@graphitation/apollo-react-relay-duct-tape 0.7.3 → 1.0.0-alpha.1

package/lib/storeObservation/compiledHooks/useCompiledLazyLoadQuery.mjs

@@ -0,0 +1,73 @@
+// src/storeObservation/compiledHooks/useCompiledLazyLoadQuery.ts
+import {useRef, useEffect} from "react";
+import {
+  useApolloClient,
+  useQuery as useApolloQuery
+} from "@apollo/client";
+import invariant from "invariant";
+import {useDeepCompareMemoize} from "./useDeepCompareMemoize.mjs";
+import {useForceUpdate} from "./useForceUpdate.mjs";
+var ExecutionQueryHandler = class {
+  constructor(onComplete) {
+    this.onComplete = onComplete;
+    this.status = [true, void 0];
+  }
+  isIdle() {
+    return this.status[0] && this.querySubscription === void 0;
+  }
+  dispose() {
+    var _a;
+    (_a = this.querySubscription) == null ? void 0 : _a.unsubscribe();
+    this.querySubscription = void 0;
+  }
+  reset() {
+    this.dispose();
+    this.status = [true, void 0];
+  }
+  handleResult(error) {
+    this.status = [false, error];
+    this.dispose();
+    this.onComplete();
+  }
+  subscribe(observable) {
+    this.querySubscription = observable.subscribe(({error: err}) => {
+      this.handleResult(err);
+    }, (err) => {
+      this.handleResult(err);
+    });
+  }
+};
+function useExecutionQuery(executionQueryDocument, variables) {
+  const client = useApolloClient();
+  const forceUpdate = useForceUpdate();
+  const execution = useRef(new ExecutionQueryHandler(() => forceUpdate()));
+  useEffect(() => {
+    if (execution.current.isIdle()) {
+      execution.current.subscribe(client.watchQuery({
+        query: executionQueryDocument,
+        variables
+      }));
+    }
+    return () => {
+      execution.current.reset();
+    };
+  }, [executionQueryDocument, variables]);
+  return execution.current.status;
+}
+function useCompiledLazyLoadQuery(documents, options) {
+  const {watchQueryDocument} = documents;
+  invariant(watchQueryDocument, "useLazyLoadQuery(): Expected a `watchQueryDocument` to have been extracted. Did you forget to invoke the compiler?");
+  const {executionQueryDocument} = documents;
+  invariant(executionQueryDocument, "useLazyLoadQuery(): Expected a `executionQueryDocument` to have been extracted. Did you forget to invoke the compiler?");
+  const variables = useDeepCompareMemoize(options.variables);
+  const [loading, error] = useExecutionQuery(executionQueryDocument, variables);
+  const {data} = useApolloQuery(watchQueryDocument, {
+    variables,
+    fetchPolicy: "cache-only",
+    skip: loading || !!error
+  });
+  return {data, error};
+}
+export {
+  useCompiledLazyLoadQuery
+};

package/lib/storeObservation/compiledHooks/useCompiledLazyLoadQuery.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/storeObservation/compiledHooks/useCompiledLazyLoadQuery.ts"],
+  "sourcesContent": ["import { useRef, useEffect } from \"react\";\nimport {\n  useApolloClient,\n  useQuery as useApolloQuery,\n  ObservableQuery,\n} from \"@apollo/client\";\nimport invariant from \"invariant\";\nimport { useDeepCompareMemoize } from \"./useDeepCompareMemoize\";\nimport { CompiledArtefactModule } from \"relay-compiler-language-graphitation\";\nimport { DocumentNode } from \"graphql\";\nimport { useForceUpdate } from \"./useForceUpdate\";\n\nclass ExecutionQueryHandler {\n  public status: [loading: boolean, error?: Error];\n  private querySubscription?: ZenObservable.Subscription;\n\n  constructor(private onComplete: () => void) {\n    this.status = [true, undefined];\n  }\n\n  public isIdle() {\n    return this.status[0] && this.querySubscription === undefined;\n  }\n\n  public dispose() {\n    this.querySubscription?.unsubscribe();\n    this.querySubscription = undefined;\n  }\n\n  public reset() {\n    this.dispose();\n    this.status = [true, undefined];\n  }\n\n  private handleResult(error?: Error) {\n    this.status = [false, error];\n    this.dispose();\n    this.onComplete();\n  }\n\n  public subscribe(observable: ObservableQuery) {\n    this.querySubscription = observable.subscribe(\n      ({ error: err }) => {\n        this.handleResult(err);\n      },\n      (err) => {\n        this.handleResult(err);\n      }\n    );\n  }\n}\n\nfunction useExecutionQuery(\n  executionQueryDocument: DocumentNode,\n  variables: Record<string, any>\n): [loading: boolean, error?: Error] {\n  const client = useApolloClient();\n  const forceUpdate = useForceUpdate();\n  const execution = useRef(new ExecutionQueryHandler(() => forceUpdate()));\n  useEffect(() => {\n    if (execution.current.isIdle()) {\n      execution.current.subscribe(\n        client.watchQuery({\n          query: executionQueryDocument,\n          variables,\n        })\n      );\n    }\n    return () => {\n      execution.current.reset();\n    };\n  }, [executionQueryDocument, variables]);\n  return execution.current.status;\n}\n\n/**\n * @todo Rewrite this to mimic Relay's preload APIs\n *\n * @param documents Compiled execute and watch query documents that are used to\n *                  setup a narrow observable for just the data selected by the\n *                  original fragment.\n * @param options An object containing a variables field.\n */\nexport function useCompiledLazyLoadQuery(\n  documents: CompiledArtefactModule,\n  options: { variables: Record<string, any> }\n): { data?: any; error?: Error } {\n  const { watchQueryDocument } = documents;\n  invariant(\n    watchQueryDocument,\n    \"useLazyLoadQuery(): Expected a `watchQueryDocument` to have been \" +\n      \"extracted. Did you forget to invoke the compiler?\"\n  );\n  const { executionQueryDocument } = documents;\n  invariant(\n    executionQueryDocument,\n    \"useLazyLoadQuery(): Expected a `executionQueryDocument` to have been \" +\n      \"extracted. Did you forget to invoke the compiler?\"\n  );\n  const variables = useDeepCompareMemoize(options.variables);\n  // First fetch all data needed for the entire tree...\n  const [loading, error] = useExecutionQuery(executionQueryDocument, variables);\n  // ...then fetch/watch data for only the calling component...\n  const { data } = useApolloQuery(watchQueryDocument, {\n    variables,\n    fetchPolicy: \"cache-only\",\n    // ...but only once finished loading.\n    skip: loading || !!error,\n  });\n  return { data, error };\n}\n"],
+  "mappings": ";AAAA;AACA;AAAA;AAAA;AAAA;AAKA;AACA;AAGA;AAEA,kCAA4B;AAAA,EAI1B,YAAoB,YAAwB;AAAxB;AAClB,SAAK,SAAS,CAAC,MAAM;AAAA;AAAA,EAGhB,SAAS;AACd,WAAO,KAAK,OAAO,MAAM,KAAK,sBAAsB;AAAA;AAAA,EAG/C,UAAU;AAxBnB;AAyBI,eAAK,sBAAL,mBAAwB;AACxB,SAAK,oBAAoB;AAAA;AAAA,EAGpB,QAAQ;AACb,SAAK;AACL,SAAK,SAAS,CAAC,MAAM;AAAA;AAAA,EAGf,aAAa,OAAe;AAClC,SAAK,SAAS,CAAC,OAAO;AACtB,SAAK;AACL,SAAK;AAAA;AAAA,EAGA,UAAU,YAA6B;AAC5C,SAAK,oBAAoB,WAAW,UAClC,CAAC,CAAE,OAAO,SAAU;AAClB,WAAK,aAAa;AAAA,OAEpB,CAAC,QAAQ;AACP,WAAK,aAAa;AAAA;AAAA;AAAA;AAM1B,2BACE,wBACA,WACmC;AACnC,QAAM,SAAS;AACf,QAAM,cAAc;AACpB,QAAM,YAAY,OAAO,IAAI,sBAAsB,MAAM;AACzD,YAAU,MAAM;AACd,QAAI,UAAU,QAAQ,UAAU;AAC9B,gBAAU,QAAQ,UAChB,OAAO,WAAW;AAAA,QAChB,OAAO;AAAA,QACP;AAAA;AAAA;AAIN,WAAO,MAAM;AACX,gBAAU,QAAQ;AAAA;AAAA,KAEnB,CAAC,wBAAwB;AAC5B,SAAO,UAAU,QAAQ;AAAA;AAWpB,kCACL,WACA,SAC+B;AAC/B,QAAM,CAAE,sBAAuB;AAC/B,YACE,oBACA;AAGF,QAAM,CAAE,0BAA2B;AACnC,YACE,wBACA;AAGF,QAAM,YAAY,sBAAsB,QAAQ;AAEhD,QAAM,CAAC,SAAS,SAAS,kBAAkB,wBAAwB;AAEnE,QAAM,CAAE,QAAS,eAAe,oBAAoB;AAAA,IAClD;AAAA,IACA,aAAa;AAAA,IAEb,MAAM,WAAW,CAAC,CAAC;AAAA;AAErB,SAAO,CAAE,MAAM;AAAA;",
+  "names": []
+}

package/lib/storeObservation/compiledHooks/useCompiledPaginationFragment.d.ts

@@ -0,0 +1,15 @@
+import { CompiledArtefactModule } from "relay-compiler-language-graphitation";
+import { FragmentReference } from "./types";
+import type { RefetchFn, Disposable, RefetchOptions } from "./useCompiledRefetchableFragment";
+export declare type PaginationFn = (count: number, options?: RefetchOptions) => Disposable;
+export declare function useCompiledPaginationFragment(documents: CompiledArtefactModule, fragmentReference: FragmentReference): {
+    data: any;
+    loadNext: PaginationFn;
+    loadPrevious: PaginationFn;
+    hasNext: boolean;
+    hasPrevious: boolean;
+    isLoadingNext: boolean;
+    isLoadingPrevious: boolean;
+    refetch: RefetchFn;
+};
+//# sourceMappingURL=useCompiledPaginationFragment.d.ts.map

package/lib/storeObservation/compiledHooks/useCompiledPaginationFragment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCompiledPaginationFragment.d.ts","sourceRoot":"","sources":["../../../src/storeObservation/compiledHooks/useCompiledPaginationFragment.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAE9E,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,KAAK,EACV,SAAS,EACT,UAAU,EAEV,cAAc,EACf,MAAM,kCAAkC,CAAC;AAI1C,oBAAY,YAAY,GAAG,CACzB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,cAAc,KACrB,UAAU,CAAC;AAmLhB,wBAAgB,6BAA6B,CAC3C,SAAS,EAAE,sBAAsB,EACjC,iBAAiB,EAAE,iBAAiB,GACnC;IACD,IAAI,EAAE,GAAG,CAAC;IACV,QAAQ,EAAE,YAAY,CAAC;IACvB,YAAY,EAAE,YAAY,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC;IACrB,aAAa,EAAE,OAAO,CAAC;IACvB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,OAAO,EAAE,SAAS,CAAC;CACpB,CA2DA"}

package/lib/storeObservation/compiledHooks/useCompiledPaginationFragment.js

@@ -0,0 +1,176 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, {enumerable: true, configurable: true, writable: true, value}) : obj[key] = value;
+var __objSpread = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __markAsModule = (target) => __defProp(target, "__esModule", {value: true});
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, {get: all[name], enumerable: true});
+};
+var __reExport = (target, module2, desc) => {
+  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
+    for (let key of __getOwnPropNames(module2))
+      if (!__hasOwnProp.call(target, key) && key !== "default")
+        __defProp(target, key, {get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable});
+  }
+  return target;
+};
+var __toModule = (module2) => {
+  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", module2 && module2.__esModule && "default" in module2 ? {get: () => module2.default, enumerable: true} : {value: module2, enumerable: true})), module2);
+};
+__markAsModule(exports);
+__export(exports, {
+  useCompiledPaginationFragment: () => useCompiledPaginationFragment
+});
+var import_react = __toModule(require("react"));
+var import_client = __toModule(require("@apollo/client"));
+var import_invariant = __toModule(require("invariant"));
+var import_useCompiledRefetchableFragment = __toModule(require("./useCompiledRefetchableFragment"));
+function useLoadMore({
+  fragmentReference,
+  refetch,
+  metadata,
+  executionQueryDocument,
+  cache,
+  countVariable,
+  cursorVariable,
+  connectionSelectionPath,
+  cursorValue,
+  updater
+}) {
+  const [isLoadingMore, setIsLoadingMore] = (0, import_react.useState)(false);
+  const loadPage = (0, import_react.useCallback)((countValue, options) => {
+    (0, import_invariant.default)(countVariable, "usePaginationFragment(): Expected a count variable to exist");
+    (0, import_invariant.default)(cursorVariable, "usePaginationFragment(): Expected a cursor variable to exist");
+    (0, import_invariant.default)(cursorValue, "usePaginationFragment(): Expected a cursor value to exist");
+    const previousVariables = __objSpread(__objSpread({}, fragmentReference.__fragments), {
+      id: fragmentReference.id
+    });
+    const newVariables = __objSpread(__objSpread({}, previousVariables), {
+      [countVariable]: countValue,
+      [cursorVariable]: cursorValue
+    });
+    const refetchOptions = {
+      fetchPolicy: "no-cache",
+      UNSTABLE_onCompletedWithData: (error, data) => {
+        var _a;
+        setIsLoadingMore(false);
+        if (!error) {
+          (0, import_invariant.default)(data, "usePaginationFragment(): Expected to have response data");
+          const newData = metadata.rootSelection ? data[metadata.rootSelection] : data;
+          const mainFragment = metadata.mainFragment;
+          (0, import_invariant.default)(mainFragment, "usePaginationFragment(): Expected mainFragment metadata");
+          const cacheSelector = {
+            id: fragmentReference.id ? `${mainFragment.typeCondition}:${fragmentReference.id}` : "ROOT_QUERY",
+            variables: previousVariables,
+            fragmentName: mainFragment.name,
+            fragment: {
+              kind: "Document",
+              definitions: executionQueryDocument.definitions.filter((def) => def.kind === "FragmentDefinition")
+            }
+          };
+          const existingData = cache.readFragment(cacheSelector);
+          const newCacheData = mergeEdges(connectionSelectionPath, newData, existingData, updater);
+          cache.writeFragment(__objSpread(__objSpread({}, cacheSelector), {
+            variables: newVariables,
+            data: newCacheData
+          }));
+        }
+        (_a = options == null ? void 0 : options.onCompleted) == null ? void 0 : _a.call(options, error);
+      }
+    };
+    const disposable = refetch(newVariables, refetchOptions);
+    setIsLoadingMore(true);
+    return disposable;
+  }, [
+    fragmentReference.id,
+    fragmentReference.__fragments,
+    refetch,
+    metadata,
+    executionQueryDocument,
+    cache,
+    countVariable,
+    cursorVariable,
+    connectionSelectionPath,
+    cursorValue
+  ]);
+  return [loadPage, isLoadingMore];
+}
+function getValueAtSelectionPath(data, selectionPath) {
+  let object = data;
+  selectionPath.forEach((field) => {
+    object = object[field];
+    (0, import_invariant.default)(object, "Expected path to connection in response to exist");
+  });
+  return object;
+}
+function getPageInfo(data, selectionPath) {
+  const object = getValueAtSelectionPath(data, selectionPath);
+  const pageInfo = object.pageInfo;
+  (0, import_invariant.default)(pageInfo, "Expected to find the connection's page info object");
+  return pageInfo;
+}
+function mergeEdges(connectionPath, destination, source, updater) {
+  const edgesPath = [...connectionPath, "edges"];
+  const existingEdges = getValueAtSelectionPath(source, edgesPath);
+  const newEdges = getValueAtSelectionPath(destination, edgesPath);
+  const allEdges = updater(existingEdges, newEdges);
+  const connection = getValueAtSelectionPath(destination, connectionPath);
+  connection["edges"] = allEdges;
+  return destination;
+}
+function useCompiledPaginationFragment(documents, fragmentReference) {
+  const {executionQueryDocument, metadata} = documents;
+  (0, import_invariant.default)(metadata && metadata.mainFragment, "usePaginationFragment(): Expected metadata to have been extracted from the fragment. Did you forget to invoke the compiler?");
+  (0, import_invariant.default)(executionQueryDocument, "usePaginationFragment(): Expected fragment `%s` to be refetchable when using `usePaginationFragment`. Did you forget to add a @refetchable directive to the fragment?", metadata.mainFragment.name);
+  const connectionMetadata = metadata.connection;
+  (0, import_invariant.default)(connectionMetadata, "usePaginationFragment: Expected fragment `%s` to include a connection when using `usePaginationFragment`. Did you forget to add a @connection directive to the connection field in the fragment?", metadata.mainFragment.name);
+  const [data, refetch] = (0, import_useCompiledRefetchableFragment.useCompiledRefetchableFragment)(documents, fragmentReference);
+  const commonPaginationParams = {
+    fragmentReference,
+    refetch,
+    metadata,
+    executionQueryDocument,
+    cache: (0, import_client.useApolloClient)().cache,
+    connectionSelectionPath: connectionMetadata.selectionPath
+  };
+  const pageInfo = getPageInfo(data, connectionMetadata.selectionPath);
+  const [loadNext, isLoadingNext] = useLoadMore(__objSpread(__objSpread({}, commonPaginationParams), {
+    countVariable: connectionMetadata.forwardCountVariable,
+    cursorVariable: connectionMetadata.forwardCursorVariable,
+    cursorValue: pageInfo == null ? void 0 : pageInfo.endCursor,
+    updater: (existing, incoming) => [...existing, ...incoming]
+  }));
+  const [loadPrevious, isLoadingPrevious] = useLoadMore(__objSpread(__objSpread({}, commonPaginationParams), {
+    countVariable: connectionMetadata.backwardCountVariable,
+    cursorVariable: connectionMetadata.backwardCursorVariable,
+    cursorValue: pageInfo == null ? void 0 : pageInfo.startCursor,
+    updater: (existing, incoming) => [...incoming, ...existing]
+  }));
+  return {
+    data,
+    refetch,
+    hasNext: !!(pageInfo == null ? void 0 : pageInfo.hasNextPage),
+    hasPrevious: !!(pageInfo == null ? void 0 : pageInfo.hasPreviousPage),
+    isLoadingNext,
+    isLoadingPrevious,
+    loadNext,
+    loadPrevious
+  };
+}

package/lib/storeObservation/compiledHooks/useCompiledPaginationFragment.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/storeObservation/compiledHooks/useCompiledPaginationFragment.ts"],
+  "sourcesContent": ["import { useState, useRef, useEffect, useCallback } from \"react\";\nimport { DataProxy, useApolloClient } from \"@apollo/client\";\nimport invariant from \"invariant\";\nimport { CompiledArtefactModule } from \"relay-compiler-language-graphitation\";\nimport { useCompiledRefetchableFragment } from \"./useCompiledRefetchableFragment\";\nimport { FragmentReference } from \"./types\";\nimport type {\n  RefetchFn,\n  Disposable,\n  PrivateRefetchOptions,\n  RefetchOptions,\n} from \"./useCompiledRefetchableFragment\";\nimport type { Metadata } from \"relay-compiler-language-graphitation\";\nimport type { DocumentNode } from \"graphql\";\n\nexport type PaginationFn = (\n  count: number,\n  options?: RefetchOptions\n) => Disposable;\n\ninterface PaginationParams {\n  fragmentReference: FragmentReference;\n  refetch: RefetchFn;\n  metadata: Metadata;\n  executionQueryDocument: DocumentNode;\n  cache: DataProxy;\n  countVariable: string | undefined;\n  cursorVariable: string | undefined;\n  connectionSelectionPath: string[];\n  cursorValue: string | undefined;\n  updater: <T>(existing: T[], incoming: T[]) => T[];\n}\n\nfunction useLoadMore({\n  fragmentReference,\n  refetch,\n  metadata,\n  executionQueryDocument,\n  cache,\n  countVariable,\n  cursorVariable,\n  connectionSelectionPath,\n  cursorValue,\n  updater,\n}: PaginationParams): [loadPage: PaginationFn, isLoadingMore: boolean] {\n  const [isLoadingMore, setIsLoadingMore] = useState(false);\n  const loadPage = useCallback<PaginationFn>(\n    (countValue, options) => {\n      invariant(\n        countVariable,\n        \"usePaginationFragment(): Expected a count variable to exist\"\n      );\n      invariant(\n        cursorVariable,\n        \"usePaginationFragment(): Expected a cursor variable to exist\"\n      );\n      invariant(\n        cursorValue,\n        \"usePaginationFragment(): Expected a cursor value to exist\"\n      );\n      const previousVariables = {\n        ...fragmentReference.__fragments,\n        id: fragmentReference.id,\n      };\n      const newVariables = {\n        ...previousVariables,\n        [countVariable]: countValue,\n        [cursorVariable]: cursorValue,\n      };\n      const refetchOptions: PrivateRefetchOptions = {\n        fetchPolicy: \"no-cache\",\n        UNSTABLE_onCompletedWithData: (error, data) => {\n          // NOTE: We can do this now already, because `refetch` wraps the\n          //       onCompleted callback in a batchedUpdates callback.\n          setIsLoadingMore(false);\n\n          if (!error) {\n            invariant(\n              data,\n              \"usePaginationFragment(): Expected to have response data\"\n            );\n            const newData = metadata.rootSelection\n              ? data[metadata.rootSelection]\n              : data;\n            const mainFragment = metadata.mainFragment;\n            invariant(\n              mainFragment,\n              \"usePaginationFragment(): Expected mainFragment metadata\"\n            );\n            const cacheSelector: DataProxy.Fragment<any, any> = {\n              id: fragmentReference.id\n                ? `${mainFragment.typeCondition}:${fragmentReference.id}`\n                : \"ROOT_QUERY\",\n              variables: previousVariables,\n              fragmentName: mainFragment.name,\n              // Create new document with operation filtered out.\n              fragment: {\n                kind: \"Document\",\n                definitions: executionQueryDocument.definitions.filter(\n                  (def) => def.kind === \"FragmentDefinition\"\n                ),\n              },\n            };\n            /**\n             * Note: Even though we already have the latest data from the\n             * useCompiledFragment hook, we can't really use that as it may contain\n             * __fragments fields and we don't want to write those to the cache. If\n             * we figure out a way from a field-policy's merge function to not write\n             * to the cache, then that would be preferable.\n             */\n            const existingData = cache.readFragment(cacheSelector);\n            const newCacheData = mergeEdges(\n              connectionSelectionPath,\n              newData,\n              existingData,\n              updater\n            );\n            cache.writeFragment({\n              ...cacheSelector,\n              variables: newVariables,\n              data: newCacheData,\n            });\n          }\n\n          options?.onCompleted?.(error);\n        },\n      };\n      // TODO: Measure if invoking `refetch` leads to React updates and if it\n      //       makes sense to wrap it and the following setIsLoadingMore(true)\n      //       call in a batchedUpdates callback.\n      const disposable = refetch(\n        newVariables,\n        refetchOptions as RefetchOptions\n      );\n      setIsLoadingMore(true);\n      return disposable;\n    },\n    [\n      fragmentReference.id,\n      fragmentReference.__fragments,\n      refetch,\n      metadata,\n      executionQueryDocument,\n      cache,\n      countVariable,\n      cursorVariable,\n      connectionSelectionPath,\n      cursorValue,\n    ]\n  );\n  return [loadPage, isLoadingMore];\n}\n\nfunction getValueAtSelectionPath(\n  data: Record<string, any>,\n  selectionPath: string[]\n): any {\n  let object: Record<string, any> = data;\n  selectionPath.forEach((field) => {\n    object = object[field];\n    invariant(object, \"Expected path to connection in response to exist\");\n  });\n  return object;\n}\n\nfunction getPageInfo(\n  data: Record<string, any>,\n  selectionPath: string[]\n): {\n  startCursor?: string;\n  endCursor?: string;\n  hasPreviousPage?: boolean;\n  hasNextPage?: boolean;\n} {\n  const object = getValueAtSelectionPath(data, selectionPath);\n  const pageInfo = object.pageInfo;\n  invariant(pageInfo, \"Expected to find the connection's page info object\");\n  return pageInfo;\n}\n\nfunction mergeEdges(\n  connectionPath: string[],\n  destination: {},\n  source: {},\n  updater: <T>(existing: T[], incoming: T[]) => T[]\n) {\n  const edgesPath = [...connectionPath, \"edges\"];\n  const existingEdges = getValueAtSelectionPath(source, edgesPath);\n  const newEdges = getValueAtSelectionPath(destination, edgesPath);\n  const allEdges = updater(existingEdges, newEdges);\n\n  const connection = getValueAtSelectionPath(destination, connectionPath);\n  connection[\"edges\"] = allEdges;\n\n  return destination;\n}\n\nexport function useCompiledPaginationFragment(\n  documents: CompiledArtefactModule,\n  fragmentReference: FragmentReference\n): {\n  data: any;\n  loadNext: PaginationFn;\n  loadPrevious: PaginationFn;\n  hasNext: boolean;\n  hasPrevious: boolean;\n  isLoadingNext: boolean;\n  isLoadingPrevious: boolean;\n  refetch: RefetchFn;\n} {\n  const { executionQueryDocument, metadata } = documents;\n  invariant(\n    metadata && metadata.mainFragment,\n    \"usePaginationFragment(): Expected metadata to have been extracted from \" +\n      \"the fragment. Did you forget to invoke the compiler?\"\n  );\n  invariant(\n    executionQueryDocument,\n    \"usePaginationFragment(): Expected fragment `%s` to be refetchable when \" +\n      \"using `usePaginationFragment`. Did you forget to add a @refetchable \" +\n      \"directive to the fragment?\",\n    metadata.mainFragment.name\n  );\n  const connectionMetadata = metadata.connection;\n  invariant(\n    connectionMetadata,\n    \"usePaginationFragment: Expected fragment `%s` to include a \" +\n      \"connection when using `usePaginationFragment`. Did you forget to add a @connection \" +\n      \"directive to the connection field in the fragment?\",\n    metadata.mainFragment.name\n  );\n  const [data, refetch] = useCompiledRefetchableFragment(\n    documents,\n    fragmentReference\n  );\n  const commonPaginationParams = {\n    fragmentReference,\n    refetch,\n    metadata,\n    executionQueryDocument,\n    cache: useApolloClient().cache,\n    connectionSelectionPath: connectionMetadata.selectionPath,\n  };\n  const pageInfo = getPageInfo(data, connectionMetadata.selectionPath);\n  const [loadNext, isLoadingNext] = useLoadMore({\n    ...commonPaginationParams,\n    countVariable: connectionMetadata.forwardCountVariable,\n    cursorVariable: connectionMetadata.forwardCursorVariable,\n    cursorValue: pageInfo?.endCursor,\n    updater: (existing, incoming) => [...existing, ...incoming],\n  });\n  const [loadPrevious, isLoadingPrevious] = useLoadMore({\n    ...commonPaginationParams,\n    countVariable: connectionMetadata.backwardCountVariable,\n    cursorVariable: connectionMetadata.backwardCursorVariable,\n    cursorValue: pageInfo?.startCursor,\n    updater: (existing, incoming) => [...incoming, ...existing],\n  });\n  return {\n    data,\n    refetch,\n    hasNext: !!pageInfo?.hasNextPage,\n    hasPrevious: !!pageInfo?.hasPreviousPage,\n    isLoadingNext,\n    isLoadingPrevious,\n    loadNext,\n    loadPrevious,\n  };\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAyD;AACzD,oBAA2C;AAC3C,uBAAsB;AAEtB,4CAA+C;AA6B/C,qBAAqB;AAAA,EACnB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,GACqE;AACrE,QAAM,CAAC,eAAe,oBAAoB,2BAAS;AACnD,QAAM,WAAW,8BACf,CAAC,YAAY,YAAY;AACvB,kCACE,eACA;AAEF,kCACE,gBACA;AAEF,kCACE,aACA;AAEF,UAAM,oBAAoB,4BACrB,kBAAkB,cADG;AAAA,MAExB,IAAI,kBAAkB;AAAA;AAExB,UAAM,eAAe,4BAChB,oBADgB;AAAA,OAElB,gBAAgB;AAAA,OAChB,iBAAiB;AAAA;AAEpB,UAAM,iBAAwC;AAAA,MAC5C,aAAa;AAAA,MACb,8BAA8B,CAAC,OAAO,SAAS;AAvEvD;AA0EU,yBAAiB;AAEjB,YAAI,CAAC,OAAO;AACV,wCACE,MACA;AAEF,gBAAM,UAAU,SAAS,gBACrB,KAAK,SAAS,iBACd;AACJ,gBAAM,eAAe,SAAS;AAC9B,wCACE,cACA;AAEF,gBAAM,gBAA8C;AAAA,YAClD,IAAI,kBAAkB,KAClB,GAAG,aAAa,iBAAiB,kBAAkB,OACnD;AAAA,YACJ,WAAW;AAAA,YACX,cAAc,aAAa;AAAA,YAE3B,UAAU;AAAA,cACR,MAAM;AAAA,cACN,aAAa,uBAAuB,YAAY,OAC9C,CAAC,QAAQ,IAAI,SAAS;AAAA;AAAA;AAW5B,gBAAM,eAAe,MAAM,aAAa;AACxC,gBAAM,eAAe,WACnB,yBACA,SACA,cACA;AAEF,gBAAM,cAAc,4BACf,gBADe;AAAA,YAElB,WAAW;AAAA,YACX,MAAM;AAAA;AAAA;AAIV,iDAAS,gBAAT,iCAAuB;AAAA;AAAA;AAM3B,UAAM,aAAa,QACjB,cACA;AAEF,qBAAiB;AACjB,WAAO;AAAA,KAET;AAAA,IACE,kBAAkB;AAAA,IAClB,kBAAkB;AAAA,IAClB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA;AAGJ,SAAO,CAAC,UAAU;AAAA;AAGpB,iCACE,MACA,eACK;AACL,MAAI,SAA8B;AAClC,gBAAc,QAAQ,CAAC,UAAU;AAC/B,aAAS,OAAO;AAChB,kCAAU,QAAQ;AAAA;AAEpB,SAAO;AAAA;AAGT,qBACE,MACA,eAMA;AACA,QAAM,SAAS,wBAAwB,MAAM;AAC7C,QAAM,WAAW,OAAO;AACxB,gCAAU,UAAU;AACpB,SAAO;AAAA;AAGT,oBACE,gBACA,aACA,QACA,SACA;AACA,QAAM,YAAY,CAAC,GAAG,gBAAgB;AACtC,QAAM,gBAAgB,wBAAwB,QAAQ;AACtD,QAAM,WAAW,wBAAwB,aAAa;AACtD,QAAM,WAAW,QAAQ,eAAe;AAExC,QAAM,aAAa,wBAAwB,aAAa;AACxD,aAAW,WAAW;AAEtB,SAAO;AAAA;AAGF,uCACL,WACA,mBAUA;AACA,QAAM,CAAE,wBAAwB,YAAa;AAC7C,gCACE,YAAY,SAAS,cACrB;AAGF,gCACE,wBACA,yKAGA,SAAS,aAAa;AAExB,QAAM,qBAAqB,SAAS;AACpC,gCACE,oBACA,oMAGA,SAAS,aAAa;AAExB,QAAM,CAAC,MAAM,WAAW,0EACtB,WACA;AAEF,QAAM,yBAAyB;AAAA,IAC7B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,OAAO,qCAAkB;AAAA,IACzB,yBAAyB,mBAAmB;AAAA;AAE9C,QAAM,WAAW,YAAY,MAAM,mBAAmB;AACtD,QAAM,CAAC,UAAU,iBAAiB,YAAY,4BACzC,yBADyC;AAAA,IAE5C,eAAe,mBAAmB;AAAA,IAClC,gBAAgB,mBAAmB;AAAA,IACnC,aAAa,qCAAU;AAAA,IACvB,SAAS,CAAC,UAAU,aAAa,CAAC,GAAG,UAAU,GAAG;AAAA;AAEpD,QAAM,CAAC,cAAc,qBAAqB,YAAY,4BACjD,yBADiD;AAAA,IAEpD,eAAe,mBAAmB;AAAA,IAClC,gBAAgB,mBAAmB;AAAA,IACnC,aAAa,qCAAU;AAAA,IACvB,SAAS,CAAC,UAAU,aAAa,CAAC,GAAG,UAAU,GAAG;AAAA;AAEpD,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,SAAS,CAAC,CAAC,sCAAU;AAAA,IACrB,aAAa,CAAC,CAAC,sCAAU;AAAA,IACzB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA;AAAA;",
+  "names": []
+}

package/lib/storeObservation/compiledHooks/useCompiledPaginationFragment.mjs

@@ -0,0 +1,157 @@
+var __defProp = Object.defineProperty;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, {enumerable: true, configurable: true, writable: true, value}) : obj[key] = value;
+var __objSpread = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+
+// src/storeObservation/compiledHooks/useCompiledPaginationFragment.ts
+import {useState, useCallback} from "react";
+import {useApolloClient} from "@apollo/client";
+import invariant from "invariant";
+import {useCompiledRefetchableFragment} from "./useCompiledRefetchableFragment.mjs";
+function useLoadMore({
+  fragmentReference,
+  refetch,
+  metadata,
+  executionQueryDocument,
+  cache,
+  countVariable,
+  cursorVariable,
+  connectionSelectionPath,
+  cursorValue,
+  updater
+}) {
+  const [isLoadingMore, setIsLoadingMore] = useState(false);
+  const loadPage = useCallback((countValue, options) => {
+    invariant(countVariable, "usePaginationFragment(): Expected a count variable to exist");
+    invariant(cursorVariable, "usePaginationFragment(): Expected a cursor variable to exist");
+    invariant(cursorValue, "usePaginationFragment(): Expected a cursor value to exist");
+    const previousVariables = __objSpread(__objSpread({}, fragmentReference.__fragments), {
+      id: fragmentReference.id
+    });
+    const newVariables = __objSpread(__objSpread({}, previousVariables), {
+      [countVariable]: countValue,
+      [cursorVariable]: cursorValue
+    });
+    const refetchOptions = {
+      fetchPolicy: "no-cache",
+      UNSTABLE_onCompletedWithData: (error, data) => {
+        var _a;
+        setIsLoadingMore(false);
+        if (!error) {
+          invariant(data, "usePaginationFragment(): Expected to have response data");
+          const newData = metadata.rootSelection ? data[metadata.rootSelection] : data;
+          const mainFragment = metadata.mainFragment;
+          invariant(mainFragment, "usePaginationFragment(): Expected mainFragment metadata");
+          const cacheSelector = {
+            id: fragmentReference.id ? `${mainFragment.typeCondition}:${fragmentReference.id}` : "ROOT_QUERY",
+            variables: previousVariables,
+            fragmentName: mainFragment.name,
+            fragment: {
+              kind: "Document",
+              definitions: executionQueryDocument.definitions.filter((def) => def.kind === "FragmentDefinition")
+            }
+          };
+          const existingData = cache.readFragment(cacheSelector);
+          const newCacheData = mergeEdges(connectionSelectionPath, newData, existingData, updater);
+          cache.writeFragment(__objSpread(__objSpread({}, cacheSelector), {
+            variables: newVariables,
+            data: newCacheData
+          }));
+        }
+        (_a = options == null ? void 0 : options.onCompleted) == null ? void 0 : _a.call(options, error);
+      }
+    };
+    const disposable = refetch(newVariables, refetchOptions);
+    setIsLoadingMore(true);
+    return disposable;
+  }, [
+    fragmentReference.id,
+    fragmentReference.__fragments,
+    refetch,
+    metadata,
+    executionQueryDocument,
+    cache,
+    countVariable,
+    cursorVariable,
+    connectionSelectionPath,
+    cursorValue
+  ]);
+  return [loadPage, isLoadingMore];
+}
+function getValueAtSelectionPath(data, selectionPath) {
+  let object = data;
+  selectionPath.forEach((field) => {
+    object = object[field];
+    invariant(object, "Expected path to connection in response to exist");
+  });
+  return object;
+}
+function getPageInfo(data, selectionPath) {
+  const object = getValueAtSelectionPath(data, selectionPath);
+  const pageInfo = object.pageInfo;
+  invariant(pageInfo, "Expected to find the connection's page info object");
+  return pageInfo;
+}
+function mergeEdges(connectionPath, destination, source, updater) {
+  const edgesPath = [...connectionPath, "edges"];
+  const existingEdges = getValueAtSelectionPath(source, edgesPath);
+  const newEdges = getValueAtSelectionPath(destination, edgesPath);
+  const allEdges = updater(existingEdges, newEdges);
+  const connection = getValueAtSelectionPath(destination, connectionPath);
+  connection["edges"] = allEdges;
+  return destination;
+}
+function useCompiledPaginationFragment(documents, fragmentReference) {
+  const {executionQueryDocument, metadata} = documents;
+  invariant(metadata && metadata.mainFragment, "usePaginationFragment(): Expected metadata to have been extracted from the fragment. Did you forget to invoke the compiler?");
+  invariant(executionQueryDocument, "usePaginationFragment(): Expected fragment `%s` to be refetchable when using `usePaginationFragment`. Did you forget to add a @refetchable directive to the fragment?", metadata.mainFragment.name);
+  const connectionMetadata = metadata.connection;
+  invariant(connectionMetadata, "usePaginationFragment: Expected fragment `%s` to include a connection when using `usePaginationFragment`. Did you forget to add a @connection directive to the connection field in the fragment?", metadata.mainFragment.name);
+  const [data, refetch] = useCompiledRefetchableFragment(documents, fragmentReference);
+  const commonPaginationParams = {
+    fragmentReference,
+    refetch,
+    metadata,
+    executionQueryDocument,
+    cache: useApolloClient().cache,
+    connectionSelectionPath: connectionMetadata.selectionPath
+  };
+  const pageInfo = getPageInfo(data, connectionMetadata.selectionPath);
+  const [loadNext, isLoadingNext] = useLoadMore(__objSpread(__objSpread({}, commonPaginationParams), {
+    countVariable: connectionMetadata.forwardCountVariable,
+    cursorVariable: connectionMetadata.forwardCursorVariable,
+    cursorValue: pageInfo == null ? void 0 : pageInfo.endCursor,
+    updater: (existing, incoming) => [...existing, ...incoming]
+  }));
+  const [loadPrevious, isLoadingPrevious] = useLoadMore(__objSpread(__objSpread({}, commonPaginationParams), {
+    countVariable: connectionMetadata.backwardCountVariable,
+    cursorVariable: connectionMetadata.backwardCursorVariable,
+    cursorValue: pageInfo == null ? void 0 : pageInfo.startCursor,
+    updater: (existing, incoming) => [...incoming, ...existing]
+  }));
+  return {
+    data,
+    refetch,
+    hasNext: !!(pageInfo == null ? void 0 : pageInfo.hasNextPage),
+    hasPrevious: !!(pageInfo == null ? void 0 : pageInfo.hasPreviousPage),
+    isLoadingNext,
+    isLoadingPrevious,
+    loadNext,
+    loadPrevious
+  };
+}
+export {
+  useCompiledPaginationFragment
+};

package/lib/storeObservation/compiledHooks/useCompiledPaginationFragment.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/storeObservation/compiledHooks/useCompiledPaginationFragment.ts"],
+  "sourcesContent": ["import { useState, useRef, useEffect, useCallback } from \"react\";\nimport { DataProxy, useApolloClient } from \"@apollo/client\";\nimport invariant from \"invariant\";\nimport { CompiledArtefactModule } from \"relay-compiler-language-graphitation\";\nimport { useCompiledRefetchableFragment } from \"./useCompiledRefetchableFragment\";\nimport { FragmentReference } from \"./types\";\nimport type {\n  RefetchFn,\n  Disposable,\n  PrivateRefetchOptions,\n  RefetchOptions,\n} from \"./useCompiledRefetchableFragment\";\nimport type { Metadata } from \"relay-compiler-language-graphitation\";\nimport type { DocumentNode } from \"graphql\";\n\nexport type PaginationFn = (\n  count: number,\n  options?: RefetchOptions\n) => Disposable;\n\ninterface PaginationParams {\n  fragmentReference: FragmentReference;\n  refetch: RefetchFn;\n  metadata: Metadata;\n  executionQueryDocument: DocumentNode;\n  cache: DataProxy;\n  countVariable: string | undefined;\n  cursorVariable: string | undefined;\n  connectionSelectionPath: string[];\n  cursorValue: string | undefined;\n  updater: <T>(existing: T[], incoming: T[]) => T[];\n}\n\nfunction useLoadMore({\n  fragmentReference,\n  refetch,\n  metadata,\n  executionQueryDocument,\n  cache,\n  countVariable,\n  cursorVariable,\n  connectionSelectionPath,\n  cursorValue,\n  updater,\n}: PaginationParams): [loadPage: PaginationFn, isLoadingMore: boolean] {\n  const [isLoadingMore, setIsLoadingMore] = useState(false);\n  const loadPage = useCallback<PaginationFn>(\n    (countValue, options) => {\n      invariant(\n        countVariable,\n        \"usePaginationFragment(): Expected a count variable to exist\"\n      );\n      invariant(\n        cursorVariable,\n        \"usePaginationFragment(): Expected a cursor variable to exist\"\n      );\n      invariant(\n        cursorValue,\n        \"usePaginationFragment(): Expected a cursor value to exist\"\n      );\n      const previousVariables = {\n        ...fragmentReference.__fragments,\n        id: fragmentReference.id,\n      };\n      const newVariables = {\n        ...previousVariables,\n        [countVariable]: countValue,\n        [cursorVariable]: cursorValue,\n      };\n      const refetchOptions: PrivateRefetchOptions = {\n        fetchPolicy: \"no-cache\",\n        UNSTABLE_onCompletedWithData: (error, data) => {\n          // NOTE: We can do this now already, because `refetch` wraps the\n          //       onCompleted callback in a batchedUpdates callback.\n          setIsLoadingMore(false);\n\n          if (!error) {\n            invariant(\n              data,\n              \"usePaginationFragment(): Expected to have response data\"\n            );\n            const newData = metadata.rootSelection\n              ? data[metadata.rootSelection]\n              : data;\n            const mainFragment = metadata.mainFragment;\n            invariant(\n              mainFragment,\n              \"usePaginationFragment(): Expected mainFragment metadata\"\n            );\n            const cacheSelector: DataProxy.Fragment<any, any> = {\n              id: fragmentReference.id\n                ? `${mainFragment.typeCondition}:${fragmentReference.id}`\n                : \"ROOT_QUERY\",\n              variables: previousVariables,\n              fragmentName: mainFragment.name,\n              // Create new document with operation filtered out.\n              fragment: {\n                kind: \"Document\",\n                definitions: executionQueryDocument.definitions.filter(\n                  (def) => def.kind === \"FragmentDefinition\"\n                ),\n              },\n            };\n            /**\n             * Note: Even though we already have the latest data from the\n             * useCompiledFragment hook, we can't really use that as it may contain\n             * __fragments fields and we don't want to write those to the cache. If\n             * we figure out a way from a field-policy's merge function to not write\n             * to the cache, then that would be preferable.\n             */\n            const existingData = cache.readFragment(cacheSelector);\n            const newCacheData = mergeEdges(\n              connectionSelectionPath,\n              newData,\n              existingData,\n              updater\n            );\n            cache.writeFragment({\n              ...cacheSelector,\n              variables: newVariables,\n              data: newCacheData,\n            });\n          }\n\n          options?.onCompleted?.(error);\n        },\n      };\n      // TODO: Measure if invoking `refetch` leads to React updates and if it\n      //       makes sense to wrap it and the following setIsLoadingMore(true)\n      //       call in a batchedUpdates callback.\n      const disposable = refetch(\n        newVariables,\n        refetchOptions as RefetchOptions\n      );\n      setIsLoadingMore(true);\n      return disposable;\n    },\n    [\n      fragmentReference.id,\n      fragmentReference.__fragments,\n      refetch,\n      metadata,\n      executionQueryDocument,\n      cache,\n      countVariable,\n      cursorVariable,\n      connectionSelectionPath,\n      cursorValue,\n    ]\n  );\n  return [loadPage, isLoadingMore];\n}\n\nfunction getValueAtSelectionPath(\n  data: Record<string, any>,\n  selectionPath: string[]\n): any {\n  let object: Record<string, any> = data;\n  selectionPath.forEach((field) => {\n    object = object[field];\n    invariant(object, \"Expected path to connection in response to exist\");\n  });\n  return object;\n}\n\nfunction getPageInfo(\n  data: Record<string, any>,\n  selectionPath: string[]\n): {\n  startCursor?: string;\n  endCursor?: string;\n  hasPreviousPage?: boolean;\n  hasNextPage?: boolean;\n} {\n  const object = getValueAtSelectionPath(data, selectionPath);\n  const pageInfo = object.pageInfo;\n  invariant(pageInfo, \"Expected to find the connection's page info object\");\n  return pageInfo;\n}\n\nfunction mergeEdges(\n  connectionPath: string[],\n  destination: {},\n  source: {},\n  updater: <T>(existing: T[], incoming: T[]) => T[]\n) {\n  const edgesPath = [...connectionPath, \"edges\"];\n  const existingEdges = getValueAtSelectionPath(source, edgesPath);\n  const newEdges = getValueAtSelectionPath(destination, edgesPath);\n  const allEdges = updater(existingEdges, newEdges);\n\n  const connection = getValueAtSelectionPath(destination, connectionPath);\n  connection[\"edges\"] = allEdges;\n\n  return destination;\n}\n\nexport function useCompiledPaginationFragment(\n  documents: CompiledArtefactModule,\n  fragmentReference: FragmentReference\n): {\n  data: any;\n  loadNext: PaginationFn;\n  loadPrevious: PaginationFn;\n  hasNext: boolean;\n  hasPrevious: boolean;\n  isLoadingNext: boolean;\n  isLoadingPrevious: boolean;\n  refetch: RefetchFn;\n} {\n  const { executionQueryDocument, metadata } = documents;\n  invariant(\n    metadata && metadata.mainFragment,\n    \"usePaginationFragment(): Expected metadata to have been extracted from \" +\n      \"the fragment. Did you forget to invoke the compiler?\"\n  );\n  invariant(\n    executionQueryDocument,\n    \"usePaginationFragment(): Expected fragment `%s` to be refetchable when \" +\n      \"using `usePaginationFragment`. Did you forget to add a @refetchable \" +\n      \"directive to the fragment?\",\n    metadata.mainFragment.name\n  );\n  const connectionMetadata = metadata.connection;\n  invariant(\n    connectionMetadata,\n    \"usePaginationFragment: Expected fragment `%s` to include a \" +\n      \"connection when using `usePaginationFragment`. Did you forget to add a @connection \" +\n      \"directive to the connection field in the fragment?\",\n    metadata.mainFragment.name\n  );\n  const [data, refetch] = useCompiledRefetchableFragment(\n    documents,\n    fragmentReference\n  );\n  const commonPaginationParams = {\n    fragmentReference,\n    refetch,\n    metadata,\n    executionQueryDocument,\n    cache: useApolloClient().cache,\n    connectionSelectionPath: connectionMetadata.selectionPath,\n  };\n  const pageInfo = getPageInfo(data, connectionMetadata.selectionPath);\n  const [loadNext, isLoadingNext] = useLoadMore({\n    ...commonPaginationParams,\n    countVariable: connectionMetadata.forwardCountVariable,\n    cursorVariable: connectionMetadata.forwardCursorVariable,\n    cursorValue: pageInfo?.endCursor,\n    updater: (existing, incoming) => [...existing, ...incoming],\n  });\n  const [loadPrevious, isLoadingPrevious] = useLoadMore({\n    ...commonPaginationParams,\n    countVariable: connectionMetadata.backwardCountVariable,\n    cursorVariable: connectionMetadata.backwardCursorVariable,\n    cursorValue: pageInfo?.startCursor,\n    updater: (existing, incoming) => [...incoming, ...existing],\n  });\n  return {\n    data,\n    refetch,\n    hasNext: !!pageInfo?.hasNextPage,\n    hasPrevious: !!pageInfo?.hasPreviousPage,\n    isLoadingNext,\n    isLoadingPrevious,\n    loadNext,\n    loadPrevious,\n  };\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AACA;AACA;AAEA;AA6BA,qBAAqB;AAAA,EACnB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,GACqE;AACrE,QAAM,CAAC,eAAe,oBAAoB,SAAS;AACnD,QAAM,WAAW,YACf,CAAC,YAAY,YAAY;AACvB,cACE,eACA;AAEF,cACE,gBACA;AAEF,cACE,aACA;AAEF,UAAM,oBAAoB,4BACrB,kBAAkB,cADG;AAAA,MAExB,IAAI,kBAAkB;AAAA;AAExB,UAAM,eAAe,4BAChB,oBADgB;AAAA,OAElB,gBAAgB;AAAA,OAChB,iBAAiB;AAAA;AAEpB,UAAM,iBAAwC;AAAA,MAC5C,aAAa;AAAA,MACb,8BAA8B,CAAC,OAAO,SAAS;AAvEvD;AA0EU,yBAAiB;AAEjB,YAAI,CAAC,OAAO;AACV,oBACE,MACA;AAEF,gBAAM,UAAU,SAAS,gBACrB,KAAK,SAAS,iBACd;AACJ,gBAAM,eAAe,SAAS;AAC9B,oBACE,cACA;AAEF,gBAAM,gBAA8C;AAAA,YAClD,IAAI,kBAAkB,KAClB,GAAG,aAAa,iBAAiB,kBAAkB,OACnD;AAAA,YACJ,WAAW;AAAA,YACX,cAAc,aAAa;AAAA,YAE3B,UAAU;AAAA,cACR,MAAM;AAAA,cACN,aAAa,uBAAuB,YAAY,OAC9C,CAAC,QAAQ,IAAI,SAAS;AAAA;AAAA;AAW5B,gBAAM,eAAe,MAAM,aAAa;AACxC,gBAAM,eAAe,WACnB,yBACA,SACA,cACA;AAEF,gBAAM,cAAc,4BACf,gBADe;AAAA,YAElB,WAAW;AAAA,YACX,MAAM;AAAA;AAAA;AAIV,iDAAS,gBAAT,iCAAuB;AAAA;AAAA;AAM3B,UAAM,aAAa,QACjB,cACA;AAEF,qBAAiB;AACjB,WAAO;AAAA,KAET;AAAA,IACE,kBAAkB;AAAA,IAClB,kBAAkB;AAAA,IAClB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA;AAGJ,SAAO,CAAC,UAAU;AAAA;AAGpB,iCACE,MACA,eACK;AACL,MAAI,SAA8B;AAClC,gBAAc,QAAQ,CAAC,UAAU;AAC/B,aAAS,OAAO;AAChB,cAAU,QAAQ;AAAA;AAEpB,SAAO;AAAA;AAGT,qBACE,MACA,eAMA;AACA,QAAM,SAAS,wBAAwB,MAAM;AAC7C,QAAM,WAAW,OAAO;AACxB,YAAU,UAAU;AACpB,SAAO;AAAA;AAGT,oBACE,gBACA,aACA,QACA,SACA;AACA,QAAM,YAAY,CAAC,GAAG,gBAAgB;AACtC,QAAM,gBAAgB,wBAAwB,QAAQ;AACtD,QAAM,WAAW,wBAAwB,aAAa;AACtD,QAAM,WAAW,QAAQ,eAAe;AAExC,QAAM,aAAa,wBAAwB,aAAa;AACxD,aAAW,WAAW;AAEtB,SAAO;AAAA;AAGF,uCACL,WACA,mBAUA;AACA,QAAM,CAAE,wBAAwB,YAAa;AAC7C,YACE,YAAY,SAAS,cACrB;AAGF,YACE,wBACA,yKAGA,SAAS,aAAa;AAExB,QAAM,qBAAqB,SAAS;AACpC,YACE,oBACA,oMAGA,SAAS,aAAa;AAExB,QAAM,CAAC,MAAM,WAAW,+BACtB,WACA;AAEF,QAAM,yBAAyB;AAAA,IAC7B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,OAAO,kBAAkB;AAAA,IACzB,yBAAyB,mBAAmB;AAAA;AAE9C,QAAM,WAAW,YAAY,MAAM,mBAAmB;AACtD,QAAM,CAAC,UAAU,iBAAiB,YAAY,4BACzC,yBADyC;AAAA,IAE5C,eAAe,mBAAmB;AAAA,IAClC,gBAAgB,mBAAmB;AAAA,IACnC,aAAa,qCAAU;AAAA,IACvB,SAAS,CAAC,UAAU,aAAa,CAAC,GAAG,UAAU,GAAG;AAAA;AAEpD,QAAM,CAAC,cAAc,qBAAqB,YAAY,4BACjD,yBADiD;AAAA,IAEpD,eAAe,mBAAmB;AAAA,IAClC,gBAAgB,mBAAmB;AAAA,IACnC,aAAa,qCAAU;AAAA,IACvB,SAAS,CAAC,UAAU,aAAa,CAAC,GAAG,UAAU,GAAG;AAAA;AAEpD,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,SAAS,CAAC,CAAC,sCAAU;AAAA,IACrB,aAAa,CAAC,CAAC,sCAAU;AAAA,IACzB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA;AAAA;",
+  "names": []
+}

package/lib/storeObservation/compiledHooks/useCompiledRefetchableFragment.d.ts

@@ -0,0 +1,23 @@
+import { CompiledArtefactModule } from "relay-compiler-language-graphitation";
+import { FragmentReference } from "./types";
+import { FetchPolicy } from "../../types";
+export interface Disposable {
+    dispose(): void;
+}
+export declare type RefetchFn<Variables extends {} = {}> = (variables: Partial<Variables>, options?: RefetchOptions) => Disposable;
+export interface RefetchOptions {
+    onCompleted?: (error: Error | null) => void;
+    fetchPolicy?: FetchPolicy;
+}
+/**
+ * These do not exist in the Relay API and should not be exported from the package.
+ */
+export interface PrivateRefetchOptions extends Omit<RefetchOptions, "fetchPolicy"> {
+    /**
+     * Returns the fetched data.
+     */
+    UNSTABLE_onCompletedWithData?: (error: Error | null, data: Record<string, any> | null) => void;
+    fetchPolicy?: FetchPolicy | "no-cache";
+}
+export declare function useCompiledRefetchableFragment(documents: CompiledArtefactModule, fragmentReference: FragmentReference): [data: {}, refetch: RefetchFn];
+//# sourceMappingURL=useCompiledRefetchableFragment.d.ts.map

package/lib/storeObservation/compiledHooks/useCompiledRefetchableFragment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCompiledRefetchableFragment.d.ts","sourceRoot":"","sources":["../../../src/storeObservation/compiledHooks/useCompiledRefetchableFragment.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAE9E,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAE5C,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAG1C,MAAM,WAAW,UAAU;IACzB,OAAO,IAAI,IAAI,CAAC;CACjB;AAED,oBAAY,SAAS,CAAC,SAAS,SAAS,EAAE,GAAG,EAAE,IAAI,CACjD,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,EAC7B,OAAO,CAAC,EAAE,cAAc,KACrB,UAAU,CAAC;AAEhB,MAAM,WAAW,cAAc;IAC7B,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,KAAK,IAAI,CAAC;IAC5C,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,qBACf,SAAQ,IAAI,CAAC,cAAc,EAAE,aAAa,CAAC;IAC3C;;OAEG;IACH,4BAA4B,CAAC,EAAE,CAC7B,KAAK,EAAE,KAAK,GAAG,IAAI,EACnB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,KAC7B,IAAI,CAAC;IAEV,WAAW,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;CACxC;AAED,wBAAgB,8BAA8B,CAC5C,SAAS,EAAE,sBAAsB,EACjC,iBAAiB,EAAE,iBAAiB,GACnC,CAAC,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,SAAS,CAAC,CAmHhC"}