@nest-omni/core 4.1.3-0 → 4.1.3-10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (242) hide show
  1. package/audit/audit.module.d.ts +10 -0
  2. package/audit/audit.module.js +15 -0
  3. package/audit/controllers/audit.controller.d.ts +24 -0
  4. package/audit/controllers/audit.controller.js +24 -0
  5. package/audit/decorators/audit-controller.decorator.d.ts +8 -0
  6. package/audit/decorators/audit-controller.decorator.js +9 -0
  7. package/audit/decorators/audit-operation.decorator.d.ts +45 -0
  8. package/audit/decorators/audit-operation.decorator.js +49 -0
  9. package/audit/decorators/entity-audit.decorator.d.ts +8 -0
  10. package/audit/decorators/entity-audit.decorator.js +9 -0
  11. package/audit/dto/audit-log-query.dto.d.ts +3 -0
  12. package/audit/dto/audit-log-query.dto.js +3 -0
  13. package/audit/dto/begin-transaction.dto.d.ts +3 -0
  14. package/audit/dto/begin-transaction.dto.js +3 -0
  15. package/audit/dto/compare-entities.dto.d.ts +3 -0
  16. package/audit/dto/compare-entities.dto.js +3 -0
  17. package/audit/dto/pre-check-restore.dto.d.ts +3 -0
  18. package/audit/dto/pre-check-restore.dto.js +3 -0
  19. package/audit/dto/restore-entity.dto.d.ts +3 -0
  20. package/audit/dto/restore-entity.dto.js +3 -0
  21. package/audit/entities/entity-audit-log.entity.d.ts +3 -0
  22. package/audit/entities/entity-audit-log.entity.js +3 -0
  23. package/audit/entities/entity-transaction.entity.d.ts +3 -0
  24. package/audit/entities/entity-transaction.entity.js +3 -0
  25. package/audit/entities/manual-operation-log.entity.d.ts +4 -0
  26. package/audit/entities/manual-operation-log.entity.js +4 -0
  27. package/audit/entities/operation-template.entity.d.ts +4 -0
  28. package/audit/entities/operation-template.entity.js +4 -0
  29. package/audit/enums/audit.enums.d.ts +17 -2
  30. package/audit/enums/audit.enums.js +15 -0
  31. package/audit/index.js +10 -0
  32. package/audit/interceptors/audit.interceptor.d.ts +15 -0
  33. package/audit/interceptors/audit.interceptor.js +23 -1
  34. package/audit/interfaces/audit.interfaces.d.ts +42 -0
  35. package/audit/services/audit-context.service.d.ts +15 -0
  36. package/audit/services/audit-context.service.js +15 -0
  37. package/audit/services/audit-strategy.service.d.ts +6 -0
  38. package/audit/services/audit-strategy.service.js +13 -0
  39. package/audit/services/entity-audit.service.d.ts +57 -0
  40. package/audit/services/entity-audit.service.js +91 -0
  41. package/audit/services/manual-audit-log.service.d.ts +124 -0
  42. package/audit/services/manual-audit-log.service.js +138 -0
  43. package/audit/services/multi-database.service.d.ts +12 -0
  44. package/audit/services/multi-database.service.js +12 -0
  45. package/audit/services/operation-description.service.d.ts +59 -0
  46. package/audit/services/operation-description.service.js +76 -2
  47. package/audit/services/transaction-audit.service.d.ts +30 -0
  48. package/audit/services/transaction-audit.service.js +47 -0
  49. package/audit/subscribers/entity-audit.subscriber.d.ts +15 -0
  50. package/audit/subscribers/entity-audit.subscriber.js +29 -1
  51. package/cache/cache-metrics.service.d.ts +67 -0
  52. package/cache/cache-metrics.service.js +68 -4
  53. package/cache/cache-serialization.service.d.ts +31 -0
  54. package/cache/cache-serialization.service.js +25 -0
  55. package/cache/cache.constants.d.ts +9 -0
  56. package/cache/cache.constants.js +9 -0
  57. package/cache/cache.health.d.ts +26 -0
  58. package/cache/cache.health.js +30 -0
  59. package/cache/cache.module.d.ts +86 -0
  60. package/cache/cache.module.js +71 -0
  61. package/cache/cache.service.d.ts +140 -0
  62. package/cache/cache.service.js +157 -0
  63. package/cache/cache.warmup.service.d.ts +39 -0
  64. package/cache/cache.warmup.service.js +32 -0
  65. package/cache/decorators/cache-evict.decorator.d.ts +47 -0
  66. package/cache/decorators/cache-evict.decorator.js +56 -0
  67. package/cache/decorators/cache-put.decorator.d.ts +34 -0
  68. package/cache/decorators/cache-put.decorator.js +39 -0
  69. package/cache/decorators/cacheable.decorator.d.ts +40 -0
  70. package/cache/decorators/cacheable.decorator.js +55 -0
  71. package/cache/dependencies/callback.dependency.d.ts +33 -0
  72. package/cache/dependencies/callback.dependency.js +39 -1
  73. package/cache/dependencies/chain.dependency.d.ts +28 -0
  74. package/cache/dependencies/chain.dependency.js +34 -0
  75. package/cache/dependencies/db.dependency.d.ts +45 -0
  76. package/cache/dependencies/db.dependency.js +48 -1
  77. package/cache/dependencies/file.dependency.d.ts +32 -0
  78. package/cache/dependencies/file.dependency.js +34 -0
  79. package/cache/dependencies/tag.dependency.d.ts +36 -0
  80. package/cache/dependencies/tag.dependency.js +36 -0
  81. package/cache/dependencies/time.dependency.d.ts +43 -0
  82. package/cache/dependencies/time.dependency.js +43 -0
  83. package/cache/examples/basic-usage.d.ts +15 -0
  84. package/cache/examples/basic-usage.js +62 -8
  85. package/cache/index.js +9 -0
  86. package/cache/interfaces/cache-dependency.interface.d.ts +53 -0
  87. package/cache/interfaces/cache-options.interface.d.ts +81 -0
  88. package/cache/interfaces/cache-options.interface.js +6 -0
  89. package/cache/interfaces/cache-provider.interface.d.ts +78 -0
  90. package/cache/providers/base-cache.provider.d.ts +14 -0
  91. package/cache/providers/base-cache.provider.js +16 -0
  92. package/cache/providers/cls-cache.provider.d.ts +20 -0
  93. package/cache/providers/cls-cache.provider.js +28 -0
  94. package/cache/providers/memory-cache.provider.d.ts +23 -0
  95. package/cache/providers/memory-cache.provider.js +26 -0
  96. package/cache/providers/redis-cache.provider.d.ts +26 -0
  97. package/cache/providers/redis-cache.provider.js +29 -0
  98. package/cache/utils/dependency-manager.util.d.ts +52 -0
  99. package/cache/utils/dependency-manager.util.js +59 -0
  100. package/cache/utils/key-generator.util.d.ts +42 -0
  101. package/cache/utils/key-generator.util.js +53 -1
  102. package/common/abstract.entity.d.ts +14 -0
  103. package/common/abstract.entity.js +14 -0
  104. package/common/boilerplate.polyfill.d.ts +142 -4
  105. package/common/boilerplate.polyfill.js +24 -131
  106. package/common/dto/dto-container.d.ts +16 -0
  107. package/common/dto/dto-container.js +20 -0
  108. package/common/dto/dto-decorators.d.ts +18 -0
  109. package/common/dto/dto-decorators.js +14 -0
  110. package/common/dto/dto-extensions.d.ts +11 -0
  111. package/common/dto/dto-extensions.js +9 -0
  112. package/common/dto/dto-service-accessor.d.ts +17 -0
  113. package/common/dto/dto-service-accessor.js +18 -0
  114. package/common/dto/dto-transformer.d.ts +12 -0
  115. package/common/dto/dto-transformer.js +9 -0
  116. package/common/dto/index.js +2 -0
  117. package/common/examples/paginate-and-map.example.d.ts +6 -0
  118. package/common/examples/paginate-and-map.example.js +26 -0
  119. package/common/utils.d.ts +15 -0
  120. package/common/utils.js +15 -0
  121. package/constants/language-code.js +1 -0
  122. package/decorators/field.decorators.js +8 -1
  123. package/decorators/property.decorators.js +1 -0
  124. package/decorators/public-route.decorator.js +1 -0
  125. package/decorators/transform.decorators.d.ts +27 -0
  126. package/decorators/transform.decorators.js +29 -0
  127. package/decorators/translate.decorator.js +1 -0
  128. package/decorators/user.decorator.js +1 -0
  129. package/decorators/validator.decorators.d.ts +8 -18
  130. package/decorators/validator.decorators.js +22 -190
  131. package/filters/constraint-errors.js +1 -0
  132. package/helpers/common.helper.d.ts +13 -0
  133. package/helpers/common.helper.js +13 -0
  134. package/http-client/config/http-client.config.d.ts +15 -0
  135. package/http-client/config/http-client.config.js +25 -9
  136. package/http-client/decorators/http-client.decorators.d.ts +63 -0
  137. package/http-client/decorators/http-client.decorators.js +71 -3
  138. package/http-client/entities/http-log.entity.d.ts +229 -0
  139. package/http-client/entities/http-log.entity.js +6 -1
  140. package/http-client/errors/http-client.errors.d.ts +57 -0
  141. package/http-client/errors/http-client.errors.js +58 -0
  142. package/http-client/examples/advanced-usage.example.d.ts +41 -0
  143. package/http-client/examples/advanced-usage.example.js +68 -24
  144. package/http-client/examples/auth-with-waiting-lock.example.d.ts +31 -0
  145. package/http-client/examples/auth-with-waiting-lock.example.js +52 -5
  146. package/http-client/examples/basic-usage.example.d.ts +60 -0
  147. package/http-client/examples/basic-usage.example.js +60 -0
  148. package/http-client/examples/multi-api-configuration.example.d.ts +60 -0
  149. package/http-client/examples/multi-api-configuration.example.js +76 -5
  150. package/http-client/http-client.module.d.ts +13 -0
  151. package/http-client/http-client.module.js +19 -0
  152. package/http-client/index.js +8 -0
  153. package/http-client/interfaces/api-client-config.interface.d.ts +125 -0
  154. package/http-client/interfaces/api-client-config.interface.js +3 -0
  155. package/http-client/interfaces/http-client-config.interface.d.ts +60 -0
  156. package/http-client/services/api-client-registry.service.d.ts +57 -0
  157. package/http-client/services/api-client-registry.service.js +84 -1
  158. package/http-client/services/cache.service.d.ts +52 -0
  159. package/http-client/services/cache.service.js +72 -3
  160. package/http-client/services/circuit-breaker.service.d.ts +46 -0
  161. package/http-client/services/circuit-breaker.service.js +52 -0
  162. package/http-client/services/http-client.service.d.ts +67 -0
  163. package/http-client/services/http-client.service.js +105 -4
  164. package/http-client/services/http-log-query.service.d.ts +83 -0
  165. package/http-client/services/http-log-query.service.js +122 -1
  166. package/http-client/services/http-replay.service.d.ts +101 -0
  167. package/http-client/services/http-replay.service.js +86 -0
  168. package/http-client/services/log-cleanup.service.d.ts +63 -0
  169. package/http-client/services/log-cleanup.service.js +54 -2
  170. package/http-client/services/logging.service.d.ts +40 -0
  171. package/http-client/services/logging.service.js +53 -0
  172. package/http-client/utils/call-stack-extractor.util.d.ts +37 -0
  173. package/http-client/utils/call-stack-extractor.util.js +48 -0
  174. package/http-client/utils/context-extractor.util.d.ts +49 -0
  175. package/http-client/utils/context-extractor.util.js +52 -0
  176. package/http-client/utils/curl-generator.util.d.ts +21 -0
  177. package/http-client/utils/curl-generator.util.js +44 -3
  178. package/http-client/utils/request-id.util.d.ts +18 -0
  179. package/http-client/utils/request-id.util.js +20 -0
  180. package/http-client/utils/retry-recorder.util.d.ts +42 -0
  181. package/http-client/utils/retry-recorder.util.js +44 -0
  182. package/i18n/en_US/validation.json +2 -1
  183. package/i18n/zh_CN/validation.json +2 -1
  184. package/index.js +8 -0
  185. package/interceptors/translation-interceptor.service.js +5 -0
  186. package/package.json +1 -1
  187. package/providers/context.provider.js +2 -0
  188. package/providers/generator.provider.d.ts +4 -0
  189. package/providers/generator.provider.js +4 -0
  190. package/redis-lock/comprehensive-lock-cleanup.service.d.ts +94 -0
  191. package/redis-lock/comprehensive-lock-cleanup.service.js +253 -0
  192. package/redis-lock/examples/lock-strategy.examples.d.ts +89 -0
  193. package/redis-lock/examples/lock-strategy.examples.js +130 -15
  194. package/redis-lock/index.d.ts +2 -0
  195. package/redis-lock/index.js +8 -1
  196. package/redis-lock/lock-heartbeat.service.d.ts +78 -0
  197. package/redis-lock/lock-heartbeat.service.js +222 -0
  198. package/redis-lock/redis-lock.decorator.d.ts +101 -0
  199. package/redis-lock/redis-lock.decorator.js +120 -0
  200. package/redis-lock/redis-lock.module.d.ts +66 -0
  201. package/redis-lock/redis-lock.module.js +175 -70
  202. package/redis-lock/redis-lock.service.d.ts +260 -0
  203. package/redis-lock/redis-lock.service.js +244 -4
  204. package/setup/bootstrap.setup.js +20 -0
  205. package/setup/mode.setup.d.ts +44 -0
  206. package/setup/mode.setup.js +44 -0
  207. package/setup/schedule.decorator.d.ts +227 -0
  208. package/setup/schedule.decorator.js +219 -6
  209. package/setup/worker.decorator.d.ts +86 -0
  210. package/setup/worker.decorator.js +88 -0
  211. package/shared/serviceRegistryModule.js +9 -1
  212. package/shared/services/api-config.service.d.ts +3 -0
  213. package/shared/services/api-config.service.js +20 -9
  214. package/validator-json/decorators.d.ts +17 -0
  215. package/validator-json/decorators.js +17 -2
  216. package/validator-json/default.d.ts +6 -0
  217. package/validator-json/default.js +30 -2
  218. package/validator-json/defaultConverters.js +1 -0
  219. package/validator-json/options.d.ts +23 -0
  220. package/validators/common-validators.d.ts +143 -0
  221. package/validators/common-validators.js +249 -0
  222. package/validators/custom-validate.examples.d.ts +96 -0
  223. package/validators/custom-validate.examples.js +400 -0
  224. package/validators/custom-validate.validator.d.ts +134 -0
  225. package/validators/custom-validate.validator.js +214 -0
  226. package/validators/index.d.ts +2 -0
  227. package/validators/index.js +2 -0
  228. package/validators/is-exists.validator.d.ts +18 -4
  229. package/validators/is-exists.validator.js +67 -6
  230. package/validators/is-unique.validator.d.ts +32 -5
  231. package/validators/is-unique.validator.js +99 -17
  232. package/validators/skip-empty.validator.d.ts +5 -0
  233. package/validators/skip-empty.validator.js +5 -0
  234. package/vault/interfaces/vault-options.interface.d.ts +9 -0
  235. package/vault/vault-config.loader.d.ts +30 -0
  236. package/vault/vault-config.loader.js +48 -1
  237. package/vault/vault-config.service.d.ts +53 -0
  238. package/vault/vault-config.service.js +57 -0
  239. package/vault/vault.module.d.ts +4 -0
  240. package/vault/vault.module.js +4 -0
  241. package/decorators/examples/validation-decorators.example.d.ts +0 -69
  242. package/decorators/examples/validation-decorators.example.js +0 -331
@@ -1,60 +1,112 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.KeyGenerator = void 0;
4
+ /**
5
+ * Utility class for generating cache keys
6
+ */
4
7
  class KeyGenerator {
8
+ /**
9
+ * Generate cache key from options and method arguments
10
+ *
11
+ * @param options - Cache key options
12
+ * @param args - Method arguments
13
+ * @returns Generated cache key
14
+ */
5
15
  static generate(options, args) {
6
16
  let key;
7
17
  if (typeof options.key === 'function') {
18
+ // Dynamic key generation using function
8
19
  key = options.key(...args);
9
20
  }
10
21
  else if (typeof options.key === 'string') {
22
+ // Static key
11
23
  key = options.key;
12
24
  }
13
25
  else if (options.includeAllArgs) {
26
+ // Auto-generate key from all arguments
14
27
  key = this.generateFromArgs(args);
15
28
  }
16
29
  else {
30
+ // Default: use first argument as key
17
31
  key = args.length > 0 ? String(args[0]) : 'default';
18
32
  }
33
+ // Add prefix if specified
19
34
  if (options.prefix) {
20
35
  key = `${options.prefix}${key}`;
21
36
  }
22
37
  return key;
23
38
  }
39
+ /**
40
+ * Generate key from method arguments
41
+ *
42
+ * @param args - Method arguments
43
+ * @returns Serialized key
44
+ */
24
45
  static generateFromArgs(args) {
25
46
  if (args.length === 0) {
26
47
  return 'default';
27
48
  }
28
49
  try {
50
+ // Serialize arguments to JSON
29
51
  return JSON.stringify(args);
30
52
  }
31
53
  catch (_a) {
54
+ // Fallback to string concatenation
32
55
  return args.map((arg) => String(arg)).join(':');
33
56
  }
34
57
  }
58
+ /**
59
+ * Normalize key (remove invalid characters, enforce length limits)
60
+ *
61
+ * @param key - Raw key
62
+ * @param maxLength - Maximum key length (default 250)
63
+ * @returns Normalized key
64
+ */
35
65
  static normalize(key, maxLength = 250) {
66
+ // Remove or replace invalid characters
36
67
  let normalized = key.replace(/[\s\n\r\t]/g, '_');
68
+ // Enforce length limit
37
69
  if (normalized.length > maxLength) {
70
+ // Use hash for long keys
38
71
  const hash = this.hashCode(normalized);
39
72
  normalized = normalized.substring(0, maxLength - 10) + '_' + hash;
40
73
  }
41
74
  return normalized;
42
75
  }
76
+ /**
77
+ * Add namespace to key
78
+ *
79
+ * @param key - Original key
80
+ * @param namespace - Namespace
81
+ * @returns Namespaced key
82
+ */
43
83
  static addNamespace(key, namespace) {
44
84
  if (!namespace) {
45
85
  return key;
46
86
  }
47
87
  return `${namespace}:${key}`;
48
88
  }
89
+ /**
90
+ * Generate hash code for a string
91
+ *
92
+ * @param str - Input string
93
+ * @returns Hash code as string
94
+ */
49
95
  static hashCode(str) {
50
96
  let hash = 0;
51
97
  for (let i = 0; i < str.length; i++) {
52
98
  const char = str.charCodeAt(i);
53
99
  hash = (hash << 5) - hash + char;
54
- hash = hash & hash;
100
+ hash = hash & hash; // Convert to 32bit integer
55
101
  }
56
102
  return Math.abs(hash).toString(36);
57
103
  }
104
+ /**
105
+ * Parse pattern into segments for matching
106
+ *
107
+ * @param pattern - Pattern with wildcards
108
+ * @returns Pattern segments
109
+ */
58
110
  static parsePattern(pattern) {
59
111
  const wildcardIndex = pattern.indexOf('*');
60
112
  if (wildcardIndex === -1) {
@@ -1,9 +1,23 @@
1
1
  import type { AbstractDto, AbstractTranslationDto } from './dto/abstract.dto';
2
2
  import { LanguageCode } from '../constants';
3
+ /**
4
+ * Abstract DTO-able Entity
5
+ *
6
+ * @description Base class that provides toDto functionality without any database fields.
7
+ * Use this for view entities or other entities that don't need createdAt/updatedAt fields.
8
+ */
3
9
  export declare abstract class AbstractDtoEntity<DTO, O = never> {
4
10
  translations?: AbstractTranslationEntity[];
5
11
  toDto(options?: O): DTO;
6
12
  }
13
+ /**
14
+ * Abstract Entity
15
+ *
16
+ * @description This class is an abstract class for all entities.
17
+ * It's experimental and recommended using it only in microservice architecture,
18
+ * otherwise just delete and use your own entity.
19
+ * Extends AbstractDtoEntity and adds createdAt/updatedAt timestamp fields.
20
+ */
7
21
  export declare abstract class AbstractBaseEntity<DTO, O> extends AbstractDtoEntity<DTO, O> {
8
22
  createdAt: Date;
9
23
  updatedAt: Date;
@@ -14,6 +14,12 @@ const typeorm_1 = require("typeorm");
14
14
  const decorators_1 = require("../decorators");
15
15
  const constants_1 = require("../constants");
16
16
  const uuid_1 = require("uuid");
17
+ /**
18
+ * Abstract DTO-able Entity
19
+ *
20
+ * @description Base class that provides toDto functionality without any database fields.
21
+ * Use this for view entities or other entities that don't need createdAt/updatedAt fields.
22
+ */
17
23
  class AbstractDtoEntity {
18
24
  toDto(options) {
19
25
  const dtoClass = Object.getPrototypeOf(this).dtoClass;
@@ -24,6 +30,14 @@ class AbstractDtoEntity {
24
30
  }
25
31
  }
26
32
  exports.AbstractDtoEntity = AbstractDtoEntity;
33
+ /**
34
+ * Abstract Entity
35
+ *
36
+ * @description This class is an abstract class for all entities.
37
+ * It's experimental and recommended using it only in microservice architecture,
38
+ * otherwise just delete and use your own entity.
39
+ * Extends AbstractDtoEntity and adds createdAt/updatedAt timestamp fields.
40
+ */
27
41
  class AbstractBaseEntity extends AbstractDtoEntity {
28
42
  }
29
43
  exports.AbstractBaseEntity = AbstractBaseEntity;
@@ -16,10 +16,6 @@ declare global {
16
16
  }
17
17
  }
18
18
  declare module 'typeorm' {
19
- interface Repository<Entity extends ObjectLiteral> {
20
- saveWithPk(this: Repository<Entity>, entity: Entity | Entity[]): Promise<Entity | Entity[]>;
21
- getPrimaryKeyFields(this: Repository<Entity>): string[];
22
- }
23
19
  interface SelectQueryBuilder<Entity> {
24
20
  searchByString(q: string, columnNames: string[], options?: {
25
21
  formStart: boolean;
@@ -29,6 +25,91 @@ declare module 'typeorm' {
29
25
  takeAll: boolean;
30
26
  skipCount: boolean;
31
27
  }>): Promise<[Entity[], PageMetaDto]>;
28
+ /**
29
+ * Paginate and automatically map entities to DTOs in a single call.
30
+ * This method combines paginate() and toPageDto() into one convenient method.
31
+ *
32
+ * @param pageOptionsDto Pagination options (page, pageSize, order, etc.)
33
+ * @param options Configuration options
34
+ * @param options.dtoOptions Options to pass to the toDto() method of each entity
35
+ * @param options.skipCount Skip counting total items (improves performance)
36
+ * @param options.takeAll Fetch all items without limit (ignores pageSize)
37
+ * @param options.transform Optional callback to transform items before mapping to DTOs (supports both sync and async)
38
+ *
39
+ * @example
40
+ * Basic usage - automatically maps entities to DTOs:
41
+ * ```typescript
42
+ * const queryBuilder = userRepository.createQueryBuilder('user');
43
+ * const pageDto = await queryBuilder.paginateAndMap(pageOptionsDto);
44
+ * return pageDto; // Returns PageDto<UserDto>
45
+ * ```
46
+ *
47
+ * @example
48
+ * With toDto options:
49
+ * ```typescript
50
+ * const queryBuilder = userRepository.createQueryBuilder('user');
51
+ * const pageDto = await queryBuilder.paginateAndMap(pageOptionsDto, {
52
+ * dtoOptions: { includeRelations: true }
53
+ * });
54
+ * ```
55
+ *
56
+ * @example
57
+ * With synchronous transform callback:
58
+ * ```typescript
59
+ * const queryBuilder = orderRepository.createQueryBuilder('order');
60
+ * const pageDto = await queryBuilder.paginateAndMap(pageOptionsDto, {
61
+ * transform: (items) => items.filter(order => order.status === 'active')
62
+ * });
63
+ * ```
64
+ *
65
+ * @example
66
+ * With async transform callback for complex operations:
67
+ * ```typescript
68
+ * const queryBuilder = orderRepository.createQueryBuilder('order');
69
+ * const pageDto = await queryBuilder.paginateAndMap(pageOptionsDto, {
70
+ * transform: async (items) => {
71
+ * // Perform async operations on items
72
+ * const enrichedItems = await Promise.all(
73
+ * items.map(async (order) => {
74
+ * order.additionalData = await externalService.getData(order.id);
75
+ * return order;
76
+ * })
77
+ * );
78
+ * return enrichedItems.filter(order => order.isValid);
79
+ * }
80
+ * });
81
+ * ```
82
+ *
83
+ * @example
84
+ * Complete example with all options:
85
+ * ```typescript
86
+ * const queryBuilder = productRepository
87
+ * .createQueryBuilder('product')
88
+ * .leftJoinAndSelect('product.category', 'category')
89
+ * .where('product.isActive = :isActive', { isActive: true });
90
+ *
91
+ * const pageDto = await queryBuilder.paginateAndMap(pageOptionsDto, {
92
+ * dtoOptions: { includeCategory: true },
93
+ * skipCount: false,
94
+ * transform: async (items) => {
95
+ * // Enrich products with external data
96
+ * const enrichedProducts = await Promise.all(
97
+ * items.map(async (product) => {
98
+ * product.reviews = await reviewService.getReviews(product.id);
99
+ * return product;
100
+ * })
101
+ * );
102
+ * // Filter out products with no stock
103
+ * return enrichedProducts.filter(product => product.stock > 0);
104
+ * }
105
+ * });
106
+ *
107
+ * // Returns PageDto<ProductDto> with enriched and filtered data
108
+ * return pageDto;
109
+ * ```
110
+ *
111
+ * @returns Promise resolving to PageDto with mapped DTOs
112
+ */
32
113
  paginateAndMap<Dto extends AbstractDto, DtoOptions = unknown>(this: SelectQueryBuilder<Entity>, pageOptionsDto: PageOptionsDto, options?: Partial<{
33
114
  dtoOptions: DtoOptions;
34
115
  skipCount: boolean;
@@ -39,9 +120,66 @@ declare module 'typeorm' {
39
120
  leftJoin<AliasEntity extends AbstractEntity, A extends string>(this: SelectQueryBuilder<Entity>, property: `${A}.${Exclude<KeyOfType<AliasEntity, AbstractEntity>, symbol>}`, alias: string, condition?: string, parameters?: ObjectLiteral): this;
40
121
  innerJoinAndSelect<AliasEntity extends AbstractEntity, A extends string>(this: SelectQueryBuilder<Entity>, property: `${A}.${Exclude<KeyOfType<AliasEntity, AbstractEntity>, symbol>}`, alias: string, condition?: string, parameters?: ObjectLiteral): this;
41
122
  innerJoin<AliasEntity extends AbstractEntity, A extends string>(this: SelectQueryBuilder<Entity>, property: `${A}.${Exclude<KeyOfType<AliasEntity, AbstractEntity>, symbol>}`, alias: string, condition?: string, parameters?: ObjectLiteral): this;
123
+ /**
124
+ * Iterate over entity results in batches using async iteration.
125
+ *
126
+ * @param options.batchSize Number of entities to retrieve per batch (default: 1000)
127
+ *
128
+ * @example
129
+ * ```typescript
130
+ * const queryBuilder = repository.createQueryBuilder('entity');
131
+ *
132
+ * for await (const batch of queryBuilder.iterate({ batchSize: 500 })) {
133
+ * console.log(`Processing batch of ${batch.length} entities`);
134
+ * // Process each batch of entities
135
+ * await processEntities(batch);
136
+ * }
137
+ * ```
138
+ *
139
+ * @returns An async iterator that yields arrays of entities
140
+ */
42
141
  iterate(this: SelectQueryBuilder<Entity>, options?: {
43
142
  batchSize?: number;
44
143
  }): AsyncIterableIterator<Entity[]>;
144
+ /**
145
+ * Process entity results in batches by calling a callback function.
146
+ * The callback can accept either individual entities or batches of entities.
147
+ *
148
+ * @param callback Function to process each entity or batch of entities
149
+ * @param options
150
+ * @param options.batchSize Number of entities to retrieve per batch (default: 1000)
151
+ * @param options.mode Whether to pass entities individually or as batches to the callback (default: 'batch')
152
+ *
153
+ * @example
154
+ * Processing individual entities:
155
+ * ```typescript
156
+ * const queryBuilder = repository.createQueryBuilder('entity');
157
+ *
158
+ * await queryBuilder.eachBatch(
159
+ * async (entity) => {
160
+ * // Process each individual entity
161
+ * console.log(`Processing entity: ${entity.id}`);
162
+ * await processEntity(entity);
163
+ * },
164
+ * { batchSize: 100, mode: 'single' }
165
+ * );
166
+ * ```
167
+ *
168
+ * @example
169
+ * Processing batches of entities:
170
+ * ```typescript
171
+ * const queryBuilder = repository.createQueryBuilder('entity');
172
+ *
173
+ * await queryBuilder.eachBatch(
174
+ * async (batch) => {
175
+ * // Process each batch of entities
176
+ * console.log(`Processing batch of ${batch.length} entities`);
177
+ * await processEntities(batch);
178
+ * },
179
+ * { batchSize: 500, mode: 'batch' }
180
+ * );
181
+ * ```
182
+ */
45
183
  eachBatch(this: SelectQueryBuilder<Entity>, callback: (item: Entity) => Promise<void> | void, options?: {
46
184
  batchSize?: number;
47
185
  mode?: 'single';
@@ -25,30 +25,32 @@ Object.defineProperty(exports, "__esModule", { value: true });
25
25
  require("source-map-support/register");
26
26
  const lodash_1 = require("lodash");
27
27
  const typeorm_1 = require("typeorm");
28
- const typeorm_2 = require("typeorm");
29
28
  const page_dto_1 = require("./dto/page.dto");
30
29
  const page_meta_dto_1 = require("./dto/page-meta.dto");
31
30
  const providers_1 = require("../providers");
32
31
  Array.prototype.toDtos = function (options) {
33
32
  return (0, lodash_1.compact)((0, lodash_1.map)(this, (item) => {
33
+ // Check if item exists and has toDto method
34
34
  if (item && typeof item.toDto === 'function') {
35
35
  return item.toDto(options);
36
36
  }
37
+ // Skip items that don't have toDto method
37
38
  return undefined;
38
39
  }));
39
40
  };
40
41
  Array.prototype.getByLanguage = function (languageCode) {
42
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
41
43
  return this.find((translation) => languageCode === translation.languageCode)
42
44
  .text;
43
45
  };
44
46
  Array.prototype.toPageDto = function (pageMetaDto, options) {
45
47
  return new page_dto_1.PageDto(this.toDtos(options), pageMetaDto);
46
48
  };
47
- typeorm_2.SelectQueryBuilder.prototype.searchByString = function (q, columnNames, options) {
49
+ typeorm_1.SelectQueryBuilder.prototype.searchByString = function (q, columnNames, options) {
48
50
  if (!q) {
49
51
  return this;
50
52
  }
51
- this.andWhere(new typeorm_2.Brackets((qb) => {
53
+ this.andWhere(new typeorm_1.Brackets((qb) => {
52
54
  for (const item of columnNames) {
53
55
  qb.orWhere(`${item} ILIKE :q`);
54
56
  }
@@ -61,7 +63,7 @@ typeorm_2.SelectQueryBuilder.prototype.searchByString = function (q, columnNames
61
63
  }
62
64
  return this;
63
65
  };
64
- typeorm_2.SelectQueryBuilder.prototype.paginate = function (pageOptionsDto, options) {
66
+ typeorm_1.SelectQueryBuilder.prototype.paginate = function (pageOptionsDto, options) {
65
67
  return __awaiter(this, void 0, void 0, function* () {
66
68
  if (!(options === null || options === void 0 ? void 0 : options.takeAll)) {
67
69
  this.skip(pageOptionsDto.skip).take(pageOptionsDto.pageSize);
@@ -78,20 +80,26 @@ typeorm_2.SelectQueryBuilder.prototype.paginate = function (pageOptionsDto, opti
78
80
  return [entities, pageMetaDto];
79
81
  });
80
82
  };
81
- typeorm_2.SelectQueryBuilder.prototype.paginateAndMap = function (pageOptionsDto, options) {
83
+ /**
84
+ * Implementation of paginateAndMap
85
+ */
86
+ typeorm_1.SelectQueryBuilder.prototype.paginateAndMap = function (pageOptionsDto, options) {
82
87
  return __awaiter(this, void 0, void 0, function* () {
88
+ // Call paginate to get entities and meta
83
89
  const [entities, pageMetaDto] = yield this.paginate(pageOptionsDto, {
84
90
  skipCount: options === null || options === void 0 ? void 0 : options.skipCount,
85
91
  takeAll: options === null || options === void 0 ? void 0 : options.takeAll,
86
92
  });
93
+ // Apply transform if provided (support both sync and async)
87
94
  let transformedEntities = entities;
88
95
  if (options === null || options === void 0 ? void 0 : options.transform) {
89
96
  transformedEntities = yield options.transform(entities);
90
97
  }
98
+ // Convert to DTOs and return PageDto
91
99
  return transformedEntities.toPageDto(pageMetaDto, options === null || options === void 0 ? void 0 : options.dtoOptions);
92
100
  });
93
101
  };
94
- typeorm_2.SelectQueryBuilder.prototype.withTenant = function (tenantId, tenantFieldName = 'tenantId') {
102
+ typeorm_1.SelectQueryBuilder.prototype.withTenant = function (tenantId, tenantFieldName = 'tenantId') {
95
103
  var _a;
96
104
  if (!tenantId) {
97
105
  tenantId = providers_1.ContextProvider.getTenantId();
@@ -107,7 +115,10 @@ typeorm_2.SelectQueryBuilder.prototype.withTenant = function (tenantId, tenantFi
107
115
  }
108
116
  return this;
109
117
  };
110
- typeorm_2.SelectQueryBuilder.prototype.iterate = function (options) {
118
+ /**
119
+ * Implementation for the async iterator method
120
+ */
121
+ typeorm_1.SelectQueryBuilder.prototype.iterate = function (options) {
111
122
  return __asyncGenerator(this, arguments, function* () {
112
123
  const batchSize = (options === null || options === void 0 ? void 0 : options.batchSize) || 100;
113
124
  let offset = 0;
@@ -125,7 +136,10 @@ typeorm_2.SelectQueryBuilder.prototype.iterate = function (options) {
125
136
  }
126
137
  });
127
138
  };
128
- typeorm_2.SelectQueryBuilder.prototype.eachBatch = function (callback, options) {
139
+ /**
140
+ * Implementation for the callback-based iteration method
141
+ */
142
+ typeorm_1.SelectQueryBuilder.prototype.eachBatch = function (callback, options) {
129
143
  return __awaiter(this, void 0, void 0, function* () {
130
144
  const batchSize = (options === null || options === void 0 ? void 0 : options.batchSize) || 100;
131
145
  const mode = (options === null || options === void 0 ? void 0 : options.mode) || 'batch';
@@ -135,11 +149,13 @@ typeorm_2.SelectQueryBuilder.prototype.eachBatch = function (callback, options)
135
149
  const batch = yield this.clone().skip(offset).take(batchSize).getMany();
136
150
  if (batch.length > 0) {
137
151
  if (mode === 'single') {
152
+ // Process each entity individually
138
153
  for (const item of batch) {
139
154
  yield callback(item);
140
155
  }
141
156
  }
142
157
  else {
158
+ // Process the entire batch
143
159
  yield callback(batch);
144
160
  }
145
161
  offset += batchSize;
@@ -151,126 +167,3 @@ typeorm_2.SelectQueryBuilder.prototype.eachBatch = function (callback, options)
151
167
  }
152
168
  });
153
169
  };
154
- const insertWithPk = function (entity) {
155
- return __awaiter(this, void 0, void 0, function* () {
156
- if (!this.metadata) {
157
- throw new Error('Repository metadata is not available. Make sure the repository is properly initialized.');
158
- }
159
- const tableName = this.metadata.tableName;
160
- const columns = this.metadata.columns;
161
- const columnNames = [];
162
- const columnValues = [];
163
- const valuePlaceholders = [];
164
- for (const column of columns) {
165
- const propertyName = column.propertyName;
166
- const value = entity[propertyName];
167
- if (value === undefined) {
168
- continue;
169
- }
170
- const columnName = column.databaseName;
171
- if (columnName) {
172
- columnNames.push(columnName);
173
- columnValues.push(value);
174
- valuePlaceholders.push(`$${columnValues.length}`);
175
- }
176
- }
177
- const connection = this.manager.connection;
178
- const databaseType = connection.options.type;
179
- try {
180
- let result;
181
- if (['postgres', 'sqlite'].includes(databaseType)) {
182
- const sql = `INSERT INTO ${tableName} (${columnNames.join(', ')}) VALUES (${valuePlaceholders.join(', ')}) RETURNING *`;
183
- const queryResult = yield this.query(sql, columnValues);
184
- result = queryResult;
185
- }
186
- else if (['mysql', 'mariadb'].includes(databaseType)) {
187
- const insertSql = `INSERT INTO ${tableName} (${columnNames.join(', ')}) VALUES (${valuePlaceholders.join(', ')})`;
188
- yield this.query(insertSql, columnValues);
189
- const pkFields = this.getPrimaryKeyFields();
190
- const whereConditions = pkFields.map(pkField => {
191
- const column = columns.find(col => col.propertyName === pkField);
192
- const dbName = (column === null || column === void 0 ? void 0 : column.databaseName) || pkField;
193
- return `${dbName} = ?`;
194
- });
195
- const pkValues = pkFields.map(pkField => entity[pkField]);
196
- const selectSql = `SELECT * FROM ${tableName} WHERE ${whereConditions.join(' AND ')}`;
197
- const queryResult = yield this.query(selectSql, pkValues);
198
- result = queryResult;
199
- }
200
- else {
201
- const sql = `INSERT INTO ${tableName} (${columnNames.join(', ')}) VALUES (${valuePlaceholders.join(', ')})`;
202
- yield this.query(sql, columnValues);
203
- return entity;
204
- }
205
- if (result && result.length > 0) {
206
- return result[0];
207
- }
208
- else {
209
- console.warn(`Native SQL insert completed but no result returned for ${tableName}, falling back to regular save`);
210
- return yield this.save(entity);
211
- }
212
- }
213
- catch (error) {
214
- console.warn(`Native SQL insert failed for ${tableName}, falling back to regular save:`, error);
215
- return yield this.save(entity);
216
- }
217
- });
218
- };
219
- typeorm_1.Repository.prototype.getPrimaryKeyFields = function () {
220
- if (!this.metadata) {
221
- throw new Error('Repository metadata is not available. Make sure the repository is properly initialized.');
222
- }
223
- const primaryKeys = this.metadata.primaryColumns;
224
- if (!primaryKeys || primaryKeys.length === 0) {
225
- throw new Error(`Entity ${this.metadata.targetName} does not have any primary key columns defined.`);
226
- }
227
- return primaryKeys.map(column => column.propertyName);
228
- };
229
- typeorm_1.Repository.prototype.saveWithPk = function (entity) {
230
- return __awaiter(this, void 0, void 0, function* () {
231
- const isArray = Array.isArray(entity);
232
- const entities = isArray ? entity : [entity];
233
- if (entities.length === 0) {
234
- return isArray ? [] : null;
235
- }
236
- const pkFields = this.getPrimaryKeyFields();
237
- const results = yield Promise.all(entities.map((singleEntity) => __awaiter(this, void 0, void 0, function* () {
238
- const hasPkValues = pkFields.every(pkField => {
239
- const value = singleEntity[pkField];
240
- return value !== undefined && value !== null && value !== '';
241
- });
242
- if (hasPkValues) {
243
- try {
244
- const existingEntity = yield this.findOne({
245
- where: pkFields.reduce((acc, pkField) => {
246
- acc[pkField] = singleEntity[pkField];
247
- return acc;
248
- }, {})
249
- });
250
- if (existingEntity) {
251
- yield this.update(pkFields.reduce((acc, pkField) => {
252
- acc[pkField] = singleEntity[pkField];
253
- return acc;
254
- }, {}), singleEntity);
255
- return yield this.findOne({
256
- where: pkFields.reduce((acc, pkField) => {
257
- acc[pkField] = singleEntity[pkField];
258
- return acc;
259
- }, {})
260
- });
261
- }
262
- else {
263
- return yield insertWithPk.call(this, singleEntity);
264
- }
265
- }
266
- catch (error) {
267
- return yield insertWithPk.call(this, singleEntity);
268
- }
269
- }
270
- else {
271
- return yield this.save(singleEntity);
272
- }
273
- })));
274
- return isArray ? results : results[0];
275
- });
276
- };
@@ -1,9 +1,25 @@
1
+ /**
2
+ * DTO容器 - 类似class-validator的useContainer机制
3
+ * 全局存储服务容器,供DTO转换时使用
4
+ */
1
5
  export declare class DtoContainer {
2
6
  private static instance;
3
7
  private container;
4
8
  static getInstance(): DtoContainer;
9
+ /**
10
+ * 设置容器 - 类似useContainer
11
+ */
5
12
  static useContainer(container: any): void;
13
+ /**
14
+ * 获取服务实例
15
+ */
6
16
  static get<T = any>(serviceToken: string | symbol | any): Promise<T | null>;
17
+ /**
18
+ * 检查容器是否已初始化
19
+ */
7
20
  static isInitialized(): boolean;
21
+ /**
22
+ * 重置容器 (主要用于测试)
23
+ */
8
24
  static reset(): void;
9
25
  }
@@ -10,6 +10,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
10
10
  };
11
11
  Object.defineProperty(exports, "__esModule", { value: true });
12
12
  exports.DtoContainer = void 0;
13
+ /**
14
+ * DTO容器 - 类似class-validator的useContainer机制
15
+ * 全局存储服务容器,供DTO转换时使用
16
+ */
13
17
  class DtoContainer {
14
18
  constructor() {
15
19
  this.container = null;
@@ -20,9 +24,15 @@ class DtoContainer {
20
24
  }
21
25
  return DtoContainer.instance;
22
26
  }
27
+ /**
28
+ * 设置容器 - 类似useContainer
29
+ */
23
30
  static useContainer(container) {
24
31
  DtoContainer.getInstance().container = container;
25
32
  }
33
+ /**
34
+ * 获取服务实例
35
+ */
26
36
  static get(serviceToken) {
27
37
  return __awaiter(this, void 0, void 0, function* () {
28
38
  const instance = DtoContainer.getInstance();
@@ -31,13 +41,17 @@ class DtoContainer {
31
41
  return null;
32
42
  }
33
43
  try {
44
+ // 支持多种容器类型
34
45
  if (typeof instance.container.get === 'function') {
46
+ // NestJS容器
35
47
  return yield instance.container.get(serviceToken);
36
48
  }
37
49
  else if (typeof instance.container.resolve === 'function') {
50
+ // ModuleRef
38
51
  return yield instance.container.resolve(serviceToken);
39
52
  }
40
53
  else if (typeof instance.container[serviceToken] === 'function') {
54
+ // 直接的服务实例
41
55
  return instance.container[serviceToken];
42
56
  }
43
57
  console.warn(`Unable to resolve service: ${String(serviceToken)}`);
@@ -49,9 +63,15 @@ class DtoContainer {
49
63
  }
50
64
  });
51
65
  }
66
+ /**
67
+ * 检查容器是否已初始化
68
+ */
52
69
  static isInitialized() {
53
70
  return DtoContainer.getInstance().container !== null;
54
71
  }
72
+ /**
73
+ * 重置容器 (主要用于测试)
74
+ */
55
75
  static reset() {
56
76
  DtoContainer.getInstance().container = null;
57
77
  }