@sippet-ai/sdk-js 0.0.1

package/LICENSE

@@ -0,0 +1,2 @@
+COPYRIGHT (c) 2026 SIPPET TECHNOLOGIES VCC
+ALL RIGHTS RESERVED

package/README.md

@@ -0,0 +1,196 @@
+# Sippet AI JS SDK
+
+Typed JavaScript/TypeScript client for Sippet AI.
+
+It includes three layers:
+
+- RPC actions for calls, queues, contacts, operators, and AI agents.
+- Realtime events via WebSocket channels.
+- SIP conference helpers built on `sip.js` for WebRTC audio.
+
+This SDK is used by the Sippet call center UI and the operator widget.
+
+## Install
+
+```bash
+npm install @sippet-ai/sdk-js
+```
+
+## Entry points
+
+- `@sippet-ai/sdk-js` for RPC actions + realtime helpers.
+- `@sippet-ai/sdk-js/realtime` for realtime helpers only.
+- `@sippet-ai/sdk-js/sip` for SIP/WebRTC helpers only.
+
+### `createClient` (recommended)
+
+```ts
+import { createClient } from "@sippet-ai/sdk-js";
+
+const client = createClient({
+  apiKey: "YOUR_PUBLISHABLE_KEY",
+});
+
+const result = await client.listCalls({
+  fields: ["id", "callUuid", "status"],
+});
+```
+
+`createClient` only injects the API key into RPC calls; realtime helpers like `initSocket` are passed through unchanged.
+
+## RPC usage
+
+All RPC functions return a discriminated union:
+
+- `{ success: true, data }`
+- `{ success: false, errors }`
+
+### Common config options
+
+Most actions accept the same config shape:
+
+- `fields`: field selection for typed responses.
+- `filter`: filter expression for list/read actions.
+- `sort`: sort string supported by the API.
+- `page`: pagination config (`{ limit, offset, count }` or keyset params).
+- `headers`: add custom headers (auth, etc.).
+- `fetchOptions`: pass `RequestInit` options (signal, cache, credentials, ...).
+- `customFetch`: supply your own `fetch` implementation.
+
+### Start an outbound call
+
+```ts
+import { createClient } from "@sippet-ai/sdk-js";
+
+const client = createClient({ apiKey: "YOUR_PUBLISHABLE_KEY" });
+
+const result = await client.startOutboundCall({
+  input: {
+    contactId: "CONTACT_ID",
+    aiAgentId: "AGENT_ID",
+  },
+});
+
+if (!result.success) {
+  throw new Error(result.errors.map((e) => e.message).join(", "));
+}
+
+const call = result.data;
+```
+
+### List calls with filters
+
+```ts
+import { createClient } from "@sippet-ai/sdk-js";
+
+const client = createClient({ apiKey: "YOUR_PUBLISHABLE_KEY" });
+
+const result = await client.listCalls({
+  fields: ["id", "callUuid", "fromNumber", "toNumber", "status", "startedAt"],
+  filter: {
+    status: { in: ["initiated", "ringing", "answered"] },
+  },
+});
+```
+
+### Pagination
+
+Many `list*` actions accept `page` to enable pagination.
+
+```ts
+import { createClient } from "@sippet-ai/sdk-js";
+
+const client = createClient({ apiKey: "YOUR_PUBLISHABLE_KEY" });
+
+const result = await client.listCalls({
+  fields: ["id", "callUuid", "status"],
+  page: { limit: 50, offset: 0, count: true },
+});
+```
+
+## Realtime events
+
+Realtime helpers are built on Phoenix channels. The SDK exposes a helper
+for the `events` channel used by Sippet AI.
+
+```ts
+import { initSocket, joinEventsChannel } from "@sippet-ai/sdk-js";
+
+initSocket({
+  baseUrl: "https://api.sippet.ai",
+  publishableKey: "YOUR_PUBLISHABLE_KEY",
+});
+
+const channel = joinEventsChannel();
+
+channel.on("incoming_call", (payload) => {
+  console.log("incoming_call", payload);
+});
+
+channel.on("call_answered", (payload) => {
+  console.log("call_answered", payload);
+});
+
+channel.on("call_ended", (payload) => {
+  console.log("call_ended", payload);
+});
+```
+
+Known `events` channel names:
+
+- `incoming_call`
+- `call_answered`
+- `call_ended`
+- `operator_status_change`
+- `call_queue_entry_updated`
+- `call_queue_entry_deleted`
+- `call_participant_joined`
+- `call_participant_left`
+- `call_transcript_delta`
+- `call_transcript_completed`
+
+## SIP / WebRTC helpers
+
+Use the SIP helpers when you need to join a SIP conference or eavesdrop
+session directly in the browser.
+
+```ts
+import {
+  joinConference,
+  leaveConference,
+  setInputDevice,
+  setOutputDevice,
+} from "@sippet-ai/sdk-js/sip";
+
+await joinConference({
+  server: "wss://sip.sippet.ai:7443",
+  domain: "sip.sippet.ai",
+  username: "SIP_USERNAME",
+  password: "SIP_PASSWORD",
+  roomId: "ROOM_ID",
+  codecPreference: "pcma",
+});
+
+await setInputDevice("mic-device-id");
+await setOutputDevice("speaker-device-id");
+
+await leaveConference();
+```
+
+## RPC API surface (high-level)
+
+This SDK is generated from the Sippet AI API. Key categories:
+
+- Identity: `whoAmI`.
+- Calls: `listCalls`, `createCall`, `endCall`, `startOutboundCall`, `resumeAiCall`, `bargeCall`, `callCodec`.
+- AI agents: `listAiAgents`.
+- Call participants and transcripts: `listCallParticipants`, `listCallTranscripts`.
+- Queue and routing: `listQueues`, `listCallQueueEntries`, `getCallQueueEntry`, `acceptCallQueueEntry`.
+- Contacts: `listContacts`, `createContact`, `updateContact`, `deleteContact`.
+- Operators: `listOperatorStatuses`, `setOperatorStatus`, `listOperatorStatusEvents`.
+- Telephony access: `issueOperatorSipAccess`, `issueSipAccess`, `revokeSipAccess`.
+- Phone numbers and gateways: `listPhoneNumbers`, `listGateways`.
+
+## Related packages
+
+- `@sippet-ai/operator-widget`: a full VoIP UI built on this SDK (web component + React wrapper).