@omniloy/sofia-sdk 0.0.9 → 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