chz-telegram-bot 0.7.13 → 0.7.15

package/src/entities/botInstance.ts

@@ -1,92 +0,0 @@
-import { Seconds } from '../types/timeValues';
-import { IStorageClient } from '../types/storage';
-import { JsonFileStorage } from '../services/jsonFileStorage';
-import { IActionState } from '../types/actionState';
-import { CommandAction } from './actions/commandAction';
-import { ScheduledAction } from './actions/scheduledAction';
-import { IScheduler } from '../types/scheduler';
-import { NodeTimeoutScheduler } from '../services/nodeTimeoutScheduler';
-import { InlineQueryAction } from './actions/inlineQueryAction';
-import { ActionProcessingService } from '../services/actionProcessingService';
-import { BotEventType, TypedEventEmitter } from '../types/events';
-import { createTrace } from '../helpers/traceFactory';
-
-export class BotInstance {
-    private readonly storage: IStorageClient;
-    private readonly scheduler: IScheduler;
-    private readonly actionProcessingService: ActionProcessingService;
-
-    readonly name: string;
-    readonly eventEmitter: TypedEventEmitter<Record<string, unknown>>;
-
-    constructor(options: {
-        name: string;
-        actions: {
-            commands: CommandAction<IActionState>[];
-            scheduled: ScheduledAction<IActionState>[];
-            inlineQueries: InlineQueryAction[];
-        };
-        chats: Record<string, number>;
-        storagePath?: string;
-        services?: {
-            storageClient?: IStorageClient;
-            scheduler?: IScheduler;
-            eventEmitter?: TypedEventEmitter<Record<string, unknown>>;
-        };
-    }) {
-        const actions = [
-            ...options.actions.commands,
-            ...options.actions.scheduled
-        ];
-
-        this.name = options.name;
-        this.eventEmitter =
-            options.services?.eventEmitter ?? new TypedEventEmitter();
-
-        this.scheduler =
-            options.services?.scheduler ??
-            new NodeTimeoutScheduler(this.eventEmitter, this.name);
-        this.storage =
-            options.services?.storageClient ??
-            new JsonFileStorage(options.name, actions, options.storagePath);
-        this.actionProcessingService = new ActionProcessingService(
-            this.name,
-            options.chats,
-            this.storage,
-            this.scheduler,
-            this.eventEmitter
-        );
-    }
-
-    async start(
-        token: string,
-        actions: {
-            commands: CommandAction<IActionState>[];
-            scheduled: ScheduledAction<IActionState>[];
-            inlineQueries: InlineQueryAction[];
-        },
-        scheduledPeriod?: Seconds
-    ) {
-        this.eventEmitter.emit(BotEventType.botStarting, {
-            botName: this.name,
-            traceId: createTrace(this, this.name, 'startup')
-        });
-
-        await this.actionProcessingService.initialize(
-            token,
-            actions,
-            scheduledPeriod
-        );
-    }
-
-    async stop() {
-        this.eventEmitter.emit(BotEventType.botStopping, {
-            botName: this.name,
-            traceId: createTrace(this, this.name, 'stop')
-        });
-
-        this.scheduler.stopAll();
-        await this.storage.close();
-        this.actionProcessingService.stop();
-    }
-}

package/src/entities/cachedStateFactory.ts

@@ -1,14 +0,0 @@
-import { Hours } from '../types/timeValues';
-
-export class CachedStateFactory {
-    readonly getValue: () => Promise<unknown>;
-    readonly invalidationTimeoutInHours: Hours;
-
-    constructor(
-        itemFactory: () => Promise<unknown>,
-        invalidationTimeout: Hours
-    ) {
-        this.getValue = itemFactory;
-        this.invalidationTimeoutInHours = invalidationTimeout;
-    }
-}

package/src/entities/context/baseContext.ts

@@ -1,111 +0,0 @@
-import { ChatInfo } from '../../dtos/chatInfo';
-import { IAction, IActionWithState } from '../../types/action';
-import { IActionState } from '../../types/actionState';
-import { ICaptureController } from '../../types/capture';
-import { CommandTrigger } from '../../types/commandTrigger';
-import { TypedEventEmitter } from '../../types/events';
-import { BotResponse, IReplyResponse } from '../../types/response';
-import { IScheduler } from '../../types/scheduler';
-import { IStorageClient } from '../../types/storage';
-import { TraceId } from '../../types/trace';
-import { ReplyContext } from './replyContext';
-
-export type BaseContextPropertiesToOmit =
-    | 'action'
-    | 'isInitialized'
-    | 'storage'
-    | 'scheduler'
-    | 'responses';
-
-export abstract class BaseContextInternal<TAction extends IAction> {
-    readonly responses: BotResponse[] = [];
-    readonly action: TAction;
-    /** Storage client instance for the bot executing this action. */
-    readonly storage: IStorageClient;
-    /** Scheduler instance for the bot executing this action */
-    readonly scheduler: IScheduler;
-    /** Name of a bot that executes this action. */
-    readonly botName: string;
-    /** Chat information. */
-    readonly chatInfo: ChatInfo;
-
-    readonly observability: {
-        /** Event emitter for emitting events related to action execution. */
-        eventEmitter: TypedEventEmitter;
-        /** Trace id of a action execution. */
-        traceId: TraceId;
-    };
-
-    get actionKey() {
-        return this.action.key;
-    }
-
-    constructor(
-        storage: IStorageClient,
-        scheduler: IScheduler,
-        eventEmitter: TypedEventEmitter,
-        action: TAction,
-        chatInfo: ChatInfo,
-        traceId: TraceId,
-        botName: string
-    ) {
-        this.storage = storage;
-        this.scheduler = scheduler;
-        this.botName = botName;
-        this.action = action;
-        this.chatInfo = chatInfo;
-        this.observability = {
-            eventEmitter,
-            traceId
-        };
-    }
-
-    protected createCaptureController(
-        response: IReplyResponse
-    ): ICaptureController {
-        return {
-            captureReplies: (
-                trigger: CommandTrigger[],
-                handler: (
-                    replyContext: ReplyContext<IActionState>
-                ) => Promise<void>,
-                abortController?: AbortController
-            ) => {
-                response.captures.push({
-                    trigger,
-                    handler,
-                    abortController: abortController ?? new AbortController(),
-                    action: this.action
-                });
-            }
-        };
-    }
-
-    /**
-     * Loads state of another action for current chat.
-     * @param action Action to load state of.
-     * @template TAnotherActionState - Type of a state that is used by another action.
-     */
-    loadStateOf<TAnotherActionState extends IActionState>(
-        action: IActionWithState<TAnotherActionState>
-    ) {
-        const allStates = this.storage.load(action);
-        const stateForChat =
-            allStates[this.chatInfo.id] ?? action.stateConstructor();
-
-        return Object.freeze(structuredClone(stateForChat));
-    }
-
-    /**
-     * Mutates state of another action for current chat.
-     * @param action Action to load state of.
-     * @param mutation Fuction that mutates the state.
-     * @template TAnotherActionState - Type of a state that is used by another action.
-     */
-    async updateStateOf<TAnotherActionState extends IActionState>(
-        action: IActionWithState<TAnotherActionState>,
-        mutation: (state: TAnotherActionState) => Promise<void>
-    ) {
-        await this.storage.updateStateFor(action, this.chatInfo.id, mutation);
-    }
-}

package/src/entities/context/chatContext.ts

@@ -1,135 +0,0 @@
-import { resolve } from 'path';
-import { ImageMessage } from '../../dtos/responses/imageMessage';
-import { TextMessage } from '../../dtos/responses/textMessage';
-import { VideoMessage } from '../../dtos/responses/videoMessage';
-import { UnpinResponse } from '../../dtos/responses/unpin';
-import {
-    MessageSendingOptions,
-    TextMessageSendingOptions
-} from '../../types/messageSendingOptions';
-import { IActionWithState } from '../../types/action';
-import { IActionState } from '../../types/actionState';
-import { Milliseconds } from '../../types/timeValues';
-import { DelayResponse } from '../../dtos/responses/delay';
-import {
-    BaseContextInternal,
-    BaseContextPropertiesToOmit
-} from './baseContext';
-import { ScheduledAction } from '../actions/scheduledAction';
-
-export type ChatContext<
-    TActionState extends IActionState,
-    TAction extends IActionWithState<TActionState> =
-        ScheduledAction<TActionState>
-> = Omit<
-    ChatContextInternal<TActionState, TAction>,
-    BaseContextPropertiesToOmit
->;
-
-/**
- * Context of action executed in chat.
- */
-export class ChatContextInternal<
-    TActionState extends IActionState,
-    TAction extends IActionWithState<TActionState> =
-        ScheduledAction<TActionState>
-> extends BaseContextInternal<TAction> {
-    /**
-     * Collection of actions that send something to chat as a standalone message.
-     */
-    send = {
-        /**
-         * Sends text message to chat 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.
-         */
-        text: (text: string, options?: TextMessageSendingOptions) => {
-            const response = new TextMessage(
-                text,
-                this.chatInfo,
-                this.observability.traceId,
-                this.action,
-                undefined,
-                options
-            );
-
-            this.responses.push(response);
-
-            return this.createCaptureController(response);
-        },
-
-        /**
-         * Sends image message to chat 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 name Message contents.
-         * @param options Message sending option.
-         */
-        image: (name: string, options?: MessageSendingOptions) => {
-            const response = new ImageMessage(
-                { source: resolve(`./content/${name}.png`) },
-                this.chatInfo,
-                this.observability.traceId,
-                this.action,
-                undefined,
-                options
-            );
-
-            this.responses.push(response);
-
-            return this.createCaptureController(response);
-        },
-
-        /**
-         * Sends video/gif message to chat 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 name Message contents.
-         * @param options Message sending option.
-         */
-        video: (name: string, options?: MessageSendingOptions) => {
-            const response = new VideoMessage(
-                { source: resolve(`./content/${name}.mp4`) },
-                this.chatInfo,
-                this.observability.traceId,
-                this.action,
-                undefined,
-                options
-            );
-
-            this.responses.push(response);
-
-            return this.createCaptureController(response);
-        }
-    };
-
-    /**
-     * Unpins message 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 messageId Message id.
-     */
-    unpinMessage(messageId: number) {
-        this.responses.push(
-            new UnpinResponse(
-                messageId,
-                this.chatInfo,
-                this.observability.traceId,
-                this.action
-            )
-        );
-    }
-
-    /**
-     * Delays next responses by specified amount of time.
-     * @param delay Delay in milliseconds.
-     */
-    wait(delay: Milliseconds) {
-        this.responses.push(
-            new DelayResponse(
-                delay,
-                this.chatInfo,
-                this.observability.traceId,
-                this.action
-            )
-        );
-    }
-}

package/src/entities/context/inlineQueryContext.ts

@@ -1,63 +0,0 @@
-import { InlineQueryAction } from '../actions/inlineQueryAction';
-import {
-    BaseContextInternal,
-    BaseContextPropertiesToOmit
-} from './baseContext';
-import { TelegramInlineQueryResult } from '../../types/externalAliases';
-import { TypedEventEmitter } from '../../types/events';
-import { IScheduler } from '../../types/scheduler';
-import { IStorageClient } from '../../types/storage';
-import { ChatInfo } from '../../dtos/chatInfo';
-import { IncomingInlineQuery } from '../../dtos/incomingQuery';
-
-export type InlineQueryContext = Omit<
-    InlineQueryContextInternal,
-    BaseContextPropertiesToOmit | 'queryResults' | 'queryId'
->;
-
-export class InlineQueryContextInternal extends BaseContextInternal<InlineQueryAction> {
-    readonly queryResults: TelegramInlineQueryResult[] = [];
-    /**
-     * Abort signal to be utilized in query handler.
-     * Signal will be aborted if new query comes from the same user.
-     */
-    readonly abortSignal: AbortSignal;
-    /** Inline query text */
-    readonly queryText: string;
-    /** Internal query id */
-    readonly queryId: string;
-    /** Collection of Regexp match results on a message that triggered this action. Will be empty if trigger is not a Regexp. */
-    matchResults: RegExpMatchArray[] = [];
-
-    constructor(
-        storage: IStorageClient,
-        scheduler: IScheduler,
-        eventEmitter: TypedEventEmitter,
-        action: InlineQueryAction,
-        query: IncomingInlineQuery,
-        chatInfo: ChatInfo,
-        botName: string
-    ) {
-        super(
-            storage,
-            scheduler,
-            eventEmitter,
-            action,
-            chatInfo,
-            query.traceId,
-            botName
-        );
-
-        this.queryText = query.query;
-        this.queryId = query.queryId;
-        this.abortSignal = query.abortController.signal;
-    }
-
-    /**
-     * This result will be shown to user as a response to inline query.
-     * @param queryResult Inline query result to be shown to user.
-     */
-    showInlineQueryResult(queryResult: TelegramInlineQueryResult) {
-        this.queryResults.push(queryResult);
-    }
-}

package/src/entities/context/messageContext.ts

@@ -1,250 +0,0 @@
-import { resolve } from 'path';
-import { IActionState } from '../../types/actionState';
-import { ImageMessage } from '../../dtos/responses/imageMessage';
-import { Reaction } from '../../dtos/responses/reaction';
-import { TextMessage } from '../../dtos/responses/textMessage';
-import { VideoMessage } from '../../dtos/responses/videoMessage';
-import { ChatContextInternal } from './chatContext';
-import {
-    MessageSendingOptions,
-    TextMessageSendingOptions
-} from '../../types/messageSendingOptions';
-import { ReplyInfo } from '../../dtos/replyInfo';
-import { CommandAction } from '../actions/commandAction';
-import { Seconds } from '../../types/timeValues';
-import { BaseContextPropertiesToOmit } from './baseContext';
-import { MessageInfo } from '../../dtos/messageInfo';
-import { UserInfo } from '../../dtos/userInfo';
-import { BotInfo, TelegramEmoji } from '../../types/externalAliases';
-import { TypedEventEmitter } from '../../types/events';
-import { IScheduler } from '../../types/scheduler';
-import { IStorageClient } from '../../types/storage';
-import { IncomingMessage } from '../../dtos/incomingMessage';
-
-export type MessageContext<TActionState extends IActionState> = Omit<
-    MessageContextInternal<TActionState>,
-    BaseContextPropertiesToOmit | 'startCooldown' | 'customCooldown'
->;
-
-/**
- * Context of action executed in chat, in response to a message
- */
-export class MessageContextInternal<
-    TActionState extends IActionState
-> extends ChatContextInternal<TActionState, CommandAction<TActionState>> {
-    /** Information about the user that triggered this action */
-    readonly userInfo!: UserInfo;
-    /** Information about the message that triggered this action */
-    readonly messageInfo!: MessageInfo;
-    /** Bot info from Telegram */
-    readonly botInfo!: BotInfo;
-    /** Indicates if cooldown should be started after action is executed. Set to `true` by default. */
-    startCooldown: boolean = true;
-    /** Custom cooldown duration in seconds, if specified. */
-    customCooldown: Seconds | undefined;
-    /** Collection of Regexp match results on a message that triggered this action. Will be empty if trigger is not a Regexp. */
-    matchResults: RegExpMatchArray[] = [];
-
-    constructor(
-        storage: IStorageClient,
-        scheduler: IScheduler,
-        eventEmitter: TypedEventEmitter,
-        action: CommandAction<TActionState>,
-        message: IncomingMessage,
-        botName: string,
-        botInfo: BotInfo
-    ) {
-        super(
-            storage,
-            scheduler,
-            eventEmitter,
-            action,
-            message.chatInfo,
-            message.traceId,
-            botName
-        );
-
-        this.messageInfo = new MessageInfo(
-            message.messageId,
-            message.text,
-            message.type,
-            message.updateObject
-        );
-        this.userInfo = new UserInfo(
-            message.from?.id ?? -1,
-            (message.from?.first_name ?? 'Unknown user') +
-                (message.from?.last_name ? ` ${message.from.last_name}` : '')
-        );
-
-        this.botInfo = botInfo;
-    }
-
-    private getQuotePart(quote: boolean | string) {
-        if (typeof quote != 'boolean') return quote;
-
-        return this.matchResults.length == 0
-            ? this.messageInfo.text
-            : this.matchResults[0][1];
-    }
-
-    private replyWithText(
-        text: string,
-        quote: boolean | string,
-        options?: TextMessageSendingOptions
-    ) {
-        const quotedPart = this.getQuotePart(quote);
-
-        const response = new TextMessage(
-            text,
-            this.chatInfo,
-            this.observability.traceId,
-            this.action,
-            new ReplyInfo(this.messageInfo.id, quote ? quotedPart : undefined),
-            options
-        );
-
-        this.responses.push(response);
-
-        return this.createCaptureController(response);
-    }
-
-    private replyWithImage(
-        name: string,
-        quote: boolean | string,
-        options?: MessageSendingOptions
-    ) {
-        const quotedPart = this.getQuotePart(quote);
-
-        const response = new ImageMessage(
-            { source: resolve(`./content/${name}.png`) },
-            this.chatInfo,
-            this.observability.traceId,
-            this.action,
-            new ReplyInfo(this.messageInfo.id, quote ? quotedPart : undefined),
-            options
-        );
-
-        this.responses.push(response);
-
-        return this.createCaptureController(response);
-    }
-
-    private replyWithVideo(
-        name: string,
-        quote: boolean | string,
-        options?: MessageSendingOptions
-    ) {
-        const quotedPart = this.getQuotePart(quote);
-
-        const response = new VideoMessage(
-            { source: resolve(`./content/${name}.mp4`) },
-            this.chatInfo,
-            this.observability.traceId,
-            this.action,
-            new ReplyInfo(this.messageInfo.id, quote ? quotedPart : undefined),
-            options
-        );
-
-        this.responses.push(response);
-
-        return this.createCaptureController(response);
-    }
-
-    skipCooldown() {
-        this.startCooldown = false;
-    }
-
-    startCustomCooldown(customCooldown: Seconds) {
-        this.startCooldown = true;
-        this.customCooldown = customCooldown;
-    }
-
-    /**
-     * 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,
-                quote?: string,
-                options?: TextMessageSendingOptions
-            ) => this.replyWithText(text, quote ?? 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,
-                quote?: string,
-                options?: MessageSendingOptions
-            ) => this.replyWithImage(name, quote ?? 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,
-                quote?: string,
-                options?: MessageSendingOptions
-            ) => this.replyWithVideo(name, quote ?? 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.observability.traceId,
-                    this.chatInfo,
-                    this.messageInfo.id,
-                    emoji,
-                    this.action
-                )
-            );
-        }
-    };
-}