@ember-data-types/rest 5.6.0-beta.0 → 5.6.0-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ember-data-types/rest",
-  "version": "5.6.0-beta.0",
+  "version": "5.6.0-beta.2",
   "files": [
     "unstable-preview-types",
     "README.md",

package/unstable-preview-types/index.d.ts

@@ -1,5 +1 @@
-/// <reference path="./request.d.ts" />
-/// <reference path="./-private/builders/query.d.ts" />
-/// <reference path="./-private/builders/save-record.d.ts" />
-/// <reference path="./-private/builders/-utils.d.ts" />
-/// <reference path="./-private/builders/find-record.d.ts" />
+/// <reference path="./request.d.ts" />

package/unstable-preview-types/request.d.ts

@@ -1,13 +1,13 @@
 declare module '@ember-data/rest/request' {
   /**
-   * <p align="center">
-    <img
-      class="project-logo"
-      src="https://raw.githubusercontent.com/emberjs/data/4612c9354e4c54d53327ec2cf21955075ce21294/ember-data-logo-light.svg#gh-light-mode-only"
-      alt="EmberData"
-      width="240px"
-      title="EmberData"
-    />
+  * <p align="center">
+  <img
+  class="project-logo"
+  src="https://raw.githubusercontent.com/emberjs/data/4612c9354e4c54d53327ec2cf21955075ce21294/ember-data-logo-light.svg#gh-light-mode-only"
+  alt="EmberData"
+  width="240px"
+  title="EmberData"
+  />
   </p>
   
   This package provides utilities for working with **REST**ful APIs with [*Ember***Data**](https://github.com/emberjs/data/).
@@ -33,13 +33,13 @@ declare module '@ember-data/rest/request' {
   const options = findRecord('ember-developer', '1', { include: ['pets', 'friends'] });
   
   /*
-    => {
-      url: 'https://api.example.com/v1/emberDevelopers/1?include=friends,pets',
-      method: 'GET',
-      headers: <Headers>, // 'Content-Type': 'application/json;charset=utf-8'
-      op: 'findRecord';
-      records: [{ type: 'ember-developer', id: '1' }]
-    }
+  => {
+  url: 'https://api.example.com/v1/emberDevelopers/1?include=friends,pets',
+  method: 'GET',
+  headers: <Headers>, // 'Content-Type': 'application/json;charset=utf-8'
+  op: 'findRecord';
+  records: [{ type: 'ember-developer', id: '1' }]
+  }
   * /
   ```
   
@@ -61,12 +61,9 @@ declare module '@ember-data/rest/request' {
   - [query](https://api.emberjs.com/ember-data/release/functions/@ember-data%2Frest/query)
   - [updateRecord](https://api.emberjs.com/ember-data/release/functions/@ember-data%2Frest/updateRecord)
   
-   * @module @ember-data/rest/request
-   * @main @ember-data/rest/request
-   * @public
-   */
-  export { findRecord } from '@ember-data/rest/-private/builders/find-record';
-  export { query } from '@ember-data/rest/-private/builders/query';
-  export { deleteRecord, createRecord, updateRecord } from '@ember-data/rest/-private/builders/save-record';
-}
-//# sourceMappingURL=request.d.ts.map
+  * @module
+  * @public
+  */
+  export { findRecord, query, deleteRecord, createRecord, updateRecord } from "@warp-drive/utilities/rest";
+  
+}

package/unstable-preview-types/-private/builders/-utils.d.ts

@@ -1,7 +0,0 @@
-declare module '@ember-data/rest/-private/builders/-utils' {
-  import type { UrlOptions } from '@ember-data/request-utils';
-  import type { CacheOptions, ConstrainedRequestOptions } from '@warp-drive/core-types/request';
-  export function copyForwardUrlOptions(urlOptions: UrlOptions, options: ConstrainedRequestOptions): void;
-  export function extractCacheOptions(options: ConstrainedRequestOptions): CacheOptions;
-}
-//# sourceMappingURL=-utils.d.ts.map

package/unstable-preview-types/-private/builders/-utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"-utils.d.ts","sourceRoot":"","sources":["../../../src/-private/builders/-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAE9F,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,yBAAyB,GAAG,IAAI,CAUtG;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,yBAAyB,GAAG,YAAY,CASpF"}

package/unstable-preview-types/-private/builders/find-record.d.ts

@@ -1,71 +0,0 @@
-declare module '@ember-data/rest/-private/builders/find-record' {
-  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 REST APIs.
-   *
-   * **Basic Usage**
-   *
-   * ```ts
-   * import { findRecord } from '@ember-data/rest/request';
-   *
-   * const data = await store.request(findRecord('person', '1'));
-   * ```
-   *
-   * **With Options**
-   *
-   * ```ts
-   * import { findRecord } from '@ember-data/rest/request';
-   *
-   * const options = findRecord('person', '1', { include: ['pets', 'friends'] });
-   * const data = await store.request(options);
-   * ```
-   *
-   * **With an Identifier**
-   *
-   * ```ts
-   * import { findRecord } from '@ember-data/rest/request';
-   *
-   * 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 '@ember-data/rest/request';
-   *
-   * const options = findRecord('person', '1', { include: ['pets', 'friends'] }, { namespace: 'api/v2' });
-   * const data = await store.request(options);
-   * ```
-   *
-   * @method findRecord
-   * @public
-   * @static
-   * @for @ember-data/rest/request
-   * @param identifier
-   * @param options
-   */
-  export type FindRecordResultDocument<T> = Omit<SingleResourceDataDocument<T>, 'data'> & {
-      data: T;
-  };
-  export function findRecord<T>(identifier: RemotelyAccessibleIdentifier<TypeFromInstance<T>>, options?: FindRecordOptions<T>): FindRecordRequestOptions<T, FindRecordResultDocument<T>>;
-  export function findRecord(identifier: RemotelyAccessibleIdentifier, options?: FindRecordOptions): FindRecordRequestOptions;
-  export function findRecord<T>(type: TypeFromInstance<T>, id: string, options?: FindRecordOptions<T>): FindRecordRequestOptions<T, FindRecordResultDocument<T>>;
-  export function findRecord(type: string, id: string, options?: FindRecordOptions): FindRecordRequestOptions;
-}
-//# sourceMappingURL=find-record.d.ts.map

package/unstable-preview-types/-private/builders/find-record.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"find-record.d.ts","sourceRoot":"","sources":["../../../src/-private/builders/find-record.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,KAAK,EACV,iBAAiB,EACjB,wBAAwB,EACxB,4BAA4B,EAC7B,MAAM,gCAAgC,CAAC;AACxC,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,sCAAsC,CAAC;AAIvF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI,IAAI,CAAC,0BAA0B,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,CAAC;AAEpG,wBAAgB,UAAU,CAAC,CAAC,EAC1B,UAAU,EAAE,4BAA4B,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAC7D,OAAO,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC7B,wBAAwB,CAAC,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5D,wBAAgB,UAAU,CACxB,UAAU,EAAE,4BAA4B,EACxC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,wBAAwB,CAAC;AAC5B,wBAAgB,UAAU,CAAC,CAAC,EAC1B,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,EACzB,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC7B,wBAAwB,CAAC,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5D,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,wBAAwB,CAAC"}

package/unstable-preview-types/-private/builders/query.d.ts

@@ -1,59 +0,0 @@
-declare module '@ember-data/rest/-private/builders/query' {
-  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 '@ember-data/rest/request';
-   *
-   * const data = await store.request(query('person'));
-   * ```
-   *
-   * **With Query Params**
-   *
-   * ```ts
-   * import { query } from '@ember-data/rest/request';
-   *
-   * 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 '@ember-data/rest/request';
-   *
-   * const options = query('person', { include: ['pets', 'friends'] }, { reload: true });
-   * const data = await store.request(options);
-   * ```
-   *
-   * @method query
-   * @public
-   * @static
-   * @for @ember-data/rest/request
-   * @param identifier
-   * @param query
-   * @param options
-   */
-  export function query<T>(type: TypeFromInstance<T>, query?: QueryParamsSource, options?: ConstrainedRequestOptions): QueryRequestOptions<T, CollectionResourceDataDocument<T>>;
-  export function query(type: string, query?: QueryParamsSource, options?: ConstrainedRequestOptions): QueryRequestOptions;
-}
-//# sourceMappingURL=query.d.ts.map

package/unstable-preview-types/-private/builders/query.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../../src/-private/builders/query.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,KAAK,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrG,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,sCAAsC,CAAC;AAI3F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,wBAAgB,KAAK,CAAC,CAAC,EACrB,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,EACzB,KAAK,CAAC,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,yBAAyB,GAClC,mBAAmB,CAAC,CAAC,EAAE,8BAA8B,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7D,wBAAgB,KAAK,CACnB,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,yBAAyB,GAClC,mBAAmB,CAAC"}

package/unstable-preview-types/-private/builders/save-record.d.ts

@@ -1,153 +0,0 @@
-declare module '@ember-data/rest/-private/builders/save-record' {
-  import type { ConstrainedRequestOptions, CreateRequestOptions, DeleteRequestOptions, UpdateRequestOptions } from '@warp-drive/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 '@ember-data/rest/request';
-   *
-   * 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 '@ember-data/rest/request';
-   *
-   * 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);
-   * ```
-   *
-   * @method deleteRecord
-   * @public
-   * @static
-   * @for @ember-data/rest/request
-   * @param record
-   * @param options
-   */
-  export function deleteRecord<T>(record: T, options?: ConstrainedRequestOptions): DeleteRequestOptions<T>;
-  export 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 '@ember-data/rest/request';
-   *
-   * 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 '@ember-data/rest/request';
-   *
-   * const person = store.createRecord('person', { name: 'Ted' });
-   * const options = createRecord(person, { namespace: 'api/v1' });
-   * const data = await store.request(options);
-   * ```
-   *
-   * @method createRecord
-   * @public
-   * @static
-   * @for @ember-data/rest/request
-   * @param record
-   * @param options
-   */
-  export function createRecord<T>(record: T, options?: ConstrainedRequestOptions): CreateRequestOptions<T>;
-  export 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 '@ember-data/rest/request';
-   *
-   * 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 '@ember-data/rest/request';
-   *
-   * const person = store.peekRecord('person', '1');
-   * person.name = 'Chris';
-   * const options = updateRecord(person, { patch: true });
-   * const data = await store.request(options);
-   * ```
-   *
-   * @method updateRecord
-   * @public
-   * @static
-   * @for @ember-data/rest/request
-   * @param record
-   * @param options
-   */
-  export function updateRecord<T>(record: T, options?: ConstrainedRequestOptions & {
-      patch?: boolean;
-  }): UpdateRequestOptions<T>;
-  export function updateRecord(record: unknown, options?: ConstrainedRequestOptions & {
-      patch?: boolean;
-  }): UpdateRequestOptions;
-}
-//# sourceMappingURL=save-record.d.ts.map

package/unstable-preview-types/-private/builders/save-record.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"save-record.d.ts","sourceRoot":"","sources":["../../../src/-private/builders/save-record.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EACV,yBAAyB,EACzB,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,gCAAgC,CAAC;AAQxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,MAAM,EAAE,CAAC,EACT,OAAO,CAAC,EAAE,yBAAyB,GAAG;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GACxD,oBAAoB,CAAC,CAAC,CAAC,CAAC;AAC3B,wBAAgB,YAAY,CAC1B,MAAM,EAAE,OAAO,EACf,OAAO,CAAC,EAAE,yBAAyB,GAAG;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GACxD,oBAAoB,CAAC"}

package/unstable-preview-types/request.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../src/request.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC"}