@warp-drive-mirror/utilities 5.8.0-alpha.30 → 5.8.0-alpha.32

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

@@ -0,0 +1,228 @@
+import type { ReactiveDataDocument } from "@warp-drive-mirror/core/reactive.js";
+import type { TypedRecordInstance } from "@warp-drive-mirror/core/types/record";
+import type { ConstrainedRequestOptions, CreateRequestOptions, DeleteRequestOptions, UpdateRequestOptions } from "@warp-drive-mirror/core/types/request";
+/**
+* :::warning ⚠️ **These Mutation Builders DO NOT Set The Request Body**
+* While this may come as a surprise, the app providing the body ensures that only
+* desired and correctly formatted data is sent with the request.
+* :::
+*
+* 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-mirror/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-mirror/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;
+/**
+* :::warning ⚠️ **These Mutation Builders DO NOT Set The Necessary Request Body**
+* While this may come as a surprise, the app providing the body ensures that only
+* desired and correctly formatted data is sent with the request.
+* :::
+*
+* 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 { cacheKeyFor } from '@warp-drive-mirror/core';
+* import { createRecord } from '@warp-drive-mirror/utilities/json-api';
+* import type { Person } from '#/data/types';
+*
+* const person = store.createRecord<Person>('person', { name: 'Ted' });
+* const init = createRecord(person);
+* init.body = JSON.stringify(
+*  {
+*    // it's likely you will want to transform this data
+*    // somewhat
+*    data: store.cache.peek(cacheKeyFor(person))
+*  }
+* );
+* const data = await store.request(init);
+* ```
+*
+* **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-mirror/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;
+/**
+* :::warning ⚠️ **These Mutation Builders DO NOT Set The Necessary Request Body**
+* While this may come as a surprise, the app providing the body ensures that only
+* desired and correctly formatted data is sent with the request.
+* :::
+*
+* Builds request options to update existing record for resources,
+* configured for the url, method and header expectations of most JSON:API APIs.
+*
+* **Example Usage**
+*
+* ```ts
+* import { cacheKeyFor } from '@warp-drive-mirror/core';
+* import { updateRecord } from '@warp-drive-mirror/utilities/json-api';
+* import type { EditablePerson } from '#/data/types';
+*
+* const mutable = await checkout<EditablePerson>(person);
+* mutable.name = 'Chris';
+* const init = updateRecord(mutable);
+*
+* init.body = JSON.stringify(
+*  // it's likely you will want to transform this data
+*  // somewhat, or serialize only specific properties instead
+*  serializePatch(store.cache, cacheKeyFor(mutable))
+* );
+* const data = await store.request(init);
+* ```
+*
+*
+* **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-mirror/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<ReactiveDataDocument<RT>, T>;
+export declare function updateRecord(record: unknown, options?: ConstrainedRequestOptions & {
+	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-mirror/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-mirror/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;

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

@@ -0,0 +1,70 @@
+import type { Cache } from "@warp-drive-mirror/core/types/cache";
+import type { ResourceKey } from "@warp-drive-mirror/core/types/identifier";
+import type { Value } from "@warp-drive-mirror/core/types/json/raw";
+import type { InnerRelationshipDocument, ResourceObject } from "@warp-drive-mirror/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: null;
+	lid: string;
+	attributes?: Record<string, Value>;
+	relationships?: Record<string, ChangedRelationshipData>;
+};
+/**
+* :::warning ⚠️ **This util often won't produce the necessary body for a {json:api} request**
+*
+* While this may come as a surprise, they are intended to serialize cache state for more
+* generalized usage. {json:api} has a large variance in acceptable shapes, and only your
+* app can ensure that the body is correctly formatted and contains all necessary data.
+* :::
+*
+* Serializes the current state of a resource or array of resources for use with POST or PUT requests.
+*
+* @public
+* @param {Cache} cache}
+* @param {ResourceKey} identifier
+* @return {Object} An object with a `data` property containing the serialized resource patch
+*/
+export declare function serializeResources(cache: Cache, identifiers: ResourceKey): {
+	data: ResourceObject;
+};
+export declare function serializeResources(cache: Cache, identifiers: ResourceKey[]): {
+	data: ResourceObject[];
+};
+/**
+* :::warning ⚠️ **This util often won't produce the necessary body for a {json:api} request**
+*
+* While this may come as a surprise, they are intended to serialize cache state for more
+* generalized usage. {json:api} has a large variance in acceptable shapes, and only your
+* app can ensure that the body is correctly formatted and contains all necessary data.
+* :::
+*
+* Serializes changes to a resource. Useful for use with building bodies for 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 {ResourceKey} identifier
+* @return {Object} An object with a `data` property containing the serialized resource patch
+*/
+export declare function serializePatch(cache: Cache, identifier: ResourceKey): {
+	data: JsonApiResourcePatch;
+};
+export {};

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

@@ -0,0 +1,62 @@
+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 REST APIs.
+*
+* **Basic Usage**
+*
+* ```ts
+* import { findRecord } from '@warp-drive-mirror/utilities/rest';
+*
+* const data = await store.request(findRecord('person', '1'));
+* ```
+*
+* **With Options**
+*
+* ```ts
+* import { findRecord } from '@warp-drive-mirror/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-mirror/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-mirror/utilities/rest';
+*
+* const options = findRecord('person', '1', { include: ['pets', 'friends'] }, { namespace: 'api/v2' });
+* const data = await store.request(options);
+* ```
+*
+* @public
+*/
+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/declarations/-private/rest/query.d.ts

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

package/dist/unpkg/prod/declarations/-private/rest/save-record.d.ts

@@ -0,0 +1,146 @@
+import type { ReactiveDataDocument } from "@warp-drive-mirror/core/reactive";
+import type { TypedRecordInstance } from "@warp-drive-mirror/core/types/record";
+import type { ConstrainedRequestOptions, CreateRequestOptions, DeleteRequestOptions, UpdateRequestOptions } from "@warp-drive-mirror/core/types/request";
+/**
+* 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-mirror/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-mirror/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-mirror/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-mirror/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-mirror/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-mirror/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<ReactiveDataDocument<RT>, T>;
+export declare function updateRecord(record: unknown, options?: ConstrainedRequestOptions & {
+	patch?: boolean;
+}): UpdateRequestOptions;

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

@@ -0,0 +1,82 @@
+/**
+* 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

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