@warp-drive/legacy 5.8.0-alpha.30 → 5.8.0-alpha.32

package/dist/unpkg/prod/serializer/rest.js

@@ -0,0 +1,1243 @@
+import { warn } from '@ember/debug';
+import { camelize, dasherize, singularize } from '@warp-drive/utilities/string';
+import { J as JSONSerializer, c as coerceId } from "../json-BNrV8EYG.js";
+import { macroCondition, getGlobalConfig } from '@embroider/macros';
+import Mixin from '@ember/object/mixin';
+
+/* eslint-disable @typescript-eslint/no-unsafe-argument */
+/* eslint-disable @typescript-eslint/no-unsafe-return */
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+
+/**
+  ## Using Embedded Records
+
+  `EmbeddedRecordsMixin` supports serializing embedded records.
+
+  To set up embedded records, include the mixin when extending a serializer,
+  then define and configure embedded (model) relationships.
+
+  Note that embedded records will serialize with the serializer for their model instead of the serializer in which they are defined.
+
+  Note also that this mixin does not work with JSONAPISerializer because the JSON:API specification does not describe how to format embedded resources.
+
+  Below is an example of a per-type serializer (`post` type).
+
+  ```js [app/serializers/post.js]
+  import RESTSerializer, { EmbeddedRecordsMixin } from '@warp-drive/legacy/serializer/rest';
+
+  export default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
+    attrs = {
+      author: { embedded: 'always' },
+      comments: { serialize: 'ids' }
+    }
+  }
+  ```
+  Note that this use of `{ embedded: 'always' }` is unrelated to
+  the `{ embedded: 'always' }` that is defined as an option on `attr` as part of
+  defining a model while working with the `ActiveModelSerializer`.  Nevertheless,
+  using `{ embedded: 'always' }` as an option to `attr` is not a valid way to set up
+  embedded records.
+
+  The `attrs` option for a resource `{ embedded: 'always' }` is shorthand for:
+
+  ```js
+  {
+    serialize: 'records',
+    deserialize: 'records'
+  }
+  ```
+
+  ### Configuring Attrs
+
+  A resource's `attrs` option may be set to use `ids`, `records` or false for the
+  `serialize`  and `deserialize` settings.
+
+  The `attrs` property can be set on the `ApplicationSerializer` or a per-type
+  serializer.
+
+  In the case where embedded JSON is expected while extracting a payload (reading)
+  the setting is `deserialize: 'records'`, there is no need to use `ids` when
+  extracting as that is the default behaviour without this mixin if you are using
+  the vanilla `EmbeddedRecordsMixin`. Likewise, to embed JSON in the payload while
+  serializing `serialize: 'records'` is the setting to use. There is an option of
+  not embedding JSON in the serialized payload by using `serialize: 'ids'`. If you
+  do not want the relationship sent at all, you can use `serialize: false`.
+
+
+  ### EmbeddedRecordsMixin defaults
+  If you do not overwrite `attrs` for a specific relationship, the `EmbeddedRecordsMixin`
+  will behave in the following way:
+
+  BelongsTo: `{ serialize: 'id', deserialize: 'id' }`
+  HasMany:   `{ serialize: false, deserialize: 'ids' }`
+
+  ### Model Relationships
+
+  Embedded records must have a model defined to be extracted and serialized. Note that
+  when defining any relationships on your model such as `belongsTo` and `hasMany`, you
+  should not both specify `async: true` and also indicate through the serializer's
+  `attrs` attribute that the related model should be embedded for deserialization.
+  If a model is declared embedded for deserialization (`embedded: 'always'` or `deserialize: 'records'`),
+  then do not use `async: true`.
+
+  To successfully extract and serialize embedded records the model relationships
+  must be set up correctly. See the
+  [defining relationships](https://guides.emberjs.com/current/models/relationships)
+  section of the **Defining Models** guide page.
+
+  Records without an `id` property are not considered embedded records, model
+  instances must have an `id` property to be used with Ember Data.
+
+  ### Example JSON payloads, Models and Serializers
+
+  **When customizing a serializer it is important to grok what the customizations
+  are. Please read the docs for the methods this mixin provides, in case you need
+  to modify it to fit your specific needs.**
+
+  @class EmbeddedRecordsMixin
+  @public
+*/
+const EmbeddedRecordsMixin = Mixin.create({
+  /**
+    Normalize the record and recursively normalize/extract all the embedded records
+    while pushing them into the store as they are encountered
+     A payload with an attr configured for embedded records needs to be extracted:
+     ```js
+    {
+      "post": {
+        "id": "1"
+        "title": "Rails is omakase",
+        "comments": [{
+          "id": "1",
+          "body": "Rails is unagi"
+        }, {
+          "id": "2",
+          "body": "Omakase O_o"
+        }]
+      }
+    }
+    ```
+    @public
+   @param {Model} typeClass
+   @param {Object} hash to be normalized
+   @param {String} prop the hash has been referenced by
+   @return {Object} the normalized hash
+  **/
+  normalize(typeClass, hash, prop) {
+    const normalizedHash = this._super(typeClass, hash, prop);
+    return this._extractEmbeddedRecords(this, this.store, typeClass, normalizedHash);
+  },
+  keyForRelationship(key, typeClass, method) {
+    if (method === 'serialize' && this.hasSerializeRecordsOption(key) || method === 'deserialize' && this.hasDeserializeRecordsOption(key)) {
+      return this.keyForAttribute(key, method);
+    } else {
+      return this._super(key, typeClass, method) || key;
+    }
+  },
+  /**
+    Serialize `belongsTo` relationship when it is configured as an embedded object.
+     This example of an author model belongs to a post model:
+     ```js
+    import Model, { attr, belongsTo } from '@warp-drive/legacy/model';
+     Post = Model.extend({
+      title:    attr('string'),
+      body:     attr('string'),
+      author:   belongsTo('author')
+    });
+     Author = Model.extend({
+      name:     attr('string'),
+      post:     belongsTo('post')
+    });
+    ```
+     Use a custom (type) serializer for the post model to configure embedded author
+     ```js [app/serializers/post.js]
+    import RESTSerializer, { EmbeddedRecordsMixin } from '@warp-drive/legacy/serializer/rest';
+     export default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
+      attrs = {
+        author: { embedded: 'always' }
+      }
+    }
+    ```
+     A payload with an attribute configured for embedded records can serialize
+    the records together under the root attribute's payload:
+     ```js
+    {
+      "post": {
+        "id": "1"
+        "title": "Rails is omakase",
+        "author": {
+          "id": "2"
+          "name": "dhh"
+        }
+      }
+    }
+    ```
+     @public
+    @param {Snapshot} snapshot
+    @param {Object} json
+    @param {Object} relationship
+  */
+  serializeBelongsTo(snapshot, json, relationship) {
+    const attr = relationship.name;
+    if (this.noSerializeOptionSpecified(attr)) {
+      this._super(snapshot, json, relationship);
+      return;
+    }
+    const includeIds = this.hasSerializeIdsOption(attr);
+    const includeRecords = this.hasSerializeRecordsOption(attr);
+    const embeddedSnapshot = snapshot.belongsTo(attr);
+    if (includeIds) {
+      const schema = this.store.modelFor(snapshot.modelName);
+      let serializedKey = this._getMappedKey(relationship.name, schema);
+      if (serializedKey === relationship.name && this.keyForRelationship) {
+        serializedKey = this.keyForRelationship(relationship.name, relationship.kind, 'serialize');
+      }
+      if (!embeddedSnapshot) {
+        json[serializedKey] = null;
+      } else {
+        json[serializedKey] = embeddedSnapshot.id;
+        if (relationship.options.polymorphic) {
+          this.serializePolymorphicType(snapshot, json, relationship);
+        }
+      }
+    } else if (includeRecords) {
+      this._serializeEmbeddedBelongsTo(snapshot, json, relationship);
+    }
+  },
+  _serializeEmbeddedBelongsTo(snapshot, json, relationship) {
+    const embeddedSnapshot = snapshot.belongsTo(relationship.name);
+    const schema = this.store.modelFor(snapshot.modelName);
+    let serializedKey = this._getMappedKey(relationship.name, schema);
+    if (serializedKey === relationship.name && this.keyForRelationship) {
+      serializedKey = this.keyForRelationship(relationship.name, relationship.kind, 'serialize');
+    }
+    if (!embeddedSnapshot) {
+      json[serializedKey] = null;
+    } else {
+      json[serializedKey] = embeddedSnapshot.serialize({
+        includeId: true
+      });
+      this.removeEmbeddedForeignKey(snapshot, embeddedSnapshot, relationship, json[serializedKey]);
+      if (relationship.options.polymorphic) {
+        this.serializePolymorphicType(snapshot, json, relationship);
+      }
+    }
+  },
+  /**
+    Serializes `hasMany` relationships when it is configured as embedded objects.
+     This example of a post model has many comments:
+     ```js
+    import Model, { attr, belongsTo, hasMany } from '@warp-drive/legacy/model';
+     Post = Model.extend({
+      title:    attr('string'),
+      body:     attr('string'),
+      comments: hasMany('comment')
+    });
+     Comment = Model.extend({
+      body:     attr('string'),
+      post:     belongsTo('post')
+    });
+    ```
+     Use a custom (type) serializer for the post model to configure embedded comments
+     ```js [app/serializers/post.js]
+    import RESTSerializer, { EmbeddedRecordsMixin } from '@warp-drive/legacy/serializer/rest';
+     export default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
+      attrs = {
+        comments: { embedded: 'always' }
+      }
+    }
+    ```
+     A payload with an attribute configured for embedded records can serialize
+    the records together under the root attribute's payload:
+     ```js
+    {
+      "post": {
+        "id": "1"
+        "title": "Rails is omakase",
+        "body": "I want this for my ORM, I want that for my template language..."
+        "comments": [{
+          "id": "1",
+          "body": "Rails is unagi"
+        }, {
+          "id": "2",
+          "body": "Omakase O_o"
+        }]
+      }
+    }
+    ```
+     The attrs options object can use more specific instruction for extracting and
+    serializing. When serializing, an option to embed `ids`, `ids-and-types` or `records` can be set.
+    When extracting the only option is `records`.
+     So `{ embedded: 'always' }` is shorthand for:
+    `{ serialize: 'records', deserialize: 'records' }`
+     To embed the `ids` for a related object (using a hasMany relationship):
+     ```js [app/serializers/post.js]
+    import RESTSerializer, { EmbeddedRecordsMixin } from '@warp-drive/legacy/serializer/rest';
+     export default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
+      attrs = {
+        comments: { serialize: 'ids', deserialize: 'records' }
+      }
+    }
+    ```
+     ```js
+    {
+      "post": {
+        "id": "1"
+        "title": "Rails is omakase",
+        "body": "I want this for my ORM, I want that for my template language..."
+        "comments": ["1", "2"]
+      }
+    }
+    ```
+     To embed the relationship as a collection of objects with `id` and `type` keys, set
+    `ids-and-types` for the related object.
+     This is particularly useful for polymorphic relationships where records don't share
+    the same table and the `id` is not enough information.
+     For example having a user that has many pets:
+     ```js
+    User = Model.extend({
+      name: attr('string'),
+      pets: hasMany('pet', { polymorphic: true })
+    });
+     Pet = Model.extend({
+      name: attr('string'),
+    });
+     Cat = Pet.extend({
+      // ...
+    });
+     Parrot = Pet.extend({
+      // ...
+    });
+    ```
+     ```js [app/serializers/user.js]
+    import RESTSerializer, { EmbeddedRecordsMixin } from '@warp-drive/legacy/serializer/rest';
+     export default class UserSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
+      attrs = {
+        pets: { serialize: 'ids-and-types', deserialize: 'records' }
+      }
+    }
+    ```
+     ```js
+    {
+      "user": {
+        "id": "1"
+        "name": "Bertin Osborne",
+        "pets": [
+          { "id": "1", "type": "Cat" },
+          { "id": "1", "type": "Parrot"}
+        ]
+      }
+    }
+    ```
+     @public
+    @param {Snapshot} snapshot
+    @param {Object} json
+    @param {Object} relationship
+  */
+  serializeHasMany(snapshot, json, relationship) {
+    const attr = relationship.name;
+    if (this.noSerializeOptionSpecified(attr)) {
+      this._super(snapshot, json, relationship);
+      return;
+    }
+    if (this.hasSerializeIdsOption(attr)) {
+      const schema = this.store.modelFor(snapshot.modelName);
+      let serializedKey = this._getMappedKey(relationship.name, schema);
+      if (serializedKey === relationship.name && this.keyForRelationship) {
+        serializedKey = this.keyForRelationship(relationship.name, relationship.kind, 'serialize');
+      }
+      json[serializedKey] = snapshot.hasMany(attr, {
+        ids: true
+      });
+    } else if (this.hasSerializeRecordsOption(attr)) {
+      this._serializeEmbeddedHasMany(snapshot, json, relationship);
+    } else {
+      if (this.hasSerializeIdsAndTypesOption(attr)) {
+        this._serializeHasManyAsIdsAndTypes(snapshot, json, relationship);
+      }
+    }
+  },
+  /*
+    Serializes a hasMany relationship as an array of objects containing only `id` and `type`
+    keys.
+    This has its use case on polymorphic hasMany relationships where the server is not storing
+    all records in the same table using STI, and therefore the `id` is not enough information
+     TODO: Make the default in Ember-data 3.0??
+  */
+  _serializeHasManyAsIdsAndTypes(snapshot, json, relationship) {
+    const serializedKey = this.keyForAttribute(relationship.name, 'serialize');
+    const hasMany = snapshot.hasMany(relationship.name) || [];
+    json[serializedKey] = hasMany.map(function (recordSnapshot) {
+      //
+      // I'm sure I'm being utterly naive here. Probably id is a configurable property and
+      // type too, and the modelName has to be normalized somehow.
+      //
+      return {
+        id: recordSnapshot.id,
+        type: recordSnapshot.modelName
+      };
+    });
+  },
+  _serializeEmbeddedHasMany(snapshot, json, relationship) {
+    const schema = this.store.modelFor(snapshot.modelName);
+    let serializedKey = this._getMappedKey(relationship.name, schema);
+    if (serializedKey === relationship.name && this.keyForRelationship) {
+      serializedKey = this.keyForRelationship(relationship.name, relationship.kind, 'serialize');
+    }
+    warn(`The embedded relationship '${serializedKey}' is undefined for '${snapshot.modelName}' with id '${snapshot.id}'. Please include it in your original payload.`, typeof snapshot.hasMany(relationship.name) !== 'undefined', {
+      id: 'ds.serializer.embedded-relationship-undefined'
+    });
+    json[serializedKey] = this._generateSerializedHasMany(snapshot, relationship);
+  },
+  /*
+    Returns an array of embedded records serialized to JSON
+  */
+  _generateSerializedHasMany(snapshot, relationship) {
+    const hasMany = snapshot.hasMany(relationship.name) || [];
+    const ret = new Array(hasMany.length);
+    for (let i = 0; i < hasMany.length; i++) {
+      const embeddedSnapshot = hasMany[i];
+      const embeddedJson = embeddedSnapshot.serialize({
+        includeId: true
+      });
+      this.removeEmbeddedForeignKey(snapshot, embeddedSnapshot, relationship, embeddedJson);
+      ret[i] = embeddedJson;
+    }
+    return ret;
+  },
+  /**
+    When serializing an embedded record, modify the property (in the `JSON` payload)
+    that refers to the parent record (foreign key for the relationship).
+     Serializing a `belongsTo` relationship removes the property that refers to the
+    parent record
+     Serializing a `hasMany` relationship does not remove the property that refers to
+    the parent record.
+     @public
+    @param {Snapshot} snapshot
+    @param {Snapshot} embeddedSnapshot
+    @param {Object} relationship
+    @param {Object} json
+  */
+  removeEmbeddedForeignKey(snapshot, embeddedSnapshot, relationship, json) {
+    if (relationship.kind === 'belongsTo') {
+      const schema = this.store.modelFor(snapshot.modelName);
+      const parentRecord = schema.inverseFor(relationship.name, this.store);
+      if (parentRecord) {
+        const name = parentRecord.name;
+        const embeddedSerializer = this.store.serializerFor(embeddedSnapshot.modelName);
+        const parentKey = embeddedSerializer.keyForRelationship(name, parentRecord.kind, 'deserialize');
+        if (parentKey) {
+          delete json[parentKey];
+        }
+      }
+    } /*else if (relationship.kind === 'hasMany') {
+      return;
+      }*/
+  },
+  // checks config for attrs option to embedded (always) - serialize and deserialize
+  hasEmbeddedAlwaysOption(attr) {
+    const option = this.attrsOption(attr);
+    return option && option.embedded === 'always';
+  },
+  // checks config for attrs option to serialize ids
+  hasSerializeRecordsOption(attr) {
+    const alwaysEmbed = this.hasEmbeddedAlwaysOption(attr);
+    const option = this.attrsOption(attr);
+    return alwaysEmbed || option && option.serialize === 'records';
+  },
+  // checks config for attrs option to serialize records
+  hasSerializeIdsOption(attr) {
+    const option = this.attrsOption(attr);
+    return option && (option.serialize === 'ids' || option.serialize === 'id');
+  },
+  // checks config for attrs option to serialize records as objects containing id and types
+  hasSerializeIdsAndTypesOption(attr) {
+    const option = this.attrsOption(attr);
+    return option && (option.serialize === 'ids-and-types' || option.serialize === 'id-and-type');
+  },
+  // checks config for attrs option to serialize records
+  noSerializeOptionSpecified(attr) {
+    const option = this.attrsOption(attr);
+    return !(option && (option.serialize || option.embedded));
+  },
+  // checks config for attrs option to deserialize records
+  // a defined option object for a resource is treated the same as
+  // `deserialize: 'records'`
+  hasDeserializeRecordsOption(attr) {
+    const alwaysEmbed = this.hasEmbeddedAlwaysOption(attr);
+    const option = this.attrsOption(attr);
+    return alwaysEmbed || option && option.deserialize === 'records';
+  },
+  attrsOption(attr) {
+    const attrs = this.attrs;
+    return attrs && (attrs[camelize(attr)] || attrs[attr]);
+  },
+  /**
+   @private
+  */
+  _extractEmbeddedRecords(serializer, store, typeClass, partial) {
+    typeClass.eachRelationship((key, relationship) => {
+      if (serializer.hasDeserializeRecordsOption(key)) {
+        if (relationship.kind === 'hasMany') {
+          this._extractEmbeddedHasMany(store, key, partial, relationship);
+        }
+        if (relationship.kind === 'belongsTo') {
+          this._extractEmbeddedBelongsTo(store, key, partial, relationship);
+        }
+      }
+    });
+    return partial;
+  },
+  /**
+   @private
+  */
+  _extractEmbeddedHasMany(store, key, hash, relationshipMeta) {
+    const relationshipHash = hash.data?.relationships?.[key]?.data;
+    if (!relationshipHash) {
+      return;
+    }
+    const hasMany = new Array(relationshipHash.length);
+    for (let i = 0; i < relationshipHash.length; i++) {
+      const item = relationshipHash[i];
+      const {
+        data,
+        included
+      } = this._normalizeEmbeddedRelationship(store, relationshipMeta, item);
+      hash.included = hash.included || [];
+      hash.included.push(data);
+      if (included) {
+        hash.included = hash.included.concat(included);
+      }
+      hasMany[i] = {
+        id: data.id,
+        type: data.type
+      };
+      if (data.lid) {
+        hasMany[i].lid = data.lid;
+      }
+    }
+    const relationship = {
+      data: hasMany
+    };
+    hash.data.relationships[key] = relationship;
+  },
+  /**
+   @private
+  */
+  _extractEmbeddedBelongsTo(store, key, hash, relationshipMeta) {
+    const relationshipHash = hash.data?.relationships?.[key]?.data;
+    if (!relationshipHash) {
+      return;
+    }
+    const {
+      data,
+      included
+    } = this._normalizeEmbeddedRelationship(store, relationshipMeta, relationshipHash);
+    hash.included = hash.included || [];
+    hash.included.push(data);
+    if (included) {
+      hash.included = hash.included.concat(included);
+    }
+    const belongsTo = {
+      id: data.id,
+      type: data.type
+    };
+    const relationship = {
+      data: belongsTo
+    };
+    if (data.lid) {
+      // @ts-expect-error
+      belongsTo.lid = data.lid;
+    }
+    hash.data.relationships[key] = relationship;
+  },
+  /**
+   @private
+  */
+  _normalizeEmbeddedRelationship(store, relationshipMeta, relationshipHash) {
+    let modelName = relationshipMeta.type;
+    if (relationshipMeta.options.polymorphic) {
+      modelName = relationshipHash.type;
+    }
+    const modelClass = store.modelFor(modelName);
+    const serializer = store.serializerFor(modelName);
+    return serializer.normalize(modelClass, relationshipHash, null);
+  },
+  isEmbeddedRecordsMixin: true
+});
+
+/* eslint-disable @typescript-eslint/no-unsafe-argument */
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-unsafe-return */
+function makeArray(value) {
+  return Array.isArray(value) ? value : [value];
+}
+
+/**
+ * :::danger
+    ⚠️ **This is LEGACY documentation** 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
+    {@link Handler} instead to be used with the {@link RequestManager}
+  :::
+
+  Normally, applications will use the `RESTSerializer` by implementing
+  the `normalize` method.
+
+  This allows you to do whatever kind of munging you need and is
+  especially useful if your server is inconsistent and you need to
+  do munging differently for many different kinds of responses.
+
+  See the `normalize` documentation for more information.
+
+  ## Across the Board Normalization
+
+  There are also a number of hooks that you might find useful to define
+  across-the-board rules for your payload. These rules will be useful
+  if your server is consistent, or if you're building an adapter for
+  an infrastructure service, like Firebase, and want to encode service
+  conventions.
+
+  For example, if all of your keys are underscored and all-caps, but
+  otherwise consistent with the names you use in your models, you
+  can implement across-the-board rules for how to convert an attribute
+  name in your model to a key in your JSON.
+
+  ```js [app/serializers/application.js]
+  import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
+  import { underscore } from '<app-name>/utils/string-utils';
+
+  export default class ApplicationSerializer extends RESTSerializer {
+    keyForAttribute(attr, method) {
+      return underscore(attr).toUpperCase();
+    }
+  }
+  ```
+
+  You can also implement `keyForRelationship`, which takes the name
+  of the relationship as the first parameter, the kind of
+  relationship (`hasMany` or `belongsTo`) as the second parameter, and
+  the method (`serialize` or `deserialize`) as the third parameter.
+
+  @class RESTSerializer
+  @public
+*/
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const RESTSerializer = JSONSerializer.extend({
+  /**
+   `keyForPolymorphicType` can be used to define a custom key when
+   serializing and deserializing a polymorphic type. By default, the
+   returned key is `${key}Type`.
+    Example
+     ```js [app/serializers/post.js]
+    import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
+     export default class ApplicationSerializer extends RESTSerializer {
+      keyForPolymorphicType(key, relationship) {
+        let relationshipKey = this.keyForRelationship(key);
+         return 'type-' + relationshipKey;
+      }
+    }
+    ```
+     @public
+  */
+  keyForPolymorphicType(key, type, method) {
+    // @ts-expect-error
+    const relationshipKey = this.keyForRelationship(key);
+    return `${relationshipKey}Type`;
+  },
+  /**
+    Normalizes a part of the JSON payload returned by
+    the server. You should override this method, munge the hash
+    and call super if you have generic normalization to do.
+     It takes the type of the record that is being normalized
+    (as a Model class), the property where the hash was
+    originally found, and the hash to normalize.
+     For example, if you have a payload that looks like this:
+     ```js
+    {
+      "post": {
+        "id": 1,
+        "title": "Rails is omakase",
+        "comments": [ 1, 2 ]
+      },
+      "comments": [{
+        "id": 1,
+        "body": "FIRST"
+      }, {
+        "id": 2,
+        "body": "Rails is unagi"
+      }]
+    }
+    ```
+     The `normalize` method will be called three times:
+     * With `App.Post`, `"posts"` and `{ id: 1, title: "Rails is omakase", ... }`
+    * With `App.Comment`, `"comments"` and `{ id: 1, body: "FIRST" }`
+    * With `App.Comment`, `"comments"` and `{ id: 2, body: "Rails is unagi" }`
+     You can use this method, for example, to normalize underscored keys to camelized
+    or other general-purpose normalizations. You will only need to implement
+    `normalize` and manipulate the payload as desired.
+     For example, if the `IDs` under `"comments"` are provided as `_id` instead of
+    `id`, you can specify how to normalize just the comments:
+     ```js [app/serializers/post.js]
+    import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
+     export default class ApplicationSerializer extends RESTSerializer {
+      normalize(model, hash, prop) {
+        if (prop === 'comments') {
+          hash.id = hash._id;
+          delete hash._id;
+        }
+         return super.normalize(...arguments);
+      }
+    }
+    ```
+     On each call to the `normalize` method, the third parameter (`prop`) is always
+    one of the keys that were in the original payload or in the result of another
+    normalization as `normalizeResponse`.
+     @public
+    @param {Model} modelClass
+    @param {Object} resourceHash
+    @param {String} prop
+    @return {Object}
+  */
+
+  /**
+    Normalizes an array of resource payloads and returns a JSON-API Document
+    with primary data and, if any, included data as `{ data, included }`.
+     @private
+  */
+  _normalizeArray(store, modelName, arrayHash, prop) {
+    const documentHash = {
+      data: [],
+      included: []
+    };
+    const modelClass = store.modelFor(modelName);
+    const serializer = store.serializerFor(modelName);
+    makeArray(arrayHash).forEach(hash => {
+      // @ts-expect-error
+      const {
+        data,
+        included
+      } = this._normalizePolymorphicRecord(store, hash, prop, modelClass, serializer);
+      // @ts-expect-error
+      documentHash.data.push(data);
+      if (included) {
+        documentHash.included = documentHash.included.concat(included);
+      }
+    });
+    return documentHash;
+  },
+  _normalizePolymorphicRecord(store, hash, prop, primaryModelClass, primarySerializer) {
+    let serializer = primarySerializer;
+    let modelClass = primaryModelClass;
+    const primaryHasTypeAttribute = primaryModelClass.fields.has('type');
+
+    // @ts-expect-error all the errors
+    if (!primaryHasTypeAttribute && hash.type) {
+      // Support polymorphic records in async relationships
+      // @ts-expect-error all the errors
+      const type = this.modelNameFromPayloadKey(hash.type);
+      if (store.schema.hasResource({
+        type
+      })) {
+        serializer = store.serializerFor(type);
+        modelClass = store.modelFor(type);
+      }
+    }
+
+    // @ts-expect-error all the errors
+    return serializer.normalize(modelClass, hash, prop);
+  },
+  /**
+    @private
+  */
+  _normalizeResponse(store, primaryModelClass, payload, id, requestType, isSingle) {
+    const documentHash = {
+      data: null,
+      included: []
+    };
+    // @ts-expect-error
+    const meta = this.extractMeta(store, primaryModelClass, payload);
+    if (meta) {
+      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+        if (!test) {
+          throw new Error('The `meta` returned from `extractMeta` has to be an object, not "' + typeof meta + '".');
+        }
+      })(typeof meta === 'object') : {}; // @ts-expect-error
+      documentHash.meta = meta;
+    }
+    const keys = Object.keys(payload);
+    for (let i = 0, length = keys.length; i < length; i++) {
+      const prop = keys[i];
+      let modelName = prop;
+      let forcedSecondary = false;
+
+      /*
+        If you want to provide sideloaded records of the same type that the
+        primary data you can do that by prefixing the key with `_`.
+         Example
+         ```
+        {
+          users: [
+            { id: 1, title: 'Tom', manager: 3 },
+            { id: 2, title: 'Yehuda', manager: 3 }
+          ],
+          _users: [
+            { id: 3, title: 'Tomster' }
+          ]
+        }
+        ```
+         This forces `_users` to be added to `included` instead of `data`.
+       */
+      if (prop.charAt(0) === '_') {
+        forcedSecondary = true;
+        modelName = prop.substr(1);
+      }
+      const type = this.modelNameFromPayloadKey(modelName);
+      if (!store.schema.hasResource({
+        type
+      })) {
+        if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
+          // @ts-expect-error
+          warn(this.warnMessageNoModelForKey(modelName, type), false, {
+            id: 'ds.serializer.model-for-key-missing'
+          });
+        }
+        continue;
+      }
+
+      // eslint-disable-next-line no-var
+      var isPrimary = !forcedSecondary && this.isPrimaryType(store, type, primaryModelClass);
+      const value = payload[prop];
+      if (value === null) {
+        continue;
+      }
+      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+        if (!test) {
+          throw new Error('The adapter returned an array for the primary data of a `queryRecord` response. `queryRecord` should return a single record.');
+        }
+      })(!(requestType === 'queryRecord' && isPrimary && Array.isArray(value))) : {};
+
+      /*
+        Support primary data as an object instead of an array.
+         Example
+         ```
+        {
+          user: { id: 1, title: 'Tom', manager: 3 }
+        }
+        ```
+       */
+      if (isPrimary && !Array.isArray(value)) {
+        // @ts-expect-error
+        const {
+          data,
+          included
+        } = this._normalizePolymorphicRecord(store, value, prop, primaryModelClass, this);
+        documentHash.data = data;
+        if (included) {
+          documentHash.included = documentHash.included.concat(included);
+        }
+        continue;
+      }
+      // @ts-expect-error
+      const {
+        data,
+        included
+      } = this._normalizeArray(store, type, value, prop);
+      if (included) {
+        documentHash.included = documentHash.included.concat(included);
+      }
+      if (isSingle) {
+        // eslint-disable-next-line @typescript-eslint/no-loop-func
+        data.forEach(resource => {
+          /*
+            Figures out if this is the primary record or not.
+             It's either:
+             1. The record with the same ID as the original request
+            2. If it's a newly created record without an ID, the first record
+               in the array
+           */
+          const isUpdatedRecord = isPrimary && coerceId(resource.id) === id;
+          const isFirstCreatedRecord = isPrimary && !id && !documentHash.data;
+          if (isFirstCreatedRecord || isUpdatedRecord) {
+            documentHash.data = resource;
+          } else {
+            // @ts-expect-error
+            documentHash.included.push(resource);
+          }
+        });
+      } else {
+        if (isPrimary) {
+          documentHash.data = data;
+        } else {
+          if (data) {
+            documentHash.included = documentHash.included.concat(data);
+          }
+        }
+      }
+    }
+    return documentHash;
+  },
+  isPrimaryType(store, modelName, primaryModelClass) {
+    return dasherize(modelName) === primaryModelClass.modelName;
+  },
+  /**
+    This method allows you to push a payload containing top-level
+    collections of records organized per type.
+     ```js
+    {
+      "posts": [{
+        "id": "1",
+        "title": "Rails is omakase",
+        "author", "1",
+        "comments": [ "1" ]
+      }],
+      "comments": [{
+        "id": "1",
+        "body": "FIRST"
+      }],
+      "users": [{
+        "id": "1",
+        "name": "@d2h"
+      }]
+    }
+    ```
+     It will first normalize the payload, so you can use this to push
+    in data streaming in from your server structured the same way
+    that fetches and saves are structured.
+     @public
+  */
+  pushPayload(store, payload) {
+    const documentHash = {
+      data: [],
+      included: []
+    };
+    for (const prop in payload) {
+      const type = this.modelNameFromPayloadKey(prop);
+      if (!store.schema.hasResource({
+        type
+      })) {
+        if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
+          // @ts-expect-error
+          warn(this.warnMessageNoModelForKey(prop, type), false, {
+            id: 'ds.serializer.model-for-key-missing'
+          });
+        }
+        continue;
+      }
+      const ModelSchema = store.modelFor(type);
+      const typeSerializer = store.serializerFor(ModelSchema.modelName);
+      makeArray(payload[prop]).forEach(hash => {
+        const {
+          data,
+          included
+        } = typeSerializer.normalize(ModelSchema, hash, prop);
+        // @ts-expect-error
+        documentHash.data.push(data);
+        if (included) {
+          documentHash.included = documentHash.included.concat(included);
+        }
+      });
+    }
+    store.push(documentHash);
+  },
+  /**
+    This method is used to convert each JSON root key in the payload
+    into a modelName that it can use to look up the appropriate model for
+    that part of the payload.
+     For example, your server may send a model name that does not correspond with
+    the name of the model in your app. Let's take a look at an example model,
+    and an example payload:
+     ```js [app/models/post.js]
+    import Model from '@warp-drive/legacy/model';
+     export default class Post extends Model {}
+    ```
+     ```javascript
+      {
+        "blog/post": {
+          "id": "1
+        }
+      }
+    ```
+     Ember Data is going to normalize the payload's root key for the modelName. As a result,
+    it will try to look up the "blog/post" model. Since we don't have a model called "blog/post"
+    (or a file called app/models/blog/post.js in ember-cli), Ember Data will throw an error
+    because it cannot find the "blog/post" model.
+     Since we want to remove this namespace, we can define a serializer for the application that will
+    remove "blog/" from the payload key whenver it's encountered by Ember Data:
+     ```js [app/serializers/application.js]
+    import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
+     export default class ApplicationSerializer extends RESTSerializer {
+      modelNameFromPayloadKey(payloadKey) {
+        if (payloadKey === 'blog/post') {
+          return super.modelNameFromPayloadKey(payloadKey.replace('blog/', ''));
+        } else {
+         return super.modelNameFromPayloadKey(payloadKey);
+        }
+      }
+    }
+    ```
+     After refreshing, Ember Data will appropriately look up the "post" model.
+     By default the modelName for a model is its
+    name in dasherized form. This means that a payload key like "blogPost" would be
+    normalized to "blog-post" when Ember Data looks up the model. Usually, Ember Data
+    can use the correct inflection to do this for you. Most of the time, you won't
+    need to override `modelNameFromPayloadKey` for this purpose.
+     @public
+    @return the model's modelName
+  */
+  modelNameFromPayloadKey(key) {
+    return dasherize(singularize(key));
+  },
+  // SERIALIZE
+
+  /**
+    Called when a record is saved in order to convert the
+    record into JSON.
+     By default, it creates a JSON object with a key for
+    each attribute and belongsTo relationship.
+     For example, consider this model:
+     ```js [app/models/comment.js]
+    import Model, { attr, belongsTo } from '@warp-drive/legacy/model';
+     export default class Comment extends Model {
+      @attr title
+      @attr body
+       @belongsTo('user') author
+    }
+    ```
+     The default serialization would create a JSON object like:
+     ```js
+    {
+      "title": "Rails is unagi",
+      "body": "Rails? Omakase? O_O",
+      "author": 12
+    }
+    ```
+     By default, attributes are passed through as-is, unless
+    you specified an attribute type (`attr('date')`). If
+    you specify a transform, the JavaScript value will be
+    serialized when inserted into the JSON hash.
+     By default, belongs-to relationships are converted into
+    IDs when inserted into the JSON hash.
+     ## IDs
+     `serialize` takes an options hash with a single option:
+    `includeId`. If this option is `true`, `serialize` will,
+    by default include the ID in the JSON object it builds.
+     The adapter passes in `includeId: true` when serializing
+    a record for `createRecord`, but not for `updateRecord`.
+     ## Customization
+     Your server may expect a different JSON format than the
+    built-in serialization format.
+     In that case, you can implement `serialize` yourself and
+    return a JSON hash of your choosing.
+     ```js [app/serializers/post.js]
+    import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
+     export default class ApplicationSerializer extends RESTSerializer {
+      serialize(snapshot, options) {
+        let json = {
+          POST_TTL: snapshot.attr('title'),
+          POST_BDY: snapshot.attr('body'),
+          POST_CMS: snapshot.hasMany('comments', { ids: true })
+        };
+         if (options.includeId) {
+          json.POST_ID_ = snapshot.id;
+        }
+         return json;
+      }
+    }
+    ```
+     ## Customizing an App-Wide Serializer
+     If you want to define a serializer for your entire
+    application, you'll probably want to use `eachAttribute`
+    and `eachRelationship` on the record.
+     ```js [app/serializers/application.js]
+    import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
+    import { pluralize } from '<app-name>/utils/string-utils';
+     export default class ApplicationSerializer extends RESTSerializer {
+      serialize(snapshot, options) {
+        let json = {};
+         snapshot.eachAttribute(function(name) {
+          json[serverAttributeName(name)] = snapshot.attr(name);
+        });
+         snapshot.eachRelationship(function(name, relationship) {
+          if (relationship.kind === 'hasMany') {
+            json[serverHasManyName(name)] = snapshot.hasMany(name, { ids: true });
+          }
+        });
+         if (options.includeId) {
+          json.ID_ = snapshot.id;
+        }
+         return json;
+      }
+    }
+     function serverAttributeName(attribute) {
+      return attribute.underscore().toUpperCase();
+    }
+     function serverHasManyName(name) {
+      return serverAttributeName(singularize(name)) + "_IDS";
+    }
+    ```
+     This serializer will generate JSON that looks like this:
+     ```js
+    {
+      "TITLE": "Rails is omakase",
+      "BODY": "Yep. Omakase.",
+      "COMMENT_IDS": [ 1, 2, 3 ]
+    }
+    ```
+     ## Tweaking the Default JSON
+     If you just want to do some small tweaks on the default JSON,
+    you can call super first and make the tweaks on the returned
+    JSON.
+     ```js [app/serializers/post.js]
+    import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
+     export default class ApplicationSerializer extends RESTSerializer {
+      serialize(snapshot, options) {
+        let json = super.serialize(snapshot, options);
+         json.subject = json.title;
+        delete json.title;
+         return json;
+      }
+    }
+    ```
+     @public
+  */
+  serialize(snapshot, options) {
+    // @ts-expect-error
+    return this._super(...arguments);
+  },
+  /**
+    You can use this method to customize the root keys serialized into the JSON.
+    The hash property should be modified by reference (possibly using something like _.extend)
+    By default the REST Serializer sends the modelName of a model, which is a camelized
+    version of the name.
+     For example, your server may expect underscored root objects.
+     ```js [app/serializers/application.js]
+    import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
+    import { underscore } from '<app-name>/utils/string-utils';
+     export default class ApplicationSerializer extends RESTSerializer {
+      serializeIntoHash(data, type, record, options) {
+        let root = underscore(type.modelName);
+        data[root] = this.serialize(record, options);
+      }
+    }
+    ```
+     @public
+  */
+  serializeIntoHash(hash, typeClass, snapshot, options) {
+    const normalizedRootKey = this.payloadKeyFromModelName(typeClass.modelName);
+    hash[normalizedRootKey] = this.serialize(snapshot, options);
+  },
+  /**
+    You can use `payloadKeyFromModelName` to override the root key for an outgoing
+    request. By default, the RESTSerializer returns a camelized version of the
+    model's name.
+     For a model called TacoParty, its `modelName` would be the string `taco-party`. The RESTSerializer
+    will send it to the server with `tacoParty` as the root key in the JSON payload:
+     ```js
+    {
+      "tacoParty": {
+        "id": "1",
+        "location": "Matthew Beale's House"
+      }
+    }
+    ```
+     For example, your server may expect dasherized root objects:
+     ```js [app/serializers/application.js]
+    import { RESTSerializer } from '@warp-drive/legacy/serializer/rest';
+    import { dasherize } from '<app-name>/utils/string-utils';
+     export default class ApplicationSerializer extends RESTSerializer {
+      payloadKeyFromModelName(modelName) {
+        return dasherize(modelName);
+      }
+    }
+    ```
+     Given a `TacoParty` model, calling `save` on it would produce an outgoing
+    request like:
+     ```js
+    {
+      "taco-party": {
+        "id": "1",
+        "location": "Matthew Beale's House"
+      }
+    }
+    ```
+     @public
+  */
+  payloadKeyFromModelName(modelName) {
+    return camelize(modelName);
+  },
+  /**
+    You can use this method to customize how polymorphic objects are serialized.
+    By default the REST Serializer creates the key by appending `Type` to
+    the attribute and value from the model's camelcased model name.
+     @public
+  */
+  serializePolymorphicType(snapshot, json, relationship) {
+    const name = relationship.name;
+    const typeKey = this.keyForPolymorphicType(name, relationship.type, 'serialize');
+    const belongsTo = snapshot.belongsTo(name);
+    if (!belongsTo) {
+      json[typeKey] = null;
+    } else {
+      // @ts-expect-error
+      json[typeKey] = camelize(belongsTo.modelName);
+    }
+  },
+  /**
+    You can use this method to customize how a polymorphic relationship should
+    be extracted.
+     @public
+    @param {Object} relationshipType
+    @param {Object} relationshipHash
+    @param {Object} relationshipOptions
+    @return {Object}
+   */
+  extractPolymorphicRelationship(relationshipType, relationshipHash, relationshipOptions) {
+    // @ts-expect-error
+    const {
+      key,
+      resourceHash,
+      relationshipMeta
+    } = relationshipOptions;
+
+    // A polymorphic belongsTo relationship can be present in the payload
+    // either in the form where the `id` and the `type` are given:
+    //
+    //   {
+    //     message: { id: 1, type: 'post' }
+    //   }
+    //
+    // or by the `id` and a `<relationship>Type` attribute:
+    //
+    //   {
+    //     message: 1,
+    //     messageType: 'post'
+    //   }
+    //
+    // The next code checks if the latter case is present and returns the
+    // corresponding JSON-API representation. The former case is handled within
+    // the base class JSONSerializer.
+    const isPolymorphic = relationshipMeta.options.polymorphic;
+    const typeProperty = this.keyForPolymorphicType(key, relationshipType, 'deserialize');
+    if (isPolymorphic && resourceHash[typeProperty] !== undefined && typeof relationshipHash !== 'object') {
+      const type = this.modelNameFromPayloadKey(resourceHash[typeProperty]);
+      return {
+        id: coerceId(relationshipHash),
+        type: type
+      };
+    }
+    // @ts-expect-error
+    return this._super(...arguments);
+  }
+});
+if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
+  RESTSerializer.reopen({
+    warnMessageNoModelForKey(prop, typeKey) {
+      return 'Encountered "' + prop + '" in payload, but no model was found for model name "' + typeKey + '" (resolved model name using ' + this.constructor.toString() + '.modelNameFromPayloadKey("' + prop + '"))';
+    }
+  });
+}
+export { EmbeddedRecordsMixin, RESTSerializer };