@apollo/client 4.0.0-alpha.0 → 4.0.0-alpha.10

package/react/types/deprecated.d.ts

@@ -0,0 +1,75 @@
+import type { ApolloCache, DefaultContext, OperationVariables } from "@apollo/client";
+import type { useBackgroundQuery } from "../hooks/useBackgroundQuery.js";
+import type { useFragment } from "../hooks/useFragment.js";
+import type { useLazyQuery } from "../hooks/useLazyQuery.js";
+import type { useLoadableQuery } from "../hooks/useLoadableQuery.js";
+import type { useMutation } from "../hooks/useMutation.js";
+import type { useQuery } from "../hooks/useQuery.js";
+import type { useQueryRefHandlers } from "../hooks/useQueryRefHandlers.js";
+import type { useReadQuery } from "../hooks/useReadQuery.js";
+import type { useSubscription } from "../hooks/useSubscription.js";
+import type { useSuspenseFragment } from "../hooks/useSuspenseFragment.js";
+import type { useSuspenseQuery } from "../hooks/useSuspenseQuery.js";
+/** @deprecated Use `useQuery.Options` instead */
+export type QueryHookOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> = useQuery.Options<TData, TVariables>;
+/** @deprecated Use `useQuery.Result` instead */
+export type QueryResult<TData = unknown, TVariables extends OperationVariables = OperationVariables> = useQuery.Result<TData, TVariables>;
+/** @deprecated Use `useLazyQuery.Options` instead */
+export type LazyQueryHookOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> = useLazyQuery.Options<TData, TVariables>;
+/** @deprecated Use `useLazyQuery.Result` instead */
+export type LazyQueryResult<TData = unknown, TVariables extends OperationVariables = OperationVariables> = useLazyQuery.Result<TData, TVariables>;
+/** @deprecated Use `useLazyQuery.ResultTuple` instead */
+export type LazyQueryResultTuple<TData = unknown, TVariables extends OperationVariables = OperationVariables> = useLazyQuery.ResultTuple<TData, TVariables>;
+/** @deprecated Use `useLazyQuery.ExecOptions` instead */
+export type LazyQueryHookExecOptions<TVariables extends OperationVariables = OperationVariables> = useLazyQuery.ExecOptions<TVariables>;
+/** @deprecated Use `useLazyQuery.ExecOptions` instead */
+export type LazyQueryExecFunction<TData = unknown, TVariables extends OperationVariables = OperationVariables> = useLazyQuery.ExecFunction<TData, TVariables>;
+/** @deprecated Use `useMutation.Options` instead */
+export type MutationHookOptions<TData = unknown, TVariables = OperationVariables, TContext = DefaultContext, TCache extends ApolloCache = ApolloCache> = useMutation.Options<TData, TVariables, TContext, TCache>;
+/** @deprecated Use `useMutation.Result` instead */
+export type MutationResult<TData = unknown> = useMutation.Result<TData>;
+/** @deprecated Use `useMutation.MutationFunctionOptions` instead */
+export type MutationFunctionOptions<TData = unknown, TVariables = OperationVariables, TContext = DefaultContext, TCache extends ApolloCache = ApolloCache> = useMutation.MutationFunctionOptions<TData, TVariables, TContext, TCache>;
+/** @deprecated Use `useMutation.ResultTuple` instead */
+export type MutationTuple<TData, TVariables, TContext = DefaultContext, TCache extends ApolloCache = ApolloCache> = useMutation.ResultTuple<TData, TVariables, TContext, TCache>;
+/** @deprecated Use `useSubscription.Result` instead */
+export type SubscriptionResult<TData = unknown, TVariables extends OperationVariables = OperationVariables> = useSubscription.Result<TData>;
+/** @deprecated Use `useSubscription.Options` instead */
+export type SubscriptionHookOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> = useSubscription.Options<TData, TVariables>;
+/** @deprecated Use `useSubscription.OnDataOptions` instead */
+export type OnDataOptions<TData = unknown> = useSubscription.OnDataOptions<TData>;
+/** @deprecated Use `useSubscription.OnSubscriptionDataOptions` instead */
+export type OnSubscriptionDataOptions<TData = unknown> = useSubscription.OnSubscriptionDataOptions<TData>;
+/** @deprecated Use `useFragment.Options` instead */
+export type UseFragmentOptions<TData, TVariables> = useFragment.Options<TData, TVariables>;
+/** @deprecated Use `useFragment.Result` instead */
+export type UseFragmentResult<TData> = useFragment.Result<TData>;
+/** @deprecated Use `useSuspenseQuery.Options` instead */
+export type SuspenseQueryHookOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> = useSuspenseQuery.Options<TVariables>;
+/** @deprecated Use `useSuspenseQuery.Result` instead */
+export type UseSuspenseQueryResult<TData = unknown, TVariables extends OperationVariables = OperationVariables> = useSuspenseQuery.Result<TData, TVariables>;
+/** @deprecated Use `useSuspenseQuery.FetchPolicy` instead */
+export type SuspenseQueryHookFetchPolicy = useSuspenseQuery.FetchPolicy;
+/** @deprecated Use `useBackgroundQuery.Options` instead */
+export type BackgroundQueryHookOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> = useBackgroundQuery.Options<TVariables>;
+/** @deprecated Use `useBackgroundQuery.Result` instead */
+export type UseBackgroundQueryResult<TData = unknown, TVariables extends OperationVariables = OperationVariables> = useBackgroundQuery.Result<TData, TVariables>;
+/** @deprecated Use `useBackgroundQuery.FetchPolicy` instead */
+export type BackgroundQueryHookFetchPolicy = useBackgroundQuery.FetchPolicy;
+/** @deprecated Use `useSuspenseFragment.Options` instead */
+export type UseSuspenseFragmentOptions<TData, TVariables extends OperationVariables> = useSuspenseFragment.Options<TData, TVariables>;
+/** @deprecated Use `useSuspenseFragment.Result` instead */
+export type UseSuspenseFragmentResult<TData> = useSuspenseFragment.Result<TData>;
+/** @deprecated Use `useLoadableQuery.LoadQueryFunction` instead */
+export type LoadQueryFunction<TVariables extends OperationVariables> = useLoadableQuery.LoadQueryFunction<TVariables>;
+/** @deprecated Use `useLoadableQuery.FetchPolicy` instead */
+export type LoadableQueryFetchPolicy = useLoadableQuery.FetchPolicy;
+/** @deprecated Use `useLoadableQuery.Options` instead */
+export type LoadableQueryHookOptions = useLoadableQuery.Options;
+/** @deprecated Use `useLoadableQuery.Result` instead */
+export type UseLoadableQueryResult<TData = unknown, TVariables extends OperationVariables = OperationVariables> = useLoadableQuery.Result<TData, TVariables>;
+/** @deprecated Use `useQueryRefHandlers.Result` instead */
+export type UseQueryRefHandlersResult<TData = unknown, TVariables extends OperationVariables = OperationVariables> = useQueryRefHandlers.Result<TData, TVariables>;
+/** @deprecated Use `useReadQuery.Result` instead */
+export type UseReadQueryResult<TData = unknown> = useReadQuery.Result<TData>;
+//# sourceMappingURL=deprecated.d.ts.map

package/react/types/deprecated.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=deprecated.js.map

package/react/types/deprecated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deprecated.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/react/types/types.documentation.d.ts

@@ -64,7 +64,7 @@ export interface QueryOptionsDocumentation {
     /**
      * 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 `false`.
+     * The default value is `true`.
      *
      * @docGroup 2. Networking options
      */
@@ -94,18 +94,6 @@ export interface QueryOptionsDocumentation {
      * @docGroup 3. Caching options
      */
     refetchWritePolicy_suspense: unknown;
-    /**
-     * Whether to canonize cache results before returning them. Canonization
-     * takes some extra time, but it speeds up future deep equality comparisons.
-     * Defaults to false.
-     *
-     * @deprecated
-     * Using `canonizeResults` can result in memory leaks so we generally do not
-     * recommend using this option anymore.
-     * A future version of Apollo Client will contain a similar feature without
-     * the risk of memory leaks.
-     */
-    canonizeResults: unknown;
     /**
      * If true, the query is not executed.
      *
@@ -210,14 +198,6 @@ export interface QueryResultDocumentation {
      * @docGroup 2. Network info
      */
     networkStatus: unknown;
-    /**
-     * If `true`, the associated lazy query has been executed.
-     *
-     * This field is only present on the result object returned by [`useLazyQuery`](/react/data/queries/#executing-queries-manually).
-     *
-     * @docGroup 2. Network info
-     */
-    called: unknown;
     /**
      * An object containing the variables that were provided for the query.
      *
@@ -392,7 +372,7 @@ export interface MutationOptionsDocumentation {
     /**
      * 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 `false`.
+     * The default value is `true`.
      *
      * @docGroup 2. Networking options
      */
@@ -457,6 +437,10 @@ export interface MutationResultDocumentation {
      * A function that you can call to reset the mutation's result to its initial, uncalled state.
      */
     reset: unknown;
+    /**
+     * Custom extensions returned from the GraphQL server
+     */
+    extensions: unknown;
 }
 export interface SubscriptionOptionsDocumentation {
     /**
@@ -514,24 +498,12 @@ export interface SubscriptionOptionsDocumentation {
      * @since 3.7.0
      */
     onData: unknown;
-    /**
-     * Allows the registration of a callback function that will be triggered each time the `useSubscription` Hook / `Subscription` component receives data. The callback `options` object param consists of the current Apollo Client instance in `client`, and the received subscription data in `subscriptionData`.
-     *
-     * @deprecated Use `onData` instead
-     */
-    onSubscriptionData: unknown;
     /**
      * Allows the registration of a callback function that will be triggered each time the `useSubscription` Hook / `Subscription` component receives an error.
      *
      * @since 3.7.0
      */
     onError: unknown;
-    /**
-     * Allows the registration of a callback function that will be triggered when the `useSubscription` Hook / `Subscription` component completes the subscription.
-     *
-     * @deprecated Use `onComplete` instead
-     */
-    onSubscriptionComplete: unknown;
 }
 export interface SubscriptionResultDocumentation {
     /**

package/testing/core/index.d.ts

@@ -1,7 +1,7 @@
-export type { MockedResponse, MockLinkOptions, ResultFunction, } from "./mocking/mockLink.js";
-export { MockLink, mockSingleLink } from "./mocking/mockLink.js";
+export type { MockedRequest, MockedResponse, MockLinkOptions, ResultFunction, } from "./mocking/mockLink.js";
+export { MockLink, mockSingleLink, realisticDelay, } from "./mocking/mockLink.js";
 export { mockObservableLink, MockSubscriptionLink, } from "./mocking/mockSubscriptionLink.js";
 export { createMockClient } from "./mocking/mockClient.js";
 export { tick, wait } from "./wait.js";
-export * from "./withConsoleSpy.js";
+export { withErrorSpy, withLogSpy, withWarningSpy } from "./withConsoleSpy.js";
 //# sourceMappingURL=index.d.ts.map

package/testing/core/index.js

@@ -1,6 +1,6 @@
-export { MockLink, mockSingleLink } from "./mocking/mockLink.js";
+export { MockLink, mockSingleLink, realisticDelay, } from "./mocking/mockLink.js";
 export { mockObservableLink, MockSubscriptionLink, } from "./mocking/mockSubscriptionLink.js";
 export { createMockClient } from "./mocking/mockClient.js";
 export { tick, wait } from "./wait.js";
-export * from "./withConsoleSpy.js";
+export { withErrorSpy, withLogSpy, withWarningSpy } from "./withConsoleSpy.js";
 //# sourceMappingURL=index.js.map

package/testing/core/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../../src/testing/core/index.ts"],"sourcesContent":["export type {\n  MockedResponse,\n  MockLinkOptions,\n  ResultFunction,\n} from \"./mocking/mockLink.js\";\nexport { MockLink, mockSingleLink } from \"./mocking/mockLink.js\";\nexport {\n  mockObservableLink,\n  MockSubscriptionLink,\n} from \"./mocking/mockSubscriptionLink.js\";\nexport { createMockClient } from \"./mocking/mockClient.js\";\nexport { tick, wait } from \"./wait.js\";\nexport * from \"./withConsoleSpy.js\";\n"],"names":[],"mappings":"AAKA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiB,EAAE,CAAnB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAyC,CAAzC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgE;AAChE,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EACL,CADF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACoB,EAClB,CAFF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAEsB,EAFtB,EAAA,CAAA,CAAA,CAAA,EAGO,CAHP,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,CAG0C;AAC1C,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAiC,CAAjC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0D;AAC1D,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAa,EAAE,CAAf,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAA2B,CAA3B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsC;AACtC,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAc,CAAd,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;"}
+{"version":3,"file":"index.js","sources":["../../../src/testing/core/index.ts"],"sourcesContent":["export type {\n  MockedRequest,\n  MockedResponse,\n  MockLinkOptions,\n  ResultFunction,\n} from \"./mocking/mockLink.js\";\nexport {\n  MockLink,\n  mockSingleLink,\n  realisticDelay,\n} from \"./mocking/mockLink.js\";\nexport {\n  mockObservableLink,\n  MockSubscriptionLink,\n} from \"./mocking/mockSubscriptionLink.js\";\nexport { createMockClient } from \"./mocking/mockClient.js\";\nexport { tick, wait } from \"./wait.js\";\nexport { withErrorSpy, withLogSpy, withWarningSpy } from \"./withConsoleSpy.js\";\n"],"names":[],"mappings":"AAMA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EACL,CADF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACU,EACR,CAFF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAEgB,EACd,CAHF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAGgB,EAHhB,EAAA,CAAA,CAAA,CAAA,EAIO,CAJP,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAI8B;AAC9B,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EACL,CADF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACoB,EAClB,CAFF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAEsB,EAFtB,EAAA,CAAA,CAAA,CAAA,EAGO,CAHP,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,CAG0C;AAC1C,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAiC,CAAjC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0D;AAC1D,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAa,EAAE,CAAf,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAA2B,CAA3B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsC;AACtC,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAuB,CAAvB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAmC,CAAnC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAyD,CAAzD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;"}

package/testing/core/mocking/mockClient.d.ts

@@ -1,5 +1,4 @@
 import type { DocumentNode } from "graphql";
-import type { NormalizedCacheObject } from "@apollo/client/cache";
-import { ApolloClient } from "@apollo/client/core";
-export declare function createMockClient<TData>(data: TData, query: DocumentNode, variables?: {}): ApolloClient<NormalizedCacheObject>;
+import { ApolloClient } from "@apollo/client";
+export declare function createMockClient<TData>(data: TData, query: DocumentNode, variables?: {}): ApolloClient;
 //# sourceMappingURL=mockClient.d.ts.map

package/testing/core/mocking/mockClient.js

@@ -1,13 +1,12 @@
+import { ApolloClient } from "@apollo/client";
 import { InMemoryCache } from "@apollo/client/cache";
-import { ApolloClient } from "@apollo/client/core";
 import { mockSingleLink } from "./mockLink.js";
+// TODO: Deprecate this function
 export function createMockClient(data, query, variables = {}) {
     return new ApolloClient({
         link: mockSingleLink({
             request: { query, variables },
             result: { data },
-        }).setOnError((error) => {
-            throw error;
         }),
         cache: new InMemoryCache(),
     });

package/testing/core/mocking/mockClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"mockClient.js","sources":["../../../../src/testing/core/mocking/mockClient.ts"],"sourcesContent":["import type { DocumentNode } from \"graphql\";\n\nimport type { NormalizedCacheObject } from \"@apollo/client/cache\";\nimport { InMemoryCache } from \"@apollo/client/cache\";\nimport { ApolloClient } from \"@apollo/client/core\";\n\nimport { mockSingleLink } from \"./mockLink.js\";\n\nexport function createMockClient<TData>(\n  data: TData,\n  query: DocumentNode,\n  variables = {}\n): ApolloClient<NormalizedCacheObject> {\n  return new ApolloClient({\n    link: mockSingleLink({\n      request: { query, variables },\n      result: { data },\n    }).setOnError((error) => {\n      throw error;\n    }),\n    cache: new InMemoryCache(),\n  });\n}\n"],"names":[],"mappings":"AAGA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAA8B,CAA9B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoD;AACpD,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,CAAkD;AAElD,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAA+B,CAA/B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8C;AAE9C,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACE,CADF,CAAA,CAAA,CAAA,EAEE,CAFF,CAAA,CAAA,CAAA,CAAA,EAGE,CAHF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAGc,CAHd,CAAA,EAAA;IAKE,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAC;QACtB,CAAJ,CAAA,CAAA,CAAQ,EAAE,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwB,CAAC;YACnB,CAAN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAa,EAAE,EAAE,CAAjB,CAAA,CAAA,CAAA,CAAsB,EAAE,CAAxB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAmC;YAC7B,CAAN,CAAA,CAAA,CAAA,CAAA,CAAY,EAAE,EAAE,CAAhB,CAAA,CAAA,EAAA,CAAsB;QACtB,CAAK,CAAC,CAAC,CAAP,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiB,CAAC,CAAC,CAAnB,CAAA,CAAA,CAAA,CAAwB,EAAE,CAA1B,EAAA;YACM,CAAN,CAAA,CAAA,CAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,CAAiB;QACb,CAAC,CAAC;QACF,CAAJ,CAAA,CAAA,CAAA,CAAS,EAAE,CAAX,CAAA,EAAe,CAAf,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA4B,CAA5B,CAA8B;IAC9B,CAAG,CAAC;AACJ;"}
+{"version":3,"file":"mockClient.js","sources":["../../../../src/testing/core/mocking/mockClient.ts"],"sourcesContent":["import type { DocumentNode } from \"graphql\";\n\nimport { ApolloClient } from \"@apollo/client\";\nimport { InMemoryCache } from \"@apollo/client/cache\";\n\nimport { mockSingleLink } from \"./mockLink.js\";\n\n// TODO: Deprecate this function\nexport function createMockClient<TData>(\n  data: TData,\n  query: DocumentNode,\n  variables = {}\n): ApolloClient {\n  return new ApolloClient({\n    link: mockSingleLink({\n      request: { query, variables },\n      result: { data },\n    }),\n    cache: new InMemoryCache(),\n  });\n}\n"],"names":[],"mappings":"AAEA,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,CAA6C;AAC7C,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAA8B,CAA9B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoD;AAEpD,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAA+B,CAA/B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8C;AAE9C,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACE,CADF,CAAA,CAAA,CAAA,EAEE,CAFF,CAAA,CAAA,CAAA,CAAA,EAGE,CAHF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAGc,CAHd,CAAA,EAAA;IAKE,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAC;QACtB,CAAJ,CAAA,CAAA,CAAQ,EAAE,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwB,CAAC;YACnB,CAAN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAa,EAAE,EAAE,CAAjB,CAAA,CAAA,CAAA,CAAsB,EAAE,CAAxB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAmC;YAC7B,CAAN,CAAA,CAAA,CAAA,CAAA,CAAY,EAAE,EAAE,CAAhB,CAAA,CAAA,EAAA,CAAsB;QACtB,CAAK,CAAC;QACF,CAAJ,CAAA,CAAA,CAAA,CAAS,EAAE,CAAX,CAAA,EAAe,CAAf,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA4B,CAA5B,CAA8B;IAC9B,CAAG,CAAC;AACJ;"}

package/testing/core/mocking/mockLink.d.ts

@@ -1,5 +1,6 @@
+import type { DocumentNode } from "graphql";
 import { Observable } from "rxjs";
-import type { FetchResult, GraphQLRequest, Operation } from "@apollo/client/link/core";
+import type { FetchResult, Operation } from "@apollo/client/link/core";
 import { ApolloLink } from "@apollo/client/link/core";
 import type { Unmasked } from "@apollo/client/masking";
 /** @internal */
@@ -8,28 +9,46 @@ type CovariantUnaryFunction<out Arg, out Ret> = {
 }["fn"];
 export type ResultFunction<T, V = Record<string, any>> = CovariantUnaryFunction<V, T>;
 type VariableMatcher<V = Record<string, any>> = CovariantUnaryFunction<V, boolean>;
+export interface MockedRequest<TVariables = Record<string, any>> {
+    query: DocumentNode;
+    variables?: TVariables | VariableMatcher<TVariables>;
+}
 export interface MockedResponse<out TData = Record<string, any>, out TVariables = Record<string, any>> {
-    request: GraphQLRequest<TVariables>;
+    request: MockedRequest<TVariables>;
     maxUsageCount?: number;
     result?: FetchResult<Unmasked<TData>> | ResultFunction<FetchResult<Unmasked<TData>>, TVariables>;
     error?: Error;
-    delay?: number;
-    variableMatcher?: VariableMatcher<TVariables>;
-    newData?: ResultFunction<FetchResult<Unmasked<TData>>, TVariables>;
+    delay?: number | MockLink.DelayFunction;
 }
 export interface MockLinkOptions {
     showWarnings?: boolean;
+    defaultOptions?: MockLink.DefaultOptions;
+}
+export declare namespace MockLink {
+    type DelayFunction = (operation: Operation) => number;
+    type Delay = number | DelayFunction;
+    interface DefaultOptions {
+        delay?: MockLink.Delay;
+    }
 }
+export declare function realisticDelay({ min, max, }?: {
+    min?: number;
+    max?: number;
+}): MockLink.DelayFunction;
 export declare class MockLink extends ApolloLink {
     operation: Operation;
     showWarnings: boolean;
+    private defaultDelay;
     private mockedResponsesByKey;
-    constructor(mockedResponses: ReadonlyArray<MockedResponse<any, any>>, options?: MockLinkOptions);
+    static defaultOptions: MockLink.DefaultOptions;
+    constructor(mockedResponses: ReadonlyArray<MockedResponse<Record<string, any>, Record<string, any>>>, options?: MockLinkOptions);
     addMockedResponse(mockedResponse: MockedResponse): void;
     request(operation: Operation): Observable<FetchResult> | null;
+    private getMockedResponses;
     private normalizeMockedResponse;
-    private normalizeVariableMatching;
 }
+/** @internal */
+export declare function stringifyMockedResponse(mockedResponse: MockedResponse): string;
 export interface MockApolloLink extends ApolloLink {
     operation?: Operation;
 }

package/testing/core/mocking/mockLink.js

@@ -1,20 +1,25 @@
 import { equal } from "@wry/equality";
-import { Observable } from "rxjs";
+import { Observable, throwError } from "rxjs";
 import { ApolloLink } from "@apollo/client/link/core";
-import { addTypenameToDocument, checkDocument, cloneDeep, getDefaultValues, getOperationDefinition, print, removeClientSetsFromDocument, removeDirectivesFromDocument, makeUniqueId, } from "@apollo/client/utilities";
+import { addTypenameToDocument, checkDocument, cloneDeep, getDefaultValues, getOperationDefinition, isDocumentNode, makeUniqueId, print, removeClientSetsFromDocument, removeDirectivesFromDocument, } from "@apollo/client/utilities";
 import { invariant } from "@apollo/client/utilities/invariant";
-function requestToKey(request) {
-    const queryString = request.query && print(addTypenameToDocument(request.query));
-    const requestKey = { query: queryString };
-    return JSON.stringify(requestKey);
+export function realisticDelay({ min = 20, max = 50, } = {}) {
+    invariant(max > min, 24);
+    return () => Math.floor(Math.random() * (max - min) + min);
 }
 export class MockLink extends ApolloLink {
     operation;
     showWarnings = true;
+    defaultDelay;
     mockedResponsesByKey = {};
+    static defaultOptions = {
+        delay: realisticDelay(),
+    };
     constructor(mockedResponses, options = {}) {
         super();
+        const defaultOptions = options.defaultOptions ?? MockLink.defaultOptions;
         this.showWarnings = options.showWarnings ?? true;
+        this.defaultDelay = defaultOptions?.delay ?? realisticDelay();
         if (mockedResponses) {
             mockedResponses.forEach((mockedResponse) => {
                 this.addMockedResponse(mockedResponse);
@@ -22,139 +27,135 @@ export class MockLink extends ApolloLink {
         }
     }
     addMockedResponse(mockedResponse) {
-        const normalizedMockedResponse = this.normalizeMockedResponse(mockedResponse);
-        const key = requestToKey(normalizedMockedResponse.request);
-        let mockedResponses = this.mockedResponsesByKey[key];
-        if (!mockedResponses) {
-            mockedResponses = [];
-            this.mockedResponsesByKey[key] = mockedResponses;
-        }
-        mockedResponses.push(normalizedMockedResponse);
+        validateMockedResponse(mockedResponse);
+        const normalized = this.normalizeMockedResponse(mockedResponse);
+        this.getMockedResponses(normalized.request).push(normalized);
     }
     request(operation) {
         this.operation = operation;
-        const key = requestToKey(operation);
         const unmatchedVars = [];
-        const requestVariables = operation.variables || {};
-        const mockedResponses = this.mockedResponsesByKey[key];
-        const responseIndex = mockedResponses ?
-            mockedResponses.findIndex((res, index) => {
-                const mockedResponseVars = res.request.variables || {};
-                if (equal(requestVariables, mockedResponseVars)) {
-                    return true;
+        const mocks = this.getMockedResponses(operation);
+        const index = mocks.findIndex((mock) => {
+            const { variables } = mock.request;
+            if (typeof variables === "function") {
+                const matched = variables(operation.variables);
+                if (!matched) {
+                    unmatchedVars.push(`<function ${variables.name}>`);
                 }
-                if (res.variableMatcher && res.variableMatcher(operation.variables)) {
-                    return true;
-                }
-                unmatchedVars.push(mockedResponseVars);
-                return false;
-            })
-            : -1;
-        const response = responseIndex >= 0 ? mockedResponses[responseIndex] : void 0;
-        // There have been platform- and engine-dependent differences with
-        // setInterval(fn, Infinity), so we pass 0 instead (but detect
-        // Infinity where we call observer.error or observer.next to pend
-        // indefinitely in those cases.)
-        const delay = response?.delay === Infinity ? 0 : response?.delay ?? 0;
-        let configError;
-        if (!response) {
-            configError = new Error(`No more mocked responses for the query: ${print(operation.query)}
-Expected variables: ${stringifyForDebugging(operation.variables)}
-${unmatchedVars.length > 0 ?
-                `
-Failed to match ${unmatchedVars.length} mock${unmatchedVars.length === 1 ? "" : "s"} for this query. The mocked response had the following variables:
-${unmatchedVars.map((d) => `  ${stringifyForDebugging(d)}`).join("\n")}
-`
-                : ""}`);
+                return matched;
+            }
+            const withDefaults = mock.variablesWithDefaults;
+            if (equal(withDefaults, operation.variables)) {
+                return true;
+            }
+            unmatchedVars.push(
+            // Include default variables from the query in unmatched variables
+            // output
+            Object.keys(withDefaults).length > 0 ?
+                withDefaults
+                : variables || "<undefined>");
+            return false;
+        });
+        const matched = index >= 0 ? mocks[index] : void 0;
+        if (!matched) {
+            const message = getErrorMessage(operation, unmatchedVars);
             if (this.showWarnings) {
-                console.warn(configError.message +
+                console.warn(message +
                     "\nThis typically indicates a configuration error in your mocks " +
                     "setup, usually due to a typo or mismatched variable.");
             }
+            return throwError(() => new Error(message));
+        }
+        if (matched.maxUsageCount > 1) {
+            matched.maxUsageCount--;
         }
         else {
-            if (response.maxUsageCount && response.maxUsageCount > 1) {
-                response.maxUsageCount--;
-            }
-            else {
-                mockedResponses.splice(responseIndex, 1);
-            }
-            const { newData } = response;
-            if (newData) {
-                response.result = newData(operation.variables);
-                mockedResponses.push(response);
-            }
-            if (!response.result && !response.error && response.delay !== Infinity) {
-                configError = new Error(`Mocked response should contain either \`result\`, \`error\` or a \`delay\` of \`Infinity\`: ${key}`);
-            }
+            mocks.splice(index, 1);
+        }
+        const delay = typeof matched.delay === "function" ?
+            matched.delay(operation)
+            : matched.delay;
+        if (!matched.result && !matched.error && delay !== Infinity) {
+            return throwError(() => new Error(`Mocked response should contain either \`result\`, \`error\` or a \`delay\` of \`Infinity\`:\n${stringifyMockedResponse(matched.original)}`));
+        }
+        if (matched.delay === Infinity) {
+            return new Observable();
         }
         return new Observable((observer) => {
             const timer = setTimeout(() => {
-                if (configError) {
-                    try {
-                        // The onError function can return false to indicate that
-                        // configError need not be passed to observer.error. For
-                        // example, the default implementation of onError calls
-                        // observer.error(configError) and then returns false to
-                        // prevent this extra (harmless) observer.error call.
-                        if (this.onError(configError, observer) !== false) {
-                            throw configError;
-                        }
-                    }
-                    catch (error) {
-                        observer.error(error);
-                    }
+                if (matched.error) {
+                    return observer.error(matched.error);
                 }
-                else if (response && response.delay !== Infinity) {
-                    if (response.error) {
-                        observer.error(response.error);
-                    }
-                    else {
-                        if (response.result) {
-                            observer.next(typeof response.result === "function" ?
-                                response.result(operation.variables)
-                                : response.result);
-                        }
-                        observer.complete();
-                    }
+                if (matched.result) {
+                    observer.next(typeof matched.result === "function" ?
+                        matched.result(operation.variables)
+                        : matched.result);
                 }
+                observer.complete();
             }, delay);
             return () => {
                 clearTimeout(timer);
             };
         });
     }
-    normalizeMockedResponse(mockedResponse) {
-        const newMockedResponse = cloneDeep(mockedResponse);
-        const queryWithoutClientOnlyDirectives = removeDirectivesFromDocument([{ name: "connection" }, { name: "nonreactive" }, { name: "unmask" }], checkDocument(newMockedResponse.request.query));
-        invariant(queryWithoutClientOnlyDirectives, 23);
-        newMockedResponse.request.query = queryWithoutClientOnlyDirectives;
-        const query = removeClientSetsFromDocument(newMockedResponse.request.query);
-        if (query) {
-            newMockedResponse.request.query = query;
+    getMockedResponses(request) {
+        const key = JSON.stringify({
+            query: print(addTypenameToDocument(request.query)),
+        });
+        let mockedResponses = this.mockedResponsesByKey[key];
+        if (!mockedResponses) {
+            mockedResponses = this.mockedResponsesByKey[key] = [];
         }
-        mockedResponse.maxUsageCount = mockedResponse.maxUsageCount ?? 1;
-        invariant(mockedResponse.maxUsageCount > 0, 24, mockedResponse.maxUsageCount);
-        this.normalizeVariableMatching(newMockedResponse);
-        return newMockedResponse;
+        return mockedResponses;
+    }
+    normalizeMockedResponse(mockedResponse) {
+        const { request } = mockedResponse;
+        const response = cloneDeep(mockedResponse);
+        response.original = mockedResponse;
+        response.request.query = getServerQuery(request.query);
+        response.maxUsageCount ??= 1;
+        response.variablesWithDefaults = {
+            ...getDefaultValues(getOperationDefinition(request.query)),
+            ...request.variables,
+        };
+        response.delay ??= this.defaultDelay;
+        return response;
     }
-    normalizeVariableMatching(mockedResponse) {
-        const request = mockedResponse.request;
-        if (mockedResponse.variableMatcher && request.variables) {
-            throw new Error("Mocked response should contain either variableMatcher or request.variables");
+}
+function getErrorMessage(operation, unmatchedVars) {
+    return `No more mocked responses for the query:
+${print(operation.query)}
+
+Request variables: ${stringifyForDebugging(operation.variables)}
+${unmatchedVars.length > 0 ?
+        `
+Failed to match variables against ${unmatchedVars.length} mock${unmatchedVars.length === 1 ? "" : "s"} for this query. The available mocks had the following variables:
+${unmatchedVars.map((d) => `  ${stringifyForDebugging(d)}`).join("\n")}
+`
+        : ""}`;
+}
+function getServerQuery(query) {
+    const queryWithoutClientOnlyDirectives = removeDirectivesFromDocument([{ name: "connection" }, { name: "nonreactive" }, { name: "unmask" }], query);
+    invariant(queryWithoutClientOnlyDirectives, 25);
+    const serverQuery = removeClientSetsFromDocument(queryWithoutClientOnlyDirectives);
+    invariant(serverQuery, 26);
+    return serverQuery;
+}
+function validateMockedResponse(mock) {
+    checkDocument(mock.request.query);
+    invariant((mock.maxUsageCount ?? 1) > 0, 27, mock.maxUsageCount);
+}
+/** @internal */
+export function stringifyMockedResponse(mockedResponse) {
+    return JSON.stringify(mockedResponse, (_, value) => {
+        if (isDocumentNode(value)) {
+            return print(value);
         }
-        if (!mockedResponse.variableMatcher) {
-            request.variables = {
-                ...getDefaultValues(getOperationDefinition(request.query)),
-                ...request.variables,
-            };
-            mockedResponse.variableMatcher = (vars) => {
-                const requestVariables = vars || {};
-                const mockedResponseVariables = request.variables || {};
-                return equal(requestVariables, mockedResponseVariables);
-            };
+        if (typeof value === "function") {
+            return "<function>";
         }
-    }
+        return value;
+    }, 2);
 }
 // Pass in multiple mocked responses, so that you can test flows that end up
 // making multiple queries to the server.
@@ -166,6 +167,9 @@ export function mockSingleLink(...mockedResponses) {
 // future. This is not added to the primary stringifyForDisplay helper since it
 // is used for the cache and other purposes. We need this for debuggging only.
 function stringifyForDebugging(value, space = 0) {
+    if (typeof value === "string") {
+        return value;
+    }
     const undefId = makeUniqueId("undefined");
     const nanId = makeUniqueId("NaN");
     return JSON.stringify(value, (_, value) => {