@mikro-orm/core 7.0.2-dev.8 → 7.0.2

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 (207) hide show
  1. package/EntityManager.d.ts +883 -579
  2. package/EntityManager.js +1897 -1865
  3. package/MikroORM.d.ts +103 -72
  4. package/MikroORM.js +178 -177
  5. package/README.md +128 -294
  6. package/cache/CacheAdapter.d.ts +38 -36
  7. package/cache/FileCacheAdapter.d.ts +30 -24
  8. package/cache/FileCacheAdapter.js +80 -78
  9. package/cache/GeneratedCacheAdapter.d.ts +19 -20
  10. package/cache/GeneratedCacheAdapter.js +31 -30
  11. package/cache/MemoryCacheAdapter.d.ts +19 -20
  12. package/cache/MemoryCacheAdapter.js +36 -36
  13. package/cache/NullCacheAdapter.d.ts +17 -16
  14. package/cache/NullCacheAdapter.js +25 -24
  15. package/connections/Connection.d.ts +99 -75
  16. package/connections/Connection.js +166 -160
  17. package/drivers/DatabaseDriver.d.ts +187 -69
  18. package/drivers/DatabaseDriver.js +451 -432
  19. package/drivers/IDatabaseDriver.d.ts +464 -281
  20. package/drivers/IDatabaseDriver.js +1 -0
  21. package/entity/BaseEntity.d.ts +121 -73
  22. package/entity/BaseEntity.js +44 -33
  23. package/entity/Collection.d.ts +216 -157
  24. package/entity/Collection.js +728 -707
  25. package/entity/EntityAssigner.d.ts +90 -76
  26. package/entity/EntityAssigner.js +232 -229
  27. package/entity/EntityFactory.d.ts +68 -40
  28. package/entity/EntityFactory.js +427 -366
  29. package/entity/EntityHelper.d.ts +34 -22
  30. package/entity/EntityHelper.js +280 -267
  31. package/entity/EntityIdentifier.d.ts +4 -4
  32. package/entity/EntityIdentifier.js +10 -10
  33. package/entity/EntityLoader.d.ts +105 -56
  34. package/entity/EntityLoader.js +754 -722
  35. package/entity/EntityRepository.d.ts +317 -200
  36. package/entity/EntityRepository.js +214 -212
  37. package/entity/PolymorphicRef.d.ts +5 -5
  38. package/entity/PolymorphicRef.js +10 -10
  39. package/entity/Reference.d.ts +130 -66
  40. package/entity/Reference.js +280 -260
  41. package/entity/WrappedEntity.d.ts +116 -53
  42. package/entity/WrappedEntity.js +169 -147
  43. package/entity/defineEntity.d.ts +1290 -614
  44. package/entity/defineEntity.js +521 -511
  45. package/entity/utils.d.ts +13 -3
  46. package/entity/utils.js +71 -73
  47. package/entity/validators.js +43 -43
  48. package/entity/wrap.js +8 -8
  49. package/enums.d.ts +275 -138
  50. package/enums.js +268 -137
  51. package/errors.d.ts +120 -72
  52. package/errors.js +356 -253
  53. package/events/EventManager.d.ts +27 -10
  54. package/events/EventManager.js +80 -73
  55. package/events/EventSubscriber.d.ts +33 -29
  56. package/events/TransactionEventBroadcaster.d.ts +16 -7
  57. package/events/TransactionEventBroadcaster.js +15 -13
  58. package/exceptions.d.ts +23 -40
  59. package/exceptions.js +35 -52
  60. package/hydration/Hydrator.d.ts +43 -16
  61. package/hydration/Hydrator.js +44 -42
  62. package/hydration/ObjectHydrator.d.ts +51 -17
  63. package/hydration/ObjectHydrator.js +480 -416
  64. package/index.d.ts +116 -2
  65. package/index.js +10 -1
  66. package/logging/DefaultLogger.d.ts +35 -30
  67. package/logging/DefaultLogger.js +87 -84
  68. package/logging/Logger.d.ts +45 -40
  69. package/logging/SimpleLogger.d.ts +13 -11
  70. package/logging/SimpleLogger.js +22 -22
  71. package/logging/colors.d.ts +6 -6
  72. package/logging/colors.js +11 -10
  73. package/logging/inspect.js +7 -7
  74. package/metadata/EntitySchema.d.ts +214 -108
  75. package/metadata/EntitySchema.js +398 -379
  76. package/metadata/MetadataDiscovery.d.ts +115 -111
  77. package/metadata/MetadataDiscovery.js +1948 -1857
  78. package/metadata/MetadataProvider.d.ts +25 -14
  79. package/metadata/MetadataProvider.js +83 -77
  80. package/metadata/MetadataStorage.d.ts +39 -19
  81. package/metadata/MetadataStorage.js +119 -106
  82. package/metadata/MetadataValidator.d.ts +39 -39
  83. package/metadata/MetadataValidator.js +381 -338
  84. package/metadata/discover-entities.d.ts +5 -2
  85. package/metadata/discover-entities.js +27 -27
  86. package/metadata/types.d.ts +615 -531
  87. package/naming-strategy/AbstractNamingStrategy.d.ts +55 -39
  88. package/naming-strategy/AbstractNamingStrategy.js +91 -85
  89. package/naming-strategy/EntityCaseNamingStrategy.d.ts +6 -6
  90. package/naming-strategy/EntityCaseNamingStrategy.js +22 -22
  91. package/naming-strategy/MongoNamingStrategy.d.ts +7 -6
  92. package/naming-strategy/MongoNamingStrategy.js +19 -18
  93. package/naming-strategy/NamingStrategy.d.ts +109 -99
  94. package/naming-strategy/UnderscoreNamingStrategy.d.ts +8 -7
  95. package/naming-strategy/UnderscoreNamingStrategy.js +22 -21
  96. package/not-supported.js +7 -4
  97. package/package.json +1 -1
  98. package/platforms/ExceptionConverter.d.ts +2 -1
  99. package/platforms/ExceptionConverter.js +5 -4
  100. package/platforms/Platform.d.ts +310 -236
  101. package/platforms/Platform.js +661 -573
  102. package/serialization/EntitySerializer.d.ts +49 -25
  103. package/serialization/EntitySerializer.js +224 -216
  104. package/serialization/EntityTransformer.d.ts +11 -5
  105. package/serialization/EntityTransformer.js +220 -216
  106. package/serialization/SerializationContext.d.ts +27 -18
  107. package/serialization/SerializationContext.js +105 -100
  108. package/types/ArrayType.d.ts +9 -8
  109. package/types/ArrayType.js +34 -33
  110. package/types/BigIntType.d.ts +17 -10
  111. package/types/BigIntType.js +37 -37
  112. package/types/BlobType.d.ts +4 -3
  113. package/types/BlobType.js +14 -13
  114. package/types/BooleanType.d.ts +5 -4
  115. package/types/BooleanType.js +13 -12
  116. package/types/CharacterType.d.ts +3 -2
  117. package/types/CharacterType.js +7 -6
  118. package/types/DateTimeType.d.ts +6 -5
  119. package/types/DateTimeType.js +16 -15
  120. package/types/DateType.d.ts +6 -5
  121. package/types/DateType.js +16 -15
  122. package/types/DecimalType.d.ts +7 -7
  123. package/types/DecimalType.js +26 -26
  124. package/types/DoubleType.d.ts +3 -3
  125. package/types/DoubleType.js +12 -12
  126. package/types/EnumArrayType.d.ts +6 -5
  127. package/types/EnumArrayType.js +25 -24
  128. package/types/EnumType.d.ts +4 -3
  129. package/types/EnumType.js +12 -11
  130. package/types/FloatType.d.ts +4 -3
  131. package/types/FloatType.js +10 -9
  132. package/types/IntegerType.d.ts +4 -3
  133. package/types/IntegerType.js +10 -9
  134. package/types/IntervalType.d.ts +5 -4
  135. package/types/IntervalType.js +13 -12
  136. package/types/JsonType.d.ts +9 -8
  137. package/types/JsonType.js +33 -32
  138. package/types/MediumIntType.d.ts +2 -1
  139. package/types/MediumIntType.js +4 -3
  140. package/types/SmallIntType.d.ts +4 -3
  141. package/types/SmallIntType.js +10 -9
  142. package/types/StringType.d.ts +5 -4
  143. package/types/StringType.js +13 -12
  144. package/types/TextType.d.ts +4 -3
  145. package/types/TextType.js +10 -9
  146. package/types/TimeType.d.ts +6 -5
  147. package/types/TimeType.js +18 -17
  148. package/types/TinyIntType.d.ts +4 -3
  149. package/types/TinyIntType.js +11 -10
  150. package/types/Type.d.ts +88 -73
  151. package/types/Type.js +85 -74
  152. package/types/Uint8ArrayType.d.ts +5 -4
  153. package/types/Uint8ArrayType.js +22 -21
  154. package/types/UnknownType.d.ts +5 -4
  155. package/types/UnknownType.js +13 -12
  156. package/types/UuidType.d.ts +6 -5
  157. package/types/UuidType.js +20 -19
  158. package/types/index.d.ts +77 -49
  159. package/types/index.js +64 -26
  160. package/typings.d.ts +1388 -729
  161. package/typings.js +255 -231
  162. package/unit-of-work/ChangeSet.d.ts +28 -24
  163. package/unit-of-work/ChangeSet.js +58 -54
  164. package/unit-of-work/ChangeSetComputer.d.ts +13 -11
  165. package/unit-of-work/ChangeSetComputer.js +180 -159
  166. package/unit-of-work/ChangeSetPersister.d.ts +64 -41
  167. package/unit-of-work/ChangeSetPersister.js +443 -418
  168. package/unit-of-work/CommitOrderCalculator.d.ts +40 -40
  169. package/unit-of-work/CommitOrderCalculator.js +89 -88
  170. package/unit-of-work/IdentityMap.d.ts +32 -25
  171. package/unit-of-work/IdentityMap.js +106 -99
  172. package/unit-of-work/UnitOfWork.d.ts +182 -127
  173. package/unit-of-work/UnitOfWork.js +1201 -1169
  174. package/utils/AbstractMigrator.d.ts +111 -91
  175. package/utils/AbstractMigrator.js +275 -275
  176. package/utils/AbstractSchemaGenerator.d.ts +43 -34
  177. package/utils/AbstractSchemaGenerator.js +121 -122
  178. package/utils/AsyncContext.d.ts +3 -3
  179. package/utils/AsyncContext.js +34 -35
  180. package/utils/Configuration.d.ts +853 -801
  181. package/utils/Configuration.js +360 -337
  182. package/utils/Cursor.d.ts +40 -22
  183. package/utils/Cursor.js +135 -127
  184. package/utils/DataloaderUtils.d.ts +58 -43
  185. package/utils/DataloaderUtils.js +203 -198
  186. package/utils/EntityComparator.d.ts +99 -80
  187. package/utils/EntityComparator.js +825 -727
  188. package/utils/NullHighlighter.d.ts +2 -1
  189. package/utils/NullHighlighter.js +4 -3
  190. package/utils/QueryHelper.d.ts +79 -51
  191. package/utils/QueryHelper.js +372 -361
  192. package/utils/RawQueryFragment.d.ts +54 -28
  193. package/utils/RawQueryFragment.js +110 -99
  194. package/utils/RequestContext.d.ts +33 -32
  195. package/utils/RequestContext.js +52 -53
  196. package/utils/TransactionContext.d.ts +17 -16
  197. package/utils/TransactionContext.js +28 -27
  198. package/utils/TransactionManager.d.ts +58 -58
  199. package/utils/TransactionManager.js +199 -197
  200. package/utils/Utils.d.ts +210 -145
  201. package/utils/Utils.js +820 -813
  202. package/utils/clone.js +104 -113
  203. package/utils/env-vars.js +90 -88
  204. package/utils/fs-utils.d.ts +15 -15
  205. package/utils/fs-utils.js +180 -181
  206. package/utils/upsert-utils.d.ts +20 -5
  207. package/utils/upsert-utils.js +114 -116
@@ -1,32 +1,41 @@
1
1
  import type { AnyString, Dictionary, EntityKey } from '../typings.js';
2
2
  declare const rawFragmentSymbolBrand: unique symbol;
3
+ /** Branded symbol type used as a unique key for tracking raw SQL fragments in object properties. */
3
4
  export type RawQueryFragmentSymbol = symbol & {
4
- readonly [rawFragmentSymbolBrand]: true;
5
+ readonly [rawFragmentSymbolBrand]: true;
5
6
  };
7
+ /** Represents a raw SQL fragment with optional parameters, usable as both a value and an object key via Symbol coercion. */
6
8
  export declare class RawQueryFragment<Alias extends string = string> {
7
- #private;
8
- readonly sql: string;
9
- readonly params: unknown[];
10
- /** @internal Type-level only - used to track the alias for type inference */
11
- private readonly __alias?;
12
- constructor(sql: string, params?: unknown[]);
13
- get key(): RawQueryFragmentSymbol;
14
- as<A extends string>(alias: A): RawQueryFragment<A>;
15
- [Symbol.toPrimitive](hint: 'string'): RawQueryFragmentSymbol;
16
- get [Symbol.toStringTag](): string;
17
- toJSON(): string;
18
- clone(): this;
19
- static isKnownFragmentSymbol(key: unknown): key is RawQueryFragmentSymbol;
20
- static hasObjectFragments(object: unknown): boolean;
21
- static isKnownFragment(key: unknown): key is RawQueryFragment | symbol;
22
- static getKnownFragment(key: unknown): RawQueryFragment | undefined;
9
+ #private;
10
+ readonly sql: string;
11
+ readonly params: unknown[];
12
+ /** @internal Type-level only - used to track the alias for type inference */
13
+ private readonly __alias?;
14
+ constructor(sql: string, params?: unknown[]);
15
+ /** Returns a unique symbol key for this fragment, creating and caching it on first access. */
16
+ get key(): RawQueryFragmentSymbol;
17
+ /** Creates a new fragment with an alias appended via `as ??`. */
18
+ as<A extends string>(alias: A): RawQueryFragment<A>;
19
+ [Symbol.toPrimitive](hint: 'string'): RawQueryFragmentSymbol;
20
+ get [Symbol.toStringTag](): string;
21
+ toJSON(): string;
22
+ clone(): this;
23
+ /** Checks whether the given value is a symbol that maps to a known raw query fragment. */
24
+ static isKnownFragmentSymbol(key: unknown): key is RawQueryFragmentSymbol;
25
+ /** Checks whether an object has any symbol keys that are known raw query fragments. */
26
+ static hasObjectFragments(object: unknown): boolean;
27
+ /** Checks whether the given value is a RawQueryFragment instance or a known fragment symbol. */
28
+ static isKnownFragment(key: unknown): key is RawQueryFragment | symbol;
29
+ /** Retrieves the RawQueryFragment associated with the given key (instance or symbol). */
30
+ static getKnownFragment(key: unknown): RawQueryFragment | undefined;
23
31
  }
24
32
  export { RawQueryFragment as Raw };
33
+ /** Checks whether the given value is a `RawQueryFragment` instance. */
25
34
  export declare function isRaw(value: unknown): value is RawQueryFragment;
26
35
  /** @internal */
27
- export declare const ALIAS_REPLACEMENT = "[::alias::]";
36
+ export declare const ALIAS_REPLACEMENT = '[::alias::]';
28
37
  /** @internal */
29
- export declare const ALIAS_REPLACEMENT_RE = "\\[::alias::\\]";
38
+ export declare const ALIAS_REPLACEMENT_RE = '\\[::alias::\\]';
30
39
  /**
31
40
  * Creates raw SQL query fragment that can be assigned to a property or part of a filter. This fragment is represented
32
41
  * by `RawQueryFragment` class instance that can be serialized to a string, so it can be used both as an object value
@@ -82,7 +91,10 @@ export declare const ALIAS_REPLACEMENT_RE = "\\[::alias::\\]";
82
91
  * export class Author { ... }
83
92
  * ```
84
93
  */
85
- 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;
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;
86
98
  /**
87
99
  * Alternative to the `raw()` helper allowing to use it as a tagged template function for the simple cases.
88
100
  *
@@ -102,12 +114,20 @@ export declare function raw<R = RawQueryFragment & symbol, T extends object = an
102
114
  */
103
115
  export declare function sql<R = RawQueryFragment & symbol>(sql: readonly string[], ...values: unknown[]): R;
104
116
  export declare namespace sql {
105
- var ref: <T extends object = any>(...keys: string[]) => RawQueryFragment & symbol;
106
- var now: (length?: number) => RawQueryFragment & symbol;
107
- var lower: <R = RawQueryFragment<string> & symbol, T extends object = any>(key: string | ((alias: string) => string)) => R;
108
- var upper: <R = RawQueryFragment<string> & symbol, T extends object = any>(key: string | ((alias: string) => string)) => R;
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;
109
125
  }
110
- export declare function createSqlFunction<R = RawQueryFragment & symbol, T extends object = any>(func: string, key: string | ((alias: string) => string)): R;
126
+ /** 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;
111
131
  /**
112
132
  * Tag function providing quoting of db identifiers (table name, columns names, index names, ...).
113
133
  *
@@ -121,6 +141,12 @@ export declare function createSqlFunction<R = RawQueryFragment & symbol, T exten
121
141
  * export class Author { ... }
122
142
  * ```
123
143
  */
124
- export declare function quote(expParts: readonly string[], ...values: (string | {
125
- toString(): string;
126
- })[]): RawQueryFragment & symbol;
144
+ export declare function quote(
145
+ expParts: readonly string[],
146
+ ...values: (
147
+ | string
148
+ | {
149
+ toString(): string;
150
+ }
151
+ )[]
152
+ ): RawQueryFragment & symbol;
@@ -1,77 +1,87 @@
1
1
  import { Utils } from './Utils.js';
2
+ /** Represents a raw SQL fragment with optional parameters, usable as both a value and an object key via Symbol coercion. */
2
3
  export class RawQueryFragment {
3
- sql;
4
- params;
5
- static #rawQueryReferences = new WeakMap();
6
- #key;
7
- constructor(sql, params = []) {
8
- this.sql = sql;
9
- this.params = params;
10
- }
11
- get key() {
12
- if (!this.#key) {
13
- this.#key = Symbol(this.toJSON());
14
- RawQueryFragment.#rawQueryReferences.set(this.#key, this);
15
- }
16
- return this.#key;
17
- }
18
- as(alias) {
19
- return new RawQueryFragment(`${this.sql} as ??`, [...this.params, alias]);
20
- }
21
- [Symbol.toPrimitive](hint) {
22
- // if a fragment is converted to string (used as an object key), return a unique symbol
23
- // and save a weak reference to map so we can retrieve it when compiling the query
24
- if (hint === 'string') {
25
- return this.key;
26
- }
27
- throw new Error(`Trying to modify raw SQL fragment: '${this.sql}'`);
28
- }
29
- get [Symbol.toStringTag]() {
30
- return this.toJSON();
31
- }
32
- toJSON() {
33
- return `raw('${this.sql}')`;
34
- }
35
- clone() {
36
- return this;
37
- }
38
- static isKnownFragmentSymbol(key) {
39
- return typeof key === 'symbol' && this.#rawQueryReferences.has(key);
40
- }
41
- static hasObjectFragments(object) {
42
- return (Utils.isPlainObject(object) &&
43
- Object.getOwnPropertySymbols(object).some(symbol => this.isKnownFragmentSymbol(symbol)));
44
- }
45
- static isKnownFragment(key) {
46
- if (key instanceof RawQueryFragment) {
47
- return true;
48
- }
49
- return this.isKnownFragmentSymbol(key);
50
- }
51
- static getKnownFragment(key) {
52
- if (key instanceof RawQueryFragment) {
53
- return key;
54
- }
55
- if (typeof key !== 'symbol') {
56
- return;
57
- }
58
- return this.#rawQueryReferences.get(key);
59
- }
60
- /** @ignore */
61
- /* v8 ignore next */
62
- [Symbol.for('nodejs.util.inspect.custom')]() {
63
- if (this.params) {
64
- return { sql: this.sql, params: this.params };
65
- }
66
- return { sql: this.sql };
67
- }
4
+ sql;
5
+ params;
6
+ static #rawQueryReferences = new WeakMap();
7
+ #key;
8
+ constructor(sql, params = []) {
9
+ this.sql = sql;
10
+ this.params = params;
11
+ }
12
+ /** Returns a unique symbol key for this fragment, creating and caching it on first access. */
13
+ get key() {
14
+ if (!this.#key) {
15
+ this.#key = Symbol(this.toJSON());
16
+ RawQueryFragment.#rawQueryReferences.set(this.#key, this);
17
+ }
18
+ return this.#key;
19
+ }
20
+ /** Creates a new fragment with an alias appended via `as ??`. */
21
+ as(alias) {
22
+ return new RawQueryFragment(`${this.sql} as ??`, [...this.params, alias]);
23
+ }
24
+ [Symbol.toPrimitive](hint) {
25
+ // if a fragment is converted to string (used as an object key), return a unique symbol
26
+ // and save a weak reference to map so we can retrieve it when compiling the query
27
+ if (hint === 'string') {
28
+ return this.key;
29
+ }
30
+ throw new Error(`Trying to modify raw SQL fragment: '${this.sql}'`);
31
+ }
32
+ get [Symbol.toStringTag]() {
33
+ return this.toJSON();
34
+ }
35
+ toJSON() {
36
+ return `raw('${this.sql}')`;
37
+ }
38
+ clone() {
39
+ return this;
40
+ }
41
+ /** Checks whether the given value is a symbol that maps to a known raw query fragment. */
42
+ static isKnownFragmentSymbol(key) {
43
+ return typeof key === 'symbol' && this.#rawQueryReferences.has(key);
44
+ }
45
+ /** Checks whether an object has any symbol keys that are known raw query fragments. */
46
+ static hasObjectFragments(object) {
47
+ return (
48
+ Utils.isPlainObject(object) &&
49
+ Object.getOwnPropertySymbols(object).some(symbol => this.isKnownFragmentSymbol(symbol))
50
+ );
51
+ }
52
+ /** Checks whether the given value is a RawQueryFragment instance or a known fragment symbol. */
53
+ static isKnownFragment(key) {
54
+ if (key instanceof RawQueryFragment) {
55
+ return true;
56
+ }
57
+ return this.isKnownFragmentSymbol(key);
58
+ }
59
+ /** Retrieves the RawQueryFragment associated with the given key (instance or symbol). */
60
+ static getKnownFragment(key) {
61
+ if (key instanceof RawQueryFragment) {
62
+ return key;
63
+ }
64
+ if (typeof key !== 'symbol') {
65
+ return;
66
+ }
67
+ return this.#rawQueryReferences.get(key);
68
+ }
69
+ /** @ignore */
70
+ /* v8 ignore next */
71
+ [Symbol.for('nodejs.util.inspect.custom')]() {
72
+ if (this.params) {
73
+ return { sql: this.sql, params: this.params };
74
+ }
75
+ return { sql: this.sql };
76
+ }
68
77
  }
69
78
  export { RawQueryFragment as Raw };
70
79
  Object.defineProperties(RawQueryFragment.prototype, {
71
- __raw: { value: true, enumerable: false },
80
+ __raw: { value: true, enumerable: false },
72
81
  });
82
+ /** Checks whether the given value is a `RawQueryFragment` instance. */
73
83
  export function isRaw(value) {
74
- return typeof value === 'object' && value !== null && '__raw' in value;
84
+ return typeof value === 'object' && value !== null && '__raw' in value;
75
85
  }
76
86
  /** @internal */
77
87
  export const ALIAS_REPLACEMENT = '[::alias::]';
@@ -133,30 +143,30 @@ export const ALIAS_REPLACEMENT_RE = '\\[::alias::\\]';
133
143
  * ```
134
144
  */
135
145
  export function raw(sql, params) {
136
- if (sql instanceof RawQueryFragment) {
137
- return sql;
138
- }
139
- if (sql instanceof Function) {
140
- sql = sql(ALIAS_REPLACEMENT);
141
- }
142
- if (sql === '??' && Array.isArray(params)) {
143
- return new RawQueryFragment(sql, params);
144
- }
145
- if (Array.isArray(sql)) {
146
- // for composite FK we return just a simple string
147
- return Utils.getPrimaryKeyHash(sql);
148
- }
149
- if (typeof params === 'object' && !Array.isArray(params)) {
150
- const pairs = Object.entries(params);
151
- const objectParams = [];
152
- for (const [key, value] of pairs) {
153
- sql = sql.replace(`:${key}:`, '??');
154
- sql = sql.replace(`:${key}`, '?');
155
- objectParams.push(value);
156
- }
157
- return new RawQueryFragment(sql, objectParams);
158
- }
146
+ if (sql instanceof RawQueryFragment) {
147
+ return sql;
148
+ }
149
+ if (sql instanceof Function) {
150
+ sql = sql(ALIAS_REPLACEMENT);
151
+ }
152
+ if (sql === '??' && Array.isArray(params)) {
159
153
  return new RawQueryFragment(sql, params);
154
+ }
155
+ if (Array.isArray(sql)) {
156
+ // for composite FK we return just a simple string
157
+ return Utils.getPrimaryKeyHash(sql);
158
+ }
159
+ if (typeof params === 'object' && !Array.isArray(params)) {
160
+ const pairs = Object.entries(params);
161
+ const objectParams = [];
162
+ for (const [key, value] of pairs) {
163
+ sql = sql.replace(`:${key}:`, '??');
164
+ sql = sql.replace(`:${key}`, '?');
165
+ objectParams.push(value);
166
+ }
167
+ return new RawQueryFragment(sql, objectParams);
168
+ }
169
+ return new RawQueryFragment(sql, params);
160
170
  }
161
171
  /**
162
172
  * Alternative to the `raw()` helper allowing to use it as a tagged template function for the simple cases.
@@ -176,18 +186,19 @@ export function raw(sql, params) {
176
186
  * ```
177
187
  */
178
188
  export function sql(sql, ...values) {
179
- return raw(sql.join('?'), values);
189
+ return raw(sql.join('?'), values);
180
190
  }
191
+ /** Creates a raw SQL function expression wrapping the given key (e.g., `lower(name)`). */
181
192
  export function createSqlFunction(func, key) {
182
- if (typeof key === 'string') {
183
- return raw(`${func}(${key})`);
184
- }
185
- return raw(a => `${func}(${key(a)})`);
193
+ if (typeof key === 'string') {
194
+ return raw(`${func}(${key})`);
195
+ }
196
+ return raw(a => `${func}(${key(a)})`);
186
197
  }
187
198
  sql.ref = (...keys) => raw('??', [keys.join('.')]);
188
- sql.now = (length) => raw('current_timestamp' + (length == null ? '' : `(${length})`));
189
- sql.lower = (key) => createSqlFunction('lower', key);
190
- sql.upper = (key) => createSqlFunction('upper', key);
199
+ sql.now = length => raw('current_timestamp' + (length == null ? '' : `(${length})`));
200
+ sql.lower = key => createSqlFunction('lower', key);
201
+ sql.upper = key => createSqlFunction('upper', key);
191
202
  /**
192
203
  * Tag function providing quoting of db identifiers (table name, columns names, index names, ...).
193
204
  *
@@ -202,5 +213,5 @@ sql.upper = (key) => createSqlFunction('upper', key);
202
213
  * ```
203
214
  */
204
215
  export function quote(expParts, ...values) {
205
- return raw(expParts.join('??'), values);
216
+ return raw(expParts.join('??'), values);
206
217
  }
@@ -4,38 +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
+ /** Options for creating a new RequestContext, allowing schema and logger overrides. */
38
39
  export interface CreateContextOptions {
39
- schema?: string;
40
- loggerContext?: LoggingOptions;
40
+ schema?: string;
41
+ loggerContext?: LoggingOptions;
41
42
  }
@@ -3,58 +3,57 @@ 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
- }
55
- else {
56
- forks.set(em.name, em.fork({ useContext: true, ...options }));
57
- }
58
- return new RequestContext(forks);
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 }));
59
56
  }
57
+ return new RequestContext(forks);
58
+ }
60
59
  }
@@ -1,19 +1,20 @@
1
1
  import type { EntityManager } from '../EntityManager.js';
2
+ /** Uses `AsyncLocalStorage` to maintain a transaction-scoped EntityManager context across async operations. */
2
3
  export declare class TransactionContext {
3
- readonly em: EntityManager;
4
- private static storage;
5
- readonly id: number;
6
- constructor(em: EntityManager);
7
- /**
8
- * Creates new TransactionContext instance and runs the code inside its domain.
9
- */
10
- static create<T>(em: EntityManager, next: (...args: any[]) => T): T;
11
- /**
12
- * Returns current TransactionContext (if available).
13
- */
14
- static currentTransactionContext(): TransactionContext | undefined;
15
- /**
16
- * Returns current EntityManager (if available).
17
- */
18
- 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;
19
20
  }
@@ -1,30 +1,31 @@
1
1
  import { createAsyncContext } from './AsyncContext.js';
2
+ /** Uses `AsyncLocalStorage` to maintain a transaction-scoped EntityManager context across async operations. */
2
3
  export class TransactionContext {
3
- em;
4
- static storage = createAsyncContext();
5
- id;
6
- constructor(em) {
7
- this.em = em;
8
- this.id = this.em._id;
9
- }
10
- /**
11
- * Creates new TransactionContext instance and runs the code inside its domain.
12
- */
13
- static create(em, next) {
14
- const context = new TransactionContext(em);
15
- return this.storage.run(context, next);
16
- }
17
- /**
18
- * Returns current TransactionContext (if available).
19
- */
20
- static currentTransactionContext() {
21
- return this.storage.getStore();
22
- }
23
- /**
24
- * Returns current EntityManager (if available).
25
- */
26
- static getEntityManager(name = 'default') {
27
- const context = TransactionContext.currentTransactionContext();
28
- return context?.em.name === name ? context.em : undefined;
29
- }
4
+ em;
5
+ static storage = createAsyncContext();
6
+ id;
7
+ constructor(em) {
8
+ this.em = em;
9
+ this.id = this.em._id;
10
+ }
11
+ /**
12
+ * Creates new TransactionContext instance and runs the code inside its domain.
13
+ */
14
+ static create(em, next) {
15
+ const context = new TransactionContext(em);
16
+ return this.storage.run(context, next);
17
+ }
18
+ /**
19
+ * Returns current TransactionContext (if available).
20
+ */
21
+ static currentTransactionContext() {
22
+ return this.storage.getStore();
23
+ }
24
+ /**
25
+ * Returns current EntityManager (if available).
26
+ */
27
+ static getEntityManager(name = 'default') {
28
+ const context = TransactionContext.currentTransactionContext();
29
+ return context?.em.name === name ? context.em : undefined;
30
+ }
30
31
  }