@warp-drive/legacy 5.8.0-alpha.9 → 5.8.0-beta.1

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) {
@@ -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) {
@@ -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
  */
 
@@ -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) {
@@ -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-B1pSSN52.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);
@@ -736,6 +737,19 @@ function queryRecord(context) {
   });
 }
 
+/**
+ * Extends the signature of {@link Store} with additional
+ * methods available when using the legacy network layer.
+ *
+ * @public
+ * @noInheritDoc
+ * @legacy
+ */
+
+/**
+ * @deprecated - use {@link LegacyStoreCompat} instead
+ */
+
 /**
   Returns an instance of the adapter for a given type. For
   example, `adapterFor('person')` will return an instance of
@@ -857,8 +871,13 @@ 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`
+
+  :::warning
+  Generally it would be better to invoke the serializer yourself directly,
+  or write a more specialized normalization utility.
+  :::
 
   Example
 
@@ -870,6 +889,7 @@ function serializerFor(modelName) {
   });
   ```
 
+  @legacy
   @public
   @param modelName The name of the model type for this payload
   @return The normalized payload
@@ -912,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;
     ```
@@ -937,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;
     ```