enhance: delegate.getEntities -> delegate.forEntities

Author: ntucker

.changeset/proud-taxes-bake.md

@@ -3,6 +3,26 @@
 '@data-client/endpoint': minor
 ---
 
-delegate.getEntity(this.key) -> delegate.getEntities(this.key)
+delegate.getEntity(key) -> delegate.forEntities(key, cb)
 
-This applies to both schema.queryKey and schema.normalize method delegates.
+This applies to both schema.queryKey and schema.normalize method delegates.
+
+#### Before
+
+```ts
+const entities = delegate.getEntity(this.key);
+if (entities)
+  Object.keys(entities).forEach(collectionPk => {
+    if (!filterCollections(JSON.parse(collectionPk))) return;
+    delegate.mergeEntity(this, collectionPk, normalizedValue);
+  });
+```
+
+#### After
+
+```ts
+delegate.forEntities(this.key, ([collectionKey]) => {
+  if (!filterCollections(JSON.parse(collectionKey))) return;
+  delegate.mergeEntity(this, collectionKey, normalizedValue);
+});
+```

packages/endpoint/src/interface.ts

@@ -127,9 +127,9 @@ export interface CheckLoop {
   (entityKey: string, pk: string, input: object): boolean;
 }
 
-/** Get all normalized entities of one type from store */
-export interface GetEntities {
-  (key: string): { readonly [pk: string]: any } | undefined;
+/** Loop over all entities of a given key */
+export interface ForEntities {
+  (key: string, callbackfn: (value: [string, unknown]) => void): boolean;
 }
 /** Get normalized Entity from store */
 export interface GetEntity {
@@ -143,7 +143,7 @@ export interface GetIndex {
 
 /** Accessors to the currently processing state while building query */
 export interface IQueryDelegate {
-  getEntities: GetEntities;
+  forEntities: ForEntities;
   getEntity: GetEntity;
   getIndex: GetIndex;
   /** Return to consider results invalid */
@@ -154,8 +154,8 @@ export interface IQueryDelegate {
 export interface INormalizeDelegate {
   /** Action meta-data for this normalize call */
   readonly meta: { fetchedAt: number; date: number; expiresAt: number };
-  /** Get all normalized entities of one type from store */
-  getEntities: GetEntities;
+  /** Loop over all entities of a given key */
+  forEntities: ForEntities;
   /** Gets any previously normalized entity from store */
   getEntity: GetEntity;
   /** Updates an entity using merge lifecycles when it has previously been set */

packages/endpoint/src/schemas/All.ts

@@ -26,23 +26,30 @@ export default class AllSchema<
 
   queryKey(args: any, unvisit: any, delegate: IQueryDelegate): any {
     if (this.isSingleSchema) {
-      const entitiesEntry = delegate.getEntities(this.schema.key);
+      const entities: any[] = [];
+      if (
+        delegate.forEntities(this.schema.key, ([pk, entity]) => {
+          if (entity) entities.push(this.schema.pk(entity));
+        })
+      )
+        return entities;
       // we must wait until there are entries for any 'All' query to be Valid
-      if (entitiesEntry === undefined) return delegate.INVALID;
-      return Object.values(entitiesEntry).map(
-        entity => entity && this.schema.pk(entity),
-      );
+      return delegate.INVALID;
     }
     let found = false;
     const list = Object.values(this.schema as Record<string, any>).flatMap(
       (schema: EntityInterface) => {
-        const entitiesEntry = delegate.getEntities(schema.key);
-        if (entitiesEntry === undefined) return [];
-        found = true;
-        return Object.entries(entitiesEntry).map(([key, entity]) => ({
-          id: entity && schema.pk(entity, undefined, key, []),
-          schema: this.getSchemaAttribute(entity, undefined, key),
-        }));
+        const entities: any[] = [];
+        if (
+          delegate.forEntities(schema.key, ([pk, entity]) => {
+            entities.push({
+              id: entity && schema.pk(entity, undefined, pk, []),
+              schema: this.getSchemaAttribute(entity, undefined, pk),
+            });
+          })
+        )
+          found = true;
+        return entities;
       },
     );
     // we need at least one table entry of the Union for this to count as Valid.

packages/endpoint/src/schemas/Collection.ts

@@ -326,12 +326,10 @@ function normalizeCreate(
   // parent is args when not nested
   const filterCollections = (this.createCollectionFilter as any)(...args);
   // add to any collections that match this
-  const entities = delegate.getEntities(this.key);
-  if (entities)
-    Object.keys(entities).forEach(collectionPk => {
-      if (!filterCollections(JSON.parse(collectionPk))) return;
-      delegate.mergeEntity(this, collectionPk, normalizedValue);
-    });
+  delegate.forEntities(this.key, ([collectionKey]) => {
+    if (!filterCollections(JSON.parse(collectionKey))) return;
+    delegate.mergeEntity(this, collectionKey, normalizedValue);
+  });
   return normalizedValue as any;
 }
 

packages/normalizr/src/delegate/BaseDelegate.ts

@@ -17,7 +17,14 @@ export abstract class BaseDelegate {
     this.indexes = indexes;
   }
 
-  abstract getEntities(...path: EntitiesPath): object | undefined;
+  abstract forEntities(
+    key: string,
+    callbackfn: (value: [string, unknown]) => void,
+  ): boolean;
+
+  // we must expose the entities object to track in our WeakDependencyMap
+  // however, this should not be part of the public API
+  protected abstract getEntities(key: string): object | undefined;
   abstract getEntity(key: string, pk: string): object | undefined;
   abstract getIndex(...path: IndexPath): object | undefined;
   abstract getIndexEnd(entity: any, value: string): string | undefined;
@@ -40,10 +47,14 @@ export abstract class BaseDelegate {
         dependencies.push({ path, entity });
         return entity;
       },
-      getEntities(...path: EntitiesPath) {
-        const entity = base.getEntities(...path);
-        dependencies.push({ path, entity });
-        return entity;
+      forEntities(
+        key: string,
+        callbackfn: (value: [string, any]) => void,
+      ): boolean {
+        const entity = base.getEntities(key);
+        // always push even if entity is undefined
+        dependencies.push({ path: [key], entity });
+        return base.forEntities(key, callbackfn);
       },
     };
     return [delegate, dependencies];

packages/normalizr/src/delegate/Delegate.imm.ts

@@ -1,7 +1,14 @@
 import { BaseDelegate } from './BaseDelegate.js';
 
 export type ImmutableJSEntityTable = {
-  get(key: string): { toJS(): any } | undefined;
+  get(key: string):
+    | {
+        forEach(
+          sideEffect: (value: any, key: string, iter: any) => unknown,
+          context?: unknown,
+        ): number;
+      }
+    | undefined;
   getIn(k: [key: string, pk: string]): { toJS(): any } | undefined;
   setIn(k: [key: string, pk: string], value: any);
 };
@@ -18,8 +25,27 @@ export class ImmDelegate extends BaseDelegate {
     super(state);
   }
 
-  getEntities(key: string): any {
-    return this.entities.get(key)?.toJS();
+  forEntities(
+    key: string,
+    callbackfn: (value: [string, unknown]) => void,
+  ): boolean {
+    const entities = this.getEntities(key);
+    if (!entities) return false;
+    entities.forEach((entity: any, pk: string) => {
+      callbackfn([pk, entity]);
+    });
+    return true;
+  }
+
+  protected getEntities(key: string):
+    | {
+        forEach(
+          sideEffect: (value: any, key: string, iter: any) => unknown,
+          context?: unknown,
+        ): number;
+      }
+    | undefined {
+    return this.entities.get(key);
   }
 
   getEntity(...path: [key: string, pk: string]): any {

packages/normalizr/src/delegate/Delegate.ts

@@ -14,7 +14,21 @@ export class POJODelegate extends BaseDelegate {
     super(state);
   }
 
-  getEntities(key: string): any {
+  forEntities(
+    key: string,
+    callbackfn: (
+      value: [string, unknown],
+      index: number,
+      array: [string, unknown][],
+    ) => void,
+  ): boolean {
+    const entities = this.getEntities(key);
+    if (entities === undefined) return false;
+    Object.entries(entities).forEach(callbackfn);
+    return true;
+  }
+
+  protected getEntities(key: string): object | undefined {
     return this.entities[key];
   }
 

packages/normalizr/src/interface.ts

@@ -114,9 +114,9 @@ export interface CheckLoop {
   (entityKey: string, pk: string, input: object): boolean;
 }
 
-/** Get all normalized entities of one type from store */
-export interface GetEntities {
-  (key: string): { readonly [pk: string]: any } | undefined;
+/** Loop over all entities of a given key */
+export interface ForEntities {
+  (key: string, callbackfn: (value: [string, unknown]) => void): boolean;
 }
 /** Get normalized Entity from store */
 export interface GetEntity {
@@ -130,7 +130,7 @@ export interface GetIndex {
 
 /** Accessors to the currently processing state while building query */
 export interface IQueryDelegate {
-  getEntities: GetEntities;
+  forEntities: ForEntities;
   getEntity: GetEntity;
   getIndex: GetIndex;
   /** Return to consider results invalid */
@@ -141,8 +141,8 @@ export interface IQueryDelegate {
 export interface INormalizeDelegate {
   /** Action meta-data for this normalize call */
   readonly meta: { fetchedAt: number; date: number; expiresAt: number };
-  /** Get all normalized entities of one type from store */
-  getEntities: GetEntities;
+  /** Loop over all entities of a given key */
+  forEntities: ForEntities;
   /** Gets any previously normalized entity from store */
   getEntity: GetEntity;
   /** Updates an entity using merge lifecycles when it has previously been set */

website/src/components/Playground/editor-types/@data-client/core.d.ts

@@ -57,11 +57,9 @@ interface EntityPath {
 type IndexPath = [key: string, index: string, value: string];
 type EntitiesPath = [key: string];
 type QueryPath = IndexPath | [key: string, pk: string] | EntitiesPath;
-/** Get all normalized entities of one type from store */
-interface GetEntities {
-    (key: string): {
-        readonly [pk: string]: any;
-    } | undefined;
+/** Loop over all entities of a given key */
+interface ForEntities {
+    (key: string, callbackfn: (value: [string, unknown]) => void): boolean;
 }
 /** Get normalized Entity from store */
 interface GetEntity {
@@ -74,7 +72,7 @@ interface GetIndex {
 }
 /** Accessors to the currently processing state while building query */
 interface IQueryDelegate {
-    getEntities: GetEntities;
+    forEntities: ForEntities;
     getEntity: GetEntity;
     getIndex: GetIndex;
     /** Return to consider results invalid */
@@ -88,8 +86,8 @@ interface INormalizeDelegate {
         date: number;
         expiresAt: number;
     };
-    /** Get all normalized entities of one type from store */
-    getEntities: GetEntities;
+    /** Loop over all entities of a given key */
+    forEntities: ForEntities;
     /** Gets any previously normalized entity from store */
     getEntity: GetEntity;
     /** Updates an entity using merge lifecycles when it has previously been set */
@@ -230,7 +228,8 @@ declare abstract class BaseDelegate {
         entities: any;
         indexes: any;
     });
-    abstract getEntities(...path: EntitiesPath): object | undefined;
+    abstract forEntities(key: string, callbackfn: (value: [string, unknown]) => void): boolean;
+    protected abstract getEntities(key: string): object | undefined;
     abstract getEntity(key: string, pk: string): object | undefined;
     abstract getIndex(...path: IndexPath): object | undefined;
     abstract getIndexEnd(entity: any, value: string): string | undefined;

website/src/components/Playground/editor-types/@data-client/endpoint.d.ts

@@ -264,11 +264,9 @@ type EntitiesPath = [key: string];
 interface CheckLoop {
     (entityKey: string, pk: string, input: object): boolean;
 }
-/** Get all normalized entities of one type from store */
-interface GetEntities {
-    (key: string): {
-        readonly [pk: string]: any;
-    } | undefined;
+/** Loop over all entities of a given key */
+interface ForEntities {
+    (key: string, callbackfn: (value: [string, unknown]) => void): boolean;
 }
 /** Get normalized Entity from store */
 interface GetEntity {
@@ -281,7 +279,7 @@ interface GetIndex {
 }
 /** Accessors to the currently processing state while building query */
 interface IQueryDelegate {
-    getEntities: GetEntities;
+    forEntities: ForEntities;
     getEntity: GetEntity;
     getIndex: GetIndex;
     /** Return to consider results invalid */
@@ -295,8 +293,8 @@ interface INormalizeDelegate {
         date: number;
         expiresAt: number;
     };
-    /** Get all normalized entities of one type from store */
-    getEntities: GetEntities;
+    /** Loop over all entities of a given key */
+    forEntities: ForEntities;
     /** Gets any previously normalized entity from store */
     getEntity: GetEntity;
     /** Updates an entity using merge lifecycles when it has previously been set */
@@ -1194,4 +1192,4 @@ declare function validateRequired(processedEntity: any, requiredDefaults: Record
 /** https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-4.html#the-noinfer-utility-type */
 type NI<T> = NoInfer<T>;
 
-export { type AbstractInstanceType, Array$1 as Array, type CheckLoop, Collection, type DefaultArgs, type Denormalize, type DenormalizeNullable, type DenormalizeNullableObject, type DenormalizeObject, Endpoint, type EndpointExtendOptions, type EndpointExtraOptions, type EndpointInstance, type EndpointInstanceInterface, type EndpointInterface, type EndpointOptions, type EndpointParam, type EndpointToFunction, type EntitiesPath, Entity, type EntityFields, type EntityInterface, type EntityMap, EntityMixin, type EntityPath, type EntityTable, type ErrorTypes, type ExpiryStatusInterface, ExtendableEndpoint, type FetchFunction, type GetEntities, type GetEntity, type GetIndex, type IEntityClass, type IEntityInstance, type INormalizeDelegate, type IQueryDelegate, type IndexPath, Invalidate, type KeyofEndpointInstance, type Mergeable, type MutateEndpoint, type NI, type NetworkError, type Normalize, type NormalizeNullable, type NormalizeObject, type NormalizedEntity, type NormalizedIndex, type NormalizedNullableObject, type ObjectArgs, type PolymorphicInterface, type Queryable, type ReadEndpoint, type RecordClass, type ResolveType, type Schema, type SchemaArgs, type SchemaClass, type SchemaSimple, type Serializable, type SnapshotInterface, type UnknownError, type Visit, schema_d as schema, validateRequired };
+export { type AbstractInstanceType, Array$1 as Array, type CheckLoop, Collection, type DefaultArgs, type Denormalize, type DenormalizeNullable, type DenormalizeNullableObject, type DenormalizeObject, Endpoint, type EndpointExtendOptions, type EndpointExtraOptions, type EndpointInstance, type EndpointInstanceInterface, type EndpointInterface, type EndpointOptions, type EndpointParam, type EndpointToFunction, type EntitiesPath, Entity, type EntityFields, type EntityInterface, type EntityMap, EntityMixin, type EntityPath, type EntityTable, type ErrorTypes, type ExpiryStatusInterface, ExtendableEndpoint, type FetchFunction, type ForEntities, type GetEntity, type GetIndex, type IEntityClass, type IEntityInstance, type INormalizeDelegate, type IQueryDelegate, type IndexPath, Invalidate, type KeyofEndpointInstance, type Mergeable, type MutateEndpoint, type NI, type NetworkError, type Normalize, type NormalizeNullable, type NormalizeObject, type NormalizedEntity, type NormalizedIndex, type NormalizedNullableObject, type ObjectArgs, type PolymorphicInterface, type Queryable, type ReadEndpoint, type RecordClass, type ResolveType, type Schema, type SchemaArgs, type SchemaClass, type SchemaSimple, type Serializable, type SnapshotInterface, type UnknownError, type Visit, schema_d as schema, validateRequired };