@voipsdk/react-native-voipcloud 0.2.1

package/src/types.ts

@@ -0,0 +1,144 @@
+/**
+ * Public types for react-native-voipcloud.
+ * Keep these stable across versions — they form the API contract.
+ */
+
+export type Transport = 'UDP' | 'TCP' | 'TLS';
+
+export interface InitConfig {
+    /** STUN server hostname, e.g. "stun.l.google.com:19302". Optional. */
+    stunServer?: string;
+    /** User-Agent header value advertised to the SIP server. */
+    userAgent?: string;
+    /** Default log level 0–6 (PJSIP convention; 4 = info). */
+    logLevel?: number;
+}
+
+export interface AccountConfig {
+    /** AOR — e.g. "sip:alice@example.com". */
+    uri: string;
+    /**
+     * Registrar URI — e.g. "sip:example.com" or
+     * "sip:example.com:5061;transport=tls".  The transport is taken from
+     * the `;transport=` parameter on this URI; if absent, PJSIP defaults
+     * to UDP.
+     */
+    registrar: string;
+    /** Auth username (often the same as the local part of `uri`). */
+    username: string;
+    /** Auth password (will be sent only in challenge response, never logged). */
+    password: string;
+    /**
+     * Hint for the transport you intend to use.  Informational only —
+     * the actual transport is resolved from the `registrar` URI.  Keep
+     * the two in sync to avoid surprises.
+     */
+    transport: Transport;
+}
+
+export interface LicenseStatus {
+    /** True if voipcloud_license_is_valid() returned 1 at call time. */
+    valid: boolean;
+    /** Server-side label: "active" | "trial" | "suspended" | "expired" | "unset". */
+    status: string;
+    /** Customer identifier embedded in the token. */
+    customerId: string;
+    /** Concurrent-call ceiling allowed by the license. */
+    ccu: number;
+    /** Current count of active calls held by the gate. */
+    currentCalls: number;
+    /** Token expiry (unix seconds). 0 if unbounded. */
+    expiry: number;
+    /** Last clock-skew anchor pushed by the refresher (unix seconds). 0 if none yet. */
+    serverTime: number;
+}
+
+export interface RegistrationStateEvent {
+    accountId: number;
+    /** SIP response code (200 = registered, 401/407 = auth, etc.). */
+    code: number;
+    /** Free-form reason string. */
+    reason: string;
+}
+
+export interface IncomingCallEvent {
+    accountId: number;
+    callId: number;
+    /** Remote-party display URI. */
+    from: string;
+    /** Local AOR. */
+    to: string;
+}
+
+export type CallState =
+    | 'NULL'
+    | 'CALLING'
+    | 'INCOMING'
+    | 'EARLY'
+    | 'CONNECTING'
+    | 'CONFIRMED'
+    | 'DISCONNECTED';
+
+export interface CallStateEvent {
+    callId: number;
+    state: CallState;
+    code: number;
+    reason: string;
+}
+
+export interface CallMediaStateEvent {
+    callId: number;
+    hasAudio: boolean;
+    isHold: boolean;
+    isMuted: boolean;
+}
+
+/** Fired right after `hold(callId)` succeeds (re-INVITE sent). */
+export interface CallHoldEvent      { callId: number; }
+/** Fired right after `unhold(callId)` succeeds. */
+export interface CallUnholdEvent    { callId: number; }
+/** Fired right after `mute(callId, isMuted)` succeeds. */
+export interface CallMuteEvent      { callId: number; isMuted: boolean; }
+/** Fired right after `sendDtmf(callId, digits)` succeeds. */
+export interface CallDtmfSentEvent  { callId: number; digits: string; }
+/** Fired right after `transferCall(callId, destinationUri)` sends the REFER. */
+export interface CallTransferEvent  { callId: number; destinationUri: string; }
+
+/**
+ * Multi-stage progress for a transfer we initiated.  Fires once per
+ * NOTIFY received from the remote — final stage has `finalNotify=true`
+ * and a 2xx statusCode (success) or a 4xx-6xx (failure).
+ */
+export interface CallTransferStatusEvent {
+    callId: number;
+    statusCode: number;
+    reason: string;
+    finalNotify: boolean;
+}
+
+/** RFC 2833 DTMF digit detected on the inbound RTP stream. */
+export interface IncomingDtmfEvent {
+    callId: number;
+    digit: string;
+    /** Duration in PJSIP timer ticks (~ ms with default sampling). */
+    duration: number;
+}
+
+export interface EventMap {
+    registrationState: RegistrationStateEvent;
+    incomingCall: IncomingCallEvent;
+    callState: CallStateEvent;
+    callMediaState: CallMediaStateEvent;
+    callHold: CallHoldEvent;
+    callUnhold: CallUnholdEvent;
+    callMute: CallMuteEvent;
+    callDtmfSent: CallDtmfSentEvent;
+    callTransfer: CallTransferEvent;
+    callTransferStatus: CallTransferStatusEvent;
+    incomingDtmf: IncomingDtmfEvent;
+}
+
+/** Subscription handle returned by VoipCloud.on(...). */
+export interface Subscription {
+    remove(): void;
+}