@depup/apollo__client 4.1.6-depup.0

package/__cjs/react/hooks/useMutation.d.cts

@@ -0,0 +1,316 @@
+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?: Partial<TVariables> & 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 the `errorPolicy`
+        * is `all` or `ignore` and the server returns a GraphQL response with `errors`
+        * but not `data` or a network error is returned.
+        */
+        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> & {
+        /**
+        * 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
+        *      
+        *
+        * @remarks
+        * When provided as a callback function, the function is called with the
+        * value of `context` provided to the `useMutation` hook.
+        */
+        context?: DefaultContext | ((hookContext: DefaultContext | undefined) => DefaultContext);
+    };
+    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.cts.map

package/__cjs/react/hooks/useQuery.cjs

@@ -0,0 +1,219 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useQuery = useQuery;
+const tslib_1 = require("tslib");
+/**
+ * Function parameters in this file try to follow a common order for the sake of
+ * readability and consistency. The order is as follows:
+ *
+ * resultData
+ * observable
+ * client
+ * query
+ * options
+ * watchQueryOptions
+ * makeWatchQueryOptions
+ */
+/**  */
+const equality_1 = require("@wry/equality");
+const React = tslib_1.__importStar(require("react"));
+const rxjs_1 = require("rxjs");
+const client_1 = require("@apollo/client");
+const internal_1 = require("@apollo/client/utilities/internal");
+const constants_js_1 = require("./constants.cjs");
+const index_js_1 = require("./internal/index.cjs");
+const useApolloClient_js_1 = require("./useApolloClient.cjs");
+const useSyncExternalStore_js_1 = require("./useSyncExternalStore.cjs");
+const lastWatchOptions = Symbol();
+function useQuery(query, ...[options]) {
+    "use no memo";
+    return (0, index_js_1.wrapHook)("useQuery", useQuery_, (0, useApolloClient_js_1.useApolloClient)(typeof options === "object" ? options.client : undefined))(query, options);
+}
+function useQuery_(query, options = {}) {
+    const client = (0, useApolloClient_js_1.useApolloClient)(typeof options === "object" ? options.client : undefined);
+    const { ssr } = typeof options === "object" ? options : {};
+    const watchQueryOptions = useOptions(query, options, client.defaultOptions.watchQuery);
+    function createState(previous) {
+        const observable = client.watchQuery(watchQueryOptions);
+        return {
+            client,
+            query,
+            observable,
+            resultData: {
+                current: observable.getCurrentResult(),
+                // Reuse previousData from previous InternalState (if any) to provide
+                // continuity of previousData even if/when the query or client changes.
+                previousData: previous?.resultData.current.data,
+                variables: observable.variables,
+            },
+        };
+    }
+    let [state, setState] = React.useState(createState);
+    if (client !== state.client || query !== state.query) {
+        // If the client or query have changed, we need to create a new InternalState.
+        // This will trigger a re-render with the new state, but it will also continue
+        // to run the current render function to completion.
+        // Since we sometimes trigger some side-effects in the render function, we
+        // re-assign `state` to the new state to ensure that those side-effects are
+        // triggered with the new state.
+        setState((state = createState(state)));
+    }
+    const { observable, resultData } = state;
+    useInitialFetchPolicyIfNecessary(watchQueryOptions, observable);
+    useResubscribeIfNecessary(resultData, // might get mutated during render
+    observable, // might get mutated during render
+    watchQueryOptions);
+    const result = useResult(observable, resultData, ssr);
+    const obsQueryFields = React.useMemo(() => ({
+        refetch: observable.refetch.bind(observable),
+        fetchMore: observable.fetchMore.bind(observable),
+        updateQuery: observable.updateQuery.bind(observable),
+        startPolling: observable.startPolling.bind(observable),
+        stopPolling: observable.stopPolling.bind(observable),
+        subscribeToMore: observable.subscribeToMore.bind(observable),
+    }), [observable]);
+    const previousData = resultData.previousData;
+    return React.useMemo(() => {
+        const { partial, ...rest } = result;
+        return {
+            ...rest,
+            client,
+            observable,
+            variables: observable.variables,
+            previousData,
+            ...obsQueryFields,
+        };
+    }, [result, client, observable, previousData, obsQueryFields]);
+}
+const fromSkipToken = Symbol();
+function useOptions(query, options, defaultOptions) {
+    return (0, index_js_1.useDeepMemo)(() => {
+        if (options === constants_js_1.skipToken) {
+            const opts = {
+                ...(0, internal_1.mergeOptions)(defaultOptions, {
+                    query,
+                    fetchPolicy: "standby",
+                }),
+                [internal_1.variablesUnknownSymbol]: true,
+            };
+            opts[fromSkipToken] = true;
+            return opts;
+        }
+        const watchQueryOptions = (0, internal_1.mergeOptions)(defaultOptions, { ...options, query });
+        if (options.skip) {
+            watchQueryOptions.initialFetchPolicy =
+                options.initialFetchPolicy || options.fetchPolicy;
+            watchQueryOptions.fetchPolicy = "standby";
+        }
+        return watchQueryOptions;
+    }, [query, options, defaultOptions]);
+}
+function useInitialFetchPolicyIfNecessary(watchQueryOptions, observable) {
+    "use no memo";
+    if (!watchQueryOptions.fetchPolicy) {
+        watchQueryOptions.fetchPolicy = observable.options.initialFetchPolicy;
+    }
+}
+function useResult(observable, resultData, ssr) {
+    "use no memo";
+    const fetchPolicy = observable.options.fetchPolicy;
+    return (0, useSyncExternalStore_js_1.useSyncExternalStore)(React.useCallback((handleStoreChange) => {
+        const subscription = observable
+            // We use the asapScheduler here to prevent issues with trying to
+            // update in the middle of a render. `reobserve` is kicked off in the
+            // middle of a render and because RxJS emits values synchronously,
+            // its possible for this `handleStoreChange` to be called in that same
+            // render. This allows the render to complete before trying to emit a
+            // new value.
+            .pipe((0, rxjs_1.observeOn)(rxjs_1.asapScheduler))
+            .subscribe((result) => {
+            const previous = resultData.current;
+            if (
+            // Avoid rerendering if the result is the same
+            (0, equality_1.equal)(previous, result) &&
+                // Force rerender if the value was emitted because variables
+                // changed, such as when calling `refetch(newVars)` which returns
+                // the same data when `notifyOnNetworkStatusChange` is `false`.
+                (0, equality_1.equal)(resultData.variables, observable.variables)) {
+                return;
+            }
+            resultData.variables = observable.variables;
+            if (previous.data && !(0, equality_1.equal)(previous.data, result.data)) {
+                resultData.previousData = previous.data;
+            }
+            resultData.current = result;
+            handleStoreChange();
+        });
+        // Do the "unsubscribe" with a short delay.
+        // This way, an existing subscription can be reused without an additional
+        // request if "unsubscribe"  and "resubscribe" to the same ObservableQuery
+        // happen in very fast succession.
+        return () => {
+            setTimeout(() => subscription.unsubscribe());
+        };
+    }, [observable, resultData]), () => resultData.current, () => ((fetchPolicy !== "standby" && ssr === false) ||
+        fetchPolicy === "no-cache") ?
+        useQuery.ssrDisabledResult
+        : resultData.current);
+}
+// this hook is not compatible with any rules of React, and there's no good way to rewrite it.
+// it should stay a separate hook that will not be optimized by the compiler
+function useResubscribeIfNecessary(
+/** this hook will mutate properties on `resultData` */
+resultData, 
+/** this hook will mutate properties on `observable` */
+observable, watchQueryOptions) {
+    "use no memo";
+    if (observable[lastWatchOptions] &&
+        !(0, equality_1.equal)(observable[lastWatchOptions], watchQueryOptions)) {
+        // If skipToken was used to generate options, we won't know the correct
+        // initialFetchPolicy until the hook is rerendered with real options, so we
+        // set it the next time we get real options
+        if (observable[lastWatchOptions][fromSkipToken] &&
+            !watchQueryOptions.initialFetchPolicy) {
+            watchQueryOptions.initialFetchPolicy =
+                watchQueryOptions.fetchPolicy;
+        }
+        // Though it might be tempting to postpone this reobserve call to the
+        // useEffect block, we need getCurrentResult to return an appropriate
+        // loading:true result synchronously (later within the same call to
+        // useQuery). Since we already have this.observable here (not true for
+        // the very first call to useQuery), we are not initiating any new
+        // subscriptions, though it does feel less than ideal that reobserve
+        // (potentially) kicks off a network request (for example, when the
+        // variables have changed), which is technically a side-effect.
+        if (shouldReobserve(observable[lastWatchOptions], watchQueryOptions)) {
+            observable.reobserve(watchQueryOptions);
+        }
+        else {
+            observable.applyOptions(watchQueryOptions);
+        }
+        // Make sure getCurrentResult returns a fresh ApolloQueryResult<TData>,
+        // but save the current data as this.previousData, just like setResult
+        // usually does.
+        const result = observable.getCurrentResult();
+        if (!(0, equality_1.equal)(result.data, resultData.current.data)) {
+            resultData.previousData = (resultData.current.data ||
+                resultData.previousData);
+        }
+        resultData.current = result;
+        resultData.variables = observable.variables;
+    }
+    observable[lastWatchOptions] = watchQueryOptions;
+}
+function shouldReobserve(previousOptions, options) {
+    return (previousOptions.query !== options.query ||
+        !(0, equality_1.equal)(previousOptions.variables, options.variables) ||
+        (previousOptions.fetchPolicy !== options.fetchPolicy &&
+            (options.fetchPolicy === "standby" ||
+                previousOptions.fetchPolicy === "standby")));
+}
+useQuery.ssrDisabledResult = (0, internal_1.maybeDeepFreeze)({
+    loading: true,
+    data: void 0,
+    dataState: "empty",
+    error: void 0,
+    networkStatus: client_1.NetworkStatus.loading,
+    partial: true,
+});
+//# sourceMappingURL=useQuery.cjs.map