@mikro-orm/migrations 7.0.2-dev.13 → 7.0.2-dev.14

package/JSMigrationGenerator.d.ts

@@ -1,4 +1,5 @@
 import { MigrationGenerator } from './MigrationGenerator.js';
+/** Generates migration files in CommonJS JavaScript format. */
 export declare class JSMigrationGenerator extends MigrationGenerator {
     /**
      * @inheritDoc

package/JSMigrationGenerator.js

@@ -1,4 +1,5 @@
 import { MigrationGenerator } from './MigrationGenerator.js';
+/** Generates migration files in CommonJS JavaScript format. */
 export class JSMigrationGenerator extends MigrationGenerator {
     /**
      * @inheritDoc

package/Migration.d.ts

@@ -1,6 +1,8 @@
 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;

package/Migration.js

@@ -1,3 +1,4 @@
+/** Base class for SQL database migrations. Extend this class and implement `up()` (and optionally `down()`). */
 export class Migration {
     driver;
     config;

package/MigrationGenerator.d.ts

@@ -1,5 +1,6 @@
 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;

package/MigrationGenerator.js

@@ -1,3 +1,4 @@
+/** Base class for generating migration source files from schema diffs. */
 export class MigrationGenerator {
     driver;
     namingStrategy;

package/MigrationRunner.d.ts

@@ -1,6 +1,7 @@
 import { type Configuration, type MigrationsOptions, type Transaction } from '@mikro-orm/core';
 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;

package/MigrationRunner.js

@@ -1,4 +1,5 @@
 import { Utils } from '@mikro-orm/core';
+/** Executes individual migration files within optional transaction contexts. */
 export class MigrationRunner {
     driver;
     options;

package/MigrationStorage.d.ts

@@ -1,6 +1,7 @@
 import { type MigrationsOptions, type Transaction, type EntitySchema } from '@mikro-orm/core';
 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;

package/MigrationStorage.js

@@ -1,5 +1,6 @@
 import { defineEntity, p } from '@mikro-orm/core';
 import { DatabaseTable, } from '@mikro-orm/sql';
+/** Tracks executed migrations in a database table. */
 export class MigrationStorage {
     driver;
     options;

package/Migrator.d.ts

@@ -3,6 +3,7 @@ import { AbstractMigrator } from '@mikro-orm/core/migrations';
 import { type AbstractSqlDriver, DatabaseSchema, type EntityManager } from '@mikro-orm/sql';
 import { MigrationStorage } from './MigrationStorage.js';
 import type { MigrationResult } from './typings.js';
+/** Manages SQL database migrations: creation, execution, and rollback of schema changes. */
 export declare class Migrator extends AbstractMigrator<AbstractSqlDriver> {
     #private;
     constructor(em: EntityManager);

package/Migrator.js

@@ -5,6 +5,7 @@ import { MigrationRunner } from './MigrationRunner.js';
 import { MigrationStorage } from './MigrationStorage.js';
 import { TSMigrationGenerator } from './TSMigrationGenerator.js';
 import { JSMigrationGenerator } from './JSMigrationGenerator.js';
+/** Manages SQL database migrations: creation, execution, and rollback of schema changes. */
 export class Migrator extends AbstractMigrator {
     #schemaGenerator;
     #snapshotPath;

package/TSMigrationGenerator.d.ts

@@ -1,4 +1,5 @@
 import { MigrationGenerator } from './MigrationGenerator.js';
+/** Generates migration files in TypeScript format. */
 export declare class TSMigrationGenerator extends MigrationGenerator {
     /**
      * @inheritDoc

package/TSMigrationGenerator.js

@@ -1,4 +1,5 @@
 import { MigrationGenerator } from './MigrationGenerator.js';
+/** Generates migration files in TypeScript format. */
 export class TSMigrationGenerator extends MigrationGenerator {
     /**
      * @inheritDoc

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/migrations",
-  "version": "7.0.2-dev.13",
+  "version": "7.0.2-dev.14",
   "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.",
   "keywords": [
     "data-mapper",
@@ -47,13 +47,13 @@
     "copy": "node ../../scripts/copy.mjs"
   },
   "dependencies": {
-    "@mikro-orm/sql": "7.0.2-dev.13"
+    "@mikro-orm/sql": "7.0.2-dev.14"
   },
   "devDependencies": {
     "@mikro-orm/core": "^7.0.1"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.2-dev.13"
+    "@mikro-orm/core": "7.0.2-dev.14"
   },
   "engines": {
     "node": ">= 22.17.0"