feat: add plugin feature (#3)

Author: kiaking

src/index.ts

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

src/plugin/Plugin.ts

@@ -0,0 +1,86 @@
+import { Store } from 'vuex'
+import { Database } from '../database/Database'
+import { Model } from '../model/Model'
+import { Attribute } from '../model/attributes/Attribute'
+import { Type } from '../model/attributes/types/Type'
+import { Attr } from '../model/attributes/types/Attr'
+import { String } from '../model/attributes/types/String'
+import { Number } from '../model/attributes/types/Number'
+import { Boolean } from '../model/attributes/types/Boolean'
+import { Relation } from '../model/attributes/relations/Relation'
+import { HasOne } from '../model/attributes/relations/HasOne'
+import { HasMany } from '../model/attributes/relations/HasMany'
+import { Repository } from '../repository/Repository'
+import { Interpreter } from '../interpreter/Interpreter'
+import { Query } from '../query/Query'
+import { Connection } from '../connection/Connection'
+import { mutations, Mutations } from '../modules/Mutations'
+
+export interface VuexORMPlugin {
+  install(
+    store: Store<any>,
+    database: Database,
+    components: VuexORMPluginComponents,
+    options: any
+  ): void
+}
+
+export interface VuexORMPluginRegistry {
+  func: VuexORMPlugin
+  options: any
+}
+
+export interface VuexORMPluginComponents {
+  Database: typeof Database
+  Model: typeof Model
+  Attribute: typeof Attribute
+  Type: typeof Type
+  Attr: typeof Attr
+  String: typeof String
+  Number: typeof Number
+  Boolean: typeof Boolean
+  Relation: typeof Relation
+  HasOne: typeof HasOne
+  HasMany: typeof HasMany
+  Repository: typeof Repository
+  Interpreter: typeof Interpreter
+  Query: typeof Query
+  Connection: typeof Connection
+  mutations: Mutations<any>
+}
+
+/**
+ * The plugin registry. All plugins registered through `VuexORM.use` method
+ * is going to be stored here and then executed during the Vuex ORM
+ * installation process.
+ */
+export const plugins: VuexORMPluginRegistry[] = []
+
+/**
+ * The components to be passed to the plugin `install` method.
+ */
+export const components: VuexORMPluginComponents = {
+  Database,
+  Model,
+  Attribute,
+  Type,
+  Attr,
+  String,
+  Number,
+  Boolean,
+  Relation,
+  HasOne,
+  HasMany,
+  Repository,
+  Interpreter,
+  Query,
+  Connection,
+  mutations
+}
+
+/**
+ * Plugin additional feature to the Vuex ORM.
+ */
+export function use(plugin: VuexORMPlugin, options?: any): void {
+  plugins.push({ func: plugin, options })
+}

src/store/Store.ts

@@ -3,6 +3,7 @@ import { Store, Plugin } from 'vuex'
 import { Database } from '../database/Database'
 import { Model } from '../model/Model'
 import { Repository } from '../repository/Repository'
+import { plugins, components } from '../plugin/Plugin'
 
 export interface InstallOptions {
   namespace?: string
@@ -39,13 +40,26 @@ function mixin(
   database: Database,
   options: FilledInstallOptions
 ): void {
+  installPlugins(store, database)
+
   connectDatabase(store, database, options)
 
   mixinRepoFunction(store)
 
   startDatabase(store)
 }
 
+/**
+ * Execute registered plugins.
+ */
+function installPlugins(store: Store<any>, database: Database): void {
+  plugins.forEach((plugin) => {
+    const { func, options } = plugin
+
+    func.install(store, database, components, options)
+  })
+}
+
 /**
  * Connect the database to the store.
  */

test/feature/plugin/plugin.spec.ts

@@ -0,0 +1,79 @@
+import Vue from 'vue'
+import Vuex, { Store } from 'vuex'
+import VuexORM, { Database, Model, VuexORMPlugin } from '@/index'
+
+Vue.use(Vuex)
+
+describe('feature/plugin/plugin', () => {
+  it('can add extra feature to the store', async () => {
+    const plugin: VuexORMPlugin = {
+      install(store) {
+        ;(store as any).custom = 1
+      }
+    }
+
+    VuexORM.use(plugin)
+
+    const database = new Database()
+
+    const store = new Store({
+      plugins: [VuexORM.install(database)]
+    })
+
+    expect((store as any).custom).toBe(1)
+  })
+
+  it('can add extra feature to the database instance', async () => {
+    const plugin: VuexORMPlugin = {
+      install(_store, database) {
+        ;(database as any).custom = 1
+      }
+    }
+
+    VuexORM.use(plugin)
+
+    const database = new Database()
+
+    new Store({
+      plugins: [VuexORM.install(database)]
+    })
+
+    expect((database as any).custom).toBe(1)
+  })
+
+  it('can add extra feature to the components', async () => {
+    const plugin: VuexORMPlugin = {
+      install(_store, _database, components) {
+        ;(components.Model as any).custom = 1
+      }
+    }
+
+    VuexORM.use(plugin)
+
+    const database = new Database()
+
+    new Store({
+      plugins: [VuexORM.install(database)]
+    })
+
+    expect((Model as any).custom).toBe(1)
+  })
+
+  it('can take options', async () => {
+    const plugin: VuexORMPlugin = {
+      install(store, _database, _components, options) {
+        ;(store as any).custom = options
+      }
+    }
+
+    VuexORM.use(plugin, 1)
+
+    const database = new Database()
+
+    new Store({
+      plugins: [VuexORM.install(database)]
+    })
+
+    expect((Model as any).custom).toBe(1)
+  })
+})