@depup/apollo__client 4.1.6-depup.0

package/__cjs/cache/core/cache.d.cts

@@ -0,0 +1,291 @@
+import type { DocumentNode, FragmentDefinitionNode, InlineFragmentNode } from "graphql";
+import { Observable } from "rxjs";
+import type { DataValue, GetDataState, OperationVariables, TypedDocumentNode } from "@apollo/client";
+import type { FragmentType, Unmasked } from "@apollo/client/masking";
+import type { Reference, StoreObject } from "@apollo/client/utilities";
+import type { IsAny, NoInfer, Prettify } from "@apollo/client/utilities/internal";
+import { getApolloCacheMemoryInternals } from "@apollo/client/utilities/internal";
+import type { Cache } from "./types/Cache.cjs";
+import type { MissingTree } from "./types/common.cjs";
+export type Transaction = (c: ApolloCache) => void;
+export declare namespace ApolloCache {
+    /**
+     * Acceptable values provided to the `from` option.
+     */
+    type FromOptionValue<TData> = StoreObject | Reference | FragmentType<NoInfer<TData>> | string;
+    /**
+     * Watched fragment options.
+     */
+    interface WatchFragmentOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> {
+        /**
+         * A GraphQL fragment document parsed into an AST with the `gql`
+         * template literal.
+         *
+         * @docGroup 1. Required options
+         */
+        fragment: DocumentNode | TypedDocumentNode<TData, TVariables>;
+        /**
+         * An object containing a `__typename` and primary key fields
+         * (such as `id`) identifying the entity object from which the fragment will
+         * be retrieved, or a `{ __ref: "..." }` reference, or a `string` ID
+         * (uncommon).
+         *
+         * @docGroup 1. Required options
+         */
+        from: ApolloCache.FromOptionValue<TData> | Array<ApolloCache.FromOptionValue<TData> | null> | null;
+        /**
+         * Any variables that the GraphQL fragment may depend on.
+         *
+         * @docGroup 2. Cache options
+         */
+        variables?: TVariables;
+        /**
+         * The name of the fragment defined in the fragment document.
+         *
+         * Required if the fragment document includes more than one fragment,
+         * optional otherwise.
+         *
+         * @docGroup 2. Cache options
+         */
+        fragmentName?: string;
+        /**
+         * If `true`, `watchFragment` returns optimistic results.
+         *
+         * The default value is `true`.
+         *
+         * @docGroup 2. Cache options
+         */
+        optimistic?: boolean;
+    }
+    /**
+     * Watched fragment results.
+     */
+    type WatchFragmentResult<TData = unknown> = true extends IsAny<TData> ? ({
+        complete: true;
+        missing?: never;
+    } & GetDataState<any, "complete">) | ({
+        complete: false;
+        missing?: MissingTree;
+    } & GetDataState<any, "partial">) : TData extends null | null[] ? Prettify<{
+        complete: true;
+        missing?: never;
+    } & GetDataState<TData, "complete">> : Prettify<{
+        complete: true;
+        missing?: never;
+    } & GetDataState<TData, "complete">> | {
+        complete: false;
+        missing?: MissingTree;
+        /**
+        * 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 extends Array<infer TItem> ? Array<DataValue.Partial<TItem> | null> : DataValue.Partial<TData>;
+        /**
+        * Describes the completeness of `data`.
+        * 
+        * - `empty`: No data could be fulfilled from the cache or the result is
+        *   incomplete. `data` is `undefined`.
+        * - `partial`: Some data could be fulfilled from the cache but `data` is
+        *   incomplete. This is only possible when `returnPartialData` is `true`.
+        * - `streaming`: `data` is incomplete as a result of a deferred query and
+        *   the result is still streaming in.
+        * - `complete`: `data` is a fully satisfied query result fulfilled
+        *   either from the cache or network.
+        * 
+        * @docGroup 1. Operation data
+        */
+        dataState: "partial";
+    };
+    interface ObservableFragment<TData = unknown> extends Observable<ApolloCache.WatchFragmentResult<TData>> {
+        /**
+         * Return the current result for the fragment.
+         */
+        getCurrentResult: () => ApolloCache.WatchFragmentResult<TData>;
+    }
+}
+export declare abstract class ApolloCache {
+    readonly assumeImmutableResults: boolean;
+    abstract read<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: Cache.ReadOptions<TData, TVariables>): Unmasked<TData> | null;
+    abstract write<TData = unknown, TVariables extends OperationVariables = OperationVariables>(write: Cache.WriteOptions<TData, TVariables>): Reference | undefined;
+    /**
+     * Returns data read from the cache for a given query along with information
+     * about the cache result such as whether the result is complete and details
+     * about missing fields.
+     *
+     * Will return `complete` as `true` if it can fulfill the full cache result or
+     * `false` if not. When no data can be fulfilled from the cache, `null` is
+     * returned. When `returnPartialData` is `true`, non-null partial results are
+     * returned if it contains at least one field that can be fulfilled from the
+     * cache.
+     */
+    abstract diff<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: Cache.DiffOptions<TData, TVariables>): Cache.DiffResult<TData>;
+    abstract watch<TData = unknown, TVariables extends OperationVariables = OperationVariables>(watch: Cache.WatchOptions<TData, TVariables>): () => void;
+    abstract reset(options?: Cache.ResetOptions): Promise<void>;
+    abstract evict(options: Cache.EvictOptions): boolean;
+    /**
+     * Replaces existing state in the cache (if any) with the values expressed by
+     * `serializedState`.
+     *
+     * Called when hydrating a cache (server side rendering, or offline storage),
+     * and also (potentially) during hot reloads.
+     */
+    abstract restore(serializedState: unknown): this;
+    /**
+     * Exposes the cache's complete state, in a serializable format for later restoration.
+     */
+    abstract extract(optimistic?: boolean): unknown;
+    abstract removeOptimistic(id: string): void;
+    abstract fragmentMatches(fragment: InlineFragmentNode | FragmentDefinitionNode, typename: string): boolean;
+    lookupFragment(fragmentName: string): FragmentDefinitionNode | null;
+    /**
+     * Determines whether a `@client` field can be resolved by the cache. Used
+     * when `LocalState` does not have a local resolver that can resolve the
+     * field.
+     *
+     * @remarks Cache implementations should return `true` if a mechanism in the
+     * cache is expected to provide a value for the field. `LocalState` will set
+     * the value of the field to `undefined` in order for the cache to handle it.
+     *
+     * Cache implementations should return `false` to indicate that it cannot
+     * handle resolving the field (either because it doesn't have a mechanism to
+     * do so, or because the user hasn't provided enough information to resolve
+     * the field). Returning `false` will emit a warning and set the value of the
+     * field to `null`.
+     *
+     * A cache that doesn't implement `resolvesClientField` will be treated the
+     * same as returning `false`.
+     */
+    resolvesClientField?(typename: string, fieldName: string): boolean;
+    /**
+     * Executes multiple cache operations as a single batch, ensuring that
+     * watchers are only notified once after all operations complete. This is
+     * useful for improving performance when making multiple cache updates, as it
+     * prevents unnecessary re-renders or query refetches between individual
+     * operations.
+     *
+     * The `batch` method supports both optimistic and non-optimistic updates, and
+     * provides fine-grained control over which cache layer receives the updates
+     * and when watchers are notified.
+     *
+     * For usage instructions, see [Interacting with cached data: `cache.batch`](https://www.apollographql.com/docs/react/caching/cache-interaction#using-cachebatch).
+     *
+     * @example
+     *
+     * ```js
+     * cache.batch({
+     *   update(cache) {
+     *     cache.writeQuery({
+     *       query: GET_TODOS,
+     *       data: { todos: updatedTodos },
+     *     });
+     *     cache.evict({ id: "Todo:123" });
+     *   },
+     * });
+     * ```
+     *
+     * @example
+     *
+     * ```js
+     * // Optimistic update with a custom layer ID
+     * cache.batch({
+     *   optimistic: "add-todo-optimistic",
+     *   update(cache) {
+     *     cache.modify({
+     *       fields: {
+     *         todos(existing = []) {
+     *           return [...existing, newTodoRef];
+     *         },
+     *       },
+     *     });
+     *   },
+     * });
+     * ```
+     *
+     * @returns The return value of the `update` function.
+     */
+    batch<U>(options: Cache.BatchOptions<this, U>): U;
+    abstract performTransaction(transaction: Transaction, optimisticId?: string | null): void;
+    recordOptimisticTransaction(transaction: Transaction, optimisticId: string): void;
+    transformDocument(document: DocumentNode): DocumentNode;
+    transformForLink(document: DocumentNode): DocumentNode;
+    identify(object: StoreObject | Reference): string | undefined;
+    gc(): string[];
+    modify<Entity extends Record<string, any> = Record<string, any>>(options: Cache.ModifyOptions<Entity>): boolean;
+    /**
+     * Read data from the cache for the specified query.
+     */
+    readQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ query, variables, id, optimistic, returnPartialData, }: Cache.ReadQueryOptions<TData, TVariables>): Unmasked<TData> | null;
+    /**
+    * Read data from the cache for the specified query.
+    */
+    readQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache.ReadQueryOptions<TData, TVariables>, 
+    /**
+     * @deprecated Pass the `optimistic` argument as part of the first argument
+     * instead of passing it as a separate option.
+     */
+    optimistic: boolean): Unmasked<TData> | null;
+    private fragmentWatches;
+    watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloCache.WatchFragmentOptions<TData, TVariables> & {
+        from: Array<ApolloCache.FromOptionValue<TData>>;
+    }): ApolloCache.ObservableFragment<Array<Unmasked<TData>>>;
+    watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloCache.WatchFragmentOptions<TData, TVariables> & {
+        from: Array<null>;
+    }): ApolloCache.ObservableFragment<Array<null>>;
+    watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloCache.WatchFragmentOptions<TData, TVariables> & {
+        from: Array<ApolloCache.FromOptionValue<TData> | null>;
+    }): ApolloCache.ObservableFragment<Array<Unmasked<TData> | null>>;
+    watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloCache.WatchFragmentOptions<TData, TVariables> & {
+        from: null;
+    }): ApolloCache.ObservableFragment<null>;
+    watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloCache.WatchFragmentOptions<TData, TVariables> & {
+        from: ApolloCache.FromOptionValue<TData>;
+    }): ApolloCache.ObservableFragment<Unmasked<TData>>;
+    watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloCache.WatchFragmentOptions<TData, TVariables>): ApolloCache.ObservableFragment<Unmasked<TData> | null>;
+    /**
+     * Can be overridden by subclasses to delay calling the provided callback
+     * until after all broadcasts have been completed - e.g. in a cache scenario
+     * where many watchers are notified in parallel.
+     */
+    protected onAfterBroadcast: (cb: () => void) => void;
+    private watchSingleFragment;
+    private getFragmentDoc;
+    /**
+     * Read data from the cache for the specified fragment.
+     */
+    readFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ fragment, variables, fragmentName, id, from, optimistic, returnPartialData, }: Cache.ReadFragmentOptions<TData, TVariables>): Unmasked<TData> | null;
+    readFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache.ReadFragmentOptions<TData, TVariables>, 
+    /**
+     * @deprecated Pass the `optimistic` argument as part of the first argument
+     * instead of passing it as a separate option.
+     */
+    optimistic: boolean): Unmasked<TData> | null;
+    /**
+     * Writes data to the root of the cache using the specified query to validate that
+     * the shape of the data you’re writing to the cache is the same as the shape of
+     * the data required by the query. Great for prepping the cache with initial data.
+     */
+    writeQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ data, query, variables, overwrite, id, broadcast, }: Cache.WriteQueryOptions<TData, TVariables>): Reference | undefined;
+    /**
+     * Similar to `writeQuery` (writes data to the cache) but uses the specified
+     * fragment to validate that the shape of the data you’re writing to the cache
+     * is the same as the shape of the data required by the fragment.
+     */
+    writeFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ data, fragment, fragmentName, variables, overwrite, id, from, broadcast, }: Cache.WriteFragmentOptions<TData, TVariables>): Reference | undefined;
+    updateQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache.UpdateQueryOptions<TData, TVariables>, update: (data: Unmasked<TData> | null) => Unmasked<TData> | null | void): Unmasked<TData> | null;
+    updateFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache.UpdateFragmentOptions<TData, TVariables>, update: (data: Unmasked<TData> | null) => Unmasked<TData> | null | void): Unmasked<TData> | null;
+    private toCacheId;
+    /**
+    * @experimental
+    * @internal
+    * This is not a stable API - it is used in development builds to expose
+    * information to the DevTools.
+    * Use at your own risk!
+    * 
+    * @deprecated This is an internal API and should not be used directly. This can be removed or changed at any time.
+    */
+    getMemoryInternals?: typeof getApolloCacheMemoryInternals;
+}
+//# sourceMappingURL=cache.d.cts.map

package/__cjs/cache/core/types/Cache.cjs

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Cache.cjs.map

package/__cjs/cache/core/types/Cache.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"Cache.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/__cjs/cache/core/types/Cache.d.cts

@@ -0,0 +1,302 @@
+import type { DataValue, DocumentNode, OperationVariables, TypedDocumentNode } from "@apollo/client";
+import type { Unmasked } from "@apollo/client/masking";
+import type { ExtensionsWithStreamInfo } from "@apollo/client/utilities/internal";
+import type { ApolloCache } from "../cache.cjs";
+import type { AllFieldsModifier, MissingFieldError, Modifiers } from "./common.cjs";
+export declare namespace Cache {
+    type WatchCallback<TData = unknown> = (diff: Cache.DiffResult<TData>, lastDiff?: Cache.DiffResult<TData>) => void;
+    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 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;
+        /**
+         * GraphQL extensions for the write operation. Any provided `extensions`
+         * are available in `merge` functions.
+         */
+        extensions?: ExtensionsWithStreamInfo;
+    }
+    interface DiffOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> extends Omit<ReadOptions<TData, TVariables>, "rootId"> {
+    }
+    interface WatchOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> extends DiffOptions<TData, TVariables> {
+        watcher?: object;
+        immediate?: boolean;
+        callback: WatchCallback<TData>;
+        lastDiff?: DiffResult<TData>;
+    }
+    interface EvictOptions {
+        id?: string;
+        fieldName?: string;
+        args?: Record<string, any>;
+        broadcast?: boolean;
+    }
+    interface ResetOptions {
+        discardWatches?: boolean;
+    }
+    interface ModifyOptions<Entity extends Record<string, any> = Record<string, any>> {
+        id?: string;
+        fields: Modifiers<Entity> | AllFieldsModifier<Entity>;
+        optimistic?: boolean;
+        broadcast?: boolean;
+    }
+    interface BatchOptions<TCache extends ApolloCache, TUpdateResult = void> {
+        /**
+         * A function that performs cache operations. Receives the cache instance as its argument.
+         *
+         * The return value of this function becomes the return value of `batch`.
+         */
+        update(cache: TCache): TUpdateResult;
+        /**
+         * Controls how optimistic data is handled:
+         *
+         * - `string`: Creates a new optimistic layer with this ID. Use `removeOptimistic` later to remove it.
+         * - `true`: Updates the current top layer of the cache (including any optimistic data).
+         * - `false`: Updates only the root (non-optimistic) cache data.
+         *
+         * @defaultValue false
+         */
+        optimistic?: string | boolean;
+        /**
+         * If provided, removes the optimistic layer with this ID after the batch completes.
+         *
+         * This is useful for atomically applying server data while removing a pending optimistic update, triggering at most one broadcast for both operations.
+         *
+         * Note: this option is needed because calling `cache.removeOptimistic` during the transaction function may not be safe, since any modifications to cache layers may be discarded after the transaction finishes.
+         */
+        removeOptimistic?: string;
+        /**
+         * Optional callback invoked for each watcher affected by the batch operation.
+         *
+         * Receives the watch options, the new diff result, and optionally the previous diff result.
+         *
+         * Return `false` to prevent broadcasting to that specific watcher.
+         */
+        onWatchUpdated?: (this: TCache, watch: Cache.WatchOptions, diff: Cache.DiffResult<any>, lastDiff?: Cache.DiffResult<any> | undefined) => any;
+    }
+    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;
+    }
+    type ReadFragmentOptions<TData, TVariables extends OperationVariables> = {
+        /**
+         * 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;
+    } & Cache.CacheIdentifierOption<TData>;
+    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;
+        /**
+         * GraphQL extensions for the write operation. Any provided `extensions`
+         * are available in `merge` functions.
+         */
+        extensions?: ExtensionsWithStreamInfo;
+    }
+    type WriteFragmentOptions<TData, TVariables extends OperationVariables> = {
+        /**
+         * 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;
+    } & Cache.CacheIdentifierOption<TData>;
+    interface UpdateQueryOptions<TData, TVariables extends OperationVariables> extends Omit<ReadQueryOptions<TData, TVariables> & WriteQueryOptions<TData, TVariables>, "data"> {
+    }
+    type UpdateFragmentOptions<TData, TVariables extends OperationVariables> = Omit<ReadFragmentOptions<TData, TVariables> & WriteFragmentOptions<TData, TVariables>, "data" | "id" | "from"> & Cache.CacheIdentifierOption<TData>;
+    type DiffResult<TData> = {
+        result: DataValue.Complete<TData>;
+        complete: true;
+        missing?: never;
+        fromOptimisticTransaction?: boolean;
+    } | {
+        result: DataValue.Partial<TData> | null;
+        complete: false;
+        missing?: MissingFieldError;
+        fromOptimisticTransaction?: boolean;
+    };
+    type CacheIdentifierOption<TData> = {
+        /**
+         * 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;
+        /**
+         * An object containing a `__typename` and primary key fields
+         * (such as `id`) identifying the entity object from which the fragment will
+         * be retrieved, or a `{ __ref: "..." }` reference, or a `string` ID
+         * (uncommon).
+         *
+         * @remarks
+         * `from` is given precedence over `id` when both are provided.
+         */
+        from?: never;
+    } | {
+        /**
+         * 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?: never;
+        /**
+         * An object containing a `__typename` and primary key fields
+         * (such as `id`) identifying the entity object from which the fragment will
+         * be retrieved, or a `{ __ref: "..." }` reference, or a `string` ID
+         * (uncommon).
+         *
+         * @remarks
+         * `from` is given precedence over `id` when both are provided.
+         */
+        from?: ApolloCache.FromOptionValue<TData>;
+    };
+}
+//# sourceMappingURL=Cache.d.cts.map

package/__cjs/cache/core/types/common.cjs

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MissingFieldError = void 0;
+class MissingFieldError extends Error {
+    message;
+    path;
+    query;
+    variables;
+    constructor(message, path, query, variables) {
+        // 'Error' breaks prototype chain here
+        super(message);
+        this.message = message;
+        this.path = path;
+        this.query = query;
+        this.variables = variables;
+        this.name = "MissingFieldError";
+        if (Array.isArray(this.path)) {
+            this.missing = this.message;
+            for (let i = this.path.length - 1; i >= 0; --i) {
+                this.missing = { [this.path[i]]: this.missing };
+            }
+        }
+        else {
+            this.missing = this.path;
+        }
+        // We're not using `Object.setPrototypeOf` here as it isn't fully supported
+        // on Android (see issue #3236).
+        this.__proto__ = MissingFieldError.prototype;
+    }
+    missing;
+}
+exports.MissingFieldError = MissingFieldError;
+//# sourceMappingURL=common.cjs.map

package/__cjs/cache/core/types/common.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.cjs","sources":["../../../../../src/cache/core/types/common.ts"],"sourcesContent":["import type { DocumentNode, FieldNode } from \"graphql\";\n\nimport type {\n  AsStoreObject,\n  DeepPartial,\n  isReference,\n  Reference,\n  StoreObject,\n  StoreValue,\n} from \"@apollo/client/utilities\";\n\nimport type { StorageType } from \"../../inmemory/policies.js\";\n\n// The Readonly<T> type only really works for object types, since it marks\n// all of the object's properties as readonly, but there are many cases when\n// a generic type parameter like TExisting might be a string or some other\n// primitive type, in which case we need to avoid wrapping it with Readonly.\n// SafeReadonly<string> collapses to just string, which makes string\n// assignable to SafeReadonly<any>, whereas string is not assignable to\n// Readonly<any>, somewhat surprisingly.\nexport type SafeReadonly<T> = T extends object ? Readonly<T> : T;\n\nexport type MissingTree =\n  | string\n  | {\n      readonly [key: string]: MissingTree;\n    };\n\nexport class MissingFieldError extends Error {\n  constructor(\n    public readonly message: string,\n    public readonly path: MissingTree | Array<string | number>,\n    public readonly query: DocumentNode,\n    public readonly variables?: Record<string, any>\n  ) {\n    // 'Error' breaks prototype chain here\n    super(message);\n    this.name = \"MissingFieldError\";\n\n    if (Array.isArray(this.path)) {\n      this.missing = this.message;\n      for (let i = this.path.length - 1; i >= 0; --i) {\n        this.missing = { [this.path[i]]: this.missing };\n      }\n    } else {\n      this.missing = this.path;\n    }\n\n    // We're not using `Object.setPrototypeOf` here as it isn't fully supported\n    // on Android (see issue #3236).\n    (this as any).__proto__ = MissingFieldError.prototype;\n  }\n\n  public readonly missing: MissingTree;\n}\n\nexport interface FieldSpecifier {\n  typename?: string;\n  fieldName: string;\n  field?: FieldNode;\n  args?: Record<string, any>;\n  variables?: Record<string, any>;\n}\n\nexport interface ReadFieldOptions extends FieldSpecifier {\n  from?: StoreObject | Reference;\n}\n\nexport interface ReadFieldFunction {\n  <V = StoreValue>(options: ReadFieldOptions): SafeReadonly<V> | undefined;\n  <V = StoreValue>(\n    fieldName: string,\n    from?: StoreObject | Reference\n  ): SafeReadonly<V> | undefined;\n}\n\nexport type ToReferenceFunction = (\n  objOrIdOrRef: StoreObject | string | Reference,\n  mergeIntoStore?: boolean\n) => Reference | undefined;\n\nexport type CanReadFunction = (value: StoreValue) => boolean;\n\ndeclare const _deleteModifier: unique symbol;\nexport interface DeleteModifier {\n  [_deleteModifier]: true;\n}\ndeclare const _invalidateModifier: unique symbol;\nexport interface InvalidateModifier {\n  [_invalidateModifier]: true;\n}\ndeclare const _ignoreModifier: unique symbol;\nexport interface IgnoreModifier {\n  [_ignoreModifier]: true;\n}\n\nexport type ModifierDetails = {\n  DELETE: DeleteModifier;\n  INVALIDATE: InvalidateModifier;\n  fieldName: string;\n  storeFieldName: string;\n  readField: ReadFieldFunction;\n  canRead: CanReadFunction;\n  isReference: typeof isReference;\n  toReference: ToReferenceFunction;\n  storage: StorageType;\n};\n\nexport type Modifier<T> = (\n  value: T,\n  details: ModifierDetails\n) => DeepPartial<T> | DeleteModifier | InvalidateModifier | undefined;\n\ntype StoreObjectValueMaybeReference<StoreVal> =\n  StoreVal extends ReadonlyArray<Record<string, any>> ?\n    StoreVal extends ReadonlyArray<infer Item> ?\n      [Item] extends [Record<string, any>] ?\n        ReadonlyArray<AsStoreObject<Item> | Reference>\n      : never\n    : never\n  : StoreVal extends Record<string, any> ? AsStoreObject<StoreVal> | Reference\n  : StoreVal;\n\nexport type AllFieldsModifier<Entity extends Record<string, any>> = Modifier<\n  Entity[keyof Entity] extends infer Value ?\n    StoreObjectValueMaybeReference<Exclude<Value, undefined>>\n  : never\n>;\n\nexport type Modifiers<T extends Record<string, any> = Record<string, unknown>> =\n  Partial<{\n    [FieldName in keyof T]: Modifier<\n      StoreObjectValueMaybeReference<Exclude<T[FieldName], undefined>>\n    >;\n  }>;\n"],"names":[],"mappings":";;;AA4BA,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAuC,CAAvC,CAAA,CAAA,CAAA,EAAA;IAEoB,CAApB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;IACoB,CAApB,CAAA,CAAA,CAAA;IACoB,CAApB,CAAA,CAAA,CAAA,CAAA;IACoB,CAApB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;IAJE,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACoB,CADpB,CAAA,CAAA,CAAA,CAAA,CAAA,CACmC,EACf,CAFpB,CAAA,CAAA,CAE8D,EAC1C,CAHpB,CAAA,CAAA,CAAA,CAGuC,EACnB,CAJpB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAImD,EAJnD;QAMI,CAAJ,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA;QACI,CAAJ,CAAA,CAAA,CAAA,CAAS,CAAC,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiB,CAAC;QANE,CAApB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAoB,CAApB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA2B;QACP,CAApB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAoB,CAApB,CAAA,CAAA,CAAwB;QACJ,CAApB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAoB,CAApB,CAAA,CAAA,CAAA,CAAyB;QACL,CAApB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAoB,CAApB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B;QAIzB,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,CAAmC;QAE/B,CAAJ,EAAA,CAAQ,CAAR,CAAA,CAAA,CAAA,CAAa,CAAC,CAAd,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqB,CAAC,CAAtB,CAAA,CAAA,CAA0B,CAAC,CAA3B,CAAA,CAAA,CAA+B,CAAC,EAAE;YAC5B,CAAN,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAqB,CAArB,CAAA,CAAA,CAAyB,CAAC,CAA1B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiC;YAC3B,CAAN,CAAA,EAAA,CAAW,CAAX,CAAA,EAAe,EAAf,EAAmB,CAAnB,CAAA,CAAA,CAAuB,CAAC,CAAxB,CAAA,CAAA,CAA4B,CAAC,CAA7B,CAAA,CAAA,CAAA,CAAA,EAAA,EAAsC,CAAC,EAAE,EAAzC,CAAA,EAA8C,CAAC,EAAE,CAAjD,CAAmD,CAAC,EAAE;gBAC9C,CAAR,CAAA,CAAA,CAAY,CAAC,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAuB,EAAE,CAAC,CAA1B,CAAA,CAAA,CAA8B,CAAC,CAA/B,CAAA,CAAA,CAAmC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAzC,CAAA,CAAA,CAA6C,CAAC,CAA9C,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAuD;YACjD;QACF;QAAJ,CAAA,CAAA,CAAA,EAAW;YACL,CAAN,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAqB,CAArB,CAAA,CAAA,CAAyB,CAAC,CAA1B,CAAA,CAAA,CAA8B;QAC1B;QAEA,CAAJ,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;QACI,CAAJ,EAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;QACK,CAAL,CAAA,CAAA,CAAiB,CAAC,CAAlB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAA8B,CAA9B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA+C,CAAC,CAAhD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyD;IACvD;IAEgB,CAAlB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB;AACzB;AA1BA,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;"}