@ember-data/store 5.4.0-alpha.28 → 5.4.0-alpha.29

package/addon/-private.js

@@ -1 +1 @@
-export { A as ARRAY_SIGNAL, f as AdapterPopulatedRecordArray, C as CacheHandler, I as IdentifierArray, M as MUTATE, I as RecordArray, R as RecordArrayManager, g as SOURCE, S as Store, l as StoreMap, _ as _clearCaches, o as _deprecatingNormalize, e as coerceId, h as fastPush, i as isStableIdentifier, n as notifyArray, p as peekCache, r as recordIdentifierFor, j as removeRecordDataFor, m as setCacheFor, c as setIdentifierForgetMethod, a as setIdentifierGenerationMethod, d as setIdentifierResetMethod, b as setIdentifierUpdateMethod, k as setRecordIdentifier, s as storeFor } from "./cache-handler-XLbbNJdo";
+export { A as ARRAY_SIGNAL, f as AdapterPopulatedRecordArray, C as CacheHandler, I as IdentifierArray, M as MUTATE, I as RecordArray, R as RecordArrayManager, g as SOURCE, S as Store, l as StoreMap, _ as _clearCaches, o as _deprecatingNormalize, e as coerceId, h as fastPush, i as isStableIdentifier, n as notifyArray, p as peekCache, r as recordIdentifierFor, j as removeRecordDataFor, m as setCacheFor, c as setIdentifierForgetMethod, a as setIdentifierGenerationMethod, d as setIdentifierResetMethod, b as setIdentifierUpdateMethod, k as setRecordIdentifier, s as storeFor } from "./cache-handler-oB00-31L";

package/addon/{cache-handler-XLbbNJdo.js → cache-handler-oB00-31L.js}

@@ -1077,6 +1077,7 @@ function peekRecordIdentifier(record) {
   @param {Object} record a record instance previously obstained from the store.
   @return {StableRecordIdentifier}
  */
+
 function recordIdentifierFor(record) {
   assert(`${String(record)} is not a record instantiated by @ember-data/store`, RecordCache.has(record));
   return RecordCache.get(record);
@@ -2528,6 +2529,7 @@ let IdentifierArray = (_class = class IdentifierArray {
             target[index] = identifier;
             return true;
           } else if (isSelfProp(self, prop)) {
+            // @ts-expect-error not all properties are indeces and we can't safely cast
             self[prop] = value;
             return true;
           }
@@ -2618,6 +2620,10 @@ let IdentifierArray = (_class = class IdentifierArray {
    */
   _update() {
     assert(`_update cannot be used with this array`, this.modelName);
+    // @ts-expect-error typescript is unable to handle the complexity of
+    //   T = unknown, modelName = string
+    //   T extends TypedRecordInstance, modelName = TypeFromInstance<T>
+    // both being valid options to pass through here.
     return this.store.findAll(this.modelName, {
       reload: true
     });
@@ -2672,6 +2678,10 @@ class Collection extends IdentifierArray {
     // TODO save options from initial request?
     assert(`update cannot be used with this array`, this.modelName);
     assert(`update cannot be used with no query`, query);
+    // @ts-expect-error typescript is unable to handle the complexity of
+    //   T = unknown, modelName = string
+    //   T extends TypedRecordInstance, modelName = TypeFromInstance<T>
+    // both being valid options to pass through here.
     const promise = store.query(this.modelName, query, {
       _recordArray: this
     });
@@ -3297,6 +3307,24 @@ function constructResource(type, id, lid) {
  */
 // this import location is deprecated but breaks in 4.8 and older
 
+/**
+ * Currently only records that extend object can be created via
+ * store.createRecord. This is a limitation of the current API,
+ * but can be worked around by creating a new identifier, running
+ * the cache.clientDidCreate method, and then peeking the record
+ * for the identifier.
+ *
+ * To assign primary key to a record during creation, only `id` will
+ * work correctly for `store.createRecord`, other primary key may be
+ * handled by updating the record after creation or using the flow
+ * described above.
+ *
+ * TODO: These are limitations we want to (and can) address. If you
+ * have need of lifting these limitations, please open an issue.
+ *
+ * @typedoc
+ */
+
 /**
  * A Store coordinates interaction between your application, a [Cache](https://api.emberjs.com/ember-data/release/classes/%3CInterface%3E%20Cache),
  * and sources of data (such as your API or a local persistence layer)
@@ -3779,7 +3807,7 @@ class Store extends EmberObject {
   }
 
   /**
-    Returns the schema for a particular `modelName`.
+    Returns the schema for a particular resource type (modelName).
      When used with Model from @ember-data/model the return is the model class,
     but this is not guaranteed.
      If looking to query attribute or relationship information it is
@@ -3793,7 +3821,7 @@ class Store extends EmberObject {
     for example.
      @method modelFor
     @public
-    @param {String} type
+    @param {string} type
     @return {ModelSchema}
     */
   // TODO @deprecate in favor of schema APIs, requires adapter/serializer overhaul or replacement
@@ -3826,17 +3854,18 @@ class Store extends EmberObject {
     ```
      @method createRecord
     @public
-    @param {String} modelName
+    @param {String} type the name of the resource
     @param {Object} inputProperties a hash of properties to set on the
       newly created record.
     @return {Model} record
   */
-  createRecord(modelName, inputProperties) {
+
+  createRecord(type, inputProperties) {
     if (macroCondition(getOwnConfig().env.DEBUG)) {
       assertDestroyingStore(this, 'createRecord');
     }
-    assert(`You need to pass a model name to the store's createRecord method`, modelName);
-    assert(`Passing classes to store methods has been removed. Please pass a dasherized string instead of ${modelName}`, typeof modelName === 'string');
+    assert(`You need to pass a model name to the store's createRecord method`, type);
+    assert(`Passing classes to store methods has been removed. Please pass a dasherized string instead of ${type}`, typeof type === 'string');
 
     // This is wrapped in a `run.join` so that in test environments users do not need to manually wrap
     //   calls to `createRecord`. The run loop usage here is because we batch the joining and updating
@@ -3845,7 +3874,7 @@ class Store extends EmberObject {
     //   to remove this, we would need to move to a new `async` API.
     let record;
     this._join(() => {
-      const normalizedModelName = normalizeModelName(modelName);
+      const normalizedModelName = normalizeModelName(type);
       const properties = {
         ...inputProperties
       };
@@ -3854,21 +3883,20 @@ class Store extends EmberObject {
       // give the adapter an opportunity to generate one. Typically,
       // client-side ID generators will use something like uuid.js
       // to avoid conflicts.
-
+      let id = null;
       if (properties.id === null || properties.id === undefined) {
-        const adapter = this.adapterFor?.(modelName, true);
+        const adapter = this.adapterFor?.(normalizedModelName, true);
         if (adapter && adapter.generateIdForRecord) {
-          properties.id = adapter.generateIdForRecord(this, modelName, properties);
+          id = properties.id = coerceId(adapter.generateIdForRecord(this, normalizedModelName, properties));
         } else {
-          properties.id = null;
+          id = properties.id = null;
         }
+      } else {
+        id = properties.id = coerceId(properties.id);
       }
-
-      // Coerce ID to a string
-      properties.id = coerceId(properties.id);
       const resource = {
         type: normalizedModelName,
-        id: properties.id
+        id
       };
       if (resource.id) {
         const identifier = this.identifierCache.peekRecordIdentifier(resource);
@@ -3894,7 +3922,7 @@ class Store extends EmberObject {
     ```
      @method deleteRecord
     @public
-    @param {Model} record
+    @param {unknown} record
   */
   deleteRecord(record) {
     if (macroCondition(getOwnConfig().env.DEBUG)) {
@@ -4216,7 +4244,7 @@ class Store extends EmberObject {
      @since 1.13.0
     @method findRecord
     @public
-    @param {String|object} modelName - either a string representing the modelName 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|object} type - 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|Integer|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 {Object} [options] - if the first param is a string this will be the optional options for the request. See examples for available options.
     @return {Promise} promise
@@ -4401,24 +4429,25 @@ class Store extends EmberObject {
      @since 1.13.0
     @method query
     @public
-    @param {String} modelName
-    @param {any} query an opaque query to be used by the adapter
+    @param {String} type the name of the resource
+    @param {object} query a query to be used by the adapter
     @param {Object} options optional, may include `adapterOptions` hash which will be passed to adapter.query
     @return {Promise} promise
   */
-  query(modelName, query, options) {
+
+  query(type, query, options = {}) {
     if (macroCondition(getOwnConfig().env.DEBUG)) {
       assertDestroyingStore(this, 'query');
     }
-    assert(`You need to pass a model name to the store's query method`, modelName);
+    assert(`You need to pass a model name to the store's query method`, type);
     assert(`You need to pass a query hash to the store's query method`, query);
-    assert(`Passing classes to store methods has been removed. Please pass a dasherized string instead of ${modelName}`, typeof modelName === 'string');
+    assert(`Passing classes to store methods has been removed. Please pass a dasherized string instead of ${type}`, typeof type === 'string');
     const promise = this.request({
       op: 'query',
       data: {
-        type: normalizeModelName(modelName),
+        type: normalizeModelName(type),
         query,
-        options: options || {}
+        options: options
       },
       cacheOptions: {
         [SkipCache]: true
@@ -4676,20 +4705,21 @@ class Store extends EmberObject {
      @since 1.13.0
     @method findAll
     @public
-    @param {String} modelName
-    @param {Object} options
+    @param {string} type the name of the resource
+    @param {object} options
     @return {Promise} promise
   */
-  findAll(modelName, options = {}) {
+
+  findAll(type, options = {}) {
     if (macroCondition(getOwnConfig().env.DEBUG)) {
       assertDestroyingStore(this, 'findAll');
     }
-    assert(`You need to pass a model name to the store's findAll method`, modelName);
-    assert(`Passing classes to store methods has been removed. Please pass a dasherized string instead of ${modelName}`, typeof modelName === 'string');
+    assert(`You need to pass a model name to the store's findAll method`, type);
+    assert(`Passing classes to store methods has been removed. Please pass a dasherized string instead of ${type}`, typeof type === 'string');
     const promise = this.request({
       op: 'findAll',
       data: {
-        type: normalizeModelName(modelName),
+        type: normalizeModelName(type),
         options: options || {}
       },
       cacheOptions: {
@@ -4716,17 +4746,17 @@ class Store extends EmberObject {
      @since 1.13.0
     @method peekAll
     @public
-    @param {String} modelName
+    @param {string} type the name of the resource
     @return {RecordArray}
   */
-  peekAll(modelName) {
+
+  peekAll(type) {
     if (macroCondition(getOwnConfig().env.DEBUG)) {
       assertDestroyingStore(this, 'peekAll');
     }
-    assert(`You need to pass a model name to the store's peekAll method`, modelName);
-    assert(`Passing classes to store methods has been removed. Please pass a dasherized string instead of ${modelName}`, typeof modelName === 'string');
-    const type = normalizeModelName(modelName);
-    return this.recordArrayManager.liveArrayFor(type);
+    assert(`You need to pass a model name to the store's peekAll method`, type);
+    assert(`Passing classes to store methods has been removed. Please pass a dasherized string instead of ${type}`, typeof type === 'string');
+    return this.recordArrayManager.liveArrayFor(normalizeModelName(type));
   }
 
   /**
@@ -4738,16 +4768,17 @@ class Store extends EmberObject {
     store.unloadAll('post');
     ```
      @method unloadAll
+    @param {string} type the name of the resource
     @public
-    @param {String} modelName
   */
-  unloadAll(modelName) {
+
+  unloadAll(type) {
     if (macroCondition(getOwnConfig().env.DEBUG)) {
       assertDestroyedStoreOnly(this, 'unloadAll');
     }
-    assert(`Passing classes to store methods has been removed. Please pass a dasherized string instead of ${String(modelName)}`, !modelName || typeof modelName === 'string');
+    assert(`Passing classes to store methods has been removed. Please pass a dasherized string instead of ${String(type)}`, !type || typeof type === 'string');
     this._join(() => {
-      if (modelName === undefined) {
+      if (type === undefined) {
         // destroy the graph before unloadAll
         // since then we avoid churning relationships
         // during unload
@@ -4755,8 +4786,7 @@ class Store extends EmberObject {
         this.recordArrayManager.clear();
         this._instanceCache.clear();
       } else {
-        const normalizedModelName = normalizeModelName(modelName);
-        this._instanceCache.clear(normalizedModelName);
+        this._instanceCache.clear(normalizeModelName(type));
       }
     });
   }
@@ -4944,11 +4974,13 @@ class Store extends EmberObject {
   /**
    * Trigger a save for a Record.
    *
+   * Returns a promise resolving with the same record when the save is complete.
+   *
    * @method saveRecord
    * @public
-   * @param {RecordInstance} record
+   * @param {unknown} record
    * @param options
-   * @return {Promise<RecordInstance>}
+   * @return {Promise<record>}
    */
   saveRecord(record, options = {}) {
     if (macroCondition(getOwnConfig().env.DEBUG)) {