@isograph/react 0.1.1 → 0.3.0

package/dist/core/FragmentReference.d.ts

@@ -0,0 +1,25 @@
+import { type Link } from './IsographEnvironment';
+import { ReaderWithRefetchQueries } from '../core/entrypoint';
+import { PromiseWrapper } from './PromiseWrapper';
+export type VariableValue = string | number | boolean | null | object;
+export type Variables = {
+    readonly [index: string]: VariableValue;
+};
+export type ExtractData<T> = T extends {
+    data: infer D extends object;
+} ? D : never;
+export type ExtractParameters<T> = T extends {
+    parameters: infer P extends Variables;
+} ? P : Variables;
+export type FragmentReference<TReadFromStore extends {
+    parameters: object;
+    data: object;
+}, TClientFieldValue> = {
+    readonly kind: 'FragmentReference';
+    readonly readerWithRefetchQueries: PromiseWrapper<ReaderWithRefetchQueries<TReadFromStore, TClientFieldValue>>;
+    readonly root: Link;
+    readonly variables: ExtractParameters<TReadFromStore>;
+    readonly networkRequest: PromiseWrapper<void, any>;
+};
+export declare function stableIdForFragmentReference(fragmentReference: FragmentReference<any, any>): string;
+//# sourceMappingURL=FragmentReference.d.ts.map

package/dist/core/FragmentReference.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FragmentReference.d.ts","sourceRoot":"","sources":["../../src/core/FragmentReference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAGlD,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,MAAM,CAAC;AAEtE,MAAM,MAAM,SAAS,GAAG;IAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,aAAa,CAAA;CAAE,CAAC;AAEpE,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS;IACrC,IAAI,EAAE,MAAM,CAAC,SAAS,MAAM,CAAC;CAC9B,GACG,CAAC,GACD,KAAK,CAAC;AAEV,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,CAAC,SAAS;IAC3C,UAAU,EAAE,MAAM,CAAC,SAAS,SAAS,CAAC;CACvC,GACG,CAAC,GACD,SAAS,CAAC;AAEd,MAAM,MAAM,iBAAiB,CAC3B,cAAc,SAAS;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAC3D,iBAAiB,IACf;IACF,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC;IACnC,QAAQ,CAAC,wBAAwB,EAAE,cAAc,CAC/C,wBAAwB,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAC5D,CAAC;IACF,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC,cAAc,CAAC,CAAC;IACtD,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;CACpD,CAAC;AAEF,wBAAgB,4BAA4B,CAC1C,iBAAiB,EAAE,iBAAiB,CAAC,GAAG,EAAE,GAAG,CAAC,GAC7C,MAAM,CAER"}

package/dist/core/FragmentReference.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stableIdForFragmentReference = stableIdForFragmentReference;
+function stableIdForFragmentReference(fragmentReference) {
+    var _a;
+    return `${fragmentReference.root.__typename}/${fragmentReference.root.__link}/TODO_FRAGMENT_NAME/${serializeVariables((_a = fragmentReference.variables) !== null && _a !== void 0 ? _a : {})}`;
+}
+function serializeVariables(variables) {
+    let s = '';
+    const keys = Object.keys(variables);
+    keys.sort();
+    for (const key of keys) {
+        s += `${key}:${variables[key]},`;
+    }
+    return s;
+}

package/dist/core/IsographEnvironment.d.ts

@@ -0,0 +1,89 @@
+import { ParentCache } from '@isograph/react-disposable-state';
+import { RetainedQuery } from './garbageCollection';
+import { WithEncounteredRecords } from './read';
+import { FragmentReference, Variables } from './FragmentReference';
+import { PromiseWrapper } from './PromiseWrapper';
+import { IsographEntrypoint } from './entrypoint';
+import type { ReaderAst } from './reader';
+import { LogFunction, WrappedLogFunction } from './logging';
+export type ComponentOrFieldName = string;
+export type StringifiedArgs = string;
+type ComponentCache = {
+    [key: DataId]: {
+        [key: ComponentOrFieldName]: {
+            [key: StringifiedArgs]: React.FC<any>;
+        };
+    };
+};
+export type FragmentSubscription<TReadFromStore extends {
+    parameters: object;
+    data: object;
+}> = {
+    readonly kind: 'FragmentSubscription';
+    readonly callback: (newEncounteredDataAndRecords: WithEncounteredRecords<TReadFromStore>) => void;
+    /** The value read out from the previous call to readButDoNotEvaluate */
+    readonly encounteredDataAndRecords: WithEncounteredRecords<TReadFromStore>;
+    readonly fragmentReference: FragmentReference<TReadFromStore, any>;
+    readonly readerAst: ReaderAst<TReadFromStore>;
+};
+type AnyChangesToRecordSubscription = {
+    readonly kind: 'AnyChangesToRecord';
+    readonly callback: () => void;
+    readonly recordLink: Link;
+};
+type AnyRecordSubscription = {
+    readonly kind: 'AnyRecords';
+    readonly callback: () => void;
+};
+type Subscription = FragmentSubscription<{
+    parameters: object;
+    data: object;
+}> | AnyChangesToRecordSubscription | AnyRecordSubscription;
+type Subscriptions = Set<Subscription>;
+type CacheMap<T> = {
+    [index: string]: ParentCache<T>;
+};
+export type IsographEnvironment = {
+    readonly store: IsographStore;
+    readonly networkFunction: IsographNetworkFunction;
+    readonly missingFieldHandler: MissingFieldHandler | null;
+    readonly componentCache: ComponentCache;
+    readonly subscriptions: Subscriptions;
+    readonly fragmentCache: CacheMap<FragmentReference<any, any>>;
+    readonly entrypointArtifactCache: Map<string, PromiseWrapper<IsographEntrypoint<any, any>>>;
+    readonly retainedQueries: Set<RetainedQuery>;
+    readonly gcBuffer: Array<RetainedQuery>;
+    readonly gcBufferSize: number;
+    readonly loggers: Set<WrappedLogFunction>;
+};
+export type MissingFieldHandler = (storeRecord: StoreRecord, root: Link, fieldName: string, arguments_: {
+    [index: string]: any;
+} | null, variables: Variables | null) => Link | undefined;
+export type IsographNetworkFunction = (queryText: string, variables: Variables) => Promise<any>;
+export type Link = {
+    readonly __link: DataId;
+    readonly __typename: TypeName;
+};
+export type DataTypeValue = undefined | number | boolean | string | null | Link | DataTypeValue[];
+export type StoreRecord = {
+    [index: DataId | string]: DataTypeValue;
+    readonly id?: DataId;
+};
+export type TypeName = string;
+export type DataId = string;
+export declare const ROOT_ID: DataId & '__ROOT';
+export type IsographStore = {
+    [index: TypeName]: {
+        [index: DataId]: StoreRecord | null;
+    } | null;
+    readonly Query: {
+        readonly __ROOT: StoreRecord;
+    };
+};
+export declare function createIsographEnvironment(store: IsographStore, networkFunction: IsographNetworkFunction, missingFieldHandler?: MissingFieldHandler | null, logFunction?: LogFunction | null): IsographEnvironment;
+export declare function createIsographStore(): IsographStore;
+export declare function assertLink(link: DataTypeValue): Link | null | undefined;
+export declare function getLink(maybeLink: DataTypeValue): Link | null;
+export declare function getOrLoadIsographArtifact(environment: IsographEnvironment, key: string, loader: () => Promise<IsographEntrypoint<any, any>>): PromiseWrapper<IsographEntrypoint<any, any>>;
+export {};
+//# sourceMappingURL=IsographEnvironment.d.ts.map

package/dist/core/IsographEnvironment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IsographEnvironment.d.ts","sourceRoot":"","sources":["../../src/core/IsographEnvironment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,MAAM,QAAQ,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAe,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAE5D,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAC1C,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AACrC,KAAK,cAAc,GAAG;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,CAAC,GAAG,EAAE,oBAAoB,GAAG;YAAE,CAAC,GAAG,EAAE,eAAe,GAAG,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAA;SAAE,CAAC;KACxE,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAC9B,cAAc,SAAS;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,IACzD;IACF,QAAQ,CAAC,IAAI,EAAE,sBAAsB,CAAC;IACtC,QAAQ,CAAC,QAAQ,EAAE,CACjB,4BAA4B,EAAE,sBAAsB,CAAC,cAAc,CAAC,KACjE,IAAI,CAAC;IACV,wEAAwE;IACxE,QAAQ,CAAC,yBAAyB,EAAE,sBAAsB,CAAC,cAAc,CAAC,CAAC;IAC3E,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;IACnE,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC;CAC/C,CAAC;AAEF,KAAK,8BAA8B,GAAG;IACpC,QAAQ,CAAC,IAAI,EAAE,oBAAoB,CAAC;IACpC,QAAQ,CAAC,QAAQ,EAAE,MAAM,IAAI,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC;CAC3B,CAAC;AAEF,KAAK,qBAAqB,GAAG;IAC3B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,QAAQ,EAAE,MAAM,IAAI,CAAC;CAC/B,CAAC;AAEF,KAAK,YAAY,GACb,oBAAoB,CAAC;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,GAC1D,8BAA8B,GAC9B,qBAAqB,CAAC;AAC1B,KAAK,aAAa,GAAG,GAAG,CAAC,YAAY,CAAC,CAAC;AAEvC,KAAK,QAAQ,CAAC,CAAC,IAAI;IAAE,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;CAAE,CAAC;AAEvD,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,eAAe,EAAE,uBAAuB,CAAC;IAClD,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACzD,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IACxC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IAGtC,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,iBAAiB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IAE9D,QAAQ,CAAC,uBAAuB,EAAE,GAAG,CACnC,MAAM,EACN,cAAc,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAC7C,CAAC;IACF,QAAQ,CAAC,eAAe,EAAE,GAAG,CAAC,aAAa,CAAC,CAAC;IAC7C,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IACxC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,kBAAkB,CAAC,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,CAChC,WAAW,EAAE,WAAW,EACxB,IAAI,EAAE,IAAI,EACV,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE;IAAE,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,GAAG,IAAI,EAC3C,SAAS,EAAE,SAAS,GAAG,IAAI,KACxB,IAAI,GAAG,SAAS,CAAC;AAEtB,MAAM,MAAM,uBAAuB,GAAG,CACpC,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,SAAS,KACjB,OAAO,CAAC,GAAG,CAAC,CAAC;AAElB,MAAM,MAAM,IAAI,GAAG;IACjB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,aAAa,GAGrB,SAAS,GAET,MAAM,GACN,OAAO,GACP,MAAM,GACN,IAAI,GAEJ,IAAI,GAEJ,aAAa,EAAE,CAAC;AAEpB,MAAM,MAAM,WAAW,GAAG;IACxB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,CAAC;IAGxC,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAE5B,eAAO,MAAM,OAAO,EAAE,MAAM,GAAG,QAAmB,CAAC;AAEnD,MAAM,MAAM,aAAa,GAAG;IAC1B,CAAC,KAAK,EAAE,QAAQ,GAAG;QACjB,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,CAAC;KACrC,GAAG,IAAI,CAAC;IACT,QAAQ,CAAC,KAAK,EAAE;QACd,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;KAC9B,CAAC;CACH,CAAC;AAGF,wBAAgB,yBAAyB,CACvC,KAAK,EAAE,aAAa,EACpB,eAAe,EAAE,uBAAuB,EACxC,mBAAmB,CAAC,EAAE,mBAAmB,GAAG,IAAI,EAChD,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI,GAC/B,mBAAmB,CAcrB;AAED,wBAAgB,mBAAmB,IAAI,aAAa,CAMnD;AAED,wBAAgB,UAAU,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,GAAG,IAAI,GAAG,SAAS,CAWvE;AAED,wBAAgB,OAAO,CAAC,SAAS,EAAE,aAAa,GAAG,IAAI,GAAG,IAAI,CAY7D;AAED,wBAAgB,yBAAyB,CACvC,WAAW,EAAE,mBAAmB,EAChC,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,OAAO,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,GAClD,cAAc,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAQ9C"}

package/dist/core/IsographEnvironment.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROOT_ID = void 0;
+exports.createIsographEnvironment = createIsographEnvironment;
+exports.createIsographStore = createIsographStore;
+exports.assertLink = assertLink;
+exports.getLink = getLink;
+exports.getOrLoadIsographArtifact = getOrLoadIsographArtifact;
+const PromiseWrapper_1 = require("./PromiseWrapper");
+exports.ROOT_ID = '__ROOT';
+const DEFAULT_GC_BUFFER_SIZE = 10;
+function createIsographEnvironment(store, networkFunction, missingFieldHandler, logFunction) {
+    return {
+        store,
+        networkFunction,
+        missingFieldHandler: missingFieldHandler !== null && missingFieldHandler !== void 0 ? missingFieldHandler : null,
+        componentCache: {},
+        subscriptions: new Set(),
+        fragmentCache: {},
+        entrypointArtifactCache: new Map(),
+        retainedQueries: new Set(),
+        gcBuffer: [],
+        gcBufferSize: DEFAULT_GC_BUFFER_SIZE,
+        loggers: logFunction != null ? new Set([{ log: logFunction }]) : new Set(),
+    };
+}
+function createIsographStore() {
+    return {
+        Query: {
+            [exports.ROOT_ID]: {},
+        },
+    };
+}
+function assertLink(link) {
+    if (Array.isArray(link)) {
+        throw new Error('Unexpected array');
+    }
+    if (link == null) {
+        return link;
+    }
+    if (typeof link === 'object') {
+        return link;
+    }
+    throw new Error('Invalid link');
+}
+function getLink(maybeLink) {
+    if (maybeLink != null &&
+        typeof maybeLink === 'object' &&
+        '__link' in maybeLink &&
+        maybeLink.__link != null &&
+        '__typename' in maybeLink &&
+        maybeLink.__typename != null) {
+        return maybeLink;
+    }
+    return null;
+}
+function getOrLoadIsographArtifact(environment, key, loader) {
+    const value = environment.entrypointArtifactCache.get(key);
+    if (value != null) {
+        return value;
+    }
+    const wrapped = (0, PromiseWrapper_1.wrapPromise)(loader());
+    environment.entrypointArtifactCache.set(key, wrapped);
+    return wrapped;
+}

package/dist/core/PromiseWrapper.d.ts

@@ -0,0 +1,28 @@
+export type AnyError = any;
+declare const NOT_SET: Symbol;
+type NotSet = typeof NOT_SET;
+type Result<T, E> = {
+    kind: 'Ok';
+    value: T;
+} | {
+    kind: 'Err';
+    error: E;
+};
+/**
+ * Invariant:
+ * Before the promise is resolved, value becomes non-null.
+ */
+export type PromiseWrapper<T, E = any> = {
+    readonly promise: Promise<T>;
+    result: Result<Exclude<T, NotSet>, E> | NotSet;
+};
+export declare function wrapPromise<T>(promise: Promise<T>): PromiseWrapper<T, any>;
+export declare function wrapResolvedValue<T>(value: T): PromiseWrapper<T, never>;
+export declare function readPromise<T, E>(p: PromiseWrapper<T, E>): T;
+export type PromiseState<T, E> = {
+    kind: 'Pending';
+    promise: Promise<T>;
+} | Result<T, E>;
+export declare function getPromiseState<T, E>(p: PromiseWrapper<T, E>): PromiseState<T, E>;
+export {};
+//# sourceMappingURL=PromiseWrapper.d.ts.map

package/dist/core/PromiseWrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PromiseWrapper.d.ts","sourceRoot":"","sources":["../../src/core/PromiseWrapper.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,GAAG,CAAC;AAE3B,QAAA,MAAM,OAAO,EAAE,MAA0B,CAAC;AAC1C,KAAK,MAAM,GAAG,OAAO,OAAO,CAAC;AAE7B,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,IACZ;IACE,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,CAAC,CAAC;CACV,GACD;IACE,IAAI,EAAE,KAAK,CAAC;IACZ,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEN;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,IAAI;IACvC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IAC7B,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC;CAChD,CAAC;AAEF,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,EAAE,GAAG,CAAC,CAa1E;AAED,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,cAAc,CAAC,CAAC,EAAE,KAAK,CAAC,CASvE;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAa5D;AAED,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,IACzB;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;CACrB,GACD,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAEjB,wBAAgB,eAAe,CAAC,CAAC,EAAE,CAAC,EAClC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,GACtB,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAWpB"}

package/dist/core/PromiseWrapper.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapPromise = wrapPromise;
+exports.wrapResolvedValue = wrapResolvedValue;
+exports.readPromise = readPromise;
+exports.getPromiseState = getPromiseState;
+const NOT_SET = Symbol('NOT_SET');
+function wrapPromise(promise) {
+    // TODO confirm suspense works if the promise is already resolved.
+    const wrapper = { promise, result: NOT_SET };
+    promise
+        .then((v) => {
+        // v is assignable to Exclude<T, Symbol> | Symbol
+        wrapper.result = { kind: 'Ok', value: v };
+    })
+        .catch((e) => {
+        // e is assignable to Exclude<T, Symbol> | Symbol
+        wrapper.result = { kind: 'Err', error: e };
+    });
+    return wrapper;
+}
+function wrapResolvedValue(value) {
+    return {
+        promise: Promise.resolve(value),
+        result: {
+            kind: 'Ok',
+            // @ts-expect-error one should not call wrapResolvedValue with NOT_SET
+            value,
+        },
+    };
+}
+function readPromise(p) {
+    const { result } = p;
+    if (result !== NOT_SET) {
+        // Safety: p.result is either NOT_SET or an actual value.
+        const resultKind = result;
+        if (resultKind.kind === 'Ok') {
+            return resultKind.value;
+        }
+        else {
+            throw resultKind.error;
+        }
+    }
+    throw p.promise;
+}
+function getPromiseState(p) {
+    const { result } = p;
+    if (result !== NOT_SET) {
+        // Safety: p.result is either NOT_SET or an actual value.
+        const resultKind = result;
+        return resultKind;
+    }
+    return {
+        kind: 'Pending',
+        promise: p.promise,
+    };
+}

package/dist/core/areEqualWithDeepComparison.d.ts

@@ -0,0 +1,5 @@
+import type { ReaderAst, ReaderLinkedField, ReaderScalarField } from './reader';
+export declare function mergeUsingReaderAst(field: ReaderScalarField | ReaderLinkedField, oldItem: unknown, newItem: unknown): unknown;
+export declare function mergeArraysUsingReaderAst(field: ReaderScalarField | ReaderLinkedField, oldItems: ReadonlyArray<unknown>, newItems: Array<unknown>): ReadonlyArray<unknown>;
+export declare function mergeObjectsUsingReaderAst(ast: ReaderAst<object>, oldItemObject: object, newItemObject: object): object;
+//# sourceMappingURL=areEqualWithDeepComparison.d.ts.map

package/dist/core/areEqualWithDeepComparison.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"areEqualWithDeepComparison.d.ts","sourceRoot":"","sources":["../../src/core/areEqualWithDeepComparison.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAChF,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,iBAAiB,GAAG,iBAAiB,EAC5C,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,GACf,OAAO,CAiCT;AAED,wBAAgB,yBAAyB,CACvC,KAAK,EAAE,iBAAiB,GAAG,iBAAiB,EAC5C,QAAQ,EAAE,aAAa,CAAC,OAAO,CAAC,EAChC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,GACvB,aAAa,CAAC,OAAO,CAAC,CAgBxB;AAED,wBAAgB,0BAA0B,CACxC,GAAG,EAAE,SAAS,CAAC,MAAM,CAAC,EACtB,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,MAAM,GACpB,MAAM,CA6CR"}

package/dist/core/areEqualWithDeepComparison.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeUsingReaderAst = mergeUsingReaderAst;
+exports.mergeArraysUsingReaderAst = mergeArraysUsingReaderAst;
+exports.mergeObjectsUsingReaderAst = mergeObjectsUsingReaderAst;
+function mergeUsingReaderAst(field, oldItem, newItem) {
+    if (newItem === null) {
+        return oldItem === null ? oldItem : newItem;
+    }
+    if (newItem === undefined) {
+        return oldItem === undefined ? oldItem : newItem;
+    }
+    if (Array.isArray(newItem)) {
+        if (!Array.isArray(oldItem)) {
+            return newItem;
+        }
+        return mergeArraysUsingReaderAst(field, oldItem, newItem);
+    }
+    switch (field.kind) {
+        case 'Scalar':
+            return oldItem === newItem ? oldItem : newItem;
+        case 'Linked':
+            if (oldItem == null) {
+                return newItem;
+            }
+            return mergeObjectsUsingReaderAst(field.selections, oldItem, newItem);
+        default: {
+            // Ensure we have covered all variants
+            let _ = field;
+            _;
+            throw new Error('Unexpected case.');
+        }
+    }
+}
+function mergeArraysUsingReaderAst(field, oldItems, newItems) {
+    if (newItems.length !== oldItems.length) {
+        return newItems;
+    }
+    let canRecycle = true;
+    for (let i = 0; i < newItems.length; i++) {
+        const mergedItem = mergeUsingReaderAst(field, oldItems[i], newItems[i]);
+        if (mergedItem !== oldItems[i]) {
+            canRecycle = false;
+        }
+        else {
+            newItems[i] = mergedItem;
+        }
+    }
+    return canRecycle ? oldItems : newItems;
+}
+function mergeObjectsUsingReaderAst(ast, oldItemObject, newItemObject) {
+    var _a;
+    let canRecycle = true;
+    for (const field of ast) {
+        switch (field.kind) {
+            case 'Scalar':
+            case 'Linked':
+                const key = (_a = field.alias) !== null && _a !== void 0 ? _a : field.fieldName;
+                // @ts-expect-error
+                const oldValue = oldItemObject[key];
+                // @ts-expect-error
+                const newValue = newItemObject[key];
+                const mergedValue = mergeUsingReaderAst(field, oldValue, newValue);
+                if (mergedValue !== oldValue) {
+                    canRecycle = false;
+                }
+                else {
+                    // @ts-expect-error
+                    newItemObject[key] = mergedValue;
+                }
+                break;
+            case 'Resolver': {
+                const key = field.alias;
+                // @ts-expect-error
+                const oldValue = oldItemObject[key];
+                // @ts-expect-error
+                const newValue = newItemObject[key];
+                if (oldValue !== newValue) {
+                    canRecycle = false;
+                }
+                break;
+            }
+            case 'ImperativelyLoadedField':
+            case 'LoadablySelectedField':
+                break;
+            default: {
+                // Ensure we have covered all variants
+                let _ = field;
+                _;
+                throw new Error('Unexpected case.');
+            }
+        }
+    }
+    return canRecycle ? oldItemObject : newItemObject;
+}

package/dist/core/cache.d.ts

@@ -0,0 +1,44 @@
+import { Factory, ParentCache } from '@isograph/react-disposable-state';
+import { DataId, Link, type IsographEnvironment, type TypeName } from './IsographEnvironment';
+import { IsographEntrypoint, NormalizationAst, NormalizationLinkedField, NormalizationScalarField, RefetchQueryNormalizationArtifactWrapper } from '../core/entrypoint';
+import { ReaderLinkedField, ReaderScalarField, type ReaderAst } from './reader';
+import { WithEncounteredRecords } from './read';
+import { FragmentReference, Variables, ExtractParameters } from './FragmentReference';
+import { FetchOptions } from './check';
+export declare const TYPENAME_FIELD_NAME = "__typename";
+export declare function getOrCreateItemInSuspenseCache<TReadFromStore extends {
+    parameters: object;
+    data: object;
+}, TClientFieldValue>(environment: IsographEnvironment, index: string, factory: Factory<FragmentReference<TReadFromStore, TClientFieldValue>>): ParentCache<FragmentReference<TReadFromStore, TClientFieldValue>>;
+/**
+ * Creates a copy of the provided value, ensuring any nested objects have their
+ * keys sorted such that equivalent values would have identical JSON.stringify
+ * results.
+ */
+export declare function stableCopy<T>(value: T): T;
+export declare function getOrCreateCacheForArtifact<TReadFromStore extends {
+    parameters: object;
+    data: object;
+}, TClientFieldValue>(environment: IsographEnvironment, entrypoint: IsographEntrypoint<TReadFromStore, TClientFieldValue>, variables: ExtractParameters<TReadFromStore>, fetchOptions?: FetchOptions): ParentCache<FragmentReference<TReadFromStore, TClientFieldValue>>;
+type NetworkResponseScalarValue = string | number | boolean;
+type NetworkResponseValue = NetworkResponseScalarValue | null | NetworkResponseObject | (NetworkResponseObject | null)[] | (NetworkResponseScalarValue | null)[];
+export type NetworkResponseObject = {
+    [index: string]: undefined | NetworkResponseValue;
+    id?: DataId;
+    __typename?: TypeName;
+};
+export declare function normalizeData(environment: IsographEnvironment, normalizationAst: NormalizationAst, networkResponse: NetworkResponseObject, variables: Variables, nestedRefetchQueries: RefetchQueryNormalizationArtifactWrapper[], root: Link): EncounteredIds;
+export declare function subscribeToAnyChange(environment: IsographEnvironment, callback: () => void): () => void;
+export declare function subscribeToAnyChangesToRecord(environment: IsographEnvironment, recordLink: Link, 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 onNextChangeToRecord(environment: IsographEnvironment, recordLink: Link): Promise<void>;
+export type EncounteredIds = Map<TypeName, Set<DataId>>;
+export declare function insertIfNotExists<K, V>(map: Map<K, Set<V>>, key: K): Set<V>;
+export declare function getParentRecordKey(astNode: NormalizationLinkedField | NormalizationScalarField | ReaderLinkedField | ReaderScalarField, variables: Variables): string;
+export declare const FIRST_SPLIT_KEY = "____";
+export declare const SECOND_SPLIT_KEY = "___";
+export {};
+//# sourceMappingURL=cache.d.ts.map

package/dist/core/cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../src/core/cache.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAEP,WAAW,EACZ,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,MAAM,EACN,IAAI,EAGJ,KAAK,mBAAmB,EAIxB,KAAK,QAAQ,EACd,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAEhB,wBAAwB,EACxB,wBAAwB,EACxB,wCAAwC,EACzC,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,KAAK,SAAS,EAAE,MAAM,UAAU,CAAC;AAEhF,OAAO,EAAE,sBAAsB,EAAwB,MAAM,QAAQ,CAAC;AACtE,OAAO,EACL,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EAClB,MAAM,qBAAqB,CAAC;AAK7B,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,eAAO,MAAM,mBAAmB,eAAe,CAAC;AAEhD,wBAAgB,8BAA8B,CAC5C,cAAc,SAAS;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAC3D,iBAAiB,EAEjB,WAAW,EAAE,mBAAmB,EAChC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,OAAO,CAAC,iBAAiB,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC,GACrE,WAAW,CAAC,iBAAiB,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC,CAanE;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAezC;AAED,wBAAgB,2BAA2B,CACzC,cAAc,SAAS;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAC3D,iBAAiB,EAEjB,WAAW,EAAE,mBAAmB,EAChC,UAAU,EAAE,kBAAkB,CAAC,cAAc,EAAE,iBAAiB,CAAC,EACjE,SAAS,EAAE,iBAAiB,CAAC,cAAc,CAAC,EAC5C,YAAY,CAAC,EAAE,YAAY,GAC1B,WAAW,CAAC,iBAAiB,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC,CAgCnE;AAED,KAAK,0BAA0B,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAC5D,KAAK,oBAAoB,GACrB,0BAA0B,GAC1B,IAAI,GACJ,qBAAqB,GACrB,CAAC,qBAAqB,GAAG,IAAI,CAAC,EAAE,GAChC,CAAC,0BAA0B,GAAG,IAAI,CAAC,EAAE,CAAC;AAE1C,MAAM,MAAM,qBAAqB,GAAG;IAGlC,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,oBAAoB,CAAC;IAClD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,QAAQ,CAAC;CACvB,CAAC;AAEF,wBAAgB,aAAa,CAC3B,WAAW,EAAE,mBAAmB,EAChC,gBAAgB,EAAE,gBAAgB,EAClC,eAAe,EAAE,qBAAqB,EACtC,SAAS,EAAE,SAAS,EACpB,oBAAoB,EAAE,wCAAwC,EAAE,EAChE,IAAI,EAAE,IAAI,GACT,cAAc,CAgChB;AAED,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,mBAAmB,EAChC,QAAQ,EAAE,MAAM,IAAI,GACnB,MAAM,IAAI,CAOZ;AAED,wBAAgB,6BAA6B,CAC3C,WAAW,EAAE,mBAAmB,EAChC,UAAU,EAAE,IAAI,EAChB,QAAQ,EAAE,MAAM,IAAI,GACnB,MAAM,IAAI,CAQZ;AAGD,wBAAgB,SAAS,CACvB,cAAc,SAAS;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAE3D,WAAW,EAAE,mBAAmB,EAChC,yBAAyB,EAAE,sBAAsB,CAAC,cAAc,CAAC,EACjE,iBAAiB,EAAE,iBAAiB,CAAC,cAAc,EAAE,GAAG,CAAC,EACzD,QAAQ,EAAE,CACR,4BAA4B,EAAE,sBAAsB,CAAC,cAAc,CAAC,KACjE,IAAI,EACT,SAAS,EAAE,SAAS,CAAC,cAAc,CAAC,GACnC,MAAM,IAAI,CAUZ;AAED,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,mBAAmB,EAChC,UAAU,EAAE,IAAI,GACf,OAAO,CAAC,IAAI,CAAC,CAWf;AA8HD,MAAM,MAAM,cAAc,GAAG,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;AA6ExD,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,UAOlE;AAwPD,wBAAgB,kBAAkB,CAChC,OAAO,EACH,wBAAwB,GACxB,wBAAwB,GACxB,iBAAiB,GACjB,iBAAiB,EACrB,SAAS,EAAE,SAAS,GACnB,MAAM,CAUR;AA0ED,eAAO,MAAM,eAAe,SAAS,CAAC;AACtC,eAAO,MAAM,gBAAgB,QAAQ,CAAC"}