@yandjin-mikro-orm/migrations-mongodb 6.1.4-rc-sti-changes-1

package/JSMigrationGenerator.d.ts

@@ -0,0 +1,10 @@
+import { MigrationGenerator } from './MigrationGenerator';
+export declare class JSMigrationGenerator extends MigrationGenerator {
+    /**
+     * @inheritDoc
+     */
+    generateMigrationFile(className: string, diff: {
+        up: string[];
+        down: string[];
+    }): string;
+}

package/JSMigrationGenerator.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JSMigrationGenerator = void 0;
+const MigrationGenerator_1 = require("./MigrationGenerator");
+class JSMigrationGenerator extends MigrationGenerator_1.MigrationGenerator {
+    /**
+     * @inheritDoc
+     */
+    generateMigrationFile(className, diff) {
+        let ret = `'use strict';\n`;
+        ret += `Object.defineProperty(exports, '__esModule', { value: true });\n`;
+        ret += `const { Migration } = require('@mikro-orm/migrations-mongodb');\n\n`;
+        ret += `class ${className} extends Migration {\n\n`;
+        ret += `  async up() {\n`;
+        /* istanbul ignore next */
+        diff.up.forEach(sql => ret += this.createStatement(sql, 4));
+        ret += `  }\n\n`;
+        /* istanbul ignore next */
+        if (diff.down.length > 0) {
+            ret += `  async down() {\n`;
+            diff.down.forEach(sql => ret += this.createStatement(sql, 4));
+            ret += `  }\n\n`;
+        }
+        ret += `}\n`;
+        ret += `exports.${className} = ${className};\n`;
+        return ret;
+    }
+}
+exports.JSMigrationGenerator = JSMigrationGenerator;

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Martin Adámek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/Migration.d.ts

@@ -0,0 +1,15 @@
+import type { Configuration, Transaction, EntityName } from "@yandjin-mikro-orm/core";
+import type { MongoDriver } from "@yandjin-mikro-orm/mongodb";
+import type { Collection, ClientSession, Document } from "mongodb";
+export declare abstract class Migration {
+    protected readonly driver: MongoDriver;
+    protected readonly config: Configuration;
+    protected ctx?: Transaction<ClientSession>;
+    constructor(driver: MongoDriver, config: Configuration);
+    abstract up(): Promise<void>;
+    down(): Promise<void>;
+    isTransactional(): boolean;
+    reset(): void;
+    setTransactionContext(ctx: Transaction): void;
+    getCollection<T extends Document>(entityName: EntityName<any>): Collection<T>;
+}

package/Migration.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Migration = void 0;
+class Migration {
+    driver;
+    config;
+    ctx;
+    constructor(driver, config) {
+        this.driver = driver;
+        this.config = config;
+    }
+    async down() {
+        throw new Error("This migration cannot be reverted");
+    }
+    isTransactional() {
+        return true;
+    }
+    reset() {
+        this.ctx = undefined;
+    }
+    setTransactionContext(ctx) {
+        this.ctx = ctx;
+    }
+    getCollection(entityName) {
+        return this.driver.getConnection().getCollection(entityName);
+    }
+}
+exports.Migration = Migration;

package/MigrationGenerator.d.ts

@@ -0,0 +1,26 @@
+import { type IMigrationGenerator, type MigrationsOptions, type NamingStrategy } from "@yandjin-mikro-orm/core";
+import type { MongoDriver } from "@yandjin-mikro-orm/mongodb";
+export declare abstract class MigrationGenerator implements IMigrationGenerator {
+    protected readonly driver: MongoDriver;
+    protected readonly namingStrategy: NamingStrategy;
+    protected readonly options: MigrationsOptions;
+    constructor(driver: MongoDriver, namingStrategy: NamingStrategy, options: MigrationsOptions);
+    /**
+     * @inheritDoc
+     */
+    generate(diff: {
+        up: string[];
+        down: string[];
+    }, path?: string, name?: string): Promise<[string, string]>;
+    /**
+     * @inheritDoc
+     */
+    createStatement(query: string, padLeft: number): string;
+    /**
+     * @inheritDoc
+     */
+    abstract generateMigrationFile(className: string, diff: {
+        up: string[];
+        down: string[];
+    }): string;
+}

package/MigrationGenerator.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MigrationGenerator = void 0;
+const core_1 = require("@yandjin-mikro-orm/core");
+const fs_extra_1 = require("fs-extra");
+/* istanbul ignore next */
+class MigrationGenerator {
+    driver;
+    namingStrategy;
+    options;
+    constructor(driver, namingStrategy, options) {
+        this.driver = driver;
+        this.namingStrategy = namingStrategy;
+        this.options = options;
+    }
+    /**
+     * @inheritDoc
+     */
+    async generate(diff, path, name) {
+        /* istanbul ignore next */
+        const defaultPath = this.options.emit === "ts" && this.options.pathTs
+            ? this.options.pathTs
+            : this.options.path;
+        path = core_1.Utils.normalizePath(this.driver.config.get("baseDir"), path ?? defaultPath);
+        await (0, fs_extra_1.ensureDir)(path);
+        const timestamp = new Date().toISOString().replace(/[-T:]|\.\d{3}z$/gi, "");
+        const className = this.namingStrategy.classToMigrationName(timestamp, name);
+        const fileName = `${this.options.fileName(timestamp, name)}.${this.options.emit}`;
+        const ret = this.generateMigrationFile(className, diff);
+        await (0, fs_extra_1.writeFile)(path + "/" + fileName, ret, { flush: true });
+        return [ret, fileName];
+    }
+    /**
+     * @inheritDoc
+     */
+    createStatement(query, padLeft) {
+        if (query) {
+            const padding = " ".repeat(padLeft);
+            return `${padding}console.log('${query}');\n`;
+        }
+        return "\n";
+    }
+}
+exports.MigrationGenerator = MigrationGenerator;

package/MigrationRunner.d.ts

@@ -0,0 +1,13 @@
+import type { MigrationsOptions, Transaction } from "@yandjin-mikro-orm/core";
+import type { MongoDriver } from "@yandjin-mikro-orm/mongodb";
+import type { Migration } from "./Migration";
+export declare class MigrationRunner {
+    protected readonly driver: MongoDriver;
+    protected readonly options: MigrationsOptions;
+    private readonly connection;
+    private masterTransaction?;
+    constructor(driver: MongoDriver, options: MigrationsOptions);
+    run(migration: Migration, method: "up" | "down"): Promise<void>;
+    setMasterMigration(trx: Transaction): void;
+    unsetMasterMigration(): void;
+}

package/MigrationRunner.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MigrationRunner = void 0;
+class MigrationRunner {
+    driver;
+    options;
+    connection;
+    masterTransaction;
+    constructor(driver, options) {
+        this.driver = driver;
+        this.options = options;
+        this.connection = this.driver.getConnection();
+    }
+    async run(migration, method) {
+        migration.reset();
+        if (!this.options.transactional || !migration.isTransactional()) {
+            await migration[method]();
+        }
+        else if (this.masterTransaction) {
+            migration.setTransactionContext(this.masterTransaction);
+            await migration[method]();
+        }
+        else {
+            await this.connection.transactional(async (tx) => {
+                migration.setTransactionContext(tx);
+                await migration[method]();
+            }, { ctx: this.masterTransaction });
+        }
+    }
+    setMasterMigration(trx) {
+        this.masterTransaction = trx;
+    }
+    unsetMasterMigration() {
+        delete this.masterTransaction;
+    }
+}
+exports.MigrationRunner = MigrationRunner;

package/MigrationStorage.d.ts

@@ -0,0 +1,20 @@
+import type { MigrationsOptions, Transaction } from "@yandjin-mikro-orm/core";
+import type { MongoDriver } from "@yandjin-mikro-orm/mongodb";
+import type { MigrationParams, UmzugStorage } from "umzug";
+import type { MigrationRow } from "./typings";
+export declare class MigrationStorage implements UmzugStorage {
+    protected readonly driver: MongoDriver;
+    protected readonly options: MigrationsOptions;
+    private masterTransaction?;
+    constructor(driver: MongoDriver, options: MigrationsOptions);
+    executed(): Promise<string[]>;
+    logMigration(params: MigrationParams<any>): Promise<void>;
+    unlogMigration(params: MigrationParams<any>): Promise<void>;
+    getExecutedMigrations(): Promise<MigrationRow[]>;
+    setMasterMigration(trx: Transaction): void;
+    unsetMasterMigration(): void;
+    /**
+     * @internal
+     */
+    getMigrationName(name: string): string;
+}

package/MigrationStorage.js

@@ -0,0 +1,72 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MigrationStorage = void 0;
+const path = __importStar(require("path"));
+class MigrationStorage {
+    driver;
+    options;
+    masterTransaction;
+    constructor(driver, options) {
+        this.driver = driver;
+        this.options = options;
+    }
+    async executed() {
+        const migrations = await this.getExecutedMigrations();
+        return migrations.map(({ name }) => `${this.getMigrationName(name)}`);
+    }
+    async logMigration(params) {
+        const tableName = this.options.tableName;
+        const name = this.getMigrationName(params.name);
+        await this.driver.nativeInsert(tableName, { name, executed_at: new Date() }, { ctx: this.masterTransaction });
+    }
+    async unlogMigration(params) {
+        const tableName = this.options.tableName;
+        const withoutExt = this.getMigrationName(params.name);
+        await this.driver.nativeDelete(tableName, { name: { $in: [params.name, withoutExt] } }, { ctx: this.masterTransaction });
+    }
+    async getExecutedMigrations() {
+        const tableName = this.options.tableName;
+        return this.driver.find(tableName, {}, { ctx: this.masterTransaction, orderBy: { _id: "asc" } });
+    }
+    setMasterMigration(trx) {
+        this.masterTransaction = trx;
+    }
+    unsetMasterMigration() {
+        delete this.masterTransaction;
+    }
+    /**
+     * @internal
+     */
+    getMigrationName(name) {
+        const parsedName = path.parse(name);
+        if ([".js", ".ts"].includes(parsedName.ext)) {
+            // strip extension
+            return parsedName.name;
+        }
+        return name;
+    }
+}
+exports.MigrationStorage = MigrationStorage;

package/Migrator.d.ts

@@ -0,0 +1,56 @@
+import { type MigrationParams, type RunnableMigration } from "umzug";
+import { type Constructor, type IMigrator, type MikroORM } from "@yandjin-mikro-orm/core";
+import type { EntityManager } from "@yandjin-mikro-orm/mongodb";
+import type { Migration } from "./Migration";
+import { MigrationStorage } from "./MigrationStorage";
+import type { MigrateOptions, MigrationResult, MigrationRow, UmzugMigration } from "./typings";
+export declare class Migrator implements IMigrator {
+    private readonly em;
+    private umzug;
+    private runner;
+    private storage;
+    private generator;
+    private readonly driver;
+    private readonly config;
+    private readonly options;
+    private readonly absolutePath;
+    constructor(em: EntityManager);
+    static register(orm: MikroORM): void;
+    /**
+     * @inheritDoc
+     */
+    createMigration(path?: string, blank?: boolean, initial?: boolean, name?: string): Promise<MigrationResult>;
+    /**
+     * @inheritDoc
+     */
+    checkMigrationNeeded(): Promise<boolean>;
+    /**
+     * @inheritDoc
+     */
+    createInitialMigration(path?: string): Promise<MigrationResult>;
+    private createUmzug;
+    /**
+     * @inheritDoc
+     */
+    getExecutedMigrations(): Promise<MigrationRow[]>;
+    /**
+     * @inheritDoc
+     */
+    getPendingMigrations(): Promise<UmzugMigration[]>;
+    /**
+     * @inheritDoc
+     */
+    up(options?: string | string[] | MigrateOptions): Promise<UmzugMigration[]>;
+    /**
+     * @inheritDoc
+     */
+    down(options?: string | string[] | MigrateOptions): Promise<UmzugMigration[]>;
+    getStorage(): MigrationStorage;
+    protected resolve(params: MigrationParams<any>): RunnableMigration<any>;
+    protected initialize(MigrationClass: Constructor<Migration>, name: string): RunnableMigration<any>;
+    private getMigrationFilename;
+    private prefix;
+    private runMigrations;
+    private runInTransaction;
+    private ensureMigrationsDirExists;
+}

package/Migrator.js

@@ -0,0 +1,197 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Migrator = void 0;
+const umzug_1 = require("umzug");
+const path_1 = require("path");
+const fs_extra_1 = require("fs-extra");
+const core_1 = require("@yandjin-mikro-orm/core");
+const MigrationRunner_1 = require("./MigrationRunner");
+const MigrationStorage_1 = require("./MigrationStorage");
+const TSMigrationGenerator_1 = require("./TSMigrationGenerator");
+const JSMigrationGenerator_1 = require("./JSMigrationGenerator");
+class Migrator {
+    em;
+    umzug;
+    runner;
+    storage;
+    generator;
+    driver;
+    config;
+    options;
+    absolutePath;
+    constructor(em) {
+        this.em = em;
+        this.driver = this.em.getDriver();
+        this.config = this.em.config;
+        this.options = this.config.get("migrations");
+        /* istanbul ignore next */
+        const key = this.config.get("tsNode", core_1.Utils.detectTsNode()) && this.options.pathTs
+            ? "pathTs"
+            : "path";
+        this.absolutePath = core_1.Utils.absolutePath(this.options[key], this.config.get("baseDir"));
+        this.createUmzug();
+    }
+    static register(orm) {
+        orm.config.registerExtension("@mikro-orm/migrator", () => new Migrator(orm.em));
+    }
+    /**
+     * @inheritDoc
+     */
+    async createMigration(path, blank = false, initial = false, name) {
+        await this.ensureMigrationsDirExists();
+        const diff = { up: [], down: [] };
+        const migration = await this.generator.generate(diff, path, name);
+        return {
+            fileName: migration[1],
+            code: migration[0],
+            diff,
+        };
+    }
+    /**
+     * @inheritDoc
+     */
+    async checkMigrationNeeded() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    async createInitialMigration(path) {
+        return this.createMigration(path);
+    }
+    createUmzug() {
+        this.runner = new MigrationRunner_1.MigrationRunner(this.driver, this.options);
+        this.storage = new MigrationStorage_1.MigrationStorage(this.driver, this.options);
+        let migrations = {
+            glob: (0, path_1.join)(this.absolutePath, this.options.glob).replace(/\\/g, "/"),
+            resolve: (params) => this.resolve(params),
+        };
+        /* istanbul ignore next */
+        if (this.options.migrationsList) {
+            migrations = this.options.migrationsList.map((migration) => this.initialize(migration.class, migration.name));
+        }
+        this.umzug = new umzug_1.Umzug({
+            storage: this.storage,
+            logger: undefined,
+            migrations,
+        });
+        if (!this.options.silent) {
+            const logger = this.config.get("logger");
+            this.umzug.on("migrating", (event) => logger(`Processing '${event.name}'`));
+            this.umzug.on("migrated", (event) => logger(`Applied '${event.name}'`));
+            this.umzug.on("reverting", (event) => logger(`Processing '${event.name}'`));
+            this.umzug.on("reverted", (event) => logger(`Reverted '${event.name}'`));
+        }
+        /* istanbul ignore next */
+        if (this.options.generator) {
+            this.generator = new this.options.generator(this.driver, this.config.getNamingStrategy(), this.options);
+        }
+        else if (this.options.emit === "js" || this.options.emit === "cjs") {
+            this.generator = new JSMigrationGenerator_1.JSMigrationGenerator(this.driver, this.config.getNamingStrategy(), this.options);
+        }
+        else {
+            this.generator = new TSMigrationGenerator_1.TSMigrationGenerator(this.driver, this.config.getNamingStrategy(), this.options);
+        }
+    }
+    /**
+     * @inheritDoc
+     */
+    async getExecutedMigrations() {
+        await this.ensureMigrationsDirExists();
+        return this.storage.getExecutedMigrations();
+    }
+    /**
+     * @inheritDoc
+     */
+    async getPendingMigrations() {
+        await this.ensureMigrationsDirExists();
+        return this.umzug.pending();
+    }
+    /**
+     * @inheritDoc
+     */
+    async up(options) {
+        return this.runMigrations("up", options);
+    }
+    /**
+     * @inheritDoc
+     */
+    async down(options) {
+        return this.runMigrations("down", options);
+    }
+    getStorage() {
+        return this.storage;
+    }
+    resolve(params) {
+        const createMigrationHandler = async (method) => {
+            const migration = await core_1.Utils.dynamicImport(params.path);
+            const MigrationClass = Object.values(migration)[0];
+            const instance = new MigrationClass(this.driver, this.config);
+            await this.runner.run(instance, method);
+        };
+        return {
+            name: this.storage.getMigrationName(params.name),
+            up: () => createMigrationHandler("up"),
+            down: () => createMigrationHandler("down"),
+        };
+    }
+    /* istanbul ignore next */
+    initialize(MigrationClass, name) {
+        const instance = new MigrationClass(this.driver, this.config);
+        return {
+            name: this.storage.getMigrationName(name),
+            up: () => this.runner.run(instance, "up"),
+            down: () => this.runner.run(instance, "down"),
+        };
+    }
+    getMigrationFilename(name) {
+        name = name.replace(/\.[jt]s$/, "");
+        return name.match(/^\d{14}$/) ? this.options.fileName(name) : name;
+    }
+    prefix(options) {
+        if (core_1.Utils.isString(options) || Array.isArray(options)) {
+            return {
+                migrations: core_1.Utils.asArray(options).map((name) => this.getMigrationFilename(name)),
+            };
+        }
+        if (!options) {
+            return {};
+        }
+        if (options.migrations) {
+            options.migrations = options.migrations.map((name) => this.getMigrationFilename(name));
+        }
+        if (options.transaction) {
+            delete options.transaction;
+        }
+        ["from", "to"]
+            .filter((k) => options[k])
+            .forEach((k) => (options[k] = this.getMigrationFilename(options[k])));
+        return options;
+    }
+    async runMigrations(method, options) {
+        await this.ensureMigrationsDirExists();
+        if (!this.options.transactional || !this.options.allOrNothing) {
+            return this.umzug[method](this.prefix(options));
+        }
+        if (core_1.Utils.isObject(options) && options.transaction) {
+            return this.runInTransaction(options.transaction, method, options);
+        }
+        return this.driver
+            .getConnection()
+            .transactional((trx) => this.runInTransaction(trx, method, options));
+    }
+    async runInTransaction(trx, method, options) {
+        this.runner.setMasterMigration(trx);
+        this.storage.setMasterMigration(trx);
+        const ret = await this.umzug[method](this.prefix(options));
+        this.runner.unsetMasterMigration();
+        this.storage.unsetMasterMigration();
+        return ret;
+    }
+    async ensureMigrationsDirExists() {
+        if (!this.options.migrationsList) {
+            await (0, fs_extra_1.ensureDir)(this.absolutePath);
+        }
+    }
+}
+exports.Migrator = Migrator;

package/README.md

@@ -0,0 +1,383 @@
+<h1 align="center">
+  <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 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)
+[![Chat on slack](https://img.shields.io/badge/chat-on%20slack-blue.svg)](https://join.slack.com/t/mikroorm/shared_invite/enQtNTM1ODYzMzM4MDk3LWM4ZDExMjU5ZDhmNjA2MmM3MWMwZmExNjhhNDdiYTMwNWM0MGY5ZTE3ZjkyZTMzOWExNDgyYmMzNDE1NDI5NjA)
+[![Downloads](https://img.shields.io/npm/dm/@mikro-orm/core.svg)](https://www.npmjs.com/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)
+[![Maintainability](https://api.codeclimate.com/v1/badges/27999651d3adc47cfa40/maintainability)](https://codeclimate.com/github/mikro-orm/mikro-orm/maintainability)
+[![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)
+
+## 🤔 Unit of What?
+
+You might be asking: _What the hell is Unit of Work and why should I care about it?_
+
+> Unit of Work maintains a list of objects (_entities_) affected by a business transaction 
+> and coordinates the writing out of changes. [(Martin Fowler)](https://www.martinfowler.com/eaaCatalog/unitOfWork.html)
+
+> Identity Map ensures that each object (_entity_) gets loaded only once by keeping every 
+> loaded object in a map. Looks up objects using the map when referring to them. 
+> [(Martin Fowler)](https://www.martinfowler.com/eaaCatalog/identityMap.html)
+
+So what benefits does it bring to us?
+
+### Implicit Transactions
+
+First and most important implication of having Unit of Work is that it allows handling transactions automatically. 
+
+When you call `em.flush()`, all computed changes are queried inside a database transaction (if supported by given driver). This means that you can control the boundaries of transactions simply by calling `em.persistLater()` and once all your changes are ready, calling `flush()` will run them inside a transaction. 
+
+> You can also control the transaction boundaries manually via `em.transactional(cb)`.
+
+```typescript
+const user = await em.findOneOrFail(User, 1);
+user.email = 'foo@bar.com';
+const car = new Car();
+user.cars.add(car);
+
+// thanks to bi-directional cascading we only need to persist user entity
+// flushing will create a transaction, insert new car and update user with new email
+// as user entity is managed, calling flush() is enough
+await em.flush();
+```
+
+### ChangeSet based persistence
+
+MikroORM allows you to implement your domain/business logic directly in the entities. To maintain always valid entities, you can use constructors to mark required properties. Let's define the `User` entity used in previous example:
+
+```typescript
+@Entity()
+export class User {
+
+  @PrimaryKey()
+  id!: number;
+
+  @Property()
+  name!: string;
+
+  @OneToOne(() => Address)
+  address?: Address;
+
+  @ManyToMany(() => Car)
+  cars = new Collection<Car>(this);
+
+  constructor(name: string) {
+    this.name = name;
+  }
+
+}
+```
+
+Now to create new instance of the `User` entity, we are forced to provide the `name`:
+
+```typescript
+const user = new User('John Doe'); // name is required to create new user instance
+user.address = new Address('10 Downing Street'); // address is optional
+```
+
+Once your entities are loaded, make a number of synchronous actions on your entities,
+then call `em.flush()`. This will trigger computing of change sets. Only entities 
+(and properties) that were changed will generate database queries, if there are no changes, 
+no transaction will be started.
+
+```typescript
+const user = await em.findOneOrFail(User, 1, {
+  populate: ['cars', 'address.city'],
+});
+user.title = 'Mr.';
+user.address.street = '10 Downing Street'; // address is 1:1 relation of Address entity
+user.cars.getItems().forEach(car => car.forSale = true); // cars is 1:m collection of Car entities
+const car = new Car('VW');
+user.cars.add(car);
+
+// now we can flush all changes done to managed entities
+await em.flush();
+```
+
+`em.flush()` will then execute these queries from the example above:
+
+```sql
+begin;
+update "user" set "title" = 'Mr.' where "id" = 1;
+update "user_address" set "street" = '10 Downing Street' where "id" = 123;
+update "car"
+  set "for_sale" = case
+    when ("id" = 1) then true
+    when ("id" = 2) then true
+    when ("id" = 3) then true
+    else "for_sale" end
+  where "id" in (1, 2, 3)
+insert into "car" ("brand", "owner") values ('VW', 1);
+commit;
+```
+
+### Identity Map
+
+Thanks to Identity Map, you will always have only one instance of given entity in one context. This allows for some optimizations (skipping loading of already loaded entities), as well as comparison by identity (`ent1 === ent2`). 
+
+## 📖 Documentation
+
+MikroORM documentation, included in this repo in the root directory, is built with [Docusaurus](https://docusaurus.io) and publicly hosted on GitHub Pages at https://mikro-orm.io.
+
+There is also auto-generated [CHANGELOG.md](CHANGELOG.md) file based on commit messages (via `semantic-release`). 
+
+## ✨ Core Features
+
+- [Clean and Simple Entity Definition](https://mikro-orm.io/docs/defining-entities)
+- [Identity Map](https://mikro-orm.io/docs/identity-map)
+- [Entity References](https://mikro-orm.io/docs/entity-references)
+- [Using Entity Constructors](https://mikro-orm.io/docs/entity-constructors)
+- [Modelling Relationships](https://mikro-orm.io/docs/relationships)
+- [Collections](https://mikro-orm.io/docs/collections)
+- [Unit of Work](https://mikro-orm.io/docs/unit-of-work)
+- [Transactions](https://mikro-orm.io/docs/transactions)
+- [Cascading persist and remove](https://mikro-orm.io/docs/cascading)
+- [Composite and Foreign Keys as Primary Key](https://mikro-orm.io/docs/composite-keys)
+- [Filters](https://mikro-orm.io/docs/filters)
+- [Using `QueryBuilder`](https://mikro-orm.io/docs/query-builder)
+- [Preloading Deeply Nested Structures via populate](https://mikro-orm.io/docs/nested-populate)
+- [Property Validation](https://mikro-orm.io/docs/property-validation)
+- [Lifecycle Hooks](https://mikro-orm.io/docs/lifecycle-hooks)
+- [Vanilla JS Support](https://mikro-orm.io/docs/usage-with-js)
+- [Schema Generator](https://mikro-orm.io/docs/schema-generator)
+- [Entity Generator](https://mikro-orm.io/docs/entity-generator)
+
+## 📦 Example Integrations
+
+You can find example integrations for some popular frameworks in the [`mikro-orm-examples` repository](https://github.com/mikro-orm/mikro-orm-examples): 
+
+### TypeScript Examples
+
+- [Express + MongoDB](https://github.com/mikro-orm/express-ts-example-app)
+- [Nest + MySQL](https://github.com/mikro-orm/nestjs-example-app)
+- [RealWorld example app (Nest + MySQL)](https://github.com/mikro-orm/nestjs-realworld-example-app)
+- [Koa + SQLite](https://github.com/mikro-orm/koa-ts-example-app)
+- [GraphQL + PostgreSQL](https://github.com/driescroons/mikro-orm-graphql-example)
+- [Inversify + PostgreSQL](https://github.com/PodaruDragos/inversify-example-app)
+- [NextJS + MySQL](https://github.com/jonahallibone/mikro-orm-nextjs)
+- [Accounts.js REST and GraphQL authentication + SQLite](https://github.com/darkbasic/mikro-orm-accounts-example)
+- [Nest + Shopify + PostgreSQL + GraphQL](https://github.com/Cloudshelf/Shopify_CSConnector)
+
+### JavaScript Examples 
+
+- [Express + SQLite](https://github.com/mikro-orm/express-js-example-app)
+
+## 🚀 Quick Start
+
+First install the module via `yarn` or `npm` and do not forget to install the database driver as well:
+
+> Since v4, you should install the driver package, but not the db connector itself, e.g. install `@mikro-orm/sqlite`, but not `sqlite3` as that is already included in the driver package.
+
+```sh
+yarn add @mikro-orm/core @mikro-orm/mongodb     # for mongo
+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/sqlite      # for sqlite
+```
+
+or
+
+```sh
+npm i -s @mikro-orm/core @mikro-orm/mongodb     # for mongo
+npm i -s @mikro-orm/core @mikro-orm/mysql       # for mysql/mariadb
+npm i -s @mikro-orm/core @mikro-orm/mariadb     # for mysql/mariadb
+npm i -s @mikro-orm/core @mikro-orm/postgresql  # for postgresql
+npm i -s @mikro-orm/core @mikro-orm/sqlite      # for sqlite
+```
+
+Next, if you want to use decorators for your entity definition, you will need to enable support for [decorators](https://www.typescriptlang.org/docs/handbook/decorators.html) as well as `esModuleInterop` in `tsconfig.json` via:
+
+```json
+"experimentalDecorators": true,
+"emitDecoratorMetadata": true,
+"esModuleInterop": true,
+```
+
+Alternatively, you can use [`EntitySchema`](https://mikro-orm.io/docs/entity-schema).
+
+Then call `MikroORM.init` as part of bootstrapping your app:
+
+> To access driver specific methods like `em.createQueryBuilder()` we need to specify the driver type when calling `MikroORM.init()`. Alternatively we can cast the `orm.em` to `EntityManager` exported from the driver package:
+> 
+> ```ts
+> import { EntityManager } from '@mikro-orm/postgresql';
+> const em = orm.em as EntityManager;
+> const qb = em.createQueryBuilder(...);
+> ```
+
+```typescript
+import type { PostgreSqlDriver } from '@mikro-orm/postgresql'; // or any other SQL driver package
+
+const orm = await MikroORM.init<PostgreSqlDriver>({
+  entities: ['./dist/entities'], // path to your JS entities (dist), relative to `baseDir`
+  dbName: 'my-db-name',
+  type: 'postgresql',
+});
+console.log(orm.em); // access EntityManager via `em` property
+```
+
+There are more ways to configure your entities, take a look at [installation page](https://mikro-orm.io/docs/installation/).
+
+> Read more about all the possible configuration options in [Advanced Configuration](https://mikro-orm.io/docs/configuration) section.
+
+Then you will need to fork entity manager for each request so their [identity maps](https://mikro-orm.io/docs/identity-map/) will not collide. To do so, use the `RequestContext` helper:
+
+```typescript
+const app = express();
+
+app.use((req, res, next) => {
+  RequestContext.create(orm.em, next);
+});
+```
+
+> You should register this middleware as the last one just before request handlers and before any of your custom middleware that is using the ORM. There might be issues when you register it before request processing middleware like `queryParser` or `bodyParser`, so definitely register the context after them. 
+
+More info about `RequestContext` is described [here](https://mikro-orm.io/docs/identity-map/#request-context).
+
+Now you can start defining your entities (in one of the `entities` folders). This is how simple entity can look like in mongo driver:
+
+**`./entities/MongoBook.ts`**
+
+```typescript
+@Entity()
+export class MongoBook {
+
+  @PrimaryKey()
+  _id: ObjectID;
+
+  @SerializedPrimaryKey()
+  id: string;
+
+  @Property()
+  title: string;
+
+  @ManyToOne(() => Author)
+  author: Author;
+
+  @ManyToMany(() => BookTag)
+  tags = new Collection<BookTag>(this);
+
+  constructor(title: string, author: Author) {
+    this.title = title;
+    this.author = author;
+  }
+
+}
+```
+
+For SQL drivers, you can use `id: number` PK:
+
+**`./entities/SqlBook.ts`**
+
+```typescript
+@Entity()
+export class SqlBook {
+
+  @PrimaryKey()
+  id: number;
+
+}
+```
+
+Or if you want to use UUID primary keys:
+
+**`./entities/UuidBook.ts`**
+
+```typescript
+import { v4 } from 'uuid';
+
+@Entity()
+export class UuidBook {
+
+  @PrimaryKey()
+  uuid = v4();
+
+}
+```
+
+More information can be found in [defining entities section](https://mikro-orm.io/docs/defining-entities/) in docs.
+
+When you have your entities defined, you can start using ORM either via `EntityManager` or via `EntityRepository`s.
+
+To save entity state to database, you need to persist it. Persist takes care or deciding whether to use `insert` or `update` and computes appropriate change-set. Entity references that are not persisted yet (does not have identifier) will be cascade persisted automatically. 
+
+```typescript
+// use constructors in your entities for required parameters
+const author = new Author('Jon Snow', 'snow@wall.st');
+author.born = new Date();
+
+const publisher = new Publisher('7K publisher');
+
+const book1 = new Book('My Life on The Wall, part 1', author);
+book1.publisher = publisher;
+const book2 = new Book('My Life on The Wall, part 2', author);
+book2.publisher = publisher;
+const book3 = new Book('My Life on The Wall, part 3', author);
+book3.publisher = publisher;
+
+// just persist books, author and publisher will be automatically cascade persisted
+await em.persistAndFlush([book1, book2, book3]);
+```
+
+To fetch entities from database you can use `find()` and `findOne()` of `EntityManager`: 
+
+```typescript
+const authors = em.find(Author, {}, { populate: ['books'] });
+
+for (const author of authors) {
+  console.log(author); // instance of Author entity
+  console.log(author.name); // Jon Snow
+
+  for (const book of author.books) { // iterating books collection
+    console.log(book); // instance of Book entity
+    console.log(book.title); // My Life on The Wall, part 1/2/3
+  }
+}
+```
+
+More convenient way of fetching entities from database is by using `EntityRepository`, that carries the entity name, so you do not have to pass it to every `find` and `findOne` calls:
+
+```typescript
+const booksRepository = em.getRepository(Book);
+
+const books = await booksRepository.find({ author: '...' }, { 
+  populate: ['author'],
+  limit: 1,
+  offset: 2,
+  orderBy: { title: QueryOrder.DESC },
+});
+
+console.log(books); // Loaded<Book, 'author'>[]
+```
+
+Take a look at docs about [working with `EntityManager`](https://mikro-orm.io/docs/entity-manager/) or [using `EntityRepository` instead](https://mikro-orm.io/docs/repositories/).
+
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process for submitting pull requests to us.
+
+## Authors
+
+👤 **Martin Adámek**
+
+- Twitter: [@B4nan](https://twitter.com/B4nan)
+- Github: [@b4nan](https://github.com/b4nan)
+
+See also the list of contributors who [participated](https://github.com/mikro-orm/mikro-orm/contributors) in this project.
+
+## Show Your Support
+
+Please ⭐️ this repository if this project helped you!
+
+## 📝 License
+
+Copyright © 2018 [Martin Adámek](https://github.com/b4nan).
+
+This project is licensed under the MIT License - see the [LICENSE file](LICENSE) for details.

package/TSMigrationGenerator.d.ts

@@ -0,0 +1,10 @@
+import { MigrationGenerator } from "./MigrationGenerator";
+export declare class TSMigrationGenerator extends MigrationGenerator {
+    /**
+     * @inheritDoc
+     */
+    generateMigrationFile(className: string, diff: {
+        up: string[];
+        down: string[];
+    }): string;
+}

package/TSMigrationGenerator.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TSMigrationGenerator = void 0;
+const MigrationGenerator_1 = require("./MigrationGenerator");
+class TSMigrationGenerator extends MigrationGenerator_1.MigrationGenerator {
+    /**
+     * @inheritDoc
+     */
+    generateMigrationFile(className, diff) {
+        let ret = `import { Migration } from '@yandjin-mikro-orm/migrations-mongodb';\n\n`;
+        ret += `export class ${className} extends Migration {\n\n`;
+        ret += `  async up(): Promise<void> {\n`;
+        /* istanbul ignore next */
+        diff.up.forEach((sql) => (ret += this.createStatement(sql, 4)));
+        ret += `  }\n\n`;
+        /* istanbul ignore next */
+        if (diff.down.length > 0) {
+            ret += `  async down(): Promise<void> {\n`;
+            diff.down.forEach((sql) => (ret += this.createStatement(sql, 4)));
+            ret += `  }\n\n`;
+        }
+        ret += `}\n`;
+        return ret;
+    }
+}
+exports.TSMigrationGenerator = TSMigrationGenerator;

package/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @packageDocumentation
+ * @module migrations-mongodb
+ */
+export * from './Migrator';
+export * from './Migration';
+export * from './MigrationRunner';
+export * from './MigrationGenerator';
+export * from './JSMigrationGenerator';
+export * from './TSMigrationGenerator';
+export * from './MigrationStorage';
+export * from './typings';

package/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * @packageDocumentation
+ * @module migrations-mongodb
+ */
+__exportStar(require("./Migrator"), exports);
+__exportStar(require("./Migration"), exports);
+__exportStar(require("./MigrationRunner"), exports);
+__exportStar(require("./MigrationGenerator"), exports);
+__exportStar(require("./JSMigrationGenerator"), exports);
+__exportStar(require("./TSMigrationGenerator"), exports);
+__exportStar(require("./MigrationStorage"), exports);
+__exportStar(require("./typings"), exports);

package/index.mjs

@@ -0,0 +1,10 @@
+import mod from "./index.js";
+
+export default mod;
+export const JSMigrationGenerator = mod.JSMigrationGenerator;
+export const Migration = mod.Migration;
+export const MigrationGenerator = mod.MigrationGenerator;
+export const MigrationRunner = mod.MigrationRunner;
+export const MigrationStorage = mod.MigrationStorage;
+export const Migrator = mod.Migrator;
+export const TSMigrationGenerator = mod.TSMigrationGenerator;

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@yandjin-mikro-orm/migrations-mongodb",
+  "version": "6.1.4-rc-sti-changes-1",
+  "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.",
+  "main": "index.js",
+  "module": "index.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "types": "./index.d.ts",
+        "default": "./index.mjs"
+      },
+      "require": "./index.js"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
+  },
+  "keywords": [
+    "orm",
+    "mongo",
+    "mongodb",
+    "mysql",
+    "mariadb",
+    "postgresql",
+    "sqlite",
+    "sqlite3",
+    "ts",
+    "typescript",
+    "js",
+    "javascript",
+    "entity",
+    "ddd",
+    "mikro-orm",
+    "unit-of-work",
+    "data-mapper",
+    "identity-map"
+  ],
+  "author": "Martin Adámek",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/mikro-orm/mikro-orm/issues"
+  },
+  "homepage": "https://mikro-orm.io",
+  "engines": {
+    "node": ">= 18.12.0"
+  },
+  "scripts": {
+    "build": "yarn clean && yarn compile && yarn copy && yarn run -T gen-esm-wrapper index.js index.mjs",
+    "clean": "yarn run -T rimraf ./dist",
+    "compile": "yarn run -T tsc -p tsconfig.build.json",
+    "copy": "node ../../scripts/copy.mjs"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@yandjin-mikro-orm/mongodb": "6.1.4-rc-sti-changes-1",
+    "fs-extra": "11.2.0",
+    "mongodb": "6.3.0",
+    "umzug": "3.7.0"
+  },
+  "devDependencies": {
+    "@yandjin-mikro-orm/core": "^6.1.4-rc-sti-changes-1"
+  },
+  "peerDependencies": {
+    "@yandjin-mikro-orm/core": "^6.0.0"
+  }
+}

package/typings.d.ts

@@ -0,0 +1 @@
+export { UmzugMigration, MigrateOptions, MigrationResult, MigrationRow, } from "@yandjin-mikro-orm/core";

package/typings.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });