@sentdm/voice-client 0.0.0-stage → 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+## [0.1.1](https://github.com/sentdm/sent-dm-voice-sdk/compare/v0.1.0...v0.1.1) (2026-09-29)
+
+
+### Chores
+
+* publish through npm trusted publishing only ([5e1e674](https://github.com/sentdm/sent-dm-voice-sdk/commit/5e1e6747ade2fc2a5acf028a9a0dc21d17f59d61))
+
+## [0.1.0](https://github.com/sentdm/sent-dm-voice-sdk/compare/v0.0.1...v0.1.0) (2026-09-29)
+
+
+### Features
+
+* add calls and incoming call invites with connect and joinConference ([d11ab9c](https://github.com/sentdm/sent-dm-voice-sdk/commit/d11ab9c601ee9a051e92fa4dbace964f624c01b4))
+* add provider quality warnings and reconnects, the README and the npm release pipeline ([e304bb3](https://github.com/sentdm/sent-dm-voice-sdk/commit/e304bb357aa363878f266bd68e094853f2776fba))
+* add the audio controller with device selection and deviceChanged ([d1ceda1](https://github.com/sentdm/sent-dm-voice-sdk/commit/d1ceda1dcafc777bcf30f58179b18b51a0753c08))
+* add the provider adapter seam and a scriptable mock adapter ([a06388d](https://github.com/sentdm/sent-dm-voice-sdk/commit/a06388dbd17465346b834818d8f613b57985d65b))
+* add the React provider and hooks with activeCallChanged and invite events ([409fc94](https://github.com/sentdm/sent-dm-voice-sdk/commit/409fc940c747b785e8e8c3436ba37945df8fb8a9))
+* add the SentVoice client with registration and token refresh ([244b73c](https://github.com/sentdm/sent-dm-voice-sdk/commit/244b73cf196bc7898d067679ff7a3a025b8b4bc4))
+* add the Sinch adapter with incoming-call push and call audio ([afe794d](https://github.com/sentdm/sent-dm-voice-sdk/commit/afe794d6ec5c8946b7f32b46a057a2f697d521e4))
+* add the telemetry module with batched usage and call quality reports ([c8c701e](https://github.com/sentdm/sent-dm-voice-sdk/commit/c8c701e6c7fe1e9644fb5596bb5a40847bd1f0de))
+* scaffold @sentdm/voice with the error family and a typed emitter ([54eae6e](https://github.com/sentdm/sent-dm-voice-sdk/commit/54eae6eb8a305688ac74573f3e6a35b00cb929f4))
+
+
+### Bug Fixes
+
+* identity namespace, telemetry logs ([8748cc3](https://github.com/sentdm/sent-dm-voice-sdk/commit/8748cc370ef4a70d8ab6e2b59f82db79f9334aee))
+
+
+### Chores
+
+* publish @sentdm/voice as a public package ([ac84a9b](https://github.com/sentdm/sent-dm-voice-sdk/commit/ac84a9b86b59a864da05ae6b9be3f000abbe055d))
+
+
+### Documentation
+
+* new token route, phone leg cap, telemetry 404 tolerance ([96ff8d9](https://github.com/sentdm/sent-dm-voice-sdk/commit/96ff8d9ff2fe93359dc5d2d0920c5f9e479ab8bb))

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 Sent
+
+   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,284 @@
-# Temporary Holding Version
+# Sent Voice TypeScript SDK
 
-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.
+This library lets a web app place and receive Sent Voice calls in the browser. React bindings ship separately as `@sentdm/voice-client-react`.
+
+Your backend mints a short-lived voice token for each user with the Sent API. The SDK registers the browser with it, then places calls, receives them and reports how they go.
+
+## Installation
+
+```sh
+npm install @sentdm/voice-client
+```
+
+## Quickstart
+
+### 1. Mint voice tokens on your backend
+
+Mint tokens on your server with your Sent API key, never in the browser, for the user who is signed in:
+
+```ts
+export async function createVoiceToken(identity: string): Promise<string> {
+  const response = await fetch('https://api.sent.dm/v3/channels/voice/tokens', {
+    method: 'POST',
+    headers: { 'x-api-key': process.env['SENT_DM_API_KEY'] ?? '', 'Content-Type': 'application/json' },
+    body: JSON.stringify({ identity }),
+  });
+  if (!response.ok) throw new Error(`Minting a voice token failed with status ${response.status}`);
+  const { data } = (await response.json()) as { data: { token: string } };
+  return data.token;
+}
+```
+
+`identity` names the user in calls: letters, digits, `-` and `_`, up to 200 characters. The user is bound to your default voice number unless you pass `number`, one of the numbers you turned voice on for with `POST /v3/channels/voice`, and the token lasts `ttl` seconds (600 by default, at most 3600). Return the token as text from an endpoint of your own, such as `/api/voice-token`.
+
+### 2. Serve the service worker
+
+Incoming calls reach the browser as push messages, through a service worker your app serves. Copy the one this package ships next to your pages, for example:
+
+```sh
+cp node_modules/@sentdm/voice-client/sw.js public/sw.js
+```
+
+The SDK registers `sw.js` relative to the page. If you serve it elsewhere, or your app already has a service worker, give it a path and scope of its own so it does not replace yours:
+
+```ts
+import SentVoice from '@sentdm/voice-client';
+
+const client = new SentVoice({
+  tokenProvider: () => fetch('/api/voice-token').then((response) => response.text()),
+  serviceWorker: { url: '/voice/sw.js', scope: '/voice/' },
+});
+```
+
+### 3. Register and call
+
+```ts
+import SentVoice from '@sentdm/voice-client';
+
+const client = new SentVoice({
+  tokenProvider: () => fetch('/api/voice-token').then((response) => response.text()),
+});
+
+document.querySelector('#call')?.addEventListener('click', async () => {
+  await client.register();
+  const call = await client.connect({ to: '+14155551234' });
+  call.on('connected', () => console.log('Connected'));
+  call.on('disconnected', ({ state }) => console.log(`The call ended as ${state}`));
+});
+```
+
+The first `register()` asks the user to allow notifications, which the browser needs to deliver incoming calls. Firefox and Safari only show that prompt after a user gesture, so call it from a click, as above. It rejects when notifications are blocked or the service worker cannot be registered.
+
+## Token lifecycle
+
+`tokenProvider` is how the SDK gets every token. It must return the `token` that `POST /v3/channels/voice/tokens` responded with, fetched fresh each time, because the SDK calls it again before each token expires.
+
+- `register()` calls it and resolves once the client is `registered`. The client moves from `unregistered` to `registering` to `registered`, emitting each state as an event.
+- A token provider that throws or rejects is retried after a short backoff, 2 more times by default (`registerRetries`); `register()` then rejects with a `NetworkError`. A value that is not a voice token rejects with a `TokenInvalidError` at once.
+- The token is refreshed at 80% of its lifetime, or 30 seconds before it expires if that is earlier, but never before half of its lifetime has passed. `tokenWillExpire` fires first, then `tokenProvider` is called with the same retries. Nothing else changes for your app.
+- If the retries run out, the client emits `error` with the cause and `offline` with a `TokenExpiredError`, then tries again about every 30 seconds until it is `registered` again; calling `register()` tries at once. Calls in progress go on, but `connect()` and `joinConference()` throw a `NotRegisteredError` while the client is offline.
+- `unregister()` stops receiving calls and leaves calls in progress alone. `destroy()` ends every call and tears the client down for good.
+
+Tokens stay in memory and are redacted from log messages.
+
+```ts
+import SentVoice from '@sentdm/voice-client';
+
+const client = new SentVoice({
+  tokenProvider: async () => {
+    const response = await fetch('/api/voice-token');
+    if (!response.ok) throw new Error(`Fetching the voice token failed with status ${response.status}`);
+    return response.text();
+  },
+});
+
+client.on('registered', () => console.log('Ready for calls'));
+client.on('tokenWillExpire', ({ expiresAt }) => console.log('Refreshing, expires', new Date(expiresAt)));
+client.on('offline', (reason) => console.warn(`Offline (${reason.code}), trying again every 30 seconds`));
+```
+
+## Calls
+
+`connect({ to })` calls a phone number in E.164 format, like `'+14155551234'`, or another user of your app by identity, like `'ben'`. `joinConference({ name })` joins one of your account's rooms, named with letters, digits, `-` and `_`, up to 27 characters. Either throws a `SentVoiceError` with code `INVALID_ADDRESS` when `to` or `name` does not fit, and one with code `CALL_IN_PROGRESS` while a call is in progress or an incoming call is still waiting for an answer. Both open the microphone, and reject with a `MediaPermissionError` when the user refuses. `to` says who the user wants to reach; your backend's answer decides what rings.
+
+A leg to a phone number, whether the answer connects the call to a number or a phone participant is added through the API, runs for at most what your account's balance affords at the destination's per-minute rate, capped at four hours by the provider. Legs to app users and rooms have no such limit because they cost nothing. A call that reaches the cap ends as `completed`.
+
+```ts
+import type SentVoice from '@sentdm/voice-client';
+
+export async function callBen(client: SentVoice) {
+  const call = await client.connect({ to: 'ben' });
+
+  call.on('ringing', () => console.log('Ringing'));
+  call.on('connected', () => call.sendDigits('1'));
+  call.on('muteChanged', (isMuted) => console.log(isMuted ? 'Muted' : 'Unmuted'));
+  call.on('disconnected', ({ state, error }) => console.log(`The call ended as ${state}`, error?.code));
+  return call;
+}
+```
+
+A call moves through `initiated`, `ringing`, `answered` and `connected`, and ends as `completed`, `failed`, `busy` or `noAnswer`, which `disconnected` reports. `hangup()` ends it, `mute()` toggles the microphone, `sendDigits()` sends DTMF, and `getStats()` reads its jitter, packet loss and round-trip time. `client.activeCall` is the call placed or answered last, until that call ends, and `activeCallChanged` reports each change. `client.calls` lists every call in progress.
+
+The SDK plays the other party through an audio element it creates. Pass your own with the `audio: { element }` option.
+
+### Receiving calls
+
+```ts
+import type SentVoice from '@sentdm/voice-client';
+
+export function receiveCalls(client: SentVoice) {
+  client.on('incomingCall', (invite) => {
+    console.log('Incoming call from', invite.from);
+    invite.on('cancelled', () => console.log('The caller hung up'));
+
+    document.querySelector('#answer')?.addEventListener(
+      'click',
+      async () => {
+        const call = await invite.accept();
+        call.on('disconnected', ({ state }) => console.log(`The call ended as ${state}`));
+      },
+      { once: true },
+    );
+    document.querySelector('#decline')?.addEventListener('click', () => invite.reject(), { once: true });
+  });
+}
+```
+
+The microphone opens when the call arrives, and `accept()` asks for permission again if that was refused, then resolves with the call. When the user refuses, it rejects with a `MediaPermissionError` and the invite stays pending, so the user can try again. `reject()` declines the call, and `cancelled` fires when the caller hangs up first. A call that arrives while another one is in progress still raises `incomingCall`; your handler decides whether to `accept()` it or `reject()` it. The call accepted last becomes `activeCall`.
+
+### Call quality and reconnection
+
+`qualityWarning` fires when a network metric of a connected call crosses its threshold, and again with `cleared: true` once it recovers. Stats are sampled every half second.
+
+| `metric`     | Raised when                                                               | Cleared when                   |
+| ------------ | ------------------------------------------------------------------------- | ------------------------------ |
+| `jitter`     | incoming audio jitter is above 30 ms in 3 of the last 4 samples           | fewer than 3 of the last 4 are |
+| `packetLoss` | over 1% of the incoming audio packets are lost in 3 of the last 4 samples | fewer than 3 of the last 4 are |
+| `rtt`        | the round-trip time is above 300 ms                                       | it is 300 ms or less again     |
+
+The `rtt` warning follows every sample, so it can go on and off while the round-trip time hovers around 300 ms. A warning still raised when the call ends is not cleared.
+
+```ts
+import type SentVoice from '@sentdm/voice-client';
+
+export function showCallQuality(call: SentVoice.Call) {
+  call.on('qualityWarning', ({ metric, cleared }) => console.log(metric, cleared ? 'recovered' : 'poor'));
+  call.on('reconnecting', () => console.log('Connection lost, reconnecting'));
+  call.on('reconnected', () => console.log('Connection back'));
+}
+```
+
+When the connection drops for 2 seconds, the call goes `reconnecting`, and `reconnected` fires when it comes back on the same network. A call cannot move to a new network: after a network switch its connection does not come back, and a call that has not reconnected within 5 minutes ends as `failed` with a `NetworkError`.
+
+## Handling errors
+
+Every error the SDK throws or emits is a `SentVoiceError` with a stable `code`, a `category` (`auth`, `media`, `signaling`, `network`, `validation` or `capability`) and whether it is `retriable`. Check for the subclasses with `instanceof`:
+
+```ts
+import type SentVoice from '@sentdm/voice-client';
+import { MediaPermissionError, SentVoiceError } from '@sentdm/voice-client/errors';
+
+export async function answer(invite: SentVoice.CallInvite) {
+  try {
+    return await invite.accept();
+  } catch (error) {
+    if (error instanceof MediaPermissionError) console.warn('Allow microphone access to answer calls');
+    else if (error instanceof SentVoiceError) console.error(error.code, error.message);
+    throw error;
+  }
+}
+```
+
+| Error                        | `code`                    | `category`   | When                                                                                                                                                                  |
+| ---------------------------- | ------------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `TokenInvalidError`          | `TOKEN_INVALID`           | `auth`       | `register()`: the token provider returned something that is not a voice token                                                                                         |
+| `TokenExpiredError`          | `TOKEN_EXPIRED`           | `auth`       | the `offline` event: the token could not be refreshed                                                                                                                 |
+| `NotRegisteredError`         | `NOT_REGISTERED`          | `validation` | `connect()` or `joinConference()` while not registered; registering, calling or choosing a device after `destroy()`                                                   |
+| `MediaPermissionError`       | `MEDIA_PERMISSION_DENIED` | `media`      | `connect()`, `joinConference()` or `accept()`: the microphone could not be opened                                                                                     |
+| `CallFailedError`            | `CALL_FAILED`             | `signaling`  | `accept()` on a call that ended before it was answered; a call the provider could not set up, such as to an identity that is not registered, ends as `failed` with it |
+| `CallRejectedError`          | `CALL_REJECTED`           | `signaling`  | not raised yet: a call the other side declines ends as `busy`                                                                                                         |
+| `NetworkError`               | `NETWORK`                 | `network`    | `register()`, when the token provider keeps failing or the calling provider cannot be loaded; a call whose connection failed or was lost                              |
+| `CapabilityUnsupportedError` | `CAPABILITY_UNSUPPORTED`  | `capability` | `setOutputDevice()` where the browser cannot choose the speaker; listing devices over plain HTTP                                                                      |
+| `SentVoiceError`             | `INVALID_ADDRESS`         | `validation` | `connect()` or `joinConference()` with a `to` or `name` that does not fit                                                                                             |
+| `SentVoiceError`             | `CALL_IN_PROGRESS`        | `validation` | `connect()` or `joinConference()` while a call is in progress or an incoming call is waiting for an answer                                                            |
+| `SentVoiceError`             | `UNKNOWN`                 | `signaling`  | anything else, such as `register()` failing because notifications are blocked                                                                                         |
+
+Errors that happen outside a method call arrive as events: the client's `error` when a token refresh fails, and a call's `error`, followed by `disconnected` with `{ state: 'failed', error }`. The underlying provider error is not exposed on the error; the SDK reports it to Sent as telemetry.
+
+## Devices
+
+```ts
+import type SentVoice from '@sentdm/voice-client';
+
+const isHeadset = (device: MediaDeviceInfo) => device.label.includes('Headset');
+
+export async function pickHeadset(client: SentVoice) {
+  const microphone = (await client.audio.inputDevices()).find(isHeadset);
+  if (microphone) await client.audio.setInputDevice(microphone.deviceId);
+  const speaker = (await client.audio.outputDevices()).find(isHeadset);
+  if (speaker) await client.audio.setOutputDevice(speaker.deviceId);
+}
+
+export function followHeadset(client: SentVoice) {
+  client.audio.on('deviceChanged', () => pickHeadset(client).catch(console.error));
+}
+```
+
+- `inputDevices()` and `outputDevices()` list the microphones and speakers. Browsers leave out labels, and may list a single device, until the user has allowed microphone access in the page, which the first call asks for.
+- `setInputDevice()` switches the microphone of the call in progress and of later calls. While the device is missing, the default one is used.
+- `setOutputDevice()` plays calls through a speaker. It throws a `CapabilityUnsupportedError` in browsers that cannot choose the audio output.
+- Both work before `register()`, and take effect when it runs. To start with saved devices, pass `audio: { inputDeviceId, outputDeviceId }`.
+- `deviceChanged` fires when a device is plugged in or out.
+
+## Ringtones
+
+The SDK plays no ringtone or ringback. Play your own on `incomingCall` and when a placed call is `ringing`, and stop it when the call is answered or ends:
+
+```ts
+import type SentVoice from '@sentdm/voice-client';
+
+const ringtone = new Audio('/sounds/ringtone.mp3');
+ringtone.loop = true;
+
+const play = () => ringtone.play().catch(() => {});
+const stop = () => {
+  ringtone.pause();
+  ringtone.currentTime = 0;
+};
+
+export function ringForIncomingCalls(client: SentVoice) {
+  client.on('incomingCall', (invite) => {
+    play();
+    invite.on('accepted', stop).on('rejected', stop).on('cancelled', stop);
+  });
+}
+
+export async function callWithRingback(client: SentVoice, to: string) {
+  const call = await client.connect({ to });
+  call.on('ringing', play).on('connected', stop).on('disconnected', stop);
+  return call;
+}
+```
+
+## React
+
+For React 18 and 19, [`@sentdm/voice-client-react`](https://www.npmjs.com/package/@sentdm/voice-client-react) wraps one client in a provider, with hooks that re-render on its events.
+
+## Telemetry
+
+The SDK reports usage and call quality data to Sent, authenticated with the voice token:
+
+- the SDK version, and the browser, its major version, the operating system, its version and the device type, as read from the user agent (the user agent itself is not sent)
+- how long `register()` took, its attempts and, when it failed, its error; how long `unregister()` took
+- for each call: its id, direction and outcome, how long it took to connect and how long it lasted, and at its end the average round-trip time, jitter and packet loss of samples taken every 10 seconds
+- the errors the client and its calls report: code, category, whether retriable, the message, and the underlying provider error with its name, message, stack and properties
+
+No audio, phone numbers or identities are added by the SDK; the underlying provider error travels as the provider produced it. Batches go to `https://api.sent.dm/v3/voice/telemetry` 3 seconds after the first event queued, so events that happen together share one request, and at once when a call ends, when the page is hidden and when the client is destroyed. A batch that fails, or that Sent refuses (for example with a 429 or a 5xx), is retried once, with the next batch or within 30 seconds, then dropped; telemetry never throws to your app and never delays a call. Turn it off with `telemetry: { disabled: true }`.
+
+## Browser realities
+
+- WebRTC requires a secure context: serve your app over HTTPS, or from `localhost` while developing. Over plain HTTP the browser hides the microphone and service worker APIs, so registering and calling fail. It is the first thing that breaks when you open the app from another device on your network.
+- A page refresh or tab close ends any live call: WebRTC media dies with the page, and there is no resuming a call across reloads.
+- Laptop sleep or a network switch does not unregister the client: incoming calls reach it through the browser's push service, which reconnects by itself, so the client stays `registered`, but calls that arrive while the device sleeps or is offline are missed. If a token refresh falls in that gap, the client goes `offline` and tries again about every 30 seconds until it is `registered` again (state passes `offline → registered`).
+- One `SentVoice` instance per tab. The same identity registered in several tabs/devices creates independent per-device registrations at the provider (documented provider behavior); which devices ring on an incoming call is the provider's delivery semantics — inherited as-is, pinned down empirically during implementation testing. Every device rings, the first to answer takes the call, and the others see their invite cancelled. Tabs of one browser share a registration, so they all ring.
+- Tokens are per-registration; each tab runs its own `tokenProvider` calls.

package/adapter/loader.d.mts

@@ -0,0 +1,3 @@
+import type { AdapterFactory } from "./types.mjs";
+export declare const loadAdapter: AdapterFactory;
+//# sourceMappingURL=loader.d.mts.map

package/adapter/loader.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.d.mts","sourceRoot":"","sources":["../src/adapter/loader.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,oBAAgB;AAE9C,eAAO,MAAM,WAAW,EAAE,cAAiC,CAAC"}

package/adapter/loader.d.ts

@@ -0,0 +1,3 @@
+import type { AdapterFactory } from "./types.js";
+export declare const loadAdapter: AdapterFactory;
+//# sourceMappingURL=loader.d.ts.map

package/adapter/loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../src/adapter/loader.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,mBAAgB;AAE9C,eAAO,MAAM,WAAW,EAAE,cAAiC,CAAC"}

package/adapter/loader.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadAdapter = void 0;
+const sinch_1 = require("./sinch.js");
+exports.loadAdapter = sinch_1.loadSinchAdapter;
+//# sourceMappingURL=loader.js.map

package/adapter/loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.js","sourceRoot":"","sources":["../src/adapter/loader.ts"],"names":[],"mappings":";;;AAAA,sCAA2C;AAG9B,QAAA,WAAW,GAAmB,wBAAgB,CAAC"}

package/adapter/loader.mjs

@@ -0,0 +1,3 @@
+import { loadSinchAdapter } from "./sinch.mjs";
+export const loadAdapter = loadSinchAdapter;
+//# sourceMappingURL=loader.mjs.map

package/adapter/loader.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.mjs","sourceRoot":"","sources":["../src/adapter/loader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,oBAAgB;AAG3C,MAAM,CAAC,MAAM,WAAW,GAAmB,gBAAgB,CAAC"}

package/adapter/sinch.d.mts

@@ -0,0 +1,3 @@
+import type { AdapterFactory } from "./types.mjs";
+export declare const loadSinchAdapter: AdapterFactory;
+//# sourceMappingURL=sinch.d.mts.map

package/adapter/sinch.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sinch.d.mts","sourceRoot":"","sources":["../src/adapter/sinch.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EACV,cAAc,EAMf,oBAAgB;AAmDjB,eAAO,MAAM,gBAAgB,EAAE,cAM5B,CAAC"}

package/adapter/sinch.d.ts

@@ -0,0 +1,3 @@
+import type { AdapterFactory } from "./types.js";
+export declare const loadSinchAdapter: AdapterFactory;
+//# sourceMappingURL=sinch.d.ts.map

package/adapter/sinch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sinch.d.ts","sourceRoot":"","sources":["../src/adapter/sinch.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EACV,cAAc,EAMf,mBAAgB;AAmDjB,eAAO,MAAM,gBAAgB,EAAE,cAM5B,CAAC"}