zaileys 4.3.0 → 4.5.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { WAMessage, WAMessageKey, AnyMessageContent, MiscMessageGenerationOptions, Chat, Contact, PresenceData, WAPrivacyValue, WAPrivacyOnlineValue, WAReadReceiptsValue, WAPrivacyGroupAddValue, GroupMetadata, ParticipantAction, NewsletterMetadata, WAMediaUpload, AuthenticationCreds, SignalDataTypeMap, SignalDataSet, WASocket, UserFacingSocketConfig, SignalKeyStore, MessageUpsertType } from 'baileys';
-export { GroupMetadata, GroupParticipant, NewsletterMetadata, ParticipantAction, WAMediaUpload, WAPrivacyGroupAddValue, WAPrivacyOnlineValue, WAPrivacyValue, WAReadReceiptsValue } from 'baileys';
+import { WAMessage, WAMessageKey, AnyMessageContent, MiscMessageGenerationOptions, Chat, Contact, PresenceData, WAPrivacyValue, WAPrivacyOnlineValue, WAReadReceiptsValue, WAPrivacyGroupAddValue, GroupMetadata, ParticipantAction, WAMediaUpload, ChatModification, NewsletterMetadata, AuthenticationCreds, SignalDataTypeMap, SignalDataSet, WASocket, UserFacingSocketConfig, SignalKeyStore, MessageUpsertType } from 'baileys';
+export { GroupMetadata, GroupParticipant, NewsletterMetadata, ParticipantAction, WAMediaUpload, WAPrivacyGroupAddValue, WAPrivacyOnlineValue, WAPrivacyValue, WAReadReceiptsValue, areJidsSameUser, getDevice, isJidBroadcast, isJidGroup, isJidNewsletter, isLidUser, isPnUser, jidDecode, jidEncode, jidNormalizedUser } from 'baileys';
 import { Readable } from 'node:stream';
 import { Pool } from 'pg';
 import { RedisClientType } from 'redis';
@@ -15,6 +15,11 @@ type VideoOptions = {
     caption?: string;
     gifPlayback?: boolean;
     viewOnce?: boolean;
+    /** Send as a round video note (PTV). */
+    ptv?: boolean;
+};
+type VideoNoteOptions = {
+    viewOnce?: boolean;
 };
 type AudioOptions = {
     ptt?: boolean;
@@ -118,6 +123,44 @@ type TemplateOptions = {
     footer?: string;
     buttons: ButtonDef[];
 };
+type EventOptions = {
+    name: string;
+    description?: string;
+    startAt: Date | number;
+    endAt?: Date | number;
+    location?: {
+        latitude: number;
+        longitude: number;
+        name?: string;
+        address?: string;
+    };
+    call?: 'audio' | 'video';
+    canceled?: boolean;
+};
+type ProductOptions = {
+    image: MediaSource;
+    title: string;
+    businessOwnerId: string;
+    description?: string;
+    /** Price in currency units (e.g. 50 = 50.00); mapped to priceAmount1000. */
+    price?: number;
+    currency?: string;
+    productId?: string;
+    retailerId?: string;
+    url?: string;
+    body?: string;
+    footer?: string;
+};
+type GroupInviteOptions = {
+    jid: string;
+    code: string;
+    subject?: string;
+    caption?: string;
+    /** Unix seconds when the invite expires. Defaults to ~3 days from now. WhatsApp reads this as seconds. */
+    expiresAt?: number;
+    /** Optional JPEG thumbnail (group avatar) — improves how the card renders. */
+    thumbnail?: Buffer;
+};
 type BuilderContext = {
     recipient: string;
     quoted?: WAMessage | WAMessageKey;
@@ -199,6 +242,7 @@ declare class MessageBuilder<State extends BuilderState> {
     to(this: MessageBuilder<'init'>, recipient: string): MessageBuilder<'init'>;
     text(this: MessageBuilder<'init'>, content: string, opts?: TextOptions): MessageBuilder<'content-set'>;
     image(this: MessageBuilder<'init'>, src: MediaSource, opts?: ImageOptions): MessageBuilder<'content-set'>;
+    videoNote(this: MessageBuilder<'init'>, src: MediaSource, opts?: VideoNoteOptions): MessageBuilder<'content-set'>;
     video(this: MessageBuilder<'init'>, src: MediaSource, opts?: VideoOptions): MessageBuilder<'content-set'>;
     audio(this: MessageBuilder<'init'>, src: MediaSource, opts?: AudioOptions): MessageBuilder<'content-set'>;
     document(this: MessageBuilder<'init'>, src: MediaSource, opts: DocumentOptions): MessageBuilder<'content-set'>;
@@ -212,6 +256,12 @@ declare class MessageBuilder<State extends BuilderState> {
     location(this: MessageBuilder<'init'>, lat: number, lon: number, opts?: LocationOptions): MessageBuilder<'content-set'>;
     contact(this: MessageBuilder<'init'>, vcard: string): MessageBuilder<'content-set'>;
     template(this: MessageBuilder<'init'>, opts: TemplateOptions): MessageBuilder<'content-set'>;
+    event(this: MessageBuilder<'init'>, opts: EventOptions): MessageBuilder<'content-set'>;
+    groupInvite(this: MessageBuilder<'init'>, opts: GroupInviteOptions): MessageBuilder<'content-set'>;
+    product(this: MessageBuilder<'init'>, opts: ProductOptions): MessageBuilder<'content-set'>;
+    requestPhoneNumber(this: MessageBuilder<'init'>): MessageBuilder<'content-set'>;
+    sharePhoneNumber(this: MessageBuilder<'init'>): MessageBuilder<'content-set'>;
+    limitSharing(this: MessageBuilder<'init'>, enabled?: boolean): MessageBuilder<'content-set'>;
     album(this: MessageBuilder<'init'>, items: AlbumItem[]): MessageBuilder<'content-set'>;
     reply(quoted: WAMessage | WAMessageKey): MessageBuilder<State>;
     mentions(jids: string[]): MessageBuilder<State>;
@@ -239,6 +289,14 @@ type MessageStoreListOptions = {
     limit?: number;
     before?: number;
 };
+type PruneOptions = {
+    /** Delete messages whose `messageTimestamp` is strictly older than this epoch value, in **seconds** (matching stored `messageTimestamp`). */
+    olderThan?: number;
+    /** Keep only the newest N messages per chat. */
+    maxPerChat?: number;
+    /** Restrict pruning to chats whose jid passes this predicate. */
+    chatFilter?: (jid: string) => boolean;
+};
 type ScheduledJobRecord = {
     id: string;
     fireAt: number;
@@ -271,14 +329,21 @@ interface MessageStore {
     saveScheduledJob?(job: ScheduledJobRecord): Promise<void>;
     listScheduledJobs?(): Promise<ScheduledJobRecord[]>;
     deleteScheduledJob?(id: string): Promise<void>;
+    deleteMessage?(key: WAMessageKey): Promise<void>;
+    pruneMessages?(opts: PruneOptions): Promise<number>;
 }
 
 type DeleteOptions = {
     forEveryone?: boolean;
 };
+type PinOptions = {
+    /** Pin duration in seconds (WhatsApp offers 86400 / 604800 / 2592000). Defaults to 24h. */
+    duration?: number;
+};
 declare const deleteMessage: (socket: BuilderSocketLike, key: WAMessageKey, opts?: DeleteOptions) => Promise<void>;
 declare const reactToMessage: (socket: BuilderSocketLike, key: WAMessageKey, emoji: string) => Promise<WAMessageKey>;
 declare const forwardMessage: (socket: BuilderSocketLike, store: Pick<MessageStore, "getMessage">, key: WAMessageKey, to: string) => Promise<WAMessageKey>;
+declare const pinMessage: (socket: BuilderSocketLike, key: WAMessageKey, pin: boolean, opts?: PinOptions) => Promise<WAMessageKey>;
 
 interface UsernameResolveSocketLike {
     onWhatsApp(...phoneNumber: string[]): Promise<Array<{
@@ -359,6 +424,43 @@ interface DomainSocketLike {
     groupToggleEphemeral(jid: string, ephemeralExpiration: number): Promise<void>;
     groupSettingUpdate(jid: string, setting: 'announcement' | 'not_announcement' | 'locked' | 'unlocked'): Promise<void>;
     updateMemberLabel(jid: string, memberLabel: string): Promise<unknown>;
+    groupFetchAllParticipating(): Promise<{
+        [jid: string]: GroupMetadata;
+    }>;
+    groupGetInviteInfo(code: string): Promise<GroupMetadata>;
+    groupRequestParticipantsList(jid: string): Promise<Array<{
+        [k: string]: string;
+    }>>;
+    groupRequestParticipantsUpdate(jid: string, participants: string[], action: 'approve' | 'reject'): Promise<{
+        status: string;
+        jid: string;
+    }[]>;
+    groupJoinApprovalMode(jid: string, mode: 'on' | 'off'): Promise<void>;
+    groupMemberAddMode(jid: string, mode: 'admin_add' | 'all_member_add'): Promise<void>;
+    onWhatsApp(...jids: string[]): Promise<Array<{
+        jid: string;
+        exists: boolean;
+        lid?: string;
+    }> | undefined>;
+    addOrEditContact(jid: string, contact: {
+        firstName?: string;
+        lastName?: string;
+        fullName?: string;
+    }): Promise<unknown>;
+    removeContact(jid: string): Promise<unknown>;
+    getBusinessProfile(jid: string): Promise<unknown>;
+    getCatalog(opts: {
+        jid?: string;
+        limit?: number;
+        cursor?: string;
+    }): Promise<unknown>;
+    getCollections(jid?: string, limit?: number): Promise<unknown>;
+    getOrderDetails(orderId: string, tokenBase64: string): Promise<unknown>;
+    productCreate(create: Record<string, unknown>): Promise<unknown>;
+    productUpdate(productId: string, update: Record<string, unknown>): Promise<unknown>;
+    productDelete(productIds: string[]): Promise<{
+        deleted: number;
+    }>;
     updateLastSeenPrivacy(value: WAPrivacyValue): Promise<void>;
     updateOnlinePrivacy(value: WAPrivacyOnlineValue): Promise<void>;
     updateProfilePicturePrivacy(value: WAPrivacyValue): Promise<void>;
@@ -371,6 +473,13 @@ interface DomainSocketLike {
     }>;
     updateBlockStatus(jid: string, action: 'block' | 'unblock'): Promise<void>;
     fetchBlocklist(): Promise<string[]>;
+    updateProfileName(name: string): Promise<void>;
+    updateProfileStatus(status: string): Promise<void>;
+    updateProfilePicture(jid: string, content: WAMediaUpload): Promise<void>;
+    removeProfilePicture(jid: string): Promise<void>;
+    profilePictureUrl(jid: string, type?: 'image' | 'preview', timeoutMs?: number): Promise<string | undefined>;
+    fetchStatus(jid: string): Promise<unknown>;
+    chatModify(mod: ChatModification, jid: string): Promise<void>;
     newsletterCreate(name: string, description?: string): Promise<NewsletterMetadata>;
     newsletterFollow(jid: string): Promise<unknown>;
     newsletterUnfollow(jid: string): Promise<unknown>;
@@ -381,6 +490,13 @@ interface DomainSocketLike {
     newsletterMute(jid: string): Promise<unknown>;
     newsletterUnmute(jid: string): Promise<unknown>;
     newsletterDelete(jid: string): Promise<void>;
+    newsletterSubscribers(jid: string): Promise<unknown>;
+    newsletterRemovePicture(jid: string): Promise<unknown>;
+    newsletterReactMessage(jid: string, serverId: string, reaction?: string): Promise<void>;
+    newsletterFetchMessages(jid: string, count: number, since?: number, after?: number): Promise<unknown>;
+    newsletterAdminCount(jid: string): Promise<number>;
+    newsletterChangeOwner(jid: string, newOwnerJid: string): Promise<void>;
+    newsletterDemote(jid: string, userJid: string): Promise<void>;
     communityCreate(subject: string, body: string): Promise<GroupMetadata>;
     communityCreateGroup(subject: string, participants: string[], parentCommunityJid: string): Promise<GroupMetadata>;
     communityLinkGroup(groupJid: string, parentCommunityJid: string): Promise<void>;
@@ -396,6 +512,15 @@ interface DomainSocketLike {
     communityInviteCode(jid: string): Promise<string | undefined>;
     communityRevokeInvite(jid: string): Promise<string | undefined>;
     communityAcceptInvite(code: string): Promise<string | undefined>;
+    communityMetadata(jid: string): Promise<GroupMetadata>;
+    communityFetchAllParticipating(): Promise<{
+        [jid: string]: GroupMetadata;
+    }>;
+    communityGetInviteInfo(code: string): Promise<GroupMetadata>;
+    communityToggleEphemeral(jid: string, ephemeralExpiration: number): Promise<void>;
+    communitySettingUpdate(jid: string, setting: 'announcement' | 'not_announcement'): Promise<void>;
+    communityMemberAddMode(jid: string, mode: 'admin_add' | 'all_member_add'): Promise<void>;
+    communityJoinApprovalMode(jid: string, mode: 'on' | 'off'): Promise<void>;
 }
 
 declare class GroupModule {
@@ -420,6 +545,15 @@ declare class GroupModule {
     acceptInvite(code: string): Promise<string>;
     toggleEphemeral(groupId: string, seconds: number): Promise<void>;
     setting(groupId: string, setting: 'announcement' | 'not_announcement' | 'locked' | 'unlocked'): Promise<void>;
+    list(): Promise<GroupMetadata[]>;
+    inviteInfo(code: string): Promise<GroupMetadata>;
+    joinRequests(groupId: string): Promise<Array<{
+        [k: string]: string;
+    }>>;
+    approveJoin(groupId: string, jids: string[]): Promise<ParticipantUpdateResult[]>;
+    rejectJoin(groupId: string, jids: string[]): Promise<ParticipantUpdateResult[]>;
+    joinApproval(groupId: string, enabled: boolean): Promise<void>;
+    memberAddMode(groupId: string, adminsOnly: boolean): Promise<void>;
 }
 
 declare class PrivacyModule {
@@ -455,6 +589,18 @@ declare class NewsletterModule {
     mute(jid: string): Promise<void>;
     unmute(jid: string): Promise<void>;
     delete(jid: string): Promise<void>;
+    removePicture(jid: string): Promise<void>;
+    react(jid: string, serverId: string, emoji: string): Promise<void>;
+    /** Remove a reaction from a newsletter message. */
+    unreact(jid: string, serverId: string): Promise<void>;
+    subscribers(jid: string): Promise<unknown>;
+    messages(jid: string, count?: number, opts?: {
+        since?: number;
+        after?: number;
+    }): Promise<unknown>;
+    adminCount(jid: string): Promise<number>;
+    changeOwner(jid: string, newOwnerJid: string): Promise<void>;
+    demote(jid: string, userJid: string): Promise<void>;
 }
 
 declare class CommunityModule {
@@ -474,6 +620,92 @@ declare class CommunityModule {
     inviteCode(communityId: string): Promise<string | undefined>;
     revokeInvite(communityId: string): Promise<string | undefined>;
     acceptInvite(code: string): Promise<string | undefined>;
+    metadata(communityId: string): Promise<GroupMetadata>;
+    list(): Promise<GroupMetadata[]>;
+    inviteInfo(code: string): Promise<GroupMetadata>;
+    toggleEphemeral(communityId: string, seconds: number): Promise<void>;
+    setting(communityId: string, setting: 'announcement' | 'not_announcement'): Promise<void>;
+    memberAddMode(communityId: string, adminsOnly: boolean): Promise<void>;
+    joinApproval(communityId: string, enabled: boolean): Promise<void>;
+}
+
+declare class ProfileModule {
+    private readonly getSocket;
+    constructor(getSocket: () => DomainSocketLike | undefined);
+    protected requireSocket(): DomainSocketLike;
+    setName(name: string): Promise<void>;
+    setStatus(status: string): Promise<void>;
+    /** Set the profile/group picture. `jid` defaults to self; pass a group jid to set a group avatar. */
+    setPicture(jid: string, image: WAMediaUpload): Promise<void>;
+    removePicture(jid: string): Promise<void>;
+    getPicture(jid: string, hd?: boolean): Promise<string | null>;
+    getStatus(jid: string): Promise<unknown>;
+}
+
+type LastMessage = {
+    key: WAMessageKey;
+    messageTimestamp: number;
+};
+type LastMessageResolver = (jid: string) => Promise<LastMessage[]>;
+declare class ChatModule {
+    private readonly getSocket;
+    private readonly resolveLast?;
+    constructor(getSocket: () => DomainSocketLike | undefined, resolveLast?: LastMessageResolver | undefined);
+    protected requireSocket(): DomainSocketLike;
+    private last;
+    archive(jid: string): Promise<void>;
+    unarchive(jid: string): Promise<void>;
+    pin(jid: string): Promise<void>;
+    unpin(jid: string): Promise<void>;
+    /** Mute for `durationMs` (e.g. 8h = 28_800_000). Omit to mute indefinitely. */
+    mute(jid: string, durationMs?: number): Promise<void>;
+    unmute(jid: string): Promise<void>;
+    markRead(jid: string): Promise<void>;
+    markUnread(jid: string): Promise<void>;
+    star(key: WAMessageKey, starred?: boolean): Promise<void>;
+    unstar(key: WAMessageKey): Promise<void>;
+    delete(jid: string): Promise<void>;
+    clear(jid: string): Promise<void>;
+}
+
+type ContactCheckResult = {
+    jid: string;
+    exists: boolean;
+    lid?: string;
+};
+declare class ContactModule {
+    private readonly getSocket;
+    private readonly normalize;
+    constructor(getSocket: () => DomainSocketLike | undefined, normalize: (input: string) => string);
+    protected requireSocket(): DomainSocketLike;
+    /** Check whether phone numbers are on WhatsApp; returns the resolved jid + existence per input. */
+    check(...numbers: string[]): Promise<ContactCheckResult[]>;
+    exists(number: string): Promise<boolean>;
+    save(jid: string, name: {
+        firstName?: string;
+        lastName?: string;
+        fullName?: string;
+    }): Promise<void>;
+    remove(jid: string): Promise<void>;
+}
+
+declare class BusinessModule {
+    private readonly getSocket;
+    constructor(getSocket: () => DomainSocketLike | undefined);
+    protected requireSocket(): DomainSocketLike;
+    profile(jid: string): Promise<unknown>;
+    catalog(opts?: {
+        jid?: string;
+        limit?: number;
+        cursor?: string;
+    }): Promise<unknown>;
+    collections(jid?: string, limit?: number): Promise<unknown>;
+    orderDetails(orderId: string, tokenBase64: string): Promise<unknown>;
+    createProduct(create: Record<string, unknown>): Promise<unknown>;
+    updateProduct(productId: string, update: Record<string, unknown>): Promise<unknown>;
+    deleteProduct(...productIds: string[]): Promise<{
+        deleted: number;
+    }>;
 }
 
 interface SenderInfo {
@@ -662,7 +894,7 @@ type InboundEventMap = {
 };
 type InboundEventName = keyof InboundEventMap;
 
-type ChatType = 'text' | 'image' | 'video' | 'audio' | 'document' | 'sticker' | 'poll' | 'contact' | 'location' | 'live-location' | 'event' | 'buttons' | 'list' | 'interactive' | 'template' | 'unknown';
+type ChatType = 'text' | 'image' | 'video' | 'audio' | 'document' | 'sticker' | 'poll' | 'contact' | 'location' | 'live-location' | 'event' | 'album' | 'group-invite' | 'product' | 'order' | 'payment' | 'buttons' | 'list' | 'interactive' | 'template' | 'unknown';
 type SenderDevice = 'unknown' | 'android' | 'ios' | 'web' | 'desktop' | string;
 interface CitationConfig {
     authors?: string[] | ((jid: string) => boolean | Promise<boolean>);
@@ -708,6 +940,54 @@ interface LocationMedia {
     speed: number | null;
     caption: string | null;
 }
+interface AlbumMedia {
+    type: 'album';
+    expectedImageCount: number | null;
+    expectedVideoCount: number | null;
+}
+interface GroupInviteMedia {
+    type: 'group-invite';
+    groupId: string | null;
+    groupName: string | null;
+    inviteCode: string | null;
+    caption: string | null;
+    expiresAt: number | null;
+}
+interface ProductMedia {
+    type: 'product';
+    productId: string | null;
+    title: string | null;
+    description: string | null;
+    price: number | null;
+    currency: string | null;
+    retailerId: string | null;
+    url: string | null;
+    businessOwnerId: string | null;
+}
+interface OrderMedia {
+    type: 'order';
+    orderId: string | null;
+    title: string | null;
+    itemCount: number | null;
+    total: number | null;
+    currency: string | null;
+    status: string | null;
+    message: string | null;
+}
+interface PaymentMedia {
+    type: 'payment';
+    kind: 'request' | 'send' | 'invite';
+    amount: number | null;
+    currency: string | null;
+    note: string | null;
+    expiresAt: number | null;
+}
+interface LinkPreviewMedia {
+    type: 'link';
+    url: string | null;
+    title: string | null;
+    description: string | null;
+}
 interface EventMedia {
     type: 'event';
     name: string | null;
@@ -758,7 +1038,7 @@ interface TemplateMedia {
     text: string | null;
     buttons: MessageButton[];
 }
-type ContextMedia = MediaAttachment | PollMedia | ContactMedia | LocationMedia | EventMedia | ButtonsMedia | ListMedia | InteractiveMedia | TemplateMedia;
+type ContextMedia = MediaAttachment | PollMedia | ContactMedia | LocationMedia | EventMedia | AlbumMedia | GroupInviteMedia | ProductMedia | OrderMedia | PaymentMedia | LinkPreviewMedia | ButtonsMedia | ListMedia | InteractiveMedia | TemplateMedia;
 interface MessageContext {
     uniqueId: string;
     staticId: string;
@@ -830,6 +1110,7 @@ interface BuildContextInput {
     isNewsletter: boolean;
     prefixes: string[];
     citationConfig?: CitationConfig;
+    lidMap?: Map<string, string>;
     resolveRoomName: () => Promise<string | null>;
     resolveReceiverName: () => Promise<string | null>;
     resolveReplied: () => Promise<MessageContext | null>;
@@ -837,6 +1118,11 @@ interface BuildContextInput {
     react: (emoji: string) => Promise<WAMessageKey>;
     media?: ContextMedia;
 }
+declare const extractLinks: (text: string) => string[];
+declare const computeUniqueId: (key: WAMessageKey) => string;
+declare const computeStaticId: (roomId: string | null, senderId: string) => string;
+declare const epochSecondsToMs: (value: unknown) => number;
+declare const senderDeviceOf: (jid: string) => SenderDevice;
 declare const buildMessageContext: (input: BuildContextInput) => MessageContext;
 
 type CommandPrefix = string | string[];
@@ -887,6 +1173,7 @@ declare class CommandRegistry {
         def: CommandDefinition;
         args: string[];
     } | undefined;
+    unregister(spec: string): void;
     list(): CommandDefinition[];
 }
 
@@ -913,6 +1200,35 @@ interface AuthStoreBundle {
     readonly signal: AuthStore;
 }
 
+type AutoDeleteOptions = {
+    maxAgeMs?: number;
+    maxPerChat?: number;
+    intervalMs?: number;
+    chats?: 'all' | ((jid: string) => boolean);
+};
+declare function genericPrune(store: MessageStore, opts: PruneOptions): Promise<number>;
+declare class AutoDeleteSweeper {
+    private readonly store;
+    private readonly options;
+    private readonly logger;
+    private readonly now;
+    private timer;
+    private running;
+    private warnedUnsupported;
+    private disabled;
+    constructor(deps: {
+        store: MessageStore;
+        options: AutoDeleteOptions;
+        logger?: Logger;
+        now?: () => number;
+    });
+    private get active();
+    private buildPruneOptions;
+    runOnce(): Promise<number>;
+    start(): void;
+    stop(): void;
+}
+
 type WAPresence = 'unavailable' | 'available' | 'composing' | 'recording' | 'paused';
 interface AutomationSocketLike {
     sendPresenceUpdate(type: WAPresence, toJid?: string): Promise<void>;
@@ -986,6 +1302,29 @@ declare function isRateLimited(reason: DisconnectReasonDomain): boolean;
 declare function shouldClearAuth(reason: DisconnectReasonDomain): boolean;
 declare function shouldReconnect(reason: DisconnectReasonDomain): boolean;
 
+interface PluginContext {
+    client: Client;
+    logger: Logger | undefined;
+    pluginDir: string;
+    command(spec: string, handler: CommandHandler): void;
+    use(middleware: Middleware): void;
+    on<E extends keyof ClientEventMap>(event: E, handler: (payload: ClientEventMap[E]) => void): () => void;
+    once<E extends keyof ClientEventMap>(event: E, handler: (payload: ClientEventMap[E]) => void): () => void;
+}
+interface Plugin {
+    name: string;
+    setup(ctx: PluginContext): void | (() => void) | Promise<void | (() => void)>;
+    onUnload?(): void | Promise<void>;
+}
+type PluginsOptions = {
+    dir?: string;
+    watch?: boolean;
+    pattern?: RegExp;
+    ignore?: RegExp;
+    onError?: (err: unknown, file: string) => void;
+};
+declare const definePlugin: (plugin: Plugin) => Plugin;
+
 type ConnectionState = 'idle' | 'connecting' | 'qr-pending' | 'pairing-pending' | 'connected' | 'reconnecting' | 'disconnecting' | 'disconnected';
 type ConnectionAuthType = 'qr' | 'pairing';
 interface Logger {
@@ -1028,6 +1367,10 @@ interface ClientOptions {
     presence?: PresenceThrottleOptions;
     /** Max scheduled messages dispatched per second, smoothing backlog bursts. Default `1`; `0` disables. */
     scheduleRateLimitPerSec?: number;
+    /** Periodically prune old messages from the store. Enabled by default with a 1-month `maxAgeMs`; pass `false` to disable or override any field. */
+    autoDelete?: AutoDeleteOptions | false;
+    /** Load and manage plugins from a directory. */
+    plugins?: PluginsOptions;
 }
 type ConnectionEventMap = {
     connect: {
@@ -1281,6 +1624,10 @@ declare class Client extends TypedEventEmitter<ClientEventMap> {
     private _privacy?;
     private _newsletter?;
     private _community?;
+    private _profile?;
+    private _chat?;
+    private _contact?;
+    private _business?;
     private commandRegistry?;
     private readonly commandMiddleware;
     private readonly commandPrefixes;
@@ -1289,6 +1636,11 @@ declare class Client extends TypedEventEmitter<ClientEventMap> {
     private commandDispatcher;
     private _presence?;
     private _scheduler?;
+    private readonly autoDeleteOptions;
+    private autoDeleteSweeper;
+    private readonly pluginsOptions;
+    private pluginRegistry;
+    private pluginLoader;
     private waVersion?;
     private versionWarming?;
     constructor(options?: ClientOptions);
@@ -1302,6 +1654,10 @@ declare class Client extends TypedEventEmitter<ClientEventMap> {
     get privacy(): PrivacyModule;
     get newsletter(): NewsletterModule;
     get community(): CommunityModule;
+    get profile(): ProfileModule;
+    get chat(): ChatModule;
+    get contact(): ContactModule;
+    get business(): BusinessModule;
     get presence(): PresenceModule;
     broadcast(jids: string[], build: (b: MessageBuilder<'init'>) => MessageBuilder<'content-set'>, options?: BroadcastOptions): Promise<BroadcastResult>;
     scheduleAt(date: Date, build: (b: MessageBuilder<'init'>) => MessageBuilder<'content-set'>): Promise<ScheduleHandle>;
@@ -1311,7 +1667,9 @@ declare class Client extends TypedEventEmitter<ClientEventMap> {
     disconnect(): Promise<void>;
     logout(): Promise<void>;
     command(spec: string, handler: CommandHandler): this;
+    unregisterCommand(spec: string): this;
     use(middleware: Middleware): this;
+    unuse(middleware: Middleware): this;
     private attachCommandsIfReady;
     private buildCommandContext;
     private detachCommands;
@@ -1320,6 +1678,9 @@ declare class Client extends TypedEventEmitter<ClientEventMap> {
     delete(key: WAMessageKey, opts?: DeleteOptions): Promise<void>;
     react(key: WAMessageKey, emoji: string): Promise<WAMessageKey>;
     forward(key: WAMessageKey, to: string): Promise<WAMessageKey>;
+    pin(key: WAMessageKey, opts?: PinOptions): Promise<WAMessageKey>;
+    unpin(key: WAMessageKey): Promise<WAMessageKey>;
+    setDisappearing(to: string, seconds: number): Promise<void>;
     private resolveRecipient;
     private requireSocket;
     private attachEmitterLogger;
@@ -1329,7 +1690,11 @@ declare class Client extends TypedEventEmitter<ClientEventMap> {
     private handleAuthExhausted;
     private handleOpen;
     private resolveMessageForResend;
-    private lidToPn;
+    private lidMapping;
+    /** Resolve a `@lid` JID to its phone-number JID (uses WhatsApp's LID mapping; may hit the network). */
+    lidToPn(lid: string): Promise<string | null>;
+    /** Resolve a phone-number JID to its `@lid` JID (uses WhatsApp's LID mapping; may hit the network). */
+    pnToLid(pn: string): Promise<string | null>;
     private lookupQuoted;
     private handleClose;
     private rejectPendingConnect;
@@ -1476,6 +1841,8 @@ declare class MemoryMessageStore implements MessageStore {
     savePresence(jid: string, presence: PresenceData): Promise<void>;
     getPresence(jid: string): Promise<PresenceData | undefined>;
     bind(socket: BaileysSocketLike): void;
+    deleteMessage(key: WAMessageKey): Promise<void>;
+    pruneMessages(opts: PruneOptions): Promise<number>;
     clear(): Promise<void>;
     close(): Promise<void>;
     private assertOpen;
@@ -1507,6 +1874,8 @@ declare class SqliteMessageStore implements MessageStore {
     listContacts(): Promise<Contact[]>;
     savePresence(jid: string, presence: PresenceData): Promise<void>;
     getPresence(jid: string): Promise<PresenceData | undefined>;
+    deleteMessage(key: WAMessageKey): Promise<void>;
+    pruneMessages(opts: PruneOptions): Promise<number>;
     bind(socket: BaileysSocketLike): void;
     clear(): Promise<void>;
     close(): Promise<void>;
@@ -1545,6 +1914,8 @@ declare class PostgresMessageStore implements MessageStore {
     listContacts(): Promise<Contact[]>;
     savePresence(jid: string, presence: PresenceData): Promise<void>;
     getPresence(jid: string): Promise<PresenceData | undefined>;
+    deleteMessage(key: WAMessageKey): Promise<void>;
+    pruneMessages(opts: PruneOptions): Promise<number>;
     bind(socket: BaileysSocketLike): void;
     clear(): Promise<void>;
     close(): Promise<void>;
@@ -1581,6 +1952,9 @@ declare class RedisMessageStore implements MessageStore {
     bind(socket: BaileysSocketLike): void;
     clear(): Promise<void>;
     close(): Promise<void>;
+    deleteMessage(key: WAMessageKey): Promise<void>;
+    pruneMessages(opts: PruneOptions): Promise<number>;
+    private jidFromIndexKey;
     private msgIndexKey;
     private msgDataKey;
     private chatsKey;
@@ -1617,6 +1991,8 @@ declare class ConvexMessageStore implements MessageStore {
     saveScheduledJob(job: ScheduledJobRecord): Promise<void>;
     listScheduledJobs(): Promise<ScheduledJobRecord[]>;
     deleteScheduledJob(id: string): Promise<void>;
+    deleteMessage(key: WAMessageKey): Promise<void>;
+    pruneMessages(opts: PruneOptions): Promise<number>;
     bind(socket: BaileysSocketLike): void;
     clear(): Promise<void>;
     close(): Promise<void>;
@@ -1687,6 +2063,26 @@ type ZaileysLogger = Logger$1;
 declare function createLogger(options?: CreateLoggerOptions): ZaileysLogger;
 declare function adoptLogger(maybe: Logger | Partial<Logger> | undefined, fallback?: Logger): Logger;
 
+declare const extractJid: (remoteJid: string | undefined | null) => string | null;
+declare const isLidJid: (jid: string) => boolean;
+declare const isPnJid: (jid: string) => boolean;
+
+/** Digits-only phone number from a JID (e.g. `628xx@s.whatsapp.net` → `628xx`). Empty for groups/lids. */
+declare const jidToPhone: (jid: string) => string;
+/** Build a user JID from a phone number or digits (e.g. `+62 812` → `62812@s.whatsapp.net`). */
+declare const phoneToJid: (phone: string) => string;
+
+type LoadedMedia = {
+    buffer: Buffer;
+    mime: string;
+    size: number;
+};
+type LoadMediaOptions = {
+    timeoutMs?: number;
+};
+declare const detectMimeFromBuffer: (buffer: Buffer) => Promise<string>;
+declare const loadMedia: (src: MediaSource, options?: LoadMediaOptions) => Promise<LoadedMedia>;
+
 interface LIDMapping {
     readonly lid: string;
     readonly pn: string;
@@ -1860,4 +2256,4 @@ declare class Media {
     toBuffer(): Promise<Buffer>;
 }
 
-export { type AddressButton, type AlbumItem, type AudioOptions, AudioProcessor, type AudioType, type AuthAttemptBlockReason, type AuthAttemptDecision, type AuthCredsStore, type AuthGuard, type AuthGuardOptions, type AuthStore, type AuthStoreBundle, type AuthStoreKey, type AuthStoreValue, type AutomationErrorCode, type AutomationSocketLike, type BaileysSocket, type BaileysSocketLike, type BottomSheetOptions, type BroadcastDeps, type BroadcastOptions, type BroadcastResult, BufferConverter, type BuildContextInput, type BuilderContext, type BuilderErrorCode, type BuilderSocketLike, type BuilderState, type ButtonClickPayload, type ButtonDef, type CacheableAuthStoreOptions, type CallBase, type CallButton, type CallPayload, type CancelReminderButton, type ChatType, type CitationConfig, type CitationPredicates, Client, type ClientEventMap, type ClientEventName, type ClientOptions, type CommandContext, type CommandDefinition, type CommandErrorCode, type CommandHandler, type CommandPrefix, CommandRegistry, CommunityModule, type ConnectionAuthType, type ConnectionEventHandler, type ConnectionEventMap, type ConnectionEventName, type ConnectionState, type ConnectionStateMachine, type ContextMedia, ConvexAuthStore, type ConvexAuthStoreOptions, ConvexMessageStore, type ConvexMessageStoreOptions, type CopyButton, type CreateLoggerOptions, type DeleteOptions, type DeletePayload, type DisconnectReasonDomain, type DispatcherDeps, type DispatcherHandle, type DocumentOptions, DocumentProcessor, type DomainErrorCode, type DomainSocketLike, EditBuilder, type EditPayload, FFMPEG_CONSTANTS, type FFmpegConfig, FFmpegProcessor, FileAuthStore, type FileAuthStoreOptions, type FileExtension, FileManager, type GroupJoinPayload, type GroupLeavePayload, GroupModule, type GroupParticipantInfo, type GroupUpdatePayload, type HistorySyncPayload, type ImageOptions, ImageProcessor, type InboundEventMap, type InboundEventName, type InteractiveButton, type LIDMapping, type LIDMappingUpdatePayload, type LimitedPayload, type LimitedTimeOfferOptions, type LinkedGroup, type ListOptions, type ListSection$1 as ListSection, type ListSelectPayload, type LocationOptions, type LocationRequestButton, type Logger, type LoggerLevel, Media, type MediaDescriptor, type MediaDownloadResult, type MediaInput, type MediaKind, type MediaSource, type MemberTagPayload, MemoryAuthStore, MemoryMessageStore, type MentionAllContext, type MentionContext, MessageBuilder, type MessageContext, type MessageStore, type MessageStoreListOptions, type Middleware, MimeValidator, NewsletterModule, type NewsletterPayload, type OperationCategory, type OperationGuard, type OperationGuardClock, type OperationGuardOptions, type PairingFlow, type PairingFlowOptions, type PairingFlowResult, type ParsedArgs, type ParticipantUpdateResult, type PollOptions, type PollVotePayload, PostgresAuthStore, type PostgresAuthStoreOptions, PostgresMessageStore, type PostgresMessageStoreOptions, type PresenceClock, PresenceModule, type PresencePayload, type PresenceThrottleOptions, type PrivacyConfig, PrivacyModule, type PrivacySettings, type QuotedRef, RateLimiter, type RateLimiterClock, type RateLimiterOptions, type ReactionPayload, type ReconnectDecision, type ReconnectOptions, type ReconnectStrategy, type ReconnectStrategyDeps, RedisAuthStore, type RedisAuthStoreOptions, RedisMessageStore, type RedisMessageStoreOptions, type ReminderButton, type ReplyButton, type ResolvedCommand, type RetryPolicy, SELF_ONLY_PROTOCOL_TYPES, type ScheduleHandle, type ScheduledContentSnapshot, type ScheduledJob, type ScheduledJobRecord, Scheduler, type SchedulerDeps, type SchedulerTimer, type SelfOnlyProtocolType, type SenderDevice, type SenderInfo, SqliteAuthStore, type SqliteAuthStoreOptions, SqliteMessageStore, type SqliteMessageStoreOptions, type StateTransitionListener, type StickerMetadataType, type StickerOptions, StickerProcessor, type StickerShapeType, type StoreErrorCode, TaskQueue, type TaskQueueClock, type TaskQueueOptions, type TemplateOptions, type TextOptions, TypedEventEmitter, type TypedEventEmitterOptions, type UpsertPayload, type UrlButton, type UsernameResolveSocketLike, type VideoOptions, VideoProcessor, type WAPresence, ZaileysAutomationError, ZaileysBuilderError, ZaileysCommandError, ZaileysDomainError, type ZaileysLogger, ZaileysStoreError, adoptLogger, attachCommandDispatcher, buildMessageContext, chunk, createAuthGuard, createConnectionStateMachine, createLogger, createOperationGuard, createPairingFlow, createReconnectStrategy, deleteMessage, detectFileType, dropSpoofedSelfOnly, ffmpegTransform, forwardMessage, generateId, initializeFFmpeg, isFatalDisconnect, isJid, isRateLimited, makeCacheableAuthStore, mapDisconnectReason, normalizePhoneNumber, parseCommand, printQrToTerminal, reactToMessage, renderQrInTerminal, resolveUsername, runBroadcast, runMiddleware, shouldClearAuth, shouldReconnect, signalKeyStoreFromAuthStore, validateE164 };
+export { type AddressButton, type AlbumItem, type AudioOptions, AudioProcessor, type AudioType, type AuthAttemptBlockReason, type AuthAttemptDecision, type AuthCredsStore, type AuthGuard, type AuthGuardOptions, type AuthStore, type AuthStoreBundle, type AuthStoreKey, type AuthStoreValue, type AutoDeleteOptions, AutoDeleteSweeper, type AutomationErrorCode, type AutomationSocketLike, type BaileysSocket, type BaileysSocketLike, type BottomSheetOptions, type BroadcastDeps, type BroadcastOptions, type BroadcastResult, BufferConverter, type BuildContextInput, type BuilderContext, type BuilderErrorCode, type BuilderSocketLike, type BuilderState, BusinessModule, type ButtonClickPayload, type ButtonDef, type CacheableAuthStoreOptions, type CallBase, type CallButton, type CallPayload, type CancelReminderButton, ChatModule, type ChatType, type CitationConfig, type CitationPredicates, Client, type ClientEventMap, type ClientEventName, type ClientOptions, type CommandContext, type CommandDefinition, type CommandErrorCode, type CommandHandler, type CommandPrefix, CommandRegistry, CommunityModule, type ConnectionAuthType, type ConnectionEventHandler, type ConnectionEventMap, type ConnectionEventName, type ConnectionState, type ConnectionStateMachine, ContactModule, type ContextMedia, ConvexAuthStore, type ConvexAuthStoreOptions, ConvexMessageStore, type ConvexMessageStoreOptions, type CopyButton, type CreateLoggerOptions, type DeleteOptions, type DeletePayload, type DisconnectReasonDomain, type DispatcherDeps, type DispatcherHandle, type DocumentOptions, DocumentProcessor, type DomainErrorCode, type DomainSocketLike, EditBuilder, type EditPayload, type EventOptions, FFMPEG_CONSTANTS, type FFmpegConfig, FFmpegProcessor, FileAuthStore, type FileAuthStoreOptions, type FileExtension, FileManager, type GroupInviteOptions, type GroupJoinPayload, type GroupLeavePayload, GroupModule, type GroupParticipantInfo, type GroupUpdatePayload, type HistorySyncPayload, type ImageOptions, ImageProcessor, type InboundEventMap, type InboundEventName, type InteractiveButton, type LIDMapping, type LIDMappingUpdatePayload, type LimitedPayload, type LimitedTimeOfferOptions, type LinkedGroup, type ListOptions, type ListSection$1 as ListSection, type ListSelectPayload, type LoadMediaOptions, type LoadedMedia, type LocationOptions, type LocationRequestButton, type Logger, type LoggerLevel, Media, type MediaDescriptor, type MediaDownloadResult, type MediaInput, type MediaKind, type MediaSource, type MemberTagPayload, MemoryAuthStore, MemoryMessageStore, type MentionAllContext, type MentionContext, MessageBuilder, type MessageContext, type MessageStore, type MessageStoreListOptions, type Middleware, MimeValidator, NewsletterModule, type NewsletterPayload, type OperationCategory, type OperationGuard, type OperationGuardClock, type OperationGuardOptions, type PairingFlow, type PairingFlowOptions, type PairingFlowResult, type ParsedArgs, type ParticipantUpdateResult, type PinOptions, type Plugin, type PluginContext, type PluginsOptions, type PollOptions, type PollVotePayload, PostgresAuthStore, type PostgresAuthStoreOptions, PostgresMessageStore, type PostgresMessageStoreOptions, type PresenceClock, PresenceModule, type PresencePayload, type PresenceThrottleOptions, type PrivacyConfig, PrivacyModule, type PrivacySettings, type ProductOptions, ProfileModule, type PruneOptions, type QuotedRef, RateLimiter, type RateLimiterClock, type RateLimiterOptions, type ReactionPayload, type ReconnectDecision, type ReconnectOptions, type ReconnectStrategy, type ReconnectStrategyDeps, RedisAuthStore, type RedisAuthStoreOptions, RedisMessageStore, type RedisMessageStoreOptions, type ReminderButton, type ReplyButton, type ResolvedCommand, type RetryPolicy, SELF_ONLY_PROTOCOL_TYPES, type ScheduleHandle, type ScheduledContentSnapshot, type ScheduledJob, type ScheduledJobRecord, Scheduler, type SchedulerDeps, type SchedulerTimer, type SelfOnlyProtocolType, type SenderDevice, type SenderInfo, SqliteAuthStore, type SqliteAuthStoreOptions, SqliteMessageStore, type SqliteMessageStoreOptions, type StateTransitionListener, type StickerMetadataType, type StickerOptions, StickerProcessor, type StickerShapeType, type StoreErrorCode, TaskQueue, type TaskQueueClock, type TaskQueueOptions, type TemplateOptions, type TextOptions, TypedEventEmitter, type TypedEventEmitterOptions, type UpsertPayload, type UrlButton, type UsernameResolveSocketLike, type VideoNoteOptions, type VideoOptions, VideoProcessor, type WAPresence, ZaileysAutomationError, ZaileysBuilderError, ZaileysCommandError, ZaileysDomainError, type ZaileysLogger, ZaileysStoreError, adoptLogger, attachCommandDispatcher, buildMessageContext, chunk, computeStaticId, computeUniqueId, createAuthGuard, createConnectionStateMachine, createLogger, createOperationGuard, createPairingFlow, createReconnectStrategy, definePlugin, deleteMessage, detectFileType, detectMimeFromBuffer, dropSpoofedSelfOnly, epochSecondsToMs, extractLinks, ffmpegTransform, forwardMessage, generateId, genericPrune, initializeFFmpeg, isFatalDisconnect, isJid, isLidJid, isPnJid, isRateLimited, jidToPhone, loadMedia, makeCacheableAuthStore, mapDisconnectReason, extractJid as normalizeJid, normalizePhoneNumber, parseCommand, phoneToJid, pinMessage, printQrToTerminal, reactToMessage, renderQrInTerminal, resolveUsername, runBroadcast, runMiddleware, senderDeviceOf, shouldClearAuth, shouldReconnect, signalKeyStoreFromAuthStore, validateE164 };