Added resource-level meta options for serialization

closes #73 #74

Author: danivek

Diff for: README.md

@@ -37,6 +37,9 @@ Serializer.register(type, options);
 * **topLevelLinks** (optional): Describes the top-level links. It can be:
   * An _object_ (values can be string or function).
   * A _function_ with one argument `function(extraData) { ... }` or with two arguments `function(data, extraData) { ... }`
+* **meta** (optional): Describes resource-level meta. It can be:
+  * An _object_ (values can be string or function).
+  * A _function_ with one argument `function(data) { ... }` or with two arguments `function(data, extraData) { ... }`
 * **relationships** (optional): An object defining some relationships
   * relationship: The property in data to use as a relationship
     * **type**: A _string_ or a _function_ `function(relationshipData, data) { ... }` for the type to use for serializing the relationship (type need to be register).

Diff for: lib/JSONAPISerializer.js

@@ -485,6 +485,7 @@ module.exports = class JSONAPISerializer {
       id: data[options.id] ? data[options.id].toString() : undefined,
       attributes: this.serializeAttributes(data, options),
       relationships: this.serializeRelationships(data, options, included, extraData),
+      meta: this.processOptionsValues(data, extraData, options.meta),
       links: this.processOptionsValues(data, extraData, options.links)
     };
   }

Diff for: lib/validator.js

@@ -16,6 +16,7 @@ function validateOptions(options) {
       relationships: {},
       topLevelLinks: {},
       topLevelMeta: {},
+      meta: {},
       blacklistOnDeserialize: [],
       whitelistOnDeserialize: [],
       jsonapiObject: true
@@ -43,6 +44,8 @@ function validateOptions(options) {
     typeof options.topLevelMeta !== 'function'
   )
     throw new Error("option 'topLevelMeta' must be an object or a function");
+  if (options.meta && typeof options.meta !== 'object' && typeof options.meta !== 'function')
+    throw new Error("option 'meta' must be an object or a function");
   if (typeof options.jsonapiObject !== 'boolean')
     throw new Error("option 'jsonapiObject' must a boolean");
   if (
@@ -126,6 +129,8 @@ function validateDynamicTypeOptions(options) {
     typeof options.topLevelMeta !== 'function'
   )
     throw new Error("option 'topLevelMeta' must be an object or a function");
+  if (options.meta && typeof options.meta !== 'object' && typeof options.meta !== 'function')
+    throw new Error("option 'meta' must be an object or a function");
   if (typeof options.jsonapiObject !== 'boolean')
     throw new Error("option 'jsonapiObject' must a boolean");
 

Diff for: test/integration/examples.js

@@ -16,6 +16,11 @@ describe('Examples', function() {
         self: '/articles/' + data.id
       }
     },
+    meta: function(data) {
+      return {
+        meta: 'metadata'
+      }
+    },
     relationships: {
       author: {
         type: 'people',
@@ -109,6 +114,7 @@ describe('Examples', function() {
     expect(serializedData.data[0].relationships.comments.data[0]).to.have.property('id').to.be.a('string');
     expect(serializedData.data[0]).to.have.property('links');
     expect(serializedData.data[0].links).to.have.property('self').to.eql('/articles/1');
+    expect(serializedData.data[0].meta).to.have.property('meta').to.eql('metadata');
     expect(serializedData).to.have.property('included');
     expect(serializedData.included).to.be.instanceof(Array).to.have.lengthOf(10);
     var includedAuhor1 = _.find(serializedData.included, {

Diff for: test/unit/JSONAPISerializer.test.js

@@ -84,6 +84,7 @@ describe('JSONAPISerializer', function() {
       expect(serializedData).to.have.property('attributes').to.have.property('body').to.eql('test body');
       expect(serializedData.relationships).to.be.undefined;
       expect(serializedData.links).to.be.undefined;
+      expect(serializedData.meta).to.be.undefined;
 
       done();
     });
@@ -99,6 +100,7 @@ describe('JSONAPISerializer', function() {
       expect(serializedData.attributes).to.be.undefined;
       expect(serializedData.relationships).to.be.undefined;
       expect(serializedData.links).to.be.undefined;
+      expect(serializedData.meta).to.be.undefined;
 
       done();
     });
@@ -118,11 +120,13 @@ describe('JSONAPISerializer', function() {
       expect(serializedData[0]).to.have.property('attributes').to.have.property('body').to.eql('test body 1');
       expect(serializedData[0].relationships).to.be.undefined;
       expect(serializedData[0].links).to.be.undefined;
+      expect(serializedData[0].meta).to.be.undefined;
       expect(serializedData[1]).to.have.property('type').to.eql('articles');
       expect(serializedData[1]).to.have.property('id').to.eql('2');
       expect(serializedData[1]).to.have.property('attributes').to.have.property('body').to.eql('test body 2');
       expect(serializedData[1].relationships).to.be.undefined;
       expect(serializedData[1].links).to.be.undefined;
+      expect(serializedData[1].meta).to.be.undefined;
       done();
     });
 
@@ -137,6 +141,7 @@ describe('JSONAPISerializer', function() {
       expect(serializedData).to.have.property('id').to.eql('1');
       expect(serializedData.relationships).to.be.undefined;
       expect(serializedData.links).to.be.undefined;
+      expect(serializedData.meta).to.be.undefined;
 
       done();
     });
@@ -221,6 +226,7 @@ describe('JSONAPISerializer', function() {
       expect(serializedData).to.have.property('attributes').to.have.property('body').to.eql('test body');
       expect(serializedData.relationships).to.be.undefined;
       expect(serializedData.links).to.be.undefined;
+      expect(serializedData.meta).to.be.undefined;
 
       done();
     });
@@ -242,11 +248,13 @@ describe('JSONAPISerializer', function() {
       expect(serializedData[0]).to.have.property('attributes').to.have.property('body').to.eql('article body');
       expect(serializedData[0].relationships).to.be.undefined;
       expect(serializedData[0].links).to.be.undefined;
+      expect(serializedData[0].meta).to.be.undefined;
       expect(serializedData[1]).to.have.property('type').to.eql('people');
       expect(serializedData[1]).to.have.property('id').to.eql('1');
       expect(serializedData[1]).to.have.property('attributes').to.have.property('body').to.eql('people body');
       expect(serializedData[1].relationships).to.be.undefined;
       expect(serializedData[1].links).to.be.undefined;
+      expect(serializedData[1].meta).to.be.undefined;
       done();
     });
 
@@ -455,12 +463,14 @@ describe('JSONAPISerializer', function() {
         id: '1',
         attributes: { type: 'people', name: 'Roman Nelson' },
         relationships: undefined,
+        meta: undefined,
         links: undefined
       }, {
         type: 'author',
         id: '1',
         attributes: { type: 'author', firstName: 'Kaley', lastName: 'Maggio' },
         relationships: undefined,
+        meta: undefined,
         links: undefined }
       ]);
       done();

Diff for: test/unit/validator.test.js

@@ -44,6 +44,14 @@ describe('validator', function() {
 
       done();
     });
+
+    it('incorrect meta', done => {
+      expect(function() {
+        validator.validateDynamicTypeOptions({ type: 'test', meta: 'test' });
+      }).to.throw(Error, "option 'meta' must be an object or a function");
+
+      done();
+    });
   });
 
   describe('validateOptions', function() {
@@ -77,6 +85,16 @@ describe('validator', function() {
       done();
     });
 
+    it('incorrect meta', done => {
+      expect(function() {
+        validator.validateOptions({
+          meta: 'test'
+        });
+      }).to.throw(Error, "option 'meta' must be an object or a function");
+
+      done();
+    });
+
     it('incorrect blacklistOnDeserialize', done => {
       expect(function() {
         validator.validateOptions({