@mikro-orm/seeder 7.0.0-dev.33 → 7.0.0-dev.331

package/README.md

@@ -2,14 +2,14 @@
   <a href="https://mikro-orm.io"><img src="https://raw.githubusercontent.com/mikro-orm/mikro-orm/master/docs/static/img/logo-readme.svg?sanitize=true" alt="MikroORM" /></a>
 </h1>
 
-TypeScript ORM for Node.js based on Data Mapper, [Unit of Work](https://mikro-orm.io/docs/unit-of-work/) and [Identity Map](https://mikro-orm.io/docs/identity-map/) patterns. Supports MongoDB, MySQL, MariaDB, PostgreSQL and SQLite (including libSQL) databases. 
+TypeScript ORM for Node.js based on Data Mapper, [Unit of Work](https://mikro-orm.io/docs/unit-of-work/) and [Identity Map](https://mikro-orm.io/docs/identity-map/) patterns. Supports MongoDB, MySQL, MariaDB, PostgreSQL, SQLite (including libSQL), MSSQL and Oracle databases. 
 
 > Heavily inspired by [Doctrine](https://www.doctrine-project.org/) and [Hibernate](https://hibernate.org/).
 
-[![NPM version](https://img.shields.io/npm/v/@mikro-orm/core.svg)](https://www.npmjs.com/package/@mikro-orm/core)
-[![NPM dev version](https://img.shields.io/npm/v/@mikro-orm/core/next.svg)](https://www.npmjs.com/package/@mikro-orm/core)
+[![NPM version](https://img.shields.io/npm/v/@mikro-orm/core.svg)](https://npmx.dev/package/@mikro-orm/core)
+[![NPM dev version](https://img.shields.io/npm/v/@mikro-orm/core/next.svg)](https://npmx.dev/package/@mikro-orm/core)
 [![Chat on discord](https://img.shields.io/discord/1214904142443839538?label=discord&color=blue)](https://discord.gg/w8bjxFHS7X)
-[![Downloads](https://img.shields.io/npm/dm/@mikro-orm/core.svg)](https://www.npmjs.com/package/@mikro-orm/core)
+[![Downloads](https://img.shields.io/npm/dm/@mikro-orm/core.svg)](https://npmx.dev/package/@mikro-orm/core)
 [![Coverage Status](https://img.shields.io/coveralls/mikro-orm/mikro-orm.svg)](https://coveralls.io/r/mikro-orm/mikro-orm?branch=master)
 [![Build Status](https://github.com/mikro-orm/mikro-orm/workflows/tests/badge.svg?branch=master)](https://github.com/mikro-orm/mikro-orm/actions?workflow=tests)
 
@@ -181,6 +181,7 @@ yarn add @mikro-orm/core @mikro-orm/mysql         # for mysql/mariadb
 yarn add @mikro-orm/core @mikro-orm/mariadb       # for mysql/mariadb
 yarn add @mikro-orm/core @mikro-orm/postgresql    # for postgresql
 yarn add @mikro-orm/core @mikro-orm/mssql         # for mssql
+yarn add @mikro-orm/core @mikro-orm/oracledb      # for oracle
 yarn add @mikro-orm/core @mikro-orm/sqlite        # for sqlite
 yarn add @mikro-orm/core @mikro-orm/libsql        # for libsql
 ```
@@ -381,6 +382,8 @@ See also the list of contributors who [participated](https://github.com/mikro-or
 
 Please ⭐️ this repository if this project helped you!
 
+> If you'd like to support my open-source work, consider sponsoring me directly at [github.com/sponsors/b4nan](https://github.com/sponsors/b4nan).
+
 ## 📝 License
 
 Copyright © 2018 [Martin Adámek](https://github.com/b4nan).

package/SeedManager.d.ts

@@ -1,17 +1,24 @@
 import { type Constructor, type EntityManager, type ISeedManager, type MikroORM } from '@mikro-orm/core';
 import type { Seeder } from './Seeder.js';
 export declare class SeedManager implements ISeedManager {
-    private readonly em;
-    private readonly config;
-    private readonly options;
-    private readonly absolutePath;
+    #private;
     constructor(em: EntityManager);
+    private init;
     static register(orm: MikroORM): void;
+    /**
+     * Checks if `src` folder exists, it so, tries to adjust the migrations and seeders paths automatically to use it.
+     * If there is a `dist` or `build` folder, it will be used for the JS variant (`path` option), while the `src` folder will be
+     * used for the TS variant (`pathTs` option).
+     *
+     * If the default folder exists (e.g. `/migrations`), the config will respect that, so this auto-detection should not
+     * break existing projects, only help with the new ones.
+     */
+    private detectSourceFolder;
     seed(...classNames: Constructor<Seeder>[]): Promise<void>;
     /**
      * @internal
      */
     seedString(...classNames: string[]): Promise<void>;
-    createSeeder(className: string): Promise<string>;
+    create(className: string): Promise<string>;
     private generate;
 }

package/SeedManager.js

@@ -1,41 +1,97 @@
 import { Utils, } from '@mikro-orm/core';
-import { writeFile } from 'node:fs/promises';
-import { glob } from 'tinyglobby';
 export class SeedManager {
-    em;
-    config;
-    options;
-    absolutePath;
+    #config;
+    #options;
+    #absolutePath;
+    #initialized = false;
+    #em;
     constructor(em) {
-        this.em = em;
-        this.config = this.em.config;
-        this.options = this.config.get('seeder');
-        this.em = this.em.fork();
-        this.config.set('persistOnCreate', true);
-        /* v8 ignore next */
-        const key = (this.config.get('preferTs', Utils.detectTypeScriptSupport()) && this.options.pathTs) ? 'pathTs' : 'path';
-        this.absolutePath = Utils.absolutePath(this.options[key], this.config.get('baseDir'));
+        this.#em = em;
+        this.#config = this.#em.config;
+        this.#options = this.#config.get('seeder');
+        this.#em = this.#em.fork();
+        this.#config.set('persistOnCreate', true);
+    }
+    async init() {
+        if (this.#initialized) {
+            return;
+        }
+        this.#initialized = true;
+        if (!this.#options.seedersList) {
+            const { fs } = await import('@mikro-orm/core/fs-utils');
+            this.detectSourceFolder(fs);
+            /* v8 ignore next */
+            const key = this.#config.get('preferTs', Utils.detectTypeScriptSupport()) && this.#options.pathTs ? 'pathTs' : 'path';
+            this.#absolutePath = fs.absolutePath(this.#options[key], this.#config.get('baseDir'));
+        }
     }
     static register(orm) {
         orm.config.registerExtension('@mikro-orm/seeder', () => new SeedManager(orm.em));
     }
+    /**
+     * Checks if `src` folder exists, it so, tries to adjust the migrations and seeders paths automatically to use it.
+     * If there is a `dist` or `build` folder, it will be used for the JS variant (`path` option), while the `src` folder will be
+     * used for the TS variant (`pathTs` option).
+     *
+     * If the default folder exists (e.g. `/migrations`), the config will respect that, so this auto-detection should not
+     * break existing projects, only help with the new ones.
+     */
+    detectSourceFolder(fs) {
+        const baseDir = this.#config.get('baseDir');
+        const defaultPath = './seeders';
+        if (!fs.pathExists(baseDir + '/src')) {
+            this.#options.path ??= defaultPath;
+            return;
+        }
+        const exists = fs.pathExists(`${baseDir}/${defaultPath}`);
+        const distDir = fs.pathExists(baseDir + '/dist');
+        const buildDir = fs.pathExists(baseDir + '/build');
+        // if neither `dist` nor `build` exist, we use the `src` folder as it might be a JS project without building, but with `src` folder
+        const path = distDir ? './dist' : buildDir ? './build' : './src';
+        // only if the user did not provide any values and if the default path does not exist
+        if (!this.#options.path && !this.#options.pathTs && !exists) {
+            this.#options.path = `${path}/seeders`;
+            this.#options.pathTs = './src/seeders';
+        }
+    }
     async seed(...classNames) {
         for (const SeederClass of classNames) {
             const seeder = new SeederClass();
-            await seeder.run(this.em);
-            await this.em.flush();
-            this.em.clear();
+            await seeder.run(this.#em);
+            await this.#em.flush();
+            this.#em.clear();
         }
     }
     /**
      * @internal
      */
     async seedString(...classNames) {
-        const path = `${this.absolutePath}/${this.options.glob}`;
-        const files = await glob(path);
+        if (this.#options.seedersList) {
+            const classMap = new Map();
+            for (const entry of this.#options.seedersList) {
+                if (typeof entry === 'function') {
+                    classMap.set(entry.name, entry);
+                }
+                else {
+                    classMap.set(entry.name, entry.class);
+                }
+            }
+            for (const className of classNames) {
+                const seederClass = classMap.get(className);
+                if (!seederClass) {
+                    throw new Error(`Seeder class ${className} not found in seedersList`);
+                }
+                await this.seed(seederClass);
+            }
+            return;
+        }
+        await this.init();
+        const { fs } = await import('@mikro-orm/core/fs-utils');
+        const path = fs.normalizePath(this.#absolutePath, this.#options.glob);
+        const files = fs.glob(path).sort();
         const classMap = new Map();
-        for (const path of files) {
-            const exports = await Utils.dynamicImport(path);
+        for (const filePath of files) {
+            const exports = await fs.dynamicImport(filePath);
             for (const name of Object.keys(exports)) {
                 classMap.set(name, exports[name]);
             }
@@ -43,20 +99,22 @@ export class SeedManager {
         for (const className of classNames) {
             const seederClass = classMap.get(className);
             if (!seederClass) {
-                throw new Error(`Seeder class ${className} not found in ${Utils.relativePath(path, process.cwd())}`);
+                throw new Error(`Seeder class ${className} not found in ${fs.relativePath(path, process.cwd())}`);
             }
             await this.seed(seederClass);
         }
     }
-    async createSeeder(className) {
-        Utils.ensureDir(this.absolutePath);
-        return this.generate(className);
+    async create(className) {
+        await this.init();
+        const { fs } = await import('@mikro-orm/core/fs-utils');
+        fs.ensureDir(this.#absolutePath);
+        return this.generate(fs, className);
     }
-    async generate(className) {
-        const fileName = `${this.options.fileName(className)}.${this.options.emit}`;
-        const filePath = `${this.absolutePath}/${fileName}`;
+    async generate(fs, className) {
+        const fileName = `${this.#options.fileName(className)}.${this.#options.emit}`;
+        const filePath = `${this.#absolutePath}/${fileName}`;
         let ret = '';
-        if (this.options.emit === 'ts') {
+        if (this.#options.emit === 'ts') {
             ret += `import type { EntityManager } from '@mikro-orm/core';\n`;
             ret += `import { Seeder } from '@mikro-orm/seeder';\n\n`;
             ret += `export class ${className} extends Seeder {\n\n`;
@@ -72,7 +130,7 @@ export class SeedManager {
             ret += `}\n`;
             ret += `exports.${className} = ${className};\n`;
         }
-        await writeFile(filePath, ret, { flush: true });
+        await fs.writeFile(filePath, ret, { flush: true });
         return filePath;
     }
 }

package/package.json

@@ -1,63 +1,59 @@
 {
   "name": "@mikro-orm/seeder",
-  "type": "module",
-  "version": "7.0.0-dev.33",
+  "version": "7.0.0-dev.331",
   "description": "Seeder package for MikroORM.",
-  "exports": {
-    "./package.json": "./package.json",
-    ".": "./index.js"
-  },
-  "typings": "index.d.ts",
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
-  },
   "keywords": [
-    "orm",
+    "data-mapper",
+    "ddd",
+    "entity",
+    "identity-map",
+    "javascript",
+    "js",
+    "mariadb",
+    "mikro-orm",
     "mongo",
     "mongodb",
     "mysql",
-    "mariadb",
+    "orm",
     "postgresql",
+    "seeder",
     "sqlite",
     "sqlite3",
     "ts",
     "typescript",
-    "js",
-    "javascript",
-    "entity",
-    "ddd",
-    "mikro-orm",
-    "unit-of-work",
-    "data-mapper",
-    "identity-map",
-    "seeder"
+    "unit-of-work"
   ],
-  "author": "Wybren Kortstra",
-  "license": "MIT",
+  "homepage": "https://mikro-orm.io",
   "bugs": {
     "url": "https://github.com/mikro-orm/mikro-orm/issues"
   },
-  "homepage": "https://mikro-orm.io",
-  "engines": {
-    "node": ">= 22.11.0"
+  "license": "MIT",
+  "author": "Wybren Kortstra",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
   },
-  "scripts": {
-    "build": "yarn clean && yarn compile && yarn copy",
-    "clean": "yarn run -T rimraf ./dist",
-    "compile": "yarn run -T tsc -p tsconfig.build.json",
-    "copy": "node ../../scripts/copy.mjs"
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": "./index.js"
   },
   "publishConfig": {
     "access": "public"
   },
-  "dependencies": {
-    "tinyglobby": "0.2.13"
+  "scripts": {
+    "build": "yarn compile && yarn copy",
+    "clean": "yarn run -T rimraf ./dist",
+    "compile": "yarn run -T tsc -p tsconfig.build.json",
+    "copy": "node ../../scripts/copy.mjs"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^6.5.7"
+    "@mikro-orm/core": "^6.6.9"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.0-dev.33"
+    "@mikro-orm/core": "7.0.0-dev.331"
+  },
+  "engines": {
+    "node": ">= 22.17.0"
   }
 }