frontendmonster

telegraf-ts

    "babel/camelcase": 0, // telegraf context is snake_case so we'll follow that convention

    "@typescript-eslint/naming-convention": 0,

  "description": "Well-Typed fork of telegraf",

  "author": "frontendmonster <frontendmonster@gamil.com>",

  "homepage": "https://github.com/frontendmonster/telegraf-ts#readme",

    "url": "git+ssh://git@github.com/frontendmonster/telegraf-ts.git"

    "registry": "https://registry.npmjs.org"

    "url": "https://github.com/frontendmonster/telegraf-ts/issues"

    "precommit": "npm run lint && npm run typecheck && npm test",

    "@frontendmonster/eslint-config": "3.2.14",

    "@frontendmonster/eslint-config": "^4.0.4",

  chosenInlineResult?: tt.ChosenInlineResult

   * Use this method to add a new sticker to a set created by the bot

   * @param ownerId User identifier of sticker set owner

   * @param isMasks https://github.com/telegraf/telegraf/blob/87882c42f6c2496576fdb57ca622690205c3e35e/lib/telegram.js#L304

   * Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set

   * @param ownerId User identifier of created sticker set owner

   * @param name Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only english letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in “_by_<bot username>”. <bot_username> is case insensitive. 1-64 characters.

   * @param title Sticker set title, 1-64 characters

   * Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.

   * Use this method to delete a sticker from a set created by the bot.

   * @param sticker File identifier of the sticker

  deleteStickerFromSet(sticker: string): Promise<boolean>

   * Use this method to export an invite link to a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.

   * @returns exported invite link as String on success.

  exportChatInviteLink(): Promise<string>

   * Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.)

   * Use this method to get a list of administrators in a chat.

   * @returns On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.

  getChatAdministrators(): Promise<Array<tt.ChatMember>>

  getChatAdministrators(): Promise<tt.ChatMember[]>

   * Use this method to get information about a member of a chat.

   * @param userId Unique identifier of the target user

   * @returns a ChatMember object on success

  getChatMember(userId: number): Promise<tt.ChatMember>

   * Use this method to get the number of members in a chat

   * Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all boolean parameters to lift restrictions from a user. Returns True on success.

   * @param user_id Unique identifier of the target user

   * @param extra Additional params for restrict chat member

   * Use this method to get a sticker set

   * @param setName Name of the sticker set

   * @returns On success, a StickerSet object is returned.

  getStickerSet(setName: string): Promise<tt.StickerSet>

   * Use this method for your bot to leave a group, supergroup or channel

   * Use this method to pin a message in a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights

   * @param messageId Identifier of a message to pin

   * @param extra Pass `{ disable_notification: true }`, if it is not necessary to send a notification to all group members about the new pinned message

    extra?: { disable_notification?: boolean }

   * Use this method to unpin a message in a group, a supergroup, or a channel.

   * Use this method to reply on messages in the same chat.

   * @param text Text of the message to be sent

   * @param extra SendMessage additional params

  reply(text: string, extra?: tt.ExtraReplyMessage): Promise<tt.Message>

   * Use this method to send audio files to the same chat, if you want Telegram clients to display them in the music player.

   * Your audio must be in the .mp3 format.

   * Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.

   * @param audio Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data

   * @returns On success, the sent Message is returned.

   * Use this method when you need to tell the user that something is happening on the bot's side.

   * The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status).

   * Choose one, depending on what the user is about to receive:

   * - record_video or upload_video for videos,

   * - record_audio or upload_audio for audio files,

   * - upload_document for general files,

   * - record_video_note or upload_video_note for video notes.

   * @param action Type of action to broadcast.

  replyWithChatAction(action: tt.ChatAction): Promise<boolean>

   * Use this method to send general files. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

   * @param document File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data

   * @param extra Additional params for send document

   * Use this method to send a native poll.

   * @param question Poll question, 1-255 characters

   * @param options A JSON-serialized list of answer options, 2-10 strings 1-100 characters each

   * @param extra Additional params to send poll

   * Use this method to send a native quiz.

   * @param extra Additional params to send quiz

   * @param messageId Identifier of the original message with the poll

   * @param extra Additional params to stop poll

   * @returns On success, the stopped Poll with the final results is returned.

  stopPoll(messageId: number, extra: tt.ExtraStopPoll): Promise<tt.Poll>

   * Use this method to send .webp stickers

   * @param sticker Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .webp file from the Internet, or upload a new one using multipart/form-data

   * @param extra Additional params to send sticker

   * Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document)

   * Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.

   * @param video video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data

   * @param extra Additional params to send video

   * Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

   * @param voice Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data

   * @param extra Additional params to send voice

   * Use this method to send a dice, which will have a random value from 1 to 6. On success, the sent Message is returned. (Yes, we're aware of the “proper” singular of die. But it's awkward, and we decided to help it change. One dice at a time!)

   * @param chatId Unique identifier for the target chat or username of the target channel (in the format @channelusername)

   * @param extra Additional params to send dice

  replyWithDice(extra?: tt.ExtraDice): Promise<tt.MessageDice>

  // ------------------------------------------------------------------------------------------ //

   * Use this method to send answers to game query.

  answerGameQuery(url: string): Promise<boolean>

   * If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.

   * @param ok  Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)

   * @param shippingOptions Required if ok is True. A JSON-serialized array of available shipping options.

   * @param errorMessage Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user.

    shippingOptions: tt.ShippingOption[],

   * Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.

   * @param ok  Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.

   * @param errorMessage Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user.

  answerPreCheckoutQuery(ok: boolean, errorMessage?: string): Promise<boolean>

   * Use this method to send answers to an inline query.

   * No more than 50 results per query are allowed.

   * @returns On success, True is returned.

   * @param results Array of results for the inline query

   * @param extra Extra optional parameters

   * Use this method to edit text and game messages sent by the bot or via the bot (for inline bots).

   * @returns On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.

   * Use this method to edit captions of messages sent by the bot or via the bot (for inline bots).

   * On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.

   * @param caption New caption of the message

   * @param markup Markup of inline keyboard

   * Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots).

   * Use this method to edit animation, audio, document, photo, or video messages.

   * @returns On success, if the edited message was sent by the bot, the edited Message is returned, otherwise True is returned.

   * Use this method to edit live location messages.

   * @returns On success, if the edited message was sent by the bot, the edited message is returned, otherwise True is returned.

  ): Promise<tt.MessageLocation | boolean>

   * Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights

   * @param untilDate Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever

  kickChatMember(userId: number, untilDate?: number): Promise<boolean>

  inReplyTo(messageId: string | number): this

  markup(markup: any): tt.ExtraEditMessage & this

  static inReplyTo(messageId: string | number): Extra

  static notifications(value?: boolean): Extra

  static webPreview(value?: boolean): Extra

  static markup(markup: any): tt.ExtraEditMessage

  static markdown(value?: boolean): Extra

import { TelegrafContext } from './context';

import { TelegrafContext } from './context'

export declare function session<TContext extends TelegrafContext>(opts?: {

  getSessionKey?: (ctx: TContext) => string;

  getSessionKey?: (ctx: TContext) => string

import { IncomingMessage, ServerResponse } from 'http'

import { Telegram, TelegramOptions } from './telegram'

   * Limits the number of updates to be retrieved

   * List the types of updates you want your bot to receive

  allowedUpdates?: tt.UpdateType[] | tt.UpdateType | null

   * Public domain for webhook. If domain is not specified, hookPath should contain a domain name as well (not only path component).

   * Webhook url path; will be automatically generated if not specified

   * The port to listen on for Telegram calls. If port is omitted or is 0, the operating system will assign an arbitrary unused port.

   * The host to listen on for Telegram calls. If host is omitted, the server will accept connections on the unspecified IPv6 address (::) when IPv6 is available, or the unspecified IPv4 address (0.0.0.0) otherwise.

   * TLS server options. Pass null (or omit) to use http.

   * A callback function suitable for the http[s].createServer() method to handle a request.

  cb?: (req: IncomingMessage, res: ServerResponse) => void

   * Use this property to get/set bot token

		module.exports = {
		root: true,
		extends: ["@frontendmonster"],
		parserOptions: {
		project: "./tsconfig.eslint.json",
		},
		rules: {
		"babel/camelcase": 0, // telegraf context is snake_case so we'll follow that convention
		"spaced-comment": 0,
		"@typescript-eslint/naming-convention": 0,
		"@typescript-eslint/ban-types": 0
		},
		};

		{
		"name": "telegraf-ts",
		"version": "3.88.6",
		"version": "3.88.7",
		"description": "Well-Typed fork of telegraf",
		@@ -12,2 +12,5 @@ "license": "MIT",
		},
		"publishConfig": {
		"registry": "https://registry.npmjs.org"
		},
		"bugs": {
		@@ -46,11 +49,11 @@ "url": "https://github.com/frontendmonster/telegraf-ts/issues"
		"devDependencies": {
		"@babel/core": "7.9.6",
		"@frontendmonster/eslint-config": "3.2.14",
		"@types/node": "13.13.5",
		"@babel/core": "^7.11.6",
		"@frontendmonster/eslint-config": "^4.0.4",
		"@types/node": "^14.11.5",
		"ava": "3.0.0",
		"eslint": "6.2.2",
		"eslint": "^7.10.0",
		"husky": "4.2.5",
		"np": "6.2.3",
		"prettier": "2.0.5",
		"typescript": "3.0.1"
		"np": "^6.5.0",
		"prettier": "^2.1.2",
		"typescript": "^4.0.3"
		},
		@@ -57,0 +60,0 @@ "keywords": [

 @@ -95,3 +95,3 @@ /** @format */
    */
   getChatAdministrators(): Promise<Array<tt.ChatMember>>
   getChatAdministrators(): Promise<tt.ChatMember[]>
 @@ -274,3 +274,3 @@ /**
     extra?: tt.ExtraMediaGroup
   ): Promise<Array<tt.Message>>
   ): Promise<tt.Message[]>
 @@ -360,3 +360,3 @@ /**
     showAlert?: boolean,
     extra?: object,
     extra?: object
   ): Promise<boolean>
 @@ -363,0 +363,0 @@

		@@ -1,3 +0,1 @@
		/** @format */

		import * as tt from './telegram-types.d'
		@@ -4,0 +2,0 @@

		/** @format */

		import { TelegrafContext } from './context';
		import { Middleware } from './composer';
		import { TelegrafContext } from './context'
		import { Middleware } from './composer'

		export declare function session<TContext extends TelegrafContext>(opts?: {
		property?: string;
		store?: Map<string, any>;
		getSessionKey?: (ctx: TContext) => string;
		ttl?: number;
		}): Middleware<TContext>;
		property?: string
		store?: Map<string, any>
		getSessionKey?: (ctx: TContext) => string
		ttl?: number
		}): Middleware<TContext>

Improved metrics

Worsened metrics

		@@ -1,3 +0,1 @@
		/** @format */

		/// <reference types="node" />
		@@ -4,0 +2,0 @@