@mtkruto/node 0.1.132 → 0.1.134

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

@@ -0,0 +1,457 @@
+import { MaybePromise } from "../1_utilities.js";
+import { enums } from "../2_tl.js";
+import { Contact } from "./0_contact.js";
+import { Dice } from "./0_dice.js";
+import { ForceReply } from "./0_force_reply.js";
+import { Location } from "./0_location.js";
+import { MessageEntity } from "./0_message_entity.js";
+import { ReplyKeyboardRemove } from "./0_reply_keyboard_remove.js";
+import { Venue } from "./0_venue.js";
+import { Voice } from "./0_voice.js";
+import { EntityGetter } from "./1__getters.js";
+import { Animation } from "./1_animation.js";
+import { Audio } from "./1_audio.js";
+import { ChatP } from "./1_chat_p.js";
+import { Document } from "./1_document.js";
+import { Giveaway } from "./1_giveaway.js";
+import { MessageReaction } from "./1_message_reaction.js";
+import { Photo } from "./1_photo.js";
+import { Poll } from "./1_poll.js";
+import { ReplyQuote } from "./1_reply_quote.js";
+import { Sticker, StickerSetNameGetter } from "./1_sticker.js";
+import { User } from "./1_user.js";
+import { VideoNote } from "./1_video_note.js";
+import { Video } from "./1_video.js";
+import { Game } from "./2_game.js";
+import { ReplyKeyboardMarkup } from "./2_reply_keyboard_markup.js";
+import { InlineKeyboardMarkup } from "./3_inline_keyboard_markup.js";
+/**
+ * Properties shared between all message types.
+ * @unlisted
+ */
+export interface MessageBase {
+    /** Whether the message is outgoing (sent by the current user). */
+    out: boolean;
+    /** The identifier of the message. */
+    id: number;
+    /** The identifier of the message's thread. */
+    threadId?: number;
+    /** The user who sent the message. */
+    from?: User;
+    /** The chat which the message was sent on behalf of. */
+    senderChat?: ChatP;
+    /** The point of time in which the message was sent. */
+    date: Date;
+    /** The chat where the message was sent to. */
+    chat: ChatP;
+    /** A link to the message. */
+    link?: string;
+    /** The original sender of the message. */
+    forwardFrom?: User;
+    /** The original chat of the message. */
+    forwardFromChat?: ChatP;
+    /** The original identifier of the message. */
+    forwardId?: number;
+    /** The original signature of the message. */
+    forwardSignature?: string;
+    /** The name of the original sender of the message. */
+    forwardSenderName?: string;
+    /** The point of time in which the original message was sent. */
+    forwardDate?: Date;
+    /** 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 of time in which the message's last edit was made. */
+    editDate?: Date;
+    /** 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 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?: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply;
+}
+/**
+ * Properties shared between media message types.
+ * @unlisted
+ */
+export interface MessageMediaBase extends MessageBase {
+    caption?: string;
+    captionEntities?: MessageEntity[];
+    hasMediaSpoiler?: boolean;
+}
+/**
+ * A text message.
+ * @unlisted
+ */
+export interface MessageText extends MessageBase {
+    /** The text included in the message. */
+    text: string;
+    /** Entities of the text. */
+    entities: MessageEntity[];
+}
+/** @unlisted */
+export interface MessagePhoto extends MessageMediaBase {
+    /** The photo included in the message. */
+    photo: Photo;
+}
+/**
+ * A document message.
+ * @unlisted
+ */
+export interface MessageDocument extends MessageMediaBase {
+    /** The document included in the message. */
+    document: Document;
+}
+/**
+ * A video message.
+ * @unlisted
+ */
+export interface MessageVideo extends MessageMediaBase {
+    /** The video included in the message. */
+    video: Video;
+}
+/**
+ * A sticker message.
+ * @unlisted
+ */
+export interface MessageSticker extends MessageBase {
+    /** The sticker included in the message. */
+    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. */
+    animation: Animation;
+}
+/**
+ * A voice message.
+ * @unlisted
+ */
+export interface MessageVoice extends MessageMediaBase {
+    /** The voice included in the message. */
+    voice: Voice;
+}
+/**
+ * An audio message.
+ * @unlisted
+ */
+export interface MessageAudio extends MessageMediaBase {
+    /** The audio included in the message. */
+    audio: Audio;
+}
+/**
+ * A dice message.
+ * @unlisted
+ */
+export interface MessageDice extends MessageBase {
+    /** The dice included in the message.  */
+    dice: Dice;
+}
+/**
+ * A video note message.
+ * @unlisted
+ */
+export interface MessageVideoNote extends MessageBase {
+    /** The video note included in the message. */
+    videoNote: VideoNote;
+}
+/**
+ * A contact message.
+ * @unlisted
+ */
+export interface MessageContact extends MessageBase {
+    /** The contact included in the message. */
+    contact: Contact;
+}
+/**
+ * A game message.
+ * @unlisted
+ */
+export interface MessageGame extends MessageBase {
+    /** The game included in the message. */
+    game: Game;
+}
+/**
+ * A poll message.
+ * @unlisted
+ */
+export interface MessagePoll extends MessageBase {
+    /** The poll included in the message. */
+    poll: Poll;
+}
+/**
+ * A venue message.
+ * @unlisted
+ */
+export interface MessageVenue extends MessageBase {
+    /** The venue included in the message. */
+    venue: Venue;
+}
+/**
+ * A location message.
+ * @unlisted
+ */
+export interface MessageLocation extends MessageBase {
+    /** The location included in the message. */
+    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. */
+    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. */
+    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. */
+    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. */
+    newChatPhoto: Photo;
+}
+/**
+ * A message that is received when a chat's photo is removed.
+ * @unlisted
+ */
+export interface MessageDeletedChatPhoto extends MessageBase {
+    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 {
+    groupCreated: true;
+    /** The initial members of the group. */
+    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 {
+    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 {
+    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. */
+    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. */
+    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. */
+    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. */
+    pinnedMessage: Message;
+}
+/**
+ * A message that is received when a bot account receives a shared user.
+ * @unlisted
+ */
+export interface MessageUserShared extends MessageBase {
+    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 {
+    writeAccessAllowed: {
+        webAppName?: string;
+    };
+}
+/**
+ * A message that is received when a new topic is created in a forum.
+ * @unlisted
+ */
+export interface MessageForumTopicCreated extends MessageBase {
+    forumTopicCreated: {
+        name: string;
+        iconColor: string;
+        iconCutsomEmojiId?: string;
+    };
+}
+/**
+ * A message that is received when a topic is edited in a forum.
+ * @unlisted
+ */
+export interface MessageForumTopicEdited extends MessageBase {
+    forumTopicEdited: {
+        name: string;
+        iconCutsomEmojiId?: string;
+    };
+}
+/**
+ * A message that is received when a topic is closed in a forum.
+ * @unlisted
+ */
+export interface MessageForumTopicClosed extends MessageBase {
+    forumTopicClosed: true;
+}
+/**
+ * A message that is received when a topic is reopened in a forum.
+ * @unlisted
+ */
+export interface MessageForumTopicReopened extends MessageBase {
+    forumTopicReopened: true;
+}
+/**
+ * A message that is received when a video chat is scheduled in a chat.
+ * @unlisted
+ */
+export interface MessageVideoChatScheduled extends MessageBase {
+    videoChatScheduled: {
+        startDate: Date;
+    };
+}
+/**
+ * A message that is received when a video chat is started in a chat.
+ * @unlisted
+ */
+export interface MessageVideoChatStarted extends MessageBase {
+    videoChatStarted: true;
+}
+/**
+ * A message that is received when a video chat is ended in a chat.
+ * @unlisted
+ */
+export interface MessageVideoChatEnded extends MessageBase {
+    videoChatEnded: {
+        duration: number;
+    };
+}
+/**
+ * A message that is received when a giveaway is started in a chat.
+ * @unlisted
+ */
+export interface MessageGiveaway extends MessageBase {
+    giveaway: Giveaway;
+}
+/**
+ * An unsupported message.
+ * @unlisted
+ */
+export interface MessageUnsupported extends MessageBase {
+    unsupported: true;
+}
+/** @unlisted */
+export interface MessageTypes {
+    text: MessageText;
+    photo: MessagePhoto;
+    document: MessageDocument;
+    video: MessageVideo;
+    sticker: MessageSticker;
+    animation: MessageAnimation;
+    voice: MessageVoice;
+    audio: MessageAudio;
+    dice: MessageDice;
+    videoNote: MessageVideoNote;
+    contact: MessageContact;
+    game: MessageGame;
+    poll: MessagePoll;
+    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;
+}
+export declare function assertMessageType<T extends keyof MessageTypes>(message: Message, type: T): MessageTypes[T];
+export type Message = MessageText | MessagePhoto | MessageDocument | MessageVideo | MessageSticker | MessageAnimation | MessageVoice | MessageAudio | MessageDice | MessageVideoNote | MessageContact | MessageGame | MessagePoll | 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;
+/** @unlisted */
+export interface MessageGetter {
+    (chatId: number, messageId: number): MaybePromise<Message | null>;
+}
+type Message_MessageGetter = MessageGetter | null;
+export declare function constructMessage(message_: enums.Message, getEntity: EntityGetter, getMessage: Message_MessageGetter, getStickerSetName: StickerSetNameGetter, getReply_?: boolean): Promise<Message>;
+export {};