@apollo/client 4.0.0-alpha.2 → 4.0.0-alpha.20

package/core/ApolloClient.d.ts

@@ -1,17 +1,14 @@
-import type { DocumentNode, FormattedExecutionResult } from "graphql";
+import type { FormattedExecutionResult } from "graphql";
 import type { Observable } from "rxjs";
 import type { ApolloCache, DataProxy, Reference } from "@apollo/client/cache";
 import type { WatchFragmentOptions, WatchFragmentResult } from "@apollo/client/cache";
-import type { FetchResult, GraphQLRequest } from "@apollo/client/link/core";
-import { ApolloLink } from "@apollo/client/link/core";
-import type { UriFunction } from "@apollo/client/link/http";
+import type { ApolloLink, GraphQLRequest } from "@apollo/client/link";
+import type { LocalState } from "@apollo/client/local-state";
 import type { MaybeMasked, Unmasked } from "@apollo/client/masking";
 import type { DocumentTransform } from "@apollo/client/utilities";
-import { mergeOptions } from "@apollo/client/utilities";
 import { getApolloClientMemoryInternals } from "@apollo/client/utilities/internal";
-import type { FragmentMatcher } from "./LocalState.js";
 import type { ObservableQuery } from "./ObservableQuery.js";
-import type { ApolloQueryResult, DefaultContext, OperationVariables, RefetchQueriesInclude, RefetchQueriesOptions, RefetchQueriesResult, Resolvers } from "./types.js";
+import type { DefaultContext, MutateResult, OperationVariables, QueryResult, RefetchQueriesInclude, RefetchQueriesOptions, RefetchQueriesResult, SubscribeResult, SubscriptionObservable } from "./types.js";
 import type { MutationOptions, QueryOptions, SubscriptionOptions, WatchQueryOptions } from "./watchQueryOptions.js";
 export interface DefaultOptions {
     watchQuery?: Partial<WatchQueryOptions<any, any>>;
@@ -33,25 +30,12 @@ interface DevtoolsOptions {
     name?: string;
 }
 export interface ApolloClientOptions {
-    /**
-     * The URI of the GraphQL endpoint that Apollo Client will communicate with.
-     *
-     * One of `uri` or `link` is **required**. If you provide both, `link` takes precedence.
-     */
-    uri?: string | UriFunction;
-    credentials?: string;
-    /**
-     * An object representing headers to include in every HTTP request, such as `{Authorization: 'Bearer 1234'}`
-     *
-     * This value will be ignored when using the `link` option.
-     */
-    headers?: Record<string, string>;
     /**
      * You can provide an `ApolloLink` instance to serve as Apollo Client's network layer. For more information, see [Advanced HTTP networking](https://www.apollographql.com/docs/react/networking/advanced-http-networking/).
      *
      * One of `uri` or `link` is **required**. If you provide both, `link` takes precedence.
      */
-    link?: ApolloLink;
+    link: ApolloLink;
     /**
      * The cache that Apollo Client should use to store query results locally. The recommended cache is `InMemoryCache`, which is provided by the `@apollo/client` package.
      *
@@ -96,9 +80,7 @@ export interface ApolloClientOptions {
      * @defaultValue `false`
      */
     assumeImmutableResults?: boolean;
-    resolvers?: Resolvers | Resolvers[];
-    typeDefs?: string | string[] | DocumentNode | DocumentNode[];
-    fragmentMatcher?: FragmentMatcher;
+    localState?: LocalState;
     /**
      * A custom name (e.g., `iOS`) that identifies this particular client among your set of clients. Apollo Server and Apollo Studio use this property as part of the [client awareness](https://www.apollographql.com/docs/apollo-server/monitoring/metrics#identifying-distinct-clients) feature.
      */
@@ -123,7 +105,6 @@ export interface ApolloClientOptions {
      */
     dataMasking?: boolean;
 }
-export { mergeOptions };
 /**
  * This is the primary Apollo Client class. It is used to send GraphQL documents (i.e. queries
  * and mutations) to a GraphQL spec-compliant server over an `ApolloLink` instance,
@@ -133,17 +114,27 @@ export { mergeOptions };
 export declare class ApolloClient implements DataProxy {
     link: ApolloLink;
     cache: ApolloCache;
-    disableNetworkFetches: boolean;
+    /**
+     * @deprecated `disableNetworkFetches` has been renamed to `prioritizeCacheValues`.
+     */
+    disableNetworkFetches: never;
+    set prioritizeCacheValues(value: boolean);
+    /**
+     * Whether to prioritize cache values over network results when `query` or `watchQuery` is called.
+     * This will essentially turn a `"network-only"` or `"cache-and-network"` fetchPolicy into a `"cache-first"` fetchPolicy,
+     * but without influencing the `fetchPolicy` of the created `ObservableQuery` long-term.
+     *
+     * This can e.g. be used to prioritize the cache during the first render after SSR.
+     */
+    get prioritizeCacheValues(): boolean;
     version: string;
     queryDeduplication: boolean;
     defaultOptions: DefaultOptions;
-    readonly typeDefs: ApolloClientOptions["typeDefs"];
     readonly devtoolsConfig: DevtoolsOptions;
     private queryManager;
     private devToolsHookCb?;
     private resetStoreCallbacks;
     private clearStoreCallbacks;
-    private localState;
     /**
      * Constructs an instance of `ApolloClient`.
      *
@@ -178,6 +169,12 @@ export declare class ApolloClient implements DataProxy {
      * default document transform.
      */
     get documentTransform(): DocumentTransform;
+    /**
+     * The configured `LocalState` instance used to enable the use of `@client`
+     * fields.
+     */
+    get localState(): LocalState | undefined;
+    set localState(localState: LocalState);
     /**
      * Call this method to terminate any active client processes, making it safe
      * to dispose of this `ApolloClient` instance.
@@ -212,7 +209,7 @@ export declare class ApolloClient implements DataProxy {
      * describe how this query should be treated e.g. whether it should hit the
      * server at all or just resolve from the cache, etc.
      */
-    query<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: QueryOptions<TVariables, TData>): Promise<ApolloQueryResult<MaybeMasked<TData>>>;
+    query<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: QueryOptions<TVariables, TData>): Promise<QueryResult<MaybeMasked<TData>>>;
     /**
      * This resolves a single mutation according to the options specified and returns a
      * Promise which is either resolved with the resulting data or rejected with an
@@ -221,12 +218,12 @@ export declare class ApolloClient implements DataProxy {
      *
      * It takes options as an object with the following keys and values:
      */
-    mutate<TData = unknown, TVariables extends OperationVariables = OperationVariables, TContext extends Record<string, any> = DefaultContext, TCache extends ApolloCache = ApolloCache>(options: MutationOptions<TData, TVariables, TContext>): Promise<FetchResult<MaybeMasked<TData>>>;
+    mutate<TData = unknown, TVariables extends OperationVariables = OperationVariables, TCache extends ApolloCache = ApolloCache>(options: MutationOptions<TData, TVariables, TCache>): Promise<MutateResult<MaybeMasked<TData>>>;
     /**
      * This subscribes to a graphql subscription according to the options specified and returns an
      * `Observable` which either emits received data or an error.
      */
-    subscribe<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: SubscriptionOptions<TVariables, TData>): Observable<FetchResult<MaybeMasked<TData>>>;
+    subscribe<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: SubscriptionOptions<TVariables, TData>): SubscriptionObservable<SubscribeResult<MaybeMasked<TData>>>;
     /**
      * Tries to read some data from the store in the shape of the provided
      * GraphQL query without making a network request. This method will start at
@@ -305,7 +302,7 @@ export declare class ApolloClient implements DataProxy {
      * re-execute any queries then you should make sure to stop watching any
      * active queries.
      */
-    resetStore(): Promise<ApolloQueryResult<any>[] | null>;
+    resetStore(): Promise<QueryResult<any>[] | null>;
     /**
      * Remove all data from the store. Unlike `resetStore`, `clearStore` will
      * not refetch any active queries.
@@ -335,7 +332,7 @@ export declare class ApolloClient implements DataProxy {
      * active queries.
      * Takes optional parameter `includeStandby` which will include queries in standby-mode when refetching.
      */
-    reFetchObservableQueries(includeStandby?: boolean): Promise<ApolloQueryResult<any>[]>;
+    reFetchObservableQueries(includeStandby?: boolean): Promise<QueryResult<any>[]>;
     /**
      * Refetches specified active queries. Similar to "reFetchObservableQueries()" but with a specific list of queries.
      *
@@ -347,7 +344,7 @@ export declare class ApolloClient implements DataProxy {
      * re-execute any queries then you should make sure to stop watching any
      * active queries.
      */
-    refetchQueries<TCache extends ApolloCache = ApolloCache, TResult = Promise<ApolloQueryResult<any>>>(options: RefetchQueriesOptions<TCache, TResult>): RefetchQueriesResult<TResult>;
+    refetchQueries<TCache extends ApolloCache = ApolloCache, TResult = Promise<QueryResult<any>>>(options: RefetchQueriesOptions<TCache, TResult>): RefetchQueriesResult<TResult>;
     /**
      * Get all currently active `ObservableQuery` objects, in a `Map` keyed by
      * query ID strings.
@@ -359,7 +356,7 @@ export declare class ApolloClient implements DataProxy {
      * by passing "all" instead of "active", or you can include just a subset of
      * active queries by passing an array of query names or DocumentNode objects.
      */
-    getObservableQueries(include?: RefetchQueriesInclude): Map<string, ObservableQuery<any>>;
+    getObservableQueries(include?: RefetchQueriesInclude): Set<ObservableQuery<any>>;
     /**
      * Exposes the cache's complete state, in a serializable format for later restoration.
      */
@@ -372,22 +369,6 @@ export declare class ApolloClient implements DataProxy {
      * and also (potentially) during hot reloads.
      */
     restore(serializedState: unknown): ApolloCache;
-    /**
-     * Add additional local resolvers.
-     */
-    addResolvers(resolvers: Resolvers | Resolvers[]): void;
-    /**
-     * Set (override existing) local resolvers.
-     */
-    setResolvers(resolvers: Resolvers | Resolvers[]): void;
-    /**
-     * Get all registered local resolvers.
-     */
-    getResolvers(): Resolvers;
-    /**
-     * Set a custom local state fragment matcher.
-     */
-    setLocalStateFragmentMatcher(fragmentMatcher: FragmentMatcher): void;
     /**
      * Define a new ApolloLink (or link chain) that Apollo Client will use.
      */
@@ -409,7 +390,6 @@ export declare class ApolloClient implements DataProxy {
      * ```json
      *{
      *  limits:     {
-     *    parser: 1000,
      *    canonicalStringify: 1000,
      *    print: 2000,
      *    'documentTransform.cache': 2000,
@@ -425,7 +405,6 @@ export declare class ApolloClient implements DataProxy {
      *    'inMemoryCache.executeSubSelectedArray': 5000
      *  },
      *  sizes: {
-     *    parser: 26,
      *    canonicalStringify: 4,
      *    print: 14,
      *    addTypenameDocumentTransform: [
@@ -475,4 +454,5 @@ export declare class ApolloClient implements DataProxy {
      */
     getMemoryInternals?: typeof getApolloClientMemoryInternals;
 }
+export {};
 //# sourceMappingURL=ApolloClient.d.ts.map

package/core/ApolloClient.js

@@ -1,19 +1,12 @@
+import { OperationTypeNode } from "graphql";
 import { map } from "rxjs";
-import { ApolloLink, execute } from "@apollo/client/link/core";
-import { HttpLink } from "@apollo/client/link/http";
-import { mergeOptions } from "@apollo/client/utilities";
+import { execute } from "@apollo/client/link";
 import { __DEV__ } from "@apollo/client/utilities/environment";
-import { getApolloClientMemoryInternals } from "@apollo/client/utilities/internal";
-import { invariant, newInvariantError, } from "@apollo/client/utilities/invariant";
+import { checkDocument, getApolloClientMemoryInternals, mergeOptions, } from "@apollo/client/utilities/internal";
+import { invariant } from "@apollo/client/utilities/invariant";
 import { version } from "../version.js";
-import { LocalState } from "./LocalState.js";
 import { QueryManager } from "./QueryManager.js";
 let hasSuggestedDevtools = false;
-// Though mergeOptions now resides in @apollo/client/utilities, it was
-// previously declared and exported from this module, and then reexported from
-// @apollo/client/core. Since we need to preserve that API anyway, the easiest
-// solution is to reexport mergeOptions where it was previously declared (here).
-export { mergeOptions };
 /**
  * This is the primary Apollo Client class. It is used to send GraphQL documents (i.e. queries
  * and mutations) to a GraphQL spec-compliant server over an `ApolloLink` instance,
@@ -23,17 +16,31 @@ export { mergeOptions };
 export class ApolloClient {
     link;
     cache;
+    /**
+     * @deprecated `disableNetworkFetches` has been renamed to `prioritizeCacheValues`.
+     */
     disableNetworkFetches;
+    set prioritizeCacheValues(value) {
+        this.queryManager.prioritizeCacheValues = value;
+    }
+    /**
+     * Whether to prioritize cache values over network results when `query` or `watchQuery` is called.
+     * This will essentially turn a `"network-only"` or `"cache-and-network"` fetchPolicy into a `"cache-first"` fetchPolicy,
+     * but without influencing the `fetchPolicy` of the created `ObservableQuery` long-term.
+     *
+     * This can e.g. be used to prioritize the cache during the first render after SSR.
+     */
+    get prioritizeCacheValues() {
+        return this.queryManager.prioritizeCacheValues;
+    }
     version;
     queryDeduplication;
     defaultOptions;
-    typeDefs;
     devtoolsConfig;
     queryManager;
     devToolsHookCb;
     resetStoreCallbacks = [];
     clearStoreCallbacks = [];
-    localState;
     /**
      * Constructs an instance of `ApolloClient`.
      *
@@ -61,25 +68,19 @@ export class ApolloClient {
      * ```
      */
     constructor(options) {
-        if (!options.cache) {
-            throw newInvariantError(62);
+        if (__DEV__) {
+            invariant(options.cache, 67);
+            invariant(options.link, 68);
         }
-        const { uri, credentials, headers, cache, documentTransform, ssrMode = false, ssrForceFetchDelay = 0, 
+        const { cache, documentTransform, ssrMode = false, ssrForceFetchDelay = 0, 
         // Expose the client instance as window.__APOLLO_CLIENT__ and call
         // onBroadcast in queryManager.broadcastQueries to enable browser
         // devtools, but disable them by default in production.
-        connectToDevTools, queryDeduplication = true, defaultOptions, defaultContext, assumeImmutableResults = cache.assumeImmutableResults, resolvers, typeDefs, fragmentMatcher, name: clientAwarenessName, version: clientAwarenessVersion, devtools, dataMasking, } = options;
-        let { link } = options;
-        if (!link) {
-            link =
-                uri ? new HttpLink({ uri, credentials, headers }) : ApolloLink.empty();
-        }
+        connectToDevTools, queryDeduplication = true, defaultOptions, defaultContext, assumeImmutableResults = cache.assumeImmutableResults, localState, name: clientAwarenessName, version: clientAwarenessVersion, devtools, dataMasking, link, } = options;
         this.link = link;
         this.cache = cache;
-        this.disableNetworkFetches = ssrMode || ssrForceFetchDelay > 0;
         this.queryDeduplication = queryDeduplication;
         this.defaultOptions = defaultOptions || {};
-        this.typeDefs = typeDefs;
         this.devtoolsConfig = {
             ...devtools,
             enabled: devtools?.enabled ?? connectToDevTools,
@@ -87,9 +88,6 @@ export class ApolloClient {
         if (this.devtoolsConfig.enabled === undefined) {
             this.devtoolsConfig.enabled = __DEV__;
         }
-        if (ssrForceFetchDelay) {
-            setTimeout(() => (this.disableNetworkFetches = false), ssrForceFetchDelay);
-        }
         this.watchQuery = this.watchQuery.bind(this);
         this.query = this.query.bind(this);
         this.mutate = this.mutate.bind(this);
@@ -97,15 +95,8 @@ export class ApolloClient {
         this.resetStore = this.resetStore.bind(this);
         this.reFetchObservableQueries = this.reFetchObservableQueries.bind(this);
         this.version = version;
-        this.localState = new LocalState({
-            cache,
-            client: this,
-            resolvers,
-            fragmentMatcher,
-        });
         this.queryManager = new QueryManager({
-            cache: this.cache,
-            link: this.link,
+            client: this,
             defaultOptions: this.defaultOptions,
             defaultContext,
             documentTransform,
@@ -116,7 +107,6 @@ export class ApolloClient {
                 name: clientAwarenessName,
                 version: clientAwarenessVersion,
             },
-            localState: this.localState,
             assumeImmutableResults,
             onBroadcast: this.devtoolsConfig.enabled ?
                 () => {
@@ -125,7 +115,14 @@ export class ApolloClient {
                     }
                 }
                 : void 0,
+            localState,
         });
+        this.prioritizeCacheValues = ssrMode || ssrForceFetchDelay > 0;
+        if (ssrForceFetchDelay) {
+            setTimeout(() => {
+                this.prioritizeCacheValues = false;
+            }, ssrForceFetchDelay);
+        }
         if (this.devtoolsConfig.enabled)
             this.connectToDevTools();
     }
@@ -179,6 +176,16 @@ export class ApolloClient {
     get documentTransform() {
         return this.queryManager.documentTransform;
     }
+    /**
+     * The configured `LocalState` instance used to enable the use of `@client`
+     * fields.
+     */
+    get localState() {
+        return this.queryManager.localState;
+    }
+    set localState(localState) {
+        this.queryManager.localState = localState;
+    }
     /**
      * Call this method to terminate any active client processes, making it safe
      * to dispose of this `ApolloClient` instance.
@@ -209,12 +216,6 @@ export class ApolloClient {
         if (this.defaultOptions.watchQuery) {
             options = mergeOptions(this.defaultOptions.watchQuery, options);
         }
-        // XXX Overwriting options is probably not the best way to do this long term...
-        if (this.disableNetworkFetches &&
-            (options.fetchPolicy === "network-only" ||
-                options.fetchPolicy === "cache-and-network")) {
-            options = { ...options, fetchPolicy: "cache-first" };
-        }
         return this.queryManager.watchQuery(options);
     }
     /**
@@ -230,9 +231,15 @@ export class ApolloClient {
         if (this.defaultOptions.query) {
             options = mergeOptions(this.defaultOptions.query, options);
         }
-        invariant(options.fetchPolicy !== "cache-and-network", 63);
-        if (this.disableNetworkFetches && options.fetchPolicy === "network-only") {
-            options = { ...options, fetchPolicy: "cache-first" };
+        if (__DEV__) {
+            invariant(options.fetchPolicy !== "cache-and-network", 69);
+            invariant(options.fetchPolicy !== "standby", 70);
+            invariant(options.query, 71);
+            invariant(options.query.kind === "Document", 72);
+            invariant(!options.returnPartialData, 73);
+            invariant(!options.pollInterval, 74);
+            invariant(!options.notifyOnNetworkStatusChange, 75);
+            checkDocument(options.query, OperationTypeNode.QUERY);
         }
         return this.queryManager.query(options);
     }
@@ -255,16 +262,18 @@ export class ApolloClient {
      * `Observable` which either emits received data or an error.
      */
     subscribe(options) {
-        const id = this.queryManager.generateQueryId();
-        return this.queryManager.startGraphQLSubscription(options).pipe(map((result) => ({
+        const cause = {};
+        const observable = this.queryManager.startGraphQLSubscription(options);
+        const mapped = observable.pipe(map((result) => ({
             ...result,
             data: this.queryManager.maskOperation({
                 document: options.query,
                 data: result.data,
                 fetchPolicy: options.fetchPolicy,
-                id,
+                cause,
             }),
         })));
+        return Object.assign(mapped, { restart: observable.restart });
     }
     /**
      * Tries to read some data from the store in the shape of the provided
@@ -351,7 +360,7 @@ export class ApolloClient {
         this.devToolsHookCb = cb;
     }
     __requestRaw(payload) {
-        return execute(this.link, payload);
+        return execute(this.link, payload, { client: this });
     }
     /**
      * Resets your entire store by clearing out your cache and then re-executing
@@ -423,7 +432,7 @@ export class ApolloClient {
      * Takes optional parameter `includeStandby` which will include queries in standby-mode when refetching.
      */
     reFetchObservableQueries(includeStandby) {
-        return this.queryManager.reFetchObservableQueries(includeStandby);
+        return this.queryManager.refetchObservableQueries(includeStandby);
     }
     /**
      * Refetches specified active queries. Similar to "reFetchObservableQueries()" but with a specific list of queries.
@@ -453,7 +462,7 @@ export class ApolloClient {
         // result.queries and result.results instead, you shouldn't have to worry
         // about preventing uncaught rejections for the Promise.all result.
         result.catch((error) => {
-            __DEV__ && invariant.debug(64, error);
+            __DEV__ && invariant.debug(76, error);
         });
         return result;
     }
@@ -487,35 +496,11 @@ export class ApolloClient {
     restore(serializedState) {
         return this.cache.restore(serializedState);
     }
-    /**
-     * Add additional local resolvers.
-     */
-    addResolvers(resolvers) {
-        this.localState.addResolvers(resolvers);
-    }
-    /**
-     * Set (override existing) local resolvers.
-     */
-    setResolvers(resolvers) {
-        this.localState.setResolvers(resolvers);
-    }
-    /**
-     * Get all registered local resolvers.
-     */
-    getResolvers() {
-        return this.localState.getResolvers();
-    }
-    /**
-     * Set a custom local state fragment matcher.
-     */
-    setLocalStateFragmentMatcher(fragmentMatcher) {
-        this.localState.setFragmentMatcher(fragmentMatcher);
-    }
     /**
      * Define a new ApolloLink (or link chain) that Apollo Client will use.
      */
     setLink(newLink) {
-        this.link = this.queryManager.link = newLink;
+        this.link = newLink;
     }
     get defaultContext() {
         return this.queryManager.defaultContext;
@@ -536,7 +521,6 @@ export class ApolloClient {
      * ```json
      *{
      *  limits:     {
-     *    parser: 1000,
      *    canonicalStringify: 1000,
      *    print: 2000,
      *    'documentTransform.cache': 2000,
@@ -552,7 +536,6 @@ export class ApolloClient {
      *    'inMemoryCache.executeSubSelectedArray': 5000
      *  },
      *  sizes: {
-     *    parser: 26,
      *    canonicalStringify: 4,
      *    print: 14,
      *    addTypenameDocumentTransform: [