# vuex-smart-module Type safe Vuex module with powerful module features. The basic API idea is brought from [Sinai](https://github.com/ktsn/sinai). ## Features - Completely type safe when used with TypeScript without redundancy. - Provide a smart way to use modules. - Canonical Vuex-like API as possible. ## Installation ```bash $ npm install vuex-smart-module ``` ## Usage **All examples are written in TypeScript** You create a module with class syntax: ```ts // store/modules/foo.ts // Import base classes import { Getters, Mutations, Actions, Module } from 'vuex-smart-module' // State class FooState { count = 1 } // Getters // Extend 'Getters' class with 'FooState' type class FooGetters extends Getters { // You can declare both getter properties or methods get double() { // Getters instance has 'state' property return this.state.count * 2 } get triple() { // When you want to use another getter, there is `getters` property return this.getters.double + this.state.count } } // Mutations // Extend 'Mutations' class with 'FooState' type class FooMutations extends Mutations { increment(payload: number) { // Mutations instance has 'state' property. // You update 'this.state' by mutating it. this.state.count += payload } } // Actions // Extend 'Actions' class with other module asset types // Note that you need to specify self action type (FooActions) as a type parameter explicitly class FooActions extends Actions< FooState, FooGetters, FooMutations, FooActions > { incrementAsync(payload: { amount: number; interval: number }) { // Actions instance has 'state', 'getters', 'commit' and 'dispatch' properties return new Promise(resolve => { setTimeout(() => { this.commit('increment', payload.amount) resolve() }, payload.interval) }) } } // Create a module with module asset classes export const foo = new Module({ state: FooState, getters: FooGetters, mutations: FooMutations, actions: FooActions }) ``` Then, create Vuex store instance by using `createStore` function from `vuex-smart-module`: ```ts // store/index.ts import Vue from 'vue' import * as Vuex from 'vuex' import { createStore, Module } from 'vuex-smart-module' import { foo } from './modules/foo' Vue.use(Vuex) // The 1st argument is root module. // Vuex store options should be passed to the 2nd argument. export const store = createStore( // Root module foo, // Vuex store options { strict: process.env.NODE_ENV !== 'production' } ) ``` The created store is a traditional instance of Vuex store - you can use it in the same manner. ```ts // main.ts import Vue from 'vue' import { store } from './store' import App from './App.vue' new Vue({ el: '#app', store, render: h => h(App) }) ``` ### Nested Modules You can create a nested module as same as Vuex by passing a module object to another module's `modules` option. ```ts import { Getters, Module, createStore } from 'vuex-smart-module' class NestedState { value = 'hello' } class NestedGetters extends Getters { greeting(name: string): string { return this.state.value + ', ' + name } } const nested = new Module({ state: NestedState, getters: NestedGetters }) const root = new Module({ modules: { nested } }) const store = createStore(root) console.log(store.state.nested.value) // -> hello console.log(store.getters['nested/greeting']('John')) // -> hello, John ``` Nested modules will be [namespaced module](https://vuex.vuejs.org/guide/modules.html#namespacing) by default. If you do not want a module to be a namespaced, pass the `namespaced: false` option to the module's constructor options. ```ts import { Getters, Module, createStore } from 'vuex-smart-module' class NestedState { value = 'hello' } class NestedGetters extends Getters { greeting(name: string): string { return this.state.value + ', ' + name } } const nested = new Module({ // nested module will not be namespaced namespaced: false state: NestedState, getters: NestedGetters }) const root = new Module({ modules: { nested } }) const store = createStore(root) console.log(store.state.nested.value) // -> hello console.log(store.getters.greeting('John')) // -> hello, John ``` ### Module Lifecycle and Dependencies Getters and actions class can have a special method `$init` which will be called after the module is initialized in a store. The `$init` hook receives the store instance as the 1st argument. You can pick some external dependencies from it. The following is an example for [Nuxt](https://nuxtjs.org/) + [Axios Module](https://axios.nuxtjs.org/). ```ts import { Store } from 'vuex' import { Actions } from 'vuex-smart-module' class FooActions extends Actions { // Declare dependency type store: Store // Called after the module is initialized $init(store: Store): void { // Retain store instance for later this.store = store } async fetch(): Promise { console.log(await this.store.$axios.$get('...')) } } ``` There are no `rootState`, `rootGetters` and `root` options on `dispatch`, `commit` because they are too difficult to type and the code has implicit dependencies to other modules. In case of you want to use another module in some module, you can create a module context. ```ts import { Store } from 'vuex' import { Getters, Actions, Module, Context } from 'vuex-smart-module' // Foo module class FooState { value = 'hello' } const foo = new Module({ state: FooState }) // Bar module (using foo module in getters and actions) class BarGetters extends Getters { // Declare context type foo: Context // Called after the module is initialized $init(store: Store): void { // Create and retain foo module context this.foo = foo.context(store) } get excited(): string { return this.foo.state.value + '!' // -> hello! } } class BarActions extends Actions { // Declare context type foo: Context // Called after the module is initialized $init(store: Store): void { // Create and retain foo module context this.foo = foo.context(store) } print(): void { console.log(this.foo.state.value) // -> hello } } const bar = new Module({ getters: BarGetters, actions: BarActions }) // Make sure to have all modules in the store const root = new Module({ modules: { foo, bar } }) const store = createStore(root) ``` ### Nested Module Context When there are nested modules in your module, you can access them through a module context. Let's say you have three modules: counter, todo and root where the root module has former two modules as nested modules: ```ts import { Module, createStore } from 'vuex-smart-module' // Counter module const counter = new Module({ // ... }) // Todo module const todo = new Module({ // ... }) // Root module const root = new Module({ modules: { counter, todo } }) export const store = createStore(root) ``` You can access counter and todo contexts through the root context by using `modules` property. ```ts import { root, store } from './store' // Get root context const ctx = root.context(store) // You can access counter and todo context through `modules` as well const counterCtx = ctx.modules.counter const todoCtx = ctx.modules.todo counterCtx.dispatch('increment') todoCtx.dispatch('fetchTodos') ``` ### Register Module Dynamically You can use `registerModule` to register a module and `unregisterModule` to unregister it. ```ts import { registerModule, unregisterModule } from 'vuex-smart-module' import { store } from './store' import { foo } from './store/modules/foo' // register module registerModule( store, // store instance ['foo'], // module path. can be string or array of string 'foo/', // namespace string which will be when put into the store foo, // module instance // module options as same as vuex registerModule { preserveState: true } ) // unregister module unregisterModule( store, // store instance foo // module instance which you want to unregister ) ``` Note that the 3rd argument of `registerModule`, which is the namespace string, must match with the actual namespace that the store resolves. If you pass the wrong namespace to it, component mappers and context api would not work correctly. ### Component Mapper You can generate `mapXXX` helpers, which are the same interface as Vuex ones, for each associated module by using the `createMapper` function. The mapped computed properties and methods are strictly typed. So you will not have some typo or pass wrong payloads to them. ```ts // @/store/modules/foo import { Module, createMapper } from 'vuex-smart-module' // Create module export const foo = new Module({ // ... }) // Create mapper export const fooMapper = createMapper(foo) ``` ```ts import Vue from 'vue' // Import foo mapper import { fooMapper } from '@/store/modules/foo' export default Vue.extend({ computed: fooMapper.mapGetters(['double']), methods: fooMapper.mapActions({ incAsync: 'incrementAsync' }), created() { console.log(this.double) this.incAsync(undefined) } }) ``` ### Composable Function If you prefer composition api for binding a store module to a component, you can create a composable function by using `createComposable`. ```ts // @/store/modules/foo import { Module, createMapper } from 'vuex-smart-module' // Create module export const foo = new Module({ // ... }) // Create mapper export const useFoo = createComposable(foo) ``` ```ts import { defineComponent } from '@vue/composition-api' // Import useFoo import { useFoo } from '@/store/modules/foo' export default defineComponent({ setup() { // Get Foo module's context const foo = useFoo() console.log(foo.getters.double) foo.dispatch('incrementAsync') } }) ``` ### Method Style Access for Actions and Mutations `this` in an action and a module context have `actions` and `mutations` properties. They contains module actions and mutations in method form. You can use them instead of `dispatch` or `commit` if you prefer method call style over event emitter style. The method style has several advantages: you can use _Go to definition_ for your actions and mutations and it prints simple and easier to understand errors if you pass a wrong payload type, for example. Example usage in an action: ```ts import { Actions } from 'vuex-smart-module' class FooActions extends Actions { increment(amount: number) // Call `increment` mutation this.mutations.increment(payload) } } ``` Example usage via a context: ```ts import Vue from 'vue' // Import foo module import { foo } from '@/store/modules/foo' export default Vue.extend({ mounted() { const ctx = foo.context(this.$store) // Call `increment` action ctx.actions.increment(1) } }) ``` ### Using in Nuxt's Modules Mode You can use `Module#getStoreOptions()` method to use vuex-smart-module in [Nuxt's module mode](https://nuxtjs.org/guide/vuex-store). When you have a counter module like the below: ```ts // store/counter.ts import { Getters, Actions, Mutations, Module } from 'vuex-smart-module' export class CounterState { count = 0 } export class CounterGetters extends Getters { get double() { return this.state.count * 2 } } export class CounterMutations extends Mutations { inc() { this.state.count++ } } export class CounterActions extends Actions { inc() { this.commit('inc') } } export default new Module({ state: CounterState, getters: CounterGetters, mutations: CounterMutations, actions: CounterActions }) ``` Construct a vuex-smart-module root module and export the store options acquired with `getStoreOptions` in `store/index.ts`. Note that you have to register all nested modules through the root module: ```ts // store/index.ts import { Module } from 'vuex-smart-module' import counter from './counter' const root = new Module({ modules: { counter } }) export const { state, getters, mutations, actions, modules, plugins } = root.getStoreOptions() ``` If you want to extend a store option, you can manually modify it: ```ts // store/index.ts const options = root.getStoreOptions() export const { state, getters, mutations, actions, modules } = options // Add an extra plugin export const plugins = options.plugins.concat([otherPlugin]) ``` ### Hot Module Replacement To utilize [hot module replacement](https://webpack.js.org/concepts/hot-module-replacement/) for the store created with vuex-smart-module, we provide `hotUpdate` function. The below is an example how to use `hotUpdate` function: ```ts import { createStore, hotUpdate } from 'vuex-smart-module' import root from './root' export const store = createStore(root) if (module.hot) { // accept actions and mutations as hot modules module.hot.accept(['./root'], () => { // require the updated modules // have to add .default here const newRoot = require('./root').default // swap in the new root module by using `hotUpdate` provided from vuex-smart-module. hotUpdate(store, newRoot) }) } ``` Note that you cannot use `hotUpdate` under Vuex store instance. Use `hotUpdate` function imported from `vuex-smart-module`. ## Testing ### Unit testing getters, mutations and actions vuex-smart-module provides the `inject` helper function which allows you to inject mock dependencies into getters, mutations and actions instances. You can inject any properties for test: ```ts import { inject } from 'vuex-smart-module' import { FooGetters, FooActions } from '@/store/modules/foo' it('returns doubled value', () => { // Inject mock state into getters const getters = inject(FooGetters, { state: { count: 5 } }) // Test double getter expect(getters.double).toBe(10) }) it('increments asynchronously', async () => { // Inject mock commit method const commit = jest.fn() const actions = inject(FooActions, { commit }) await actions.incrementAsync({ amount: 3 interval: 1 }) // Check mock commit method is called expect(commit).toHaveBeenCalledWith('increment', 3) }) ``` ### Mocking modules to test components When you want to mock some module assets, you can directly inject a mock constructor into the module options. For example, you will test the following component which is using the `counter` module: ```vue ``` In the spec file, mock the `mutations` option in the `counter` module. The below is a [Jest](https://jestjs.io/) example but the essential idea holds true for many test frameworks: ```ts import * as Vuex from 'vuex' import { shallowMount, createLocalVue } from '@vue/test-utils' import { createStore } from 'vuex-smart-module' // component which we want to test import Counter from '@/components/Counter.vue' // counter module which we want to mock import counter, { CounterMutations } from '@/store/modules/counter' const localVue = createLocalVue() localVue.use(Vuex) // make sure that you clean mocked object after each test case const originalMutations = counter.options.mutations afterEach(() => { counter.options.mutations = originalMutations }) it('calls increment mutation', () => { // create spy const spy = jest.fn() // create mock mutation class MockMutations extends CounterMutations { // override increment method for mock increment() { spy() } } // inject mock counter.options.mutations = MockMutations // create mock store const store = createStore(counter) // emulate click event shallowMount(Counter, { store, localVue }).trigger('click') // check the mock function was called expect(spy).toHaveBeenCalled() }) ``` ### Mocking nested modules and dependencies Using dependencies and nested module contexts in Actions requires to mock them in tests. So you test the following Actions class that has been constructed as described in the section above: ```ts import { Store } from 'vuex' import { Actions } from 'vuex-smart-module' class FooActions extends Actions { // Declare dependency type store!: Store bar!: Context // Called after the module is initialized $init(store: Store): void { // Retain store instance for later this.store = store this.bar = bar.context(store) } async fetch(): Promise { console.log(await this.store.$axios.$get('...')) this.bar.dispatch(...) } } ``` Then the Jest spec file would be written as: ```ts import { inject } from 'vuex-smart-module' import { FooActions } from '@/store/modules/foo' describe('FooActions', () => { it('calls the dependency and dispatches the remote action', async () => { const axiosGet = jest.fn() const barDispatch = jest.fn() const actions = inject(FooActions, { store: { $axios: { $get: axiosGet } }, bar: { dispatch: barDispatch } }) await actions.fetch() expect(axiosGet).toHaveBeenCalledWith(...) expect(barDispatch).toHaveBeenCalledWith(...) }) }) ``` ## License MIT

	Stars	Issues	Version	Updated	Created
vuex-aggregate	15	32	4.1.3	5 years ago	5 years ago
vuex-class	1,730	20	0.3.2	4 years ago	6 years ago
vuex-smart-module	387	26	0.6.2	4 months ago	4 years ago
vuex-typex	195	11	3.1.9	2 years ago	6 years ago

vuex-aggregate vs vuex-class vs vuex-smart-module vs vuex-typex

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past