@dementevdev/maxbot-ts 1.0.0

package/dist/cjs/bot/Composer.d.ts

@@ -0,0 +1,131 @@
+import type { Middleware } from "../middleware/types.js";
+import type { Context } from "./Bot.js";
+import type { UpdateType } from "../types/update.js";
+import { type HearsTrigger } from "./triggers.js";
+/**
+ * Тип предиката-фильтра, уточняющего тип контекста.
+ *
+ * @example
+ * const isAdmin: Filter<Context, MessageContext> = (ctx) =>
+ *   isMessageContext(ctx) && ctx.senderId === ADMIN_ID;
+ */
+export type Filter<Ctx, Narrowed extends Ctx> = (ctx: Ctx) => ctx is Narrowed;
+/**
+ * Composer — независимый суб-роутер, совместимый с `bot.use()`.
+ *
+ * Собирает маршруты (`command`, `hears`, `action`, `on`, `filter`) в изолированную
+ * цепочку middleware и подключается к боту через `bot.use(composer.middleware())`.
+ *
+ * Позволяет разбить логику бота на независимые модули с явными границами:
+ * - `adminRouter` — команды только для администраторов
+ * - `shopRouter` — весь шоппинг-флоу
+ * - `notificationRouter` — обработка системных событий
+ *
+ * @example Суб-роутер для администраторов
+ * ```ts
+ * const adminRouter = new Composer<Context>();
+ *
+ * adminRouter.use(onlyAdminMiddleware);
+ * adminRouter.command('stats', async (ctx) => { ... });
+ * adminRouter.hears(/^админ/i, async (ctx) => { ... });
+ *
+ * bot.use(adminRouter.middleware());
+ * ```
+ *
+ * @example bot.filter() + Composer
+ * ```ts
+ * const privateRouter = new Composer<Context>();
+ * privateRouter.command('start', async (ctx) => { ... });
+ *
+ * // Подключаем только для приватных диалогов
+ * bot.filter(isPrivateChat, privateRouter.middleware());
+ * ```
+ */
+export declare class Composer<Ctx extends Context = Context> {
+    private readonly fns;
+    /**
+     * Добавить middleware в цепочку.
+     *
+     * Middleware получает контекст и функцию `next` для перехода к следующему звену.
+     *
+     * @example
+     * composer.use(async (ctx, next) => {
+     *   console.log('before');
+     *   await next();
+     *   console.log('after');
+     * });
+     */
+    use(middleware: Middleware<Ctx>): this;
+    /**
+     * Подписаться на конкретный тип обновления.
+     *
+     * @example
+     * composer.on('bot_added', async (ctx, next) => {
+     *   await ctx.reply('Бот добавлен!');
+     * });
+     */
+    on(event: UpdateType, ...fns: Middleware<Ctx>[]): this;
+    /**
+     * Подписаться на команду (`/name`).
+     *
+     * @example
+     * composer.command('help', async (ctx) => { ... });
+     * composer.command('pay', authMw, async (ctx) => { ... });
+     */
+    command(name: string, ...fns: Middleware<Ctx>[]): this;
+    /**
+     * Подписаться на текст сообщения.
+     *
+     * `pattern` может быть строкой, RegExp или массивом — срабатывает на первое совпадение.
+     * При совпадении RegExp устанавливает `ctx.match` с capture-группами.
+     *
+     * @example
+     * composer.hears(/(\d+)\+(\d+)/, async (ctx) => {
+     *   const [, a, b] = ctx.match!;
+     * });
+     * composer.hears([/^\d+$/, 'помощь'], handler); // массив паттернов
+     */
+    hears(pattern: HearsTrigger, ...fns: Middleware<Ctx>[]): this;
+    /**
+     * Подписаться на callback payload.
+     *
+     * `pattern` может быть строкой, RegExp или массивом — срабатывает на первое совпадение.
+     * При совпадении RegExp устанавливает `ctx.match` с capture-группами.
+     *
+     * @example
+     * composer.action(/^buy:(\d+)$/, async (ctx) => {
+     *   const [, id] = ctx.match!;
+     * });
+     * composer.action(['confirm', 'ok'], handler); // несколько payload
+     */
+    action(pattern: HearsTrigger, ...fns: Middleware<Ctx>[]): this;
+    /**
+     * Фильтровать контекст по предикату с сужением типа.
+     *
+     * Если предикат возвращает `true` — выполняются handlers с суженным типом.
+     * Если `false` — вызывается `next()` (передаётся наружу).
+     *
+     * @example Только авторизованные пользователи
+     * composer.filter(isAdmin, async (ctx) => {
+     *   await ctx.reply('Привет, администратор!');
+     * });
+     *
+     * @example Только сообщения с текстом
+     * composer.filter(hasText, async (ctx) => {
+     *   console.log(ctx.text.toUpperCase()); // ctx.text: string
+     * });
+     */
+    filter<Narrowed extends Ctx>(predicate: (ctx: Ctx) => ctx is Narrowed, ...fns: Middleware<Narrowed>[]): this;
+    /**
+     * Вернуть этот Composer как один `Middleware` для подключения к боту или другому Composer.
+     *
+     * @example
+     * const router = new Composer();
+     * router.command('start', handler);
+     * bot.use(router.middleware());
+     */
+    middleware(): Middleware<Ctx>;
+    /** Сборка цепочки из нескольких fns в единый терминальный обработчик (без next). */
+    private pipe;
+}
+//# sourceMappingURL=Composer.d.ts.map

package/dist/cjs/bot/Composer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Composer.d.ts","sourceRoot":"","sources":["../../../src/bot/Composer.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD,OAAO,EAAgB,KAAK,YAAY,EAAE,MAAM,eAAe,CAAC;AAEhE;;;;;;GAMG;AACH,MAAM,MAAM,MAAM,CAAC,GAAG,EAAE,QAAQ,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,IAAI,QAAQ,CAAC;AAE9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,QAAQ,CAAC,GAAG,SAAS,OAAO,GAAG,OAAO;IACjD,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAyB;IAE7C;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI;IAKtC;;;;;;;OAOG;IACH,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,GAAG,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI;IAatD;;;;;;OAMG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI;IAkBtD;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI;IAkB7D;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI;IAkB9D;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,QAAQ,SAAS,GAAG,EACzB,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,IAAI,QAAQ,EACxC,GAAG,GAAG,EAAE,UAAU,CAAC,QAAQ,CAAC,EAAE,GAC7B,IAAI;IAWP;;;;;;;OAOG;IACH,UAAU,IAAI,UAAU,CAAC,GAAG,CAAC;IAU7B,oFAAoF;IACpF,OAAO,CAAC,IAAI;CAOb"}

package/dist/cjs/bot/Composer.js

@@ -0,0 +1,218 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Composer = void 0;
+const compose_js_1 = require("../middleware/compose.js");
+const guards_js_1 = require("./context/guards.js");
+const triggers_js_1 = require("./triggers.js");
+/**
+ * Composer — независимый суб-роутер, совместимый с `bot.use()`.
+ *
+ * Собирает маршруты (`command`, `hears`, `action`, `on`, `filter`) в изолированную
+ * цепочку middleware и подключается к боту через `bot.use(composer.middleware())`.
+ *
+ * Позволяет разбить логику бота на независимые модули с явными границами:
+ * - `adminRouter` — команды только для администраторов
+ * - `shopRouter` — весь шоппинг-флоу
+ * - `notificationRouter` — обработка системных событий
+ *
+ * @example Суб-роутер для администраторов
+ * ```ts
+ * const adminRouter = new Composer<Context>();
+ *
+ * adminRouter.use(onlyAdminMiddleware);
+ * adminRouter.command('stats', async (ctx) => { ... });
+ * adminRouter.hears(/^админ/i, async (ctx) => { ... });
+ *
+ * bot.use(adminRouter.middleware());
+ * ```
+ *
+ * @example bot.filter() + Composer
+ * ```ts
+ * const privateRouter = new Composer<Context>();
+ * privateRouter.command('start', async (ctx) => { ... });
+ *
+ * // Подключаем только для приватных диалогов
+ * bot.filter(isPrivateChat, privateRouter.middleware());
+ * ```
+ */
+class Composer {
+    fns = [];
+    /**
+     * Добавить middleware в цепочку.
+     *
+     * Middleware получает контекст и функцию `next` для перехода к следующему звену.
+     *
+     * @example
+     * composer.use(async (ctx, next) => {
+     *   console.log('before');
+     *   await next();
+     *   console.log('after');
+     * });
+     */
+    use(middleware) {
+        this.fns.push(middleware);
+        return this;
+    }
+    /**
+     * Подписаться на конкретный тип обновления.
+     *
+     * @example
+     * composer.on('bot_added', async (ctx, next) => {
+     *   await ctx.reply('Бот добавлен!');
+     * });
+     */
+    on(event, ...fns) {
+        const composed = this.pipe(...fns);
+        this.fns.push(async (ctx, next) => {
+            // ctx as Context — безопасно: Ctx extends Context, все .raw содержат update_type
+            if (ctx.raw.update_type === event) {
+                await composed(ctx);
+            }
+            else {
+                await next();
+            }
+        });
+        return this;
+    }
+    /**
+     * Подписаться на команду (`/name`).
+     *
+     * @example
+     * composer.command('help', async (ctx) => { ... });
+     * composer.command('pay', authMw, async (ctx) => { ... });
+     */
+    command(name, ...fns) {
+        const composed = this.pipe(...fns);
+        this.fns.push(async (ctx, next) => {
+            if (!(0, guards_js_1.isMessageContext)(ctx)) {
+                await next();
+                return;
+            }
+            const text = ctx.text ?? "";
+            const normalized = name.startsWith("/") ? name : `/${name}`;
+            if (text === normalized || text.startsWith(`${normalized} `)) {
+                await composed(ctx);
+            }
+            else {
+                await next();
+            }
+        });
+        return this;
+    }
+    /**
+     * Подписаться на текст сообщения.
+     *
+     * `pattern` может быть строкой, RegExp или массивом — срабатывает на первое совпадение.
+     * При совпадении RegExp устанавливает `ctx.match` с capture-группами.
+     *
+     * @example
+     * composer.hears(/(\d+)\+(\d+)/, async (ctx) => {
+     *   const [, a, b] = ctx.match!;
+     * });
+     * composer.hears([/^\d+$/, 'помощь'], handler); // массив паттернов
+     */
+    hears(pattern, ...fns) {
+        const composed = this.pipe(...fns);
+        this.fns.push(async (ctx, next) => {
+            if (!(0, guards_js_1.isMessageContext)(ctx)) {
+                await next();
+                return;
+            }
+            const result = (0, triggers_js_1.matchTrigger)(pattern, ctx.text ?? "");
+            if (result !== null) {
+                if (result !== true)
+                    ctx.match = result;
+                await composed(ctx);
+            }
+            else {
+                await next();
+            }
+        });
+        return this;
+    }
+    /**
+     * Подписаться на callback payload.
+     *
+     * `pattern` может быть строкой, RegExp или массивом — срабатывает на первое совпадение.
+     * При совпадении RegExp устанавливает `ctx.match` с capture-группами.
+     *
+     * @example
+     * composer.action(/^buy:(\d+)$/, async (ctx) => {
+     *   const [, id] = ctx.match!;
+     * });
+     * composer.action(['confirm', 'ok'], handler); // несколько payload
+     */
+    action(pattern, ...fns) {
+        const composed = this.pipe(...fns);
+        this.fns.push(async (ctx, next) => {
+            if (!(0, guards_js_1.isCallbackContext)(ctx)) {
+                await next();
+                return;
+            }
+            const result = (0, triggers_js_1.matchTrigger)(pattern, ctx.data);
+            if (result !== null) {
+                if (result !== true)
+                    ctx.match = result;
+                await composed(ctx);
+            }
+            else {
+                await next();
+            }
+        });
+        return this;
+    }
+    /**
+     * Фильтровать контекст по предикату с сужением типа.
+     *
+     * Если предикат возвращает `true` — выполняются handlers с суженным типом.
+     * Если `false` — вызывается `next()` (передаётся наружу).
+     *
+     * @example Только авторизованные пользователи
+     * composer.filter(isAdmin, async (ctx) => {
+     *   await ctx.reply('Привет, администратор!');
+     * });
+     *
+     * @example Только сообщения с текстом
+     * composer.filter(hasText, async (ctx) => {
+     *   console.log(ctx.text.toUpperCase()); // ctx.text: string
+     * });
+     */
+    filter(predicate, ...fns) {
+        this.fns.push(async (ctx, next) => {
+            if (predicate(ctx)) {
+                await (0, compose_js_1.compose)(fns, async () => { })(ctx);
+            }
+            else {
+                await next();
+            }
+        });
+        return this;
+    }
+    /**
+     * Вернуть этот Composer как один `Middleware` для подключения к боту или другому Composer.
+     *
+     * @example
+     * const router = new Composer();
+     * router.command('start', handler);
+     * bot.use(router.middleware());
+     */
+    middleware() {
+        if (this.fns.length === 0) {
+            return async (_ctx, next) => next();
+        }
+        return async (ctx, next) => {
+            // Запускаем внутреннюю цепочку; в конце вызываем внешний next — fall-through
+            await (0, compose_js_1.compose)(this.fns, async () => next())(ctx);
+        };
+    }
+    /** Сборка цепочки из нескольких fns в единый терминальный обработчик (без next). */
+    pipe(...fns) {
+        if (fns.length === 1) {
+            const fn = fns[0];
+            return (ctx) => Promise.resolve(fn(ctx, async () => { }));
+        }
+        return (0, compose_js_1.compose)(fns, async () => { });
+    }
+}
+exports.Composer = Composer;
+//# sourceMappingURL=Composer.js.map

package/dist/cjs/bot/context/BotStartedContext.d.ts

@@ -0,0 +1,83 @@
+import type { ContextApi, SendOptions } from "./MessageContext.js";
+import type { Message } from "../../types/message.js";
+import type { User } from "../../types/common.js";
+import type { BotStartedUpdate } from "../../types/update.js";
+import type { Context } from "../Bot.js";
+/**
+ * Контекст события bot_started.
+ *
+ * Возникает когда пользователь нажимает кнопку Start в диалоге с ботом
+ * или переходит по deep link вида `https://max.ru/...?start=<payload>`.
+ *
+ * Используйте `ctx.startPayload` для чтения payload из deep link:
+ * реферальные программы, onboarding-флоу, контекстный запуск бота.
+ *
+ * @example Реферальная ссылка
+ * bot.onStart(async (ctx) => {
+ *   if (ctx.startPayload) {
+ *     await ctx.reply(`Вы пришли по ссылке: ref=${ctx.startPayload}`);
+ *   } else {
+ *     await ctx.reply("Добро пожаловать!");
+ *   }
+ * });
+ */
+export declare class BotStartedContext {
+    private readonly update;
+    private readonly api;
+    constructor(update: BotStartedUpdate, api: ContextApi);
+    /** Исходное обновление */
+    get raw(): BotStartedUpdate;
+    /** ID чата (диалога), в котором произошло событие */
+    get chatId(): number;
+    /** Пользователь, нажавший Start */
+    get user(): User;
+    /** ID пользователя */
+    get userId(): number;
+    /**
+     * Payload из deep link.
+     *
+     * `null` или `undefined` если Start нажат без параметра (обычный запуск).
+     * Непустая строка — значение параметра `start` из ссылки.
+     *
+     * @example
+     * // Ссылка: https://max.ru/...?start=ref_123
+     * bot.onStart(async (ctx) => {
+     *   const ref = ctx.startPayload; // "ref_123" | null | undefined
+     * });
+     */
+    get startPayload(): string | null | undefined;
+    /**
+     * Отправить сообщение в диалог пользователю.
+     *
+     * @example
+     * bot.onStart(async (ctx) => {
+     *   if (isBotStartedContext(ctx)) await ctx.reply('Добро пожаловать!');
+     * });
+     */
+    reply(text: string, options?: SendOptions): Promise<Message>;
+    /**
+     * Отправить произвольное действие в чат (диалог пользователя).
+     *
+     * Распространённые значения: `"typing_on"`, `"sending_photo"`,
+     * `"sending_video"`, `"sending_audio"`, `"sending_file"`, `"mark_seen"`.
+     *
+     * @example
+     * bot.onStart(async (ctx) => {
+     *   await ctx.sendAction('typing_on');
+     *   await ctx.reply('Добро пожаловать!');
+     * });
+     */
+    sendAction(action: string): Promise<void>;
+    /**
+     * Проверить тип контекста с сужением типа (type narrowing).
+     *
+     * @example
+     * ```ts
+     * bot.onStart(async (ctx) => {
+     *   if (ctx.has(isPrivateChat)) { ... }
+     * });
+     * ```
+     */
+    has<R extends Context>(filter: (ctx: Context) => ctx is R): this is R;
+}
+//# sourceMappingURL=BotStartedContext.d.ts.map

package/dist/cjs/bot/context/BotStartedContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BotStartedContext.d.ts","sourceRoot":"","sources":["../../../../src/bot/context/BotStartedContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,KAAK,EAAE,OAAO,EAAkB,MAAM,wBAAwB,CAAC;AACtE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,iBAAiB;IAG1B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,GAAG;gBADH,MAAM,EAAE,gBAAgB,EACxB,GAAG,EAAE,UAAU;IAGlC,0BAA0B;IAC1B,IAAI,GAAG,IAAI,gBAAgB,CAE1B;IAED,qDAAqD;IACrD,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,mCAAmC;IACnC,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,sBAAsB;IACtB,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;;;;;;;;;;OAWG;IACH,IAAI,YAAY,IAAI,MAAM,GAAG,IAAI,GAAG,SAAS,CAE5C;IAED;;;;;;;OAOG;IACG,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBlE;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/C;;;;;;;;;OASG;IACH,GAAG,CAAC,CAAC,SAAS,OAAO,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC;CAGtE"}

package/dist/cjs/bot/context/BotStartedContext.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BotStartedContext = void 0;
+/**
+ * Контекст события bot_started.
+ *
+ * Возникает когда пользователь нажимает кнопку Start в диалоге с ботом
+ * или переходит по deep link вида `https://max.ru/...?start=<payload>`.
+ *
+ * Используйте `ctx.startPayload` для чтения payload из deep link:
+ * реферальные программы, onboarding-флоу, контекстный запуск бота.
+ *
+ * @example Реферальная ссылка
+ * bot.onStart(async (ctx) => {
+ *   if (ctx.startPayload) {
+ *     await ctx.reply(`Вы пришли по ссылке: ref=${ctx.startPayload}`);
+ *   } else {
+ *     await ctx.reply("Добро пожаловать!");
+ *   }
+ * });
+ */
+class BotStartedContext {
+    update;
+    api;
+    constructor(
+    // BotStartedUpdate — не общий Update: типизация гарантирует chat_id, user, payload
+    update, api) {
+        this.update = update;
+        this.api = api;
+    }
+    /** Исходное обновление */
+    get raw() {
+        return this.update;
+    }
+    /** ID чата (диалога), в котором произошло событие */
+    get chatId() {
+        return this.update.chat_id;
+    }
+    /** Пользователь, нажавший Start */
+    get user() {
+        return this.update.user;
+    }
+    /** ID пользователя */
+    get userId() {
+        return this.update.user.user_id;
+    }
+    /**
+     * Payload из deep link.
+     *
+     * `null` или `undefined` если Start нажат без параметра (обычный запуск).
+     * Непустая строка — значение параметра `start` из ссылки.
+     *
+     * @example
+     * // Ссылка: https://max.ru/...?start=ref_123
+     * bot.onStart(async (ctx) => {
+     *   const ref = ctx.startPayload; // "ref_123" | null | undefined
+     * });
+     */
+    get startPayload() {
+        return this.update.payload;
+    }
+    /**
+     * Отправить сообщение в диалог пользователю.
+     *
+     * @example
+     * bot.onStart(async (ctx) => {
+     *   if (isBotStartedContext(ctx)) await ctx.reply('Добро пожаловать!');
+     * });
+     */
+    async reply(text, options) {
+        const body = {
+            text,
+            format: options?.format,
+            attachments: options?.attachments,
+            notify: options?.notify,
+        };
+        const response = await this.api.messages.sendMessage({
+            chat_id: this.chatId,
+            disable_link_preview: options?.disable_link_preview,
+        }, body);
+        return response.message;
+    }
+    /**
+     * Отправить произвольное действие в чат (диалог пользователя).
+     *
+     * Распространённые значения: `"typing_on"`, `"sending_photo"`,
+     * `"sending_video"`, `"sending_audio"`, `"sending_file"`, `"mark_seen"`.
+     *
+     * @example
+     * bot.onStart(async (ctx) => {
+     *   await ctx.sendAction('typing_on');
+     *   await ctx.reply('Добро пожаловать!');
+     * });
+     */
+    async sendAction(action) {
+        await this.api.chats.sendAction(this.chatId, action);
+    }
+    /**
+     * Проверить тип контекста с сужением типа (type narrowing).
+     *
+     * @example
+     * ```ts
+     * bot.onStart(async (ctx) => {
+     *   if (ctx.has(isPrivateChat)) { ... }
+     * });
+     * ```
+     */
+    has(filter) {
+        return filter(this);
+    }
+}
+exports.BotStartedContext = BotStartedContext;
+//# sourceMappingURL=BotStartedContext.js.map

package/dist/cjs/bot/context/CallbackContext.d.ts

@@ -0,0 +1,107 @@
+import type { ContextApi, SendOptions } from "./MessageContext.js";
+import type { User } from "../../types/common.js";
+import type { Message, NewMessageBody } from "../../types/message.js";
+import type { CallbackUpdate } from "../../types/update.js";
+import type { Context } from "../Bot.js";
+/**
+ * Опции ответа на callback
+ */
+export interface AnswerOptions {
+    /** Обновить текущее сообщение */
+    message?: NewMessageBody;
+    /** Одноразовое уведомление пользователю */
+    notification?: string;
+}
+/**
+ * Контекст callback-запроса (нажатие на inline-кнопку).
+ */
+export declare class CallbackContext {
+    private readonly update;
+    private readonly api;
+    /**
+     * Результат совпадения RegExp из `bot.action()`.
+     *
+     * Доступен только внутри обработчика `action()` с RegExp-паттерном.
+     * Содержит полный `RegExpExecArray`: `ctx.match[0]` — полное совпадение,
+     * `ctx.match[1]`, `ctx.match[2]`, ... — группы захвата.
+     *
+     * `null` если обработчик вызван не через `action()` или паттерн — строка.
+     *
+     * @example
+     * bot.action(/^buy:(\d+)$/, async (ctx) => {
+     *   if (isCallbackContext(ctx)) console.log(ctx.match?.[1]); // id товара
+     * });
+     */
+    match: RegExpExecArray | null;
+    constructor(update: CallbackUpdate, api: ContextApi);
+    /** Исходное обновление */
+    get raw(): CallbackUpdate;
+    /** ID callback-запроса */
+    get callbackId(): string;
+    /** Данные callback (payload кнопки) */
+    get data(): string;
+    /**
+     * Сообщение, к которому была прикреплена кнопка.
+     * Может отсутствовать, если сообщение было удалено к моменту callback.
+     */
+    get message(): Message | null;
+    /** ID чата */
+    get chatId(): number | null;
+    /** Пользователь, нажавший кнопку — гарантировано присутствие API */
+    get callbackUser(): User;
+    /** ID пользователя, нажавшего кнопку */
+    get userId(): number;
+    /** Локаль пользователя */
+    get locale(): string | null;
+    /**
+     * Ответить на callback.
+     *
+     * Закрывает "часики" на кнопке и опционально показывает уведомление.
+     */
+    answer(options?: AnswerOptions): Promise<void>;
+    /**
+     * Ответить сообщением в чат.
+     *
+     * Бросает ошибку, если chat_id недоступен — сообщение было удалено.
+     */
+    reply(text: string, options?: SendOptions): Promise<Message>;
+    /**
+     * Редактировать сообщение с кнопкой.
+     */
+    editMessage(text: string, options?: SendOptions): Promise<void>;
+    /**
+     * Удалить сообщение с кнопкой.
+     *
+     * Бросает ошибку, если сообщение было удалено до callback.
+     *
+     * @example
+     * await ctx.deleteMessage();
+     */
+    deleteMessage(): Promise<void>;
+    /**
+     * Отправить произвольное действие в чат.
+     *
+     * Распространённые значения: `"typing_on"`, `"sending_photo"`,
+     * `"sending_video"`, `"sending_audio"`, `"sending_file"`, `"mark_seen"`.
+     *
+     * Бросает ошибку, если chat_id недоступен — сообщение удалено.
+     *
+     * @example
+     * await ctx.sendAction('typing_on');
+     */
+    sendAction(action: string): Promise<void>;
+    /**
+     * Проверить тип контекста с сужением типа (type narrowing).
+     *
+     * @example
+     * ```ts
+     * bot.on('callback', async (ctx) => {
+     *   if (ctx.has(hasCallbackPayload('confirm'))) {
+     *     await ctx.answer({ notification: 'Подтверждено!' });
+     *   }
+     * });
+     * ```
+     */
+    has<R extends Context>(filter: (ctx: Context) => ctx is R): this is R;
+}
+//# sourceMappingURL=CallbackContext.d.ts.map

package/dist/cjs/bot/context/CallbackContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CallbackContext.d.ts","sourceRoot":"","sources":["../../../../src/bot/context/CallbackContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,iCAAiC;IACjC,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,2CAA2C;IAC3C,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,qBAAa,eAAe;IAmBxB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,GAAG;IAnBtB;;;;;;;;;;;;;OAaG;IACH,KAAK,EAAE,eAAe,GAAG,IAAI,CAAQ;gBAIlB,MAAM,EAAE,cAAc,EACtB,GAAG,EAAE,UAAU;IAGlC,0BAA0B;IAC1B,IAAI,GAAG,IAAI,cAAc,CAExB;IAED,0BAA0B;IAC1B,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED,uCAAuC;IACvC,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,OAAO,GAAG,IAAI,CAE5B;IAED,cAAc;IACd,IAAI,MAAM,IAAI,MAAM,GAAG,IAAI,CAE1B;IAED,oEAAoE;IACpE,IAAI,YAAY,IAAI,IAAI,CAEvB;IAED,wCAAwC;IACxC,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,0BAA0B;IAC1B,IAAI,MAAM,IAAI,MAAM,GAAG,IAAI,CAE1B;IAED;;;;OAIG;IACG,MAAM,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpD;;;;OAIG;IACG,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAsBlE;;OAEG;IACG,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAerE;;;;;;;OAOG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAUpC;;;;;;;;;;OAUG;IACG,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU/C;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,CAAC,SAAS,OAAO,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC;CAGtE"}