@mtcute/core 0.6.0 → 0.7.0

package/cjs/highlevel/types/peers/chat-preview.d.ts

@@ -0,0 +1,55 @@
+import { tl } from '@mtcute/tl';
+import { Photo } from '../media/photo.js';
+import { User } from './user.js';
+/**
+ * Chat type. Can be:
+ *  - `group`: Legacy group
+ *  - `supergroup`: Supergroup
+ *  - `channel`: Broadcast channel
+ */
+export type ChatPreviewType = 'group' | 'supergroup' | 'channel';
+export declare class ChatPreview {
+    readonly invite: tl.RawChatInvite;
+    /**
+     * Original invite link used to fetch this preview
+     */
+    readonly link: string;
+    constructor(invite: tl.RawChatInvite, 
+    /**
+     * Original invite link used to fetch this preview
+     */
+    link: string);
+    /**
+     * Title of the chat
+     */
+    get title(): string;
+    /**
+     * Type of the chat
+     */
+    get type(): ChatPreviewType;
+    /**
+     * Whether this chat is public
+     */
+    get public(): boolean;
+    /**
+     * Total chat member count
+     */
+    get memberCount(): number;
+    /**
+     * Chat photo
+     */
+    get photo(): Photo | null;
+    /**
+     * Preview of some of the chat members.
+     *
+     * This usually contains around 10 members,
+     * and members that are inside your contacts list are
+     * ordered before others.
+     */
+    get someMembers(): ReadonlyArray<User>;
+    /**
+     * Whether by using this link you'll also need
+     * to wait for admin approval.
+     */
+    get withApproval(): boolean;
+}

package/cjs/highlevel/types/peers/chat-preview.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatPreview = void 0;
+const index_js_1 = require("../../utils/index.js");
+const memoize_js_1 = require("../../utils/memoize.js");
+const photo_js_1 = require("../media/photo.js");
+const user_js_1 = require("./user.js");
+class ChatPreview {
+    constructor(invite, 
+    /**
+     * Original invite link used to fetch this preview
+     */
+    link) {
+        this.invite = invite;
+        this.link = link;
+    }
+    /**
+     * Title of the chat
+     */
+    get title() {
+        return this.invite.title;
+    }
+    /**
+     * Type of the chat
+     */
+    get type() {
+        if (this.invite.broadcast)
+            return 'channel';
+        if (this.invite.megagroup || this.invite.channel)
+            return 'supergroup';
+        return 'group';
+    }
+    /**
+     * Whether this chat is public
+     */
+    get public() {
+        return this.invite.public;
+    }
+    /**
+     * Total chat member count
+     */
+    get memberCount() {
+        return this.invite.participantsCount;
+    }
+    /**
+     * Chat photo
+     */
+    get photo() {
+        if (this.invite.photo._ === 'photoEmpty')
+            return null;
+        return new photo_js_1.Photo(this.invite.photo);
+    }
+    /**
+     * Preview of some of the chat members.
+     *
+     * This usually contains around 10 members,
+     * and members that are inside your contacts list are
+     * ordered before others.
+     */
+    get someMembers() {
+        return this.invite.participants?.map((it) => new user_js_1.User(it)) ?? [];
+    }
+    /**
+     * Whether by using this link you'll also need
+     * to wait for admin approval.
+     */
+    get withApproval() {
+        return this.invite.requestNeeded;
+    }
+}
+exports.ChatPreview = ChatPreview;
+(0, memoize_js_1.memoizeGetters)(ChatPreview, ['photo', 'someMembers']);
+(0, index_js_1.makeInspectable)(ChatPreview, ['link']);
+//# sourceMappingURL=chat-preview.js.map

package/cjs/highlevel/types/peers/chat-preview.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chat-preview.js","sourceRoot":"","sources":["../../../../../src/highlevel/types/peers/chat-preview.ts"],"names":[],"mappings":";;;AAEA,mDAAsD;AACtD,uDAAuD;AACvD,gDAAyC;AACzC,uCAAgC;AAUhC,MAAa,WAAW;IACpB,YACa,MAAwB;IACjC;;OAEG;IACM,IAAY;QAJZ,WAAM,GAAN,MAAM,CAAkB;QAIxB,SAAI,GAAJ,IAAI,CAAQ;IACtB,CAAC;IAEJ;;OAEG;IACH,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAA;IAC5B,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACJ,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS;YAAE,OAAO,SAAS,CAAA;QAC3C,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO;YAAE,OAAO,YAAY,CAAA;QAErE,OAAO,OAAO,CAAA;IAClB,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,MAAO,CAAA;IAC9B,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAA;IACxC,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACL,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,YAAY;YAAE,OAAO,IAAI,CAAA;QAErD,OAAO,IAAI,gBAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IACvC,CAAC;IAED;;;;;;OAMG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,cAAI,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAA;IACpE,CAAC;IAED;;;OAGG;IACH,IAAI,YAAY;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,aAAc,CAAA;IACrC,CAAC;CACJ;AAnED,kCAmEC;AAED,IAAA,2BAAc,EAAC,WAAW,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAA;AACrD,IAAA,0BAAe,EAAC,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAA","sourcesContent":["import { tl } from '@mtcute/tl'\n\nimport { makeInspectable } from '../../utils/index.js'\nimport { memoizeGetters } from '../../utils/memoize.js'\nimport { Photo } from '../media/photo.js'\nimport { User } from './user.js'\n\n/**\n * Chat type. Can be:\n *  - `group`: Legacy group\n *  - `supergroup`: Supergroup\n *  - `channel`: Broadcast channel\n */\nexport type ChatPreviewType = 'group' | 'supergroup' | 'channel'\n\nexport class ChatPreview {\n    constructor(\n        readonly invite: tl.RawChatInvite,\n        /**\n         * Original invite link used to fetch this preview\n         */\n        readonly link: string,\n    ) {}\n\n    /**\n     * Title of the chat\n     */\n    get title(): string {\n        return this.invite.title\n    }\n\n    /**\n     * Type of the chat\n     */\n    get type(): ChatPreviewType {\n        if (this.invite.broadcast) return 'channel'\n        if (this.invite.megagroup || this.invite.channel) return 'supergroup'\n\n        return 'group'\n    }\n\n    /**\n     * Whether this chat is public\n     */\n    get public(): boolean {\n        return this.invite.public!\n    }\n\n    /**\n     * Total chat member count\n     */\n    get memberCount(): number {\n        return this.invite.participantsCount\n    }\n\n    /**\n     * Chat photo\n     */\n    get photo(): Photo | null {\n        if (this.invite.photo._ === 'photoEmpty') return null\n\n        return new Photo(this.invite.photo)\n    }\n\n    /**\n     * Preview of some of the chat members.\n     *\n     * This usually contains around 10 members,\n     * and members that are inside your contacts list are\n     * ordered before others.\n     */\n    get someMembers(): ReadonlyArray<User> {\n        return this.invite.participants?.map((it) => new User(it)) ?? []\n    }\n\n    /**\n     * Whether by using this link you'll also need\n     * to wait for admin approval.\n     */\n    get withApproval(): boolean {\n        return this.invite.requestNeeded!\n    }\n}\n\nmemoizeGetters(ChatPreview, ['photo', 'someMembers'])\nmakeInspectable(ChatPreview, ['link'])\n"]}

package/cjs/highlevel/types/peers/chat.d.ts

@@ -0,0 +1,332 @@
+import { tl } from '@mtcute/tl';
+import { Photo } from '../media/photo.js';
+import { MessageEntity } from '../messages/message-entity.js';
+import { EmojiStatus } from '../reactions/emoji-status.js';
+import { ChatColors } from './chat-colors.js';
+import { ChatLocation } from './chat-location.js';
+import { ChatPermissions } from './chat-permissions.js';
+import { ChatPhoto } from './chat-photo.js';
+import { User } from './user.js';
+/**
+ * Chat type. Can be:
+ *  - `private`: PM with other users or yourself (Saved Messages)
+ *  - `bot`: PM with a bot
+ *  - `group`: Legacy group
+ *  - `supergroup`: Supergroup
+ *  - `channel`: Broadcast channel
+ *  - `gigagroup`: Gigagroup aka Broadcast group
+ */
+export type ChatType = 'private' | 'bot' | 'group' | 'supergroup' | 'channel' | 'gigagroup';
+/**
+ * A chat.
+ */
+export declare class Chat {
+    readonly fullPeer?: tl.RawUserFull | tl.TypeChatFull | undefined;
+    readonly type: "chat";
+    /**
+     * Raw peer object that this {@link Chat} represents.
+     */
+    readonly peer: tl.RawUser | tl.RawChat | tl.RawChannel | tl.RawChatForbidden | tl.RawChannelForbidden;
+    constructor(peer: tl.TypeUser | tl.TypeChat, fullPeer?: tl.RawUserFull | tl.TypeChatFull | undefined);
+    /** Marked ID of this chat */
+    get id(): number;
+    /**
+     * Whether this chat's information is incomplete.
+     *
+     * This usually only happens in large chats, where
+     * the server sometimes sends only a part of the chat's
+     * information. Basic info like name and profile photo
+     * are always available, but other fields may be omitted
+     * despite being available.
+     *
+     * It was observed that these fields may be missing:
+     *   - `isMember`
+     *   - and probably more
+     *
+     * This currently only ever happens for non-bot users, so if you are building
+     * a normal bot, you can safely ignore this field.
+     *
+     * To fetch the "complete" user information, use one of these methods:
+     *  - {@link TelegramClient.getChat}
+     *  - {@link TelegramClient.getFullChat}.
+     *
+     * Learn more: [Incomplete peers](https://mtcute.dev/guide/topics/peers.html#incomplete-peers)
+     */
+    get isMin(): boolean;
+    /**
+     * Chat's input peer for advanced use-cases.
+     *
+     * > **Note**: for {@link min} chats, this method will return
+     * > `mtcute.dummyInputPeerMin*`, which are actually not a valid input peer,
+     * > These are used to indicate that the user is incomplete, and a message
+     * > reference is needed to resolve the peer.
+     * >
+     * > Such objects are handled by {@link TelegramClient.resolvePeer} method,
+     * so prefer using it whenever you need an input peer.
+     */
+    get inputPeer(): tl.TypeInputPeer;
+    /** Type of chat */
+    get chatType(): ChatType;
+    /**
+     * Whether this chat is a group chat
+     * (i.e. not a channel and not PM)
+     */
+    get isGroup(): boolean;
+    /**
+     * Whether this chat has been verified by Telegram.
+     * Supergroups, channels and groups only
+     */
+    get isVerified(): boolean;
+    /**
+     * Whether this chat has been restricted.
+     * See {@link restrictions} for details
+     */
+    get isRestricted(): boolean;
+    /**
+     * Whether this chat is owned by the current user.
+     * Supergroups, channels and groups only
+     */
+    get isCreator(): boolean;
+    /**
+     * Whether current user has admin rights in this chat.
+     * Supergroups, channels and groups only.
+     */
+    get isAdmin(): boolean;
+    /** Whether this chat has been flagged for scam */
+    get isScam(): boolean;
+    /** Whether this chat has been flagged for impersonation */
+    get isFake(): boolean;
+    /** Whether this chat is part of the Telegram support team. Users and bots only */
+    get isSupport(): boolean;
+    /** Whether this chat is chat with yourself (i.e. Saved Messages) */
+    get isSelf(): boolean;
+    /** Whether this peer is your contact */
+    get isContact(): boolean;
+    /** Whether this peer is a forum supergroup */
+    get isForum(): boolean;
+    /**
+     * Whether the current user is a member of the chat.
+     *
+     * For users, this is always `true`.
+     */
+    get isMember(): boolean;
+    /** Whether you have hidden (arhived) this chat's stories */
+    get storiesHidden(): boolean;
+    get storiesUnavailable(): boolean;
+    /** Whether this group is a channel/supergroup with join requests enabled */
+    get hasJoinRequests(): boolean;
+    /** Whether this group is a supergroup with join-to-send rule enabled */
+    get hasJoinToSend(): boolean;
+    /** Whether this group has content protection (i.e. disabled forwards) */
+    get hasContentProtection(): boolean;
+    /**
+     * Whether this chat (user) has restricted sending them voice/video messages.
+     *
+     * Returned only in {@link TelegramClient.getFullChat}
+     */
+    get hasBlockedVoices(): boolean;
+    /**
+     * Title, for supergroups, channels and groups
+     */
+    get title(): string | null;
+    /**
+     * Username, for private chats, bots, supergroups and channels if available
+     */
+    get username(): string | null;
+    /**
+     * Usernames (inclufing collectibles), for private chats, bots, supergroups and channels if available
+     */
+    get usernames(): ReadonlyArray<tl.RawUsername> | null;
+    /**
+     * First name of the other party in a private chat,
+     * for private chats and bots
+     */
+    get firstName(): string | null;
+    /**
+     * Last name of the other party in a private chat, for private chats
+     */
+    get lastName(): string | null;
+    /**
+     * Get the display name of the chat.
+     *
+     * Title for groups and channels,
+     * name (and last name if available) for users
+     */
+    get displayName(): string;
+    /**
+     * Chat photo, if any.
+     * Suitable for downloads only.
+     *
+     * If full chat information is available, prefer {@link fullPhoto} instead.
+     */
+    get photo(): ChatPhoto | null;
+    /**
+     * Full information about this chat's photo, if any.
+     *
+     * Unlike {@link Chat.photo}, this field contains additional information
+     * about the photo, such as its date, more sizes, and is the only
+     * way to get the animated profile photo.
+     *
+     * This field takes into account any personal/fallback photo
+     * that the user may have set
+     *
+     * Only available in {@link TelegramClient.getFullChat}
+     */
+    get fullPhoto(): Photo | null;
+    /**
+     * A custom photo (set by the current user) that should be displayed
+     * instead of the actual chat photo.
+     *
+     * Currently only available for users.
+     * Returned only in {@link TelegramClient.getFullChat}
+     */
+    get personalPhoto(): Photo | null;
+    /**
+     * Actual profile photo of the user, bypassing the custom one.
+     *
+     * Returned only in {@link TelegramClient.getFullChat}
+     */
+    get realPhoto(): Photo | null;
+    /**
+     * A photo that the user has set to be shown
+     * in case their actual profile photo is not available
+     * due to privacy settings.
+     *
+     * Currently only available for users.
+     * Returned only in {@link TelegramClient.getFullChat}
+     */
+    get publicPhoto(): Photo | null;
+    /**
+     * Bio of the other party in a private chat, or description of a
+     * group, supergroup or channel.
+     *
+     * Returned only in {@link TelegramClient.getFullChat}
+     */
+    get bio(): string | null;
+    /**
+     * User's or bot's assigned DC (data center).
+     * Available only in case the user has set a public profile photo.
+     *
+     * **Note**: this information is approximate; it is based on where
+     * Telegram stores the current chat photo. It is accurate only in case
+     * the owner has set the chat photo, otherwise it will be the DC assigned
+     * to the administrator who set the current profile photo.
+     */
+    get dcId(): number | null;
+    /**
+     * Chat's permanent invite link, for groups, supergroups and channels.
+     * Returned only in {@link TelegramClient.getFullChat}
+     */
+    get inviteLink(): string | null;
+    /**
+     * For supergroups, name of the group sticker set.
+     * Returned only in {@link TelegramClient.getFullChat}
+     */
+    get stickerSetName(): string | null;
+    /**
+     * Whether the group sticker set can be changed by you.
+     * Returned only in {@link TelegramClient.getFullChat}
+     */
+    get canSetStickerSet(): boolean | null;
+    /**
+     * Chat members count, for groups, supergroups and channels only.
+     * Returned only in {@link TelegramClient.getFullChat}
+     */
+    get membersCount(): number | null;
+    /**
+     * The list of reasons why this chat might be unavailable to some users.
+     * This field is available only in case {@link isRestricted} is `true`
+     */
+    get restrictions(): ReadonlyArray<tl.RawRestrictionReason> | null;
+    /**
+     * Current user's permissions, for supergroups.
+     */
+    get permissions(): ChatPermissions | null;
+    /**
+     * Default chat member permissions, for groups and supergroups.
+     */
+    get defaultPermissions(): ChatPermissions | null;
+    /**
+     * Admin rights of the current user in this chat.
+     * `null` for PMs and non-administered chats
+     */
+    get adminRights(): tl.RawChatAdminRights | null;
+    /**
+     * Distance in meters of this group chat from your location
+     * Returned only in {@link TelegramClient.getNearbyChats}
+     */
+    readonly distance?: number;
+    /**
+     * Location of the chat.
+     * Returned only in {@link TelegramClient.getFullChat}
+     */
+    get location(): ChatLocation | null;
+    private _linkedChat?;
+    /**
+     * The linked discussion group (in case of channels)
+     * or the linked channel (in case of supergroups).
+     *
+     * Returned only in {@link TelegramClient.getFullChat}
+     */
+    get linkedChat(): Chat | null;
+    /**
+     * TTL of all messages in this chat, in seconds
+     *
+     * Returned only in {@link TelegramClient.getFullChat}
+     */
+    get ttlPeriod(): number | null;
+    /**
+     * Maximum ID of stories this chat has (or 0 if none)
+     */
+    get storiesMaxId(): number;
+    /**
+     * Color that should be used when rendering replies to
+     * the messages and web previews sent by this chat,
+     * as well as to render the chat title
+     */
+    get color(): ChatColors;
+    /**
+     * Chat's emoji status, if any.
+     */
+    get emojiStatus(): EmojiStatus | null;
+    /**
+     * Color that should be used when rendering the header of
+     * the user's profile
+     *
+     * If `null`, a generic header should be used instead
+     */
+    get profileColors(): ChatColors;
+    /** Boosts level this chat has (0 if none or is not a channel) */
+    get boostsLevel(): number;
+    /**
+     * Get a {@link User} from this chat.
+     *
+     * Returns `null` if this is not a chat with user
+     */
+    get user(): User | null;
+    /**
+     * Create a mention for the chat.
+     *
+     * If this is a user, works just like {@link User.mention}.
+     * Otherwise, if the chat has a username, a `@username` is created
+     * (or text link, if `text` is passed). If it does not, chat title is
+     * simply returned without additional formatting.
+     *
+     * When available and `text` is omitted, this method will return `@username`.
+     * Otherwise, text mention is created for the given (or default) parse mode
+     *
+     * Use `null` as `text` (first parameter) to force create a text
+     * mention with display name, even if there is a username.
+     *
+     * > **Note**: This method doesn't format anything on its own.
+     * > Instead, it returns a {@link MessageEntity} that can later
+     * > be used with `html` or `md` template tags, or `unparse` method directly.
+     *
+     * @param text  Text of the mention.
+     * @example
+     * ```typescript
+     * msg.replyText(html`Hello, ${msg.chat.mention()`)
+     * ```
+     */
+    mention(text?: string | null): string | MessageEntity;
+}