@mtcute/dispatcher 0.1.0

package/LICENSE

@@ -0,0 +1,8 @@
+Copyright 2023 Alina Sireneva
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

package/README.md

@@ -0,0 +1,26 @@
+# @mtcute/dispatcher
+
+📖 [API Reference](https://ref.mtcute.dev/modules/_mtcute_dispatcher.html)  
+🧐 [Guide](https://mtcute.dev/guide/dispatcher/intro.html)
+
+Dispatcher and bot framework based on @mtcute/client.
+
+## Features
+- **Straightforward**: Simple and expressive API
+- **State**: Supports storing state for each chat
+- **Filters**: Powerful and easy-to-use filtering system
+- **Middleware**: Basic middleware support for updates
+- **Scenes**: Built-in support for scenes
+
+## Usage
+
+```ts
+import { NodeTelegramClient, Dispatcher } from '@mtcute/node'
+
+const tg = new NodeTelegramClient({ ... })
+const dp = Dispatcher.for(tg)
+
+dp.onNewMessage(async (msg) => {
+    await msg.replyText('Hello world!')
+})
+```

package/cjs/callback-data-builder.d.ts

@@ -0,0 +1,43 @@
+import { CallbackQuery, MaybeArray } from '@mtcute/client';
+import { UpdateFilter } from './filters/types.js';
+/**
+ * Callback data builder, inspired by [aiogram](https://github.com/aiogram/aiogram).
+ *
+ * This can be used to simplify management of different callbacks.
+ *
+ * [Learn more in the docs](/guide/topics/keyboards.html#callback-data-builders)
+ */
+export declare class CallbackDataBuilder<T extends string> {
+    prefix: string;
+    private readonly _fields;
+    sep: string;
+    /**
+     * @param prefix  Prefix for the data. Use something unique across your bot.
+     * @param fields  Field names in the order they will be serialized.
+     */
+    constructor(prefix: string, ...fields: T[]);
+    /**
+     * Build a callback data string
+     *
+     * @param obj  Object containing the data
+     */
+    build(obj: Record<T, string>): string;
+    /**
+     * Parse callback data to object
+     *
+     * @param data  Callback data as string
+     */
+    parse(data: string): Record<T, string>;
+    /**
+     * Create a filter for this callback data.
+     *
+     * > **Note**: `params` object will be compiled to a RegExp,
+     * > so avoid using characters that have special meaning in regex,
+     * > or use RegExp directly to let the IDE guide you.
+     *
+     * @param params
+     */
+    filter(params: Partial<Record<T, MaybeArray<string | RegExp>>>): UpdateFilter<CallbackQuery, {
+        match: Record<T, string>;
+    }>;
+}

package/cjs/callback-data-builder.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CallbackDataBuilder = void 0;
+const client_1 = require("@mtcute/client");
+/**
+ * Callback data builder, inspired by [aiogram](https://github.com/aiogram/aiogram).
+ *
+ * This can be used to simplify management of different callbacks.
+ *
+ * [Learn more in the docs](/guide/topics/keyboards.html#callback-data-builders)
+ */
+class CallbackDataBuilder {
+    /**
+     * @param prefix  Prefix for the data. Use something unique across your bot.
+     * @param fields  Field names in the order they will be serialized.
+     */
+    constructor(prefix, ...fields) {
+        this.prefix = prefix;
+        this.sep = ':';
+        this._fields = fields;
+    }
+    /**
+     * Build a callback data string
+     *
+     * @param obj  Object containing the data
+     */
+    build(obj) {
+        const ret = this.prefix +
+            this.sep +
+            this._fields
+                .map((f) => {
+                const val = obj[f];
+                if (val.includes(this.sep)) {
+                    throw new client_1.MtArgumentError(`Value for ${f} ${val} contains separator ${this.sep} and cannot be used.`);
+                }
+                return val;
+            })
+                .join(this.sep);
+        if (ret.length > 64) {
+            throw new client_1.MtArgumentError('Resulting callback data is too long.');
+        }
+        return ret;
+    }
+    /**
+     * Parse callback data to object
+     *
+     * @param data  Callback data as string
+     */
+    parse(data) {
+        const parts = data.split(this.sep);
+        if (parts[0] !== this.prefix) {
+            throw new client_1.MtArgumentError('Invalid data passed');
+        }
+        if (parts.length !== this._fields.length + 1) {
+            throw new client_1.MtArgumentError('Invalid data passed');
+        }
+        const ret = {};
+        parts.forEach((it, idx) => {
+            ret[this._fields[idx - 1]] = it;
+        });
+        return ret;
+    }
+    /**
+     * Create a filter for this callback data.
+     *
+     * > **Note**: `params` object will be compiled to a RegExp,
+     * > so avoid using characters that have special meaning in regex,
+     * > or use RegExp directly to let the IDE guide you.
+     *
+     * @param params
+     */
+    filter(params) {
+        const parts = [];
+        this._fields.forEach((field) => {
+            if (!(field in params)) {
+                parts.push(`[^${this.sep}]*?`);
+                return;
+            }
+            const value = params[field];
+            if (Array.isArray(value)) {
+                parts.push(`(${value.map((i) => (typeof i === 'string' ? i : i.source)).join('|')})`);
+            }
+            else {
+                // noinspection SuspiciousTypeOfGuard
+                parts.push(typeof value === 'string' ? value : value.source);
+            }
+        });
+        const regex = new RegExp(`^${this.prefix}${this.sep}${parts.join(this.sep)}$`);
+        return (query) => {
+            const m = query.dataStr?.match(regex);
+            if (!m)
+                return false;
+            query.match = this.parse(m[0]);
+            return true;
+        };
+    }
+}
+exports.CallbackDataBuilder = CallbackDataBuilder;
+//# sourceMappingURL=callback-data-builder.js.map

package/cjs/callback-data-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"callback-data-builder.js","sourceRoot":"","sources":["../../src/callback-data-builder.ts"],"names":[],"mappings":";;;AAAA,2CAA2E;AAI3E;;;;;;GAMG;AACH,MAAa,mBAAmB;IAK5B;;;OAGG;IACH,YACW,MAAc,EACrB,GAAG,MAAW;QADP,WAAM,GAAN,MAAM,CAAQ;QAPzB,QAAG,GAAG,GAAG,CAAA;QAUL,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;IACzB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAsB;QACxB,MAAM,GAAG,GACL,IAAI,CAAC,MAAM;YACX,IAAI,CAAC,GAAG;YACR,IAAI,CAAC,OAAO;iBACP,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBACP,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAA;gBAElB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;oBACxB,MAAM,IAAI,wBAAe,CACrB,aAAa,CAAC,IAAI,GAAG,uBAAuB,IAAI,CAAC,GAAG,sBAAsB,CAC7E,CAAA;iBACJ;gBAED,OAAO,GAAG,CAAA;YACd,CAAC,CAAC;iBACD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAEvB,IAAI,GAAG,CAAC,MAAM,GAAG,EAAE,EAAE;YACjB,MAAM,IAAI,wBAAe,CAAC,sCAAsC,CAAC,CAAA;SACpE;QAED,OAAO,GAAG,CAAA;IACd,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAY;QACd,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAElC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE;YAC1B,MAAM,IAAI,wBAAe,CAAC,qBAAqB,CAAC,CAAA;SACnD;QAED,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YAC1C,MAAM,IAAI,wBAAe,CAAC,qBAAqB,CAAC,CAAA;SACnD;QAED,MAAM,GAAG,GAAG,EAAuB,CAAA;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE;YACtB,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;QACnC,CAAC,CAAC,CAAA;QAEF,OAAO,GAAG,CAAA;IACd,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAuD;QAM1D,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3B,IAAI,CAAC,CAAC,KAAK,IAAI,MAAM,CAAC,EAAE;gBACpB,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,CAAA;gBAE9B,OAAM;aACT;YAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;YAE3B,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBACtB,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;aACxF;iBAAM;gBACH,qCAAqC;gBACrC,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,KAAgB,CAAC,MAAM,CAAC,CAAA;aAC3E;QACL,CAAC,CAAC,CAAA;QAEF,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAE9E,OAAO,CAAC,KAAK,EAAE,EAAE;YACb,MAAM,CAAC,GAAG,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;YACrC,IAAI,CAAC,CAAC;gBAAE,OAAO,KAAK,CACnB;YACG,KAGH,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAE1B,OAAO,IAAI,CAAA;QACf,CAAC,CAAA;IACL,CAAC;CACJ;AAtHD,kDAsHC","sourcesContent":["import { CallbackQuery, MaybeArray, MtArgumentError } from '@mtcute/client'\n\nimport { UpdateFilter } from './filters/types.js'\n\n/**\n * Callback data builder, inspired by [aiogram](https://github.com/aiogram/aiogram).\n *\n * This can be used to simplify management of different callbacks.\n *\n * [Learn more in the docs](/guide/topics/keyboards.html#callback-data-builders)\n */\nexport class CallbackDataBuilder<T extends string> {\n    private readonly _fields: T[]\n\n    sep = ':'\n\n    /**\n     * @param prefix  Prefix for the data. Use something unique across your bot.\n     * @param fields  Field names in the order they will be serialized.\n     */\n    constructor(\n        public prefix: string,\n        ...fields: T[]\n    ) {\n        this._fields = fields\n    }\n\n    /**\n     * Build a callback data string\n     *\n     * @param obj  Object containing the data\n     */\n    build(obj: Record<T, string>): string {\n        const ret =\n            this.prefix +\n            this.sep +\n            this._fields\n                .map((f) => {\n                    const val = obj[f]\n\n                    if (val.includes(this.sep)) {\n                        throw new MtArgumentError(\n                            `Value for ${f} ${val} contains separator ${this.sep} and cannot be used.`,\n                        )\n                    }\n\n                    return val\n                })\n                .join(this.sep)\n\n        if (ret.length > 64) {\n            throw new MtArgumentError('Resulting callback data is too long.')\n        }\n\n        return ret\n    }\n\n    /**\n     * Parse callback data to object\n     *\n     * @param data  Callback data as string\n     */\n    parse(data: string): Record<T, string> {\n        const parts = data.split(this.sep)\n\n        if (parts[0] !== this.prefix) {\n            throw new MtArgumentError('Invalid data passed')\n        }\n\n        if (parts.length !== this._fields.length + 1) {\n            throw new MtArgumentError('Invalid data passed')\n        }\n\n        const ret = {} as Record<T, string>\n        parts.forEach((it, idx) => {\n            ret[this._fields[idx - 1]] = it\n        })\n\n        return ret\n    }\n\n    /**\n     * Create a filter for this callback data.\n     *\n     * > **Note**: `params` object will be compiled to a RegExp,\n     * > so avoid using characters that have special meaning in regex,\n     * > or use RegExp directly to let the IDE guide you.\n     *\n     * @param params\n     */\n    filter(params: Partial<Record<T, MaybeArray<string | RegExp>>>): UpdateFilter<\n        CallbackQuery,\n        {\n            match: Record<T, string>\n        }\n    > {\n        const parts: string[] = []\n\n        this._fields.forEach((field) => {\n            if (!(field in params)) {\n                parts.push(`[^${this.sep}]*?`)\n\n                return\n            }\n\n            const value = params[field]\n\n            if (Array.isArray(value)) {\n                parts.push(`(${value.map((i) => (typeof i === 'string' ? i : i.source)).join('|')})`)\n            } else {\n                // noinspection SuspiciousTypeOfGuard\n                parts.push(typeof value === 'string' ? value : (value as RegExp).source)\n            }\n        })\n\n        const regex = new RegExp(`^${this.prefix}${this.sep}${parts.join(this.sep)}$`)\n\n        return (query) => {\n            const m = query.dataStr?.match(regex)\n            if (!m) return false\n            ;(\n                query as CallbackQuery & {\n                    match: Record<T, string>\n                }\n            ).match = this.parse(m[0])\n\n            return true\n        }\n    }\n}\n"]}

package/cjs/context/base.d.ts

@@ -0,0 +1,8 @@
+import { ParsedUpdate, TelegramClient } from '@mtcute/client';
+export type UpdateContext<T> = T & {
+    client: TelegramClient;
+    _name: Extract<ParsedUpdate, {
+        data: T;
+    }>['name'];
+};
+export type UpdateContextDistributed<T> = T extends never ? never : UpdateContext<T>;

package/cjs/context/base.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=base.js.map

package/cjs/context/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../src/context/base.ts"],"names":[],"mappings":"","sourcesContent":["import { ParsedUpdate, TelegramClient } from '@mtcute/client'\n\nexport type UpdateContext<T> = T & {\n    client: TelegramClient\n    _name: Extract<ParsedUpdate, { data: T }>['name']\n}\n\nexport type UpdateContextDistributed<T> = T extends never ? never : UpdateContext<T>\n"]}

package/cjs/context/callback-query.d.ts

@@ -0,0 +1,27 @@
+import { CallbackQuery, TelegramClient } from '@mtcute/client';
+import { UpdateContext } from './base.js';
+/**
+ * Context of a callback query update.
+ *
+ * This is a subclass of {@link CallbackQuery}, so all its fields are also available.
+ */
+export declare class CallbackQueryContext extends CallbackQuery implements UpdateContext<CallbackQuery> {
+    readonly client: TelegramClient;
+    readonly _name = "callback_query";
+    constructor(client: TelegramClient, query: CallbackQuery);
+    /** Answer to this callback query */
+    answer(params: Parameters<TelegramClient['answerCallbackQuery']>[1]): Promise<void>;
+    /**
+     *      * Message that contained the callback button that was clicked.
+     *
+     * Note that the message may have been deleted, in which case
+     * `MessageNotFoundError` is thrown.
+     *
+     * Can only be used if `isInline = false`
+     */
+    getMessage(): Promise<import("@mtcute/client").Message>;
+    /**
+     * Edit the message that contained the callback button that was clicked.
+     */
+    editMessage(params: Omit<Parameters<TelegramClient['editInlineMessage']>[0], 'messageId'>): Promise<void | import("@mtcute/client").Message>;
+}

package/cjs/context/callback-query.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CallbackQueryContext = void 0;
+const client_1 = require("@mtcute/client");
+/**
+ * Context of a callback query update.
+ *
+ * This is a subclass of {@link CallbackQuery}, so all its fields are also available.
+ */
+class CallbackQueryContext extends client_1.CallbackQuery {
+    constructor(client, query) {
+        super(query.raw, query._peers);
+        this.client = client;
+        this._name = 'callback_query';
+    }
+    /** Answer to this callback query */
+    answer(params) {
+        return this.client.answerCallbackQuery(this.id, params);
+    }
+    /**
+     *      * Message that contained the callback button that was clicked.
+     *
+     * Note that the message may have been deleted, in which case
+     * `MessageNotFoundError` is thrown.
+     *
+     * Can only be used if `isInline = false`
+     */
+    async getMessage() {
+        if (this.raw._ !== 'updateBotCallbackQuery') {
+            throw new client_1.MtArgumentError('Cannot get message for inline callback query');
+        }
+        const [msg] = await this.client.getMessages(this.raw.peer, this.raw.msgId);
+        if (!msg) {
+            throw new client_1.MtMessageNotFoundError((0, client_1.getMarkedPeerId)(this.raw.peer), this.raw.msgId, 'Message not found');
+        }
+        return msg;
+    }
+    /**
+     * Edit the message that contained the callback button that was clicked.
+     */
+    async editMessage(params) {
+        if (this.raw._ === 'updateInlineBotCallbackQuery') {
+            return this.client.editInlineMessage({
+                messageId: this.raw.msgId,
+                ...params,
+            });
+        }
+        return this.client.editMessage({
+            chatId: this.raw.peer,
+            message: this.raw.msgId,
+            ...params,
+        });
+    }
+}
+exports.CallbackQueryContext = CallbackQueryContext;
+//# sourceMappingURL=callback-query.js.map

package/cjs/context/callback-query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"callback-query.js","sourceRoot":"","sources":["../../../src/context/callback-query.ts"],"names":[],"mappings":";;;AAAA,2CAAwH;AAIxH;;;;GAIG;AACH,MAAa,oBAAqB,SAAQ,sBAAa;IAGnD,YACa,MAAsB,EAC/B,KAAoB;QAEpB,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QAHrB,WAAM,GAAN,MAAM,CAAgB;QAH1B,UAAK,GAAG,gBAAgB,CAAA;IAOjC,CAAC;IAED,oCAAoC;IACpC,MAAM,CAAC,MAA4D;QAC/D,OAAO,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC3D,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,UAAU;QACZ,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,wBAAwB,EAAE;YACzC,MAAM,IAAI,wBAAe,CAAC,8CAA8C,CAAC,CAAA;SAC5E;QAED,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QAE1E,IAAI,CAAC,GAAG,EAAE;YACN,MAAM,IAAI,+BAAsB,CAAC,IAAA,wBAAe,EAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAA;SACxG;QAED,OAAO,GAAG,CAAA;IACd,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAC,MAA6E;QAC3F,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,8BAA8B,EAAE;YAC/C,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC;gBACjC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK;gBACzB,GAAG,MAAM;aACZ,CAAC,CAAA;SACL;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;YAC3B,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI;YACrB,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK;YACvB,GAAG,MAAM;SACZ,CAAC,CAAA;IACN,CAAC;CACJ;AAtDD,oDAsDC","sourcesContent":["import { CallbackQuery, getMarkedPeerId, MtArgumentError, MtMessageNotFoundError, TelegramClient } from '@mtcute/client'\n\nimport { UpdateContext } from './base.js'\n\n/**\n * Context of a callback query update.\n *\n * This is a subclass of {@link CallbackQuery}, so all its fields are also available.\n */\nexport class CallbackQueryContext extends CallbackQuery implements UpdateContext<CallbackQuery> {\n    readonly _name = 'callback_query'\n\n    constructor(\n        readonly client: TelegramClient,\n        query: CallbackQuery,\n    ) {\n        super(query.raw, query._peers)\n    }\n\n    /** Answer to this callback query */\n    answer(params: Parameters<TelegramClient['answerCallbackQuery']>[1]) {\n        return this.client.answerCallbackQuery(this.id, params)\n    }\n\n    /**\n     *      * Message that contained the callback button that was clicked.\n     *\n     * Note that the message may have been deleted, in which case\n     * `MessageNotFoundError` is thrown.\n     *\n     * Can only be used if `isInline = false`\n     */\n    async getMessage() {\n        if (this.raw._ !== 'updateBotCallbackQuery') {\n            throw new MtArgumentError('Cannot get message for inline callback query')\n        }\n\n        const [msg] = await this.client.getMessages(this.raw.peer, this.raw.msgId)\n\n        if (!msg) {\n            throw new MtMessageNotFoundError(getMarkedPeerId(this.raw.peer), this.raw.msgId, 'Message not found')\n        }\n\n        return msg\n    }\n\n    /**\n     * Edit the message that contained the callback button that was clicked.\n     */\n    async editMessage(params: Omit<Parameters<TelegramClient['editInlineMessage']>[0], 'messageId'>) {\n        if (this.raw._ === 'updateInlineBotCallbackQuery') {\n            return this.client.editInlineMessage({\n                messageId: this.raw.msgId,\n                ...params,\n            })\n        }\n\n        return this.client.editMessage({\n            chatId: this.raw.peer,\n            message: this.raw.msgId,\n            ...params,\n        })\n    }\n}\n"]}

package/cjs/context/chat-join-request.d.ts

@@ -0,0 +1,16 @@
+import { BotChatJoinRequestUpdate, TelegramClient } from '@mtcute/client';
+import { UpdateContext } from './base.js';
+/**
+ * Context of a chat join request update (for bots).
+ *
+ * This is a subclass of {@link BotChatJoinRequestUpdate}, so all its fields are also available.
+ */
+export declare class ChatJoinRequestUpdateContext extends BotChatJoinRequestUpdate implements UpdateContext<BotChatJoinRequestUpdate> {
+    readonly client: TelegramClient;
+    readonly _name = "bot_chat_join_request";
+    constructor(client: TelegramClient, update: BotChatJoinRequestUpdate);
+    /** Approve the request */
+    approve(): Promise<void>;
+    /** Decline the request */
+    decline(): Promise<void>;
+}

package/cjs/context/chat-join-request.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatJoinRequestUpdateContext = void 0;
+const client_1 = require("@mtcute/client");
+/**
+ * Context of a chat join request update (for bots).
+ *
+ * This is a subclass of {@link BotChatJoinRequestUpdate}, so all its fields are also available.
+ */
+class ChatJoinRequestUpdateContext extends client_1.BotChatJoinRequestUpdate {
+    constructor(client, update) {
+        super(update.raw, update._peers);
+        this.client = client;
+        this._name = 'bot_chat_join_request';
+    }
+    /** Approve the request */
+    approve() {
+        return this.client.hideJoinRequest({
+            action: 'approve',
+            user: this.user.inputPeer,
+            chatId: this.chat.inputPeer,
+        });
+    }
+    /** Decline the request */
+    decline() {
+        return this.client.hideJoinRequest({
+            action: 'decline',
+            user: this.user.inputPeer,
+            chatId: this.chat.inputPeer,
+        });
+    }
+}
+exports.ChatJoinRequestUpdateContext = ChatJoinRequestUpdateContext;
+//# sourceMappingURL=chat-join-request.js.map

package/cjs/context/chat-join-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chat-join-request.js","sourceRoot":"","sources":["../../../src/context/chat-join-request.ts"],"names":[],"mappings":";;;AAAA,2CAAyE;AAIzE;;;;GAIG;AACH,MAAa,4BACT,SAAQ,iCAAwB;IAIhC,YACa,MAAsB,EAC/B,MAAgC;QAEhC,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;QAHvB,WAAM,GAAN,MAAM,CAAgB;QAH1B,UAAK,GAAG,uBAAuB,CAAA;IAOxC,CAAC;IAED,0BAA0B;IAC1B,OAAO;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;YAC/B,MAAM,EAAE,SAAS;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS;YACzB,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS;SAC9B,CAAC,CAAA;IACN,CAAC;IAED,0BAA0B;IAC1B,OAAO;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;YAC/B,MAAM,EAAE,SAAS;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS;YACzB,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS;SAC9B,CAAC,CAAA;IACN,CAAC;CACJ;AA7BD,oEA6BC","sourcesContent":["import { BotChatJoinRequestUpdate, TelegramClient } from '@mtcute/client'\n\nimport { UpdateContext } from './base.js'\n\n/**\n * Context of a chat join request update (for bots).\n *\n * This is a subclass of {@link BotChatJoinRequestUpdate}, so all its fields are also available.\n */\nexport class ChatJoinRequestUpdateContext\n    extends BotChatJoinRequestUpdate\n    implements UpdateContext<BotChatJoinRequestUpdate> {\n    readonly _name = 'bot_chat_join_request'\n\n    constructor(\n        readonly client: TelegramClient,\n        update: BotChatJoinRequestUpdate,\n    ) {\n        super(update.raw, update._peers)\n    }\n\n    /** Approve the request */\n    approve(): Promise<void> {\n        return this.client.hideJoinRequest({\n            action: 'approve',\n            user: this.user.inputPeer,\n            chatId: this.chat.inputPeer,\n        })\n    }\n\n    /** Decline the request */\n    decline(): Promise<void> {\n        return this.client.hideJoinRequest({\n            action: 'decline',\n            user: this.user.inputPeer,\n            chatId: this.chat.inputPeer,\n        })\n    }\n}\n"]}

package/cjs/context/chosen-inline-result.d.ts

@@ -0,0 +1,21 @@
+import { ChosenInlineResult, TelegramClient } from '@mtcute/client';
+import { UpdateContext } from './base.js';
+/**
+ * Context of a chosen inline result update.
+ *
+ * This is a subclass of {@link ChosenInlineResult}, so all its fields are also available.
+ *
+ * > **Note**: To receive these updates, you must enable
+ * > Inline feedback in [@BotFather](//t.me/botfather)
+ */
+export declare class ChosenInlineResultContext extends ChosenInlineResult implements UpdateContext<ChosenInlineResult> {
+    readonly client: TelegramClient;
+    readonly _name = "chosen_inline_result";
+    constructor(client: TelegramClient, result: ChosenInlineResult);
+    /**
+     * Edit the message that was sent when this inline result that was chosen.
+     *
+     * > **Note**: This method can only be used if the message contained a reply markup
+     */
+    editMessage(params: Parameters<TelegramClient['editInlineMessage']>[0]): Promise<void>;
+}

package/cjs/context/chosen-inline-result.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChosenInlineResultContext = void 0;
+const client_1 = require("@mtcute/client");
+/**
+ * Context of a chosen inline result update.
+ *
+ * This is a subclass of {@link ChosenInlineResult}, so all its fields are also available.
+ *
+ * > **Note**: To receive these updates, you must enable
+ * > Inline feedback in [@BotFather](//t.me/botfather)
+ */
+class ChosenInlineResultContext extends client_1.ChosenInlineResult {
+    constructor(client, result) {
+        super(result.raw, result._peers);
+        this.client = client;
+        this._name = 'chosen_inline_result';
+    }
+    /**
+     * Edit the message that was sent when this inline result that was chosen.
+     *
+     * > **Note**: This method can only be used if the message contained a reply markup
+     */
+    async editMessage(params) {
+        if (!this.raw.msgId) {
+            throw new client_1.MtArgumentError('No message ID, make sure you have included reply markup!');
+        }
+        return this.client.editInlineMessage({
+            ...params,
+            messageId: this.raw.msgId,
+        });
+    }
+}
+exports.ChosenInlineResultContext = ChosenInlineResultContext;
+//# sourceMappingURL=chosen-inline-result.js.map

package/cjs/context/chosen-inline-result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chosen-inline-result.js","sourceRoot":"","sources":["../../../src/context/chosen-inline-result.ts"],"names":[],"mappings":";;;AAAA,2CAAoF;AAIpF;;;;;;;GAOG;AACH,MAAa,yBAA0B,SAAQ,2BAAkB;IAG7D,YACa,MAAsB,EAC/B,MAA0B;QAE1B,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;QAHvB,WAAM,GAAN,MAAM,CAAgB;QAH1B,UAAK,GAAG,sBAAsB,CAAA;IAOvC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,CAAC,MAA0D;QACxE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE;YACjB,MAAM,IAAI,wBAAe,CAAC,0DAA0D,CAAC,CAAA;SACxF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC;YACjC,GAAG,MAAM;YACT,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK;SAC5B,CAAC,CAAA;IACN,CAAC;CACJ;AAzBD,8DAyBC","sourcesContent":["import { ChosenInlineResult, MtArgumentError, TelegramClient } from '@mtcute/client'\n\nimport { UpdateContext } from './base.js'\n\n/**\n * Context of a chosen inline result update.\n *\n * This is a subclass of {@link ChosenInlineResult}, so all its fields are also available.\n *\n * > **Note**: To receive these updates, you must enable\n * > Inline feedback in [@BotFather](//t.me/botfather)\n */\nexport class ChosenInlineResultContext extends ChosenInlineResult implements UpdateContext<ChosenInlineResult> {\n    readonly _name = 'chosen_inline_result'\n\n    constructor(\n        readonly client: TelegramClient,\n        result: ChosenInlineResult,\n    ) {\n        super(result.raw, result._peers)\n    }\n\n    /**\n     * Edit the message that was sent when this inline result that was chosen.\n     *\n     * > **Note**: This method can only be used if the message contained a reply markup\n     */\n    async editMessage(params: Parameters<TelegramClient['editInlineMessage']>[0]): Promise<void> {\n        if (!this.raw.msgId) {\n            throw new MtArgumentError('No message ID, make sure you have included reply markup!')\n        }\n\n        return this.client.editInlineMessage({\n            ...params,\n            messageId: this.raw.msgId,\n        })\n    }\n}\n"]}

package/cjs/context/index.d.ts

@@ -0,0 +1,8 @@
+export * from './base.js';
+export * from './callback-query.js';
+export * from './chat-join-request.js';
+export * from './chosen-inline-result.js';
+export * from './inline-query.js';
+export * from './message.js';
+export { UpdateContextType } from './parse.js';
+export * from './pre-checkout-query.js';

package/cjs/context/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./base.js"), exports);
+__exportStar(require("./callback-query.js"), exports);
+__exportStar(require("./chat-join-request.js"), exports);
+__exportStar(require("./chosen-inline-result.js"), exports);
+__exportStar(require("./inline-query.js"), exports);
+__exportStar(require("./message.js"), exports);
+__exportStar(require("./pre-checkout-query.js"), exports);
+//# sourceMappingURL=index.js.map

package/cjs/context/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/context/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAAyB;AACzB,sDAAmC;AACnC,yDAAsC;AACtC,4DAAyC;AACzC,oDAAiC;AACjC,+CAA4B;AAE5B,0DAAuC","sourcesContent":["export * from './base.js'\nexport * from './callback-query.js'\nexport * from './chat-join-request.js'\nexport * from './chosen-inline-result.js'\nexport * from './inline-query.js'\nexport * from './message.js'\nexport { UpdateContextType } from './parse.js'\nexport * from './pre-checkout-query.js'\n"]}

package/cjs/context/inline-query.d.ts

@@ -0,0 +1,14 @@
+import { InlineQuery, ParametersSkip1, TelegramClient } from '@mtcute/client';
+import { UpdateContext } from './base.js';
+/**
+ * Context of an inline query update.
+ *
+ * This is a subclass of {@link InlineQuery}, so all its fields are also available.
+ */
+export declare class InlineQueryContext extends InlineQuery implements UpdateContext<InlineQuery> {
+    readonly client: TelegramClient;
+    readonly _name = "inline_query";
+    constructor(client: TelegramClient, query: InlineQuery);
+    /** Answer to this inline query */
+    answer(...params: ParametersSkip1<TelegramClient['answerInlineQuery']>): Promise<void>;
+}

package/cjs/context/inline-query.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InlineQueryContext = void 0;
+const client_1 = require("@mtcute/client");
+/**
+ * Context of an inline query update.
+ *
+ * This is a subclass of {@link InlineQuery}, so all its fields are also available.
+ */
+class InlineQueryContext extends client_1.InlineQuery {
+    constructor(client, query) {
+        super(query.raw, query._peers);
+        this.client = client;
+        this._name = 'inline_query';
+    }
+    /** Answer to this inline query */
+    answer(...params) {
+        return this.client.answerInlineQuery(this.id, ...params);
+    }
+}
+exports.InlineQueryContext = InlineQueryContext;
+//# sourceMappingURL=inline-query.js.map

package/cjs/context/inline-query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inline-query.js","sourceRoot":"","sources":["../../../src/context/inline-query.ts"],"names":[],"mappings":";;;AAAA,2CAA6E;AAI7E;;;;GAIG;AACH,MAAa,kBAAmB,SAAQ,oBAAW;IAG/C,YACa,MAAsB,EAC/B,KAAkB;QAElB,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;QAHrB,WAAM,GAAN,MAAM,CAAgB;QAH1B,UAAK,GAAG,cAAc,CAAA;IAO/B,CAAC;IAED,kCAAkC;IAClC,MAAM,CAAC,GAAG,MAA4D;QAClE,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,CAAA;IAC5D,CAAC;CACJ;AAdD,gDAcC","sourcesContent":["import { InlineQuery, ParametersSkip1, TelegramClient } from '@mtcute/client'\n\nimport { UpdateContext } from './base.js'\n\n/**\n * Context of an inline query update.\n *\n * This is a subclass of {@link InlineQuery}, so all its fields are also available.\n */\nexport class InlineQueryContext extends InlineQuery implements UpdateContext<InlineQuery> {\n    readonly _name = 'inline_query'\n\n    constructor(\n        readonly client: TelegramClient,\n        query: InlineQuery,\n    ) {\n        super(query.raw, query._peers)\n    }\n\n    /** Answer to this inline query */\n    answer(...params: ParametersSkip1<TelegramClient['answerInlineQuery']>) {\n        return this.client.answerInlineQuery(this.id, ...params)\n    }\n}\n"]}

package/cjs/context/message.d.ts

@@ -0,0 +1,72 @@
+import { Message, OmitInputMessageId, ParametersSkip1, TelegramClient } from '@mtcute/client';
+import { DeleteMessagesParams } from '@mtcute/client/methods/messages/delete-messages.js';
+import { ForwardMessageOptions } from '@mtcute/client/methods/messages/forward-messages.js';
+import { SendCopyParams } from '@mtcute/client/methods/messages/send-copy.js';
+import { SendCopyGroupParams } from '@mtcute/client/methods/messages/send-copy-group.js';
+import { UpdateContext } from './base.js';
+/**
+ * Context of a message-related update.
+ *
+ * This is a subclass of {@link Message}, so all fields
+ * of the message are available.
+ *
+ * For message groups, own fields are related to the last message
+ * in the group. To access all messages, use {@link MessageContext#messages}.
+ */
+export declare class MessageContext extends Message implements UpdateContext<Message> {
+    readonly client: TelegramClient;
+    readonly _name = "new_message";
+    /**
+     * List of messages in the message group.
+     *
+     * For other updates, this is a list with a single element (`this`).
+     */
+    readonly messages: MessageContext[];
+    /** Whether this update is about a message group */
+    readonly isMessageGroup: boolean;
+    constructor(client: TelegramClient, message: Message | Message[]);
+    /** Get a message that this message is a reply to */
+    getReplyTo(): Promise<Message | null>;
+    /** If this is a channel post, get its automatic forward in the discussion group */
+    getDiscussionMessage(): Promise<Message | null>;
+    /** Get all custom emojis contained in this message (message group), if any */
+    getCustomEmojis(): Promise<import("@mtcute/client").Sticker[]>;
+    /** Send a text message to the same chat (and topic, if applicable) as a given message */
+    answerText(...params: ParametersSkip1<TelegramClient['answerText']>): Promise<Message>;
+    /** Send a media to the same chat (and topic, if applicable) as a given message */
+    answerMedia(...params: ParametersSkip1<TelegramClient['answerMedia']>): Promise<Message>;
+    /** Send a media group to the same chat (and topic, if applicable) as a given message */
+    answerMediaGroup(...params: ParametersSkip1<TelegramClient['answerMediaGroup']>): Promise<Message[]>;
+    /** Send a text message in reply to this message */
+    replyText(...params: ParametersSkip1<TelegramClient['replyText']>): Promise<Message>;
+    /** Send a media in reply to this message */
+    replyMedia(...params: ParametersSkip1<TelegramClient['replyMedia']>): Promise<Message>;
+    /** Send a media group in reply to this message */
+    replyMediaGroup(...params: ParametersSkip1<TelegramClient['replyMediaGroup']>): Promise<Message[]>;
+    /** Send a text message in reply to this message */
+    quoteWithText(params: Parameters<TelegramClient['quoteWithText']>[1]): Promise<Message>;
+    /** Send a media in reply to this message */
+    quoteWithMedia(params: Parameters<TelegramClient['quoteWithMedia']>[1]): Promise<Message>;
+    /** Send a media group in reply to this message */
+    quoteWithMediaGroup(params: Parameters<TelegramClient['quoteWithMediaGroup']>[1]): Promise<Message[]>;
+    /** Send a text as a comment to this message */
+    commentText(...params: ParametersSkip1<TelegramClient['commentText']>): Promise<Message>;
+    /** Send a media as a comment to this message */
+    commentMedia(...params: ParametersSkip1<TelegramClient['commentMedia']>): Promise<Message>;
+    /** Send a media group as a comment to this message */
+    commentMediaGroup(...params: ParametersSkip1<TelegramClient['commentMediaGroup']>): Promise<Message[]>;
+    /** Delete this message (message group) */
+    delete(params?: DeleteMessagesParams): Promise<void>;
+    /** Pin this message */
+    pin(params?: OmitInputMessageId<Parameters<TelegramClient['pinMessage']>[0]>): Promise<Message | null>;
+    /** Unpin this message */
+    unpin(): Promise<void>;
+    /** Edit this message */
+    edit(params: OmitInputMessageId<Parameters<TelegramClient['editMessage']>[0]>): Promise<Message>;
+    /** Forward this message (message group) */
+    forwardTo(params: ForwardMessageOptions): Promise<Message[]>;
+    /** Send a copy of this message (message group) */
+    copy(params: SendCopyParams & SendCopyGroupParams): Promise<Message> | Promise<Message[]>;
+    /** React to this message */
+    react(params: OmitInputMessageId<Parameters<TelegramClient['sendReaction']>[0]>): Promise<Message>;
+}