xhyphersockets 1.4.3

package/lib/Socket/Client/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
+__exportStar(require("./websocket"), exports);

package/lib/Socket/Client/types.d.ts

@@ -0,0 +1,16 @@
+import { EventEmitter } from 'events';
+import { URL } from 'url';
+import { SocketConfig } from '../../Types';
+export declare abstract class AbstractSocketClient extends EventEmitter {
+    url: URL;
+    config: SocketConfig;
+    abstract get isOpen(): boolean;
+    abstract get isClosed(): boolean;
+    abstract get isClosing(): boolean;
+    abstract get isConnecting(): boolean;
+    constructor(url: URL, config: SocketConfig);
+    abstract connect(): Promise<void>;
+    abstract close(): Promise<void>;
+    abstract restart(): Promise<void>;
+    abstract send(str: Uint8Array | string, cb?: (err?: Error) => void): boolean;
+}

package/lib/Socket/Client/types.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractSocketClient = void 0;
+const events_1 = require("events");
+class AbstractSocketClient extends events_1.EventEmitter {
+    constructor(url, config) {
+        super();
+        this.url = url;
+        this.config = config;
+        this.setMaxListeners(0);
+    }
+}
+exports.AbstractSocketClient = AbstractSocketClient;

package/lib/Socket/Client/websocket.d.ts

@@ -0,0 +1,13 @@
+import WebSocket from 'ws';
+import { AbstractSocketClient } from './types';
+export declare class WebSocketClient extends AbstractSocketClient {
+    protected socket: WebSocket | null;
+    get isOpen(): boolean;
+    get isClosed(): boolean;
+    get isClosing(): boolean;
+    get isConnecting(): boolean;
+    connect(): Promise<void>;
+    close(): Promise<void>;
+    restart(): Promise<void>;
+    send(str: string | Uint8Array, cb?: (err?: Error) => void): boolean;
+}

package/lib/Socket/Client/websocket.js

@@ -0,0 +1,111 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebSocketClient = void 0;
+const ws_1 = __importDefault(require("ws"));
+const Defaults_1 = require("../../Defaults");
+const types_1 = require("./types");
+class WebSocketClient extends types_1.AbstractSocketClient {
+    constructor() {
+        super(...arguments);
+        this.socket = null;
+        // queue & dispatch variables for throttling outgoing messages to avoid rate limits
+        this._queue = [];
+        this._isDispatching = false;
+        this._lastDispatch = 0;
+        this._minSendIntervalMs = (Defaults_1.DEFAULT_CONNECTION_CONFIG && Defaults_1.DEFAULT_CONNECTION_CONFIG.minSendIntervalMs) || 50;
+    }
+    get isOpen() {
+        var _a;
+        return ((_a = this.socket) === null || _a === void 0 ? void 0 : _a.readyState) === ws_1.default.OPEN;
+    }
+    get isClosed() {
+        var _a;
+        return this.socket === null || ((_a = this.socket) === null || _a === void 0 ? void 0 : _a.readyState) === ws_1.default.CLOSED;
+    }
+    get isClosing() {
+        var _a;
+        return this.socket === null || ((_a = this.socket) === null || _a === void 0 ? void 0 : _a.readyState) === ws_1.default.CLOSING;
+    }
+    get isConnecting() {
+        var _a;
+        return ((_a = this.socket) === null || _a === void 0 ? void 0 : _a.readyState) === ws_1.default.CONNECTING;
+    }
+    async connect() {
+        var _a, _b;
+        if (this.socket) {
+            return;
+        }
+        this.socket = new ws_1.default(this.url, {
+            origin: Defaults_1.DEFAULT_ORIGIN,
+            headers: (_a = this.config.options) === null || _a === void 0 ? void 0 : _a.headers,
+            handshakeTimeout: this.config.connectTimeoutMs,
+            timeout: this.config.connectTimeoutMs,
+            agent: this.config.agent,
+        });
+        this.socket.setMaxListeners(0);
+        const events = ['close', 'error', 'upgrade', 'message', 'open', 'ping', 'pong', 'unexpected-response'];
+        for (const event of events) {
+            (_b = this.socket) === null || _b === void 0 ? void 0 : _b.on(event, (...args) => this.emit(event, ...args));
+        }
+    }
+    async close() {
+        if (!this.socket) {
+            return;
+        }
+        this.socket.close();
+        this.socket = null;
+    }
+    async restart() {
+        if (this.socket) {
+            await new Promise(resolve => {
+                this.socket.once('close', resolve);
+                this.socket.terminate();
+            });
+            this.socket = null;
+        }
+        await this.connect();
+    }
+    send(str, cb) {
+        // throttle sends to reduce rate-limit likelihood
+        const doSend = () => {
+            var _a;
+            (_a = this.socket) === null || _a === void 0 ? void 0 : _a.send(str, cb);
+            return Boolean(this.socket);
+        };
+        this._queue.push(doSend);
+        this._dispatch();
+        return true;
+    }
+
+    _dispatch() {
+        if (this._isDispatching) {
+            return;
+        }
+        this._isDispatching = true;
+        const tick = () => {
+            const now = Date.now();
+            if (this._queue.length === 0) {
+                this._isDispatching = false;
+                return;
+            }
+            const delta = now - this._lastDispatch;
+            const wait = Math.max(0, this._minSendIntervalMs - delta);
+            setTimeout(() => {
+                const fn = this._queue.shift();
+                this._lastDispatch = Date.now();
+                try {
+                    fn && fn();
+                }
+                catch (_err) {
+                    // ignore send errors here; they'll surface elsewhere
+                }
+                tick();
+            }, wait);
+        };
+        tick();
+    }
+}
+exports.WebSocketClient = WebSocketClient;

package/lib/Socket/RHandler.d.ts

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