@ftschopp/dynatable-migrations 1.2.6 → 1.3.0

package/package.json

@@ -1,12 +1,26 @@
 {
   "name": "@ftschopp/dynatable-migrations",
-  "version": "1.2.6",
+  "version": "1.3.0",
   "description": "DynamoDB migration tool for single table design with schema versioning",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "bin": {
     "dynatable-migrate": "./bin/dynatable-migrate.js"
   },
+  "files": [
+    "dist",
+    "bin",
+    "README.md",
+    "USAGE.md",
+    "CHANGELOG.md"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -14,7 +28,9 @@
     "build": "tsc",
     "dev": "tsc --watch",
     "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
-    "test": "jest"
+    "lint": "eslint src",
+    "test": "jest",
+    "prepublishOnly": "yarn build"
   },
   "keywords": [
     "dynamodb",
@@ -29,6 +45,7 @@
     "@types/jest": "^30.0.0",
     "@types/node": "^25.0.3",
     "aws-sdk-client-mock": "^4.1.0",
+    "eslint": "^9.39.2",
     "jest": "^30.2.0",
     "ts-jest": "^29.4.6",
     "typescript": "5.9.3"
@@ -36,7 +53,21 @@
   "dependencies": {
     "@aws-sdk/client-dynamodb": "^3.965.0",
     "@aws-sdk/lib-dynamodb": "^3.965.0",
-    "commander": "^14.0.2",
-    "ts-node": "^10.9.2"
+    "commander": "^14.0.2"
+  },
+  "peerDependencies": {
+    "ts-node": "^10.9.0",
+    "typescript": ">=4.5"
+  },
+  "peerDependenciesMeta": {
+    "ts-node": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=22"
   }
 }

package/jest.config.js

@@ -1,8 +0,0 @@
-/** @type {import('jest').Config} */
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  testMatch: ['**/?(*.)+(test).[tj]s'],
-  testPathIgnorePatterns: ['/node_modules/', '/dist/'],
-  roots: ['<rootDir>/src'],
-};

package/src/cli-utils.test.ts

@@ -1,45 +0,0 @@
-import { parsePositiveInt } from './cli-utils';
-
-describe('parsePositiveInt', () => {
-  const parser = parsePositiveInt('limit');
-
-  test('accepts positive integers', () => {
-    expect(parser('1')).toBe(1);
-    expect(parser('42')).toBe(42);
-    expect(parser('1000')).toBe(1000);
-  });
-
-  test('trims surrounding whitespace before parsing', () => {
-    expect(parser('  5  ')).toBe(5);
-  });
-
-  test('rejects 0', () => {
-    expect(() => parser('0')).toThrow(/--limit must be a positive integer/);
-  });
-
-  test('rejects negative numbers', () => {
-    expect(() => parser('-5')).toThrow(/--limit must be a positive integer/);
-  });
-
-  test('rejects non-numeric input', () => {
-    expect(() => parser('abc')).toThrow(/--limit must be a positive integer/);
-  });
-
-  test('rejects floats (1.5 would parseInt to 1, but the trailing decimals are still wrong)', () => {
-    expect(() => parser('1.5')).toThrow(/--limit must be a positive integer/);
-  });
-
-  test('rejects empty string', () => {
-    expect(() => parser('')).toThrow(/--limit must be a positive integer/);
-  });
-
-  test('rejects strings with trailing junk that parseInt would silently swallow', () => {
-    // parseInt('5abc', 10) === 5, but we should refuse it because the input
-    // is clearly not a positive integer.
-    expect(() => parser('5abc')).toThrow(/--limit must be a positive integer/);
-  });
-
-  test('error mentions the flag name passed to the factory', () => {
-    expect(() => parsePositiveInt('steps')('-1')).toThrow(/--steps/);
-  });
-});

package/src/cli-utils.ts

@@ -1,18 +0,0 @@
-import { InvalidArgumentError } from 'commander';
-
-/**
- * Commander value parser that accepts only positive integers. Used for
- * `--limit` and `--steps` so `0`, negative numbers, and non-numeric input
- * fail at parse time with a clean usage error instead of silently feeding
- * `Array.prototype.slice` and producing surprising rollbacks.
- */
-export function parsePositiveInt(name: string): (raw: string) => number {
-  return (raw: string) => {
-    const trimmed = raw.trim();
-    const n = Number.parseInt(trimmed, 10);
-    if (!Number.isInteger(n) || n <= 0 || String(n) !== trimmed) {
-      throw new InvalidArgumentError(`--${name} must be a positive integer (got "${raw}").`);
-    }
-    return n;
-  };
-}

package/src/cli.ts

@@ -1,110 +0,0 @@
-#!/usr/bin/env node
-
-import { Command } from 'commander';
-import { loadConfig } from './core/config';
-import { createMigration } from './commands/create';
-import { runMigrations } from './commands/up';
-import { rollbackMigrations } from './commands/down';
-import { showStatus } from './commands/status';
-import { initProject } from './commands/init';
-import { parsePositiveInt } from './cli-utils';
-
-// Read version from package.json
-const packageJson = require('../package.json');
-
-const program = new Command();
-
-program
-  .name('dynatable-migrate')
-  .description('DynamoDB migration tool for single table design')
-  .version(packageJson.version);
-
-// Init command
-program
-  .command('init')
-  .description('Initialize migrations in current project')
-  .action(async () => {
-    try {
-      await initProject();
-    } catch (error: any) {
-      console.error(`Error: ${error.message}`);
-      process.exit(1);
-    }
-  });
-
-// Create command
-program
-  .command('create <name>')
-  .description('Create a new migration file')
-  .option('-c, --config <path>', 'Path to config file')
-  .option('-t, --type <type>', 'Version bump type: major, minor, or patch (default: patch)')
-  .option('-e, --explicit <version>', 'Explicit version (e.g., 2.0.0)')
-  .action(async (name: string, options) => {
-    try {
-      let migrationsDir = './migrations';
-
-      // Try to load config to get migrations directory
-      try {
-        const config = await loadConfig(options.config);
-        migrationsDir = config.migrationsDir || './migrations';
-      } catch {
-        // If config doesn't exist, use default
-      }
-
-      await createMigration(name, migrationsDir, options.type, options.explicit);
-    } catch (error: any) {
-      console.error(`Error: ${error.message}`);
-      process.exit(1);
-    }
-  });
-
-// Up command
-program
-  .command('up')
-  .description('Run pending migrations')
-  .option('-c, --config <path>', 'Path to config file')
-  .option('-l, --limit <number>', 'Limit number of migrations to run', parsePositiveInt('limit'))
-  .option('-d, --dry-run', 'Show what would be done without making changes')
-  .action(async (options) => {
-    try {
-      const config = await loadConfig(options.config);
-      await runMigrations(config, options.limit, options.dryRun);
-    } catch (error: any) {
-      console.error(`Error: ${error.message}`);
-      process.exit(1);
-    }
-  });
-
-// Down command
-program
-  .command('down')
-  .description('Rollback migrations')
-  .option('-c, --config <path>', 'Path to config file')
-  .option('-s, --steps <number>', 'Number of migrations to rollback', parsePositiveInt('steps'), 1)
-  .option('-d, --dry-run', 'Show what would be done without making changes')
-  .action(async (options) => {
-    try {
-      const config = await loadConfig(options.config);
-      await rollbackMigrations(config, options.steps, options.dryRun);
-    } catch (error: any) {
-      console.error(`Error: ${error.message}`);
-      process.exit(1);
-    }
-  });
-
-// Status command
-program
-  .command('status')
-  .description('Show migration status')
-  .option('-c, --config <path>', 'Path to config file')
-  .action(async (options) => {
-    try {
-      const config = await loadConfig(options.config);
-      await showStatus(config);
-    } catch (error: any) {
-      console.error(`Error: ${error.message}`);
-      process.exit(1);
-    }
-  });
-
-program.parse(process.argv);

package/src/commands/create.ts

@@ -1,111 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import { MigrationLoader } from '../core/loader';
-import { generateMigrationTemplate } from '../templates/migration';
-
-type VersionBumpType = 'major' | 'minor' | 'patch';
-
-/**
- * Get next version based on bump type
- */
-async function getNextVersion(loader: MigrationLoader, bumpType: VersionBumpType): Promise<string> {
-  const migrations = await loader['loadMigrations']();
-
-  const lastMigration = migrations.length > 0 ? migrations[migrations.length - 1] : null;
-  const lastVersion = lastMigration?.version;
-  const parts = lastVersion?.split('.');
-
-  if (!parts || parts.length !== 3 || !parts[0] || !parts[1] || !parts[2]) {
-    switch (bumpType) {
-      case 'major':
-        return '1.0.0';
-      case 'minor':
-        return '0.1.0';
-      case 'patch':
-        return '0.0.1';
-      default:
-        return '0.1.0';
-    }
-  }
-
-  const major = parseInt(parts[0], 10);
-  const minor = parseInt(parts[1], 10);
-  const patch = parseInt(parts[2], 10);
-
-  switch (bumpType) {
-    case 'major':
-      return `${major + 1}.0.0`;
-    case 'minor':
-      return `${major}.${minor + 1}.0`;
-    case 'patch':
-      return `${major}.${minor}.${patch + 1}`;
-    default:
-      return `${major}.${minor}.${patch + 1}`;
-  }
-}
-
-export async function createMigration(
-  name: string,
-  migrationsDir: string = './migrations',
-  bumpType?: string,
-  explicitVersion?: string
-): Promise<void> {
-  // Ensure migrations directory exists
-  if (!fs.existsSync(migrationsDir)) {
-    fs.mkdirSync(migrationsDir, { recursive: true });
-    console.log(`📁 Created migrations directory: ${migrationsDir}`);
-  }
-
-  // Generate version
-  const loader = new MigrationLoader(migrationsDir);
-  let version: string;
-
-  if (explicitVersion) {
-    // Validate explicit version is semver
-    if (!/^\d+\.\d+\.\d+$/.test(explicitVersion)) {
-      throw new Error(
-        `Invalid version format: ${explicitVersion}. Expected semver format (e.g., 1.0.0)`
-      );
-    }
-    version = explicitVersion;
-  } else if (bumpType) {
-    // Validate bump type
-    const validTypes: VersionBumpType[] = ['major', 'minor', 'patch'];
-    if (!validTypes.includes(bumpType as VersionBumpType)) {
-      throw new Error(`Invalid bump type: ${bumpType}. Expected: major, minor, or patch`);
-    }
-    version = await getNextVersion(loader, bumpType as VersionBumpType);
-  } else {
-    // Default: increment patch
-    version = await getNextVersion(loader, 'patch');
-  }
-
-  // Sanitize name (replace spaces and special chars with underscores)
-  const sanitizedName = name.replace(/[^a-zA-Z0-9]/g, '_').toLowerCase();
-
-  // Generate file name
-  const fileName = `${version}_${sanitizedName}.ts`;
-  const filePath = path.join(migrationsDir, fileName);
-
-  // Check if file already exists
-  if (fs.existsSync(filePath)) {
-    throw new Error(`Migration file already exists: ${filePath}`);
-  }
-
-  // Generate migration content
-  const content = generateMigrationTemplate(version, sanitizedName);
-
-  // Write file
-  fs.writeFileSync(filePath, content, 'utf-8');
-
-  // Determine version type for informational message
-  const versionType = bumpType ? bumpType.toUpperCase() : explicitVersion ? 'EXPLICIT' : 'PATCH';
-
-  console.log(`\n✅ Created migration: ${fileName}`);
-  console.log(`   Path: ${filePath}`);
-  console.log(`   Version: ${version} (${versionType})\n`);
-  console.log(`Next steps:`);
-  console.log(`  1. Edit ${fileName}`);
-  console.log(`  2. Implement up() and down() functions`);
-  console.log(`  3. Run: dynatable-migrate up\n`);
-}

package/src/commands/down.ts

@@ -1,26 +0,0 @@
-import { MigrationRunner } from '../core/runner';
-import { createDynamoDBClient } from '../core/client';
-import { MigrationConfig } from '../types';
-
-export async function rollbackMigrations(
-  config: MigrationConfig,
-  steps: number = 1,
-  dryRun: boolean = false
-): Promise<void> {
-  const client = createDynamoDBClient(config);
-  const runner = new MigrationRunner(client, config);
-
-  try {
-    const rolledBack = await runner.down(steps, dryRun);
-
-    if (!dryRun && rolledBack.length > 0) {
-      console.log(`\n🎉 Successfully rolled back ${rolledBack.length} migration(s)`);
-
-      const currentVersion = await runner.getCurrentVersion();
-      console.log(`📌 Current version: ${currentVersion}\n`);
-    }
-  } catch (error: any) {
-    console.error(`\n❌ Rollback failed: ${error.message}\n`);
-    process.exit(1);
-  }
-}

package/src/commands/init.ts

@@ -1,37 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import { ConfigLoader } from '../core/config';
-
-export async function initProject(): Promise<void> {
-  const cwd = process.cwd();
-
-  console.log('\n🚀 Initializing DynamoDB migrations\n');
-
-  // Create migrations directory
-  const migrationsDir = path.join(cwd, 'migrations');
-  if (!fs.existsSync(migrationsDir)) {
-    fs.mkdirSync(migrationsDir, { recursive: true });
-    console.log(`✅ Created: ${migrationsDir}/`);
-
-    // Create .gitkeep
-    fs.writeFileSync(path.join(migrationsDir, '.gitkeep'), '');
-  } else {
-    console.log(`⚠️  Directory already exists: ${migrationsDir}/`);
-  }
-
-  // Create config file
-  const configPath = path.join(cwd, 'dynatable.config.js');
-  if (!fs.existsSync(configPath)) {
-    ConfigLoader.createDefaultConfig(configPath);
-  } else {
-    console.log(`⚠️  Config already exists: ${configPath}`);
-  }
-
-  console.log('\n✅ Initialization complete!\n');
-  console.log('Next steps:');
-  console.log('  1. Edit dynatable.config.js with your DynamoDB settings');
-  console.log('  2. Create your first migration:');
-  console.log('     dynatable-migrate create add_user_email');
-  console.log('  3. Run migrations:');
-  console.log('     dynatable-migrate up\n');
-}

package/src/commands/status.ts

@@ -1,75 +0,0 @@
-import { MigrationRunner } from '../core/runner';
-import { createDynamoDBClient } from '../core/client';
-import { MigrationConfig } from '../types';
-
-export async function showStatus(config: MigrationConfig): Promise<void> {
-  const client = createDynamoDBClient(config);
-  const runner = new MigrationRunner(client, config);
-
-  try {
-    const statuses = await runner.status();
-    const currentVersion = await runner.getCurrentVersion();
-
-    console.log(`\n📊 Migration Status\n`);
-    console.log(`Table: ${config.tableName}`);
-    console.log(`Current version: ${currentVersion || 'v0000 (no migrations)'}`);
-    console.log(`Migrations directory: ${config.migrationsDir || './migrations'}\n`);
-
-    if (statuses.length === 0) {
-      console.log('No migrations found.\n');
-      return;
-    }
-
-    // Group by status
-    const pending = statuses.filter((s) => s.status === 'pending');
-    const applied = statuses.filter((s) => s.status === 'applied');
-    const failed = statuses.filter((s) => s.status === 'failed');
-    const rolledBack = statuses.filter((s) => s.status === 'rolled_back');
-
-    // Show applied migrations
-    if (applied.length > 0) {
-      console.log(`✅ Applied (${applied.length}):`);
-      for (const status of applied) {
-        const date = status.appliedAt ? new Date(status.appliedAt).toLocaleString() : '';
-        console.log(`   ${status.version} - ${status.name} (${date})`);
-      }
-      console.log();
-    }
-
-    // Show pending migrations
-    if (pending.length > 0) {
-      console.log(`⏳ Pending (${pending.length}):`);
-      for (const status of pending) {
-        console.log(`   ${status.version} - ${status.name}`);
-      }
-      console.log();
-    }
-
-    // Show rolled back migrations
-    if (rolledBack.length > 0) {
-      console.log(`⬅️  Rolled Back (${rolledBack.length}):`);
-      for (const status of rolledBack) {
-        console.log(`   ${status.version} - ${status.name}`);
-      }
-      console.log();
-    }
-
-    // Show failed migrations
-    if (failed.length > 0) {
-      console.log(`❌ Failed (${failed.length}):`);
-      for (const status of failed) {
-        console.log(`   ${status.version} - ${status.name}`);
-        if (status.error) {
-          console.log(`      Error: ${status.error}`);
-        }
-      }
-      console.log();
-    }
-
-    // Summary
-    console.log(`Total: ${statuses.length} migration(s)\n`);
-  } catch (error: any) {
-    console.error(`\n❌ Failed to get status: ${error.message}\n`);
-    process.exit(1);
-  }
-}

package/src/commands/up.ts

@@ -1,26 +0,0 @@
-import { MigrationRunner } from '../core/runner';
-import { createDynamoDBClient } from '../core/client';
-import { MigrationConfig } from '../types';
-
-export async function runMigrations(
-  config: MigrationConfig,
-  limit?: number,
-  dryRun: boolean = false
-): Promise<void> {
-  const client = createDynamoDBClient(config);
-  const runner = new MigrationRunner(client, config);
-
-  try {
-    const executed = await runner.up({ limit, dryRun });
-
-    if (!dryRun && executed.length > 0) {
-      console.log(`\n🎉 Successfully applied ${executed.length} migration(s)`);
-
-      const currentVersion = await runner.getCurrentVersion();
-      console.log(`📌 Current version: ${currentVersion}\n`);
-    }
-  } catch (error: any) {
-    console.error(`\n❌ Migration failed: ${error.message}\n`);
-    process.exit(1);
-  }
-}

package/src/core/client.ts

@@ -1,24 +0,0 @@
-import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
-import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
-import { MigrationConfig } from '../types';
-
-/**
- * Create a DynamoDB Document Client from config
- */
-export function createDynamoDBClient(config: MigrationConfig): DynamoDBDocumentClient {
-  const ddbClient = new DynamoDBClient({
-    region: config.client.region,
-    endpoint: config.client.endpoint,
-    credentials: config.client.credentials,
-  });
-
-  return DynamoDBDocumentClient.from(ddbClient, {
-    marshallOptions: {
-      removeUndefinedValues: true,
-      convertClassInstanceToMap: true,
-    },
-    unmarshallOptions: {
-      wrapNumbers: false,
-    },
-  });
-}