@elsikora/nestjs-crud-automator 1.8.0-dev.2 → 1.9.0-dev.1

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

@@ -1,2 +1,83 @@
-import type { TApiPropertyDescribeProperties } from "../../../type";
+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[];
+ * ```
+ */
 export declare function ApiPropertyDescribe(properties: TApiPropertyDescribeProperties): (target: Record<any, any>, propertyKey: string) => void;

package/dist/esm/decorator/api/property/describe.decorator.js

@@ -0,0 +1,94 @@
+import { MetadataStorage } from '../../../class/metadata-storage.class.js';
+import '../../../constant/decorator/api/function.constant.js';
+import { PROPERTY_DESCRIBE_DECORATOR_API_CONSTANT } from '../../../constant/decorator/api/property-describe.constant.js';
+
+/**
+ * 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[];
+ * ```
+ */
+function ApiPropertyDescribe(properties) {
+    return (target, propertyKey) => {
+        const entityName = target.constructor.name;
+        MetadataStorage.getInstance().setMetadata(entityName, propertyKey, PROPERTY_DESCRIBE_DECORATOR_API_CONSTANT.METADATA_PROPERTY_NAME, properties);
+    };
+}
+
+export { ApiPropertyDescribe };
+//# sourceMappingURL=describe.decorator.js.map

package/dist/esm/decorator/api/property/describe.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"describe.decorator.js","sources":["../../../../../../src/decorator/api/property/describe.decorator.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAKA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgFG;AACG,SAAU,mBAAmB,CAAC,UAA0C,EAAA;AAC7E,IAAA,OAAO,CAAC,MAAwB,EAAE,WAAmB,KAAU;AAC9D,QAAA,MAAM,UAAU,GAAW,MAAM,CAAC,WAAW,CAAC,IAAI;AAClD,QAAA,eAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,UAAU,EAAE,WAAW,EAAE,wCAAwC,CAAC,sBAAsB,EAAE,UAAU,CAAC;AAChJ,KAAC;AACF;;;;"}

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

@@ -1,2 +1,76 @@
-import type { TApiPropertyEnumProperties } from "../../../type/decorator/api/property/enum-properties.type";
+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
+ * @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): <Y>(target: object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/dist/esm/{src/decorator → decorator}/api/property/enum.decorator.js

@@ -3,12 +3,92 @@ import { ApiProperty, ApiResponseProperty } from '@nestjs/swagger';
 import { Expose, Exclude } from 'class-transformer';
 import { IsOptional, IsArray, ArrayMinSize, ArrayMaxSize, ArrayNotEmpty, IsEnum } from 'class-validator';
 
+/**
+ * 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
+ * @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[];
+ * }
+ * ```
+ */
 function ApiPropertyEnum(properties) {
     validateOptions(properties);
     const apiPropertyOptions = buildApiPropertyOptions(properties);
     const decorators = buildDecorators(properties, apiPropertyOptions);
     return applyDecorators(...decorators);
 }
+/**
+ * Builds the API property options object from the provided enum property configuration
+ * @param {TApiPropertyEnumProperties} properties - The enum property configuration
+ * @returns {ApiPropertyOptions} The Swagger API property options object
+ * @private
+ */
 function buildApiPropertyOptions(properties) {
     const apiPropertyOptions = {
         description: `${String(properties.entity.name)} ${properties.description ?? ""}`,
@@ -37,11 +117,24 @@ function buildApiPropertyOptions(properties) {
     apiPropertyOptions.enum = properties.enum;
     return apiPropertyOptions;
 }
+/**
+ * Builds all the necessary decorators for the enum property based on the configuration
+ * @param {TApiPropertyEnumProperties} properties - The enum property configuration
+ * @param {ApiPropertyOptions} apiPropertyOptions - The Swagger API property options
+ * @returns {Array<PropertyDecorator>} An array of decorators to apply to the property
+ * @private
+ */
 function buildDecorators(properties, apiPropertyOptions) {
     const decorators = [ApiProperty(apiPropertyOptions)];
     decorators.push(...buildResponseDecorators(properties), ...buildRequestDecorators(properties), ...buildFormatDecorators(properties));
     return decorators;
 }
+/**
+ * Builds decorators for enum validation
+ * @param {TApiPropertyEnumProperties} properties - The enum property configuration
+ * @returns {Array<PropertyDecorator>} An array of enum validation decorators
+ * @private
+ */
 function buildFormatDecorators(properties) {
     const decorators = [];
     const isArray = properties.isArray ?? false;
@@ -49,6 +142,12 @@ function buildFormatDecorators(properties) {
     decorators.push(IsEnum(properties.enum, { each: isArray }));
     return decorators;
 }
+/**
+ * Builds decorators for request validation including optional status and array validation
+ * @param {TApiPropertyEnumProperties} properties - The enum property configuration
+ * @returns {Array<PropertyDecorator>} An array of request validation decorators
+ * @private
+ */
 function buildRequestDecorators(properties) {
     const decorators = [];
     if (properties.isResponse === false || properties.isResponse === undefined) {
@@ -64,6 +163,12 @@ function buildRequestDecorators(properties) {
     }
     return decorators;
 }
+/**
+ * Builds decorators for response serialization including API response property and expose/exclude
+ * @param {TApiPropertyEnumProperties} properties - The enum property configuration
+ * @returns {Array<PropertyDecorator>} An array of response serialization decorators
+ * @private
+ */
 function buildResponseDecorators(properties) {
     const decorators = [];
     if (properties.isResponse) {
@@ -77,6 +182,13 @@ function buildResponseDecorators(properties) {
     }
     return decorators;
 }
+/**
+ * Validates the configuration options for the API property enum
+ * @param {TApiPropertyEnumProperties} properties - The property configuration to validate
+ * @returns {void}
+ * @throws {Error} If the configuration is invalid
+ * @private
+ */
 function validateOptions(properties) {
     const errors = [];
     if (properties.isArray === true) {

package/dist/esm/decorator/api/property/enum.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enum.decorator.js","sources":["../../../../../../src/decorator/api/property/enum.decorator.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAQA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyEG;AACG,SAAU,eAAe,CAAC,UAAsC,EAAA;IACrE,eAAe,CAAC,UAAU,CAAC;AAE3B,IAAA,MAAM,kBAAkB,GAAuB,uBAAuB,CAAC,UAAU,CAAC;IAClF,MAAM,UAAU,GAA6B,eAAe,CAAC,UAAU,EAAE,kBAAkB,CAAC;AAE5F,IAAA,OAAO,eAAe,CAAC,GAAG,UAAU,CAAC;AACtC;AAEA;;;;;AAKG;AACH,SAAS,uBAAuB,CAAC,UAAsC,EAAA;AACtE,IAAA,MAAM,kBAAkB,GAA6C;AACpE,QAAA,WAAW,EAAE,CAAG,EAAA,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,WAAW,IAAI,EAAE,CAAE,CAAA;;QAEhF,QAAQ,EAAE,UAAU,CAAC,UAAU;KAC/B;IAED,kBAAkB,CAAC,QAAQ,GAAG,UAAU,CAAC,UAAU,KAAK,KAAK,IAAI,UAAU,CAAC,UAAU,KAAK,SAAS,GAAG,UAAU,CAAC,UAAU,GAAG,KAAK;AAEpI,IAAA,IAAI,UAAU,CAAC,OAAO,KAAK,IAAI,EAAE;AAChC,QAAA,kBAAkB,CAAC,OAAO,GAAG,IAAI;AACjC,QAAA,kBAAkB,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ;AACjD,QAAA,kBAAkB,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ;AACjD,QAAA,kBAAkB,CAAC,WAAW,GAAG,UAAU,CAAC,aAAa;AAEzD,QAAA,IAAI,UAAU,CAAC,YAAY,EAAE;YAC5B,kBAAkB,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC,YAAY,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC;;aACnH;AACN,YAAA,kBAAkB,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;;;AAE3D,SAAA,IAAI,UAAU,CAAC,YAAY,EAAE;AACnC,QAAA,kBAAkB,CAAC,OAAO,GAAG,UAAU,CAAC,YAAY;;SAC9C;AACN,QAAA,kBAAkB,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;;AAG/D,IAAA,kBAAkB,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI;AAEzC,IAAA,OAAO,kBAAkB;AAC1B;AAEA;;;;;;AAMG;AACH,SAAS,eAAe,CAAC,UAAsC,EAAE,kBAAsC,EAAA;IACtG,MAAM,UAAU,GAA6B,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAE9E,UAAU,CAAC,IAAI,CAAC,GAAG,uBAAuB,CAAC,UAAU,CAAC,EAAE,GAAG,sBAAsB,CAAC,UAAU,CAAC,EAAE,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAC;AAEpI,IAAA,OAAO,UAAU;AAClB;AAEA;;;;;AAKG;AACH,SAAS,qBAAqB,CAAC,UAAsC,EAAA;IACpE,MAAM,UAAU,GAA6B,EAAE;AAC/C,IAAA,MAAM,OAAO,GAAY,UAAU,CAAC,OAAO,IAAI,KAAK;;AAGpD,IAAA,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;AAE3D,IAAA,OAAO,UAAU;AAClB;AAEA;;;;;AAKG;AACH,SAAS,sBAAsB,CAAC,UAAsC,EAAA;IACrE,MAAM,UAAU,GAA6B,EAAE;AAE/C,IAAA,IAAI,UAAU,CAAC,UAAU,KAAK,KAAK,IAAI,UAAU,CAAC,UAAU,KAAK,SAAS,EAAE;AAC3E,QAAA,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE;AAC3B,YAAA,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;;AAG9B,QAAA,IAAI,UAAU,CAAC,OAAO,KAAK,IAAI,EAAE;YAChC,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;AAEhG,YAAA,IAAI,UAAU,CAAC,QAAQ,GAAG,CAAC,EAAE;AAC5B,gBAAA,UAAU,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;;;;AAKnC,IAAA,OAAO,UAAU;AAClB;AAEA;;;;;AAKG;AACH,SAAS,uBAAuB,CAAC,UAAsC,EAAA;IACtE,MAAM,UAAU,GAA6B,EAAE;AAE/C,IAAA,IAAI,UAAU,CAAC,UAAU,EAAE;AAC1B,QAAA,UAAU,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAEtC,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS,IAAI,UAAU,CAAC,QAAQ,EAAE;AAC7D,YAAA,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;;aACnB;AACN,YAAA,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;;;AAI5B,IAAA,OAAO,UAAU;AAClB;AAEA;;;;;;AAMG;AACH,SAAS,eAAe,CAAC,UAAsC,EAAA;IAC9D,MAAM,MAAM,GAAkB,EAAE;AAEhC,IAAA,IAAI,UAAU,CAAC,OAAO,KAAK,IAAI,EAAE;QAChC,IAAI,UAAU,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,EAAE;AAC9C,YAAA,MAAM,CAAC,IAAI,CAAC,uCAAuC,CAAC;;AAGrD,QAAA,IAAI,UAAU,CAAC,QAAQ,GAAG,CAAC,EAAE;AAC5B,YAAA,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC;;AAGzC,QAAA,IAAI,UAAU,CAAC,QAAQ,GAAG,CAAC,EAAE;AAC5B,YAAA,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC;;QAGzC,IAAI,UAAU,CAAC,aAAa,IAAI,UAAU,CAAC,QAAQ,IAAI,CAAC,EAAE;AACzD,YAAA,MAAM,CAAC,IAAI,CAAC,iEAAiE,CAAC;;;IAIhF,IAAI,UAAU,CAAC,YAAY,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;AACjG,QAAA,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC;;AAG/C,IAAA,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;AACtB,QAAA,MAAM,IAAI,KAAK,CAAC,CAAA,uBAAA,EAA0B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA,CAAC;;AAEhE;;;;"}

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

@@ -1,7 +1,9 @@
-export * from "./boolean.decorator";
-export * from "./date.decorator";
-export * from "./describe.decorator";
-export * from "./number.decorator";
-export * from "./object.decorator";
-export * from "./string.decorator";
-export * from "./uuid.decorator";
+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';

package/dist/esm/decorator/api/property/number.decorator.d.ts

@@ -1,2 +1,68 @@
-import type { TApiPropertyNumberProperties } from "../../../type/decorator/api/property/number-properties.type";
+import type { TApiPropertyNumberProperties } from '../../../type/decorator/api/property/index';
+/**
+ * Creates a decorator that applies NestJS Swagger and class-validator/class-transformer decorators
+ * for number properties in DTOs.
+ *
+ * This decorator handles number properties with support for:
+ * - Integer and double/float formats
+ * - Single numbers or arrays of numbers
+ * - Response/Request specific decorators
+ * - Min/max value constraints
+ * - Multiple-of validation
+ * - Automatic transformation from string to number
+ * - Range validation
+ *
+ * The decorator can automatically generate an example value within the specified range
+ * if one is not provided, and applies appropriate validation rules based on the configuration.
+ * @param {TApiPropertyNumberProperties} properties - Configuration options for the number property
+ * @returns {Function} A decorator function that can be applied to a class property
+ * @example
+ * ```typescript
+ * // Simple integer property
+ * class ProductDto {
+ *   @ApiPropertyNumber({
+ *     entity: { name: 'Product' },
+ *     description: 'quantity',
+ *     format: EApiPropertyNumberType.INTEGER,
+ *     isRequired: true,
+ *     minimum: 1,
+ *     maximum: 100,
+ *     exampleValue: 10
+ *   })
+ *   quantity: number;
+ * }
+ *
+ * // Float property with multiple-of validation
+ * class PriceDto {
+ *   @ApiPropertyNumber({
+ *     entity: { name: 'Price' },
+ *     description: 'amount',
+ *     format: EApiPropertyNumberType.DOUBLE,
+ *     isRequired: true,
+ *     minimum: 0.01,
+ *     maximum: 999999.99,
+ *     multipleOf: 0.01,
+ *     exampleValue: 29.99
+ *   })
+ *   amount: number;
+ * }
+ *
+ * // Array of numbers
+ * class PointsDto {
+ *   @ApiPropertyNumber({
+ *     entity: { name: 'Coordinate' },
+ *     description: 'values',
+ *     format: EApiPropertyNumberType.INTEGER,
+ *     isArray: true,
+ *     minItems: 2,
+ *     maxItems: 3,
+ *     isUniqueItems: true,
+ *     minimum: -180,
+ *     maximum: 180,
+ *     exampleValue: [45, 90, 135]
+ *   })
+ *   coordinates: number[];
+ * }
+ * ```
+ */
 export declare function ApiPropertyNumber(properties: TApiPropertyNumberProperties): <Y>(target: object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;