@apollo/client 4.0.0-rc.1 → 4.0.0-rc.10

package/react/hooks-compiled/useLoadableQuery.js

@@ -0,0 +1,247 @@
+import { c as _c } from "@apollo/client/react/internal/compiler-runtime";
+import * as React from "react";
+import { canonicalStringify } from "@apollo/client/cache";
+import { assertWrappedQueryRef, getSuspenseCache, unwrapQueryRef, updateWrappedQueryRef, wrapQueryRef, } from "@apollo/client/react/internal";
+import { __DEV__ } from "@apollo/client/utilities/environment";
+import { invariant } from "@apollo/client/utilities/invariant";
+import { useDeepMemo, useRenderGuard } from "./internal/index.js";
+import { validateSuspenseHookOptions } from "./internal/validateSuspenseHookOptions.js";
+import { useApolloClient } from "./useApolloClient.js";
+export function useLoadableQuery(query, t0) {
+    const $ = _c(34);
+    let t1;
+
+    if ($[0] !== t0) {
+        t1 = t0 === undefined ? {} : t0;
+        $[0] = t0;
+        $[1] = t1;
+    } else {
+        t1 = $[1];
+    }
+
+    const options = t1;
+    const client = useApolloClient(options.client);
+    let t2;
+
+    if ($[2] !== client) {
+        t2 = getSuspenseCache(client);
+        $[2] = client;
+        $[3] = t2;
+    } else {
+        t2 = $[3];
+    }
+
+    const suspenseCache = t2;
+    let t3;
+
+    if ($[4] !== client || $[5] !== options || $[6] !== query) {
+        t3 = {
+            client,
+            query,
+            options
+        };
+        $[4] = client;
+        $[5] = options;
+        $[6] = query;
+        $[7] = t3;
+    } else {
+        t3 = $[7];
+    }
+
+    const watchQueryOptions = useWatchQueryOptions(t3);
+    const {
+        queryKey: t4
+    } = options;
+    let t5;
+
+    if ($[8] !== t4) {
+        t5 = t4 === undefined ? [] : t4;
+        $[8] = t4;
+        $[9] = t5;
+    } else {
+        t5 = $[9];
+    }
+
+    const queryKey = t5;
+    const [queryRef, setQueryRef] = React.useState(null);
+    assertWrappedQueryRef(queryRef);
+    let t6;
+
+    if ($[10] !== queryRef) {
+        t6 = queryRef && unwrapQueryRef(queryRef);
+        $[10] = queryRef;
+        $[11] = t6;
+    } else {
+        t6 = $[11];
+    }
+
+    const internalQueryRef = t6;
+
+    if (queryRef && internalQueryRef?.didChangeOptions(watchQueryOptions)) {
+        const promise = internalQueryRef.applyOptions(watchQueryOptions);
+        updateWrappedQueryRef(queryRef, promise);
+    }
+
+    const calledDuringRender = useRenderGuard();
+    let t7;
+
+    if ($[12] !== internalQueryRef) {
+        t7 = options_0 => {
+            if (!internalQueryRef) {
+                throw new Error("The query has not been loaded. Please load the query.");
+            }
+
+            const promise_0 = internalQueryRef.fetchMore(options_0);
+            setQueryRef(wrapQueryRef(internalQueryRef));
+            return promise_0;
+        };
+        $[12] = internalQueryRef;
+        $[13] = t7;
+    } else {
+        t7 = $[13];
+    }
+
+    const fetchMore = t7;
+    let t8;
+
+    if ($[14] !== internalQueryRef) {
+        t8 = options_1 => {
+            if (!internalQueryRef) {
+                throw new Error("The query has not been loaded. Please load the query.");
+            }
+
+            const promise_1 = internalQueryRef.refetch(options_1);
+            setQueryRef(wrapQueryRef(internalQueryRef));
+            return promise_1;
+        };
+        $[14] = internalQueryRef;
+        $[15] = t8;
+    } else {
+        t8 = $[15];
+    }
+
+    const refetch = t8;
+    let t9;
+
+    if ($[16] !== calledDuringRender || $[17] !== client || $[18] !== query || $[19] !== queryKey || $[20] !== suspenseCache || $[21] !== watchQueryOptions) {
+        t9 = (...t10) => {
+            const args = t10;
+            invariant(!calledDuringRender(), 31);
+            const [variables] = args;
+            const cacheKey = [query, canonicalStringify(variables), ...[].concat(queryKey)];
+            const queryRef_0 = suspenseCache.getQueryRef(cacheKey, () => client.watchQuery({
+                ...watchQueryOptions,
+                variables
+            }));
+            setQueryRef(wrapQueryRef(queryRef_0));
+        };
+        $[16] = calledDuringRender;
+        $[17] = client;
+        $[18] = query;
+        $[19] = queryKey;
+        $[20] = suspenseCache;
+        $[21] = watchQueryOptions;
+        $[22] = t9;
+    } else {
+        t9 = $[22];
+    }
+
+    const loadQuery = t9;
+    let t10;
+
+    if ($[23] !== internalQueryRef) {
+        t10 = options_2 => {
+            invariant(internalQueryRef, 32);
+            return internalQueryRef.observable.subscribeToMore(options_2);
+        };
+        $[23] = internalQueryRef;
+        $[24] = t10;
+    } else {
+        t10 = $[24];
+    }
+
+    const subscribeToMore = t10;
+    let t11;
+
+    if ($[25] === Symbol.for("react.memo_cache_sentinel")) {
+        t11 = () => {
+            setQueryRef(null);
+        };
+        $[25] = t11;
+    } else {
+        t11 = $[25];
+    }
+
+    const reset = t11;
+    let t12;
+
+    if ($[26] !== fetchMore || $[27] !== refetch || $[28] !== subscribeToMore) {
+        t12 = {
+            fetchMore,
+            refetch,
+            reset,
+            subscribeToMore
+        };
+        $[26] = fetchMore;
+        $[27] = refetch;
+        $[28] = subscribeToMore;
+        $[29] = t12;
+    } else {
+        t12 = $[29];
+    }
+
+    let t13;
+
+    if ($[30] !== loadQuery || $[31] !== queryRef || $[32] !== t12) {
+        t13 = [loadQuery, queryRef, t12];
+        $[30] = loadQuery;
+        $[31] = queryRef;
+        $[32] = t12;
+        $[33] = t13;
+    } else {
+        t13 = $[33];
+    }
+
+    return t13;
+}
+function useWatchQueryOptions(t0) {
+    const $ = _c(5);
+    const {
+        client,
+        query,
+        options
+    } = t0;
+    let t1;
+    let t2;
+
+    if ($[0] !== client || $[1] !== options || $[2] !== query) {
+        t1 = () => {
+            const fetchPolicy = options.fetchPolicy || client.defaultOptions.watchQuery?.fetchPolicy || "cache-first";
+            const watchQueryOptions = {
+                ...options,
+                fetchPolicy,
+                query,
+                notifyOnNetworkStatusChange: false,
+                nextFetchPolicy: void 0
+            };
+
+            if (__DEV__) {
+                validateSuspenseHookOptions(watchQueryOptions);
+            }
+
+            return watchQueryOptions;
+        };t2 = [client, options, query];
+        $[0] = client;
+        $[1] = options;
+        $[2] = query;
+        $[3] = t1;
+        $[4] = t2;
+    } else {
+        t1 = $[3];
+        t2 = $[4];
+    }
+
+    return useDeepMemo(t1, t2);
+}
+
+//# sourceMappingURL=useLoadableQuery.js.map

package/react/hooks-compiled/useLoadableQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLoadableQuery.js","sources":["../../../src/react/hooks/useLoadableQuery.ts"],"sourcesContent":["import * as React from \"react\";\n\nimport type {\n  ApolloClient,\n  DataState,\n  DefaultContext,\n  DocumentNode,\n  ErrorPolicy,\n  ObservableQuery,\n  OperationVariables,\n  RefetchWritePolicy,\n  TypedDocumentNode,\n  WatchQueryFetchPolicy,\n} from \"@apollo/client\";\nimport type { SubscribeToMoreFunction } from \"@apollo/client\";\nimport { canonicalStringify } from \"@apollo/client/cache\";\nimport type {\n  CacheKey,\n  FetchMoreFunction,\n  QueryRef,\n  RefetchFunction,\n} from \"@apollo/client/react/internal\";\nimport {\n  assertWrappedQueryRef,\n  getSuspenseCache,\n  unwrapQueryRef,\n  updateWrappedQueryRef,\n  wrapQueryRef,\n} from \"@apollo/client/react/internal\";\nimport { __DEV__ } from \"@apollo/client/utilities/environment\";\nimport { invariant } from \"@apollo/client/utilities/invariant\";\n\nimport { __use, useDeepMemo, useRenderGuard } from \"./internal/index.js\";\nimport { validateSuspenseHookOptions } from \"./internal/validateSuspenseHookOptions.js\";\nimport { useApolloClient } from \"./useApolloClient.js\";\n\ntype ResetFunction = () => void;\n\nexport declare namespace useLoadableQuery {\n  export type LoadQueryFunction<TVariables extends OperationVariables> = (\n    // Use variadic args to handle cases where TVariables is type `never`, in\n    // which case we don't want to allow a variables argument. In other\n    // words, we don't want to allow variables to be passed as an argument to this\n    // function if the query does not expect variables in the document.\n    ...args: {} extends TVariables ? [variables?: TVariables]\n    : [variables: TVariables]\n  ) => void;\n\n  export type Result<\n    TData = unknown,\n    TVariables extends OperationVariables = OperationVariables,\n    TStates extends\n      DataState<TData>[\"dataState\"] = DataState<TData>[\"dataState\"],\n  > = [\n    loadQuery: LoadQueryFunction<TVariables>,\n    queryRef: QueryRef<TData, TVariables, TStates> | null,\n    handlers: Handlers<TData, TVariables>,\n  ];\n  export interface Handlers<\n    TData = unknown,\n    TVariables extends OperationVariables = OperationVariables,\n  > {\n    /** {@inheritDoc @apollo/client!QueryResultDocumentation#fetchMore:member} */\n    fetchMore: FetchMoreFunction<TData, TVariables>;\n    /** {@inheritDoc @apollo/client!QueryResultDocumentation#refetch:member} */\n    refetch: RefetchFunction<TData, TVariables>;\n    /** {@inheritDoc @apollo/client!ObservableQuery#subscribeToMore:member(1)} */\n    subscribeToMore: SubscribeToMoreFunction<TData, TVariables>;\n    /**\n     * A function that resets the `queryRef` back to `null`.\n     */\n    reset: ResetFunction;\n  }\n\n  export type FetchPolicy = Extract<\n    WatchQueryFetchPolicy,\n    \"cache-first\" | \"network-only\" | \"no-cache\" | \"cache-and-network\"\n  >;\n\n  export interface Options {\n    /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#client:member} */\n    client?: ApolloClient;\n\n    /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#context:member} */\n    context?: DefaultContext;\n\n    /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#errorPolicy:member} */\n    errorPolicy?: ErrorPolicy;\n\n    /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#fetchPolicy:member} */\n    fetchPolicy?: FetchPolicy;\n\n    /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#queryKey:member} */\n    queryKey?: string | number | any[];\n\n    /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#refetchWritePolicy:member} */\n    refetchWritePolicy?: RefetchWritePolicy;\n\n    /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#returnPartialData:member} */\n    returnPartialData?: boolean;\n  }\n\n  export namespace DocumentationTypes {\n    /** {@inheritDoc @apollo/client/react!useLoadableQuery:function(1)} */\n    export function useLoadableQuery<\n      TData = unknown,\n      TVariables extends OperationVariables = OperationVariables,\n    >(\n      query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n      options: useLoadableQuery.Options\n    ): useLoadableQuery.Result<TData, TVariables>;\n  }\n}\n\n/**\n * A hook for imperatively loading a query, such as responding to a user\n * interaction.\n *\n * > Refer to the [Suspense - Fetching in response to user interaction](https://www.apollographql.com/docs/react/data/suspense#fetching-in-response-to-user-interaction) section for a more in-depth overview of `useLoadableQuery`.\n *\n * @example\n *\n * ```jsx\n * import { gql, useLoadableQuery } from \"@apollo/client\";\n *\n * const GET_GREETING = gql`\n *   query GetGreeting($language: String!) {\n *     greeting(language: $language) {\n *       message\n *     }\n *   }\n * `;\n *\n * function App() {\n *   const [loadGreeting, queryRef] = useLoadableQuery(GET_GREETING);\n *\n *   return (\n *     <>\n *       <button onClick={() => loadGreeting({ language: \"english\" })}>\n *         Load greeting\n *       </button>\n *       <Suspense fallback={<div>Loading...</div>}>\n *         {queryRef && <Hello queryRef={queryRef} />}\n *       </Suspense>\n *     </>\n *   );\n * }\n *\n * function Hello({ queryRef }) {\n *   const { data } = useReadQuery(queryRef);\n *\n *   return <div>{data.greeting.message}</div>;\n * }\n * ```\n *\n * @param query - A GraphQL query document parsed into an AST by `gql`.\n * @param options - Options to control how the query is executed.\n * @returns A tuple in the form of `[loadQuery, queryRef, handlers]`\n */\nexport function useLoadableQuery<\n  TData = unknown,\n  TVariables extends OperationVariables = OperationVariables,\n>(\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n  options: useLoadableQuery.Options & {\n    returnPartialData: true;\n    errorPolicy: \"ignore\" | \"all\";\n  }\n): useLoadableQuery.Result<\n  TData,\n  TVariables,\n  \"complete\" | \"streaming\" | \"partial\" | \"empty\"\n>;\n\n/** {@inheritDoc @apollo/client/react!useLoadableQuery:function(1)} */\nexport function useLoadableQuery<\n  TData = unknown,\n  TVariables extends OperationVariables = OperationVariables,\n>(\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n  options: useLoadableQuery.Options & {\n    errorPolicy: \"ignore\" | \"all\";\n  }\n): useLoadableQuery.Result<\n  TData,\n  TVariables,\n  \"complete\" | \"streaming\" | \"empty\"\n>;\n\n/** {@inheritDoc @apollo/client/react!useLoadableQuery:function(1)} */\nexport function useLoadableQuery<\n  TData = unknown,\n  TVariables extends OperationVariables = OperationVariables,\n>(\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n  options: useLoadableQuery.Options & {\n    returnPartialData: true;\n  }\n): useLoadableQuery.Result<\n  TData,\n  TVariables,\n  \"complete\" | \"streaming\" | \"partial\"\n>;\n\n/** {@inheritDoc @apollo/client/react!useLoadableQuery:function(1)} */\nexport function useLoadableQuery<\n  TData = unknown,\n  TVariables extends OperationVariables = OperationVariables,\n>(\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n  options?: useLoadableQuery.Options\n): useLoadableQuery.Result<TData, TVariables, \"complete\" | \"streaming\">;\n\nexport function useLoadableQuery<\n  TData = unknown,\n  TVariables extends OperationVariables = OperationVariables,\n>(\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n  options: useLoadableQuery.Options = {}\n): useLoadableQuery.Result<TData, TVariables> {\n  const client = useApolloClient(options.client);\n  const suspenseCache = getSuspenseCache(client);\n  const watchQueryOptions = useWatchQueryOptions({ client, query, options });\n  const { queryKey = [] } = options;\n\n  const [queryRef, setQueryRef] = React.useState<QueryRef<\n    TData,\n    TVariables,\n    DataState<TData>[\"dataState\"]\n  > | null>(null);\n\n  assertWrappedQueryRef(queryRef);\n\n  const internalQueryRef = queryRef && unwrapQueryRef(queryRef);\n\n  if (queryRef && internalQueryRef?.didChangeOptions(watchQueryOptions)) {\n    const promise = internalQueryRef.applyOptions(watchQueryOptions);\n    updateWrappedQueryRef(queryRef, promise);\n  }\n\n  const calledDuringRender = useRenderGuard();\n\n  const fetchMore: FetchMoreFunction<TData, TVariables> = React.useCallback(\n    (options) => {\n      if (!internalQueryRef) {\n        throw new Error(\n          \"The query has not been loaded. Please load the query.\"\n        );\n      }\n\n      const promise = internalQueryRef.fetchMore(options);\n\n      setQueryRef(wrapQueryRef(internalQueryRef));\n\n      return promise;\n    },\n    [internalQueryRef]\n  );\n\n  const refetch: RefetchFunction<TData, TVariables> = React.useCallback(\n    (options) => {\n      if (!internalQueryRef) {\n        throw new Error(\n          \"The query has not been loaded. Please load the query.\"\n        );\n      }\n\n      const promise = internalQueryRef.refetch(options);\n\n      setQueryRef(wrapQueryRef(internalQueryRef));\n\n      return promise;\n    },\n    [internalQueryRef]\n  );\n\n  const loadQuery: useLoadableQuery.LoadQueryFunction<TVariables> =\n    React.useCallback(\n      (...args) => {\n        invariant(\n          !calledDuringRender(),\n          \"useLoadableQuery: 'loadQuery' should not be called during render. To start a query during render, use the 'useBackgroundQuery' hook.\"\n        );\n\n        const [variables] = args;\n\n        const cacheKey: CacheKey = [\n          query,\n          canonicalStringify(variables),\n          ...([] as any[]).concat(queryKey),\n        ];\n\n        const queryRef = suspenseCache.getQueryRef(cacheKey, () =>\n          client.watchQuery({\n            ...watchQueryOptions,\n            variables,\n          } as ApolloClient.WatchQueryOptions<any, any>)\n        );\n\n        setQueryRef(wrapQueryRef(queryRef));\n      },\n      [\n        query,\n        queryKey,\n        suspenseCache,\n        watchQueryOptions,\n        calledDuringRender,\n        client,\n      ]\n    );\n\n  const subscribeToMore: SubscribeToMoreFunction<TData, TVariables> =\n    React.useCallback(\n      (options) => {\n        invariant(\n          internalQueryRef,\n          \"The query has not been loaded. Please load the query.\"\n        );\n\n        return internalQueryRef.observable.subscribeToMore(\n          // TODO: The internalQueryRef doesn't have TVariables' type information so we have to cast it here\n          options as any as ObservableQuery.SubscribeToMoreOptions<\n            TData,\n            OperationVariables\n          >\n        );\n      },\n      [internalQueryRef]\n    );\n\n  const reset: ResetFunction = React.useCallback(() => {\n    setQueryRef(null);\n  }, []);\n\n  return [loadQuery, queryRef, { fetchMore, refetch, reset, subscribeToMore }];\n}\n\nfunction useWatchQueryOptions<TData, TVariables extends OperationVariables>({\n  client,\n  query,\n  options,\n}: {\n  client: ApolloClient;\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>;\n  options: useLoadableQuery.Options;\n}): ApolloClient.WatchQueryOptions<TData, TVariables> {\n  return useDeepMemo<ApolloClient.WatchQueryOptions<TData, TVariables>>(() => {\n    const fetchPolicy =\n      options.fetchPolicy ||\n      client.defaultOptions.watchQuery?.fetchPolicy ||\n      \"cache-first\";\n\n    const watchQueryOptions = {\n      ...options,\n      fetchPolicy,\n      query,\n      notifyOnNetworkStatusChange: false,\n      nextFetchPolicy: void 0,\n    };\n\n    if (__DEV__) {\n      validateSuspenseHookOptions(watchQueryOptions as any);\n    }\n\n    return watchQueryOptions as ApolloClient.WatchQueryOptions<\n      TData,\n      TVariables\n    >;\n  }, [client, options, query]);\n}\n"],"names":[],"mappings":";AAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAP,CAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAuB,CAAvB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8B;AAe9B,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAmC,CAAnC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyD;AAOzD,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EACL,CADF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACuB,EACrB,CAFF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAEkB,EAChB,CAHF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAGgB,EACd,CAJF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAIuB,EACrB,CALF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAKc,EALd,EAAA,CAAA,CAAA,CAAA,EAMO,CANP,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAMsC;AACtC,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAwB,CAAxB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8D;AAC9D,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAA0B,CAA1B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8D;AAE9D,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAS,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA2B,EAAE,CAA7B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAmD,CAAnD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwE;AACxE,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAA4C,CAA5C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuF;AACvF,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAgC,CAAhC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsD"}

package/react/hooks-compiled/useMutation.d.ts

@@ -0,0 +1,302 @@
+import type { TypedDocumentNode } from "@graphql-typed-document-node/core";
+import type { ApolloCache, ApolloClient, DefaultContext, DocumentNode, ErrorLike, ErrorPolicy, InternalRefetchQueriesInclude, MaybeMasked, MutationFetchPolicy, MutationQueryReducersMap, MutationUpdaterFunction, NormalizedExecutionResult, OnQueryUpdated, OperationVariables, Unmasked } from "@apollo/client";
+import type { IgnoreModifier } from "@apollo/client/cache";
+import type { NoInfer, Prettify } from "@apollo/client/utilities/internal";
+type MakeRequiredVariablesOptional<TVariables extends OperationVariables, TConfiguredVariables extends Partial<TVariables>> = Prettify<{
+    [K in keyof TVariables as K extends keyof TConfiguredVariables ? K : never]?: TVariables[K];
+} & Omit<TVariables, keyof TConfiguredVariables>>;
+export declare namespace useMutation {
+    interface Options<TData = unknown, TVariables extends OperationVariables = OperationVariables, TCache extends ApolloCache = ApolloCache, TConfiguredVariables extends Partial<TVariables> = Partial<TVariables>> {
+        /**
+        * By providing either an object or a callback function that, when invoked after
+        * a mutation, allows you to return optimistic data and optionally skip updates
+        * via the `IGNORE` sentinel object, Apollo Client caches this temporary
+        * (and potentially incorrect) response until the mutation completes, enabling
+        * more responsive UI updates.
+        * 
+        * For more information, see [Optimistic mutation results](https://www.apollographql.com/docs/react/performance/optimistic-ui/).
+        * 
+        * @docGroup 3. Caching options
+        */
+        optimisticResponse?: Unmasked<NoInfer<TData>> | ((vars: TVariables, { IGNORE }: {
+            IGNORE: IgnoreModifier;
+        }) => Unmasked<NoInfer<TData>> | IgnoreModifier);
+        /**
+        * A `MutationQueryReducersMap`, which is map from query names to
+        * mutation query reducers. Briefly, this map defines how to incorporate the
+        * results of the mutation into the results of queries that are currently
+        * being watched by your application.
+        */
+        updateQueries?: MutationQueryReducersMap<TData>;
+        /**
+        * An array (or a function that _returns_ an array) that specifies which queries you want to refetch after the mutation occurs.
+        * 
+        * Each array value can be either:
+        * 
+        * - An object containing the `query` to execute, along with any `variables`
+        * 
+        * - A string indicating the operation name of the query to refetch
+        * 
+        * @docGroup 1. Operation options
+        */
+        refetchQueries?: ((result: NormalizedExecutionResult<Unmasked<TData>>) => InternalRefetchQueriesInclude) | InternalRefetchQueriesInclude;
+        /**
+        * If `true`, makes sure all queries included in `refetchQueries` are completed before the mutation is considered complete.
+        * 
+        * The default value is `false` (queries are refetched asynchronously).
+        * 
+        * @docGroup 1. Operation options
+        */
+        awaitRefetchQueries?: boolean;
+        /**
+        * A function used to update the Apollo Client cache after the mutation completes.
+        * 
+        * For more information, see [Updating the cache after a mutation](https://www.apollographql.com/docs/react/data/mutations#updating-the-cache-after-a-mutation).
+        * 
+        * @docGroup 3. Caching options
+        */
+        update?: MutationUpdaterFunction<TData, TVariables, TCache>;
+        /**
+        * Optional callback for intercepting queries whose cache data has been updated by the mutation, as well as any queries specified in the `refetchQueries: [...]` list passed to `client.mutate`.
+        * 
+        * Returning a `Promise` from `onQueryUpdated` will cause the final mutation `Promise` to await the returned `Promise`. Returning `false` causes the query to be ignored.
+        * 
+        * @docGroup 1. Operation options
+        */
+        onQueryUpdated?: OnQueryUpdated<any>;
+        /**
+        * Specifies how the mutation handles a response that returns both GraphQL errors and partial results.
+        * 
+        * For details, see [GraphQL error policies](https://www.apollographql.com/docs/react/data/error-handling/#graphql-error-policies).
+        * 
+        * The default value is `none`, meaning that the mutation result includes error details but _not_ partial results.
+        * 
+        * @docGroup 1. Operation options
+        */
+        errorPolicy?: ErrorPolicy;
+        /**
+        * An object containing all of the GraphQL variables your mutation requires to execute.
+        * 
+        * Each key in the object corresponds to a variable name, and that key's value corresponds to the variable value.
+        * 
+        * @docGroup 1. Operation options
+        */
+        variables?: TConfiguredVariables;
+        /**
+        * If you're using [Apollo Link](https://www.apollographql.com/docs/react/api/link/introduction/), this object is the initial value of the `context` object that's passed along your link chain.
+        * 
+        * @docGroup 2. Networking options
+        */
+        context?: DefaultContext;
+        /**
+        * Provide `no-cache` if the mutation's result should _not_ be written to the Apollo Client cache.
+        * 
+        * The default value is `network-only` (which means the result _is_ written to the cache).
+        * 
+        * Unlike queries, mutations _do not_ support [fetch policies](https://www.apollographql.com/docs/react/data/queries/#setting-a-fetch-policy) besides `network-only` and `no-cache`.
+        * 
+        * @docGroup 3. Caching options
+        */
+        fetchPolicy?: MutationFetchPolicy;
+        /**
+        * To avoid retaining sensitive information from mutation root field
+        * arguments, Apollo Client v3.4+ automatically clears any `ROOT_MUTATION`
+        * fields from the cache after each mutation finishes. If you need this
+        * information to remain in the cache, you can prevent the removal by passing
+        * `keepRootFields: true` to the mutation. `ROOT_MUTATION` result data are
+        * also passed to the mutation `update` function, so we recommend obtaining
+        * the results that way, rather than using this option, if possible.
+        */
+        keepRootFields?: boolean;
+        /**
+        * The instance of `ApolloClient` to use to execute the mutation.
+        * 
+        * By default, the instance that's passed down via context is used, but you can provide a different instance here.
+        * 
+        * @docGroup 2. Networking options
+        */
+        client?: ApolloClient;
+        /**
+        * If `true`, the in-progress mutation's associated component re-renders whenever the network status changes or a network error occurs.
+        * 
+        * The default value is `true`.
+        * 
+        * @docGroup 2. Networking options
+        */
+        notifyOnNetworkStatusChange?: boolean;
+        /**
+        * A callback function that's called when your mutation successfully completes with zero errors (or if `errorPolicy` is `ignore` and partial data is returned).
+        * 
+        * This function is passed the mutation's result `data` and any options passed to the mutation.
+        * 
+        * @docGroup 1. Operation options
+        */
+        onCompleted?: (data: MaybeMasked<TData>, clientOptions?: Options<TData, TVariables, TCache>) => void;
+        /**
+        * A callback function that's called when the mutation encounters one or more errors (unless `errorPolicy` is `ignore`).
+        * 
+        * This function is passed an [`ApolloError`](https://github.com/apollographql/apollo-client/blob/d96f4578f89b933c281bb775a39503f6cdb59ee8/src/errors/index.ts#L36-L39) object that contains either a `networkError` object or a `graphQLErrors` array, depending on the error(s) that occurred, as well as any options passed the mutation.
+        * 
+        * @docGroup 1. Operation options
+        */
+        onError?: (error: ErrorLike, clientOptions?: Options<TData, TVariables, TCache>) => void;
+    }
+    interface Result<TData = unknown> {
+        /**
+        * The data returned from your mutation. Can be `undefined` if `ignoreResults` is `true`.
+        */
+        data: MaybeMasked<TData> | null | undefined;
+        /**
+        * If the mutation produces one or more errors, this object contains either an array of `graphQLErrors` or a single `networkError`. Otherwise, this value is `undefined`.
+        * 
+        * For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
+        */
+        error: ErrorLike | undefined;
+        /**
+        * If `true`, the mutation is currently in flight.
+        */
+        loading: boolean;
+        /**
+        * If `true`, the mutation's mutate function has been called.
+        */
+        called: boolean;
+        /**
+        * The instance of Apollo Client that executed the mutation.
+        * 
+        * Can be useful for manually executing followup operations or writing data to the cache.
+        */
+        client: ApolloClient;
+        /**
+        * A function that you can call to reset the mutation's result to its initial, uncalled state.
+        */
+        reset: () => void;
+    }
+    type ResultTuple<TData, TVariables extends OperationVariables, TCache extends ApolloCache = ApolloCache> = [
+        mutate: MutationFunction<TData, TVariables, TCache>,
+        result: Result<TData>
+    ];
+    type MutationFunction<TData, TVariables extends OperationVariables, TCache extends ApolloCache = ApolloCache> = (...[options]: {} extends TVariables ? [
+        options?: MutationFunctionOptions<TData, TVariables, TCache> & {
+            /**
+            * An object containing all of the GraphQL variables your mutation requires to execute.
+            * 
+            * Each key in the object corresponds to a variable name, and that key's value corresponds to the variable value.
+            * 
+            * @docGroup 1. Operation options
+            */
+            variables?: TVariables;
+        }
+    ] : [
+        options: MutationFunctionOptions<TData, TVariables, TCache> & {
+            /**
+            * An object containing all of the GraphQL variables your mutation requires to execute.
+            * 
+            * Each key in the object corresponds to a variable name, and that key's value corresponds to the variable value.
+            * 
+            * @docGroup 1. Operation options
+            */
+            variables: TVariables;
+        }
+    ]) => Promise<ApolloClient.MutateResult<MaybeMasked<TData>>>;
+    type MutationFunctionOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables, TCache extends ApolloCache = ApolloCache> = Options<TData, TVariables, TCache>;
+    namespace DocumentationTypes {
+        /**
+        * > Refer to the [Mutations](https://www.apollographql.com/docs/react/data/mutations/) section for a more in-depth overview of `useMutation`.
+        * 
+        * @example
+        * 
+        * ```jsx
+        * import { gql, useMutation } from "@apollo/client";
+        * 
+        * const ADD_TODO = gql`
+        *   mutation AddTodo($type: String!) {
+        *     addTodo(type: $type) {
+        *       id
+        *       type
+        *     }
+        *   }
+        * `;
+        * 
+        * function AddTodo() {
+        *   let input;
+        *   const [addTodo, { data }] = useMutation(ADD_TODO);
+        * 
+        *   return (
+        *     <div>
+        *       <form
+        *         onSubmit={(e) => {
+        *           e.preventDefault();
+        *           addTodo({ variables: { type: input.value } });
+        *           input.value = "";
+        *         }}
+        *       >
+        *         <input
+        *           ref={(node) => {
+        *             input = node;
+        *           }}
+        *         />
+        *         <button type="submit">Add Todo</button>
+        *       </form>
+        *     </div>
+        *   );
+        * }
+        * ```
+        * 
+        * @param mutation - A GraphQL mutation document parsed into an AST by `gql`.
+        * @param options - Options to control how the mutation is executed.
+        * @returns A tuple in the form of `[mutate, result]`
+        */
+        function useMutation<TData = unknown, TVariables extends OperationVariables = OperationVariables>(mutation: DocumentNode | TypedDocumentNode<TData, TVariables>, options?: useMutation.Options<TData, TVariables>): useMutation.ResultTuple<TData, TVariables>;
+    }
+}
+/**
+ * > Refer to the [Mutations](https://www.apollographql.com/docs/react/data/mutations/) section for a more in-depth overview of `useMutation`.
+ *
+ * @example
+ *
+ * ```jsx
+ * import { gql, useMutation } from "@apollo/client";
+ *
+ * const ADD_TODO = gql`
+ *   mutation AddTodo($type: String!) {
+ *     addTodo(type: $type) {
+ *       id
+ *       type
+ *     }
+ *   }
+ * `;
+ *
+ * function AddTodo() {
+ *   let input;
+ *   const [addTodo, { data }] = useMutation(ADD_TODO);
+ *
+ *   return (
+ *     <div>
+ *       <form
+ *         onSubmit={(e) => {
+ *           e.preventDefault();
+ *           addTodo({ variables: { type: input.value } });
+ *           input.value = "";
+ *         }}
+ *       >
+ *         <input
+ *           ref={(node) => {
+ *             input = node;
+ *           }}
+ *         />
+ *         <button type="submit">Add Todo</button>
+ *       </form>
+ *     </div>
+ *   );
+ * }
+ * ```
+ *
+ * @param mutation - A GraphQL mutation document parsed into an AST by `gql`.
+ * @param options - Options to control how the mutation is executed.
+ * @returns A tuple in the form of `[mutate, result]`
+ */
+export declare function useMutation<TData = unknown, TVariables extends OperationVariables = OperationVariables, TCache extends ApolloCache = ApolloCache, TConfiguredVariables extends Partial<TVariables> = {}>(mutation: DocumentNode | TypedDocumentNode<TData, TVariables>, options?: useMutation.Options<NoInfer<TData>, NoInfer<TVariables>, TCache, {
+    [K in keyof TConfiguredVariables]: K extends keyof TVariables ? TConfiguredVariables[K] : never;
+}>): useMutation.ResultTuple<TData, MakeRequiredVariablesOptional<TVariables, TConfiguredVariables>, TCache>;
+export {};
+//# sourceMappingURL=useMutation.d.ts.map