@mtcute/core 0.18.0-rc.5 → 0.18.0

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

@@ -0,0 +1,249 @@
+import { tl } from '@mtcute/tl';
+import { ReplyMarkup } from '../bots/keyboards/index.js';
+import { TextWithEntities } from '../misc/index.js';
+import { Peer } from '../peers/peer.js';
+import { PeersIndex } from '../peers/peers-index.js';
+import { MessageAction } from './message-action.js';
+import { MessageMedia } from './message-media.js';
+import { User } from '../peers/user.js';
+import { FactCheck } from './fact-check.js';
+import { MessageEntity } from './message-entity.js';
+import { MessageForwardInfo } from './message-forward.js';
+import { MessageReactions } from './message-reactions.js';
+import { MessageRepliesInfo } from './message-replies.js';
+import { RepliedMessageInfo } from './replied-message.js';
+/**
+ * A Telegram message.
+ */
+export declare class Message {
+    readonly _peers: PeersIndex;
+    /**
+     * Whether the message is scheduled.
+     * If it is, then its {@link date} is set to future.
+     */
+    readonly isScheduled: boolean;
+    /**
+     * Raw TL object.
+     */
+    readonly raw: tl.RawMessage | tl.RawMessageService;
+    constructor(raw: tl.TypeMessage, _peers: PeersIndex, 
+    /**
+     * Whether the message is scheduled.
+     * If it is, then its {@link date} is set to future.
+     */
+    isScheduled?: boolean);
+    /** Unique message identifier inside this chat */
+    get id(): number;
+    /**
+     * For channel posts, number of views
+     *
+     * `null` for service messages and non-post messages.
+     */
+    get views(): number | null;
+    /**
+     * For channel posts, number of forwards
+     *
+     * `null` for service messages and non-post messages, or
+     * if the current user is not an admin in the channel
+     */
+    get forwards(): number | null;
+    /**
+     * For channel posts with signatures enabled, name of the post author
+     */
+    get signature(): string | null;
+    /**
+     * Whether the message is incoming or outgoing:
+     *  - Messages received from other chats are incoming (`outgoing = false`)
+     *  - Messages sent by you to other chats are outgoing (`outgoing = true`)
+     *  - Messages to yourself (i.e. *Saved Messages*) are incoming (`outgoing = false`)
+     */
+    get isOutgoing(): boolean;
+    /**
+     * Whether this message is a service message
+     */
+    get isService(): boolean;
+    /** Whether this message has content protection (i.e. disabled forwards) */
+    get isContentProtected(): boolean;
+    /**
+     * Whether the message was sent by an implicit action, for example,
+     * as an away or a greeting business message, or as a scheduled message
+     */
+    get isFromOffline(): boolean;
+    /** Whether this is a silent message (no notification triggered) */
+    get isSilent(): boolean;
+    /** Whether there are unread media attachments in this message */
+    get hasUnreadMedia(): boolean;
+    /** Whether this is a broadcast channel post */
+    get isChannelPost(): boolean;
+    /**
+     * Whether this message was automatically sent from a scheduled message.
+     *
+     * **Note**: for messages sent by other users, this is always `false`.
+     */
+    get isFromScheduled(): boolean;
+    /** Whether the message is pinned in the current chat */
+    get isPinned(): boolean;
+    /** Whether the message should be considered unedited, even if {@link editDate} ≠ null */
+    get hideEditMark(): boolean;
+    /**
+     * If set, any eventual webpage preview should be shown on top of
+     * the message instead of at the bottom.
+     */
+    get invertMedia(): boolean;
+    /**
+     * Multiple media messages with the same grouped ID
+     * indicate an album or media group
+     *
+     * `null` for service messages and non-grouped messages
+     */
+    get groupedId(): tl.Long | null;
+    /**
+     * Same as {@link groupedId}, but is globally unique across chats.
+     */
+    get groupedIdUnique(): string | null;
+    /**
+     * Message sender.
+     *
+     * Usually is a {@link User}, but can be a {@link Peer}
+     * in case the message was sent by an anonymous admin, anonymous premium user,
+     * or if the message is a forwarded channel post.
+     *
+     * If the message was sent by an anonymous admin,
+     * sender will equal to {@link chat}.
+     *
+     * If the message is a forwarded channel post,
+     * sender is the channel itself.
+     */
+    get sender(): Peer;
+    /**
+     * Number of boosts applied to this {@link chat} by the sender
+     */
+    get senderBoostCount(): number;
+    /**
+     * Conversation the message belongs to
+     */
+    get chat(): Peer;
+    /**
+     * Date when the message was sent
+     */
+    get date(): Date;
+    /**
+     * Date when the message was last edited
+     */
+    get editDate(): Date | null;
+    /**
+     * If this message is a forward, contains info about it.
+     */
+    get forward(): MessageForwardInfo | null;
+    /**
+     * Whether the message is a channel post that was
+     * automatically forwarded to the connected discussion group
+     */
+    get isAutomaticForward(): boolean;
+    /**
+     * Information about comments (for channels) or replies (for groups)
+     */
+    get replies(): MessageRepliesInfo | null;
+    /**
+     * For replies, information about the that is being replied to.
+     *
+     * Mutually exclusive with {@link replyToStory}
+     */
+    get replyToMessage(): RepliedMessageInfo | null;
+    /**
+     * For replies, information about the story that is being replied to
+     *
+     * Mutually exclusive with {@link replyToMessage}
+     */
+    get replyToStory(): tl.RawMessageReplyStoryHeader | null;
+    /** Whether this message is in a forum topic */
+    get isTopicMessage(): boolean;
+    /**
+     * Whether this message contains mention of the current user
+     */
+    get isMention(): boolean;
+    /**
+     * If non-null, this message is not actually sent, and is
+     * instead inside a group of "quick reply" messages
+     * under the given shortcut ID
+     */
+    get quickReplyShortcutId(): number | null;
+    /**
+     * If this message is generated from an inline query,
+     * information about the bot which generated it
+     */
+    get viaBot(): User | null;
+    /**
+     * If this message was sent by a business bot on behalf of {@link sender},
+     * information about the business bot.
+     *
+     * **Note**: only available to the business account and the bot itself.
+     */
+    get viaBusinessBot(): User | null;
+    /**
+     * Message text or media caption.
+     *
+     * Empty string for service messages
+     * (you should handle i18n yourself)
+     */
+    get text(): string;
+    /**
+     * Message text/caption entities (may be empty)
+     */
+    get entities(): ReadonlyArray<MessageEntity>;
+    get textWithEntities(): TextWithEntities;
+    /**
+     * Message action. `null` for non-service messages
+     * or for unsupported events.
+     *
+     * For unsupported events, use `.raw.action` directly.
+     */
+    get action(): MessageAction | null;
+    /**
+     * Message media. `null` for text-only and service messages
+     * and for unsupported media types.
+     *
+     * For unsupported media types, use `.raw.media` directly.
+     */
+    get media(): MessageMedia;
+    /**
+     * Whether this is a premium media
+     * (e.g. >2gb file or fullscreen sticker)
+     * that was forwarded without author by a non-premium user
+     */
+    get isForwardedPremiumMedia(): boolean;
+    /**
+     * TTL period of the message, in seconds.
+     */
+    get ttlPeriod(): number | null;
+    /**
+     * Reply markup provided with this message, if any.
+     */
+    get markup(): ReplyMarkup | null;
+    /**
+     * Whether this message can be forwarded
+     *
+     * `false` for service mesasges and private restricted chats/chanenls
+     */
+    get canBeForwarded(): boolean;
+    /**
+     * Reactions added to this message, if any
+     */
+    get reactions(): MessageReactions | null;
+    /**
+     * Information about fact-check added to the message, if any
+     */
+    get factCheck(): FactCheck | null;
+    /**
+     * If this message was sent with a message effect, ID of the effect
+     */
+    get effectId(): tl.Long | null;
+    /** Whether this message has a video that is still being processed */
+    get videoProcessingPending(): boolean;
+    /**
+     * Generated permalink to this message, only for groups and channels
+     *
+     * @throws MtArgumentError  In case the chat does not support message links
+     */
+    get link(): string;
+}

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

@@ -0,0 +1,103 @@
+import { tl } from '@mtcute/tl';
+import { PeersIndex } from '../peers/peers-index.js';
+import { MessageMedia } from './message-media.js';
+import { Chat } from '../peers/chat.js';
+import { Peer, PeerSender } from '../peers/peer.js';
+import { MessageEntity } from './message-entity.js';
+/**
+ * Origin of the replied-to message
+ *  - `same_chat` — reply to a message in the same chat as this message
+ *  - `other_chat` — reply to a message in a different chat
+ *  - `private` — reply to a message in a private chat
+ */
+export type RepliedMessageOrigin = 'same_chat' | 'other_chat' | 'private';
+/** @hidden */
+export interface _RepliedMessageAssertionsByOrigin {
+    same_chat: {
+        id: number;
+        chat: null;
+        media: null;
+        sender: null;
+    };
+    other_chat: {
+        id: number;
+        chat: Chat;
+        sender: PeerSender;
+    };
+    private: {
+        id: null;
+        chat: null;
+        sender: PeerSender;
+    };
+}
+/**
+ * Information about a message that this message is a reply to
+ */
+export declare class RepliedMessageInfo {
+    readonly raw: tl.RawMessageReplyHeader;
+    readonly _peers: PeersIndex;
+    constructor(raw: tl.RawMessageReplyHeader, _peers: PeersIndex);
+    /** Whether this message is a reply to another scheduled message */
+    get isScheduled(): boolean;
+    /** Whether this message was sent to a forum topic */
+    get isForumTopic(): boolean;
+    /** Whether this message is quoting another message */
+    get isQuote(): boolean;
+    /** Origin of the replied-to message */
+    get origin(): RepliedMessageOrigin;
+    /**
+     * Helper method to check {@link origin} that will also
+     * narrow the type of this object respectively
+     */
+    originIs<T extends RepliedMessageOrigin>(origin: T): this is RepliedMessageInfo & _RepliedMessageAssertionsByOrigin[T];
+    /**
+     * For non-`private` origin, ID of the replied-to message in the original chat.
+     */
+    get id(): number | null;
+    /** ID of the replies thread where this message belongs to */
+    get threadId(): number | null;
+    /**
+     * If replied-to message is available, chat where the message was sent.
+     *
+     * If `null`, the message was sent in the same chat.
+     */
+    get chat(): Peer | null;
+    /**
+     * Sender of the replied-to message (either user or a channel)
+     * or their name (for users with private forwards).
+     *
+     * For replies to channel messages, this will be the channel itself.
+     *
+     * `null` if the sender is not available (for `same_chat` origin)
+     */
+    get sender(): PeerSender | null;
+    /**
+     * For non-`same_chat` origin, date the original message was sent.
+     */
+    get date(): Date | null;
+    /**
+     * If this message is a quote, text of the quote.
+     *
+     * For non-`same_chat` origin, this will be the full text of the
+     * replied-to message in case `.isQuote` is `false`
+     */
+    get quoteText(): string;
+    /** Message entities contained in the quote */
+    get quoteEntities(): MessageEntity[];
+    /**
+     * Offset of the start of the {@link quoteText} in the replied-to message.
+     *
+     * Note that this offset should only be used as a hint, as the actual
+     * quote offset may be different due to message being edited after the quote
+     *
+     * `null` if not available, in which case it should be assumed that the quote
+     * starts at `.indexOf(quoteText)` of the replied-to message text.
+     */
+    get quoteOffset(): number | null;
+    /**
+     * Media contained in the replied-to message
+     *
+     * Only available for non-`same_chat` origin
+     */
+    get media(): MessageMedia;
+}

package/highlevel/types/messages/search-filters.d.cts

@@ -0,0 +1,82 @@
+/**
+ * Search filters to be used in {@link TelegramClient.searchMessages}
+ * and {@link TelegramClient.searchGlobal}.
+ *
+ * Note that due to Telegram API limitations, you can't combine filters,
+ * and can only use a limited pre-defined set.
+ *
+ * This object simply exports static TL objects for convenience,
+ * if it does not expose something, simply pass a TL object
+ * directly.
+ *
+ *  - `Empty`: Search for all messages (used by default)
+ *  - `Photo`: Search for photos
+ *  - `Video`: Search for videos
+ *  - `PhotoAndVideo`: Search for photos and videos
+ *  - `Document`: Search for documents (generic files, not including audio, video, etc.)
+ *  - `Url`: Search for messages containing URLs and text links
+ *  - `Gif`: Search for messages containing GIFs
+ *  - `Voice`: Search for messages containing voice notes
+ *  - `Audio`: Search for messages containing audio files
+ *  - `ChatPhotoChange`: Search for chat photo changes
+ *  - `Call`: Search for calls
+ *  - `Round`: Search for round messages (aka video notes)
+ *  - `RoundAndVoice`: Search for round messages (aka video notes) and voice notes
+ *  - `MyMention`: Search for mentions of yourself
+ *  - `Location`: Search for geolocations
+ *  - `Contact`: Search for contacts
+ *  - `Pinned`: Search for pinned messages
+ */
+export declare const SearchFilters: {
+    readonly Empty: {
+        readonly _: "inputMessagesFilterEmpty";
+    };
+    readonly Photo: {
+        readonly _: "inputMessagesFilterPhotos";
+    };
+    readonly Video: {
+        readonly _: "inputMessagesFilterVideo";
+    };
+    readonly PhotoAndVideo: {
+        readonly _: "inputMessagesFilterPhotoVideo";
+    };
+    readonly Document: {
+        readonly _: "inputMessagesFilterDocument";
+    };
+    readonly Url: {
+        readonly _: "inputMessagesFilterUrl";
+    };
+    readonly Gif: {
+        readonly _: "inputMessagesFilterGif";
+    };
+    readonly Voice: {
+        readonly _: "inputMessagesFilterVoice";
+    };
+    readonly Audio: {
+        readonly _: "inputMessagesFilterMusic";
+    };
+    readonly ChatPhotoChange: {
+        readonly _: "inputMessagesFilterChatPhotos";
+    };
+    readonly Call: {
+        readonly _: "inputMessagesFilterPhoneCalls";
+    };
+    readonly Round: {
+        readonly _: "inputMessagesFilterRoundVideo";
+    };
+    readonly RoundAndVoice: {
+        readonly _: "inputMessagesFilterRoundVoice";
+    };
+    readonly MyMention: {
+        readonly _: "inputMessagesFilterMyMentions";
+    };
+    readonly Location: {
+        readonly _: "inputMessagesFilterGeo";
+    };
+    readonly Contact: {
+        readonly _: "inputMessagesFilterContacts";
+    };
+    readonly Pinned: {
+        readonly _: "inputMessagesFilterPinned";
+    };
+};