@apollo/client 4.0.0-alpha.8 → 4.0.0-rc.0

package/__cjs/core/ApolloClient.d.cts

@@ -1,17 +1,15 @@
-import type { DocumentNode, 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 { GraphQLRequest } from "@apollo/client/link/core";
-import { ApolloLink } from "@apollo/client/link/core";
-import type { UriFunction } from "@apollo/client/link/http";
+import type { Incremental } from "@apollo/client/incremental";
+import type { ApolloLink, FetchResult, GraphQLRequest } from "@apollo/client/link";
+import type { ClientAwarenessLink } from "@apollo/client/link/client-awareness";
+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.cjs";
 import type { ObservableQuery } from "./ObservableQuery.cjs";
-import type { DefaultContext, MutateResult, OperationVariables, QueryResult, RefetchQueriesInclude, RefetchQueriesOptions, RefetchQueriesResult, Resolvers, SubscribeResult } from "./types.cjs";
+import type { DefaultContext, MutateResult, OperationVariables, QueryResult, RefetchQueriesInclude, RefetchQueriesOptions, RefetchQueriesResult, SubscribeResult, SubscriptionObservable } from "./types.cjs";
 import type { MutationOptions, QueryOptions, SubscriptionOptions, WatchQueryOptions } from "./watchQueryOptions.cjs";
 export interface DefaultOptions {
     watchQuery?: Partial<WatchQueryOptions<any, any>>;
@@ -33,25 +31,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,19 +81,15 @@ 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.
-     */
-    name?: string;
+    *
+    */
+    clientAwareness?: ClientAwarenessLink.ClientAwarenessOptions;
     /**
-     * A custom version that identifies the current version of this particular client (e.g., `1.2`). 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.
-     *
-     * This is **not** the version of Apollo Client that you are using, but rather any version string that helps you differentiate between versions of your client.
-     */
-    version?: string;
+    *
+    */
+    enhancedClientAwareness?: ClientAwarenessLink.EnhancedClientAwarenessOptions;
     documentTransform?: DocumentTransform;
     /**
      * Configuration used by the [Apollo Client Devtools extension](https://www.apollographql.com/docs/react/development-testing/developer-tooling/#apollo-client-devtools) for this client.
@@ -122,8 +103,12 @@ export interface ApolloClientOptions {
      * @defaultValue false
      */
     dataMasking?: boolean;
+    /**
+     * Determines the strategy used to parse incremental chunks from `@defer`
+     * queries.
+     */
+    incrementalHandler?: Incremental.Handler<any>;
 }
-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,
@@ -149,13 +134,11 @@ export declare class ApolloClient implements DataProxy {
     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`.
      *
@@ -190,6 +173,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.
@@ -233,12 +222,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<MutateResult<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<SubscribeResult<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
@@ -300,7 +289,7 @@ export declare class ApolloClient implements DataProxy {
      */
     writeFragment<TData = unknown, TVariables = OperationVariables>(options: DataProxy.WriteFragmentOptions<TData, TVariables>): Reference | undefined;
     __actionHookForDevTools(cb: () => any): void;
-    __requestRaw(payload: GraphQLRequest): Observable<FormattedExecutionResult>;
+    __requestRaw(payload: GraphQLRequest): Observable<FetchResult<unknown>>;
     /**
      * Resets your entire store by clearing out your cache and then re-executing
      * all of your active queries. This makes it so that you may guarantee that
@@ -371,7 +360,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.
      */
@@ -384,22 +373,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.
      */
@@ -485,4 +458,5 @@ export declare class ApolloClient implements DataProxy {
      */
     getMemoryInternals?: typeof getApolloClientMemoryInternals;
 }
+export {};
 //# sourceMappingURL=ApolloClient.d.cts.map