@warp-drive/utilities 5.9.0-alpha.2 → 5.9.0-alpha.21

package/dist/unpkg/dev/active-record.js

@@ -1,394 +1,269 @@
-import { buildBaseURL, buildQueryParams } from './index.js';
-import { p as pluralize, j as underscore } from "./inflect-BEv8WqY1.js";
-import { e as extractCacheOptions, c as copyForwardUrlOptions } from "./builder-utils-Donkk-BZ.js";
-import { recordIdentifierFor } from '@warp-drive/core';
-
-/**
- * Builds request options to fetch a single resource by a known id or identifier
- * configured for the url and header expectations of most ActiveRecord APIs.
- *
- * **Basic Usage**
- *
- * ```ts
- * import { findRecord } from '@warp-drive/utilities/active-record';
- *
- * const data = await store.request(findRecord('person', '1'));
- * ```
- *
- * **With Options**
- *
- * ```ts
- * import { findRecord } from '@warp-drive/utilities/active-record';
- *
- * const options = findRecord('person', '1', { include: ['pets', 'friends'] });
- * const data = await store.request(options);
- * ```
- *
- * **With an Identifier**
- *
- * ```ts
- * import { findRecord } from '@warp-drive/utilities/active-record';
- *
- * 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 underscoring 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/active-record';
- *
- * const options = findRecord('person', '1', { include: ['pets', 'friends'] }, { namespace: 'api/v2' });
- * const data = await store.request(options);
- * ```
- *
- * @public
- * @param identifier
- * @param options
- */
+import { buildBaseURL, buildQueryParams } from "./index.js";
+import { g as underscore, s as pluralize } from "./string-j4ur-TDs.js";
+import { n as extractCacheOptions, t as copyForwardUrlOptions } from "./builder-utils-BkXwUT0x.js";
+import { recordIdentifierFor } from "@warp-drive/core";
 
+//#region src/-private/active-record/find-record.ts
 function findRecord(arg1, arg2, arg3) {
-  const identifier = typeof arg1 === 'string' ? {
-    type: arg1,
-    id: arg2
-  } : arg1;
-  const options = (typeof arg1 === 'string' ? arg3 : arg2) || {};
-  const cacheOptions = extractCacheOptions(options);
-  const urlOptions = {
-    identifier,
-    op: 'findRecord',
-    resourcePath: pluralize(underscore(identifier.type))
-  };
-  copyForwardUrlOptions(urlOptions, options);
-  const url = buildBaseURL(urlOptions);
-  const headers = new Headers();
-  headers.append('Accept', 'application/json;charset=utf-8');
-  return {
-    url: options.include?.length ? `${url}?${buildQueryParams({
-      include: options.include
-    }, options.urlParamsSettings)}` : url,
-    method: 'GET',
-    headers,
-    cacheOptions,
-    op: 'findRecord',
-    records: [identifier]
-  };
+	const identifier = typeof arg1 === "string" ? {
+		type: arg1,
+		id: arg2
+	} : arg1;
+	const options = (typeof arg1 === "string" ? arg3 : arg2) || {};
+	const cacheOptions = extractCacheOptions(options);
+	const urlOptions = {
+		identifier,
+		op: "findRecord",
+		resourcePath: pluralize(underscore(identifier.type))
+	};
+	copyForwardUrlOptions(urlOptions, options);
+	const url = buildBaseURL(urlOptions);
+	const headers = new Headers();
+	headers.append("Accept", "application/json;charset=utf-8");
+	return {
+		url: options.include?.length ? `${url}?${buildQueryParams({ include: options.include }, options.urlParamsSettings)}` : url,
+		method: "GET",
+		headers,
+		cacheOptions,
+		op: "findRecord",
+		records: [identifier]
+	};
 }
 
-/** @deprecated use {@link ReactiveDataDocument} instead */
-
-/**
- * Builds request options to query for resources, usually by a primary
- * type, configured for the url and header expectations of most ActiveRecord APIs.
- *
- * **Basic Usage**
- *
- * ```ts
- * import { query } from '@warp-drive/utilities/active-record';
- *
- * const data = await store.request(query('person'));
- * ```
- *
- * **With Query Params**
- *
- * ```ts
- * import { query } from '@warp-drive/utilities/active-record';
- *
- * const options = query('person', { 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 underscoring 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 { query } from '@warp-drive/utilities/active-record';
- *
- * const options = query('person', { include: ['pets', 'friends'] }, { reload: true });
- * const data = await store.request(options);
- * ```
- *
- * @public
- * @param identifier
- * @param query
- * @param options
- */
-
-function query(type,
-// eslint-disable-next-line @typescript-eslint/no-shadow
-query = {}, options = {}) {
-  const cacheOptions = extractCacheOptions(options);
-  const urlOptions = {
-    identifier: {
-      type
-    },
-    op: 'query',
-    resourcePath: pluralize(underscore(type))
-  };
-  copyForwardUrlOptions(urlOptions, options);
-  const url = buildBaseURL(urlOptions);
-  const headers = new Headers();
-  headers.append('Accept', 'application/json;charset=utf-8');
-  const queryString = buildQueryParams(query, options.urlParamsSettings);
-  return {
-    url: queryString ? `${url}?${queryString}` : url,
-    method: 'GET',
-    headers,
-    cacheOptions,
-    op: 'query'
-  };
+//#endregion
+//#region src/-private/active-record/query.ts
+function query(type, query = {}, options = {}) {
+	const cacheOptions = extractCacheOptions(options);
+	const urlOptions = {
+		identifier: { type },
+		op: "query",
+		resourcePath: pluralize(underscore(type))
+	};
+	copyForwardUrlOptions(urlOptions, options);
+	const url = buildBaseURL(urlOptions);
+	const headers = new Headers();
+	headers.append("Accept", "application/json;charset=utf-8");
+	const queryString = buildQueryParams(query, options.urlParamsSettings);
+	return {
+		url: queryString ? `${url}?${queryString}` : url,
+		method: "GET",
+		headers,
+		cacheOptions,
+		op: "query"
+	};
 }
+
+//#endregion
+//#region src/-private/active-record/save-record.ts
 function isExisting(identifier) {
-  return 'id' in identifier && identifier.id !== null && 'type' in identifier && identifier.type !== null;
+	return "id" in identifier && identifier.id !== null && "type" in identifier && identifier.type !== null;
 }
-
 /**
- * Builds request options to delete record for resources,
- * configured for the url, method and header expectations of ActiveRecord APIs.
- *
- * **Basic Usage**
- *
- * ```ts
- * import { deleteRecord } from '@warp-drive/utilities/active-record';
- *
- * 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/active-record';
- *
- * 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 ActiveRecord APIs.
+*
+* **Basic Usage**
+*
+* ```ts
+* import { deleteRecord } from '@warp-drive/utilities/active-record';
+*
+* 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/active-record';
+*
+* 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
+*/
 function deleteRecord(record, options = {}) {
-  const identifier = recordIdentifierFor(record);
-  (test => {
-    if (!test) {
-      throw new Error(`Expected to be given a record instance`);
-    }
-  })(identifier);
-  (test => {
-    if (!test) {
-      throw new Error(`Cannot delete a record that does not have an associated type and id.`);
-    }
-  })(isExisting(identifier));
-  const urlOptions = {
-    identifier: identifier,
-    op: 'deleteRecord',
-    resourcePath: pluralize(underscore(identifier.type))
-  };
-  copyForwardUrlOptions(urlOptions, options);
-  const url = buildBaseURL(urlOptions);
-  const headers = new Headers();
-  headers.append('Accept', 'application/json;charset=utf-8');
-  return {
-    url,
-    method: 'DELETE',
-    headers,
-    op: 'deleteRecord',
-    data: {
-      record: identifier
-    },
-    records: [identifier]
-  };
+	const identifier = recordIdentifierFor(record);
+	((test) => {
+		if (!test) throw new Error(`Expected to be given a record instance`);
+	})(identifier);
+	((test) => {
+		if (!test) throw new Error(`Cannot delete a record that does not have an associated type and id.`);
+	})(isExisting(identifier));
+	const urlOptions = {
+		identifier,
+		op: "deleteRecord",
+		resourcePath: pluralize(underscore(identifier.type))
+	};
+	copyForwardUrlOptions(urlOptions, options);
+	const url = buildBaseURL(urlOptions);
+	const headers = new Headers();
+	headers.append("Accept", "application/json;charset=utf-8");
+	return {
+		url,
+		method: "DELETE",
+		headers,
+		op: "deleteRecord",
+		data: { record: identifier },
+		records: [identifier]
+	};
 }
-
 /**
- * Builds request options to create new record for resources,
- * configured for the url, method and header expectations of most ActiveRecord APIs.
- *
- * **Basic Usage**
- *
- * ```ts
- * import { createRecord } from '@warp-drive/utilities/active-record';
- *
- * 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/active-record';
- *
- * 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 ActiveRecord APIs.
+*
+* **Basic Usage**
+*
+* ```ts
+* import { createRecord } from '@warp-drive/utilities/active-record';
+*
+* 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/active-record';
+*
+* 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
+*/
 function createRecord(record, options = {}) {
-  const identifier = recordIdentifierFor(record);
-  (test => {
-    if (!test) {
-      throw new Error(`Expected to be given a record instance`);
-    }
-  })(identifier);
-  const urlOptions = {
-    identifier: identifier,
-    op: 'createRecord',
-    resourcePath: pluralize(underscore(identifier.type))
-  };
-  copyForwardUrlOptions(urlOptions, options);
-  const url = buildBaseURL(urlOptions);
-  const headers = new Headers();
-  headers.append('Accept', 'application/json;charset=utf-8');
-  return {
-    url,
-    method: 'POST',
-    headers,
-    op: 'createRecord',
-    data: {
-      record: identifier
-    },
-    records: [identifier]
-  };
+	const identifier = recordIdentifierFor(record);
+	((test) => {
+		if (!test) throw new Error(`Expected to be given a record instance`);
+	})(identifier);
+	const urlOptions = {
+		identifier,
+		op: "createRecord",
+		resourcePath: pluralize(underscore(identifier.type))
+	};
+	copyForwardUrlOptions(urlOptions, options);
+	const url = buildBaseURL(urlOptions);
+	const headers = new Headers();
+	headers.append("Accept", "application/json;charset=utf-8");
+	return {
+		url,
+		method: "POST",
+		headers,
+		op: "createRecord",
+		data: { record: identifier },
+		records: [identifier]
+	};
 }
-
 /**
- * Builds request options to update existing record for resources,
- * configured for the url, method and header expectations of most ActiveRecord APIs.
- *
- * **Basic Usage**
- *
- * ```ts
- * import { updateRecord } from '@warp-drive/utilities/active-record';
- *
- * 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/active-record';
- *
- * 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
- */
-
+* Builds request options to update existing record for resources,
+* configured for the url, method and header expectations of most ActiveRecord APIs.
+*
+* **Basic Usage**
+*
+* ```ts
+* import { updateRecord } from '@warp-drive/utilities/active-record';
+*
+* 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/active-record';
+*
+* 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
+*/
 function updateRecord(record, options = {}) {
-  const identifier = recordIdentifierFor(record);
-  (test => {
-    if (!test) {
-      throw new Error(`Expected to be given a record instance`);
-    }
-  })(identifier);
-  (test => {
-    if (!test) {
-      throw new Error(`Cannot update a record that does not have an associated type and id.`);
-    }
-  })(isExisting(identifier));
-  const urlOptions = {
-    identifier: identifier,
-    op: 'updateRecord',
-    resourcePath: pluralize(underscore(identifier.type))
-  };
-  copyForwardUrlOptions(urlOptions, options);
-  const url = buildBaseURL(urlOptions);
-  const headers = new Headers();
-  headers.append('Accept', 'application/json;charset=utf-8');
-  return {
-    url,
-    method: options.patch ? 'PATCH' : 'PUT',
-    headers,
-    op: 'updateRecord',
-    data: {
-      record: identifier
-    },
-    records: [identifier]
-  };
+	const identifier = recordIdentifierFor(record);
+	((test) => {
+		if (!test) throw new Error(`Expected to be given a record instance`);
+	})(identifier);
+	((test) => {
+		if (!test) throw new Error(`Cannot update a record that does not have an associated type and id.`);
+	})(isExisting(identifier));
+	const urlOptions = {
+		identifier,
+		op: "updateRecord",
+		resourcePath: pluralize(underscore(identifier.type))
+	};
+	copyForwardUrlOptions(urlOptions, options);
+	const url = buildBaseURL(urlOptions);
+	const headers = new Headers();
+	headers.append("Accept", "application/json;charset=utf-8");
+	return {
+		url,
+		method: options.patch ? "PATCH" : "PUT",
+		headers,
+		op: "updateRecord",
+		data: { record: identifier },
+		records: [identifier]
+	};
 }
-export { createRecord, deleteRecord, findRecord, query, updateRecord };
+
+//#endregion
+export { createRecord, deleteRecord, findRecord, query, updateRecord };
+//# sourceMappingURL=active-record.js.map