@hieuxyz/rpc 1.2.4 → 1.2.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hieuxyz/rpc",
-  "version": "1.2.4",
+  "version": "1.2.5",
   "description": "A Discord Rich Presence library for Node.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -39,20 +39,21 @@
   },
   "homepage": "https://github.com/hieuxyz00/hieuxyz_rpc#readme",
   "dependencies": {
-    "axios": "^1.13.2",
-    "ws": "^8.18.3"
+    "axios": "^1.13.6",
+    "ws": "^8.19.0"
   },
   "devDependencies": {
-    "@types/node": "^25.0.3",
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^25.3.3",
     "@types/ws": "^8.18.1",
-    "esbuild": "^0.27.2",
-    "eslint": "^9.39.2",
+    "esbuild": "^0.27.3",
+    "eslint": "^10.0.2",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-prettier": "^5.5.4",
-    "prettier": "^3.7.4",
+    "eslint-plugin-prettier": "^5.5.5",
+    "prettier": "^3.8.1",
     "ts-node": "^10.9.2",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.51.0"
+    "typescript-eslint": "^8.56.1"
   }
 }

package/dist/hieuxyz/Client.d.ts

@@ -1,100 +0,0 @@
-import { HieuxyzRPC } from './rpc/HieuxyzRPC';
-import { ClientProperties } from './gateway/entities/identify';
-import { DiscordUser } from './gateway/entities/types';
-/**
- * Option to initialize Client.
- */
-export interface ClientOptions {
-    /** Your Discord user token. */
-    token: string;
-    /** (Optional) Base URL of the image proxy service. */
-    apiBaseUrl?: string;
-    /**
-     * (Optional) If true, the client will attempt to reconnect even after a normal close (code 1000).
-     * Defaults to false.
-     */
-    alwaysReconnect?: boolean;
-    /**
-     * (Optional) Client properties to send to Discord gateway.
-     * Used for client spoofing (e.g., appearing as on mobile).
-     */
-    properties?: ClientProperties;
-    /**
-     * (Optional) The timeout in milliseconds for the initial gateway connection.
-     * Defaults to 30000 (30 seconds).
-     */
-    connectionTimeout?: number;
-}
-/**
- * The main Client class for interacting with Discord Rich Presence.
- * This is the starting point for creating and managing your RPC state.
- * @example
- * const client = new Client({
- *   token: "YOUR_DISCORD_TOKEN",
- *   alwaysReconnect: true // Keep the RPC alive no matter what
- * });
- * await client.run();
- * client.rpc.setName("Visual Studio Code");
- * await client.rpc.build();
- */
-export declare class Client {
-    /**
-     * The default RPC instance.
-     * Use this to set your main Rich Presence state details.
-     */
-    readonly rpc: HieuxyzRPC;
-    /**
-     * List of all RPC instances managed by this client.
-     */
-    private rpcs;
-    /**
-     * Information about the logged-in user.
-     * Populated after run() resolves.
-     */
-    user: DiscordUser | null;
-    private readonly websocket;
-    private readonly imageService;
-    private readonly token;
-    /**
-     * Create a new Client instance.
-     * @param {ClientOptions} options - Options to configure the client.
-     * @throws {Error} If no token is provided in the options.
-     */
-    constructor(options: ClientOptions);
-    /**
-     * Create a new RPC instance.
-     * Use this if you want to display multiple activities simultaneously (Multi-RPC).
-     * @returns {HieuxyzRPC} A new RPC builder instance.
-     */
-    createRPC(): HieuxyzRPC;
-    /**
-     * Removes an RPC instance and cleans up its resources.
-     * @param {HieuxyzRPC} rpcInstance The RPC instance to remove.
-     */
-    removeRPC(rpcInstance: HieuxyzRPC): void;
-    /**
-     * Aggregates activities from all RPC instances and sends them to Discord.
-     * Uses Promise.all for parallel asset resolution.
-     */
-    private sendAllActivities;
-    /**
-     * Displays information about the library.
-     */
-    private printAbout;
-    /**
-     * Connect to Discord Gateway and prepare the client for RPC updates.
-     * This method must be called before sending any Rich Presence updates.
-     * @returns {Promise<DiscordUser>} A promise will be resolved when the client is ready.
-     */
-    run(): Promise<DiscordUser>;
-    private formatters;
-    private formatFlags;
-    private printDynamicTree;
-    private logUserProfile;
-    /**
-     * Close the connection to Discord Gateway.
-     * @param {boolean} [force=false] - If true, the client closes permanently and will not reconnect.
-     * even if `alwaysReconnect` is enabled. Defaults to false.
-     */
-    close(force?: boolean): void;
-}

package/dist/hieuxyz/Client.js

@@ -1,256 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Client = void 0;
-const DiscordWebSocket_1 = require("./gateway/DiscordWebSocket");
-const HieuxyzRPC_1 = require("./rpc/HieuxyzRPC");
-const ImageService_1 = require("./rpc/ImageService");
-const logger_1 = require("./utils/logger");
-const types_1 = require("./gateway/entities/types");
-/**
- * The main Client class for interacting with Discord Rich Presence.
- * This is the starting point for creating and managing your RPC state.
- * @example
- * const client = new Client({
- *   token: "YOUR_DISCORD_TOKEN",
- *   alwaysReconnect: true // Keep the RPC alive no matter what
- * });
- * await client.run();
- * client.rpc.setName("Visual Studio Code");
- * await client.rpc.build();
- */
-class Client {
-    /**
-     * The default RPC instance.
-     * Use this to set your main Rich Presence state details.
-     */
-    rpc;
-    /**
-     * List of all RPC instances managed by this client.
-     */
-    rpcs = [];
-    /**
-     * Information about the logged-in user.
-     * Populated after run() resolves.
-     */
-    user = null;
-    websocket;
-    imageService;
-    token;
-    /**
-     * Create a new Client instance.
-     * @param {ClientOptions} options - Options to configure the client.
-     * @throws {Error} If no token is provided in the options.
-     */
-    constructor(options) {
-        if (!options.token) {
-            throw new Error('Tokens are required to connect to Discord.');
-        }
-        this.token = options.token;
-        this.imageService = new ImageService_1.ImageService(options.apiBaseUrl);
-        this.websocket = new DiscordWebSocket_1.DiscordWebSocket(this.token, {
-            alwaysReconnect: options.alwaysReconnect ?? false,
-            properties: options.properties,
-            connectionTimeout: options.connectionTimeout,
-        });
-        this.rpc = this.createRPC();
-        this.printAbout();
-    }
-    /**
-     * Create a new RPC instance.
-     * Use this if you want to display multiple activities simultaneously (Multi-RPC).
-     * @returns {HieuxyzRPC} A new RPC builder instance.
-     */
-    createRPC() {
-        const newRpc = new HieuxyzRPC_1.HieuxyzRPC(this.imageService, async () => {
-            await this.sendAllActivities();
-        });
-        this.rpcs.push(newRpc);
-        return newRpc;
-    }
-    /**
-     * Removes an RPC instance and cleans up its resources.
-     * @param {HieuxyzRPC} rpcInstance The RPC instance to remove.
-     */
-    removeRPC(rpcInstance) {
-        const index = this.rpcs.indexOf(rpcInstance);
-        if (index > -1) {
-            rpcInstance.destroy();
-            this.rpcs.splice(index, 1);
-            this.sendAllActivities();
-        }
-    }
-    /**
-     * Aggregates activities from all RPC instances and sends them to Discord.
-     * Uses Promise.all for parallel asset resolution.
-     */
-    async sendAllActivities() {
-        const potentialActivities = await Promise.all(this.rpcs.map((rpc) => rpc.buildActivity()));
-        const activities = potentialActivities.filter((a) => a !== null);
-        let status = 'online';
-        for (let i = this.rpcs.length - 1; i >= 0; i--) {
-            if (this.rpcs[i].currentStatus) {
-                status = this.rpcs[i].currentStatus;
-                break;
-            }
-        }
-        this.websocket.sendActivity({
-            since: 0,
-            activities: activities,
-            status: status,
-            afk: true,
-        });
-    }
-    /**
-     * Displays information about the library.
-     */
-    printAbout() {
-        const version = '1.2.3';
-        console.log(`
-  _     _                               
- | |__ (_) ___ _   ___  ___   _ ______  
- | '_ \\| |/ _ \\ | | \\ \\/ / | | |_  /  
- | | | | |  __/ |_| |>  <| |_| |/ /   
- |_| |_|_|\\___|\\__,_/_/\\_\\\\__, /___|  
-                          |___/       
-  @hieuxyz/rpc v${version}
-  A powerful Discord Rich Presence library.
-  Developed by: hieuxyz
-        `);
-    }
-    /**
-     * Connect to Discord Gateway and prepare the client for RPC updates.
-     * This method must be called before sending any Rich Presence updates.
-     * @returns {Promise<DiscordUser>} A promise will be resolved when the client is ready.
-     */
-    async run() {
-        this.websocket.connect();
-        logger_1.logger.info('Waiting for Discord session to be ready...');
-        const user = await this.websocket.readyPromise;
-        this.user = user;
-        this.logUserProfile(user);
-        logger_1.logger.info('Client is ready to send Rich Presence updates.');
-        return user;
-    }
-    formatters = {
-        email: (val) => (val ? `\x1b[90m<Hidden>\x1b[0m` : 'null'),
-        phone: (val) => (val ? `\x1b[90m<Hidden>\x1b[0m` : 'null'),
-        avatar: (val, parent) => {
-            if (!val)
-                return 'null';
-            const ext = val.startsWith('a_') ? 'gif' : 'png';
-            const userId = parent?.id;
-            const url = userId ? `https://cdn.discordapp.com/avatars/${userId}/${val}.${ext}` : '';
-            return `"${val}" ${url ? `(\x1b[34m${url}\x1b[0m)` : ''}`;
-        },
-        banner: (val, parent) => {
-            if (!val)
-                return 'null';
-            const ext = val.startsWith('a_') ? 'gif' : 'png';
-            const userId = parent?.id;
-            const url = userId ? `https://cdn.discordapp.com/banners/${userId}/${val}.${ext}` : '';
-            return `"${val}" ${url ? `(\x1b[34m${url}\x1b[0m)` : ''}`;
-        },
-        asset: (val) => {
-            const url = `https://cdn.discordapp.com/avatar-decoration-presets/${val}.png`;
-            return `"${val}" (\x1b[34m${url}\x1b[0m)`;
-        },
-        accent_color: (val) => `${val} (\x1b[33m#${val.toString(16).padStart(6, '0').toUpperCase()}\x1b[0m)`,
-        banner_color: (val) => `\x1b[33m${val}\x1b[0m`,
-        expires_at: (val) => (val ? `${val} (${new Date(val).toLocaleString()})` : 'Never'),
-        premium_type: (val) => {
-            const map = { 0: 'None', 1: 'Classic', 2: 'Nitro', 3: 'Basic' };
-            return `${val} (\x1b[32m${map[val] || 'Unknown'}\x1b[0m)`;
-        },
-        flags: (val) => this.formatFlags(val),
-        public_flags: (val) => this.formatFlags(val),
-        purchased_flags: (val) => `\x1b[33m${val}\x1b[0m`,
-    };
-    formatFlags(flags) {
-        const flagNames = [];
-        if (flags & types_1.UserFlags.STAFF)
-            flagNames.push('Staff');
-        if (flags & types_1.UserFlags.PARTNER)
-            flagNames.push('Partner');
-        if (flags & types_1.UserFlags.HYPESQUAD)
-            flagNames.push('HypeSquad');
-        if (flags & types_1.UserFlags.BUG_HUNTER_LEVEL_1)
-            flagNames.push('BugHunter I');
-        if (flags & types_1.UserFlags.HYPESQUAD_ONLINE_HOUSE_1)
-            flagNames.push('Bravery');
-        if (flags & types_1.UserFlags.HYPESQUAD_ONLINE_HOUSE_2)
-            flagNames.push('Brilliance');
-        if (flags & types_1.UserFlags.HYPESQUAD_ONLINE_HOUSE_3)
-            flagNames.push('Balance');
-        if (flags & types_1.UserFlags.PREMIUM_EARLY_SUPPORTER)
-            flagNames.push('EarlySupporter');
-        if (flags & types_1.UserFlags.BUG_HUNTER_LEVEL_2)
-            flagNames.push('BugHunter II');
-        if (flags & types_1.UserFlags.VERIFIED_DEVELOPER)
-            flagNames.push('VerifiedDev');
-        if (flags & types_1.UserFlags.CERTIFIED_MODERATOR)
-            flagNames.push('CertifiedMod');
-        if (flags & types_1.UserFlags.ACTIVE_DEVELOPER)
-            flagNames.push('ActiveDev');
-        return `${flags} \x1b[36m[${flagNames.length > 0 ? flagNames.join(', ') : 'None'}]\x1b[0m`;
-    }
-    printDynamicTree(obj, prefix = '') {
-        const entries = Object.entries(obj);
-        entries.forEach(([key, value], index) => {
-            const isLastItem = index === entries.length - 1;
-            const connector = isLastItem ? '└── ' : '├── ';
-            const childPrefix = prefix + (isLastItem ? '    ' : '│   ');
-            let displayValue = '';
-            let isObject = false;
-            if (value === null) {
-                displayValue = '\x1b[90mnull\x1b[0m';
-            }
-            else if (typeof value === 'object' && !Array.isArray(value)) {
-                isObject = true;
-                console.log(`${prefix}${connector}\x1b[1m${key}\x1b[0m`);
-                this.printDynamicTree(value, childPrefix);
-            }
-            else if (Array.isArray(value)) {
-                if (value.length > 0 && typeof value[0] !== 'object') {
-                    displayValue = `[ ${value.join(', ')} ]`;
-                }
-                else {
-                    displayValue = `[Array(${value.length})]`;
-                }
-            }
-            else {
-                if (this.formatters[key]) {
-                    displayValue = this.formatters[key](value, obj);
-                }
-                else {
-                    if (typeof value === 'string')
-                        displayValue = `"\x1b[32m${value}\x1b[0m"`;
-                    else if (typeof value === 'boolean')
-                        displayValue = value ? '\x1b[32mtrue\x1b[0m' : '\x1b[31mfalse\x1b[0m';
-                    else if (typeof value === 'number')
-                        displayValue = `\x1b[33m${value}\x1b[0m`;
-                    else
-                        displayValue = String(value);
-                }
-            }
-            if (!isObject) {
-                console.log(`${prefix}${connector}${key}: ${displayValue}`);
-            }
-        });
-    }
-    logUserProfile(user) {
-        logger_1.logger.info('-> User Data:');
-        this.printDynamicTree(user);
-        /*logger.info('-> Raw JSON:');
-        console.log(JSON.stringify(user));*/
-    }
-    /**
-     * Close the connection to Discord Gateway.
-     * @param {boolean} [force=false] - If true, the client closes permanently and will not reconnect.
-     * even if `alwaysReconnect` is enabled. Defaults to false.
-     */
-    close(force = false) {
-        this.rpcs.forEach((rpc) => rpc.destroy());
-        this.websocket.close(force);
-    }
-}
-exports.Client = Client;

package/dist/hieuxyz/gateway/DiscordWebSocket.d.ts

@@ -1,69 +0,0 @@
-import { ClientProperties } from './entities/identify';
-import { PresenceUpdatePayload, DiscordUser } from './entities/types';
-interface DiscordWebSocketOptions {
-    alwaysReconnect: boolean;
-    properties?: ClientProperties;
-    connectionTimeout?: number;
-}
-/**
- * Manage WebSocket connections to Discord Gateway.
- * Handles low-level operations like heartbeating, identifying, and resuming.
- */
-export declare class DiscordWebSocket {
-    private token;
-    private ws;
-    private sequence;
-    private heartbeatInterval;
-    private heartbeatIntervalValue;
-    private sessionId;
-    private resumeGatewayUrl;
-    private options;
-    private isReconnecting;
-    private permanentClose;
-    private connectTimeout;
-    private resolveReady;
-    private lastHeartbeatAck;
-    /**
-     * Current logged in user info.
-     */
-    user: DiscordUser | null;
-    /**
-     * A promise will be resolved when the Gateway connection is ready.
-     * and received the READY event.
-     */
-    readyPromise: Promise<DiscordUser>;
-    /**
-     * Create a DiscordWebSocket instance.
-     * @param {string} token - Discord user token for authentication.
-     * @param {DiscordWebSocketOptions} options - Configuration options for the WebSocket client.
-     * @throws {Error} If the token is invalid.
-     */
-    constructor(token: string, options: DiscordWebSocketOptions);
-    private resetReadyPromise;
-    private isTokenValid;
-    /**
-     * Initiate connection to Discord Gateway.
-     * If there was a previous session, it will try to resume.
-     */
-    connect(): void;
-    private handleClose;
-    private onMessage;
-    private startHeartbeating;
-    private sendHeartbeat;
-    private identify;
-    private resume;
-    /**
-     * Send presence update payload to Gateway.
-     * @param {PresenceUpdatePayload} presence - Payload update status to send.
-     */
-    sendActivity(presence: PresenceUpdatePayload): void;
-    private sendJson;
-    /**
-     * Closes the WebSocket connection.
-     * @param {boolean} force If true, prevents any automatic reconnection attempts.
-     */
-    close(force?: boolean): void;
-    private cleanupHeartbeat;
-    private shouldReconnect;
-}
-export {};