Add inData flag to distinguish records coming via includes.

Author: mrichar1

README.md

@@ -678,6 +678,8 @@ Distinguishing between the `attributes` and `relationships` in the 'root' is sim
 
 - `isRel` - a function which returns True/False for a given name.
 
+- `inData` - this property is set to `true` on items returned as part of the `data` property, if `included` records were also returned. This is useful if you wish to filter out included records when displaying data, but still want to access them as related data.
+
 These are particularly useful in `Vue` templates. For example to iterate over an item, picking out just the attributes:
 
 ```html

package.json

@@ -17,7 +17,7 @@
     "babel-polyfill": "^6.26.0",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
-    "chromedriver": "^93",
+    "chromedriver": "^95",
     "concurrently": "^6.2.1",
     "core-js": "^3.16.1",
     "eslint": "^7.32.0",
@@ -49,7 +49,7 @@
     "vuex": "^4.0.0"
   },
   "name": "jsonapi-vuex",
-  "version": "5.6.0",
+  "version": "5.7.0",
   "description": "Access restructured JSONAPI data from a Vuex Store.",
   "keywords": [
     "vue",

src/actions.js

@@ -85,7 +85,12 @@ const actions = (api, conf) => {
       config['data'] = config['data'] || {}
       merge(apiConf, config)
       return api(apiConf).then((results) => {
-        let resData = utils.jsonapiToNorm(results.data.data)
+        // If there is included data, set 'inData' flag on all 'root' records
+        let setInData = false
+        if (get(results, ['data', 'included'])) {
+          setInData = true
+        }
+        let resData = utils.jsonapiToNorm(results.data.data, setInData)
         context.commit('addRecords', resData)
         let [type, id] = utils.getTypeId(data)
         if (!id && conf.clearOnUpdate) {

src/lib.js

@@ -361,20 +361,21 @@ 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} inData - Flag which if true, will mark these records as coming from 'data' not via 'included'
    * @return {object} Restructured data
    */
-  jsonapiToNorm(data) {
+  jsonapiToNorm(data, inData) {
     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))
+        Object.assign(norm[id], this.jsonapiToNormItem(item, inData))
       })
     } else {
-      Object.assign(norm, this.jsonapiToNormItem(data))
+      Object.assign(norm, this.jsonapiToNormItem(data, inData))
     }
     return norm
   }
@@ -383,9 +384,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} inData - Flag, which if true will mark this record as coming from 'data', not via 'included'
    * @return {object} Restructured data
    */
-  jsonapiToNormItem(data) {
+  jsonapiToNormItem(data, inData = false) {
     if (!data) {
       return {}
     }
@@ -394,6 +396,9 @@ 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 (inData) {
+      norm[this.jvtag].inData = inData
+    }
     return norm
   }
 

tests/unit/jsonapi-vuex.spec.js

@@ -356,6 +356,11 @@ describe('jsonapi-vuex tests', function () {
       it("should preserve deeply nested '_jv' keys", function () {
         expect(utils.jsonapiToNormItem(jsonWidget1)).to.deep.equal(normWidget1)
       })
+      it("should set the 'inData' property if inData param is true", function () {
+        // Set inData param to true
+        normWidget1._jv.inData = true
+        expect(utils.jsonapiToNormItem(jsonWidget1, true)).to.deep.equal(normWidget1)
+      })
     })
 
     describe('utils.jsonapiToNorm', function () {