@mikro-orm/core 7.0.0-dev.2 → 7.0.0-dev.200

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 (210) hide show
  1. package/EntityManager.d.ts +111 -61
  2. package/EntityManager.js +346 -300
  3. package/MikroORM.d.ts +44 -35
  4. package/MikroORM.js +103 -143
  5. package/README.md +3 -2
  6. package/cache/FileCacheAdapter.d.ts +1 -1
  7. package/cache/FileCacheAdapter.js +8 -7
  8. package/cache/GeneratedCacheAdapter.d.ts +0 -1
  9. package/cache/GeneratedCacheAdapter.js +0 -2
  10. package/cache/index.d.ts +0 -1
  11. package/cache/index.js +0 -1
  12. package/connections/Connection.d.ts +16 -7
  13. package/connections/Connection.js +23 -14
  14. package/drivers/DatabaseDriver.d.ts +25 -16
  15. package/drivers/DatabaseDriver.js +80 -35
  16. package/drivers/IDatabaseDriver.d.ts +47 -17
  17. package/entity/BaseEntity.d.ts +2 -2
  18. package/entity/BaseEntity.js +0 -3
  19. package/entity/Collection.d.ts +95 -31
  20. package/entity/Collection.js +444 -102
  21. package/entity/EntityAssigner.d.ts +1 -1
  22. package/entity/EntityAssigner.js +26 -18
  23. package/entity/EntityFactory.d.ts +13 -1
  24. package/entity/EntityFactory.js +88 -54
  25. package/entity/EntityHelper.d.ts +2 -2
  26. package/entity/EntityHelper.js +38 -15
  27. package/entity/EntityLoader.d.ts +8 -7
  28. package/entity/EntityLoader.js +134 -80
  29. package/entity/EntityRepository.d.ts +24 -4
  30. package/entity/EntityRepository.js +8 -2
  31. package/entity/Reference.d.ts +9 -12
  32. package/entity/Reference.js +34 -9
  33. package/entity/WrappedEntity.d.ts +2 -7
  34. package/entity/WrappedEntity.js +3 -8
  35. package/entity/defineEntity.d.ts +585 -0
  36. package/entity/defineEntity.js +533 -0
  37. package/entity/index.d.ts +3 -2
  38. package/entity/index.js +3 -2
  39. package/entity/utils.d.ts +7 -0
  40. package/entity/utils.js +16 -4
  41. package/entity/validators.d.ts +11 -0
  42. package/entity/validators.js +65 -0
  43. package/enums.d.ts +22 -6
  44. package/enums.js +15 -1
  45. package/errors.d.ts +23 -9
  46. package/errors.js +59 -21
  47. package/events/EventManager.d.ts +2 -1
  48. package/events/EventManager.js +19 -11
  49. package/events/EventSubscriber.d.ts +3 -1
  50. package/hydration/Hydrator.js +1 -2
  51. package/hydration/ObjectHydrator.d.ts +4 -4
  52. package/hydration/ObjectHydrator.js +53 -33
  53. package/index.d.ts +2 -2
  54. package/index.js +1 -2
  55. package/logging/DefaultLogger.d.ts +1 -1
  56. package/logging/DefaultLogger.js +1 -0
  57. package/logging/SimpleLogger.d.ts +1 -1
  58. package/logging/colors.d.ts +1 -1
  59. package/logging/colors.js +7 -6
  60. package/logging/index.d.ts +1 -0
  61. package/logging/index.js +1 -0
  62. package/logging/inspect.d.ts +2 -0
  63. package/logging/inspect.js +11 -0
  64. package/metadata/EntitySchema.d.ts +26 -26
  65. package/metadata/EntitySchema.js +82 -51
  66. package/metadata/MetadataDiscovery.d.ts +7 -10
  67. package/metadata/MetadataDiscovery.js +408 -335
  68. package/metadata/MetadataProvider.d.ts +11 -2
  69. package/metadata/MetadataProvider.js +46 -2
  70. package/metadata/MetadataStorage.d.ts +13 -11
  71. package/metadata/MetadataStorage.js +70 -37
  72. package/metadata/MetadataValidator.d.ts +17 -9
  73. package/metadata/MetadataValidator.js +100 -42
  74. package/metadata/discover-entities.d.ts +5 -0
  75. package/metadata/discover-entities.js +40 -0
  76. package/metadata/index.d.ts +1 -1
  77. package/metadata/index.js +1 -1
  78. package/metadata/types.d.ts +502 -0
  79. package/metadata/types.js +1 -0
  80. package/naming-strategy/AbstractNamingStrategy.d.ts +12 -4
  81. package/naming-strategy/AbstractNamingStrategy.js +14 -2
  82. package/naming-strategy/EntityCaseNamingStrategy.d.ts +3 -3
  83. package/naming-strategy/EntityCaseNamingStrategy.js +6 -5
  84. package/naming-strategy/MongoNamingStrategy.d.ts +3 -3
  85. package/naming-strategy/MongoNamingStrategy.js +6 -6
  86. package/naming-strategy/NamingStrategy.d.ts +24 -4
  87. package/naming-strategy/UnderscoreNamingStrategy.d.ts +3 -3
  88. package/naming-strategy/UnderscoreNamingStrategy.js +6 -6
  89. package/not-supported.d.ts +2 -0
  90. package/not-supported.js +4 -0
  91. package/package.json +19 -11
  92. package/platforms/ExceptionConverter.js +1 -1
  93. package/platforms/Platform.d.ts +7 -13
  94. package/platforms/Platform.js +20 -43
  95. package/serialization/EntitySerializer.d.ts +5 -0
  96. package/serialization/EntitySerializer.js +47 -27
  97. package/serialization/EntityTransformer.js +28 -18
  98. package/serialization/SerializationContext.d.ts +6 -6
  99. package/serialization/SerializationContext.js +16 -13
  100. package/types/ArrayType.d.ts +1 -1
  101. package/types/ArrayType.js +2 -3
  102. package/types/BigIntType.d.ts +9 -6
  103. package/types/BigIntType.js +4 -1
  104. package/types/BlobType.d.ts +0 -1
  105. package/types/BlobType.js +0 -3
  106. package/types/BooleanType.d.ts +2 -1
  107. package/types/BooleanType.js +3 -0
  108. package/types/DecimalType.d.ts +6 -4
  109. package/types/DecimalType.js +3 -3
  110. package/types/DoubleType.js +2 -2
  111. package/types/EnumArrayType.js +1 -2
  112. package/types/JsonType.d.ts +1 -1
  113. package/types/JsonType.js +7 -2
  114. package/types/TinyIntType.js +1 -1
  115. package/types/Type.d.ts +2 -4
  116. package/types/Type.js +3 -3
  117. package/types/Uint8ArrayType.d.ts +0 -1
  118. package/types/Uint8ArrayType.js +1 -4
  119. package/types/index.d.ts +1 -1
  120. package/typings.d.ts +300 -140
  121. package/typings.js +62 -44
  122. package/unit-of-work/ChangeSet.d.ts +2 -6
  123. package/unit-of-work/ChangeSet.js +4 -5
  124. package/unit-of-work/ChangeSetComputer.d.ts +1 -3
  125. package/unit-of-work/ChangeSetComputer.js +26 -13
  126. package/unit-of-work/ChangeSetPersister.d.ts +5 -4
  127. package/unit-of-work/ChangeSetPersister.js +77 -35
  128. package/unit-of-work/CommitOrderCalculator.d.ts +12 -10
  129. package/unit-of-work/CommitOrderCalculator.js +13 -13
  130. package/unit-of-work/IdentityMap.d.ts +12 -0
  131. package/unit-of-work/IdentityMap.js +39 -1
  132. package/unit-of-work/UnitOfWork.d.ts +23 -3
  133. package/unit-of-work/UnitOfWork.js +199 -106
  134. package/utils/AbstractSchemaGenerator.d.ts +5 -5
  135. package/utils/AbstractSchemaGenerator.js +22 -17
  136. package/utils/AsyncContext.d.ts +6 -0
  137. package/utils/AsyncContext.js +42 -0
  138. package/utils/Configuration.d.ts +779 -207
  139. package/utils/Configuration.js +146 -190
  140. package/utils/ConfigurationLoader.d.ts +1 -54
  141. package/utils/ConfigurationLoader.js +1 -352
  142. package/utils/Cursor.d.ts +3 -6
  143. package/utils/Cursor.js +27 -11
  144. package/utils/DataloaderUtils.d.ts +15 -5
  145. package/utils/DataloaderUtils.js +65 -17
  146. package/utils/EntityComparator.d.ts +13 -9
  147. package/utils/EntityComparator.js +164 -89
  148. package/utils/QueryHelper.d.ts +14 -6
  149. package/utils/QueryHelper.js +88 -26
  150. package/utils/RawQueryFragment.d.ts +48 -25
  151. package/utils/RawQueryFragment.js +67 -66
  152. package/utils/RequestContext.js +2 -2
  153. package/utils/TransactionContext.js +2 -2
  154. package/utils/TransactionManager.d.ts +65 -0
  155. package/utils/TransactionManager.js +223 -0
  156. package/utils/Utils.d.ts +13 -120
  157. package/utils/Utils.js +104 -375
  158. package/utils/clone.js +8 -23
  159. package/utils/env-vars.d.ts +7 -0
  160. package/utils/env-vars.js +97 -0
  161. package/utils/fs-utils.d.ts +32 -0
  162. package/utils/fs-utils.js +178 -0
  163. package/utils/index.d.ts +2 -1
  164. package/utils/index.js +2 -1
  165. package/utils/upsert-utils.d.ts +9 -4
  166. package/utils/upsert-utils.js +55 -4
  167. package/decorators/Check.d.ts +0 -3
  168. package/decorators/Check.js +0 -13
  169. package/decorators/CreateRequestContext.d.ts +0 -3
  170. package/decorators/CreateRequestContext.js +0 -29
  171. package/decorators/Embeddable.d.ts +0 -8
  172. package/decorators/Embeddable.js +0 -11
  173. package/decorators/Embedded.d.ts +0 -18
  174. package/decorators/Embedded.js +0 -18
  175. package/decorators/Entity.d.ts +0 -18
  176. package/decorators/Entity.js +0 -13
  177. package/decorators/Enum.d.ts +0 -9
  178. package/decorators/Enum.js +0 -16
  179. package/decorators/Filter.d.ts +0 -2
  180. package/decorators/Filter.js +0 -8
  181. package/decorators/Formula.d.ts +0 -5
  182. package/decorators/Formula.js +0 -15
  183. package/decorators/Indexed.d.ts +0 -17
  184. package/decorators/Indexed.js +0 -20
  185. package/decorators/ManyToMany.d.ts +0 -40
  186. package/decorators/ManyToMany.js +0 -14
  187. package/decorators/ManyToOne.d.ts +0 -30
  188. package/decorators/ManyToOne.js +0 -14
  189. package/decorators/OneToMany.d.ts +0 -28
  190. package/decorators/OneToMany.js +0 -17
  191. package/decorators/OneToOne.d.ts +0 -24
  192. package/decorators/OneToOne.js +0 -7
  193. package/decorators/PrimaryKey.d.ts +0 -9
  194. package/decorators/PrimaryKey.js +0 -20
  195. package/decorators/Property.d.ts +0 -250
  196. package/decorators/Property.js +0 -32
  197. package/decorators/Transactional.d.ts +0 -13
  198. package/decorators/Transactional.js +0 -28
  199. package/decorators/hooks.d.ts +0 -16
  200. package/decorators/hooks.js +0 -47
  201. package/decorators/index.d.ts +0 -17
  202. package/decorators/index.js +0 -17
  203. package/entity/ArrayCollection.d.ts +0 -116
  204. package/entity/ArrayCollection.js +0 -395
  205. package/entity/EntityValidator.d.ts +0 -19
  206. package/entity/EntityValidator.js +0 -150
  207. package/metadata/ReflectMetadataProvider.d.ts +0 -8
  208. package/metadata/ReflectMetadataProvider.js +0 -44
  209. package/utils/resolveContextProvider.d.ts +0 -10
  210. package/utils/resolveContextProvider.js +0 -28
@@ -1,352 +1 @@
1
- import dotenv from 'dotenv';
2
- import { realpathSync } from 'node:fs';
3
- import { platform } from 'node:os';
4
- import { fileURLToPath } from 'node:url';
5
- import { colors } from '../logging/colors.js';
6
- import { Configuration } from './Configuration.js';
7
- import { Utils } from './Utils.js';
8
- /**
9
- * @internal
10
- */
11
- export class ConfigurationLoader {
12
- static async getConfiguration(contextName = 'default', paths = ConfigurationLoader.getConfigPaths(), options = {}) {
13
- // Backwards compatibility layer
14
- if (typeof contextName === 'boolean' || !Array.isArray(paths)) {
15
- this.commonJSCompat(options);
16
- this.registerDotenv(options);
17
- const configPathFromArg = ConfigurationLoader.configPathsFromArg();
18
- const configPaths = configPathFromArg ?? (Array.isArray(paths) ? paths : ConfigurationLoader.getConfigPaths());
19
- const config = contextName
20
- ? (await ConfigurationLoader.getConfiguration(process.env.MIKRO_ORM_CONTEXT_NAME ?? 'default', configPaths, Array.isArray(paths) ? {} : paths))
21
- : await (async () => {
22
- const env = await this.loadEnvironmentVars();
23
- const [path, tmp] = await this.getConfigFile(configPaths);
24
- if (!path) {
25
- if (Utils.hasObjectKeys(env)) {
26
- return new Configuration(Utils.mergeConfig({}, options, env), false);
27
- }
28
- throw new Error(`MikroORM config file not found in ['${configPaths.join(`', '`)}']`);
29
- }
30
- return new Configuration(Utils.mergeConfig(tmp, options, env), false);
31
- })();
32
- if (configPathFromArg) {
33
- config.getLogger().warn('deprecated', 'Path for config file was inferred from the command line arguments. Instead, you should set the MIKRO_ORM_CLI_CONFIG environment variable to specify the path, or if you really must use the command line arguments, import the config manually based on them, and pass it to init.', { label: 'D0001' });
34
- }
35
- return config;
36
- }
37
- const env = await this.loadEnvironmentVars();
38
- const configFinder = (cfg) => {
39
- return typeof cfg === 'object' && cfg !== null && ('contextName' in cfg ? cfg.contextName === contextName : (contextName === 'default'));
40
- };
41
- const isValidConfigFactoryResult = (cfg) => {
42
- return typeof cfg === 'object' && cfg !== null && (!('contextName' in cfg) || cfg.contextName === contextName);
43
- };
44
- const result = await this.getConfigFile(paths);
45
- if (!result[0]) {
46
- if (Utils.hasObjectKeys(env)) {
47
- return new Configuration(Utils.mergeConfig({ contextName }, options, env));
48
- }
49
- throw new Error(`MikroORM config file not found in ['${paths.join(`', '`)}']`);
50
- }
51
- const path = result[0];
52
- let tmp = result[1];
53
- if (Array.isArray(tmp)) {
54
- const tmpFirstIndex = tmp.findIndex(configFinder);
55
- if (tmpFirstIndex === -1) {
56
- // Static config not found. Try factory functions
57
- let configCandidate;
58
- for (let i = 0, l = tmp.length; i < l; ++i) {
59
- const f = tmp[i];
60
- if (typeof f !== 'function') {
61
- continue;
62
- }
63
- configCandidate = await f(contextName);
64
- if (!isValidConfigFactoryResult(configCandidate)) {
65
- continue;
66
- }
67
- tmp = configCandidate;
68
- break;
69
- }
70
- if (Array.isArray(tmp)) {
71
- throw new Error(`MikroORM config '${contextName}' was not found within the config file '${path}'. Either add a config with this name to the array, or add a function that when given this name will return a configuration object without a name, or with name set to this name.`);
72
- }
73
- }
74
- else {
75
- const tmpLastIndex = tmp.findLastIndex(configFinder);
76
- if (tmpLastIndex !== tmpFirstIndex) {
77
- throw new Error(`MikroORM config '${contextName}' is not unique within the array exported by '${path}' (first occurrence index: ${tmpFirstIndex}; last occurrence index: ${tmpLastIndex})`);
78
- }
79
- tmp = tmp[tmpFirstIndex];
80
- }
81
- }
82
- else {
83
- if (tmp instanceof Function) {
84
- tmp = await tmp(contextName);
85
- if (!isValidConfigFactoryResult(tmp)) {
86
- throw new Error(`MikroORM config '${contextName}' was not what the function exported from '${path}' provided. Ensure it returns a config object with no name, or name matching the requested one.`);
87
- }
88
- }
89
- else {
90
- if (!configFinder(tmp)) {
91
- throw new Error(`MikroORM config '${contextName}' was not what the default export from '${path}' provided.`);
92
- }
93
- }
94
- }
95
- const esmConfigOptions = this.isESM() ? { entityGenerator: { esmImport: true } } : {};
96
- return new Configuration(Utils.mergeConfig({}, esmConfigOptions, tmp, options, env));
97
- }
98
- static async getConfigFile(paths) {
99
- for (let path of paths) {
100
- path = Utils.absolutePath(path);
101
- path = Utils.normalizePath(path);
102
- if (Utils.pathExistsSync(path)) {
103
- const config = await Utils.dynamicImport(path);
104
- /* v8 ignore next */
105
- return [path, await (config.default ?? config)];
106
- }
107
- }
108
- return [];
109
- }
110
- static getPackageConfig(basePath = process.cwd()) {
111
- if (Utils.pathExistsSync(`${basePath}/package.json`)) {
112
- /* v8 ignore next 5 */
113
- try {
114
- return Utils.readJSONSync(`${basePath}/package.json`);
115
- }
116
- catch {
117
- return {};
118
- }
119
- }
120
- const parentFolder = realpathSync(`${basePath}/..`);
121
- // we reached the root folder
122
- if (basePath === parentFolder) {
123
- return {};
124
- }
125
- return this.getPackageConfig(parentFolder);
126
- }
127
- static getSettings() {
128
- const config = ConfigurationLoader.getPackageConfig();
129
- const settings = { ...config['mikro-orm'] };
130
- const bool = (v) => ['true', 't', '1'].includes(v.toLowerCase());
131
- settings.preferTs = process.env.MIKRO_ORM_CLI_PREFER_TS != null ? bool(process.env.MIKRO_ORM_CLI_PREFER_TS) : settings.preferTs;
132
- settings.tsConfigPath = process.env.MIKRO_ORM_CLI_TS_CONFIG_PATH ?? settings.tsConfigPath;
133
- settings.alwaysAllowTs = process.env.MIKRO_ORM_CLI_ALWAYS_ALLOW_TS != null ? bool(process.env.MIKRO_ORM_CLI_ALWAYS_ALLOW_TS) : settings.alwaysAllowTs;
134
- settings.verbose = process.env.MIKRO_ORM_CLI_VERBOSE != null ? bool(process.env.MIKRO_ORM_CLI_VERBOSE) : settings.verbose;
135
- if (process.env.MIKRO_ORM_CLI_CONFIG?.endsWith('.ts')) {
136
- settings.preferTs = true;
137
- }
138
- return settings;
139
- }
140
- static configPathsFromArg() {
141
- const options = Utils.parseArgs();
142
- const configArgName = process.env.MIKRO_ORM_CONFIG_ARG_NAME ?? 'config';
143
- if (options[configArgName]) {
144
- return [options[configArgName]];
145
- }
146
- return undefined;
147
- }
148
- static getConfigPaths() {
149
- const paths = [];
150
- const settings = ConfigurationLoader.getSettings();
151
- if (process.env.MIKRO_ORM_CLI_CONFIG) {
152
- paths.push(process.env.MIKRO_ORM_CLI_CONFIG);
153
- }
154
- paths.push(...(settings.configPaths || []));
155
- const alwaysAllowTs = settings.alwaysAllowTs ?? process.versions.bun;
156
- if (settings.preferTs !== false || alwaysAllowTs) {
157
- paths.push('./src/mikro-orm.config.ts');
158
- paths.push('./mikro-orm.config.ts');
159
- }
160
- const distDir = Utils.pathExistsSync(process.cwd() + '/dist');
161
- const buildDir = Utils.pathExistsSync(process.cwd() + '/build');
162
- /* v8 ignore next */
163
- const path = distDir ? 'dist' : (buildDir ? 'build' : 'src');
164
- paths.push(`./${path}/mikro-orm.config.js`);
165
- paths.push('./mikro-orm.config.js');
166
- const typeScriptSupport = Utils.detectTypeScriptSupport();
167
- /* v8 ignore next */
168
- return Utils.unique(paths).filter(p => p.endsWith('.js') || typeScriptSupport || alwaysAllowTs);
169
- }
170
- static isESM() {
171
- const config = ConfigurationLoader.getPackageConfig();
172
- const type = config?.type ?? '';
173
- return type === 'module';
174
- }
175
- static async registerTypeScriptSupport(configPath = 'tsconfig.json') {
176
- /* v8 ignore next 3 */
177
- if (process.versions.bun) {
178
- return true;
179
- }
180
- process.env.SWC_NODE_PROJECT ??= configPath;
181
- process.env.MIKRO_ORM_CLI_ALWAYS_ALLOW_TS ??= '1';
182
- const esm = this.isESM();
183
- /* v8 ignore next 2 */
184
- const importMethod = esm ? 'tryImport' : 'tryRequire';
185
- const module = esm ? '@swc-node/register/esm-register' : '@swc-node/register';
186
- const supported = await Utils[importMethod]({
187
- module,
188
- warning: '@swc-node/register and @swc/core are not installed, support for working with TypeScript files might not work',
189
- });
190
- return !!supported;
191
- }
192
- static registerDotenv(options) {
193
- const path = process.env.MIKRO_ORM_ENV ?? ((options?.baseDir ?? process.cwd()) + '/.env');
194
- const env = {};
195
- dotenv.config({ path, processEnv: env });
196
- // only propagate known env vars
197
- for (const key of Object.keys(env)) {
198
- if (key.startsWith('MIKRO_ORM_')) {
199
- process.env[key] ??= env[key]; // respect user provided values
200
- }
201
- }
202
- }
203
- static async loadEnvironmentVars() {
204
- const ret = this.loadEnvironmentVarsSync();
205
- // only to keep some sort of back compatibility with those using env vars only, to support `MIKRO_ORM_TYPE`
206
- const PLATFORMS = {
207
- mongo: { className: 'MongoDriver', module: '@mikro-orm/mongodb' },
208
- mysql: { className: 'MySqlDriver', module: '@mikro-orm/mysql' },
209
- mssql: { className: 'MsSqlDriver', module: '@mikro-orm/mssql' },
210
- mariadb: { className: 'MariaDbDriver', module: '@mikro-orm/mariadb' },
211
- postgresql: { className: 'PostgreSqlDriver', module: '@mikro-orm/postgresql' },
212
- sqlite: { className: 'SqliteDriver', module: '@mikro-orm/sqlite' },
213
- libsql: { className: 'LibSqlDriver', module: '@mikro-orm/libsql' },
214
- };
215
- if (process.env.MIKRO_ORM_TYPE) {
216
- const val = process.env.MIKRO_ORM_TYPE;
217
- const driver = await import(PLATFORMS[val].module);
218
- ret.driver = driver[PLATFORMS[val].className];
219
- }
220
- return ret;
221
- }
222
- static loadEnvironmentVarsSync() {
223
- const ret = {};
224
- const array = (v) => v.split(',').map(vv => vv.trim());
225
- const bool = (v) => ['true', 't', '1'].includes(v.toLowerCase());
226
- const num = (v) => +v;
227
- const read = (o, envKey, key, mapper = v => v) => {
228
- if (!(envKey in process.env)) {
229
- return;
230
- }
231
- const val = process.env[envKey];
232
- o[key] = mapper(val);
233
- };
234
- const cleanup = (o, k) => Utils.hasObjectKeys(o[k]) ? {} : delete o[k];
235
- read(ret, 'MIKRO_ORM_BASE_DIR', 'baseDir');
236
- read(ret, 'MIKRO_ORM_ENTITIES', 'entities', array);
237
- read(ret, 'MIKRO_ORM_ENTITIES_TS', 'entitiesTs', array);
238
- read(ret, 'MIKRO_ORM_CLIENT_URL', 'clientUrl');
239
- read(ret, 'MIKRO_ORM_HOST', 'host');
240
- read(ret, 'MIKRO_ORM_PORT', 'port', num);
241
- read(ret, 'MIKRO_ORM_USER', 'user');
242
- read(ret, 'MIKRO_ORM_PASSWORD', 'password');
243
- read(ret, 'MIKRO_ORM_DB_NAME', 'dbName');
244
- read(ret, 'MIKRO_ORM_SCHEMA', 'schema');
245
- read(ret, 'MIKRO_ORM_LOAD_STRATEGY', 'loadStrategy');
246
- read(ret, 'MIKRO_ORM_BATCH_SIZE', 'batchSize', num);
247
- read(ret, 'MIKRO_ORM_USE_BATCH_INSERTS', 'useBatchInserts', bool);
248
- read(ret, 'MIKRO_ORM_USE_BATCH_UPDATES', 'useBatchUpdates', bool);
249
- read(ret, 'MIKRO_ORM_STRICT', 'strict', bool);
250
- read(ret, 'MIKRO_ORM_VALIDATE', 'validate', bool);
251
- read(ret, 'MIKRO_ORM_ALLOW_GLOBAL_CONTEXT', 'allowGlobalContext', bool);
252
- read(ret, 'MIKRO_ORM_AUTO_JOIN_ONE_TO_ONE_OWNER', 'autoJoinOneToOneOwner', bool);
253
- read(ret, 'MIKRO_ORM_POPULATE_AFTER_FLUSH', 'populateAfterFlush', bool);
254
- read(ret, 'MIKRO_ORM_FORCE_ENTITY_CONSTRUCTOR', 'forceEntityConstructor', bool);
255
- read(ret, 'MIKRO_ORM_FORCE_UNDEFINED', 'forceUndefined', bool);
256
- read(ret, 'MIKRO_ORM_FORCE_UTC_TIMEZONE', 'forceUtcTimezone', bool);
257
- read(ret, 'MIKRO_ORM_TIMEZONE', 'timezone');
258
- read(ret, 'MIKRO_ORM_ENSURE_INDEXES', 'ensureIndexes', bool);
259
- read(ret, 'MIKRO_ORM_IMPLICIT_TRANSACTIONS', 'implicitTransactions', bool);
260
- read(ret, 'MIKRO_ORM_DEBUG', 'debug', bool);
261
- read(ret, 'MIKRO_ORM_COLORS', 'colors', bool);
262
- ret.discovery = {};
263
- read(ret.discovery, 'MIKRO_ORM_DISCOVERY_WARN_WHEN_NO_ENTITIES', 'warnWhenNoEntities', bool);
264
- read(ret.discovery, 'MIKRO_ORM_DISCOVERY_REQUIRE_ENTITIES_ARRAY', 'requireEntitiesArray', bool);
265
- read(ret.discovery, 'MIKRO_ORM_DISCOVERY_ALWAYS_ANALYSE_PROPERTIES', 'alwaysAnalyseProperties', bool);
266
- read(ret.discovery, 'MIKRO_ORM_DISCOVERY_DISABLE_DYNAMIC_FILE_ACCESS', 'disableDynamicFileAccess', bool);
267
- cleanup(ret, 'discovery');
268
- ret.migrations = {};
269
- read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_TABLE_NAME', 'tableName');
270
- read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_PATH', 'path');
271
- read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_PATH_TS', 'pathTs');
272
- read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_GLOB', 'glob');
273
- read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_TRANSACTIONAL', 'transactional', bool);
274
- read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_DISABLE_FOREIGN_KEYS', 'disableForeignKeys', bool);
275
- read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_ALL_OR_NOTHING', 'allOrNothing', bool);
276
- read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_DROP_TABLES', 'dropTables', bool);
277
- read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_SAFE', 'safe', bool);
278
- read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_SILENT', 'silent', bool);
279
- read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_EMIT', 'emit');
280
- read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_SNAPSHOT', 'snapshot', bool);
281
- read(ret.migrations, 'MIKRO_ORM_MIGRATIONS_SNAPSHOT_NAME', 'snapshotName');
282
- cleanup(ret, 'migrations');
283
- ret.schemaGenerator = {};
284
- read(ret.schemaGenerator, 'MIKRO_ORM_SCHEMA_GENERATOR_DISABLE_FOREIGN_KEYS', 'disableForeignKeys', bool);
285
- read(ret.schemaGenerator, 'MIKRO_ORM_SCHEMA_GENERATOR_CREATE_FOREIGN_KEY_CONSTRAINTS', 'createForeignKeyConstraints', bool);
286
- cleanup(ret, 'schemaGenerator');
287
- ret.seeder = {};
288
- read(ret.seeder, 'MIKRO_ORM_SEEDER_PATH', 'path');
289
- read(ret.seeder, 'MIKRO_ORM_SEEDER_PATH_TS', 'pathTs');
290
- read(ret.seeder, 'MIKRO_ORM_SEEDER_GLOB', 'glob');
291
- read(ret.seeder, 'MIKRO_ORM_SEEDER_EMIT', 'emit');
292
- read(ret.seeder, 'MIKRO_ORM_SEEDER_DEFAULT_SEEDER', 'defaultSeeder');
293
- cleanup(ret, 'seeder');
294
- return ret;
295
- }
296
- static getORMPackages() {
297
- const pkg = this.getPackageConfig();
298
- return new Set([
299
- ...Object.keys(pkg.dependencies ?? {}),
300
- ...Object.keys(pkg.devDependencies ?? {}),
301
- ]);
302
- }
303
- /** @internal */
304
- static commonJSCompat(options) {
305
- if (this.isESM()) {
306
- return;
307
- }
308
- /* v8 ignore next 11 */
309
- options.dynamicImportProvider ??= id => {
310
- if (platform() === 'win32') {
311
- try {
312
- id = fileURLToPath(id);
313
- }
314
- catch {
315
- // ignore
316
- }
317
- }
318
- return Utils.requireFrom(id);
319
- };
320
- Utils.setDynamicImportProvider(options.dynamicImportProvider);
321
- }
322
- static getORMPackageVersion(name) {
323
- try {
324
- const pkg = Utils.requireFrom(`${name}/package.json`);
325
- /* v8 ignore next */
326
- return pkg?.version;
327
- }
328
- catch (e) {
329
- return undefined;
330
- }
331
- }
332
- // inspired by https://github.com/facebook/docusaurus/pull/3386
333
- static checkPackageVersion() {
334
- const coreVersion = Utils.getORMVersion();
335
- if (process.env.MIKRO_ORM_ALLOW_VERSION_MISMATCH) {
336
- return coreVersion;
337
- }
338
- const deps = this.getORMPackages();
339
- const exceptions = new Set(['nestjs', 'sql-highlighter', 'mongo-highlighter']);
340
- const ormPackages = [...deps].filter(d => d.startsWith('@mikro-orm/') && d !== '@mikro-orm/core' && !exceptions.has(d.substring('@mikro-orm/'.length)));
341
- for (const ormPackage of ormPackages) {
342
- const version = this.getORMPackageVersion(ormPackage);
343
- if (version != null && version !== coreVersion) {
344
- throw new Error(`Bad ${colors.cyan(ormPackage)} version ${colors.yellow('' + version)}.\n` +
345
- `All official @mikro-orm/* packages need to have the exact same version as @mikro-orm/core (${colors.green(coreVersion)}).\n` +
346
- `Only exceptions are packages that don't live in the 'mikro-orm' repository: ${[...exceptions].join(', ')}.\n` +
347
- `Maybe you want to check, or regenerate your yarn.lock or package-lock.json file?`);
348
- }
349
- }
350
- return coreVersion;
351
- }
352
- }
1
+ export {};
package/utils/Cursor.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- import { inspect } from 'node:util';
2
1
  import type { EntityMetadata, FilterObject, Loaded } from '../typings.js';
3
2
  import type { FindByCursorOptions, OrderDefinition } from '../drivers/IDatabaseDriver.js';
4
3
  import { type QueryOrder } from '../enums.js';
@@ -49,13 +48,13 @@ import { type QueryOrder } from '../enums.js';
49
48
  * }
50
49
  * ```
51
50
  */
52
- export declare class Cursor<Entity extends object, Hint extends string = never, Fields extends string = '*', Excludes extends string = never> {
51
+ export declare class Cursor<Entity extends object, Hint extends string = never, Fields extends string = '*', Excludes extends string = never, IncludeCount extends boolean = true> {
53
52
  readonly items: Loaded<Entity, Hint, Fields, Excludes>[];
54
- readonly totalCount: number;
53
+ readonly totalCount: IncludeCount extends true ? number : undefined;
55
54
  readonly hasPrevPage: boolean;
56
55
  readonly hasNextPage: boolean;
57
56
  private readonly definition;
58
- constructor(items: Loaded<Entity, Hint, Fields, Excludes>[], totalCount: number, options: FindByCursorOptions<Entity, Hint, Fields, Excludes>, meta: EntityMetadata<Entity>);
57
+ constructor(items: Loaded<Entity, Hint, Fields, Excludes>[], totalCount: IncludeCount extends true ? number : undefined, options: FindByCursorOptions<Entity, Hint, Fields, Excludes, IncludeCount>, meta: EntityMetadata<Entity>);
59
58
  get startCursor(): string | null;
60
59
  get endCursor(): string | null;
61
60
  /**
@@ -71,6 +70,4 @@ export declare class Cursor<Entity extends object, Hint extends string = never,
71
70
  static encode(value: unknown[]): string;
72
71
  static decode(value: string): unknown[];
73
72
  static getDefinition<Entity extends object>(meta: EntityMetadata<Entity>, orderBy: OrderDefinition<Entity>): [never, QueryOrder][];
74
- /** @ignore */
75
- [inspect.custom](): string;
76
73
  }
package/utils/Cursor.js CHANGED
@@ -1,10 +1,10 @@
1
- import { inspect } from 'node:util';
2
1
  import { Utils } from './Utils.js';
3
2
  import { ReferenceKind } from '../enums.js';
4
3
  import { Reference } from '../entity/Reference.js';
5
4
  import { helper } from '../entity/wrap.js';
6
- import { RawQueryFragment } from '../utils/RawQueryFragment.js';
5
+ import { Raw } from '../utils/RawQueryFragment.js';
7
6
  import { CursorError } from '../errors.js';
7
+ import { inspect } from '../logging/inspect.js';
8
8
  /**
9
9
  * As an alternative to the offset-based pagination with `limit` and `offset`, we can paginate based on a cursor.
10
10
  * A cursor is an opaque string that defines a specific place in ordered entity graph. You can use `em.findByCursor()`
@@ -95,18 +95,28 @@ export class Cursor {
95
95
  from(entity) {
96
96
  const processEntity = (entity, prop, direction, object = false) => {
97
97
  if (Utils.isPlainObject(direction)) {
98
+ const unwrapped = Reference.unwrapReference(entity[prop]);
99
+ // Check if the relation is loaded - for nested properties, undefined means not populated
100
+ if (Utils.isEntity(unwrapped) && !helper(unwrapped).isInitialized()) {
101
+ throw CursorError.entityNotPopulated(entity, prop);
102
+ }
98
103
  return Utils.keys(direction).reduce((o, key) => {
99
- Object.assign(o, processEntity(Reference.unwrapReference(entity[prop]), key, direction[key], true));
104
+ Object.assign(o, processEntity(unwrapped, key, direction[key], true));
100
105
  return o;
101
106
  }, {});
102
107
  }
103
- if (entity[prop] == null) {
104
- throw CursorError.entityNotPopulated(entity, prop);
105
- }
106
108
  let value = entity[prop];
109
+ // Allow null/undefined values in cursor - they will be handled in createCursorCondition
110
+ // undefined can occur with forceUndefined config option which converts null to undefined
111
+ if (value == null) {
112
+ return object ? { [prop]: null } : null;
113
+ }
107
114
  if (Utils.isEntity(value, true)) {
108
115
  value = helper(value).getPrimaryKey();
109
116
  }
117
+ if (Utils.isScalarReference(value)) {
118
+ value = value.unwrap();
119
+ }
110
120
  if (object) {
111
121
  return ({ [prop]: value });
112
122
  }
@@ -128,7 +138,13 @@ export class Cursor {
128
138
  */
129
139
  static for(meta, entity, orderBy) {
130
140
  const definition = this.getDefinition(meta, orderBy);
131
- return Cursor.encode(definition.map(([key]) => entity[key]));
141
+ return Cursor.encode(definition.map(([key]) => {
142
+ const value = entity[key];
143
+ if (value === undefined) {
144
+ throw CursorError.missingValue(meta.className, key);
145
+ }
146
+ return value;
147
+ }));
132
148
  }
133
149
  static encode(value) {
134
150
  return Buffer.from(JSON.stringify(value)).toString('base64url');
@@ -144,8 +160,8 @@ export class Cursor {
144
160
  static getDefinition(meta, orderBy) {
145
161
  return Utils.asArray(orderBy).flatMap(order => {
146
162
  const ret = [];
147
- for (const key of Utils.keys(order)) {
148
- if (RawQueryFragment.isKnownFragment(key)) {
163
+ for (const key of Utils.getObjectQueryKeys(order)) {
164
+ if (Raw.isKnownFragmentSymbol(key)) {
149
165
  ret.push([key, order[key]]);
150
166
  continue;
151
167
  }
@@ -159,9 +175,9 @@ export class Cursor {
159
175
  return ret;
160
176
  });
161
177
  }
162
- /* v8 ignore start */
163
178
  /** @ignore */
164
- [inspect.custom]() {
179
+ /* v8 ignore next */
180
+ [Symbol.for('nodejs.util.inspect.custom')]() {
165
181
  const type = this.items[0]?.constructor.name;
166
182
  const { items, startCursor, endCursor, hasPrevPage, hasNextPage, totalCount, length } = this;
167
183
  const options = inspect({ startCursor, endCursor, totalCount, hasPrevPage, hasNextPage, items, length }, { depth: 0 });
@@ -1,9 +1,10 @@
1
- import type { Primary, Ref } from '../typings.js';
1
+ import type { Constructor, Primary, Ref } from '../typings.js';
2
2
  import { Collection, type InitCollectionOptions } from '../entity/Collection.js';
3
3
  import { type EntityManager } from '../EntityManager.js';
4
- import type DataLoader from 'dataloader';
5
4
  import { type LoadReferenceOptions } from '../entity/Reference.js';
5
+ type BatchLoadFn<K, V> = (keys: readonly K[]) => PromiseLike<ArrayLike<V | Error>>;
6
6
  export declare class DataloaderUtils {
7
+ private static DataLoader?;
7
8
  /**
8
9
  * Groups identified references by entity and returns a Map with the
9
10
  * class name as the index and the corresponding primary keys as the value.
@@ -13,7 +14,7 @@ export declare class DataloaderUtils {
13
14
  * Returns the reference dataloader batchLoadFn, which aggregates references by entity,
14
15
  * makes one query per entity and maps each input reference to the corresponding result.
15
16
  */
16
- static getRefBatchLoadFn(em: EntityManager): DataLoader.BatchLoadFn<[Ref<any>, Omit<LoadReferenceOptions<any, any>, 'dataloader'>?], any>;
17
+ static getRefBatchLoadFn(em: EntityManager): BatchLoadFn<[Ref<any>, Omit<LoadReferenceOptions<any, any>, 'dataloader'>?], any>;
17
18
  /**
18
19
  * Groups collections by entity and returns a Map whose keys are the entity names and whose values are filter Maps
19
20
  * which we can use to narrow down the find query to return just the items of the collections that have been dataloaded.
@@ -34,8 +35,17 @@ export declare class DataloaderUtils {
34
35
  */
35
36
  static getColFilter<T, S extends T>(collection: Collection<any>): (result: T) => result is S;
36
37
  /**
37
- * Returns the collection dataloader batchLoadFn, which aggregates collections by entity,
38
+ * Returns the 1:M collection dataloader batchLoadFn, which aggregates collections by entity,
38
39
  * makes one query per entity and maps each input collection to the corresponding result.
39
40
  */
40
- static getColBatchLoadFn(em: EntityManager): DataLoader.BatchLoadFn<[Collection<any>, Omit<InitCollectionOptions<any, any>, 'dataloader'>?], any>;
41
+ static getColBatchLoadFn(em: EntityManager): BatchLoadFn<[Collection<any>, Omit<InitCollectionOptions<any, any>, 'dataloader'>?], any>;
42
+ /**
43
+ * Returns the M:N collection dataloader batchLoadFn, which aggregates collections by entity,
44
+ * makes one query per entity and maps each input collection to the corresponding result.
45
+ */
46
+ static getManyToManyColBatchLoadFn(em: EntityManager): BatchLoadFn<[Collection<any>, Omit<InitCollectionOptions<any, any>, 'dataloader'>?], any>;
47
+ static getDataLoader(): Promise<Constructor<{
48
+ load: (...args: unknown[]) => Promise<unknown>;
49
+ }>>;
41
50
  }
51
+ export {};