@mikro-orm/core 7.0.4-dev.9 → 7.0.4

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 +884 -583
  2. package/EntityManager.js +1922 -1895
  3. package/MikroORM.d.ts +103 -74
  4. package/MikroORM.js +178 -179
  5. package/README.md +1 -1
  6. package/cache/CacheAdapter.d.ts +36 -36
  7. package/cache/FileCacheAdapter.d.ts +30 -24
  8. package/cache/FileCacheAdapter.js +80 -78
  9. package/cache/GeneratedCacheAdapter.d.ts +18 -20
  10. package/cache/GeneratedCacheAdapter.js +30 -30
  11. package/cache/MemoryCacheAdapter.d.ts +18 -20
  12. package/cache/MemoryCacheAdapter.js +35 -36
  13. package/cache/NullCacheAdapter.d.ts +16 -16
  14. package/cache/NullCacheAdapter.js +24 -24
  15. package/connections/Connection.d.ts +95 -84
  16. package/connections/Connection.js +165 -168
  17. package/drivers/DatabaseDriver.d.ts +186 -80
  18. package/drivers/DatabaseDriver.js +450 -443
  19. package/drivers/IDatabaseDriver.d.ts +440 -301
  20. package/entity/BaseEntity.d.ts +120 -83
  21. package/entity/BaseEntity.js +43 -43
  22. package/entity/Collection.d.ts +212 -179
  23. package/entity/Collection.js +727 -721
  24. package/entity/EntityAssigner.d.ts +88 -77
  25. package/entity/EntityAssigner.js +231 -230
  26. package/entity/EntityFactory.d.ts +66 -54
  27. package/entity/EntityFactory.js +425 -383
  28. package/entity/EntityHelper.d.ts +34 -22
  29. package/entity/EntityHelper.js +280 -267
  30. package/entity/EntityIdentifier.d.ts +4 -4
  31. package/entity/EntityIdentifier.js +10 -10
  32. package/entity/EntityLoader.d.ts +98 -72
  33. package/entity/EntityLoader.js +753 -723
  34. package/entity/EntityRepository.d.ts +316 -201
  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 +126 -82
  39. package/entity/Reference.js +278 -274
  40. package/entity/WrappedEntity.d.ts +115 -72
  41. package/entity/WrappedEntity.js +168 -166
  42. package/entity/defineEntity.d.ts +1315 -636
  43. package/entity/defineEntity.js +527 -518
  44. package/entity/utils.d.ts +13 -3
  45. package/entity/utils.js +71 -73
  46. package/entity/validators.js +43 -43
  47. package/entity/wrap.js +8 -8
  48. package/enums.d.ts +258 -253
  49. package/enums.js +251 -252
  50. package/errors.d.ts +114 -72
  51. package/errors.js +350 -253
  52. package/events/EventManager.d.ts +26 -14
  53. package/events/EventManager.js +79 -77
  54. package/events/EventSubscriber.d.ts +29 -29
  55. package/events/TransactionEventBroadcaster.d.ts +15 -8
  56. package/events/TransactionEventBroadcaster.js +14 -14
  57. package/exceptions.d.ts +23 -40
  58. package/exceptions.js +35 -52
  59. package/hydration/Hydrator.d.ts +42 -17
  60. package/hydration/Hydrator.js +43 -43
  61. package/hydration/ObjectHydrator.d.ts +50 -17
  62. package/hydration/ObjectHydrator.js +481 -416
  63. package/index.d.ts +116 -2
  64. package/index.js +10 -1
  65. package/logging/DefaultLogger.d.ts +34 -32
  66. package/logging/DefaultLogger.js +86 -86
  67. package/logging/Logger.d.ts +41 -41
  68. package/logging/SimpleLogger.d.ts +13 -11
  69. package/logging/SimpleLogger.js +22 -22
  70. package/logging/colors.d.ts +6 -6
  71. package/logging/colors.js +11 -10
  72. package/logging/inspect.js +7 -7
  73. package/metadata/EntitySchema.d.ts +211 -127
  74. package/metadata/EntitySchema.js +397 -398
  75. package/metadata/MetadataDiscovery.d.ts +114 -114
  76. package/metadata/MetadataDiscovery.js +1951 -1863
  77. package/metadata/MetadataProvider.d.ts +24 -21
  78. package/metadata/MetadataProvider.js +82 -84
  79. package/metadata/MetadataStorage.d.ts +38 -32
  80. package/metadata/MetadataStorage.js +118 -118
  81. package/metadata/MetadataValidator.d.ts +39 -39
  82. package/metadata/MetadataValidator.js +381 -338
  83. package/metadata/discover-entities.d.ts +5 -2
  84. package/metadata/discover-entities.js +35 -27
  85. package/metadata/types.d.ts +615 -531
  86. package/naming-strategy/AbstractNamingStrategy.d.ts +54 -39
  87. package/naming-strategy/AbstractNamingStrategy.js +90 -85
  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 +109 -99
  93. package/naming-strategy/UnderscoreNamingStrategy.d.ts +7 -7
  94. package/naming-strategy/UnderscoreNamingStrategy.js +21 -21
  95. package/not-supported.js +7 -4
  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 +310 -299
  100. package/platforms/Platform.js +663 -636
  101. package/serialization/EntitySerializer.d.ts +49 -26
  102. package/serialization/EntitySerializer.js +224 -218
  103. package/serialization/EntityTransformer.d.ts +10 -6
  104. package/serialization/EntityTransformer.js +219 -217
  105. package/serialization/SerializationContext.d.ts +27 -23
  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 +17 -10
  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 +83 -79
  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 +75 -49
  158. package/types/index.js +52 -26
  159. package/typings.d.ts +1250 -737
  160. package/typings.js +244 -231
  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 +178 -170
  165. package/unit-of-work/ChangeSetPersister.d.ts +63 -44
  166. package/unit-of-work/ChangeSetPersister.js +442 -421
  167. package/unit-of-work/CommitOrderCalculator.d.ts +40 -40
  168. package/unit-of-work/CommitOrderCalculator.js +89 -88
  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 +181 -141
  172. package/unit-of-work/UnitOfWork.js +1200 -1183
  173. package/utils/AbstractMigrator.d.ts +111 -91
  174. package/utils/AbstractMigrator.js +275 -275
  175. package/utils/AbstractSchemaGenerator.d.ts +43 -34
  176. package/utils/AbstractSchemaGenerator.js +121 -122
  177. package/utils/AsyncContext.d.ts +3 -3
  178. package/utils/AsyncContext.js +34 -35
  179. package/utils/Configuration.d.ts +852 -808
  180. package/utils/Configuration.js +359 -344
  181. package/utils/Cursor.d.ts +40 -22
  182. package/utils/Cursor.js +135 -127
  183. package/utils/DataloaderUtils.d.ts +58 -43
  184. package/utils/DataloaderUtils.js +203 -198
  185. package/utils/EntityComparator.d.ts +98 -81
  186. package/utils/EntityComparator.js +828 -728
  187. package/utils/NullHighlighter.d.ts +1 -1
  188. package/utils/NullHighlighter.js +3 -3
  189. package/utils/QueryHelper.d.ts +79 -51
  190. package/utils/QueryHelper.js +372 -361
  191. package/utils/RawQueryFragment.d.ts +50 -34
  192. package/utils/RawQueryFragment.js +107 -105
  193. package/utils/RequestContext.d.ts +32 -32
  194. package/utils/RequestContext.js +52 -53
  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 +199 -197
  199. package/utils/Utils.d.ts +204 -145
  200. package/utils/Utils.js +812 -810
  201. package/utils/clone.js +104 -113
  202. package/utils/env-vars.js +90 -88
  203. package/utils/fs-utils.d.ts +15 -15
  204. package/utils/fs-utils.js +180 -181
  205. package/utils/upsert-utils.d.ts +20 -5
  206. package/utils/upsert-utils.js +114 -116
@@ -4,26 +4,38 @@ import { type EntityMetadata, type EntityProperty, type IHydrator } from '../typ
4
4
  * @internal
5
5
  */
6
6
  export declare class EntityHelper {
7
- static decorate<T extends object>(meta: EntityMetadata<T>, em: EntityManager): void;
8
- /**
9
- * As a performance optimization, we create entity state methods lazily. We first add
10
- * the `null` value to the prototype to reserve space in memory. Then we define a setter on the
11
- * prototype that will be executed exactly once per entity instance. There we redefine the given
12
- * property on the entity instance, so shadowing the prototype setter.
13
- */
14
- private static defineBaseProperties;
15
- /**
16
- * Defines getter and setter for every owning side of m:1 and 1:1 relation. This is then used for propagation of
17
- * changes to the inverse side of bi-directional relations. Rest of the properties are also defined this way to
18
- * achieve dirtiness, which is then used for fast checks whether we need to auto-flush because of managed entities.
19
- *
20
- * First defines a setter on the prototype, once called, actual get/set handlers are registered on the instance rather
21
- * than on its prototype. Thanks to this we still have those properties enumerable (e.g. part of `Object.keys(entity)`).
22
- */
23
- private static defineProperties;
24
- static defineCustomInspect<T extends object>(meta: EntityMetadata<T>): void;
25
- static defineReferenceProperty<T extends object>(meta: EntityMetadata<T>, prop: EntityProperty<T>, ref: T, hydrator: IHydrator): void;
26
- static propagate<T extends object>(meta: EntityMetadata<T>, entity: T, owner: T, prop: EntityProperty<T>, value?: T[keyof T & string], old?: T): void;
27
- private static propagateOneToOne;
28
- static ensurePropagation<T extends object>(entity: T): void;
7
+ static decorate<T extends object>(meta: EntityMetadata<T>, em: EntityManager): void;
8
+ /**
9
+ * As a performance optimization, we create entity state methods lazily. We first add
10
+ * the `null` value to the prototype to reserve space in memory. Then we define a setter on the
11
+ * prototype that will be executed exactly once per entity instance. There we redefine the given
12
+ * property on the entity instance, so shadowing the prototype setter.
13
+ */
14
+ private static defineBaseProperties;
15
+ /**
16
+ * Defines getter and setter for every owning side of m:1 and 1:1 relation. This is then used for propagation of
17
+ * changes to the inverse side of bi-directional relations. Rest of the properties are also defined this way to
18
+ * achieve dirtiness, which is then used for fast checks whether we need to auto-flush because of managed entities.
19
+ *
20
+ * First defines a setter on the prototype, once called, actual get/set handlers are registered on the instance rather
21
+ * than on its prototype. Thanks to this we still have those properties enumerable (e.g. part of `Object.keys(entity)`).
22
+ */
23
+ private static defineProperties;
24
+ static defineCustomInspect<T extends object>(meta: EntityMetadata<T>): void;
25
+ static defineReferenceProperty<T extends object>(
26
+ meta: EntityMetadata<T>,
27
+ prop: EntityProperty<T>,
28
+ ref: T,
29
+ hydrator: IHydrator,
30
+ ): void;
31
+ static propagate<T extends object>(
32
+ meta: EntityMetadata<T>,
33
+ entity: T,
34
+ owner: T,
35
+ prop: EntityProperty<T>,
36
+ value?: T[keyof T & string],
37
+ old?: T,
38
+ ): void;
39
+ private static propagateOneToOne;
40
+ static ensurePropagation<T extends object>(entity: T): void;
29
41
  }
@@ -1,4 +1,11 @@
1
- import { EagerProps, EntityName, EntityRepositoryType, HiddenProps, OptionalProps, PrimaryKeyProp, } from '../typings.js';
1
+ import {
2
+ EagerProps,
3
+ EntityName,
4
+ EntityRepositoryType,
5
+ HiddenProps,
6
+ OptionalProps,
7
+ PrimaryKeyProp,
8
+ } from '../typings.js';
2
9
  import { EntityTransformer } from '../serialization/EntityTransformer.js';
3
10
  import { Reference } from './Reference.js';
4
11
  import { Utils } from '../utils/Utils.js';
@@ -11,288 +18,294 @@ import { getEnv } from '../utils/env-vars.js';
11
18
  * @internal
12
19
  */
13
20
  export class EntityHelper {
14
- static decorate(meta, em) {
15
- const fork = em.fork(); // use fork so we can access `EntityFactory`
16
- const serializedPrimaryKey = meta.props.find(p => p.serializedPrimaryKey);
17
- if (serializedPrimaryKey) {
18
- Object.defineProperty(meta.prototype, serializedPrimaryKey.name, {
19
- get() {
20
- return this._id ? em.getPlatform().normalizePrimaryKey(this._id) : null;
21
- },
22
- set(id) {
23
- this._id = id ? em.getPlatform().denormalizePrimaryKey(id) : null;
24
- },
25
- configurable: true,
26
- });
27
- }
28
- EntityHelper.defineBaseProperties(meta, meta.prototype, fork);
29
- EntityHelper.defineCustomInspect(meta);
30
- if (em.config.get('propagationOnPrototype') && !meta.embeddable && !meta.virtual) {
31
- EntityHelper.defineProperties(meta, fork);
32
- }
33
- const prototype = meta.prototype;
34
- if (!prototype.toJSON) {
35
- // toJSON can be overridden
36
- Object.defineProperty(prototype, 'toJSON', {
37
- value: function (...args) {
38
- // Guard against being called on the prototype itself (e.g. by serializers
39
- // walking the object graph and calling toJSON on prototype objects)
40
- if (this === prototype) {
41
- return {};
42
- }
43
- return EntityTransformer.toObject(this, ...args);
44
- },
45
- writable: true,
46
- configurable: true,
47
- enumerable: false,
48
- });
49
- }
21
+ static decorate(meta, em) {
22
+ const fork = em.fork(); // use fork so we can access `EntityFactory`
23
+ const serializedPrimaryKey = meta.props.find(p => p.serializedPrimaryKey);
24
+ if (serializedPrimaryKey) {
25
+ Object.defineProperty(meta.prototype, serializedPrimaryKey.name, {
26
+ get() {
27
+ return this._id ? em.getPlatform().normalizePrimaryKey(this._id) : null;
28
+ },
29
+ set(id) {
30
+ this._id = id ? em.getPlatform().denormalizePrimaryKey(id) : null;
31
+ },
32
+ configurable: true,
33
+ });
50
34
  }
51
- /**
52
- * As a performance optimization, we create entity state methods lazily. We first add
53
- * the `null` value to the prototype to reserve space in memory. Then we define a setter on the
54
- * prototype that will be executed exactly once per entity instance. There we redefine the given
55
- * property on the entity instance, so shadowing the prototype setter.
56
- */
57
- static defineBaseProperties(meta, prototype, em) {
58
- // oxfmt-ignore
59
- const helperParams = meta.embeddable || meta.virtual ? [] : [em.getComparator().getPkGetter(meta), em.getComparator().getPkSerializer(meta), em.getComparator().getPkGetterConverted(meta)];
60
- Object.defineProperties(prototype, {
61
- __entity: { value: !meta.embeddable, configurable: true },
62
- __meta: { value: meta, configurable: true },
63
- __config: { value: em.config, configurable: true },
64
- __platform: { value: em.getPlatform(), configurable: true },
65
- __factory: { value: em.getEntityFactory(), configurable: true },
66
- __helper: {
67
- get() {
68
- Object.defineProperty(this, '__helper', {
69
- value: new WrappedEntity(this, em.getHydrator(), ...helperParams),
70
- enumerable: false,
71
- configurable: true,
72
- });
73
- return this.__helper;
74
- },
75
- configurable: true, // otherwise jest fails when trying to compare entities ¯\_(ツ)_/¯
76
- },
77
- });
35
+ EntityHelper.defineBaseProperties(meta, meta.prototype, fork);
36
+ EntityHelper.defineCustomInspect(meta);
37
+ if (em.config.get('propagationOnPrototype') && !meta.embeddable && !meta.virtual) {
38
+ EntityHelper.defineProperties(meta, fork);
78
39
  }
79
- /**
80
- * Defines getter and setter for every owning side of m:1 and 1:1 relation. This is then used for propagation of
81
- * changes to the inverse side of bi-directional relations. Rest of the properties are also defined this way to
82
- * achieve dirtiness, which is then used for fast checks whether we need to auto-flush because of managed entities.
83
- *
84
- * First defines a setter on the prototype, once called, actual get/set handlers are registered on the instance rather
85
- * than on its prototype. Thanks to this we still have those properties enumerable (e.g. part of `Object.keys(entity)`).
86
- */
87
- static defineProperties(meta, em) {
88
- Object.values(meta.properties).forEach(prop => {
89
- const isCollection = [ReferenceKind.ONE_TO_MANY, ReferenceKind.MANY_TO_MANY].includes(prop.kind);
90
- // oxfmt-ignore
91
- const isReference = [ReferenceKind.ONE_TO_ONE, ReferenceKind.MANY_TO_ONE].includes(prop.kind) && (prop.inversedBy || prop.mappedBy) && !prop.mapToPk;
92
- if (isReference) {
93
- Object.defineProperty(meta.prototype, prop.name, {
94
- set(val) {
95
- EntityHelper.defineReferenceProperty(meta, prop, this, em.getHydrator());
96
- this[prop.name] = val;
97
- },
98
- configurable: true,
99
- });
100
- return;
101
- }
102
- if (prop.inherited || prop.primary || prop.accessor || prop.persist === false || prop.embedded || isCollection) {
103
- return;
104
- }
105
- Object.defineProperty(meta.prototype, prop.name, {
106
- set(val) {
107
- Object.defineProperty(this, prop.name, {
108
- get() {
109
- return this.__helper?.__data[prop.name];
110
- },
111
- set(val) {
112
- this.__helper.__data[prop.name] = val;
113
- },
114
- enumerable: true,
115
- configurable: true,
116
- });
117
- this.__helper.__data[prop.name] = val;
118
- },
119
- configurable: true,
120
- });
121
- });
40
+ const prototype = meta.prototype;
41
+ if (!prototype.toJSON) {
42
+ // toJSON can be overridden
43
+ Object.defineProperty(prototype, 'toJSON', {
44
+ value: function (...args) {
45
+ // Guard against being called on the prototype itself (e.g. by serializers
46
+ // walking the object graph and calling toJSON on prototype objects)
47
+ if (this === prototype) {
48
+ return {};
49
+ }
50
+ return EntityTransformer.toObject(this, ...args);
51
+ },
52
+ writable: true,
53
+ configurable: true,
54
+ enumerable: false,
55
+ });
122
56
  }
123
- static defineCustomInspect(meta) {
124
- // @ts-ignore
125
- meta.prototype[Symbol.for('nodejs.util.inspect.custom')] ??= function (depth = 2) {
126
- const object = {};
127
- const keys = new Set(Utils.keys(this));
128
- for (const prop of meta.props) {
129
- if (keys.has(prop.name) || (prop.getter && prop.accessor === prop.name)) {
130
- object[prop.name] = this[prop.name];
131
- }
132
- }
133
- for (const key of keys) {
134
- if (!meta.properties[key]) {
135
- object[key] = this[key];
136
- }
137
- }
138
- // ensure we dont have internal symbols in the POJO
139
- [OptionalProps, EntityRepositoryType, PrimaryKeyProp, EagerProps, HiddenProps, EntityName].forEach(sym => delete object[sym]);
140
- meta.props.filter(prop => object[prop.name] === undefined).forEach(prop => delete object[prop.name]);
141
- const ret = inspect(object, { depth });
142
- let name = this.constructor.name;
143
- const showEM = ['true', 't', '1'].includes(getEnv('MIKRO_ORM_LOG_EM_ID')?.toLowerCase() ?? '');
144
- if (showEM) {
145
- if (helper(this).__em) {
146
- name += ` [managed by ${helper(this).__em.id}]`;
147
- }
148
- else {
149
- name += ` [not managed]`;
150
- }
151
- }
152
- // distinguish not initialized entities
153
- if (!helper(this).__initialized) {
154
- name = `(${name})`;
155
- }
156
- return ret === '[Object]' ? `[${name}]` : name + ' ' + ret;
157
- };
158
- }
159
- static defineReferenceProperty(meta, prop, ref, hydrator) {
160
- const wrapped = helper(ref);
161
- Object.defineProperty(ref, prop.name, {
57
+ }
58
+ /**
59
+ * As a performance optimization, we create entity state methods lazily. We first add
60
+ * the `null` value to the prototype to reserve space in memory. Then we define a setter on the
61
+ * prototype that will be executed exactly once per entity instance. There we redefine the given
62
+ * property on the entity instance, so shadowing the prototype setter.
63
+ */
64
+ static defineBaseProperties(meta, prototype, em) {
65
+ // oxfmt-ignore
66
+ const helperParams = meta.embeddable || meta.virtual ? [] : [em.getComparator().getPkGetter(meta), em.getComparator().getPkSerializer(meta), em.getComparator().getPkGetterConverted(meta)];
67
+ Object.defineProperties(prototype, {
68
+ __entity: { value: !meta.embeddable, configurable: true },
69
+ __meta: { value: meta, configurable: true },
70
+ __config: { value: em.config, configurable: true },
71
+ __platform: { value: em.getPlatform(), configurable: true },
72
+ __factory: { value: em.getEntityFactory(), configurable: true },
73
+ __helper: {
74
+ get() {
75
+ Object.defineProperty(this, '__helper', {
76
+ value: new WrappedEntity(this, em.getHydrator(), ...helperParams),
77
+ enumerable: false,
78
+ configurable: true,
79
+ });
80
+ return this.__helper;
81
+ },
82
+ configurable: true, // otherwise jest fails when trying to compare entities ¯\_(ツ)_/¯
83
+ },
84
+ });
85
+ }
86
+ /**
87
+ * Defines getter and setter for every owning side of m:1 and 1:1 relation. This is then used for propagation of
88
+ * changes to the inverse side of bi-directional relations. Rest of the properties are also defined this way to
89
+ * achieve dirtiness, which is then used for fast checks whether we need to auto-flush because of managed entities.
90
+ *
91
+ * First defines a setter on the prototype, once called, actual get/set handlers are registered on the instance rather
92
+ * than on its prototype. Thanks to this we still have those properties enumerable (e.g. part of `Object.keys(entity)`).
93
+ */
94
+ static defineProperties(meta, em) {
95
+ Object.values(meta.properties).forEach(prop => {
96
+ const isCollection = [ReferenceKind.ONE_TO_MANY, ReferenceKind.MANY_TO_MANY].includes(prop.kind);
97
+ // oxfmt-ignore
98
+ const isReference = [ReferenceKind.ONE_TO_ONE, ReferenceKind.MANY_TO_ONE].includes(prop.kind) && (prop.inversedBy || prop.mappedBy) && !prop.mapToPk;
99
+ if (isReference) {
100
+ Object.defineProperty(meta.prototype, prop.name, {
101
+ set(val) {
102
+ EntityHelper.defineReferenceProperty(meta, prop, this, em.getHydrator());
103
+ this[prop.name] = val;
104
+ },
105
+ configurable: true,
106
+ });
107
+ return;
108
+ }
109
+ if (prop.inherited || prop.primary || prop.accessor || prop.persist === false || prop.embedded || isCollection) {
110
+ return;
111
+ }
112
+ Object.defineProperty(meta.prototype, prop.name, {
113
+ set(val) {
114
+ Object.defineProperty(this, prop.name, {
162
115
  get() {
163
- return helper(ref).__data[prop.name];
116
+ return this.__helper?.__data[prop.name];
164
117
  },
165
118
  set(val) {
166
- const entity = Reference.unwrapReference(val ?? wrapped.__data[prop.name]);
167
- const old = Reference.unwrapReference(wrapped.__data[prop.name]);
168
- // oxfmt-ignore
169
- if (old && old !== entity && prop.kind === ReferenceKind.MANY_TO_ONE && prop.inversedBy && old[prop.inversedBy]) {
170
- old[prop.inversedBy].removeWithoutPropagation(this);
171
- }
172
- wrapped.__data[prop.name] = Reference.wrapReference(val, prop);
173
- // when propagation from inside hydration, we set the FK to the entity data immediately
174
- if (val && hydrator.isRunning() && wrapped.__originalEntityData && prop.owner) {
175
- wrapped.__originalEntityData[prop.name] = Utils.getPrimaryKeyValues(wrapped.__data[prop.name], prop.targetMeta, true);
176
- }
177
- EntityHelper.propagate(meta, entity, this, prop, Reference.unwrapReference(val), old);
119
+ this.__helper.__data[prop.name] = val;
178
120
  },
179
121
  enumerable: true,
180
122
  configurable: true,
181
- });
182
- }
183
- static propagate(meta, entity, owner, prop, value, old) {
184
- // For polymorphic relations, get bidirectional relations from the actual entity's metadata
185
- let bidirectionalRelations;
186
- if (prop.polymorphic && prop.polymorphTargets?.length) {
187
- // For polymorphic relations, we need to get the bidirectional relations from the actual value's metadata
188
- if (!value) {
189
- return; // No value means no propagation needed
190
- }
191
- bidirectionalRelations = helper(value).__meta.bidirectionalRelations;
123
+ });
124
+ this.__helper.__data[prop.name] = val;
125
+ },
126
+ configurable: true,
127
+ });
128
+ });
129
+ }
130
+ static defineCustomInspect(meta) {
131
+ // @ts-ignore
132
+ meta.prototype[Symbol.for('nodejs.util.inspect.custom')] ??= function (depth = 2) {
133
+ const object = {};
134
+ const keys = new Set(Utils.keys(this));
135
+ for (const prop of meta.props) {
136
+ if (keys.has(prop.name) || (prop.getter && prop.accessor === prop.name)) {
137
+ object[prop.name] = this[prop.name];
192
138
  }
193
- else {
194
- bidirectionalRelations = prop.targetMeta.bidirectionalRelations;
139
+ }
140
+ for (const key of keys) {
141
+ if (!meta.properties[key]) {
142
+ object[key] = this[key];
195
143
  }
196
- for (const prop2 of bidirectionalRelations) {
197
- if ((prop2.inversedBy || prop2.mappedBy) !== prop.name) {
198
- continue;
199
- }
200
- // oxfmt-ignore
201
- if (prop2.targetMeta.abstract ? prop2.targetMeta.root.class !== meta.root.class : prop2.targetMeta.class !== meta.class) {
202
- continue;
203
- }
204
- const inverse = value?.[prop2.name];
205
- if (prop.ref && owner[prop.name]) {
206
- // eslint-disable-next-line dot-notation
207
- owner[prop.name]['property'] = prop;
208
- }
209
- if (Utils.isCollection(inverse) && inverse.isPartial()) {
210
- continue;
211
- }
212
- if (prop.kind === ReferenceKind.MANY_TO_ONE && Utils.isCollection(inverse) && inverse.isInitialized()) {
213
- inverse.addWithoutPropagation(owner);
214
- helper(owner).__em?.getUnitOfWork().cancelOrphanRemoval(owner);
215
- }
216
- if (prop.kind === ReferenceKind.ONE_TO_ONE) {
217
- if ((value != null && Reference.unwrapReference(inverse) !== owner) ||
218
- (value == null && entity?.[prop2.name] != null)) {
219
- if (entity && (!prop.owner || helper(entity).__initialized)) {
220
- EntityHelper.propagateOneToOne(entity, owner, prop, prop2, value, old);
221
- }
222
- if (old && prop.orphanRemoval) {
223
- helper(old).__em?.getUnitOfWork().scheduleOrphanRemoval(old);
224
- }
144
+ }
145
+ // ensure we dont have internal symbols in the POJO
146
+ [OptionalProps, EntityRepositoryType, PrimaryKeyProp, EagerProps, HiddenProps, EntityName].forEach(
147
+ sym => delete object[sym],
148
+ );
149
+ meta.props.filter(prop => object[prop.name] === undefined).forEach(prop => delete object[prop.name]);
150
+ const ret = inspect(object, { depth });
151
+ let name = this.constructor.name;
152
+ const showEM = ['true', 't', '1'].includes(getEnv('MIKRO_ORM_LOG_EM_ID')?.toLowerCase() ?? '');
153
+ if (showEM) {
154
+ if (helper(this).__em) {
155
+ name += ` [managed by ${helper(this).__em.id}]`;
156
+ } else {
157
+ name += ` [not managed]`;
158
+ }
159
+ }
160
+ // distinguish not initialized entities
161
+ if (!helper(this).__initialized) {
162
+ name = `(${name})`;
163
+ }
164
+ return ret === '[Object]' ? `[${name}]` : name + ' ' + ret;
165
+ };
166
+ }
167
+ static defineReferenceProperty(meta, prop, ref, hydrator) {
168
+ const wrapped = helper(ref);
169
+ Object.defineProperty(ref, prop.name, {
170
+ get() {
171
+ return helper(ref).__data[prop.name];
172
+ },
173
+ set(val) {
174
+ const entity = Reference.unwrapReference(val ?? wrapped.__data[prop.name]);
175
+ const old = Reference.unwrapReference(wrapped.__data[prop.name]);
176
+ // oxfmt-ignore
177
+ if (old && old !== entity && prop.kind === ReferenceKind.MANY_TO_ONE && prop.inversedBy && old[prop.inversedBy]) {
178
+ old[prop.inversedBy].removeWithoutPropagation(this);
225
179
  }
226
- }
180
+ wrapped.__data[prop.name] = Reference.wrapReference(val, prop);
181
+ // when propagation from inside hydration, we set the FK to the entity data immediately
182
+ if (val && hydrator.isRunning() && wrapped.__originalEntityData && prop.owner) {
183
+ wrapped.__originalEntityData[prop.name] = Utils.getPrimaryKeyValues(
184
+ wrapped.__data[prop.name],
185
+ prop.targetMeta,
186
+ true,
187
+ );
227
188
  }
189
+ EntityHelper.propagate(meta, entity, this, prop, Reference.unwrapReference(val), old);
190
+ },
191
+ enumerable: true,
192
+ configurable: true,
193
+ });
194
+ }
195
+ static propagate(meta, entity, owner, prop, value, old) {
196
+ // For polymorphic relations, get bidirectional relations from the actual entity's metadata
197
+ let bidirectionalRelations;
198
+ if (prop.polymorphic && prop.polymorphTargets?.length) {
199
+ // For polymorphic relations, we need to get the bidirectional relations from the actual value's metadata
200
+ if (!value) {
201
+ return; // No value means no propagation needed
202
+ }
203
+ bidirectionalRelations = helper(value).__meta.bidirectionalRelations;
204
+ } else {
205
+ bidirectionalRelations = prop.targetMeta.bidirectionalRelations;
228
206
  }
229
- static propagateOneToOne(entity, owner, prop, prop2, value, old) {
230
- helper(entity).__pk = helper(entity).getPrimaryKey();
231
- // the inverse side will be changed on the `value` too, so we need to clean-up and schedule orphan removal there too
232
- if (!prop.primary &&
233
- !prop2.mapToPk &&
234
- value?.[prop2.name] != null &&
235
- Reference.unwrapReference(value[prop2.name]) !== entity) {
236
- const other = Reference.unwrapReference(value[prop2.name]);
237
- delete helper(other).__data[prop.name];
238
- if (prop2.orphanRemoval) {
239
- helper(other).__em?.getUnitOfWork().scheduleOrphanRemoval(other);
207
+ for (const prop2 of bidirectionalRelations) {
208
+ if ((prop2.inversedBy || prop2.mappedBy) !== prop.name) {
209
+ continue;
210
+ }
211
+ // oxfmt-ignore
212
+ if (prop2.targetMeta.abstract ? prop2.targetMeta.root.class !== meta.root.class : prop2.targetMeta.class !== meta.class) {
213
+ continue;
240
214
  }
215
+ const inverse = value?.[prop2.name];
216
+ if (prop.ref && owner[prop.name]) {
217
+ // eslint-disable-next-line dot-notation
218
+ owner[prop.name]['property'] = prop;
219
+ }
220
+ if (Utils.isCollection(inverse) && inverse.isPartial()) {
221
+ continue;
222
+ }
223
+ if (prop.kind === ReferenceKind.MANY_TO_ONE && Utils.isCollection(inverse) && inverse.isInitialized()) {
224
+ inverse.addWithoutPropagation(owner);
225
+ helper(owner).__em?.getUnitOfWork().cancelOrphanRemoval(owner);
226
+ }
227
+ if (prop.kind === ReferenceKind.ONE_TO_ONE) {
228
+ if (
229
+ (value != null && Reference.unwrapReference(inverse) !== owner) ||
230
+ (value == null && entity?.[prop2.name] != null)
231
+ ) {
232
+ if (entity && (!prop.owner || helper(entity).__initialized)) {
233
+ EntityHelper.propagateOneToOne(entity, owner, prop, prop2, value, old);
234
+ }
235
+ if (old && prop.orphanRemoval) {
236
+ helper(old).__em?.getUnitOfWork().scheduleOrphanRemoval(old);
237
+ }
241
238
  }
242
- // Skip setting the inverse side to null if it's a primary key - the entity will be removed via orphan removal
243
- // Setting a primary key to null would corrupt the entity and cause validation errors
244
- if (value == null && prop.orphanRemoval && prop2.primary) {
245
- return;
246
- }
247
- if (value == null) {
248
- entity[prop2.name] = value;
249
- }
250
- else if (prop2.mapToPk) {
251
- entity[prop2.name] = helper(owner).getPrimaryKey();
252
- }
253
- else {
254
- entity[prop2.name] = Reference.wrapReference(owner, prop);
255
- }
256
- if (old?.[prop2.name] != null) {
257
- delete helper(old).__data[prop2.name];
258
- old[prop2.name] = null;
259
- }
239
+ }
260
240
  }
261
- static ensurePropagation(entity) {
262
- if (entity.__gettersDefined) {
263
- return;
264
- }
265
- const wrapped = helper(entity);
266
- const meta = wrapped.__meta;
267
- const platform = wrapped.__platform;
268
- const serializedPrimaryKey = meta.props.find(p => p.serializedPrimaryKey);
269
- const values = [];
270
- if (serializedPrimaryKey) {
271
- const pk = meta.getPrimaryProps()[0];
272
- const val = entity[serializedPrimaryKey.name];
273
- delete entity[serializedPrimaryKey.name];
274
- Object.defineProperty(entity, serializedPrimaryKey.name, {
275
- get() {
276
- return this[pk.name] ? platform.normalizePrimaryKey(this[pk.name]) : null;
277
- },
278
- set(id) {
279
- this[pk.name] = id ? platform.denormalizePrimaryKey(id) : null;
280
- },
281
- configurable: true,
282
- });
283
- if (entity[pk.name] == null && val != null) {
284
- values.push(serializedPrimaryKey.name, val);
285
- }
286
- }
287
- for (const prop of meta.trackingProps) {
288
- if (entity[prop.name] !== undefined) {
289
- values.push(prop.name, entity[prop.name]);
290
- }
291
- delete entity[prop.name];
292
- }
293
- Object.defineProperties(entity, meta.definedProperties);
294
- for (let i = 0; i < values.length; i += 2) {
295
- entity[values[i]] = values[i + 1];
296
- }
241
+ }
242
+ static propagateOneToOne(entity, owner, prop, prop2, value, old) {
243
+ helper(entity).__pk = helper(entity).getPrimaryKey();
244
+ // the inverse side will be changed on the `value` too, so we need to clean-up and schedule orphan removal there too
245
+ if (
246
+ !prop.primary &&
247
+ !prop2.mapToPk &&
248
+ value?.[prop2.name] != null &&
249
+ Reference.unwrapReference(value[prop2.name]) !== entity
250
+ ) {
251
+ const other = Reference.unwrapReference(value[prop2.name]);
252
+ delete helper(other).__data[prop.name];
253
+ if (prop2.orphanRemoval) {
254
+ helper(other).__em?.getUnitOfWork().scheduleOrphanRemoval(other);
255
+ }
256
+ }
257
+ // Skip setting the inverse side to null if it's a primary key - the entity will be removed via orphan removal
258
+ // Setting a primary key to null would corrupt the entity and cause validation errors
259
+ if (value == null && prop.orphanRemoval && prop2.primary) {
260
+ return;
261
+ }
262
+ if (value == null) {
263
+ entity[prop2.name] = value;
264
+ } else if (prop2.mapToPk) {
265
+ entity[prop2.name] = helper(owner).getPrimaryKey();
266
+ } else {
267
+ entity[prop2.name] = Reference.wrapReference(owner, prop);
268
+ }
269
+ if (old?.[prop2.name] != null) {
270
+ delete helper(old).__data[prop2.name];
271
+ old[prop2.name] = null;
272
+ }
273
+ }
274
+ static ensurePropagation(entity) {
275
+ if (entity.__gettersDefined) {
276
+ return;
277
+ }
278
+ const wrapped = helper(entity);
279
+ const meta = wrapped.__meta;
280
+ const platform = wrapped.__platform;
281
+ const serializedPrimaryKey = meta.props.find(p => p.serializedPrimaryKey);
282
+ const values = [];
283
+ if (serializedPrimaryKey) {
284
+ const pk = meta.getPrimaryProps()[0];
285
+ const val = entity[serializedPrimaryKey.name];
286
+ delete entity[serializedPrimaryKey.name];
287
+ Object.defineProperty(entity, serializedPrimaryKey.name, {
288
+ get() {
289
+ return this[pk.name] ? platform.normalizePrimaryKey(this[pk.name]) : null;
290
+ },
291
+ set(id) {
292
+ this[pk.name] = id ? platform.denormalizePrimaryKey(id) : null;
293
+ },
294
+ configurable: true,
295
+ });
296
+ if (entity[pk.name] == null && val != null) {
297
+ values.push(serializedPrimaryKey.name, val);
298
+ }
299
+ }
300
+ for (const prop of meta.trackingProps) {
301
+ if (entity[prop.name] !== undefined) {
302
+ values.push(prop.name, entity[prop.name]);
303
+ }
304
+ delete entity[prop.name];
305
+ }
306
+ Object.defineProperties(entity, meta.definedProperties);
307
+ for (let i = 0; i < values.length; i += 2) {
308
+ entity[values[i]] = values[i + 1];
297
309
  }
310
+ }
298
311
  }