@nest-omni/core 4.1.3-1 → 4.1.3-11

package/common/dto/dto-service-accessor.js

@@ -11,12 +11,22 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DtoServiceAccessor = void 0;
 const dto_container_1 = require("./dto-container");
+/**
+ * DTO服务访问器 - 使用全局容器获取服务
+ * 类似class-validator的useContainer机制
+ */
 class DtoServiceAccessor {
+    /**
+     * 获取服务实例
+     */
     static getService(serviceToken) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield dto_container_1.DtoContainer.get(serviceToken);
         });
     }
+    /**
+     * 批量获取服务
+     */
     static getServices(serviceTokens) {
         return __awaiter(this, void 0, void 0, function* () {
             const services = {};
@@ -33,8 +43,13 @@ class DtoServiceAccessor {
             return services;
         });
     }
+    /**
+     * 为特定DTO类获取所需服务
+     * 基于预定义的服务依赖列表
+     */
     static getServicesForDto(dtoClass) {
         return __awaiter(this, void 0, void 0, function* () {
+            // 从元数据获取服务依赖
             const serviceTokens = Reflect.getMetadata('dto:required-services', dtoClass) || [];
             if (serviceTokens.length === 0) {
                 return {};
@@ -42,6 +57,9 @@ class DtoServiceAccessor {
             return yield DtoServiceAccessor.getServices(serviceTokens);
         });
     }
+    /**
+     * 检查是否已初始化
+     */
     static isInitialized() {
         return dto_container_1.DtoContainer.isInitialized();
     }

package/common/dto/dto-transformer.d.ts

@@ -1,11 +1,23 @@
 import { Constructor } from '../types';
+/**
+ * DTO转换上下文
+ */
 export interface DtoTransformContext {
     user?: any;
     request?: any;
     services?: Record<string, any>;
     [key: string]: any;
 }
+/**
+ * 简化的DTO转换器 - 利用class-transformer和自动服务注入
+ */
 export declare class DtoTransformer {
+    /**
+     * 转换单个实体到DTO
+     */
     static transform<EntityType, DtoType>(entity: EntityType, dtoClass: Constructor<DtoType>, context?: DtoTransformContext): Promise<DtoType>;
+    /**
+     * 批量转换实体数组到DTO数组
+     */
     static transformArray<EntityType, DtoType>(entities: EntityType[], dtoClass: Constructor<DtoType>, context?: DtoTransformContext): Promise<DtoType[]>;
 }

package/common/dto/dto-transformer.js

@@ -12,7 +12,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DtoTransformer = void 0;
 const class_transformer_1 = require("class-transformer");
 const dto_service_accessor_1 = require("./dto-service-accessor");
+/**
+ * 简化的DTO转换器 - 利用class-transformer和自动服务注入
+ */
 class DtoTransformer {
+    /**
+     * 转换单个实体到DTO
+     */
     static transform(entity, dtoClass, context) {
         return __awaiter(this, void 0, void 0, function* () {
             const services = yield dto_service_accessor_1.DtoServiceAccessor.getServicesForDto(dtoClass);
@@ -27,6 +33,9 @@ class DtoTransformer {
             return (0, class_transformer_1.plainToInstance)(dtoClass, entity, options);
         });
     }
+    /**
+     * 批量转换实体数组到DTO数组
+     */
     static transformArray(entities, dtoClass, context) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!entities || entities.length === 0) {

package/common/dto/index.js

@@ -20,9 +20,11 @@ __exportStar(require("./create-translation.dto"), exports);
 __exportStar(require("./page.dto"), exports);
 __exportStar(require("./page-meta.dto"), exports);
 __exportStar(require("./page-options.dto"), exports);
+// 导出新的DTO转换功能
 __exportStar(require("./dto-service-accessor"), exports);
 __exportStar(require("./dto-decorators"), exports);
 __exportStar(require("./dto-transformer"), exports);
 __exportStar(require("./dto-extensions"), exports);
 __exportStar(require("./dto-container"), exports);
+// 需要导入扩展文件以激活原型方法扩展
 require("./dto-extensions");

package/common/examples/paginate-and-map.example.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Example usage of the paginateAndMap method with async transform
+ *
+ * This file demonstrates various ways to use the enhanced paginateAndMap method
+ * with support for both synchronous and asynchronous transform functions.
+ */
 import { Repository } from 'typeorm';
 import { PageOptionsDto } from '../dto/page-options.dto';
 export declare function basicPaginationExample(repository: Repository<any>, pageOptions: PageOptionsDto): Promise<import("..").PageDto<import("..").AbstractDto>>;

package/common/examples/paginate-and-map.example.js

@@ -1,4 +1,10 @@
 "use strict";
+/**
+ * Example usage of the paginateAndMap method with async transform
+ *
+ * This file demonstrates various ways to use the enhanced paginateAndMap method
+ * with support for both synchronous and asynchronous transform functions.
+ */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -24,6 +30,7 @@ exports.complexAsyncTransformExample = complexAsyncTransformExample;
 exports.iterateExample = iterateExample;
 exports.eachBatchSingleExample = eachBatchSingleExample;
 exports.eachBatchGroupExample = eachBatchGroupExample;
+// Example 1: Basic usage without transform
 function basicPaginationExample(repository, pageOptions) {
     return __awaiter(this, void 0, void 0, function* () {
         const result = yield repository
@@ -32,6 +39,7 @@ function basicPaginationExample(repository, pageOptions) {
         return result;
     });
 }
+// Example 2: Synchronous transform
 function syncTransformExample(repository, pageOptions) {
     return __awaiter(this, void 0, void 0, function* () {
         const result = yield repository
@@ -39,12 +47,14 @@ function syncTransformExample(repository, pageOptions) {
             .where('entity.isActive = :isActive', { isActive: true })
             .paginateAndMap(pageOptions, {
             transform: (items) => {
+                // Filter items synchronously
                 return items.filter(item => item.status === 'approved');
             },
         });
         return result;
     });
 }
+// Example 3: Async transform with external service call
 function asyncTransformExample(repository, pageOptions, externalService) {
     return __awaiter(this, void 0, void 0, function* () {
         const result = yield repository
@@ -52,16 +62,19 @@ function asyncTransformExample(repository, pageOptions, externalService) {
             .where('entity.isActive = :isActive', { isActive: true })
             .paginateAndMap(pageOptions, {
             transform: (items) => __awaiter(this, void 0, void 0, function* () {
+                // Enrich each item with data from external service
                 const enrichedItems = yield Promise.all(items.map((item) => __awaiter(this, void 0, void 0, function* () {
                     const additionalData = yield externalService.fetchData(item.id);
                     return Object.assign(Object.assign({}, item), { additionalData });
                 })));
+                // Filter after enrichment
                 return enrichedItems.filter(item => { var _a; return (_a = item.additionalData) === null || _a === void 0 ? void 0 : _a.isValid; });
             }),
         });
         return result;
     });
 }
+// Example 4: Async transform with batch processing
 function asyncBatchTransformExample(repository, pageOptions, batchProcessor) {
     return __awaiter(this, void 0, void 0, function* () {
         const result = yield repository
@@ -70,13 +83,16 @@ function asyncBatchTransformExample(repository, pageOptions, batchProcessor) {
             .paginateAndMap(pageOptions, {
             dtoOptions: { includeRelations: true },
             transform: (items) => __awaiter(this, void 0, void 0, function* () {
+                // Process items in batches for better performance
                 const processedItems = yield batchProcessor.processBatch(items);
+                // Additional filtering or transformation
                 return processedItems.map(item => (Object.assign(Object.assign({}, item), { processed: true, processedAt: new Date() })));
             }),
         });
         return result;
     });
 }
+// Example 5: Complex async transform with error handling
 function complexAsyncTransformExample(repository, pageOptions, services) {
     return __awaiter(this, void 0, void 0, function* () {
         const result = yield repository
@@ -85,6 +101,7 @@ function complexAsyncTransformExample(repository, pageOptions, services) {
             .paginateAndMap(pageOptions, {
             skipCount: false,
             transform: (items) => __awaiter(this, void 0, void 0, function* () {
+                // Step 1: Validate items
                 const validatedItems = yield Promise.all(items.map((item) => __awaiter(this, void 0, void 0, function* () {
                     try {
                         const isValid = yield services.validation.validate(item);
@@ -95,11 +112,14 @@ function complexAsyncTransformExample(repository, pageOptions, services) {
                         return null;
                     }
                 })));
+                // Filter out invalid items
                 const validItems = validatedItems.filter(item => item !== null);
+                // Step 2: Enrich with external data
                 const enrichedItems = yield Promise.all(validItems.map((item) => __awaiter(this, void 0, void 0, function* () {
                     const enrichmentData = yield services.enrichment.enrich(item.id);
                     return Object.assign(Object.assign({}, item), enrichmentData);
                 })));
+                // Step 3: Calculate derived fields
                 const finalItems = yield Promise.all(enrichedItems.map((item) => __awaiter(this, void 0, void 0, function* () {
                     const calculatedFields = yield services.calculation.calculate(item);
                     return Object.assign(Object.assign({}, item), calculatedFields);
@@ -110,6 +130,7 @@ function complexAsyncTransformExample(repository, pageOptions, services) {
         return result;
     });
 }
+// Example 6: Using iterate for large datasets
 function iterateExample(repository, processor) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a, e_1, _b, _c;
@@ -117,6 +138,7 @@ function iterateExample(repository, processor) {
             .createQueryBuilder('entity')
             .where('entity.needsProcessing = :needsProcessing', { needsProcessing: true });
         try {
+            // Process large dataset in batches without loading everything into memory
             for (var _d = true, _e = __asyncValues(queryBuilder.iterate({ batchSize: 500 })), _f; _f = yield _e.next(), _a = _f.done, !_a; _d = true) {
                 _c = _f.value;
                 _d = false;
@@ -134,23 +156,27 @@ function iterateExample(repository, processor) {
         }
     });
 }
+// Example 7: Using eachBatch with individual processing
 function eachBatchSingleExample(repository, processor) {
     return __awaiter(this, void 0, void 0, function* () {
         yield repository
             .createQueryBuilder('entity')
             .where('entity.status = :status', { status: 'pending' })
             .eachBatch((entity) => __awaiter(this, void 0, void 0, function* () {
+            // Process each entity individually
             console.log(`Processing entity ${entity.id}`);
             yield processor.processOne(entity);
         }), { batchSize: 100, mode: 'single' });
     });
 }
+// Example 8: Using eachBatch with batch processing
 function eachBatchGroupExample(repository, processor) {
     return __awaiter(this, void 0, void 0, function* () {
         yield repository
             .createQueryBuilder('entity')
             .where('entity.status = :status', { status: 'pending' })
             .eachBatch((batch) => __awaiter(this, void 0, void 0, function* () {
+            // Process entire batch at once
             console.log(`Processing batch of ${batch.length} entities`);
             yield processor.processBatch(batch);
         }), { batchSize: 500, mode: 'batch' });

package/common/utils.d.ts

@@ -1,4 +1,19 @@
+/**
+ * generate hash from password or string
+ * @param {string} password
+ * @returns {string}
+ */
 export declare function generateHash(password: string): string;
+/**
+ * validate text with hash
+ * @param {string} password
+ * @param {string} hash
+ * @returns {Promise<boolean>}
+ */
 export declare function validateHash(password: string | undefined, hash: string | undefined): Promise<boolean>;
 export declare function getVariableName<TResult>(getVar: () => TResult): string;
+/**
+ * Generate a unique request ID
+ * @returns {string}
+ */
 export declare function generateRequestId(): string;

package/common/utils.js

@@ -5,9 +5,20 @@ exports.validateHash = validateHash;
 exports.getVariableName = getVariableName;
 exports.generateRequestId = generateRequestId;
 const bcrypt_1 = require("bcrypt");
+/**
+ * generate hash from password or string
+ * @param {string} password
+ * @returns {string}
+ */
 function generateHash(password) {
     return bcrypt_1.default.hashSync(password, 10);
 }
+/**
+ * validate text with hash
+ * @param {string} password
+ * @param {string} hash
+ * @returns {Promise<boolean>}
+ */
 function validateHash(password, hash) {
     if (!password || !hash) {
         return Promise.resolve(false);
@@ -23,6 +34,10 @@ function getVariableName(getVar) {
     const memberParts = fullMemberName.split('.');
     return memberParts[memberParts.length - 1];
 }
+/**
+ * Generate a unique request ID
+ * @returns {string}
+ */
 function generateRequestId() {
     return Math.random().toString(36).substring(2, 15) +
         Math.random().toString(36).substring(2, 15) +

package/constants/language-code.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.supportedLanguageCount = exports.LanguageCode = void 0;
+/* eslint-disable @typescript-eslint/naming-convention */
 var LanguageCode;
 (function (LanguageCode) {
     LanguageCode["en_US"] = "en-US";

package/decorators/field.decorators.js

@@ -145,7 +145,7 @@ function StringFieldOptional(options = {}) {
 }
 function PasswordField(options = {}) {
     const decorators = [
-        StringField(Object.assign(Object.assign({}, options), { minLength: 6 })),
+        StringField(Object.assign(Object.assign({}, options), { minLength: 6 })) /*IsPassword()*/,
     ];
     if (options.nullable) {
         decorators.push((0, validator_decorators_1.IsNullable)());
@@ -223,7 +223,9 @@ function getEnumDescription(enumType) {
     const keys = Object.keys(enumType).filter((k) => typeof enumType[k] === 'number');
     return keys.map((k) => `${enumType[k]}: ${k}`).join(', ');
 }
+// eslint-disable-next-line @typescript-eslint/ban-types
 function EnumField(getEnum, options = {}) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/ban-types
     const enumValue = getEnum();
     const decorators = [
         (0, class_validator_1.IsEnum)(enumValue, {
@@ -245,7 +247,9 @@ function EnumField(getEnum, options = {}) {
     }
     return (0, common_1.applyDecorators)(...decorators);
 }
+// eslint-disable-next-line @typescript-eslint/ban-types
 function ClassField(getClass, options = {}) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const classValue = getClass();
     if (!classValue) {
         throw new Error('ClassField: recursive class definition');
@@ -271,9 +275,11 @@ function ClassField(getClass, options = {}) {
     }
     return (0, common_1.applyDecorators)(...decorators);
 }
+// eslint-disable-next-line @typescript-eslint/ban-types
 function EnumFieldOptional(getEnum, options = {}) {
     return (0, common_1.applyDecorators)((0, validator_decorators_1.IsEmptyable)(), EnumField(getEnum, Object.assign({ required: false }, options)));
 }
+// eslint-disable-next-line @typescript-eslint/ban-types
 function ClassFieldOptional(getClass, options = {}) {
     return (0, common_1.applyDecorators)((0, validator_decorators_1.IsEmptyable)(), ClassField(getClass, Object.assign({ required: false }, options)));
 }
@@ -407,6 +413,7 @@ function DateField(options = {}) {
         }));
     }
     if (options.swagger !== false) {
+        // Add default example with current date
         const swaggerOptions = Object.assign({ type: Date, example: (_a = options.example) !== null && _a !== void 0 ? _a : new Date() }, options);
         decorators.push((0, swagger_1.ApiProperty)(swaggerOptions));
     }

package/decorators/property.decorators.js

@@ -22,6 +22,7 @@ function ApiUUIDPropertyOptional(options = {}) {
     return ApiUUIDProperty(Object.assign({ required: false }, options));
 }
 function ApiEnumProperty(getEnum, options = {}) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const enumValue = getEnum();
     options.description = (0, field_decorators_1.getEnumDescription)(enumValue);
     return (0, swagger_1.ApiProperty)(Object.assign({ enum: enumValue, enumName: (0, utils_1.getVariableName)(getEnum) }, options));

package/decorators/public-route.decorator.js

@@ -3,5 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PublicRoute = exports.PUBLIC_ROUTE_KEY = void 0;
 const common_1 = require("@nestjs/common");
 exports.PUBLIC_ROUTE_KEY = 'public_route';
+// eslint-disable-next-line @typescript-eslint/naming-convention
 const PublicRoute = (isPublic = false) => (0, common_1.SetMetadata)(exports.PUBLIC_ROUTE_KEY, isPublic);
 exports.PublicRoute = PublicRoute;

package/decorators/transform.decorators.d.ts

@@ -1,6 +1,33 @@
+/**
+ * @description trim spaces from start and end, replace multiple spaces with one.
+ * @example
+ * @ApiProperty()
+ * @IsString()
+ * @Trim()
+ * name: string;
+ * @returns PropertyDecorator
+ * @constructor
+ */
 export declare function Trim(): PropertyDecorator;
 export declare function ToBoolean(): PropertyDecorator;
+/**
+ * @description convert string or number to integer
+ * @example
+ * @IsNumber()
+ * @ToInt()
+ * name: number;
+ * @returns PropertyDecorator
+ * @constructor
+ */
 export declare function ToInt(): PropertyDecorator;
+/**
+ * @description transforms to array, specially for query params
+ * @example
+ * @IsNumber()
+ * @ToArray()
+ * name: number;
+ * @constructor
+ */
 export declare function ToArray(): PropertyDecorator;
 export declare function ToLowerCase(): PropertyDecorator;
 export declare function ToUpperCase(): PropertyDecorator;

package/decorators/transform.decorators.js

@@ -12,12 +12,24 @@ const class_transformer_1 = require("class-transformer");
 const libphonenumber_js_1 = require("libphonenumber-js");
 const lodash_1 = require("lodash");
 const providers_1 = require("../providers");
+/**
+ * @description trim spaces from start and end, replace multiple spaces with one.
+ * @example
+ * @ApiProperty()
+ * @IsString()
+ * @Trim()
+ * name: string;
+ * @returns PropertyDecorator
+ * @constructor
+ */
 function Trim() {
     return (0, class_transformer_1.Transform)((params) => {
         const value = params.value;
         if ((0, lodash_1.isArray)(value)) {
+            // @ts-ignore
             return (0, lodash_1.map)(value, (v) => (0, lodash_1.trim)(v).replaceAll(/\s\s+/g, ' '));
         }
+        // @ts-ignore
         return (0, lodash_1.trim)(value).replaceAll(/\s\s+/g, ' ');
     });
 }
@@ -36,12 +48,29 @@ function ToBoolean() {
         }
     }, { toClassOnly: true });
 }
+/**
+ * @description convert string or number to integer
+ * @example
+ * @IsNumber()
+ * @ToInt()
+ * name: number;
+ * @returns PropertyDecorator
+ * @constructor
+ */
 function ToInt() {
     return (0, class_transformer_1.Transform)((params) => {
         const value = params.value;
         return Number.parseInt(value, 10);
     }, { toClassOnly: true });
 }
+/**
+ * @description transforms to array, specially for query params
+ * @example
+ * @IsNumber()
+ * @ToArray()
+ * name: number;
+ * @constructor
+ */
 function ToArray() {
     return (0, class_transformer_1.Transform)((params) => {
         const value = params.value;

package/decorators/translate.decorator.js

@@ -5,6 +5,7 @@ exports.StaticTranslate = StaticTranslate;
 exports.DynamicTranslate = DynamicTranslate;
 exports.STATIC_TRANSLATION_DECORATOR_KEY = 'custom:static-translate';
 exports.DYNAMIC_TRANSLATION_DECORATOR_KEY = 'custom:dynamic-translate';
+// FIXME: This is a temporary solution to get the translation decorator working.
 function StaticTranslate(data = {}) {
     return (target, key) => {
         Reflect.defineMetadata(exports.STATIC_TRANSLATION_DECORATOR_KEY, data, target, key);

package/decorators/user.decorator.js

@@ -14,6 +14,7 @@ function getOmniAuthData(request, key) {
     const headers = request.headers;
     let user;
     const configService = new config_1.ConfigService(request);
+    // 未通过网关透传用户信息且处于local开发环境，则从配置获取用户信息
     if ((0, lodash_1.isEmpty)(headers['x-user-id']) && (0, lodash_1.isEmpty)(headers['x-app-id'])) {
         if (process.env.NODE_ENV === 'dev' || process.env.MOCK_ENABLED === 'true') {
             user = {

package/decorators/validator.decorators.d.ts

@@ -1,18 +1,8 @@
-import type { ValidationOptions } from 'class-validator';
-import { IsPhoneNumber as isPhoneNumber, ValidationArguments, ValidatorConstraintInterface } from 'class-validator';
-export declare function IsPassword(validationOptions?: ValidationOptions): PropertyDecorator;
-export declare function IsPhoneNumber(validationOptions?: ValidationOptions & {
-    region?: Parameters<typeof isPhoneNumber>[0];
-}): PropertyDecorator;
-export declare function IsTmpKey(validationOptions?: ValidationOptions): PropertyDecorator;
-export declare function IsUndefinable(options?: ValidationOptions): PropertyDecorator;
-export declare function IsEmptyable(options?: ValidationOptions): PropertyDecorator;
-export declare function IsNullable(options?: ValidationOptions): PropertyDecorator;
-export declare function IsHttpUrl(validationOptions?: ValidationOptions): (object: any, propertyName: string) => void;
-export declare class AtLeastOneFieldConstraint implements ValidatorConstraintInterface {
-    validate(value: any, args: ValidationArguments): boolean;
-    defaultMessage(args: ValidationArguments): string;
-}
-export declare function AtLeastOneField(properties: string[], validationOptions?: ValidationOptions): PropertyDecorator;
-export declare function CustomValidation<T = any>(validationCallback: (value: T, args: ValidationArguments) => boolean | Promise<boolean>, validationOptions?: ValidationOptions): PropertyDecorator;
-export declare function CustomValidationMethod(methodName: string, validationOptions?: ValidationOptions): PropertyDecorator;
+/**
+ * Validator decorators
+ *
+ * 所有验证装饰器已迁移到 validators 目录
+ * 此文件仅用于重新导出，保持导入路径的一致性
+ */
+export * from '../validators/common-validators';
+export * from '../validators/custom-validate.validator';