zaileys 4.7.1 → 4.8.0

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 {};

package/dist/events/types.d.ts

@@ -0,0 +1,187 @@
+import type { WAMessageKey } from 'baileys';
+import type { MentionAllContext, MentionContext, MessageContext } from './context.js';
+export interface SenderInfo {
+    jid: string;
+    deviceJid?: string;
+    lid?: string;
+    pn?: string;
+    username?: string;
+    pushName?: string;
+    isMe?: boolean;
+}
+export interface GroupParticipantInfo {
+    jid: string;
+    participantAlt?: string;
+    authorPn?: string;
+    authorUsername?: string;
+    isAdmin?: boolean;
+}
+export interface QuotedRef {
+    key: WAMessageKey;
+    content?: string;
+    sender?: SenderInfo;
+}
+export type MediaKind = 'image' | 'video' | 'audio' | 'document' | 'sticker';
+export interface MediaDownloadResult {
+    buffer: Buffer;
+    mime: string;
+    size: number;
+}
+export interface MediaDescriptor {
+    mimetype: string;
+    size?: number;
+    caption?: string;
+    fileName?: string;
+    ptt?: boolean;
+}
+export interface ReactionPayload {
+    key: WAMessageKey;
+    emoji: string | null;
+    sender: SenderInfo;
+    timestamp: number;
+}
+export interface EditPayload {
+    key: WAMessageKey;
+    newContent: string;
+    editedAt: number;
+    sender: SenderInfo;
+}
+export interface DeletePayload {
+    key: WAMessageKey;
+    deletedFor: 'everyone' | 'me';
+    sender: SenderInfo;
+    timestamp: number;
+}
+export interface PollVotePayload {
+    pollKey: WAMessageKey;
+    selectedOptions: string[];
+    voter: SenderInfo;
+    timestamp: number;
+}
+export interface ButtonClickPayload {
+    key: WAMessageKey;
+    buttonId: string;
+    buttonText?: string;
+    sender: SenderInfo;
+    timestamp: number;
+}
+export interface ListSelectPayload {
+    key: WAMessageKey;
+    rowId: string;
+    title?: string;
+    sender: SenderInfo;
+    timestamp: number;
+}
+export interface GroupUpdatePayload {
+    groupId: string;
+    update: Partial<{
+        subject: string;
+        description: string;
+        announce: boolean;
+        restrict: boolean;
+        ephemeralDuration: number;
+    }>;
+    timestamp: number;
+}
+export interface GroupJoinPayload {
+    groupId: string;
+    participants: GroupParticipantInfo[];
+    action: 'add' | 'invite' | 'invite-link';
+    by?: string;
+    timestamp: number;
+}
+export interface GroupLeavePayload {
+    groupId: string;
+    participants: GroupParticipantInfo[];
+    action: 'remove' | 'leave';
+    by?: string;
+    timestamp: number;
+}
+export interface MemberTagPayload {
+    groupId: string;
+    participant: string;
+    participantAlt?: string;
+    label: string;
+    timestamp: number;
+}
+export type CallPayload = (CallBase & {
+    kind: 'incoming';
+}) | (CallBase & {
+    kind: 'ended';
+});
+export interface CallBase {
+    callId: string;
+    from: string;
+    isGroup: boolean;
+    isVideo: boolean;
+    timestamp: number;
+    status?: string;
+}
+export interface HistorySyncPayload {
+    syncType: string;
+    status: 'complete' | 'paused';
+    explicit: boolean;
+}
+export type LimitedPayload = {
+    reason: 'reachout-timelock';
+    retryAt: number;
+} | {
+    reason: 'chat-limit-reached';
+    usedQuota?: number;
+    totalQuota?: number;
+};
+export interface PresencePayload {
+    jid: string;
+    participant?: string;
+    status: 'available' | 'unavailable' | 'composing' | 'recording' | 'paused';
+}
+export type NewsletterPayload = {
+    newsletterId: string;
+    timestamp: number;
+} & ({
+    action: 'reaction';
+    serverId?: string;
+    emoji?: string;
+} | {
+    action: 'view';
+    serverId?: string;
+    count?: number;
+} | {
+    action: 'participants';
+    count?: number;
+} | {
+    action: 'settings';
+    update?: Record<string, unknown>;
+});
+export type InboundEventMap = {
+    message: MessageContext;
+    text: MessageContext;
+    image: MessageContext;
+    video: MessageContext;
+    audio: MessageContext;
+    document: MessageContext;
+    sticker: MessageContext;
+    reaction: ReactionPayload;
+    edit: EditPayload;
+    delete: DeletePayload;
+    'poll-vote': PollVotePayload;
+    'button-click': ButtonClickPayload;
+    'list-select': ListSelectPayload;
+    mention: MentionContext;
+    'mention-all': MentionAllContext;
+    'group-update': GroupUpdatePayload;
+    'group-join': GroupJoinPayload;
+    'group-leave': GroupLeavePayload;
+    'member-tag': MemberTagPayload;
+    'call-incoming': Extract<CallPayload, {
+        kind: 'incoming';
+    }>;
+    'call-ended': Extract<CallPayload, {
+        kind: 'ended';
+    }>;
+    'history-sync': HistorySyncPayload;
+    limited: LimitedPayload;
+    presence: PresencePayload;
+    newsletter: NewsletterPayload;
+};
+export type InboundEventName = keyof InboundEventMap;