@warp-drive/utilities 5.6.0-alpha.15 → 5.6.0-alpha.18

package/declarations/-private/json-api/save-record.d.ts

@@ -1,191 +1,193 @@
-import type { TypedRecordInstance } from '@warp-drive/core/types/record';
-import type { ConstrainedRequestOptions, CreateRequestOptions, DeleteRequestOptions, UpdateRequestOptions } from '@warp-drive/core/types/request';
-import type { SingleResourceDataDocument } from '@warp-drive/core/types/spec/document';
+import type { TypedRecordInstance } from "@warp-drive/core/types/record";
+import type { ConstrainedRequestOptions, CreateRequestOptions, DeleteRequestOptions, UpdateRequestOptions } from "@warp-drive/core/types/request";
+import type { SingleResourceDataDocument } from "@warp-drive/core/types/spec/document";
 /**
- * Builds request options to delete record for resources,
- * configured for the url, method and header expectations of most JSON:API APIs.
- *
- * **Basic Usage**
- *
- * ```ts
- * import { deleteRecord } from '@warp-drive/utilities/json-api';
- *
- * const person = store.peekRecord('person', '1');
- *
- * // mark record as deleted
- * store.deleteRecord(person);
- *
- * // persist deletion
- * const data = await store.request(deleteRecord(person));
- * ```
- *
- * **Supplying Options to Modify the Request Behavior**
- *
- * The following options are supported:
- *
- * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.
- * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.
- * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type
- * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this
- *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.
- * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the
- *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,
- *      defaulting to `false` if none is configured.
- * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)
- *
- * ```ts
- * import { deleteRecord } from '@warp-drive/utilities/json-api';
- *
- * const person = store.peekRecord('person', '1');
- *
- * // mark record as deleted
- * store.deleteRecord(person);
- *
- * // persist deletion
- * const options = deleteRecord(person, { namespace: 'api/v1' });
- * const data = await store.request(options);
- * ```
- *
- * @public
- * @param record
- * @param options
- */
+* Builds request options to delete record for resources,
+* configured for the url, method and header expectations of most JSON:API APIs.
+*
+* **Basic Usage**
+*
+* ```ts
+* import { deleteRecord } from '@warp-drive/utilities/json-api';
+*
+* const person = store.peekRecord('person', '1');
+*
+* // mark record as deleted
+* store.deleteRecord(person);
+*
+* // persist deletion
+* const data = await store.request(deleteRecord(person));
+* ```
+*
+* **Supplying Options to Modify the Request Behavior**
+*
+* The following options are supported:
+*
+* - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.
+* - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.
+* - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type
+* - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this
+*      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.
+* - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the
+*      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,
+*      defaulting to `false` if none is configured.
+* - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)
+*
+* ```ts
+* import { deleteRecord } from '@warp-drive/utilities/json-api';
+*
+* const person = store.peekRecord('person', '1');
+*
+* // mark record as deleted
+* store.deleteRecord(person);
+*
+* // persist deletion
+* const options = deleteRecord(person, { namespace: 'api/v1' });
+* const data = await store.request(options);
+* ```
+*
+* @public
+* @param record
+* @param options
+*/
 export declare function deleteRecord<T>(record: T, options?: ConstrainedRequestOptions): DeleteRequestOptions<T>;
 export declare function deleteRecord(record: unknown, options?: ConstrainedRequestOptions): DeleteRequestOptions;
 /**
- * Builds request options to create new record for resources,
- * configured for the url, method and header expectations of most JSON:API APIs.
- *
- * **Basic Usage**
- *
- * ```ts
- * import { createRecord } from '@warp-drive/utilities/json-api';
- *
- * const person = store.createRecord('person', { name: 'Ted' });
- * const data = await store.request(createRecord(person));
- * ```
- *
- * **Supplying Options to Modify the Request Behavior**
- *
- * The following options are supported:
- *
- * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.
- * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.
- * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type
- * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this
- *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.
- * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the
- *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,
- *      defaulting to `false` if none is configured.
- * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)
- *
- * ```ts
- * import { createRecord } from '@warp-drive/utilities/json-api';
- *
- * const person = store.createRecord('person', { name: 'Ted' });
- * const options = createRecord(person, { namespace: 'api/v1' });
- * const data = await store.request(options);
- * ```
- *
- * @public
- * @param record
- * @param options
- */
+* Builds request options to create new record for resources,
+* configured for the url, method and header expectations of most JSON:API APIs.
+*
+* **Basic Usage**
+*
+* ```ts
+* import { createRecord } from '@warp-drive/utilities/json-api';
+*
+* const person = store.createRecord('person', { name: 'Ted' });
+* const data = await store.request(createRecord(person));
+* ```
+*
+* **Supplying Options to Modify the Request Behavior**
+*
+* The following options are supported:
+*
+* - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.
+* - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.
+* - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type
+* - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this
+*      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.
+* - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the
+*      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,
+*      defaulting to `false` if none is configured.
+* - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)
+*
+* ```ts
+* import { createRecord } from '@warp-drive/utilities/json-api';
+*
+* const person = store.createRecord('person', { name: 'Ted' });
+* const options = createRecord(person, { namespace: 'api/v1' });
+* const data = await store.request(options);
+* ```
+*
+* @public
+* @param record
+* @param options
+*/
 export declare function createRecord<T>(record: T, options?: ConstrainedRequestOptions): CreateRequestOptions<T>;
 export declare function createRecord(record: unknown, options?: ConstrainedRequestOptions): CreateRequestOptions;
 /**
- * Builds request options to update existing record for resources,
- * configured for the url, method and header expectations of most JSON:API APIs.
- *
- * **Basic Usage**
- *
- * ```ts
- * import { updateRecord } from '@warp-drive/utilities/json-api';
- *
- * const person = store.peekRecord('person', '1');
- * person.name = 'Chris';
- * const data = await store.request(updateRecord(person));
- * ```
- *
- * **Supplying Options to Modify the Request Behavior**
- *
- * The following options are supported:
- *
- * - `patch` - Allows caller to specify whether to use a PATCH request instead of a PUT request, defaults to `false`.
- * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.
- * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.
- * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type
- * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this
- *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.
- * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the
- *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,
- *      defaulting to `false` if none is configured.
- * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)
- *
- * ```ts
- * import { updateRecord } from '@warp-drive/utilities/json-api';
- *
- * const person = store.peekRecord('person', '1');
- * person.name = 'Chris';
- * const options = updateRecord(person, { patch: true });
- * const data = await store.request(options);
- * ```
- *
- * @public
- * @param record
- * @param options
- */
-export declare function updateRecord<T extends TypedRecordInstance, RT extends TypedRecordInstance = T>(record: T, options?: ConstrainedRequestOptions & {
-    patch?: boolean;
+* Builds request options to update existing record for resources,
+* configured for the url, method and header expectations of most JSON:API APIs.
+*
+* **Basic Usage**
+*
+* ```ts
+* import { updateRecord } from '@warp-drive/utilities/json-api';
+*
+* const person = store.peekRecord('person', '1');
+* person.name = 'Chris';
+* const data = await store.request(updateRecord(person));
+* ```
+*
+* **Supplying Options to Modify the Request Behavior**
+*
+* The following options are supported:
+*
+* - `patch` - Allows caller to specify whether to use a PATCH request instead of a PUT request, defaults to `false`.
+* - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.
+* - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.
+* - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type
+* - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this
+*      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.
+* - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the
+*      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,
+*      defaulting to `false` if none is configured.
+* - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)
+*
+* ```ts
+* import { updateRecord } from '@warp-drive/utilities/json-api';
+*
+* const person = store.peekRecord('person', '1');
+* person.name = 'Chris';
+* const options = updateRecord(person, { patch: true });
+* const data = await store.request(options);
+* ```
+*
+* @public
+* @param record
+* @param options
+*/
+export declare function updateRecord<
+	T extends TypedRecordInstance,
+	RT extends TypedRecordInstance = T
+>(record: T, options?: ConstrainedRequestOptions & {
+	patch?: boolean;
 }): UpdateRequestOptions<SingleResourceDataDocument<RT>, T>;
 export declare function updateRecord(record: unknown, options?: ConstrainedRequestOptions & {
-    patch?: boolean;
+	patch?: boolean;
 }): UpdateRequestOptions;
 /**
- * Builds request options to update existing record for resources,
- * configured for the url and header expectations of most JSON:API APIs
- * for a PATCH request.
- *
- * Note: This is a convenience method that calls `updateRecord` with the
- * supplied request with the `patch` option set to `true`.
- *
- * **Basic Usage**
- *
- * ```ts
- * import { patchRecord } from '@warp-drive/utilities/json-api';
- *
- * const person = store.peekRecord('person', '1');
- * person.name = 'Chris';
- * const data = await store.request(patchRecord(person));
- * ```
- *
- * **Supplying Options to Modify the Request Behavior**
- *
- * The following options are supported:
- *
- * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.
- * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.
- * - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type
- * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this
- *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.
- * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the
- *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,
- *      defaulting to `false` if none is configured.
- * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)
- *
- * ```ts
- * import { patchRecord } from '@warp-drive/utilities/json-api';
- *
- * const person = store.peekRecord('person', '1');
- * person.name = 'Chris';
- * const options = patchRecord(person);
- * const data = await store.request(options);
- * ```
- *
- * @public
- * @param record
- * @param options
- */
+* Builds request options to update existing record for resources,
+* configured for the url and header expectations of most JSON:API APIs
+* for a PATCH request.
+*
+* Note: This is a convenience method that calls `updateRecord` with the
+* supplied request with the `patch` option set to `true`.
+*
+* **Basic Usage**
+*
+* ```ts
+* import { patchRecord } from '@warp-drive/utilities/json-api';
+*
+* const person = store.peekRecord('person', '1');
+* person.name = 'Chris';
+* const data = await store.request(patchRecord(person));
+* ```
+*
+* **Supplying Options to Modify the Request Behavior**
+*
+* The following options are supported:
+*
+* - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.
+* - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.
+* - `resourcePath` - The resource path to use for the request, defaults to pluralizing the supplied type
+* - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this
+*      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.
+* - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the
+*      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,
+*      defaulting to `false` if none is configured.
+* - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)
+*
+* ```ts
+* import { patchRecord } from '@warp-drive/utilities/json-api';
+*
+* const person = store.peekRecord('person', '1');
+* person.name = 'Chris';
+* const options = patchRecord(person);
+* const data = await store.request(options);
+* ```
+*
+* @public
+* @param record
+* @param options
+*/
 export declare function patchRecord<T>(record: T, options?: ConstrainedRequestOptions): UpdateRequestOptions<T>;
 export declare function patchRecord(record: unknown, options?: ConstrainedRequestOptions): UpdateRequestOptions;
-//# sourceMappingURL=save-record.d.ts.map

package/declarations/-private/json-api/serialize.d.ts

@@ -1,57 +1,56 @@
-import type { Cache } from '@warp-drive/core/types/cache';
-import type { StableRecordIdentifier } from '@warp-drive/core/types/identifier';
-import type { Value } from '@warp-drive/core/types/json/raw';
-import type { InnerRelationshipDocument, ResourceObject } from '@warp-drive/core/types/spec/json-api-raw';
+import type { Cache } from "@warp-drive/core/types/cache";
+import type { StableRecordIdentifier } from "@warp-drive/core/types/identifier";
+import type { Value } from "@warp-drive/core/types/json/raw";
+import type { InnerRelationshipDocument, ResourceObject } from "@warp-drive/core/types/spec/json-api-raw";
 type ChangedRelationshipData = InnerRelationshipDocument;
 export type JsonApiResourcePatch = {
-    type: string;
-    id: string;
-    attributes?: Record<string, Value>;
-    relationships?: Record<string, ChangedRelationshipData>;
+	type: string;
+	id: string;
+	attributes?: Record<string, Value>;
+	relationships?: Record<string, ChangedRelationshipData>;
 } | {
-    type: string;
-    id: null;
-    lid: string;
-    attributes?: Record<string, Value>;
-    relationships?: Record<string, ChangedRelationshipData>;
+	type: string;
+	id: null;
+	lid: string;
+	attributes?: Record<string, Value>;
+	relationships?: Record<string, ChangedRelationshipData>;
 };
 /**
- * Serializes the current state of a resource or array of resources for use with POST or PUT requests.
- *
- * @public
- * @param {Cache} cache}
- * @param {StableRecordIdentifier} identifier
- * @return {Object} An object with a `data` property containing the serialized resource patch
- */
+* Serializes the current state of a resource or array of resources for use with POST or PUT requests.
+*
+* @public
+* @param {Cache} cache}
+* @param {StableRecordIdentifier} identifier
+* @return {Object} An object with a `data` property containing the serialized resource patch
+*/
 export declare function serializeResources(cache: Cache, identifiers: StableRecordIdentifier): {
-    data: ResourceObject;
+	data: ResourceObject;
 };
 export declare function serializeResources(cache: Cache, identifiers: StableRecordIdentifier[]): {
-    data: ResourceObject[];
+	data: ResourceObject[];
 };
 /**
- * Serializes changes to a resource for use with PATCH requests.
- *
- * Only attributes which are changed are serialized.
- * Only relationships which are changed are serialized.
- *
- * Collection relationships serialize the collection as a whole.
- *
- * If you would like to serialize updates to a collection more granularly
- * (for instance, as operations) request the diff from the store and
- * serialize as desired:
- *
- * ```ts
- * const relationshipDiffMap = cache.changedRelationships(identifier);
- * ```
- *
- * @public
- * @param {Cache} cache}
- * @param {StableRecordIdentifier} identifier
- * @return {Object} An object with a `data` property containing the serialized resource patch
- */
+* Serializes changes to a resource for use with PATCH requests.
+*
+* Only attributes which are changed are serialized.
+* Only relationships which are changed are serialized.
+*
+* Collection relationships serialize the collection as a whole.
+*
+* If you would like to serialize updates to a collection more granularly
+* (for instance, as operations) request the diff from the store and
+* serialize as desired:
+*
+* ```ts
+* const relationshipDiffMap = cache.changedRelationships(identifier);
+* ```
+*
+* @public
+* @param {Cache} cache}
+* @param {StableRecordIdentifier} identifier
+* @return {Object} An object with a `data` property containing the serialized resource patch
+*/
 export declare function serializePatch(cache: Cache, identifier: StableRecordIdentifier): {
-    data: JsonApiResourcePatch;
+	data: JsonApiResourcePatch;
 };
 export {};
-//# sourceMappingURL=serialize.d.ts.map

package/declarations/-private/rest/find-record.d.ts

@@ -1,66 +1,65 @@
-import type { TypeFromInstance } from '@warp-drive/core/types/record';
-import type { FindRecordOptions, FindRecordRequestOptions, RemotelyAccessibleIdentifier } from '@warp-drive/core/types/request';
-import type { SingleResourceDataDocument } from '@warp-drive/core/types/spec/document';
+import type { TypeFromInstance } from "@warp-drive/core/types/record";
+import type { FindRecordOptions, FindRecordRequestOptions, RemotelyAccessibleIdentifier } from "@warp-drive/core/types/request";
+import type { SingleResourceDataDocument } from "@warp-drive/core/types/spec/document";
 /**
- * Builds request options to fetch a single resource by a known id or identifier
- * configured for the url and header expectations of most REST APIs.
- *
- * **Basic Usage**
- *
- * ```ts
- * import { findRecord } from '@warp-drive/utilities/rest';
- *
- * const data = await store.request(findRecord('person', '1'));
- * ```
- *
- * **With Options**
- *
- * ```ts
- * import { findRecord } from '@warp-drive/utilities/rest';
- *
- * const options = findRecord('person', '1', { include: ['pets', 'friends'] });
- * const data = await store.request(options);
- * ```
- *
- * **With an Identifier**
- *
- * ```ts
- * import { findRecord } from '@warp-drive/utilities/rest';
- *
- * const options = findRecord({ type: 'person', id: '1' }, { include: ['pets', 'friends'] });
- * const data = await store.request(options);
- * ```
- *
- * **Supplying Options to Modify the Request Behavior**
- *
- * The following options are supported:
- *
- * - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.
- * - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.
- * - `resourcePath` - The resource path to use for the request, defaults to pluralizing and camelCasing the supplied type
- * - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this
- *      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.
- * - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the
- *      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,
- *      defaulting to `false` if none is configured.
- * - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)
- *
- * ```ts
- * import { findRecord } from '@warp-drive/utilities/rest';
- *
- * const options = findRecord('person', '1', { include: ['pets', 'friends'] }, { namespace: 'api/v2' });
- * const data = await store.request(options);
- * ```
- *
- * @public
- * @param identifier
- * @param options
- */
-export type FindRecordResultDocument<T> = Omit<SingleResourceDataDocument<T>, 'data'> & {
-    data: T;
+* Builds request options to fetch a single resource by a known id or identifier
+* configured for the url and header expectations of most REST APIs.
+*
+* **Basic Usage**
+*
+* ```ts
+* import { findRecord } from '@warp-drive/utilities/rest';
+*
+* const data = await store.request(findRecord('person', '1'));
+* ```
+*
+* **With Options**
+*
+* ```ts
+* import { findRecord } from '@warp-drive/utilities/rest';
+*
+* const options = findRecord('person', '1', { include: ['pets', 'friends'] });
+* const data = await store.request(options);
+* ```
+*
+* **With an Identifier**
+*
+* ```ts
+* import { findRecord } from '@warp-drive/utilities/rest';
+*
+* const options = findRecord({ type: 'person', id: '1' }, { include: ['pets', 'friends'] });
+* const data = await store.request(options);
+* ```
+*
+* **Supplying Options to Modify the Request Behavior**
+*
+* The following options are supported:
+*
+* - `host` - The host to use for the request, defaults to the `host` configured with `setBuildURLConfig`.
+* - `namespace` - The namespace to use for the request, defaults to the `namespace` configured with `setBuildURLConfig`.
+* - `resourcePath` - The resource path to use for the request, defaults to pluralizing and camelCasing the supplied type
+* - `reload` - Whether to forcibly reload the request if it is already in the store, not supplying this
+*      option will delegate to the store's CachePolicy, defaulting to `false` if none is configured.
+* - `backgroundReload` - Whether to reload the request if it is already in the store, but to also resolve the
+*      promise with the cached value, not supplying this option will delegate to the store's CachePolicy,
+*      defaulting to `false` if none is configured.
+* - `urlParamsSetting` - an object containing options for how to serialize the query params (see `buildQueryParams`)
+*
+* ```ts
+* import { findRecord } from '@warp-drive/utilities/rest';
+*
+* const options = findRecord('person', '1', { include: ['pets', 'friends'] }, { namespace: 'api/v2' });
+* const data = await store.request(options);
+* ```
+*
+* @public
+* @param identifier
+* @param options
+*/
+export type FindRecordResultDocument<T> = Omit<SingleResourceDataDocument<T>, "data"> & {
+	data: T;
 };
 export declare function findRecord<T>(identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>, options?: FindRecordOptions<T>): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
 export declare function findRecord(identifier: RemotelyAccessibleIdentifier, options?: FindRecordOptions): FindRecordRequestOptions;
 export declare function findRecord<T>(type: TypeFromInstance<T>, id: string, options?: FindRecordOptions<T>): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
 export declare function findRecord(type: string, id: string, options?: FindRecordOptions): FindRecordRequestOptions;
-//# sourceMappingURL=find-record.d.ts.map