@warp-drive-mirror/utilities 5.8.0-alpha.37 → 5.8.0-alpha.40

package/dist/unpkg/prod/declarations/-private/string/inflect.d.ts

@@ -1,82 +0,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
-* @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
-* @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
-* @since 4.13.0
-*/
-export declare function loadIrregular(irregularPairs: Array<[string, string]>): void;
-/**
-* 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
-* @since 4.13.0
-*/
-export declare function resetToDefaults(): void;
-/**
-* 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
-* @since 4.13.0
-*/
-export declare function singularize(word: string): string;
-/**
-* Pluralizes a word.
-*
-* @public
-* @since 4.13.0
-*/
-export declare function pluralize(word: string): string;
-/**
-* Adds a pluralization rule.
-*
-* @public
-* @since 4.13.0
-*/
-export declare function plural(regex: RegExp, string: string): void;
-/**
-* Adds a singularization rule.
-*
-* @public
-* @since 4.13.0
-*/
-export declare function singular(regex: RegExp, string: string): void;

package/dist/unpkg/prod/declarations/-private/string/inflections.d.ts

@@ -1,9 +0,0 @@
-export type RulesArray = Array<[RegExp, string]>;
-type DefaultRulesType = {
-	plurals: RulesArray;
-	singular: RulesArray;
-	irregularPairs: Array<[string, string]>;
-	uncountable: string[];
-};
-export declare const defaultRules: DefaultRulesType;
-export {};

package/dist/unpkg/prod/declarations/-private/string/transform.d.ts

@@ -1,77 +0,0 @@
-/**
-* Replaces underscores, spaces, or camelCase with dashes.
-*
-* ```js
-* import { dasherize } from '@warp-drive-mirror/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
-* @since 4.13.0
-*/
-export declare const dasherize: (str: string) => string;
-/**
-* Returns the lowerCamelCase form of a string.
-*
-* ```js
-* import { camelize } from '@warp-drive-mirror/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
-* @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-mirror/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
-* @since 4.13.0
-*/
-export declare function underscore(str: string): string;
-/**
-* Returns the Capitalized form of a string
-*
-* ```js
-* import { capitalize } from '@warp-drive-mirror/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
-* @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
-* @since 4.13.0
-*/
-export declare function setMaxLRUCacheSize(size: number): void;

package/dist/unpkg/prod/declarations/-private.d.ts

@@ -1 +0,0 @@
-export { defaultRules as InflectionRuleDefaults } from "./-private/string/inflections.js";

package/dist/unpkg/prod/declarations/active-record.d.ts

@@ -1,3 +0,0 @@
-export { findRecord } from "./-private/active-record/find-record.js";
-export { query } from "./-private/active-record/query.js";
-export { deleteRecord, createRecord, updateRecord } from "./-private/active-record/save-record.js";

package/dist/unpkg/prod/declarations/derivations.d.ts

@@ -1,27 +0,0 @@
-import type { ReactiveResource } from "@warp-drive-mirror/core/reactive";
-import { Type } from "@warp-drive-mirror/core/types/symbols";
-interface ConcatDerivation {
-	(record: ReactiveResource & {
-		[key: string]: unknown;
-	}, options: Record<string, unknown> | null, _prop: string): string;
-	[Type]: "concat";
-}
-/**
-* A derivation for use by {@link ReactiveResource} that joins the given fields
-* with the optional separator (or '' if no separator is provided).
-*
-* Generally you should not need to import and use this function directly.
-*
-* @example
-* {
-*   name: 'fullName',
-*   kind: 'derived',
-*   type: 'concat',
-*   options: {
-*     fields: ['firstName', 'lastName'],
-*     separator: ' ',
-*   },
-* }
-*/
-export declare const concat: ConcatDerivation;
-export {};

package/dist/unpkg/prod/declarations/handlers.d.ts

@@ -1,10 +0,0 @@
-/**
-* A selection of pre-built request handlers for handling common
-* request scenarios.
-*
-* @module
-*/
-export { AutoCompress, SupportsRequestStreams } from "./-private/handlers/auto-compress.js";
-export { Gate } from "./-private/handlers/gated.js";
-export { MetaDocHandler } from "./-private/handlers/meta-doc.js";
-export { addTraceHeader, TAB_ASSIGNED, TAB_ID, assertInvalidUrlLength, MAX_URL_LENGTH } from "./-private/handlers/utils.js";

package/dist/unpkg/prod/declarations/index.d.ts

@@ -1,208 +0,0 @@
-import type { QueryParamsSerializationOptions, QueryParamsSource, Serializable } from "@warp-drive-mirror/core/types/params";
-export interface BuildURLConfig {
-	host: string | null;
-	namespace: string | null;
-}
-/**
-* Sets the global configuration for `buildBaseURL`
-* for host and namespace values for the application.
-*
-* These values may still be overridden by passing
-* them to buildBaseURL directly.
-*
-* This method may be called as many times as needed.
-* host values of `''` or `'/'` are equivalent.
-*
-* Except for the value of `/` as host, host should not
-* end with `/`.
-*
-* namespace should not start or end with a `/`.
-*
-* ```ts
-* type BuildURLConfig = {
-*   host: string;
-*   namespace: string'
-* }
-* ```
-*
-* Example:
-*
-* ```ts
-* import { setBuildURLConfig } from '@ember-data-mirror/request-utils';
-*
-* setBuildURLConfig({
-*   host: 'https://api.example.com',
-*   namespace: 'api/v1'
-* });
-* ```
-*
-* @public
-*/
-export declare function setBuildURLConfig(config: BuildURLConfig): void;
-export interface FindRecordUrlOptions {
-	op: "findRecord";
-	identifier: {
-		type: string;
-		id: string;
-	};
-	resourcePath?: string;
-	host?: string;
-	namespace?: string;
-}
-export interface QueryUrlOptions {
-	op: "query";
-	identifier: {
-		type: string;
-	};
-	resourcePath?: string;
-	host?: string;
-	namespace?: string;
-}
-export interface FindManyUrlOptions {
-	op: "findMany";
-	identifiers: {
-		type: string;
-		id: string;
-	}[];
-	resourcePath?: string;
-	host?: string;
-	namespace?: string;
-}
-export interface FindRelatedCollectionUrlOptions {
-	op: "findRelatedCollection";
-	identifier: {
-		type: string;
-		id: string;
-	};
-	fieldPath: string;
-	resourcePath?: string;
-	host?: string;
-	namespace?: string;
-}
-export interface FindRelatedResourceUrlOptions {
-	op: "findRelatedRecord";
-	identifier: {
-		type: string;
-		id: string;
-	};
-	fieldPath: string;
-	resourcePath?: string;
-	host?: string;
-	namespace?: string;
-}
-export interface CreateRecordUrlOptions {
-	op: "createRecord";
-	identifier: {
-		type: string;
-	};
-	resourcePath?: string;
-	host?: string;
-	namespace?: string;
-}
-export interface UpdateRecordUrlOptions {
-	op: "updateRecord";
-	identifier: {
-		type: string;
-		id: string;
-	};
-	resourcePath?: string;
-	host?: string;
-	namespace?: string;
-}
-export interface DeleteRecordUrlOptions {
-	op: "deleteRecord";
-	identifier: {
-		type: string;
-		id: string;
-	};
-	resourcePath?: string;
-	host?: string;
-	namespace?: string;
-}
-export interface GenericUrlOptions {
-	resourcePath: string;
-	host?: string;
-	namespace?: string;
-}
-export type UrlOptions = FindRecordUrlOptions | QueryUrlOptions | FindManyUrlOptions | FindRelatedCollectionUrlOptions | FindRelatedResourceUrlOptions | CreateRecordUrlOptions | UpdateRecordUrlOptions | DeleteRecordUrlOptions | GenericUrlOptions;
-/**
-* Builds a URL for a request based on the provided options.
-* Does not include support for building query params (see `buildQueryParams`)
-* so that it may be composed cleanly with other query-params strategies.
-*
-* Usage:
-*
-* ```ts
-* import { buildBaseURL } from '@ember-data-mirror/request-utils';
-*
-* const url = buildBaseURL({
-*   host: 'https://api.example.com',
-*   namespace: 'api/v1',
-*   resourcePath: 'emberDevelopers',
-*   op: 'query',
-*   identifier: { type: 'ember-developer' }
-* });
-*
-* // => 'https://api.example.com/api/v1/emberDevelopers'
-* ```
-*
-* On the surface this may seem like a lot of work to do something simple, but
-* it is designed to be composable with other utilities and interfaces that the
-* average product engineer will never need to see or use.
-*
-* A few notes:
-*
-* - `resourcePath` is optional, but if it is not provided, `identifier.type` will be used.
-* - `host` and `namespace` are optional, but if they are not provided, the values globally
-*    configured via `setBuildURLConfig` will be used.
-* - `op` is required and must be one of the following:
-*   - 'findRecord' 'query' 'findMany' 'findRelatedCollection' 'findRelatedRecord'` 'createRecord' 'updateRecord' 'deleteRecord'
-* - Depending on the value of `op`, `identifier` or `identifiers` will be required.
-*
-* @public
-*/
-export declare function buildBaseURL(urlOptions: UrlOptions): string;
-/**
-* filter out keys of an object that have falsy values or point to empty arrays
-* returning a new object with only those keys that have truthy values / non-empty arrays
-*
-* @public
-* @param source object to filter keys with empty values from
-* @return A new object with the keys that contained empty values removed
-*/
-export declare function filterEmpty(source: Record<string, Serializable>): Record<string, Serializable>;
-/**
-* Sorts query params by both key and value returning a new URLSearchParams
-* object with the keys inserted in sorted order.
-*
-* Treats `included` specially, splicing it into an array if it is a string and sorting the array.
-*
-* Options:
-* - arrayFormat: 'bracket' | 'indices' | 'repeat' | 'comma'
-*
-* 'bracket': appends [] to the key for every value e.g. `&ids[]=1&ids[]=2`
-* 'indices': appends [i] to the key for every value e.g. `&ids[0]=1&ids[1]=2`
-* 'repeat': appends the key for every value e.g. `&ids=1&ids=2`
-* 'comma' (default): appends the key once with a comma separated list of values e.g. `&ids=1,2`
-*
-* @public
-* @return A {@link URLSearchParams} with keys inserted in sorted order
-*/
-export declare function sortQueryParams(params: QueryParamsSource, options?: QueryParamsSerializationOptions): URLSearchParams;
-/**
-* Sorts query params by both key and value, returning a query params string
-*
-* Treats `included` specially, splicing it into an array if it is a string and sorting the array.
-*
-* Options:
-* - arrayFormat: 'bracket' | 'indices' | 'repeat' | 'comma'
-*
-* 'bracket': appends [] to the key for every value e.g. `ids[]=1&ids[]=2`
-* 'indices': appends [i] to the key for every value e.g. `ids[0]=1&ids[1]=2`
-* 'repeat': appends the key for every value e.g. `ids=1&ids=2`
-* 'comma' (default): appends the key once with a comma separated list of values e.g. `ids=1,2`
-*
-* @public
-* @return A sorted query params string without the leading `?`
-*/
-export declare function buildQueryParams(params: QueryParamsSource, options?: QueryParamsSerializationOptions): string;

package/dist/unpkg/prod/declarations/json-api.d.ts

@@ -1,5 +0,0 @@
-export { findRecord } from "./-private/json-api/find-record.js";
-export { query, postQuery } from "./-private/json-api/query.js";
-export { deleteRecord, createRecord, updateRecord } from "./-private/json-api/save-record.js";
-export { serializeResources, serializePatch } from "./-private/json-api/serialize.js";
-export { setBuildURLConfig } from "./-private/json-api/-utils.js";

package/dist/unpkg/prod/declarations/rest.d.ts

@@ -1,3 +0,0 @@
-export { findRecord } from "./-private/rest/find-record.js";
-export { query } from "./-private/rest/query.js";
-export { deleteRecord, createRecord, updateRecord } from "./-private/rest/save-record.js";

package/dist/unpkg/prod/declarations/string.d.ts

@@ -1,14 +0,0 @@
-/**
-* String utilities for transforming and inflecting strings useful for
-* when the format provided by the server is not the format you want to use
-* in your application.
-*
-* Each transformation function stores its results in an LRUCache to avoid
-* recomputing the same value multiple times. The cache size can be set
-* using the `setMaxLRUCacheSize` function. The default size is 10,000.
-*
-* @module
-* @public
-*/
-export { pluralize, singularize, singular, plural, loadIrregular, loadUncountable, irregular, uncountable, resetToDefaults, clear, clearRules } from "./-private/string/inflect.js";
-export { dasherize, camelize, capitalize, underscore, setMaxLRUCacheSize } from "./-private/string/transform.js";

package/dist/unpkg/prod-deprecated/declarations/-private/active-record/find-record.d.ts

@@ -1,64 +0,0 @@
-import type { ReactiveDataDocument } from "@warp-drive-mirror/core/reactive";
-import type { TypeFromInstance } from "@warp-drive-mirror/core/types/record";
-import type { FindRecordOptions, FindRecordRequestOptions, RemotelyAccessibleIdentifier } from "@warp-drive-mirror/core/types/request";
-/**
-* 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-mirror/utilities/active-record';
-*
-* const data = await store.request(findRecord('person', '1'));
-* ```
-*
-* **With Options**
-*
-* ```ts
-* import { findRecord } from '@warp-drive-mirror/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-mirror/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-mirror/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
-*/
-export declare function findRecord<T>(identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>, options?: FindRecordOptions): FindRecordRequestOptions<ReactiveDataDocument<T>, T>;
-export declare function findRecord(identifier: RemotelyAccessibleIdentifier, options?: FindRecordOptions): FindRecordRequestOptions;
-export declare function findRecord<T>(type: TypeFromInstance<T>, id: string, options?: FindRecordOptions): FindRecordRequestOptions<ReactiveDataDocument<T>, T>;
-export declare function findRecord(type: string, id: string, options?: FindRecordOptions): FindRecordRequestOptions;
-/** @deprecated use {@link ReactiveDataDocument} instead */
-export type FindRecordResultDocument<T> = ReactiveDataDocument<T>;

package/dist/unpkg/prod-deprecated/declarations/-private/active-record/query.d.ts

@@ -1,53 +0,0 @@
-import type { ReactiveDataDocument } from "@warp-drive-mirror/core/reactive";
-import type { QueryParamsSource } from "@warp-drive-mirror/core/types/params";
-import type { TypeFromInstance } from "@warp-drive-mirror/core/types/record";
-import type { ConstrainedRequestOptions, QueryRequestOptions } from "@warp-drive-mirror/core/types/request";
-/**
-* 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-mirror/utilities/active-record';
-*
-* const data = await store.request(query('person'));
-* ```
-*
-* **With Query Params**
-*
-* ```ts
-* import { query } from '@warp-drive-mirror/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-mirror/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
-*/
-export declare function query<T>(type: TypeFromInstance<T>, query?: QueryParamsSource, options?: ConstrainedRequestOptions): QueryRequestOptions<ReactiveDataDocument<T[]>>;
-export declare function query(type: string, query?: QueryParamsSource, options?: ConstrainedRequestOptions): QueryRequestOptions;