alipclutch-baileys 8.5.3 → 8.5.5

package/lib/Socket/registration.d.ts

@@ -0,0 +1,267 @@
+/// <reference types="node" />
+import { AxiosRequestConfig } from 'axios';
+import { KeyPair, SignedKeyPair, SocketConfig } from '../Types';
+export declare const makeRegistrationSocket: (config: SocketConfig) => {
+    register: (code: string) => Promise<ExistsResponse>;
+    requestRegistrationCode: (registrationOptions?: RegistrationOptions) => Promise<ExistsResponse>;
+    logger: import("pino").Logger<import("pino").LoggerOptions>;
+    getOrderDetails: (orderId: string, tokenBase64: string) => Promise<import("../Types").OrderDetails>;
+    getCatalog: ({ jid, limit, cursor }: import("../Types").GetCatalogOptions) => Promise<{
+        products: import("../Types").Product[];
+        nextPageCursor: string | undefined;
+    }>;
+    getCollections: (jid?: string | undefined, limit?: number) => Promise<{
+        collections: import("../Types").CatalogCollection[];
+    }>;
+    productCreate: (create: import("../Types").ProductCreate) => Promise<import("../Types").Product>;
+    productDelete: (productIds: string[]) => Promise<{
+        deleted: number;
+    }>;
+    productUpdate: (productId: string, update: import("../Types").ProductUpdate) => Promise<import("../Types").Product>;
+    sendMessageAck: ({ tag, attrs, content }: import("../WABinary").BinaryNode) => Promise<void>;
+    sendRetryRequest: (node: import("../WABinary").BinaryNode, forceIncludeKeys?: boolean) => Promise<void>;
+    offerCall: (toJid: string, isVideo?: boolean) => Promise<{
+        id: string;
+        to: string;
+    }>;
+    rejectCall: (callId: string, callFrom: string) => Promise<void>;
+    getPrivacyTokens: (jids: string[]) => Promise<import("../WABinary").BinaryNode>;
+    assertSessions: (jids: string[], force: boolean) => Promise<boolean>;
+    relayMessage: (jid: string, message: import("../Types").WAProto.IMessage, { messageId: msgId, participant, additionalAttributes, additionalNodes, useUserDevicesCache, cachedGroupMetadata, statusJidList }: import("../Types").MessageRelayOptions) => Promise<string>;
+    sendReceipt: (jid: string, participant: string | undefined, messageIds: string[], type: import("../Types").MessageReceiptType) => Promise<void>;
+    sendReceipts: (keys: import("../Types").WAProto.IMessageKey[], type: import("../Types").MessageReceiptType) => Promise<void>;
+    getButtonArgs: (message: import("../Types").WAProto.IMessage) => {
+        [key: string]: string;
+    };
+    readMessages: (keys: import("../Types").WAProto.IMessageKey[]) => Promise<void>;
+    refreshMediaConn: (forceGet?: boolean) => Promise<import("../Types").MediaConnInfo>;
+    getUSyncDevices: (jids: string[], useCache: boolean, ignoreZeroDevices: boolean) => Promise<import("../WABinary").JidWithDevice[]>;
+    createParticipantNodes: (jids: string[], message: import("../Types").WAProto.IMessage, extraAttrs?: {
+        [key: string]: string;
+    } | undefined) => Promise<{
+        nodes: import("../WABinary").BinaryNode[];
+        shouldIncludeDeviceIdentity: boolean;
+    }>;
+    waUploadToServer: import("../Types").WAMediaUploadFunction;
+    fetchPrivacySettings: (force?: boolean) => Promise<{
+        [_: string]: string;
+    }>;
+    updateMediaMessage: (message: import("../Types").WAProto.IWebMessageInfo) => Promise<import("../Types").WAProto.IWebMessageInfo>;
+    sendMessage: (jid: string, content: import("../Types").AnyMessageContent, options?: import("../Types").MiscMessageGenerationOptions) => Promise<import("../Types").WAProto.WebMessageInfo | undefined>;
+    subscribeNewsletterUpdates: (jid: string) => Promise<{
+        duration: string;
+    }>;
+    newsletterReactionMode: (jid: string, mode: import("../Types").NewsletterReactionMode) => Promise<void>;
+    newsletterUpdateDescription: (jid: string, description?: string | undefined) => Promise<void>;
+    newsletterUpdateName: (jid: string, name: string) => Promise<void>;
+    newsletterUpdatePicture: (jid: string, content: import("../Types").WAMediaUpload) => Promise<void>;
+    newsletterRemovePicture: (jid: string) => Promise<void>;
+    newsletterUnfollow: (jid: string) => Promise<void>;
+    newsletterFollow: (jid: string) => Promise<void>;
+    newsletterUnmute: (jid: string) => Promise<void>;
+    newsletterMute: (jid: string) => Promise<void>;
+    newsletterAction: (jid: string, type: "mute" | "follow" | "unfollow" | "unmute") => Promise<void>;
+    newsletterCreate: (name: string, description: string, reaction_codes: string) => Promise<import("../Types").NewsletterMetadata>;
+    newsletterMetadata: (type: "invite" | "jid", key: string, role?: import("../Types").NewsletterViewRole | undefined) => Promise<import("../Types").NewsletterMetadata>;
+    newsletterAdminCount: (jid: string) => Promise<number>;
+    newsletterChangeOwner: (jid: string, user: string) => Promise<void>;
+    newsletterDemote: (jid: string, user: string) => Promise<void>;
+    newsletterDelete: (jid: string) => Promise<void>;
+    newsletterReactMessage: (jid: string, serverId: string, code?: string | undefined) => Promise<void>;
+    newsletterFetchMessages: (type: "invite" | "jid", key: string, count: number, after?: number | undefined) => Promise<import("../Types").NewsletterFetchedUpdate[]>;
+    newsletterFetchUpdates: (jid: string, count: number, after?: number | undefined, since?: number | undefined) => Promise<import("../Types").NewsletterFetchedUpdate[]>;
+    groupMetadata: (jid: string) => Promise<import("../Types").GroupMetadata>;
+    groupCreate: (subject: string, participants: string[]) => Promise<import("../Types").GroupMetadata>;
+    groupLeave: (id: string) => Promise<void>;
+    /** the network code of your mobile network
+     * @see {@link https://de.wikipedia.org/wiki/Mobile_Network_Code}
+     */
+    groupUpdateSubject: (jid: string, subject: string) => Promise<void>;
+    groupRequestParticipantsList: (jid: string) => Promise<{
+        [key: string]: string;
+    }[]>;
+    groupRequestParticipantsUpdate: (jid: string, participants: string[], action: "reject" | "approve") => Promise<{
+        status: string;
+        jid: string;
+    }[]>;
+    groupParticipantsUpdate: (jid: string, participants: string[], action: import("../Types").ParticipantAction) => Promise<{
+        status: string;
+        jid: string;
+        content: import("../WABinary").BinaryNode;
+    }[]>;
+    groupUpdateDescription: (jid: string, description?: string | undefined) => Promise<void>;
+    groupInviteCode: (jid: string) => Promise<string | undefined>;
+    groupRevokeInvite: (jid: string) => Promise<string | undefined>;
+    groupAcceptInvite: (code: string) => Promise<string | undefined>;
+    groupAcceptInviteV4: (key: string | import("../Types").WAProto.IMessageKey, inviteMessage: import("../Types").WAProto.Message.IGroupInviteMessage) => Promise<string>;
+    groupGetInviteInfo: (code: string) => Promise<import("../Types").GroupMetadata>;
+    groupToggleEphemeral: (jid: string, ephemeralExpiration: number) => Promise<void>;
+    groupSettingUpdate: (jid: string, setting: "announcement" | "locked" | "not_announcement" | "unlocked") => Promise<void>;
+    groupMemberAddMode: (jid: string, mode: "all_member_add" | "admin_add") => Promise<void>;
+    groupJoinApprovalMode: (jid: string, mode: "on" | "off") => Promise<void>;
+    groupFetchAllParticipating: () => Promise<{
+        [_: string]: import("../Types").GroupMetadata;
+    }>;
+    processingMutex: {
+        mutex<T>(code: () => T | Promise<T>): Promise<T>;
+    };
+    upsertMessage: (msg: import("../Types").WAProto.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<{
+        exists: boolean;
+        jid: string;
+    }[]>;
+    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: import("../WABinary").BinaryNode, timeoutMs?: number | undefined) => Promise<import("../WABinary").BinaryNode>;
+    waitForMessage: <T_2>(msgId: string, timeoutMs?: number | undefined) => Promise<T_2>;
+    waitForSocketOpen: () => Promise<void>;
+    sendRawMessage: (data: Uint8Array | Buffer) => Promise<void>;
+    sendNode: (frame: import("../WABinary").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<import("../WABinary").BinaryNode>;
+};
+export interface RegistrationData {
+    registrationId: number;
+    signedPreKey: SignedKeyPair;
+    noiseKey: KeyPair;
+    signedIdentityKey: KeyPair;
+    identityId: Buffer;
+    phoneId: string;
+    deviceId: string;
+    backupToken: Buffer;
+}
+export interface RegistrationOptions {
+    /** your phone number */
+    phoneNumber?: string;
+    /** the country code of your phone number */
+    phoneNumberCountryCode: string;
+    /** your phone number without country code */
+    phoneNumberNationalNumber: string;
+    /** the country code of your mobile network
+     * @see {@link https://de.wikipedia.org/wiki/Mobile_Country_Code}
+     */
+    phoneNumberMobileCountryCode: string;
+    /** the network code of your mobile network
+     * @see {@link https://de.wikipedia.org/wiki/Mobile_Network_Code}
+     */
+    phoneNumberMobileNetworkCode: string;
+    /**
+     * How to send the one time code
+     */
+    method?: 'sms' | 'voice' | 'captcha';
+    /**
+     * The captcha code if it was requested
+     */
+    captcha?: string;
+}
+export type RegistrationParams = RegistrationData & RegistrationOptions;
+export declare function registrationParams(params: RegistrationParams): {
+    cc: string;
+    in: string;
+    Rc: string;
+    lg: string;
+    lc: string;
+    mistyped: string;
+    authkey: string;
+    e_regid: string;
+    e_keytype: string;
+    e_ident: string;
+    e_skey_id: string;
+    e_skey_val: string;
+    e_skey_sig: string;
+    fdid: string;
+    network_ratio_type: string;
+    expid: string;
+    simnum: string;
+    hasinrc: string;
+    pid: string;
+    id: string;
+    backup_token: string;
+    token: string;
+    fraud_checkpoint_code: string | undefined;
+};
+/**
+ * Requests a registration code for the given phone number.
+ */
+export declare function mobileRegisterCode(params: RegistrationParams, fetchOptions?: AxiosRequestConfig): Promise<ExistsResponse>;
+export declare function mobileRegisterExists(params: RegistrationParams, fetchOptions?: AxiosRequestConfig): Promise<ExistsResponse>;
+/**
+ * Registers the phone number on whatsapp with the received OTP code.
+ */
+export declare function mobileRegister(params: RegistrationParams & {
+    code: string;
+}, fetchOptions?: AxiosRequestConfig): Promise<ExistsResponse>;
+/**
+ * Encrypts the given string as AEAD aes-256-gcm with the public whatsapp key and a random keypair.
+ */
+export declare function mobileRegisterEncrypt(data: string): string;
+export declare function mobileRegisterFetch(path: string, opts?: AxiosRequestConfig): Promise<ExistsResponse>;
+export interface ExistsResponse {
+    status: 'fail' | 'sent';
+    voice_length?: number;
+    voice_wait?: number;
+    sms_length?: number;
+    sms_wait?: number;
+    reason?: 'incorrect' | 'missing_param' | 'code_checkpoint';
+    login?: string;
+    flash_type?: number;
+    ab_hash?: string;
+    ab_key?: string;
+    exp_cfg?: string;
+    lid?: string;
+    image_blob?: string;
+    audio_blob?: string;
+}

package/lib/Socket/registration.js

@@ -0,0 +1,166 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mobileRegisterFetch = exports.mobileRegisterEncrypt = exports.mobileRegister = exports.mobileRegisterExists = exports.mobileRegisterCode = exports.registrationParams = exports.makeRegistrationSocket = void 0;
+/* eslint-disable camelcase */
+const axios_1 = __importDefault(require("axios"));
+const Defaults_1 = require("../Defaults");
+const crypto_1 = require("../Utils/crypto");
+const WABinary_1 = require("../WABinary");
+const business_1 = require("./business");
+function urlencode(str) {
+    return str.replace(/-/g, '%2d').replace(/_/g, '%5f').replace(/~/g, '%7e');
+}
+const validRegistrationOptions = (config) => (config === null || config === void 0 ? void 0 : config.phoneNumberCountryCode) &&
+    config.phoneNumberNationalNumber &&
+    config.phoneNumberMobileCountryCode;
+const makeRegistrationSocket = (config) => {
+    const sock = (0, business_1.makeBusinessSocket)(config);
+    const register = async (code) => {
+        if (!validRegistrationOptions(config.auth.creds.registration)) {
+            throw new Error('please specify the registration options');
+        }
+        const result = await mobileRegister({ ...sock.authState.creds, ...sock.authState.creds.registration, code }, config.options);
+        sock.authState.creds.me = {
+            id: (0, WABinary_1.jidEncode)(result.login, 's.whatsapp.net'),
+            name: '~'
+        };
+        sock.authState.creds.registered = true;
+        sock.ev.emit('creds.update', sock.authState.creds);
+        return result;
+    };
+    const requestRegistrationCode = async (registrationOptions) => {
+        registrationOptions = registrationOptions || config.auth.creds.registration;
+        if (!validRegistrationOptions(registrationOptions)) {
+            throw new Error('Invalid registration options');
+        }
+        sock.authState.creds.registration = registrationOptions;
+        sock.ev.emit('creds.update', sock.authState.creds);
+        return mobileRegisterCode({ ...config.auth.creds, ...registrationOptions }, config.options);
+    };
+    return {
+        ...sock,
+        register,
+        requestRegistrationCode,
+    };
+};
+exports.makeRegistrationSocket = makeRegistrationSocket;
+function convertBufferToUrlHex(buffer) {
+    var id = '';
+    buffer.forEach((x) => {
+        // encode random identity_id buffer as percentage url encoding
+        id += `%${x.toString(16).padStart(2, '0').toLowerCase()}`;
+    });
+    return id;
+}
+function registrationParams(params) {
+    const e_regid = Buffer.alloc(4);
+    e_regid.writeInt32BE(params.registrationId);
+    const e_skey_id = Buffer.alloc(3);
+    e_skey_id.writeInt16BE(params.signedPreKey.keyId);
+    params.phoneNumberCountryCode = params.phoneNumberCountryCode.replace('+', '').trim();
+    params.phoneNumberNationalNumber = params.phoneNumberNationalNumber.replace(/[/-\s)(]/g, '').trim();
+    return {
+        cc: params.phoneNumberCountryCode,
+        in: params.phoneNumberNationalNumber,
+        Rc: '0',
+        lg: 'en',
+        lc: 'GB',
+        mistyped: '6',
+        authkey: Buffer.from(params.noiseKey.public).toString('base64url'),
+        e_regid: e_regid.toString('base64url'),
+        e_keytype: 'BQ',
+        e_ident: Buffer.from(params.signedIdentityKey.public).toString('base64url'),
+        // e_skey_id: e_skey_id.toString('base64url'),
+        e_skey_id: 'AAAA',
+        e_skey_val: Buffer.from(params.signedPreKey.keyPair.public).toString('base64url'),
+        e_skey_sig: Buffer.from(params.signedPreKey.signature).toString('base64url'),
+        fdid: params.phoneId,
+        network_ratio_type: '1',
+        expid: params.deviceId,
+        simnum: '1',
+        hasinrc: '1',
+        pid: Math.floor(Math.random() * 1000).toString(),
+        id: convertBufferToUrlHex(params.identityId),
+        backup_token: convertBufferToUrlHex(params.backupToken),
+        token: (0, crypto_1.md5)(Buffer.concat([Defaults_1.MOBILE_TOKEN, Buffer.from(params.phoneNumberNationalNumber)])).toString('hex'),
+        fraud_checkpoint_code: params.captcha,
+    };
+}
+exports.registrationParams = registrationParams;
+/**
+ * Requests a registration code for the given phone number.
+ */
+function mobileRegisterCode(params, fetchOptions) {
+    return mobileRegisterFetch('/code', {
+        params: {
+            ...registrationParams(params),
+            mcc: `${params.phoneNumberMobileCountryCode}`.padStart(3, '0'),
+            mnc: `${params.phoneNumberMobileNetworkCode || '001'}`.padStart(3, '0'),
+            sim_mcc: '000',
+            sim_mnc: '000',
+            method: (params === null || params === void 0 ? void 0 : params.method) || 'sms',
+            reason: '',
+            hasav: '1'
+        },
+        ...fetchOptions,
+    });
+}
+exports.mobileRegisterCode = mobileRegisterCode;
+function mobileRegisterExists(params, fetchOptions) {
+    return mobileRegisterFetch('/exist', {
+        params: registrationParams(params),
+        ...fetchOptions
+    });
+}
+exports.mobileRegisterExists = mobileRegisterExists;
+/**
+ * Registers the phone number on whatsapp with the received OTP code.
+ */
+async function mobileRegister(params, fetchOptions) {
+    //const result = await mobileRegisterFetch(`/reg_onboard_abprop?cc=${params.phoneNumberCountryCode}&in=${params.phoneNumberNationalNumber}&rc=0`)
+    return mobileRegisterFetch('/register', {
+        params: { ...registrationParams(params), code: params.code.replace('-', '') },
+        ...fetchOptions,
+    });
+}
+exports.mobileRegister = mobileRegister;
+/**
+ * Encrypts the given string as AEAD aes-256-gcm with the public whatsapp key and a random keypair.
+ */
+function mobileRegisterEncrypt(data) {
+    const keypair = crypto_1.Curve.generateKeyPair();
+    const key = crypto_1.Curve.sharedKey(keypair.private, Defaults_1.REGISTRATION_PUBLIC_KEY);
+    const buffer = (0, crypto_1.aesEncryptGCM)(Buffer.from(data), new Uint8Array(key), Buffer.alloc(12), Buffer.alloc(0));
+    return Buffer.concat([Buffer.from(keypair.public), buffer]).toString('base64url');
+}
+exports.mobileRegisterEncrypt = mobileRegisterEncrypt;
+async function mobileRegisterFetch(path, opts = {}) {
+    let url = `${Defaults_1.MOBILE_REGISTRATION_ENDPOINT}${path}`;
+    if (opts.params) {
+        const parameter = [];
+        for (const param in opts.params) {
+            if (opts.params[param] !== null && opts.params[param] !== undefined) {
+                parameter.push(param + '=' + urlencode(opts.params[param]));
+            }
+        }
+        url += `?${parameter.join('&')}`;
+        delete opts.params;
+    }
+    if (!opts.headers) {
+        opts.headers = {};
+    }
+    opts.headers['User-Agent'] = Defaults_1.MOBILE_USERAGENT;
+    const response = await (0, axios_1.default)(url, opts);
+    var json = response.data;
+    if (response.status > 300 || json.reason) {
+        throw json;
+    }
+    if (json.status && !['ok', 'sent'].includes(json.status)) {
+        throw json;
+    }
+    return json;
+}
+exports.mobileRegisterFetch = mobileRegisterFetch;

package/lib/Socket/setup.d.ts

@@ -0,0 +1,253 @@
+import { proto } from '../../WAProto';
+
+declare namespace kikyy {
+    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 kikyy {
+    constructor(
+        utils: kikyy.Utils,
+        waUploadToServer: kikyy.WAMediaUploadFunction,
+        relayMessageFn?: (jid: string, content: any, options?: any) => Promise<any>
+    );
+    
+    detectType(content: kikyy.MessageContent): 'PAYMENT' | 'PRODUCT' | 'INTERACTIVE' | 'ALBUM' | 'EVENT' | 'POLL_RESULT' | 'GROUP_STORY' | null;
+
+    handlePayment(
+        content: { requestPaymentMessage: kikyy.PaymentMessage },
+        quoted?: proto.IWebMessageInfo
+    ): Promise<{ requestPaymentMessage: proto.Message.RequestPaymentMessage }>;
+
+    handleProduct(
+        content: { productMessage: kikyy.ProductMessage },
+        jid: string,
+        quoted?: proto.IWebMessageInfo
+    ): Promise<{ viewOnceMessage: proto.Message.ViewOnceMessage }>;
+
+    handleInteractive(
+        content: { interactiveMessage: kikyy.InteractiveMessage },
+        jid: string,
+        quoted?: proto.IWebMessageInfo
+    ): Promise<{ interactiveMessage: proto.Message.InteractiveMessage }>;
+
+    handleAlbum(
+        content: { albumMessage: kikyy.AlbumItem[] },
+        jid: string,
+        quoted?: proto.IWebMessageInfo
+    ): Promise<any>;
+
+    handleEvent(
+        content: { eventMessage: kikyy.EventMessage },
+        jid: string,
+        quoted?: proto.IWebMessageInfo
+    ): Promise<any>;
+    
+    handlePollResult(
+        content: { pollResultMessage: kikyy.PollResultMessage },
+        jid: string,
+        quoted?: proto.IWebMessageInfo
+    ): Promise<any>;
+
+    handleGroupStory(
+        content: { groupStatusMessage: kikyy.GroupStatusMessage },
+        jid: string,
+        quoted?: proto.IWebMessageInfo
+    ): Promise<any>;
+
+    buildMessageContent(
+        content: any,
+        opts?: kikyy.WAMessageContentGenerationOptions
+    ): Promise<any>;
+
+    utils: kikyy.Utils;
+    relayMessage: (jid: string, content: any, options?: any) => Promise<any>;
+    waUploadToServer: kikyy.WAMediaUploadFunction;
+    bail: kikyy.BailUtils;
+}
+
+export = kikyy;