Add isData alongside isIncluded (servers can return objects in both parts).

Author: mrichar1

src/lib.js

@@ -361,21 +361,20 @@ const Utils = class {
    * Convert JSONAPI record(s) to restructured data
    * @memberof module:jsonapi-vuex.utils
    * @param {object} data - The `data` object from a JSONAPI record
-   * @param {boolean} isIncluded - Flag which if true, will mark these records as coming from 'included' not via 'data'
    * @return {object} Restructured data
    */
-  jsonapiToNorm(data, isIncluded) {
+  jsonapiToNorm(data) {
     const norm = {}
     if (Array.isArray(data)) {
       data.forEach((item) => {
         let { id } = item
         if (!this.hasProperty(norm, id)) {
           norm[id] = {}
         }
-        Object.assign(norm[id], this.jsonapiToNormItem(item, isIncluded))
+        Object.assign(norm[id], this.jsonapiToNormItem(item))
       })
     } else {
-      Object.assign(norm, this.jsonapiToNormItem(data, isIncluded))
+      Object.assign(norm, this.jsonapiToNormItem(data))
     }
     return norm
   }
@@ -384,10 +383,10 @@ const Utils = class {
    * Restructure a single jsonapi item. Used internally by {@link module:jsonapi-vuex.utils.jsonapiToNorm}
    * @memberof module:jsonapi-vuex._internal
    * @param {object} data - JSONAPI record
-   * @param {boolean} isIncluded - Flag, which if true will mark this record as coming from 'included', not via 'data'
+   * @param {boolean} recordType=isData - Set a key in _jv which reflects if this came 'direct' from 'data' or via 'included'
    * @return {object} Restructured data
    */
-  jsonapiToNormItem(data, isIncluded = false) {
+  jsonapiToNormItem(data, recordType = 'isData') {
     if (!data) {
       return {}
     }
@@ -396,9 +395,8 @@ const Utils = class {
     // Create a new object omitting attributes
     const { attributes, ...normNoAttrs } = norm[this.jvtag] // eslint-disable-line no-unused-vars
     norm[this.jvtag] = normNoAttrs
-    if (isIncluded) {
-      norm[this.jvtag].isIncluded = isIncluded
-    }
+    // Set recordType (either isData or isIncluded) to true
+    norm[this.jvtag][recordType] = true
     return norm
   }
 
@@ -504,9 +502,8 @@ const Utils = class {
    */
   processIncludedRecords(context, results) {
     for (let item of get(results, ['data', 'included'], [])) {
-      //Mark record as coming from included
-      let isIncluded = true
-      const includedItem = this.jsonapiToNormItem(item, isIncluded)
+      // Mark record as coming from included
+      const includedItem = this.jsonapiToNormItem(item, 'isIncluded')
       context.commit('mergeRecords', includedItem)
     }
   }

tests/unit/actions/get.spec.js

@@ -114,8 +114,11 @@ describe('get', function () {
     // for a real API call, would need axios include params here
     await jsonapiModule.actions.get(stubContext, normWidget1)
 
+    // Add isIncluded, remove isData (As would be found in 'real' response)
     normWidget2._jv.isIncluded = true
     normMachine1._jv.isIncluded = true
+    delete normWidget2._jv.isData
+    delete normMachine1._jv.isData
     expect(stubContext.commit).to.have.been.calledWith('mergeRecords', normWidget2)
     expect(stubContext.commit).to.have.been.calledWith('mergeRecords', normMachine1)
   })

tests/unit/fixtures/widget1.js

@@ -55,6 +55,7 @@ export function normFormat() {
     foo: 1,
     bar: 'baz',
     _jv: {
+      isData: true,
       type: 'widget',
       id: '1',
       links: {
@@ -85,6 +86,7 @@ export function normFormatPatch() {
   return {
     foo: 'update',
     _jv: {
+      isData: true,
       type: 'widget',
       id: '1',
     },
@@ -96,6 +98,7 @@ export function normFormatUpdate() {
     foo: 'update',
     bar: 'baz',
     _jv: {
+      isData: true,
       type: 'widget',
       id: '1',
       links: {

tests/unit/fixtures/widget2.js

@@ -29,6 +29,7 @@ export function normFormat() {
   return {
     foo: 2,
     _jv: {
+      isData: true,
       type: 'widget',
       id: '2',
       relationships: {

tests/unit/fixtures/widget3.js

@@ -22,6 +22,7 @@ export function normFormat() {
   return {
     foo: 3,
     _jv: {
+      isData: true,
       type: 'widget',
       id: '3',
       relationships: {

tests/unit/jsonapi-vuex.spec.js

@@ -256,6 +256,8 @@ describe('jsonapi-vuex tests', function () {
     })
     describe('utils.cleanPatch', function () {
       it('should return patch unmodified if record not in state', function () {
+        // Remove isData as clean Patch will have removed it
+        delete normWidget1Patch._jv.isData
         const res = utils.cleanPatch(normWidget1Patch, {})
         expect(res).to.deep.equal(normWidget1Patch)
       })
@@ -357,9 +359,10 @@ describe('jsonapi-vuex tests', function () {
         expect(utils.jsonapiToNormItem(jsonWidget1)).to.deep.equal(normWidget1)
       })
       it("should set the 'isIncluded' property if isIncluded param is true", function () {
-        // Set inData param to true
+        // Set isIncluded param to true, drop isData
         normWidget1._jv.isIncluded = true
-        expect(utils.jsonapiToNormItem(jsonWidget1, true)).to.deep.equal(normWidget1)
+        delete normWidget1._jv.isData
+        expect(utils.jsonapiToNormItem(jsonWidget1, 'isIncluded')).to.deep.equal(normWidget1)
       })
     })