chz-telegram-bot 0.5.4 → 0.5.5

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

@@ -0,0 +1 @@
+{"version":3,"file":"replyContext.d.ts","sourceRoot":"","sources":["../../../entities/context/replyContext.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EACH,yBAAyB,EACzB,qBAAqB,EACxB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAEnE,OAAO,EACH,mBAAmB,EACnB,2BAA2B,EAC9B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAE1E,MAAM,MAAM,YAAY,CAAC,YAAY,SAAS,YAAY,IAAI,IAAI,CAC9D,oBAAoB,CAAC,YAAY,CAAC,EAChC,2BAA2B,GAC3B,WAAW,GACX,eAAe,GACf,gBAAgB,CACrB,CAAC;AAEF,qBAAa,oBAAoB,CAC7B,kBAAkB,SAAS,YAAY,CACzC,SAAQ,mBAAmB,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,CAAC;IACjE,4HAA4H;IAC5H,YAAY,EAAG,eAAe,EAAE,CAAC;IACjC,kDAAkD;IAClD,cAAc,EAAG,MAAM,GAAG,SAAS,CAAC;IACpC,4DAA4D;IAC5D,QAAQ,EAAG,QAAQ,CAAC;IACpB,+DAA+D;IAC/D,WAAW,EAAG,WAAW,CAAC;IAC1B,6BAA6B;IAC7B,OAAO,EAAG,YAAY,CAAC;IAEvB,aAAa,UAAS;IAEtB,OAAO,CAAC,YAAY;IAQpB,OAAO,CAAC,aAAa;IAqBrB,OAAO,CAAC,cAAc;IAqBtB,OAAO,CAAC,cAAc;IAqBtB;;OAEG;IACH,WAAW;IAIX;;OAEG;IACH,KAAK;QACD;;;WAGG;;YAEC;;;;;eAKG;6BAEO,MAAM,UACJ,MAAM,YACJ,yBAAyB;YAIvC;;;;;eAKG;8BAEO,MAAM,UACJ,MAAM,YACJ,qBAAqB;YAKnC;;;;;eAKG;8BAEO,MAAM,UACJ,MAAM,YACJ,qBAAqB;;QAMvC;;;;;WAKG;yBACc,MAAM,YAAY,yBAAyB;QAG5D;;;;;WAKG;0BACe,MAAM,YAAY,qBAAqB;QAIzD;;;;;WAKG;0BACe,MAAM,YAAY,qBAAqB;QAIzD;;;;WAIG;8BACmB,aAAa;MAWrC;CACL"}

package/dist/entities/context/replyContext.js

@@ -0,0 +1,124 @@
+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 { resolve } from 'path';
+import { BaseContextInternal } from './baseContext';
+export class ReplyContextInternal extends BaseContextInternal {
+    /** Collection of Regexp match results on a message that triggered this action. Will be empty if trigger is not a Regexp. */
+    matchResults;
+    /** Id of a message that triggered this action. */
+    replyMessageId;
+    /** Information about the user that triggered this action */
+    userInfo;
+    /** Information about the message that triggered this action */
+    messageInfo;
+    /** Bot info from Telegram */
+    botInfo;
+    isInitialized = false;
+    getQuotePart(quote) {
+        if (typeof quote != 'boolean')
+            return quote;
+        return this.matchResults.length == 0
+            ? this.messageInfo.text
+            : this.matchResults[0][1];
+    }
+    replyWithText(text, quote, options) {
+        const quotedPart = this.getQuotePart(quote);
+        const response = new TextMessage(text, this.chatInfo, this.traceId, this.action, new ReplyInfo(this.messageInfo.id, quote ? quotedPart : undefined), options);
+        this.responses.push(response);
+        return this.createCaptureController(response);
+    }
+    replyWithImage(name, quote, options) {
+        const quotedPart = this.getQuotePart(quote);
+        const response = new ImageMessage({ source: resolve(`./content/${name}.png`) }, this.chatInfo, this.traceId, this.action, new ReplyInfo(this.messageInfo.id, quote ? quotedPart : undefined), options);
+        this.responses.push(response);
+        return this.createCaptureController(response);
+    }
+    replyWithVideo(name, quote, options) {
+        const quotedPart = this.getQuotePart(quote);
+        const response = new VideoMessage({ source: resolve(`./content/${name}.mp4`) }, this.chatInfo, this.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, quote, options) => {
+                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, quote, options) => {
+                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, quote, options) => {
+                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, options) => {
+            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, options) => {
+            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, options) => {
+            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) => {
+            this.responses.push(new Reaction(this.traceId, this.chatInfo, this.messageInfo.id, emoji, this.action));
+        }
+    };
+}

package/dist/entities/states/actionStateBase.d.ts

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

package/dist/entities/states/actionStateBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actionStateBase.d.ts","sourceRoot":"","sources":["../../../entities/states/actionStateBase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,qBAAa,eAAgB,YAAW,YAAY;IAChD,cAAc,EAAE,MAAM,EAAE,CAAM;IAC9B,gBAAgB,SAAK;CACxB"}

package/dist/entities/states/actionStateBase.js

@@ -0,0 +1,4 @@
+export class ActionStateBase {
+    pinnedMessages = [];
+    lastExecutedDate = 0;
+}

package/dist/entities/taskRecord.d.ts

@@ -0,0 +1,8 @@
+import { Milliseconds } from '../types/timeValues';
+export declare class TaskRecord {
+    readonly name: string;
+    readonly taskId: NodeJS.Timeout;
+    readonly interval: Milliseconds;
+    constructor(name: string, taskId: NodeJS.Timeout, interval: Milliseconds);
+}
+//# sourceMappingURL=taskRecord.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"taskRecord.d.ts","sourceRoot":"","sources":["../../entities/taskRecord.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,qBAAa,UAAU;IACnB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC;IAChC,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;gBAEpB,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY;CAK3E"}

package/dist/entities/taskRecord.js

@@ -0,0 +1,10 @@
+export class TaskRecord {
+    name;
+    taskId;
+    interval;
+    constructor(name, taskId, interval) {
+        this.name = name;
+        this.taskId = taskId;
+        this.interval = interval;
+    }
+}

package/dist/eslint.config.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("typescript-eslint").FlatConfig.ConfigArray;
+export default _default;
+//# sourceMappingURL=eslint.config.d.ts.map

package/dist/eslint.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eslint.config.d.ts","sourceRoot":"","sources":["../eslint.config.ts"],"names":[],"mappings":";AAIA,wBAoDE"}

package/dist/eslint.config.js

@@ -0,0 +1,51 @@
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import parser from '@typescript-eslint/parser';
+export default tseslint.config({
+    ignores: ['dist/**']
+}, eslint.configs.recommended, tseslint.configs.strictTypeChecked, {
+    languageOptions: {
+        parser,
+        parserOptions: {
+            project: './tsconfig.json',
+            tsconfigRootDir: __dirname,
+            sourceType: 'module',
+            projectService: true
+        }
+    },
+    plugins: { '@typescript-eslint': tseslint.plugin },
+    rules: {
+        '@typescript-eslint/switch-exhaustiveness-check': 'error',
+        '@typescript-eslint/no-unused-vars': [
+            'error',
+            {
+                args: 'all',
+                argsIgnorePattern: '^_',
+                caughtErrors: 'all',
+                caughtErrorsIgnorePattern: '^_',
+                destructuredArrayIgnorePattern: '^_',
+                varsIgnorePattern: '^_',
+                ignoreRestSiblings: true
+            }
+        ],
+        '@typescript-eslint/no-misused-promises': [
+            'error',
+            {
+                checksVoidReturn: true,
+                checksConditionals: true
+            }
+        ],
+        '@typescript-eslint/restrict-template-expressions': [
+            'error',
+            {
+                allowNumber: true
+            }
+        ],
+        '@typescript-eslint/unbound-method': [
+            'error',
+            {
+                ignoreStatic: true
+            }
+        ]
+    }
+});

package/dist/helpers/builders/commandActionBuilder.d.ts

@@ -0,0 +1,100 @@
+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 { CommandTrigger } from '../../types/commandTrigger';
+import { CooldownInfo } from '../../dtos/cooldownInfo';
+import { CommandActionPropertyProvider } from '../../types/propertyProvider';
+/**
+ * Builder for `CommandAction` with state represented by `TActionState`
+ */
+export declare class CommandActionBuilderWithState<TActionState extends IActionState> {
+    private readonly name;
+    private trigger;
+    private activeProvider;
+    private cooldownSettingsProvider;
+    private blacklistProvider;
+    private whitelistProvider;
+    private allowedUsersProvider;
+    private readmeFactory;
+    private readonly stateConstructor;
+    private handler;
+    private condition;
+    private maxAllowedSimultaniousExecutions;
+    /**
+     * 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);
+    /**
+     * 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;
+    /** Defines id (or ids) of users that are allowed to trigger this action.
+     * @param id User id or ids
+     */
+    from(id: number | number[]): this;
+    /**
+     * Sets chats whitelist for this action.
+     * @param chatIds Chats ids to allow.
+     */
+    in(chatIds: number[]): this;
+    /**
+     * Sets chats blacklist for this action.
+     * @param chatIds Chats ids to ignore.
+     */
+    notIn(chatIds: number[]): this;
+    /** Defines action logic itself, will be executed on trigger.
+     * @param handler Callback that will be called on trigger
+     */
+    do(handler: CommandHandler<TActionState>): this;
+    /** Defines condition that will be checked before trigger match check is executed.
+     * @param condition Condition check predicate
+     */
+    when(condition: CommandCondition<TActionState>): this;
+    /**
+     * Sets factory method for readme (shown on /help) for this action.
+     * @param readmeFactory readme factory
+     */
+    withHelp(readmeFactory: (botName: string) => string): this;
+    /** If called during building, action is marked as disabled and never checked. */
+    disabled(): this;
+    /** Sets maximum number of simultaniously executing handlers for this command per chat. 0 is treated as unlimited. */
+    withRatelimit(maxAllowedSimultaniousExecutions: number): this;
+    /** Sets action cooldown settings.
+     * @param cooldownSettings Settings.
+     */
+    withCooldown(cooldownSettings: {
+        cooldown: Seconds;
+        message?: string;
+    }): this;
+    /**
+     * Configures action to use property value providers instead of static value to allow changes in runtime
+     */
+    withConfiguration(configuration: CommandActionProvidersConfiguration | (() => CommandActionProvidersConfiguration)): this;
+    /** Builds action */
+    build(): CommandAction<TActionState>;
+}
+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 declare class CommandActionBuilder extends CommandActionBuilderWithState<ActionStateBase> {
+    /**
+     * Builder for `CommandAction` with state represented by default state (containing only last execution date).
+     */
+    constructor(name: string);
+}
+//# sourceMappingURL=commandActionBuilder.d.ts.map

package/dist/helpers/builders/commandActionBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commandActionBuilder.d.ts","sourceRoot":"","sources":["../../../helpers/builders/commandActionBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAGvD,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,6BAA6B,EAAE,MAAM,8BAA8B,CAAC;AAE7E;;GAEG;AACH,qBAAa,6BAA6B,CAAC,YAAY,SAAS,YAAY;IACxE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAC9B,OAAO,CAAC,OAAO,CAAyC;IAExD,OAAO,CAAC,cAAc,CAAsD;IAC5E,OAAO,CAAC,wBAAwB,CACS;IACzC,OAAO,CAAC,iBAAiB,CACZ;IACb,OAAO,CAAC,iBAAiB,CACZ;IACb,OAAO,CAAC,oBAAoB,CACf;IAEb,OAAO,CAAC,aAAa,CAAiD;IACtE,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAqB;IACtD,OAAO,CAAC,OAAO,CAA2C;IAC1D,OAAO,CAAC,SAAS,CAA6C;IAC9D,OAAO,CAAC,gCAAgC,CAAa;IAErD;;;;OAIG;gBACS,IAAI,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,YAAY;IAK9D;;;;;OAKG;IACH,EAAE,CAAC,OAAO,EAAE,cAAc,GAAG,cAAc,EAAE;IAM7C;;OAEG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE;IAO1B;;;OAGG;IACH,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE;IAMpB;;;OAGG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE;IAMvB;;OAEG;IACH,EAAE,CAAC,OAAO,EAAE,cAAc,CAAC,YAAY,CAAC;IAMxC;;OAEG;IACH,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,YAAY,CAAC;IAM9C;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM;IAMnD,iFAAiF;IACjF,QAAQ;IAMR,qHAAqH;IACrH,aAAa,CAAC,gCAAgC,EAAE,MAAM;IAOtD;;OAEG;IACH,YAAY,CAAC,gBAAgB,EAAE;QAAE,QAAQ,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE;IAUtE;;OAEG;IACH,iBAAiB,CACb,aAAa,EACP,mCAAmC,GACnC,CAAC,MAAM,mCAAmC,CAAC;IAwBrD,oBAAoB;IACpB,KAAK;CAkBR;AAED,MAAM,MAAM,mCAAmC,GAAG;IAC9C,gBAAgB,CAAC,EAAE,6BAA6B,CAAC,YAAY,CAAC,CAAC;IAC/D,gBAAgB,CAAC,EAAE,6BAA6B,CAAC,OAAO,CAAC,CAAC;IAC1D,sBAAsB,CAAC,EAAE,6BAA6B,CAAC,MAAM,EAAE,CAAC,CAAC;IACjE,sBAAsB,CAAC,EAAE,6BAA6B,CAAC,MAAM,EAAE,CAAC,CAAC;IACjE,sBAAsB,CAAC,EAAE,6BAA6B,CAAC,MAAM,EAAE,CAAC,CAAC;CACpE,CAAC;AAEF;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,6BAA6B,CAAC,eAAe,CAAC;IACpF;;OAEG;gBACS,IAAI,EAAE,MAAM;CAG3B"}

package/dist/helpers/builders/commandActionBuilder.js

@@ -0,0 +1,146 @@
+import { CommandAction } from '../../entities/actions/commandAction';
+import { ActionStateBase } from '../../entities/states/actionStateBase';
+import { toArray } from '../toArray';
+import { Noop } from '../noop';
+import { CooldownInfo } from '../../dtos/cooldownInfo';
+/**
+ * Builder for `CommandAction` with state represented by `TActionState`
+ */
+export class CommandActionBuilderWithState {
+    name;
+    trigger = [];
+    activeProvider = () => true;
+    cooldownSettingsProvider = () => new CooldownInfo(0);
+    blacklistProvider = () => [];
+    whitelistProvider = () => [];
+    allowedUsersProvider = () => [];
+    readmeFactory = Noop.emptyString;
+    stateConstructor;
+    handler = Noop.call;
+    condition = Noop.true;
+    maxAllowedSimultaniousExecutions = 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, stateConstructor) {
+        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) {
+        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) {
+        const ids = toArray(id);
+        this.allowedUsersProvider = () => ids;
+        return this;
+    }
+    /**
+     * Sets chats whitelist for this action.
+     * @param chatIds Chats ids to allow.
+     */
+    in(chatIds) {
+        this.whitelistProvider = () => chatIds;
+        return this;
+    }
+    /**
+     * Sets chats blacklist for this action.
+     * @param chatIds Chats ids to ignore.
+     */
+    notIn(chatIds) {
+        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) {
+        this.handler = handler;
+        return this;
+    }
+    /** Defines condition that will be checked before trigger match check is executed.
+     * @param condition Condition check predicate
+     */
+    when(condition) {
+        this.condition = condition;
+        return this;
+    }
+    /**
+     * Sets factory method for readme (shown on /help) for this action.
+     * @param readmeFactory readme factory
+     */
+    withHelp(readmeFactory) {
+        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) {
+        this.maxAllowedSimultaniousExecutions =
+            maxAllowedSimultaniousExecutions;
+        return this;
+    }
+    /** Sets action cooldown settings.
+     * @param cooldownSettings Settings.
+     */
+    withCooldown(cooldownSettings) {
+        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) {
+        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
+        }, this.maxAllowedSimultaniousExecutions, this.condition, this.stateConstructor, this.readmeFactory);
+    }
+}
+/**
+ * Builder for `CommandAction` with state represented by default state (containing only last execution date).
+ */
+export class CommandActionBuilder extends CommandActionBuilderWithState {
+    /**
+     * Builder for `CommandAction` with state represented by default state (containing only last execution date).
+     */
+    constructor(name) {
+        super(name, () => new ActionStateBase());
+    }
+}

package/dist/helpers/builders/inlineQueryActionBuilder.d.ts

@@ -0,0 +1,37 @@
+import { InlineQueryHandler } from '../../types/handlers';
+import { InlineQueryAction } from '../../entities/actions/inlineQueryAction';
+import { InlineActionPropertyProvider } from '../../types/propertyProvider';
+/**
+ * Builder for `InlineQueryAction`
+ */
+export declare class InlineQueryActionBuilder {
+    private readonly name;
+    private pattern;
+    private activeProvider;
+    private handler;
+    /**
+     * Builder for `InlineQueryAction`
+     * @param name Action name, will be used for logging and storage
+     */
+    constructor(name: string);
+    /**
+     * 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;
+    /** Defines action logic itself, will be executed.
+     * @param handler Callback that will be called
+     */
+    do(handler: InlineQueryHandler): this;
+    /** If called during building, action is marked as disabled and never checked. */
+    disabled(): this;
+    /**
+     * Configures action to use property value providers instead of static value to allow changes in runtime
+     */
+    withConfiguration(configuration: {
+        isActiveProvider?: InlineActionPropertyProvider<boolean>;
+    }): this;
+    /** Builds action */
+    build(): InlineQueryAction;
+}
+//# sourceMappingURL=inlineQueryActionBuilder.d.ts.map

package/dist/helpers/builders/inlineQueryActionBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inlineQueryActionBuilder.d.ts","sourceRoot":"","sources":["../../../helpers/builders/inlineQueryActionBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AAC7E,OAAO,EAAE,4BAA4B,EAAE,MAAM,8BAA8B,CAAC;AAE5E;;GAEG;AACH,qBAAa,wBAAwB;IACjC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAC9B,OAAO,CAAC,OAAO,CAAkB;IAEjC,OAAO,CAAC,cAAc,CAAqD;IAC3E,OAAO,CAAC,OAAO,CAAiC;IAEhD;;;OAGG;gBACS,IAAI,EAAE,MAAM;IAIxB;;;OAGG;IACH,EAAE,CAAC,OAAO,EAAE,MAAM;IAMlB;;OAEG;IACH,EAAE,CAAC,OAAO,EAAE,kBAAkB;IAM9B,iFAAiF;IACjF,QAAQ;IAMR;;OAEG;IACH,iBAAiB,CAAC,aAAa,EAAE;QAC7B,gBAAgB,CAAC,EAAE,4BAA4B,CAAC,OAAO,CAAC,CAAC;KAC5D;IAOD,oBAAoB;IACpB,KAAK;CAQR"}

package/dist/helpers/builders/inlineQueryActionBuilder.js

@@ -0,0 +1,50 @@
+import { Noop } from '../noop';
+import { InlineQueryAction } from '../../entities/actions/inlineQueryAction';
+/**
+ * Builder for `InlineQueryAction`
+ */
+export class InlineQueryActionBuilder {
+    name;
+    pattern = /.+/gi;
+    activeProvider = () => true;
+    handler = Noop.call;
+    /**
+     * Builder for `InlineQueryAction`
+     * @param name Action name, will be used for logging and storage
+     */
+    constructor(name) {
+        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) {
+        this.pattern = pattern;
+        return this;
+    }
+    /** Defines action logic itself, will be executed.
+     * @param handler Callback that will be called
+     */
+    do(handler) {
+        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) {
+        if (configuration.isActiveProvider)
+            this.activeProvider = configuration.isActiveProvider;
+        return this;
+    }
+    /** Builds action */
+    build() {
+        return new InlineQueryAction(this.handler, this.name, this.activeProvider, this.pattern);
+    }
+}

package/dist/helpers/builders/scheduledActionBuilder.d.ts

@@ -0,0 +1,68 @@
+import { ScheduledAction } from '../../entities/actions/scheduledAction';
+import { ActionStateBase } from '../../entities/states/actionStateBase';
+import { IActionState } from '../../types/actionState';
+import { ScheduledHandler } from '../../types/handlers';
+import { ScheduledActionPropertyProvider } from '../../types/propertyProvider';
+import { Hours, HoursOfDay } from '../../types/timeValues';
+/**
+ * Builder for `ScheduledAction` with state represented by `TActionState`
+ */
+export declare class ScheduledActionBuilderWithState<TActionState extends IActionState> {
+    private readonly name;
+    private readonly cachedStateFactories;
+    private readonly stateConstructor;
+    private handler;
+    private whitelistProvider;
+    private activeProvider;
+    private timeinHoursProvider;
+    /**
+     * Builder for `ScheduledAction` 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);
+    /**
+     * Sets whitelist for this action.
+     * @param chatIds Chat ids to execute in.
+     */
+    in(chatIds: number[]): this;
+    /**
+     * Defines time for scheduled item execution.
+     * @param time Time of day (0 - 23) to execute action.
+     */
+    runAt(time: HoursOfDay): this;
+    /** Defines action logic itself, will be executed on timer.
+     * @param handler Callback that will be called on timer.
+     */
+    do(handler: ScheduledHandler<TActionState>): this;
+    /**
+     * Defines process-wide cache, that is shared by all actions of this type (even in different bot instances).
+     * Can be used for fetch request de-duping, etc.
+     * @param key Key that will be used to retrieve value from cache.
+     * @param itemFactory Callback that will be executed once to create cached value.
+     * @param invalidationTimeoutInHours Timeout for cache invalidation.
+     */
+    withSharedCache(key: string, itemFactory: () => Promise<unknown>, invalidationTimeoutInHours?: Hours): this;
+    /** If called during building, action is marked as disabled and never checked. */
+    disabled(): this;
+    /**
+     * Configures action to use property value providers instead of static value to allow changes in runtime
+     */
+    withConfiguration(configuration: {
+        timeinHoursProvider?: ScheduledActionPropertyProvider<HoursOfDay>;
+        isActiveProvider?: ScheduledActionPropertyProvider<boolean>;
+        chatsWhitelistProvider?: ScheduledActionPropertyProvider<number[]>;
+    }): this;
+    /** Builds action */
+    build(): ScheduledAction<TActionState>;
+}
+/**
+ * Builder for `ScheduledAction` with state represented by default state (containing only last execution date).
+ */
+export declare class ScheduledActionBuilder extends ScheduledActionBuilderWithState<ActionStateBase> {
+    /**
+     * Builder for `ScheduledAction` with state represented by default state (containing only last execution date).
+     */
+    constructor(name: string);
+}
+//# sourceMappingURL=scheduledActionBuilder.d.ts.map

package/dist/helpers/builders/scheduledActionBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduledActionBuilder.d.ts","sourceRoot":"","sources":["../../../helpers/builders/scheduledActionBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AAEzE,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,+BAA+B,EAAE,MAAM,8BAA8B,CAAC;AAC/E,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAG3D;;GAEG;AACH,qBAAa,+BAA+B,CACxC,YAAY,SAAS,YAAY;IAEjC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAGjC;IACJ,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAqB;IACtD,OAAO,CAAC,OAAO,CAA6C;IAE5D,OAAO,CAAC,iBAAiB,CACZ;IACb,OAAO,CAAC,cAAc,CACb;IACT,OAAO,CAAC,mBAAmB,CACf;IAEZ;;;;OAIG;gBACS,IAAI,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,YAAY;IAK9D;;;OAGG;IACH,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE;IAMpB;;;OAGG;IACH,KAAK,CAAC,IAAI,EAAE,UAAU;IAMtB;;OAEG;IACH,EAAE,CAAC,OAAO,EAAE,gBAAgB,CAAC,YAAY,CAAC;IAM1C;;;;;;OAMG;IACH,eAAe,CACX,GAAG,EAAE,MAAM,EACX,WAAW,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,EACnC,0BAA0B,GAAE,KAAmB;IAUnD,iFAAiF;IACjF,QAAQ;IAMR;;OAEG;IACH,iBAAiB,CAAC,aAAa,EAAE;QAC7B,mBAAmB,CAAC,EAAE,+BAA+B,CAAC,UAAU,CAAC,CAAC;QAClE,gBAAgB,CAAC,EAAE,+BAA+B,CAAC,OAAO,CAAC,CAAC;QAC5D,sBAAsB,CAAC,EAAE,+BAA+B,CAAC,MAAM,EAAE,CAAC,CAAC;KACtE;IAaD,oBAAoB;IACpB,KAAK;CAaR;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,+BAA+B,CAAC,eAAe,CAAC;IACxF;;OAEG;gBACS,IAAI,EAAE,MAAM;CAG3B"}