@remnawave/backend-contract 0.0.2 → 0.0.3

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"));

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/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/package.json

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