Class MinimumSerializerInterface

Show:

schema
ShimModelClass
An object with methods for accessing information about the type, attributes and relationships of the primary type associated with the request.
rawPayload
JSONObject
Some raw JSON data to be normalized into a JSON:API Resource.
prop
String
When called by the EmbeddedRecordsMixin this param will be the property at which the object provided as rawPayload was found.
returns
SingleResourceDocument
A JSON:API Document containing a single JSON:API Resource as its primary data.

This method is intended to normalize data into a JSON:API Document with a data member containing a single Resource.

  • type should be formatted in the singular, dasherized and lowercase form
  • members (the property names of attributes and relationships) should be formatted to match their definition in the corresponding Model definition. Typically this will be camelCase.
  • lid is a valid optional sibling to id and type in both Resources and Resource Identifier Objects

This method is called by the Store when store.normalize(modelName, payload) is called. It is recommended to use store.serializerFor(modelName).normalizeResponse over store.normalize.

This method may be called when also using the RESTSerializer when serializer.pushPayload is called by store.pushPayload. However, it is recommended to use store.push over store.pushPayload after normalizing the payload directly.

Example:

1
2
3
4
5
6
7
function pushPayload(store, modelName, rawPayload) {
  const ModelClass = store.modelFor(modelName);
  const serializer = store.serializerFor(modelName);
  const jsonApiPayload = serializer.normalizeResponse(store, ModelClass, rawPayload, null, 'query');

  return store.push(jsonApiPayload);
}

This method may be called when also using the JSONAPISerializer when normalizing included records. If mixing serializer usage in this way we recommend implementing this method, but caution that it may lead to unexpected mixing of formats.

This method may also be called when normalizing embedded relationships when using the EmbeddedRecordsMixin. If using this mixin in a serializer in your application we recommend implementing this method, but caution that it may lead to unexpected mixing of formats.

store
Store
The store service that initiated the request being normalized
schema
ShimModelClass
An object with methods for accessing information about the type, attributes and relationships of the primary type associated with the request.
rawPayload
JSONObject
The raw JSON response data returned from an API request. This correlates to the value the promise returned by the adapter method that performed the request resolved to.
id
String|null
For a findRecord request, this is the id initially provided in the call to store.findRecord. Else this value is null.
requestType
'findRecord' | 'queryRecord' | 'findAll' | 'findBelongsTo' | 'findHasMany' | 'findMany' | 'query' | 'createRecord' | 'deleteRecord' | 'updateRecord'
The type of request the Adapter had been asked to perform.
returns
JsonApiDocument
a document following the structure of a JSON:API Document.

This method is responsible for normalizing the value resolved from the promise returned by an Adapter request into the format expected by the Store.

The output should be a JSON:API Document with the following additional restrictions:

  • type should be formatted in the singular dasherized lowercase form
  • members (the property names of attributes and relationships) should be formatted to match their definition in the corresponding Model definition. Typically this will be camelCase.
  • lid is a valid optional sibling to id and type in both Resources and Resource Identifier Objects
store
Store
The store service that initiated the request being normalized
rawPayload
JSONObject
The raw JSON response data returned from an API request. This JSON should be in the API format expected by the serializer.
returns
Void

This method allows for normalization of data when store.pushPayload is called and should be implemented if you want to use that method.

The method is responsible for pushing new data to the store using store.push once any necessary normalization has occurred, and no data in the store will be updated unless it does so.

The normalized form pushed to the store should be a JSON:API Document with the following additional restrictions:

  • type should be formatted in the singular, dasherized and lowercase form
  • members (the property names of attributes and relationships) should be formatted to match their definition in the corresponding Model definition. Typically this will be camelCase.
  • lid is a valid optional sibling to id and type in both Resources and Resource Identifier Objects

If you need better control over normalization or want access to the records being added or updated in the store, we recommended using store.push over store.pushPayload after normalizing the payload directly. This can even take advantage of an existing serializer for the format the data is in, for example:

1
2
3
4
5
6
7
function pushPayload(store, modelName, rawPayload) {
  const ModelClass = store.modelFor(modelName);
  const serializer = store.serializerFor(modelName);
  const jsonApiPayload = serializer.normalizeResponse(store, ModelClass, rawPayload, null, 'query');

  return store.push(jsonApiPayload);
}
snapshot
Snapshot
A Snapshot for the record to serialize
options
Object

This method is responsible for serializing an individual record via a Snapshot into the format expected by the API.

This method is called by snapshot.serialize().

When using Model, this method is called by record.serialize().

When using JSONAPIAdapter or RESTAdapter this method is called by updateRecord and createRecord if Serializer.serializeIntoHash is not implemented.

hash
A top most object of the request payload onto which to append the serialized record
schema
ShimModelClass
An object with methods for accessing information about the type, attributes and relationships of the primary type associated with the request.
snapshot
Snapshot
A Snapshot for the record to serialize
options
returns
Void

When using JSONAPIAdapter or RESTAdapter this method is called by adapter.updateRecord and adapter.createRecord if serializer.serializeIntoHash is implemented. If this method is not implemented, serializer.serialize will be called in this case.

You can use this method to customize the root keys serialized into the payload. The hash property should be modified by reference.

For instance, your API may expect resources to be keyed by underscored type in the payload:

1
2
3
4
5
6
{
  _user: {
    type: 'user',
    id: '1'
  }
}

Which when using these adapters can be achieved by implementing this method similar to the following:

1
2
3
serializeIntoHash(hash, ModelClass, snapshot, options) {
  hash[`_${snapshot.modelName}`] = this.serialize(snapshot, options).data;
}