@dbsp/nql 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,67 @@
+# @dbsp/nql
+
+[![npm version](https://img.shields.io/npm/v/@dbsp/nql.svg)](https://www.npmjs.com/package/@dbsp/nql)
+[![license](https://img.shields.io/npm/l/@dbsp/nql.svg)](LICENSE)
+
+NQL (Natural Query Language) — a human- and LLM-friendly pipe-based query language that compiles to `IntentAST` for `@dbsp/core`.
+
+## Installation
+
+```bash
+pnpm add @dbsp/nql
+```
+
+## Quick Start
+
+```typescript
+// doctest: skip — exec-only operation; compile from @dbsp/nql is not in doctest preamble and orm.from(intent).all() requires a real PostgreSQL connection
+import { compile } from '@dbsp/nql';
+
+// Compile an NQL query to IntentAST
+const intent = compile(
+  "users | where active = true | select name, email | order name asc | limit 20",
+  schema
+);
+
+// Pass the intent to the ORM
+const users = await orm.from(intent).all();
+```
+
+## Syntax overview
+
+```nql
+-- Basic selection with filter
+users | where status = 'active'
+
+-- Computed columns and ordering
+orders | select id, total, tax | order total desc | limit 10
+
+-- Relations (auto-resolved from schema refs)
+posts | include author | where published = true
+
+-- CTEs (WITH clause)
+with recent AS (orders | where createdAt > '2024-01-01')
+recent | select id, total
+
+-- Aggregation
+orders | group customerId | select customerId, sum(total) as revenue
+```
+
+## Key features
+
+- **Pipe syntax** — Readable left-to-right data flow (`table | filter | select | order`)
+- **SQL-style literals** — Single-quoted strings (`'value'`), not double-quoted
+- **CTE support** — `WITH name AS (subquery)` for named subqueries
+- **Schema-aware** — Validates column names and relation paths against `ModelIR` at parse time
+- **LLM-friendly** — Concise syntax designed for AI-generated queries
+- **Chevrotain-based** — Robust lexer + parser with structured error recovery
+- **Composable** — Output `IntentAST` is the same type used by the TypeScript fluent builders
+
+## Documentation
+
+- [Guides](https://oorabona.github.io/db-semantic-planner/guide/)
+- [Full-text search guide](https://oorabona.github.io/db-semantic-planner/guide/full-text-search)
+
+## License
+
+MIT