chz-telegram-bot 0.0.23 → 0.0.25

package/dist/helpers/builders/scheduledActionBuilder.js

@@ -5,7 +5,15 @@ const scheduledAction_1 = require("../../entities/actions/scheduledAction");
 const cachedStateFactory_1 = require("../../entities/cachedStateFactory");
 const actionStateBase_1 = require("../../entities/states/actionStateBase");
 const noop_1 = require("../noop");
+/**
+ * Builder for `ScheduledAction` with state represented by `TActionState`
+ */
 class ScheduledActionBuilderWithState {
+    /**
+     * Builder for `ScheduledAction` with state represented by `TActionState`
+     * @param name Action name, will be used for logging and storage
+     * @param stateConstructor Function that creates default state object
+     */
     constructor(name, stateConstructor) {
         this.active = true;
         this.time = 0;
@@ -15,32 +23,58 @@ class ScheduledActionBuilderWithState {
         this.name = name;
         this.stateConstructor = stateConstructor;
     }
+    /**
+     * Adds a chat to whitelist for this action.
+     * @param chatId Chat id to execute in.
+     */
     allowIn(chatId) {
         this.whitelist.push(chatId);
         return this;
     }
+    /**
+     * Defines time for scheduled item execution.
+     * @param time Time of day (0 - 23) to execute action.
+     */
     runAt(time) {
         this.time = time;
         return this;
     }
+    /** Defines action logic itself, will be executed on timer.
+     * @param handler Callback that will be called on timer.
+     */
     do(handler) {
         this.handler = handler;
         return this;
     }
+    /**
+     * Defines process-wide cache, that is shared by all actions of this type (even in different bot instances).
+     * Can be used for fetch request de-duping, etc.
+     * @param key Key that will be used to retrieve value from cache.
+     * @param itemFactory Callback that will be executed once to create cached value.
+     * @param invalidationTimeoutInHours Timeout for cache invalidation.
+     */
     withSharedCache(key, itemFactory, invalidationTimeoutInHours = 20) {
         this.cachedStateFactories.set(key, new cachedStateFactory_1.CachedStateFactory(itemFactory, invalidationTimeoutInHours));
         return this;
     }
+    /** If called during building, action is marked as disabled and never checked. */
     disabled() {
         this.active = false;
         return this;
     }
+    /** Builds action */
     build() {
         return new scheduledAction_1.ScheduledAction(this.name, this.handler, this.time, this.active, this.whitelist, this.cachedStateFactories, this.stateConstructor);
     }
 }
 exports.ScheduledActionBuilderWithState = ScheduledActionBuilderWithState;
+/**
+ * Builder for `ScheduledAction` with state represented by default state (containing only last execution date).
+ */
 class ScheduledActionBuilder extends ScheduledActionBuilderWithState {
+    /**
+     * Builder for `ScheduledAction` with state represented by default state (containing only last execution date).
+     */
     constructor(name) {
         super(name, () => new actionStateBase_1.ActionStateBase());
     }

package/dist/helpers/reverseRecord.d.ts

@@ -0,0 +1,2 @@
+export declare function reverseRecord<T extends PropertyKey, U extends PropertyKey>(input: Record<T, U>): Record<U, T>;
+//# sourceMappingURL=reverseRecord.d.ts.map

package/dist/helpers/reverseRecord.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reverseRecord.d.ts","sourceRoot":"","sources":["../../helpers/reverseRecord.ts"],"names":[],"mappings":"AAAA,wBAAgB,aAAa,CAAC,CAAC,SAAS,WAAW,EAAE,CAAC,SAAS,WAAW,EACtE,KAAK,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAId,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CACpB"}

package/dist/helpers/reverseRecord.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reverseRecord = reverseRecord;
+function reverseRecord(input) {
+    return Object.fromEntries(Object.entries(input).map(([key, value]) => [value, key]));
+}

package/dist/main.d.ts

@@ -3,15 +3,28 @@ import { CommandAction } from './entities/actions/commandAction';
 import { ScheduledAction } from './entities/actions/scheduledAction';
 import { IActionState } from './types/actionState';
 import { BotInstance } from './entities/botInstance';
+/**
+ * Starts bot
+ */
 declare 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;
 }): Promise<BotInstance>;
+/**
+ * Terminates all scheduled tasks, closes storage connections and stops all bots.
+ */
 declare function stopBots(reason: string): Promise<void>;
 export { startBot, stopBots };
 //# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../main.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAQrD,iBAAe,QAAQ,CAAC,OAAO,EAAE;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC;IACxC,SAAS,EAAE,eAAe,CAAC,YAAY,CAAC,EAAE,CAAC;IAC3C,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3B,aAAa,CAAC,EAAE,cAAc,CAAC;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB,wBAcA;AAED,iBAAe,QAAQ,CAAC,MAAM,EAAE,MAAM,iBASrC;AAED,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../main.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAQrD;;GAEG;AACH,iBAAe,QAAQ,CAAC,OAAO,EAAE;IAC7B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,aAAa,EAAE,MAAM,CAAC;IACtB,2HAA2H;IAC3H,QAAQ,EAAE,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC;IACxC,mGAAmG;IACnG,SAAS,EAAE,eAAe,CAAC,YAAY,CAAC,EAAE,CAAC;IAC3C,yGAAyG;IACzG,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,qGAAqG;IACrG,aAAa,CAAC,EAAE,cAAc,CAAC;IAC/B,2KAA2K;IAC3K,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB,wBAcA;AAED;;GAEG;AACH,iBAAe,QAAQ,CAAC,MAAM,EAAE,MAAM,iBASrC;AAED,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC"}

package/dist/main.js

@@ -10,6 +10,9 @@ const bots = [];
 function log(text) {
     logger_1.Logger.logWithTraceId('ALL BOTS', 'System:Bot', 'System', text);
 }
+/**
+ * Starts bot
+ */
 async function startBot(options) {
     const token = await (0, promises_1.readFile)(options.tokenFilePath, 'utf8');
     const bot = new botInstance_1.BotInstance({
@@ -24,12 +27,15 @@ async function startBot(options) {
     bots.push(bot);
     return bot;
 }
+/**
+ * Terminates all scheduled tasks, closes storage connections and stops all bots.
+ */
 async function stopBots(reason) {
     log(`Recieved termination code: ${reason}`);
     taskScheduler_1.Scheduler.stopAll();
     log('Acquiring storage semaphore...');
     log('Stopping bots...');
     for (const bot of bots) {
-        bot.stop(reason);
+        await bot.stop(reason);
     }
 }

package/dist/services/taskScheduler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"taskScheduler.d.ts","sourceRoot":"","sources":["../../services/taskScheduler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEpD,OAAO,EAAE,YAAY,EAAW,MAAM,qBAAqB,CAAC;AAG5D,cAAM,aAAa;IACf,WAAW,EAAE,UAAU,EAAE,CAAM;IAE/B,OAAO;IAMP,UAAU,CACN,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,IAAI,EAClB,QAAQ,EAAE,YAAY,EACtB,gBAAgB,EAAE,OAAO,EACzB,SAAS,EAAE,MAAM;IAoBrB,iBAAiB,CACb,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,IAAI,EAClB,KAAK,EAAE,YAAY,EACnB,SAAS,EAAE,MAAM;CAoBxB;AAED,eAAO,MAAM,SAAS,eAAsB,CAAC"}
+{"version":3,"file":"taskScheduler.d.ts","sourceRoot":"","sources":["../../services/taskScheduler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAGnD,cAAM,aAAa;IACf,WAAW,EAAE,UAAU,EAAE,CAAM;IAE/B,OAAO;IAMP,UAAU,CACN,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,IAAI,EAClB,QAAQ,EAAE,YAAY,EACtB,gBAAgB,EAAE,OAAO,EACzB,SAAS,EAAE,MAAM;IAoBrB,iBAAiB,CACb,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,IAAI,EAClB,KAAK,EAAE,YAAY,EACnB,SAAS,EAAE,MAAM;CAoBxB;AAED,eAAO,MAAM,SAAS,eAAsB,CAAC"}

package/dist/services/taskScheduler.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Scheduler = void 0;
 const taskRecord_1 = require("../entities/taskRecord");
-const timeConvertions_1 = require("../helpers/timeConvertions");
 const logger_1 = require("./logger");
 class TaskScheduler {
     constructor() {
@@ -18,7 +17,7 @@ class TaskScheduler {
         const taskId = setInterval(action, interval);
         const task = new taskRecord_1.TaskRecord(name, taskId, interval);
         if (executeRightAway) {
-            setTimeout(action, (0, timeConvertions_1.secondsToMilliseconds)(1));
+            setImmediate(action);
         }
         logger_1.Logger.logWithTraceId(ownerName, `System:TaskScheduler-${ownerName}-${name}`, 'System', `Created task [${taskId}]${name}, that will run every ${interval}ms.`);
         this.activeTasks.push(task);

package/dist/services/telegramApi.d.ts

@@ -9,21 +9,24 @@ import { TextMessage } from '../entities/responses/textMessage';
 import { VideoMessage } from '../entities/responses/videoMessage';
 import { ImageMessage } from '../entities/responses/imageMessage';
 import { Telegram } from 'telegraf/typings/telegram';
+import { ScheduledAction } from '../entities/actions/scheduledAction';
+import { IActionState } from '../types/actionState';
+import { CommandAction } from '../entities/actions/commandAction';
 export declare class TelegramApiService {
     isFlushing: boolean;
     messageQueue: Array<BotResponse>;
     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>);
+    constructor(botName: string, telegram: Telegram, storage: IStorageClient, chats: Record<string, number>);
     flushResponses(): Promise<void>;
     private pinIfShould;
     private processResponse;
     private enqueue;
     private getInteractions;
-    createContextForMessage(incomingMessage: IncomingMessage, commandKey: string): MessageContext<import("..").IActionState>;
-    createContextForChat(chatId: number, scheduledKey: string): ChatContext;
+    createContextForMessage<TActionState extends IActionState>(incomingMessage: IncomingMessage, command: CommandAction<TActionState>): MessageContext<TActionState>;
+    createContextForChat<TActionState extends IActionState>(chatId: number, scheduledAction: ScheduledAction<TActionState>): ChatContext<TActionState>;
 }
 export interface IBotApiInteractions {
     respond: (response: TextMessage | VideoMessage | ImageMessage) => void;

package/dist/services/telegramApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"telegramApi.d.ts","sourceRoot":"","sources":["../../services/telegramApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAEpE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAiB,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAIrD,qBAAa,kBAAkB;IAC3B,UAAU,UAAS;IACnB,YAAY,EAAE,KAAK,CAAC,WAAW,CAAC,CAAM;IAEtC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3B,OAAO,EAAE,cAAc,CAAC;gBAGpB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,cAAc,EACvB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IAQxB,cAAc;YAyBN,WAAW;YAqBX,eAAe;IA2E7B,OAAO,CAAC,OAAO;IAIf,OAAO,CAAC,eAAe;IAQvB,uBAAuB,CACnB,eAAe,EAAE,eAAe,EAChC,UAAU,EAAE,MAAM;IAsBtB,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;CAW5D;AAED,MAAM,WAAW,mBAAmB;IAChC,OAAO,EAAE,CAAC,QAAQ,EAAE,WAAW,GAAG,YAAY,GAAG,YAAY,KAAK,IAAI,CAAC;IACvE,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IACpC,KAAK,EAAE,CAAC,YAAY,EAAE,aAAa,KAAK,IAAI,CAAC;CAChD"}
+{"version":3,"file":"telegramApi.d.ts","sourceRoot":"","sources":["../../services/telegramApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAEpE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAiB,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAGrD,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AACtE,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAElE,qBAAa,kBAAkB;IAC3B,UAAU,UAAS;IACnB,YAAY,EAAE,KAAK,CAAC,WAAW,CAAC,CAAM;IAEtC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,OAAO,EAAE,cAAc,CAAC;gBAGpB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,cAAc,EACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAQ3B,cAAc;YA2BN,WAAW;YAqBX,eAAe;IA2E7B,OAAO,CAAC,OAAO;IAIf,OAAO,CAAC,eAAe;IAQvB,uBAAuB,CAAC,YAAY,SAAS,YAAY,EACrD,eAAe,EAAE,eAAe,EAChC,OAAO,EAAE,aAAa,CAAC,YAAY,CAAC;IAsBxC,oBAAoB,CAAC,YAAY,SAAS,YAAY,EAClD,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,eAAe,CAAC,YAAY,CAAC;CAYrD;AAED,MAAM,WAAW,mBAAmB;IAChC,OAAO,EAAE,CAAC,QAAQ,EAAE,WAAW,GAAG,YAAY,GAAG,YAAY,KAAK,IAAI,CAAC;IACvE,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IACpC,KAAK,EAAE,CAAC,YAAY,EAAE,aAAa,KAAK,IAAI,CAAC;CAChD"}

package/dist/services/telegramApi.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TelegramApiService = void 0;
 const chatContext_1 = require("../entities/context/chatContext");
 const messageContext_1 = require("../entities/context/messageContext");
-const reverseMap_1 = require("../helpers/reverseMap");
+const reverseRecord_1 = require("../helpers/reverseRecord");
 const logger_1 = require("./logger");
 const promises_1 = require("timers/promises");
 class TelegramApiService {
@@ -12,12 +12,13 @@ class TelegramApiService {
         this.messageQueue = [];
         this.telegram = telegram;
         this.botName = botName;
-        this.chats = (0, reverseMap_1.reverseMap)(chats);
+        this.chats = (0, reverseRecord_1.reverseRecord)(chats);
         this.storage = storage;
     }
     async flushResponses() {
         if (this.isFlushing)
             return;
+        this.isFlushing = true;
         while (this.messageQueue.length) {
             const message = this.messageQueue.pop();
             if (!message)
@@ -27,7 +28,7 @@ class TelegramApiService {
                 await (0, promises_1.setTimeout)(100);
             }
             catch (error) {
-                logger_1.Logger.errorWithTraceId(this.botName, message.traceId, this.chats.get(message.chatId), error, message);
+                logger_1.Logger.errorWithTraceId(this.botName, message.traceId, this.chats[message.chatId], error, message);
             }
         }
         this.isFlushing = false;
@@ -92,15 +93,15 @@ class TelegramApiService {
             unpin: (unpinMessage) => this.enqueue(unpinMessage)
         };
     }
-    createContextForMessage(incomingMessage, commandKey) {
+    createContextForMessage(incomingMessage, command) {
         const firstName = incomingMessage.from?.first_name ?? 'Unknown user';
         const lastName = incomingMessage.from?.last_name
             ? ` ${incomingMessage.from?.last_name}`
             : '';
-        return new messageContext_1.MessageContext(this.botName, commandKey, this.getInteractions(), incomingMessage.chat.id, incomingMessage.chatName, incomingMessage.message_id, incomingMessage.text, incomingMessage.from?.id, incomingMessage.traceId, firstName + lastName, this.storage);
+        return new messageContext_1.MessageContext(this.botName, command.key, this.getInteractions(), incomingMessage.chat.id, incomingMessage.chatName, incomingMessage.message_id, incomingMessage.text, incomingMessage.from?.id, incomingMessage.traceId, firstName + lastName, this.storage);
     }
-    createContextForChat(chatId, scheduledKey) {
-        return new chatContext_1.ChatContext(this.botName, scheduledKey, this.getInteractions(), chatId, this.chats.get(chatId), `Scheduled:${scheduledKey}:${chatId}`, this.storage);
+    createContextForChat(chatId, scheduledAction) {
+        return new chatContext_1.ChatContext(this.botName, scheduledAction.key, this.getInteractions(), chatId, this.chats[chatId], `Scheduled:${scheduledAction.key}:${chatId}`, this.storage);
     }
 }
 exports.TelegramApiService = TelegramApiService;

package/dist/types/handlers.d.ts

@@ -2,6 +2,16 @@ import { ChatContext } from '../entities/context/chatContext';
 import { MessageContext } from '../entities/context/messageContext';
 import { IActionState } from './actionState';
 import { CachedValueAccessor } from './cachedValueAccessor';
-export type CommandHandler<TActionState extends IActionState> = (ctx: MessageContext<TActionState>, state: TActionState) => Promise<void>;
-export type ScheduledHandler<TActionState extends IActionState> = (ctx: ChatContext, getCached: CachedValueAccessor, state: TActionState) => Promise<void>;
+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<TActionState>, 
+/** 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>;
 //# sourceMappingURL=handlers.d.ts.map

package/dist/types/handlers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handlers.d.ts","sourceRoot":"","sources":["../../types/handlers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,MAAM,MAAM,cAAc,CAAC,YAAY,SAAS,YAAY,IAAI,CAC5D,GAAG,EAAE,cAAc,CAAC,YAAY,CAAC,EACjC,KAAK,EAAE,YAAY,KAClB,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB,MAAM,MAAM,gBAAgB,CAAC,YAAY,SAAS,YAAY,IAAI,CAC9D,GAAG,EAAE,WAAW,EAChB,SAAS,EAAE,mBAAmB,EAC9B,KAAK,EAAE,YAAY,KAClB,OAAO,CAAC,IAAI,CAAC,CAAC"}
+{"version":3,"file":"handlers.d.ts","sourceRoot":"","sources":["../../types/handlers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,MAAM,MAAM,cAAc,CAAC,YAAY,SAAS,YAAY,IAAI;AAC5D,oEAAoE;AACpE,GAAG,EAAE,cAAc,CAAC,YAAY,CAAC;AACjC,yCAAyC;AACzC,KAAK,EAAE,YAAY,KAClB,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB,MAAM,MAAM,gBAAgB,CAAC,YAAY,SAAS,YAAY,IAAI;AAC9D,0CAA0C;AAC1C,GAAG,EAAE,WAAW,CAAC,YAAY,CAAC;AAC9B,yIAAyI;AACzI,SAAS,EAAE,mBAAmB;AAC9B,yCAAyC;AACzC,KAAK,EAAE,YAAY,KAClB,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/entities/actions/scheduledAction.ts

@@ -46,7 +46,7 @@ export class ScheduledAction<TActionState extends IActionState>
         this.stateConstructor = stateConstructor;
     }
 
-    async exec(ctx: ChatContext) {
+    async exec(ctx: ChatContext<TActionState>) {
         if (!this.active || !this.chatsWhitelist.includes(ctx.chatId)) return;
 
         const state = await ctx.storage.getActionState<TActionState>(
@@ -72,6 +72,7 @@ export class ScheduledAction<TActionState extends IActionState>
 
             state.lastExecutedDate = moment().valueOf();
 
+            ctx.updateActions.forEach((action) => action(state));
             await ctx.storage.saveActionExecutionResult(
                 this,
                 ctx.chatId,

package/entities/botInstance.ts

@@ -1,6 +1,6 @@
 import { Telegraf } from 'telegraf';
 import { hoursToMilliseconds } from '../helpers/timeConvertions';
-import { Hours } from '../types/timeValues';
+import { Hours, Milliseconds } from '../types/timeValues';
 import { IStorageClient } from '../types/storage';
 import { JsonFileStorage } from '../services/jsonFileStorage';
 import { TelegramApiService } from '../services/telegramApi';
@@ -10,6 +10,7 @@ import { ScheduledAction } from './actions/scheduledAction';
 import { Logger } from '../services/logger';
 import { Scheduler } from '../services/taskScheduler';
 import { IncomingMessage } from './incomingMessage';
+import moment from 'moment';
 
 export class BotInstance {
     name: string;
@@ -17,7 +18,7 @@ export class BotInstance {
     private telegraf: Telegraf;
     private commands: CommandAction<IActionState>[];
     private scheduled: ScheduledAction<IActionState>[];
-    private chats: Map<string, number>;
+    private chats: Record<string, number>;
     storage: IStorageClient;
 
     constructor(options: {
@@ -25,7 +26,7 @@ export class BotInstance {
         token: string;
         commands: CommandAction<IActionState>[];
         scheduled: ScheduledAction<IActionState>[];
-        chats: Map<string, number>;
+        chats: Record<string, number>;
         storageClient?: IStorageClient;
         storagePath?: string;
     }) {
@@ -64,13 +65,44 @@ export class BotInstance {
 
     private initializeScheduledProcessing() {
         if (this.scheduled.length > 0) {
-            Scheduler.createTask(
-                'ScheduledProcessing',
+            const now = moment();
+
+            let nextExecutionTime = now.clone().startOf('hour');
+
+            if (now.minute() == 0 && now.second() == 0) {
+                Scheduler.createTask(
+                    'ScheduledProcessing',
+                    async () => {
+                        await this.runScheduled();
+                    },
+                    hoursToMilliseconds(1 as Hours),
+                    true,
+                    this.name
+                );
+
+                return;
+            }
+
+            if (now.minute() > 0 || now.second() > 0) {
+                nextExecutionTime = nextExecutionTime.add(1, 'hour');
+            }
+
+            const delay = nextExecutionTime.diff(now);
+
+            Scheduler.createOnetimeTask(
+                'ScheduledProcessing_OneTime',
                 async () => {
-                    await this.runScheduled();
+                    Scheduler.createTask(
+                        'ScheduledProcessing',
+                        async () => {
+                            await this.runScheduled();
+                        },
+                        hoursToMilliseconds(1 as Hours),
+                        true,
+                        this.name
+                    );
                 },
-                hoursToMilliseconds(0.5 as Hours),
-                true,
+                delay as Milliseconds,
                 this.name
             );
         }
@@ -111,12 +143,15 @@ export class BotInstance {
     }
 
     private async runScheduled() {
-        for (const [chatName, chatId] of this.chats.entries()) {
-            for (const trig of this.scheduled) {
-                const ctx = this.api.createContextForChat(chatId, trig.key);
+        for (const [chatName, chatId] of Object.entries(this.chats)) {
+            for (const scheduledAction of this.scheduled) {
+                const ctx = this.api.createContextForChat(
+                    chatId,
+                    scheduledAction
+                );
 
                 try {
-                    await trig.exec(ctx);
+                    await scheduledAction.exec(ctx);
                 } catch (error) {
                     Logger.errorWithTraceId(
                         ctx.botName,
@@ -129,15 +164,15 @@ export class BotInstance {
             }
         }
 
-        this.api.flushResponses();
+        await this.api.flushResponses();
     }
 
     private async processMessage(msg: IncomingMessage) {
-        for (const cmd of this.commands) {
-            const ctx = this.api.createContextForMessage(msg, cmd.key);
+        for (const commandAction of this.commands) {
+            const ctx = this.api.createContextForMessage(msg, commandAction);
 
             try {
-                await cmd.exec(ctx);
+                await commandAction.exec(ctx);
             } catch (error) {
                 Logger.errorWithTraceId(
                     ctx.botName,
@@ -149,6 +184,6 @@ export class BotInstance {
             }
         }
 
-        this.api.flushResponses();
+        await this.api.flushResponses();
     }
 }

package/entities/context/chatContext.ts

@@ -10,13 +10,22 @@ import {
     TextMessageSendingOptions
 } from '../../types/messageSendingOptions';
 
-export class ChatContext {
+/**
+ * Context of action executed in chat.
+ */
+export class ChatContext<TActionState> {
+    protected actionKey: string;
+    protected interactions: IBotApiInteractions;
+    updateActions: Array<(state: TActionState) => void> = [];
+    /** Trace id of a action execution. */
+    traceId: number | string;
+    /** Name of a bot that executes this action. */
     botName: string;
-    actionKey: string;
-    interactions: IBotApiInteractions;
+    /** Id of a chat that action is executed in. */
     chatId: number;
+    /** Name of a chat that action is executed in. */
     chatName: string;
-    traceId: number | string;
+    /** Storage client instance for this bot. */
     storage: IStorageClient;
 
     constructor(
@@ -37,6 +46,21 @@ export class ChatContext {
         this.storage = storage;
     }
 
+    /**
+     * Manually update the state of an action.
+     * @param stateUpdateAction Function that will modify state.
+     */
+    updateState(stateUpdateAction: (state: TActionState) => void) {
+        this.updateActions.push(
+            stateUpdateAction as (state: TActionState) => void
+        );
+    }
+
+    /**
+     * Sends text message to chat.
+     * @param text Message contents.
+     * @param options Message sending option.
+     */
     sendTextToChat(text: string, options?: TextMessageSendingOptions) {
         this.interactions.respond(
             new TextMessage(
@@ -50,6 +74,11 @@ export class ChatContext {
         );
     }
 
+    /**
+     * Sends image message to chat.
+     * @param name Message contents.
+     * @param options Message sending option.
+     */
     sendImageToChat(name: string, options?: MessageSendingOptions) {
         const filePath = `./content/${name}.png`;
         this.interactions.respond(
@@ -64,6 +93,11 @@ export class ChatContext {
         );
     }
 
+    /**
+     * Sends video/gif message to chat.
+     * @param name Message contents.
+     * @param options Message sending option.
+     */
     sendVideoToChat(name: string, options?: MessageSendingOptions) {
         const filePath = `./content/${name}.mp4`;
         this.interactions.respond(
@@ -78,6 +112,10 @@ export class ChatContext {
         );
     }
 
+    /**
+     * Unpins message.
+     * @param messageId Message id.
+     */
     unpinMessage(messageId: number) {
         this.interactions.unpin(
             new UnpinResponse(

package/entities/context/messageContext.ts

@@ -14,15 +14,23 @@ import {
     TextMessageSendingOptions
 } from '../../types/messageSendingOptions';
 
+/**
+ * Context of action executed in chat, in response to a message
+ */
 export class MessageContext<
     TActionState extends IActionState
-> extends ChatContext {
+> extends ChatContext<TActionState> {
+    /** Id of a message that triggered this action. */
     messageId: number;
+    /** Text of a message that triggered this action. */
     messageText: string;
+    /** Collection of Regexp match results on a message that triggered this action. Will be empty if trigger is not a Regexp. */
     matchResults: RegExpMatchArray[] = [];
+    /** Id of a user that sent a message that triggered this action. */
     fromUserId: number | undefined;
+    /** Indicates if cooldown should be started after action is executed. Set to `true` by default. */
     startCooldown: boolean = true;
-    updateActions: Array<(state: TActionState) => void> = [];
+    /** Name of a user that sent a message that triggered this action. */
     fromUserName: string;
 
     constructor(
@@ -54,6 +62,11 @@ export class MessageContext<
         this.fromUserName = fromUserName;
     }
 
+    /**
+     * Loads state of another action. Changes to the loaded state will no affect actual state of other action.
+     * @param commandName Name of an action to load state of.
+     * @template TAnotherActionState - Type of a state that is used by another action.
+     */
     async loadStateOf<TAnotherActionState extends IActionState>(
         commandName: string
     ): Promise<TAnotherActionState> {
@@ -66,12 +79,11 @@ export class MessageContext<
         );
     }
 
-    updateState(stateUpdateAction: (state: TActionState) => void) {
-        this.updateActions.push(
-            stateUpdateAction as (state: TActionState) => void
-        );
-    }
-
+    /**
+     * Reply with text message to message that triggered this action.
+     * @param text Message contents.
+     * @param options Message sending option.
+     */
     replyWithText(text: string, options?: TextMessageSendingOptions) {
         this.interactions.respond(
             new TextMessage(
@@ -85,6 +97,11 @@ export class MessageContext<
         );
     }
 
+    /**
+     * Reply with image message to message that triggered this action.
+     * @param text Message contents.
+     * @param options Message sending option.
+     */
     replyWithImage(name: string, options?: MessageSendingOptions) {
         const filePath = `./content/${name}.png`;
         this.interactions.respond(
@@ -99,6 +116,11 @@ export class MessageContext<
         );
     }
 
+    /**
+     * Reply with video/gif message to message that triggered this action.
+     * @param text Message contents.
+     * @param options Message sending option.
+     */
     replyWithVideo(name: string, options?: MessageSendingOptions) {
         const filePath = `./content/${name}.mp4`;
         this.interactions.respond(
@@ -113,6 +135,10 @@ export class MessageContext<
         );
     }
 
+    /**
+     * React to the message that triggered this action.
+     * @param emoji Telegram emoji to react with.
+     */
     react(emoji: TelegramEmoji) {
         this.interactions.react(
             new Reaction(