@apollo/client 4.0.0-alpha.5 → 4.0.0-alpha.6

package/__cjs/core/QueryManager.d.cts

@@ -9,7 +9,7 @@ import type { DefaultOptions } from "./ApolloClient.cjs";
 import type { LocalState } from "./LocalState.cjs";
 import { NetworkStatus } from "./networkStatus.cjs";
 import { ObservableQuery } from "./ObservableQuery.cjs";
-import type { ApolloQueryResult, DefaultContext, InternalRefetchQueriesInclude, InternalRefetchQueriesMap, InternalRefetchQueriesOptions, MutateResult, MutationUpdaterFunction, OnQueryUpdated, OperationVariables, SubscribeResult } from "./types.cjs";
+import type { ApolloQueryResult, DefaultContext, InternalRefetchQueriesInclude, InternalRefetchQueriesMap, InternalRefetchQueriesOptions, MutateResult, MutationUpdaterFunction, OnQueryUpdated, OperationVariables, QueryResult, SubscribeResult } from "./types.cjs";
 import type { ErrorPolicy, MutationFetchPolicy, MutationOptions, QueryOptions, SubscriptionOptions, WatchQueryFetchPolicy, WatchQueryOptions } from "./watchQueryOptions.cjs";
 interface MutationStoreValue {
     mutation: DocumentNode;
@@ -117,13 +117,13 @@ export declare class QueryManager {
         update?: MutationUpdaterFunction<TData, TVariables, TContext, TCache>;
         keepRootFields?: boolean;
     }): boolean;
-    fetchQuery<TData, TVars extends OperationVariables>(queryId: string, options: WatchQueryOptions<TVars, TData>, networkStatus?: NetworkStatus): Promise<ApolloQueryResult<TData>>;
+    fetchQuery<TData, TVars extends OperationVariables>(queryId: string, options: WatchQueryOptions<TVars, TData>, networkStatus?: NetworkStatus): Promise<QueryResult<TData>>;
     transform(document: DocumentNode): DocumentNode;
     private transformCache;
     getDocumentInfo(document: DocumentNode): TransformCacheEntry;
     private getVariables;
     watchQuery<T, TVariables extends OperationVariables = OperationVariables>(options: WatchQueryOptions<TVariables, T>): ObservableQuery<T, TVariables>;
-    query<TData, TVars extends OperationVariables = OperationVariables>(options: QueryOptions<TVars, TData>, queryId?: string): Promise<ApolloQueryResult<MaybeMasked<TData>>>;
+    query<TData, TVars extends OperationVariables = OperationVariables>(options: QueryOptions<TVars, TData>, queryId?: string): Promise<QueryResult<MaybeMasked<TData>>>;
     private queryIdCounter;
     generateQueryId(): string;
     private requestIdCounter;
@@ -132,7 +132,7 @@ export declare class QueryManager {
     generateMutationId(): string;
     clearStore(options?: Cache.ResetOptions): Promise<void>;
     getObservableQueries(include?: InternalRefetchQueriesInclude): Map<string, ObservableQuery<any, OperationVariables>>;
-    reFetchObservableQueries(includeStandby?: boolean): Promise<ApolloQueryResult<any>[]>;
+    reFetchObservableQueries(includeStandby?: boolean): Promise<QueryResult<any>[]>;
     setObservableQuery(observableQuery: ObservableQuery<any, any>): void;
     startGraphQLSubscription<TData = unknown>(options: SubscriptionOptions): Observable<SubscribeResult<TData>>;
     stopQuery(queryId: string): void;

package/__cjs/core/types.d.cts

@@ -61,7 +61,7 @@ export interface RefetchQueriesOptions<TCache extends ApolloCache, TResult> {
     optimistic?: boolean;
     onQueryUpdated?: OnQueryUpdated<TResult> | null;
 }
-export type RefetchQueriesPromiseResults<TResult> = IsStrictlyAny<TResult> extends true ? any[] : TResult extends boolean ? ApolloQueryResult<any>[] : TResult extends PromiseLike<infer U> ? U[] : TResult[];
+export type RefetchQueriesPromiseResults<TResult> = IsStrictlyAny<TResult> extends true ? any[] : TResult extends boolean ? QueryResult<any>[] : TResult extends PromiseLike<infer U> ? U[] : TResult[];
 export interface RefetchQueriesResult<TResult> extends Promise<RefetchQueriesPromiseResults<TResult>> {
     queries: ObservableQuery<any>[];
     results: InternalRefetchQueriesResult<TResult>[];
@@ -70,7 +70,7 @@ export interface InternalRefetchQueriesOptions<TCache extends ApolloCache, TResu
     include?: InternalRefetchQueriesInclude;
     removeOptimistic?: string;
 }
-export type InternalRefetchQueriesResult<TResult> = TResult extends boolean ? Promise<ApolloQueryResult<any>> : TResult;
+export type InternalRefetchQueriesResult<TResult> = TResult extends boolean ? Promise<QueryResult<any>> : TResult;
 export type InternalRefetchQueriesMap<TResult> = Map<ObservableQuery<any>, InternalRefetchQueriesResult<TResult>>;
 export type { QueryOptions as PureQueryOptions };
 export type OperationVariables = Record<string, any>;
@@ -149,4 +149,26 @@ export interface SubscribeResult<TData = unknown> {
     */
     extensions?: Record<string, unknown>;
 }
+export interface QueryResult<TData = unknown> {
+    /**
+    * An object containing the result of your GraphQL query after it completes.
+    * 
+    * This value might be `undefined` if a query results in one or more errors (depending on the query's `errorPolicy`).
+    * 
+    * @docGroup
+    * 
+    * 1. Operation data
+    */
+    data: TData | undefined;
+    /**
+    * If the query 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/).
+    * 
+    * @docGroup
+    * 
+    * 1. Operation data
+    */
+    error?: ErrorLike;
+}
 //# sourceMappingURL=types.d.cts.map

package/__cjs/errors/CombinedGraphQLErrors.cjs

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CombinedGraphQLErrors = void 0;
+const utilities_1 = require("@apollo/client/utilities");
 /**
  * Represents the combined list of GraphQL errors returned from the server in a
  * GraphQL response.
@@ -10,9 +11,15 @@ class CombinedGraphQLErrors extends Error {
      * The raw list of GraphQL errors returned in a GraphQL response.
      */
     errors;
-    constructor(errors) {
+    /**
+     * Partial data returned in the GraphQL response.
+     */
+    data;
+    constructor(result) {
+        const errors = (0, utilities_1.getGraphQLErrorsFromResult)(result);
         super(formatMessage(errors));
         this.errors = errors;
+        this.data = result.data;
         this.name = "CombinedGraphQLErrors";
         Object.setPrototypeOf(this, CombinedGraphQLErrors.prototype);
     }

package/__cjs/errors/CombinedGraphQLErrors.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"CombinedGraphQLErrors.cjs","sources":["../../../src/errors/CombinedGraphQLErrors.ts"],"sourcesContent":["import type { GraphQLFormattedError } from \"graphql\";\n\n/**\n * Represents the combined list of GraphQL errors returned from the server in a\n * GraphQL response.\n */\nexport class CombinedGraphQLErrors extends Error {\n  /**\n   * The raw list of GraphQL errors returned in a GraphQL response.\n   */\n  errors: ReadonlyArray<GraphQLFormattedError>;\n\n  constructor(\n    errors: Array<GraphQLFormattedError> | ReadonlyArray<GraphQLFormattedError>\n  ) {\n    super(formatMessage(errors));\n    this.errors = errors;\n    this.name = \"CombinedGraphQLErrors\";\n\n    Object.setPrototypeOf(this, CombinedGraphQLErrors.prototype);\n  }\n}\n\nfunction formatMessage(\n  errors: Array<GraphQLFormattedError> | ReadonlyArray<GraphQLFormattedError>\n) {\n  const messageList = errors\n    // Handle non-spec-compliant servers: See #1185\n    .filter((e) => e)\n    .map((e) => `- ${e.message}`)\n    .join(\"\\n\");\n\n  return `The GraphQL server returned with errors:\n${messageList}`;\n}\n"],"names":[],"mappings":";;;AAEA,CAAA,CAAA;;;CAGA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAA2C,CAA3C,CAAA,CAAA,CAAA,EAAA;IACE,CAAF,CAAA;;KAEA,CAAA;IACE,CAAF,CAAA,CAAA,CAAA,CAAA,CAAQ;IAEN,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACI,CADJ,CAAA,CAAA,CAAA,CAAA,CAC+E,EAD/E;QAGI,CAAJ,CAAA,CAAA,CAAA,CAAS,CAAC,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuB,CAAC,CAAxB,CAAA,CAAA,CAAA,CAAA,CAA8B,CAAC,CAAC;QAC5B,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,EAAA,EAAkB,CAAlB,CAAA,CAAA,CAAA,CAAA,CAAwB;QACpB,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,EAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuC;QAEnC,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAC,CAA1B,CAAA,CAAA,CAA8B,EAAE,CAAhC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqD,CAAC,CAAtD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA+D,CAAC;IAC9D;AACF;AAfA,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,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAiBA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACE,CADF,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA;IAGE,CAAF,CAAA,CAAA,CAAA,EAAQ,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAsB,CAAtB,CAAA,CAAA,CAAA,CAAA;QACI,CAAJ,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA;QACA,CAAK,CAAL,CAAA,CAAA,CAAA,CAAA,CAAW,CAAC,CAAC,CAAC,EAAE,CAAhB,EAAmB,CAAC;QACpB,CAAK,CAAL,CAAA,CAAQ,CAAC,CAAC,CAAC,EAAE,CAAb,EAAgB,CAAhB,EAAA,CAAA,CAAqB,CAAC,CAAC,CAAvB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8B,CAA9B,CAAgC;QAChC,CAAK,CAAL,CAAA,CAAA,CAAS,CAAC,CAAV,CAAA,CAAA,CAAc,CAAC;IAEb,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AACA,CAAA,CAAE,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAa,CAAb,CAAe;AACf;"}
+{"version":3,"file":"CombinedGraphQLErrors.cjs","sources":["../../../src/errors/CombinedGraphQLErrors.ts"],"sourcesContent":["import type { GraphQLFormattedError } from \"graphql\";\n\nimport type { FetchResult } from \"@apollo/client/core\";\nimport { getGraphQLErrorsFromResult } from \"@apollo/client/utilities\";\n\n/**\n * Represents the combined list of GraphQL errors returned from the server in a\n * GraphQL response.\n */\nexport class CombinedGraphQLErrors extends Error {\n  /**\n   * The raw list of GraphQL errors returned in a GraphQL response.\n   */\n  readonly errors: ReadonlyArray<GraphQLFormattedError>;\n\n  /**\n   * Partial data returned in the GraphQL response.\n   */\n  readonly data: Record<string, unknown> | null | undefined;\n\n  constructor(result: FetchResult<unknown>) {\n    const errors = getGraphQLErrorsFromResult(result);\n\n    super(formatMessage(errors));\n    this.errors = errors;\n    this.data = result.data as Record<string, unknown>;\n    this.name = \"CombinedGraphQLErrors\";\n\n    Object.setPrototypeOf(this, CombinedGraphQLErrors.prototype);\n  }\n}\n\nfunction formatMessage(\n  errors: Array<GraphQLFormattedError> | ReadonlyArray<GraphQLFormattedError>\n) {\n  const messageList = errors\n    // Handle non-spec-compliant servers: See #1185\n    .filter((e) => e)\n    .map((e) => `- ${e.message}`)\n    .join(\"\\n\");\n\n  return `The GraphQL server returned with errors:\n${messageList}`;\n}\n"],"names":[],"mappings":";;;AAGA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAEA,CAAA,CAAA;;;CAGA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAA2C,CAA3C,CAAA,CAAA,CAAA,EAAA;IACE,CAAF,CAAA;;KAEA,CAAA;IACW,CAAX,CAAA,CAAA,CAAA,CAAA,CAAiB;IAEf,CAAF,CAAA;;KAEA,CAAA;IACW,CAAX,CAAA,CAAA,CAAe;IAEb,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAc,CAAd,CAAA,CAAA,CAAA,CAAA,CAA0C,EAA1C;QACI,CAAJ,CAAA,CAAA,CAAA,EAAU,CAAV,CAAA,CAAA,CAAA,CAAA,EAAA,EAAmB,CAAnB,CAAA,EAAmB,CAAnB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6C,CAA7C,CAA8C,CAA9C,CAAA,CAAA,CAAA,CAAA,CAAoD,CAAC;QAEjD,CAAJ,CAAA,CAAA,CAAA,CAAS,CAAC,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuB,CAAC,CAAxB,CAAA,CAAA,CAAA,CAAA,CAA8B,CAAC,CAAC;QAC5B,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,EAAA,EAAkB,CAAlB,CAAA,CAAA,CAAA,CAAA,CAAwB;QACpB,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,EAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAsB,CAAC,CAAvB,CAAA,CAAA,CAAsD;QAClD,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,EAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuC;QAEnC,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAC,CAA1B,CAAA,CAAA,CAA8B,EAAE,CAAhC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqD,CAAC,CAAtD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA+D,CAAC;IAC9D;AACF;AArBA,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,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAuBA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACE,CADF,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA;IAGE,CAAF,CAAA,CAAA,CAAA,EAAQ,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAsB,CAAtB,CAAA,CAAA,CAAA,CAAA;QACI,CAAJ,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA;QACA,CAAK,CAAL,CAAA,CAAA,CAAA,CAAA,CAAW,CAAC,CAAC,CAAC,EAAE,CAAhB,EAAmB,CAAC;QACpB,CAAK,CAAL,CAAA,CAAQ,CAAC,CAAC,CAAC,EAAE,CAAb,EAAgB,CAAhB,EAAA,CAAA,CAAqB,CAAC,CAAC,CAAvB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8B,CAA9B,CAAgC;QAChC,CAAK,CAAL,CAAA,CAAA,CAAS,CAAC,CAAV,CAAA,CAAA,CAAc,CAAC;IAEb,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AACA,CAAA,CAAE,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAa,CAAb,CAAe;AACf;"}

package/__cjs/errors/CombinedGraphQLErrors.d.cts

@@ -1,4 +1,5 @@
 import type { GraphQLFormattedError } from "graphql";
+import type { FetchResult } from "@apollo/client/core";
 /**
  * Represents the combined list of GraphQL errors returned from the server in a
  * GraphQL response.
@@ -7,7 +8,11 @@ export declare class CombinedGraphQLErrors extends Error {
     /**
      * The raw list of GraphQL errors returned in a GraphQL response.
      */
-    errors: ReadonlyArray<GraphQLFormattedError>;
-    constructor(errors: Array<GraphQLFormattedError> | ReadonlyArray<GraphQLFormattedError>);
+    readonly errors: ReadonlyArray<GraphQLFormattedError>;
+    /**
+     * Partial data returned in the GraphQL response.
+     */
+    readonly data: Record<string, unknown> | null | undefined;
+    constructor(result: FetchResult<unknown>);
 }
 //# sourceMappingURL=CombinedGraphQLErrors.d.cts.map