@ember-data-mirror/serializer 5.6.0-alpha.1 → 5.6.0-alpha.12

package/unstable-preview-types/index.d.ts

@@ -1,15 +1,7 @@
+/// <reference path="./json.d.ts" />
+/// <reference path="./transform.d.ts" />
 /// <reference path="./json-api.d.ts" />
 /// <reference path="./rest.d.ts" />
-/// <reference path="./transform.d.ts" />
-/// <reference path="./json.d.ts" />
-/// <reference path="./-private/utils.d.ts" />
-/// <reference path="./-private/embedded-records-mixin.d.ts" />
-/// <reference path="./-private/transforms/number.d.ts" />
-/// <reference path="./-private/transforms/boolean.d.ts" />
-/// <reference path="./-private/transforms/boolean.type-test.d.ts" />
-/// <reference path="./-private/transforms/date.d.ts" />
-/// <reference path="./-private/transforms/string.d.ts" />
-/// <reference path="./-private/transforms/transform.d.ts" />
 declare module '@ember-data-mirror/serializer' {
   /**
     ## Overview
@@ -41,7 +33,7 @@ declare module '@ember-data-mirror/serializer' {
     server API format.
   
     To implement a serializer, export a class that conforms to the structure
-    described by [<Interface> Serializer](/ember-data/release/classes/%3CInterface%3E%20Serializer)
+    described by {@link MinimumSerializerInterface}
     from the `app/serializers/` directory. An example is below.
   
     ```ts
@@ -116,162 +108,8 @@ declare module '@ember-data-mirror/serializer' {
     It is recommended that apps write their own serializer to best suit the needs of their API and
     application.
   
-    @module @ember-data-mirror/serializer
-    @main @ember-data-mirror/serializer
-  */
-  import EmberObject from '@ember/object';
-  import type Store from '@ember-data-mirror/store';
-  import type { ModelSchema } from '@ember-data-mirror/store/types';
-  import type { EmptyResourceDocument, SingleResourceDocument } from '@warp-drive-mirror/core-types/spec/json-api-raw';
-  /**
-    > ⚠️ CAUTION you likely want the docs for [<Interface> Serializer](/ember-data/release/classes/%3CInterface%3E%20Serializer)
-    > as extending this abstract class is unnecessary.
-  
-    `Serializer` is an abstract base class that you may override in your
-    application to customize it for your backend. The minimum set of methods
-    that you should implement is:
-  
-      * `normalizeResponse()`
-      * `serialize()`
-  
-    And you can optionally override the following methods:
-  
-      * `normalize()`
-  
-    For an example implementation, see
-    [JSONSerializer](JSONSerializer), the included JSON serializer.
-  
-    @class Serializer
-    @public
-    @extends Ember.EmberObject
+    @module
   */
-  export default class extends EmberObject {
-      store: Store;
-      /**
-        The `store` property is the application's `store` that contains
-        all records. It can be used to look up serializers for other model
-        types that may be nested inside the payload response.
-    
-        Example:
-    
-        ```js
-        Serializer.extend({
-          extractRelationship(relationshipModelName, relationshipHash) {
-            let modelClass = this.store.modelFor(relationshipModelName);
-            let relationshipSerializer = this.store.serializerFor(relationshipModelName);
-            return relationshipSerializer.normalize(modelClass, relationshipHash);
-          }
-        });
-        ```
-    
-        @property store
-        @type {Store}
-        @public
-      */
-      /**
-        The `normalizeResponse` method is used to normalize a payload from the
-        server to a JSON-API Document.
-    
-        http://jsonapi.org/format/#document-structure
-    
-        Example:
-    
-        ```js
-        Serializer.extend({
-          normalizeResponse(store, primaryModelClass, payload, id, requestType) {
-            if (requestType === 'findRecord') {
-              return this.normalize(primaryModelClass, payload);
-            } else {
-              return payload.reduce(function(documentHash, item) {
-                let { data, included } = this.normalize(primaryModelClass, item);
-                documentHash.included.push(...included);
-                documentHash.data.push(data);
-                return documentHash;
-              }, { data: [], included: [] })
-            }
-          }
-        });
-        ```
-    
-        @since 1.13.0
-        @method normalizeResponse
-        @public
-        @param {Store} store
-        @param {Model} primaryModelClass
-        @param {Object} payload
-        @param {String|Number} id
-        @param {String} requestType
-        @return {Object} JSON-API Document
-      */
-      /**
-        The `serialize` method is used when a record is saved in order to convert
-        the record into the form that your external data source expects.
-    
-        `serialize` takes an optional `options` hash with a single option:
-    
-        - `includeId`: If this is `true`, `serialize` should include the ID
-          in the serialized object it builds.
-    
-        Example:
-    
-        ```js
-        Serializer.extend({
-          serialize(snapshot, options) {
-            let json = {
-              id: snapshot.id
-            };
-    
-            snapshot.eachAttribute((key, attribute) => {
-              json[key] = snapshot.attr(key);
-            });
-    
-            snapshot.eachRelationship((key, relationship) => {
-              if (relationship.kind === 'belongsTo') {
-                json[key] = snapshot.belongsTo(key, { id: true });
-              } else if (relationship.kind === 'hasMany') {
-                json[key] = snapshot.hasMany(key, { ids: true });
-              }
-            });
-    
-            return json;
-          },
-        });
-        ```
-    
-        @method serialize
-        @public
-        @param {Snapshot} snapshot
-        @param {Object} [options]
-        @return {Object}
-      */
-      /**
-        The `normalize` method is used to convert a payload received from your
-        external data source into the normalized form `store.push()` expects. You
-        should override this method, munge the hash and return the normalized
-        payload.
-    
-        Example:
-    
-        ```js
-        Serializer.extend({
-          normalize(modelClass, resourceHash) {
-            let data = {
-              id:            resourceHash.id,
-              type:          modelClass.modelName,
-              attributes:    resourceHash
-            };
-            return { data: data };
-          }
-        })
-        ```
-    
-        @method normalize
-        @public
-        @param {Model} typeClass
-        @param {Object} hash
-        @return {Object}
-      */
-      normalize(_typeClass: ModelSchema, hash: Record<string, unknown>): SingleResourceDocument | EmptyResourceDocument;
-  }
+  export { Serializer as default } from '@warp-drive-mirror/legacy/serializer';
 }
 //# sourceMappingURL=index.d.ts.map

package/unstable-preview-types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA2GE;AAEF,OAAO,WAAW,MAAM,eAAe,CAAC;AAGxC,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,KAAK,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AAI9G;;;;;;;;;;;;;;;;;;;;;EAqBE;AAEF,MAAM,CAAC,OAAO,MAAO,SAAQ,WAAW;IACrB,KAAK,EAAE,KAAK,CAAC;IAC9B;;;;;;;;;;;;;;;;;;;;MAoBE;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAkCE;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAwCE;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;MA0BE;IACF,SAAS,CAAC,UAAU,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,sBAAsB,GAAG,qBAAqB;CAGlH"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0GE;AACF,OAAO,EAAE,UAAU,IAAI,OAAO,EAAE,MAAM,+BAA+B,CAAC"}