apps/api/src/app/environments-v2/environments.controller.ts - next - githubmirror/novu

apps/api/src/app/environments-v2/environments.controller.ts
143 строки5 KB
Paweł Tymczuk
chore(api-service,application-generic): moved ai workflow generation to enterprise package fixes NV-7165 (#10179)
08 мар 2026, 04:43
08 мар 2026, 04:43a041b79
import {
  Body,
  ClassSerializerInterceptor,
  Controller,
  Get,
  HttpCode,
  Param,
  Post,
  UseInterceptors,
} from '@nestjs/common';
import { ApiBody, ApiOperation, ApiParam, ApiTags } from '@nestjs/swagger';
import {
  GetEnvironmentTags,
  GetEnvironmentTagsCommand,
  GetEnvironmentTagsDto,
  RequirePermissions,
  SkipPermissionsCheck,
} from '@novu/application-generic';
import { PermissionsEnum, UserSessionData } from '@novu/shared';
import { RequireAuthentication } from '../auth/framework/auth.decorator';
import { ExternalApiAccessible } from '../auth/framework/external-api.decorator';
import { ApiCommonResponses, ApiResponse } from '../shared/framework/response.decorator';
import { SdkGroupName, SdkMethodName } from '../shared/framework/swagger/sdk.decorators';
import { UserSession } from '../shared/framework/user.decorator';
import {
  DiffEnvironmentRequestDto,
  DiffEnvironmentResponseDto,
  PublishEnvironmentRequestDto,
  PublishEnvironmentResponseDto,
} from './dtos';
import { DiffEnvironmentCommand } from './usecases/diff-environment/diff-environment.command';
import { DiffEnvironmentUseCase } from './usecases/diff-environment/diff-environment.usecase';
import { PublishEnvironmentCommand } from './usecases/publish-environment/publish-environment.command';
import { PublishEnvironmentUseCase } from './usecases/publish-environment/publish-environment.usecase';

@ApiCommonResponses()
@Controller({ path: `/environments`, version: '2' })
@UseInterceptors(ClassSerializerInterceptor)
@RequireAuthentication()
@ApiTags('Environments')
@SdkGroupName('Environments')
export class EnvironmentsController {
  constructor(
    private getEnvironmentTagsUsecase: GetEnvironmentTags,
    private publishEnvironmentUseCase: PublishEnvironmentUseCase,
    private diffEnvironmentUseCase: DiffEnvironmentUseCase
  ) {}

  @Get('/:environmentId/tags')
  @ApiOperation({
    summary: 'List environment tags',
    description:
      'Retrieve all unique tags used in workflows within the specified environment. These tags can be used for filtering workflows.',
  })
  @ApiParam({
    name: 'environmentId',
    description: 'Environment internal ID (MongoDB ObjectId) or identifier',
    type: String,
    example: '6615943e7ace93b0540ae377',
  })
  @ApiResponse(GetEnvironmentTagsDto, 200, true)
  @SdkMethodName('getTags')
  @ExternalApiAccessible()
  @SkipPermissionsCheck()
  async getEnvironmentTags(
    @UserSession() user: UserSessionData,
    @Param('environmentId') environmentIdOrIdentifier: string
  ): Promise<GetEnvironmentTagsDto[]> {
    return await this.getEnvironmentTagsUsecase.execute(
      GetEnvironmentTagsCommand.create({
        environmentIdOrIdentifier,
        userId: user._id,
        organizationId: user.organizationId,
      })
    );
  }

  @Post('/:targetEnvironmentId/publish')
  @HttpCode(200)
  @ApiOperation({
    summary: 'Publish resources to target environment',
    description:
      'Publishes all workflows and resources from the source environment to the target environment. Optionally specify specific resources to publish or use dryRun mode to preview changes.',
  })
  @ApiParam({
    name: 'targetEnvironmentId',
    description: 'Target environment ID (MongoDB ObjectId) to publish resources to',
    type: String,
    example: '6615943e7ace93b0540ae377',
  })
  @ApiBody({ type: PublishEnvironmentRequestDto, description: 'Publish request configuration' })
  @ApiResponse(PublishEnvironmentResponseDto)
  @ExternalApiAccessible()
  @SdkMethodName('publish')
  @RequirePermissions(PermissionsEnum.ENVIRONMENT_WRITE)
  async publishEnvironment(
    @UserSession() user: UserSessionData,
    @Param('targetEnvironmentId') targetEnvironmentId: string,
    @Body() body: PublishEnvironmentRequestDto
  ): Promise<PublishEnvironmentResponseDto> {
    return await this.publishEnvironmentUseCase.execute(
      PublishEnvironmentCommand.create({
        user,
        sourceEnvironmentId: body.sourceEnvironmentId,
        targetEnvironmentId,
        dryRun: body.dryRun,
        resources: body.resources,
      })
    );
  }

  @Post('/:targetEnvironmentId/diff')
  @HttpCode(200)
  @ApiOperation({
    summary: 'Compare resources between environments',
    description:
      'Compares workflows and other resources between the source and target environments, returning detailed diff information including additions, modifications, and deletions.',
  })
  @ApiParam({
    name: 'targetEnvironmentId',
    description: 'Target environment ID (MongoDB ObjectId) to compare against',
    type: String,
    example: '6615943e7ace93b0540ae377',
  })
  @ApiBody({ type: DiffEnvironmentRequestDto, description: 'Diff request configuration' })
  @ApiResponse(DiffEnvironmentResponseDto)
  @ExternalApiAccessible()
  @SdkMethodName('diff')
  @RequirePermissions(PermissionsEnum.ENVIRONMENT_WRITE)
  async diffEnvironment(
    @UserSession() user: UserSessionData,
    @Param('targetEnvironmentId') targetEnvironmentId: string,
    @Body() body: DiffEnvironmentRequestDto
  ): Promise<DiffEnvironmentResponseDto> {
    return await this.diffEnvironmentUseCase.execute(
      DiffEnvironmentCommand.create({
        user,
        sourceEnvironmentId: body.sourceEnvironmentId,
        targetEnvironmentId,
      })
    );
  }
}