telegram-bot-api-nodejs 1.0.0

package/index.d.ts

@@ -0,0 +1,581 @@
+export type ChatType = "private" | "group" | "supergroup" | "channel";
+export type ChatAction = "typing" | "upload_photo" | "record_video" | "upload_video" | "record_audio" | "upload_audio" | "upload_document" | "find_location" | "record_video_note" | "upload_video_note";
+export type ChatMemberStatus = "creator" | "administrator" | "member" | "restricted" | "left" | "kicked";
+export type DocumentMimeType = "application/pdf" | "application/zip";
+export type MessageType = "text" | "animation" | "audio" | "channel_chat_created" | "contact" | "delete_chat_photo" | "document" | "game" | "group_chat_created" | "invoice" | "left_chat_member" | "location" | "migrate_from_chat_id" | "migrate_to_chat_id" | "new_chat_members" | "new_chat_photo" | "new_chat_title" | "passport_data" | "photo" | "pinned_message" | "sticker" | "successful_payment" | "supergroup_chat_created" | "video" | "video_note" | "voice";
+type MessageEntityType = "mention" | "hashtag" | "bot_command" | "url" | "email" | "bold" | "italic" | "code" | "pre" | "text_link" | "text_mention";
+type ParseMode = "Markdown" | "MarkdownV2" | "HTML";
+export interface SetWebHookOptions {
+    url?: string;
+    max_connections?: number;
+    allowed_updates?: string[];
+}
+interface SendBasicOptions {
+    chat_id: number | string;
+    disable_notification?: boolean;
+    reply_to_message_id?: number | string;
+    reply_markup?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
+}
+export interface SendMessageOptions extends SendBasicOptions {
+    text: string;
+    parse_mode?: ParseMode;
+    disable_web_page_preview?: boolean;
+    entities?: MessageEntity[];
+}
+export interface SendPhotoOptions extends SendBasicOptions {
+    photo: string;
+    parse_mode?: ParseMode;
+    caption?: string;
+}
+export interface SendAnimationOptions extends SendBasicOptions {
+    animation: string;
+    parse_mode?: ParseMode;
+    caption?: string;
+}
+interface SendDocumentOptions extends SendBasicOptions {
+    document: string;
+    parse_mode?: ParseMode;
+    caption?: string;
+}
+interface SendDocumentStreamOptions extends SendBasicOptions {
+    document: Blob;
+    documentName: string;
+    parse_mode?: ParseMode;
+    caption?: string;
+}
+export interface AnswerCallbackQueryOptions {
+    callback_query_id: string;
+    text?: string;
+    show_alert?: boolean;
+    url?: string;
+    cache_time?: number;
+}
+export interface GetChatOptions {
+    chat_id: string;
+}
+interface SetMyCommandsOptions {
+    commands: BotCommand[];
+}
+interface DeleteMyCommandsOptions {
+}
+interface EditMessageTextOptions extends EditMessageReplyMarkupOptions {
+    parse_mode?: ParseMode;
+    disable_web_page_preview?: boolean;
+    text: string;
+}
+interface EditMessageReplyMarkupOptions {
+    chat_id?: number | string;
+    message_id?: number | string;
+    inline_message_id?: string;
+}
+export interface GetUserProfilePhotosOptions {
+    user_id: number | string;
+    offset?: number;
+    limit?: number;
+}
+interface PassportFile {
+    file_id: string;
+    file_size: number;
+    file_date: number;
+}
+interface EncryptedPassportElement {
+    type: string;
+    data?: string;
+    phone_number?: string;
+    email?: string;
+    files?: PassportFile[];
+    front_side?: PassportFile;
+    reverse_side?: PassportFile;
+    selfie?: PassportFile;
+    translation?: PassportFile[];
+    hash: string;
+}
+interface EncryptedCredentials {
+    data: string;
+    hash: string;
+    secret: string;
+}
+interface PassportData {
+    data: EncryptedPassportElement[];
+    credentials: EncryptedCredentials;
+}
+export interface Update {
+    update_id: number;
+    message?: Message;
+    edited_message?: Message;
+    channel_post?: Message;
+    edited_channel_post?: Message;
+    inline_query?: InlineQuery;
+    chosen_inline_result?: ChosenInlineResult;
+    callback_query?: CallbackQuery;
+    shipping_query?: ShippingQuery;
+    pre_checkout_query?: PreCheckoutQuery;
+}
+export interface WebhookInfo {
+    url: string;
+    has_custom_certificate: boolean;
+    pending_update_count: number;
+    last_error_date?: number;
+    last_error_message?: string;
+    max_connections?: number;
+    allowed_updates?: string[];
+}
+export interface User {
+    id: string;
+    is_bot: boolean;
+    first_name: string;
+    last_name?: string;
+    username?: string;
+    language_code?: string;
+    can_join_groups?: boolean;
+    supports_inline_queries?: boolean;
+    can_read_all_group_messages?: boolean;
+}
+export interface Chat {
+    id: number;
+    type: ChatType;
+    title?: string;
+    username?: string;
+    first_name?: string;
+    last_name?: string;
+    photo?: ChatPhoto;
+    description?: string;
+    invite_link?: string;
+    pinned_message?: Message;
+    permissions?: ChatPermissions;
+    can_set_sticker_set?: boolean;
+    sticker_set_name?: string;
+}
+export interface Message {
+    message_id: number;
+    from?: User;
+    date: number;
+    chat: Chat;
+    forward_from?: User;
+    forward_from_chat?: Chat;
+    forward_from_message_id?: number;
+    forward_signature?: string;
+    forward_sender_name?: string;
+    forward_date?: number;
+    reply_to_message?: Message;
+    edit_date?: number;
+    media_group_id?: string;
+    author_signature?: string;
+    text?: string;
+    entities?: MessageEntity[];
+    caption_entities?: MessageEntity[];
+    audio?: Audio;
+    document?: Document;
+    animation?: Animation;
+    game?: Game;
+    photo?: PhotoSize[];
+    sticker?: Sticker;
+    video?: Video;
+    voice?: Voice;
+    video_note?: VideoNote;
+    caption?: string;
+    contact?: Contact;
+    location?: Location;
+    venue?: Venue;
+    poll?: Poll;
+    new_chat_members?: User[];
+    left_chat_member?: User;
+    new_chat_title?: string;
+    new_chat_photo?: PhotoSize[];
+    delete_chat_photo?: boolean;
+    group_chat_created?: boolean;
+    supergroup_chat_created?: boolean;
+    channel_chat_created?: boolean;
+    migrate_to_chat_id?: number;
+    migrate_from_chat_id?: number;
+    pinned_message?: Message;
+    invoice?: Invoice;
+    successful_payment?: SuccessfulPayment;
+    connected_website?: string;
+    passport_data?: PassportData;
+    reply_markup?: InlineKeyboardMarkup;
+    sender_chat?: Chat;
+}
+export interface MessageEntity {
+    type: MessageEntityType;
+    offset: number;
+    length: number;
+    url?: string;
+    user?: User;
+}
+interface FileBase {
+    file_id: string;
+    file_size?: number;
+}
+export interface PhotoSize extends FileBase {
+    width: number;
+    height: number;
+}
+export interface Audio extends FileBase {
+    duration: number;
+    performer?: string;
+    title?: string;
+    file_name?: string;
+    mime_type?: string;
+    thumb?: PhotoSize;
+}
+export interface Document extends FileBase {
+    thumb?: PhotoSize;
+    file_name?: string;
+    mime_type?: string;
+    file_size?: number;
+}
+export interface Video extends FileBase {
+    width: number;
+    height: number;
+    duration: number;
+    thumb?: PhotoSize;
+    mime_type?: string;
+    file_name?: string;
+}
+export interface Voice extends FileBase {
+    duration: number;
+    mime_type?: string;
+}
+export interface VideoNote extends FileBase {
+    length: number;
+    duration: number;
+    thumb?: PhotoSize;
+}
+export interface Contact {
+    phone_number: string;
+    first_name: string;
+    last_name?: string;
+    user_id?: number;
+    vcard?: string;
+}
+export interface Location {
+    longitude: number;
+    latitude: number;
+}
+export interface Venue {
+    location: Location;
+    title: string;
+    address: string;
+    foursquare_id?: string;
+    foursquare_type?: string;
+    google_place_id?: string;
+    google_place_type?: string;
+}
+export interface PollOption {
+    text: string;
+    voter_count: number;
+}
+export interface Poll {
+    id: string;
+    question: string;
+    options: PollOption[];
+    is_closed: boolean;
+}
+export interface UserProfilePhotos {
+    total_count: number;
+    photos: PhotoSize[][];
+}
+export interface File extends FileBase {
+    file_path?: string;
+}
+interface ReplyKeyboardMarkup {
+    keyboard: KeyboardButton[][];
+    resize_keyboard?: boolean;
+    one_time_keyboard?: boolean;
+    selective?: boolean;
+}
+interface KeyboardButton {
+    text: string;
+    request_contact?: boolean;
+    request_location?: boolean;
+}
+interface ReplyKeyboardRemove {
+    remove_keyboard: boolean;
+    selective?: boolean;
+}
+export interface InlineKeyboardMarkup {
+    inline_keyboard: InlineKeyboardButton[][];
+}
+export interface InlineKeyboardButton {
+    text: string;
+    url?: string;
+    login_url?: LoginUrl;
+    callback_data?: string;
+    switch_inline_query?: string;
+    switch_inline_query_current_chat?: string;
+    callback_game?: CallbackGame;
+    pay?: boolean;
+}
+interface LoginUrl {
+    url: string;
+    forward_text?: string;
+    bot_username?: string;
+    request_write_acces?: boolean;
+}
+export interface CallbackQuery {
+    id: string;
+    from: User;
+    message?: Message;
+    inline_message_id?: string;
+    chat_instance: string;
+    data?: string;
+    game_short_name?: string;
+}
+interface ForceReply {
+    force_reply: boolean;
+    selective?: boolean;
+}
+interface ChatPhoto {
+    small_file_id: string;
+    small_file_unique_id: string;
+    big_file_id: string;
+    big_file_unique_id: string;
+}
+interface ChatMember {
+    user: User;
+    status: ChatMemberStatus;
+    until_date?: number;
+    can_be_edited?: boolean;
+    can_post_messages?: boolean;
+    can_edit_messages?: boolean;
+    can_delete_messages?: boolean;
+    can_restrict_members?: boolean;
+    can_promote_members?: boolean;
+    can_change_info?: boolean;
+    can_invite_users?: boolean;
+    can_pin_messages?: boolean;
+    is_member?: boolean;
+    can_send_messages?: boolean;
+    can_send_media_messages?: boolean;
+    can_send_polls: boolean;
+    can_send_other_messages?: boolean;
+    can_add_web_page_previews?: boolean;
+}
+interface ChatPermissions {
+    can_send_messages?: boolean;
+    can_send_media_messages?: boolean;
+    can_send_polls?: boolean;
+    can_send_other_messages?: boolean;
+    can_add_web_page_previews?: boolean;
+    can_change_info?: boolean;
+    can_invite_users?: boolean;
+    can_pin_messages?: boolean;
+}
+export interface Sticker {
+    file_id: string;
+    width: number;
+    height: number;
+    thumb?: PhotoSize;
+    emoji?: string;
+    set_name?: string;
+    mask_position?: MaskPosition;
+    file_size?: number;
+}
+interface MaskPosition {
+    point: string;
+    x_shift: number;
+    y_shift: number;
+    scale: number;
+}
+interface InlineQuery {
+    id: string;
+    from: User;
+    location?: Location;
+    query: string;
+    offset: string;
+}
+interface ChosenInlineResult {
+    result_id: string;
+    from: User;
+    location?: Location;
+    inline_message_id?: string;
+    query: string;
+}
+interface Invoice {
+    title: string;
+    description: string;
+    start_parameter: string;
+    currency: string;
+    total_amount: number;
+}
+interface ShippingAddress {
+    country_code: string;
+    state: string;
+    city: string;
+    street_line1: string;
+    street_line2: string;
+    post_code: string;
+}
+interface OrderInfo {
+    name?: string;
+    phone_number?: string;
+    email?: string;
+    shipping_address?: ShippingAddress;
+}
+interface SuccessfulPayment {
+    currency: string;
+    total_amount: number;
+    invoice_payload: string;
+    shipping_option_id?: string;
+    order_info?: OrderInfo;
+    telegram_payment_charge_id: string;
+    provider_payment_charge_id: string;
+}
+interface ShippingQuery {
+    id: string;
+    from: User;
+    invoice_payload: string;
+    shipping_address: ShippingAddress;
+}
+interface PreCheckoutQuery {
+    id: string;
+    from: User;
+    currency: string;
+    total_amount: number;
+    invoice_payload: string;
+    shipping_option_id?: string;
+    order_info?: OrderInfo;
+}
+interface Game {
+    title: string;
+    description: string;
+    photo: PhotoSize[];
+    text?: string;
+    text_entities?: MessageEntity[];
+    animation?: Animation;
+}
+export interface Animation extends FileBase {
+    width: number;
+    height: number;
+    duration: number;
+    thumb?: PhotoSize;
+    file_name?: string;
+    mime_type?: string;
+}
+type CallbackGame = object;
+interface BotCommand {
+    command: string;
+    description: string;
+}
+/**
+ * Methods
+ */
+export declare function setWebhook(token: string, body: SetWebHookOptions, signal: any): Promise<any>;
+export declare function deleteWebhook(token: string, signal: any): Promise<any>;
+/** @todo cehck if response is the same as in typings */
+export declare function getWebhookInfo(token: string, signal: any): Promise<WebhookInfo>;
+export declare function getMe(token: string, signal: any): Promise<User>;
+export declare function sendMessage(token: string, payload: SendMessageOptions, signal: any): Promise<Message>;
+export declare function editMessageText(token: string, payload: EditMessageTextOptions, signal: any): Promise<Message>;
+export declare function sendPhoto(token: string, payload: SendPhotoOptions, signal: any): Promise<Message>;
+export declare function sendAnimation(token: string, payload: SendAnimationOptions, signal: any): Promise<Message>;
+export declare function sendDocument(token: string, payload: SendDocumentOptions, signal: any): Promise<Message>;
+export declare function sendDocumentStream(token: string, payload: SendDocumentStreamOptions, signal: any): Promise<Message>;
+export declare function getUserProfilePhotos(token: string, payload: GetUserProfilePhotosOptions, signal: any): Promise<UserProfilePhotos>;
+export declare function getFile(token: string, file_id: string, signal: any): Promise<File>;
+export declare function answerCallbackQuery(token: string, payload: AnswerCallbackQueryOptions, signal: any): Promise<File>;
+export declare function getChat(token: string, payload: GetChatOptions, signal: any): Promise<Chat>;
+export declare function getChatMember(token: string, payload: {
+    chat_id: string;
+    user_id: string;
+}, signal: AbortSignal): Promise<ChatMember>;
+export declare function setMyCommands(token: string, payload: SetMyCommandsOptions, signal: any): Promise<Chat>;
+export declare function deleteMyCommands(token: string, payload: DeleteMyCommandsOptions, signal: any): Promise<Chat>;
+/**
+ * Parsers
+ */
+export declare function parseUpdate(update: any): Update;
+export declare function parseMessage(m?: any): Message | undefined;
+export declare function parseUser(u: User): {
+    id: string;
+    is_bot: boolean;
+    first_name: string;
+    last_name: string;
+    username: string;
+    language_code: string;
+};
+export declare function parseChat(c: Chat): {
+    id: number;
+    type: ChatType;
+    title: string;
+    username: string;
+    first_name: string;
+    last_name: string;
+};
+export declare function parsePhotoSizes(p: PhotoSize[]): {
+    file_id: string;
+    file_size: number;
+    width: number;
+    height: number;
+}[] | undefined;
+export declare function parsePhotoSize(p: PhotoSize): {
+    file_id: string;
+    file_size: number;
+    width: number;
+    height: number;
+};
+export declare function parseSticker(v: Sticker): Sticker;
+export declare function parseVideo(v: Video): Video;
+export declare function parseVoice(v: Voice): Voice;
+export declare function parseVideoNote(v: VideoNote): VideoNote;
+export declare function parseEntities(v: MessageEntity[]): MessageEntity[];
+export declare function parseAudio(v: Audio): Audio;
+export declare function parseDocument(v: Document): Document;
+export declare function parseAnimation(v: Animation): {
+    file_id: string;
+    width: number;
+    height: number;
+    duration: number;
+    file_name: string;
+    mime_type: string;
+};
+export declare function parseContact(v: Contact): {
+    phone_number: string;
+    first_name: string;
+    last_name: string;
+    user_id: number;
+    vcard: string;
+};
+export declare function parseLocation(v: Location): {
+    longitude: number;
+    latitude: number;
+};
+export declare function parseVenue(v: Venue): {
+    location: {
+        longitude: number;
+        latitude: number;
+    };
+    title: string;
+    address: string;
+    foursquare_id: string;
+    foursquare_type: string;
+    google_place_id: string;
+    google_place_type: string;
+};
+export declare function parsePoll(v: Poll): {
+    id: string;
+    question: string;
+    options: {
+        text: string;
+        voter_count: number;
+    }[];
+    is_closed: boolean;
+};
+export declare function parsePollOptions(v: PollOption[]): {
+    text: string;
+    voter_count: number;
+}[];
+export declare function parsePollOption(v: PollOption): {
+    text: string;
+    voter_count: number;
+};
+/**
+ * @see https://core.telegram.org/bots/api#callbackquery
+ */
+export declare function parseCallbackQuery(v?: CallbackQuery): CallbackQuery | undefined;
+export declare class TelegramError extends Error {
+    status: number;
+    constructor(message: string, status: number);
+}
+export {};