@mtcute/core 0.16.7 → 0.16.9

package/highlevel/types/peers/chat-event/actions.d.ts

@@ -0,0 +1,279 @@
+import { tl } from '@mtcute/tl';
+import { Photo } from '../../media/photo.js';
+import { Message } from '../../messages/message.js';
+import { ChatInviteLink } from '../chat-invite-link.js';
+import { ChatLocation } from '../chat-location.js';
+import { ChatMember } from '../chat-member.js';
+import { ChatPermissions } from '../chat-permissions.js';
+import { ForumTopic } from '../forum-topic.js';
+import { PeersIndex } from '../peers-index.js';
+import { User } from '../user.js';
+/** A user has joined the channel (in the case of big groups, info of the user that has joined isn't shown) */
+export interface ChatActionUserJoined {
+    type: 'user_joined';
+}
+/** A user has joined the channel using an invite link */
+export interface ChatActionUserJoinedInvite {
+    type: 'user_joined_invite';
+    /** Invite link user to join */
+    link: ChatInviteLink;
+}
+/** A user has joined the channel using an invite link and was approved by an admin */
+export interface ChatActionUserJoinedApproved {
+    type: 'user_joined_approved';
+    /** Invite link user to join */
+    link: ChatInviteLink;
+    /** User who approved the join */
+    approvedBy: User;
+}
+/** A user has left the channel (in the case of big groups, info of the user that has joined isn't shown) */
+export interface ChatActionUserLeft {
+    type: 'user_left';
+}
+/** A user was invited to the channel */
+export interface ChatActionUserInvited {
+    type: 'user_invited';
+    /** Member who has been invited */
+    member: ChatMember;
+}
+/** Channel title has been changed */
+export interface ChatActionTitleChanged {
+    type: 'title_changed';
+    /** Old chat title */
+    old: string;
+    /** New chat title */
+    new: string;
+}
+/** Channel description has been changed */
+export interface ChatActionDescriptionChanged {
+    type: 'description_changed';
+    /** Old description */
+    old: string;
+    /** New description */
+    new: string;
+}
+/** Channel username has been changed */
+export interface ChatActionUsernameChanged {
+    type: 'username_changed';
+    /** Old username */
+    old: string;
+    /** New username */
+    new: string;
+}
+/** Channel username list has been changed */
+export interface ChatActionUsernamesChanged {
+    type: 'usernames_changed';
+    /** Old username */
+    old: string[];
+    /** New username */
+    new: string[];
+}
+/** Channel photo has been changed */
+export interface ChatActionPhotoChanged {
+    type: 'photo_changed';
+    /** Old photo */
+    old: Photo;
+    /** New photo */
+    new: Photo;
+}
+/** Invites were enabled/disabled */
+export interface ChatActionInvitesToggled {
+    type: 'invites_toggled';
+    /** Old value */
+    old: boolean;
+    /** New value */
+    new: boolean;
+}
+/** Signatures were enabled/disabled */
+export interface ChatActionSignaturesToggled {
+    type: 'signatures_toggled';
+    /** Old value */
+    old: boolean;
+    /** New value */
+    new: boolean;
+}
+/** A message has been pinned */
+export interface ChatActionMessagePinned {
+    type: 'msg_pinned';
+    /** Message which was pinned */
+    message: Message;
+}
+/** A message has been edited */
+export interface ChatActionMessageEdited {
+    type: 'msg_edited';
+    /** Old message */
+    old: Message;
+    /** New message */
+    new: Message;
+}
+/** A message has been deleted */
+export interface ChatActionMessageDeleted {
+    type: 'msg_deleted';
+    /** Message which was deleted */
+    message: Message;
+}
+/** User's permissions were changed */
+export interface ChatActionUserPermissionsChanged {
+    type: 'user_perms_changed';
+    /** Information about member before change */
+    old: ChatMember;
+    /** Information about member after change */
+    new: ChatMember;
+}
+/** User's admin permissions were changed */
+export interface ChatActionUserAdminPermissionsChanged {
+    type: 'user_admin_perms_changed';
+    /** Information about member before change */
+    old: ChatMember;
+    /** Information about member after change */
+    new: ChatMember;
+}
+/** Group stickerset has been changed */
+export interface ChatActionStickersetChanged {
+    type: 'stickerset_changed';
+    /** Old stickerset */
+    old: tl.TypeInputStickerSet;
+    /** New stickerset */
+    new: tl.TypeInputStickerSet;
+}
+/** History visibility for new users has been toggled */
+export interface ChatActionHistoryToggled {
+    type: 'history_toggled';
+    /** Old value (`false` if new users can see history) */
+    old: boolean;
+    /** New value (`false` if new users can see history) */
+    new: boolean;
+}
+/** Group default permissions have been changed */
+export interface ChatActionDefaultPermissionsChanged {
+    type: 'def_perms_changed';
+    /** Old default permissions */
+    old: ChatPermissions;
+    /** New default permissions */
+    new: ChatPermissions;
+}
+/** Poll has been stopped */
+export interface ChatActionPollStopped {
+    type: 'poll_stopped';
+    /** Message containing the poll */
+    message: Message;
+}
+/** Linked chat has been changed */
+export interface ChatActionLinkedChatChanged {
+    type: 'linked_chat_changed';
+    /** ID of the old linked chat */
+    old: number;
+    /** ID of the new linked chat */
+    new: number;
+}
+/** Group location has been changed */
+export interface ChatActionLocationChanged {
+    type: 'location_changed';
+    /** Old location */
+    old: ChatLocation | null;
+    /** New location */
+    new: ChatLocation | null;
+}
+/** Group slow mode delay has been changed */
+export interface ChatActionSlowModeChanged {
+    type: 'slow_mode_changed';
+    /** Old delay (can be 0) */
+    old: number;
+    /** New delay (can be 0) */
+    new: number;
+}
+/** Group call has been started */
+export interface ChatActionCallStarted {
+    type: 'call_started';
+    /** TL object representing the call */
+    call: tl.TypeInputGroupCall;
+}
+/** Group call has ended */
+export interface ChatActionCallEnded {
+    type: 'call_ended';
+    /** TL object representing the call */
+    call: tl.TypeInputGroupCall;
+}
+/** Group call "join muted" setting has been changed */
+export interface ChatActionCallSettingChanged {
+    type: 'call_setting_changed';
+    /** Whether new call participants should join muted */
+    joinMuted: boolean;
+}
+/** Invite link has been deleted */
+export interface ChatActionInviteLinkDeleted {
+    type: 'invite_deleted';
+    /** Invite link which was deleted */
+    link: ChatInviteLink;
+}
+/** Invite link has been edited */
+export interface ChatActionInviteLinkEdited {
+    type: 'invite_edited';
+    /** Old invite link */
+    old: ChatInviteLink;
+    /** New invite link */
+    new: ChatInviteLink;
+}
+/** Invite link has been revoked */
+export interface ChatActionInviteLinkRevoked {
+    type: 'invite_revoked';
+    /** Invite link which was revoked */
+    link: ChatInviteLink;
+}
+/** History TTL has been changed */
+export interface ChatActionTtlChanged {
+    type: 'ttl_changed';
+    /** Old TTL value (can be 0) */
+    old: number;
+    /** New TTL value (can be 0) */
+    new: number;
+}
+/** Content protection has been toggled */
+export interface ChatActionNoForwardsToggled {
+    type: 'no_forwards_toggled';
+    /** New status */
+    enabled: boolean;
+}
+/** Forum has been toggled */
+export interface ChatActionForumToggled {
+    type: 'forum_toggled';
+    /** New status */
+    enabled: boolean;
+}
+/** Forum topic has been created */
+export interface ChatActionTopicCreated {
+    type: 'topic_created';
+    /** Topic that has been created */
+    topic: ForumTopic;
+}
+/** Forum topic has been edited */
+export interface ChatActionTopicEdited {
+    type: 'topic_edited';
+    /** Old topic info */
+    old: ForumTopic;
+    /** New topic info */
+    new: ForumTopic;
+}
+/** Forum topic has been edited */
+export interface ChatActionTopicDeleted {
+    type: 'topic_deleted';
+    /** Old topic info */
+    topic: ForumTopic;
+}
+/** Profile signatures were toggled in a channel ("Super Channel" mode) */
+export interface ChatActionSignatureProfilesToggled {
+    type: 'signature_profiles_toggled';
+    /** Whether signatures are enabled as of this action */
+    new: boolean;
+}
+export interface ChatActionSubscriptionExtended {
+    type: 'sub_extend';
+    /** Previous participant information */
+    prev: ChatMember;
+    /** New participant information */
+    new: ChatMember;
+}
+/** Chat event action (`null` if unsupported) */
+export type ChatAction = ChatActionUserJoined | ChatActionUserLeft | ChatActionUserInvited | ChatActionTitleChanged | ChatActionDescriptionChanged | ChatActionUsernameChanged | ChatActionUsernamesChanged | ChatActionPhotoChanged | ChatActionInvitesToggled | ChatActionSignaturesToggled | ChatActionMessagePinned | ChatActionMessageEdited | ChatActionMessageDeleted | ChatActionUserPermissionsChanged | ChatActionUserAdminPermissionsChanged | ChatActionStickersetChanged | ChatActionHistoryToggled | ChatActionDefaultPermissionsChanged | ChatActionPollStopped | ChatActionLinkedChatChanged | ChatActionLocationChanged | ChatActionSlowModeChanged | ChatActionCallStarted | ChatActionCallEnded | ChatActionCallSettingChanged | ChatActionUserJoinedInvite | ChatActionInviteLinkDeleted | ChatActionInviteLinkEdited | ChatActionInviteLinkRevoked | ChatActionUserJoinedApproved | ChatActionTtlChanged | ChatActionNoForwardsToggled | ChatActionForumToggled | ChatActionTopicCreated | ChatActionTopicEdited | ChatActionTopicDeleted | ChatActionSignatureProfilesToggled | ChatActionSubscriptionExtended | null;
+/** @internal */
+export declare function _actionFromTl(e: tl.TypeChannelAdminLogEventAction, peers: PeersIndex): ChatAction;

package/highlevel/types/peers/chat-event/filters.d.ts

@@ -0,0 +1,10 @@
+import { tl } from '@mtcute/tl';
+import { MaybeArray } from '../../../../types/utils.js';
+import { ChatAction } from './actions.js';
+export interface ChatEventFilters {
+    serverFilter?: tl.TypeChannelAdminLogEventsFilter;
+    localFilter?: Record<string, true>;
+}
+export type InputChatEventFilters = ChatEventFilters | tl.TypeChannelAdminLogEventsFilter | MaybeArray<Exclude<ChatAction, null>['type']> | undefined;
+/** @internal */
+export declare function normalizeChatEventFilters(input: InputChatEventFilters): ChatEventFilters;

package/highlevel/types/peers/chat-event/index.d.ts

@@ -0,0 +1,27 @@
+import { tl } from '@mtcute/tl';
+import { PeersIndex } from '../peers-index.js';
+import { User } from '../user.js';
+import { ChatAction } from './actions.js';
+export * from './actions.js';
+export type { ChatEventFilters, InputChatEventFilters } from './filters.js';
+export declare class ChatEvent {
+    readonly raw: tl.TypeChannelAdminLogEvent;
+    readonly _peers: PeersIndex;
+    constructor(raw: tl.TypeChannelAdminLogEvent, _peers: PeersIndex);
+    /**
+     * Event ID.
+     *
+     * Event IDs are generated in direct chronological order
+     * (i.e. newer events have bigger event ID)
+     */
+    get id(): tl.Long;
+    /**
+     * Date of the event
+     */
+    get date(): Date;
+    /**
+     * Actor of the event
+     */
+    get actor(): User;
+    get action(): ChatAction;
+}

package/highlevel/types/peers/chat-invite-link-member.d.ts

@@ -0,0 +1,33 @@
+import { tl } from '@mtcute/tl';
+import { PeersIndex } from './peers-index.js';
+import { User } from './user.js';
+export declare class ChatInviteLinkMember {
+    readonly raw: tl.RawChatInviteImporter;
+    readonly _peers: PeersIndex;
+    constructor(raw: tl.RawChatInviteImporter, _peers: PeersIndex);
+    /**
+     * User who joined the chat
+     */
+    get user(): User;
+    /**
+     * Date when the user joined the chat
+     */
+    get date(): Date;
+    /**
+     * Whether this user currently has a pending join request
+     * (and is actually not a member yet)
+     */
+    get isPendingRequest(): boolean;
+    /**
+     * Whether the participant joined by importing a chat folder deep link
+     */
+    get isViaChatlist(): boolean;
+    /**
+     * For users with pending requests, contains bio of the user that requested to join
+     */
+    get bio(): string | null;
+    /**
+     * The administrator that approved the join request of the user
+     */
+    get approvedBy(): User | null;
+}

package/highlevel/types/peers/chat-invite-link.d.ts

@@ -0,0 +1,72 @@
+import { tl } from '@mtcute/tl';
+import { User } from './user.js';
+import { PeersIndex } from './index.js';
+/**
+ * An invite link
+ */
+export declare class ChatInviteLink {
+    readonly _peers?: PeersIndex | undefined;
+    readonly raw: tl.RawChatInviteExported;
+    constructor(raw: tl.TypeExportedChatInvite, _peers?: PeersIndex | undefined);
+    /**
+     * The invite link as a `t.me/joinchat/` string.
+     *
+     * If the link was created by another administrator, the second
+     * part of the link will be censored with `...` (e.g. `https://t.me/joinchat/BGxxHIg4...`
+     *
+     * See also: {@link isMyLink}
+     */
+    get link(): string;
+    /**
+     * Whether this invite link was created by the current user.
+     *
+     * If so, {@link link} will be a full invite link.
+     */
+    get isMyLink(): boolean;
+    /**
+     * Creator of the invite link, if available
+     */
+    get creator(): User | null;
+    /**
+     * Creation date of the link
+     */
+    get date(): Date;
+    /**
+     * Whether this link is primary (i.e. "permanent")
+     */
+    get isPrimary(): boolean;
+    /**
+     * Whether this link was revoked and can't be used anymore
+     */
+    get isRevoked(): boolean;
+    /**
+     * The date since which the link will be valid (if any)
+     */
+    get startDate(): Date | null;
+    /**
+     * The date until which the link will be valid (if any)
+     */
+    get endDate(): Date | null;
+    /**
+     * 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` if unspecified
+     */
+    get usageLimit(): number;
+    /**
+     * Number of users currently in the chat that joined using this link
+     */
+    get usage(): number;
+    /**
+     * Whether users joined by this link need to be
+     * approved by the group administrator before they can join
+     */
+    get approvalNeeded(): boolean;
+    /**
+     * Number of users currently awaiting admin approval.
+     *
+     * 0 in case the link is not using approvals
+     */
+    get pendingApprovals(): number;
+}

package/highlevel/types/peers/chat-location.d.ts

@@ -0,0 +1,17 @@
+import { tl } from '@mtcute/tl';
+import { Location } from '../media/location.js';
+/**
+ * Geolocation of a supergroup
+ */
+export declare class ChatLocation {
+    readonly raw: tl.RawChannelLocation;
+    constructor(raw: tl.RawChannelLocation);
+    /**
+     * Location of the chat
+     */
+    get location(): Location;
+    /**
+     * Textual description of the address
+     */
+    get address(): string;
+}

package/highlevel/types/peers/chat-member.d.ts

@@ -0,0 +1,86 @@
+import { tl } from '@mtcute/tl';
+import { ChatPermissions } from './chat-permissions.js';
+import { User } from './user.js';
+import { PeersIndex } from './index.js';
+/**
+ * Status of the member:
+ *  - `creator`: user is the creator of the chat
+ *  - `admin`: user has admin rights in the chat
+ *  - `member`: user is a normal member of the chat
+ *  - `restricted`: user has some restrictions applied
+ *  - `banned`: user was banned from the chat
+ *  - `left`: user left the chat on their own
+ */
+export type ChatMemberStatus = 'creator' | 'admin' | 'member' | 'restricted' | 'banned' | 'left';
+/**
+ * Information about one chat member
+ */
+export declare class ChatMember {
+    readonly raw: tl.TypeChatParticipant | tl.TypeChannelParticipant;
+    readonly _peers: PeersIndex;
+    constructor(raw: tl.TypeChatParticipant | tl.TypeChannelParticipant, _peers: PeersIndex);
+    /**
+     * Information about the user
+     */
+    get user(): User;
+    /**
+     * Get the chat member status
+     */
+    get status(): ChatMemberStatus;
+    /**
+     * Custom title (for creators and admins).
+     *
+     * `null` for non-admins and in case custom title is not set.
+     */
+    get title(): string | null;
+    /**
+     * Date when the user has joined the chat.
+     *
+     * Not available for creators and left members
+     */
+    get joinedDate(): Date | null;
+    /**
+     * Information about whoever invited this member to the chat.
+     *
+     * Only available in the following cases:
+     *  - `user` is yourself
+     *  - `chat` is a legacy group
+     *  - `chat` is a supergroup/channel, and `user` is an admin
+     */
+    get invitedBy(): User | null;
+    /**
+     * Information about whoever promoted this admin.
+     *
+     * Only available if `status = admin`.
+     */
+    get promotedBy(): User | null;
+    /**
+     * Information about whoever restricted this user.
+     *
+     * Only available if `status = restricted or status = banned`
+     */
+    get restrictedBy(): User | null;
+    /**
+     * For restricted and banned users,
+     * information about the restrictions
+     */
+    get restrictions(): ChatPermissions | null;
+    /**
+     * Whether this member is a part of the chat now.
+     *
+     * Makes sense only when `status = restricted or staus = banned`
+     */
+    get isMember(): boolean;
+    /**
+     * For admins and creator of supergroup/channels,
+     * list of their admin permissions.
+     *
+     * Also contains whether this admin is anonymous.
+     */
+    get permissions(): tl.RawChatAdminRights | null;
+    /**
+     * If this member subscribed to a channel using Telegram Stars,
+     * this field will contain the date when the subscription will expire
+     */
+    get subscriptionUntilDate(): Date | null;
+}

package/highlevel/types/peers/chat-permissions.d.ts

@@ -0,0 +1,127 @@
+import { tl } from '@mtcute/tl';
+/**
+ * Represents the permissions of a user in a {@link Chat}.
+ */
+export declare class ChatPermissions {
+    readonly raw: tl.RawChatBannedRights;
+    constructor(bannedRights: tl.RawChatBannedRights);
+    /**
+     * Whether users can view messages
+     */
+    get canViewMessages(): boolean;
+    /**
+     * Whether users can send text messages,
+     * contacts, locations and venues
+     */
+    get canSendMessages(): boolean;
+    /**
+     * Whether users can send media messages,
+     * including documents, photos, videos, video notes and voice notes.
+     *
+     * Implies {@link canSendMessages}
+     */
+    get canSendMedia(): boolean;
+    /**
+     * Whether users can send stickers.
+     *
+     * Implies {@link canSendMedia}
+     */
+    get canSendStickers(): boolean;
+    /**
+     * Whether users can send GIFs.
+     *
+     * Implies {@link canSendMedia}
+     */
+    get canSendGifs(): boolean;
+    /**
+     * Whether users can send photos.
+     *
+     * Implies {@link canSendMedia}
+     */
+    get canSendPhotos(): boolean;
+    /**
+     * Whether users can send videos.
+     *
+     * Implies {@link canSendMedia}
+     */
+    get canSendVideos(): boolean;
+    /**
+     * Whether users can send round videos (i.e. video notes).
+     *
+     * Implies {@link canSendMedia}
+     */
+    get canSendRoundVideos(): boolean;
+    /**
+     * Whether users can send audio files.
+     *
+     * Implies {@link canSendMedia}
+     */
+    get canSendAudios(): boolean;
+    /**
+     * Whether users can send voice notes.
+     *
+     * Implies {@link canSendMedia}
+     */
+    get canSendVoices(): boolean;
+    /**
+     * Whether users can send files.
+     *
+     * Implies {@link canSendMedia}
+     */
+    get canSendFiles(): boolean;
+    /**
+     * Whether users can send games.
+     *
+     * Implies {@link canSendMedia}
+     */
+    get canSendGames(): boolean;
+    /**
+     * Whether users can use inline bots.
+     *
+     * Implies {@link canSendMedia}
+     */
+    get canUseInline(): boolean;
+    /**
+     * Whether users can use inline bots.
+     *
+     * Implies {@link canSendMedia}
+     */
+    get canAddWebPreviews(): boolean;
+    /**
+     * Whether users can send text messages.
+     *
+     * Implies {@link canSendMessages}
+     */
+    get canSendText(): boolean;
+    /**
+     * Whether users can send polls.
+     *
+     * Implies {@link canSendMessages}
+     */
+    get canSendPolls(): boolean;
+    /**
+     * Whether users can change the chat title,
+     * photo and other settings.
+     */
+    get canChangeInfo(): boolean;
+    /**
+     * Whether users can invite other users to the chat
+     */
+    get canInviteUsers(): boolean;
+    /**
+     * Whether users can pin messages
+     */
+    get canPinMessages(): boolean;
+    /**
+     * Whether users can pin messages
+     */
+    get canManageTopics(): boolean;
+    /**
+     * UNIX date until which these permissions are valid,
+     * or `null` if forever.
+     *
+     * For example, represents the time when the restrictions
+     * will be lifted from a {@link ChatMember}
+     */
+    get untilDate(): Date | null;
+}

package/highlevel/types/peers/chat-photo.d.ts

@@ -0,0 +1,39 @@
+import { tl } from '@mtcute/tl';
+import { FileLocation } from '../files/index.js';
+/**
+ * A size of a chat photo
+ */
+export declare class ChatPhotoSize extends FileLocation {
+    readonly peer: tl.TypeInputPeer;
+    readonly obj: tl.RawUserProfilePhoto | tl.RawChatPhoto;
+    readonly big: boolean;
+    constructor(peer: tl.TypeInputPeer, obj: tl.RawUserProfilePhoto | tl.RawChatPhoto, big: boolean);
+    /**
+     * TDLib and Bot API compatible File ID representing this size
+     */
+    get fileId(): string;
+    /**
+     * TDLib and Bot API compatible unique File ID representing this size
+     */
+    get uniqueFileId(): string;
+}
+/**
+ * A chat photo
+ */
+export declare class ChatPhoto {
+    readonly peer: tl.TypeInputPeer;
+    readonly raw: tl.RawUserProfilePhoto | tl.RawChatPhoto;
+    constructor(peer: tl.TypeInputPeer, raw: tl.RawUserProfilePhoto | tl.RawChatPhoto);
+    /**
+     * Whether this photo is personal (i.e. you set it yourself for this peer)
+     */
+    get isPersonal(): boolean;
+    /** Chat photo file location in small resolution (160x160) */
+    get small(): ChatPhotoSize;
+    /** Chat photo file location in big resolution (640x640) */
+    get big(): ChatPhotoSize;
+    /**
+     * Chat photo preview in *very* small resolution, if available
+     */
+    get thumb(): Uint8Array | null;
+}