@dialstack/sdk-react 3.10.0 → 3.11.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.
@@ -63,8 +63,10 @@ interface UseCallActions extends CallActions {
63
63
  * Blind-transfer the active call to `destination`. Returns `true` when the
64
64
  * transfer was *initiated* (so the UI can close its transfer overlay), `false`
65
65
  * on empty input or a synchronous failure routed to `onError`. `true` means
66
- * initiated, not confirmed — the core call is fire-and-forget, so the outcome
67
- * arrives later as the call ending ('transferred') or an `onError`.
66
+ * initiated, not confirmed: once the far end accepts, the call ends
67
+ * ('transferred') as on a deskphone, so a target that is then busy or doesn't
68
+ * answer is not reported. A refusal arrives as a `transfer_failed` `onError`
69
+ * and leaves the call up.
68
70
  */
69
71
  transfer: (destination: string) => boolean;
70
72
  /**
@@ -383,19 +385,19 @@ interface UseDialInput {
383
385
  declare function useDialInput(setValue: (value: string) => void): UseDialInput;
384
386
 
385
387
  /**
386
- * Shared design tokens for the DialStack Softphone.
388
+ * The design tokens shared by every call UI: the softphone and the components
389
+ * that show and control calls.
387
390
  *
388
- * This module is intentionally framework-agnostic (no DOM, no React Native) so
389
- * that BOTH the web Softphone (Web Component, consumes these as CSS values) and the
390
- * React Native Softphone (consumes these in a StyleSheet) render from a single
391
- * source of truth — that is what makes the two look identical by default.
391
+ * Framework-agnostic (no DOM, no React Native), so the web UIs consume these as
392
+ * CSS values and the React Native ones in a StyleSheet, and the two look the
393
+ * same by default.
392
394
  *
393
395
  * Colors resolve from the same `AppearanceOptions` surface the rest of the SDK
394
396
  * uses (theme + variables), so theming through `DialstackComponentsProvider` /
395
397
  * the `appearance` prop flows through identically on both platforms.
396
398
  */
397
399
 
398
- interface SoftphonePalette {
400
+ interface CallPalette {
399
401
  background: string;
400
402
  surface: string;
401
403
  surfaceActive: string;
@@ -484,7 +486,7 @@ interface SoftphoneContextBase {
484
486
  t: (key: keyof Locale$1['softphone']) => string;
485
487
  displayNumber: (value: string) => string;
486
488
  /** Resolved theme palette — computed on both platforms so mobile themes like web. */
487
- palette: SoftphonePalette;
489
+ palette: CallPalette;
488
490
  /**
489
491
  * The host's {@link PeerInfo} for a call, from `resolvePeer`, or null while it
490
492
  * resolves, when the host has none, or when no resolver is set. The built-in
@@ -63,8 +63,10 @@ interface UseCallActions extends CallActions {
63
63
  * Blind-transfer the active call to `destination`. Returns `true` when the
64
64
  * transfer was *initiated* (so the UI can close its transfer overlay), `false`
65
65
  * on empty input or a synchronous failure routed to `onError`. `true` means
66
- * initiated, not confirmed — the core call is fire-and-forget, so the outcome
67
- * arrives later as the call ending ('transferred') or an `onError`.
66
+ * initiated, not confirmed: once the far end accepts, the call ends
67
+ * ('transferred') as on a deskphone, so a target that is then busy or doesn't
68
+ * answer is not reported. A refusal arrives as a `transfer_failed` `onError`
69
+ * and leaves the call up.
68
70
  */
69
71
  transfer: (destination: string) => boolean;
70
72
  /**
@@ -383,19 +385,19 @@ interface UseDialInput {
383
385
  declare function useDialInput(setValue: (value: string) => void): UseDialInput;
384
386
 
385
387
  /**
386
- * Shared design tokens for the DialStack Softphone.
388
+ * The design tokens shared by every call UI: the softphone and the components
389
+ * that show and control calls.
387
390
  *
388
- * This module is intentionally framework-agnostic (no DOM, no React Native) so
389
- * that BOTH the web Softphone (Web Component, consumes these as CSS values) and the
390
- * React Native Softphone (consumes these in a StyleSheet) render from a single
391
- * source of truth — that is what makes the two look identical by default.
391
+ * Framework-agnostic (no DOM, no React Native), so the web UIs consume these as
392
+ * CSS values and the React Native ones in a StyleSheet, and the two look the
393
+ * same by default.
392
394
  *
393
395
  * Colors resolve from the same `AppearanceOptions` surface the rest of the SDK
394
396
  * uses (theme + variables), so theming through `DialstackComponentsProvider` /
395
397
  * the `appearance` prop flows through identically on both platforms.
396
398
  */
397
399
 
398
- interface SoftphonePalette {
400
+ interface CallPalette {
399
401
  background: string;
400
402
  surface: string;
401
403
  surfaceActive: string;
@@ -484,7 +486,7 @@ interface SoftphoneContextBase {
484
486
  t: (key: keyof Locale$1['softphone']) => string;
485
487
  displayNumber: (value: string) => string;
486
488
  /** Resolved theme palette — computed on both platforms so mobile themes like web. */
487
- palette: SoftphonePalette;
489
+ palette: CallPalette;
488
490
  /**
489
491
  * The host's {@link PeerInfo} for a call, from `resolvePeer`, or null while it
490
492
  * resolves, when the host has none, or when no resolver is set. The built-in