Invox Dictation SDK Version:

Upgrade Guide


Introduction

Version 2.9 introduces an ESM architecture (with ESM and CommonJS entry points) and UI components as named exports. The SDK is distributed via npm, making upgrades straightforward.

Upgrade via npm

To upgrade to the latest version of the SDK, run:

npm update @invox-medical-npm/invox-dictation

Check your current version

To verify which version is installed:

npm list @invox-medical-npm/invox-dictation

Install a specific version

If you need to install a specific version (e.g., to match your server):

npm install @invox-medical-npm/invox-dictation@2.9.39

Breaking changes from v2.8

1. ESM module system

The previous invox.min.js (IIFE) build has been replaced with an ESM bundle:

- <script src="./node_modules/@invox-medical-npm/invox-dictation/dist/libs/invox.min.js"></script>
+ <script type="module">
+   import INVOX from "@invox-medical-npm/invox-dictation";
+ </script>

2. Components are named exports

UI components are now named exports from the package, not global INVOXMDComponent_* variables:

- const bar = INVOXMDComponent_Bar.create("invox-bar");
+ import { BarComponent } from "@invox-medical-npm/invox-dictation";
+ const bar = BarComponent.create("invox-bar");
Old globalNew named export
INVOXMDComponent_BarBarComponent
INVOXMDComponent_DictionaryDictionaryDialog
INVOXMDComponent_TemplatesTemplatesDialog
INVOXMDComponent_TransformationsTransformationsDialog

3. CSS is auto-injected

Separate CSS file imports are no longer needed; styles are injected at runtime:

- <link rel="stylesheet" href="invox-bar-component.css">
+ // No CSS import needed; styles are auto-injected.

4. No opus/ folder copying required

The Opus audio library is bundled within the main ESM module — no manual cp -r step needed.

5. transcriptionServiceUrl is rejected (2.9.1)

From version 2.9.1, INVOX.init(...) rejects transcriptionServiceUrl: the Direct Dictation endpoint is selected by the SDK build. Remove it from your initialization code.

6. The credential must belong to your organization (2.9.39)

From version 2.9.39, organizationId, appId and apiKey are all required in INVOX.init(...) and must belong to the same organization: the credential (appId and apiKey) has to be associated with that organization in the portal. If they do not match, INVOX.Login fails with LOGIN_AUTHORIZATION_REJECTED, a code and text of its own, different from INVALID_CREDENTIALS; the SDK does not say which of the three values is wrong. Update the package to 2.9.39 and ask for the association before deploying: earlier versions stop working with the credentials of the Invox Dictation app once the server check is active.

Migration steps

  1. Update the SDK:
    npm install @invox-medical-npm/invox-dictation
    
  2. Replace script tags with type="module" imports.
  3. Replace component globals with named imports from the package.
  4. Remove CSS link tags for component stylesheets.
  5. Remove opus/ folder copying from your build script.
  6. Test your application thoroughly after migration.

Before upgrading patch versions, check the Changelog for any breaking changes.