@mikro-orm/core 7.0.10-dev.9 → 7.0.10
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.
- package/EntityManager.d.ts +885 -583
- package/EntityManager.js +1927 -1899
- package/MikroORM.d.ts +103 -74
- package/MikroORM.js +177 -178
- package/README.md +1 -1
- package/cache/CacheAdapter.d.ts +36 -36
- package/cache/FileCacheAdapter.d.ts +30 -24
- package/cache/FileCacheAdapter.js +80 -78
- package/cache/GeneratedCacheAdapter.d.ts +18 -20
- package/cache/GeneratedCacheAdapter.js +30 -30
- package/cache/MemoryCacheAdapter.d.ts +18 -20
- package/cache/MemoryCacheAdapter.js +35 -36
- package/cache/NullCacheAdapter.d.ts +16 -16
- package/cache/NullCacheAdapter.js +24 -24
- package/connections/Connection.d.ts +95 -84
- package/connections/Connection.js +165 -168
- package/drivers/DatabaseDriver.d.ts +186 -80
- package/drivers/DatabaseDriver.js +450 -443
- package/drivers/IDatabaseDriver.d.ts +440 -301
- package/entity/BaseEntity.d.ts +120 -83
- package/entity/BaseEntity.js +43 -43
- package/entity/Collection.d.ts +215 -181
- package/entity/Collection.js +733 -725
- package/entity/EntityAssigner.d.ts +88 -77
- package/entity/EntityAssigner.js +231 -230
- package/entity/EntityFactory.d.ts +67 -55
- package/entity/EntityFactory.js +457 -416
- package/entity/EntityHelper.d.ts +35 -23
- package/entity/EntityHelper.js +302 -290
- package/entity/EntityIdentifier.d.ts +4 -4
- package/entity/EntityIdentifier.js +10 -10
- package/entity/EntityLoader.d.ts +98 -72
- package/entity/EntityLoader.js +805 -760
- package/entity/EntityRepository.d.ts +316 -201
- package/entity/EntityRepository.js +213 -213
- package/entity/PolymorphicRef.d.ts +5 -5
- package/entity/PolymorphicRef.js +10 -10
- package/entity/Reference.d.ts +127 -83
- package/entity/Reference.js +285 -279
- package/entity/WrappedEntity.d.ts +115 -72
- package/entity/WrappedEntity.js +168 -166
- package/entity/defineEntity.d.ts +1359 -654
- package/entity/defineEntity.js +527 -518
- package/entity/utils.d.ts +13 -3
- package/entity/utils.js +71 -73
- package/entity/validators.js +43 -43
- package/entity/wrap.js +8 -8
- package/enums.d.ts +258 -253
- package/enums.js +251 -252
- package/errors.d.ts +114 -72
- package/errors.js +350 -253
- package/events/EventManager.d.ts +26 -14
- package/events/EventManager.js +79 -77
- package/events/EventSubscriber.d.ts +29 -29
- package/events/TransactionEventBroadcaster.d.ts +15 -8
- package/events/TransactionEventBroadcaster.js +14 -14
- package/exceptions.d.ts +23 -40
- package/exceptions.js +35 -52
- package/hydration/Hydrator.d.ts +42 -17
- package/hydration/Hydrator.js +43 -43
- package/hydration/ObjectHydrator.d.ts +50 -17
- package/hydration/ObjectHydrator.js +483 -418
- package/index.d.ts +116 -2
- package/index.js +10 -1
- package/logging/DefaultLogger.d.ts +34 -32
- package/logging/DefaultLogger.js +86 -86
- package/logging/Logger.d.ts +41 -41
- package/logging/SimpleLogger.d.ts +13 -11
- package/logging/SimpleLogger.js +22 -22
- package/logging/colors.d.ts +6 -6
- package/logging/colors.js +11 -10
- package/logging/inspect.js +7 -7
- package/metadata/EntitySchema.d.ts +214 -130
- package/metadata/EntitySchema.js +411 -412
- package/metadata/MetadataDiscovery.d.ts +114 -114
- package/metadata/MetadataDiscovery.js +1962 -1879
- package/metadata/MetadataProvider.d.ts +29 -26
- package/metadata/MetadataProvider.js +95 -97
- package/metadata/MetadataStorage.d.ts +38 -32
- package/metadata/MetadataStorage.js +118 -118
- package/metadata/MetadataValidator.d.ts +39 -39
- package/metadata/MetadataValidator.js +381 -338
- package/metadata/discover-entities.d.ts +5 -2
- package/metadata/discover-entities.js +35 -37
- package/metadata/types.d.ts +615 -531
- package/naming-strategy/AbstractNamingStrategy.d.ts +54 -39
- package/naming-strategy/AbstractNamingStrategy.js +90 -85
- package/naming-strategy/EntityCaseNamingStrategy.d.ts +6 -6
- package/naming-strategy/EntityCaseNamingStrategy.js +22 -22
- package/naming-strategy/MongoNamingStrategy.d.ts +6 -6
- package/naming-strategy/MongoNamingStrategy.js +18 -18
- package/naming-strategy/NamingStrategy.d.ts +109 -99
- package/naming-strategy/UnderscoreNamingStrategy.d.ts +7 -7
- package/naming-strategy/UnderscoreNamingStrategy.js +21 -21
- package/not-supported.js +7 -4
- package/package.json +1 -1
- package/platforms/ExceptionConverter.d.ts +1 -1
- package/platforms/ExceptionConverter.js +4 -4
- package/platforms/Platform.d.ts +312 -303
- package/platforms/Platform.js +695 -675
- package/serialization/EntitySerializer.d.ts +49 -26
- package/serialization/EntitySerializer.js +224 -218
- package/serialization/EntityTransformer.d.ts +10 -6
- package/serialization/EntityTransformer.js +219 -217
- package/serialization/SerializationContext.d.ts +27 -23
- package/serialization/SerializationContext.js +105 -105
- package/types/ArrayType.d.ts +8 -8
- package/types/ArrayType.js +33 -33
- package/types/BigIntType.d.ts +17 -10
- package/types/BigIntType.js +37 -37
- package/types/BlobType.d.ts +3 -3
- package/types/BlobType.js +13 -13
- package/types/BooleanType.d.ts +4 -4
- package/types/BooleanType.js +12 -12
- package/types/CharacterType.d.ts +2 -2
- package/types/CharacterType.js +6 -6
- package/types/DateTimeType.d.ts +5 -5
- package/types/DateTimeType.js +15 -15
- package/types/DateType.d.ts +5 -5
- package/types/DateType.js +15 -15
- package/types/DecimalType.d.ts +7 -7
- package/types/DecimalType.js +26 -26
- package/types/DoubleType.d.ts +3 -3
- package/types/DoubleType.js +12 -12
- package/types/EnumArrayType.d.ts +5 -5
- package/types/EnumArrayType.js +24 -24
- package/types/EnumType.d.ts +3 -3
- package/types/EnumType.js +11 -11
- package/types/FloatType.d.ts +3 -3
- package/types/FloatType.js +9 -9
- package/types/IntegerType.d.ts +3 -3
- package/types/IntegerType.js +9 -9
- package/types/IntervalType.d.ts +4 -4
- package/types/IntervalType.js +12 -12
- package/types/JsonType.d.ts +8 -8
- package/types/JsonType.js +32 -32
- package/types/MediumIntType.d.ts +1 -1
- package/types/MediumIntType.js +3 -3
- package/types/SmallIntType.d.ts +3 -3
- package/types/SmallIntType.js +9 -9
- package/types/StringType.d.ts +4 -4
- package/types/StringType.js +12 -12
- package/types/TextType.d.ts +3 -3
- package/types/TextType.js +9 -9
- package/types/TimeType.d.ts +5 -5
- package/types/TimeType.js +17 -17
- package/types/TinyIntType.d.ts +3 -3
- package/types/TinyIntType.js +10 -10
- package/types/Type.d.ts +83 -79
- package/types/Type.js +82 -82
- package/types/Uint8ArrayType.d.ts +4 -4
- package/types/Uint8ArrayType.js +21 -21
- package/types/UnknownType.d.ts +4 -4
- package/types/UnknownType.js +12 -12
- package/types/UuidType.d.ts +5 -5
- package/types/UuidType.js +19 -19
- package/types/index.d.ts +75 -49
- package/types/index.js +52 -26
- package/typings.d.ts +1254 -741
- package/typings.js +244 -233
- package/unit-of-work/ChangeSet.d.ts +26 -26
- package/unit-of-work/ChangeSet.js +56 -56
- package/unit-of-work/ChangeSetComputer.d.ts +12 -12
- package/unit-of-work/ChangeSetComputer.js +187 -179
- package/unit-of-work/ChangeSetPersister.d.ts +69 -50
- package/unit-of-work/ChangeSetPersister.js +465 -442
- package/unit-of-work/CommitOrderCalculator.d.ts +40 -40
- package/unit-of-work/CommitOrderCalculator.js +89 -88
- package/unit-of-work/IdentityMap.d.ts +31 -31
- package/unit-of-work/IdentityMap.js +105 -105
- package/unit-of-work/UnitOfWork.d.ts +181 -141
- package/unit-of-work/UnitOfWork.js +1237 -1223
- package/utils/AbstractMigrator.d.ts +111 -91
- package/utils/AbstractMigrator.js +275 -275
- package/utils/AbstractSchemaGenerator.d.ts +43 -34
- package/utils/AbstractSchemaGenerator.js +121 -122
- package/utils/AsyncContext.d.ts +3 -3
- package/utils/AsyncContext.js +34 -35
- package/utils/Configuration.d.ts +852 -808
- package/utils/Configuration.js +359 -344
- package/utils/Cursor.d.ts +40 -22
- package/utils/Cursor.js +135 -127
- package/utils/DataloaderUtils.d.ts +58 -43
- package/utils/DataloaderUtils.js +203 -198
- package/utils/EntityComparator.d.ts +99 -82
- package/utils/EntityComparator.js +829 -737
- package/utils/NullHighlighter.d.ts +1 -1
- package/utils/NullHighlighter.js +3 -3
- package/utils/QueryHelper.d.ts +79 -51
- package/utils/QueryHelper.js +375 -361
- package/utils/RawQueryFragment.d.ts +52 -36
- package/utils/RawQueryFragment.js +147 -109
- package/utils/RequestContext.d.ts +32 -32
- package/utils/RequestContext.js +52 -53
- package/utils/TransactionContext.d.ts +16 -16
- package/utils/TransactionContext.js +27 -27
- package/utils/TransactionManager.d.ts +58 -58
- package/utils/TransactionManager.js +202 -196
- package/utils/Utils.d.ts +204 -145
- package/utils/Utils.js +826 -817
- package/utils/clone.js +105 -114
- package/utils/env-vars.js +90 -88
- package/utils/fs-utils.d.ts +15 -15
- package/utils/fs-utils.js +181 -182
- package/utils/upsert-utils.d.ts +20 -5
- package/utils/upsert-utils.js +114 -116
|
@@ -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
|
-
|
|
5
|
+
readonly [rawFragmentSymbolBrand]: true;
|
|
6
6
|
};
|
|
7
|
+
/** Checks whether the given value is a `RawQueryFragment` instance. */
|
|
8
|
+
export declare function isRaw(value: unknown): value is RawQueryFragment;
|
|
7
9
|
/** Represents a raw SQL fragment with optional parameters, usable as both a value and an object key via Symbol coercion. */
|
|
8
10
|
export declare class RawQueryFragment<Alias extends string = string> {
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
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;
|
|
31
33
|
}
|
|
32
34
|
export { RawQueryFragment as Raw };
|
|
33
|
-
/** Checks whether the given value is a `RawQueryFragment` instance. */
|
|
34
|
-
export declare function isRaw(value: unknown): value is RawQueryFragment;
|
|
35
35
|
/** @internal */
|
|
36
|
-
export declare const ALIAS_REPLACEMENT =
|
|
36
|
+
export declare const ALIAS_REPLACEMENT = '[::alias::]';
|
|
37
37
|
/** @internal */
|
|
38
|
-
export declare const ALIAS_REPLACEMENT_RE =
|
|
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,7 +91,10 @@ 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>(
|
|
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;
|
|
95
98
|
/**
|
|
96
99
|
* Alternative to the `raw()` helper allowing to use it as a tagged template function for the simple cases.
|
|
97
100
|
*
|
|
@@ -111,13 +114,20 @@ export declare function raw<R = RawQueryFragment & symbol, T extends object = an
|
|
|
111
114
|
*/
|
|
112
115
|
export declare function sql<R = RawQueryFragment & symbol>(sql: readonly string[], ...values: unknown[]): R;
|
|
113
116
|
export declare namespace sql {
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
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;
|
|
118
125
|
}
|
|
119
126
|
/** Creates a raw SQL function expression wrapping the given key (e.g., `lower(name)`). */
|
|
120
|
-
export declare function createSqlFunction<R = RawQueryFragment & symbol, T extends object = any>(
|
|
127
|
+
export declare function createSqlFunction<R = RawQueryFragment & symbol, T extends object = any>(
|
|
128
|
+
func: string,
|
|
129
|
+
key: string | ((alias: string) => string),
|
|
130
|
+
): R;
|
|
121
131
|
/**
|
|
122
132
|
* Tag function providing quoting of db identifiers (table name, columns names, index names, ...).
|
|
123
133
|
*
|
|
@@ -131,6 +141,12 @@ export declare function createSqlFunction<R = RawQueryFragment & symbol, T exten
|
|
|
131
141
|
* export class Author { ... }
|
|
132
142
|
* ```
|
|
133
143
|
*/
|
|
134
|
-
export declare function quote(
|
|
135
|
-
|
|
136
|
-
|
|
144
|
+
export declare function quote(
|
|
145
|
+
expParts: readonly string[],
|
|
146
|
+
...values: (
|
|
147
|
+
| string
|
|
148
|
+
| {
|
|
149
|
+
toString(): string;
|
|
150
|
+
}
|
|
151
|
+
)[]
|
|
152
|
+
): RawQueryFragment & symbol;
|
|
@@ -1,85 +1,123 @@
|
|
|
1
1
|
import { Utils } from './Utils.js';
|
|
2
|
-
|
|
2
|
+
// Brand lives on the prototype so JSON payloads — whose proto is
|
|
3
|
+
// `Object.prototype` — cannot forge it. String key, not a `Symbol.for(...)`,
|
|
4
|
+
// so each CJS/ESM copy of this module independently installs it on its own
|
|
5
|
+
// prototype without publishing a global key for the marker that controls raw
|
|
6
|
+
// SQL assembly. The string is namespaced so it does not collide with property
|
|
7
|
+
// names users might independently install on their own prototypes.
|
|
8
|
+
const RAW_FRAGMENT_BRAND = '__mikroOrmRawFragment';
|
|
9
|
+
// Back-references from a fragment's symbol key to the fragment itself, shared
|
|
10
|
+
// across CJS/ESM module copies via globalThis: when one copy creates a fragment
|
|
11
|
+
// via `raw('…')` and stores its symbol in a where-clause object key, the other
|
|
12
|
+
// copy still needs to recover the original fragment to assemble SQL.
|
|
13
|
+
const REGISTRY_KEY = Symbol.for('@mikro-orm/core/RawQueryFragment.references');
|
|
14
|
+
const rawQueryReferences = (globalThis[REGISTRY_KEY] ??= new WeakMap());
|
|
15
|
+
/** Checks whether the given value is a `RawQueryFragment` instance. */
|
|
16
|
+
export function isRaw(value) {
|
|
17
|
+
if (value == null || typeof value !== 'object') {
|
|
18
|
+
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
|
+
}
|
|
3
36
|
/** Represents a raw SQL fragment with optional parameters, usable as both a value and an object key via Symbol coercion. */
|
|
4
37
|
export class RawQueryFragment {
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
}
|
|
75
|
-
return { sql: this.sql };
|
|
76
|
-
}
|
|
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
|
+
}
|
|
77
107
|
}
|
|
108
|
+
// Non-enumerable so the brand is skipped by JSON/Object.keys/for-in, and locked
|
|
109
|
+
// down (non-writable, non-configurable) so in-process code cannot delete or
|
|
110
|
+
// overwrite it and thereby silently disable `isRaw` recognition for every
|
|
111
|
+
// fragment in the process. Subclasses don't need mutability here — they inherit
|
|
112
|
+
// the brand via the prototype chain, and sibling-copy classes install their own
|
|
113
|
+
// brand on their own prototype (a different object), so lockdown only blocks
|
|
114
|
+
// tampering with the canonical marker.
|
|
115
|
+
Object.defineProperty(RawQueryFragment.prototype, RAW_FRAGMENT_BRAND, {
|
|
116
|
+
value: true,
|
|
117
|
+
writable: false,
|
|
118
|
+
configurable: false,
|
|
119
|
+
});
|
|
78
120
|
export { RawQueryFragment as Raw };
|
|
79
|
-
/** Checks whether the given value is a `RawQueryFragment` instance. */
|
|
80
|
-
export function isRaw(value) {
|
|
81
|
-
return typeof value === 'object' && value !== null && Object.hasOwn(value, rawSymbol);
|
|
82
|
-
}
|
|
83
121
|
/** @internal */
|
|
84
122
|
export const ALIAS_REPLACEMENT = '[::alias::]';
|
|
85
123
|
/** @internal */
|
|
@@ -140,30 +178,30 @@ export const ALIAS_REPLACEMENT_RE = '\\[::alias::\\]';
|
|
|
140
178
|
* ```
|
|
141
179
|
*/
|
|
142
180
|
export function raw(sql, params) {
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
return new RawQueryFragment(sql, params);
|
|
151
|
-
}
|
|
152
|
-
if (Array.isArray(sql)) {
|
|
153
|
-
// for composite FK we return just a simple string
|
|
154
|
-
return Utils.getPrimaryKeyHash(sql);
|
|
155
|
-
}
|
|
156
|
-
if (typeof params === 'object' && !Array.isArray(params)) {
|
|
157
|
-
const pairs = Object.entries(params);
|
|
158
|
-
const objectParams = [];
|
|
159
|
-
for (const [key, value] of pairs) {
|
|
160
|
-
sql = sql.replace(`:${key}:`, '??');
|
|
161
|
-
sql = sql.replace(`:${key}`, '?');
|
|
162
|
-
objectParams.push(value);
|
|
163
|
-
}
|
|
164
|
-
return new RawQueryFragment(sql, objectParams);
|
|
165
|
-
}
|
|
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)) {
|
|
166
188
|
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);
|
|
167
205
|
}
|
|
168
206
|
/**
|
|
169
207
|
* Alternative to the `raw()` helper allowing to use it as a tagged template function for the simple cases.
|
|
@@ -183,19 +221,19 @@ export function raw(sql, params) {
|
|
|
183
221
|
* ```
|
|
184
222
|
*/
|
|
185
223
|
export function sql(sql, ...values) {
|
|
186
|
-
|
|
224
|
+
return raw(sql.join('?'), values);
|
|
187
225
|
}
|
|
188
226
|
/** Creates a raw SQL function expression wrapping the given key (e.g., `lower(name)`). */
|
|
189
227
|
export function createSqlFunction(func, key) {
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
228
|
+
if (typeof key === 'string') {
|
|
229
|
+
return raw(`${func}(${key})`);
|
|
230
|
+
}
|
|
231
|
+
return raw(a => `${func}(${key(a)})`);
|
|
194
232
|
}
|
|
195
233
|
sql.ref = (...keys) => raw('??', [keys.join('.')]);
|
|
196
|
-
sql.now =
|
|
197
|
-
sql.lower =
|
|
198
|
-
sql.upper =
|
|
234
|
+
sql.now = length => raw('current_timestamp' + (length == null ? '' : `(${length})`));
|
|
235
|
+
sql.lower = key => createSqlFunction('lower', key);
|
|
236
|
+
sql.upper = key => createSqlFunction('upper', key);
|
|
199
237
|
/**
|
|
200
238
|
* Tag function providing quoting of db identifiers (table name, columns names, index names, ...).
|
|
201
239
|
*
|
|
@@ -210,5 +248,5 @@ sql.upper = (key) => createSqlFunction('upper', key);
|
|
|
210
248
|
* ```
|
|
211
249
|
*/
|
|
212
250
|
export function quote(expParts, ...values) {
|
|
213
|
-
|
|
251
|
+
return raw(expParts.join('??'), values);
|
|
214
252
|
}
|
|
@@ -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
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
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
|
-
|
|
41
|
-
|
|
40
|
+
schema?: string;
|
|
41
|
+
loggerContext?: LoggingOptions;
|
|
42
42
|
}
|
package/utils/RequestContext.js
CHANGED
|
@@ -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
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
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,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
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
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
|
}
|