@warp-drive/utilities 5.6.0-alpha.11

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

@@ -0,0 +1,144 @@
+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
+ */
+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
+ */
+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;
+}): UpdateRequestOptions<SingleResourceDataDocument<RT>, T>;
+export declare function updateRecord(record: unknown, options?: ConstrainedRequestOptions & {
+    patch?: boolean;
+}): UpdateRequestOptions;
+//# sourceMappingURL=save-record.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"save-record.d.ts","sourceRoot":"","sources":["../../../src/-private/rest/save-record.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,KAAK,EACV,yBAAyB,EACzB,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,gCAAgC,CAAC;AACxC,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,sCAAsC,CAAC;AAevF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,yBAAyB,GAAG,oBAAoB,CAAC,CAAC,CAAC,CAAC;AACzG,wBAAgB,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,yBAAyB,GAAG,oBAAoB,CAAC;AA8BzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,yBAAyB,GAAG,oBAAoB,CAAC,CAAC,CAAC,CAAC;AACzG,wBAAgB,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,yBAAyB,GAAG,oBAAoB,CAAC;AA6BzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,mBAAmB,EAAE,EAAE,SAAS,mBAAmB,GAAG,CAAC,EAC5F,MAAM,EAAE,CAAC,EACT,OAAO,CAAC,EAAE,yBAAyB,GAAG;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GACxD,oBAAoB,CAAC,0BAA0B,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAC3D,wBAAgB,YAAY,CAC1B,MAAM,EAAE,OAAO,EACf,OAAO,CAAC,EAAE,yBAAyB,GAAG;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GACxD,oBAAoB,CAAC"}

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

@@ -0,0 +1,105 @@
+/**
+ * Marks a word as uncountable. Uncountable words are not pluralized
+ * or singularized.
+ *
+ * @public
+ * @param {String} word
+ * @return {void}
+ * @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
+ */
+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
+ */
+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
+ */
+export declare function loadIrregular(irregularPairs: Array<[string, string]>): void;
+/**
+ * Clears the caches for singularize and pluralize.
+ *
+ * @public
+ * @return {void}
+ * @since 4.13.0
+ */
+export declare function clear(): void;
+/**
+ * Resets the inflection rules to the defaults.
+ *
+ * @public
+ * @return {void}
+ * @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
+ */
+export declare function clearRules(): void;
+/**
+ * Singularizes a word.
+ *
+ * @public
+ * @param {String} word
+ * @return {String}
+ * @since 4.13.0
+ */
+export declare function singularize(word: string): string;
+/**
+ * Pluralizes a word.
+ *
+ * @public
+ * @param {String} word
+ * @return {String}
+ * @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
+ */
+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
+ */
+export declare function singular(regex: RegExp, string: string): void;
+//# sourceMappingURL=inflect.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"inflect.d.ts","sourceRoot":"","sources":["../../../src/-private/string/inflect.ts"],"names":[],"mappings":"AAuBA;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,QAEvC;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,QAIrD;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAQrD;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,QAUpE;AAGD;;;;;;GAMG;AACH,wBAAgB,KAAK,SAGpB;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,SAM9B;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,SAQzB;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,UAIvC;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,UAIrC;AAWD;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAQnD;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAQrD"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"inflections.d.ts","sourceRoot":"","sources":["../../../src/-private/string/inflections.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AACjD,KAAK,gBAAgB,GAAG;IACtB,OAAO,EAAE,UAAU,CAAC;IACpB,QAAQ,EAAE,UAAU,CAAC;IACrB,cAAc,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACxC,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,gBAkE1B,CAAC"}

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

@@ -0,0 +1,89 @@
+import { dasherize as internalDasherize } from '@warp-drive/core/utils/string';
+/**
+ * Replaces underscores, spaces, or camelCase with dashes.
+ *
+ * ```js
+ * import { dasherize } from '@warp-drive/utilities/string';
+ *
+ * dasherize('innerHTML');                // 'inner-html'
+ * dasherize('action_name');              // 'action-name'
+ * dasherize('css-class-name');           // 'css-class-name'
+ * dasherize('my favorite items');        // 'my-favorite-items'
+ * dasherize('privateDocs/ownerInvoice';  // 'private-docs/owner-invoice'
+ * ```
+ *
+ * @public
+ * @param {String} str
+ * @return {String}
+ * @since 4.13.0
+ */
+export declare const dasherize: typeof internalDasherize;
+/**
+ * Returns the lowerCamelCase form of a string.
+ *
+ * ```js
+ * import { camelize } from '@warp-drive/utilities/string';
+ *
+ * camelize('innerHTML');                   // 'innerHTML'
+ * camelize('action_name');                 // 'actionName'
+ * camelize('css-class-name');              // 'cssClassName'
+ * camelize('my favorite items');           // 'myFavoriteItems'
+ * camelize('My Favorite Items');           // 'myFavoriteItems'
+ * camelize('private-docs/owner-invoice');  // 'privateDocs/ownerInvoice'
+ * ```
+ *
+ * @public
+ * @param {String} str
+ * @return {String}
+ * @since 4.13.0
+ */
+export declare function camelize(str: string): string;
+/**
+ * Returns the lower\_case\_and\_underscored form of a string.
+ *
+ * ```js
+ * import { underscore } from '@warp-drive/utilities/string';
+ *
+ * underscore('innerHTML');                 // 'inner_html'
+ * underscore('action_name');               // 'action_name'
+ * underscore('css-class-name');            // 'css_class_name'
+ * underscore('my favorite items');         // 'my_favorite_items'
+ * underscore('privateDocs/ownerInvoice');  // 'private_docs/owner_invoice'
+ * ```
+ *
+ * @public
+ * @param {String} str
+ * @return {String}
+ * @since 4.13.0
+ */
+export declare function underscore(str: string): string;
+/**
+ * Returns the Capitalized form of a string
+ *
+ * ```js
+ * import { capitalize } from '@warp-drive/utilities/string';
+ *
+ * capitalize('innerHTML')                 // 'InnerHTML'
+ * capitalize('action_name')               // 'Action_name'
+ * capitalize('css-class-name')            // 'Css-class-name'
+ * capitalize('my favorite items')         // 'My favorite items'
+ * capitalize('privateDocs/ownerInvoice'); // 'PrivateDocs/ownerInvoice'
+ * ```
+ *
+ * @public
+ * @param {String} str
+ * @return {String}
+ * @since 4.13.0
+ */
+export declare function capitalize(str: string): string;
+/**
+ * Sets the maximum size of the LRUCache for all string transformation functions.
+ * The default size is 10,000.
+ *
+ * @public
+ * @param {Number} size
+ * @return {void}
+ * @since 4.13.0
+ */
+export declare function setMaxLRUCacheSize(size: number): void;
+//# sourceMappingURL=transform.d.ts.map

package/declarations/-private/string/transform.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform.d.ts","sourceRoot":"","sources":["../../../src/-private/string/transform.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,IAAI,iBAAiB,EAAoC,MAAM,+BAA+B,CAAC;AAuBjH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,SAAS,0BAAoB,CAAC;AAE3C;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE9C;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE9C;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,QAK9C"}

package/declarations/-private.d.ts

@@ -0,0 +1,2 @@
+export { defaultRules as InflectionRuleDefaults } from './-private/string/inflections.ts';
+//# sourceMappingURL=-private.d.ts.map

package/declarations/-private.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"-private.d.ts","sourceRoot":"","sources":["../src/-private.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,IAAI,sBAAsB,EAAE,MAAM,kCAAkC,CAAC"}

package/declarations/active-record.d.ts

@@ -0,0 +1,71 @@
+/**
+ *
+ *
+ *This package provides utilities for working with [ActiveRecord](https://guides.rubyonrails.org/active_record_basics.html#convention-over-configuration-in-active-record) APIs.
+ *
+ * ## Installation
+ *
+ * Install using your javascript package manager of choice. For instance with [pnpm](https://pnpm.io/)
+ *
+ * ::: code-group
+ *
+ * ```sh [pnpm]
+ * pnpm add -E @ember-data/active-record
+ * ```
+ *
+ * ```sh [npm]
+ * npm add -E @ember-data/active-record
+ * ```
+ *
+ * ```sh [yarn]
+ * yarn add -E @ember-data/active-record
+ * ```
+ *
+ * ```sh [bun]
+ * bun add --exact @ember-data/active-record
+ * ```
+ *
+ * :::
+ *
+ * ## Usage
+ *
+ * Request builders are functions that produce [Fetch Options](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
+ * They take a few contextual inputs about the request you want to make, abstracting away the gnarlier details.
+ *
+ * For instance, to construct a request that would fetch a resource from your API:
+ *
+ * ```ts
+ * import { findRecord } from '@ember-data/active-record/request';
+ *
+ * const options = findRecord('ember-developer', '1', { include: ['pets', 'friends'] });
+ * ```
+ *
+ * This would produce the following request object:
+ *
+ * ```js
+ * {
+ *   url: 'https://api.example.com/v1/ember_developers/1?include=friends,pets',
+ *   method: 'GET',
+ *   headers: <Headers>, // 'Accept': 'application/json;charset=utf-8'
+ *   op: 'findRecord';
+ *   records: [{ type: 'ember-developer', id: '1' }]
+ * }
+ * ```
+ *
+ * Request builder output may be used with either `requestManager.request` or `store.request`.
+ *
+ * ```ts
+ * const data = await store.request(options);
+ * ```
+ *
+ * URLs are stable. The same query will produce the same URL every time, even if the order of keys in
+ * the query or values in an array changes.
+ *
+ * URLs follow the most common ActiveRecord format (underscored pluralized resource types).
+ *
+ * @module
+ */
+export { findRecord } from './-private/active-record/find-record';
+export { query } from './-private/active-record/query';
+export { deleteRecord, createRecord, updateRecord } from './-private/active-record/save-record';
+//# sourceMappingURL=active-record.d.ts.map

package/declarations/active-record.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"active-record.d.ts","sourceRoot":"","sources":["../src/active-record.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAClE,OAAO,EAAE,KAAK,EAAE,MAAM,gCAAgC,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC"}

package/declarations/handlers.d.ts

@@ -0,0 +1,8 @@
+/**
+ * A selection of pre-built request handlers for handling common
+ * request scenarios.
+ *
+ * @module
+ */
+export { AutoCompress, SupportsRequestStreams } from './-private/handlers/auto-compress.ts';
+//# sourceMappingURL=handlers.d.ts.map

package/declarations/handlers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handlers.d.ts","sourceRoot":"","sources":["../src/handlers.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,YAAY,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC"}