@remnawave/backend-contract 0.0.1

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

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+import { REST_API } from '../../api';
+export namespace DeleteUserCommand {
+    export const url = REST_API.USERS.DELETE_USER;
+
+    export const RequestSchema = z.object({
+        uuid: z.string().uuid(),
+    });
+
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = z.object({
+        response: z.object({
+            isDeleted: z.boolean(),
+        }),
+    });
+
+    export type Response = z.infer<typeof ResponseSchema>;
+}

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

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+import { REST_API } from '../../api';
+import { UsersSchema } from '../../models/users.schema';
+export namespace DisableUserCommand {
+    export const url = REST_API.USERS.DISABLE_USER;
+
+    export const RequestSchema = z.object({
+        uuid: z.string().uuid(),
+    });
+
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = z.object({
+        response: UsersSchema,
+    });
+
+    export type Response = z.infer<typeof ResponseSchema>;
+}

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

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+import { REST_API } from '../../api';
+import { UsersSchema } from '../../models/users.schema';
+
+export namespace EnableUserCommand {
+    export const url = REST_API.USERS.ENABLE_USER;
+
+    export const RequestSchema = z.object({
+        uuid: z.string().uuid(),
+    });
+
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = z.object({
+        response: UsersSchema,
+    });
+
+    export type Response = z.infer<typeof ResponseSchema>;
+}

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

@@ -0,0 +1,26 @@
+import { z } from 'zod';
+import { REST_API } from '../../api';
+import { UsersSchema } from '../../models/users.schema';
+
+export namespace GetAllUsersCommand {
+    export const url = REST_API.USERS.GET_ALL;
+
+    export const RequestQuerySchema = z.object({
+        limit: z
+            .string()
+            .default('10')
+            .transform((val) => parseInt(val)),
+        offset: z
+            .string()
+            .default('0')
+            .transform((val) => parseInt(val)),
+    });
+
+    export type RequestQuery = z.infer<typeof RequestQuerySchema>;
+
+    export const ResponseSchema = z.object({
+        response: z.array(UsersSchema),
+    });
+
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/commands/users/get-user-by-short-uuid.command.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+import { REST_API } from '../../api';
+import { UsersSchema } from '../../models/users.schema';
+
+export namespace GetUserByShortUuidCommand {
+    export const url = REST_API.USERS.GET_BY_SHORT_UUID;
+
+    export const RequestSchema = z.object({
+        shortUuid: z.string(),
+    });
+
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = z.object({
+        response: UsersSchema,
+    });
+
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/commands/users/get-user-by-subscription-uuid.command.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+import { REST_API } from '../../api';
+import { UsersSchema } from '../../models/users.schema';
+
+export namespace GetUserBySubscriptionUuidCommand {
+    export const url = REST_API.USERS.GET_BY_SUBSCRIPTION_UUID;
+
+    export const RequestSchema = z.object({
+        subscriptionUuid: z.string(),
+    });
+
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = z.object({
+        response: UsersSchema,
+    });
+
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/commands/users/get-user-by-uuid.command.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+import { REST_API } from '../../api';
+import { UsersSchema } from '../../models/users.schema';
+
+export namespace GetUserByUuidCommand {
+    export const url = REST_API.USERS.GET_BY_UUID;
+
+    export const RequestSchema = z.object({
+        uuid: z.string().uuid(),
+    });
+
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = z.object({
+        response: UsersSchema,
+    });
+
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/commands/users/index.ts

@@ -0,0 +1,9 @@
+export * from './create-user.command';
+export * from './delete-user.command';
+export * from './disable-user.command.ts';
+export * from './enable-user.command';
+export * from './get-all-users.command';
+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';

package/commands/users/revoke-user-subscription.command.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+import { REST_API } from '../../api';
+import { UsersSchema } from '../../models/users.schema';
+
+export namespace RevokeUserSubscriptionCommand {
+    export const url = REST_API.USERS.REVOKE_SUBSCRIPTION;
+
+    export const RequestSchema = z.object({
+        uuid: z.string().uuid(),
+    });
+
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = z.object({
+        response: UsersSchema,
+    });
+
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/commands/xray/get-config.command.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+import { REST_API } from '../../api';
+export namespace GetXrayConfigCommand {
+    export const url = REST_API.XRAY.GET_CONFIG;
+    export const ResponseSchema = z.object({
+        response: z.object({
+            config: z.record(z.any()),
+        }),
+    });
+
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/commands/xray/index.ts

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

package/constants/errors/errors.ts

@@ -0,0 +1,233 @@
+export const ERRORS = {
+    INTERNAL_SERVER_ERROR: { code: 'A001', message: 'Server error', httpCode: 500 },
+    LOGIN_ERROR: { code: 'A002', message: 'Login error', httpCode: 500 },
+    UNAUTHORIZED: { code: 'A003', message: 'Unauthorized', httpCode: 401 },
+    FORBIDDEN_ROLE_ERROR: { code: 'A004', message: 'Forbidden role error', httpCode: 403 },
+    CREATE_API_TOKEN_ERROR: { code: 'A005', message: 'Create API token error', httpCode: 500 },
+    DELETE_API_TOKEN_ERROR: { code: 'A006', message: 'Delete API token error', httpCode: 500 },
+    REQUESTED_TOKEN_NOT_FOUND: {
+        code: 'A007',
+        message: 'Requested token not found',
+        httpCode: 404,
+    },
+    FIND_ALL_API_TOKENS_ERROR: {
+        code: 'A008',
+        message: 'Find all API tokens error',
+        httpCode: 500,
+    },
+    GET_PUBLIC_KEY_ERROR: {
+        code: 'A009',
+        message: 'Get public key error',
+        httpCode: 500,
+    },
+    ENABLE_NODE_ERROR: {
+        code: 'A010',
+        message: 'Enable node error',
+        httpCode: 500,
+    },
+    NODE_NOT_FOUND: {
+        code: 'A011',
+        message: 'Node not found',
+        httpCode: 404,
+    },
+    CONFIG_NOT_FOUND: {
+        code: 'A012',
+        message: 'Configuration not found',
+        httpCode: 404,
+    },
+    UPDATE_CONFIG_ERROR: {
+        code: 'A013',
+        message: 'Error updating configuration',
+        httpCode: 500,
+    },
+    GET_CONFIG_ERROR: {
+        code: 'A014',
+        message: 'Error retrieving configuration',
+        httpCode: 500,
+    },
+    DELETE_MANY_INBOUNDS_ERROR: {
+        code: 'A015',
+        message: 'Delete many inbounds error',
+        httpCode: 500,
+    },
+    CREATE_MANY_INBOUNDS_ERROR: {
+        code: 'A016',
+        message: 'Create many inbounds error',
+        httpCode: 500,
+    },
+    FIND_ALL_INBOUNDS_ERROR: {
+        code: 'A017',
+        message: 'Find all inbounds error',
+        httpCode: 500,
+    },
+    CREATE_USER_ERROR: {
+        code: 'A018',
+        message: 'Failed to create user',
+        httpCode: 500,
+    },
+    USER_USERNAME_ALREADY_EXISTS: {
+        code: 'A019',
+        message: 'User username already exists',
+        httpCode: 400,
+    },
+    USER_SHORT_UUID_ALREADY_EXISTS: {
+        code: 'A020',
+        message: 'User short UUID already exists',
+        httpCode: 400,
+    },
+    USER_SUBSCRIPTION_UUID_ALREADY_EXISTS: {
+        code: 'A021',
+        message: 'User subscription UUID already exists',
+        httpCode: 400,
+    },
+    CREATE_USER_WITH_INBOUNDS_ERROR: {
+        code: 'A022',
+        message: 'User creation successful, but inbound creation failed. User not created.',
+        httpCode: 500,
+    },
+    CANT_GET_CREATED_USER_WITH_INBOUNDS: {
+        code: 'A023',
+        message: 'User creation successful, but failed to get created user with inbounds.',
+        httpCode: 500,
+    },
+    GET_ALL_USERS_ERROR: {
+        code: 'A024',
+        message: 'Get all users error',
+        httpCode: 500,
+    },
+    USER_NOT_FOUND: {
+        code: 'A025',
+        message: 'User not found',
+        httpCode: 404,
+    },
+    GET_USER_BY_ERROR: {
+        code: 'A026',
+        message: 'Get user by error',
+        httpCode: 500,
+    },
+    REVOKE_USER_SUBSCRIPTION_ERROR: {
+        code: 'A027',
+        message: 'Revoke user subscription error',
+        httpCode: 500,
+    },
+    DISABLE_USER_ERROR: {
+        code: 'A028',
+        message: 'Disable user error',
+        httpCode: 500,
+    },
+    USER_ALREADY_DISABLED: {
+        code: 'A029',
+        message: 'User already disabled',
+        httpCode: 400,
+    },
+    USER_ALREADY_ENABLED: {
+        code: 'A030',
+        message: 'User already enabled',
+        httpCode: 400,
+    },
+    ENABLE_USER_ERROR: {
+        code: 'A031',
+        message: 'Enable user error',
+        httpCode: 500,
+    },
+    CREATE_NODE_ERROR: {
+        code: 'A032',
+        message: 'Create node error',
+        httpCode: 500,
+    },
+    NODE_NAME_ALREADY_EXISTS: {
+        code: 'A033',
+        message: 'Node name already exists',
+        httpCode: 400,
+    },
+    NODE_ADDRESS_ALREADY_EXISTS: {
+        code: 'A034',
+        message: 'Node address already exists',
+        httpCode: 400,
+    },
+    NODE_ERROR_WITH_MSG: {
+        code: 'N001',
+        message: '',
+        httpCode: 500,
+        withMessage: (message: string) => ({
+            code: 'N001',
+            message,
+            httpCode: 500,
+        }),
+    },
+    NODE_ERROR_500_WITH_MSG: {
+        code: 'N002',
+        message: '',
+        httpCode: 500,
+        withMessage: (message: string) => ({
+            code: 'N002',
+            message,
+            httpCode: 500,
+        }),
+    },
+    RESTART_NODE_ERROR: {
+        code: 'A035',
+        message: 'Restart node error',
+        httpCode: 500,
+    },
+    GET_CONFIG_WITH_USERS_ERROR: {
+        code: 'A036',
+        message: 'Get config with users error',
+        httpCode: 500,
+    },
+    DELETE_USER_ERROR: {
+        code: 'A037',
+        message: 'Delete user error',
+        httpCode: 500,
+    },
+    UPDATE_NODE_ERROR: {
+        code: 'A038',
+        message: 'Update node error',
+        httpCode: 500,
+    },
+    UPDATE_USER_ERROR: {
+        code: 'A039',
+        message: 'Update user error',
+        httpCode: 500,
+    },
+    INCREMENT_USED_TRAFFIC_ERROR: {
+        code: 'A040',
+        message: 'Increment used traffic error',
+        httpCode: 500,
+    },
+    GET_ALL_NODES_ERROR: {
+        code: 'A041',
+        message: 'Get all nodes error',
+        httpCode: 500,
+    },
+    GET_ONE_NODE_ERROR: {
+        code: 'A042',
+        message: 'Get one node error',
+        httpCode: 500,
+    },
+    DELETE_NODE_ERROR: {
+        code: 'A043',
+        message: 'Delete node error',
+        httpCode: 500,
+    },
+    CREATE_HOST_ERROR: {
+        code: 'A044',
+        message: 'Create host error',
+        httpCode: 500,
+    },
+    HOST_REMARK_ALREADY_EXISTS: {
+        code: 'A045',
+        message: 'Host remark already exists',
+        httpCode: 400,
+    },
+    HOST_NOT_FOUND: {
+        code: 'A046',
+        message: 'Host not found',
+        httpCode: 404,
+    },
+    DELETE_HOST_ERROR: {
+        code: 'A047',
+        message: 'Delete host error',
+        httpCode: 500,
+    },
+} as const;

package/constants/errors/index.ts

@@ -0,0 +1 @@
+export * from './errors';

package/constants/hosts/alpn.ts

@@ -0,0 +1,8 @@
+export const ALPN = {
+    HTTP_1_1: 'http/1.1',
+    H2: 'h2',
+    H_COMBINED: 'h2,http/1.1',
+} as const;
+
+export type TAlpn = [keyof typeof ALPN][number];
+export const ALPN_VALUES = Object.values(ALPN);

package/constants/hosts/fingerprints.ts

@@ -0,0 +1,14 @@
+export const FINGERPRINTS = {
+    CHROME: 'chrome',
+    FIREFOX: 'firefox',
+    SAFARI: 'safari',
+    IOS: 'ios',
+    ANDROID: 'android',
+    EDGE: 'edge',
+    QQ: 'qq',
+    RANDOM: 'random',
+    RANDOMIZED: 'randomized',
+} as const;
+
+export type TFingerprints = [keyof typeof FINGERPRINTS][number];
+export const FINGERPRINTS_VALUES = Object.values(FINGERPRINTS);

package/constants/hosts/index.ts

@@ -0,0 +1,2 @@
+export * from './alpn';
+export * from './fingerprints';

package/constants/index.ts

@@ -0,0 +1,6 @@
+export * from './errors';
+export * from './hosts';
+export * from './nodes';
+export * from './roles';
+export * from './templates';
+export * from './users';

package/constants/nodes/cycle/cycle.ts

@@ -0,0 +1,7 @@
+export const NODES_CYCLE = {
+    MONTH: 'MONTH',
+    YEAR: 'YEAR',
+} as const;
+
+export type TNodesCycle = [keyof typeof NODES_CYCLE][number];
+export const NODES_CYCLE_VALUES = Object.values(NODES_CYCLE);

package/constants/nodes/cycle/index.ts

@@ -0,0 +1 @@
+export * from './cycle';

package/constants/nodes/index.ts

@@ -0,0 +1,2 @@
+export * from './status';
+export * from './cycle';

package/constants/nodes/status/index.ts

@@ -0,0 +1 @@
+export * from './status.constant';

package/constants/nodes/status/status.constant.ts

@@ -0,0 +1,8 @@
+export const NODES_STATUS = {
+    CONNECTED: 'CONNECTED',
+    DISCONNECTED: 'DISCONNECTED',
+    DISABLED: 'DISABLED',
+} as const;
+
+export type TNodesStatus = [keyof typeof NODES_STATUS][number];
+export const NODES_STATUS_VALUES = Object.values(NODES_STATUS);

package/constants/roles/index.ts

@@ -0,0 +1 @@
+export * from './role';

package/constants/roles/role.ts

@@ -0,0 +1,7 @@
+export const ROLE = {
+    ADMIN: 'ADMIN',
+    API: 'API',
+} as const;
+
+export type TRole = typeof ROLE;
+export type TRolesKeys = (typeof ROLE)[keyof typeof ROLE];

package/constants/templates/index.ts

@@ -0,0 +1,2 @@
+export * from './template-keys';
+export * from './user-statuses';

package/constants/templates/template-keys.ts

@@ -0,0 +1,2 @@
+export const TEMPLATE_KEYS = ['DAYS_LEFT', 'TRAFFIC_USED', 'TRAFFIC_LEFT', 'STATUS'] as const;
+export type TemplateKeys = (typeof TEMPLATE_KEYS)[number];

package/constants/templates/user-statuses.ts

@@ -0,0 +1,6 @@
+export const USER_STATUSES_TEMPLATE = {
+    ACTIVE: ' ✅ Active',
+    EXPIRED: ' ⚠️ Expired',
+    DISABLED: '❌ Disabled',
+    LIMITED: '🔴 Limited',
+} as const;

package/constants/users/index.ts

@@ -0,0 +1,2 @@
+export * from './reset-periods';
+export * from './status';

package/constants/users/reset-periods/index.ts

@@ -0,0 +1 @@
+export * from './reset-periods.constant';

package/constants/users/reset-periods/reset-periods.constant.ts

@@ -0,0 +1,10 @@
+export const RESET_PERIODS = {
+    NO_RESET: 'NO_RESET',
+    DAY: 'DAY',
+    WEEK: 'WEEK',
+    MONTH: 'MONTH',
+    YEAR: 'YEAR',
+} as const;
+
+export type TResetPeriods = [keyof typeof RESET_PERIODS][number];
+export const RESET_PERIODS_VALUES = Object.values(RESET_PERIODS);

package/constants/users/status/index.ts

@@ -0,0 +1 @@
+export * from './status.constant';

package/constants/users/status/status.constant.ts

@@ -0,0 +1,9 @@
+export const USERS_STATUS = {
+    ACTIVE: 'ACTIVE',
+    DISABLED: 'DISABLED',
+    LIMITED: 'LIMITED',
+    EXPIRED: 'EXPIRED',
+} as const;
+
+export type TUsersStatus = [keyof typeof USERS_STATUS][number];
+export const USERS_STATUS_VALUES = Object.values(USERS_STATUS);

package/index.ts

@@ -0,0 +1,4 @@
+export * from './api';
+export * from './commands';
+export * from './constants';
+export * from './models';

package/models/api-tokens.schema.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+
+export const ApiTokensSchema = z.object({
+    uuid: z.string().uuid(),
+    token: z.string(),
+    tokenName: z.string(),
+    tokenDescription: z.nullable(z.string()),
+
+    createdAt: z.date(),
+    updatedAt: z.date(),
+});

package/models/auth.schema.ts

@@ -0,0 +1,5 @@
+import { z } from 'zod';
+
+export const AuthSchema = z.object({
+    hash: z.string(),
+});

package/models/hosts.schema.ts

@@ -0,0 +1,17 @@
+import { z } from 'zod';
+
+export const HostsSchema = z.object({
+    uuid: z.string().uuid(),
+    inboundUuid: z.string().uuid(),
+    viewPosition: z.number().int(),
+    remark: z.string(),
+    address: z.string(),
+    port: z.number().int(),
+    path: z.string().nullable(),
+    sni: z.string().nullable(),
+    host: z.string().nullable(),
+    alpn: z.string().nullable(),
+    fingerprint: z.string().nullable(),
+    allowInsecure: z.boolean().default(false),
+    isDisabled: z.boolean().default(false),
+});

package/models/inbounds.schema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+
+export const InboundsSchema = z.object({
+    uuid: z.string().uuid(),
+    tag: z.string(),
+    type: z.string(),
+});

package/models/index.ts

@@ -0,0 +1,6 @@
+export * from './api-tokens.schema';
+export * from './auth.schema';
+export * from './hosts.schema';
+export * from './inbounds.schema';
+export * from './nodes.schema';
+export * from './users.schema';

package/models/nodes.schema.ts

@@ -0,0 +1,28 @@
+import { z } from 'zod';
+
+export const NodesSchema = z.object({
+    uuid: z.string().uuid(),
+    name: z.string(),
+    address: z.string(),
+    port: z.number().int().nullable(),
+    isConnected: z.boolean().default(false),
+    isDisabled: z.boolean().default(false),
+    isConnecting: z.boolean().default(false),
+    isNodeOnline: z.boolean().default(false),
+    isXrayRunning: z.boolean().default(false),
+    lastStatusChange: z.date().nullable(),
+    lastStatusMessage: z.string().nullable(),
+    xrayVersion: z.string().nullable(),
+    isTrafficTrackingActive: z.boolean().default(false),
+    trafficResetDay: z.number().int().nullable(),
+    trafficLimitBytes: z.number().nullable(),
+    trafficUsedBytes: z.number().nullable(),
+    notifyPercent: z.number().int().nullable(),
+
+    cpuCount: z.number().int().nullable(),
+    cpuModel: z.string().nullable(),
+    totalRam: z.string().nullable(),
+
+    createdAt: z.date(),
+    updatedAt: z.date(),
+});