@sippulse/niva-sdk 0.1.0-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to the Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by the Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding any notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2026 SipPulse
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,153 @@
1
+ # @sippulse/niva-sdk
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@sippulse/niva-sdk.svg)](https://www.npmjs.com/package/@sippulse/niva-sdk)
4
+ [![Node.js](https://img.shields.io/badge/node-%3E%3D22-brightgreen.svg)](https://nodejs.org)
5
+ [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE)
6
+
7
+ Typed TypeScript SDK for [NIVA](https://niva.sippulse.com) - a low-code platform for building intelligent IVR systems with AI integration.
8
+
9
+ It ships a typed client generated from the NIVA `/api/v1` contract (no runtime dependencies, `fetch`-based) and a webhook receiver with signature verification that runs on Node.js, Bun and Deno.
10
+
11
+ ## Install
12
+
13
+ ```bash
14
+ npm i @sippulse/niva-sdk
15
+ ```
16
+
17
+ The `latest` dist-tag tracks the newest SDK. To pin the SDK maintained for a NIVA line, install through that line's dist-tag (see [Compatibility](#compatibility)):
18
+
19
+ ```bash
20
+ npm i @sippulse/niva-sdk@niva-2.0
21
+ ```
22
+
23
+ ## Quick start
24
+
25
+ ```ts
26
+ import { createNivaClient, isNivaApiError } from "@sippulse/niva-sdk";
27
+
28
+ const client = createNivaClient({
29
+ baseUrl: "https://niva.yourcompany.com", // server root, without /api/v1
30
+ apiKey: process.env.NIVA_API_KEY!, // or a function returning it, re-read per request
31
+ });
32
+
33
+ const plans = await client.visualPlans.list({ page: 1 });
34
+
35
+ const call = await client.calls.originate({
36
+ plan_id: "vp_01hzy00000000000000000000",
37
+ destination: "+15551234567",
38
+ });
39
+
40
+ try {
41
+ await client.visualPlans.publish({ plan_id: "vp_01hzy00000000000000000000" });
42
+ } catch (error) {
43
+ if (isNivaApiError(error)) {
44
+ // errors carry the HTTP status, the server error code and the operation id
45
+ console.error(error.status, error.code, error.operation);
46
+ }
47
+ }
48
+ ```
49
+
50
+ `baseUrl` is the server root; the client appends `/api/v1`. The client performs a one-time compatibility handshake against `/capabilities` and fails fast with `NivaIncompatibleServerError` or `NivaUnavailableError` when the server does not match the generated contract.
51
+
52
+ ## Errors
53
+
54
+ All SDK failures extend `NivaError` and set a stable `name`:
55
+
56
+ | Class | Meaning |
57
+ |-------|---------|
58
+ | `NivaApiError` | The server answered a non-2xx status. `status`, `code`, `data`, `operation`, `requestId`. |
59
+ | `NivaConnectionError` | Transport failure. `reason` is `network`, `timeout` or `aborted`. |
60
+ | `NivaConfigurationError` | Invalid client options or an empty resolved API key. |
61
+ | `NivaIncompatibleServerError` | The server product version is outside the supported range. |
62
+ | `NivaUnavailableError` | The operation is not served, or its module is disabled. |
63
+ | `NivaWebhookError` | Webhook verification or payload failure (see below). |
64
+
65
+ `isNivaApiError(error)` narrows `unknown` to `NivaApiError`.
66
+
67
+ ## Streaming (SSE)
68
+
69
+ Operations served as Server-Sent Events return a `NivaStream` - an `AsyncIterable` with an explicit `close()`:
70
+
71
+ ```ts
72
+ const stream = client.dashboard.watchDashboardMetrics();
73
+
74
+ for await (const event of stream) {
75
+ console.log(event);
76
+ }
77
+
78
+ await stream.close(); // or pass { signal } to stop through an AbortSignal
79
+ ```
80
+
81
+ ## Binary and uploads
82
+
83
+ Binary operations return the raw `Response` (they support HTTP range requests); multipart uploads take Blobs:
84
+
85
+ ```ts
86
+ const response = await client.audioFiles.content(
87
+ { audio_file_id: "aud_01hzy00000000000000000000" },
88
+ { range: "bytes=0-1023" },
89
+ );
90
+ const bytes = new Uint8Array(await response.arrayBuffer());
91
+
92
+ await client.audioFiles.upload({ file: new Blob([bytes]), name: "greeting" });
93
+ ```
94
+
95
+ ## Webhooks
96
+
97
+ `createNivaWebhookHandler` is the fetch-portable receiver. It verifies the `x-webhook-signature` HMAC, enforces the timestamp tolerance and the body-size limit, and dispatches typed events:
98
+
99
+ ```ts
100
+ import { createNivaWebhookHandler } from "@sippulse/niva-sdk";
101
+
102
+ const handler = createNivaWebhookHandler({
103
+ secret: process.env.NIVA_WEBHOOK_SECRET!,
104
+ path: "/webhooks",
105
+ });
106
+
107
+ handler.on("call.hangup", (event) => {
108
+ // event.data is narrowed to the call.hangup payload
109
+ console.log(event.data.call_id, event.data.hangup_cause);
110
+ });
111
+
112
+ // Mount handler.fetch in any framework/serverless runtime, or use the native server:
113
+ ```
114
+
115
+ For a standalone server, `createNivaWebhookServer` resolves to the adapter of the running runtime through the package's `node` / `bun` / `deno` export conditions:
116
+
117
+ ```ts
118
+ import { createNivaWebhookServer } from "@sippulse/niva-sdk";
119
+
120
+ const server = createNivaWebhookServer({ secret: process.env.NIVA_WEBHOOK_SECRET! });
121
+ server.on("call.answered", (event) => console.log(event.data.call_id));
122
+
123
+ const handle = await server.serve({ port: 8080 });
124
+ console.log(`listening on ${handle.url}`);
125
+ // later: await handle.close();
126
+ ```
127
+
128
+ On an unrecognized runtime the `default` entry resolves and `.serve()` throws `NivaWebhookError` with code `unsupported_runtime`; `handler.fetch` still works everywhere.
129
+
130
+ See the webhook receiver guide in the NIVA docs (`/sdk/webhooks`) for the event registry and payload shapes.
131
+
132
+ ## Compatibility
133
+
134
+ The SDK is generated from, and handshakes against, the server `/api/v1` contract.
135
+
136
+ | SDK version | NIVA version | npm dist-tag |
137
+ |-------------|--------------|--------------|
138
+ | 0.1.x | 2.0.x | `niva-2.0` |
139
+
140
+ ## Runtime support
141
+
142
+ | Runtime | Client | Webhook handler | Native webhook server |
143
+ |---------|--------|-----------------|------------------------|
144
+ | Node.js >= 22 | yes | yes | `node:http` adapter |
145
+ | Bun | yes | yes | `Bun.serve` adapter |
146
+ | Deno | yes | yes | `Deno.serve` adapter |
147
+ | Any `fetch` runtime | yes | yes | `.serve()` is unavailable |
148
+
149
+ Any runtime with a global `fetch`, `Request` and `Response` can use the client and the webhook handler. The package has zero runtime dependencies and does not require `@types/node` or `@types/bun` to type-check.
150
+
151
+ ## License
152
+
153
+ Apache-2.0
@@ -0,0 +1,6 @@
1
+ import type { NivaClient } from "./generated/client.js";
2
+ import type { NivaClientOptions, NivaRequestOptions } from "./types.js";
3
+ export type OperationCall = <T>(opId: string, input: unknown, options?: NivaRequestOptions & {
4
+ range?: string;
5
+ }) => Promise<T>;
6
+ export declare function createNivaClient(options: NivaClientOptions): NivaClient;
@@ -0,0 +1,3 @@
1
+ /** Bun entry: everything from the root plus the `Bun.serve` server adapter. */
2
+ export * from "../index.js";
3
+ export { createNivaWebhookServer, WEBHOOK_RUNTIME } from "../webhook/serve-bun.js";
@@ -0,0 +1,3 @@
1
+ /** Fallback entry: everything from the root; `.serve()` throws `unsupported_runtime`. */
2
+ export * from "../index.js";
3
+ export { createNivaWebhookServer, WEBHOOK_RUNTIME } from "../webhook/serve-default.js";
@@ -0,0 +1,3 @@
1
+ /** Deno entry: everything from the root plus the `Deno.serve` server adapter. */
2
+ export * from "../index.js";
3
+ export { createNivaWebhookServer, WEBHOOK_RUNTIME } from "../webhook/serve-deno.js";
@@ -0,0 +1,3 @@
1
+ /** Node.js entry: everything from the root plus the `node:http` server adapter. */
2
+ export * from "../index.js";
3
+ export { createNivaWebhookServer, WEBHOOK_RUNTIME } from "../webhook/serve-node.js";
@@ -0,0 +1,98 @@
1
+ /**
2
+ * Public error hierarchy for `@niva/sdk` (NIVA-258 phase B).
3
+ *
4
+ * Every error extends `NivaError extends Error` with `name` set. `cause` is
5
+ * preserved where the code receives one; the SDK never puts the API key, a
6
+ * secret, a signature, or a request/response body into `message`, `cause`,
7
+ * or any property it sets. `NivaApiError.data` is the server's DEFINED error
8
+ * payload (public contract) and stays a normal enumerable property.
9
+ */
10
+ import type { NivaErrorCodes } from "./generated/operations.js";
11
+ /** Union of every defined error code in the generated contract. */
12
+ export type NivaErrorCode = NivaErrorCodes[keyof NivaErrorCodes];
13
+ export declare class NivaError extends Error {
14
+ constructor(message: string, options?: {
15
+ cause?: unknown;
16
+ });
17
+ name: string;
18
+ }
19
+ export interface NivaApiErrorDetails {
20
+ status: number;
21
+ code: string;
22
+ message: string;
23
+ data?: unknown;
24
+ requestId?: string | undefined;
25
+ operation: string;
26
+ }
27
+ export declare class NivaApiError<Code extends string = string> extends NivaError {
28
+ name: string;
29
+ readonly status: number;
30
+ readonly code: Code;
31
+ readonly data: unknown;
32
+ readonly requestId: string | undefined;
33
+ readonly operation: string;
34
+ constructor(details: NivaApiErrorDetails & {
35
+ code: Code;
36
+ });
37
+ }
38
+ export type NivaConnectionReason = "network" | "timeout" | "aborted";
39
+ export declare class NivaConnectionError extends NivaError {
40
+ name: string;
41
+ readonly reason: NivaConnectionReason;
42
+ constructor(message: string, options: {
43
+ reason: NivaConnectionReason;
44
+ cause?: unknown;
45
+ });
46
+ }
47
+ export declare class NivaConfigurationError extends NivaError {
48
+ name: string;
49
+ }
50
+ export interface NivaIncompatibleServerDetails {
51
+ serverVersion: string;
52
+ supported: string;
53
+ installCommand?: string | undefined;
54
+ }
55
+ export declare class NivaIncompatibleServerError extends NivaError {
56
+ name: string;
57
+ readonly serverVersion: string;
58
+ readonly supported: string;
59
+ readonly installCommand: string | undefined;
60
+ constructor(message: string, details: NivaIncompatibleServerDetails);
61
+ }
62
+ export type NivaUnavailableReason = "operation" | "module";
63
+ export declare class NivaUnavailableError extends NivaError {
64
+ name: string;
65
+ readonly operation: string;
66
+ readonly reason: NivaUnavailableReason;
67
+ readonly module: string | undefined;
68
+ constructor(operation: string, options: {
69
+ reason: NivaUnavailableReason;
70
+ module?: string | undefined;
71
+ });
72
+ }
73
+ /**
74
+ * Webhook failure taxonomy. `verification` covers signature/clock/headers,
75
+ * `payload` covers JSON/envelope after the signature verified,
76
+ * `handler_missing` a valid event with no handler, `unsupported_runtime`
77
+ * a `.serve()` call on a runtime without a native adapter.
78
+ */
79
+ export type NivaWebhookErrorKind = "verification" | "payload" | "handler_missing" | "unsupported_runtime";
80
+ /** Machine-readable webhook failure codes (stable, documented, no secrets). */
81
+ export type NivaWebhookErrorCode = "missing_header" | "duplicate_header" | "bad_timestamp" | "timestamp_out_of_tolerance" | "bad_signature" | "invalid_json" | "invalid_envelope" | "unknown_event";
82
+ /**
83
+ * The only error the webhook receiver throws. Carries `kind` + `code` only:
84
+ * never the secret, the signature, or the request body.
85
+ */
86
+ export declare class NivaWebhookError extends NivaError {
87
+ name: string;
88
+ readonly kind: NivaWebhookErrorKind;
89
+ readonly code: NivaWebhookErrorCode | "handler_missing" | "unsupported_runtime";
90
+ constructor(kind: NivaWebhookErrorKind, code: NivaWebhookError["code"], message: string);
91
+ }
92
+ /**
93
+ * Guard for API errors. With a code it narrows `err.code` to that literal;
94
+ * the code parameter autocompletes every generated error code but still
95
+ * accepts any string.
96
+ */
97
+ export declare function isNivaApiError<Code extends NivaErrorCode | (string & {})>(err: unknown, code: Code): err is NivaApiError<Extract<Code, string>>;
98
+ export declare function isNivaApiError(err: unknown): err is NivaApiError;
@@ -0,0 +1,8 @@
1
+ /**
2
+ * GENERATED FILE - do not edit. Run `bun run generate` in packages/sdk
3
+ * (NIVA-258). Source: GET /api/v1/spec.json via generateOpenApiSpec().
4
+ */
5
+ import type { OperationCall } from "../client.js";
6
+ import type { NivaClient } from "./client.js";
7
+ /** GENERATED implementation: namespaces delegating to one hand-written call. */
8
+ export declare function buildNivaClient(call: OperationCall): NivaClient;