feat: add hostOverrides to external squad schemas and services

kastov · kastov · commit 3a240d6f101b · 2025-10-29T07:58:07.000+03:00
diff --git a/libs/contract/commands/external-squads/update-external-squad.command.ts b/libs/contract/commands/external-squads/update-external-squad.command.ts
@@ -1,6 +1,10 @@
 import { z } from 'zod';
 
-import { ExternalSquadSchema, ExternalSquadSubscriptionSettingsSchema } from '../../models';
+import {
+    ExternalSquadHostOverridesSchema,
+    ExternalSquadSchema,
+    ExternalSquadSubscriptionSettingsSchema,
+} from '../../models';
 import { getEndpointDetails, SUBSCRIPTION_TEMPLATE_TYPE } from '../../constants';
 import { EXTERNAL_SQUADS_ROUTES, REST_API } from '../../api';
 
@@ -34,6 +38,7 @@ export namespace UpdateExternalSquadCommand {
             )
             .optional(),
         subscriptionSettings: ExternalSquadSubscriptionSettingsSchema.optional(),
+        hostOverrides: ExternalSquadHostOverridesSchema.optional(),
     });
 
     export type Request = z.infer<typeof RequestSchema>;
diff --git a/libs/contract/models/external-squad.schema.ts b/libs/contract/models/external-squad.schema.ts
@@ -1,6 +1,9 @@
 import { z } from 'zod';
 
-import { ExternalSquadSubscriptionSettingsSchema } from './external-squad-subscription-settings.schema';
+import {
+    ExternalSquadSubscriptionSettingsSchema,
+    ExternalSquadHostOverridesSchema,
+} from './external-squads';
 import { SUBSCRIPTION_TEMPLATE_TYPE } from '../constants';
 
 export const ExternalSquadSchema = z.object({
@@ -18,6 +21,7 @@ export const ExternalSquadSchema = z.object({
         }),
     ),
     subscriptionSettings: z.nullable(ExternalSquadSubscriptionSettingsSchema),
+    hostOverrides: z.nullable(ExternalSquadHostOverridesSchema),
 
     createdAt: z
         .string()
diff --git a/libs/contract/models/external-squads/external-squad-host-overrides.schema.ts b/libs/contract/models/external-squads/external-squad-host-overrides.schema.ts
@@ -0,0 +1,6 @@
+import { HostsSchema } from '../hosts.schema';
+
+export const ExternalSquadHostOverridesSchema = HostsSchema.pick({
+    serverDescription: true,
+    vlessRouteId: true,
+}).partial();
diff --git a/libs/contract/models/external-squads/external-squad-subscription-settings.schema.ts b/libs/contract/models/external-squads/external-squad-subscription-settings.schema.ts
@@ -1,4 +1,4 @@
-import { SubscriptionSettingsSchema } from './subscription-settings.schema';
+import { SubscriptionSettingsSchema } from '../subscription-settings.schema';
 
 export const ExternalSquadSubscriptionSettingsSchema = SubscriptionSettingsSchema.pick({
     profileTitle: true,
diff --git a/libs/contract/models/external-squads/index.ts b/libs/contract/models/external-squads/index.ts
@@ -0,0 +1,2 @@
+export * from './external-squad-host-overrides.schema';
+export * from './external-squad-subscription-settings.schema';
diff --git a/libs/contract/models/hosts.schema.ts b/libs/contract/models/hosts.schema.ts
@@ -24,11 +24,11 @@ export const HostsSchema = z.object({
         configProfileInboundUuid: z.string().uuid().nullable(),
     }),
 
-    serverDescription: z.string().nullable(),
+    serverDescription: z.string().max(30).nullable(),
     tag: z.string().nullable(),
     isHidden: z.boolean().default(false),
     overrideSniFromAddress: z.boolean().default(false),
-    vlessRouteId: z.number().int().nullable(),
+    vlessRouteId: z.number().int().min(0).max(65535).nullable(),
     allowInsecure: z.boolean().default(false),
     shuffleHost: z.boolean(),
     mihomoX25519: z.boolean(),
diff --git a/libs/contract/models/index.ts b/libs/contract/models/index.ts
@@ -5,8 +5,8 @@ export * from './base-stat.schema';
 export * from './config-profile-inbounds.schema';
 export * from './config-profile.schema';
 export * from './extended-users.schema';
-export * from './external-squad-subscription-settings.schema';
 export * from './external-squad.schema';
+export * from './external-squads';
 export * from './happ.schema';
 export * from './hosts.schema';
 export * from './hwid-user-device.schema';
diff --git a/libs/contract/package.json b/libs/contract/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@remnawave/backend-contract",
-  "version": "2.2.28",
+  "version": "2.2.31",
   "public": true,
   "license": "AGPL-3.0-only",
   "description": "A contract library for Remnawave Backend. It can be used in backend and frontend.",
diff --git a/prisma/migrations/20251028234406_add_hosts_override_to_es/migration.sql b/prisma/migrations/20251028234406_add_hosts_override_to_es/migration.sql
@@ -0,0 +1,4 @@
+-- AlterTable
+ALTER TABLE "public"."external_squads" ADD COLUMN     "host_overrides" JSONB,
+ALTER COLUMN "created_at" SET DEFAULT now(),
+ALTER COLUMN "updated_at" SET DEFAULT now();
diff --git a/prisma/schema.prisma b/prisma/schema.prisma
@@ -548,6 +548,7 @@ model ExternalSquads {
   uuid                 String @id @default(dbgenerated("gen_random_uuid()")) @db.Uuid
   name                 String @unique @map("name") @db.VarChar(30)
   subscriptionSettings Json?  @map("subscription_settings")
+  hostOverrides        Json?  @map("host_overrides")
 
   createdAt DateTime @default(dbgenerated("now()")) @map("created_at")
   updatedAt DateTime @default(dbgenerated("now()")) @updatedAt @map("updated_at")
diff --git a/src/modules/external-squads/entities/external-squad-with-info.entity.ts b/src/modules/external-squads/entities/external-squad-with-info.entity.ts
@@ -1,7 +1,10 @@
 import { ExternalSquads } from '@prisma/client';
 import z from 'zod';
 
-import { ExternalSquadSubscriptionSettingsSchema } from '@libs/contracts/models';
+import {
+    ExternalSquadHostOverridesSchema,
+    ExternalSquadSubscriptionSettingsSchema,
+} from '@libs/contracts/models';
 import { TSubscriptionTemplateType } from '@libs/contracts/constants';
 
 export class ExternalSquadWithInfoEntity implements ExternalSquads {
@@ -16,6 +19,7 @@ export class ExternalSquadWithInfoEntity implements ExternalSquads {
     }[];
 
     public subscriptionSettings: z.infer<typeof ExternalSquadSubscriptionSettingsSchema> | null;
+    public hostOverrides: z.infer<typeof ExternalSquadHostOverridesSchema> | null;
 
     public createdAt: Date;
     public updatedAt: Date;
diff --git a/src/modules/external-squads/entities/external-squad.entity.ts b/src/modules/external-squads/entities/external-squad.entity.ts
@@ -1,13 +1,17 @@
 import { ExternalSquads } from '@prisma/client';
 import z from 'zod';
 
-import { ExternalSquadSubscriptionSettingsSchema } from '@libs/contracts/models';
+import {
+    ExternalSquadHostOverridesSchema,
+    ExternalSquadSubscriptionSettingsSchema,
+} from '@libs/contracts/models';
 
 export class ExternalSquadEntity implements ExternalSquads {
     public uuid: string;
     public name: string;
 
     public subscriptionSettings: z.infer<typeof ExternalSquadSubscriptionSettingsSchema> | null;
+    public hostOverrides: z.infer<typeof ExternalSquadHostOverridesSchema> | null;
 
     public createdAt: Date;
     public updatedAt: Date;
diff --git a/src/modules/external-squads/entities/index.ts b/src/modules/external-squads/entities/index.ts
@@ -1,2 +1,2 @@
+export * from './external-squad-with-info.entity';
 export * from './external-squad.entity';
-export * from './internal-squad-with-info.entity';
diff --git a/src/modules/external-squads/external-squads.converter.ts b/src/modules/external-squads/external-squads.converter.ts
@@ -15,6 +15,7 @@ const entityToModel = (entity: ExternalSquadEntity): ExternalSquads => {
         uuid: entity.uuid,
         name: entity.name,
         subscriptionSettings: entity.subscriptionSettings,
+        hostOverrides: entity.hostOverrides,
         createdAt: entity.createdAt,
         updatedAt: entity.updatedAt,
     };
diff --git a/src/modules/external-squads/external-squads.service.ts b/src/modules/external-squads/external-squads.service.ts
@@ -107,7 +107,7 @@ export class ExternalSquadService {
     public async updateExternalSquad(
         dto: UpdateExternalSquadRequestDto,
     ): Promise<ICommandResponse<GetExternalSquadByUuidResponseModel>> {
-        const { uuid, name, templates, subscriptionSettings } = dto;
+        const { uuid, name, templates, subscriptionSettings, hostOverrides } = dto;
 
         try {
             const externalSquad = await this.externalSquadRepository.findByUUID(uuid);
@@ -119,18 +119,19 @@ export class ExternalSquadService {
                 };
             }
 
-            if (!name && !templates && !subscriptionSettings) {
+            if (!name && !templates && !subscriptionSettings && !hostOverrides) {
                 return {
                     isOk: false,
                     ...ERRORS.NAME_OR_TEMPLATES_REQUIRED,
                 };
             }
 
-            if (name || subscriptionSettings) {
+            if (name || subscriptionSettings || hostOverrides) {
                 await this.externalSquadRepository.update({
                     uuid,
                     name: name || undefined,
                     subscriptionSettings: subscriptionSettings || undefined,
+                    hostOverrides: hostOverrides || undefined,
                 });
             }
 
diff --git a/src/modules/external-squads/models/get-external-squad-by-uuid.response.model.ts b/src/modules/external-squads/models/get-external-squad-by-uuid.response.model.ts
@@ -1,9 +1,12 @@
 import z from 'zod';
 
-import { ExternalSquadSubscriptionSettingsSchema } from '@libs/contracts/models';
+import {
+    ExternalSquadHostOverridesSchema,
+    ExternalSquadSubscriptionSettingsSchema,
+} from '@libs/contracts/models';
 import { TSubscriptionTemplateType } from '@libs/contracts/constants';
 
-import { ExternalSquadWithInfoEntity } from '../entities/internal-squad-with-info.entity';
+import { ExternalSquadWithInfoEntity } from '../entities/external-squad-with-info.entity';
 
 export class GetExternalSquadByUuidResponseModel {
     public readonly uuid: string;
@@ -21,6 +24,8 @@ export class GetExternalSquadByUuidResponseModel {
         typeof ExternalSquadSubscriptionSettingsSchema
     > | null;
 
+    public readonly hostOverrides: z.infer<typeof ExternalSquadHostOverridesSchema> | null;
+
     public readonly createdAt: Date;
     public readonly updatedAt: Date;
 
@@ -38,6 +43,8 @@ export class GetExternalSquadByUuidResponseModel {
 
         this.subscriptionSettings = entity.subscriptionSettings;
 
+        this.hostOverrides = entity.hostOverrides;
+
         this.createdAt = entity.createdAt;
         this.updatedAt = entity.updatedAt;
     }
diff --git a/src/modules/external-squads/queries/get-external-squad-settings/get-external-squad-settings.handler.ts b/src/modules/external-squads/queries/get-external-squad-settings/get-external-squad-settings.handler.ts
@@ -7,24 +7,29 @@ import { ERRORS } from '@libs/contracts/constants';
 import { ExternalSquadRepository } from '@modules/external-squads/repositories/external-squad.repository';
 import { ExternalSquadEntity } from '@modules/external-squads/entities';
 
-import { GetExternalSquadSubscriptionSettingsQuery } from './get-external-squad-subscription-settings.query';
+import { GetExternalSquadSettingsQuery } from './get-external-squad-settings.query';
 
-@QueryHandler(GetExternalSquadSubscriptionSettingsQuery)
-export class GetExternalSquadSubscriptionSettingsHandler
+@QueryHandler(GetExternalSquadSettingsQuery)
+export class GetExternalSquadSettingsHandler
     implements
         IQueryHandler<
-            GetExternalSquadSubscriptionSettingsQuery,
-            ICommandResponse<Pick<ExternalSquadEntity, 'subscriptionSettings'> | null>
+            GetExternalSquadSettingsQuery,
+            ICommandResponse<Pick<
+                ExternalSquadEntity,
+                'subscriptionSettings' | 'hostOverrides'
+            > | null>
         >
 {
-    private readonly logger = new Logger(GetExternalSquadSubscriptionSettingsHandler.name);
+    private readonly logger = new Logger(GetExternalSquadSettingsHandler.name);
     constructor(private readonly externalSquadRepository: ExternalSquadRepository) {}
 
     async execute(
-        query: GetExternalSquadSubscriptionSettingsQuery,
-    ): Promise<ICommandResponse<Pick<ExternalSquadEntity, 'subscriptionSettings'> | null>> {
+        query: GetExternalSquadSettingsQuery,
+    ): Promise<
+        ICommandResponse<Pick<ExternalSquadEntity, 'subscriptionSettings' | 'hostOverrides'> | null>
+    > {
         try {
-            const result = await this.externalSquadRepository.getExternalSquadSubscriptionSettings(
+            const result = await this.externalSquadRepository.getExternalSquadSettings(
                 query.externalSquadUuid,
             );
 
diff --git a/src/modules/external-squads/queries/get-external-squad-settings/get-external-squad-settings.query.ts b/src/modules/external-squads/queries/get-external-squad-settings/get-external-squad-settings.query.ts
@@ -4,8 +4,8 @@ import { ICommandResponse } from '@common/types/command-response.type';
 
 import { ExternalSquadEntity } from '@modules/external-squads/entities';
 
-export class GetExternalSquadSubscriptionSettingsQuery extends Query<
-    ICommandResponse<Pick<ExternalSquadEntity, 'subscriptionSettings'> | null>
+export class GetExternalSquadSettingsQuery extends Query<
+    ICommandResponse<Pick<ExternalSquadEntity, 'subscriptionSettings' | 'hostOverrides'> | null>
 > {
     constructor(public readonly externalSquadUuid: string) {
         super();
diff --git a/src/modules/external-squads/queries/get-external-squad-settings/index.ts b/src/modules/external-squads/queries/get-external-squad-settings/index.ts
@@ -0,0 +1,2 @@
+export * from './get-external-squad-settings.handler';
+export * from './get-external-squad-settings.query';
diff --git a/src/modules/external-squads/queries/get-external-squad-subscription-settings/index.ts b/src/modules/external-squads/queries/get-external-squad-subscription-settings/index.ts
diff --git a/src/modules/external-squads/queries/index.ts b/src/modules/external-squads/queries/index.ts
@@ -1,4 +1,4 @@
-import { GetExternalSquadSubscriptionSettingsHandler } from './get-external-squad-subscription-settings';
+import { GetExternalSquadSettingsHandler } from './get-external-squad-settings';
 import { GetTemplateNameHandler } from './get-template-name';
 
-export const QUERIES = [GetTemplateNameHandler, GetExternalSquadSubscriptionSettingsHandler];
+export const QUERIES = [GetTemplateNameHandler, GetExternalSquadSettingsHandler];
diff --git a/src/modules/external-squads/repositories/external-squad.repository.ts b/src/modules/external-squads/repositories/external-squad.repository.ts
@@ -62,8 +62,13 @@ export class ExternalSquadRepository implements ICrud<ExternalSquadEntity> {
     }
 
     public async findByCriteria(dto: Partial<ExternalSquadEntity>): Promise<ExternalSquadEntity[]> {
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        const { subscriptionSettings: _subscriptionSettings, ...rest } = dto;
+        const {
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            subscriptionSettings: _subscriptionSettings,
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            hostOverrides: _hostOverrides,
+            ...rest
+        } = dto;
         const externalSquadList = await this.prisma.tx.externalSquads.findMany({
             where: {
                 ...rest,
@@ -75,8 +80,13 @@ export class ExternalSquadRepository implements ICrud<ExternalSquadEntity> {
     public async findFirstByCriteria(
         dto: Partial<ExternalSquadEntity>,
     ): Promise<ExternalSquadEntity | null> {
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        const { subscriptionSettings: _subscriptionSettings, ...rest } = dto;
+        const {
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            subscriptionSettings: _subscriptionSettings,
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            hostOverrides: _hostOverrides,
+            ...rest
+        } = dto;
         const result = await this.prisma.tx.externalSquads.findFirst({
             where: {
                 ...rest,
@@ -102,6 +112,7 @@ export class ExternalSquadRepository implements ICrud<ExternalSquadEntity> {
                 'externalSquads.uuid',
                 'externalSquads.name',
                 'externalSquads.subscriptionSettings',
+                'externalSquads.hostOverrides',
                 'externalSquads.createdAt',
                 'externalSquads.updatedAt',
 
@@ -132,14 +143,15 @@ export class ExternalSquadRepository implements ICrud<ExternalSquadEntity> {
                 'externalSquads.uuid',
                 'externalSquads.name',
                 'externalSquads.subscriptionSettings',
+                'externalSquads.hostOverrides',
                 'externalSquads.createdAt',
                 'externalSquads.updatedAt',
 
                 eb
                     .selectFrom('users')
                     .select(eb.fn.countAll().as('count'))
                     .whereRef('users.externalSquadUuid', '=', 'externalSquads.uuid')
-                    .as('usersCount'),
+                    .as('membersCount'),
 
                 jsonArrayFrom(
                     eb
@@ -252,13 +264,14 @@ export class ExternalSquadRepository implements ICrud<ExternalSquadEntity> {
         return result.templateName;
     }
 
-    public async getExternalSquadSubscriptionSettings(
+    public async getExternalSquadSettings(
         externalSquadUuid: string,
-    ): Promise<Pick<ExternalSquadEntity, 'subscriptionSettings'> | null> {
+    ): Promise<Pick<ExternalSquadEntity, 'subscriptionSettings' | 'hostOverrides'> | null> {
         const result = await this.prisma.tx.externalSquads.findUnique({
             where: { uuid: externalSquadUuid },
             select: {
                 subscriptionSettings: true,
+                hostOverrides: true,
             },
         });
 
diff --git a/src/modules/subscription-template/generators/format-hosts.service.ts b/src/modules/subscription-template/generators/format-hosts.service.ts
diff --git a/src/modules/subscription-template/interfaces/generate-subscription.interface.ts b/src/modules/subscription-template/interfaces/generate-subscription.interface.ts
diff --git a/src/modules/subscription-template/render-templates.service.ts b/src/modules/subscription-template/render-templates.service.ts
diff --git a/src/modules/subscription/subscription.service.ts b/src/modules/subscription/subscription.service.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { SubscriptionSettingsSchema } from './subscription-settings.schema';`
	`1`	`+import { SubscriptionSettingsSchema } from '../subscription-settings.schema';`
`2`	`2`
`3`	`3`	`export const ExternalSquadSubscriptionSettingsSchema = SubscriptionSettingsSchema.pick({`
`4`	`4`	`profileTitle: true,`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export * from './external-squad-host-overrides.schema';`
	`2`	`+export * from './external-squad-subscription-settings.schema';`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@remnawave/backend-contract",`
`3`		`- "version": "2.2.28",`
	`3`	`+ "version": "2.2.31",`
`4`	`4`	`"public": true,`
`5`	`5`	`"license": "AGPL-3.0-only",`
`6`	`6`	`"description": "A contract library for Remnawave Backend. It can be used in backend and frontend.",`