@omniloy/sofia-sdk 0.0.10 → 0.0.11

package/README.md

@@ -13,104 +13,115 @@ AI-powered medical assistant web component for healthcare applications.
 
 ## Installation
 
+### Option 1: NPM/Yarn (Recommended)
+
 ```bash
 npm install @omniloy/sofia-sdk
 ```
 
-## Quick Start
+```bash
+yarn add @omniloy/sofia-sdk
+```
+
+Import in your project:
 
-### Option 1: ES Modules (Recommended)
 ```javascript
+// In your main file (main.js, app.js, index.js, etc.)
 import '@omniloy/sofia-sdk';
-
-<sofia-sdk
-  baseurl="your-base-url"
-  wssurl="your-wss-url"
-  apikey="your-api-key"
-  userid="dr-garcia-123"
-  patientid="patient-456"
-  toolsargs='{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "Medical Consultation",
-    "type": "object",
-    "properties": {
-      "chief_complaint": {"type": "string", "description": "Primary reason for visit"},
-      "diagnosis": {"type": "string", "description": "Medical diagnosis"},
-      "treatment_plan": {"type": "string", "description": "Recommended treatment"}
-    },
-    "required": ["chief_complaint", "diagnosis"]
-  }'>
-</sofia-sdk>
 ```
 
-### Option 2: Script Tag
+Once imported, the `<sofia-sdk>` component becomes available globally.
+
+### Option 2: CDN
+
+Latest version:
+
 ```html
 <script src="https://unpkg.com/@omniloy/sofia-sdk@latest/dist/webcomponents.umd.js"></script>
+```
 
-<sofia-sdk
-  baseurl="your-base-url"
-  wssurl="your-wss-url"
-  apikey="your-api-key"
-  userid="dr-garcia-123"
-  patientid="patient-456"
-  toolsargs='{"$schema": "http://json-schema.org/draft-07/schema#", "title": "Medical Consultation", "type": "object", "properties": {"diagnosis": {"type": "string"}}, "required": ["diagnosis"]}'
-  templateid='1234'
-  >
-</sofia-sdk>
+Specific version:
+
+```html
+<script src="https://unpkg.com/@omniloy/sofia-sdk@1.0.0/dist/webcomponents.umd.js"></script>
 ```
 
-### Handling Generated Reports
+### Option 3: Manual Build
+
+```html
+<script src="/dist/webcomponents.umd.js"></script>
+```
+
+## Installation Verification
+
+Browser verification:
+
 ```javascript
-const sofiaComponent = document.querySelector('sofia-sdk');
-
-// Handle medical reports
-sofiaComponent.handleReport = (report) => {
-  console.log('Medical report generated:', report);
-  // Integrate with your medical records system
-  saveToEHR(report);
-};
-
-// Control component visibility
-sofiaComponent.setIsOpen = (isOpen) => {
-  console.log('Component status:', isOpen ? 'Open' : 'Closed');
-};
+console.log(customElements.get('sofia-sdk'));
+```
+
+Should return the component definition rather than `undefined`.
+
+HTML verification:
+
+```html
+<sofia-sdk></sofia-sdk>
+```
+
+Successful installation displays a message about missing required properties.
+
+## Environment Requirements
+
+### HTTPS Protocol
+
+SofIA SDK requires HTTPS for audio and microphone functionality. Local development uses `https://localhost` or `local-ssl-proxy`.
+
+### Content Security Policy
+
+```
+connect-src 'self' https://*.omniloy.com wss://*.omniloy.com;
+script-src 'self' 'unsafe-inline' https://unpkg.com;
 ```
 
-## Required Configuration
+### SDK Configuration with Proxy
 
-All properties below are mandatory for proper SDK functionality:
+```html
+<sofia-sdk
+  baseurl="base-url"
+  apikey="your-api-key"
+  wssurl="wss://WSS_URL"
+  userid="doctor-123"
+  patientid="patient-456"
+  template='{"$schema": "http://json-schema.org/draft-07/schema#", "title": "Medical Consultation", "type": "object", "properties": {"diagnosis": {"type": "string"}}, "required": ["diagnosis"]}'
+  templateid='1234'
+></sofia-sdk>
+```
 
-| Property | Type | Description |
-|----------|------|-------------|
-| **baseurl** | `string` | SofIA REST API endpoint (HTTPS required) |
-| **wssurl** | `string` | WebSocket URL for real-time streaming (WSS required) |
-| **apikey** | `string` | Authentication key provided by Omniloy |
-| **userid** | `string` | Unique identifier of the healthcare professional |
-| **patientid** | `string` | Unique identifier of the patient for the session |
-| **toolsargs** | `string` | JSON Schema Draft-07 defining clinical data structure  - mandatory if isonlychat is not "true" |
-| **templateid** | `string` | The current template Id - mandatory if isonlychat is not "true" |
+## Troubleshooting
 
-### Getting Credentials
+**Component doesn't load:**
+- Verify the import is in the main file
+- Confirm no errors in browser console
+- Check network connectivity for CDN usage
 
-Contact [support@omniloy.com](mailto:support@omniloy.com) to obtain:
-- **API Key**: Authentication credentials
-- **Base URL**: Your API endpoint
-- **WebSocket URL**: Real-time connection endpoint
+**CORS errors:**
+- Ensure application uses HTTPS
+- Verify `baseurl` and `wssurl` URLs are correct
 
-## Features
+**Component not defined:**
 
-- **Real-time medical transcription**: Voice-to-text conversion optimized for medical terminology
-- **Intelligent report generation**: AI-powered clinical documentation
-- **HIPAA compliant**: Enterprise-grade security and privacy
-- **Framework agnostic**: Works with any web framework or vanilla JavaScript
-- **WebSocket streaming**: Real-time bidirectional communication
-- **Customizable schemas**: Define your own clinical data structures
+```javascript
+// Wait for component definition
+customElements.whenDefined('sofia-sdk').then(() => {
+  console.log('SofIA SDK is ready');
+});
+```
 
-## Technical Requirements
+## Next Steps
 
-- **HTTPS connection**: TLS required for audio functionalities
-- **Modern browser**: Chrome 88+, Firefox 78+, Safari 14+, Edge 88+
-- **WebSocket support**: For real-time features
+1. **[Required Properties](https://omniloy.mintlify.app/en/sdk/installation)**: Configure mandatory parameters
+2. **[Optional Properties](https://omniloy.mintlify.app/en/sdk/installation)**: Customize behavior
+3. **[Clinical Data Schemas](https://omniloy.mintlify.app/en/sdk/installation)**: Define data structure to generate
 
 ## License
 

package/dist/legacy/webcomponents.es.js

@@ -12411,11 +12411,9 @@ const Collapse$4 = "طي";
 const Multilingual$4 = "متعدد اللغات";
 const Arabic$4 = "عربي";
 const Tamil$4 = "التاميل";
-const Malayalam$4 = "المالايالامية";
 const Telugu$4 = "التيلجو";
 const Kannada$4 = "الكانادا";
 const Hindi$4 = "الهندية";
-const Malay$4 = "لغة الملايو";
 const Thai$4 = "التايلاندية";
 const Filipino$4 = "فلبينية";
 const English$4 = "الإنجليزية";
@@ -12541,12 +12539,11 @@ const ar = {
   Multilingual: Multilingual$4,
   Arabic: Arabic$4,
   Tamil: Tamil$4,
-  Malayalam: Malayalam$4,
+  "Malay / Malayalam": "لغة الملايو / المالايالامية",
   Telugu: Telugu$4,
   Kannada: Kannada$4,
   Hindi: Hindi$4,
   "Bahasa Indonesia": "البهاسا الاندونيسية",
-  Malay: Malay$4,
   Thai: Thai$4,
   Filipino: Filipino$4,
   English: English$4,
@@ -12637,11 +12634,9 @@ const Collapse$3 = "Collapse";
 const Multilingual$3 = "Multilingual";
 const Arabic$3 = "Arabic";
 const Tamil$3 = "Tamil";
-const Malayalam$3 = "Malayalam";
 const Telugu$3 = "Telugu";
 const Kannada$3 = "Kannada";
 const Hindi$3 = "Hindi";
-const Malay$3 = "Malay";
 const Thai$3 = "Thai";
 const Filipino$3 = "Filipino";
 const English$3 = "English";
@@ -12769,12 +12764,11 @@ const en = {
   Multilingual: Multilingual$3,
   Arabic: Arabic$3,
   Tamil: Tamil$3,
-  Malayalam: Malayalam$3,
+  "Malay / Malayalam": "Malay / Malayalam",
   Telugu: Telugu$3,
   Kannada: Kannada$3,
   Hindi: Hindi$3,
   "Bahasa Indonesia": "Bahasa Indonesia",
-  Malay: Malay$3,
   Thai: Thai$3,
   Filipino: Filipino$3,
   English: English$3,
@@ -12868,11 +12862,9 @@ const Collapse$2 = "Cerrar";
 const Multilingual$2 = "Plurilingüe";
 const Arabic$2 = "Árabe";
 const Tamil$2 = "Tamil";
-const Malayalam$2 = "Malayalam";
 const Telugu$2 = "Telugu";
 const Kannada$2 = "Canarés";
 const Hindi$2 = "Hindi";
-const Malay$2 = "Malayo";
 const Thai$2 = "Tailandés";
 const Filipino$2 = "Filipino";
 const English$2 = "Inglés";
@@ -13000,12 +12992,11 @@ const es = {
   Multilingual: Multilingual$2,
   Arabic: Arabic$2,
   Tamil: Tamil$2,
-  Malayalam: Malayalam$2,
+  "Malay / Malayalam": "Malayo / Malayalam",
   Telugu: Telugu$2,
   Kannada: Kannada$2,
   Hindi: Hindi$2,
   "Bahasa Indonesia": "Bahasa Indonesia",
-  Malay: Malay$2,
   Thai: Thai$2,
   Filipino: Filipino$2,
   English: English$2,
@@ -13099,11 +13090,9 @@ const Collapse$1 = "संक्षिप्त करें";
 const Multilingual$1 = "बहुभाषी";
 const Arabic$1 = "अरबी";
 const Tamil$1 = "तमिल";
-const Malayalam$1 = "मलयालम";
 const Telugu$1 = "तेलुगु";
 const Kannada$1 = "कन्नड़";
 const Hindi$1 = "हिंदी";
-const Malay$1 = "मलय";
 const Thai$1 = "थाई";
 const Filipino$1 = "फिलिपिनो";
 const English$1 = "अंग्रेज़ी";
@@ -13229,12 +13218,11 @@ const hi = {
   Multilingual: Multilingual$1,
   Arabic: Arabic$1,
   Tamil: Tamil$1,
-  Malayalam: Malayalam$1,
+  "Malay / Malayalam": "मलय / मलयालम",
   Telugu: Telugu$1,
   Kannada: Kannada$1,
   Hindi: Hindi$1,
   "Bahasa Indonesia": "बहासा इंडोनेशिया",
-  Malay: Malay$1,
   Thai: Thai$1,
   Filipino: Filipino$1,
   English: English$1,
@@ -13326,11 +13314,9 @@ const Collapse = "Ciutkan";
 const Multilingual = "Multibahasa";
 const Arabic = "Arab";
 const Tamil = "Tamil";
-const Malayalam = "Malayalam";
 const Telugu = "Telugu";
 const Kannada = "Kannada";
 const Hindi = "Hindi";
-const Malay = "Melayu";
 const Thai = "Thai";
 const Filipino = "Filipina";
 const English = "Bahasa Inggris";
@@ -13456,12 +13442,11 @@ const id = {
   Multilingual,
   Arabic,
   Tamil,
-  Malayalam,
+  "Malay / Malayalam": "Melayu / Malayalam",
   Telugu,
   Kannada,
   Hindi,
   "Bahasa Indonesia": "Bahasa Indonesia",
-  Malay,
   Thai,
   Filipino,
   English,
@@ -13534,27 +13519,27 @@ var LanguageCode;
 var TranscriptionLanguageCode;
 (function(TranscriptionLanguageCode2) {
   TranscriptionLanguageCode2["ar"] = "ar";
-  TranscriptionLanguageCode2["en"] = "en";
+  TranscriptionLanguageCode2["ca"] = "ca";
+  TranscriptionLanguageCode2["cs"] = "cs";
   TranscriptionLanguageCode2["de"] = "de";
+  TranscriptionLanguageCode2["en_GB"] = "en_GB";
+  TranscriptionLanguageCode2["en_US"] = "en_US";
   TranscriptionLanguageCode2["es"] = "es";
-  TranscriptionLanguageCode2["fil"] = "fil";
   TranscriptionLanguageCode2["fr"] = "fr";
-  TranscriptionLanguageCode2["id"] = "id";
   TranscriptionLanguageCode2["hi"] = "hi";
+  TranscriptionLanguageCode2["id"] = "id";
+  TranscriptionLanguageCode2["it"] = "it";
   TranscriptionLanguageCode2["ja"] = "ja";
   TranscriptionLanguageCode2["kn"] = "kn";
-  TranscriptionLanguageCode2["ml"] = "ml";
   TranscriptionLanguageCode2["ms"] = "ms";
+  TranscriptionLanguageCode2["pt"] = "pt";
+  TranscriptionLanguageCode2["sv"] = "sv";
   TranscriptionLanguageCode2["ta"] = "ta";
   TranscriptionLanguageCode2["te"] = "te";
   TranscriptionLanguageCode2["th"] = "th";
+  TranscriptionLanguageCode2["ur"] = "ur";
   TranscriptionLanguageCode2["zh"] = "zh";
-  TranscriptionLanguageCode2["it"] = "it";
-  TranscriptionLanguageCode2["pt"] = "pt";
-  TranscriptionLanguageCode2["ca"] = "ca";
-  TranscriptionLanguageCode2["eu"] = "eu";
-  TranscriptionLanguageCode2["gl"] = "gl";
-  TranscriptionLanguageCode2["multilingual"] = "";
+  TranscriptionLanguageCode2["multilingual"] = "multi";
 })(TranscriptionLanguageCode || (TranscriptionLanguageCode = {}));
 LanguageCode.es;
 const languages = [
@@ -13587,25 +13572,31 @@ const languages = [
 const transcriptionLanguages = [
   { label: "Multilingual", value: TranscriptionLanguageCode.multilingual },
   { label: "Español", value: TranscriptionLanguageCode.es },
-  { label: "English", value: TranscriptionLanguageCode.en },
+  {
+    label: "English (US)",
+    value: TranscriptionLanguageCode.en_US
+  },
+  {
+    label: "English (UK)",
+    value: TranscriptionLanguageCode.en_GB
+  },
   { label: "Français", value: TranscriptionLanguageCode.fr },
   { label: "Deutsch", value: TranscriptionLanguageCode.de },
   { label: "Italiano", value: TranscriptionLanguageCode.it },
   { label: "Português", value: TranscriptionLanguageCode.pt },
   { label: "Català", value: TranscriptionLanguageCode.ca },
-  { label: "Euskera", value: TranscriptionLanguageCode.eu },
-  { label: "Galego", value: TranscriptionLanguageCode.gl },
   { label: "Arabic", value: TranscriptionLanguageCode.ar },
+  { label: "Čeština", value: TranscriptionLanguageCode.cs },
   { label: "Bahasa Indonesia", value: TranscriptionLanguageCode.id },
   { label: "Chinese", value: TranscriptionLanguageCode.zh },
-  { label: "Filipino", value: TranscriptionLanguageCode.fil },
   { label: "Hindi", value: TranscriptionLanguageCode.hi },
   { label: "Japanese", value: TranscriptionLanguageCode.ja },
   { label: "Kannada", value: TranscriptionLanguageCode.kn },
-  { label: "Malay", value: TranscriptionLanguageCode.ms },
-  { label: "Malayalam", value: TranscriptionLanguageCode.ml },
+  { label: "Malay / Malayalam", value: TranscriptionLanguageCode.ms },
   { label: "Tamil", value: TranscriptionLanguageCode.ta },
   { label: "Telugu", value: TranscriptionLanguageCode.te },
+  { label: "Urdu", value: TranscriptionLanguageCode.ur },
+  { label: "Svenska", value: TranscriptionLanguageCode.sv },
   { label: "Thai", value: TranscriptionLanguageCode.th }
 ];
 function bind(fn, thisArg) {
@@ -16084,7 +16075,7 @@ const {
   getAdapter,
   mergeConfig: mergeConfig$1
 } = axios;
-const version$1 = "0.0.10";
+const version$1 = "0.0.11";
 const handleApiError = async (error) => {
   return Promise.reject(error);
 };
@@ -16663,7 +16654,7 @@ const SettingsProvider = ({ predefinedLanguage, templateId, toolArgs, children }
       const profile = await SettingsApi.getSettings(templateId, toolArgs);
       const newDictionary = (profile == null ? void 0 : profile[SettingsApiKeys.dictionary]) || [];
       const newLanguage = (profile == null ? void 0 : profile[SettingsApiKeys.language]) || (predefinedLanguage != null ? predefinedLanguage : getUserDefaultLanguage().code);
-      const newTranscriptionLanguage = profile == null ? void 0 : profile[SettingsApiKeys.transcriptionLanguage];
+      const newTranscriptionLanguage = (profile == null ? void 0 : profile[SettingsApiKeys.transcriptionLanguage]) || TranscriptionLanguageCode.multilingual;
       const newSources = Array.isArray(profile == null ? void 0 : profile[SettingsApiKeys.sources]) ? profile[SettingsApiKeys.sources] : null;
       const newAvailableSources = Array.isArray(profile == null ? void 0 : profile[SettingsApiKeys.availableSources]) ? profile[SettingsApiKeys.availableSources] : [];
       const newCustomTemplate = (profile == null ? void 0 : profile[SettingsApiKeys.template]) ? {
@@ -16759,7 +16750,7 @@ const SettingsProvider = ({ predefinedLanguage, templateId, toolArgs, children }
     try {
       setTranscriptionLanguage(lang);
       SettingsCache.getInstance().setTranscriptionLanguage(lang);
-      const dBLanguage = lang === "" ? null : lang;
+      const dBLanguage = lang;
       await SettingsApi.updateSetting(SettingsApiKeys.transcriptionLanguage, dBLanguage);
     } catch (error) {
       logger.settingsError("Error updating transcription language:", error);
@@ -97292,7 +97283,7 @@ const ReportButton = ({ onFillClick }) => {
   };
   return jsxRuntimeExports.jsxs("div", { className: "omniscribe_report-button-container", children: [renderContent(), jsxRuntimeExports.jsx(LoadingModal, { isLoading: transcriptorLoader || generating || loading, message: loading ? "Por favor espera mientras rellenamos con el reporte" : void 0 })] });
 };
-const CustomSelect = ({ options, onChange, selectedNumber = 0 }) => {
+const CustomSelect = ({ options, onChange, selectedNumber = 0, maxVisibleItems }) => {
   const dropdownRef = reactExports.useRef(null);
   const [selected, setSelected] = reactExports.useState(options[selectedNumber]);
   const [isOpen, setIsOpen] = reactExports.useState(false);
@@ -97332,7 +97323,9 @@ const CustomSelect = ({ options, onChange, selectedNumber = 0 }) => {
     height: "calc(var(--spacing) * 5)",
     color: "var(--color-gray-900)",
     marginLeft: "calc(var(--spacing) * 2)"
-  } })] }), isOpen && jsxRuntimeExports.jsx("div", { className: "omniscribe_select-content-container", children: jsxRuntimeExports.jsx("ul", { className: "omniscribe_select-content-ul scrollbar-pretty", children: options.map((option) => {
+  } })] }), isOpen && jsxRuntimeExports.jsx("div", { className: "omniscribe_select-content-container", children: jsxRuntimeExports.jsx("ul", { className: "omniscribe_select-content-ul scrollbar-pretty", style: maxVisibleItems ? {
+    maxHeight: `calc(var(--spacing) * ${maxVisibleItems * 11} + var(--spacing) * 2)`
+  } : void 0, children: options.map((option) => {
     var _a2;
     return jsxRuntimeExports.jsxs("li", { onMouseDown: (e) => {
       e.stopPropagation();
@@ -97777,7 +97770,7 @@ const LanguageSelector = () => {
     const { code: code2 } = await getLanguageByCode(value);
     await updateLanguage(code2);
   };
-  return jsxRuntimeExports.jsx("div", { className: "w-full", "data-testid": "language-selector", children: jsxRuntimeExports.jsx(CustomSelect, { options: langOptions, onChange: handleLanguageChange, selectedNumber, className: "w-full" }) });
+  return jsxRuntimeExports.jsx("div", { className: "w-full", "data-testid": "language-selector", children: jsxRuntimeExports.jsx(CustomSelect, { options: langOptions, onChange: handleLanguageChange, selectedNumber, className: "w-full", maxVisibleItems: 3 }) });
 };
 const TranscriptionLanguageSelector = () => {
   const { updateTranscriptionLanguage, transcriptionLanguage } = useSettingsContext();
@@ -97794,7 +97787,7 @@ const TranscriptionLanguageSelector = () => {
       logger.settingsError("Error updating transcription language:", error);
     }
   };
-  return jsxRuntimeExports.jsx("div", { className: "w-full", "data-testid": "transcription-language-selector", children: jsxRuntimeExports.jsx(CustomSelect, { options: transcriptionLanguageOptions, onChange: handleTranscriptionLanguageChange, selectedNumber: getSelectedIndex, className: "w-full" }) });
+  return jsxRuntimeExports.jsx("div", { className: "w-full", "data-testid": "transcription-language-selector", children: jsxRuntimeExports.jsx(CustomSelect, { options: transcriptionLanguageOptions, onChange: handleTranscriptionLanguageChange, selectedNumber: getSelectedIndex, className: "w-full", maxVisibleItems: 4 }) });
 };
 const ConfigSection = ({ description, children, className = "" }) => {
   return jsxRuntimeExports.jsxs("div", { className: `omniscribe_config-language-section ${className}`.trim(), children: [description && jsxRuntimeExports.jsx("p", { className: "omniscribe_config-subscreen-description", children: description }), children] });