@ember-data/model 4.12.8 → 4.13.0-alpha.1

package/unstable-preview-types/-private/many-array.d.ts

@@ -0,0 +1,196 @@
+declare module '@ember-data/model/-private/many-array' {
+  import type Store from '@ember-data/store';
+  import type { CreateRecordProperties, NativeProxy } from '@ember-data/store/-private';
+  import { LiveArray, MUTATE } from '@ember-data/store/-private';
+  import type { BaseFinderOptions, ModelSchema } from '@ember-data/store/types';
+  import type { Signal } from '@ember-data/tracking/-private';
+  import type { StableRecordIdentifier } from '@warp-drive/core-types';
+  import type { Cache } from '@warp-drive/core-types/cache';
+  import type { TypedRecordInstance, TypeFromInstance, TypeFromInstanceOrString } from '@warp-drive/core-types/record';
+  import type { Links, PaginationLinks } from '@warp-drive/core-types/spec/json-api-raw';
+  import type { LegacySupport } from '@ember-data/model/-private/legacy-relationships-support';
+  export interface ManyArrayCreateArgs<T> {
+      identifiers: StableRecordIdentifier<TypeFromInstanceOrString<T>>[];
+      type: TypeFromInstanceOrString<T>;
+      store: Store;
+      allowMutation: boolean;
+      manager: LegacySupport;
+      identifier: StableRecordIdentifier;
+      cache: Cache;
+      meta: Record<string, unknown> | null;
+      links: Links | PaginationLinks | null;
+      key: string;
+      isPolymorphic: boolean;
+      isAsync: boolean;
+      _inverseIsAsync: boolean;
+      isLoaded: boolean;
+  }
+  /**
+    A `ManyArray` is a `MutableArray` that represents the contents of a has-many
+    relationship.
+  
+    The `ManyArray` is instantiated lazily the first time the relationship is
+    requested.
+  
+    This class is not intended to be directly instantiated by consuming applications.
+  
+    ### Inverses
+  
+    Often, the relationships in Ember Data applications will have
+    an inverse. For example, imagine the following models are
+    defined:
+  
+    ```app/models/post.js
+    import Model, { hasMany } from '@ember-data/model';
+  
+    export default class PostModel extends Model {
+      @hasMany('comment') comments;
+    }
+    ```
+  
+    ```app/models/comment.js
+    import Model, { belongsTo } from '@ember-data/model';
+  
+    export default class CommentModel extends Model {
+      @belongsTo('post') post;
+    }
+    ```
+  
+    If you created a new instance of `Post` and added
+    a `Comment` record to its `comments` has-many
+    relationship, you would expect the comment's `post`
+    property to be set to the post that contained
+    the has-many.
+  
+    We call the record to which a relationship belongs-to the
+    relationship's _owner_.
+  
+    @class ManyArray
+    @public
+  */
+  export class RelatedCollection<T = unknown> extends LiveArray<T> {
+      isAsync: boolean;
+      /**
+        The loading state of this array
+    
+        @property {Boolean} isLoaded
+        @public
+        */
+      isLoaded: boolean;
+      /**
+        `true` if the relationship is polymorphic, `false` otherwise.
+    
+        @property {Boolean} isPolymorphic
+        @private
+        */
+      isPolymorphic: boolean;
+      _inverseIsAsync: boolean;
+      /**
+        Metadata associated with the request for async hasMany relationships.
+    
+        Example
+    
+        Given that the server returns the following JSON payload when fetching a
+        hasMany relationship:
+    
+        ```js
+        {
+          "comments": [{
+            "id": 1,
+            "comment": "This is the first comment",
+          }, {
+        // ...
+          }],
+    
+          "meta": {
+            "page": 1,
+            "total": 5
+          }
+        }
+        ```
+    
+        You can then access the meta data via the `meta` property:
+    
+        ```js
+        let comments = await post.comments;
+        let meta = comments.meta;
+    
+        // meta.page => 1
+        // meta.total => 5
+        ```
+    
+        @property {Object | null} meta
+        @public
+        */
+      meta: Record<string, unknown> | null;
+      /**
+         * Retrieve the links for this relationship
+         *
+         @property {Object | null} links
+         @public
+         */
+      links: Links | PaginationLinks | null;
+      identifier: StableRecordIdentifier;
+      cache: Cache;
+      _manager: LegacySupport;
+      store: Store;
+      key: string;
+      type: ModelSchema;
+      modelName: T extends TypedRecordInstance ? TypeFromInstance<T> : string;
+      constructor(options: ManyArrayCreateArgs<T>);
+      [MUTATE](target: StableRecordIdentifier[], receiver: typeof NativeProxy<StableRecordIdentifier[], T[]>, prop: string, args: unknown[], _SIGNAL: Signal): unknown;
+      notify(): void;
+      /**
+        Reloads all of the records in the manyArray. If the manyArray
+        holds a relationship that was originally fetched using a links url
+        EmberData will revisit the original links url to repopulate the
+        relationship.
+    
+        If the ManyArray holds the result of a `store.query()` reload will
+        re-run the original query.
+    
+        Example
+    
+        ```javascript
+        let user = store.peekRecord('user', '1')
+        await login(user);
+    
+        let permissions = await user.permissions;
+        await permissions.reload();
+        ```
+    
+        @method reload
+        @public
+      */
+      reload(options?: BaseFinderOptions): Promise<this>;
+      /**
+        Saves all of the records in the `ManyArray`.
+    
+        Example
+    
+        ```javascript
+        let inbox = await store.findRecord('inbox', '1');
+        let messages = await inbox.messages;
+        messages.forEach((message) => {
+          message.isRead = true;
+        });
+        messages.save();
+        ```
+    
+        @method save
+        @public
+        @return {PromiseArray} promise
+      */
+      /**
+        Create a child record within the owner
+    
+        @method createRecord
+        @public
+        @param {Object} hash
+        @return {Model} record
+      */
+      createRecord(hash: CreateRecordProperties<T>): T;
+      destroy(): void;
+  }
+}
+//# sourceMappingURL=many-array.d.ts.map

package/unstable-preview-types/-private/many-array.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"many-array.d.ts","sourceRoot":"","sources":["../../src/-private/many-array.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAC3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACtF,OAAO,EAGL,SAAS,EACT,MAAM,EAIP,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC9E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AAQ5D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,KAAK,EAEV,mBAAmB,EACnB,gBAAgB,EAChB,wBAAwB,EACzB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,KAAK,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAEvF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAIpE,MAAM,WAAW,mBAAmB,CAAC,CAAC;IACpC,WAAW,EAAE,sBAAsB,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACnE,IAAI,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC;IAClC,KAAK,EAAE,KAAK,CAAC;IACb,aAAa,EAAE,OAAO,CAAC;IACvB,OAAO,EAAE,aAAa,CAAC;IAEvB,UAAU,EAAE,sBAAsB,CAAC;IACnC,KAAK,EAAE,KAAK,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACrC,KAAK,EAAE,KAAK,GAAG,eAAe,GAAG,IAAI,CAAC;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,aAAa,EAAE,OAAO,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,OAAO,CAAC;IACzB,QAAQ,EAAE,OAAO,CAAC;CACnB;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0CE;AACF,qBAAa,iBAAiB,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,SAAS,CAAC,CAAC,CAAC;IACtD,OAAO,EAAE,OAAO,CAAC;IACzB;;;;;QAKI;IAEI,QAAQ,EAAE,OAAO,CAAC;IAC1B;;;;;QAKI;IACI,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,EAAE,OAAO,CAAC;IACjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAoCI;IACI,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC7C;;;;;SAKK;IACG,KAAK,EAAE,KAAK,GAAG,eAAe,GAAG,IAAI,CAAC;IACtC,UAAU,EAAE,sBAAsB,CAAC;IACnC,KAAK,EAAE,KAAK,CAAC;IACb,QAAQ,EAAE,aAAa,CAAC;IACxB,KAAK,EAAE,KAAK,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE,CAAC,SAAS,mBAAmB,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;gBAEpE,OAAO,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAS3C,CAAC,MAAM,CAAC,CACN,MAAM,EAAE,sBAAsB,EAAE,EAChC,QAAQ,EAAE,OAAO,WAAW,CAAC,sBAAsB,EAAE,EAAE,CAAC,EAAE,CAAC,EAC3D,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,OAAO,EAAE,EACf,OAAO,EAAE,MAAM,GACd,OAAO;IA6MV,MAAM;IAMN;;;;;;;;;;;;;;;;;;;;;MAqBE;IACF,MAAM,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAKlD;;;;;;;;;;;;;;;;;MAiBE;IAEF;;;;;;;MAOE;IACF,YAAY,CAAC,IAAI,EAAE,sBAAsB,CAAC,CAAC,CAAC,GAAG,CAAC;IAShD,OAAO;CAGR"}

package/unstable-preview-types/-private/model-for-mixin.d.ts

@@ -0,0 +1,6 @@
+declare module '@ember-data/model/-private/model-for-mixin' {
+  import type Store from '@ember-data/store';
+  import { type ModelFactory } from '@ember-data/model/-private/model';
+  export default function modelForMixin(store: Store, normalizedModelName: string): ModelFactory | undefined;
+}
+//# sourceMappingURL=model-for-mixin.d.ts.map

package/unstable-preview-types/-private/model-for-mixin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-for-mixin.d.ts","sourceRoot":"","sources":["../../src/-private/model-for-mixin.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAE3C,OAAO,EAAS,KAAK,YAAY,EAAE,MAAM,SAAS,CAAC;AAkBnD,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,KAAK,EAAE,KAAK,EAAE,mBAAmB,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAYzG"}

package/unstable-preview-types/-private/model-methods.d.ts

@@ -0,0 +1,37 @@
+declare module '@ember-data/model/-private/model-methods' {
+  import type { Snapshot } from '@ember-data/legacy-compat/-private';
+  import type Store from '@ember-data/store';
+  import type { ChangedAttributesHash } from '@warp-drive/core-types/cache';
+  import { RecordStore } from '@warp-drive/core-types/symbols';
+  import type { Errors } from '@ember-data/model/-private/errors';
+  import type RecordState from '@ember-data/model/-private/record-state';
+  import type BelongsToReference from '@ember-data/model/-private/references/belongs-to';
+  import type HasManyReference from '@ember-data/model/-private/references/has-many';
+  import type { MaybeBelongsToFields, MaybeHasManyFields } from '@ember-data/model/-private/type-utils';
+  export interface MinimalLegacyRecord {
+      errors: Errors;
+      ___recordState: RecordState;
+      currentState: RecordState;
+      isDestroyed: boolean;
+      isDestroying: boolean;
+      isReloading: boolean;
+      isValid: boolean;
+      [RecordStore]: Store;
+      deleteRecord(): void;
+      unloadRecord(): void;
+      save<T extends MinimalLegacyRecord>(this: T, options?: Record<string, unknown>): Promise<this>;
+      destroyRecord<T extends MinimalLegacyRecord>(this: T, options?: Record<string, unknown>): Promise<this>;
+  }
+  export function rollbackAttributes<T extends MinimalLegacyRecord>(this: T): void;
+  export function unloadRecord<T extends MinimalLegacyRecord>(this: T): void;
+  export function belongsTo<T extends MinimalLegacyRecord, K extends MaybeBelongsToFields<T>>(this: T, prop: K): BelongsToReference<T, K>;
+  export function hasMany<T extends MinimalLegacyRecord, K extends MaybeHasManyFields<T>>(this: T, prop: K): HasManyReference<T, K>;
+  export function reload<T extends MinimalLegacyRecord>(this: T, options?: Record<string, unknown>): Promise<T>;
+  export function changedAttributes<T extends MinimalLegacyRecord>(this: T): ChangedAttributesHash;
+  export function serialize<T extends MinimalLegacyRecord>(this: T, options?: Record<string, unknown>): unknown;
+  export function deleteRecord<T extends MinimalLegacyRecord>(this: T): void;
+  export function save<T extends MinimalLegacyRecord>(this: T, options?: Record<string, unknown>): Promise<T>;
+  export function destroyRecord<T extends MinimalLegacyRecord>(this: T, options?: Record<string, unknown>): Promise<T>;
+  export function createSnapshot<T extends MinimalLegacyRecord>(this: T): Snapshot<T>;
+}
+//# sourceMappingURL=model-methods.d.ts.map

package/unstable-preview-types/-private/model-methods.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-methods.d.ts","sourceRoot":"","sources":["../../src/-private/model-methods.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oCAAoC,CAAC;AAEnE,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAK3C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAG7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,OAAO,KAAK,WAAW,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,kBAAkB,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,gBAAgB,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAE7E,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,WAAW,CAAC;IAC5B,YAAY,EAAE,WAAW,CAAC;IAC1B,WAAW,EAAE,OAAO,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,CAAC,WAAW,CAAC,EAAE,KAAK,CAAC;IAErB,YAAY,IAAI,IAAI,CAAC;IACrB,YAAY,IAAI,IAAI,CAAC;IACrB,IAAI,CAAC,CAAC,SAAS,mBAAmB,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/F,aAAa,CAAC,CAAC,SAAS,mBAAmB,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzG;AAED,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,mBAAmB,EAAE,IAAI,EAAE,CAAC,QAYxE;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,mBAAmB,EAAE,IAAI,EAAE,CAAC,QAKlE;AAED,wBAAgB,SAAS,CAAC,CAAC,SAAS,mBAAmB,EAAE,CAAC,SAAS,oBAAoB,CAAC,CAAC,CAAC,EACxF,IAAI,EAAE,CAAC,EACP,IAAI,EAAE,CAAC,GACN,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAE1B;AAED,wBAAgB,OAAO,CAAC,CAAC,SAAS,mBAAmB,EAAE,CAAC,SAAS,kBAAkB,CAAC,CAAC,CAAC,EACpF,IAAI,EAAE,CAAC,EACP,IAAI,EAAE,CAAC,GACN,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,CAExB;AAED,wBAAgB,MAAM,CAAC,CAAC,SAAS,mBAAmB,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CA0BhH;AAED,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,mBAAmB,EAAE,IAAI,EAAE,CAAC,GAAG,qBAAqB,CAE/F;AAED,wBAAgB,SAAS,CAAC,CAAC,SAAS,mBAAmB,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAG5G;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,mBAAmB,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,CAKzE;AAED,wBAAgB,IAAI,CAAC,CAAC,SAAS,mBAAmB,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAe1G;AAED,wBAAgB,aAAa,CAAC,CAAC,SAAS,mBAAmB,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAYnH;AAED,wBAAgB,cAAc,CAAC,CAAC,SAAS,mBAAmB,EAAE,IAAI,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAalF"}