@hbmodsofc/baileys 1.0.6

package/lib/Socket/groups.d.ts

@@ -0,0 +1,115 @@
+/// <reference types="node" />
+import { proto } from '../../WAProto';
+import { GroupMetadata, ParticipantAction, SocketConfig } from '../Types';
+import { BinaryNode } from '../WABinary';
+export declare const makeGroupsSocket: (config: SocketConfig) => {
+    groupMetadata: (jid: string) => Promise<GroupMetadata>;
+    groupCreate: (subject: string, participants: string[]) => Promise<GroupMetadata>;
+    groupLeave: (id: string) => Promise<void>;
+    groupUpdateSubject: (jid: string, subject: string) => Promise<void>;
+    groupRequestParticipantsList: (jid: string) => Promise<{
+        [key: string]: string;
+    }[]>;
+    groupRequestParticipantsUpdate: (jid: string, participants: string[], action: 'approve' | 'reject') => Promise<{
+        status: string;
+        jid: string;
+    }[]>;
+    groupParticipantsUpdate: (jid: string, participants: string[], action: ParticipantAction) => Promise<{
+        status: string;
+        jid: string;
+        content: BinaryNode;
+    }[]>;
+    groupUpdateDescription: (jid: string, description?: string) => Promise<void>;
+    groupInviteCode: (jid: string) => Promise<string | undefined>;
+    groupRevokeInvite: (jid: string) => Promise<string | undefined>;
+    groupAcceptInvite: (code: string) => Promise<string | undefined>;
+    /**
+     * accept a GroupInviteMessage
+     * @param key the key of the invite message, or optionally only provide the jid of the person who sent the invite
+     * @param inviteMessage the message to accept
+     */
+    groupAcceptInviteV4: (key: string | proto.IMessageKey, inviteMessage: proto.Message.IGroupInviteMessage) => Promise<string>;
+    groupGetInviteInfo: (code: string) => Promise<GroupMetadata>;
+    groupToggleEphemeral: (jid: string, ephemeralExpiration: number) => Promise<void>;
+    groupSettingUpdate: (jid: string, setting: 'announcement' | 'not_announcement' | 'locked' | 'unlocked') => Promise<void>;
+    groupMemberAddMode: (jid: string, mode: 'admin_add' | 'all_member_add') => Promise<void>;
+    groupJoinApprovalMode: (jid: string, mode: 'on' | 'off') => Promise<void>;
+    groupFetchAllParticipating: () => Promise<{
+        [_: string]: GroupMetadata;
+    }>;
+    processingMutex: {
+        mutex<T>(code: () => T | Promise<T>): Promise<T>;
+    };
+    fetchPrivacySettings: (force?: boolean) => Promise<{
+        [_: string]: string;
+    }>;
+    upsertMessage: (msg: proto.IWebMessageInfo, type: import("../Types").MessageUpsertType) => Promise<void>;
+    appPatch: (patchCreate: import("../Types").WAPatchCreate) => Promise<void>;
+    sendPresenceUpdate: (type: import("../Types").WAPresence, toJid?: string | undefined) => Promise<void>;
+    presenceSubscribe: (toJid: string, tcToken?: Buffer | undefined) => Promise<void>;
+    profilePictureUrl: (jid: string, type?: "image" | "preview", timeoutMs?: number | undefined) => Promise<string | undefined>;
+    onWhatsApp: (...jids: string[]) => Promise<{
+        jid: string;
+        exists: unknown;
+        lid: unknown;
+    }[] | undefined>;
+    fetchBlocklist: () => Promise<string[]>;
+    fetchStatus: (jid: string) => Promise<{
+        status: string | undefined;
+        setAt: Date;
+    } | undefined>;
+    updateProfilePicture: (jid: string, content: import("../Types").WAMediaUpload) => Promise<void>;
+    removeProfilePicture: (jid: string) => Promise<void>;
+    updateProfileStatus: (status: string) => Promise<void>;
+    updateProfileName: (name: string) => Promise<void>;
+    updateBlockStatus: (jid: string, action: "block" | "unblock") => Promise<void>;
+    updateLastSeenPrivacy: (value: import("../Types").WAPrivacyValue) => Promise<void>;
+    updateOnlinePrivacy: (value: import("../Types").WAPrivacyOnlineValue) => Promise<void>;
+    updateProfilePicturePrivacy: (value: import("../Types").WAPrivacyValue) => Promise<void>;
+    updateStatusPrivacy: (value: import("../Types").WAPrivacyValue) => Promise<void>;
+    updateReadReceiptsPrivacy: (value: import("../Types").WAReadReceiptsValue) => Promise<void>;
+    updateGroupsAddPrivacy: (value: import("../Types").WAPrivacyValue) => Promise<void>;
+    updateDefaultDisappearingMode: (duration: number) => Promise<void>;
+    getBusinessProfile: (jid: string) => Promise<void | import("../Types").WABusinessProfile>;
+    resyncAppState: (collections: readonly ("critical_block" | "critical_unblock_low" | "regular_high" | "regular_low" | "regular")[], isInitialSync: boolean) => Promise<void>;
+    chatModify: (mod: import("../Types").ChatModification, jid: string) => Promise<void>;
+    cleanDirtyBits: (type: "account_sync" | "groups", fromTimestamp?: string | number | undefined) => Promise<void>;
+    addChatLabel: (jid: string, labelId: string) => Promise<void>;
+    removeChatLabel: (jid: string, labelId: string) => Promise<void>;
+    addMessageLabel: (jid: string, messageId: string, labelId: string) => Promise<void>;
+    removeMessageLabel: (jid: string, messageId: string, labelId: string) => Promise<void>;
+    star: (jid: string, messages: {
+        id: string;
+        fromMe?: boolean | undefined;
+    }[], star: boolean) => Promise<void>;
+    type: "md";
+    ws: any;
+    ev: import("../Types").BaileysEventEmitter & {
+        process(handler: (events: Partial<import("../Types").BaileysEventMap>) => void | Promise<void>): () => void;
+        buffer(): void;
+        createBufferedFunction<A extends any[], T_1>(work: (...args: A) => Promise<T_1>): (...args: A) => Promise<T_1>;
+        flush(force?: boolean | undefined): boolean;
+        isBuffering(): boolean;
+    };
+    authState: {
+        creds: import("../Types").AuthenticationCreds;
+        keys: import("../Types").SignalKeyStoreWithTransaction;
+    };
+    signalRepository: import("../Types").SignalRepository;
+    user: import("../Types").Contact | undefined;
+    generateMessageTag: () => string;
+    query: (node: BinaryNode, timeoutMs?: number | undefined) => Promise<BinaryNode>;
+    waitForMessage: <T_2>(msgId: string, timeoutMs?: number | undefined) => Promise<T_2>;
+    waitForSocketOpen: () => Promise<void>;
+    sendRawMessage: (data: Uint8Array | Buffer) => Promise<void>;
+    sendNode: (frame: BinaryNode) => Promise<void>;
+    logout: (msg?: string | undefined) => Promise<void>;
+    end: (error: Error | undefined) => void;
+    onUnexpectedError: (err: Error | import("@hapi/boom").Boom<any>, msg: string) => void;
+    uploadPreKeys: (count?: number) => Promise<void>;
+    uploadPreKeysToServerIfRequired: () => Promise<void>;
+    requestPairingCode: (phoneNumber: string) => Promise<string>;
+    waitForConnectionUpdate: (check: (u: Partial<import("../Types").ConnectionState>) => boolean | undefined, timeoutMs?: number | undefined) => Promise<void>;
+    sendWAMBuffer: (wamBuffer: Buffer) => Promise<BinaryNode>;
+};
+export declare const extractGroupMetadata: (result: BinaryNode) => GroupMetadata;

package/lib/Socket/groups.js

@@ -0,0 +1,317 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractGroupMetadata = exports.makeGroupsSocket = void 0;
+const WAProto_1 = require("../../WAProto");
+const Types_1 = require("../Types");
+const Utils_1 = require("../Utils");
+const WABinary_1 = require("../WABinary");
+const chats_1 = require("./chats");
+const WAUSync_1 = require("../WAUSync"); 
+const makeGroupsSocket = (config) => {
+    const sock = (0, chats_1.makeChatsSocket)(config);
+    const { authState, ev, query, upsertMessage } = sock;
+    const groupQuery = async (jid, type, content) => (query({
+        tag: 'iq',
+        attrs: {
+            type,
+            xmlns: 'w:g2',
+            to: jid,
+        },
+        content
+    }));
+    const groupMetadata = async (jid) => {
+        const result = await groupQuery(jid, 'get', [{ tag: 'query', attrs: { request: 'interactive' } }]);
+        return (0, exports.extractGroupMetadata)(result);
+    };
+    const groupFetchAllParticipating = async () => {
+        const result = await query({
+            tag: 'iq',
+            attrs: {
+                to: '@g.us',
+                xmlns: 'w:g2',
+                type: 'get',
+            },
+            content: [
+                {
+                    tag: 'participating',
+                    attrs: {},
+                    content: [
+                        { tag: 'participants', attrs: {} },
+                        { tag: 'description', attrs: {} }
+                    ]
+                }
+            ]
+        });
+        const data = {};
+        const groupsChild = (0, WABinary_1.getBinaryNodeChild)(result, 'groups');
+        if (groupsChild) {
+            const groups = (0, WABinary_1.getBinaryNodeChildren)(groupsChild, 'group');
+            for (const groupNode of groups) {
+                const meta = (0, exports.extractGroupMetadata)({
+                    tag: 'result',
+                    attrs: {},
+                    content: [groupNode]
+                });
+                data[meta.id] = meta;
+            }
+        }
+        sock.ev.emit('groups.update', Object.values(data));
+        return data;
+    };
+    sock.ws.on('CB:ib,,dirty', async (node) => {
+        const { attrs } = (0, WABinary_1.getBinaryNodeChild)(node, 'dirty');
+        if (attrs.type !== 'groups') {
+            return;
+        }
+        await groupFetchAllParticipating();
+        await sock.cleanDirtyBits('groups');
+    });
+    return {
+        ...sock,
+        groupMetadata,
+        groupCreate: async (subject, participants) => {
+            const key = (0, Utils_1.generateMessageID)();
+            const result = await groupQuery('@g.us', 'set', [
+                {
+                    tag: 'create',
+                    attrs: {
+                        subject,
+                        key
+                    },
+                    content: participants.map(jid => ({
+                        tag: 'participant',
+                        attrs: { jid }
+                    }))
+                }
+            ]);
+            return (0, exports.extractGroupMetadata)(result);
+        },
+        groupLeave: async (id) => {
+            await groupQuery('@g.us', 'set', [
+                {
+                    tag: 'leave',
+                    attrs: {},
+                    content: [
+                        { tag: 'group', attrs: { id } }
+                    ]
+                }
+            ]);
+        },
+        groupUpdateSubject: async (jid, subject) => {
+            await groupQuery(jid, 'set', [
+                {
+                    tag: 'subject',
+                    attrs: {},
+                    content: Buffer.from(subject, 'utf-8')
+                }
+            ]);
+        },
+        groupRequestParticipantsList: async (jid) => {
+            const result = await groupQuery(jid, 'get', [
+                {
+                    tag: 'membership_approval_requests',
+                    attrs: {}
+                }
+            ]);
+            const node = (0, WABinary_1.getBinaryNodeChild)(result, 'membership_approval_requests');
+            const participants = (0, WABinary_1.getBinaryNodeChildren)(node, 'membership_approval_request');
+            return participants.map(v => v.attrs);
+        },
+        groupRequestParticipantsUpdate: async (jid, participants, action) => {
+            const result = await groupQuery(jid, 'set', [{
+                    tag: 'membership_requests_action',
+                    attrs: {},
+                    content: [
+                        {
+                            tag: action,
+                            attrs: {},
+                            content: participants.map(jid => ({
+                                tag: 'participant',
+                                attrs: { jid }
+                            }))
+                        }
+                    ]
+                }]);
+            const node = (0, WABinary_1.getBinaryNodeChild)(result, 'membership_requests_action');
+            const nodeAction = (0, WABinary_1.getBinaryNodeChild)(node, action);
+            const participantsAffected = (0, WABinary_1.getBinaryNodeChildren)(nodeAction, 'participant');
+            return participantsAffected.map(p => {
+                return { status: p.attrs.error || '200', jid: p.attrs.jid };
+            });
+        },
+        groupParticipantsUpdate: async (jid, participants, action) => {
+            const result = await groupQuery(jid, 'set', [
+                {
+                    tag: action,
+                    attrs: {},
+                    content: participants.map(jid => ({
+                        tag: 'participant',
+                        attrs: { jid }
+                    }))
+                }
+            ]);
+            const node = (0, WABinary_1.getBinaryNodeChild)(result, action);
+            const participantsAffected = (0, WABinary_1.getBinaryNodeChildren)(node, 'participant');
+            return participantsAffected.map(p => {
+                return { status: p.attrs.error || '200', jid: p.attrs.jid, content: p };
+            });
+        },
+        groupUpdateDescription: async (jid, description) => {
+            var _a;
+            const metadata = await groupMetadata(jid);
+            const prev = (_a = metadata.descId) !== null && _a !== void 0 ? _a : null;
+            await groupQuery(jid, 'set', [
+                {
+                    tag: 'description',
+                    attrs: {
+                        ...(description ? { id: (0, Utils_1.generateMessageID)() } : { delete: 'true' }),
+                        ...(prev ? { prev } : {})
+                    },
+                    content: description ? [
+                        { tag: 'body', attrs: {}, content: Buffer.from(description, 'utf-8') }
+                    ] : undefined
+                }
+            ]);
+        },
+        groupInviteCode: async (jid) => {
+            const result = await groupQuery(jid, 'get', [{ tag: 'invite', attrs: {} }]);
+            const inviteNode = (0, WABinary_1.getBinaryNodeChild)(result, 'invite');
+            return inviteNode === null || inviteNode === void 0 ? void 0 : inviteNode.attrs.code;
+        },
+        groupRevokeInvite: async (jid) => {
+            const result = await groupQuery(jid, 'set', [{ tag: 'invite', attrs: {} }]);
+            const inviteNode = (0, WABinary_1.getBinaryNodeChild)(result, 'invite');
+            return inviteNode === null || inviteNode === void 0 ? void 0 : inviteNode.attrs.code;
+        },
+        groupAcceptInvite: async (code) => {
+            const results = await groupQuery('@g.us', 'set', [{ tag: 'invite', attrs: { code } }]);
+            const result = (0, WABinary_1.getBinaryNodeChild)(results, 'group');
+            return result === null || result === void 0 ? void 0 : result.attrs.jid;
+        },
+        /**
+         * accept a GroupInviteMessage
+         * @param key the key of the invite message, or optionally only provide the jid of the person who sent the invite
+         * @param inviteMessage the message to accept
+         */
+        groupAcceptInviteV4: ev.createBufferedFunction(async (key, inviteMessage) => {
+            key = typeof key === 'string' ? { remoteJid: key } : key;
+            const results = await groupQuery(inviteMessage.groupJid, 'set', [{
+                    tag: 'accept',
+                    attrs: {
+                        code: inviteMessage.inviteCode,
+                        expiration: inviteMessage.inviteExpiration.toString(),
+                        admin: key.remoteJid
+                    }
+                }]);
+            // if we have the full message key
+            // update the invite message to be expired
+            if (key.id) {
+                // create new invite message that is expired
+                inviteMessage = WAProto_1.proto.Message.GroupInviteMessage.fromObject(inviteMessage);
+                inviteMessage.inviteExpiration = 0;
+                inviteMessage.inviteCode = '';
+                ev.emit('messages.update', [
+                    {
+                        key,
+                        update: {
+                            message: {
+                                groupInviteMessage: inviteMessage
+                            }
+                        }
+                    }
+                ]);
+            }
+            // generate the group add message
+            await upsertMessage({
+                key: {
+                    remoteJid: inviteMessage.groupJid,
+                    id: (0, Utils_1.generateMessageID)(),
+                    fromMe: false,
+                    participant: key.remoteJid,
+                },
+                messageStubType: Types_1.WAMessageStubType.GROUP_PARTICIPANT_ADD,
+                messageStubParameters: [
+                    authState.creds.me.id
+                ],
+                participant: key.remoteJid,
+                messageTimestamp: (0, Utils_1.unixTimestampSeconds)()
+            }, 'notify');
+            return results.attrs.from;
+        }),
+        groupGetInviteInfo: async (code) => {
+            const results = await groupQuery('@g.us', 'get', [{ tag: 'invite', attrs: { code } }]);
+            return (0, exports.extractGroupMetadata)(results);
+        },
+        groupToggleEphemeral: async (jid, ephemeralExpiration) => {
+            const content = ephemeralExpiration ?
+                { tag: 'ephemeral', attrs: { expiration: ephemeralExpiration.toString() } } :
+                { tag: 'not_ephemeral', attrs: {} };
+            await groupQuery(jid, 'set', [content]);
+        },
+        groupSettingUpdate: async (jid, setting) => {
+            await groupQuery(jid, 'set', [{ tag: setting, attrs: {} }]);
+        },
+        groupMemberAddMode: async (jid, mode) => {
+            await groupQuery(jid, 'set', [{ tag: 'member_add_mode', attrs: {}, content: mode }]);
+        },
+        groupJoinApprovalMode: async (jid, mode) => {
+            await groupQuery(jid, 'set', [{ tag: 'membership_approval_mode', attrs: {}, content: [{ tag: 'group_join', attrs: { state: mode } }] }]);
+        },
+        groupFetchAllParticipating
+    };
+};
+exports.makeGroupsSocket = makeGroupsSocket;
+const extractGroupMetadata = (result) => {
+    var _a, _b;
+    const group = WABinary_1.getBinaryNodeChild(result, 'group');
+    const descChild = WABinary_1.getBinaryNodeChild(group, 'description');
+    let desc;
+    let descId;
+    let descOwner;
+    let descOwnerLid;
+    let descTime;
+    if (descChild) {
+        desc = WABinary_1.getBinaryNodeChildString(descChild, 'body');
+        descOwner = WABinary_1.jidNormalizedUser(descChild.attrs.participant_pn || descChild.attrs.participant);
+        if (group.attrs.addressing_mode === 'lid') {
+            descOwnerLid = WABinary_1.jidNormalizedUser(descChild.attrs.participant);
+        }
+        descId = descChild.attrs.id;
+        descTime = descChild.attrs.t ? +descChild.attrs.t : undefined;
+    }
+    const groupSize = group.attrs.size ? Number(group.attrs.size) : undefined;
+    const groupId = group.attrs.id.includes('@') ? group.attrs.id : (0, WABinary_1.jidEncode)(group.attrs.id, 'g.us');
+    const eph = WABinary_1.getBinaryNodeChild(group, 'ephemeral')?.attrs.expiration
+    const memberAddMode = WABinary_1.getBinaryNodeChildString(group, 'member_add_mode') === 'all_member_add';
+    const metadata = {
+        id: groupId,
+        addressingMode: group.attrs.addressing_mode,
+        subject: group.attrs.subject,
+        subjectOwner: WABinary_1.jidNormalizedUser(group.attrs.s_o_pn || group.attrs.s_o),
+        ...(group.attrs.addressing_mode === 'lid' ? { subjectOwnerLid: WABinary_1.jidNormalizedUser(group.attrs.s_o) } : {}),
+        subjectTime: group.attrs.s_t ? +group.attrs.s_t : undefined,
+        size: groupSize || WABinary_1.getBinaryNodeChildren(group, 'participant').length,
+        creation: group.attrs.creation ? +group.attrs.creation : undefined,
+        owner: WABinary_1.jidNormalizedUser(group.attrs.creator_pn || group.attrs.creator),
+        ...(group.attrs.addressing_mode === 'lid' ? { ownerLid: WABinary_1.jidNormalizedUser(group.attrs.creator) } : {}),
+        descOwner,
+        descOwnerLid,
+        restrict: !!WABinary_1.getBinaryNodeChild(group, 'locked'),
+        announce: !!WABinary_1.getBinaryNodeChild(group, 'announcement'),
+        isCommunity: !!WABinary_1.getBinaryNodeChild(group, 'parent'),
+        isCommunityAnnounce: !!WABinary_1.getBinaryNodeChild(group, 'default_sub_group'),
+        joinApprovalMode: !!WABinary_1.getBinaryNodeChild(group, 'membership_approval_mode'),
+        memberAddMode,
+        participants: WABinary_1.getBinaryNodeChildren(group, 'participant').map(({ attrs }) => {
+            return {
+                id: attrs.jid,
+                jid: attrs.phone_number || attrs.jid,
+                admin: (attrs.type || null),
+            };
+        }),
+        ephemeralDuration: eph ? +eph : undefined
+    };
+    return metadata;
+};
+exports.extractGroupMetadata = extractGroupMetadata;
+

package/lib/Socket/hbmods.d.ts

@@ -0,0 +1,253 @@
+import { proto } from '../../WAProto';
+
+declare namespace hbmodsofc {
+    interface MediaUploadOptions {
+        fileEncSha256?: Buffer;
+        mediaType?: string;
+        newsletter?: boolean;
+    }
+
+    type WAMediaUploadFunction = (
+        stream: Buffer | NodeJS.ReadableStream, 
+        options?: MediaUploadOptions
+    ) => Promise<{ url: string; directPath: string }>;
+
+    interface WAMessageContentGenerationOptions {
+        upload?: WAMediaUploadFunction;
+        mediaCache?: any;
+        options?: any;
+        logger?: any;
+    }
+
+    interface StickerMessage {
+        url: string;
+        fileSha256: Buffer | string;
+        fileEncSha256: Buffer | string;
+        mediaKey: Buffer | string;
+        mimetype: string;
+        directPath: string;
+        fileLength: number | string;
+        mediaKeyTimestamp: number | string;
+        isAnimated?: boolean;
+        stickerSentTs?: number | string;
+        isAvatar?: boolean;
+        isAiSticker?: boolean;
+        isLottie?: boolean;
+    }
+
+    interface PaymentMessage {
+        amount: number;
+        currency?: string;
+        from?: string;
+        expiry?: number;
+        sticker?: { stickerMessage: StickerMessage };
+        note?: string;
+        background?: {
+            id?: string;
+            fileLength?: string;
+            width?: number;
+            height?: number;
+            mimetype?: string;
+            placeholderArgb?: number;
+            textArgb?: number;
+            subtextArgb?: number;
+        };
+    }
+
+    interface ProductMessage {
+        title: string;
+        description: string;
+        thumbnail: Buffer | { url: string };
+        productId: string;
+        retailerId: string;
+        url: string;
+        body?: string;
+        footer?: string;
+        buttons?: proto.Message.InteractiveMessage.INativeFlowButton[];
+        priceAmount1000?: number | null;
+        currencyCode?: string;
+    }
+
+    interface InteractiveMessage {
+        header?: string;
+        title: string;
+        footer?: string;
+        thumbnail?: string;
+        image?: string | Buffer | { url: string };
+        video?: string | Buffer | { url: string };
+        document?: string | Buffer | { url: string };
+        mimetype?: string;
+        fileName?: string;
+        jpegThumbnail?: string | Buffer | { url: string };
+        contextInfo?: {
+            mentionedJid?: string[];
+            forwardingScore?: number;
+            isForwarded?: boolean;
+            externalAdReply?: {
+                title?: string;
+                body?: string;
+                mediaType?: number;
+                thumbnailUrl?: string;
+                mediaUrl?: string;
+                sourceUrl?: string;
+                showAdAttribution?: boolean;
+                renderLargerThumbnail?: boolean;
+                [key: string]: any;
+            };
+            [key: string]: any;
+        };
+        externalAdReply?: {
+            title?: string;
+            body?: string;
+            mediaType?: number;
+            thumbnailUrl?: string;
+            mediaUrl?: string;
+            sourceUrl?: string;
+            showAdAttribution?: boolean;
+            renderLargerThumbnail?: boolean;
+            [key: string]: any;
+        };
+        buttons?: proto.Message.InteractiveMessage.INativeFlowButton[];
+        nativeFlowMessage?: {
+            messageParamsJson?: string;
+            buttons?: proto.Message.InteractiveMessage.INativeFlowButton[];
+            [key: string]: any;
+        };
+    }
+
+    interface AlbumItem {
+        image?: string | Buffer | { url: string; caption?: string };
+        video?: string | Buffer | { url: string; caption?: string };
+    }
+
+    interface EventMessageLocation {
+        degreesLatitude: number;
+        degreesLongitude: number;
+        name: string;
+    }
+
+    interface EventMessage {
+        isCanceled?: boolean;
+        name: string;
+        description: string;
+        location?: EventMessageLocation;
+        joinLink?: string;
+        startTime?: string | number;
+        endTime?: string | number;
+        extraGuestsAllowed?: boolean;
+    }
+    
+    interface PollVote {
+        optionName: string;
+        optionVoteCount: string | number;
+    }
+    
+    interface PollResultMessage {
+        name: string;
+        pollVotes: PollVote[];
+    }
+
+    interface GroupStatusMessage {
+        message?: any;
+        image?: string | Buffer | { url: string };
+        video?: string | Buffer | { url: string };
+        text?: string;
+        caption?: string;
+        document?: string | Buffer | { url: string };
+        [key: string]: any;
+    }
+ 
+    interface MessageContent {
+        requestPaymentMessage?: PaymentMessage;
+        productMessage?: ProductMessage;
+        interactiveMessage?: InteractiveMessage;
+        albumMessage?: AlbumItem[];
+        eventMessage?: EventMessage;
+        pollResultMessage?: PollResultMessage;
+        groupStatusMessage?: GroupStatusMessage;
+        sender?: string;
+    }
+
+    interface MessageOptions {
+        quoted?: proto.IWebMessageInfo;
+        filter?: boolean;
+    }
+
+    interface Utils {
+        prepareWAMessageMedia: (media: any, options: WAMessageContentGenerationOptions) => Promise<any>;
+        generateWAMessageContent: (content: any, options: WAMessageContentGenerationOptions) => Promise<any>;
+        generateWAMessageFromContent: (jid: string, content: any, options?: any) => Promise<any>;
+        generateWAMessage: (jid: string, content: any, options?: any) => Promise<any>;
+        generateMessageID: () => string;
+        prepareMessageContent?: (content: any, options?: any) => Promise<any>;
+    }
+
+    interface BailUtils {
+        generateWAMessageContent?: (content: any, options: WAMessageContentGenerationOptions) => Promise<any>;
+        generateMessageID: () => string;
+        getContentType: (msg: any) => string;
+    }
+}
+
+declare class hbmodsofc {
+    constructor(
+        utils: hbmodsofc.Utils,
+        waUploadToServer: hbmodsofc.WAMediaUploadFunction,
+        relayMessageFn?: (jid: string, content: any, options?: any) => Promise<any>
+    );
+    
+    detectType(content: hbmodsofc.MessageContent): 'PAYMENT' | 'PRODUCT' | 'INTERACTIVE' | 'ALBUM' | 'EVENT' | 'POLL_RESULT' | 'GROUP_STORY' | null;
+
+    handlePayment(
+        content: { requestPaymentMessage: hbmodsofc.PaymentMessage },
+        quoted?: proto.IWebMessageInfo
+    ): Promise<{ requestPaymentMessage: proto.Message.RequestPaymentMessage }>;
+
+    handleProduct(
+        content: { productMessage: hbmodsofc.ProductMessage },
+        jid: string,
+        quoted?: proto.IWebMessageInfo
+    ): Promise<{ viewOnceMessage: proto.Message.ViewOnceMessage }>;
+
+    handleInteractive(
+        content: { interactiveMessage: hbmodsofc.InteractiveMessage },
+        jid: string,
+        quoted?: proto.IWebMessageInfo
+    ): Promise<{ interactiveMessage: proto.Message.InteractiveMessage }>;
+
+    handleAlbum(
+        content: { albumMessage: hbmodsofc.AlbumItem[] },
+        jid: string,
+        quoted?: proto.IWebMessageInfo
+    ): Promise<any>;
+
+    handleEvent(
+        content: { eventMessage: hbmodsofc.EventMessage },
+        jid: string,
+        quoted?: proto.IWebMessageInfo
+    ): Promise<any>;
+    
+    handlePollResult(
+        content: { pollResultMessage: hbmodsofc.PollResultMessage },
+        jid: string,
+        quoted?: proto.IWebMessageInfo
+    ): Promise<any>;
+
+    handleGroupStory(
+        content: { groupStatusMessage: hbmodsofc.GroupStatusMessage },
+        jid: string,
+        quoted?: proto.IWebMessageInfo
+    ): Promise<any>;
+
+    buildMessageContent(
+        content: any,
+        opts?: hbmodsofc.WAMessageContentGenerationOptions
+    ): Promise<any>;
+
+    utils: hbmodsofc.Utils;
+    relayMessage: (jid: string, content: any, options?: any) => Promise<any>;
+    waUploadToServer: hbmodsofc.WAMediaUploadFunction;
+    bail: hbmodsofc.BailUtils;
+}
+
+export = hbmodsofc;