farvex 0.2.0 → 1.0.1

package/dist/types-Dgwrb3rf.d.cts

@@ -0,0 +1,206 @@
+type Auth = {
+    getAccessToken: () => string | Promise<string>;
+    onUnauthorized?: () => void | Promise<void>;
+};
+declare class CallpadError extends Error {
+    readonly code: string;
+    readonly status?: number | undefined;
+    constructor(code: string, message: string, status?: number | undefined);
+}
+
+type RealtimeToken = {
+    url: string;
+    token: string;
+    channel: string;
+    expiresAt: string;
+};
+type VoiceDirection = 'inbound' | 'outbound';
+type VoiceSessionState = 'ringing' | 'active' | 'ended';
+type VoiceEndReason = 'completed' | 'declined' | 'closed' | 'no_route';
+type VoiceParticipantKind = 'agent' | 'vendor_user' | 'customer' | 'contact' | 'phone';
+type VoiceParticipantRole = 'host' | 'participant';
+type VoiceTransport = 'webrtc' | 'sip';
+type VoiceParticipantState = 'invited' | 'accepted' | 'joined' | 'left' | 'rejected' | 'removed';
+type VoiceParticipant = {
+    id: string;
+    kind: VoiceParticipantKind;
+    role: VoiceParticipantRole;
+    transport: VoiceTransport;
+    state: VoiceParticipantState;
+    identity: string;
+    userId: number | null;
+    agentId: string | null;
+    contactId: string | null;
+    phone: string | null;
+    firstName: string | null;
+    lastName: string | null;
+    profilePhoto: string | null;
+    inviteExpiresAt: string | null;
+    acceptedAt: string | null;
+    joinedAt: string | null;
+    leftAt: string | null;
+};
+type VoiceSession = {
+    id: string;
+    vendor: string;
+    version: number;
+    direction: VoiceDirection;
+    state: VoiceSessionState;
+    createdAt: string;
+    answeredAt: string | null;
+    endedAt: string | null;
+    endReason: VoiceEndReason | null;
+    recording: SessionRecording;
+    participants: Array<VoiceParticipant>;
+};
+type SessionRecordingStatus = 'off' | 'starting' | 'recording' | 'stopping';
+type SessionRecording = {
+    status: SessionRecordingStatus;
+    startedAt: string | null;
+};
+type SessionRecordingControl = {
+    sessionId: string;
+    sessionVersion: number;
+    recording: SessionRecording;
+};
+type VoiceJoinGrant = {
+    url: string;
+    roomName: string;
+    token: string;
+    participantIdentity: string;
+    participantId: string;
+    expiresAt: string;
+};
+type StartedSession = {
+    session: VoiceSession;
+    join: VoiceJoinGrant | null;
+};
+type ListSessionsResponse = {
+    items: Array<VoiceSession>;
+};
+type ListSessionsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        vendor?: string;
+        state?: 'active' | 'ended' | 'all';
+        before?: string;
+        limit?: number;
+    };
+    url: '/api/v1/sessions';
+};
+
+type Nullable<T> = T | null;
+
+type ClientStatus = "idle" | "connecting" | "ready" | "reconnecting" | "offline" | "disposed";
+type SessionAction = "accept" | "reject" | "join" | "leave" | "end" | "addParticipant" | "removeParticipant" | "startRecording" | "stopRecording";
+type Unsubscribe = () => void;
+type StoreTopic = "status" | "sessions" | "invites" | `session:${string}`;
+type SessionInvite = {
+    session: VoiceSession;
+    participant: VoiceParticipant;
+};
+type SessionDuration = {
+    seconds: number;
+    startedAt: Nullable<string>;
+    endedAt: Nullable<string>;
+    running: boolean;
+};
+type ClientEvents = {
+    status: ClientStatus;
+    "session.added": VoiceSession;
+    "session.updated": VoiceSession;
+    "session.removed": {
+        sessionId: string;
+        vendor?: string;
+        version?: number;
+    };
+    error: Error;
+};
+type SessionClientConfig = {
+    apiUrl: string;
+    userId: number;
+    auth: Auth;
+    fetch?: typeof fetch;
+};
+type HostClientConfig = SessionClientConfig & {
+    vendor: string;
+};
+type ListQuery = NonNullable<ListSessionsData["query"]>;
+type CustomerStartInput = {
+    vendor: string;
+    target: {
+        type: "vendor_user";
+        userId: number;
+    };
+};
+type HostStartInput = {
+    target: {
+        type: "customer";
+        userId: number;
+    } | {
+        type: "contact";
+        contactId: string;
+    } | {
+        type: "phone";
+        phone: string;
+    };
+};
+type ParticipantRef = {
+    sessionId: string;
+    participantId: string;
+};
+type HostParticipantInput = {
+    sessionId: string;
+    target: {
+        type: "contact";
+        contactId: string;
+    } | {
+        type: "phone";
+        phone: string;
+    };
+};
+type Invites = {
+    list: () => readonly SessionInvite[];
+    get: (sessionId: string) => Nullable<SessionInvite>;
+};
+type Sessions = {
+    list: () => readonly VoiceSession[];
+    get: (sessionId?: string) => Nullable<VoiceSession>;
+    sync: (query?: ListQuery) => Promise<readonly VoiceSession[]>;
+    start: (input: CustomerStartInput) => Promise<StartedSession>;
+    join: (sessionId: string) => Promise<VoiceJoinGrant>;
+    accept: (input: ParticipantRef) => Promise<StartedSession>;
+    reject: (input: ParticipantRef) => Promise<VoiceSession>;
+    leave: (sessionId: string) => Promise<VoiceSession>;
+    can: (session: VoiceSession, action: SessionAction) => boolean;
+};
+type HostSessions = Omit<Sessions, "start"> & {
+    start: (input: HostStartInput) => Promise<StartedSession>;
+};
+type HostControls = {
+    end: (sessionId: string) => Promise<void>;
+    addParticipant: (input: HostParticipantInput) => Promise<StartedSession>;
+    removeParticipant: (input: ParticipantRef) => Promise<VoiceSession>;
+    startRecording: (sessionId: string) => Promise<SessionRecordingControl>;
+    stopRecording: (sessionId: string) => Promise<SessionRecordingControl>;
+};
+type SessionClient = {
+    readonly kind: "session";
+    readonly status: ClientStatus;
+    readonly sessions: Sessions;
+    readonly invites: Invites;
+    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"> & {
+    readonly kind: "host";
+    readonly vendor: string;
+    readonly sessions: HostSessions;
+    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 HostStartInput as h, type ListSessionsResponse as i, type SessionClient as j, type SessionClientConfig as k, type SessionDuration as l, type SessionInvite as m, type SessionRecording as n, type SessionRecordingControl as o, type Sessions as p, type StartedSession as q, type StoreTopic as r, type VoiceParticipant as s, type VoiceSession as t };

package/dist/types-Dgwrb3rf.d.ts

@@ -0,0 +1,206 @@
+type Auth = {
+    getAccessToken: () => string | Promise<string>;
+    onUnauthorized?: () => void | Promise<void>;
+};
+declare class CallpadError extends Error {
+    readonly code: string;
+    readonly status?: number | undefined;
+    constructor(code: string, message: string, status?: number | undefined);
+}
+
+type RealtimeToken = {
+    url: string;
+    token: string;
+    channel: string;
+    expiresAt: string;
+};
+type VoiceDirection = 'inbound' | 'outbound';
+type VoiceSessionState = 'ringing' | 'active' | 'ended';
+type VoiceEndReason = 'completed' | 'declined' | 'closed' | 'no_route';
+type VoiceParticipantKind = 'agent' | 'vendor_user' | 'customer' | 'contact' | 'phone';
+type VoiceParticipantRole = 'host' | 'participant';
+type VoiceTransport = 'webrtc' | 'sip';
+type VoiceParticipantState = 'invited' | 'accepted' | 'joined' | 'left' | 'rejected' | 'removed';
+type VoiceParticipant = {
+    id: string;
+    kind: VoiceParticipantKind;
+    role: VoiceParticipantRole;
+    transport: VoiceTransport;
+    state: VoiceParticipantState;
+    identity: string;
+    userId: number | null;
+    agentId: string | null;
+    contactId: string | null;
+    phone: string | null;
+    firstName: string | null;
+    lastName: string | null;
+    profilePhoto: string | null;
+    inviteExpiresAt: string | null;
+    acceptedAt: string | null;
+    joinedAt: string | null;
+    leftAt: string | null;
+};
+type VoiceSession = {
+    id: string;
+    vendor: string;
+    version: number;
+    direction: VoiceDirection;
+    state: VoiceSessionState;
+    createdAt: string;
+    answeredAt: string | null;
+    endedAt: string | null;
+    endReason: VoiceEndReason | null;
+    recording: SessionRecording;
+    participants: Array<VoiceParticipant>;
+};
+type SessionRecordingStatus = 'off' | 'starting' | 'recording' | 'stopping';
+type SessionRecording = {
+    status: SessionRecordingStatus;
+    startedAt: string | null;
+};
+type SessionRecordingControl = {
+    sessionId: string;
+    sessionVersion: number;
+    recording: SessionRecording;
+};
+type VoiceJoinGrant = {
+    url: string;
+    roomName: string;
+    token: string;
+    participantIdentity: string;
+    participantId: string;
+    expiresAt: string;
+};
+type StartedSession = {
+    session: VoiceSession;
+    join: VoiceJoinGrant | null;
+};
+type ListSessionsResponse = {
+    items: Array<VoiceSession>;
+};
+type ListSessionsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        vendor?: string;
+        state?: 'active' | 'ended' | 'all';
+        before?: string;
+        limit?: number;
+    };
+    url: '/api/v1/sessions';
+};
+
+type Nullable<T> = T | null;
+
+type ClientStatus = "idle" | "connecting" | "ready" | "reconnecting" | "offline" | "disposed";
+type SessionAction = "accept" | "reject" | "join" | "leave" | "end" | "addParticipant" | "removeParticipant" | "startRecording" | "stopRecording";
+type Unsubscribe = () => void;
+type StoreTopic = "status" | "sessions" | "invites" | `session:${string}`;
+type SessionInvite = {
+    session: VoiceSession;
+    participant: VoiceParticipant;
+};
+type SessionDuration = {
+    seconds: number;
+    startedAt: Nullable<string>;
+    endedAt: Nullable<string>;
+    running: boolean;
+};
+type ClientEvents = {
+    status: ClientStatus;
+    "session.added": VoiceSession;
+    "session.updated": VoiceSession;
+    "session.removed": {
+        sessionId: string;
+        vendor?: string;
+        version?: number;
+    };
+    error: Error;
+};
+type SessionClientConfig = {
+    apiUrl: string;
+    userId: number;
+    auth: Auth;
+    fetch?: typeof fetch;
+};
+type HostClientConfig = SessionClientConfig & {
+    vendor: string;
+};
+type ListQuery = NonNullable<ListSessionsData["query"]>;
+type CustomerStartInput = {
+    vendor: string;
+    target: {
+        type: "vendor_user";
+        userId: number;
+    };
+};
+type HostStartInput = {
+    target: {
+        type: "customer";
+        userId: number;
+    } | {
+        type: "contact";
+        contactId: string;
+    } | {
+        type: "phone";
+        phone: string;
+    };
+};
+type ParticipantRef = {
+    sessionId: string;
+    participantId: string;
+};
+type HostParticipantInput = {
+    sessionId: string;
+    target: {
+        type: "contact";
+        contactId: string;
+    } | {
+        type: "phone";
+        phone: string;
+    };
+};
+type Invites = {
+    list: () => readonly SessionInvite[];
+    get: (sessionId: string) => Nullable<SessionInvite>;
+};
+type Sessions = {
+    list: () => readonly VoiceSession[];
+    get: (sessionId?: string) => Nullable<VoiceSession>;
+    sync: (query?: ListQuery) => Promise<readonly VoiceSession[]>;
+    start: (input: CustomerStartInput) => Promise<StartedSession>;
+    join: (sessionId: string) => Promise<VoiceJoinGrant>;
+    accept: (input: ParticipantRef) => Promise<StartedSession>;
+    reject: (input: ParticipantRef) => Promise<VoiceSession>;
+    leave: (sessionId: string) => Promise<VoiceSession>;
+    can: (session: VoiceSession, action: SessionAction) => boolean;
+};
+type HostSessions = Omit<Sessions, "start"> & {
+    start: (input: HostStartInput) => Promise<StartedSession>;
+};
+type HostControls = {
+    end: (sessionId: string) => Promise<void>;
+    addParticipant: (input: HostParticipantInput) => Promise<StartedSession>;
+    removeParticipant: (input: ParticipantRef) => Promise<VoiceSession>;
+    startRecording: (sessionId: string) => Promise<SessionRecordingControl>;
+    stopRecording: (sessionId: string) => Promise<SessionRecordingControl>;
+};
+type SessionClient = {
+    readonly kind: "session";
+    readonly status: ClientStatus;
+    readonly sessions: Sessions;
+    readonly invites: Invites;
+    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"> & {
+    readonly kind: "host";
+    readonly vendor: string;
+    readonly sessions: HostSessions;
+    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 HostStartInput as h, type ListSessionsResponse as i, type SessionClient as j, type SessionClientConfig as k, type SessionDuration as l, type SessionInvite as m, type SessionRecording as n, type SessionRecordingControl as o, type Sessions as p, type StartedSession as q, type StoreTopic as r, type VoiceParticipant as s, type VoiceSession as t };

package/package.json

@@ -1,15 +1,23 @@
 {
   "name": "farvex",
-  "version": "0.2.0",
-  "description": "Web SDK for Callpad sessions (LiveKit + Pulse)",
+  "version": "1.0.1",
+  "description": "Web SDK for Callpad voice sessions",
+  "keywords": [
+    "callpad",
+    "livekit",
+    "react",
+    "realtime",
+    "sessions",
+    "webrtc"
+  ],
   "license": "UNLICENSED",
-  "type": "module",
-  "sideEffects": false,
   "files": [
     "dist",
     "README.md",
     "CHANGELOG.md"
   ],
+  "type": "module",
+  "sideEffects": false,
   "exports": {
     ".": {
       "import": {
@@ -21,16 +29,6 @@
         "default": "./dist/index.cjs"
       }
     },
-    "./core": {
-      "import": {
-        "types": "./dist/core/index.d.ts",
-        "default": "./dist/core/index.js"
-      },
-      "require": {
-        "types": "./dist/core/index.d.cts",
-        "default": "./dist/core/index.cjs"
-      }
-    },
     "./react": {
       "import": {
         "types": "./dist/react/index.d.ts",
@@ -51,80 +49,63 @@
         "default": "./dist/livekit/index.cjs"
       }
     },
-    "./mock": {
-      "import": {
-        "types": "./dist/mock/index.d.ts",
-        "default": "./dist/mock/index.js"
-      },
-      "require": {
-        "types": "./dist/mock/index.d.cts",
-        "default": "./dist/mock/index.cjs"
-      }
-    },
     "./package.json": "./package.json"
   },
-  "peerDependencies": {
-    "react": "^18 || ^19",
-    "react-dom": "^18 || ^19"
+  "publishConfig": {
+    "access": "public"
   },
-  "peerDependenciesMeta": {
-    "react": {
-      "optional": true
-    },
-    "react-dom": {
-      "optional": true
-    }
+  "scripts": {
+    "changeset": "changeset",
+    "version": "changeset version",
+    "release": "changeset publish",
+    "generate": "openapi-ts",
+    "build": "bun run generate && tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "oxlint .",
+    "format": "oxfmt .",
+    "format:check": "oxfmt --check .",
+    "check": "bun run generate && bun run lint && bun run format:check && bun run typecheck",
+    "prepublishOnly": "bun run check && bun run build"
   },
   "dependencies": {
-    "@livekit/components-react": "^2.9.0",
-    "livekit-client": "^2.13.0",
-    "socket.io-client": "^4.8.1"
+    "centrifuge": "5.6.0"
   },
   "devDependencies": {
-    "@hey-api/openapi-ts": "^0.73.0",
-    "@testing-library/jest-dom": "^6.5.0",
-    "@testing-library/react": "^16.0.0",
+    "@changesets/cli": "^2.27.0",
+    "@hey-api/openapi-ts": "0.97.2",
+    "@livekit/components-react": "^2.9.0",
     "@types/react": "^18.3.0",
     "@types/react-dom": "^18.3.0",
-    "jsdom": "^25.0.0",
+    "livekit-client": "^2.13.0",
     "oxfmt": "^0.38.0",
     "oxlint": "^1.53.0",
     "react": "^18.3.0",
     "react-dom": "^18.3.0",
     "tsup": "^8.3.0",
-    "typescript": "5.8.3",
-    "vitest": "^2.1.0"
+    "typescript": "5.8.3"
   },
-  "scripts": {
-    "build": "bun run generate:api && tsup",
-    "dev": "tsup --watch",
-    "typecheck": "tsc --noEmit",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "lint": "oxlint .",
-    "format": "oxfmt .",
-    "format:check": "oxfmt --check .",
-    "check": "bun run generate:api && bun run lint && bun run format:check && bun run typecheck",
-    "generate:api": "openapi-ts",
-    "generate:api:watch": "openapi-ts --watch",
-    "changeset": "changeset",
-    "version": "changeset version",
-    "release": "bun run build && changeset publish",
-    "prepublishOnly": "bun run check && bun run test && bun run build"
+  "peerDependencies": {
+    "@livekit/components-react": "^2",
+    "livekit-client": "^2",
+    "react": "^18 || ^19",
+    "react-dom": "^18 || ^19"
   },
-  "publishConfig": {
-    "access": "public"
+  "peerDependenciesMeta": {
+    "@livekit/components-react": {
+      "optional": true
+    },
+    "livekit-client": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    }
   },
   "engines": {
     "node": ">=18"
-  },
-  "keywords": [
-    "callpad",
-    "sessions",
-    "livekit",
-    "webrtc",
-    "sip",
-    "realtime",
-    "react"
-  ]
+  }
 }