@warp-drive-mirror/utilities 5.10.0-alpha.2 → 5.10.0-alpha.21

package/dist/json-api.d.ts

@@ -1,4 +1,4 @@
-import { t as BuildURLConfig } from "./index-BeMAuqgZ.js";
+import { t as BuildURLConfig } from "./index-Dv5kZpGe.js";
 import { ReactiveDataDocument } from "@warp-drive-mirror/core/reactive";
 import { TypeFromInstance, TypedRecordInstance } from "@warp-drive-mirror/core/types/record";
 import { ConstrainedRequestOptions, CreateRequestOptions, DeleteRequestOptions, FindRecordOptions, FindRecordRequestOptions, PostQueryRequestOptions, QueryRequestOptions, RemotelyAccessibleIdentifier, UpdateRequestOptions } from "@warp-drive-mirror/core/types/request";
@@ -8,11 +8,13 @@ import { ApiError } from "@warp-drive-mirror/core/types/spec/error";
 import { Cache } from "@warp-drive-mirror/core/types/cache";
 import { ResourceKey } from "@warp-drive-mirror/core/types/identifier";
 import { Value } from "@warp-drive-mirror/core/types/json/raw";
-//#region src/-private/json-api/find-record.d.ts
 /**
  * Builds request options to fetch a single resource by a known id or identifier
  * configured for the url and header expectations of most JSON:API APIs.
  *
+ * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and
+ * when to use one.
+ *
  * :::tabs
  *
  * == Basic Usage
@@ -82,18 +84,20 @@ import { Value } from "@warp-drive-mirror/core/types/json/raw";
  * );
  * ```
  *
+ * @summary Builds a JSON:API `GET` request for one resource by type and id, with optional `include`.
  * @public
  */
 export declare function findRecord<T, M extends Meta | undefined = Meta | undefined, E extends object = ApiError>(identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>, options?: FindRecordOptions): FindRecordRequestOptions<ReactiveDataDocument<T, M, E>, T>;
 export declare function findRecord(identifier: RemotelyAccessibleIdentifier, options?: FindRecordOptions): FindRecordRequestOptions;
 export declare function findRecord<T, M extends Meta | undefined = Meta | undefined, E extends object = ApiError>(type: TypeFromInstance<T>, id: string, options?: FindRecordOptions): FindRecordRequestOptions<ReactiveDataDocument<T, M, E>, T>;
 export declare function findRecord(type: string, id: string, options?: FindRecordOptions): FindRecordRequestOptions;
-//#endregion
-//#region src/-private/json-api/query.d.ts
 /**
  * Builds request options to query for resources, usually by a primary
  * type, configured for the url and header expectations of most JSON:API APIs.
  *
+ * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and
+ * when to use one.
+ *
  * The key difference between this and `postQuery` is that this method will send the query
  * as query params in the url of a "GET" request instead of as the JSON body of a "POST"
  * request.
@@ -136,6 +140,7 @@ export declare function findRecord(type: string, id: string, options?: FindRecor
  * const data = await store.request(options);
  * ```
  *
+ * @summary Builds a JSON:API `GET` request that queries a resource type, sending the query as URL query params.
  * @public
  * @badge Builder
  */
@@ -145,6 +150,9 @@ export declare function query(type: string, query?: QueryParamsSource, options?:
  * Builds request options to query for resources, usually by a primary
  * type, configured for the url and header expectations of most JSON:API APIs.
  *
+ * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and
+ * when to use one.
+ *
  * The key difference between this and `query` is that this method will send the query
  * as the JSON body of a "POST" request instead of as query params in the url of a "GET"
  * request.
@@ -180,6 +188,8 @@ export declare function query(type: string, query?: QueryParamsSource, options?:
  * const data = await store.request(options);
  * ```
  *
+ * @summary Builds a JSON:API `POST` request that sends a query as the JSON body, cached under a key built from the
+ * query params.
  * @public
  * @param type - the name of the resource type to query
  * @param query - the query params to send with the request
@@ -187,8 +197,6 @@ export declare function query(type: string, query?: QueryParamsSource, options?:
  */
 export declare function postQuery<T, M extends Meta | undefined = Meta | undefined, E extends object = ApiError>(type: TypeFromInstance<T>, query?: QueryParamsSource, options?: ConstrainedRequestOptions): PostQueryRequestOptions<ReactiveDataDocument<T[], M, E>>;
 export declare function postQuery(type: string, query?: QueryParamsSource, options?: ConstrainedRequestOptions): PostQueryRequestOptions;
-//#endregion
-//#region src/-private/json-api/save-record.d.ts
 /**
  * :::warning ⚠️ **These Mutation Builders DO NOT Set The Request Body**
  * While this may come as a surprise, the app providing the body ensures that only
@@ -198,6 +206,9 @@ export declare function postQuery(type: string, query?: QueryParamsSource, optio
  * Builds request options to delete record for resources,
  * configured for the url, method and header expectations of most JSON:API APIs.
  *
+ * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and
+ * when to use one.
+ *
  * **Basic Usage**
  *
  * ```ts
@@ -239,6 +250,7 @@ export declare function postQuery(type: string, query?: QueryParamsSource, optio
  * const data = await store.request(options);
  * ```
  *
+ * @summary Builds a JSON:API `DELETE` request that persists deletion of an existing record.
  * @public
  * @param record
  * @param options
@@ -254,6 +266,9 @@ export declare function deleteRecord(record: unknown, options?: ConstrainedReque
  * Builds request options to create new record for resources,
  * configured for the url, method and header expectations of most JSON:API APIs.
  *
+ * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and
+ * when to use one.
+ *
  * **Basic Usage**
  *
  * ```ts
@@ -295,6 +310,7 @@ export declare function deleteRecord(record: unknown, options?: ConstrainedReque
  * const data = await store.request(options);
  * ```
  *
+ * @summary Builds a JSON:API `POST` request for saving a new record; the app must set the request body itself.
  * @public
  * @param record
  * @param options
@@ -310,6 +326,9 @@ export declare function createRecord(record: unknown, options?: ConstrainedReque
  * Builds request options to update existing record for resources,
  * configured for the url, method and header expectations of most JSON:API APIs.
  *
+ * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and
+ * when to use one.
+ *
  * **Example Usage**
  *
  * ```ts
@@ -354,6 +373,8 @@ export declare function createRecord(record: unknown, options?: ConstrainedReque
  * const data = await store.request(options);
  * ```
  *
+ * @summary Builds a JSON:API `PUT` (or `PATCH`) request for saving an existing record; the app must set the request
+ * body itself.
  * @public
  * @param record
  * @param options
@@ -364,9 +385,14 @@ export declare function updateRecord<T extends TypedRecordInstance, RT extends T
 export declare function updateRecord(record: unknown, options?: ConstrainedRequestOptions & {
   patch?: boolean;
 }): UpdateRequestOptions;
-//#endregion
-//#region src/-private/json-api/serialize.d.ts
 type ChangedRelationshipData = InnerRelationshipDocument;
+/**
+ * The resource object {@link serializePatch} produces: the resource's `type` and `id` (or `lid`
+ * for a new record) with only its changed attributes and relationships.
+ *
+ * @summary A JSON:API resource object holding only a record's changed attributes and relationships, as produced by `serializePatch`.
+ * @public
+ */
 type JsonApiResourcePatch = {
   type: string;
   id: string;
@@ -389,6 +415,8 @@ type JsonApiResourcePatch = {
  *
  * Serializes the current state of a resource or array of resources for use with POST or PUT requests.
  *
+ * @summary Copies the cached state of one or more resources into a JSON:API-style `{ data }` object, a starting point
+ * for request bodies.
  * @public
  * @param cache - the cache to serialize the resource(s) from
  * @param identifiers - the resource(s) to serialize
@@ -429,6 +457,8 @@ export declare function serializeResources(cache: Cache, identifiers: ResourceKe
  * const relationshipDiffMap = cache.changedRelationships(identifier);
  * ```
  *
+ * @summary Serializes only a resource's changed attributes and relationships from the cache into a JSON:API-style
+ * `{ data }` patch.
  * @public
  * @param cache - the cache to serialize the resource's changes from
  * @param identifier - the resource whose changes should be serialized
@@ -440,8 +470,13 @@ export declare function serializePatch(cache: Cache, identifier: ResourceKey): {
    */
   data: JsonApiResourcePatch;
 };
-//#endregion
-//#region src/-private/json-api/-utils.d.ts
+/**
+ * The configuration {@link setBuildURLConfig} accepts: the {@link BuildURLConfig} fields, plus
+ * the {json:api} profile and extension URIs to send in the `Accept` header.
+ *
+ * @summary Configuration for the JSON:API request builders: host, namespace, and the profile and extension URIs for `Accept`.
+ * @public
+ */
 interface JSONAPIConfig extends BuildURLConfig {
   profiles?: {
     pagination?: string;
@@ -458,6 +493,9 @@ interface JSONAPIConfig extends BuildURLConfig {
  * Extensions and profiles are keyed by their namespace with the value being
  * their URI.
  *
+ * The [Basic Usage](/guides/the-manual/cookbook/basic-usage#step-2-configure-some-request-defaults)
+ * guide uses it to configure a host, a namespace and a pagination profile.
+ *
  * Example:
  *
  * ```ts
@@ -487,10 +525,12 @@ interface JSONAPIConfig extends BuildURLConfig {
  * }
  * ```
  *
+ * @summary Sets the JSON:API extensions and profiles sent in the `Accept` header, plus the global URL host and
+ * namespace.
  * @public
  * @param {BuildURLConfig} config
  * @return {void}
  */
 export declare function setBuildURLConfig(config: JSONAPIConfig): void;
-//#endregion
+export type { JSONAPIConfig, JsonApiResourcePatch };
 //# sourceMappingURL=json-api.d.ts.map

package/dist/json-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"json-api.d.ts","names":[],"sources":["../src/-private/json-api/find-record.ts","../src/-private/json-api/query.ts","../src/-private/json-api/save-record.ts","../src/-private/json-api/serialize.ts","../src/-private/json-api/-utils.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBA0FgB,WAAW,GAAG,UAAU,mBAAmB,kBAAkB,mBAAmB,UAC9F,YAAY,6BAA6B,iBAAiB,KAC1D,UAAU,oBACT,yBAAyB,qBAAqB,GAAG,GAAG,IAAI;wBAC3C,WACd,YAAY,8BACZ,UAAU,oBACT;wBACa,WAAW,GAAG,UAAU,mBAAmB,kBAAkB,mBAAmB,UAC9F,MAAM,iBAAiB,IACvB,YACA,UAAU,oBACT,yBAAyB,qBAAqB,GAAG,GAAG,IAAI;wBAC3C,WAAW,cAAc,YAAY,UAAU,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBCtCnE,MACd,UAAU,qBACV,UAAU,mBAAmB,kBAC7B,mBAAmB,UAEnB,MAAM,iBAAiB,IACvB,QAAQ,mBACR,UAAU,4BACT,oBAAoB,qBAAqB,KAAK,GAAG;wBACpC,MACd,cACA,QAAQ,mBACR,UAAU,4BACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBA0Ea,UAAU,GAAG,UAAU,mBAAmB,kBAAkB,mBAAmB,UAC7F,MAAM,iBAAiB,IACvB,QAAQ,mBACR,UAAU,4BACT,wBAAwB,qBAAqB,KAAK,GAAG;wBACxC,UACd,cACA,QAAQ,mBACR,UAAU,4BACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBC/Ea,aAAa,GAAG,QAAQ,GAAG,UAAU,4BAA4B,qBAAqB;wBACtF,aAAa,iBAAiB,UAAU,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAoFpE,aAAa,GAAG,QAAQ,GAAG,UAAU,4BAA4B,qBAAqB;wBACtF,aAAa,iBAAiB,UAAU,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAsFpE,aACd,UAAU,qBACV,WAAW,sBAAsB,GACjC,UAAU,mBAAmB,kBAC7B,mBAAmB,UAEnB,QAAQ,GACR,UAAU;EAA8B;IACvC,qBAAqB,qBAAqB,IAAI,GAAG,IAAI;wBACxC,aACd,iBACA,UAAU;EAA8B;IACvC;;;KCnQE,0BAA0B;KAEnB;EAEN;EACA;EACA,aAAa,eAAe;EAC5B,gBAAgB,eAAe;;EAG/B;EACA;EACA;EACA,aAAa,eAAe;EAC5B,gBAAgB,eAAe;;;;;;;;;;;;;;;;;wBAkBrB,mBACd,OAAO,OACP,aAAa;;;;EAKb,MAAM;;wBAEQ,mBACd,OAAO,OACP,aAAa;;;;EAKb,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAqGQ,eACd,OAAO,OACP,YAAY;;;;EAMZ,MAAM;;;;UC/JS,sBAAsB;EACrC;IACE;;;EAGF;IACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAiDY,kBAAkB,QAAQ"}
+{"version":3,"file":"json-api.d.ts","names":[],"sources":["../src/-private/json-api/find-record.ts","../src/-private/json-api/query.ts","../src/-private/json-api/save-record.ts","../src/-private/json-api/serialize.ts","../src/-private/json-api/-utils.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBA8FgB,WAAW,GAAG,UAAU,mBAAmB,kBAAkB,mBAAmB,UAC9F,YAAY,6BAA6B,iBAAiB,KAC1D,UAAU,oBACT,yBAAyB,qBAAqB,GAAG,GAAG,IAAI;wBAC3C,WACd,YAAY,8BACZ,UAAU,oBACT;wBACa,WAAW,GAAG,UAAU,mBAAmB,kBAAkB,mBAAmB,UAC9F,MAAM,iBAAiB,IACvB,YACA,UAAU,oBACT,yBAAyB,qBAAqB,GAAG,GAAG,IAAI;wBAC3C,WAAW,cAAc,YAAY,UAAU,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBCtCnE,MACd,UAAU,qBACV,UAAU,mBAAmB,kBAC7B,mBAAmB,UAEnB,MAAM,iBAAiB,IACvB,QAAQ,mBACR,UAAU,4BACT,oBAAoB,qBAAqB,KAAK,GAAG;wBACpC,MACd,cACA,QAAQ,mBACR,UAAU,4BACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBA+Ea,UAAU,GAAG,UAAU,mBAAmB,kBAAkB,mBAAmB,UAC7F,MAAM,iBAAiB,IACvB,QAAQ,mBACR,UAAU,4BACT,wBAAwB,qBAAqB,KAAK,GAAG;wBACxC,UACd,cACA,QAAQ,mBACR,UAAU,4BACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBCpFa,aAAa,GAAG,QAAQ,GAAG,UAAU,4BAA4B,qBAAqB;wBACtF,aAAa,iBAAiB,UAAU,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAwFpE,aAAa,GAAG,QAAQ,GAAG,UAAU,4BAA4B,qBAAqB;wBACtF,aAAa,iBAAiB,UAAU,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBA2FpE,aACd,UAAU,qBACV,WAAW,sBAAsB,GACjC,UAAU,mBAAmB,kBAC7B,mBAAmB,UAEnB,QAAQ,GACR,UAAU;EAA8B;IACvC,qBAAqB,qBAAqB,IAAI,GAAG,IAAI;wBACxC,aACd,iBACA,UAAU;EAA8B;IACvC;KChRE,0BAA0B;;;;;;;;KASnB;EAEN;EACA;EACA,aAAa,eAAe;EAC5B,gBAAgB,eAAe;;EAG/B;EACA;EACA;EACA,aAAa,eAAe;EAC5B,gBAAgB,eAAe;;;;;;;;;;;;;;;;;;;wBAoBrB,mBACd,OAAO,OACP,aAAa;;;;EAKb,MAAM;;wBAEQ,mBACd,OAAO,OACP,aAAa;;;;EAKb,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAuGQ,eACd,OAAO,OACP,YAAY;;;;EAMZ,MAAM;;;;;;;;;UCnKS,sBAAsB;EACrC;IACE;;;EAGF;IACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAsDY,kBAAkB,QAAQ"}

package/dist/json-api.js

@@ -1,10 +1,17 @@
 import { buildBaseURL, buildQueryParams, setBuildURLConfig as setBuildURLConfig$1 } from "./index.js";
-import { s as pluralize } from "./string-CWmAluxh.js";
-import { n as extractCacheOptions, t as copyForwardUrlOptions } from "./builder-utils-BkXwUT0x.js";
+import { s as pluralize } from "./string-DFhbMVCj.js";
+import { n as extractCacheOptions, t as copyForwardUrlOptions } from "./builder-utils-bjXbHa-m.js";
 import { getGlobalConfig, macroCondition } from "@embroider/macros";
 import { recordIdentifierFor } from "@warp-drive-mirror/core";
 
-//#region src/-private/json-api/-utils.ts
+// src/-private/json-api/-utils.ts
+/**
+* The configuration {@link setBuildURLConfig} accepts: the {@link BuildURLConfig} fields, plus
+* the {json:api} profile and extension URIs to send in the `Accept` header.
+*
+* @summary Configuration for the JSON:API request builders: host, namespace, and the profile and extension URIs for `Accept`.
+* @public
+*/
 const JsonApiAccept = "application/vnd.api+json";
 const DEFAULT_CONFIG = {
 	host: "",
@@ -18,6 +25,9 @@ let ACCEPT_HEADER_VALUE = "application/vnd.api+json";
 * Extensions and profiles are keyed by their namespace with the value being
 * their URI.
 *
+* The [Basic Usage](/guides/the-manual/cookbook/basic-usage#step-2-configure-some-request-defaults)
+* guide uses it to configure a host, a namespace and a pagination profile.
+*
 * Example:
 *
 * ```ts
@@ -47,6 +57,8 @@ let ACCEPT_HEADER_VALUE = "application/vnd.api+json";
 * }
 * ```
 *
+* @summary Sets the JSON:API extensions and profiles sent in the `Accept` header, plus the global URL host and
+* namespace.
 * @public
 * @param {BuildURLConfig} config
 * @return {void}
@@ -68,8 +80,7 @@ function setBuildURLConfig(config) {
 	setBuildURLConfig$1(config);
 }
 
-//#endregion
-//#region src/-private/json-api/find-record.ts
+// src/-private/json-api/find-record.ts
 function findRecord(arg1, arg2, arg3) {
 	const identifier = typeof arg1 === "string" ? {
 		type: arg1,
@@ -96,8 +107,7 @@ function findRecord(arg1, arg2, arg3) {
 	};
 }
 
-//#endregion
-//#region src/-private/json-api/query.ts
+// src/-private/json-api/query.ts
 function query(type, query = {}, options = {}) {
 	const cacheOptions = extractCacheOptions(options);
 	const urlOptions = {
@@ -141,8 +151,7 @@ function postQuery(type, query = {}, options = {}) {
 	};
 }
 
-//#endregion
-//#region src/-private/json-api/save-record.ts
+// src/-private/json-api/save-record.ts
 function isExisting(identifier) {
 	return "id" in identifier && identifier.id !== null && "type" in identifier && identifier.type !== null;
 }
@@ -155,6 +164,9 @@ function isExisting(identifier) {
 * Builds request options to delete record for resources,
 * configured for the url, method and header expectations of most JSON:API APIs.
 *
+* See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and
+* when to use one.
+*
 * **Basic Usage**
 *
 * ```ts
@@ -196,6 +208,7 @@ function isExisting(identifier) {
 * const data = await store.request(options);
 * ```
 *
+* @summary Builds a JSON:API `DELETE` request that persists deletion of an existing record.
 * @public
 * @param record
 * @param options
@@ -235,6 +248,9 @@ function deleteRecord(record, options = {}) {
 * Builds request options to create new record for resources,
 * configured for the url, method and header expectations of most JSON:API APIs.
 *
+* See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and
+* when to use one.
+*
 * **Basic Usage**
 *
 * ```ts
@@ -276,6 +292,7 @@ function deleteRecord(record, options = {}) {
 * const data = await store.request(options);
 * ```
 *
+* @summary Builds a JSON:API `POST` request for saving a new record; the app must set the request body itself.
 * @public
 * @param record
 * @param options
@@ -312,6 +329,9 @@ function createRecord(record, options = {}) {
 * Builds request options to update existing record for resources,
 * configured for the url, method and header expectations of most JSON:API APIs.
 *
+* See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and
+* when to use one.
+*
 * **Example Usage**
 *
 * ```ts
@@ -356,6 +376,8 @@ function createRecord(record, options = {}) {
 * const data = await store.request(options);
 * ```
 *
+* @summary Builds a JSON:API `PUT` (or `PATCH`) request for saving an existing record; the app must set the request
+* body itself.
 * @public
 * @param record
 * @param options
@@ -387,8 +409,14 @@ function updateRecord(record, options = {}) {
 	};
 }
 
-//#endregion
-//#region src/-private/json-api/serialize.ts
+// src/-private/json-api/serialize.ts
+/**
+* The resource object {@link serializePatch} produces: the resource's `type` and `id` (or `lid`
+* for a new record) with only its changed attributes and relationships.
+*
+* @summary A JSON:API resource object holding only a record's changed attributes and relationships, as produced by `serializePatch`.
+* @public
+*/
 /**
 * :::warning ⚠️ **This util often won't produce the necessary body for a {json:api} request**
 *
@@ -399,6 +427,8 @@ function updateRecord(record, options = {}) {
 *
 * Serializes the current state of a resource or array of resources for use with POST or PUT requests.
 *
+* @summary Copies the cached state of one or more resources into a JSON:API-style `{ data }` object, a starting point
+* for request bodies.
 * @public
 * @param cache - the cache to serialize the resource(s) from
 * @param identifiers - the resource(s) to serialize
@@ -461,6 +491,8 @@ function _serializeResource(cache, identifier) {
 * const relationshipDiffMap = cache.changedRelationships(identifier);
 * ```
 *
+* @summary Serializes only a resource's changed attributes and relationships from the cache into a JSON:API-style
+* `{ data }` patch.
 * @public
 * @param cache - the cache to serialize the resource's changes from
 * @param identifier - the resource whose changes should be serialized
@@ -499,6 +531,5 @@ function serializePatch(cache, identifier) {
 	return { data };
 }
 
-//#endregion
 export { createRecord, deleteRecord, findRecord, postQuery, query, serializePatch, serializeResources, setBuildURLConfig, updateRecord };
 //# sourceMappingURL=json-api.js.map

package/dist/json-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"json-api.js","names":["recordIdentifierFor","buildBaseURL","pluralize","copyForwardUrlOptions","ACCEPT_HEADER_VALUE","macroCondition","getGlobalConfig","isExisting","identifier","id","type","deleteRecord","record","options","WarpDrive","env","DEBUG","test","Error","urlOptions","op","resourcePath","url","headers","Headers","append","method","data","records","createRecord","updateRecord","patch","patchRecord","opts","serializeResources","cache","identifiers","data","Array","isArray","map","identifier","_serializeResource","fixRef","id","lid","type","fixRelData","rel","ref","record","structuredClone","peek","macroCondition","getGlobalConfig","WarpDrive","env","DEBUG","test","Error","String","relationships","key","Object","keys","relationship","length","serializePatch","hasChangedAttrs","attrsChanges","changedAttrs","attributes","forEach","change","newVal","undefined","changedRelationships","size","diff","localState"],"sources":["../src/-private/json-api/-utils.ts","../src/-private/json-api/find-record.ts","../src/-private/json-api/query.ts","../src/-private/json-api/save-record.ts","../src/-private/json-api/serialize.ts"],"sourcesContent":["import type { QueryParamsSource } from '@warp-drive-mirror/core/types/params';\n\nimport type { BuildURLConfig } from '../../index.ts';\nimport { buildQueryParams as buildParams, setBuildURLConfig as setConfig } from '../../index.ts';\n\nexport interface JSONAPIConfig extends BuildURLConfig {\n  profiles?: {\n    pagination?: string;\n    [key: string]: string | undefined;\n  };\n  extensions?: {\n    atomic?: string;\n    [key: string]: string | undefined;\n  };\n}\n\nconst JsonApiAccept = 'application/vnd.api+json';\nconst DEFAULT_CONFIG: JSONAPIConfig = { host: '', namespace: '' };\nexport let CONFIG: JSONAPIConfig = DEFAULT_CONFIG;\nexport let ACCEPT_HEADER_VALUE = 'application/vnd.api+json';\n\n/**\n * Allows setting extensions and profiles to be used in the `Accept` header.\n *\n * Extensions and profiles are keyed by their namespace with the value being\n * their URI.\n *\n * Example:\n *\n * ```ts\n * setBuildURLConfig({\n *   extensions: {\n *     atomic: 'https://jsonapi.org/ext/atomic'\n *   },\n *   profiles: {\n *     pagination: 'https://jsonapi.org/profiles/ethanresnick/cursor-pagination'\n *   }\n * });\n * ```\n *\n * This also sets the global configuration for `buildBaseURL`\n * for host and namespace values for the global coniguration\n * done via `import { setBuildURLConfig } from '@warp-drive-mirror/utilities';`\n *\n * These values may still be overridden by passing\n * them to buildBaseURL directly.\n *\n * This method may be called as many times as needed\n *\n * ```ts\n * type BuildURLConfig = {\n *   host: string;\n *   namespace: string'\n * }\n * ```\n *\n * @public\n * @param {BuildURLConfig} config\n * @return {void}\n */\nexport function setBuildURLConfig(config: JSONAPIConfig): void {\n  CONFIG = Object.assign({}, DEFAULT_CONFIG, config);\n\n  if (config.profiles || config.extensions) {\n    let accept = JsonApiAccept;\n    if (config.profiles) {\n      const profiles = Object.values(config.profiles);\n      if (profiles.length) {\n        accept += ';profile=\"' + profiles.join(' ') + '\"';\n      }\n    }\n    if (config.extensions) {\n      const extensions = Object.values(config.extensions);\n      if (extensions.length) {\n        accept += ';ext=' + extensions.join(' ');\n      }\n    }\n    ACCEPT_HEADER_VALUE = accept;\n  }\n\n  setConfig(config);\n}\n\ninterface RelatedObject {\n  [key: string]: string | string[] | RelatedObject;\n}\n\nexport type JsonApiQuery = {\n  include?: string | string[] | RelatedObject;\n  fields?: Record<string, string | string[]>;\n  page?: {\n    size?: number;\n    after?: string;\n    before?: string;\n  };\n};\n\nfunction isJsonApiQuery(query: JsonApiQuery | QueryParamsSource): query is JsonApiQuery {\n  if ('include' in query && query.include && typeof query.include === 'object') {\n    return true;\n  }\n  if ('fields' in query || 'page' in query) {\n    return true;\n  }\n  return false;\n}\n\nfunction collapseIncludePaths(basePath: string, include: RelatedObject, paths: string[]) {\n  const keys = Object.keys(include);\n  for (let i = 0; i < keys.length; i++) {\n    // the key is always included too\n    paths.push(`${basePath}.${keys[i]}`);\n    const key = keys[i];\n    const value = include[key];\n\n    // include: { 'company': 'field1,field2' }\n    if (typeof value === 'string') {\n      value.split(',').forEach((field) => {\n        paths.push(`${basePath}.${key}.${field}`);\n      });\n\n      // include: { 'company': ['field1', 'field2'] }\n    } else if (Array.isArray(value)) {\n      value.forEach((field) => {\n        paths.push(`${basePath}.${key}.${field}`);\n      });\n\n      // include: { 'company': { 'nested': 'field1,field2' } }\n    } else {\n      collapseIncludePaths(`${basePath}.${key}`, value, paths);\n    }\n  }\n}\n\n/**\n * Sorts query params by both key and value, returning a query params string\n *\n * Treats `included` specially, splicing it into an array if it is a string and sorting the array.\n *   - If `included` is an object we build paths dynamically for you\n * Treats `fields` specially, building JSON:API partial fields params from an object\n * Treats `page` specially, building cursor-pagination profile page params from an object\n *\n * ```ts\n * const params = buildQueryParams({\n *  include: {\n *    company: {\n *      locations: 'address'\n *    }\n *  },\n *   fields: {\n *     company: ['name', 'ticker'],\n *     person: 'name'\n *   },\n *   page: {\n *     size: 10,\n *     after: 'abc',\n *   }\n * });\n *\n * // => 'fields[company]=name,ticker&fields[person]=name&include=company.locations,company.locations.address&page[after]=abc&page[size]=10'\n * ```\n *\n * Options:\n * - arrayFormat: 'bracket' | 'indices' | 'repeat' | 'comma'\n *\n * 'bracket': appends [] to the key for every value e.g. `ids[]=1&ids[]=2`\n * 'indices': appends [i] to the key for every value e.g. `ids[0]=1&ids[1]=2`\n * 'repeat': appends the key for every value e.g. `ids=1&ids=2`\n * 'comma' (default): appends the key once with a comma separated list of values e.g. `ids=1,2`\n *\n * @public\n * @param {URLSearchParams | Object} params\n * @param {Object} [options]\n * @return {String} A sorted query params string without the leading `?`\n */\nexport function buildQueryParams(query: JsonApiQuery | QueryParamsSource): string {\n  if (query instanceof URLSearchParams) {\n    return buildParams(query);\n  }\n\n  if (!isJsonApiQuery(query)) {\n    return buildParams(query);\n  }\n\n  const { include, fields, page, ...rest } = query;\n  const finalQuery: QueryParamsSource = {\n    ...rest,\n  };\n\n  if ('include' in query) {\n    // include: { 'company': 'field1,field2' }\n    // include: { 'company': ['field1', 'field2'] }\n    // include: { 'company': { 'nested': 'field1,field2' } }\n    // include: { 'company': { 'nested': ['field1', 'field2'] } }\n    if (include && !Array.isArray(include) && typeof include === 'object') {\n      const includePaths: string[] = [];\n      collapseIncludePaths('', include, includePaths);\n      finalQuery.include = includePaths.sort();\n\n      // include: 'field1,field2'\n      // include: ['field1', 'field2']\n    } else {\n      finalQuery.include = include;\n    }\n  }\n\n  if (fields) {\n    const keys = Object.keys(fields).sort();\n    for (let i = 0; i < keys.length; i++) {\n      const resourceType = keys[i];\n      const value = fields[resourceType];\n\n      // fields: { 'company': ['field1', 'field2'] }\n      if (Array.isArray(value)) {\n        finalQuery[`fields[${resourceType}]`] = value.sort().join(',');\n\n        // fields: { 'company': 'field1' }\n        // fields: { 'company': 'field1,field2' }\n      } else {\n        finalQuery[`fields[${resourceType}]`] = value.split(',').sort().join(',');\n      }\n    }\n  }\n\n  if (page) {\n    const keys = Object.keys(page).sort() as Array<'size' | 'after' | 'before'>;\n    keys.forEach((key) => {\n      const value = page[key];\n      finalQuery[`page[${key}]`] = value!;\n    });\n  }\n\n  return buildParams(finalQuery);\n}\n","import type { ReactiveDataDocument } from '@warp-drive-mirror/core/reactive';\nimport type { TypeFromInstance } from '@warp-drive-mirror/core/types/record';\nimport type {\n  FindRecordOptions,\n  FindRecordRequestOptions,\n  RemotelyAccessibleIdentifier,\n} from '@warp-drive-mirror/core/types/request';\nimport type { ApiError } from '@warp-drive-mirror/core/types/spec/error';\nimport type { Meta } from '@warp-drive-mirror/core/types/spec/json-api-raw';\n\nimport { buildBaseURL, buildQueryParams, type FindRecordUrlOptions } from '../../index.ts';\nimport { pluralize } from '../../string.ts';\nimport { copyForwardUrlOptions, extractCacheOptions } from '../builder-utils.ts';\nimport { ACCEPT_HEADER_VALUE } from './-utils.ts';\n\n/**\n * Builds request options to fetch a single resource by a known id or identifier\n * configured for the url and header expectations of most JSON:API APIs.\n *\n * :::tabs\n *\n * == Basic Usage\n *\n * ```ts\n * import { findRecord } from '@warp-drive-mirror/utilities/json-api';\n * import type { Person } from '#/data/types';\n *\n * const result = await store.request(\n *   findRecord<Person>('person', '1')\n * );\n * ```\n *\n * == With Options\n *\n * ```ts\n * import { findRecord } from '@warp-drive-mirror/utilities/json-api';\n * import type { Person } from '#/data/types';\n *\n * const data = await store.request(\n *   findRecord<Person>(\n *     'person', '1',\n *     { include: ['pets', 'friends'] }\n *   )\n * );\n * ```\n *\n * == With an Identifier\n *\n * ```ts\n * import { findRecord } from '@warp-drive-mirror/utilities/json-api';\n * import type { Person } from '#/data/types';\n *\n * const data = await store.request(\n *   findRecord<Person>(\n *     { type: 'person', id: '1' },\n *     { include: ['pets', 'friends'] }\n *   )\n * );\n * ```\n *\n * :::\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { findRecord } from '@warp-drive-mirror/utilities/json-api';\n *\n * const data = await store.request(\n *   findRecord(\n *     'person', '1',\n *     { include: ['pets', 'friends'] },\n *     { namespace: 'api/v2' }\n *   )\n * );\n * ```\n *\n * @public\n */\nexport function findRecord<T, M extends Meta | undefined = Meta | undefined, E extends object = ApiError>(\n  identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>,\n  options?: FindRecordOptions\n): FindRecordRequestOptions<ReactiveDataDocument<T, M, E>, T>;\nexport function findRecord(\n  identifier: RemotelyAccessibleIdentifier,\n  options?: FindRecordOptions\n): FindRecordRequestOptions;\nexport function findRecord<T, M extends Meta | undefined = Meta | undefined, E extends object = ApiError>(\n  type: TypeFromInstance<T>,\n  id: string,\n  options?: FindRecordOptions\n): FindRecordRequestOptions<ReactiveDataDocument<T, M, E>, T>;\nexport function findRecord(type: string, id: string, options?: FindRecordOptions): FindRecordRequestOptions;\nexport function findRecord(\n  arg1: string | RemotelyAccessibleIdentifier,\n  arg2: string | FindRecordOptions | undefined,\n  arg3?: FindRecordOptions\n): FindRecordRequestOptions {\n  const identifier: RemotelyAccessibleIdentifier = typeof arg1 === 'string' ? { type: arg1, id: arg2 as string } : arg1;\n  const options = ((typeof arg1 === 'string' ? arg3 : arg2) || {}) as FindRecordOptions;\n  const cacheOptions = extractCacheOptions(options);\n  const urlOptions: FindRecordUrlOptions = {\n    identifier,\n    op: 'findRecord',\n    resourcePath: pluralize(identifier.type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  return {\n    url: options.include?.length\n      ? `${url}?${buildQueryParams({ include: options.include }, options.urlParamsSettings)}`\n      : url,\n    method: 'GET',\n    headers,\n    cacheOptions,\n    op: 'findRecord',\n    records: [identifier],\n  };\n}\n\n/** @deprecated use {@link ReactiveDataDocument} */\nexport type FindRecordResultDocument<\n  T,\n  M extends Meta | undefined = Meta | undefined,\n  E extends object = ApiError,\n> = ReactiveDataDocument<T, M, E>;\n","import type { ReactiveDataDocument } from '@warp-drive-mirror/core/reactive';\nimport type { QueryParamsSource } from '@warp-drive-mirror/core/types/params';\nimport type { TypedRecordInstance, TypeFromInstance } from '@warp-drive-mirror/core/types/record';\nimport type {\n  CacheOptions,\n  ConstrainedRequestOptions,\n  PostQueryRequestOptions,\n  QueryRequestOptions,\n} from '@warp-drive-mirror/core/types/request';\nimport type { ApiError } from '@warp-drive-mirror/core/types/spec/error';\nimport type { Meta } from '@warp-drive-mirror/core/types/spec/json-api-raw';\n\nimport { buildBaseURL, buildQueryParams, type QueryUrlOptions } from '../../index.ts';\nimport { pluralize } from '../../string.ts';\nimport { copyForwardUrlOptions, extractCacheOptions } from '../builder-utils.ts';\nimport { ACCEPT_HEADER_VALUE } from './-utils.ts';\n/**\n * Builds request options to query for resources, usually by a primary\n * type, configured for the url and header expectations of most JSON:API APIs.\n *\n * The key difference between this and `postQuery` is that this method will send the query\n * as query params in the url of a \"GET\" request instead of as the JSON body of a \"POST\"\n * request.\n *\n * **Basic Usage**\n *\n * ```ts\n * import { query } from '@warp-drive-mirror/utilities/json-api';\n *\n * const data = await store.request(query('person'));\n * ```\n *\n * **With Query Params**\n *\n * ```ts\n * import { query } from '@warp-drive-mirror/utilities/json-api';\n *\n * const options = query('person', { include: ['pets', 'friends'] });\n * const data = await store.request(options);\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { query } from '@warp-drive-mirror/utilities/json-api';\n *\n * const options = query('person', { include: ['pets', 'friends'] }, { reload: true });\n * const data = await store.request(options);\n * ```\n *\n * @public\n * @badge Builder\n */\nexport function query<\n  T extends TypedRecordInstance,\n  M extends Meta | undefined = Meta | undefined,\n  E extends object = ApiError,\n>(\n  type: TypeFromInstance<T>,\n  query?: QueryParamsSource,\n  options?: ConstrainedRequestOptions\n): QueryRequestOptions<ReactiveDataDocument<T[], M, E>>;\nexport function query(\n  type: string,\n  query?: QueryParamsSource,\n  options?: ConstrainedRequestOptions\n): QueryRequestOptions;\nexport function query(\n  type: string,\n  // oxlint-disable-next-line no-shadow\n  query: QueryParamsSource = {},\n  options: ConstrainedRequestOptions = {}\n): QueryRequestOptions {\n  const cacheOptions = extractCacheOptions(options);\n  const urlOptions: QueryUrlOptions = {\n    identifier: { type },\n    op: 'query',\n    resourcePath: pluralize(type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n  const queryString = buildQueryParams(query, options.urlParamsSettings);\n\n  return {\n    url: queryString ? `${url}?${queryString}` : url,\n    method: 'GET',\n    headers,\n    cacheOptions,\n    op: 'query',\n  };\n}\n\n/**\n * Builds request options to query for resources, usually by a primary\n * type, configured for the url and header expectations of most JSON:API APIs.\n *\n * The key difference between this and `query` is that this method will send the query\n * as the JSON body of a \"POST\" request instead of as query params in the url of a \"GET\"\n * request.\n *\n * A CacheKey is generated from the url and query params, and used to cache the response\n * in the store.\n *\n * ```ts\n * import { postQuery } from '@warp-drive-mirror/utilities/json-api';\n *\n * const options = postQuery('person', { include: ['pets', 'friends'] });\n * const data = await store.request(options);\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { postQuery } from '@warp-drive-mirror/utilities/json-api';\n *\n * const options = postQuery('person', { include: ['pets', 'friends'] }, { reload: true });\n * const data = await store.request(options);\n * ```\n *\n * @public\n * @param type - the name of the resource type to query\n * @param query - the query params to send with the request\n * @param options - options to modify the request behavior\n */\nexport function postQuery<T, M extends Meta | undefined = Meta | undefined, E extends object = ApiError>(\n  type: TypeFromInstance<T>,\n  query?: QueryParamsSource,\n  options?: ConstrainedRequestOptions\n): PostQueryRequestOptions<ReactiveDataDocument<T[], M, E>>;\nexport function postQuery(\n  type: string,\n  query?: QueryParamsSource,\n  options?: ConstrainedRequestOptions\n): PostQueryRequestOptions;\nexport function postQuery(\n  type: string,\n  // oxlint-disable-next-line no-shadow\n  query: QueryParamsSource = {},\n  options: ConstrainedRequestOptions = {}\n): PostQueryRequestOptions {\n  const cacheOptions = extractCacheOptions(options);\n  const urlOptions: QueryUrlOptions = {\n    identifier: { type },\n    op: 'query',\n    resourcePath: options.resourcePath ?? pluralize(type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  const queryData = structuredClone(query);\n  cacheOptions.key = cacheOptions.key ?? `${url}?${buildQueryParams(queryData, options.urlParamsSettings)}`;\n\n  return {\n    url,\n    method: 'POST',\n    body: JSON.stringify(query),\n    headers,\n    cacheOptions: cacheOptions as CacheOptions & { key: string },\n    op: 'query',\n  };\n}\n","import { recordIdentifierFor } from '@warp-drive-mirror/core';\nimport { assert } from '@warp-drive-mirror/core/build-config/macros';\nimport type { ReactiveDataDocument } from '@warp-drive-mirror/core/reactive';\nimport type { PersistedResourceKey, ResourceKey } from '@warp-drive-mirror/core/types/identifier';\nimport type { TypedRecordInstance } from '@warp-drive-mirror/core/types/record';\nimport type {\n  ConstrainedRequestOptions,\n  CreateRequestOptions,\n  DeleteRequestOptions,\n  UpdateRequestOptions,\n} from '@warp-drive-mirror/core/types/request';\nimport type { ApiError } from '@warp-drive-mirror/core/types/spec/error';\nimport type { Meta } from '@warp-drive-mirror/core/types/spec/json-api-raw';\n\nimport {\n  buildBaseURL,\n  type CreateRecordUrlOptions,\n  type DeleteRecordUrlOptions,\n  type UpdateRecordUrlOptions,\n} from '../../index.ts';\nimport { pluralize } from '../../string.ts';\nimport { copyForwardUrlOptions } from '../builder-utils.ts';\nimport { ACCEPT_HEADER_VALUE } from './-utils.ts';\n\nfunction isExisting(identifier: ResourceKey): identifier is PersistedResourceKey {\n  return 'id' in identifier && identifier.id !== null && 'type' in identifier && identifier.type !== null;\n}\n\n/**\n * :::warning ⚠️ **These Mutation Builders DO NOT Set The Request Body**\n * While this may come as a surprise, the app providing the body ensures that only\n * desired and correctly formatted data is sent with the request.\n * :::\n *\n * Builds request options to delete record for resources,\n * configured for the url, method and header expectations of most JSON:API APIs.\n *\n * **Basic Usage**\n *\n * ```ts\n * import { deleteRecord } from '@warp-drive-mirror/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n *\n * // mark record as deleted\n * store.deleteRecord(person);\n *\n * // persist deletion\n * const data = await store.request(deleteRecord(person));\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { deleteRecord } from '@warp-drive-mirror/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n *\n * // mark record as deleted\n * store.deleteRecord(person);\n *\n * // persist deletion\n * const options = deleteRecord(person, { namespace: 'api/v1' });\n * const data = await store.request(options);\n * ```\n *\n * @public\n * @param record\n * @param options\n */\nexport function deleteRecord<T>(record: T, options?: ConstrainedRequestOptions): DeleteRequestOptions<T>;\nexport function deleteRecord(record: unknown, options?: ConstrainedRequestOptions): DeleteRequestOptions;\nexport function deleteRecord(record: unknown, options: ConstrainedRequestOptions = {}): DeleteRequestOptions {\n  const identifier = recordIdentifierFor(record);\n  assert(`Expected to be given a record instance`, identifier);\n  assert(`Cannot delete a record that does not have an associated type and id.`, isExisting(identifier));\n\n  const urlOptions: DeleteRecordUrlOptions = {\n    identifier: identifier,\n    op: 'deleteRecord',\n    resourcePath: pluralize(identifier.type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  return {\n    url,\n    method: 'DELETE',\n    headers,\n    op: 'deleteRecord',\n    data: {\n      record: identifier,\n    },\n    records: [identifier],\n  };\n}\n\n/**\n * :::warning ⚠️ **These Mutation Builders DO NOT Set The Necessary Request Body**\n * While this may come as a surprise, the app providing the body ensures that only\n * desired and correctly formatted data is sent with the request.\n * :::\n *\n * Builds request options to create new record for resources,\n * configured for the url, method and header expectations of most JSON:API APIs.\n *\n * **Basic Usage**\n *\n * ```ts\n * import { cacheKeyFor } from '@warp-drive-mirror/core';\n * import { createRecord } from '@warp-drive-mirror/utilities/json-api';\n * import type { Person } from '#/data/types';\n *\n * const person = store.createRecord<Person>('person', { name: 'Ted' });\n * const init = createRecord(person);\n * init.body = JSON.stringify(\n *  {\n *    // it's likely you will want to transform this data\n *    // somewhat\n *    data: store.cache.peek(cacheKeyFor(person))\n *  }\n * );\n * const data = await store.request(init);\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { createRecord } from '@warp-drive-mirror/utilities/json-api';\n *\n * const person = store.createRecord('person', { name: 'Ted' });\n * const options = createRecord(person, { namespace: 'api/v1' });\n * const data = await store.request(options);\n * ```\n *\n * @public\n * @param record\n * @param options\n */\nexport function createRecord<T>(record: T, options?: ConstrainedRequestOptions): CreateRequestOptions<T>;\nexport function createRecord(record: unknown, options?: ConstrainedRequestOptions): CreateRequestOptions;\nexport function createRecord(record: unknown, options: ConstrainedRequestOptions = {}): CreateRequestOptions {\n  const identifier = recordIdentifierFor(record);\n  assert(`Expected to be given a record instance`, identifier);\n\n  const urlOptions: CreateRecordUrlOptions = {\n    identifier: identifier,\n    op: 'createRecord',\n    resourcePath: pluralize(identifier.type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  return {\n    url,\n    method: 'POST',\n    headers,\n    op: 'createRecord',\n    data: {\n      record: identifier,\n    },\n    records: [identifier],\n  };\n}\n\n/**\n * :::warning ⚠️ **These Mutation Builders DO NOT Set The Necessary Request Body**\n * While this may come as a surprise, the app providing the body ensures that only\n * desired and correctly formatted data is sent with the request.\n * :::\n *\n * Builds request options to update existing record for resources,\n * configured for the url, method and header expectations of most JSON:API APIs.\n *\n * **Example Usage**\n *\n * ```ts\n * import { cacheKeyFor } from '@warp-drive-mirror/core';\n * import { updateRecord } from '@warp-drive-mirror/utilities/json-api';\n * import type { EditablePerson } from '#/data/types';\n *\n * const mutable = await checkout<EditablePerson>(person);\n * mutable.name = 'Chris';\n * const init = updateRecord(mutable);\n *\n * init.body = JSON.stringify(\n *  // it's likely you will want to transform this data\n *  // somewhat, or serialize only specific properties instead\n *  serializePatch(store.cache, cacheKeyFor(mutable))\n * );\n * const data = await store.request(init);\n * ```\n *\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `patch` - Allows caller to specify whether to use a PATCH request instead of a PUT request, defaults to `false`.\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { updateRecord } from '@warp-drive-mirror/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n * person.name = 'Chris';\n * const options = updateRecord(person, { patch: true });\n * const data = await store.request(options);\n * ```\n *\n * @public\n * @param record\n * @param options\n */\nexport function updateRecord<\n  T extends TypedRecordInstance,\n  RT extends TypedRecordInstance = T,\n  M extends Meta | undefined = Meta | undefined,\n  E extends object = ApiError,\n>(\n  record: T,\n  options?: ConstrainedRequestOptions & { patch?: boolean }\n): UpdateRequestOptions<ReactiveDataDocument<RT, M, E>, T>;\nexport function updateRecord(\n  record: unknown,\n  options?: ConstrainedRequestOptions & { patch?: boolean }\n): UpdateRequestOptions;\nexport function updateRecord(\n  record: unknown,\n  options: ConstrainedRequestOptions & { patch?: boolean } = {}\n): UpdateRequestOptions {\n  const identifier = recordIdentifierFor(record);\n  assert(`Expected to be given a record instance`, identifier);\n  assert(`Cannot update a record that does not have an associated type and id.`, isExisting(identifier));\n\n  const urlOptions: UpdateRecordUrlOptions = {\n    identifier: identifier,\n    op: 'updateRecord',\n    resourcePath: pluralize(identifier.type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  return {\n    url,\n    method: options.patch ? 'PATCH' : 'PUT',\n    headers,\n    op: 'updateRecord',\n    data: {\n      record: identifier,\n    },\n    records: [identifier],\n  };\n}\n\n/**\n * Builds request options to update existing record for resources,\n * configured for the url and header expectations of most JSON:API APIs\n * for a PATCH request.\n *\n * Note: This is a convenience method that calls `updateRecord` with the\n * supplied request with the `patch` option set to `true`.\n *\n * **Basic Usage**\n *\n * ```ts\n * import { patchRecord } from '@warp-drive-mirror/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n * person.name = 'Chris';\n * const data = await store.request(patchRecord(person));\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { patchRecord } from '@warp-drive-mirror/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n * person.name = 'Chris';\n * const options = patchRecord(person);\n * const data = await store.request(options);\n * ```\n *\n * @public\n * @param record\n * @param options\n */\nexport function patchRecord<T>(record: T, options?: ConstrainedRequestOptions): UpdateRequestOptions<T>;\nexport function patchRecord(record: unknown, options?: ConstrainedRequestOptions): UpdateRequestOptions;\nexport function patchRecord(record: unknown, options: ConstrainedRequestOptions = {}): UpdateRequestOptions {\n  const opts = options as ConstrainedRequestOptions & { patch: true };\n  opts.patch = true;\n  return updateRecord(record, opts);\n}\n","import { assert } from '@warp-drive-mirror/core/build-config/macros';\nimport type { Cache } from '@warp-drive-mirror/core/types/cache';\nimport type { Relationship } from '@warp-drive-mirror/core/types/cache/relationship';\nimport type { ResourceKey } from '@warp-drive-mirror/core/types/identifier';\nimport type { Value } from '@warp-drive-mirror/core/types/json/raw';\nimport type { InnerRelationshipDocument, ResourceObject } from '@warp-drive-mirror/core/types/spec/json-api-raw';\n\ntype ChangedRelationshipData = InnerRelationshipDocument;\n\nexport type JsonApiResourcePatch =\n  | {\n      type: string;\n      id: string;\n      attributes?: Record<string, Value>;\n      relationships?: Record<string, ChangedRelationshipData>;\n    }\n  | {\n      type: string;\n      id: null;\n      lid: string;\n      attributes?: Record<string, Value>;\n      relationships?: Record<string, ChangedRelationshipData>;\n    };\n\n/**\n * :::warning ⚠️ **This util often won't produce the necessary body for a {json:api} request**\n *\n * While this may come as a surprise, they are intended to serialize cache state for more\n * generalized usage. {json:api} has a large variance in acceptable shapes, and only your\n * app can ensure that the body is correctly formatted and contains all necessary data.\n * :::\n *\n * Serializes the current state of a resource or array of resources for use with POST or PUT requests.\n *\n * @public\n * @param cache - the cache to serialize the resource(s) from\n * @param identifiers - the resource(s) to serialize\n * @return an object with a `data` property containing the serialized resource(s)\n */\nexport function serializeResources(\n  cache: Cache,\n  identifiers: ResourceKey\n): {\n  /**\n   * The serialized resource.\n   */\n  data: ResourceObject;\n};\nexport function serializeResources(\n  cache: Cache,\n  identifiers: ResourceKey[]\n): {\n  /**\n   * The serialized resources.\n   */\n  data: ResourceObject[];\n};\nexport function serializeResources(\n  cache: Cache,\n  identifiers: ResourceKey | ResourceKey[]\n): { data: ResourceObject | ResourceObject[] } {\n  return {\n    data: Array.isArray(identifiers)\n      ? identifiers.map((identifier) => _serializeResource(cache, identifier))\n      : _serializeResource(cache, identifiers),\n  };\n}\n\ntype SerializedRef =\n  | {\n      id: string;\n      type: string;\n    }\n  | { id: null; lid: string; type: string };\n\nfunction fixRef({\n  id,\n  lid,\n  type,\n}: { id: string; lid?: string; type: string } | { id: null; lid: string; type: string }): SerializedRef {\n  if (id !== null) {\n    return { id, type };\n  }\n  return { id, lid, type };\n}\n\nfunction fixRelData(\n  rel: Relationship['data'] | InnerRelationshipDocument['data']\n): SerializedRef | SerializedRef[] | null {\n  if (Array.isArray(rel)) {\n    return rel.map((ref) => fixRef(ref));\n  } else if (typeof rel === 'object' && rel !== null) {\n    return fixRef(rel);\n  }\n  return null;\n}\n\nfunction _serializeResource(cache: Cache, identifier: ResourceKey): ResourceObject {\n  const { id, lid, type } = identifier;\n  // peek gives us everything we want, but since its referentially the same data\n  // as is in the cache we clone it to avoid any accidental mutations\n  const record = structuredClone(cache.peek(identifier)) as ResourceObject;\n  assert(\n    `A record with id ${String(id)} and type ${type} for lid ${lid} was not found not in the supplied Cache.`,\n    record\n  );\n\n  // remove lid from anything that has an ID and slice any relationship arrays\n  if (record.id !== null) {\n    delete record.lid;\n  }\n\n  if (record.relationships) {\n    for (const key of Object.keys(record.relationships)) {\n      const relationship = record.relationships[key];\n      if (Array.isArray(relationship.data)) {\n        relationship.data = relationship.data.map((ref) => fixRef(ref));\n      } else if (typeof relationship.data === 'object' && relationship.data !== null) {\n        relationship.data = fixRef(relationship.data);\n      } else if (Object.keys(relationship ?? {}).length === 0) {\n        delete record.relationships[key];\n      }\n    }\n  }\n\n  return record;\n}\n\n/**\n * :::warning ⚠️ **This util often won't produce the necessary body for a {json:api} request**\n *\n * While this may come as a surprise, they are intended to serialize cache state for more\n * generalized usage. {json:api} has a large variance in acceptable shapes, and only your\n * app can ensure that the body is correctly formatted and contains all necessary data.\n * :::\n *\n * Serializes changes to a resource. Useful for use with building bodies for PATCH requests.\n *\n * Only attributes which are changed are serialized.\n * Only relationships which are changed are serialized.\n *\n * Collection relationships serialize the collection as a whole.\n *\n * If you would like to serialize updates to a collection more granularly\n * (for instance, as operations) request the diff from the store and\n * serialize as desired:\n *\n * ```ts\n * const relationshipDiffMap = cache.changedRelationships(identifier);\n * ```\n *\n * @public\n * @param cache - the cache to serialize the resource's changes from\n * @param identifier - the resource whose changes should be serialized\n * @return an object with a `data` property containing the serialized resource patch\n */\nexport function serializePatch(\n  cache: Cache,\n  identifier: ResourceKey\n  // options: { include?: string[] } = {}\n): {\n  /**\n   * The serialized resource patch.\n   */\n  data: JsonApiResourcePatch;\n} {\n  const { id, lid, type } = identifier;\n  assert(\n    `A record with id ${String(id)} and type ${type} for lid ${lid} was not found not in the supplied Cache.`,\n    cache.peek(identifier)\n  );\n\n  const data: JsonApiResourcePatch =\n    id === null\n      ? { type, lid, id }\n      : {\n          type,\n          id,\n        };\n\n  if (cache.hasChangedAttrs(identifier)) {\n    const attrsChanges = cache.changedAttrs(identifier);\n    const attributes: ResourceObject['attributes'] = {};\n\n    Object.keys(attrsChanges).forEach((key) => {\n      const change = attrsChanges[key];\n      const newVal = change[1];\n      attributes[key] = newVal === undefined ? null : structuredClone(newVal);\n    });\n\n    data.attributes = attributes;\n  }\n\n  const changedRelationships = cache.changedRelationships(identifier);\n  if (changedRelationships.size) {\n    const relationships: Record<string, ChangedRelationshipData> = {};\n    changedRelationships.forEach((diff, key) => {\n      relationships[key] = { data: fixRelData(diff.localState) } as ChangedRelationshipData;\n    });\n\n    data.relationships = relationships;\n  }\n\n  return { data };\n}\n"],"mappings":";;;;;;;AAgBA,MAAM,gBAAgB;AACtB,MAAM,iBAAgC;CAAE,MAAM;CAAI,WAAW;AAAG;AAChE,IAAW,SAAwB;AACnC,IAAW,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCjC,SAAgB,kBAAkB,QAA6B;CAC7D,SAAS,OAAO,OAAO,CAAC,GAAG,gBAAgB,MAAM;CAEjD,IAAI,OAAO,YAAY,OAAO,YAAY;EACxC,IAAI,SAAS;EACb,IAAI,OAAO,UAAU;GACnB,MAAM,WAAW,OAAO,OAAO,OAAO,QAAQ;GAC9C,IAAI,SAAS,QACX,UAAU,gBAAe,SAAS,KAAK,GAAG,IAAI;EAElD;EACA,IAAI,OAAO,YAAY;GACrB,MAAM,aAAa,OAAO,OAAO,OAAO,UAAU;GAClD,IAAI,WAAW,QACb,UAAU,UAAU,WAAW,KAAK,GAAG;EAE3C;EACA,sBAAsB;CACxB;CAEA,oBAAU,MAAM;AAClB;;;;ACuBA,SAAgB,WACd,MACA,MACA,MAC0B;CAC1B,MAAM,aAA2C,OAAO,SAAS,WAAW;EAAE,MAAM;EAAM,IAAI;CAAe,IAAI;CACjH,MAAM,WAAY,OAAO,SAAS,WAAW,OAAO,SAAS,CAAC;CAC9D,MAAM,eAAe,oBAAoB,OAAO;CAChD,MAAM,aAAmC;EACvC;EACA,IAAI;EACJ,cAAc,UAAU,WAAW,IAAI;CACzC;CAEA,sBAAsB,YAAY,OAAO;CAEzC,MAAM,MAAM,aAAa,UAAU;CACnC,MAAM,UAAU,IAAI,QAAQ;CAC5B,QAAQ,OAAO,UAAU,mBAAmB;CAE5C,OAAO;EACL,KAAK,QAAQ,SAAS,SAClB,GAAG,IAAI,GAAG,iBAAiB,EAAE,SAAS,QAAQ,QAAQ,GAAG,QAAQ,iBAAiB,MAClF;EACJ,QAAQ;EACR;EACA;EACA,IAAI;EACJ,SAAS,CAAC,UAAU;CACtB;AACF;;;;ACvDA,SAAgB,MACd,MAEA,QAA2B,CAAC,GAC5B,UAAqC,CAAC,GACjB;CACrB,MAAM,eAAe,oBAAoB,OAAO;CAChD,MAAM,aAA8B;EAClC,YAAY,EAAE,KAAK;EACnB,IAAI;EACJ,cAAc,UAAU,IAAI;CAC9B;CAEA,sBAAsB,YAAY,OAAO;CAEzC,MAAM,MAAM,aAAa,UAAU;CACnC,MAAM,UAAU,IAAI,QAAQ;CAC5B,QAAQ,OAAO,UAAU,mBAAmB;CAC5C,MAAM,cAAc,iBAAiB,OAAO,QAAQ,iBAAiB;CAErE,OAAO;EACL,KAAK,cAAc,GAAG,IAAI,GAAG,gBAAgB;EAC7C,QAAQ;EACR;EACA;EACA,IAAI;CACN;AACF;AAwDA,SAAgB,UACd,MAEA,QAA2B,CAAC,GAC5B,UAAqC,CAAC,GACb;CACzB,MAAM,eAAe,oBAAoB,OAAO;CAChD,MAAM,aAA8B;EAClC,YAAY,EAAE,KAAK;EACnB,IAAI;EACJ,cAAc,QAAQ,gBAAgB,UAAU,IAAI;CACtD;CAEA,sBAAsB,YAAY,OAAO;CAEzC,MAAM,MAAM,aAAa,UAAU;CACnC,MAAM,UAAU,IAAI,QAAQ;CAC5B,QAAQ,OAAO,UAAU,mBAAmB;CAE5C,MAAM,YAAY,gBAAgB,KAAK;CACvC,aAAa,MAAM,aAAa,OAAO,GAAG,IAAI,GAAG,iBAAiB,WAAW,QAAQ,iBAAiB;CAEtG,OAAO;EACL;EACA,QAAQ;EACR,MAAM,KAAK,UAAU,KAAK;EAC1B;EACc;EACd,IAAI;CACN;AACF;;;;ACxKA,SAASO,WAAWC,YAA6D;CAC/E,OAAO,QAAQA,cAAcA,WAAWC,OAAO,QAAQ,UAAUD,cAAcA,WAAWE,SAAS;AACrG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA,SAAgBC,aAAaC,QAAiBC,UAAqC,CAAC,GAAyB;CAC3G,MAAML,aAAaR,oBAAoBY,MAAM;CAC7CP,eAAAC,gBAAA,CAAA,CAAAQ,UAAAC,IAAAC,KAAA,OAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,wCAAwC;CAAA,EAAA,CAAEV,UAAU;CAC3DH,eAAAC,gBAAA,CAAA,CAAAQ,UAAAC,IAAAC,KAAA,OAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,sEAAsE;CAAA,EAAA,CAAEX,WAAWC,UAAU,CAAC;CAErG,MAAMW,aAAqC;EAC7BX;EACZY,IAAI;EACJC,cAAcnB,UAAUM,WAAWE,IAAI;CACzC;CAEAP,sBAAsBgB,YAAYN,OAAO;CAEzC,MAAMS,MAAMrB,aAAakB,UAAU;CACnC,MAAMI,UAAU,IAAIC,QAAQ;CAC5BD,QAAQE,OAAO,UAAUrB,mBAAmB;CAE5C,OAAO;EACLkB;EACAI,QAAQ;EACRH;EACAH,IAAI;EACJO,MAAM,EACJf,QAAQJ,WACV;EACAoB,SAAS,CAACpB,UAAU;CACtB;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA,SAAgBqB,aAAajB,QAAiBC,UAAqC,CAAC,GAAyB;CAC3G,MAAML,aAAaR,oBAAoBY,MAAM;CAC7CP,eAAAC,gBAAA,CAAA,CAAAQ,UAAAC,IAAAC,KAAA,OAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,wCAAwC;CAAA,EAAA,CAAEV,UAAU;CAE3D,MAAMW,aAAqC;EAC7BX;EACZY,IAAI;EACJC,cAAcnB,UAAUM,WAAWE,IAAI;CACzC;CAEAP,sBAAsBgB,YAAYN,OAAO;CAEzC,MAAMS,MAAMrB,aAAakB,UAAU;CACnC,MAAMI,UAAU,IAAIC,QAAQ;CAC5BD,QAAQE,OAAO,UAAUrB,mBAAmB;CAE5C,OAAO;EACLkB;EACAI,QAAQ;EACRH;EACAH,IAAI;EACJO,MAAM,EACJf,QAAQJ,WACV;EACAoB,SAAS,CAACpB,UAAU;CACtB;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwEA,SAAgBsB,aACdlB,QACAC,UAA2D,CAAC,GACtC;CACtB,MAAML,aAAaR,oBAAoBY,MAAM;CAC7CP,eAAAC,gBAAA,CAAA,CAAAQ,UAAAC,IAAAC,KAAA,OAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,wCAAwC;CAAA,EAAA,CAAEV,UAAU;CAC3DH,eAAAC,gBAAA,CAAA,CAAAQ,UAAAC,IAAAC,KAAA,OAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,sEAAsE;CAAA,EAAA,CAAEX,WAAWC,UAAU,CAAC;CAErG,MAAMW,aAAqC;EAC7BX;EACZY,IAAI;EACJC,cAAcnB,UAAUM,WAAWE,IAAI;CACzC;CAEAP,sBAAsBgB,YAAYN,OAAO;CAEzC,MAAMS,MAAMrB,aAAakB,UAAU;CACnC,MAAMI,UAAU,IAAIC,QAAQ;CAC5BD,QAAQE,OAAO,UAAUrB,mBAAmB;CAE5C,OAAO;EACLkB;EACAI,QAAQb,QAAQkB,QAAQ,UAAU;EAClCR;EACAH,IAAI;EACJO,MAAM,EACJf,QAAQJ,WACV;EACAoB,SAAS,CAACpB,UAAU;CACtB;AACF;;;;;;;;;;;;;;;;;;;AChPA,SAAgB0B,mBACdC,OACAC,aAC6C;CAC7C,OAAO,EACLC,MAAMC,MAAMC,QAAQH,WAAW,IAC3BA,YAAYI,KAAKC,eAAeC,mBAAmBP,OAAOM,UAAU,CAAC,IACrEC,mBAAmBP,OAAOC,WAAW,EAC3C;AACF;AASA,SAASO,OAAO,EACdC,IACAC,KACAC,QACsG;CACtG,IAAIF,OAAO,MACT,OAAO;EAAEA;EAAIE;CAAK;CAEpB,OAAO;EAAEF;EAAIC;EAAKC;CAAK;AACzB;AAEA,SAASC,WACPC,KACwC;CACxC,IAAIV,MAAMC,QAAQS,GAAG,GACnB,OAAOA,IAAIR,KAAKS,QAAQN,OAAOM,GAAG,CAAC;MAC9B,IAAI,OAAOD,QAAQ,YAAYA,QAAQ,MAC5C,OAAOL,OAAOK,GAAG;CAEnB,OAAO;AACT;AAEA,SAASN,mBAAmBP,OAAcM,YAAyC;CACjF,MAAM,EAAEG,IAAIC,KAAKC,SAASL;CAG1B,MAAMS,SAASC,gBAAgBhB,MAAMiB,KAAKX,UAAU,CAAC;CACrDY,eAAAC,gBAAA,CAAA,CAAAC,UAAAC,IAAAC,KAAA,OAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,oBAAoBC,OAAOhB,EAAE,EAAC,YAAaE,KAAI,WAAYD,IAAG,0CAA2C;CAAA,EAAA,CACzGK,MAAM;CAIR,IAAIA,OAAON,OAAO,MAChB,OAAOM,OAAOL;CAGhB,IAAIK,OAAOW,eACT,KAAK,MAAMC,OAAOC,OAAOC,KAAKd,OAAOW,aAAa,GAAG;EACnD,MAAMI,eAAef,OAAOW,cAAcC;EAC1C,IAAIxB,MAAMC,QAAQ0B,aAAa5B,IAAI,GACjC4B,aAAa5B,OAAO4B,aAAa5B,KAAKG,KAAKS,QAAQN,OAAOM,GAAG,CAAC;OACzD,IAAI,OAAOgB,aAAa5B,SAAS,YAAY4B,aAAa5B,SAAS,MACxE4B,aAAa5B,OAAOM,OAAOsB,aAAa5B,IAAI;OACvC,IAAI0B,OAAOC,KAAKC,gBAAgB,CAAC,CAAC,CAAC,CAACC,WAAW,GACpD,OAAOhB,OAAOW,cAAcC;CAEhC;CAGF,OAAOZ;AACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,SAAgBiB,eACdhC,OACAM,YAOA;CACA,MAAM,EAAEG,IAAIC,KAAKC,SAASL;CAC1BY,eAAAC,gBAAA,CAAA,CAAAC,UAAAC,IAAAC,KAAA,OAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,oBAAoBC,OAAOhB,EAAE,EAAC,YAAaE,KAAI,WAAYD,IAAG,0CAA2C;CAAA,EAAA,CACzGV,MAAMiB,KAAKX,UAAU,CAAC;CAGxB,MAAMJ,OACJO,OAAO,OACH;EAAEE;EAAMD;EAAKD;CAAG,IAChB;EACEE;EACAF;CACF;CAEN,IAAIT,MAAMiC,gBAAgB3B,UAAU,GAAG;EACrC,MAAM4B,eAAelC,MAAMmC,aAAa7B,UAAU;EAClD,MAAM8B,aAA2C,CAAC;EAElDR,OAAOC,KAAKK,YAAY,CAAC,CAACG,SAASV,QAAQ;GAEzC,MAAMY,SADSL,aAAaP,IACP,CAAC;GACtBS,WAAWT,OAAOY,WAAWC,SAAY,OAAOxB,gBAAgBuB,MAAM;EACxE,CAAC;EAEDrC,KAAKkC,aAAaA;CACpB;CAEA,MAAMK,uBAAuBzC,MAAMyC,qBAAqBnC,UAAU;CAClE,IAAImC,qBAAqBC,MAAM;EAC7B,MAAMhB,gBAAyD,CAAC;EAChEe,qBAAqBJ,SAASM,MAAMhB,QAAQ;GAC1CD,cAAcC,OAAO,EAAEzB,MAAMU,WAAW+B,KAAKC,UAAU,EAAE;EAC3D,CAAC;EAED1C,KAAKwB,gBAAgBA;CACvB;CAEA,OAAO,EAAExB,KAAK;AAChB"}
+{"version":3,"file":"json-api.js","names":["buildQueryParams","buildParams","setBuildURLConfig","setConfig","JsonApiAccept","DEFAULT_CONFIG","host","namespace","CONFIG","ACCEPT_HEADER_VALUE","config","Object","assign","profiles","extensions","accept","values","length","join","isJsonApiQuery","query","include","collapseIncludePaths","basePath","paths","keys","i","push","key","value","split","forEach","field","Array","isArray","URLSearchParams","fields","page","rest","finalQuery","includePaths","sort","resourceType","toSorted","recordIdentifierFor","buildBaseURL","pluralize","copyForwardUrlOptions","ACCEPT_HEADER_VALUE","macroCondition","getGlobalConfig","isExisting","identifier","id","type","deleteRecord","record","options","WarpDrive","env","DEBUG","test","Error","urlOptions","op","resourcePath","url","headers","Headers","append","method","data","records","createRecord","updateRecord","patch","patchRecord","opts","serializeResources","cache","identifiers","data","Array","isArray","map","identifier","_serializeResource","fixRef","id","lid","type","fixRelData","rel","ref","record","structuredClone","peek","macroCondition","getGlobalConfig","WarpDrive","env","DEBUG","test","Error","String","relationships","key","Object","keys","relationship","length","serializePatch","hasChangedAttrs","attrsChanges","changedAttrs","attributes","forEach","change","newVal","undefined","changedRelationships","size","diff","localState"],"sources":["../src/-private/json-api/-utils.ts","../src/-private/json-api/find-record.ts","../src/-private/json-api/query.ts","../src/-private/json-api/save-record.ts","../src/-private/json-api/serialize.ts"],"sourcesContent":["import type { QueryParamsSource } from '@warp-drive-mirror/core/types/params';\n\nimport type { BuildURLConfig } from '../../index.ts';\nimport { buildQueryParams as buildParams, setBuildURLConfig as setConfig } from '../../index.ts';\n\n/**\n * The configuration {@link setBuildURLConfig} accepts: the {@link BuildURLConfig} fields, plus\n * the {json:api} profile and extension URIs to send in the `Accept` header.\n *\n * @summary Configuration for the JSON:API request builders: host, namespace, and the profile and extension URIs for `Accept`.\n * @public\n */\nexport interface JSONAPIConfig extends BuildURLConfig {\n  profiles?: {\n    pagination?: string;\n    [key: string]: string | undefined;\n  };\n  extensions?: {\n    atomic?: string;\n    [key: string]: string | undefined;\n  };\n}\n\nconst JsonApiAccept = 'application/vnd.api+json';\nconst DEFAULT_CONFIG: JSONAPIConfig = { host: '', namespace: '' };\nexport let CONFIG: JSONAPIConfig = DEFAULT_CONFIG;\nexport let ACCEPT_HEADER_VALUE = 'application/vnd.api+json';\n\n/**\n * Allows setting extensions and profiles to be used in the `Accept` header.\n *\n * Extensions and profiles are keyed by their namespace with the value being\n * their URI.\n *\n * The [Basic Usage](/guides/the-manual/cookbook/basic-usage#step-2-configure-some-request-defaults)\n * guide uses it to configure a host, a namespace and a pagination profile.\n *\n * Example:\n *\n * ```ts\n * setBuildURLConfig({\n *   extensions: {\n *     atomic: 'https://jsonapi.org/ext/atomic'\n *   },\n *   profiles: {\n *     pagination: 'https://jsonapi.org/profiles/ethanresnick/cursor-pagination'\n *   }\n * });\n * ```\n *\n * This also sets the global configuration for `buildBaseURL`\n * for host and namespace values for the global coniguration\n * done via `import { setBuildURLConfig } from '@warp-drive-mirror/utilities';`\n *\n * These values may still be overridden by passing\n * them to buildBaseURL directly.\n *\n * This method may be called as many times as needed\n *\n * ```ts\n * type BuildURLConfig = {\n *   host: string;\n *   namespace: string'\n * }\n * ```\n *\n * @summary Sets the JSON:API extensions and profiles sent in the `Accept` header, plus the global URL host and\n * namespace.\n * @public\n * @param {BuildURLConfig} config\n * @return {void}\n */\nexport function setBuildURLConfig(config: JSONAPIConfig): void {\n  CONFIG = Object.assign({}, DEFAULT_CONFIG, config);\n\n  if (config.profiles || config.extensions) {\n    let accept = JsonApiAccept;\n    if (config.profiles) {\n      const profiles = Object.values(config.profiles);\n      if (profiles.length) {\n        accept += ';profile=\"' + profiles.join(' ') + '\"';\n      }\n    }\n    if (config.extensions) {\n      const extensions = Object.values(config.extensions);\n      if (extensions.length) {\n        accept += ';ext=' + extensions.join(' ');\n      }\n    }\n    ACCEPT_HEADER_VALUE = accept;\n  }\n\n  setConfig(config);\n}\n\ninterface RelatedObject {\n  [key: string]: string | string[] | RelatedObject;\n}\n\nexport type JsonApiQuery = {\n  include?: string | string[] | RelatedObject;\n  fields?: Record<string, string | string[]>;\n  page?: {\n    size?: number;\n    after?: string;\n    before?: string;\n  };\n};\n\nfunction isJsonApiQuery(query: JsonApiQuery | QueryParamsSource): query is JsonApiQuery {\n  if ('include' in query && query.include && typeof query.include === 'object') {\n    return true;\n  }\n  if ('fields' in query || 'page' in query) {\n    return true;\n  }\n  return false;\n}\n\nfunction collapseIncludePaths(basePath: string, include: RelatedObject, paths: string[]) {\n  const keys = Object.keys(include);\n  for (let i = 0; i < keys.length; i++) {\n    // the key is always included too\n    paths.push(`${basePath}.${keys[i]}`);\n    const key = keys[i];\n    const value = include[key];\n\n    // include: { 'company': 'field1,field2' }\n    if (typeof value === 'string') {\n      value.split(',').forEach((field) => {\n        paths.push(`${basePath}.${key}.${field}`);\n      });\n\n      // include: { 'company': ['field1', 'field2'] }\n    } else if (Array.isArray(value)) {\n      value.forEach((field) => {\n        paths.push(`${basePath}.${key}.${field}`);\n      });\n\n      // include: { 'company': { 'nested': 'field1,field2' } }\n    } else {\n      collapseIncludePaths(`${basePath}.${key}`, value, paths);\n    }\n  }\n}\n\n/**\n * Sorts query params by both key and value, returning a query params string\n *\n * Treats `included` specially, splicing it into an array if it is a string and sorting the array.\n *   - If `included` is an object we build paths dynamically for you\n * Treats `fields` specially, building JSON:API partial fields params from an object\n * Treats `page` specially, building cursor-pagination profile page params from an object\n *\n * ```ts\n * const params = buildQueryParams({\n *  include: {\n *    company: {\n *      locations: 'address'\n *    }\n *  },\n *   fields: {\n *     company: ['name', 'ticker'],\n *     person: 'name'\n *   },\n *   page: {\n *     size: 10,\n *     after: 'abc',\n *   }\n * });\n *\n * // => 'fields[company]=name,ticker&fields[person]=name&include=company.locations,company.locations.address&page[after]=abc&page[size]=10'\n * ```\n *\n * Options:\n * - arrayFormat: 'bracket' | 'indices' | 'repeat' | 'comma'\n *\n * 'bracket': appends [] to the key for every value e.g. `ids[]=1&ids[]=2`\n * 'indices': appends [i] to the key for every value e.g. `ids[0]=1&ids[1]=2`\n * 'repeat': appends the key for every value e.g. `ids=1&ids=2`\n * 'comma' (default): appends the key once with a comma separated list of values e.g. `ids=1,2`\n *\n * @public\n * @param {URLSearchParams | Object} params\n * @param {Object} [options]\n * @return {String} A sorted query params string without the leading `?`\n */\nexport function buildQueryParams(query: JsonApiQuery | QueryParamsSource): string {\n  if (query instanceof URLSearchParams) {\n    return buildParams(query);\n  }\n\n  if (!isJsonApiQuery(query)) {\n    return buildParams(query);\n  }\n\n  const { include, fields, page, ...rest } = query;\n  const finalQuery: QueryParamsSource = {\n    ...rest,\n  };\n\n  if ('include' in query) {\n    // include: { 'company': 'field1,field2' }\n    // include: { 'company': ['field1', 'field2'] }\n    // include: { 'company': { 'nested': 'field1,field2' } }\n    // include: { 'company': { 'nested': ['field1', 'field2'] } }\n    if (include && !Array.isArray(include) && typeof include === 'object') {\n      const includePaths: string[] = [];\n      collapseIncludePaths('', include, includePaths);\n      finalQuery.include = includePaths.sort();\n\n      // include: 'field1,field2'\n      // include: ['field1', 'field2']\n    } else {\n      finalQuery.include = include;\n    }\n  }\n\n  if (fields) {\n    const keys = Object.keys(fields).sort();\n    for (let i = 0; i < keys.length; i++) {\n      const resourceType = keys[i];\n      const value = fields[resourceType];\n\n      // fields: { 'company': ['field1', 'field2'] }\n      if (Array.isArray(value)) {\n        // toSorted: `value` belongs to the caller, sorting it in place would\n        // reorder whatever else they are doing with it\n        finalQuery[`fields[${resourceType}]`] = value.toSorted().join(',');\n\n        // fields: { 'company': 'field1' }\n        // fields: { 'company': 'field1,field2' }\n      } else {\n        finalQuery[`fields[${resourceType}]`] = value.split(',').sort().join(',');\n      }\n    }\n  }\n\n  if (page) {\n    const keys = Object.keys(page).sort() as Array<'size' | 'after' | 'before'>;\n    keys.forEach((key) => {\n      const value = page[key];\n      finalQuery[`page[${key}]`] = value!;\n    });\n  }\n\n  return buildParams(finalQuery);\n}\n","import type { ReactiveDataDocument } from '@warp-drive-mirror/core/reactive';\nimport type { TypeFromInstance } from '@warp-drive-mirror/core/types/record';\nimport type {\n  FindRecordOptions,\n  FindRecordRequestOptions,\n  RemotelyAccessibleIdentifier,\n} from '@warp-drive-mirror/core/types/request';\nimport type { ApiError } from '@warp-drive-mirror/core/types/spec/error';\nimport type { Meta } from '@warp-drive-mirror/core/types/spec/json-api-raw';\n\nimport { buildBaseURL, buildQueryParams, type FindRecordUrlOptions } from '../../index.ts';\nimport { pluralize } from '../../string.ts';\nimport { copyForwardUrlOptions, extractCacheOptions } from '../builder-utils.ts';\nimport { ACCEPT_HEADER_VALUE } from './-utils.ts';\n\n/**\n * Builds request options to fetch a single resource by a known id or identifier\n * configured for the url and header expectations of most JSON:API APIs.\n *\n * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and\n * when to use one.\n *\n * :::tabs\n *\n * == Basic Usage\n *\n * ```ts\n * import { findRecord } from '@warp-drive-mirror/utilities/json-api';\n * import type { Person } from '#/data/types';\n *\n * const result = await store.request(\n *   findRecord<Person>('person', '1')\n * );\n * ```\n *\n * == With Options\n *\n * ```ts\n * import { findRecord } from '@warp-drive-mirror/utilities/json-api';\n * import type { Person } from '#/data/types';\n *\n * const data = await store.request(\n *   findRecord<Person>(\n *     'person', '1',\n *     { include: ['pets', 'friends'] }\n *   )\n * );\n * ```\n *\n * == With an Identifier\n *\n * ```ts\n * import { findRecord } from '@warp-drive-mirror/utilities/json-api';\n * import type { Person } from '#/data/types';\n *\n * const data = await store.request(\n *   findRecord<Person>(\n *     { type: 'person', id: '1' },\n *     { include: ['pets', 'friends'] }\n *   )\n * );\n * ```\n *\n * :::\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { findRecord } from '@warp-drive-mirror/utilities/json-api';\n *\n * const data = await store.request(\n *   findRecord(\n *     'person', '1',\n *     { include: ['pets', 'friends'] },\n *     { namespace: 'api/v2' }\n *   )\n * );\n * ```\n *\n * @summary Builds a JSON:API `GET` request for one resource by type and id, with optional `include`.\n * @public\n */\nexport function findRecord<T, M extends Meta | undefined = Meta | undefined, E extends object = ApiError>(\n  identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>,\n  options?: FindRecordOptions\n): FindRecordRequestOptions<ReactiveDataDocument<T, M, E>, T>;\nexport function findRecord(\n  identifier: RemotelyAccessibleIdentifier,\n  options?: FindRecordOptions\n): FindRecordRequestOptions;\nexport function findRecord<T, M extends Meta | undefined = Meta | undefined, E extends object = ApiError>(\n  type: TypeFromInstance<T>,\n  id: string,\n  options?: FindRecordOptions\n): FindRecordRequestOptions<ReactiveDataDocument<T, M, E>, T>;\nexport function findRecord(type: string, id: string, options?: FindRecordOptions): FindRecordRequestOptions;\nexport function findRecord(\n  arg1: string | RemotelyAccessibleIdentifier,\n  arg2: string | FindRecordOptions | undefined,\n  arg3?: FindRecordOptions\n): FindRecordRequestOptions {\n  const identifier: RemotelyAccessibleIdentifier = typeof arg1 === 'string' ? { type: arg1, id: arg2 as string } : arg1;\n  const options = ((typeof arg1 === 'string' ? arg3 : arg2) || {}) as FindRecordOptions;\n  const cacheOptions = extractCacheOptions(options);\n  const urlOptions: FindRecordUrlOptions = {\n    identifier,\n    op: 'findRecord',\n    resourcePath: pluralize(identifier.type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  return {\n    url: options.include?.length\n      ? `${url}?${buildQueryParams({ include: options.include }, options.urlParamsSettings)}`\n      : url,\n    method: 'GET',\n    headers,\n    cacheOptions,\n    op: 'findRecord',\n    records: [identifier],\n  };\n}\n\n/** @deprecated use {@link ReactiveDataDocument} */\nexport type FindRecordResultDocument<\n  T,\n  M extends Meta | undefined = Meta | undefined,\n  E extends object = ApiError,\n> = ReactiveDataDocument<T, M, E>;\n","import type { ReactiveDataDocument } from '@warp-drive-mirror/core/reactive';\nimport type { QueryParamsSource } from '@warp-drive-mirror/core/types/params';\nimport type { TypedRecordInstance, TypeFromInstance } from '@warp-drive-mirror/core/types/record';\nimport type {\n  CacheOptions,\n  ConstrainedRequestOptions,\n  PostQueryRequestOptions,\n  QueryRequestOptions,\n} from '@warp-drive-mirror/core/types/request';\nimport type { ApiError } from '@warp-drive-mirror/core/types/spec/error';\nimport type { Meta } from '@warp-drive-mirror/core/types/spec/json-api-raw';\n\nimport { buildBaseURL, buildQueryParams, type QueryUrlOptions } from '../../index.ts';\nimport { pluralize } from '../../string.ts';\nimport { copyForwardUrlOptions, extractCacheOptions } from '../builder-utils.ts';\nimport { ACCEPT_HEADER_VALUE } from './-utils.ts';\n/**\n * Builds request options to query for resources, usually by a primary\n * type, configured for the url and header expectations of most JSON:API APIs.\n *\n * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and\n * when to use one.\n *\n * The key difference between this and `postQuery` is that this method will send the query\n * as query params in the url of a \"GET\" request instead of as the JSON body of a \"POST\"\n * request.\n *\n * **Basic Usage**\n *\n * ```ts\n * import { query } from '@warp-drive-mirror/utilities/json-api';\n *\n * const data = await store.request(query('person'));\n * ```\n *\n * **With Query Params**\n *\n * ```ts\n * import { query } from '@warp-drive-mirror/utilities/json-api';\n *\n * const options = query('person', { include: ['pets', 'friends'] });\n * const data = await store.request(options);\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { query } from '@warp-drive-mirror/utilities/json-api';\n *\n * const options = query('person', { include: ['pets', 'friends'] }, { reload: true });\n * const data = await store.request(options);\n * ```\n *\n * @summary Builds a JSON:API `GET` request that queries a resource type, sending the query as URL query params.\n * @public\n * @badge Builder\n */\nexport function query<\n  T extends TypedRecordInstance,\n  M extends Meta | undefined = Meta | undefined,\n  E extends object = ApiError,\n>(\n  type: TypeFromInstance<T>,\n  query?: QueryParamsSource,\n  options?: ConstrainedRequestOptions\n): QueryRequestOptions<ReactiveDataDocument<T[], M, E>>;\nexport function query(\n  type: string,\n  query?: QueryParamsSource,\n  options?: ConstrainedRequestOptions\n): QueryRequestOptions;\nexport function query(\n  type: string,\n  // oxlint-disable-next-line no-shadow\n  query: QueryParamsSource = {},\n  options: ConstrainedRequestOptions = {}\n): QueryRequestOptions {\n  const cacheOptions = extractCacheOptions(options);\n  const urlOptions: QueryUrlOptions = {\n    identifier: { type },\n    op: 'query',\n    resourcePath: pluralize(type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n  const queryString = buildQueryParams(query, options.urlParamsSettings);\n\n  return {\n    url: queryString ? `${url}?${queryString}` : url,\n    method: 'GET',\n    headers,\n    cacheOptions,\n    op: 'query',\n  };\n}\n\n/**\n * Builds request options to query for resources, usually by a primary\n * type, configured for the url and header expectations of most JSON:API APIs.\n *\n * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and\n * when to use one.\n *\n * The key difference between this and `query` is that this method will send the query\n * as the JSON body of a \"POST\" request instead of as query params in the url of a \"GET\"\n * request.\n *\n * A CacheKey is generated from the url and query params, and used to cache the response\n * in the store.\n *\n * ```ts\n * import { postQuery } from '@warp-drive-mirror/utilities/json-api';\n *\n * const options = postQuery('person', { include: ['pets', 'friends'] });\n * const data = await store.request(options);\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { postQuery } from '@warp-drive-mirror/utilities/json-api';\n *\n * const options = postQuery('person', { include: ['pets', 'friends'] }, { reload: true });\n * const data = await store.request(options);\n * ```\n *\n * @summary Builds a JSON:API `POST` request that sends a query as the JSON body, cached under a key built from the\n * query params.\n * @public\n * @param type - the name of the resource type to query\n * @param query - the query params to send with the request\n * @param options - options to modify the request behavior\n */\nexport function postQuery<T, M extends Meta | undefined = Meta | undefined, E extends object = ApiError>(\n  type: TypeFromInstance<T>,\n  query?: QueryParamsSource,\n  options?: ConstrainedRequestOptions\n): PostQueryRequestOptions<ReactiveDataDocument<T[], M, E>>;\nexport function postQuery(\n  type: string,\n  query?: QueryParamsSource,\n  options?: ConstrainedRequestOptions\n): PostQueryRequestOptions;\nexport function postQuery(\n  type: string,\n  // oxlint-disable-next-line no-shadow\n  query: QueryParamsSource = {},\n  options: ConstrainedRequestOptions = {}\n): PostQueryRequestOptions {\n  const cacheOptions = extractCacheOptions(options);\n  const urlOptions: QueryUrlOptions = {\n    identifier: { type },\n    op: 'query',\n    resourcePath: options.resourcePath ?? pluralize(type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  const queryData = structuredClone(query);\n  cacheOptions.key = cacheOptions.key ?? `${url}?${buildQueryParams(queryData, options.urlParamsSettings)}`;\n\n  return {\n    url,\n    method: 'POST',\n    body: JSON.stringify(query),\n    headers,\n    cacheOptions: cacheOptions as CacheOptions & { key: string },\n    op: 'query',\n  };\n}\n","import { recordIdentifierFor } from '@warp-drive-mirror/core';\nimport { assert } from '@warp-drive-mirror/core/build-config/macros';\nimport type { ReactiveDataDocument } from '@warp-drive-mirror/core/reactive';\nimport type { PersistedResourceKey, ResourceKey } from '@warp-drive-mirror/core/types/identifier';\nimport type { TypedRecordInstance } from '@warp-drive-mirror/core/types/record';\nimport type {\n  ConstrainedRequestOptions,\n  CreateRequestOptions,\n  DeleteRequestOptions,\n  UpdateRequestOptions,\n} from '@warp-drive-mirror/core/types/request';\nimport type { ApiError } from '@warp-drive-mirror/core/types/spec/error';\nimport type { Meta } from '@warp-drive-mirror/core/types/spec/json-api-raw';\n\nimport {\n  buildBaseURL,\n  type CreateRecordUrlOptions,\n  type DeleteRecordUrlOptions,\n  type UpdateRecordUrlOptions,\n} from '../../index.ts';\nimport { pluralize } from '../../string.ts';\nimport { copyForwardUrlOptions } from '../builder-utils.ts';\nimport { ACCEPT_HEADER_VALUE } from './-utils.ts';\n\nfunction isExisting(identifier: ResourceKey): identifier is PersistedResourceKey {\n  return 'id' in identifier && identifier.id !== null && 'type' in identifier && identifier.type !== null;\n}\n\n/**\n * :::warning ⚠️ **These Mutation Builders DO NOT Set The Request Body**\n * While this may come as a surprise, the app providing the body ensures that only\n * desired and correctly formatted data is sent with the request.\n * :::\n *\n * Builds request options to delete record for resources,\n * configured for the url, method and header expectations of most JSON:API APIs.\n *\n * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and\n * when to use one.\n *\n * **Basic Usage**\n *\n * ```ts\n * import { deleteRecord } from '@warp-drive-mirror/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n *\n * // mark record as deleted\n * store.deleteRecord(person);\n *\n * // persist deletion\n * const data = await store.request(deleteRecord(person));\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { deleteRecord } from '@warp-drive-mirror/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n *\n * // mark record as deleted\n * store.deleteRecord(person);\n *\n * // persist deletion\n * const options = deleteRecord(person, { namespace: 'api/v1' });\n * const data = await store.request(options);\n * ```\n *\n * @summary Builds a JSON:API `DELETE` request that persists deletion of an existing record.\n * @public\n * @param record\n * @param options\n */\nexport function deleteRecord<T>(record: T, options?: ConstrainedRequestOptions): DeleteRequestOptions<T>;\nexport function deleteRecord(record: unknown, options?: ConstrainedRequestOptions): DeleteRequestOptions;\nexport function deleteRecord(record: unknown, options: ConstrainedRequestOptions = {}): DeleteRequestOptions {\n  const identifier = recordIdentifierFor(record);\n  assert(`Expected to be given a record instance`, identifier);\n  assert(`Cannot delete a record that does not have an associated type and id.`, isExisting(identifier));\n\n  const urlOptions: DeleteRecordUrlOptions = {\n    identifier: identifier,\n    op: 'deleteRecord',\n    resourcePath: pluralize(identifier.type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  return {\n    url,\n    method: 'DELETE',\n    headers,\n    op: 'deleteRecord',\n    data: {\n      record: identifier,\n    },\n    records: [identifier],\n  };\n}\n\n/**\n * :::warning ⚠️ **These Mutation Builders DO NOT Set The Necessary Request Body**\n * While this may come as a surprise, the app providing the body ensures that only\n * desired and correctly formatted data is sent with the request.\n * :::\n *\n * Builds request options to create new record for resources,\n * configured for the url, method and header expectations of most JSON:API APIs.\n *\n * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and\n * when to use one.\n *\n * **Basic Usage**\n *\n * ```ts\n * import { cacheKeyFor } from '@warp-drive-mirror/core';\n * import { createRecord } from '@warp-drive-mirror/utilities/json-api';\n * import type { Person } from '#/data/types';\n *\n * const person = store.createRecord<Person>('person', { name: 'Ted' });\n * const init = createRecord(person);\n * init.body = JSON.stringify(\n *  {\n *    // it's likely you will want to transform this data\n *    // somewhat\n *    data: store.cache.peek(cacheKeyFor(person))\n *  }\n * );\n * const data = await store.request(init);\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { createRecord } from '@warp-drive-mirror/utilities/json-api';\n *\n * const person = store.createRecord('person', { name: 'Ted' });\n * const options = createRecord(person, { namespace: 'api/v1' });\n * const data = await store.request(options);\n * ```\n *\n * @summary Builds a JSON:API `POST` request for saving a new record; the app must set the request body itself.\n * @public\n * @param record\n * @param options\n */\nexport function createRecord<T>(record: T, options?: ConstrainedRequestOptions): CreateRequestOptions<T>;\nexport function createRecord(record: unknown, options?: ConstrainedRequestOptions): CreateRequestOptions;\nexport function createRecord(record: unknown, options: ConstrainedRequestOptions = {}): CreateRequestOptions {\n  const identifier = recordIdentifierFor(record);\n  assert(`Expected to be given a record instance`, identifier);\n\n  const urlOptions: CreateRecordUrlOptions = {\n    identifier: identifier,\n    op: 'createRecord',\n    resourcePath: pluralize(identifier.type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  return {\n    url,\n    method: 'POST',\n    headers,\n    op: 'createRecord',\n    data: {\n      record: identifier,\n    },\n    records: [identifier],\n  };\n}\n\n/**\n * :::warning ⚠️ **These Mutation Builders DO NOT Set The Necessary Request Body**\n * While this may come as a surprise, the app providing the body ensures that only\n * desired and correctly formatted data is sent with the request.\n * :::\n *\n * Builds request options to update existing record for resources,\n * configured for the url, method and header expectations of most JSON:API APIs.\n *\n * See the [Builders](/guides/the-manual/requests/builders) guide for what request builders do and\n * when to use one.\n *\n * **Example Usage**\n *\n * ```ts\n * import { cacheKeyFor } from '@warp-drive-mirror/core';\n * import { updateRecord } from '@warp-drive-mirror/utilities/json-api';\n * import type { EditablePerson } from '#/data/types';\n *\n * const mutable = await checkout<EditablePerson>(person);\n * mutable.name = 'Chris';\n * const init = updateRecord(mutable);\n *\n * init.body = JSON.stringify(\n *  // it's likely you will want to transform this data\n *  // somewhat, or serialize only specific properties instead\n *  serializePatch(store.cache, cacheKeyFor(mutable))\n * );\n * const data = await store.request(init);\n * ```\n *\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `patch` - Allows caller to specify whether to use a PATCH request instead of a PUT request, defaults to `false`.\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { updateRecord } from '@warp-drive-mirror/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n * person.name = 'Chris';\n * const options = updateRecord(person, { patch: true });\n * const data = await store.request(options);\n * ```\n *\n * @summary Builds a JSON:API `PUT` (or `PATCH`) request for saving an existing record; the app must set the request\n * body itself.\n * @public\n * @param record\n * @param options\n */\nexport function updateRecord<\n  T extends TypedRecordInstance,\n  RT extends TypedRecordInstance = T,\n  M extends Meta | undefined = Meta | undefined,\n  E extends object = ApiError,\n>(\n  record: T,\n  options?: ConstrainedRequestOptions & { patch?: boolean }\n): UpdateRequestOptions<ReactiveDataDocument<RT, M, E>, T>;\nexport function updateRecord(\n  record: unknown,\n  options?: ConstrainedRequestOptions & { patch?: boolean }\n): UpdateRequestOptions;\nexport function updateRecord(\n  record: unknown,\n  options: ConstrainedRequestOptions & { patch?: boolean } = {}\n): UpdateRequestOptions {\n  const identifier = recordIdentifierFor(record);\n  assert(`Expected to be given a record instance`, identifier);\n  assert(`Cannot update a record that does not have an associated type and id.`, isExisting(identifier));\n\n  const urlOptions: UpdateRecordUrlOptions = {\n    identifier: identifier,\n    op: 'updateRecord',\n    resourcePath: pluralize(identifier.type),\n  };\n\n  copyForwardUrlOptions(urlOptions, options);\n\n  const url = buildBaseURL(urlOptions);\n  const headers = new Headers();\n  headers.append('Accept', ACCEPT_HEADER_VALUE);\n\n  return {\n    url,\n    method: options.patch ? 'PATCH' : 'PUT',\n    headers,\n    op: 'updateRecord',\n    data: {\n      record: identifier,\n    },\n    records: [identifier],\n  };\n}\n\n/**\n * Builds request options to update existing record for resources,\n * configured for the url and header expectations of most JSON:API APIs\n * for a PATCH request.\n *\n * Note: This is a convenience method that calls `updateRecord` with the\n * supplied request with the `patch` option set to `true`.\n *\n * **Basic Usage**\n *\n * ```ts\n * import { patchRecord } from '@warp-drive-mirror/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n * person.name = 'Chris';\n * const data = await store.request(patchRecord(person));\n * ```\n *\n * **Supplying Options to Modify the Request Behavior**\n *\n * The following options are supported:\n *\n * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.\n * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.\n * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type\n * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this\n *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.\n * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the\n *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,\n *      defaulting to `false` if none is configured.\n * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)\n *\n * ```ts\n * import { patchRecord } from '@warp-drive-mirror/utilities/json-api';\n *\n * const person = store.peekRecord('person', '1');\n * person.name = 'Chris';\n * const options = patchRecord(person);\n * const data = await store.request(options);\n * ```\n *\n * @public\n * @param record\n * @param options\n */\nexport function patchRecord<T>(record: T, options?: ConstrainedRequestOptions): UpdateRequestOptions<T>;\nexport function patchRecord(record: unknown, options?: ConstrainedRequestOptions): UpdateRequestOptions;\nexport function patchRecord(record: unknown, options: ConstrainedRequestOptions = {}): UpdateRequestOptions {\n  const opts = options as ConstrainedRequestOptions & { patch: true };\n  opts.patch = true;\n  return updateRecord(record, opts);\n}\n","import { assert } from '@warp-drive-mirror/core/build-config/macros';\nimport type { Cache } from '@warp-drive-mirror/core/types/cache';\nimport type { Relationship } from '@warp-drive-mirror/core/types/cache/relationship';\nimport type { ResourceKey } from '@warp-drive-mirror/core/types/identifier';\nimport type { Value } from '@warp-drive-mirror/core/types/json/raw';\nimport type { InnerRelationshipDocument, ResourceObject } from '@warp-drive-mirror/core/types/spec/json-api-raw';\n\ntype ChangedRelationshipData = InnerRelationshipDocument;\n\n/**\n * The resource object {@link serializePatch} produces: the resource's `type` and `id` (or `lid`\n * for a new record) with only its changed attributes and relationships.\n *\n * @summary A JSON:API resource object holding only a record's changed attributes and relationships, as produced by `serializePatch`.\n * @public\n */\nexport type JsonApiResourcePatch =\n  | {\n      type: string;\n      id: string;\n      attributes?: Record<string, Value>;\n      relationships?: Record<string, ChangedRelationshipData>;\n    }\n  | {\n      type: string;\n      id: null;\n      lid: string;\n      attributes?: Record<string, Value>;\n      relationships?: Record<string, ChangedRelationshipData>;\n    };\n\n/**\n * :::warning ⚠️ **This util often won't produce the necessary body for a {json:api} request**\n *\n * While this may come as a surprise, they are intended to serialize cache state for more\n * generalized usage. {json:api} has a large variance in acceptable shapes, and only your\n * app can ensure that the body is correctly formatted and contains all necessary data.\n * :::\n *\n * Serializes the current state of a resource or array of resources for use with POST or PUT requests.\n *\n * @summary Copies the cached state of one or more resources into a JSON:API-style `{ data }` object, a starting point\n * for request bodies.\n * @public\n * @param cache - the cache to serialize the resource(s) from\n * @param identifiers - the resource(s) to serialize\n * @return an object with a `data` property containing the serialized resource(s)\n */\nexport function serializeResources(\n  cache: Cache,\n  identifiers: ResourceKey\n): {\n  /**\n   * The serialized resource.\n   */\n  data: ResourceObject;\n};\nexport function serializeResources(\n  cache: Cache,\n  identifiers: ResourceKey[]\n): {\n  /**\n   * The serialized resources.\n   */\n  data: ResourceObject[];\n};\nexport function serializeResources(\n  cache: Cache,\n  identifiers: ResourceKey | ResourceKey[]\n): { data: ResourceObject | ResourceObject[] } {\n  return {\n    data: Array.isArray(identifiers)\n      ? identifiers.map((identifier) => _serializeResource(cache, identifier))\n      : _serializeResource(cache, identifiers),\n  };\n}\n\ntype SerializedRef =\n  | {\n      id: string;\n      type: string;\n    }\n  | { id: null; lid: string; type: string };\n\nfunction fixRef({\n  id,\n  lid,\n  type,\n}: { id: string; lid?: string; type: string } | { id: null; lid: string; type: string }): SerializedRef {\n  if (id !== null) {\n    return { id, type };\n  }\n  return { id, lid, type };\n}\n\nfunction fixRelData(\n  rel: Relationship['data'] | InnerRelationshipDocument['data']\n): SerializedRef | SerializedRef[] | null {\n  if (Array.isArray(rel)) {\n    return rel.map((ref) => fixRef(ref));\n  } else if (typeof rel === 'object' && rel !== null) {\n    return fixRef(rel);\n  }\n  return null;\n}\n\nfunction _serializeResource(cache: Cache, identifier: ResourceKey): ResourceObject {\n  const { id, lid, type } = identifier;\n  // peek gives us everything we want, but since its referentially the same data\n  // as is in the cache we clone it to avoid any accidental mutations\n  const record = structuredClone(cache.peek(identifier)) as ResourceObject;\n  assert(\n    `A record with id ${String(id)} and type ${type} for lid ${lid} was not found not in the supplied Cache.`,\n    record\n  );\n\n  // remove lid from anything that has an ID and slice any relationship arrays\n  if (record.id !== null) {\n    delete record.lid;\n  }\n\n  if (record.relationships) {\n    for (const key of Object.keys(record.relationships)) {\n      const relationship = record.relationships[key];\n      if (Array.isArray(relationship.data)) {\n        relationship.data = relationship.data.map((ref) => fixRef(ref));\n      } else if (typeof relationship.data === 'object' && relationship.data !== null) {\n        relationship.data = fixRef(relationship.data);\n      } else if (Object.keys(relationship ?? {}).length === 0) {\n        delete record.relationships[key];\n      }\n    }\n  }\n\n  return record;\n}\n\n/**\n * :::warning ⚠️ **This util often won't produce the necessary body for a {json:api} request**\n *\n * While this may come as a surprise, they are intended to serialize cache state for more\n * generalized usage. {json:api} has a large variance in acceptable shapes, and only your\n * app can ensure that the body is correctly formatted and contains all necessary data.\n * :::\n *\n * Serializes changes to a resource. Useful for use with building bodies for PATCH requests.\n *\n * Only attributes which are changed are serialized.\n * Only relationships which are changed are serialized.\n *\n * Collection relationships serialize the collection as a whole.\n *\n * If you would like to serialize updates to a collection more granularly\n * (for instance, as operations) request the diff from the store and\n * serialize as desired:\n *\n * ```ts\n * const relationshipDiffMap = cache.changedRelationships(identifier);\n * ```\n *\n * @summary Serializes only a resource's changed attributes and relationships from the cache into a JSON:API-style\n * `{ data }` patch.\n * @public\n * @param cache - the cache to serialize the resource's changes from\n * @param identifier - the resource whose changes should be serialized\n * @return an object with a `data` property containing the serialized resource patch\n */\nexport function serializePatch(\n  cache: Cache,\n  identifier: ResourceKey\n  // options: { include?: string[] } = {}\n): {\n  /**\n   * The serialized resource patch.\n   */\n  data: JsonApiResourcePatch;\n} {\n  const { id, lid, type } = identifier;\n  assert(\n    `A record with id ${String(id)} and type ${type} for lid ${lid} was not found not in the supplied Cache.`,\n    cache.peek(identifier)\n  );\n\n  const data: JsonApiResourcePatch =\n    id === null\n      ? { type, lid, id }\n      : {\n          type,\n          id,\n        };\n\n  if (cache.hasChangedAttrs(identifier)) {\n    const attrsChanges = cache.changedAttrs(identifier);\n    const attributes: ResourceObject['attributes'] = {};\n\n    Object.keys(attrsChanges).forEach((key) => {\n      const change = attrsChanges[key];\n      const newVal = change[1];\n      attributes[key] = newVal === undefined ? null : structuredClone(newVal);\n    });\n\n    data.attributes = attributes;\n  }\n\n  const changedRelationships = cache.changedRelationships(identifier);\n  if (changedRelationships.size) {\n    const relationships: Record<string, ChangedRelationshipData> = {};\n    changedRelationships.forEach((diff, key) => {\n      relationships[key] = { data: fixRelData(diff.localState) } as ChangedRelationshipData;\n    });\n\n    data.relationships = relationships;\n  }\n\n  return { data };\n}\n"],"mappings":";;;;;;;;;;;;;;AAuBA,MAAMI,gBAAgB;AACtB,MAAMC,iBAAgC;CAAEC,MAAM;CAAIC,WAAW;AAAG;AAChE,IAAWC,SAAwBH;AACnC,IAAWI,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8CjC,SAAgBP,kBAAkBQ,QAA6B;CAC7DF,SAASG,OAAOC,OAAO,CAAC,GAAGP,gBAAgBK,MAAM;CAEjD,IAAIA,OAAOG,YAAYH,OAAOI,YAAY;EACxC,IAAIC,SAASX;EACb,IAAIM,OAAOG,UAAU;GACnB,MAAMA,WAAWF,OAAOK,OAAON,OAAOG,QAAQ;GAC9C,IAAIA,SAASI,QACXF,UAAU,gBAAeF,SAASK,KAAK,GAAG,IAAI;EAElD;EACA,IAAIR,OAAOI,YAAY;GACrB,MAAMA,aAAaH,OAAOK,OAAON,OAAOI,UAAU;GAClD,IAAIA,WAAWG,QACbF,UAAU,UAAUD,WAAWI,KAAK,GAAG;EAE3C;EACAT,sBAAsBM;CACxB;CAEAZ,oBAAUO,MAAM;AAClB;;;ACeA,SAAgB,WACd,MACA,MACA,MAC0B;CAC1B,MAAM,aAA2C,OAAO,SAAS,WAAW;EAAE,MAAM;EAAM,IAAI;CAAe,IAAI;CACjH,MAAM,WAAY,OAAO,SAAS,WAAW,OAAO,SAAS,CAAC;CAC9D,MAAM,eAAe,oBAAoB,OAAO;CAChD,MAAM,aAAmC;EACvC;EACA,IAAI;EACJ,cAAc,UAAU,WAAW,IAAI;CACzC;CAEA,sBAAsB,YAAY,OAAO;CAEzC,MAAM,MAAM,aAAa,UAAU;CACnC,MAAM,UAAU,IAAI,QAAQ;CAC5B,QAAQ,OAAO,UAAU,mBAAmB;CAE5C,OAAO;EACL,KAAK,QAAQ,SAAS,SAClB,GAAG,IAAI,GAAG,iBAAiB,EAAE,SAAS,QAAQ,QAAQ,GAAG,QAAQ,iBAAiB,MAClF;EACJ,QAAQ;EACR;EACA;EACA,IAAI;EACJ,SAAS,CAAC,UAAU;CACtB;AACF;;;ACvDA,SAAgB,MACd,MAEA,QAA2B,CAAC,GAC5B,UAAqC,CAAC,GACjB;CACrB,MAAM,eAAe,oBAAoB,OAAO;CAChD,MAAM,aAA8B;EAClC,YAAY,EAAE,KAAK;EACnB,IAAI;EACJ,cAAc,UAAU,IAAI;CAC9B;CAEA,sBAAsB,YAAY,OAAO;CAEzC,MAAM,MAAM,aAAa,UAAU;CACnC,MAAM,UAAU,IAAI,QAAQ;CAC5B,QAAQ,OAAO,UAAU,mBAAmB;CAC5C,MAAM,cAAc,iBAAiB,OAAO,QAAQ,iBAAiB;CAErE,OAAO;EACL,KAAK,cAAc,GAAG,IAAI,GAAG,gBAAgB;EAC7C,QAAQ;EACR;EACA;EACA,IAAI;CACN;AACF;AA6DA,SAAgB,UACd,MAEA,QAA2B,CAAC,GAC5B,UAAqC,CAAC,GACb;CACzB,MAAM,eAAe,oBAAoB,OAAO;CAChD,MAAM,aAA8B;EAClC,YAAY,EAAE,KAAK;EACnB,IAAI;EACJ,cAAc,QAAQ,gBAAgB,UAAU,IAAI;CACtD;CAEA,sBAAsB,YAAY,OAAO;CAEzC,MAAM,MAAM,aAAa,UAAU;CACnC,MAAM,UAAU,IAAI,QAAQ;CAC5B,QAAQ,OAAO,UAAU,mBAAmB;CAE5C,MAAM,YAAY,gBAAgB,KAAK;CACvC,aAAa,MAAM,aAAa,OAAO,GAAG,IAAI,GAAG,iBAAiB,WAAW,QAAQ,iBAAiB;CAEtG,OAAO;EACL;EACA,QAAQ;EACR,MAAM,KAAK,UAAU,KAAK;EAC1B;EACc;EACd,IAAI;CACN;AACF;;;ACjLA,SAASyC,WAAWC,YAA6D;CAC/E,OAAO,QAAQA,cAAcA,WAAWC,OAAO,QAAQ,UAAUD,cAAcA,WAAWE,SAAS;AACrG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8DA,SAAgBC,aAAaC,QAAiBC,UAAqC,CAAC,GAAyB;CAC3G,MAAML,aAAaR,oBAAoBY,MAAM;CAC7CP,eAAAC,gBAAA,CAAA,CAAAQ,UAAAC,IAAAC,KAAA,OAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,wCAAwC;CAAA,EAAA,CAAEV,UAAU;CAC3DH,eAAAC,gBAAA,CAAA,CAAAQ,UAAAC,IAAAC,KAAA,OAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,sEAAsE;CAAA,EAAA,CAAEX,WAAWC,UAAU,CAAC;CAErG,MAAMW,aAAqC;EAC7BX;EACZY,IAAI;EACJC,cAAcnB,UAAUM,WAAWE,IAAI;CACzC;CAEAP,sBAAsBgB,YAAYN,OAAO;CAEzC,MAAMS,MAAMrB,aAAakB,UAAU;CACnC,MAAMI,UAAU,IAAIC,QAAQ;CAC5BD,QAAQE,OAAO,UAAUrB,mBAAmB;CAE5C,OAAO;EACLkB;EACAI,QAAQ;EACRH;EACAH,IAAI;EACJO,MAAM,EACJf,QAAQJ,WACV;EACAoB,SAAS,CAACpB,UAAU;CACtB;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8DA,SAAgBqB,aAAajB,QAAiBC,UAAqC,CAAC,GAAyB;CAC3G,MAAML,aAAaR,oBAAoBY,MAAM;CAC7CP,eAAAC,gBAAA,CAAA,CAAAQ,UAAAC,IAAAC,KAAA,OAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,wCAAwC;CAAA,EAAA,CAAEV,UAAU;CAE3D,MAAMW,aAAqC;EAC7BX;EACZY,IAAI;EACJC,cAAcnB,UAAUM,WAAWE,IAAI;CACzC;CAEAP,sBAAsBgB,YAAYN,OAAO;CAEzC,MAAMS,MAAMrB,aAAakB,UAAU;CACnC,MAAMI,UAAU,IAAIC,QAAQ;CAC5BD,QAAQE,OAAO,UAAUrB,mBAAmB;CAE5C,OAAO;EACLkB;EACAI,QAAQ;EACRH;EACAH,IAAI;EACJO,MAAM,EACJf,QAAQJ,WACV;EACAoB,SAAS,CAACpB,UAAU;CACtB;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6EA,SAAgBsB,aACdlB,QACAC,UAA2D,CAAC,GACtC;CACtB,MAAML,aAAaR,oBAAoBY,MAAM;CAC7CP,eAAAC,gBAAA,CAAA,CAAAQ,UAAAC,IAAAC,KAAA,OAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,wCAAwC;CAAA,EAAA,CAAEV,UAAU;CAC3DH,eAAAC,gBAAA,CAAA,CAAAQ,UAAAC,IAAAC,KAAA,OAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,sEAAsE;CAAA,EAAA,CAAEX,WAAWC,UAAU,CAAC;CAErG,MAAMW,aAAqC;EAC7BX;EACZY,IAAI;EACJC,cAAcnB,UAAUM,WAAWE,IAAI;CACzC;CAEAP,sBAAsBgB,YAAYN,OAAO;CAEzC,MAAMS,MAAMrB,aAAakB,UAAU;CACnC,MAAMI,UAAU,IAAIC,QAAQ;CAC5BD,QAAQE,OAAO,UAAUrB,mBAAmB;CAE5C,OAAO;EACLkB;EACAI,QAAQb,QAAQkB,QAAQ,UAAU;EAClCR;EACAH,IAAI;EACJO,MAAM,EACJf,QAAQJ,WACV;EACAoB,SAAS,CAACpB,UAAU;CACtB;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;ACpPA,SAAgB0B,mBACdC,OACAC,aAC6C;CAC7C,OAAO,EACLC,MAAMC,MAAMC,QAAQH,WAAW,IAC3BA,YAAYI,KAAKC,eAAeC,mBAAmBP,OAAOM,UAAU,CAAC,IACrEC,mBAAmBP,OAAOC,WAAW,EAC3C;AACF;AASA,SAASO,OAAO,EACdC,IACAC,KACAC,QACsG;CACtG,IAAIF,OAAO,MACT,OAAO;EAAEA;EAAIE;CAAK;CAEpB,OAAO;EAAEF;EAAIC;EAAKC;CAAK;AACzB;AAEA,SAASC,WACPC,KACwC;CACxC,IAAIV,MAAMC,QAAQS,GAAG,GACnB,OAAOA,IAAIR,KAAKS,QAAQN,OAAOM,GAAG,CAAC;MAC9B,IAAI,OAAOD,QAAQ,YAAYA,QAAQ,MAC5C,OAAOL,OAAOK,GAAG;CAEnB,OAAO;AACT;AAEA,SAASN,mBAAmBP,OAAcM,YAAyC;CACjF,MAAM,EAAEG,IAAIC,KAAKC,SAASL;CAG1B,MAAMS,SAASC,gBAAgBhB,MAAMiB,KAAKX,UAAU,CAAC;CACrDY,eAAAC,gBAAA,CAAA,CAAAC,UAAAC,IAAAC,KAAA,OAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,oBAAoBC,OAAOhB,EAAE,EAAC,YAAaE,KAAI,WAAYD,IAAG,0CAA2C;CAAA,EAAA,CACzGK,MAAM;CAIR,IAAIA,OAAON,OAAO,MAChB,OAAOM,OAAOL;CAGhB,IAAIK,OAAOW,eACT,KAAK,MAAMC,OAAOC,OAAOC,KAAKd,OAAOW,aAAa,GAAG;EACnD,MAAMI,eAAef,OAAOW,cAAcC;EAC1C,IAAIxB,MAAMC,QAAQ0B,aAAa5B,IAAI,GACjC4B,aAAa5B,OAAO4B,aAAa5B,KAAKG,KAAKS,QAAQN,OAAOM,GAAG,CAAC;OACzD,IAAI,OAAOgB,aAAa5B,SAAS,YAAY4B,aAAa5B,SAAS,MACxE4B,aAAa5B,OAAOM,OAAOsB,aAAa5B,IAAI;OACvC,IAAI0B,OAAOC,KAAKC,gBAAgB,CAAC,CAAC,CAAC,CAACC,WAAW,GACpD,OAAOhB,OAAOW,cAAcC;CAEhC;CAGF,OAAOZ;AACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCA,SAAgBiB,eACdhC,OACAM,YAOA;CACA,MAAM,EAAEG,IAAIC,KAAKC,SAASL;CAC1BY,eAAAC,gBAAA,CAAA,CAAAC,UAAAC,IAAAC,KAAA,OAAAC,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,oBAAoBC,OAAOhB,EAAE,EAAC,YAAaE,KAAI,WAAYD,IAAG,0CAA2C;CAAA,EAAA,CACzGV,MAAMiB,KAAKX,UAAU,CAAC;CAGxB,MAAMJ,OACJO,OAAO,OACH;EAAEE;EAAMD;EAAKD;CAAG,IAChB;EACEE;EACAF;CACF;CAEN,IAAIT,MAAMiC,gBAAgB3B,UAAU,GAAG;EACrC,MAAM4B,eAAelC,MAAMmC,aAAa7B,UAAU;EAClD,MAAM8B,aAA2C,CAAC;EAElDR,OAAOC,KAAKK,YAAY,CAAC,CAACG,SAASV,QAAQ;GAEzC,MAAMY,SADSL,aAAaP,IACP,CAAC;GACtBS,WAAWT,OAAOY,WAAWC,SAAY,OAAOxB,gBAAgBuB,MAAM;EACxE,CAAC;EAEDrC,KAAKkC,aAAaA;CACpB;CAEA,MAAMK,uBAAuBzC,MAAMyC,qBAAqBnC,UAAU;CAClE,IAAImC,qBAAqBC,MAAM;EAC7B,MAAMhB,gBAAyD,CAAC;EAChEe,qBAAqBJ,SAASM,MAAMhB,QAAQ;GAC1CD,cAAcC,OAAO,EAAEzB,MAAMU,WAAW+B,KAAKC,UAAU,EAAE;EAC3D,CAAC;EAED1C,KAAKwB,gBAAgBA;CACvB;CAEA,OAAO,EAAExB,KAAK;AAChB"}