feat: add responseHeaders to ExternalSquad model and update related services

kastov · kastov · commit 30c8f1a2a62d · 2025-11-06T00:17:56.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
@@ -2,6 +2,7 @@ import { z } from 'zod';
 
 import {
     ExternalSquadHostOverridesSchema,
+    ExternalSquadResponseHeadersSchema,
     ExternalSquadSchema,
     ExternalSquadSubscriptionSettingsSchema,
 } from '../../models';
@@ -39,6 +40,7 @@ export namespace UpdateExternalSquadCommand {
             .optional(),
         subscriptionSettings: ExternalSquadSubscriptionSettingsSchema.optional(),
         hostOverrides: ExternalSquadHostOverridesSchema.optional(),
+        responseHeaders: ExternalSquadResponseHeadersSchema.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
@@ -3,6 +3,7 @@ import { z } from 'zod';
 import {
     ExternalSquadSubscriptionSettingsSchema,
     ExternalSquadHostOverridesSchema,
+    ExternalSquadResponseHeadersSchema,
 } from './external-squads';
 import { SUBSCRIPTION_TEMPLATE_TYPE } from '../constants';
 
@@ -22,6 +23,7 @@ export const ExternalSquadSchema = z.object({
     ),
     subscriptionSettings: z.nullable(ExternalSquadSubscriptionSettingsSchema),
     hostOverrides: z.nullable(ExternalSquadHostOverridesSchema),
+    responseHeaders: ExternalSquadResponseHeadersSchema,
 
     createdAt: z
         .string()
diff --git a/libs/contract/models/external-squads/external-squad-response-headers.schema.ts b/libs/contract/models/external-squads/external-squad-response-headers.schema.ts
@@ -0,0 +1,3 @@
+import { z } from 'zod';
+
+export const ExternalSquadResponseHeadersSchema = z.nullable(z.record(z.string(), z.string()));
diff --git a/libs/contract/models/external-squads/index.ts b/libs/contract/models/external-squads/index.ts
@@ -1,2 +1,3 @@
 export * from './external-squad-host-overrides.schema';
+export * from './external-squad-response-headers.schema';
 export * from './external-squad-subscription-settings.schema';
diff --git a/libs/contract/package.json b/libs/contract/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@remnawave/backend-contract",
-  "version": "2.2.32",
+  "version": "2.2.34",
   "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/20251105201518_response_headers_es/migration.sql b/prisma/migrations/20251105201518_response_headers_es/migration.sql
@@ -0,0 +1,4 @@
+-- AlterTable
+ALTER TABLE "public"."external_squads" ADD COLUMN     "response_headers" 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
@@ -549,6 +549,7 @@ model ExternalSquads {
   name                 String @unique @map("name") @db.VarChar(30)
   subscriptionSettings Json?  @map("subscription_settings")
   hostOverrides        Json?  @map("host_overrides")
+  responseHeaders      Json?  @map("response_headers")
 
   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
@@ -3,6 +3,7 @@ import z from 'zod';
 
 import {
     ExternalSquadHostOverridesSchema,
+    ExternalSquadResponseHeadersSchema,
     ExternalSquadSubscriptionSettingsSchema,
 } from '@libs/contracts/models';
 import { TSubscriptionTemplateType } from '@libs/contracts/constants';
@@ -20,6 +21,7 @@ export class ExternalSquadWithInfoEntity implements ExternalSquads {
 
     public subscriptionSettings: z.infer<typeof ExternalSquadSubscriptionSettingsSchema> | null;
     public hostOverrides: z.infer<typeof ExternalSquadHostOverridesSchema> | null;
+    public responseHeaders: z.infer<typeof ExternalSquadResponseHeadersSchema> | 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
@@ -3,6 +3,7 @@ import z from 'zod';
 
 import {
     ExternalSquadHostOverridesSchema,
+    ExternalSquadResponseHeadersSchema,
     ExternalSquadSubscriptionSettingsSchema,
 } from '@libs/contracts/models';
 
@@ -12,6 +13,7 @@ export class ExternalSquadEntity implements ExternalSquads {
 
     public subscriptionSettings: z.infer<typeof ExternalSquadSubscriptionSettingsSchema> | null;
     public hostOverrides: z.infer<typeof ExternalSquadHostOverridesSchema> | null;
+    public responseHeaders: z.infer<typeof ExternalSquadResponseHeadersSchema> | 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
@@ -16,6 +16,7 @@ const entityToModel = (entity: ExternalSquadEntity): ExternalSquads => {
         name: entity.name,
         subscriptionSettings: entity.subscriptionSettings,
         hostOverrides: entity.hostOverrides,
+        responseHeaders: entity.responseHeaders,
         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, hostOverrides } = dto;
+        const { uuid, name, templates, subscriptionSettings, hostOverrides, responseHeaders } = dto;
 
         try {
             const externalSquad = await this.externalSquadRepository.findByUUID(uuid);
@@ -119,19 +119,26 @@ export class ExternalSquadService {
                 };
             }
 
-            if (!name && !templates && !subscriptionSettings && !hostOverrides) {
+            if (
+                !name &&
+                !templates &&
+                !subscriptionSettings &&
+                !hostOverrides &&
+                !responseHeaders
+            ) {
                 return {
                     isOk: false,
                     ...ERRORS.NAME_OR_TEMPLATES_REQUIRED,
                 };
             }
 
-            if (name || subscriptionSettings || hostOverrides) {
+            if (name || subscriptionSettings || hostOverrides || responseHeaders) {
                 await this.externalSquadRepository.update({
                     uuid,
                     name: name || undefined,
                     subscriptionSettings: subscriptionSettings || undefined,
                     hostOverrides: hostOverrides || undefined,
+                    responseHeaders: responseHeaders || 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
@@ -2,6 +2,7 @@ import z from 'zod';
 
 import {
     ExternalSquadHostOverridesSchema,
+    ExternalSquadResponseHeadersSchema,
     ExternalSquadSubscriptionSettingsSchema,
 } from '@libs/contracts/models';
 import { TSubscriptionTemplateType } from '@libs/contracts/constants';
@@ -26,6 +27,8 @@ export class GetExternalSquadByUuidResponseModel {
 
     public readonly hostOverrides: z.infer<typeof ExternalSquadHostOverridesSchema> | null;
 
+    public readonly responseHeaders: z.infer<typeof ExternalSquadResponseHeadersSchema> | null;
+
     public readonly createdAt: Date;
     public readonly updatedAt: Date;
 
@@ -44,6 +47,7 @@ export class GetExternalSquadByUuidResponseModel {
         this.subscriptionSettings = entity.subscriptionSettings;
 
         this.hostOverrides = entity.hostOverrides;
+        this.responseHeaders = entity.responseHeaders;
 
         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
@@ -16,7 +16,7 @@ export class GetExternalSquadSettingsHandler
             GetExternalSquadSettingsQuery,
             ICommandResponse<Pick<
                 ExternalSquadEntity,
-                'subscriptionSettings' | 'hostOverrides'
+                'subscriptionSettings' | 'hostOverrides' | 'responseHeaders'
             > | null>
         >
 {
@@ -26,7 +26,10 @@ export class GetExternalSquadSettingsHandler
     async execute(
         query: GetExternalSquadSettingsQuery,
     ): Promise<
-        ICommandResponse<Pick<ExternalSquadEntity, 'subscriptionSettings' | 'hostOverrides'> | null>
+        ICommandResponse<Pick<
+            ExternalSquadEntity,
+            'subscriptionSettings' | 'hostOverrides' | 'responseHeaders'
+        > | null>
     > {
         try {
             const result = await this.externalSquadRepository.getExternalSquadSettings(
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
@@ -5,7 +5,10 @@ import { ICommandResponse } from '@common/types/command-response.type';
 import { ExternalSquadEntity } from '@modules/external-squads/entities';
 
 export class GetExternalSquadSettingsQuery extends Query<
-    ICommandResponse<Pick<ExternalSquadEntity, 'subscriptionSettings' | 'hostOverrides'> | null>
+    ICommandResponse<Pick<
+        ExternalSquadEntity,
+        'subscriptionSettings' | 'hostOverrides' | 'responseHeaders'
+    > | 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
@@ -67,6 +67,8 @@ export class ExternalSquadRepository implements ICrud<ExternalSquadEntity> {
             subscriptionSettings: _subscriptionSettings,
             // eslint-disable-next-line @typescript-eslint/no-unused-vars
             hostOverrides: _hostOverrides,
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            responseHeaders: _responseHeaders,
             ...rest
         } = dto;
         const externalSquadList = await this.prisma.tx.externalSquads.findMany({
@@ -85,6 +87,8 @@ export class ExternalSquadRepository implements ICrud<ExternalSquadEntity> {
             subscriptionSettings: _subscriptionSettings,
             // eslint-disable-next-line @typescript-eslint/no-unused-vars
             hostOverrides: _hostOverrides,
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            responseHeaders: _responseHeaders,
             ...rest
         } = dto;
         const result = await this.prisma.tx.externalSquads.findFirst({
@@ -113,6 +117,7 @@ export class ExternalSquadRepository implements ICrud<ExternalSquadEntity> {
                 'externalSquads.name',
                 'externalSquads.subscriptionSettings',
                 'externalSquads.hostOverrides',
+                'externalSquads.responseHeaders',
                 'externalSquads.createdAt',
                 'externalSquads.updatedAt',
 
@@ -144,6 +149,7 @@ export class ExternalSquadRepository implements ICrud<ExternalSquadEntity> {
                 'externalSquads.name',
                 'externalSquads.subscriptionSettings',
                 'externalSquads.hostOverrides',
+                'externalSquads.responseHeaders',
                 'externalSquads.createdAt',
                 'externalSquads.updatedAt',
 
@@ -266,12 +272,16 @@ export class ExternalSquadRepository implements ICrud<ExternalSquadEntity> {
 
     public async getExternalSquadSettings(
         externalSquadUuid: string,
-    ): Promise<Pick<ExternalSquadEntity, 'subscriptionSettings' | 'hostOverrides'> | null> {
+    ): Promise<Pick<
+        ExternalSquadEntity,
+        'subscriptionSettings' | 'hostOverrides' | 'responseHeaders'
+    > | null> {
         const result = await this.prisma.tx.externalSquads.findUnique({
             where: { uuid: externalSquadUuid },
             select: {
                 subscriptionSettings: true,
                 hostOverrides: true,
+                responseHeaders: true,
             },
         });
 
diff --git a/src/modules/subscription/subscription.service.ts b/src/modules/subscription/subscription.service.ts
@@ -152,6 +152,15 @@ export class SubscriptionService {
                     if (externalSquadSubscriptionSettings.response.hostOverrides !== null) {
                         hostsOverrides = externalSquadSubscriptionSettings.response.hostOverrides;
                     }
+
+                    if (
+                        externalSquadSubscriptionSettings.response.responseHeaders !== null &&
+                        Object.keys(externalSquadSubscriptionSettings.response.responseHeaders)
+                            .length > 0
+                    ) {
+                        srrContext.subscriptionSettings.customResponseHeaders =
+                            externalSquadSubscriptionSettings.response.responseHeaders;
+                    }
                 }
             }
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { z } from 'zod';`
	`2`	`+`
	`3`	`+export const ExternalSquadResponseHeadersSchema = z.nullable(z.record(z.string(), z.string()));`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`export * from './external-squad-host-overrides.schema';`
	`2`	`+export * from './external-squad-response-headers.schema';`
`2`	`3`	`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.32",`
	`3`	`+ "version": "2.2.34",`
`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.",`