@alannxd/baileys 6.0.5 → 6.0.6

package/lib/Types/Message.d.ts

@@ -1,50 +1,34 @@
+/// <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 { proto } from '../../WAProto/index.js';
-import type { MediaType } from '../Defaults/index.js';
-import type { BinaryNode } from '../WABinary/index.js';
-import type { GroupMetadata } from './GroupMetadata.js';
-import type { CacheStore } from './Socket.js';
+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 & {
-    key: WAMessageKey;
-    messageStubParameters?: any;
-    category?: string;
-    retryCount?: number;
-};
+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 & {
-    remoteJidAlt?: string;
-    remoteJidUsername?: string;
-    participantAlt?: string;
-    participantUsername?: string;
-    server_id?: string;
-    addressingMode?: string;
-    isViewOnce?: boolean;
-};
+export type WAMessageKey = proto.IMessageKey;
 export type WATextMessage = proto.Message.IExtendedTextMessage;
 export type WAContextInfo = proto.IContextInfo;
 export type WALocationMessage = proto.Message.ILocationMessage;
 export type WAGenericMediaMessage = proto.Message.IVideoMessage | proto.Message.IImageMessage | proto.Message.IAudioMessage | proto.Message.IDocumentMessage | proto.Message.IStickerMessage;
-export declare const WAMessageStubType: typeof proto.WebMessageInfo.StubType;
-export declare const WAMessageStatus: typeof proto.WebMessageInfo.Status;
-import type { ILogger } from '../Utils/logger.js';
-export type WAMediaPayloadURL = {
+export import WAMessageStubType = proto.WebMessageInfo.StubType;
+export import WAMessageStatus = proto.WebMessageInfo.Status;
+export type WAMediaUpload = Buffer | {
     url: URL | string;
-};
-export type WAMediaPayloadStream = {
+} | {
     stream: Readable;
 };
-export type WAMediaUpload = Buffer | WAMediaPayloadStream | WAMediaPayloadURL;
 /** Set of message types that are supported by the library */
 export type MessageType = keyof proto.Message;
-export declare enum WAMessageAddressingMode {
-    PN = "pn",
-    LID = "lid"
-}
-export type MessageWithContextInfo = 'imageMessage' | 'contactMessage' | 'locationMessage' | 'extendedTextMessage' | 'documentMessage' | 'audioMessage' | 'videoMessage' | 'call' | 'contactsArrayMessage' | 'liveLocationMessage' | 'templateMessage' | 'stickerMessage' | 'groupInviteMessage' | 'templateButtonReplyMessage' | 'productMessage' | 'listMessage' | 'orderMessage' | 'listResponseMessage' | 'buttonsMessage' | 'buttonsResponseMessage' | 'interactiveMessage' | 'interactiveResponseMessage' | 'pollCreationMessage' | 'requestPhoneNumberMessage' | 'messageHistoryBundle' | 'eventMessage' | 'newsletterAdminInviteMessage' | 'albumMessage' | 'stickerPackMessage' | 'pollResultSnapshotMessage' | 'messageHistoryNotice';
 export type DownloadableMessage = {
     mediaKey?: Uint8Array | null;
     directPath?: string | null;
@@ -72,8 +56,6 @@ export interface WAUrlInfo {
 type Mentionable = {
     /** list of jids that are mentioned in the accompanying text */
     mentions?: string[];
-    /** mention all */
-    mentionAll?: boolean;
 };
 type Contextable = {
     /** add contextInfo to the message */
@@ -82,9 +64,26 @@ type Contextable = {
 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 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 bnutton on the list (required) */
+    buttonText?: string;
+};
 type WithDimensions = {
     width?: number;
     height?: number;
@@ -95,25 +94,6 @@ export type PollMessageOptions = {
     values: string[];
     /** 32 byte message secret to encrypt poll selections */
     messageSecret?: Uint8Array;
-    toAnnouncementGroup?: boolean;
-};
-export type EventMessageOptions = {
-    name: string;
-    description?: string;
-    startDate: Date;
-    endDate?: Date;
-    location?: WALocationMessage;
-    call?: 'audio' | 'video';
-    isCancelled?: boolean;
-    isScheduleCall?: boolean;
-    extraGuestsAllowed?: boolean;
-    messageSecret?: Uint8Array<ArrayBufferLike>;
-};
-export type AlbumMessageOptions = {
-    /** Number of images expected in the album */
-    expectedImageCount?: number;
-    /** Number of videos expected in the album */
-    expectedVideoCount?: number;
 };
 type SharePhoneNumber = {
     sharePhoneNumber: boolean;
@@ -121,18 +101,19 @@ type SharePhoneNumber = {
 type RequestPhoneNumber = {
     requestPhoneNumber: boolean;
 };
+export type MediaType = keyof typeof MEDIA_HKDF_KEY_MAPPING;
 export type AnyMediaMessageContent = (({
     image: WAMediaUpload;
     caption?: string;
     jpegThumbnail?: string;
-} & Mentionable & Contextable & WithDimensions) | ({
+} & Mentionable & Contextable & Buttonable & Templatable & WithDimensions) | ({
     video: WAMediaUpload;
     caption?: string;
     gifPlayback?: boolean;
     jpegThumbnail?: string;
     /** if set to true, will send as a `video note` */
     ptv?: boolean;
-} & Mentionable & Contextable & WithDimensions) | {
+} & Mentionable & Contextable & Buttonable & Templatable & WithDimensions) | {
     audio: WAMediaUpload;
     /** if set to true, will send as a `voice note` */
     ptt?: boolean;
@@ -146,37 +127,23 @@ export type AnyMediaMessageContent = (({
     mimetype: string;
     fileName?: string;
     caption?: string;
-} & Contextable)) & {
+} & Contextable & Buttonable & Templatable)) & {
     mimetype?: string;
-} & Editable & {
-    /** key of the parent albumMessage to associate this media with */
-    albumParentKey?: WAMessageKey;
-};
+} & Editable;
 export type ButtonReplyInfo = {
     displayText: string;
     id: string;
     index: number;
 };
-export type GroupInviteInfo = {
-    inviteCode: string;
-    inviteExpiration: number;
-    text: string;
-    jid: string;
-    subject: string;
-};
 export type WASendableProduct = Omit<proto.Message.ProductMessage.IProductSnapshot, 'productImage'> & {
     productImage: WAMediaUpload;
 };
 export type AnyRegularMessageContent = (({
     text: string;
     linkPreview?: WAUrlInfo | null;
-} & Mentionable & Contextable & Editable) | AnyMediaMessageContent | {
-    event: EventMessageOptions;
-} | ({
+} & Mentionable & Contextable & Buttonable & Templatable & Listable & Editable) | AnyMediaMessageContent | ({
     poll: PollMessageOptions;
-} & Mentionable & Contextable & Editable) | ({
-    album: AlbumMessageOptions;
-} & Contextable & Mentionable) | {
+} & Mentionable & Contextable & Buttonable & Templatable & Editable) | {
     contacts: {
         displayName?: string;
         contacts: proto.Message.IContactMessage[];
@@ -188,17 +155,8 @@ export type AnyRegularMessageContent = (({
 } | {
     buttonReply: ButtonReplyInfo;
     type: 'template' | 'plain';
-} | {
-    groupInvite: GroupInviteInfo;
 } | {
     listReply: Omit<proto.Message.IListResponseMessage, 'contextInfo'>;
-} | {
-    pin: WAMessageKey;
-    type: proto.PinInChat.Type;
-    /**
-     * 24 hours, 7 days, 30 days
-     */
-    time?: 86400 | 604800 | 2592000;
 } | {
     product: WASendableProduct;
     businessOwnerJid?: string;
@@ -213,15 +171,13 @@ export type AnyMessageContent = AnyRegularMessageContent | {
     delete: WAMessageKey;
 } | {
     disappearingMessagesInChat: boolean | number;
-} | {
-    limitSharing: boolean;
 };
 export type GroupMetadataParticipants = Pick<GroupMetadata, 'participants'>;
 type MinimalRelayOptions = {
     /** override the message ID with a custom provided string */
     messageId?: string;
-    /** should we use group metadata cache, or fetch afresh from the server; default assumed to be "true" */
-    useCachedGroupMetadata?: boolean;
+    /** 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 */
@@ -244,6 +200,7 @@ export type MiscMessageGenerationOptions = MinimalRelayOptions & {
     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 */
@@ -260,35 +217,32 @@ export type MiscMessageGenerationOptions = MinimalRelayOptions & {
 export type MessageGenerationOptionsFromContent = MiscMessageGenerationOptions & {
     userJid: string;
 };
-export type WAMediaUploadFunction = (encFilePath: string, opts: {
+export type WAMediaUploadFunctionOpts = {
     fileEncSha256B64: string;
     mediaType: MediaType;
+    newsletter?: boolean;
     timeoutMs?: number;
-}) => Promise<{
+};
+export type WAMediaUploadFunction = (readStream: Readable | Buffer, opts: WAMediaUploadFunctionOpts) => Promise<{
     mediaUrl: string;
     directPath: string;
-    meta_hmac?: string;
-    ts?: number;
-    fbid?: number;
+    handle?: string;
 }>;
 export type MediaGenerationOptions = {
-    logger?: ILogger;
+    logger?: Logger;
     mediaTypeOverride?: MediaType;
     upload: WAMediaUploadFunction;
     /** cache media so it does not have to be uploaded again */
     mediaCache?: CacheStore;
     mediaUploadTimeoutMs?: number;
-    options?: RequestInit;
+    options?: AxiosRequestConfig;
     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>;
-    getCallLink?: (type: 'audio' | 'video', event?: {
-        startTime: number;
-    }) => Promise<string | undefined>;
-    jid?: string;
 };
 export type MessageGenerationOptions = MessageContentGenerationOptions & MessageGenerationOptionsFromContent;
 /**
@@ -300,7 +254,7 @@ export type MessageUpsertType = 'append' | 'notify';
 export type MessageUserReceipt = proto.IUserReceipt;
 export type WAMessageUpdate = {
     update: Partial<WAMessage>;
-    key: WAMessageKey;
+    key: proto.IMessageKey;
 };
 export type WAMessageCursor = {
     before: WAMessageKey | undefined;
@@ -308,13 +262,12 @@ export type WAMessageCursor = {
     after: WAMessageKey | undefined;
 };
 export type MessageUserReceiptUpdate = {
-    key: WAMessageKey;
+    key: proto.IMessageKey;
     receipt: MessageUserReceipt;
 };
 export type MediaDecryptionKeyInfo = {
-    iv: Uint8Array;
-    cipherKey: Uint8Array;
-    macKey?: Uint8Array;
+    iv: Buffer;
+    cipherKey: Buffer;
+    macKey?: Buffer;
 };
-export type MinimalMessage = Pick<WAMessage, 'key' | 'messageTimestamp'>;
-//# sourceMappingURL=Message.d.ts.map
+export type MinimalMessage = Pick<proto.IWebMessageInfo, 'key' | 'messageTimestamp'>;

package/lib/Types/Message.js

@@ -1,11 +1,9 @@
-import { proto } from '../../WAProto/index.js';
-// export the WAMessage Prototypes
-export { proto as WAProto };
-export const WAMessageStubType = proto.WebMessageInfo.StubType;
-export const WAMessageStatus = proto.WebMessageInfo.Status;
-export var WAMessageAddressingMode;
-(function (WAMessageAddressingMode) {
-    WAMessageAddressingMode["PN"] = "pn";
-    WAMessageAddressingMode["LID"] = "lid";
-})(WAMessageAddressingMode || (WAMessageAddressingMode = {}));
-//# sourceMappingURL=Message.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WAMessageStatus = exports.WAMessageStubType = exports.WAProto = void 0;
+const WAProto_1 = require("../../WAProto");
+Object.defineProperty(exports, "WAProto", { enumerable: true, get: function () { return WAProto_1.proto; } });
+// eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
+exports.WAMessageStubType = WAProto_1.proto.WebMessageInfo.StubType;
+// eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
+exports.WAMessageStatus = WAProto_1.proto.WebMessageInfo.Status;

package/lib/Types/Newsletter.d.ts

@@ -0,0 +1,103 @@
+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
+  /** 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 const MexOperations = {
+  PROMOTE: "NotificationNewsletterAdminPromote",
+  DEMOTE: "NotificationNewsletterAdminDemote",
+  UPDATE: "NotificationNewsletterUpdate"
+} as const
+
+export const 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",
+  SUBSCRIBED: "xwa2_newsletter_subscribed",
+  METADATA_UPDATE: "xwa2_notify_newsletter_on_metadata_update"
+} as const
+
+export const 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",
+  SUBSCRIBED: "6388546374527196"
+} as const

package/lib/Types/Newsletter.js

@@ -0,0 +1,38 @@
+"use strict"
+
+Object.defineProperty(exports, "__esModule", { value: true })
+
+const MexOperations = {
+  PROMOTE: "NotificationNewsletterAdminPromote",
+  DEMOTE: "NotificationNewsletterAdminDemote",
+  UPDATE: "NotificationNewsletterUpdate"
+}
+
+const 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",
+  SUBSCRIBED: "xwa2_newsletter_subscribed",
+  METADATA_UPDATE: "xwa2_notify_newsletter_on_metadata_update"
+}
+
+const 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",
+  SUBSCRIBED: "6388546374527196"
+}
+
+exports.MexOperations = MexOperations
+exports.XWAPaths = XWAPaths
+exports.QueryIds = QueryIds

package/lib/Types/Product.d.ts

@@ -1,4 +1,4 @@
-import type { WAMediaUpload } from './Message.js';
+import { WAMediaUpload } from './Message';
 export type CatalogResult = {
     data: {
         paging: {
@@ -76,4 +76,3 @@ export type GetCatalogOptions = {
     limit?: number;
     jid?: string;
 };
-//# sourceMappingURL=Product.d.ts.map

package/lib/Types/Product.js

@@ -1,2 +1,2 @@
-export {};
-//# sourceMappingURL=Product.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Types/Signal.d.ts

@@ -1,5 +1,4 @@
-import { proto } from '../../WAProto/index.js';
-import type { LIDMappingStore } from '../Signal/lid-mapping.js';
+import { proto } from '../../WAProto';
 type DecryptGroupSignalOpts = {
     group: string;
     authorJid: string;
@@ -23,10 +22,6 @@ type EncryptGroupMessageOpts = {
     data: Uint8Array;
     meId: string;
 };
-type GetSenderKeyDistributionMessageOpts = {
-    group: string;
-    meId: string;
-};
 type PreKey = {
     keyId: number;
     publicKey: Uint8Array;
@@ -38,7 +33,7 @@ type E2ESession = {
     registrationId: number;
     identityKey: Uint8Array;
     signedPreKey: SignedPreKey;
-    preKey?: PreKey;
+    preKey: PreKey;
 };
 type E2ESessionOpts = {
     jid: string;
@@ -56,32 +51,7 @@ export type SignalRepository = {
         senderKeyDistributionMessage: Uint8Array;
         ciphertext: Uint8Array;
     }>;
-    getSenderKeyDistributionMessage(opts: GetSenderKeyDistributionMessageOpts): Promise<Uint8Array>;
-    hasSenderKey(opts: GetSenderKeyDistributionMessageOpts): Promise<boolean>;
-    getSessionInfo(jid: string): Promise<{
-        baseKey: Uint8Array;
-        registrationId: number;
-    } | null>;
     injectE2ESession(opts: E2ESessionOpts): Promise<void>;
-    validateSession(jid: string): Promise<{
-        exists: boolean;
-        reason?: string;
-    }>;
     jidToSignalProtocolAddress(jid: string): string;
-    migrateSession(fromJid: string, toJid: string): Promise<{
-        migrated: number;
-        skipped: number;
-        total: number;
-    }>;
-    validateSession(jid: string): Promise<{
-        exists: boolean;
-        reason?: string;
-    }>;
-    deleteSession(jids: string[]): Promise<void>;
 };
-export interface SignalRepositoryWithLIDStore extends SignalRepository {
-    lidMapping: LIDMappingStore;
-    close?: () => void;
-}
 export {};
-//# sourceMappingURL=Signal.d.ts.map

package/lib/Types/Signal.js

@@ -1,2 +1,2 @@
-import { proto } from '../../WAProto/index.js';
-//# sourceMappingURL=Signal.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });