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

package/declarations/-private/rest/query.d.ts

@@ -1,54 +1,53 @@
-import type { QueryParamsSource } from '@warp-drive/core/types/params';
-import type { TypeFromInstance } from '@warp-drive/core/types/record';
-import type { ConstrainedRequestOptions, QueryRequestOptions } from '@warp-drive/core/types/request';
-import type { CollectionResourceDataDocument } from '@warp-drive/core/types/spec/document';
+import type { QueryParamsSource } from "@warp-drive/core/types/params";
+import type { TypeFromInstance } from "@warp-drive/core/types/record";
+import type { ConstrainedRequestOptions, QueryRequestOptions } from "@warp-drive/core/types/request";
+import type { CollectionResourceDataDocument } from "@warp-drive/core/types/spec/document";
 /**
- * Builds request options to query for resources, usually by a primary
- * type, configured for the url and header expectations of most REST APIs.
- *
- * **Basic Usage**
- *
- * ```ts
- * import { query } from '@warp-drive/utilities/rest';
- *
- * const data = await store.request(query('person'));
- * ```
- *
- * **With Query Params**
- *
- * ```ts
- * import { query } from '@warp-drive/utilities/rest';
- *
- * 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 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.
- * - `urlParamsSettings` - an object containing options for how to serialize the query params (see `buildQueryParams`)
- *
- * ```ts
- * import { query } from '@warp-drive/utilities/rest';
- *
- * const options = query('person', { include: ['pets', 'friends'] }, { reload: true });
- * const data = await store.request(options);
- * ```
- *
- * @public
- * @param identifier
- * @param query
- * @param options
- */
+* Builds request options to query for resources, usually by a primary
+* type, configured for the url and header expectations of most REST APIs.
+*
+* **Basic Usage**
+*
+* ```ts
+* import { query } from '@warp-drive/utilities/rest';
+*
+* const data = await store.request(query('person'));
+* ```
+*
+* **With Query Params**
+*
+* ```ts
+* import { query } from '@warp-drive/utilities/rest';
+*
+* 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 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.
+* - `urlParamsSettings` - an object containing options for how to serialize the query params (see `buildQueryParams`)
+*
+* ```ts
+* import { query } from '@warp-drive/utilities/rest';
+*
+* const options = query('person', { include: ['pets', 'friends'] }, { reload: true });
+* const data = await store.request(options);
+* ```
+*
+* @public
+* @param identifier
+* @param query
+* @param options
+*/
 export declare function query<T>(type: TypeFromInstance<T>, query?: QueryParamsSource, options?: ConstrainedRequestOptions): QueryRequestOptions<CollectionResourceDataDocument<T>, T>;
 export declare function query(type: string, query?: QueryParamsSource, options?: ConstrainedRequestOptions): QueryRequestOptions;
-//# sourceMappingURL=query.d.ts.map

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

@@ -1,144 +1,146 @@
-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 REST APIs.
- *
- * **Basic Usage**
- *
- * ```ts
- * import { deleteRecord } from '@warp-drive/utilities/rest';
- *
- * 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/rest';
- *
- * 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 REST APIs.
+*
+* **Basic Usage**
+*
+* ```ts
+* import { deleteRecord } from '@warp-drive/utilities/rest';
+*
+* 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/rest';
+*
+* 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 REST APIs.
- *
- * **Basic Usage**
- *
- * ```ts
- * import { createRecord } from '@warp-drive/utilities/rest';
- *
- * 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/rest';
- *
- * 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 REST APIs.
+*
+* **Basic Usage**
+*
+* ```ts
+* import { createRecord } from '@warp-drive/utilities/rest';
+*
+* 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/rest';
+*
+* 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 REST APIs.
- *
- * **Basic Usage**
- *
- * ```ts
- * import { updateRecord } from '@warp-drive/utilities/rest';
- *
- * 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/rest';
- *
- * 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 REST APIs.
+*
+* **Basic Usage**
+*
+* ```ts
+* import { updateRecord } from '@warp-drive/utilities/rest';
+*
+* 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/rest';
+*
+* 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;
-//# sourceMappingURL=save-record.d.ts.map

package/declarations/-private/string/inflect.d.ts

@@ -1,105 +1,82 @@
 /**
- * Marks a word as uncountable. Uncountable words are not pluralized
- * or singularized.
- *
- * @public
- * @param {String} word
- * @return {void}
- * @since 4.13.0
- */
+* Marks a word as uncountable. Uncountable words are not pluralized
+* or singularized.
+*
+* @public
+* @since 4.13.0
+*/
 export declare function uncountable(word: string): void;
 /**
- * Marks a list of words as uncountable. Uncountable words are not pluralized
- * or singularized.
- *
- * @public
- * @param {Array<String>} uncountables
- * @return {void}
- * @since 4.13.0
- */
+* Marks a list of words as uncountable. Uncountable words are not pluralized
+* or singularized.
+*
+* @public
+* @since 4.13.0
+*/
 export declare function loadUncountable(uncountables: string[]): void;
 /**
- * Marks a word as irregular. Irregular words have unique
- * pluralization and singularization rules.
- *
- * @public
- * @param {String} single
- * @param {String} plur
- * @return {void}
- * @since 4.13.0
- */
+* Marks a word as irregular. Irregular words have unique
+* pluralization and singularization rules.
+*
+* @public
+* @since 4.13.0
+*/
 export declare function irregular(single: string, plur: string): void;
 /**
- * Marks a list of word pairs as irregular. Irregular words have unique
- * pluralization and singularization rules.
- *
- * @public
- * @param {Array<Array<String>>} irregularPairs
- * @return {void}
- * @since 4.13.0
- */
+* Marks a list of word pairs as irregular. Irregular words have unique
+* pluralization and singularization rules.
+*
+* @public
+* @since 4.13.0
+*/
 export declare function loadIrregular(irregularPairs: Array<[string, string]>): void;
 /**
- * Clears the caches for singularize and pluralize.
- *
- * @public
- * @return {void}
- * @since 4.13.0
- */
+* Clears the caches for singularize and pluralize.
+*
+* @public
+* @since 4.13.0
+*/
 export declare function clear(): void;
 /**
- * Resets the inflection rules to the defaults.
- *
- * @public
- * @return {void}
- * @since 4.13.0
- */
+* Resets the inflection rules to the defaults.
+*
+* @public
+* @since 4.13.0
+*/
 export declare function resetToDefaults(): void;
 /**
- * Clears all inflection rules
- * and resets the caches for singularize and pluralize.
- *
- * @public
- * @return {void}
- * @since 4.13.0
- */
+* Clears all inflection rules
+* and resets the caches for singularize and pluralize.
+*
+* @public
+* @since 4.13.0
+*/
 export declare function clearRules(): void;
 /**
- * Singularizes a word.
- *
- * @public
- * @param {String} word
- * @return {String}
- * @since 4.13.0
- */
+* Singularizes a word.
+*
+* @public
+* @since 4.13.0
+*/
 export declare function singularize(word: string): string;
 /**
- * Pluralizes a word.
- *
- * @public
- * @param {String} word
- * @return {String}
- * @since 4.13.0
- */
+* Pluralizes a word.
+*
+* @public
+* @since 4.13.0
+*/
 export declare function pluralize(word: string): string;
 /**
- * Adds a pluralization rule.
- *
- * @public
- * @param {RegExp} regex
- * @param {String} string
- * @return {void}
- * @since 4.13.0
- */
+* Adds a pluralization rule.
+*
+* @public
+* @since 4.13.0
+*/
 export declare function plural(regex: RegExp, string: string): void;
 /**
- * Adds a singularization rule.
- *
- * @public
- * @param {RegExp} regex
- * @param {String} string
- * @return {void}
- * @since 4.13.0
- */
+* Adds a singularization rule.
+*
+* @public
+* @since 4.13.0
+*/
 export declare function singular(regex: RegExp, string: string): void;
-//# sourceMappingURL=inflect.d.ts.map

package/declarations/-private/string/inflections.d.ts

@@ -1,10 +1,9 @@
 export type RulesArray = Array<[RegExp, string]>;
 type DefaultRulesType = {
-    plurals: RulesArray;
-    singular: RulesArray;
-    irregularPairs: Array<[string, string]>;
-    uncountable: string[];
+	plurals: RulesArray;
+	singular: RulesArray;
+	irregularPairs: Array<[string, string]>;
+	uncountable: string[];
 };
 export declare const defaultRules: DefaultRulesType;
 export {};
-//# sourceMappingURL=inflections.d.ts.map