chz-telegram-bot 0.0.46 → 0.0.48

package/entities/responses/textMessage.ts

@@ -1,6 +1,7 @@
 import { TextMessageSendingOptions } from '../../types/messageSendingOptions';
 import { BotResponseTypes, IReplyMessage } from '../../types/response';
 import { IActionWithState } from '../../types/actionWithState';
+import { IActionState } from '../../types/actionState';
 
 export class TextMessage implements IReplyMessage<string> {
     kind = BotResponseTypes.text;
@@ -11,14 +12,14 @@ export class TextMessage implements IReplyMessage<string> {
     traceId: string | number;
     disableWebPreview: boolean;
     shouldPin: boolean;
-    action: IActionWithState;
+    action: IActionWithState<IActionState>;
 
     constructor(
         text: string,
         chatId: number,
         replyId: number | undefined,
         traceId: string | number,
-        action: IActionWithState,
+        action: IActionWithState<IActionState>,
         options?: TextMessageSendingOptions
     ) {
         this.content = text;

package/entities/responses/unpin.ts

@@ -1,5 +1,6 @@
 import { BotResponseTypes, IChatResponse } from '../../types/response';
 import { IActionWithState } from '../../types/actionWithState';
+import { IActionState } from '../../types/actionState';
 
 export class UnpinResponse implements IChatResponse {
     kind = BotResponseTypes.unpin;
@@ -7,13 +8,13 @@ export class UnpinResponse implements IChatResponse {
     messageId: number;
     chatId: number;
     traceId: number | string;
-    action: IActionWithState;
+    action: IActionWithState<IActionState>;
 
     constructor(
         messageId: number,
         chatId: number,
         traceId: number | string,
-        action: IActionWithState
+        action: IActionWithState<IActionState>
     ) {
         this.messageId = messageId;
         this.chatId = chatId;

package/entities/responses/videoMessage.ts

@@ -2,6 +2,7 @@ import { InputFile } from 'telegraf/types';
 import { BotResponseTypes, IReplyMessage } from '../../types/response';
 import { MessageSendingOptions } from '../../types/messageSendingOptions';
 import { IActionWithState } from '../../types/actionWithState';
+import { IActionState } from '../../types/actionState';
 
 export class VideoMessage implements IReplyMessage<InputFile> {
     kind = BotResponseTypes.video;
@@ -12,14 +13,14 @@ export class VideoMessage implements IReplyMessage<InputFile> {
     traceId: string | number;
     disableWebPreview = false;
     shouldPin: boolean;
-    action: IActionWithState;
+    action: IActionWithState<IActionState>;
 
     constructor(
         video: InputFile,
         chatId: number,
         replyId: number | undefined,
         traceId: number | string,
-        action: IActionWithState,
+        action: IActionWithState<IActionState>,
         options?: MessageSendingOptions
     ) {
         this.content = video;

package/package.json

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

package/services/jsonFileStorage.ts

@@ -3,7 +3,6 @@ import { dirname } from 'path';
 import { mkdir, readFile, writeFile } from 'fs/promises';
 import { Sema as Semaphore } from 'async-sema';
 import { IStorageClient } from '../types/storage';
-import { ActionStateBase } from '../entities/states/actionStateBase';
 import { ActionExecutionResult } from '../entities/actionExecutionResult';
 import { IActionState } from '../types/actionState';
 import { IActionWithState, ActionKey } from '../types/actionWithState';
@@ -14,7 +13,11 @@ export class JsonFileStorage implements IStorageClient {
     private storagePath: string;
     private botName: string;
 
-    constructor(botName: string, actions: IActionWithState[], path?: string) {
+    constructor(
+        botName: string,
+        actions: IActionWithState<IActionState>[],
+        path?: string
+    ) {
         this.cache = new Map<string, Record<number, IActionState>>();
         this.botName = botName;
         this.storagePath = path ?? 'storage';
@@ -67,8 +70,11 @@ export class JsonFileStorage implements IStorageClient {
         return (this.cache.get(key) ?? {}) as Record<number, TActionState>;
     }
 
-    private async save(data: Record<number, ActionStateBase>, key: ActionKey) {
-        this.cache.delete(key);
+    private async save<TActionState extends IActionState>(
+        data: Record<number, TActionState>,
+        key: ActionKey
+    ) {
+        this.cache.set(key, data);
 
         const targetPath = this.buidPathFromKey(key);
         const folderName = dirname(targetPath);
@@ -93,7 +99,10 @@ export class JsonFileStorage implements IStorageClient {
         });
     }
 
-    async saveMetadata(actions: IActionWithState[], botName: string) {
+    async saveMetadata(
+        actions: IActionWithState<IActionState>[],
+        botName: string
+    ) {
         const targetPath = this.buidPathFromKey(
             `Metadata-${botName}` as ActionKey
         );
@@ -104,7 +113,7 @@ export class JsonFileStorage implements IStorageClient {
     }
 
     async getActionState<TActionState extends IActionState>(
-        action: IActionWithState,
+        action: IActionWithState<TActionState>,
         chatId: number
     ) {
         return await this.lock(action.key, async () => {
@@ -117,13 +126,13 @@ export class JsonFileStorage implements IStorageClient {
         });
     }
 
-    async saveActionExecutionResult(
-        action: IActionWithState,
+    async saveActionExecutionResult<TActionState extends IActionState>(
+        action: IActionWithState<TActionState>,
         chatId: number,
-        transactionResult: ActionExecutionResult
+        transactionResult: ActionExecutionResult<TActionState>
     ) {
         await this.lock(action.key, async () => {
-            const data = await this.loadInternal(action.key);
+            const data = await this.loadInternal<TActionState>(action.key);
 
             if (transactionResult.shouldUpdate) {
                 data[chatId] = transactionResult.data;
@@ -139,16 +148,16 @@ export class JsonFileStorage implements IStorageClient {
     }
 
     async updateStateFor<TActionState extends IActionState>(
-        action: IActionWithState,
+        action: IActionWithState<TActionState>,
         chatId: number,
         update: (state: TActionState) => Promise<void>
     ) {
         await this.lock(action.key, async () => {
-            const data = await this.loadInternal(action.key);
+            const data = await this.loadInternal<TActionState>(action.key);
             const state = Object.assign(
                 action.stateConstructor(),
                 data[chatId]
-            ) as TActionState;
+            );
 
             await update(state);
 

package/services/telegramApi.ts

@@ -4,13 +4,8 @@ import { MessageContext } from '../entities/context/messageContext';
 import { inverseRecord as inverseRecord } from '../helpers/inverseRecord';
 import { IStorageClient } from '../types/storage';
 import { Logger } from './logger';
-import { Reaction } from '../entities/responses/reaction';
 import { IncomingMessage } from '../entities/incomingMessage';
 import { BotResponse, IReplyMessage } from '../types/response';
-import { UnpinResponse } from '../entities/responses/unpin';
-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 { setTimeout } from 'timers/promises';
 import { Milliseconds } from '../types/timeValues';
@@ -28,7 +23,6 @@ export class TelegramApiService {
     telegram: Telegram;
     chats: Record<number, string>;
     storage: IStorageClient;
-    interactions: IBotApiInteractions;
 
     constructor(
         botName: string,
@@ -40,12 +34,12 @@ export class TelegramApiService {
         this.botName = botName;
         this.chats = inverseRecord(chats);
         this.storage = storage;
+    }
 
-        this.interactions = {
-            react: (reaction) => this.enqueue(reaction),
-            respond: (response) => this.enqueue(response),
-            unpin: (unpinMessage) => this.enqueue(unpinMessage)
-        } as IBotApiInteractions;
+    enqueueBatchedResponses(responses: BotResponse[]) {
+        for (const response of responses) {
+            this.messageQueue.push(response);
+        }
     }
 
     async flushResponses() {
@@ -171,10 +165,6 @@ export class TelegramApiService {
         }
     }
 
-    private enqueue(response: BotResponse) {
-        this.messageQueue.push(response);
-    }
-
     initializeContextForMessage<TActionState extends IActionState>(
         ctx: MessageContext<TActionState>,
         incomingMessage: IncomingMessage,
@@ -183,7 +173,6 @@ export class TelegramApiService {
         return ctx.initializeMessageContext(
             this.botName,
             command,
-            this.interactions,
             incomingMessage,
             this.storage
         );
@@ -197,7 +186,6 @@ export class TelegramApiService {
         return ctx.initializeChatContext(
             this.botName,
             scheduledAction,
-            this.interactions,
             chatId,
             this.chats[chatId],
             `Scheduled:${scheduledAction.key}:${chatId}`,
@@ -205,9 +193,3 @@ export class TelegramApiService {
         );
     }
 }
-
-export interface IBotApiInteractions {
-    respond: (response: TextMessage | VideoMessage | ImageMessage) => void;
-    react: (reaction: Reaction) => void;
-    unpin: (unpinMessage: UnpinResponse) => void;
-}

package/types/actionWithState.ts

@@ -2,7 +2,7 @@ import { IActionState } from './actionState';
 
 export type ActionKey = string & { __brand: 'actionKey' };
 
-export interface IActionWithState {
+export interface IActionWithState<TActionState extends IActionState> {
     key: ActionKey;
-    stateConstructor: () => IActionState;
+    stateConstructor: () => TActionState;
 }

package/types/response.ts

@@ -1,8 +1,10 @@
+import { DelayResponse } from '../entities/responses/delay';
 import { ImageMessage } from '../entities/responses/imageMessage';
 import { Reaction } from '../entities/responses/reaction';
 import { TextMessage } from '../entities/responses/textMessage';
 import { UnpinResponse } from '../entities/responses/unpin';
 import { VideoMessage } from '../entities/responses/videoMessage';
+import { IActionState } from './actionState';
 import { IActionWithState } from './actionWithState';
 
 export const BotResponseTypes = {
@@ -10,7 +12,8 @@ export const BotResponseTypes = {
     text: 'text',
     image: 'image',
     video: 'video',
-    react: 'react'
+    react: 'react',
+    delay: 'delay'
 } as const;
 
 export type BotResponse =
@@ -18,6 +21,7 @@ export type BotResponse =
     | Reaction
     | TextMessage
     | VideoMessage
+    | DelayResponse
     | ImageMessage;
 
 export interface IChatResponse {
@@ -25,7 +29,7 @@ export interface IChatResponse {
     chatId: number;
     traceId: number | string;
 
-    action: IActionWithState;
+    action: IActionWithState<IActionState>;
 }
 
 export interface IReplyMessage<TType> extends IChatResponse {

package/types/storage.ts

@@ -4,7 +4,7 @@ import { ActionKey, IActionWithState } from './actionWithState';
 
 export interface IStorageClient {
     updateStateFor<TActionState extends IActionState>(
-        action: IActionWithState,
+        action: IActionWithState<TActionState>,
         chatId: number,
         update: (state: TActionState) => Promise<void>
     ): Promise<void>;
@@ -12,14 +12,17 @@ export interface IStorageClient {
     load<TActionState extends IActionState>(
         key: ActionKey
     ): Promise<Record<number, TActionState>>;
-    saveMetadata(actions: IActionWithState[], botName: string): Promise<void>;
+    saveMetadata<TActionState extends IActionState>(
+        actions: IActionWithState<TActionState>[],
+        botName: string
+    ): Promise<void>;
     getActionState<TActionState extends IActionState>(
-        action: IActionWithState,
+        action: IActionWithState<TActionState>,
         chatId: number
     ): Promise<TActionState>;
-    saveActionExecutionResult(
-        action: IActionWithState,
+    saveActionExecutionResult<TActionState extends IActionState>(
+        action: IActionWithState<TActionState>,
         chatId: number,
-        transactionResult: ActionExecutionResult
+        transactionResult: ActionExecutionResult<TActionState>
     ): Promise<void>;
 }