@warp-drive-mirror/core 5.10.0-alpha.21 → 5.10.0-alpha.22

package/dist/store/-private.d.ts

@@ -1,2 +1,2 @@
-import { $ as PrivateStore, At as CachePolicy, Ct as setRecordIdentifier, Et as assertPrivateCapabilities, G as logGroup, J as normalizeModelName, K as LegacyManyArray, Mt as StoreRequestContext, Nt as StoreRequestInput, Q as CreateRecordProperties, St as recordIdentifierFor, Tt as PrivateCacheCapabilitiesManager, W as log, X as ensureStringId, Y as coerceId, Z as constructResource, at as Request, bt as StoreMap, cn as isRequestKey, ct as SaveRecordMutation, dt as LegacyQueryArray, et as Store, ft as LegacyLiveArray, it as PrivateRequestStateService, jt as CacheHandler, ln as isResourceKey, lt as RecordArrayManager, mt as ReactiveResourceArray, nt as isPrivateStore, on as FieldValueIdentity, ot as RequestCacheRequestState, pt as PrivateReactiveResourceArray, q as createLegacyManyArray, rt as FindRecordQuery, sn as fieldValueIdentity, st as RequestStateService, tt as assertPrivateStore, ut as fastPush, vt as NativeProxy, wt as storeFor, xt as _clearCaches, yt as InstanceCache } from "../internal-D_WIXC4r.js";
+import { $ as PrivateStore, At as CachePolicy, Ct as setRecordIdentifier, Et as assertPrivateCapabilities, G as logGroup, J as normalizeModelName, K as LegacyManyArray, Mt as StoreRequestContext, Nt as StoreRequestInput, Q as CreateRecordProperties, St as recordIdentifierFor, Tt as PrivateCacheCapabilitiesManager, W as log, X as ensureStringId, Y as coerceId, Z as constructResource, at as Request, bt as StoreMap, cn as isRequestKey, ct as SaveRecordMutation, dt as LegacyQueryArray, et as Store, ft as LegacyLiveArray, it as PrivateRequestStateService, jt as CacheHandler, ln as isResourceKey, lt as RecordArrayManager, mt as ReactiveResourceArray, nt as isPrivateStore, on as FieldValueIdentity, ot as RequestCacheRequestState, pt as PrivateReactiveResourceArray, q as createLegacyManyArray, rt as FindRecordQuery, sn as fieldValueIdentity, st as RequestStateService, tt as assertPrivateStore, ut as fastPush, vt as NativeProxy, wt as storeFor, xt as _clearCaches, yt as InstanceCache } from "../internal-BrC3kM86.js";
 export { CacheHandler, type CachePolicy, type LegacyQueryArray as CollectionRecordArray, type LegacyQueryArray, type CreateRecordProperties, type FieldValueIdentity, type FindRecordQuery, type InstanceCache, type LegacyLiveArray, type LegacyLiveArray as LiveArray, type LegacyManyArray, type LegacyManyArray as RelatedCollection, type NativeProxy, type PrivateCacheCapabilitiesManager, type PrivateReactiveResourceArray, type PrivateRequestStateService, type PrivateStore, type ReactiveResourceArray, RecordArrayManager, type Request, type RequestCacheRequestState, type RequestStateService, type SaveRecordMutation, Store, StoreMap, type StoreRequestContext, type StoreRequestInput, _clearCaches, normalizeModelName as _deprecatingNormalize, assertPrivateCapabilities, assertPrivateStore, coerceId, constructResource, createLegacyManyArray, ensureStringId, fastPush, fieldValueIdentity, isPrivateStore, isRequestKey, isResourceKey, log, logGroup, recordIdentifierFor, setRecordIdentifier, storeFor };

package/dist/store/-private.js

@@ -1,3 +1,3 @@
-import { C as setRecordIdentifier, D as isRequestKey, E as fieldValueIdentity, F as coerceId, I as ensureStringId, L as log, O as isResourceKey, P as normalizeModelName, R as logGroup, S as recordIdentifierFor, T as assertPrivateCapabilities, _ as isPrivateStore, b as StoreMap, f as createLegacyManyArray, g as assertPrivateStore, h as Store, m as CacheHandler, p as constructResource, v as RecordArrayManager, w as storeFor, x as _clearCaches, y as fastPush } from "../src-ccp1WKyt.js";
+import { C as setRecordIdentifier, D as isRequestKey, E as fieldValueIdentity, F as coerceId, I as ensureStringId, L as log, O as isResourceKey, P as normalizeModelName, R as logGroup, S as recordIdentifierFor, T as assertPrivateCapabilities, _ as isPrivateStore, b as StoreMap, f as createLegacyManyArray, g as assertPrivateStore, h as Store, m as CacheHandler, p as constructResource, v as RecordArrayManager, w as storeFor, x as _clearCaches, y as fastPush } from "../src-spa19bCt.js";
 
 export { CacheHandler, RecordArrayManager, Store, StoreMap, _clearCaches, normalizeModelName as _deprecatingNormalize, assertPrivateCapabilities, assertPrivateStore, coerceId, constructResource, createLegacyManyArray, ensureStringId, fastPush, fieldValueIdentity, isPrivateStore, isRequestKey, isResourceKey, log, logGroup, recordIdentifierFor, setRecordIdentifier, storeFor };

package/dist/store.d.ts

@@ -1,2 +1,7 @@
-import { F as PolicyConfig, I as parseCacheControl, N as CacheControlValue, P as DefaultCachePolicy, rn as NotificationManager } from "./internal-D_WIXC4r.js";
+/**
+ * @module
+ * @summary The `DefaultCachePolicy` and `parseCacheControl` for expiring cached requests, plus the
+ * `NotificationManager` type for subscribing to cache change notifications.
+ */
+import { F as PolicyConfig, I as parseCacheControl, N as CacheControlValue, P as DefaultCachePolicy, rn as NotificationManager } from "./internal-BrC3kM86.js";
 export { type CacheControlValue, DefaultCachePolicy, type NotificationManager, type PolicyConfig, parseCacheControl };

package/dist/types/-private.js

@@ -2,7 +2,7 @@ import { getGlobalConfig, macroCondition } from "@embroider/macros";
 
 // src/types/-private.ts
 const name = "@warp-drive-mirror/core";
-const version = "5.10.0-alpha.21";
+const version = "5.10.0-alpha.22";
 const GlobalRef = globalThis;
 const UniversalCache = GlobalRef.__warpDrive_universalCache = GlobalRef.__warpDrive_universalCache ?? {};
 GlobalRef[name] = GlobalRef[name] ?? { __version: version };

package/dist/types/cache/relationship.d.ts

@@ -1,2 +1,7 @@
+/**
+ * @module
+ * @summary Types for the cache-side state of to-one and to-many relationships, with related resources referenced by
+ * `ResourceKey`.
+ */
 import { n as Relationship, r as ResourceRelationship, t as CollectionRelationship } from "../../relationship-99pc4CaS.js";
 export { CollectionRelationship, Relationship, ResourceRelationship };

package/dist/types/cache.d.ts

@@ -1,2 +1,7 @@
-import { Qt as RelationshipDiff, Xt as Cache, Zt as ChangedAttributesHash } from "../internal-D_WIXC4r.js";
+/**
+ * @module
+ * @summary The `Cache` interface a cache implementation fulfills to store, patch, mutate and read documents and
+ * resources, plus the `ChangedAttributesHash` and `RelationshipDiff` types.
+ */
+import { Qt as RelationshipDiff, Xt as Cache, Zt as ChangedAttributesHash } from "../internal-BrC3kM86.js";
 export { Cache, ChangedAttributesHash, RelationshipDiff };

package/dist/types/graph.d.ts

@@ -1,2 +1,7 @@
-import { a as ReplaceRelatedRecordOperation, c as UnknownOperation, i as RemoteRelationshipOperation, l as UpdateRelationshipOperation, n as LocalRelationshipOperation, o as ReplaceRelatedRecordsOperation, r as Operation, s as SortRelatedRecords, t as DeleteRecordOperation } from "../graph-BqxaFjEb.js";
+/**
+ * @module
+ * @summary Types for the operations that update a relationship's remote (persisted) or local (uncommitted) state in the
+ * relationship Graph.
+ */
+import { a as ReplaceRelatedRecordOperation, c as UnknownOperation, i as RemoteRelationshipOperation, l as UpdateRelationshipOperation, n as LocalRelationshipOperation, o as ReplaceRelatedRecordsOperation, r as Operation, s as SortRelatedRecords, t as DeleteRecordOperation } from "../graph-CoQhsOgT.js";
 export { DeleteRecordOperation, LocalRelationshipOperation, Operation, RemoteRelationshipOperation, ReplaceRelatedRecordOperation, ReplaceRelatedRecordsOperation, SortRelatedRecords, UnknownOperation, UpdateRelationshipOperation };

package/dist/types/record.d.ts

@@ -1,2 +1,7 @@
+/**
+ * @module
+ * @summary Types for records that declare their resource type via the `[Type]` symbol, including `TypedRecordInstance`,
+ * `Includes`, `Mask` and the `createIncludeValidator` helper.
+ */
 import { a as StringSatisfiesIncludes, c as TypedRecordInstance, i as OpaqueRecordInstance, l as Validate, n as Includes, o as TypeFromInstance, r as Mask, s as TypeFromInstanceOrString, t as ExtractSuggestedCacheTypes, u as createIncludeValidator } from "../record-f5-uOgHt.js";
 export { ExtractSuggestedCacheTypes, Includes, Mask, OpaqueRecordInstance, StringSatisfiesIncludes, TypeFromInstance, TypeFromInstanceOrString, TypedRecordInstance, Validate, createIncludeValidator };

package/dist/types/request.d.ts

@@ -1,2 +1,2 @@
-import { $n as STRUCTURED, Bn as HTTPMethod, Fn as CreateRequestOptions, Gn as ImmutableRequestInfo, Hn as ImmutableCreateRequestOptions, In as DeleteRequestOptions, Jn as QueryRequestOptions, Kn as ImmutableUpdateRequestOptions, Ln as EnableHydration, Nn as CacheOptions, Pn as ConstrainedRequestOptions, Qn as ResponseInfo, Rn as FindRecordOptions, Un as ImmutableDeleteRequestOptions, Vn as IS_FUTURE, Wn as ImmutableHeaders, Xn as RequestContext, Yn as RemotelyAccessibleIdentifier, Zn as RequestInfo, ar as FetchError, er as SkipCache, ir as UpdateRequestOptions, nr as StructuredDocument, qn as PostQueryRequestOptions, rr as StructuredErrorDocument, tr as StructuredDataDocument, zn as FindRecordRequestOptions } from "../internal-D_WIXC4r.js";
+import { $n as STRUCTURED, Bn as HTTPMethod, Fn as CreateRequestOptions, Gn as ImmutableRequestInfo, Hn as ImmutableCreateRequestOptions, In as DeleteRequestOptions, Jn as QueryRequestOptions, Kn as ImmutableUpdateRequestOptions, Ln as EnableHydration, Nn as CacheOptions, Pn as ConstrainedRequestOptions, Qn as ResponseInfo, Rn as FindRecordOptions, Un as ImmutableDeleteRequestOptions, Vn as IS_FUTURE, Wn as ImmutableHeaders, Xn as RequestContext, Yn as RemotelyAccessibleIdentifier, Zn as RequestInfo, ar as FetchError, er as SkipCache, ir as UpdateRequestOptions, nr as StructuredDocument, qn as PostQueryRequestOptions, rr as StructuredErrorDocument, tr as StructuredDataDocument, zn as FindRecordRequestOptions } from "../internal-BrC3kM86.js";
 export { CacheOptions, ConstrainedRequestOptions, CreateRequestOptions, DeleteRequestOptions, EnableHydration, type FetchError, FindRecordOptions, FindRecordRequestOptions, HTTPMethod, IS_FUTURE, ImmutableCreateRequestOptions, ImmutableDeleteRequestOptions, ImmutableHeaders, ImmutableRequestInfo, ImmutableUpdateRequestOptions, PostQueryRequestOptions, QueryRequestOptions, RemotelyAccessibleIdentifier, RequestContext, RequestInfo, ResponseInfo, STRUCTURED, SkipCache, StructuredDataDocument, StructuredDocument, StructuredErrorDocument, UpdateRequestOptions };

package/dist/types/schema/concepts.d.ts

@@ -1,2 +1,7 @@
-import { n as HashFn, r as Transformation, t as Derivation } from "../../concepts-vh86nAcd.js";
+/**
+ * @module
+ * @summary Types for the functions schemas reference by name: `Transformation` to convert field values, `Derivation`
+ * for computed fields and `HashFn` for object identity.
+ */
+import { n as HashFn, r as Transformation, t as Derivation } from "../../concepts-Db9ssz1h.js";
 export { Derivation, HashFn, Transformation };

package/dist/types/schema/fields.d.ts

@@ -1,2 +1,2 @@
-import { A as ResourceField, C as ObjectField, D as PolarisModeFieldSchema, E as PolarisAliasField, F as Trait, I as isLegacyResourceSchema, L as isResourceSchema, M as Schema, N as SchemaArrayField, O as PolarisResourceSchema, P as SchemaObjectField, R as objectSchema, S as ObjectAliasField, T as ObjectSchema, _ as LegacyResourceSchema, a as DerivedField, b as LinksModeHasManyField, c as HashField, d as LegacyAttributeField, f as LegacyBelongsToField, g as LegacyRelationshipField, h as LegacyModeFieldSchema, i as CollectionField, j as ResourceSchema, k as PolarisTrait, l as IdentityField, m as LegacyHasManyField, n as AttrOptions, o as FieldSchema, p as LegacyField, r as CacheableFieldSchema, s as GenericField, t as ArrayField, u as LegacyAliasField, v as LegacyTrait, w as ObjectFieldSchema, x as LocalField, y as LinksModeBelongsToField, z as resourceSchema } from "../../fields-r1rZJB9d.js";
-export { ArrayField, AttrOptions, CacheableFieldSchema, CollectionField, DerivedField, FieldSchema, GenericField, HashField, IdentityField, LegacyAliasField, LegacyAttributeField, LegacyBelongsToField, LegacyField, LegacyHasManyField, LegacyModeFieldSchema, LegacyRelationshipField, LegacyResourceSchema, LegacyTrait, LinksModeBelongsToField, LinksModeHasManyField, LocalField, ObjectAliasField, ObjectField, ObjectFieldSchema, ObjectSchema, PolarisAliasField, PolarisModeFieldSchema, PolarisResourceSchema, PolarisTrait, ResourceField, ResourceSchema, Schema, SchemaArrayField, SchemaObjectField, Trait, isLegacyResourceSchema, isResourceSchema, objectSchema, resourceSchema };
+import { A as ResourceField, B as isSingleKind, C as ObjectField, D as PolarisModeFieldSchema, E as PolarisAliasField, F as Trait, H as resourceSchema, I as isLegacyResourceSchema, L as isManyKind, M as Schema, N as SchemaArrayField, O as PolarisResourceSchema, P as SchemaObjectField, R as isRelationshipKind, S as ObjectAliasField, T as ObjectSchema, V as objectSchema, _ as LegacyResourceSchema, a as DerivedField, b as LinksModeHasManyField, c as HashField, d as LegacyAttributeField, f as LegacyBelongsToField, g as LegacyRelationshipField, h as LegacyModeFieldSchema, i as CollectionField, j as ResourceSchema, k as PolarisTrait, l as IdentityField, m as LegacyHasManyField, n as AttrOptions, o as FieldSchema, p as LegacyField, r as CacheableFieldSchema, s as GenericField, t as ArrayField, u as LegacyAliasField, v as LegacyTrait, w as ObjectFieldSchema, x as LocalField, y as LinksModeBelongsToField, z as isResourceSchema } from "../../fields-B-jO-dzB.js";
+export { ArrayField, AttrOptions, CacheableFieldSchema, CollectionField, DerivedField, FieldSchema, GenericField, HashField, IdentityField, LegacyAliasField, LegacyAttributeField, LegacyBelongsToField, LegacyField, LegacyHasManyField, LegacyModeFieldSchema, LegacyRelationshipField, LegacyResourceSchema, LegacyTrait, LinksModeBelongsToField, LinksModeHasManyField, LocalField, ObjectAliasField, ObjectField, ObjectFieldSchema, ObjectSchema, PolarisAliasField, PolarisModeFieldSchema, PolarisResourceSchema, PolarisTrait, ResourceField, ResourceSchema, Schema, SchemaArrayField, SchemaObjectField, Trait, isLegacyResourceSchema, isManyKind, isRelationshipKind, isResourceSchema, isSingleKind, objectSchema, resourceSchema };

package/dist/types/schema/fields.js

@@ -280,31 +280,64 @@
 * Represents a field that is a reference to
 * another resource.
 *
-* SUPPORT FOR THIS FEATURE IS NOT YET COMPLETE
-* IN ReactiveResource. It is not yet part of
-* {@link PolarisModeFieldSchema} or {@link LegacyModeFieldSchema}.
-* Reading the field returns an object with the related
-* record as `data`, plus `links`, `meta` and a `fetch()`
-* method, but it does not yet update when the
-* relationship changes, and setting it is not supported.
+* The value of a `resource` field on a ReactiveResource is a
+* `ReactiveRelationshipDocument` whose `data` is the related
+* resource (or `null`), and whose `links` and `meta` mirror the
+* relationship payload received from the API.
 *
-* @summary Field schema of kind `resource` for a reference to another resource; not yet implemented by
-* `ReactiveResource`.
+* ```ts
+* const user = store.peekRecord<User>('user', '1');
+* user.bestFriend.data; // User | null | undefined
+* user.bestFriend.links; // { related: '/users/1/best-friend' }
+* ```
+*
+* The relationship payload for this field is expected to have the
+* shape `{ data?: { type, id } | null, links?: Links, meta?: Meta }`.
+* When `data` is omitted from the payload `doc.data` is `undefined`
+* and `doc.fetch()` may be used to load the related resource via
+* the `related` link.
+*
+* In LegacyMode the relationship is mutable via `doc.data = record`.
+* In PolarisMode it is immutable unless the parent resource has been
+* checked out for editing.
+*
+* @summary Field schema of kind `resource` for a reference to another resource, whose value is a
+* `ReactiveRelationshipDocument`.
 * @public
 */
 /**
 * Represents a field that is a reference to
-* a collection of other resources, potentially
-* paginate.
+* a collection of other resources.
+*
+* The value of a `collection` field on a ReactiveResource is a
+* `ReactiveRelationshipDocument` whose `data` is a reactive array
+* of the related resources, and whose `links` and `meta` mirror the
+* relationship payload received from the API.
+*
+* ```ts
+* const user = store.peekRecord<User>('user', '1');
+* user.friends.data; // User[] | undefined
+* user.friends.links; // { related: '/users/1/friends' }
+* ```
 *
-* SUPPORT FOR THIS FEATURE IS NOT YET IMPLEMENTED
-* BY ReactiveResource. It is not yet part of
-* {@link PolarisModeFieldSchema} or {@link LegacyModeFieldSchema},
-* and reading or setting the field fails an assertion
-* in development builds.
+* The relationship payload for this field is expected to have the
+* shape `{ data?: { type, id }[], links?: Links, meta?: Meta }`.
+* When `data` is omitted from the payload `doc.data` is `undefined`
+* and `doc.fetch()` may be used to load the related resources via
+* the `related` link.
 *
-* @summary Field schema of kind `collection` for a possibly paginated reference to other resources; not yet implemented
-* by `ReactiveResource`.
+* Collection relationships are not paginated: pagination links present
+* on the relationship are surfaced on `doc.links` but are never merged
+* into the relationship's membership. Large, sortable, filterable or
+* paginated lists should be loaded with a top-level request instead.
+*
+* In LegacyMode the relationship is mutable via `doc.data.push(record)`
+* (and the other array mutation methods) or `doc.data = [records]`.
+* In PolarisMode it is immutable unless the parent resource has been
+* checked out for editing.
+*
+* @summary Field schema of kind `collection` for a reference to other resources, whose value is a
+* `ReactiveRelationshipDocument`.
 * @public
 */
 /**
@@ -400,8 +433,8 @@
 * - {@link ArrayField}
 * - {@link SchemaArrayField}
 * - {@link DerivedField}
-* - {@link ResourceField | ResourceField (not yet implemented)}
-* - {@link CollectionField | CollectionField (not yet implemented)}
+* - {@link ResourceField}
+* - {@link CollectionField}
 * - {@link LegacyAttributeField}
 * - {@link LegacyBelongsToField}
 * - {@link LegacyHasManyField}
@@ -423,8 +456,8 @@
 * - {@link ArrayField}
 * - {@link SchemaArrayField}
 * - {@link DerivedField}
-* - {@link ResourceField | ResourceField (not yet implemented)}
-* - {@link CollectionField | CollectionField (not yet implemented)}
+* - {@link ResourceField}
+* - {@link CollectionField}
 * - {@link LinksModeBelongsToField}
 * - {@link LinksModeHasManyField}
 *
@@ -591,6 +624,32 @@ function objectSchema(schema) {
 * `@id`.
 * @public
 */
+/**
+* Whether a field kind is a to-many relationship: the legacy `hasMany` or the
+* `collection` kind.
+*
+* @public
+*/
+function isManyKind(kind) {
+	return kind === "hasMany" || kind === "collection";
+}
+/**
+* Whether a field kind is a to-one relationship: the legacy `belongsTo` or the
+* `resource` kind.
+*
+* @public
+*/
+function isSingleKind(kind) {
+	return kind === "belongsTo" || kind === "resource";
+}
+/**
+* Whether a field kind is any relationship kind, legacy or not.
+*
+* @public
+*/
+function isRelationshipKind(kind) {
+	return isManyKind(kind) || isSingleKind(kind);
+}
 function isResourceSchema(schema) {
 	return schema?.identity?.kind === "@id";
 }
@@ -635,5 +694,5 @@ function isLegacyResourceSchema(schema) {
 * @summary Union of the legacy belongsTo and hasMany field schemas, including their LinksMode variants.
 * @public
 */
-export { isLegacyResourceSchema, isResourceSchema, objectSchema, resourceSchema };
+export { isLegacyResourceSchema, isManyKind, isRelationshipKind, isResourceSchema, isSingleKind, objectSchema, resourceSchema };
 //# sourceMappingURL=fields.js.map