@hieuxyz/rpc 1.1.0 → 1.2.0

package/dist/hieuxyz/rpc/HieuxyzRPC.js

@@ -1,9 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HieuxyzRPC = void 0;
+exports.HieuxyzRPC = exports.ActivityFlags = void 0;
 const types_1 = require("../gateway/entities/types");
 const RpcImage_1 = require("./RpcImage");
 const logger_1 = require("../utils/logger");
+/**
+ * Flags for activities, used with `.setFlags()`.
+ * @enum {number}
+ */
+var ActivityFlags;
+(function (ActivityFlags) {
+    ActivityFlags[ActivityFlags["INSTANCE"] = 1] = "INSTANCE";
+    ActivityFlags[ActivityFlags["JOIN"] = 2] = "JOIN";
+    ActivityFlags[ActivityFlags["SPECTATE"] = 4] = "SPECTATE";
+    ActivityFlags[ActivityFlags["JOIN_REQUEST"] = 8] = "JOIN_REQUEST";
+    ActivityFlags[ActivityFlags["SYNC"] = 16] = "SYNC";
+    ActivityFlags[ActivityFlags["PLAY"] = 32] = "PLAY";
+})(ActivityFlags || (exports.ActivityFlags = ActivityFlags = {}));
 /**
  * Class built for creating and managing Discord Rich Presence states.
  */
@@ -13,7 +26,7 @@ class HieuxyzRPC {
     activity = {};
     assets = {};
     status = 'online';
-    applicationId = '1416676323459469363'; // Default ID, can be changed
+    applicationId = '1416676323459469363';
     platform = 'desktop';
     /**
      * Cache for resolved image assets to avoid re-uploading or re-fetching.
@@ -22,11 +35,58 @@ class HieuxyzRPC {
      */
     resolvedAssetsCache = new Map();
     renewalInterval = null;
+    /**
+     * Cache for Application Assets (Bot Assets).
+     * Map<ApplicationID, Map<AssetName, AssetID>>
+     */
+    applicationAssetsCache = new Map();
     constructor(websocket, imageService) {
         this.websocket = websocket;
         this.imageService = imageService;
         this.startBackgroundRenewal();
     }
+    /**
+     * Returns the URL of the large image asset, if available.
+     * @type {string | null}
+     * @readonly
+     */
+    get largeImageUrl() {
+        if (!this.assets.large_image)
+            return null;
+        const cacheKey = this.assets.large_image.getCacheKey();
+        const resolvedAsset = this.resolvedAssetsCache.get(cacheKey);
+        return resolvedAsset ? this._resolveAssetUrl(resolvedAsset) : null;
+    }
+    /**
+     * Returns the URL of the small image asset, if available.
+     * @type {string | null}
+     * @readonly
+     */
+    get smallImageUrl() {
+        if (!this.assets.small_image)
+            return null;
+        const cacheKey = this.assets.small_image.getCacheKey();
+        const resolvedAsset = this.resolvedAssetsCache.get(cacheKey);
+        return resolvedAsset ? this._resolveAssetUrl(resolvedAsset) : null;
+    }
+    _resolveAssetUrl(assetKey) {
+        if (assetKey.startsWith('mp:')) {
+            return `https://media.discordapp.net/${assetKey.substring(3)}`;
+        }
+        if (assetKey.startsWith('spotify:')) {
+            return `https://i.scdn.co/image/${assetKey.substring(8)}`;
+        }
+        if (assetKey.startsWith('youtube:')) {
+            return `https://i.ytimg.com/vi/${assetKey.substring(8)}/hqdefault.jpg`;
+        }
+        if (assetKey.startsWith('twitch:')) {
+            return `https://static-cdn.jtvnw.net/previews-ttv/live_user_${assetKey.substring(7)}.png`;
+        }
+        if (this.applicationId && !assetKey.startsWith('http')) {
+            return `https://cdn.discordapp.com/app-assets/${this.applicationId}/${assetKey}.png`;
+        }
+        return null;
+    }
     _toRpcImage(source) {
         if (typeof source !== 'string') {
             return source;
@@ -50,6 +110,9 @@ class HieuxyzRPC {
         if (source.startsWith('attachments/') || source.startsWith('external/')) {
             return new RpcImage_1.DiscordImage(source);
         }
+        if (/^[a-zA-Z0-9_]+$/.test(source) && !/^\d{17,20}$/.test(source)) {
+            return new RpcImage_1.ApplicationImage(source);
+        }
         return new RpcImage_1.RawImage(source);
     }
     cleanupNulls(obj) {
@@ -60,7 +123,7 @@ class HieuxyzRPC {
     }
     /**
      * Name the operation (first line of RPC).
-     * @param name - Name to display.
+     * @param {string} name - Name to display.
      * @returns {this}
      */
     setName(name) {
@@ -69,7 +132,7 @@ class HieuxyzRPC {
     }
     /**
      * Set details for the operation (second line of RPC).
-     * @param details - Details to display.
+     * @param {string} details - Details to display.
      * @returns {this}
      */
     setDetails(details) {
@@ -78,7 +141,7 @@ class HieuxyzRPC {
     }
     /**
      * Set the state for the operation (third line of the RPC).
-     * @param state - State to display.
+     * @param {string} state - State to display.
      * @returns {this}
      */
     setState(state) {
@@ -87,7 +150,7 @@ class HieuxyzRPC {
     }
     /**
      * Set the activity type.
-     * @param type - The type of activity (e.g. 0, 'playing', or ActivityType.Playing).
+     * @param {SettableActivityType} type - The type of activity (e.g. 0, 'playing', or ActivityType.Playing).
      * @returns {this}
      */
     setType(type) {
@@ -109,8 +172,8 @@ class HieuxyzRPC {
     }
     /**
      * Set a start and/or end timestamp for the activity.
-     * @param start - Unix timestamp (milliseconds) for start time.
-     * @param end - Unix timestamp (milliseconds) for the end time.
+     * @param {number} [start] - Unix timestamp (milliseconds) for start time.
+     * @param {number} [end] - Unix timestamp (milliseconds) for the end time.
      * @returns {this}
      */
     setTimestamps(start, end) {
@@ -119,8 +182,8 @@ class HieuxyzRPC {
     }
     /**
      * Set party information for the activity.
-     * @param currentSize - Current number of players.
-     * @param maxSize - Maximum number of players.
+     * @param {number} currentSize - Current number of players.
+     * @param {number} maxSize - Maximum number of players.
      * @returns {this}
      */
     setParty(currentSize, maxSize) {
@@ -129,8 +192,8 @@ class HieuxyzRPC {
     }
     /**
      * Set large image and its caption text.
-     * @param source - Image source (URL, asset key, or RpcImage object).
-     * @param text - Text displayed when hovering over image.
+     * @param {string | RpcImage} source - Image source (URL, asset key, Asset Name or RpcImage object).
+     * @param {string} [text] - Text displayed when hovering over image.
      * @returns {this}
      */
     setLargeImage(source, text) {
@@ -141,8 +204,8 @@ class HieuxyzRPC {
     }
     /**
      * Set the small image and its caption text.
-     * @param source - Image source (URL, asset key, or RpcImage object).
-     * @param text - Text displayed when hovering over image.
+     * @param {string | RpcImage} source - Image source (URL, asset key, Asset Name or RpcImage object).
+     * @param {string} [text] - Text displayed when hovering over image.
      * @returns {this}
      */
     setSmallImage(source, text) {
@@ -153,7 +216,7 @@ class HieuxyzRPC {
     }
     /**
      * Set clickable buttons for RPC (up to 2).
-     * @param buttons - An array of button objects.
+     * @param {RpcButton[]} buttons - An array of button objects, each with a `label` and `url`.
      * @returns {this}
      */
     setButtons(buttons) {
@@ -162,22 +225,49 @@ class HieuxyzRPC {
         this.activity.metadata = { button_urls: validButtons.map((b) => b.url) };
         return this;
     }
+    /**
+     * Set secrets for joining, spectating, and matching games.
+     * @param {RpcSecrets} secrets - An object with join, spectate, and/or match secrets.
+     * @returns {this}
+     */
+    setSecrets(secrets) {
+        this.activity.secrets = secrets;
+        return this;
+    }
+    /**
+     * Set the sync_id, typically used for Spotify track synchronization.
+     * @param {string} syncId - The synchronization ID.
+     * @returns {this}
+     */
+    setSyncId(syncId) {
+        this.activity.sync_id = syncId;
+        return this;
+    }
+    /**
+     * Set activity flags. Use the ActivityFlags enum for convenience.
+     * @param {number} flags - A number representing the bitwise flags.
+     * @returns {this}
+     */
+    setFlags(flags) {
+        this.activity.flags = flags;
+        return this;
+    }
     /**
      * Set custom application ID for RPC.
-     * @param id - Discord app ID (must be an 18 or 19 digit number string).
+     * @param {string} id - Discord app ID (must be an 18 or 19 digit number string).
      * @throws {Error} If ID is invalid.
      * @returns {this}
      */
     setApplicationId(id) {
-        if (!/^\d{18,19}$/.test(id)) {
-            throw new Error('The app ID must be an 18 or 19 digit number.');
+        if (!/^\d{17,20}$/.test(id)) {
+            throw new Error('The app ID must be a valid number string (17-20 digits).');
         }
         this.applicationId = id;
         return this;
     }
     /**
      * Set the user's status (e.g. online, idle, dnd).
-     * @param status - Desired state.
+     * @param {'online' | 'dnd' | 'idle' | 'invisible' | 'offline'} status - Desired state.
      * @returns {this}
      */
     setStatus(status) {
@@ -186,7 +276,7 @@ class HieuxyzRPC {
     }
     /**
      * Set the platform on which the activity is running.
-     * @param platform - Platform (e.g. 'desktop', 'xbox').
+     * @param {DiscordPlatform} platform - Platform (e.g. 'desktop', 'xbox').
      * @returns {this}
      */
     setPlatform(platform) {
@@ -195,7 +285,7 @@ class HieuxyzRPC {
     }
     /**
      * Marks the activity as a joinable instance for the game.
-     * @param instance - Whether this activity is a specific instance.
+     * @param {boolean} instance - Whether this activity is a specific instance.
      * @returns {this}
      */
     setInstance(instance) {
@@ -223,6 +313,10 @@ class HieuxyzRPC {
         this.activity.metadata = undefined;
         return this;
     }
+    clearSecrets() {
+        this.activity.secrets = undefined;
+        return this;
+    }
     clearInstance() {
         this.activity.instance = undefined;
         return this;
@@ -288,16 +382,45 @@ class HieuxyzRPC {
             logger_1.logger.info('Stopped background asset renewal process.');
         }
     }
+    /**
+     * Ensure assets are fetched for the current application ID.
+     */
+    async ensureAppAssetsLoaded() {
+        if (!this.applicationAssetsCache.has(this.applicationId)) {
+            logger_1.logger.info(`Fetching assets for Application ID: ${this.applicationId}...`);
+            const assets = await this.imageService.fetchApplicationAssets(this.applicationId);
+            const assetMap = new Map();
+            assets.forEach((asset) => {
+                assetMap.set(asset.name, asset.id);
+            });
+            this.applicationAssetsCache.set(this.applicationId, assetMap);
+            logger_1.logger.info(`Loaded ${assets.length} assets for Application ID: ${this.applicationId}.`);
+        }
+    }
     async resolveImage(image) {
         if (!image)
             return undefined;
         const cacheKey = image.getCacheKey();
+        if (cacheKey.startsWith('app_asset:')) {
+            await this.ensureAppAssetsLoaded();
+            const assetName = cacheKey.substring('app_asset:'.length);
+            const appAssets = this.applicationAssetsCache.get(this.applicationId);
+            const assetId = appAssets?.get(assetName);
+            if (!assetId) {
+                logger_1.logger.warn(`Asset with name "${assetName}" not found for Application ID ${this.applicationId}.`);
+                return undefined;
+            }
+            return assetId;
+        }
         const cachedAsset = this.resolvedAssetsCache.get(cacheKey);
         if (cachedAsset) {
             return await this.renewAssetIfNeeded(cacheKey, cachedAsset);
         }
         const resolvedAsset = await image.resolve(this.imageService);
         if (resolvedAsset) {
+            if (resolvedAsset.startsWith('app_asset:')) {
+                return this.resolveImage(image);
+            }
             this.resolvedAssetsCache.set(cacheKey, resolvedAsset);
         }
         return resolvedAsset;

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

@@ -1,3 +1,8 @@
+export interface DiscordAsset {
+    id: string;
+    type: number;
+    name: string;
+}
 /**
  * A service to handle external image proxying and local image uploading.
  * Interact with a backend API service to manage image assets.
@@ -28,4 +33,10 @@ export declare class ImageService {
      * @returns {Promise<string | undefined>} The new asset key or undefined if it failed.
      */
     renewImage(assetId: string): Promise<string | undefined>;
+    /**
+     * Fetch all assets for a specific Discord Application.
+     * @param applicationId - The ID of the application.
+     * @returns {Promise<DiscordAsset[]>} List of assets (id, name, type).
+     */
+    fetchApplicationAssets(applicationId: string): Promise<DiscordAsset[]>;
 }

package/dist/hieuxyz/rpc/ImageService.js

@@ -121,5 +121,22 @@ class ImageService {
         }
         return undefined;
     }
+    /**
+     * Fetch all assets for a specific Discord Application.
+     * @param applicationId - The ID of the application.
+     * @returns {Promise<DiscordAsset[]>} List of assets (id, name, type).
+     */
+    async fetchApplicationAssets(applicationId) {
+        try {
+            const url = `https://discord.com/api/v9/oauth2/applications/${applicationId}/assets`;
+            const response = await axios_1.default.get(url);
+            return response.data;
+        }
+        catch (error) {
+            const err = error;
+            logger_1.logger.error(`Failed to fetch assets for application ${applicationId}: ${err.message}. Ensure the App ID is correct.`);
+            return [];
+        }
+    }
 }
 exports.ImageService = ImageService;

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

@@ -54,3 +54,16 @@ export declare class RawImage extends RpcImage {
     resolve(__imageService: ImageService): Promise<string | undefined>;
     getCacheKey(): string;
 }
+/**
+ * Represents an asset uploaded to the Discord Application (Bot Assets).
+ * It will resolve the asset ID by matching the asset name.
+ */
+export declare class ApplicationImage extends RpcImage {
+    assetName: string;
+    /**
+     * @param assetName The name of the asset as defined in the Discord Developer Portal.
+     */
+    constructor(assetName: string);
+    resolve(__imageService: ImageService): Promise<string | undefined>;
+    getCacheKey(): string;
+}

package/dist/hieuxyz/rpc/RpcImage.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RawImage = exports.LocalImage = exports.ExternalImage = exports.DiscordImage = exports.RpcImage = void 0;
+exports.ApplicationImage = exports.RawImage = exports.LocalImage = exports.ExternalImage = exports.DiscordImage = exports.RpcImage = void 0;
 const path = __importStar(require("path"));
 /**
  * Base abstract class for all RPC image types.
@@ -113,3 +113,24 @@ class RawImage extends RpcImage {
     }
 }
 exports.RawImage = RawImage;
+/**
+ * Represents an asset uploaded to the Discord Application (Bot Assets).
+ * It will resolve the asset ID by matching the asset name.
+ */
+class ApplicationImage extends RpcImage {
+    assetName;
+    /**
+     * @param assetName The name of the asset as defined in the Discord Developer Portal.
+     */
+    constructor(assetName) {
+        super();
+        this.assetName = assetName;
+    }
+    async resolve(__imageService) {
+        return `app_asset:${this.assetName}`;
+    }
+    getCacheKey() {
+        return `app_asset:${this.assetName}`;
+    }
+}
+exports.ApplicationImage = ApplicationImage;

package/dist/index.d.ts

@@ -2,6 +2,6 @@ export { Client, ClientOptions } from './hieuxyz/Client';
 export { DiscordWebSocket } from './hieuxyz/gateway/DiscordWebSocket';
 export { HieuxyzRPC } from './hieuxyz/rpc/HieuxyzRPC';
 export { ImageService } from './hieuxyz/rpc/ImageService';
-export { RpcImage, DiscordImage, ExternalImage, LocalImage, RawImage } from './hieuxyz/rpc/RpcImage';
+export { RpcImage, DiscordImage, ExternalImage, LocalImage, RawImage, ApplicationImage } from './hieuxyz/rpc/RpcImage';
 export { logger } from './hieuxyz/utils/logger';
 export * from './hieuxyz/gateway/entities/types';

package/dist/index.js

@@ -14,7 +14,7 @@ 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 });
-exports.logger = exports.RawImage = exports.LocalImage = exports.ExternalImage = exports.DiscordImage = exports.RpcImage = exports.ImageService = exports.HieuxyzRPC = exports.DiscordWebSocket = exports.Client = void 0;
+exports.logger = exports.ApplicationImage = exports.RawImage = exports.LocalImage = exports.ExternalImage = exports.DiscordImage = exports.RpcImage = exports.ImageService = exports.HieuxyzRPC = exports.DiscordWebSocket = exports.Client = void 0;
 var Client_1 = require("./hieuxyz/Client");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return Client_1.Client; } });
 var DiscordWebSocket_1 = require("./hieuxyz/gateway/DiscordWebSocket");
@@ -29,6 +29,7 @@ Object.defineProperty(exports, "DiscordImage", { enumerable: true, get: function
 Object.defineProperty(exports, "ExternalImage", { enumerable: true, get: function () { return RpcImage_1.ExternalImage; } });
 Object.defineProperty(exports, "LocalImage", { enumerable: true, get: function () { return RpcImage_1.LocalImage; } });
 Object.defineProperty(exports, "RawImage", { enumerable: true, get: function () { return RpcImage_1.RawImage; } });
+Object.defineProperty(exports, "ApplicationImage", { enumerable: true, get: function () { return RpcImage_1.ApplicationImage; } });
 var logger_1 = require("./hieuxyz/utils/logger");
 Object.defineProperty(exports, "logger", { enumerable: true, get: function () { return logger_1.logger; } });
 __exportStar(require("./hieuxyz/gateway/entities/types"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hieuxyz/rpc",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "A Discord Rich Presence library for Node.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -16,6 +16,10 @@
     "lint:fix": "eslint \"src/**/*.ts\" --fix",
     "format": "prettier --write \"src/**/*.ts\" \"examples/**/*.ts\""
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hieuxyz00/hieuxyz_rpc.git"
+  },
   "keywords": [
     "discord",
     "rpc",
@@ -23,19 +27,23 @@
   ],
   "author": "hieuxyz",
   "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/hieuxyz00/hieuxyz_rpc/issues"
+  },
+  "homepage": "https://github.com/hieuxyz00/hieuxyz_rpc#readme",
   "dependencies": {
-    "axios": "^1.12.2",
+    "axios": "^1.13.2",
     "ws": "^8.18.3"
   },
   "devDependencies": {
-    "@types/node": "^24.6.2",
+    "@types/node": "^25.0.3",
     "@types/ws": "^8.18.1",
-    "eslint": "^9.36.0",
+    "eslint": "^9.39.2",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-prettier": "^5.5.4",
-    "prettier": "^3.6.2",
+    "prettier": "^3.7.4",
     "ts-node": "^10.9.2",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.45.0"
+    "typescript-eslint": "^8.51.0"
   }
 }