@isograph/react 0.2.0 → 0.3.1

package/dist/core/makeNetworkRequest.js

@@ -1,39 +1,97 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeNetworkRequest = void 0;
+exports.maybeMakeNetworkRequest = maybeMakeNetworkRequest;
+exports.makeNetworkRequest = makeNetworkRequest;
+const cache_1 = require("./cache");
+const check_1 = require("./check");
+const componentCache_1 = require("./componentCache");
 const garbageCollection_1 = require("./garbageCollection");
+const IsographEnvironment_1 = require("./IsographEnvironment");
+const logging_1 = require("./logging");
 const PromiseWrapper_1 = require("./PromiseWrapper");
-const cache_1 = require("./cache");
-function makeNetworkRequest(environment, artifact, variables) {
-    // @ts-expect-error
-    if (typeof window !== 'undefined' && window.__LOG) {
-        console.log('make network request', artifact, variables);
+const read_1 = require("./read");
+const startUpdate_1 = require("./startUpdate");
+let networkRequestId = 0;
+function maybeMakeNetworkRequest(environment, artifact, variables, fetchOptions) {
+    var _a;
+    switch ((_a = fetchOptions === null || fetchOptions === void 0 ? void 0 : fetchOptions.shouldFetch) !== null && _a !== void 0 ? _a : check_1.DEFAULT_SHOULD_FETCH_VALUE) {
+        case 'Yes': {
+            return makeNetworkRequest(environment, artifact, variables, fetchOptions);
+        }
+        case 'No': {
+            return [(0, PromiseWrapper_1.wrapResolvedValue)(undefined), () => { }];
+        }
+        case 'IfNecessary': {
+            if (artifact.networkRequestInfo.normalizationAst.kind ===
+                'NormalizationAstLoader') {
+                throw new Error('Using lazy loaded normalizationAst with shouldFetch: "IfNecessary" is not supported as it will lead to slower initial load time.');
+            }
+            const result = (0, check_1.check)(environment, artifact.networkRequestInfo.normalizationAst.selections, variables, {
+                __link: IsographEnvironment_1.ROOT_ID,
+                __typename: artifact.concreteType,
+            });
+            if (result.kind === 'EnoughData') {
+                return [(0, PromiseWrapper_1.wrapResolvedValue)(undefined), () => { }];
+            }
+            else {
+                return makeNetworkRequest(environment, artifact, variables, fetchOptions);
+            }
+        }
     }
+}
+function loadNormalizationAst(normalizationAst) {
+    switch (normalizationAst.kind) {
+        case 'NormalizationAst': {
+            return normalizationAst;
+        }
+        case 'NormalizationAstLoader': {
+            return normalizationAst.loader();
+        }
+    }
+}
+function makeNetworkRequest(environment, artifact, variables, fetchOptions) {
+    // TODO this should be a DataId and stored in the store
+    const myNetworkRequestId = networkRequestId + '';
+    networkRequestId++;
+    (0, logging_1.logMessage)(environment, () => ({
+        kind: 'MakeNetworkRequest',
+        artifact,
+        variables,
+        networkRequestId: myNetworkRequestId,
+    }));
     let status = {
         kind: 'UndisposedIncomplete',
     };
     // This should be an observable, not a promise
-    const promise = environment
-        .networkFunction(artifact.queryText, variables)
-        .then((networkResponse) => {
-        var _a;
-        // @ts-expect-error
-        if (typeof window !== 'undefined' && window.__LOG) {
-            console.log('network response', artifact, networkResponse);
-        }
+    const promise = Promise.all([
+        environment.networkFunction(artifact.networkRequestInfo.queryText, variables),
+        loadNormalizationAst(artifact.networkRequestInfo.normalizationAst),
+    ])
+        .then(([networkResponse, normalizationAst]) => {
+        var _a, _b;
+        (0, logging_1.logMessage)(environment, () => ({
+            kind: 'ReceivedNetworkResponse',
+            networkResponse,
+            networkRequestId: myNetworkRequestId,
+        }));
         if (networkResponse.errors != null) {
-            // @ts-expect-error Why are we getting the wrong constructor here?
+            try {
+                (_a = fetchOptions === null || fetchOptions === void 0 ? void 0 : fetchOptions.onError) === null || _a === void 0 ? void 0 : _a.call(fetchOptions);
+            }
+            catch (_c) { }
             throw new Error('GraphQL network response had errors', {
                 cause: networkResponse,
             });
         }
+        const root = { __link: IsographEnvironment_1.ROOT_ID, __typename: artifact.concreteType };
         if (status.kind === 'UndisposedIncomplete') {
-            (0, cache_1.normalizeData)(environment, artifact.normalizationAst, (_a = networkResponse.data) !== null && _a !== void 0 ? _a : {}, variables, artifact.kind === 'Entrypoint'
+            (0, cache_1.normalizeData)(environment, normalizationAst.selections, (_b = networkResponse.data) !== null && _b !== void 0 ? _b : {}, variables, artifact.kind === 'Entrypoint'
                 ? artifact.readerWithRefetchQueries.nestedRefetchQueries
-                : []);
+                : [], root);
             const retainedQuery = {
-                normalizationAst: artifact.normalizationAst,
+                normalizationAst: normalizationAst.selections,
                 variables,
+                root,
             };
             status = {
                 kind: 'UndisposedComplete',
@@ -41,6 +99,31 @@ function makeNetworkRequest(environment, artifact, variables) {
             };
             (0, garbageCollection_1.retainQuery)(environment, retainedQuery);
         }
+        const onComplete = fetchOptions === null || fetchOptions === void 0 ? void 0 : fetchOptions.onComplete;
+        if (onComplete != null) {
+            let data = readDataForOnComplete(artifact, environment, root, variables);
+            try {
+                // @ts-expect-error this problem will be fixed when we remove RefetchQueryNormalizationArtifact
+                // (or we can fix this by having a single param of type { kind: 'Entrypoint', entrypoint,
+                // fetchOptions: FetchOptions<TReadFromStore> } | { kind: 'RefetchQuery', refetchQuery,
+                // fetchOptions: FetchOptions<void> }).
+                onComplete(data);
+            }
+            catch (_d) { }
+        }
+    })
+        .catch((e) => {
+        var _a;
+        (0, logging_1.logMessage)(environment, () => ({
+            kind: 'ReceivedNetworkError',
+            networkRequestId: myNetworkRequestId,
+            error: e,
+        }));
+        try {
+            (_a = fetchOptions === null || fetchOptions === void 0 ? void 0 : fetchOptions.onError) === null || _a === void 0 ? void 0 : _a.call(fetchOptions);
+        }
+        catch (_b) { }
+        throw e;
     });
     const wrapper = (0, PromiseWrapper_1.wrapPromise)(promise);
     const response = [
@@ -59,4 +142,62 @@ function makeNetworkRequest(environment, artifact, variables) {
     ];
     return response;
 }
-exports.makeNetworkRequest = makeNetworkRequest;
+function readDataForOnComplete(artifact, environment, root, variables) {
+    // An entrypoint, but not a RefetchQueryNormalizationArtifact, has a reader ASTs.
+    // So, we can only pass data to onComplete if makeNetworkRequest was passed an entrypoint.
+    // This is awkward, since we don't express that in the types of the parameters
+    // (i.e. FetchOptions could be passed, along with a RefetchQueryNormalizationArtifact).
+    //
+    // However, this isn't a big deal: RefetchQueryNormalizationArtifact is going away.
+    if (artifact.kind === 'Entrypoint') {
+        // TODO this is a smell!
+        const fakeNetworkRequest = (0, PromiseWrapper_1.wrapResolvedValue)(undefined);
+        // TODO this is a smell — we know the network response is not in flight,
+        // so we don't really care!
+        const fakeNetworkRequestOptions = {
+            suspendIfInFlight: false,
+            throwOnNetworkError: false,
+        };
+        const fragment = {
+            kind: 'FragmentReference',
+            // TODO this smells.
+            readerWithRefetchQueries: (0, PromiseWrapper_1.wrapResolvedValue)(artifact.readerWithRefetchQueries),
+            root,
+            variables,
+            networkRequest: fakeNetworkRequest,
+        };
+        const fragmentResult = (0, read_1.readButDoNotEvaluate)(environment, fragment, fakeNetworkRequestOptions).item;
+        const readerArtifact = artifact.readerWithRefetchQueries.readerArtifact;
+        switch (readerArtifact.kind) {
+            case 'ComponentReaderArtifact': {
+                // @ts-expect-error We should find a way to encode this in the type system:
+                // if we have a ComponentReaderArtifact, we will necessarily have a
+                // TClientFieldValue which is a React.FC<...>
+                return (0, componentCache_1.getOrCreateCachedComponent)(environment, readerArtifact.fieldName, {
+                    kind: 'FragmentReference',
+                    readerWithRefetchQueries: (0, PromiseWrapper_1.wrapResolvedValue)({
+                        kind: 'ReaderWithRefetchQueries',
+                        readerArtifact: readerArtifact,
+                        nestedRefetchQueries: artifact.readerWithRefetchQueries.nestedRefetchQueries,
+                    }),
+                    root,
+                    variables,
+                    networkRequest: fakeNetworkRequest,
+                }, fakeNetworkRequestOptions);
+            }
+            case 'EagerReaderArtifact': {
+                return readerArtifact.resolver(Object.assign({ data: fragmentResult, parameters: variables }, (readerArtifact.hasUpdatable
+                    ? {
+                        startUpdate: (0, startUpdate_1.getOrCreateCachedStartUpdate)(environment, fragment, artifact.readerWithRefetchQueries.readerArtifact.fieldName),
+                    }
+                    : undefined)));
+            }
+            default: {
+                const _ = readerArtifact;
+                _;
+                throw new Error('Expected case');
+            }
+        }
+    }
+    return null;
+}

package/dist/core/read.d.ts

@@ -1,12 +1,32 @@
-import { FragmentReference } from './FragmentReference';
-import { DataId, IsographEnvironment } from './IsographEnvironment';
+import { type EncounteredIds } from './cache';
+import { RefetchQueryNormalizationArtifactWrapper } from './entrypoint';
+import { ExtractData, FragmentReference, Variables, type UnknownTReadFromStore } from './FragmentReference';
+import { IsographEnvironment, type DataTypeValue, type Link, type StoreRecord } from './IsographEnvironment';
+import { PromiseWrapper } from './PromiseWrapper';
+import { ReaderAst, type ReaderImperativelyLoadedField, type ReaderLinkedField, type ReaderLoadableField, type ReaderNonLoadableResolverField, type ReaderScalarField } from './reader';
 export type WithEncounteredRecords<T> = {
-    readonly encounteredRecords: Set<DataId>;
-    readonly item: T;
+    readonly encounteredRecords: EncounteredIds;
+    readonly item: ExtractData<T>;
 };
-export declare function readButDoNotEvaluate<TReadFromStore extends Object>(environment: IsographEnvironment, fragmentReference: FragmentReference<TReadFromStore, unknown>, networkRequestOptions: NetworkRequestReaderOptions): WithEncounteredRecords<TReadFromStore>;
+export declare function readButDoNotEvaluate<TReadFromStore extends UnknownTReadFromStore>(environment: IsographEnvironment, fragmentReference: FragmentReference<TReadFromStore, unknown>, networkRequestOptions: NetworkRequestReaderOptions): WithEncounteredRecords<TReadFromStore>;
+export type ReadDataResultSuccess<Data> = {
+    readonly kind: 'Success';
+    readonly data: Data;
+};
+export type ReadDataResult<Data> = ReadDataResultSuccess<Data> | {
+    readonly kind: 'MissingData';
+    readonly reason: string;
+    readonly nestedReason?: ReadDataResult<unknown>;
+    readonly recordLink: Link;
+};
+export declare function readLoadablySelectedFieldData(environment: IsographEnvironment, field: ReaderLoadableField, root: Link, variables: Variables, networkRequest: PromiseWrapper<void, any>, networkRequestOptions: NetworkRequestReaderOptions, mutableEncounteredRecords: EncounteredIds): ReadDataResult<unknown>;
+export declare function readResolverFieldData(environment: IsographEnvironment, field: ReaderNonLoadableResolverField, root: Link, variables: Variables, nestedRefetchQueries: RefetchQueryNormalizationArtifactWrapper[], networkRequest: PromiseWrapper<void, any>, networkRequestOptions: NetworkRequestReaderOptions, mutableEncounteredRecords: EncounteredIds): ReadDataResult<unknown>;
+export declare function readScalarFieldData(field: ReaderScalarField, storeRecord: StoreRecord, root: Link, variables: Variables): ReadDataResult<string | number | boolean | Link | DataTypeValue[] | null>;
+export declare function readLinkedFieldData(environment: IsographEnvironment, field: ReaderLinkedField, storeRecord: StoreRecord, root: Link, variables: Variables, networkRequest: PromiseWrapper<void, any>, readData: <TReadFromStore>(ast: ReaderAst<TReadFromStore>, root: Link) => ReadDataResult<object>): ReadDataResult<unknown>;
 export type NetworkRequestReaderOptions = {
     suspendIfInFlight: boolean;
     throwOnNetworkError: boolean;
 };
 export declare function getNetworkRequestOptionsWithDefaults(networkRequestOptions?: Partial<NetworkRequestReaderOptions> | void): NetworkRequestReaderOptions;
+export declare function readImperativelyLoadedField(environment: IsographEnvironment, field: ReaderImperativelyLoadedField, root: Link, variables: Variables, nestedRefetchQueries: RefetchQueryNormalizationArtifactWrapper[], networkRequest: PromiseWrapper<void, any>, networkRequestOptions: NetworkRequestReaderOptions, mutableEncounteredRecords: EncounteredIds): ReadDataResult<unknown>;
+//# sourceMappingURL=read.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"read.d.ts","sourceRoot":"","sources":["../../src/core/read.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,KAAK,cAAc,EACpB,MAAM,SAAS,CAAC;AAGjB,OAAO,EAEL,wCAAwC,EAEzC,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,WAAW,EACX,iBAAiB,EACjB,SAAS,EACT,KAAK,qBAAqB,EAC3B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAGL,mBAAmB,EACnB,KAAK,aAAa,EAClB,KAAK,IAAI,EACT,KAAK,WAAW,EACjB,MAAM,uBAAuB,CAAC;AAG/B,OAAO,EAEL,cAAc,EAKf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,SAAS,EACT,KAAK,6BAA6B,EAClC,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,8BAA8B,EACnC,KAAK,iBAAiB,EACvB,MAAM,UAAU,CAAC;AAIlB,MAAM,MAAM,sBAAsB,CAAC,CAAC,IAAI;IACtC,QAAQ,CAAC,kBAAkB,EAAE,cAAc,CAAC;IAC5C,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CAC/B,CAAC;AAEF,wBAAgB,oBAAoB,CAClC,cAAc,SAAS,qBAAqB,EAE5C,WAAW,EAAE,mBAAmB,EAChC,iBAAiB,EAAE,iBAAiB,CAAC,cAAc,EAAE,OAAO,CAAC,EAC7D,qBAAqB,EAAE,2BAA2B,GACjD,sBAAsB,CAAC,cAAc,CAAC,CAmExC;AAED,MAAM,MAAM,qBAAqB,CAAC,IAAI,IAAI;IACxC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,IAAI,IAC3B,qBAAqB,CAAC,IAAI,CAAC,GAC3B;IACE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,YAAY,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;IAChD,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC;CAC3B,CAAC;AA6IN,wBAAgB,6BAA6B,CAC3C,WAAW,EAAE,mBAAmB,EAChC,KAAK,EAAE,mBAAmB,EAC1B,IAAI,EAAE,IAAI,EACV,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,EACzC,qBAAqB,EAAE,2BAA2B,EAClD,yBAAyB,EAAE,cAAc,GACxC,cAAc,CAAC,OAAO,CAAC,CA4JzB;AAoFD,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,mBAAmB,EAChC,KAAK,EAAE,8BAA8B,EACrC,IAAI,EAAE,IAAI,EACV,SAAS,EAAE,SAAS,EACpB,oBAAoB,EAAE,wCAAwC,EAAE,EAChE,cAAc,EAAE,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,EACzC,qBAAqB,EAAE,2BAA2B,EAClD,yBAAyB,EAAE,cAAc,GACxC,cAAc,CAAC,OAAO,CAAC,CA+EzB;AAED,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,iBAAiB,EACxB,WAAW,EAAE,WAAW,EACxB,IAAI,EAAE,IAAI,EACV,SAAS,EAAE,SAAS,GACnB,cAAc,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,aAAa,EAAE,GAAG,IAAI,CAAC,CAa3E;AAED,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,mBAAmB,EAChC,KAAK,EAAE,iBAAiB,EACxB,WAAW,EAAE,WAAW,EACxB,IAAI,EAAE,IAAI,EACV,SAAS,EAAE,SAAS,EACpB,cAAc,EAAE,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,EAEzC,QAAQ,EAAE,CAAC,cAAc,EACvB,GAAG,EAAE,SAAS,CAAC,cAAc,CAAC,EAC9B,IAAI,EAAE,IAAI,KACP,cAAc,CAAC,MAAM,CAAC,GAC1B,cAAc,CAAC,OAAO,CAAC,CA6JzB;AAED,MAAM,MAAM,2BAA2B,GAAG;IACxC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,mBAAmB,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF,wBAAgB,oCAAoC,CAClD,qBAAqB,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,GAAG,IAAI,GAClE,2BAA2B,CAK7B;AAiBD,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,mBAAmB,EAChC,KAAK,EAAE,6BAA6B,EACpC,IAAI,EAAE,IAAI,EACV,SAAS,EAAE,SAAS,EACpB,oBAAoB,EAAE,wCAAwC,EAAE,EAChE,cAAc,EAAE,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,EACzC,qBAAqB,EAAE,2BAA2B,EAClD,yBAAyB,EAAE,cAAc,GACxC,cAAc,CAAC,OAAO,CAAC,CAuDzB"}