@aouda/client 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Aouda
+
+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,151 @@
+# @aouda/client
+
+Official TypeScript/JavaScript client library for [Aouda](https://github.com/aouda/aouda).
+
+**Quickstart — start a Aouda server first:**
+
+```bash
+# CLI
+aouda dev --db myapp
+
+# or Docker
+docker run -p 5000:5000 aouda/server
+
+# or Docker Compose (server + Studio at http://localhost:3000)
+docker compose up
+```
+
+See [Getting Started](https://github.com/aouda/aouda/blob/main/docs/dev/Getting-Started.md) for full setup options.
+
+## Installation
+
+```bash
+npm install @aouda/client
+```
+
+## Quick Start
+
+```typescript
+import { createAoudaClient } from '@aouda/client';
+
+// Create client
+const client = createAoudaClient({
+  serverUrl: 'http://localhost:5000',
+});
+
+// Query data
+const orders = await client.table('orders')
+  .where('status', '=', 'active')
+  .where('total', '>', 100)
+  .orderBy('createdAt', 'desc')
+  .limit(50)
+  .execute();
+
+// List tables
+const tables = await client.tables.list();
+
+// Get table schema
+const schema = await client.tables.schema('orders');
+```
+
+## Typed client
+
+Pass a schema type as the generic parameter to get table and column name autocomplete and inferred result row types:
+
+```typescript
+import { createAoudaClient } from '@aouda/client';
+import type { SchemaLike } from '@aouda/client';
+
+interface Order { id: number; status: string; }
+interface Schema extends SchemaLike { tables: { orders: Order }; }
+
+const client = createAoudaClient<Schema>({ serverUrl: 'http://localhost:5000' });
+
+const query = client.table('orders');   // TableQuery<Order>
+const result = await query.execute();   // QueryResult<Order> — result.rows is Order[]
+```
+
+Without a type argument, `createAoudaClient(options)` behaves as before: `table(name)` accepts any string and rows are `Record<string, unknown>`.
+
+## Type Generation
+
+Generate TypeScript types from your Aouda schema (B.8 CLI):
+
+```bash
+npx @aouda/client generate --server http://localhost:5000 --output ./types/
+```
+
+The generated file (e.g. `schema.ts`) exports a `Schema` interface, a `TableName` union, and one interface per table. That shape is compatible with the typed client: use it as the generic for `createAoudaClient<Schema>(options)`.
+
+```typescript
+import { createAoudaClient } from '@aouda/client';
+import type { Schema } from './types/schema';
+
+const client = createAoudaClient<Schema>({
+  serverUrl: 'http://localhost:5000',
+});
+
+const orders = await client.table('orders')
+  .where('customerId', '=', 123)
+  .execute();  // result.rows is Order[]
+```
+
+## API Reference
+
+### Client Creation
+
+```typescript
+interface AoudaClientOptions {
+  serverUrl: string;
+  timeout?: number;        // Request timeout in ms (default: 30000)
+  retryPolicy?: RetryPolicy;
+}
+
+const client = createAoudaClient(options);
+```
+
+### Query Builder
+
+```typescript
+client.table('tableName')
+  .where('column', 'op', value)   // Filter (eq, ne, gt, gte, lt, lte)
+  .orderBy('column', 'asc')       // Sort
+  .limit(100)                     // Limit rows
+  .offset(0)                      // Skip rows
+  .select('col1', 'col2')         // Select columns
+  .execute();                     // Execute query
+```
+
+### Table Operations
+
+```typescript
+client.tables.list();              // Get all tables
+client.tables.get('name');         // Get table metadata
+client.tables.schema('name');      // Get detailed schema
+```
+
+### Mutations
+
+```typescript
+client.table('orders').insert({ ... });
+client.table('orders').insertMany([...]);
+client.table('orders').where(...).update({ ... });
+client.table('orders').where(...).delete();
+```
+
+## Development
+
+```bash
+npm install      # Install dependencies
+npm run build    # Build package
+npm run test     # Run tests
+npm run lint     # Lint code
+```
+
+## Contributing
+
+See [AGENTS.md](./AGENTS.md) for development workflow.
+
+## License
+
+MIT