feat: add subpage config support for external squads

kastov · kastov · commit 054b4b36dfda · 2025-12-15T03:23:26.000+03:00
diff --git a/libs/contract/api/controllers/subscriptions.ts b/libs/contract/api/controllers/subscriptions.ts
@@ -8,4 +8,7 @@ export const SUBSCRIPTIONS_ROUTES = {
         SHORT_UUID: (shortUuid: string) => `by-short-uuid/${shortUuid}`,
         SHORT_UUID_RAW: (shortUuid: string) => `by-short-uuid/${shortUuid}/raw`,
     },
+    SUBPAGE: {
+        GET_CONFIG: (shortUuid: string) => `subppage-config/${shortUuid}`,
+    },
 } as const;
diff --git a/libs/contract/api/routes.ts b/libs/contract/api/routes.ts
@@ -276,6 +276,12 @@ export const REST_API = {
                     shortUuid,
                 )}`,
         },
+        SUBPAGE: {
+            GET_CONFIG: (shortUuid: string) =>
+                `${ROOT}/${CONTROLLERS.SUBSCRIPTIONS_CONTROLLER}/${CONTROLLERS.SUBSCRIPTIONS_ROUTES.SUBPAGE.GET_CONFIG(
+                    shortUuid,
+                )}`,
+        },
     },
     CONFIG_PROFILES: {
         GET: `${ROOT}/${CONTROLLERS.CONFIG_PROFILES_CONTROLLER}/${CONTROLLERS.CONFIG_PROFILES_ROUTES.GET}`,
diff --git a/libs/contract/commands/external-squads/update-external-squad.command.ts b/libs/contract/commands/external-squads/update-external-squad.command.ts
@@ -45,6 +45,7 @@ export namespace UpdateExternalSquadCommand {
         responseHeaders: ExternalSquadResponseHeadersSchema.optional(),
         hwidSettings: z.optional(z.nullable(HwidSettingsSchema)),
         customRemarks: z.optional(z.nullable(CustomRemarksSchema)),
+        subpageConfigUuid: z.optional(z.nullable(z.string().uuid())),
     });
 
     export type Request = z.infer<typeof RequestSchema>;
diff --git a/libs/contract/commands/subscriptions/index.ts b/libs/contract/commands/subscriptions/index.ts
@@ -1,2 +1,3 @@
 export * from './get-all-subscriptions.command';
 export * from './get-by';
+export * from './subpage';
diff --git a/libs/contract/commands/subscriptions/subpage/get-subpage-config-by-shortuuid.command.ts b/libs/contract/commands/subscriptions/subpage/get-subpage-config-by-shortuuid.command.ts
@@ -0,0 +1,36 @@
+import { z } from 'zod';
+
+import { REST_API, SUBSCRIPTIONS_ROUTES } from '../../../api';
+import { getEndpointDetails } from '../../../constants';
+
+export namespace GetSubpageConfigByShortUuidCommand {
+    export const url = REST_API.SUBSCRIPTIONS.SUBPAGE.GET_CONFIG;
+    export const TSQ_url = url(':shortUuid');
+
+    export const endpointDetails = getEndpointDetails(
+        SUBSCRIPTIONS_ROUTES.SUBPAGE.GET_CONFIG(':shortUuid'),
+        'get',
+        'Get Subpage Config by Short UUID',
+    );
+
+    export const RequestSchema = z.object({
+        shortUuid: z.string(),
+    });
+
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const RequestBodySchema = z.object({
+        requestHeaders: z.record(z.string(), z.string()),
+    });
+
+    export type RequestBody = z.infer<typeof RequestBodySchema>;
+
+    export const ResponseSchema = z.object({
+        response: z.object({
+            subpageConfigUuid: z.string().uuid().nullable(),
+            webpageAllowed: z.boolean(),
+        }),
+    });
+
+    export type Response = z.infer<typeof ResponseSchema>;
+}
diff --git a/libs/contract/commands/subscriptions/subpage/index.ts b/libs/contract/commands/subscriptions/subpage/index.ts
@@ -0,0 +1 @@
+export * from './get-subpage-config-by-shortuuid.command';
diff --git a/libs/contract/models/external-squad.schema.ts b/libs/contract/models/external-squad.schema.ts
@@ -28,6 +28,7 @@ export const ExternalSquadSchema = z.object({
     responseHeaders: ExternalSquadResponseHeadersSchema,
     hwidSettings: z.nullable(HwidSettingsSchema),
     customRemarks: z.nullable(CustomRemarksSchema),
+    subpageConfigUuid: z.nullable(z.string().uuid()),
 
     createdAt: z
         .string()
diff --git a/libs/contract/package.json b/libs/contract/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@remnawave/backend-contract",
-  "version": "2.3.55",
+  "version": "2.3.58",
   "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/libs/subscription-page/constants/app-config.constant.ts b/libs/subscription-page/constants/app-config.constant.ts
@@ -0,0 +1,2 @@
+export const APP_CONFIG_ROUTE_LEADING_PATH = '/assets/.app-config-v2.json' as const;
+export const APP_CONFIG_ROUTE_WO_LEADING_PATH = 'assets/.app-config-v2.json' as const;
diff --git a/libs/subscription-page/constants/index.ts b/libs/subscription-page/constants/index.ts
@@ -1 +1,2 @@
+export * from './app-config.constant';
 export * from './subscription-page-config';
diff --git a/libs/subscription-page/package.json b/libs/subscription-page/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@remnawave/subscription-page-types",
-  "version": "0.0.6",
+  "version": "0.1.0",
   "public": true,
   "license": "AGPL-3.0-only",
   "description": "A types library for Remnawave Subscription Page.",
diff --git a/prisma/migrations/20251214213514_add_subpage_to_es/migration.sql b/prisma/migrations/20251214213514_add_subpage_to_es/migration.sql
@@ -0,0 +1,5 @@
+-- AlterTable
+ALTER TABLE "external_squads" ADD COLUMN     "subpage_config_uuid" UUID;
+
+-- AddForeignKey
+ALTER TABLE "external_squads" ADD CONSTRAINT "external_squads_subpage_config_uuid_fkey" FOREIGN KEY ("subpage_config_uuid") REFERENCES "subscription_page_config"("uuid") ON DELETE SET NULL ON UPDATE CASCADE;
diff --git a/prisma/schema.prisma b/prisma/schema.prisma
@@ -550,11 +550,14 @@ model ExternalSquads {
   hwidSettings  Json? @map("hwid_settings")
   customRemarks Json? @map("custom_remarks")
 
+  subpageConfigUuid String? @map("subpage_config_uuid") @db.Uuid
+
   createdAt DateTime @default(dbgenerated("now()")) @map("created_at")
   updatedAt DateTime @default(dbgenerated("now()")) @updatedAt @map("updated_at")
 
   externalSquadsTemplates ExternalSquadsTemplates[]
   users                   Users[]
+  subpageConfig           SubscriptionPageConfig?   @relation(fields: [subpageConfigUuid], references: [uuid], onDelete: SetNull)
 
   @@map("external_squads")
 }
@@ -580,5 +583,7 @@ model SubscriptionPageConfig {
   createdAt DateTime @default(dbgenerated("now()")) @map("created_at")
   updatedAt DateTime @default(dbgenerated("now()")) @updatedAt @map("updated_at")
 
+  externalSquads ExternalSquads[]
+
   @@map("subscription_page_config")
 }
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
@@ -27,6 +27,7 @@ export class ExternalSquadWithInfoEntity implements ExternalSquads {
     public responseHeaders: z.infer<typeof ExternalSquadResponseHeadersSchema> | null;
     public hwidSettings: THwidSettings | null;
     public customRemarks: TCustomRemarks | null;
+    public subpageConfigUuid: string | 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
@@ -20,6 +20,7 @@ export class ExternalSquadEntity implements ExternalSquads {
 
     public hwidSettings: THwidSettings | null;
     public customRemarks: TCustomRemarks | null;
+    public subpageConfigUuid: string | null;
 
     public createdAt: Date;
     public updatedAt: Date;
diff --git a/src/modules/external-squads/external-squads.converter.ts b/src/modules/external-squads/external-squads.converter.ts
@@ -20,6 +20,7 @@ const entityToModel = (entity: ExternalSquadEntity): ExternalSquads => {
         responseHeaders: entity.responseHeaders,
         hwidSettings: entity.hwidSettings,
         customRemarks: entity.customRemarks,
+        subpageConfigUuid: entity.subpageConfigUuid,
         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
@@ -101,6 +101,7 @@ export class ExternalSquadService {
             responseHeaders,
             hwidSettings,
             customRemarks,
+            subpageConfigUuid,
         } = dto;
 
         try {
@@ -117,7 +118,8 @@ export class ExternalSquadService {
                 !hostOverrides &&
                 !responseHeaders &&
                 hwidSettings === undefined &&
-                customRemarks === undefined
+                customRemarks === undefined &&
+                subpageConfigUuid === undefined
             ) {
                 return fail(ERRORS.NAME_OR_TEMPLATES_REQUIRED);
             }
@@ -130,6 +132,7 @@ export class ExternalSquadService {
                 responseHeaders: responseHeaders || undefined,
                 hwidSettings: hwidSettings,
                 customRemarks: customRemarks,
+                subpageConfigUuid: subpageConfigUuid,
             });
 
             if (templates !== 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
@@ -34,6 +34,7 @@ export class GetExternalSquadByUuidResponseModel {
 
     public readonly hwidSettings: THwidSettings | null;
     public readonly customRemarks: TCustomRemarks | null;
+    public readonly subpageConfigUuid: string | null;
 
     public readonly createdAt: Date;
     public readonly updatedAt: Date;
@@ -58,7 +59,7 @@ export class GetExternalSquadByUuidResponseModel {
 
         this.hwidSettings = entity.hwidSettings;
         this.customRemarks = entity.customRemarks;
-
+        this.subpageConfigUuid = entity.subpageConfigUuid;
         this.createdAt = entity.createdAt;
         this.updatedAt = entity.updatedAt;
     }
diff --git a/src/modules/external-squads/repositories/external-squad.repository.ts b/src/modules/external-squads/repositories/external-squad.repository.ts
@@ -123,6 +123,7 @@ export class ExternalSquadRepository implements ICrud<ExternalSquadEntity> {
                 'externalSquads.responseHeaders',
                 'externalSquads.hwidSettings',
                 'externalSquads.customRemarks',
+                'externalSquads.subpageConfigUuid',
                 'externalSquads.createdAt',
                 'externalSquads.updatedAt',
 
@@ -158,6 +159,7 @@ export class ExternalSquadRepository implements ICrud<ExternalSquadEntity> {
                 'externalSquads.responseHeaders',
                 'externalSquads.hwidSettings',
                 'externalSquads.customRemarks',
+                'externalSquads.subpageConfigUuid',
                 'externalSquads.createdAt',
                 'externalSquads.updatedAt',
 
diff --git a/src/modules/subscription/controllers/subscriptions.controller.ts b/src/modules/subscription/controllers/subscriptions.controller.ts
@@ -8,7 +8,16 @@ import {
     ApiQuery,
     ApiTags,
 } from '@nestjs/swagger';
-import { Controller, HttpStatus, Param, Query, Req, UseFilters, UseGuards } from '@nestjs/common';
+import {
+    Body,
+    Controller,
+    HttpStatus,
+    Param,
+    Query,
+    Req,
+    UseFilters,
+    UseGuards,
+} from '@nestjs/common';
 
 import { HttpExceptionFilter } from '@common/exception/http-exception.filter';
 import { JwtDefaultGuard } from '@common/guards/jwt-guards/def-jwt-guard';
@@ -25,6 +34,7 @@ import {
     GetSubscriptionByUsernameCommand,
     GetSubscriptionByUuidCommand,
 } from '@libs/contracts/commands';
+import { GetSubpageConfigByShortUuidCommand } from '@libs/contracts/commands/subscriptions/subpage/get-subpage-config-by-shortuuid.command';
 import { CONTROLLERS_INFO, SUBSCRIPTIONS_CONTROLLER } from '@libs/contracts/api';
 import { ROLE } from '@libs/contracts/constants';
 
@@ -41,6 +51,11 @@ import {
     GetSubscriptionByUuidRequestDto,
     GetSubscriptionByUuidResponseDto,
 } from '../dto';
+import {
+    GetSubpageConfigByShortUuidRequestBodyDto,
+    GetSubpageConfigByShortUuidRequestDto,
+    GetSubpageConfigByShortUuidResponseDto,
+} from '../dto/get-subpage-config.dto';
 import { AllSubscriptionsResponseModel, SubscriptionRawResponse } from '../models';
 import { SubscriptionService } from '../subscription.service';
 
@@ -268,4 +283,34 @@ export class SubscriptionsController {
             response: data,
         };
     }
+
+    @ApiOkResponse({
+        type: GetSubpageConfigByShortUuidResponseDto,
+        description: 'Subpage config fetched successfully',
+    })
+    @ApiParam({
+        name: 'shortUuid',
+        type: String,
+        description: 'Short UUID of the user',
+        required: true,
+    })
+    @Endpoint({
+        command: GetSubpageConfigByShortUuidCommand,
+        httpCode: HttpStatus.OK,
+        apiBody: GetSubpageConfigByShortUuidRequestBodyDto,
+    })
+    async getSubpageConfigByShortUuid(
+        @Param() paramData: GetSubpageConfigByShortUuidRequestDto,
+        @Body() body: GetSubpageConfigByShortUuidRequestBodyDto,
+    ): Promise<GetSubpageConfigByShortUuidResponseDto> {
+        const { shortUuid } = paramData;
+        const result = await this.subscriptionService.getSubpageConfigByShortUuid(
+            shortUuid,
+            body.requestHeaders,
+        );
+        const data = errorHandler(result);
+        return {
+            response: data,
+        };
+    }
 }
diff --git a/src/modules/subscription/dto/get-subpage-config.dto.ts b/src/modules/subscription/dto/get-subpage-config.dto.ts
@@ -0,0 +1,14 @@
+import { createZodDto } from 'nestjs-zod';
+
+import { GetSubpageConfigByShortUuidCommand } from '@libs/contracts/commands/subscriptions/subpage/get-subpage-config-by-shortuuid.command';
+
+export class GetSubpageConfigByShortUuidRequestDto extends createZodDto(
+    GetSubpageConfigByShortUuidCommand.RequestSchema,
+) {}
+export class GetSubpageConfigByShortUuidResponseDto extends createZodDto(
+    GetSubpageConfigByShortUuidCommand.ResponseSchema,
+) {}
+
+export class GetSubpageConfigByShortUuidRequestBodyDto extends createZodDto(
+    GetSubpageConfigByShortUuidCommand.RequestBodySchema,
+) {}
diff --git a/src/modules/subscription/models/get-subpage-config.response.model.ts b/src/modules/subscription/models/get-subpage-config.response.model.ts
@@ -0,0 +1,9 @@
+export class GetSubpageConfigResponseModel {
+    public readonly subpageConfigUuid: string | null;
+    public readonly webpageAllowed: boolean;
+
+    constructor(data: GetSubpageConfigResponseModel) {
+        this.subpageConfigUuid = data.subpageConfigUuid;
+        this.webpageAllowed = data.webpageAllowed;
+    }
+}
diff --git a/src/modules/subscription/subscription.service.ts b/src/modules/subscription/subscription.service.ts
@@ -17,6 +17,7 @@ import { THwidSettings } from '@libs/contracts/models';
 import { UserHwidDeviceEvent } from '@integration-modules/notifications/interfaces';
 
 import { GetCachedSubscriptionSettingsQuery } from '@modules/subscription-settings/queries/get-cached-subscrtipion-settings';
+import { ResponseRulesMatcherService } from '@modules/subscription-response-rules/services/response-rules-matcher.service';
 import { GetCachedExternalSquadSettingsQuery } from '@modules/external-squads/queries/get-cached-external-squad-settings';
 import { SubscriptionSettingsEntity } from '@modules/subscription-settings/entities/subscription-settings.entity';
 import { UpsertHwidUserDeviceCommand } from '@modules/hwid-user-devices/commands/upsert-hwid-user-device';
@@ -30,6 +31,7 @@ import { GetUsersWithPaginationQuery } from '@modules/users/queries/get-users-wi
 import { ExternalSquadEntity } from '@modules/external-squads/entities/external-squad.entity';
 import { CheckHwidExistsQuery } from '@modules/hwid-user-devices/queries/check-hwid-exists';
 import { GetUserByUniqueFieldQuery } from '@modules/users/queries/get-user-by-unique-field';
+import { GetUserSubpageConfigQuery } from '@modules/users/queries/get-user-subpage-config';
 import { GetTemplateNameQuery } from '@modules/external-squads/queries/get-template-name';
 import { ISRRContext } from '@modules/subscription-response-rules/interfaces';
 import { UserEntity } from '@modules/users/entities/user.entity';
@@ -44,6 +46,7 @@ import {
     SubscriptionWithConfigResponse,
 } from './models';
 import { getSubscriptionRefillDate, getSubscriptionUserInfo } from './utils/get-user-info.headers';
+import { GetSubpageConfigResponseModel } from './models/get-subpage-config.response.model';
 import { GetHostsForUserQuery } from '../hosts/queries/get-hosts-for-user';
 import { ISubscriptionHeaders, IGetSubscriptionInfo } from './interfaces';
 import { GetAllSubscriptionsQueryDto } from './dto';
@@ -62,6 +65,7 @@ export class SubscriptionService {
         private readonly formatHostsService: FormatHostsService,
         private readonly xrayGeneratorService: XrayGeneratorService,
         private readonly usersQueuesService: UsersQueuesService,
+        private readonly srrMatcher: ResponseRulesMatcherService,
     ) {
         this.subPublicDomain = this.configService.getOrThrow<string>('SUB_PUBLIC_DOMAIN');
     }
@@ -856,4 +860,48 @@ export class SubscriptionService {
             return;
         }
     }
+
+    public async getSubpageConfigByShortUuid(
+        shortUuid: string,
+        requestHeaders: Record<string, string>,
+    ): Promise<TResult<GetSubpageConfigResponseModel>> {
+        let subpageConfigUuid: string | null = null;
+        let webpageAllowed: boolean = false;
+
+        try {
+            const [subpageConfigUuidResult, settingsEntity] = await Promise.all([
+                this.queryBus.execute(new GetUserSubpageConfigQuery(shortUuid)),
+                this.queryBus.execute(new GetCachedSubscriptionSettingsQuery()),
+            ]);
+
+            if (subpageConfigUuidResult.isOk) {
+                subpageConfigUuid = subpageConfigUuidResult.response;
+            }
+
+            if (settingsEntity && settingsEntity.responseRules) {
+                const result = this.srrMatcher.matchRules(
+                    settingsEntity.responseRules,
+                    requestHeaders,
+                    undefined,
+                );
+
+                webpageAllowed = result.matched === true && result.responseType === 'BROWSER';
+            }
+
+            return ok(
+                new GetSubpageConfigResponseModel({
+                    subpageConfigUuid,
+                    webpageAllowed,
+                }),
+            );
+        } catch (error) {
+            this.logger.error(`Error getting subpage config by short uuid: ${error}`);
+            return ok(
+                new GetSubpageConfigResponseModel({
+                    subpageConfigUuid: null,
+                    webpageAllowed: false,
+                }),
+            );
+        }
+    }
 }
diff --git a/src/modules/users/queries/get-user-subpage-config/get-user-subpage-config.handler.ts b/src/modules/users/queries/get-user-subpage-config/get-user-subpage-config.handler.ts
diff --git a/src/modules/users/queries/get-user-subpage-config/get-user-subpage-config.query.ts b/src/modules/users/queries/get-user-subpage-config/get-user-subpage-config.query.ts
diff --git a/src/modules/users/queries/get-user-subpage-config/index.ts b/src/modules/users/queries/get-user-subpage-config/index.ts
diff --git a/src/modules/users/queries/index.ts b/src/modules/users/queries/index.ts
diff --git a/src/modules/users/repositories/users.repository.ts b/src/modules/users/repositories/users.repository.ts

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`export * from './get-all-subscriptions.command';`
`2`	`2`	`export * from './get-by';`
	`3`	`+export * from './subpage';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export * from './get-subpage-config-by-shortuuid.command';`
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.3.55",`
	`3`	`+ "version": "2.3.58",`
`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.",`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export const APP_CONFIG_ROUTE_LEADING_PATH = '/assets/.app-config-v2.json' as const;`
	`2`	`+export const APP_CONFIG_ROUTE_WO_LEADING_PATH = 'assets/.app-config-v2.json' as const;`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+export * from './app-config.constant';`
`1`	`2`	`export * from './subscription-page-config';`