Saltar al contenido principal
SofIA SDK está disponible como un paquete npm que puede integrarse en proyectos web modernos. Elija el método de instalación que mejor se adapte a su entorno de desarrollo.

Métodos de instalación

Opción 1: NPM/Yarn (Recomendado)

Esta es la opción recomendada para la mayoría de proyectos que utilizan bundlers modernos como Webpack, Vite, o similares.

Instalación con NPM

npm install @omniloy/sofia-sdk

Instalación con Yarn

yarn add @omniloy/sofia-sdk

Importación en su proyecto

// En su archivo principal (main.js, app.js, index.js, etc.)
import '@omniloy/sofia-sdk';
Una vez importado, el componente <sofia-sdk> estará disponible globalmente en toda su aplicación.

Opción 2: CDN

Ideal para prototipado rápido, desarrollo sin bundler, o integración en sistemas legacy.
<script src="https://unpkg.com/@omniloy/sofia-sdk@latest/dist/webcomponents.umd.js"></script>

Para versión específica

<script src="https://unpkg.com/@omniloy/sofia-sdk@1.0.0/dist/webcomponents.umd.js"></script>

Opción 3: Build manual

Para proyectos con pipelines de build personalizados que ya tienen el paquete instalado vía npm.
<script src="/dist/webcomponents.umd.js"></script>

Verificación de instalación

Después de la instalación, puede verificar que el componente está disponible:

En el navegador

Abra las herramientas de desarrollador y ejecute:
console.log(customElements.get('sofia-sdk'));
Debería mostrar la definición del componente en lugar de undefined.

En su HTML

Pruebe añadir el componente básico:
<sofia-sdk></sofia-sdk>
Si la instalación fue exitosa, verá un mensaje indicando que faltan propiedades requeridas.

Compatibilidad

  • Chrome: 54+
  • Firefox: 63+
  • Safari: 10.1+
  • Edge: 79+

Frameworks compatibles

  • Vanilla JavaScript: Compatibilidad completa
  • React: Soporte nativo para Web Components
  • Angular: CUSTOM_ELEMENTS_SCHEMA requerido
  • Vue.js: Configuración adicional necesaria
  • Svelte: Compilador compatible

Requisitos del entorno

Protocolo HTTPS

SofIA SDK requiere HTTPS para funcionalidades de audio y micrófono:
  • Desarrollo local: https://localhost o use herramientas como local-ssl-proxy
  • Producción: Certificado SSL válido obligatorio

Content Security Policy (CSP)

Si su aplicación usa CSP, añada las siguientes directivas:
connect-src 'self' https://*.omniloy.com wss://*.omniloy.com;
script-src 'self' 'unsafe-inline' https://unpkg.com;

Solución de problemas comunes

El componente no se carga

  1. Verifique que la importación esté en el archivo principal
  2. Confirme que no hay errores en la consola del navegador
  3. Verifique la conectividad de red si usa CDN

Errores de CORS

  • Asegúrese de servir su aplicación desde HTTPS
  • Verifique que las URLs de baseUrl y wssUrl sean correctas

Componente no definido

// Espere a que el componente esté definido
customElements.whenDefined('sofia-sdk').then(() => {
  console.log('SofIA SDK está listo');
});

Próximos pasos

Una vez completada la instalación:
  1. Propiedades requeridas: Configure los parámetros obligatorios
  2. Propiedades opcionales: Personalice el comportamiento
  3. Esquemas de datos clínicos: Defina la estructura de datos a generar