farvex 1.0.0 → 2.0.0

package/dist/{types-DhJEeeui.d.ts → types-BjVaSMZ6.d.ts}

@@ -8,6 +8,10 @@ declare class CallpadError extends Error {
     constructor(code: string, message: string, status?: number | undefined);
 }
 
+/**
+ * Canonical E.164 phone number with a leading plus.
+ */
+type E164Phone = string;
 type RealtimeToken = {
     url: string;
     token: string;
@@ -31,7 +35,7 @@ type VoiceParticipant = {
     userId: number | null;
     agentId: string | null;
     contactId: string | null;
-    phone: string | null;
+    phone: E164Phone | null;
     firstName: string | null;
     lastName: string | null;
     profilePhoto: string | null;
@@ -106,6 +110,55 @@ type SessionDuration = {
     endedAt: Nullable<string>;
     running: boolean;
 };
+type SessionPhase = "incoming" | "outgoing" | "connecting" | "active" | "ending" | "ended" | "failed";
+type SessionDirection = "inbound" | "outbound";
+type CurrentSession = {
+    phase: SessionPhase;
+    direction: SessionDirection;
+    sessionId: string;
+    participantId: Nullable<string>;
+    session: Nullable<VoiceSession>;
+    join: Nullable<VoiceJoinGrant>;
+    startedBy: "start" | "accept" | "join";
+    error: Nullable<CallpadError>;
+    createdAt: string;
+    answeredAt: Nullable<string>;
+    endedAt: Nullable<string>;
+};
+type CurrentSessionSnapshot = {
+    current: Nullable<CurrentSession>;
+    incoming: readonly SessionInvite[];
+    busy: boolean;
+};
+type SessionStartBehavior = "rejectWhileBusy" | "focusExisting" | "allowParallel";
+type SessionMediaRequirement = "required" | "optional";
+type SessionStartOptions = {
+    behavior?: SessionStartBehavior;
+    media?: SessionMediaRequirement;
+};
+type SessionAcceptOptions = {
+    replaceCurrent?: boolean;
+    media?: SessionMediaRequirement;
+};
+type SessionJoinOptions = {
+    replaceCurrent?: boolean;
+};
+type SessionSyncMode = "merge" | "replaceVisible";
+type SessionSyncOptions = {
+    mode?: SessionSyncMode;
+};
+type SessionControls<TStartInput> = {
+    get: () => CurrentSessionSnapshot;
+    start: (input: TStartInput, options?: SessionStartOptions) => Promise<CurrentSession>;
+    accept: (input: ParticipantRef, options?: SessionAcceptOptions) => Promise<CurrentSession>;
+    join: (sessionId: string, options?: SessionJoinOptions) => Promise<CurrentSession>;
+    end: () => Promise<void>;
+    clear: () => void;
+    mediaConnected: (sessionId?: string) => void;
+    mediaDisconnected: (sessionId?: string) => void;
+    mediaFailed: (error: Error, sessionId?: string) => void;
+    subscribe: (fn: () => void) => Unsubscribe;
+};
 type ClientEvents = {
     status: ClientStatus;
     "session.added": VoiceSession;
@@ -115,6 +168,14 @@ type ClientEvents = {
         vendor?: string;
         version?: number;
     };
+    "session.current.changed": CurrentSessionSnapshot;
+    "session.current.started": CurrentSession;
+    "session.current.connected": CurrentSession;
+    "session.current.ended": CurrentSession;
+    "session.current.failed": {
+        session: Nullable<CurrentSession>;
+        error: CallpadError;
+    };
     error: Error;
 };
 type SessionClientConfig = {
@@ -166,8 +227,8 @@ type Invites = {
 };
 type Sessions = {
     list: () => readonly VoiceSession[];
-    get: (sessionId?: string) => Nullable<VoiceSession>;
-    sync: (query?: ListQuery) => Promise<readonly VoiceSession[]>;
+    get: (sessionId: string) => Nullable<VoiceSession>;
+    sync: (query?: ListQuery, options?: SessionSyncOptions) => Promise<readonly VoiceSession[]>;
     start: (input: CustomerStartInput) => Promise<StartedSession>;
     join: (sessionId: string) => Promise<VoiceJoinGrant>;
     accept: (input: ParticipantRef) => Promise<StartedSession>;
@@ -190,17 +251,19 @@ type SessionClient = {
     readonly status: ClientStatus;
     readonly sessions: Sessions;
     readonly invites: Invites;
+    readonly session: SessionControls<CustomerStartInput>;
     connect: () => Promise<void>;
     disconnect: () => Promise<void>;
     dispose: () => Promise<void>;
     on: <K extends keyof ClientEvents>(event: K, fn: (payload: ClientEvents[K]) => void) => Unsubscribe;
     subscribe: (topic: StoreTopic, fn: () => void) => Unsubscribe;
 };
-type HostClient = Omit<SessionClient, "kind" | "sessions"> & {
+type HostClient = Omit<SessionClient, "kind" | "sessions" | "session"> & {
     readonly kind: "host";
     readonly vendor: string;
     readonly sessions: HostSessions;
+    readonly session: SessionControls<HostStartInput>;
     readonly host: HostControls;
 };
 
-export { CallpadError as C, type HostClient as H, type Invites as I, type ListQuery as L, type Nullable as N, type ParticipantRef as P, type RealtimeToken as R, type SessionAction as S, type Unsubscribe as U, type VoiceJoinGrant as V, type ClientEvents as a, type ClientStatus as b, type CustomerStartInput as c, type HostClientConfig as d, type HostControls as e, type HostParticipantInput as f, type HostSessions as g, type ListSessionsResponse as h, type SessionClient as i, type SessionClientConfig as j, type SessionDuration as k, type SessionInvite as l, type SessionRecording as m, type SessionRecordingControl as n, type Sessions as o, type StartedSession as p, type StoreTopic as q, type VoiceParticipant as r, type VoiceSession as s };
+export { type SessionSyncOptions as A, type Sessions as B, CallpadError as C, type StartedSession as D, type StoreTopic as E, type VoiceParticipant as F, type VoiceSession as G, type HostClient as H, type Invites as I, type ListQuery as L, type Nullable as N, type ParticipantRef as P, type RealtimeToken as R, type SessionAcceptOptions as S, type Unsubscribe as U, type VoiceJoinGrant as V, type ClientEvents as a, type ClientStatus as b, type CurrentSession as c, type CurrentSessionSnapshot as d, type CustomerStartInput as e, type HostClientConfig as f, type HostControls as g, type HostParticipantInput as h, type HostSessions as i, type HostStartInput as j, type ListSessionsResponse as k, type SessionAction as l, type SessionClient as m, type SessionClientConfig as n, type SessionControls as o, type SessionDirection as p, type SessionDuration as q, type SessionInvite as r, type SessionJoinOptions as s, type SessionMediaRequirement as t, type SessionPhase as u, type SessionRecording as v, type SessionRecordingControl as w, type SessionStartBehavior as x, type SessionStartOptions as y, type SessionSyncMode as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "farvex",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Web SDK for Callpad voice sessions",
   "keywords": [
     "callpad",
@@ -69,7 +69,8 @@
     "prepublishOnly": "bun run check && bun run build"
   },
   "dependencies": {
-    "centrifuge": "5.6.0"
+    "centrifuge": "5.6.0",
+    "libphonenumber-js": "^1.13.6"
   },
   "devDependencies": {
     "@changesets/cli": "^2.27.0",