@telia-ace/websdk-id-container

Common storage for Telia ACE clients.

Overview

The idContainer is a system for storing session ids and other settings, for the sub-functions in ACE Web SDK (Chat, Proactive Web, and Cobrowsing). Instead of just saving to local storage, idContainer can provide a storage that works even if the user navigates over different origins, provided that these origins are declared as a part of the web site solutions.

For simplicity, mostly in development and test scenarios, a version of idContainer that only supports storage for only one origin is also provided.

In the future, even more variants of the idContainer will be realised, since browser behaviour when the user opts in for "Block third-party tracking" restricts the possibilities to share storage between origins.

ACE Web SDK uses the concepts _instance_ and _companyName_. These parameters are provided when an idContainer is created, and that container will not be able to handle data for other instances or companyNames, even if they are on the same origin.

Storage interface

All variants of idContainers implement the same interface (except for the constructors). The interface, idStorage is declared in the file
types.ts. The interface looks like

``
type Ids = {
cobKey: string;
cobPrivateKey: string;
cobAccept: string;
cobWsUrl: string;
cobLang: string;
cobType: string;
chatUid: string;
chatEntrance: string;
PWUID: string;
};

export type eventHandlerFunction = (event: Event) => void;

export interface idStorage {
getIds: () => Promise;
setCobKey: (key: string, lifetime: number) => void;
getCobKey: () => Promise;
setCobPrivateKey: (key: string, lifetime: number) => void;
getCobPrivateKey: () => Promise;
setCobAccept: (value: string, lifetime: number) => void;
getCobAccept: () => Promise;
setCobWsUrl: (value: string, lifetime: number) => void;
getCobWsUrl: () => Promise;
setCobLang: (value: string, lifetime: number) => void;
getCobLang: () => Promise;
setCobType: (value: string, lifetime: number) => void;
getCobType: () => Promise;
setChatUID: (value: string, lifetime: number) => void;
getChatUID: () => Promise;
setChatEntrance: (value: string, lifetime: number) => void;
getChatEntrance: () => Promise;
setPWUID: (value: string, lifetime: number) => void;
getPWUID: () => Promise;
setXDItem: (
client: string,
storageType: 'local' | 'session',
keyName: string,
keyValue: Object
) => void;
getXDItem: (client: string, storageType: 'local' | 'session', keyName: string) => Promise