@warp-drive/legacy 5.9.0-beta.0 → 5.9.0-beta.1

package/dist/{schema-provider-DJCV_6AF.js → schema-provider-DtPOp0d7.js}

@@ -5,7 +5,7 @@ import { recordIdentifierFor, storeFor } from '@warp-drive/core';
 import { notifyInternalSignal, peekInternalSignal, withSignalStore, gate, memoized, defineSignal, entangleSignal, defineGate } from '@warp-drive/core/signals/-leaked';
 import { assertPrivateStore, recordIdentifierFor as recordIdentifierFor$1, coerceId } from '@warp-drive/core/store/-private';
 import { RecordStore } from '@warp-drive/core/types/symbols';
-import { l as lookupLegacySupport, L as LEGACY_SUPPORT, E as Errors } from "./errors-Cz5KrzBk.js";
+import { l as lookupLegacySupport, L as LEGACY_SUPPORT, E as Errors } from "./errors-DZKA206g.js";
 import { u as upgradeStore, F as FetchManager } from "./-private-BG3bMiKp.js";
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 import { cacheFor } from '@ember/object/internals';
@@ -44,11 +44,13 @@ function hasMany(prop) {
 }
 function reload(options = {}) {
   if (macroCondition(!getGlobalConfig().WarpDrive.deprecations.ENABLE_LEGACY_REQUEST_METHODS)) {
+    const message = `You cannot use reload() on a record when ENABLE_LEGACY_REQUEST_METHODS is false.`;
     macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
       {
-        throw new Error(`You cannot use reload() on a record when ENABLE_LEGACY_REQUEST_METHODS is false.`);
+        throw new Error(message);
       }
     })() : {};
+    return Promise.reject(new Error(message));
   } else {
     deprecate(`record.reload is deprecated, please use store.request to initiate a request instead.`, false, {
       id: 'warp-drive:deprecate-legacy-request-methods',
@@ -102,11 +104,13 @@ function deleteRecord() {
 }
 function save(options) {
   if (macroCondition(!getGlobalConfig().WarpDrive.deprecations.ENABLE_LEGACY_REQUEST_METHODS)) {
+    const message = `You cannot use save() on a record when ENABLE_LEGACY_REQUEST_METHODS is false.`;
     macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
       {
-        throw new Error(`You cannot use save() on a record when ENABLE_LEGACY_REQUEST_METHODS is false.`);
+        throw new Error(message);
       }
     })() : {};
+    return Promise.reject(new Error(message));
   } else {
     deprecate(`record.save is deprecated, please use store.request to initiate a request instead.`, false, {
       id: 'warp-drive:deprecate-legacy-request-methods',
@@ -133,11 +137,13 @@ function _save(options) {
 }
 function destroyRecord(options) {
   if (macroCondition(!getGlobalConfig().WarpDrive.deprecations.ENABLE_LEGACY_REQUEST_METHODS)) {
+    const message = `You cannot use destroyRecord() on a record when ENABLE_LEGACY_REQUEST_METHODS is false.`;
     macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
       {
-        throw new Error(`You cannot use destroyRecord() on a record when ENABLE_LEGACY_REQUEST_METHODS is false.`);
+        throw new Error(message);
       }
     })() : {};
+    return Promise.reject(new Error(message));
   } else {
     deprecate(`record.destroyRecord is deprecated, please use store.request to initiate a request instead.`, false, {
       id: 'warp-drive:deprecate-legacy-request-methods',
@@ -977,6 +983,9 @@ class Model extends EmberObject {
   get isError() {
     return this.currentState.isError;
   }
+  /**
+   * `isError` is read-only and cannot be set directly.
+   */
   static {
     decorateMethodV2(this.prototype, "isError", [memoized]);
   }
@@ -1024,6 +1033,10 @@ class Model extends EmberObject {
     }
     return recordIdentifierFor(this).id;
   }
+  /**
+   * Assigns the resource's primary key. Typically only used internally
+   * when a client-created record is assigned an id upon being saved.
+   */
   static {
     decorateMethodV2(this.prototype, "id", [gate]);
   }
@@ -1063,6 +1076,9 @@ class Model extends EmberObject {
     }
     return this.___recordState;
   }
+  /**
+   * `currentState` is read-only and cannot be set directly.
+   */
   static {
     decorateMethodV2(this.prototype, "currentState", [gate]);
   }
@@ -1136,6 +1152,9 @@ class Model extends EmberObject {
   get adapterError() {
     return this.currentState.adapterError;
   }
+  /**
+   * `adapterError` is read-only and cannot be set directly.
+   */
   static {
     decorateMethodV2(this.prototype, "adapterError", [memoized]);
   }
@@ -1209,12 +1228,29 @@ class Model extends EmberObject {
   eachRelationship(callback, binding) {
     this.constructor.eachRelationship(callback, binding);
   }
+
+  /**
+   * Returns the relationship schema for the given relationship name, if any.
+   */
   relationshipFor(name) {
     return this.constructor.relationshipsByName.get(name);
   }
+
+  /**
+   * Returns the inverse relationship schema for the given relationship
+   * name, if one exists. See {@link Model.inverseFor | the static inverseFor}.
+   */
   inverseFor(name) {
     return this.constructor.inverseFor(name, storeFor(this, false));
   }
+
+  /**
+   * Iterates over the attributes defined on this record's class, calling
+   * `callback` for each one. See {@link Model.eachAttribute | the static eachAttribute}.
+   *
+   * @param callback the callback to invoke
+   * @param binding the value to which the callback's `this` should be bound
+   */
   eachAttribute(callback, binding) {
     this.constructor.eachAttribute(callback, binding);
   }
@@ -1286,6 +1322,11 @@ class Model extends EmberObject {
     const relationship = this.relationshipsByName.get(name);
     return relationship && store.modelFor(relationship.type);
   }
+
+  /**
+   * A cache of resolved inverse relationships by name, populated lazily by
+   * {@link Model.inverseFor | inverseFor}.
+   */
   static get inverseMap() {
     macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
       if (!test) {
@@ -1338,6 +1379,9 @@ class Model extends EmberObject {
     }
   }
 
+  /**
+   * @private
+   */
   //Calculate the inverse, ignoring the cache
   static _findInverseFor(name, store) {
     macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
@@ -1568,6 +1612,12 @@ class Model extends EmberObject {
     }
     return map;
   }
+
+  /**
+   * A hash of the model's relationship schemas keyed by relationship name.
+   * See also {@link Model.relationshipsByName | relationshipsByName}, which
+   * provides the same information as a `Map`.
+   */
   static {
     decorateMethodV2(this, "relationshipsByName", [computeOnce]);
   }
@@ -1954,6 +2004,13 @@ defineGate(Model.prototype, 'isReloading', {
   // @ts-expect-error specially handled prop
   isLocal: true
 });
+
+/**
+ * Restores the pre-`RequestManager` implementations of `save`,
+ * `destroyRecord`, and `reload` onto the given `Model` subclass, for
+ * apps that have not yet migrated off of the deprecated
+ * `ENABLE_LEGACY_REQUEST_METHODS` behaviors.
+ */
 function restoreDeprecatedModelRequestBehaviors(ModelKlass) {
   // @ts-expect-error TS doesn't know how to do `this` function overloads
   ModelKlass.prototype.save = _save;
@@ -2147,7 +2204,11 @@ class ModelSchemaProvider {
   }
   /** @internal */
   _loadModelSchema(type) {
-    const modelClass = this.store.modelFor(type);
+    const factory = getModelFactory(this.store, type);
+    if (!factory) {
+      throw new Error(`No model was found for '${type}'`);
+    }
+    const modelClass = factory.class;
     const attributeMap = modelClass.attributes;
     const attributes = Object.create(null);
     attributeMap.forEach((meta, name) => attributes[name] = meta);
@@ -2168,11 +2229,22 @@ class ModelSchemaProvider {
       type,
       fields: Array.from(fields.values())
     };
+    const cacheFields = new Map();
+    for (const field of fields.values()) {
+      const cacheKey = field.sourceKey ?? field.name;
+      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+        if (!test) {
+          throw new Error(`The sourceKey '${field.sourceKey}' for the field '${field.name}' on '${type}' is invalid because it matches the name of an existing field`);
+        }
+      })(!field.sourceKey || field.sourceKey === field.name || !fields.has(field.sourceKey)) : {};
+      cacheFields.set(cacheKey, field);
+    }
     const internalSchema = {
       schema,
       attributes,
       relationships,
-      fields
+      fields,
+      cacheFields
     };
     this._schemas.set(type, internalSchema);
     return internalSchema;
@@ -2184,6 +2256,13 @@ class ModelSchemaProvider {
     }
     return this._schemas.get(type).fields;
   }
+  cacheFields(resource) {
+    const type = normalizeModelName(resource.type);
+    if (!this._schemas.has(type)) {
+      this._loadModelSchema(type);
+    }
+    return this._schemas.get(type).cacheFields;
+  }
   hasResource(resource) {
     const type = normalizeModelName(resource.type);
     if (this._schemas.has(type)) {
@@ -2259,6 +2338,14 @@ if (macroCondition(getGlobalConfig().WarpDrive.deprecations.ENABLE_LEGACY_SCHEMA
     return this._schemas.get(type).relationships;
   };
 }
+
+/**
+ * The `createSchemaService` implementation for use with `Model`. Pass
+ * the result of this to your store's `createSchemaService` method when
+ * configuring the store to use `Model` for schema information.
+ *
+ * @public
+ */
 function buildSchema(store) {
   return new ModelSchemaProvider(store);
 }

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) {