@ku6epxboctuk/sqlite-up 0.0.0-stage → 0.6.1

package/dist/providers/index.d.ts

@@ -0,0 +1,12 @@
+import type { MigratorDatabase } from '../types.js';
+import type { SqliteProvider } from './types.js';
+/**
+ * Creates the best provider adapter for a supported SQLite database client.
+ */
+export declare function createSqliteProvider(db: MigratorDatabase): SqliteProvider;
+export { createBetterSqlite3Provider, isBetterSqlite3Database } from './better-sqlite3.js';
+export { createBunSqlProvider, isBunSqlDatabase } from './bun-sql.js';
+export { createBunSqliteProvider, isBunSqliteDatabase } from './bun-sqlite.js';
+export { createNodeSqliteProvider, isNodeSqliteDatabase } from './node-sqlite.js';
+export type { SqliteProvider } from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/providers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/providers/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAkB,MAAM,aAAa,CAAC;AAMpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAUjD;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,EAAE,EAAE,gBAAgB,GAAG,cAAc,CA0BzE;AAED,OAAO,EAAE,2BAA2B,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC/E,OAAO,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAClF,YAAY,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC"}

package/dist/providers/manual-transaction.d.ts

@@ -0,0 +1,7 @@
+import type { SqliteDatabase } from '../types.js';
+import type { SqliteProvider } from './types.js';
+/**
+ * Creates a provider that wraps migration work in explicit SQL transactions.
+ */
+export declare function createManualTransactionProvider(db: SqliteDatabase): SqliteProvider;
+//# sourceMappingURL=manual-transaction.d.ts.map

package/dist/providers/manual-transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manual-transaction.d.ts","sourceRoot":"","sources":["../../src/providers/manual-transaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAgB,cAAc,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD;;GAEG;AACH,wBAAgB,+BAA+B,CAAC,EAAE,EAAE,cAAc,GAAG,cAAc,CAsBlF"}

package/dist/providers/node-sqlite.d.ts

@@ -0,0 +1,17 @@
+import type { SqliteDatabase } from '../types.js';
+import type { SqliteProvider } from './types.js';
+/**
+ * Structural database shape used to identify Node's node:sqlite DatabaseSync.
+ */
+export type NodeSqliteDatabase = SqliteDatabase & {
+    isOpen?: boolean;
+};
+/**
+ * Checks whether a value looks like a node:sqlite database instance.
+ */
+export declare function isNodeSqliteDatabase(db: unknown): db is NodeSqliteDatabase;
+/**
+ * Creates a sqlite-up provider for node:sqlite database instances.
+ */
+export declare function createNodeSqliteProvider(db: NodeSqliteDatabase): SqliteProvider;
+//# sourceMappingURL=node-sqlite.d.ts.map

package/dist/providers/node-sqlite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node-sqlite.d.ts","sourceRoot":"","sources":["../../src/providers/node-sqlite.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG;IAChD,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,EAAE,EAAE,OAAO,GAAG,EAAE,IAAI,kBAAkB,CAO1E;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,EAAE,EAAE,kBAAkB,GAAG,cAAc,CAE/E"}

package/dist/providers/types.d.ts

@@ -0,0 +1,15 @@
+import type { MaybePromise, SqliteDatabase } from '../types.js';
+/**
+ * Adapter that normalizes driver-specific SQLite behavior for the migrator.
+ */
+export interface SqliteProvider {
+    /**
+     * Database facade used by migration code.
+     */
+    db: SqliteDatabase;
+    /**
+     * Runs migration bookkeeping and user migration code atomically.
+     */
+    transaction(fn: () => MaybePromise<void>): Promise<void>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/providers/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/providers/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,cAAc,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,YAAY,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1D"}

package/dist/types.d.ts

@@ -0,0 +1,201 @@
+/**
+ * A value or a promise for that value.
+ */
+export type MaybePromise<T> = T | Promise<T>;
+/**
+ * Optional context argument tuple. Context is omitted by default and required
+ * when a migrator or migration is typed with a context value.
+ */
+export type ContextArg<T> = [T] extends [undefined] ? [] : [ctx: T];
+/**
+ * Result returned by SQLite statement execution.
+ */
+export interface SqliteRunResult {
+    /**
+     * Number of rows changed by the statement, when reported by the driver.
+     */
+    changes?: number | bigint;
+    /**
+     * Last inserted row identifier, when reported by the driver.
+     */
+    lastInsertRowid?: number | bigint;
+}
+/**
+ * Minimal prepared statement surface used by sqlite-up.
+ * Compatible with Node's `node:sqlite`, Bun's `bun:sqlite`, Bun SQL, and
+ * similar SQLite clients.
+ */
+export interface SqliteStatement {
+    /**
+     * Runs the prepared statement and returns all result rows.
+     */
+    all(...params: unknown[]): MaybePromise<unknown[]>;
+    /**
+     * Runs the prepared statement and returns the first result row.
+     */
+    get(...params: unknown[]): MaybePromise<unknown>;
+    /**
+     * Runs the prepared statement for side effects and returns the driver result.
+     */
+    run(...params: unknown[]): MaybePromise<SqliteRunResult | unknown>;
+}
+/**
+ * Transaction function returned by SQLite drivers that provide native
+ * async-compatible transaction wrappers.
+ */
+export interface SqliteTransaction<Args extends unknown[] = unknown[], Result = unknown> {
+    (...args: Args): MaybePromise<Result>;
+    /**
+     * Runs the transaction with deferred locking semantics when supported.
+     */
+    deferred?: (...args: Args) => MaybePromise<Result>;
+    /**
+     * Runs the transaction with immediate locking semantics when supported.
+     */
+    immediate?: (...args: Args) => MaybePromise<Result>;
+    /**
+     * Runs the transaction with exclusive locking semantics when supported.
+     */
+    exclusive?: (...args: Args) => MaybePromise<Result>;
+}
+/**
+ * Minimal SQLite database surface passed to migration files.
+ * Node 24+ `DatabaseSync`, Bun `Database`, better-sqlite3 `Database`,
+ * and Bun SQL adapters are structurally compatible with this interface.
+ */
+export interface SqliteDatabase {
+    /**
+     * Executes one or more SQL statements without returning result rows.
+     */
+    exec(sql: string): MaybePromise<unknown>;
+    /**
+     * Prepares a SQL statement for repeated execution.
+     */
+    prepare(sql: string): SqliteStatement;
+}
+/**
+ * Structural subset of Bun's Promise-based SQL client when configured for SQLite.
+ * sqlite-up wraps this into the `SqliteDatabase` migration surface.
+ */
+export interface BunSqliteDatabase {
+    /**
+     * Executes raw SQL through Bun SQL and returns all result rows.
+     */
+    unsafe(sql: string, params?: unknown[]): PromiseLike<unknown[]> | unknown[];
+    /**
+     * Runs a callback inside a Bun SQL transaction when supported.
+     */
+    begin?<Result>(fn: (tx: BunSqliteDatabase) => MaybePromise<Result>): MaybePromise<Result>;
+}
+/**
+ * Database instances accepted by `Migrator`.
+ */
+export type MigratorDatabase = SqliteDatabase | BunSqliteDatabase;
+/**
+ * Options for initializing the Migrator.
+ */
+export interface MigratorOptions {
+    /**
+     * SQLite database instance
+     */
+    db: MigratorDatabase;
+    /**
+     * Directory containing migration files
+     */
+    migrationsDir: string;
+    /**
+     * Name of the migrations table (default: schema_migrations)
+     */
+    migrationsTable?: string;
+    /**
+     * Name of the migrations lock table (default: schema_migrations_lock)
+     */
+    migrationsLockTable?: string;
+    /**
+     * File extensions to look for when loading migrations (default: ['ts', 'js'])
+     * Note: .d.ts files are always ignored
+     */
+    fileExtensions?: string[];
+}
+/**
+ * Represents a single migration file/module.
+ */
+export interface Migration<T = undefined> {
+    /**
+     * Name of the migration (derived from filename)
+     */
+    name: string;
+    /**
+     * Function to apply the migration
+     */
+    up: (db: SqliteDatabase, ...args: ContextArg<T>) => MaybePromise<void>;
+    /**
+     * Function to revert the migration
+     */
+    down: (db: SqliteDatabase, ...args: ContextArg<T>) => MaybePromise<void>;
+}
+/**
+ * A record of applied migrations as stored in the database.
+ */
+export interface MigrationRecord {
+    /**
+     * Name of the migration
+     */
+    name: string;
+    /**
+     * ISO timestamp when the migration was executed
+     */
+    executed_at: string;
+    /**
+     * Batch number for the migration
+     */
+    batch: number;
+}
+/**
+ * Result type returned by migration actions.
+ */
+export interface MigrationResult {
+    /**
+     * Whether the migration operation was successful
+     */
+    success: boolean;
+    /**
+     * Error if the operation failed
+     */
+    error?: Error;
+    /**
+     * List of migrations that were applied/rolled back
+     */
+    appliedMigrations: string[];
+}
+/**
+ * Represents the plan for pending migrations.
+ */
+export interface MigrationPlan {
+    /**
+     * The next batch number that will be used
+     */
+    nextBatch: number;
+    /**
+     * List of migrations that will be applied
+     */
+    pendingMigrations: string[];
+}
+/**
+ * Represents the status of migrations.
+ */
+export interface MigrationStatus {
+    /**
+     * Current highest batch number
+     */
+    currentBatch: number;
+    /**
+     * Number of pending migrations
+     */
+    pending: number;
+    /**
+     * List of applied migrations
+     */
+    applied: MigrationRecord[];
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAE1B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,GAAG,CAAC,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;IAEnD;;OAEG;IACH,GAAG,CAAC,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAEjD;;OAEG;IACH,GAAG,CAAC,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC,eAAe,GAAG,OAAO,CAAC,CAAC;CACpE;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB,CAAC,IAAI,SAAS,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,MAAM,GAAG,OAAO;IACrF,CAAC,GAAG,IAAI,EAAE,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;IAEnD;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;IAEpD;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;CACrD;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC,OAAO,EAAE,CAAC,GAAG,OAAO,EAAE,CAAC;IAE5E;;OAEG;IACH,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,iBAAiB,KAAK,YAAY,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;CAC3F;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,cAAc,GAAG,iBAAiB,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,gBAAgB,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC,GAAG,SAAS;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,EAAE,EAAE,CAAC,EAAE,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;IAEvE;;OAEG;IACH,IAAI,EAAE,CAAC,EAAE,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;CAC1E;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IAEd;;OAEG;IACH,iBAAiB,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,iBAAiB,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,eAAe,EAAE,CAAC;CAC5B"}

package/package.json

@@ -1,6 +1,81 @@
 {
   "name": "@ku6epxboctuk/sqlite-up",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "author": "Sandrino Di Mattia",
+  "contributors": [
+    "Ku6epXBOCTuK (https://github.com/Ku6epXBOCTuK)"
+  ],
+  "version": "0.6.1",
+  "description": "A lightweight SQLite migration system for Node.js and Bun (fork with Windows ESM path fix)",
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Ku6epXBOCTuK/sqlite-up.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Ku6epXBOCTuK/sqlite-up/issues"
+  },
+  "homepage": "https://github.com/Ku6epXBOCTuK/sqlite-up#readme",
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "packageManager": "pnpm@10.30.3",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --sourcemap && tsc -p tsconfig.build.json",
+    "check": "biome check .",
+    "check:fix": "biome check --write --unsafe .",
+    "format": "biome format --write .",
+    "lint": "biome lint . && jsdoc-lint src",
+    "typecheck": "pnpm typecheck:src && pnpm typecheck:test",
+    "typecheck:src": "tsc --noEmit",
+    "typecheck:test": "tsc --noEmit -p tsconfig.test.json",
+    "test": "vitest run",
+    "test:bun": "bun test ./src/*.bun.test.ts ./src/providers/*.bun.test.ts",
+    "test:coverage": "vitest run --coverage",
+    "test:node": "vitest run",
+    "test:watch": "vitest",
+    "prepare": "husky install",
+    "release": "node scripts/release.mjs",
+    "prepublishOnly": "pnpm run build"
+  },
+  "keywords": [
+    "bun",
+    "database",
+    "migrations",
+    "node",
+    "sqlite",
+    "typescript"
+  ],
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.13",
+    "@types/better-sqlite3": "^7.6.13",
+    "@types/bun": "^1.3.13",
+    "@types/node": "^25.6.0",
+    "@vitest/coverage-v8": "^4.1.5",
+    "better-sqlite3": "^12.9.0",
+    "husky": "^9.1.7",
+    "jsdoc-lint": "0.4.0",
+    "lint-staged": "^16.4.0",
+    "tsup": "^8.5.1",
+    "tsx": "^4.21.0",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.5"
+  }
+}