@hieuxyz/rpc 1.2.2 → 1.2.3

package/README.md

@@ -195,8 +195,8 @@ This is the main starting point.
     -   `options.connectionTimeout` (optional): Timeout in milliseconds for the initial connection. Defaults to `30000`.
 -   `client.run()`: Start connecting to Discord Gateway.
 -   `client.rpc`: Access the instance of `HieuxyzRPC` to build the state.
+-   `client.createRPC()`: Create a new separate RPC instance (Multi-RPC).
 -   `client.close(force?: boolean)`: Closes the connection to the Discord Gateway.
-    -   `force` (optional, boolean): If `true`, the client closes permanently and will not reconnect.
 
 ### Class `HieuxyzRPC`
 
@@ -205,23 +205,26 @@ Main builder class for RPC.
 #### Getter Properties
 -   `.largeImageUrl`: Returns the resolved URL for the large image, or `null`.
 -   `.smallImageUrl`: Returns the resolved URL for the small image, or `null`.
+-   `.currentStatus`: Returns the current status string (e.g. 'online').
 
 #### 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.
+-   `.setStatus('online' | 'dnd' | 'idle' | 'invisible' | 'offline')`: Sets the user's presence status.
+-   `.setType(ActivityType | string | number)`: Sets the activity type (Playing, Listening, etc.).
+-   `.setTimestamps(start?, end?)`: Sets the start and/or end times (ms).
+-   `.setParty(current, max, id?)`: Sets the party information.
+-   `.setLargeImage(RpcImage | string, text?)`: Sets the large image and its tooltip text.
+-   `.setSmallImage(RpcImage | string, text?)`: Sets the small image and its tooltip text.
 -   `.setButtons(buttons[])`: Sets up to two clickable buttons. Each button is an object `{ label: string, url: string }`.
+-   `.addButton(label, url)`: Adds a single button (max 2).
 -   `.setSecrets({ join?, spectate?, match? })`: Sets secrets for game invites.
 -   `.setSyncId(string)`: Sets the sync ID, used for features like Spotify track syncing.
 -   `.setFlags(number)`: Sets activity flags (e.g., for instanced games). Use the `ActivityFlags` enum.
--   `.setPlatform(platform)`: Sets the platform (`'desktop'`, `'xbox'`, etc.).
+-   `.setPlatform(platform)`: Sets the platform (`'desktop'`, `'android'`, `'ios'`, `'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 activity details.
@@ -238,16 +241,17 @@ Main builder class for RPC.
 -   `.build()`: Builds and sends the presence payload to Discord.
 -   `.updateRPC()`: Alias for `build()`.
 -   `.clear()`: Clears the Rich Presence from the user's profile and resets the builder.
--   `.clearCache()`
--   `.destroy()`
+-   `.clearCache()`: Clears the internal asset cache.
+-   `.destroy()`: Destroys the RPC instance and stops background tasks.
 
 ### Types of images
 
 -   `new ExternalImage(url)`: Use an image from an external URL (will be proxied).
 -   `new LocalImage(filePath, fileName?)`: Upload a photo from your device.
--   `new RawImage(assetKey)`: Use an existing asset key directly (e.g., `spotify:track_id`).
+-   `new RawImage(assetKey)`: Use an existing asset key directly.
 -   `new DiscordImage(key)`: Use assets already on Discord (e.g., `mp:attachments/...`).
 -   `new ApplicationImage(name)`: Use an asset name from your Discord Application (requires .setApplicationId()).
+
 ## Author
 
 Developed by **hieuxyz**.

package/dist/hieuxyz/Client.js

@@ -104,7 +104,7 @@ class Client {
      * Displays information about the library.
      */
     printAbout() {
-        const version = '1.2.2';
+        const version = '1.2.3';
         console.log(`
   _     _                               
  | |__ (_) ___ _   ___  ___   _ ______  

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

@@ -103,9 +103,10 @@ export declare class HieuxyzRPC {
      * Set party information for the activity.
      * @param {number} currentSize - Current number of players.
      * @param {number} maxSize - Maximum number of players.
+     * @param {string} [id] - Optional custom party ID. Defaults to 'hieuxyz'.
      * @returns {this}
      */
-    setParty(currentSize: number, maxSize: number): this;
+    setParty(currentSize: number, maxSize: number, id?: string): this;
     /**
      * Set large image and its caption text.
      * @param {string | RpcImage} source - Image source (URL, asset key, Asset Name or RpcImage object).
@@ -120,8 +121,16 @@ export declare class HieuxyzRPC {
      * @returns {this}
      */
     setSmallImage(source: string | RpcImage, text?: string): this;
+    /**
+     * Add a single button to the activity.
+     * @param {string} label - The text displayed on the button.
+     * @param {string} url - The URL opened when the button is clicked.
+     * @returns {this}
+     */
+    addButton(label: string, url: string): this;
     /**
      * Set clickable buttons for RPC (up to 2).
+     * This will overwrite any existing buttons.
      * @param {RpcButton[]} buttons - An array of button objects, each with a `label` and `url`.
      * @returns {this}
      */

package/dist/hieuxyz/rpc/HieuxyzRPC.js

@@ -188,10 +188,11 @@ class HieuxyzRPC {
      * Set party information for the activity.
      * @param {number} currentSize - Current number of players.
      * @param {number} maxSize - Maximum number of players.
+     * @param {string} [id] - Optional custom party ID. Defaults to 'hieuxyz'.
      * @returns {this}
      */
-    setParty(currentSize, maxSize) {
-        this.activity.party = { id: 'hieuxyz', size: [currentSize, maxSize] };
+    setParty(currentSize, maxSize, id = 'hieuxyz') {
+        this.activity.party = { id: id, size: [currentSize, maxSize] };
         return this;
     }
     /**
@@ -218,8 +219,33 @@ class HieuxyzRPC {
             this.assets.small_text = this.sanitize(text);
         return this;
     }
+    /**
+     * Add a single button to the activity.
+     * @param {string} label - The text displayed on the button.
+     * @param {string} url - The URL opened when the button is clicked.
+     * @returns {this}
+     */
+    addButton(label, url) {
+        if (!this.activity.buttons) {
+            this.activity.buttons = [];
+        }
+        if (!this.activity.metadata) {
+            this.activity.metadata = { button_urls: [] };
+        }
+        if (!this.activity.metadata.button_urls) {
+            this.activity.metadata.button_urls = [];
+        }
+        if (this.activity.buttons.length >= 2) {
+            logger_1.logger.warn('Cannot add more than 2 buttons. Button ignored.');
+            return this;
+        }
+        this.activity.buttons.push(this.sanitize(label, 32));
+        this.activity.metadata.button_urls.push(url);
+        return this;
+    }
     /**
      * Set clickable buttons for RPC (up to 2).
+     * This will overwrite any existing buttons.
      * @param {RpcButton[]} buttons - An array of button objects, each with a `label` and `url`.
      * @returns {this}
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hieuxyz/rpc",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "A Discord Rich Presence library for Node.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",