@mtcute/core 0.16.7 → 0.16.9

package/highlevel/methods/files/download-iterable.d.ts

@@ -0,0 +1,10 @@
+import { ITelegramClient } from '../../client.types.js';
+import { FileDownloadLocation, FileDownloadParameters } from '../../types/index.js';
+/**
+ * Download a file and return it as an iterable, which yields file contents
+ * in chunks of a given size. Order of the chunks is guaranteed to be
+ * consecutive.
+ *
+ * @param params  Download parameters
+ */
+export declare function downloadAsIterable(client: ITelegramClient, input: FileDownloadLocation, params?: FileDownloadParameters): AsyncIterableIterator<Uint8Array>;

package/highlevel/methods/files/download-stream.d.ts

@@ -0,0 +1,9 @@
+import { ITelegramClient } from '../../client.types.js';
+import { FileDownloadLocation, FileDownloadParameters } from '../../types/index.js';
+/**
+ * Download a file and return it as a readable stream,
+ * streaming file contents.
+ *
+ * @param params  File download parameters
+ */
+export declare function downloadAsStream(client: ITelegramClient, location: FileDownloadLocation, params?: FileDownloadParameters): ReadableStream<Uint8Array>;

package/highlevel/methods/files/normalize-file-to-document.d.ts

@@ -0,0 +1,9 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { InputFileLike } from '../../types/index.js';
+/**
+ * @internal
+ */
+export declare function _normalizeFileToDocument(client: ITelegramClient, file: InputFileLike | tl.TypeInputDocument, params: {
+    progressCallback?: (uploaded: number, total: number) => void;
+}): Promise<tl.TypeInputDocument>;

package/highlevel/methods/files/normalize-input-file.d.ts

@@ -0,0 +1,13 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { InputFileLike } from '../../types/files/index.js';
+/**
+ * Normalize a {@link InputFileLike} to `InputFile`,
+ * uploading it if needed.
+ */
+export declare function _normalizeInputFile(client: ITelegramClient, input: InputFileLike, params: {
+    progressCallback?: (uploaded: number, total: number) => void;
+    fileName?: string;
+    fileSize?: number;
+    fileMime?: string;
+}): Promise<tl.TypeInputFile>;

package/highlevel/methods/files/normalize-input-media.d.ts

@@ -0,0 +1,12 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { InputMediaLike } from '../../types/media/input-media/types.js';
+/**
+ * Normalize an {@link InputMediaLike} to `InputMedia`,
+ * uploading the file if needed.
+ */
+export declare function _normalizeInputMedia(client: ITelegramClient, media: InputMediaLike, params?: {
+    progressCallback?: (uploaded: number, total: number) => void;
+    uploadPeer?: tl.TypeInputPeer;
+    businessConnectionId?: string;
+}, uploadMedia?: boolean): Promise<tl.TypeInputMedia>;

package/highlevel/methods/files/upload-file.d.ts

@@ -0,0 +1,64 @@
+import { ITelegramClient } from '../../client.types.js';
+import { UploadFileLike, UploadedFile } from '../../types/index.js';
+/**
+ * Upload a file to Telegram servers, without actually
+ * sending a message anywhere. Useful when an `InputFile` is required.
+ *
+ * This method is quite low-level, and you should use other
+ * methods like {@link sendMedia} that handle this under the hood.
+ *
+ * @param params  Upload parameters
+ */
+export declare function uploadFile(client: ITelegramClient, params: {
+    /**
+     * Upload file source.
+     */
+    file: UploadFileLike;
+    /**
+     * File name for the uploaded file. Is usually inferred from path,
+     * but should be provided for files sent as `Buffer` or stream.
+     *
+     * When file name can't be inferred, it falls back to "unnamed"
+     */
+    fileName?: string;
+    /**
+     * Total file size. Automatically inferred for Buffer, File and local files.
+     */
+    fileSize?: number;
+    /**
+     * If the file size is unknown, you can provide an estimate,
+     * which will be used to determine appropriate part size.
+     */
+    estimatedSize?: number;
+    /**
+     * File MIME type. By default is automatically inferred from magic number
+     * If MIME can't be inferred, it defaults to `application/octet-stream`
+     */
+    fileMime?: string;
+    /**
+     * Upload part size (in KB).
+     *
+     * By default, automatically selected by file size.
+     * Must not be bigger than 512 and must not be a fraction.
+     */
+    partSize?: number;
+    /**
+     * Number of parts to be sent in parallel per connection.
+     */
+    requestsPerConnection?: number;
+    /**
+     * Function that will be called after some part has been uploaded.
+     *
+     * @param uploaded  Number of bytes already uploaded
+     * @param total  Total file size, if known
+     */
+    progressCallback?: (uploaded: number, total: number) => void;
+    /**
+     * When using `inputMediaUploadedPhoto` (e.g. when sending an uploaded photo) require
+     * the file size to be known beforehand.
+     *
+     * In case this is set to `true`, a stream is passed as `file` and the file size is unknown,
+     * the stream will be buffered in memory and the file size will be inferred from the buffer.
+     */
+    requireFileSize?: boolean;
+}): Promise<UploadedFile>;

package/highlevel/methods/files/upload-media.d.ts

@@ -0,0 +1,28 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputMediaLike, InputPeerLike, MessageMedia, RawDocument, Photo } from '../../types/index.js';
+/**
+ * Upload a media to Telegram servers, without actually
+ * sending a message anywhere. Useful when File ID is needed.
+ *
+ * The difference with {@link uploadFile} is that
+ * the returned object will act like a message media
+ * and contain fields like File ID.
+ *
+ * @param media  Media to upload
+ * @param params  Upload parameters
+ */
+export declare function uploadMedia(client: ITelegramClient, media: InputMediaLike, params?: {
+    /**
+     * Peer to associate this media with.
+     *
+     * @default  `self`
+     */
+    peer?: InputPeerLike;
+    /**
+     * Upload progress callback
+     *
+     * @param uploaded  Number of bytes uploaded
+     * @param total  Total file size
+     */
+    progressCallback?: (uploaded: number, total: number) => void;
+}): Promise<Extract<MessageMedia, Photo | RawDocument>>;

package/highlevel/methods/forums/create-forum-topic.d.ts

@@ -0,0 +1,36 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Message } from '../../types/index.js';
+/**
+ * Create a topic in a forum
+ *
+ * Only admins with `manageTopics` permission can do this.
+ *
+ * @returns  Service message for the created topic
+ */
+export declare function createForumTopic(client: ITelegramClient, params: {
+    /** Chat ID or username */
+    chatId: InputPeerLike;
+    /**
+     * Topic title
+     */
+    title: string;
+    /**
+     * Icon of the topic.
+     *
+     * Can be a number (color in RGB, see {@link ForumTopic} static members for allowed values)
+     * or a custom emoji ID.
+     *
+     * Icon color can't be changed after the topic is created.
+     */
+    icon?: number | tl.Long;
+    /**
+     * Send as a specific channel
+     */
+    sendAs?: InputPeerLike;
+    /**
+     * Whether to dispatch the returned service message (if any)
+     * to the client's update handler.
+     */
+    shouldDispatch?: true;
+}): Promise<Message>;

package/highlevel/methods/forums/delete-forum-topic-history.d.ts

@@ -0,0 +1,15 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ForumTopic, InputPeerLike } from '../../types/index.js';
+/**
+ * Delete a forum topic and all its history
+ *
+ * @param chat  Chat or user ID, username, phone number, `"me"` or `"self"`
+ * @param topicId  ID of the topic (i.e. its top message ID)
+ */
+export declare function deleteForumTopicHistory(client: ITelegramClient, chat: InputPeerLike, topicId: number | ForumTopic, params?: {
+    /**
+     * Whether to dispatch updates that will be generated by this call.
+     * Doesn't follow `disableNoDispatch`
+     */
+    shouldDispatch?: true;
+}): Promise<void>;

package/highlevel/methods/forums/edit-forum-topic.d.ts

@@ -0,0 +1,34 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { ForumTopic, InputPeerLike, Message } from '../../types/index.js';
+/**
+ * Modify a topic in a forum
+ *
+ * Only admins with `manageTopics` permission can do this.
+ *
+ * @param chatId  Chat ID or username
+ * @param topicId  ID of the topic (i.e. its top message ID)
+ * @returns  Service message about the modification
+ */
+export declare function editForumTopic(client: ITelegramClient, params: {
+    /** Chat ID or username */
+    chatId: InputPeerLike;
+    /** ID of the topic (i.e. its top message ID) */
+    topicId: number | ForumTopic;
+    /**
+     * New topic title
+     */
+    title?: string;
+    /**
+     * New icon of the topic.
+     *
+     * Can be a custom emoji ID, or `null` to remove the icon
+     * and use static color instead
+     */
+    icon?: tl.Long | null;
+    /**
+     * Whether to dispatch the returned service message (if any)
+     * to the client's update handler.
+     */
+    shouldDispatch?: true;
+}): Promise<Message>;

package/highlevel/methods/forums/get-forum-topics-by-id.d.ts

@@ -0,0 +1,9 @@
+import { MaybeArray } from '../../../types/utils.js';
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, ForumTopic } from '../../types/index.js';
+/**
+ * Get forum topics by their IDs
+ *
+ * @param chatId  Chat ID or username
+ */
+export declare function getForumTopicsById(client: ITelegramClient, chatId: InputPeerLike, ids: MaybeArray<number>): Promise<ForumTopic[]>;

package/highlevel/methods/forums/get-forum-topics.d.ts

@@ -0,0 +1,28 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ArrayPaginated, InputPeerLike, ForumTopic } from '../../types/index.js';
+export interface GetForumTopicsOffset {
+    date: number;
+    id: number;
+    topic: number;
+}
+/**
+ * Get forum topics
+ *
+ * @param chatId  Chat ID or username
+ */
+export declare function getForumTopics(client: ITelegramClient, chatId: InputPeerLike, params?: {
+    /**
+     * Search query
+     */
+    query?: string;
+    /**
+     * Offset for pagination
+     */
+    offset?: GetForumTopicsOffset;
+    /**
+     * Maximum number of topics to return.
+     *
+     * @default  100
+     */
+    limit?: number;
+}): Promise<ArrayPaginated<ForumTopic, GetForumTopicsOffset>>;

package/highlevel/methods/forums/iter-forum-topics.d.ts

@@ -0,0 +1,20 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ForumTopic, InputPeerLike } from '../../types/index.js';
+import { getForumTopics } from './get-forum-topics.js';
+/**
+ * Iterate over forum topics. Wrapper over {@link getForumTopics}.
+ *
+ * @param chatId  Chat ID or username
+ */
+export declare function iterForumTopics(client: ITelegramClient, chatId: InputPeerLike, params?: Parameters<typeof getForumTopics>[2] & {
+    /**
+     * Maximum number of topics to return.
+     *
+     * @default  `Infinity`, i.e. return all topics
+     */
+    limit?: number;
+    /**
+     * Chunk size. Usually you shouldn't care about this.
+     */
+    chunkSize?: number;
+}): AsyncIterableIterator<ForumTopic>;

package/highlevel/methods/forums/reorder-pinned-forum-topics.d.ts

@@ -0,0 +1,19 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ForumTopic, InputPeerLike } from '../../types/index.js';
+/**
+ * Reorder pinned forum topics
+ *
+ * Only admins with `manageTopics` permission can do this.
+ */
+export declare function reorderPinnedForumTopics(client: ITelegramClient, params: {
+    /** Chat ID or username */
+    chatId: InputPeerLike;
+    /**
+     * Order of the pinned topics
+     */
+    order: (number | ForumTopic)[];
+    /**
+     * Whether to un-pin topics not present in the order
+     */
+    force?: boolean;
+}): Promise<void>;

package/highlevel/methods/forums/toggle-forum-topic-closed.d.ts

@@ -0,0 +1,22 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ForumTopic, InputPeerLike, Message } from '../../types/index.js';
+/**
+ * Toggle open/close status of a topic in a forum
+ *
+ * Only admins with `manageTopics` permission can do this.
+ *
+ * @returns  Service message about the modification
+ */
+export declare function toggleForumTopicClosed(client: ITelegramClient, parmas: {
+    /** Chat ID or username */
+    chatId: InputPeerLike;
+    /** ID of the topic (i.e. its top message ID) */
+    topicId: number | ForumTopic;
+    /** Whether the topic should be closed */
+    closed: boolean;
+    /**
+     * Whether to dispatch the returned service message (if any)
+     * to the client's update handler.
+     */
+    shouldDispatch?: true;
+}): Promise<Message>;

package/highlevel/methods/forums/toggle-forum-topic-pinned.d.ts

@@ -0,0 +1,15 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ForumTopic, InputPeerLike } from '../../types/index.js';
+/**
+ * Toggle whether a topic in a forum is pinned
+ *
+ * Only admins with `manageTopics` permission can do this.
+ */
+export declare function toggleForumTopicPinned(client: ITelegramClient, params: {
+    /** Chat ID or username */
+    chatId: InputPeerLike;
+    /** ID of the topic (i.e. its top message ID) */
+    topicId: number | ForumTopic;
+    /** Whether the topic should be pinned */
+    pinned: boolean;
+}): Promise<void>;

package/highlevel/methods/forums/toggle-forum.d.ts

@@ -0,0 +1,11 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Set whether a supergroup is a forum.
+ *
+ * Only owner of the supergroup can change this setting.
+ *
+ * @param chatId  Chat ID or username
+ * @param enabled  Whether the supergroup should be a forum
+ */
+export declare function toggleForum(client: ITelegramClient, chatId: InputPeerLike, enabled?: boolean): Promise<void>;

package/highlevel/methods/forums/toggle-general-topic-hidden.d.ts

@@ -0,0 +1,20 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Message } from '../../types/index.js';
+/**
+ * Toggle whether "General" topic in a forum is hidden or not
+ *
+ * Only admins with `manageTopics` permission can do this.
+ *
+ * @returns  Service message about the modification
+ */
+export declare function toggleGeneralTopicHidden(client: ITelegramClient, params: {
+    /** Chat ID or username */
+    chatId: InputPeerLike;
+    /** Whether the topic should be hidden */
+    hidden: boolean;
+    /**
+     * Whether to dispatch the returned service message (if any)
+     * to the client's update handler.
+     */
+    shouldDispatch?: true;
+}): Promise<Message>;

package/highlevel/methods/invite-links/create-invite-link.d.ts

@@ -0,0 +1,31 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, ChatInviteLink } from '../../types/index.js';
+/**
+ * Create an additional invite link for the chat.
+ *
+ * You must be an administrator and have appropriate rights.
+ *
+ * @param chatId  Chat ID
+ * @param params
+ */
+export declare function createInviteLink(client: ITelegramClient, chatId: InputPeerLike, params?: {
+    /**
+     * Date when this link will expire.
+     * If `number` is passed, UNIX time in ms is expected.
+     */
+    expires?: number | Date;
+    /**
+     * Maximum number of users that can be members of this chat
+     * at the same time after joining using this link.
+     *
+     * Integer in range `[1, 99999]` or `Infinity`
+     *
+     * @default  `Infinity`
+     */
+    usageLimit?: number;
+    /**
+     * Whether users to be joined via this link need to be
+     * approved by an admin
+     */
+    withApproval?: boolean;
+}): Promise<ChatInviteLink>;

package/highlevel/methods/invite-links/edit-invite-link.d.ts

@@ -0,0 +1,36 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, ChatInviteLink } from '../../types/index.js';
+/**
+ * Edit an invite link. You can only edit non-primary
+ * invite links.
+ *
+ * Only pass the fields that you want to modify.
+ *
+ * @param chatId  Chat ID
+ * @param link  Invite link to edit
+ * @param params
+ * @returns  Modified invite link
+ */
+export declare function editInviteLink(client: ITelegramClient, params: {
+    /** Chat ID */
+    chatId: InputPeerLike;
+    /** Invite link to edit */
+    link: string | ChatInviteLink;
+    /**
+     * Date when this link will expire.
+     * If `number` is passed, UNIX time in ms is expected.
+     */
+    expires?: number | Date;
+    /**
+     * Maximum number of users that can be members of this chat
+     * at the same time after joining using this link.
+     *
+     * Integer in range `[1, 99999]` or `Infinity`,
+     */
+    usageLimit?: number;
+    /**
+     * Whether users to be joined via this link need to be
+     * approved by an admin
+     */
+    withApproval?: boolean;
+}): Promise<ChatInviteLink>;

package/highlevel/methods/invite-links/export-invite-link.d.ts

@@ -0,0 +1,12 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, ChatInviteLink } from '../../types/index.js';
+/**
+ * Generate a new primary invite link for a chat,
+ * old primary link is revoked.
+ *
+ * > **Note**: each administrator has their own primary invite link,
+ * > and bots by default don't have one.
+ *
+ * @param chatId  Chat IDs
+ */
+export declare function exportInviteLink(client: ITelegramClient, chatId: InputPeerLike): Promise<ChatInviteLink>;

package/highlevel/methods/invite-links/get-invite-link-members.d.ts

@@ -0,0 +1,45 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { ArrayPaginated, ChatInviteLink, InputPeerLike, ChatInviteLinkMember } from '../../types/index.js';
+/**
+ * Iterate over users who have joined
+ * the chat with the given invite link.
+ *
+ * @param chatId  Chat ID
+ * @param params  Additional params
+ */
+export declare function getInviteLinkMembers(client: ITelegramClient, chatId: InputPeerLike, params?: {
+    /**
+     * Invite link for which to get members
+     */
+    link?: string | ChatInviteLink;
+    /**
+     * Maximum number of users to return
+     *
+     * @default  100
+     */
+    limit?: number;
+    /**
+     * Offset request/join date used as an anchor for pagination.
+     */
+    offsetDate?: Date | number;
+    /**
+     * Offset user used as an anchor for pagination
+     */
+    offsetUser?: tl.TypeInputUser;
+    /**
+     * Whether to get users who have requested to join
+     * the chat but weren't accepted yet
+     */
+    requested?: boolean;
+    /**
+     * Search for a user in the pending join requests list
+     * (if passed, {@link requested} is assumed to be true)
+     *
+     * Doesn't work when {@link link} is set (Telegram limitation)
+     */
+    requestedSearch?: string;
+}): Promise<ArrayPaginated<ChatInviteLinkMember, {
+    date: number;
+    user: tl.TypeInputUser;
+}>>;

package/highlevel/methods/invite-links/get-invite-link.d.ts

@@ -0,0 +1,9 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, ChatInviteLink } from '../../types/index.js';
+/**
+ * Get detailed information about an invite link
+ *
+ * @param chatId  Chat ID
+ * @param link  The invite link
+ */
+export declare function getInviteLink(client: ITelegramClient, chatId: InputPeerLike, link: string): Promise<ChatInviteLink>;

package/highlevel/methods/invite-links/get-invite-links.d.ts

@@ -0,0 +1,39 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ArrayPaginated, InputPeerLike, ChatInviteLink } from '../../types/index.js';
+export interface GetInviteLinksOffset {
+    date: number;
+    link: string;
+}
+/**
+ * Get invite links created by some administrator in the chat.
+ *
+ * As an administrator you can only get your own links
+ * (i.e. `adminId = "self"`), as a creator you can get
+ * any other admin's links.
+ *
+ * @param chatId  Chat ID
+ * @param adminId  Admin who created the links
+ * @param params
+ */
+export declare function getInviteLinks(client: ITelegramClient, chatId: InputPeerLike, params?: {
+    /**
+     * Only return this admin's links.
+     *
+     * @default `"self"`
+     */
+    admin?: InputPeerLike;
+    /**
+     * Whether to fetch revoked invite links
+     */
+    revoked?: boolean;
+    /**
+     * Limit the number of invite links to be fetched.
+     *
+     * @default  100
+     */
+    limit?: number;
+    /**
+     * Offset for pagination.
+     */
+    offset?: GetInviteLinksOffset;
+}): Promise<ArrayPaginated<ChatInviteLink, GetInviteLinksOffset>>;

package/highlevel/methods/invite-links/get-primary-invite-link.d.ts

@@ -0,0 +1,8 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, ChatInviteLink } from '../../types/index.js';
+/**
+ * Get primary invite link of a chat
+ *
+ * @param chatId  Chat ID
+ */
+export declare function getPrimaryInviteLink(client: ITelegramClient, chatId: InputPeerLike): Promise<ChatInviteLink>;

package/highlevel/methods/invite-links/hide-all-join-requests.d.ts

@@ -0,0 +1,13 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ChatInviteLink, InputPeerLike } from '../../types/index.js';
+/**
+ * Approve or decline multiple join requests to a chat.
+ */
+export declare function hideAllJoinRequests(client: ITelegramClient, params: {
+    /** Chat/channel ID */
+    chatId: InputPeerLike;
+    /** Whether to approve or decline the join requests */
+    action: 'approve' | 'decline';
+    /** Invite link to target */
+    link?: string | ChatInviteLink;
+}): Promise<void>;

package/highlevel/methods/invite-links/hide-join-request.d.ts

@@ -0,0 +1,13 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Approve or decline join request to a chat.
+ */
+export declare function hideJoinRequest(client: ITelegramClient, params: {
+    /** Chat/channel ID */
+    chatId: InputPeerLike;
+    /** User ID */
+    user: InputPeerLike;
+    /** Whether to approve or decline the join request */
+    action: 'approve' | 'decline';
+}): Promise<void>;

package/highlevel/methods/invite-links/iter-invite-link-members.d.ts

@@ -0,0 +1,25 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ChatInviteLinkMember, InputPeerLike } from '../../types/index.js';
+import { getInviteLinkMembers } from './get-invite-link-members.js';
+/**
+ * Iterate over users who have joined
+ * the chat with the given invite link.
+ *
+ * @param chatId  Chat ID
+ * @param params  Additional params
+ */
+export declare function iterInviteLinkMembers(client: ITelegramClient, chatId: InputPeerLike, params?: Parameters<typeof getInviteLinkMembers>[2] & {
+    /**
+     * Maximum number of users to return
+     *
+     * @default  `Infinity`, i.e. all users are fetched
+     */
+    limit?: number;
+    /**
+     * Chunk size which will be passed to `messages.getChatInviteImporters`.
+     * You shouldn't usually care about this.
+     *
+     * @default  100.
+     */
+    chunkSize?: number;
+}): AsyncIterableIterator<ChatInviteLinkMember>;