@ember-data/legacy-compat 5.3.3 → 5.3.4

package/unstable-preview-types/legacy-network-handler/minimum-serializer-interface.d.ts

@@ -0,0 +1,235 @@
+declare module '@ember-data/legacy-compat/legacy-network-handler/minimum-serializer-interface' {
+  /**
+    @module @ember-data/experimental-preview-types
+   */
+  import type Store from '@ember-data/store';
+  import type { ModelSchema } from '@ember-data/store/types';
+  import type { ObjectValue } from '@warp-drive/core-types/json/raw';
+  import type { JsonApiDocument, SingleResourceDocument } from '@warp-drive/core-types/spec/json-api-raw';
+  import type { AdapterPayload } from '@ember-data/legacy-compat/legacy-network-handler/minimum-adapter-interface';
+  import type { Snapshot } from '@ember-data/legacy-compat/legacy-network-handler/snapshot';
+  export type SerializerOptions = {
+      includeId?: boolean;
+  };
+  export type RequestType = 'findRecord' | 'queryRecord' | 'findAll' | 'findBelongsTo' | 'findHasMany' | 'findMany' | 'query' | 'createRecord' | 'deleteRecord' | 'updateRecord';
+  /**
+   * <blockquote style="margin: 1em; padding: .1em 1em .1em 1em; border-left: solid 1em #E34C32; background: #e0e0e0;">
+    <p>
+      ⚠️ <strong>This is LEGACY documentation</strong> for a feature that is no longer encouraged to be used.
+      If starting a new app or thinking of implementing a new adapter, consider writing a
+      <a href="/ember-data/release/classes/%3CInterface%3E%20Handler">Handler</a> instead to be used with the <a href="https://github.com/emberjs/data/tree/main/packages/request#readme">RequestManager</a>
+    </p>
+    </blockquote>
+  
+    The following documentation describes the methods an application
+    serializer should implement with descriptions around when an
+    application might expect these methods to be called.
+  
+    Methods that are not required are marked as **optional**.
+  
+    @class <Interface> Serializer
+    @public
+  */
+  export interface MinimumSerializerInterface {
+      /**
+       * This method is responsible for normalizing the value resolved from the promise returned
+       * by an Adapter request into the format expected by the `Store`.
+       *
+       * The output should be a [JSON:API Document](https://jsonapi.org/format/#document-structure)
+       * with the following additional restrictions:
+       *
+       * - `type` should be formatted in the `singular` `dasherized` `lowercase` form
+       * - `members` (the property names of attributes and relationships) should be formatted
+       *    to match their definition in the corresponding `Model` definition. Typically this
+       *    will be `camelCase`.
+       * - [`lid`](https://github.com/emberjs/rfcs/blob/main/text/0403-ember-data-identifiers.md) is
+       *    a valid optional sibling to `id` and `type` in both [Resources](https://jsonapi.org/format/#document-resource-objects)
+       *    and [Resource Identifier Objects](https://jsonapi.org/format/#document-resource-identifier-objects)
+       *
+       * @method normalizeResponse
+       * @public
+       * @param {Store} store The store service that initiated the request being normalized
+       * @param {ModelSchema} schema An object with methods for accessing information about
+       *  the type, attributes and relationships of the primary type associated with the request.
+       * @param {JSONObject} rawPayload The raw JSON response data returned from an API request.
+       *  This correlates to the value the promise returned by the adapter method that performed
+       *  the request resolved to.
+       * @param {string|null} id For a findRecord request, this is the id initially provided
+       *  in the call to store.findRecord. Else this value is null.
+       * @param {'findRecord' | 'queryRecord' | 'findAll' | 'findBelongsTo' | 'findHasMany' | 'findMany' | 'query' | 'createRecord' | 'deleteRecord' | 'updateRecord'} requestType The
+       *  type of request the Adapter had been asked to perform.
+       *
+       * @return {JsonApiDocument} a document following the structure of a JSON:API Document.
+       */
+      normalizeResponse(store: Store, schema: ModelSchema, rawPayload: AdapterPayload, id: string | null, requestType: 'findRecord' | 'queryRecord' | 'findAll' | 'findBelongsTo' | 'findHasMany' | 'findMany' | 'query' | 'createRecord' | 'deleteRecord' | 'updateRecord'): JsonApiDocument;
+      /**
+       * This method is responsible for serializing an individual record
+       * via a [Snapshot](Snapshot) into the format expected by the API.
+       *
+       * This method is called by `snapshot.serialize()`.
+       *
+       * When using `Model`, this method is called by `record.serialize()`.
+       *
+       * When using `JSONAPIAdapter` or `RESTAdapter` this method is called
+       * by `updateRecord` and `createRecord` if `Serializer.serializeIntoHash`
+       * is not implemented.
+       *
+       * @method serialize
+       * @public
+       * @param {Snapshot} snapshot A Snapshot for the record to serialize
+       * @param {object} [options]
+       */
+      serialize(snapshot: Snapshot, options?: SerializerOptions): ObjectValue;
+      /**
+       * This method is intended to normalize data into a [JSON:API Document](https://jsonapi.org/format/#document-structure)
+       * with a data member containing a single [Resource](https://jsonapi.org/format/#document-resource-objects).
+       *
+       * - `type` should be formatted in the singular, dasherized and lowercase form
+       * - `members` (the property names of attributes and relationships) should be formatted
+       *    to match their definition in the corresponding `Model` definition. Typically this
+       *    will be `camelCase`.
+       * - [`lid`](https://github.com/emberjs/rfcs/blob/main/text/0403-ember-data-identifiers.md) is
+       *    a valid optional sibling to `id` and `type` in both [Resources](https://jsonapi.org/format/#document-resource-objects)
+       *    and [Resource Identifier Objects](https://jsonapi.org/format/#document-resource-identifier-objects)
+       *
+       * This method is called by the `Store` when `store.normalize(modelName, payload)` is
+       * called. It is recommended to use `store.serializerFor(modelName).normalizeResponse`
+       * over `store.normalize`.
+       *
+       * This method may be called when also using the `RESTSerializer`
+       * when `serializer.pushPayload` is called by `store.pushPayload`.
+       * However, it is recommended to use `store.push` over `store.pushPayload` after normalizing
+       * the payload directly.
+       *
+       * Example:
+       * ```js
+       * function pushPayload(store, modelName, rawPayload) {
+       *   const ModelClass = store.modelFor(modelName);
+       *   const serializer = store.serializerFor(modelName);
+       *   const jsonApiPayload = serializer.normalizeResponse(store, ModelClass, rawPayload, null, 'query');
+       *
+       *   return store.push(jsonApiPayload);
+       * }
+       * ```
+       *
+       * This method may be called when also using the `JSONAPISerializer`
+       * when normalizing included records. If mixing serializer usage in this way
+       * we recommend implementing this method, but caution that it may lead
+       * to unexpected mixing of formats.
+       *
+       * This method may also be called when normalizing embedded relationships when
+       * using the `EmbeddedRecordsMixin`. If using this mixin in a serializer in
+       * your application we recommend implementing this method, but caution that
+       * it may lead to unexpected mixing of formats.
+       *
+       * @method normalize [OPTIONAL]
+       * @public
+       * @optional
+       * @param {ModelSchema} schema An object with methods for accessing information about
+       *  the type, attributes and relationships of the primary type associated with the request.
+       * @param {JSONObject} rawPayload Some raw JSON data to be normalized into a JSON:API Resource.
+       * @param {string} [prop] When called by the EmbeddedRecordsMixin this param will be the
+       *  property at which the object provided as rawPayload was found.
+       * @return {SingleResourceDocument} A JSON:API Document
+       *  containing a single JSON:API Resource
+       *  as its primary data.
+       */
+      normalize?(schema: ModelSchema, rawPayload: ObjectValue, prop?: string): SingleResourceDocument;
+      /**
+       * When using `JSONAPIAdapter` or `RESTAdapter` this method is called
+       * by `adapter.updateRecord` and `adapter.createRecord` if `serializer.serializeIntoHash`
+       * is implemented. If this method is not implemented, `serializer.serialize`
+       * will be called in this case.
+       *
+       * You can use this method to customize the root keys serialized into the payload.
+       * The hash property should be modified by reference.
+       *
+       * For instance, your API may expect resources to be keyed by underscored type in the payload:
+       *
+       * ```js
+       * {
+       *   _user: {
+       *     type: 'user',
+       *     id: '1'
+       *   }
+       * }
+       * ```
+       *
+       * Which when using these adapters can be achieved by implementing this method similar
+       * to the following:
+       *
+       * ```js
+       * serializeIntoHash(hash, ModelClass, snapshot, options) {
+       *   hash[`_${snapshot.modelName}`] = this.serialize(snapshot, options).data;
+       * }
+       * ```
+       *
+       * @method serializeIntoHash [OPTIONAL]
+       * @public
+       * @optional
+       * @param hash A top most object of the request payload onto
+       *  which to append the serialized record
+       * @param {ModelSchema} schema An object with methods for accessing information about
+       *  the type, attributes and relationships of the primary type associated with the request.
+       * @param {Snapshot} snapshot A Snapshot for the record to serialize
+       * @param [options]
+       * @return {void}
+       */
+      serializeIntoHash?(hash: object, schema: ModelSchema, snapshot: Snapshot, options?: SerializerOptions): void;
+      /**
+       * This method allows for normalization of data when `store.pushPayload` is called
+       * and should be implemented if you want to use that method.
+       *
+       * The method is responsible for pushing new data to the store using `store.push`
+       * once any necessary normalization has occurred, and no data in the store will be
+       * updated unless it does so.
+       *
+       * The normalized form pushed to the store should be a [JSON:API Document](https://jsonapi.org/format/#document-structure)
+       * with the following additional restrictions:
+       *
+       * - `type` should be formatted in the singular, dasherized and lowercase form
+       * - `members` (the property names of attributes and relationships) should be formatted
+       *    to match their definition in the corresponding `Model` definition. Typically this
+       *    will be `camelCase`.
+       * - [`lid`](https://github.com/emberjs/rfcs/blob/main/text/0403-ember-data-identifiers.md) is
+       *    a valid optional sibling to `id` and `type` in both [Resources](https://jsonapi.org/format/#document-resource-objects)
+       *    and [Resource Identifier Objects](https://jsonapi.org/format/#document-resource-identifier-objects)
+       *
+       * If you need better control over normalization or want access to the records being added or updated
+       * in the store, we recommended using `store.push` over `store.pushPayload` after normalizing
+       * the payload directly. This can even take advantage of an existing serializer for the format
+       * the data is in, for example:
+       *
+       * ```js
+       * function pushPayload(store, modelName, rawPayload) {
+       *   const ModelClass = store.modelFor(modelName);
+       *   const serializer = store.serializerFor(modelName);
+       *   const jsonApiPayload = serializer.normalizeResponse(store, ModelClass, rawPayload, null, 'query');
+       *
+       *   return store.push(jsonApiPayload);
+       * }
+       * ```
+       *
+       * @method pushPayload [OPTIONAL]
+       * @public
+       * @optional
+       * @param {Store} store The store service that initiated the request being normalized
+       * @param {object} rawPayload The raw JSON response data returned from an API request.
+       *  This JSON should be in the API format expected by the serializer.
+       * @return {void}
+       */
+      pushPayload?(store: Store, rawPayload: ObjectValue): void;
+      /**
+       * In some situations the serializer may need to perform cleanup when destroyed,
+       * that cleanup can be done in `destroy`.
+       *
+       * If not implemented, the store does not inform the serializer of destruction.
+       *
+       * @method destroy [OPTIONAL]
+       * @public
+       * @optional
+       */
+      destroy?(): void;
+  }
+}
+//# sourceMappingURL=minimum-serializer-interface.d.ts.map

package/unstable-preview-types/legacy-network-handler/minimum-serializer-interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"minimum-serializer-interface.d.ts","sourceRoot":"","sources":["../../src/legacy-network-handler/minimum-serializer-interface.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AAExG,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,MAAM,iBAAiB,GAAG;IAAE,SAAS,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AACxD,MAAM,MAAM,WAAW,GACnB,YAAY,GACZ,aAAa,GACb,SAAS,GACT,eAAe,GACf,aAAa,GACb,UAAU,GACV,OAAO,GACP,cAAc,GACd,cAAc,GACd,cAAc,CAAC;AAEnB;;;;;;;;;;;;;;;;;EAiBE;AACF,MAAM,WAAW,0BAA0B;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,iBAAiB,CACf,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,cAAc,EAC1B,EAAE,EAAE,MAAM,GAAG,IAAI,EACjB,WAAW,EACP,YAAY,GACZ,aAAa,GACb,SAAS,GACT,eAAe,GACf,aAAa,GACb,UAAU,GACV,OAAO,GACP,cAAc,GACd,cAAc,GACd,cAAc,GACjB,eAAe,CAAC;IAEnB;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,WAAW,CAAC;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACH,SAAS,CAAC,CAAC,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAEhG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,iBAAiB,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAE7G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,WAAW,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,WAAW,GAAG,IAAI,CAAC;IAE1D;;;;;;;;;OASG;IACH,OAAO,CAAC,IAAI,IAAI,CAAC;CAClB"}

package/unstable-preview-types/legacy-network-handler/serializer-response.d.ts

@@ -0,0 +1,9 @@
+declare module '@ember-data/legacy-compat/legacy-network-handler/serializer-response' {
+  import type Store from '@ember-data/store';
+  import type { ModelSchema } from '@ember-data/store/types';
+  import type { JsonApiDocument } from '@warp-drive/core-types/spec/json-api-raw';
+  import type { AdapterPayload } from '@ember-data/legacy-compat/legacy-network-handler/minimum-adapter-interface';
+  import type { MinimumSerializerInterface, RequestType } from '@ember-data/legacy-compat/legacy-network-handler/minimum-serializer-interface';
+  export function normalizeResponseHelper(serializer: MinimumSerializerInterface | null, store: Store, modelClass: ModelSchema, payload: AdapterPayload, id: string | null, requestType: RequestType): JsonApiDocument;
+}
+//# sourceMappingURL=serializer-response.d.ts.map

package/unstable-preview-types/legacy-network-handler/serializer-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializer-response.d.ts","sourceRoot":"","sources":["../../src/legacy-network-handler/serializer-response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAG3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAEhF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,KAAK,EAAE,0BAA0B,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AA8D9F,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,0BAA0B,GAAG,IAAI,EAC7C,KAAK,EAAE,KAAK,EACZ,UAAU,EAAE,WAAW,EACvB,OAAO,EAAE,cAAc,EACvB,EAAE,EAAE,MAAM,GAAG,IAAI,EACjB,WAAW,EAAE,WAAW,GACvB,eAAe,CAQjB"}

package/unstable-preview-types/legacy-network-handler/snapshot-record-array.d.ts

@@ -0,0 +1,96 @@
+declare module '@ember-data/legacy-compat/legacy-network-handler/snapshot-record-array' {
+  /**
+    @module @ember-data/legacy-compat
+  */
+  import type Store from '@ember-data/store';
+  import type { LiveArray } from '@ember-data/store/-private';
+  import type { FindAllOptions, ModelSchema } from '@ember-data/store/types';
+  import type { Snapshot } from '@ember-data/legacy-compat/legacy-network-handler/snapshot';
+  /**
+    SnapshotRecordArray is not directly instantiable.
+    Instances are provided to consuming application's
+    adapters for certain `findAll` requests.
+  
+    @class SnapshotRecordArray
+    @public
+  */
+  export class SnapshotRecordArray {
+      _snapshots: Snapshot[] | null;
+      _type: ModelSchema | null;
+      modelName: string;
+      __store: Store;
+      adapterOptions?: Record<string, unknown>;
+      include?: string | string[];
+      /**
+        SnapshotRecordArray is not directly instantiable.
+        Instances are provided to consuming application's
+        adapters and serializers for certain requests.
+    
+        @method constructor
+        @private
+        @constructor
+        @param {Store} store
+        @param {string} type
+        @param options
+       */
+      constructor(store: Store, type: string, options?: FindAllOptions);
+      /**
+        An array of records
+    
+        @property _recordArray
+        @private
+        @type {Array}
+      */
+      get _recordArray(): LiveArray;
+      /**
+          Number of records in the array
+    
+          Example
+    
+          ```app/adapters/post.js
+          import JSONAPIAdapter from '@ember-data/adapter/json-api';
+    
+          export default class PostAdapter extends JSONAPIAdapter {
+            shouldReloadAll(store, snapshotRecordArray) {
+              return !snapshotRecordArray.length;
+            }
+          });
+          ```
+    
+          @property length
+          @public
+          @type {Number}
+        */
+      get length(): number;
+      /**
+        Get snapshots of the underlying record array
+    
+        Example
+    
+        ```app/adapters/post.js
+        import JSONAPIAdapter from '@ember-data/adapter/json-api';
+    
+        export default class PostAdapter extends JSONAPIAdapter {
+          shouldReloadAll(store, snapshotArray) {
+            let snapshots = snapshotArray.snapshots();
+    
+            return snapshots.any(function(ticketSnapshot) {
+              let timeDiff = moment().diff(ticketSnapshot.attr('lastAccessedAt'), 'minutes');
+              if (timeDiff > 20) {
+                return true;
+              } else {
+                return false;
+              }
+            });
+          }
+        }
+        ```
+    
+        @method snapshots
+        @public
+        @return {Array} Array of snapshots
+      */
+      snapshots(): Snapshot<unknown>[];
+  }
+}
+//# sourceMappingURL=snapshot-record-array.d.ts.map

package/unstable-preview-types/legacy-network-handler/snapshot-record-array.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot-record-array.d.ts","sourceRoot":"","sources":["../../src/legacy-network-handler/snapshot-record-array.ts"],"names":[],"mappings":"AAAA;;EAEE;AACF,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAE5D,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAI3E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C;;;;;;;EAOE;AACF,qBAAa,mBAAmB;IACtB,UAAU,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IAC9B,KAAK,EAAE,WAAW,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,KAAK,CAAC;IAEf,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAEpC;;;;;;;;;;;OAWG;gBACS,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB;IAkEpE;;;;;;MAME;IACF,IAAI,YAAY,IAAI,SAAS,CAE5B;IAED;;;;;;;;;;;;;;;;;;QAkBI;IACJ,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;MA2BE;IACF,SAAS;CAaV"}

package/unstable-preview-types/legacy-network-handler/snapshot.d.ts

@@ -0,0 +1,248 @@
+declare module '@ember-data/legacy-compat/legacy-network-handler/snapshot' {
+  import type Store from '@ember-data/store';
+  import type { FindRecordOptions } from '@ember-data/store/types';
+  import type { StableRecordIdentifier } from '@warp-drive/core-types';
+  import type { ChangedAttributesHash } from '@warp-drive/core-types/cache';
+  import type { TypedRecordInstance, TypeFromInstance } from '@warp-drive/core-types/record';
+  import type { LegacyAttributeField, LegacyRelationshipSchema } from '@warp-drive/core-types/schema/fields';
+  import type { SerializerOptions } from '@ember-data/legacy-compat/legacy-network-handler/minimum-serializer-interface';
+  type RecordId = string | null;
+  /**
+    Snapshot is not directly instantiable.
+    Instances are provided to a consuming application's
+    adapters and serializers for certain requests.
+  
+    Snapshots are only available when using `@ember-data/legacy-compat`
+    for legacy compatibility with adapters and serializers.
+  
+    @class Snapshot
+    @public
+  */
+  export class Snapshot<R = unknown> {
+      __attributes: Record<keyof R & string, unknown> | null;
+      _belongsToRelationships: Record<string, Snapshot>;
+      _belongsToIds: Record<string, RecordId>;
+      _hasManyRelationships: Record<string, Snapshot[]>;
+      _hasManyIds: Record<string, RecordId[]>;
+      _changedAttributes: ChangedAttributesHash;
+      identifier: StableRecordIdentifier<R extends TypedRecordInstance ? TypeFromInstance<R> : string>;
+      modelName: R extends TypedRecordInstance ? TypeFromInstance<R> : string;
+      id: string | null;
+      include?: string | string[];
+      adapterOptions?: Record<string, unknown>;
+      _store: Store;
+      /**
+       * @method constructor
+       * @constructor
+       * @private
+       * @param options
+       * @param identifier
+       * @param _store
+       */
+      constructor(options: FindRecordOptions, identifier: StableRecordIdentifier<R extends TypedRecordInstance ? TypeFromInstance<R> : string>, store: Store);
+      /**
+       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();
+       ```
+    
+       @property record
+       @type {Model}
+       @public
+       */
+      get record(): R | null;
+      get _attributes(): Record<keyof R & string, unknown>;
+      get isNew(): boolean;
+      /**
+       Returns the value of an attribute.
+    
+       Example
+    
+       ```javascript
+       // store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });
+       postSnapshot.attr('author'); // => 'Tomster'
+       postSnapshot.attr('title'); // => 'Ember.js rocks'
+       ```
+    
+       Note: Values are loaded eagerly and cached when the snapshot is created.
+    
+       @method attr
+       @param {String} keyName
+       @return {Object} The attribute value or undefined
+       @public
+       */
+      attr(keyName: keyof R & string): unknown;
+      /**
+       Returns all attributes and their corresponding values.
+    
+       Example
+    
+       ```javascript
+       // store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });
+       postSnapshot.attributes(); // => { author: 'Tomster', title: 'Ember.js rocks' }
+       ```
+    
+       @method attributes
+       @return {Object} All attributes of the current snapshot
+       @public
+       */
+      attributes(): Record<keyof R & string, unknown>;
+      /**
+       Returns all changed attributes and their old and new values.
+    
+       Example
+    
+       ```javascript
+       // 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!'] }
+       ```
+    
+       @method changedAttributes
+       @return {Object} All changed attributes of the current snapshot
+       @public
+       */
+      changedAttributes(): ChangedAttributesHash;
+      /**
+       Returns the current value of a belongsTo relationship.
+    
+       `belongsTo` takes an optional hash of options as a second parameter,
+       currently supported options are:
+    
+       - `id`: set to `true` if you only want the ID of the related record to be
+       returned.
+    
+       Example
+    
+       ```javascript
+       // store.push('post', { id: 1, title: 'Hello World' });
+       // store.createRecord('comment', { body: 'Lorem ipsum', post: post });
+       commentSnapshot.belongsTo('post'); // => Snapshot
+       commentSnapshot.belongsTo('post', { id: true }); // => '1'
+    
+       // store.push('comment', { id: 1, body: 'Lorem ipsum' });
+       commentSnapshot.belongsTo('post'); // => undefined
+       ```
+    
+       Calling `belongsTo` will return a new Snapshot as long as there's any known
+       data for the relationship available, such as an ID. If the relationship is
+       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.
+    
+       @method belongsTo
+       @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.
+       */
+      belongsTo(keyName: string, options?: {
+          id?: boolean;
+      }): Snapshot | RecordId | undefined;
+      /**
+       Returns the current value of a hasMany relationship.
+    
+       `hasMany` takes an optional hash of options as a second parameter,
+       currently supported options are:
+    
+       - `ids`: set to `true` if you only want the IDs of the related records to be
+       returned.
+    
+       Example
+    
+       ```javascript
+       // store.push('post', { id: 1, title: 'Hello World', comments: [2, 3] });
+       postSnapshot.hasMany('comments'); // => [Snapshot, Snapshot]
+       postSnapshot.hasMany('comments', { ids: true }); // => ['2', '3']
+    
+       // store.push('post', { id: 1, title: 'Hello World' });
+       postSnapshot.hasMany('comments'); // => undefined
+       ```
+    
+       Note: Relationships are loaded lazily and cached upon first access.
+    
+       @method hasMany
+       @param {String} keyName
+       @param {Object} [options]
+       @public
+       @return {(Array|undefined)} 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.
+       */
+      hasMany(keyName: string, options?: {
+          ids?: boolean;
+      }): RecordId[] | Snapshot[] | undefined;
+      /**
+        Iterates through all the attributes of the model, calling the passed
+        function on each attribute.
+    
+        Example
+    
+        ```javascript
+        snapshot.eachAttribute(function(name, meta) {
+          // ...
+        });
+        ```
+    
+        @method eachAttribute
+        @param {Function} callback the callback to execute
+        @param {Object} [binding] the value to which the callback's `this` should be bound
+        @public
+      */
+      eachAttribute(callback: (key: string, meta: LegacyAttributeField) => void, binding?: unknown): void;
+      /**
+        Iterates through all the relationships of the model, calling the passed
+        function on each relationship.
+    
+        Example
+    
+        ```javascript
+        snapshot.eachRelationship(function(name, relationship) {
+          // ...
+        });
+        ```
+    
+        @method eachRelationship
+        @param {Function} callback the callback to execute
+        @param {Object} [binding] the value to which the callback's `this` should be bound
+        @public
+      */
+      eachRelationship(callback: (key: string, meta: LegacyRelationshipSchema) => void, binding?: unknown): void;
+      /**
+        Serializes the snapshot using the serializer for the model.
+    
+        Example
+    
+        ```app/adapters/application.js
+        import Adapter from '@ember-data/adapter';
+    
+        export default Adapter.extend({
+          createRecord(store, type, snapshot) {
+            let data = snapshot.serialize({ includeId: true });
+            let url = `/${type.modelName}`;
+    
+            return fetch(url, {
+              method: 'POST',
+              body: data,
+            }).then((response) => response.json())
+          }
+        });
+        ```
+    
+        @method serialize
+        @param {Object} options
+        @return {Object} an object whose values are primitive JSON values only
+        @public
+       */
+      serialize(options?: SerializerOptions): unknown;
+  }
+  export {};
+}
+//# sourceMappingURL=snapshot.d.ts.map

package/unstable-preview-types/legacy-network-handler/snapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot.d.ts","sourceRoot":"","sources":["../../src/legacy-network-handler/snapshot.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAC3C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAGjE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAG1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAC3F,OAAO,KAAK,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAG3G,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAExE,KAAK,QAAQ,GAAG,MAAM,GAAG,IAAI,CAAC;AAE9B;;;;;;;;;;EAUE;AACF,qBAAa,QAAQ,CAAC,CAAC,GAAG,OAAO;IACvB,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACvD,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAClD,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACxC,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClD,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;IACxC,kBAAkB,EAAE,qBAAqB,CAAC;IAE1C,UAAU,EAAE,sBAAsB,CAAC,CAAC,SAAS,mBAAmB,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;IACjG,SAAS,EAAE,CAAC,SAAS,mBAAmB,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;IACxE,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzC,MAAM,EAAE,KAAK,CAAC;IAEtB;;;;;;;OAOG;gBAED,OAAO,EAAE,iBAAiB,EAC1B,UAAU,EAAE,sBAAsB,CAAC,CAAC,SAAS,mBAAmB,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,EAChG,KAAK,EAAE,KAAK;IAiFd;;;;;;;;;;;;;OAaG;IACH,IAAI,MAAM,IAAI,CAAC,GAAG,IAAI,CAOrB;IAED,IAAI,WAAW,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE,OAAO,CAAC,CAgBnD;IAED,IAAI,KAAK,IAAI,OAAO,CAGnB;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,MAAM,GAAG,OAAO;IAOxC;;;;;;;;;;;;;OAaG;IACH,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE,OAAO,CAAC;IAI/C;;;;;;;;;;;;;;OAcG;IACH,iBAAiB,IAAI,qBAAqB;IAgB1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,EAAE,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS;IAwEvF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,QAAQ,EAAE,GAAG,QAAQ,EAAE,GAAG,SAAS;IA+E1F;;;;;;;;;;;;;;;;MAgBE;IACF,aAAa,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,KAAK,IAAI,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI;IASnG;;;;;;;;;;;;;;;;MAgBE;IACF,gBAAgB,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,wBAAwB,KAAK,IAAI,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI;IAS1G;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO;CAMhD"}