WIP on tests

Author: Ben Crowl

.vscode/settings.json

@@ -3,7 +3,8 @@
     "typescript.format.placeOpenBraceOnNewLineForFunctions": true,
     "typescript.format.placeOpenBraceOnNewLineForControlBlocks": true,
     "tsimporter.emitSemicolon": false,
+    "tsimporter.noStatusBar": false,
     "tsimporter.filesToExclude": [
-        "./dist/**/*"
+        "./dist/**"
     ]
 }

README.md

@@ -1,5 +1,7 @@
-# Vuex-Typescript-Builder
+# Vuex-Typex
 
-[https://github.com/mrcrowl/vuex-ts-builder/](https://github.com/mrcrowl/vuex-ts-builder/)
+[https://github.com/mrcrowl/vuex-typex/](https://github.com/mrcrowl/vuex-typex/)
 
-A shameless extension of the ideas presented by [@istrib](https://github.com/istrib) in the [vuex-typescript](https://github.com/istrib/vuex-typescript) package.
+## A TypeScript pattern for strongly-typed access to Vuex Store modules
+
+\*A shameless extension of the ideas presented by [@istrib](https://github.com/istrib) in the [vuex-typescript](https://github.com/istrib/vuex-typescript) package.

package.json

@@ -1,7 +1,7 @@
 {
-    "name": "vuex-ts-builder",
+    "name": "vuex-typex",
     "version": "1.0.0",
-    "description": "Typescript builder for strongly-typed access to Vuex Store modules",
+    "description": "A TypeScript pattern for strongly-typed access to Vuex Store modules",
     "files": [
         "dist/index.js",
         "dist/index.d.ts"
@@ -24,7 +24,7 @@
     },
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/mrcrowl/vuex-ts-builder.git"
+        "url": "git+https://github.com/mrcrowl/vuex-typex.git"
     },
     "keywords": [
         "vuex",
@@ -34,9 +34,9 @@
     "author": "mrcrowl",
     "license": "MIT",
     "bugs": {
-        "url": "https://github.com/mrcrowl/vuex-ts-builder/issues"
+        "url": "https://github.com/mrcrowl/vuex-typex/issues"
     },
-    "homepage": "https://github.com/mrcrowl/vuex-ts-builder#readme",
+    "homepage": "https://github.com/mrcrowl/vuex-typex#readme",
     "scripts": {
         "clean": "rimraf dist && rimraf coverage",
         "compile": "tsc --pretty",

src/bah.ts

@@ -0,0 +1,11 @@
+
+type a = { a: string }
+type b = { b: number }
+type c = { c: Date }
+type d<T> = { d: (payload: { s: T }) => T }
+
+type e = a & b & c & d<Symbol> & { z: StringConstructor }
+
+type f = {[K in keyof e]: e[K]}
+
+var abcd: e;

src/index.ts

@@ -4,7 +4,7 @@ import { ActionContext, ActionTree, GetterTree, Module, MutationTree, Store } fr
 const useRootNamespace = { root: true }
 
 export type MutationHandler<S, P> = (state: S, payload: P) => void
-export type ActionHandler<S, R, P, T> = (context: BareActionContext<S, R>, payload: P) => Promise<T>
+export type ActionHandler<S, R, P, T> = (context: BareActionContext<S, R>, payload: P) => Promise<T> | T
 export type GetterHandler<S, R, T> = (state: S, rootState: R) => T
 
 export interface BareActionContext<S, R>

src/tests/store/auth/auth.ts

@@ -1,6 +1,24 @@
 
 import { ModuleBuilder } from "../../.."
-import { BirthdayState } from "./state"
+import { AuthState } from "./state"
+import { RootState } from "../index"
+import { Module } from "vuex"
 
+const initialState: AuthState = {
+    userID: "b6c8185c6d0af2f5d968",
+    isLoggedIn: true
+}
 
-const birthday = new ModuleBuilder<AuthState>
+const m = new ModuleBuilder<AuthState, RootState>("auth", initialState)
+
+const auth = {
+    commitSetUserID: m.commit((state, payload: { userID: string }) => state.userID = payload.userID),
+    commitSetIsLoggedIn: m.commit((state, payload: { isLoggedIn: boolean }) => state.isLoggedIn = payload.isLoggedIn),
+    dispatchLogin: m.dispatch((context) =>
+    {
+        return
+    })
+}
+
+export default auth
+export const birthdayModule: Module<AuthState, RootState> = m.toVuexModule()

src/tests/store/auth/state.ts

@@ -2,4 +2,5 @@
 export interface AuthState
 {
     userID: string
+    isLoggedIn: boolean
 }

src/tests/store/birthday/actions/removeFirstAfter.ts

@@ -0,0 +1,13 @@
+import birthday from "../birthday"
+import { BareActionContext } from "../../../../index"
+import { BirthdayState } from "../state"
+import { RootState } from "../../root"
+
+export default async function removeFirstAfter(context: BareActionContext<BirthdayState, RootState>, delay: number)
+{
+    if (context.state.birthdays.length > 2)
+    {
+        await new Promise((resolve, _) => setTimeout(resolve, 1000)); // second delay
+        birthday.commitRemoveFirstBirthday()
+    }
+}

src/tests/store/birthday/birthday.ts

@@ -3,39 +3,54 @@ import { ModuleBuilder } from "../../.."
 import { BirthdayState, Birthday } from "./state"
 import { Module } from "vuex"
 import { RootState } from "../root"
+import * as Vuex from "vuex"
+import removeFirstAfter from "../../../../dist/tests/store/birthday/actions/removeFirstAfter"
 
 const initialState: BirthdayState = {
     birthdays: [
         {
-            name: "Jacob",
-            dob: new Date(2006, 10, 11)
+            name: "Richard",
+            dob: new Date(1995, 10, 11)
         },
         {
-            name: "Danny",
-            dob: new Date(2009, 11, 30)
+            name: "Erlich",
+            dob: new Date(1983, 1, 17)
+        },
+        {
+            name: "Nelson",
+            dob: new Date(1996, 3, 28)
+        },
+        {
+            name: "Dinesh",
+            dob: new Date(1989, 1, 7)
+        },
+        {
+            name: "Bertram",
+            dob: new Date(1985, 7, 14)
+        },
+        {
+            name: "Donald",
+            dob: new Date(1994, 5, 31)
+        },
+        {
+            name: "Monica",
+            dob: new Date(1996, 8, 26)
         }
     ]
 }
 
-const builder = new ModuleBuilder<BirthdayState, RootState>("birthday", initialState)
+const m = new ModuleBuilder<BirthdayState, RootState>("birthday", initialState)
 
-const commitAddBirthday = builder.commit((state, payload: { birthday: Birthday }) =>
-{
-    state.birthdays.push(payload.birthday)
-})
+const addBirthdayMut = (state: BirthdayState, payload: { birthday: Birthday }) => state.birthdays.push(payload.birthday)
+const removeFirstBirthdayMut = (state: BirthdayState) => state.birthdays.shift()
 
-const commitRemoveFirstBirthday = builder.commit((state) =>
-{
-    state.birthdays.shift()
-})
-
-const getOldestName = builder.read((state): Birthday | undefined =>
+const oldestNameGetter = m.read((state): Birthday | undefined =>
 {
     const sortedBirthdays = (<Birthday[]>[]).sort((a, b) => a.dob.getTime() - b.dob.getTime())
     return sortedBirthdays[0]
-})
+}, "oldestName")
 
-const getDOBforName = builder.read((state) => (name: string) => 
+const dateOfBirthForMethod = m.read((state) => (name: string) => 
 {
     const matches = state.birthdays.filter(b => b.name === name)
     if (matches.length)
@@ -46,33 +61,23 @@ const getDOBforName = builder.read((state) => (name: string) =>
     return
 }, "dob")
 
-const dispatchRemoveFirstAfter = builder.dispatch(async (context, delay: number) =>
-{
-    if (context.state.birthdays.length > 2)
-    {
-        await new Promise((resolve, _) => setTimeout(resolve, 1000)); // second delay
-        commitRemoveFirstBirthday()
-    }
-})
-
-const module = {
+const birthday = {
     // getters + methods
-    get oldestName() { return getOldestName() },
-    dateOfBirthFor(name: string) { return getDOBforName()(name) },
+    get oldestName() { return oldestNameGetter() },
+    dateOfBirthFor(name: string) { return dateOfBirthForMethod()(name) },
 
     // mutations    
-    commitAddBirthday,
-    commitRemoveFirstBirthday,
+    commitAddBirthday: m.commit(addBirthdayMut),
+    commitRemoveFirstBirthday: m.commit(removeFirstBirthdayMut),
 
     // actions
-    dispatchRemoveFirstAfter,
+    dispatchRemoveFirstAfter: m.dispatch(removeFirstAfter)
 }
 
-module.commitAddBirthday({ birthday: { dob: new Date(1980, 2, 3), name: "Louise" } })
-module.commitRemoveFirstBirthday()
-module.dateOfBirthFor("Louise")
-module.dispatchRemoveFirstAfter(1000)
-
-export default module
+// birthday.commitAddBirthday({ birthday: { dob: new Date(1980, 2, 3), name: "Louise" } })
+// birthday.commitRemoveFirstBirthday()
+// birthday.dateOfBirthFor("Louise")
+// birthday.dispatchRemoveFirstAfter(1000)
 
-export const vuexModule: Module<BirthdayState, RootState> = builder.toVuexModule()
+export default birthday
+export const birthdayModule: Module<BirthdayState, RootState> = m.toVuexModule()

src/tests/store/index.ts

@@ -0,0 +1,19 @@
+
+import { AuthState } from "./auth/state";
+import { BirthdayState } from "../store/birthday/state"
+import { Store } from "vuex"
+import { authModule } from './auth/auth'
+import { birthdayModule } from './birthday/birthday'
+
+export interface RootState
+{
+    auth: AuthState
+    birthday: BirthdayState
+}
+
+export const createStore = new Store({
+    modules: {
+        auth: authModule,
+        birthday: birthdayModule
+    }
+})