@mikro-orm/migrations 7.0.4 → 7.0.5-dev.0

package/JSMigrationGenerator.d.ts

@@ -1,14 +1,11 @@
 import { MigrationGenerator } from './MigrationGenerator.js';
 /** Generates migration files in CommonJS JavaScript format. */
 export declare class JSMigrationGenerator extends MigrationGenerator {
-  /**
-   * @inheritDoc
-   */
-  generateMigrationFile(
-    className: string,
-    diff: {
-      up: string[];
-      down: string[];
-    },
-  ): string;
+    /**
+     * @inheritDoc
+     */
+    generateMigrationFile(className: string, diff: {
+        up: string[];
+        down: string[];
+    }): string;
 }

package/JSMigrationGenerator.js

@@ -1,25 +1,25 @@
 import { MigrationGenerator } from './MigrationGenerator.js';
 /** Generates migration files in CommonJS JavaScript format. */
 export class JSMigrationGenerator extends 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');\n\n`;
-    ret += `class ${className} extends Migration {\n\n`;
-    ret += `  async up() {\n`;
-    diff.up.forEach(sql => (ret += this.createStatement(sql, 4)));
-    ret += `  }\n\n`;
-    /* v8 ignore next */
-    if (diff.down.length > 0) {
-      ret += `  async down() {\n`;
-      diff.down.forEach(sql => (ret += this.createStatement(sql, 4)));
-      ret += `  }\n\n`;
+    /**
+     * @inheritDoc
+     */
+    generateMigrationFile(className, diff) {
+        let ret = `'use strict';\n`;
+        ret += `Object.defineProperty(exports, '__esModule', { value: true });\n`;
+        ret += `const { Migration } = require('@mikro-orm/migrations');\n\n`;
+        ret += `class ${className} extends Migration {\n\n`;
+        ret += `  async up() {\n`;
+        diff.up.forEach(sql => (ret += this.createStatement(sql, 4)));
+        ret += `  }\n\n`;
+        /* v8 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;
     }
-    ret += `}\n`;
-    ret += `exports.${className} = ${className};\n`;
-    return ret;
-  }
 }

package/Migration.d.ts

@@ -1,35 +1,29 @@
-import {
-  type AnyEntity,
-  type Configuration,
-  type EntityData,
-  type RawQueryFragment,
-  type Transaction,
-} from '@mikro-orm/core';
+import { type AnyEntity, type Configuration, type EntityData, type RawQueryFragment, type Transaction } from '@mikro-orm/core';
 import type { AbstractSqlDriver, EntityManager, NativeQueryBuilder } from '@mikro-orm/sql';
 /** A migration query: raw SQL string, a native query builder instance, or a `raw()` SQL fragment. */
 export type Query = string | NativeQueryBuilder | RawQueryFragment;
 /** Base class for SQL database migrations. Extend this class and implement `up()` (and optionally `down()`). */
 export declare abstract class Migration {
-  #private;
-  protected readonly driver: AbstractSqlDriver;
-  protected readonly config: Configuration;
-  protected ctx?: Transaction;
-  constructor(driver: AbstractSqlDriver, config: Configuration);
-  abstract up(): Promise<void> | void;
-  down(): Promise<void> | void;
-  isTransactional(): boolean;
-  addSql(sql: Query): void;
-  reset(): void;
-  setTransactionContext(ctx: Transaction): void;
-  /**
-   * Executes a raw SQL query. Accepts a string SQL, `raw()` SQL fragment, or a native query builder instance.
-   * The `params` parameter is respected only if you use string SQL in the first parameter.
-   */
-  execute(sql: Query, params?: unknown[]): Promise<EntityData<AnyEntity>[]>;
-  /**
-   * Creates a cached `EntityManager` instance for this migration, which will respect
-   * the current transaction context.
-   */
-  getEntityManager(): EntityManager;
-  getQueries(): Query[];
+    #private;
+    protected readonly driver: AbstractSqlDriver;
+    protected readonly config: Configuration;
+    protected ctx?: Transaction;
+    constructor(driver: AbstractSqlDriver, config: Configuration);
+    abstract up(): Promise<void> | void;
+    down(): Promise<void> | void;
+    isTransactional(): boolean;
+    addSql(sql: Query): void;
+    reset(): void;
+    setTransactionContext(ctx: Transaction): void;
+    /**
+     * Executes a raw SQL query. Accepts a string SQL, `raw()` SQL fragment, or a native query builder instance.
+     * The `params` parameter is respected only if you use string SQL in the first parameter.
+     */
+    execute(sql: Query, params?: unknown[]): Promise<EntityData<AnyEntity>[]>;
+    /**
+     * Creates a cached `EntityManager` instance for this migration, which will respect
+     * the current transaction context.
+     */
+    getEntityManager(): EntityManager;
+    getQueries(): Query[];
 }

package/Migration.js

@@ -1,49 +1,49 @@
 /** Base class for SQL database migrations. Extend this class and implement `up()` (and optionally `down()`). */
 export class Migration {
-  driver;
-  config;
-  #queries = [];
-  ctx;
-  #em;
-  constructor(driver, config) {
-    this.driver = driver;
-    this.config = config;
-  }
-  down() {
-    throw new Error('This migration cannot be reverted');
-  }
-  isTransactional() {
-    return true;
-  }
-  addSql(sql) {
-    this.#queries.push(sql);
-  }
-  reset() {
-    this.#queries.length = 0;
-    this.ctx = undefined;
-  }
-  setTransactionContext(ctx) {
-    this.ctx = ctx;
-  }
-  /**
-   * Executes a raw SQL query. Accepts a string SQL, `raw()` SQL fragment, or a native query builder instance.
-   * The `params` parameter is respected only if you use string SQL in the first parameter.
-   */
-  async execute(sql, params) {
-    return this.driver.execute(sql, params, 'all', this.ctx);
-  }
-  /**
-   * Creates a cached `EntityManager` instance for this migration, which will respect
-   * the current transaction context.
-   */
-  getEntityManager() {
-    if (!this.#em) {
-      this.#em = this.driver.createEntityManager();
-      this.#em.setTransactionContext(this.ctx);
-    }
-    return this.#em;
-  }
-  getQueries() {
-    return this.#queries;
-  }
+    driver;
+    config;
+    #queries = [];
+    ctx;
+    #em;
+    constructor(driver, config) {
+        this.driver = driver;
+        this.config = config;
+    }
+    down() {
+        throw new Error('This migration cannot be reverted');
+    }
+    isTransactional() {
+        return true;
+    }
+    addSql(sql) {
+        this.#queries.push(sql);
+    }
+    reset() {
+        this.#queries.length = 0;
+        this.ctx = undefined;
+    }
+    setTransactionContext(ctx) {
+        this.ctx = ctx;
+    }
+    /**
+     * Executes a raw SQL query. Accepts a string SQL, `raw()` SQL fragment, or a native query builder instance.
+     * The `params` parameter is respected only if you use string SQL in the first parameter.
+     */
+    async execute(sql, params) {
+        return this.driver.execute(sql, params, 'all', this.ctx);
+    }
+    /**
+     * Creates a cached `EntityManager` instance for this migration, which will respect
+     * the current transaction context.
+     */
+    getEntityManager() {
+        if (!this.#em) {
+            this.#em = this.driver.createEntityManager();
+            this.#em.setTransactionContext(this.ctx);
+        }
+        return this.#em;
+    }
+    getQueries() {
+        return this.#queries;
+    }
 }

package/MigrationGenerator.d.ts

@@ -1,39 +1,27 @@
-import {
-  type IMigrationGenerator,
-  type MaybePromise,
-  type MigrationsOptions,
-  type NamingStrategy,
-} from '@mikro-orm/core';
+import { type IMigrationGenerator, type MaybePromise, type MigrationsOptions, type NamingStrategy } from '@mikro-orm/core';
 import type { AbstractSqlDriver } from '@mikro-orm/sql';
 /** Base class for generating migration source files from schema diffs. */
 export declare abstract class MigrationGenerator implements IMigrationGenerator {
-  protected readonly driver: AbstractSqlDriver;
-  protected readonly namingStrategy: NamingStrategy;
-  protected readonly options: MigrationsOptions;
-  constructor(driver: AbstractSqlDriver, namingStrategy: NamingStrategy, options: MigrationsOptions);
-  /**
-   * @inheritDoc
-   */
-  generate(
-    diff: {
-      up: string[];
-      down: string[];
-    },
-    path?: string,
-    name?: string,
-  ): Promise<[string, string]>;
-  /**
-   * @inheritDoc
-   */
-  createStatement(sql: string, padLeft: number): string;
-  /**
-   * @inheritDoc
-   */
-  abstract generateMigrationFile(
-    className: string,
-    diff: {
-      up: string[];
-      down: string[];
-    },
-  ): MaybePromise<string>;
+    protected readonly driver: AbstractSqlDriver;
+    protected readonly namingStrategy: NamingStrategy;
+    protected readonly options: MigrationsOptions;
+    constructor(driver: AbstractSqlDriver, namingStrategy: NamingStrategy, options: MigrationsOptions);
+    /**
+     * @inheritDoc
+     */
+    generate(diff: {
+        up: string[];
+        down: string[];
+    }, path?: string, name?: string): Promise<[string, string]>;
+    /**
+     * @inheritDoc
+     */
+    createStatement(sql: string, padLeft: number): string;
+    /**
+     * @inheritDoc
+     */
+    abstract generateMigrationFile(className: string, diff: {
+        up: string[];
+        down: string[];
+    }): MaybePromise<string>;
 }

package/MigrationGenerator.js

@@ -1,37 +1,37 @@
 /** Base class for generating migration source files from schema diffs. */
 export class MigrationGenerator {
-  driver;
-  namingStrategy;
-  options;
-  constructor(driver, namingStrategy, options) {
-    this.driver = driver;
-    this.namingStrategy = namingStrategy;
-    this.options = options;
-  }
-  /**
-   * @inheritDoc
-   */
-  async generate(diff, path, name) {
-    const { fs } = await import('@mikro-orm/core/fs-utils');
-    /* v8 ignore next */
-    const defaultPath = this.options.emit === 'ts' && this.options.pathTs ? this.options.pathTs : this.options.path;
-    path = fs.normalizePath(this.driver.config.get('baseDir'), path ?? defaultPath);
-    fs.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 = await this.generateMigrationFile(className, diff);
-    await fs.writeFile(path + '/' + fileName, ret, { flush: true });
-    return [ret, fileName];
-  }
-  /**
-   * @inheritDoc
-   */
-  createStatement(sql, padLeft) {
-    if (sql) {
-      const padding = ' '.repeat(padLeft);
-      return `${padding}this.addSql(\`${sql.replace(/[`$\\]/g, '\\$&')}\`);\n`;
+    driver;
+    namingStrategy;
+    options;
+    constructor(driver, namingStrategy, options) {
+        this.driver = driver;
+        this.namingStrategy = namingStrategy;
+        this.options = options;
+    }
+    /**
+     * @inheritDoc
+     */
+    async generate(diff, path, name) {
+        const { fs } = await import('@mikro-orm/core/fs-utils');
+        /* v8 ignore next */
+        const defaultPath = this.options.emit === 'ts' && this.options.pathTs ? this.options.pathTs : this.options.path;
+        path = fs.normalizePath(this.driver.config.get('baseDir'), path ?? defaultPath);
+        fs.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 = await this.generateMigrationFile(className, diff);
+        await fs.writeFile(path + '/' + fileName, ret, { flush: true });
+        return [ret, fileName];
+    }
+    /**
+     * @inheritDoc
+     */
+    createStatement(sql, padLeft) {
+        if (sql) {
+            const padding = ' '.repeat(padLeft);
+            return `${padding}this.addSql(\`${sql.replace(/[`$\\]/g, '\\$&')}\`);\n`;
+        }
+        return '\n';
     }
-    return '\n';
-  }
 }

package/MigrationRunner.d.ts

@@ -3,13 +3,13 @@ import type { AbstractSqlDriver } from '@mikro-orm/sql';
 import type { Migration } from './Migration.js';
 /** Executes individual migration files within optional transaction contexts. */
 export declare class MigrationRunner {
-  #private;
-  protected readonly driver: AbstractSqlDriver;
-  protected readonly options: MigrationsOptions;
-  protected readonly config: Configuration;
-  constructor(driver: AbstractSqlDriver, options: MigrationsOptions, config: Configuration);
-  run(migration: Migration, method: 'up' | 'down'): Promise<void>;
-  setMasterMigration(trx: Transaction): void;
-  unsetMasterMigration(): void;
-  private getQueries;
+    #private;
+    protected readonly driver: AbstractSqlDriver;
+    protected readonly options: MigrationsOptions;
+    protected readonly config: Configuration;
+    constructor(driver: AbstractSqlDriver, options: MigrationsOptions, config: Configuration);
+    run(migration: Migration, method: 'up' | 'down'): Promise<void>;
+    setMasterMigration(trx: Transaction): void;
+    unsetMasterMigration(): void;
+    private getQueries;
 }

package/MigrationRunner.js

@@ -1,48 +1,46 @@
 import { Utils } from '@mikro-orm/core';
 /** Executes individual migration files within optional transaction contexts. */
 export class MigrationRunner {
-  driver;
-  options;
-  config;
-  #connection;
-  #helper;
-  #masterTransaction;
-  constructor(driver, options, config) {
-    this.driver = driver;
-    this.options = options;
-    this.config = config;
-    this.#connection = this.driver.getConnection();
-    this.#helper = this.driver.getPlatform().getSchemaHelper();
-  }
-  async run(migration, method) {
-    migration.reset();
-    if (!this.options.transactional || !migration.isTransactional()) {
-      const queries = await this.getQueries(migration, method);
-      await Utils.runSerial(queries, sql => this.driver.execute(sql));
-    } else {
-      await this.#connection.transactional(
-        async tx => {
-          migration.setTransactionContext(tx);
-          const queries = await this.getQueries(migration, method);
-          await Utils.runSerial(queries, sql => this.driver.execute(sql, undefined, 'all', tx));
-        },
-        { ctx: this.#masterTransaction },
-      );
+    driver;
+    options;
+    config;
+    #connection;
+    #helper;
+    #masterTransaction;
+    constructor(driver, options, config) {
+        this.driver = driver;
+        this.options = options;
+        this.config = config;
+        this.#connection = this.driver.getConnection();
+        this.#helper = this.driver.getPlatform().getSchemaHelper();
+    }
+    async run(migration, method) {
+        migration.reset();
+        if (!this.options.transactional || !migration.isTransactional()) {
+            const queries = await this.getQueries(migration, method);
+            await Utils.runSerial(queries, sql => this.driver.execute(sql));
+        }
+        else {
+            await this.#connection.transactional(async (tx) => {
+                migration.setTransactionContext(tx);
+                const queries = await this.getQueries(migration, method);
+                await Utils.runSerial(queries, sql => this.driver.execute(sql, undefined, 'all', tx));
+            }, { ctx: this.#masterTransaction });
+        }
+    }
+    setMasterMigration(trx) {
+        this.#masterTransaction = trx;
+    }
+    unsetMasterMigration() {
+        this.#masterTransaction = undefined;
+    }
+    async getQueries(migration, method) {
+        await migration[method]();
+        const charset = this.config.get('charset');
+        let queries = migration.getQueries();
+        queries.unshift(...this.#helper.getSchemaBeginning(charset, this.options.disableForeignKeys).split('\n'));
+        queries.push(...this.#helper.getSchemaEnd(this.options.disableForeignKeys).split('\n'));
+        queries = queries.filter(sql => typeof sql !== 'string' || sql.trim().length > 0);
+        return queries;
     }
-  }
-  setMasterMigration(trx) {
-    this.#masterTransaction = trx;
-  }
-  unsetMasterMigration() {
-    this.#masterTransaction = undefined;
-  }
-  async getQueries(migration, method) {
-    await migration[method]();
-    const charset = this.config.get('charset');
-    let queries = migration.getQueries();
-    queries.unshift(...this.#helper.getSchemaBeginning(charset, this.options.disableForeignKeys).split('\n'));
-    queries.push(...this.#helper.getSchemaEnd(this.options.disableForeignKeys).split('\n'));
-    queries = queries.filter(sql => typeof sql !== 'string' || sql.trim().length > 0);
-    return queries;
-  }
 }

package/MigrationStorage.d.ts

@@ -3,27 +3,31 @@ import { type AbstractSqlDriver } from '@mikro-orm/sql';
 import type { MigrationRow } from './typings.js';
 /** Tracks executed migrations in a database table. */
 export declare class MigrationStorage {
-  #private;
-  protected readonly driver: AbstractSqlDriver;
-  protected readonly options: MigrationsOptions;
-  constructor(driver: AbstractSqlDriver, options: MigrationsOptions);
-  executed(): Promise<string[]>;
-  logMigration(params: { name: string }): Promise<void>;
-  unlogMigration(params: { name: string }): Promise<void>;
-  getExecutedMigrations(): Promise<MigrationRow[]>;
-  ensureTable(): Promise<void>;
-  setMasterMigration(trx: Transaction): void;
-  unsetMasterMigration(): void;
-  /**
-   * @internal
-   */
-  getMigrationName(name: string): string;
-  /**
-   * @internal
-   */
-  getTableName(): {
-    tableName: string;
-    schemaName: string;
-    entity: EntitySchema;
-  };
+    #private;
+    protected readonly driver: AbstractSqlDriver;
+    protected readonly options: MigrationsOptions;
+    constructor(driver: AbstractSqlDriver, options: MigrationsOptions);
+    executed(): Promise<string[]>;
+    logMigration(params: {
+        name: string;
+    }): Promise<void>;
+    unlogMigration(params: {
+        name: string;
+    }): Promise<void>;
+    getExecutedMigrations(): Promise<MigrationRow[]>;
+    ensureTable(): Promise<void>;
+    setMasterMigration(trx: Transaction): void;
+    unsetMasterMigration(): void;
+    /**
+     * @internal
+     */
+    getMigrationName(name: string): string;
+    /**
+     * @internal
+     */
+    getTableName(): {
+        tableName: string;
+        schemaName: string;
+        entity: EntitySchema;
+    };
 }