@noormdev/sdk 1.0.0-alpha.9 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Danilo Alonso
+
+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,81 @@
+# @noormdev/sdk
+
+Type-safe programmatic access to a noorm-managed database. Wraps [Kysely](https://kysely.dev) with noorm's config resolution, change tracking, and access policy.
+
+**[Documentation](https://noorm.dev)** | **[SDK Reference](https://noorm.dev/reference/sdk)** | **[Source](https://github.com/noormdev/noorm)**
+
+
+## Install
+
+```bash
+npm install @noormdev/sdk kysely
+```
+
+Install the driver for your dialect alongside it — `pg`, `mysql2`, `tedious` + `tarn`, or `better-sqlite3`. They are optional peer dependencies, so only the one you use needs to be present.
+
+
+## Usage
+
+```typescript
+import { createContext } from '@noormdev/sdk';
+
+const ctx = await createContext<{ users: { id: number; name: string } }>({
+    config: 'dev',
+});
+
+await ctx.connect();
+
+// Query through Kysely
+const users = await ctx.kysely
+    .selectFrom('users')
+    .select(['id', 'name'])
+    .execute();
+
+// noorm operations live under their own namespace
+await ctx.noorm.changes.ff();
+
+await ctx.disconnect();
+```
+
+`createContext` resolves connection settings the same way the CLI does — defaults, then stage, then stored config, then `NOORM_CONNECTION_*` env vars, then explicit options — so the same code runs locally and in CI.
+
+
+## Testing
+
+Pass `requireTest: true` and the context refuses to connect unless the resolved config is marked `isTest`. This makes it impossible for a test suite to point at production by accident.
+
+```typescript
+const ctx = await createContext<Database>({
+    config: 'test',
+    requireTest: true,
+});
+```
+
+
+## Typed procedures, functions, and TVFs
+
+Stored routines can be declared as `[Args, ReturnType]` tuples so return types are inferred at the call site, with the generic still available as an override.
+
+```typescript
+type Procs = {
+    get_users: [{ department_id: number }, User];
+    refresh_cache: void;
+};
+
+const ctx = await createContext<Database, Procs>({ config: 'dev' });
+
+const users = await ctx.proc('get_users', { department_id: 1 }); // User[]
+await ctx.proc('refresh_cache');
+```
+
+`createContext<DB, Procs, Funcs, Tvfs>` takes a map per routine kind. Plain `void` is shorthand for "no arguments, no meaningful return".
+
+
+## Requires
+
+Node >= 22.13. Supports **PostgreSQL**, **MySQL**, **SQLite**, and **SQL Server**.
+
+
+## License
+
+MIT