feat: Add schema.Collection

fix: changes to

Author: ntucker

.vscode/tasks.json

@@ -46,6 +46,14 @@
 					"endsPattern": "compiled successfully"
 				}
 			}
+		},
+		{
+			"type": "npm",
+			"script": "build",
+			"group": "build",
+			"problemMatcher": [],
+			"label": "npm: build",
+			"detail": "yarn build:types && yarn workspaces foreach -ptiv --no-private run build"
 		}
 	]
 }

__tests__/new.ts

@@ -1,5 +1,3 @@
-import React, { createContext, useContext } from 'react';
-
 import { SimpleRecord } from '@rest-hooks/legacy';
 import {
   AbstractInstanceType,
@@ -17,6 +15,7 @@ import {
   RestType,
   MutateEndpoint,
 } from '@rest-hooks/rest';
+import React, { createContext, useContext } from 'react';
 
 /** Represents data with primary key being from 'id' field. */
 export class IDEntity extends Entity {

docs/rest/guides/summary-list.md

@@ -45,7 +45,9 @@ delay: 150,
 },
 ]}>
 
-```typescript title="api/Article.ts" {9}
+```typescript title="api/Article.ts" {11,24}
+import { validateRequired } from '@rest-hooks/rest';
+
 class ArticleSummary extends Entity {
   readonly id: string = '';
   readonly title: string = '';
@@ -170,6 +172,7 @@ class Article extends ArticleSummary {
 
   static validate(processedEntity) {
     return (
+      // highlight-next-line
       validateRequired(processedEntity, this.defaults) ||
       super.validate(processedEntity)
     );

examples/benchmark/normalizr.js

@@ -57,13 +57,15 @@ export default function addNormlizrSuite(suite) {
     entities,
     denormCache.entities,
     denormCache.results['/fake'],
+    [],
   );
   denormalizeCached(
     queryState.result,
     ProjectQuery,
     queryState.entities,
     denormCache.entities,
     denormCache.results['/fakeQuery'],
+    [],
   );
   %OptimizeFunctionOnNextCall(denormalizeCached);
   %OptimizeFunctionOnNextCall(normalize);
@@ -73,6 +75,7 @@ export default function addNormlizrSuite(suite) {
       return normalize(
         data,
         ProjectSchema,
+        [],
         initialState.entities,
         initialState.indexes,
         initialState.entityMeta,
@@ -113,6 +116,7 @@ export default function addNormlizrSuite(suite) {
         entities,
         denormCache.entities,
         denormCache.results['/fake'],
+        [],
       );
     })
     .add('denormalizeLong All withCache', () => {
@@ -122,6 +126,7 @@ export default function addNormlizrSuite(suite) {
         queryState.entities,
         denormCache.entities,
         denormCache.results['/fakeQuery'],
+        [],
       );
     })
     .add('denormalizeLong Query-sorted withCache', () => {
@@ -131,6 +136,7 @@ export default function addNormlizrSuite(suite) {
         queryState.entities,
         denormCache.entities,
         denormCache.results['/fakeQuery'],
+        [],
       );
     })
     .on('complete', function () {

packages/core/src/controller/BaseController.ts

@@ -401,6 +401,7 @@ export default class Controller<
       state.entities,
       this.globalCache.entities,
       this.globalCache.results[key],
+      args,
     ) as { data: DenormalizeNullable<E['schema']>; paths: Path[] };
     const invalidDenormalize = typeof data === 'symbol';
 

packages/core/src/next/Controller.ts

@@ -30,7 +30,7 @@ export default class Controller<
 
     if (endpoint.schema) {
       return action.meta.promise.then(input =>
-        denormalize(input, endpoint.schema, {}),
+        denormalize(input, endpoint.schema, {}, args),
       ) as any;
     }
     return action.meta.promise as any;

packages/core/src/state/reducer/setReducer.ts

@@ -40,6 +40,7 @@ export function setReducer(
     const { result, entities, indexes, entityMeta } = normalize(
       payload,
       action.meta.schema,
+      action.meta.args as any,
       state.entities,
       state.indexes,
       state.entityMeta,

packages/endpoint/src/interface.ts

@@ -25,13 +25,19 @@ export interface SchemaSimple<T = any> {
     visit: (...args: any) => any,
     addEntity: (...args: any) => any,
     visitedEntities: Record<string, any>,
+    storeEntities: any,
+    args: any[],
   ): any;
   denormalize(
     // eslint-disable-next-line @typescript-eslint/ban-types
     input: {},
     unvisit: UnvisitFunction,
   ): [denormalized: T, found: boolean, suspend: boolean];
-  denormalizeOnly?(input: {}, unvisit: (input: any, schema: any) => any): T;
+  denormalizeOnly?(
+    input: {},
+    args: any,
+    unvisit: (input: any, schema: any) => any,
+  ): T;
   infer(
     args: readonly any[],
     indexes: NormalizedIndex,
@@ -50,7 +56,7 @@ export interface SchemaClass<T = any, N = T | undefined>
 
 export interface EntityInterface<T = any> extends SchemaSimple {
   createIfValid?(props: any): any;
-  pk(params: any, parent?: any, key?: string): string | undefined;
+  pk(params: any, parent?: any, key?: string, args?: any[]): string | undefined;
   readonly key: string;
   merge(existing: any, incoming: any): any;
   expiresAt?(meta: any, input: any): number;

packages/endpoint/src/normal.ts

@@ -70,7 +70,7 @@ export type Denormalize<S> = S extends EntityInterface<infer U>
   ? AbstractInstanceType<S>
   : S extends { denormalizeOnly: (...args: any) => any }
   ? ReturnType<S['denormalizeOnly']>
-  : S extends SchemaClass
+  : S extends { denormalize: (...args: any) => any }
   ? DenormalizeReturnType<S['denormalize']>
   : S extends Serializable<infer T>
   ? T
@@ -84,7 +84,7 @@ export type DenormalizeNullable<S> = S extends EntityInterface<any>
   ? DenormalizeNullableNestedSchema<S> | undefined
   : S extends RecordClass
   ? DenormalizeNullableNestedSchema<S>
-  : S extends SchemaClass
+  : S extends { _denormalizeNullable: (...args: any) => any }
   ? DenormalizeReturnType<S['_denormalizeNullable']>
   : S extends Serializable<infer T>
   ? T
@@ -98,7 +98,7 @@ export type Normalize<S> = S extends EntityInterface
   ? string
   : S extends RecordClass
   ? NormalizeObject<S['schema']>
-  : S extends SchemaClass
+  : S extends { normalize: (...args: any) => any }
   ? NormalizeReturnType<S['normalize']>
   : S extends Serializable<infer T>
   ? T
@@ -112,7 +112,7 @@ export type NormalizeNullable<S> = S extends EntityInterface
   ? string | undefined
   : S extends RecordClass
   ? NormalizedNullableObject<S['schema']>
-  : S extends SchemaClass
+  : S extends { _normalizeNullable: (...args: any) => any }
   ? NormalizeReturnType<S['_normalizeNullable']>
   : S extends Serializable<infer T>
   ? T

packages/endpoint/src/queryEndpoint.ts

@@ -46,10 +46,11 @@ export class Query<
     if (schema.denormalizeOnly)
       query.denormalizeOnly = (
         { args, input }: { args: P; input: any },
+        _: P,
         unvisit: any,
       ) => {
         if (input === undefined) return undefined;
-        const value = (schema as any).denormalizeOnly(input, unvisit);
+        const value = (schema as any).denormalizeOnly(input, args, unvisit);
         return typeof value === 'symbol'
           ? undefined
           : this.process(value, ...args);
@@ -83,5 +84,9 @@ type QuerySchema<Schema, R> = Exclude<
     input: {},
     unvisit: UnvisitFunction,
   ): [denormalized: R | undefined, found: boolean, suspend: boolean];
-  denormalizeOnly(input: {}, unvisit: (input: any, schema: any) => any): R;
+  denormalizeOnly(
+    input: {},
+    args: readonly any[],
+    unvisit: (input: any, schema: any) => any,
+  ): R;
 };