@unblu/embedded-app-component 8.19.1 → 8.21.0

package/dist/lib/shared/unblu-api-error.d.ts

@@ -0,0 +1,117 @@
+/**
+ * Type of an unblu error. This can be used to check what kind of error occurred.
+ */
+export declare enum UnbluErrorType {
+    /**
+     * Thrown if the browser is not supported by unblu.
+     */
+    UNSUPPORTED_BROWSER = "UNSUPPORTED_BROWSER",
+    /**
+     * Thrown if the initialization of the unblu API failed due to a timeout.
+     */
+    INITIALIZATION_TIMEOUT = "INITIALIZATION_TIMEOUT",
+    /**
+     * Thrown if the initialization is called with no existing snippet and no configuration.
+     */
+    CONFIGURATION_MISSING = "CONFIGURATION_MISSING",
+    /**
+     * Thrown if the login against the Unblu collaboration server failed.
+     */
+    AUTHENTICATION_FAILED = "AUTHENTICATION_FAILED",
+    /**
+     * Thrown during initialization if the snippet can't be loaded or unblu can't be initialized from the snippet.
+     */
+    ERROR_LOADING_UNBLU = "ERROR_LOADING_UNBLU",
+    /**
+     * Thrown if the unblu JS API is not compatible with the unblu collaboration server.
+     */
+    INCOMPATIBLE_UNBLU_VERSION = "INCOMPATIBLE_UNBLU_VERSION",
+    /**
+     * Thrown if a function call was invalid.
+     * This is usually do to an incompatibility between the unblu JS API and the unblu collaboration server.
+     */
+    INVALID_FUNCTION_CALL = "INVALID_FUNCTION_CALL",
+    /**
+     * Thrown if the arguments passed to a function where invalid.
+     */
+    INVALID_FUNCTION_ARGUMENTS = "INVALID_FUNCTION_ARGUMENTS",
+    /**
+     * Thrown if a called action is not permitted for the local person.
+     * The details message usually has more information about the required permissions.
+     */
+    ACTION_NOT_GRANTED = "ACTION_NOT_GRANTED",
+    /**
+     * Thrown if an unexpected exception occurrs during a function execution.
+     */
+    EXECUTION_EXCEPTION = "EXECUTION_EXCEPTION",
+    /**
+     * Thrown if a method is called in an invalid context. E.g. if the Object called upon was already destroyed.
+     */
+    ILLEGAL_STATE = "ILLEGAL_STATE",
+    /**
+    * Thrown if a timeout ocurrs.
+    */
+    TIMEOUT = "TIMEOUT"
+}
+/**
+ * General unblu JS API error class that will be thrown whenever something goes wrong.
+ *
+ * - Use the {@link UnbluApiError.type} to check what kind of error occurred.
+ * - Use the {@link UnbluApiError.detail} for human readable details.
+ *
+ * Check the documentation of {@link UnbluErrorType} for more details on the different error types.
+ *
+ * Example for the Floating API:
+ * ```ts
+ * unblu.floating.api.initialize().then(api => {
+ *      // use the api
+ * }).catch(e => {
+ *     if(e.type === 'INITIALIZATION_TIMEOUT') {
+ *          //retry
+ *     } else if(e.type === 'UNSUPPORTED_BROWSER') {
+ *          // display unsupported browser dialog
+ *     } else {
+ *          // show generic error message
+ *     }
+ * })
+ * ```
+ *
+ * or using async / await:
+ *
+ * ```ts
+ * try {
+ *     const api = await unblu.floating.api.initialize()
+ *     // use the api
+ * } catch(e) {
+ *     if(e.type === 'INITIALIZATION_TIMEOUT') {
+ *          //retry
+ *     } else if(e.type === 'UNSUPPORTED_BROWSER') {
+ *          // display unsupported browser dialog
+ *     } else {
+ *          // show generic error message
+ *     }
+ * }
+ * ```
+ *
+ *
+ * The error types may either be checked via their constant string values or via the UnbluErrorType enum:
+ *
+ * ```ts
+ * // using string constant
+ * function isTimeout(e: UnbluApiError) {
+ *  return e.type === 'INITIALIZATION_TIMEOUT'
+ * }
+ * ```
+ * ```ts
+ * // using the enum
+ * function isTimeout(e: UnbluApiError) {
+ *  return e.type === window.unblu.UnbluErrorType.INITIALIZATION_TIMEOUT
+ * }
+ * ```
+ *
+ */
+export declare class UnbluApiError extends Error {
+    type: UnbluErrorType;
+    detail: string;
+    constructor(type: UnbluErrorType, detail: string);
+}

package/dist/lib/unblu-embedded-api.d.ts

@@ -0,0 +1,554 @@
+import { InitializedUnbluApi } from "./shared/internal/initialized-unblu-api";
+import { Conversation } from "./shared/conversation";
+import { ConversationInfo } from "./shared/model/conversation-info";
+import { PersonInfo } from "./shared/model/person-info";
+import { AgentAvailabilityState } from "./shared/model/agent-availability-state";
+import { AgentAvailabilityEventType } from "./shared/internal/module/agent-availability-module";
+import { InternalEmbeddedApi } from "./internal/internal-embedded-api";
+import { EmbeddedMetaEventType } from "./internal/module/embedded-meta-module";
+import { ViewMode } from "./view-mode";
+import { NewConversationInterceptor } from "./shared/new-conversation-interceptor";
+import { ConversationType } from "./shared/model/conversation-type";
+import { GeneralEventType } from "./internal/module/general-module";
+import { NewConversationRecipient } from "./shared/model/new-conversation-recipient";
+import { DestroyOptions } from "./shared/internal/model/destroy-options";
+/**
+ * Listener called whenever the active conversation changes.
+ *
+ * **Note:** If no conversation is currently active the passed conversation object will be `null`
+ * @param conversation API object for the active conversation or `null` if no conversation is active.
+ *
+ * @see {@link  UnbluEmbeddedApi.ACTIVE_CONVERSATION_CHANGE}
+ * @see {@link UnbluEmbeddedApi.on} to register for the event
+ * @see {@link UnbluEmbeddedApi.off} to unregister from the event
+ * @see {@link ActiveConversationChangeEvent} for the corresponding custom event on the {@link UnbluEmbeddedAppElement}
+ */
+export type ActiveConversationChangeListener = (conversation?: Conversation) => void;
+/**
+ * Listener called whenever a conversation changed, added or removed from all conversations.
+ * @param conversations All conversations of the current visitor.
+ *
+ * @see {@link UnbluEmbeddedApi.CONVERSATIONS_CHANGE}
+ * @see {@link UnbluEmbeddedApi.on} to register for the event
+ * @see {@link UnbluEmbeddedApi.off} to unregister from the event
+ */
+export type ConversationsChangeListener = (conversations: ConversationInfo[]) => void;
+/**
+ * Listener called whenever the notification count of a person (i.e. unread messages) changes.
+ * @param count The number of unseen notifications.
+ *
+ * @see {@link UnbluEmbeddedApi.NOTIFICATION_COUNT_CHANGE}
+ * @see {@link UnbluEmbeddedApi.on} to register for the event
+ * @see {@link UnbluEmbeddedApi.off} to unregister from the event
+ */
+export type NotificationCountChangeListener = (count: number) => void;
+/**
+ * Listener called whenever the local person changes.
+ * @param person Info about the person.
+ *
+ * @see {@link UnbluEmbeddedApi.PERSON_CHANGE}
+ * @see {@link UnbluEmbeddedApi.on} to register for the event
+ * @see {@link UnbluEmbeddedApi.off} to unregister from the event
+ */
+export type PersonChangeListener = (person: PersonInfo) => void;
+/**
+ * Listener called whenever there is activity by the person.
+ * @param lastActivity A UTC timestamp when the last activity happened.
+ *
+ * @see {@link UnbluEmbeddedApi.PERSON_ACTIVITY}
+ * @see {@link UnbluEmbeddedApi.on} to register for the event
+ * @see {@link UnbluEmbeddedApi.off} to unregister from the event
+ */
+export type PersonActivityListener = (person: PersonInfo) => void;
+/**
+ * Listener called whenever the agent availability changes.
+ * @param isAvailable A boolean that indicates if an agent is available.
+ *
+ * @see {@link UnbluEmbeddedApi.AGENT_AVAILABLE_CHANGE}
+ * @see {@link UnbluEmbeddedApi.on} to register for the event
+ * @see {@link UnbluEmbeddedApi.off} to unregister from the event
+ */
+export type AgentAvailableChangeListener = (isAvailable: boolean) => void;
+/**
+ * Listener called whenever the agent availability state changes.
+ * @param availability The new availability state.
+ *
+ * @see {@link UnbluEmbeddedApi.AGENT_AVAILABILITY_CHANGE}
+ * @see {@link UnbluEmbeddedApi.on} to register for the event
+ * @see {@link UnbluEmbeddedApi.off} to unregister from the event
+ */
+export type AgentAvailabilityChangeListener = (availability: AgentAvailabilityState) => void;
+/**
+ * Listener called whenever the embedded app switches to fullscreen mode or back
+ * @param fullscreen The new flag for the fullscreen mode.
+ *
+ * @see {@link UnbluEmbeddedApi.FULLSCREEN_CHANGE}
+ * @see {@link UnbluEmbeddedApi.on} to register for the event
+ * @see {@link UnbluEmbeddedApi.off} to unregister from the event
+ * @see {@link UnbluEmbeddedAppElement.FullscreenChangeEvent} for the corresponding custom event on the {@link UnbluEmbeddedAppElement}
+ */
+export type FullscreenChangeListener = (fullscreen: boolean) => void;
+/**
+ * Listener called whenever the view mode changes.
+ * @param viewMode The new view mode.
+ *
+ * @see {@link UnbluEmbeddedApi.VIEW_MODE_CHANGE}
+ * @see {@link UnbluEmbeddedApi.on} to register for the event
+ * @see {@link UnbluEmbeddedApi.off} to unregister from the event
+ * @see {@link UnbluEmbeddedAppElement.ViewModeChangeEvent} for the corresponding custom event on the {@link UnbluEmbeddedAppElement}
+ */
+export type ViewModeChangeListener = (viewMode: ViewMode) => void;
+/**
+ * Listener called whenever the UnbluApi gets de-initialized.
+ *
+ * @see {@link UnbluEmbeddedApi.DEINITIALIZING} and {@link UnbluEmbeddedApi.DEINITIALIZED}
+ * @see {@link UnbluEmbeddedApi.on} to register for the events
+ * @see {@link UnbluEmbeddedApi.off} to unregister from the events
+ * @see {@link UnbluEmbeddedAppElement.DeinitializationStartedEvent} and {@link UnbluEmbeddedAppElement.DeinitializationFinishedEvent} for the corresponding custom events on the {@link UnbluEmbeddedAppElement}
+ */
+export type DeinitializationListener = () => void;
+/**
+ * This is the main class to interact with the Unblu embedded web component after initialization is done.
+ *
+ * An instance of the {@link UnbluEmbeddedApi} is returned by calling {@link UnbluEmbeddedAppElement.initialize} or listening to the {@link UnbluEmbeddedAppElement.READY} event.
+ *
+ * **Note**: After deinitialization an instance of {@link UnbluEmbeddedApi} is no longer usable and will throw errors on API calls.
+ * In order to access the API again, it is required to initialize Unblu again.
+ */
+export declare class UnbluEmbeddedApi implements InitializedUnbluApi {
+    /**
+     * Event emitted every time the active conversation changes.
+     *
+     * This may happen due to a UI-navigation or an API-call.
+     *
+     * @event activeConversationChange
+     * @see {@link on} for listener registration
+     * @see {@link ConversationChangeListener}
+     */
+    static readonly ACTIVE_CONVERSATION_CHANGE: 'activeConversationChange';
+    /**
+     * Event emitted every time one of the conversations accessible to the current user changes or one is added or removed.
+     *
+     * @event conversationsChanged
+     * @see {@link on} for listener registration
+     * @see {@link ConversationsChangeListener}
+     */
+    static readonly CONVERSATIONS_CHANGE: 'conversationsChange';
+    /**
+     * Event emitted every time the notification count (unread messages) changes.
+     *
+     * @event notificationCountChange
+     * @see {@link on} for listener registration
+     * @see {@link NotificationCountChangeListener}
+     */
+    static readonly NOTIFICATION_COUNT_CHANGE: 'notificationCountChange';
+    /**
+     * Event emitted every time the local person changes. This may be i.e. due to the person setting its name.
+     *
+     * @event personChange
+     * @see {@link on} for listener registration
+     * @see {@link PersonChangeListener}
+     */
+    static readonly PERSON_CHANGE: 'personChange';
+    /**
+     * Event emitted every time the local person has some activity inside Unblu.
+     * This may be i.e. an interaction with the chat, a call, opening a conversation or interacting
+     * with a co-browsing layer.
+     *
+     * The event can be used to reset the logout timer inside an authenticated area, for example.
+     *
+     * The configuration property com.unblu.conversation.activity.activityCategoriesToTrack specifies which categories of activity trigger the event.
+     *
+     * @event personActivity
+     * @see {@link on} for listener registration
+     * @see {@link PersonActivityListener}
+     */
+    static readonly PERSON_ACTIVITY: 'personActivity';
+    /**
+     * Event emitted every time the agent availability changes for the current named area and locale.
+     *
+     * @event availableChange
+     * @see {@link on} for listener registration
+     * @see {@link AgentAvailableChangeListener}
+     */
+    static readonly AGENT_AVAILABLE_CHANGE: 'availableChange';
+    /**
+     * Event emitted every time the agent availability state changes for the current named area and locale.
+     *
+     * @event availabilityChange
+     * @see {@link on} for listener registration
+     * @see {@link AgentAvailabilityChangeListener}
+     */
+    static readonly AGENT_AVAILABILITY_CHANGE: 'availabilityChange';
+    /**
+     * Event emitted every time the embedded app switches to fullscreen mode or back.
+     *
+     * @event fullscreenChange
+     * @see {@link on} for listener registration
+     * @see {@link FullscreenChangeListener}
+     */
+    static readonly FULLSCREEN_CHANGE: 'fullscreenChange';
+    /**
+     * Event emitted every time the view mode changes.
+     *
+     * @event viewModeChange
+     * @see {@link on} for listener registration
+     * @see {@link FullscreenChangeListener}
+     */
+    static readonly VIEW_MODE_CHANGE: 'viewModeChange';
+    /**
+     * Event emitted when this instance gets de-initialized and is not usable at the time until it fully got de-initialized.
+     *
+     * @event deinitializing
+     * @see {@link on} for listener registration
+     * @see {@link DeinitializationListener}
+     */
+    static readonly DEINITIALIZING: 'deinitializing';
+    /**
+     * Event emitted when this instance got de-initialized and has to be initialized again.
+     *
+     * **Note**: After this event, the instance of {@link UnbluEmbeddedApi} is no longer usable.
+     *
+     * @event deinitialized
+     * @see {@link on} for listener registration
+     * @see {@link DeinitializationListener}
+     */
+    static readonly DEINITIALIZED: 'deinitialized';
+    private _internalApi;
+    /**
+     * @hidden
+     */
+    constructor(internalApi: InternalEmbeddedApi);
+    /**
+     * Registers an event listener for the given event.
+     * @param event The activeConversationChange event.
+     * @param listener The listener to be called.
+     * @see {@link UnbluEmbeddedApi.ACTIVE_CONVERSATION_CHANGE}
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    on(event: typeof UnbluEmbeddedApi.ACTIVE_CONVERSATION_CHANGE, listener: ActiveConversationChangeListener): void;
+    /**
+     * Registers an event listener for the given event.
+     * @param event The conversationsChanged event.
+     * @param listener The listener to be called.
+     * @see {@link UnbluEmbeddedApi.CONVERSATIONS_CHANGE}
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    on(event: typeof UnbluEmbeddedApi.CONVERSATIONS_CHANGE, listener: ConversationsChangeListener): void;
+    /**
+     * Registers an event listener for the given event.
+     * @param event The notificationCountChanged event.
+     * @param listener The listener to be called.
+     * @see {@link UnbluEmbeddedApi.NOTIFICATION_COUNT_CHANGE}
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    on(event: typeof UnbluEmbeddedApi.NOTIFICATION_COUNT_CHANGE, listener: NotificationCountChangeListener): void;
+    /**
+     * Registers an event listener for the given event.
+     * @param event The personChange event.
+     * @param listener The listener to be called.
+     * @see {@link UnbluEmbeddedApi.PERSON_CHANGE}
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    on(event: typeof UnbluEmbeddedApi.PERSON_CHANGE, listener: PersonChangeListener): void;
+    /**
+     * Registers an event listener for the given event.
+     * @param event The personActivity event.
+     * @param listener The listener to be called.
+     * @see {@link PERSON_ACTIVITY}
+     */
+    on(event: typeof UnbluEmbeddedApi.PERSON_ACTIVITY, listener: PersonActivityListener): void;
+    /**
+     * Registers an event listener for the given event.
+     * @param event The agentAvailableChange event.
+     * @param listener The listener to be called.
+     * @see {@link UnbluEmbeddedApi.AGENT_AVAILABLE_CHANGE}
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    on(event: typeof UnbluEmbeddedApi.AGENT_AVAILABLE_CHANGE, listener: AgentAvailableChangeListener): void;
+    /**
+     * Registers an event listener for the given event.
+     * @param event The agentAvailabilityChange event.
+     * @param listener The listener to be called.
+     * @see {@link UnbluEmbeddedApi.AGENT_AVAILABILITY_CHANGE}
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    on(event: typeof UnbluEmbeddedApi.AGENT_AVAILABILITY_CHANGE, listener: AgentAvailabilityChangeListener): void;
+    /**
+     * Registers an event listener for the given event.
+     * @param event The fullscreenChange event.
+     * @param listener The listener to be called.
+     * @see {@link UnbluEmbeddedApi.FULLSCREEN_CHANGE}
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    on(event: typeof UnbluEmbeddedApi.FULLSCREEN_CHANGE, listener: FullscreenChangeListener): void;
+    /**
+     * Registers an event listener for the given event.
+     * @param event The viewModeChange event.
+     * @param listener The listener to be called.
+     * @see {@link UnbluEmbeddedApi.VIEW_MODE_CHANGE}
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    on(event: typeof UnbluEmbeddedApi.VIEW_MODE_CHANGE, listener: ViewModeChangeListener): void;
+    /**
+     * Registers an event listener for the given event.
+     * @param event The deinitializing event.
+     * @param listener The listener to be called.
+     * @see {@link UnbluEmbeddedApi.DEINITIALIZING}
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    on(event: typeof UnbluEmbeddedApi.DEINITIALIZING, listener: DeinitializationListener): void;
+    /**
+     * Registers an event listener for the given event.
+     * @param event The deinitialized event.
+     * @param listener The listener to be called.
+     * @see {@link UnbluEmbeddedApi.DEINITIALIZED}
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    on(event: typeof UnbluEmbeddedApi.DEINITIALIZED, listener: DeinitializationListener): void;
+    /**
+     * Removes a previously registered listener
+     * @param event The event to unregister from.
+     * @param listener The listener to remove.
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    off(event: GeneralEventType | AgentAvailabilityEventType | EmbeddedMetaEventType, listener: (data?: any) => void): Promise<void>;
+    /**
+     * Opens the conversation for the given conversation ID.
+     *
+     * If the conversation doesn't exist or the user doesn't have the right to access it, a dialog will be displayed with the respective error message.
+     * Be aware that in such a case the promise will still resolve successfully as the UI switched into the conversation view showing the error dialog. - The active conversation property will however be set to `null`.
+     *
+     * @see {@link UnbluEmbeddedAppElement.ATTR_CONVERSATION_ID} to set this as attribute
+     * @param conversationId The id of the conversation to open. Using null will close the current conversation and open the overview of conversations
+     * @return A promise that resolves with the opened conversation instance, `null` if the overview was opened, or it is rejected with an error if it did not work.
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    openConversation(conversationId: string): Promise<Conversation>;
+    /**
+     * Returns the currently active conversation or `null` if no conversation is active.
+     *
+     * **NOTE:** calling this method twice while the same conversation is active, will result in two individual conversation API instances being returned.
+     * destroying one of them will not cause the other one to also be destroyed. If however the active conversation is closed, all returned Conversation instances will be destroyed.
+     *
+     * @return A promise that either resolves to the currently active conversation or `null` if no conversation is open.
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     * @see {@link ACTIVE_CONVERSATION_CHANGE} for the event whenever the active conversation changes
+     */
+    getActiveConversation(): Promise<Conversation | null>;
+    /**
+     * All conversations accessible to the current user.
+     * If no conversation is present, an empty array is returned.
+     *
+     * @return A promise that resolves to a list of all conversations accessible to the current user.
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    getConversations(): Promise<ConversationInfo[]>;
+    /**
+     * Sets the view mode of the embedded app element.
+     *
+     * Depending on the view mode the UI is displayed the following way:
+     * - {@link ViewMode.SPLIT}: The UI will be divided into two parts.
+     * The list of conversations is displayed on the left and the active conversation on the right side.
+     *
+     * - {@link ViewMode.SINGLE}: Both the conversation list and the active conversation will be displayed in the same view using UI navigation to switch between them.
+     *
+     * - {@link ViewMode.AUTO}: The UI will automatically switch back and forth between the two other modes depending on the available width.
+     * The trigger point when to switch between the two modes can be configured on the Unblu collaboration server.
+     *
+     * @param viewMode The new view mode to use
+     * @return A promise that resolves as soon as the value has been applied
+     * @default {@link ViewMode.AUTO}
+     *
+     * @see {@link getViewMode} to retrieve the current value
+     * @see {@link UnbluEmbeddedAppElement.viewMode} for the corresponding property on the element
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    setViewMode(viewMode: ViewMode): Promise<void>;
+    /**
+     * Returns the view mode of the embedded app element.
+     *
+     * @default {@link ViewMode.AUTO}
+     * @return A promise that resolves with the current view mode
+     *
+     * @see {@link setViewMode} to set the value and for further details on the view mode
+     * @see {@link UnbluEmbeddedAppElement.viewMode} for the corresponding property on the element
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    getViewMode(): Promise<ViewMode>;
+    /**
+     * When this attribute is set to true, the embedded app element will ignore the position and size set to its element and will used fixed positioning to display itself to cover the whole website.
+     *
+     * **Note**: The user itself can also toggle this inside the UI.
+     *
+     * @param fullscreen True to enable fullscreen, false otherwise.
+     * @return A promise that resolves as soon as the value has been applied
+     * @default false
+     *
+     * @see {@link isFullscreen} to retrieve the current value
+     * @see {@link UnbluEmbeddedAppElement.fullscreen} for the corresponding property on the element
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    setFullscreen(fullscreen: boolean): Promise<void>;
+    /**
+     * Returns true if the UI is currently displayed in fullscreen, false otherwise.
+     *
+     * @default false
+     * @return A promise that resolves with true if the UI is in fullscreen mode, false otherwise
+     *
+     * @see {@link setFullscreen} to set the value and for further details on the fullscreen mode
+     * @see {@link UnbluEmbeddedAppElement.fullscreen} for the corresponding property on the element
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    isFullscreen(): Promise<boolean>;
+    /**
+     * Returns the information about the current person.
+     *
+     * @return A promise that resolves with the current person information
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    getPersonInfo(): Promise<PersonInfo>;
+    /**
+     * Sets the nickname of the current user.
+     *
+     * This is only respected for anonymous visitors.
+     *
+     * @return A promise that resolves as soon as the value has been applied
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    setPersonNickname(nickname: string): Promise<void>;
+    /**
+     * Adds the label with the given labelName to the current visitor.
+     * This only adds the label as long as it exists, can be set on visitors and the visitor is allowed to set the label.
+     * @returns A promise that resolves empty when the operation is done or is rejected if it failed.
+     */
+    addPersonLabel(labelName: string): Promise<void>;
+    /**
+     * Removes the label with the given labelName from the current visitor.
+     * This only removes the label as long as the visitor has the label applied to themselves and the visitor is allowed to remove the label.
+     * @returns A promise that resolves empty when the operation is done or is rejected if it failed.
+     */
+    removePersonLabel(labelName: string): Promise<void>;
+    /**
+     * Logs the current visitor in with the access token provided.
+     * Depending on the configuration, existing conversation may will be transferred to the authenticated user.
+     * @param accessToken The access token (JWT) to authenticate the visitor with
+     * @return A promise that resolves empty if the login succeeds or is rejected if it fails
+     */
+    login(accessToken: string): Promise<void>;
+    /**
+     * Checks if the current visitor is authenticated.
+     * @return A promise that resolves to a boolean if the visitor is authenticated
+     */
+    isAuthenticated(): Promise<boolean>;
+    /**
+     * Logs the visitor out.
+     * The user will not have access to conversations from the authenticated visitor he was before anymore. He needs to be authenticated again for that.
+     * @return A promise that resolves empty when the logout succeeds or is rejected if it fails
+     */
+    logout(): Promise<void>;
+    /**
+     * Returns the number of unread messages.
+     *
+     * @return A promise that resolves with the number of unread messages
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    getNotificationCount(): Promise<number>;
+    /**
+     * Returns true if an agent is available for the current named area and language. False otherwise.
+     *
+     * @return A promise that resolves with true if an agent is available, false otherwise
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    isAgentAvailable(): Promise<boolean>;
+    /**
+     * Returns the current availability state for the current named area and language.
+     *
+     * @return A promise that resolves with the current agent availability state
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    getAgentAvailabilityState(): Promise<AgentAvailabilityState>;
+    /**
+     * Sets a custom interceptor which will be triggered when a new conversation is started (initiated from UI or JavaScript).
+     *
+     * @param newConversationInterceptor The interceptor which should be triggered on new conversations
+     *
+     * @return A promise that resolves as soon as the new interceptor has been applied
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    setNewConversationInterceptor(newConversationInterceptor: NewConversationInterceptor): Promise<void>;
+    /**
+     * Joins an existing conversation with a given PIN.
+     *
+     * @param pin The PIN retrieved from the Unblu Agent Desk.
+     * @param visitorName The name the local visitor should have. This is only taken into account if the visitor is not already authenticated.
+     * @return A promise that resolves to the conversation which was joined
+     *
+     * @throws {@link UnbluApiError} with type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized.
+     */
+    joinConversation(pin: string, visitorName?: string): Promise<Conversation>;
+    /**
+     * Starts a new conversation and places it into the inbound conversation queue.
+     *
+     * Starting a new conversation involves an agent availability check.
+     * For {@link ConversationType.OFFLINE_CHAT_REQUEST} conversations, the check proceeds as follows:
+     * * If an agent is available, the conversation type will be changed to {@link ConversationType.CHAT_REQUEST}.
+     * * If no agents are available, it will start an offline conversation provided offline chat requests are enabled in the Unblu server's configuration.
+     * * if offline chat requests aren't enabled, the request will be rejected.
+     *
+     * For all `online` conversation types, the check works as follows:
+     * * If an agent is available, the conversation will be started.
+     * * If no agents are available, the request will be rejected.
+     *
+     * You should therefore always check agent availability before starting a new conversation.
+     * If no agents are available, only start conversations of the type {@link ConversationType.OFFLINE_CHAT_REQUEST}.
+     *
+     * @param type The type of the conversation
+     * @param visitorName The name of the visitor. This is only respected for anonymous visitors
+     * @param visitorData 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.
+     * @param recipient The team or agent recipient of the conversation. This will overwrite any named area that might be set for this web page.
+     * @return A promise that resolves to the conversation which was started
+     *
+     * @throws {@link UnbluApiError} of type {@link UnbluErrorType.ILLEGAL_STATE} when the API instance is deinitialized or if the conversation type may not be started.
+     */
+    startConversation(type: ConversationType, visitorName?: string, visitorData?: string, recipient?: NewConversationRecipient): Promise<Conversation>;
+    private buildConversation;
+    private assertNotDeinitialized;
+    /**
+     * Returns true if this instance of the API is deinitialized, false otherwise.
+     */
+    isDeinitialized(): Boolean;
+    /**
+     * Deinitializes the Unblu Embedded Web Component.
+     * This means that both API is no longer usable but also the UI is completely destroyed.
+     */
+    deinitialize(): Promise<void>;
+    /**
+     * @hidden
+     */
+    deinitialize(destroyOptions: DestroyOptions): Promise<void>;
+}

package/dist/lib/unblu-embedded-api.js

@@ -378,9 +378,7 @@ export class UnbluEmbeddedApi {
     isDeinitialized() {
         return this._internalApi == null;
     }
-    /**
-     * @hidden
-     */
+    //don't hide as otherwise the visible function without parameters is also hidden from the docs
     async deinitialize(destroyOptions) {
         if (this.isDeinitialized()) {
             return;