@unblu/floating-js-api 8.19.1 → 8.20.2

package/dist/lib/shared/internal/module/base-general-module.d.ts

@@ -0,0 +1,35 @@
+import { ApiBridge } from "../api-bridge";
+import { InternalModule } from "./module";
+import { NewConversationInterceptor } from "../../new-conversation-interceptor";
+import { ConversationType } from "../../model/conversation-type";
+import { PersonInfo } from "../../model/person-info";
+import { ConversationInfo } from "../../model/conversation-info";
+import { NewConversationRecipient } from "../../model/new-conversation-recipient";
+export type BaseGeneralEventType = 'activeConversationChange' | 'conversationsChange' | 'notificationCountChange' | 'personChange' | 'personActivity';
+export declare enum BaseGeneralFunction {
+    startConversation = "startConversation",
+    setNewConversationInterceptor = "setNewConversationInterceptor",
+    joinConversation = "joinConversation",
+    openConversation = "openConversation",
+    getActiveConversation = "getActiveConversation",
+    getConversations = "getConversations",
+    getNotificationCount = "getNotificationCount",
+    getPersonInfo = "getPersonInfo",
+    setPersonNickname = "setPersonNickname",
+    addPersonLabel = "addPersonLabel",
+    removePersonLabel = "removePersonLabel"
+}
+export declare class BaseGeneralModule<T extends string | BaseGeneralFunction, E extends BaseGeneralEventType | string> extends InternalModule<BaseGeneralFunction | T, E> {
+    constructor(bridge: ApiBridge);
+    startConversation(type: ConversationType, visitorName?: string, visitorData?: string, recipient?: NewConversationRecipient, languageTag?: string): Promise<string>;
+    setNewConversationInterceptor(callback: NewConversationInterceptor): Promise<void>;
+    joinConversation(pin: string, visitorName?: string): Promise<string>;
+    openConversation(conversationId: string): Promise<void>;
+    getActiveConversation(): Promise<string | null>;
+    getConversations(): Promise<ConversationInfo[]>;
+    getNotificationCount(): Promise<number>;
+    getPersonInfo(): Promise<PersonInfo>;
+    setPersonNickname(nickname: string): Promise<void>;
+    addPersonLabel(labelName: string): Promise<void>;
+    removePersonLabel(labelName: string): Promise<void>;
+}

package/dist/lib/shared/internal/module/conversation-module.d.ts

@@ -0,0 +1,64 @@
+import { InternalModule } from './module';
+import { ApiBridge } from '../api-bridge';
+import { CallState } from '../../model/call-state';
+import { ConversationState } from '../../model/conversation-state';
+import { ConnectionState } from '../../model/connection-state';
+import { CallConnectionState } from "../../model/call-connection-state";
+export interface ConversationCallState {
+    conversationId: string;
+    callState: CallState;
+}
+export interface ConversationConnectionState {
+    conversationId: string;
+    connectionState: ConnectionState;
+}
+export interface ConversationWithState {
+    conversationId: string;
+    conversationState: ConversationState;
+}
+export interface ConversationQueueStatus {
+    conversationId: string;
+    /**
+     * Current position in the queue, can be null or left out if feature is disabled
+     */
+    position?: number | null;
+    /**
+     * Calculated waiting time in milliseconds, can be null or left out if feature is disabled
+     */
+    averageWaitingTime?: number | null;
+}
+export interface ConversationCallConnectionState {
+    conversationId: string;
+    callConnectionState: ConversationState;
+}
+export type ConversationEventType = 'connectionStateChange' | 'conversationStateChange' | 'end' | 'close' | 'personChange' | 'callStateChange' | 'invitationsChange' | 'customActionInvocation' | 'queueStatusChange' | 'callConnectionStateChange';
+declare const enum ConversationFunction {
+    getConnectionState = "getConnectionState",
+    getConversationState = "getConversationState",
+    getCallState = "getCallState",
+    startAudioCall = "startAudioCall",
+    startVideoCall = "startVideoCall",
+    endConversation = "endConversation",
+    leaveConversation = "leaveConversation",
+    closeConversation = "closeConversation",
+    setVisitorData = "setVisitorData",
+    getVisitorData = "getVisitorData",
+    getQueueStatus = "getQueueStatus",
+    getCallConnectionState = "getCallConnectionState"
+}
+export declare class ConversationModule extends InternalModule<ConversationFunction, ConversationEventType> {
+    constructor(bridge: ApiBridge);
+    getConnectionState(conversationId: string): Promise<ConnectionState>;
+    getConversationState(conversationId: string): Promise<ConversationState>;
+    getCallState(conversationId: string): Promise<CallState>;
+    startAudioCall(conversationId: string): Promise<void>;
+    startVideoCall(conversationId: string): Promise<void>;
+    endConversation(conversationId: string): Promise<void>;
+    leaveConversation(conversationId: string): Promise<void>;
+    closeConversation(conversationId: string): Promise<void>;
+    setVisitorData(visitorData: String): Promise<void>;
+    getVisitorData(): Promise<String>;
+    getQueueStatus(conversationId: string): Promise<ConversationQueueStatus>;
+    getCallConnectionState(conversationId: string): Promise<CallConnectionState>;
+}
+export {};

package/dist/lib/shared/internal/module/module.d.ts

@@ -0,0 +1,10 @@
+import { ApiBridge } from '../api-bridge';
+import { EventCallback } from '../event';
+export declare class InternalModule<T extends string, E extends string> {
+    private bridge;
+    moduleName: string;
+    constructor(bridge: ApiBridge, moduleName: string);
+    protected callApiFunction(functionName: T, args: any[]): Promise<any>;
+    on(eventName: E, listener: EventCallback): Promise<void>;
+    off(eventName: E, listener: EventCallback): Promise<void>;
+}

package/dist/lib/shared/internal/unblu-floating-api.d.ts

@@ -0,0 +1,15 @@
+import { ApiState } from "../api-state";
+import { InitializedUnbluApi } from "./initialized-unblu-api";
+/**
+ * @hidden
+ */
+export declare interface UnbluFloatingApi {
+    api: UnbluFloatingApiFactory;
+}
+/**
+ * @hidden
+ */
+export declare interface UnbluFloatingApiFactory {
+    initialize(): Promise<InitializedUnbluApi>;
+    getApiState(): ApiState;
+}

package/dist/lib/shared/internal/unblu-util.d.ts

@@ -0,0 +1,76 @@
+import { InitializedUnbluElement } from "./initialized-unblu-element";
+import { Configuration } from "../model/configuration";
+import { UnbluFloatingApi } from "./unblu-floating-api";
+export declare enum IntegrationType {
+    embedded = "embedded",
+    floating = "floating",
+    branchClient = "branch-client"
+}
+declare enum EntryPoint {
+    siteIntegrationGreedyMain = "SiteIntegrationGreedyMain",
+    siteIntegrationLazyMain = "SiteIntegrationLazyMain",
+    siteEmbeddedMain = "SiteEmbeddedMain",
+    branchClientMain = "BranchClientMain"
+}
+/**
+ * Internal type definition of the unblu object.
+ */
+export interface UnbluObject {
+    floating?: UnbluFloatingApi;
+    /**
+     * internal unblu field
+     * @hidden
+     */
+    APIKEY?: string;
+    /**
+     * internal unblu field
+     * @hidden
+     */
+    BRANCHCLIENTTOKEN?: string;
+    /**
+     * internal unblu field
+     * @hidden
+     */
+    SERVER?: string;
+    /**
+     * internal unblu field
+     * @hidden
+     */
+    l?: string;
+    /**
+     * internal unblu field
+     * @hidden
+     */
+    entryPoint?: EntryPoint;
+    /**
+     * internal unblu field
+     * @hidden
+     */
+    globalPrefix?: string;
+    /**
+     * internal unblu field
+     * @hidden
+     */
+    'embedded-internal-element'?: InitializedUnbluElement | null;
+}
+export declare class UnbluUtil {
+    static loadScript(uri: string, timeout: number): Promise<void>;
+    static getNamedArea(): string | undefined;
+    static setNamedArea(namedArea: string): void;
+    static removeNamedArea(): void;
+    static setLocale(locale: string): void;
+    static loginWithSecureToken(serverUrl: string, apiKey: string, entryPath: string, accessToken: string): Promise<void>;
+    static isAuthenticated(serverUrl: string, entryPath: string): Promise<boolean>;
+    static logout(serverUrl: string, entryPath: string): Promise<void>;
+    static isUnbluLoaded(integrationType: IntegrationType): boolean;
+    static generateConfigurationFromLoadedUnblu(): Configuration;
+    private static entryPointMatches;
+    static getUnbluObject(): UnbluObject;
+    static createUnbluObject(): UnbluObject;
+    static getOrCreateUnbluObject(): UnbluObject;
+    static deinitializeFloatingIfNeeded(): Promise<void>;
+    static deinitializeEmbeddedIfNeeded(excludedAppElement?: InitializedUnbluElement): Promise<void>;
+    static deinitializeBranchClientIfNeeded(excludedAppElement?: InitializedUnbluElement): Promise<void>;
+    static sanitizeParameter(param: string): string;
+}
+export {};

package/dist/lib/shared/internal/util/event-emitter.d.ts

@@ -0,0 +1,44 @@
+export type Listener = (data?: any) => void;
+export declare class EventEmitter {
+    private listeners;
+    /**
+     * Resets the emitter by removing all registered listeners.
+     */
+    reset(): void;
+    /**
+     * Adds an event listeners
+     * @param event the event to listen to
+     * @param listener the listener to be called.
+     */
+    on(event: string, listener: Listener): void;
+    /**
+     * removes a previously registered listener
+     * @param event the event
+     * @param listener the listener that should be removed.
+     * @return `true` if the listener was removed, `false` otherwise.
+     */
+    off(event: string, listener: any): boolean;
+    /**
+     * removes all listeners for the given event.
+     * @param event the event for which all listeners will be removed.
+     */
+    offAll(event: string): void;
+    /**
+     * Checks weather at least one listener exists for a given event.
+     * @param event the event to check for
+     * @return weather or not any listeners for the given event are registered.
+     */
+    hasListeners(event: string): boolean;
+    /**
+     * Returns all events that have at least one listeners registered to them.
+     * @return An array containing all events that have at least one listener.
+     * If no listeners are registered at all, an empty array will be returned.
+     */
+    getEventsWithListeners(): string[];
+    /**
+     * Emits an event dispatching it to all listeners registered for it.
+     * @param event the event name.
+     * @param data the event data.
+     */
+    emit(event: string, data?: any): void;
+}

package/dist/lib/shared/model/agent-availability-state.d.ts

@@ -0,0 +1,18 @@
+export declare enum AgentAvailabilityState {
+    /**
+     * There is at least one agent available for the specified named area and locale.
+     */
+    AVAILABLE = "AVAILABLE",
+    /**
+     * There is at least one agent watching the inbound queue for the specified named area and locale but the max capacity of parallel conversations is reached.
+     *
+     * It is very likely, that an agent will be available in a short time.
+     */
+    BUSY = "BUSY",
+    /**
+     * There is currently no agent handling any inbound queue items.
+     *
+     * It is very unlikely, that an agent will be available in a short time.
+     */
+    UNAVAILABLE = "UNAVAILABLE"
+}

package/dist/lib/shared/model/branchclient/language.d.ts

@@ -0,0 +1,14 @@
+export interface Language {
+    /**
+     * BCP 47 language tag representation
+     */
+    languageTag: string;
+    /**
+     * Name of the language in the current locale
+     */
+    name: string;
+    /**
+     * Native name of the language localized with the language of this instance
+     */
+    nativeName: string;
+}

package/dist/lib/shared/model/branchclient/named-area-agent-availability.d.ts

@@ -0,0 +1,19 @@
+import { AgentAvailabilityState } from "../agent-availability-state";
+export interface NamedAreaAgentAvailability {
+    /**
+     * Display name of named area
+     */
+    displayName: string;
+    /**
+     * Description of named area
+     */
+    description: string;
+    /**
+     * Site ID of named area
+     */
+    namedAreaSiteId: string;
+    /**
+     * Agent availability state of named area
+     */
+    availability: AgentAvailabilityState;
+}

package/dist/lib/shared/model/call-connection-state.d.ts

@@ -0,0 +1,18 @@
+export declare enum CallConnectionState {
+    /**
+     * Call is connecting to call service
+     */
+    CONNECTING = "CONNECTING",
+    /**
+     * Call is connected to call service
+     */
+    CONNECTED = "CONNECTED",
+    /**
+     * Call is reconnecting to call service, possibly due to poor internet connectivity
+     */
+    RECONNECTING = "RECONNECTING",
+    /**
+     * Call is disconnected, either because there is no call in the conversation or it isn't joined
+     */
+    DISCONNECTED = "DISCONNECTED"
+}

package/dist/lib/shared/model/call-state.d.ts

@@ -0,0 +1,30 @@
+export declare enum CallState {
+    /**
+     * A some one is trying to call, the phone is ringing
+     */
+    INBOUND = "INBOUND",
+    /**
+     * You are trying to call someone
+     */
+    OUTBOUND = "OUTBOUND",
+    /**
+     * A call is active and the local tab is connected to the call, however there is currently no other participant in the call.
+     */
+    ACTIVE_JOINED_ALONE = "ACTIVE_JOINED_ALONE",
+    /**
+     * A call is active and the local tab is connected to the call and there is at least one other participant to which the connection is established.
+     */
+    ACTIVE_JOINED = "ACTIVE_JOINED",
+    /**
+     * A call is active but the local person has declined it.
+     */
+    ACTIVE_NOT_JOINED = "ACTIVE_NOT_JOINED",
+    /**
+     * A call is active and the local person has joined it on an other device.
+     */
+    ACTIVE_JOINED_ELSEWHERE = "ACTIVE_JOINED_ELSEWHERE",
+    /**
+     * No inbound, outgoing or active call.
+     */
+    NONE = "NONE"
+}

package/dist/lib/shared/model/configuration.d.ts

@@ -0,0 +1,53 @@
+export interface Configuration {
+    /**
+     * The API key to use.
+     * This is a mandatory configuration.
+     *
+     * You can retrieve API keys from the Account Configuration interface.
+     * This requires the `ADMIN` user role.
+     */
+    apiKey: string;
+    /**
+     * The BranchClient token to use.
+     * This is a mandatory configuration for the branch client. When branch clients are defined in the branch client
+     * configuration on the collaboration server, the token will be generated and can be retrieved from there.
+     *
+     */
+    branchClientToken?: string;
+    /**
+     * The URL of the Unblu server to connect to.
+     *
+     * @default If not set, the domain of the current page is used.
+     */
+    serverUrl?: string;
+    /**
+     * The public path used with {@link serverUrl} to connect to Unblu.
+     *
+     * @default If not set, '/unblu' is used.
+     */
+    entryPath?: string;
+    /**
+     * The locale to use for all Unblu translation texts.
+     *
+     * @default If not set, the browser's locale will be used.
+     */
+    locale?: string;
+    /**
+     * The named area to be used.
+     * The named area determines the queue that conversation requests go to, the agent availability, and the configuration.
+     *
+     * @default If not set, the named area specified in the HTML `meta` element named `unblu:named-area` is used.
+     * If no such element is present, the named area associated with the current domain is used.
+     */
+    namedArea?: string;
+    /**
+     * The timeout in milliseconds for the Unblu integration to load.
+     *
+     * @default 30'000 (30 seconds)
+     */
+    initTimeout?: number;
+    /**
+     * The access token used to log the user in before initializing Unblu.
+     */
+    accessToken?: string;
+}

package/dist/lib/shared/model/connection-state.d.ts

@@ -0,0 +1,27 @@
+export declare enum ConnectionState {
+    /**
+     * Initial state before connection establishment has started
+     */
+    INITIAL = "INITIAL",
+    /**
+     * State during the first connection to the server
+     */
+    CONNECTING = "CONNECTING",
+    /**
+     * The connection has been successfully established.
+     */
+    CONNECTED = "CONNECTED",
+    /**
+     * The connection has been lost, reconnect is active.
+     */
+    RECONNECTING = "RECONNECTING",
+    /**
+     * The connection has been successfully closed.
+     *
+     */
+    CLOSED = "CLOSED",
+    /**
+     * A fatal error has occurred. The connection has been permanently lost. No reconnect will be be possible.
+     */
+    ERROR = "ERROR"
+}

package/dist/lib/shared/model/conversation-info.d.ts

@@ -0,0 +1,42 @@
+import { ConversationRecipient } from "./conversation-recipient";
+import { ConversationParticipationType } from "./conversation-participation-type";
+import { ConversationParticipant } from "./conversation-participant";
+import { ConversationState } from "./conversation-state";
+export interface ConversationInfo {
+    /**
+     * The ID of the conversation.
+     */
+    id: string;
+    /**
+     * Conversation state.
+     */
+    state: ConversationState;
+    /**
+     * Conversation creation timestamp in milliseconds elapsed since January 1, 1970 00:00:00 UTC.
+     */
+    creationTimestamp: number;
+    /**
+     * Notification count of this conversation.
+     */
+    notificationCount: number;
+    /**
+     * Participation type of the current person in this conversation
+     */
+    myParticipationType: ConversationParticipationType;
+    /**
+     * All other participants of this conversation
+     */
+    otherParticipants: [ConversationParticipant];
+    /**
+     * The current recipient of this conversation
+     */
+    recipient: ConversationRecipient;
+    /**
+     * Topic of this conversation; null if not set
+     */
+    topic?: string;
+    /**
+     * The custom visitor data of the conversation. Null if not set.
+     */
+    visitorData?: string;
+}

package/dist/lib/shared/model/conversation-message-info.d.ts

@@ -0,0 +1,14 @@
+export interface ConversationMessageInfo {
+    /**
+    * ID of the conversation message
+    */
+    id: string;
+    /**
+    * Type of the conversation message
+    */
+    type: string;
+    /**
+    * Text content of the conversation message
+    */
+    text: string;
+}

package/dist/lib/shared/model/conversation-participant.d.ts

@@ -0,0 +1,15 @@
+import { ConversationParticipationType } from "./conversation-participation-type";
+export interface ConversationParticipant {
+    /**
+     * Person ID of the participant
+     */
+    personId: string;
+    /**
+     * Name of the participant
+     */
+    name: string;
+    /**
+     * Participation type of the participant
+     */
+    participationType: ConversationParticipationType;
+}

package/dist/lib/shared/model/conversation-participation-type.d.ts

@@ -0,0 +1,18 @@
+export declare enum ConversationParticipationType {
+    /**
+     * The main agent of the conversation. There can only be one per conversation at any given point in time.
+     */
+    ASSIGNED_AGENT = "ASSIGNED_AGENT",
+    /**
+     * The main visitor of the conversation. There can only be one per conversation at any given point in time.
+     */
+    CONTEXT_PERSON = "CONTEXT_PERSON",
+    /**
+     * A secondary agent. Multiple instances per conversation possible.
+     */
+    SECONDARY_AGENT = "SECONDARY_AGENT",
+    /**
+     * A secondary visitor. Multiple instances per conversation possible.
+     */
+    SECONDARY_VISITOR = "SECONDARY_VISITOR"
+}

package/dist/lib/shared/model/conversation-recipient-type.d.ts

@@ -0,0 +1,18 @@
+export declare enum ConversationRecipientType {
+    /**
+     * The recipient type for a conversation is the account
+     */
+    ACCOUNT = "ACCOUNT",
+    /**
+     * The recipient type for a conversation is a named area
+     */
+    NAMED_AREA = "NAMED_AREA",
+    /**
+     * The recipient type for a conversation is a team
+     */
+    TEAM = "TEAM",
+    /**
+     * The recipient type for a conversation is an agent
+     */
+    AGENT = "AGENT"
+}

package/dist/lib/shared/model/conversation-recipient.d.ts

@@ -0,0 +1,18 @@
+import { ConversationRecipientType } from "./conversation-recipient-type";
+/**
+ * The recipient of a conversation
+ */
+export interface ConversationRecipient {
+    /**
+     * The ID of the recipient. Depending on the type, this either refers to an agent person ID or to a team ID
+     */
+    id: string;
+    /**
+     * The recipient type
+     */
+    recipientType: ConversationRecipientType;
+    /**
+     * The name of the recipient
+     */
+    name: string;
+}

package/dist/lib/shared/model/conversation-state.d.ts

@@ -0,0 +1,37 @@
+export declare enum ConversationState {
+    /**
+     * Initial state of a conversation
+     */
+    CREATED = "CREATED",
+    /**
+     * Depending of the engagement type of the conversation, the conversation stays in the onboarding state as long as the person in the center of the conversation
+     * is doing his onboarding
+     */
+    ONBOARDING = "ONBOARDING",
+    /**
+     * When a message is send to an unassigned conversation, the conversation first is put into the reboarding state as long as the person in the center of the
+     * conversation is doing the reboarding.
+     */
+    REBOARDING = "REBOARDING",
+    /**
+     * Depending of the engagement type of the conversation, the conversation is put in the queued state when it is inside the queue.
+     */
+    QUEUED = "QUEUED",
+    /**
+     * Conversation is active
+     */
+    ACTIVE = "ACTIVE",
+    /**
+     * After there is no assignee of a conversation anymore, the conversation goes to unassigned state until a message from a visitor is written to start reboarding
+     * again.
+     */
+    UNASSIGNED = "UNASSIGNED",
+    /**
+     * Conversation is being ended
+     */
+    OFFBOARDING = "OFFBOARDING",
+    /**
+     * Conversation is ended
+     */
+    ENDED = "ENDED"
+}

package/dist/lib/shared/model/conversation-type.d.ts

@@ -0,0 +1,47 @@
+export declare enum ConversationType {
+    /**
+     * (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation.
+     */
+    CHAT_REQUEST = "CHAT_REQUEST",
+    /**
+     * (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation while all agents are offline.
+     */
+    OFFLINE_CHAT_REQUEST = "OFFLINE_CHAT_REQUEST",
+    /**
+     * (Visitor initiated, visitor centered) A visitor creates an incoming video conversation.
+     */
+    VIDEO_REQUEST = "VIDEO_REQUEST",
+    /**
+     * (Visitor initiated, visitor centered) A visitor creates an incoming audio conversation.
+     */
+    AUDIO_REQUEST = "AUDIO_REQUEST",
+    /**
+     * (Visitor initiated, visitor centered) A visitor creates an incoming universal co-browsing conversation.
+     */
+    HEADLESS_BROWSER_REQUEST = "HEADLESS_BROWSER_REQUEST",
+    /**
+     * (Visitor initiated, visitor centered) A visitor creates an incoming embedded co-browsing conversation.
+     */
+    DOMCAP_BROWSER_REQUEST = "DOMCAP_BROWSER_REQUEST",
+    /**
+     * (Visitor initiated, visitor centered) A visitor creates an incoming mobile co-browsing conversation.
+     */
+    MOBILE_COBROWSING_REQUEST = "MOBILE_COBROWSING_REQUEST",
+    /**
+     * (Visitor initiated, visitor centered) A visitor creates an incoming whiteboard conversation.
+     */
+    WHITEBOARD_REQUEST = "WHITEBOARD_REQUEST",
+    /**
+     * (Visitor initiated, visitor centered) A visitor creates an incoming screen sharing conversation.
+     */
+    SCREEN_SHARING_REQUEST = "SCREEN_SHARING_REQUEST",
+    /**
+     * (Api initiated, visitor centered) A visitor creates a conversation via API which is not added to the queue and where he can invite other visitor to do
+     * embedded
+     */
+    VISITOR_COBROWSING = "VISITOR_COBROWSING",
+    /**
+     * (Visitor initiated, visitor centered) A visitor creates an incoming branch client conversation.
+     */
+    BRANCH_CLIENT_REQUEST = "BRANCH_CLIENT_REQUEST"
+}