@remnawave/xtls-sdk 0.0.1 → 0.0.3

package/README.md

@@ -1,8 +1,29 @@
-# XTLS API SDK
+# XTLS SDK
 
-A TypeScript SDK for interacting with Xray server statistics via gRPC.
+![GitHub top language](https://img.shields.io/github/languages/top/remnawave/xtls-sdk)
+![GitHub Repo stars](https://img.shields.io/github/stars/remnawave/xtls-sdk)
 
-This package provides a simple and type-safe way to retrieve various statistics from your Xray server, including system stats, user stats, and connection information.
+![npm version](https://img.shields.io/npm/v/@remnawave/xtls-sdk)
+![GitHub Tag](https://img.shields.io/github/v/tag/remnawave/xtls-sdk)
+
+![Build Status](https://img.shields.io/github/actions/workflow/status/remnawave/xtls-sdk/.github/workflows/deploy-lib.yml)
+![Downloads](https://img.shields.io/npm/dt/@remnawave/xtls-sdk)
+![License](https://img.shields.io/npm/l/@remnawave/xtls-sdk)
+![NPM Last Update](https://img.shields.io/npm/last-update/%40remnawave%2Fxtls-sdk)
+
+![Known Vulnerabilities](https://snyk.io/test/github/remnawave/xtls-sdk/badge.svg)
+![Coverage Status](https://img.shields.io/codecov/c/github/remnawave/xtls-sdk)
+
+A TypeScript SDK for interacting with XRAY (XTLS) Core via gRPC API. This package provides a type-safe interface for managing and monitoring your XRAY server, including statistics, user management, and connection information.
+
+## Features
+
+- 🔒 Type-safe API interactions
+- 📊 Comprehensive statistics monitoring
+- 👥 User management capabilities
+- 🔄 Connection monitoring
+- ⚡ Async/Promise-based API
+- 📝 Detailed error handling
 
 ## Installation
 
@@ -10,95 +31,185 @@ This package provides a simple and type-safe way to retrieve various statistics
 npm install @remnawave/xtls-sdk
 # or
 yarn add @remnawave/xtls-sdk
+# or
+pnpm add @remnawave/xtls-sdk
 ```
 
-## Usage
-
-### Basic Setup
+## Quick Start
 
 ```typescript
 import { XtlsApi } from '@remnawave/xtls-sdk';
 
-// Create a new instance
-const xtlsApi = new XtlsApi('127.0.0.1', '8080');
+// Initialize the API client
+const api = new XtlsApi('127.0.0.1', '10085');
+
+// Example: Get system statistics
+const stats = await api.stats.getSysStats();
+if (stats.isOk) {
+  console.log('System Stats:', stats.data);
+}
+```
+
+## Core Features
+
+### Statistics Management
+
+```typescript
+// System Statistics
+const sysStats = await api.stats.getSysStats();
+
+// User Statistics
+const userStats = await api.stats.getUserStats('username');
+const allUsers = await api.stats.getAllUsersStats();
+const isOnline = await api.stats.getUserOnlineStatus('username');
+
+// Traffic Statistics
+const inbounds = await api.stats.getAllInboundsStats();
+const outbounds = await api.stats.getAllOutboundsStats();
 ```
 
-### Examples
+### Response Handling
 
-#### Get System Statistics
+All API methods return a standardized response format:
 
 ```typescript
-const response = await xtlsApi.stats.getSysStats();
+interface ISdkResponse<T> {
+  isOk: boolean;
+  data?: T;
+  message?: string;
+  code?: string;
+}
+```
+
+Example usage:
+
+```typescript
+const response = await api.stats.getSysStats();
 
 if (response.isOk) {
-  console.log('System Stats:', response.data);
+  // Success case
+  console.log('Stats:', response.data);
 } else {
-  console.error('Error:', response.message);
+  // Error case
+  console.error(`Error ${response.code}: ${response.message}`);
 }
 ```
 
-#### Get User Statistics
+### Reset Options
+
+Many methods support statistics reset functionality:
 
 ```typescript
-// Get stats for all users
-const allUsers = await xtlsApi.stats.getAllUsersStats();
+// Get stats and reset counters
+const stats = await api.stats.getUserStats('username', true);
+```
 
-// Get stats for a specific user
-const userStats = await xtlsApi.stats.getUserStats('username123');
+## API Reference
 
-// Check if a user is online
-const onlineStatus = await xtlsApi.stats.getUserOnlineStatus('username123');
-```
+### XtlsApi
 
-#### Connection Statistics
+Main client class for interacting with the XRAY server.
 
 ```typescript
-// Get all inbound connection stats
-const inbounds = await xtlsApi.stats.getAllInboundsStats();
+const api = new XtlsApi(ip: string, port: string);
+```
 
-// Get specific inbound stats
-const inbound = await xtlsApi.stats.getInboundStats('http_in');
+### HandlerService
 
-// Get all outbound connection stats
-const outbounds = await xtlsApi.stats.getAllOutboundsStats();
+Service for managing inbound handlers and their users.
 
-// Get specific outbound stats
-const outbound = await xtlsApi.stats.getOutboundStats('http_out');
-```
+#### User Management Methods
 
-### Reset Statistics
+| Method                                      | Description                      | Parameters                                               |
+| ------------------------------------------- | -------------------------------- | -------------------------------------------------------- |
+| `getInboundUsers(tag: string)`              | Get all users from an inbound    | `tag`: Inbound handler tag                               |
+| `getInboundUsersCount(tag: string)`         | Get count of users in an inbound | `tag`: Inbound handler tag                               |
+| `removeUser(tag: string, username: string)` | Remove a user from an inbound    | `tag`: Inbound handler tag<br>`username`: User to remove |
 
-Most methods support an optional `reset` parameter to clear statistics after retrieval:
+#### Add User Methods
+
+| Method                                                  | Description               | Parameters                                                       |
+| ------------------------------------------------------- | ------------------------- | ---------------------------------------------------------------- |
+| `addTrojanUser(data: IAddTrojanUser)`                   | Add Trojan user           | `data`: { tag, username, password, level }                       |
+| `addVlessUser(data: IAddVlessUser)`                     | Add VLESS user            | `data`: { tag, username, uuid, flow, level }                     |
+| `addShadowsocksUser(data: IAddShadowsocksUser)`         | Add Shadowsocks user      | `data`: { tag, username, password, cipherType, ivCheck, level }  |
+| `addShadowsocks2022User(data: IAddShadowsocks2022User)` | Add Shadowsocks 2022 user | `data`: { tag, username, key, level }                            |
+| `addSocksUser(data: IAddSocksUser)`                     | Add SOCKS user            | `data`: { tag, username, socks_username, socks_password, level } |
+| `addHttpUser(data: IAddHttpUser)`                       | Add HTTP user             | `data`: { tag, username, http_username, http_password, level }   |
+
+Example usage:
 
 ```typescript
-// Get and reset user stats
-const stats = await xtlsApi.stats.getUserStats('username123', true);
+// Get all users in an inbound
+const users = await api.handler.getInboundUsers('main-inbound');
+if (users.isOk) {
+  console.log('Users:', users.data.users);
+}
+
+// Add a new Trojan user
+const newUser = await api.handler.addTrojanUser({
+  tag: 'main-inbound',
+  username: 'user@example.com',
+  password: 'secure-password',
+  level: 0,
+});
+
+// Remove a user
+const removed = await api.handler.removeUser('main-inbound', 'user@example.com');
+
+// Get user count
+const count = await api.handler.getInboundUsersCount('main-inbound');
+if (count.isOk) {
+  console.log('Total users:', count.data);
+}
 ```
 
-## API Reference
+### StatsService
 
-### XtlsApi
+Statistics management service.
 
-- `constructor(ip: string, port: string)`: Creates a new XtlsApi instance
+| Method                                                | Description                      | Parameters                                                       |
+| ----------------------------------------------------- | -------------------------------- | ---------------------------------------------------------------- |
+| `getSysStats()`                                       | Get system statistics            | None                                                             |
+| `getAllUsersStats(reset?: boolean)`                   | Get all users' statistics        | `reset`: Reset stats after retrieval                             |
+| `getUserStats(username: string, reset?: boolean)`     | Get specific user statistics     | `username`: Target user<br>`reset`: Reset stats after retrieval  |
+| `getUserOnlineStatus(username: string)`               | Check user online status         | `username`: Target user                                          |
+| `getAllInboundsStats(reset?: boolean)`                | Get all inbound statistics       | `reset`: Reset stats after retrieval                             |
+| `getInboundStats(inbound: string, reset?: boolean)`   | Get specific inbound statistics  | `inbound`: Inbound tag<br>`reset`: Reset stats after retrieval   |
+| `getAllOutboundsStats(reset?: boolean)`               | Get all outbound statistics      | `reset`: Reset stats after retrieval                             |
+| `getOutboundStats(outbound: string, reset?: boolean)` | Get specific outbound statistics | `outbound`: Outbound tag<br>`reset`: Reset stats after retrieval |
 
-### StatsService
+## Error Handling
+
+The SDK provides detailed error information through the response object:
+
+```typescript
+try {
+  const response = await api.stats.getUserStats('username');
+  if (!response.isOk) {
+    console.error(`Operation failed: ${response.message}`);
+    console.error(`Error code: ${response.code}`);
+  }
+} catch (error) {
+  console.error('Unexpected error:', error);
+}
+```
+
+# Contributors
 
-- `getSysStats()`: Get system statistics
-- `getAllUsersStats(reset?: boolean)`: Get statistics for all users
-- `getUserStats(username: string, reset?: boolean)`: Get statistics for a specific user
-- `getUserOnlineStatus(username: string)`: Check if a user is currently online
-- `getAllInboundsStats(reset?: boolean)`: Get statistics for all inbound connections
-- `getInboundStats(inbound: string, reset?: boolean)`: Get statistics for a specific inbound connection
-- `getAllOutboundsStats(reset?: boolean)`: Get statistics for all outbound connections
-- `getOutboundStats(outbound: string, reset?: boolean)`: Get statistics for a specific outbound connection
+We ❤️‍🔥 contributors! If you'd like to contribute, please check out our [Contributing Guidelines](CONTRIBUTING.md) and feel free to submit a pull request or open an issue.
 
-All methods return a Promise with an `ISdkResponse` type that includes:
+Check [open issues](https://github.com/remnawave/xtls-sdk/issues) to help the progress of this project.
 
-- `isOk`: Boolean indicating success/failure
-- `data`: The requested statistics (when successful)
-- `message`: Error message (when unsuccessful)
-- `code`: Error code (when unsuccessful)
+<p align="center">
+Thanks to the all contributors who have helped improve XTLS SDK:
+</p>
+<p align="center">
+<a href="https://github.com/remnawave/xtls-sdk/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=remnawave/xtls-sdk" />
+</a>
+</p>
 
 ## License
 
-MIT
+MIT License - see the [LICENSE](LICENSE) file for details.

package/build/src/common/errors/handler/handler.errors.d.ts

@@ -0,0 +1,23 @@
+export declare const HANDLER_ERRORS: {
+    readonly UNKNOWN_ERROR: {
+        readonly code: "A001";
+        readonly message: "Unexpected error";
+    };
+    readonly GET_ALL_USERS_ERROR: (message: string) => {
+        code: string;
+        message: string;
+    };
+    readonly ADD_USER_ERROR: (message: string) => {
+        code: string;
+        message: string;
+    };
+    readonly REMOVE_USER_ERROR: (message: string) => {
+        code: string;
+        message: string;
+    };
+    readonly GET_INBOUND_USERS_COUNT_ERROR: (message: string) => {
+        code: string;
+        message: string;
+    };
+};
+//# sourceMappingURL=handler.errors.d.ts.map

package/build/src/common/errors/handler/handler.errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler.errors.d.ts","sourceRoot":"","sources":["../../../../../src/common/errors/handler/handler.errors.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc;;;;;4CAEQ,MAAM;;;;uCAIX,MAAM;;;;0CAIH,MAAM;;;;sDAIM,MAAM;;;;CAIzC,CAAC"}

package/build/src/common/errors/handler/handler.errors.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HANDLER_ERRORS = void 0;
+exports.HANDLER_ERRORS = {
+    UNKNOWN_ERROR: { code: 'A001', message: 'Unexpected error' },
+    GET_ALL_USERS_ERROR: (message) => ({
+        code: 'A002',
+        message: `Error getting all users: ${message}`,
+    }),
+    ADD_USER_ERROR: (message) => ({
+        code: 'A003',
+        message: `Error adding user: ${message}`,
+    }),
+    REMOVE_USER_ERROR: (message) => ({
+        code: 'A004',
+        message: `Error removing user: ${message}`,
+    }),
+    GET_INBOUND_USERS_COUNT_ERROR: (message) => ({
+        code: 'A005',
+        message: `Error getting inbound users count: ${message}`,
+    }),
+};

package/build/src/common/errors/handler/index.d.ts

@@ -0,0 +1,2 @@
+export * from './handler.errors';
+//# sourceMappingURL=index.d.ts.map

package/build/src/common/errors/handler/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/common/errors/handler/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}

package/build/src/common/errors/handler/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./handler.errors"), exports);

package/build/src/common/errors/index.d.ts

@@ -1,2 +1,3 @@
 export * from './stats';
+export * from './handler';
 //# sourceMappingURL=index.d.ts.map

package/build/src/common/errors/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/common/errors/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/common/errors/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC"}

package/build/src/common/errors/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./stats"), exports);
+__exportStar(require("./handler"), exports);

package/build/src/common/utils/create-typed-message/create-typed-message.d.ts

@@ -0,0 +1,5 @@
+import { TypedMessage } from '../../../xray-protos/common/serial/typed_message';
+import { MessageFns } from '../../../xray-protos/common/serial/typed_message';
+declare function createTypedMessage<T extends MessageFns<unknown, string>>(proto: T, data: Parameters<T['create']>[0]): TypedMessage;
+export default createTypedMessage;
+//# sourceMappingURL=create-typed-message.d.ts.map

package/build/src/common/utils/create-typed-message/create-typed-message.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-typed-message.d.ts","sourceRoot":"","sources":["../../../../../src/common/utils/create-typed-message/create-typed-message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,kDAAkD,CAAC;AAChF,OAAO,EAAE,UAAU,EAAE,MAAM,kDAAkD,CAAC;AAE9E,iBAAS,kBAAkB,CAAC,CAAC,SAAS,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,EAC7D,KAAK,EAAE,CAAC,EACR,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GACjC,YAAY,CAKd;AAED,eAAe,kBAAkB,CAAC"}

package/build/src/common/utils/create-typed-message/create-typed-message.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const typed_message_1 = require("../../../xray-protos/common/serial/typed_message");
+function createTypedMessage(proto, data) {
+    return typed_message_1.TypedMessage.create({
+        type: proto.$type,
+        value: proto.encode(proto.create(data)).finish(),
+    });
+}
+exports.default = createTypedMessage;

package/build/src/common/utils/decode-user/constants/account-types.d.ts

@@ -0,0 +1,39 @@
+import { Account as TrojanAccount } from '../../../../xray-protos/proxy/trojan/config';
+import { Account as VlessAccount } from '../../../../xray-protos/proxy/vless/account';
+import { Account as ShadowsocksAccount } from '../../../../xray-protos/proxy/shadowsocks/config';
+import { Account as Shadowsocks2022Account } from '../../../../xray-protos/proxy/shadowsocks_2022/config';
+import { Account as SocksAccount } from '../../../../xray-protos/proxy/socks/config';
+import { Account as HttpAccount } from '../../../../xray-protos/proxy/http/config';
+export declare const ACCOUNT_TYPES: {
+    readonly "xray.proxy.trojan.Account": {
+        readonly decoder: import("../../../../xray-protos/proxy/trojan/config").MessageFns<TrojanAccount, "xray.proxy.trojan.Account">;
+        readonly protocol: "trojan";
+        readonly getCredentials: (acc: TrojanAccount) => Omit<TrojanAccount, "$type">;
+    };
+    readonly "xray.proxy.vless.Account": {
+        readonly decoder: import("../../../../xray-protos/proxy/vless/account").MessageFns<VlessAccount, "xray.proxy.vless.Account">;
+        readonly protocol: "vless";
+        readonly getCredentials: (acc: VlessAccount) => Omit<VlessAccount, "$type">;
+    };
+    readonly "xray.proxy.shadowsocks.Account": {
+        readonly decoder: import("../../../../xray-protos/proxy/shadowsocks/config").MessageFns<ShadowsocksAccount, "xray.proxy.shadowsocks.Account">;
+        readonly protocol: "shadowsocks";
+        readonly getCredentials: (acc: ShadowsocksAccount) => Omit<ShadowsocksAccount, "$type">;
+    };
+    readonly "xray.proxy.shadowsocks_2022.Account": {
+        readonly decoder: import("../../../../xray-protos/proxy/shadowsocks_2022/config").MessageFns<Shadowsocks2022Account, "xray.proxy.shadowsocks_2022.Account">;
+        readonly protocol: "shadowsocks2022";
+        readonly getCredentials: (acc: Shadowsocks2022Account) => Omit<Shadowsocks2022Account, "$type">;
+    };
+    readonly "xray.proxy.socks.Account": {
+        readonly decoder: import("../../../../xray-protos/proxy/socks/config").MessageFns<SocksAccount, "xray.proxy.socks.Account">;
+        readonly protocol: "socks";
+        readonly getCredentials: (acc: SocksAccount) => Omit<SocksAccount, "$type">;
+    };
+    readonly "xray.proxy.http.Account": {
+        readonly decoder: import("../../../../xray-protos/proxy/http/config").MessageFns<HttpAccount, "xray.proxy.http.Account">;
+        readonly protocol: "http";
+        readonly getCredentials: (acc: HttpAccount) => Omit<HttpAccount, "$type">;
+    };
+};
+//# sourceMappingURL=account-types.d.ts.map

package/build/src/common/utils/decode-user/constants/account-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-types.d.ts","sourceRoot":"","sources":["../../../../../../src/common/utils/decode-user/constants/account-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,6CAA6C,CAAC;AACvF,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,kDAAkD,CAAC;AACjG,OAAO,EAAE,OAAO,IAAI,sBAAsB,EAAE,MAAM,uDAAuD,CAAC;AAC1G,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,4CAA4C,CAAC;AACrF,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,2CAA2C,CAAC;AAEnF,eAAO,MAAM,aAAa;;;;uCAII,aAAa,KAAG,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC;;;;;uCAO5C,YAAY,KAAG,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC;;;;;uCAS1C,kBAAkB,KAAG,IAAI,CAAC,kBAAkB,EAAE,OAAO,CAAC;;;;;uCAStD,sBAAsB,KAAG,IAAI,CAAC,sBAAsB,EAAE,OAAO,CAAC;;;;;uCAO9D,YAAY,KAAG,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC;;;;;uCAQ1C,WAAW,KAAG,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC;;CAK5D,CAAC"}

package/build/src/common/utils/decode-user/constants/account-types.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ACCOUNT_TYPES = void 0;
+const config_1 = require("../../../../xray-protos/proxy/trojan/config");
+const account_1 = require("../../../../xray-protos/proxy/vless/account");
+const config_2 = require("../../../../xray-protos/proxy/shadowsocks/config");
+const config_3 = require("../../../../xray-protos/proxy/shadowsocks_2022/config");
+const config_4 = require("../../../../xray-protos/proxy/socks/config");
+const config_5 = require("../../../../xray-protos/proxy/http/config");
+exports.ACCOUNT_TYPES = {
+    [config_1.Account.$type]: {
+        decoder: config_1.Account,
+        protocol: 'trojan',
+        getCredentials: (acc) => ({
+            password: acc.password,
+        }),
+    },
+    [account_1.Account.$type]: {
+        decoder: account_1.Account,
+        protocol: 'vless',
+        getCredentials: (acc) => ({
+            id: acc.id,
+            flow: acc.flow,
+            encryption: acc.encryption,
+        }),
+    },
+    [config_2.Account.$type]: {
+        decoder: config_2.Account,
+        protocol: 'shadowsocks',
+        getCredentials: (acc) => ({
+            password: acc.password,
+            cipherType: acc.cipherType,
+            ivCheck: acc.ivCheck,
+        }),
+    },
+    [config_3.Account.$type]: {
+        decoder: config_3.Account,
+        protocol: 'shadowsocks2022',
+        getCredentials: (acc) => ({
+            key: acc.key,
+        }),
+    },
+    [config_4.Account.$type]: {
+        decoder: config_4.Account,
+        protocol: 'socks',
+        getCredentials: (acc) => ({
+            username: acc.username,
+            password: acc.password,
+        }),
+    },
+    [config_5.Account.$type]: {
+        decoder: config_5.Account,
+        protocol: 'http',
+        getCredentials: (acc) => ({
+            username: acc.username,
+            password: acc.password,
+        }),
+    },
+};

package/build/src/common/utils/decode-user/constants/index.d.ts

@@ -0,0 +1,2 @@
+export * from './account-types';
+//# sourceMappingURL=index.d.ts.map

package/build/src/common/utils/decode-user/constants/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/common/utils/decode-user/constants/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC"}

package/build/src/common/utils/decode-user/constants/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./account-types"), exports);

package/build/src/common/utils/decode-user/decode-user.d.ts

@@ -0,0 +1,37 @@
+import { User } from '../../../xray-protos/common/protocol/user';
+import { DecodedUser } from './types';
+/**
+ * Decodes a User object into a DecodedUser with credentials and metadata.
+ * The function extracts account credentials based on the account type and protocol.
+ *
+ * @param user - The User object to decode, containing account information including:
+ *   - email: User's email address used as username
+ *   - level: User's permission level
+ *   - account: Object containing account type and encoded credentials
+ * @returns DecodedUser object containing:
+ *   - Protocol-specific credentials decoded from the account value
+ *   - Protocol identifier
+ *   - Username (from email)
+ *   - Permission level
+ * @throws Error if user object is missing account information
+ * @throws Error if account type is not recognized
+ *
+ * @example
+ * const user = {
+ *   email: "user@example.com",
+ *   level: 1,
+ *   account: {
+ *     type: "standard",
+ *     value: Buffer.from("...") // Encoded credentials
+ *   }
+ * };
+ * const decoded = decodeUser(user);
+ * // Returns: {
+ * //   standard: { ... decoded credentials ... },
+ * //   protocol: "standard",
+ * //   username: "user@example.com",
+ * //   level: 1
+ * // }
+ */
+export declare const decodeUser: (user: User) => DecodedUser;
+//# sourceMappingURL=decode-user.d.ts.map

package/build/src/common/utils/decode-user/decode-user.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decode-user.d.ts","sourceRoot":"","sources":["../../../../../src/common/utils/decode-user/decode-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,2CAA2C,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,UAAU,SAAU,IAAI,KAAG,WAoBvC,CAAC"}

package/build/src/common/utils/decode-user/decode-user.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decodeUser = void 0;
+const constants_1 = require("./constants");
+/**
+ * Decodes a User object into a DecodedUser with credentials and metadata.
+ * The function extracts account credentials based on the account type and protocol.
+ *
+ * @param user - The User object to decode, containing account information including:
+ *   - email: User's email address used as username
+ *   - level: User's permission level
+ *   - account: Object containing account type and encoded credentials
+ * @returns DecodedUser object containing:
+ *   - Protocol-specific credentials decoded from the account value
+ *   - Protocol identifier
+ *   - Username (from email)
+ *   - Permission level
+ * @throws Error if user object is missing account information
+ * @throws Error if account type is not recognized
+ *
+ * @example
+ * const user = {
+ *   email: "user@example.com",
+ *   level: 1,
+ *   account: {
+ *     type: "standard",
+ *     value: Buffer.from("...") // Encoded credentials
+ *   }
+ * };
+ * const decoded = decodeUser(user);
+ * // Returns: {
+ * //   standard: { ... decoded credentials ... },
+ * //   protocol: "standard",
+ * //   username: "user@example.com",
+ * //   level: 1
+ * // }
+ */
+const decodeUser = (user) => {
+    if (!user?.account) {
+        throw new Error('Invalid user object: missing account');
+    }
+    const accountType = user.account.type;
+    const accountConfig = constants_1.ACCOUNT_TYPES[accountType];
+    if (!accountConfig) {
+        throw new Error(`Unknown account type: ${accountType}`);
+    }
+    const accountBuffer = Buffer.from(user.account.value);
+    const decodedAccount = accountConfig.decoder.decode(accountBuffer);
+    return {
+        [accountConfig.protocol]: accountConfig.getCredentials(decodedAccount),
+        protocol: accountConfig.protocol,
+        username: user.email,
+        level: user.level,
+    };
+};
+exports.decodeUser = decodeUser;

package/build/src/common/utils/decode-user/types/account-type-keys.type.d.ts

@@ -0,0 +1,3 @@
+import { ACCOUNT_TYPES } from '../constants';
+export type TAccountTypesKey = keyof typeof ACCOUNT_TYPES;
+//# sourceMappingURL=account-type-keys.type.d.ts.map

package/build/src/common/utils/decode-user/types/account-type-keys.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-type-keys.type.d.ts","sourceRoot":"","sources":["../../../../../../src/common/utils/decode-user/types/account-type-keys.type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C,MAAM,MAAM,gBAAgB,GAAG,MAAM,OAAO,aAAa,CAAC"}

package/build/src/common/utils/decode-user/types/account-type-keys.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/src/common/utils/decode-user/types/account-type-mapping.type.d.ts

@@ -0,0 +1,4 @@
+import { ACCOUNT_TYPES } from '../constants';
+import { TAccountTypesKey } from './account-type-keys.type';
+export type AccountTypeMapping = ReturnType<(typeof ACCOUNT_TYPES)[TAccountTypesKey]['getCredentials']>;
+//# sourceMappingURL=account-type-mapping.type.d.ts.map

package/build/src/common/utils/decode-user/types/account-type-mapping.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-type-mapping.type.d.ts","sourceRoot":"","sources":["../../../../../../src/common/utils/decode-user/types/account-type-mapping.type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAE5D,MAAM,MAAM,kBAAkB,GAAG,UAAU,CACvC,CAAC,OAAO,aAAa,CAAC,CAAC,gBAAgB,CAAC,CAAC,gBAAgB,CAAC,CAC7D,CAAC"}

package/build/src/common/utils/decode-user/types/account-type-mapping.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });