chz-telegram-bot 0.7.13 → 0.7.15

package/src/entities/context/replyContext.ts

@@ -1,260 +0,0 @@
-import { ReplyInfo } from '../../dtos/replyInfo';
-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 { IActionState } from '../../types/actionState';
-import {
-    TextMessageSendingOptions,
-    MessageSendingOptions
-} from '../../types/messageSendingOptions';
-import { ReplyCaptureAction } from '../actions/replyCaptureAction';
-import { resolve } from 'path';
-import {
-    BaseContextInternal,
-    BaseContextPropertiesToOmit
-} from './baseContext';
-import { UserInfo } from '../../dtos/userInfo';
-import { MessageInfo } from '../../dtos/messageInfo';
-import {
-    TelegramUser,
-    TelegramEmoji,
-    BotInfo
-} 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 ReplyContext<TActionState extends IActionState> = Omit<
-    ReplyContextInternal<TActionState>,
-    | BaseContextPropertiesToOmit
-    | 'messageId'
-    | 'startCooldown'
-    | 'customCooldown'
->;
-
-export class ReplyContextInternal<
-    TParentActionState extends IActionState
-> extends BaseContextInternal<ReplyCaptureAction<TParentActionState>> {
-    /** Collection of Regexp match results on a message that triggered this action. Will be empty if trigger is not a Regexp. */
-    matchResults: RegExpExecArray[] = [];
-    /** Id of a message that triggered this action. */
-    readonly replyMessageId: number | undefined;
-    /** 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: TelegramUser;
-
-    constructor(
-        storage: IStorageClient,
-        scheduler: IScheduler,
-        eventEmitter: TypedEventEmitter,
-        action: ReplyCaptureAction<TParentActionState>,
-        message: IncomingMessage,
-        botName: string,
-        botInfo: BotInfo
-    ) {
-        super(
-            storage,
-            scheduler,
-            eventEmitter,
-            action,
-            message.chatInfo,
-            message.traceId,
-            botName
-        );
-
-        this.replyMessageId = message.replyToMessageId;
-        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);
-    }
-
-    /**
-     * Stops capturing replies and removes this action
-     */
-    stopCapture() {
-        this.action.abortController.abort();
-    }
-
-    /**
-     * 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
-            ) => {
-                return 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
-            ) => {
-                return 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
-            ) => {
-                return 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) => {
-            return 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) => {
-            return 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) => {
-            return 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
-                )
-            );
-        }
-    };
-}

package/src/entities/states/actionStateBase.ts

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

package/src/entities/taskRecord.ts

@@ -1,11 +0,0 @@
-import { Milliseconds } from '../types/timeValues';
-import { TraceId } from '../types/trace';
-
-export class TaskRecord {
-    constructor(
-        readonly name: string,
-        readonly taskId: NodeJS.Timeout,
-        readonly interval: Milliseconds,
-        readonly traceId: TraceId
-    ) {}
-}

package/src/helpers/builders/commandActionBuilder.ts

@@ -1,214 +0,0 @@
-import { CommandHandler } from '../../types/handlers';
-import { CommandCondition } from '../../types/commandCondition';
-import { Seconds } from '../../types/timeValues';
-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';
-import { CommandTrigger } from '../../types/commandTrigger';
-import { CooldownInfo } from '../../dtos/cooldownInfo';
-import { CommandActionPropertyProvider } from '../../types/propertyProvider';
-
-/**
- * Builder for `CommandAction` with state represented by `TActionState`
- */
-export class CommandActionBuilderWithState<TActionState extends IActionState> {
-    private readonly name: string;
-    private trigger: CommandTrigger | CommandTrigger[] = [];
-
-    private activeProvider: CommandActionPropertyProvider<boolean> = () => true;
-    private cooldownSettingsProvider: CommandActionPropertyProvider<CooldownInfo> =
-        () => new CooldownInfo(0 as Seconds);
-    private blacklistProvider: CommandActionPropertyProvider<number[]> =
-        () => [];
-    private whitelistProvider: CommandActionPropertyProvider<number[]> =
-        () => [];
-    private allowedUsersProvider: CommandActionPropertyProvider<number[]> =
-        () => [];
-
-    private readmeFactory: (botName: string) => string = Noop.emptyString;
-    private readonly stateConstructor: () => TActionState;
-    private handler: CommandHandler<TActionState> = Noop.call;
-    private condition: CommandCondition<TActionState> = Noop.true;
-    private maxAllowedSimultaniousExecutions: number = 0;
-
-    /**
-     * Builder for `CommandAction` with state represented by `TActionState`
-     * @param name Action name, will be used for logging and storage
-     * @param stateConstructor Function that creates default state object
-     */
-    constructor(name: string, stateConstructor: () => TActionState) {
-        this.name = name;
-        this.stateConstructor = stateConstructor;
-    }
-
-    /**
-     * Defines action trigger
-     * @param trigger If `string` or `string[]` is provided, will be triggered only on exact message match.
-     *
-     * If `RegExp` or `RegExp[]` is provided, will be triggered on successful match.
-     */
-    on(trigger: CommandTrigger | CommandTrigger[]) {
-        this.trigger = trigger;
-
-        return this;
-    }
-
-    /** Defines id (or ids) of users that are allowed to trigger this action.
-     * @param id User id or ids
-     */
-    from(id: number | number[]) {
-        const ids = toArray(id);
-        this.allowedUsersProvider = () => ids;
-
-        return this;
-    }
-
-    /**
-     * Sets chats whitelist for this action.
-     * @param chatIds Chats ids to allow.
-     */
-    in(chatIds: number[]) {
-        this.whitelistProvider = () => chatIds;
-
-        return this;
-    }
-
-    /**
-     * Sets chats blacklist for this action.
-     * @param chatIds Chats ids to ignore.
-     */
-    notIn(chatIds: number[]) {
-        this.blacklistProvider = () => chatIds;
-
-        return this;
-    }
-
-    /** Defines action logic itself, will be executed on trigger.
-     * @param handler Callback that will be called on trigger
-     */
-    do(handler: CommandHandler<TActionState>) {
-        this.handler = handler;
-
-        return this;
-    }
-
-    /** Defines condition that will be checked before trigger match check is executed.
-     * @param condition Condition check predicate
-     */
-    when(condition: CommandCondition<TActionState>) {
-        this.condition = condition;
-
-        return this;
-    }
-
-    /**
-     * Sets factory method for readme (shown on /help) for this action.
-     * @param readmeFactory readme factory
-     */
-    withHelp(readmeFactory: (botName: string) => string) {
-        this.readmeFactory = readmeFactory;
-
-        return this;
-    }
-
-    /** If called during building, action is marked as disabled and never checked. */
-    disabled() {
-        this.activeProvider = () => false;
-
-        return this;
-    }
-
-    /** Sets maximum number of simultaniously executing handlers for this command per chat. 0 is treated as unlimited. */
-    withRatelimit(maxAllowedSimultaniousExecutions: number) {
-        this.maxAllowedSimultaniousExecutions =
-            maxAllowedSimultaniousExecutions;
-
-        return this;
-    }
-
-    /** Sets action cooldown settings.
-     * @param cooldownSettings Settings.
-     */
-    withCooldown(cooldownSettings: { cooldown: Seconds; message?: string }) {
-        const settings = new CooldownInfo(
-            cooldownSettings.cooldown,
-            cooldownSettings.message
-        );
-        this.cooldownSettingsProvider = () => settings;
-
-        return this;
-    }
-
-    /**
-     * Configures action to use property value providers instead of static value to allow changes in runtime
-     */
-    withConfiguration(
-        configuration:
-            | CommandActionProvidersConfiguration
-            | (() => CommandActionProvidersConfiguration)
-    ) {
-        if (typeof configuration == 'function') {
-            configuration = configuration();
-        }
-
-        if (configuration.cooldownProvider)
-            this.cooldownSettingsProvider = configuration.cooldownProvider;
-
-        if (configuration.chatsWhitelistProvider)
-            this.whitelistProvider = configuration.chatsWhitelistProvider;
-
-        if (configuration.chatsBlacklistProvider)
-            this.blacklistProvider = configuration.chatsBlacklistProvider;
-
-        if (configuration.usersWhitelistProvider)
-            this.allowedUsersProvider = configuration.usersWhitelistProvider;
-
-        if (configuration.isActiveProvider)
-            this.activeProvider = configuration.isActiveProvider;
-
-        return this;
-    }
-
-    /** Builds action */
-    build() {
-        return new CommandAction(
-            this.trigger,
-            this.handler,
-            this.name,
-            {
-                cooldownProvider: this.cooldownSettingsProvider,
-                isActiveProvider: this.activeProvider,
-                chatsBlacklistProvider: this.blacklistProvider,
-                chatsWhitelistProvider: this.whitelistProvider,
-                usersWhitelistProvider: this.allowedUsersProvider,
-                maxAllowedSimultaniousExecutions:
-                    this.maxAllowedSimultaniousExecutions
-            },
-            this.condition,
-            this.stateConstructor,
-            this.readmeFactory
-        );
-    }
-}
-
-export type CommandActionProvidersConfiguration = {
-    cooldownProvider?: CommandActionPropertyProvider<CooldownInfo>;
-    isActiveProvider?: CommandActionPropertyProvider<boolean>;
-    chatsBlacklistProvider?: CommandActionPropertyProvider<number[]>;
-    chatsWhitelistProvider?: CommandActionPropertyProvider<number[]>;
-    usersWhitelistProvider?: CommandActionPropertyProvider<number[]>;
-};
-
-/**
- * Builder for `CommandAction` with state represented by default state (containing only last execution date).
- */
-export class CommandActionBuilder extends CommandActionBuilderWithState<ActionStateBase> {
-    /**
-     * Builder for `CommandAction` with state represented by default state (containing only last execution date).
-     */
-    constructor(name: string) {
-        super(name, () => new ActionStateBase());
-    }
-}

package/src/helpers/builders/inlineQueryActionBuilder.ts

@@ -1,71 +0,0 @@
-import { InlineQueryHandler } from '../../types/handlers';
-import { Noop } from '../noop';
-import { InlineQueryAction } from '../../entities/actions/inlineQueryAction';
-import { InlineActionPropertyProvider } from '../../types/propertyProvider';
-
-/**
- * Builder for `InlineQueryAction`
- */
-export class InlineQueryActionBuilder {
-    private readonly name: string;
-    private pattern: RegExp = /.+/gi;
-
-    private activeProvider: InlineActionPropertyProvider<boolean> = () => true;
-    private handler: InlineQueryHandler = Noop.call;
-
-    /**
-     * Builder for `InlineQueryAction`
-     * @param name Action name, will be used for logging and storage
-     */
-    constructor(name: string) {
-        this.name = name;
-    }
-
-    /**
-     * Defines action pattern to check if action should be executed, if not setup, check will default to true
-     * @param trigger RegExp to check
-     */
-    on(pattern: RegExp) {
-        this.pattern = pattern;
-
-        return this;
-    }
-
-    /** Defines action logic itself, will be executed.
-     * @param handler Callback that will be called
-     */
-    do(handler: InlineQueryHandler) {
-        this.handler = handler;
-
-        return this;
-    }
-
-    /** If called during building, action is marked as disabled and never checked. */
-    disabled() {
-        this.activeProvider = () => false;
-
-        return this;
-    }
-
-    /**
-     * Configures action to use property value providers instead of static value to allow changes in runtime
-     */
-    withConfiguration(configuration: {
-        isActiveProvider?: InlineActionPropertyProvider<boolean>;
-    }) {
-        if (configuration.isActiveProvider)
-            this.activeProvider = configuration.isActiveProvider;
-
-        return this;
-    }
-
-    /** Builds action */
-    build() {
-        return new InlineQueryAction(
-            this.handler,
-            this.name,
-            this.activeProvider,
-            this.pattern
-        );
-    }
-}