nyx-bot-client 0.0.2

package/.env.sample

@@ -0,0 +1,4 @@
+BROKER_MYSQL_USER=
+BROKER_MYSQL_NAME=
+BROKER_MYSQL_HOST=
+BROKER_MYSQL_PASS=

package/.vscode/extensions.json

@@ -0,0 +1,11 @@
+{
+	"recommendations": [
+		"biomejs.biome",
+		"vscode.html-language-features",
+		"vscode.css-language-features",
+		"vscode.typescript-language-features",
+		"vscode.json-language-features",
+		"vscode.markdown-language-features",
+		"vscode.builtin-extensions"
+	]
+}

package/.vscode/settings.json

@@ -0,0 +1,17 @@
+{
+	"editor.tabSize": 3,
+	"editor.insertSpaces": false,
+	"editor.formatOnSave": true,
+	"editor.detectIndentation": false,
+	"editor.defaultFormatter": "biomejs.biome",
+	"[javascript]": {
+		"editor.tabSize": 3,
+		"editor.insertSpaces": false,
+		"editor.defaultFormatter": "biomejs.biome"
+	},
+	"[typescript]": {
+		"editor.tabSize": 3,
+		"editor.insertSpaces": false,
+		"editor.defaultFormatter": "biomejs.biome"
+	}
+}

package/.zed/settings.json

@@ -0,0 +1,20 @@
+{
+	"tab_size": 3,
+	"format_on_save": "on",
+	"remove_trailing_whitespace_on_save": true,
+	"show_whitespaces": "trailing",
+	"languages": {
+		"JavaScript": { "formatter": { "language_server": { "name": "biome" } } },
+		"TypeScript": { "formatter": { "language_server": { "name": "biome" } } },
+		"JSX": { "formatter": { "language_server": { "name": "biome" } } },
+		"TSX": { "formatter": { "language_server": { "name": "biome" } } },
+		"JSON": { "formatter": { "language_server": { "name": "biome" } } },
+		"JSONC": { "formatter": { "language_server": { "name": "biome" } } },
+		"CSS": { "formatter": { "language_server": { "name": "biome" } } },
+		"GraphQL": { "formatter": { "language_server": { "name": "biome" } } }
+	},
+	"code_actions_on_format": {
+		"source.organizeImports.biome": true,
+		"source.fixAll.biome": true
+	}
+}

package/@types/AcceptedGiftTypes.ts

@@ -0,0 +1,26 @@
+/**
+ * ## AcceptedGiftTypes
+ * This object describes the types of gifts that can be gifted to a user or a chat.
+ * @see https://core.telegram.org/bots/api#acceptedgifttypes
+ */
+export type AcceptedGiftTypes = {
+	/**
+	 * True, if unlimited regular gifts are accepted
+	 */
+	unlimited_gifts: boolean;
+
+	/**
+	 * True, if limited regular gifts are accepted
+	 */
+	limited_gifts: boolean;
+
+	/**
+	 * True, if unique gifts or gifts that can be upgraded to unique for free are accepted
+	 */
+	unique_gifts: boolean;
+
+	/**
+	 * True, if a Telegram Premium subscription is accepted
+	 */
+	premium_subscription: boolean;
+};

package/@types/AffiliateInfo.ts

@@ -0,0 +1,35 @@
+import type { Chat, User } from "./";
+
+/**
+ * ## AffiliateInfo
+ * Contains information about the affiliate that received a commission via this transaction.
+ */
+export type AffiliateInfo = {
+	/**
+	 * Optional. The bot or the user that received an affiliate commission if it was received by a bot or a user
+	 */
+	affiliate_user?: User;
+
+	/**
+	 * Optional. The chat that received an affiliate commission if it was received by a chat
+	 */
+	affiliate_chat?: Chat;
+
+	/**
+	 * The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from
+	 * referred users
+	 */
+	commission_per_mille: number;
+
+	/**
+	 * Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for
+	 * refunds
+	 */
+	amount: number;
+
+	/**
+	 * Optional. The number of 1/1000000000 shares of Telegram Stars received by the affiliate;
+	 * from -999999999 to 999999999; can be negative for refunds
+	 */
+	nanostar_amount?: number;
+};

package/@types/Animation.ts

@@ -0,0 +1,56 @@
+import type { PhotoSize } from "./";
+
+/**
+ * ## Animation
+ * This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
+ * @see https://core.telegram.org/bots/api#animation
+ */
+export type Animation = {
+	/**
+	 * Identifier for this file, which can be used to download or reuse the file
+	 */
+	file_id: string;
+
+	/**
+	 * Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used
+	 * to download or reuse the file.
+	 */
+	file_unique_id: string;
+
+	/**
+	 * Video width as defined by sender
+	 */
+	width: number;
+
+	/**
+	 * Video height as defined by sender
+	 */
+	height: number;
+
+	/**
+	 * Duration of the video in seconds as defined by sender
+	 */
+	duration: number;
+
+	/**
+	 * Optional. Animation thumbnail as defined by sender
+	 */
+	thumbnail?: PhotoSize;
+
+	/**
+	 * Optional. Original animation filename as defined by sender
+	 */
+	file_name?: string;
+
+	/**
+	 * Optional. MIME type of the file as defined by sender
+	 */
+	mime_type?: string;
+
+	/**
+	 * Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent
+	 * defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision
+	 * float type are safe for storing this value.
+	 */
+	file_size?: number;
+};

package/@types/Audio.ts

@@ -0,0 +1,56 @@
+import type { PhotoSize } from "./";
+
+/**
+ * ## Audio
+ * This object represents an audio file to be treated as music by the Telegram clients.
+ * @see https://core.telegram.org/bots/api#audio
+ */
+export type Audio = {
+	/**
+	 * Identifier for this file, which can be used to download or reuse the file
+	 */
+	file_id: string;
+
+	/**
+	 * Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used
+	 * to download or reuse the file.
+	 */
+	file_unique_id: string;
+
+	/**
+	 * Duration of the audio in seconds as defined by sender
+	 */
+	duration: number;
+
+	/**
+	 * Optional. Performer of the audio as defined by sender or by audio tags
+	 */
+	performer?: string;
+
+	/**
+	 * Optional. Title of the audio as defined by sender or by audio tags
+	 */
+	title?: string;
+
+	/**
+	 * Optional. Original filename as defined by sender
+	 */
+	file_name?: string;
+
+	/**
+	 * Optional. MIME type of the file as defined by sender
+	 */
+	mime_type?: string;
+
+	/**
+	 * Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent
+	 * defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision
+	 * float type are safe for storing this value.
+	 */
+	file_size?: number;
+
+	/**
+	 * Optional. Thumbnail of the album cover to which the music file belongs
+	 */
+	thumbnail?: PhotoSize;
+};

package/@types/BackgroundFill.ts

@@ -0,0 +1,18 @@
+import type {
+	BackgroundFillFreeformGradient,
+	BackgroundFillGradient,
+	BackgroundFillSolid,
+} from "./";
+
+/**
+ * ## BackgroundFill
+ * This object describes the way a background is filled based on the selected colors. Currently, it can be one of
+ * - `BackgroundFillSolid`
+ * - `BackgroundFillGradient`
+ * - `BackgroundFillFreeformGradient`
+ * @see https://core.telegram.org/bots/api#backgroundfill
+ */
+export type BackgroundFill =
+	| BackgroundFillSolid
+	| BackgroundFillGradient
+	| BackgroundFillFreeformGradient;

package/@types/BackgroundFillFreeformGradient.ts

@@ -0,0 +1,16 @@
+/**
+ * ## BackgroundFillFreeformGradient
+ * The background is a freeform gradient that rotates after every message in the chat.
+ * @see https://core.telegram.org/bots/api#backgroundfillfreeformgradient
+ */
+export type BackgroundFillFreeformGradient = {
+	/**
+	 * Type of the background fill, always `freeform_gradient`
+	 */
+	type: "freeform_gradient";
+
+	/**
+	 * A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format
+	 */
+	colors: [number, number, number] | [number, number, number, number];
+};

package/@types/BackgroundFillGradient.ts

@@ -0,0 +1,26 @@
+/**
+ * ## BackgroundFillGradient
+ * The background is a gradient fill.
+ * @see https://core.telegram.org/bots/api#backgroundfillgradient
+ */
+export type BackgroundFillGradient = {
+	/**
+	 * Type of the background fill, always “gradient”
+	 */
+	type: "gradient";
+
+	/**
+	 * Top color of the gradient in the RGB24 format
+	 */
+	top_color: number;
+
+	/**
+	 * Bottom color of the gradient in the RGB24 format
+	 */
+	bottom_color: number;
+
+	/**
+	 * Clockwise rotation angle of the background fill in degrees; 0-359
+	 */
+	rotation_angle: number;
+};

package/@types/BackgroundFillSolid.ts

@@ -0,0 +1,16 @@
+/**
+ * ## BackgroundFillSolid
+ * The background is filled using the selected color.
+ * @see https://core.telegram.org/bots/api#backgroundfillsolid
+ */
+export type BackgroundFillSolid = {
+	/**
+	 * Type of the background fill, always “solid”
+	 */
+	type: "solid";
+
+	/**
+	 * The color of the background fill in the RGB24 format
+	 */
+	color: string;
+};

package/@types/BackgroundType.ts

@@ -0,0 +1,21 @@
+import type {
+	BackgroundTypeChatTheme,
+	BackgroundTypeFill,
+	BackgroundTypePattern,
+	BackgroundTypeWallpaper,
+} from "./";
+
+/**
+ * ## BackgroundType
+ * This object describes the type of a background. Currently, it can be one of
+ * - `BackgroundTypeFill`
+ * - `BackgroundTypeWallpaper`
+ * - `BackgroundTypePattern`
+ * - `BackgroundTypeChatTheme`
+ * @see https://core.telegram.org/bots/api#backgroundtype
+ */
+export type BackgroundType =
+	| BackgroundTypeFill
+	| BackgroundTypeWallpaper
+	| BackgroundTypePattern
+	| BackgroundTypeChatTheme;

package/@types/BackgroundTypeChatTheme.ts

@@ -0,0 +1,16 @@
+/**
+ * ## BackgroundTypeChatTheme
+ * The background is taken directly from a built-in chat theme.
+ * @see https://core.telegram.org/bots/api#backgroundtypechattheme
+ */
+export type BackgroundTypeChatTheme = {
+	/**
+	 * Type of the background, always “chat_theme”
+	 */
+	type: "chat_theme";
+
+	/**
+	 * Name of the chat theme, which is usually an emoji
+	 */
+	theme_name: string;
+};

package/@types/BackgroundTypeFill.ts

@@ -0,0 +1,23 @@
+import type { BackgroundFill } from "./";
+
+/**
+ * ## BackgroundTypeFill
+ * The background is automatically filled based on the selected colors.
+ * @see https://core.telegram.org/bots/api#backgroundtypefill
+ */
+export type BackgroundTypeFill = {
+	/**
+	 * Type of the background, always “fill”
+	 */
+	type: "fill";
+
+	/**
+	 * The background fill
+	 */
+	fill: BackgroundFill;
+
+	/**
+	 * Dimming of the background in dark themes, as a percentage; 0-100
+	 */
+	dark_theme_dimming: number;
+};

package/@types/BackgroundTypePattern.ts

@@ -0,0 +1,40 @@
+import type { BackgroundFill, Document } from "./";
+
+/**
+ * ## BackgroundTypePattern
+ * The background is a PNG or TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be
+ * combined with the background fill chosen by the user.
+ * @see https://core.telegram.org/bots/api#backgroundtypepattern
+ */
+export type BackgroundTypePattern = {
+	/**
+	 * Type of the background, always “pattern”
+	 */
+	type: "pattern";
+
+	/**
+	 * Document with the pattern
+	 */
+	document: Document;
+
+	/**
+	 * The background fill that is combined with the pattern
+	 */
+	fill: BackgroundFill;
+
+	/**
+	 * Intensity of the pattern when it is shown above the filled background; 0-100
+	 */
+	intensity: number;
+
+	/**
+	 * Optional. True, if the background fill must be applied only to the pattern itself. All other pixels are black in
+	 * this case. For dark themes only
+	 */
+	is_blurred: boolean;
+
+	/**
+	 * Optional. True, if the background moves slightly when the device is tilted
+	 */
+	is_moving: boolean;
+};

package/@types/BackgroundTypeWallpaper.ts

@@ -0,0 +1,33 @@
+import type { Document } from "./";
+
+/**
+ * ## BackgroundTypeWallpaper
+ * The background is a wallpaper in the JPEG format.
+ * @see https://core.telegram.org/bots/api#backgroundtypewallpaper
+ */
+export type BackgroundTypeWallpaper = {
+	/**
+	 * Type of the background, always “wallpaper”
+	 */
+	type: "wallpaper";
+
+	/**
+	 * Document with the wallpaper
+	 */
+	document: Document;
+
+	/**
+	 * Dimming of the background in dark themes, as a percentage; 0-100
+	 */
+	dark_theme_dimming: number;
+
+	/**
+	 * Optional. True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12
+	 */
+	is_blurred: boolean;
+
+	/**
+	 * Optional. True, if the background moves slightly when the device is tilted
+	 */
+	is_moving: boolean;
+};

package/@types/Birthdate.ts

@@ -0,0 +1,21 @@
+/**
+ * ## Birthdate
+ * Describes the birthdate of a user.
+ * @see https://core.telegram.org/bots/api#birthdate
+ */
+export type Birthdate = {
+	/**
+	 * Day of the user's birth; 1-31
+	 */
+	day: number;
+
+	/**
+	 * Month of the user's birth; 1-12
+	 */
+	month: number;
+
+	/**
+	 * Optional. Year of the user's birth
+	 */
+	year?: number;
+};

package/@types/BotCommand.ts

@@ -0,0 +1,16 @@
+/**
+ * ## BotCommand
+ * This object represents a bot command.
+ * @see https://core.telegram.org/bots/api#botcommand
+ */
+export type BotCommand = {
+	/**
+	 * Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores.
+	 */
+	command: string;
+
+	/**
+	 * Description of the command; 1-256 characters.
+	 */
+	description: string;
+};

package/@types/BotCommandScope.ts

@@ -0,0 +1,30 @@
+import type {
+	BotCommandScopeAllChatAdministrators,
+	BotCommandScopeAllGroupChats,
+	BotCommandScopeAllPrivateChats,
+	BotCommandScopeChat,
+	BotCommandScopeChatAdministrators,
+	BotCommandScopeChatMember,
+	BotCommandScopeDefault,
+} from "./";
+
+/**
+ * ## BotCommandScope
+ * This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:
+ * - `BotCommandScopeDefault`
+ * - `BotCommandScopeAllPrivateChats`
+ * - `BotCommandScopeAllGroupChats`
+ * - `BotCommandScopeAllChatAdministrators`
+ * - `BotCommandScopeChat`
+ * - `BotCommandScopeChatAdministrators`
+ * - `BotCommandScopeChatMember`
+ * @see https://core.telegram.org/bots/api#botcommandscope
+ */
+export type BotCommandScope =
+	| BotCommandScopeDefault
+	| BotCommandScopeAllPrivateChats
+	| BotCommandScopeAllGroupChats
+	| BotCommandScopeAllChatAdministrators
+	| BotCommandScopeChat
+	| BotCommandScopeChatAdministrators
+	| BotCommandScopeChatMember;

package/@types/BotCommandScopeAllChatAdministrators.ts

@@ -0,0 +1,11 @@
+/**
+ * ## BotCommandScopeAllChatAdministrators
+ * Represents the scope of bot commands, covering all group and supergroup chat administrators.
+ * @see https://core.telegram.org/bots/api#botcommandscopeallchatadministrators
+ */
+export type BotCommandScopeAllChatAdministrators = {
+	/**
+	 * Scope type, must be all_chat_administrators
+	 */
+	type: "all_chat_administrators";
+};

package/@types/BotCommandScopeAllGroupChats.ts

@@ -0,0 +1,11 @@
+/**
+ * ## BotCommandScopeAllGroupChats
+ * Represents the scope of bot commands, covering all group and supergroup chats.
+ * @see https://core.telegram.org/bots/api#botcommandscopeallgroupchats
+ */
+export type BotCommandScopeAllGroupChats = {
+	/**
+	 * Scope type, must be all_group_chats
+	 */
+	type: "all_group_chats";
+};

package/@types/BotCommandScopeAllPrivateChats.ts

@@ -0,0 +1,11 @@
+/**
+ * ## BotCommandScopeAllPrivateChats
+ * Represents the scope of bot commands, covering all private chats.
+ * @see https://core.telegram.org/bots/api#botcommandscopeallprivatechats
+ */
+export type BotCommandScopeAllPrivateChats = {
+	/**
+	 * Scope type, must be all_private_chats
+	 */
+	type: "all_private_chats";
+};

package/@types/BotCommandScopeChat.ts

@@ -0,0 +1,16 @@
+/**
+ * ## BotCommandScopeChat
+ * Represents the scope of bot commands, covering a specific chat.
+ * @see https://core.telegram.org/bots/api#botcommandscopechat
+ */
+export type BotCommandScopeChat = {
+	/**
+	 * Scope type, must be chat
+	 */
+	type: "chat";
+
+	/**
+	 * Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
+	 */
+	chat_id: number | string;
+};

package/@types/BotCommandScopeChatAdministrators.ts

@@ -0,0 +1,16 @@
+/**
+ * ## BotCommandScopeChatAdministrators
+ * Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.
+ * @see https://core.telegram.org/bots/api#botcommandscopechatadministrators
+ */
+export type BotCommandScopeChatAdministrators = {
+	/**
+	 * Scope type, must be chat_administrators
+	 */
+	type: "chat_administrators";
+
+	/**
+	 * Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
+	 */
+	chat_id: number | string;
+};

package/@types/BotCommandScopeChatMember.ts

@@ -0,0 +1,21 @@
+/**
+ * ## BotCommandScopeChatMember
+ * Represents the scope of bot commands, covering a specific member of a group or supergroup chat.
+ * @see https://core.telegram.org/bots/api#botcommandscopechatmember
+ */
+export type BotCommandScopeChatMember = {
+	/**
+	 * Scope type, must be chat_member
+	 */
+	type: "chat_member";
+
+	/**
+	 * Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
+	 */
+	chat_id: number | string;
+
+	/**
+	 * Unique identifier of the target user
+	 */
+	user_id: number;
+};

package/@types/BotCommandScopeDefault.ts

@@ -0,0 +1,12 @@
+/**
+ * ## BotCommandScopeDefault
+ * Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are
+ * specified for the user.
+ * @see https://core.telegram.org/bots/api#botcommandscopedefault
+ */
+export type BotCommandScopeDefault = {
+	/**
+	 * Scope type, must be default
+	 */
+	type: "default";
+};

package/@types/BotDescription.ts

@@ -0,0 +1,11 @@
+/**
+ * BotDescription
+ * This object represents the bot's description.
+ * @see https://core.telegram.org/bots/api#botdescription
+ */
+export type BotDescription = {
+	/**
+	 * The bot's description
+	 */
+	description: string;
+};

package/@types/BotName.ts

@@ -0,0 +1,11 @@
+/**
+ * ## BotName
+ * This object represents the bot's name.
+ * @see https://core.telegram.org/bots/api#botname
+ */
+export type BotName = {
+	/**
+	 * The bot's name
+	 */
+	name: string;
+};

package/@types/BotShortDescription.ts

@@ -0,0 +1,11 @@
+/**
+ * ## BotShortDescription
+ * This object represents the bot's short description.
+ * @see https://core.telegram.org/bots/api#botshortdescription
+ */
+export type BotShortDescription = {
+	/**
+	 * The bot's short description
+	 */
+	short_description: string;
+};