@warp-drive/legacy 5.8.0-beta.0 → 5.8.0-beta.2

package/dist/compat/builders.js

@@ -9,16 +9,16 @@ import { storeFor, recordIdentifierFor } from '@warp-drive/core';
   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
 */
 function findAllBuilder(type, options = {}) {
   macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
@@ -51,7 +51,7 @@ function findAllBuilder(type, options = {}) {
   **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'));
   ```
 
@@ -62,20 +62,20 @@ function findAllBuilder(type, options = {}) {
   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
 */
 function findRecordBuilder(resource, idOrOptions, options) {
   macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
@@ -118,16 +118,16 @@ function findRecordBuilder(resource, idOrOptions, options) {
   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
 */
 function queryBuilder(type, query, options = {}) {
   macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
@@ -163,16 +163,16 @@ function queryBuilder(type, query, options = {}) {
   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
 */
 
 function queryRecordBuilder(type, query, options) {

package/dist/compat/utils.js

@@ -6,7 +6,6 @@ import { macroCondition, getGlobalConfig } from '@embroider/macros';
   and more consistent use of IDs and types.
 
   @module
-  @deprecated
 */
 
 let MismatchReporter = function () {};
@@ -33,7 +32,7 @@ let NormalizedType = str => {
  * 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
  */
 function configureMismatchReporter(fn) {
@@ -45,7 +44,7 @@ function configureMismatchReporter(fn) {
  * 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
  */
 function configureAssertFn(fn) {
@@ -62,7 +61,7 @@ function configureAssertFn(fn) {
  * 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
  */
 function configureTypeNormalization(fn) {
@@ -72,7 +71,7 @@ const NORMALIZED_TYPES = new Map();
 
 /**
  * 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
@@ -95,8 +94,8 @@ const NORMALIZED_TYPES = new Map();
  * 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
  */
 function formattedType(type) {
@@ -116,7 +115,7 @@ function formattedType(type) {
 }
 
 /**
- * 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.
@@ -131,8 +130,8 @@ function formattedType(type) {
  * 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
  */
 
@@ -154,7 +153,7 @@ function expectId(id) {
 
 /**
  * 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.
@@ -172,9 +171,9 @@ function expectId(id) {
  * 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
  */
 function isEquivType(expected, actual) {
@@ -191,7 +190,7 @@ function isEquivType(expected, actual) {
 
 /**
  * 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.
@@ -205,9 +204,9 @@ function isEquivType(expected, actual) {
  * 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
  */
 function isEquivId(expected, actual) {

package/dist/compat.js

@@ -1,9 +1,10 @@
 import { getOwner } from '@ember/application';
 import { recordIdentifierFor } from '@warp-drive/core';
-import { assertPrivateStore, waitFor, _deprecatingNormalize } from '@warp-drive/core/store/-private';
+import { assertPrivateStore, _deprecatingNormalize } from '@warp-drive/core/store/-private';
 import '@warp-drive/core/reactive/-private';
-import { p as payloadIsNotBlank, n as normalizeResponseHelper, i as iterateData, F as FetchManager, S as SaveOp, a as assertIdentifierHasId, b as SnapshotRecordArray } from "./-private-8UmnAf9J.js";
+import { p as payloadIsNotBlank, n as normalizeResponseHelper, i as iterateData, F as FetchManager, S as SaveOp, a as assertIdentifierHasId, b as SnapshotRecordArray } from "./-private-BG3bMiKp.js";
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
+import { waitFor } from '@warp-drive/core/signals/-leaked';
 function _findHasMany(adapter, store, identifier, link, relationship, options) {
   const promise = Promise.resolve().then(() => {
     const snapshot = store._fetchManager.createSnapshot(identifier, options);
@@ -162,7 +163,7 @@ function ensureRelationshipIsSetToParent(payload, parentIdentifier, store, paren
         const other = data ? `<${data.type}:${data.id}>` : null;
         const relationshipFetched = `${expectedModel}.${parentRelationship.kind}("${parentRelationship.name}")`;
         const includedRecord = `<${type}:${id}>`;
-        const message = [`Encountered mismatched relationship: Ember Data expected ${path} in the payload from ${relationshipFetched} to include ${expected} but got ${got} instead.\n`, `The ${includedRecord} record loaded at ${prefix} in the payload specified ${other} as its ${quotedInverse}, but should have specified ${expectedModel} (the record the relationship is being loaded from) as its ${quotedInverse} instead.`, `This could mean that the response for ${relationshipFetched} may have accidentally returned ${quotedType} records that aren't related to ${expectedModel} and could be related to a different ${parentIdentifier.type} record instead.`, `Ember Data has corrected the ${includedRecord} record's ${quotedInverse} relationship to ${expectedModel} so that ${relationshipFetched} will include ${includedRecord}.`, `Please update the response from the server or change your serializer to either ensure that the response for only includes ${quotedType} records that specify ${expectedModel} as their ${quotedInverse}, or omit the ${quotedInverse} relationship from the response.`].join('\n');
+        const message = [`Encountered mismatched relationship: WarpDrive expected ${path} in the payload from ${relationshipFetched} to include ${expected} but got ${got} instead.\n`, `The ${includedRecord} record loaded at ${prefix} in the payload specified ${other} as its ${quotedInverse}, but should have specified ${expectedModel} (the record the relationship is being loaded from) as its ${quotedInverse} instead.`, `This could mean that the response for ${relationshipFetched} may have accidentally returned ${quotedType} records that aren't related to ${expectedModel} and could be related to a different ${parentIdentifier.type} record instead.`, `WarpDrive has corrected the ${includedRecord} record's ${quotedInverse} relationship to ${expectedModel} so that ${relationshipFetched} will include ${includedRecord}.`, `Please update the response from the server or change your serializer to either ensure that the response for only includes ${quotedType} records that specify ${expectedModel} as their ${quotedInverse}, or omit the ${quotedInverse} relationship from the response.`].join('\n');
         macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
           {
             throw new Error(message);
@@ -737,18 +738,30 @@ function queryRecord(context) {
 }
 
 /**
-    Returns an instance of the adapter for a given type. For
-    example, `adapterFor('person')` will return an instance of
-    the adapter located at `app/adapters/person.js`
+ * Extends the signature of {@link Store} with additional
+ * methods available when using the legacy network layer.
+ *
+ * @public
+ * @noInheritDoc
+ * @legacy
+ */
 
-    If no `person` adapter is found, this method will look
-    for an `application` adapter (the default adapter for
-    your entire application).
+/**
+ * @deprecated - use {@link LegacyStoreCompat} instead
+ */
 
-    @public
-    @param {String} modelName
-    @return {Adapter}
-  */
+/**
+  Returns an instance of the adapter for a given type. For
+  example, `adapterFor('person')` will return an instance of
+  the adapter located at `app/adapters/person.js`
+
+  If no `person` adapter is found, this method will look
+  for an `application` adapter (the default adapter for
+  your entire application).
+
+  @public
+  @param modelName
+*/
 
 function adapterFor(modelName, _allowMissing) {
   macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
@@ -799,20 +812,19 @@ function adapterFor(modelName, _allowMissing) {
 }
 
 /**
-    Returns an instance of the serializer for a given type. For
-    example, `serializerFor('person')` will return an instance of
-    `App.PersonSerializer`.
+  Returns an instance of the serializer for a given type. For
+  example, `serializerFor('person')` will return an instance of
+  `App.PersonSerializer`.
 
-    If no `App.PersonSerializer` is found, this method will look
-    for an `App.ApplicationSerializer` (the default serializer for
-    your entire application).
+  If no `App.PersonSerializer` is found, this method will look
+  for an `App.ApplicationSerializer` (the default serializer for
+  your entire application).
 
-    If a serializer cannot be found on the adapter, it will fall back
-    to an instance of `JSONSerializer`.
+  If a serializer cannot be found on the adapter, it will fall back
+  to an instance of `JSONSerializer`.
 
-    @public
-    @param {String} modelName the record to serialize
-    @return {Serializer}
+  @public
+  @param modelName the record to serialize
   */
 function serializerFor(modelName) {
   macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
@@ -859,23 +871,29 @@ function serializerFor(modelName) {
 }
 
 /**
-    `normalize` converts a json payload into the normalized form that
-    [push](../methods/push?anchor=push) expects.
+  `normalize` converts a json payload into the normalized form expected by
+  {@link Store.push | push} using the serializer specified by `modelName`
 
-    Example
+  :::warning
+  Generally it would be better to invoke the serializer yourself directly,
+  or write a more specialized normalization utility.
+  :::
 
-    ```js
-    socket.on('message', function(message) {
-      let modelName = message.model;
-      let data = message.data;
-      store.push(store.normalize(modelName, data));
-    });
-    ```
+  Example
 
-    @public
-    @param modelName The name of the model type for this payload
-    @return The normalized payload
-  */
+  ```js
+  socket.on('message', function(message) {
+    let modelName = message.model;
+    let data = message.data;
+    store.push(store.normalize(modelName, data));
+  });
+  ```
+
+  @legacy
+  @public
+  @param modelName The name of the model type for this payload
+  @return The normalized payload
+*/
 // TODO @runspired @deprecate users should call normalize on the associated serializer directly
 function normalize(modelName, payload) {
   macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
@@ -914,7 +932,7 @@ function normalize(modelName, payload) {
     serializer.
 
     ```js [app/serializers/application.js]
-    import RESTSerializer from '@ember-data/serializer/rest';
+    import RESTSerializer from '@warp-drive/legacy/serializer/rest';
 
     export default class ApplicationSerializer extends RESTSerializer;
     ```
@@ -939,13 +957,13 @@ function normalize(modelName, payload) {
     will determine which serializer will process the payload.
 
     ```js [app/serializers/application.js]
-    import RESTSerializer from '@ember-data/serializer/rest';
+    import RESTSerializer from '@warp-drive/legacy/serializer/rest';
 
      export default class ApplicationSerializer extends RESTSerializer;
     ```
 
     ```js [app/serializers/post.js]
-    import JSONSerializer from '@ember-data/serializer/json';
+    import JSONSerializer from '@warp-drive/legacy/serializer/json';
 
     export default JSONSerializer;
     ```
@@ -956,8 +974,8 @@ function normalize(modelName, payload) {
     ```
 
     @public
-    @param {String} modelName Optionally, a model type used to determine which serializer will be used
-    @param {Object} inputPayload
+    @param modelName Optionally, a model type used to determine which serializer will be used
+    @param inputPayload
   */
 // TODO @runspired @deprecate pushPayload in favor of looking up the serializer
 function pushPayload(modelName, inputPayload) {