Configuration

Aura Widget supports a multi level configuration architecture.

Sandbox Configuration

The package exposes a configure function to set the sandbox configuration. The widget by default is configured to point to the production sandbox https://anywhere.insighthealth.ai, this allows you to test the widget against any beta environment for testing and development purposes.

import { configure } from '@insight-health/aura';
 
configure({
  insightBaseUrl: 'https://anywhere.lumi.build',
});

Or via the InsightAura.configure method for CDN usage.

InsightAura.configure({
  insightBaseUrl: 'https://anywhere.lumi.build',
});

Configuration Options

Widget Configuration and Initialization

The widget configuration is set using the init method, thats also responsible to for the initial authentication and embedding of the widget. It returns a promise that resolves when the widget is authenticated and ready to use.

import { AuraWidget } from '@insight-health/aura';
 
AuraWidget.init({
  partnerKey: '<partner-key-shared-by-insight-health>',
  tenantId: 'tenant-id',
  tenantName?: 'tenant-name', // Optional
  themeConfig: {
    primary: '#2563eb', // Optional
    secondary: '#7c3aed', // Optional
  },
  user: {
    id: '13',
    email: 'user@example.com',
    firstName: 'John',
    lastName: 'Doe',
  },
});

Or via the AuraWidget.init method for CDN usage.

InsightAura.AuraWidget.init({
  partnerKey: '<partner-key-shared-by-insight-health>',
  // ... similar options as above
});

Configuration Options

User

The user object defines the user’s identity and is used for authentication. This object is used in both init and setUser methods.

Authentication Success

When the widget is successfully authenticated, you can handle this via either a callback or promise-based approach.

Using onAuthenticated callback

AuraWidget.init({
  // ...init options
  onAuthenticated: (response) => {
    console.log('Widget authenticated:', response);
  },
});

Using Promise

const response = await AuraWidget.init({
  // ...init options
});
console.log('Widget authenticated:', response);

Response Payload

Both approaches return the same response payload containing all the options passed to init, plus additional properties:

Show widget

The widget automatically shows itself when a command is sent to the widget after initialization. But you can also show the widget manually using the show method.

AuraWidget.show();

Hide widget

Use the hide method to toggle the widget visibility. This is ideal when navigating between routes or when you want to temporarily hide the widget without destroying it.

AuraWidget.hide();

The widget state is preserved when hidden and can be shown again by sending a command to the widget or by calling the show method.

Reset widget

Use the reset method when you want to completely reset the widget to its initial state.

AuraWidget.reset();

Dynamic User Switching

After the widget is initialized, you can dynamically switch to a different user or tenant using the setUser method. This is useful for scenarios where the authenticated user changes without requiring a full page reload, such as multi-user dashboards or session handoffs.

AuraWidget.setUser({
  tenantId: 'new-tenant-id',
  tenantName: 'New Tenant Name', // Optional
  user: {
    email: 'newuser@example.com',
    firstName: 'Jane',
    lastName: 'Smith',
  },
  language: 'en-US', // Optional
});

Or via the InsightAura.AuraWidget.setUser method for CDN usage.

InsightAura.AuraWidget.setUser({
  tenantId: 'new-tenant-id',
  // ... similar options as above
});

setUser Options

Once the widget is initialized, you can start communicating with the widget through events.