@ember-data-mirror/serializer 5.6.0-alpha.2 → 5.6.0-alpha.4

package/dist/{json-CVTR4xWv.js → json-CYP2BhR9.js}

@@ -14,10 +14,6 @@ function coerceId(id) {
     return String(id);
   }
 }
-
-/**
- * @module @ember-data-mirror/serializer/json
- */
 const SOURCE_POINTER_REGEXP = /^\/?data\/(attributes|relationships)\/(.*)/;
 const SOURCE_POINTER_PRIMARY_REGEXP = /^\/?data/;
 const PRIMARY_ATTRIBUTE_KEY = 'base';
@@ -43,7 +39,7 @@ const PRIMARY_ATTRIBUTE_KEY = 'base';
 
   For example, given the following `User` model and JSON payload:
 
-  ```app/models/user.js
+  ```js [app/models/user.js]
   import Model, { attr, belongsTo, hasMany } from '@ember-data-mirror/model';
 
   export default class UserModel extends Model {
@@ -94,10 +90,8 @@ const PRIMARY_ATTRIBUTE_KEY = 'base';
         - `normalize` delegates to these methods to
           turn the record payload into the JSON API format.
 
-  @main @ember-data-mirror/serializer/json
   @class JSONSerializer
   @public
-  @extends Serializer
 */
 const JSONSerializer = Serializer.extend({
   /**
@@ -108,7 +102,7 @@ const JSONSerializer = Serializer.extend({
     `primaryKey` property to match the `primaryKey` of your external
     store.
      Example
-     ```app/serializers/application.js
+     ```js [app/serializers/application.js]
     import JSONSerializer from '@ember-data-mirror/serializer/json';
      export default class ApplicationSerializer extends JSONSerializer {
       primaryKey = '_id'
@@ -127,7 +121,7 @@ const JSONSerializer = Serializer.extend({
     property `key` can also be used to designate the attribute's key on
     the response payload.
      Example
-     ```app/models/person.js
+     ```js [app/models/person.js]
     import Model, { attr } from '@ember-data-mirror/model';
      export default class PersonModel extends Model {
       @attr('string') firstName;
@@ -136,7 +130,7 @@ const JSONSerializer = Serializer.extend({
       @attr('boolean') admin;
     }
     ```
-     ```app/serializers/person.js
+     ```js [app/serializers/person.js]
     import JSONSerializer from '@ember-data-mirror/serializer/json';
      export default class PersonSerializer extends JSONSerializer {
       attrs = {
@@ -148,7 +142,7 @@ const JSONSerializer = Serializer.extend({
      You can also remove attributes and relationships by setting the `serialize`
     key to `false` in your mapping object.
      Example
-     ```app/serializers/person.js
+     ```js [app/serializers/person.js]
     import JSONSerializer from '@ember-data-mirror/serializer/json';
      export default class PostSerializer extends JSONSerializer {
       attrs = {
@@ -180,8 +174,7 @@ const JSONSerializer = Serializer.extend({
    `Transform#deserialize` method on the matching property of the
    JSON object.  This method is typically called after the
    serializer's `normalize` method.
-    @method applyTransforms
-   @private
+    @private
    @param {Model} typeClass
    @param {Object} data The data to transform
    @return {Object} data The transformed data object
@@ -218,7 +211,6 @@ const JSONSerializer = Serializer.extend({
     });
     ```
      @since 1.13.0
-    @method normalizeResponse
     @public
     @param {Store} store
     @param {Model} primaryModelClass
@@ -255,7 +247,6 @@ const JSONSerializer = Serializer.extend({
     Called by the default normalizeResponse implementation when the
     type of request is `findRecord`
      @since 1.13.0
-    @method normalizeFindRecordResponse
     @public
     @param {Store} store
     @param {Model} primaryModelClass
@@ -271,7 +262,6 @@ const JSONSerializer = Serializer.extend({
     Called by the default normalizeResponse implementation when the
     type of request is `queryRecord`
      @since 1.13.0
-    @method normalizeQueryRecordResponse
     @public
     @param {Store} store
     @param {Model} primaryModelClass
@@ -287,7 +277,6 @@ const JSONSerializer = Serializer.extend({
     Called by the default normalizeResponse implementation when the
     type of request is `findAll`
      @since 1.13.0
-    @method normalizeFindAllResponse
     @public
     @param {Store} store
     @param {Model} primaryModelClass
@@ -303,7 +292,6 @@ const JSONSerializer = Serializer.extend({
     Called by the default normalizeResponse implementation when the
     type of request is `findBelongsTo`
      @since 1.13.0
-    @method normalizeFindBelongsToResponse
     @public
     @param {Store} store
     @param {Model} primaryModelClass
@@ -319,7 +307,6 @@ const JSONSerializer = Serializer.extend({
     Called by the default normalizeResponse implementation when the
     type of request is `findHasMany`
      @since 1.13.0
-    @method normalizeFindHasManyResponse
     @public
     @param {Store} store
     @param {Model} primaryModelClass
@@ -335,7 +322,6 @@ const JSONSerializer = Serializer.extend({
     Called by the default normalizeResponse implementation when the
     type of request is `findMany`
      @since 1.13.0
-    @method normalizeFindManyResponse
     @public
     @param {Store} store
     @param {Model} primaryModelClass
@@ -351,7 +337,6 @@ const JSONSerializer = Serializer.extend({
     Called by the default normalizeResponse implementation when the
     type of request is `query`
      @since 1.13.0
-    @method normalizeQueryResponse
     @public
     @param {Store} store
     @param {Model} primaryModelClass
@@ -367,7 +352,6 @@ const JSONSerializer = Serializer.extend({
     Called by the default normalizeResponse implementation when the
     type of request is `createRecord`
      @since 1.13.0
-    @method normalizeCreateRecordResponse
     @public
     @param {Store} store
     @param {Model} primaryModelClass
@@ -383,7 +367,6 @@ const JSONSerializer = Serializer.extend({
     Called by the default normalizeResponse implementation when the
     type of request is `deleteRecord`
      @since 1.13.0
-    @method normalizeDeleteRecordResponse
     @public
     @param {Store} store
     @param {Model} primaryModelClass
@@ -399,7 +382,6 @@ const JSONSerializer = Serializer.extend({
     Called by the default normalizeResponse implementation when the
     type of request is `updateRecord`
      @since 1.13.0
-    @method normalizeUpdateRecordResponse
     @public
     @param {Store} store
     @param {Model} primaryModelClass
@@ -415,7 +397,6 @@ const JSONSerializer = Serializer.extend({
     normalizeUpdateRecordResponse, normalizeCreateRecordResponse and
     normalizeDeleteRecordResponse delegate to this method by default.
      @since 1.13.0
-    @method normalizeSaveResponse
     @public
     @param {Store} store
     @param {Model} primaryModelClass
@@ -431,7 +412,6 @@ const JSONSerializer = Serializer.extend({
     normalizeQueryResponse and normalizeFindRecordResponse delegate to this
     method by default.
      @since 1.13.0
-    @method normalizeSingleResponse
     @public
     @param {Store} store
     @param {Model} primaryModelClass
@@ -447,7 +427,6 @@ const JSONSerializer = Serializer.extend({
     normalizeQueryResponse, normalizeFindManyResponse, and normalizeFindHasManyResponse delegate
     to this method by default.
      @since 1.13.0
-    @method normalizeArrayResponse
     @public
     @param {Store} store
     @param {Model} primaryModelClass
@@ -460,7 +439,6 @@ const JSONSerializer = Serializer.extend({
     return this._normalizeResponse(store, primaryModelClass, payload, id, requestType, false);
   },
   /**
-    @method _normalizeResponse
     @param {Store} store
     @param {Model} primaryModelClass
     @param {Object} payload
@@ -520,7 +498,7 @@ const JSONSerializer = Serializer.extend({
      You can use this method, for example, to normalize underscored keys to camelized
     or other general-purpose normalizations.
      Example
-     ```app/serializers/application.js
+     ```js [app/serializers/application.js]
     import JSONSerializer from '@ember-data-mirror/serializer/json';
     import { underscore } from '<app-name>/utils/string-utils';
     import { get } from '@ember/object';
@@ -537,8 +515,7 @@ const JSONSerializer = Serializer.extend({
       }
     }
     ```
-     @method normalize
-    @public
+     @public
     @param {Model} typeClass
     @param {Object} hash
     @return {Object}
@@ -567,8 +544,7 @@ const JSONSerializer = Serializer.extend({
   },
   /**
     Returns the resource's ID.
-     @method extractId
-    @public
+     @public
     @param {Object} modelClass
     @param {Object} resourceHash
     @return {String}
@@ -581,8 +557,7 @@ const JSONSerializer = Serializer.extend({
   /**
     Returns the resource's attributes formatted as a JSON-API "attributes object".
      http://jsonapi.org/format/#document-resource-object-attributes
-     @method extractAttributes
-    @public
+     @public
     @param {Object} modelClass
     @param {Object} resourceHash
     @return {Object}
@@ -601,8 +576,7 @@ const JSONSerializer = Serializer.extend({
   /**
     Returns a relationship formatted as a JSON-API "relationship object".
      http://jsonapi.org/format/#document-resource-object-relationships
-     @method extractRelationship
-    @public
+     @public
     @param {Object} relationshipModelName
     @param {Object} relationshipHash
     @return {Object}
@@ -641,8 +615,7 @@ const JSONSerializer = Serializer.extend({
       - `relationshipKey` key under which the value for the relationship is
         extracted from the resourceHash
       - `relationshipMeta` meta information about the relationship
-     @method extractPolymorphicRelationship
-    @public
+     @public
     @param {Object} relationshipModelName
     @param {Object} relationshipHash
     @param {Object} relationshipOptions
@@ -654,8 +627,7 @@ const JSONSerializer = Serializer.extend({
   /**
     Returns the resource's relationships formatted as a JSON-API "relationships object".
      http://jsonapi.org/format/#document-resource-object-relationships
-     @method extractRelationships
-    @public
+     @public
     @param {Object} modelClass
     @param {Object} resourceHash
     @return {Object}
@@ -722,8 +694,7 @@ const JSONSerializer = Serializer.extend({
   },
   /**
     Dasherizes the model name in the payload
-     @method modelNameFromPayloadKey
-    @public
+     @public
     @param {String} key
     @return {String} the model's modelName
   */
@@ -731,7 +702,6 @@ const JSONSerializer = Serializer.extend({
     return dasherize(singularize(key));
   },
   /**
-    @method normalizeRelationships
     @private
   */
   normalizeRelationships(typeClass, hash) {
@@ -751,7 +721,6 @@ const JSONSerializer = Serializer.extend({
     }
   },
   /**
-    @method normalizeUsingDeclaredMapping
     @private
   */
   normalizeUsingDeclaredMapping(modelClass, hash) {
@@ -780,8 +749,7 @@ const JSONSerializer = Serializer.extend({
   /**
     Looks up the property key that was set by the custom `attr` mapping
     passed to the serializer.
-     @method _getMappedKey
-    @private
+     @private
     @param {String} key
     @return {String} key
   */
@@ -807,8 +775,7 @@ const JSONSerializer = Serializer.extend({
   /**
     Check attrs.key.serialize property to inform if the `key`
     can be serialized
-     @method _canSerialize
-    @private
+     @private
     @param {String} key
     @return {Boolean} true if the key can be serialized
   */
@@ -820,8 +787,7 @@ const JSONSerializer = Serializer.extend({
     When attrs.key.serialize is set to true then
     it takes priority over the other checks and the related
     attribute/relationship will be serialized
-     @method _mustSerialize
-    @private
+     @private
     @param {String} key
     @return {Boolean} true if the key must be serialized
   */
@@ -833,8 +799,7 @@ const JSONSerializer = Serializer.extend({
     Check if the given hasMany relationship should be serialized
      By default only many-to-many and many-to-none relationships are serialized.
     This could be configured per relationship by Serializer's `attrs` object.
-     @method shouldSerializeHasMany
-    @public
+     @public
     @param {Snapshot} snapshot
     @param {String} key
     @param {RelationshipSchema} relationship
@@ -855,7 +820,7 @@ const JSONSerializer = Serializer.extend({
      By default, it creates a JSON object with a key for
     each attribute and belongsTo relationship.
      For example, consider this model:
-     ```app/models/comment.js
+     ```js [app/models/comment.js]
     import Model, { attr, belongsTo } from '@ember-data-mirror/model';
      export default class CommentModel extends Model {
       @attr title;
@@ -888,7 +853,7 @@ const JSONSerializer = Serializer.extend({
     built-in serialization format.
      In that case, you can implement `serialize` yourself and
     return a JSON hash of your choosing.
-     ```app/serializers/post.js
+     ```js [app/serializers/post.js]
     import JSONSerializer from '@ember-data-mirror/serializer/json';
      export default class PostSerializer extends JSONSerializer {
       serialize(snapshot, options) {
@@ -908,7 +873,7 @@ const JSONSerializer = Serializer.extend({
      If you want to define a serializer for your entire
     application, you'll probably want to use `eachAttribute`
     and `eachRelationship` on the record.
-     ```app/serializers/application.js
+     ```js [app/serializers/application.js]
     import JSONSerializer from '@ember-data-mirror/serializer/json';
     import { singularize } from '<app-name>/utils/string-utils';
      export default class ApplicationSerializer extends JSONSerializer {
@@ -947,7 +912,7 @@ const JSONSerializer = Serializer.extend({
      If you just want to do some small tweaks on the default JSON,
     you can call `super.serialize` first and make the tweaks on
     the returned JSON.
-     ```app/serializers/post.js
+     ```js [app/serializers/post.js]
     import JSONSerializer from '@ember-data-mirror/serializer/json';
      export default class PostSerializer extends JSONSerializer {
       serialize(snapshot, options) {
@@ -958,8 +923,7 @@ const JSONSerializer = Serializer.extend({
       }
     }
     ```
-     @method serialize
-    @public
+     @public
     @param {Snapshot} snapshot
     @param {Object} options
     @return {Object} json
@@ -992,7 +956,7 @@ const JSONSerializer = Serializer.extend({
     Otherwise you can override this method to customize how the record is added to the hash.
     The hash property should be modified by reference.
      For example, your server may expect underscored root objects.
-     ```app/serializers/application.js
+     ```js [app/serializers/application.js]
     import RESTSerializer from '@ember-data-mirror/serializer/rest';
     import { underscoren} from '<app-name>/utils/string-utils';
      export default class ApplicationSerializer extends RESTSerializer {
@@ -1002,8 +966,7 @@ const JSONSerializer = Serializer.extend({
       }
     }
     ```
-     @method serializeIntoHash
-    @public
+     @public
     @param {Object} hash
     @param {Model} typeClass
     @param {Snapshot} snapshot
@@ -1018,7 +981,7 @@ const JSONSerializer = Serializer.extend({
      For example if you wanted to ensure all your attributes were always
     serialized as properties on an `attributes` object you could
     write:
-     ```app/serializers/application.js
+     ```js [app/serializers/application.js]
     import JSONSerializer from '@ember-data-mirror/serializer/json';
      export default class ApplicationSerializer extends JSONSerializer {
       serializeAttribute(snapshot, json, key, attributes) {
@@ -1027,8 +990,7 @@ const JSONSerializer = Serializer.extend({
       }
     }
     ```
-     @method serializeAttribute
-    @public
+     @public
     @param {Snapshot} snapshot
     @param {Object} json
     @param {String} key
@@ -1057,7 +1019,7 @@ const JSONSerializer = Serializer.extend({
     `serializeBelongsTo` can be used to customize how `belongsTo`
     properties are serialized.
      Example
-     ```app/serializers/post.js
+     ```js [app/serializers/post.js]
     import JSONSerializer from '@ember-data-mirror/serializer/json';
      export default class PostSerializer extends JSONSerializer {
       serializeBelongsTo(snapshot, json, relationship) {
@@ -1068,8 +1030,7 @@ const JSONSerializer = Serializer.extend({
       }
     }
     ```
-     @method serializeBelongsTo
-    @public
+     @public
     @param {Snapshot} snapshot
     @param {Object} json
     @param {Object} relationship
@@ -1104,7 +1065,7 @@ const JSONSerializer = Serializer.extend({
    `serializeHasMany` can be used to customize how `hasMany`
    properties are serialized.
     Example
-    ```app/serializers/post.js
+    ```js [app/serializers/post.js]
    import JSONSerializer from '@ember-data-mirror/serializer/json';
     export default class PostSerializer extends JSONSerializer {
      serializeHasMany(snapshot, json, relationship) {
@@ -1117,8 +1078,7 @@ const JSONSerializer = Serializer.extend({
      }
    }
    ```
-    @method serializeHasMany
-    @public
+     @public
    @param {Snapshot} snapshot
    @param {Object} json
    @param {Object} relationship
@@ -1148,7 +1108,7 @@ const JSONSerializer = Serializer.extend({
     `{ polymorphic: true }` is pass as the second argument to the
     `belongsTo` function.
      Example
-     ```app/serializers/comment.js
+     ```js [app/serializers/comment.js]
     import JSONSerializer from '@ember-data-mirror/serializer/json';
      export default class CommentSerializer extends JSONSerializer {
       serializePolymorphicType(snapshot, json, relationship) {
@@ -1163,8 +1123,7 @@ const JSONSerializer = Serializer.extend({
       }
     }
     ```
-     @method serializePolymorphicType
-    @public
+     @public
     @param {Snapshot} snapshot
     @param {Object} json
     @param {Object} relationship
@@ -1175,7 +1134,7 @@ const JSONSerializer = Serializer.extend({
     adapter payload. By default Ember Data expects meta information to
     be located on the `meta` property of the payload object.
      Example
-     ```app/serializers/post.js
+     ```js [app/serializers/post.js]
     import JSONSerializer from '@ember-data-mirror/serializer/json';
      export default class PostSerializer extends JSONSerializer {
       extractMeta(store, typeClass, payload) {
@@ -1187,8 +1146,7 @@ const JSONSerializer = Serializer.extend({
       }
     }
     ```
-     @method extractMeta
-    @public
+     @public
     @param {Store} store
     @param {Model} modelClass
     @param {Object} payload
@@ -1254,7 +1212,7 @@ const JSONSerializer = Serializer.extend({
     ```
      Example of alternative implementation, overriding the default
     behavior to deal with a different format of errors:
-     ```app/serializers/post.js
+     ```js [app/serializers/post.js]
     import JSONSerializer from '@ember-data-mirror/serializer/json';
      export default class PostSerializer extends JSONSerializer {
       extractErrors(store, typeClass, payload, id) {
@@ -1266,8 +1224,7 @@ const JSONSerializer = Serializer.extend({
       }
     }
     ```
-     @method extractErrors
-    @public
+     @public
     @param {Store} store
     @param {Model} typeClass
     @param {Object} payload
@@ -1320,7 +1277,7 @@ const JSONSerializer = Serializer.extend({
     `keyForAttribute` can be used to define rules for how to convert an
     attribute name in your model to a key in your JSON.
      Example
-     ```app/serializers/application.js
+     ```js [app/serializers/application.js]
     import JSONSerializer from '@ember-data-mirror/serializer/json';
     import { underscore } from '<app-name>/utils/string-utils';
      export default class ApplicationSerializer extends JSONSerializer {
@@ -1329,8 +1286,7 @@ const JSONSerializer = Serializer.extend({
       }
     }
     ```
-     @method keyForAttribute
-    @public
+     @public
     @param {String} key
     @param {String} method
     @return {String} normalized key
@@ -1343,7 +1299,7 @@ const JSONSerializer = Serializer.extend({
     serializing and deserializing relationship properties. By default
     `JSONSerializer` does not provide an implementation of this method.
      Example
-       ```app/serializers/post.js
+       ```js [app/serializers/post.js]
       import JSONSerializer from '@ember-data-mirror/serializer/json';
       import { underscore } from '<app-name>/utils/string-utils';
        export default class PostSerializer extends JSONSerializer {
@@ -1352,8 +1308,7 @@ const JSONSerializer = Serializer.extend({
         }
       }
       ```
-     @method keyForRelationship
-    @public
+     @public
     @param {String} key
     @param {String} typeClass
     @param {String} method
@@ -1365,8 +1320,7 @@ const JSONSerializer = Serializer.extend({
   /**
    `keyForLink` can be used to define a custom key when deserializing link
    properties.
-    @method keyForLink
-    @public
+     @public
    @param {String} key
    @param {String} kind `belongsTo` or `hasMany`
    @return {String} normalized key
@@ -1377,7 +1331,6 @@ const JSONSerializer = Serializer.extend({
   // HELPERS
 
   /**
-   @method transformFor
    @private
    @param {String} attributeType
    @param {Boolean} skipAssertion