zaileys 4.7.0 → 4.7.2

package/dist/events/context.d.ts

@@ -0,0 +1,238 @@
+import { type WAMessage, type WAMessageKey } from 'baileys';
+import { Readable } from 'node:stream';
+import type { SenderInfo } from './types.js';
+import type { TextOptions } from '../builder/builder.js';
+export 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';
+export type SenderDevice = 'unknown' | 'android' | 'ios' | 'web' | 'desktop' | string;
+export interface CitationConfig {
+    authors?: string[] | ((jid: string) => boolean | Promise<boolean>);
+    banned?: string[] | ((jid: string) => boolean | Promise<boolean>);
+}
+export interface CitationPredicates {
+    authors(): Promise<boolean>;
+    banned(): Promise<boolean>;
+}
+export interface MediaAttachment {
+    type: 'image' | 'video' | 'audio' | 'document' | 'sticker';
+    mimetype: string | null;
+    caption: string | null;
+    fileName: string | null;
+    fileSize: number | null;
+    ptt: boolean;
+    buffer(): Promise<Buffer>;
+    stream(): Promise<Readable>;
+}
+export interface PollMedia {
+    type: 'poll';
+    name: string | null;
+    options: string[];
+    selectableCount: number;
+}
+export interface ContactCard {
+    displayName: string | null;
+    vcard: string | null;
+}
+export interface ContactMedia {
+    type: 'contact';
+    displayName: string | null;
+    vcard: string | null;
+    contacts: ContactCard[];
+}
+export interface LocationMedia {
+    type: 'location' | 'live-location';
+    latitude: number | null;
+    longitude: number | null;
+    name: string | null;
+    address: string | null;
+    accuracy: number | null;
+    speed: number | null;
+    caption: string | null;
+}
+export interface AlbumMedia {
+    type: 'album';
+    expectedImageCount: number | null;
+    expectedVideoCount: number | null;
+}
+export interface GroupInviteMedia {
+    type: 'group-invite';
+    groupId: string | null;
+    groupName: string | null;
+    inviteCode: string | null;
+    caption: string | null;
+    expiresAt: number | null;
+}
+export 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;
+}
+export 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;
+}
+export interface PaymentMedia {
+    type: 'payment';
+    kind: 'request' | 'send' | 'invite';
+    amount: number | null;
+    currency: string | null;
+    note: string | null;
+    expiresAt: number | null;
+}
+export interface LinkPreviewMedia {
+    type: 'link';
+    url: string | null;
+    title: string | null;
+    description: string | null;
+}
+export interface EventMedia {
+    type: 'event';
+    name: string | null;
+    description: string | null;
+    location: string | null;
+    startTime: number | null;
+    endTime: number | null;
+    isCanceled: boolean;
+}
+export interface MessageButton {
+    id: string | null;
+    text: string | null;
+}
+export interface ButtonsMedia {
+    type: 'buttons';
+    contentText: string | null;
+    footerText: string | null;
+    buttons: MessageButton[];
+}
+export interface ListRow {
+    id: string | null;
+    title: string | null;
+    description: string | null;
+}
+export interface ListSection {
+    title: string | null;
+    rows: ListRow[];
+}
+export interface ListMedia {
+    type: 'list';
+    title: string | null;
+    description: string | null;
+    buttonText: string | null;
+    sections: ListSection[];
+}
+export interface InteractiveMedia {
+    type: 'interactive';
+    title: string | null;
+    body: string | null;
+    footer: string | null;
+    buttons: Array<{
+        name: string | null;
+        params: string | null;
+    }>;
+}
+export interface TemplateMedia {
+    type: 'template';
+    text: string | null;
+    buttons: MessageButton[];
+}
+export type ContextMedia = MediaAttachment | PollMedia | ContactMedia | LocationMedia | EventMedia | AlbumMedia | GroupInviteMedia | ProductMedia | OrderMedia | PaymentMedia | LinkPreviewMedia | ButtonsMedia | ListMedia | InteractiveMedia | TemplateMedia;
+export interface MessageContext {
+    uniqueId: string;
+    staticId: string;
+    channelId: string;
+    chatId: string;
+    chatType: ChatType;
+    receiverId: string;
+    roomId: string | null;
+    senderId: string;
+    senderLid: string | null;
+    senderName: string | null;
+    senderDevice: SenderDevice;
+    timestamp: number;
+    text: string;
+    mentions: string[];
+    links: string[];
+    isFromMe: boolean;
+    isGroup: boolean;
+    isNewsletter: boolean;
+    isBroadcast: boolean;
+    isViewOnce: boolean;
+    isEphemeral: boolean;
+    isForwarded: boolean;
+    isQuestion: boolean;
+    isPrefix: boolean;
+    isTagMe: boolean;
+    isEdited: boolean;
+    isDeleted: boolean;
+    isPinned: boolean;
+    isUnPinned: boolean;
+    isBot: boolean;
+    isSpam: boolean;
+    isHideTags: boolean;
+    isStatusMention: boolean;
+    isGroupStatusMention: boolean;
+    isStory: boolean;
+    roomName(): Promise<string | null>;
+    receiverName(): Promise<string | null>;
+    media?: ContextMedia;
+    replied(): Promise<MessageContext | null>;
+    message(): WAMessage;
+    citation: CitationPredicates;
+    reply(content: string, opts?: TextOptions): Promise<WAMessageKey>;
+    react(emoji: string): Promise<WAMessageKey>;
+}
+export interface MentionContext extends MessageContext {
+    mentionedJids: string[];
+    selfJid: string;
+}
+export interface MentionAllContext extends MessageContext {
+    isMentionAll: true;
+    selfJid: string;
+    members?: string[];
+}
+export interface BuildContextInput {
+    message: WAMessage;
+    key: WAMessageKey;
+    channelId: string;
+    receiverId: string;
+    selfJid: string;
+    text: string;
+    chatType: ChatType;
+    sender: SenderInfo;
+    mentions: string[];
+    isViewOnce: boolean;
+    isEphemeral: boolean;
+    isForwarded: boolean;
+    isBroadcast: boolean;
+    isNewsletter: boolean;
+    prefixes: string[];
+    citationConfig?: CitationConfig;
+    lidMap?: Map<string, string>;
+    resolveRoomName: () => Promise<string | null>;
+    resolveReceiverName: () => Promise<string | null>;
+    resolveReplied: () => Promise<MessageContext | null>;
+    reply: (content: string, opts?: TextOptions) => Promise<WAMessageKey>;
+    react: (emoji: string) => Promise<WAMessageKey>;
+    media?: ContextMedia;
+}
+export declare const extractLinks: (text: string) => string[];
+export declare const computeUniqueId: (key: WAMessageKey) => string;
+export declare const computeStaticId: (roomId: string | null, senderId: string) => string;
+export declare const epochSecondsToMs: (value: unknown) => number;
+export declare const senderDeviceOf: (jid: string) => SenderDevice;
+export declare const isQuestionOf: (text: string) => boolean;
+export declare const isPrefixOf: (text: string, prefixes: string[]) => boolean;
+export declare const isTagMeOf: (selfJid: string, mentions: string[]) => boolean;
+export declare const makeCitation: (config: CitationConfig | undefined, senderJid: string) => CitationPredicates;
+export declare const buildMessageContext: (input: BuildContextInput) => MessageContext;

package/dist/events/decoders/_media-download.d.ts

@@ -0,0 +1,8 @@
+import { Readable } from 'node:stream';
+import type { WAMessage } from 'baileys';
+import type { MediaDownloadResult, MediaKind } from '../types.js';
+export interface DownloadLogger {
+    warn(obj: unknown, msg?: string): void;
+}
+export declare const createDownloadFn: (msg: WAMessage, kind: MediaKind, logger?: DownloadLogger) => (() => Promise<MediaDownloadResult>);
+export declare const createStreamFn: (msg: WAMessage, kind: MediaKind, logger?: DownloadLogger) => (() => Promise<Readable>);

package/dist/events/decoders/_shared.d.ts

@@ -0,0 +1,26 @@
+import { type WAContextInfo, type WAMessageKey } from 'baileys';
+import type { QuotedRef, SenderInfo } from '../types.js';
+export interface LongLike {
+    toNumber(): number;
+    low: number;
+    high: number;
+}
+export interface AddressingAliases {
+    remoteJidAlt?: string;
+    remoteJidUsername?: string;
+    participantAlt?: string;
+    participantUsername?: string;
+}
+export interface ExtractedMentions {
+    mentionedJids: string[];
+    mentionAll: boolean;
+}
+export declare const extractJid: (remoteJid: string | undefined | null) => string | null;
+export declare const isLidJid: (jid: string) => boolean;
+export declare const isPnJid: (jid: string) => boolean;
+export declare const extractSender: (key: WAMessageKey | undefined, pushName?: string) => SenderInfo | null;
+export declare const extractQuoted: (contextInfo: WAContextInfo | null | undefined) => QuotedRef | null;
+export declare const extractMentions: (contextInfo: WAContextInfo | null | undefined) => ExtractedMentions;
+export declare const mapAddressing: (key: WAMessageKey) => AddressingAliases;
+export declare const isGroupJid: (jid: string) => boolean;
+export declare const safeNumber: (n: number | LongLike | null | undefined) => number | null;

package/dist/events/decoders/calls.d.ts

@@ -0,0 +1,11 @@
+import type { WACallEvent } from 'baileys';
+import type { CallPayload } from '../types.js';
+type IncomingCall = Extract<CallPayload, {
+    kind: 'incoming';
+}>;
+type EndedCall = Extract<CallPayload, {
+    kind: 'ended';
+}>;
+export declare const decodeCallIncoming: (item: WACallEvent) => IncomingCall | null;
+export declare const decodeCallEnded: (item: WACallEvent) => EndedCall | null;
+export {};

package/dist/events/decoders/groups.d.ts

@@ -0,0 +1,36 @@
+import type { GroupJoinPayload, GroupLeavePayload, GroupUpdatePayload, MemberTagPayload } from '../types.js';
+export interface GroupMetadataUpdate {
+    id?: string;
+    subject?: string;
+    desc?: string;
+    announce?: boolean;
+    restrict?: boolean;
+    ephemeralDuration?: number;
+}
+export interface RawGroupParticipant {
+    id: string;
+    lid?: string;
+    pn?: string;
+    phoneNumber?: string;
+    username?: string;
+    admin?: 'admin' | 'superadmin' | null;
+}
+export interface GroupParticipantsUpdate {
+    id?: string;
+    author?: string;
+    authorPn?: string;
+    authorUsername?: string;
+    participants: RawGroupParticipant[];
+    action: string;
+}
+export interface MemberTagUpdate {
+    groupId?: string;
+    participant?: string;
+    participantAlt?: string;
+    label?: string;
+    messageTimestamp?: number;
+}
+export declare const decodeGroupUpdate: (item: GroupMetadataUpdate) => GroupUpdatePayload | null;
+export declare const decodeMemberTag: (item: MemberTagUpdate) => MemberTagPayload | null;
+export declare const decodeGroupJoin: (item: GroupParticipantsUpdate) => GroupJoinPayload | null;
+export declare const decodeGroupLeave: (item: GroupParticipantsUpdate) => GroupLeavePayload | null;

package/dist/events/decoders/interactive.d.ts

@@ -0,0 +1,9 @@
+import type { WAMessage } from 'baileys';
+import type { Logger } from '../../client/types.js';
+import type { ButtonClickPayload, ListSelectPayload } from '../types.js';
+export interface InteractiveContext {
+    selfJid: string;
+    logger?: Logger;
+}
+export declare const decodeButtonClick: (msg: WAMessage, ctx: InteractiveContext) => ButtonClickPayload | null;
+export declare const decodeListSelect: (msg: WAMessage, ctx: InteractiveContext) => ListSelectPayload | null;

package/dist/events/decoders/lifecycle.d.ts

@@ -0,0 +1,69 @@
+import type { HistorySyncPayload, LimitedPayload, NewsletterPayload, PresencePayload } from '../types.js';
+export interface RawHistorySync {
+    syncType: number | string;
+    status: string;
+    explicit: boolean;
+}
+export interface RawReachoutTimelock {
+    isActive?: boolean;
+    timeEnforcementEnds?: Date | number;
+    enforcementType?: string;
+}
+export interface RawCapInfo {
+    capping_status?: string;
+    used_quota?: number;
+    total_quota?: number;
+}
+export type LimitedInput = {
+    source: 'connection-update';
+    reachoutTimeLock: RawReachoutTimelock;
+} | {
+    source: 'message-capping';
+    capInfo: RawCapInfo;
+};
+export interface RawPresence {
+    id: string;
+    presences: {
+        [participant: string]: {
+            lastKnownPresence?: string;
+            lastSeen?: number;
+        };
+    };
+}
+export type NewsletterInput = {
+    source: 'reaction';
+    payload: {
+        id: string;
+        server_id?: string;
+        reaction?: {
+            code?: string;
+            count?: number;
+        };
+    };
+} | {
+    source: 'view';
+    payload: {
+        id: string;
+        server_id?: string;
+        count?: number;
+    };
+} | {
+    source: 'participants';
+    payload: {
+        id: string;
+        author?: string;
+        user?: string;
+        new_role?: string;
+        action?: string;
+    };
+} | {
+    source: 'settings';
+    payload: {
+        id: string;
+        update?: Record<string, unknown>;
+    };
+};
+export declare const decodeHistorySync: (item: RawHistorySync) => HistorySyncPayload | null;
+export declare const decodeLimited: (input: LimitedInput) => LimitedPayload | null;
+export declare const decodePresence: (item: RawPresence) => PresencePayload[];
+export declare const decodeNewsletter: (input: NewsletterInput) => NewsletterPayload | null;

package/dist/events/decoders/messages.d.ts

@@ -0,0 +1,30 @@
+import { type WAMessage, type WAMessageKey } from 'baileys';
+import type { TextOptions } from '../../builder/builder.js';
+import { type CitationConfig, type MentionAllContext, type MentionContext, type MessageContext } from '../context.js';
+import { type DownloadLogger } from './_media-download.js';
+export interface DecodeContext {
+    selfJid: string;
+    selfLid?: string;
+    selfName?: string;
+    lidMap?: Map<string, string>;
+    logger?: DownloadLogger;
+    channelId?: string;
+    receiverId?: string;
+    prefixes?: string[];
+    citationConfig?: CitationConfig;
+    resolveRoomName?: (roomId: string) => Promise<string | null>;
+    resolveReceiverName?: () => Promise<string | null>;
+    resolveQuoted?: (id: string, remoteJid: string) => Promise<WAMessage | null>;
+    reply?: (target: string, content: string, opts: TextOptions | undefined, quoted: WAMessage) => Promise<WAMessageKey>;
+    react?: (key: WAMessageKey, emoji: string) => Promise<WAMessageKey>;
+}
+export declare const rawMentionsOf: (msg: WAMessage) => string[];
+export declare const decodeMessage: (msg: WAMessage, ctx: DecodeContext) => MessageContext | null;
+export declare const decodeText: (msg: WAMessage, ctx: DecodeContext) => MessageContext | null;
+export declare const decodeImage: (msg: WAMessage, ctx: DecodeContext) => MessageContext | null;
+export declare const decodeVideo: (msg: WAMessage, ctx: DecodeContext) => MessageContext | null;
+export declare const decodeAudio: (msg: WAMessage, ctx: DecodeContext) => MessageContext | null;
+export declare const decodeDocument: (msg: WAMessage, ctx: DecodeContext) => MessageContext | null;
+export declare const decodeSticker: (msg: WAMessage, ctx: DecodeContext) => MessageContext | null;
+export declare const decodeMention: (msg: WAMessage, ctx: DecodeContext) => MentionContext | null;
+export declare const decodeMentionAll: (msg: WAMessage, ctx: DecodeContext) => MentionAllContext | null;

package/dist/events/decoders/mutations.d.ts

@@ -0,0 +1,24 @@
+import { proto, type WAMessageKey } from 'baileys';
+import type { DeletePayload, EditPayload, PollVotePayload, ReactionPayload } from '../types.js';
+import { type LongLike } from './_shared.js';
+export interface MutationContext {
+    selfJid: string;
+    pushName?: string;
+}
+export interface ReactionItem {
+    key: WAMessageKey;
+    reaction: proto.IReaction;
+}
+export interface MessageUpdate {
+    key: WAMessageKey;
+    update: {
+        message?: proto.IMessage | null;
+        messageTimestamp?: number | LongLike | null;
+        pollUpdates?: proto.IPollUpdate[] | null;
+        status?: number | null;
+    };
+}
+export declare const decodeReaction: (item: ReactionItem, ctx: MutationContext) => ReactionPayload | null;
+export declare const decodeEdit: (update: MessageUpdate, ctx: MutationContext) => EditPayload | null;
+export declare const decodeDelete: (update: MessageUpdate, ctx: MutationContext) => DeletePayload | null;
+export declare const decodePollVote: (update: MessageUpdate, ctx: MutationContext) => PollVotePayload | null;

package/dist/events/guards.d.ts

@@ -0,0 +1,9 @@
+import type { WAMessage, MessageUpsertType } from 'baileys';
+export declare const SELF_ONLY_PROTOCOL_TYPES: readonly ["HISTORY_SYNC_NOTIFICATION", "APP_STATE_SYNC_KEY_SHARE", "LID_MIGRATION_MAPPING_SYNC", "PEER_DATA_OPERATION_REQUEST_RESPONSE_MESSAGE"];
+export type SelfOnlyProtocolType = (typeof SELF_ONLY_PROTOCOL_TYPES)[number];
+export interface UpsertPayload {
+    messages: WAMessage[];
+    type: MessageUpsertType;
+    requestId?: string;
+}
+export declare const dropSpoofedSelfOnly: (upsert: UpsertPayload) => UpsertPayload;

package/dist/events/index.d.ts

@@ -0,0 +1,4 @@
+export * from './guards.js';
+export type { ButtonClickPayload, CallBase, CallPayload, DeletePayload, EditPayload, GroupJoinPayload, GroupLeavePayload, GroupParticipantInfo, GroupUpdatePayload, HistorySyncPayload, InboundEventMap, InboundEventName, LimitedPayload, ListSelectPayload, MediaDescriptor, MediaDownloadResult, MediaKind, MemberTagPayload, NewsletterPayload, PollVotePayload, PresencePayload, QuotedRef, ReactionPayload, SenderInfo, } from './types.js';
+export type { BuildContextInput, ChatType, CitationConfig, CitationPredicates, ContextMedia, MentionAllContext, MentionContext, MessageContext, SenderDevice, } from './context.js';
+export { buildMessageContext } from './context.js';

package/dist/events/pipeline.d.ts

@@ -0,0 +1,37 @@
+import type { WAMessage, WAMessageKey } from 'baileys';
+import type { CitationConfig } from './context.js';
+import type { TextOptions } from '../builder/builder.js';
+import type { ClientEventMap, Logger } from '../client/types.js';
+import type { TypedEventEmitter } from '../client/event-emitter.js';
+export interface InboundPipelineHandle {
+    detach: () => void;
+}
+export interface InboundPipelineContext {
+    selfJid: string;
+    selfLid?: string;
+    selfName?: string;
+    logger?: Logger;
+    channelId?: string;
+    receiverId?: string;
+    prefixes?: string[];
+    citationConfig?: CitationConfig;
+    groupMetadata?: (groupId: string) => Promise<{
+        subject?: string;
+    } | null>;
+    receiverName?: () => Promise<string | null>;
+    resolveQuoted?: (id: string, remoteJid: string) => Promise<WAMessage | null>;
+    resolveLidToPn?: (lid: string) => Promise<string | null>;
+    sendReply?: (target: string, content: string, opts: TextOptions | undefined, quoted: WAMessage) => Promise<WAMessageKey>;
+    react?: (key: WAMessageKey, emoji: string) => Promise<WAMessageKey>;
+    ignoreMe?: boolean;
+}
+export interface BaileysEventSurface {
+    on: (event: string, handler: (...args: unknown[]) => void) => void;
+    off: (event: string, handler: (...args: unknown[]) => void) => void;
+}
+export interface PipelineSocketLike {
+    ev: BaileysEventSurface;
+}
+type ClientEmitter = TypedEventEmitter<ClientEventMap>;
+export declare function attachInboundPipeline(client: ClientEmitter, socket: PipelineSocketLike, ctx: InboundPipelineContext): InboundPipelineHandle;
+export {};