feat: enhance subscription and external squad models with custom remarks

kastov · kastov · commit 932782fe5c53 · 2025-11-21T04:26:52.000+03:00
- Added customRemarks field to SubscriptionSettings and ExternalSquad models.
- Updated related schemas, commands, and services to handle custom remarks.
- Refactored seeding logic to include custom remarks for subscription settings.
- Enhanced formatting logic to utilize custom remarks in host responses.
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,7 @@
 import { z } from 'zod';
 
 import {
+    CustomRemarksSchema,
     ExternalSquadHostOverridesSchema,
     ExternalSquadResponseHeadersSchema,
     ExternalSquadSchema,
@@ -43,6 +44,7 @@ export namespace UpdateExternalSquadCommand {
         hostOverrides: ExternalSquadHostOverridesSchema.optional(),
         responseHeaders: ExternalSquadResponseHeadersSchema.optional(),
         hwidSettings: z.optional(z.nullable(HwidSettingsSchema)),
+        customRemarks: z.optional(z.nullable(CustomRemarksSchema)),
     });
 
     export type Request = z.infer<typeof RequestSchema>;
diff --git a/libs/contract/commands/subscription-settings/update-subscription-settings.command.ts b/libs/contract/commands/subscription-settings/update-subscription-settings.command.ts
@@ -1,6 +1,7 @@
 import { z } from 'zod';
 
 import {
+    CustomRemarksSchema,
     HwidSettingsSchema,
     ResponseRulesConfigSchema,
     SubscriptionSettingsSchema,
@@ -27,7 +28,6 @@ export namespace UpdateSubscriptionSettingsCommand {
         isProfileWebpageUrlEnabled: z.optional(z.boolean()),
         serveJsonAtBaseSubscription: z.optional(z.boolean()),
         addUsernameToBaseSubscription: z.optional(z.boolean()),
-        isShowCustomRemarks: z.optional(z.boolean()),
 
         happAnnounce: z.optional(
             z
@@ -37,9 +37,8 @@ export namespace UpdateSubscriptionSettingsCommand {
         ),
         happRouting: z.optional(z.string().nullable()),
 
-        expiredUsersRemarks: z.optional(z.array(z.string())),
-        limitedUsersRemarks: z.optional(z.array(z.string())),
-        disabledUsersRemarks: z.optional(z.array(z.string())),
+        isShowCustomRemarks: z.optional(z.boolean()),
+        customRemarks: z.optional(CustomRemarksSchema),
 
         customResponseHeaders: z.optional(
             z.record(
diff --git a/libs/contract/models/external-squad.schema.ts b/libs/contract/models/external-squad.schema.ts
@@ -5,7 +5,7 @@ import {
     ExternalSquadHostOverridesSchema,
     ExternalSquadResponseHeadersSchema,
 } from './external-squads';
-import { HwidSettingsSchema } from './subscription-settings/hwid-settings.schema';
+import { HwidSettingsSchema, CustomRemarksSchema } from './subscription-settings';
 import { SUBSCRIPTION_TEMPLATE_TYPE } from '../constants';
 
 export const ExternalSquadSchema = z.object({
@@ -27,6 +27,7 @@ export const ExternalSquadSchema = z.object({
     hostOverrides: z.nullable(ExternalSquadHostOverridesSchema),
     responseHeaders: ExternalSquadResponseHeadersSchema,
     hwidSettings: z.nullable(HwidSettingsSchema),
+    customRemarks: z.nullable(CustomRemarksSchema),
 
     createdAt: z
         .string()
diff --git a/libs/contract/models/subscription-settings.schema.ts b/libs/contract/models/subscription-settings.schema.ts
@@ -1,5 +1,6 @@
 import { z } from 'zod';
 
+import { CustomRemarksSchema } from './subscription-settings/custom-remarks.schema';
 import { HwidSettingsSchema } from './subscription-settings/hwid-settings.schema';
 import { ResponseRulesConfigSchema } from './response-rules';
 
@@ -16,15 +17,13 @@ export const SubscriptionSettingsSchema = z.object({
     isProfileWebpageUrlEnabled: z.boolean(),
     serveJsonAtBaseSubscription: z.boolean(),
     addUsernameToBaseSubscription: z.boolean(),
+
     isShowCustomRemarks: z.boolean(),
+    customRemarks: CustomRemarksSchema,
 
     happAnnounce: z.string().nullable(),
     happRouting: z.string().nullable(),
 
-    expiredUsersRemarks: z.array(z.string()),
-    limitedUsersRemarks: z.array(z.string()),
-    disabledUsersRemarks: z.array(z.string()),
-
     customResponseHeaders: z.nullable(z.record(z.string(), z.string())),
 
     randomizeHosts: z.boolean(),
diff --git a/libs/contract/models/subscription-settings/custom-remarks.schema.ts b/libs/contract/models/subscription-settings/custom-remarks.schema.ts
@@ -0,0 +1,11 @@
+import z from 'zod';
+
+export const CustomRemarksSchema = z.object({
+    expiredUsers: z.array(z.string()).min(1),
+    limitedUsers: z.array(z.string()).min(1),
+    disabledUsers: z.array(z.string()).min(1),
+    emptyHosts: z.array(z.string()).min(1),
+    emptyInternalSquads: z.array(z.string()).min(1),
+});
+
+export type TCustomRemarks = z.infer<typeof CustomRemarksSchema>;
diff --git a/libs/contract/models/subscription-settings/index.ts b/libs/contract/models/subscription-settings/index.ts
@@ -1 +1,2 @@
+export * from './custom-remarks.schema';
 export * from './hwid-settings.schema';
diff --git a/libs/contract/package.json b/libs/contract/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@remnawave/backend-contract",
-  "version": "2.3.16",
+  "version": "2.3.19",
   "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/20251120225934_es_custom_remarks/migration.sql b/prisma/migrations/20251120225934_es_custom_remarks/migration.sql
@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "external_squads" ADD COLUMN     "custom_remarks" JSONB;
diff --git a/prisma/migrations/20251121001611_unify_custom_remarks/migration.sql b/prisma/migrations/20251121001611_unify_custom_remarks/migration.sql
@@ -0,0 +1,21 @@
+-- AlterTable
+ALTER TABLE "subscription_settings" ADD COLUMN "custom_remarks" JSONB;
+
+-- Migrate data
+UPDATE "subscription_settings"
+SET "custom_remarks" = jsonb_build_object(
+    'expiredUsers', COALESCE("expired_users_remarks", '[]'::jsonb),
+    'limitedUsers', COALESCE("limited_users_remarks", '[]'::jsonb),
+    'disabledUsers', COALESCE("disabled_users_remarks", '[]'::jsonb),
+    'emptyHosts', '["→ Remnawave", "Did you forget to add hosts?", "→ No hosts found", "→ Check Hosts tab"]'::jsonb,
+    'emptyInternalSquads', '["→ Remnawave", "Did you forget to add internal squads?", "→ No internal squads found", "User has no internal squads"]'::jsonb
+);
+
+-- AlterTable
+ALTER TABLE "subscription_settings" ALTER COLUMN "custom_remarks" SET NOT NULL;
+
+-- Drop old columns
+ALTER TABLE "subscription_settings" 
+DROP COLUMN "disabled_users_remarks",
+DROP COLUMN "expired_users_remarks",
+DROP COLUMN "limited_users_remarks";
diff --git a/prisma/schema.prisma b/prisma/schema.prisma
@@ -361,9 +361,7 @@ model SubscriptionSettings {
   happAnnounce                  String? @map("happ_announce")
   happRouting                   String? @map("happ_routing")
   isShowCustomRemarks           Boolean @default(true) @map("is_show_custom_remarks")
-  expiredUsersRemarks           Json    @map("expired_users_remarks")
-  limitedUsersRemarks           Json    @map("limited_users_remarks")
-  disabledUsersRemarks          Json    @map("disabled_users_remarks")
+  customRemarks                 Json    @map("custom_remarks")
   customResponseHeaders         Json?   @map("custom_response_headers")
   randomizeHosts                Boolean @default(false) @map("randomize_hosts")
   responseRules                 Json?   @map("response_rules")
@@ -568,7 +566,8 @@ model ExternalSquads {
   hostOverrides        Json?  @map("host_overrides")
   responseHeaders      Json?  @map("response_headers")
 
-  hwidSettings Json? @map("hwid_settings")
+  hwidSettings  Json? @map("hwid_settings")
+  customRemarks Json? @map("custom_remarks")
 
   createdAt DateTime @default(dbgenerated("now()")) @map("created_at")
   updatedAt DateTime @default(dbgenerated("now()")) @updatedAt @map("updated_at")
diff --git a/prisma/seed/config.seed.ts b/prisma/seed/config.seed.ts
@@ -298,24 +298,36 @@ async function seedSubscriptionSettings() {
         return;
     }
 
-    const expiredUserRemarks = ['🚨 Subscription expired', 'Contact support'];
-    const disabledUserRemarks = ['❌ Subscription disabled', 'Contact support'];
-    const limitedUserRemarks = ['🔴 Subscription limited', 'Contact support'];
+    const customRemarks = {
+        expiredUsers: ['⌛ Subscription expired', 'Contact support'],
+        limitedUsers: ['🚧 Subscription limited', 'Contact support'],
+        disabledUsers: ['🚫 Subscription disabled', 'Contact support'],
+        emptyHosts: [
+            '→ Remnawave',
+            'Did you forget to add hosts?',
+            '→ No hosts found',
+            '→ Check Hosts tab',
+        ],
+        emptyInternal: [
+            '→ Remnawave',
+            'Did you forget to add internal squads?',
+            '→ No internal squads found',
+            'User has no internal squads',
+        ],
+    };
 
     await prisma.subscriptionSettings.create({
         data: {
             profileTitle: 'Remnawave',
             supportLink: 'https://docs.rw',
             profileUpdateInterval: 12,
             isProfileWebpageUrlEnabled: true,
-            expiredUsersRemarks: expiredUserRemarks,
-            limitedUsersRemarks: limitedUserRemarks,
-            disabledUsersRemarks: disabledUserRemarks,
             serveJsonAtBaseSubscription: false,
             addUsernameToBaseSubscription: false,
-            isShowCustomRemarks: true,
             randomizeHosts: false,
             hwidSettings: DEFAULT_HWID_SETTINGS,
+            isShowCustomRemarks: true,
+            customRemarks,
         },
     });
 }
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
@@ -5,6 +5,7 @@ import {
     ExternalSquadHostOverridesSchema,
     ExternalSquadResponseHeadersSchema,
     ExternalSquadSubscriptionSettingsSchema,
+    TCustomRemarks,
     THwidSettings,
 } from '@libs/contracts/models';
 import { TSubscriptionTemplateType } from '@libs/contracts/constants';
@@ -25,6 +26,7 @@ export class ExternalSquadWithInfoEntity implements ExternalSquads {
     public hostOverrides: z.infer<typeof ExternalSquadHostOverridesSchema> | null;
     public responseHeaders: z.infer<typeof ExternalSquadResponseHeadersSchema> | null;
     public hwidSettings: THwidSettings | null;
+    public customRemarks: TCustomRemarks | 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
@@ -5,6 +5,7 @@ import {
     ExternalSquadHostOverridesSchema,
     ExternalSquadResponseHeadersSchema,
     ExternalSquadSubscriptionSettingsSchema,
+    TCustomRemarks,
     THwidSettings,
 } from '@libs/contracts/models';
 
@@ -18,6 +19,7 @@ export class ExternalSquadEntity implements ExternalSquads {
     public responseHeaders: z.infer<typeof ExternalSquadResponseHeadersSchema> | null;
 
     public hwidSettings: THwidSettings | null;
+    public customRemarks: TCustomRemarks | 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
@@ -19,6 +19,7 @@ const entityToModel = (entity: ExternalSquadEntity): ExternalSquads => {
         hostOverrides: entity.hostOverrides,
         responseHeaders: entity.responseHeaders,
         hwidSettings: entity.hwidSettings,
+        customRemarks: entity.customRemarks,
         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
@@ -119,6 +119,7 @@ export class ExternalSquadService {
             hostOverrides,
             responseHeaders,
             hwidSettings,
+            customRemarks,
         } = dto;
 
         try {
@@ -137,7 +138,8 @@ export class ExternalSquadService {
                 !subscriptionSettings &&
                 !hostOverrides &&
                 !responseHeaders &&
-                hwidSettings === undefined
+                hwidSettings === undefined &&
+                customRemarks === undefined
             ) {
                 return {
                     isOk: false,
@@ -152,6 +154,7 @@ export class ExternalSquadService {
                 hostOverrides: hostOverrides || undefined,
                 responseHeaders: responseHeaders || undefined,
                 hwidSettings: hwidSettings,
+                customRemarks: customRemarks,
             });
 
             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
@@ -4,6 +4,7 @@ import {
     ExternalSquadHostOverridesSchema,
     ExternalSquadResponseHeadersSchema,
     ExternalSquadSubscriptionSettingsSchema,
+    TCustomRemarks,
     THwidSettings,
 } from '@libs/contracts/models';
 import { TSubscriptionTemplateType } from '@libs/contracts/constants';
@@ -32,6 +33,7 @@ export class GetExternalSquadByUuidResponseModel {
     public readonly responseHeaders: z.infer<typeof ExternalSquadResponseHeadersSchema> | null;
 
     public readonly hwidSettings: THwidSettings | null;
+    public readonly customRemarks: TCustomRemarks | null;
 
     public readonly createdAt: Date;
     public readonly updatedAt: Date;
@@ -55,6 +57,7 @@ export class GetExternalSquadByUuidResponseModel {
         this.responseHeaders = entity.responseHeaders;
 
         this.hwidSettings = entity.hwidSettings;
+        this.customRemarks = entity.customRemarks;
 
         this.createdAt = entity.createdAt;
         this.updatedAt = entity.updatedAt;
diff --git a/src/modules/external-squads/queries/get-cached-external-squad-settings/get-cached-external-squad-settings.handler.ts b/src/modules/external-squads/queries/get-cached-external-squad-settings/get-cached-external-squad-settings.handler.ts
@@ -26,7 +26,11 @@ export class GetCachedExternalSquadSettingsHandler
             const cached = await this.cacheManager.get<
                 Pick<
                     ExternalSquadEntity,
-                    'subscriptionSettings' | 'hostOverrides' | 'responseHeaders' | 'hwidSettings'
+                    | 'subscriptionSettings'
+                    | 'hostOverrides'
+                    | 'responseHeaders'
+                    | 'hwidSettings'
+                    | 'customRemarks'
                 >
             >(CACHE_KEYS.EXTERNAL_SQUAD_SETTINGS(query.externalSquadUuid));
 
diff --git a/src/modules/external-squads/queries/get-cached-external-squad-settings/get-cached-external-squad-settings.query.ts b/src/modules/external-squads/queries/get-cached-external-squad-settings/get-cached-external-squad-settings.query.ts
@@ -4,7 +4,7 @@ import { ExternalSquadEntity } from '@modules/external-squads/entities';
 
 export class GetCachedExternalSquadSettingsQuery extends Query<Pick<
     ExternalSquadEntity,
-    'subscriptionSettings' | 'hostOverrides' | 'responseHeaders' | 'hwidSettings'
+    'subscriptionSettings' | 'hostOverrides' | 'responseHeaders' | 'hwidSettings' | 'customRemarks'
 > | null> {
     constructor(public readonly externalSquadUuid: string) {
         super();
diff --git a/src/modules/external-squads/repositories/external-squad.repository.ts b/src/modules/external-squads/repositories/external-squad.repository.ts
diff --git a/src/modules/subscription-settings/entities/subscription-settings.entity.ts b/src/modules/subscription-settings/entities/subscription-settings.entity.ts
diff --git a/src/modules/subscription-settings/models/get-subscription-settings.response.model.ts b/src/modules/subscription-settings/models/get-subscription-settings.response.model.ts
diff --git a/src/modules/subscription-settings/repositories/subscription-settings.repository.ts b/src/modules/subscription-settings/repositories/subscription-settings.repository.ts
diff --git a/src/modules/subscription-settings/subscription-settings.converter.ts b/src/modules/subscription-settings/subscription-settings.converter.ts
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/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 +1,2 @@`
	`1`	`+export * from './custom-remarks.schema';`
`1`	`2`	`export * from './hwid-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.3.16",`
	`3`	`+ "version": "2.3.19",`
`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`	`+-- AlterTable`
	`2`	`+ALTER TABLE "external_squads" ADD COLUMN "custom_remarks" JSONB;`