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

package/dist/cjs/decorator/api/property/date.decorator.js

@@ -1,9 +1,5 @@
 'use strict';
 
-var common = require('@nestjs/common');
-var swagger = require('@nestjs/swagger');
-var classTransformer = require('class-transformer');
-var classValidator = require('class-validator');
 require('../../../enum/decorator/api/action.enum.js');
 require('../../../enum/decorator/api/authentication-type.enum.js');
 require('../../../enum/decorator/api/controller/load-relations-strategy.enum.js');
@@ -17,16 +13,78 @@ require('../../../enum/decorator/api/property/desribe-type.enum.js');
 require('../../../enum/decorator/api/property/number-type.enum.js');
 require('../../../enum/decorator/api/property/string-type.enum.js');
 require('../../../enum/decorator/api/route-type.enum.js');
-require('../../../enum/exception.enum.js');
-require('../../../enum/filter-order-direction.enum.js');
-require('../../../enum/utility/error-string-action.enum.js');
+var common = require('@nestjs/common');
+var swagger = require('@nestjs/swagger');
+var classTransformer = require('class-transformer');
+var classValidator = require('class-validator');
 
+/**
+ * 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
+ * @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[];
+ * }
+ * ```
+ */
 function ApiPropertyDate(properties) {
     validateOptions(properties);
     const apiPropertyOptions = buildApiPropertyOptions(properties);
     const decorators = buildDecorators(properties, apiPropertyOptions);
     return common.applyDecorators(...decorators);
 }
+/**
+ * Builds the API property options object from the provided date property configuration
+ * @param {TApiPropertyDateProperties} properties - The date property configuration
+ * @returns {ApiPropertyOptions} The Swagger API property options object
+ * @private
+ */
 function buildApiPropertyOptions(properties) {
     const example = getExample(properties.format);
     const apiPropertyOptions = {
@@ -56,11 +114,25 @@ function buildApiPropertyOptions(properties) {
     apiPropertyOptions.format = properties.format;
     return apiPropertyOptions;
 }
+/**
+ * Builds all the necessary decorators for the date property based on the configuration
+ * @param {TApiPropertyDateProperties} properties - The date 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 = [swagger.ApiProperty(apiPropertyOptions)];
     decorators.push(...buildResponseDecorators(properties), ...buildRequestDecorators(properties), ...buildFormatDecorators(properties), ...buildTransformDecorators(properties));
     return decorators;
 }
+/**
+ * Builds decorators for date format validation.
+ * Applies IsDate validator with appropriate configuration for single values or arrays.
+ * @param {TApiPropertyDateProperties} properties - The property configuration
+ * @returns {Array<PropertyDecorator>} An array of date format validation decorators
+ * @private
+ */
 function buildFormatDecorators(properties) {
     const decorators = [];
     const isArray = properties.isArray ?? false;
@@ -70,6 +142,13 @@ function buildFormatDecorators(properties) {
     }
     return decorators;
 }
+/**
+ * Builds decorators for request validation including optional status,
+ * array validation, and size constraints for date properties.
+ * @param {TApiPropertyDateProperties} properties - The property configuration
+ * @returns {Array<PropertyDecorator>} An array of request validation decorators
+ * @private
+ */
 function buildRequestDecorators(properties) {
     const decorators = [];
     if (properties.isResponse === false || properties.isResponse === undefined) {
@@ -85,6 +164,13 @@ function buildRequestDecorators(properties) {
     }
     return decorators;
 }
+/**
+ * Builds decorators for response serialization including API response property,
+ * expose, and exclude decorators for date properties.
+ * @param {TApiPropertyDateProperties} properties - The property configuration
+ * @returns {Array<PropertyDecorator>} An array of response serialization decorators
+ * @private
+ */
 function buildResponseDecorators(properties) {
     const decorators = [];
     if (properties.isResponse) {
@@ -98,6 +184,14 @@ function buildResponseDecorators(properties) {
     }
     return decorators;
 }
+/**
+ * Builds decorators for type transformation from string to Date objects.
+ * Handles both single values and arrays with appropriate transformers,
+ * including special handling for null/undefined values.
+ * @param {TApiPropertyDateProperties} properties - The property configuration
+ * @returns {Array<PropertyDecorator>} An array of type transformation decorators
+ * @private
+ */
 function buildTransformDecorators(properties) {
     const decorators = [];
     if (!properties.isResponse) {
@@ -116,6 +210,13 @@ function buildTransformDecorators(properties) {
     }
     return decorators;
 }
+/**
+ * Gets the appropriate description text based on the date property identifier.
+ * Maps identifiers like CREATED_AT, UPDATED_AT, EXPIRES_IN to human-readable descriptions.
+ * @param {EApiPropertyDateIdentifier} identifier - The date property identifier
+ * @returns {string} The human-readable description for the date property
+ * @private
+ */
 function getDescription(identifier) {
     switch (identifier) {
         case identifier_enum.EApiPropertyDateIdentifier.CREATED_AT: {
@@ -156,6 +257,14 @@ function getDescription(identifier) {
         }
     }
 }
+/**
+ * Generates an example date string based on the specified format.
+ * Creates examples for DATE (YYYY-MM-DD), DATE_TIME (ISO), and TIME (HH:MM:SS) formats
+ * using the start of the current year as a reference.
+ * @param {EApiPropertyDateType} format - The date format type
+ * @returns {string} An example date string in the specified format
+ * @private
+ */
 function getExample(format) {
     const startOfYearUTCDate = new Date(Date.UTC(new Date().getUTCFullYear(), 0, 1, 0, 0, 0, 0));
     switch (format) {
@@ -170,6 +279,13 @@ function getExample(format) {
         }
     }
 }
+/**
+ * Gets the appropriate regex pattern for validating a date string in the specified format.
+ * Provides patterns for DATE (YYYY-MM-DD), DATE_TIME (ISO format), and TIME (HH:MM:SS) formats.
+ * @param {EApiPropertyDateType} format - The date format type
+ * @returns {string} A regex pattern string for validating the date format
+ * @private
+ */
 function getPattern(format) {
     switch (format) {
         case type_enum.EApiPropertyDateType.DATE: {
@@ -183,6 +299,15 @@ function getPattern(format) {
         }
     }
 }
+/**
+ * Validates the configuration options for the API property date.
+ * Checks for logical consistency in array options including min/max items,
+ * unique items constraints, and other validation rules.
+ * @param {TApiPropertyDateProperties} properties - The property configuration to validate
+ * @returns {void}
+ * @throws {Error} If the configuration is invalid with detailed error messages
+ * @private
+ */
 function validateOptions(properties) {
     const errors = [];
     if (properties.isArray === true) {

package/dist/cjs/decorator/api/property/date.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"date.decorator.js","sources":["../../../../../../src/decorator/api/property/date.decorator.ts"],"sourcesContent":[null],"names":["applyDecorators","EApiPropertyDataType","ApiProperty","IsDate","IsOptional","IsArray","ArrayMinSize","ArrayMaxSize","ArrayNotEmpty","ApiResponseProperty","Expose","Exclude","Transform","EApiPropertyDateIdentifier","EApiPropertyDateType"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAWM,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,OAAOA,sBAAe,CAAC,GAAG,UAAU,CAAC;AACtC;AAEA,SAAS,uBAAuB,CAAC,UAAsC,EAAA;IACtE,MAAM,OAAO,GAAW,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC;AAErD,IAAA,MAAM,kBAAkB,GAAuB;AAC9C,QAAA,WAAW,EAAE,CAAG,EAAA,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,CAAE,CAAA;;QAEzF,QAAQ,EAAE,UAAU,CAAC,UAAU;QAC/B,IAAI,EAAEC,kCAAoB,CAAC,MAAM;KACjC;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,EAAE;AACvB,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;QACzD,kBAAkB,CAAC,KAAK,GAAG;YAC1B,SAAS,EAAE,OAAO,CAAC,MAAM;YACzB,SAAS,EAAE,OAAO,CAAC,MAAM;SACzB;AACD,QAAA,kBAAkB,CAAC,OAAO,GAAG,CAAC,OAAO,CAAC;;SAChC;AACN,QAAA,kBAAkB,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM;AAC7C,QAAA,kBAAkB,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM;AAC7C,QAAA,kBAAkB,CAAC,OAAO,GAAG,OAAO;;IAGrC,kBAAkB,CAAC,OAAO,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC;AAC1D,IAAA,kBAAkB,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM;AAE7C,IAAA,OAAO,kBAAkB;AAC1B;AAEA,SAAS,eAAe,CAAC,UAAsC,EAAE,kBAAsC,EAAA;IACtG,MAAM,UAAU,GAA6B,CAACC,mBAAW,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,EAAE,GAAG,wBAAwB,CAAC,UAAU,CAAC,CAAC;AAE7K,IAAA,OAAO,UAAU;AAClB;AAEA,SAAS,qBAAqB,CAAC,UAAsC,EAAA;IACpE,MAAM,UAAU,GAA6B,EAAE;AAC/C,IAAA,MAAM,OAAO,GAAY,UAAU,CAAC,OAAO,IAAI,KAAK;AAEpD,IAAA,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE;;AAE3B,QAAA,UAAU,CAAC,IAAI,CAACC,qBAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;;AAG3C,IAAA,OAAO,UAAU;AAClB;AAEA,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,CAACC,yBAAU,EAAE,CAAC;;AAG9B,QAAA,IAAI,UAAU,CAAC,OAAO,KAAK,IAAI,EAAE;YAChC,UAAU,CAAC,IAAI,CAACC,sBAAO,EAAE,EAAEC,2BAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAEC,2BAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;AAEhG,YAAA,IAAI,UAAU,CAAC,QAAQ,GAAG,CAAC,EAAE;AAC5B,gBAAA,UAAU,CAAC,IAAI,CAACC,4BAAa,EAAE,CAAC;;;;AAKnC,IAAA,OAAO,UAAU;AAClB;AAEA,SAAS,uBAAuB,CAAC,UAAsC,EAAA;IACtE,MAAM,UAAU,GAA6B,EAAE;AAE/C,IAAA,IAAI,UAAU,CAAC,UAAU,EAAE;AAC1B,QAAA,UAAU,CAAC,IAAI,CAACC,2BAAmB,EAAE,CAAC;QAEtC,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS,IAAI,UAAU,CAAC,QAAQ,EAAE;AAC7D,YAAA,UAAU,CAAC,IAAI,CAACC,uBAAM,EAAE,CAAC;;aACnB;AACN,YAAA,UAAU,CAAC,IAAI,CAACC,wBAAO,EAAE,CAAC;;;AAI5B,IAAA,OAAO,UAAU;AAClB;AAEA,SAAS,wBAAwB,CAAC,UAAsC,EAAA;IACvE,MAAM,UAAU,GAA6B,EAAE;AAE/C,IAAA,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE;AAC3B,QAAA,IAAI,UAAU,CAAC,OAAO,EAAE;YACvB,UAAU,CAAC,IAAI,CACdC,0BAAS,CACR,CAAC,EAAE,KAAK,EAAsB,KAAI;gBACjC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;oBAC1B,MAAM,WAAW,GAAW,KAAe;AAE3C,oBAAA,OAAO,WAAW,GAAG,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE;;gBAGlD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,UAAkB,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC,CAAC;aACzF,EACD,EAAE,WAAW,EAAE,IAAI,EAAE,CACrB,CACD;;aACK;AACN,YAAA,UAAU,CAAC,IAAI,CAACA,0BAAS,CAAC,CAAC,EAAE,KAAK,EAAqB,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;;;AAI5H,IAAA,OAAO,UAAU;AAClB;AAEA,SAAS,cAAc,CAAC,UAAsC,EAAA;IAC7D,QAAQ,UAAU;AACjB,QAAA,KAAKC,0CAA0B,CAAC,UAAU,EAAE;AAC3C,YAAA,OAAO,eAAe;;AAGvB,QAAA,KAAKA,0CAA0B,CAAC,eAAe,EAAE;AAChD,YAAA,OAAO,gBAAgB;;AAGxB,QAAA,KAAKA,0CAA0B,CAAC,aAAa,EAAE;AAC9C,YAAA,OAAO,cAAc;;AAGtB,QAAA,KAAKA,0CAA0B,CAAC,IAAI,EAAE;AACrC,YAAA,OAAO,MAAM;;AAGd,QAAA,KAAKA,0CAA0B,CAAC,UAAU,EAAE;AAC3C,YAAA,OAAO,iBAAiB;;AAGzB,QAAA,KAAKA,0CAA0B,CAAC,WAAW,EAAE;AAC5C,YAAA,OAAO,iBAAiB;;AAGzB,QAAA,KAAKA,0CAA0B,CAAC,gBAAgB,EAAE;AACjD,YAAA,OAAO,iBAAiB;;AAGzB,QAAA,KAAKA,0CAA0B,CAAC,cAAc,EAAE;AAC/C,YAAA,OAAO,eAAe;;AAGvB,QAAA,KAAKA,0CAA0B,CAAC,UAAU,EAAE;AAC3C,YAAA,OAAO,cAAc;;AAGtB,QAAA,KAAKA,0CAA0B,CAAC,UAAU,EAAE;AAC3C,YAAA,OAAO,kBAAkB;;AAG1B,QAAA,KAAKA,0CAA0B,CAAC,eAAe,EAAE;AAChD,YAAA,OAAO,gBAAgB;;AAGxB,QAAA,KAAKA,0CAA0B,CAAC,aAAa,EAAE;AAC9C,YAAA,OAAO,cAAc;;;AAGxB;AAEA,SAAS,UAAU,CAAC,MAA4B,EAAA;AAC/C,IAAA,MAAM,kBAAkB,GAAS,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAElG,QAAQ,MAAM;AACb,QAAA,KAAKC,8BAAoB,CAAC,IAAI,EAAE;AAC/B,YAAA,OAAO,kBAAkB,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,YAAY;;AAGtE,QAAA,KAAKA,8BAAoB,CAAC,SAAS,EAAE;AACpC,YAAA,OAAO,kBAAkB,CAAC,WAAW,EAAE;;AAGxC,QAAA,KAAKA,8BAAoB,CAAC,IAAI,EAAE;YAC/B,OAAO,kBAAkB,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,UAAU;;;AAGrF;AAEA,SAAS,UAAU,CAAC,MAA4B,EAAA;IAC/C,QAAQ,MAAM;AACb,QAAA,KAAKA,8BAAoB,CAAC,IAAI,EAAE;AAC/B,YAAA,OAAO,8BAA8B;;AAGtC,QAAA,KAAKA,8BAAoB,CAAC,SAAS,EAAE;AACpC,YAAA,OAAO,mEAAmE;;AAG3E,QAAA,KAAKA,8BAAoB,CAAC,IAAI,EAAE;AAC/B,YAAA,OAAO,8BAA8B;;;AAGxC;AAEA,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;;;AAIhF,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;;;;"}
+{"version":3,"file":"date.decorator.js","sources":["../../../../../../src/decorator/api/property/date.decorator.ts"],"sourcesContent":[null],"names":["applyDecorators","EApiPropertyDataType","ApiProperty","IsDate","IsOptional","IsArray","ArrayMinSize","ArrayMaxSize","ArrayNotEmpty","ApiResponseProperty","Expose","Exclude","Transform","EApiPropertyDateIdentifier","EApiPropertyDateType"],"mappings":";;;;;;;;;;;;;;;;;;;;AASA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsDG;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,OAAOA,sBAAe,CAAC,GAAG,UAAU,CAAC;AACtC;AAEA;;;;;AAKG;AACH,SAAS,uBAAuB,CAAC,UAAsC,EAAA;IACtE,MAAM,OAAO,GAAW,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC;AAErD,IAAA,MAAM,kBAAkB,GAAuB;AAC9C,QAAA,WAAW,EAAE,CAAG,EAAA,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,CAAE,CAAA;;QAEzF,QAAQ,EAAE,UAAU,CAAC,UAAU;QAC/B,IAAI,EAAEC,kCAAoB,CAAC,MAAM;KACjC;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,EAAE;AACvB,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;QACzD,kBAAkB,CAAC,KAAK,GAAG;YAC1B,SAAS,EAAE,OAAO,CAAC,MAAM;YACzB,SAAS,EAAE,OAAO,CAAC,MAAM;SACzB;AACD,QAAA,kBAAkB,CAAC,OAAO,GAAG,CAAC,OAAO,CAAC;;SAChC;AACN,QAAA,kBAAkB,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM;AAC7C,QAAA,kBAAkB,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM;AAC7C,QAAA,kBAAkB,CAAC,OAAO,GAAG,OAAO;;IAGrC,kBAAkB,CAAC,OAAO,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC;AAC1D,IAAA,kBAAkB,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM;AAE7C,IAAA,OAAO,kBAAkB;AAC1B;AAEA;;;;;;AAMG;AACH,SAAS,eAAe,CAAC,UAAsC,EAAE,kBAAsC,EAAA;IACtG,MAAM,UAAU,GAA6B,CAACC,mBAAW,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,EAAE,GAAG,wBAAwB,CAAC,UAAU,CAAC,CAAC;AAE7K,IAAA,OAAO,UAAU;AAClB;AAEA;;;;;;AAMG;AACH,SAAS,qBAAqB,CAAC,UAAsC,EAAA;IACpE,MAAM,UAAU,GAA6B,EAAE;AAC/C,IAAA,MAAM,OAAO,GAAY,UAAU,CAAC,OAAO,IAAI,KAAK;AAEpD,IAAA,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE;;AAE3B,QAAA,UAAU,CAAC,IAAI,CAACC,qBAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;;AAG3C,IAAA,OAAO,UAAU;AAClB;AAEA;;;;;;AAMG;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,CAACC,yBAAU,EAAE,CAAC;;AAG9B,QAAA,IAAI,UAAU,CAAC,OAAO,KAAK,IAAI,EAAE;YAChC,UAAU,CAAC,IAAI,CAACC,sBAAO,EAAE,EAAEC,2BAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAEC,2BAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;AAEhG,YAAA,IAAI,UAAU,CAAC,QAAQ,GAAG,CAAC,EAAE;AAC5B,gBAAA,UAAU,CAAC,IAAI,CAACC,4BAAa,EAAE,CAAC;;;;AAKnC,IAAA,OAAO,UAAU;AAClB;AAEA;;;;;;AAMG;AACH,SAAS,uBAAuB,CAAC,UAAsC,EAAA;IACtE,MAAM,UAAU,GAA6B,EAAE;AAE/C,IAAA,IAAI,UAAU,CAAC,UAAU,EAAE;AAC1B,QAAA,UAAU,CAAC,IAAI,CAACC,2BAAmB,EAAE,CAAC;QAEtC,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS,IAAI,UAAU,CAAC,QAAQ,EAAE;AAC7D,YAAA,UAAU,CAAC,IAAI,CAACC,uBAAM,EAAE,CAAC;;aACnB;AACN,YAAA,UAAU,CAAC,IAAI,CAACC,wBAAO,EAAE,CAAC;;;AAI5B,IAAA,OAAO,UAAU;AAClB;AAEA;;;;;;;AAOG;AACH,SAAS,wBAAwB,CAAC,UAAsC,EAAA;IACvE,MAAM,UAAU,GAA6B,EAAE;AAE/C,IAAA,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE;AAC3B,QAAA,IAAI,UAAU,CAAC,OAAO,EAAE;YACvB,UAAU,CAAC,IAAI,CACdC,0BAAS,CACR,CAAC,EAAE,KAAK,EAAsB,KAAI;gBACjC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;oBAC1B,MAAM,WAAW,GAAW,KAAe;AAE3C,oBAAA,OAAO,WAAW,GAAG,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE;;gBAGlD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,UAAkB,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC,CAAC;aACzF,EACD,EAAE,WAAW,EAAE,IAAI,EAAE,CACrB,CACD;;aACK;AACN,YAAA,UAAU,CAAC,IAAI,CAACA,0BAAS,CAAC,CAAC,EAAE,KAAK,EAAqB,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;;;AAI5H,IAAA,OAAO,UAAU;AAClB;AAEA;;;;;;AAMG;AACH,SAAS,cAAc,CAAC,UAAsC,EAAA;IAC7D,QAAQ,UAAU;AACjB,QAAA,KAAKC,0CAA0B,CAAC,UAAU,EAAE;AAC3C,YAAA,OAAO,eAAe;;AAGvB,QAAA,KAAKA,0CAA0B,CAAC,eAAe,EAAE;AAChD,YAAA,OAAO,gBAAgB;;AAGxB,QAAA,KAAKA,0CAA0B,CAAC,aAAa,EAAE;AAC9C,YAAA,OAAO,cAAc;;AAGtB,QAAA,KAAKA,0CAA0B,CAAC,IAAI,EAAE;AACrC,YAAA,OAAO,MAAM;;AAGd,QAAA,KAAKA,0CAA0B,CAAC,UAAU,EAAE;AAC3C,YAAA,OAAO,iBAAiB;;AAGzB,QAAA,KAAKA,0CAA0B,CAAC,WAAW,EAAE;AAC5C,YAAA,OAAO,iBAAiB;;AAGzB,QAAA,KAAKA,0CAA0B,CAAC,gBAAgB,EAAE;AACjD,YAAA,OAAO,iBAAiB;;AAGzB,QAAA,KAAKA,0CAA0B,CAAC,cAAc,EAAE;AAC/C,YAAA,OAAO,eAAe;;AAGvB,QAAA,KAAKA,0CAA0B,CAAC,UAAU,EAAE;AAC3C,YAAA,OAAO,cAAc;;AAGtB,QAAA,KAAKA,0CAA0B,CAAC,UAAU,EAAE;AAC3C,YAAA,OAAO,kBAAkB;;AAG1B,QAAA,KAAKA,0CAA0B,CAAC,eAAe,EAAE;AAChD,YAAA,OAAO,gBAAgB;;AAGxB,QAAA,KAAKA,0CAA0B,CAAC,aAAa,EAAE;AAC9C,YAAA,OAAO,cAAc;;;AAGxB;AAEA;;;;;;;AAOG;AACH,SAAS,UAAU,CAAC,MAA4B,EAAA;AAC/C,IAAA,MAAM,kBAAkB,GAAS,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAElG,QAAQ,MAAM;AACb,QAAA,KAAKC,8BAAoB,CAAC,IAAI,EAAE;AAC/B,YAAA,OAAO,kBAAkB,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,YAAY;;AAGtE,QAAA,KAAKA,8BAAoB,CAAC,SAAS,EAAE;AACpC,YAAA,OAAO,kBAAkB,CAAC,WAAW,EAAE;;AAGxC,QAAA,KAAKA,8BAAoB,CAAC,IAAI,EAAE;YAC/B,OAAO,kBAAkB,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,UAAU;;;AAGrF;AAEA;;;;;;AAMG;AACH,SAAS,UAAU,CAAC,MAA4B,EAAA;IAC/C,QAAQ,MAAM;AACb,QAAA,KAAKA,8BAAoB,CAAC,IAAI,EAAE;AAC/B,YAAA,OAAO,8BAA8B;;AAGtC,QAAA,KAAKA,8BAAoB,CAAC,SAAS,EAAE;AACpC,YAAA,OAAO,mEAAmE;;AAG3E,QAAA,KAAKA,8BAAoB,CAAC,IAAI,EAAE;AAC/B,YAAA,OAAO,8BAA8B;;;AAGxC;AAEA;;;;;;;;AAQG;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;;;AAIhF,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/cjs/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/cjs/decorator/api/property/describe.decorator.js

@@ -1,25 +1,90 @@
 'use strict';
 
 var metadataStorage_class = require('../../../class/metadata-storage.class.js');
-require('../../../enum/decorator/api/action.enum.js');
-require('../../../enum/decorator/api/authentication-type.enum.js');
-require('../../../enum/decorator/api/controller/load-relations-strategy.enum.js');
-require('../../../enum/decorator/api/controller/request-transformer-type.enum.js');
-require('../../../enum/decorator/api/dto-type.enum.js');
-require('../../../enum/decorator/api/function/type.enum.js');
-require('../../../enum/decorator/api/property/data-type.enum.js');
-require('../../../enum/decorator/api/property/date/identifier.enum.js');
-require('../../../enum/decorator/api/property/date/type.enum.js');
-require('../../../enum/decorator/api/property/desribe-type.enum.js');
-require('../../../enum/decorator/api/property/number-type.enum.js');
-require('../../../enum/decorator/api/property/string-type.enum.js');
-require('../../../enum/decorator/api/route-type.enum.js');
-require('../../../enum/exception.enum.js');
-require('../../../enum/filter-order-direction.enum.js');
-require('../../../enum/utility/error-string-action.enum.js');
 require('../../../constant/decorator/api/function.constant.js');
 var propertyDescribe_constant = require('../../../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;

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

@@ -1 +1 @@
-{"version":3,"file":"describe.decorator.js","sources":["../../../../../../src/decorator/api/property/describe.decorator.ts"],"sourcesContent":[null],"names":["MetadataStorage","PROPERTY_DESCRIBE_DECORATOR_API_CONSTANT"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAKM,SAAU,mBAAmB,CAAC,UAA0C,EAAA;AAC7E,IAAA,OAAO,CAAC,MAAwB,EAAE,WAAmB,KAAU;AAC9D,QAAA,MAAM,UAAU,GAAW,MAAM,CAAC,WAAW,CAAC,IAAI;AAClD,QAAAA,qCAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,UAAU,EAAE,WAAW,EAAEC,kEAAwC,CAAC,sBAAsB,EAAE,UAAU,CAAC;AAChJ,KAAC;AACF;;;;"}
+{"version":3,"file":"describe.decorator.js","sources":["../../../../../../src/decorator/api/property/describe.decorator.ts"],"sourcesContent":[null],"names":["MetadataStorage","PROPERTY_DESCRIBE_DECORATOR_API_CONSTANT"],"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,QAAAA,qCAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,UAAU,EAAE,WAAW,EAAEC,kEAAwC,CAAC,sBAAsB,EAAE,UAAU,CAAC;AAChJ,KAAC;AACF;;;;"}

package/dist/cjs/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/cjs/decorator/api/property/enum.decorator.js

@@ -5,12 +5,92 @@ var swagger = require('@nestjs/swagger');
 var classTransformer = require('class-transformer');
 var classValidator = require('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 common.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 ?? ""}`,
@@ -39,11 +119,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 = [swagger.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;
@@ -51,6 +144,12 @@ function buildFormatDecorators(properties) {
     decorators.push(classValidator.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) {
@@ -66,6 +165,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) {
@@ -79,6 +184,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) {