@remnawave/backend-contract 0.0.4 → 0.0.6

package/api/controllers/users.ts

@@ -10,4 +10,5 @@ export const USERS_ROUTES = {
     DISABLE_USER: '/disable/:uuid',
     ENABLE_USER: '/enable/:uuid',
     DELETE_USER: '/delete/:uuid',
+    UPDATE: '/update',
 } as const;

package/api/routes.ts

@@ -55,6 +55,7 @@ export const REST_API = {
             `${ROOT}/${CONTROLLERS.USERS_CONTROLLER}/${CONTROLLERS.USERS_ROUTES.ENABLE_USER}/${uuid}`,
         DELETE_USER: (uuid: string) =>
             `${ROOT}/${CONTROLLERS.USERS_CONTROLLER}/${CONTROLLERS.USERS_ROUTES.DELETE_USER}/${uuid}`,
+        UPDATE: `${ROOT}/${CONTROLLERS.USERS_CONTROLLER}/${CONTROLLERS.USERS_ROUTES.UPDATE}`,
     },
     SUBSCRIPTION: {
         GET: (shortUuid: string) =>

package/build/api/controllers/users.js

@@ -12,4 +12,5 @@ exports.USERS_ROUTES = {
     DISABLE_USER: '/disable/:uuid',
     ENABLE_USER: '/enable/:uuid',
     DELETE_USER: '/delete/:uuid',
+    UPDATE: '/update',
 };

package/build/api/routes.js

@@ -76,6 +76,7 @@ exports.REST_API = {
         DISABLE_USER: (uuid) => `${exports.ROOT}/${CONTROLLERS.USERS_CONTROLLER}/${CONTROLLERS.USERS_ROUTES.DISABLE_USER}/${uuid}`,
         ENABLE_USER: (uuid) => `${exports.ROOT}/${CONTROLLERS.USERS_CONTROLLER}/${CONTROLLERS.USERS_ROUTES.ENABLE_USER}/${uuid}`,
         DELETE_USER: (uuid) => `${exports.ROOT}/${CONTROLLERS.USERS_CONTROLLER}/${CONTROLLERS.USERS_ROUTES.DELETE_USER}/${uuid}`,
+        UPDATE: `${exports.ROOT}/${CONTROLLERS.USERS_CONTROLLER}/${CONTROLLERS.USERS_ROUTES.UPDATE}`,
     },
     SUBSCRIPTION: {
         GET: (shortUuid) => `${exports.ROOT}/${CONTROLLERS.SUBSCRIPTION_CONTROLLER}/${CONTROLLERS.SUBSCRIPTION_ROUTES.GET}/${shortUuid}`,

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

@@ -39,7 +39,9 @@ var GetAllUsersCommand;
     });
     GetAllUsersCommand.ResponseSchema = zod_1.z.object({
         response: zod_1.z.object({
-            users: zod_1.z.array(users_schema_1.UsersSchema),
+            users: zod_1.z.array(users_schema_1.UsersSchema.extend({
+                totalUsedBytes: zod_1.z.string(),
+            })),
             total: zod_1.z.number(),
         }),
     });

package/build/commands/users/index.js

@@ -23,3 +23,4 @@ __exportStar(require("./get-user-by-short-uuid.command"), exports);
 __exportStar(require("./get-user-by-subscription-uuid.command"), exports);
 __exportStar(require("./get-user-by-uuid.command"), exports);
 __exportStar(require("./revoke-user-subscription.command"), exports);
+__exportStar(require("./update-user.command"), exports);

package/build/commands/users/update-user.command.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateUserCommand = void 0;
+const zod_1 = require("zod");
+const api_1 = require("../../api");
+const constants_1 = require("../../constants");
+const models_1 = require("../../models");
+var UpdateUserCommand;
+(function (UpdateUserCommand) {
+    UpdateUserCommand.url = api_1.REST_API.USERS.UPDATE;
+    UpdateUserCommand.RequestSchema = models_1.UsersSchema.pick({
+        uuid: true,
+    }).extend({
+        status: models_1.UsersSchema.shape.status.optional(),
+        trafficLimitBytes: zod_1.z
+            .number({
+            invalid_type_error: 'Traffic limit must be a number',
+        })
+            .int('Traffic limit must be an integer')
+            .min(0, 'Traffic limit must be greater than 0')
+            .describe('Traffic limit in bytes. 0 - unlimited')
+            .optional(),
+        trafficLimitStrategy: models_1.UsersSchema.shape.trafficLimitStrategy
+            .describe('Traffic limit reset strategy')
+            .optional()
+            .default(constants_1.RESET_PERIODS.NO_RESET)
+            .superRefine((val, ctx) => {
+            if (val && !Object.values(constants_1.RESET_PERIODS).includes(val)) {
+                ctx.addIssue({
+                    code: zod_1.z.ZodIssueCode.invalid_enum_value,
+                    message: 'Invalid traffic limit strategy',
+                    path: ['trafficLimitStrategy'],
+                    received: val,
+                    options: Object.values(constants_1.RESET_PERIODS),
+                });
+            }
+        }),
+        enabledInbounds: zod_1.z
+            .array(models_1.InboundsSchema.pick({
+            uuid: true,
+        }), {
+            invalid_type_error: 'Enabled inbounds must be an array',
+        })
+            .optional(),
+        expireAt: zod_1.z.coerce
+            .date({
+            required_error: 'Expiration date is required',
+            invalid_type_error: 'Invalid expiration date format',
+        })
+            .refine((date) => date > new Date(), {
+            message: 'Expiration date cannot be in the past',
+        })
+            .optional(),
+    });
+    UpdateUserCommand.ResponseSchema = zod_1.z.object({
+        response: models_1.UsersSchema,
+    });
+})(UpdateUserCommand || (exports.UpdateUserCommand = UpdateUserCommand = {}));

package/build/constants/errors/errors.js

@@ -238,4 +238,9 @@ exports.ERRORS = {
         message: 'Get user stats error',
         httpCode: 500,
     },
+    UPDATE_USER_WITH_INBOUNDS_ERROR: {
+        code: 'A049',
+        message: 'Update user with inbounds error',
+        httpCode: 500,
+    },
 };

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

@@ -47,7 +47,12 @@ export namespace GetAllUsersCommand {
 
     export const ResponseSchema = z.object({
         response: z.object({
-            users: z.array(UsersSchema),
+            users: z.array(
+                UsersSchema.extend({
+                    totalUsedBytes: z.string(),
+                }),
+            ),
+
             total: z.number(),
         }),
     });

package/commands/users/index.ts

@@ -7,3 +7,4 @@ export * from './get-user-by-short-uuid.command';
 export * from './get-user-by-subscription-uuid.command';
 export * from './get-user-by-uuid.command';
 export * from './revoke-user-subscription.command';
+export * from './update-user.command';

package/commands/users/update-user.command.ts

@@ -0,0 +1,64 @@
+import { z } from 'zod';
+import { REST_API } from '../../api';
+import { RESET_PERIODS } from '../../constants';
+import { InboundsSchema, UsersSchema } from '../../models';
+
+export namespace UpdateUserCommand {
+    export const url = REST_API.USERS.UPDATE;
+
+    export const RequestSchema = UsersSchema.pick({
+        uuid: true,
+    }).extend({
+        status: UsersSchema.shape.status.optional(),
+        trafficLimitBytes: z
+            .number({
+                invalid_type_error: 'Traffic limit must be a number',
+            })
+            .int('Traffic limit must be an integer')
+            .min(0, 'Traffic limit must be greater than 0')
+            .describe('Traffic limit in bytes. 0 - unlimited')
+            .optional(),
+        trafficLimitStrategy: UsersSchema.shape.trafficLimitStrategy
+            .describe('Traffic limit reset strategy')
+            .optional()
+            .default(RESET_PERIODS.NO_RESET)
+            .superRefine((val, ctx) => {
+                if (val && !Object.values(RESET_PERIODS).includes(val)) {
+                    ctx.addIssue({
+                        code: z.ZodIssueCode.invalid_enum_value,
+                        message: 'Invalid traffic limit strategy',
+                        path: ['trafficLimitStrategy'],
+                        received: val,
+                        options: Object.values(RESET_PERIODS),
+                    });
+                }
+            }),
+        enabledInbounds: z
+            .array(
+                InboundsSchema.pick({
+                    uuid: true,
+                }),
+                {
+                    invalid_type_error: 'Enabled inbounds must be an array',
+                },
+            )
+            .optional(),
+        expireAt: z.coerce
+            .date({
+                required_error: 'Expiration date is required',
+                invalid_type_error: 'Invalid expiration date format',
+            })
+            .refine((date) => date > new Date(), {
+                message: 'Expiration date cannot be in the past',
+            })
+            .optional(),
+    });
+
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = z.object({
+        response: UsersSchema,
+    });
+
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/constants/errors/errors.ts

@@ -235,4 +235,9 @@ export const ERRORS = {
         message: 'Get user stats error',
         httpCode: 500,
     },
+    UPDATE_USER_WITH_INBOUNDS_ERROR: {
+        code: 'A049',
+        message: 'Update user with inbounds error',
+        httpCode: 500,
+    },
 } as const;

package/package.json

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