@hieuxyz/rpc 1.2.4 → 1.2.5

package/dist/hieuxyz/rpc/HieuxyzRPC.js

@@ -1,546 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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.
- */
-class HieuxyzRPC {
-    imageService;
-    onUpdate;
-    activity = {};
-    assets = {};
-    status = 'online';
-    applicationId = '1416676323459469363';
-    platform = 'desktop';
-    /**
-     * Cache for resolved image assets to avoid re-uploading or re-fetching.
-     * Key: A unique string from RpcImage.getCacheKey().
-     * Value: The resolved asset key (e.g., "mp:attachments/...").
-     */
-    resolvedAssetsCache = new Map();
-    /**
-     * Maximum number of items in cache to prevent memory leaks/bloat over long runtime.
-     */
-    MAX_CACHE_SIZE = 50;
-    renewalInterval = null;
-    /**
-     * Cache for Application Assets (Bot Assets).
-     * Map<ApplicationID, Map<AssetName, AssetID>>
-     */
-    applicationAssetsCache = new Map();
-    constructor(imageService, onUpdate) {
-        this.imageService = imageService;
-        this.onUpdate = onUpdate;
-        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;
-        }
-        if (source.startsWith('https://') || source.startsWith('http://')) {
-            try {
-                const url = new URL(source);
-                if (url.hostname === 'cdn.discordapp.com' || url.hostname === 'media.discordapp.net') {
-                    const discordAssetPath = url.pathname.substring(1);
-                    return new RpcImage_1.DiscordImage(discordAssetPath);
-                }
-                else {
-                    return new RpcImage_1.ExternalImage(source);
-                }
-            }
-            catch {
-                logger_1.logger.warn(`Could not parse "${source}" into a valid URL. Treating as RawImage.`);
-                return new RpcImage_1.RawImage(source);
-            }
-        }
-        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) {
-        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;
-    }
-    /**
-     * Name the operation (first line of RPC).
-     * @param {string} name - Name to display.
-     * @returns {this}
-     */
-    setName(name) {
-        this.activity.name = this.sanitize(name);
-        return this;
-    }
-    /**
-     * Set details for the operation (second line of RPC).
-     * @param {string} details - Details to display.
-     * @returns {this}
-     */
-    setDetails(details) {
-        this.activity.details = this.sanitize(details);
-        return this;
-    }
-    /**
-     * Set the state for the operation (third line of the RPC).
-     * @param {string} state - State to display.
-     * @returns {this}
-     */
-    setState(state) {
-        this.activity.state = this.sanitize(state);
-        return this;
-    }
-    /**
-     * Set the activity type.
-     * @param {SettableActivityType} type - The type of activity (e.g. 0, 'playing', or ActivityType.Playing).
-     * @returns {this}
-     */
-    setType(type) {
-        if (typeof type === 'string') {
-            const typeMap = {
-                playing: types_1.ActivityType.Playing,
-                streaming: types_1.ActivityType.Streaming,
-                listening: types_1.ActivityType.Listening,
-                watching: types_1.ActivityType.Watching,
-                custom: types_1.ActivityType.Custom,
-                competing: types_1.ActivityType.Competing,
-            };
-            this.activity.type = typeMap[type.toLowerCase()] ?? types_1.ActivityType.Playing;
-        }
-        else {
-            this.activity.type = type;
-        }
-        return this;
-    }
-    /**
-     * Set a start and/or end timestamp for the activity.
-     * @param {number} [start] - Unix timestamp (milliseconds) for start time.
-     * @param {number} [end] - Unix timestamp (milliseconds) for the end time.
-     * @returns {this}
-     */
-    setTimestamps(start, end) {
-        this.activity.timestamps = { start, end };
-        return this;
-    }
-    /**
-     * 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, id = 'hieuxyz') {
-        this.activity.party = { id: id, size: [currentSize, maxSize] };
-        return this;
-    }
-    /**
-     * Set large image and its caption text.
-     * @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) {
-        this.assets.large_image = this._toRpcImage(source);
-        if (text)
-            this.assets.large_text = this.sanitize(text);
-        return this;
-    }
-    /**
-     * Set the small image and its caption text.
-     * @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) {
-        this.assets.small_image = this._toRpcImage(source);
-        if (text)
-            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}
-     */
-    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) };
-        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 {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{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 {'online' | 'dnd' | 'idle' | 'invisible' | 'offline'} status - Desired state.
-     * @returns {this}
-     */
-    setStatus(status) {
-        this.status = status;
-        return this;
-    }
-    /**
-     * Set the platform on which the activity is running.
-     * @param {DiscordPlatform} platform - Platform (e.g. 'desktop', 'xbox').
-     * @returns {this}
-     */
-    setPlatform(platform) {
-        this.platform = platform;
-        return this;
-    }
-    /**
-     * Marks the activity as a joinable instance for the game.
-     * @param {boolean} 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;
-    }
-    clearSecrets() {
-        this.activity.secrets = 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;
-        const urlPart = assetKey.substring(3);
-        try {
-            const parsedUrl = new URL(`https://cdn.discordapp.com/${urlPart}`);
-            const expiresTimestamp = parsedUrl.searchParams.get('ex');
-            if (expiresTimestamp) {
-                return parseInt(expiresTimestamp, 16) * 1000;
-            }
-        }
-        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) {
-            // logger.info(`Asset ${cacheKey} is expiring soon. Renewing...`);
-            const assetId = assetKey.split('mp:attachments/')[1];
-            const newAsset = await this.imageService.renewImage(assetId);
-            if (newAsset) {
-                this.resolvedAssetsCache.set(cacheKey, newAsset);
-                return newAsset;
-            }
-            logger_1.logger.warn(`Failed to renew asset, will use the old one.`);
-        }
-        return assetKey;
-    }
-    startBackgroundRenewal() {
-        if (this.renewalInterval) {
-            clearInterval(this.renewalInterval);
-        }
-        this.renewalInterval = setInterval(async () => {
-            // logger.info('Running background asset renewal check...');
-            for (const [cacheKey, assetKey] of this.resolvedAssetsCache.entries()) {
-                await this.renewAssetIfNeeded(cacheKey, assetKey);
-            }
-        }, 600000);
-    }
-    /**
-     * Stops the background process that checks for asset renewal.
-     */
-    stopBackgroundRenewal() {
-        if (this.renewalInterval) {
-            clearInterval(this.renewalInterval);
-            this.renewalInterval = null;
-            // 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;
-        }
-        if (this.resolvedAssetsCache.size >= this.MAX_CACHE_SIZE && !this.resolvedAssetsCache.has(cacheKey)) {
-            const oldestKey = this.resolvedAssetsCache.keys().next().value;
-            if (oldestKey) {
-                this.resolvedAssetsCache.delete(oldestKey);
-            }
-        }
-        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;
-    }
-    /**
-     * Publicly accessible method to build the Activity object.
-     * Used by Client to aggregate activities from multiple RPC instances.
-     * @returns {Promise<Activity | null>} The constructed activity or null if empty.
-     */
-    async buildActivity() {
-        if (Object.keys(this.activity).length === 0 && !this.assets.large_image && !this.assets.small_image) {
-            return null;
-        }
-        const large_image = await this.resolveImage(this.assets.large_image);
-        const small_image = await this.resolveImage(this.assets.small_image);
-        const finalAssets = {
-            large_text: this.assets.large_text,
-            small_text: this.assets.small_text,
-        };
-        if (large_image)
-            finalAssets.large_image = large_image;
-        if (small_image)
-            finalAssets.small_image = small_image;
-        const finalActivity = { ...this.activity };
-        finalActivity.assets = large_image || small_image ? finalAssets : undefined;
-        finalActivity.application_id = this.applicationId;
-        finalActivity.platform = this.platform;
-        if (!finalActivity.name) {
-            finalActivity.name = 'hieuxyzRPC';
-        }
-        if (typeof finalActivity.type === 'undefined') {
-            finalActivity.type = types_1.ActivityType.Playing;
-        }
-        return this.cleanupNulls(finalActivity);
-    }
-    /**
-     * Build the final Rich Presence payload and notify the Client to send it to Discord.
-     * @returns {Promise<void>}
-     */
-    async build() {
-        await this.onUpdate();
-    }
-    /**
-     * Sends an update to an existing RPC.
-     * This is essentially an alias for `build()`.
-     * @returns {Promise<void>}
-     */
-    async updateRPC() {
-        await this.build();
-    }
-    /**
-     * Clears the current Rich Presence from the user's profile and resets the builder.
-     */
-    clear() {
-        this.activity = {};
-        this.assets = {};
-        this.applicationId = '1416676323459469363'; // Reset to default
-        this.platform = 'desktop'; // Reset to default
-        logger_1.logger.info('RPC instance cleared.');
-        this.onUpdate();
-    }
-    /**
-     * Manually clear the asset cache to free memory.
-     */
-    clearCache() {
-        this.resolvedAssetsCache.clear();
-        this.applicationAssetsCache.clear();
-        logger_1.logger.info('RPC Asset cache has been cleared.');
-    }
-    /**
-     * Permanently destroy this RPC instance.
-     * Stops renewal timers and clears memory.
-     */
-    destroy() {
-        this.stopBackgroundRenewal();
-        this.clearCache();
-        this.activity = {};
-        this.assets = {};
-    }
-    /**
-     * Get the current status set for this RPC instance.
-     */
-    get currentStatus() {
-        return this.status;
-    }
-}
-exports.HieuxyzRPC = HieuxyzRPC;

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

@@ -1,42 +0,0 @@
-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.
- */
-export declare class ImageService {
-    private apiClient;
-    /**
-     * Create an ImageService instance.
-     * @param apiBaseUrl - The base URL of the image upload/proxy API.
-     */
-    constructor(apiBaseUrl?: string);
-    /**
-     * Get an asset key proxy for an external image URL.
-     * @param url - URL of external image.
-     * @returns {Promise<string | undefined>} Asset key resolved or undefined if failed.
-     */
-    getExternalUrl(url: string): Promise<string | undefined>;
-    /**
-     * Upload an image from the local file system to the image service.
-     * @param filePath - Path to the image file.
-     * @param fileName - File name to use when uploading.
-     * @returns {Promise<string | undefined>} Asset key resolved or undefined if failed.
-     */
-    uploadImage(filePath: string, fileName: string): Promise<string | undefined>;
-    /**
-     * Requests a new signed URL for an expired or expiring attachment asset.
-     * @param assetId The asset ID part of the URL (e.g., "channel_id/message_id/filename.ext...")
-     * @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[]>;
-}