@coventia/softphone 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,62 @@
+import { S as Softphone } from './softphone-DhuhcKCy.cjs';
+export { A as AudioDevices } from './softphone-DhuhcKCy.cjs';
+import { S as SoftphoneConfig } from './call-BTYlT2SU.cjs';
+export { C as CALL_TRANSITIONS, a as Call, b as CallDirection, c as CallEvent, d as CallEventMap, e as CallOptions, f as CallState, g as Contact, E as ERROR_CATALOGUE, F as FatalErrorCode, h as FatalSoftphoneError, H as HangupReason, i as HoldOriginator, I as INITIAL_STATES, L as LogLevel, N as NonFatalErrorCode, j as NonFatalSoftphoneError, R as RemoteParty, k as SoftphoneError, l as SoftphoneErrorCode, m as SoftphoneEvent, n as SoftphoneEventMap, o as SoftphoneState, T as TokenEndpointOptions, p as TokenSource, q as TypedEmitter, V as VoiceToken, r as canTransition, s as isFatal, t as isTerminal } from './call-BTYlT2SU.cjs';
+
+/**
+ * Construct a softphone.
+ *
+ * A factory, not `new Softphone()`, for two reasons: it resolves the underlying call engine from
+ * config without exposing that machinery, and it returns the `Softphone` INTERFACE, so the concrete
+ * class stays an implementation detail free to change without a major version.
+ *
+ * @example
+ *   const phone = createSoftphone({
+ *     tokenSource: TokenSource.endpoint('/voice/token'),
+ *     resolveContact: (n) => api.lookup(n),
+ *   });
+ *   await phone.start();               // from a user gesture — see Softphone.start()
+ */
+declare function createSoftphone(config: SoftphoneConfig): Softphone;
+
+/**
+ * Browser-capability probes.
+ *
+ * SPEC §10.2: nothing under core/ or transports/ may touch `window`, `document` or `navigator` at
+ * MODULE SCOPE. Importing the package must be safe on a server — a Next.js consumer renders on the
+ * server first, and a bare `ReferenceError: window is not defined` at import time makes us unusable
+ * there no matter how framework-agnostic the runtime API is.
+ *
+ * Every probe below is therefore a FUNCTION, evaluated lazily at call time.
+ */
+/** True when running in a browser with a DOM. False under SSR, in Node, and in a worker. */
+declare function isBrowser(): boolean;
+/**
+ * True when the browser exposes the WebRTC APIs the softphone needs.
+ *
+ * Worth a distinct check rather than folding into isBrowser(): privacy extensions
+ * (uBlock Origin Extra, WebRTC Leak Prevent) disable RTCPeerConnection outright, and the resulting
+ * failure is otherwise reported as a confusing SIP error deep in a call attempt.
+ */
+declare function isWebRtcSupported(): boolean;
+
+/**
+ * @coventia/softphone — the framework-free engine.
+ *
+ * Importable from vanilla JS, Vue, Svelte, a PHP-rendered page, and a Node/SSR process. Exports NO
+ * React and touches NO browser global at module scope (SPEC §10.1, §10.2). Those two rules — not the
+ * authoring language, not the package layout — are what make this usable anywhere.
+ *
+ * THIS FILE IS THE PUBLIC API. Anything not exported here is free to change without a major version;
+ * anything exported here is not. Adding to it is cheap and removing from it is expensive, so add
+ * deliberately.
+ *
+ * Notably NOT exported, and deliberately:
+ *   - `SipProvider` and everything under transports/ — the provider seam is internal (SPEC §5.4).
+ *     Exporting it would freeze the shape of a Zadarma migration we have not designed yet.
+ *   - `MockProvider` — lives at @coventia/softphone/testing, so it never lands in a production bundle.
+ */
+
+declare const VERSION = "0.0.0";
+
+export { Softphone, SoftphoneConfig, VERSION, createSoftphone, isBrowser, isWebRtcSupported };

package/dist/index.d.ts

@@ -0,0 +1,62 @@
+import { S as Softphone } from './softphone-DHmhotbf.js';
+export { A as AudioDevices } from './softphone-DHmhotbf.js';
+import { S as SoftphoneConfig } from './call-BTYlT2SU.js';
+export { C as CALL_TRANSITIONS, a as Call, b as CallDirection, c as CallEvent, d as CallEventMap, e as CallOptions, f as CallState, g as Contact, E as ERROR_CATALOGUE, F as FatalErrorCode, h as FatalSoftphoneError, H as HangupReason, i as HoldOriginator, I as INITIAL_STATES, L as LogLevel, N as NonFatalErrorCode, j as NonFatalSoftphoneError, R as RemoteParty, k as SoftphoneError, l as SoftphoneErrorCode, m as SoftphoneEvent, n as SoftphoneEventMap, o as SoftphoneState, T as TokenEndpointOptions, p as TokenSource, q as TypedEmitter, V as VoiceToken, r as canTransition, s as isFatal, t as isTerminal } from './call-BTYlT2SU.js';
+
+/**
+ * Construct a softphone.
+ *
+ * A factory, not `new Softphone()`, for two reasons: it resolves the underlying call engine from
+ * config without exposing that machinery, and it returns the `Softphone` INTERFACE, so the concrete
+ * class stays an implementation detail free to change without a major version.
+ *
+ * @example
+ *   const phone = createSoftphone({
+ *     tokenSource: TokenSource.endpoint('/voice/token'),
+ *     resolveContact: (n) => api.lookup(n),
+ *   });
+ *   await phone.start();               // from a user gesture — see Softphone.start()
+ */
+declare function createSoftphone(config: SoftphoneConfig): Softphone;
+
+/**
+ * Browser-capability probes.
+ *
+ * SPEC §10.2: nothing under core/ or transports/ may touch `window`, `document` or `navigator` at
+ * MODULE SCOPE. Importing the package must be safe on a server — a Next.js consumer renders on the
+ * server first, and a bare `ReferenceError: window is not defined` at import time makes us unusable
+ * there no matter how framework-agnostic the runtime API is.
+ *
+ * Every probe below is therefore a FUNCTION, evaluated lazily at call time.
+ */
+/** True when running in a browser with a DOM. False under SSR, in Node, and in a worker. */
+declare function isBrowser(): boolean;
+/**
+ * True when the browser exposes the WebRTC APIs the softphone needs.
+ *
+ * Worth a distinct check rather than folding into isBrowser(): privacy extensions
+ * (uBlock Origin Extra, WebRTC Leak Prevent) disable RTCPeerConnection outright, and the resulting
+ * failure is otherwise reported as a confusing SIP error deep in a call attempt.
+ */
+declare function isWebRtcSupported(): boolean;
+
+/**
+ * @coventia/softphone — the framework-free engine.
+ *
+ * Importable from vanilla JS, Vue, Svelte, a PHP-rendered page, and a Node/SSR process. Exports NO
+ * React and touches NO browser global at module scope (SPEC §10.1, §10.2). Those two rules — not the
+ * authoring language, not the package layout — are what make this usable anywhere.
+ *
+ * THIS FILE IS THE PUBLIC API. Anything not exported here is free to change without a major version;
+ * anything exported here is not. Adding to it is cheap and removing from it is expensive, so add
+ * deliberately.
+ *
+ * Notably NOT exported, and deliberately:
+ *   - `SipProvider` and everything under transports/ — the provider seam is internal (SPEC §5.4).
+ *     Exporting it would freeze the shape of a Zadarma migration we have not designed yet.
+ *   - `MockProvider` — lives at @coventia/softphone/testing, so it never lands in a production bundle.
+ */
+
+declare const VERSION = "0.0.0";
+
+export { Softphone, SoftphoneConfig, VERSION, createSoftphone, isBrowser, isWebRtcSupported };