@mtkruto/browser 0.6.1 → 0.119.1

package/esm/types/6_message.d.ts

@@ -0,0 +1,704 @@
+/**
+ * MTKruto - Cross-runtime JavaScript library for building Telegram clients
+ * Copyright (C) 2023-2026 Roj <https://roj.im/>
+ *
+ * This file is part of MTKruto.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+import { type MaybePromise } from "../1_utilities.js";
+import { Api } from "../2_tl.js";
+import { type ChecklistChanged } from "./0_checklist_changed.js";
+import { type Contact } from "./0_contact.js";
+import { type Dice } from "./0_dice.js";
+import { type Invoice } from "./0_invoice.js";
+import { type Location } from "./0_location.js";
+import { type RefundedPayment } from "./0_refunded_payment.js";
+import { type SelfDestructOption } from "./0_self_destruct_option.js";
+import { type Voice } from "./0_voice.js";
+import { type Animation } from "./1_animation.js";
+import { type Audio } from "./1_audio.js";
+import { type ChatP, type PeerGetter } from "./1_chat_p.js";
+import { type Document } from "./1_document.js";
+import { type Giveaway } from "./1_giveaway.js";
+import { type MessageReaction } from "./1_message_reaction.js";
+import { type Photo } from "./1_photo.js";
+import { type Sticker, type StickerSetNameGetter } from "./1_sticker.js";
+import { type Venue } from "./1_venue.js";
+import { type VideoNote } from "./1_video_note.js";
+import { type Video } from "./1_video.js";
+import { type MessageEntity } from "./2_message_entity.js";
+import { type ReplyMarkup } from "./2_reply_markup.js";
+import { type SuccessfulPayment } from "./2_successful_payment.js";
+import { type User } from "./2_user.js";
+import { type ChecklistItem } from "./3_checklist_item.js";
+import { type ForwardHeader } from "./3_forward_header.js";
+import { type Game } from "./3_game.js";
+import { type ReplyQuote } from "./3_reply_quote.js";
+import { type Checklist } from "./4_checklist.js";
+import { type Poll } from "./4_poll.js";
+import { type GiftNonUpgradedInformation } from "./5_gift_non_upgraded_information.js";
+import { type GiftUpgradedInformation } from "./5_gift_upgraded_information.js";
+import { type LinkPreview } from "./5_link_preview.js";
+/**
+ * Properties shared between all message types.
+ * @unlisted
+ */
+export interface _MessageBase {
+    /** Whether the message is outgoing (sent by the current user). */
+    isOutgoing: boolean;
+    /** The identifier of the message. */
+    id: number;
+    /** The identifier of the message's thread. */
+    threadId?: number;
+    /** The sender of the message. */
+    from: ChatP;
+    /** The point in time in which the message was sent. */
+    date: number;
+    /** The chat where the message was sent to. */
+    chat: ChatP;
+    /** A link to the message. */
+    link?: string;
+    /** Information on the original message. */
+    forwardFrom?: ForwardHeader;
+    /** Whether the message was sent in a topic thread. */
+    isTopicMessage: boolean;
+    /** Whether the message is an automatic forward. */
+    isAutomaticForward?: boolean;
+    /** The message that is being replied to. Not always available even if a message is being replied to. */
+    replyToMessage?: Message;
+    /** The identifier of the message that is being replied to. */
+    replyToMessageId?: number;
+    /** The reactions of the message. */
+    reactions?: MessageReaction[];
+    /** The part of the message that is being replied to. */
+    replyQuote?: ReplyQuote;
+    /** The inline bot that was used to send this message. */
+    viaBot?: User;
+    /** The point in time in which the message's last edit was made. */
+    editDate?: number;
+    /** Whether the contents of the message is protected. */
+    hasProtectedContent?: boolean;
+    /** The identifier of the message's media group. */
+    mediaGroupId?: string;
+    /** The signature of the message. */
+    authorSignature?: string;
+    /** The member tag of the sender of the message. */
+    tag?: string;
+    /** The number of times the message was viewed. */
+    views?: number;
+    /** The number of times the message was forwarded. */
+    forwards?: number;
+    /** The message's reply markup. */
+    replyMarkup?: ReplyMarkup;
+    /** The identifier of a business conection that the message was sent in. */
+    businessConnectionId?: string;
+    /** The number of the boosts made by the sender of the message. */
+    senderBoostCount?: number;
+    /** The identifier of the business connection in which the message was sent. */
+    viaBusinessBot?: User;
+    /** The identifier of the message effect that has been attached to the message. */
+    effectId?: string;
+    /** Whether the message is scheduled. */
+    isScheduled?: boolean;
+    /** The message's self-destruct preference. */
+    selfDestruct?: SelfDestructOption;
+}
+/**
+ * Properties shared between media message types.
+ * @unlisted
+ */
+export interface _MessageMediaBase extends _MessageBase {
+    /** The media's caption. */
+    caption?: string;
+    /** The entities of the media's caption. */
+    captionEntities?: MessageEntity[];
+    /** Whether the media is a spoiler. */
+    isSpoiler?: boolean;
+}
+/**
+ * A text message.
+ * @unlisted
+ */
+export interface MessageText extends _MessageBase {
+    /**
+     * The text included in the message.
+     * @discriminator
+     */
+    text: string;
+    /**
+     * The text's entities.
+     * @discriminator
+     */
+    entities: MessageEntity[];
+    /** The message's link preview. */
+    linkPreview?: LinkPreview;
+}
+/**
+ * A message with a link preview only.
+ * @unlisted
+ */
+export interface MessageLink extends _MessageBase {
+    /** @discriminator */
+    linkPreview: LinkPreview & {
+        url: NonNullable<LinkPreview["url"]>;
+    };
+}
+/** @unlisted */
+export interface MessagePhoto extends _MessageMediaBase {
+    /** The photo included in the message.
+     * @discriminator
+     */
+    photo: Photo;
+}
+/**
+ * A document message.
+ * @unlisted
+ */
+export interface MessageDocument extends _MessageMediaBase {
+    /**
+     * The document included in the message.
+     * @discriminator
+     */
+    document: Document;
+}
+/**
+ * A video message.
+ * @unlisted
+ */
+export interface MessageVideo extends _MessageMediaBase {
+    /**
+     * The video included in the message.
+     * @discriminator
+     */
+    video: Video;
+}
+/**
+ * A sticker message.
+ * @unlisted
+ */
+export interface MessageSticker extends _MessageBase {
+    /**
+     * The sticker included in the message.
+     * @discriminator
+     */
+    sticker: Sticker;
+}
+/**
+ * An animation message. Animations are GIFs or H.264/MPEG-4 AVC videos without sound.
+ * @unlisted
+ */
+export interface MessageAnimation extends _MessageMediaBase {
+    /**
+     * The animation included in the message.
+     * @discriminator
+     */
+    animation: Animation;
+}
+/**
+ * A voice message.
+ * @unlisted
+ */
+export interface MessageVoice extends _MessageMediaBase {
+    /**
+     * The voice included in the message.
+     * @discriminator
+     */
+    voice: Voice;
+}
+/**
+ * An audio message.
+ * @unlisted
+ */
+export interface MessageAudio extends _MessageMediaBase {
+    /**
+     * The audio included in the message.
+     * @discriminator
+     */
+    audio: Audio;
+}
+/**
+ * A dice message.
+ * @unlisted
+ */
+export interface MessageDice extends _MessageBase {
+    /**
+     * The dice included in the message.
+     * @discriminator
+     */
+    dice: Dice;
+}
+/**
+ * A video note message.
+ * @unlisted
+ */
+export interface MessageVideoNote extends _MessageBase {
+    /**
+     * The video note included in the message.
+     * @discriminator
+     */
+    videoNote: VideoNote;
+}
+/**
+ * A contact message.
+ * @unlisted
+ */
+export interface MessageContact extends _MessageBase {
+    /**
+     * The contact included in the message.
+     * @discriminator
+     */
+    contact: Contact;
+}
+/**
+ * A game message.
+ * @unlisted
+ */
+export interface MessageGame extends _MessageBase {
+    /**
+     * The game included in the message.
+     * @discriminator
+     */
+    game: Game;
+}
+/**
+ * A poll message.
+ * @unlisted
+ */
+export interface MessagePoll extends _MessageBase {
+    /**
+     * The poll included in the message.
+     * @discriminator
+     */
+    poll: Poll;
+}
+/**
+ * A checklist message.
+ * @unlisted
+ */
+export interface MessageChecklist extends _MessageBase {
+    /**
+     * The checklist included in the message.
+     * @discriminator
+     */
+    checklist: Checklist;
+}
+/**
+ * An invoice message.
+ * @unlisted
+ */
+export interface MessageInvoice extends _MessageBase {
+    /**
+     * The invoice included in the message.
+     * @discriminator
+     */
+    invoice: Invoice;
+}
+/**
+ * A venue message.
+ * @unlisted
+ */
+export interface MessageVenue extends _MessageBase {
+    /**
+     * The venue included in the message.
+     * @discriminator
+     */
+    venue: Venue;
+}
+/**
+ * A location message.
+ * @unlisted
+ */
+export interface MessageLocation extends _MessageBase {
+    /**
+     * The location included in the message.
+     * @discriminator
+     */
+    location: Location;
+}
+/**
+ * A message that is received when new members join a chat.
+ * @unlisted
+ */
+export interface MessageNewChatMembers extends _MessageBase {
+    /**
+     * The new members of the chat.
+     * @discriminator
+     */
+    newChatMembers: User[];
+}
+/**
+ * A message that is received when a member leaves a chat.
+ * @unlisted
+ */
+export interface MessageLeftChatMember extends _MessageBase {
+    /**
+     * The member who left the chat.
+     * @discriminator
+     */
+    leftChatMember: User;
+}
+/**
+ * A message that is received when a chat's title is changed.
+ * @unlisted
+ */
+export interface MessageNewChatTitle extends _MessageBase {
+    /**
+     * The new title of the chat.
+     * @discriminator
+     */
+    newChatTitle: string;
+}
+/**
+ * A message that is received when a chat's photo is changed.
+ * @unlisted
+ */
+export interface MessageNewChatPhoto extends _MessageBase {
+    /**
+     * The new photo of the chat
+     * @discriminator
+     */
+    newChatPhoto: Photo;
+}
+/**
+ * A message that is received when a chat's photo is removed.
+ * @unlisted
+ */
+export interface MessageDeletedChatPhoto extends _MessageBase {
+    /** @discriminator */
+    deletedChatPhoto: true;
+}
+/**
+ * A message that is received by user accounts when a group is created.
+ * While bots don't receive them, they are able to see them if someone replies to them.
+ * @unlisted
+ */
+export interface MessageGroupCreated extends _MessageBase {
+    /** @discriminator */
+    groupCreated: true;
+    /**
+     * The initial members of the group.
+     * @discriminator
+     */
+    newChatMembers: User[];
+}
+/**
+ * A message that is received by user accounts when a supergroup is created.
+ * While bots don't receive them, they are able to see them if someone replies to them.
+ * @unlisted
+ */
+export interface MessageSupergroupCreated extends _MessageBase {
+    /** @discriminator */
+    supergroupCreated: true;
+}
+/**
+ * A message that is received by user accounts when a channel is created.
+ * While bots don't receive them, they are able to see them if someone replies to them.
+ * @unlisted
+ */
+export interface MessageChannelCreated extends _MessageBase {
+    /** @discriminator */
+    channelCreated: true;
+}
+/**
+ * A message that is received when a chat's auto-delete timer is changed.
+ * @unlisted
+ */
+export interface MessageAutoDeleteTimerChanged extends _MessageBase {
+    /**
+     * The new auto-delete time in seconds.
+     * @discriminator
+     */
+    newAutoDeleteTime: number;
+}
+/**
+ * A message that is received when a supergroup is created as a result of a group migration.
+ * @unlisted
+ */
+export interface MessageChatMigratedTo extends _MessageBase {
+    /**
+     * The supergroup's ID.
+     * @discriminator
+     */
+    chatMigratedTo: number;
+}
+/**
+ * A message that is received when a group is migrated to a supergroup.
+ * @unlisted
+ */
+export interface MessageChatMigratedFrom extends _MessageBase {
+    /**
+     * The group's ID.
+     * @discriminator
+     */
+    chatMigratedFrom: number;
+}
+/**
+ * A message that is received when a message is pinned in a chat.
+ * @unlisted
+ */
+export interface MessagePinnedMessage extends _MessageBase {
+    /**
+     * The message that was pinned.
+     * @discriminator
+     */
+    pinnedMessage: Message;
+}
+/**
+ * A message that is received when a bot account receives a shared user.
+ * @unlisted
+ */
+export interface MessageUserShared extends _MessageBase {
+    /** @discriminator */
+    userShared: {
+        requestId: number;
+        userId: number;
+    };
+}
+/**
+ * A message that is received when a bot is allowed to message a user.
+ * @unlisted
+ */
+export interface MessageWriteAccessAllowed extends _MessageBase {
+    /** @discriminator */
+    writeAccessAllowed: {
+        miniAppName?: string;
+    };
+}
+/**
+ * A message that is received when a new topic is created in a forum.
+ * @unlisted
+ */
+export interface MessageForumTopicCreated extends _MessageBase {
+    /**
+     * Information on the created forum topic.
+     * @discriminator
+     */
+    forumTopicCreated: {
+        name: string;
+        color: number;
+        customEmojiId?: string;
+    };
+}
+/**
+ * A message that is received when a topic is edited in a forum.
+ * @unlisted
+ */
+export interface MessageForumTopicEdited extends _MessageBase {
+    /** @discriminator */
+    forumTopicEdited: {
+        name: string;
+        customEmojiId?: string;
+    };
+}
+/**
+ * A message that is received when a topic is closed in a forum.
+ * @unlisted
+ */
+export interface MessageForumTopicClosed extends _MessageBase {
+    /** @discriminator */
+    forumTopicClosed: true;
+}
+/**
+ * A message that is received when a topic is reopened in a forum.
+ * @unlisted
+ */
+export interface MessageForumTopicReopened extends _MessageBase {
+    /** @discriminator */
+    forumTopicReopened: true;
+}
+/**
+ * A message that is received when a video chat is scheduled in a chat.
+ * @unlisted
+ */
+export interface MessageVideoChatScheduled extends _MessageBase {
+    /**
+     * Information on the scheduled video chat.
+     * @discriminator
+     */
+    videoChatScheduled: {
+        startDate: number;
+    };
+}
+/**
+ * A message that is received when a video chat is started in a chat.
+ * @unlisted
+ */
+export interface MessageVideoChatStarted extends _MessageBase {
+    /** @discriminator */
+    videoChatStarted: true;
+}
+/**
+ * A message that is received when a video chat is ended in a chat.
+ * @unlisted
+ */
+export interface MessageVideoChatEnded extends _MessageBase {
+    /**
+     * Information on the ended video chat.
+     * @discriminator
+     */
+    videoChatEnded: {
+        duration: number;
+    };
+}
+/**
+ * A message that is received when a giveaway is started in a chat.
+ * @unlisted
+ */
+export interface MessageGiveaway extends _MessageBase {
+    /**
+     * Information on the giveaway.
+     * @discriminator
+     */
+    giveaway: Giveaway;
+}
+/**
+ * An unsupported message.
+ * @unlisted
+ */
+export interface MessageUnsupported extends _MessageBase {
+    /** @discriminator */
+    unsupported: true;
+}
+/**
+ * A payment was successfully received. Bot-only.
+ * @unlisted
+ */
+export interface MessageSuccessfulPayment extends _MessageBase {
+    /**
+     * Information on the successful payment.
+     * @discriminator
+     */
+    successfulPayment: SuccessfulPayment;
+}
+/**
+ * A payment was successfully refunded. Bot-only.
+ * @unlisted
+ */
+export interface MessageRefundedPayment extends _MessageBase {
+    /**
+     * Information on the refunded payment.
+     * @discriminator
+     */
+    refundedPayment: RefundedPayment;
+}
+/**
+ * A checklist was changed.
+ * @unlisted
+ */
+export interface MessageChecklistChanged extends _MessageBase {
+    /**
+     * The checklist's changes.
+     * @discriminator
+     */
+    checklistChanged: ChecklistChanged;
+}
+/**
+ * A checklist was extended.
+ * @unlisted
+ */
+export interface MessageChecklistExtended extends _MessageBase {
+    /**
+     * The checklist's new items.
+     * @discriminator
+     */
+    checklistExtended: ChecklistItem[];
+}
+/**
+ * An action related to a non-upgraded gift.
+ * @unlisted
+ */
+export interface MessageGiftNonUpgraded extends _MessageBase {
+    /**
+     * Information on the non-upgraded gift.
+     * @discriminator
+     */
+    giftNonUpgraded: GiftNonUpgradedInformation;
+}
+/**
+ * An action related an upgraded gift.
+ * @unlisted
+ */
+export interface MessageGiftUpgraded extends _MessageBase {
+    /**
+     * Information on the upgraded gift.
+     * @discriminator
+     */
+    giftUpgraded: GiftUpgradedInformation;
+}
+/** @unlisted */
+export interface MessageTypes {
+    text: MessageText;
+    link: MessageLink;
+    photo: MessagePhoto;
+    document: MessageDocument;
+    video: MessageVideo;
+    sticker: MessageSticker;
+    animation: MessageAnimation;
+    voice: MessageVoice;
+    audio: MessageAudio;
+    dice: MessageDice;
+    videoNote: MessageVideoNote;
+    contact: MessageContact;
+    game: MessageGame;
+    poll: MessagePoll;
+    checklist: MessageChecklist;
+    invoice: MessageInvoice;
+    venue: MessageVenue;
+    location: MessageLocation;
+    newChatMembers: MessageNewChatMembers;
+    leftChatMember: MessageLeftChatMember;
+    newChatTitle: MessageNewChatTitle;
+    newChatPhoto: MessageNewChatPhoto;
+    deletedChatPhoto: MessageDeletedChatPhoto;
+    groupCreated: MessageGroupCreated;
+    supergroupCreated: MessageSupergroupCreated;
+    channelCreated: MessageChannelCreated;
+    newAutoDeleteTime: MessageAutoDeleteTimerChanged;
+    chatMigratedTo: MessageChatMigratedTo;
+    chatMigratedFrom: MessageChatMigratedFrom;
+    pinnedMessage: MessagePinnedMessage;
+    userShared: MessageUserShared;
+    writeAccessAllowed: MessageWriteAccessAllowed;
+    forumTopicCreated: MessageForumTopicCreated;
+    forumTopicEdited: MessageForumTopicEdited;
+    forumTopicClosed: MessageForumTopicClosed;
+    forumTopicReopened: MessageForumTopicReopened;
+    videoChatScheduled: MessageVideoChatScheduled;
+    videoChatStarted: MessageVideoChatStarted;
+    videoChatEnded: MessageVideoChatEnded;
+    giveaway: MessageGiveaway;
+    unsupported: MessageUnsupported;
+    successfulPayment: MessageSuccessfulPayment;
+    refundedPayment: MessageRefundedPayment;
+    checklistChanged: MessageChecklistChanged;
+    checklistExtended: MessageChecklistExtended;
+    giftNonUpgraded: MessageGiftNonUpgraded;
+    giftUpgraded: MessageGiftUpgraded;
+}
+export declare function isMessageType<T extends keyof MessageTypes>(message: Message, type: T): message is MessageTypes[T];
+export declare function assertMessageType<T extends keyof MessageTypes>(message: Message, type: T): MessageTypes[T];
+/** Any type of message. */
+export type Message = MessageText | MessageLink | MessagePhoto | MessageDocument | MessageVideo | MessageSticker | MessageAnimation | MessageVoice | MessageAudio | MessageDice | MessageVideoNote | MessageContact | MessageGame | MessagePoll | MessageChecklist | MessageInvoice | MessageVenue | MessageLocation | MessageNewChatMembers | MessageLeftChatMember | MessageNewChatTitle | MessageNewChatPhoto | MessageDeletedChatPhoto | MessageGroupCreated | MessageSupergroupCreated | MessageChannelCreated | MessageAutoDeleteTimerChanged | MessageChatMigratedTo | MessageChatMigratedFrom | MessagePinnedMessage | MessageUserShared | MessageWriteAccessAllowed | MessageForumTopicCreated | MessageForumTopicEdited | MessageForumTopicClosed | MessageForumTopicReopened | MessageVideoChatScheduled | MessageVideoChatStarted | MessageVideoChatEnded | MessageGiveaway | MessageUnsupported | MessageSuccessfulPayment | MessageRefundedPayment | MessageChecklistChanged | MessageChecklistExtended | MessageGiftNonUpgraded | MessageGiftUpgraded;
+/** @unlisted */
+export interface MessageGetter {
+    (chatId: number, messageId: number): MaybePromise<Message | null>;
+}
+type Message_MessageGetter = MessageGetter | null;
+export declare function constructMessage(message_: Api.Message, getPeer: PeerGetter, getMessage: Message_MessageGetter, getStickerSetName: StickerSetNameGetter, getReply_?: boolean, business?: {
+    connectionId: string;
+    replyToMessage?: Api.Message;
+}, poll?: Api.poll, pollResults?: Api.pollResults): Promise<Message>;
+export {};
+//# sourceMappingURL=6_message.d.ts.map