JavaScript

Release notes for all SDK JS versions

v0.18.5

New:

• Added cookie-based authentication in Identify kit

Fixes:

• Improved handling of cases where the Identify service is enabled but not properly configured, preventing errors that occurred when the SDK tried to load an assets list that was empty or in the wrong format.

• Corrected element state when underlying data updates. We fixed a case where the onElementUpdated event didn't reflect the element's new state when the element was closed — the callback could still report open.

• Corrected state recalculation logic when elements transition into an active state. We fixed a problem where events starting from a scheduled state did not fire their update or state-change callbacks when becoming active.

• Ensured onProjectListingsUpdated() returns correct listings. We fixed issues where the callback was triggered again when the app returned to the foreground and where newly created or started events were not reflected in the updated listings.

Migration guide

Cookie-based authentication

The Credentials type now supports both cookie-based and bearer-token authentication:

type Credentials = {
  token: 'cookie' | string;
};

• 'cookie' — use browser cookies

• string — use bearer token (existing behaviour)

If you already use a token string: nothing changes.

To use cookie-based auth:

setCredentials({ token: 'cookie' });

Behaviour

• 'cookie' — SDK uses cookie-based authentication

• string — SDK uses Authorization: Bearer <token>

No API changes, no breaking changes.

v0.18.4

New:

• Support for configuring the title of the iframe in the embedded Experience. The title can be set either through the getExperience() configuration or by using the title attribute on the custom element.

Migration guide

Using npm module:

import { getExperience } from '@monterosa/sdk-launcher-kit';

const experience = getExperience({
  title: 'Experience Title',
});

Using custom element:

<monterosa-experience
  host="..."
  projectId="..."
  title="Experience Title"
></monterosa-experience>

v0.18.3

New

• A new package, @monterosa/sdk-storage-kit, has been introduced. The following storage-related functions have been migrated from @monterosa/sdk-launcher-kit to @monterosa/sdk-storage-kit:

  function setStoragePersistent(persistent: boolean): void;
  async function storageRead(key: string): Promise<string | null>;
  async function storageWrite(key: string, value: string): Promise<void>;
  async function storageRemove(key: string): Promise<void>;
  async function storageClear(): Promise<void>;

Migration guide

Before

import { 
  setStoragePersistent, 
  storageRead, 
  storageWrite, 
  storageRemove, 
  storageClear, 
} from '@monterosa/sdk-launcher-kit';

After

import { 
  setStoragePersistent, 
  storageRead, 
  storageWrite, 
  storageRemove, 
  storageClear, 
} from '@monterosa/sdk-storage-kit';

v0.18.2

Fixes:

• ConnectKit behaviour in Nextjs env

v0.18.1

Fixes:

• A fix to a -1 percentage issue. In rare circumstances SDK was inaccurately calculating vote percentages resulting in one of the answer options getting -1%.

• Percentages calculation approach has been replaced with a different approach based on Hamilton’s method. This method produces fairer results as we illustrate in the table below.

  // Raw votes per answer option
  [88267, 273, 255, 284, 225, 258, 258, 248, 224, 233]
  
  // Total
  90,525
  
  // 2 decimal places precision percentages
  [97.51%, 0.30%, 0.28%, 0.31%, 0.25%, 0.29%, 0.29%, 0.27%, 0.25%, 0.26%]
  
  // Percentages calculation prior to v0.18.1
  [99, 0, 0, 1, 0, 0, 0, 0, 0, 0]
  
  // Percentages calcualtion post v0.18.1
  [98, 1, 0, 1, 0, 0, 0, 0, 0, 0]

v0.18.0

All SDK packages have been re-deployed to the public npmjs.com registry under the @monterosa organisation.

Migration guide

1

Update package names to use the new sdk- prefix, for example:

"@monterosa/sdk-launcher-kit": "0.18.0"

2

Update Import Statements

- import { getExperience } from '@monterosa/launcher-kit';
+ import { getExperience } from '@monterosa/sdk-launcher-kit';

3

Install Updated Packages

npm install
# or
yarn install

4

Remove GitLab Private Registry Configuration

Option 1 - manual

Remove entries manually. Open your local .npmrc file and delete the following lines:

@monterosa-sdk:registry=https://gitlab.com/api/v4/projects/38419920/packages/npm/
//gitlab.com/api/v4/projects/38419920/packages/npm/:_authToken=<package token>

Option 2 - CLI

v0.17.1

Internal package @monterosa-sdk/enmasse renamed to @monterosa-sdk/enmasse-kit

v0.17.0

• Support added for allow attribute in static embed tag. Allows control over enabling browser features within Experience, such as access to the microphone, camera, battery status, and so on.

• Support added for allowFullScreen attribute in static embed tag. Enables full screen mode support for the Experience iframe. This enables older browsers compatibility.

• Added Identify Kit support to the static embed tag. This is a temporary change to simplify migration from some of the previous versions of SDK to this one.

v0.16.16

New:

• Static embedding supports persistentStorage which allows to enable persistent storage

v0.16.15

New:

• Implemented automatic reconnection when the app is brought into the foreground or when the device comes back online

Fixes:

• Event history refetch issue under certain conditions

• Time synchronisation with the server upon connection to Enmasse

v0.16.14

Fixes:

• Invoke onElementPublished() only when event is initialised

• getElements() that returns empty dataset under certain conditions

• Constant disconnect in inactive tabs

• connect() function to re-establish connection after forced disconnect

• Historical events initialisation

v0.16.13

Fixes:

• improved handling of the finished events

v0.16.12

New:

• Adds onEventAdded() and onEventRemoved() functions

Deprecations:

• onEventPublished()

Fixes:

• onElementPublished(), onElementUpdated() and onElementRevoked() for multiple events

v0.16.11

Fixes:

• Avoid server-side rendering errors and warnings

• Avoids raising warnings when the Experience is embedded from a server-side rendering context.