chz-telegram-bot 0.0.23 → 0.0.24

package/main.ts

@@ -13,13 +13,23 @@ function log(text: string) {
     Logger.logWithTraceId('ALL BOTS', 'System:Bot', 'System', text);
 }
 
+/**
+ * Starts bot
+ */
 async function startBot(options: {
+    /** Bot name, used in logging */
     name: string;
+    /** Path to file containing Telegram Bot token. */
     tokenFilePath: string;
+    /** Collection of actions that will be executed as a response to message from used. Created using `CommandActionBuilder`.*/
     commands: CommandAction<IActionState>[];
+    /** Collection of actions that will be executed on timer. Created using `ScheduledActionBuilder`.*/
     scheduled: ScheduledAction<IActionState>[];
-    chats: Map<string, number>;
+    /** Object containing chat name and chat id pairs. Used for logging and execution of scheduled action. */
+    chats: Record<string, number>;
+    /** Storage client for bot state storage. If not provided, default `JsonFileStorage` will be used. */
     storageClient?: IStorageClient;
+    /** Storage path for default `JsonFileStorage` client. Will be used only if `storageClient` is not provided. If not provided, default value of `./storage/` will be used.*/
     storagePath?: string;
 }) {
     const token = await readFile(options.tokenFilePath, 'utf8');
@@ -37,6 +47,9 @@ async function startBot(options: {
     return bot;
 }
 
+/**
+ * Terminates all scheduled tasks, closes storage connections and stops all bots.
+ */
 async function stopBots(reason: string) {
     log(`Recieved termination code: ${reason}`);
     Scheduler.stopAll();
@@ -44,7 +57,7 @@ async function stopBots(reason: string) {
 
     log('Stopping bots...');
     for (const bot of bots) {
-        bot.stop(reason);
+        await bot.stop(reason);
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "chz-telegram-bot",
-    "version": "0.0.23",
+    "version": "0.0.24",
     "type": "module",
     "dependencies": {
         "async-sema": "^3.1.1",

package/services/taskScheduler.ts

@@ -1,6 +1,5 @@
 import { TaskRecord } from '../entities/taskRecord';
-import { secondsToMilliseconds } from '../helpers/timeConvertions';
-import { Milliseconds, Seconds } from '../types/timeValues';
+import { Milliseconds } from '../types/timeValues';
 import { Logger } from './logger';
 
 class TaskScheduler {
@@ -24,7 +23,7 @@ class TaskScheduler {
         const task = new TaskRecord(name, taskId, interval);
 
         if (executeRightAway) {
-            setTimeout(action, secondsToMilliseconds(1 as Seconds));
+            setImmediate(action);
         }
 
         Logger.logWithTraceId(

package/services/telegramApi.ts

@@ -1,7 +1,7 @@
 import { InputFile, Message } from 'telegraf/types';
 import { ChatContext } from '../entities/context/chatContext';
 import { MessageContext } from '../entities/context/messageContext';
-import { reverseMap } from '../helpers/reverseMap';
+import { reverseRecord } from '../helpers/reverseRecord';
 import { IStorageClient } from '../types/storage';
 import { Logger } from './logger';
 import { Reaction } from '../entities/responses/reaction';
@@ -21,24 +21,26 @@ export class TelegramApiService {
 
     botName: string;
     telegram: Telegram;
-    chats: Map<number, string>;
+    chats: Record<number, string>;
     storage: IStorageClient;
 
     constructor(
         botName: string,
         telegram: Telegram,
         storage: IStorageClient,
-        chats: Map<string, number>
+        chats: Record<string, number>
     ) {
         this.telegram = telegram;
         this.botName = botName;
-        this.chats = reverseMap(chats);
+        this.chats = reverseRecord(chats);
         this.storage = storage;
     }
 
     async flushResponses() {
         if (this.isFlushing) return;
 
+        this.isFlushing = true;
+
         while (this.messageQueue.length) {
             const message = this.messageQueue.pop();
 
@@ -51,7 +53,7 @@ export class TelegramApiService {
                 Logger.errorWithTraceId(
                     this.botName,
                     message.traceId,
-                    this.chats.get(message.chatId)!,
+                    this.chats[message.chatId],
                     error,
                     message
                 );
@@ -199,7 +201,7 @@ export class TelegramApiService {
             scheduledKey,
             this.getInteractions(),
             chatId,
-            this.chats.get(chatId)!,
+            this.chats[chatId],
             `Scheduled:${scheduledKey}:${chatId}`,
             this.storage
         );

package/types/handlers.ts

@@ -4,12 +4,17 @@ import { IActionState } from './actionState';
 import { CachedValueAccessor } from './cachedValueAccessor';
 
 export type CommandHandler<TActionState extends IActionState> = (
+    /** Context of action executed in chat, in response to a message. */
     ctx: MessageContext<TActionState>,
+    /** State of an action being executed. */
     state: TActionState
 ) => Promise<void>;
 
 export type ScheduledHandler<TActionState extends IActionState> = (
+    /** Context of action executed in chat. */
     ctx: ChatContext,
+    /** Function that will attempt to get value from cache. If there is no value found, corresponding cached state factory will be called. */
     getCached: CachedValueAccessor,
+    /** State of an action being executed. */
     state: TActionState
 ) => Promise<void>;

package/helpers/reverseMap.ts

@@ -1,3 +0,0 @@
-export function reverseMap<K, V>(map: Map<K, V>): Map<V, K> {
-    return new Map(Array.from(map, ([key, value]) => [value, key]));
-}