@warp-drive-mirror/core 5.10.0-alpha.12 → 5.10.0-alpha.13

package/dist/{graph-DLqYXP2z.d.ts → graph-rjTyJ-gd.d.ts}

@@ -1,12 +1,14 @@
-import { l as ResourceKey } from "./identifier-DQnqOSJK.js";
-import { b as SingleResourceRelationship, n as CollectionResourceRelationship } from "./json-api-raw-C5APJHHB.js";
-import { r as RemoveFromResourceRelationshipMutation, t as AddToResourceRelationshipMutation } from "./mutations-CqtoGB4t.js";
-import { l as RemoveFromResourceRelationshipOperation, p as UpdateResourceRelationshipOperation, r as AddToResourceRelationshipOperation } from "./operations-D1qA6r0_.js";
+import { l as ResourceKey } from "./identifier-B_tK3FUw.js";
+import { b as SingleResourceRelationship, n as CollectionResourceRelationship } from "./json-api-raw-BxzNsCg0.js";
+import { r as RemoveFromResourceRelationshipMutation, t as AddToResourceRelationshipMutation } from "./mutations-C81gbYjB.js";
+import { l as RemoveFromResourceRelationshipOperation, p as UpdateResourceRelationshipOperation, r as AddToResourceRelationshipOperation } from "./operations-B4pQM7D6.js";
 //#region src/types/graph.d.ts
 /**
  * All Graph operations are objects with at least one property,
  * `op`, which contains a string with the name of the operation
  * to perform.
+ *
+ * @summary Base shape of every relationship Graph operation, carrying the operation's name in `op`.
  */
 interface Operation {
   /**
@@ -16,6 +18,8 @@ interface Operation {
 }
 /**
  * Replaces the state of a relationship on the Graph with a new state.
+ *
+ * @summary Graph operation that replaces a relationship's remote state with a raw JSON:API relationship object.
  */
 interface UpdateRelationshipOperation {
   /**
@@ -38,6 +42,9 @@ interface UpdateRelationshipOperation {
 /**
  * Signals to the Graph that a resource has been deleted, so that
  * it can be removed from any relationships that reference it.
+ *
+ * @summary Graph operation signaling that a resource was deleted so it is removed from every relationship that
+ * references it.
  */
 interface DeleteRecordOperation {
   /**
@@ -56,6 +63,9 @@ interface DeleteRecordOperation {
 /**
  * A placeholder operation for a relationship whose kind (`to-one` vs
  * `to-many`) is not yet known to the Graph.
+ *
+ * @summary Placeholder Graph operation, with `op: 'never'`, for a relationship whose to-one or to-many kind is not
+ * yet known.
  */
 interface UnknownOperation {
   /**
@@ -73,6 +83,8 @@ interface UnknownOperation {
 }
 /**
  * Replaces the state of a `to-one` relationship on the Graph with a new value.
+ *
+ * @summary Graph operation that sets a to-one relationship's value, or swaps a single member of a to-many.
  */
 interface ReplaceRelatedRecordOperation {
   /**
@@ -103,6 +115,8 @@ interface ReplaceRelatedRecordOperation {
 }
 /**
  * Reorders the state of a `to-many` relationship on the Graph.
+ *
+ * @summary Graph operation that reorders the members of a to-many relationship.
  */
 interface SortRelatedRecords {
   /**
@@ -125,6 +139,8 @@ interface SortRelatedRecords {
 /**
  * Replaces the state of a `to-many` relationship on the Graph with a
  * new set of values.
+ *
+ * @summary Graph operation that replaces or splices the members of a to-many relationship.
  */
 interface ReplaceRelatedRecordsOperation {
   /**
@@ -167,6 +183,8 @@ interface ReplaceRelatedRecordsOperation {
  * - {@link AddResourceOperation}
  * - {@link DeleteRecordOperation}
  * - {@link SortRelatedRecords}
+ *
+ * @summary Union of the Graph operations that update a relationship's remote (persisted) state.
  */
 type RemoteRelationshipOperation = UpdateResourceRelationshipOperation | UpdateRelationshipOperation | ReplaceRelatedRecordOperation | ReplaceRelatedRecordsOperation | RemoveFromResourceRelationshipOperation | AddToResourceRelationshipOperation | DeleteRecordOperation | SortRelatedRecords;
 /**
@@ -179,8 +197,10 @@ type RemoteRelationshipOperation = UpdateResourceRelationshipOperation | UpdateR
  * - {@link AddResourceMutation}
  * - {@link RemoveResourceMutation}
  * - {@link SortRelatedRecords}
+ *
+ * @summary Union of the Graph operations that update a relationship's local (uncommitted) state.
  */
 type LocalRelationshipOperation = ReplaceRelatedRecordsOperation | ReplaceRelatedRecordOperation | AddToResourceRelationshipMutation | RemoveFromResourceRelationshipMutation | SortRelatedRecords;
 //#endregion
 export { ReplaceRelatedRecordOperation as a, UnknownOperation as c, RemoteRelationshipOperation as i, UpdateRelationshipOperation as l, LocalRelationshipOperation as n, ReplaceRelatedRecordsOperation as o, Operation as r, SortRelatedRecords as s, DeleteRecordOperation as t };
-//# sourceMappingURL=graph-DLqYXP2z.d.ts.map
+//# sourceMappingURL=graph-rjTyJ-gd.d.ts.map

package/dist/graph-rjTyJ-gd.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"graph-rjTyJ-gd.d.ts","names":["RemoveResourceOperation","AddResourceOperation","AddResourceMutation","RemoveResourceMutation"],"sources":["../src/types/graph.ts"],"mappings":";;;;;;;;;;;;UAyBiB;;;;EAIf;;;;;;;UAQe;;;;EAIf;;;;EAIA,QAAQ;;;;EAIR;;;;EAIA,OAAO,6BAA6B;;;;;;;;;UAUrB;;;;EAIf;;;;EAIA,QAAQ;;;;EAIR;;;;;;;;;UAUe;;;;EAIf;;;;EAIA,QAAQ;;;;EAIR;;;;;;;UAQe;;;;EAIf;;;;EAIA,QAAQ;;;;EAIR;;;;;EAKA,OAAO;;;;EAIP,QAAQ;;;;EAIR;;;;;;;UAQe;;;;EAIf;;;;EAIA,QAAQ;;;;EAIR;;;;EAIA,OAAO;;;;;;;;UASQ;;;;EAIf;;;;EAIA,QAAQ;;;;EAIR;;;;;;EAMA,OAAO;;;;EAIP,QAAQ;;;;EAIR;;;;;;;;;;;;;;;;;;KAmBU,8BACR,sCACA,8BACA,gCACA,iCACAA,0CACAC,qCACA,wBACA;;;;;;;;;;;;;;KAeQ,6BACR,iCACA,gCACAC,oCACAC,yCACA"}

package/dist/{identifier-DQnqOSJK.d.ts → identifier-B_tK3FUw.d.ts}

@@ -19,6 +19,8 @@ declare const CACHE_OWNER: "__$co";
  * Identifies which "bucket" of the cache a key belongs to: resources
  * (`'record'`, see {@link ResourceKey}) or request documents
  * (`'document'`, see {@link RequestKey}).
+ *
+ * @summary Which cache bucket a key belongs to: `'record'` for resource keys or `'document'` for request keys.
  */
 type CacheKeyType = "record" | "document";
 /**
@@ -28,6 +30,11 @@ type CacheKeyType = "record" | "document";
  * Only requests that are assigned a RequestKey are retrievable/replayable from
  * the cache, though requests without RequestKeys may still update cache state.
  *
+ * The [Key Terminology](/guides/the-manual/caching/key-terms#documents) guide explains
+ * the documents it identifies.
+ *
+ * @summary Stable object with a unique `lid` that references a cached request document, letting that request's
+ * result be retrieved or replayed.
  * @public
  */
 interface RequestKey {
@@ -40,7 +47,10 @@ interface RequestKey {
    */
   type: "@document";
 }
-/** @deprecated use {@link RequestKey} */
+/**
+ * @summary Deprecated alias for `RequestKey`, the stable cache reference to a request document.
+ * @deprecated use {@link RequestKey}
+ */
 type StableDocumentIdentifier = RequestKey;
 /**
  * Used when an ResourceKey is known to be the stable version
@@ -66,6 +76,8 @@ interface ResourceKeyBase<T extends string = string> {
  * Distinguishing between this ResourceKey and one for a client created
  * resource that was created with an ID is generally speaking not possible
  * at runtime, so anything with an ID typically narrows to this.
+ *
+ * @summary Resource key whose `id` is a known string, the form keys for server-loaded resources take.
  */
 interface PersistedResourceKey<T extends string = string> extends ResourceKeyBase<T> {
   /**
@@ -75,7 +87,10 @@ interface PersistedResourceKey<T extends string = string> extends ResourceKeyBas
    */
   id: string;
 }
-/** @deprecated use {@link PersistedResourceKey} */
+/**
+ * @summary Deprecated alias for `PersistedResourceKey`, a resource key whose `id` is known.
+ * @deprecated use {@link PersistedResourceKey}
+ */
 type StableExistingRecordIdentifier<T extends string = string> = PersistedResourceKey<T>;
 /**
  * Used when a ResourceKey was created locally
@@ -85,6 +100,8 @@ type StableExistingRecordIdentifier<T extends string = string> = PersistedResour
  * that is not for a new record but does not have an ID. This would
  * happen if a user intentionally created one for use with a secondary-index
  * prior to the record having been fully loaded.
+ *
+ * @summary Resource key for a record created locally with `store.createRecord`, whose `id` may still be `null`.
  */
 interface NewResourceKey<T extends string = string> extends ResourceKeyBase<T> {
   /**
@@ -102,11 +119,19 @@ interface NewResourceKey<T extends string = string> extends ResourceKeyBase<T> {
  * Every resource has a unique ResourceKey, and ResourceKeys may refer
  * to data that has never been loaded (for instance, in an async relationship).
  *
+ * The [Key Terminology](/guides/the-manual/caching/key-terms#resources) guide explains
+ * the resources it identifies.
+ *
+ * @summary Stable object with a unique `lid` plus `type` and `id` that uniquely references one resource's data in
+ * the cache, loaded or not.
  * @public
  */
 type ResourceKey<T extends string = string> = PersistedResourceKey<T> | NewResourceKey<T>;
-/** @deprecated use {@link ResourceKey} */
+/**
+ * @summary Deprecated alias for `ResourceKey`, the stable cache reference to a single resource.
+ * @deprecated use {@link ResourceKey}
+ */
 type StableRecordIdentifier<T extends string = string> = ResourceKey<T>;
 //#endregion
 export { DEBUG_STALE_CACHE_OWNER as a, RequestKey as c, StableExistingRecordIdentifier as d, StableRecordIdentifier as f, DEBUG_KEY_TYPE as i, ResourceKey as l, CacheKeyType as n, NewResourceKey as o, DEBUG_CLIENT_ORIGINATED as r, PersistedResourceKey as s, CACHE_OWNER as t, StableDocumentIdentifier as u };
-//# sourceMappingURL=identifier-DQnqOSJK.d.ts.map
+//# sourceMappingURL=identifier-B_tK3FUw.d.ts.map

package/dist/identifier-B_tK3FUw.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identifier-B_tK3FUw.d.ts","names":[],"sources":["../src/types/identifier.ts"],"mappings":";;;;cAYa;;;;cAIA;;;;cAIA;;;;cAUA;;;;;;;;KASD;;;;;;;;;;;;;;;UAgBK;;;;EAIf;;;;EAIA;;;;;;KASU,2BAA2B;;;;UAK7B,gBAAgB;;;;;;EAMxB;;;;;;EAOA,MAAM;;;;;;;;;;;;UAqBS,qBAAqB,mCAAmC,gBAAgB;;;;;;EAMvF;;;;;;KAOU,+BAA+B,6BAA6B,qBAAqB;;;;;;;;;;;;UAa5E,eAAe,mCAAmC,gBAAgB;;;;;;;EAOjF;;;;;;;;;;;;;;;;KAiBU,YAAY,6BAA6B,qBAAqB,KAAK,eAAe;;;;;KAMlF,uBAAuB,6BAA6B,YAAY"}

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-import { D as StoreSetupOptions, Dt as CacheHandler, E as Document, Et as CachePolicy, N as Fetch, O as useRecommendedStore, Ot as StoreRequestContext, Qt as NotificationChannel, T as ConfiguredStore, X as Store, Xt as CacheOperation, Zt as DocumentCacheOperation, bt as storeFor, cn as setIdentifierResetMethod, en as NotificationType, kt as StoreRequestInput, ln as setIdentifierUpdateMethod, lr as RequestManager, on as setIdentifierForgetMethod, sn as setIdentifierGenerationMethod, tn as NotifyKeys, un as setKeyInfoForResource, vt as recordIdentifierFor } from "./internal-DBnp5uP6.js";
+import { A as Document, At as CachePolicy, L as Fetch, M as useRecommendedStore, Mt as StoreRequestContext, Nt as StoreRequestInput, St as recordIdentifierFor, an as NotifyKeys, dn as setIdentifierGenerationMethod, en as CacheOperation, et as Store, fn as setIdentifierResetMethod, in as NotificationType, j as StoreSetupOptions, jt as CacheHandler, k as ConfiguredStore, mn as setKeyInfoForResource, nn as NotificationChannel, pn as setIdentifierUpdateMethod, pr as RequestManager, tn as DocumentCacheOperation, un as setIdentifierForgetMethod, wt as storeFor } from "./internal-CgOlgOt3.js";
 export { CacheHandler, type CacheOperation, type CachePolicy, ConfiguredStore, Document, type DocumentCacheOperation, Fetch, type NotificationChannel, type NotificationType, type NotifyKeys, RequestManager, Store, type StoreRequestContext, type StoreRequestInput, StoreSetupOptions, recordIdentifierFor as cacheKeyFor, recordIdentifierFor, setIdentifierForgetMethod, setIdentifierGenerationMethod, setIdentifierResetMethod, setIdentifierUpdateMethod, setKeyInfoForResource, storeFor, useRecommendedStore };

package/dist/index.js

@@ -1,3 +1,3 @@
-import { A as setIdentifierGenerationMethod, M as setIdentifierUpdateMethod, N as setKeyInfoForResource, S as recordIdentifierFor, h as Store, j as setIdentifierResetMethod, k as setIdentifierForgetMethod, m as CacheHandler, n as RequestManager, r as Fetch, t as useRecommendedStore, w as storeFor } from "./src-B9WcEdYg.js";
+import { A as setIdentifierGenerationMethod, M as setIdentifierUpdateMethod, N as setKeyInfoForResource, S as recordIdentifierFor, h as Store, j as setIdentifierResetMethod, k as setIdentifierForgetMethod, m as CacheHandler, n as RequestManager, r as Fetch, t as useRecommendedStore, w as storeFor } from "./src-DlNeupkA.js";
 
 export { CacheHandler, Fetch, RequestManager, Store, recordIdentifierFor as cacheKeyFor, recordIdentifierFor, setIdentifierForgetMethod, setIdentifierGenerationMethod, setIdentifierResetMethod, setIdentifierUpdateMethod, setKeyInfoForResource, storeFor, useRecommendedStore };