@sentdm/voice-client 0.1.1 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## [0.2.0](https://github.com/sentdm/sent-dm-voice-typescript/compare/voice-client-v0.1.1...voice-client-v0.2.0) (2026-10-23)
+
+
+### ⚠ BREAKING CHANGES
+
+* tokenProvider must return the token from POST /v3/voice/tokens, and telemetry.baseURL is replaced by the top-level baseURL option, which the token exchange also uses.
+* import the React bindings from @sentdm/voice-client-react instead of @sentdm/voice-client/react.
+* install @sentdm/voice-client instead of @sentdm/voice.
+
+### Features
+
+* add the Voice Client contract and its conformance test ([fdd7995](https://github.com/sentdm/sent-dm-voice-typescript/commit/fdd7995eb44c7a5ea93f834d24fe34d5f7a31c29))
+* exchange the opaque voice token for the provider credential ([e0ec6d7](https://github.com/sentdm/sent-dm-voice-typescript/commit/e0ec6d7248b0d9f8861401752a08433967badf4d))
+* extract @sentdm/voice-client-core ([a8cbf69](https://github.com/sentdm/sent-dm-voice-typescript/commit/a8cbf692a9fad8fedb4337df143e5b77f8eba88e))
+* move the React bindings to @sentdm/voice-client-react ([3853f65](https://github.com/sentdm/sent-dm-voice-typescript/commit/3853f6522d31ce9a4c865749d8d39c2b6485adf7))
+* publish as @sentdm/voice-client from a pnpm workspace ([cdd8b0c](https://github.com/sentdm/sent-dm-voice-typescript/commit/cdd8b0cf0bb57549816f9acf99fe4725e10ecf70))
+
+
+### Bug Fixes
+
+* ignore call updates once the call has ended ([e33c825](https://github.com/sentdm/sent-dm-voice-typescript/commit/e33c8258a7ab282292fefafa1954353d175c67ef))
+
+
+### Documentation
+
+* keep the units on CallStats after its move to core ([590df75](https://github.com/sentdm/sent-dm-voice-typescript/commit/590df759d0aa377d84ec875b00fdb768615f536b))
+
+
+### Build System
+
+* bundle sinch-rtc into the voice client ([9db8bbb](https://github.com/sentdm/sent-dm-voice-typescript/commit/9db8bbbc56c307cb08def1c3973fbbfeab68fa47))
+
 ## [0.1.1](https://github.com/sentdm/sent-dm-voice-sdk/compare/v0.1.0...v0.1.1) (2026-09-29)
 
 

package/README.md

@@ -18,7 +18,7 @@ Mint tokens on your server with your Sent API key, never in the browser, for the
 
 ```ts
 export async function createVoiceToken(identity: string): Promise<string> {
-  const response = await fetch('https://api.sent.dm/v3/channels/voice/tokens', {
+  const response = await fetch('https://api.sent.dm/v3/voice/tokens', {
     method: 'POST',
     headers: { 'x-api-key': process.env['SENT_DM_API_KEY'] ?? '', 'Content-Type': 'application/json' },
     body: JSON.stringify({ identity }),
@@ -71,10 +71,10 @@ The first `register()` asks the user to allow notifications, which the browser n
 
 ## 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.
+`tokenProvider` is how the SDK gets every token. It must return the `token` that `POST /v3/voice/tokens` responded with, unchanged and fetched fresh each time, because the SDK calls it again before each token expires. The token is opaque: read the identity, number and expiry from the minting response, not from the token. The SDK exchanges it with Sent for what it registers with, so nothing your backend or app handles belongs to the calling provider.
 
 - `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.
+- A token provider that throws or rejects, or a token exchange that cannot reach Sent or is rate limited, 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, or a token Sent refuses, 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.
@@ -191,13 +191,13 @@ export async function answer(invite: SentVoice.CallInvite) {
 
 | Error                        | `code`                    | `category`   | When                                                                                                                                                                  |
 | ---------------------------- | ------------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `TokenInvalidError`          | `TOKEN_INVALID`           | `auth`       | `register()`: the token provider returned something that is not a voice token                                                                                         |
+| `TokenInvalidError`          | `TOKEN_INVALID`           | `auth`       | `register()`: the token provider returned something that is not a voice token, or a token Sent refuses                                                                |
 | `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                              |
+| `NetworkError`               | `NETWORK`                 | `network`    | `register()`, when the token provider or the token exchange 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                                                            |
@@ -273,7 +273,7 @@ The SDK reports usage and call quality data to Sent, authenticated with the voic
 - 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 }`.
+No audio, phone numbers or identities are added by the SDK; the underlying provider error travels as the provider produced it. Batches go to `/v3/voice/telemetry` under `baseURL` (`https://api.sent.dm` by default) 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
 

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,153 @@
+# Third-party notices
+
+This package bundles the following packages into `adapter/sinch-rtc.js` and `adapter/sinch-rtc.mjs`, each under its own licence. `pubnub`, which they use, is not bundled: it is a dependency of this package.
+
+## crypto-js 4.2.0
+
+Licence: MIT
+
+```
+# License
+
+[The MIT License (MIT)](http://opensource.org/licenses/MIT)
+
+Copyright (c) 2009-2013 Jeff Mott  
+Copyright (c) 2013-2016 Evan Vosberg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+```
+
+## fp-ts 2.16.11
+
+Licence: MIT
+
+```
+MIT License
+
+Copyright (c) 2017-present Giulio Canti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+
+## pako 2.2.0
+
+Licence: (MIT AND Zlib)
+
+```
+(The MIT License)
+
+Copyright (C) 2014-2017 by Vitaly Puzrin and Andrei Tuputcyn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+```
+
+## sdp-transform 2.15.0
+
+Licence: MIT
+
+```
+(The MIT License)
+
+Copyright (c) 2013 Eirik Albrigtsen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```
+
+## sinch-rtc 2.49.11
+
+Licence: ISC
+
+The package ships no licence file.
+
+## ulid 2.4.0
+
+Licence: MIT
+
+```
+The MIT License (MIT)
+
+Copyright (c) 2017 Alizain Feerasta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```