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

package/dist/rest.js

@@ -1,13 +1,9 @@
 import { warn } from '@ember/debug';
 import { camelize, dasherize, singularize } from '@ember-data-mirror/request-utils/string';
-import { J as JSONSerializer, c as coerceId } from "./json-CVTR4xWv.js";
+import { J as JSONSerializer, c as coerceId } from "./json-CYP2BhR9.js";
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 import Mixin from '@ember/object/mixin';
 
-/**
-  @module @ember-data-mirror/serializer/rest
-*/
-
 /**
   ## Using Embedded Records
 
@@ -22,7 +18,7 @@ import Mixin from '@ember/object/mixin';
 
   Below is an example of a per-type serializer (`post` type).
 
-  ```app/serializers/post.js
+  ```js [app/serializers/post.js]
   import RESTSerializer, { EmbeddedRecordsMixin } from '@ember-data-mirror/serializer/rest';
 
   export default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
@@ -122,7 +118,6 @@ const EmbeddedRecordsMixin = Mixin.create({
       }
     }
     ```
-   @method normalize
     @public
    @param {Model} typeClass
    @param {Object} hash to be normalized
@@ -156,7 +151,7 @@ const EmbeddedRecordsMixin = Mixin.create({
     });
     ```
      Use a custom (type) serializer for the post model to configure embedded author
-     ```app/serializers/post.js
+     ```js [app/serializers/post.js]
     import RESTSerializer, { EmbeddedRecordsMixin } from '@ember-data-mirror/serializer/rest';
      export default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
       attrs = {
@@ -178,8 +173,7 @@ const EmbeddedRecordsMixin = Mixin.create({
       }
     }
     ```
-     @method serializeBelongsTo
-    @public
+     @public
     @param {Snapshot} snapshot
     @param {Object} json
     @param {Object} relationship
@@ -246,7 +240,7 @@ const EmbeddedRecordsMixin = Mixin.create({
     });
     ```
      Use a custom (type) serializer for the post model to configure embedded comments
-     ```app/serializers/post.js
+     ```js [app/serializers/post.js]
     import RESTSerializer, { EmbeddedRecordsMixin } from '@ember-data-mirror/serializer/rest';
      export default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
       attrs = {
@@ -278,7 +272,7 @@ const EmbeddedRecordsMixin = Mixin.create({
      So `{ embedded: 'always' }` is shorthand for:
     `{ serialize: 'records', deserialize: 'records' }`
      To embed the `ids` for a related object (using a hasMany relationship):
-     ```app/serializers/post.js
+     ```js [app/serializers/post.js]
     import RESTSerializer, { EmbeddedRecordsMixin } from '@ember-data-mirror/serializer/rest';
      export default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
       attrs = {
@@ -316,7 +310,7 @@ const EmbeddedRecordsMixin = Mixin.create({
       // ...
     });
     ```
-     ```app/serializers/user.js
+     ```js [app/serializers/user.js]
     import RESTSerializer, { EmbeddedRecordsMixin } from '@ember-data-mirror/serializer/rest';
      export default class UserSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {
       attrs = {
@@ -336,8 +330,7 @@ const EmbeddedRecordsMixin = Mixin.create({
       }
     }
     ```
-     @method serializeHasMany
-    @public
+     @public
     @param {Snapshot} snapshot
     @param {Object} json
     @param {Object} relationship
@@ -420,8 +413,7 @@ const EmbeddedRecordsMixin = Mixin.create({
     parent record
      Serializing a `hasMany` relationship does not remove the property that refers to
     the parent record.
-     @method removeEmbeddedForeignKey
-    @public
+     @public
     @param {Snapshot} snapshot
     @param {Snapshot} embeddedSnapshot
     @param {Object} relationship
@@ -482,7 +474,6 @@ const EmbeddedRecordsMixin = Mixin.create({
     return attrs && (attrs[camelize(attr)] || attrs[attr]);
   },
   /**
-   @method _extractEmbeddedRecords
    @private
   */
   _extractEmbeddedRecords(serializer, store, typeClass, partial) {
@@ -499,7 +490,6 @@ const EmbeddedRecordsMixin = Mixin.create({
     return partial;
   },
   /**
-   @method _extractEmbeddedHasMany
    @private
   */
   _extractEmbeddedHasMany(store, key, hash, relationshipMeta) {
@@ -533,7 +523,6 @@ const EmbeddedRecordsMixin = Mixin.create({
     hash.data.relationships[key] = relationship;
   },
   /**
-   @method _extractEmbeddedBelongsTo
    @private
   */
   _extractEmbeddedBelongsTo(store, key, hash, relationshipMeta) {
@@ -563,7 +552,6 @@ const EmbeddedRecordsMixin = Mixin.create({
     hash.data.relationships[key] = relationship;
   },
   /**
-   @method _normalizeEmbeddedRelationship
    @private
   */
   _normalizeEmbeddedRelationship(store, relationshipMeta, relationshipHash) {
@@ -577,10 +565,6 @@ const EmbeddedRecordsMixin = Mixin.create({
   },
   isEmbeddedRecordsMixin: true
 });
-
-/**
- * @module @ember-data-mirror/serializer/rest
- */
 function makeArray(value) {
   return Array.isArray(value) ? value : [value];
 }
@@ -616,7 +600,7 @@ function makeArray(value) {
   can implement across-the-board rules for how to convert an attribute
   name in your model to a key in your JSON.
 
-  ```app/serializers/application.js
+  ```js [app/serializers/application.js]
   import RESTSerializer from '@ember-data-mirror/serializer/rest';
   import { underscore } from '<app-name>/utils/string-utils';
 
@@ -633,9 +617,7 @@ function makeArray(value) {
   the method (`serialize` or `deserialize`) as the third parameter.
 
   @class RESTSerializer
-  @main @ember-data-mirror/serializer/rest
   @public
-  @extends JSONSerializer
 */
 const RESTSerializer = JSONSerializer.extend({
   /**
@@ -643,7 +625,7 @@ const RESTSerializer = JSONSerializer.extend({
    serializing and deserializing a polymorphic type. By default, the
    returned key is `${key}Type`.
     Example
-     ```app/serializers/post.js
+     ```js [app/serializers/post.js]
     import RESTSerializer from '@ember-data-mirror/serializer/rest';
      export default class ApplicationSerializer extends RESTSerializer {
       keyForPolymorphicType(key, relationship) {
@@ -652,8 +634,7 @@ const RESTSerializer = JSONSerializer.extend({
       }
     }
     ```
-    @method keyForPolymorphicType
-    @public
+     @public
    @param {String} key
    @param {String} typeClass
    @param {String} method
@@ -696,7 +677,7 @@ const RESTSerializer = JSONSerializer.extend({
     `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:
-     ```app/serializers/post.js
+     ```js [app/serializers/post.js]
     import RESTSerializer from '@ember-data-mirror/serializer/rest';
      export default class ApplicationSerializer extends RESTSerializer {
       normalize(model, hash, prop) {
@@ -711,8 +692,7 @@ const RESTSerializer = JSONSerializer.extend({
      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`.
-     @method normalize
-    @public
+     @public
     @param {Model} modelClass
     @param {Object} resourceHash
     @param {String} prop
@@ -722,8 +702,7 @@ const RESTSerializer = JSONSerializer.extend({
   /**
     Normalizes an array of resource payloads and returns a JSON-API Document
     with primary data and, if any, included data as `{ data, included }`.
-     @method _normalizeArray
-    @param {Store} store
+     @param {Store} store
     @param {String} modelName
     @param {Object} arrayHash
     @param {String} prop
@@ -766,7 +745,6 @@ const RESTSerializer = JSONSerializer.extend({
     return serializer.normalize(modelClass, hash, prop);
   },
   /**
-    @method _normalizeResponse
     @param {Store} store
     @param {Model} primaryModelClass
     @param {Object} payload
@@ -922,8 +900,7 @@ const RESTSerializer = JSONSerializer.extend({
      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.
-     @method pushPayload
-    @public
+     @public
     @param {Store} store
     @param {Object} payload
   */
@@ -966,7 +943,7 @@ const RESTSerializer = JSONSerializer.extend({
      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:
-     ```app/models/post.js
+     ```js [app/models/post.js]
     import Model from '@ember-data-mirror/model';
      export default class Post extends Model {}
     ```
@@ -983,7 +960,7 @@ const RESTSerializer = JSONSerializer.extend({
     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:
-     ```app/serializers/application.js
+     ```js [app/serializers/application.js]
     import RESTSerializer from '@ember-data-mirror/serializer/rest';
      export default class ApplicationSerializer extends RESTSerializer {
       modelNameFromPayloadKey(payloadKey) {
@@ -1001,8 +978,7 @@ const RESTSerializer = JSONSerializer.extend({
     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.
-     @method modelNameFromPayloadKey
-    @public
+     @public
     @param {String} key
     @return {String} the model's modelName
   */
@@ -1017,7 +993,7 @@ const RESTSerializer = JSONSerializer.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 Comment extends Model {
       @attr title
@@ -1050,7 +1026,7 @@ const RESTSerializer = JSONSerializer.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 RESTSerializer from '@ember-data-mirror/serializer/rest';
      export default class ApplicationSerializer extends RESTSerializer {
       serialize(snapshot, options) {
@@ -1070,7 +1046,7 @@ const RESTSerializer = JSONSerializer.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 RESTSerializer from '@ember-data-mirror/serializer/rest';
     import { pluralize } from '<app-name>/utils/string-utils';
      export default class ApplicationSerializer extends RESTSerializer {
@@ -1109,7 +1085,7 @@ const RESTSerializer = JSONSerializer.extend({
      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.
-     ```app/serializers/post.js
+     ```js [app/serializers/post.js]
     import RESTSerializer from '@ember-data-mirror/serializer/rest';
      export default class ApplicationSerializer extends RESTSerializer {
       serialize(snapshot, options) {
@@ -1120,8 +1096,7 @@ const RESTSerializer = JSONSerializer.extend({
       }
     }
     ```
-     @method serialize
-    @public
+     @public
     @param {Snapshot} snapshot
     @param {Object} options
     @return {Object} json
@@ -1135,7 +1110,7 @@ const RESTSerializer = JSONSerializer.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.
-     ```app/serializers/application.js
+     ```js [app/serializers/application.js]
     import RESTSerializer from '@ember-data-mirror/serializer/rest';
     import { underscore } from '<app-name>/utils/string-utils';
      export default class ApplicationSerializer extends RESTSerializer {
@@ -1145,8 +1120,7 @@ const RESTSerializer = JSONSerializer.extend({
       }
     }
     ```
-     @method serializeIntoHash
-    @public
+     @public
     @param {Object} hash
     @param {Model} typeClass
     @param {Snapshot} snapshot
@@ -1171,7 +1145,7 @@ const RESTSerializer = JSONSerializer.extend({
     }
     ```
      For example, your server may expect dasherized root objects:
-     ```app/serializers/application.js
+     ```js [app/serializers/application.js]
     import RESTSerializer from '@ember-data-mirror/serializer/rest';
     import { dasherize } from '<app-name>/utils/string-utils';
      export default class ApplicationSerializer extends RESTSerializer {
@@ -1190,8 +1164,7 @@ const RESTSerializer = JSONSerializer.extend({
       }
     }
     ```
-     @method payloadKeyFromModelName
-    @public
+     @public
     @param {String} modelName
     @return {String}
   */
@@ -1202,8 +1175,7 @@ const RESTSerializer = JSONSerializer.extend({
     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.
-     @method serializePolymorphicType
-    @public
+     @public
     @param {Snapshot} snapshot
     @param {Object} json
     @param {Object} relationship
@@ -1221,8 +1193,7 @@ const RESTSerializer = JSONSerializer.extend({
   /**
     You can use this method to customize how a polymorphic relationship should
     be extracted.
-     @method extractPolymorphicRelationship
-    @public
+     @public
     @param {Object} relationshipType
     @param {Object} relationshipHash
     @param {Object} relationshipOptions