@mtcute/core 0.7.3 → 0.9.0

package/{esm/highlevel/types/bots/input/input-inline-result.d.ts → cjs/highlevel/types/bots/inline-result/types.d.ts}

@@ -1,5 +1,5 @@
 import { tl } from '@mtcute/tl';
-import { InputInlineMessage } from './input-inline-message.js';
+import { InputInlineMessage } from '../inline-message/types.js';
 export interface BaseInputInlineResult {
     /**
      * Unique ID of the result
@@ -415,97 +415,3 @@ export interface InputInlineResultContact extends BaseInputInlineResult {
     thumb?: string | tl.RawInputWebDocument;
 }
 export type InputInlineResult = InputInlineResultArticle | InputInlineResultGif | InputInlineResultVideo | InputInlineResultAudio | InputInlineResultVoice | InputInlineResultPhoto | InputInlineResultSticker | InputInlineResultFile | InputInlineResultGeo | InputInlineResultVenue | InputInlineResultGame | InputInlineResultContact;
-export declare namespace BotInline {
-    /**
-     * Create an inline result containing an article
-     *
-     * @param id  Inline result ID
-     * @param params  Article
-     */
-    function article(id: string, params: Omit<InputInlineResultArticle, 'type' | 'id'>): InputInlineResultArticle;
-    /**
-     * Create an inline result containing a GIF
-     *
-     * @param id  Inline result ID
-     * @param media  GIF animation
-     * @param params  Additional parameters
-     */
-    function gif(id: string, media: string | tl.RawInputWebDocument | tl.RawInputDocument, params?: Omit<InputInlineResultGif, 'type' | 'id' | 'media'>): InputInlineResultGif;
-    /**
-     * Create an inline result containing a video
-     *
-     * @param id  Inline result ID
-     * @param media  Video
-     * @param params  Additional parameters
-     */
-    function video(id: string, media: string | tl.RawInputWebDocument | tl.RawInputDocument, params: Omit<InputInlineResultVideo, 'type' | 'id' | 'media'>): InputInlineResultVideo;
-    /**
-     * Create an inline result containing an audio file
-     *
-     * @param id  Inline result ID
-     * @param media  Audio file
-     * @param params  Additional parameters
-     */
-    function audio(id: string, media: string | tl.RawInputWebDocument | tl.RawInputDocument, params: Omit<InputInlineResultAudio, 'type' | 'id' | 'media'>): InputInlineResultAudio;
-    /**
-     * Create an inline result containing a voice note
-     *
-     * @param id  Inline result ID
-     * @param media  Voice note
-     * @param params  Additional parameters
-     */
-    function voice(id: string, media: string | tl.RawInputWebDocument | tl.RawInputDocument, params: Omit<InputInlineResultVoice, 'type' | 'id' | 'media'>): InputInlineResultVoice;
-    /**
-     * Create an inline result containing a photo
-     *
-     * @param id  Inline result ID
-     * @param media  Photo
-     * @param params  Additional parameters
-     */
-    function photo(id: string, media: string | tl.RawInputWebDocument | tl.RawInputPhoto, params?: Omit<InputInlineResultPhoto, 'type' | 'id' | 'media'>): InputInlineResultPhoto;
-    /**
-     * Create an inline result containing a sticker
-     *
-     * @param id  Inline result ID
-     * @param media  Sticker
-     */
-    function sticker(id: string, media: string | tl.RawInputDocument): InputInlineResultSticker;
-    /**
-     * Create an inline result containing a document
-     * (only PDF and ZIP are supported when using URL)
-     *
-     * @param id  Inline result ID
-     * @param media  Document
-     * @param params  Additional parameters
-     */
-    function file(id: string, media: string | tl.RawInputWebDocument | tl.RawInputDocument, params: Omit<InputInlineResultFile, 'type' | 'id' | 'media'>): InputInlineResultFile;
-    /**
-     * Create an inline result containing a geolocation
-     *
-     * @param id  Inline result ID
-     * @param params  Additional parameters
-     */
-    function geo(id: string, params: Omit<InputInlineResultGeo, 'type' | 'id'>): InputInlineResultGeo;
-    /**
-     * Create an inline result containing a venue
-     *
-     * @param id  Inline result ID
-     * @param params  Venue parameters
-     */
-    function venue(id: string, params: Omit<InputInlineResultVenue, 'type' | 'id'>): InputInlineResultVenue;
-    /**
-     * Create an inline result containing a contact
-     *
-     * @param id  Inline result ID
-     * @param params  Contact parameters
-     */
-    function contact(id: string, params: Omit<InputInlineResultContact, 'type' | 'id'>): InputInlineResultContact;
-    /**
-     * Create an inline result containing a game
-     *
-     * @param id  Inline result ID
-     * @param shortName  Short name of the game
-     * @param params  Additional parameters
-     */
-    function game(id: string, shortName: string, params?: Omit<InputInlineResultGame, 'type' | 'id' | 'shortName'>): InputInlineResultGame;
-}

package/cjs/highlevel/types/bots/inline-result/types.js

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

package/cjs/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/cjs/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/cjs/highlevel/types/bots/{keyboard-builder.js → keyboards/builder.js}

@@ -90,4 +90,4 @@ class BotKeyboardBuilder {
     }
 }
 exports.BotKeyboardBuilder = BotKeyboardBuilder;
-//# sourceMappingURL=keyboard-builder.js.map
+//# sourceMappingURL=builder.js.map

package/cjs/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,MAAa,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;AA7FD,gDA6FC","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/cjs/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;