chz-telegram-bot 0.0.15 → 0.0.17

package/entities/context/chatContext.ts

@@ -1,12 +1,14 @@
-import ImageMessage from '../responses/imageMessage';
-import TextMessage from '../responses/textMessage';
-import VideoMessage from '../responses/videoMessage';
 import { resolve } from 'path';
 import { IBotApiInteractions } from '../../services/telegramApi';
 import { IStorageClient } from '../../types/storage';
+import { ImageMessage } from '../responses/imageMessage';
+import { TextMessage } from '../responses/textMessage';
+import { VideoMessage } from '../responses/videoMessage';
+import { UnpinResponse } from '../responses/unpin';
 
-export default class ChatContext {
+export class ChatContext {
     botName: string;
+    actionKey: string;
     interactions: IBotApiInteractions;
     chatId: number;
     chatName: string;
@@ -15,6 +17,7 @@ export default class ChatContext {
 
     constructor(
         botName: string,
+        actionKey: string,
         interactions: IBotApiInteractions,
         chatId: number,
         chatName: string,
@@ -22,6 +25,7 @@ export default class ChatContext {
         storage: IStorageClient
     ) {
         this.botName = botName;
+        this.actionKey = actionKey;
         this.interactions = interactions;
         this.chatId = chatId;
         this.chatName = chatName;
@@ -29,38 +33,59 @@ export default class ChatContext {
         this.storage = storage;
     }
 
-    sendTextToChat(text: string, disableWebPreview?: boolean) {
+    sendTextToChat(
+        text: string,
+        disableWebPreview?: boolean,
+        pinned?: boolean
+    ) {
         this.interactions.respond(
             new TextMessage(
                 text,
                 this.chatId,
                 undefined,
                 this.traceId,
-                disableWebPreview ?? false
+                disableWebPreview ?? false,
+                pinned ?? false,
+                this.actionKey
             )
         );
     }
 
-    sendImageToChat(name: string) {
+    sendImageToChat(name: string, pinned?: boolean) {
         const filePath = `./content/${name}.png`;
         this.interactions.respond(
             new ImageMessage(
                 { source: resolve(filePath) },
                 this.chatId,
                 undefined,
-                this.traceId
+                this.traceId,
+                pinned ?? false,
+                this.actionKey
             )
         );
     }
 
-    sendVideoToChat(name: string) {
+    sendVideoToChat(name: string, pinned?: boolean) {
         const filePath = `./content/${name}.mp4`;
         this.interactions.respond(
             new VideoMessage(
                 { source: resolve(filePath) },
                 this.chatId,
                 undefined,
-                this.traceId
+                this.traceId,
+                pinned ?? false,
+                this.actionKey
+            )
+        );
+    }
+
+    unpinMessage(messageId: number) {
+        this.interactions.unpin(
+            new UnpinResponse(
+                messageId,
+                this.chatId,
+                this.traceId,
+                this.actionKey
             )
         );
     }

package/entities/context/messageContext.ts

@@ -1,16 +1,16 @@
-import ActionStateBase from '../states/actionStateBase';
-import ImageMessage from '../responses/imageMessage';
-import TextMessage from '../responses/textMessage';
-import VideoMessage from '../responses/videoMessage';
-import ChatContext from './chatContext';
 import { resolve } from 'path';
-import IActionState from '../../types/actionState';
 import { IBotApiInteractions } from '../../services/telegramApi';
 import { TelegramEmoji } from 'telegraf/types';
-import Reaction from '../responses/reaction';
 import { IStorageClient } from '../../types/storage';
+import { IActionState } from '../../types/actionState';
+import { ImageMessage } from '../responses/imageMessage';
+import { Reaction } from '../responses/reaction';
+import { TextMessage } from '../responses/textMessage';
+import { VideoMessage } from '../responses/videoMessage';
+import { ActionStateBase } from '../states/actionStateBase';
+import { ChatContext } from './chatContext';
 
-export default class MessageContext<
+export class MessageContext<
     TActionState extends IActionState
 > extends ChatContext {
     messageId: number;
@@ -23,6 +23,7 @@ export default class MessageContext<
 
     constructor(
         botName: string,
+        scheduledKey: string,
         interactions: IBotApiInteractions,
         chatId: number,
         chatName: string,
@@ -33,7 +34,15 @@ export default class MessageContext<
         fromUserName: string,
         storage: IStorageClient
     ) {
-        super(botName, interactions, chatId, chatName, traceId, storage);
+        super(
+            botName,
+            scheduledKey,
+            interactions,
+            chatId,
+            chatName,
+            traceId,
+            storage
+        );
 
         this.messageId = messageId;
         this.messageText = messageText;
@@ -59,45 +68,57 @@ export default class MessageContext<
         );
     }
 
-    replyWithText(text: string, disableWebPreview?: boolean) {
+    replyWithText(text: string, disableWebPreview?: boolean, pinned?: boolean) {
         this.interactions.respond(
             new TextMessage(
                 text,
                 this.chatId,
                 this.messageId,
                 this.traceId,
-                disableWebPreview ?? false
+                disableWebPreview ?? false,
+                pinned ?? false,
+                this.actionKey
             )
         );
     }
 
-    replyWithImage(name: string) {
+    replyWithImage(name: string, pinned?: boolean) {
         const filePath = `./content/${name}.png`;
         this.interactions.respond(
             new ImageMessage(
                 { source: resolve(filePath) },
                 this.chatId,
                 this.messageId,
-                this.traceId
+                this.traceId,
+                pinned ?? false,
+                this.actionKey
             )
         );
     }
 
-    replyWithVideo(name: string) {
+    replyWithVideo(name: string, pinned?: boolean) {
         const filePath = `./content/${name}.mp4`;
         this.interactions.respond(
             new VideoMessage(
                 { source: resolve(filePath) },
                 this.chatId,
                 this.messageId,
-                this.traceId
+                this.traceId,
+                pinned ?? false,
+                this.actionKey
             )
         );
     }
 
     react(emoji: TelegramEmoji) {
         this.interactions.react(
-            new Reaction(this.traceId, this.chatId, this.messageId, emoji)
+            new Reaction(
+                this.traceId,
+                this.chatId,
+                this.messageId,
+                emoji,
+                this.actionKey
+            )
         );
     }
 }

package/entities/incomingMessage.ts

@@ -1,7 +1,7 @@
 import { Chat, User } from 'telegraf/types';
 import { randomInt } from 'crypto';
 
-export default class IncomingMessage {
+export class IncomingMessage {
     message_id: number;
     chat: Chat;
     from: User | undefined;

package/entities/responses/imageMessage.ts

@@ -1,22 +1,30 @@
 import { InputFile } from 'telegraf/types';
-import IReplyMessage from '../../types/replyMessage';
+import { BotResponseTypes, IReplyMessage } from '../../types/response';
+
+export class ImageMessage implements IReplyMessage<InputFile> {
+    kind = BotResponseTypes.image;
 
-export default class ImageMessage implements IReplyMessage<InputFile> {
     content: InputFile;
     chatId: number;
     replyId: number | undefined;
     traceId: string | number;
     disableWebPreview = false;
+    shouldPin: boolean;
+    sourceActionKey: string;
 
     constructor(
         image: InputFile,
         chatId: number,
         replyId: number | undefined,
-        traceId: number | string
+        traceId: number | string,
+        pinned: boolean,
+        sourceActionKey: string
     ) {
         this.content = image;
         this.chatId = chatId;
         this.replyId = replyId;
         this.traceId = traceId;
+        this.shouldPin = pinned;
+        this.sourceActionKey = sourceActionKey;
     }
 }

package/entities/responses/reaction.ts

@@ -1,20 +1,26 @@
 import { TelegramEmoji } from 'telegraf/types';
+import { BotResponseTypes, IChatResponse } from '../../types/response';
+
+export class Reaction implements IChatResponse {
+    kind = BotResponseTypes.react;
 
-export default class Reaction {
     chatId: number;
     messageId: number;
     traceId: number | string;
     emoji: TelegramEmoji;
+    sourceActionKey: string;
 
     constructor(
         traceId: number | string,
         chatId: number,
         messageId: number,
-        emoji: TelegramEmoji
+        emoji: TelegramEmoji,
+        sourceActionKey: string
     ) {
         this.chatId = chatId;
         this.messageId = messageId;
         this.emoji = emoji;
         this.traceId = traceId;
+        this.sourceActionKey = sourceActionKey;
     }
 }

package/entities/responses/textMessage.ts

@@ -1,23 +1,31 @@
-import IReplyMessage from '../../types/replyMessage';
+import { BotResponseTypes, IReplyMessage } from '../../types/response';
+
+export class TextMessage implements IReplyMessage<string> {
+    kind = BotResponseTypes.text;
 
-export default class TextMessage implements IReplyMessage<string> {
     content: string;
     chatId: number;
     replyId: number | undefined;
     traceId: string | number;
     disableWebPreview: boolean;
+    shouldPin: boolean;
+    sourceActionKey: string;
 
     constructor(
         text: string,
         chatId: number,
         replyId: number | undefined,
         traceId: string | number,
-        disableWebPreview: boolean
+        disableWebPreview: boolean,
+        pinned: boolean,
+        sourceActionKey: string
     ) {
         this.content = text;
         this.chatId = chatId;
         this.replyId = replyId;
         this.traceId = traceId;
         this.disableWebPreview = disableWebPreview;
+        this.shouldPin = pinned;
+        this.sourceActionKey = sourceActionKey;
     }
 }

package/entities/responses/unpin.ts

@@ -0,0 +1,22 @@
+import { BotResponseTypes, IChatResponse } from '../../types/response';
+
+export class UnpinResponse implements IChatResponse {
+    kind = BotResponseTypes.unpin;
+
+    messageId: number;
+    chatId: number;
+    traceId: number | string;
+    sourceActionKey: string;
+
+    constructor(
+        messageId: number,
+        chatId: number,
+        traceId: number | string,
+        sourceActionKey: string
+    ) {
+        this.messageId = messageId;
+        this.chatId = chatId;
+        this.traceId = traceId;
+        this.sourceActionKey = sourceActionKey;
+    }
+}

package/entities/responses/videoMessage.ts

@@ -1,22 +1,30 @@
 import { InputFile } from 'telegraf/types';
-import IReplyMessage from '../../types/replyMessage';
+import { BotResponseTypes, IReplyMessage } from '../../types/response';
+
+export class VideoMessage implements IReplyMessage<InputFile> {
+    kind = BotResponseTypes.video;
 
-export default class VideoMessage implements IReplyMessage<InputFile> {
     content: InputFile;
     chatId: number;
     replyId: number | undefined;
     traceId: string | number;
     disableWebPreview = false;
+    shouldPin: boolean;
+    sourceActionKey: string;
 
     constructor(
         video: InputFile,
         chatId: number,
         replyId: number | undefined,
-        traceId: number | string
+        traceId: number | string,
+        pinned: boolean,
+        sourceActionKey: string
     ) {
         this.content = video;
         this.chatId = chatId;
         this.replyId = replyId;
         this.traceId = traceId;
+        this.shouldPin = pinned;
+        this.sourceActionKey = sourceActionKey;
     }
 }

package/entities/states/actionStateBase.ts

@@ -1,5 +1,6 @@
-import IActionState from '../../types/actionState';
+import { IActionState } from '../../types/actionState';
 
-export default class ActionStateBase implements IActionState {
+export class ActionStateBase implements IActionState {
+    pinnedMessages: number[] = [];
     lastExecutedDate = 0;
 }

package/entities/taskRecord.ts

@@ -1,6 +1,6 @@
 import { Milliseconds } from '../types/timeValues';
 
-export default class TaskRecord {
+export class TaskRecord {
     name: string;
     taskId: NodeJS.Timeout;
     interval: Milliseconds;

package/helpers/builders/commandActionBuilder.ts

@@ -1,11 +1,11 @@
-import CommandAction from '../../entities/actions/commandAction';
-import ActionStateBase from '../../entities/states/actionStateBase';
-import toArray from '../toArray';
-import IActionState from '../../types/actionState';
 import { CommandHandler } from '../../types/handlers';
 import { CommandCondition } from '../../types/commandCondition';
 import { Seconds } from '../../types/timeValues';
-import Noop from '../noop';
+import { CommandAction } from '../../entities/actions/commandAction';
+import { ActionStateBase } from '../../entities/states/actionStateBase';
+import { IActionState } from '../../types/actionState';
+import { toArray } from '../toArray';
+import { Noop } from '../noop';
 
 export class CommandActionBuilderWithState<TActionState extends IActionState> {
     name: string;

package/helpers/builders/scheduledActionBuilder.ts

@@ -1,10 +1,10 @@
-import ScheduledAction from '../../entities/actions/scheduledAction';
-import CachedStateFactory from '../../entities/cachedStateFactory';
+import { ScheduledAction } from '../../entities/actions/scheduledAction';
+import { CachedStateFactory } from '../../entities/cachedStateFactory';
 import { ScheduledHandler } from '../../types/handlers';
 import { Hours, HoursOfDay } from '../../types/timeValues';
-import Noop from '../noop';
+import { Noop } from '../noop';
 
-export default class ScheduledActionBuilder {
+export class ScheduledActionBuilder {
     active = true;
     time: HoursOfDay = 0;
     cachedStateFactories = new Map<string, CachedStateFactory>();

package/helpers/noop.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-class Noop {
+export class Noop {
     static async true<T1>(arg1: T1) {
         return true;
     }
@@ -9,5 +9,3 @@ class Noop {
     static async call<T1, T2>(arg1: T1, arg2: T2): Promise<void>;
     static async call<T1>(arg1: T1) {}
 }
-
-export default Noop;

package/helpers/toArray.ts

@@ -1,3 +1,3 @@
-export default function toArray<TType>(value: TType | TType[]) {
+export function toArray<TType>(value: TType | TType[]) {
     return Array.isArray(value) ? value : [value];
 }

package/main.ts

@@ -1,16 +1,16 @@
 import { readFile } from 'fs/promises';
-import BotInstance from './entities/bot.js';
-import taskScheduler from './services/taskScheduler.js';
-import logger from './services/logger.js';
-import CommandAction from './entities/actions/commandAction.js';
-import IActionState from './types/actionState.js';
-import ScheduledAction from './entities/actions/scheduledAction.js';
-import { IStorageClient } from './types/storage.js';
+import { IStorageClient } from './types/storage';
+import { Logger } from './services/logger';
+import { CommandAction } from './entities/actions/commandAction';
+import { ScheduledAction } from './entities/actions/scheduledAction';
+import { IActionState } from './types/actionState';
+import { Scheduler } from './services/taskScheduler';
+import { BotInstance } from './entities/botInstance';
 
 const bots: BotInstance[] = [];
 
 function log(text: string) {
-    logger.logWithTraceId('ALL BOTS', 'System:Bot', 'System', text);
+    Logger.logWithTraceId('ALL BOTS', 'System:Bot', 'System', text);
 }
 
 async function startBot(options: {
@@ -39,7 +39,7 @@ async function startBot(options: {
 
 async function stopBots(reason: string) {
     log(`Recieved termination code: ${reason}`);
-    taskScheduler.stopAll();
+    Scheduler.stopAll();
     log('Acquiring storage semaphore...');
 
     log('Stopping bots...');

package/package.json

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

package/services/jsonFileStorage.ts

@@ -1,14 +1,14 @@
 import { existsSync, mkdirSync } from 'fs';
 import { dirname } from 'path';
-import TransactionResult from '../entities/transactionResult';
 import { mkdir, readFile, writeFile } from 'fs/promises';
-import ActionStateBase from '../entities/states/actionStateBase';
-import IActionState from '../types/actionState';
-import IActionWithState from '../types/actionWithState';
 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 } from '../types/actionWithState';
 
-export default class JsonFileStorage implements IStorageClient {
+export class JsonFileStorage implements IStorageClient {
     semaphore = new Semaphore(1);
     private cache: Map<string, Record<number, IActionState>>;
     private storagePath: string;
@@ -105,7 +105,7 @@ export default class JsonFileStorage implements IStorageClient {
     async saveActionExecutionResult(
         action: IActionWithState,
         chatId: number,
-        transactionResult: TransactionResult
+        transactionResult: ActionExecutionResult
     ) {
         await this.lock(async () => {
             const data = await this.loadInternal(action.key);
@@ -120,4 +120,19 @@ export default class JsonFileStorage implements IStorageClient {
     async close(): Promise<void> {
         await this.semaphore.acquire();
     }
+
+    async updateStateFor<TActionState extends IActionState>(
+        sourceActionKey: string,
+        chatId: number,
+        update: (state: TActionState) => Promise<void>
+    ) {
+        await this.lock(async () => {
+            const data = await this.loadInternal(sourceActionKey);
+            const state = data[chatId] as TActionState;
+
+            await update(state);
+
+            await this.save(data, sourceActionKey);
+        });
+    }
 }

package/services/logger.ts

@@ -1,4 +1,4 @@
-class Logger {
+class JsonLogger {
     logWithTraceId(
         botName: string,
         traceId: string | number,
@@ -27,4 +27,4 @@ class Logger {
     }
 }
 
-export default new Logger();
+export const Logger = new JsonLogger();

package/services/taskScheduler.ts

@@ -1,7 +1,7 @@
-import TaskRecord from '../entities/taskRecord';
+import { TaskRecord } from '../entities/taskRecord';
 import { secondsToMilliseconds } from '../helpers/timeConvertions';
 import { Milliseconds, Seconds } from '../types/timeValues';
-import logger from './logger';
+import { Logger } from './logger';
 
 class TaskScheduler {
     activeTasks: TaskRecord[] = [];
@@ -27,7 +27,7 @@ class TaskScheduler {
             setTimeout(action, secondsToMilliseconds(1 as Seconds));
         }
 
-        logger.logWithTraceId(
+        Logger.logWithTraceId(
             ownerName,
             `System:TaskScheduler-${ownerName}-${name}`,
             'System',
@@ -44,7 +44,7 @@ class TaskScheduler {
         ownerName: string
     ) {
         const actionWrapper = () => {
-            logger.logWithTraceId(
+            Logger.logWithTraceId(
                 ownerName,
                 `System:TaskScheduler-${ownerName}-${name}`,
                 'System',
@@ -54,7 +54,7 @@ class TaskScheduler {
         };
         const taskId = setTimeout(actionWrapper, delay);
 
-        logger.logWithTraceId(
+        Logger.logWithTraceId(
             ownerName,
             `System:TaskScheduler-${ownerName}-${name}`,
             'System',
@@ -63,4 +63,4 @@ class TaskScheduler {
     }
 }
 
-export default new TaskScheduler();
+export const Scheduler = new TaskScheduler();