chz-telegram-bot 0.0.16 → 0.0.17

package/dist/types/response.d.ts

@@ -0,0 +1,26 @@
+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';
+export declare const BotResponseTypes: {
+    readonly unpin: "unpin";
+    readonly text: "text";
+    readonly image: "image";
+    readonly video: "video";
+    readonly react: "react";
+};
+export type BotResponse = UnpinResponse | Reaction | TextMessage | VideoMessage | ImageMessage;
+export interface IChatResponse {
+    kind: keyof typeof BotResponseTypes;
+    chatId: number;
+    traceId: number | string;
+    sourceActionKey: string;
+}
+export interface IReplyMessage<TType> extends IChatResponse {
+    content: TType;
+    replyId: number | undefined;
+    disableWebPreview: boolean;
+    shouldPin: boolean;
+}
+//# sourceMappingURL=response.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../types/response.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE,eAAO,MAAM,gBAAgB;;;;;;CAMnB,CAAC;AAEX,MAAM,MAAM,WAAW,GACjB,aAAa,GACb,QAAQ,GACR,WAAW,GACX,YAAY,GACZ,YAAY,CAAC;AAEnB,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,MAAM,OAAO,gBAAgB,CAAC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa,CAAC,KAAK,CAAE,SAAQ,aAAa;IACvD,OAAO,EAAE,KAAK,CAAC;IACf,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,SAAS,EAAE,OAAO,CAAC;CACtB"}

package/dist/types/response.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BotResponseTypes = void 0;
+exports.BotResponseTypes = {
+    unpin: 'unpin',
+    text: 'text',
+    image: 'image',
+    video: 'video',
+    react: 'react'
+};

package/dist/types/storage.d.ts

@@ -2,6 +2,7 @@ import { ActionExecutionResult } from '../entities/actionExecutionResult';
 import { IActionState } from './actionState';
 import { IActionWithState } from './actionWithState';
 export interface IStorageClient {
+    updateStateFor<TActionState extends IActionState>(sourceActionKey: string, chatId: number, update: (state: TActionState) => Promise<void>): Promise<void>;
     close(): Promise<void>;
     load<TActionState extends IActionState>(key: string): Promise<Record<number, TActionState>>;
     saveMetadata(actions: IActionWithState[], botName: string): Promise<void>;

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

@@ -1 +1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../types/storage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAErD,MAAM,WAAW,cAAc;IAC3B,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,IAAI,CAAC,YAAY,SAAS,YAAY,EAClC,GAAG,EAAE,MAAM,GACZ,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;IACzC,YAAY,CAAC,OAAO,EAAE,gBAAgB,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1E,cAAc,CAAC,YAAY,SAAS,YAAY,EAC5C,MAAM,EAAE,gBAAgB,EACxB,MAAM,EAAE,MAAM,GACf,OAAO,CAAC,YAAY,CAAC,CAAC;IACzB,yBAAyB,CACrB,MAAM,EAAE,gBAAgB,EACxB,MAAM,EAAE,MAAM,EACd,iBAAiB,EAAE,qBAAqB,GACzC,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../types/storage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAErD,MAAM,WAAW,cAAc;IAC3B,cAAc,CAAC,YAAY,SAAS,YAAY,EAC5C,eAAe,EAAE,MAAM,EACvB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,GAC/C,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,IAAI,CAAC,YAAY,SAAS,YAAY,EAClC,GAAG,EAAE,MAAM,GACZ,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;IACzC,YAAY,CAAC,OAAO,EAAE,gBAAgB,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1E,cAAc,CAAC,YAAY,SAAS,YAAY,EAC5C,MAAM,EAAE,gBAAgB,EACxB,MAAM,EAAE,MAAM,GACf,OAAO,CAAC,YAAY,CAAC,CAAC;IACzB,yBAAyB,CACrB,MAAM,EAAE,gBAAgB,EACxB,MAAM,EAAE,MAAM,EACd,iBAAiB,EAAE,qBAAqB,GACzC,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB"}

package/entities/botInstance.ts

@@ -50,7 +50,7 @@ export class BotInstance {
             new JsonFileStorage(options.name, options.storagePath);
         this.api = new TelegramApiService(
             this.name,
-            this.telegraf,
+            this.telegraf.telegram,
             this.storage,
             this.chats
         );
@@ -118,7 +118,7 @@ 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.name);
+                const ctx = this.api.createContextForChat(chatId, trig.key);
 
                 try {
                     await trig.exec(ctx);
@@ -140,7 +140,7 @@ export class BotInstance {
         const msg = this.messageQueue.pop()!;
 
         for (const cmd of this.commands) {
-            const ctx = this.api.createContextForMessage(msg);
+            const ctx = this.api.createContextForMessage(msg, cmd.key);
 
             try {
                 await cmd.exec(ctx);

package/entities/context/chatContext.ts

@@ -4,9 +4,11 @@ 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 class ChatContext {
     botName: string;
+    actionKey: string;
     interactions: IBotApiInteractions;
     chatId: number;
     chatName: string;
@@ -15,6 +17,7 @@ export class ChatContext {
 
     constructor(
         botName: string,
+        actionKey: string,
         interactions: IBotApiInteractions,
         chatId: number,
         chatName: string,
@@ -22,6 +25,7 @@ export class ChatContext {
         storage: IStorageClient
     ) {
         this.botName = botName;
+        this.actionKey = actionKey;
         this.interactions = interactions;
         this.chatId = chatId;
         this.chatName = chatName;
@@ -29,38 +33,59 @@ export 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

@@ -23,6 +23,7 @@ export class MessageContext<
 
     constructor(
         botName: string,
+        scheduledKey: string,
         interactions: IBotApiInteractions,
         chatId: number,
         chatName: string,
@@ -33,7 +34,15 @@ export 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 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/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;
+
     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 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;
+
     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;
+
     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';
 
 export class ActionStateBase implements IActionState {
+    pinnedMessages: number[] = [];
     lastExecutedDate = 0;
 }

package/package.json

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

package/services/jsonFileStorage.ts

@@ -120,4 +120,19 @@ export 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);
+        });
+    }
 }