@unblu/embedded-app-component 8.19.1 → 8.21.0

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"
+}

package/dist/lib/shared/model/customaction/custom-action-invocation.d.ts

@@ -0,0 +1,27 @@
+import { PersonInfo } from "../person-info";
+import { ConversationInfo } from "../conversation-info";
+/**
+ * CustomActionInvocation represents an event containing information about the invoked custom action
+ */
+export interface CustomActionInvocation {
+    /**
+     * The invocation ID
+     */
+    invocationId: string;
+    /**
+     * The unique key of the invoked custom action
+     */
+    key: string;
+    /**
+     * UTC timestamp, in milliseconds, of the custom action invocation
+     */
+    invocationTimestamp: number;
+    /**
+     * The person who invoked the custom action
+     */
+    invokingPerson: PersonInfo;
+    /**
+     * The conversation the custom action was invoked in
+     */
+    conversation: ConversationInfo;
+}

package/dist/lib/shared/model/customaction/custom-conversation-action-invocation.d.ts

@@ -0,0 +1,6 @@
+import { CustomActionInvocation } from "./custom-action-invocation";
+/**
+ * Custom conversation action invocation
+ */
+export interface CustomConversationActionInvocation extends CustomActionInvocation {
+}

package/dist/lib/shared/model/customaction/custom-message-action-invocation.d.ts

@@ -0,0 +1,16 @@
+import { CustomActionInvocation } from "./custom-action-invocation";
+import { PersonInfo } from "../person-info";
+import { ConversationMessageInfo } from "../conversation-message-info";
+/**
+ * Custom message action invocation
+ */
+export interface CustomMessageActionInvocation extends CustomActionInvocation {
+    /**
+     * The conversation containing the message that the custom action was invoked on is part of
+     */
+    targetMessage: ConversationMessageInfo;
+    /**
+     * The sender of the message the custom action was invoked on
+     */
+    targetMessageSender: PersonInfo;
+}

package/dist/lib/shared/model/customaction/custom-person-action-invocation.d.ts

@@ -0,0 +1,11 @@
+import { CustomActionInvocation } from "./custom-action-invocation";
+import { PersonInfo } from "../person-info";
+/**
+ * Custom person action invocation
+ */
+export interface CustomPersonActionInvocation extends CustomActionInvocation {
+    /**
+     * The person the custom action was invoked on
+     */
+    targetPerson: PersonInfo;
+}

package/dist/lib/shared/model/new-conversation-interceptor-result.d.ts

@@ -0,0 +1,14 @@
+import { NewConversationRecipient } from "./new-conversation-recipient";
+/**
+ * The result of calling a {@link NewConversationInterceptor}.
+ */
+export interface NewConversationInterceptorResult {
+    /**
+     * Custom visitor data that will be stored on the conversation and can be accessed through the Web API later on. This data won't be displayed anywhere and is for API usage only.
+     */
+    visitorData?: string;
+    /**
+     * The team or agent recipient of the conversation. This overwrites any named area that may be set on the web page.
+     */
+    recipient?: NewConversationRecipient;
+}

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

@@ -0,0 +1,10 @@
+export declare enum NewConversationRecipientType {
+    /**
+     * The recipient type for a conversation is an agent
+     */
+    AGENT = "AGENT",
+    /**
+     * The recipient type for a conversation is a team
+     */
+    TEAM = "TEAM"
+}

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

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

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

@@ -0,0 +1,5 @@
+export interface PersonInfo {
+    id: string;
+    displayName: string;
+    labels: string[];
+}

package/dist/lib/shared/new-conversation-interceptor.d.ts

@@ -0,0 +1,24 @@
+import { ConversationType } from "./model/conversation-type";
+import { NewConversationRecipient } from "./model/new-conversation-recipient";
+import { NewConversationInterceptorResult } from "./model/new-conversation-interceptor-result";
+/**
+ * Interceptor function which is called every time a new conversation is started from the UI or JS API.
+ *
+ * Starting the conversation is deferred until the Promise returned by this interceptor resolves:
+ * - If the interceptor rejects the Promise, starting the conversation will be cancelled.
+ * - If the interceptor resolves the Promise with a String, the value of the String will be used and set as "visitorData" for the conversation created.
+ * - If the interceptor resolves the Promise with a {@link NewConversationInterceptorResult}, the values from it will be used for the "visitorData" and the "recipient" for the conversation created.
+ * - If the resolved value is undefined, the value passed into the {@link UnbluApi.startConversation} method will be used.
+ * - If the resolved value is set to null, any value passed into {@link UnbluApi.startConversation} will be discarded.
+ * - If the resolved value is neither a {@link NewConversationInterceptorResult}, nor a String, nor undefined, the conversation is started without any visitorData.
+ * - If the interceptor resolves the Promise with something other than a {@link NewConversationInterceptorResult} or a String, the conversation is started without any visitorData.
+ *
+ * Any values of {@link NewConversationInterceptorResult} that are undefined are replaced by the corresponding values passed to {@link UnbluApi.startConversation}.
+ * Any values of {@link NewConversationInterceptorResult} that are null discard the corresponding values passed to {@link UnbluApi.startConversation}.
+ *
+ * @param conversationType The type of the conversation being started.
+ * @param visitorData Optional visitorData, only present if passed to the {@link UnbluApi.startConversation} method
+ * @param recipient Optional recipient, only present if passed to the {@link UnbluApi.startConversation} method
+ * @return A Promise deferring the start of the conversation until it resolves.
+ */
+export type NewConversationInterceptor = (conversationType: ConversationType, visitorData?: String, recipient?: NewConversationRecipient) => Promise<String | NewConversationInterceptorResult>;