feat: add clone functionality for subscription page configurations and update related schemas

kastov · kastov · commit 600ed9b64d83 · 2025-12-15T16:56:07.000+03:00
diff --git a/libs/contract/api/controllers/subscription-page-configs.ts b/libs/contract/api/controllers/subscription-page-configs.ts
@@ -11,5 +11,6 @@ export const SUBSCRIPTION_PAGE_CONFIGS_ROUTES = {
 
     ACTIONS: {
         REORDER: `${ACTIONS_ROUTE}/reorder`,
+        CLONE: `${ACTIONS_ROUTE}/clone`,
     },
 } as const;
diff --git a/libs/contract/api/routes.ts b/libs/contract/api/routes.ts
@@ -401,6 +401,7 @@ export const REST_API = {
         CREATE: `${ROOT}/${CONTROLLERS.SUBSCRIPTION_PAGE_CONFIGS_CONTROLLER}/${CONTROLLERS.SUBSCRIPTION_PAGE_CONFIGS_ROUTES.CREATE}`,
         ACTIONS: {
             REORDER: `${ROOT}/${CONTROLLERS.SUBSCRIPTION_PAGE_CONFIGS_CONTROLLER}/${CONTROLLERS.SUBSCRIPTION_PAGE_CONFIGS_ROUTES.ACTIONS.REORDER}`,
+            CLONE: `${ROOT}/${CONTROLLERS.SUBSCRIPTION_PAGE_CONFIGS_CONTROLLER}/${CONTROLLERS.SUBSCRIPTION_PAGE_CONFIGS_ROUTES.ACTIONS.CLONE}`,
         },
     },
 } as const;
diff --git a/libs/contract/commands/subscription-page-configs/actions/clone-subpage-config.command.ts b/libs/contract/commands/subscription-page-configs/actions/clone-subpage-config.command.ts
@@ -0,0 +1,30 @@
+import { z } from 'zod';
+
+import { REST_API, SUBSCRIPTION_PAGE_CONFIGS_ROUTES } from '../../../api';
+import { SubscriptionPageConfigSchema } from '../../../models';
+import { getEndpointDetails } from '../../../constants';
+
+export namespace CloneSubscriptionPageConfigCommand {
+    export const url = REST_API.SUBSCRIPTION_PAGE_CONFIGS.ACTIONS.CLONE;
+    export const TSQ_url = url;
+
+    export const endpointDetails = getEndpointDetails(
+        SUBSCRIPTION_PAGE_CONFIGS_ROUTES.ACTIONS.CLONE,
+        'post',
+        'Clone subscription page config',
+    );
+
+    export const RequestSchema = z.object({
+        cloneFromUuid: z.string().uuid(),
+    });
+
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = z.object({
+        response: SubscriptionPageConfigSchema.extend({
+            config: z.unknown(),
+        }),
+    });
+
+    export type Response = z.infer<typeof ResponseSchema>;
+}
diff --git a/libs/contract/commands/subscription-page-configs/actions/index.ts b/libs/contract/commands/subscription-page-configs/actions/index.ts
@@ -1 +1,2 @@
+export * from './clone-subpage-config.command';
 export * from './reorder.command';
diff --git a/libs/contract/package.json b/libs/contract/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@remnawave/backend-contract",
-  "version": "2.3.59",
+  "version": "2.3.61",
   "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/button-types.constant.ts b/libs/subscription-page/constants/button-types.constant.ts
@@ -0,0 +1,12 @@
+export const BUTTON_TYPES = {
+    EXTERNAL: 'external',
+    SUBSCRIPTION_LINK: 'subscriptionLink',
+} as const;
+
+export type TButtonType = (typeof BUTTON_TYPES)[keyof typeof BUTTON_TYPES];
+
+export const BUTTON_TYPES_VALUES = Object.values(BUTTON_TYPES);
+
+export const isButtonType = (value: string): value is TButtonType => {
+    return BUTTON_TYPES_VALUES.includes(value as TButtonType);
+};
diff --git a/libs/subscription-page/constants/index.ts b/libs/subscription-page/constants/index.ts
@@ -1,2 +1,5 @@
 export * from './app-config.constant';
+export * from './button-types.constant';
+export * from './installation-guide-blocks.constant';
+export * from './subscription-info-blocks.constant';
 export * from './subscription-page-config';
diff --git a/libs/subscription-page/constants/installation-guide-blocks.constant.ts b/libs/subscription-page/constants/installation-guide-blocks.constant.ts
@@ -0,0 +1,21 @@
+export const INSTALLATION_GUIDE_BLOCKS_VARIANTS = {
+    CARDS: 'cards',
+    ACCORDION: 'accordion',
+    MINIMAL: 'minimal',
+    TIMELINE: 'timeline',
+} as const;
+
+export type TInstallationGuideBlockVariant =
+    (typeof INSTALLATION_GUIDE_BLOCKS_VARIANTS)[keyof typeof INSTALLATION_GUIDE_BLOCKS_VARIANTS];
+
+export const INSTALLATION_GUIDE_BLOCKS_VARIANTS_VALUES = Object.values(
+    INSTALLATION_GUIDE_BLOCKS_VARIANTS,
+);
+
+export const isInstallationGuideBlockVariant = (
+    value: string,
+): value is TInstallationGuideBlockVariant => {
+    return INSTALLATION_GUIDE_BLOCKS_VARIANTS_VALUES.includes(
+        value as TInstallationGuideBlockVariant,
+    );
+};
diff --git a/libs/subscription-page/constants/subscription-info-blocks.constant.ts b/libs/subscription-page/constants/subscription-info-blocks.constant.ts
@@ -0,0 +1,19 @@
+export const SUBSCRIPTION_INFO_BLOCK_VARIANTS = {
+    COLLAPSED: 'collapsed',
+    EXPANDED: 'expanded',
+    CARDS: 'cards',
+    HIDDEN: 'hidden',
+} as const;
+
+export type TSubscriptionInfoBlockVariant =
+    (typeof SUBSCRIPTION_INFO_BLOCK_VARIANTS)[keyof typeof SUBSCRIPTION_INFO_BLOCK_VARIANTS];
+
+export const SUBSCRIPTION_INFO_BLOCK_VARIANTS_VALUES = Object.values(
+    SUBSCRIPTION_INFO_BLOCK_VARIANTS,
+);
+
+export const isSubscriptionInfoBlockVariant = (
+    value: string,
+): value is TSubscriptionInfoBlockVariant => {
+    return SUBSCRIPTION_INFO_BLOCK_VARIANTS_VALUES.includes(value as TSubscriptionInfoBlockVariant);
+};
diff --git a/libs/subscription-page/models/subscription-page-config/subscription-page-config.schema.ts b/libs/subscription-page/models/subscription-page-config/subscription-page-config.schema.ts
@@ -4,6 +4,9 @@ import {
     SUBSCRIPTION_PAGE_CONFIG_VERSION,
     SUBSCRIPTION_PAGE_CONFIG_PLATFORM_TYPES,
     SUBSCRIPTION_PAGE_CONFIG_ADDITIONAL_LOCALES,
+    SUBSCRIPTION_INFO_BLOCK_VARIANTS,
+    INSTALLATION_GUIDE_BLOCKS_VARIANTS,
+    BUTTON_TYPES,
 } from '../../constants';
 import {
     validateLocalizedTexts,
@@ -25,7 +28,7 @@ const SvgLibrarySchema = z.record(
 
 const ButtonSchema = z.object({
     link: z.string(),
-    type: z.enum(['external', 'subscriptionLink']),
+    type: z.nativeEnum(BUTTON_TYPES),
     text: LocalizedTextSchema,
     svgIconKey: z.string(),
 });
@@ -82,10 +85,12 @@ const BrandingSettingsSchema = z.object({
 
 const UiConfigSchema = z.object({
     subscriptionInfo: z.object({
-        block: z.enum(['collapsed', 'expanded', 'cards', 'hidden']),
+        block: z.nativeEnum(SUBSCRIPTION_INFO_BLOCK_VARIANTS),
     }),
     installationGuides: z.object({
-        block: z.enum(['cards', 'accordion', 'minimal', 'timeline']).default('cards'),
+        block: z
+            .nativeEnum(INSTALLATION_GUIDE_BLOCKS_VARIANTS)
+            .default(INSTALLATION_GUIDE_BLOCKS_VARIANTS.CARDS),
         headerText: LocalizedTextSchema,
     }),
     connectionKeys: z.object({
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.1.0",
+  "version": "0.1.2",
   "public": true,
   "license": "AGPL-3.0-only",
   "description": "A types library for Remnawave Subscription Page.",
diff --git a/src/modules/subscription-page-configs/dtos/subpage-configs.dtos.ts b/src/modules/subscription-page-configs/dtos/subpage-configs.dtos.ts
@@ -7,6 +7,7 @@ import {
     DeleteSubscriptionPageConfigCommand,
     CreateSubscriptionPageConfigCommand,
     ReorderSubscriptionPageConfigsCommand,
+    CloneSubscriptionPageConfigCommand,
 } from '@libs/contracts/commands';
 
 export class GetSubscriptionPageConfigsResponseDto extends createZodDto(
@@ -51,3 +52,10 @@ export class ReorderSubscriptionPageConfigsRequestDto extends createZodDto(
 export class ReorderSubscriptionPageConfigsResponseDto extends createZodDto(
     ReorderSubscriptionPageConfigsCommand.ResponseSchema,
 ) {} // REORDER
+
+export class CloneSubscriptionPageConfigRequestDto extends createZodDto(
+    CloneSubscriptionPageConfigCommand.RequestSchema,
+) {} // CLONE
+export class CloneSubscriptionPageConfigResponseDto extends createZodDto(
+    CloneSubscriptionPageConfigCommand.ResponseSchema,
+) {} // CLONE
diff --git a/src/modules/subscription-page-configs/subpage-configs.controller.ts b/src/modules/subscription-page-configs/subpage-configs.controller.ts
@@ -11,6 +11,7 @@ import { Endpoint } from '@common/decorators/base-endpoint';
 import { Roles } from '@common/decorators/roles/roles';
 import { RolesGuard } from '@common/guards/roles';
 import {
+    CloneSubscriptionPageConfigCommand,
     CreateSubscriptionPageConfigCommand,
     DeleteSubscriptionPageConfigCommand,
     GetSubscriptionPageConfigCommand,
@@ -31,6 +32,8 @@ import {
     CreateSubscriptionPageConfigRequestDto,
     CreateSubscriptionPageConfigResponseDto,
     GetSubscriptionPageConfigRequestDto,
+    CloneSubscriptionPageConfigResponseDto,
+    CloneSubscriptionPageConfigRequestDto,
 } from './dtos/subpage-configs.dtos';
 import { SubscriptionPageConfigService } from './subpage-configs.service';
 
@@ -171,4 +174,26 @@ export class SubscriptionPageConfigController {
             response: data,
         };
     }
+
+    @ApiOkResponse({
+        type: CloneSubscriptionPageConfigResponseDto,
+        description: 'Subscription page config cloned successfully',
+    })
+    @Endpoint({
+        command: CloneSubscriptionPageConfigCommand,
+        httpCode: HttpStatus.OK,
+        apiBody: CloneSubscriptionPageConfigRequestDto,
+    })
+    async cloneSubscriptionPageConfig(
+        @Body() body: CloneSubscriptionPageConfigRequestDto,
+    ): Promise<CloneSubscriptionPageConfigResponseDto> {
+        const result = await this.subscriptionPageConfigService.cloneSubscriptionPageConfig(
+            body.cloneFromUuid,
+        );
+
+        const data = errorHandler(result);
+        return {
+            response: data,
+        };
+    }
 }
diff --git a/src/modules/subscription-page-configs/subpage-configs.service.ts b/src/modules/subscription-page-configs/subpage-configs.service.ts
@@ -1,4 +1,5 @@
 import { PrismaClientKnownRequestError } from '@prisma/client/runtime/library';
+import { nanoid } from 'nanoid';
 
 import { Injectable, Logger } from '@nestjs/common';
 
@@ -198,4 +199,28 @@ export class SubscriptionPageConfigService {
             return fail(ERRORS.GENERIC_REORDER_ERROR);
         }
     }
+
+    public async cloneSubscriptionPageConfig(
+        cloneFromUuid: string,
+    ): Promise<TResult<BaseSubscriptionPageConfigResponseModel>> {
+        try {
+            const config = await this.subscriptionPageConfigRepository.findByUUID(cloneFromUuid);
+
+            if (!config) {
+                return fail(ERRORS.SUBSCRIPTION_PAGE_CONFIG_NOT_FOUND);
+            }
+
+            const newConfig = await this.subscriptionPageConfigRepository.create(
+                new SubscriptionPageConfigEntity({
+                    name: `Clone ${nanoid(5)}`,
+                    config: config.config,
+                }),
+            );
+
+            return ok(new BaseSubscriptionPageConfigResponseModel(newConfig));
+        } catch (error) {
+            this.logger.error(error);
+            return fail(ERRORS.CREATE_SUBSCRIPTION_PAGE_CONFIG_ERROR);
+        }
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+export * from './clone-subpage-config.command';`
`1`	`2`	`export * from './reorder.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.59",`
	`3`	`+ "version": "2.3.61",`
`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.",`