@mikro-orm/core 7.0.10 → 7.0.11-dev.1

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 +584 -885
  2. package/EntityManager.js +1900 -1927
  3. package/MikroORM.d.ts +74 -103
  4. package/MikroORM.js +178 -177
  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 +181 -215
  23. package/entity/Collection.js +724 -730
  24. package/entity/EntityAssigner.d.ts +77 -88
  25. package/entity/EntityAssigner.js +230 -231
  26. package/entity/EntityFactory.d.ts +55 -67
  27. package/entity/EntityFactory.js +416 -457
  28. package/entity/EntityHelper.d.ts +23 -35
  29. package/entity/EntityHelper.js +290 -302
  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 +776 -805
  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 +83 -127
  39. package/entity/Reference.js +277 -281
  40. package/entity/WrappedEntity.d.ts +72 -115
  41. package/entity/WrappedEntity.js +166 -168
  42. package/entity/defineEntity.d.ts +654 -1359
  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 +418 -483
  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 +130 -214
  74. package/metadata/EntitySchema.js +412 -411
  75. package/metadata/MetadataDiscovery.d.ts +114 -114
  76. package/metadata/MetadataDiscovery.js +1884 -1962
  77. package/metadata/MetadataProvider.d.ts +26 -29
  78. package/metadata/MetadataProvider.js +97 -95
  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 +303 -312
  100. package/platforms/Platform.js +675 -695
  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 +741 -1254
  160. package/typings.js +233 -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 +179 -187
  165. package/unit-of-work/ChangeSetPersister.d.ts +50 -69
  166. package/unit-of-work/ChangeSetPersister.js +442 -465
  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 +1223 -1237
  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 +82 -99
  186. package/utils/EntityComparator.js +737 -829
  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 +364 -375
  191. package/utils/RawQueryFragment.d.ts +34 -50
  192. package/utils/RawQueryFragment.js +121 -122
  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 +200 -202
  199. package/utils/Utils.d.ts +145 -204
  200. package/utils/Utils.js +826 -826
  201. package/utils/clone.js +114 -105
  202. package/utils/env-vars.js +88 -90
  203. package/utils/fs-utils.d.ts +15 -15
  204. package/utils/fs-utils.js +182 -181
  205. package/utils/upsert-utils.d.ts +5 -20
  206. package/utils/upsert-utils.js +116 -114
@@ -2,40 +2,40 @@ import type { AnyString, Dictionary, EntityKey } from '../typings.js';
2
2
  declare const rawFragmentSymbolBrand: unique symbol;
3
3
  /** Branded symbol type used as a unique key for tracking raw SQL fragments in object properties. */
4
4
  export type RawQueryFragmentSymbol = symbol & {
5
- readonly [rawFragmentSymbolBrand]: true;
5
+ readonly [rawFragmentSymbolBrand]: true;
6
6
  };
7
7
  /** Checks whether the given value is a `RawQueryFragment` instance. */
8
8
  export declare function isRaw(value: unknown): value is RawQueryFragment;
9
9
  /** Represents a raw SQL fragment with optional parameters, usable as both a value and an object key via Symbol coercion. */
10
10
  export declare class RawQueryFragment<Alias extends string = string> {
11
- #private;
12
- readonly sql: string;
13
- readonly params: unknown[];
14
- /** @internal Type-level only - used to track the alias for type inference */
15
- private readonly __alias?;
16
- constructor(sql: string, params?: unknown[]);
17
- /** Returns a unique symbol key for this fragment, creating and caching it on first access. */
18
- get key(): RawQueryFragmentSymbol;
19
- /** Creates a new fragment with an alias appended via `as ??`. */
20
- as<A extends string>(alias: A): RawQueryFragment<A>;
21
- [Symbol.toPrimitive](hint: 'string'): RawQueryFragmentSymbol;
22
- get [Symbol.toStringTag](): string;
23
- toJSON(): string;
24
- clone(): this;
25
- /** Checks whether the given value is a symbol that maps to a known raw query fragment. */
26
- static isKnownFragmentSymbol(key: unknown): key is RawQueryFragmentSymbol;
27
- /** Checks whether an object has any symbol keys that are known raw query fragments. */
28
- static hasObjectFragments(object: unknown): boolean;
29
- /** Checks whether the given value is a RawQueryFragment instance or a known fragment symbol. */
30
- static isKnownFragment(key: unknown): key is RawQueryFragment | symbol;
31
- /** Retrieves the RawQueryFragment associated with the given key (instance or symbol). */
32
- static getKnownFragment(key: unknown): RawQueryFragment | undefined;
11
+ #private;
12
+ readonly sql: string;
13
+ readonly params: unknown[];
14
+ /** @internal Type-level only - used to track the alias for type inference */
15
+ private readonly __alias?;
16
+ constructor(sql: string, params?: unknown[]);
17
+ /** Returns a unique symbol key for this fragment, creating and caching it on first access. */
18
+ get key(): RawQueryFragmentSymbol;
19
+ /** Creates a new fragment with an alias appended via `as ??`. */
20
+ as<A extends string>(alias: A): RawQueryFragment<A>;
21
+ [Symbol.toPrimitive](hint: 'string'): RawQueryFragmentSymbol;
22
+ get [Symbol.toStringTag](): string;
23
+ toJSON(): string;
24
+ clone(): this;
25
+ /** Checks whether the given value is a symbol that maps to a known raw query fragment. */
26
+ static isKnownFragmentSymbol(key: unknown): key is RawQueryFragmentSymbol;
27
+ /** Checks whether an object has any symbol keys that are known raw query fragments. */
28
+ static hasObjectFragments(object: unknown): boolean;
29
+ /** Checks whether the given value is a RawQueryFragment instance or a known fragment symbol. */
30
+ static isKnownFragment(key: unknown): key is RawQueryFragment | symbol;
31
+ /** Retrieves the RawQueryFragment associated with the given key (instance or symbol). */
32
+ static getKnownFragment(key: unknown): RawQueryFragment | undefined;
33
33
  }
34
34
  export { RawQueryFragment as Raw };
35
35
  /** @internal */
36
- export declare const ALIAS_REPLACEMENT = '[::alias::]';
36
+ export declare const ALIAS_REPLACEMENT = "[::alias::]";
37
37
  /** @internal */
38
- export declare const ALIAS_REPLACEMENT_RE = '\\[::alias::\\]';
38
+ export declare const ALIAS_REPLACEMENT_RE = "\\[::alias::\\]";
39
39
  /**
40
40
  * Creates raw SQL query fragment that can be assigned to a property or part of a filter. This fragment is represented
41
41
  * by `RawQueryFragment` class instance that can be serialized to a string, so it can be used both as an object value
@@ -91,10 +91,7 @@ export declare const ALIAS_REPLACEMENT_RE = '\\[::alias::\\]';
91
91
  * export class Author { ... }
92
92
  * ```
93
93
  */
94
- export declare function raw<R = RawQueryFragment & symbol, T extends object = any>(
95
- sql: EntityKey<T> | EntityKey<T>[] | AnyString | ((alias: string) => string) | RawQueryFragment,
96
- params?: readonly unknown[] | Dictionary<unknown>,
97
- ): R;
94
+ export declare function raw<R = RawQueryFragment & symbol, T extends object = any>(sql: EntityKey<T> | EntityKey<T>[] | AnyString | ((alias: string) => string) | RawQueryFragment, params?: readonly unknown[] | Dictionary<unknown>): R;
98
95
  /**
99
96
  * Alternative to the `raw()` helper allowing to use it as a tagged template function for the simple cases.
100
97
  *
@@ -114,20 +111,13 @@ export declare function raw<R = RawQueryFragment & symbol, T extends object = an
114
111
  */
115
112
  export declare function sql<R = RawQueryFragment & symbol>(sql: readonly string[], ...values: unknown[]): R;
116
113
  export declare namespace sql {
117
- var ref: <T extends object = any>(...keys: string[]) => RawQueryFragment & symbol;
118
- var now: (length?: number) => RawQueryFragment & symbol;
119
- var lower: <R = RawQueryFragment<string> & symbol, T extends object = any>(
120
- key: string | ((alias: string) => string),
121
- ) => R;
122
- var upper: <R = RawQueryFragment<string> & symbol, T extends object = any>(
123
- key: string | ((alias: string) => string),
124
- ) => R;
114
+ var ref: <T extends object = any>(...keys: string[]) => RawQueryFragment & symbol;
115
+ var now: (length?: number) => RawQueryFragment & symbol;
116
+ var lower: <R = RawQueryFragment<string> & symbol, T extends object = any>(key: string | ((alias: string) => string)) => R;
117
+ var upper: <R = RawQueryFragment<string> & symbol, T extends object = any>(key: string | ((alias: string) => string)) => R;
125
118
  }
126
119
  /** Creates a raw SQL function expression wrapping the given key (e.g., `lower(name)`). */
127
- export declare function createSqlFunction<R = RawQueryFragment & symbol, T extends object = any>(
128
- func: string,
129
- key: string | ((alias: string) => string),
130
- ): R;
120
+ export declare function createSqlFunction<R = RawQueryFragment & symbol, T extends object = any>(func: string, key: string | ((alias: string) => string)): R;
131
121
  /**
132
122
  * Tag function providing quoting of db identifiers (table name, columns names, index names, ...).
133
123
  *
@@ -141,12 +131,6 @@ export declare function createSqlFunction<R = RawQueryFragment & symbol, T exten
141
131
  * export class Author { ... }
142
132
  * ```
143
133
  */
144
- export declare function quote(
145
- expParts: readonly string[],
146
- ...values: (
147
- | string
148
- | {
149
- toString(): string;
150
- }
151
- )[]
152
- ): RawQueryFragment & symbol;
134
+ export declare function quote(expParts: readonly string[], ...values: (string | {
135
+ toString(): string;
136
+ })[]): RawQueryFragment & symbol;
@@ -11,99 +11,98 @@ const RAW_FRAGMENT_BRAND = '__mikroOrmRawFragment';
11
11
  // via `raw('…')` and stores its symbol in a where-clause object key, the other
12
12
  // copy still needs to recover the original fragment to assemble SQL.
13
13
  const REGISTRY_KEY = Symbol.for('@mikro-orm/core/RawQueryFragment.references');
14
- const rawQueryReferences = (globalThis[REGISTRY_KEY] ??= new WeakMap());
14
+ const rawQueryReferences = (globalThis[REGISTRY_KEY] ??=
15
+ new WeakMap());
15
16
  /** Checks whether the given value is a `RawQueryFragment` instance. */
16
17
  export function isRaw(value) {
17
- if (value == null || typeof value !== 'object') {
18
+ if (value == null || typeof value !== 'object') {
19
+ return false;
20
+ }
21
+ // Fast path: intra-module instances and their subclasses.
22
+ // eslint-disable-next-line no-use-before-define
23
+ if (value instanceof RawQueryFragment) {
24
+ return true;
25
+ }
26
+ // Walk the prototype chain starting from the *prototype* (not the value) so
27
+ // own-property spoofing from JSON payloads cannot forge the brand. Stop at
28
+ // `Object.prototype`, which is never branded — that bails plain objects,
29
+ // JSON payloads, and built-ins like `Date`/`Array`/`Map` at depth 1.
30
+ for (let p = Object.getPrototypeOf(value); p != null && p !== Object.prototype; p = Object.getPrototypeOf(p)) {
31
+ if (Object.hasOwn(p, RAW_FRAGMENT_BRAND)) {
32
+ return true;
33
+ }
34
+ }
18
35
  return false;
19
- }
20
- // Fast path: intra-module instances and their subclasses.
21
- // eslint-disable-next-line no-use-before-define
22
- if (value instanceof RawQueryFragment) {
23
- return true;
24
- }
25
- // Walk the prototype chain starting from the *prototype* (not the value) so
26
- // own-property spoofing from JSON payloads cannot forge the brand. Stop at
27
- // `Object.prototype`, which is never branded — that bails plain objects,
28
- // JSON payloads, and built-ins like `Date`/`Array`/`Map` at depth 1.
29
- for (let p = Object.getPrototypeOf(value); p != null && p !== Object.prototype; p = Object.getPrototypeOf(p)) {
30
- if (Object.hasOwn(p, RAW_FRAGMENT_BRAND)) {
31
- return true;
32
- }
33
- }
34
- return false;
35
36
  }
36
37
  /** Represents a raw SQL fragment with optional parameters, usable as both a value and an object key via Symbol coercion. */
37
38
  export class RawQueryFragment {
38
- sql;
39
- params;
40
- #key;
41
- constructor(sql, params = []) {
42
- this.sql = sql;
43
- this.params = params;
44
- }
45
- /** Returns a unique symbol key for this fragment, creating and caching it on first access. */
46
- get key() {
47
- if (!this.#key) {
48
- this.#key = Symbol(this.toJSON());
49
- rawQueryReferences.set(this.#key, this);
50
- }
51
- return this.#key;
52
- }
53
- /** Creates a new fragment with an alias appended via `as ??`. */
54
- as(alias) {
55
- return new RawQueryFragment(`${this.sql} as ??`, [...this.params, alias]);
56
- }
57
- [Symbol.toPrimitive](hint) {
58
- // if a fragment is converted to string (used as an object key), return a unique symbol
59
- // and save a weak reference to map so we can retrieve it when compiling the query
60
- if (hint === 'string') {
61
- return this.key;
62
- }
63
- throw new Error(`Trying to modify raw SQL fragment: '${this.sql}'`);
64
- }
65
- get [Symbol.toStringTag]() {
66
- return this.toJSON();
67
- }
68
- toJSON() {
69
- return `raw('${this.sql}')`;
70
- }
71
- clone() {
72
- return this;
73
- }
74
- /** Checks whether the given value is a symbol that maps to a known raw query fragment. */
75
- static isKnownFragmentSymbol(key) {
76
- return typeof key === 'symbol' && rawQueryReferences.has(key);
77
- }
78
- /** Checks whether an object has any symbol keys that are known raw query fragments. */
79
- static hasObjectFragments(object) {
80
- return (
81
- Utils.isPlainObject(object) &&
82
- Object.getOwnPropertySymbols(object).some(symbol => this.isKnownFragmentSymbol(symbol))
83
- );
84
- }
85
- /** Checks whether the given value is a RawQueryFragment instance or a known fragment symbol. */
86
- static isKnownFragment(key) {
87
- return isRaw(key) || this.isKnownFragmentSymbol(key);
88
- }
89
- /** Retrieves the RawQueryFragment associated with the given key (instance or symbol). */
90
- static getKnownFragment(key) {
91
- if (isRaw(key)) {
92
- return key;
93
- }
94
- if (typeof key !== 'symbol') {
95
- return;
96
- }
97
- return rawQueryReferences.get(key);
98
- }
99
- /** @ignore */
100
- /* v8 ignore next */
101
- [Symbol.for('nodejs.util.inspect.custom')]() {
102
- if (this.params) {
103
- return { sql: this.sql, params: this.params };
104
- }
105
- return { sql: this.sql };
106
- }
39
+ sql;
40
+ params;
41
+ #key;
42
+ constructor(sql, params = []) {
43
+ this.sql = sql;
44
+ this.params = params;
45
+ }
46
+ /** Returns a unique symbol key for this fragment, creating and caching it on first access. */
47
+ get key() {
48
+ if (!this.#key) {
49
+ this.#key = Symbol(this.toJSON());
50
+ rawQueryReferences.set(this.#key, this);
51
+ }
52
+ return this.#key;
53
+ }
54
+ /** Creates a new fragment with an alias appended via `as ??`. */
55
+ as(alias) {
56
+ return new RawQueryFragment(`${this.sql} as ??`, [...this.params, alias]);
57
+ }
58
+ [Symbol.toPrimitive](hint) {
59
+ // if a fragment is converted to string (used as an object key), return a unique symbol
60
+ // and save a weak reference to map so we can retrieve it when compiling the query
61
+ if (hint === 'string') {
62
+ return this.key;
63
+ }
64
+ throw new Error(`Trying to modify raw SQL fragment: '${this.sql}'`);
65
+ }
66
+ get [Symbol.toStringTag]() {
67
+ return this.toJSON();
68
+ }
69
+ toJSON() {
70
+ return `raw('${this.sql}')`;
71
+ }
72
+ clone() {
73
+ return this;
74
+ }
75
+ /** Checks whether the given value is a symbol that maps to a known raw query fragment. */
76
+ static isKnownFragmentSymbol(key) {
77
+ return typeof key === 'symbol' && rawQueryReferences.has(key);
78
+ }
79
+ /** Checks whether an object has any symbol keys that are known raw query fragments. */
80
+ static hasObjectFragments(object) {
81
+ return (Utils.isPlainObject(object) &&
82
+ Object.getOwnPropertySymbols(object).some(symbol => this.isKnownFragmentSymbol(symbol)));
83
+ }
84
+ /** Checks whether the given value is a RawQueryFragment instance or a known fragment symbol. */
85
+ static isKnownFragment(key) {
86
+ return isRaw(key) || this.isKnownFragmentSymbol(key);
87
+ }
88
+ /** Retrieves the RawQueryFragment associated with the given key (instance or symbol). */
89
+ static getKnownFragment(key) {
90
+ if (isRaw(key)) {
91
+ return key;
92
+ }
93
+ if (typeof key !== 'symbol') {
94
+ return;
95
+ }
96
+ return rawQueryReferences.get(key);
97
+ }
98
+ /** @ignore */
99
+ /* v8 ignore next */
100
+ [Symbol.for('nodejs.util.inspect.custom')]() {
101
+ if (this.params) {
102
+ return { sql: this.sql, params: this.params };
103
+ }
104
+ return { sql: this.sql };
105
+ }
107
106
  }
108
107
  // Non-enumerable so the brand is skipped by JSON/Object.keys/for-in, and locked
109
108
  // down (non-writable, non-configurable) so in-process code cannot delete or
@@ -113,9 +112,9 @@ export class RawQueryFragment {
113
112
  // brand on their own prototype (a different object), so lockdown only blocks
114
113
  // tampering with the canonical marker.
115
114
  Object.defineProperty(RawQueryFragment.prototype, RAW_FRAGMENT_BRAND, {
116
- value: true,
117
- writable: false,
118
- configurable: false,
115
+ value: true,
116
+ writable: false,
117
+ configurable: false,
119
118
  });
120
119
  export { RawQueryFragment as Raw };
121
120
  /** @internal */
@@ -178,30 +177,30 @@ export const ALIAS_REPLACEMENT_RE = '\\[::alias::\\]';
178
177
  * ```
179
178
  */
180
179
  export function raw(sql, params) {
181
- if (isRaw(sql)) {
182
- return sql;
183
- }
184
- if (sql instanceof Function) {
185
- sql = sql(ALIAS_REPLACEMENT);
186
- }
187
- if (sql === '??' && Array.isArray(params)) {
180
+ if (isRaw(sql)) {
181
+ return sql;
182
+ }
183
+ if (sql instanceof Function) {
184
+ sql = sql(ALIAS_REPLACEMENT);
185
+ }
186
+ if (sql === '??' && Array.isArray(params)) {
187
+ return new RawQueryFragment(sql, params);
188
+ }
189
+ if (Array.isArray(sql)) {
190
+ // for composite FK we return just a simple string
191
+ return Utils.getPrimaryKeyHash(sql);
192
+ }
193
+ if (typeof params === 'object' && !Array.isArray(params)) {
194
+ const pairs = Object.entries(params);
195
+ const objectParams = [];
196
+ for (const [key, value] of pairs) {
197
+ sql = sql.replace(`:${key}:`, '??');
198
+ sql = sql.replace(`:${key}`, '?');
199
+ objectParams.push(value);
200
+ }
201
+ return new RawQueryFragment(sql, objectParams);
202
+ }
188
203
  return new RawQueryFragment(sql, params);
189
- }
190
- if (Array.isArray(sql)) {
191
- // for composite FK we return just a simple string
192
- return Utils.getPrimaryKeyHash(sql);
193
- }
194
- if (typeof params === 'object' && !Array.isArray(params)) {
195
- const pairs = Object.entries(params);
196
- const objectParams = [];
197
- for (const [key, value] of pairs) {
198
- sql = sql.replace(`:${key}:`, '??');
199
- sql = sql.replace(`:${key}`, '?');
200
- objectParams.push(value);
201
- }
202
- return new RawQueryFragment(sql, objectParams);
203
- }
204
- return new RawQueryFragment(sql, params);
205
204
  }
206
205
  /**
207
206
  * Alternative to the `raw()` helper allowing to use it as a tagged template function for the simple cases.
@@ -221,19 +220,19 @@ export function raw(sql, params) {
221
220
  * ```
222
221
  */
223
222
  export function sql(sql, ...values) {
224
- return raw(sql.join('?'), values);
223
+ return raw(sql.join('?'), values);
225
224
  }
226
225
  /** Creates a raw SQL function expression wrapping the given key (e.g., `lower(name)`). */
227
226
  export function createSqlFunction(func, key) {
228
- if (typeof key === 'string') {
229
- return raw(`${func}(${key})`);
230
- }
231
- return raw(a => `${func}(${key(a)})`);
227
+ if (typeof key === 'string') {
228
+ return raw(`${func}(${key})`);
229
+ }
230
+ return raw(a => `${func}(${key(a)})`);
232
231
  }
233
232
  sql.ref = (...keys) => raw('??', [keys.join('.')]);
234
- sql.now = length => raw('current_timestamp' + (length == null ? '' : `(${length})`));
235
- sql.lower = key => createSqlFunction('lower', key);
236
- sql.upper = key => createSqlFunction('upper', key);
233
+ sql.now = (length) => raw('current_timestamp' + (length == null ? '' : `(${length})`));
234
+ sql.lower = (key) => createSqlFunction('lower', key);
235
+ sql.upper = (key) => createSqlFunction('upper', key);
237
236
  /**
238
237
  * Tag function providing quoting of db identifiers (table name, columns names, index names, ...).
239
238
  *
@@ -248,5 +247,5 @@ sql.upper = key => createSqlFunction('upper', key);
248
247
  * ```
249
248
  */
250
249
  export function quote(expParts, ...values) {
251
- return raw(expParts.join('??'), values);
250
+ return raw(expParts.join('??'), values);
252
251
  }
@@ -4,39 +4,39 @@ import { type LoggingOptions } from '../logging/Logger.js';
4
4
  * Uses `AsyncLocalStorage` to create async context that holds the current EM fork.
5
5
  */
6
6
  export declare class RequestContext {
7
- readonly map: Map<string, EntityManager>;
8
- private static storage;
9
- private static counter;
10
- readonly id: number;
11
- constructor(map: Map<string, EntityManager>);
12
- /**
13
- * Returns default EntityManager.
14
- */
15
- get em(): EntityManager | undefined;
16
- /**
17
- * Creates new RequestContext instance and runs the code inside its domain.
18
- * If the handler is async, the return value needs to be awaited.
19
- * Uses `AsyncLocalStorage.run()`, suitable for regular express style middlewares with a `next` callback.
20
- */
21
- static create<T>(em: EntityManager | EntityManager[], next: (...args: any[]) => T, options?: CreateContextOptions): T;
22
- /**
23
- * Creates new RequestContext instance and runs the code inside its domain.
24
- * If the handler is async, the return value needs to be awaited.
25
- * Uses `AsyncLocalStorage.enterWith()`, suitable for elysia style middlewares without a `next` callback.
26
- */
27
- static enter(em: EntityManager | EntityManager[], options?: CreateContextOptions): void;
28
- /**
29
- * Returns current RequestContext (if available).
30
- */
31
- static currentRequestContext(): RequestContext | undefined;
32
- /**
33
- * Returns current EntityManager (if available).
34
- */
35
- static getEntityManager(name?: string): EntityManager | undefined;
36
- private static createContext;
7
+ readonly map: Map<string, EntityManager>;
8
+ private static storage;
9
+ private static counter;
10
+ readonly id: number;
11
+ constructor(map: Map<string, EntityManager>);
12
+ /**
13
+ * Returns default EntityManager.
14
+ */
15
+ get em(): EntityManager | undefined;
16
+ /**
17
+ * Creates new RequestContext instance and runs the code inside its domain.
18
+ * If the handler is async, the return value needs to be awaited.
19
+ * Uses `AsyncLocalStorage.run()`, suitable for regular express style middlewares with a `next` callback.
20
+ */
21
+ static create<T>(em: EntityManager | EntityManager[], next: (...args: any[]) => T, options?: CreateContextOptions): T;
22
+ /**
23
+ * Creates new RequestContext instance and runs the code inside its domain.
24
+ * If the handler is async, the return value needs to be awaited.
25
+ * Uses `AsyncLocalStorage.enterWith()`, suitable for elysia style middlewares without a `next` callback.
26
+ */
27
+ static enter(em: EntityManager | EntityManager[], options?: CreateContextOptions): void;
28
+ /**
29
+ * Returns current RequestContext (if available).
30
+ */
31
+ static currentRequestContext(): RequestContext | undefined;
32
+ /**
33
+ * Returns current EntityManager (if available).
34
+ */
35
+ static getEntityManager(name?: string): EntityManager | undefined;
36
+ private static createContext;
37
37
  }
38
38
  /** Options for creating a new RequestContext, allowing schema and logger overrides. */
39
39
  export interface CreateContextOptions {
40
- schema?: string;
41
- loggerContext?: LoggingOptions;
40
+ schema?: string;
41
+ loggerContext?: LoggingOptions;
42
42
  }
@@ -3,57 +3,58 @@ import { createAsyncContext } from './AsyncContext.js';
3
3
  * Uses `AsyncLocalStorage` to create async context that holds the current EM fork.
4
4
  */
5
5
  export class RequestContext {
6
- map;
7
- static storage = createAsyncContext();
8
- static counter = 1;
9
- id = RequestContext.counter++;
10
- constructor(map) {
11
- this.map = map;
12
- }
13
- /**
14
- * Returns default EntityManager.
15
- */
16
- get em() {
17
- return this.map.get('default');
18
- }
19
- /**
20
- * Creates new RequestContext instance and runs the code inside its domain.
21
- * If the handler is async, the return value needs to be awaited.
22
- * Uses `AsyncLocalStorage.run()`, suitable for regular express style middlewares with a `next` callback.
23
- */
24
- static create(em, next, options = {}) {
25
- const ctx = this.createContext(em, options);
26
- return this.storage.run(ctx, next);
27
- }
28
- /**
29
- * Creates new RequestContext instance and runs the code inside its domain.
30
- * If the handler is async, the return value needs to be awaited.
31
- * Uses `AsyncLocalStorage.enterWith()`, suitable for elysia style middlewares without a `next` callback.
32
- */
33
- static enter(em, options = {}) {
34
- const ctx = this.createContext(em, options);
35
- this.storage.enterWith(ctx);
36
- }
37
- /**
38
- * Returns current RequestContext (if available).
39
- */
40
- static currentRequestContext() {
41
- return this.storage.getStore();
42
- }
43
- /**
44
- * Returns current EntityManager (if available).
45
- */
46
- static getEntityManager(name = 'default') {
47
- const context = RequestContext.currentRequestContext();
48
- return context ? context.map.get(name) : undefined;
49
- }
50
- static createContext(em, options = {}) {
51
- const forks = new Map();
52
- if (Array.isArray(em)) {
53
- em.forEach(em => forks.set(em.name, em.fork({ useContext: true, ...options })));
54
- } else {
55
- forks.set(em.name, em.fork({ useContext: true, ...options }));
6
+ map;
7
+ static storage = createAsyncContext();
8
+ static counter = 1;
9
+ id = RequestContext.counter++;
10
+ constructor(map) {
11
+ this.map = map;
12
+ }
13
+ /**
14
+ * Returns default EntityManager.
15
+ */
16
+ get em() {
17
+ return this.map.get('default');
18
+ }
19
+ /**
20
+ * Creates new RequestContext instance and runs the code inside its domain.
21
+ * If the handler is async, the return value needs to be awaited.
22
+ * Uses `AsyncLocalStorage.run()`, suitable for regular express style middlewares with a `next` callback.
23
+ */
24
+ static create(em, next, options = {}) {
25
+ const ctx = this.createContext(em, options);
26
+ return this.storage.run(ctx, next);
27
+ }
28
+ /**
29
+ * Creates new RequestContext instance and runs the code inside its domain.
30
+ * If the handler is async, the return value needs to be awaited.
31
+ * Uses `AsyncLocalStorage.enterWith()`, suitable for elysia style middlewares without a `next` callback.
32
+ */
33
+ static enter(em, options = {}) {
34
+ const ctx = this.createContext(em, options);
35
+ this.storage.enterWith(ctx);
36
+ }
37
+ /**
38
+ * Returns current RequestContext (if available).
39
+ */
40
+ static currentRequestContext() {
41
+ return this.storage.getStore();
42
+ }
43
+ /**
44
+ * Returns current EntityManager (if available).
45
+ */
46
+ static getEntityManager(name = 'default') {
47
+ const context = RequestContext.currentRequestContext();
48
+ return context ? context.map.get(name) : undefined;
49
+ }
50
+ static createContext(em, options = {}) {
51
+ const forks = new Map();
52
+ if (Array.isArray(em)) {
53
+ em.forEach(em => forks.set(em.name, em.fork({ useContext: true, ...options })));
54
+ }
55
+ else {
56
+ forks.set(em.name, em.fork({ useContext: true, ...options }));
57
+ }
58
+ return new RequestContext(forks);
56
59
  }
57
- return new RequestContext(forks);
58
- }
59
60
  }
@@ -1,20 +1,20 @@
1
1
  import type { EntityManager } from '../EntityManager.js';
2
2
  /** Uses `AsyncLocalStorage` to maintain a transaction-scoped EntityManager context across async operations. */
3
3
  export declare class TransactionContext {
4
- readonly em: EntityManager;
5
- private static storage;
6
- readonly id: number;
7
- constructor(em: EntityManager);
8
- /**
9
- * Creates new TransactionContext instance and runs the code inside its domain.
10
- */
11
- static create<T>(em: EntityManager, next: (...args: any[]) => T): T;
12
- /**
13
- * Returns current TransactionContext (if available).
14
- */
15
- static currentTransactionContext(): TransactionContext | undefined;
16
- /**
17
- * Returns current EntityManager (if available).
18
- */
19
- static getEntityManager(name?: string): EntityManager | undefined;
4
+ readonly em: EntityManager;
5
+ private static storage;
6
+ readonly id: number;
7
+ constructor(em: EntityManager);
8
+ /**
9
+ * Creates new TransactionContext instance and runs the code inside its domain.
10
+ */
11
+ static create<T>(em: EntityManager, next: (...args: any[]) => T): T;
12
+ /**
13
+ * Returns current TransactionContext (if available).
14
+ */
15
+ static currentTransactionContext(): TransactionContext | undefined;
16
+ /**
17
+ * Returns current EntityManager (if available).
18
+ */
19
+ static getEntityManager(name?: string): EntityManager | undefined;
20
20
  }