@mikro-orm/core 7.0.0-dev.44 → 7.0.0-dev.46

package/MikroORM.d.ts

@@ -27,7 +27,6 @@ export declare class MikroORM<Driver extends IDatabaseDriver = IDatabaseDriver,
      * - database connection will be established when you first interact with the database (or you can use `orm.connect()` explicitly)
      * - no loading of the `config` file, `options` parameter is mandatory
      * - no support for folder based discovery
-     * - no check for mismatched package versions
      */
     constructor(options: Options<Driver, EM>);
     /**

package/MikroORM.js

@@ -27,17 +27,10 @@ export class MikroORM {
         if (!options) {
             throw new Error(`options parameter is required`);
         }
-        const coreVersion = ConfigurationLoader.checkPackageVersion();
         options.discovery ??= {};
         options.discovery.skipSyncDiscovery ??= true;
         const orm = new this(options);
-        orm.logger.log('info', `MikroORM version: ${colors.green(coreVersion)}`);
-        // we need to allow global context here as we are not in a scope of requests yet
-        const allowGlobalContext = orm.config.get('allowGlobalContext');
-        orm.config.set('allowGlobalContext', true);
         await orm.discoverEntities();
-        orm.config.set('allowGlobalContext', allowGlobalContext);
-        orm.driver.getPlatform().init(orm);
         return orm;
     }
     /**
@@ -45,11 +38,11 @@ export class MikroORM {
      * - database connection will be established when you first interact with the database (or you can use `orm.connect()` explicitly)
      * - no loading of the `config` file, `options` parameter is mandatory
      * - no support for folder based discovery
-     * - no check for mismatched package versions
      */
     constructor(options) {
         ConfigurationLoader.registerDotenv(options);
         const env = ConfigurationLoader.loadEnvironmentVarsSync();
+        const coreVersion = ConfigurationLoader.checkPackageVersion();
         options = Utils.merge(options, env);
         this.config = new Configuration(options);
         const discovery = this.config.get('discovery');
@@ -60,18 +53,15 @@ export class MikroORM {
         }
         this.driver = this.config.getDriver();
         this.logger = this.config.getLogger();
+        this.logger.log('info', `MikroORM version: ${colors.green(coreVersion)}`);
         this.discovery = new MetadataDiscovery(new MetadataStorage(), this.driver.getPlatform(), this.config);
-        if (!discovery.skipSyncDiscovery) {
-            // we need to allow global context here as we are not in a scope of requests yet
-            const allowGlobalContext = this.config.get('allowGlobalContext');
-            this.config.set('allowGlobalContext', true);
-            this.discoverEntitiesSync();
-            this.config.set('allowGlobalContext', allowGlobalContext);
-            this.driver.getPlatform().init(this);
-        }
+        this.driver.getPlatform().init(this);
         for (const extension of this.config.get('extensions')) {
             extension.register(this);
         }
+        if (!discovery.skipSyncDiscovery) {
+            this.discoverEntitiesSync();
+        }
     }
     /**
      * Connects to the database.
@@ -125,12 +115,20 @@ export class MikroORM {
         return this.metadata;
     }
     async discoverEntities() {
+        // we need to allow global context here as we are not in a scope of requests yet
+        const allowGlobalContext = this.config.get('allowGlobalContext');
+        this.config.set('allowGlobalContext', true);
         this.metadata = await this.discovery.discover(this.config.get('preferTs'));
         this.createEntityManager();
+        this.config.set('allowGlobalContext', allowGlobalContext);
     }
     discoverEntitiesSync() {
+        // we need to allow global context here as we are not in a scope of requests yet
+        const allowGlobalContext = this.config.get('allowGlobalContext');
+        this.config.set('allowGlobalContext', true);
         this.metadata = this.discovery.discoverSync();
         this.createEntityManager();
+        this.config.set('allowGlobalContext', allowGlobalContext);
     }
     createEntityManager() {
         this.driver.setMetadata(this.metadata);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mikro-orm/core",
   "type": "module",
-  "version": "7.0.0-dev.44",
+  "version": "7.0.0-dev.46",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "exports": {
     "./package.json": "./package.json",
@@ -54,7 +54,7 @@
     "dataloader": "2.2.3",
     "dotenv": "17.2.3",
     "esprima": "4.0.1",
-    "mikro-orm": "7.0.0-dev.44",
+    "mikro-orm": "7.0.0-dev.46",
     "reflect-metadata": "0.2.2",
     "tinyglobby": "0.2.13"
   }

package/typings.d.ts

@@ -604,8 +604,6 @@ export interface GenerateOptions {
     coreImportsPrefix?: string;
     onInitialMetadata?: MetadataProcessor;
     onProcessedMetadata?: MetadataProcessor;
-    /** @deprecated use `entityDefinition: 'entitySchema'` instead */
-    entitySchema?: boolean;
 }
 export interface IEntityGenerator {
     generate(options?: GenerateOptions): Promise<string[]>;

package/utils/Configuration.d.ts

@@ -114,12 +114,12 @@ export declare class Configuration<D extends IDatabaseDriver = IDatabaseDriver,
         entityGenerator: {
             forceUndefined: true;
             undefinedDefaults: false;
-            bidirectionalRelations: false;
-            identifiedReferences: false;
             scalarTypeInDecorator: false;
+            bidirectionalRelations: true;
+            identifiedReferences: true;
             scalarPropertiesForRelations: "never";
-            entityDefinition: "decorators";
-            enumMode: "ts-enum";
+            entityDefinition: "defineEntity";
+            enumMode: "dictionary";
             fileName: (className: string) => string;
             onlyPurePivotTables: false;
             outputPurePivotTables: false;

package/utils/Configuration.js

@@ -104,12 +104,12 @@ export class Configuration {
         entityGenerator: {
             forceUndefined: true,
             undefinedDefaults: false,
-            bidirectionalRelations: false,
-            identifiedReferences: false,
             scalarTypeInDecorator: false,
+            bidirectionalRelations: true,
+            identifiedReferences: true,
             scalarPropertiesForRelations: 'never',
-            entityDefinition: 'decorators',
-            enumMode: 'ts-enum',
+            entityDefinition: 'defineEntity',
+            enumMode: 'dictionary',
             fileName: (className) => className,
             onlyPurePivotTables: false,
             outputPurePivotTables: false,
@@ -150,7 +150,6 @@ export class Configuration {
         }
         this.options = Utils.mergeConfig({}, Configuration.DEFAULTS, options);
         this.options.baseDir = Utils.absolutePath(this.options.baseDir);
-        this.options.preferTs ??= options.preferTs;
         if (validate) {
             this.validateOptions();
         }
@@ -348,10 +347,6 @@ export class Configuration {
     }
     sync() {
         process.env.MIKRO_ORM_COLORS = '' + this.options.colors;
-        // FIXME remove `entityGenerator.entitySchema` option
-        if (this.options.entityGenerator.entitySchema) {
-            this.options.entityGenerator.entityDefinition = 'entitySchema';
-        }
         this.logger.setDebugMode(this.options.debug);
     }
     /**

package/utils/ConfigurationLoader.d.ts

@@ -19,7 +19,12 @@ export declare class ConfigurationLoader {
     static getSettings(): Settings;
     static getConfigPaths(): string[];
     static isESM(): boolean;
-    static registerTypeScriptSupport(configPath?: string): Promise<boolean>;
+    /**
+     * Tries to register TS support in the following order: swc, tsx, jiti, tsimp
+     * Use `MIKRO_ORM_CLI_TS_LOADER` env var to set the loader explicitly.
+     * This method is used only in CLI context.
+     */
+    static registerTypeScriptSupport(configPath?: string, tsLoader?: 'swc' | 'tsx' | 'jiti' | 'tsimp' | 'auto'): Promise<boolean>;
     static registerDotenv<D extends IDatabaseDriver>(options: Options<D>): void;
     static loadEnvironmentVars<D extends IDatabaseDriver>(): Promise<Partial<Options<D>>>;
     static loadEnvironmentVarsSync<D extends IDatabaseDriver>(): Partial<Options<D>>;
@@ -31,6 +36,7 @@ export interface Settings {
     alwaysAllowTs?: boolean;
     verbose?: boolean;
     preferTs?: boolean;
+    tsLoader?: 'swc' | 'tsx' | 'jiti' | 'tsimp' | 'auto';
     tsConfigPath?: string;
     configPaths?: string[];
 }

package/utils/ConfigurationLoader.js

@@ -110,6 +110,7 @@ export class ConfigurationLoader {
         const settings = { ...config['mikro-orm'] };
         const bool = (v) => ['true', 't', '1'].includes(v.toLowerCase());
         settings.preferTs = process.env.MIKRO_ORM_CLI_PREFER_TS != null ? bool(process.env.MIKRO_ORM_CLI_PREFER_TS) : settings.preferTs;
+        settings.tsLoader = process.env.MIKRO_ORM_CLI_TS_LOADER ?? settings.tsLoader;
         settings.tsConfigPath = process.env.MIKRO_ORM_CLI_TS_CONFIG_PATH ?? settings.tsConfigPath;
         settings.alwaysAllowTs = process.env.MIKRO_ORM_CLI_ALWAYS_ALLOW_TS != null ? bool(process.env.MIKRO_ORM_CLI_ALWAYS_ALLOW_TS) : settings.alwaysAllowTs;
         settings.verbose = process.env.MIKRO_ORM_CLI_VERBOSE != null ? bool(process.env.MIKRO_ORM_CLI_VERBOSE) : settings.verbose;
@@ -145,22 +146,46 @@ export class ConfigurationLoader {
         const type = config?.type ?? '';
         return type === 'module';
     }
-    static async registerTypeScriptSupport(configPath = 'tsconfig.json') {
+    /**
+     * Tries to register TS support in the following order: swc, tsx, jiti, tsimp
+     * Use `MIKRO_ORM_CLI_TS_LOADER` env var to set the loader explicitly.
+     * This method is used only in CLI context.
+     */
+    static async registerTypeScriptSupport(configPath = 'tsconfig.json', tsLoader) {
         /* v8 ignore next 3 */
         if (process.versions.bun) {
             return true;
         }
         process.env.SWC_NODE_PROJECT ??= configPath;
+        process.env.TSIMP_PROJECT ??= configPath;
         process.env.MIKRO_ORM_CLI_ALWAYS_ALLOW_TS ??= '1';
-        const esm = this.isESM();
-        /* v8 ignore next 2 */
-        const importMethod = esm ? 'tryImport' : 'tryRequire';
-        const module = esm ? '@swc-node/register/esm-register' : '@swc-node/register';
-        const supported = await Utils[importMethod]({
-            module,
-            warning: '@swc-node/register and @swc/core are not installed, support for working with TypeScript files might not work',
-        });
-        return !!supported;
+        const isEsm = this.isESM();
+        /* v8 ignore next */
+        const importMethod = isEsm ? 'tryImport' : 'tryRequire';
+        const explicitLoader = tsLoader ?? process.env.MIKRO_ORM_CLI_TS_LOADER ?? 'auto';
+        const loaders = {
+            swc: { esm: '@swc-node/register/esm-register', cjs: '@swc-node/register' },
+            tsx: { esm: 'tsx/esm/api', cjs: 'tsx/cjs/api', cb: (tsx) => tsx.register({ tsconfig: configPath }) },
+            jiti: { esm: 'jiti/register', cjs: 'jiti/register', cb: () => Utils.setDynamicImportProvider(id => import(id).then(mod => mod?.default ?? mod)) },
+            tsimp: { esm: 'tsimp/import', cjs: 'tsimp/import' },
+        };
+        for (const loader of Utils.keys(loaders)) {
+            if (explicitLoader !== 'auto' && loader !== explicitLoader) {
+                continue;
+            }
+            const { esm, cjs, cb } = loaders[loader];
+            /* v8 ignore next */
+            const module = isEsm ? esm : cjs;
+            const mod = await Utils[importMethod]({ module });
+            if (mod) {
+                cb?.(mod);
+                process.env.MIKRO_ORM_CLI_TS_LOADER = loader;
+                return true;
+            }
+        }
+        // eslint-disable-next-line no-console
+        console.warn('Neither `swc`, `tsx`, `jiti` nor `tsimp` found in the project dependencies, support for working with TypeScript files might not work. To use `swc`, you need to install both `@swc-node/register` and `@swc/core`.');
+        return false;
     }
     static registerDotenv(options) {
         const path = process.env.MIKRO_ORM_ENV ?? ((options.baseDir ?? process.cwd()) + '/.env');

package/utils/Utils.d.ts

@@ -252,13 +252,13 @@ export declare class Utils {
     static setPayloadProperty<T>(entity: EntityDictionary<T>, meta: EntityMetadata<T>, prop: EntityProperty<T>, value: unknown, idx: number[]): void;
     static tryRequire<T extends Dictionary = any>({ module, from, allowError, warning }: {
         module: string;
-        warning: string;
+        warning?: string;
         from?: string;
         allowError?: string;
     }): T | undefined;
     static tryImport<T extends Dictionary = any>({ module, warning }: {
         module: string;
-        warning: string;
+        warning?: string;
     }): Promise<T | undefined>;
     static stripRelativePath(str: string): string;
     static xor(a: boolean, b: boolean): boolean;

package/utils/Utils.js

@@ -1075,8 +1075,10 @@ export class Utils {
         }
         catch (err) {
             if (err.message.includes(allowError)) {
-                // eslint-disable-next-line no-console
-                console.warn(warning);
+                if (warning) {
+                    // eslint-disable-next-line no-console
+                    console.warn(warning);
+                }
                 return undefined;
             }
             throw err;
@@ -1088,8 +1090,10 @@ export class Utils {
         }
         catch (err) {
             if (err.code === 'ERR_MODULE_NOT_FOUND') {
-                // eslint-disable-next-line no-console
-                console.warn(warning);
+                if (warning) {
+                    // eslint-disable-next-line no-console
+                    console.warn(warning);
+                }
                 return undefined;
             }
             throw err;