clearOnUpdate should only apply to collection gets, not item gets.

Use a new object for more atomic store updates.

Author: mrichar1

README.md

@@ -659,7 +659,7 @@ As `addRecords`, but explicitly merges onto existing records.
 
 #### clearRecords
 
-Will remove all records from the store (of a given type) which aren't contained in a given response. Can be set as he default behaviour on updates - see [clearOnUpdate](#usage).
+Will remove all records from the store (of a given type) which aren't contained in a given response. Can be set as the default behaviour on updates - see [clearOnUpdate](#usage).
 
 ```js
 // Remove all records of type 'widget' from the store
@@ -761,7 +761,7 @@ For many of these options, more information is provided in the [Usage](#usage) s
 - `followRelationshipsData` - Whether to follow and expand relationships and store them alongside attributes in the item 'root' (defaults to `true`).
 - `preserveJson` - Whether actions should return the API response json (minus `data`) in `_jv/json` (for access to `meta` etc) (defaults to `false`)
 - `mergeRecords` - Whether new records should be merged onto existing records in the store, or just replace them (defaults to `false`).
-- `clearOnUpdate` - Whether the store should clear old records and only keep new records when updating. Applies to the `type(s)` associated with the new records. (defaults to false).
+- `clearOnUpdate` - Whether the store should clear old records and only keep new records when updating from a 'collection' get. Applies to the `type(s)` associated with the new records. (defaults to false).
 - `cleanPatch` - If enabled, patch object is compared to the record in the store, and only unique or modified attributes are kept in the patch. (defaults to false).
 - `cleanPatchProps` - If cleanPatch is enabled, an array of `_jv` properties that should be preserved - `links`, `meta`, and/or `relationships`. (defaults to `[]`).
 - `recurseRelationships` - If `false`, replaces recursive relationships with a normalised resource identifier (i.e `{ _jv: { type: 'x', id: 'y' } }`). (defaults to `false`).

package.json

@@ -49,7 +49,7 @@
     "vuex": "^4.0.0"
   },
   "name": "jsonapi-vuex",
-  "version": "5.4.0",
+  "version": "5.5.0",
   "description": "Access restructured JSONAPI data from a Vuex Store.",
   "keywords": [
     "vue",

src/actions.js

@@ -87,11 +87,11 @@ const actions = (api, conf) => {
       return api(apiConf).then((results) => {
         let resData = utils.jsonapiToNorm(results.data.data)
         context.commit('addRecords', resData)
-        if (conf.clearOnUpdate) {
+        let [type, id] = utils.getTypeId(data)
+        if (!id && conf.clearOnUpdate) {
           let record = resData
           if (Object.keys(resData).length === 0) {
             // No records - assume type == endpoint
-            let [type] = utils.getTypeId(data)
             record = { _jv: { type: type } }
           }
           context.commit('clearRecords', record)

src/lib.js

@@ -529,8 +529,10 @@ const Utils = class {
    * @param {boolean} merging - Whether or not to merge or overwrite records
    */
   updateRecords(state, records, merging = this.conf.mergeRecords) {
+    let newState = {}
     const storeRecords = this.normToStore(records)
     for (let [type, item] of Object.entries(storeRecords)) {
+      newState[type] = {}
       if (!this.hasProperty(state, type)) {
         state[type] = {}
         // If there's no type, then there are no existing records to merge
@@ -543,11 +545,11 @@ const Utils = class {
             data = merge(oldRecord, data)
           }
         }
-        state[type][id] = data
+        newState[type][id] = data
       }
       // FIXME: Review with release of Vuex5 to see if there is a new ref()/reactive() approach
       // Maintain reactivity by 'touching' the 'root' state property
-      state[type] = { ...state[type] }
+      state[type] = Object.assign({}, state[type], newState[type])
     }
   }
 }

tests/unit/actions/get.spec.js

@@ -183,13 +183,22 @@ describe('get', function () {
     expect(res).to.not.have.key('_jv')
   })
 
-  it('should call clearRecords if clearOnUpdate is set', async function () {
+  it('should call clearRecords if clearOnUpdate is set for collections', async function () {
+    this.mockApi.onAny().reply(200, { data: [] })
+
+    config.clearOnUpdate = true
+
+    await jsonapiModule.actions.get(stubContext, '/widgets')
+    expect(stubContext.commit).to.have.been.calledWith('clearRecords')
+  })
+
+  it('should not call clearRecords if clearOnUpdate is set for items', async function () {
     this.mockApi.onAny().reply(200, { data: jsonWidget1 })
 
     config.clearOnUpdate = true
 
     await jsonapiModule.actions.get(stubContext, normWidget1)
-    expect(stubContext.commit).to.have.been.calledWith('clearRecords', normWidget1)
+    expect(stubContext.commit).to.not.have.been.calledWith('clearRecords')
   })
 
   it('should call clearRecords with endpoint if clearOnUpdate is set and no data', async function () {