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

package/cache/core/types/Cache.d.ts

@@ -1,23 +1,59 @@
-import type { OperationVariables } from "@apollo/client";
+import type { DataValue, DocumentNode, OperationVariables, TypedDocumentNode } from "@apollo/client";
 import type { Unmasked } from "@apollo/client/masking";
 import type { ApolloCache } from "../cache.js";
-import type { AllFieldsModifier, Modifiers } from "./common.js";
-import { DataProxy } from "./DataProxy.js";
+import type { AllFieldsModifier, MissingFieldError, Modifiers } from "./common.js";
 export declare namespace Cache {
     type WatchCallback<TData = unknown> = (diff: Cache.DiffResult<TData>, lastDiff?: Cache.DiffResult<TData>) => void;
-    interface ReadOptions<TVariables = OperationVariables, TData = unknown> extends DataProxy.Query<TVariables, TData> {
+    interface ReadOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> {
+        /**
+         * The GraphQL query shape to be used constructed using the `gql` template
+         * string tag from `graphql-tag`. The query will be used to determine the
+         * shape of the data to be read.
+         */
+        query: DocumentNode | TypedDocumentNode<TData, TVariables>;
+        /**
+         * Any variables that the GraphQL query may depend on.
+         */
+        variables?: TVariables;
+        /**
+         * The root id to be used. Defaults to "ROOT_QUERY", which is the ID of the
+         * root query object. This property makes writeQuery capable of writing data
+         * to any object in the cache.
+         */
+        id?: string;
         rootId?: string;
         previousResult?: any;
         optimistic: boolean;
         returnPartialData?: boolean;
     }
-    interface WriteOptions<TData = unknown, TVariables = OperationVariables> extends Omit<DataProxy.Query<TVariables, TData>, "id">, Omit<DataProxy.WriteOptions<TData>, "data"> {
+    interface WriteOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> {
+        /**
+         * The GraphQL query shape to be used constructed using the `gql` template
+         * string tag from `graphql-tag`. The query will be used to determine the
+         * shape of the data to be read.
+         */
+        query: DocumentNode | TypedDocumentNode<TData, TVariables>;
+        /**
+         * Any variables that the GraphQL query may depend on.
+         */
+        variables?: TVariables;
         dataId?: string;
         result: Unmasked<TData>;
+        /**
+         * Whether to notify query watchers.
+         * @defaultValue true
+         */
+        broadcast?: boolean;
+        /**
+         * When true, ignore existing field data rather than merging it with
+         * incoming data.
+         * @defaultValue false
+         */
+        overwrite?: boolean;
     }
-    interface DiffOptions<TData = unknown, TVariables = OperationVariables> extends Omit<ReadOptions<TVariables, TData>, "rootId"> {
+    interface DiffOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> extends Omit<ReadOptions<TData, TVariables>, "rootId"> {
     }
-    interface WatchOptions<TData = unknown, TVariables = OperationVariables> extends DiffOptions<TData, TVariables> {
+    interface WatchOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> extends DiffOptions<TData, TVariables> {
         watcher?: object;
         immediate?: boolean;
         callback: WatchCallback<TData>;
@@ -44,13 +80,162 @@ export declare namespace Cache {
         removeOptimistic?: string;
         onWatchUpdated?: (this: TCache, watch: Cache.WatchOptions, diff: Cache.DiffResult<any>, lastDiff?: Cache.DiffResult<any> | undefined) => any;
     }
-    export import DiffResult = DataProxy.DiffResult;
-    export import ReadQueryOptions = DataProxy.ReadQueryOptions;
-    export import ReadFragmentOptions = DataProxy.ReadFragmentOptions;
-    export import WriteQueryOptions = DataProxy.WriteQueryOptions;
-    export import WriteFragmentOptions = DataProxy.WriteFragmentOptions;
-    export import UpdateQueryOptions = DataProxy.UpdateQueryOptions;
-    export import UpdateFragmentOptions = DataProxy.UpdateFragmentOptions;
-    export import Fragment = DataProxy.Fragment;
+    interface ReadQueryOptions<TData, TVariables extends OperationVariables> {
+        /**
+         * The GraphQL query shape to be used constructed using the `gql` template
+         * string tag. The query will be used to determine the
+         * shape of the data to be read.
+         */
+        query: DocumentNode | TypedDocumentNode<TData, TVariables>;
+        /**
+         * Any variables that the GraphQL query may depend on.
+         */
+        variables?: TVariables;
+        /**
+         * The root id to be used. Defaults to "ROOT_QUERY", which is the ID of the
+         * root query object. This property makes readQuery capable of reading data
+         * from any object in the cache.
+         */
+        id?: string;
+        /**
+         * Whether to return incomplete data rather than null.
+         * @defaultValue false
+         */
+        returnPartialData?: boolean;
+        /**
+         * Whether to read from optimistic or non-optimistic cache data. If
+         * this named option is provided, the optimistic parameter of the
+         * readQuery method can be omitted.
+         * @defaultValue false
+         */
+        optimistic?: boolean;
+    }
+    interface ReadFragmentOptions<TData, TVariables extends OperationVariables> {
+        /**
+         * The root id to be used. This id should take the same form as the
+         * value returned by the `cache.identify` function. If a value with your
+         * id does not exist in the store, `null` will be returned.
+         */
+        id?: string;
+        /**
+         * A GraphQL document created using the `gql` template string tag from
+         * `graphql-tag` with one or more fragments which will be used to determine
+         * the shape of data to read. If you provide more than one fragment in this
+         * document then you must also specify `fragmentName` to specify which
+         * fragment is the root fragment.
+         */
+        fragment: DocumentNode | TypedDocumentNode<TData, TVariables>;
+        /**
+         * The name of the fragment in your GraphQL document to be used. If you do
+         * not provide a `fragmentName` and there is only one fragment in your
+         * `fragment` document then that fragment will be used.
+         */
+        fragmentName?: string;
+        /**
+         * Any variables that your GraphQL fragments depend on.
+         */
+        variables?: TVariables;
+        /**
+         * Whether to return incomplete data rather than null.
+         * @defaultValue false
+         */
+        returnPartialData?: boolean;
+        /**
+         * Whether to read from optimistic or non-optimistic cache data. If
+         * this named option is provided, the optimistic parameter of the
+         * readFragment method can be omitted.
+         * @defaultValue false
+         */
+        optimistic?: boolean;
+    }
+    interface WriteQueryOptions<TData, TVariables extends OperationVariables> {
+        /**
+         * The GraphQL query shape to be used constructed using the `gql` template
+         * string tag from `graphql-tag`. The query will be used to determine the
+         * shape of the data to be read.
+         */
+        query: DocumentNode | TypedDocumentNode<TData, TVariables>;
+        /**
+         * Any variables that the GraphQL query may depend on.
+         */
+        variables?: TVariables;
+        /**
+         * The root id to be used. Defaults to "ROOT_QUERY", which is the ID of the
+         * root query object. This property makes writeQuery capable of writing data
+         * to any object in the cache.
+         */
+        id?: string;
+        /**
+         * The data to write to the store.
+         */
+        data: Unmasked<TData>;
+        /**
+         * Whether to notify query watchers.
+         * @defaultValue true
+         */
+        broadcast?: boolean;
+        /**
+         * When true, ignore existing field data rather than merging it with
+         * incoming data.
+         * @defaultValue false
+         */
+        overwrite?: boolean;
+    }
+    interface WriteFragmentOptions<TData, TVariables extends OperationVariables> {
+        /**
+         * The root id to be used. This id should take the same form as the
+         * value returned by the `cache.identify` function. If a value with your
+         * id does not exist in the store, `null` will be returned.
+         */
+        id?: string;
+        /**
+         * A GraphQL document created using the `gql` template string
+         * with one or more fragments which will be used to determine
+         * the shape of data to read. If you provide more than one fragment in this
+         * document then you must also specify `fragmentName` to specify specify which
+         * fragment is the root fragment.
+         */
+        fragment: DocumentNode | TypedDocumentNode<TData, TVariables>;
+        /**
+         * The name of the fragment in your GraphQL document to be used. If you do
+         * not provide a `fragmentName` and there is only one fragment in your
+         * `fragment` document then that fragment will be used.
+         */
+        fragmentName?: string;
+        /**
+         * Any variables that your GraphQL fragments depend on.
+         */
+        variables?: TVariables;
+        /**
+         * The data to write to the store.
+         */
+        data: Unmasked<TData>;
+        /**
+         * Whether to notify query watchers.
+         * @defaultValue true
+         */
+        broadcast?: boolean;
+        /**
+         * When true, ignore existing field data rather than merging it with
+         * incoming data.
+         * @defaultValue false
+         */
+        overwrite?: boolean;
+    }
+    interface UpdateQueryOptions<TData, TVariables extends OperationVariables> extends Omit<ReadQueryOptions<TData, TVariables> & WriteQueryOptions<TData, TVariables>, "data"> {
+    }
+    interface UpdateFragmentOptions<TData, TVariables extends OperationVariables> extends Omit<ReadFragmentOptions<TData, TVariables> & WriteFragmentOptions<TData, TVariables>, "data"> {
+    }
+    type DiffResult<TData> = {
+        result: DataValue.Complete<TData>;
+        complete: true;
+        missing?: never;
+        fromOptimisticTransaction?: boolean;
+    } | {
+        result: DataValue.Partial<TData> | null;
+        complete: false;
+        missing?: MissingFieldError;
+        fromOptimisticTransaction?: boolean;
+    };
 }
 //# sourceMappingURL=Cache.d.ts.map

package/cache/core/types/Cache.js

@@ -1,4 +1,2 @@
-export var Cache;
-(function (Cache) {
-})(Cache || (Cache = {}));
+export {};
 //# sourceMappingURL=Cache.js.map

package/cache/core/types/Cache.js.map

@@ -1 +1 @@
-{"version":3,"file":"Cache.js","sourceRoot":"","sources":["../../../../src/cache/core/types/Cache.ts"],"names":[],"mappings":"AAQA,MAAM,KAAW,KAAK,CA0GrB;AA1GD,WAAiB,KAAK;AA0GtB,CAAC,EA1GgB,KAAK,KAAL,KAAK,QA0GrB","sourcesContent":["import type { OperationVariables } from \"@apollo/client\";\nimport type { Unmasked } from \"@apollo/client/masking\";\n\nimport type { ApolloCache } from \"../cache.js\";\n\nimport type { AllFieldsModifier, Modifiers } from \"./common.js\";\nimport { DataProxy } from \"./DataProxy.js\";\n\nexport namespace Cache {\n  export type WatchCallback<TData = unknown> = (\n    diff: Cache.DiffResult<TData>,\n    lastDiff?: Cache.DiffResult<TData>\n  ) => void;\n\n  export interface ReadOptions<TVariables = OperationVariables, TData = unknown>\n    extends DataProxy.Query<TVariables, TData> {\n    rootId?: string;\n    previousResult?: any;\n    optimistic: boolean;\n    returnPartialData?: boolean;\n  }\n\n  export interface WriteOptions<\n    TData = unknown,\n    TVariables = OperationVariables,\n  > extends Omit<DataProxy.Query<TVariables, TData>, \"id\">,\n      Omit<DataProxy.WriteOptions<TData>, \"data\"> {\n    dataId?: string;\n    result: Unmasked<TData>;\n  }\n\n  export interface DiffOptions<TData = unknown, TVariables = OperationVariables>\n    extends Omit<ReadOptions<TVariables, TData>, \"rootId\"> {\n    // The DiffOptions interface is currently just an alias for\n    // ReadOptions, though DiffOptions used to be responsible for\n    // declaring the returnPartialData option.\n  }\n\n  export interface WatchOptions<\n    TData = unknown,\n    TVariables = OperationVariables,\n  > extends DiffOptions<TData, TVariables> {\n    watcher?: object;\n    immediate?: boolean;\n    callback: WatchCallback<TData>;\n    lastDiff?: DiffResult<TData>;\n  }\n\n  export interface EvictOptions {\n    id?: string;\n    fieldName?: string;\n    args?: Record<string, any>;\n    broadcast?: boolean;\n  }\n\n  // Although you can call cache.reset() without options, its behavior can be\n  // configured by passing a Cache.ResetOptions object.\n  export interface ResetOptions {\n    discardWatches?: boolean;\n  }\n\n  export interface ModifyOptions<\n    Entity extends Record<string, any> = Record<string, any>,\n  > {\n    id?: string;\n    fields: Modifiers<Entity> | AllFieldsModifier<Entity>;\n    optimistic?: boolean;\n    broadcast?: boolean;\n  }\n\n  export interface BatchOptions<\n    TCache extends ApolloCache,\n    TUpdateResult = void,\n  > {\n    // Same as the first parameter of performTransaction, except the cache\n    // argument will have the subclass type rather than ApolloCache.\n    update(cache: TCache): TUpdateResult;\n\n    // Passing a string for this option creates a new optimistic layer, with the\n    // given string as its layer.id, just like passing a string for the\n    // optimisticId parameter of performTransaction. Passing true is the same as\n    // passing undefined to performTransaction (running the batch operation\n    // against the current top layer of the cache), and passing false is the\n    // same as passing null (running the operation against root/non-optimistic\n    // cache data).\n    optimistic?: string | boolean;\n\n    // If you specify the ID of an optimistic layer using this option, that\n    // layer will be removed as part of the batch transaction, triggering at\n    // most one broadcast for both the transaction and the removal of the layer.\n    // Note: this option is needed because calling cache.removeOptimistic during\n    // the transaction function may not be not safe, since any modifications to\n    // cache layers may be discarded after the transaction finishes.\n    removeOptimistic?: string;\n\n    // If you want to find out which watched queries were invalidated during\n    // this batch operation, pass this optional callback function. Returning\n    // false from the callback will prevent broadcasting this result.\n    onWatchUpdated?: (\n      this: TCache,\n      watch: Cache.WatchOptions,\n      diff: Cache.DiffResult<any>,\n      lastDiff?: Cache.DiffResult<any> | undefined\n    ) => any;\n  }\n\n  export import DiffResult = DataProxy.DiffResult;\n  export import ReadQueryOptions = DataProxy.ReadQueryOptions;\n  export import ReadFragmentOptions = DataProxy.ReadFragmentOptions;\n  export import WriteQueryOptions = DataProxy.WriteQueryOptions;\n  export import WriteFragmentOptions = DataProxy.WriteFragmentOptions;\n  export import UpdateQueryOptions = DataProxy.UpdateQueryOptions;\n  export import UpdateFragmentOptions = DataProxy.UpdateFragmentOptions;\n  export import Fragment = DataProxy.Fragment;\n}\n"]}
+{"version":3,"file":"Cache.js","sourceRoot":"","sources":["../../../../src/cache/core/types/Cache.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n  DataValue,\n  DocumentNode,\n  OperationVariables,\n  TypedDocumentNode,\n} from \"@apollo/client\";\nimport type { Unmasked } from \"@apollo/client/masking\";\n\nimport type { ApolloCache } from \"../cache.js\";\n\nimport type {\n  AllFieldsModifier,\n  MissingFieldError,\n  Modifiers,\n} from \"./common.js\";\nexport declare namespace Cache {\n  export type WatchCallback<TData = unknown> = (\n    diff: Cache.DiffResult<TData>,\n    lastDiff?: Cache.DiffResult<TData>\n  ) => void;\n\n  export interface ReadOptions<\n    TData = unknown,\n    TVariables extends OperationVariables = OperationVariables,\n  > {\n    /**\n     * The GraphQL query shape to be used constructed using the `gql` template\n     * string tag from `graphql-tag`. The query will be used to determine the\n     * shape of the data to be read.\n     */\n    query: DocumentNode | TypedDocumentNode<TData, TVariables>;\n\n    /**\n     * Any variables that the GraphQL query may depend on.\n     */\n    variables?: TVariables;\n\n    /**\n     * The root id to be used. Defaults to \"ROOT_QUERY\", which is the ID of the\n     * root query object. This property makes writeQuery capable of writing data\n     * to any object in the cache.\n     */\n    id?: string;\n    rootId?: string;\n    previousResult?: any;\n    optimistic: boolean;\n    returnPartialData?: boolean;\n  }\n\n  export interface WriteOptions<\n    TData = unknown,\n    TVariables extends OperationVariables = OperationVariables,\n  > {\n    /**\n     * The GraphQL query shape to be used constructed using the `gql` template\n     * string tag from `graphql-tag`. The query will be used to determine the\n     * shape of the data to be read.\n     */\n    query: DocumentNode | TypedDocumentNode<TData, TVariables>;\n\n    /**\n     * Any variables that the GraphQL query may depend on.\n     */\n    variables?: TVariables;\n\n    dataId?: string;\n    result: Unmasked<TData>;\n\n    /**\n     * Whether to notify query watchers.\n     * @defaultValue true\n     */\n    broadcast?: boolean;\n    /**\n     * When true, ignore existing field data rather than merging it with\n     * incoming data.\n     * @defaultValue false\n     */\n    overwrite?: boolean;\n  }\n\n  export interface DiffOptions<\n    TData = unknown,\n    TVariables extends OperationVariables = OperationVariables,\n  > extends Omit<ReadOptions<TData, TVariables>, \"rootId\"> {\n    // The DiffOptions interface is currently just an alias for\n    // ReadOptions, though DiffOptions used to be responsible for\n    // declaring the returnPartialData option.\n  }\n\n  export interface WatchOptions<\n    TData = unknown,\n    TVariables extends OperationVariables = OperationVariables,\n  > extends DiffOptions<TData, TVariables> {\n    watcher?: object;\n    immediate?: boolean;\n    callback: WatchCallback<TData>;\n    lastDiff?: DiffResult<TData>;\n  }\n\n  export interface EvictOptions {\n    id?: string;\n    fieldName?: string;\n    args?: Record<string, any>;\n    broadcast?: boolean;\n  }\n\n  // Although you can call cache.reset() without options, its behavior can be\n  // configured by passing a Cache.ResetOptions object.\n  export interface ResetOptions {\n    discardWatches?: boolean;\n  }\n\n  export interface ModifyOptions<\n    Entity extends Record<string, any> = Record<string, any>,\n  > {\n    id?: string;\n    fields: Modifiers<Entity> | AllFieldsModifier<Entity>;\n    optimistic?: boolean;\n    broadcast?: boolean;\n  }\n\n  export interface BatchOptions<\n    TCache extends ApolloCache,\n    TUpdateResult = void,\n  > {\n    // Same as the first parameter of performTransaction, except the cache\n    // argument will have the subclass type rather than ApolloCache.\n    update(cache: TCache): TUpdateResult;\n\n    // Passing a string for this option creates a new optimistic layer, with the\n    // given string as its layer.id, just like passing a string for the\n    // optimisticId parameter of performTransaction. Passing true is the same as\n    // passing undefined to performTransaction (running the batch operation\n    // against the current top layer of the cache), and passing false is the\n    // same as passing null (running the operation against root/non-optimistic\n    // cache data).\n    optimistic?: string | boolean;\n\n    // If you specify the ID of an optimistic layer using this option, that\n    // layer will be removed as part of the batch transaction, triggering at\n    // most one broadcast for both the transaction and the removal of the layer.\n    // Note: this option is needed because calling cache.removeOptimistic during\n    // the transaction function may not be not safe, since any modifications to\n    // cache layers may be discarded after the transaction finishes.\n    removeOptimistic?: string;\n\n    // If you want to find out which watched queries were invalidated during\n    // this batch operation, pass this optional callback function. Returning\n    // false from the callback will prevent broadcasting this result.\n    onWatchUpdated?: (\n      this: TCache,\n      watch: Cache.WatchOptions,\n      diff: Cache.DiffResult<any>,\n      lastDiff?: Cache.DiffResult<any> | undefined\n    ) => any;\n  }\n\n  export interface ReadQueryOptions<\n    TData,\n    TVariables extends OperationVariables,\n  > {\n    /**\n     * The GraphQL query shape to be used constructed using the `gql` template\n     * string tag. The query will be used to determine the\n     * shape of the data to be read.\n     */\n    query: DocumentNode | TypedDocumentNode<TData, TVariables>;\n\n    /**\n     * Any variables that the GraphQL query may depend on.\n     */\n    variables?: TVariables;\n\n    /**\n     * The root id to be used. Defaults to \"ROOT_QUERY\", which is the ID of the\n     * root query object. This property makes readQuery capable of reading data\n     * from any object in the cache.\n     */\n    id?: string;\n    /**\n     * Whether to return incomplete data rather than null.\n     * @defaultValue false\n     */\n    returnPartialData?: boolean;\n    /**\n     * Whether to read from optimistic or non-optimistic cache data. If\n     * this named option is provided, the optimistic parameter of the\n     * readQuery method can be omitted.\n     * @defaultValue false\n     */\n    optimistic?: boolean;\n  }\n\n  export interface ReadFragmentOptions<\n    TData,\n    TVariables extends OperationVariables,\n  > {\n    /**\n     * The root id to be used. This id should take the same form as the\n     * value returned by the `cache.identify` function. If a value with your\n     * id does not exist in the store, `null` will be returned.\n     */\n    id?: string;\n\n    /**\n     * A GraphQL document created using the `gql` template string tag from\n     * `graphql-tag` with one or more fragments which will be used to determine\n     * the shape of data to read. If you provide more than one fragment in this\n     * document then you must also specify `fragmentName` to specify which\n     * fragment is the root fragment.\n     */\n    fragment: DocumentNode | TypedDocumentNode<TData, TVariables>;\n\n    /**\n     * The name of the fragment in your GraphQL document to be used. If you do\n     * not provide a `fragmentName` and there is only one fragment in your\n     * `fragment` document then that fragment will be used.\n     */\n    fragmentName?: string;\n\n    /**\n     * Any variables that your GraphQL fragments depend on.\n     */\n    variables?: TVariables;\n\n    /**\n     * Whether to return incomplete data rather than null.\n     * @defaultValue false\n     */\n    returnPartialData?: boolean;\n    /**\n     * Whether to read from optimistic or non-optimistic cache data. If\n     * this named option is provided, the optimistic parameter of the\n     * readFragment method can be omitted.\n     * @defaultValue false\n     */\n    optimistic?: boolean;\n  }\n\n  export interface WriteQueryOptions<\n    TData,\n    TVariables extends OperationVariables,\n  > {\n    /**\n     * The GraphQL query shape to be used constructed using the `gql` template\n     * string tag from `graphql-tag`. The query will be used to determine the\n     * shape of the data to be read.\n     */\n    query: DocumentNode | TypedDocumentNode<TData, TVariables>;\n\n    /**\n     * Any variables that the GraphQL query may depend on.\n     */\n    variables?: TVariables;\n\n    /**\n     * The root id to be used. Defaults to \"ROOT_QUERY\", which is the ID of the\n     * root query object. This property makes writeQuery capable of writing data\n     * to any object in the cache.\n     */\n    id?: string;\n\n    /**\n     * The data to write to the store.\n     */\n    data: Unmasked<TData>;\n    /**\n     * Whether to notify query watchers.\n     * @defaultValue true\n     */\n    broadcast?: boolean;\n    /**\n     * When true, ignore existing field data rather than merging it with\n     * incoming data.\n     * @defaultValue false\n     */\n    overwrite?: boolean;\n  }\n\n  export interface WriteFragmentOptions<\n    TData,\n    TVariables extends OperationVariables,\n  > {\n    /**\n     * The root id to be used. This id should take the same form as the\n     * value returned by the `cache.identify` function. If a value with your\n     * id does not exist in the store, `null` will be returned.\n     */\n    id?: string;\n\n    /**\n     * A GraphQL document created using the `gql` template string\n     * with one or more fragments which will be used to determine\n     * the shape of data to read. If you provide more than one fragment in this\n     * document then you must also specify `fragmentName` to specify specify which\n     * fragment is the root fragment.\n     */\n    fragment: DocumentNode | TypedDocumentNode<TData, TVariables>;\n\n    /**\n     * The name of the fragment in your GraphQL document to be used. If you do\n     * not provide a `fragmentName` and there is only one fragment in your\n     * `fragment` document then that fragment will be used.\n     */\n    fragmentName?: string;\n\n    /**\n     * Any variables that your GraphQL fragments depend on.\n     */\n    variables?: TVariables;\n    /**\n     * The data to write to the store.\n     */\n    data: Unmasked<TData>;\n    /**\n     * Whether to notify query watchers.\n     * @defaultValue true\n     */\n    broadcast?: boolean;\n    /**\n     * When true, ignore existing field data rather than merging it with\n     * incoming data.\n     * @defaultValue false\n     */\n    overwrite?: boolean;\n  }\n\n  export interface UpdateQueryOptions<\n    TData,\n    TVariables extends OperationVariables,\n  > extends Omit<\n      ReadQueryOptions<TData, TVariables> &\n        WriteQueryOptions<TData, TVariables>,\n      \"data\"\n    > {}\n\n  export interface UpdateFragmentOptions<\n    TData,\n    TVariables extends OperationVariables,\n  > extends Omit<\n      ReadFragmentOptions<TData, TVariables> &\n        WriteFragmentOptions<TData, TVariables>,\n      \"data\"\n    > {}\n\n  export type DiffResult<TData> =\n    | {\n        result: DataValue.Complete<TData>;\n        complete: true;\n        missing?: never;\n        fromOptimisticTransaction?: boolean;\n      }\n    | {\n        result: DataValue.Partial<TData> | null;\n        complete: false;\n        missing?: MissingFieldError;\n        fromOptimisticTransaction?: boolean;\n      };\n}\n"]}

package/cache/deprecated.d.ts

@@ -0,0 +1,6 @@
+import type { ApolloCache, OperationVariables } from "@apollo/client";
+/** @deprecated Use `ApolloCache.WatchFragmentOptions` instead */
+export type WatchFragmentOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> = ApolloCache.WatchFragmentOptions<TData, TVariables>;
+/** @deprecated Use `ApolloCache.WatchFragmentResult` instead */
+export type WatchFragmentResult<TData> = ApolloCache.WatchFragmentResult<TData>;
+//# sourceMappingURL=deprecated.d.ts.map

package/cache/deprecated.js

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

package/cache/deprecated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deprecated.js","sourceRoot":"","sources":["../../src/cache/deprecated.ts"],"names":[],"mappings":"","sourcesContent":["import type { ApolloCache, OperationVariables } from \"@apollo/client\";\n\n/** @deprecated Use `ApolloCache.WatchFragmentOptions` instead */\nexport type WatchFragmentOptions<\n  TData = unknown,\n  TVariables extends OperationVariables = OperationVariables,\n> = ApolloCache.WatchFragmentOptions<TData, TVariables>;\n\n/** @deprecated Use `ApolloCache.WatchFragmentResult` instead */\nexport type WatchFragmentResult<TData> = ApolloCache.WatchFragmentResult<TData>;\n"]}

package/cache/index.d.ts

@@ -1,7 +1,7 @@
-export type { Transaction, WatchFragmentOptions, WatchFragmentResult, } from "./core/cache.js";
+export type { Transaction } from "./core/cache.js";
+export type { WatchFragmentOptions, WatchFragmentResult, } from "./deprecated.js";
 export { ApolloCache } from "./core/cache.js";
 export type { Cache } from "./core/types/Cache.js";
-export type { DataProxy } from "./core/types/DataProxy.js";
 export type { IgnoreModifier, MissingTree, Modifier, ModifierDetails, Modifiers, ReadFieldOptions, } from "./core/types/common.js";
 export { MissingFieldError } from "./core/types/common.js";
 export type { Reference } from "@apollo/client/utilities";

package/cache/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cache/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAW9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAG3D,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAE3E,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EACL,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAG5D,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAWhE,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAGlD,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC","sourcesContent":["export type {\n  Transaction,\n  WatchFragmentOptions,\n  WatchFragmentResult,\n} from \"./core/cache.js\";\nexport { ApolloCache } from \"./core/cache.js\";\nexport type { Cache } from \"./core/types/Cache.js\";\nexport type { DataProxy } from \"./core/types/DataProxy.js\";\nexport type {\n  IgnoreModifier,\n  MissingTree,\n  Modifier,\n  ModifierDetails,\n  Modifiers,\n  ReadFieldOptions,\n} from \"./core/types/common.js\";\nexport { MissingFieldError } from \"./core/types/common.js\";\n\nexport type { Reference } from \"@apollo/client/utilities\";\nexport { canonicalStringify, isReference } from \"@apollo/client/utilities\";\n\nexport { EntityStore } from \"./inmemory/entityStore.js\";\nexport {\n  defaultDataIdFromObject,\n  fieldNameFromStoreName,\n} from \"./inmemory/helpers.js\";\n\nexport { InMemoryCache } from \"./inmemory/inMemoryCache.js\";\n\nexport type { ReactiveVar } from \"./inmemory/reactiveVars.js\";\nexport { cacheSlot, makeVar } from \"./inmemory/reactiveVars.js\";\n\nexport type {\n  FieldFunctionOptions,\n  FieldMergeFunction,\n  FieldPolicy,\n  FieldReadFunction,\n  PossibleTypesMap,\n  TypePolicies,\n  TypePolicy,\n} from \"./inmemory/policies.js\";\nexport { Policies } from \"./inmemory/policies.js\";\n\nexport type { FragmentRegistryAPI } from \"./inmemory/fragmentRegistry.js\";\nexport { createFragmentRegistry } from \"./inmemory/fragmentRegistry.js\";\n\nexport type {\n  ApolloReducerConfig,\n  DiffQueryAgainstStoreOptions,\n  IdGetter,\n  IdGetterObj,\n  InMemoryCacheConfig,\n  MergeInfo,\n  MergeTree,\n  NormalizedCache,\n  NormalizedCacheObject,\n  OptimisticStoreItem,\n  ReadMergeModifyContext,\n  ReadQueryOptions,\n  StoreObject,\n  StoreValue,\n} from \"./inmemory/types.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cache/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAU9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAG3D,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAE3E,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EACL,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAG5D,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAWhE,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAGlD,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC","sourcesContent":["export type { Transaction } from \"./core/cache.js\";\nexport type {\n  WatchFragmentOptions,\n  WatchFragmentResult,\n} from \"./deprecated.js\";\nexport { ApolloCache } from \"./core/cache.js\";\nexport type { Cache } from \"./core/types/Cache.js\";\nexport type {\n  IgnoreModifier,\n  MissingTree,\n  Modifier,\n  ModifierDetails,\n  Modifiers,\n  ReadFieldOptions,\n} from \"./core/types/common.js\";\nexport { MissingFieldError } from \"./core/types/common.js\";\n\nexport type { Reference } from \"@apollo/client/utilities\";\nexport { canonicalStringify, isReference } from \"@apollo/client/utilities\";\n\nexport { EntityStore } from \"./inmemory/entityStore.js\";\nexport {\n  defaultDataIdFromObject,\n  fieldNameFromStoreName,\n} from \"./inmemory/helpers.js\";\n\nexport { InMemoryCache } from \"./inmemory/inMemoryCache.js\";\n\nexport type { ReactiveVar } from \"./inmemory/reactiveVars.js\";\nexport { cacheSlot, makeVar } from \"./inmemory/reactiveVars.js\";\n\nexport type {\n  FieldFunctionOptions,\n  FieldMergeFunction,\n  FieldPolicy,\n  FieldReadFunction,\n  PossibleTypesMap,\n  TypePolicies,\n  TypePolicy,\n} from \"./inmemory/policies.js\";\nexport { Policies } from \"./inmemory/policies.js\";\n\nexport type { FragmentRegistryAPI } from \"./inmemory/fragmentRegistry.js\";\nexport { createFragmentRegistry } from \"./inmemory/fragmentRegistry.js\";\n\nexport type {\n  ApolloReducerConfig,\n  DiffQueryAgainstStoreOptions,\n  IdGetter,\n  IdGetterObj,\n  InMemoryCacheConfig,\n  MergeInfo,\n  MergeTree,\n  NormalizedCache,\n  NormalizedCacheObject,\n  OptimisticStoreItem,\n  ReadMergeModifyContext,\n  ReadQueryOptions,\n  StoreObject,\n  StoreValue,\n} from \"./inmemory/types.js\";\n"]}

package/cache/inmemory/entityStore.d.ts

@@ -8,6 +8,7 @@ import type { NormalizedCache, NormalizedCacheObject } from "./types.js";
 export declare abstract class EntityStore implements NormalizedCache {
     readonly policies: Policies;
     readonly group: CacheGroup;
+    static Root: typeof Root;
     protected data: NormalizedCacheObject;
     constructor(policies: Policies, group: CacheGroup);
     abstract addLayer(layerId: string, replay: (layer: EntityStore) => any): Layer;
@@ -37,8 +38,10 @@ export declare abstract class EntityStore implements NormalizedCache {
     makeCacheKey(selectionSet: SelectionSetNode, parent: string | StoreObject, varString: string | undefined): object;
     /** overload for `StoreReader.executeSubSelectedArray` */
     makeCacheKey(field: FieldNode, array: readonly any[], varString: string | undefined): object;
-    /** @deprecated This is only meant for internal usage,
-     * in your own code please use a `Trie` instance instead. */
+    /**
+     * @deprecated This is only meant for internal usage,
+     * in your own code please use a `Trie` instance instead.
+     */
     makeCacheKey(...args: any[]): object;
     getFieldValue: <T = StoreValue>(objectOrReference: StoreObject | Reference | undefined, storeFieldName: string) => SafeReadonly<T>;
     canRead: CanReadFunction;
@@ -57,19 +60,17 @@ declare class CacheGroup {
     dirty(dataId: string, storeFieldName: string): void;
 }
 export declare function maybeDependOnExistenceOfEntity(store: NormalizedCache, entityId: string): void;
-export declare namespace EntityStore {
-    class Root extends EntityStore {
-        constructor({ policies, resultCaching, seed, }: {
-            policies: Policies;
-            resultCaching?: boolean;
-            seed?: NormalizedCacheObject;
-        });
-        readonly stump: Stump;
-        addLayer(layerId: string, replay: (layer: EntityStore) => any): Layer;
-        removeLayer(): Root;
-        readonly storageTrie: Trie<StorageType>;
-        getStorage(): StorageType;
-    }
+declare class Root extends EntityStore {
+    constructor({ policies, resultCaching, seed, }: {
+        policies: Policies;
+        resultCaching?: boolean;
+        seed?: NormalizedCacheObject;
+    });
+    readonly stump: Stump;
+    addLayer(layerId: string, replay: (layer: EntityStore) => any): Layer;
+    removeLayer(): Root;
+    readonly storageTrie: Trie<StorageType>;
+    getStorage(): StorageType;
 }
 declare class Layer extends EntityStore {
     readonly id: string;
@@ -84,7 +85,7 @@ declare class Layer extends EntityStore {
     getStorage(...args: Parameters<EntityStore["getStorage"]>): StorageType;
 }
 declare class Stump extends Layer {
-    constructor(root: EntityStore.Root);
+    constructor(root: Root);
     removeLayer(): this;
     merge(older: string | StoreObject, newer: string | StoreObject): void;
 }

package/cache/inmemory/entityStore.js

@@ -73,7 +73,7 @@ export class EntityStore {
         // then there are no fields to be merged, so we're done.
         if (!incoming)
             return;
-        invariant(typeof dataId === "string", 96);
+        invariant(typeof dataId === "string", 95);
         const merged = new DeepMerger(storeObjectReconciler).merge(existing, incoming);
         // Even if merged === existing, existing may have come from a lower
         // layer, so we always need to set this.data[dataId] on this level.
@@ -173,7 +173,7 @@ export class EntityStore {
                             if (__DEV__) {
                                 const checkReference = (ref) => {
                                     if (this.lookup(ref.__ref) === undefined) {
-                                        __DEV__ && invariant.warn(97, ref);
+                                        __DEV__ && invariant.warn(96, ref);
                                         return true;
                                     }
                                 };
@@ -202,7 +202,7 @@ export class EntityStore {
                                             }
                                         }
                                         if (seenReference && someNonReference !== undefined) {
-                                            __DEV__ && invariant.warn(98, someNonReference);
+                                            __DEV__ && invariant.warn(97, someNonReference);
                                             break;
                                         }
                                     }
@@ -516,32 +516,29 @@ export function maybeDependOnExistenceOfEntity(store, entityId) {
         store.group.depend(entityId, "__exists");
     }
 }
-(function (EntityStore) {
-    // Refer to this class as EntityStore.Root outside this namespace.
-    class Root extends EntityStore {
-        constructor({ policies, resultCaching = true, seed, }) {
-            super(policies, new CacheGroup(resultCaching));
-            if (seed)
-                this.replace(seed);
-        }
-        stump = new Stump(this);
-        addLayer(layerId, replay) {
-            // Adding an optimistic Layer on top of the Root actually adds the Layer
-            // on top of the Stump, so the Stump always comes between the Root and
-            // any Layer objects that we've added.
-            return this.stump.addLayer(layerId, replay);
-        }
-        removeLayer() {
-            // Never remove the root layer.
-            return this;
-        }
-        storageTrie = new Trie();
-        getStorage() {
-            return this.storageTrie.lookupArray(arguments);
-        }
+class Root extends EntityStore {
+    constructor({ policies, resultCaching = true, seed, }) {
+        super(policies, new CacheGroup(resultCaching));
+        if (seed)
+            this.replace(seed);
+    }
+    stump = new Stump(this);
+    addLayer(layerId, replay) {
+        // Adding an optimistic Layer on top of the Root actually adds the Layer
+        // on top of the Stump, so the Stump always comes between the Root and
+        // any Layer objects that we've added.
+        return this.stump.addLayer(layerId, replay);
+    }
+    removeLayer() {
+        // Never remove the root layer.
+        return this;
+    }
+    storageTrie = new Trie();
+    getStorage() {
+        return this.storageTrie.lookupArray(arguments);
     }
-    EntityStore.Root = Root;
-})(EntityStore || (EntityStore = {}));
+}
+EntityStore.Root = Root;
 // Not exported, since all Layer instances are created by the addLayer method
 // of the EntityStore.Root class.
 class Layer extends EntityStore {