@neelegirl/baileys 1.5.5 → 1.5.7

package/lib/Types/Call.d.ts

@@ -0,0 +1,14 @@
+export type WACallUpdateType = 'offer' | 'ringing' | 'timeout' | 'reject' | 'accept' | 'terminate'
+
+export type WACallEvent = {
+    chatId: string
+    from: string
+    isGroup?: boolean
+    groupJid?: string
+    id: string
+    date: Date
+    isVideo?: boolean
+    status: WACallUpdateType
+    offline: boolean
+    latencyMs?: number
+}

package/lib/Types/Call.js

@@ -0,0 +1,3 @@
+"use strict"
+
+Object.defineProperty(exports, "__esModule", { value: true })

package/lib/Types/Chat.d.ts

@@ -0,0 +1,138 @@
+import type { proto } from '../../WAProto'
+import type { AccountSettings } from './Auth'
+import type { ContactAction } from './Contact'
+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'
+
+/** 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'
+
+export type WAPrivacyMessagesValue = 'all' | 'contacts'
+
+/** 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"]
+
+export type WAPatchName = typeof ALL_WA_PATCH_NAMES[number]
+
+export type BotListInfo = {
+    jid: string
+    personaId: string
+}
+
+export interface PresenceData {
+    lastKnownPresence: WAPresence
+    lastSeen?: number
+}
+
+export type ChatMutation = {
+    syncAction: proto.ISyncActionData
+    index: string[]
+}
+
+export type WAPatchCreate = {
+    syncAction: proto.ISyncActionValue
+    index: string[]
+    type: WAPatchName
+    apiVersion: number
+    operation: proto.SyncdMutation.SyncdOperation
+}
+
+export type Chat = proto.IConversation & {
+    /** unix timestamp of when the last message was received in the chat */
+    lastMessageRecvTimestamp?: number
+}
+
+export type ChatUpdate = Partial<Chat & {
+    /**
+     * if specified in the update,
+     * the EV buffer will check if the condition gets fulfilled before applying the update
+     * Right now, used to determine when to release an app state sync event
+     *
+     * @returns true, if the update should be applied
+     * false if it can be discarded
+     * undefined if the condition is not yet fulfilled
+     * */
+    conditional: (bufferedData: BufferedEventData) => boolean | undefined
+}>
+
+/**
+ * the last messages in a chat, sorted reverse-chronologically. That is, the latest message should be first in the chat
+ * for MD modifications, the last message in the array (i.e. the earlist message) must be the last message recv in the chat
+ * */
+export type LastMessageList = MinimalMessage[] | proto.SyncActionValue.ISyncActionMessageRange
+
+export type ChatModification = {
+    archive: boolean
+    lastMessages: LastMessageList
+} | {
+    contact: ContactAction | null
+} | {
+    pushNameSetting: string
+} | {
+    pin: boolean
+} | {
+    /** mute for duration, or provide timestamp of mute to remove*/
+    mute: number | null
+} | {
+    clear: boolean
+} | {
+    deleteForMe: {
+        deleteMedia: boolean
+        key: WAMessageKey
+        timestamp: number
+    }
+} | {
+    star: {
+        messages: {
+            id: string
+            fromMe?: boolean
+        }[]
+        star: boolean
+    }
+} | {
+    markRead: boolean
+    lastMessages: LastMessageList
+} | {
+    delete: true
+    lastMessages: LastMessageList
+} | {
+    contact: proto.SyncActionValue.IContactAction | null
+} | {
+    disableLinkPreviews: proto.SyncActionValue.IPrivacySettingDisableLinkPreviewsAction
+} | {
+    addLabel: LabelActionBody
+} | {
+    addChatLabel: ChatLabelAssociationActionBody
+} | {
+    removeChatLabel: ChatLabelAssociationActionBody
+} | {
+    addMessageLabel: MessageLabelAssociationActionBody
+} | {
+    removeMessageLabel: MessageLabelAssociationActionBody
+}
+
+export type InitialReceivedChatsState = {
+    [jid: string]: {
+        /** the last message received from the other party */
+        lastMsgRecvTimestamp?: number
+        /** the absolute last message in the chat */
+        lastMsgTimestamp: number
+    }
+}
+
+export type InitialAppStateSyncOptions = {
+    accountSettings: AccountSettings
+}

package/lib/Types/Chat.js

@@ -0,0 +1,9 @@
+"use strict"
+
+Object.defineProperty(exports, "__esModule", { value: true })
+
+const ALL_WA_PATCH_NAMES = ['critical_block', 'critical_unblock_low', 'regular_high', 'regular_low', 'regular']
+
+module.exports = {
+  ALL_WA_PATCH_NAMES
+}

package/lib/Types/Contact.d.ts

@@ -0,0 +1,20 @@
+export interface Contact {
+    id: string
+    lid?: string
+    jid?: string
+    /** name of the contact, you have saved on your WA */
+    name?: string
+    /** name of the contact, the contact has set on their own on WA */
+    notify?: string
+    /** I have no idea */
+    verifiedName?: string
+    /**
+     * Url of the profile picture of the contact
+     *
+     * 'changed' => if the profile picture has changed
+     * null => if the profile picture has not been set (default profile picture)
+     * any other string => url of the profile picture
+     */
+    imgUrl?: string | null
+    status?: string
+}

package/lib/Types/Contact.js

@@ -0,0 +1,3 @@
+"use strict"
+
+Object.defineProperty(exports, "__esModule", { value: true })

package/lib/Types/Events.d.ts

@@ -0,0 +1,229 @@
+import type { Boom } from '@hapi/boom'
+import { proto } from '../../WAProto'
+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 { Label } from './Label'
+import { LabelAssociation } from './LabelAssociation'
+import { MessageUpsertType, MessageUserReceiptUpdate, WAMessage, WAMessageKey, WAMessageUpdate } from './Message'
+import { NewsletterViewRole, SubscriberAction, NewsletterSettingsUpdate } from './Newsletter'
+import { ConnectionState } from './State'
+
+export type BaileysEventMap = {
+    /** connection state has been updated -- WS closed, opened, connecting etc. */
+    'connection.update': Partial<ConnectionState>
+    /** credentials updated -- some metadata, keys or something */
+    'creds.update': Partial<AuthenticationCreds>
+    /** set chats (history sync), everything is reverse chronologically sorted */
+    'messaging-history.set': {
+        chats: Chat[]
+        contacts: Contact[]
+        messages: WAMessage[]
+        isLatest?: boolean
+        progress?: number | null
+        syncType?: proto.HistorySync.HistorySyncType
+        peerDataRequestSessionId?: string | null
+    }
+    /** upsert chats */
+    'chats.upsert': Chat[]
+    /** update the given chats */
+    'chats.update': ChatUpdate[]
+    'chats.phoneNumberShare': {
+        lid: string
+        jid: string
+    }
+    /** delete chats with given ID */
+    'chats.delete': string[]
+    /** presence of contact in a chat updated */
+    'presence.update': {
+        id: string
+        presences: {
+            [participant: string]: PresenceData
+        }
+    }
+    'contacts.upsert': Contact[]
+    'contacts.update': Partial<Contact>[]
+    'messages.delete': {
+        keys: WAMessageKey[]
+    } | {
+        jid: string
+        all: true
+    }
+    'messages.update': WAMessageUpdate[]
+    'messages.media-update': {
+        key: WAMessageKey
+        media?: {
+            ciphertext: Uint8Array
+            iv: Uint8Array
+        }
+        error?: Boom
+    }[]
+    /**
+     * 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
+    }
+    // 'messages.poll': {
+    // 	key: WAMessageKey
+    //     pollUpdates: proto.IPollUpdateMessage
+    // }[]
+    /** message was reacted to. If reaction was removed -- then "reaction.text" will be falsey */
+    'messages.reaction': {
+        key: WAMessageKey
+        reaction: proto.IReaction
+    }[]
+    'message-receipt.update': MessageUserReceiptUpdate[]
+    'groups.upsert': GroupMetadata[]
+    'groups.update': Partial<GroupMetadata>[]
+    /** apply an action to participants in a group */
+    'group-participants.update': {
+        id: string
+        author: string
+        participants: string[]
+        action: ParticipantAction
+    }
+    'group.join-request': {
+        id: string
+        author: string
+        participant: string
+        action: RequestJoinAction
+        method: RequestJoinMethod
+    }
+    'newsletter.reaction': {
+    	id: string
+        newsletter_server_id: string
+        reaction: {
+        	code?: string
+            count?: number
+            removed?: boolean
+        }
+    }
+    'newsletter.view': {
+    	id: string
+        newsletter_server_id: string
+        count: number
+    }
+    'newsletter-participants.update': {
+    	id: string
+        author: string
+        user: string
+        new_role: NewsletterViewRole
+        action: SubscriberAction
+    }
+    'newsletter-settings.update': {
+    	id: string
+        update: NewsletterSettingsUpdate
+    }
+    'limit-sharing.update': {
+        id: string
+        author: string
+        action: 'on' | 'off'
+        trigger: proto.LimitSharing.TriggerType
+        update_time: number
+    }
+    'community-owner.update': {
+        id: string
+        author: string
+        user: string
+        new_role: 'SUPERADMIN_MEMBER'
+        update_time: number
+    }
+    'blocklist.set': {
+        blocklist: string[]
+    }
+    'blocklist.update': {
+        blocklist: string[]
+        type: 'add' | 'remove'
+    }
+    /** Receive an update on a call, including when the call was received, rejected, accepted */
+    'call': WACallEvent[]
+    'labels.edit': Label
+    'labels.association': {
+        association: LabelAssociation
+        type: 'add' | 'remove'
+    }
+}
+
+export type BufferedEventData = {
+    historySets: {
+        chats: {
+            [jid: string]: Chat
+        }
+        contacts: {
+            [jid: string]: Contact
+        }
+        messages: {
+            [uqId: string]: WAMessage
+        }
+        empty: boolean
+        isLatest: boolean
+        progress?: number | null
+        syncType?: proto.HistorySync.HistorySyncType
+        peerDataRequestSessionId?: string
+    }
+    chatUpserts: {
+        [jid: string]: Chat
+    }
+    chatUpdates: {
+        [jid: string]: ChatUpdate
+    }
+    chatDeletes: Set<string>
+    contactUpserts: {
+        [jid: string]: Contact
+    }
+    contactUpdates: {
+        [jid: string]: Partial<Contact>
+    }
+    messageUpserts: {
+        [key: string]: {
+            type: MessageUpsertType
+            message: WAMessage
+        }
+    }
+    messageUpdates: {
+        [key: string]: WAMessageUpdate
+    }
+    messageDeletes: {
+        [key: string]: WAMessageKey
+    }
+    // messagePollings: {
+    //     [key: string]: {
+    //        key: WAMessageKey
+    //        pollUpdates: proto.IPollUpdateMessage[]
+    //    }
+    // }
+    messageReactions: {
+        [key: string]: {
+            key: WAMessageKey
+            reactions: proto.IReaction[]
+        }
+    }
+    messageReceipts: {
+        [key: string]: {
+            key: WAMessageKey
+            userReceipt: proto.IUserReceipt[]
+        }
+    }
+    groupUpdates: {
+        [jid: string]: Partial<GroupMetadata>
+    }
+     communityUpdates: {
+        [jid: string]: Partial<GroupMetadata>
+    }
+}
+
+export type BaileysEvent = keyof BaileysEventMap
+
+export interface BaileysEventEmitter {
+    on<T extends keyof BaileysEventMap>(event: T, listener: (arg: BaileysEventMap[T]) => void): void
+    off<T extends keyof BaileysEventMap>(event: T, listener: (arg: BaileysEventMap[T]) => void): void
+    removeAllListeners<T extends keyof BaileysEventMap>(event: T): void
+    emit<T extends keyof BaileysEventMap>(event: T, arg: BaileysEventMap[T]): boolean
+}

package/lib/Types/Events.js

@@ -0,0 +1,3 @@
+"use strict"
+
+Object.defineProperty(exports, "__esModule", { value: true })

package/lib/Types/GroupMetadata.d.ts

@@ -0,0 +1,66 @@
+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
+    addressingMode: string
+    owner: string | undefined
+    ownerCountry: string, 
+    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[]
+    picture?: string
+    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/GroupMetadata.js

@@ -0,0 +1,3 @@
+"use strict"
+
+Object.defineProperty(exports, "__esModule", { value: true })

package/lib/Types/Label.d.ts

@@ -0,0 +1,48 @@
+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 const 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/Label.js

@@ -0,0 +1,31 @@
+"use strict"
+
+Object.defineProperty(exports, "__esModule", { value: true })
+
+/** WhatsApp has 20 predefined colors */
+const 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
+}
+
+module.exports = {
+  LabelColor
+}

package/lib/Types/LabelAssociation.d.ts

@@ -0,0 +1,35 @@
+/** Association type */
+export declare const 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/LabelAssociation.js

@@ -0,0 +1,13 @@
+"use strict"
+
+Object.defineProperty(exports, "__esModule", { value: true })
+
+/** Association type */
+const LabelAssociationType = {
+	Chat: "label_jid", 
+	Message: "label_message"
+}
+
+module.exports = {
+  LabelAssociationType
+}