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

package/react/hooks-compiled/useMutation.js

@@ -0,0 +1,262 @@
+import { c as _c } from "@apollo/client/react/internal/compiler-runtime";
+import { equal } from "@wry/equality";
+import * as React from "react";
+import { mergeOptions } from "@apollo/client/utilities/internal";
+import { useIsomorphicLayoutEffect } from "./internal/useIsomorphicLayoutEffect.js";
+import { useApolloClient } from "./useApolloClient.js";
+/**
+ * > 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 function useMutation(mutation, options) {
+    const $ = _c(17);
+    const client = useApolloClient(options?.client);
+    let t0;
+
+    if ($[0] !== client) {
+        t0 = () => createInitialResult(client);
+        $[0] = client;
+        $[1] = t0;
+    } else {
+        t0 = $[1];
+    }
+
+    const [result, setResult] = React.useState(t0);
+    let t1;
+
+    if ($[2] !== client || $[3] !== mutation || $[4] !== options || $[5] !== result) {
+        t1 = {
+            result,
+            mutationId: 0,
+            isMounted: true,
+            client,
+            mutation,
+            options
+        };
+        $[2] = client;
+        $[3] = mutation;
+        $[4] = options;
+        $[5] = result;
+        $[6] = t1;
+    } else {
+        t1 = $[6];
+    }
+
+    const ref = React.useRef(t1);
+    let t2;
+
+    if ($[7] !== client || $[8] !== mutation || $[9] !== options) {
+        t2 = () => {
+            Object.assign(ref.current, {
+                client,
+                options,
+                mutation
+            });
+        };
+        $[7] = client;
+        $[8] = mutation;
+        $[9] = options;
+        $[10] = t2;
+    } else {
+        t2 = $[10];
+    }
+
+    useIsomorphicLayoutEffect(t2);
+    let t3;
+
+    if ($[11] === Symbol.for("react.memo_cache_sentinel")) {
+        t3 = t4 => {
+            const executeOptions = t4 === undefined ? {} : t4;
+            const {
+                options: options_0,
+                mutation: mutation_0
+            } = ref.current;
+            const baseOptions = {
+                ...options_0,
+                mutation: mutation_0
+            };
+            const client_0 = executeOptions.client || ref.current.client;
+
+            if (!ref.current.result.loading && ref.current.isMounted) {
+                setResult(ref.current.result = {
+                    loading: true,
+                    error: undefined,
+                    data: undefined,
+                    called: true,
+                    client: client_0
+                });
+            }
+
+            const mutationId = ref.current.mutationId = ref.current.mutationId + 1;
+            const clientOptions = mergeOptions(baseOptions, executeOptions);
+
+            return client_0.mutate(clientOptions).then(response => {
+                const {
+                    data,
+                    error
+                } = response;
+                const onError = executeOptions.onError || ref.current.options?.onError;
+
+                if (error && onError) {
+                    onError(error, clientOptions);
+                }
+
+                if (mutationId === ref.current.mutationId) {
+                    const result_0 = {
+                        called: true,
+                        loading: false,
+                        data,
+                        error,
+                        client: client_0
+                    };
+
+                    if (ref.current.isMounted && !equal(ref.current.result, result_0)) {
+                        setResult(ref.current.result = result_0);
+                    }
+                }
+
+                const onCompleted = executeOptions.onCompleted || ref.current.options?.onCompleted;
+
+                if (!error) {
+                    onCompleted?.(response.data, clientOptions);
+                }
+
+                return response;
+            }, error_0 => {
+                if (mutationId === ref.current.mutationId && ref.current.isMounted) {
+                    const result_1 = {
+                        loading: false,
+                        error: error_0,
+                        data: void 0,
+                        called: true,
+                        client: client_0
+                    };
+
+                    if (!equal(ref.current.result, result_1)) {
+                        setResult(ref.current.result = result_1);
+                    }
+                }
+
+                const onError_0 = executeOptions.onError || ref.current.options?.onError;
+
+                if (onError_0) {
+                    onError_0(error_0, clientOptions);
+                }
+
+                throw error_0;
+            });
+        };
+        $[11] = t3;
+    } else {
+        t3 = $[11];
+    }
+
+    const execute = t3;
+    let t4;
+
+    if ($[12] === Symbol.for("react.memo_cache_sentinel")) {
+        t4 = () => {
+            if (ref.current.isMounted) {
+                const result_2 = createInitialResult(ref.current.client);
+
+                Object.assign(ref.current, {
+                    mutationId: 0,
+                    result: result_2
+                });
+
+                setResult(result_2);
+            }
+        };
+        $[12] = t4;
+    } else {
+        t4 = $[12];
+    }
+
+    const reset = t4;
+    let t5;
+    let t6;
+
+    if ($[13] === Symbol.for("react.memo_cache_sentinel")) {
+        t5 = () => {
+            const current = ref.current;
+            current.isMounted = true;
+
+            return () => {
+                current.isMounted = false;
+            };
+        };t6 = [];
+        $[13] = t5;
+        $[14] = t6;
+    } else {
+        t5 = $[13];
+        t6 = $[14];
+    }
+
+    React.useEffect(t5, t6);
+    let t7;
+
+    if ($[15] !== result) {
+        t7 = [execute, {
+            reset,
+            ...result
+        }];
+        $[15] = result;
+        $[16] = t7;
+    } else {
+        t7 = $[16];
+    }
+
+    return t7;
+}
+function createInitialResult(client) {
+    return {
+        data: undefined,
+        error: undefined,
+        called: false,
+        loading: false,
+        client,
+    };
+}
+//# sourceMappingURL=useMutation.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useMutation.js","sources":["../../../src/react/hooks/useMutation.ts"],"sourcesContent":["import type { TypedDocumentNode } from \"@graphql-typed-document-node/core\";\nimport { equal } from \"@wry/equality\";\nimport * as React from \"react\";\n\nimport type {\n  ApolloCache,\n  ApolloClient,\n  DefaultContext,\n  DocumentNode,\n  ErrorLike,\n  ErrorPolicy,\n  InternalRefetchQueriesInclude,\n  MaybeMasked,\n  MutationFetchPolicy,\n  MutationQueryReducersMap,\n  MutationUpdaterFunction,\n  NormalizedExecutionResult,\n  OnQueryUpdated,\n  OperationVariables,\n  Unmasked,\n} from \"@apollo/client\";\nimport type { IgnoreModifier } from \"@apollo/client/cache\";\nimport type { NoInfer, Prettify } from \"@apollo/client/utilities/internal\";\nimport { mergeOptions } from \"@apollo/client/utilities/internal\";\n\nimport { useIsomorphicLayoutEffect } from \"./internal/useIsomorphicLayoutEffect.js\";\nimport { useApolloClient } from \"./useApolloClient.js\";\n\ntype MakeRequiredVariablesOptional<\n  TVariables extends OperationVariables,\n  TConfiguredVariables extends Partial<TVariables>,\n> = Prettify<\n  {\n    [K in keyof TVariables as K extends keyof TConfiguredVariables ? K\n    : never]?: TVariables[K];\n  } & Omit<TVariables, keyof TConfiguredVariables>\n>;\n\nexport declare namespace useMutation {\n  export interface Options<\n    TData = unknown,\n    TVariables extends OperationVariables = OperationVariables,\n    TCache extends ApolloCache = ApolloCache,\n    TConfiguredVariables extends Partial<TVariables> = Partial<TVariables>,\n  > {\n    /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#optimisticResponse:member} */\n    optimisticResponse?:\n      | Unmasked<NoInfer<TData>>\n      | ((\n          vars: TVariables,\n          { IGNORE }: { IGNORE: IgnoreModifier }\n        ) => Unmasked<NoInfer<TData>> | IgnoreModifier);\n\n    /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#updateQueries:member} */\n    updateQueries?: MutationQueryReducersMap<TData>;\n\n    /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#refetchQueries:member} */\n    refetchQueries?:\n      | ((\n          result: NormalizedExecutionResult<Unmasked<TData>>\n        ) => InternalRefetchQueriesInclude)\n      | InternalRefetchQueriesInclude;\n\n    /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#awaitRefetchQueries:member} */\n    awaitRefetchQueries?: boolean;\n\n    /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#update:member} */\n    update?: MutationUpdaterFunction<TData, TVariables, TCache>;\n\n    /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#onQueryUpdated:member} */\n    onQueryUpdated?: OnQueryUpdated<any>;\n\n    /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#errorPolicy:member} */\n    errorPolicy?: ErrorPolicy;\n\n    /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#variables:member} */\n    variables?: TConfiguredVariables;\n\n    /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#context:member} */\n    context?: DefaultContext;\n\n    /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#fetchPolicy:member} */\n    fetchPolicy?: MutationFetchPolicy;\n\n    /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#keepRootFields:member} */\n    keepRootFields?: boolean;\n\n    /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#client:member} */\n    client?: ApolloClient;\n\n    /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#notifyOnNetworkStatusChange:member} */\n    notifyOnNetworkStatusChange?: boolean;\n\n    /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#onCompleted:member} */\n    onCompleted?: (\n      data: MaybeMasked<TData>,\n      clientOptions?: Options<TData, TVariables, TCache>\n    ) => void;\n\n    /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#onError:member} */\n    onError?: (\n      error: ErrorLike,\n      clientOptions?: Options<TData, TVariables, TCache>\n    ) => void;\n  }\n\n  export interface Result<TData = unknown> {\n    /** {@inheritDoc @apollo/client!MutationResultDocumentation#data:member} */\n    data: MaybeMasked<TData> | null | undefined;\n\n    /** {@inheritDoc @apollo/client!MutationResultDocumentation#error:member} */\n    error: ErrorLike | undefined;\n\n    /** {@inheritDoc @apollo/client!MutationResultDocumentation#loading:member} */\n    loading: boolean;\n\n    /** {@inheritDoc @apollo/client!MutationResultDocumentation#called:member} */\n    called: boolean;\n\n    /** {@inheritDoc @apollo/client!MutationResultDocumentation#client:member} */\n    client: ApolloClient;\n\n    /** {@inheritDoc @apollo/client!MutationResultDocumentation#reset:member} */\n    reset: () => void;\n  }\n\n  export type ResultTuple<\n    TData,\n    TVariables extends OperationVariables,\n    TCache extends ApolloCache = ApolloCache,\n  > = [\n    mutate: MutationFunction<TData, TVariables, TCache>,\n    result: Result<TData>,\n  ];\n\n  export type MutationFunction<\n    TData,\n    TVariables extends OperationVariables,\n    TCache extends ApolloCache = ApolloCache,\n  > = (\n    ...[options]: {} extends TVariables ?\n      [\n        options?: MutationFunctionOptions<TData, TVariables, TCache> & {\n          /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#variables:member} */\n          variables?: TVariables;\n        },\n      ]\n    : [\n        options: MutationFunctionOptions<TData, TVariables, TCache> & {\n          /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#variables:member} */\n          variables: TVariables;\n        },\n      ]\n  ) => Promise<ApolloClient.MutateResult<MaybeMasked<TData>>>;\n\n  export type MutationFunctionOptions<\n    TData = unknown,\n    TVariables extends OperationVariables = OperationVariables,\n    TCache extends ApolloCache = ApolloCache,\n  > = Options<TData, TVariables, TCache>;\n\n  export namespace DocumentationTypes {\n    /** {@inheritDoc @apollo/client/react!useMutation:function(1)} */\n    export function useMutation<\n      TData = unknown,\n      TVariables extends OperationVariables = OperationVariables,\n    >(\n      mutation: DocumentNode | TypedDocumentNode<TData, TVariables>,\n      options?: useMutation.Options<TData, TVariables>\n    ): useMutation.ResultTuple<TData, TVariables>;\n  }\n}\n\n/**\n * > Refer to the [Mutations](https://www.apollographql.com/docs/react/data/mutations/) section for a more in-depth overview of `useMutation`.\n *\n * @example\n *\n * ```jsx\n * import { gql, useMutation } from \"@apollo/client\";\n *\n * const ADD_TODO = gql`\n *   mutation AddTodo($type: String!) {\n *     addTodo(type: $type) {\n *       id\n *       type\n *     }\n *   }\n * `;\n *\n * function AddTodo() {\n *   let input;\n *   const [addTodo, { data }] = useMutation(ADD_TODO);\n *\n *   return (\n *     <div>\n *       <form\n *         onSubmit={(e) => {\n *           e.preventDefault();\n *           addTodo({ variables: { type: input.value } });\n *           input.value = \"\";\n *         }}\n *       >\n *         <input\n *           ref={(node) => {\n *             input = node;\n *           }}\n *         />\n *         <button type=\"submit\">Add Todo</button>\n *       </form>\n *     </div>\n *   );\n * }\n * ```\n *\n * @param mutation - A GraphQL mutation document parsed into an AST by `gql`.\n * @param options - Options to control how the mutation is executed.\n * @returns A tuple in the form of `[mutate, result]`\n */\nexport function useMutation<\n  TData = unknown,\n  TVariables extends OperationVariables = OperationVariables,\n  TCache extends ApolloCache = ApolloCache,\n  TConfiguredVariables extends Partial<TVariables> = {},\n>(\n  mutation: DocumentNode | TypedDocumentNode<TData, TVariables>,\n  options?: useMutation.Options<\n    NoInfer<TData>,\n    NoInfer<TVariables>,\n    TCache,\n    {\n      [K in keyof TConfiguredVariables]: K extends keyof TVariables ?\n        TConfiguredVariables[K]\n      : never;\n    }\n  >\n): useMutation.ResultTuple<\n  TData,\n  MakeRequiredVariablesOptional<TVariables, TConfiguredVariables>,\n  TCache\n> {\n  const client = useApolloClient(options?.client);\n  const [result, setResult] = React.useState<\n    Omit<useMutation.Result<TData>, \"reset\">\n  >(() => createInitialResult(client));\n\n  const ref = React.useRef({\n    result,\n    mutationId: 0,\n    isMounted: true,\n    client,\n    mutation,\n    options,\n  });\n\n  useIsomorphicLayoutEffect(() => {\n    Object.assign(ref.current, { client, options, mutation });\n  });\n\n  const execute = React.useCallback(\n    (\n      executeOptions: useMutation.MutationFunctionOptions<\n        TData,\n        TVariables,\n        TCache\n      > = {} as useMutation.MutationFunctionOptions<TData, TVariables, TCache>\n    ) => {\n      const { options, mutation } = ref.current;\n      const baseOptions = { ...options, mutation };\n      const client = executeOptions.client || ref.current.client;\n\n      if (!ref.current.result.loading && ref.current.isMounted) {\n        setResult(\n          (ref.current.result = {\n            loading: true,\n            error: undefined,\n            data: undefined,\n            called: true,\n            client,\n          })\n        );\n      }\n\n      const mutationId = ++ref.current.mutationId;\n      const clientOptions = mergeOptions(baseOptions, executeOptions as any);\n\n      return client\n        .mutate(\n          clientOptions as ApolloClient.MutateOptions<TData, OperationVariables>\n        )\n        .then(\n          (response) => {\n            const { data, error } = response;\n\n            const onError =\n              executeOptions.onError || ref.current.options?.onError;\n\n            if (error && onError) {\n              onError(error, clientOptions);\n            }\n\n            if (mutationId === ref.current.mutationId) {\n              const result = {\n                called: true,\n                loading: false,\n                data,\n                error,\n                client,\n              };\n\n              if (ref.current.isMounted && !equal(ref.current.result, result)) {\n                setResult((ref.current.result = result));\n              }\n            }\n\n            const onCompleted =\n              executeOptions.onCompleted || ref.current.options?.onCompleted;\n\n            if (!error) {\n              onCompleted?.(response.data!, clientOptions);\n            }\n\n            return response;\n          },\n          (error) => {\n            if (\n              mutationId === ref.current.mutationId &&\n              ref.current.isMounted\n            ) {\n              const result = {\n                loading: false,\n                error,\n                data: void 0,\n                called: true,\n                client,\n              };\n\n              if (!equal(ref.current.result, result)) {\n                setResult((ref.current.result = result));\n              }\n            }\n\n            const onError =\n              executeOptions.onError || ref.current.options?.onError;\n\n            if (onError) {\n              onError(error, clientOptions);\n            }\n\n            throw error;\n          }\n        );\n    },\n    []\n  );\n\n  const reset = React.useCallback(() => {\n    if (ref.current.isMounted) {\n      const result = createInitialResult(ref.current.client);\n      Object.assign(ref.current, { mutationId: 0, result });\n      setResult(result);\n    }\n  }, []);\n\n  React.useEffect(() => {\n    const current = ref.current;\n    current.isMounted = true;\n\n    return () => {\n      current.isMounted = false;\n    };\n  }, []);\n\n  return [execute as any, { reset, ...result }];\n}\n\nfunction createInitialResult(client: ApolloClient) {\n  return {\n    data: undefined,\n    error: undefined,\n    called: false,\n    loading: false,\n    client,\n  };\n}\n"],"names":[],"mappings":";AACA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAsB,CAAtB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqC;AACrC,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;AAqB9B,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAA6B,CAA7B,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,CAAgE;AAEhE,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,EAAA,EAAA,CAAA,CAAA,CAAA,EAA0C,CAA1C,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,CAAmF;AACnF,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;AAmJtD,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6CA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SA8JS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAA6B,CAA7B,CAAA,CAAA,CAAA,CAAA,GAAA;IACE,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS;QACL,CAAJ,CAAA,CAAA,CAAQ,EAAE,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAmB;QACf,CAAJ,CAAA,CAAA,CAAA,CAAS,EAAE,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB;QAChB,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAU,EAAE,CAAZ,CAAA,CAAA,CAAA,CAAiB;QACb,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAW,EAAE,CAAb,CAAA,CAAA,CAAA,CAAkB;QACd,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAU;IACV,CAAG;AACH;"}

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

@@ -0,0 +1,393 @@
+import type { ApolloClient, DataState, DefaultContext, DocumentNode, ErrorLike, ErrorPolicy, GetDataState, InternalTypes, ObservableQuery, OperationVariables, RefetchWritePolicy, SubscribeToMoreFunction, TypedDocumentNode, UpdateQueryMapFn, WatchQueryFetchPolicy } from "@apollo/client";
+import { NetworkStatus } from "@apollo/client";
+import type { MaybeMasked } from "@apollo/client/masking";
+import type { DocumentationTypes as UtilityDocumentationTypes, NoInfer, VariablesOption } from "@apollo/client/utilities/internal";
+export declare namespace useQuery {
+    namespace Base {
+        interface Options<TData = unknown, TVariables extends OperationVariables = OperationVariables> {
+            /**
+            * Specifies how the query interacts with the Apollo Client cache during execution (for example, whether it checks the cache for results before sending a request to the server).
+            * 
+            * For details, see [Setting a fetch policy](https://www.apollographql.com/docs/react/data/queries/#setting-a-fetch-policy).
+            * 
+            * The default value is `cache-first`.
+            * 
+            * @docGroup 3. Caching options
+            */
+            fetchPolicy?: WatchQueryFetchPolicy;
+            /**
+            * Specifies the `FetchPolicy` to be used after this query has completed.
+            * 
+            * @docGroup 3. Caching options
+            */
+            nextFetchPolicy?: WatchQueryFetchPolicy | ((this: ApolloClient.WatchQueryOptions<TData, TVariables>, currentFetchPolicy: WatchQueryFetchPolicy, context: InternalTypes.NextFetchPolicyContext<TData, TVariables>) => WatchQueryFetchPolicy);
+            /**
+            * Defaults to the initial value of options.fetchPolicy, but can be explicitly
+            * configured to specify the WatchQueryFetchPolicy to revert back to whenever
+            * variables change (unless nextFetchPolicy intervenes).
+            * 
+            * @docGroup 3. Caching options
+            */
+            initialFetchPolicy?: WatchQueryFetchPolicy;
+            /**
+            * Specifies whether a `NetworkStatus.refetch` operation should merge
+            * incoming field data with existing data, or overwrite the existing data.
+            * Overwriting is probably preferable, but merging is currently the default
+            * behavior, for backwards compatibility with Apollo Client 3.x.
+            * 
+            * @docGroup 3. Caching options
+            */
+            refetchWritePolicy?: RefetchWritePolicy;
+            /**
+            * Specifies how the query 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 query result includes error details but not partial results.
+            * 
+            * @docGroup 1. Operation options
+            */
+            errorPolicy?: ErrorPolicy;
+            /**
+            * Specifies the interval (in milliseconds) at which the query polls for updated results.
+            * 
+            * The default value is `0` (no polling).
+            * 
+            * @docGroup 2. Networking options
+            */
+            pollInterval?: number;
+            /**
+            * If `true`, the in-progress query'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;
+            /**
+            * If `true`, the query can return partial results from the cache if the cache doesn't contain results for all queried fields.
+            * 
+            * The default value is `false`.
+            * 
+            * @docGroup 3. Caching options
+            */
+            returnPartialData?: boolean;
+            /**
+            * A callback function that's called whenever a refetch attempt occurs
+            * while polling. If the function returns `true`, the refetch is
+            * skipped and not reattempted until the next poll interval.
+            * 
+            * @docGroup 2. Networking options
+            */
+            skipPollAttempt?: () => boolean;
+            /**
+            * Pass `false` to skip executing the query during [server-side rendering](https://www.apollographql.com/docs/react/performance/server-side-rendering/).
+            * 
+            * @docGroup 2. Networking options
+            */
+            ssr?: boolean;
+            /**
+            * The instance of `ApolloClient` to use to execute the query.
+            * 
+            * By default, the instance that's passed down via context is used, but you
+            * can provide a different instance here.
+            * 
+            * @docGroup 1. Operation options
+            */
+            client?: ApolloClient;
+            /**
+            * 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;
+            /**
+            * If true, the query is not executed.
+            * 
+            * The default value is `false`.
+            * 
+            * @docGroup 1. Operation options
+            */
+            skip?: boolean;
+        }
+    }
+    type Options<TData = unknown, TVariables extends OperationVariables = OperationVariables> = Base.Options<TData, TVariables> & VariablesOption<TVariables>;
+    namespace DocumentationTypes {
+        namespace useQuery {
+            interface Options<TData = unknown, TVariables extends OperationVariables = OperationVariables> extends Base.Options<TData, TVariables>, UtilityDocumentationTypes.VariableOptions<TVariables> {
+            }
+        }
+    }
+    namespace Base {
+        interface Result<TData = unknown, TVariables extends OperationVariables = OperationVariables> {
+            /**
+            * The instance of Apollo Client that executed the query.
+            * Can be useful for manually executing followup queries or writing data to the cache.
+            * 
+            * @docGroup 2. Network info
+            */
+            client: ApolloClient;
+            /**
+            * A reference to the internal `ObservableQuery` used by the hook.
+            */
+            observable: ObservableQuery<TData, TVariables>;
+            /**
+            * An object containing the result from the most recent _previous_ execution of this query.
+            * 
+            * This value is `undefined` if this is the query's first execution.
+            * 
+            * @docGroup 1. Operation data
+            */
+            previousData?: MaybeMasked<TData>;
+            /**
+            * A single ErrorLike object describing the error that occured during the latest
+            * query execution.
+            * 
+            * For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
+            * 
+            * @docGroup 1. Operation data
+            */
+            error?: ErrorLike;
+            /**
+            * If `true`, the query is still in flight and results have not yet been returned.
+            * 
+            * @docGroup 2. Network info
+            */
+            loading: boolean;
+            /**
+            * A number indicating the current network state of the query's associated request. [See possible values.](https://github.com/apollographql/apollo-client/blob/d96f4578f89b933c281bb775a39503f6cdb59ee8/src/core/networkStatus.ts#L4)
+            * 
+            * Used in conjunction with the [`notifyOnNetworkStatusChange`](#notifyonnetworkstatuschange) option.
+            * 
+            * @docGroup 2. Network info
+            */
+            networkStatus: NetworkStatus;
+            /**
+            * A function that instructs the query to begin re-executing at a specified interval (in milliseconds).
+            *      
+            * 
+            * @docGroup 3. Helper functions
+            */
+            startPolling: (pollInterval: number) => void;
+            /**
+            * A function that instructs the query to stop polling after a previous call to `startPolling`.
+            *      
+            * 
+            * @docGroup 3. Helper functions
+            */
+            stopPolling: () => void;
+            /**
+            * A function that enables you to execute a [subscription](https://www.apollographql.com/docs/react/data/subscriptions/), usually to subscribe to specific fields that were included in the query.
+            * 
+            * This function returns _another_ function that you can call to terminate the subscription.
+            *      
+            * 
+            * @docGroup 3. Helper functions
+            */
+            subscribeToMore: SubscribeToMoreFunction<TData, TVariables>;
+            /**
+            * A function that enables you to update the query's cached result without executing a followup GraphQL operation.
+            * 
+            * See [using updateQuery and updateFragment](https://www.apollographql.com/docs/react/caching/cache-interaction/#using-updatequery-and-updatefragment) for additional information.
+            *      
+            * 
+            * @docGroup 3. Helper functions
+            */
+            updateQuery: (mapFn: UpdateQueryMapFn<TData, TVariables>) => void;
+            /**
+            * A function that enables you to re-execute the query, optionally passing in new `variables`.
+            * 
+            * To guarantee that the refetch performs a network request, its `fetchPolicy` is set to `network-only` (unless the original query's `fetchPolicy` is `no-cache` or `cache-and-network`, which also guarantee a network request).
+            * 
+            * See also [Refetching](https://www.apollographql.com/docs/react/data/queries/#refetching).
+            * 
+            * Returns a `ResultPromise` with an additional `.retain()` method. Calling
+            * `.retain()` keeps the network operation running even if the `ObservableQuery`
+            * no longer requires the result.
+            * 
+            * @docGroup 3. Helper functions
+            */
+            refetch: (variables?: Partial<TVariables>) => Promise<ApolloClient.QueryResult<MaybeMasked<TData>>>;
+            /**
+            * An object containing the variables that were provided for the query.
+            * 
+            * @docGroup 1. Operation data
+            */
+            variables: TVariables;
+            /**
+            * A function that helps you fetch the next set of results for a [paginated list field](https://www.apollographql.com/docs/react/pagination/core-api/).
+            *      
+            * 
+            * @docGroup 3. Helper functions
+            */
+            fetchMore: <TFetchData = TData, TFetchVars extends OperationVariables = TVariables>(fetchMoreOptions: ObservableQuery.FetchMoreOptions<TData, TVariables, TFetchData, TFetchVars>) => Promise<ApolloClient.QueryResult<MaybeMasked<TFetchData>>>;
+        }
+    }
+    type Result<TData = unknown, TVariables extends OperationVariables = OperationVariables, TStates extends DataState<TData>["dataState"] = DataState<TData>["dataState"]> = Base.Result<TData, TVariables> & GetDataState<MaybeMasked<TData>, TStates>;
+    namespace DocumentationTypes {
+        namespace useQuery {
+            interface Result<TData = unknown, TVariables extends OperationVariables = OperationVariables> extends Base.Result<TData, TVariables>, UtilityDocumentationTypes.DataState<TData> {
+            }
+        }
+    }
+    namespace DocumentationTypes {
+        /**
+        * A hook for executing queries in an Apollo application.
+        * 
+        * To run a query within a React component, call `useQuery` and pass it a GraphQL query document.
+        * 
+        * When your component renders, `useQuery` returns an object from Apollo Client that contains `loading`, `error`, `dataState`, and `data` properties you can use to render your UI.
+        * 
+        * > Refer to the [Queries](https://www.apollographql.com/docs/react/data/queries) section for a more in-depth overview of `useQuery`.
+        * 
+        * @example
+        * 
+        * ```jsx
+        * import { gql } from "@apollo/client";
+        * import { useQuery } from "@apollo/client/react";
+        * 
+        * const GET_GREETING = gql`
+        *   query GetGreeting($language: String!) {
+        *     greeting(language: $language) {
+        *       message
+        *     }
+        *   }
+        * `;
+        * 
+        * function Hello() {
+        *   const { loading, error, data } = useQuery(GET_GREETING, {
+        *     variables: { language: "english" },
+        *   });
+        *   if (loading) return <p>Loading ...</p>;
+        *   return <h1>Hello {data.greeting.message}!</h1>;
+        * }
+        * ```
+        * 
+        * @param query - A GraphQL query document parsed into an AST by `gql`.
+        * @param options - Options to control how the query is executed.
+        * @returns Query result object
+        */
+        function useQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useQuery.Options<TData, TVariables>): useQuery.Result<TData, TVariables>;
+    }
+}
+/**
+ * A hook for executing queries in an Apollo application.
+ *
+ * To run a query within a React component, call `useQuery` and pass it a GraphQL query document.
+ *
+ * When your component renders, `useQuery` returns an object from Apollo Client that contains `loading`, `error`, `dataState`, and `data` properties you can use to render your UI.
+ *
+ * > Refer to the [Queries](https://www.apollographql.com/docs/react/data/queries) section for a more in-depth overview of `useQuery`.
+ *
+ * @example
+ *
+ * ```jsx
+ * import { gql } from "@apollo/client";
+ * import { useQuery } from "@apollo/client/react";
+ *
+ * const GET_GREETING = gql`
+ *   query GetGreeting($language: String!) {
+ *     greeting(language: $language) {
+ *       message
+ *     }
+ *   }
+ * `;
+ *
+ * function Hello() {
+ *   const { loading, error, data } = useQuery(GET_GREETING, {
+ *     variables: { language: "english" },
+ *   });
+ *   if (loading) return <p>Loading ...</p>;
+ *   return <h1>Hello {data.greeting.message}!</h1>;
+ * }
+ * ```
+ *
+ * @param query - A GraphQL query document parsed into an AST by `gql`.
+ * @param options - Options to control how the query is executed.
+ * @returns Query result object
+ */
+export declare function useQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useQuery.Options<NoInfer<TData>, NoInfer<TVariables>> & {
+    returnPartialData: true;
+}): useQuery.Result<TData, TVariables, "empty" | "complete" | "streaming" | "partial">;
+/**
+* A hook for executing queries in an Apollo application.
+* 
+* To run a query within a React component, call `useQuery` and pass it a GraphQL query document.
+* 
+* When your component renders, `useQuery` returns an object from Apollo Client that contains `loading`, `error`, `dataState`, and `data` properties you can use to render your UI.
+* 
+* > Refer to the [Queries](https://www.apollographql.com/docs/react/data/queries) section for a more in-depth overview of `useQuery`.
+* 
+* @example
+* 
+* ```jsx
+* import { gql } from "@apollo/client";
+* import { useQuery } from "@apollo/client/react";
+* 
+* const GET_GREETING = gql`
+*   query GetGreeting($language: String!) {
+*     greeting(language: $language) {
+*       message
+*     }
+*   }
+* `;
+* 
+* function Hello() {
+*   const { loading, error, data } = useQuery(GET_GREETING, {
+*     variables: { language: "english" },
+*   });
+*   if (loading) return <p>Loading ...</p>;
+*   return <h1>Hello {data.greeting.message}!</h1>;
+* }
+* ```
+* 
+* @param query - A GraphQL query document parsed into an AST by `gql`.
+* @param options - Options to control how the query is executed.
+* @returns Query result object
+*/
+export declare function useQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useQuery.Options<NoInfer<TData>, NoInfer<TVariables>> & {
+    returnPartialData: boolean;
+}): useQuery.Result<TData, TVariables, "empty" | "complete" | "streaming" | "partial">;
+/**
+* A hook for executing queries in an Apollo application.
+* 
+* To run a query within a React component, call `useQuery` and pass it a GraphQL query document.
+* 
+* When your component renders, `useQuery` returns an object from Apollo Client that contains `loading`, `error`, `dataState`, and `data` properties you can use to render your UI.
+* 
+* > Refer to the [Queries](https://www.apollographql.com/docs/react/data/queries) section for a more in-depth overview of `useQuery`.
+* 
+* @example
+* 
+* ```jsx
+* import { gql } from "@apollo/client";
+* import { useQuery } from "@apollo/client/react";
+* 
+* const GET_GREETING = gql`
+*   query GetGreeting($language: String!) {
+*     greeting(language: $language) {
+*       message
+*     }
+*   }
+* `;
+* 
+* function Hello() {
+*   const { loading, error, data } = useQuery(GET_GREETING, {
+*     variables: { language: "english" },
+*   });
+*   if (loading) return <p>Loading ...</p>;
+*   return <h1>Hello {data.greeting.message}!</h1>;
+* }
+* ```
+* 
+* @param query - A GraphQL query document parsed into an AST by `gql`.
+* @param options - Options to control how the query is executed.
+* @returns Query result object
+*/
+export declare function useQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, ...[options]: {} extends TVariables ? [
+    options?: useQuery.Options<NoInfer<TData>, NoInfer<TVariables>>
+] : [options: useQuery.Options<NoInfer<TData>, NoInfer<TVariables>>]): useQuery.Result<TData, TVariables, "empty" | "complete" | "streaming">;
+export declare namespace useQuery {
+    var ssrDisabledResult: ObservableQuery.Result<any, "complete" | "streaming" | "partial" | "empty">;
+}
+//# sourceMappingURL=useQuery.d.ts.map