@remnawave/backend-contract 0.0.1 → 0.0.3

package/api/controllers/index.ts

@@ -5,5 +5,6 @@ export * from './inbounds';
 export * from './keygen';
 export * from './nodes';
 export * from './subscription';
+export * from './system';
 export * from './users';
 export * from './xray';

package/api/controllers/system.ts

@@ -0,0 +1,5 @@
+export const SYSTEM_CONTROLLER = 'system' as const;
+
+export const SYSTEM_ROUTES = {
+    STATS: 'stats',
+} as const;

package/api/routes.ts

@@ -70,4 +70,7 @@ export const REST_API = {
         DELETE: (uuid: string) =>
             `${ROOT}/${CONTROLLERS.HOSTS_CONTROLLER}/${CONTROLLERS.HOSTS_ROUTES.DELETE}/${uuid}`,
     },
+    SYSTEM: {
+        STATS: `${ROOT}/${CONTROLLERS.SYSTEM_CONTROLLER}/${CONTROLLERS.SYSTEM_ROUTES.STATS}`,
+    },
 } as const;

package/build/api/controllers/index.js

@@ -21,5 +21,6 @@ __exportStar(require("./inbounds"), exports);
 __exportStar(require("./keygen"), exports);
 __exportStar(require("./nodes"), exports);
 __exportStar(require("./subscription"), exports);
+__exportStar(require("./system"), exports);
 __exportStar(require("./users"), exports);
 __exportStar(require("./xray"), exports);

package/build/api/controllers/system.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SYSTEM_ROUTES = exports.SYSTEM_CONTROLLER = void 0;
+exports.SYSTEM_CONTROLLER = 'system';
+exports.SYSTEM_ROUTES = {
+    STATS: 'stats',
+};

package/build/api/routes.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.REST_API = exports.ROOT = void 0;
 const CONTROLLERS = __importStar(require("./controllers"));
@@ -78,4 +88,7 @@ exports.REST_API = {
         UPDATE_MANY: `${exports.ROOT}/${CONTROLLERS.HOSTS_CONTROLLER}/${CONTROLLERS.HOSTS_ROUTES.UPDATE_MANY}`,
         DELETE: (uuid) => `${exports.ROOT}/${CONTROLLERS.HOSTS_CONTROLLER}/${CONTROLLERS.HOSTS_ROUTES.DELETE}/${uuid}`,
     },
+    SYSTEM: {
+        STATS: `${exports.ROOT}/${CONTROLLERS.SYSTEM_CONTROLLER}/${CONTROLLERS.SYSTEM_ROUTES.STATS}`,
+    },
 };

package/build/commands/index.js

@@ -21,5 +21,6 @@ __exportStar(require("./inbounds"), exports);
 __exportStar(require("./keygen"), exports);
 __exportStar(require("./nodes"), exports);
 __exportStar(require("./subscription"), exports);
+__exportStar(require("./system"), exports);
 __exportStar(require("./users"), exports);
 __exportStar(require("./xray"), exports);

package/build/commands/system/get-stats.command.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetStatsCommand = void 0;
+const zod_1 = require("zod");
+const api_1 = require("../../api");
+const constants_1 = require("../../constants");
+var GetStatsCommand;
+(function (GetStatsCommand) {
+    GetStatsCommand.url = api_1.REST_API.SYSTEM.STATS;
+    GetStatsCommand.ResponseSchema = zod_1.z.object({
+        response: zod_1.z.object({
+            cpu: zod_1.z.object({
+                cores: zod_1.z.number(),
+                physicalCores: zod_1.z.number(),
+            }),
+            memory: zod_1.z.object({
+                total: zod_1.z.number(),
+                free: zod_1.z.number(),
+                used: zod_1.z.number(),
+                active: zod_1.z.number(),
+                available: zod_1.z.number(),
+            }),
+            uptime: zod_1.z.number(),
+            timestamp: zod_1.z.number(),
+            users: zod_1.z.object({
+                onlineLastMinute: zod_1.z.number(),
+                statusCounts: zod_1.z.record(zod_1.z.enum(Object.values(constants_1.USERS_STATUS)), zod_1.z.number()),
+                totalUsers: zod_1.z.number(),
+                totalTrafficBytes: zod_1.z.string(),
+            }),
+        }),
+    });
+})(GetStatsCommand || (exports.GetStatsCommand = GetStatsCommand = {}));

package/build/commands/system/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("./get-stats.command"), exports);

package/build/commands/users/get-all-users.command.js

@@ -7,6 +7,16 @@ const users_schema_1 = require("../../models/users.schema");
 var GetAllUsersCommand;
 (function (GetAllUsersCommand) {
     GetAllUsersCommand.url = api_1.REST_API.USERS.GET_ALL;
+    GetAllUsersCommand.SortableFields = [
+        'username',
+        'status',
+        'expireAt',
+        'createdAt',
+        'onlineAt',
+        'usedTrafficBytes',
+        'trafficLimitBytes',
+    ];
+    GetAllUsersCommand.SearchableFields = ['username', 'shortUuid', 'subscriptionUuid', 'uuid'];
     GetAllUsersCommand.RequestQuerySchema = zod_1.z.object({
         limit: zod_1.z
             .string()
@@ -16,8 +26,15 @@ var GetAllUsersCommand;
             .string()
             .default('0')
             .transform((val) => parseInt(val)),
+        orderBy: zod_1.z.enum(GetAllUsersCommand.SortableFields).default('createdAt'),
+        orderDir: zod_1.z.enum(['asc', 'desc']).default('desc'),
+        search: zod_1.z.string().optional(),
+        searchBy: zod_1.z.enum(GetAllUsersCommand.SearchableFields).default('username'),
     });
     GetAllUsersCommand.ResponseSchema = zod_1.z.object({
-        response: zod_1.z.array(users_schema_1.UsersSchema),
+        response: zod_1.z.object({
+            users: zod_1.z.array(users_schema_1.UsersSchema),
+            total: zod_1.z.number(),
+        }),
     });
 })(GetAllUsersCommand || (exports.GetAllUsersCommand = GetAllUsersCommand = {}));

package/build/constants/errors/errors.js

@@ -233,4 +233,9 @@ exports.ERRORS = {
         message: 'Delete host error',
         httpCode: 500,
     },
+    GET_USER_STATS_ERROR: {
+        code: 'A048',
+        message: 'Get user stats error',
+        httpCode: 500,
+    },
 };

package/commands/index.ts

@@ -5,5 +5,6 @@ export * from './inbounds';
 export * from './keygen';
 export * from './nodes';
 export * from './subscription';
+export * from './system';
 export * from './users';
 export * from './xray';

package/commands/system/get-stats.command.ts

@@ -0,0 +1,36 @@
+import { z } from 'zod';
+import { REST_API } from '../../api';
+import { USERS_STATUS } from '../../constants';
+
+export namespace GetStatsCommand {
+    export const url = REST_API.SYSTEM.STATS;
+
+    export const ResponseSchema = z.object({
+        response: z.object({
+            cpu: z.object({
+                cores: z.number(),
+                physicalCores: z.number(),
+            }),
+            memory: z.object({
+                total: z.number(),
+                free: z.number(),
+                used: z.number(),
+                active: z.number(),
+                available: z.number(),
+            }),
+            uptime: z.number(),
+            timestamp: z.number(),
+            users: z.object({
+                onlineLastMinute: z.number(),
+                statusCounts: z.record(
+                    z.enum(Object.values(USERS_STATUS) as [string, ...string[]]),
+                    z.number(),
+                ),
+                totalUsers: z.number(),
+                totalTrafficBytes: z.string(),
+            }),
+        }),
+    });
+
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/commands/system/index.ts

@@ -0,0 +1 @@
+export * from './get-stats.command';

package/commands/users/get-all-users.command.ts

@@ -5,6 +5,21 @@ import { UsersSchema } from '../../models/users.schema';
 export namespace GetAllUsersCommand {
     export const url = REST_API.USERS.GET_ALL;
 
+    export const SortableFields = [
+        'username',
+        'status',
+        'expireAt',
+        'createdAt',
+        'onlineAt',
+        'usedTrafficBytes',
+        'trafficLimitBytes',
+    ] as const;
+
+    export const SearchableFields = ['username', 'shortUuid', 'subscriptionUuid', 'uuid'] as const;
+
+    export type SortableField = (typeof SortableFields)[number];
+    export type SearchableField = (typeof SearchableFields)[number];
+
     export const RequestQuerySchema = z.object({
         limit: z
             .string()
@@ -14,12 +29,21 @@ export namespace GetAllUsersCommand {
             .string()
             .default('0')
             .transform((val) => parseInt(val)),
+        orderBy: z.enum(SortableFields).default('createdAt'),
+        orderDir: z.enum(['asc', 'desc']).default('desc'),
+        search: z.string().optional(),
+        searchBy: z.enum(SearchableFields).default('username'),
     });
 
+    // !TODO: add searchBy validation
+
     export type RequestQuery = z.infer<typeof RequestQuerySchema>;
 
     export const ResponseSchema = z.object({
-        response: z.array(UsersSchema),
+        response: z.object({
+            users: z.array(UsersSchema),
+            total: z.number(),
+        }),
     });
 
     export type Response = z.infer<typeof ResponseSchema>;

package/constants/errors/errors.ts

@@ -230,4 +230,9 @@ export const ERRORS = {
         message: 'Delete host error',
         httpCode: 500,
     },
+    GET_USER_STATS_ERROR: {
+        code: 'A048',
+        message: 'Get user stats error',
+        httpCode: 500,
+    },
 } as const;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remnawave/backend-contract",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "A contract library for Remnawave",
   "main": "index.js",
   "scripts": {