x3ui-api 1.0.5 → 1.0.7-1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "x3ui-api",
-  "version": "1.0.5",
+  "version": "1.0.7-1",
   "description": "API client for x3ui panel",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/core/ClientBuilder.js

@@ -54,4 +54,6 @@ module.exports = class ClientBuilder {
             reset: this.reset
         };
     }
-}
+}
+
+module.exports.default = module.exports;

package/src/core/X3UIClient.d.ts

@@ -1,5 +1,6 @@
 import {AxiosInstance} from "axios";
 import {
+    DeepPartial,
     InboundConfig,
     LoginResponse,
     SystemStats,
@@ -19,7 +20,7 @@ export default class X3UIClient {
 
     addInbound(config: Omit<InboundConfig, 'id'>): Promise<InboundConfig>;
 
-    updateInbound(id: number, config: Partial<InboundConfig>): Promise<void>;
+    updateInbound(id: number, config: DeepPartial<InboundConfig>): Promise<void>;
 
     deleteInbound(id: number): Promise<void>;
 

package/src/core/X3UIClient.js

@@ -1,8 +1,13 @@
 const axios = require("axios");
 
 module.exports = class X3UIClient {
+
+    isAuthed = false;
+    config = {};
+
     constructor(config) {
-        this.parseJSONSettings = config.parseJSONSettings || true;
+        this.config = config;
+        this.config.parseJSONSettings ??= true;
         this.client = axios.create({
             baseURL: config.baseURL,
             headers: config.token ? {
@@ -15,14 +20,14 @@ module.exports = class X3UIClient {
 
     /**
      * Login to the x3ui panel
-     * @param {string} username Panel username
-     * @param {string} password Panel password
+     * @param {string?} username Panel username
+     * @param {string?} password Panel password
      * @returns {Promise<{success: boolean, msg: string, obj: any}>} Login response with success status and token
      */
     async login(username, password) {
         const formData = new URLSearchParams();
-        formData.append('username', username);
-        formData.append('password', password);
+        formData.append('username', username || this.config.username);
+        formData.append('password', password || this.config.password);
 
         const response = await this.client.post('/login', formData, {
             headers: {
@@ -32,12 +37,16 @@ module.exports = class X3UIClient {
 
         if (response.data.success) {
             this.client.defaults.headers.Cookie = `lang=en-US; ${response.headers.get("set-cookie")[0].split(";")[0]}`;
+            this.isAuthed = true;
         }
 
         return response.data;
     }
 
     async getSystemStats() {
+        if(!this.isAuthed) {
+            await this.login();
+        }
         const response = await this.client.post('/server/status');
         return response.data.obj;
     }
@@ -61,6 +70,9 @@ module.exports = class X3UIClient {
      * }>>}
      */
     async getInbounds() {
+        if(!this.isAuthed) {
+            await this.login();
+        }
         const response = await this.client.get('/panel/api/inbounds/list');
         let inbounds = response.data.obj;
         if (this.parseJSONSettings) {
@@ -106,6 +118,9 @@ module.exports = class X3UIClient {
      * @returns {Promise<void>}
      */
     async addInbound(config) {
+        if(!this.isAuthed) {
+            await this.login();
+        }
         config = this.stringifyInbound(config);
         const response = await this.client.post('/panel/api/inbounds/add', config);
         if(!response.data.success)
@@ -120,6 +135,9 @@ module.exports = class X3UIClient {
      * @returns {Promise<void>}
      */
     async updateInbound(id, config) {
+        if(!this.isAuthed) {
+            await this.login();
+        }
         config = this.stringifyInbound(config);
         const response = await this.client.post(`/panel/api/inbounds/update/${id}`, config);
         if(!response.data.success)
@@ -133,6 +151,9 @@ module.exports = class X3UIClient {
      * @returns {Promise<void>}
      */
     async deleteInbound(id) {
+        if(!this.isAuthed) {
+            await this.login();
+        }
         await this.client.post(`/panel/api/inbounds/del/${id}`);
     }
 
@@ -141,7 +162,12 @@ module.exports = class X3UIClient {
      * @returns {Promise<{privateKey: string, publicKey: string}>} New X25519 key pair
      */
     async getNewX25519Cert() {
+        if(!this.isAuthed) {
+            await this.login();
+        }
         const response = await this.client.post('/server/getNewX25519Cert');
         return response.data.obj;
     }
-}
+}
+
+module.exports.default = module.exports;

package/src/index.d.ts

@@ -1,11 +1,17 @@
 import X3UIClient from "./core/X3UIClient";
 
+export type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+
 export default X3UIClient;
 
 export interface X3UIConfig {
     baseURL: string;
     token?: string;
     parseJSONSettings?: boolean;
+    username?: string;
+    password?: string;
 }
 
 export interface LoginResponse {

package/src/index.js

@@ -1,3 +1,4 @@
 const X3UIClient = require('./core/X3UIClient');
 
 module.exports = X3UIClient;
+module.exports.default = X3UIClient;

package/src/protocols/vless/ClearBuilder.d.ts

@@ -0,0 +1,51 @@
+import X3UIClient, {ClientSettings, InboundConfig, DeepPartial} from "../../index";
+import RealityClientBuilder from "./RealityClientBuilder";
+
+export default class ClearBuilder {
+
+    constructor(client: X3UIClient, inbound?: DeepPartial<InboundConfig>);
+
+    /**
+     * Set the port for the inbound. If not provided, will auto-generate unused port
+     */
+    setPort(port: number): this;
+
+    /**
+     * Set the remark/name for the inbound
+     */
+    setRemark(remark: string): this;
+
+    /**
+     * Set listen IP address. Defaults to empty string
+     */
+    setListenIP(ip: string): this;
+
+    /**
+     * Set inbound expiry time. Defaults to 0 (no expiry)
+     */
+    setExpiryTime(timestamp: number): this;
+
+    /**
+     * Add a new client to the inbound
+     */
+    addClient(options?: DeepPartial<ClientSettings>): RealityClientBuilder;
+
+    /**
+     * Get connection link for a client
+     * @param clientIndex Index of the client (defaults to 0)
+     * @param host Optional host address (defaults to listenIP or 'localhost')
+     */
+    getClientLinkByIndex(clientIndex?: number, host?: string): string;
+
+    /**
+     * Get connection link for a client
+     * @param email Email of the client
+     * @param host Optional host address (defaults to listenIP or 'localhost')
+     */
+    getClientLinkByEmail(email: string, host?: string): string;
+
+    /**
+     * Build the final inbound config
+     */
+    build(): Promise<InboundConfig>;
+}

package/src/protocols/vless/ClearBuilder.js

@@ -0,0 +1,150 @@
+const ClearClientBuilder = require("./ClearClientBuilder");
+
+module.exports = class ClearBuilder {
+    constructor(client, options = {}) {
+        this.client = client;
+        // Initialize from InboundConfig
+        this.id = options.id || undefined;
+        this.port = options.port || 0;
+        this.remark = options.remark || '';
+        this.listenIP = options.listen || '';
+        this.expiryTime = options.expiryTime || 0;
+        this.enable = true;
+
+        // Initialize from StreamSettings and RealitySettings
+        const streamSettings = typeof options.streamSettings === 'string'
+            ? JSON.parse(options.streamSettings)
+            : options.streamSettings || {};
+
+        // Initialize clients
+        this.clients = [];
+        const settings = typeof options.settings === 'string'
+            ? JSON.parse(options.settings)
+            : options.settings;
+
+        if (settings?.clients) {
+            settings.clients.forEach(client => {
+                this.addClient(client);
+            });
+        }
+    }
+
+    setPort(port) {
+        this.port = port;
+        return this;
+    }
+
+    setRemark(remark) {
+        this.remark = remark;
+        return this;
+    }
+
+    setListenIP(ip) {
+        this.listenIP = ip;
+        return this;
+    }
+
+    setExpiryTime(timestamp) {
+        this.expiryTime = timestamp;
+        return this;
+    }
+
+    addClient(options = {}) {
+        const builder = new ClearClientBuilder(this);
+        if (options.id) builder.setId(options.id);
+        if (options.email) builder.setEmail(options.email);
+        if (options.totalGB) builder.setTotalGB(options.totalGB);
+        if (options.expiryTime) builder.setExpiryTime(options.expiryTime);
+        if (options.tgId) builder.setTgId(options.tgId);
+        this.clients.push(builder);
+        return builder;
+    }
+
+    getClientLinkByIndex(clientIndex = 0, host) {
+        if (clientIndex < 0 || clientIndex >= this.clients.length) {
+            throw new Error('Invalid client index');
+        }
+        const client = this.clients[clientIndex];
+        return client.getLink(host || this.listenIP || 'localhost', this.port);
+    }
+
+    getClientLinkByEmail(email, host) {
+        const client = this.clients.find(client => client.email === email);
+        if (!client) {
+            throw new Error('Client not found');
+        }
+        return client.getLink(host || this.listenIP || 'localhost', this.port);
+    }
+
+    generateRandomPort() {
+        return Math.floor(Math.random() * (65535 - 1024) + 1024);
+    }
+
+    async build() {
+        if (!this.remark) {
+            throw new Error('Remark is required');
+        }
+
+        // If no port specified, find unused one
+        if (!this.port) {
+            const inbounds = await this.client.getInbounds();
+            const usedPorts = new Set(inbounds.map(i => i.port));
+            let port;
+            do {
+                port = this.generateRandomPort();
+            } while (usedPorts.has(port));
+            this.port = port;
+        }
+
+        // If no clients added, create one default client
+        if (this.clients.length === 0) {
+            this.addClient();
+        }
+
+        // Build all clients
+        const clientConfigs = await Promise.all(this.clients.map(builder => builder.build()));
+
+        return {
+            id: this.id,
+            up: 0,
+            down: 0,
+            total: 0,
+            remark: this.remark,
+            enable: true,
+            expiryTime: this.expiryTime,
+            listen: this.listenIP,
+            port: this.port,
+            protocol: 'vless',
+            settings: {
+                clients: clientConfigs,
+                decryption: 'none',
+                fallbacks: []
+            },
+            streamSettings: {
+                network: 'tcp',
+                security: 'none',
+                externalProxy: [],
+                tcpSettings: {
+                    acceptProxyProtocol: false,
+                    header: {
+                        type: 'none'
+                    }
+                }
+            },
+            tag: `inbound-${this.port}`,
+            sniffing: {
+                enabled: false,
+                destOverride: ['http', 'tls', 'quic', 'fakedns'],
+                metadataOnly: false,
+                routeOnly: false
+            },
+            allocate: {
+                strategy: 'always',
+                refresh: 5,
+                concurrency: 3
+            }
+        };
+    }
+}
+
+module.exports.default = module.exports;

package/src/protocols/vless/ClearClientBuilder.d.ts

@@ -0,0 +1,11 @@
+import ClientBuilder from "../../core/ClientBuilder";
+
+export default class ClearClientBuilder extends ClientBuilder {
+
+    /**
+     * Generate connection link for this client
+     * @param host Host address
+     * @param port Optional port number, defaults to parent's port
+     */
+    getLink(host: string, port?: number): string;
+}

package/src/protocols/vless/ClearClientBuilder.js

@@ -0,0 +1,20 @@
+const ClientBuilder = require('../../core/ClientBuilder');
+
+module.exports = class ClearClientBuilder extends ClientBuilder {
+    getLink(host, port) {
+        const id = this.id || crypto.randomUUID();
+
+        port = port || this.parent.port;
+        let protocol = this.parent.protocol || 'vless';
+
+        const params = new URLSearchParams({
+            security: this.parent.streamSettings?.security || 'none',
+            type: this.parent.streamSettings?.network || 'tcp',
+            encryption: this.parent.settings?.decryption || 'none'
+        });
+
+        return `${protocol}://${id}@${host}:${port}?${params.toString()}#${encodeURIComponent(this.email || 'default')}`;
+    }
+}
+
+module.exports.default = module.exports;

package/src/protocols/vless/RealityBuilder.d.ts

@@ -1,9 +1,9 @@
-import X3UIClient, {ClientSettings, InboundConfig} from "../../index";
-import ClientBuilder from "../../core/ClientBuilder";
+import X3UIClient, {ClientSettings, InboundConfig, DeepPartial} from "../../index";
+import RealityClientBuilder from "./RealityClientBuilder";
 
 export default class RealityBuilder {
 
-    constructor(client: X3UIClient, inbound?: Partial<InboundConfig>);
+    constructor(client: X3UIClient, inbound?: DeepPartial<InboundConfig>);
 
     /**
      * Set the port for the inbound. If not provided, will auto-generate unused port
@@ -53,14 +53,21 @@ export default class RealityBuilder {
     /**
      * Add a new client to the inbound
      */
-    addClient(options?: Partial<ClientSettings>): ClientBuilder;
+    addClient(options?: DeepPartial<ClientSettings>): RealityClientBuilder;
 
     /**
      * Get connection link for a client
      * @param clientIndex Index of the client (defaults to 0)
      * @param host Optional host address (defaults to listenIP or 'localhost')
      */
-    getClientLink(clientIndex?: number, host?: string): string;
+    getClientLinkByIndex(clientIndex?: number, host?: string): string;
+
+    /**
+     * Get connection link for a client
+     * @param email Email of the client
+     * @param host Optional host address (defaults to listenIP or 'localhost')
+     */
+    getClientLinkByEmail(email: string, host?: string): string;
 
     /**
      * Build the final inbound config

package/src/protocols/vless/RealityBuilder.js

@@ -107,7 +107,7 @@ module.exports = class RealityBuilder {
         return builder;
     }
 
-    getClientLink(clientIndex = 0, host) {
+    getClientLinkByIndex(clientIndex = 0, host) {
         if (clientIndex < 0 || clientIndex >= this.clients.length) {
             throw new Error('Invalid client index');
         }
@@ -115,6 +115,14 @@ module.exports = class RealityBuilder {
         return client.getLink(host || this.listenIP || 'localhost', this.port);
     }
 
+    getClientLinkByEmail(email, host) {
+        const client = this.clients.find(client => client.email === email);
+        if (!client) {
+            throw new Error('Client not found');
+        }
+        return client.getLink(host || this.listenIP || 'localhost', this.port);
+    }
+
     generateRandomPort() {
         return Math.floor(Math.random() * (65535 - 1024) + 1024);
     }
@@ -220,4 +228,6 @@ module.exports = class RealityBuilder {
             }
         };
     }
-}
+}
+
+module.exports.default = module.exports;

package/src/protocols/vless/RealityClientBuilder.js

@@ -22,4 +22,6 @@ module.exports = class RealityClientBuilder extends ClientBuilder {
 
         return `${protocol}://${id}@${host}:${port}?${params.toString()}#${encodeURIComponent(this.email || 'default')}`;
     }
-}
+}
+
+module.exports.default = module.exports;

package/src/protocols/vless/index.d.ts

@@ -4,6 +4,8 @@ import RealityClientBuilder from "./RealityClientBuilder";
 declare const _default: {
     RealityBuilder: typeof RealityBuilder;
     RealityClientBuilder: typeof RealityClientBuilder;
+    ClearBuilder: typeof RealityBuilder;
+    ClearClientBuilder: typeof RealityClientBuilder;
 };
 
 export default _default;

package/src/protocols/vless/index.js

@@ -1,4 +1,8 @@
 module.exports = {
     RealityBuilder: require('./RealityBuilder'),
-    RealityClientBuilder: require('./RealityClientBuilder')
-}
+    RealityClientBuilder: require('./RealityClientBuilder'),
+    ClearBuilder: require('./ClearBuilder'),
+    ClearClientBuilder: require('./ClearClientBuilder')
+}
+
+module.exports.default = module.exports

package/src/protocols/vmess/VmessBuilder.d.ts

@@ -1,4 +1,4 @@
-import X3UIClient, {ClientSettings, InboundConfig} from "../../index";
+import X3UIClient, { ClientSettings, DeepPartial, InboundConfig } from "../../index";
 import VmessClientBuilder from "./VmessClientBuilder";
 
 /**
@@ -6,7 +6,7 @@ import VmessClientBuilder from "./VmessClientBuilder";
  */
 export default class VmessBuilder {
 
-    constructor(client: X3UIClient, inbound?: Partial<InboundConfig>);
+    constructor(client: X3UIClient, inbound?: DeepPartial<InboundConfig>);
 
     /**
      * Set the port for the inbound. If not provided, will auto-generate unused port
@@ -56,7 +56,7 @@ export default class VmessBuilder {
     /**
      * Add a new client to the inbound
      */
-    addClient(options?: Partial<ClientSettings>): VmessClientBuilder;
+    addClient(options?: DeepPartial<ClientSettings>): VmessClientBuilder;
 
     /**
      * Get connection link for a client

package/src/protocols/vmess/VmessBuilder.js

@@ -186,4 +186,6 @@ module.exports = class VmessBuilder {
             allocate: this.allocate
         };
     }
-}
+}
+
+module.exports.default = module.exports;

package/src/protocols/vmess/VmessClientBuilder.js

@@ -89,4 +89,6 @@ module.exports = class VmessClientBuilder {
         const vmessLink = 'vmess://' + Buffer.from(JSON.stringify(vmessConfig)).toString('base64');
         return vmessLink;
     }
-}
+}
+
+module.exports.default = module.exports;

package/src/protocols/vmess/index.js

@@ -1,4 +1,6 @@
 module.exports = {
     VmessBuilder: require('./VmessBuilder'),
     VmessClientBuilder: require('./VmessClientBuilder')
-}
+}
+
+module.exports.default = module.exports

package/src/protocols/wireguard/WireguardBuilder.d.ts

@@ -1,5 +1,5 @@
 import WireguardClientBuilder from './WireguardClientBuilder';
-import {ClientSettings} from "../../index";
+import { ClientSettings, DeepPartial } from "../../index";
 
 /**
  * WireguardBuilder class for creating and managing Wireguard server configurations.
@@ -77,7 +77,7 @@ export default class WireguardBuilder {
      * @param options - Optional client settings
      * @returns A new WireguardClientBuilder instance for configuring the client
      */
-    addClient(options?: Partial<ClientSettings>): WireguardClientBuilder;
+    addClient(options?: DeepPartial<ClientSettings>): WireguardClientBuilder;
     
     /**
      * Generates a connection link for a client.

package/src/protocols/wireguard/WireguardBuilder.js

@@ -202,3 +202,5 @@ module.exports = class WireguardBuilder {
         };
     }
 }
+
+module.exports.default = module.exports;

package/src/protocols/wireguard/WireguardClientBuilder.js

@@ -86,3 +86,5 @@ module.exports = class WireguardClientBuilder extends ClientBuilder {
         return config;
     }
 }
+
+module.exports.default = module.exports;

package/src/protocols/wireguard/index.js

@@ -2,3 +2,5 @@ module.exports = {
     WireguardBuilder: require('./WireguardBuilder'),
     WireguardClientBuilder: require('./WireguardClientBuilder')
 }
+
+module.exports.default = module.exports

package/src/index.d.ts~

@@ -1,185 +0,0 @@
-import X3UIClient from "./core/X3UIClient";
-
-export default X3UIClient;
-
-export interface X3UIConfig {
-    baseURL: string;
-    token?: string;
-    parseJSONSettings?: boolean;
-}
-
-export interface LoginResponse {
-    success: boolean;
-    msg: string;
-    obj: any;
-}
-
-export interface InboundConfig {
-    id?: number;
-    up: number;
-    down: number;
-    total: number;
-    remark: string;
-    enable: boolean;
-    expiryTime: number | null;
-    clientStats: ClientStats[];
-    listen: string;
-    port: number;
-    protocol: string;
-    settings: string | InboundSettings;
-    streamSettings: string | StreamSettings;
-    tag: string;
-    sniffing: string | SniffingSettings;
-    allocate: string | AllocateSettings;
-}
-
-export interface AllocateSettings {
-    strategy: string;
-    refresh: number;
-    concurrency: number;
-}
-
-export interface SniffingSettings {
-    enabled: boolean;
-    destOverride: string[];
-    metadataOnly: boolean;
-    routeOnly: boolean;
-}
-
-export interface StreamSettings {
-    network: string;
-    security: string;
-    externalProxy: any[];
-    realitySettings?: RealitySettings;
-    tcpSettings?: TCPSettings;
-    httpupgradeSettings?: HttpUpgradeSettings;
-}
-
-export interface HttpUpgradeSettings {
-    acceptProxyProtocol: boolean;
-    path: string;
-    host: string;
-    headers: Record<string, string>;
-}
-
-export interface TCPSettings {
-    acceptProxyProtocol: boolean;
-    header: {
-        type: string;
-    }
-}
-
-export interface RealitySettings {
-    show: boolean;
-    xver: number;
-    dest: string;
-    serverNames: string[];
-    privateKey: string;
-    minClient: string;
-    maxClient: string;
-    maxTimediff: number;
-    shortIds: string[];
-    settings: {
-        publicKey: string;
-        fingerprint: string;
-        serverName: string;
-        spiderX: string;
-    }
-}
-
-export interface InboundSettings {
-    clients: ClientSettings[];
-    decryption: string;
-    fallbacks: any[];
-}
-
-export interface ClientSettings {
-    id: string;
-    flow: string;
-    email: string;
-    limitIp: number;
-    totalGB: number;
-    expiryTime: number | null;
-    enable: boolean;
-    tgId: string;
-    subId: string;
-    reset: number;
-}
-
-export interface ClientStats {
-    id: number;
-    inboundId: number;
-    enable: boolean;
-    email: string;
-    up: number;
-    down: number;
-    expiryTime: number | null;
-    total: number;
-    reset: number;
-}
-
-export interface SystemStats {
-    cpu: number;
-    cpuCores: number;
-    logicalPro: number;
-    cpuSpeedMhz: number;
-    mem: {
-        current: number;
-        total: number;
-    };
-    swap: {
-        current: number;
-        total: number;
-    }
-    disk: {
-        current: number;
-        total: number;
-    };
-    xray: {
-        state: boolean;
-        errorMsg: string;
-        version: string;
-    };
-    uptime: number;
-    loads: number[];
-    tcpCount: number;
-    udpCount: number;
-    netIO: {
-        up: number;
-        down: number;
-    };
-    netTraffic: {
-        up: number;
-        down: number;
-    };
-    publicIP: {
-        ipv4: string;
-        ipv6: string;
-    }
-    appStats: {
-        threads: number;
-        mem: number;
-        uptime: number;
-    }
-}
-
-export interface RealityInboundOptions {
-    remark: string;
-    port?: number;
-    dest?: string;
-    serverNames?: string[];
-    privateKey?: string;
-    publicKey?: string;
-    shortIds?: string[];
-    fingerprint?: string;
-    listenIP?: string;
-    expiryTime?: number;
-}
-
-export interface ClientOptions {
-    id?: string;
-    email?: string;
-    totalGB?: number;
-    expiryTime?: number;
-    tgId?: string;
-}