@warp-drive/legacy 5.9.0-alpha.2 → 5.9.0-alpha.21

package/dist/serializer/json-api.js

@@ -1,6 +1,6 @@
 import { warn } from '@ember/debug';
 import { dasherize, pluralize, singularize } from '@warp-drive/utilities/string';
-import { J as JSONSerializer } from "../json-ChdEfB0X.js";
+import { J as JSONSerializer } from "../json-DU8m1pGf.js";
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 
 /* eslint-disable @typescript-eslint/no-unsafe-return */
@@ -14,10 +14,15 @@ const JSONAPISerializer = JSONSerializer.extend({
   */
   _normalizeDocumentHelper(documentHash) {
     if (Array.isArray(documentHash.data)) {
-      const ret = new Array(documentHash.data.length);
+      const ret = [];
       for (let i = 0; i < documentHash.data.length; i++) {
         const data = documentHash.data[i];
-        ret[i] = this._normalizeResourceHelper(data);
+        const normalized = this._normalizeResourceHelper(data);
+        if (normalized !== null) {
+          // @ts-expect-error untyped
+          // can be null when unknown type is encountered
+          ret.push(normalized);
+        }
       }
       documentHash.data = ret;
     } else if (documentHash.data && typeof documentHash.data === 'object') {

package/dist/serializer/json.js

@@ -2,5 +2,5 @@ import '@ember/application';
 import '@ember/debug';
 import '@warp-drive/utilities/string';
 import '../serializer.js';
-export { J as JSONSerializer } from "../json-ChdEfB0X.js";
+export { J as JSONSerializer } from "../json-DU8m1pGf.js";
 import '@embroider/macros';

package/dist/serializer/rest.js

@@ -1,6 +1,6 @@
 import { warn } from '@ember/debug';
 import { camelize, dasherize, singularize } from '@warp-drive/utilities/string';
-import { J as JSONSerializer, c as coerceId } from "../json-ChdEfB0X.js";
+import { i as inverseForRelationship, J as JSONSerializer, c as coerceId } from "../json-DU8m1pGf.js";
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 import Mixin from '@ember/object/mixin';
 
@@ -422,8 +422,7 @@ const EmbeddedRecordsMixin = Mixin.create({
   */
   removeEmbeddedForeignKey(snapshot, embeddedSnapshot, relationship, json) {
     if (relationship.kind === 'belongsTo') {
-      const schema = this.store.modelFor(snapshot.modelName);
-      const parentRecord = schema.inverseFor(relationship.name, this.store);
+      const parentRecord = inverseForRelationship(this.store, snapshot.modelName, relationship.name);
       if (parentRecord) {
         const name = parentRecord.name;
         const embeddedSerializer = this.store.serializerFor(embeddedSnapshot.modelName);
@@ -1025,7 +1024,7 @@ const RESTSerializer = JSONSerializer.extend({
      `serialize` takes an options hash with a single option:
     `includeId`. If this option is `true`, `serialize` will,
     by default include the ID in the JSON object it builds.
-     The adapter passes in `includeId: true` when serializing
+     The RESTAdapter passes in `includeId: true` when serializing
     a record for `createRecord`, but not for `updateRecord`.
      ## Customization
      Your server may expect a different JSON format than the

package/dist/serializer/transform.js

@@ -116,6 +116,10 @@ const Transform = EmberObject;
   @public
  */
 class BooleanTransform {
+  /**
+   * Converts a serialized (raw payload) value into a `boolean` (or `null`
+   * when `allowNull` is set and the value is nullish).
+   */
   deserialize(serialized, options) {
     if ((serialized === null || serialized === undefined) && options?.allowNull === true) {
       return null;
@@ -130,12 +134,20 @@ class BooleanTransform {
       return false;
     }
   }
+
+  /**
+   * Converts a `boolean` attribute value into its serialized (raw payload) form.
+   */
   serialize(deserialized, options) {
     if ((deserialized === null || deserialized === undefined) && options?.allowNull === true) {
       return null;
     }
     return Boolean(deserialized);
   }
+
+  /**
+   * Creates a new instance of this transform.
+   */
   static create() {
     return new this();
   }
@@ -151,7 +163,7 @@ class BooleanTransform {
  standard.
 
  ```js [app/models/score.js]
- import Model, { attr, belongsTo } from '@ember-data/model';
+ import Model, { attr, belongsTo } from '@warp-drive/legacy/model';
 
  export default class ScoreModel extends Model {
     @attr('number') value;
@@ -164,6 +176,10 @@ class BooleanTransform {
  */
 
 class DateTransform {
+  /**
+   * Converts a serialized (raw payload) `ISO 8601` string, epoch number,
+   * or nullish value into a `Date` (or `null`/`undefined`).
+   */
   deserialize(serialized, _options) {
     if (typeof serialized === 'string') {
       let offset = serialized.indexOf('+');
@@ -182,6 +198,11 @@ class DateTransform {
       return null;
     }
   }
+
+  /**
+   * Converts a `Date` attribute value into an `ISO 8601` string, or `null`
+   * if the value is not a valid `Date`.
+   */
   serialize(date, _options) {
     // @ts-expect-error isNaN accepts date as it is coercible
     if (date instanceof Date && !isNaN(date)) {
@@ -190,6 +211,10 @@ class DateTransform {
       return null;
     }
   }
+
+  /**
+   * Creates a new instance of this transform.
+   */
   static create() {
     return new this();
   }
@@ -209,7 +234,7 @@ function isNumber(value) {
   Usage
 
   ```js [app/models/score.js]
-  import Model, { attr, belongsTo } from '@ember-data/model';
+  import Model, { attr, belongsTo } from '@warp-drive/legacy/model';
 
   export default class ScoreModel extends Model {
     @attr('number') value;
@@ -221,6 +246,10 @@ function isNumber(value) {
   @public
  */
 class NumberTransform {
+  /**
+   * Converts a serialized (raw payload) value into a `number`, or `null`
+   * if the value is empty, nullish, or not a valid number.
+   */
   deserialize(serialized, _options) {
     if (serialized === '' || serialized === null || serialized === undefined) {
       return null;
@@ -229,6 +258,10 @@ class NumberTransform {
       return isNumber(transformed) ? transformed : null;
     }
   }
+
+  /**
+   * Converts a `number` attribute value into its serialized (raw payload) form.
+   */
   serialize(deserialized, _options) {
     if (deserialized === '' || deserialized === null || deserialized === undefined) {
       return null;
@@ -237,6 +270,10 @@ class NumberTransform {
       return isNumber(transformed) ? transformed : null;
     }
   }
+
+  /**
+   * Creates a new instance of this transform.
+   */
   static create() {
     return new this();
   }
@@ -253,7 +290,7 @@ class NumberTransform {
   Usage
 
   ```js [app/models/user.js]
-  import Model, { attr, belongsTo } from '@ember-data/model';
+  import Model, { attr, belongsTo } from '@warp-drive/legacy/model';
 
   export default class UserModel extends Model {
     @attr('boolean') isAdmin;
@@ -265,12 +302,23 @@ class NumberTransform {
   @public
  */
 class StringTransform {
+  /**
+   * Converts a serialized (raw payload) value into a `string`, or `null`
+   * if the value is falsy (and not an empty string).
+   */
   deserialize(serialized, _options) {
     return !serialized && serialized !== '' ? null : String(serialized);
   }
+  /**
+   * Converts a `string` attribute value into its serialized (raw payload) form.
+   */
   serialize(deserialized, _options) {
     return !deserialized && deserialized !== '' ? null : String(deserialized);
   }
+
+  /**
+   * Creates a new instance of this transform.
+   */
   static create() {
     return new this();
   }

package/dist/serializer.js

@@ -149,11 +149,8 @@ class Serializer extends EmberObject {
       }
     });
     ```
-     @property store
-    @type {Store}
-    @public
+     @public
   */
-
   /**
     The `normalizeResponse` method is used to normalize a payload from the
     server to a JSON-API Document.
@@ -237,9 +234,9 @@ class Serializer extends EmberObject {
     })
     ```
      @public
-    @param {Model} typeClass
-    @param {Object} hash
-    @return {Object}
+    @param _typeClass - the model class the hash is being normalized for
+    @param hash - the raw payload hash to normalize
+    @return the normalized resource document
   */
   normalize(_typeClass, hash) {
     return hash;

package/dist/store.js

@@ -108,12 +108,11 @@ function resourceIsFullyDeleted(instanceCache, identifier) {
 class RecordReference {
   /** @internal */
 
-  /** @internal */
   // unsubscribe token given to us by the notification manager
+  /** @internal */
   ___token;
   /** @internal */
   ___identifier;
-
   /** @internal */
 
   constructor(store, identifier) {
@@ -144,7 +143,7 @@ class RecordReference {
       userRef.id(); // '1'
      ```
      @public
-     @return The id of the record.
+    @return The id of the record.
   */
   id() {
     // eslint-disable-next-line @typescript-eslint/no-unused-expressions
@@ -162,7 +161,7 @@ class RecordReference {
       userRef.identifier(); // '1'
      ```
      @public
-     @return The identifier of the record.
+    @return The identifier of the record.
   */
   identifier() {
     return this.___identifier;
@@ -188,7 +187,7 @@ class RecordReference {
     simplest usage of this API is similar to `store.push`: you provide a
     normalized hash of data and the object represented by the reference
     will update.
-     If you pass a promise to `push`, Ember Data will not ask the adapter
+     If you pass a promise to `push`, WarpDrive will not ask the adapter
     for the data if another attempt to fetch it is made in the
     interim. When the promise resolves, the underlying object is updated
     with the new data, and the promise returned by *this function* is resolved
@@ -232,7 +231,7 @@ class RecordReference {
       userRef.value(); // user
      ```
      @public
-     @return {Model} the record for this RecordReference
+    @return the record for this RecordReference
   */
   value() {
     return this.store.peekRecord(this.___identifier);
@@ -527,7 +526,14 @@ function restoreDeprecatedStoreBehaviors(StoreKlass) {
   };
 
   // do not put a ts-expect-error here, because typedoc will fail to
-  // build due to this error only occurring when references are in use in the editor
+  // build due to this error only occurring when references are in use in the editor.
+  // The return statement below casts to `PrivateStore['getReference']`'s return
+  // type rather than annotating this function `: RecordReference` directly,
+  // since this package's `RecordReference` and core's `deprecated/-private.ts`
+  // copy are structurally identical but nominally distinct classes (TS treats
+  // their private fields as separate brands); casting only the return value
+  // (instead of the whole function) keeps `this` contextually typed from the
+  // assignment target below.
   StoreKlass.prototype.getReference = function (resource, id) {
     macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
       if (!test) {