@nopaque/sdk 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.1] - 2026-04-21
+
+### Fixed
+- Cross-resource response envelope audit. The server uses resource-named
+  keys for most list endpoints (and wraps load-test config create/update
+  in `{config: {...}}`); the SDK previously assumed `{items: [...]}`
+  everywhere, so several list methods returned empty results. Aligned:
+  - `mapping.runs(jobId)` — reads `runs` (was: `items`).
+  - `mapping.paths(jobId)` — reads `rules` (was: `items`).
+  - `batches.list()` / `listPage()` — reads `batches`.
+  - `batches.runs(batchId)` and `batches.listRuns()` — read `runs`.
+  - `sweeps.list()` / `listPage()` — reads `sweeps`.
+  - `sweeps.runs(sweepId)` and `sweeps.listRuns()` — read `runs`.
+  - `datasets.list()` / `listPage()` — reads `datasets`.
+  - `loadTesting.list()` / `listPage()` — reads `configs`.
+  - `loadTesting.listRuns()` — reads `runs`.
+  - `scheduler.list()` / `listPage()` — reads `schedules`.
+  - `audio.list()` / `listPage()` — reads `audioFiles`.
+  - `profiles.list()` / `listPage()` — reads `profiles`.
+- `loadTesting.create()` and `loadTesting.update()` now unwrap the
+  server's `{config: {...}}` envelope before returning.
+- `profiles.findByParameters()` response shape corrected from
+  `{items: [...]}` to `{profiles: [...]}`. Callers should read
+  `result.profiles`.
+
+### Changed (non-breaking)
+- `Paginator` accepts an `itemsKey?: string` option so each resource can
+  declare the key its list endpoint uses. Falls back to `items` if the
+  declared key is missing, preserving forward compatibility.
+- `BatchRun`, `SweepRun`, `LoadTestRun` now declare `id` as the primary
+  key (matching the server); `runId` remains on the type as deprecated.
+
+## [0.1.0] — 2026-04-19
+
+### Added
+- Initial release.
+- `Nopaque` client with full coverage of the API-key-authenticated
+  Nopaque REST API: mapping, profiles, testing (configs/jobs/runs),
+  batches, sweeps, datasets, load testing, scheduler, enrichment, audio.
+- Automatic pagination, polling helpers for long-running jobs,
+  one-call audio upload/download.
+- Method-aware retry with exponential jitter and `Retry-After` honor.
+- Typed error class hierarchy.
+- Dual ESM + CJS output with TypeScript definitions.
+
+[Unreleased]: https://github.com/nopaque/node-sdk/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/nopaque/node-sdk/releases/tag/v0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nopaque Ltd
+
+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 @@
+# @nopaque/sdk — Node SDK for Nopaque
+
+Official Node.js client for the [Nopaque](https://nopaque.co.uk) API.
+
+## Install
+
+```bash
+npm install @nopaque/sdk
+# or
+pnpm add @nopaque/sdk
+# or
+yarn add @nopaque/sdk
+```
+
+## Quick start
+
+```typescript
+import { Nopaque } from '@nopaque/sdk';
+
+const client = new Nopaque({ apiKey: process.env.NOPAQUE_API_KEY });
+
+// Create a mapping job and wait until it completes
+const job = await client.mapping.create({
+  name: 'Main IVR',
+  phoneNumber: '+441234567890',
+  mappingMode: 'dtmf',
+});
+await client.mapping.start(job.id);
+const final = await client.mapping.waitForComplete(job.id);
+console.log(final.status);
+
+// List audio files with automatic pagination
+for await (const audio of client.audio.list()) {
+  console.log(audio.id, audio.fileName);
+}
+```
+
+## Features
+
+- Full coverage of the Nopaque REST API via API-key auth
+- Written in TypeScript; full type definitions included
+- Automatic pagination for list endpoints
+- Polling helpers for long-running jobs (`waitForComplete`)
+- One-call audio upload/download wrapping the presigned-URL flow
+- Method-aware retry with exponential jitter and `Retry-After` honor
+- Typed error classes (`NotFoundError`, `RateLimitError`, etc.)
+- Zero runtime dependencies — uses platform `fetch`
+- Dual ESM + CJS, works in Node 20+, Next.js server actions, and bundlers
+
+## Documentation
+
+Full reference: <https://nopaque.co.uk/docs/sdks>
+
+## Authentication
+
+```typescript
+new Nopaque({ apiKey: 'nop_live_...' });
+```
+
+Or set the environment variable:
+
+```bash
+export NOPAQUE_API_KEY=nop_live_...
+```
+
+API keys are workspace-scoped and subject to per-minute rate limits based on your subscription tier. Free tier cannot use API keys.
+
+## CommonJS
+
+```javascript
+const { Nopaque } = require('@nopaque/sdk');
+const client = new Nopaque({ apiKey: '...' });
+```
+
+## Requirements
+
+- Node 20+
+
+## License
+
+MIT