@warp-drive/json-api 5.9.0-beta.0 → 5.9.0-beta.1

package/CHANGELOG.md

@@ -1 +1,110 @@
 # @warp-drive/json-api changelog
+
+## v5.8.0 (2025-10-07)
+
+#### :house: Internal
+
+* [#10349](https://github.com/warp-drive-data/warp-drive/pull/10349) chore: update all emberjs/data links to warp-drive-data/warp-drive ([@runspired](https://github.com/runspired))
+
+#### Committers: (1)
+
+Chris Thoburn ([@runspired](https://github.com/runspired))
+
+## v5.7.0 (2025-08-26)
+
+#### :memo: Documentation
+
+* [#10295](https://github.com/warp-drive-data/warp-drive/pull/10295) Update json-api.org URLs to jsonapi.org ([@Copilot](https://github.com/apps/copilot-swe-agent))
+
+#### :house: Internal
+
+* [#10130](https://github.com/warp-drive-data/warp-drive/pull/10130) chore: bump pnpm version ([@runspired](https://github.com/runspired))
+* [#10124](https://github.com/warp-drive-data/warp-drive/pull/10124) chore: mark a few types as private ([@runspired](https://github.com/runspired))
+
+#### Committers: (2)
+
+
+Chris Thoburn ([@runspired](https://github.com/runspired))
+
+## v5.6.0 (2025-07-01)
+
+#### :memo: Documentation
+
+* [#9991](https://github.com/warp-drive-data/warp-drive/pull/9991) chore: improve output of typedoc ([@runspired](https://github.com/runspired))
+* [#9989](https://github.com/warp-drive-data/warp-drive/pull/9989) [BREAKING] docs: integrate API docs to the new docs site ([@runspired](https://github.com/runspired))
+* [#9983](https://github.com/warp-drive-data/warp-drive/pull/9983) feat: revamp guide, make builder typing easier ([@runspired](https://github.com/runspired))
+
+#### :rocket: Enhancement
+
+* [#10011](https://github.com/warp-drive-data/warp-drive/pull/10011) feat: @warp-drive/core/build-config ([@runspired](https://github.com/runspired))
+* [#10003](https://github.com/warp-drive-data/warp-drive/pull/10003) feat: @warp-drive/json-api ([@runspired](https://github.com/runspired))
+
+#### :house: Internal
+
+* [#10042](https://github.com/warp-drive-data/warp-drive/pull/10042) chore: upgrade to vite7 ([@runspired](https://github.com/runspired))
+* [#10040](https://github.com/warp-drive-data/warp-drive/pull/10040) chore: isolated declarations ([@runspired](https://github.com/runspired))
+* [#10039](https://github.com/warp-drive-data/warp-drive/pull/10039) chore: bump pnpm ([@runspired](https://github.com/runspired))
+
+#### Committers: (1)
+
+Chris Thoburn ([@runspired](https://github.com/runspired))
+
+## v5.5.0 (2025-05-08)
+
+#### :memo: Documentation
+
+* [#9975](https://github.com/warp-drive-data/warp-drive/pull/9975) types: fixup PolarisMode schema types to check better ([@runspired](https://github.com/runspired))
+
+#### :rocket: Enhancement
+
+* [#9965](https://github.com/warp-drive-data/warp-drive/pull/9965) feat: universal reactivity hooks ([@runspired](https://github.com/runspired))
+
+#### :house: Internal
+
+* [#9965](https://github.com/warp-drive-data/warp-drive/pull/9965) feat: universal reactivity hooks ([@runspired](https://github.com/runspired))
+
+#### Committers: (1)
+
+Chris Thoburn ([@runspired](https://github.com/runspired))
+
+## v5.4.0 (2025-04-11)
+
+#### :memo: Documentation
+
+* [#9472](https://github.com/warp-drive-data/warp-drive/pull/9472) fix: code snippet in json-api/request api docs ([@MehulKChaudhari](https://github.com/MehulKChaudhari))
+
+#### :rocket: Enhancement
+
+* [#9884](https://github.com/warp-drive-data/warp-drive/pull/9884) feat: cache patch operations for relationships and documents ([@runspired](https://github.com/runspired))
+* [#9896](https://github.com/warp-drive-data/warp-drive/pull/9896) feat: whoa debugging ([@runspired](https://github.com/runspired))
+* [#9769](https://github.com/warp-drive-data/warp-drive/pull/9769) chore: remove restriction on new field kinds being used with legacy mode ([@runspired](https://github.com/runspired))
+* [#9676](https://github.com/warp-drive-data/warp-drive/pull/9676) Feat: hasMany linksMode ([@leoeuclids](https://github.com/leoeuclids))
+* [#9686](https://github.com/warp-drive-data/warp-drive/pull/9686) feat: immutable records should show only remote state, make builder types more useful ([@runspired](https://github.com/runspired))
+* [#9687](https://github.com/warp-drive-data/warp-drive/pull/9687) feat: add patchRecord util to JSON:API ([@runspired](https://github.com/runspired))
+* [#9585](https://github.com/warp-drive-data/warp-drive/pull/9585) chore: stub out linksMode work ([@runspired](https://github.com/runspired))
+* [#9541](https://github.com/warp-drive-data/warp-drive/pull/9541) feat: eslint-plugin-(ember-data|warp-drive) ([@runspired](https://github.com/runspired))
+
+#### :bug: Bug Fix
+
+* [#9698](https://github.com/warp-drive-data/warp-drive/pull/9698) fix: Don't notify changes for attributes not registered with the schema ([@gitKrystan](https://github.com/gitKrystan))
+* [#9692](https://github.com/warp-drive-data/warp-drive/pull/9692) fix: make serialize utils smarter ([@runspired](https://github.com/runspired))
+
+#### :house: Internal
+
+* [#9780](https://github.com/warp-drive-data/warp-drive/pull/9780) chore: bump @glimmer/component ([@runspired](https://github.com/runspired))
+* [#9761](https://github.com/warp-drive-data/warp-drive/pull/9761) chore: reduce simple Map/Set ops ([@runspired](https://github.com/runspired))
+* [#9759](https://github.com/warp-drive-data/warp-drive/pull/9759) chore: Improve contributing experience ([@runspired](https://github.com/runspired))
+* [#9752](https://github.com/warp-drive-data/warp-drive/pull/9752) chore: tooling upgrades to support WarpDrive package unification ([@runspired](https://github.com/runspired))
+* [#9705](https://github.com/warp-drive-data/warp-drive/pull/9705) chore: make diagnostic shutdown safer, use bun for holodeck server ([@runspired](https://github.com/runspired))
+* [#9699](https://github.com/warp-drive-data/warp-drive/pull/9699) chore: update to pnpm 10 ([@runspired](https://github.com/runspired))
+* [#9629](https://github.com/warp-drive-data/warp-drive/pull/9629) fix: restore * versions and setup publish to not overwrite them ([@runspired](https://github.com/runspired))
+* [#9620](https://github.com/warp-drive-data/warp-drive/pull/9620) Starwars ([@NullVoxPopuli](https://github.com/NullVoxPopuli))
+* [#9596](https://github.com/warp-drive-data/warp-drive/pull/9596) chore: Remove unused `--report-unused-disable-directives` flag ([@gitKrystan](https://github.com/gitKrystan))
+
+#### Committers: (5)
+
+Mehul Kiran Chaudhari ([@MehulKChaudhari](https://github.com/MehulKChaudhari))
+Chris Thoburn ([@runspired](https://github.com/runspired))
+Leo Euclides ([@leoeuclids](https://github.com/leoeuclids))
+Krystan HuffMenne ([@gitKrystan](https://github.com/gitKrystan))
+[@NullVoxPopuli](https://github.com/NullVoxPopuli)

package/README.md

@@ -18,7 +18,7 @@
 
 # @warp-drive/json-api
 
-A {json:api} Cache Implementation for ***Warp*Drive**.
+A [{json:api}](https://jsonapi.org) Cache Implementation for ***Warp*Drive**.
 
 `{json:api}` excels at simplifying common complex problems around cache consistency and information density, especially in regards to relational or polymorphic data.
 

package/declarations/index.d.ts

@@ -1,5 +1,515 @@
+import { Graph } from "@warp-drive/core/graph/-private";
+import { CacheCapabilitiesManager } from "@warp-drive/core/types";
+import { Cache, ChangedAttributesHash, RelationshipDiff } from "@warp-drive/core/types/cache";
+import { Change } from "@warp-drive/core/types/cache/change";
+import { Operation } from "@warp-drive/core/types/cache/operations";
+import { CollectionRelationship, ResourceRelationship } from "@warp-drive/core/types/cache/relationship";
+import { LocalRelationshipOperation } from "@warp-drive/core/types/graph";
+import { RequestKey, ResourceKey } from "@warp-drive/core/types/identifier";
+import { Value } from "@warp-drive/core/types/json/raw";
+import { RequestContext, StructuredDataDocument, StructuredDocument, StructuredErrorDocument } from "@warp-drive/core/types/request";
+import { CollectionResourceDataDocument, ResourceDocument, ResourceErrorDocument, ResourceMetaDocument, SingleResourceDataDocument } from "@warp-drive/core/types/spec/document";
+import { ApiError } from "@warp-drive/core/types/spec/error";
+import { CollectionResourceDocument, ExistingResourceObject, ResourceObject, SingleResourceDocument } from "@warp-drive/core/types/spec/json-api-raw";
+//#region src/-private/cache.d.ts
+interface CachedResource {
+  id: string | null;
+  remoteAttrs: Record<string, Value | undefined> | null;
+  localAttrs: Record<string, Value | undefined> | null;
+  defaultAttrs: Record<string, Value | undefined> | null;
+  inflightAttrs: Record<string, Value | undefined> | null;
+  changes: Record<string, [Value | undefined, Value]> | null;
+  errors: ApiError[] | null;
+  isNew: boolean;
+  isDeleted: boolean;
+  isDeletionCommitted: boolean;
+  /**
+   * debugging only
+   *
+   * @internal
+   */
+  inflightRelationships?: Record<string, unknown> | null;
+}
 /**
-* @module
-* @mergeModuleWith <project>
-*/
-export { JSONAPICache } from "./-private/cache.js";
+ * ```ts
+ * import { JSONAPICache } from '@warp-drive/json-api';
+ * ```
+ *
+ * A {@link Cache} implementation tuned for [{json:api}](https://jsonapi.org/)
+ *
+ * @categoryDescription Cache Management
+ * APIs for primary cache management functionality
+ * @categoryDescription Cache Forking
+ * APIs that support Cache Forking
+ * @categoryDescription SSR Support
+ * APIs that support SSR functionality
+ * @categoryDescription Resource Lifecycle
+ * APIs that support management of resource data
+ * @categoryDescription Resource Data
+ * APIs that support granular field level management of resource data
+ * @categoryDescription Resource State
+ * APIs that support managing Resource states
+ *
+ * @public
+ */
+declare class JSONAPICache implements Cache {
+  /**
+   * The Cache Version that this implementation implements.
+   *
+   * @public
+   */
+  version: "2";
+  /** @internal */
+  _capabilities: CacheCapabilitiesManager;
+  /** @internal */
+  __cache: Map<ResourceKey, CachedResource>;
+  /** @internal */
+  __destroyedCache: Map<ResourceKey, CachedResource>;
+  /** @internal */
+  __documents: Map<string, StructuredDocument<ResourceDocument>>;
+  /** @internal */
+  __graph: Graph;
+  constructor(capabilities: CacheCapabilitiesManager);
+  /**
+   * Cache the response to a request
+   *
+   * Implements `Cache.put`.
+   *
+   * Expects a StructuredDocument whose `content` member is a JsonApiDocument.
+   *
+   * ```js
+   * cache.put({
+   *   request: { url: 'https://api.example.com/v1/user/1' },
+   *   content: {
+   *     data: {
+   *       type: 'user',
+   *       id: '1',
+   *       attributes: {
+   *         name: 'Chris'
+   *       }
+   *     }
+   *   }
+   * })
+   * ```
+   *
+   * > **Note**
+   * > The nested `content` and `data` members are not a mistake. This is because
+   * > there are two separate concepts involved here, the `StructuredDocument` which contains
+   * > the context of a given Request that has been issued with the returned contents as its
+   * > `content` property, and a `JSON:API Document` which is the json contents returned by
+   * > this endpoint and which uses its `data` property to signify which resources are the
+   * > primary resources associated with the request.
+   *
+   * StructuredDocument's with urls will be cached as full documents with
+   * associated resource membership order and contents preserved but linked
+   * into the cache.
+   *
+   * @category Cache Management
+   * @public
+   */
+  put<T extends SingleResourceDocument>(doc: StructuredDataDocument<T>): SingleResourceDataDocument;
+  put<T extends CollectionResourceDocument>(doc: StructuredDataDocument<T>): CollectionResourceDataDocument;
+  put<T extends ResourceErrorDocument>(doc: StructuredErrorDocument<T>): ResourceErrorDocument;
+  put<T extends ResourceMetaDocument>(doc: StructuredDataDocument<T>): ResourceMetaDocument;
+  /** @internal */
+  private _putDocument;
+  /** @internal */
+  private _putDocument;
+  /** @internal */
+  private _putDocument;
+  /** @internal */
+  private _putDocument;
+  /**
+   * Update the "remote" or "canonical" (persisted) state of the Cache
+   * by merging new information into the existing state.
+   *
+   * @category Cache Management
+   * @public
+   * @param op the operation or list of operations to perform
+   */
+  patch(op: Operation | Operation[]): void;
+  /**
+   * Update the "local" or "current" (unpersisted) state of the Cache
+   *
+   * @category Cache Management
+   * @public
+   */
+  mutate(mutation: LocalRelationshipOperation): void;
+  /**
+   * Peek resource data from the Cache.
+   *
+   * In development, if the return value
+   * is JSON the return value
+   * will be deep-cloned and deep-frozen
+   * to prevent mutation thereby enforcing cache
+   * Immutability.
+   *
+   * This form of peek is useful for implementations
+   * that want to feed raw-data from cache to the UI
+   * or which want to interact with a blob of data
+   * directly from the presentation cache.
+   *
+   * An implementation might want to do this because
+   * de-referencing records which read from their own
+   * blob is generally safer because the record does
+   * not require retainining connections to the Store
+   * and Cache to present data on a per-field basis.
+   *
+   * This generally takes the place of `getAttr` as
+   * an API and may even take the place of `getRelationship`
+   * depending on implementation specifics, though this
+   * latter usage is less recommended due to the advantages
+   * of the Graph handling necessary entanglements and
+   * notifications for relational data.
+   *
+   * :::warning
+   * It is not recommended to use the return value as
+   * a serialized representation of the resource both
+   * due to it containing local mutations and because
+   * it may contain additional fields not recognized
+   * by the {json:api} API implementation such as `lid` and
+   * the various internal WarpDrive bookkeeping fields.
+   * :::
+   *
+   * @category Cache Management
+   * @public
+   */
+  peek(identifier: ResourceKey): ResourceObject | null;
+  peek(identifier: RequestKey): ResourceDocument | null;
+  /**
+   * Peek the remote resource data from the Cache.
+   *
+   * @category Cache Management
+   * @public
+   */
+  peekRemoteState(identifier: ResourceKey): ResourceObject | null;
+  peekRemoteState(identifier: RequestKey): ResourceDocument | null;
+  /**
+   * Peek the Cache for the existing request data associated with
+   * a cacheable request.
+   *
+   * This is effectively the reverse of `put` for a request in
+   * that it will return the the request, response, and content
+   * whereas `peek` will return just the `content`.
+   *
+   * @category Cache Management
+   * @public
+   */
+  peekRequest(identifier: RequestKey): StructuredDocument<ResourceDocument> | null;
+  /**
+   * Push resource data from a remote source into the cache for this identifier
+   *
+   * @category Cache Management
+   * @public
+   * @return if `calculateChanges` is true then calculated key changes should be returned
+   */
+  upsert(identifier: ResourceKey, data: ExistingResourceObject, calculateChanges?: boolean): void | string[];
+  /**
+   * Create a fork of the cache from the current state.
+   *
+   * Applications should typically not call this method themselves,
+   * preferring instead to fork at the Store level, which will
+   * utilize this method to fork the cache.
+   *
+   * @category Cache Forking
+   * @private
+   */
+  fork(): Promise<Cache>;
+  /**
+   * Merge a fork back into a parent Cache.
+   *
+   * Applications should typically not call this method themselves,
+   * preferring instead to merge at the Store level, which will
+   * utilize this method to merge the caches.
+   *
+   * @category Cache Forking
+   * @private
+   */
+  merge(_cache: Cache): Promise<void>;
+  /**
+   * Generate the list of changes applied to all
+   * record in the store.
+   *
+   * Each individual resource or document that has
+   * been mutated should be described as an individual
+   * `Change` entry in the returned array.
+   *
+   * A `Change` is described by an object containing up to
+   * three properties: (1) the `identifier` of the entity that
+   * changed; (2) the `op` code of that change being one of
+   * `upsert` or `remove`, and if the op is `upsert` a `patch`
+   * containing the data to merge into the cache for the given
+   * entity.
+   *
+   * This `patch` is opaque to the Store but should be understood
+   * by the Cache and may expect to be utilized by an Adapter
+   * when generating data during a `save` operation.
+   *
+   * It is generally recommended that the `patch` contain only
+   * the updated state, ignoring fields that are unchanged
+   *
+   * ```ts
+   * interface Change {
+   *  identifier: ResourceKey | RequestKey;
+   *  op: 'upsert' | 'remove';
+   *  patch?: unknown;
+   * }
+   * ```
+   *
+   * @category Cache Forking
+   * @private
+   */
+  diff(): Promise<Change[]>;
+  /**
+   * Serialize the entire contents of the Cache into a Stream
+   * which may be fed back into a new instance of the same Cache
+   * via `cache.hydrate`.
+   *
+   * @category SSR Support
+   * @private
+   */
+  dump(): Promise<ReadableStream<unknown>>;
+  /**
+   * hydrate a Cache from a Stream with content previously serialized
+   * from another instance of the same Cache, resolving when hydration
+   * is complete.
+   *
+   * This method should expect to be called both in the context of restoring
+   * the Cache during application rehydration after SSR **AND** at unknown
+   * times during the lifetime of an already booted application when it is
+   * desired to bulk-load additional information into the cache. This latter
+   * behavior supports optimizing pre/fetching of data for route transitions
+   * via data-only SSR modes.
+   *
+   * @category SSR Support
+   * @private
+   */
+  hydrate(stream: ReadableStream<unknown>): Promise<void>;
+  /**
+   * [LIFECYCLE] Signal to the cache that a new record has been instantiated on the client
+   *
+   * It returns properties from options that should be set on the record during the create
+   * process. This return value behavior is deprecated.
+   *
+   * @category Resource Lifecycle
+   * @public
+   */
+  clientDidCreate(identifier: ResourceKey, options?: Record<string, Value>): Record<string, unknown>;
+  /**
+   * [LIFECYCLE] Signals to the cache that a resource
+   * will be part of a save transaction.
+   *
+   * @category Resource Lifecycle
+   * @public
+   */
+  willCommit(identifier: ResourceKey | ResourceKey[], _context: RequestContext | null): void;
+  /**
+   * [LIFECYCLE] Signals to the cache that a resource
+   * was successfully updated as part of a save transaction.
+   *
+   * @category Resource Lifecycle
+   * @public
+   */
+  didCommit(committedIdentifier: ResourceKey, result: StructuredDataDocument<SingleResourceDataDocument> | null): SingleResourceDataDocument;
+  didCommit(committedIdentifier: ResourceKey[], result: StructuredDataDocument<SingleResourceDataDocument> | null): SingleResourceDataDocument;
+  didCommit(committedIdentifier: ResourceKey[], result: StructuredDataDocument<CollectionResourceDataDocument> | null): CollectionResourceDataDocument;
+  /**
+   * [LIFECYCLE] Signals to the cache that a resource
+   * was update via a save transaction failed.
+   *
+   * @category Resource Lifecycle
+   * @public
+   */
+  commitWasRejected(identifier: ResourceKey | ResourceKey[], errors?: ApiError[]): void;
+  /**
+   * [LIFECYCLE] Signals to the cache that all data for a resource
+   * should be cleared.
+   *
+   * This method is a candidate to become a mutation
+   *
+   * @category Resource Lifecycle
+   * @public
+   */
+  unloadRecord(identifier: ResourceKey): void;
+  /**
+   * Retrieve the data for an attribute from the cache
+   * with local mutations applied.
+   *
+   * @category Resource Data
+   * @public
+   */
+  getAttr(identifier: ResourceKey, attr: string | string[]): Value | undefined;
+  /**
+   * Retrieve the remote data for an attribute from the cache
+   *
+   * @category Resource Data
+   * @public
+   */
+  getRemoteAttr(identifier: ResourceKey, attr: string | string[]): Value | undefined;
+  /**
+   * Mutate the data for an attribute in the cache
+   *
+   * This method is a candidate to become a mutation
+   *
+   * @category Resource Data
+   * @public
+   */
+  setAttr(identifier: ResourceKey, attr: string | string[], value: Value): void;
+  /**
+   * Query the cache for the changed attributes of a resource.
+   *
+   * @category Resource Data
+   * @public
+   * @return `{ '<field>': ['<old>', '<new>'] }`
+   */
+  changedAttrs(identifier: ResourceKey): ChangedAttributesHash;
+  /**
+   * Query the cache for whether any mutated attributes exist
+   *
+   * @category Resource Data
+   * @public
+   */
+  hasChangedAttrs(identifier: ResourceKey): boolean;
+  /**
+   * Tell the cache to discard any uncommitted mutations to attributes
+   *
+   * This method is a candidate to become a mutation
+   *
+   * @category Resource Data
+   * @public
+   * @return the names of fields that were restored
+   */
+  rollbackAttrs(identifier: ResourceKey): string[];
+  /**
+	* Query the cache for the changes to relationships of a resource.
+	*
+	* Returns a map of relationship names to RelationshipDiff objects.
+	*
+	* ```ts
+	* type RelationshipDiff =
+	| {
+	kind: 'collection';
+	remoteState: ResourceKey[];
+	additions: Set<ResourceKey>;
+	removals: Set<ResourceKey>;
+	localState: ResourceKey[];
+	reordered: boolean;
+	}
+	| {
+	kind: 'resource';
+	remoteState: ResourceKey | null;
+	localState: ResourceKey | null;
+	};
+	```
+	*
+	* @category Resource Data
+	* @public
+	*/
+  changedRelationships(identifier: ResourceKey): Map<string, RelationshipDiff>;
+  /**
+   * Query the cache for whether any mutated relationships exist
+   *
+   * @category Resource Data
+   * @public
+   */
+  hasChangedRelationships(identifier: ResourceKey): boolean;
+  /**
+   * Tell the cache to discard any uncommitted mutations to relationships.
+   *
+   * This will also discard the change on any appropriate inverses.
+   *
+   * This method is a candidate to become a mutation
+   *
+   * @category Resource Data
+   * @public
+   * @return the names of relationships that were restored
+   */
+  rollbackRelationships(identifier: ResourceKey): string[];
+  /**
+   * Query the cache for the current state of a relationship property
+   *
+   * @category Resource Data
+   * @public
+   * @return resource relationship object
+   */
+  getRelationship(identifier: ResourceKey, field: string): ResourceRelationship | CollectionRelationship;
+  /**
+   * Query the cache for the remote state of a relationship property
+   *
+   * @category Resource Data
+   * @public
+   * @return resource relationship object
+   */
+  getRemoteRelationship(identifier: ResourceKey, field: string): ResourceRelationship | CollectionRelationship;
+  /**
+   * Update the cache state for the given resource to be marked
+   * as locally deleted, or remove such a mark.
+   *
+   * This method is a candidate to become a mutation
+   *
+   * @category Resource State
+   * @public
+   */
+  setIsDeleted(identifier: ResourceKey, isDeleted: boolean): void;
+  /**
+   * Query the cache for any validation errors applicable to the given resource.
+   *
+   * @category Resource State
+   * @public
+   */
+  getErrors(identifier: ResourceKey): ApiError[];
+  /**
+   * Query the cache for whether a given resource has any available data
+   *
+   * @category Resource State
+   * @public
+   */
+  isEmpty(identifier: ResourceKey): boolean;
+  /**
+   * Query the cache for whether a given resource was created locally and not
+   * yet persisted.
+   *
+   * @category Resource State
+   * @public
+   */
+  isNew(identifier: ResourceKey): boolean;
+  /**
+   * Query the cache for whether a given resource is marked as deleted (but not
+   * necessarily persisted yet).
+   *
+   * @category Resource State
+   * @public
+   */
+  isDeleted(identifier: ResourceKey): boolean;
+  /**
+   * Query the cache for whether a given resource has been deleted and that deletion
+   * has also been persisted.
+   *
+   * @category Resource State
+   * @public
+   */
+  isDeletionCommitted(identifier: ResourceKey): boolean;
+  /**
+   * Private method used to populate an entry for the identifier
+   *
+   * @internal
+   */
+  _createCache(identifier: ResourceKey): CachedResource;
+  /**
+   * Peek whether we have cached resource data matching the identifier
+   * without asserting if the resource data is missing.
+   *
+   * @internal
+   */
+  __safePeek(identifier: ResourceKey, allowDestroyed: boolean): CachedResource | undefined;
+  /**
+   * Peek whether we have cached resource data matching the identifier
+   * Asserts if the resource data is missing.
+   *
+   * @internal
+   */
+  __peek(identifier: ResourceKey, allowDestroyed: boolean): CachedResource;
+}
+//#endregion
+export { JSONAPICache };
+//# sourceMappingURL=index.d.ts.map

package/declarations/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/-private/cache.ts"],"mappings":";;;;;;;;;;;;;;UAkFU;EACR;EACA,aAAa,eAAe;EAC5B,YAAY,eAAe;EAC3B,cAAc,eAAe;EAC7B,eAAe,eAAe;EAC9B,SAAS,gBAAgB,mBAAmB;EAC5C,QAAQ;EACR;EACA;EACA;;;;;;EAOA,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;cAwCb,wBAAwB;;;;;;EAMnC;;EAGA,eAAuB;;EAEvB,SAAiB,IAAI,aAAa;;EAElC,kBAA0B,IAAI,aAAa;;EAE3C,aAAqB,YAAY,mBAAmB;;EAEpD,SAAiB;EAEjB,YAAY,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkD1B,IAAI,UAAU,wBAAwB,KAAK,uBAAuB,KAAK;EACvE,IAAI,UAAU,4BAA4B,KAAK,uBAAuB,KAAK;EAC3E,IAAI,UAAU,uBAAuB,KAAK,wBAAwB,KAAK;EACvE,IAAI,UAAU,sBAAsB,KAAK,uBAAuB,KAAK;;UA6G7D;;UAMA;;UAMA;;UAMA;;;;;;;;;EAoER,MAAM,IAAI,YAAY;;;;;;;EA4BtB,OAAO,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA2DjB,KAAK,YAAY,cAAc;EAC/B,KAAK,YAAY,aAAa;;;;;;;EAgE9B,gBAAgB,YAAY,cAAc;EAC1C,gBAAgB,YAAY,aAAa;;;;;;;;;;;;EAmEzC,YAAY,YAAY,aAAa,mBAAmB;;;;;;;;EAWxD,OAAO,YAAY,aAAa,MAAM,wBAAwB;;;;;;;;;;;EA6B9D,QAAQ,QAAQ;;;;;;;;;;;EAchB,MAAM,QAAQ,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqCtB,QAAQ,QAAQ;;;;;;;;;EAgBhB,QAAQ,QAAQ;;;;;;;;;;;;;;;;EAmBhB,QAAQ,QAAQ,0BAA0B;;;;;;;;;;EAiB1C,gBAAgB,YAAY,aAAa,UAAU,eAAe,SAAS;;;;;;;;EA8E3E,WAAW,YAAY,cAAc,eAAe,UAAU;;;;;;;;EAiB9D,UACE,qBAAqB,aACrB,QAAQ,uBAAuB,qCAC9B;EACH,UACE,qBAAqB,eACrB,QAAQ,uBAAuB,qCAC9B;EACH,UACE,qBAAqB,eACrB,QAAQ,uBAAuB,yCAC9B;;;;;;;;EAyEH,kBAAkB,YAAY,cAAc,eAAe,SAAS;;;;;;;;;;EAoBpE,aAAa,YAAY;;;;;;;;EAkFzB,QAAQ,YAAY,aAAa,0BAA0B;;;;;;;EAuE3D,cAAc,YAAY,aAAa,0BAA0B;;;;;;;;;EAmEjE,QAAQ,YAAY,aAAa,yBAAyB,OAAO;;;;;;;;EAqHjE,aAAa,YAAY,cAAc;;;;;;;EAuBvC,gBAAgB,YAAY;;;;;;;;;;EA4B5B,cAAc,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;EA+D1B,qBAAqB,YAAY,cAAc,YAAY;;;;;;;EAU3D,wBAAwB,YAAY;;;;;;;;;;;;EAepC,sBAAsB,YAAY;;;;;;;;EAiBlC,gBAAgB,YAAY,aAAa,gBAAgB,uBAAuB;;;;;;;;EAWhF,sBAAsB,YAAY,aAAa,gBAAgB,uBAAuB;;;;;;;;;;EAiBtF,aAAa,YAAY,aAAa;;;;;;;EAatC,UAAU,YAAY,cAAc;;;;;;;EAUpC,QAAQ,YAAY;;;;;;;;EAYpB,MAAM,YAAY;;;;;;;;EAYlB,UAAU,YAAY;;;;;;;;EAYtB,oBAAoB,YAAY;;;;;;EAUhC,aAAa,YAAY,cAAc;;;;;;;EAavC,WAAW,YAAY,aAAa,0BAA0B;;;;;;;EAc9D,OAAO,YAAY,aAAa,0BAA0B"}