@mtcute/dispatcher 0.1.0

package/esm/wizard.js

@@ -0,0 +1,99 @@
+import { Dispatcher } from './dispatcher.js';
+import { filters } from './filters/index.js';
+/**
+ * Action for the wizard scene.
+ *
+ * `Next`: Continue to the next registered step
+ * (or exit, if this is the last step)
+ *
+ * `Stay`: Stay on the same step
+ *
+ * `Exit`: Exit from the wizard scene
+ *
+ * You can also return a `number` to jump to that step
+ */
+export var WizardSceneAction;
+(function (WizardSceneAction) {
+    WizardSceneAction["Next"] = "next";
+    WizardSceneAction["Stay"] = "stay";
+    WizardSceneAction["Exit"] = "exit";
+})(WizardSceneAction = WizardSceneAction || (WizardSceneAction = {}));
+/**
+ * Wizard is a special type of Dispatcher
+ * that can be used to simplify implementing
+ * step-by-step scenes.
+ */
+export class WizardScene extends Dispatcher {
+    constructor() {
+        super(...arguments);
+        this._steps = 0;
+        this._defaultState = {};
+    }
+    setDefaultState(defaultState) {
+        this._defaultState = defaultState;
+    }
+    /**
+     * Get the total number of registered steps
+     */
+    get totalSteps() {
+        return this._steps;
+    }
+    /**
+     * Go to the Nth step
+     */
+    async goToStep(state, step) {
+        if (step >= this._steps) {
+            await state.exit();
+        }
+        else {
+            await state.merge({ $step: step }, this._defaultState);
+        }
+    }
+    /**
+     * Skip N steps
+     */
+    async skip(state, count = 1) {
+        const { $step } = (await state.get()) || {};
+        if ($step === undefined)
+            throw new Error('Wizard state is not initialized');
+        return this.goToStep(state, $step + count);
+    }
+    /**
+     * Filter that will only pass if the current step is `step`
+     */
+    static onNthStep(step) {
+        const filter = filters.state((it) => it.$step === step);
+        if (step === 0)
+            return filters.or(filters.stateEmpty, filter);
+        return filter;
+    }
+    /**
+     * Filter that will only pass if the current step is the one after last one added
+     */
+    onCurrentStep() {
+        return WizardScene.onNthStep(this._steps);
+    }
+    /**
+     * Add a step to the wizard
+     */
+    addStep(handler) {
+        const step = this._steps++;
+        this.onNewMessage(WizardScene.onNthStep(step), async (msg, state) => {
+            const result = await handler(msg, state);
+            if (typeof result === 'number') {
+                await this.goToStep(state, result);
+                return;
+            }
+            switch (result) {
+                case 'next': {
+                    await this.goToStep(state, step + 1);
+                    break;
+                }
+                case 'exit':
+                    await state.exit();
+                    break;
+            }
+        });
+    }
+}
+//# sourceMappingURL=wizard.js.map

package/esm/wizard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wizard.js","sourceRoot":"","sources":["../../src/wizard.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAG5C;;;;;;;;;;;GAWG;AACH,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IACzB,kCAAa,CAAA;IACb,kCAAa,CAAA;IACb,kCAAa,CAAA;AACjB,CAAC,EAJW,iBAAiB,GAAjB,iBAAiB,KAAjB,iBAAiB,QAI5B;AAMD;;;;GAIG;AACH,MAAM,OAAO,WAAkC,SAAQ,UAAuC;IAA9F;;QACY,WAAM,GAAG,CAAC,CAAA;QAEV,kBAAa,GAAgC,EAAiC,CAAA;IAmF1F,CAAC;IAjFG,eAAe,CAAC,YAAmB;QAC/B,IAAI,CAAC,aAAa,GAAG,YAA2C,CAAA;IACpE,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,MAAM,CAAA;IACtB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,KAAuC,EAAE,IAAY;QAChE,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE;YACrB,MAAM,KAAK,CAAC,IAAI,EAAE,CAAA;SACrB;aAAM;YACH,MAAM,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,CAAA;SACzD;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,KAAuC,EAAE,KAAK,GAAG,CAAC;QACzD,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,CAAA;QAC3C,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;QAE3E,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAAC,CAAA;IAC9C,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,IAAY;QACzB,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAsB,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAA;QAE5E,IAAI,IAAI,KAAK,CAAC;YAAE,OAAO,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;QAE7D,OAAO,MAAM,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,aAAa;QACT,OAAO,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC7C,CAAC;IAED;;OAEG;IACH,OAAO,CACH,OAG2C;QAE3C,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,CAAA;QAE1B,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;YAChE,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;YAExC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;gBAC5B,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;gBAElC,OAAM;aACT;YAED,QAAQ,MAAM,EAAE;gBACZ,KAAK,MAAM,CAAC,CAAC;oBACT,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,GAAG,CAAC,CAAC,CAAA;oBACpC,MAAK;iBACR;gBACD,KAAK,MAAM;oBACP,MAAM,KAAK,CAAC,IAAI,EAAE,CAAA;oBAClB,MAAK;aACZ;QACL,CAAC,CAAC,CAAA;IACN,CAAC;CACJ","sourcesContent":["import { MaybeAsync } from '@mtcute/client'\n\nimport { MessageContext } from './context/message.js'\nimport { Dispatcher } from './dispatcher.js'\nimport { filters } from './filters/index.js'\nimport { UpdateState } from './state/update-state.js'\n\n/**\n * Action for the wizard scene.\n *\n * `Next`: Continue to the next registered step\n * (or exit, if this is the last step)\n *\n * `Stay`: Stay on the same step\n *\n * `Exit`: Exit from the wizard scene\n *\n * You can also return a `number` to jump to that step\n */\nexport enum WizardSceneAction {\n    Next = 'next',\n    Stay = 'stay',\n    Exit = 'exit',\n}\n\ninterface WizardInternalState {\n    $step?: number\n}\n\n/**\n * Wizard is a special type of Dispatcher\n * that can be used to simplify implementing\n * step-by-step scenes.\n */\nexport class WizardScene<State extends object> extends Dispatcher<State & WizardInternalState> {\n    private _steps = 0\n\n    private _defaultState: State & WizardInternalState = {} as State & WizardInternalState\n\n    setDefaultState(defaultState: State): void {\n        this._defaultState = defaultState as State & WizardInternalState\n    }\n\n    /**\n     * Get the total number of registered steps\n     */\n    get totalSteps(): number {\n        return this._steps\n    }\n\n    /**\n     * Go to the Nth step\n     */\n    async goToStep(state: UpdateState<WizardInternalState>, step: number) {\n        if (step >= this._steps) {\n            await state.exit()\n        } else {\n            await state.merge({ $step: step }, this._defaultState)\n        }\n    }\n\n    /**\n     * Skip N steps\n     */\n    async skip(state: UpdateState<WizardInternalState>, count = 1) {\n        const { $step } = (await state.get()) || {}\n        if ($step === undefined) throw new Error('Wizard state is not initialized')\n\n        return this.goToStep(state, $step + count)\n    }\n\n    /**\n     * Filter that will only pass if the current step is `step`\n     */\n    static onNthStep(step: number) {\n        const filter = filters.state<WizardInternalState>((it) => it.$step === step)\n\n        if (step === 0) return filters.or(filters.stateEmpty, filter)\n\n        return filter\n    }\n\n    /**\n     * Filter that will only pass if the current step is the one after last one added\n     */\n    onCurrentStep() {\n        return WizardScene.onNthStep(this._steps)\n    }\n\n    /**\n     * Add a step to the wizard\n     */\n    addStep(\n        handler: (\n            msg: MessageContext,\n            state: UpdateState<State & WizardInternalState>,\n        ) => MaybeAsync<WizardSceneAction | number>,\n    ): void {\n        const step = this._steps++\n\n        this.onNewMessage(WizardScene.onNthStep(step), async (msg, state) => {\n            const result = await handler(msg, state)\n\n            if (typeof result === 'number') {\n                await this.goToStep(state, result)\n\n                return\n            }\n\n            switch (result) {\n                case 'next': {\n                    await this.goToStep(state, step + 1)\n                    break\n                }\n                case 'exit':\n                    await state.exit()\n                    break\n            }\n        })\n    }\n}\n"]}

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@mtcute/dispatcher",
+  "version": "0.1.0",
+  "description": "Updates dispatcher and bot framework for @mtcute/client",
+  "author": "Alina Sireneva <alina@tei.su>",
+  "license": "MIT",
+  "main": "cjs/index.js",
+  "type": "module",
+  "scripts": {},
+  "dependencies": {
+    "@mtcute/client": "^0.1.0",
+    "events": "3.2.0"
+  },
+  "module": "esm/index.js",
+  "exports": {
+    ".": {
+      "import": "./esm/index.js",
+      "require": "./cjs/index.js"
+    }
+  }
+}