bigal 14.1.26 → 15.0.1

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+## [15.0.1](https://github.com/bigalorm/bigal/compare/v15.0.0...v15.0.1) (2026-01-07)
+
+# [15.0.0](https://github.com/bigalorm/bigal/compare/v14.1.26...v15.0.0) (2025-12-28)
+
+- feat!: support pluggable PostgreSQL drivers ([7638343](https://github.com/bigalorm/bigal/commit/76383432acc8ee1bdf48a8c60a8e5fa10176bd69))
+
+### BREAKING CHANGES
+
+- pg and postgres-pool are no longer bundled dependencies.
+  Users must now install their preferred PostgreSQL driver separately.
+
+* Add PoolLike interface for driver-agnostic pool support
+* Support pg, postgres-pool, @neondatabase/serverless, or any compatible driver
+* Remove pg and @types/pg from dependencies
+* Move postgres-pool to devDependencies
+* Update README with driver installation options
+
 ## [14.1.26](https://github.com/bigalorm/bigal/compare/v14.1.25...v14.1.26) (2025-12-25)
 
 ## [14.1.25](https://github.com/bigalorm/bigal/compare/v14.1.24...v14.1.25) (2025-12-25)

package/README.md

@@ -19,9 +19,79 @@ This ORM does not:
 ## Install
 
 ```sh
-npm install pg postgres-pool bigal
+npm install bigal
 ```
 
+You'll also need a PostgreSQL driver. Choose one of the following:
+
+```sh
+# Option 1: postgres-pool (recommended)
+npm install postgres-pool
+
+# Option 2: node-postgres
+npm install pg
+
+# Option 3: Neon serverless
+npm install @neondatabase/serverless
+```
+
+## Using Alternative PostgreSQL Drivers
+
+BigAl is compatible with any PostgreSQL driver that implements the standard `pool.query()` method, including:
+
+- [postgres-pool](https://www.npmjs.com/package/postgres-pool) (default)
+- [pg](https://www.npmjs.com/package/pg) (node-postgres)
+- [@neondatabase/serverless](https://www.npmjs.com/package/@neondatabase/serverless)
+
+### Using with Neon Serverless
+
+```ts
+import { Pool } from '@neondatabase/serverless';
+import { initialize, Repository } from 'bigal';
+import { Product, Store } from './models';
+
+const pool = new Pool({ connectionString: process.env.DATABASE_URL });
+
+const repositoriesByName = initialize({
+  models: [Product, Store],
+  pool,
+});
+```
+
+### Using with node-postgres (pg)
+
+```ts
+import { Pool } from 'pg';
+import { initialize, Repository } from 'bigal';
+import { Product, Store } from './models';
+
+const pool = new Pool({ connectionString: process.env.DATABASE_URL });
+
+const repositoriesByName = initialize({
+  models: [Product, Store],
+  pool,
+});
+```
+
+### Type Requirements
+
+Any pool implementation must satisfy the `PoolLike` interface:
+
+```ts
+import type { PoolLike, PoolQueryResult } from 'bigal';
+
+interface PoolQueryResult<TRow extends Record<string, unknown>> {
+  rows: TRow[];
+  rowCount: number | null;
+}
+
+interface PoolLike {
+  query<TRow extends Record<string, unknown> = Record<string, unknown>>(text: string, values?: readonly unknown[]): Promise<PoolQueryResult<TRow>>;
+}
+```
+
+All standard PostgreSQL drivers (pg, postgres-pool, @neondatabase/serverless) satisfy this interface.
+
 ## Configuring
 
 ### Defining database models