rake-db 2.20.6 → 2.20.8

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as orchid_core from 'orchid-core';
-import { MaybeArray, RawSQLBase, ColumnDataCheckBase, RecordString, EmptyObject, ColumnSchemaConfig, RecordOptionalString, ColumnTypeBase, ForeignKeyTable, Sql, MaybePromise } from 'orchid-core';
+import { MaybeArray, RawSQLBase, ColumnDataCheckBase, RecordString, EmptyObject, ColumnSchemaConfig, MaybePromise, RecordOptionalString, ColumnTypeBase, ForeignKeyTable, Sql } from 'orchid-core';
 import * as pqb from 'pqb';
 import { TableData, ColumnsShape, NoPrimaryKeyOption, ColumnType, EnumColumn, raw, Adapter, DbResult, TransactionAdapter, QueryLogObject, TableDataFn, TableDataItem, DbDomainArg, TextColumn, Db as Db$1, QueryArraysResult, AdapterOptions, DefaultColumnTypes, DefaultSchemaConfig, QueryLogOptions, SearchWeight, ColumnsByType, ArrayColumn } from 'pqb';
 
@@ -1247,7 +1247,7 @@ interface MigrationItem {
     load(): Promise<unknown>;
 }
 interface MigrationsSet {
-    renameTo?: RakeDbMigrationId;
+    renameTo?: RakeDbRenameMigrations;
     migrations: MigrationItem[];
 }
 
@@ -1260,6 +1260,7 @@ interface RakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT = DefaultColu
     migrationsPath: string;
     migrationId: RakeDbMigrationId;
     migrations?: ModuleExportsRecord;
+    renameMigrations?: RakeDbRenameMigrationsInput;
     recurrentPath: string;
     migrationsTable: string;
     snakeCase: boolean;
@@ -1284,7 +1285,7 @@ interface InputRakeDbConfigBase<SchemaConfig extends ColumnSchemaConfig, CT> ext
     basePath?: string;
     dbScript?: string;
     migrationsPath?: string;
-    migrationId?: RakeDbMigrationId;
+    migrationId?: 'serial' | RakeDbMigrationId;
     recurrentPath?: string;
     migrationsTable?: string;
     snakeCase?: boolean;
@@ -1360,6 +1361,7 @@ type InputRakeDbConfig<SchemaConfig extends ColumnSchemaConfig, CT> = InputRakeD
      * To specify array of migrations explicitly, without loading them from files.
      */
     migrations: ModuleExportsRecord;
+    renameMigrations?: RakeDbRenameMigrationsInput;
     /**
      * It may look odd, but it's required for `tsx` and other bundlers to have such `import` config specified explicitly.
      */
@@ -1395,11 +1397,26 @@ interface RakeDbBaseTable<CT> {
 interface ModuleExportsRecord {
     [K: string]: () => Promise<unknown>;
 }
-type RakeDbMigrationId = 'serial' | 'timestamp';
+type RakeDbMigrationId = 'timestamp' | {
+    serial: number;
+};
+interface RakeDbRenameMigrationsMap {
+    [K: string]: number;
+}
+interface RakeDbRenameMigrations {
+    to: RakeDbMigrationId;
+    map(): MaybePromise<RakeDbRenameMigrationsMap>;
+}
+interface RakeDbRenameMigrationsInput {
+    to: RakeDbMigrationId;
+    map: RakeDbRenameMigrationsMap;
+}
 declare const migrationConfigDefaults: {
     schemaConfig: DefaultSchemaConfig;
     migrationsPath: string;
-    migrationId: "serial";
+    migrationId: {
+        serial: number;
+    };
     migrationsTable: string;
     snakeCase: false;
     commands: {};
@@ -1435,7 +1452,7 @@ type RakeDbAppliedVersions = {
     map: RecordOptionalString;
     sequence: number[];
 };
-declare const getMigratedVersionsMap: <SchemaConfig extends ColumnSchemaConfig<orchid_core.ColumnTypeBase<orchid_core.ColumnTypeSchemaArg, unknown, any, orchid_core.CoreBaseOperators, unknown, unknown, any, unknown, any, orchid_core.ColumnDataBase>>, CT>(ctx: RakeDbCtx, adapter: Adapter | TransactionAdapter, config: RakeDbConfig<SchemaConfig, CT>, renameTo?: RakeDbMigrationId) => Promise<RakeDbAppliedVersions>;
+declare const getMigratedVersionsMap: <SchemaConfig extends ColumnSchemaConfig<orchid_core.ColumnTypeBase<orchid_core.ColumnTypeSchemaArg, unknown, any, orchid_core.CoreBaseOperators, unknown, unknown, any, unknown, any, orchid_core.ColumnDataBase>>, CT>(ctx: RakeDbCtx, adapter: Adapter | TransactionAdapter, config: RakeDbConfig<SchemaConfig, CT>, renameTo?: RakeDbRenameMigrations) => Promise<RakeDbAppliedVersions>;
 
 declare const RAKE_DB_LOCK_KEY = "8582141715823621641";
 type MigrateFn = <SchemaConfig extends ColumnSchemaConfig, CT>(ctx: RakeDbCtx, options: AdapterOptions[], config: RakeDbConfig<SchemaConfig, CT>, args?: string[], adapters?: Adapter[], dontClose?: boolean) => Promise<Adapter[]>;
@@ -1777,4 +1794,4 @@ declare const promptText: ({ message, default: def, password, min, }: {
     min?: number;
 }) => Promise<string>;
 
-export { AnyRakeDbConfig, ChangeCallback, ChangeTableCallback, ChangeTableOptions, ColumnComment, ColumnsShapeCallback, CommandFn, DbMigration, DbStructure, DbStructureDomainsMap, DropMode, InputRakeDbConfig, InputRakeDbConfigBase, IntrospectedStructure, Migration, MigrationAdapter, MigrationColumnTypes, ModuleExportsRecord, NoMigrationsTableError, RAKE_DB_LOCK_KEY, RakeDbAppliedVersions, RakeDbAst, RakeDbBaseTable, RakeDbChangeFn, RakeDbConfig, RakeDbCtx, RakeDbFn, RakeDbFnReturns, RakeDbLazyFn, RakeDbMigrationId, RakeDbResult, SilentQueries, StructureToAstCtx, StructureToAstTableData, TableOptions, addColumnComment, addColumnIndex, addOrDropEnumValues, astToMigration, changeCache, changeEnumValues, clearChanges, colors, columnToSql, columnTypeToSql, commentsToQuery, concatSchemaAndName, constraintToSql, createDb, createMigrationInterface, dbColumnToAst, deleteMigratedVersion, dropDb, encodeColumnDefault, exhaustive, generateTimeStamp, getColumnName, getConstraintName, getCurrentChanges, getDatabaseAndUserFromOptions, getDbStructureTableData, getDbTableColumnsChecks, getFirstWordAndRest, getForeignKeyTable, getIndexName, getMigratedVersionsMap, getSchemaAndTableFromName, getTextAfterFrom, getTextAfterTo, identityToSql, indexesToQuery, instantiateDbColumn, introspectDbSchema, joinColumns, joinWords, makeDbStructureColumnsShape, makeDomainsMap, makeFileVersion, makePopulateEnumQuery, makeStructureToAstCtx, migrate, migrateOrRollback, migrationConfigDefaults, newMigration, pluralize, primaryKeyToSql, processRakeDbConfig, promptConfirm, promptSelect, promptText, pushChange, queryLock, quoteNameFromString, quoteSchemaTable, quoteTable, quoteWithSchema, rakeDb, rakeDbAliases, rakeDbCommands, redo, referencesToSql, renameType, resetDb, rollback, saveMigratedVersion, structureToAst, tableToAst, transaction, versionToString, writeMigrationFile };
+export { AnyRakeDbConfig, ChangeCallback, ChangeTableCallback, ChangeTableOptions, ColumnComment, ColumnsShapeCallback, CommandFn, DbMigration, DbStructure, DbStructureDomainsMap, DropMode, InputRakeDbConfig, InputRakeDbConfigBase, IntrospectedStructure, Migration, MigrationAdapter, MigrationColumnTypes, ModuleExportsRecord, NoMigrationsTableError, RAKE_DB_LOCK_KEY, RakeDbAppliedVersions, RakeDbAst, RakeDbBaseTable, RakeDbChangeFn, RakeDbConfig, RakeDbCtx, RakeDbFn, RakeDbFnReturns, RakeDbLazyFn, RakeDbMigrationId, RakeDbRenameMigrations, RakeDbRenameMigrationsInput, RakeDbRenameMigrationsMap, RakeDbResult, SilentQueries, StructureToAstCtx, StructureToAstTableData, TableOptions, addColumnComment, addColumnIndex, addOrDropEnumValues, astToMigration, changeCache, changeEnumValues, clearChanges, colors, columnToSql, columnTypeToSql, commentsToQuery, concatSchemaAndName, constraintToSql, createDb, createMigrationInterface, dbColumnToAst, deleteMigratedVersion, dropDb, encodeColumnDefault, exhaustive, generateTimeStamp, getColumnName, getConstraintName, getCurrentChanges, getDatabaseAndUserFromOptions, getDbStructureTableData, getDbTableColumnsChecks, getFirstWordAndRest, getForeignKeyTable, getIndexName, getMigratedVersionsMap, getSchemaAndTableFromName, getTextAfterFrom, getTextAfterTo, identityToSql, indexesToQuery, instantiateDbColumn, introspectDbSchema, joinColumns, joinWords, makeDbStructureColumnsShape, makeDomainsMap, makeFileVersion, makePopulateEnumQuery, makeStructureToAstCtx, migrate, migrateOrRollback, migrationConfigDefaults, newMigration, pluralize, primaryKeyToSql, processRakeDbConfig, promptConfirm, promptSelect, promptText, pushChange, queryLock, quoteNameFromString, quoteSchemaTable, quoteTable, quoteWithSchema, rakeDb, rakeDbAliases, rakeDbCommands, redo, referencesToSql, renameType, resetDb, rollback, saveMigratedVersion, structureToAst, tableToAst, transaction, versionToString, writeMigrationFile };

package/dist/index.js

@@ -112,7 +112,7 @@ var __spreadValues$9 = (a, b) => {
   return a;
 };
 var __spreadProps$7 = (a, b) => __defProps$7(a, __getOwnPropDescs$7(b));
-const versionToString = (config, version) => config.migrationId === "serial" ? `${version}`.padStart(4, "0") : `${version}`;
+const versionToString = (config, version) => config.migrationId === "timestamp" ? `${version}` : `${version}`.padStart(config.migrationId.serial, "0");
 const columnTypeToSql = (item) => {
   return item.data.isOfCustomType ? quoteNameFromString(item.toSQL()) : item.toSQL();
 };
@@ -2490,19 +2490,17 @@ const fileNamesToChangeMigrationId = {
 const fileNamesToChangeMigrationIdMap = Object.fromEntries(
   Object.entries(fileNamesToChangeMigrationId).map(([_, name]) => [name, true])
 );
-const changeIds = async (options, config, [arg]) => {
-  var _a;
+const changeIds = async (options, config, [arg, digitsArg]) => {
+  var _a, _b, _c, _d;
   if (arg !== "serial" && arg !== "timestamp") {
     throw new Error(
       `Pass "serial" or "timestamp" argument to the "change-ids" command`
     );
   }
-  if (config.migrations) {
-    throw new Error(
-      `Cannot change migrations ids when migrations set is defined in the config`
-    );
-  }
-  const data = await getMigrationsFromFiles(config, false, (_, filePath) => {
+  let digits = digitsArg && parseInt(digitsArg);
+  if (!digits || isNaN(digits))
+    digits = 4;
+  const data = await getMigrations({}, config, true, false, (_, filePath) => {
     const fileName = path.basename(filePath);
     const match = fileName.match(/^(\d+)\D/);
     if (!match) {
@@ -2513,47 +2511,87 @@ const changeIds = async (options, config, [arg]) => {
     return match[1];
   });
   if (data.renameTo) {
-    if (data.renameTo === arg) {
-      (_a = config.logger) == null ? void 0 : _a.log(`${fileNamesToChangeMigrationId[arg]} already exists`);
+    if (arg === "serial" && typeof data.renameTo.to === "object" && digits === data.renameTo.to.serial || arg === "timestamp" && data.renameTo.to === "timestamp") {
+      (_a = config.logger) == null ? void 0 : _a.log(
+        config.migrations ? "`renameMigrations` setting is already set" : `${fileNamesToChangeMigrationId[arg]} already exists`
+      );
       return;
     }
-    await fs.unlink(
-      path.join(
-        config.migrationsPath,
-        fileNamesToChangeMigrationId[data.renameTo]
-      )
-    );
+    if (!config.migrations) {
+      await fs.unlink(
+        path.join(
+          config.migrationsPath,
+          fileNamesToChangeMigrationId[data.renameTo.to === "timestamp" ? "timestamp" : "serial"]
+        )
+      );
+    }
   }
   const version = arg === "timestamp" ? parseInt(generateTimeStamp()) : 1;
   const rename = Object.fromEntries(
     data.migrations.map((item, i) => [path.basename(item.path), version + i])
   );
-  await fs.writeFile(
-    path.join(config.migrationsPath, fileNamesToChangeMigrationId[arg]),
-    JSON.stringify(rename, null, 2)
-  );
-  const values = [];
-  await Promise.all(
-    data.migrations.map(async (item, i) => {
+  if (config.migrations) {
+    const to = arg === "timestamp" ? `'${arg}'` : `{ serial: ${digits} }`;
+    (_b = config.logger) == null ? void 0 : _b.log(
+      `Save the following settings into your rake-db config under the \`migrations\` setting, it will instruct rake-db to rename migration entries during the next deploy:
+${arg !== "serial" || digits !== 4 ? `
+migrationId: ${to},` : ""}
+renameMigrations: {
+  to: ${to},
+  map: {
+    ` + Object.entries(rename).map(([key, value]) => `"${key}": ${value},`).join("\n    ") + "\n  },\n},\n\n"
+    );
+  } else {
+    await fs.writeFile(
+      path.join(config.migrationsPath, fileNamesToChangeMigrationId[arg]),
+      JSON.stringify(rename, null, 2)
+    );
+  }
+  const values = data.migrations.map(
+    (item, i) => {
       let newVersion = String(version + i);
       if (arg === "serial")
-        newVersion = newVersion.padStart(4, "0");
+        newVersion = newVersion.padStart(digits, "0");
       const name = path.basename(item.path).slice(item.version.length + 1);
+      return [item.version, name, newVersion];
+    }
+  );
+  if (!values.length)
+    return;
+  if (config.migrations) {
+    (_c = config.logger) == null ? void 0 : _c.log(
+      `If your migrations are stored in files, navigate to migrations directory and run the following commands to rename them:
+
+${values.map(
+        ([version2, name, newVersion]) => `mv "${version2}_${name}" "${newVersion}_${name}"`
+      ).join(
+        "\n"
+      )}
+
+After setting \`renameMigrations\` (see above) and renaming the files, run the db up command to rename migration entries in your database`
+    );
+    return;
+  }
+  await Promise.all(
+    data.migrations.map(async (item, i) => {
+      const [, name, newVersion] = values[i];
       await fs.rename(
         item.path,
         path.join(path.dirname(item.path), `${newVersion}_${name}`)
       );
-      values.push([item.version, name, newVersion]);
     })
   );
-  if (!values.length)
-    return;
   await options.map((opts) => {
     const adapter = new pqb.Adapter(opts);
     renameMigrationVersionsInDb(config, adapter, values).then(
       () => adapter.close()
     );
   });
+  (_d = config.logger) == null ? void 0 : _d.log(
+    `Migration files were renamed, a config file ${fileNamesToChangeMigrationId[arg]} for renaming migrations after deploy was created, and migrations in local db were renamed successfully.
+
+${arg === "timestamp" || digits !== 4 ? `Set \`migrationId\`: ${arg === "timestamp" ? `'timestamp'` : `{ serial: ${digits} }`}` : `Remove \`migrationId\``} setting in the rake-db config`
+  );
 };
 const renameMigrationVersionsInDb = async (config, adapter, values) => {
   await adapter.arrays({
@@ -2585,18 +2623,25 @@ var __spreadValues$5 = (a, b) => {
   return a;
 };
 var __spreadProps$3 = (a, b) => __defProps$3(a, __getOwnPropDescs$3(b));
-const getMigrations = async (ctx, config, up, allowDuplicates) => {
+const getMigrations = async (ctx, config, up, allowDuplicates, getVersion = getMigrationVersionOrThrow) => {
   var _a;
-  return ((_a = ctx.migrationsPromise) != null ? _a : ctx.migrationsPromise = config.migrations ? getMigrationsFromConfig(__spreadProps$3(__spreadValues$5({}, config), { migrations: config.migrations })) : getMigrationsFromFiles(config, allowDuplicates)).then(
-    (data) => up ? data : { renameTo: data.renameTo, migrations: [...data.migrations].reverse() }
+  return ((_a = ctx.migrationsPromise) != null ? _a : ctx.migrationsPromise = config.migrations ? getMigrationsFromConfig(
+    __spreadProps$3(__spreadValues$5({}, config), { migrations: config.migrations }),
+    allowDuplicates,
+    getVersion
+  ) : getMigrationsFromFiles(config, allowDuplicates, getVersion)).then(
+    (data) => up ? data : {
+      renameTo: data.renameTo,
+      migrations: [...data.migrations].reverse()
+    }
   );
 };
-function getMigrationsFromConfig(config, allowDuplicates) {
+function getMigrationsFromConfig(config, allowDuplicates, getVersion = getMigrationVersionOrThrow) {
   const result = [];
   const versions = {};
   const { migrations, basePath } = config;
   for (const key in migrations) {
-    const version = getMigrationVersionOrThrow(config, path.basename(key));
+    const version = getVersion(config, path.basename(key));
     if (versions[version] && !allowDuplicates) {
       throw new Error(
         `Migration ${key} has the same version as ${versions[version]}`
@@ -2609,8 +2654,10 @@ function getMigrationsFromConfig(config, allowDuplicates) {
       load: migrations[key]
     });
   }
+  const { renameMigrations } = config;
   return Promise.resolve({
-    migrations: result
+    migrations: result,
+    renameTo: renameMigrations ? { to: renameMigrations.to, map: () => renameMigrations.map } : void 0
   });
 }
 const sortMigrationsAsc = (a, b) => +a.version - +b.version;
@@ -2630,7 +2677,19 @@ async function getMigrationsFromFiles(config, allowDuplicates, getVersion = getM
             `Both files for renaming to serial and timestamp found, only one must remain`
           );
         }
-        data.renameTo = file.name === ".rename-to-serial.json" ? "serial" : "timestamp";
+        const isSerialFile = file.name === ".rename-to-serial.json";
+        const isSerialConfig = config.migrationId !== "timestamp";
+        if (isSerialFile && !isSerialConfig || !isSerialFile && isSerialConfig) {
+          throw new Error(
+            `File ${file.name} to rename migrations does not match \`migrationId\` ${JSON.stringify(
+              config.migrationId
+            )} set in config`
+          );
+        }
+        data.renameTo = {
+          to: config.migrationId,
+          map: () => renameMigrationsMap(config, file.name)
+        };
         return data;
       } else {
         checkExt(file.name);
@@ -2668,6 +2727,21 @@ Run \`**db command** rebase\` to reorganize files with duplicated versions.`
   result.migrations.sort(sortMigrationsAsc);
   return result;
 }
+const renameMigrationsMap = async (config, fileName) => {
+  const filePath = path.join(config.migrationsPath, fileName);
+  const json = await fs.readFile(filePath, "utf-8");
+  let data;
+  try {
+    data = JSON.parse(json);
+    if (typeof data !== "object")
+      throw new Error("Config for renaming is not an object");
+  } catch (err) {
+    throw new Error(`Failed to read ${node_url.pathToFileURL(filePath)}`, {
+      cause: err
+    });
+  }
+  return data;
+};
 function checkExt(filePath) {
   const ext = path.extname(filePath);
   if (ext !== ".ts" && ext !== ".js" && ext !== ".mjs") {
@@ -2782,32 +2856,20 @@ async function renameMigrations(config, trx, versions, renameTo) {
   }
   if (!first || getMigrationVersion(config, first))
     return versions;
-  const fileName = fileNamesToChangeMigrationId[renameTo];
-  const filePath = path.join(config.migrationsPath, fileName);
-  const json = await fs.readFile(filePath, "utf-8");
-  let data;
-  try {
-    data = JSON.parse(json);
-    if (typeof data !== "object")
-      throw new Error("Config for renaming is not an object");
-  } catch (err) {
-    throw new Error(`Failed to read ${node_url.pathToFileURL(filePath)}`, {
-      cause: err
-    });
-  }
   const values = [];
   const updatedVersions = {};
+  const data = await renameTo.map();
   for (const version in versions) {
     const name = versions[version];
     const key = `${version}_${name}`;
     let newVersion = data[key];
     if (!newVersion) {
       throw new Error(
-        `Failed to find an entry for the migrated ${key} in the ${fileName} config`
+        `Failed to find an entry for the migrated ${key} in the renaming config`
       );
     }
-    if (renameTo === "serial") {
-      newVersion = String(newVersion).padStart(4, "0");
+    if (typeof renameTo.to === "object") {
+      newVersion = String(newVersion).padStart(renameTo.to.serial, "0");
     }
     updatedVersions[newVersion] = name;
     values.push([version, name, newVersion]);
@@ -3085,7 +3147,7 @@ var __spreadValues$4 = (a, b) => {
 const migrationConfigDefaults = {
   schemaConfig: pqb.defaultSchemaConfig,
   migrationsPath: path.join("src", "db", "migrations"),
-  migrationId: "serial",
+  migrationId: { serial: 4 },
   migrationsTable: "schemaMigrations",
   snakeCase: false,
   commands: {},
@@ -3145,6 +3207,9 @@ const processRakeDbConfig = (config) => {
       pqb.makeColumnTypes(pqb.defaultSchemaConfig)
     ) : ct) || pqb.makeColumnTypes;
   }
+  if (config.migrationId === "serial") {
+    result.migrationId = { serial: 4 };
+  }
   return result;
 };
 const getDatabaseAndUserFromOptions = (options) => {
@@ -5346,9 +5411,9 @@ const rebase = async (options, config) => {
   if (config.migrations) {
     throw new Error("Cannot rebase migrations defined in the config");
   }
-  if (config.migrationId !== "serial") {
+  if (config.migrationId === "timestamp") {
     throw new Error(
-      `Cannot rebase when the 'migrationId' is set to '${config.migrationId}' in the config`
+      `Cannot rebase when the 'migrationId' is set to 'timestamp' in the config`
     );
   }
   const adapters = options.map((opts) => new pqb.Adapter(opts));
@@ -5707,7 +5772,7 @@ const rakeDbCommands = {
     helpArguments: {
       serial: "change ids to 4 digit serial",
       "serial *number*": "change ids to serial number of custom length",
-      "change-ids timestamp": "change ids to timestamps"
+      timestamp: "change ids to timestamps"
     }
   }
 };