@warp-drive/legacy 5.7.0-alpha.9 → 5.7.0-beta.0

package/dist/{-private-CKrP0ogQ.js → -private-8UmnAf9J.js}

@@ -1,6 +1,7 @@
-import { SOURCE, waitFor, coerceId } from '@warp-drive/core/store/-private';
+import { Context } from '@warp-drive/core/reactive/-private';
 import { warn } from '@ember/debug';
 import { createDeferred } from '@warp-drive/core/request';
+import { assertPrivateStore, waitFor, coerceId } from '@warp-drive/core/store/-private';
 import { getOrSetGlobal } from '@warp-drive/core/types/-private';
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 
@@ -9,40 +10,26 @@ import { macroCondition, getGlobalConfig } from '@embroider/macros';
   Instances are provided to consuming application's
   adapters for certain `findAll` requests.
 
-  @class SnapshotRecordArray
+  @hideconstructor
   @public
 */
 class SnapshotRecordArray {
   /**
-    SnapshotRecordArray is not directly instantiable.
-    Instances are provided to consuming application's
-    adapters and serializers for certain requests.
-     @private
-    @constructor
-    @param {Store} store
-    @param {String} type
-    @param options
+   * An array of snapshots
+   *
+   * @internal
    */
-  constructor(store, type, options = {}) {
-    this.__store = store;
-    /**
-      An array of snapshots
-      @private
-      @property _snapshots
-      @type {Array}
-    */
-    this._snapshots = null;
 
-    /**
-    The modelName of the underlying records for the snapshots in the array, as a Model
-    @property modelName
-    @public
-    @type {Model}
-    */
-    this.modelName = type;
+  /** @internal */
 
-    /**
-      A hash of adapter options passed into the store method for this request.
+  /**
+   * The ResourceType of the underlying records for the {@link Snapshot | Snapshots} in the array
+   */
+
+  /** @internal */
+
+  /**
+   *  A hash of adapter options passed into the store method for this request.
        Example
        ```js [app/adapters/post.js]
       import MyCustomAdapter from './custom-adapter';
@@ -55,14 +42,10 @@ class SnapshotRecordArray {
         }
       }
       ```
-       @property adapterOptions
-      @public
-      @type {Object}
-    */
-    this.adapterOptions = options.adapterOptions;
+   */
 
-    /**
-      The relationships to include for this request.
+  /**
+   * The relationships to include for this request.
        Example
        ```js [app/adapters/application.js]
       import Adapter from '@ember-data/adapter';
@@ -73,18 +56,29 @@ class SnapshotRecordArray {
         }
       }
       ```
-       @property include
-      @public
-      @type {String|Array}
-    */
+   */
+
+  /**
+    SnapshotRecordArray is not directly instantiable.
+    Instances are provided to consuming application's
+    adapters and serializers for certain requests.
+     @private
+    @constructor
+    @param {Store} store
+    @param {String} type
+    @param options
+   */
+  constructor(store, type, options = {}) {
+    this.__store = store;
+    this._snapshots = null;
+    this.modelName = type;
+    this.adapterOptions = options.adapterOptions;
     this.include = options.include;
   }
 
   /**
     An array of records
-     @property _recordArray
-    @private
-    @type {Array}
+     @internal
   */
   get _recordArray() {
     return this.__store.peekAll(this.modelName);
@@ -101,9 +95,6 @@ class SnapshotRecordArray {
         }
       });
       ```
-       @property length
-      @public
-      @type {Number}
     */
   get length() {
     return this._recordArray.length;
@@ -139,7 +130,8 @@ class SnapshotRecordArray {
     const {
       _fetchManager
     } = this.__store;
-    this._snapshots = this._recordArray[SOURCE].map(identifier => _fetchManager.createSnapshot(identifier));
+    const LiveArrayContext = this._recordArray[Context];
+    this._snapshots = LiveArrayContext.source.map(identifier => _fetchManager.createSnapshot(identifier));
     return this._snapshots;
   }
 }
@@ -238,17 +230,58 @@ function normalizeResponseHelper(serializer, store, modelClass, payload, id, req
   Snapshots are only available when using `@ember-data/legacy-compat`
   for legacy compatibility with adapters and serializers.
 
-  @class Snapshot
+  For serialization of records in modern paradigms, request data from
+  the cache or off the record directly.
+
+  @hideconstructor
   @public
 */
 class Snapshot {
+  /** @internal */
+
+  /** @internal */
+
+  /** @internal */
+
+  /** @internal */
+
+  /** @internal */
+
+  /** @internal */
+
+  /** @internal */
+
   /**
-   * @constructor
-   * @private
-   * @param options
-   * @param identifier
-   * @param _store
-   */
+    The unique ResourceKey associated with this Snapshot.
+     @public
+  */
+
+  /**
+   The ResourceType of the underlying record for this Snapshot, as a string.
+     @public
+  */
+
+  /**
+   The id of the snapshot's underlying record
+     Example
+     ```js
+    // store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });
+    postSnapshot.id; // => '1'
+    ```
+     @public
+  */
+
+  /**
+   If `include` was passed to the options for the request, the value
+   would be available here.
+    @public
+  */
+
+  /**
+   The adapterOptions passed to the request which generated this Snapshot, if any
+    @public
+  */
+
   constructor(options, identifier, store) {
     this._store = store;
     this.__attributes = null;
@@ -256,15 +289,9 @@ class Snapshot {
     this._belongsToIds = Object.create(null);
     this._hasManyRelationships = Object.create(null);
     this._hasManyIds = Object.create(null);
+    assertPrivateStore(store);
     const hasRecord = !!store._instanceCache.peek(identifier);
     this.modelName = identifier.type;
-
-    /**
-      The unique RecordIdentifier associated with this Snapshot.
-       @property identifier
-      @public
-      @type {StableRecordIdentifier}
-    */
     this.identifier = identifier;
 
     /*
@@ -278,43 +305,9 @@ class Snapshot {
       // eslint-disable-next-line @typescript-eslint/no-unused-expressions
       this._attributes;
     }
-
-    /**
-     The id of the snapshot's underlying record
-      Example
-      ```javascript
-     // store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });
-     postSnapshot.id; // => '1'
-     ```
-      @property id
-     @type {String}
-     @public
-     */
     this.id = identifier.id;
-
-    /**
-     A hash of adapter options
-     @property adapterOptions
-     @type {Object}
-     @public
-     */
     this.adapterOptions = options.adapterOptions;
-
-    /**
-     If `include` was passed to the options hash for the request, the value
-     would be available here.
-      @property include
-     @type {String|Array}
-     @public
-     */
     this.include = options.include;
-
-    /**
-     The name of the type of the underlying record for this snapshot, as a string.
-      @property modelName
-     @type {String}
-     @public
-     */
     this.modelName = identifier.type;
     if (hasRecord) {
       const cache = this._store.cache;
@@ -325,12 +318,10 @@ class Snapshot {
   /**
    The underlying record for this snapshot. Can be used to access methods and
    properties defined on the record.
-    Example
-    ```javascript
-   let json = snapshot.record.toJSON();
+    ```js
+   const someValue = snapshot.record.someProp;
    ```
     @property record
-   @type {Model}
    @public
    */
   get record() {
@@ -342,6 +333,8 @@ class Snapshot {
     })(record !== null) : {};
     return record;
   }
+
+  /** @internal */
   get _attributes() {
     if (this.__attributes !== null) {
       return this.__attributes;
@@ -350,12 +343,9 @@ class Snapshot {
     const {
       identifier
     } = this;
-    const attrs = this._store.schema.fields(identifier);
     const cache = this._store.cache;
-    attrs.forEach((field, keyName) => {
-      if (field.kind === 'attribute') {
-        attributes[keyName] = cache.getAttr(identifier, keyName);
-      }
+    this.eachAttribute((key, meta) => {
+      attributes[key] = cache.getAttr(identifier, key);
     });
     return attributes;
   }
@@ -373,8 +363,7 @@ class Snapshot {
    postSnapshot.attr('title'); // => 'Ember.js rocks'
    ```
     Note: Values are loaded eagerly and cached when the snapshot is created.
-    @param {String} keyName
-   @return {Object} The attribute value or undefined
+    @return The attribute value or undefined
    @public
    */
   attr(keyName) {
@@ -390,12 +379,18 @@ class Snapshot {
 
   /**
    Returns all attributes and their corresponding values.
+    ::: warning ⚠️ WARNING
+   Attributes are SHALLOW copied from the cache.
+   Because they are NOT deep copied from the cache, mutating
+   any object or array fields will cause unintended side-effects
+   and bugs.
+   :::
     Example
-    ```javascript
+    ```js
    // store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });
    postSnapshot.attributes(); // => { author: 'Tomster', title: 'Ember.js rocks' }
    ```
-    @return {Object} All attributes of the current snapshot
+    @return All attributes of the current snapshot
    @public
    */
   attributes() {
@@ -407,12 +402,12 @@ class Snapshot {
   /**
    Returns all changed attributes and their old and new values.
     Example
-    ```javascript
+    ```js
    // store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });
    postModel.set('title', 'Ember.js rocks!');
    postSnapshot.changedAttributes(); // => { title: ['Ember.js rocks', 'Ember.js rocks!'] }
    ```
-    @return {Object} All changed attributes of the current snapshot
+    @return All changed attributes of the current snapshot
    @public
    */
   changedAttributes() {
@@ -435,7 +430,7 @@ class Snapshot {
     - `id`: set to `true` if you only want the ID of the related record to be
    returned.
     Example
-    ```javascript
+    ```js
    // store.push('post', { id: 1, title: 'Hello World' });
    // store.createRecord('comment', { body: 'Lorem ipsum', post: post });
    commentSnapshot.belongsTo('post'); // => Snapshot
@@ -448,12 +443,10 @@ class Snapshot {
    known but unset, `belongsTo` will return `null`. If the contents of the
    relationship is unknown `belongsTo` will return `undefined`.
     Note: Relationships are loaded lazily and cached upon first access.
-    @param {String} keyName
-   @param {Object} [options]
-   @public
-   @return {(Snapshot|String|null|undefined)} A snapshot or ID of a known
-   relationship or null if the relationship is known but unset. undefined
-   will be returned if the contents of the relationship is unknown.
+    @public
+   @return A snapshot or ID of a known relationship or null if the
+   relationship is known but unset. undefined will be returned if the
+   contents of the relationship are unknown.
    */
   belongsTo(keyName, options) {
     const returnModeIsId = !!(options && options.id);
@@ -496,7 +489,7 @@ class Snapshot {
     }
     const value = this._store.cache.getRelationship(identifier, keyName);
     const data = value && value.data;
-    const inverseIdentifier = data ? store.identifierCache.getOrCreateRecordIdentifier(data) : null;
+    const inverseIdentifier = data ? store.cacheKeyManager.getOrCreateRecordIdentifier(data) : null;
     if (value && value.data !== undefined) {
       const cache = store.cache;
       if (inverseIdentifier && !cache.isDeleted(inverseIdentifier)) {
@@ -532,10 +525,8 @@ class Snapshot {
    postSnapshot.hasMany('comments'); // => undefined
    ```
     Note: Relationships are loaded lazily and cached upon first access.
-    @param {String} keyName
-   @param {Object} [options]
-   @public
-   @return {(Array|undefined)} An array of snapshots or IDs of a known
+    @public
+   @return An array of snapshots or IDs of a known
    relationship or an empty array if the relationship is known but unset.
    undefined will be returned if the contents of the relationship is unknown.
    */
@@ -590,7 +581,7 @@ class Snapshot {
     if (value.data) {
       results = [];
       value.data.forEach(member => {
-        const inverseIdentifier = store.identifierCache.getOrCreateRecordIdentifier(member);
+        const inverseIdentifier = store.cacheKeyManager.getOrCreateRecordIdentifier(member);
         const cache = store.cache;
         if (!cache.isDeleted(inverseIdentifier)) {
           if (returnModeIsIds) {
@@ -621,17 +612,24 @@ class Snapshot {
       // ...
     });
     ```
-     @param {Function} callback the callback to execute
-    @param {Object} [binding] the value to which the callback's `this` should be bound
+     @param callback the callback to execute
+    @param binding the optional value to which the callback's `this` should be bound
     @public
   */
   eachAttribute(callback, binding) {
-    const fields = this._store.schema.fields(this.identifier);
-    fields.forEach((field, key) => {
-      if (field.kind === 'attribute') {
-        callback.call(binding, key, field);
-      }
-    });
+    // if the store has a modelFor implementation, we use it to iterate attributes. This allows
+    // a custom "ModelSchema" class for legacy serializers to adapt to new fields if desired.
+    if (typeof this._store.modelFor === 'function') {
+      const modelSchema = this._store.modelFor(this.identifier.type);
+      modelSchema.eachAttribute(callback, binding);
+    } else {
+      const fields = this._store.schema.fields(this.identifier);
+      fields.forEach((field, key) => {
+        if (field.kind === 'attribute') {
+          callback.call(binding, key, field);
+        }
+      });
+    }
   }
 
   /**
@@ -643,17 +641,24 @@ class Snapshot {
       // ...
     });
     ```
-     @param {Function} callback the callback to execute
-    @param {Object} [binding] the value to which the callback's `this` should be bound
+     @param callback the callback to execute
+    @param binding the optional value to which the callback's `this` should be bound
     @public
   */
   eachRelationship(callback, binding) {
-    const fields = this._store.schema.fields(this.identifier);
-    fields.forEach((field, key) => {
-      if (field.kind === 'belongsTo' || field.kind === 'hasMany') {
-        callback.call(binding, key, field);
-      }
-    });
+    // if the store has a modelFor implementation, we use it to iterate relationships. This allows
+    // a custom "ModelSchema" class for legacy serializers to adapt to new fields if desired.
+    if (typeof this._store.modelFor === 'function') {
+      const modelSchema = this._store.modelFor(this.identifier.type);
+      modelSchema.eachRelationship(callback, binding);
+    } else {
+      const fields = this._store.schema.fields(this.identifier);
+      fields.forEach((field, key) => {
+        if (field.kind === 'belongsTo' || field.kind === 'hasMany') {
+          callback.call(binding, key, field);
+        }
+      });
+    }
   }
 
   /**
@@ -672,8 +677,7 @@ class Snapshot {
       }
     });
     ```
-     @param {Object} options
-    @return {Object} an object whose values are primitive JSON values only
+     @return an object whose values are primitive JSON values only
     @public
    */
   serialize(options) {
@@ -688,10 +692,25 @@ class Snapshot {
   }
 }
 const SaveOp = getOrSetGlobal('SaveOp', Symbol('SaveOp'));
+/**
+ * @private
+ */
 class FetchManager {
+  /**
+   * @internal
+   */
+
+  /** @internal */
+
   // fetches pending in the runloop, waiting to be coalesced
+  /**
+   * @internal
+   */
+
+  /** @internal */
 
   constructor(store) {
+    assertPrivateStore(store);
     this._store = store;
     // used to keep track of all the find requests that need to be coalesced
     this._pendingFetch = new Map();
@@ -706,7 +725,7 @@ class FetchManager {
     This method is called by `record.save`, and gets passed a
     resolver for the promise that `record.save` returns.
      It schedules saving to happen at the end of the run loop.
-     @internal
+     @private
   */
   scheduleSave(identifier, options) {
     const resolver = createDeferred();
@@ -870,6 +889,15 @@ class FetchManager {
     this.isDestroyed = true;
   }
 }
+
+/**
+ * This type exists for internal use only for
+ * where intimate contracts still exist either for
+ * the Test Suite or for Legacy code.
+ *
+ * @private
+ */
+
 function _isEmpty(instanceCache, identifier) {
   const cache = instanceCache.cache;
   if (!cache) {

package/dist/adapter/-private.js

@@ -1 +1 @@
-export { d as determineBodyPromise, g as fetch, p as parseResponseHeaders, b as serializeIntoHash, s as serializeQueryParams, a as setupFastboot } from "../serialize-into-hash-Bp58npke.js";
+export { d as determineBodyPromise, g as fetch, p as parseResponseHeaders, b as serializeIntoHash, s as serializeQueryParams, a as setupFastboot } from "../serialize-into-hash-CS0MIv4F.js";

package/dist/adapter/json-api.js

@@ -1,7 +1,7 @@
 import { dasherize, pluralize } from '@warp-drive/utilities/string';
 import '@ember/debug';
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
-import { b as serializeIntoHash } from "../serialize-into-hash-Bp58npke.js";
+import { b as serializeIntoHash } from "../serialize-into-hash-CS0MIv4F.js";
 import { RESTAdapter } from './rest.js';
 class JSONAPIAdapter extends RESTAdapter {
   _defaultContentType = 'application/vnd.api+json';

package/dist/adapter/rest.js

@@ -2,7 +2,7 @@ import { getOwner } from '@ember/application';
 import { warn } from '@ember/debug';
 import { computed } from '@ember/object';
 import { Adapter, BuildURLMixin } from '../adapter.js';
-import { b as serializeIntoHash, d as determineBodyPromise, g as getFetchFunction, s as serializeQueryParams, p as parseResponseHeaders } from "../serialize-into-hash-Bp58npke.js";
+import { b as serializeIntoHash, d as determineBodyPromise, g as getFetchFunction, s as serializeQueryParams, p as parseResponseHeaders } from "../serialize-into-hash-CS0MIv4F.js";
 import { InvalidError, ServerError, ConflictError, NotFoundError, ForbiddenError, UnauthorizedError, AdapterError, TimeoutError, AbortError } from './error.js';
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 import { d as decorateMethodV2 } from "../runtime-BPCpkOf1-BKOwiRJp.js";

package/dist/compat/-private.js

@@ -1 +1 @@
-export { F as FetchManager, S as SaveOp, c as Snapshot, b as SnapshotRecordArray, u as upgradeStore } from "../-private-CKrP0ogQ.js";
+export { F as FetchManager, S as SaveOp, c as Snapshot, b as SnapshotRecordArray, u as upgradeStore } from "../-private-8UmnAf9J.js";

package/dist/compat/builders.js

@@ -1,7 +1,7 @@
 import { SkipCache } from '@warp-drive/core/types/request';
 import { n as normalizeModelName, i as isMaybeIdentifier } from "../utils-Cqw9eRj5.js";
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
-import { ensureStringId, constructResource } from '@warp-drive/core/store/-private';
+import { ensureStringId, constructResource, assertPrivateStore } from '@warp-drive/core/store/-private';
 import { storeFor, recordIdentifierFor } from '@warp-drive/core';
 
 /**
@@ -227,7 +227,8 @@ function resourceIsFullyDeleted(instanceCache, identifier) {
   @return {SaveRecordRequestInput} request config
 */
 function saveRecordBuilder(record, options = {}) {
-  const store = storeFor(record);
+  const store = storeFor(record, true);
+  assertPrivateStore(store);
   macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
     if (!test) {
       throw new Error(`Unable to initiate save for a record in a disconnected state`);

package/dist/compat.js

@@ -1,7 +1,8 @@
 import { getOwner } from '@ember/application';
 import { recordIdentifierFor } from '@warp-drive/core';
-import { waitFor, _deprecatingNormalize } from '@warp-drive/core/store/-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-CKrP0ogQ.js";
+import { assertPrivateStore, waitFor, _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 { macroCondition, getGlobalConfig } from '@embroider/macros';
 function _findHasMany(adapter, store, identifier, link, relationship, options) {
   const promise = Promise.resolve().then(() => {
@@ -424,6 +425,7 @@ function saveRecord(context) {
     options,
     record: identifier
   } = data;
+  assertPrivateStore(store);
   store.cache.willCommit(identifier, context);
   const saveOptions = Object.assign({
     [SaveOp]: operation
@@ -529,6 +531,7 @@ function findRecord(context) {
     record: identifier,
     options
   } = data;
+  assertPrivateStore(store);
   let promise;
 
   // if not loaded start loading
@@ -583,6 +586,7 @@ function findAll(context) {
     type,
     options
   } = data;
+  assertPrivateStore(store);
   const adapter = store.adapterFor(type);
   macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
     if (!test) {
@@ -647,6 +651,7 @@ function query(context) {
     store,
     data
   } = context.request;
+  assertPrivateStore(store);
   let {
     options
   } = data;