chz-telegram-bot 0.5.4 → 0.6.8

package/dist/entities/actions/scheduledAction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduledAction.d.ts","sourceRoot":"","sources":["../../../entities/actions/scheduledAction.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,IAAI,SAAS,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAGxD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAI7D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAG3E,qBAAa,eAAe,CAAC,YAAY,SAAS,YAAY,CAC1D,YAAW,gBAAgB,CAAC,YAAY,CAAC;IAEzC,MAAM,CAAC,QAAQ,CAAC,KAAK,yBAAgC;IAErD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC;IAExB,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAA8C;IAClF,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA2C;IAC1E,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAErC;IAEF,QAAQ,CAAC,WAAW,uBAA8B;IAClD,QAAQ,CAAC,gBAAgB,EAAE,MAAM,YAAY,CAAC;IAC9C,QAAQ,CAAC,oBAAoB,EAAE,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAC/D,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;gBAG7C,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,gBAAgB,CAAC,YAAY,CAAC,EACvC,SAAS,EAAE,wBAAwB,EACnC,oBAAoB,EAAE,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,EACrD,gBAAgB,EAAE,MAAM,YAAY;IAclC,IAAI,CAAC,GAAG,EAAE,mBAAmB,CAAC,YAAY,CAAC;YAgDnC,cAAc;IA2D5B,OAAO,CAAC,uBAAuB;CAgBlC"}

package/dist/entities/actions/scheduledAction.js

@@ -0,0 +1,92 @@
+import moment from 'moment';
+import { Sema as Semaphore } from 'async-sema';
+import { hoursToMilliseconds } from '../../helpers/timeConvertions';
+import { Noop } from '../../helpers/noop';
+import { getOrSetIfNotExists, getOrThrow } from '../../helpers/mapUtils';
+import { BotEventType } from '../../types/events';
+export class ScheduledAction {
+    static locks = new Map();
+    name;
+    key;
+    timeinHoursProvider;
+    activeProvider;
+    chatsWhitelistProvider;
+    cachedState = new Map();
+    stateConstructor;
+    cachedStateFactories;
+    handler;
+    constructor(name, handler, providers, cachedStateFactories, stateConstructor) {
+        this.name = name;
+        this.key = `scheduled:${this.name.replace('.', '-')}`;
+        this.timeinHoursProvider = providers.timeinHoursProvider;
+        this.activeProvider = providers.isActiveProvider;
+        this.chatsWhitelistProvider = providers.chatsWhitelistProvider;
+        this.cachedStateFactories = cachedStateFactories;
+        this.stateConstructor = stateConstructor;
+        this.handler = handler;
+    }
+    async exec(ctx) {
+        if (!ctx.isInitialized)
+            throw new Error(`Context for ${this.key} is not initialized or already consumed`);
+        if (!this.activeProvider(ctx) ||
+            !this.chatsWhitelistProvider(ctx).includes(ctx.chatInfo.id))
+            return Noop.NoResponse;
+        const state = await ctx.storage.getActionState(this, ctx.chatInfo.id);
+        const isAllowedToTrigger = this.checkIfShouldBeExecuted(state, ctx);
+        if (!isAllowedToTrigger)
+            return Noop.NoResponse;
+        ctx.eventEmitter.emit(BotEventType.scheduledActionExecuting, {
+            action: this,
+            ctx,
+            state
+        });
+        await this.handler(ctx, (key) => this.getCachedValue(key, ctx), state);
+        state.lastExecutedDate = moment().valueOf();
+        await ctx.storage.saveActionExecutionResult(this, ctx.chatInfo.id, state);
+        ctx.eventEmitter.emit(BotEventType.scheduledActionExecuted, {
+            action: this,
+            ctx,
+            state
+        });
+        return ctx.responses;
+    }
+    async getCachedValue(key, ctx) {
+        const cachedItemFactory = getOrThrow(this.cachedStateFactories, key, `No shared cache was set up for the key [${key}] in action '${this.name}'`);
+        const semaphoreKey = `${this.key}_cached:${key}`;
+        const semaphore = getOrSetIfNotExists(ScheduledAction.locks, semaphoreKey, new Semaphore(1));
+        await semaphore.acquire();
+        try {
+            if (this.cachedState.has(key)) {
+                return this.cachedState.get(key);
+            }
+            ctx.eventEmitter.emit(BotEventType.scheduledActionCacheValueCreating, {
+                action: this,
+                ctx,
+                key
+            });
+            const value = await cachedItemFactory.getValue();
+            this.cachedState.set(key, value);
+            ctx.scheduler.createOnetimeTask(`Drop cached value [${this.name} : ${key}]`, () => this.cachedState.delete(key), hoursToMilliseconds(cachedItemFactory.invalidationTimeoutInHours), ctx.botName);
+            return value;
+        }
+        finally {
+            ctx.eventEmitter.emit(BotEventType.scheduledActionCacheValueReturned, {
+                action: this,
+                ctx,
+                key
+            });
+            semaphore.release();
+        }
+    }
+    checkIfShouldBeExecuted(state, ctx) {
+        const startOfToday = moment().startOf('day').valueOf();
+        const lastExecutedDate = moment(state.lastExecutedDate);
+        const currentTime = moment();
+        const scheduledTime = moment()
+            .startOf('day')
+            .add(this.timeinHoursProvider(ctx), 'hours');
+        const isAllowedToTrigger = currentTime.isSameOrAfter(scheduledTime);
+        const hasTriggeredToday = lastExecutedDate.isAfter(startOfToday);
+        return isAllowedToTrigger && !hasTriggeredToday;
+    }
+}

package/dist/entities/botInstance.d.ts

@@ -0,0 +1,36 @@
+import { Seconds } from '../types/timeValues';
+import { IStorageClient } from '../types/storage';
+import { IActionState } from '../types/actionState';
+import { CommandAction } from './actions/commandAction';
+import { ScheduledAction } from './actions/scheduledAction';
+import { IScheduler } from '../types/scheduler';
+import { InlineQueryAction } from './actions/inlineQueryAction';
+import { TypedEventEmitter } from '../types/events';
+export declare class BotInstance {
+    private readonly storage;
+    private readonly scheduler;
+    private readonly actionProcessingService;
+    readonly name: string;
+    readonly eventEmitter: TypedEventEmitter;
+    constructor(options: {
+        name: string;
+        actions: {
+            commands: CommandAction<IActionState>[];
+            scheduled: ScheduledAction<IActionState>[];
+            inlineQueries: InlineQueryAction[];
+        };
+        chats: Record<string, number>;
+        storagePath?: string;
+        services?: {
+            storageClient?: IStorageClient;
+            scheduler?: IScheduler;
+        };
+    });
+    start(token: string, actions: {
+        commands: CommandAction<IActionState>[];
+        scheduled: ScheduledAction<IActionState>[];
+        inlineQueries: InlineQueryAction[];
+    }, scheduledPeriod?: Seconds): Promise<void>;
+    stop(): Promise<void>;
+}
+//# sourceMappingURL=botInstance.d.ts.map

package/dist/entities/botInstance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"botInstance.d.ts","sourceRoot":"","sources":["../../entities/botInstance.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAEhE,OAAO,EAAgB,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAElE,qBAAa,WAAW;IACpB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiB;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAa;IACvC,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAA0B;IAElE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,YAAY,oBAA2B;gBAEpC,OAAO,EAAE;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE;YACL,QAAQ,EAAE,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC;YACxC,SAAS,EAAE,eAAe,CAAC,YAAY,CAAC,EAAE,CAAC;YAC3C,aAAa,EAAE,iBAAiB,EAAE,CAAC;SACtC,CAAC;QACF,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE;YACP,aAAa,CAAC,EAAE,cAAc,CAAC;YAC/B,SAAS,CAAC,EAAE,UAAU,CAAC;SAC1B,CAAC;KACL;IA4BK,KAAK,CACP,KAAK,EAAE,MAAM,EACb,OAAO,EAAE;QACL,QAAQ,EAAE,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC;QACxC,SAAS,EAAE,eAAe,CAAC,YAAY,CAAC,EAAE,CAAC;QAC3C,aAAa,EAAE,iBAAiB,EAAE,CAAC;KACtC,EACD,eAAe,CAAC,EAAE,OAAO;IAavB,IAAI;CASb"}

package/dist/entities/botInstance.js

@@ -0,0 +1,39 @@
+import { JsonFileStorage } from '../services/jsonFileStorage';
+import { NodeTimeoutScheduler } from '../services/nodeTimeoutScheduler';
+import { ActionProcessingService } from '../services/actionProcessingService';
+import { BotEventType, TypedEventEmitter } from '../types/events';
+export class BotInstance {
+    storage;
+    scheduler;
+    actionProcessingService;
+    name;
+    eventEmitter = new TypedEventEmitter();
+    constructor(options) {
+        const actions = [
+            ...options.actions.commands,
+            ...options.actions.scheduled
+        ];
+        this.name = options.name;
+        this.scheduler =
+            options.services?.scheduler ??
+                new NodeTimeoutScheduler(this.eventEmitter);
+        this.storage =
+            options.services?.storageClient ??
+                new JsonFileStorage(options.name, actions, this.eventEmitter, options.storagePath);
+        this.actionProcessingService = new ActionProcessingService(this.name, options.chats, this.storage, this.scheduler, this.eventEmitter);
+    }
+    async start(token, actions, scheduledPeriod) {
+        this.eventEmitter.emit(BotEventType.botStarting, {
+            botName: this.name
+        });
+        await this.actionProcessingService.initialize(token, actions, scheduledPeriod);
+    }
+    async stop() {
+        this.eventEmitter.emit(BotEventType.botStopping, {
+            botName: this.name
+        });
+        this.scheduler.stopAll();
+        await this.storage.close();
+        this.actionProcessingService.stop();
+    }
+}

package/dist/entities/cachedStateFactory.d.ts

@@ -0,0 +1,7 @@
+import { Hours } from '../types/timeValues';
+export declare class CachedStateFactory {
+    readonly getValue: () => Promise<unknown>;
+    readonly invalidationTimeoutInHours: Hours;
+    constructor(itemFactory: () => Promise<unknown>, invalidationTimeout: Hours);
+}
+//# sourceMappingURL=cachedStateFactory.d.ts.map

package/dist/entities/cachedStateFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cachedStateFactory.d.ts","sourceRoot":"","sources":["../../entities/cachedStateFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAE5C,qBAAa,kBAAkB;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1C,QAAQ,CAAC,0BAA0B,EAAE,KAAK,CAAC;gBAGvC,WAAW,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,EACnC,mBAAmB,EAAE,KAAK;CAKjC"}

package/dist/entities/cachedStateFactory.js

@@ -0,0 +1,8 @@
+export class CachedStateFactory {
+    getValue;
+    invalidationTimeoutInHours;
+    constructor(itemFactory, invalidationTimeout) {
+        this.getValue = itemFactory;
+        this.invalidationTimeoutInHours = invalidationTimeout;
+    }
+}

package/dist/entities/context/baseContext.d.ts

@@ -0,0 +1,39 @@
+import { ChatInfo } from '../../dtos/chatInfo';
+import { IAction, IActionWithState } from '../../types/action';
+import { IActionState } from '../../types/actionState';
+import { ICaptureController } from '../../types/capture';
+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';
+export type BaseContextPropertiesToOmit = 'action' | 'isInitialized' | 'storage' | 'scheduler' | 'eventEmitter' | 'responses' | 'traceId';
+export declare abstract class BaseContextInternal<TAction extends IAction> {
+    isInitialized: boolean;
+    private _responses;
+    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;
+    readonly eventEmitter: TypedEventEmitter;
+    /** Trace id of a action execution. */
+    traceId: TraceId;
+    /** Name of a bot that executes this action. */
+    botName: string;
+    /** Chat information. */
+    chatInfo: ChatInfo;
+    get actionKey(): import("../..").ActionKey;
+    /** Ordered collection of responses to be processed  */
+    get responses(): BotResponse[];
+    set responses(value: BotResponse[]);
+    constructor(storage: IStorageClient, scheduler: IScheduler, eventEmitter: TypedEventEmitter);
+    protected createCaptureController(response: IReplyResponse): ICaptureController;
+    /**
+     * 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>): Promise<Readonly<TAnotherActionState>>;
+}
+//# sourceMappingURL=baseContext.d.ts.map

package/dist/entities/context/baseContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseContext.d.ts","sourceRoot":"","sources":["../../../entities/context/baseContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAG5C,MAAM,MAAM,2BAA2B,GACjC,QAAQ,GACR,eAAe,GACf,SAAS,GACT,WAAW,GACX,cAAc,GACd,WAAW,GACX,SAAS,CAAC;AAEhB,8BAAsB,mBAAmB,CAAC,OAAO,SAAS,OAAO;IAC7D,aAAa,UAAS;IACtB,OAAO,CAAC,UAAU,CAAqB;IAEvC,MAAM,EAAG,OAAO,CAAC;IAEjB,iEAAiE;IACjE,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,2DAA2D;IAC3D,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;IAC/B,QAAQ,CAAC,YAAY,EAAE,iBAAiB,CAAC;IACzC,sCAAsC;IACtC,OAAO,EAAG,OAAO,CAAC;IAClB,+CAA+C;IAC/C,OAAO,EAAG,MAAM,CAAC;IACjB,wBAAwB;IACxB,QAAQ,EAAG,QAAQ,CAAC;IACpB,IAAI,SAAS,8BAEZ;IAED,uDAAuD;IACvD,IAAW,SAAS,IAAI,WAAW,EAAE,CAEpC;IACD,IAAW,SAAS,CAAC,KAAK,EAAE,WAAW,EAAE,EAExC;gBAGG,OAAO,EAAE,cAAc,EACvB,SAAS,EAAE,UAAU,EACrB,YAAY,EAAE,iBAAiB;IAOnC,SAAS,CAAC,uBAAuB,CAC7B,QAAQ,EAAE,cAAc,GACzB,kBAAkB;IAmBrB;;;;OAIG;IACG,WAAW,CAAC,mBAAmB,SAAS,YAAY,EACtD,MAAM,EAAE,gBAAgB,CAAC,mBAAmB,CAAC;CAWpD"}

package/dist/entities/context/baseContext.js

@@ -0,0 +1,56 @@
+export class BaseContextInternal {
+    isInitialized = false;
+    _responses = [];
+    action;
+    /** Storage client instance for the bot executing this action. */
+    storage;
+    /** Scheduler instance for the bot executing this action */
+    scheduler;
+    eventEmitter;
+    /** Trace id of a action execution. */
+    traceId;
+    /** Name of a bot that executes this action. */
+    botName;
+    /** Chat information. */
+    chatInfo;
+    get actionKey() {
+        return this.action.key;
+    }
+    /** Ordered collection of responses to be processed  */
+    get responses() {
+        return this._responses;
+    }
+    set responses(value) {
+        this._responses = value;
+    }
+    constructor(storage, scheduler, eventEmitter) {
+        this.storage = storage;
+        this.scheduler = scheduler;
+        this.eventEmitter = eventEmitter;
+    }
+    createCaptureController(response) {
+        return {
+            captureReplies: (trigger, handler, 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.
+     */
+    async loadStateOf(action) {
+        const allStates = await this.storage.load(action.key);
+        const stateForChat = allStates[this.chatInfo.id];
+        if (!stateForChat) {
+            return Object.freeze(action.stateConstructor());
+        }
+        return Object.freeze(stateForChat);
+    }
+}

package/dist/entities/context/chatContext.d.ts

@@ -0,0 +1,50 @@
+import { MessageSendingOptions, TextMessageSendingOptions } from '../../types/messageSendingOptions';
+import { IActionWithState } from '../../types/action';
+import { IActionState } from '../../types/actionState';
+import { Milliseconds } from '../../types/timeValues';
+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 declare 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) => import("../..").ICaptureController;
+        /**
+         * 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) => import("../..").ICaptureController;
+        /**
+         * 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) => import("../..").ICaptureController;
+    };
+    /**
+     * 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): void;
+    /**
+     * Delays next responses by specified amount of time.
+     * @param delay Delay in milliseconds.
+     */
+    wait(delay: Milliseconds): void;
+}
+//# sourceMappingURL=chatContext.d.ts.map

package/dist/entities/context/chatContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chatContext.d.ts","sourceRoot":"","sources":["../../../entities/context/chatContext.ts"],"names":[],"mappings":"AAKA,OAAO,EACH,qBAAqB,EACrB,yBAAyB,EAC5B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD,OAAO,EACH,mBAAmB,EACnB,2BAA2B,EAC9B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAE7D,MAAM,MAAM,WAAW,CACnB,YAAY,SAAS,YAAY,EACjC,OAAO,SAAS,gBAAgB,CAAC,YAAY,CAAC,GAAG,eAAe,CAAC,YAAY,CAAC,IAC9E,IAAI,CACJ,mBAAmB,CAAC,YAAY,EAAE,OAAO,CAAC,EAC1C,2BAA2B,CAC9B,CAAC;AAEF;;GAEG;AACH,qBAAa,mBAAmB,CAC5B,YAAY,SAAS,YAAY,EACjC,OAAO,SAAS,gBAAgB,CAAC,YAAY,CAAC,GAAG,eAAe,CAAC,YAAY,CAAC,CAChF,SAAQ,mBAAmB,CAAC,OAAO,CAAC;IAClC;;OAEG;IACH,IAAI;QACA;;;;;WAKG;qBACU,MAAM,YAAY,yBAAyB;QAexD;;;;;WAKG;sBACW,MAAM,YAAY,qBAAqB;QAerD;;;;;WAKG;sBACW,MAAM,YAAY,qBAAqB;MAcvD;IAEF;;;;OAIG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM;IAW9B;;;OAGG;IACH,IAAI,CAAC,KAAK,EAAE,YAAY;CAK3B"}

package/dist/entities/context/chatContext.js

@@ -0,0 +1,65 @@
+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 { DelayResponse } from '../../dtos/responses/delay';
+import { BaseContextInternal } from './baseContext';
+/**
+ * Context of action executed in chat.
+ */
+export class ChatContextInternal extends BaseContextInternal {
+    /**
+     * 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, options) => {
+            const response = new TextMessage(text, this.chatInfo, this.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, options) => {
+            const response = new ImageMessage({ source: resolve(`./content/${name}.png`) }, this.chatInfo, this.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, options) => {
+            const response = new VideoMessage({ source: resolve(`./content/${name}.mp4`) }, this.chatInfo, this.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) {
+        this.responses.push(new UnpinResponse(messageId, this.chatInfo, this.traceId, this.action));
+    }
+    /**
+     * Delays next responses by specified amount of time.
+     * @param delay Delay in milliseconds.
+     */
+    wait(delay) {
+        this.responses.push(new DelayResponse(delay, this.chatInfo, this.traceId, this.action));
+    }
+}

package/dist/entities/context/inlineQueryContext.d.ts

@@ -0,0 +1,27 @@
+import { BotResponse } from '../../types/response';
+import { InlineQueryAction } from '../actions/inlineQueryAction';
+import { BaseContextInternal, BaseContextPropertiesToOmit } from './baseContext';
+import { TelegramInlineQueryResult } from '../../types/externalAliases';
+export type InlineQueryContext = Omit<InlineQueryContextInternal, BaseContextPropertiesToOmit | 'queryResults' | 'queryId'>;
+export declare class InlineQueryContextInternal extends BaseContextInternal<InlineQueryAction> {
+    queryResults: TelegramInlineQueryResult[];
+    /**
+     * Abort signal to be utilized in query handler.
+     * Signal will be aborted if new query comes from the same user.
+     */
+    abortSignal: AbortSignal;
+    /** Ordered collection of responses to be processed  */
+    get responses(): BotResponse[];
+    /** Inline query text */
+    queryText: string;
+    /** Internal query id */
+    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[];
+    /**
+     * 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): void;
+}
+//# sourceMappingURL=inlineQueryContext.d.ts.map

package/dist/entities/context/inlineQueryContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inlineQueryContext.d.ts","sourceRoot":"","sources":["../../../entities/context/inlineQueryContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEjE,OAAO,EACH,mBAAmB,EACnB,2BAA2B,EAC9B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACjC,0BAA0B,EAC1B,2BAA2B,GAAG,cAAc,GAAG,SAAS,CAC3D,CAAC;AAEF,qBAAa,0BAA2B,SAAQ,mBAAmB,CAAC,iBAAiB,CAAC;IAClF,YAAY,EAAE,yBAAyB,EAAE,CAAM;IAC/C;;;OAGG;IACH,WAAW,EAAG,WAAW,CAAC;IAE1B,uDAAuD;IACvD,IAAI,SAAS,IAAI,WAAW,EAAE,CAS7B;IACD,wBAAwB;IACxB,SAAS,EAAG,MAAM,CAAC;IACnB,wBAAwB;IACxB,OAAO,EAAG,MAAM,CAAC;IACjB,4HAA4H;IAC5H,YAAY,EAAE,gBAAgB,EAAE,CAAM;IAEtC;;;OAGG;IACH,qBAAqB,CAAC,WAAW,EAAE,yBAAyB;CAG/D"}

package/dist/entities/context/inlineQueryContext.js

@@ -0,0 +1,29 @@
+import { InlineQueryResponse } from '../../dtos/responses/inlineQueryResponse';
+import { BaseContextInternal } from './baseContext';
+export class InlineQueryContextInternal extends BaseContextInternal {
+    queryResults = [];
+    /**
+     * Abort signal to be utilized in query handler.
+     * Signal will be aborted if new query comes from the same user.
+     */
+    abortSignal;
+    /** Ordered collection of responses to be processed  */
+    get responses() {
+        return [
+            new InlineQueryResponse(this.queryResults, this.queryId, this.traceId, this.action)
+        ];
+    }
+    /** Inline query text */
+    queryText;
+    /** Internal query id */
+    queryId;
+    /** Collection of Regexp match results on a message that triggered this action. Will be empty if trigger is not a Regexp. */
+    matchResults = [];
+    /**
+     * 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) {
+        this.queryResults.push(queryResult);
+    }
+}

package/dist/entities/context/messageContext.d.ts

@@ -0,0 +1,92 @@
+import { IActionState } from '../../types/actionState';
+import { ChatContextInternal } from './chatContext';
+import { MessageSendingOptions, TextMessageSendingOptions } from '../../types/messageSendingOptions';
+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';
+export type MessageContext<TActionState extends IActionState> = Omit<MessageContextInternal<TActionState>, BaseContextPropertiesToOmit | 'startCooldown' | 'customCooldown'>;
+/**
+ * Context of action executed in chat, in response to a message
+ */
+export declare class MessageContextInternal<TActionState extends IActionState> extends ChatContextInternal<TActionState, CommandAction<TActionState>> {
+    /** Information about the user that triggered this action */
+    userInfo: UserInfo;
+    /** Information about the message that triggered this action */
+    messageInfo: MessageInfo;
+    /** Collection of Regexp match results on a message that triggered this action. Will be empty if trigger is not a Regexp. */
+    matchResults: RegExpMatchArray[];
+    /** Indicates if cooldown should be started after action is executed. Set to `true` by default. */
+    startCooldown: boolean;
+    /** Bot info from Telegram */
+    botInfo: BotInfo;
+    customCooldown: Seconds | undefined;
+    private getQuotePart;
+    private replyWithText;
+    private replyWithImage;
+    private replyWithVideo;
+    skipCooldown(): void;
+    startCustomCooldown(customCooldown: Seconds): void;
+    /**
+     * 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) => import("../..").ICaptureController;
+            /**
+             * 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) => import("../..").ICaptureController;
+            /**
+             * 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) => import("../..").ICaptureController;
+        };
+        /**
+         * 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) => import("../..").ICaptureController;
+        /**
+         * 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) => import("../..").ICaptureController;
+        /**
+         * 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) => import("../..").ICaptureController;
+        /**
+         * 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) => void;
+    };
+}
+//# sourceMappingURL=messageContext.d.ts.map

package/dist/entities/context/messageContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messageContext.d.ts","sourceRoot":"","sources":["../../../entities/context/messageContext.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAKvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EACH,qBAAqB,EACrB,yBAAyB,EAC5B,MAAM,mCAAmC,CAAC;AAE3C,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAErE,MAAM,MAAM,cAAc,CAAC,YAAY,SAAS,YAAY,IAAI,IAAI,CAChE,sBAAsB,CAAC,YAAY,CAAC,EACpC,2BAA2B,GAAG,eAAe,GAAG,gBAAgB,CACnE,CAAC;AAEF;;GAEG;AACH,qBAAa,sBAAsB,CAC/B,YAAY,SAAS,YAAY,CACnC,SAAQ,mBAAmB,CAAC,YAAY,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IACpE,4DAA4D;IAC5D,QAAQ,EAAG,QAAQ,CAAC;IACpB,+DAA+D;IAC/D,WAAW,EAAG,WAAW,CAAC;IAC1B,4HAA4H;IAC5H,YAAY,EAAE,gBAAgB,EAAE,CAAM;IACtC,kGAAkG;IAClG,aAAa,EAAE,OAAO,CAAQ;IAC9B,6BAA6B;IAC7B,OAAO,EAAG,OAAO,CAAC;IAClB,cAAc,EAAE,OAAO,GAAG,SAAS,CAAC;IAEpC,OAAO,CAAC,YAAY;IAQpB,OAAO,CAAC,aAAa;IAqBrB,OAAO,CAAC,cAAc;IAqBtB,OAAO,CAAC,cAAc;IAqBtB,YAAY;IAIZ,mBAAmB,CAAC,cAAc,EAAE,OAAO;IAK3C;;OAEG;IACH,KAAK;QACD;;;WAGG;;YAEC;;;;;eAKG;6BAEO,MAAM,UACJ,MAAM,YACJ,yBAAyB;YAEvC;;;;;eAKG;8BAEO,MAAM,UACJ,MAAM,YACJ,qBAAqB;YAGnC;;;;;eAKG;8BAEO,MAAM,UACJ,MAAM,YACJ,qBAAqB;;QAIvC;;;;;WAKG;yBACc,MAAM,YAAY,yBAAyB;QAE5D;;;;;WAKG;0BACe,MAAM,YAAY,qBAAqB;QAGzD;;;;;WAKG;0BACe,MAAM,YAAY,qBAAqB;QAGzD;;;;WAIG;8BACmB,aAAa;MAWrC;CACL"}