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

package/declarations/-private/json-api/find-record.d.ts

@@ -1,66 +1,65 @@
-import type { TypeFromInstance } from '@warp-drive/core/types/record';
-import type { FindRecordOptions, FindRecordRequestOptions, RemotelyAccessibleIdentifier } from '@warp-drive/core/types/request';
-import type { SingleResourceDataDocument } from '@warp-drive/core/types/spec/document';
+import type { TypeFromInstance } from "@warp-drive/core/types/record";
+import type { FindRecordOptions, FindRecordRequestOptions, RemotelyAccessibleIdentifier } from "@warp-drive/core/types/request";
+import type { SingleResourceDataDocument } from "@warp-drive/core/types/spec/document";
 /**
- * Builds request options to fetch a single resource by a known id or identifier
- * configured for the url and header expectations of most JSON:API APIs.
- *
- * **Basic Usage**
- *
- * ```ts
- * import { findRecord } from '@warp-drive/utilities/json-api';
- *
- * const data = await store.request(findRecord('person', '1'));
- * ```
- *
- * **With Options**
- *
- * ```ts
- * import { findRecord } from '@warp-drive/utilities/json-api';
- *
- * const options = findRecord('person', '1', { include: ['pets', 'friends'] });
- * const data = await store.request(options);
- * ```
- *
- * **With an Identifier**
- *
- * ```ts
- * import { findRecord } from '@warp-drive/utilities/json-api';
- *
- * 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 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/json-api';
- *
- * const options = findRecord('person', '1', { include: ['pets', 'friends'] }, { namespace: 'api/v2' });
- * const data = await store.request(options);
- * ```
- *
- * @public
- * @param identifier
- * @param options
- */
-export type FindRecordResultDocument<T> = Omit<SingleResourceDataDocument<T>, 'data'> & {
-    data: T;
+* Builds request options to fetch a single resource by a known id or identifier
+* configured for the url and header expectations of most JSON:API APIs.
+*
+* **Basic Usage**
+*
+* ```ts
+* import { findRecord } from '@warp-drive/utilities/json-api';
+*
+* const data = await store.request(findRecord('person', '1'));
+* ```
+*
+* **With Options**
+*
+* ```ts
+* import { findRecord } from '@warp-drive/utilities/json-api';
+*
+* const options = findRecord('person', '1', { include: ['pets', 'friends'] });
+* const data = await store.request(options);
+* ```
+*
+* **With an Identifier**
+*
+* ```ts
+* import { findRecord } from '@warp-drive/utilities/json-api';
+*
+* 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 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/json-api';
+*
+* const options = findRecord('person', '1', { include: ['pets', 'friends'] }, { namespace: 'api/v2' });
+* const data = await store.request(options);
+* ```
+*
+* @public
+* @param identifier
+* @param options
+*/
+export type FindRecordResultDocument<T> = Omit<SingleResourceDataDocument<T>, "data"> & {
+	data: T;
 };
 export declare function findRecord<T>(identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>, options?: FindRecordOptions<T>): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
 export declare function findRecord(identifier: RemotelyAccessibleIdentifier, options?: FindRecordOptions): FindRecordRequestOptions;
 export declare function findRecord<T>(type: TypeFromInstance<T>, id: string, options?: FindRecordOptions<T>): FindRecordRequestOptions<FindRecordResultDocument<T>, T>;
 export declare function findRecord(type: string, id: string, options?: FindRecordOptions): FindRecordRequestOptions;
-//# sourceMappingURL=find-record.d.ts.map

package/declarations/-private/json-api/query.d.ts

@@ -1,104 +1,103 @@
-import type { QueryParamsSource } from '@warp-drive/core/types/params';
-import type { TypedRecordInstance, TypeFromInstance } from '@warp-drive/core/types/record';
-import type { ConstrainedRequestOptions, PostQueryRequestOptions, 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 { TypedRecordInstance, TypeFromInstance } from "@warp-drive/core/types/record";
+import type { ConstrainedRequestOptions, PostQueryRequestOptions, 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 JSON:API APIs.
- *
- * The key difference between this and `postQuery` is that this method will send the query
- * as query params in the url of a "GET" request instead of as the JSON body of a "POST"
- * request.
- *
- * **Basic Usage**
- *
- * ```ts
- * import { query } from '@warp-drive/utilities/json-api';
- *
- * const data = await store.request(query('person'));
- * ```
- *
- * **With Query Params**
- *
- * ```ts
- * import { query } from '@warp-drive/utilities/json-api';
- *
- * 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 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/json-api';
- *
- * 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 JSON:API APIs.
+*
+* The key difference between this and `postQuery` is that this method will send the query
+* as query params in the url of a "GET" request instead of as the JSON body of a "POST"
+* request.
+*
+* **Basic Usage**
+*
+* ```ts
+* import { query } from '@warp-drive/utilities/json-api';
+*
+* const data = await store.request(query('person'));
+* ```
+*
+* **With Query Params**
+*
+* ```ts
+* import { query } from '@warp-drive/utilities/json-api';
+*
+* 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 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/json-api';
+*
+* 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 extends TypedRecordInstance>(type: TypeFromInstance<T>, query?: QueryParamsSource<T>, options?: ConstrainedRequestOptions): QueryRequestOptions<CollectionResourceDataDocument<T>, T>;
 export declare function query(type: string, query?: QueryParamsSource, options?: ConstrainedRequestOptions): QueryRequestOptions;
 /**
- * Builds request options to query for resources, usually by a primary
- * type, configured for the url and header expectations of most JSON:API APIs.
- *
- * The key difference between this and `query` is that this method will send the query
- * as the JSON body of a "POST" request instead of as query params in the url of a "GET"
- * request.
- *
- * A CacheKey is generated from the url and query params, and used to cache the response
- * in the store.
- *
- * ```ts
- * import { postQuery } from '@warp-drive/utilities/json-api';
- *
- * const options = postQuery('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 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 { postQuery } from '@warp-drive/utilities/json-api';
- *
- * const options = postQuery('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 JSON:API APIs.
+*
+* The key difference between this and `query` is that this method will send the query
+* as the JSON body of a "POST" request instead of as query params in the url of a "GET"
+* request.
+*
+* A CacheKey is generated from the url and query params, and used to cache the response
+* in the store.
+*
+* ```ts
+* import { postQuery } from '@warp-drive/utilities/json-api';
+*
+* const options = postQuery('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 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 { postQuery } from '@warp-drive/utilities/json-api';
+*
+* const options = postQuery('person', { include: ['pets', 'friends'] }, { reload: true });
+* const data = await store.request(options);
+* ```
+*
+* @public
+* @param identifier
+* @param query
+* @param options
+*/
 export declare function postQuery<T>(type: TypeFromInstance<T>, query?: QueryParamsSource, options?: ConstrainedRequestOptions): PostQueryRequestOptions<CollectionResourceDataDocument<T>, T>;
 export declare function postQuery(type: string, query?: QueryParamsSource, options?: ConstrainedRequestOptions): PostQueryRequestOptions;
-//# sourceMappingURL=query.d.ts.map