@dalea/sdk 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Dalea
+
+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,119 @@
+# @dalea/sdk
+
+The official TypeScript & JavaScript SDK for the [Dalea](https://dalea.app) data platform.
+
+Typed, promise-based access to the Dalea API, with dual **ESM + CJS** builds, bundled
+type declarations, and **zero runtime dependencies**.
+
+- Node **>= 20** (works in the browser and edge runtimes too)
+- Fully typed against the platform's OpenAPI contract
+- API-key, session-cookie, and OAuth 2.1 + PKCE auth
+
+## Install
+
+```sh
+npm i @dalea/sdk
+# or: pnpm add @dalea/sdk   /   yarn add @dalea/sdk
+```
+
+## Quickstart
+
+Create a workspace API key in the Dalea app, then:
+
+```ts
+import { DaleaClient } from '@dalea/sdk';
+
+const client = new DaleaClient({
+  baseUrl: 'https://dalea.app',
+  apiKey: process.env.DALEA_API_KEY, // or set DALEA_API_KEY and omit this
+});
+
+// List the data environments in your workspace.
+const environments = await client.data.environments.list();
+console.log(environments);
+```
+
+If `DALEA_API_KEY` is set in the environment, `new DaleaClient({ baseUrl: 'https://dalea.app' })`
+picks it up automatically — no `apiKey` needed.
+
+## Authentication
+
+Pass exactly one credential to the constructor:
+
+```ts
+// 1. Workspace API key (server-side; the default) — sent as X-API-Key.
+new DaleaClient({ baseUrl: 'https://dalea.app', apiKey: 'dalea_…' });
+
+// 2. Session cookie (browser, same-origin) — omit baseUrl to use the current origin.
+new DaleaClient({ sessionCookie: true });
+
+// 3. Any Credential (OAuth 2.1 + PKCE, client-credentials, bearer, …).
+import { OAuthPkceCredential } from '@dalea/sdk';
+new DaleaClient({ baseUrl: 'https://dalea.app', credential: new OAuthPkceCredential(/* … */) });
+```
+
+Scope calls to a workspace with `client.setWorkspace(id)` (or the `workspace` config
+option), and pass a per-request bearer token with `client.as(token)`.
+
+## Error handling
+
+Every failure throws a typed `DaleaError` subclass you can branch on:
+
+```ts
+import { DaleaRateLimitError, DaleaValidationError } from '@dalea/sdk';
+
+try {
+  await client.data.environments.list();
+} catch (err) {
+  if (err instanceof DaleaRateLimitError) {
+    // Retries are automatic (see below); this only fires once they're exhausted.
+    // err.retryAfterSeconds carries the server's hint.
+  } else if (err instanceof DaleaValidationError) {
+    // err.code / err.message / err.data describe what the server rejected.
+  } else {
+    throw err;
+  }
+}
+```
+
+Other subclasses: `DaleaAuthError`, `DaleaPermissionError`, `DaleaNotFoundError`,
+`DaleaConflictError`, `DaleaArchivedError`, `DaleaQuotaError`, `DaleaServerError`,
+`DaleaNetworkError`.
+
+## Retries & backoff
+
+Throttling responses (`429`) and transient `503`s are retried automatically with
+exponential backoff and full jitter, honouring the server's `Retry-After`. **Writes
+retry too** — a throttle is rejected before the handler runs, so replaying is safe —
+so you never need to hand-roll a backoff loop. A `DaleaRateLimitError` surfaces only
+once retries are exhausted (or when the server asks for a wait longer than
+`maxRetryDelayMs`). Terminal errors like `DaleaQuotaError` (`507`) are never retried.
+
+Tune or opt out via the constructor:
+
+| Option | Default | Meaning |
+| --- | --- | --- |
+| `maxRetries` | `2` | Max retries per request. |
+| `retryWrites` | `true` | Retry POST/PATCH/DELETE, not just GET. Set `false` for strict, no-replay callers. |
+| `retryBaseDelayMs` | `500` | Base delay for exponential backoff when the server sends no `Retry-After`. |
+| `maxRetryDelayMs` | `20000` | Ceiling on any single backoff wait; a longer `Retry-After` fails fast. |
+
+## Pagination
+
+List endpoints expose `iterate*` async iterators built on the exported `paginate`
+primitive, so you can walk every page without managing cursors yourself:
+
+```ts
+for await (const obj of client.data.tables.iterateObjects(tableId)) {
+  // … `break` stops fetching the next page
+}
+```
+
+## Documentation
+
+- **API reference** — https://dalea.app/api-docs
+- **Guides & concepts** — the Dalea wiki
+
+## License
+
+[MIT](./LICENSE) © Dalea