chz-telegram-bot 0.3.14 → 0.3.16

package/index.ts

@@ -1,13 +1,17 @@
-export { botOrchestrator } from './main';
-export { InlineQueryActionBuilder } from './helpers/builders/inlineQueryActionBuilder';
-export { CommandActionBuilder } from './helpers/builders/commandActionBuilder';
-export { CommandActionBuilderWithState } from './helpers/builders/commandActionBuilder';
-export { IStorageClient } from './types/storage';
-export { ILogger } from './types/logger';
-export { IScheduler } from './types/scheduler';
+export * from './main';
+export * from './helpers/builders/inlineQueryActionBuilder';
+export * from './helpers/builders/commandActionBuilder';
 export * from './helpers/builders/scheduledActionBuilder';
 export * from './types/actionState';
 export * from './entities/states/actionStateBase';
+export * from './types/messageTypes';
+export * from './helpers/timeConvertions';
+export { CommandAction } from './entities/actions/commandAction';
+export { InlineQueryAction } from './entities/actions/inlineQueryAction';
+export { ReplyCaptureAction } from './entities/actions/replyCaptureAction';
+export { ScheduledAction } from './entities/actions/scheduledAction';
 export { Hours, Milliseconds, Seconds } from './types/timeValues';
-export { MessageType } from './types/messageTypes';
-export { TraceId } from './types/trace';
+export { ChatContext } from './entities/context/chatContext';
+export { InlineQueryContext } from './entities/context/inlineQueryContext';
+export { MessageContext } from './entities/context/messageContext';
+export { ReplyContext } from './entities/context/replyContext';

package/package.json

@@ -1,6 +1,20 @@
 {
     "name": "chz-telegram-bot",
-    "version": "0.3.14",
+    "description": "Opinionated TypeScript framework that provides a structured approach to building Telegram bots.",
+    "author": {
+        "name": "Alex Halanin",
+        "url": "https://github.com/AlexSolari"
+    },
+    "license": "MIT",
+    "keywords": [
+        "telegram",
+        "telegram bot"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/AlexSolari/botFramework.git"
+    },
+    "version": "0.3.16",
     "type": "module",
     "dependencies": {
         "async-sema": "^3.1.1",

package/services/actionProcessors/baseProcessor.ts

@@ -3,7 +3,7 @@ import { IScheduler } from '../../types/scheduler';
 import { IStorageClient } from '../../types/storage';
 import { TelegramApiService } from '../telegramApi';
 import { IAction } from '../../types/action';
-import { BaseContext } from '../../entities/context/baseContext';
+import { BaseContextInternal } from '../../entities/context/baseContext';
 
 export abstract class BaseActionProcessor {
     protected readonly storage: IStorageClient;
@@ -29,7 +29,7 @@ export abstract class BaseActionProcessor {
 
     private defaultErrorHandler<TAction extends IAction>(
         error: Error,
-        ctx: BaseContext<TAction>
+        ctx: BaseContextInternal<TAction>
     ) {
         ctx.logger.errorWithTraceId(error, ctx);
     }
@@ -40,7 +40,7 @@ export abstract class BaseActionProcessor {
 
     async executeAction<
         TAction extends IAction,
-        TActionContext extends BaseContext<TAction>
+        TActionContext extends BaseContextInternal<TAction>
     >(
         action: TAction,
         ctx: TActionContext,

package/services/actionProcessors/commandActionProcessor.ts

@@ -2,8 +2,8 @@ import { Telegraf } from 'telegraf';
 import { IncomingMessage } from '../../dtos/incomingMessage';
 import { CommandAction } from '../../entities/actions/commandAction';
 import { ReplyCaptureAction } from '../../entities/actions/replyCaptureAction';
-import { MessageContext } from '../../entities/context/messageContext';
-import { ReplyContext } from '../../entities/context/replyContext';
+import { MessageContextInternal } from '../../entities/context/messageContext';
+import { ReplyContextInternal } from '../../entities/context/replyContext';
 import { IActionState } from '../../types/actionState';
 import { TelegramApiService } from '../telegramApi';
 import { IReplyCapture } from '../../types/capture';
@@ -16,10 +16,16 @@ import {
 import { typeSafeObjectFromEntries } from '../../helpers/objectFromEntries';
 import { BaseActionProcessor } from './baseProcessor';
 import { UserFromGetMe } from 'telegraf/types';
+import { getOrSetIfNotExists } from '../../helpers/mapUtils';
+import { MessageInfo } from '../../dtos/messageInfo';
+import { UserInfo } from '../../dtos/userInfo';
+
+const MESSAGE_HISTORY_LENGTH_LIMIT = 100;
 
 export class CommandActionProcessor extends BaseActionProcessor {
     private readonly replyCaptures: ReplyCaptureAction<IActionState>[] = [];
     private botInfo!: UserFromGetMe;
+    private lastMessages = new Map<number, IncomingMessage[]>();
 
     private commands = typeSafeObjectFromEntries(
         Object.values(MessageType).map((x) => [
@@ -67,7 +73,8 @@ export class CommandActionProcessor extends BaseActionProcessor {
             telegraf.on('message', (ctx) => {
                 const msg = new IncomingMessage(
                     ctx.update.message,
-                    this.botName
+                    this.botName,
+                    getOrSetIfNotExists(this.lastMessages, ctx.chat.id, [])
                 );
 
                 const logger = this.logger.createScope(
@@ -127,7 +134,16 @@ export class CommandActionProcessor extends BaseActionProcessor {
         });
     }
     private async processMessage(msg: IncomingMessage) {
-        const ctx = new MessageContext<IActionState>(
+        const messageHistoryArray = getOrSetIfNotExists(
+            this.lastMessages,
+            msg.chatInfo.id,
+            []
+        );
+        if (messageHistoryArray.length > MESSAGE_HISTORY_LENGTH_LIMIT)
+            messageHistoryArray.shift();
+        messageHistoryArray.push(msg);
+
+        const ctx = new MessageContextInternal<IActionState>(
             this.storage,
             this.scheduler
         );
@@ -145,7 +161,7 @@ export class CommandActionProcessor extends BaseActionProcessor {
         }
 
         if (this.replyCaptures.length != 0) {
-            const replyCtx = new ReplyContext<IActionState>(
+            const replyCtx = new ReplyContextInternal<IActionState>(
                 this.storage,
                 this.scheduler
             );
@@ -160,19 +176,22 @@ export class CommandActionProcessor extends BaseActionProcessor {
     }
 
     private initializeReplyCaptureContext(
-        ctx: ReplyContext<IActionState>,
+        ctx: ReplyContextInternal<IActionState>,
         action: ReplyCaptureAction<IActionState>,
         message: IncomingMessage
     ) {
         ctx.replyMessageId = message.replyToMessageId;
-        ctx.messageId = message.messageId;
-        ctx.messageText = message.text;
-        ctx.messageType = message.type;
-        ctx.fromUserId = message.from?.id;
-        ctx.fromUserName =
+        ctx.messageInfo = new MessageInfo(
+            message.messageId,
+            message.text,
+            message.type,
+            message.updateObject
+        );
+        ctx.userInfo = new UserInfo(
+            message.from?.id ?? -1,
             (message.from?.first_name ?? 'Unknown user') +
-            (message.from?.last_name ? ` ${message.from.last_name}` : '');
-        ctx.messageUpdateObject = message.updateObject;
+                (message.from?.last_name ? ` ${message.from.last_name}` : '')
+        );
         ctx.botName = this.botName;
         ctx.action = action;
         ctx.chatInfo = message.chatInfo;
@@ -190,18 +209,21 @@ export class CommandActionProcessor extends BaseActionProcessor {
     }
 
     private initializeMessageContext(
-        ctx: MessageContext<IActionState>,
+        ctx: MessageContextInternal<IActionState>,
         action: CommandAction<IActionState>,
         message: IncomingMessage
     ) {
-        ctx.messageId = message.messageId;
-        ctx.messageText = message.text;
-        ctx.messageType = message.type;
-        ctx.fromUserId = message.from?.id;
-        ctx.fromUserName =
+        ctx.messageInfo = new MessageInfo(
+            message.messageId,
+            message.text,
+            message.type,
+            message.updateObject
+        );
+        ctx.userInfo = new UserInfo(
+            message.from?.id ?? -1,
             (message.from?.first_name ?? 'Unknown user') +
-            (message.from?.last_name ? ` ${message.from.last_name}` : '');
-        ctx.messageUpdateObject = message.updateObject;
+                (message.from?.last_name ? ` ${message.from.last_name}` : '')
+        );
 
         ctx.matchResults = [];
         ctx.startCooldown = true;

package/services/actionProcessors/inlineQueryActionProcessor.ts

@@ -1,7 +1,7 @@
 import { Telegraf } from 'telegraf';
 import { IncomingInlineQuery } from '../../dtos/incomingQuery';
 import { InlineQueryAction } from '../../entities/actions/inlineQueryAction';
-import { InlineQueryContext } from '../../entities/context/inlineQueryContext';
+import { InlineQueryContextInternal } from '../../entities/context/inlineQueryContext';
 import { createTrace } from '../../helpers/traceFactory';
 import { Milliseconds } from '../../types/timeValues';
 import { TraceId } from '../../types/trace';
@@ -67,7 +67,7 @@ export class InlineQueryActionProcessor extends BaseActionProcessor {
             this.scheduler.createTask(
                 'InlineQueryProcessing',
                 async () => {
-                    const ctx = new InlineQueryContext(
+                    const ctx = new InlineQueryContextInternal(
                         this.storage,
                         this.scheduler
                     );
@@ -119,7 +119,7 @@ export class InlineQueryActionProcessor extends BaseActionProcessor {
     }
 
     private initializeInlineQueryContext(
-        ctx: InlineQueryContext,
+        ctx: InlineQueryContextInternal,
         queryText: string,
         queryId: string,
         action: InlineQueryAction,

package/services/actionProcessors/scheduledActionProcessor.ts

@@ -1,7 +1,7 @@
 import moment from 'moment';
 import { ChatInfo } from '../../dtos/chatInfo';
 import { ScheduledAction } from '../../entities/actions/scheduledAction';
-import { ChatContext } from '../../entities/context/chatContext';
+import { ChatContextInternal } from '../../entities/context/chatContext';
 import { secondsToMilliseconds } from '../../helpers/timeConvertions';
 import { createTrace } from '../../helpers/traceFactory';
 import { IActionState } from '../../types/actionState';
@@ -81,14 +81,17 @@ export class ScheduledActionProcessor extends BaseActionProcessor {
     }
 
     private async runScheduled() {
-        const ctx = new ChatContext<IActionState>(this.storage, this.scheduler);
+        const ctx = new ChatContextInternal<IActionState>(
+            this.storage,
+            this.scheduler
+        );
 
         for (const [chatName, chatId] of Object.entries(this.chats)) {
             for (const scheduledAction of this.scheduled) {
                 this.initializeChatContext(
                     ctx,
                     scheduledAction,
-                    new ChatInfo(chatId, chatName),
+                    new ChatInfo(chatId, chatName, []),
                     createTrace(
                         scheduledAction,
                         this.botName,
@@ -104,7 +107,7 @@ export class ScheduledActionProcessor extends BaseActionProcessor {
     }
 
     private initializeChatContext(
-        ctx: ChatContext<IActionState>,
+        ctx: ChatContextInternal<IActionState>,
         action: ScheduledAction<IActionState>,
         chatInfo: ChatInfo,
         traceId: TraceId

package/types/action.ts

@@ -1,4 +1,4 @@
-import { BaseContext } from '../entities/context/baseContext';
+import { BaseContextInternal } from '../entities/context/baseContext';
 import { IActionState } from './actionState';
 import { BotResponse } from './response';
 
@@ -11,5 +11,5 @@ export interface IActionWithState<TActionState extends IActionState>
 
 export interface IAction {
     readonly key: ActionKey;
-    exec(ctx: BaseContext<IAction>): Promise<BotResponse[]>;
+    exec(ctx: BaseContextInternal<IAction>): Promise<BotResponse[]>;
 }

package/types/capture.ts

@@ -1,4 +1,4 @@
-import { ReplyContext } from '../entities/context/replyContext';
+import { ReplyContextInternal } from '../entities/context/replyContext';
 import { IActionState } from './actionState';
 import { CommandTrigger } from './commandTrigger';
 import { IActionWithState } from './action';
@@ -13,7 +13,7 @@ export interface ICaptureController {
         trigger: CommandTrigger[],
         /** Callback that will be called on trigger */
         handler: (
-            replyContext: ReplyContext<TParentActionState>
+            replyContext: ReplyContextInternal<TParentActionState>
         ) => Promise<void>,
         /** Abort controller to abort capturing manually */
         abortController: AbortController
@@ -22,7 +22,9 @@ export interface ICaptureController {
 
 export interface IReplyCapture {
     trigger: CommandTrigger[];
-    handler: (replyContext: ReplyContext<IActionState>) => Promise<void>;
+    handler: (
+        replyContext: ReplyContextInternal<IActionState>
+    ) => Promise<void>;
     abortController: AbortController;
     action: IActionWithState<IActionState>;
 }