@mtcute/core 0.18.0-rc.5 → 0.18.0

package/highlevel/types/messages/message-action.d.cts

@@ -0,0 +1,420 @@
+import { tl } from '@mtcute/tl';
+import { CallDiscardReason } from '../calls/index.js';
+import { TextWithEntities } from '../misc/entities.js';
+import { Peer } from '../peers/peer.js';
+import { Message } from './message.js';
+import { Photo } from '../media/photo.js';
+import { StarGift } from '../premium/stars-gift.js';
+/** Group was created */
+export interface ActionChatCreated {
+    readonly type: 'chat_created';
+    /** Group name */
+    readonly title: string;
+    /** IDs of the users in the group */
+    readonly users: number[];
+}
+/** Channel/supergroup was created */
+export interface ActionChannelCreated {
+    readonly type: 'channel_created';
+    /** Original channel/supergroup title */
+    readonly title: string;
+}
+/** Chat was migrated to a supergroup with a given ID */
+export interface ActionChatMigrateTo {
+    readonly type: 'chat_migrate_to';
+    /** Marked ID of the supergroup chat was migrated to */
+    readonly id: number;
+}
+/** Supergroup was migrated from a chat with a given ID */
+export interface ActionChannelMigrateFrom {
+    readonly type: 'channel_migrate_from';
+    /** Marked ID of the chat this channel was migrated from */
+    readonly id: number;
+    /** Old chat's title */
+    readonly title: string;
+}
+/**
+ * A message has been pinned.
+ *
+ * To get the message itself, use {@link Message.getReplyTo}
+ */
+export interface ActionMessagePinned {
+    readonly type: 'message_pinned';
+}
+/** History was cleared in a private chat. */
+export interface ActionHistoryCleared {
+    readonly type: 'history_cleared';
+}
+/** Someone scored in a game (usually only used for newly set high scores) */
+export interface ActionGameScore {
+    readonly type: 'game_score';
+    /** Game ID */
+    readonly gameId: tl.Long;
+    /** Score */
+    readonly score: number;
+}
+/** Contact has joined Telegram */
+export interface ActionContactJoined {
+    readonly type: 'contact_joined';
+}
+/** Group title was changed */
+export interface ActionTitleChanged {
+    readonly type: 'title_changed';
+    /** New group name */
+    readonly title: string;
+}
+/** Group photo was changed */
+export interface ActionPhotoChanged {
+    readonly type: 'photo_changed';
+    /** New group photo */
+    readonly photo: Photo;
+}
+/** Group photo was deleted */
+export interface ActionPhotoDeleted {
+    readonly type: 'photo_deleted';
+}
+/** Users were added to the chat */
+export interface ActionUsersAdded {
+    readonly type: 'users_added';
+    /** IDs of the users that were added */
+    readonly users: number[];
+}
+/** User has left the group */
+export interface ActionUserLeft {
+    readonly type: 'user_left';
+}
+/** User was removed from the group */
+export interface ActionUserRemoved {
+    readonly type: 'user_removed';
+    /** ID of the user that was removed from the group */
+    readonly user: number;
+}
+/** User has joined the group via an invite link */
+export interface ActionUserJoinedLink {
+    readonly type: 'user_joined_link';
+    /** ID of the user who created the link */
+    readonly inviter: number;
+}
+/**
+ * User has joined the group via an invite link
+ * and was approved by an administrator
+ */
+export interface ActionUserJoinedApproved {
+    readonly type: 'user_joined_approved';
+}
+/** A payment was received from a user (bot) */
+export interface ActionPaymentReceived {
+    readonly type: 'payment_received';
+    /** Three-letter ISO 4217 currency code */
+    readonly currency: string;
+    /**
+     * Price of the product in the smallest units of the currency
+     * (integer, not float/double). For example, for a price of
+     * `US$ 1.45`, `amount = 145`
+     */
+    readonly amount: tl.Long;
+    /** Bot specified invoice payload */
+    readonly payload: Uint8Array;
+    /** Order information provided by the user */
+    readonly info?: tl.TypePaymentRequestedInfo;
+    /** ID of the shipping option chosen by the user */
+    readonly shippingOptionId?: string;
+    /** Payment provider ID */
+    readonly charge?: tl.TypePaymentCharge;
+    /** If this is a subscription being bought, the date when the subscription will expire */
+    readonly subscriptionUntilDate?: Date;
+}
+/** A payment was sent to a user */
+export interface ActionPaymentSent {
+    readonly type: 'payment_sent';
+    /** Three-letter ISO 4217 currency code */
+    readonly currency: string;
+    /**
+     * Price of the product in the smallest units of the currency
+     * (integer, not float/double). For example, for a price of
+     * `US$ 1.45`, `amount = 145`
+     */
+    readonly amount: tl.Long;
+    /** If this is a subscription being bought, the date when the subscription will expire */
+    readonly subscriptionUntilDate?: Date;
+}
+/** A phone call */
+export interface ActionCall {
+    readonly type: 'call';
+    /** Call ID */
+    readonly id: tl.Long;
+    /** Whether this is a video call */
+    readonly isVideo: boolean;
+    /** Duration if the call in seconds (0 if not available) */
+    readonly duration: number;
+    /** Call discard reason, if available */
+    readonly reason?: CallDiscardReason;
+}
+/** A screenshot was taken */
+export interface ActionScreenshotTaken {
+    readonly type: 'screenshot_taken';
+}
+/** User has authorized via the bot */
+export interface ActionBotAllowed {
+    readonly type: 'bot_allowed';
+    /** Domain where the user has logged in */
+    readonly domain?: string;
+}
+/**
+ * A user is in proximity of another user
+ * (see [Proximity alerts](https://core.telegram.org/api/live-location#proximity-alert))
+ */
+export interface ActionGeoProximity {
+    readonly type: 'geo_proximity';
+    /** ID of the user who sent the geolocation with proximity alerts */
+    readonly targetId: number;
+    /** ID of the user who has approached `targetId` */
+    readonly userId: number;
+    /** Distance between them in meters */
+    readonly distance: number;
+}
+/** Group call has started */
+export interface ActionGroupCallStarted {
+    readonly type: 'group_call_started';
+    /** TL object representing the call */
+    readonly call: tl.TypeInputGroupCall;
+}
+/** Group call has ended */
+export interface ActionGroupCallEnded {
+    readonly type: 'group_call_ended';
+    /** TL object representing the call */
+    readonly call: tl.TypeInputGroupCall;
+    /** Duration of the call */
+    readonly duration: number;
+}
+/** Group call has been scheduled */
+export interface ActionGroupCallScheduled {
+    readonly type: 'group_call_scheduled';
+    /** TL object representing the call */
+    readonly call: tl.TypeInputGroupCall;
+    /** Date when the call will start */
+    readonly date: Date;
+}
+/** Group call has ended */
+export interface ActionGroupInvite {
+    readonly type: 'group_call_invite';
+    /** TL object representing the call */
+    readonly call: tl.TypeInputGroupCall;
+    /** IDs of the users invited to the call */
+    readonly userIds: number[];
+}
+/** Messages TTL changed */
+export interface ActionTtlChanged {
+    readonly type: 'ttl_changed';
+    /** New TTL period */
+    readonly period: number;
+}
+/** Forum topic was created */
+export interface ActionTopicCreated {
+    readonly type: 'topic_created';
+    /** Title of the topic */
+    title: string;
+    /** Icon color of the topic */
+    iconColor: number;
+    /** Icon emoji of the topic */
+    iconCustomEmoji?: tl.Long;
+}
+/** Forum topic was modified */
+export interface ActionTopicEdited {
+    readonly type: 'topic_edited';
+    /** New title of the topic */
+    title?: string;
+    /** New icon emoji of the topic (may be empty) */
+    iconCustomEmoji?: tl.Long;
+    /** Whether the topic was opened/closed */
+    closed?: boolean;
+    /** Whether the topic was (un-)hidden - only for "General" topic (`id=1`) */
+    hidden?: boolean;
+}
+/** A non-standard action has happened in the chat */
+export interface ActionCustom {
+    readonly type: 'custom';
+    /** Text to be shown in the interface */
+    action: string;
+}
+/** Chat theme was changed */
+export interface ActionThemeChanged {
+    readonly type: 'theme_changed';
+    /** Emoji representing the new theme */
+    emoji: string;
+}
+/** Data was sent from a WebView (user-side action) */
+export interface ActionWebviewDataSent {
+    readonly type: 'webview_sent';
+    /** Text of the button that was pressed to open the WebView */
+    text: string;
+}
+/** Data was received from a WebView (bot-side action) */
+export interface ActionWebviewDataReceived {
+    readonly type: 'webview_received';
+    /** Text of the button that was pressed to open the WebView */
+    text: string;
+    /** Data received from the WebView */
+    data: string;
+}
+/** Premium subscription was gifted */
+export interface ActionPremiumGifted {
+    readonly type: 'premium_gifted';
+    /**
+     * Currency in which it was paid for.
+     * Three-letter ISO 4217 currency code)
+     */
+    currency: string;
+    /**
+     * Price of the product in the smallest units of the currency
+     * (integer, not float/double). For example, for a price of
+     * `US$ 1.45`, `amount = 145`
+     */
+    amount: number;
+    /** Duration of the gifted subscription in months */
+    months: number;
+    /** If the subscription was bought with crypto, information about it */
+    crypto?: {
+        /** Crypto currency name */
+        currency: string;
+        /** Price in the smallest units */
+        amount: number;
+    };
+    /** Message attached to the gift */
+    message?: TextWithEntities;
+}
+/** A photo has been suggested as a profile photo */
+export interface ActionPhotoSuggested {
+    readonly type: 'photo_suggested';
+    /** Photo that was suggested */
+    photo: Photo;
+}
+/**
+ * A peer was chosen by the user after clicking on a RequestPeer button.
+ * The user-side version of {@link ActionPeerChosen}
+ */
+export interface ActionPeerSent {
+    readonly type: 'peer_sent';
+    /** ID of the button passed earlier by the bot */
+    buttonId: number;
+    /** Brief information about the chosen peers */
+    peers: tl.TypeRequestedPeer[];
+}
+/**
+ * A peer was chosen by the user after clicking on a RequestPeer button
+ * The bot-side version of {@link ActionPeerSent}
+ */
+export interface ActionPeerChosen {
+    readonly type: 'peer_chosen';
+    /** ID of the button passed earlier by the bot */
+    buttonId: number;
+    /** Chosen peers */
+    peers: Peer[];
+}
+/** A wallpaper of the chathas been changed */
+export interface ActionWallpaperChanged {
+    readonly type: 'wallpaper_changed';
+    /**
+     * Whether the user has applied the same wallpaper
+     * as the other party previously set in the chat
+     */
+    same: boolean;
+    /**
+     * Whether the wallpaper was forcefully applied for
+     * both sides, without explicit confirmation from the other
+     * side.
+     */
+    forBoth: boolean;
+    /** TL object representing the new wallpaper */
+    wallpaper: tl.TypeWallPaper;
+}
+/** A Telergam Premium gift code was received */
+export interface ActionGiftCode {
+    readonly type: 'gift_code';
+    /** Information about the gift code */
+    raw: tl.RawMessageActionGiftCode;
+    /** Message attached to the gift */
+    message?: TextWithEntities;
+}
+/** A Telergam Premium giveaway was started */
+export interface ActionGiveawayStarted {
+    readonly type: 'giveaway_started';
+}
+/** A Telergam Premium giveaway was ended and results are available */
+export interface ActionGiveawayEnded {
+    readonly type: 'giveaway_ended';
+    /** Number of winners in the giveaway */
+    winners: number;
+    /** Number of undistributed prizes */
+    undistributed: number;
+}
+/** Boosts were applied to the group */
+export interface ActionBoostApply {
+    readonly type: 'boost_apply';
+    /** Number of boosts applied */
+    count: number;
+}
+/** A payment was refunded */
+export interface ActionPaymentRefunded {
+    readonly type: 'payment_refunded';
+    /** Three-letter ISO 4217 currency code */
+    currency: string;
+    /** Marked ID of the peer where the stars were refunded (?) */
+    peerId: number;
+    /** Number of `currency` refunded, in the smallest unit */
+    amount: tl.Long;
+    /** Payload defined by the bot */
+    payload?: Uint8Array;
+    /** Information about the charge */
+    charge: tl.TypePaymentCharge;
+}
+/** Telegram Stars were gifted by the other chat participant */
+export interface ActionStarGifted {
+    readonly type: 'stars_gifted';
+    /** Whether `currency` is a cryptocurrency */
+    isCrypto: boolean;
+    /** Currency in which the stars were paid for */
+    currency: string;
+    /** Amount of `currency` that was paid */
+    amount: tl.Long;
+    /** Amount of Telegram Stars that were gifted */
+    stars: tl.Long;
+    /** Transaction ID, if available */
+    transactionId?: string;
+}
+/**
+ * Telegram Stars were awarded in a giveaway
+ */
+export interface ActionStarsPrize {
+    readonly type: 'stars_prize';
+    /** Whether this prize was claimed yet */
+    claimed: boolean;
+    /** Stars prize */
+    stars: tl.Long;
+    /** Transaction ID */
+    transactionId: string;
+    boostPeer: Peer;
+    /** Message ID containing the giveaway */
+    giveawayMessageId: number;
+}
+export interface ActionStarGift {
+    readonly type: 'stars_gift';
+    /** Whether the sender chose to send the gift anonymously */
+    nameHidden: boolean;
+    /** Whether this gift was saved to the recipient's profile */
+    saved: boolean;
+    /** Whether this gift was converted to stars */
+    converted: boolean;
+    /**
+     * Amount of stars the gift can be converted to by the recipient
+     * (0 if the gift cannot be converted)
+     */
+    convertStars: tl.Long;
+    /** The gift itself */
+    gift: StarGift;
+    /** Message attached to the gift */
+    message: TextWithEntities | null;
+}
+export type MessageAction = ActionChatCreated | ActionChannelCreated | ActionChatMigrateTo | ActionChannelMigrateFrom | ActionMessagePinned | ActionHistoryCleared | ActionGameScore | ActionContactJoined | ActionTitleChanged | ActionPhotoChanged | ActionPhotoDeleted | ActionUsersAdded | ActionUserLeft | ActionUserRemoved | ActionUserJoinedLink | ActionPaymentReceived | ActionPaymentSent | ActionCall | ActionScreenshotTaken | ActionBotAllowed | ActionGeoProximity | ActionGroupCallStarted | ActionGroupCallEnded | ActionGroupCallScheduled | ActionGroupInvite | ActionTtlChanged | ActionTopicCreated | ActionTopicEdited | ActionCustom | ActionThemeChanged | ActionUserJoinedApproved | ActionWebviewDataSent | ActionWebviewDataReceived | ActionPremiumGifted | ActionPhotoSuggested | ActionPeerSent | ActionPeerChosen | ActionWallpaperChanged | ActionGiftCode | ActionGiveawayStarted | ActionGiveawayEnded | ActionBoostApply | ActionPaymentRefunded | ActionStarGifted | ActionStarsPrize | ActionStarGift | null;
+/** @internal */
+export declare function _messageActionFromTl(this: Message, act: tl.TypeMessageAction): MessageAction;

package/highlevel/types/messages/message-effect.d.cts

@@ -0,0 +1,20 @@
+import { tl } from '@mtcute/tl';
+import { LongMap } from '../../../utils/long-utils.js';
+import { Sticker } from '../media/sticker.js';
+export declare class MessageEffect {
+    readonly raw: tl.RawAvailableEffect;
+    readonly documentsMap: LongMap<tl.RawDocument>;
+    constructor(raw: tl.RawAvailableEffect, documentsMap: LongMap<tl.RawDocument>);
+    /** Whether Telegram Premium is required to use this effect */
+    get isPremiumRequired(): boolean;
+    /** ID of this effect */
+    get id(): tl.Long;
+    /** Emoji representint this reaction */
+    get emoji(): string;
+    /** Sticker representing a static icon for this effect (if any) */
+    get staticIcon(): Sticker | null;
+    /** Animated icon representing the effect  */
+    get icon(): Sticker;
+    /** The animation itself */
+    get animation(): Sticker | null;
+}

package/highlevel/types/messages/message-entity.d.cts

@@ -0,0 +1,89 @@
+import { tl } from '@mtcute/tl';
+/**
+ * Params of the entity. `.kind` can be:
+ *   - 'mention': `@username`.
+ *   - 'hashtag': `#hashtag`.
+ *   - 'cashtag': `$USD`.
+ *   - 'bot_command': `/start`.
+ *   - 'url': `https://example.com`
+ *   - 'email': `example@example.com`.
+ *   - 'phone_number': `+42000`.
+ *   - 'bold': **bold text**.
+ *   - 'italic': *italic text*.
+ *   - 'underline': <u>underlined</u> text.
+ *   - 'strikethrough': <s>strikethrough</s> text.
+ *   - 'code': `monospaced` string.
+ *   - 'pre': `monospaced` block. `.language` contains the language of the block (if available).
+ *   - 'text_link': for clickable text URLs.
+ *   - 'text_mention': for user mention by name. `.userId` contains the ID of the mentioned user.
+ *   - 'blockquote': A blockquote
+ *   - 'emoji': A custom emoji. `.emojiId` contains the emoji ID.
+ */
+export type MessageEntityParams = {
+    kind: 'mention' | 'hashtag' | 'cashtag' | 'bot_command' | 'url' | 'email' | 'phone_number' | 'bold' | 'italic' | 'underline' | 'strikethrough' | 'spoiler' | 'code' | 'bank_card' | 'unknown';
+} | {
+    kind: 'blockquote';
+    collapsible: boolean;
+} | {
+    kind: 'pre';
+    language?: string;
+} | {
+    kind: 'text_link';
+    url: string;
+} | {
+    kind: 'text_mention';
+    userId: number;
+} | {
+    kind: 'emoji';
+    emojiId: tl.Long;
+};
+/**
+ * Kind of the entity. For more information, see {@link MessageEntityParams}
+ */
+export type MessageEntityKind = MessageEntityParams['kind'];
+/**
+ * One special entity in a text message (like mention, hashtag, URL, etc.)
+ */
+export declare class MessageEntity {
+    readonly raw: tl.TypeMessageEntity;
+    readonly _text?: string | undefined;
+    constructor(raw: tl.TypeMessageEntity, _text?: string | undefined);
+    /**
+     * Offset in UTF-16 code units to the start of the entity.
+     *
+     * Since JS strings are UTF-16, you can use this as-is
+     */
+    get offset(): number;
+    /**
+     * Length of the entity in UTF-16 code units.
+     *
+     * Since JS strings are UTF-16, you can use this as-is
+     */
+    get length(): number;
+    /**
+     * Kind of the entity (see {@link MessageEntityParams})
+     */
+    get kind(): MessageEntityKind;
+    /**
+     * Params of the entity
+     */
+    get params(): MessageEntityParams;
+    /**
+     * Text contained in this entity.
+     *
+     * > **Note**: This does not take into account that entities may overlap,
+     * > and is only useful for simple cases.
+     */
+    get text(): string;
+    /**
+     * Checks if this entity is of the given type, and adjusts the type accordingly.
+     * @param kind
+     * @returns
+     */
+    is<const T extends MessageEntityKind>(kind: T): this is MessageEntity & {
+        params: Extract<MessageEntityParams, {
+            kind: T;
+        }>;
+        kind: T;
+    };
+}

package/highlevel/types/messages/message-forward.d.cts

@@ -0,0 +1,39 @@
+import { tl } from '@mtcute/tl';
+import { Peer, PeerSender } from '../peers/peer.js';
+import { PeersIndex } from '../peers/peers-index.js';
+/**
+ * Information about forwarded message origin
+ */
+export declare class MessageForwardInfo {
+    readonly raw: tl.RawMessageFwdHeader;
+    readonly _peers: PeersIndex;
+    constructor(raw: tl.RawMessageFwdHeader, _peers: PeersIndex);
+    /**
+     * Date the original message was sent
+     */
+    get date(): Date;
+    /**
+     * Sender of the original message (either user or a channel)
+     * or their name (for users with private forwards)
+     */
+    get sender(): PeerSender;
+    /**
+     * For "saved" messages (i.e. messages forwarded to yourself,
+     * "Saved Messages"), the peer where the message was originally sent.
+     *
+     * `null` for other messages, you might want to use {@link sender} instead
+     */
+    fromChat(): Peer | null;
+    /**
+     * For messages forwarded from channels,
+     * identifier of the original message in the channel
+     *
+     * (only availale if {@link fromChat} is not `null`)
+     */
+    get fromMessageId(): number | null;
+    /**
+     * For messages forwarded from channels,
+     * signature of the post author (if present)
+     */
+    get signature(): string | null;
+}

package/highlevel/types/messages/message-media.d.cts

@@ -0,0 +1,23 @@
+import { tl } from '@mtcute/tl';
+import { Audio } from '../media/audio.js';
+import { Document } from '../media/document.js';
+import { Sticker } from '../media/sticker.js';
+import { Video } from '../media/video.js';
+import { Voice } from '../media/voice.js';
+import { PeersIndex } from '../peers/peers-index.js';
+import { Contact } from '../media/contact.js';
+import { Dice } from '../media/dice.js';
+import { Game } from '../media/game.js';
+import { Invoice } from '../media/invoice.js';
+import { LiveLocation, Location } from '../media/location.js';
+import { PaidMedia } from '../media/paid-media.js';
+import { Photo } from '../media/photo.js';
+import { Poll } from '../media/poll.js';
+import { MediaStory } from '../media/story.js';
+import { Venue } from '../media/venue.js';
+import { WebPage } from '../media/web-page.js';
+/** A media inside of a {@link Message} */
+export type MessageMedia = Photo | Dice | Contact | Audio | Voice | Sticker | Document | Video | Location | LiveLocation | Game | WebPage | Venue | Poll | Invoice | MediaStory | PaidMedia | null;
+export type MessageMediaType = Exclude<MessageMedia, null>['type'];
+/** @internal */
+export declare function _messageMediaFromTl(peers: PeersIndex | null, m: tl.TypeMessageMedia): MessageMedia;

package/highlevel/types/messages/message-reactions.d.cts

@@ -0,0 +1,31 @@
+import { tl } from '@mtcute/tl';
+import { PeersIndex } from '../peers/index.js';
+import { PaidPeerReaction, PeerReaction } from '../reactions/peer-reaction.js';
+import { ReactionCount } from '../reactions/reaction-count.js';
+/**
+ * Reactions on a message
+ */
+export declare class MessageReactions {
+    readonly messageId: number;
+    readonly chatId: number;
+    readonly raw: tl.RawMessageReactions;
+    readonly _peers: PeersIndex;
+    constructor(messageId: number, chatId: number, raw: tl.RawMessageReactions, _peers: PeersIndex);
+    /**
+     * Whether you can use {@link getUsers}
+     * (or {@link TelegramClient.getReactionUsers})
+     * to get the users who reacted to this message
+     */
+    get usersVisible(): boolean;
+    /**
+     * Reactions on the message, along with their counts
+     */
+    get reactions(): ReactionCount[];
+    /**
+     * Recently reacted users.
+     * To get a full list of users, use {@link getUsers}
+     */
+    get recentReactions(): PeerReaction[];
+    /** Leaderboard of paid reactions to the message */
+    get paidReactions(): PaidPeerReaction[];
+}

package/highlevel/types/messages/message-replies.d.cts

@@ -0,0 +1,42 @@
+import { tl } from '@mtcute/tl';
+import { Peer } from '../peers/peer.js';
+import { PeersIndex } from '../peers/peers-index.js';
+/**
+ * Information about replies to a message
+ */
+export declare class MessageRepliesInfo {
+    readonly raw: tl.RawMessageReplies;
+    readonly _peers: PeersIndex;
+    constructor(raw: tl.RawMessageReplies, _peers: PeersIndex);
+    /**
+     * Whether this message is a channel post that has a comments thread
+     * in the linked discussion group
+     */
+    get hasComments(): boolean;
+    /**
+     * Total number of replies
+     */
+    get count(): number;
+    /**
+     * Whether this reply thread has unread messages
+     */
+    get hasUnread(): boolean;
+    /**
+     * ID of the last message in the thread (if any)
+     */
+    get lastMessageId(): number | null;
+    /**
+     * ID of the last read message in the thread (if any)
+     */
+    get lastReadMessageId(): number | null;
+    /**
+     * ID of the discussion group for the post
+     *
+     * `null` if the post is not a channel post
+     */
+    get discussion(): number | null;
+    /**
+     * Last few commenters to the post (usually 3)
+     */
+    get repliers(): Peer[];
+}