@elsikora/nestjs-crud-automator 2.0.1 → 2.0.2-dev.1

package/dist/esm/src/constant/class/index.d.ts

@@ -1 +0,0 @@
-export * from './authorization/index';

package/dist/esm/src/constant/decorator/api/function.constant.d.ts

@@ -1,4 +0,0 @@
-import { EFilterOrderDirection } from '../../../enum/filter/index';
-export declare const FUNCTION_API_DECORATOR_CONSTANT: {
-    readonly DEFAULT_FILTER_ORDER_BY_DIRECTION: EFilterOrderDirection;
-};

package/dist/esm/src/constant/decorator/api/index.d.ts

@@ -1,4 +0,0 @@
-export { CONTROLLER_API_DECORATOR_CONSTANT } from './controller.constant';
-export { FUNCTION_API_DECORATOR_CONSTANT } from './function.constant';
-export { METHOD_API_DECORATOR_CONSTANT } from './method.constant';
-export { PROPERTY_DESCRIBE_DECORATOR_API_CONSTANT } from './property-describe.constant';

package/dist/esm/src/constant/decorator/index.d.ts

@@ -1 +0,0 @@
-export * from './api/index';

package/dist/esm/src/constant/dto/index.d.ts

@@ -1,5 +0,0 @@
-export { AUTO_CONTEXT_DTO_CONSTANT } from './auto-context.constant';
-export { CONTEXTUAL_MANUAL_DTO_CONSTANT } from './contextual-manual.constant';
-export { EXCEPTION_DTO_CONSTANT } from './exception.constant';
-export { LIST_DTO_CONSTANT } from './list.constant';
-export { TRANSFORMER_VALUE_DTO_CONSTANT } from './transformer-value.constant';

package/dist/esm/src/constant/index.d.ts

@@ -1,9 +0,0 @@
-export * from './class/index';
-export { DATE_CONSTANT } from './date.constant';
-export * from './decorator/index';
-export * from './dto/index';
-export { GET_LIST_QUERY_DTO_FACTORY_CONSTANT } from './factory-dto-get-list-query.constant';
-export * from './interface/index';
-export { NUMBER_CONSTANT } from './number.constant';
-export * from './utility/index';
-export * from './validator/index';

package/dist/esm/src/constant/interface/api/index.d.ts

@@ -1,2 +0,0 @@
-export { FILTER_API_INTERFACE_CONSTANT } from './filter.constant';
-export * from './property/index';

package/dist/esm/src/constant/interface/api/property/default-string-format.constant.d.ts

@@ -1,4 +0,0 @@
-import type { TApiPropertyDefaultStringFormat, TApiPropertyDefaultStringFormatProperties } from '../../../../type/decorator/api/property/default/string/index';
-export declare const DEFAULT_STRING_FORMAT_PROPERTY_API_INTERFACE_CONSTANT: {
-    readonly DEFAULT_FORMAT_PROPERTIES: Record<TApiPropertyDefaultStringFormat, TApiPropertyDefaultStringFormatProperties>;
-};

package/dist/esm/src/constant/interface/api/property/index.d.ts

@@ -1,3 +0,0 @@
-export { DEFAULT_STRING_FORMAT_PROPERTY_API_INTERFACE_CONSTANT } from './default-string-format.constant';
-export { STRING_PROPERTY_API_INTERFACE_CONSTANT } from './string.constant';
-export { WALLET_PROPERTY_API_INTERFACE_CONSTANT } from './wallet.constant';

package/dist/esm/src/constant/interface/index.d.ts

@@ -1 +0,0 @@
-export * from './api/index';

package/dist/esm/src/constant/utility/dto/constant.d.ts

@@ -1,7 +0,0 @@
-import type { IDtoStrategy } from '../../../interface/class/index';
-import type { IDtoGenerateFactory } from '../../../interface/dto-generate-factory.interface';
-import { EApiDtoType, EApiPropertyDescribeType } from '../../../enum/decorator/api/index';
-export declare const DTO_UTILITY_CONSTANT: {
-    readonly DTO_STRATEGIES: Record<EApiDtoType, IDtoStrategy>;
-    readonly PROPERTY_DECORATOR_FACTORIES: Record<EApiPropertyDescribeType, IDtoGenerateFactory<unknown>>;
-};

package/dist/esm/src/constant/utility/dto/index.d.ts

@@ -1,2 +0,0 @@
-export { DTO_UTILITY_CONSTANT } from './constant';
-export { DTO_GENERATE_CONSTANT } from './generate.constant';

package/dist/esm/src/constant/utility/index.d.ts

@@ -1 +0,0 @@
-export * from './dto/index';

package/dist/esm/src/constant/validator/index.d.ts

@@ -1 +0,0 @@
-export { VALIDATOR_HAS_PAIRED_CUSTOM_SUFFIXES_FIELDS_CONSTANT } from '../validator-has-paired-custom-suffixes-fields.constant';

package/dist/esm/src/constant/validator-has-paired-custom-suffixes-fields.constant.d.ts

@@ -1,5 +0,0 @@
-import type { THasPairedCustomSuffixesFieldsOperationConfig } from '../type/validator/has-paired-custom-suffixes-fields/index';
-import { EFilterOperation } from '../enum/filter/index';
-export declare const VALIDATOR_HAS_PAIRED_CUSTOM_SUFFIXES_FIELDS_CONSTANT: {
-    readonly DEFAULT_OPERATION_CONFIGS: Record<EFilterOperation, THasPairedCustomSuffixesFieldsOperationConfig>;
-};

package/dist/esm/src/decorator/api/authorization-policy.decorator.d.ts

@@ -1,10 +0,0 @@
-import type { IApiBaseEntity } from '../../interface/api-base-entity.interface';
-import type { IApiAuthorizationPolicySubscriberProperties } from '../../interface/class/api/authorization/policy/subscriber/properties.interface';
-/**
- * Decorator that registers a class as an authorization policy for a specific entity.
- * @template E - Entity type extending IApiBaseEntity
- * @param {IApiAuthorizationPolicySubscriberProperties<E>} properties - Policy properties.
- * @returns {ClassDecorator} Class decorator registering metadata for discovery.
- * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators/api-authorization/api-authorization-policy | API Reference - ApiAuthorizationPolicy}
- */
-export declare function ApiAuthorizationPolicy<E extends IApiBaseEntity>(properties: IApiAuthorizationPolicySubscriberProperties<E>): ClassDecorator;

package/dist/esm/src/decorator/api/controller/decorator.d.ts

@@ -1,27 +0,0 @@
-import type { IApiBaseEntity } from '../../../interface/api-base-entity.interface';
-import type { IApiControllerProperties } from '../../../interface/decorator/api/index';
-import type { TApiControllerConstructor } from '../../../type/decorator/api/controller/index';
-/**
- * Automatically generates CRUD endpoints for an entity.
- * @param {IApiControllerProperties<E>} options - The controller properties
- * @returns {TApiControllerConstructor} The controller constructor
- * @template E - The entity type
- * @example
- * ```typescript
- * @ApiController<UserEntity>({
- *   entity: UserEntity,
- *   name: "Users",
- *   routes: {
- *     [EApiRouteType.CREATE]: {},
- *     [EApiRouteType.GET]: {},
- *     [EApiRouteType.GET_LIST]: {},
- *     [EApiRouteType.UPDATE]: {},
- *     [EApiRouteType.DELETE]: {},
- *   },
- * })
- * export class UserController {}
- * ```
- * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators/api-controller/api-controller | API Reference - ApiController}
- * @see {@link https://elsikora.com/docs/nestjs-crud-automator/core-concepts/controllers | Core Concepts - Controllers}
- */
-export declare const ApiController: <E extends IApiBaseEntity>(options: IApiControllerProperties<E>) => <T extends TApiControllerConstructor>(target: T) => T;

package/dist/esm/src/decorator/api/controller/index.d.ts

@@ -1,3 +0,0 @@
-export { ApiController } from './decorator';
-export { ApiControllerObservable } from './observable.decorator';
-export { ApiControllerSecurable } from './securable.decorator';

package/dist/esm/src/decorator/api/function/create.decorator.d.ts

@@ -1,10 +0,0 @@
-import type { IApiBaseEntity } from '../../../interface/api-base-entity.interface';
-import type { IApiFunctionProperties } from '../../../interface/decorator/api/index';
-/**
- * Creates a decorator that adds entity creation functionality to a service method
- * @template E The entity type
- * @param {IApiFunctionProperties<E>} properties - Configuration properties for the create function
- * @returns {(target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor} A decorator function that modifies the target method to handle entity creation
- * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators/api-function/api-function-create | API Reference - ApiFunctionCreate}
- */
-export declare function ApiFunctionCreate<E extends IApiBaseEntity>(properties: IApiFunctionProperties<E>): (target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/dist/esm/src/decorator/api/function/custom.decorator.d.ts

@@ -1,9 +0,0 @@
-import type { IApiBaseEntity } from '../../../interface/api-base-entity.interface';
-import type { IApiFunctionCustomProperties } from '../../../interface/decorator/api/function/index';
-/**
- * Creates a decorator that executes custom service functions through the ApiFunction runtime.
- * @template E - Entity type handled by the decorated service.
- * @param {IApiFunctionCustomProperties<E>} properties - Custom function configuration and lifecycle metadata.
- * @returns {(target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor} A method decorator that wraps the original function.
- */
-export declare function ApiFunctionCustom<E extends IApiBaseEntity>(properties: IApiFunctionCustomProperties<E>): (target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/dist/esm/src/decorator/api/function/decorator.d.ts

@@ -1,11 +0,0 @@
-import type { IApiBaseEntity } from '../../../interface/api-base-entity.interface';
-import type { TApiFunctionProperties } from '../../../type/decorator/api/function/index';
-/**
- * Main decorator factory for API service functions that selects and applies the appropriate function decorator
- * based on the specified type (create, update, delete, get, getList, getMany)
- * @param {TApiFunctionProperties<E>} properties - Configuration properties for the API function
- * @returns {(target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor} A decorator function that applies the appropriate function decorator
- * @template E - The entity type for the API function
- * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators/api-function/api-function | API Reference - ApiFunction}
- */
-export declare function ApiFunction<E extends IApiBaseEntity, R>(properties: TApiFunctionProperties<E>): (target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/dist/esm/src/decorator/api/function/delete.decorator.d.ts

@@ -1,10 +0,0 @@
-import type { IApiBaseEntity } from '../../../interface/api-base-entity.interface';
-import type { IApiFunctionProperties } from '../../../interface/decorator/api/index';
-/**
- * Creates a decorator that adds entity deletion functionality to a service method
- * @template E The entity type
- * @param {IApiFunctionProperties<E>} properties - Configuration properties for the delete function
- * @returns {(target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor} A decorator function that modifies the target method to handle entity deletion
- * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators/api-function/api-function-delete | API Reference - ApiFunctionDelete}
- */
-export declare function ApiFunctionDelete<E extends IApiBaseEntity>(properties: IApiFunctionProperties<E>): (target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/dist/esm/src/decorator/api/function/get/decorator.d.ts

@@ -1,10 +0,0 @@
-import type { IApiBaseEntity } from '../../../../interface/api-base-entity.interface';
-import type { IApiFunctionProperties } from '../../../../interface/decorator/api/index';
-/**
- * Creates a decorator that adds single entity retrieval functionality to a service method
- * @template E The entity type
- * @param {IApiFunctionProperties<E>} properties - Configuration properties for the get function
- * @returns {(target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor} A decorator function that modifies the target method to handle single entity retrieval
- * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators/api-function/api-function-get | API Reference - ApiFunctionGet}
- */
-export declare function ApiFunctionGet<E extends IApiBaseEntity>(properties: IApiFunctionProperties<E>): (target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/dist/esm/src/decorator/api/function/get/index.d.ts

@@ -1,3 +0,0 @@
-export { ApiFunctionGet } from './decorator';
-export { ApiFunctionGetList } from './list.decorator';
-export { ApiFunctionGetMany } from './many.decorator';

package/dist/esm/src/decorator/api/function/get/list.decorator.d.ts

@@ -1,10 +0,0 @@
-import type { IApiBaseEntity } from '../../../../interface/api-base-entity.interface';
-import type { IApiFunctionProperties } from '../../../../interface/decorator/api/index';
-/**
- * Creates a decorator that adds entity list retrieval functionality to a service method
- * @template E The entity type
- * @param {IApiFunctionProperties<E>} properties - Configuration properties for the get-list function
- * @returns {(target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor} A decorator function that modifies the target method to handle entity list retrieval
- * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators/api-function/api-function-get-list | API Reference - ApiFunctionGetList}
- */
-export declare function ApiFunctionGetList<E extends IApiBaseEntity>(properties: IApiFunctionProperties<E>): (target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/dist/esm/src/decorator/api/function/get/many.decorator.d.ts

@@ -1,10 +0,0 @@
-import type { IApiBaseEntity } from '../../../../interface/api-base-entity.interface';
-import type { IApiFunctionProperties } from '../../../../interface/decorator/api/index';
-/**
- * Creates a decorator that adds functionality to retrieve multiple entities to a service method
- * @template E The entity type
- * @param {IApiFunctionProperties<E>} properties - Configuration properties for the get-many function
- * @returns {(target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor} A decorator function that modifies the target method to handle retrieving multiple entities
- * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators/api-function/api-function-get-many | API Reference - ApiFunctionGetMany}
- */
-export declare function ApiFunctionGetMany<E extends IApiBaseEntity>(properties: IApiFunctionProperties<E>): (target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/dist/esm/src/decorator/api/function/index.d.ts

@@ -1,6 +0,0 @@
-export { ApiFunctionCreate } from './create.decorator';
-export { ApiFunctionCustom } from './custom.decorator';
-export { ApiFunction } from './decorator';
-export { ApiFunctionDelete } from './delete.decorator';
-export * from './get/index';
-export { ApiFunctionUpdate } from './update.decorator';

package/dist/esm/src/decorator/api/function/update.decorator.d.ts

@@ -1,10 +0,0 @@
-import type { IApiBaseEntity } from '../../../interface/api-base-entity.interface';
-import type { IApiFunctionProperties } from '../../../interface/decorator/api/function/index';
-/**
- * Creates a decorator that adds entity update functionality to a service method
- * @template E The entity type
- * @param {IApiFunctionProperties<E>} properties - Configuration properties for the update function
- * @returns {(target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor} A decorator function that modifies the target method to handle entity updates
- * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators/api-function/api-function-update | API Reference - ApiFunctionUpdate}
- */
-export declare function ApiFunctionUpdate<E extends IApiBaseEntity>(properties: IApiFunctionProperties<E>): (target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/dist/esm/src/decorator/api/index.d.ts

@@ -1,8 +0,0 @@
-export * from './authorization-policy.decorator';
-export * from './controller/index';
-export * from './function/index';
-export * from './method.decorator';
-export * from './property/index';
-export { ApiRouteCustom } from './route-custom.decorator';
-export * from './service/index';
-export * from './subscriber/index';

package/dist/esm/src/decorator/api/method.decorator.d.ts

@@ -1,9 +0,0 @@
-import type { IApiBaseEntity } from '../../interface/api-base-entity.interface';
-import type { IApiMethodProperties } from '../../interface/decorator/api/index';
-/**
- * Composes Nest route, Swagger, throttling, authentication, and route metadata decorators.
- * @template E - Entity type represented by the route metadata.
- * @param {IApiMethodProperties<E>} options - Route metadata used to build the composed method decorator.
- * @returns {MethodDecorator} A decorator for a controller method.
- */
-export declare function ApiMethod<E extends IApiBaseEntity>(options: IApiMethodProperties<E>): MethodDecorator;

package/dist/esm/src/decorator/api/property/boolean.decorator.d.ts

@@ -1,54 +0,0 @@
-import type { TApiPropertyBaseProperties } from '../../../type/decorator/api/property/index';
-/**
- * Creates a decorator that applies NestJS Swagger and class-validator/class-transformer decorators
- * for boolean properties in DTOs.
- *
- * This decorator handles boolean properties with support for:
- * - Single boolean values or arrays of booleans
- * - Response/Request specific decorators
- * - Intelligent type conversion from various input types to boolean
- * - Array validation with min/max items
- * - Nullable values
- *
- * The decorator provides smart type conversion that handles string values ('true'/'false', '1'/'0'),
- * number values (0/non-zero), and proper boolean values. This makes it robust when working with
- * form data and query parameters.
- * @param {TApiPropertyBaseProperties} properties - Configuration options for the boolean property
- * @returns {Function} A decorator function that can be applied to a class property
- * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators/api-property/api-property-boolean | API Reference - ApiPropertyBoolean}
- * @example
- * ```typescript
- * // Simple boolean property
- * class UserDto {
- *   @ApiPropertyBoolean({
- *     entity: { name: 'User' },
- *     description: 'is active',
- *     isRequired: true
- *   })
- *   isActive: boolean;
- * }
- *
- * // Optional boolean property
- * class ProductDto {
- *   @ApiPropertyBoolean({
- *     entity: { name: 'Product' },
- *     description: 'is featured',
- *     isRequired: false
- *   })
- *   isFeatured?: boolean;
- * }
- *
- * // Array of boolean flags
- * class PermissionsDto {
- *   @ApiPropertyBoolean({
- *     entity: { name: 'Permission' },
- *     description: 'flags',
- *     isArray: true,
- *     minItems: 1,
- *     maxItems: 10
- *   })
- *   flags: boolean[];
- * }
- * ```
- */
-export declare function ApiPropertyBoolean(properties: TApiPropertyBaseProperties): PropertyDecorator;

package/dist/esm/src/decorator/api/property/copy.decorator.d.ts

@@ -1,36 +0,0 @@
-import type { TApiPropertyCopyProperties } from '../../../type/decorator/api/property/copy-properties.type';
-/**
- * Copies every generated decorator (Swagger metadata, validators, transformers, DTO hooks) from an entity property
- * onto a manual DTO property.
- *
- * Supports:
- * - Direct entity references or lazy factories to break circular imports
- * - Overriding the source route/method (`method` + `dtoType`)
- * - Guard-aware decorator copies (pass the guard used during auto DTO generation)
- * - Metadata extension (supply `metadata` to merge additional describe fields)
- * - Auto context resolution for nested DTOs generated through the CRUD automator pipeline
- * @example
- * ```ts
- * class DepositCallbackRequestBodyDto {
- *   @ApiPropertyCopy({
- *     entity: () => Deposit,
- *     propertyName: "status",
- *     method: EApiRouteType.GET,
- *     dtoType: EApiDtoType.RESPONSE,
- *   })
- *   status!: EDepositStatus;
- *
- *   @ApiPropertyCopy({
- *     entity: () => Deposit,
- *     propertyName: "amount",
- *     shouldAutoResolveContext: true,
- *   })
- *   amount!: number;
- * }
- * ```
- * @template E
- * @param {TApiPropertyCopyProperties<E>} properties - Configuration describing which entity property to mirror.
- * @returns {PropertyDecorator} Property decorator that applies copied metadata.
- * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators/api-property/api-property-copy | API Reference - ApiPropertyCopy}
- */
-export declare function ApiPropertyCopy<E>(properties: TApiPropertyCopyProperties<E>): PropertyDecorator;

package/dist/esm/src/decorator/api/property/date.decorator.d.ts

@@ -1,58 +0,0 @@
-import type { TApiPropertyDateProperties } from '../../../type/decorator/api/property/index';
-/**
- * Creates a decorator that applies NestJS Swagger and class-validator/class-transformer decorators
- * for date properties in DTOs.
- *
- * This decorator handles date properties with support for:
- * - Various date formats (date, datetime, time)
- * - Predefined date types (createdAt, updatedAt, expiresIn, etc.)
- * - Single dates or arrays of dates
- * - Response/Request specific decorators
- * - Automatic transformation from string to Date objects
- * - Validation with appropriate patterns for each format
- *
- * The decorator provides appropriate examples and validation patterns based on the format,
- * and handles string-to-Date transformation for request DTOs.
- * @param {TApiPropertyDateProperties} properties - Configuration options for the date property
- * @returns {Function} A decorator function that can be applied to a class property
- * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators/api-property/api-property-date | API Reference - ApiPropertyDate}
- * @example
- * ```typescript
- * // Simple date property (YYYY-MM-DD)
- * class EventDto {
- *   @ApiPropertyDate({
- *     entity: { name: 'Event' },
- *     identifier: EApiPropertyDateIdentifier.DATE,
- *     format: EApiPropertyDateType.DATE,
- *     isRequired: true
- *   })
- *   date: Date;
- * }
- *
- * // DateTime property for createdAt (ISO format)
- * class UserDto {
- *   @ApiPropertyDate({
- *     entity: { name: 'User' },
- *     identifier: EApiPropertyDateIdentifier.CREATED_AT,
- *     format: EApiPropertyDateType.DATE_TIME,
- *     isResponse: true
- *   })
- *   createdAt: Date;
- * }
- *
- * // Array of time values
- * class ScheduleDto {
- *   @ApiPropertyDate({
- *     entity: { name: 'Schedule' },
- *     identifier: EApiPropertyDateIdentifier.DATE,
- *     format: EApiPropertyDateType.TIME,
- *     isArray: true,
- *     minItems: 1,
- *     maxItems: 10,
- *     isUniqueItems: true
- *   })
- *   availableTimes: Date[];
- * }
- * ```
- */
-export declare function ApiPropertyDate(properties: TApiPropertyDateProperties): PropertyDecorator;

package/dist/esm/src/decorator/api/property/describe.decorator.d.ts

@@ -1,85 +0,0 @@
-import type { TApiPropertyDescribeProperties } from '../../../type/decorator/api/property/index';
-/**
- * Creates a decorator for entity properties that provides metadata used for automatic
- * DTO generation, validation rules, and Swagger documentation.
- *
- * This decorator serves as the foundation for the automated CRUD system by storing
- * property metadata that is later used to:
- * - Generate appropriate DTOs for requests and responses
- * - Apply validation rules based on the property type
- * - Generate Swagger/OpenAPI documentation
- * - Enable intelligent filtering and sorting for list operations
- *
- * The decorator accepts various property types including string, number, boolean, date,
- * enum, UUID, object, and relation properties, each with their specific configuration options.
- * @param {TApiPropertyDescribeProperties} properties - Configuration options for the property,
- *   which varies based on the property type (string, number, boolean, date, enum, UUID, object, relation)
- * @returns {PropertyDecorator} A decorator function that can be applied to entity properties
- * @example
- * ```typescript
- * // UUID property (primary key)
- * @PrimaryGeneratedColumn('uuid')
- * @ApiPropertyDescribe({
- *   type: EApiPropertyDescribeType.UUID,
- *   description: 'Unique identifier'
- * })
- * id: string;
- *
- * // String property with validation rules
- * @Column()
- * @ApiPropertyDescribe({
- *   type: EApiPropertyDescribeType.STRING,
- *   description: 'User name',
- *   format: EApiPropertyStringType.STRING,
- *   minLength: 3,
- *   maxLength: 50,
- *   pattern: '/^[a-zA-Z0-9_-]+$/',
- *   exampleValue: 'john_doe'
- * })
- * username: string;
- *
- * // Number property
- * @Column()
- * @ApiPropertyDescribe({
- *   type: EApiPropertyDescribeType.NUMBER,
- *   description: 'User age',
- *   format: EApiPropertyNumberType.INTEGER,
- *   minimum: 18,
- *   maximum: 120,
- *   exampleValue: 25
- * })
- * age: number;
- *
- * // Enum property
- * @Column({
- *   type: 'enum',
- *   enum: UserRole,
- *   default: UserRole.USER
- * })
- * @ApiPropertyDescribe({
- *   type: EApiPropertyDescribeType.ENUM,
- *   description: 'User role',
- *   enum: UserRole,
- *   enumName: 'UserRole',
- *   defaultValue: UserRole.USER
- * })
- * role: UserRole;
- *
- * // Relation property
- * @OneToMany(() => Post, post => post.author)
- * @ApiPropertyDescribe({
- *   type: EApiPropertyDescribeType.RELATION,
- *   description: 'User posts',
- *   isArray: true,
- *   relationMetadata: {
- *     relationType: 'one-to-many',
- *     entity: Post,
- *     isEager: false
- *   }
- * })
- * posts: Post[];
- * ```
- * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators/api-property/api-property-describe | API Reference - ApiPropertyDescribe}
- * @see {@link https://elsikora.com/docs/nestjs-crud-automator/core-concepts/entities | Core Concepts - Entities}
- */
-export declare function ApiPropertyDescribe(properties: TApiPropertyDescribeProperties): PropertyDecorator;

package/dist/esm/src/decorator/api/property/enum.decorator.d.ts

@@ -1,77 +0,0 @@
-import type { TApiPropertyEnumProperties } from '../../../type/decorator/api/property/enum-properties.type';
-/**
- * Creates a decorator that applies NestJS Swagger and class-validator/class-transformer decorators
- * for enum properties in DTOs.
- *
- * This decorator handles enum properties with support for:
- * - TypeScript enums (both string and numeric)
- * - Single enum values or arrays of enum values
- * - Response/Request specific decorators
- * - Validation to ensure values match enum options
- * - Array validation with min/max items
- * - Automatic generation of example values from enum
- * - Swagger/OpenAPI documentation for enum values
- *
- * The decorator provides proper validation and documentation of enum values, ensuring
- * that only valid options are accepted in requests and properly documented in the API.
- * @param {TApiPropertyEnumProperties} properties - Configuration options for the enum property
- * @returns {Function} A decorator function that can be applied to a class property
- * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators/api-property/api-property-enum | API Reference - ApiPropertyEnum}
- * @example
- * ```typescript
- * // String enum example
- * enum UserRole {
- *   ADMIN = 'admin',
- *   USER = 'user',
- *   GUEST = 'guest'
- * }
- *
- * class UserDto {
- *   @ApiPropertyEnum({
- *     entity: { name: 'User' },
- *     description: 'user role',
- *     enum: UserRole,
- *     enumName: 'UserRole',
- *     isRequired: true,
- *     exampleValue: UserRole.USER
- *   })
- *   role: UserRole;
- * }
- *
- * // Numeric enum example
- * enum Status {
- *   ACTIVE = 1,
- *   INACTIVE = 0,
- *   PENDING = 2
- * }
- *
- * class ProductDto {
- *   @ApiPropertyEnum({
- *     entity: { name: 'Product' },
- *     description: 'status',
- *     enum: Status,
- *     enumName: 'Status',
- *     isRequired: true,
- *     exampleValue: Status.ACTIVE
- *   })
- *   status: Status;
- * }
- *
- * // Array of enum values
- * class PermissionsDto {
- *   @ApiPropertyEnum({
- *     entity: { name: 'Permission' },
- *     description: 'user roles',
- *     enum: UserRole,
- *     enumName: 'UserRole',
- *     isArray: true,
- *     minItems: 1,
- *     maxItems: 3,
- *     isUniqueItems: true,
- *     exampleValue: [UserRole.USER, UserRole.ADMIN]
- *   })
- *   roles: UserRole[];
- * }
- * ```
- */
-export declare function ApiPropertyEnum(properties: TApiPropertyEnumProperties): PropertyDecorator;

package/dist/esm/src/decorator/api/property/index.d.ts

@@ -1,9 +0,0 @@
-export { ApiPropertyBoolean } from './boolean.decorator';
-export { ApiPropertyCopy } from './copy.decorator';
-export { ApiPropertyDate } from './date.decorator';
-export { ApiPropertyDescribe } from './describe.decorator';
-export { ApiPropertyEnum } from './enum.decorator';
-export { ApiPropertyNumber } from './number.decorator';
-export { ApiPropertyObject } from './object.decorator';
-export { ApiPropertyString } from './string.decorator';
-export { ApiPropertyUUID } from './uuid.decorator';