@dialgem/client 0.0.0-stage → 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## 1.0.0
+
+The first stable release. The API is the one in `0.1.0-beta.1`, unchanged: nothing was added, removed or renamed. From here on, breaking changes only come in a new major version, and `npm install @dialgem/client` installs this release.
+
+### What it does
+
+- `DialgemCall`: microphone capture (AudioWorklet, converted to 16 kHz mono in the audio thread), streaming playback of the agent's voice, and typed events (`started`, `transcript`, `agent_speaking`, `interrupted`, `level`, `ended`, `error`). `start()`, `stop()` and `setMuted()`.
+- `@dialgem/client/react`: `useDialgemCall`, a hook that makes a new call (and fetches a new token) on every `start()` and hangs up on unmount.
+- Authenticates with the one-use token from `dialgem.webCalls.create` (in `@dialgem/sdk`); an API key is never needed in the browser.
+- Refusals say why: `refused` (with `reason` `token_expired`, `token_already_used`, `token_invalid` or `origin_not_allowed`), `busy`, `call_refused` (with the server's reason).
+- Not in this release: reconnecting a dropped call (the token is single-use and the conversation lives on the server for as long as the connection does), WebRTC, a script-tag build.

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,149 @@
-# Temporary Holding Version
+<div align="center">
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# Dialgem Client
+
+**Talk to a [Dialgem](https://dialgem.com) voice agent from any web page.**
+
+Microphone capture, streaming playback and live call events in the browser, with a small React hook. Your API key never reaches the page.
+
+[![npm](https://img.shields.io/npm/v/@dialgem/client?color=CB3837&logo=npm&logoColor=white)](https://www.npmjs.com/package/@dialgem/client)
+[![CI](https://img.shields.io/github/actions/workflow/status/DialgemAI/dialgem-client-sdk/ci.yml?branch=main&label=CI&logo=github)](https://github.com/DialgemAI/dialgem-client-sdk/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+[![TypeScript](https://img.shields.io/badge/TypeScript-typed-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
+[![React](https://img.shields.io/badge/React-hook%20included-61DAFB?logo=react&logoColor=black)](#react)
+[![Stars](https://img.shields.io/github/stars/DialgemAI/dialgem-client-sdk?style=flat&logo=github)](https://github.com/DialgemAI/dialgem-client-sdk/stargazers)
+
+[Website](https://dialgem.com) · [Issues](https://github.com/DialgemAI/dialgem-client-sdk/issues) · [Changelog](CHANGELOG.md) · [Server SDK](https://github.com/DialgemAI/dialgem-sdk-typescript)
+
+</div>
+
+---
+
+```ts
+import { DialgemCall } from "@dialgem/client"
+
+const call = new DialgemCall({ accessToken: () => fetch("/api/start-call").then((r) => r.text()) })
+call.on("transcript", (t) => console.log(t.role, t.text))
+button.onclick = () => call.start()
+```
+
+## Why this SDK
+
+- **Your API key stays on your server.** Your backend mints a one-use token that lives 60 seconds; the page connects with that alone.
+- **Voice in the browser, handled.** It opens the microphone, converts to 16 kHz in an audio worklet, streams the voice to the agent and plays the agent's voice as it arrives, with echo cancellation on by default.
+- **Events for your UI.** Transcript (live as the caller speaks), who is speaking, interruptions, microphone level, and how the call ended.
+- **React hook included.** `useDialgemCall` from `@dialgem/client/react`; React is an optional peer dependency (18+).
+- **No runtime dependencies**, and typed.
+- **Wide support.** Chrome 66+, Edge 79+, Firefox 76+, Safari 14.1+ (anything with `AudioWorklet`), over HTTPS or `localhost`.
+
+## Contents
+
+[Install](#install) · [How a call starts](#how-a-call-starts) · [React](#react) · [DialgemCall](#dialgemcall) · [Events](#events) · [Things worth knowing](#things-worth-knowing) · [License](#license)
+
+## Install
+
+```sh
+npm install @dialgem/client
+```
+
+## How a call starts
+
+Your **server** asks Dialgem for a call with your API key and gives the page a one-use token. The page connects with that token alone, so **your API key never reaches the browser**.
+
+```ts
+// On your server, with @dialgem/sdk. Called by your page when a visitor clicks.
+import { Dialgem } from "@dialgem/sdk"
+const dialgem = new Dialgem({ apiKey: process.env.DIALGEM_API_KEY })
+
+export async function startCall() {
+  const { access_token } = await dialgem.webCalls.create({ agent_id: "AGENT_ID" })
+  return access_token                 // 60 seconds, one use
+}
+```
+
+```ts
+// On your page.
+import { DialgemCall } from "@dialgem/client"
+
+const call = new DialgemCall({
+  accessToken: () => fetch("/api/start-call").then((r) => r.text()),
+})
+
+call.on("transcript", (t) => console.log(t.role, t.text, t.final ? "" : "…"))
+call.on("agent_speaking", ({ speaking }) => orb.classList.toggle("talking", speaking))
+call.on("ended", ({ reason }) => console.log("call ended:", reason))
+call.on("error", (e) => alert(e.message))
+
+button.onclick = () => call.start()   // from a click: browsers only allow sound after one
+hangUp.onclick = () => call.stop()
+```
+
+Before the first call, allow your page's origin (for example `https://app.example.com`) in the Dialgem dashboard under **Settings, Web calls**, or with `dialgem.webCalls.updateSettings({ allowed_origins: [...] })`.
+
+### React
+
+```tsx
+import { useDialgemCall } from "@dialgem/client/react"
+
+function Talk() {
+  const call = useDialgemCall({ getAccessToken: () => fetch("/api/start-call").then((r) => r.text()) })
+  return (
+    <>
+      <button onClick={call.start} disabled={call.state === "connecting" || call.state === "active"}>Talk to us</button>
+      {call.state === "active" && <button onClick={call.stop}>Hang up</button>}
+      {call.transcript.map((l) => <p key={l.id}>{l.role}: {l.text}</p>)}
+      {call.error && <p role="alert">{call.error.message}</p>}
+    </>
+  )
+}
+```
+
+## `DialgemCall`
+
+`new DialgemCall({ accessToken, microphone?, baseURL? })`
+
+- `accessToken`: the token, or a function returning it (sync or async). A function is called **after** the visitor has allowed the microphone, because the token lives 60 seconds and a permission prompt can take longer.
+- `microphone`: `{ deviceId, echoCancellation, noiseSuppression, autoGainControl }`. The last three default to `true`: without echo cancellation the agent's own voice comes back through the microphone and it answers itself. Turn them off only for a headset in a quiet room.
+- `baseURL`: only for a self-hosted deployment. Plain `ws://` is refused for anything but `localhost`, because the token would cross the network in the clear.
+
+Methods: `start()` (returns when connected; rejects with the same error the `error` event carries), `stop()`, `setMuted(boolean)` (the agent hears silence; the call stays open). Properties: `state`, `callId`, `muted`.
+
+A `DialgemCall` is used once. A token is single-use, so a second call needs a new object (the React hook does this for you on every `start()`).
+
+### Events
+
+| Event | Payload |
+| --- | --- |
+| `state` | `"idle" \| "connecting" \| "active" \| "ended" \| "error"` |
+| `started` | `{ callId }`. The agent is live. |
+| `transcript` | `{ role: "user" \| "agent", text, final }`. A caller's line arrives as `final: false` while they speak, then settles. |
+| `agent_speaking` | `{ speaking }`. True from the first audio until it has played out. |
+| `interrupted` | The caller talked over the agent and its speech was cut off. |
+| `level` | `{ level }`, microphone level 0 to 1, about ten times a second. |
+| `ended` | `{ reason: "hangup" \| "agent_ended" \| "connection_lost" }` |
+| `error` | `{ code, message, reason? }` |
+
+Error codes: `unsupported`, `mic_denied`, `mic_unavailable`, `token_unavailable`, `refused` (token invalid, expired or used, or this page's origin not allowed; `reason` says which), `busy` (too many calls running), `call_refused` (declined by the server, `reason` says why, for example `insufficient_credit`), `server_error`, `connection_failed`.
+
+### There is no reconnecting
+
+The conversation lives on the server for as long as the connection does, and the token is single-use. A call that drops has ended (`reason: "connection_lost"`); start a new one. A page that wants to carry on should tell the visitor and start again.
+
+## Things worth knowing
+
+- **Content-Security-Policy.** The audio processor is loaded from a `blob:` URL. If your page sets a CSP, `script-src` needs `blob:`, or `start()` fails with `unsupported`.
+- **Sample rate.** The microphone is captured at the device's own rate and converted to 16 kHz in the audio thread; the agent's voice is 16 kHz and the browser resamples it for the speakers. Nothing to configure.
+- **Autoplay.** Call `start()` straight from a click or tap handler. The audio output is created synchronously inside it, before any `await`, which is what browsers count as the visitor starting it.
+- **Billing.** Browser calls are billed like any other call. `webCalls.create` fails with 402 if the organization cannot pay for one.
+
+## License
+
+Apache-2.0
+
+---
+
+<div align="center">
+
+If this SDK saves you time, a ⭐ on [GitHub](https://github.com/DialgemAI/dialgem-client-sdk) helps other developers find it.
+
+</div>

package/dist/call-Cv2GrNfJ.d.cts

@@ -0,0 +1,160 @@
+/** A minimal typed event emitter. A handler that throws never stops the others or the call. */
+declare class Emitter<Events extends Record<string, unknown>> {
+    private handlers;
+    on<K extends keyof Events>(event: K, handler: (payload: Events[K]) => void): () => void;
+    off<K extends keyof Events>(event: K, handler: (payload: Events[K]) => void): void;
+    protected emit<K extends keyof Events>(event: K, payload: Events[K]): void;
+}
+
+type CallState = "idle" | "connecting" | "active" | "ended" | "error";
+/** How a call that started came to an end. */
+type EndReason = 
+/** `stop()` was called. */
+"hangup"
+/** The agent ended the call, or a call limit (maximum length, silence) did. */
+ | "agent_ended"
+/** The connection dropped. The call cannot be resumed: start a new one. */
+ | "connection_lost";
+type ErrorCode = 
+/** The browser lacks something the call needs (WebSocket, Web Audio, AudioWorklet, a microphone API). */
+"unsupported"
+/** The visitor refused microphone access, or it is blocked for this page. */
+ | "mic_denied"
+/** No microphone, or it could not be opened. */
+ | "mic_unavailable"
+/** `accessToken` was a function and it threw or returned nothing. */
+ | "token_unavailable"
+/** The token was invalid, expired or already used, or this page's origin is not allowed. */
+ | "refused"
+/** The organization has too many calls running. */
+ | "busy"
+/** The server declined the call; `reason` says why (for example `insufficient_credit`). */
+ | "call_refused" | "server_error" | "connection_failed";
+interface CallError {
+    code: ErrorCode;
+    message: string;
+    /** For `call_refused`: the server's reason. */
+    reason?: string | undefined;
+}
+interface TranscriptEvent {
+    role: "user" | "agent";
+    text: string;
+    /** False while the caller is still speaking (the words so far); true once the line is settled. */
+    final: boolean;
+}
+interface CallEvents extends Record<string, unknown> {
+    state: CallState;
+    started: {
+        callId: string;
+    };
+    transcript: TranscriptEvent;
+    agent_speaking: {
+        speaking: boolean;
+    };
+    /** The caller talked over the agent and its speech was cut off. */
+    interrupted: Record<string, never>;
+    /** Microphone level, 0 to 1, about ten times a second. Not emitted while muted. */
+    level: {
+        level: number;
+    };
+    ended: {
+        reason: EndReason;
+    };
+    error: CallError;
+}
+interface MicrophoneOptions {
+    deviceId?: string | undefined;
+    /** Default true: without it the agent's own voice comes back through the microphone and it answers itself. */
+    echoCancellation?: boolean | undefined;
+    noiseSuppression?: boolean | undefined;
+    autoGainControl?: boolean | undefined;
+}
+interface DialgemCallOptions {
+    /**
+     * The access token from your backend's `POST /v1/calls/web`, or a function that returns it. A function
+     * is called **after** the visitor has allowed the microphone, because the token only lives 60 seconds and
+     * the permission prompt can take longer than that.
+     */
+    accessToken: string | (() => string | Promise<string>);
+    /** Only for a self-hosted deployment. Default `wss://api.dialgem.com`. */
+    baseURL?: string | undefined;
+    microphone?: MicrophoneOptions | undefined;
+    /** @internal Stand-ins for the browser, for tests. */
+    platform?: Partial<Platform> | undefined;
+}
+/** What the call needs from the browser. */
+interface Platform {
+    WebSocket: typeof WebSocket;
+    AudioContext: typeof AudioContext;
+    AudioWorkletNode: typeof AudioWorkletNode;
+    getUserMedia(constraints: MediaStreamConstraints): Promise<MediaStream>;
+    createObjectURL(blob: Blob): string;
+    revokeObjectURL(url: string): void;
+    Blob: typeof Blob;
+}
+/**
+ * One conversation with one agent.
+ *
+ *   const call = new DialgemCall({ accessToken: () => fetch("/api/start-call").then((r) => r.text()) })
+ *   call.on("transcript", (t) => ...)
+ *   await call.start()      // from a click: browsers only let a page open the microphone and play sound after one
+ *   ...
+ *   call.stop()
+ *
+ * A call object is used once. Its token is single-use, so a second call needs a new object (and a new token).
+ * There is no reconnecting: the conversation lives on the server for as long as the socket does, and a call
+ * that drops has ended.
+ */
+declare class DialgemCall extends Emitter<CallEvents> {
+    private readonly options;
+    private _state;
+    private _muted;
+    private _callId;
+    private readonly platform;
+    private ctx;
+    private stream;
+    private ws;
+    private player;
+    private source;
+    private node;
+    private sink;
+    private moduleUrl;
+    private speakingTimer;
+    private drainTimer;
+    private ending;
+    private pendingRefusal;
+    private failure;
+    private lastLevelAt;
+    private speaking;
+    constructor(options: DialgemCallOptions);
+    get state(): CallState;
+    /** Set once the call has started. */
+    get callId(): string | null;
+    get muted(): boolean;
+    /**
+     * Opens the microphone and the call. Call it directly from a click or tap: the browser decides whether the page
+     * may play sound at the moment this runs, and a call started from a timer or after other awaits can be silent.
+     * Resolves when the connection is open; the call has started when `started` fires. A failure is reported as an
+     * `error` event and also rejects.
+     */
+    start(): Promise<void>;
+    /** Ends the call. Safe to call at any time, any number of times. */
+    stop(): void;
+    /** While muted the agent hears silence. The call stays open. */
+    setMuted(muted: boolean): void;
+    private onMessage;
+    private onStarted;
+    private onCaptured;
+    private onAudio;
+    private setSpeaking;
+    private onCallEnded;
+    private onClose;
+    private dead;
+    /** Ends the call as failed and reports it once. Returns the error, for `start()` to throw. */
+    private fail;
+    private finish;
+    private setState;
+    private cleanup;
+}
+
+export { type CallError as C, DialgemCall as D, type EndReason as E, type MicrophoneOptions as M, type TranscriptEvent as T, type CallEvents as a, type CallState as b, type DialgemCallOptions as c, type ErrorCode as d };