@convirza/dialer-sdk 1.0.0 → 1.0.1

package/README.md

@@ -1,6 +1,6 @@
 # @convirza/dialer-sdk
 
-Production-ready embeddable WebRTC SIP dialer widget. Auto-configures from OAuth session, handles token refresh, cross-tab logout detection. Includes call parking, call history persistence, audio device management, call quality monitoring.
+A browser-based calling widget that lets users make and receive calls directly from the web app, with call history, call parking, device controls.
 
 ---
 
@@ -43,18 +43,6 @@ Production-ready embeddable WebRTC SIP dialer widget. Auto-configures from OAuth
 npm install @convirza/dialer-sdk
 ```
 
-**Peer dependency** — SIP.js must be loaded separately (UMD global `SIP` or `sip`):
-
-```html
-<script src="https://cdn.jsdelivr.net/npm/sip.js@0.13.8/dist/sip.js"></script>
-```
-
-Or install via npm and bundle it yourself:
-
-```bash
-npm install sip.js@^0.13.8
-```
-
 ---
 
 ## Quick Start
@@ -75,11 +63,10 @@ const accessToken = localStorage.getItem('access_token');
 const refreshToken = localStorage.getItem('refresh_token');
 
 // Initialize widget (auto-fetches SIP config from OAuth session endpoint)
+// OAuth/API URLs hardcoded in SDK — points to staging by default
 convirzaDialer.init({
 	access_token: accessToken,
 	refresh_token: refreshToken,
-	oauth_endpoint: 'https://stag-5-oauth.convirza.com/oauth/internal',
-	api_url: 'https://stag-5-dialer-apis.convirza.com',
 	dark_theme: true,
 	primaryColor: '#6366f1',
 	brandName: 'Acme Corp',
@@ -134,7 +121,6 @@ const refreshToken = localStorage.getItem('refresh_token');
 initDialer({
 	access_token: accessToken,
 	refresh_token: refreshToken,
-	api_url: 'https://stag-5-dialer-apis.convirza.com',
 });
 
 if (isDialerInitialized()) {
@@ -157,9 +143,7 @@ Embed the dialer widget as a custom HTML element.
 	dialer.setAttribute('access-token', accessToken);
 	dialer.setAttribute('refresh-token', refreshToken);
 	dialer.setAttribute('auto-configure', 'true');
-	dialer.setAttribute('oauth-endpoint', 'https://stag-5-oauth.convirza.com/oauth/internal');
 	dialer.setAttribute('theme', 'dark');
-	dialer.setAttribute('api-url', 'https://stag-5-dialer-apis.convirza.com');
 
 	// Listen for token refresh (only fires if access_token expires)
 	dialer.addEventListener('token-refreshed', (e) => {
@@ -182,8 +166,6 @@ Embed the dialer widget as a custom HTML element.
 - `access-token` — Access token from user login (used first)
 - `refresh-token` — Refresh token (fallback if access_token expires)
 - `auto-configure="true"` — Enables auto-config flow
-- `oauth-endpoint` — OAuth base URL (default: `https://stag-5-oauth.convirza.com/oauth/internal`)
-- `api-url` — API base URL for park slots, call history
 
 **Events:**
 
@@ -222,7 +204,6 @@ localStorage.setItem('refresh_token', refresh_token);
 convirzaDialer.init({
 	access_token: localStorage.getItem('access_token'),
 	refresh_token: localStorage.getItem('refresh_token'),
-	oauth_endpoint: 'https://stag-5-oauth.convirza.com/oauth/internal',
 });
 ```
 
@@ -349,28 +330,23 @@ Initialize the dialer and inject the widget into the page. **Must be called befo
 convirzaDialer.init(config: DialerInitConfig): void
 ```
 
-| Field            | Type      | Required | Description                                  |
-| ---------------- | --------- | -------- | -------------------------------------------- |
-| `access_token`   | `string`  | Yes      | Access token from user login session         |
-| `refresh_token`  | `string`  | Yes      | Refresh token (used if access_token expires) |
-| `oauth_endpoint` | `string`  | No       | OAuth base URL (default: internal)           |
-| `api_url`        | `string`  | No       | API base URL for park slots, call history    |
-| `brandName`      | `string`  | No       | Brand name shown in widget header            |
-| `brandLogo`      | `string`  | No       | URL of brand logo image                      |
-| `dark_theme`     | `boolean` | No       | Use dark theme (default `false`)             |
-| `showPopup`      | `boolean` | No       | Start with widget expanded                   |
-| `primaryColor`   | `string`  | No       | CSS color for primary UI elements (hex/rgb)  |
-| `accentColor`    | `string`  | No       | CSS color for accent elements                |
-
-OAuth response provides SIP credentials automatically. User never sees SIP details.
+| Field           | Type      | Required | Description                                  |
+| --------------- | --------- | -------- | -------------------------------------------- |
+| `access_token`  | `string`  | Yes      | Access token from user login session         |
+| `refresh_token` | `string`  | Yes      | Refresh token (used if access_token expires) |
+| `brandName`     | `string`  | No       | Brand name shown in widget header            |
+| `brandLogo`     | `string`  | No       | URL of brand logo image                      |
+| `dark_theme`    | `boolean` | No       | Use dark theme (default `false`)             |
+| `showPopup`     | `boolean` | No       | Start with widget expanded                   |
+| `primaryColor`  | `string`  | No       | CSS color for primary UI elements (hex/rgb)  |
+| `accentColor`   | `string`  | No       | CSS color for accent elements                |
 
 **Example:**
 
 ```js
 convirzaDialer.init({
-	oauth_endpoint: 'https://api.example.com/oauth/token',
-	username: 'user@example.com',
-	password: 'userpassword',
+	access_token: 'eyJhbGc...',
+	refresh_token: 'eyJhbGc...',
 	dark_theme: true,
 	primaryColor: '#6366f1',
 	brandName: 'Acme Corp',
@@ -1208,48 +1184,6 @@ const result = await api.fetchOrderedNumbers({
 
 ---
 
-### `CallHistoryAPI`
-
-REST client for persisting and querying call history.
-
-```ts
-import { CallHistoryAPI } from '@convirza/dialer-sdk';
-
-const api = new CallHistoryAPI('https://api.convirza.com', 'Bearer-token');
-
-const history = await api.fetchHistory({
-	userId: 'user-123',
-	sipDomain: 'sip.example.com',
-	limit: 50,
-	offset: 0,
-});
-// history: { calls: CallRecord[], total: number, hasMore: boolean }
-
-const saved = await api.saveCall({
-	callId: 'abc-123',
-	userId: 'user-123',
-	sipDomain: 'sip.example.com',
-	callerIdNumber: '+15551234567',
-	phoneNumber: '+19876543210',
-	direction: 'outbound',
-	disposition: 'answered',
-	startedAt: Date.now(),
-	durationSeconds: 42,
-	createdAt: Date.now(),
-});
-
-const updated = await api.updateCall(saved.callId, { disposition: 'missed' });
-```
-
-| Method                        | Description                      |
-| ----------------------------- | -------------------------------- |
-| `setAuthToken(token)`         | Update the bearer token          |
-| `fetchHistory(params)`        | Fetch paginated call history     |
-| `saveCall(record)`            | Create a new call history record |
-| `updateCall(callId, updates)` | Patch an existing call record    |
-
----
-
 ## Web Component Reference
 
 ### Web Component Attributes
@@ -1261,8 +1195,6 @@ The `<convirza-dialer>` custom element accepts the following HTML attributes:
 | `access-token`       | `string`                                                       | Yes\*    | Access token from user login                     |
 | `refresh-token`      | `string`                                                       | Yes\*    | Refresh token (fallback if access_token expires) |
 | `auto-configure`     | `'true' \| 'false'`                                            | Yes\*    | Enable auto-config from OAuth session            |
-| `oauth-endpoint`     | `string`                                                       | No       | OAuth base URL (default: stag-5 internal)        |
-| `api-url`            | `string`                                                       | No       | API base URL for park/history                    |
 | `brand-name`         | `string`                                                       | No       | Brand name in header                             |
 | `brand-logo`         | `string`                                                       | No       | URL for brand logo                               |
 | `theme`              | `'light' \| 'dark'`                                            | No       | UI theme (default: dark)                         |
@@ -1273,8 +1205,6 @@ The `<convirza-dialer>` custom element accepts the following HTML attributes:
 | `z-index`            | `number`                                                       | No       | CSS z-index of the widget                        |
 | `park-poll-interval` | `number`                                                       | No       | Park slots polling interval in ms (default 5000) |
 
-**Required only for auto-configure mode.** Widget fetches SIP credentials from OAuth session endpoint automatically.
-
 ### Web Component Public Methods
 
 All methods can be called on the element reference.
@@ -1420,7 +1350,7 @@ element.setTheme({
 
 #### `element.clearCallHistoryCache()`
 
-Clear IndexedDB call history cache and reload from backend.
+Clear IndexedDB call history.
 
 ```ts
 async clearCallHistoryCache(): Promise<void>
@@ -1514,17 +1444,14 @@ Call parking allows transferring an active call to a shared "parking lot" where
 **HTML Attributes:**
 
 ```html
-<convirza-dialer
-	api-url="https://stag-5-dialer-apis.convirza.com"
-	auth-token="Bearer xyz"
-	park-poll-interval="5000"
-></convirza-dialer>
+<convirza-dialer auth-token="Bearer xyz" park-poll-interval="5000"></convirza-dialer>
 ```
 
-- `api-url`: Base API URL — park endpoint is `{api-url}/v3/park-slots`
 - `auth-token`: JWT or API key for backend auth
 - `park-poll-interval`: Poll interval in ms (default: 5000)
 
+**Note:** API URL hardcoded in SDK — park endpoint auto-detected as `{API_URL}/v3/park-slots`
+
 #### Backend API
 
 **Required endpoint:**
@@ -1578,81 +1505,30 @@ element.addEventListener('call-park-failed', (e) => {
 
 ### Call History Persistence
 
-Call history is saved to **two tiers**:
-
-1. **IndexedDB** (local cache) — instant load, offline support
-2. **Backend API** (source of truth) — multi-device sync, compliance
-
-Widget saves to IndexedDB immediately (non-blocking), then syncs to backend async.
+Call history saved to **IndexedDB** (browser-local storage). No backend sync.
 
 #### Data Flow
 
 **On call end:**
 
 1. Widget generates UUID `callId`
-2. Saves to IndexedDB (instant)
-3. POSTs to `/api/call-history` (async, retries on failure)
-4. Reloads history from IndexedDB to update UI
+2. Saves to IndexedDB
+3. Reloads history to update UI
 
 **On SIP registration:**
 
 1. Initialize `CallHistoryService`
-2. Load from IndexedDB (fast)
-3. Background-sync from backend (replaces IndexedDB cache)
+2. Load from IndexedDB
 
 **On page reload:**
 
 - IndexedDB persists → history visible immediately
-- Backend sync refreshes on reconnect
-
-#### Configuration
 
-**HTML Attributes:**
+#### Storage Scope
 
-```html
-<convirza-dialer api-url="https://api.example.com" auth-token="Bearer xyz"></convirza-dialer>
-```
-
-- `api-url`: Base API URL — history endpoint = `{api-url}/api/call-history`
-- `auth-token`: JWT or API key for backend auth
-
-**If `api-url` not set:**
-
-- IndexedDB-only mode (no backend sync)
-- History persists locally but not across devices
-
-#### Backend API
-
-**Required endpoints:**
-
-```
-GET  /api/call-history?userId={id}&sipDomain={domain}&limit=100&offset=0
-POST /api/call-history
-PATCH /api/call-history/{callId}
-```
-
-**Database schema (PostgreSQL):**
-
-```sql
-CREATE TABLE call_history (
-  id BIGSERIAL PRIMARY KEY,
-  call_id VARCHAR(100) UNIQUE NOT NULL,
-  user_id VARCHAR(50) NOT NULL,
-  sip_domain VARCHAR(100) NOT NULL,
-  phone_number VARCHAR(50) NOT NULL,
-  direction VARCHAR(10) NOT NULL CHECK (direction IN ('inbound', 'outbound')),
-  status VARCHAR(20) NOT NULL CHECK (status IN ('answered', 'missed', 'rejected', 'failed')),
-  started_at TIMESTAMPTZ NOT NULL,
-  ended_at TIMESTAMPTZ,
-  duration_seconds INTEGER DEFAULT 0,
-  recording_url VARCHAR(500),
-  created_at TIMESTAMPTZ DEFAULT NOW(),
-  INDEX idx_user_domain_started (user_id, sip_domain, started_at DESC),
-  INDEX idx_call_id (call_id)
-);
-```
-
-See `docs/CALL_HISTORY_API.md` for full spec, Node.js examples, security notes.
+- **Per-browser only** — not synced across devices
+- **Offline support** — no network dependency
+- **Privacy** — stays local, never uploaded
 
 #### Events
 
@@ -1664,6 +1540,13 @@ element.addEventListener('history-updated', (e) => {
 });
 ```
 
+#### API Methods
+
+```js
+// Clear all call history
+await dialer.clearCallHistoryCache();
+```
+
 ### Audio Device Management
 
 Microphone and speaker selection with hot-swapping during calls.
@@ -1686,35 +1569,6 @@ await sip.setSpeaker(deviceId);
 - Microphone switching: Chrome, Firefox, Safari, Edge
 - Speaker switching (`setSinkId`): Chrome, Edge only (silently no-ops in Firefox/Safari)
 
-### Call Quality Monitoring
-
-Polls `RTCPeerConnection.getStats()` every 2s and emits quality metrics.
-
-**Metrics:**
-
-- **Bitrate** (kbps)
-- **Packet loss** (%)
-- **Jitter** (ms)
-- **Latency** (ms, round-trip)
-- **Audio level** (0–1)
-- **Quality** (`excellent` | `good` | `fair` | `poor`)
-
-**Usage:**
-
-```js
-const sip = new SipAdapter(config, {
-	onQualityChange: (metrics) => {
-		if (metrics.quality === 'poor') {
-			console.warn('Poor call quality:', metrics);
-		}
-	},
-});
-
-// Or poll manually
-const metrics = sip.getCallQuality();
-console.log('Packet loss:', metrics.packetLoss + '%');
-```
-
 ### Theming
 
 #### HTML Attributes (static)
@@ -1808,31 +1662,6 @@ Requires a browser with WebRTC (`RTCPeerConnection`) and WebSocket support.
 
 ---
 
-## Project Structure
-
-```
-convirza-dialer-1/
-├── packages/web-sdk/
-│   ├── src/              # Source code (TypeScript)
-│   │   ├── ui/           # Web component
-│   │   ├── sip/          # SIP adapter
-│   │   ├── api/          # REST clients
-│   │   ├── media/        # Audio device management
-│   │   ├── constants/    # Configuration
-│   │   └── types/        # TypeScript types
-│   ├── test/             # Unit tests
-│   ├── dist/             # Built output (published)
-│   │   ├── index.esm.js  # ES modules
-│   │   ├── index.cjs.js  # CommonJS
-│   │   ├── index.umd.js  # UMD (browser)
-│   │   └── types/        # TypeScript declarations
-│   └── package.json      # Package metadata
-└── demo/                 # Demo files (root level, not published)
-    ├── demo.html         # Interactive demo
-    ├── sip.bundle.js     # Bundled SIP.js
-    └── README.md         # Demo instructions
-```
-
 **For development:** Work in `src/` directory.  
 **For users:** Import from `dist/` (handled automatically by package.json).
 

package/dist/api/DialerAPI.d.ts

@@ -1,8 +1,6 @@
 export interface DialerInitConfig {
     access_token: string;
     refresh_token: string;
-    oauth_endpoint?: string;
-    api_url?: string;
     dark_theme?: boolean;
     showPopup?: boolean;
     primaryColor?: string;