feat: add meta to Resource Identifier Objects

browserify/jsonapi-serializer.js

@@ -137,9 +137,15 @@ module.exports = function (jsonapi, data, opts) {
 
         if (valueForRelationship && isFunction(valueForRelationship.then)) {
           return valueForRelationship.then(function (value) {
+              if (relationshipData.meta) {
+                  value.meta = relationshipData.meta
+              }
             return value;
           });
         } else {
+            if (relationshipData.meta) {
+                valueForRelationship.meta = relationshipData.meta
+            }
           return valueForRelationship;
         }
       });
@@ -532,7 +538,13 @@ module.exports = function (collectionName, record, payload, opts) {
       if (typeof id !== 'undefined') { pushToIncluded(payload, included); }
     }
 
-    return typeof id !== 'undefined' ? { type: type, id: id } : null;
+    var json = typeof id !== 'undefined' ? { type: type, id: id } : null;
+
+    if (dest && dest.meta) {
+      json.meta = dest.meta
+    }
+
+    return json
   };
 
   this.serializeNested = function (dest, current, attribute, opts) {

lib/deserializer-utils.js

@@ -114,7 +114,8 @@ module.exports = function (jsonapi, data, opts) {
               return extractIncludes(relationshipData, ancestry);
             }))
             .then(function (includes) {
-              if (includes) { dest[keyForAttribute(key)] = includes; }
+              var filteredIncludes = includes.filter(item => Boolean(item));
+              if (filteredIncludes.length) { dest[keyForAttribute(key)] = filteredIncludes; }
             });
         } else {
           return extractIncludes(relationship.data, ancestry)
@@ -134,13 +135,24 @@ module.exports = function (jsonapi, data, opts) {
         var valueForRelationship = getValueForRelationship(relationshipData,
           included);
 
-        if (valueForRelationship && isFunction(valueForRelationship.then)) {
+        if (!valueForRelationship) {
+            return null
+        }
+
+        if (isFunction(valueForRelationship.then)) {
           return valueForRelationship.then(function (value) {
+              if (relationshipData.meta) {
+                  value.meta = relationshipData.meta
+              }
             return value;
           });
-        } else {
-          return valueForRelationship;
         }
+
+        if (relationshipData.meta) {
+            valueForRelationship.meta = relationshipData.meta
+        }
+
+        return valueForRelationship;
       });
   }
 

lib/serializer-utils.js

@@ -65,11 +65,16 @@ module.exports = function (collectionName, record, payload, opts) {
     }
   }
 
-  function getType(str, attrVal) {
+  function getType(str, attrVal, attrOpts) {
     var type;
     attrVal = attrVal || {};
+    attrOpts = attrOpts || {};
 
-    if (isFunction(opts.typeForAttribute)) {
+    if (isFunction(attrOpts.typeForAttribute)) {
+      type = attrOpts.typeForAttribute(str, attrVal);
+    }
+
+    if (type === undefined && isFunction(opts.typeForAttribute)) {
       type = opts.typeForAttribute(str, attrVal);
     }
 
@@ -190,7 +195,7 @@ module.exports = function (collectionName, record, payload, opts) {
   this.serializeRef = function (dest, current, attribute, opts) {
     var that = this;
     var id = getRef(current, dest, opts);
-    var type = getType(attribute, dest);
+    var type = getType(attribute, dest, opts);
 
     var relationships = [];
     var includedAttrs = [];
@@ -230,7 +235,13 @@ module.exports = function (collectionName, record, payload, opts) {
       if (typeof id !== 'undefined') { pushToIncluded(payload, included); }
     }
 
-    return typeof id !== 'undefined' ? { type: type, id: id } : null;
+    var json = typeof id !== 'undefined' ? { type: type, id: id } : null;
+
+    if (dest && dest.meta) {
+      json.meta = dest.meta
+    }
+
+    return json
   };
 
   this.serializeNested = function (dest, current, attribute, opts) {

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "jsonapi-serializer",
-  "version": "3.6.7",
+  "name": "@freshfx/jsonapi-serializer",
+  "version": "3.7.1",
   "description": "A Node.js framework agnostic library for serializing your data to JSON API",
   "main": "index.js",
   "scripts": {

test/deserializer.js

@@ -478,7 +478,7 @@ describe('JSON API Deserializer', function () {
           .deserialize(dataSet, function (err, json) {
             expect(json).to.be.an('object');
 
-            expect(json).to.have.key('id', 'first-name', 'last-name', 
+            expect(json).to.have.key('id', 'first-name', 'last-name',
               'username', 'images');
 
             expect(json.images).to.be.an('array').with.length(2)
@@ -553,7 +553,7 @@ describe('JSON API Deserializer', function () {
               id: '2',
               type: 'stores',
               attributes: {
-                name: 'Fashionable Clothes' 
+                name: 'Fashionable Clothes'
               },
               relationships: {
                 deals: {
@@ -619,7 +619,7 @@ describe('JSON API Deserializer', function () {
               name: 'Twin Pines Mall',
               id: '1',
               stores: [
-                { 
+                {
                   name: 'Tasty Food',
                   id: '1',
                   deals: [
@@ -634,10 +634,10 @@ describe('JSON API Deserializer', function () {
                       id: '2',
                       stores: [
                         { name: 'Tasty Food', id: '1' }
-                      ] 
-                    } 
+                      ]
+                    }
                   ]
-                }, { 
+                }, {
                   name: 'Fashionable Clothes',
                   id: '2',
                   deals: [
@@ -649,10 +649,10 @@ describe('JSON API Deserializer', function () {
                       ]
                     }
                   ]
-                }, { 
+                }, {
                   name: 'Readable Books',
                   id: '3'
-                } 
+                }
               ],
               deals: [
                 {
@@ -696,7 +696,7 @@ describe('JSON API Deserializer', function () {
                     }
                   ]
                 }
-              ] 
+              ]
             });
 
             done(null, json);
@@ -1180,8 +1180,7 @@ describe('JSON API Deserializer', function () {
             expect(json).eql({
               id: '54735750e16638ba1eee59cb',
               'first-name': 'Sandro',
-              'last-name': 'Munda',
-              'addresses': []
+              'last-name': 'Munda'
             });
             done(null, json);
           });