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

package/dist/{unpkg/dev/-private-Dtj8O5W7.js → -private-CmNOwhK0.js}

@@ -7,6 +7,8 @@ const Destroy = getOrSetGlobal("Destroy", Symbol.dispose || Symbol.for("Dispose"
 * Symbol for the method used to request a mutable copy of an otherwise
 * immutable {@link ReactiveResource}.
 *
+* @summary Deprecated symbol-keyed method on a ReactiveResource that resolves with an editable copy;
+* use `checkout` instead.
 * @deprecated use the {@link checkout} utility function instead.
 */
 const Checkout = getOrSetGlobal("Checkout", Symbol("Checkout"));
@@ -19,4 +21,4 @@ const Context = getOrSetGlobal("Context", Symbol("Context"));
 
 //#endregion
 export { SOURCE as a, Destroy as i, Commit as n, Context as r, Checkout as t };
-//# sourceMappingURL=-private-Dtj8O5W7.js.map
+//# sourceMappingURL=-private-CmNOwhK0.js.map

package/dist/{-private-Dtj8O5W7.js.map → -private-CmNOwhK0.js.map}

@@ -1 +1 @@
-{"version":3,"file":"-private-Dtj8O5W7.js","names":["getOrSetGlobal","SOURCE","Symbol","Destroy","dispose","for","Checkout","Commit","Context"],"sources":["../src/reactive/-private/symbols.ts"],"sourcesContent":["///////////////////\n///// WARNING /////\n///////////////////\n\nimport { getOrSetGlobal } from '../../types/-private';\n\n// Great, got your attention with that warning didn't we?\n// Good. Here's the deal: typescript treats symbols as unique types.\n// If by accident a module creating a symbol is processed more than\n// once, the symbol will be different in each processing. This will\n// cause a type error.\n// It could also cause a runtime error if the symbol is used innapropriately.\n// However, this case is extremely hard to hit and would require other things\n// to go wrong first.\n//\n// So, why do the warning? And why do we lie about the types of the symbols?\n//\n// Because we intentionally create multiple copies of them within the types\n// at build time. This is because we rollup our d.ts files in order to give\n// our consumers a better experience.\n//\n// However, no tool today supports rolling up d.ts files with multiple entry\n// points correctly. The tool we use currently (vite-plugin-dts) uses @microsoft/api-extractor\n// which creates a fully unique stand-alone types file per-entry-point. Thus\n// every entry point that uses one of these symbols somewhere will have accidentally\n// created a new symbol type.\n//\n// This cast allows us to rollup these types using this tool while not encountering\n// the unique symbol type issue.\n//\n// Note that none of these symbols are part of the public API, these are used for\n// debugging DX and as a safe way to provide an intimate contract on public objects.\n\nexport const SOURCE: '___(unique) Symbol(SOURCE)' = getOrSetGlobal('SOURCE', Symbol('#source'));\n\nexport const Destroy: '___(unique) Symbol(Destroy)' = getOrSetGlobal(\n  'Destroy',\n  Symbol.dispose || Symbol.for('Dispose')\n);\n/**\n * Symbol for the method used to request a mutable copy of an otherwise\n * immutable {@link ReactiveResource}.\n *\n * @deprecated use the {@link checkout} utility function instead.\n */\nexport const Checkout: '___(unique) Symbol(Checkout)' = getOrSetGlobal('Checkout', Symbol('Checkout'));\nexport const Commit: '___(unique) Symbol(Commit)' = getOrSetGlobal('Commit', Symbol('Commit'));\n\n/**\n * Symbol used to stash the internal field/resource context (schema, store,\n * mutability, etc.) on a {@link ReactiveResource} or reactive field instance.\n */\nexport const Context: '___(unique) Symbol(Context)' = getOrSetGlobal('Context', Symbol('Context'));\n"],"mappings":";;;AAiCA,MAAaC,SAAuCD,eAAe,UAAUE,OAAO,SAAS,CAAC;AAE9F,MAAaC,UAAyCH,eACpD,WACAE,OAAOE,WAAWF,OAAOG,IAAI,SAAS,CACxC;;;;;;;AAOA,MAAaC,WAA2CN,eAAe,YAAYE,OAAO,UAAU,CAAC;AACrG,MAAaK,SAAuCP,eAAe,UAAUE,OAAO,QAAQ,CAAC;;;;;AAM7F,MAAaM,UAAyCR,eAAe,WAAWE,OAAO,SAAS,CAAC"}
+{"version":3,"file":"-private-CmNOwhK0.js","names":["getOrSetGlobal","SOURCE","Symbol","Destroy","dispose","for","Checkout","Commit","Context"],"sources":["../src/reactive/-private/symbols.ts"],"sourcesContent":["///////////////////\n///// WARNING /////\n///////////////////\n\nimport { getOrSetGlobal } from '../../types/-private';\n\n// Great, got your attention with that warning didn't we?\n// Good. Here's the deal: typescript treats symbols as unique types.\n// If by accident a module creating a symbol is processed more than\n// once, the symbol will be different in each processing. This will\n// cause a type error.\n// It could also cause a runtime error if the symbol is used innapropriately.\n// However, this case is extremely hard to hit and would require other things\n// to go wrong first.\n//\n// So, why do the warning? And why do we lie about the types of the symbols?\n//\n// Because we intentionally create multiple copies of them within the types\n// at build time. This is because we rollup our d.ts files in order to give\n// our consumers a better experience.\n//\n// However, no tool today supports rolling up d.ts files with multiple entry\n// points correctly. The tool we use currently (vite-plugin-dts) uses @microsoft/api-extractor\n// which creates a fully unique stand-alone types file per-entry-point. Thus\n// every entry point that uses one of these symbols somewhere will have accidentally\n// created a new symbol type.\n//\n// This cast allows us to rollup these types using this tool while not encountering\n// the unique symbol type issue.\n//\n// Note that none of these symbols are part of the public API, these are used for\n// debugging DX and as a safe way to provide an intimate contract on public objects.\n\nexport const SOURCE: '___(unique) Symbol(SOURCE)' = getOrSetGlobal('SOURCE', Symbol('#source'));\n\nexport const Destroy: '___(unique) Symbol(Destroy)' = getOrSetGlobal(\n  'Destroy',\n  Symbol.dispose || Symbol.for('Dispose')\n);\n/**\n * Symbol for the method used to request a mutable copy of an otherwise\n * immutable {@link ReactiveResource}.\n *\n * @summary Deprecated symbol-keyed method on a ReactiveResource that resolves with an editable copy;\n * use `checkout` instead.\n * @deprecated use the {@link checkout} utility function instead.\n */\nexport const Checkout: '___(unique) Symbol(Checkout)' = getOrSetGlobal('Checkout', Symbol('Checkout'));\nexport const Commit: '___(unique) Symbol(Commit)' = getOrSetGlobal('Commit', Symbol('Commit'));\n\n/**\n * Symbol used to stash the internal field/resource context (schema, store,\n * mutability, etc.) on a {@link ReactiveResource} or reactive field instance.\n */\nexport const Context: '___(unique) Symbol(Context)' = getOrSetGlobal('Context', Symbol('Context'));\n"],"mappings":";;;AAiCA,MAAaC,SAAuCD,eAAe,UAAUE,OAAO,SAAS,CAAC;AAE9F,MAAaC,UAAyCH,eACpD,WACAE,OAAOE,WAAWF,OAAOG,IAAI,SAAS,CACxC;;;;;;;;;AASA,MAAaC,WAA2CN,eAAe,YAAYE,OAAO,UAAU,CAAC;AACrG,MAAaK,SAAuCP,eAAe,UAAUE,OAAO,QAAQ,CAAC;;;;;AAM7F,MAAaM,UAAyCR,eAAe,WAAWE,OAAO,SAAS,CAAC"}

package/dist/{aliases-BWYW5EhX.d.ts → aliases-BQmAxXmb.d.ts}

@@ -10,8 +10,11 @@
  *
  * This opaqueness allows arbitrary storage of any serializable/transferable
  * state, including such things as `Buffer`s and `String`s.
+ *
+ * @summary Opaque raw resource data whose format the Cache defines and from which the CacheKeyManager can derive a
+ * `ResourceKey`.
  */
 type ResourceBlob = unknown;
 //#endregion
 export { ResourceBlob as t };
-//# sourceMappingURL=aliases-BWYW5EhX.d.ts.map
+//# sourceMappingURL=aliases-BQmAxXmb.d.ts.map

package/dist/aliases-BQmAxXmb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aliases-BQmAxXmb.d.ts","names":[],"sources":["../src/types/cache/aliases.ts"],"mappings":";;;;;;;;;;;;;;;;KA2BY"}

package/dist/{change-C7kqv2kW.d.ts → change-DClXcHvr.d.ts}

@@ -1,9 +1,11 @@
-import { c as RequestKey, l as ResourceKey } from "./identifier-DQnqOSJK.js";
+import { c as RequestKey, l as ResourceKey } from "./identifier-B_tK3FUw.js";
 //#region src/types/cache/change.d.ts
 /**
  * Describes a single mutation to a resource or document that occurred
  * in the cache, as returned by {@link Cache.diff}.
  *
+ * @summary One upsert or removal of a resource or document recorded by the cache, with an optional patch, as
+ * returned by `cache.diff`.
  * @example
  * ```ts
  * const change: Change = {
@@ -38,4 +40,4 @@ interface Change {
 }
 //#endregion
 export { Change as t };
-//# sourceMappingURL=change-C7kqv2kW.d.ts.map
+//# sourceMappingURL=change-DClXcHvr.d.ts.map

package/dist/change-DClXcHvr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"change-DClXcHvr.d.ts","names":[],"sources":["../src/types/cache/change.ts"],"mappings":";;;;;;;;;;;;;;;;;UAwBiB;;;;EAIf,YAAY,cAAc;;;;;EAK1B;;;;;;;;;;;;EAYA"}

package/dist/{concepts-DFldVwEM.d.ts → concepts-DzuY5M1K.d.ts}

@@ -1,7 +1,7 @@
-import { l as ResourceKey } from "./identifier-DQnqOSJK.js";
-import { a as Type } from "./symbols-DjRDCeX0.js";
-import { i as OpaqueRecordInstance } from "./record-D3QQcaIR.js";
-import { i as Value, n as ObjectValue } from "./raw-D5hnjiq7.js";
+import { l as ResourceKey } from "./identifier-B_tK3FUw.js";
+import { a as Type } from "./symbols-Cu9un1NR.js";
+import { i as OpaqueRecordInstance } from "./record-DDxPtzcY.js";
+import { i as Value, n as ObjectValue } from "./raw-CiC64nCY.js";
 //#region src/types/schema/concepts.d.ts
 /**
  * A Transformation converts a cached primitive value into a richer
@@ -14,6 +14,9 @@ import { i as Value, n as ObjectValue } from "./raw-D5hnjiq7.js";
  * Transformations must be registered with the SchemaService via
  * `schema.registerTransformation(transform)` before use, keyed by the
  * name assigned to their {@link Type} property.
+ *
+ * @summary A registered pair of `serialize` and `hydrate` functions that convert a field's raw cached value to and from
+ * the value exposed on a record.
  */
 type Transformation<T extends Value = Value, PT = unknown> = {
   /**
@@ -47,6 +50,9 @@ type Transformation<T extends Value = Value, PT = unknown> = {
  * Derivations must be registered with the SchemaService via
  * `schema.registerDerivation(derivation)` before use, keyed by the
  * name assigned to their {@link Type} property.
+ *
+ * @summary A registered function that computes a memoized, read-only field value from a record's other fields, backing
+ * `derived` fields.
  */
 type Derivation<R = unknown, T = unknown, FM extends ObjectValue | null = ObjectValue | null> = {
   /**
@@ -65,6 +71,9 @@ type Derivation<R = unknown, T = unknown, FM extends ObjectValue | null = Object
  * HashFns must be registered with the SchemaService via
  * `schema.registerHashFn(hashFn)` before use, keyed by the name
  * assigned to their {@link Type} property.
+ *
+ * @summary A registered function that computes a stable string identity from an object's cache data, used for `@hash`
+ * fields and polymorphic schema-object types.
  */
 type HashFn<T extends object = object> = {
   /**
@@ -74,4 +83,4 @@ type HashFn<T extends object = object> = {
 } & ((data: T, options: ObjectValue | null, prop: string | null) => string);
 //#endregion
 export { HashFn as n, Transformation as r, Derivation as t };
-//# sourceMappingURL=concepts-DFldVwEM.d.ts.map
+//# sourceMappingURL=concepts-DzuY5M1K.d.ts.map

package/dist/concepts-DzuY5M1K.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"concepts-DzuY5M1K.d.ts","names":[],"sources":["../src/types/schema/concepts.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;KA0BY,eAAe,UAAU,QAAQ,OAAO;;;;;EAKlD,UAAU,OAAO,IAAI,SAAS,oBAAoB,QAAQ,uBAAuB;;;;;EAMjF,QAAQ,OAAO,eAAe,SAAS,oBAAoB,QAAQ,uBAAuB;;;;;EAM1F,cAAc,SAAS,oBAAoB,YAAY,cAAc;;;;GAKpE;;;;;;;;;;;;;;;;;KAkBS,WAAW,aAAa,aAAa,WAAW,qBAAqB;;;;GAI9E;MACG,QAAQ,GAAG,SAAS,IAAI,iBAAiB;;;;;;;;;;;;;;;;KAiBnC,OAAO;;;;GAIhB;MACG,MAAM,GAAG,SAAS,oBAAoB"}

package/dist/{configure-B_F639tN.d.ts → configure-CjsojjiI.d.ts}

@@ -30,6 +30,8 @@ type SignalRef = unknown;
  * scenarios you may also be interested in integrating with the {@link NotificationManager}
  * more directly.
  *
+ * @summary The create, consume, notify, and memo hooks a framework or TC39 signals implementation
+ * supplies to `setupSignals` to make WarpDrive data reactive.
  * @public
  */
 interface SignalHooks<T = SignalRef> {
@@ -90,6 +92,8 @@ interface SignalHooks<T = SignalRef> {
  * }
  * ```
  *
+ * @summary The options passed to the `setupSignals` callback, including the well-known key WarpDrive
+ * uses for an array's contents signal.
  * @public
  */
 interface HooksOptions {
@@ -119,6 +123,8 @@ interface HooksOptions {
  * See {@link SignalHooks} for the implementation the callback function should
  * return.
  *
+ * @summary Registers the signal hooks WarpDrive uses for reactivity, built by a callback that receives
+ * `HooksOptions`.
  * @public
  * @param buildConfig - a function that takes options and returns a configuration object
  */
@@ -131,4 +137,4 @@ declare function setupSignals<T>(buildConfig: (options: HooksOptions) => SignalH
 declare function waitFor<K>(promise: Promise<K>): Promise<K>;
 //#endregion
 export { setupSignals as a, SignalRef as i, HooksOptions as n, waitFor as o, SignalHooks as r, ARRAY_SIGNAL as t };
-//# sourceMappingURL=configure-B_F639tN.d.ts.map
+//# sourceMappingURL=configure-CjsojjiI.d.ts.map

package/dist/configure-CjsojjiI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configure-CjsojjiI.d.ts","names":[],"sources":["../src/signals/reactivity/configure.ts"],"mappings":";cAMa;;;;;;;;KAsCD;;;;;;;;;;;;;;;;;;;;;;;;;;;UA2BK,YAAY,IAAI;;;;;;;;;;EAU/B,eAAe,aAAa,yBAAyB;;;;EAIrD,gBAAgB,QAAQ;;;;EAIxB,eAAe,QAAQ;;;;;;;;EAQvB,aAAa,GAAG,aAAa,sBAAsB,UAAU,YAAY;;;;;;;;;;;;EAazE;;;;;EAMA,WAAW,GAAG,SAAS,QAAQ,OAAO,QAAQ;;;;;;;;;;;;;;;;;;;UAoB/B;;;;;;EAMf;;;;;;;;IAQE;;;;;;;;;;;;;;;;;;iBAmBY,aAAa,GAAG,cAAc,SAAS,iBAAiB,YAAY;;;;;;iBAgEpE,QAAQ,GAAG,SAAS,QAAQ,KAAK,QAAQ"}

package/dist/configure.d.ts

@@ -1,2 +1,2 @@
-import { a as setupSignals, n as HooksOptions, r as SignalHooks } from "./configure-B_F639tN.js";
+import { a as setupSignals, n as HooksOptions, r as SignalHooks } from "./configure-CjsojjiI.js";
 export { type HooksOptions, type SignalHooks, setupSignals };

package/dist/configure.js

@@ -1,3 +1,3 @@
-import { M as setupSignals } from "./-private-CjK1Dmuh.js";
+import { M as setupSignals } from "./-private-BpyvBYFj.js";
 
 export { setupSignals };

package/dist/{document-Ca4ZZBd9.d.ts → document-Ni8Ns26t.d.ts}

@@ -1,10 +1,13 @@
-import { s as PersistedResourceKey } from "./identifier-DQnqOSJK.js";
-import { d as Meta, m as PaginationLinks, u as Links } from "./json-api-raw-C5APJHHB.js";
-import { t as ApiError } from "./error-0uD6GkNX.js";
+import { s as PersistedResourceKey } from "./identifier-B_tK3FUw.js";
+import { d as Meta, m as PaginationLinks, u as Links } from "./json-api-raw-BxzNsCg0.js";
+import { t as ApiError } from "./error-APuUdUGk.js";
 //#region src/types/spec/document.d.ts
 /**
  * This type represents a raw {json:api} document for a meta-only
  * document returned by a request intended to be inserted into the cache.
+ *
+ * @summary A raw {json:api} document carrying only `meta` and optional `links`, as returned by a request and
+ * inserted into the cache.
  */
 interface ResourceMetaDocument {
   /**
@@ -25,6 +28,9 @@ interface ResourceMetaDocument {
  * returned by a request intended to be inserted into the cache.
  *
  * For the Reactive value returned by a request using the store, use {@link ReactiveDataDocument} instead.
+ *
+ * @summary A raw {json:api} document whose `data` is a single resource or `null`, as returned by a request and
+ * inserted into the cache.
  */
 interface SingleResourceDataDocument<T = PersistedResourceKey, R = PersistedResourceKey> {
   /**
@@ -53,6 +59,9 @@ interface SingleResourceDataDocument<T = PersistedResourceKey, R = PersistedReso
  * returned by a request intended to be inserted into the cache.
  *
  * For the Reactive value returned by a request using the store, use {@link ReactiveDataDocument} instead.
+ *
+ * @summary A raw {json:api} document whose `data` is an array of resources, as returned by a request and inserted
+ * into the cache.
  */
 interface CollectionResourceDataDocument<T = PersistedResourceKey> {
   /**
@@ -85,6 +94,9 @@ interface CollectionResourceDataDocument<T = PersistedResourceKey> {
  * - {@link CollectionResourceDataDocument}
  *
  * For the Reactive value returned by a request using the store, use {@link ReactiveDataDocument} instead.
+ *
+ * @summary Either a single-resource or a collection raw {json:api} data document, as stored in and returned by
+ * the cache.
  */
 type ResourceDataDocument<T = PersistedResourceKey> = SingleResourceDataDocument<T> | CollectionResourceDataDocument<T>;
 /**
@@ -92,6 +104,9 @@ type ResourceDataDocument<T = PersistedResourceKey> = SingleResourceDataDocument
  * the cache may use.
  *
  * For the Reactive value returned by a request using the store, use {@link ReactiveErrorDocument} instead.
+ *
+ * @summary A raw {json:api} document carrying an `errors` array for a failed request, as stored in and returned
+ * by the cache.
  */
 interface ResourceErrorDocument {
   /**
@@ -122,8 +137,11 @@ interface ResourceErrorDocument {
  * - {@link ResourceErrorDocument}
  *
  * For the Reactive value returned by a request using the store, use {@link ReactiveDocument} instead.
+ *
+ * @summary Any raw {json:api} document the cache stores and returns: meta-only, single-resource, collection, or
+ * error.
  */
 type ResourceDocument<T = PersistedResourceKey> = ResourceMetaDocument | SingleResourceDataDocument<T> | CollectionResourceDataDocument<T> | ResourceErrorDocument;
 //#endregion
 export { ResourceMetaDocument as a, ResourceErrorDocument as i, ResourceDataDocument as n, SingleResourceDataDocument as o, ResourceDocument as r, CollectionResourceDataDocument as t };
-//# sourceMappingURL=document-Ca4ZZBd9.d.ts.map
+//# sourceMappingURL=document-Ni8Ns26t.d.ts.map

package/dist/document-Ni8Ns26t.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-Ni8Ns26t.d.ts","names":[],"sources":["../src/types/spec/document.ts"],"mappings":";;;;;;;;;;;UAmBiB;;;;EAIf;;;;EAIA,MAAM;;;;EAIN,QAAQ,QAAQ;;;;;;;;;;;UAYD,2BAA2B,IAAI,sBAAsB,IAAI;;;;EAIxE;;;;EAIA,QAAQ,QAAQ;;;;EAIhB,OAAO;;;;EAIP,MAAM;;;;EAIN,WAAW;;;;;;;;;;;UAYI,+BAA+B,IAAI;;;;EAIlD;;;;EAIA,QAAQ,QAAQ;;;;EAIhB,OAAO;;;;EAIP,MAAM;;;;EAIN,WAAW;;;;;;;;;;;;;;;KAgBD,qBAAqB,IAAI,wBACjC,2BAA2B,KAC3B,+BAA+B;;;;;;;;;;UAWlB;;;;EAIf;;;;EAIA,QAAQ,QAAQ;;;;EAIhB,OAAO;;;;EAIP,QAAQ;;;;;;;;;;;;;;;;;KAkBE,iBAAiB,IAAI,wBAC7B,uBACA,2BAA2B,KAC3B,+BAA+B,KAC/B"}

package/dist/{error-0uD6GkNX.d.ts → error-APuUdUGk.d.ts}

@@ -1,10 +1,12 @@
-import { c as Link, d as Meta } from "./json-api-raw-C5APJHHB.js";
+import { c as Link, d as Meta } from "./json-api-raw-BxzNsCg0.js";
 //#region src/types/spec/error.d.ts
 /**
  * Represents a single error in the `errors` member of a {json:api} document.
  *
  * [{json:api} Spec](https://jsonapi.org/format/#error-objects)
  *
+ * @summary One {json:api} error object, with optional `status`, `code`, `title`, `detail`, `source`, `links`, and
+ * `meta`, found in a document's `errors` array.
  * @example
  * ```json
  * {
@@ -78,4 +80,4 @@ interface ApiError {
 }
 //#endregion
 export { ApiError as t };
-//# sourceMappingURL=error-0uD6GkNX.d.ts.map
+//# sourceMappingURL=error-APuUdUGk.d.ts.map

package/dist/error-APuUdUGk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-APuUdUGk.d.ts","names":[],"sources":["../src/types/spec/error.ts"],"mappings":";;;;;;;;;;;;;;;;;;;UAwBiB;;;;EAIf;;;;;EAKA;;;;EAIA;;;;EAIA;;;;IAIE,QAAQ;;;;IAIR,OAAO;;;;;EAKT;;;;EAIA;;;;;;;;EAQA;;;;IAIE;;;;IAIA;;;;IAIA;;;;;EAKF,OAAO"}