@sixcore/baileys 1.0.0 → 1.0.2

package/lib/Types/Chat.d.ts

@@ -1,16 +1,13 @@
 import type { proto } from '../../WAProto';
 import type { AccountSettings } from './Auth';
 import type { BufferedEventData } from './Events';
-import type { LabelActionBody } from './Label';
 import type { ChatLabelAssociationActionBody } from './LabelAssociation';
 import type { MessageLabelAssociationActionBody } from './LabelAssociation';
-import type { MinimalMessage, WAMessageKey } from './Message';
+import type { MinimalMessage } from './Message';
 /** privacy settings in WhatsApp Web */
 export type WAPrivacyValue = 'all' | 'contacts' | 'contact_blacklist' | 'none';
 export type WAPrivacyOnlineValue = 'all' | 'match_last_seen';
-export type WAPrivacyGroupAddValue = 'all' | 'contacts' | 'contact_blacklist';
 export type WAReadReceiptsValue = 'all' | 'none';
-export type WAPrivacyCallValue = 'all' | 'known';
 /** set of statuses visible to other people; see updatePresence() in WhatsAppWeb.Send */
 export type WAPresence = 'unavailable' | 'available' | 'composing' | 'recording' | 'paused';
 export declare const ALL_WA_PATCH_NAMES: readonly ["critical_block", "critical_unblock_low", "regular_high", "regular_low", "regular"];
@@ -62,12 +59,12 @@ export type ChatModification = {
     /** mute for duration, or provide timestamp of mute to remove*/
     mute: number | null;
 } | {
-    clear: boolean;
-} | {
-    deleteForMe: {
-        deleteMedia: boolean;
-        key: WAMessageKey;
-        timestamp: number;
+    clear: 'all' | {
+        messages: {
+            id: string;
+            fromMe?: boolean;
+            timestamp: number;
+        }[];
     };
 } | {
     star: {
@@ -83,8 +80,6 @@ export type ChatModification = {
 } | {
     delete: true;
     lastMessages: LastMessageList;
-} | {
-    addLabel: LabelActionBody;
 } | {
     addChatLabel: ChatLabelAssociationActionBody;
 } | {

package/lib/Types/Events.d.ts

@@ -4,7 +4,7 @@ import { AuthenticationCreds } from './Auth';
 import { WACallEvent } from './Call';
 import { Chat, ChatUpdate, PresenceData } from './Chat';
 import { Contact } from './Contact';
-import { GroupMetadata, ParticipantAction, RequestJoinAction, RequestJoinMethod } from './GroupMetadata';
+import { GroupMetadata, ParticipantAction } from './GroupMetadata';
 import { Label } from './Label';
 import { LabelAssociation } from './LabelAssociation';
 import { MessageUpsertType, MessageUserReceiptUpdate, WAMessage, WAMessageKey, WAMessageUpdate } from './Message';
@@ -19,10 +19,7 @@ export type BaileysEventMap = {
         chats: Chat[];
         contacts: Contact[];
         messages: WAMessage[];
-        isLatest?: boolean;
-        progress?: number | null;
-        syncType?: proto.HistorySync.HistorySyncType;
-        peerDataRequestSessionId?: string | null;
+        isLatest: boolean;
     };
     /** upsert chats */
     'chats.upsert': Chat[];
@@ -61,12 +58,10 @@ export type BaileysEventMap = {
     /**
      * add/update the given messages. If they were received while the connection was online,
      * the update will have type: "notify"
-     * if requestId is provided, then the messages was received from the phone due to it being unavailable
      *  */
     'messages.upsert': {
         messages: WAMessage[];
         type: MessageUpsertType;
-        requestId?: string;
     };
     /** message was reacted to. If reaction was removed -- then "reaction.text" will be falsey */
     'messages.reaction': {
@@ -83,13 +78,6 @@ export type BaileysEventMap = {
         participants: string[];
         action: ParticipantAction;
     };
-    'group.join-request': {
-        id: string;
-        author: string;
-        participant: string;
-        action: RequestJoinAction;
-        method: RequestJoinMethod;
-    };
     'blocklist.set': {
         blocklist: string[];
     };
@@ -118,9 +106,6 @@ export type BufferedEventData = {
         };
         empty: boolean;
         isLatest: boolean;
-        progress?: number | null;
-        syncType?: proto.HistorySync.HistorySyncType;
-        peerDataRequestSessionId?: string;
     };
     chatUpserts: {
         [jid: string]: Chat;

package/lib/Types/GroupMetadata.d.ts

@@ -4,13 +4,12 @@ export type GroupParticipant = (Contact & {
     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 type ParticipantAction = 'add' | 'remove' | 'promote' | 'demote';
 export interface GroupMetadata {
     id: string;
     owner: string | undefined;
     subject: string;
+    addressingMode: "pn" | "lid";
     /** group subject owner */
     subjectOwner?: string;
     /** group subject modification date */

package/lib/Types/Label.d.ts

@@ -10,17 +10,6 @@ export interface Label {
     /** 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,

package/lib/Types/Label.js

@@ -24,4 +24,4 @@ var LabelColor;
     LabelColor[LabelColor["Color18"] = 17] = "Color18";
     LabelColor[LabelColor["Color19"] = 18] = "Color19";
     LabelColor[LabelColor["Color20"] = 19] = "Color20";
-})(LabelColor || (exports.LabelColor = LabelColor = {}));
+})(LabelColor = exports.LabelColor || (exports.LabelColor = {}));

package/lib/Types/LabelAssociation.js

@@ -6,4 +6,4 @@ var LabelAssociationType;
 (function (LabelAssociationType) {
     LabelAssociationType["Chat"] = "label_jid";
     LabelAssociationType["Message"] = "label_message";
-})(LabelAssociationType || (exports.LabelAssociationType = LabelAssociationType = {}));
+})(LabelAssociationType = exports.LabelAssociationType || (exports.LabelAssociationType = {}));

package/lib/Types/Message.d.ts

@@ -19,7 +19,6 @@ 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;
@@ -28,7 +27,6 @@ export type WAMediaUpload = Buffer | {
 } | {
     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 = {
@@ -55,19 +53,6 @@ export interface WAUrlInfo {
     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[];
@@ -88,35 +73,6 @@ type Templatable = {
     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;
 };
@@ -125,7 +81,7 @@ type Listable = {
     sections?: proto.Message.ListMessage.ISection[];
     /** Title of a List Message only */
     title?: string;
-    /** Text of the button on the list (required) */
+    /** Text of the bnutton on the list (required) */
     buttonText?: string;
 };
 type WithDimensions = {
@@ -138,12 +94,6 @@ export type PollMessageOptions = {
     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;
@@ -151,123 +101,48 @@ type SharePhoneNumber = {
 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) | ({
+} & 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;
-    annotations?: Annotations;
-} & Mentionable & Contextable & Buttonable & Templatable & Interactiveable & Shopable & Collectionable & Cardsable & WithDimensions) | {
+} & Mentionable & Contextable & Buttonable & Templatable & 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)) & {
+} & Contextable & Buttonable & Templatable)) & {
     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 WASendableProduct = Omit<proto.Message.ProductMessage.IProductSnapshot, 'productImage'> & {
+    productImage: WAMediaUpload;
 };
 export type AnyRegularMessageContent = (({
     text: string;
     linkPreview?: WAUrlInfo | null;
-} & Mentionable & Contextable & Buttonable & Templatable & Interactiveable & Shopable & Collectionable & Cardsable & Listable & Editable) | AnyMediaMessageContent | ({
+} & Mentionable & Contextable & Buttonable & Templatable & Listable & Editable) | AnyMediaMessageContent | ({
     poll: PollMessageOptions;
-} | {
-    pollResult: PollResultMessage;
 } & Mentionable & Contextable & Buttonable & Templatable & Editable) | {
     contacts: {
         displayName?: string;
@@ -275,49 +150,19 @@ export type AnyRegularMessageContent = (({
     };
 } | {
     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;
+    type: 'template' | 'plain';
 } | {
     listReply: Omit<proto.Message.IListResponseMessage, 'contextInfo'>;
-} | ({
+} | {
     product: WASendableProduct;
     businessOwnerJid?: string;
     body?: string;
     footer?: string;
-} & Mentionable & Contextable & Interactiveable & Shopable & Collectionable & Cardsable & WithDimensions) | SharePhoneNumber | RequestPhoneNumber) & ViewOnce;
+} | SharePhoneNumber | RequestPhoneNumber) & ViewOnce;
 export type AnyMessageContent = AnyRegularMessageContent | {
     forward: WAMessage;
     force?: boolean;
@@ -368,8 +213,6 @@ export type MiscMessageGenerationOptions = MinimalRelayOptions & {
     font?: number;
     /** if it is broadcast */
     broadcast?: boolean;
-    /** delay of message time */
-    delay?: number;
 };
 export type MessageGenerationOptionsFromContent = MiscMessageGenerationOptions & {
     userJid: string;
@@ -393,8 +236,6 @@ export type MediaGenerationOptions = {
     mediaCache?: CacheStore;
     mediaUploadTimeoutMs?: number;
     options?: AxiosRequestConfig;
-    /** the message you want to quote */
-    quoted?: WAMessage;
     backgroundColor?: string;
     font?: number;
     /** The message is for newsletter? */
@@ -402,7 +243,6 @@ export type MediaGenerationOptions = {
 };
 export type MessageContentGenerationOptions = MediaGenerationOptions & {
     getUrlInfo?: (text: string) => Promise<WAUrlInfo | undefined>;
-    getProfilePicUrl?: (jid: string, type: 'image' | 'preview') => Promise<string | undefined>;
 };
 export type MessageGenerationOptions = MessageContentGenerationOptions & MessageGenerationOptionsFromContent;
 /**

package/lib/Types/Newsletter.d.ts

@@ -1,92 +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';
+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;
-};
+  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';
+  /** 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 declare enum MexOperations {
-    PROMOTE = "NotificationNewsletterAdminPromote",
-    DEMOTE = "NotificationNewsletterAdminDemote",
-    UPDATE = "NotificationNewsletterUpdate"
+  reaction_codes: {
+    blocked_codes: null
+    enabled_ts_sec: null
+    value: NewsletterReactionMode
+  }
 }
-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"
+
+/** only exists reaction mode update */
+export type NewsletterSettingsUpdate = ReactionModeUpdate
+
+export type NewsletterReaction = {
+  count: number
+  code: string
 }
-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"
+
+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