@apollo/client 4.1.4 → 4.2.0-alpha.0

package/__cjs/core/ApolloClient.d.cts

@@ -267,7 +267,25 @@ export declare namespace ApolloClient {
         */
         fetchPolicy?: FetchPolicy;
     } & VariablesOption<NoInfer<TVariables>>;
-    interface QueryResult<TData = unknown> {
+    type QueryResult<TData = unknown, TErrorPolicy extends ErrorPolicy | undefined = undefined> = TErrorPolicy extends "none" ? {
+        /**
+        * 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;
+        /**
+        * A single ErrorLike object describing the error that occurred during the latest
+        * query execution.
+        * 
+        * For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
+        * 
+        * @docGroup 1. Operation data
+        */
+        error?: never;
+    } : TErrorPolicy extends "all" ? {
         /**
         * An object containing the result of your GraphQL query after it completes.
         * 
@@ -285,7 +303,43 @@ export declare namespace ApolloClient {
         * @docGroup 1. Operation data
         */
         error?: ErrorLike;
-    }
+    } : TErrorPolicy extends "ignore" ? {
+        /**
+        * 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;
+        /**
+        * A single ErrorLike object describing the error that occurred during the latest
+        * query execution.
+        * 
+        * For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
+        * 
+        * @docGroup 1. Operation data
+        */
+        error?: never;
+    } : {
+        /**
+        * 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;
+        /**
+        * A single ErrorLike object describing the error that occurred during the latest
+        * query execution.
+        * 
+        * For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
+        * 
+        * @docGroup 1. Operation data
+        */
+        error?: ErrorLike;
+    };
     /**
      * Options object for the `client.refetchQueries` method.
      */
@@ -811,7 +865,31 @@ export declare class ApolloClient {
      * 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: ApolloClient.QueryOptions<TData, TVariables>): Promise<ApolloClient.QueryResult<MaybeMasked<TData>>>;
+    query<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.QueryOptions<TData, TVariables> & {
+        errorPolicy: "all";
+    }): Promise<ApolloClient.QueryResult<MaybeMasked<TData>, "all">>;
+    /**
+    * This resolves a single query according to the options specified and
+    * returns a `Promise` which is either resolved with the resulting data
+    * or rejected with an error.
+    * 
+    * @param options - An object of type `QueryOptions` that allows us to
+    * 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: ApolloClient.QueryOptions<TData, TVariables> & {
+        errorPolicy: "ignore";
+    }): Promise<ApolloClient.QueryResult<MaybeMasked<TData>, "ignore">>;
+    /**
+    * This resolves a single query according to the options specified and
+    * returns a `Promise` which is either resolved with the resulting data
+    * or rejected with an error.
+    * 
+    * @param options - An object of type `QueryOptions` that allows us to
+    * 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: ApolloClient.QueryOptions<TData, TVariables>): Promise<ApolloClient.QueryResult<MaybeMasked<TData>, "none">>;
     /**
      * 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

package/__cjs/react/internal/cache/QueryReference.d.cts

@@ -96,8 +96,14 @@ export declare class InternalQueryReference<TData = unknown, TStates extends Dat
     didChangeOptions(watchQueryOptions: ObservedOptions): boolean;
     applyOptions(watchQueryOptions: ObservedOptions): QueryRefPromise<TData, TStates>;
     listen(listener: Listener<TData, TStates>): () => void;
-    refetch(variables: OperationVariables | undefined): Promise<ApolloClient.QueryResult<TData>>;
-    fetchMore(options: ObservableQuery.FetchMoreOptions<TData, any, any, any>): Promise<ApolloClient.QueryResult<TData>>;
+    refetch(variables: OperationVariables | undefined): Promise<{
+        data: TData | undefined;
+        error?: import("@apollo/client").ErrorLike;
+    }>;
+    fetchMore(options: ObservableQuery.FetchMoreOptions<TData, any, any, any>): Promise<{
+        data: TData | undefined;
+        error?: import("@apollo/client").ErrorLike;
+    }>;
     private dispose;
     private onDispose;
     private handleNext;

package/__cjs/utilities/internal/toQueryResult.d.cts

@@ -1,8 +1,11 @@
-import type { ApolloClient, ObservableQuery } from "@apollo/client";
+import type { ObservableQuery } from "@apollo/client";
 /**
 * @internal
 * 
 * @deprecated This is an internal API and should not be used directly. This can be removed or changed at any time.
 */
-export declare function toQueryResult<TData = unknown>(value: ObservableQuery.Result<TData>): ApolloClient.QueryResult<TData>;
+export declare function toQueryResult<TData = unknown>(value: ObservableQuery.Result<TData>): {
+    data: TData | undefined;
+    error?: import("@apollo/client").ErrorLike;
+};
 //# sourceMappingURL=toQueryResult.d.cts.map

package/__cjs/version.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.build = exports.version = void 0;
-exports.version = "4.1.4";
+exports.version = "4.2.0-alpha.0";
 exports.build = "cjs";
 //# sourceMappingURL=version.cjs.map

package/__cjs/version.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.cjs","sources":["../../src/version.ts"],"sourcesContent":["export const version = \"local\" as string;\nexport const build = \"source\" as \"source\" | \"esm\" | \"cjs\";\n"],"names":[],"mappings":";;;AAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,SAAwC;AAC3B,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAa,CAAb,CAAA,CAAA,CAAA,EAAA,OAAyD;"}
+{"version":3,"file":"version.cjs","sources":["../../src/version.ts"],"sourcesContent":["export const version = \"local\" as string;\nexport const build = \"source\" as \"source\" | \"esm\" | \"cjs\";\n"],"names":[],"mappings":";;;AAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,iBAAwC;AAC3B,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAa,CAAb,CAAA,CAAA,CAAA,EAAA,OAAyD;"}

package/core/ApolloClient.d.ts

@@ -267,7 +267,25 @@ export declare namespace ApolloClient {
         */
         fetchPolicy?: FetchPolicy;
     } & VariablesOption<NoInfer<TVariables>>;
-    interface QueryResult<TData = unknown> {
+    type QueryResult<TData = unknown, TErrorPolicy extends ErrorPolicy | undefined = undefined> = TErrorPolicy extends "none" ? {
+        /**
+        * 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;
+        /**
+        * A single ErrorLike object describing the error that occurred during the latest
+        * query execution.
+        * 
+        * For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
+        * 
+        * @docGroup 1. Operation data
+        */
+        error?: never;
+    } : TErrorPolicy extends "all" ? {
         /**
         * An object containing the result of your GraphQL query after it completes.
         * 
@@ -285,7 +303,43 @@ export declare namespace ApolloClient {
         * @docGroup 1. Operation data
         */
         error?: ErrorLike;
-    }
+    } : TErrorPolicy extends "ignore" ? {
+        /**
+        * 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;
+        /**
+        * A single ErrorLike object describing the error that occurred during the latest
+        * query execution.
+        * 
+        * For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
+        * 
+        * @docGroup 1. Operation data
+        */
+        error?: never;
+    } : {
+        /**
+        * 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;
+        /**
+        * A single ErrorLike object describing the error that occurred during the latest
+        * query execution.
+        * 
+        * For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
+        * 
+        * @docGroup 1. Operation data
+        */
+        error?: ErrorLike;
+    };
     /**
      * Options object for the `client.refetchQueries` method.
      */
@@ -811,7 +865,31 @@ export declare class ApolloClient {
      * 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: ApolloClient.QueryOptions<TData, TVariables>): Promise<ApolloClient.QueryResult<MaybeMasked<TData>>>;
+    query<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.QueryOptions<TData, TVariables> & {
+        errorPolicy: "all";
+    }): Promise<ApolloClient.QueryResult<MaybeMasked<TData>, "all">>;
+    /**
+    * This resolves a single query according to the options specified and
+    * returns a `Promise` which is either resolved with the resulting data
+    * or rejected with an error.
+    * 
+    * @param options - An object of type `QueryOptions` that allows us to
+    * 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: ApolloClient.QueryOptions<TData, TVariables> & {
+        errorPolicy: "ignore";
+    }): Promise<ApolloClient.QueryResult<MaybeMasked<TData>, "ignore">>;
+    /**
+    * This resolves a single query according to the options specified and
+    * returns a `Promise` which is either resolved with the resulting data
+    * or rejected with an error.
+    * 
+    * @param options - An object of type `QueryOptions` that allows us to
+    * 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: ApolloClient.QueryOptions<TData, TVariables>): Promise<ApolloClient.QueryResult<MaybeMasked<TData>, "none">>;
     /**
      * 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

package/core/ApolloClient.js

@@ -218,15 +218,6 @@ export class ApolloClient {
         }
         return this.queryManager.watchQuery(options);
     }
-    /**
-     * This resolves a single query according to the options specified and
-     * returns a `Promise` which is either resolved with the resulting data
-     * or rejected with an error.
-     *
-     * @param options - An object of type `QueryOptions` that allows us to
-     * 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(options) {
         if (this.defaultOptions.query) {
             options = mergeOptions(this.defaultOptions.query, options);