bigal 16.0.0-beta.2 → 16.0.0

package/docs/reference/configuration.md

@@ -1,5 +1,5 @@
 ---
-description: Configure connection pools (postgres-pool, pg, Neon), read replicas, multiple databases, and query observability.
+description: Configure connection pools (postgres-pool, pg, Neon), read replicas, multiple databases, and debug logging.
 ---
 
 # Configuration
@@ -18,33 +18,31 @@ const pool = new Pool({
   connectionString: 'postgres://user:pass@localhost/mydb',
 });
 
-const { Product } = initialize({ models: { Product }, pool });
+const repos = initialize({ models, pool });
 ```
 
 ### node-postgres (pg)
 
 ```ts
 import pg from 'pg';
-import { initialize } from 'bigal';
 
 const pool = new pg.Pool({
   connectionString: 'postgres://user:pass@localhost/mydb',
 });
 
-const { Product } = initialize({ models: { Product }, pool });
+const repos = initialize({ models, pool });
 ```
 
 ### Neon serverless
 
 ```ts
 import { Pool } from '@neondatabase/serverless';
-import { initialize } from 'bigal';
 
 const pool = new Pool({
   connectionString: process.env.DATABASE_URL,
 });
 
-const { Product } = initialize({ models: { Product }, pool });
+const repos = initialize({ models, pool });
 ```
 
 ## Read replicas
@@ -55,22 +53,23 @@ Separate read and write pools by passing `readonlyPool`:
 const pool = new Pool('postgres://localhost/mydb');
 const readonlyPool = new Pool('postgres://readonly-host/mydb');
 
-const { Product } = initialize({
-  models: { Product },
+const repos = initialize({
+  models,
   pool,
   readonlyPool,
 });
 ```
 
-`find()`, `findOne()`, and `count()` use `readonlyPool`. `create()`, `update()`, and `destroy()` use
-`pool`.
+`find()`, `findOne()`, and `count()` use `readonlyPool`. `create()`, `update()`, and `destroy()` use `pool`.
 
 Individual queries can override the pool:
 
 ```ts
-const product = await Product.findOne({
-  pool: writePool,
-}).where({ id: 42 });
+const product = await productRepository
+  .findOne({
+    pool: writePool,
+  })
+  .where({ id: 42 });
 ```
 
 ## Multiple databases
@@ -78,16 +77,13 @@ const product = await Product.findOne({
 Use named connections for models that live in different databases:
 
 ```ts
-const AuditLog = table(
-  'audit_logs',
-  {
-    /* columns */
-  },
-  { connection: 'audit' },
-);
+@table({ name: 'audit_logs', connection: 'audit' })
+export class AuditLog extends Entity {
+  // ...
+}
 
-const { Product, AuditLog } = initialize({
-  models: { Product, AuditLog },
+const repos = initialize({
+  models: [Product, AuditLog],
   pool: mainPool,
   connections: {
     audit: {
@@ -100,107 +96,24 @@ const { Product, AuditLog } = initialize({
 
 Models without a `connection` option use the top-level `pool`.
 
-## Models: object vs array
-
-`initialize()` accepts models as either an object or an array:
-
-### Object-style (recommended)
-
-Returns typed repositories directly via destructuring. No type assertions needed:
-
-```ts
-const { Product, Store } = initialize({
-  pool,
-  models: { Product, Store, Category, ProductCategory },
-});
-```
-
-### Array-style
+## Expose callback
 
-Returns an object with `getRepository()` and `getReadonlyRepository()` methods:
+The `expose` callback is invoked for each repository after creation:
 
 ```ts
-const bigal = initialize({
+const repos = initialize({
+  models,
   pool,
-  models: [Product, Store, Category, ProductCategory],
-});
-
-const Product = bigal.getRepository(Product);
-const ProductSummary = bigal.getReadonlyRepository(ProductSummary);
-```
-
-## Global filters
-
-Define named filters on models that are automatically applied to every `find` and `findOne` query:
-
-```ts
-const Product = table(
-  'products',
-  {
-    /* columns */
-  },
-  {
-    filters: {
-      active: { isActive: true },
-      notDeleted: () => ({ deletedAt: null }),
-    },
-  },
-);
-```
-
-Filters can be static objects or functions that return a where clause dynamically. Override per query:
-
-```ts
-// Disable all filters
-await Product.find().where({}).filters(false);
-
-// Disable a specific filter
-await Product.find().where({}).filters({ active: false });
-```
-
-## Query observability
-
-### onQuery callback
-
-Pass an `onQuery` callback to `initialize()` for structured query logging:
-
-```ts
-const { Product } = initialize({
-  pool,
-  models: { Product },
-  onQuery({ sql, params, duration, error, model, operation }) {
-    logger.debug({ sql, params, duration, model, operation });
-    if (error) {
-      logger.error({ sql, error, model });
-    }
+  expose(repository, tableMetadata) {
+    console.log(`Initialized ${tableMetadata.name}`);
   },
 });
 ```
 
-The callback receives an `OnQueryEvent` for every query:
-
-| Property    | Type                 | Description                                           |
-| ----------- | -------------------- | ----------------------------------------------------- |
-| `sql`       | `string`             | The generated SQL statement                           |
-| `params`    | `readonly unknown[]` | Query parameter values                                |
-| `duration`  | `number`             | Execution time in milliseconds                        |
-| `error`     | `Error \| undefined` | Error if the query failed                             |
-| `model`     | `string`             | Model name                                            |
-| `operation` | `string`             | One of: find, findOne, count, create, update, destroy |
+## Debugging
 
-The callback is wrapped in a try/catch internally - exceptions in `onQuery` will not crash your
-queries. When no `onQuery` is provided, there is zero overhead.
-
-**Note:** `params` may contain sensitive data (user input, passwords, etc.). Use appropriate care when
-logging.
-
-### DEBUG_BIGAL environment variable
-
-The `DEBUG_BIGAL` environment variable still works as a fallback. When set and no `onQuery` callback
-is provided, BigAl logs generated SQL to the console:
+Set the `DEBUG_BIGAL` environment variable to log generated SQL:
 
 ```sh
 DEBUG_BIGAL=true node app.js
 ```
-
-For production use, prefer the `onQuery` callback for structured, configurable logging.

package/package.json

@@ -1,15 +1,37 @@
 {
   "name": "bigal",
-  "version": "16.0.0-beta.2",
+  "version": "16.0.0",
   "description": "A type-safe PostgreSQL ORM for Node.js, written in TypeScript. Features a fluent query builder, decorator-based models, and immutable query state.",
+  "keywords": [
+    "decorator",
+    "fluent-api",
+    "node",
+    "orm",
+    "postgres",
+    "postgresql",
+    "query-builder",
+    "repository-pattern",
+    "type-safe",
+    "typescript"
+  ],
+  "homepage": "https://bigalorm.github.io/bigal/",
+  "bugs": {
+    "url": "https://github.com/bigalorm/bigal/issues"
+  },
+  "license": "MIT",
+  "author": "Jim Geurts <jim@biacreations.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bigalorm/bigal.git"
+  },
+  "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "type": "module",
+  "types": "./dist/index.d.cts",
   "exports": {
     ".": {
       "import": {
-        "types": "./dist/index.d.ts",
+        "types": "./dist/index.d.mts",
         "default": "./dist/index.mjs"
       },
       "require": {
@@ -18,84 +40,48 @@
       }
     }
   },
-  "keywords": [
-    "orm",
-    "postgres",
-    "postgresql",
-    "typescript",
-    "type-safe",
-    "query-builder",
-    "node",
-    "fluent-api",
-    "decorator",
-    "repository-pattern"
-  ],
-  "author": "Jim Geurts <jim@biacreations.com>",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/bigalorm/bigal/issues"
-  },
-  "homepage": "https://bigalorm.github.io/bigal/",
-  "engines": {
-    "node": ">=22.0.0"
+  "scripts": {
+    "build": "vp pack",
+    "check:types": "tsc --noEmit --skipLibCheck",
+    "test": "pnpm run check:types && vp test run",
+    "lint:markdown": "markdownlint '**/*.md' --ignore '**/node_modules/**' --ignore '**/dist/**' --ignore 'internal/**' --config=.github/linters/.markdown-lint.yml --fix",
+    "lint:code": "vp lint --fix",
+    "lint": "pnpm run format && run-p lint:*",
+    "format": "vp fmt",
+    "beta": "pnpm publish --tag beta",
+    "prepublishOnly": "pinst --disable",
+    "postpublish": "pinst --enable",
+    "prepare": "vp config --no-agent"
   },
   "devDependencies": {
-    "@faker-js/faker": "10.3.0",
+    "@faker-js/faker": "10.5.0",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/commit-analyzer": "13.0.1",
     "@semantic-release/git": "10.0.1",
-    "@semantic-release/github": "12.0.6",
+    "@semantic-release/github": "12.0.9",
     "@semantic-release/npm": "13.1.5",
-    "@semantic-release/release-notes-generator": "14.1.0",
+    "@semantic-release/release-notes-generator": "14.1.1",
+    "@stylistic/eslint-plugin": "5.10.0",
     "@types/node": ">=22",
-    "@typescript/native-preview": "7.0.0-dev.20260322.1",
-    "conventional-changelog-conventionalcommits": "9.3.0",
-    "eslint-plugin-vitest": "0.5.4",
-    "husky": "9.1.7",
-    "lint-staged": "16.4.0",
-    "markdownlint-cli": "0.48.0",
-    "npm-run-all2": "8.0.4",
-    "oxfmt": "0.41.0",
-    "oxlint": "1.56.0",
-    "oxlint-tsgolint": "0.17.1",
+    "conventional-changelog-conventionalcommits": "10.2.1",
+    "eslint-config-decent": "4.2.38",
+    "eslint-plugin-jsdoc": "62.9.0",
+    "eslint-plugin-security": "4.0.1",
+    "eslint-plugin-unicorn": "64.0.0",
+    "markdownlint-cli": "0.49.0",
+    "npm-run-all2": "9.0.2",
+    "oxlint-plugin-eslint": "1.73.0",
     "pinst": "3.0.0",
-    "postgres-pool": "11.0.4",
-    "semantic-release": "25.0.3",
+    "postgres-pool": "11.0.5",
+    "semantic-release": "25.0.5",
     "strict-event-emitter-types": "2.0.0",
-    "ts-morph": "27.0.2",
-    "typescript": "5.9.3",
-    "unbuild": "3.6.1",
-    "vitest": "4.1.0"
+    "typescript": "7.0.2",
+    "vite": "catalog:",
+    "vite-plus": "catalog:",
+    "vitest": "4.1.10"
   },
-  "scripts": {
-    "build": "unbuild",
-    "check:types": "tsgo --noEmit --skipLibCheck",
-    "test": "npm run check:types && vitest run",
-    "lint:markdown": "markdownlint '**/*.md' --ignore '**/node_modules/**' --ignore '**/dist/**' --ignore 'internal/**' --config=.github/linters/.markdown-lint.yml --fix",
-    "lint:code": "oxlint --fix --fix-suggestions --deny-warnings",
-    "lint": "npm run format && run-p lint:*",
-    "format": "oxfmt --write .",
-    "lint-staged": "lint-staged",
-    "beta": "npm publish --tag beta",
-    "prepublishOnly": "pinst --disable",
-    "postpublish": "pinst --enable",
-    "prepare": "husky"
-  },
-  "lint-staged": {
-    "*.md": [
-      "oxfmt --write",
-      "markdownlint --config=.github/linters/.markdown-lint.yml --fix"
-    ],
-    "*.{js,cjs,mjs,ts}": [
-      "oxfmt --write",
-      "oxlint --fix --fix-suggestions --deny-warnings"
-    ],
-    "*.{json5,yml}": [
-      "oxfmt --write"
-    ]
+  "engines": {
+    "node": ">=22.11.0"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/bigalorm/bigal.git"
-  }
+  "packageManager": "pnpm@11.11.0+sha512.4463f65fd80ed80d69bc1d4bf163ee94f605c7380fc318bb5b2ebe15f8cd12d49c51a4d59e951b401e764d3b6ca751cbf51bc50ed7001a6bcb4935e684c34882"
 }

package/pnpm-workspace.yaml

@@ -0,0 +1,14 @@
+allowBuilds:
+  esbuild: true
+  unrs-resolver: true
+savePrefix: ''
+catalog:
+  vite: npm:@voidzero-dev/vite-plus-core@0.2.4
+  vite-plus: 0.2.4
+overrides:
+  vite: 'catalog:'
+peerDependencyRules:
+  allowAny:
+    - vite
+  allowedVersions:
+    vite: '*'

package/release.config.mjs

@@ -46,7 +46,7 @@ export default {
     [
       '@semantic-release/git',
       {
-        assets: ['CHANGELOG.md', 'package.json', 'package-lock.json'],
+        assets: ['CHANGELOG.md', 'package.json'],
         message: `chore: release \${nextRelease.version} [skip ci]\n\n\${nextRelease.notes}`,
       },
     ],