@sebspark/spanner-migrate 0.1.1 → 1.0.0

package/dist/cli.mjs

@@ -5,55 +5,53 @@ import {
   init,
   status,
   up
-} from "./chunk-K5WX6ESL.mjs";
+} from "./chunk-SZDH364K.mjs";
 
 // src/cli.ts
 import fs from "node:fs/promises";
 import { join } from "node:path";
-import input from "@inquirer/input";
+import { input, select } from "@inquirer/prompts";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 var CONFIG_FILE = "./.spanner-migrate.config.json";
-async function loadConfig() {
-  try {
-    const configContent = await fs.readFile(CONFIG_FILE, "utf8");
-    return JSON.parse(configContent);
-  } catch {
-    console.error('Config file not found. Run "spanner-migrate init" first.');
-    process.exit(1);
-  }
-}
 yargs(hideBin(process.argv)).scriptName("spanner-migrate").usage("$0 <command>").command(
   "init",
   "Initialize a .spanner-migrate.config.json file",
   async () => {
-    const migrationsPath = await input({
-      message: "Enter the path for your migrations",
-      required: true,
-      default: "./migrations"
-    });
     const instanceName = await input({
       message: "Enter Spanner instance name",
       required: true
     });
-    const databaseName = await input({
-      message: "Enter Spanner database name",
-      required: true
-    });
+    const databases = [
+      await getDatabaseConfig(true)
+    ];
+    while (true) {
+      const dbConfig = await getDatabaseConfig(false);
+      if (!dbConfig) break;
+      databases.push(dbConfig);
+    }
     const projectId = await input({
       message: "Enter Google Cloud project name",
       required: false
     });
-    const config = { instanceName, databaseName, migrationsPath };
+    const config = {
+      instance: {
+        name: instanceName,
+        databases
+      }
+    };
     if (projectId) config.projectId = projectId;
     await init(config, CONFIG_FILE);
-    console.log(`Configuration written to ${CONFIG_FILE}`);
   }
 ).command(
   "create <description ...>",
   "Create a new migration file",
   (yargs2) => {
-    yargs2.positional("description", {
+    yargs2.option("database", {
+      alias: "d",
+      type: "string",
+      describe: "Database name"
+    }).positional("description", {
       type: "string",
       describe: "Description of the migration",
       demandOption: true
@@ -62,33 +60,157 @@ yargs(hideBin(process.argv)).scriptName("spanner-migrate").usage("$0 <command>")
   async (args) => {
     const config = await loadConfig();
     const fullDescription = args.description.join(" ");
-    await create(config, fullDescription);
+    let databaseConfig;
+    if (args.database) {
+      databaseConfig = config.instance.databases.find(
+        (db) => db.name === args.database
+      );
+      if (!databaseConfig) {
+        throw new Error(`Unknown database name "${args.database}"`);
+      }
+    } else {
+      if (config.instance.databases.length === 1) {
+        databaseConfig = config.instance.databases[0];
+      } else {
+        databaseConfig = await select({
+          message: "Select database",
+          choices: config.instance.databases.map((dbConfig) => ({
+            name: dbConfig.name,
+            value: dbConfig
+          }))
+        });
+      }
+    }
+    if (!databaseConfig) throw new Error("No database config found");
+    await create(databaseConfig, fullDescription);
     console.log(
-      `Migration file created: '${join(config.migrationsPath, args.description.join("_"))}.ts'`
+      `Migration file created: '${join(databaseConfig.migrationsPath, args.description.join("_"))}.sql'`
     );
   }
 ).command(
   "up",
   "Apply migrations",
   (yargs2) => {
-    yargs2.option("max", {
+    yargs2.option("database", {
+      alias: "d",
+      type: "string",
+      describe: "Database name",
+      requiresArg: false
+    }).option("max", {
       alias: "m",
       type: "number",
-      describe: "Maximum number of migrations to apply",
-      default: 1e3
+      describe: "Maximum number of migrations to apply (requires --database)",
+      requiresArg: false
     });
   },
   async (args) => {
     const config = await loadConfig();
-    await up(config, args.max);
+    if (args.max !== void 0) {
+      if (!args.database) {
+        throw new Error("The --max option requires a specified --database");
+      }
+      if (!Number.isInteger(args.max) || args.max <= 0) {
+        throw new Error("The --max option must be an integer greater than 0");
+      }
+    }
+    if (args.database) {
+      const databaseConfig = config.instance.databases.find(
+        (db) => db.name === args.database
+      );
+      if (!databaseConfig) {
+        throw new Error(`Unknown database name "${args.database}"`);
+      }
+      if (args.max !== void 0) {
+        await up(config, databaseConfig, args.max);
+      } else {
+        await up(config, databaseConfig);
+      }
+    } else {
+      await up(config);
+    }
     console.log("Migrations applied successfully.");
   }
-).command("down", "Roll back the last applied migration", {}, async () => {
-  const config = await loadConfig();
-  await down(config);
-  console.log("Last migration rolled back successfully.");
-}).command("status", "Show the migration status", {}, async () => {
-  const config = await loadConfig();
-  const migrationStatus = await status(config);
-  console.log(migrationStatus);
-}).demandCommand().help().parse();
+).command(
+  "down",
+  "Roll back the last applied migration",
+  (yargs2) => {
+    yargs2.option("database", {
+      alias: "d",
+      type: "string",
+      describe: "Specify the database to roll back (required if multiple databases exist)"
+    });
+  },
+  async (args) => {
+    const config = await loadConfig();
+    let databaseConfig;
+    if (args.database) {
+      databaseConfig = config.instance.databases.find(
+        (dbConfig) => dbConfig.name === args.database
+      );
+      if (!databaseConfig) {
+        throw new Error(`Unknown database name "${args.database}"`);
+      }
+    } else if (config.instance.databases.length === 1) {
+      databaseConfig = config.instance.databases[0];
+    } else {
+      throw new Error(
+        "Multiple databases detected. Use --database to specify which one to roll back."
+      );
+    }
+    if (!databaseConfig) throw new Error("No database config found");
+    await down(config, databaseConfig);
+    console.log("Last migration rolled back successfully.");
+  }
+).command(
+  "status",
+  "Show the migration status",
+  (yargs2) => {
+    yargs2.option("database", {
+      alias: "d",
+      type: "string",
+      describe: "Specify a database to check status (optional, runs on all databases if omitted)"
+    });
+  },
+  async (args) => {
+    const config = await loadConfig();
+    let migrationStatus;
+    if (args.database) {
+      const databaseConfig = config.instance.databases.find(
+        (db) => db.name === args.database
+      );
+      if (!databaseConfig) {
+        throw new Error(`Unknown database name "${args.database}"`);
+      }
+      migrationStatus = await status(config, [databaseConfig]);
+    } else {
+      migrationStatus = await status(config);
+    }
+    console.log(migrationStatus);
+  }
+).demandCommand().help().parse();
+async function loadConfig() {
+  try {
+    const configContent = await fs.readFile(CONFIG_FILE, "utf8");
+    return JSON.parse(configContent);
+  } catch {
+    console.error('Config file not found. Run "spanner-migrate init" first.');
+    process.exit(1);
+  }
+}
+var getDatabaseConfig = async (required) => {
+  const message = required ? "Enter Spanner database name" : "Enter another Spanner database name [Enter to continue]";
+  const name = await input({
+    message,
+    required
+  });
+  if (!name) return;
+  const migrationsPath = await input({
+    message: "Enter the path for your migrations",
+    required: true,
+    default: `./migrations/${name}`
+  });
+  return {
+    name,
+    migrationsPath
+  };
+};

package/dist/index.d.mts

@@ -1,14 +1,20 @@
-type Config = {
+type DatabaseConfig = {
+    name: string;
     migrationsPath: string;
-    instanceName: string;
-    databaseName: string;
+};
+type InstanceConfig = {
+    name: string;
+    databases: DatabaseConfig[];
+};
+type Config = {
+    instance: InstanceConfig;
     projectId?: string;
 };
 
 declare const init: (config: Config, configPath: string) => Promise<void>;
-declare const create: (config: Config, description: string) => Promise<void>;
-declare const up: (config: Config, max?: number) => Promise<void>;
-declare const down: (config: Config) => Promise<void>;
-declare const status: (config: Config) => Promise<string>;
+declare const create: (config: DatabaseConfig, description: string) => Promise<void>;
+declare const up: (config: Config, database?: DatabaseConfig, max?: number) => Promise<void>;
+declare const down: (config: Config, database: DatabaseConfig) => Promise<void>;
+declare const status: (config: Config, databases?: DatabaseConfig[]) => Promise<string>;
 
 export { create, down, init, status, up };

package/dist/index.d.ts

@@ -1,14 +1,20 @@
-type Config = {
+type DatabaseConfig = {
+    name: string;
     migrationsPath: string;
-    instanceName: string;
-    databaseName: string;
+};
+type InstanceConfig = {
+    name: string;
+    databases: DatabaseConfig[];
+};
+type Config = {
+    instance: InstanceConfig;
     projectId?: string;
 };
 
 declare const init: (config: Config, configPath: string) => Promise<void>;
-declare const create: (config: Config, description: string) => Promise<void>;
-declare const up: (config: Config, max?: number) => Promise<void>;
-declare const down: (config: Config) => Promise<void>;
-declare const status: (config: Config) => Promise<string>;
+declare const create: (config: DatabaseConfig, description: string) => Promise<void>;
+declare const up: (config: Config, database?: DatabaseConfig, max?: number) => Promise<void>;
+declare const down: (config: Config, database: DatabaseConfig) => Promise<void>;
+declare const status: (config: Config, databases?: DatabaseConfig[]) => Promise<string>;
 
 export { create, down, init, status, up };

package/dist/index.js

@@ -66,7 +66,7 @@ var applyDown = async (db) => {
     json: true
   };
   const [rows] = await db.run(req);
-  const lastMigration = rows == null ? void 0 : rows[0];
+  const lastMigration = rows?.[0];
   if (!lastMigration) {
     throw new Error("No migrations found to roll back.");
   }
@@ -98,12 +98,11 @@ var runScript = async (db, script) => {
   }
   for (const statement of statements) {
     console.log(`Executing statement: ${statement}`);
-    const sql = statement.replace(/--.*$/gm, "");
-    if (isSchemaChange(sql)) {
-      await db.updateSchema(sql);
+    if (isSchemaChange(statement)) {
+      await db.updateSchema(statement);
     } else {
       await db.runTransactionAsync(async (transaction) => {
-        await transaction.runUpdate(sql);
+        await transaction.runUpdate(statement);
         await transaction.commit();
       });
     }
@@ -129,12 +128,12 @@ var SQL_CREATE_TABLE_MIGRATIONS = `
     down STRING(1024)
   ) PRIMARY KEY (id)
 `;
-var ensureMigrationTable = async (database) => {
-  const [rows] = await database.run(SQL_SELECT_TABLE_MIGRATIONS);
+var ensureMigrationTable = async (db) => {
+  const [rows] = await db.run(SQL_SELECT_TABLE_MIGRATIONS);
   if (rows.length) return;
   console.log("Creating migration table");
   try {
-    await database.updateSchema(SQL_CREATE_TABLE_MIGRATIONS);
+    await db.updateSchema(SQL_CREATE_TABLE_MIGRATIONS);
   } catch (err) {
     console.error("Failed to create migrations table");
     throw err;
@@ -165,7 +164,7 @@ var import_node_path = require("path");
 var getMigrationFiles = async (path) => {
   try {
     const files = await (0, import_promises.readdir)(path);
-    const migrationFileIds = files.filter((file) => file.endsWith(".ts")).map((file) => file.replace(/\.ts$/, ""));
+    const migrationFileIds = files.filter((file) => file.endsWith(".sql")).map((file) => file.replace(/\.sql$/, ""));
     return migrationFileIds;
   } catch (error) {
     throw new Error(
@@ -175,35 +174,39 @@ var getMigrationFiles = async (path) => {
 };
 var getMigration = async (path, id) => {
   try {
-    const filePath = (0, import_node_path.resolve)(process.cwd(), (0, import_node_path.join)(path, `${id}.ts`));
+    const filePath = (0, import_node_path.resolve)(process.cwd(), (0, import_node_path.join)(path, `${id}.sql`));
     try {
       await (0, import_promises.access)(filePath);
     } catch (err) {
       throw new Error(`Migration file not found: ${filePath}`);
     }
-    const migrationModule = await import(filePath);
-    if (!migrationModule.up || !migrationModule.down) {
+    const migrationText = await (0, import_promises.readFile)(filePath, "utf8");
+    const up2 = getSql(migrationText, "up");
+    const down2 = getSql(migrationText, "down");
+    const description = getDescription(migrationText);
+    if (!up2 || !down2) {
       throw new Error(
         `Migration file ${filePath} does not export required scripts (up, down).`
       );
     }
-    return {
-      id,
-      description: id.split("_").slice(1).map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join(" "),
-      // Generate a human-readable description
-      up: migrationModule.up,
-      down: migrationModule.down
-    };
+    return { id, description, up: up2, down: down2 };
   } catch (error) {
     throw new Error(
       `Failed to get migration ${id}: ${error.message}`
     );
   }
 };
+var getDescription = (text) => text?.match(/^--\s*Description:\s*(.+)$/m)?.[1]?.trim() || "";
+var getSql = (text, direction) => {
+  const rx = {
+    up: /---- UP ----\n([\s\S]*?)\n---- DOWN ----/,
+    down: /---- DOWN ----\n([\s\S]*)$/
+  };
+  return text?.match(rx[direction])?.[1]?.replace(/--.*$/gm, "").trim();
+};
 var getNewMigrations = (applied, files) => {
   const sortedFiles = files.sort();
   for (let ix = 0; ix < applied.length; ix++) {
-    console.log(sortedFiles[ix], applied[ix].id);
     if (sortedFiles[ix] !== applied[ix].id) {
       throw new Error(
         `Mismatch between applied migrations and files. Found '${sortedFiles[ix]}' but expected '${applied[ix].id}' at position ${ix}.`
@@ -211,25 +214,24 @@ var getNewMigrations = (applied, files) => {
     }
   }
   const newMigrations = sortedFiles.slice(applied.length);
-  console.log(`Found ${newMigrations.length} new migrations.`);
   return newMigrations;
 };
 var createMigration = async (path, description) => {
   const timestamp = (/* @__PURE__ */ new Date()).toISOString();
   const compactTimestamp = timestamp.replace(/[-:.TZ]/g, "");
   const parsedDescription = description.replace(/\s+/g, "_").toLowerCase();
-  const filename = `${compactTimestamp}_${parsedDescription}.ts`;
+  const filename = `${compactTimestamp}_${parsedDescription}.sql`;
   const filePath = (0, import_node_path.join)(path, filename);
-  const template = `// ${timestamp}
-// ${description}
+  const template = `-- Created: ${timestamp}
+-- Description: ${description}
+
+---- UP ----
+
+
+
+---- DOWN ----
 
-export const up = \`
-  -- SQL for migrate up
-\`
 
-export const down = \`
-  -- SQL for migrate down
-\`
 `;
   try {
     await (0, import_promises.mkdir)(path, { recursive: true });
@@ -262,42 +264,74 @@ var init = async (config, configPath) => {
 var create = async (config, description) => {
   await createMigration(config.migrationsPath, description);
 };
-var up = async (config, max = 1e3) => {
-  const db = getDb(config);
-  await ensureMigrationTable(db);
-  const appliedMigrations = await getAppliedMigrations(db);
-  const migrationFiles = await getMigrationFiles(config.migrationsPath);
-  const newMigrations = getNewMigrations(appliedMigrations, migrationFiles);
-  console.log(`Found ${newMigrations.length} new migrations.`);
-  console.log(newMigrations.map((mig) => `	${mig}`).join("\n"));
-  for (const id of newMigrations.slice(0, max)) {
-    const migration = await getMigration(config.migrationsPath, id);
-    await applyUp(db, migration);
+var up = async (config, database, max) => {
+  if (max && !database) {
+    throw new Error("Max number of migrations requires specifying a database");
+  }
+  const databases = database ? [database] : config.instance.databases;
+  for (const databaseConfig of databases) {
+    const path = {
+      projectId: config.projectId,
+      instanceName: config.instance.name,
+      databaseName: databaseConfig.name
+    };
+    const db = getDb(path);
+    await ensureMigrationTable(db);
+    const appliedMigrations = await getAppliedMigrations(db);
+    const migrationFiles = await getMigrationFiles(
+      databaseConfig.migrationsPath
+    );
+    const newMigrations = getNewMigrations(appliedMigrations, migrationFiles);
+    console.log(`Found ${newMigrations.length} new migrations.`);
+    console.log(newMigrations.map((mig) => `	${mig}`).join("\n"));
+    const newMigrationsToApply = max ? newMigrations.slice(0, max) : newMigrations;
+    for (const id of newMigrationsToApply) {
+      const migration = await getMigration(databaseConfig.migrationsPath, id);
+      await applyUp(db, migration);
+    }
   }
 };
-var down = async (config) => {
-  const db = getDb(config);
+var down = async (config, database) => {
+  const path = {
+    projectId: config.projectId,
+    instanceName: config.instance.name,
+    databaseName: database.name
+  };
+  const db = getDb(path);
   await ensureMigrationTable(db);
   await applyDown(db);
 };
-var status = async (config) => {
-  const db = getDb(config);
-  await ensureMigrationTable(db);
-  const appliedMigrations = await getAppliedMigrations(db);
-  const migrationFiles = await getMigrationFiles(config.migrationsPath);
-  const newMigrations = getNewMigrations(appliedMigrations, migrationFiles);
-  return [
-    "Migrations",
-    "",
-    "Applied",
-    "--------------------------------------------------------------------------------",
-    `${appliedMigrations.map((m) => m.id).join("\n")}
+var status = async (config, databases) => {
+  const statuses = [];
+  for (const databaseConfig of databases || config.instance.databases) {
+    const path = {
+      projectId: config.projectId,
+      instanceName: config.instance.name,
+      databaseName: databaseConfig.name
+    };
+    const db = getDb(path);
+    await ensureMigrationTable(db);
+    const appliedMigrations = await getAppliedMigrations(db);
+    const migrationFiles = await getMigrationFiles(
+      databaseConfig.migrationsPath
+    );
+    const newMigrations = getNewMigrations(appliedMigrations, migrationFiles);
+    statuses.push(
+      [
+        `Migrations [${databaseConfig.name}]`,
+        "",
+        "Applied",
+        "--------------------------------------------------------------------------------",
+        `${appliedMigrations.map((m) => m.id).join("\n")}
 `,
-    "New",
-    "--------------------------------------------------------------------------------",
-    `${newMigrations.join("\n")}
+        "New",
+        "--------------------------------------------------------------------------------",
+        `${newMigrations.join("\n")}
 `
-  ].join("\n");
+      ].join("\n")
+    );
+  }
+  return statuses.join("\n\n");
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.mjs

@@ -4,7 +4,7 @@ import {
   init,
   status,
   up
-} from "./chunk-K5WX6ESL.mjs";
+} from "./chunk-SZDH364K.mjs";
 export {
   create,
   down,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sebspark/spanner-migrate",
-  "version": "0.1.1",
+  "version": "1.0.0",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -14,24 +14,29 @@
     "dev": "tsc --watch --noEmit",
     "lint": "biome check .",
     "test": "jest --config jest.config.ts --passWithNoTests --coverage",
-    "test:e2e": "jest --config jest.e2e.config.ts",
+    "test:e2e": "jest --config jest.e2e.config.ts --runInBand",
     "typecheck": "tsc --noEmit "
   },
   "devDependencies": {
-    "@google-cloud/spanner": "^7.17.1",
+    "@google-cloud/spanner": "7.18.1",
+    "@sebspark/cli-tester": "*",
     "@sebspark/spanner-mock": "*",
-    "@types/jest": "^29.5.14",
-    "@types/yargs": "^17.0.33",
-    "jest": "^29.7.0",
-    "testcontainers": "^10.16.0",
-    "ts-jest": "^29.2.5",
+    "@types/jest": "29.5.14",
+    "@types/yargs": "17.0.33",
+    "jest": "29.7.0",
+    "testcontainers": "10.18.0",
+    "ts-jest": "29.2.6",
     "tsconfig": "*"
   },
   "peerDependencies": {
     "@google-cloud/spanner": "*"
   },
   "dependencies": {
-    "@inquirer/input": "4.1.3",
+    "@inquirer/prompts": "7.3.2",
+    "@jest/globals": "29.7.0",
+    "@types/node": "20.17.17",
+    "typescript": "5.7.3",
+    "vitest": "3.0.7",
     "yargs": "17.7.2"
   }
 }