Actor model (since 1973) & XState

.eslintrc.cjs

@@ -1,6 +1,8 @@
-// eslint-disable-next-line semi
-
 const rules = {
+  'array-bracket-spacing': [
+    'error',
+    'always',
+  ],
 }
 
 module.exports = {

.vscode/launch.json

@@ -0,0 +1,27 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "pwa-node",
+            "request": "launch",
+            "name": "Launch Program",
+            "runtimeExecutable": "/home/huan/.nvm/versions/node/v16.13.2/bin/node",
+            "runtimeArgs": [
+              "--loader",
+              "ts-node/esm",
+              "--no-warnings",
+            ],
+            "skipFiles": [
+              "<node_internals>/**",
+              "${workspaceFolder}/node_modules/**/*.js",
+            ],
+            "program": "${workspaceFolder}/src/application-actors/message-to-text/machine.spec.ts",
+            "outFiles": [
+                "${workspaceFolder}/**/*.js"
+            ]
+        }
+    ]
+}

README.md

@@ -8,6 +8,135 @@ BOT5 Meeting Assistant BOT powered by RSVP.ai & Wechaty & XState.
 
 ![BOT5 Club](docs/images/caq-bot5-qingyu.webp)
 
+## BOT5 Club Seminar Flow Chart
+
+```mermaid
+flowchart TD
+  Initializing --> Loading
+  subgraph Loading
+    LoadSavedState
+  end
+
+  Loading --> Restoring
+  subgraph Restoring
+    SetContext
+    TransitionToLastStateOrCalling
+  end
+
+  Restoring --> Calling
+  subgraph Calling
+    SetChairs
+    SetTalks
+    SetSchedule
+  end
+
+  Calling --> Registering
+  subgraph Registering
+    attendees
+    EveryDay
+    8h
+    4h
+    2h
+    1h
+    20m
+    10m
+  end
+
+  Registering --> Checkining
+  Checkining --> Starting
+  Starting --> Introducing
+  Introducing --> Retrospecting
+  Retrospecting --> Welcoming
+  subgraph Welcoming
+    Joining
+    introducing
+  end
+
+  Welcoming --> Presenting
+  Presenting --> Promoting
+  subgraph Promoting
+    Newcomer
+    TrialMember
+    Member
+    TrialChair
+    Chair
+  end
+
+  Promoting --> Brainstorming
+  Brainstorming --> Roasting
+  Roasting --> Chairing  
+  subgraph Chairing
+    Electing
+      Naming
+      Voting
+      Deciding
+    Summarizing
+    Pledging
+  end
+
+  Chairing --> Photoing
+  subgraph Photoing
+    ShootingChairs
+    ShootingAll
+  end
+
+  Photoing --> Housekeeping
+  Housekeeping --> AfterParty
+  subgraph AfterParty
+    Chatting
+    Drinking
+    ShootingDrinkers
+    Paying
+  end
+
+  AfterParty --> Completing
+  Completing --> Completed
+```
+
+```
+
+
+
+```
+
+See also: [BOT5 Club Chair Manual](http://bot5.ml/manuals/chair/)
+
+## User Journey Diagram
+
+Learn more from [BOT Friday Club Seminar Chair Manual](http://bot5.ml/manuals/chair/)
+
+To be writen...
+
+### Registering
+
+```mermaid
+journey
+  title Registering - BOT Friday Club Seminar
+  section Register
+    Make tea: 5: Chair
+    Go upstairs: 3: Chair
+    Do work: 1: Member
+    Miao: 3: Cat, Member
+  section Go home
+    Go downstairs: 5: Chair
+    Sit down: 5: Member
+```
+
+### Mindstorming
+
+```mermaid
+journey
+  title Mindstorming - BOT Friday Club Seminar
+  section Mindsotming
+    Make tea: 5: Chair
+    Go upstairs: 3: Chair
+    Do work: 1: Member
+    Miao: 3: Cat, Member
+  section Member PTT
+    Go downstairs: 5: Chair
+    Sit down: 5: Member
+```
+
 ## Getting Started
 
 ### Step 1: Install
@@ -69,6 +198,19 @@ We are trying to use [XState](https://xstate.js.org/) to implement the FSM and u
 
 Currently we are just getting started, you can learn more about the BOT5 Club Meeting FSM at <https://wechaty.github.io/bot5-assistant/>
 
+## Resources
+
+### Projects
+
+- [Dialogs modeled as finite state machines, Giorgio Robino, Jul 14, 2016](https://solyarisoftware.medium.com/dialoghi-come-macchine-a-stati-41bb748fd5b0)
+
+### Papers
+
+- [Dialog Management for Credit Card Selling via Finite State Machine Using Sentiment Classification in Turkish Language, Gizem Sogancıo ˘ glu et. al., INTELLI 2017 : The Sixth International Conference on Intelligent Systems and Applications (includes InManEnt)](https://www.thinkmind.org/articles/intelli_2017_2_30_60066.pdf)
+- [State Machine Based Human-Bot Conversation Model and Services, Shayan Zamanirad et. al., May 9, 2020, CAiSE 2020](https://www.semanticscholar.org/paper/State-Machine-Based-Human-Bot-Conversation-Model-Zamanirad-Benatallah/ffa524c4e247a9f532ea4ddb6407be0c9cc8d301)
+- [Tartan: A retrieval-based socialbot powered by a dynamic finite-state machine architecture, George Larionov, 4 Dec 2018](https://arxiv.org/abs/1812.01260)
+- [A Chatbot by Combining Finite State Machine , Information Retrieval , and Bot-Initiative Strategy, Sanghyun Yi, Published 2017](https://www.semanticscholar.org/paper/A-Chatbot-by-Combining-Finite-State-Machine-%2C-%2C-and-Yi/1fc7c24d80ede54871696e8e44a60fb6d0c8a475)
+
 ## History
 
 ### main v0.3 (Nov 29, 2021)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "wechaty-bot5-assistant",
-  "version": "0.3.8",
+  "version": "1.11.0",
   "description": "BOT Friday Club Assistant",
   "type": "module",
   "exports": {
@@ -31,9 +31,16 @@
     "wechaty"
   ],
   "author": {
-    "name": "Anqi CUI",
-    "url": "https://wechaty.js.org/contributors/caq"
+    "name": "Huan LI",
+    "url": "https://wechaty.js.org/contributors/huan",
+    "email": "[email protected]"
   },
+  "contributors": [
+    {
+      "name": "Anqi CUI",
+      "url": "https://wechaty.js.org/contributors/caq"
+    }
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/wechaty/bot5-assistant.git"
@@ -45,26 +52,36 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@chatie/eslint-config": "^1.0.4",
-    "@chatie/git-scripts": "^0.6.2",
+    "@chatie/git-scripts": "^0.7.7",
     "@chatie/semver": "^0.4.7",
-    "@chatie/tsconfig": "^4.6.2",
-    "@types/lru-cache": "^5.1.1",
-    "@types/request": "^2.48.7",
-    "@types/uuid": "^8.3.3",
-    "wechaty": "^1",
-    "wechaty-mocker": "^1.10.2",
-    "wechaty-puppet-mock": "^1"
+    "@chatie/tsconfig": "^4.6.3",
+    "@types/lru-cache": "^7.4.0",
+    "@types/request": "^2.48.8",
+    "@types/uuid": "^8.3.4",
+    "@types/ws": "^8.5.3",
+    "@xstate/inspect": "^0.6.4",
+    "typescript": "^4.6.2",
+    "utility-types": "^3.10.0",
+    "wechaty": "^1.18.1",
+    "wechaty-mocker": "^1.11.3",
+    "wechaty-puppet-mock": "^1.19.3",
+    "ws": "^8.5.0"
   },
   "peerDependencies": {
-    "wechaty-plugin-contrib": "^1"
+    "wechaty-plugin-contrib": "^1.11.1"
   },
   "readme": "README.md",
   "dependencies": {
-    "lru-cache": "^6.0.0",
+    "file-box": "^1.4.15",
+    "lru-cache": "^7.5.0",
+    "mailbox": "^0.10.9",
     "request": "^2.88.2",
-    "tencentcloud-sdk-nodejs": "^4.0.246",
+    "tencentcloud-sdk-nodejs": "^4.0.306",
+    "typed-inject": "^3.0.1",
+    "typesafe-actions": "^5.1.0",
     "uuid": "^8.3.2",
-    "xstate": "^4.26.1"
+    "wechaty-cqrs": "^0.15.4",
+    "xstate": "^4.31.0"
   },
   "git": {
     "scripts": {

src/actor-utils/invoke-id.spec.ts

@@ -0,0 +1,17 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+import { test } from 'tstest'
+
+import { invokeId } from './invoke-id.js'
+
+test('invokeId() smoke testing', async t => {
+  const FIXTURES = [
+    [
+      [ 'childId', 'parentId', 'id1', 'id2' ],
+      'childId@parentId@id1@id2',
+    ],
+  ] as const
+
+  for (const [ ids, expected ] of FIXTURES) {
+    t.equal(invokeId(ids[0], ids[1], ...ids.slice(2)), expected, `invokeId(${ids}) should be ${expected}`)
+  }
+})

src/actor-utils/invoke-id.ts

@@ -0,0 +1,13 @@
+/**
+ * Generate an invoke id in an machine for make it distinct
+ *
+ * @param childId { string } - the id of the child actor
+ * @param parentId { string } - the id of the parent actor
+ * @param ids - additional ids
+ * @returns generated invoke id
+ */
+export function invokeId (childId: string, parentId: string, ...ids: string[]) {
+  return [ parentId, ...ids ].reduce((acc, id) => {
+    return acc + '@' + id
+  }, childId)
+}

src/actor-utils/mod.ts

@@ -0,0 +1 @@
+export { responseStates } from './response-states.js'