@telegram.ts/types 1.0.1 → 1.3.0

package/src/telegramTypes.d.ts

@@ -0,0 +1,49 @@
+/**
+* Represents the response from the API, which can be either a success or an error.
+* If 'ok' is true, the request was successful, and the result of the query can be found in the 'result' field.
+* In case of an unsuccessful request, 'ok' is false, and the error is explained in the 'description' field.
+* An optional 'error_code' field of type number may be returned, but its contents are subject to change in the future.
+* Some errors may also have an additional 'parameters' field of type ResponseParameters,
+* which can provide information to automatically handle the error.
+*/
+export type ApiResponse < T > = ApiError | ApiSuccess < T >;
+
+/**
+* Represents an API error response.
+*/
+export interface ApiError {
+  ok: false;
+  error_code: number;
+  description: string;
+  parameters?: ResponseParameters;
+}
+
+/**
+* Represents a successful API response.
+* 'ok' is true, and the result of the query can be found in the 'result' field.
+*/
+export interface ApiSuccess < T > {
+  ok: true;
+  result: T;
+}
+
+/**
+* Describes additional parameters provided in an API error response.
+*/
+export interface ResponseParameters {
+  /**
+  * The group has been migrated to a supergroup with the specified identifier.
+  * This number may have more than 32 significant bits, and some programming languages may have difficulty/silent defects in interpreting it.
+  * However, it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type is safe for storing this identifier.
+  */
+  migrate_to_chat_id?: number;
+  /**
+  * In case of exceeding flood control, the number of seconds left to wait before the request can be repeated.
+  */
+  retry_after?: number;
+}
+
+/**
+* All methods in the Bot API are case-insensitive.
+* All queries must be made using UTF-8.
+*/

package/src/updateTypes.d.ts

@@ -0,0 +1,141 @@
+import type {
+  ChosenInlineResult,
+  InlineQuery
+} from "./inlineTypes.js";
+import type {
+  Chat,
+  ChatJoinRequest,
+  ChatMemberUpdated,
+  User
+} from "./manageTypes.js";
+import type {
+  CallbackQuery
+} from "./markupTypes.js";
+import type {
+  Message,
+  Poll,
+  PollAnswer
+} from "./messageTypes.js";
+import type {
+  PreCheckoutQuery,
+  ShippingQuery
+} from "./invoiceTypes.js";
+
+/**
+* Namespace used internally to define more accurate message update types.
+*/
+export declare namespace Update {
+  /**
+  * Internal type holding properties that message updates in channels share.
+  */
+  interface Channel {
+    chat: Chat.ChannelChat;
+  }
+
+  /**
+  * Internal type holding properties that message updates outside of channels share.
+  */
+  interface NonChannel {
+    chat: Exclude < Chat,
+    Chat.ChannelChat >;
+    from: User;
+  }
+
+  /**
+  * Internal type holding properties that updates about edited messages share.
+  */
+  interface Edited {
+    /**
+    * Date the message was last edited in Unix time.
+    */
+    edit_date: number;
+  }
+}
+
+/**
+* This object represents an incoming update.
+* At most one of the optional parameters can be present in any given update.
+*/
+export interface Update {
+  /**
+  * The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially.
+  * This ID becomes especially handy if you're using webhooks, as it allows you to ignore repeated updates or restore the correct update sequence if they get out of order.
+  * If there are no new updates for at least a week, the identifier of the next update will be chosen randomly instead of sequentially.
+  */
+  update_id: number;
+
+  /**
+  * New incoming message of any kind - text, photo, sticker, etc.
+  */
+  message?: Message & Update.NonChannel;
+
+  /**
+  * New version of a message known to the bot that has been edited.
+  */
+  edited_message?: Message & Update.Edited & Update.NonChannel;
+
+  /**
+  * New incoming channel post of any kind - text, photo, sticker, etc.
+  */
+  channel_post?: Message & Update.Channel;
+
+  /**
+  * New version of a channel post known to the bot that has been edited.
+  */
+  edited_channel_post?: Message & Update.Edited & Update.Channel;
+
+  /**
+  * New incoming inline query.
+  */
+  inline_query?: InlineQuery;
+
+  /**
+  * The result of an inline query that was chosen by a user and sent to their chat partner.
+  * Please refer to our documentation on collecting feedback for details on how to enable these updates for your bot.
+  */
+  chosen_inline_result?: ChosenInlineResult;
+
+  /**
+  * New incoming callback query.
+  */
+  callback_query?: CallbackQuery;
+
+  /**
+  * New incoming shipping query. Only for invoices with flexible price.
+  */
+  shipping_query?: ShippingQuery;
+
+  /**
+  * New incoming pre-checkout query. Contains full information about checkout.
+  */
+  pre_checkout_query?: PreCheckoutQuery;
+
+  /**
+  * New poll state. Bots receive updates only about stopped polls and polls sent by the bot.
+  */
+  poll?: Poll;
+
+  /**
+  * A user changed their answer in a non-anonymous poll.
+  * Bots receive new votes only in polls that were sent by the bot itself.
+  */
+  poll_answer?: PollAnswer;
+
+  /**
+  * The bot's chat member status was updated in a chat.
+  * For private chats, this update is received only when the bot is blocked or unblocked by the user.
+  */
+  my_chat_member?: ChatMemberUpdated;
+
+  /**
+  * A chat member's status was updated in a chat.
+  * The bot must be an administrator in the chat and must explicitly specify "chat_member" in the list of allowed_updates to receive these updates.
+  */
+  chat_member?: ChatMemberUpdated;
+
+  /**
+  * A request to join the chat has been sent.
+  * The bot must have the can_invite_users administrator right in the chat to receive these updates.
+  */
+  chat_join_request?: ChatJoinRequest;
+}

package/src/api.d.ts

@@ -1,22 +0,0 @@
-export interface ApiError {
-  ok: false;
-  error_code: number;
-  description: string;
-  parameters?: ResponseParameters;
-}
-export interface ApiSuccess < T > {
-  ok: true;
-  result: T;
-}
-/** The response contains an object, which always has a Boolean field 'ok' and may have an optional String field 'description' with a human-readable description of the result. If 'ok' equals true, the request was successful and the result of the query can be found in the 'result' field. In case of an unsuccessful request, 'ok' equals false and the error is explained in the 'description'. An Integer 'error_code' field is also returned, but its contents are subject to change in the future. Some errors may also have an optional field 'parameters' of the type ResponseParameters, which can help to automatically handle the error.
-
-All methods in the Bot API are case-insensitive.
-All queries must be made using UTF-8. */
-export type ApiResponse < T > = ApiError | ApiSuccess < T >;
-/** Describes why a request was unsuccessful. */
-export interface ResponseParameters {
-  /** The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits 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 identifier. */
-  migrate_to_chat_id?: number;
-  /** In case of exceeding flood control, the number of seconds left to wait before the request can be repeated */
-  retry_after?: number;
-}