@mikro-orm/core 7.0.0-dev.32 → 7.0.0-dev.321

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 (216) hide show
  1. package/EntityManager.d.ts +71 -63
  2. package/EntityManager.js +365 -283
  3. package/MikroORM.d.ts +44 -35
  4. package/MikroORM.js +109 -142
  5. package/README.md +7 -4
  6. package/cache/FileCacheAdapter.d.ts +1 -2
  7. package/cache/FileCacheAdapter.js +19 -14
  8. package/cache/GeneratedCacheAdapter.d.ts +0 -1
  9. package/cache/GeneratedCacheAdapter.js +0 -2
  10. package/cache/index.d.ts +1 -2
  11. package/cache/index.js +0 -2
  12. package/connections/Connection.d.ts +12 -5
  13. package/connections/Connection.js +37 -15
  14. package/drivers/DatabaseDriver.d.ts +25 -18
  15. package/drivers/DatabaseDriver.js +144 -45
  16. package/drivers/IDatabaseDriver.d.ts +118 -23
  17. package/entity/BaseEntity.d.ts +63 -4
  18. package/entity/BaseEntity.js +0 -3
  19. package/entity/Collection.d.ts +101 -29
  20. package/entity/Collection.js +473 -115
  21. package/entity/EntityAssigner.js +37 -25
  22. package/entity/EntityFactory.d.ts +7 -1
  23. package/entity/EntityFactory.js +116 -64
  24. package/entity/EntityHelper.d.ts +2 -2
  25. package/entity/EntityHelper.js +69 -27
  26. package/entity/EntityLoader.d.ts +11 -10
  27. package/entity/EntityLoader.js +264 -102
  28. package/entity/EntityRepository.d.ts +28 -8
  29. package/entity/EntityRepository.js +8 -2
  30. package/entity/PolymorphicRef.d.ts +12 -0
  31. package/entity/PolymorphicRef.js +18 -0
  32. package/entity/Reference.d.ts +2 -6
  33. package/entity/Reference.js +52 -19
  34. package/entity/WrappedEntity.d.ts +3 -8
  35. package/entity/WrappedEntity.js +6 -7
  36. package/entity/defineEntity.d.ts +525 -311
  37. package/entity/defineEntity.js +134 -290
  38. package/entity/index.d.ts +2 -2
  39. package/entity/index.js +2 -2
  40. package/entity/utils.d.ts +6 -1
  41. package/entity/utils.js +46 -11
  42. package/entity/validators.d.ts +11 -0
  43. package/entity/validators.js +66 -0
  44. package/enums.d.ts +8 -6
  45. package/enums.js +13 -17
  46. package/errors.d.ts +20 -10
  47. package/errors.js +63 -31
  48. package/events/EventManager.d.ts +2 -1
  49. package/events/EventManager.js +24 -13
  50. package/events/index.d.ts +1 -1
  51. package/events/index.js +0 -1
  52. package/exceptions.js +9 -2
  53. package/hydration/Hydrator.js +1 -2
  54. package/hydration/ObjectHydrator.d.ts +4 -4
  55. package/hydration/ObjectHydrator.js +105 -46
  56. package/index.d.ts +2 -2
  57. package/index.js +1 -2
  58. package/logging/DefaultLogger.d.ts +1 -1
  59. package/logging/DefaultLogger.js +3 -4
  60. package/logging/SimpleLogger.d.ts +1 -1
  61. package/logging/colors.d.ts +1 -1
  62. package/logging/colors.js +5 -7
  63. package/logging/index.d.ts +2 -1
  64. package/logging/index.js +1 -1
  65. package/logging/inspect.d.ts +2 -0
  66. package/logging/inspect.js +11 -0
  67. package/metadata/EntitySchema.d.ts +47 -23
  68. package/metadata/EntitySchema.js +103 -34
  69. package/metadata/MetadataDiscovery.d.ts +64 -9
  70. package/metadata/MetadataDiscovery.js +867 -354
  71. package/metadata/MetadataProvider.d.ts +11 -2
  72. package/metadata/MetadataProvider.js +71 -2
  73. package/metadata/MetadataStorage.d.ts +13 -11
  74. package/metadata/MetadataStorage.js +72 -41
  75. package/metadata/MetadataValidator.d.ts +32 -9
  76. package/metadata/MetadataValidator.js +214 -44
  77. package/metadata/discover-entities.d.ts +5 -0
  78. package/metadata/discover-entities.js +40 -0
  79. package/metadata/index.d.ts +1 -1
  80. package/metadata/index.js +0 -1
  81. package/metadata/types.d.ts +577 -0
  82. package/metadata/types.js +1 -0
  83. package/naming-strategy/AbstractNamingStrategy.d.ts +16 -4
  84. package/naming-strategy/AbstractNamingStrategy.js +26 -5
  85. package/naming-strategy/EntityCaseNamingStrategy.d.ts +3 -3
  86. package/naming-strategy/EntityCaseNamingStrategy.js +6 -5
  87. package/naming-strategy/MongoNamingStrategy.d.ts +3 -3
  88. package/naming-strategy/MongoNamingStrategy.js +6 -6
  89. package/naming-strategy/NamingStrategy.d.ts +28 -4
  90. package/naming-strategy/UnderscoreNamingStrategy.d.ts +3 -3
  91. package/naming-strategy/UnderscoreNamingStrategy.js +6 -6
  92. package/naming-strategy/index.d.ts +1 -1
  93. package/naming-strategy/index.js +0 -1
  94. package/not-supported.d.ts +2 -0
  95. package/not-supported.js +8 -0
  96. package/package.json +47 -36
  97. package/platforms/ExceptionConverter.js +1 -1
  98. package/platforms/Platform.d.ts +33 -15
  99. package/platforms/Platform.js +125 -69
  100. package/serialization/EntitySerializer.d.ts +6 -3
  101. package/serialization/EntitySerializer.js +53 -29
  102. package/serialization/EntityTransformer.js +33 -21
  103. package/serialization/SerializationContext.d.ts +6 -6
  104. package/serialization/SerializationContext.js +4 -4
  105. package/types/ArrayType.d.ts +1 -1
  106. package/types/ArrayType.js +2 -3
  107. package/types/BigIntType.js +1 -1
  108. package/types/BlobType.d.ts +0 -1
  109. package/types/BlobType.js +0 -3
  110. package/types/BooleanType.d.ts +1 -0
  111. package/types/BooleanType.js +3 -0
  112. package/types/DecimalType.js +2 -2
  113. package/types/DoubleType.js +1 -1
  114. package/types/EnumArrayType.js +1 -2
  115. package/types/JsonType.d.ts +1 -1
  116. package/types/JsonType.js +7 -2
  117. package/types/TinyIntType.js +1 -1
  118. package/types/Type.d.ts +2 -4
  119. package/types/Type.js +3 -3
  120. package/types/Uint8ArrayType.d.ts +0 -1
  121. package/types/Uint8ArrayType.js +1 -4
  122. package/types/UuidType.d.ts +2 -0
  123. package/types/UuidType.js +14 -2
  124. package/types/index.d.ts +3 -2
  125. package/typings.d.ts +427 -170
  126. package/typings.js +100 -45
  127. package/unit-of-work/ChangeSet.d.ts +4 -6
  128. package/unit-of-work/ChangeSet.js +8 -9
  129. package/unit-of-work/ChangeSetComputer.d.ts +3 -8
  130. package/unit-of-work/ChangeSetComputer.js +49 -26
  131. package/unit-of-work/ChangeSetPersister.d.ts +13 -12
  132. package/unit-of-work/ChangeSetPersister.js +107 -44
  133. package/unit-of-work/CommitOrderCalculator.d.ts +12 -10
  134. package/unit-of-work/CommitOrderCalculator.js +17 -15
  135. package/unit-of-work/IdentityMap.d.ts +12 -0
  136. package/unit-of-work/IdentityMap.js +39 -1
  137. package/unit-of-work/UnitOfWork.d.ts +34 -4
  138. package/unit-of-work/UnitOfWork.js +294 -107
  139. package/utils/AbstractMigrator.d.ts +101 -0
  140. package/utils/AbstractMigrator.js +303 -0
  141. package/utils/AbstractSchemaGenerator.d.ts +5 -5
  142. package/utils/AbstractSchemaGenerator.js +30 -18
  143. package/utils/AsyncContext.d.ts +6 -0
  144. package/utils/AsyncContext.js +42 -0
  145. package/utils/Configuration.d.ts +796 -211
  146. package/utils/Configuration.js +160 -197
  147. package/utils/ConfigurationLoader.d.ts +1 -52
  148. package/utils/ConfigurationLoader.js +1 -330
  149. package/utils/Cursor.d.ts +0 -3
  150. package/utils/Cursor.js +29 -14
  151. package/utils/DataloaderUtils.d.ts +10 -5
  152. package/utils/DataloaderUtils.js +42 -22
  153. package/utils/EntityComparator.d.ts +16 -9
  154. package/utils/EntityComparator.js +202 -96
  155. package/utils/QueryHelper.d.ts +34 -7
  156. package/utils/QueryHelper.js +183 -72
  157. package/utils/RawQueryFragment.d.ts +28 -34
  158. package/utils/RawQueryFragment.js +37 -72
  159. package/utils/RequestContext.js +2 -2
  160. package/utils/TransactionContext.js +2 -2
  161. package/utils/TransactionManager.js +11 -7
  162. package/utils/Utils.d.ts +16 -127
  163. package/utils/Utils.js +106 -401
  164. package/utils/clone.js +13 -23
  165. package/utils/env-vars.d.ts +7 -0
  166. package/utils/env-vars.js +98 -0
  167. package/utils/fs-utils.d.ts +34 -0
  168. package/utils/fs-utils.js +193 -0
  169. package/utils/index.d.ts +1 -3
  170. package/utils/index.js +1 -3
  171. package/utils/upsert-utils.d.ts +9 -4
  172. package/utils/upsert-utils.js +51 -5
  173. package/decorators/Check.d.ts +0 -3
  174. package/decorators/Check.js +0 -13
  175. package/decorators/CreateRequestContext.d.ts +0 -3
  176. package/decorators/CreateRequestContext.js +0 -32
  177. package/decorators/Embeddable.d.ts +0 -8
  178. package/decorators/Embeddable.js +0 -11
  179. package/decorators/Embedded.d.ts +0 -12
  180. package/decorators/Embedded.js +0 -18
  181. package/decorators/Entity.d.ts +0 -33
  182. package/decorators/Entity.js +0 -12
  183. package/decorators/Enum.d.ts +0 -9
  184. package/decorators/Enum.js +0 -16
  185. package/decorators/Filter.d.ts +0 -2
  186. package/decorators/Filter.js +0 -8
  187. package/decorators/Formula.d.ts +0 -4
  188. package/decorators/Formula.js +0 -15
  189. package/decorators/Indexed.d.ts +0 -19
  190. package/decorators/Indexed.js +0 -20
  191. package/decorators/ManyToMany.d.ts +0 -42
  192. package/decorators/ManyToMany.js +0 -14
  193. package/decorators/ManyToOne.d.ts +0 -34
  194. package/decorators/ManyToOne.js +0 -14
  195. package/decorators/OneToMany.d.ts +0 -28
  196. package/decorators/OneToMany.js +0 -17
  197. package/decorators/OneToOne.d.ts +0 -28
  198. package/decorators/OneToOne.js +0 -7
  199. package/decorators/PrimaryKey.d.ts +0 -8
  200. package/decorators/PrimaryKey.js +0 -20
  201. package/decorators/Property.d.ts +0 -250
  202. package/decorators/Property.js +0 -32
  203. package/decorators/Transactional.d.ts +0 -14
  204. package/decorators/Transactional.js +0 -28
  205. package/decorators/hooks.d.ts +0 -16
  206. package/decorators/hooks.js +0 -47
  207. package/decorators/index.d.ts +0 -17
  208. package/decorators/index.js +0 -17
  209. package/entity/ArrayCollection.d.ts +0 -118
  210. package/entity/ArrayCollection.js +0 -407
  211. package/entity/EntityValidator.d.ts +0 -19
  212. package/entity/EntityValidator.js +0 -150
  213. package/metadata/ReflectMetadataProvider.d.ts +0 -8
  214. package/metadata/ReflectMetadataProvider.js +0 -44
  215. package/utils/resolveContextProvider.d.ts +0 -10
  216. package/utils/resolveContextProvider.js +0 -28
@@ -1,16 +1,13 @@
1
- import { inspect } from 'node:util';
2
- import DataLoader from 'dataloader';
3
1
  import { type Configuration } from './utils/Configuration.js';
4
2
  import { Cursor } from './utils/Cursor.js';
5
3
  import { EntityFactory } from './entity/EntityFactory.js';
6
4
  import { type AssignOptions } from './entity/EntityAssigner.js';
7
- import { EntityValidator } from './entity/EntityValidator.js';
8
5
  import { type EntityRepository } from './entity/EntityRepository.js';
9
6
  import { EntityLoader, type EntityLoaderOptions } from './entity/EntityLoader.js';
10
7
  import { Reference } from './entity/Reference.js';
11
8
  import { UnitOfWork } from './unit-of-work/UnitOfWork.js';
12
- import type { CountOptions, DeleteOptions, FindAllOptions, FindByCursorOptions, FindOneOptions, FindOneOrFailOptions, FindOptions, GetReferenceOptions, IDatabaseDriver, LockOptions, NativeInsertUpdateOptions, UpdateOptions, UpsertManyOptions, UpsertOptions } from './drivers/IDatabaseDriver.js';
13
- import type { AnyEntity, AnyString, ArrayElement, AutoPath, ConnectionType, Dictionary, EntityData, EntityDictionary, EntityDTO, EntityMetadata, EntityName, FilterQuery, FromEntityType, GetRepository, IHydrator, IsSubset, Loaded, MaybePromise, MergeLoaded, MergeSelected, NoInfer, ObjectQuery, Primary, Ref, RequiredEntityData, UnboxArray } from './typings.js';
9
+ import type { CountOptions, DeleteOptions, FilterOptions, FindAllOptions, FindByCursorOptions, FindOneOptions, FindOneOrFailOptions, FindOptions, GetReferenceOptions, IDatabaseDriver, LockOptions, NativeInsertUpdateOptions, StreamOptions, UpdateOptions, UpsertManyOptions, UpsertOptions } from './drivers/IDatabaseDriver.js';
10
+ import type { AnyString, ArrayElement, AutoPath, ConnectionType, Dictionary, EntityClass, EntityData, EntityDictionary, EntityDTO, EntityMetadata, EntityName, FilterDef, FilterQuery, FromEntityType, GetRepository, IHydrator, IsSubset, Loaded, MergeLoaded, MergeSelected, ObjectQuery, PopulateOptions, Primary, Ref, RequiredEntityData, UnboxArray } from './typings.js';
14
11
  import { FlushMode, LockMode, PopulatePath, type TransactionOptions } from './enums.js';
15
12
  import type { MetadataStorage } from './metadata/MetadataStorage.js';
16
13
  import type { Transaction } from './connections/Connection.js';
@@ -25,19 +22,18 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
25
22
  readonly config: Configuration;
26
23
  protected readonly driver: Driver;
27
24
  protected readonly metadata: MetadataStorage;
28
- protected readonly useContext: boolean;
25
+ private readonly useContext;
29
26
  protected readonly eventManager: EventManager;
27
+ /** @internal */
28
+ readonly '~entities'?: unknown;
30
29
  private static counter;
31
30
  readonly _id: number;
32
31
  readonly global = false;
33
32
  readonly name: string;
34
- protected readonly refLoader: DataLoader<[Reference<any>, (Omit<import("./entity/Reference.js").LoadReferenceOptions<any, any, "*", never>, "dataloader"> | undefined)?], any, [Reference<any>, (Omit<import("./entity/Reference.js").LoadReferenceOptions<any, any, "*", never>, "dataloader"> | undefined)?]>;
35
- protected readonly colLoader: DataLoader<[import("./index.js").Collection<any, object>, (Omit<import("./index.js").InitCollectionOptions<any, any, "*", never>, "dataloader"> | undefined)?], any, [import("./index.js").Collection<any, object>, (Omit<import("./index.js").InitCollectionOptions<any, any, "*", never>, "dataloader"> | undefined)?]>;
36
- protected readonly colLoaderMtoN: DataLoader<[import("./index.js").Collection<any, object>, (Omit<import("./index.js").InitCollectionOptions<any, any, "*", never>, "dataloader"> | undefined)?], any, [import("./index.js").Collection<any, object>, (Omit<import("./index.js").InitCollectionOptions<any, any, "*", never>, "dataloader"> | undefined)?]>;
37
- private readonly validator;
33
+ private readonly loaders;
38
34
  private readonly repositoryMap;
39
35
  private readonly entityLoader;
40
- protected readonly comparator: EntityComparator;
36
+ private readonly comparator;
41
37
  private readonly entityFactory;
42
38
  private readonly unitOfWork;
43
39
  private readonly resultCache;
@@ -73,14 +69,28 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
73
69
  * Shortcut for `em.getRepository()`.
74
70
  */
75
71
  repo<Entity extends object, Repository extends EntityRepository<Entity> = EntityRepository<Entity>>(entityName: EntityName<Entity>): GetRepository<Entity, Repository>;
76
- /**
77
- * Gets EntityValidator instance
78
- */
79
- getValidator(): EntityValidator;
80
72
  /**
81
73
  * Finds all entities matching your `where` query. You can pass additional options via the `options` parameter.
82
74
  */
83
75
  find<Entity extends object, Hint extends string = never, Fields extends string = PopulatePath.ALL, Excludes extends string = never>(entityName: EntityName<Entity>, where: FilterQuery<NoInfer<Entity>>, options?: FindOptions<Entity, Hint, Fields, Excludes>): Promise<Loaded<Entity, Hint, Fields, Excludes>[]>;
76
+ /**
77
+ * Finds all entities and returns an async iterable (async generator) that yields results one by one.
78
+ * The results are merged and mapped to entity instances, without adding them to the identity map.
79
+ * You can disable merging by passing the options `{ mergeResults: false }`.
80
+ * With `mergeResults` disabled, to-many collections will contain at most one item, and you will get duplicate
81
+ * root entities when there are multiple items in the populated collection.
82
+ * This is useful for processing large datasets without loading everything into memory at once.
83
+ *
84
+ * ```ts
85
+ * const stream = em.stream(Book, { populate: ['author'] });
86
+ *
87
+ * for await (const book of stream) {
88
+ * // book is an instance of Book entity
89
+ * console.log(book.title, book.author.name);
90
+ * }
91
+ * ```
92
+ */
93
+ stream<Entity extends object, Hint extends string = never, Fields extends string = '*', Excludes extends string = never>(entityName: EntityName<Entity>, options?: StreamOptions<NoInfer<Entity>, Hint, Fields, Excludes>): AsyncIterableIterator<Loaded<Entity, Hint, Fields, Excludes>>;
84
94
  /**
85
95
  * Finds all entities of given type, optionally matching the `where` condition provided in the `options` parameter.
86
96
  */
@@ -89,19 +99,7 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
89
99
  /**
90
100
  * Registers global filter to this entity manager. Global filters are enabled by default (unless disabled via last parameter).
91
101
  */
92
- addFilter<T1>(name: string, cond: FilterQuery<T1> | ((args: Dictionary) => MaybePromise<FilterQuery<T1>>), entityName?: EntityName<T1> | [EntityName<T1>], enabled?: boolean): void;
93
- /**
94
- * Registers global filter to this entity manager. Global filters are enabled by default (unless disabled via last parameter).
95
- */
96
- addFilter<T1, T2>(name: string, cond: FilterQuery<T1 | T2> | ((args: Dictionary) => MaybePromise<FilterQuery<T1 | T2>>), entityName?: [EntityName<T1>, EntityName<T2>], enabled?: boolean): void;
97
- /**
98
- * Registers global filter to this entity manager. Global filters are enabled by default (unless disabled via last parameter).
99
- */
100
- addFilter<T1, T2, T3>(name: string, cond: FilterQuery<T1 | T2 | T3> | ((args: Dictionary) => MaybePromise<FilterQuery<T1 | T2 | T3>>), entityName?: [EntityName<T1>, EntityName<T2>, EntityName<T3>], enabled?: boolean): void;
101
- /**
102
- * Registers global filter to this entity manager. Global filters are enabled by default (unless disabled via last parameter).
103
- */
104
- addFilter(name: string, cond: Dictionary | ((args: Dictionary) => MaybePromise<FilterQuery<AnyEntity>>), entityName?: EntityName<AnyEntity> | EntityName<AnyEntity>[], enabled?: boolean): void;
102
+ addFilter<T extends EntityName | readonly EntityName[]>(options: FilterDef<T>): void;
105
103
  /**
106
104
  * Sets filter parameter values globally inside context defined by this entity manager.
107
105
  * If you want to set shared value for all contexts, be sure to use the root entity manager.
@@ -121,19 +119,23 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
121
119
  getLoggerContext<T extends Dictionary = Dictionary>(options?: {
122
120
  disableContextResolution?: boolean;
123
121
  }): T;
124
- setFlushMode(flushMode?: FlushMode): void;
125
- protected processWhere<Entity extends object, Hint extends string = never, Fields extends string = '*', Excludes extends string = never>(entityName: string, where: FilterQuery<Entity>, options: FindOptions<Entity, Hint, Fields, Excludes> | FindOneOptions<Entity, Hint, Fields, Excludes>, type: 'read' | 'update' | 'delete'): Promise<FilterQuery<Entity>>;
126
- protected applyDiscriminatorCondition<Entity extends object>(entityName: string, where: FilterQuery<Entity>): FilterQuery<Entity>;
122
+ setFlushMode(flushMode?: FlushMode | `${FlushMode}`): void;
123
+ protected processWhere<Entity extends object, Hint extends string = never, Fields extends string = '*', Excludes extends string = never>(entityName: EntityName<Entity>, where: FilterQuery<Entity>, options: FindOptions<Entity, Hint, Fields, Excludes> | FindOneOptions<Entity, Hint, Fields, Excludes>, type: 'read' | 'update' | 'delete'): Promise<FilterQuery<Entity>>;
124
+ protected processUnionWhere<Entity extends object, Hint extends string = never>(entityName: EntityName<Entity>, options: FindOptions<Entity, Hint, any, any> | CountOptions<Entity, Hint> | UpdateOptions<Entity> | DeleteOptions<Entity>, type: 'read' | 'update' | 'delete'): Promise<void>;
125
+ protected applyDiscriminatorCondition<Entity extends object>(entityName: EntityName<Entity>, where: FilterQuery<Entity>): FilterQuery<Entity>;
127
126
  protected createPopulateWhere<Entity extends object>(cond: ObjectQuery<Entity>, options: FindOptions<Entity, any, any, any> | FindOneOptions<Entity, any, any, any> | CountOptions<Entity, any>): ObjectQuery<Entity>;
128
- protected getJoinedFilters<Entity extends object>(meta: EntityMetadata<Entity>, cond: ObjectQuery<Entity>, options: FindOptions<Entity, any, any, any> | FindOneOptions<Entity, any, any, any>): Promise<ObjectQuery<Entity>>;
127
+ protected getJoinedFilters<Entity extends object>(meta: EntityMetadata<Entity>, options: FindOptions<Entity, any, any, any> | FindOneOptions<Entity, any, any, any>): Promise<ObjectQuery<Entity> | undefined>;
129
128
  /**
130
129
  * When filters are active on M:1 or 1:1 relations, we need to ref join them eagerly as they might affect the FK value.
131
130
  */
132
- protected autoJoinRefsForFilters<T extends object>(meta: EntityMetadata<T>, options: FindOptions<T, any, any, any> | FindOneOptions<T, any, any, any>): Promise<void>;
131
+ protected autoJoinRefsForFilters<T extends object>(meta: EntityMetadata<T>, options: FindOptions<T, any, any, any> | FindOneOptions<T, any, any, any>, parent?: {
132
+ class: EntityClass;
133
+ propName: string;
134
+ }): Promise<void>;
133
135
  /**
134
136
  * @internal
135
137
  */
136
- applyFilters<Entity extends object>(entityName: string, where: FilterQuery<Entity> | undefined, options: Dictionary<boolean | Dictionary> | string[] | boolean, type: 'read' | 'update' | 'delete', findOptions?: FindOptions<any, any, any, any> | FindOneOptions<any, any, any, any>): Promise<FilterQuery<Entity> | undefined>;
138
+ applyFilters<Entity extends object>(entityName: EntityName<Entity>, where: FilterQuery<Entity> | undefined, options: FilterOptions | undefined, type: 'read' | 'update' | 'delete', findOptions?: FindOptions<any, any, any, any> | FindOneOptions<any, any, any, any>): Promise<FilterQuery<Entity> | undefined>;
137
139
  /**
138
140
  * Calls `em.find()` and `em.count()` with the same arguments (where applicable) and returns the results as tuple
139
141
  * where the first element is the array of entities, and the second is the count.
@@ -153,21 +155,21 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
153
155
  * - POJO/entity instance
154
156
  *
155
157
  * ```ts
156
- * const currentCursor = await em.findByCursor(User, {}, {
158
+ * const currentCursor = await em.findByCursor(User, {
157
159
  * first: 10,
158
160
  * after: previousCursor, // cursor instance
159
161
  * orderBy: { id: 'desc' },
160
162
  * });
161
163
  *
162
164
  * // to fetch next page
163
- * const nextCursor = await em.findByCursor(User, {}, {
165
+ * const nextCursor = await em.findByCursor(User, {
164
166
  * first: 10,
165
167
  * after: currentCursor.endCursor, // opaque string
166
168
  * orderBy: { id: 'desc' },
167
169
  * });
168
170
  *
169
171
  * // to fetch next page
170
- * const nextCursor2 = await em.findByCursor(User, {}, {
172
+ * const nextCursor2 = await em.findByCursor(User, {
171
173
  * first: 10,
172
174
  * after: { id: lastSeenId }, // entity-like POJO
173
175
  * orderBy: { id: 'desc' },
@@ -195,7 +197,7 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
195
197
  * }
196
198
  * ```
197
199
  */
198
- findByCursor<Entity extends object, Hint extends string = never, Fields extends string = '*', Excludes extends string = never, IncludeCount extends boolean = true>(entityName: EntityName<Entity>, where: FilterQuery<NoInfer<Entity>>, options: FindByCursorOptions<Entity, Hint, Fields, Excludes, IncludeCount>): Promise<Cursor<Entity, Hint, Fields, Excludes, IncludeCount>>;
200
+ findByCursor<Entity extends object, Hint extends string = never, Fields extends string = '*', Excludes extends string = never, IncludeCount extends boolean = true>(entityName: EntityName<Entity>, options: FindByCursorOptions<Entity, Hint, Fields, Excludes, IncludeCount>): Promise<Cursor<Entity, Hint, Fields, Excludes, IncludeCount>>;
199
201
  /**
200
202
  * Refreshes the persistent state of an entity from the database, overriding any local changes that have not yet been
201
203
  * persisted. Returns the same entity instance (same object reference), but re-hydrated. If the entity is no longer
@@ -358,7 +360,7 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
358
360
  * The newly created entity will be automatically marked for persistence via `em.persist` unless you disable this
359
361
  * behavior, either locally via `persist: false` option, or globally via `persistOnCreate` ORM config option.
360
362
  */
361
- create<Entity extends object, Convert extends boolean = false>(entityName: EntityName<Entity>, data: RequiredEntityData<Entity, never, Convert>, options?: CreateOptions<Convert>): Entity;
363
+ create<Entity extends object, Convert extends boolean = false, Data extends RequiredEntityData<Entity, never, Convert> = RequiredEntityData<Entity, never, Convert>>(entityName: EntityName<Entity>, data: Data & IsSubset<RequiredEntityData<Entity, never, Convert>, Data>, options?: CreateOptions<Convert>): Entity;
362
364
  /**
363
365
  * Creates new instance of given entity and populates it with given data.
364
366
  * The entity constructor will be used unless you provide `{ managed: true }` in the `options` parameter.
@@ -374,17 +376,33 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
374
376
  * The newly created entity will be automatically marked for persistence via `em.persist` unless you disable this
375
377
  * behavior, either locally via `persist: false` option, or globally via `persistOnCreate` ORM config option.
376
378
  */
377
- create<Entity extends object, Convert extends boolean = false>(entityName: EntityName<Entity>, data: EntityData<Entity, Convert>, options: CreateOptions<Convert> & {
379
+ create<Entity extends object, Convert extends boolean = false, Data extends EntityData<Entity, Convert> = EntityData<Entity, Convert>>(entityName: EntityName<Entity>, data: Data & IsSubset<EntityData<Entity, Convert>, Data>, options: CreateOptions<Convert> & {
378
380
  partial: true;
379
381
  }): Entity;
380
382
  /**
381
383
  * Shortcut for `wrap(entity).assign(data, { em })`
382
384
  */
383
385
  assign<Entity extends object, Naked extends FromEntityType<Entity> = FromEntityType<Entity>, Convert extends boolean = false, Data extends EntityData<Naked, Convert> | Partial<EntityDTO<Naked>> = EntityData<Naked, Convert> | Partial<EntityDTO<Naked>>>(entity: Entity | Partial<Entity>, data: Data & IsSubset<EntityData<Naked, Convert>, Data>, options?: AssignOptions<Convert>): MergeSelected<Entity, Naked, keyof Data & string>;
386
+ /**
387
+ * Gets a reference to the entity identified by the given type and alternate key property without actually loading it.
388
+ * The key option specifies which property to use for identity map lookup instead of the primary key.
389
+ */
390
+ getReference<Entity extends object, K extends string & keyof Entity>(entityName: EntityName<Entity>, id: Entity[K], options: Omit<GetReferenceOptions, 'key' | 'wrapped'> & {
391
+ key: K;
392
+ wrapped: true;
393
+ }): Ref<Entity>;
394
+ /**
395
+ * Gets a reference to the entity identified by the given type and alternate key property without actually loading it.
396
+ * The key option specifies which property to use for identity map lookup instead of the primary key.
397
+ */
398
+ getReference<Entity extends object, K extends string & keyof Entity>(entityName: EntityName<Entity>, id: Entity[K], options: Omit<GetReferenceOptions, 'key'> & {
399
+ key: K;
400
+ wrapped?: false;
401
+ }): Entity;
384
402
  /**
385
403
  * Gets a reference to the entity identified by the given type and identifier without actually loading it, if the entity is not yet loaded
386
404
  */
387
- getReference<Entity extends object>(entityName: EntityName<Entity>, id: Primary<Entity>, options: Omit<GetReferenceOptions, 'wrapped'> & {
405
+ getReference<Entity extends object>(entityName: EntityName<Entity>, id: Primary<Entity>, options: Omit<GetReferenceOptions, 'wrapped' | 'key'> & {
388
406
  wrapped: true;
389
407
  }): Ref<Entity>;
390
408
  /**
@@ -394,7 +412,7 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
394
412
  /**
395
413
  * Gets a reference to the entity identified by the given type and identifier without actually loading it, if the entity is not yet loaded
396
414
  */
397
- getReference<Entity extends object>(entityName: EntityName<Entity>, id: Primary<Entity>, options: Omit<GetReferenceOptions, 'wrapped'> & {
415
+ getReference<Entity extends object>(entityName: EntityName<Entity>, id: Primary<Entity>, options: Omit<GetReferenceOptions, 'wrapped' | 'key'> & {
398
416
  wrapped: false;
399
417
  }): Entity;
400
418
  /**
@@ -410,11 +428,6 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
410
428
  * The entity will be entered into the database at or before transaction commit or as a result of the flush operation.
411
429
  */
412
430
  persist<Entity extends object>(entity: Entity | Reference<Entity> | Iterable<Entity | Reference<Entity>>): this;
413
- /**
414
- * Persists your entity immediately, flushing all not yet persisted changes to the database too.
415
- * Equivalent to `em.persist(e).flush()`.
416
- */
417
- persistAndFlush(entity: AnyEntity | Reference<AnyEntity> | Iterable<AnyEntity | Reference<AnyEntity>>): Promise<void>;
418
431
  /**
419
432
  * Marks entity for removal.
420
433
  * A removed entity will be removed from the database at or before transaction commit or as a result of the flush operation.
@@ -422,11 +435,6 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
422
435
  * To remove entities by condition, use `em.nativeDelete()`.
423
436
  */
424
437
  remove<Entity extends object>(entity: Entity | Reference<Entity> | Iterable<Entity | Reference<Entity>>): this;
425
- /**
426
- * Removes an entity instance immediately, flushing all not yet persisted changes to the database too.
427
- * Equivalent to `em.remove(e).flush()`
428
- */
429
- removeAndFlush(entity: AnyEntity | Reference<AnyEntity> | Iterable<AnyEntity | Reference<AnyEntity>>): Promise<void>;
430
438
  /**
431
439
  * Flushes all changes to objects that have been queued up to now to the database.
432
440
  * This effectively synchronizes the in-memory state of managed objects with the database.
@@ -449,7 +457,7 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
449
457
  /**
450
458
  * Loads specified relations in batch. This will execute one query for each relation, that will populate it on all the specified entities.
451
459
  */
452
- populate<Entity extends object, Naked extends FromEntityType<UnboxArray<Entity>> = FromEntityType<UnboxArray<Entity>>, Hint extends string = never, Fields extends string = '*', Excludes extends string = never>(entities: Entity, populate: readonly AutoPath<Naked, Hint, PopulatePath.ALL>[] | false, options?: EntityLoaderOptions<Naked, Fields, Excludes>): Promise<Entity extends object[] ? MergeLoaded<ArrayElement<Entity>, Naked, Hint, Fields, Excludes>[] : MergeLoaded<Entity, Naked, Hint, Fields, Excludes>>;
460
+ populate<Entity extends object, Naked extends FromEntityType<UnboxArray<Entity>> = FromEntityType<UnboxArray<Entity>>, Hint extends string = never, Fields extends string = never, Excludes extends string = never>(entities: Entity, populate: readonly AutoPath<Naked, Hint, PopulatePath.ALL>[] | false, options?: EntityLoaderOptions<Naked, Fields, Excludes>): Promise<Entity extends object[] ? MergeLoaded<ArrayElement<Entity>, Naked, Hint, Fields, Excludes>[] : MergeLoaded<Entity, Naked, Hint, Fields, Excludes>>;
453
461
  /**
454
462
  * Returns new EntityManager instance with its own identity map
455
463
  */
@@ -507,7 +515,8 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
507
515
  private checkLockRequirements;
508
516
  private lockAndPopulate;
509
517
  private buildFields;
510
- private preparePopulate;
518
+ /** @internal */
519
+ preparePopulate<Entity extends object>(entityName: EntityName<Entity>, options: Pick<FindOptions<Entity, any, any, any>, 'populate' | 'strategy' | 'fields' | 'flags' | 'filters' | 'exclude' | 'populateHints'>, validate?: boolean): Promise<PopulateOptions<Entity>[]>;
511
520
  /**
512
521
  * when the entity is found in identity map, we check if it was partially loaded or we are trying to populate
513
522
  * some additional lazy properties, if so, we reload and merge the data from database
@@ -517,20 +526,20 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
517
526
  /**
518
527
  * @internal
519
528
  */
520
- cacheKey<T extends object>(entityName: string, options: FindOptions<T, any, any, any> | FindOneOptions<T, any, any, any> | CountOptions<T, any>, method: string, where: FilterQuery<T>): unknown[];
529
+ cacheKey<T extends object>(entityName: EntityName<T>, options: FindOptions<T, any, any, any> | FindOneOptions<T, any, any, any> | CountOptions<T, any>, method: string, where: FilterQuery<T>): unknown[];
521
530
  /**
522
531
  * @internal
523
532
  */
524
- tryCache<T extends object, R>(entityName: string, config: boolean | number | [string, number] | undefined, key: unknown, refresh?: boolean, merge?: boolean): Promise<{
533
+ tryCache<T extends object, R>(entityName: EntityName<T>, config: boolean | number | [string, number] | undefined, key: unknown, refresh?: boolean, merge?: boolean): Promise<{
525
534
  data?: R | null;
526
535
  key: string;
527
536
  } | undefined>;
528
537
  /**
529
538
  * @internal
530
539
  */
531
- storeCache(config: boolean | number | [string, number] | undefined, key: {
540
+ storeCache<T>(config: boolean | number | [string, number] | undefined, key: {
532
541
  key: string;
533
- }, data: unknown | (() => unknown)): Promise<void>;
542
+ }, data: T | (() => T)): Promise<void>;
534
543
  /**
535
544
  * Clears result cache for given cache key. If we want to be able to call this method,
536
545
  * we need to set the cache key explicitly when storing the cache.
@@ -554,13 +563,13 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
554
563
  * if executed inside request context handler.
555
564
  */
556
565
  set schema(schema: string | null | undefined);
566
+ /** @internal */
567
+ getDataLoader(type: 'ref' | '1:m' | 'm:n'): Promise<any>;
557
568
  /**
558
569
  * Returns the ID of this EntityManager. Respects the context, so global EM will give you the contextual ID
559
570
  * if executed inside request context handler.
560
571
  */
561
572
  get id(): number;
562
- /** @ignore */
563
- [inspect.custom](): string;
564
573
  }
565
574
  export interface CreateOptions<Convert extends boolean> {
566
575
  /** creates a managed entity instance instead, bypassing the constructor call */
@@ -584,9 +593,8 @@ export interface MergeOptions {
584
593
  convertCustomTypes?: boolean;
585
594
  schema?: string;
586
595
  disableContextResolution?: boolean;
587
- keepIdentity?: boolean;
588
596
  validate?: boolean;
589
- cascade?: boolean; /** @default true */
597
+ cascade?: boolean /** @default true */;
590
598
  }
591
599
  export interface ForkOptions {
592
600
  /** do we want a clear identity map? defaults to true */
@@ -600,7 +608,7 @@ export interface ForkOptions {
600
608
  /** use this flag to ignore the current async context - this is required if we want to call `em.fork()` inside the `getContext` handler */
601
609
  disableContextResolution?: boolean;
602
610
  /** set flush mode for this fork, overrides the global option can be overridden locally via FindOptions */
603
- flushMode?: FlushMode;
611
+ flushMode?: FlushMode | `${FlushMode}`;
604
612
  /** disable transactions for this fork */
605
613
  disableTransactions?: boolean;
606
614
  /** should we keep the transaction context of the parent EM? */