wechaty · huan · Mar 27, 2022 · Mar 17, 2022 · Mar 18, 2022 · Mar 18, 2022
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -1,5 +1,5 @@
-
 const rules = {
+  'no-redeclare': 'off',
 }
 
 module.exports = {

diff --git a/README.md b/README.md
@@ -197,7 +197,13 @@ Read CQRS Wechaty API Reference at: <https://paka.dev/npm/wechaty-cqrs>
 
 ## History
 
-### main
+### main v1.12
+
+1. Classify action builders so that they will be compatible with Class events
+  with NestJS [#1](https://github.com/wechaty/cqrs/issues/1)
+1. `execute$()` helper function for sending the events to the bus
+  and get back the response, with automatically type inferring.
+1. lots of typing enhancements.
 
 ## v0.10 (Mar 17) Beta release
 

diff --git a/examples/ding-dong-bot.ts b/examples/ding-dong-bot.ts
@@ -64,12 +64,12 @@ const onMessage$ = (bus$: CQRS.Bus) => CQRS.events$.messageReceivedEvent$(bus$).
     /**
      * message -> sayable
      */
-    map(messageId => CQRS.queries.getSayablePayloadQuery(
+    map(messageId => CQRS.queries.GetSayablePayloadQuery(
       messageReceivedEvent.meta.puppetId,
       messageId,
     )),
-    mergeMap(CQRS.execute$(bus$)(CQRS.queries.getSayablePayloadQuery)),
-    map(sayablePayloadGotMessage => sayablePayloadGotMessage.payload),
+    mergeMap(CQRS.execute$(bus$)),
+    map(sayablePayloadGotMessage => sayablePayloadGotMessage.payload.sayable),
     filter(Boolean),
     tap(sayable => console.info('sayable:', sayable)),
 
@@ -85,19 +85,19 @@ const onMessage$ = (bus$: CQRS.Bus) => CQRS.events$.messageReceivedEvent$(bus$).
       /**
        * ding -> talkerId
        */
-      map(messageReceivedEvent => CQRS.queries.getMessagePayloadQuery(messageReceivedEvent.meta.puppetId, messageReceivedEvent.payload.messageId)),
-      mergeMap(CQRS.execute$(bus$)(CQRS.queries.getMessagePayloadQuery)),
+      map(messageReceivedEvent => CQRS.queries.GetMessagePayloadQuery(messageReceivedEvent.meta.puppetId, messageReceivedEvent.payload.messageId)),
+      mergeMap(CQRS.execute$(bus$)),
       /**
        * Huan(202203): `.fromId` deprecated, will be removed after v2.0
        */
-      map(messagePayloadGotMmessage => messagePayloadGotMmessage.payload?.talkerId || messagePayloadGotMmessage.payload?.fromId),
+      map(messagePayloadGotMmessage => messagePayloadGotMmessage.payload.message?.talkerId || messagePayloadGotMmessage.payload.message?.fromId),
       filter(Boolean),
       tap(talkerId => console.info('talkerId:', talkerId)),
 
       /**
        * talkerId -> command
        */
-      map(talkerId => CQRS.commands.sendMessageCommand(
+      map(talkerId => CQRS.commands.SendMessageCommand(
         messageReceivedEvent.meta.puppetId,
         talkerId,
         CQRS.sayables.text('dong'),
@@ -107,7 +107,7 @@ const onMessage$ = (bus$: CQRS.Bus) => CQRS.events$.messageReceivedEvent$(bus$).
       /**
        * execute command (return MessageSentMessage)
        */
-      mergeMap(CQRS.execute$(bus$)(CQRS.commands.sendMessageCommand)),
+      mergeMap(CQRS.execute$(bus$)),
     )),
   )),
 )
@@ -127,10 +127,7 @@ async function cqrsWechaty () {
 }
 
 async function main () {
-  const {
-    bus$,
-    puppetId,
-  }             = await cqrsWechaty()
+  const { bus$, puppetId } = await cqrsWechaty()
 
   const onStartedEvent$ = (bus$: CQRS.Bus) => CQRS.events$.startedEvent$(bus$).pipe(
     switchMap(() => merge(
@@ -141,13 +138,13 @@ async function main () {
     )),
   )
 
-  const main$ = defer(() => of(CQRS.commands.startCommand(puppetId))).pipe(
+  const main$ = defer(() => of(CQRS.commands.StartCommand(puppetId))).pipe(
     mergeMap(startCommand => merge(
       onStartedEvent$(bus$),
-      CQRS.execute$(bus$)(CQRS.commands.startCommand)(startCommand),
+      CQRS.execute$(bus$)(startCommand),
     )),
     ignoreElements(),
-    finalize(() => bus$.next(CQRS.commands.stopCommand(puppetId))),
+    finalize(() => bus$.next(CQRS.commands.StopCommand(puppetId))),
   )
 
   /**

diff --git a/examples/template.ts b/examples/template.ts
@@ -42,11 +42,11 @@ const onScan$ = (source$: CQRS.BusObs) => CQRS.events$.scanReceivedEvent$(source
 )
 
 const onMessage$ = (bus$: CQRS.Bus) => CQRS.events$.messageReceivedEvent$(bus$).pipe(
-  map(messageReceivedEvent => CQRS.queries.getSayablePayloadQuery(
+  map(messageReceivedEvent => CQRS.queries.GetSayablePayloadQuery(
     messageReceivedEvent.meta.puppetId,
     messageReceivedEvent.payload.messageId,
   )),
-  mergeMap(CQRS.execute$(bus$)(CQRS.queries.getSayablePayloadQuery)),
+  mergeMap(CQRS.execute$(bus$)),
   map(sayablePayloadGotMessage => sayablePayloadGotMessage.payload),
   tap(sayable => console.info('onMessage$:', sayable)),
 )
@@ -59,8 +59,8 @@ async function main () {
   /**
    * Start/stop Wechaty when subscribing/unsubscribing
    */
-  const onSubscribe$  = () => defer(()    => CQRS.execute$(bus$)(CQRS.commands.startCommand)(CQRS.commands.startCommand(wechaty.puppet.id)))
-  const onUnsubscribe = () => finalize(() => bus$.next(CQRS.commands.stopCommand(wechaty.puppet.id)))
+  const onSubscribe$  = () => defer(()    => CQRS.execute$(bus$)(CQRS.commands.StartCommand(wechaty.puppet.id)))
+  const onUnsubscribe = () => finalize(() => bus$.next(CQRS.commands.StopCommand(wechaty.puppet.id)))
 
   const handlers$ = (bus$: CQRS.Bus) => merge(
     onScan$(bus$),

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "wechaty-cqrs",
-  "version": "0.10.4",
+  "version": "0.12.1",
   "description": "An event-driven architecture wrapper for Wechaty that applies the CQS principle by using separate Query and Command messages to retrieve and modify the bot state, respectively.",
   "type": "module",
   "exports": {
@@ -107,7 +107,9 @@
   },
   "dependencies": {
     "ducks": "^1.3.2",
+    "lodash": "^4.17.21",
     "redux": "^4.1.2",
+    "reflect-metadata": "^0.1.13",
     "rxjs": "^7.5.5",
     "time-constants": "^1.0.3",
     "typesafe-actions": "^5.1.0",
@@ -123,10 +125,11 @@
     "@chatie/semver": "^0.4.7",
     "@chatie/tsconfig": "^4.6.3",
     "@types/glob": "^7.2.0",
+    "@types/lodash": "^4.14.180",
     "@types/time-constants": "^1.0.0",
     "@types/uuid": "^8.3.4",
     "glob": "^7.2.0",
-    "tstest": "^1.2.6",
+    "tstest": "^1.2.8",
     "wechaty-puppet-mock": "^1.18.2",
     "wechaty-puppet-wechat": "^1.12.2"
   },

diff --git a/src/bus.ts b/src/bus.ts
@@ -25,7 +25,7 @@ import type {
   ActionType,
 }                   from 'typesafe-actions'
 
-import type * as CqrsDuck  from './duck/mod.js'
+import type * as classified from './classified/mod.js'
 
 // type BusSubject<T> = Subject<
 //   ActionType<T>
@@ -34,7 +34,7 @@ import type * as CqrsDuck  from './duck/mod.js'
 /**
  * Huan(202203): Use a simplified interface for Bus
  */
-export interface Bus<T = ActionType<typeof CqrsDuck.actions>> {
+export interface Bus<T = ActionType<typeof classified.actions>> {
   asObservable : Subject<T>['asObservable']
   next         : Subject<T>['next']
   // complete     : Subject<T>['complete']

diff --git a/src/classified/actions/commands.ts b/src/classified/actions/commands.ts
@@ -0,0 +1,14 @@
+import { classifyMap }  from '../../classify/classify-map.js'
+import * as commands    from '../../duck/actions/commands.js'
+
+/**
+ * Selective export `Command` only
+ */
+export const {
+  DingCommand,
+  ResetCommand,
+  NopCommand,
+  SendMessageCommand,
+  StartCommand,
+  StopCommand,
+} = classifyMap(commands)
diff --git a/src/classified/actions/events.ts b/src/classified/actions/events.ts
@@ -0,0 +1,26 @@
+import { classifyMap }  from '../../classify/classify-map.js'
+import * as events      from '../../duck/actions/events.js'
+
+/**
+ * Selective export for `Event` only
+ */
+export const {
+  DongReceivedEvent,
+  ErrorReceivedEvent,
+  FriendshipReceivedEvent,
+  HeartbeatReceivedEvent,
+  LoginReceivedEvent,
+  LogoutReceivedEvent,
+  MessageReceivedEvent,
+  ReadyReceivedEvent,
+  ResetReceivedEvent,
+  RoomInviteReceivedEvent,
+  RoomJoinReceivedEvent,
+  RoomLeaveReceivedEvent,
+  RoomTopicReceivedEvent,
+  ScanReceivedEvent,
+  StartedEvent,
+  StateActivatedEvent,
+  StateInactivatedEvent,
+  StoppedEvent,
+} = classifyMap(events)
diff --git a/src/classified/actions/mod.ts b/src/classified/actions/mod.ts
@@ -0,0 +1,4 @@
+export * from './commands.js'
+export * from './events.js'
+export * from './queries.js'
+export * from './responses.js'
diff --git a/src/classified/actions/queries.ts b/src/classified/actions/queries.ts
@@ -0,0 +1,13 @@
+import { classifyMap }  from '../../classify/classify-map.js'
+import * as queries     from '../../duck/actions/queries.js'
+
+/**
+ * Selective export `Query` only
+ */
+export const {
+  GetAuthQrCodeQuery,
+  GetCurrentUserIdQuery,
+  GetIsLoggedInQuery,
+  GetMessagePayloadQuery,
+  GetSayablePayloadQuery,
+} = classifyMap(queries)
diff --git a/src/classified/actions/responses.ts b/src/classified/actions/responses.ts
@@ -0,0 +1,23 @@
+import { classifyMap }  from '../../classify/classify-map.js'
+import * as commands    from '../../duck/actions/commands.js'
+import * as queries     from '../../duck/actions/queries.js'
+
+/**
+ * Selective export for `Response` only
+ */
+export const {
+  DingCommandResponse,
+  GetAuthQrCodeQueryResponse,
+  GetCurrentUserIdQueryResponse,
+  GetIsLoggedInQueryResponse,
+  GetMessagePayloadQueryResponse,
+  GetSayablePayloadQueryResponse,
+  NopCommandResponse,
+  ResetCommandResponse,
+  SendMessageCommandResponse,
+  StartCommandResponse,
+  StopCommandResponse,
+} = classifyMap({
+  ...commands,
+  ...queries,
+})
diff --git a/src/classified/mod.ts b/src/classified/mod.ts
@@ -0,0 +1,17 @@
+import type * as commandTypes from './types/commands.js'
+import type * as queryTypes   from './types/queries.js'
+
+import type * as commandActions from './actions/commands.js'
+import type * as queryActions   from './actions/queries.js'
+
+export type CQType =
+  | typeof commandTypes [keyof typeof commandTypes]
+  | typeof queryTypes   [keyof typeof queryTypes]
+
+export type CQAction =
+  | InstanceType<typeof commandActions[keyof typeof commandActions]>
+  | InstanceType<typeof queryActions  [keyof typeof queryActions]>
+
+export type { Type }  from './types/types.js'
+export * as types     from './types/mod.js'
+export * as actions   from './actions/mod.js'
diff --git a/src/classified/types/commands.ts b/src/classified/types/commands.ts
@@ -0,0 +1,9 @@
+import { types } from './types.js'
+
+export const {
+  DING_COMMAND,
+  RESET_COMMAND,
+  SEND_MESSAGE_COMMAND,
+  START_COMMAND,
+  STOP_COMMAND,
+} = types
diff --git a/src/classified/types/events.ts b/src/classified/types/events.ts
@@ -0,0 +1,22 @@
+import { types } from './types.js'
+
+export const {
+  DONG_RECEIVED_EVENT,
+  ERROR_RECEIVED_EVENT,
+  FRIENDSHIP_RECEIVED_EVENT,
+  HEARTBEAT_RECEIVED_EVENT,
+  LOGIN_RECEIVED_EVENT,
+  LOGOUT_RECEIVED_EVENT,
+  MESSAGE_RECEIVED_EVENT,
+  READY_RECEIVED_EVENT,
+  RESET_RECEIVED_EVENT,
+  ROOM_INVITE_RECEIVED_EVENT,
+  ROOM_JOIN_RECEIVED_EVENT,
+  ROOM_LEAVE_RECEIVED_EVENT,
+  ROOM_TOPIC_RECEIVED_EVENT,
+  SCAN_RECEIVED_EVENT,
+  STARTED_EVENT,
+  STATE_ACTIVATED_EVENT,
+  STATE_INACTIVATED_EVENT,
+  STOPPED_EVENT,
+} = types
diff --git a/src/classified/types/mod.ts b/src/classified/types/mod.ts
@@ -0,0 +1,4 @@
+export * from './commands.js'
+export * from './events.js'
+export * from './queries.js'
+export * from './responses.js'
diff --git a/src/classified/types/queries.ts b/src/classified/types/queries.ts
@@ -0,0 +1,9 @@
+import { types } from './types.js'
+
+export const {
+  GET_AUTH_QR_CODE_QUERY,
+  GET_CURRENT_USER_ID_QUERY,
+  GET_IS_LOGGED_IN_QUERY,
+  GET_MESSAGE_PAYLOAD_QUERY,
+  GET_SAYABLE_PAYLOAD_QUERY,
+} = types
diff --git a/src/classified/types/responses.ts b/src/classified/types/responses.ts
@@ -0,0 +1,14 @@
+import { types } from './types.js'
+
+export const {
+  DING_COMMAND_RESPONSE,
+  GET_AUTH_QR_CODE_QUERY_RESPONSE,
+  GET_CURRENT_USER_ID_QUERY_RESPONSE,
+  GET_IS_LOGGED_IN_QUERY_RESPONSE,
+  GET_MESSAGE_PAYLOAD_QUERY_RESPONSE,
+  GET_SAYABLE_PAYLOAD_QUERY_RESPONSE,
+  RESET_COMMAND_RESPONSE,
+  SEND_MESSAGE_COMMAND_RESPONSE,
+  START_COMMAND_RESPONSE,
+  STOP_COMMAND_RESPONSE,
+} = types
diff --git a/src/classified/types/types.ts b/src/classified/types/types.ts
@@ -0,0 +1,17 @@
+import { ActionCreatorTypeMetadata, getType } from 'typesafe-actions'
+
+import { PureTypeName, pureTypeName } from '../../classify/pure-type-name.js'
+
+import * as actions from '../actions/mod.js'
+
+export type Type = typeof actions[keyof typeof actions] extends ActionCreatorTypeMetadata<infer TType> ? TType : never
+
+type TypeMap = {
+  [T in Type as PureTypeName<T>]: T
+}
+
+export const types = Object.values(actions).reduce((acc, action) => {
+  const type = getType(action)
+  acc[pureTypeName(type)] = type
+  return acc
+}, {} as any) as TypeMap
diff --git a/src/classify/classify-map.spec.ts b/src/classify/classify-map.spec.ts
@@ -0,0 +1,31 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+
+import {
+  test,
+  AssertEqual,
+}                     from 'tstest'
+
+import * as duck from '../duck/mod.js'
+
+import { classify }     from './classify.js'
+import { classifyMap }  from './classify-map.js'
+
+test('classify smoke testing', async t => {
+  const actionMap = {
+    dongReceivedEvent:          duck.actions.dongReceivedEvent,
+    sendMessageCommand:         duck.actions.sendMessageCommand,
+    sendMessageCommandResponse: duck.actions.sendMessageCommandResponse,
+  }
+
+  const EXPECTED = {
+    DongReceivedEvent:          classify(duck.actions.dongReceivedEvent),
+    SendMessageCommand:         classify(duck.actions.sendMessageCommand),
+    SendMessageCommandResponse: classify(duck.actions.sendMessageCommandResponse),
+  }
+
+  const classMap = classifyMap(actionMap)
+  t.same(classMap, EXPECTED, 'should be the same of classMap & EXPECTED')
+
+  const test: AssertEqual<typeof classMap, typeof EXPECTED> = true
+  t.ok(test, 'should be the same typing of classMap & EXPECTED')
+})