@coventia/softphone 0.2.0 → 0.3.0

package/dist/ui/index.d.cts

@@ -1,7 +1,7 @@
 import * as react from 'react';
 import { ReactNode } from 'react';
-import { g as Contact, u as ContactsSource, v as HistorySource, a as Call } from '../call-DUVnDxsz.cjs';
-export { y as CallHistoryEntry, z as ContactsPage } from '../call-DUVnDxsz.cjs';
+import { g as Contact, x as ContactsSource, y as HistorySource, a as Call, k as RingtoneOption } from '../call-CaPDWVk3.cjs';
+export { D as CallHistoryEntry, G as ContactsPage } from '../call-CaPDWVk3.cjs';
 
 /**
  * Shaped like a Lucide icon (`size`, `className`, both optional — every SVG prop Lucide's own icons
@@ -75,8 +75,9 @@ interface SoftphoneWidgetProps {
      */
     readonly requireMic?: boolean;
     /**
-     * Play call audio: the remote party, the inbound ring, the outbound ringback, and a short cue when
-     * a connected call ends — by either side. **On by default.**
+     * Play call audio: the remote party, the inbound ring, the outbound ringback, a short cue when a
+     * connected call ends — by either side — and a key tone for each keypad press (the dialer, and the
+     * in-call keypad that sends DTMF). **On by default.**
      *
      * The remote-party half is not a nicety — nothing else attaches the `MediaStream`, so with this
      * off a connected call is silent in both directions. Turn it off only if the host attaches
@@ -149,13 +150,23 @@ interface DialpadProps {
     } | null;
     /** Called on any action that supersedes that outcome: a digit, a backspace, a dial. */
     readonly onIntent?: () => void;
+    /**
+     * Play a key tone when a digit is pressed. **On by default**; `SoftphoneWidget` passes its own
+     * `sounds` flag, so a host that silences the widget silences this too.
+     */
+    readonly keyTones?: boolean;
 }
-declare function Dialpad({ outcome, onIntent }?: DialpadProps): react.JSX.Element;
+declare function Dialpad({ outcome, onIntent, keyTones }?: DialpadProps): react.JSX.Element;
 
 /** The active-call view: incoming, outgoing and in-call in one, switched on call.state. */
-declare function CallScreen({ call, incomingCallAction, }: Readonly<{
+declare function CallScreen({ call, incomingCallAction, keyTones, }: Readonly<{
     call: Call;
     incomingCallAction?: ContactAction;
+    /**
+     * Play a tone for each keypad press. **On by default**; `SoftphoneWidget` passes its own `sounds`
+     * flag, so a host that silences the widget silences this too.
+     */
+    keyTones?: boolean;
 }>): react.JSX.Element | null;
 
 /**
@@ -185,4 +196,26 @@ declare function HistoryTab({ source }: Readonly<{
     source: HistorySource;
 }>): react.JSX.Element;
 
-export { CallScreen, ContactsSource, ContactsTab, Dialpad, HistorySource, HistoryTab, MicPermissionGate, type SoftphoneTheme, SoftphoneWidget, type SoftphoneWidgetProps };
+/** A running preview. */
+interface RingtonePreview {
+    /** Stops it now. Safe to call more than once, and after it ended. */
+    stop(): void;
+    /**
+     * Settles once the preview is over — played to its end, or `stop()` called. Rejects only when the file
+     * could not be downloaded or decoded (a `stop()` before that resolves it instead).
+     */
+    readonly done: Promise<void>;
+}
+/**
+ * Plays one ringtone briefly, the way the softphone's Ajustes does — same sound, level, loop points and
+ * length. For a host's own ringtone picker where no softphone is involved, such as an organization-default
+ * setting (custom-ringtone.md §4.7): the built-in "Clásico" (`url: null`) is generated in code, so there is
+ * no file such a page could play by itself.
+ *
+ * Call it from a user gesture (a click): that is when a browser lets audio start.
+ */
+declare function previewRingtone(ringtone: Pick<RingtoneOption, 'url'> & Partial<Pick<RingtoneOption, 'loop'>>, options?: {
+    readonly sinkId?: string | null;
+}): RingtonePreview;
+
+export { CallScreen, ContactsSource, ContactsTab, Dialpad, HistorySource, HistoryTab, MicPermissionGate, type RingtonePreview, type SoftphoneTheme, SoftphoneWidget, type SoftphoneWidgetProps, previewRingtone };

package/dist/ui/index.d.ts

@@ -1,7 +1,7 @@
 import * as react from 'react';
 import { ReactNode } from 'react';
-import { g as Contact, u as ContactsSource, v as HistorySource, a as Call } from '../call-DUVnDxsz.js';
-export { y as CallHistoryEntry, z as ContactsPage } from '../call-DUVnDxsz.js';
+import { g as Contact, x as ContactsSource, y as HistorySource, a as Call, k as RingtoneOption } from '../call-CaPDWVk3.js';
+export { D as CallHistoryEntry, G as ContactsPage } from '../call-CaPDWVk3.js';
 
 /**
  * Shaped like a Lucide icon (`size`, `className`, both optional — every SVG prop Lucide's own icons
@@ -75,8 +75,9 @@ interface SoftphoneWidgetProps {
      */
     readonly requireMic?: boolean;
     /**
-     * Play call audio: the remote party, the inbound ring, the outbound ringback, and a short cue when
-     * a connected call ends — by either side. **On by default.**
+     * Play call audio: the remote party, the inbound ring, the outbound ringback, a short cue when a
+     * connected call ends — by either side — and a key tone for each keypad press (the dialer, and the
+     * in-call keypad that sends DTMF). **On by default.**
      *
      * The remote-party half is not a nicety — nothing else attaches the `MediaStream`, so with this
      * off a connected call is silent in both directions. Turn it off only if the host attaches
@@ -149,13 +150,23 @@ interface DialpadProps {
     } | null;
     /** Called on any action that supersedes that outcome: a digit, a backspace, a dial. */
     readonly onIntent?: () => void;
+    /**
+     * Play a key tone when a digit is pressed. **On by default**; `SoftphoneWidget` passes its own
+     * `sounds` flag, so a host that silences the widget silences this too.
+     */
+    readonly keyTones?: boolean;
 }
-declare function Dialpad({ outcome, onIntent }?: DialpadProps): react.JSX.Element;
+declare function Dialpad({ outcome, onIntent, keyTones }?: DialpadProps): react.JSX.Element;
 
 /** The active-call view: incoming, outgoing and in-call in one, switched on call.state. */
-declare function CallScreen({ call, incomingCallAction, }: Readonly<{
+declare function CallScreen({ call, incomingCallAction, keyTones, }: Readonly<{
     call: Call;
     incomingCallAction?: ContactAction;
+    /**
+     * Play a tone for each keypad press. **On by default**; `SoftphoneWidget` passes its own `sounds`
+     * flag, so a host that silences the widget silences this too.
+     */
+    keyTones?: boolean;
 }>): react.JSX.Element | null;
 
 /**
@@ -185,4 +196,26 @@ declare function HistoryTab({ source }: Readonly<{
     source: HistorySource;
 }>): react.JSX.Element;
 
-export { CallScreen, ContactsSource, ContactsTab, Dialpad, HistorySource, HistoryTab, MicPermissionGate, type SoftphoneTheme, SoftphoneWidget, type SoftphoneWidgetProps };
+/** A running preview. */
+interface RingtonePreview {
+    /** Stops it now. Safe to call more than once, and after it ended. */
+    stop(): void;
+    /**
+     * Settles once the preview is over — played to its end, or `stop()` called. Rejects only when the file
+     * could not be downloaded or decoded (a `stop()` before that resolves it instead).
+     */
+    readonly done: Promise<void>;
+}
+/**
+ * Plays one ringtone briefly, the way the softphone's Ajustes does — same sound, level, loop points and
+ * length. For a host's own ringtone picker where no softphone is involved, such as an organization-default
+ * setting (custom-ringtone.md §4.7): the built-in "Clásico" (`url: null`) is generated in code, so there is
+ * no file such a page could play by itself.
+ *
+ * Call it from a user gesture (a click): that is when a browser lets audio start.
+ */
+declare function previewRingtone(ringtone: Pick<RingtoneOption, 'url'> & Partial<Pick<RingtoneOption, 'loop'>>, options?: {
+    readonly sinkId?: string | null;
+}): RingtonePreview;
+
+export { CallScreen, ContactsSource, ContactsTab, Dialpad, HistorySource, HistoryTab, MicPermissionGate, type RingtonePreview, type SoftphoneTheme, SoftphoneWidget, type SoftphoneWidgetProps, previewRingtone };