npm - interview-widget - Versions diffs - 0.0.9 → 0.1.1 - Mend

interview-widget 0.0.9 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2) hide show

package/README.md +243 -58
package/package.json +5 -4

package/README.md CHANGED Viewed

@@ -127,11 +127,6 @@ export default function App() {
 | `onInterviewEnd` | `() => void` | `undefined`   | Called when the interview completes or the user exits        |
 | `className`      | `string`     | `""`          | Additional CSS classes applied to the outer widget container |
-Notes:
-- Internally uses an InterviewController that orchestrates the full flow using the configured API/STT/TTS/Timer.
-- The interview id is currently derived internally; integrate with your backend by configuring the API base and auth.
 ### <InterviewWidgetProvider />
 Wrap your app (or the widget) to provide configuration. See full config reference below.
@@ -148,71 +143,261 @@ Pass this object to `InterviewWidgetProvider` via the `config` prop. Tables list
 ### Top-level
-| Prop      | Type   | Default   | Description                                    |
-| --------- | ------ | --------- | ---------------------------------------------- |
-| api       | object | see below | Backend/API configuration                      |
-| ui        | object | see below | UI customization tokens                        |
-| interview | object | see below | Interview behavior settings (timers, STT, TTS) |
+<table width="100%">
+  <thead>
+    <tr>
+      <th>Prop</th>
+      <th>Type</th>
+      <th>Default</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>api</td>
+      <td><code>object</code></td>
+      <td>see below</td>
+      <td>Backend/API configuration</td>
+    </tr>
+    <tr>
+      <td>ui</td>
+      <td><code>object</code></td>
+      <td>see below</td>
+      <td>UI customization tokens</td>
+    </tr>
+    <tr>
+      <td>interview</td>
+      <td><code>object</code></td>
+      <td>see below</td>
+      <td>Interview behavior settings (timers, STT, TTS)</td>
+    </tr>
+  </tbody>
+  </table>
 ### api
-| Prop        | Type   | Default   | Description                                            |
-| ----------- | ------ | --------- | ------------------------------------------------------ |
-| baseUrl     | string | "/api"    | Base URL for backend endpoints                         |
-| authToken   | string | undefined | Optional bearer token appended as Authorization header |
-| retryConfig | object | see below | Retry policy for fetch calls                           |
+<table width="100%">
+  <thead>
+    <tr>
+      <th>Prop</th>
+      <th>Type</th>
+      <th>Default</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>baseUrl</td>
+      <td><code>string</code></td>
+      <td>"/api"</td>
+      <td>Base URL for backend endpoints</td>
+    </tr>
+    <tr>
+      <td>authToken</td>
+      <td><code>string</code></td>
+      <td>undefined</td>
+      <td>Optional bearer token appended as Authorization header</td>
+    </tr>
+    <tr>
+      <td>retryConfig</td>
+      <td><code>object</code></td>
+      <td>see below</td>
+      <td>Retry policy for fetch calls</td>
+    </tr>
+  </tbody>
+</table>
 retryConfig
-| Prop      | Type                     | Default       | Description                                |
-| --------- | ------------------------ | ------------- | ------------------------------------------ |
-| attempts  | number                   | 3             | Number of retry attempts                   |
-| backoff   | "fixed" \| "exponential" | "exponential" | Backoff strategy                           |
-| baseDelay | number (ms)              | 1000          | Base delay between retries in milliseconds |
+<table width="100%">
+  <thead>
+    <tr>
+      <th>Prop</th>
+      <th>Type</th>
+      <th>Default</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>attempts</td>
+      <td><code>number</code></td>
+      <td>3</td>
+      <td>Number of retry attempts</td>
+    </tr>
+    <tr>
+      <td>backoff</td>
+      <td><code>"fixed" | "exponential"</code></td>
+      <td>"exponential"</td>
+      <td>Backoff strategy</td>
+    </tr>
+    <tr>
+      <td>baseDelay</td>
+      <td><code>number (ms)</code></td>
+      <td>1000</td>
+      <td>Base delay between retries in milliseconds</td>
+    </tr>
+  </tbody>
+</table>
 ### ui
-| Prop         | Type         | Default   | Description                            |
-| ------------ | ------------ | --------- | -------------------------------------- |
-| baseColor    | string (hex) | "#3B82F6" | Primary brand color used by the widget |
-| borderRadius | string (CSS) | "8px"     | Global corner radius for components    |
+<table width="100%">
+  <thead>
+    <tr>
+      <th>Prop</th>
+      <th>Type</th>
+      <th>Default</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>baseColor</td>
+      <td><code>string (hex)</code></td>
+      <td>"#3B82F6"</td>
+      <td>Primary brand color used by the widget</td>
+    </tr>
+    <tr>
+      <td>borderRadius</td>
+      <td><code>string (CSS)</code></td>
+      <td>"8px"</td>
+      <td>Global corner radius for components</td>
+    </tr>
+  </tbody>
+</table>
 ### interview
-| Prop   | Type   | Default   | Description                               |
-| ------ | ------ | --------- | ----------------------------------------- |
-| timers | object | see below | Per-phase and global timing configuration |
-| stt    | object | see below | Speech-to-Text provider settings          |
-| tts    | object | see below | Text-to-Speech provider settings          |
-timers
-| Prop                       | Type       | Default | Description                                               |
-| -------------------------- | ---------- | ------- | --------------------------------------------------------- |
-| thinkingDuration           | number (s) | 30      | Timebox for the Thinking phase                            |
-| answeringDuration          | number (s) | 120     | Timebox for the Answering phase                           |
-| editingDuration            | number (s) | 30      | Timebox for the Editing phase                             |
-| totalInterviewDuration     | number (s) | 600     | Overall interview time cap                                |
-| minimumTimeForNextQuestion | number (s) | 120     | Minimum time required to allow starting the next question |
-stt
-| Prop     | Type                               | Default                  | Description                            |
-| -------- | ---------------------------------- | ------------------------ | -------------------------------------- |
-| provider | "groq" \| "deepgram"               | "groq"                   | STT vendor to use                      |
-| model    | "whisper-large-v3-turbo" \| string | "whisper-large-v3-turbo" | STT model identifier                   |
-| language | "en"                               | "en"                     | Language code passed to the STT engine |
-tts
-| Prop     | Type    | Default | Description       |
-| -------- | ------- | ------- | ----------------- |
-| provider | "piper" | "piper" | TTS vendor to use |
-Notes on defaults:
-- Base defaults come from `src/utils/constants.ts` (`defaultConfig`).
-- `totalInterviewDuration` and `minimumTimeForNextQuestion` default to 600s and 120s respectively via the TimerService if not explicitly provided.
+<table width="100%">
+  <thead>
+    <tr>
+      <th>Prop</th>
+      <th>Type</th>
+      <th>Default</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>timers</td>
+      <td><code>object</code></td>
+      <td>see below</td>
+      <td>Per-phase and global timing configuration</td>
+    </tr>
+    <tr>
+      <td>stt</td>
+      <td><code>object</code></td>
+      <td>see below</td>
+      <td>Speech-to-Text provider settings</td>
+    </tr>
+    <tr>
+      <td>tts</td>
+      <td><code>object</code></td>
+      <td>see below</td>
+      <td>Text-to-Speech provider settings</td>
+    </tr>
+  </tbody>
+</table>
+#### timers
+<table width="100%">
+  <thead>
+    <tr>
+      <th>Prop</th>
+      <th>Type</th>
+      <th>Default</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>thinkingDuration</td>
+      <td><code>number (s)</code></td>
+      <td>30</td>
+      <td>Timebox for the Thinking phase</td>
+    </tr>
+    <tr>
+      <td>answeringDuration</td>
+      <td><code>number (s)</code></td>
+      <td>120</td>
+      <td>Timebox for the Answering phase</td>
+    </tr>
+    <tr>
+      <td>editingDuration</td>
+      <td><code>number (s)</code></td>
+      <td>30</td>
+      <td>Timebox for the Editing phase</td>
+    </tr>
+    <tr>
+      <td>totalInterviewDuration</td>
+      <td><code>number (s)</code></td>
+      <td>600</td>
+      <td>Overall interview time cap</td>
+    </tr>
+    <tr>
+      <td>minimumTimeForNextQuestion</td>
+      <td><code>number (s)</code></td>
+      <td>120</td>
+      <td>Minimum time required to allow starting the next question</td>
+    </tr>
+  </tbody>
+</table>
+#### stt
+<table width="100%">
+  <thead>
+    <tr>
+      <th>Prop</th>
+      <th>Type</th>
+      <th>Default</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>provider</td>
+      <td><code>"groq" | "deepgram"</code></td>
+      <td>"groq"</td>
+      <td>STT vendor to use</td>
+    </tr>
+    <tr>
+      <td>model</td>
+      <td><code>"whisper-large-v3-turbo" | string</code></td>
+      <td>"whisper-large-v3-turbo"</td>
+      <td>STT model identifier</td>
+    </tr>
+    <tr>
+      <td>language</td>
+      <td><code>string</code></td>
+      <td>"en"</td>
+      <td>Language code passed to the STT engine</td>
+    </tr>
+  </tbody>
+</table>
+#### tts
+<table width="100%">
+  <thead>
+    <tr>
+      <th>Prop</th>
+      <th>Type</th>
+      <th>Default</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>provider</td>
+      <td><code>"piper"</code></td>
+      <td>"piper"</td>
+      <td>TTS vendor to use</td>
+    </tr>
+  </tbody>
+</table>
 ## How it works

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "interview-widget",
   "type": "module",
-  "version": "0.0.9",
+  "version": "0.1.1",
   "description": "Advanced React interview widget with STT, TTS, camera access, and ML-powered analysis",
   "main": "dist/widget.umd.js",
   "module": "dist/widget.es.js",
@@ -54,11 +54,12 @@
   },
   "keywords": [
     "react",
-    "chat",
+    "interview",
     "widget",
     "cdn",
-    "embed"
+    "embed",
+    "interview-widget"
   ],
-  "author": "Your Name",
+  "author": "Jaber Hossain Pranto",
   "license": "MIT"
 }