feat: add mapRepos helper (#5)

Author: kiaking

package.json

@@ -48,6 +48,7 @@
     "url": "https://github.com/vuex-orm/vuex-orm-next/issues"
   },
   "peerDependencies": {
+    "vue": ">=2.6.0",
     "vuex": ">=3.1.0"
   },
   "dependencies": {

src/helpers/Helpers.ts

@@ -0,0 +1,36 @@
+import Vue from 'vue'
+import { Model } from '../model/Model'
+import { Repository } from '../repository/Repository'
+
+export type MappedRepositories<MR extends ModelsOrRepositories> = {
+  [K in keyof MR]: MR[K] extends typeof Model
+    ? () => Repository<InstanceType<MR[K]>>
+    : () => InstanceType<MR[K]>
+}
+
+export type ModelOrRepository<
+  M extends typeof Model,
+  R extends typeof Repository
+> = M | R
+
+export type ModelsOrRepositories<
+  M extends typeof Model = any,
+  R extends typeof Repository = any
+> = Record<string, ModelOrRepository<M, R>>
+
+/**
+ * Map given models or repositories to the Vue Component.
+ */
+export function mapRepos<MR extends ModelsOrRepositories>(
+  modelsOrRepositories: MR
+): MappedRepositories<MR> {
+  const repositories = {} as MappedRepositories<MR>
+
+  for (const name in modelsOrRepositories) {
+    ;(repositories as any)[name] = function (this: Vue) {
+      return this.$store.$repo(modelsOrRepositories[name])
+    }
+  }
+
+  return repositories
+}

src/index.cjs.ts

@@ -2,6 +2,7 @@ import './polyfills/Polyfills'
 
 import { install } from './store/Store'
 import { use } from './plugin/Plugin'
+import { mapRepos } from './helpers/Helpers'
 import { Database } from './database/Database'
 import { Schema } from './schema/Schema'
 import { Model } from './model/Model'
@@ -29,6 +30,7 @@ import { Connection } from './connection/Connection'
 export default {
   install,
   use,
+  mapRepos,
   Database,
   Schema,
   Model,

src/index.ts

@@ -34,10 +34,12 @@ export * from './interpreter/Interpreter'
 export * from './query/Query'
 export * from './query/Options'
 export * from './connection/Connection'
+export * from './helpers/Helpers'
 export * from './plugin/Plugin'
 
 import { install } from './store/Store'
 import { use } from './plugin/Plugin'
+import { mapRepos } from './helpers/Helpers'
 import { Database } from './database/Database'
 import { Schema } from './schema/Schema'
 import { Model } from './model/Model'
@@ -58,6 +60,7 @@ import { Connection } from './connection/Connection'
 export default {
   install,
   use,
+  mapRepos,
   Database,
   Schema,
   Model,

test/feature/helpers/helpers.spec.ts

@@ -0,0 +1,44 @@
+import Vue from 'vue'
+import { createStore } from 'test/Helpers'
+import { Model, Attr, Str, Repository, mapRepos } from '@/index'
+
+describe('feature/helpers/helpers', () => {
+  class User extends Model {
+    static entity = 'users'
+
+    @Attr() id!: any
+    @Str('') name!: string
+  }
+
+  class UserRepository extends Repository<User> {
+    use = User
+  }
+
+  it('maps repositories to vue component from models', async () => {
+    const store = createStore([User])
+
+    const vm = new Vue({
+      store,
+      computed: mapRepos({
+        userRepo: User
+      })
+    })
+
+    expect(vm.userRepo).toBeInstanceOf(Repository)
+    expect(vm.userRepo.getModel()).toBeInstanceOf(User)
+  })
+
+  it('maps repositories to vue component from repositories', async () => {
+    const store = createStore([User])
+
+    const vm = new Vue({
+      store,
+      computed: mapRepos({
+        userRepo: UserRepository
+      })
+    })
+
+    expect(vm.userRepo).toBeInstanceOf(Repository)
+    expect(vm.userRepo.getModel()).toBeInstanceOf(User)
+  })
+})