@jkt48connect-corp/baileys 7.2.9 → 7.3.0

package/lib/Types/GroupMetadata.d.ts

@@ -0,0 +1,56 @@
+import { Contact } from './Contact';
+export type GroupParticipant = (Contact & {
+    isAdmin?: boolean;
+    isSuperAdmin?: boolean;
+    admin?: 'admin' | 'superadmin' | null;
+});
+export type ParticipantAction = 'add' | 'remove' | 'promote' | 'demote' | 'modify';
+export type RequestJoinAction = 'created' | 'revoked' | 'rejected';
+export type RequestJoinMethod = 'invite_link' | 'linked_group_join' | 'non_admin_add' | undefined;
+export interface GroupMetadata {
+    id: string;
+    owner: string | undefined;
+    subject: string;
+    /** group subject owner */
+    subjectOwner?: string;
+    /** group subject modification date */
+    subjectTime?: number;
+    creation?: number;
+    desc?: string;
+    descOwner?: string;
+    descId?: string;
+    /** if this group is part of a community, it returns the jid of the community to which it belongs */
+    linkedParent?: string;
+    /** is set when the group only allows admins to change group settings */
+    restrict?: boolean;
+    /** is set when the group only allows admins to write messages */
+    announce?: boolean;
+    /** is set when the group also allows members to add participants */
+    memberAddMode?: boolean;
+    /** Request approval to join the group */
+    joinApprovalMode?: boolean;
+    /** is this a community */
+    isCommunity?: boolean;
+    /** is this the announce of a community */
+    isCommunityAnnounce?: boolean;
+    /** number of group participants */
+    size?: number;
+    participants: GroupParticipant[];
+    ephemeralDuration?: number;
+    inviteCode?: string;
+    /** the person who added you to group or changed some setting in group */
+    author?: string;
+}
+export interface WAGroupCreateResponse {
+    status: number;
+    gid?: string;
+    participants?: [{
+        [key: string]: {};
+    }];
+}
+export interface GroupModificationResponse {
+    status: number;
+    participants?: {
+        [key: string]: {};
+    };
+}

package/lib/Types/Label.d.ts

@@ -0,0 +1,46 @@
+export interface Label {
+    /** Label uniq ID */
+    id: string;
+    /** Label name */
+    name: string;
+    /** Label color ID */
+    color: number;
+    /** Is label has been deleted */
+    deleted: boolean;
+    /** WhatsApp has 5 predefined labels (New customer, New order & etc) */
+    predefinedId?: string;
+}
+export interface LabelActionBody {
+    id: string;
+    /** Label name */
+    name?: string;
+    /** Label color ID */
+    color?: number;
+    /** Is label has been deleted */
+    deleted?: boolean;
+    /** WhatsApp has 5 predefined labels (New customer, New order & etc) */
+    predefinedId?: number;
+}
+/** WhatsApp has 20 predefined colors */
+export declare enum LabelColor {
+    Color1 = 0,
+    Color2 = 1,
+    Color3 = 2,
+    Color4 = 3,
+    Color5 = 4,
+    Color6 = 5,
+    Color7 = 6,
+    Color8 = 7,
+    Color9 = 8,
+    Color10 = 9,
+    Color11 = 10,
+    Color12 = 11,
+    Color13 = 12,
+    Color14 = 13,
+    Color15 = 14,
+    Color16 = 15,
+    Color17 = 16,
+    Color18 = 17,
+    Color19 = 18,
+    Color20 = 19
+}

package/lib/Types/LabelAssociation.d.ts

@@ -0,0 +1,29 @@
+/** Association type */
+export declare enum LabelAssociationType {
+    Chat = "label_jid",
+    Message = "label_message"
+}
+export type LabelAssociationTypes = `${LabelAssociationType}`;
+/** Association for chat */
+export interface ChatLabelAssociation {
+    type: LabelAssociationType.Chat;
+    chatId: string;
+    labelId: string;
+}
+/** Association for message */
+export interface MessageLabelAssociation {
+    type: LabelAssociationType.Message;
+    chatId: string;
+    messageId: string;
+    labelId: string;
+}
+export type LabelAssociation = ChatLabelAssociation | MessageLabelAssociation;
+/** Body for add/remove chat label association action */
+export interface ChatLabelAssociationActionBody {
+    labelId: string;
+}
+/** body for add/remove message label association action */
+export interface MessageLabelAssociationActionBody {
+    labelId: string;
+    messageId: string;
+}

package/lib/Types/Message.d.ts

@@ -0,0 +1,433 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { AxiosRequestConfig } from 'axios';
+import type { Logger } from 'pino';
+import type { Readable } from 'stream';
+import type { URL } from 'url';
+import { BinaryNode } from '../WABinary';
+import { proto } from '../../WAProto';
+import { MEDIA_HKDF_KEY_MAPPING } from '../Defaults';
+import type { GroupMetadata } from './GroupMetadata';
+import { CacheStore } from './Socket';
+export { proto as WAProto };
+export type WAMessage = proto.IWebMessageInfo;
+export type WAMessageContent = proto.IMessage;
+export type WAContactMessage = proto.Message.IContactMessage;
+export type WAContactsArrayMessage = proto.Message.IContactsArrayMessage;
+export type WAMessageKey = proto.IMessageKey;
+export type WATextMessage = proto.Message.IExtendedTextMessage;
+export type WAContextInfo = proto.IContextInfo;
+export type WALocationMessage = proto.Message.ILocationMessage;
+export type WALiveLocationMessage = proto.Message.ILiveLocationMessage;
+export type WAGenericMediaMessage = proto.Message.IVideoMessage | proto.Message.IImageMessage | proto.Message.IAudioMessage | proto.Message.IDocumentMessage | proto.Message.IStickerMessage;
+export import WAMessageStubType = proto.WebMessageInfo.StubType;
+export import WAMessageStatus = proto.WebMessageInfo.Status;
+export type WAMediaUpload = Buffer | {
+    url: URL | string;
+} | {
+    stream: Readable;
+};
+export import Annotations = proto.IInteractiveAnnotation;
+/** Set of message types that are supported by the library */
+export type MessageType = keyof proto.Message;
+export type DownloadableMessage = {
+    mediaKey?: Uint8Array | null;
+    directPath?: string | null;
+    url?: string | null;
+};
+export type MessageReceiptType = 'read' | 'read-self' | 'hist_sync' | 'peer_msg' | 'sender' | 'inactive' | 'played' | undefined;
+export type MediaConnInfo = {
+    auth: string;
+    ttl: number;
+    hosts: {
+        hostname: string;
+        maxContentLengthBytes: number;
+    }[];
+    fetchDate: Date;
+};
+export interface WAUrlInfo {
+    'canonical-url': string;
+    'matched-text': string;
+    title: string;
+    description?: string;
+    jpegThumbnail?: Buffer;
+    highQualityThumbnail?: proto.Message.IImageMessage;
+    originalThumbnailUrl?: string;
+}
+export interface Media {
+    image?: WAMediaUpload;
+    video?: WAMediaUpload;
+}
+export interface Carousel {
+    image?: WAMediaUpload;
+    video?: WAMediaUpload;
+    product?: WASendableProduct;
+    title?: string;
+    caption?: string;
+    footer?: string;
+    buttons?: proto.Message.InteractiveMessage.NativeFlowMessage.NativeFlowButton[];
+}
+type Mentionable = {
+    /** list of jids that are mentioned in the accompanying text */
+    mentions?: string[];
+};
+type Contextable = {
+    /** add contextInfo to the message */
+    contextInfo?: proto.IContextInfo;
+};
+type ViewOnce = {
+    viewOnce?: boolean;
+};
+type Buttonable = {
+    /** add buttons to the message  */
+    buttons?: proto.Message.ButtonsMessage.IButton[];
+};
+type Templatable = {
+    /** add buttons to the message (conflicts with normal buttons)*/
+    templateButtons?: proto.IHydratedTemplateButton[];
+    footer?: string;
+};
+type Interactiveable = {
+    /** add buttons to the message (conflicts with normal buttons)*/
+    interactiveButtons?: proto.Message.InteractiveMessage.NativeFlowMessage.NativeFlowButton[];
+    title?: string;
+    subtitle?: string;
+    media?: boolean;
+};
+type Shopable = {
+    shop?: proto.Message.InteractiveMessage.ShopMessage.Surface;
+    id?: string;
+    title?: string;
+    subtitle?: string;
+    media?: boolean;
+};
+type Collectionable = {
+    collection?: {
+        bizJid?: string;
+        id?: string;
+        version?: number;
+    };
+    title?: string;
+    subtitle?: string;
+    media?: boolean;
+};
+type Cardsable = {
+    cards?: Carousel[];
+    title?: string;
+    subtitle?: string;
+};
+type Editable = {
+    edit?: WAMessageKey;
+};
+type Listable = {
+    /** Sections of the List */
+    sections?: proto.Message.ListMessage.ISection[];
+    /** Title of a List Message only */
+    title?: string;
+    /** Text of the button on the list (required) */
+    buttonText?: string;
+};
+type WithDimensions = {
+    width?: number;
+    height?: number;
+};
+export type PollMessageOptions = {
+    name: string;
+    selectableCount?: number;
+    values: string[];
+    /** 32 byte message secret to encrypt poll selections */
+    messageSecret?: Uint8Array;
+    toAnnouncementGroup?: boolean;
+};
+export type PollResultMessage = {
+    name: string;
+    votes: proto.Message.PollResultSnapshotMessage.PollVote[];
+    messageSecret?: Uint8Array;
+};
+type SharePhoneNumber = {
+    sharePhoneNumber: boolean;
+};
+type RequestPhoneNumber = {
+    requestPhoneNumber: boolean;
+};
+export type WASendableProduct = Omit<proto.Message.ProductMessage.IProductSnapshot, 'productImage'> & {
+    productImage: WAMediaUpload;
+};
+export type MediaType = keyof typeof MEDIA_HKDF_KEY_MAPPING;
+export type AnyMediaMessageContent = (({
+    image: WAMediaUpload;
+    caption?: string;
+    jpegThumbnail?: string;
+    annotations?: Annotations;
+} & Mentionable & Contextable & Buttonable & Templatable & Interactiveable & Shopable & Collectionable & Cardsable & WithDimensions) | ({
+    video: WAMediaUpload;
+    caption?: string;
+    gifPlayback?: boolean;
+    jpegThumbnail?: string;
+    /** if set to true, will send as a `video note` */
+    ptv?: boolean;
+    annotations?: Annotations;
+} & Mentionable & Contextable & Buttonable & Templatable & Interactiveable & Shopable & Collectionable & Cardsable & WithDimensions) | {
+    audio: WAMediaUpload;
+    /** if set to true, will send as a `voice note` */
+    ptt?: boolean;
+    /** optionally tell the duration of the audio */
+    seconds?: number;
+    annotations?: Annotations;
+} | ({
+    sticker: WAMediaUpload;
+    isAnimated?: boolean;
+    annotations?: Annotations;
+} & WithDimensions) | ({
+    document: WAMediaUpload;
+    mimetype: string;
+    fileName?: string;
+    caption?: string;
+    annotations?: Annotations;
+} & Contextable & Buttonable & Templatable & Interactiveable & Shopable & Collectionable & Cardsable)) & {
+    mimetype?: string;
+} & Editable;
+export type ButtonReplyInfo = {
+    displayText: string;
+    id: string;
+    index: number;
+    text: string;
+    nativeFlow: proto.Message.InteractiveResponseMessage.NativeFlowResponseMessage;
+};
+export type GroupInviteInfo = {
+    inviteCode: string;
+    inviteExpiration: number;
+    text: string;
+    jid: string;
+    subject: string;
+    thumbnail: Buffer;
+};
+export type PinInChatInfo = {
+    key: WAMessageKey;
+    type?: number;
+    time?: number;
+};
+export type KeepInChatInfo = {
+    key: WAMessageKey;
+    type?: number;
+    time?: number;
+};
+export type CallCreationInfo = {
+    time?: number;
+    title?: string;
+    type?: number;
+};
+export type PaymentInviteInfo = {
+    type?: number;
+    expiry?: number;
+};
+export type RequestPaymentInfo = {
+    expiry: number;
+    amount: number;
+    currency: string;
+    from: string;
+    note?: string;
+    sticker?: WAMediaUpload;
+    background: string;
+    /** add contextInfo to the message */
+    contextInfo?: proto.IContextInfo;
+};
+export type EventsInfo = {
+    isCanceled?: boolean;
+    name: string;
+    description: string;
+    joinLink?: string;
+    startTime?: number;
+    messageSecret?: Uint8Array;
+};
+export type AdminInviteInfo = {
+    inviteExpiration: number;
+    text: string;
+    jid: string;
+    subject: string;
+    thumbnail: Buffer;
+};
+export type OrderInfo = {
+    id: number;
+    thumbnail: string;
+    itemCount: number;
+    status: number;
+    surface: number;
+    title: string;
+    text: string;
+    seller: string;
+    token: string;
+    amount: number;
+    currency: string;
+};
+export type AnyRegularMessageContent = (({
+    text: string;
+    linkPreview?: WAUrlInfo | null;
+} & Mentionable & Contextable & Buttonable & Templatable & Interactiveable & Shopable & Collectionable & Cardsable & Listable & Editable) | AnyMediaMessageContent | ({
+    poll: PollMessageOptions;
+} | {
+    pollResult: PollResultMessage;
+} & Mentionable & Contextable & Buttonable & Templatable & Editable) | {
+    contacts: {
+        displayName?: string;
+        contacts: proto.Message.IContactMessage[];
+    };
+} | {
+    location: WALocationMessage;
+} | {
+    liveLocation: WALiveLocationMessage;
+} | {
+    react: proto.Message.IReactionMessage;
+} | {
+    buttonReply: ButtonReplyInfo;
+    type: 'template' | 'plain' | 'interactive';
+} | {
+    groupInvite: GroupInviteInfo;
+} | {
+    pin: WAMessageKey;
+    type: proto.PinInChat.Type;
+    /**
+     * 24 hours, 7 days, 30 days
+     */
+    time?: 86400 | 604800 | 2592000;
+} | {
+    keep: WAMessageKey;
+    type: number;
+    /**
+     * 24 hours, 7 days, 90 days
+     */
+    time?: 86400 | 604800 | 7776000;
+} | {
+    paymentInvite: PaymentInviteInfo;
+} | {
+    requestPayment: RequestPaymentInfo;
+} | {
+    event: EventsInfo;
+} | {
+    order: OrderInfo;
+} | {
+    call: CallCreationInfo;
+} | {
+    inviteAdmin: AdminInviteInfo;
+} | {
+    listReply: Omit<proto.Message.IListResponseMessage, 'contextInfo'>;
+} | ({
+    product: WASendableProduct;
+    businessOwnerJid?: string;
+    body?: string;
+    footer?: string;
+} & Mentionable & Contextable & Interactiveable & Shopable & Collectionable & Cardsable & WithDimensions) | SharePhoneNumber | RequestPhoneNumber) & ViewOnce;
+export type AnyMessageContent = AnyRegularMessageContent | {
+    forward: WAMessage;
+    force?: boolean;
+} | {
+    /** Delete your message or anyone's message in a group (admin required) */
+    delete: WAMessageKey;
+} | {
+    disappearingMessagesInChat: boolean | number;
+};
+export type GroupMetadataParticipants = Pick<GroupMetadata, 'participants'>;
+type MinimalRelayOptions = {
+    /** override the message ID with a custom provided string */
+    messageId?: string;
+    /** cached group metadata, use to prevent redundant requests to WA & speed up msg sending */
+    cachedGroupMetadata?: (jid: string) => Promise<GroupMetadataParticipants | undefined>;
+};
+export type MessageRelayOptions = MinimalRelayOptions & {
+    /** only send to a specific participant; used when a message decryption fails for a single user */
+    participant?: {
+        jid: string;
+        count: number;
+    };
+    /** additional attributes to add to the WA binary node */
+    additionalAttributes?: {
+        [_: string]: string;
+    };
+    additionalNodes?: BinaryNode[];
+    /** should we use the devices cache, or fetch afresh from the server; default assumed to be "true" */
+    useUserDevicesCache?: boolean;
+    /** jid list of participants for status@broadcast */
+    statusJidList?: string[];
+};
+export type MiscMessageGenerationOptions = MinimalRelayOptions & {
+    /** optional, if you want to manually set the timestamp of the message */
+    timestamp?: Date;
+    /** the message you want to quote */
+    quoted?: WAMessage;
+    additionalNodes?: BinaryNode[];
+    /** disappearing messages settings */
+    ephemeralExpiration?: number | string;
+    /** timeout for media upload to WA server */
+    mediaUploadTimeoutMs?: number;
+    /** jid list of participants for status@broadcast */
+    statusJidList?: string[];
+    /** backgroundcolor for status */
+    backgroundColor?: string;
+    /** font type for status */
+    font?: number;
+    /** if it is broadcast */
+    broadcast?: boolean;
+    /** delay of message time */
+    delay?: number;
+};
+export type MessageGenerationOptionsFromContent = MiscMessageGenerationOptions & {
+    userJid: string;
+};
+export type WAMediaUploadFunctionOpts = {
+    fileEncSha256B64: string;
+    mediaType: MediaType;
+    newsletter?: boolean;
+    timeoutMs?: number;
+};
+export type WAMediaUploadFunction = (readStream: Readable | Buffer, opts: WAMediaUploadFunctionOpts) => Promise<{
+    mediaUrl: string;
+    directPath: string;
+    handle?: string;
+}>;
+export type MediaGenerationOptions = {
+    logger?: Logger;
+    mediaTypeOverride?: MediaType;
+    upload: WAMediaUploadFunction;
+    /** cache media so it does not have to be uploaded again */
+    mediaCache?: CacheStore;
+    mediaUploadTimeoutMs?: number;
+    options?: AxiosRequestConfig;
+    /** the message you want to quote */
+    quoted?: WAMessage;
+    backgroundColor?: string;
+    font?: number;
+    /** The message is for newsletter? */
+    newsletter?: boolean;
+};
+export type MessageContentGenerationOptions = MediaGenerationOptions & {
+    getUrlInfo?: (text: string) => Promise<WAUrlInfo | undefined>;
+    getProfilePicUrl?: (jid: string, type: 'image' | 'preview') => Promise<string | undefined>;
+};
+export type MessageGenerationOptions = MessageContentGenerationOptions & MessageGenerationOptionsFromContent;
+/**
+ * Type of message upsert
+ * 1. notify => notify the user, this message was just received
+ * 2. append => append the message to the chat history, no notification required
+ */
+export type MessageUpsertType = 'append' | 'notify';
+export type MessageUserReceipt = proto.IUserReceipt;
+export type WAMessageUpdate = {
+    update: Partial<WAMessage>;
+    key: proto.IMessageKey;
+};
+export type WAMessageCursor = {
+    before: WAMessageKey | undefined;
+} | {
+    after: WAMessageKey | undefined;
+};
+export type MessageUserReceiptUpdate = {
+    key: proto.IMessageKey;
+    receipt: MessageUserReceipt;
+};
+export type MediaDecryptionKeyInfo = {
+    iv: Buffer;
+    cipherKey: Buffer;
+    macKey?: Buffer;
+};
+export type MinimalMessage = Pick<proto.IWebMessageInfo, 'key' | 'messageTimestamp'>;

package/lib/Types/Newsletter.d.ts

@@ -0,0 +1,92 @@
+import { proto } from '../../WAProto';
+export type NewsletterReactionMode = 'ALL' | 'BASIC' | 'NONE';
+export type NewsletterState = 'ACTIVE' | 'GEOSUSPENDED' | 'SUSPENDED';
+export type NewsletterVerification = 'VERIFIED' | 'UNVERIFIED';
+export type NewsletterMute = 'ON' | 'OFF' | 'UNDEFINED';
+export type NewsletterViewRole = 'ADMIN' | 'GUEST' | 'OWNER' | 'SUBSCRIBER';
+export type NewsletterViewerMetadata = {
+    mute: NewsletterMute;
+    view_role: NewsletterViewRole;
+};
+export type NewsletterMetadata = {
+    /**jid of newsletter */
+    id: string;
+    /**state of newsletter */
+    state: NewsletterState;
+    /**creation timestamp of newsletter */
+    creation_time: number;
+    /**name of newsletter */
+    name: string;
+    /**timestamp of last name modification of newsletter */
+    nameTime: number;
+    /**description of newsletter */
+    description: string;
+    /**timestamp of last description modification of newsletter */
+    descriptionTime: number;
+    /**invite code of newsletter */
+    invite: string;
+    /**i dont know */
+    handle: null;
+    /**direct path of picture */
+    picture: string | null;
+    /**direct path of picture preview (lower quality) */
+    preview: string | null;
+    /**reaction mode of newsletter */
+    reaction_codes?: NewsletterReactionMode;
+    /**subscribers count of newsletter */
+    subscribers: number;
+    /**verification state of newsletter */
+    verification: NewsletterVerification;
+    /**viewer metadata */
+    viewer_metadata: NewsletterViewerMetadata;
+};
+export type SubscriberAction = 'promote' | 'demote';
+export type ReactionModeUpdate = {
+    reaction_codes: {
+        blocked_codes: null;
+        enabled_ts_sec: null;
+        value: NewsletterReactionMode;
+    };
+};
+/**only exists reaction mode update */
+export type NewsletterSettingsUpdate = ReactionModeUpdate;
+export type NewsletterReaction = {
+    count: number;
+    code: string;
+};
+export type NewsletterFetchedUpdate = {
+    /**id of message in newsletter, starts from 100 */
+    server_id: string;
+    /**count of views in this message */
+    views?: number;
+    /**reactions in this message */
+    reactions: NewsletterReaction[];
+    /**the message, if you requested only updates, you will not receive message */
+    message?: proto.IWebMessageInfo;
+};
+export declare enum MexOperations {
+    PROMOTE = "NotificationNewsletterAdminPromote",
+    DEMOTE = "NotificationNewsletterAdminDemote",
+    UPDATE = "NotificationNewsletterUpdate"
+}
+export declare enum XWAPaths {
+    PROMOTE = "xwa2_notify_newsletter_admin_promote",
+    DEMOTE = "xwa2_notify_newsletter_admin_demote",
+    ADMIN_COUNT = "xwa2_newsletter_admin",
+    CREATE = "xwa2_newsletter_create",
+    NEWSLETTER = "xwa2_newsletter",
+    METADATA_UPDATE = "xwa2_notify_newsletter_on_metadata_update"
+}
+export declare enum QueryIds {
+    JOB_MUTATION = "7150902998257522",
+    METADATA = "6620195908089573",
+    UNFOLLOW = "7238632346214362",
+    FOLLOW = "7871414976211147",
+    UNMUTE = "7337137176362961",
+    MUTE = "25151904754424642",
+    CREATE = "6996806640408138",
+    ADMIN_COUNT = "7130823597031706",
+    CHANGE_OWNER = "7341777602580933",
+    DELETE = "8316537688363079",
+    DEMOTE = "6551828931592903"
+}