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

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

@@ -1,9 +1,3 @@
-import { applyDecorators } from '@nestjs/common';
-import { ApiProperty, ApiResponseProperty } from '@nestjs/swagger';
-import { Expose, Exclude, Type, Transform } from 'class-transformer';
-import { isInt, IsOptional, IsArray, ArrayMinSize, ArrayMaxSize, ArrayNotEmpty, IsInt, IsNumber, IsDivisibleBy, Min, Max } from 'class-validator';
-import random from 'lodash/random';
-import '../../../constant/decorator/api/function.constant.js';
 import { NUMBER_CONSTANT } from '../../../constant/number.constant.js';
 import '../../../enum/decorator/api/action.enum.js';
 import '../../../enum/decorator/api/authentication-type.enum.js';
@@ -18,10 +12,78 @@ import '../../../enum/decorator/api/property/desribe-type.enum.js';
 import { EApiPropertyNumberType } from '../../../enum/decorator/api/property/number-type.enum.js';
 import '../../../enum/decorator/api/property/string-type.enum.js';
 import '../../../enum/decorator/api/route-type.enum.js';
-import '../../../enum/exception.enum.js';
-import '../../../enum/filter-order-direction.enum.js';
-import '../../../enum/utility/error-string-action.enum.js';
+import { applyDecorators } from '@nestjs/common';
+import { ApiProperty, ApiResponseProperty } from '@nestjs/swagger';
+import { Expose, Exclude, Type, Transform } from 'class-transformer';
+import { isInt, IsOptional, IsArray, ArrayMinSize, ArrayMaxSize, ArrayNotEmpty, IsInt, IsNumber, IsDivisibleBy, Min, Max } from 'class-validator';
+import random from 'lodash/random';
 
+/**
+ * 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[];
+ * }
+ * ```
+ */
 function ApiPropertyNumber(properties) {
     if (properties.exampleValue === undefined) {
         properties.exampleValue = random(properties.minimum, properties.maximum);
@@ -31,6 +93,14 @@ function ApiPropertyNumber(properties) {
     const decorators = buildDecorators(properties, apiPropertyOptions);
     return applyDecorators(...decorators);
 }
+/**
+ * Builds the API property options object from the provided property configuration.
+ * Sets up number-specific properties including format, min/max values, example value,
+ * and multiple-of constraint.
+ * @param {TApiPropertyNumberProperties} properties - The property configuration
+ * @returns {ApiPropertyOptions} The Swagger API property options object
+ * @private
+ */
 function buildApiPropertyOptions(properties) {
     const apiPropertyOptions = {
         description: `${String(properties.entity.name)} ${properties.description ?? ""}`,
@@ -52,16 +122,32 @@ function buildApiPropertyOptions(properties) {
     }
     apiPropertyOptions.minimum = properties.minimum;
     apiPropertyOptions.maximum = properties.maximum;
-    if ((properties.isResponse === false || properties.isResponse === undefined) && properties.multipleOf !== undefined) {
+    if ((properties.isResponse === false || properties.isResponse === undefined) && properties.multipleOf != undefined) {
         apiPropertyOptions.multipleOf = properties.multipleOf;
     }
     return apiPropertyOptions;
 }
+/**
+ * Builds all the necessary decorators for the number property based on the configuration.
+ * Combines API property decorators, response decorators, request decorators, format decorators,
+ * transform decorators, and number validation decorators.
+ * @param {TApiPropertyNumberProperties} properties - The 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), ...buildTransformDecorators(properties), ...buildNumberValidationDecorators(properties));
     return decorators;
 }
+/**
+ * Builds decorators for number format validation based on the specified format type.
+ * Handles integer and double/float formats with appropriate validators.
+ * @param {TApiPropertyNumberProperties} properties - The property configuration
+ * @returns {Array<PropertyDecorator>} An array of format-specific validation decorators
+ * @private
+ */
 function buildFormatDecorators(properties) {
     const decorators = [];
     const isArray = properties.isArray ?? false;
@@ -85,15 +171,29 @@ function buildFormatDecorators(properties) {
     }
     return decorators;
 }
+/**
+ * Builds decorators for number-specific validation including multiple-of constraint,
+ * minimum value, and maximum value validation.
+ * @param {TApiPropertyNumberProperties} properties - The property configuration
+ * @returns {Array<PropertyDecorator>} An array of number validation decorators
+ * @private
+ */
 function buildNumberValidationDecorators(properties) {
     const decorators = [];
     const isArray = properties.isArray ?? false;
-    if ((properties.isResponse === false || properties.isResponse === undefined) && properties.multipleOf !== undefined) {
+    if ((properties.isResponse === false || properties.isResponse === undefined) && properties.multipleOf != undefined) {
         // eslint-disable-next-line @elsikora/typescript/naming-convention
         decorators.push(IsDivisibleBy(properties.multipleOf, { each: isArray }), Min(properties.minimum, { each: isArray }), Max(properties.maximum, { each: isArray }));
     }
     return decorators;
 }
+/**
+ * Builds decorators for request validation including optional status,
+ * array validation, and size constraints for number properties.
+ * @param {TApiPropertyNumberProperties} 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) {
@@ -109,6 +209,13 @@ function buildRequestDecorators(properties) {
     }
     return decorators;
 }
+/**
+ * Builds decorators for response serialization including API response property,
+ * expose, and exclude decorators for number properties.
+ * @param {TApiPropertyNumberProperties} properties - The property configuration
+ * @returns {Array<PropertyDecorator>} An array of response serialization decorators
+ * @private
+ */
 function buildResponseDecorators(properties) {
     const decorators = [];
     if (properties.isResponse) {
@@ -122,6 +229,13 @@ function buildResponseDecorators(properties) {
     }
     return decorators;
 }
+/**
+ * Builds decorators for type transformation from string to number.
+ * Handles both single values and arrays with appropriate transformers.
+ * @param {TApiPropertyNumberProperties} properties - The property configuration
+ * @returns {Array<PropertyDecorator>} An array of type transformation decorators
+ * @private
+ */
 function buildTransformDecorators(properties) {
     const decorators = [];
     if (!properties.isResponse) {
@@ -134,6 +248,13 @@ function buildTransformDecorators(properties) {
     }
     return decorators;
 }
+/**
+ * Determines the appropriate Swagger format for the number property.
+ * Maps integer types to int32/int64 based on value range, and handles double format.
+ * @param {TApiPropertyNumberProperties} properties - The property configuration
+ * @returns {string} The Swagger format string
+ * @private
+ */
 function getFormat(properties) {
     switch (properties.format) {
         case EApiPropertyNumberType.DOUBLE: {
@@ -147,6 +268,13 @@ function getFormat(properties) {
         }
     }
 }
+/**
+ * Determines the appropriate Swagger data type for the number property.
+ * Maps formatter types to the corresponding API property data types.
+ * @param {TApiPropertyNumberProperties} properties - The property configuration
+ * @returns {EApiPropertyDataType.INTEGER | EApiPropertyDataType.NUMBER} The Swagger data type
+ * @private
+ */
 function getType(properties) {
     switch (properties.format) {
         case EApiPropertyNumberType.DOUBLE: {
@@ -157,12 +285,24 @@ function getType(properties) {
         }
     }
 }
+/**
+ * Validates the configuration options for the API property number.
+ * Performs extensive validation including:
+ * - Min/max values consistency
+ * - Multiple-of constraints and example value compatibility
+ * - Example values within min/max range
+ * - Array options consistency (min/max items, unique items)
+ * @param {TApiPropertyNumberProperties} 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.minimum > properties.maximum) {
         errors.push("'minimum' is greater than maximum");
     }
-    if (properties.multipleOf !== undefined) {
+    if (properties.multipleOf != undefined) {
         if (Array.isArray(properties.exampleValue)) {
             for (const example of properties.exampleValue) {
                 if (!isInt(example / properties.multipleOf)) {

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

@@ -0,0 +1 @@
+{"version":3,"file":"number.decorator.js","sources":["../../../../../../src/decorator/api/property/number.decorator.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAWA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiEG;AACG,SAAU,iBAAiB,CAAC,UAAwC,EAAA;AACzE,IAAA,IAAI,UAAU,CAAC,YAAY,KAAK,SAAS,EAAE;AAC1C,QAAA,UAAU,CAAC,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC;;IAGzE,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;;;;;;;AAOG;AACH,SAAS,uBAAuB,CAAC,UAAwC,EAAA;AACxE,IAAA,MAAM,kBAAkB,GAAuB;AAC9C,QAAA,WAAW,EAAE,CAAG,EAAA,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,WAAW,IAAI,EAAE,CAAE,CAAA;AAChF,QAAA,MAAM,EAAE,SAAS,CAAC,UAAU,CAAC;;QAE7B,QAAQ,EAAE,UAAU,CAAC,UAAU;AAC/B,QAAA,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC;KACzB;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,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC,YAAY,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC;;SACnH;AACN,QAAA,kBAAkB,CAAC,OAAO,GAAG,UAAU,CAAC,YAAY;;AAGrD,IAAA,kBAAkB,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO;AAC/C,IAAA,kBAAkB,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO;IAE/C,IAAI,CAAC,UAAU,CAAC,UAAU,KAAK,KAAK,IAAI,UAAU,CAAC,UAAU,KAAK,SAAS,KAAK,UAAU,CAAC,UAAU,IAAI,SAAS,EAAE;AACnH,QAAA,kBAAkB,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU;;AAGtD,IAAA,OAAO,kBAAkB;AAC1B;AAEA;;;;;;;;AAQG;AACH,SAAS,eAAe,CAAC,UAAwC,EAAE,kBAAsC,EAAA;IACxG,MAAM,UAAU,GAA6B,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;AAE9E,IAAA,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,EAAE,GAAG,+BAA+B,CAAC,UAAU,CAAC,CAAC;AAE7N,IAAA,OAAO,UAAU;AAClB;AAEA;;;;;;AAMG;AACH,SAAS,qBAAqB,CAAC,UAAwC,EAAA;IACtE,MAAM,UAAU,GAA6B,EAAE;AAC/C,IAAA,MAAM,OAAO,GAAY,UAAU,CAAC,OAAO,IAAI,KAAK;IAEpD,IAAI,UAAU,CAAC,UAAU,KAAK,SAAS,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE;AAClE,QAAA,QAAQ,UAAU,CAAC,MAAM;AACxB,YAAA,KAAK,sBAAsB,CAAC,MAAM,EAAE;;AAEnC,gBAAA,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;gBAEhD;;AAGD,YAAA,KAAK,sBAAsB,CAAC,OAAO,EAAE;;AAEpC,gBAAA,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;gBAEzC;;YAGD,SAAS;AACR,gBAAA,MAAM,IAAI,KAAK,CAAC,CAAA,kEAAA,EAAqE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAE,CAAA,CAAC;;;QAInH,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,MAAM,CAAC,CAAC;;AAGpC,IAAA,OAAO,UAAU;AAClB;AAEA;;;;;;AAMG;AACH,SAAS,+BAA+B,CAAC,UAAwC,EAAA;IAChF,MAAM,UAAU,GAA6B,EAAE;AAC/C,IAAA,MAAM,OAAO,GAAY,UAAU,CAAC,OAAO,IAAI,KAAK;IAEpD,IAAI,CAAC,UAAU,CAAC,UAAU,KAAK,KAAK,IAAI,UAAU,CAAC,UAAU,KAAK,SAAS,KAAK,UAAU,CAAC,UAAU,IAAI,SAAS,EAAE;;AAEnH,QAAA,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;;AAGjK,IAAA,OAAO,UAAU;AAClB;AAEA;;;;;;AAMG;AACH,SAAS,sBAAsB,CAAC,UAAwC,EAAA;IACvE,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;;;;;;AAMG;AACH,SAAS,uBAAuB,CAAC,UAAwC,EAAA;IACxE,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,wBAAwB,CAAC,UAAwC,EAAA;IACzE,MAAM,UAAU,GAA6B,EAAE;AAE/C,IAAA,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE;AAC3B,QAAA,IAAI,UAAU,CAAC,OAAO,EAAE;YACvB,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,EAA4B,KAAK,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;;aACvG;YACN,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,EAAqB,KAAK,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;;;AAIpG,IAAA,OAAO,UAAU;AAClB;AAEA;;;;;;AAMG;AACH,SAAS,SAAS,CAAC,UAAwC,EAAA;AAC1D,IAAA,QAAQ,UAAU,CAAC,MAAM;AACxB,QAAA,KAAK,sBAAsB,CAAC,MAAM,EAAE;YACnC,OAAO,sBAAsB,CAAC,MAAM;;AAGrC,QAAA,KAAK,sBAAsB,CAAC,OAAO,EAAE;YACpC,OAAO,UAAU,CAAC,OAAO,IAAI,eAAe,CAAC,WAAW,IAAI,UAAU,CAAC,OAAO,IAAI,eAAe,CAAC,WAAW,GAAG,OAAO,GAAG,OAAO;;QAGlI,SAAS;AACR,YAAA,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC;;;AAGpE;AAEA;;;;;;AAMG;AACH,SAAS,OAAO,CAAC,UAAwC,EAAA;AACxD,IAAA,QAAQ,UAAU,CAAC,MAAM;AACxB,QAAA,KAAK,sBAAsB,CAAC,MAAM,EAAE;YACnC,OAAO,oBAAoB,CAAC,MAAM;;AAGnC,QAAA,KAAK,sBAAsB,CAAC,OAAO,EAAE;YACpC,OAAO,oBAAoB,CAAC,OAAO;;;AAGtC;AAEA;;;;;;;;;;;AAWG;AACH,SAAS,eAAe,CAAC,UAAwC,EAAA;IAChE,MAAM,MAAM,GAAkB,EAAE;IAEhC,IAAI,UAAU,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE;AAC5C,QAAA,MAAM,CAAC,IAAI,CAAC,mCAAmC,CAAC;;AAGjD,IAAA,IAAI,UAAU,CAAC,UAAU,IAAI,SAAS,EAAE;QACvC,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;AAC3C,YAAA,KAAK,MAAM,OAAO,IAAI,UAAU,CAAC,YAAY,EAAE;gBAC9C,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,UAAU,CAAC,UAAU,CAAC,EAAE;oBAC5C,MAAM,CAAC,IAAI,CAAC,0DAA0D,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;;;;AAGrF,aAAA,IAAI,UAAU,CAAC,YAAY,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,UAAU,CAAC,EAAE;AAC5G,YAAA,MAAM,CAAC,IAAI,CAAC,0DAA0D,GAAG,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;;;IAI3G,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;AAC3C,QAAA,KAAK,MAAM,OAAO,IAAI,UAAU,CAAC,YAAY,EAAE;AAC9C,YAAA,IAAI,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE;gBACjC,MAAM,CAAC,IAAI,CAAC,yCAAyC,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;;;;AAGpE,SAAA,IAAI,UAAU,CAAC,YAAY,KAAK,SAAS,IAAI,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,OAAO,EAAE;AACjG,QAAA,MAAM,CAAC,IAAI,CAAC,yCAAyC,GAAG,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;;IAGzF,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;AAC3C,QAAA,KAAK,MAAM,OAAO,IAAI,UAAU,CAAC,YAAY,EAAE;AAC9C,YAAA,IAAI,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE;gBACjC,MAAM,CAAC,IAAI,CAAC,4CAA4C,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;;;;AAGvE,SAAA,IAAI,UAAU,CAAC,YAAY,KAAK,SAAS,IAAI,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,OAAO,EAAE;AACjG,QAAA,MAAM,CAAC,IAAI,CAAC,4CAA4C,GAAG,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;;AAG5F,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,yBAAA,EAA4B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA,CAAC;;AAElE;;;;"}

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

@@ -1,2 +1,28 @@
-import type { TApiPropertyObjectProperties } from "../../../type/decorator/api/property/object-properties.type";
+import type { TApiPropertyObjectProperties } from '../../../type/decorator/api/property/index';
+/**
+ * Creates a decorator that applies NestJS Swagger and class-validator/class-transformer decorators
+ * for object properties in DTOs.
+ *
+ * This decorator handles complex object properties with support for:
+ * - Single type objects
+ * - Polymorphic objects (with discriminator)
+ * - Arrays of objects
+ * - Response/Request specific decorators
+ * - Validation rules
+ * - Transformation rules
+ * @param {TApiPropertyObjectProperties} options - Configuration options for the object property
+ * @returns {Function} A decorator function that can be applied to a class property
+ * @example
+ * ```typescript
+ * class UserDto {
+ *   @ApiPropertyObject({
+ *     entity: { name: 'Address' },
+ *     type: AddressDto,
+ *     isRequired: true,
+ *     shouldValidateNested: true
+ *   })
+ *   address: AddressDto;
+ * }
+ * ```
+ */
 export declare function ApiPropertyObject(options: TApiPropertyObjectProperties): <Y>(target: object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

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

@@ -0,0 +1,246 @@
+import { applyDecorators } from '@nestjs/common';
+import { getSchemaPath, ApiProperty, ApiResponseProperty } from '@nestjs/swagger';
+import { MustMatchOneOfSchemasValidator } from '../../../validator/must-match-one-of-schemas.validator.js';
+import { Expose, Exclude, Type } from 'class-transformer';
+import { IsOptional, IsArray, ArrayMinSize, ArrayMaxSize, ArrayNotEmpty, ValidateNested } from 'class-validator';
+
+/**
+ * Creates a decorator that applies NestJS Swagger and class-validator/class-transformer decorators
+ * for object properties in DTOs.
+ *
+ * This decorator handles complex object properties with support for:
+ * - Single type objects
+ * - Polymorphic objects (with discriminator)
+ * - Arrays of objects
+ * - Response/Request specific decorators
+ * - Validation rules
+ * - Transformation rules
+ * @param {TApiPropertyObjectProperties} options - Configuration options for the object property
+ * @returns {Function} A decorator function that can be applied to a class property
+ * @example
+ * ```typescript
+ * class UserDto {
+ *   @ApiPropertyObject({
+ *     entity: { name: 'Address' },
+ *     type: AddressDto,
+ *     isRequired: true,
+ *     shouldValidateNested: true
+ *   })
+ *   address: AddressDto;
+ * }
+ * ```
+ */
+function ApiPropertyObject(options) {
+    validateOptions(options);
+    const apiPropertyOptions = buildApiPropertyOptions(options);
+    const decorators = buildDecorators(options, apiPropertyOptions);
+    return applyDecorators(...decorators);
+}
+/**
+ * Builds the API property options object from the provided property configuration.
+ * Handles different scenarios including single type, multiple types, dynamically generated types, and arrays.
+ * @param {TApiPropertyObjectProperties} properties - The property configuration
+ * @returns {ApiPropertyOptions} The Swagger API property options object
+ * @private
+ */
+function buildApiPropertyOptions(properties) {
+    const apiPropertyOptions = {
+        description: `${String(properties.entity.name)} ${properties.description ?? ""}`,
+        // eslint-disable-next-line @elsikora/typescript/naming-convention
+        nullable: properties.isNullable,
+    };
+    if (Array.isArray(properties.type)) {
+        // eslint-disable-next-line @elsikora/typescript/no-unsafe-function-type
+        apiPropertyOptions.oneOf = properties.type.map((type) => {
+            return { $ref: getSchemaPath(type) };
+        });
+        if (properties.discriminator) {
+            apiPropertyOptions.discriminator = {
+                // eslint-disable-next-line @elsikora/typescript/no-unsafe-function-type
+                mapping: Object.fromEntries(Object.keys(properties.discriminator.mapping).map((key) => [key, getSchemaPath(properties.discriminator?.mapping[key])])),
+                propertyName: properties.discriminator.propertyName,
+            };
+        }
+        // eslint-disable-next-line @elsikora/typescript/no-unsafe-assignment
+        apiPropertyOptions.type = "object";
+    }
+    else if ("isDynamicallyGenerated" in properties && properties.isDynamicallyGenerated) {
+        // eslint-disable-next-line @elsikora/typescript/no-unsafe-function-type
+        apiPropertyOptions.oneOf = Object.entries(properties.generatedDTOs).map(([_key, value]) => {
+            return { $ref: getSchemaPath(value) };
+        });
+        if (properties.discriminator) {
+            apiPropertyOptions.discriminator = {
+                // eslint-disable-next-line @elsikora/typescript/no-unsafe-function-type
+                mapping: Object.fromEntries(Object.keys(properties.discriminator.mapping).map((key) => [key, getSchemaPath(properties.generatedDTOs[key])])),
+                propertyName: properties.discriminator.propertyName,
+            };
+        }
+        // eslint-disable-next-line @elsikora/typescript/no-unsafe-assignment
+        apiPropertyOptions.type = "object";
+    }
+    else {
+        apiPropertyOptions.type = properties.type;
+    }
+    apiPropertyOptions.required = properties.isResponse === false || properties.isResponse === undefined ? properties.isRequired : false;
+    if (properties.additionalProperties) {
+        apiPropertyOptions.additionalProperties = properties.additionalProperties;
+    }
+    if (properties.isArray) {
+        apiPropertyOptions.isArray = true;
+        apiPropertyOptions.minItems = properties.minItems;
+        apiPropertyOptions.maxItems = properties.maxItems;
+        apiPropertyOptions.uniqueItems = properties.isUniqueItems;
+        apiPropertyOptions.description = `Array of ${String(properties.entity.name)} ${properties.description ?? ""}`;
+    }
+    return apiPropertyOptions;
+}
+/**
+ * Builds all the necessary decorators for the property based on the configuration.
+ * Combines API property decorators, response decorators, request decorators, transform decorators,
+ * and validation decorators.
+ * @param {TApiPropertyObjectProperties} properties - The 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), ...buildTransformDecorators(properties), ...buildObjectValidationDecorators(properties));
+    return decorators;
+}
+/**
+ * Builds decorators for validation of nested objects.
+ * @param {TApiPropertyObjectProperties} properties - The property configuration
+ * @returns {Array<PropertyDecorator>} An array of object validation decorators
+ * @private
+ */
+function buildObjectValidationDecorators(properties) {
+    const decorators = [];
+    const isArray = properties.isArray ?? false;
+    if (!properties.isResponse && properties.shouldValidateNested) {
+        // eslint-disable-next-line @elsikora/typescript/naming-convention
+        decorators.push(ValidateNested({ each: isArray }));
+    }
+    return decorators;
+}
+/**
+ * Builds decorators for request validation including optional status,
+ * array validation, and size constraints.
+ * @param {TApiPropertyObjectProperties} 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) {
+        if (!properties.isRequired) {
+            decorators.push(IsOptional());
+        }
+        if (properties.isArray === true) {
+            decorators.push(IsArray(), ArrayMinSize(properties.minItems), ArrayMaxSize(properties.maxItems));
+            if (properties.minItems > 0) {
+                decorators.push(ArrayNotEmpty());
+            }
+        }
+    }
+    return decorators;
+}
+/**
+ * Builds decorators for response serialization including API response property,
+ * expose, and exclude decorators.
+ * @param {TApiPropertyObjectProperties} properties - The property configuration
+ * @returns {Array<PropertyDecorator>} An array of response serialization decorators
+ * @private
+ */
+function buildResponseDecorators(properties) {
+    const decorators = [];
+    if (properties.isResponse) {
+        decorators.push(ApiResponseProperty());
+        if (properties.isExpose === undefined || properties.isExpose) {
+            decorators.push(Expose());
+        }
+        else {
+            decorators.push(Exclude());
+        }
+    }
+    return decorators;
+}
+/**
+ * Builds decorators for type transformation including handling of discriminator-based
+ * polymorphic objects.
+ * @param {TApiPropertyObjectProperties} properties - The property configuration
+ * @returns {Array<PropertyDecorator>} An array of type transformation decorators
+ * @private
+ */
+function buildTransformDecorators(properties) {
+    const decorators = [];
+    if (Array.isArray(properties.type) && properties.discriminator) {
+        decorators.push(MustMatchOneOfSchemasValidator({
+            discriminator: properties.discriminator,
+            schemas: properties.type,
+        }), Type(() => Object, {
+            discriminator: {
+                property: properties.discriminator.propertyName,
+                subTypes: Object.entries(properties.discriminator.mapping).map(([key, value]) => {
+                    return { name: key, value };
+                }),
+            },
+            // eslint-disable-next-line @elsikora/typescript/naming-convention
+            keepDiscriminatorProperty: properties.discriminator.shouldKeepDiscriminatorProperty,
+        }));
+    }
+    else if ("isDynamicallyGenerated" in properties && properties.isDynamicallyGenerated) {
+        decorators.push(MustMatchOneOfSchemasValidator({
+            discriminator: properties.discriminator,
+            schemas: properties.generatedDTOs,
+        }), Type(() => Object, {
+            discriminator: {
+                property: properties.discriminator.propertyName,
+                subTypes: Object.entries(properties.discriminator.mapping).map(([key, value]) => {
+                    return { name: key, value: properties.generatedDTOs[value] };
+                }),
+            },
+            // eslint-disable-next-line @elsikora/typescript/naming-convention
+            keepDiscriminatorProperty: properties.discriminator.shouldKeepDiscriminatorProperty,
+        }));
+    }
+    else {
+        decorators.push(Type(() => properties.type));
+    }
+    return decorators;
+}
+/**
+ * Validates the configuration options for the API property object.
+ * Throws an error if the configuration is invalid.
+ * @param {TApiPropertyObjectProperties} properties - The property configuration to validate
+ * @returns {void}
+ * @throws {Error} If the configuration is invalid
+ * @private
+ */
+function validateOptions(properties) {
+    const errors = [];
+    if (properties.isArray && !properties.shouldValidateNested && !properties.isResponse) {
+        errors.push("Array property must be 'shouldValidateNested'");
+    }
+    if (properties.isArray === true) {
+        if (properties.minItems > properties.maxItems) {
+            errors.push("'minItems' is greater than 'maxItems'");
+        }
+        if (properties.minItems < 0) {
+            errors.push("'minItems' is less than 0");
+        }
+        if (properties.maxItems < 0) {
+            errors.push("'maxItems' is less than 0");
+        }
+        if (properties.isUniqueItems && properties.maxItems <= 1) {
+            errors.push("'uniqueItems' is true but 'maxItems' is less than or equal to 1");
+        }
+    }
+    if (errors.length > 0) {
+        throw new Error(`ApiPropertyObject error: ${errors.join("\n")}`);
+    }
+}
+
+export { ApiPropertyObject };
+//# sourceMappingURL=object.decorator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"object.decorator.js","sources":["../../../../../../src/decorator/api/property/object.decorator.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AAUA;;;;;;;;;;;;;;;;;;;;;;;;;AAyBG;AACG,SAAU,iBAAiB,CAAC,OAAqC,EAAA;IACtE,eAAe,CAAC,OAAO,CAAC;AAExB,IAAA,MAAM,kBAAkB,GAAuB,uBAAuB,CAAC,OAAO,CAAC;IAC/E,MAAM,UAAU,GAA6B,eAAe,CAAC,OAAO,EAAE,kBAAkB,CAAC;AAEzF,IAAA,OAAO,eAAe,CAAC,GAAG,UAAU,CAAC;AACtC;AAEA;;;;;;AAMG;AACH,SAAS,uBAAuB,CAAC,UAAwC,EAAA;AACxE,IAAA,MAAM,kBAAkB,GAAuB;AAC9C,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,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;;AAEnC,QAAA,kBAAkB,CAAC,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAc,KAAI;YACjE,OAAO,EAAE,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,EAAE;AACrC,SAAC,CAAC;AAEF,QAAA,IAAI,UAAU,CAAC,aAAa,EAAE;YAC7B,kBAAkB,CAAC,aAAa,GAAG;;AAElC,gBAAA,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,GAAW,KAAK,CAAC,GAAG,EAAE,aAAa,CAAC,UAAU,CAAC,aAAa,EAAE,OAAO,CAAC,GAAG,CAAa,CAAC,CAAC,CAAC,CAAC;AACzK,gBAAA,YAAY,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY;aACnD;;;AAIF,QAAA,kBAAkB,CAAC,IAAI,GAAG,QAAe;;SACnC,IAAI,wBAAwB,IAAI,UAAU,IAAI,UAAU,CAAC,sBAAsB,EAAE;;QAEvF,kBAAkB,CAAC,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAqB,KAAI;YAC7G,OAAO,EAAE,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE;AACtC,SAAC,CAAC;AAEF,QAAA,IAAI,UAAU,CAAC,aAAa,EAAE;YAC7B,kBAAkB,CAAC,aAAa,GAAG;;AAElC,gBAAA,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,GAAW,KAAK,CAAC,GAAG,EAAE,aAAa,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,CAAa,CAAC,CAAC,CAAC,CAAC;AAChK,gBAAA,YAAY,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY;aACnD;;;AAIF,QAAA,kBAAkB,CAAC,IAAI,GAAG,QAAe;;SACnC;AACN,QAAA,kBAAkB,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI;;IAG1C,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,oBAAoB,EAAE;AACpC,QAAA,kBAAkB,CAAC,oBAAoB,GAAG,UAAU,CAAC,oBAAoB;;AAG1E,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;AACzD,QAAA,kBAAkB,CAAC,WAAW,GAAG,YAAY,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,WAAW,IAAI,EAAE,EAAE;;AAG9G,IAAA,OAAO,kBAAkB;AAC1B;AAEA;;;;;;;;AAQG;AACH,SAAS,eAAe,CAAC,UAAwC,EAAE,kBAAsC,EAAA;IACxG,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,wBAAwB,CAAC,UAAU,CAAC,EAAE,GAAG,+BAA+B,CAAC,UAAU,CAAC,CAAC;AAEvL,IAAA,OAAO,UAAU;AAClB;AAEA;;;;;AAKG;AACH,SAAS,+BAA+B,CAAC,UAAwC,EAAA;IAChF,MAAM,UAAU,GAA6B,EAAE;AAC/C,IAAA,MAAM,OAAO,GAAY,UAAU,CAAC,OAAO,IAAI,KAAK;IAEpD,IAAI,CAAC,UAAU,CAAC,UAAU,IAAI,UAAU,CAAC,oBAAoB,EAAE;;AAE9D,QAAA,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;;AAGnD,IAAA,OAAO,UAAU;AAClB;AAEA;;;;;;AAMG;AACH,SAAS,sBAAsB,CAAC,UAAwC,EAAA;IACvE,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;;;;;;AAMG;AACH,SAAS,uBAAuB,CAAC,UAAwC,EAAA;IACxE,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,wBAAwB,CAAC,UAAwC,EAAA;IACzE,MAAM,UAAU,GAA6B,EAAE;AAE/C,IAAA,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,aAAa,EAAE;AAC/D,QAAA,UAAU,CAAC,IAAI,CACd,8BAA8B,CAAC;YAC9B,aAAa,EAAE,UAAU,CAAC,aAAa;YACvC,OAAO,EAAE,UAAU,CAAC,IAAI;AACxB,SAAA,CAAC,EACF,IAAI,CAAC,MAAM,MAAM,EAAE;AAClB,YAAA,aAAa,EAAE;AACd,gBAAA,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY;gBAC/C,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAkC,KAAI;AAChH,oBAAA,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE;AAC5B,iBAAC,CAAC;AACF,aAAA;;AAED,YAAA,yBAAyB,EAAE,UAAU,CAAC,aAAa,CAAC,+BAA+B;AACnF,SAAA,CAAC,CACF;;SACK,IAAI,wBAAwB,IAAI,UAAU,IAAI,UAAU,CAAC,sBAAsB,EAAE;AACvF,QAAA,UAAU,CAAC,IAAI,CACd,8BAA8B,CAAC;YAC9B,aAAa,EAAE,UAAU,CAAC,aAAa;YACvC,OAAO,EAAE,UAAU,CAAC,aAAa;AACjC,SAAA,CAAC,EACF,IAAI,CAAC,MAAM,MAAM,EAAE;AAClB,YAAA,aAAa,EAAE;AACd,gBAAA,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY;gBAC/C,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAmB,KAAI;AACjG,oBAAA,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,aAAa,CAAC,KAAK,CAA0B,EAAE;AACtF,iBAAC,CAAC;AACF,aAAA;;AAED,YAAA,yBAAyB,EAAE,UAAU,CAAC,aAAa,CAAC,+BAA+B;AACnF,SAAA,CAAC,CACF;;SACK;AACN,QAAA,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,UAAU,CAAC,IAAiB,CAAC,CAAC;;AAG1D,IAAA,OAAO,UAAU;AAClB;AAEA;;;;;;;AAOG;AACH,SAAS,eAAe,CAAC,UAAwC,EAAA;IAChE,MAAM,MAAM,GAAkB,EAAE;AAEhC,IAAA,IAAI,UAAU,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,oBAAoB,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE;AACrF,QAAA,MAAM,CAAC,IAAI,CAAC,+CAA+C,CAAC;;AAG7D,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,yBAAA,EAA4B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAA,CAAC;;AAElE;;;;"}

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

@@ -1,2 +1,69 @@
-import type { TApiPropertyStringProperties } from "../../../type/decorator/api/property/string-properties.type";
+import type { TApiPropertyStringProperties } from '../../../type/decorator/api/property/index';
+/**
+ * Creates a decorator that applies NestJS Swagger and class-validator/class-transformer decorators
+ * for string properties in DTOs.
+ *
+ * This decorator handles string properties with support for:
+ * - Various string formats (email, URL, UUID, IP, date, etc.)
+ * - Single strings or arrays of strings
+ * - Response/Request specific decorators
+ * - Pattern validation with regex
+ * - Length validation
+ * - Case sensitivity options (uppercase, lowercase)
+ * - Transformation rules
+ *
+ * The decorator applies appropriate validation rules based on the format and configuration.
+ * @param {TApiPropertyStringProperties} properties - Configuration options for the string property
+ * @returns {Function} A decorator function that can be applied to a class property
+ * @example
+ * ```typescript
+ * // Simple string property
+ * class UserDto {
+ *   @ApiPropertyString({
+ *     entity: { name: 'User' },
+ *     description: 'name',
+ *     format: EApiPropertyStringType.STRING,
+ *     isRequired: true,
+ *     minLength: 2,
+ *     maxLength: 100,
+ *     pattern: '/^[a-zA-Z ]+$/',
+ *     exampleValue: 'John Doe'
+ *   })
+ *   name: string;
+ * }
+ *
+ * // Email format
+ * class ContactDto {
+ *   @ApiPropertyString({
+ *     entity: { name: 'Contact' },
+ *     description: 'email address',
+ *     format: EApiPropertyStringType.EMAIL,
+ *     isRequired: true,
+ *     minLength: 5,
+ *     maxLength: 255,
+ *     pattern: '/^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$/',
+ *     exampleValue: 'user@example.com'
+ *   })
+ *   email: string;
+ * }
+ *
+ * // Array of URLs
+ * class WebsitesDto {
+ *   @ApiPropertyString({
+ *     entity: { name: 'Website' },
+ *     description: 'links',
+ *     format: EApiPropertyStringType.URL,
+ *     isArray: true,
+ *     minItems: 1,
+ *     maxItems: 5,
+ *     isUniqueItems: true,
+ *     minLength: 10,
+ *     maxLength: 2000,
+ *     pattern: '/^https?:\\/\\/[\\w\\-]+(\\.[\\w\\-]+)+[/#?]?.*$/',
+ *     exampleValue: ['https://example.com', 'https://another-example.org']
+ *   })
+ *   websites: string[];
+ * }
+ * ```
+ */
 export declare function ApiPropertyString(properties: TApiPropertyStringProperties): <Y>(target: object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;