enhance: state.entityMeta -> state.entitiesMeta (#3451)

Author: ntucker

.changeset/sixty-monkeys-open.md

@@ -0,0 +1,7 @@
+---
+'@data-client/normalizr': minor
+'@data-client/react': minor
+'@data-client/core': minor
+---
+
+state.entityMeta -> state.entitiesMeta

__tests__/utils.ts

@@ -25,12 +25,12 @@ export function mockEventHandlers() {
 export function createEntityMeta(
   entities: Record<string, Record<string, any>>,
 ) {
-  const entityMeta: any = {};
+  const entitiesMeta: any = {};
   for (const k in entities) {
-    entityMeta[k] = {};
+    entitiesMeta[k] = {};
     for (const pk in entities[k]) {
-      entityMeta[k][pk] = { date: 0, expiresAt: 0 };
+      entitiesMeta[k][pk] = { date: 0, expiresAt: 0 };
     }
   }
-  return entityMeta;
+  return entitiesMeta;
 }

docs/core/api/DataProvider.md

@@ -54,7 +54,7 @@ export interface State<T> {
       readonly errorPolicy?: 'hard' | 'soft' | undefined;
     };
   };
-  readonly entityMeta: {
+  readonly entitiesMeta: {
     readonly [entityKey: string]: {
       readonly [pk: string]: {
         readonly date: number;

docs/core/api/types.md

@@ -57,7 +57,7 @@ interface State<T> {
       readonly errorPolicy?: 'hard' | 'soft' | undefined;
     };
   };
-  readonly entityMeta: {
+  readonly entitiesMeta: {
     readonly [entityKey: string]: {
       readonly [pk: string]: {
         readonly date: number;

docs/rest/api/schema.md

@@ -142,7 +142,7 @@ Now, `normalizedData` will create a single serializable source of truth for all
   },
   // contents excluded for brevity
   indexes,
-  entityMeta,
+  entitiesMeta,
 }
 ```
 

examples/normalizr-relationships/output.json

@@ -81,7 +81,7 @@
     "1",
     "2"
   ],
-  "entityMeta": {
+  "entitiesMeta": {
     "User": {
       "123": {
         "expiresAt": null,

packages/core/README.md

@@ -48,7 +48,7 @@ function useSuspense(endpoint, ...args)
     cacheResults,
     state.indexes,
     state.entities,
-    state.entityMeta,
+    state.entitiesMeta,
     meta,
     key,
   ]);

packages/core/src/controller/Controller.ts

@@ -563,7 +563,7 @@ export default class Controller<
       // note: isInvalid can only be true if shouldQuery is true
       if (isInvalid) expiresAt = 1;
       // fallback to entity expiry time
-      else expiresAt = entityExpiresAt(paths, state.entityMeta);
+      else expiresAt = entityExpiresAt(paths, state.entitiesMeta);
     }
 
     return {
@@ -664,7 +664,7 @@ export default class Controller<
 // earliest expiry dictates age
 function entityExpiresAt(
   paths: EntityPath[],
-  entityMeta: {
+  entitiesMeta: {
     readonly [entityKey: string]: {
       readonly [pk: string]: {
         readonly date: number;
@@ -676,7 +676,7 @@ function entityExpiresAt(
 ) {
   let expiresAt = Infinity;
   for (const { pk, key } of paths) {
-    const entityExpiry = entityMeta[key]?.[pk]?.expiresAt;
+    const entityExpiry = entitiesMeta[key]?.[pk]?.expiresAt;
     // expiresAt will always resolve to false with any comparison
     if (entityExpiry < expiresAt) expiresAt = entityExpiry;
   }

packages/core/src/controller/__tests__/Controller.ts

@@ -46,7 +46,7 @@ describe('Controller', () => {
         endpoints: {
           [fetchKey]: result,
         },
-        entityMeta: createEntityMeta(entities),
+        entitiesMeta: createEntityMeta(entities),
         meta: {
           [fetchKey]: {
             date: Date.now(),
@@ -85,7 +85,7 @@ describe('Controller', () => {
         endpoints: {
           [fetchKey]: result,
         },
-        entityMeta: createEntityMeta(entities),
+        entitiesMeta: createEntityMeta(entities),
         meta: {
           [fetchKey]: {
             date: 0,

packages/core/src/controller/__tests__/getResponse.ts

@@ -152,7 +152,7 @@ describe('Controller.getResponse()', () => {
     const state = {
       ...initialState,
       entities,
-      entityMeta: {
+      entitiesMeta: {
         Tacos: {
           1: { date: 1000000, expiresAt: 1100000, fetchedAt: 1000000 },
           2: { date: 2000000, expiresAt: 2100000, fetchedAt: 2000000 },