@dbsp/core 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Olivier Orabona
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,69 @@
+# @dbsp/core
+
+[![npm version](https://img.shields.io/npm/v/@dbsp/core.svg)](https://www.npmjs.com/package/@dbsp/core)
+[![license](https://img.shields.io/npm/l/@dbsp/core.svg)](LICENSE)
+
+Intent-first semantic query planner for databases. Declare what you want, let the planner decide how — with full type safety and observability.
+
+## Installation
+
+```bash
+pnpm add @dbsp/core @dbsp/adapter-pgsql
+```
+
+## Quick Start
+
+```typescript
+import { schema, ref, createOrm, eq } from '@dbsp/core';
+import { createPgsqlAdapter } from '@dbsp/adapter-pgsql';
+import { Pool } from 'pg';
+
+// 1. Define schema
+const db = schema({
+  users: { id: 'uuid', name: 'string', email: 'string', active: 'boolean' },
+  posts: { id: 'uuid', title: 'string', authorId: ref('users') },
+});
+
+// 2. Create ORM
+const orm = createOrm({
+  schema: db,
+  adapter: createPgsqlAdapter(new Pool({ connectionString: process.env.DATABASE_URL })),
+});
+
+// 3. Query
+const users = await orm.select('users').where(eq('active', true)).all();
+
+// 4. Inspect the plan
+const dump = await orm.select('users').where(eq('active', true)).dump();
+console.log(dump.sql);     // SELECT "id", "name", "email", "active" FROM "users" WHERE "active" = $1
+console.log(dump.params);  // [true]
+console.log(dump.plan);    // PlanReport with decisions + reasoning
+```
+
+## Key features
+
+- **Intent-first** — Declare what to fetch; the planner decides JOIN vs EXISTS, aliasing, CTE extraction
+- **Type-safe** — Full TypeScript inference from schema definition to query result types
+- **Observable** — Every query exposes `dump()` returning plan decisions, SQL, and bound parameters
+- **Deterministic** — Same inputs always produce the same SQL and plan (stable aliasing)
+- **Multi-tenant** — `orm.withSchema('tenant_123')` for schema-per-tenant isolation
+- **Expression primitives** — `op()`, `fn()`, `ref()`, `cast()`, `caseWhen()`, vector distances, ParadeDB full-text
+- **Set operations** — `union()`, `unionAll()`, `intersect()`, `except()`
+- **Subqueries** — Scalar subqueries, `inSubquery()`, correlated EXISTS
+- **Joins** — Relation-based includes, manual `join()` with custom `ON` clauses
+- **Mutations** — Insert, update, upsert, delete with type-safe builders
+
+## Adapter interface
+
+`@dbsp/core` defines the `Adapter` port; concrete implementations live in separate packages (e.g. `@dbsp/adapter-pgsql`). The core is fully database-agnostic.
+
+## Documentation
+
+- [Guides](https://oorabona.github.io/db-semantic-planner/guide/)
+- [Expression primitives guide](https://oorabona.github.io/db-semantic-planner/guide/expression-primitives)
+- [Joins guide](https://oorabona.github.io/db-semantic-planner/guide/joins)
+- [DDL helpers guide](https://oorabona.github.io/db-semantic-planner/guide/ddl-helpers)
+
+## License
+
+MIT