hexabot/api/src/nlp/dto/nlp-entity.dto.ts

/*
 * Copyright © 2025 Hexastack. All rights reserved.
 *
 * Licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms:
 * 1. The name "Hexabot" is a trademark of Hexastack. You may not use this name in derivative works without express written permission.
 * 2. All derivative works must include clear attribution to the original creator and software, Hexastack and Hexabot, in a prominent location (e.g., in the software's "About" section, documentation, and README file).
 */

import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
import {
  IsArray,
  IsBoolean,
  IsIn,
  IsNotEmpty,
  IsNumber,
  IsOptional,
  IsString,
  Matches,
  Validate,
} from 'class-validator';

import { DtoConfig } from '@/utils/types/dto.types';

import { Lookup, LookupStrategy } from '../schemas/types';

export class NlpEntityCreateDto {
  @ApiProperty({ description: 'Name of the nlp entity', type: String })
  @Matches(/^[a-zA-Z0-9_]+$/, {
    message: 'Only alphanumeric characters and underscores are allowed.',
  })
  @IsNotEmpty()
  name: string;

  @ApiPropertyOptional({
    isArray: true,
    enum: Object.values(LookupStrategy),
  })
  @IsArray()
  @IsIn(Object.values(LookupStrategy), { each: true })
  @IsOptional()
  lookups?: Lookup[];

  @ApiPropertyOptional({ type: String })
  @IsString()
  @IsOptional()
  doc?: string;

  @ApiPropertyOptional({ description: 'Nlp entity is builtin', type: Boolean })
  @IsBoolean()
  @IsOptional()
  builtin?: boolean;

  @ApiPropertyOptional({
    description: 'Nlp entity associated weight for next block triggering',
    type: Number,
  })
  @IsOptional()
  @Validate((value: number) => value > 0, {
    message: 'Weight must be a strictly positive number',
  })
  @IsNumber({ allowNaN: false, allowInfinity: false })
  weight?: number;
}

export class NlpEntityUpdateDto {
  @ApiPropertyOptional({ description: 'Name of the nlp entity', type: String })
  @Matches(/^[a-zA-Z0-9_]+$/, {
    message: 'Only alphanumeric characters and underscores are allowed.',
  })
  @IsString()
  @IsOptional()
  name?: string;

  @ApiPropertyOptional({ type: String })
  @IsString()
  @IsOptional()
  foreign_id?: string;

  @ApiPropertyOptional({
    description: 'Nlp entity associated weight for next block triggering',
    type: Number,
  })
  @IsOptional()
  @Validate((value: number) => value > 0, {
    message: 'Weight must be a strictly positive number',
  })
  @IsNumber({ allowNaN: false, allowInfinity: false })
  weight?: number;
}

export type NlpEntityDto = DtoConfig<{
  create: NlpEntityCreateDto;
  update: NlpEntityUpdateDto;
}>;