fix issues with default keys

Author: cjcrawford

dist/index.js

@@ -0,0 +1,12 @@
+import { Model } from '@vuex-orm/core'
+
+export default class Role extends Model {
+  static entity = 'roles'
+
+  static fields () {
+    return {
+      id: this.attr(null),
+      name: this.attr('')
+    }
+  }
+}

package-lock.json

@@ -1,4 +1,5 @@
 import { Model } from '@vuex-orm/core'
+import Role from './Role'
 
 export default class User extends Model {
   static entity = 'users'
@@ -8,7 +9,12 @@ export default class User extends Model {
       id: this.attr(null),
       name: this.attr(''),
       email: this.attr(''),
-      phone: this.attr('')
+      phone: this.attr(''),
+      roleId: this.attr(1),
+      role: this.belongsTo(Role, 'roleId')
     }
   }
+  get formattedPhone () {
+    return this.phone
+  }
 }

src/common/models/Role.js

@@ -3,12 +3,14 @@ import Vuex from 'vuex'
 import VuexORM from '@vuex-orm/core'
 import VuexORMSearchPlugin from 'src/index'
 import User from './common/models/User'
+import Role from './common/models/Role'
 
 Vue.use(Vuex)
 VuexORM.use(VuexORMSearchPlugin)
 
 const database = new VuexORM.Database()
 database.register(User, {})
+database.register(Role, {})
 
 export const store = new Vuex.Store({
   plugins: [VuexORM.install(database)]

src/common/models/User.js

@@ -24,19 +24,37 @@ const plugin = {
 
     // -- breaking change check in 0.23.1
     const {Query} = components
-
+    /*
     const searchKeys = function () {
       // -- normal keys
-      let fields = Object.keys(this.model.fields())
+      const modelFields = Object.keys(this.model.fields())
       // -- mutations
-      fields.concat(Object.keys(this.model.mutators))
+      const mutationFields = Object.keys(this.model.mutators)
+
       // -- related (1 deep)
-      this.load.forEach(({name}) => {
-        const relatedFields = Object.keys(this.getModel(name).fields())
-        fields.concat(relatedFields.map(rf => `${name}.${rf}`))
+      let relatedFields = []
+      this.load.forEach(relationship => {
+        const relatedModel = this.getModel(relationship.name)
+        if (relatedModel) {
+          relatedFields.concat(
+            Object.keys(relatedModel.fields())
+            .map(rf => `${relationship.name}.${rf}`)
+          )
+        }
       })
-      return fields
+      if (process.env.ENVIRONMENT === 'testing') {
+        console.log(' -- LOADED --')
+        console.log(this.load)
+        console.log(' ----- MODEL ---- ')
+        console.log(modelFields)
+        console.log(' ----- MUTATORS ---- ')
+        console.log(mutationFields)
+        console.log(' ----- RELATED ---- ')
+        console.log(relatedFields)
+      }
+      return modelFields.concat(mutationFields).concat(relatedFields)
     }
+    */
 
     const searchProcess = function ({records, entity, term, options}) {
 
@@ -82,15 +100,15 @@ const plugin = {
       }
 
       //-- get default keys
-      const allKeys = searchKeys.call(this)
+      // const allKeys = searchKeys.call(this)
 
       // -- override default keys if run-time initializes keys
-      const instanceOptions = {
+      let instanceOptions = {
         ...pluginOptions,
-        ...singleOptions,
-        ...{
-          keys: singleOptions.keys && singleOptions.keys.length ? singleOptions.keys : allKeys
-        }
+        ...singleOptions
+      }
+      if (instanceOptions.keys && !instanceOptions.keys.length) {
+        instanceOptions.keys = Object.keys(this.model.fields())
       }
 
       if (pluginOptions.debug || process.env.ENVIRONMENT === 'testing' || singleOptions.debug) {
@@ -112,7 +130,7 @@ const plugin = {
     }
 
     // -- prototype methods
-    Query.prototype.searchKeys = searchKeys
+    // Query.prototype.searchKeys = searchKeys
     Query.prototype.search = search
 
   }

src/dev.js

@@ -14,20 +14,36 @@ describe('Setup unit tests', function () {
           id: 1,
           name: 'John Walker',
           email: 'john@gmail.com',
-          phone: '(555) 281-4567'
+          phone: '(555) 281-4567',
+          roleId: 1
         },
         {
           id: 2,
           name: 'Bobby Banana',
           email: 'walker.banana@gmail.com',
-          phone: '(555) 555-4567'
+          phone: '(555) 555-4567',
+          roleId: 2
         }
       ]
     })
 
-    const records = store.getters['entities/users/query']().all()
+    store.dispatch('entities/roles/create', {
+      data: [
+        {
+          id: 1,
+          name: 'Admin'
+        },
+        {
+          id: 2,
+          name: 'Customer'
+        }
+      ]
+    })
 
-    expect(records).to.have.lengthOf(2)
+    const records = store.getters['entities/users/query']()
+      .withAll()
+      .all()
+      expect(records).to.have.lengthOf(2)
 
   })