@isograph/react 0.0.0-main-c938c1af → 0.0.0-main-4693ce16

package/dist/core/IsographEnvironment.d.ts

@@ -26,6 +26,11 @@ export type FragmentSubscription<TReadFromStore extends {
     readonly fragmentReference: FragmentReference<TReadFromStore, any>;
     readonly readerAst: ReaderAst<TReadFromStore>;
 };
+type AnyChangesToRecordSubscription = {
+    readonly kind: 'AnyChangesToRecord';
+    readonly callback: () => void;
+    readonly recordId: DataId;
+};
 type AnyRecordSubscription = {
     readonly kind: 'AnyRecords';
     readonly callback: () => void;
@@ -33,7 +38,7 @@ type AnyRecordSubscription = {
 type Subscription = FragmentSubscription<{
     parameters: object;
     data: object;
-}> | AnyRecordSubscription;
+}> | AnyChangesToRecordSubscription | AnyRecordSubscription;
 type Subscriptions = Set<Subscription>;
 type CacheMap<T> = {
     [index: string]: ParentCache<T>;

package/dist/core/cache.d.ts

@@ -26,11 +26,12 @@ type NetworkResponseObject = {
 };
 export declare function normalizeData(environment: IsographEnvironment, normalizationAst: NormalizationAst, networkResponse: NetworkResponseObject, variables: Variables, nestedRefetchQueries: RefetchQueryNormalizationArtifactWrapper[]): Set<DataId>;
 export declare function subscribeToAnyChange(environment: IsographEnvironment, callback: () => void): () => void;
+export declare function subscribeToAnyChangesToRecord(environment: IsographEnvironment, recordId: DataId, callback: () => void): () => void;
 export declare function subscribe<TReadFromStore extends {
     parameters: object;
     data: object;
 }>(environment: IsographEnvironment, encounteredDataAndRecords: WithEncounteredRecords<TReadFromStore>, fragmentReference: FragmentReference<TReadFromStore, any>, callback: (newEncounteredDataAndRecords: WithEncounteredRecords<TReadFromStore>) => void, readerAst: ReaderAst<TReadFromStore>): () => void;
-export declare function onNextChange(environment: IsographEnvironment): Promise<void>;
+export declare function onNextChangeToRecord(environment: IsographEnvironment, recordId: DataId): Promise<void>;
 export declare function getParentRecordKey(astNode: NormalizationLinkedField | NormalizationScalarField | ReaderLinkedField | ReaderScalarField, variables: Variables): string;
 export declare const FIRST_SPLIT_KEY = "____";
 export declare const SECOND_SPLIT_KEY = "___";

package/dist/core/cache.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SECOND_SPLIT_KEY = exports.FIRST_SPLIT_KEY = exports.getParentRecordKey = exports.onNextChange = exports.subscribe = exports.subscribeToAnyChange = exports.normalizeData = exports.getOrCreateCacheForArtifact = exports.stableCopy = exports.getOrCreateItemInSuspenseCache = void 0;
+exports.SECOND_SPLIT_KEY = exports.FIRST_SPLIT_KEY = exports.getParentRecordKey = exports.onNextChangeToRecord = exports.subscribe = exports.subscribeToAnyChangesToRecord = exports.subscribeToAnyChange = exports.normalizeData = exports.getOrCreateCacheForArtifact = exports.stableCopy = exports.getOrCreateItemInSuspenseCache = void 0;
 const react_disposable_state_1 = require("@isograph/react-disposable-state");
 const IsographEnvironment_1 = require("./IsographEnvironment");
 const read_1 = require("./read");
@@ -96,6 +96,16 @@ function subscribeToAnyChange(environment, callback) {
     return () => environment.subscriptions.delete(subscription);
 }
 exports.subscribeToAnyChange = subscribeToAnyChange;
+function subscribeToAnyChangesToRecord(environment, recordId, callback) {
+    const subscription = {
+        kind: 'AnyChangesToRecord',
+        recordId,
+        callback,
+    };
+    environment.subscriptions.add(subscription);
+    return () => environment.subscriptions.delete(subscription);
+}
+exports.subscribeToAnyChangesToRecord = subscribeToAnyChangesToRecord;
 // TODO we should re-read and call callback if the value has changed
 function subscribe(environment, encounteredDataAndRecords, fragmentReference, callback, readerAst) {
     const fragmentSubscription = {
@@ -109,15 +119,15 @@ function subscribe(environment, encounteredDataAndRecords, fragmentReference, ca
     return () => environment.subscriptions.delete(fragmentSubscription);
 }
 exports.subscribe = subscribe;
-function onNextChange(environment) {
+function onNextChangeToRecord(environment, recordId) {
     return new Promise((resolve) => {
-        const unsubscribe = subscribeToAnyChange(environment, () => {
+        const unsubscribe = subscribeToAnyChangesToRecord(environment, recordId, () => {
             unsubscribe();
             resolve();
         });
     });
 }
-exports.onNextChange = onNextChange;
+exports.onNextChangeToRecord = onNextChangeToRecord;
 // Calls to readButDoNotEvaluate can suspend (i.e. throw a promise).
 // Maybe in the future, they will be able to throw errors.
 //
@@ -181,7 +191,14 @@ function callSubscriptions(environment, recordsEncounteredWhenNormalizing) {
                 return;
             }
             case 'AnyRecords': {
-                return subscription.callback();
+                subscription.callback();
+                return;
+            }
+            case 'AnyChangesToRecord': {
+                if (recordsEncounteredWhenNormalizing.has(subscription.recordId)) {
+                    subscription.callback();
+                }
+                return;
             }
             default: {
                 // Ensure we have covered all variants

package/dist/core/read.js

@@ -29,11 +29,11 @@ function readButDoNotEvaluate(environment, fragmentReference, networkRequestOpti
             networkRequestOptions.throwOnNetworkError) {
             // TODO assert that the network request state is not Err
             throw new Promise((resolve, reject) => {
-                (0, cache_1.onNextChange)(environment).then(resolve);
+                (0, cache_1.onNextChangeToRecord)(environment, response.recordId).then(resolve);
                 fragmentReference.networkRequest.promise.catch(reject);
             });
         }
-        throw (0, cache_1.onNextChange)(environment);
+        throw (0, cache_1.onNextChangeToRecord)(environment, response.recordId);
     }
     else {
         return {
@@ -51,6 +51,7 @@ function readData(environment, ast, root, variables, nestedRefetchQueries, netwo
         return {
             kind: 'MissingData',
             reason: 'No record for root ' + root,
+            recordId: root,
         };
     }
     if (storeRecord === null) {
@@ -72,6 +73,7 @@ function readData(environment, ast, root, variables, nestedRefetchQueries, netwo
                     return {
                         kind: 'MissingData',
                         reason: 'No value for ' + storeRecordName + ' on root ' + root,
+                        recordId: root,
                     };
                 }
                 target[(_a = field.alias) !== null && _a !== void 0 ? _a : field.fieldName] = value;
@@ -93,6 +95,7 @@ function readData(environment, ast, root, variables, nestedRefetchQueries, netwo
                                     root +
                                     '. Link is ' +
                                     JSON.stringify(item),
+                                recordId: root,
                             };
                         }
                         else if (link === null) {
@@ -110,6 +113,7 @@ function readData(environment, ast, root, variables, nestedRefetchQueries, netwo
                                     '. Link is ' +
                                     JSON.stringify(item),
                                 nestedReason: result,
+                                recordId: result.recordId,
                             };
                         }
                         results.push(result.data);
@@ -131,6 +135,7 @@ function readData(environment, ast, root, variables, nestedRefetchQueries, netwo
                                 root +
                                 '. Link is ' +
                                 JSON.stringify(value),
+                            recordId: root,
                         };
                     }
                     else {
@@ -148,6 +153,7 @@ function readData(environment, ast, root, variables, nestedRefetchQueries, netwo
                         kind: 'MissingData',
                         reason: 'Missing data for ' + storeRecordName + ' on root ' + root,
                         nestedReason: data,
+                        recordId: data.recordId,
                     };
                 }
                 target[(_e = field.alias) !== null && _e !== void 0 ? _e : field.fieldName] = data.data;
@@ -167,6 +173,7 @@ function readData(environment, ast, root, variables, nestedRefetchQueries, netwo
                         kind: 'MissingData',
                         reason: 'Missing data for ' + field.alias + ' on root ' + root,
                         nestedReason: data,
+                        recordId: data.recordId,
                     };
                 }
                 else {
@@ -201,6 +208,7 @@ function readData(environment, ast, root, variables, nestedRefetchQueries, netwo
                                 kind: 'MissingData',
                                 reason: 'Missing data for ' + field.alias + ' on root ' + root,
                                 nestedReason: data,
+                                recordId: data.recordId,
                             };
                         }
                         else {
@@ -244,6 +252,7 @@ function readData(environment, ast, root, variables, nestedRefetchQueries, netwo
                         kind: 'MissingData',
                         reason: 'Missing data for ' + field.alias + ' on root ' + root,
                         nestedReason: refetchReaderParams,
+                        recordId: refetchReaderParams.recordId,
                     };
                 }
                 else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@isograph/react",
-  "version": "0.0.0-main-c938c1af",
+  "version": "0.0.0-main-4693ce16",
   "description": "Use Isograph with React",
   "homepage": "https://isograph.dev",
   "main": "dist/index.js",
@@ -17,9 +17,9 @@
     "tsc": "tsc"
   },
   "dependencies": {
-    "@isograph/disposable-types": "0.0.0-main-c938c1af",
-    "@isograph/react-disposable-state": "0.0.0-main-c938c1af",
-    "@isograph/reference-counted-pointer": "0.0.0-main-c938c1af"
+    "@isograph/disposable-types": "0.0.0-main-4693ce16",
+    "@isograph/react-disposable-state": "0.0.0-main-4693ce16",
+    "@isograph/reference-counted-pointer": "0.0.0-main-4693ce16"
   },
   "peerDependencies": {
     "react": "18.2.0"

package/src/core/IsographEnvironment.ts

@@ -26,6 +26,13 @@ export type FragmentSubscription<
   readonly fragmentReference: FragmentReference<TReadFromStore, any>;
   readonly readerAst: ReaderAst<TReadFromStore>;
 };
+
+type AnyChangesToRecordSubscription = {
+  readonly kind: 'AnyChangesToRecord';
+  readonly callback: () => void;
+  readonly recordId: DataId;
+};
+
 type AnyRecordSubscription = {
   readonly kind: 'AnyRecords';
   readonly callback: () => void;
@@ -33,6 +40,7 @@ type AnyRecordSubscription = {
 
 type Subscription =
   | FragmentSubscription<{ parameters: object; data: object }>
+  | AnyChangesToRecordSubscription
   | AnyRecordSubscription;
 type Subscriptions = Set<Subscription>;
 // Should this be a map?

package/src/core/cache.ts

@@ -183,6 +183,20 @@ export function subscribeToAnyChange(
   return () => environment.subscriptions.delete(subscription);
 }
 
+export function subscribeToAnyChangesToRecord(
+  environment: IsographEnvironment,
+  recordId: DataId,
+  callback: () => void,
+): () => void {
+  const subscription = {
+    kind: 'AnyChangesToRecord',
+    recordId,
+    callback,
+  } as const;
+  environment.subscriptions.add(subscription);
+  return () => environment.subscriptions.delete(subscription);
+}
+
 // TODO we should re-read and call callback if the value has changed
 export function subscribe<
   TReadFromStore extends { parameters: object; data: object },
@@ -206,12 +220,19 @@ export function subscribe<
   return () => environment.subscriptions.delete(fragmentSubscription);
 }
 
-export function onNextChange(environment: IsographEnvironment): Promise<void> {
+export function onNextChangeToRecord(
+  environment: IsographEnvironment,
+  recordId: DataId,
+): Promise<void> {
   return new Promise((resolve) => {
-    const unsubscribe = subscribeToAnyChange(environment, () => {
-      unsubscribe();
-      resolve();
-    });
+    const unsubscribe = subscribeToAnyChangesToRecord(
+      environment,
+      recordId,
+      () => {
+        unsubscribe();
+        resolve();
+      },
+    );
   });
 }
 
@@ -294,7 +315,14 @@ function callSubscriptions(
           return;
         }
         case 'AnyRecords': {
-          return subscription.callback();
+          subscription.callback();
+          return;
+        }
+        case 'AnyChangesToRecord': {
+          if (recordsEncounteredWhenNormalizing.has(subscription.recordId)) {
+            subscription.callback();
+          }
+          return;
         }
         default: {
           // Ensure we have covered all variants

package/src/core/read.ts

@@ -1,5 +1,5 @@
 import { CleanupFn } from '@isograph/isograph-disposable-types/dist';
-import { getParentRecordKey, onNextChange } from './cache';
+import { getParentRecordKey, onNextChangeToRecord } from './cache';
 import { getOrCreateCachedComponent } from './componentCache';
 import {
   IsographEntrypoint,
@@ -77,11 +77,11 @@ export function readButDoNotEvaluate<
     ) {
       // TODO assert that the network request state is not Err
       throw new Promise((resolve, reject) => {
-        onNextChange(environment).then(resolve);
+        onNextChangeToRecord(environment, response.recordId).then(resolve);
         fragmentReference.networkRequest.promise.catch(reject);
       });
     }
-    throw onNextChange(environment);
+    throw onNextChangeToRecord(environment, response.recordId);
   } else {
     return {
       encounteredRecords: mutableEncounteredRecords,
@@ -100,6 +100,7 @@ type ReadDataResult<TReadFromStore> =
       readonly kind: 'MissingData';
       readonly reason: string;
       readonly nestedReason?: ReadDataResult<unknown>;
+      readonly recordId: DataId;
     };
 
 function readData<TReadFromStore>(
@@ -118,6 +119,7 @@ function readData<TReadFromStore>(
     return {
       kind: 'MissingData',
       reason: 'No record for root ' + root,
+      recordId: root,
     };
   }
 
@@ -142,6 +144,7 @@ function readData<TReadFromStore>(
           return {
             kind: 'MissingData',
             reason: 'No value for ' + storeRecordName + ' on root ' + root,
+            recordId: root,
           };
         }
         target[field.alias ?? field.fieldName] = value;
@@ -164,6 +167,7 @@ function readData<TReadFromStore>(
                   root +
                   '. Link is ' +
                   JSON.stringify(item),
+                recordId: root,
               };
             } else if (link === null) {
               results.push(null);
@@ -190,6 +194,7 @@ function readData<TReadFromStore>(
                   '. Link is ' +
                   JSON.stringify(item),
                 nestedReason: result,
+                recordId: result.recordId,
               };
             }
             results.push(result.data);
@@ -219,6 +224,7 @@ function readData<TReadFromStore>(
                 root +
                 '. Link is ' +
                 JSON.stringify(value),
+              recordId: root,
             };
           } else {
             link = altLink;
@@ -243,6 +249,7 @@ function readData<TReadFromStore>(
             kind: 'MissingData',
             reason: 'Missing data for ' + storeRecordName + ' on root ' + root,
             nestedReason: data,
+            recordId: data.recordId,
           };
         }
         target[field.alias ?? field.fieldName] = data.data;
@@ -269,6 +276,7 @@ function readData<TReadFromStore>(
             kind: 'MissingData',
             reason: 'Missing data for ' + field.alias + ' on root ' + root,
             nestedReason: data,
+            recordId: data.recordId,
           };
         } else {
           const refetchQueryIndex = field.refetchQuery;
@@ -322,6 +330,7 @@ function readData<TReadFromStore>(
                 kind: 'MissingData',
                 reason: 'Missing data for ' + field.alias + ' on root ' + root,
                 nestedReason: data,
+                recordId: data.recordId,
               };
             } else {
               const firstParameter = {
@@ -377,6 +386,7 @@ function readData<TReadFromStore>(
             kind: 'MissingData',
             reason: 'Missing data for ' + field.alias + ' on root ' + root,
             nestedReason: refetchReaderParams,
+            recordId: refetchReaderParams.recordId,
           };
         } else {
           target[field.alias] = (args: any) => {