@mtcute/core 0.18.0-rc.5 → 0.19.0

package/highlevel/methods/stories/delete-stories.d.cts

@@ -0,0 +1,20 @@
+import { MaybeArray } from '../../../types/utils.js';
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Delete a story
+ *
+ * @returns  IDs of stories that were removed
+ */
+export declare function deleteStories(client: ITelegramClient, params: {
+    /**
+     * Story IDs to delete
+     */
+    ids: MaybeArray<number>;
+    /**
+     * Peer ID whose stories to delete
+     *
+     * @default  `self`
+     */
+    peer?: InputPeerLike;
+}): Promise<number[]>;

package/highlevel/methods/stories/edit-story.d.cts

@@ -0,0 +1,38 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { InputMediaLike, InputPeerLike, InputPrivacyRule, InputText, Story } from '../../types/index.js';
+/**
+ * Edit a sent story
+ *
+ * @returns  Edited story
+ */
+export declare function editStory(client: ITelegramClient, params: {
+    /**
+     * Story ID to edit
+     */
+    id: number;
+    /**
+     * Peer ID to whose story to edit
+     *
+     * @default  `self`
+     */
+    peer?: InputPeerLike;
+    /**
+     * Media contained in a story. Currently can only be a photo or a video.
+     */
+    media?: InputMediaLike;
+    /**
+     * Override caption for {@link media}
+     */
+    caption?: InputText;
+    /**
+     * Interactive elements to add to the story
+     */
+    interactiveElements?: tl.TypeMediaArea[];
+    /**
+     * Privacy rules to apply to the story
+     *
+     * @default  "Everyone"
+     */
+    privacyRules?: InputPrivacyRule[];
+}): Promise<Story>;

package/highlevel/methods/stories/find-in-update.d.cts

@@ -0,0 +1,5 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { Story } from '../../types/index.js';
+/** @internal */
+export declare function _findStoryInUpdate(client: ITelegramClient, res: tl.TypeUpdates): Story;

package/highlevel/methods/stories/get-all-stories.d.cts

@@ -0,0 +1,15 @@
+import { ITelegramClient } from '../../client.types.js';
+import { AllStories } from '../../types/index.js';
+/**
+ * Get all stories (e.g. to load the top bar)
+ */
+export declare function getAllStories(client: ITelegramClient, params?: {
+    /**
+     * Offset from which to fetch stories
+     */
+    offset?: string;
+    /**
+     * Whether to fetch stories from "archived" (or "hidden") peers
+     */
+    archived?: boolean;
+}): Promise<AllStories>;

package/highlevel/methods/stories/get-peer-stories.d.cts

@@ -0,0 +1,8 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, PeerStories } from '../../types/index.js';
+/**
+ * Get stories of a given peer
+ *
+ * @param peerId  Peer ID whose stories to fetch
+ */
+export declare function getPeerStories(client: ITelegramClient, peerId: InputPeerLike): Promise<PeerStories>;

package/highlevel/methods/stories/get-profile-stories.d.cts

@@ -0,0 +1,25 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ArrayPaginated, InputPeerLike, Story } from '../../types/index.js';
+/**
+ * Get profile stories
+ */
+export declare function getProfileStories(client: ITelegramClient, peerId: InputPeerLike, params?: {
+    /**
+     * Kind of stories to fetch
+     * - `pinned` - stories pinned to the profile and visible to everyone
+     * - `archived` - "archived" stories that can later be pinned, only visible to the owner
+     *
+     * @default  `pinned`
+     */
+    kind?: 'pinned' | 'archived';
+    /**
+     * Offset ID for pagination
+     */
+    offsetId?: number;
+    /**
+     * Maximum number of stories to fetch
+     *
+     * @default  100
+     */
+    limit?: number;
+}): Promise<ArrayPaginated<Story, number>>;

package/highlevel/methods/stories/get-stories-by-id.d.cts

@@ -0,0 +1,10 @@
+import { MaybeArray } from '../../../types/utils.js';
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Story } from '../../types/index.js';
+/**
+ * Get one or more stories by their IDs
+ *
+ * @param peerId  Peer ID whose stories to fetch
+ * @param storyIds  Story IDs
+ */
+export declare function getStoriesById(client: ITelegramClient, peerId: InputPeerLike, storyIds: MaybeArray<number>): Promise<Story[]>;

package/highlevel/methods/stories/get-stories-interactions.d.cts

@@ -0,0 +1,9 @@
+import { MaybeArray } from '../../../types/utils.js';
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, StoryInteractions } from '../../types/index.js';
+/**
+ * Get brief information about stories interactions.
+ *
+ * The result will be in the same order as the input IDs
+ */
+export declare function getStoriesInteractions(client: ITelegramClient, peerId: InputPeerLike, storyIds: MaybeArray<number>): Promise<StoryInteractions[]>;

package/highlevel/methods/stories/get-story-link.d.cts

@@ -0,0 +1,11 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Generate a link to a story.
+ *
+ * Basically the link format is `t.me/<username>/s/<story_id>`,
+ * and if the user doesn't have a username, `USER_PUBLIC_MISSING` is thrown.
+ *
+ * I have no idea why is this an RPC call, but whatever
+ */
+export declare function getStoryLink(client: ITelegramClient, peerId: InputPeerLike, storyId: number): Promise<string>;

package/highlevel/methods/stories/get-story-viewers.d.cts

@@ -0,0 +1,33 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, StoryViewersList } from '../../types/index.js';
+/**
+ * Get viewers list of a story
+ */
+export declare function getStoryViewers(client: ITelegramClient, peerId: InputPeerLike, storyId: number, params?: {
+    /**
+     * Whether to only fetch viewers from contacts
+     */
+    onlyContacts?: boolean;
+    /**
+     * How to sort the results?
+     * - `reaction` - by reaction (viewers who has reacted are first), then by date (newest first)
+     * - `date` - by date, newest first
+     *
+     * @default  `reaction`
+     */
+    sortBy?: 'reaction' | 'date';
+    /**
+     * Search query
+     */
+    query?: string;
+    /**
+     * Offset ID for pagination
+     */
+    offset?: string;
+    /**
+     * Maximum number of viewers to fetch
+     *
+     * @default  100
+     */
+    limit?: number;
+}): Promise<StoryViewersList>;

package/highlevel/methods/stories/hide-my-stories-views.d.cts

@@ -0,0 +1,21 @@
+import { ITelegramClient } from '../../client.types.js';
+import { StoriesStealthMode } from '../../types/stories/stealth-mode.js';
+/**
+ * Hide own stories views (activate so called "stealth mode")
+ *
+ * Currently has a cooldown of 1 hour, and throws FLOOD_WAIT error if it is on cooldown.
+ */
+export declare function hideMyStoriesViews(client: ITelegramClient, params?: {
+    /**
+     * Whether to hide views from the last 5 minutes
+     *
+     * @default  true
+     */
+    past?: boolean;
+    /**
+     * Whether to hide views for the next 25 minutes
+     *
+     * @default  true
+     */
+    future?: boolean;
+}): Promise<StoriesStealthMode>;

package/highlevel/methods/stories/increment-stories-views.d.cts

@@ -0,0 +1,13 @@
+import { MaybeArray } from '../../../types/utils.js';
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Increment views of one or more stories.
+ *
+ * This should be used for pinned stories, as they can't
+ * be marked as read when the user sees them ({@link Story#isActive} == false)
+ *
+ * @param peerId  Peer ID whose stories to mark as read
+ * @param ids  ID(s) of the stories to increment views of (max 200)
+ */
+export declare function incrementStoriesViews(client: ITelegramClient, peerId: InputPeerLike, ids: MaybeArray<number>): Promise<void>;

package/highlevel/methods/stories/iter-all-stories.d.cts

@@ -0,0 +1,16 @@
+import { ITelegramClient } from '../../client.types.js';
+import { PeerStories } from '../../types/index.js';
+import { getAllStories } from './get-all-stories.js';
+/**
+ * Iterate over all stories (e.g. to load the top bar)
+ *
+ * Wrapper over {@link getAllStories}
+ */
+export declare function iterAllStories(client: ITelegramClient, params?: Parameters<typeof getAllStories>[1] & {
+    /**
+     * Maximum number of stories to fetch
+     *
+     * @default  Infinity
+     */
+    limit?: number;
+}): AsyncIterableIterator<PeerStories>;

package/highlevel/methods/stories/iter-profile-stories.d.cts

@@ -0,0 +1,21 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Story } from '../../types/index.js';
+import { getProfileStories } from './get-profile-stories.js';
+/**
+ * Iterate over profile stories. Wrapper over {@link getProfileStories}
+ */
+export declare function iterProfileStories(client: ITelegramClient, peerId: InputPeerLike, params?: Parameters<typeof getProfileStories>[2] & {
+    /**
+     * Total number of stories to fetch
+     *
+     * @default  `Infinity`, i.e. fetch all stories
+     */
+    limit?: number;
+    /**
+     * Number of stories to fetch per request.
+     * Usually you shouldn't care about this.
+     *
+     * @default  100
+     */
+    chunkSize?: number;
+}): AsyncIterableIterator<Story>;

package/highlevel/methods/stories/iter-story-viewers.d.cts

@@ -0,0 +1,22 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, StoryViewer } from '../../types/index.js';
+import { getStoryViewers } from './get-story-viewers.js';
+/**
+ * Iterate over viewers list of a story.
+ * Wrapper over {@link getStoryViewers}
+ */
+export declare function iterStoryViewers(client: ITelegramClient, peerId: InputPeerLike, storyId: number, params?: Parameters<typeof getStoryViewers>[3] & {
+    /**
+     * Total number of viewers to fetch
+     *
+     * @default  Infinity, i.e. fetch all viewers
+     */
+    limit?: number;
+    /**
+     * Number of viewers to fetch per request.
+     * Usually you don't need to change this.
+     *
+     * @default  100
+     */
+    chunkSize?: number;
+}): AsyncIterableIterator<StoryViewer>;

package/highlevel/methods/stories/read-stories.d.cts

@@ -0,0 +1,11 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Mark all stories up to a given ID as read
+ *
+ * This should only be used for "active" stories ({@link Story#isActive} == false)
+ *
+ * @param peerId  Peer ID whose stories to mark as read
+ * @returns  IDs of the stores that were marked as read
+ */
+export declare function readStories(client: ITelegramClient, peerId: InputPeerLike, maxId: number): Promise<number[]>;

package/highlevel/methods/stories/send-story-reaction.d.cts

@@ -0,0 +1,14 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, InputReaction } from '../../types/index.js';
+/**
+ * Send (or remove) a reaction to a story
+ */
+export declare function sendStoryReaction(client: ITelegramClient, params: {
+    peerId: InputPeerLike;
+    storyId: number;
+    reaction: InputReaction;
+    /**
+     * Whether to add this reaction to recently used
+     */
+    addToRecent?: boolean;
+}): Promise<void>;

package/highlevel/methods/stories/send-story.d.cts

@@ -0,0 +1,51 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { InputMediaLike, InputPeerLike, InputPrivacyRule, InputText, Story } from '../../types/index.js';
+/**
+ * Send a story
+ *
+ * @returns  Created story
+ */
+export declare function sendStory(client: ITelegramClient, params: {
+    /**
+     * Peer ID to send story as
+     *
+     * @default  `self`
+     */
+    peer?: InputPeerLike;
+    /**
+     * Media contained in a story. Currently can only be a photo or a video.
+     *
+     * You can also pass TDLib and Bot API compatible File ID,
+     * which will be wrapped in {@link InputMedia.auto}
+     */
+    media: InputMediaLike | string;
+    /**
+     * Override caption for {@link media}
+     */
+    caption?: InputText;
+    /**
+     * Whether to automatically pin this story to the profile
+     */
+    pinned?: boolean;
+    /**
+     * Whether to disallow sharing this story
+     */
+    forbidForwards?: boolean;
+    /**
+     * Interactive elements to add to the story
+     */
+    interactiveElements?: tl.TypeMediaArea[];
+    /**
+     * Privacy rules to apply to the story
+     *
+     * @default  "Everyone"
+     */
+    privacyRules?: InputPrivacyRule[];
+    /**
+     * TTL period of the story, in seconds
+     *
+     * @default  86400
+     */
+    period?: number;
+}): Promise<Story>;

package/highlevel/methods/stories/toggle-peer-stories-archived.d.cts

@@ -0,0 +1,8 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Toggle whether peer's stories are archived (hidden) or not.
+ *
+ * This **does not** archive the chat with that peer, only stories.
+ */
+export declare function togglePeerStoriesArchived(client: ITelegramClient, peerId: InputPeerLike, archived: boolean): Promise<void>;

package/highlevel/methods/stories/toggle-stories-pinned.d.cts

@@ -0,0 +1,24 @@
+import { MaybeArray } from '../../../types/utils.js';
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Toggle one or more stories pinned status
+ *
+ * @returns  IDs of stories that were toggled
+ */
+export declare function toggleStoriesPinned(client: ITelegramClient, params: {
+    /**
+     * Story ID(s) to toggle
+     */
+    ids: MaybeArray<number>;
+    /**
+     * Whether to pin or unpin the story
+     */
+    pinned: boolean;
+    /**
+     * Peer ID whose stories to toggle
+     *
+     * @default  `self`
+     */
+    peer?: InputPeerLike;
+}): Promise<number[]>;

package/highlevel/methods/users/block-user.d.cts

@@ -0,0 +1,8 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Block a user
+ *
+ * @param id  User ID, username or phone number
+ */
+export declare function blockUser(client: ITelegramClient, id: InputPeerLike): Promise<void>;

package/highlevel/methods/users/delete-profile-photos.d.cts

@@ -0,0 +1,9 @@
+import { tl } from '@mtcute/tl';
+import { MaybeArray } from '../../../types/utils.js';
+import { ITelegramClient } from '../../client.types.js';
+/**
+ * Delete your own profile photos
+ *
+ * @param ids  ID(s) of the photos. Can be file IDs or raw TL objects
+ */
+export declare function deleteProfilePhotos(client: ITelegramClient, ids: MaybeArray<string | tl.TypeInputPhoto>): Promise<void>;

package/highlevel/methods/users/edit-close-friends.d.cts

@@ -0,0 +1,14 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Edit "close friends" list directly using user IDs
+ *
+ * @param ids  User IDs
+ */
+export declare function editCloseFriendsRaw(client: ITelegramClient, ids: number[]): Promise<void>;
+/**
+ * Edit "close friends" list using `InputPeerLike`s
+ *
+ * @param ids  User IDs
+ */
+export declare function editCloseFriends(client: ITelegramClient, ids: InputPeerLike[]): Promise<void>;

package/highlevel/methods/users/get-common-chats.d.cts

@@ -0,0 +1,9 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Chat } from '../../types/index.js';
+/**
+ * Get a list of common chats you have with a given user
+ *
+ * @param userId  User's ID, username or phone number
+ * @throws MtInvalidPeerTypeError
+ */
+export declare function getCommonChats(client: ITelegramClient, userId: InputPeerLike): Promise<Chat[]>;

package/highlevel/methods/users/get-global-ttl.d.cts

@@ -0,0 +1,5 @@
+import { ITelegramClient } from '../../client.types.js';
+/**
+ * Gets the current default value of the Time-To-Live setting, applied to all new chats.
+ */
+export declare function getGlobalTtl(client: ITelegramClient): Promise<number>;

package/highlevel/methods/users/get-me.d.cts

@@ -0,0 +1,6 @@
+import { ITelegramClient } from '../../client.types.js';
+import { User } from '../../types/index.js';
+/**
+ * Get currently authorized user's full information
+ */
+export declare function getMe(client: ITelegramClient): Promise<User>;

package/highlevel/methods/users/get-my-username.d.cts

@@ -0,0 +1,8 @@
+import { ITelegramClient } from '../../client.types.js';
+/**
+ * Get currently authorized user's username.
+ *
+ * This method uses locally available information and
+ * does not call any API methods.
+ */
+export declare function getMyUsername(client: ITelegramClient): Promise<string | null>;

package/highlevel/methods/users/get-profile-photo.d.cts

@@ -0,0 +1,11 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Photo } from '../../types/index.js';
+/**
+ * Get a single profile picture of a user by its ID
+ *
+ * @param userId  User ID, username, phone number, `"me"` or `"self"`
+ * @param photoId  ID of the photo to fetch
+ * @param params
+ */
+export declare function getProfilePhoto(client: ITelegramClient, userId: InputPeerLike, photoId: tl.Long): Promise<Photo>;

package/highlevel/methods/users/get-profile-photos.d.cts

@@ -0,0 +1,22 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ArrayPaginated, InputPeerLike, Photo } from '../../types/index.js';
+/**
+ * Get a list of profile pictures of a user
+ *
+ * @param userId  User ID, username, phone number, `"me"` or `"self"`
+ * @param params
+ */
+export declare function getProfilePhotos(client: ITelegramClient, userId: InputPeerLike, params?: {
+    /**
+     * Offset from which to fetch.
+     *
+     * @default  `0`
+     */
+    offset?: number;
+    /**
+     * Maximum number of items to fetch (up to 100)
+     *
+     * @default  `100`
+     */
+    limit?: number;
+}): Promise<ArrayPaginated<Photo, number>>;

package/highlevel/methods/users/get-users.d.cts

@@ -0,0 +1,12 @@
+import { MaybeArray } from '../../../types/utils.js';
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, User } from '../../types/index.js';
+/**
+ * Get information about multiple users.
+ * You can retrieve up to 200 users at once.
+ *
+ * Note that order is not guaranteed.
+ *
+ * @param ids  Users' identifiers. Can be ID, username, phone number, `"me"`, `"self"` or TL object
+ */
+export declare function getUsers(client: ITelegramClient, ids: MaybeArray<InputPeerLike>): Promise<(User | null)[]>;

package/highlevel/methods/users/get-users.test.d.cts

@@ -0,0 +1 @@
+export {};

package/highlevel/methods/users/is-peer-available.d.cts

@@ -0,0 +1,20 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Check whether a given peer ID can be used to actually
+ * interact with the Telegram API.
+ * This method checks the internal peers cache for the given
+ * input peer, and returns `true` if it is available there.
+ *
+ * You can think of this method as a stripped down version of
+ * {@link resolvePeer}, which only returns `true` or `false`.
+ *
+ * > **Note:** This method works offline and never sends any requests.
+ * > This means that when passing a username or phone number, it will
+ * > only return `true` if the user with that username/phone number
+ * > is cached in the storage, and will not try to resolve the peer by calling the API,
+ * > which *may* lead to false negatives.
+ *
+ * @returns
+ */
+export declare function isPeerAvailable(client: ITelegramClient, peerId: InputPeerLike): Promise<boolean>;

package/highlevel/methods/users/iter-profile-photos.d.cts

@@ -0,0 +1,23 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Photo } from '../../types/index.js';
+import { getProfilePhotos } from './get-profile-photos.js';
+/**
+ * Iterate over profile photos
+ *
+ * @param userId  User ID, username, phone number, `"me"` or `"self"`
+ * @param params
+ */
+export declare function iterProfilePhotos(client: ITelegramClient, userId: InputPeerLike, params?: Parameters<typeof getProfilePhotos>[2] & {
+    /**
+     * Maximum number of items to fetch
+     *
+     * @default  `Infinity`, i.e. all items are fetched
+     */
+    limit?: number;
+    /**
+     * Size of chunks which are fetched. Usually not needed.
+     *
+     * @default  100
+     */
+    chunkSize?: number;
+}): AsyncIterableIterator<Photo>;

package/highlevel/methods/users/resolve-peer-many.d.cts

@@ -0,0 +1,26 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/peers/index.js';
+/**
+ * Get multiple `InputPeer`s at once,
+ * while also normalizing and removing
+ * peers that can't be normalized to that type.
+ *
+ * If a peer was not found, it will be skipped.
+ *
+ * Uses async pool internally, with a concurrent limit of 8
+ *
+ * @param peerIds  Peer Ids
+ * @param normalizer  Normalization function
+ */
+export declare function resolvePeerMany<T extends tl.TypeInputPeer | tl.TypeInputUser | tl.TypeInputChannel>(client: ITelegramClient, peerIds: InputPeerLike[], normalizer: (obj: tl.TypeInputPeer) => T | null): Promise<T[]>;
+/**
+ * Get multiple `InputPeer`s at once.
+ *
+ * If a peer was not found, `null` will be returned instead
+ *
+ * Uses async pool internally, with a concurrent limit of 8
+ *
+ * @param peerIds  Peer Ids
+ */
+export declare function resolvePeerMany(client: ITelegramClient, peerIds: InputPeerLike[]): Promise<(tl.TypeInputPeer | null)[]>;

package/highlevel/methods/users/resolve-peer.d.cts

@@ -0,0 +1,20 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/peers/index.js';
+import { tl } from '@mtcute/tl';
+export declare function _normalizePeerId(peerId: InputPeerLike): number | string | tl.TypeInputPeer;
+/**
+ * Get the `InputPeer` of a known peer id.
+ * Useful when an `InputPeer` is needed in Raw API.
+ *
+ * @param peerId  The peer identifier that you want to extract the `InputPeer` from.
+ * @param force  Whether to force re-fetch the peer from the server (only for usernames and phone numbers)
+ */
+export declare function resolvePeer(client: ITelegramClient, peerId: InputPeerLike, force?: boolean): Promise<tl.TypeInputPeer>;
+/**
+ * Shorthand for `resolvePeer` that converts the input peer to `InputUser`.
+ */
+export declare function resolveUser(client: ITelegramClient, peerId: InputPeerLike, force?: boolean): Promise<tl.TypeInputUser>;
+/**
+ * Shorthand for `resolvePeer` that converts the input peer to `InputChannel`.
+ */
+export declare function resolveChannel(client: ITelegramClient, peerId: InputPeerLike, force?: boolean): Promise<tl.TypeInputChannel>;

package/highlevel/methods/users/resolve-peer.test.d.cts

@@ -0,0 +1 @@
+export {};