@elsikora/nestjs-crud-automator/dist/cjs/utility/dto/generate.utility.d.ts

A library for automating the creation of CRUD operations in NestJS.

import type { IApiControllerPropertiesRouteAutoDtoConfig } from '../../interface/decorator/api/index';
import type { IApiEntity } from '../../interface/entity/index';
import type { Type } from "@nestjs/common";
import type { IAuthGuard } from "@nestjs/passport";
import type { ObjectLiteral } from "typeorm";
import { EApiDtoType, EApiRouteType } from '../../enum/decorator/api/index';
/**
 * Core utility for DTO generation that determines which properties should be included in the DTO.
 * Builds decorators, handles special cases like filter queries, and generates the appropriate class
 * based on entity metadata, route type, and DTO type.
 * @param {ObjectLiteral} entity - The entity class or prototype
 * @param {IApiEntity<E>} entityMetadata - The entity metadata containing column information
 * @param {EApiRouteType} method - The API route type (CREATE, DELETE, GET, etc.)
 * @param {EApiDtoType} dtoType - The type of DTO (REQUEST, RESPONSE, etc.)
 * @param {IApiControllerPropertiesRouteAutoDtoConfig} [dtoConfig] - Optional configuration for automatic DTO generation
 * @param {Type<IAuthGuard>} [currentGuard] - Optional authentication guard for property visibility control
 * @returns {Type<unknown> | undefined} The generated DTO class or undefined if no DTO should be generated
 * @throws {Error} When primary key metadata is missing
 * @template E - The entity type
 */
export declare function DtoGenerate<E>(entity: ObjectLiteral, entityMetadata: IApiEntity<E>, method: EApiRouteType, dtoType: EApiDtoType, dtoConfig?: IApiControllerPropertiesRouteAutoDtoConfig, currentGuard?: Type<IAuthGuard>): Type<unknown> | undefined;