chz-telegram-bot 0.1.7 → 0.1.9

package/builtin/helpAction.ts

@@ -0,0 +1,14 @@
+import { CommandActionBuilder } from '../helpers/builders/commandActionBuilder';
+import { Seconds } from '../types/timeValues';
+
+export function buildHelpCommand(readmes: string[]) {
+    return new CommandActionBuilder('Reaction.Help')
+        .on('/help')
+        .do(async (ctx) => {
+            if (readmes.length == 0) return;
+
+            ctx.replyWithText(readmes.join('\n\n'));
+        })
+        .cooldown(60 as Seconds)
+        .build();
+}

package/dist/builtin/helpAction.d.ts

@@ -0,0 +1,2 @@
+export declare function buildHelpCommand(readmes: string[]): import("../entities/actions/commandAction").CommandAction<import("..").ActionStateBase>;
+//# sourceMappingURL=helpAction.d.ts.map

package/dist/builtin/helpAction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpAction.d.ts","sourceRoot":"","sources":["../../builtin/helpAction.ts"],"names":[],"mappings":"AAGA,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,2FAUjD"}

package/dist/builtin/helpAction.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildHelpCommand = buildHelpCommand;
+const commandActionBuilder_1 = require("../helpers/builders/commandActionBuilder");
+function buildHelpCommand(readmes) {
+    return new commandActionBuilder_1.CommandActionBuilder('Reaction.Help')
+        .on('/help')
+        .do(async (ctx) => {
+        if (readmes.length == 0)
+            return;
+        ctx.replyWithText(readmes.join('\n\n'));
+    })
+        .cooldown(60)
+        .build();
+}

package/dist/entities/actions/commandAction.d.ts

@@ -16,7 +16,8 @@ export declare class CommandAction<TActionState extends IActionState> implements
     readonly condition: CommandCondition<TActionState>;
     readonly stateConstructor: () => TActionState;
     readonly key: ActionKey;
-    constructor(trigger: CommandTrigger | CommandTrigger[], handler: CommandHandler<TActionState>, name: string, active: boolean, cooldown: Seconds, chatsBlacklist: number[], allowedUsers: number[], condition: CommandCondition<TActionState>, stateConstructor: () => TActionState);
+    readonly readme: string;
+    constructor(trigger: CommandTrigger | CommandTrigger[], handler: CommandHandler<TActionState>, name: string, active: boolean, cooldown: Seconds, chatsBlacklist: number[], allowedUsers: number[], condition: CommandCondition<TActionState>, stateConstructor: () => TActionState, readme: string);
     exec(ctx: MessageContext<TActionState>): Promise<import("../../types/response").BotResponse[]>;
     private checkIfShouldBeExecuted;
     private checkTrigger;

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

@@ -1 +1 @@
-{"version":3,"file":"commandAction.d.ts","sourceRoot":"","sources":["../../../entities/actions/commandAction.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAGjD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAEzE,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAG5D,qBAAa,aAAa,CAAC,YAAY,SAAS,YAAY,CACxD,YAAW,gBAAgB,CAAC,YAAY,CAAC;IAEzC,QAAQ,CAAC,QAAQ,EAAE,cAAc,EAAE,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;IAC/C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC;IAChC,QAAQ,CAAC,SAAS,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;IACnD,QAAQ,CAAC,gBAAgB,EAAE,MAAM,YAAY,CAAC;IAC9C,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC;gBAGpB,OAAO,EAAE,cAAc,GAAG,cAAc,EAAE,EAC1C,OAAO,EAAE,cAAc,CAAC,YAAY,CAAC,EACrC,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,OAAO,EACf,QAAQ,EAAE,OAAO,EACjB,cAAc,EAAE,MAAM,EAAE,EACxB,YAAY,EAAE,MAAM,EAAE,EACtB,SAAS,EAAE,gBAAgB,CAAC,YAAY,CAAC,EACzC,gBAAgB,EAAE,MAAM,YAAY;IAelC,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,YAAY,CAAC;IAkD5C,OAAO,CAAC,uBAAuB;IAqC/B,OAAO,CAAC,YAAY;CAmCvB"}
+{"version":3,"file":"commandAction.d.ts","sourceRoot":"","sources":["../../../entities/actions/commandAction.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAGjD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAEzE,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAG5D,qBAAa,aAAa,CAAC,YAAY,SAAS,YAAY,CACxD,YAAW,gBAAgB,CAAC,YAAY,CAAC;IAEzC,QAAQ,CAAC,QAAQ,EAAE,cAAc,EAAE,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;IAC/C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC;IAChC,QAAQ,CAAC,SAAS,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC;IACnD,QAAQ,CAAC,gBAAgB,EAAE,MAAM,YAAY,CAAC;IAC9C,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAGpB,OAAO,EAAE,cAAc,GAAG,cAAc,EAAE,EAC1C,OAAO,EAAE,cAAc,CAAC,YAAY,CAAC,EACrC,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,OAAO,EACf,QAAQ,EAAE,OAAO,EACjB,cAAc,EAAE,MAAM,EAAE,EACxB,YAAY,EAAE,MAAM,EAAE,EACtB,SAAS,EAAE,gBAAgB,CAAC,YAAY,CAAC,EACzC,gBAAgB,EAAE,MAAM,YAAY,EACpC,MAAM,EAAE,MAAM;IAgBZ,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,YAAY,CAAC;IAkD5C,OAAO,CAAC,uBAAuB;IAqC/B,OAAO,CAAC,YAAY;CAmCvB"}

package/dist/entities/actions/commandAction.js

@@ -10,7 +10,7 @@ const toArray_1 = require("../../helpers/toArray");
 const commandTriggerCheckResult_1 = require("../../dtos/commandTriggerCheckResult");
 const noop_1 = require("../../helpers/noop");
 class CommandAction {
-    constructor(trigger, handler, name, active, cooldown, chatsBlacklist, allowedUsers, condition, stateConstructor) {
+    constructor(trigger, handler, name, active, cooldown, chatsBlacklist, allowedUsers, condition, stateConstructor, readme) {
         this.triggers = (0, toArray_1.toArray)(trigger);
         this.handler = handler;
         this.name = name;
@@ -20,6 +20,7 @@ class CommandAction {
         this.allowedUsers = allowedUsers;
         this.condition = condition;
         this.stateConstructor = stateConstructor;
+        this.readme = readme;
         this.key = `command:${this.name.replace('.', '-')}`;
     }
     async exec(ctx) {

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

@@ -1 +1 @@
-{"version":3,"file":"botInstance.d.ts","sourceRoot":"","sources":["../../entities/botInstance.ts"],"names":[],"mappings":"AAKA,OAAO,EAAuB,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAGlD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAO5D,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAGhD,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAIhE,qBAAa,WAAW;IACpB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAqB;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiB;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAa;IACvC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAU;IAEjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IACpC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgC;IACzD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAkC;IAC5D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAsB;IACpD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAyB;gBAEnC,OAAO,EAAE;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,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,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,gCAAgC,CAAC,EAAE,OAAO,CAAC;QAC3C,QAAQ,CAAC,EAAE;YACP,aAAa,CAAC,EAAE,cAAc,CAAC;YAC/B,MAAM,CAAC,EAAE,OAAO,CAAC;YACjB,SAAS,CAAC,EAAE,UAAU,CAAC;SAC1B,CAAC;KACL;IA0CD,OAAO,CAAC,6BAA6B;IA4CrC,OAAO,CAAC,+BAA+B;IA2EvC,OAAO,CAAC,2BAA2B;IAiC7B,IAAI,CAAC,IAAI,EAAE,MAAM;YAaT,YAAY;YAuCZ,cAAc;CA2B/B"}
+{"version":3,"file":"botInstance.d.ts","sourceRoot":"","sources":["../../entities/botInstance.ts"],"names":[],"mappings":"AAKA,OAAO,EAAuB,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAGlD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAO5D,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAGhD,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAKhE,qBAAa,WAAW;IACpB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAqB;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiB;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAa;IACvC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAU;IAEjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IACpC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgC;IACzD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAkC;IAC5D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAsB;IACpD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAyB;gBAEnC,OAAO,EAAE;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,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,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,gCAAgC,CAAC,EAAE,OAAO,CAAC;QAC3C,QAAQ,CAAC,EAAE;YACP,aAAa,CAAC,EAAE,cAAc,CAAC;YAC/B,MAAM,CAAC,EAAE,OAAO,CAAC;YACjB,SAAS,CAAC,EAAE,UAAU,CAAC;SAC1B,CAAC;KACL;IAoDD,OAAO,CAAC,6BAA6B;IA4CrC,OAAO,CAAC,+BAA+B;IA2EvC,OAAO,CAAC,2BAA2B;IAiC7B,IAAI,CAAC,IAAI,EAAE,MAAM;YAaT,YAAY;YAuCZ,cAAc;CA2B/B"}

package/dist/entities/botInstance.js

@@ -18,10 +18,19 @@ const nodeTimeoutScheduler_1 = require("../services/nodeTimeoutScheduler");
 const traceFactory_1 = require("../helpers/traceFactory");
 const incomingQuery_1 = require("../dtos/incomingQuery");
 const inlineQueryContext_1 = require("./context/inlineQueryContext");
+const helpAction_1 = require("../builtin/helpAction");
 class BotInstance {
     constructor(options) {
         this.name = options.name;
-        this.commands = options.actions.commands;
+        this.commands =
+            options.actions.commands.length > 0
+                ? [
+                    (0, helpAction_1.buildHelpCommand)(options.actions.commands
+                        .map((x) => x.readme)
+                        .filter((x) => !!x)),
+                    ...options.actions.commands
+                ]
+                : [];
         this.scheduled = options.actions.scheduled;
         this.inlineQueries = options.actions.inlineQueries;
         this.chats = options.chats;
@@ -36,7 +45,7 @@ class BotInstance {
                 new jsonFileStorage_1.JsonFileStorage(options.name, actions, options.storagePath);
         this.api = new telegramApi_1.TelegramApiService(this.name, this.telegraf.telegram, this.storage, this.logger);
         this.initializeMessageProcessing(options.verboseLoggingForIncomingMessage ?? false);
-        this.initializeInlineQueryProcessing(500);
+        this.initializeInlineQueryProcessing(1000);
         this.initializeScheduledProcessing(options.scheduledPeriod ?? (0, timeConvertions_1.hoursToSeconds)(1));
         this.storage.saveMetadata(actions, this.name);
         this.logger.logWithTraceId(this.name, (0, traceFactory_1.createTrace)(this, this.name, 'Start'), 'System', 'Starting bot...');

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

@@ -12,6 +12,7 @@ export declare class CommandActionBuilderWithState<TActionState extends IActionS
     name: string;
     trigger: CommandTrigger | CommandTrigger[];
     active: boolean;
+    readme: string;
     cooldownSeconds: Seconds;
     blacklist: number[];
     allowedUsers: number[];
@@ -43,6 +44,7 @@ export declare class CommandActionBuilderWithState<TActionState extends IActionS
      * @param condition Condition check predicate
      */
     when(condition: CommandCondition<TActionState>): this;
+    withHelp(readme: string): void;
     /** If called during building, action is marked as disabled and never checked. */
     disabled(): this;
     /** Sets action cooldown.

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

@@ -1 +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;AAE5D;;GAEG;AACH,qBAAa,6BAA6B,CAAC,YAAY,SAAS,YAAY;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,cAAc,GAAG,cAAc,EAAE,CAAM;IAEhD,MAAM,UAAQ;IACd,eAAe,EAAE,OAAO,CAAgB;IACxC,SAAS,EAAE,MAAM,EAAE,CAAM;IACzB,YAAY,EAAE,MAAM,EAAE,CAAM;IAC5B,gBAAgB,EAAE,MAAM,YAAY,CAAC;IACrC,OAAO,EAAE,cAAc,CAAC,YAAY,CAAC,CAAa;IAClD,SAAS,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAa;IAEtD;;;;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;IAM1B;;OAEG;IACH,EAAE,CAAC,OAAO,EAAE,cAAc,CAAC,YAAY,CAAC;IAMxC;;OAEG;IACH,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,YAAY,CAAC;IAM9C,iFAAiF;IACjF,QAAQ;IAMR;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO;IAMzB;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM;IAMzB,oBAAoB;IACpB,KAAK;CAaR;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,6BAA6B,CAAC,eAAe,CAAC;IACpF;;OAEG;gBACS,IAAI,EAAE,MAAM;CAG3B"}
+{"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;AAE5D;;GAEG;AACH,qBAAa,6BAA6B,CAAC,YAAY,SAAS,YAAY;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,cAAc,GAAG,cAAc,EAAE,CAAM;IAEhD,MAAM,UAAQ;IACd,MAAM,SAAM;IACZ,eAAe,EAAE,OAAO,CAAgB;IACxC,SAAS,EAAE,MAAM,EAAE,CAAM;IACzB,YAAY,EAAE,MAAM,EAAE,CAAM;IAC5B,gBAAgB,EAAE,MAAM,YAAY,CAAC;IACrC,OAAO,EAAE,cAAc,CAAC,YAAY,CAAC,CAAa;IAClD,SAAS,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAa;IAEtD;;;;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;IAM1B;;OAEG;IACH,EAAE,CAAC,OAAO,EAAE,cAAc,CAAC,YAAY,CAAC;IAMxC;;OAEG;IACH,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,YAAY,CAAC;IAM9C,QAAQ,CAAC,MAAM,EAAE,MAAM;IAIvB,iFAAiF;IACjF,QAAQ;IAMR;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO;IAMzB;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM;IAMzB,oBAAoB;IACpB,KAAK;CAcR;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,6BAA6B,CAAC,eAAe,CAAC;IACpF;;OAEG;gBACS,IAAI,EAAE,MAAM;CAG3B"}

package/dist/helpers/builders/commandActionBuilder.js

@@ -17,6 +17,7 @@ class CommandActionBuilderWithState {
     constructor(name, stateConstructor) {
         this.trigger = [];
         this.active = true;
+        this.readme = '';
         this.cooldownSeconds = 0;
         this.blacklist = [];
         this.allowedUsers = [];
@@ -56,6 +57,9 @@ class CommandActionBuilderWithState {
         this.condition = condition;
         return this;
     }
+    withHelp(readme) {
+        this.readme = readme;
+    }
     /** If called during building, action is marked as disabled and never checked. */
     disabled() {
         this.active = false;
@@ -78,7 +82,7 @@ class CommandActionBuilderWithState {
     }
     /** Builds action */
     build() {
-        return new commandAction_1.CommandAction(this.trigger, this.handler, this.name, this.active, this.cooldownSeconds, this.blacklist, this.allowedUsers, this.condition, this.stateConstructor);
+        return new commandAction_1.CommandAction(this.trigger, this.handler, this.name, this.active, this.cooldownSeconds, this.blacklist, this.allowedUsers, this.condition, this.stateConstructor, this.readme);
     }
 }
 exports.CommandActionBuilderWithState = CommandActionBuilderWithState;

package/entities/actions/commandAction.ts

@@ -24,6 +24,7 @@ export class CommandAction<TActionState extends IActionState>
     readonly condition: CommandCondition<TActionState>;
     readonly stateConstructor: () => TActionState;
     readonly key: ActionKey;
+    readonly readme: string;
 
     constructor(
         trigger: CommandTrigger | CommandTrigger[],
@@ -34,7 +35,8 @@ export class CommandAction<TActionState extends IActionState>
         chatsBlacklist: number[],
         allowedUsers: number[],
         condition: CommandCondition<TActionState>,
-        stateConstructor: () => TActionState
+        stateConstructor: () => TActionState,
+        readme: string
     ) {
         this.triggers = toArray(trigger);
         this.handler = handler;
@@ -45,6 +47,7 @@ export class CommandAction<TActionState extends IActionState>
         this.allowedUsers = allowedUsers;
         this.condition = condition;
         this.stateConstructor = stateConstructor;
+        this.readme = readme;
 
         this.key = `command:${this.name.replace('.', '-')}` as ActionKey;
     }

package/entities/botInstance.ts

@@ -23,6 +23,7 @@ import { createTrace } from '../helpers/traceFactory';
 import { InlineQueryAction } from './actions/inlineQueryAction';
 import { IncomingInlineQuery } from '../dtos/incomingQuery';
 import { InlineQueryContext } from './context/inlineQueryContext';
+import { buildHelpCommand } from '../builtin/helpAction';
 
 export class BotInstance {
     private readonly api: TelegramApiService;
@@ -56,7 +57,17 @@ export class BotInstance {
         };
     }) {
         this.name = options.name;
-        this.commands = options.actions.commands;
+        this.commands =
+            options.actions.commands.length > 0
+                ? [
+                      buildHelpCommand(
+                          options.actions.commands
+                              .map((x) => x.readme)
+                              .filter((x) => !!x)
+                      ),
+                      ...options.actions.commands
+                  ]
+                : [];
         this.scheduled = options.actions.scheduled;
         this.inlineQueries = options.actions.inlineQueries;
         this.chats = options.chats;
@@ -80,7 +91,7 @@ export class BotInstance {
         this.initializeMessageProcessing(
             options.verboseLoggingForIncomingMessage ?? false
         );
-        this.initializeInlineQueryProcessing(500 as Milliseconds);
+        this.initializeInlineQueryProcessing(1000 as Milliseconds);
         this.initializeScheduledProcessing(
             options.scheduledPeriod ?? hoursToSeconds(1 as Hours)
         );

package/helpers/builders/commandActionBuilder.ts

@@ -16,6 +16,7 @@ export class CommandActionBuilderWithState<TActionState extends IActionState> {
     trigger: CommandTrigger | CommandTrigger[] = [];
 
     active = true;
+    readme = '';
     cooldownSeconds: Seconds = 0 as Seconds;
     blacklist: number[] = [];
     allowedUsers: number[] = [];
@@ -72,6 +73,10 @@ export class CommandActionBuilderWithState<TActionState extends IActionState> {
         return this;
     }
 
+    withHelp(readme: string) {
+        this.readme = readme;
+    }
+
     /** If called during building, action is marked as disabled and never checked. */
     disabled() {
         this.active = false;
@@ -109,7 +114,8 @@ export class CommandActionBuilderWithState<TActionState extends IActionState> {
             this.blacklist,
             this.allowedUsers,
             this.condition,
-            this.stateConstructor
+            this.stateConstructor,
+            this.readme
         );
     }
 }

package/package.json

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