@mtcute/core 0.7.3 → 0.9.0

package/esm/highlevel/types/bots/inline-result/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../src/highlevel/types/bots/inline-result/types.ts"],"names":[],"mappings":"","sourcesContent":["import { tl } from '@mtcute/tl'\n\nimport { InputInlineMessage } from '../inline-message/types.js'\n\nexport interface BaseInputInlineResult {\n    /**\n     * Unique ID of the result\n     */\n    id: string\n\n    /**\n     * Message to send when the result is selected.\n     *\n     * By default, is automatically generated,\n     * and details about how it is generated can be found\n     * in subclasses' description\n     */\n    message?: InputInlineMessage\n}\n\n/**\n * Inline result containing an article.\n *\n * If `message` is not provided, a {@link InputInlineMessageText} is created\n * with web preview enabled and text generated as follows:\n * ```\n * {{#if url}}\n * <a href=\"{{url}}\"><b>{{title}}</b></a>\n * {{else}}\n * <b>{{title}}</b>\n * {{/if}}\n * {{#if description}}\n * {{description}}\n * {{/if}}\n * ```\n * > Handlebars syntax is used. HTML tags are used to signify entities,\n * > but in fact raw TL entity objects are created\n */\nexport interface InputInlineResultArticle extends BaseInputInlineResult {\n    type: 'article'\n\n    /**\n     * Title of the result (must not be empty)\n     */\n    title: string\n\n    /**\n     * Description of the result\n     */\n    description?: string\n\n    /**\n     * URL of the article\n     */\n    url?: string\n\n    /**\n     * Whether to prevent article URL from\n     * displaying by the client\n     *\n     * @default  `false`\n     */\n    hideUrl?: boolean\n\n    /**\n     * Article thumbnail URL (must be jpeg).\n     */\n    thumb?: string | tl.RawInputWebDocument\n}\n\n/**\n * Inline result containing an animation (silent mp4 or gif).\n *\n * If `message` is not provided, {@link InputInlineMessageMedia} is used\n * with empty caption\n */\nexport interface InputInlineResultGif extends BaseInputInlineResult {\n    type: 'gif'\n\n    /**\n     * The animation itself.\n     *\n     * Can be a URL, a TDLib and Bot API compatible File ID,\n     * or a TL object representing either of them.\n     */\n    media: string | tl.RawInputWebDocument | tl.RawInputDocument\n\n    /**\n     * Media MIME type, only applicable to URLs.\n     *\n     * Usually unnecessary, since Telegram automatically infers it.\n     *\n     * @default `video/mp4`\n     */\n    mime?: string\n\n    /**\n     * Title of the result\n     */\n    title?: string\n\n    /**\n     * Title of the result\n     */\n    description?: string\n\n    /**\n     * Animation thumbnail URL, only applicable in case `media` is a URL\n     *\n     * @default  `media`\n     */\n    thumb?: string | tl.RawInputWebDocument\n\n    /**\n     * Thumbnail MIME type\n     *\n     * @default  `image/jpeg`\n     */\n    thumbMime?: string\n\n    /**\n     * Width of the animation in pixels\n     */\n    width?: number\n\n    /**\n     * Height of the animation in pixels\n     */\n    height?: number\n\n    /**\n     * Duration of the animation in seconds\n     */\n    duration?: number\n}\n\n/**\n * Inline result containing a video (only MP4)\n *\n * If `message` is not provided, {@link InputInlineMessageMedia} is used\n * with empty caption for non-embed videos, {@link InputInlineMessageText}\n * is used with text containing the URL for embed videos.\n */\nexport interface InputInlineResultVideo extends BaseInputInlineResult {\n    type: 'video'\n\n    /**\n     * The video itself, or a page containing an embedded video\n     *\n     * Can be a URL, a TDLib and Bot API compatible File ID,\n     * or a TL object representing either of them.\n     */\n    media: string | tl.RawInputWebDocument | tl.RawInputDocument\n\n    /**\n     * In case `media` is a URL, whether that URL is a link\n     * to an embedded video player.\n     */\n    isEmbed?: boolean\n\n    /**\n     * Title of the result\n     */\n    title: string\n\n    /**\n     * Description of the result\n     */\n    description?: string\n\n    /**\n     * Video thumbnail URL (must be jpeg), only applicable in case `media` is a URL.\n     *\n     * Must be provided explicitly if this is a video loaded by URL.\n     *\n     * @default  `media`\n     */\n    thumb?: string | tl.RawInputWebDocument\n\n    /**\n     * Width of the video in pixels\n     */\n    width?: number\n\n    /**\n     * Height of the video in pixels\n     */\n    height?: number\n\n    /**\n     * Duration of the video in seconds\n     */\n    duration?: number\n}\n\n/**\n * Inline result containing an audio file\n *\n * If `message` is not provided, {@link InputInlineMessageMedia} is used\n * with empty caption.\n */\nexport interface InputInlineResultAudio extends BaseInputInlineResult {\n    type: 'audio'\n\n    /**\n     * The audio itself\n     *\n     * Can be a URL, a TDLib and Bot API compatible File ID,\n     * or a TL object representing either of them.\n     */\n    media: string | tl.RawInputWebDocument | tl.RawInputDocument\n\n    /**\n     * MIME type of the audio file\n     *\n     * Usually unnecessary, since Telegram infers it automatically.\n     *\n     * @default  `audio/mpeg`\n     */\n    mime?: string\n\n    /**\n     * Title of the audio track\n     */\n    title: string\n\n    /**\n     * Performer of the audio track\n     */\n    performer?: string\n\n    /**\n     * Duration of the audio in seconds\n     */\n    duration?: number\n}\n\n/**\n * Inline result containing a voice note\n *\n * If `message` is not provided, {@link InputInlineMessageMedia} is used\n * with empty caption.\n */\nexport interface InputInlineResultVoice extends BaseInputInlineResult {\n    type: 'voice'\n\n    /**\n     * The voice itself (.ogg, preferably encoded with OPUS)\n     *\n     * Can be a URL, a TDLib and Bot API compatible File ID,\n     * or a TL object representing either of them.\n     */\n    media: string | tl.RawInputWebDocument | tl.RawInputDocument\n\n    /**\n     * Title of the result\n     */\n    title: string\n\n    /**\n     * Duration of the voice note in seconds\n     */\n    duration?: number\n}\n\n/**\n * Inline result containing a photo\n *\n * If `message` is not provided, {@link InputInlineMessageMedia} is used\n * with empty caption.\n */\nexport interface InputInlineResultPhoto extends BaseInputInlineResult {\n    type: 'photo'\n\n    /**\n     * The photo itself\n     *\n     * Can be a URL, a TDLib and Bot API compatible File ID,\n     * or a TL object representing either of them.\n     */\n    media: string | tl.RawInputWebDocument | tl.RawInputPhoto\n\n    /**\n     * Title of the result\n     */\n    title?: string\n\n    /**\n     * Description of the result\n     */\n    description?: string\n\n    /**\n     * Width of the photo in pixels\n     */\n    width?: number\n\n    /**\n     * Height of the photo in pixels\n     */\n    height?: number\n\n    /**\n     * Photo thumbnail URL (must be jpeg), only applicable in case `media` is a URL\n     *\n     * @default  `media`\n     */\n    thumb?: string | tl.RawInputWebDocument\n}\n\n/**\n * Inline result containing a sticker\n *\n * If `message` is not provided, {@link InputInlineMessageMedia} is used.\n */\nexport interface InputInlineResultSticker extends BaseInputInlineResult {\n    type: 'sticker'\n\n    /**\n     * The sticker itself. Can't be a URL.\n     */\n    media: string | tl.RawInputDocument\n}\n\n/**\n * Inline result containing a document\n *\n * If `message` is not provided, {@link InputInlineMessageMedia} is used\n * with empty caption.\n */\nexport interface InputInlineResultFile extends BaseInputInlineResult {\n    type: 'file'\n\n    /**\n     * The file itself. When using URL, only PDF and ZIP are supported.\n     *\n     * Can be a URL, a TDLib and Bot API compatible File ID,\n     * or a TL object representing either of them.\n     */\n    media: string | tl.RawInputWebDocument | tl.RawInputDocument\n\n    /**\n     * MIME type of the file.\n     *\n     * Due to some Telegram limitation, you can only send\n     * PDF and ZIP files from URL\n     * (`application/pdf` and `application/zip` MIMEs respectively).\n     *\n     * Must be provided if `media` is a URL\n     */\n    mime?: string\n\n    /**\n     * Title of the result\n     */\n    title: string\n\n    /**\n     * Description of the result\n     */\n    description?: string\n\n    /**\n     * Photo thumbnail URL (must be jpeg), only applicable in case `media` is a URL\n     *\n     * @default  `media`\n     */\n    thumb?: string | tl.RawInputWebDocument\n}\n\n/**\n * Inline result containing a geolocation.\n *\n * If `message` is not passed, a {@link InputInlineMessageGeo} is\n * used, with the `latitude` and `longitude` parameters set\n * accordingly\n */\nexport interface InputInlineResultGeo extends BaseInputInlineResult {\n    type: 'geo'\n\n    /**\n     * Title of the result\n     */\n    title: string\n\n    /**\n     * Latitude of the geolocation\n     */\n    latitude: number\n\n    /**\n     * Longitude of the geolocation\n     */\n    longitude: number\n\n    /**\n     * Location thumbnail URL (must be jpeg).\n     *\n     * By default, Telegram generates one based on\n     * the location set by `latitude` and `longitude`\n     */\n    thumb?: string | tl.RawInputWebDocument\n}\n\n/**\n * Inline result containing a venue.\n *\n * If `message` is not passed, {@link BotInlineMessage.venue} is used with\n * given `latitude` and `longitude` were passed.\n * If they weren't passed either, an error is thrown.\n */\nexport interface InputInlineResultVenue extends BaseInputInlineResult {\n    type: 'venue'\n\n    /**\n     * Title of the venue\n     */\n    title: string\n\n    /**\n     * Address of the venue\n     */\n    address: string\n\n    /**\n     * Latitude of the geolocation\n     */\n    latitude?: number\n\n    /**\n     * Longitude of the geolocation\n     */\n    longitude?: number\n\n    /**\n     * Venue thumbnail URL (must be jpeg).\n     *\n     * By default, Telegram generates one based on\n     * the location in the `message`\n     */\n    thumb?: string | tl.RawInputWebDocument\n}\n\n/**\n * Inline result containing a game.\n *\n * If `message` is not passed, {@link InputInlineMessageGame} is used.\n *\n * Note that `message` can only be {@link InputInlineMessageGame}\n */\nexport interface InputInlineResultGame extends BaseInputInlineResult {\n    type: 'game'\n\n    /**\n     * Short name of the game\n     */\n    shortName: string\n}\n\n/**\n * Inline result containing a contact.\n *\n * If `message` is not passed, {@link InputInlineMessageContact} is used.\n */\nexport interface InputInlineResultContact extends BaseInputInlineResult {\n    type: 'contact'\n\n    /**\n     * First name of the contact\n     */\n    firstName: string\n\n    /**\n     * Last name of the contact\n     */\n    lastName?: string\n\n    /**\n     * Phone number of the contact\n     */\n    phone: string\n\n    /**\n     * Contact thumbnail URL (i.e. their avatar) (must be jpeg)\n     */\n    thumb?: string | tl.RawInputWebDocument\n}\n\nexport type InputInlineResult =\n    | InputInlineResultArticle\n    | InputInlineResultGif\n    | InputInlineResultVideo\n    | InputInlineResultAudio\n    | InputInlineResultVoice\n    | InputInlineResultPhoto\n    | InputInlineResultSticker\n    | InputInlineResultFile\n    | InputInlineResultGeo\n    | InputInlineResultVenue\n    | InputInlineResultGame\n    | InputInlineResultContact\n"]}

package/esm/highlevel/types/bots/{keyboard-builder.d.ts → keyboards/builder.d.ts}

@@ -1,5 +1,5 @@
 import { tl } from '@mtcute/tl';
-import type { InlineKeyboardMarkup, ReplyKeyboardMarkup } from './keyboards.js';
+import type { InlineKeyboardMarkup, ReplyKeyboardMarkup } from './types.js';
 export type ButtonLike = tl.TypeKeyboardButton | false | null | undefined | void;
 /**
  * Builder for bot keyboards

package/esm/highlevel/types/bots/{keyboard-builder.js → keyboards/builder.js}

@@ -86,4 +86,4 @@ export class BotKeyboardBuilder {
         return ret;
     }
 }
-//# sourceMappingURL=keyboard-builder.js.map
+//# sourceMappingURL=builder.js.map

package/esm/highlevel/types/bots/keyboards/builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder.js","sourceRoot":"","sources":["../../../../../../src/highlevel/types/bots/keyboards/builder.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAG3B,YAAqB,cAA6B,CAAC;QAA9B,gBAAW,GAAX,WAAW,CAAmB;QAF3C,aAAQ,GAA8B,EAAE,CAAA;IAEM,CAAC;IAEvD;;;;OAIG;IACH,IAAI,CAAC,GAAG,OAA4C;QAChD,IAAI,CAAC,OAAO,CAAC,MAAM;YAAE,OAAO,IAAI,CAAA;QAEhC,IAAI,GAAG,GAA4B,EAAE,CAAA;QACrC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACpB,IAAI,OAAO,GAAG,KAAK,UAAU;gBAAE,GAAG,GAAG,GAAG,EAAE,CAAA;YAC1C,IAAI,CAAC,GAAG;gBAAE,OAAM;YAEhB,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAEb,IAAI,GAAG,CAAC,MAAM,KAAK,IAAI,CAAC,WAAW,EAAE;gBACjC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;gBACvB,GAAG,GAAG,EAAE,CAAA;aACX;QACL,CAAC,CAAC,CAAA;QAEF,IAAI,GAAG,CAAC,MAAM,EAAE;YACZ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;SAC1B;QAED,OAAO,IAAI,CAAA;IACf,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,GAAiD;QACjD,IAAI,OAAO,GAAG,KAAK,UAAU,EAAE;YAC3B,MAAM,EAAE,GAAG,GAAG,CAAA;YACd,GAAG,GAAG,EAAE,CAAA;YACR,EAAE,CAAC,GAAG,CAAC,CAAA;SACV;QAED,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,CAA4B,CAAA;QAC7D,IAAI,MAAM,CAAC,MAAM;YAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAE7C,OAAO,IAAI,CAAA;IACf,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,GAAoC,EAAE,KAAK,GAAG,KAAK;QACtD,IAAI,OAAO,GAAG,KAAK,UAAU;YAAE,GAAG,GAAG,GAAG,EAAE,CAAA;QAC1C,IAAI,CAAC,GAAG;YAAE,OAAO,IAAI,CAAA;QAErB,IACI,IAAI,CAAC,QAAQ,CAAC,MAAM;YACpB,CAAC,IAAI,CAAC,WAAW,KAAK,IAAI,IAAI,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,EAC3G;YACE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;SACpD;aAAM;YACH,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;SAC5B;QAED,OAAO,IAAI,CAAA;IACf,CAAC;IAED;;OAEG;IACH,QAAQ;QACJ,OAAO;YACH,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,IAAI,CAAC,QAAQ;SACzB,CAAA;IACL,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,SAAwD,EAAE;QAC9D,MAAM,GAAG,GAAG,MAAyC,CAAA;QACrD,GAAG,CAAC,IAAI,GAAG,OAAO,CAAA;QAClB,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAA;QAE3B,OAAO,GAAG,CAAA;IACd,CAAC;CACJ","sourcesContent":["import { tl } from '@mtcute/tl'\n\nimport type { InlineKeyboardMarkup, ReplyKeyboardMarkup } from './types.js'\n\nexport type ButtonLike = tl.TypeKeyboardButton | false | null | undefined | void\n\n/**\n * Builder for bot keyboards\n */\nexport class BotKeyboardBuilder {\n    private _buttons: tl.TypeKeyboardButton[][] = []\n\n    constructor(readonly maxRowWidth: number | null = 3) {}\n\n    /**\n     * Add buttons, wrapping them once {@link maxRowWidth} is reached\n     *\n     * @param buttons  Buttons to add\n     */\n    push(...buttons: (ButtonLike | (() => ButtonLike))[]): this {\n        if (!buttons.length) return this\n\n        let row: tl.TypeKeyboardButton[] = []\n        buttons.forEach((btn) => {\n            if (typeof btn === 'function') btn = btn()\n            if (!btn) return\n\n            row.push(btn)\n\n            if (row.length === this.maxRowWidth) {\n                this._buttons.push(row)\n                row = []\n            }\n        })\n\n        if (row.length) {\n            this._buttons.push(row)\n        }\n\n        return this\n    }\n\n    /**\n     * Add a row of buttons. Will not be wrapped.\n     *\n     * @param row  Row or a function that will populate it\n     */\n    row(row: ButtonLike[] | ((arr: ButtonLike[]) => void)): this {\n        if (typeof row === 'function') {\n            const fn = row\n            row = []\n            fn(row)\n        }\n\n        const normal = row.filter(Boolean) as tl.TypeKeyboardButton[]\n        if (normal.length) this._buttons.push(normal)\n\n        return this\n    }\n\n    /**\n     * Append a button to the last row, wrapping if needed.\n     *\n     * @param btn  Button to add\n     * @param force  Whether to forcefully add the button (i.e. do not wrap)\n     */\n    append(btn: ButtonLike | (() => ButtonLike), force = false): this {\n        if (typeof btn === 'function') btn = btn()\n        if (!btn) return this\n\n        if (\n            this._buttons.length &&\n            (this.maxRowWidth === null || force || this._buttons[this._buttons.length - 1].length < this.maxRowWidth)\n        ) {\n            this._buttons[this._buttons.length - 1].push(btn)\n        } else {\n            this._buttons.push([btn])\n        }\n\n        return this\n    }\n\n    /**\n     * Return contents of this builder as an inline keyboard\n     */\n    asInline(): InlineKeyboardMarkup {\n        return {\n            type: 'inline',\n            buttons: this._buttons,\n        }\n    }\n\n    /**\n     * Return contents of this builder as a reply keyboard\n     */\n    asReply(params: Omit<ReplyKeyboardMarkup, 'type' | 'buttons'> = {}): ReplyKeyboardMarkup {\n        const ret = params as tl.Mutable<ReplyKeyboardMarkup>\n        ret.type = 'reply'\n        ret.buttons = this._buttons\n\n        return ret\n    }\n}\n"]}

package/esm/highlevel/types/bots/keyboards/factories.d.ts

@@ -0,0 +1,195 @@
+import { tl } from '@mtcute/tl';
+import { BotKeyboardBuilder } from './builder.js';
+import { InlineKeyboardMarkup, ReplyKeyboardForceReply, ReplyKeyboardHide, ReplyKeyboardMarkup } from './types.js';
+/** Create a keyboard builder */
+export declare function builder(maxRowWidth?: number | null): BotKeyboardBuilder;
+/**
+ * Create an inline keyboard markup
+ *
+ * @param buttons  Two-dimensional array of buttons
+ */
+export declare function inline(buttons: tl.TypeKeyboardButton[][]): InlineKeyboardMarkup;
+/**
+ * Create a reply keyboard markup
+ *
+ * @param buttons  Two-dimensional array of buttons
+ * @param params  Additional parameters for the keyboard
+ */
+export declare function reply(buttons: tl.TypeKeyboardButton[][], params?: Omit<ReplyKeyboardMarkup, 'type' | 'buttons'>): ReplyKeyboardMarkup;
+/**
+ * Hide the previously sent reply keyboard
+ *
+ * @param selective
+ *     Whether to remove the keyboard for specific users only. Targets:
+ *      - users that are @mentioned in the text of the Message
+ *      - in case this is a reply, sender of the original message
+ */
+export declare function hideReply(selective?: boolean): ReplyKeyboardHide;
+/**
+ * Force the user to send a reply
+ */
+export declare function forceReply(params?: Omit<ReplyKeyboardForceReply, 'type'>): ReplyKeyboardForceReply;
+/**
+ * Create a text-only keyboard button.
+ *
+ * Used for reply keyboards, not inline!
+ *
+ * @param text  Button text
+ */
+export declare function text(text: string): tl.RawKeyboardButton;
+/**
+ * Create a keyboard button requesting for user's contact.
+ * Available only for private chats.
+ *
+ * Used for reply keyboards, not inline!
+ *
+ * @param text  Button text
+ */
+export declare function requestContact(text: string): tl.RawKeyboardButtonRequestPhone;
+/**
+ * Create a keyboard button requesting for user's geo location.
+ * Available only for private chats.
+ *
+ * Used for reply keyboards, not inline!
+ *
+ * @param text  Button text
+ */
+export declare function requestGeo(text: string): tl.RawKeyboardButtonRequestGeoLocation;
+/**
+ * Create a keyboard button requesting the user to create and send a poll.
+ * Available only for private chats.
+ *
+ * Used for reply keyboards, not inline!
+ *
+ * @param text  Button text
+ * @param quiz  If set, only quiz polls can be sent
+ */
+export declare function requestPoll(text: string, quiz?: boolean): tl.RawKeyboardButtonRequestPoll;
+/**
+ * Create a keyboard button with a link.
+ *
+ * Used for inline keyboards, not reply!
+ *
+ * @param text  Button text
+ * @param url  URL
+ */
+export declare function url(text: string, url: string): tl.RawKeyboardButtonUrl;
+/**
+ * Create a keyboard button with a link.
+ *
+ * Used for inline keyboards, not reply!
+ *
+ * @param text  Button text
+ * @param data  Callback data (1-64 bytes). String will be converted to `Buffer`
+ * @param requiresPassword
+ *   Whether the user should verify their identity by entering 2FA password.
+ *   See more: {@link tl.RawKeyboardButtonCallback#requiresPassword}
+ */
+export declare function callback(text: string, data: string | Uint8Array, requiresPassword?: boolean): tl.RawKeyboardButtonCallback;
+/**
+ * Button to force a user to switch to inline mode.
+ *
+ * Pressing the button will prompt the user to select
+ * one of their chats, open that chat and insert the bot‘s
+ * username and the specified inline query (if any) in the input field.
+ *
+ * Used for inline keyboards, not reply!
+ *
+ * @param text  Button text
+ * @param query  Inline query (can be empty or omitted)
+ * @param currentChat
+ *     If set, pressing the button will insert the bot's username
+ *     and the specified inline query in the current chat's input field
+ */
+export declare function switchInline(text: string, query?: string, currentChat?: boolean): tl.RawKeyboardButtonSwitchInline;
+/**
+ * Button to start a game
+ *
+ * Used for inline keyboards, not reply!
+ *
+ * **Note**: This type of button must always be
+ * the first button in the first row. ID of the
+ * game is inferred from {@link InputMedia.game},
+ * thus this button should only be used with it.
+ */
+export declare function game(text: string): tl.RawKeyboardButtonGame;
+/**
+ * Button to pay for a product.
+ *
+ * Used for inline keyboards, not reply!
+ *
+ * **Note**: This type of button must always be
+ * the first button in the first row. Related
+ * invoice is inferred from {@link InputMedia.invoice},
+ * thus this button should only be used with it.
+ */
+export declare function pay(text: string): tl.RawKeyboardButtonBuy;
+/**
+ * Button to authorize a user
+ *
+ * Used for inline keyboards, not reply!
+ *
+ * @param text  Button label
+ * @param url  Authorization URL (see {@link tl.RawInputKeyboardButtonUrlAuth})
+ * @param params
+ */
+export declare function urlAuth(text: string, url: string, params?: {
+    /**
+     * Button label when forwarded
+     */
+    fwdText?: string;
+    /**
+     * Whether to request the permission for
+     * your bot to send messages to the user
+     */
+    requestWriteAccess?: boolean;
+    /**
+     * Bot, which will be used for user authorization.
+     * `url` domain must be the same as the domain linked
+     * with the bot.
+     *
+     * @default  current bot
+     */
+    bot?: tl.TypeInputUser;
+}): tl.RawInputKeyboardButtonUrlAuth;
+/**
+ * Button to open webview
+ *
+ * Used for both inline keyboards and reply ones
+ *
+ * @param text  Button label
+ * @param url  WebView URL
+ */
+export declare function webView(text: string, url: string): tl.RawKeyboardButtonWebView;
+/**
+ * Button to open user profile
+ *
+ * @param text  Text of the button
+ * @param user  User to be opened (use {@link TelegramClient.resolvePeer})
+ */
+export declare function userProfile(text: string, user: tl.TypeInputPeer): tl.RawInputKeyboardButtonUserProfile;
+/**
+ * Button to request a peer from the user
+ *
+ * @param text  Text of the button
+ * @param buttonId  ID of the button that will later be passed to the service message
+ */
+export declare function requestPeer(text: string, buttonId: number, params: {
+    /**
+     * Peer type, along with filters
+     */
+    peerType: tl.TypeRequestPeerType;
+    /**
+     * Maximum number of peers to be selected
+     *
+     * @default  1
+     */
+    count?: number;
+}): tl.RawKeyboardButtonRequestPeer;
+/**
+ * Find a button in the keyboard by its text or by predicate
+ *
+ * @param buttons  Two-dimensional array of buttons
+ * @param predicate  Button text or predicate function
+ */
+export declare function findButton(buttons: tl.TypeKeyboardButton[][], predicate: string | ((btn: tl.TypeKeyboardButton) => boolean)): tl.TypeKeyboardButton | null;

package/esm/highlevel/types/bots/keyboards/factories.js

@@ -0,0 +1,341 @@
+import { tl } from '@mtcute/tl';
+import { getPlatform } from '../../../../platform.js';
+import { assertNever } from '../../../../types/utils.js';
+import { toInputUser } from '../../../utils/peer-utils.js';
+import { BotKeyboardBuilder } from './builder.js';
+/** Create a keyboard builder */
+export function builder(maxRowWidth) {
+    return new BotKeyboardBuilder(maxRowWidth);
+}
+/**
+ * Create an inline keyboard markup
+ *
+ * @param buttons  Two-dimensional array of buttons
+ */
+export function inline(buttons) {
+    return {
+        type: 'inline',
+        buttons,
+    };
+}
+/**
+ * Create a reply keyboard markup
+ *
+ * @param buttons  Two-dimensional array of buttons
+ * @param params  Additional parameters for the keyboard
+ */
+export function reply(buttons, params = {}) {
+    const ret = params;
+    ret.type = 'reply';
+    ret.buttons = buttons;
+    return ret;
+}
+/**
+ * Hide the previously sent reply keyboard
+ *
+ * @param selective
+ *     Whether to remove the keyboard for specific users only. Targets:
+ *      - users that are @mentioned in the text of the Message
+ *      - in case this is a reply, sender of the original message
+ */
+export function hideReply(selective) {
+    return {
+        type: 'reply_hide',
+        selective,
+    };
+}
+/**
+ * Force the user to send a reply
+ */
+export function forceReply(params = {}) {
+    const ret = params;
+    ret.type = 'force_reply';
+    return ret;
+}
+/**
+ * Create a text-only keyboard button.
+ *
+ * Used for reply keyboards, not inline!
+ *
+ * @param text  Button text
+ */
+export function text(text) {
+    return {
+        _: 'keyboardButton',
+        text,
+    };
+}
+/**
+ * Create a keyboard button requesting for user's contact.
+ * Available only for private chats.
+ *
+ * Used for reply keyboards, not inline!
+ *
+ * @param text  Button text
+ */
+export function requestContact(text) {
+    return {
+        _: 'keyboardButtonRequestPhone',
+        text,
+    };
+}
+/**
+ * Create a keyboard button requesting for user's geo location.
+ * Available only for private chats.
+ *
+ * Used for reply keyboards, not inline!
+ *
+ * @param text  Button text
+ */
+export function requestGeo(text) {
+    return {
+        _: 'keyboardButtonRequestGeoLocation',
+        text,
+    };
+}
+/**
+ * Create a keyboard button requesting the user to create and send a poll.
+ * Available only for private chats.
+ *
+ * Used for reply keyboards, not inline!
+ *
+ * @param text  Button text
+ * @param quiz  If set, only quiz polls can be sent
+ */
+export function requestPoll(text, quiz) {
+    return {
+        _: 'keyboardButtonRequestPoll',
+        text,
+        quiz,
+    };
+}
+/**
+ * Create a keyboard button with a link.
+ *
+ * Used for inline keyboards, not reply!
+ *
+ * @param text  Button text
+ * @param url  URL
+ */
+export function url(text, url) {
+    return {
+        _: 'keyboardButtonUrl',
+        text,
+        url,
+    };
+}
+/**
+ * Create a keyboard button with a link.
+ *
+ * Used for inline keyboards, not reply!
+ *
+ * @param text  Button text
+ * @param data  Callback data (1-64 bytes). String will be converted to `Buffer`
+ * @param requiresPassword
+ *   Whether the user should verify their identity by entering 2FA password.
+ *   See more: {@link tl.RawKeyboardButtonCallback#requiresPassword}
+ */
+export function callback(text, data, requiresPassword) {
+    return {
+        _: 'keyboardButtonCallback',
+        text,
+        requiresPassword,
+        data: typeof data === 'string' ? getPlatform().utf8Encode(data) : data,
+    };
+}
+/**
+ * Button to force a user to switch to inline mode.
+ *
+ * Pressing the button will prompt the user to select
+ * one of their chats, open that chat and insert the bot‘s
+ * username and the specified inline query (if any) in the input field.
+ *
+ * Used for inline keyboards, not reply!
+ *
+ * @param text  Button text
+ * @param query  Inline query (can be empty or omitted)
+ * @param currentChat
+ *     If set, pressing the button will insert the bot's username
+ *     and the specified inline query in the current chat's input field
+ */
+export function switchInline(text, query = '', currentChat) {
+    return {
+        _: 'keyboardButtonSwitchInline',
+        samePeer: currentChat,
+        text,
+        query,
+    };
+}
+/**
+ * Button to start a game
+ *
+ * Used for inline keyboards, not reply!
+ *
+ * **Note**: This type of button must always be
+ * the first button in the first row. ID of the
+ * game is inferred from {@link InputMedia.game},
+ * thus this button should only be used with it.
+ */
+export function game(text) {
+    return { _: 'keyboardButtonGame', text };
+}
+/**
+ * Button to pay for a product.
+ *
+ * Used for inline keyboards, not reply!
+ *
+ * **Note**: This type of button must always be
+ * the first button in the first row. Related
+ * invoice is inferred from {@link InputMedia.invoice},
+ * thus this button should only be used with it.
+ */
+export function pay(text) {
+    return { _: 'keyboardButtonBuy', text };
+}
+/**
+ * Button to authorize a user
+ *
+ * Used for inline keyboards, not reply!
+ *
+ * @param text  Button label
+ * @param url  Authorization URL (see {@link tl.RawInputKeyboardButtonUrlAuth})
+ * @param params
+ */
+export function urlAuth(text, url, params = {}) {
+    return {
+        _: 'inputKeyboardButtonUrlAuth',
+        text,
+        url,
+        bot: params.bot ?? {
+            _: 'inputUserSelf',
+        },
+        fwdText: params.fwdText,
+        requestWriteAccess: params.requestWriteAccess,
+    };
+}
+/**
+ * Button to open webview
+ *
+ * Used for both inline keyboards and reply ones
+ *
+ * @param text  Button label
+ * @param url  WebView URL
+ */
+export function webView(text, url) {
+    return {
+        _: 'keyboardButtonWebView',
+        text,
+        url,
+    };
+}
+/**
+ * Button to open user profile
+ *
+ * @param text  Text of the button
+ * @param user  User to be opened (use {@link TelegramClient.resolvePeer})
+ */
+export function userProfile(text, user) {
+    return {
+        _: 'inputKeyboardButtonUserProfile',
+        text,
+        userId: toInputUser(user),
+    };
+}
+/**
+ * Button to request a peer from the user
+ *
+ * @param text  Text of the button
+ * @param buttonId  ID of the button that will later be passed to the service message
+ */
+export function requestPeer(text, buttonId, params) {
+    return {
+        _: 'keyboardButtonRequestPeer',
+        text,
+        buttonId,
+        peerType: params.peerType,
+        maxQuantity: params.count ?? 1,
+    };
+}
+/**
+ * Find a button in the keyboard by its text or by predicate
+ *
+ * @param buttons  Two-dimensional array of buttons
+ * @param predicate  Button text or predicate function
+ */
+export function findButton(buttons, predicate) {
+    if (typeof predicate === 'string') {
+        const text = predicate;
+        predicate = (btn) => {
+            return 'text' in btn && btn.text === text;
+        };
+    }
+    for (const row of buttons) {
+        for (const btn of row) {
+            if (predicate(btn)) {
+                return btn;
+            }
+        }
+    }
+    return null;
+}
+/** @internal */
+export function _rowsTo2d(rows) {
+    return rows.map((it) => it.buttons);
+}
+/** @internal */
+export function _2dToRows(arr, inline) {
+    return arr.map((row) => {
+        if (!inline) {
+            // le cringe
+            row = row.map((btn) => btn._ === 'keyboardButtonWebView' ?
+                {
+                    ...btn,
+                    _: 'keyboardButtonSimpleWebView',
+                } :
+                btn);
+        }
+        return {
+            _: 'keyboardButtonRow',
+            buttons: row,
+        };
+    });
+}
+/** @internal */
+export function _convertToTl(obj) {
+    if (!obj)
+        return obj;
+    if (tl.isAnyReplyMarkup(obj))
+        return obj;
+    switch (obj.type) {
+        case 'reply':
+            return {
+                _: 'replyKeyboardMarkup',
+                resize: obj.resize,
+                singleUse: obj.singleUse,
+                selective: obj.selective,
+                persistent: obj.persistent,
+                placeholder: obj.placeholder,
+                rows: _2dToRows(obj.buttons, false),
+            };
+        case 'reply_hide':
+            return {
+                _: 'replyKeyboardHide',
+                selective: obj.selective,
+            };
+        case 'force_reply':
+            return {
+                _: 'replyKeyboardForceReply',
+                singleUse: obj.singleUse,
+                selective: obj.selective,
+                placeholder: obj.placeholder,
+            };
+        case 'inline':
+            return {
+                _: 'replyInlineMarkup',
+                rows: _2dToRows(obj.buttons, true),
+            };
+        default:
+            assertNever(obj);
+    }
+}
+//# sourceMappingURL=factories.js.map

package/esm/highlevel/types/bots/keyboards/factories.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"factories.js","sourceRoot":"","sources":["../../../../../../src/highlevel/types/bots/keyboards/factories.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,YAAY,CAAA;AAE/B,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AASjD,gCAAgC;AAChC,MAAM,UAAU,OAAO,CAAC,WAA2B;IAC/C,OAAO,IAAI,kBAAkB,CAAC,WAAW,CAAC,CAAA;AAC9C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,MAAM,CAAC,OAAkC;IACrD,OAAO;QACH,IAAI,EAAE,QAAQ;QACd,OAAO;KACV,CAAA;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,KAAK,CACjB,OAAkC,EAClC,SAAwD,EAAE;IAE1D,MAAM,GAAG,GAAG,MAAyC,CAAA;IACrD,GAAG,CAAC,IAAI,GAAG,OAAO,CAAA;IAClB,GAAG,CAAC,OAAO,GAAG,OAAO,CAAA;IAErB,OAAO,GAAG,CAAA;AACd,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,SAAS,CAAC,SAAmB;IACzC,OAAO;QACH,IAAI,EAAE,YAAY;QAClB,SAAS;KACZ,CAAA;AACL,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,SAAgD,EAAE;IACzE,MAAM,GAAG,GAAG,MAA6C,CAAA;IACzD,GAAG,CAAC,IAAI,GAAG,aAAa,CAAA;IAExB,OAAO,GAAG,CAAA;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,IAAI,CAAC,IAAY;IAC7B,OAAO;QACH,CAAC,EAAE,gBAAgB;QACnB,IAAI;KACP,CAAA;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY;IACvC,OAAO;QACH,CAAC,EAAE,4BAA4B;QAC/B,IAAI;KACP,CAAA;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CAAC,IAAY;IACnC,OAAO;QACH,CAAC,EAAE,kCAAkC;QACrC,IAAI;KACP,CAAA;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,IAAc;IACpD,OAAO;QACH,CAAC,EAAE,2BAA2B;QAC9B,IAAI;QACJ,IAAI;KACP,CAAA;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,GAAW;IACzC,OAAO;QACH,CAAC,EAAE,mBAAmB;QACtB,IAAI;QACJ,GAAG;KACN,CAAA;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,QAAQ,CACpB,IAAY,EACZ,IAAyB,EACzB,gBAA0B;IAE1B,OAAO;QACH,CAAC,EAAE,wBAAwB;QAC3B,IAAI;QACJ,gBAAgB;QAChB,IAAI,EAAE,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;KACzE,CAAA;AACL,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY,EAAE,KAAK,GAAG,EAAE,EAAE,WAAqB;IACxE,OAAO;QACH,CAAC,EAAE,4BAA4B;QAC/B,QAAQ,EAAE,WAAW;QACrB,IAAI;QACJ,KAAK;KACR,CAAA;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,IAAI,CAAC,IAAY;IAC7B,OAAO,EAAE,CAAC,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAA;AAC5C,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,GAAG,CAAC,IAAY;IAC5B,OAAO,EAAE,CAAC,EAAE,mBAAmB,EAAE,IAAI,EAAE,CAAA;AAC3C,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,OAAO,CACnB,IAAY,EACZ,GAAW,EACX,SAoBI,EAAE;IAEN,OAAO;QACH,CAAC,EAAE,4BAA4B;QAC/B,IAAI;QACJ,GAAG;QACH,GAAG,EAAE,MAAM,CAAC,GAAG,IAAI;YACf,CAAC,EAAE,eAAe;SACrB;QACD,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;KAChD,CAAA;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,OAAO,CAAC,IAAY,EAAE,GAAW;IAC7C,OAAO;QACH,CAAC,EAAE,uBAAuB;QAC1B,IAAI;QACJ,GAAG;KACN,CAAA;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,IAAsB;IAC5D,OAAO;QACH,CAAC,EAAE,gCAAgC;QACnC,IAAI;QACJ,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC;KAC5B,CAAA;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CACvB,IAAY,EACZ,QAAgB,EAChB,MAYC;IAED,OAAO;QACH,CAAC,EAAE,2BAA2B;QAC9B,IAAI;QACJ,QAAQ;QACR,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,WAAW,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC;KACjC,CAAA;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CACtB,OAAkC,EAClC,SAA6D;IAE7D,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;QAC/B,MAAM,IAAI,GAAG,SAAS,CAAA;QAEtB,SAAS,GAAG,CAAC,GAAG,EAAE,EAAE;YAChB,OAAO,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,IAAI,CAAA;QAC7C,CAAC,CAAA;KACJ;IAED,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE;QACvB,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE;YACnB,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;gBAChB,OAAO,GAAG,CAAA;aACb;SACJ;KACJ;IAED,OAAO,IAAI,CAAA;AACf,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,SAAS,CAAC,IAA+B;IACrD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,CAAA;AACvC,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,SAAS,CAAC,GAA8B,EAAE,MAAe;IACrE,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACnB,IAAI,CAAC,MAAM,EAAE;YACT,YAAY;YACZ,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAClB,GAAG,CAAC,CAAC,KAAK,uBAAuB,CAAC,CAAC;gBAC/B;oBACI,GAAG,GAAG;oBACN,CAAC,EAAE,6BAA6B;iBACnC,CAAC,CAAC;gBACH,GAAG,CACV,CAAA;SACJ;QAED,OAAO;YACH,CAAC,EAAE,mBAAmB;YACtB,OAAO,EAAE,GAAG;SACf,CAAA;IACL,CAAC,CAAC,CAAA;AACN,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,YAAY,CAAC,GAAiB;IAC1C,IAAI,CAAC,GAAG;QAAE,OAAO,GAAG,CAAA;IACpB,IAAI,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC;QAAE,OAAO,GAAG,CAAA;IAExC,QAAQ,GAAG,CAAC,IAAI,EAAE;QACd,KAAK,OAAO;YACR,OAAO;gBACH,CAAC,EAAE,qBAAqB;gBACxB,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,SAAS,EAAE,GAAG,CAAC,SAAS;gBACxB,SAAS,EAAE,GAAG,CAAC,SAAS;gBACxB,UAAU,EAAE,GAAG,CAAC,UAAU;gBAC1B,WAAW,EAAE,GAAG,CAAC,WAAW;gBAC5B,IAAI,EAAE,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC;aACtC,CAAA;QACL,KAAK,YAAY;YACb,OAAO;gBACH,CAAC,EAAE,mBAAmB;gBACtB,SAAS,EAAE,GAAG,CAAC,SAAS;aAC3B,CAAA;QACL,KAAK,aAAa;YACd,OAAO;gBACH,CAAC,EAAE,yBAAyB;gBAC5B,SAAS,EAAE,GAAG,CAAC,SAAS;gBACxB,SAAS,EAAE,GAAG,CAAC,SAAS;gBACxB,WAAW,EAAE,GAAG,CAAC,WAAW;aAC/B,CAAA;QACL,KAAK,QAAQ;YACT,OAAO;gBACH,CAAC,EAAE,mBAAmB;gBACtB,IAAI,EAAE,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC;aACrC,CAAA;QACL;YACI,WAAW,CAAC,GAAG,CAAC,CAAA;KACvB;AACL,CAAC","sourcesContent":["import { tl } from '@mtcute/tl'\n\nimport { getPlatform } from '../../../../platform.js'\nimport { assertNever } from '../../../../types/utils.js'\nimport { toInputUser } from '../../../utils/peer-utils.js'\nimport { BotKeyboardBuilder } from './builder.js'\nimport {\n    InlineKeyboardMarkup,\n    ReplyKeyboardForceReply,\n    ReplyKeyboardHide,\n    ReplyKeyboardMarkup,\n    ReplyMarkup,\n} from './types.js'\n\n/** Create a keyboard builder */\nexport function builder(maxRowWidth?: number | null): BotKeyboardBuilder {\n    return new BotKeyboardBuilder(maxRowWidth)\n}\n\n/**\n * Create an inline keyboard markup\n *\n * @param buttons  Two-dimensional array of buttons\n */\nexport function inline(buttons: tl.TypeKeyboardButton[][]): InlineKeyboardMarkup {\n    return {\n        type: 'inline',\n        buttons,\n    }\n}\n\n/**\n * Create a reply keyboard markup\n *\n * @param buttons  Two-dimensional array of buttons\n * @param params  Additional parameters for the keyboard\n */\nexport function reply(\n    buttons: tl.TypeKeyboardButton[][],\n    params: Omit<ReplyKeyboardMarkup, 'type' | 'buttons'> = {},\n): ReplyKeyboardMarkup {\n    const ret = params as tl.Mutable<ReplyKeyboardMarkup>\n    ret.type = 'reply'\n    ret.buttons = buttons\n\n    return ret\n}\n\n/**\n * Hide the previously sent reply keyboard\n *\n * @param selective\n *     Whether to remove the keyboard for specific users only. Targets:\n *      - users that are @mentioned in the text of the Message\n *      - in case this is a reply, sender of the original message\n */\nexport function hideReply(selective?: boolean): ReplyKeyboardHide {\n    return {\n        type: 'reply_hide',\n        selective,\n    }\n}\n\n/**\n * Force the user to send a reply\n */\nexport function forceReply(params: Omit<ReplyKeyboardForceReply, 'type'> = {}): ReplyKeyboardForceReply {\n    const ret = params as tl.Mutable<ReplyKeyboardForceReply>\n    ret.type = 'force_reply'\n\n    return ret\n}\n\n/**\n * Create a text-only keyboard button.\n *\n * Used for reply keyboards, not inline!\n *\n * @param text  Button text\n */\nexport function text(text: string): tl.RawKeyboardButton {\n    return {\n        _: 'keyboardButton',\n        text,\n    }\n}\n\n/**\n * Create a keyboard button requesting for user's contact.\n * Available only for private chats.\n *\n * Used for reply keyboards, not inline!\n *\n * @param text  Button text\n */\nexport function requestContact(text: string): tl.RawKeyboardButtonRequestPhone {\n    return {\n        _: 'keyboardButtonRequestPhone',\n        text,\n    }\n}\n\n/**\n * Create a keyboard button requesting for user's geo location.\n * Available only for private chats.\n *\n * Used for reply keyboards, not inline!\n *\n * @param text  Button text\n */\nexport function requestGeo(text: string): tl.RawKeyboardButtonRequestGeoLocation {\n    return {\n        _: 'keyboardButtonRequestGeoLocation',\n        text,\n    }\n}\n\n/**\n * Create a keyboard button requesting the user to create and send a poll.\n * Available only for private chats.\n *\n * Used for reply keyboards, not inline!\n *\n * @param text  Button text\n * @param quiz  If set, only quiz polls can be sent\n */\nexport function requestPoll(text: string, quiz?: boolean): tl.RawKeyboardButtonRequestPoll {\n    return {\n        _: 'keyboardButtonRequestPoll',\n        text,\n        quiz,\n    }\n}\n\n/**\n * Create a keyboard button with a link.\n *\n * Used for inline keyboards, not reply!\n *\n * @param text  Button text\n * @param url  URL\n */\nexport function url(text: string, url: string): tl.RawKeyboardButtonUrl {\n    return {\n        _: 'keyboardButtonUrl',\n        text,\n        url,\n    }\n}\n\n/**\n * Create a keyboard button with a link.\n *\n * Used for inline keyboards, not reply!\n *\n * @param text  Button text\n * @param data  Callback data (1-64 bytes). String will be converted to `Buffer`\n * @param requiresPassword\n *   Whether the user should verify their identity by entering 2FA password.\n *   See more: {@link tl.RawKeyboardButtonCallback#requiresPassword}\n */\nexport function callback(\n    text: string,\n    data: string | Uint8Array,\n    requiresPassword?: boolean,\n): tl.RawKeyboardButtonCallback {\n    return {\n        _: 'keyboardButtonCallback',\n        text,\n        requiresPassword,\n        data: typeof data === 'string' ? getPlatform().utf8Encode(data) : data,\n    }\n}\n\n/**\n * Button to force a user to switch to inline mode.\n *\n * Pressing the button will prompt the user to select\n * one of their chats, open that chat and insert the bot‘s\n * username and the specified inline query (if any) in the input field.\n *\n * Used for inline keyboards, not reply!\n *\n * @param text  Button text\n * @param query  Inline query (can be empty or omitted)\n * @param currentChat\n *     If set, pressing the button will insert the bot's username\n *     and the specified inline query in the current chat's input field\n */\nexport function switchInline(text: string, query = '', currentChat?: boolean): tl.RawKeyboardButtonSwitchInline {\n    return {\n        _: 'keyboardButtonSwitchInline',\n        samePeer: currentChat,\n        text,\n        query,\n    }\n}\n\n/**\n * Button to start a game\n *\n * Used for inline keyboards, not reply!\n *\n * **Note**: This type of button must always be\n * the first button in the first row. ID of the\n * game is inferred from {@link InputMedia.game},\n * thus this button should only be used with it.\n */\nexport function game(text: string): tl.RawKeyboardButtonGame {\n    return { _: 'keyboardButtonGame', text }\n}\n\n/**\n * Button to pay for a product.\n *\n * Used for inline keyboards, not reply!\n *\n * **Note**: This type of button must always be\n * the first button in the first row. Related\n * invoice is inferred from {@link InputMedia.invoice},\n * thus this button should only be used with it.\n */\nexport function pay(text: string): tl.RawKeyboardButtonBuy {\n    return { _: 'keyboardButtonBuy', text }\n}\n\n/**\n * Button to authorize a user\n *\n * Used for inline keyboards, not reply!\n *\n * @param text  Button label\n * @param url  Authorization URL (see {@link tl.RawInputKeyboardButtonUrlAuth})\n * @param params\n */\nexport function urlAuth(\n    text: string,\n    url: string,\n    params: {\n        /**\n         * Button label when forwarded\n         */\n        fwdText?: string\n\n        /**\n         * Whether to request the permission for\n         * your bot to send messages to the user\n         */\n        requestWriteAccess?: boolean\n\n        /**\n         * Bot, which will be used for user authorization.\n         * `url` domain must be the same as the domain linked\n         * with the bot.\n         *\n         * @default  current bot\n         */\n        bot?: tl.TypeInputUser\n    } = {},\n): tl.RawInputKeyboardButtonUrlAuth {\n    return {\n        _: 'inputKeyboardButtonUrlAuth',\n        text,\n        url,\n        bot: params.bot ?? {\n            _: 'inputUserSelf',\n        },\n        fwdText: params.fwdText,\n        requestWriteAccess: params.requestWriteAccess,\n    }\n}\n\n/**\n * Button to open webview\n *\n * Used for both inline keyboards and reply ones\n *\n * @param text  Button label\n * @param url  WebView URL\n */\nexport function webView(text: string, url: string): tl.RawKeyboardButtonWebView {\n    return {\n        _: 'keyboardButtonWebView',\n        text,\n        url,\n    }\n}\n\n/**\n * Button to open user profile\n *\n * @param text  Text of the button\n * @param user  User to be opened (use {@link TelegramClient.resolvePeer})\n */\nexport function userProfile(text: string, user: tl.TypeInputPeer): tl.RawInputKeyboardButtonUserProfile {\n    return {\n        _: 'inputKeyboardButtonUserProfile',\n        text,\n        userId: toInputUser(user),\n    }\n}\n\n/**\n * Button to request a peer from the user\n *\n * @param text  Text of the button\n * @param buttonId  ID of the button that will later be passed to the service message\n */\nexport function requestPeer(\n    text: string,\n    buttonId: number,\n    params: {\n        /**\n         * Peer type, along with filters\n         */\n        peerType: tl.TypeRequestPeerType\n\n        /**\n         * Maximum number of peers to be selected\n         *\n         * @default  1\n         */\n        count?: number\n    },\n): tl.RawKeyboardButtonRequestPeer {\n    return {\n        _: 'keyboardButtonRequestPeer',\n        text,\n        buttonId,\n        peerType: params.peerType,\n        maxQuantity: params.count ?? 1,\n    }\n}\n\n/**\n * Find a button in the keyboard by its text or by predicate\n *\n * @param buttons  Two-dimensional array of buttons\n * @param predicate  Button text or predicate function\n */\nexport function findButton(\n    buttons: tl.TypeKeyboardButton[][],\n    predicate: string | ((btn: tl.TypeKeyboardButton) => boolean),\n): tl.TypeKeyboardButton | null {\n    if (typeof predicate === 'string') {\n        const text = predicate\n\n        predicate = (btn) => {\n            return 'text' in btn && btn.text === text\n        }\n    }\n\n    for (const row of buttons) {\n        for (const btn of row) {\n            if (predicate(btn)) {\n                return btn\n            }\n        }\n    }\n\n    return null\n}\n\n/** @internal */\nexport function _rowsTo2d(rows: tl.RawKeyboardButtonRow[]): tl.TypeKeyboardButton[][] {\n    return rows.map((it) => it.buttons)\n}\n\n/** @internal */\nexport function _2dToRows(arr: tl.TypeKeyboardButton[][], inline: boolean): tl.RawKeyboardButtonRow[] {\n    return arr.map((row) => {\n        if (!inline) {\n            // le cringe\n            row = row.map((btn) =>\n                btn._ === 'keyboardButtonWebView' ?\n                    {\n                        ...btn,\n                        _: 'keyboardButtonSimpleWebView',\n                    } :\n                    btn,\n            )\n        }\n\n        return {\n            _: 'keyboardButtonRow',\n            buttons: row,\n        }\n    })\n}\n\n/** @internal */\nexport function _convertToTl(obj?: ReplyMarkup): tl.TypeReplyMarkup | undefined {\n    if (!obj) return obj\n    if (tl.isAnyReplyMarkup(obj)) return obj\n\n    switch (obj.type) {\n        case 'reply':\n            return {\n                _: 'replyKeyboardMarkup',\n                resize: obj.resize,\n                singleUse: obj.singleUse,\n                selective: obj.selective,\n                persistent: obj.persistent,\n                placeholder: obj.placeholder,\n                rows: _2dToRows(obj.buttons, false),\n            }\n        case 'reply_hide':\n            return {\n                _: 'replyKeyboardHide',\n                selective: obj.selective,\n            }\n        case 'force_reply':\n            return {\n                _: 'replyKeyboardForceReply',\n                singleUse: obj.singleUse,\n                selective: obj.selective,\n                placeholder: obj.placeholder,\n            }\n        case 'inline':\n            return {\n                _: 'replyInlineMarkup',\n                rows: _2dToRows(obj.buttons, true),\n            }\n        default:\n            assertNever(obj)\n    }\n}\n"]}

package/esm/highlevel/types/bots/keyboards/index.d.ts

@@ -0,0 +1,14 @@
+export * from './types.js';
+import * as BotKeyboard from './factories.js';
+export { 
+/**
+ * Convenience methods wrapping TL
+ * objects creation for bot keyboard buttons.
+ *
+ * You can also use the type-discriminated objects directly.
+ *
+ * > **Note**: Button creation functions are intended to be used
+ * > with inline reply markup, unless stated otherwise
+ * > in the description.
+ */
+BotKeyboard, };

package/esm/highlevel/types/bots/keyboards/index.js

@@ -0,0 +1,15 @@
+export * from './types.js';
+import * as BotKeyboard from './factories.js';
+export { 
+/**
+ * Convenience methods wrapping TL
+ * objects creation for bot keyboard buttons.
+ *
+ * You can also use the type-discriminated objects directly.
+ *
+ * > **Note**: Button creation functions are intended to be used
+ * > with inline reply markup, unless stated otherwise
+ * > in the description.
+ */
+BotKeyboard, };
+//# sourceMappingURL=index.js.map

package/esm/highlevel/types/bots/keyboards/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/highlevel/types/bots/keyboards/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,OAAO,KAAK,WAAW,MAAM,gBAAgB,CAAA;AAE7C,OAAO;AACH;;;;;;;;;GASG;AACH,WAAW,GACd,CAAA","sourcesContent":["export * from './types.js'\nimport * as BotKeyboard from './factories.js'\n\nexport {\n    /**\n     * Convenience methods wrapping TL\n     * objects creation for bot keyboard buttons.\n     *\n     * You can also use the type-discriminated objects directly.\n     *\n     * > **Note**: Button creation functions are intended to be used\n     * > with inline reply markup, unless stated otherwise\n     * > in the description.\n     */\n    BotKeyboard,\n}\n"]}