@mikro-orm/core 7.0.4 → 7.0.5-dev.0

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 (206) hide show
  1. package/EntityManager.d.ts +583 -884
  2. package/EntityManager.js +1895 -1922
  3. package/MikroORM.d.ts +74 -103
  4. package/MikroORM.js +179 -178
  5. package/README.md +1 -1
  6. package/cache/CacheAdapter.d.ts +36 -36
  7. package/cache/FileCacheAdapter.d.ts +24 -30
  8. package/cache/FileCacheAdapter.js +78 -80
  9. package/cache/GeneratedCacheAdapter.d.ts +20 -18
  10. package/cache/GeneratedCacheAdapter.js +30 -30
  11. package/cache/MemoryCacheAdapter.d.ts +20 -18
  12. package/cache/MemoryCacheAdapter.js +36 -35
  13. package/cache/NullCacheAdapter.d.ts +16 -16
  14. package/cache/NullCacheAdapter.js +24 -24
  15. package/connections/Connection.d.ts +84 -95
  16. package/connections/Connection.js +168 -165
  17. package/drivers/DatabaseDriver.d.ts +80 -186
  18. package/drivers/DatabaseDriver.js +443 -450
  19. package/drivers/IDatabaseDriver.d.ts +301 -440
  20. package/entity/BaseEntity.d.ts +83 -120
  21. package/entity/BaseEntity.js +43 -43
  22. package/entity/Collection.d.ts +179 -212
  23. package/entity/Collection.js +721 -727
  24. package/entity/EntityAssigner.d.ts +77 -88
  25. package/entity/EntityAssigner.js +230 -231
  26. package/entity/EntityFactory.d.ts +54 -66
  27. package/entity/EntityFactory.js +383 -425
  28. package/entity/EntityHelper.d.ts +22 -34
  29. package/entity/EntityHelper.js +267 -280
  30. package/entity/EntityIdentifier.d.ts +4 -4
  31. package/entity/EntityIdentifier.js +10 -10
  32. package/entity/EntityLoader.d.ts +72 -98
  33. package/entity/EntityLoader.js +723 -753
  34. package/entity/EntityRepository.d.ts +201 -316
  35. package/entity/EntityRepository.js +213 -213
  36. package/entity/PolymorphicRef.d.ts +5 -5
  37. package/entity/PolymorphicRef.js +10 -10
  38. package/entity/Reference.d.ts +82 -126
  39. package/entity/Reference.js +274 -278
  40. package/entity/WrappedEntity.d.ts +72 -115
  41. package/entity/WrappedEntity.js +166 -168
  42. package/entity/defineEntity.d.ts +636 -1315
  43. package/entity/defineEntity.js +518 -527
  44. package/entity/utils.d.ts +3 -13
  45. package/entity/utils.js +73 -71
  46. package/entity/validators.js +43 -43
  47. package/entity/wrap.js +8 -8
  48. package/enums.d.ts +253 -258
  49. package/enums.js +252 -251
  50. package/errors.d.ts +72 -114
  51. package/errors.js +253 -350
  52. package/events/EventManager.d.ts +14 -26
  53. package/events/EventManager.js +77 -79
  54. package/events/EventSubscriber.d.ts +29 -29
  55. package/events/TransactionEventBroadcaster.d.ts +8 -15
  56. package/events/TransactionEventBroadcaster.js +14 -14
  57. package/exceptions.d.ts +40 -23
  58. package/exceptions.js +52 -35
  59. package/hydration/Hydrator.d.ts +17 -42
  60. package/hydration/Hydrator.js +43 -43
  61. package/hydration/ObjectHydrator.d.ts +17 -50
  62. package/hydration/ObjectHydrator.js +416 -481
  63. package/index.d.ts +2 -116
  64. package/index.js +1 -10
  65. package/logging/DefaultLogger.d.ts +32 -34
  66. package/logging/DefaultLogger.js +86 -86
  67. package/logging/Logger.d.ts +41 -41
  68. package/logging/SimpleLogger.d.ts +11 -13
  69. package/logging/SimpleLogger.js +22 -22
  70. package/logging/colors.d.ts +6 -6
  71. package/logging/colors.js +10 -11
  72. package/logging/inspect.js +7 -7
  73. package/metadata/EntitySchema.d.ts +127 -211
  74. package/metadata/EntitySchema.js +398 -397
  75. package/metadata/MetadataDiscovery.d.ts +114 -114
  76. package/metadata/MetadataDiscovery.js +1870 -1951
  77. package/metadata/MetadataProvider.d.ts +21 -24
  78. package/metadata/MetadataProvider.js +84 -82
  79. package/metadata/MetadataStorage.d.ts +32 -38
  80. package/metadata/MetadataStorage.js +118 -118
  81. package/metadata/MetadataValidator.d.ts +39 -39
  82. package/metadata/MetadataValidator.js +338 -381
  83. package/metadata/discover-entities.d.ts +2 -5
  84. package/metadata/discover-entities.js +37 -35
  85. package/metadata/types.d.ts +531 -615
  86. package/naming-strategy/AbstractNamingStrategy.d.ts +39 -54
  87. package/naming-strategy/AbstractNamingStrategy.js +85 -90
  88. package/naming-strategy/EntityCaseNamingStrategy.d.ts +6 -6
  89. package/naming-strategy/EntityCaseNamingStrategy.js +22 -22
  90. package/naming-strategy/MongoNamingStrategy.d.ts +6 -6
  91. package/naming-strategy/MongoNamingStrategy.js +18 -18
  92. package/naming-strategy/NamingStrategy.d.ts +99 -109
  93. package/naming-strategy/UnderscoreNamingStrategy.d.ts +7 -7
  94. package/naming-strategy/UnderscoreNamingStrategy.js +21 -21
  95. package/not-supported.js +4 -7
  96. package/package.json +1 -1
  97. package/platforms/ExceptionConverter.d.ts +1 -1
  98. package/platforms/ExceptionConverter.js +4 -4
  99. package/platforms/Platform.d.ts +301 -310
  100. package/platforms/Platform.js +640 -663
  101. package/serialization/EntitySerializer.d.ts +26 -49
  102. package/serialization/EntitySerializer.js +218 -224
  103. package/serialization/EntityTransformer.d.ts +6 -10
  104. package/serialization/EntityTransformer.js +217 -219
  105. package/serialization/SerializationContext.d.ts +23 -27
  106. package/serialization/SerializationContext.js +105 -105
  107. package/types/ArrayType.d.ts +8 -8
  108. package/types/ArrayType.js +33 -33
  109. package/types/BigIntType.d.ts +10 -17
  110. package/types/BigIntType.js +37 -37
  111. package/types/BlobType.d.ts +3 -3
  112. package/types/BlobType.js +13 -13
  113. package/types/BooleanType.d.ts +4 -4
  114. package/types/BooleanType.js +12 -12
  115. package/types/CharacterType.d.ts +2 -2
  116. package/types/CharacterType.js +6 -6
  117. package/types/DateTimeType.d.ts +5 -5
  118. package/types/DateTimeType.js +15 -15
  119. package/types/DateType.d.ts +5 -5
  120. package/types/DateType.js +15 -15
  121. package/types/DecimalType.d.ts +7 -7
  122. package/types/DecimalType.js +26 -26
  123. package/types/DoubleType.d.ts +3 -3
  124. package/types/DoubleType.js +12 -12
  125. package/types/EnumArrayType.d.ts +5 -5
  126. package/types/EnumArrayType.js +24 -24
  127. package/types/EnumType.d.ts +3 -3
  128. package/types/EnumType.js +11 -11
  129. package/types/FloatType.d.ts +3 -3
  130. package/types/FloatType.js +9 -9
  131. package/types/IntegerType.d.ts +3 -3
  132. package/types/IntegerType.js +9 -9
  133. package/types/IntervalType.d.ts +4 -4
  134. package/types/IntervalType.js +12 -12
  135. package/types/JsonType.d.ts +8 -8
  136. package/types/JsonType.js +32 -32
  137. package/types/MediumIntType.d.ts +1 -1
  138. package/types/MediumIntType.js +3 -3
  139. package/types/SmallIntType.d.ts +3 -3
  140. package/types/SmallIntType.js +9 -9
  141. package/types/StringType.d.ts +4 -4
  142. package/types/StringType.js +12 -12
  143. package/types/TextType.d.ts +3 -3
  144. package/types/TextType.js +9 -9
  145. package/types/TimeType.d.ts +5 -5
  146. package/types/TimeType.js +17 -17
  147. package/types/TinyIntType.d.ts +3 -3
  148. package/types/TinyIntType.js +10 -10
  149. package/types/Type.d.ts +79 -83
  150. package/types/Type.js +82 -82
  151. package/types/Uint8ArrayType.d.ts +4 -4
  152. package/types/Uint8ArrayType.js +21 -21
  153. package/types/UnknownType.d.ts +4 -4
  154. package/types/UnknownType.js +12 -12
  155. package/types/UuidType.d.ts +5 -5
  156. package/types/UuidType.js +19 -19
  157. package/types/index.d.ts +49 -75
  158. package/types/index.js +26 -52
  159. package/typings.d.ts +737 -1250
  160. package/typings.js +231 -244
  161. package/unit-of-work/ChangeSet.d.ts +26 -26
  162. package/unit-of-work/ChangeSet.js +56 -56
  163. package/unit-of-work/ChangeSetComputer.d.ts +12 -12
  164. package/unit-of-work/ChangeSetComputer.js +170 -178
  165. package/unit-of-work/ChangeSetPersister.d.ts +44 -63
  166. package/unit-of-work/ChangeSetPersister.js +421 -442
  167. package/unit-of-work/CommitOrderCalculator.d.ts +40 -40
  168. package/unit-of-work/CommitOrderCalculator.js +88 -89
  169. package/unit-of-work/IdentityMap.d.ts +31 -31
  170. package/unit-of-work/IdentityMap.js +105 -105
  171. package/unit-of-work/UnitOfWork.d.ts +141 -181
  172. package/unit-of-work/UnitOfWork.js +1183 -1200
  173. package/utils/AbstractMigrator.d.ts +91 -111
  174. package/utils/AbstractMigrator.js +275 -275
  175. package/utils/AbstractSchemaGenerator.d.ts +34 -43
  176. package/utils/AbstractSchemaGenerator.js +122 -121
  177. package/utils/AsyncContext.d.ts +3 -3
  178. package/utils/AsyncContext.js +35 -34
  179. package/utils/Configuration.d.ts +808 -852
  180. package/utils/Configuration.js +344 -359
  181. package/utils/Cursor.d.ts +22 -40
  182. package/utils/Cursor.js +127 -135
  183. package/utils/DataloaderUtils.d.ts +43 -58
  184. package/utils/DataloaderUtils.js +198 -203
  185. package/utils/EntityComparator.d.ts +81 -98
  186. package/utils/EntityComparator.js +732 -828
  187. package/utils/NullHighlighter.d.ts +1 -1
  188. package/utils/NullHighlighter.js +3 -3
  189. package/utils/QueryHelper.d.ts +51 -79
  190. package/utils/QueryHelper.js +361 -372
  191. package/utils/RawQueryFragment.d.ts +34 -50
  192. package/utils/RawQueryFragment.js +105 -107
  193. package/utils/RequestContext.d.ts +32 -32
  194. package/utils/RequestContext.js +53 -52
  195. package/utils/TransactionContext.d.ts +16 -16
  196. package/utils/TransactionContext.js +27 -27
  197. package/utils/TransactionManager.d.ts +58 -58
  198. package/utils/TransactionManager.js +197 -199
  199. package/utils/Utils.d.ts +145 -204
  200. package/utils/Utils.js +812 -812
  201. package/utils/clone.js +113 -104
  202. package/utils/env-vars.js +88 -90
  203. package/utils/fs-utils.d.ts +15 -15
  204. package/utils/fs-utils.js +181 -180
  205. package/utils/upsert-utils.d.ts +5 -20
  206. package/utils/upsert-utils.js +116 -114
@@ -2,14 +2,14 @@
2
2
  * @internal
3
3
  */
4
4
  export class EntityIdentifier {
5
- value;
6
- constructor(value) {
7
- this.value = value;
8
- }
9
- setValue(value) {
10
- this.value = value;
11
- }
12
- getValue() {
13
- return this.value;
14
- }
5
+ value;
6
+ constructor(value) {
7
+ this.value = value;
8
+ }
9
+ setValue(value) {
10
+ this.value = value;
11
+ }
12
+ getValue() {
13
+ return this.value;
14
+ }
15
15
  }
@@ -1,108 +1,82 @@
1
- import type {
2
- AnyEntity,
3
- AutoPath,
4
- ConnectionType,
5
- EntityName,
6
- EntityProperty,
7
- FilterQuery,
8
- PopulateOptions,
9
- } from '../typings.js';
1
+ import type { AnyEntity, AutoPath, ConnectionType, EntityName, EntityProperty, FilterQuery, PopulateOptions } from '../typings.js';
10
2
  import type { EntityManager } from '../EntityManager.js';
11
3
  import { LoadStrategy, type LockMode, type PopulateHint, PopulatePath, type QueryOrderMap } from '../enums.js';
12
4
  import type { FilterOptions } from '../drivers/IDatabaseDriver.js';
13
5
  import type { LoggingOptions } from '../logging/Logger.js';
14
6
  /** Options for controlling how relations are loaded by the EntityLoader. */
15
7
  export interface EntityLoaderOptions<Entity, Fields extends string = never, Excludes extends string = never> {
16
- /** Select specific fields to load (partial loading). */
17
- fields?: readonly AutoPath<Entity, Fields, `${PopulatePath.ALL}`>[];
18
- /** Fields to exclude from loading. */
19
- exclude?: readonly AutoPath<Entity, Excludes>[];
20
- /** Additional filtering conditions applied to populated relations. */
21
- where?: FilterQuery<Entity>;
22
- /** Controls how `where` conditions are applied to populated relations. */
23
- populateWhere?: PopulateHint | `${PopulateHint}`;
24
- /** Ordering for populated relations. */
25
- orderBy?: QueryOrderMap<Entity> | QueryOrderMap<Entity>[];
26
- /** Whether to reload already loaded entities. */
27
- refresh?: boolean;
28
- /** Whether to validate the populate hint against the entity metadata. */
29
- validate?: boolean;
30
- /** Whether to look up eager-loaded relationships automatically. */
31
- lookup?: boolean;
32
- /** Whether to convert custom types during hydration. */
33
- convertCustomTypes?: boolean;
34
- /** Whether to skip loading lazy scalar properties. */
35
- ignoreLazyScalarProperties?: boolean;
36
- /** Filter options to apply when loading relations. */
37
- filters?: FilterOptions;
38
- /** Loading strategy to use (select-in, joined, or balanced). */
39
- strategy?: LoadStrategy | `${LoadStrategy}`;
40
- /** Lock mode for the query (pessimistic locking). */
41
- lockMode?: Exclude<LockMode, LockMode.OPTIMISTIC>;
42
- /** Database schema override. */
43
- schema?: string;
44
- /** Connection type (read or write replica). */
45
- connectionType?: ConnectionType;
46
- /** Logging options for the query. */
47
- logging?: LoggingOptions;
8
+ /** Select specific fields to load (partial loading). */
9
+ fields?: readonly AutoPath<Entity, Fields, `${PopulatePath.ALL}`>[];
10
+ /** Fields to exclude from loading. */
11
+ exclude?: readonly AutoPath<Entity, Excludes>[];
12
+ /** Additional filtering conditions applied to populated relations. */
13
+ where?: FilterQuery<Entity>;
14
+ /** Controls how `where` conditions are applied to populated relations. */
15
+ populateWhere?: PopulateHint | `${PopulateHint}`;
16
+ /** Ordering for populated relations. */
17
+ orderBy?: QueryOrderMap<Entity> | QueryOrderMap<Entity>[];
18
+ /** Whether to reload already loaded entities. */
19
+ refresh?: boolean;
20
+ /** Whether to validate the populate hint against the entity metadata. */
21
+ validate?: boolean;
22
+ /** Whether to look up eager-loaded relationships automatically. */
23
+ lookup?: boolean;
24
+ /** Whether to convert custom types during hydration. */
25
+ convertCustomTypes?: boolean;
26
+ /** Whether to skip loading lazy scalar properties. */
27
+ ignoreLazyScalarProperties?: boolean;
28
+ /** Filter options to apply when loading relations. */
29
+ filters?: FilterOptions;
30
+ /** Loading strategy to use (select-in, joined, or balanced). */
31
+ strategy?: LoadStrategy | `${LoadStrategy}`;
32
+ /** Lock mode for the query (pessimistic locking). */
33
+ lockMode?: Exclude<LockMode, LockMode.OPTIMISTIC>;
34
+ /** Database schema override. */
35
+ schema?: string;
36
+ /** Connection type (read or write replica). */
37
+ connectionType?: ConnectionType;
38
+ /** Logging options for the query. */
39
+ logging?: LoggingOptions;
48
40
  }
49
41
  /** Responsible for batch-loading entity relations using either select-in or joined loading strategies. */
50
42
  export declare class EntityLoader {
51
- #private;
52
- constructor(em: EntityManager);
53
- /**
54
- * Loads specified relations in batch.
55
- * This will execute one query for each relation, that will populate it on all the specified entities.
56
- */
57
- populate<Entity extends object, Fields extends string = never>(
58
- entityName: EntityName<Entity>,
59
- entities: Entity[],
60
- populate: PopulateOptions<Entity>[] | boolean,
61
- options: EntityLoaderOptions<Entity, Fields>,
62
- ): Promise<void>;
63
- /** Normalizes populate hints into a structured array of PopulateOptions, expanding dot paths and eager relations. */
64
- normalizePopulate<Entity>(
65
- entityName: EntityName<Entity>,
66
- populate: (PopulateOptions<Entity> | boolean)[] | PopulateOptions<Entity> | boolean,
67
- strategy?: LoadStrategy,
68
- lookup?: boolean,
69
- exclude?: string[],
70
- ): PopulateOptions<Entity>[];
71
- private setSerializationContext;
72
- /**
73
- * Merge multiple populates for the same entity with different children. Also skips `*` fields, those can come from
74
- * partial loading hints (`fields`) that are used to infer the `populate` hint if missing.
75
- */
76
- private mergeNestedPopulate;
77
- /**
78
- * preload everything in one call (this will update already existing references in IM)
79
- */
80
- private populateMany;
81
- private populateScalar;
82
- private populatePolymorphic;
83
- private initializeCollections;
84
- private initializeOneToMany;
85
- private initializeManyToMany;
86
- private findChildren;
87
- private mergePrimaryCondition;
88
- private populateField;
89
- /** @internal */
90
- findChildrenFromPivotTable<Entity extends object>(
91
- filtered: Entity[],
92
- prop: EntityProperty<Entity>,
93
- options: Required<EntityLoaderOptions<Entity>>,
94
- orderBy?: QueryOrderMap<Entity>[],
95
- populate?: PopulateOptions<Entity>,
96
- pivotJoin?: boolean,
97
- ): Promise<AnyEntity[][]>;
98
- private extractChildCondition;
99
- private buildFields;
100
- private getChildReferences;
101
- private filterCollections;
102
- private isPropertyLoaded;
103
- private filterReferences;
104
- private filterByReferences;
105
- private lookupAllRelationships;
106
- private getRelationName;
107
- private lookupEagerLoadedRelationships;
43
+ #private;
44
+ constructor(em: EntityManager);
45
+ /**
46
+ * Loads specified relations in batch.
47
+ * This will execute one query for each relation, that will populate it on all the specified entities.
48
+ */
49
+ populate<Entity extends object, Fields extends string = never>(entityName: EntityName<Entity>, entities: Entity[], populate: PopulateOptions<Entity>[] | boolean, options: EntityLoaderOptions<Entity, Fields>): Promise<void>;
50
+ /** Normalizes populate hints into a structured array of PopulateOptions, expanding dot paths and eager relations. */
51
+ normalizePopulate<Entity>(entityName: EntityName<Entity>, populate: (PopulateOptions<Entity> | boolean)[] | PopulateOptions<Entity> | boolean, strategy?: LoadStrategy, lookup?: boolean, exclude?: string[]): PopulateOptions<Entity>[];
52
+ private setSerializationContext;
53
+ /**
54
+ * Merge multiple populates for the same entity with different children. Also skips `*` fields, those can come from
55
+ * partial loading hints (`fields`) that are used to infer the `populate` hint if missing.
56
+ */
57
+ private mergeNestedPopulate;
58
+ /**
59
+ * preload everything in one call (this will update already existing references in IM)
60
+ */
61
+ private populateMany;
62
+ private populateScalar;
63
+ private populatePolymorphic;
64
+ private initializeCollections;
65
+ private initializeOneToMany;
66
+ private initializeManyToMany;
67
+ private findChildren;
68
+ private mergePrimaryCondition;
69
+ private populateField;
70
+ /** @internal */
71
+ findChildrenFromPivotTable<Entity extends object>(filtered: Entity[], prop: EntityProperty<Entity>, options: Required<EntityLoaderOptions<Entity>>, orderBy?: QueryOrderMap<Entity>[], populate?: PopulateOptions<Entity>, pivotJoin?: boolean): Promise<AnyEntity[][]>;
72
+ private extractChildCondition;
73
+ private buildFields;
74
+ private getChildReferences;
75
+ private filterCollections;
76
+ private isPropertyLoaded;
77
+ private filterReferences;
78
+ private filterByReferences;
79
+ private lookupAllRelationships;
80
+ private getRelationName;
81
+ private lookupEagerLoadedRelationships;
108
82
  }