@warp-drive/legacy 5.9.0-alpha.21 → 5.9.0-alpha.22

package/dist/serializer/json-api.js

@@ -1,532 +1,540 @@
-import { warn } from '@ember/debug';
-import { dasherize, pluralize, singularize } from '@warp-drive/utilities/string';
-import { J as JSONSerializer } from "../json-DU8m1pGf.js";
-import { macroCondition, getGlobalConfig } from '@embroider/macros';
+import { t as JSONSerializer } from "../json-BXNPTlcH.js";
+import { warn } from "@ember/debug";
+import { getGlobalConfig, macroCondition } from "@embroider/macros";
+import { dasherize, pluralize, singularize } from "@warp-drive/utilities/string";
 
-/* eslint-disable @typescript-eslint/no-unsafe-return */
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable @typescript-eslint/no-unsafe-argument */
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-/* eslint-disable @typescript-eslint/no-unsafe-call */
-const JSONAPISerializer = JSONSerializer.extend({
-  /**
-    @private
-  */
-  _normalizeDocumentHelper(documentHash) {
-    if (Array.isArray(documentHash.data)) {
-      const ret = [];
-      for (let i = 0; i < documentHash.data.length; i++) {
-        const data = documentHash.data[i];
-        const normalized = this._normalizeResourceHelper(data);
-        if (normalized !== null) {
-          // @ts-expect-error untyped
-          // can be null when unknown type is encountered
-          ret.push(normalized);
-        }
-      }
-      documentHash.data = ret;
-    } else if (documentHash.data && typeof documentHash.data === 'object') {
-      documentHash.data = this._normalizeResourceHelper(documentHash.data);
-    }
-    if (Array.isArray(documentHash.included)) {
-      const ret = [];
-      for (let i = 0; i < documentHash.included.length; i++) {
-        const included = documentHash.included[i];
-        const normalized = this._normalizeResourceHelper(included);
-        if (normalized !== null) {
-          // @ts-expect-error untyped
-          // can be null when unknown type is encountered
-          ret.push(normalized);
-        }
-      }
-      documentHash.included = ret;
-    }
-    return documentHash;
-  },
-  /**
-    @private
-  */
-  _normalizeRelationshipDataHelper(relationshipDataHash) {
-    relationshipDataHash.type = this.modelNameFromPayloadKey(relationshipDataHash.type);
-    return relationshipDataHash;
-  },
-  /**
-    @private
-  */
-  _normalizeResourceHelper(resourceHash) {
-    // @ts-expect-error untyped
-    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
-      if (!test) {
-        throw new Error(this.warnMessageForUndefinedType());
-      }
-    })(resourceHash.type) : {};
-    const type = this.modelNameFromPayloadKey(resourceHash.type);
+//#region src/serializer/json-api.ts
+/**
+* :::danger
+⚠️ <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
+{@link Handler} instead to be used with the {@link RequestManager}
+:::
 
-    // @ts-expect-error store is dynamically added
-    if (!this.store.schema.hasResource({
-      type
-    })) {
-      if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
-        // @ts-expect-error untyped
-        warn(this.warnMessageNoModelForType(type, resourceHash.type, 'modelNameFromPayloadKey'), false, {
-          id: 'ds.serializer.model-for-type-missing'
-        });
-      }
-      return null;
-    }
+In WarpDrive a Serializer is used to serialize and deserialize
+records when they are transferred in and out of an external source.
+This process involves normalizing property names, transforming
+attribute values and serializing relationships.
 
-    // @ts-expect-error store is dynamically added
-    const modelClass = this.store.modelFor(type);
-    // @ts-expect-error store is dynamically added
-    const serializer = this.store.serializerFor(type);
-    const {
-      data
-    } = serializer.normalize(modelClass, resourceHash);
-    return data;
-  },
-  /**
-    Normalize some data and push it into the store.
-     @public
-  */
-  pushPayload(store, payload) {
-    const normalizedPayload = this._normalizeDocumentHelper(payload);
-    store.push(normalizedPayload);
-  },
-  /**
-    @return A {json:api} Document
-    @private
-  */
-  _normalizeResponse(store, primaryModelClass, payload, id, requestType, isSingle) {
-    const normalizedPayload = this._normalizeDocumentHelper(payload);
-    return normalizedPayload;
-  },
-  normalizeQueryRecordResponse() {
-    // @ts-expect-error untyped
-    const normalized = this._super(...arguments);
-    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
-      if (!test) {
-        throw new Error('Expected the primary data returned by the serializer for a `queryRecord` response to be a single object but instead it was an array.');
-      }
-    })(!Array.isArray(normalized.data)) : {};
-    return normalized;
-  },
-  extractAttributes(modelClass, resourceHash) {
-    const attributes = {};
-    if (resourceHash.attributes) {
-      modelClass.eachAttribute(key => {
-        const attributeKey = this.keyForAttribute(key, 'deserialize');
-        if (resourceHash.attributes[attributeKey] !== undefined) {
-          attributes[key] = resourceHash.attributes[attributeKey];
-        }
-        if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
-          if (resourceHash.attributes[attributeKey] === undefined && resourceHash.attributes[key] !== undefined) {
-            macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
-              {
-                throw new Error(`Your payload for '${modelClass.modelName}' contains '${key}', but your serializer is setup to look for '${attributeKey}'. This is most likely because Ember Data's JSON API serializer dasherizes attribute keys by default. You should subclass JSONAPISerializer and implement 'keyForAttribute(key) { return key; }' to prevent Ember Data from customizing your attribute keys.`);
-              }
-            })() : {};
-          }
-        }
-      });
-    }
-    return attributes;
-  },
-  /**
-     Returns a relationship formatted as a JSON-API "relationship object".
-      http://jsonapi.org/format/#document-resource-object-relationships
-     @public
-  */
-  extractRelationship(relationshipHash) {
-    if (Array.isArray(relationshipHash.data)) {
-      const ret = new Array(relationshipHash.data.length);
-      for (let i = 0; i < relationshipHash.data.length; i++) {
-        const data = relationshipHash.data[i];
-        ret[i] = this._normalizeRelationshipDataHelper(data);
-      }
-      relationshipHash.data = ret;
-    } else if (relationshipHash.data && typeof relationshipHash.data === 'object') {
-      relationshipHash.data = this._normalizeRelationshipDataHelper(relationshipHash.data);
-    }
-    return relationshipHash;
-  },
-  /**
-     Returns the resource's relationships formatted as a JSON-API "relationships object".
-      http://jsonapi.org/format/#document-resource-object-relationships
-     @public
-  */
-  extractRelationships(modelClass, resourceHash) {
-    const relationships = {};
-    if (resourceHash.relationships) {
-      modelClass.eachRelationship((key, relationshipMeta) => {
-        const relationshipKey = this.keyForRelationship(key, relationshipMeta.kind, 'deserialize');
-        if (resourceHash.relationships[relationshipKey] !== undefined) {
-          const relationshipHash = resourceHash.relationships[relationshipKey];
-          relationships[key] = this.extractRelationship(relationshipHash);
-        }
-        if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
-          if (resourceHash.relationships[relationshipKey] === undefined && resourceHash.relationships[key] !== undefined) {
-            macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
-              {
-                throw new Error(`Your payload for '${modelClass.modelName}' contains '${key}', but your serializer is setup to look for '${relationshipKey}'. This is most likely because Ember Data's JSON API serializer dasherizes relationship keys by default. You should subclass JSONAPISerializer and implement 'keyForRelationship(key) { return key; }' to prevent Ember Data from customizing your relationship keys.`);
-              }
-            })() : {};
-          }
-        }
-      });
-    }
-    return relationships;
-  },
-  /**
-    @private
-  */
-  _extractType(modelClass, resourceHash) {
-    return this.modelNameFromPayloadKey(resourceHash.type);
-  },
-  /**
-    Dasherizes and singularizes the model name in the payload to match
-    the common convention for model names.
-     For example the key `posts` would be converted to `post` and the
-    key `studentAssesments` would be converted to `student-assesment`.
-     @public
-    @return the model's modelName
-  */
-  modelNameFromPayloadKey(key) {
-    return dasherize(singularize(key));
-  },
-  /**
-    Converts the model name to a pluralized version of the model name.
-     For example `post` would be converted to `posts` and
-    `student-assesment` would be converted to `student-assesments`.
-     @public
-  */
-  payloadKeyFromModelName(modelName) {
-    return pluralize(modelName);
-  },
-  normalize(modelClass, resourceHash) {
-    if (resourceHash.attributes) {
-      // @ts-expect-error untyped
-      this.normalizeUsingDeclaredMapping(modelClass, resourceHash.attributes);
-    }
-    if (resourceHash.relationships) {
-      // @ts-expect-error untyped
-      this.normalizeUsingDeclaredMapping(modelClass, resourceHash.relationships);
-    }
-    const data = {
-      // @ts-expect-error untyped
-      id: this.extractId(modelClass, resourceHash),
-      type: this._extractType(modelClass, resourceHash),
-      attributes: this.extractAttributes(modelClass, resourceHash),
-      relationships: this.extractRelationships(modelClass, resourceHash)
-    };
-    if (resourceHash.lid) {
-      // @ts-expect-error untyped
-      data.lid = resourceHash.lid;
-    }
+`JSONAPISerializer` supports the http://jsonapi.org/ spec, though
+even compliant {json:api} servers may find writing an application
+specific serializer better suited to their needs and more performant.
 
-    // @ts-expect-error untyped
-    this.applyTransforms(modelClass, data.attributes);
-    return {
-      data
-    };
-  },
-  /**
-    `keyForAttribute` can be used to define rules for how to convert an
-    attribute name in your model to a key in your JSON.
-    By default `JSONAPISerializer` follows the format used on the examples of
-    http://jsonapi.org/format and uses dashes as the word separator in the JSON
-    attribute keys.
-     This behaviour can be easily customized by extending this method.
-     Example
-     ```js [app/serializers/application.js]
-    import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
-    import { dasherize } from '<app-name>/utils/string-utils';
-     export default class ApplicationSerializer extends JSONAPISerializer {
-      keyForAttribute(attr, method) {
-        return dasherize(attr).toUpperCase();
-      }
-    }
-    ```
-     @public
-    @return normalized key
-  */
-  keyForAttribute(key, method) {
-    return dasherize(key);
-  },
-  /**
-   `keyForRelationship` can be used to define a custom key when
-   serializing and deserializing relationship properties.
-   By default `JSONAPISerializer` follows the format used on the examples of
-   http://jsonapi.org/format and uses dashes as word separators in
-   relationship properties.
-    This behaviour can be easily customized by extending this method.
-    Example
-     ```js [app/serializers/post.js]
-    import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
-    import { underscore } from '<app-name>/utils/string-utils';
-     export default class ApplicationSerializer extends JSONAPISerializer {
-      keyForRelationship(key, relationship, method) {
-        return underscore(key);
-      }
-    }
-    ```
-    @public
-   @return the normalized key
-  */
-  keyForRelationship(key, typeClass, method) {
-    return dasherize(key);
-  },
-  /**
-    Called when a record is saved in order to convert the
-    record into JSON.
-     For example, consider this model:
-     ```js [app/models/comment.js]
-    import Model, { attr, belongsTo } from '@warp-drive/legacy/model';
-     export default class CommentModel extends Model {
-      @attr title;
-      @attr body;
-       @belongsTo('user', { async: false, inverse: null })
-      author;
-    }
-    ```
-     The default serialization would create a JSON-API resource object like:
-     ```javascript
-    {
-      "data": {
-        "type": "comments",
-        "attributes": {
-          "title": "Rails is unagi",
-          "body": "Rails? Omakase? O_O",
-        },
-        "relationships": {
-          "author": {
-            "data": {
-              "id": "12",
-              "type": "users"
-            }
-          }
-        }
-      }
-    }
-    ```
-     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 attributes hash.
-     Belongs-to relationships are converted into JSON-API
-    resource identifier objects.
-     ## 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 JSONAPIAdapter passes in `includeId: true` when serializing a record
-    for `createRecord` or `updateRecord`.
-     ## Customization
-     Your server may expect data in a different format than the
-    built-in serialization format.
-     In that case, you can implement `serialize` yourself and
-    return data formatted to match your API's expectations, or override
-    the invoked adapter method and do the serialization in the adapter directly
-    by using the provided snapshot.
-     If your API's format differs greatly from the JSON:API spec, you should
-    consider authoring your own adapter and serializer instead of extending
-    this class.
-     ```js [app/serializers/post.js]
-    import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
-     export default class PostSerializer extends JSONAPISerializer {
-      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 JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
-    import { underscore, singularize } from '<app-name>/utils/string-utils';
-     export default class ApplicationSerializer extends JSONAPISerializer {
-      serialize(snapshot, options) {
-        let json = {};
-         snapshot.eachAttribute((name) => {
-          json[serverAttributeName(name)] = snapshot.attr(name);
-        });
-         snapshot.eachRelationship((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 underscore(attribute).toUpperCase();
-    }
-     function serverHasManyName(name) {
-      return serverAttributeName(singularize(name)) + '_IDS';
-    }
-    ```
-     This serializer will generate JSON that looks like this:
-     ```javascript
-    {
-      "TITLE": "Rails is omakase",
-      "BODY": "Yep. Omakase.",
-      "COMMENT_IDS": [ "1", "2", "3" ]
-    }
-    ```
-     ## Tweaking the Default Formatting
-     If you just want to do some small tweaks on the default JSON:API formatted response,
-    you can call `super.serialize` first and make the tweaks
-    on the returned object.
-     ```js [app/serializers/post.js]
-    import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
-     export default class PostSerializer extends JSONAPISerializer {
-      serialize(snapshot, options) {
-        let json = super.serialize(...arguments);
-         json.data.attributes.subject = json.data.attributes.title;
-        delete json.data.attributes.title;
-         return json;
-      }
-    }
-    ```
-     @public
-  */
-  serialize(snapshot, options) {
-    // @ts-expect-error untyped
-    const data = this._super(...arguments);
-    data.type = this.payloadKeyFromModelName(snapshot.modelName);
-    return {
-      data
-    };
-  },
-  serializeAttribute(snapshot, json, key, attribute) {
-    const type = attribute.type;
+This serializer normalizes a JSON API payload that looks like:
 
-    // @ts-expect-error untyped
-    if (this._canSerialize(key)) {
-      json.attributes = json.attributes || {};
-      let value = snapshot.attr(key);
-      if (type) {
-        // @ts-expect-error untyped
-        const transform = this.transformFor(type);
-        value = transform.serialize(value, attribute.options);
-      }
+```js [app/models/player.js]
+import Model, { attr, belongsTo } from '@warp-drive/legacy/model';
 
-      // @ts-expect-error store is dynamically added
-      const schema = this.store.modelFor(snapshot.modelName);
-      // @ts-expect-error untyped
-      let payloadKey = this._getMappedKey(key, schema);
-      if (payloadKey === key) {
-        payloadKey = this.keyForAttribute(key, 'serialize');
-      }
-      json.attributes[payloadKey] = value;
-    }
-  },
-  serializeBelongsTo(snapshot, json, relationship) {
-    const name = relationship.name;
+export default class Player extends Model {
+@attr('string') name;
+@attr('string') skill;
+@attr('number') gamesPlayed;
+@belongsTo('club') club;
+}
+```
 
-    // @ts-expect-error untyped
-    if (this._canSerialize(name)) {
-      const belongsTo = snapshot.belongsTo(name);
-      // @ts-expect-error not narrowed
-      const belongsToIsNotNew = belongsTo && !belongsTo.isNew;
-      if (belongsTo === null || belongsToIsNotNew) {
-        json.relationships = json.relationships || {};
+```js [app/models/club.js]
+import Model, { attr, hasMany } from '@warp-drive/legacy/model';
 
-        // @ts-expect-error store is dynamically added
-        const schema = this.store.modelFor(snapshot.modelName);
-        // @ts-expect-error untyped
-        let payloadKey = this._getMappedKey(name, schema);
-        if (payloadKey === name) {
-          payloadKey = this.keyForRelationship(name, 'belongsTo', 'serialize');
-        }
-        let data = null;
-        if (belongsTo) {
-          // @ts-expect-error not narrowed
-          const payloadType = this.payloadKeyFromModelName(belongsTo.modelName);
+export default class Club extends Model {
+@attr('string') name;
+@attr('string') location;
+@hasMany('player') players;
+}
+```
 
-          // @ts-expect-error untyped
-          data = {
-            type: payloadType,
-            // @ts-expect-error not narrowed
-            id: belongsTo.id
-          };
-        }
-        json.relationships[payloadKey] = {
-          data
-        };
-      }
-    }
-  },
-  serializeHasMany(snapshot, json, relationship) {
-    const name = relationship.name;
+```js
+{
+"data": [
+{
+"attributes": {
+"name": "Benfica",
+"location": "Portugal"
+},
+"id": "1",
+"relationships": {
+"players": {
+"data": [
+{
+"id": "3",
+"type": "players"
+}
+]
+}
+},
+"type": "clubs"
+}
+],
+"included": [
+{
+"attributes": {
+"name": "Eusebio Silva Ferreira",
+"skill": "Rocket shot",
+"games-played": 431
+},
+"id": "3",
+"relationships": {
+"club": {
+"data": {
+"id": "1",
+"type": "clubs"
+}
+}
+},
+"type": "players"
+}
+]
+}
+```
 
-    // @ts-expect-error untyped
-    if (this.shouldSerializeHasMany(snapshot, name, relationship)) {
-      const hasMany = snapshot.hasMany(name);
-      if (hasMany !== undefined) {
-        json.relationships = json.relationships || {};
+to the format that the JSONAPICache expects.
 
-        // @ts-expect-error store is dynamically added
-        const schema = this.store.modelFor(snapshot.modelName);
-        // @ts-expect-error untyped
-        let payloadKey = this._getMappedKey(name, schema);
-        if (payloadKey === name && this.keyForRelationship) {
-          payloadKey = this.keyForRelationship(name, 'hasMany', 'serialize');
-        }
+### Customizing meta
 
-        // only serialize has many relationships that are not new
-        // @ts-expect-error not narrowed
-        const nonNewHasMany = hasMany.filter(item => !item.isNew);
-        const data = new Array(nonNewHasMany.length);
-        for (let i = 0; i < nonNewHasMany.length; i++) {
-          const item = hasMany[i];
-          // @ts-expect-error not narrowed
-          const payloadType = this.payloadKeyFromModelName(item.modelName);
-          data[i] = {
-            type: payloadType,
-            // @ts-expect-error not narrowed
-            id: item.id
-          };
-        }
-        json.relationships[payloadKey] = {
-          data
-        };
-      }
-    }
-  }
-});
-if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
-  JSONAPISerializer.reopen({
-    init(...args) {
-      this._super(...args);
-      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
-        if (!test) {
-          throw new Error(`You've used the EmbeddedRecordsMixin in ${this.toString()} which is not fully compatible with the JSON:API specification. Please confirm that this works for your specific API and add \`this.isEmbeddedRecordsMixinCompatible = true\` to your serializer.`);
-        }
-      })(!this.isEmbeddedRecordsMixin || this.isEmbeddedRecordsMixinCompatible === true) : {};
-      const constructor = this.constructor;
-      warn(`You've defined 'extractMeta' in ${constructor.toString()} which is not used for serializers extending JSONAPISerializer. Read more at https://api.emberjs.com/ember-data/release/classes/JSONAPISerializer on how to customize meta when using JSON API.`, this.extractMeta === JSONSerializer.prototype.extractMeta, {
-        id: 'ds.serializer.json-api.extractMeta'
-      });
-    },
-    warnMessageForUndefinedType() {
-      return 'Encountered a resource object with an undefined type (resolved resource using ' + this.constructor.toString() + ')';
-    },
-    warnMessageNoModelForType(modelName, originalType, usedLookup) {
-      return `Encountered a resource object with type "${originalType}", but no model was found for model name "${modelName}" (resolved model name using '${this.constructor.toString()}.${usedLookup}("${originalType}")').`;
-    }
-  });
+Since a JSON API Document can have meta defined in multiple locations you can
+use the specific serializer hooks if you need to customize the meta.
+
+One scenario would be to camelCase the meta keys of your payload. The example
+below shows how this could be done using `normalizeArrayResponse` and
+`extractRelationship`.
+
+```js [app/serializers/application.js]
+import { JSONAPISerializer } from '@warp-drive/legacy/serializer/json-api';
+
+export default class ApplicationSerializer extends JSONAPISerializer {
+normalizeArrayResponse(store, primaryModelClass, payload, id, requestType) {
+let normalizedDocument = super.normalizeArrayResponse(...arguments);
+
+// Customize document meta
+normalizedDocument.meta = camelCaseKeys(normalizedDocument.meta);
+
+return normalizedDocument;
+}
+
+extractRelationship(relationshipHash) {
+let normalizedRelationship = super.extractRelationship(...arguments);
+
+// Customize relationship meta
+normalizedRelationship.meta = camelCaseKeys(normalizedRelationship.meta);
+
+return normalizedRelationship;
 }
-export { JSONAPISerializer };
+}
+```
+
+@since 1.13.0
+@class JSONAPISerializer
+@public
+*/
+const JSONAPISerializer = JSONSerializer.extend({
+	/**
+	@private
+	*/
+	_normalizeDocumentHelper(documentHash) {
+		if (Array.isArray(documentHash.data)) {
+			const ret = [];
+			for (let i = 0; i < documentHash.data.length; i++) {
+				const data = documentHash.data[i];
+				const normalized = this._normalizeResourceHelper(data);
+				if (normalized !== null) ret.push(normalized);
+			}
+			documentHash.data = ret;
+		} else if (documentHash.data && typeof documentHash.data === "object") documentHash.data = this._normalizeResourceHelper(documentHash.data);
+		if (Array.isArray(documentHash.included)) {
+			const ret = [];
+			for (let i = 0; i < documentHash.included.length; i++) {
+				const included = documentHash.included[i];
+				const normalized = this._normalizeResourceHelper(included);
+				if (normalized !== null) ret.push(normalized);
+			}
+			documentHash.included = ret;
+		}
+		return documentHash;
+	},
+	/**
+	@private
+	*/
+	_normalizeRelationshipDataHelper(relationshipDataHash) {
+		relationshipDataHash.type = this.modelNameFromPayloadKey(relationshipDataHash.type);
+		return relationshipDataHash;
+	},
+	/**
+	@private
+	*/
+	_normalizeResourceHelper(resourceHash) {
+		macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) && ((test) => {
+			if (!test) throw new Error(this.warnMessageForUndefinedType());
+		})(resourceHash.type);
+		const type = this.modelNameFromPayloadKey(resourceHash.type);
+		if (!this.store.schema.hasResource({ type })) {
+			if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) warn(this.warnMessageNoModelForType(type, resourceHash.type, "modelNameFromPayloadKey"), false, { id: "ds.serializer.model-for-type-missing" });
+			return null;
+		}
+		const modelClass = this.store.modelFor(type);
+		const { data } = this.store.serializerFor(type).normalize(modelClass, resourceHash);
+		return data;
+	},
+	/**
+	Normalize some data and push it into the store.
+	@public
+	*/
+	pushPayload(store, payload) {
+		const normalizedPayload = this._normalizeDocumentHelper(payload);
+		store.push(normalizedPayload);
+	},
+	/**
+	@return A {json:api} Document
+	@private
+	*/
+	_normalizeResponse(store, primaryModelClass, payload, id, requestType, isSingle) {
+		return this._normalizeDocumentHelper(payload);
+	},
+	normalizeQueryRecordResponse() {
+		const normalized = this._super(...arguments);
+		macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) && ((test) => {
+			if (!test) throw new Error("Expected the primary data returned by the serializer for a `queryRecord` response to be a single object but instead it was an array.");
+		})(!Array.isArray(normalized.data));
+		return normalized;
+	},
+	extractAttributes(modelClass, resourceHash) {
+		const attributes = {};
+		if (resourceHash.attributes) modelClass.eachAttribute((key) => {
+			const attributeKey = this.keyForAttribute(key, "deserialize");
+			if (resourceHash.attributes[attributeKey] !== void 0) attributes[key] = resourceHash.attributes[attributeKey];
+			if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
+				if (resourceHash.attributes[attributeKey] === void 0 && resourceHash.attributes[key] !== void 0) macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) && ((test) => {
+					if (!test) throw new Error(`Your payload for '${modelClass.modelName}' contains '${key}', but your serializer is setup to look for '${attributeKey}'. This is most likely because Ember Data's JSON API serializer dasherizes attribute keys by default. You should subclass JSONAPISerializer and implement 'keyForAttribute(key) { return key; }' to prevent Ember Data from customizing your attribute keys.`);
+				})(false);
+			}
+		});
+		return attributes;
+	},
+	/**
+	Returns a relationship formatted as a JSON-API "relationship object".
+	http://jsonapi.org/format/#document-resource-object-relationships
+	@public
+	*/
+	extractRelationship(relationshipHash) {
+		if (Array.isArray(relationshipHash.data)) {
+			const ret = new Array(relationshipHash.data.length);
+			for (let i = 0; i < relationshipHash.data.length; i++) {
+				const data = relationshipHash.data[i];
+				ret[i] = this._normalizeRelationshipDataHelper(data);
+			}
+			relationshipHash.data = ret;
+		} else if (relationshipHash.data && typeof relationshipHash.data === "object") relationshipHash.data = this._normalizeRelationshipDataHelper(relationshipHash.data);
+		return relationshipHash;
+	},
+	/**
+	Returns the resource's relationships formatted as a JSON-API "relationships object".
+	http://jsonapi.org/format/#document-resource-object-relationships
+	@public
+	*/
+	extractRelationships(modelClass, resourceHash) {
+		const relationships = {};
+		if (resourceHash.relationships) modelClass.eachRelationship((key, relationshipMeta) => {
+			const relationshipKey = this.keyForRelationship(key, relationshipMeta.kind, "deserialize");
+			if (resourceHash.relationships[relationshipKey] !== void 0) {
+				const relationshipHash = resourceHash.relationships[relationshipKey];
+				relationships[key] = this.extractRelationship(relationshipHash);
+			}
+			if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
+				if (resourceHash.relationships[relationshipKey] === void 0 && resourceHash.relationships[key] !== void 0) macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) && ((test) => {
+					if (!test) throw new Error(`Your payload for '${modelClass.modelName}' contains '${key}', but your serializer is setup to look for '${relationshipKey}'. This is most likely because Ember Data's JSON API serializer dasherizes relationship keys by default. You should subclass JSONAPISerializer and implement 'keyForRelationship(key) { return key; }' to prevent Ember Data from customizing your relationship keys.`);
+				})(false);
+			}
+		});
+		return relationships;
+	},
+	/**
+	@private
+	*/
+	_extractType(modelClass, resourceHash) {
+		return this.modelNameFromPayloadKey(resourceHash.type);
+	},
+	/**
+	Dasherizes and singularizes the model name in the payload to match
+	the common convention for model names.
+	For example the key `posts` would be converted to `post` and the
+	key `studentAssesments` would be converted to `student-assesment`.
+	@public
+	@return the model's modelName
+	*/
+	modelNameFromPayloadKey(key) {
+		return dasherize(singularize(key));
+	},
+	/**
+	Converts the model name to a pluralized version of the model name.
+	For example `post` would be converted to `posts` and
+	`student-assesment` would be converted to `student-assesments`.
+	@public
+	*/
+	payloadKeyFromModelName(modelName) {
+		return pluralize(modelName);
+	},
+	normalize(modelClass, resourceHash) {
+		if (resourceHash.attributes) this.normalizeUsingDeclaredMapping(modelClass, resourceHash.attributes);
+		if (resourceHash.relationships) this.normalizeUsingDeclaredMapping(modelClass, resourceHash.relationships);
+		const data = {
+			id: this.extractId(modelClass, resourceHash),
+			type: this._extractType(modelClass, resourceHash),
+			attributes: this.extractAttributes(modelClass, resourceHash),
+			relationships: this.extractRelationships(modelClass, resourceHash)
+		};
+		if (resourceHash.lid) data.lid = resourceHash.lid;
+		this.applyTransforms(modelClass, data.attributes);
+		return { data };
+	},
+	/**
+	`keyForAttribute` can be used to define rules for how to convert an
+	attribute name in your model to a key in your JSON.
+	By default `JSONAPISerializer` follows the format used on the examples of
+	http://jsonapi.org/format and uses dashes as the word separator in the JSON
+	attribute keys.
+	This behaviour can be easily customized by extending this method.
+	Example
+	```js [app/serializers/application.js]
+	import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
+	import { dasherize } from '<app-name>/utils/string-utils';
+	export default class ApplicationSerializer extends JSONAPISerializer {
+	keyForAttribute(attr, method) {
+	return dasherize(attr).toUpperCase();
+	}
+	}
+	```
+	@public
+	@return normalized key
+	*/
+	keyForAttribute(key, method) {
+		return dasherize(key);
+	},
+	/**
+	`keyForRelationship` can be used to define a custom key when
+	serializing and deserializing relationship properties.
+	By default `JSONAPISerializer` follows the format used on the examples of
+	http://jsonapi.org/format and uses dashes as word separators in
+	relationship properties.
+	This behaviour can be easily customized by extending this method.
+	Example
+	```js [app/serializers/post.js]
+	import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
+	import { underscore } from '<app-name>/utils/string-utils';
+	export default class ApplicationSerializer extends JSONAPISerializer {
+	keyForRelationship(key, relationship, method) {
+	return underscore(key);
+	}
+	}
+	```
+	@public
+	@return the normalized key
+	*/
+	keyForRelationship(key, typeClass, method) {
+		return dasherize(key);
+	},
+	/**
+	Called when a record is saved in order to convert the
+	record into JSON.
+	For example, consider this model:
+	```js [app/models/comment.js]
+	import Model, { attr, belongsTo } from '@warp-drive/legacy/model';
+	export default class CommentModel extends Model {
+	@attr title;
+	@attr body;
+	@belongsTo('user', { async: false, inverse: null })
+	author;
+	}
+	```
+	The default serialization would create a JSON-API resource object like:
+	```javascript
+	{
+	"data": {
+	"type": "comments",
+	"attributes": {
+	"title": "Rails is unagi",
+	"body": "Rails? Omakase? O_O",
+	},
+	"relationships": {
+	"author": {
+	"data": {
+	"id": "12",
+	"type": "users"
+	}
+	}
+	}
+	}
+	}
+	```
+	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 attributes hash.
+	Belongs-to relationships are converted into JSON-API
+	resource identifier objects.
+	## 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 JSONAPIAdapter passes in `includeId: true` when serializing a record
+	for `createRecord` or `updateRecord`.
+	## Customization
+	Your server may expect data in a different format than the
+	built-in serialization format.
+	In that case, you can implement `serialize` yourself and
+	return data formatted to match your API's expectations, or override
+	the invoked adapter method and do the serialization in the adapter directly
+	by using the provided snapshot.
+	If your API's format differs greatly from the JSON:API spec, you should
+	consider authoring your own adapter and serializer instead of extending
+	this class.
+	```js [app/serializers/post.js]
+	import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
+	export default class PostSerializer extends JSONAPISerializer {
+	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 JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
+	import { underscore, singularize } from '<app-name>/utils/string-utils';
+	export default class ApplicationSerializer extends JSONAPISerializer {
+	serialize(snapshot, options) {
+	let json = {};
+	snapshot.eachAttribute((name) => {
+	json[serverAttributeName(name)] = snapshot.attr(name);
+	});
+	snapshot.eachRelationship((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 underscore(attribute).toUpperCase();
+	}
+	function serverHasManyName(name) {
+	return serverAttributeName(singularize(name)) + '_IDS';
+	}
+	```
+	This serializer will generate JSON that looks like this:
+	```javascript
+	{
+	"TITLE": "Rails is omakase",
+	"BODY": "Yep. Omakase.",
+	"COMMENT_IDS": [ "1", "2", "3" ]
+	}
+	```
+	## Tweaking the Default Formatting
+	If you just want to do some small tweaks on the default JSON:API formatted response,
+	you can call `super.serialize` first and make the tweaks
+	on the returned object.
+	```js [app/serializers/post.js]
+	import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
+	export default class PostSerializer extends JSONAPISerializer {
+	serialize(snapshot, options) {
+	let json = super.serialize(...arguments);
+	json.data.attributes.subject = json.data.attributes.title;
+	delete json.data.attributes.title;
+	return json;
+	}
+	}
+	```
+	@public
+	*/
+	serialize(snapshot, options) {
+		const data = this._super(...arguments);
+		data.type = this.payloadKeyFromModelName(snapshot.modelName);
+		return { data };
+	},
+	serializeAttribute(snapshot, json, key, attribute) {
+		const type = attribute.type;
+		if (this._canSerialize(key)) {
+			json.attributes = json.attributes || {};
+			let value = snapshot.attr(key);
+			if (type) value = this.transformFor(type).serialize(value, attribute.options);
+			const schema = this.store.modelFor(snapshot.modelName);
+			let payloadKey = this._getMappedKey(key, schema);
+			if (payloadKey === key) payloadKey = this.keyForAttribute(key, "serialize");
+			json.attributes[payloadKey] = value;
+		}
+	},
+	serializeBelongsTo(snapshot, json, relationship) {
+		const name = relationship.name;
+		if (this._canSerialize(name)) {
+			const belongsTo = snapshot.belongsTo(name);
+			const belongsToIsNotNew = belongsTo && !belongsTo.isNew;
+			if (belongsTo === null || belongsToIsNotNew) {
+				json.relationships = json.relationships || {};
+				const schema = this.store.modelFor(snapshot.modelName);
+				let payloadKey = this._getMappedKey(name, schema);
+				if (payloadKey === name) payloadKey = this.keyForRelationship(name, "belongsTo", "serialize");
+				let data = null;
+				if (belongsTo) data = {
+					type: this.payloadKeyFromModelName(belongsTo.modelName),
+					id: belongsTo.id
+				};
+				json.relationships[payloadKey] = { data };
+			}
+		}
+	},
+	serializeHasMany(snapshot, json, relationship) {
+		const name = relationship.name;
+		if (this.shouldSerializeHasMany(snapshot, name, relationship)) {
+			const hasMany = snapshot.hasMany(name);
+			if (hasMany !== void 0) {
+				json.relationships = json.relationships || {};
+				const schema = this.store.modelFor(snapshot.modelName);
+				let payloadKey = this._getMappedKey(name, schema);
+				if (payloadKey === name && this.keyForRelationship) payloadKey = this.keyForRelationship(name, "hasMany", "serialize");
+				const nonNewHasMany = hasMany.filter((item) => !item.isNew);
+				const data = new Array(nonNewHasMany.length);
+				for (let i = 0; i < nonNewHasMany.length; i++) {
+					const item = hasMany[i];
+					const payloadType = this.payloadKeyFromModelName(item.modelName);
+					data[i] = {
+						type: payloadType,
+						id: item.id
+					};
+				}
+				json.relationships[payloadKey] = { data };
+			}
+		}
+	}
+});
+if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) JSONAPISerializer.reopen({
+	init(...args) {
+		this._super(...args);
+		macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) && ((test) => {
+			if (!test) throw new Error(`You've used the EmbeddedRecordsMixin in ${this.toString()} which is not fully compatible with the JSON:API specification. Please confirm that this works for your specific API and add \`this.isEmbeddedRecordsMixinCompatible = true\` to your serializer.`);
+		})(!this.isEmbeddedRecordsMixin || this.isEmbeddedRecordsMixinCompatible === true);
+		const constructor = this.constructor;
+		warn(`You've defined 'extractMeta' in ${constructor.toString()} which is not used for serializers extending JSONAPISerializer. Read more at https://api.emberjs.com/ember-data/release/classes/JSONAPISerializer on how to customize meta when using JSON API.`, this.extractMeta === JSONSerializer.prototype.extractMeta, { id: "ds.serializer.json-api.extractMeta" });
+	},
+	warnMessageForUndefinedType() {
+		return "Encountered a resource object with an undefined type (resolved resource using " + this.constructor.toString() + ")";
+	},
+	warnMessageNoModelForType(modelName, originalType, usedLookup) {
+		return `Encountered a resource object with type "${originalType}", but no model was found for model name "${modelName}" (resolved model name using '${this.constructor.toString()}.${usedLookup}("${originalType}")').`;
+	}
+});
+
+//#endregion
+export { JSONAPISerializer };
+//# sourceMappingURL=json-api.js.map