@warp-drive/legacy 5.8.0-alpha.4 → 5.8.0-alpha.40

package/README.md

@@ -1,44 +1,31 @@
-<h1 align="center">
-  <img
-    class="project-logo"
-    src="./logos/github-header.svg#gh-light-mode-only"
-    alt="WarpDrive | Boldly go where no app has gone before"
-    title="WarpDrive | Boldly go where no app has gone before"
-    />
+<p align="center">
   <img
     class="project-logo"
-    src="./logos/github-header.svg#gh-dark-mode-only"
-    alt="WarpDrive | Boldly go where no app has gone before"
-    title="WarpDrive | Boldly go where no app has gone before"
+    src="./logos/logo-yellow-slab.svg"
+    alt="WarpDrive"
+    width="180px"
+    title="WarpDrive"
     />
-</h1>
+</p>
 
-![NPM Stable Version](https://img.shields.io/npm/v/ember-data/latest?label=version&style=flat&color=FFC474)
-![NPM Downloads](https://img.shields.io/npm/dm/ember-data.svg?style=flat&color=FFC474)
-![License](https://img.shields.io/github/license/emberjs/data.svg?style=flat&color=FFC474)
-[![Docs](./logos/docs-badge.svg)](https://docs.warp-drive.io)
-[![EmberJS Discord Community Server](https://img.shields.io/badge/EmberJS-grey?logo=discord&logoColor=FFC474)](https://discord.gg/zT3asNS
+![NPM Stable Version](https://img.shields.io/npm/v/ember-data/latest?label=version&style=flat&color=fdb155)
+![NPM Downloads](https://img.shields.io/npm/dm/ember-data.svg?style=flat&color=fdb155)
+![License](https://img.shields.io/github/license/warp-drive-data/warp-drive.svg?style=flat&color=fdb155)
+[![EmberJS Discord Community Server](https://img.shields.io/badge/EmberJS-grey?logo=discord&logoColor=fdb155)](https://discord.gg/zT3asNS
 )
-[![WarpDrive Discord Server](https://img.shields.io/badge/WarpDrive-grey?logo=discord&logoColor=FFC474)](https://discord.gg/n8BptgFzNt
+[![WarpDrive Discord Server](https://img.shields.io/badge/WarpDrive-grey?logo=discord&logoColor=fdb155)](https://discord.gg/PHBbnWJx5S
 )
 
+# @warp-drive/legacy
 
 <br>
 
 <p align="center">
-Decommissioned Packages for <em>Warp</em><strong>Drive</strong> that your App may want to continue using for a little while longer.
+Decommissioned Features from <em>Warp</em><strong>Drive</strong> that your App may want to continue using for a little while longer.
 </p>
 
 <br>
 
-## Installation
-
-```sh
-pnpm add -E @warp-drive/legacy
-```
-
-<br>
-
 ## Documentation
 
 *Get Started* → [Guides](https://docs.warp-drive.io)
@@ -48,7 +35,7 @@ pnpm add -E @warp-drive/legacy
 
 ## Code of Conduct
 
-Refer to the [Code of Conduct](https://github.com/emberjs/data/blob/main/CODE_OF_CONDUCT.md) for community guidelines and inclusivity.
+Refer to the [Code of Conduct](https://github.com/warp-drive-data/warp-drive/blob/main/CODE_OF_CONDUCT.md) for community guidelines and inclusivity.
 
 <br>
 

package/declarations/adapter/error.d.ts

@@ -42,8 +42,8 @@ rejects with a `InvalidError` object that looks like this:
 
 ```js [app/adapters/post.js]
 import RSVP from 'RSVP';
-import RESTAdapter from '@ember-data/adapter/rest';
-import { InvalidError } from '@ember-data/adapter/error';
+import RESTAdapter from '@warp-drive/legacy/adapter/rest';
+import { InvalidError } from '@warp-drive/legacy/adapter/error';
 
 export default class ApplicationAdapter extends RESTAdapter {
 updateRecord() {
@@ -82,7 +82,7 @@ An example use case would be to warn the user to check their internet
 connection if an adapter operation has timed out:
 
 ```js [app/routes/application.js]
-import { TimeoutError } from '@ember-data/adapter/error';
+import { TimeoutError } from '@warp-drive/legacy/adapter/error';
 
 export default class ApplicationRoute extends Route {
 @action
@@ -124,7 +124,7 @@ An example use case would be to redirect the user to a login route if a
 request is unauthorized:
 
 ```js [app/routes/application.js]
-import { UnauthorizedError } from '@ember-data/adapter/error';
+import { UnauthorizedError } from '@warp-drive/legacy/adapter/error';
 
 export default class ApplicationRoute extends Route {
 @action
@@ -166,7 +166,7 @@ An example use case would be to detect if the user has entered a route
 for a specific model that does not exist. For example:
 
 ```js [app/routes/post.js]
-import { NotFoundError } from '@ember-data/adapter/error';
+import { NotFoundError } from '@warp-drive/legacy/adapter/error';
 
 export default class PostRoute extends Route {
 @service store;

package/declarations/adapter/json-api.d.ts

@@ -8,13 +8,11 @@ import { RESTAdapter } from "./rest.js";
 /**
 ## Overview
 
-<blockquote style="margin: 1em; padding: .1em 1em .1em 1em; border-left: solid 1em #E34C32; background: #e0e0e0;">
-<p>
-⚠️ <strong>This is LEGACY documentation</strong> for a feature that is no longer encouraged to be used.
+:::danger
+⚠️ **This is LEGACY documentation** for a feature that is no longer encouraged to be used.
 If starting a new app or thinking of implementing a new adapter, consider writing a
-<a href="/ember-data/release/classes/%3CInterface%3E%20Handler">Handler</a> instead to be used with the <a href="https://github.com/warp-drive-data/warp-drive/tree/main/packages/request#readme">RequestManager</a>
-</p>
-</blockquote>
+{@link Handler} instead to be used with the {@link RequestManager}
+:::
 
 The `JSONAPIAdapter` is an adapter whichtransforms the store's
 requests into HTTP requests that follow the [JSON API format](http://jsonapi.org/format/).
@@ -120,7 +118,7 @@ Endpoint paths can be prefixed with a `namespace` by setting the
 namespace property on the adapter:
 
 ```js [app/adapters/application.js]
-import JSONAPIAdapter from '@ember-data/adapter/json-api';
+import JSONAPIAdapter from '@warp-drive/legacy/adapter/json-api';
 
 export default class ApplicationAdapter extends JSONAPIAdapter {
 namespace = 'api/1';
@@ -133,7 +131,7 @@ Requests for the `person` model would now target `/api/1/people/1`.
 An adapter can target other hosts by setting the `host` property.
 
 ```js [app/adapters/application.js]
-import JSONAPIAdapter from '@ember-data/adapter/json-api';
+import JSONAPIAdapter from '@warp-drive/legacy/adapter/json-api';
 
 export default class ApplicationAdapter extends JSONAPIAdapter {
 host = 'https://api.example.com';

package/declarations/adapter/rest.d.ts

@@ -31,13 +31,11 @@ export type RequestData = {
 };
 declare const AdapterWithBuildURLMixin: Readonly<typeof Adapter> & (new (owner?: Owner) => Adapter) & Mixin;
 /**
-* <blockquote style="margin: 1em; padding: .1em 1em .1em 1em; border-left: solid 1em #E34C32; background: #e0e0e0;">
-<p>
-⚠️ <strong>This is LEGACY documentation</strong> for a feature that is no longer encouraged to be used.
+* :::danger
+⚠️ **This is LEGACY documentation** for a feature that is no longer encouraged to be used.
 If starting a new app or thinking of implementing a new adapter, consider writing a
-<a href="/ember-data/release/classes/%3CInterface%3E%20Handler">Handler</a> instead to be used with the <a href="https://github.com/warp-drive-data/warp-drive/tree/main/packages/request#readme">RequestManager</a>
-</p>
-</blockquote>
+{@link Handler} instead to be used with the {@link RequestManager}
+:::
 
 The REST adapter allows your store to communicate with an HTTP server by
 transmitting JSON via XHR.
@@ -406,8 +404,7 @@ declare class RESTAdapter extends AdapterWithBuildURLMixin {
 	Some APIs require HTTP headers, e.g. to provide an API
 	key. Arbitrary headers can be set as key/value pairs on the
 	`RESTAdapter`'s `headers` object and Ember Data will send them
-	along with each ajax request. For dynamic headers see [headers
-	customization](/ember-data/release/classes/RESTAdapter).
+	along with each ajax request..
 	
 	```js [app/adapters/application.js]
 	import { RESTAdapter } from '@warp-drive/legacy/adapter/rest';

package/declarations/adapter.d.ts

@@ -1,13 +1,11 @@
 /**
 * ## Overview
 *
-* <blockquote style="margin: 1em; padding: .1em 1em .1em 1em; border-left: solid 1em #E34C32; background: #e0e0e0;">
-* <p>
-*   ⚠️ <strong>This is LEGACY documentation</strong> for a feature that is no longer encouraged to be used.
+* :::danger
+*   ⚠️ **This is LEGACY documentation** for a feature that is no longer encouraged to be used.
 *   If starting a new app or thinking of implementing a new adapter, consider writing a
-*   <a href="/ember-data/release/classes/%3CInterface%3E%20Handler">Handler</a> instead to be used with the <a href="https://github.com/warp-drive-data/warp-drive/tree/main/packages/request#readme">RequestManager</a>
-* </p>
-* </blockquote>
+*   {@link Handler} instead to be used with the {@link RequestManager}
+* ::::
 *
 * In order to properly fetch and update data, @warp-drive/legacy
 * needs to understand how to connect to your API.

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

@@ -2,7 +2,7 @@ import type { Store } from "@warp-drive/core";
 import type { CompatStore } from "../compat.js";
 /**
 * Utilities - often temporary - for maintaining backwards compatibility with
-* older parts of EmberData.
+* older parts of WarpDrive.
 *
 @module
 */

package/declarations/compat/builders/find-all.d.ts

@@ -19,16 +19,16 @@ This function builds a request config to perform a `findAll` request for the giv
 When passed to `store.request`, this config will result in the same behavior as a `store.findAll` request.
 Additionally, it takes the same options as `store.findAll`.
 
-All `@ember-data/legacy-compat` builders exist to enable you to migrate your codebase to using the correct syntax for `store.request` while temporarily preserving legacy behaviors.
+All `@warp-drive/legacy/compat` builders exist to enable you to migrate your codebase to using the correct syntax for `store.request` while temporarily preserving legacy behaviors.
 This is useful for quickly upgrading an entire app to a unified syntax while a longer incremental migration is made to shift off of adapters and serializers.
-To that end, these builders are deprecated and will be removed in a future version of Ember Data.
+To that end, these builders are deprecated and will be removed in a future version of WarpDrive.
 
 @deprecated
 @public
-@param {String} type the name of the resource
-@param {Object} query a query to be used by the adapter
-@param {FindAllBuilderOptions} [options] optional, may include `adapterOptions` hash which will be passed to adapter.findAll
-@return {FindAllRequestInput} request config
+@param type the name of the resource
+@param query a query to be used by the adapter
+@param options optional, may include `adapterOptions` hash which will be passed to adapter.findAll
+@return request config
 */
 export declare function findAllBuilder<T extends TypedRecordInstance>(type: TypeFromInstance<T>, options?: FindAllBuilderOptions): FindAllRequestInput<TypeFromInstance<T>, T[]>;
 export declare function findAllBuilder(type: string, options?: FindAllBuilderOptions): FindAllRequestInput;

package/declarations/compat/builders/find-record.d.ts

@@ -23,7 +23,7 @@ Additionally, it takes the same options as `store.findRecord`, with the exceptio
 **Example 1**
 
 ```ts
-import { findRecord } from '@ember-data/legacy-compat/builders';
+import { findRecord } from '@warp-drive/legacy/compat/builders';
 const { content: post } = await store.request<Post>(findRecord<Post>('post', '1'));
 ```
 
@@ -34,20 +34,20 @@ of `type` (modelName) and `id` as separate arguments. You may recognize this com
 the typical pairing from [JSON:API](https://jsonapi.org/format/#document-resource-object-identification)
 
 ```ts
-import { findRecord } from '@ember-data/legacy-compat/builders';
+import { findRecord } from '@warp-drive/legacy/compat/builders';
 const { content: post } = await store.request<Post>(findRecord<Post>({ type: 'post', id }));
 ```
 
-All `@ember-data/legacy-compat` builders exist to enable you to migrate your codebase to using the correct syntax for `store.request` while temporarily preserving legacy behaviors.
+All `@warp-drive/legacy/compat` builders exist to enable you to migrate your codebase to using the correct syntax for `store.request` while temporarily preserving legacy behaviors.
 This is useful for quickly upgrading an entire app to a unified syntax while a longer incremental migration is made to shift off of adapters and serializers.
-To that end, these builders are deprecated and will be removed in a future version of Ember Data.
+To that end, these builders are deprecated and will be removed in a future version of Warp Drive.
 
 @deprecated
 @public
-@param {string|object} resource - either a string representing the name of the resource or a ResourceIdentifier object containing both the type (a string) and the id (a string) for the record or an lid (a string) of an existing record
-@param {string|number|object} id - optional object with options for the request only if the first param is a ResourceIdentifier, else the string id of the record to be retrieved
-@param {FindRecordBuilderOptions} [options] - if the first param is a string this will be the optional options for the request. See examples for available options.
-@return {FindRecordRequestInput} request config
+@param resource - either a string representing the name of the resource or a ResourceIdentifier object containing both the type (a string) and the id (a string) for the record or an lid (a string) of an existing record
+@param id - optional object with options for the request only if the first param is a ResourceIdentifier, else the string id of the record to be retrieved
+@param options - if the first param is a string this will be the optional options for the request. See examples for available options.
+@return request config
 */
 export declare function findRecordBuilder<T extends TypedRecordInstance>(type: TypeFromInstance<T>, id: string, options?: FindRecordBuilderOptions): FindRecordRequestInput<TypeFromInstance<T>, T>;
 export declare function findRecordBuilder(type: string, id: string, options?: FindRecordBuilderOptions): FindRecordRequestInput;

package/declarations/compat/builders/query.d.ts

@@ -20,16 +20,16 @@ This function builds a request config for a given type and query object.
 When passed to `store.request`, this config will result in the same behavior as a `store.query` request.
 Additionally, it takes the same options as `store.query`.
 
-All `@ember-data/legacy-compat` builders exist to enable you to migrate your codebase to using the correct syntax for `store.request` while temporarily preserving legacy behaviors.
+All `@warp-drive/legacy/compat` builders exist to enable you to migrate your codebase to using the correct syntax for `store.request` while temporarily preserving legacy behaviors.
 This is useful for quickly upgrading an entire app to a unified syntax while a longer incremental migration is made to shift off of adapters and serializers.
-To that end, these builders are deprecated and will be removed in a future version of Ember Data.
+To that end, these builders are deprecated and will be removed in a future version of WarpDrive.
 
 @deprecated
 @public
-@param {String} type the name of the resource
-@param {Object} query a query to be used by the adapter
-@param {QueryBuilderOptions} [options] optional, may include `adapterOptions` hash which will be passed to adapter.query
-@return {QueryRequestInput} request config
+@param type the name of the resource
+@param query a query to be used by the adapter
+@param options optional, may include `adapterOptions` hash which will be passed to adapter.query
+@return request config
 */
 export declare function queryBuilder<T extends TypedRecordInstance>(type: TypeFromInstance<T>, query: LegacyResourceQuery, options?: QueryBuilderOptions): QueryRequestInput<TypeFromInstance<T>, T[]>;
 export declare function queryBuilder(type: string, query: LegacyResourceQuery, options?: QueryBuilderOptions): QueryRequestInput;
@@ -50,16 +50,16 @@ This function builds a request config for a given type and query object.
 When passed to `store.request`, this config will result in the same behavior as a `store.queryRecord` request.
 Additionally, it takes the same options as `store.queryRecord`.
 
-All `@ember-data/legacy-compat` builders exist to enable you to migrate your codebase to using the correct syntax for `store.request` while temporarily preserving legacy behaviors.
+All `@warp-drive/legacy/compat` builders exist to enable you to migrate your codebase to using the correct syntax for `store.request` while temporarily preserving legacy behaviors.
 This is useful for quickly upgrading an entire app to a unified syntax while a longer incremental migration is made to shift off of adapters and serializers.
-To that end, these builders are deprecated and will be removed in a future version of Ember Data.
+To that end, these builders are deprecated and will be removed in a future version of WarpDrive.
 
 @deprecated
 @public
-@param {String} type the name of the resource
-@param {Object} query a query to be used by the adapter
-@param {QueryBuilderOptions} [options] optional, may include `adapterOptions` hash which will be passed to adapter.query
-@return {QueryRecordRequestInput} request config
+@param type the name of the resource
+@param query a query to be used by the adapter
+@param options optional, may include `adapterOptions` hash which will be passed to adapter.query
+@return request config
 */
 export declare function queryRecordBuilder<T extends TypedRecordInstance>(type: TypeFromInstance<T>, query: LegacyResourceQuery, options?: QueryBuilderOptions): QueryRecordRequestInput<TypeFromInstance<T>, T | null>;
 export declare function queryRecordBuilder(type: string, query: LegacyResourceQuery, options?: QueryBuilderOptions): QueryRecordRequestInput;

package/declarations/compat/extensions.d.ts

@@ -1,5 +1,5 @@
 import { type default as EmberObject } from "@ember/object";
-import type { CAUTION_MEGA_DANGER_ZONE_Extension } from "@warp-drive/core/reactive/-private/schema";
+import type { CAUTION_MEGA_DANGER_ZONE_Extension } from "@warp-drive/core/reactive";
 declare const EmberObjectMethods: readonly ["addObserver", "cacheFor", "decrementProperty", "get", "getProperties", "incrementProperty", "notifyPropertyChange", "removeObserver", "set", "setProperties", "toggleProperty"];
 export declare const EmberObjectArrayExtension: CAUTION_MEGA_DANGER_ZONE_Extension;
 export declare const EmberObjectExtension: CAUTION_MEGA_DANGER_ZONE_Extension;

package/declarations/compat/legacy-network-handler/minimum-adapter-interface.d.ts

@@ -7,13 +7,11 @@ import type { SnapshotRecordArray } from "./snapshot-record-array.js";
 type Group = Snapshot[];
 export type AdapterPayload = Record<string, unknown> | unknown[];
 /**
-* <blockquote style="margin: 1em; padding: .1em 1em .1em 1em; border-left: solid 1em #E34C32; background: #e0e0e0;">
-<p>
-⚠️ <strong>This is LEGACY documentation</strong> for a feature that is no longer encouraged to be used.
+* :::danger
+⚠️ **This is LEGACY documentation** for a feature that is no longer encouraged to be used.
 If starting a new app or thinking of implementing a new adapter, consider writing a
-<a href="/ember-data/release/classes/%3CInterface%3E%20Handler">Handler</a> instead to be used with the <a href="https://github.com/warp-drive-data/warp-drive/tree/main/packages/request#readme">RequestManager</a>
-</p>
-</blockquote>
+{@link Handler} instead to be used with the {@link RequestManager}
+:::
 
 The following documentation describes the methods an
 adapter should implement with descriptions around when an
@@ -170,7 +168,7 @@ export interface MinimumAdapterInterface {
 	* let error = new Error(errorMessage);
 	*
 	* // these two properties combined
-	* // alert EmberData to this error being for
+	* // alert WarpDrive to this error being for
 	* // invalid properties on the record during
 	* // the request
 	* error.isAdapterError = true;
@@ -221,7 +219,7 @@ export interface MinimumAdapterInterface {
 	* let error = new Error(errorMessage);
 	*
 	* // these two properties combined
-	* // alert EmberData to this error being for
+	* // alert WarpDrive to this error being for
 	* // invalid properties on the record during
 	* // the request
 	* error.isAdapterError = true;
@@ -404,7 +402,7 @@ export interface MinimumAdapterInterface {
 	*
 	* A group is an array of snapshots meant to be fetched together by a single `findMany` request.
 	*
-	* By default if this method is not implemented EmberData will call `findMany` once with all
+	* By default if this method is not implemented WarpDrive will call `findMany` once with all
 	* requested records as a single group when `coalesceFindRequests` is `true`.
 	*
 	* See also `findMany` and `coalesceFindRequests`

package/declarations/compat/legacy-network-handler/minimum-serializer-interface.d.ts

@@ -9,13 +9,11 @@ export type SerializerOptions = {
 };
 export type RequestType = "findRecord" | "queryRecord" | "findAll" | "findBelongsTo" | "findHasMany" | "findMany" | "query" | "createRecord" | "deleteRecord" | "updateRecord";
 /**
-* <blockquote style="margin: 1em; padding: .1em 1em .1em 1em; border-left: solid 1em #E34C32; background: #e0e0e0;">
-<p>
-⚠️ <strong>This is LEGACY documentation</strong> for a feature that is no longer encouraged to be used.
+* :::danger
+⚠️ **This is LEGACY documentation** for a feature that is no longer encouraged to be used.
 If starting a new app or thinking of implementing a new adapter, consider writing a
-<a href="/ember-data/release/classes/%3CInterface%3E%20Handler">Handler</a> instead to be used with the <a href="https://github.com/warp-drive-data/warp-drive/tree/main/packages/request#readme">RequestManager</a>
-</p>
-</blockquote>
+{@link Handler} instead to be used with the {@link RequestManager}
+:::
 
 The following documentation describes the methods an application
 serializer should implement with descriptions around when an
@@ -23,7 +21,6 @@ application might expect these methods to be called.
 
 Methods that are not required are marked as **optional**.
 
-@class (Interface) Serializer
 @public
 */
 export interface MinimumSerializerInterface {
@@ -43,23 +40,22 @@ export interface MinimumSerializerInterface {
 	*    and [Resource Identifier Objects](https://jsonapi.org/format/#document-resource-identifier-objects)
 	*
 	* @public
-	* @param {Store} store The store service that initiated the request being normalized
-	* @param {ModelSchema} schema An object with methods for accessing information about
+	* @param store The store service that initiated the request being normalized
+	* @param schema An object with methods for accessing information about
 	*  the type, attributes and relationships of the primary type associated with the request.
-	* @param {JSONObject} rawPayload The raw JSON response data returned from an API request.
+	* @param rawPayload The raw JSON response data returned from an API request.
 	*  This correlates to the value the promise returned by the adapter method that performed
 	*  the request resolved to.
-	* @param {string|null} id For a findRecord request, this is the id initially provided
+	* @param id For a findRecord request, this is the id initially provided
 	*  in the call to store.findRecord. Else this value is null.
-	* @param {'findRecord' | 'queryRecord' | 'findAll' | 'findBelongsTo' | 'findHasMany' | 'findMany' | 'query' | 'createRecord' | 'deleteRecord' | 'updateRecord'} requestType The
-	*  type of request the Adapter had been asked to perform.
+	* @param requestType The type of request the Adapter had been asked to perform.
 	*
-	* @return {JsonApiDocument} a document following the structure of a JSON:API Document.
+	* @return a document following the structure of a [{json:api} Document](https://jsonapi.org/format/#document-structure).
 	*/
 	normalizeResponse(store: Store, schema: ModelSchema, rawPayload: AdapterPayload, id: string | null, requestType: "findRecord" | "queryRecord" | "findAll" | "findBelongsTo" | "findHasMany" | "findMany" | "query" | "createRecord" | "deleteRecord" | "updateRecord"): JsonApiDocument;
 	/**
 	* This method is responsible for serializing an individual record
-	* via a [Snapshot](Snapshot) into the format expected by the API.
+	* via a {@link Snapshot} into the format expected by the API.
 	*
 	* This method is called by `snapshot.serialize()`.
 	*
@@ -70,8 +66,7 @@ export interface MinimumSerializerInterface {
 	* is not implemented.
 	*
 	* @public
-	* @param {Snapshot} snapshot A Snapshot for the record to serialize
-	* @param {Object} [options]
+	* @param snapshot A Snapshot for the record to serialize
 	*/
 	serialize(snapshot: Snapshot, options?: SerializerOptions): ObjectValue;
 	/**
@@ -118,14 +113,12 @@ export interface MinimumSerializerInterface {
 	*
 	* @public
 	* @optional
-	* @param {ModelSchema} schema An object with methods for accessing information about
+	* @param schema An object with methods for accessing information about
 	*  the type, attributes and relationships of the primary type associated with the request.
-	* @param {JSONObject} rawPayload Some raw JSON data to be normalized into a JSON:API Resource.
-	* @param {String} [prop] When called by the EmbeddedRecordsMixin this param will be the
+	* @param rawPayload Some raw JSON data to be normalized into a JSON:API Resource.
+	* @param prop When called by the EmbeddedRecordsMixin this param will be the
 	*  property at which the object provided as rawPayload was found.
-	* @return {SingleResourceDocument} A JSON:API Document
-	*  containing a single JSON:API Resource
-	*  as its primary data.
+	* @return A JSON:API Document containing a single JSON:API Resource as its primary data.
 	*/
 	normalize?(schema: ModelSchema, rawPayload: ObjectValue, prop?: string): SingleResourceDocument;
 	/**
@@ -161,11 +154,9 @@ export interface MinimumSerializerInterface {
 	* @optional
 	* @param hash A top most object of the request payload onto
 	*  which to append the serialized record
-	* @param {ModelSchema} schema An object with methods for accessing information about
+	* @param schema An object with methods for accessing information about
 	*  the type, attributes and relationships of the primary type associated with the request.
-	* @param {Snapshot} snapshot A Snapshot for the record to serialize
-	* @param [options]
-	* @return {void}
+	* @param snapshot A Snapshot for the record to serialize
 	*/
 	serializeIntoHash?(hash: object, schema: ModelSchema, snapshot: Snapshot, options?: SerializerOptions): void;
 	/**
@@ -204,10 +195,9 @@ export interface MinimumSerializerInterface {
 	*
 	* @public
 	* @optional
-	* @param {Store} store The store service that initiated the request being normalized
-	* @param {Object} rawPayload The raw JSON response data returned from an API request.
+	* @param store The store service that initiated the request being normalized
+	* @param rawPayload The raw JSON response data returned from an API request.
 	*  This JSON should be in the API format expected by the serializer.
-	* @return {void}
 	*/
 	pushPayload?(store: Store, rawPayload: ObjectValue): void;
 	/**

package/declarations/compat/utils.d.ts

@@ -4,7 +4,7 @@ type Reporter = (type: "formatted-id" | "formatted-type", actual: unknown, expec
 * changes during normalization. This is useful for instrumenting
 * to discover places where usage in the app is not consistent.
 *
-* @param method a function which takes a mismatch-type ('formatted-id' | 'formatted-type'), actual, and expected value
+* @param fn - a function which takes a mismatch-type ('formatted-id' | 'formatted-type'), actual, and expected value
 * @public
 */
 export declare function configureMismatchReporter(fn: Reporter): void;
@@ -13,7 +13,7 @@ export declare function configureMismatchReporter(fn: Reporter): void;
 * fails validation. This is useful for instrumenting
 * to discover places where usage in the app is not consistent.
 *
-* @param method a function which takes a message and a condition
+* @param fn - a function which takes a message and a condition
 * @public
 */
 export declare function configureAssertFn(fn: (message: string, condition: unknown) => void): void;
@@ -27,13 +27,13 @@ export declare function configureAssertFn(fn: (message: string, condition: unkno
 * the configured mismatch reporter and assert functions will
 * be called.
 *
-* @param method a function which takes a string and returns a string
+* @param fn - a function which takes a string and returns a string
 * @public
 */
 export declare function configureTypeNormalization(fn: (type: string) => string): void;
 /**
 * Converts a potentially unnormalized type into the format expected
-* by our EmberData Cache. Currently this is singular-dasherized.
+* by our WarpDrive Cache. Currently this is singular-dasherized.
 *
 * you should not rely on this function to give you an exact format
 * for display purposes. Formatting for display should be handled
@@ -56,13 +56,13 @@ export declare function configureTypeNormalization(fn: (type: string) => string)
 * formattedType('PostComment'); // => 'post-comment'
 * ```
 *
-* @param {String} type the potentially un-normalized type
-* @return {String} the normalized type
+* @param type the potentially un-normalized type
+* @return the normalized type
 * @public
 */
 export declare function formattedType<T extends string>(type: T | string): T;
 /**
-* Format an id to the format expected by the EmberData Cache.
+* Format an id to the format expected by the WarpDrive Cache.
 * Currently this means that id should be `string | null`.
 *
 * Asserts invalid IDs (undefined, '', 0, '0') in dev.
@@ -77,8 +77,8 @@ export declare function formattedType<T extends string>(type: T | string): T;
 * formattedId(null); // => null
 *	```
 *
-* @param {String | Number | null} id the potentially un-normalized id
-* @return {String | null} the normalized id
+* @param id the potentially un-normalized id
+* @return the normalized id
 * @public
 */
 export declare function formattedId(id: string | number): string;
@@ -88,7 +88,7 @@ export declare function expectId(id: string | number): string;
 export declare function expectId(id: null): never;
 /**
 * Compares two types for strict equality, converting them to
-* the format expected by the EmberData Cache to ensure
+* the format expected by the WarpDrive Cache to ensure
 * differences in format are accounted for in the comparison.
 *
 * Asserts when expected or actual are invalid types in dev.
@@ -106,15 +106,15 @@ export declare function expectId(id: null): never;
 * isEquivType('posts', null); // false
 * ```
 *
-* @param {String} expected a potentially unnormalized type to match against
-* @param {String} actual a potentially unnormalized type to match against
-* @return {Boolean} true if the types are equivalent
+* @param expected a potentially unnormalized type to match against
+* @param actual a potentially unnormalized type to match against
+* @return true if the types are equivalent
 * @public
 */
 export declare function isEquivType(expected: string, actual: string): boolean;
 /**
 * Compares two IDs for strict equality, converting them to
-* the format expected by the EmberData Cache to ensure
+* the format expected by the WarpDrive Cache to ensure
 * differences in format are accounted for in the comparison.
 *
 * Asserts when expected or actual are invalid IDs in dev.
@@ -128,9 +128,9 @@ export declare function isEquivType(expected: string, actual: string): boolean;
 * isEquivId(1, null); // false
 * ```
 *
-* @param {string | number} expected a potentially un-normalized id to match against
-* @param {string | number} actual a potentially un-normalized id to match against
-* @return {Boolean} true if the ids are equivalent
+* @param expected a potentially un-normalized id to match against
+* @param actual a potentially un-normalized id to match against
+* @return true if the ids are equivalent
 * @public
 */
 export declare function isEquivId(expected: string | number, actual: string | number | null): boolean;