Skip to main content
All notable changes to SofIA SDK are documented on this page. The format follows Keep a Changelog and the project adheres to Semantic Versioning.

v1.0.0 — 2025

Release type: Major

Added

  • template prop replaces toolsargs for clinical data schema configuration
  • templateid prop required alongside template for report generation
  • isConfigurable field in template properties to control user customization
  • debug="true" mode with structured console logging prefixed with [Sofia SDK]
  • Automatic chat-only mode when template/templateid are omitted
  • PII masking in debug logs for HIPAA/GDPR compliance
  • Input validation with XSS, SQL injection, and NoSQL injection protection
  • Custom events on web component: handle-report, set-is-open, set-get-last-report

Changed

  • Generate button now requires both template and templateid to appear
  • Template parsing uses three-strategy fallback: JSON.parse → prefix removal → Function eval
  • Error messages now include category suffixes (configError, authError, apiError, settingsError, audioError, storageError, webSocketError)
  • Improved prop validation with detailed console error messages and documentation links

Deprecated

  • toolsargs → use template (will be removed in v2.0)

Removed

  • isonlychat — chat-only mode is now automatic
  • disablegenerate — omit template/templateid instead
  • disableactions — don’t mount the component instead
  • sofiatitle — title is always “SofIA”
  • isscreenloading — not available in Chat-based UI
  • transcriptorselectvalues — no effect
  • renderReportContent — custom rendering not available in Chat UI
  • handleFill — not available in Chat UI
  • toast — no effect

Migration

See the Migration Guide for step-by-step instructions.

v0.0.10 — 2024

Release type: Patch

Added

  • File processing support — SofIA can now process uploaded documents as part of the consultation context
  • Deprecation warnings for legacy props (toolsargs, isonlychat, disableactions, disablegenerate, sofiatitle, isscreenloading, transcriptorselectvalues, handleFill, renderReportContent)
  • isConfigurable property support in template fields

Changed

  • Deprecated props now emit [Sofia SDK] DEPRECATED: warnings in console

v0.0.9 — 2024

Release type: Patch

Added

  • Configurable autosummary — automatic conversation summaries can now be enabled and customized

Changed

  • Internal dependency alignment across all packages

v0.0.8 — 2024

Release type: Patch

Added

  • Version display in settings screen

Changed

  • Internal improvements to settings management

v0.0.7 — 2024

Release type: Patch

Changed

  • Bug fixes and stability improvements
No user-facing changes in this release.

v0.0.6 — 2024

Release type: Patch

Changed

  • Bug fixes and internal improvements
No user-facing changes in this release.

v0.0.5 — 2024

Internal release — no user-facing changes.

v0.0.4 — 2024

Release type: Patch

Changed

  • Initial public release improvements

v0.0.3 — 2024

Release type: Patch

Added

  • Initial public release of SofIA SDK
  • Web component (<sofia-sdk>) with Shadow DOM encapsulation
  • Real-time audio transcription via WebSocket
  • Report generation with LangGraph streaming
  • Framework support: Vanilla JS, React, Angular
  • Bilingual support (English, Spanish)
  • handleReport, setIsOpen, setGetLastReport callbacks
  • Patient data integration via patientdata prop
  • JSON Schema Draft-07 template support