pgroll 0.0.8 → 0.0.10

package/README.md

@@ -1,60 +1,204 @@
-#
-
 # pgroll
 
-`pgroll` is a thread-safe, lightweight and flexible database migration tool for PostgreSQL
+[![npm version](https://img.shields.io/npm/v/pgroll.svg)](https://www.npmjs.com/package/pgroll)
+[![license](https://img.shields.io/npm/l/pgroll.svg)](./LICENSE)
+[![node](https://img.shields.io/node/v/pgroll.svg)](https://nodejs.org)
 
-PostgreSQL clients currently supporting:
+A thread-safe, lightweight, and flexible database migration tool for **PostgreSQL**.
 
-- [x] PostgresJS
-- [ ] pg
-- [ ] ...
+`pgroll` runs your plain-SQL migrations through the [`postgres`](https://github.com/porsager/postgres)
+(PostgresJS) client. Migrations are applied inside a transaction and guarded by a session-level
+advisory lock, so it is safe to run concurrently from multiple processes — only one migration runs
+at a time.
 
-`postgresjs` client. It offers simple commands to manage your database schema changes with `up`, `down`, `create`, and `go` features.
+> **Supported PostgreSQL clients**
+>
+> - [x] PostgresJS
+> - [ ] node-postgres (`pg`)
 
 ## Features
 
-- **up**: Apply all pending migrations.
-- **down**: Rollback the last applied migration.
-- **create**: Create new migration files.
-- **go**: Migrate the database schema to a specific version.
+- **up** — Apply all pending migrations.
+- **down** — Roll back **all** applied migrations (down to version `0`).
+- **go** — Migrate forward or backward to a specific version (`go 0` reverts everything).
+- **create** — Generate a matching up/down migration file pair.
+
+## Requirements
+
+- **Node.js ≥ 24.16.0** (the package ships as ESM)
+- A reachable **PostgreSQL** database
 
 ## Installation
 
-You can install `pgroll` via npm:
+Install globally to use the CLI anywhere:
+
+```bash
+npm install -g pgroll
+```
+
+…or add it to a project and run it with `npx`:
 
 ```bash
 npm install pgroll
 ```
 
-## Usage
+## Configuration
 
-### Command Line Interface (CLI)
+### Connecting to PostgreSQL
 
-`pgroll` provides a CLI to manage your database migrations. Below are the available commands:
+The CLI connects using a connection URL or the standard libpq environment variables (read by the
+underlying `postgres` client).
 
-#### Running the CLI
+**Option 1 — connection URL** via the `-u, --url` flag:
 
-1. Run Migrations Up:
+```bash
+npx pgroll --url "postgres://user:password@localhost:5432/mydb" up
+```
+
+**Option 2 — environment variables:**
+
+| Variable     | Description   | Default      |
+| ------------ | ------------- | ------------ |
+| `PGHOST`     | Server host   | `localhost`  |
+| `PGPORT`     | Server port   | `5432`       |
+| `PGDATABASE` | Database name | —            |
+| `PGUSER`     | User name     | OS user name |
+| `PGPASSWORD` | Password      | —            |
+
+```bash
+PGHOST=localhost PGDATABASE=mydb PGUSER=me PGPASSWORD=secret npx pgroll up
+```
+
+When `--url` is provided, it takes precedence over the `PG*` variables.
+
+### Migration files
+
+Migrations live in a directory (default `./migrations`, override with `-d, --migrationDir <path>`).
+Each migration is a **pair** of plain `.sql` files distinguished by suffix:
+
+```
+20240619121610402_init_up.sql     # applied on "up"
+20240619121610402_init_down.sql   # applied on "down"
+```
+
+- The leading number is a timestamp generated by `create`; it determines order.
+- `up` migrations are applied in **ascending** filename order; `down` migrations in **descending**
+  order, so rollbacks unwind in the reverse of how they were applied.
+- A migration's _version_ is its position in that ordered list (the first up migration is version `1`).
+
+## CLI
+
+```text
+pgroll [global options] <command>
+```
+
+### Global options
+
+| Option                      | Description                                                        |
+| --------------------------- | ------------------------------------------------------------------ |
+| `-d, --migrationDir <path>` | Directory holding the migration files (default: `./migrations`).   |
+| `-u, --url <url>`           | PostgreSQL connection URL (overrides `PG*` env vars).              |
+| `-s, --schema <schema>`     | Schema for pgroll's internal migrations table (default: `public`). |
+| `-V, --version`             | Print the `pgroll` version.                                        |
+| `-h, --help`                | Show help.                                                         |
+
+### Commands
+
+**Apply all pending migrations:**
 
 ```bash
 npx pgroll up
 ```
 
-2. Run Migrations Down:
+**Roll back every applied migration:**
 
 ```bash
 npx pgroll down
 ```
 
-3. Navigate to a Specific Version:
+**Migrate to a specific version** (moves up or down as needed; `0` rolls everything back):
 
 ```bash
 npx pgroll go <version>
 ```
 
-4. Create New Migration Files:
+**Create a new migration pair** (writes `<timestamp>_<name>_up.sql` and `..._down.sql` with
+placeholder contents for you to fill in):
 
 ```bash
-npx pgroll create <migration-name>
+npx pgroll create <name>
+```
+
+A typical workflow:
+
+```bash
+npx pgroll create add_users_table   # creates the up/down file pair
+# …edit the generated *_up.sql / *_down.sql files…
+npx pgroll up                        # apply it
+```
+
+## Programmatic API
+
+`pgroll` can also be used as a library. Pass it a `postgres` client instance and drive migrations
+directly:
+
+```ts
+import postgres from 'postgres';
+import { Migrator } from 'pgroll';
+
+const sql = postgres('postgres://user:password@localhost:5432/mydb');
+const migrator = new Migrator(sql, './migrations');
+
+// Apply all pending migrations
+await migrator.up();
+
+console.log('Current version:', await migrator.getCurrentVersion());
+
+// Migrate to a specific version, logging progress as it goes
+await migrator.go(0, { eventHandler: info => console.log(info) });
+
+await sql.end();
 ```
+
+### `new Migrator(dbClient, migrationsDir?, schema?)`
+
+| Parameter       | Type                | Description                                                          |
+| --------------- | ------------------- | -------------------------------------------------------------------- |
+| `dbClient`      | `Sql` (PostgresJS)  | A `postgres` client instance.                                        |
+| `migrationsDir` | `string` (optional) | Directory of migration files. Defaults to `<cwd>/migrations`.        |
+| `schema`        | `string` (optional) | Schema for pgroll's internal migrations table. Defaults to `public`. |
+
+### Methods
+
+| Method                | Description                                                             |
+| --------------------- | ----------------------------------------------------------------------- |
+| `up(opts?)`           | Apply all pending up migrations.                                        |
+| `down(opts?)`         | Roll back all applied migrations (to version `0`).                      |
+| `go(version, opts?)`  | Migrate forward or backward to `version` (`0` reverts everything).      |
+| `getCurrentVersion()` | Resolve to the highest applied version (`0` if none have been applied). |
+
+`opts` is `{ eventHandler: (info: string) => void }` — an optional callback invoked with a
+human-readable message as each migration is applied.
+
+## How it works
+
+On the first run, `pgroll` creates a bookkeeping table in the configured schema (default
+`public`, override with `-s, --schema`). All references to it are schema-qualified, so it is
+unaffected by any `search_path` a migration sets:
+
+```sql
+CREATE TABLE IF NOT EXISTS <schema>.migrations (
+  name       varchar(500) PRIMARY KEY,
+  version    smallint NOT NULL,
+  applied_at timestamp DEFAULT CURRENT_TIMESTAMP
+);
+```
+
+Each `up`/`down`/`go` run reserves a single connection, takes a session-level
+`pg_advisory_lock`, and applies the relevant migration files within a transaction — recording or
+removing the corresponding rows in `migrations` as it goes. The advisory lock serializes concurrent
+runs across processes, and the surrounding transaction means a failed migration rolls back cleanly.
+
+## License
+
+[ISC](./LICENSE)

package/dist/src/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/{esm/src → src}/cli.js

@@ -1,28 +1,33 @@
-import { __awaiter } from "tslib";
+#!/usr/bin/env node
+/* eslint-disable no-console */
 import * as process from 'node:process';
 import { Command } from 'commander';
 import postgres from 'postgres';
-import { createFile } from './utils';
-import { Migrator } from './index';
+import { Migrator } from "./index.js";
+import { createFile } from "./utils.js";
 const program = new Command();
 let migrator;
 program
-    .version('0.0.1')
+    .version('0.0.9')
     .description('Database migration tool')
-    .option('-d, --migrationDir <filepath>', 'Specify migration directory(Default: ./migrations)')
+    .option('-d, --migrationDir <filepath>', 'Specify migration directory (Default: ./migrations)')
+    .option('-u, --url <url>', 'PostgreSQL connection URL (overrides PG* env vars)')
+    .option('-s, --schema <schema>', 'Specify schema (Default: public)')
     .hook('preAction', cmd => {
     const opts = cmd.opts();
-    migrator = new Migrator(postgres({
+    const pgOptions = {
         onnotice: () => {
+            // do nothing
         }
-    }), opts.migrationDir);
+    };
+    migrator = new Migrator(opts.url ? postgres(opts.url, pgOptions) : postgres(pgOptions), opts.migrationDir, opts.schema);
 });
 program
     .command('up')
     .description('Run all up migrations')
-    .action(() => __awaiter(void 0, void 0, void 0, function* () {
+    .action(async () => {
     try {
-        yield migrator.up({ eventHandler: console.log });
+        await migrator.up({ eventHandler: console.log });
         console.log('Migrations up completed successfully.');
         process.exit(0);
     }
@@ -30,13 +35,13 @@ program
         console.error('Error during migrations up:', error);
         process.exit(1);
     }
-}));
+});
 program
     .command('down')
     .description('Run all down migrations')
-    .action(() => __awaiter(void 0, void 0, void 0, function* () {
+    .action(async () => {
     try {
-        yield migrator.down({ eventHandler: console.log });
+        await migrator.down({ eventHandler: console.log });
         console.log('Migrations down completed successfully.');
         process.exit(0);
     }
@@ -44,7 +49,7 @@ program
         console.error('Error during migrations down:', error);
         process.exit(1);
     }
-}));
+});
 program
     .command('create')
     .description('Generate migration files in the migrations folder: one for applying changes (up), and one for reverting them (down).')
@@ -59,19 +64,19 @@ program
     .command('go')
     .description('Navigate to a specific version; version 0 performs a rollback, reverting all migrations.')
     .argument('<version>', 'version to migrate to')
-    .action((version) => __awaiter(void 0, void 0, void 0, function* () {
-    const parsedVersion = Number.parseInt(version, 10);
-    if (Number.isNaN(parsedVersion)) {
+    .action(async (version) => {
+    const parsedVersion = Number(version);
+    if (!Number.isSafeInteger(parsedVersion) || parsedVersion < 0) {
         console.error('Invalid version number.');
         process.exit(1);
     }
     try {
-        yield migrator.go(parsedVersion, { eventHandler: console.log });
+        await migrator.go(parsedVersion, { eventHandler: console.log });
         process.exit(0);
     }
     catch (error) {
         console.error('Error during migrations:', error);
         process.exit(1);
     }
-}));
+});
 program.parse(process.argv);

package/dist/{esm/src → src}/index.d.ts

@@ -1,10 +1,11 @@
-import { ReservedSql, Sql } from 'postgres';
-import { Direction } from './utils';
+import { type ReservedSql, type Sql } from 'postgres';
+import { type Direction } from './utils.ts';
 interface Option {
     eventHandler: (info: string) => void;
 }
 export interface IMigrator {
     migrationsDir: string;
+    schema: string;
     up: (opts?: Option) => Promise<void>;
     down: (opts?: Option) => Promise<void>;
     go: (version: number, opts?: Option) => Promise<void>;
@@ -13,7 +14,8 @@ export interface IMigrator {
 export declare class Migrator implements IMigrator {
     private readonly dbClient;
     readonly migrationsDir: string;
-    constructor(dbClient: Sql, migrationsDir?: string);
+    readonly schema: string;
+    constructor(dbClient: Sql, migrationsDir?: string, schema?: string);
     ensureMigrationTable(tx: ReservedSql): Promise<void>;
     up(): Promise<void>;
     down(): Promise<void>;

package/dist/src/index.js

@@ -0,0 +1,138 @@
+import path from 'node:path';
+import {} from 'postgres';
+import { getMigrationFiles } from "./utils.js";
+export class Migrator {
+    dbClient;
+    migrationsDir;
+    schema;
+    constructor(dbClient, migrationsDir = '', schema = 'public') {
+        this.dbClient = dbClient;
+        this.migrationsDir = migrationsDir || `${process.cwd()}/migrations`;
+        this.schema = schema;
+    }
+    async ensureMigrationTable(tx) {
+        await tx `CREATE SCHEMA IF NOT EXISTS ${tx(this.schema)}`;
+        await tx `CREATE TABLE IF NOT EXISTS ${tx(this.schema)}.migrations(
+                        name varchar(500) PRIMARY KEY,
+                        version smallint NOT NULL,
+                        applied_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);`;
+    }
+    async up() {
+        return this.migrate('up');
+    }
+    async down() {
+        return this.migrate('down');
+    }
+    async go(version, opts) {
+        const tx = await this.dbClient.reserve();
+        try {
+            await this.acquireLock(tx);
+            await this.begin(tx);
+            await this.ensureMigrationTable(tx);
+            const currentVersion = await this.getCurrentVersionWithTx(tx);
+            if (currentVersion === version) {
+                opts?.eventHandler(`Already at version ${version}`);
+                await this.commit(tx);
+                return;
+            }
+            const direction = version > currentVersion ? 'up' : 'down';
+            const fileNames = getMigrationFiles(this.migrationsDir, direction);
+            if (direction === 'up') {
+                const fileVersion = Math.min(fileNames.length, version);
+                for (let i = currentVersion; i < fileVersion; i++) {
+                    const file = fileNames[i] ?? '';
+                    await tx.file(path.join(this.migrationsDir, file)).execute();
+                    await tx `INSERT INTO ${tx(this.schema)}.migrations(name, version) VALUES (${file}, ${i} + 1)`;
+                    opts?.eventHandler(`Successfully migrated: ${file}`);
+                }
+                if (version > fileNames.length) {
+                    opts?.eventHandler(`Currently at latest version: ${currentVersion}`);
+                }
+            }
+            else {
+                // get index of the current file
+                const start = fileNames.length - currentVersion;
+                // current index + number of file to down
+                const end = start + (currentVersion - version);
+                for (let i = start; i < end; i++) {
+                    const file = fileNames[i] ?? '';
+                    await tx.file(path.join(this.migrationsDir, file)).execute();
+                    await tx `DELETE FROM ${tx(this.schema)}.migrations WHERE version = ${fileNames.length - i}`;
+                    opts?.eventHandler(`Successfully migrated: ${file}`);
+                }
+            }
+            await this.commit(tx);
+        }
+        catch (error) {
+            await this.rollback(tx);
+            throw error;
+        }
+        finally {
+            await this.releaseLock(tx);
+            tx.release();
+        }
+    }
+    async migrate(direction, opts) {
+        const tx = await this.dbClient.reserve();
+        try {
+            await this.acquireLock(tx);
+            await this.begin(tx);
+            await this.ensureMigrationTable(tx);
+            const currentVersion = await this.getCurrentVersionWithTx(tx);
+            const fileNames = getMigrationFiles(this.migrationsDir, direction);
+            if (direction === 'up') {
+                for (const fileName of fileNames) {
+                    const id = fileNames.indexOf(fileName);
+                    if (id >= currentVersion) {
+                        await tx.file(path.join(this.migrationsDir, fileName)).execute();
+                        await tx `INSERT INTO ${tx(this.schema)}.migrations(name, version) VALUES (${fileName}, ${id} + 1)`;
+                        opts?.eventHandler(`Successfully migrated: ${fileName}`);
+                    }
+                }
+            }
+            else {
+                // calculate start to know where the down migration starts
+                const start = fileNames.length - currentVersion;
+                for (let i = start; i < fileNames.length; i++) {
+                    const file = fileNames[i] ?? '';
+                    await tx.file(path.join(this.migrationsDir, file)).execute();
+                    await tx `DELETE FROM ${tx(this.schema)}.migrations WHERE version = ${fileNames.length - i}`;
+                    opts?.eventHandler(`Successfully migrated: ${file}`);
+                }
+            }
+            await this.commit(tx);
+        }
+        catch (error) {
+            await this.rollback(tx);
+            throw error;
+        }
+        finally {
+            await this.releaseLock(tx);
+            tx.release();
+        }
+    }
+    async getCurrentVersion() {
+        const result = await this
+            .dbClient `SELECT version FROM ${this.dbClient(this.schema)}.migrations ORDER BY version DESC LIMIT 1`;
+        return result.length > 0 ? result[0]?.['version'] : 0;
+    }
+    async getCurrentVersionWithTx(tx) {
+        const result = await tx `SELECT version FROM ${tx(this.schema)}.migrations ORDER BY version DESC LIMIT 1`;
+        return result.length > 0 ? result[0]?.['version'] : 0;
+    }
+    async acquireLock(tx) {
+        await tx `SELECT pg_advisory_lock(21421431414441411)`;
+    }
+    async releaseLock(tx) {
+        await tx `SELECT pg_advisory_unlock(21421431414441411)`;
+    }
+    async begin(tx) {
+        await tx `BEGIN`;
+    }
+    async commit(tx) {
+        await tx `COMMIT`;
+    }
+    async rollback(tx) {
+        await tx `ROLLBACK`;
+    }
+}

package/dist/{esm/src → src}/utils.js

@@ -1,10 +1,8 @@
 import fs from 'node:fs';
 import path from 'node:path';
 export const getMigrationFiles = (dir, direction) => {
-    const files = fs
-        .readdirSync(dir)
-        .filter(file => file.endsWith(`_${direction}.sql`));
-    if (direction == 'up') {
+    const files = fs.readdirSync(dir).filter(file => file.endsWith(`_${direction}.sql`));
+    if (direction === 'up') {
         return files.toSorted((a, b) => a.localeCompare(b));
     }
     return files.toSorted((a, b) => b.localeCompare(a));
@@ -18,10 +16,12 @@ export const createFile = (migrationDir, name) => {
     createFolderIfNotExists(migrationDir);
     const timestamp = new Date().toISOString().replaceAll(/[.:TZ-]/g, '');
     const ressult = [];
+    // make up file
     let fileName = `${timestamp}_${name}_up.sql`;
     let filePath = path.join(migrationDir, fileName);
     fs.writeFileSync(filePath, '-- up SQL here');
     ressult.push(filePath);
+    // make down file
     fileName = `${timestamp}_${name}_down.sql`;
     filePath = path.join(migrationDir, fileName);
     fs.writeFileSync(filePath, '-- down SQL here');

package/package.json

@@ -1,20 +1,25 @@
 {
   "name": "pgroll",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "description": "Postgres migration tool",
-  "main": "dist/cjs/src/index.js",
-  "module": "dist/esm/src/index.js",
-  "types": "dist/cjs/src/index.d.ts",
+  "type": "module",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/tnht95/pgroll.git"
   },
   "files": [
-    "dist/cjs/src",
-    "dist/esm/src"
+    "dist/src"
   ],
   "bin": {
-    "pgroll": "dist/cjs/src/cli.js"
+    "pgroll": "dist/src/cli.js"
   },
   "keywords": [
     "postgres",
@@ -26,48 +31,43 @@
   ],
   "scripts": {
     "preinstall": "npx only-allow pnpm",
-    "dev": "tsx ./src/cli.ts",
-    "build-cjs": "tsc -p tsconfig.cjs.json",
-    "build-esm": "tsc -p tsconfig.esm.json",
-    "build": "rm -rf dist && pnpm build-cjs && pnpm build-esm",
-    "start": "node ./dist/index.js",
+    "dev": "node --watch ./src/cli.ts",
+    "build": "rm -rf dist && tsc -p tsconfig.build.json",
+    "start": "node ./dist/src/cli.js",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "lint": "eslint . --fix",
     "lint:check": "eslint .",
-    "test": "jest",
-    "pp": "pnpm build && node update-version && npm publish --access=public"
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "pp": "pnpm build && node update-version.ts && npm publish --access=public"
   },
   "packageManager": "pnpm@10.28.1+sha512.7d7dbbca9e99447b7c3bf7a73286afaaf6be99251eb9498baefa7d406892f67b879adb3a1d7e687fc4ccc1a388c7175fbaae567a26ab44d1067b54fcb0d6a316",
   "engines": {
-    "node": ">=v24.13.0"
+    "node": ">=v24.16.0"
   },
   "license": "ISC",
   "devDependencies": {
-    "@eslint/compat": "^2.0.1",
-    "@eslint/eslintrc": "^3.3.3",
-    "@eslint/js": "^9.39.2",
-    "@types/jest": "^30.0.0",
-    "@types/node": "^25.0.9",
-    "@typescript-eslint/eslint-plugin": "^8.53.1",
-    "eslint": "^9.39.2",
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^26.0.1",
+    "@vitest/coverage-v8": "^4.1.9",
+    "@vitest/eslint-plugin": "^1.6.20",
+    "eslint": "^10.5.0",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-import-resolver-typescript": "^4.4.4",
-    "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-jest": "^29.12.1",
-    "eslint-plugin-promise": "^7.2.1",
-    "eslint-plugin-sonarjs": "^3.0.5",
-    "eslint-plugin-unicorn": "^62.0.0",
-    "jest": "^30.2.0",
-    "prettier": "^3.8.0",
-    "ts-jest": "^29.4.6",
-    "tsx": "^4.21.0",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.53.1"
+    "eslint-import-resolver-typescript": "^4.4.5",
+    "eslint-plugin-import-x": "^4.17.0",
+    "eslint-plugin-promise": "^7.3.0",
+    "eslint-plugin-sonarjs": "^4.1.0",
+    "eslint-plugin-unicorn": "^69.0.0",
+    "globals": "^17.7.0",
+    "prettier": "^3.8.4",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.62.0",
+    "vitest": "^4.1.9"
   },
   "dependencies": {
-    "commander": "^14.0.2",
-    "postgres": "^3.4.8",
-    "tslib": "^2.8.1"
+    "commander": "^15.0.0",
+    "postgres": "^3.4.9"
   }
 }

package/dist/cjs/src/cli.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/cjs/src/cli.js

@@ -1,79 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const process = tslib_1.__importStar(require("node:process"));
-const commander_1 = require("commander");
-const postgres_1 = tslib_1.__importDefault(require("postgres"));
-const utils_1 = require("./utils");
-const index_1 = require("./index");
-const program = new commander_1.Command();
-let migrator;
-program
-    .version('0.0.1')
-    .description('Database migration tool')
-    .option('-d, --migrationDir <filepath>', 'Specify migration directory(Default: ./migrations)')
-    .hook('preAction', cmd => {
-    const opts = cmd.opts();
-    migrator = new index_1.Migrator((0, postgres_1.default)({
-        onnotice: () => {
-        }
-    }), opts.migrationDir);
-});
-program
-    .command('up')
-    .description('Run all up migrations')
-    .action(() => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-    try {
-        yield migrator.up({ eventHandler: console.log });
-        console.log('Migrations up completed successfully.');
-        process.exit(0);
-    }
-    catch (error) {
-        console.error('Error during migrations up:', error);
-        process.exit(1);
-    }
-}));
-program
-    .command('down')
-    .description('Run all down migrations')
-    .action(() => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-    try {
-        yield migrator.down({ eventHandler: console.log });
-        console.log('Migrations down completed successfully.');
-        process.exit(0);
-    }
-    catch (error) {
-        console.error('Error during migrations down:', error);
-        process.exit(1);
-    }
-}));
-program
-    .command('create')
-    .description('Generate migration files in the migrations folder: one for applying changes (up), and one for reverting them (down).')
-    .argument('<filename>', 'file name to be created')
-    .action((fileName) => {
-    const result = (0, utils_1.createFile)(migrator.migrationsDir, fileName);
-    for (const f of result)
-        console.log(`Successfully created migration files: ${f}`);
-    process.exit(0);
-});
-program
-    .command('go')
-    .description('Navigate to a specific version; version 0 performs a rollback, reverting all migrations.')
-    .argument('<version>', 'version to migrate to')
-    .action((version) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-    const parsedVersion = Number.parseInt(version, 10);
-    if (Number.isNaN(parsedVersion)) {
-        console.error('Invalid version number.');
-        process.exit(1);
-    }
-    try {
-        yield migrator.go(parsedVersion, { eventHandler: console.log });
-        process.exit(0);
-    }
-    catch (error) {
-        console.error('Error during migrations:', error);
-        process.exit(1);
-    }
-}));
-program.parse(process.argv);

package/dist/cjs/src/index.d.ts

@@ -1,30 +0,0 @@
-import { ReservedSql, Sql } from 'postgres';
-import { Direction } from './utils';
-interface Option {
-    eventHandler: (info: string) => void;
-}
-export interface IMigrator {
-    migrationsDir: string;
-    up: (opts?: Option) => Promise<void>;
-    down: (opts?: Option) => Promise<void>;
-    go: (version: number, opts?: Option) => Promise<void>;
-    getCurrentVersion: () => Promise<number>;
-}
-export declare class Migrator implements IMigrator {
-    private readonly dbClient;
-    readonly migrationsDir: string;
-    constructor(dbClient: Sql, migrationsDir?: string);
-    ensureMigrationTable(tx: ReservedSql): Promise<void>;
-    up(): Promise<void>;
-    down(): Promise<void>;
-    go(version: number, opts?: Option): Promise<void>;
-    migrate(direction: Direction, opts?: Option): Promise<void>;
-    getCurrentVersion(): Promise<number>;
-    getCurrentVersionWithTx(tx: ReservedSql): Promise<number>;
-    acquireLock(tx: ReservedSql): Promise<void>;
-    releaseLock(tx: ReservedSql): Promise<void>;
-    begin(tx: ReservedSql): Promise<void>;
-    commit(tx: ReservedSql): Promise<void>;
-    rollback(tx: ReservedSql): Promise<void>;
-}
-export {};

package/dist/cjs/src/index.js

@@ -1,181 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Migrator = void 0;
-const tslib_1 = require("tslib");
-const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const utils_1 = require("./utils");
-class Migrator {
-    constructor(dbClient, migrationsDir = '') {
-        Object.defineProperty(this, "dbClient", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "migrationsDir", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.dbClient = dbClient;
-        this.migrationsDir = migrationsDir || `${process.cwd()}/migrations`;
-    }
-    ensureMigrationTable(tx) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            yield tx `CREATE TABLE IF NOT EXISTS migrations(
-                        name varchar(500) PRIMARY KEY,
-                        version smallint NOT NULL,
-                        applied_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);`;
-        });
-    }
-    up() {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            return this.migrate('up');
-        });
-    }
-    down() {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            return this.migrate('down');
-        });
-    }
-    go(version, opts) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            const tx = yield this.dbClient.reserve();
-            try {
-                yield this.acquireLock(tx);
-                yield this.begin(tx);
-                yield this.ensureMigrationTable(tx);
-                const currentVersion = yield this.getCurrentVersionWithTx(tx);
-                if (currentVersion === version) {
-                    opts === null || opts === void 0 ? void 0 : opts.eventHandler(`Already at version ${version}`);
-                    return;
-                }
-                const direction = version > currentVersion ? 'up' : 'down';
-                const fileNames = (0, utils_1.getMigrationFiles)(this.migrationsDir, direction);
-                if (direction === 'up') {
-                    const fileVersion = Math.min(fileNames.length, version);
-                    for (let i = currentVersion; i < fileVersion; i++) {
-                        const file = (_a = fileNames[i]) !== null && _a !== void 0 ? _a : '';
-                        yield Promise.all([
-                            tx.file(node_path_1.default.join(this.migrationsDir, file)).execute(),
-                            tx `INSERT INTO migrations(name, version) VALUES (${file}, ${i} + 1)`
-                        ]);
-                        opts === null || opts === void 0 ? void 0 : opts.eventHandler(`Successfully migrated: ${file}`);
-                    }
-                    if (version > fileNames.length) {
-                        opts === null || opts === void 0 ? void 0 : opts.eventHandler(`Currently at latest version: ${currentVersion}`);
-                    }
-                }
-                else {
-                    const start = fileNames.length - currentVersion;
-                    const end = start + (currentVersion - version);
-                    for (let i = start; i < end; i++) {
-                        const file = (_b = fileNames[i]) !== null && _b !== void 0 ? _b : '';
-                        yield Promise.all([
-                            tx.file(node_path_1.default.join(this.migrationsDir, file)).execute(),
-                            tx `DELETE FROM migrations WHERE version = ${fileNames.length - i}`
-                        ]);
-                        opts === null || opts === void 0 ? void 0 : opts.eventHandler(`Successfully migrated: ${file}`);
-                    }
-                }
-                yield this.commit(tx);
-            }
-            catch (error) {
-                yield this.rollback(tx);
-                throw error;
-            }
-            finally {
-                yield this.releaseLock(tx);
-                tx.release();
-            }
-        });
-    }
-    migrate(direction, opts) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            var _a;
-            const tx = yield this.dbClient.reserve();
-            try {
-                yield this.acquireLock(tx);
-                yield this.begin(tx);
-                yield this.ensureMigrationTable(tx);
-                const currentVersion = yield this.getCurrentVersionWithTx(tx);
-                const fileNames = (0, utils_1.getMigrationFiles)(this.migrationsDir, direction);
-                if (direction === 'up') {
-                    for (const fileName of fileNames) {
-                        const id = fileNames.indexOf(fileName);
-                        if (id >= currentVersion) {
-                            yield Promise.all([
-                                tx.file(node_path_1.default.join(this.migrationsDir, fileName)).execute(),
-                                tx `INSERT INTO migrations(name, version) VALUES (${fileName}, ${id} + 1)`
-                            ]);
-                            opts === null || opts === void 0 ? void 0 : opts.eventHandler(`Successfully migrated: ${fileName}`);
-                        }
-                    }
-                }
-                else {
-                    const start = fileNames.length - currentVersion;
-                    for (let i = start; i < fileNames.length; i++) {
-                        const file = (_a = fileNames[i]) !== null && _a !== void 0 ? _a : '';
-                        yield Promise.all([
-                            tx.file(node_path_1.default.join(this.migrationsDir, file)).execute(),
-                            tx `DELETE FROM migrations WHERE version = ${fileNames.length - i}`
-                        ]);
-                        opts === null || opts === void 0 ? void 0 : opts.eventHandler(`Successfully migrated: ${file}`);
-                    }
-                }
-                yield this.commit(tx);
-            }
-            catch (error) {
-                yield this.rollback(tx);
-                throw error;
-            }
-            finally {
-                yield this.releaseLock(tx);
-                tx.release();
-            }
-        });
-    }
-    getCurrentVersion() {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            var _a;
-            const result = yield this
-                .dbClient `SELECT version FROM migrations ORDER BY version DESC LIMIT 1`;
-            return result.length > 0 ? (_a = result[0]) === null || _a === void 0 ? void 0 : _a['version'] : 0;
-        });
-    }
-    getCurrentVersionWithTx(tx) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            var _a;
-            const result = yield tx `SELECT version FROM migrations ORDER BY version DESC LIMIT 1`;
-            return result.length > 0 ? (_a = result[0]) === null || _a === void 0 ? void 0 : _a['version'] : 0;
-        });
-    }
-    acquireLock(tx) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            yield tx `SELECT pg_advisory_lock(21421431414441411)`;
-        });
-    }
-    releaseLock(tx) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            yield tx `SELECT pg_advisory_unlock(21421431414441411)`;
-        });
-    }
-    begin(tx) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            yield tx `BEGIN`;
-        });
-    }
-    commit(tx) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            yield tx `COMMIT`;
-        });
-    }
-    rollback(tx) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            yield tx `ROLLBACK`;
-        });
-    }
-}
-exports.Migrator = Migrator;

package/dist/cjs/src/utils.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createFile = exports.createFolderIfNotExists = exports.getMigrationFiles = void 0;
-const tslib_1 = require("tslib");
-const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
-const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const getMigrationFiles = (dir, direction) => {
-    const files = node_fs_1.default
-        .readdirSync(dir)
-        .filter(file => file.endsWith(`_${direction}.sql`));
-    if (direction == 'up') {
-        return files.toSorted((a, b) => a.localeCompare(b));
-    }
-    return files.toSorted((a, b) => b.localeCompare(a));
-};
-exports.getMigrationFiles = getMigrationFiles;
-const createFolderIfNotExists = (filePath) => {
-    if (!node_fs_1.default.existsSync(filePath)) {
-        node_fs_1.default.mkdirSync(filePath, { recursive: true });
-    }
-};
-exports.createFolderIfNotExists = createFolderIfNotExists;
-const createFile = (migrationDir, name) => {
-    (0, exports.createFolderIfNotExists)(migrationDir);
-    const timestamp = new Date().toISOString().replaceAll(/[.:TZ-]/g, '');
-    const ressult = [];
-    let fileName = `${timestamp}_${name}_up.sql`;
-    let filePath = node_path_1.default.join(migrationDir, fileName);
-    node_fs_1.default.writeFileSync(filePath, '-- up SQL here');
-    ressult.push(filePath);
-    fileName = `${timestamp}_${name}_down.sql`;
-    filePath = node_path_1.default.join(migrationDir, fileName);
-    node_fs_1.default.writeFileSync(filePath, '-- down SQL here');
-    ressult.push(filePath);
-    return ressult;
-};
-exports.createFile = createFile;

package/dist/esm/src/cli.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/src/index.js

@@ -1,177 +0,0 @@
-import { __awaiter } from "tslib";
-import path from 'node:path';
-import { getMigrationFiles } from './utils';
-export class Migrator {
-    constructor(dbClient, migrationsDir = '') {
-        Object.defineProperty(this, "dbClient", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "migrationsDir", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.dbClient = dbClient;
-        this.migrationsDir = migrationsDir || `${process.cwd()}/migrations`;
-    }
-    ensureMigrationTable(tx) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield tx `CREATE TABLE IF NOT EXISTS migrations(
-                        name varchar(500) PRIMARY KEY,
-                        version smallint NOT NULL,
-                        applied_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);`;
-        });
-    }
-    up() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.migrate('up');
-        });
-    }
-    down() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.migrate('down');
-        });
-    }
-    go(version, opts) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            const tx = yield this.dbClient.reserve();
-            try {
-                yield this.acquireLock(tx);
-                yield this.begin(tx);
-                yield this.ensureMigrationTable(tx);
-                const currentVersion = yield this.getCurrentVersionWithTx(tx);
-                if (currentVersion === version) {
-                    opts === null || opts === void 0 ? void 0 : opts.eventHandler(`Already at version ${version}`);
-                    return;
-                }
-                const direction = version > currentVersion ? 'up' : 'down';
-                const fileNames = getMigrationFiles(this.migrationsDir, direction);
-                if (direction === 'up') {
-                    const fileVersion = Math.min(fileNames.length, version);
-                    for (let i = currentVersion; i < fileVersion; i++) {
-                        const file = (_a = fileNames[i]) !== null && _a !== void 0 ? _a : '';
-                        yield Promise.all([
-                            tx.file(path.join(this.migrationsDir, file)).execute(),
-                            tx `INSERT INTO migrations(name, version) VALUES (${file}, ${i} + 1)`
-                        ]);
-                        opts === null || opts === void 0 ? void 0 : opts.eventHandler(`Successfully migrated: ${file}`);
-                    }
-                    if (version > fileNames.length) {
-                        opts === null || opts === void 0 ? void 0 : opts.eventHandler(`Currently at latest version: ${currentVersion}`);
-                    }
-                }
-                else {
-                    const start = fileNames.length - currentVersion;
-                    const end = start + (currentVersion - version);
-                    for (let i = start; i < end; i++) {
-                        const file = (_b = fileNames[i]) !== null && _b !== void 0 ? _b : '';
-                        yield Promise.all([
-                            tx.file(path.join(this.migrationsDir, file)).execute(),
-                            tx `DELETE FROM migrations WHERE version = ${fileNames.length - i}`
-                        ]);
-                        opts === null || opts === void 0 ? void 0 : opts.eventHandler(`Successfully migrated: ${file}`);
-                    }
-                }
-                yield this.commit(tx);
-            }
-            catch (error) {
-                yield this.rollback(tx);
-                throw error;
-            }
-            finally {
-                yield this.releaseLock(tx);
-                tx.release();
-            }
-        });
-    }
-    migrate(direction, opts) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            const tx = yield this.dbClient.reserve();
-            try {
-                yield this.acquireLock(tx);
-                yield this.begin(tx);
-                yield this.ensureMigrationTable(tx);
-                const currentVersion = yield this.getCurrentVersionWithTx(tx);
-                const fileNames = getMigrationFiles(this.migrationsDir, direction);
-                if (direction === 'up') {
-                    for (const fileName of fileNames) {
-                        const id = fileNames.indexOf(fileName);
-                        if (id >= currentVersion) {
-                            yield Promise.all([
-                                tx.file(path.join(this.migrationsDir, fileName)).execute(),
-                                tx `INSERT INTO migrations(name, version) VALUES (${fileName}, ${id} + 1)`
-                            ]);
-                            opts === null || opts === void 0 ? void 0 : opts.eventHandler(`Successfully migrated: ${fileName}`);
-                        }
-                    }
-                }
-                else {
-                    const start = fileNames.length - currentVersion;
-                    for (let i = start; i < fileNames.length; i++) {
-                        const file = (_a = fileNames[i]) !== null && _a !== void 0 ? _a : '';
-                        yield Promise.all([
-                            tx.file(path.join(this.migrationsDir, file)).execute(),
-                            tx `DELETE FROM migrations WHERE version = ${fileNames.length - i}`
-                        ]);
-                        opts === null || opts === void 0 ? void 0 : opts.eventHandler(`Successfully migrated: ${file}`);
-                    }
-                }
-                yield this.commit(tx);
-            }
-            catch (error) {
-                yield this.rollback(tx);
-                throw error;
-            }
-            finally {
-                yield this.releaseLock(tx);
-                tx.release();
-            }
-        });
-    }
-    getCurrentVersion() {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            const result = yield this
-                .dbClient `SELECT version FROM migrations ORDER BY version DESC LIMIT 1`;
-            return result.length > 0 ? (_a = result[0]) === null || _a === void 0 ? void 0 : _a['version'] : 0;
-        });
-    }
-    getCurrentVersionWithTx(tx) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            const result = yield tx `SELECT version FROM migrations ORDER BY version DESC LIMIT 1`;
-            return result.length > 0 ? (_a = result[0]) === null || _a === void 0 ? void 0 : _a['version'] : 0;
-        });
-    }
-    acquireLock(tx) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield tx `SELECT pg_advisory_lock(21421431414441411)`;
-        });
-    }
-    releaseLock(tx) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield tx `SELECT pg_advisory_unlock(21421431414441411)`;
-        });
-    }
-    begin(tx) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield tx `BEGIN`;
-        });
-    }
-    commit(tx) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield tx `COMMIT`;
-        });
-    }
-    rollback(tx) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield tx `ROLLBACK`;
-        });
-    }
-}

package/dist/esm/src/utils.d.ts

@@ -1,4 +0,0 @@
-export type Direction = 'up' | 'down';
-export declare const getMigrationFiles: (dir: string, direction: Direction) => string[];
-export declare const createFolderIfNotExists: (filePath: string) => void;
-export declare const createFile: (migrationDir: string, name: string) => string[];