rake-db 2.16.0 → 2.17.1

package/dist/index.d.ts

@@ -986,6 +986,25 @@ declare namespace RakeDbAst {
     }
 }
 
+interface RakeDbCtx {
+    migrationsPromise?: Promise<MigrationsSet>;
+}
+
+interface MigrationItem {
+    path: string;
+    version: string;
+    /**
+     * Function that loads the migration content,
+     * can store lazy import of a migration file.
+     * Promise can return `{ default: x }` where `x` is a return of `change` or an array of such returns.
+     */
+    load(): Promise<unknown>;
+}
+interface MigrationsSet {
+    renameTo?: RakeDbMigrationId;
+    migrations: MigrationItem[];
+}
+
 interface RakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT = DefaultColumnTypes<DefaultSchemaConfig>> extends QueryLogOptions {
     schemaConfig: SchemaConfig;
     columnTypes: CT;
@@ -1005,12 +1024,13 @@ interface RakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT = DefaultColu
     useCodeUpdater?: boolean;
     forceDefaultExports?: boolean;
     import(path: string): Promise<unknown>;
-    beforeChange?(db: Db, up: boolean, redo: boolean): void | Promise<void>;
-    afterChange?(db: Db, up: boolean, redo: boolean): void | Promise<void>;
-    beforeMigrate?(db: Db): void | Promise<void>;
-    afterMigrate?(db: Db): void | Promise<void>;
-    beforeRollback?(db: Db): void | Promise<void>;
-    afterRollback?(db: Db): void | Promise<void>;
+    beforeChange?: ChangeCallback$1;
+    afterChange?: ChangeCallback$1;
+    afterChangeCommit?: ChangeCommitCallback;
+    beforeMigrate?: MigrationCallback;
+    afterMigrate?: MigrationCallback;
+    beforeRollback?: MigrationCallback;
+    afterRollback?: MigrationCallback;
 }
 interface InputRakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT> extends QueryLogOptions {
     columnTypes?: CT | ((t: DefaultColumnTypes<DefaultSchemaConfig>) => CT);
@@ -1032,46 +1052,78 @@ interface InputRakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT> extends
     forceDefaultExports?: boolean;
     import?(path: string): Promise<unknown>;
     /**
-     * Is called once before migrating (up) or rolling back one or more migrations.
+     * Is called once per db before migrating or rolling back a set of migrations.
      *
-     * @param db - query builder
-     * @param up - whether it's migrating up or down
-     * @param redo - whether it's migrating down and then up for `redo` command
+     * @param arg.db - query builder
+     * @param arg.up - whether it's migrating up or down
+     * @param arg.redo - whether it's migrating down and then up for `redo` command
+     * @param arg.migrations - array of executed (up or down) migrations
+     */
+    beforeChange?: ChangeCallback$1;
+    /**
+     * Is called once per db after migrating or rolling back a set of migrations.
+     * Runs inside the same transaction as migrations,
+     * for running after commit use {@link afterChangeCommit}.
+     *
+     * @param arg.db - query builder
+     * @param arg.up - whether it's migrating up or down
+     * @param arg.redo - whether it's migrating down and then up for `redo` command
+     * @param arg.migrations - array of executed (up or down) migrations
      */
-    beforeChange?(db: Db, up: boolean, redo: boolean): void | Promise<void>;
+    afterChange?: ChangeCallback$1;
     /**
-     * Is called once after migrating (up) or rolling back one or more migrations.
+     * Is called once per db after migrating or rolling back a set of migrations.
+     * Runs **after** committing migrations transaction.
      *
-     * @param db - query builder
-     * @param up - whether it's migrating up or down
-     * @param redo - whether it's migrating down and then up for `redo` command
+     * @param arg.options - database connection options
+     * @param arg.up - whether it's migrating up or down
+     * @param arg.migrations - array of executed (up or down) migrations
      */
-    afterChange?(db: Db, up: boolean, redo: boolean): void | Promise<void>;
+    afterChangeCommit?: ChangeCommitCallback;
     /**
-     * Is called once before migrating (up) one or more migrations.
+     * Is called once per db before migrating (up) a set of migrations.
      *
-     * @param db - query builder
+     * @param arg.db - query builder
+     * @param arg.migrations - applied migrations
      */
-    beforeMigrate?(db: Db): void | Promise<void>;
+    beforeMigrate?: MigrationCallback;
     /**
-     * Is called once after migrating (up) one or more migrations.
+     * Is called once per db after migrating (up) a set of migrations.
      *
-     * @param db - query builder
+     * @param arg.db - query builder
+     * @param arg.migrations - applied migrations
      */
-    afterMigrate?(db: Db): void | Promise<void>;
+    afterMigrate?: MigrationCallback;
     /**
-     * Is called once before rolling back one or more migrations.
+     * Is called once per db before rolling back a set of migrations.
      *
-     * @param db - query builder
+     * @param arg.db - query builder
+     * @param arg.migrations - rolled back migrations
      */
-    beforeRollback?(db: Db): void | Promise<void>;
+    beforeRollback?: MigrationCallback;
     /**
-     * Is called once before rolling back one or more migrations.
+     * Is called once per db before rolling back a set of migrations.
      *
-     * @param db - query builder
+     * @param arg.db - query builder
+     * @param arg.migrations - rolled back migrations
      */
-    afterRollback?(db: Db): void | Promise<void>;
+    afterRollback?: MigrationCallback;
 }
+type ChangeCallback$1 = (arg: {
+    db: Db;
+    up: boolean;
+    redo: boolean;
+    migrations: MigrationItem[];
+}) => void | Promise<void>;
+type ChangeCommitCallback = (arg: {
+    options: AdapterOptions;
+    up: boolean;
+    migrations: MigrationItem[];
+}) => void | Promise<void>;
+type MigrationCallback = (arg: {
+    db: Db;
+    migrations: MigrationItem[];
+}) => void | Promise<void>;
 type AnyRakeDbConfig = RakeDbConfig<any, any>;
 type Db = DbResult<RakeDbColumnTypes>;
 interface RakeDbBaseTable<CT> {
@@ -1127,25 +1179,6 @@ declare const createDb: <SchemaConfig extends ColumnSchemaConfig<orchid_core.Col
 declare const dropDb: <SchemaConfig extends ColumnSchemaConfig<orchid_core.ColumnTypeBase<orchid_core.ColumnTypeSchemaArg, unknown, any, orchid_core.CoreBaseOperators, unknown, unknown, any, unknown, any, orchid_core.ColumnDataBase>>, CT>(options: AdapterOptions[], config: RakeDbConfig<SchemaConfig, CT>) => Promise<void>;
 declare const resetDb: <SchemaConfig extends ColumnSchemaConfig<orchid_core.ColumnTypeBase<orchid_core.ColumnTypeSchemaArg, unknown, any, orchid_core.CoreBaseOperators, unknown, unknown, any, unknown, any, orchid_core.ColumnDataBase>>, CT extends RakeDbColumnTypes>(options: AdapterOptions[], config: RakeDbConfig<SchemaConfig, CT>) => Promise<void>;
 
-interface MigrationItem {
-    path: string;
-    version: string;
-    /**
-     * Function that loads the migration content,
-     * can store lazy import of a migration file.
-     * Promise can return `{ default: x }` where `x` is a return of `change` or an array of such returns.
-     */
-    load(): Promise<unknown>;
-}
-interface MigrationsSet {
-    renameTo?: RakeDbMigrationId;
-    migrations: MigrationItem[];
-}
-
-interface RakeDbCtx {
-    migrationsPromise?: Promise<MigrationsSet>;
-}
-
 declare const writeMigrationFile: <SchemaConfig extends ColumnSchemaConfig<orchid_core.ColumnTypeBase<orchid_core.ColumnTypeSchemaArg, unknown, any, orchid_core.CoreBaseOperators, unknown, unknown, any, unknown, any, orchid_core.ColumnDataBase>>, CT>(config: RakeDbConfig<SchemaConfig, CT>, version: string, name: string, content: (importPath: string, name: string) => string) => Promise<void>;
 declare const generate: (config: AnyRakeDbConfig, [name]: string[]) => Promise<void>;
 declare const makeFileVersion: (ctx: RakeDbCtx, config: AnyRakeDbConfig) => Promise<string>;

package/dist/index.js

@@ -2413,6 +2413,7 @@ var __spreadValues$5 = (a, b) => {
 const RAKE_DB_LOCK_KEY = "8582141715823621641";
 function makeMigrateFn(defaultCount, up, fn) {
   return async (ctx, options, config, args = []) => {
+    var _a;
     const set = await getMigrations(ctx, config, up);
     const arg = args[0];
     let force = arg === "force";
@@ -2477,6 +2478,11 @@ function makeMigrateFn(defaultCount, up, fn) {
         await adapter.close();
       }
       localAsts = [];
+      (_a = config.afterChangeCommit) == null ? void 0 : _a.call(config, {
+        options: opts,
+        up,
+        migrations: set.migrations
+      });
     }
     await runCodeUpdaterAfterAll(
       options[0],
@@ -2560,7 +2566,7 @@ function prepareConfig(config, args, hasArg) {
   return config;
 }
 const migrateOrRollback = async (trx, config, set, versions, count, asts, up, redo2, force, skipLock) => {
-  var _a, _b, _c, _d, _e;
+  var _a, _b, _c;
   const { sequence, map: versionsMap } = versions;
   if (up) {
     const rollbackTo = checkMigrationOrder(config, set, versions, force);
@@ -2591,8 +2597,13 @@ const migrateOrRollback = async (trx, config, set, versions, count, asts, up, re
   if (!skipLock)
     await queryLock(trx);
   let db;
-  await ((_a = config[up ? "beforeMigrate" : "beforeRollback"]) == null ? void 0 : _a.call(config, db != null ? db : db = getDb(trx)));
-  await ((_b = config.beforeChange) == null ? void 0 : _b.call(config, db != null ? db : db = getDb(trx), up, redo2));
+  const beforeMigrate = config[up ? "beforeMigrate" : "beforeRollback"];
+  if (beforeMigrate || config.beforeChange) {
+    db != null ? db : db = getDb(trx);
+    const { migrations } = set;
+    await (beforeMigrate == null ? void 0 : beforeMigrate({ db, migrations }));
+    await ((_a = config.beforeChange) == null ? void 0 : _a.call(config, { db, migrations, up, redo: redo2 }));
+  }
   for (const file of set.migrations) {
     if (up && versionsMap[file.version] || !up && !versionsMap[file.version]) {
       continue;
@@ -2608,12 +2619,17 @@ const migrateOrRollback = async (trx, config, set, versions, count, asts, up, re
       versionsMap[file.version] = void 0;
       sequence.pop();
     }
-    (_c = config.logger) == null ? void 0 : _c.log(
+    (_b = config.logger) == null ? void 0 : _b.log(
       `${up ? "Migrated" : "Rolled back"} ${orchidCore.pathToLog(file.path)}`
     );
   }
-  await ((_d = config.afterChange) == null ? void 0 : _d.call(config, db != null ? db : db = getDb(trx), up, redo2));
-  await ((_e = config[up ? "afterMigrate" : "afterRollback"]) == null ? void 0 : _e.call(config, db != null ? db : db = getDb(trx)));
+  const afterMigrate = config[up ? "afterMigrate" : "afterRollback"];
+  if (config.afterChange || afterMigrate) {
+    db != null ? db : db = getDb(trx);
+    const { migrations } = set;
+    await ((_c = config.afterChange) == null ? void 0 : _c.call(config, { db, up, redo: redo2, migrations }));
+    await (afterMigrate == null ? void 0 : afterMigrate({ db, migrations }));
+  }
 };
 const checkMigrationOrder = (config, set, { sequence, map }, force) => {
   const last = sequence[sequence.length - 1];