update Bot API to 8.3

Borodin · Borodin · commit 0f50b4aefc76 · 2025-02-13T23:01:22.000+03:00
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 [![npm](https://img.shields.io/npm/dt/typescript-telegram-bot-api)](https://www.npmjs.com/package/typescript-telegram-bot-api)
 [![codecov](https://codecov.io/github/Borodin/typescript-telegram-bot-api/graph/badge.svg?token=509N5AZDTV)](https://codecov.io/github/Borodin/typescript-telegram-bot-api)
 [![codesandbox](https://img.shields.io/badge/Open_in-sandbox-eaff96)](https://codesandbox.io/p/sandbox/interesting-wave-qgspfs)
-[![GitHub](https://img.shields.io/badge/Bot_API-v8.2-0088cc)](https://core.telegram.org/bots/api#january-1-2025)
+[![GitHub](https://img.shields.io/badge/Bot_API-v8.3-0088cc)](https://core.telegram.org/bots/api#february-12-2025)
 
 
 This is a TypeScript wrapper for the [Telegram Bot API](https://core.telegram.org/bots/api) Node.js and browsers. It allows you to easily interact with the Telegram Bot API using TypeScript.
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "type": "commonjs",
   "name": "typescript-telegram-bot-api",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Telegram Bot API wrapper for Node.js written in TypeScript",
   "repository": "github:Borodin/typescript-telegram-bot-api",
   "main": "dist/index.js",
diff --git a/src/index.ts b/src/index.ts
@@ -67,6 +67,7 @@ import {
   Gifts,
 } from './types/';
 import * as TelegramTypes from './types/';
+import { ExactlyOne } from './utils';
 
 const wait: (ms: number) => Promise<void> = promisify(setTimeout);
 
@@ -499,6 +500,7 @@ export class TelegramBot extends EventEmitter {
     chat_id: number | string;
     message_thread_id?: number;
     from_chat_id: number | string;
+    video_start_timestamp?: number;
     disable_notification?: boolean;
     protect_content?: boolean;
     message_id: number;
@@ -543,6 +545,7 @@ export class TelegramBot extends EventEmitter {
     message_thread_id?: number;
     from_chat_id: number | string;
     message_id: number;
+    video_start_timestamp?: number;
     caption?: string;
     parse_mode?: ParseMode;
     caption_entities?: MessageEntity[];
@@ -721,6 +724,8 @@ export class TelegramBot extends EventEmitter {
     width?: number;
     height?: number;
     thumbnail?: InputFile | string;
+    cover?: InputFile | string;
+    start_timestamp?: number;
     caption?: string;
     parse_mode?: ParseMode;
     caption_entities?: MessageEntity[];
@@ -2601,14 +2606,19 @@ export class TelegramBot extends EventEmitter {
    * Sends a gift to the given user. The gift can't be converted to Telegram Stars by the user. Returns True on success.
    * @see https://core.telegram.org/bots/api#sendgift
    */
-  async sendGift(options: {
-    user_id: number;
-    gift_id: string;
-    pay_for_upgrade?: boolean;
-    text?: string;
-    text_parse_mode?: ParseMode;
-    text_entities?: MessageEntity[];
-  }): Promise<true> {
+
+  async sendGift(
+    options: ExactlyOne<{
+      user_id?: number;
+      chat_id?: number | string;
+    }> & {
+      gift_id: string;
+      pay_for_upgrade?: boolean;
+      text?: string;
+      text_parse_mode?: ParseMode;
+      text_entities?: MessageEntity[];
+    },
+  ): Promise<true> {
     return await this.callApi('sendGift', {
       ...options,
       text_entities: new JSONSerialized(options.text_entities),
diff --git a/src/types/ChatFullInfo.ts b/src/types/ChatFullInfo.ts
@@ -180,6 +180,12 @@ export type ChatFullInfo = {
    */
   permissions?: ChatPermissions;
 
+  /**
+   * Optional. True, if paid media messages can be sent or forwarded to the channel chat. The field is available only
+   * for channel chats.
+   */
+  can_send_gift?: true;
+
   /**
    * Optional. True, if paid media messages can be sent or forwarded to the channel chat. The field is available only
    * for channel chats.
diff --git a/src/types/InlineQueryResultsButton.ts b/src/types/InlineQueryResultsButton.ts
@@ -1,5 +1,5 @@
 import { WebAppInfo } from './';
-import { AtMostOne } from './Update';
+import { AtMostOne } from '../utils';
 
 /**
  * ## InlineQueryResultsButton
diff --git a/src/types/InputMediaVideo.ts b/src/types/InputMediaVideo.ts
@@ -26,6 +26,18 @@ export type InputMediaVideo = {
    */
   thumbnail?: InputFile | string;
 
+  /**
+   * Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers
+   * (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>”
+   * to upload a new one using multipart/form-data under <file_attach_name> name. [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
+   */
+  cover?: InputFile | string;
+
+  /**
+   * Optional. Start timestamp for the video in the message
+   */
+  start_timestamp?: number;
+
   /**
    * Optional. Caption of the video to be sent, 0-1024 characters after entities parsing
    */
diff --git a/src/types/InputPaidMediaVideo.ts b/src/types/InputPaidMediaVideo.ts
@@ -30,6 +30,18 @@ export type InputPaidMediaVideo = {
    */
   thumbnail?: InputFile | string;
 
+  /**
+   * Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers
+   * (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>”
+   * to upload a new one using multipart/form-data under <file_attach_name> name. [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
+   */
+  cover?: InputFile | string;
+
+  /**
+   * Optional. Start timestamp for the video in the message
+   */
+  start_timestamp?: number;
+
   /**
    * Optional. Video width
    */
diff --git a/src/types/KeyboardButton.ts b/src/types/KeyboardButton.ts
@@ -1,5 +1,5 @@
 import { WebAppInfo, KeyboardButtonRequestChat, KeyboardButtonPollType, KeyboardButtonRequestUsers } from './';
-import { AtMostOne } from './Update';
+import { AtMostOne } from '../utils';
 
 /**
  * ## KeyboardButton
diff --git a/src/types/TransactionPartner.ts b/src/types/TransactionPartner.ts
@@ -1,6 +1,7 @@
 import {
   TransactionPartnerFragment,
   TransactionPartnerUser,
+  TransactionPartnerChat,
   TransactionPartnerTelegramAds,
   TransactionPartnerTelegramApi,
   TransactionPartnerOther,
@@ -12,6 +13,7 @@ import {
  * This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be
  * one of
  * - TransactionPartnerUser
+ * - TransactionPartnerChat
  * - TransactionPartnerAffiliateProgram
  * - TransactionPartnerFragment
  * - TransactionPartnerTelegramAds
@@ -21,6 +23,7 @@ import {
  */
 export type TransactionPartner =
   | TransactionPartnerUser
+  | TransactionPartnerChat
   | TransactionPartnerAffiliateProgram
   | TransactionPartnerFragment
   | TransactionPartnerTelegramAds
diff --git a/src/types/TransactionPartnerChat.ts b/src/types/TransactionPartnerChat.ts
@@ -0,0 +1,21 @@
+import { Chat, Gift } from './';
+
+/**
+ * Describes a transaction with a chat.
+ */
+export type TransactionPartnerChat = {
+  /**
+   * Type of the transaction partner, always “chat”
+   */
+  type: 'chat';
+
+  /**
+   * Information about the chat
+   */
+  chat: Chat;
+
+  /**
+   * Optional. The gift sent to the chat by the bot
+   */
+  gift?: Gift;
+};
diff --git a/src/types/Update.ts b/src/types/Update.ts
@@ -17,6 +17,7 @@ import {
   ChatBoostRemoved,
   PaidMediaPurchased,
 } from './';
+import { AtMostOne } from '../utils';
 
 /**
  * @see https://core.telegram.org/bots/api#update
@@ -156,13 +157,6 @@ export type EventTypes = {
  */
 export type UpdateType = keyof EventTypes;
 
-/**
- * A TypeScript utility type that enforces only one or none specified properties of a given type to be present.
- */
-export type AtMostOne<T, Keys extends keyof T = keyof T> = {
-  [K in Keys]: { [P in K]: T[K] } & Partial<Record<Exclude<Keys, K>, never>>;
-}[Keys];
-
 /**
  * ## Update
  * This object represents an incoming update.
diff --git a/src/types/Video.ts b/src/types/Video.ts
@@ -37,6 +37,16 @@ export type Video = {
    */
   thumbnail?: PhotoSize;
 
+  /**
+   * Optional. Available sizes of the cover of the video in the message
+   */
+  cover?: PhotoSize[];
+
+  /**
+   * Optional. Timestamp in seconds from which the video will play in the message
+   */
+  start_timestamp?: number;
+
   /**
    * Optional. Original filename as defined by the sender
    */
diff --git a/src/types/index.ts b/src/types/index.ts
@@ -208,6 +208,7 @@ export * from './PaidMediaPurchased';
 export * from './PaidMediaVideo';
 export * from './TransactionPartner';
 export * from './TransactionPartnerAffiliateProgram';
+export * from './TransactionPartnerChat';
 export * from './TransactionPartnerFragment';
 export * from './TransactionPartnerOther';
 export * from './TransactionPartnerTelegramAds';
diff --git a/src/utils.ts b/src/utils.ts
@@ -0,0 +1,17 @@
+/**
+ * A TypeScript utility type that enforces only one or none specified properties of a given type to be present.
+ */
+export type AtMostOne<T, Keys extends keyof T = keyof T> = {
+  [K in Keys]: { [P in K]: T[K] } & Partial<Record<Exclude<Keys, K>, never>>;
+}[Keys];
+
+/**
+ * A TypeScript utility type that enforces exactly one specified property of a given type to be present.
+ */
+export type ExactlyOne<T, Keys extends keyof T = keyof T> = {
+  [K in Keys]: {
+    [P in K]-?: T[P];
+  } & {
+    [P in Exclude<Keys, K>]?: never;
+  } & Omit<T, Keys>;
+}[Keys];

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"type": "commonjs",`
`3`	`3`	`"name": "typescript-telegram-bot-api",`
`4`		`- "version": "0.7.0",`
	`4`	`+ "version": "0.8.0",`
`5`	`5`	`"description": "Telegram Bot API wrapper for Node.js written in TypeScript",`
`6`	`6`	`"repository": "github:Borodin/typescript-telegram-bot-api",`
`7`	`7`	`"main": "dist/index.js",`