chz-telegram-bot 0.1.19 → 0.2.0

package/entities/context/messageContext.ts

@@ -8,18 +8,18 @@ import { TextMessage } from '../../dtos/responses/textMessage';
 import { VideoMessage } from '../../dtos/responses/videoMessage';
 import { ActionStateBase } from '../states/actionStateBase';
 import { ChatContext } from './chatContext';
-import { IncomingMessage } from '../../dtos/incomingMessage';
 import {
     MessageSendingOptions,
     TextMessageSendingOptions
 } from '../../types/messageSendingOptions';
-import { IActionWithState, ActionKey } from '../../types/statefulAction';
+import { ActionKey } from '../../types/statefulAction';
 import {
     MessageTypeValue,
     TelegrafContextMessage
 } from '../../types/messageTypes';
 import { ILogger } from '../../types/logger';
 import { IScheduler } from '../../types/scheduler';
+import { ReplyInfo } from '../../types/replyInfo';
 /**
  * Context of action executed in chat, in response to a message
  */
@@ -51,126 +51,171 @@ export class MessageContext<
         super(storage, logger, scheduler);
     }
 
-    initializeMessageContext(
-        botName: string,
-        action: IActionWithState<TActionState>,
-        message: IncomingMessage
+    private replyWithText(
+        text: string,
+        quote: boolean,
+        options?: TextMessageSendingOptions
     ) {
-        this.messageId = message.message_id;
-        this.messageText = message.text ?? '';
-        this.messageType = message.type;
-        this.fromUserId = message.from?.id;
-        this.fromUserName =
-            (message.from?.first_name ?? 'Unknown user') +
-            (message.from?.last_name ? ` ${message.from.last_name}` : '');
-        this.messageUpdateObject = message.updateObject;
+        const quotedPart =
+            this.matchResults.length != 0
+                ? this.matchResults[0][1]
+                : this.messageText;
 
-        this.matchResults = [];
-        this.startCooldown = true;
-
-        return this.initializeChatContext(
-            botName,
-            action,
-            message.chatInfo,
-            message.traceId
-        );
-    }
-
-    /**
-     * 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> {
-        const storageKey = `command:${commandName.replace(
-            '.',
-            '-'
-        )}` as ActionKey;
-        const allStates = await this.storage.load(storageKey);
-        const stateForChat = allStates[this.chatInfo.id];
-
-        if (!stateForChat) {
-            return new ActionStateBase() as TAnotherActionState;
-        }
-
-        return stateForChat as TAnotherActionState;
-    }
-
-    /**
-     * Reply with text message to message that triggered this action after action execution is finished.
-     * If multiple responses are sent, they will be sent in the order they were added, with delay of at least 35ms as per Telegram rate-limit.
-     * @param text Message contents.
-     * @param options Message sending option.
-     */
-    replyWithText(text: string, options?: TextMessageSendingOptions) {
         this.responses.push(
             new TextMessage(
                 text,
                 this.chatInfo,
-                this.messageId,
                 this.traceId,
                 this.action,
+                new ReplyInfo(this.messageId, quote ? quotedPart : undefined),
                 options
             )
         );
     }
 
-    /**
-     * Reply with image message to message that triggered this action after action execution is finished.
-     * If multiple responses are sent, they will be sent in the order they were added, with delay of at least 35ms as per Telegram rate-limit.
-     * @param text Message contents.
-     * @param options Message sending option.
-     */
-    replyWithImage(name: string, options?: MessageSendingOptions) {
-        const filePath = `./content/${name}.png`;
+    private replyWithImage(
+        name: string,
+        quote: boolean,
+        options?: MessageSendingOptions
+    ) {
+        const quotedPart =
+            this.matchResults.length != 0
+                ? this.matchResults[0][1]
+                : this.messageText;
+
         this.responses.push(
             new ImageMessage(
-                { source: resolve(filePath) },
+                { source: resolve(`./content/${name}.png`) },
                 this.chatInfo,
-                this.messageId,
                 this.traceId,
                 this.action,
+                new ReplyInfo(this.messageId, quote ? quotedPart : undefined),
                 options
             )
         );
     }
 
-    /**
-     * Reply with video/gif message to message that triggered this action after action execution is finished.
-     * If multiple responses are sent, they will be sent in the order they were added, with delay of at least 35ms as per Telegram rate-limit.
-     * @param text Message contents.
-     * @param options Message sending option.
-     */
-    replyWithVideo(name: string, options?: MessageSendingOptions) {
-        const filePath = `./content/${name}.mp4`;
+    private replyWithVideo(
+        name: string,
+        quote: boolean,
+        options?: MessageSendingOptions
+    ) {
+        const quotedPart =
+            this.matchResults.length != 0
+                ? this.matchResults[0][1]
+                : this.messageText;
+
         this.responses.push(
             new VideoMessage(
-                { source: resolve(filePath) },
+                { source: resolve(`./content/${name}.mp4`) },
                 this.chatInfo,
-                this.messageId,
                 this.traceId,
                 this.action,
+                new ReplyInfo(this.messageId, quote ? quotedPart : undefined),
                 options
             )
         );
     }
 
     /**
-     * React to the message that triggered this action after action execution is finished.
-     * If multiple responses are sent, they will be sent in the order they were added, with delay of at least 35ms as per Telegram rate-limit.
-     * @param emoji Telegram emoji to react with.
+     * 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.
      */
-    react(emoji: TelegramEmoji) {
-        this.responses.push(
-            new Reaction(
-                this.traceId,
-                this.chatInfo,
-                this.messageId,
-                emoji,
-                this.action
-            )
-        );
+    async loadStateOf<TAnotherActionState extends IActionState>(
+        commandName: string
+    ): Promise<TAnotherActionState> {
+        const storageKey = `command:${commandName.replace(
+            '.',
+            '-'
+        )}` as ActionKey;
+        const allStates = await this.storage.load(storageKey);
+        const stateForChat = allStates[this.chatInfo.id];
+
+        if (!stateForChat) {
+            return new ActionStateBase() as TAnotherActionState;
+        }
+
+        return stateForChat as TAnotherActionState;
     }
+
+    /**
+     * Collection of actions that can be done as a reply to a message that triggered this action
+     */
+    reply = {
+        /**
+         * Collection of actions that can be done as a reply to a message, quoting the part that triggered this action
+         * If regex is matched, first match will be quoted
+         */
+        andQuote: {
+            /**
+             * Reply with text message to message that triggered this action after action execution is finished.
+             * If multiple responses are sent, they will be sent in the order they were added, with delay of at least 35ms as per Telegram rate-limit.
+             * @param text Message contents.
+             * @param options Message sending option.
+             */
+            withText: (text: string, options?: TextMessageSendingOptions) =>
+                this.replyWithText(text, true, options),
+            /**
+             * Reply with image message to message that triggered this action after action execution is finished.
+             * If multiple responses are sent, they will be sent in the order they were added, with delay of at least 35ms as per Telegram rate-limit.
+             * @param text Message contents.
+             * @param options Message sending option.
+             */
+            withImage: (name: string, options?: MessageSendingOptions) =>
+                this.replyWithImage(name, true, options),
+
+            /**
+             * Reply with video/gif message to message that triggered this action after action execution is finished.
+             * If multiple responses are sent, they will be sent in the order they were added, with delay of at least 35ms as per Telegram rate-limit.
+             * @param text Message contents.
+             * @param options Message sending option.
+             */
+            withVideo: (name: string, options?: MessageSendingOptions) =>
+                this.replyWithVideo(name, true, options)
+        },
+
+        /**
+         * Reply with text message to message that triggered this action after action execution is finished.
+         * If multiple responses are sent, they will be sent in the order they were added, with delay of at least 35ms as per Telegram rate-limit.
+         * @param text Message contents.
+         * @param options Message sending option.
+         */
+        withText: (text: string, options?: TextMessageSendingOptions) =>
+            this.replyWithText(text, false, options),
+        /**
+         * Reply with image message to message that triggered this action after action execution is finished.
+         * If multiple responses are sent, they will be sent in the order they were added, with delay of at least 35ms as per Telegram rate-limit.
+         * @param text Message contents.
+         * @param options Message sending option.
+         */
+        withImage: (name: string, options?: MessageSendingOptions) =>
+            this.replyWithImage(name, false, options),
+
+        /**
+         * Reply with video/gif message to message that triggered this action after action execution is finished.
+         * If multiple responses are sent, they will be sent in the order they were added, with delay of at least 35ms as per Telegram rate-limit.
+         * @param text Message contents.
+         * @param options Message sending option.
+         */
+        withVideo: (name: string, options?: MessageSendingOptions) =>
+            this.replyWithVideo(name, false, options),
+
+        /**
+         * React to the message that triggered this action after action execution is finished.
+         * If multiple responses are sent, they will be sent in the order they were added, with delay of at least 35ms as per Telegram rate-limit.
+         * @param emoji Telegram emoji to react with.
+         */
+        withReaction: (emoji: TelegramEmoji) => {
+            this.responses.push(
+                new Reaction(
+                    this.traceId,
+                    this.chatInfo,
+                    this.messageId,
+                    emoji,
+                    this.action
+                )
+            );
+        }
+    };
 }

package/eslint.config.js

@@ -5,7 +5,6 @@ export default tseslint.config(
     eslint.configs.recommended,
     ...tseslint.configs.recommended,
     {
-        ignores: ['dist/*'],
         rules: {
             '@typescript-eslint/no-unused-vars': [
                 'error',

package/package.json

@@ -1,29 +1,30 @@
-{
-    "name": "chz-telegram-bot",
-    "version": "0.1.19",
-    "type": "module",
-    "dependencies": {
-        "async-sema": "^3.1.1",
-        "moment": "^2.29.4",
-        "telegraf": "^4.16.3"
-    },
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
-    "devDependencies": {
-        "@eslint/js": "^9.10.0",
-        "@types/markdown-escape": "^1.1.3",
-        "@types/node": "^22.5.5",
-        "eslint": "^9.10.0",
-        "typescript": "^5.6.2",
-        "typescript-eslint": "^8.5.0"
-    },
-    "scripts": {
-        "build": "tsc",
-        "lint": "npx eslint && tsc --noEmit"
-    },
-    "overrides": {
-        "telegraf": {
-            "node-fetch": "3.3.2"
-        }
-    }
-}
+{
+    "name": "chz-telegram-bot",
+    "version": "0.2.0",
+    "type": "module",
+    "dependencies": {
+        "async-sema": "^3.1.1",
+        "moment": "^2.29.4",
+        "telegraf": "^4.16.3"
+    },
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "devDependencies": {
+        "@eslint/js": "^9.29.0",
+        "@types/markdown-escape": "^1.1.3",
+        "@types/node": "^22.5.5",
+        "eslint": "^9.29.0",
+        "globals": "^16.2.0",
+        "typescript": "^5.6.2",
+        "typescript-eslint": "^8.34.1"
+    },
+    "scripts": {
+        "build": "tsc",
+        "lint": "npx eslint && tsc --noEmit"
+    },
+    "overrides": {
+        "telegraf": {
+            "node-fetch": "3.3.2"
+        }
+    }
+}

package/services/jsonFileStorage.ts

@@ -1,6 +1,5 @@
 import { existsSync, mkdirSync } from 'fs';
-import { dirname } from 'path';
-import { mkdir, readFile, writeFile } from 'fs/promises';
+import { readFile, writeFile } from 'fs/promises';
 import { Sema as Semaphore } from 'async-sema';
 import { IStorageClient } from '../types/storage';
 import { IActionState } from '../types/actionState';
@@ -51,11 +50,11 @@ export class JsonFileStorage implements IStorageClient {
     ) {
         if (!this.cache.has(key)) {
             const targetPath = this.buidPathFromKey(key);
-            if (!existsSync(targetPath)) {
-                return {};
-            }
 
-            const fileContent = await readFile(targetPath, 'utf8');
+            const fileContent = await readFile(targetPath, {
+                encoding: 'utf-8',
+                flag: 'a+'
+            });
 
             if (fileContent) {
                 const data = JSON.parse(fileContent);
@@ -74,11 +73,6 @@ export class JsonFileStorage implements IStorageClient {
         this.cache.set(key, data);
 
         const targetPath = this.buidPathFromKey(key);
-        const folderName = dirname(targetPath);
-
-        if (!existsSync(folderName)) {
-            await mkdir(folderName, { recursive: true });
-        }
 
         await writeFile(targetPath, JSON.stringify(data), { flag: 'w+' });
     }
@@ -92,7 +86,7 @@ export class JsonFileStorage implements IStorageClient {
 
     async load<TActionState extends IActionState>(key: ActionKey) {
         return await this.lock(key, async () => {
-            return this.loadInternal<TActionState>(key);
+            return await this.loadInternal<TActionState>(key);
         });
     }
 
@@ -128,7 +122,7 @@ export class JsonFileStorage implements IStorageClient {
         chatId: number,
         state: TActionState
     ) {
-        await this.lock(action.key, async () => {
+        return await this.lock(action.key, async () => {
             const data = await this.loadInternal<TActionState>(action.key);
 
             data[chatId] = state;

package/services/responseProcessingQueue.ts

@@ -37,10 +37,8 @@ export class ResponseProcessingQueue {
         this.isFlushing = true;
 
         while (this.items.length) {
-            if (Date.now() >= this.peek()!.priority) {
-                const item = this.items.shift();
-
-                if (!item) return;
+            if (Date.now() >= this.items[0].priority) {
+                const item = this.items.shift()!;
 
                 await item.callback();
             } else {
@@ -50,8 +48,4 @@ export class ResponseProcessingQueue {
 
         this.isFlushing = false;
     }
-
-    private peek() {
-        return this.items[0];
-    }
 }

package/services/telegramApi.ts

@@ -1,6 +1,6 @@
 import { Message } from 'telegraf/types';
 import { IStorageClient } from '../types/storage';
-import { BotResponse, IReplyMessage } from '../types/response';
+import { BotResponse, IReplyResponse } from '../types/response';
 import { Telegram } from 'telegraf/typings/telegram';
 import { ILogger } from '../types/logger';
 import { QueueItem, ResponseProcessingQueue } from './responseProcessingQueue';
@@ -60,7 +60,7 @@ export class TelegramApiService {
     }
 
     private async pinIfShould<T>(
-        response: IReplyMessage<T>,
+        response: IReplyResponse<T>,
         sentMessage: Message
     ) {
         if (response.shouldPin) {
@@ -89,7 +89,7 @@ export class TelegramApiService {
                     response.chatInfo.id,
                     response.content,
                     {
-                        reply_to_message_id: response.replyId,
+                        reply_to_message_id: response.replyInfo?.id,
                         parse_mode: 'MarkdownV2',
                         disable_web_page_preview: response.disableWebPreview
                         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -102,9 +102,10 @@ export class TelegramApiService {
                 sentMessage = await this.telegram.sendPhoto(
                     response.chatInfo.id,
                     response.content,
-                    response.replyId
-                        ? // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                          ({ reply_to_message_id: response.replyId } as any)
+                    response.replyInfo?.id
+                        ? ({
+                              reply_to_message_id: response.replyInfo?.id // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                          } as any)
                         : undefined
                 );
 
@@ -114,9 +115,10 @@ export class TelegramApiService {
                 sentMessage = await this.telegram.sendVideo(
                     response.chatInfo.id,
                     response.content,
-                    response.replyId
-                        ? // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                          ({ reply_to_message_id: response.replyId } as any)
+                    response.replyInfo?.id
+                        ? ({
+                              reply_to_message_id: response.replyInfo?.id // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                          } as any)
                         : undefined
                 );
 

package/types/messageTypes.ts

@@ -1,19 +1,21 @@
 import { Message, Update } from 'telegraf/types';
 
+export const INTERNAL_MESSAGE_TYPE_PREFIX = `__msg:`;
+
 export const MessageType = {
-    Text: '__msg:Text',
-    Sticker: '__msg:Sticker',
-    Animation: '__msg:Animation',
-    Document: '__msg:Document',
-    Voice: '__msg:Voice',
-    Audio: '__msg:Audio',
-    LeftChatMember: '__msg:LeftChatMember',
-    NewChatMember: '__msg:NewChatMember',
-    Poll: '__msg:Poll',
-    Location: '__msg:Location',
-    Photo: '__msg:Photo',
-    Forward: '__msg:Forward',
-    Unknown: '__msg:Unknown'
+    Text: `${INTERNAL_MESSAGE_TYPE_PREFIX}Text`,
+    Sticker: `${INTERNAL_MESSAGE_TYPE_PREFIX}Sticker`,
+    Animation: `${INTERNAL_MESSAGE_TYPE_PREFIX}Animation`,
+    Document: `${INTERNAL_MESSAGE_TYPE_PREFIX}Document`,
+    Voice: `${INTERNAL_MESSAGE_TYPE_PREFIX}Voice`,
+    Audio: `${INTERNAL_MESSAGE_TYPE_PREFIX}Audio`,
+    LeftChatMember: `${INTERNAL_MESSAGE_TYPE_PREFIX}LeftChatMember`,
+    NewChatMember: `${INTERNAL_MESSAGE_TYPE_PREFIX}NewChatMember`,
+    Poll: `${INTERNAL_MESSAGE_TYPE_PREFIX}Poll`,
+    Location: `${INTERNAL_MESSAGE_TYPE_PREFIX}Location`,
+    Photo: `${INTERNAL_MESSAGE_TYPE_PREFIX}Photo`,
+    Forward: `${INTERNAL_MESSAGE_TYPE_PREFIX}Forward`,
+    Unknown: `${INTERNAL_MESSAGE_TYPE_PREFIX}Unknown`
 } as const;
 
 export type MessageTypeValue = (typeof MessageType)[keyof typeof MessageType];

package/types/replyInfo.ts

@@ -0,0 +1,9 @@
+export class ReplyInfo {
+    readonly id: number;
+    readonly quote: string | undefined;
+
+    constructor(id: number, quote?: string) {
+        this.id = id;
+        this.quote = quote;
+    }
+}

package/types/response.ts

@@ -7,6 +7,7 @@ import { TextMessage } from '../dtos/responses/textMessage';
 import { UnpinResponse } from '../dtos/responses/unpin';
 import { VideoMessage } from '../dtos/responses/videoMessage';
 import { IActionState } from './actionState';
+import { ReplyInfo } from './replyInfo';
 import { IActionWithState } from './statefulAction';
 import { TraceId } from './trace';
 
@@ -38,9 +39,9 @@ export interface IChatResponse {
     readonly action: IActionWithState<IActionState>;
 }
 
-export interface IReplyMessage<TType> extends IChatResponse {
+export interface IReplyResponse<TType> extends IChatResponse {
     readonly content: TType;
-    readonly replyId: number | undefined;
+    readonly replyInfo: ReplyInfo | undefined;
     readonly disableWebPreview: boolean;
     readonly shouldPin: boolean;
 }