@hieuxyz/rpc 1.0.9 → 1.0.91

package/README.md

@@ -43,7 +43,7 @@ DISCORD_USER_TOKEN="YOUR_DISCORD_USER_TOKEN_HERE"
 
 ```typescript
 import * as path from 'path';
-import { Client, LocalImage, logger } from '../src';
+import { Client, LocalImage, logger } from '@hieuxyz/rpc';
 
 async function start() {
     const token = process.env.DISCORD_USER_TOKEN;
@@ -150,18 +150,34 @@ This is the main starting point.
 
 Main builder class for RPC.
 
--   `.setName(string)`: Activity name (first line).
--   `.setDetails(string)`: Activity details (second line).
--   `.setState(string)`: Activity status (third line).
--   `.setTimestamps(start?, end?)`: Set start/end time.
--   `.setParty(current, max)`: Set group information.
--   `.setLargeImage(RpcImage, text?)`: Set large image and caption.
--   `.setSmallImage(RpcImage, text?)`: Set thumbnail and caption.
--   `.setButtons(buttons[])`: Set buttons (up to 2).
--   `.setPlatform(platform)`: Lay the platform (`'desktop'`, `'xbox'`, `'ps5'`).
--   `.build()`: First RPC send.
--   `.updateRPC()`: Send updates to an existing RPC.(it just call build() lol).
--   `.clear()`: Clears the current Rich Presence from the user's profile and resets the builder to its default state.
+#### Setter Methods
+-   `.setName(string)`: Sets the activity name (first line).
+-   `.setDetails(string)`: Sets the activity details (second line).
+-   `.setState(string)`: Sets the activity state (third line).
+-   `.setTimestamps(start?, end?)`: Sets the start and/or end times.
+-   `.setParty(current, max)`: Sets the party information.
+-   `.setLargeImage(RpcImage, text?)`: Sets the large image and its tooltip text.
+-   `.setSmallImage(RpcImage, text?)`: Sets the small image and its tooltip text.
+-   `.setButtons(buttons[])`: Sets up to two clickable buttons.
+-   `.setPlatform(platform)`: Sets the platform (`'desktop'`, `'xbox'`, etc.).
+-   `.setInstance(boolean)`: Marks the activity as a specific, joinable instance.
+-   `.setApplicationId(string)`: Sets a custom Application ID.
+-   `.setStatus('online' | ...)`: Sets the user's presence status.
+
+#### Clearer Methods
+-   `.clearDetails()`: Removes the activity details.
+-   `.clearState()`: Removes the activity state.
+-   `.clearTimestamps()`: Removes the timestamps.
+-   `.clearParty()`: Removes the party information.
+-   `.clearLargeImage()`: Removes the large image and its text.
+-   `.clearSmallImage()`: Removes the small image and its text.
+-   `.clearButtons()`: Removes all buttons.
+-   `.clearInstance()`: Removes the instance flag.
+
+#### Core Methods
+-   `.build()`: Builds and sends the presence payload to Discord.
+-   `.updateRPC()`: Builds and sends an updated presence payload. (Alias for `build()`).
+-   `.clear()`: Clears the entire Rich Presence from the user's profile and resets the builder to its default state.
 
 ### Types of images
 

package/dist/hieuxyz/Client.js

@@ -33,7 +33,7 @@ class Client {
      */
     constructor(options) {
         if (!options.token) {
-            throw new Error("Tokens are required to connect to Discord.");
+            throw new Error('Tokens are required to connect to Discord.');
         }
         this.token = options.token;
         this.imageService = new ImageService_1.ImageService(options.apiBaseUrl);
@@ -49,9 +49,9 @@ class Client {
      */
     async run() {
         this.websocket.connect();
-        logger_1.logger.info("Waiting for Discord session to be ready...");
+        logger_1.logger.info('Waiting for Discord session to be ready...');
         await this.websocket.readyPromise;
-        logger_1.logger.info("Client is ready to send Rich Presence updates.");
+        logger_1.logger.info('Client is ready to send Rich Presence updates.');
     }
     /**
      * Close the connection to Discord Gateway.

package/dist/hieuxyz/gateway/DiscordWebSocket.js

@@ -37,17 +37,18 @@ class DiscordWebSocket {
      */
     constructor(token, options) {
         if (!this.isTokenValid(token)) {
-            throw new Error("Invalid token provided.");
+            throw new Error('Invalid token provided.');
         }
         this.token = token;
         this.options = options;
-        this.readyPromise = new Promise(resolve => (this.resolveReady = resolve));
+        this.readyPromise = new Promise((resolve) => (this.resolveReady = resolve));
     }
     resetReadyPromise() {
-        this.readyPromise = new Promise(resolve => (this.resolveReady = resolve));
+        this.readyPromise = new Promise((resolve) => (this.resolveReady = resolve));
     }
     isTokenValid(token) {
-        return /^[a-zA-Z0-9_-]{24}\.[a-zA-Z0-9_-]{6}\.[a-zA-Z0-9_-]{38}$/.test(token) || /^mfa\.[a-zA-Z0-9_-]{84}$/.test(token);
+        return (/^[a-zA-Z0-9_-]{24}\.[a-zA-Z0-9_-]{6}\.[a-zA-Z0-9_-]{38}$/.test(token) ||
+            /^mfa\.[a-zA-Z0-9_-]{84}$/.test(token));
     }
     /**
      * Initiate connection to Discord Gateway.
@@ -55,13 +56,13 @@ class DiscordWebSocket {
      */
     connect() {
         if (this.isReconnecting) {
-            logger_1.logger.info("Connection attempt aborted: reconnection already in progress.");
+            logger_1.logger.info('Connection attempt aborted: reconnection already in progress.');
             return;
         }
         this.permanentClose = false;
         this.isReconnecting = true;
         this.resetReadyPromise();
-        const url = this.resumeGatewayUrl || "wss://gateway.discord.gg/?v=10&encoding=json";
+        const url = this.resumeGatewayUrl || 'wss://gateway.discord.gg/?v=10&encoding=json';
         logger_1.logger.info(`Attempting to connect to ${url}...`);
         this.ws = new ws_1.default(url);
         this.ws.on('open', () => {
@@ -73,7 +74,7 @@ class DiscordWebSocket {
             logger_1.logger.warn(`Connection closed: ${code} - ${reason.toString('utf-8')}`);
             this.cleanupHeartbeat();
             if (this.permanentClose) {
-                logger_1.logger.info("Connection permanently closed by client. Not reconnecting.");
+                logger_1.logger.info('Connection permanently closed by client. Not reconnecting.');
                 return;
             }
             if (this.isReconnecting)
@@ -90,7 +91,7 @@ class DiscordWebSocket {
                 }, 500);
             }
             else {
-                logger_1.logger.info("Not attempting to reconnect based on close code and client options.");
+                logger_1.logger.info('Not attempting to reconnect based on close code and client options.');
             }
         });
         this.ws.on('error', (err) => {
@@ -117,30 +118,30 @@ class DiscordWebSocket {
             case OpCode_1.OpCode.DISPATCH:
                 if (payload.t === 'READY') {
                     this.sessionId = payload.d.session_id;
-                    this.resumeGatewayUrl = payload.d.resume_gateway_url + "/?v=10&encoding=json";
+                    this.resumeGatewayUrl = payload.d.resume_gateway_url + '/?v=10&encoding=json';
                     logger_1.logger.info(`Session READY. Session ID: ${this.sessionId}. Resume URL set.`);
                     this.resolveReady();
                 }
                 else if (payload.t === 'RESUMED') {
-                    logger_1.logger.info("The session has been successfully resumed.");
+                    logger_1.logger.info('The session has been successfully resumed.');
                     this.resolveReady();
                 }
                 break;
             case OpCode_1.OpCode.HEARTBEAT_ACK:
-                logger_1.logger.info("Heartbeat acknowledged.");
+                logger_1.logger.info('Heartbeat acknowledged.');
                 break;
             case OpCode_1.OpCode.INVALID_SESSION:
                 logger_1.logger.warn(`Received INVALID_SESSION. Resumable: ${payload.d}`);
                 if (payload.d) {
-                    this.ws?.close(4000, "Invalid session, attempting to resume.");
+                    this.ws?.close(4000, 'Invalid session, attempting to resume.');
                 }
                 else {
-                    this.ws?.close(4004, "Invalid session, starting a new session.");
+                    this.ws?.close(4004, 'Invalid session, starting a new session.');
                 }
                 break;
             case OpCode_1.OpCode.RECONNECT:
-                logger_1.logger.info("Gateway requested RECONNECT. Closing to reconnect and resume.");
-                this.ws?.close(4000, "Gateway requested reconnect.");
+                logger_1.logger.info('Gateway requested RECONNECT. Closing to reconnect and resume.');
+                this.ws?.close(4000, 'Gateway requested reconnect.');
                 break;
             default:
                 break;
@@ -154,7 +155,7 @@ class DiscordWebSocket {
             }
             this.heartbeatInterval = setInterval(() => {
                 if (this.ws?.readyState !== ws_1.default.OPEN) {
-                    logger_1.logger.warn("Heartbeat skipped: WebSocket is not open.");
+                    logger_1.logger.warn('Heartbeat skipped: WebSocket is not open.');
                     this.cleanupHeartbeat();
                     return;
                 }
@@ -171,21 +172,21 @@ class DiscordWebSocket {
     identify() {
         const identifyPayload = (0, identify_1.getIdentifyPayload)(this.token);
         this.sendJson({ op: OpCode_1.OpCode.IDENTIFY, d: identifyPayload });
-        logger_1.logger.info("Identify payload sent.");
+        logger_1.logger.info('Identify payload sent.');
     }
     resume() {
         if (!this.sessionId || this.sequence === null) {
-            logger_1.logger.error("Attempted to resume without session ID or sequence. Falling back to identify.");
+            logger_1.logger.error('Attempted to resume without session ID or sequence. Falling back to identify.');
             this.identify();
             return;
         }
         const resumePayload = {
             token: this.token,
             session_id: this.sessionId,
-            seq: this.sequence
+            seq: this.sequence,
         };
         this.sendJson({ op: OpCode_1.OpCode.RESUME, d: resumePayload });
-        logger_1.logger.info("Resume payload sent.");
+        logger_1.logger.info('Resume payload sent.');
     }
     /**
      * Send presence update payload to Gateway.
@@ -193,14 +194,14 @@ class DiscordWebSocket {
      */
     sendActivity(presence) {
         this.sendJson({ op: OpCode_1.OpCode.PRESENCE_UPDATE, d: presence });
-        logger_1.logger.info("Presence update sent.");
+        logger_1.logger.info('Presence update sent.');
     }
     sendJson(data) {
         if (this.ws?.readyState === ws_1.default.OPEN) {
             this.ws.send(JSON.stringify(data));
         }
         else {
-            logger_1.logger.warn("Attempted to send data while WebSocket was not open.");
+            logger_1.logger.warn('Attempted to send data while WebSocket was not open.');
         }
     }
     /**
@@ -209,15 +210,15 @@ class DiscordWebSocket {
      */
     close(force = false) {
         if (force) {
-            logger_1.logger.info("Forcing permanent closure. Reconnects will be disabled.");
+            logger_1.logger.info('Forcing permanent closure. Reconnects will be disabled.');
             this.permanentClose = true;
         }
         else {
-            logger_1.logger.info("Closing connection manually...");
+            logger_1.logger.info('Closing connection manually...');
         }
         this.isReconnecting = false;
         if (this.ws) {
-            this.ws.close(1000, "Client initiated closure");
+            this.ws.close(1000, 'Client initiated closure');
         }
     }
     cleanupHeartbeat() {

package/dist/hieuxyz/gateway/entities/identify.d.ts

@@ -1,2 +1,2 @@
-import { IdentifyPayload } from "./types";
+import { IdentifyPayload } from './types';
 export declare function getIdentifyPayload(token: string): IdentifyPayload;

package/dist/hieuxyz/gateway/entities/identify.js

@@ -6,9 +6,9 @@ function getIdentifyPayload(token) {
         token: token,
         capabilities: 65,
         properties: {
-            os: "Windows",
-            browser: "Discord Client",
-            device: "hieuxyz©rpc",
+            os: 'Windows',
+            browser: 'Discord Client',
+            device: 'hieuxyz©rpc',
         },
         compress: false,
     };

package/dist/hieuxyz/gateway/entities/types.d.ts

@@ -1,4 +1,4 @@
-import { OpCode } from "./OpCode";
+import { OpCode } from './OpCode';
 export declare enum ActivityType {
     Playing = 0,
     Streaming = 1,
@@ -32,6 +32,7 @@ export interface Activity {
     details?: string;
     state?: string;
     platform?: string;
+    instance?: boolean;
     party?: {
         id?: string;
         size?: [number, number];

package/dist/hieuxyz/rpc/HieuxyzRPC.d.ts

@@ -1,7 +1,7 @@
-import { DiscordWebSocket } from "../gateway/DiscordWebSocket";
-import { SettableActivityType } from "../gateway/entities/types";
-import { ImageService } from "./ImageService";
-import { RpcImage } from "./RpcImage";
+import { DiscordWebSocket } from '../gateway/DiscordWebSocket';
+import { SettableActivityType } from '../gateway/entities/types';
+import { ImageService } from './ImageService';
+import { RpcImage } from './RpcImage';
 interface RpcButton {
     label: string;
     url: string;
@@ -27,6 +27,7 @@ export declare class HieuxyzRPC {
     private renewalInterval;
     constructor(websocket: DiscordWebSocket, imageService: ImageService);
     private _toRpcImage;
+    private cleanupNulls;
     private sanitize;
     /**
      * Name the operation (first line of RPC).
@@ -105,6 +106,20 @@ export declare class HieuxyzRPC {
      * @returns {this}
      */
     setPlatform(platform: DiscordPlatform): this;
+    /**
+     * Marks the activity as a joinable instance for the game.
+     * @param instance - Whether this activity is a specific instance.
+     * @returns {this}
+     */
+    setInstance(instance: boolean): this;
+    clearDetails(): this;
+    clearState(): this;
+    clearTimestamps(): this;
+    clearParty(): this;
+    clearButtons(): this;
+    clearInstance(): this;
+    clearLargeImage(): this;
+    clearSmallImage(): this;
     private getExpiryTime;
     private renewAssetIfNeeded;
     private startBackgroundRenewal;

package/dist/hieuxyz/rpc/HieuxyzRPC.js

@@ -42,7 +42,7 @@ class HieuxyzRPC {
                     return new RpcImage_1.ExternalImage(source);
                 }
             }
-            catch (e) {
+            catch {
                 logger_1.logger.warn(`Could not parse "${source}" into a valid URL. Treating as RawImage.`);
                 return new RpcImage_1.RawImage(source);
             }
@@ -52,6 +52,9 @@ class HieuxyzRPC {
         }
         return new RpcImage_1.RawImage(source);
     }
+    cleanupNulls(obj) {
+        return Object.fromEntries(Object.entries(obj).filter(([, v]) => v !== null && v !== undefined));
+    }
     sanitize(str, length = 128) {
         return str.length > length ? str.substring(0, length) : str;
     }
@@ -155,8 +158,8 @@ class HieuxyzRPC {
      */
     setButtons(buttons) {
         const validButtons = buttons.slice(0, 2);
-        this.activity.buttons = validButtons.map(b => this.sanitize(b.label, 32));
-        this.activity.metadata = { button_urls: validButtons.map(b => b.url) };
+        this.activity.buttons = validButtons.map((b) => this.sanitize(b.label, 32));
+        this.activity.metadata = { button_urls: validButtons.map((b) => b.url) };
         return this;
     }
     /**
@@ -167,7 +170,7 @@ class HieuxyzRPC {
      */
     setApplicationId(id) {
         if (!/^\d{18,19}$/.test(id)) {
-            throw new Error("The app ID must be an 18 or 19 digit number.");
+            throw new Error('The app ID must be an 18 or 19 digit number.');
         }
         this.applicationId = id;
         return this;
@@ -190,6 +193,50 @@ class HieuxyzRPC {
         this.platform = platform;
         return this;
     }
+    /**
+     * Marks the activity as a joinable instance for the game.
+     * @param instance - Whether this activity is a specific instance.
+     * @returns {this}
+     */
+    setInstance(instance) {
+        this.activity.instance = instance;
+        return this;
+    }
+    clearDetails() {
+        this.activity.details = undefined;
+        return this;
+    }
+    clearState() {
+        this.activity.state = undefined;
+        return this;
+    }
+    clearTimestamps() {
+        this.activity.timestamps = undefined;
+        return this;
+    }
+    clearParty() {
+        this.activity.party = undefined;
+        return this;
+    }
+    clearButtons() {
+        this.activity.buttons = undefined;
+        this.activity.metadata = undefined;
+        return this;
+    }
+    clearInstance() {
+        this.activity.instance = undefined;
+        return this;
+    }
+    clearLargeImage() {
+        this.assets.large_image = undefined;
+        this.assets.large_text = undefined;
+        return this;
+    }
+    clearSmallImage() {
+        this.assets.small_image = undefined;
+        this.assets.small_text = undefined;
+        return this;
+    }
     getExpiryTime(assetKey) {
         if (!assetKey.startsWith('mp:attachments'))
             return null;
@@ -201,14 +248,14 @@ class HieuxyzRPC {
                 return parseInt(expiresTimestamp, 16) * 1000;
             }
         }
-        catch (e) {
+        catch {
             logger_1.logger.error(`Could not parse asset URL for expiry check: ${assetKey}`);
         }
         return null;
     }
     async renewAssetIfNeeded(cacheKey, assetKey) {
         const expiryTimeMs = this.getExpiryTime(assetKey);
-        if (expiryTimeMs && expiryTimeMs < (Date.now() + 3600000)) {
+        if (expiryTimeMs && expiryTimeMs < Date.now() + 3600000) {
             logger_1.logger.info(`Asset ${cacheKey} is expiring soon. Renewing...`);
             const assetId = assetKey.split('mp:attachments/')[1];
             const newAsset = await this.imageService.renewImage(assetId);
@@ -225,7 +272,7 @@ class HieuxyzRPC {
             clearInterval(this.renewalInterval);
         }
         this.renewalInterval = setInterval(async () => {
-            logger_1.logger.info("Running background asset renewal check...");
+            logger_1.logger.info('Running background asset renewal check...');
             for (const [cacheKey, assetKey] of this.resolvedAssetsCache.entries()) {
                 await this.renewAssetIfNeeded(cacheKey, assetKey);
             }
@@ -238,14 +285,14 @@ class HieuxyzRPC {
         if (this.renewalInterval) {
             clearInterval(this.renewalInterval);
             this.renewalInterval = null;
-            logger_1.logger.info("Stopped background asset renewal process.");
+            logger_1.logger.info('Stopped background asset renewal process.');
         }
     }
     async resolveImage(image) {
         if (!image)
             return undefined;
         const cacheKey = image.getCacheKey();
-        let cachedAsset = this.resolvedAssetsCache.get(cacheKey);
+        const cachedAsset = this.resolvedAssetsCache.get(cacheKey);
         if (cachedAsset) {
             return await this.renewAssetIfNeeded(cacheKey, cachedAsset);
         }
@@ -267,16 +314,16 @@ class HieuxyzRPC {
         if (small_image)
             finalAssets.small_image = small_image;
         const finalActivity = { ...this.activity };
-        finalActivity.assets = (large_image || small_image) ? finalAssets : undefined;
+        finalActivity.assets = large_image || small_image ? finalAssets : undefined;
         finalActivity.application_id = this.applicationId;
         finalActivity.platform = this.platform;
         if (!finalActivity.name) {
-            finalActivity.name = "hieuxyzRPC";
+            finalActivity.name = 'hieuxyzRPC';
         }
         if (typeof finalActivity.type === 'undefined') {
             finalActivity.type = types_1.ActivityType.Playing;
         }
-        return finalActivity;
+        return this.cleanupNulls(finalActivity);
     }
     /**
      * Build the final Rich Presence payload and send it to Discord.
@@ -314,12 +361,12 @@ class HieuxyzRPC {
             afk: true,
         };
         this.websocket.sendActivity(clearPayload);
-        logger_1.logger.info("Rich Presence cleared from Discord.");
+        logger_1.logger.info('Rich Presence cleared from Discord.');
         this.activity = {};
         this.assets = {};
         this.applicationId = '1416676323459469363'; // Reset to default
         this.platform = 'desktop'; // Reset to default
-        logger_1.logger.info("RPC builder has been reset to its initial state.");
+        logger_1.logger.info('RPC builder has been reset to its initial state.');
     }
 }
 exports.HieuxyzRPC = HieuxyzRPC;

package/dist/hieuxyz/rpc/ImageService.js

@@ -90,8 +90,8 @@ class ImageService {
             form.append('file_name', fileName);
             const response = await this.apiClient.post('/upload', form, {
                 headers: {
-                    ...form.getHeaders()
-                }
+                    ...form.getHeaders(),
+                },
             });
             if (response.data && response.data.id) {
                 return response.data.id;

package/dist/hieuxyz/rpc/RpcImage.d.ts

@@ -51,6 +51,6 @@ export declare class LocalImage extends RpcImage {
 export declare class RawImage extends RpcImage {
     private assetKey;
     constructor(assetKey: string);
-    resolve(imageService: ImageService): Promise<string | undefined>;
+    resolve(__imageService: ImageService): Promise<string | undefined>;
     getCacheKey(): string;
 }

package/dist/hieuxyz/rpc/RpcImage.js

@@ -105,7 +105,7 @@ class RawImage extends RpcImage {
         super();
         this.assetKey = assetKey;
     }
-    async resolve(imageService) {
+    async resolve(__imageService) {
         return this.assetKey;
     }
     getCacheKey() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hieuxyz/rpc",
-  "version": "1.0.9",
+  "version": "1.0.91",
   "description": "A Discord Rich Presence library for Node.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,7 +11,10 @@
   ],
   "scripts": {
     "build": "tsc",
-    "dev": "node -r ts-node/register --env-file=.env examples/main.ts"
+    "dev": "node -r ts-node/register --env-file=.env examples/main.ts",
+    "lint": "eslint \"src/**/*.ts\" --report-unused-disable-directives --max-warnings 0",
+    "lint:fix": "eslint \"src/**/*.ts\" --fix",
+    "format": "prettier --write \"src/**/*.ts\" \"examples/**/*.ts\""
   },
   "keywords": [
     "discord",
@@ -25,9 +28,14 @@
     "ws": "^8.18.3"
   },
   "devDependencies": {
-    "@types/node": "^24.5.2",
+    "@types/node": "^24.6.0",
     "@types/ws": "^8.18.1",
+    "eslint": "^9.36.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "prettier": "^3.6.2",
     "ts-node": "^10.9.2",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.45.0"
   }
 }