Add type reflection support for @action

Author: keenondrums

README.md

@@ -20,7 +20,7 @@ Consider using it with [flux-action-class](https://github.com/keenondrums/flux-a
   - [Old school: JavaScript](#old-school-javascript)
 - [Integration with `immer`](#integration-with-immer)
 - [In depth](#in-depth)
-  - [When to use `@ActionReflect`](#when-to-use-actionreflect)
+  - [When we can we omit list of actions for `@Action`?](#when-we-can-we-omit-list-of-actions-for-action)
   - [Running several reducers for the same action](#running-several-reducers-for-the-same-action)
 - [How does it compare to ngrx-actions?](#how-does-it-compare-to-ngrx-actions)
 
@@ -68,7 +68,7 @@ Consider using it with [flux-action-class](https://github.com/keenondrums/flux-a
 
 ```ts
 import { ActionStandard } from 'flux-action-class'
-import { Action, ActionReflect, ReducerClass } from 'reducer-class'
+import { Action, ReducerClass } from 'reducer-class'
 
 class ActionCatEat extends ActionStandard<number> {}
 class ActionCatPlay extends ActionStandard<number> {}
@@ -82,7 +82,7 @@ class ReducerCat extends ReducerClass<IReducerCatState> {
     energy: 100,
   }
 
-  @ActionReflect
+  @Action
   addEnergy(state: IReducerCatState, action: ActionCatEat) {
     return {
       energy: state.energy + action.payload,
@@ -103,7 +103,7 @@ const reducer = ReducerCat.create()
 ### Classic NGRX actions
 
 ```ts
-import { Action, ActionReflect, ReducerClass } from 'reducer-class'
+import { Action, ReducerClass } from 'reducer-class'
 
 class ActionCatEat {
   type = 'ActionCatEat'
@@ -126,7 +126,7 @@ class ReducerCat extends ReducerClass<IReducerCatState> {
     energy: 100,
   }
 
-  @ActionReflect
+  @Action
   addEnergy(state: IReducerCatState, action: ActionCatEat) {
     return {
       energy: state.energy + action.payload,
@@ -179,7 +179,7 @@ class ReducerCat extends ReducerClass<IReducerCatState> {
 const reducer = ReducerCat.create()
 ```
 
-> You might have noticed that `ActionReflect` is missing in this version. It's because we no longer use classes for our actions and TypeScript can not provide type metadata.
+> You might have noticed that we always pass actions to `Action` in this version. It's because we no longer use classes for our actions and TypeScript can not provide type metadata.
 
 ### JavaScript with flux-action-class
 
@@ -214,7 +214,7 @@ class ReducerCat extends ReducerClass {
 const reducer = ReducerCat.create()
 ```
 
-> We can not use `ActionReflect` in JavaScript because there's no compiler which provides us with metadata for type reflection.
+> We can not use `Action` without arguments in JavaScript because there's no compiler which provides us with metadata for type reflection.
 
 > Be aware, you have to configure [babel](https://babeljs.io/) to provide you with decorator syntax.
 
@@ -262,7 +262,7 @@ Why 3? [Read pitfall #3 from immer's official documentation.](https://github.com
 
 ```ts
 import { ActionStandard } from 'flux-action-class'
-import { Action, ActionReflect, ReducerClass, Immutable } from 'reducer-class'
+import { Action, ReducerClass, Immutable } from 'reducer-class'
 
 class ActionCatEat extends ActionStandard<number> {}
 class ActionCatPlay extends ActionStandard<number> {}
@@ -276,7 +276,7 @@ class ReducerCat extends ReducerClass<IReducerCatState> {
     energy: 100,
   }
 
-  @ActionReflect
+  @Action
   addEnergy(state: Immutable<IReducerCatState>, draft: IReducerCatState, action: ActionCatEat) {
     draft.energy += action.payload
   }
@@ -294,17 +294,17 @@ const reducer = ReducerCat.create()
 
 ## In depth
 
-### When to use `@ActionReflect`
+### When we can we omit list of actions for `@Action`?
 
-You can use `@ActionReflect` if you want to run a reducer function for a single action. **Works with TypeScript only!** Action must be a class-based action. It can be a flux-action-class' action, a classic NGRX class-based action or any other class which has either a static property `type` or a property `type` on the instance of the class.
+You can omit list of actions for `@Action` if you want to run a reducer function for a single action. **Works with TypeScript only!** Action must be a class-based action. It can be a flux-action-class' action, a classic NGRX class-based action or any other class which has either a static property `type` or a property `type` on the instance of the class.
 
 ### Running several reducers for the same action
 
 If you have declare several reducer functions corresponding to the same action `reducer-class` runs all of them serially (it uses its own implementation of (reduce-reducers)[https://github.com/redux-utilities/reduce-reducers]). The order is defined by [Object.keys](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/keys).
 
 ```ts
 import { ActionStandard } from 'flux-action-class'
-import { Action, ActionReflect, ReducerClass } from 'reducer-class'
+import { Action, ReducerClass } from 'reducer-class'
 
 class ActionCatEat extends ActionStandard<number> {}
 class ActionCatSleep extends ActionStandard<number> {}
@@ -324,7 +324,7 @@ class ReducerCat extends ReducerClass<IReducerCatState> {
     }
   }
 
-  @ActionReflect
+  @Action
   addMoreEnergy(state: IReducerCatState, action: ActionCatSleep) {
     return {
       energy: state.energy + action.payload * 2,
@@ -343,6 +343,6 @@ console.log(res2) // logs 135: 130 - previous value, 5 is added by addEnergy
 ## How does it compare to [ngrx-actions](https://github.com/amcdnl/ngrx-actions)?
 
 1. Stricter typings. Now you'll never forget to add initial state, return a new state from your reducer and accidentally invoke `immer` as a result and etc.
-1. `@ActionReflect` can be used to automatically reflect a corresponding action from the type.
+1. `@Action` can be used to automatically reflect a corresponding action from the type.
 1. `ngrx-actions` doesn't allow matching several reducers to the same action, while `reducer-class` allows you to do that and merges them for you.
 1. `reducer-class` is built with both worlds, Angular and Redux, in mind. It means equal support for both of them!

index.ts

@@ -1,4 +1,4 @@
-export { Action, ActionReflect } from './src/decorator-action'
+export { Action } from './src/decorator-action'
 export { METADATA_KEY_ACTION } from './src/constants'
 export * from './src/errors'
 export { ReducerClass } from './src/reducer-class'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "reducer-class",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Boilerplate free class-based reducer creator. Built with TypeScript. Works with Redux and NGRX. Has integration with immer.",
   "main": "dist/index.js",
   "scripts": {

src/decorator-action.test.ts

@@ -4,114 +4,116 @@ import 'reflect-metadata'
 import { ActionStandard } from 'flux-action-class'
 
 import { METADATA_KEY_ACTION } from './constants'
-import { Action, ActionReflect } from './decorator-action'
+import { Action } from './decorator-action'
 import { ActionTypeUnclearError, MetadataActionPropsMissingError } from './errors'
 
 describe('Action', () => {
-  test('sets metadata', () => {
-    const prop = 'test'
-    class Action1 extends ActionStandard {}
-    const actionType2 = 'actionType2'
-    class Action3 extends ActionStandard {}
-    const action4Type = 'action4Type'
-    class Action4 {
-      public readonly type = action4Type
-      constructor(public payload: any) {}
-    }
-    class Test {
-      @Action(Action1, actionType2, Action3, Action4)
-      public [prop]() {} // tslint:disable-line no-empty
-    }
-    const metadataExpected = [Action1.type, actionType2, Action3.type, action4Type]
-    const metadataFromClass = Reflect.getMetadata(METADATA_KEY_ACTION, Test.prototype, prop)
-    expect(metadataFromClass).toEqual(metadataExpected)
-    const metadataFromInstance = Reflect.getMetadata(METADATA_KEY_ACTION, new Test(), prop)
-    expect(metadataFromInstance).toEqual(metadataExpected)
-  })
-  test('throws if no actions passed', () => {
-    const createFalseClass = () => {
-      // @ts-ignore
-      class Test {
-        @Action()
-        public test() {} // tslint:disable-line no-empty
+  describe('with reflection', () => {
+    test('sets metadata', () => {
+      const prop1 = 'test1'
+      const prop2 = 'test2'
+      const prop3 = 'test3'
+      const prop4 = 'test4'
+      class Action1 extends ActionStandard {}
+      const action2Type = 'action2Type'
+      class Action2 {
+        public readonly type = action2Type
+        constructor(public payload: any) {}
       }
-    }
-    expect(createFalseClass).toThrow(MetadataActionPropsMissingError)
-  })
-})
-
-describe('ActionReflect', () => {
-  test('sets metadata', () => {
-    const prop1 = 'test1'
-    const prop2 = 'test2'
-    const prop3 = 'test3'
-    const prop4 = 'test4'
-    class Action1 extends ActionStandard {}
-    const action2Type = 'action2Type'
-    class Action2 {
-      public readonly type = action2Type
-      constructor(public payload: any) {}
-    }
-    class Test {
-      @ActionReflect
-      public [prop1](state: any, action: Action1) {} // tslint:disable-line no-empty
+      class Test {
+        @Action
+        public [prop1](state: any, action: Action1) {} // tslint:disable-line no-empty
 
-      @ActionReflect
-      public [prop2](state: any, action: Action2) {} // tslint:disable-line no-empty
+        @Action
+        public [prop2](state: any, action: Action2) {} // tslint:disable-line no-empty
 
-      @ActionReflect
-      public [prop3](state: any, draft: any, action: Action1) {} // tslint:disable-line no-empty
+        @Action
+        public [prop3](state: any, draft: any, action: Action1) {} // tslint:disable-line no-empty
 
-      @ActionReflect
-      public [prop4](state: any, draft: any, action: Action2) {} // tslint:disable-line no-empty
-    }
-    const metadataExpected1 = [Action1.type]
-    const metadataExpected2 = [action2Type]
-    const metadataFromClass1 = Reflect.getMetadata(METADATA_KEY_ACTION, Test.prototype, prop1)
-    expect(metadataFromClass1).toEqual(metadataExpected1)
-    const metadataFromClass2 = Reflect.getMetadata(METADATA_KEY_ACTION, Test.prototype, prop2)
-    expect(metadataFromClass2).toEqual(metadataExpected2)
-    const metadataFromClass3 = Reflect.getMetadata(METADATA_KEY_ACTION, Test.prototype, prop3)
-    expect(metadataFromClass3).toEqual(metadataExpected1)
-    const metadataFromClass4 = Reflect.getMetadata(METADATA_KEY_ACTION, Test.prototype, prop4)
-    expect(metadataFromClass4).toEqual(metadataExpected2)
-    const metadataFromInstance1 = Reflect.getMetadata(METADATA_KEY_ACTION, new Test(), prop1)
-    expect(metadataFromInstance1).toEqual(metadataExpected1)
-    const metadataFromInstance2 = Reflect.getMetadata(METADATA_KEY_ACTION, new Test(), prop2)
-    expect(metadataFromInstance2).toEqual(metadataExpected2)
-    const metadataFromInstance3 = Reflect.getMetadata(METADATA_KEY_ACTION, new Test(), prop3)
-    expect(metadataFromInstance3).toEqual(metadataExpected1)
-    const metadataFromInstance4 = Reflect.getMetadata(METADATA_KEY_ACTION, new Test(), prop4)
-    expect(metadataFromInstance4).toEqual(metadataExpected2)
-  })
-  test('throws if no action argument provided', () => {
-    const createFalseClass = () => {
-      // @ts-ignore
-      class Test {
-        @ActionReflect
-        public test() {} // tslint:disable-line no-empty
+        @Action
+        public [prop4](state: any, draft: any, action: Action2) {} // tslint:disable-line no-empty
       }
-    }
-    expect(createFalseClass).toThrow(ActionTypeUnclearError)
-  })
-  test('throws if too many action arguments provided', () => {
-    const createFalseClass = () => {
-      // @ts-ignore
-      class Test {
-        @ActionReflect
-        public test(arg1: any, arg2: any, arg3: any, arg4: any) {} // tslint:disable-line no-empty
+      const metadataExpected1 = [Action1.type]
+      const metadataExpected2 = [action2Type]
+      const metadataFromClass1 = Reflect.getMetadata(METADATA_KEY_ACTION, Test.prototype, prop1)
+      expect(metadataFromClass1).toEqual(metadataExpected1)
+      const metadataFromClass2 = Reflect.getMetadata(METADATA_KEY_ACTION, Test.prototype, prop2)
+      expect(metadataFromClass2).toEqual(metadataExpected2)
+      const metadataFromClass3 = Reflect.getMetadata(METADATA_KEY_ACTION, Test.prototype, prop3)
+      expect(metadataFromClass3).toEqual(metadataExpected1)
+      const metadataFromClass4 = Reflect.getMetadata(METADATA_KEY_ACTION, Test.prototype, prop4)
+      expect(metadataFromClass4).toEqual(metadataExpected2)
+      const metadataFromInstance1 = Reflect.getMetadata(METADATA_KEY_ACTION, new Test(), prop1)
+      expect(metadataFromInstance1).toEqual(metadataExpected1)
+      const metadataFromInstance2 = Reflect.getMetadata(METADATA_KEY_ACTION, new Test(), prop2)
+      expect(metadataFromInstance2).toEqual(metadataExpected2)
+      const metadataFromInstance3 = Reflect.getMetadata(METADATA_KEY_ACTION, new Test(), prop3)
+      expect(metadataFromInstance3).toEqual(metadataExpected1)
+      const metadataFromInstance4 = Reflect.getMetadata(METADATA_KEY_ACTION, new Test(), prop4)
+      expect(metadataFromInstance4).toEqual(metadataExpected2)
+    })
+    test('throws if no action argument provided', () => {
+      const createFalseClass = () => {
+        // @ts-ignore
+        class Test {
+          @Action
+          public test() {} // tslint:disable-line no-empty
+        }
+      }
+      expect(createFalseClass).toThrow(ActionTypeUnclearError)
+    })
+    test('throws if too many action arguments provided', () => {
+      const createFalseClass = () => {
+        // @ts-ignore
+        class Test {
+          @Action
+          public test(arg1: any, arg2: any, arg3: any, arg4: any) {} // tslint:disable-line no-empty
+        }
+      }
+      expect(createFalseClass).toThrow(ActionTypeUnclearError)
+    })
+    test('throws if action argument type is unclear', () => {
+      const createFalseClass = () => {
+        // @ts-ignore
+        class Test {
+          @Action
+          public test(arg1: any, arg2: undefined) {} // tslint:disable-line no-empty
+        }
       }
-    }
-    expect(createFalseClass).toThrow(ActionTypeUnclearError)
+      expect(createFalseClass).toThrow(ActionTypeUnclearError)
+    })
   })
-  test('throws if action argument type is unclear', () => {
-    const createFalseClass = () => {
-      // @ts-ignore
+
+  describe('without reflection', () => {
+    test('sets metadata', () => {
+      const prop = 'test'
+      class Action1 extends ActionStandard {}
+      const actionType2 = 'actionType2'
+      class Action3 extends ActionStandard {}
+      const action4Type = 'action4Type'
+      class Action4 {
+        public readonly type = action4Type
+        constructor(public payload: any) {}
+      }
       class Test {
-        @ActionReflect
-        public test(arg1: any, arg2: undefined) {} // tslint:disable-line no-empty
+        @Action(Action1, actionType2, Action3, Action4)
+        public [prop]() {} // tslint:disable-line no-empty
+      }
+      const metadataExpected = [Action1.type, actionType2, Action3.type, action4Type]
+      const metadataFromClass = Reflect.getMetadata(METADATA_KEY_ACTION, Test.prototype, prop)
+      expect(metadataFromClass).toEqual(metadataExpected)
+      const metadataFromInstance = Reflect.getMetadata(METADATA_KEY_ACTION, new Test(), prop)
+      expect(metadataFromInstance).toEqual(metadataExpected)
+    })
+    test('throws if no actions passed', () => {
+      const createFalseClass = () => {
+        // @ts-ignore
+        class Test {
+          @Action()
+          public test() {} // tslint:disable-line no-empty
+        }
       }
-    }
-    expect(createFalseClass).toThrow(ActionTypeUnclearError)
+      expect(createFalseClass).toThrow(MetadataActionPropsMissingError)
+    })
   })
 })