@ember-data/model 4.12.0-beta.1 → 4.12.0-beta.10

package/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (C) 2017-2022 Ember.js contributors
+Copyright (C) 2017-2023 Ember.js contributors
 Portions Copyright (C) 2011-2017 Tilde, Inc. and contributors.
 Portions Copyright (C) 2011 LivingSocial Inc.
 

package/README.md

@@ -1,31 +1,55 @@
-@ember-data/model
-==============================================================================
+<p align="center">
+  <img
+    class="project-logo"
+    src="./ember-data-logo-dark.svg#gh-dark-mode-only"
+    alt="EmberData Model"
+    width="240px"
+    title="EmberData Model"
+    />
+  <img
+    class="project-logo"
+    src="./ember-data-logo-light.svg#gh-light-mode-only"
+    alt="EmberData Model"
+    width="240px"
+    title="EmberData Model"
+    />
+</p>
 
-[Short description of the addon.]
+<p align="center">Provides a Presentation Model for resource data in an EmberData Cache</p>
 
+This package implements the EmberData Store's `instantiateRecord` and `teardownRecord` hooks
+as well as configures an associated `SchemaService` implementation.
 
-Compatibility
-------------------------------------------------------------------------------
+Models are defined as classes extending from `import Model from '@ember-data/model';` and the
+attributes and relationships on these classes are parsed at runtime to supply static "schema"
+to EmberData's SchemaService.
 
-* Ember.js v3.4 or above
-* Ember CLI v2.13 or above
+Resource data for individual resources fetched from your API is presented to the UI via instances
+of the `Model`s you define. An instantiated `Model` is referred to as a `record`.
 
+When we refer to the `ModelClass` as opposed to a `Model` or `Record` we are referring
+specifically to the class definition and the static schema methods present on it.
 
-Installation
-------------------------------------------------------------------------------
+When we refer to a `record` we refer to a specific class instance presenting
+the resource data for a given `type` and `id`.
 
-```
-ember install @ember-data/model
-```
+  ### Defining a Model
 
+ *app/models/person.js*
+  ```ts
+  import Model, { attr, belongsTo, hasMany } from '@ember-data/model';
 
-Usage
-------------------------------------------------------------------------------
+  export default class PersonModel extends Model {
+    @attr name;
 
-[Longer description of how to use the addon in apps.]
+    @belongsTo('pet', { inverse: 'owners', async: false }) dog;
 
+    @hasMany('person', { inverse: 'friends', async: true }) friends;
+  }
+  ```
 
-License
-------------------------------------------------------------------------------
+  ### modelName convention
 
-This project is licensed under the [MIT License](LICENSE.md).
+  By convention, the name of a given model (its `type`) matches the name
+  of the file in the `app/models` folder and should be lowercase, singular
+  and dasherized.

package/addon/-private.js

@@ -1,5 +1,5 @@
-import { M as Model } from "./has-many-0b8d932c";
-export { E as Errors, L as LEGACY_SUPPORT, R as ManyArray, P as PromiseBelongsTo, c as PromiseManyArray, a as attr, b as belongsTo, h as hasMany } from "./has-many-0b8d932c";
+import { M as Model } from "./has-many-2eb0dc13";
+export { E as Errors, L as LEGACY_SUPPORT, R as ManyArray, P as PromiseBelongsTo, c as PromiseManyArray, a as attr, b as belongsTo, h as hasMany } from "./has-many-2eb0dc13";
 import { getOwner } from '@ember/application';
 
 /*
@@ -34,62 +34,4 @@ function modelForMixin(store, normalizedModelName) {
   }
   return owner.factoryFor(`model:${normalizedModelName}`);
 }
-
-/**
-  @module @ember-data/model
-*/
-
-/**
-  @method diffArray
-  @internal
-  @param {Array} oldArray the old array
-  @param {Array} newArray the new array
-  @return {hash} {
-      firstChangeIndex: <integer>,  // null if no change
-      addedCount: <integer>,        // 0 if no change
-      removedCount: <integer>       // 0 if no change
-    }
-*/
-function diffArray(oldArray, newArray) {
-  const oldLength = oldArray.length;
-  const newLength = newArray.length;
-  const shortestLength = Math.min(oldLength, newLength);
-  let firstChangeIndex = null; // null signifies no changes
-
-  // find the first change
-  for (let i = 0; i < shortestLength; i++) {
-    // compare each item in the array
-    if (oldArray[i] !== newArray[i]) {
-      firstChangeIndex = i;
-      break;
-    }
-  }
-  if (firstChangeIndex === null && newLength !== oldLength) {
-    // no change found in the overlapping block
-    // and array lengths differ,
-    // so change starts at end of overlap
-    firstChangeIndex = shortestLength;
-  }
-  let addedCount = 0;
-  let removedCount = 0;
-  if (firstChangeIndex !== null) {
-    // we found a change, find the end of the change
-    let unchangedEndBlockLength = shortestLength - firstChangeIndex;
-    // walk back from the end of both arrays until we find a change
-    for (let i = 1; i <= shortestLength; i++) {
-      // compare each item in the array
-      if (oldArray[oldLength - i] !== newArray[newLength - i]) {
-        unchangedEndBlockLength = i - 1;
-        break;
-      }
-    }
-    addedCount = newLength - unchangedEndBlockLength - firstChangeIndex;
-    removedCount = oldLength - unchangedEndBlockLength - firstChangeIndex;
-  }
-  return {
-    firstChangeIndex,
-    addedCount,
-    removedCount
-  };
-}
-export { Model, modelForMixin as _modelForMixin, diffArray };
+export { Model, modelForMixin as _modelForMixin };

package/addon/-private.js.map

@@ -1 +1 @@
-{"version":3,"file":"-private.js","sources":["../src/-private/model-for-mixin.ts","../src/-private/diff-array.ts"],"sourcesContent":["import { getOwner } from '@ember/application';\n\nimport type Store from '@ember-data/store';\n\nimport Model from './model';\n\n/*\n    In case someone defined a relationship to a mixin, for example:\n    ```\n      import Model, { belongsTo, hasMany } from '@ember-data/model';\n      import Mixin from '@ember/object/mixin';\n\n      class CommentModel extends Model {\n        @belongsTo('commentable', { polymorphic: true }) owner;\n      }\n\n      let Commentable = Mixin.create({\n        @hasMany('comment') comments;\n      });\n    ```\n    we want to look up a Commentable class which has all the necessary\n    relationship meta data. Thus, we look up the mixin and create a mock\n    Model, so we can access the relationship CPs of the mixin (`comments`)\n    in this case\n  */\nexport default function modelForMixin(store: Store, normalizedModelName: string): Model | null {\n  let owner: any = getOwner(store);\n  let MaybeMixin = owner.factoryFor(`mixin:${normalizedModelName}`);\n  let mixin = MaybeMixin && MaybeMixin.class;\n  if (mixin) {\n    let ModelForMixin = Model.extend(mixin);\n    ModelForMixin.__isMixin = true;\n    ModelForMixin.__mixin = mixin;\n    //Cache the class as a model\n    owner.register('model:' + normalizedModelName, ModelForMixin);\n  }\n  return owner.factoryFor(`model:${normalizedModelName}`);\n}\n","/**\n  @module @ember-data/model\n*/\n\nexport interface ArrayDiffResult {\n  firstChangeIndex: number | null;\n  removedCount: number;\n  addedCount: number;\n}\n\n/**\n  @method diffArray\n  @internal\n  @param {Array} oldArray the old array\n  @param {Array} newArray the new array\n  @return {hash} {\n      firstChangeIndex: <integer>,  // null if no change\n      addedCount: <integer>,        // 0 if no change\n      removedCount: <integer>       // 0 if no change\n    }\n*/\nexport default function diffArray(oldArray: unknown[], newArray: unknown[]): ArrayDiffResult {\n  const oldLength = oldArray.length;\n  const newLength = newArray.length;\n\n  const shortestLength = Math.min(oldLength, newLength);\n  let firstChangeIndex: number | null = null; // null signifies no changes\n\n  // find the first change\n  for (let i = 0; i < shortestLength; i++) {\n    // compare each item in the array\n    if (oldArray[i] !== newArray[i]) {\n      firstChangeIndex = i;\n      break;\n    }\n  }\n\n  if (firstChangeIndex === null && newLength !== oldLength) {\n    // no change found in the overlapping block\n    // and array lengths differ,\n    // so change starts at end of overlap\n    firstChangeIndex = shortestLength;\n  }\n\n  let addedCount = 0;\n  let removedCount = 0;\n  if (firstChangeIndex !== null) {\n    // we found a change, find the end of the change\n    let unchangedEndBlockLength = shortestLength - firstChangeIndex;\n    // walk back from the end of both arrays until we find a change\n    for (let i = 1; i <= shortestLength; i++) {\n      // compare each item in the array\n      if (oldArray[oldLength - i] !== newArray[newLength - i]) {\n        unchangedEndBlockLength = i - 1;\n        break;\n      }\n    }\n    addedCount = newLength - unchangedEndBlockLength - firstChangeIndex;\n    removedCount = oldLength - unchangedEndBlockLength - firstChangeIndex;\n  }\n\n  return {\n    firstChangeIndex,\n    addedCount,\n    removedCount,\n  };\n}\n"],"names":["modelForMixin","store","normalizedModelName","owner","getOwner","MaybeMixin","factoryFor","mixin","class","ModelForMixin","Model","extend","__isMixin","__mixin","register","diffArray","oldArray","newArray","oldLength","length","newLength","shortestLength","Math","min","firstChangeIndex","i","addedCount","removedCount","unchangedEndBlockLength"],"mappings":";;;;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,SAASA,aAAaA,CAACC,KAAY,EAAEC,mBAA2B,EAAgB;AAC7F,EAAA,IAAIC,KAAU,GAAGC,QAAQ,CAACH,KAAK,CAAC,CAAA;EAChC,IAAII,UAAU,GAAGF,KAAK,CAACG,UAAU,CAAE,CAAA,MAAA,EAAQJ,mBAAoB,CAAA,CAAC,CAAC,CAAA;AACjE,EAAA,IAAIK,KAAK,GAAGF,UAAU,IAAIA,UAAU,CAACG,KAAK,CAAA;AAC1C,EAAA,IAAID,KAAK,EAAE;AACT,IAAA,IAAIE,aAAa,GAAGC,KAAK,CAACC,MAAM,CAACJ,KAAK,CAAC,CAAA;IACvCE,aAAa,CAACG,SAAS,GAAG,IAAI,CAAA;IAC9BH,aAAa,CAACI,OAAO,GAAGN,KAAK,CAAA;AAC7B;IACAJ,KAAK,CAACW,QAAQ,CAAC,QAAQ,GAAGZ,mBAAmB,EAAEO,aAAa,CAAC,CAAA;AAC/D,GAAA;AACA,EAAA,OAAON,KAAK,CAACG,UAAU,CAAE,CAAQJ,MAAAA,EAAAA,mBAAoB,EAAC,CAAC,CAAA;AACzD;;ACrCA;AACA;AACA;;AAQA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,SAASa,SAASA,CAACC,QAAmB,EAAEC,QAAmB,EAAmB;AAC3F,EAAA,MAAMC,SAAS,GAAGF,QAAQ,CAACG,MAAM,CAAA;AACjC,EAAA,MAAMC,SAAS,GAAGH,QAAQ,CAACE,MAAM,CAAA;EAEjC,MAAME,cAAc,GAAGC,IAAI,CAACC,GAAG,CAACL,SAAS,EAAEE,SAAS,CAAC,CAAA;AACrD,EAAA,IAAII,gBAA+B,GAAG,IAAI,CAAC;;AAE3C;EACA,KAAK,IAAIC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGJ,cAAc,EAAEI,CAAC,EAAE,EAAE;AACvC;IACA,IAAIT,QAAQ,CAACS,CAAC,CAAC,KAAKR,QAAQ,CAACQ,CAAC,CAAC,EAAE;AAC/BD,MAAAA,gBAAgB,GAAGC,CAAC,CAAA;AACpB,MAAA,MAAA;AACF,KAAA;AACF,GAAA;AAEA,EAAA,IAAID,gBAAgB,KAAK,IAAI,IAAIJ,SAAS,KAAKF,SAAS,EAAE;AACxD;AACA;AACA;AACAM,IAAAA,gBAAgB,GAAGH,cAAc,CAAA;AACnC,GAAA;EAEA,IAAIK,UAAU,GAAG,CAAC,CAAA;EAClB,IAAIC,YAAY,GAAG,CAAC,CAAA;EACpB,IAAIH,gBAAgB,KAAK,IAAI,EAAE;AAC7B;AACA,IAAA,IAAII,uBAAuB,GAAGP,cAAc,GAAGG,gBAAgB,CAAA;AAC/D;IACA,KAAK,IAAIC,CAAC,GAAG,CAAC,EAAEA,CAAC,IAAIJ,cAAc,EAAEI,CAAC,EAAE,EAAE;AACxC;AACA,MAAA,IAAIT,QAAQ,CAACE,SAAS,GAAGO,CAAC,CAAC,KAAKR,QAAQ,CAACG,SAAS,GAAGK,CAAC,CAAC,EAAE;QACvDG,uBAAuB,GAAGH,CAAC,GAAG,CAAC,CAAA;AAC/B,QAAA,MAAA;AACF,OAAA;AACF,KAAA;AACAC,IAAAA,UAAU,GAAGN,SAAS,GAAGQ,uBAAuB,GAAGJ,gBAAgB,CAAA;AACnEG,IAAAA,YAAY,GAAGT,SAAS,GAAGU,uBAAuB,GAAGJ,gBAAgB,CAAA;AACvE,GAAA;EAEA,OAAO;IACLA,gBAAgB;IAChBE,UAAU;AACVC,IAAAA,YAAAA;GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"-private.js","sources":["../src/-private/model-for-mixin.ts"],"sourcesContent":["import { getOwner } from '@ember/application';\n\nimport type Store from '@ember-data/store';\n\nimport Model from './model';\n\n/*\n    In case someone defined a relationship to a mixin, for example:\n    ```\n      import Model, { belongsTo, hasMany } from '@ember-data/model';\n      import Mixin from '@ember/object/mixin';\n\n      class CommentModel extends Model {\n        @belongsTo('commentable', { polymorphic: true }) owner;\n      }\n\n      let Commentable = Mixin.create({\n        @hasMany('comment') comments;\n      });\n    ```\n    we want to look up a Commentable class which has all the necessary\n    relationship meta data. Thus, we look up the mixin and create a mock\n    Model, so we can access the relationship CPs of the mixin (`comments`)\n    in this case\n  */\nexport default function modelForMixin(store: Store, normalizedModelName: string): Model | null {\n  let owner: any = getOwner(store);\n  let MaybeMixin = owner.factoryFor(`mixin:${normalizedModelName}`);\n  let mixin = MaybeMixin && MaybeMixin.class;\n  if (mixin) {\n    let ModelForMixin = Model.extend(mixin);\n    ModelForMixin.__isMixin = true;\n    ModelForMixin.__mixin = mixin;\n    //Cache the class as a model\n    owner.register('model:' + normalizedModelName, ModelForMixin);\n  }\n  return owner.factoryFor(`model:${normalizedModelName}`);\n}\n"],"names":["modelForMixin","store","normalizedModelName","owner","getOwner","MaybeMixin","factoryFor","mixin","class","ModelForMixin","Model","extend","__isMixin","__mixin","register"],"mappings":";;;;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,SAASA,aAAaA,CAACC,KAAY,EAAEC,mBAA2B,EAAgB;AAC7F,EAAA,IAAIC,KAAU,GAAGC,QAAQ,CAACH,KAAK,CAAC,CAAA;EAChC,IAAII,UAAU,GAAGF,KAAK,CAACG,UAAU,CAAE,CAAA,MAAA,EAAQJ,mBAAoB,CAAA,CAAC,CAAC,CAAA;AACjE,EAAA,IAAIK,KAAK,GAAGF,UAAU,IAAIA,UAAU,CAACG,KAAK,CAAA;AAC1C,EAAA,IAAID,KAAK,EAAE;AACT,IAAA,IAAIE,aAAa,GAAGC,KAAK,CAACC,MAAM,CAACJ,KAAK,CAAC,CAAA;IACvCE,aAAa,CAACG,SAAS,GAAG,IAAI,CAAA;IAC9BH,aAAa,CAACI,OAAO,GAAGN,KAAK,CAAA;AAC7B;IACAJ,KAAK,CAACW,QAAQ,CAAC,QAAQ,GAAGZ,mBAAmB,EAAEO,aAAa,CAAC,CAAA;AAC/D,GAAA;AACA,EAAA,OAAON,KAAK,CAACG,UAAU,CAAE,CAAQJ,MAAAA,EAAAA,mBAAoB,EAAC,CAAC,CAAA;AACzD;;;;"}