bigal 15.11.4 → 16.0.0-beta.1

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [16.0.0-beta.1](https://github.com/bigalorm/bigal/compare/v15.11.4...v16.0.0-beta.1) (2026-03-23)
+
+### ⚠ BREAKING CHANGES
+
+- Function-based schema API
+
+### Features
+
+- Function-based schema API ([5b67b83](https://github.com/bigalorm/bigal/commit/5b67b83c29cfe7b53b725415c0eeff175445ffac))
+
 ## [15.11.4](https://github.com/bigalorm/bigal/compare/v15.11.3...v15.11.4) (2026-03-12)
 
 ## [15.11.3](https://github.com/bigalorm/bigal/compare/v15.11.2...v15.11.3) (2026-03-12)

package/README.md

@@ -4,9 +4,10 @@
 [![node version](https://img.shields.io/node/v/bigal.svg?style=flat)](https://nodejs.org)
 [![Known Vulnerabilities](https://snyk.io/test/npm/bigal/badge.svg)](https://snyk.io/test/npm/bigal)
 
-A PostgreSQL-optimized, type-safe TypeScript ORM for Node.js. BigAl uses a fluent builder pattern for queries,
-decorator-based models, and immutable query state. Built exclusively for Postgres — queries are tuned for
-Postgres performance with native support for JSONB, DISTINCT ON, subquery joins, and ON CONFLICT upserts.
+A PostgreSQL-optimized, type-safe TypeScript ORM for Node.js. BigAl uses a fluent builder
+pattern for queries, function-based schema definitions with PostgreSQL-native column builders,
+and immutable query state. Built exclusively for Postgres with native support for JSONB,
+DISTINCT ON, subquery joins, ON CONFLICT upserts, and pgvector.
 
 ## Install
 
@@ -27,49 +28,62 @@ npm install pg
 npm install @neondatabase/serverless
 ```
 
+Requires Node.js >= 22.
+
 ## Quick Start
 
 ```ts
-import { column, primaryColumn, table, Entity, initialize, Repository } from 'bigal';
+import { initialize, defineTable as table, serial, text, integer, belongsTo, hasMany, createdAt, updatedAt } from 'bigal';
+import type { Repository } from 'bigal';
 import { Pool } from 'postgres-pool';
 
-@table({ name: 'products' })
-class Product extends Entity {
-  @primaryColumn({ type: 'integer' })
-  public id!: number;
-
-  @column({ type: 'string', required: true })
-  public name!: string;
-
-  @column({ type: 'integer', required: true, name: 'price_cents' })
-  public priceCents!: number;
-}
-
+// Define models with PostgreSQL-native column builders
+// Column names auto-derive from property keys (priceCents -> price_cents)
+const Product = table('products', {
+  id: serial().primaryKey(),
+  name: text().notNull(),
+  priceCents: integer().notNull(),
+  store: belongsTo('Store'),
+  createdAt: createdAt(),
+  updatedAt: updatedAt(),
+});
+
+const Store = table('stores', {
+  id: serial().primaryKey(),
+  name: text(),
+  products: hasMany('Product').via('store'),
+});
+
+// Initialize with typed destructuring -- no type assertions needed
 const pool = new Pool('postgres://localhost/mydb');
-const repos = initialize({ models: [Product], pool });
-const productRepository = repos.Product as Repository<Product>;
+const { Product, Store } = initialize({
+  pool,
+  models: { Product, Store },
+});
 
-// Fluent queries — just await the chain
-const products = await productRepository
-  .find()
+// Fluent queries -- just await the chain
+const products = await Product.find()
   .where({ priceCents: { '>=': 1000 }, name: { contains: 'widget' } })
   .sort('name asc')
   .limit(10);
 
 // Upserts with ON CONFLICT
-await productRepository.create({ name: 'Widget', sku: 'WDG-001', priceCents: 999 }, { onConflict: { action: 'merge', targets: ['sku'], merge: ['priceCents'] } });
+await Product.create({ name: 'Widget', priceCents: 999, store: 1 }, { onConflict: { action: 'merge', targets: ['name'], merge: ['priceCents'] } });
+
+// Inspect generated SQL without executing
+const { sql, params } = Product.find().where({ name: 'Widget' }).toSQL();
 ```
 
 ## Documentation
 
 Full documentation is available at **[bigalorm.github.io/bigal](https://bigalorm.github.io/bigal/)**.
 
-- [Getting Started](https://bigalorm.github.io/bigal/getting-started) — install, first model, first query
-- [Models](https://bigalorm.github.io/bigal/guide/models) — decorators, column options, relationships
-- [Querying](https://bigalorm.github.io/bigal/guide/querying) — operators, pagination, JSONB, DISTINCT ON
-- [CRUD Operations](https://bigalorm.github.io/bigal/guide/crud-operations) — create, update, destroy, upserts
-- [Subqueries & Joins](https://bigalorm.github.io/bigal/guide/subqueries-and-joins) — subquery builder, aggregates
-- [API Reference](https://bigalorm.github.io/bigal/reference/api) — all exports and method signatures
+- [Getting Started](https://bigalorm.github.io/bigal/getting-started) -- install, first model, first query
+- [Models](https://bigalorm.github.io/bigal/guide/models) -- table definitions, column types, relationships
+- [Querying](https://bigalorm.github.io/bigal/guide/querying) -- operators, pagination, JSONB, DISTINCT ON
+- [CRUD Operations](https://bigalorm.github.io/bigal/guide/crud-operations) -- create, update, destroy, upserts
+- [Subqueries & Joins](https://bigalorm.github.io/bigal/guide/subqueries-and-joins) -- subquery builder, aggregates
+- [API Reference](https://bigalorm.github.io/bigal/reference/api) -- all exports and method signatures
 
 ## Machine-Readable Documentation
 
@@ -91,7 +105,7 @@ npx skills add bigalorm/bigal
 ## Compatibility
 
 - [PostgreSQL](http://www.postgresql.org/) 14 or above
-- Node.js 20.11.0 or above
+- Node.js 22 or above
 
 ## License