@relq/orm 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Yuniq Solutions
+
+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,236 @@
+<p align="center">
+  <!-- <img src="https://relq.dev/logo.svg" alt="Relq" width="280" /> -->
+  <h1 align="center">Relq ORM</h1>
+</p>
+
+<p align="center">
+  <b>The runtime engine for Relq.</b><br/>
+  Query, mutate, and transact with end-to-end type inference across PostgreSQL, SQLite, and MySQL.
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@relq/orm"><img src="https://img.shields.io/npm/v/@relq/orm.svg" alt="npm version" /></a>
+  <a href="https://www.npmjs.com/package/@relq/orm"><img src="https://img.shields.io/npm/dm/@relq/orm.svg" alt="npm downloads" /></a>
+  <a href="https://github.com/yuniqsolutions/relq/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/@relq/orm.svg" alt="license" /></a>
+</p>
+
+<p align="center">
+  <a href="https://relq.dev/docs">Documentation</a> &bull;
+  <a href="https://relq.dev/docs/getting-started">Getting Started</a> &bull;
+  <a href="https://github.com/yuniqsolutions/relq">GitHub</a>
+</p>
+
+---
+
+## Install
+
+```bash
+npm install @relq/orm
+# Schema definition & CLI (dev dependency)
+npm install -D @relq/kit
+```
+
+## Quick Start
+
+```typescript
+import { Relq } from '@relq/orm'
+import { schema } from './db/schema'
+
+const db = new Relq(schema, 'postgres', {
+  host: 'localhost',
+  database: 'myapp',
+  user: 'postgres',
+  password: 'password',
+})
+
+await db.initialize()
+```
+
+## Queries
+
+Every query is fully typed. Column names, return types, and conditions are all inferred from your schema.
+
+### Select
+
+```typescript
+// All columns
+const users = await db.table.users.select().all()
+
+// Specific columns — return type narrows automatically
+const names = await db.table.users
+  .select('id', 'name', 'email')
+  .where(q => q.equal('status', 'active'))
+  .orderBy('createdAt', 'DESC')
+  .limit(10)
+  .all()
+
+// Single row
+const user = await db.table.users
+  .select()
+  .where(q => q.equal('id', userId))
+  .get()
+```
+
+### Insert
+
+```typescript
+// Single row
+await db.table.users
+  .insert({ name: 'Alice', email: 'alice@example.com' })
+  .returning('*')
+  .run()
+
+// Bulk insert with upsert
+await db.table.users
+  .insert(batchOfUsers)
+  .onConflict('email')
+  .doUpdate({ name: 'excluded.name', updatedAt: PG.now() })
+  .run()
+```
+
+### Update
+
+```typescript
+await db.table.users
+  .update({ status: 'inactive', updatedAt: PG.now() })
+  .where(q => q.equal('id', userId))
+  .returning('id', 'status')
+  .run()
+```
+
+### Delete
+
+```typescript
+await db.table.users
+  .delete()
+  .where(q => q.equal('id', userId))
+  .returning('*')
+  .run()
+```
+
+### Count
+
+```typescript
+const total = await db.table.users.count().get()
+
+const grouped = await db.table.users
+  .count()
+  .group('active', q => q.equal('status', 'active'))
+  .group('inactive', q => q.equal('status', 'inactive'))
+  .get()
+// { active: 142, inactive: 37 }
+```
+
+## Joins
+
+Type-safe joins with automatic foreign key detection.
+
+```typescript
+const orders = await db.table.orders
+  .select('id', 'total')
+  .join('users')
+  .select('name', 'email')
+  .where(q => q.gte('total', 100))
+  .all()
+// Array<{ id, total, users: { name, email } }>
+```
+
+## Computed Columns & Aggregates
+
+```typescript
+const report = await db.table.users
+  .select('id', 'name')
+  .include((a, t) => ({
+    orderCount: a.count(t.orders.id),
+    totalSpent: a.sum(t.orders.amount),
+  }))
+  .all()
+// Array<{ id, name, orderCount: number, totalSpent: number }>
+```
+
+## Transactions
+
+```typescript
+const result = await db.transaction(async tx => {
+  const user = await tx.table.users
+    .insert({ name: 'Bob', email: 'bob@example.com' })
+    .returning('*')
+    .run()
+
+  await tx.table.logs
+    .insert({ userId: user.id, action: 'signup' })
+    .run()
+
+  return user
+})
+```
+
+## Pagination
+
+```typescript
+const page = await db.table.posts
+  .select()
+  .orderBy('createdAt', 'DESC')
+  .pagination({ page: 2, perPage: 20 })
+
+// page.data — the rows
+// page.pagination.total — total count
+// page.pagination.totalPages
+// page.pagination.hasNext / hasPrev
+```
+
+## Cursor Iteration
+
+Process large datasets without loading everything into memory.
+
+```typescript
+await db.table.events
+  .select()
+  .where(q => q.gte('createdAt', startDate))
+  .each(async (event, index) => {
+    await processEvent(event)
+  })
+```
+
+## Pub/Sub
+
+Real-time notifications over PostgreSQL `LISTEN/NOTIFY`.
+
+```typescript
+await db.subscribe<{ userId: string }>('user_events', payload => {
+  console.log('New event for', payload.userId)
+})
+```
+
+## Raw SQL
+
+Escape hatch when you need it.
+
+```typescript
+const results = await db.raw('SELECT * FROM users WHERE id = $1', userId)
+```
+
+## Supported Dialects
+
+| Dialect | Status |
+|---------|--------|
+| PostgreSQL | Stable |
+| Nile (multi-tenant) | Stable |
+| CockroachDB | Stable |
+| AWS Aurora DSQL | Stable |
+| SQLite | Coming soon |
+| Turso (libSQL) | Coming soon |
+| MySQL | Coming soon |
+| PlanetScale | Coming soon |
+
+## Ecosystem
+
+| Package | Purpose |
+|---------|---------|
+| **@relq/orm** | Runtime — queries, mutations, transactions |
+| **@relq/kit** | Tooling — schema definition, CLI, migrations |
+| **@relq/zod** | Validation — Zod schema generation *(coming soon)* |
+
+## License
+
+[MIT](https://github.com/yuniqsolutions/relq/blob/main/LICENSE)

package/dist/cjs/__test-types.cjs

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const relq_client_1 = require("./core/relq-client.cjs");
+const schema = {};
+const pg1 = new relq_client_1.Relq(schema, 'postgres');
+const nile1 = new relq_client_1.Relq(schema, 'nile');
+const crdb1 = new relq_client_1.Relq(schema, 'cockroachdb');
+const dsql1 = new relq_client_1.Relq(schema, 'awsdsql');
+const pg2 = new relq_client_1.Relq(schema, 'postgres', { host: 'localhost' });
+const nile2 = new relq_client_1.Relq(schema, 'nile', { host: 'db.thenile.dev' });
+const pg3 = new relq_client_1.RelqPostgres(schema);
+const nile3 = new relq_client_1.RelqNile(schema);
+pg1.subscribe;
+nile1.subscribe;
+nile1.setTenant;
+pg1.setTenant;
+console.log('All type checks passed!');