@unblu/floating-js-api 7.37.2

package/dist/lib/shared/conversation.js

@@ -0,0 +1,384 @@
+import { UnbluApiError, UnbluErrorType } from './unblu-api-error';
+import { EventEmitter } from './internal/util/event-emitter';
+/**
+ * #### This class gives API access to the currently active conversation.
+ *
+ * As long as a conversation is active one can register and receive the events provided by this class and call the methods.
+ * Once the conversation is closed this API object will be destroyed and no more event callbacks will be called.
+ * Any subsequent calls will fail.
+ *
+ * Use the {@link CLOSE} event to de-init any code connected to this conversation.
+ */
+export class Conversation {
+    /**
+     * @hidden
+     */
+    constructor(conversationModule, conversationId) {
+        this.conversationModule = conversationModule;
+        this.conversationId = conversationId;
+        this.eventEmitter = new EventEmitter();
+        this.internalListeners = {};
+        this.destroyed = false;
+        // clean up all listeners when the conversation disconnects.
+        this.on(Conversation.CLOSE, () => this.destroy());
+    }
+    /**
+     * Adds a listener.
+     * @param event The event to register.
+     * @param listener The listener to register.
+     */
+    on(event, listener) {
+        this.checkNotDestroyed();
+        const needsInternalSubscription = !this.eventEmitter.hasListeners(event);
+        this.eventEmitter.on(event, listener);
+        if (needsInternalSubscription)
+            this.onInternal(event);
+    }
+    /**
+     * Removes a previously registered listener.
+     * @param event The event to unregister from.
+     * @param listener The listener to remove.
+     */
+    off(event, listener) {
+        this.checkNotDestroyed();
+        const removed = this.eventEmitter.off(event, listener);
+        if (!this.eventEmitter.hasListeners(event))
+            this.offInternal(event);
+        return removed;
+    }
+    onInternal(eventName) {
+        let internalListener;
+        switch (eventName) {
+            case Conversation.CONNECTION_STATE_CHANGE:
+                internalListener = (event) => {
+                    if (event.data.conversationId == this.conversationId)
+                        this.eventEmitter.emit(event.name, event.data.connectionState);
+                };
+                break;
+            case Conversation.CONVERSATION_STATE_CHANGE:
+                internalListener = (event) => {
+                    if (event.data.conversationId == this.conversationId)
+                        this.eventEmitter.emit(event.name, event.data.conversationState);
+                };
+                break;
+            case Conversation.CALL_STATE_CHANGE:
+                internalListener = (event) => {
+                    if (event.data.conversationId == this.conversationId)
+                        this.eventEmitter.emit(event.name, event.data.callState);
+                };
+                break;
+            case Conversation.INVITATIONS_CHANGE:
+                internalListener = (event) => {
+                    if (event.data.conversationId == this.conversationId)
+                        this.eventEmitter.emit(event.name, event.data.invitations);
+                };
+                break;
+            case Conversation.CUSTOM_ACTION_INVOCATION:
+                internalListener = (event) => {
+                    if (event.data.conversation.id == this.conversationId)
+                        this.eventEmitter.emit(event.name, event.data);
+                };
+                break;
+            default:
+                internalListener = (event) => {
+                    if (event.data == this.conversationId) {
+                        this.eventEmitter.emit(event.name);
+                    }
+                };
+                break;
+        }
+        this.internalListeners[eventName] = internalListener;
+        this.conversationModule.on(eventName, internalListener).catch(e => console.warn('Error registering internal listener for event:', eventName, 'error:' + e, e));
+    }
+    offInternal(eventName) {
+        const listener = this.internalListeners[eventName];
+        if (listener == null)
+            return;
+        delete this.internalListeners[eventName];
+        this.conversationModule.off(eventName, listener).catch(e => console.warn('Error removing internal listener for event:', eventName, 'error:' + e, e));
+    }
+    /**
+     * Returns the ID of this conversation.
+     */
+    getConversationId() {
+        return this.conversationId;
+    }
+    /**
+     * Returns the current connection state the conversation is in.
+     *
+     * If the connection is lost, the conversation will automatically try to reconnect using an exponential back-off strategy.
+     * If a fatal error is detected, the state will change to {@link ConnectionState.ERROR}.
+     *
+     * If this happens, the conversation is in it's terminal state. A dialog or other UI will be displayed to the user with details on the failure.
+     * The conversation is not automatically closed in this case.
+     * It may either be closed through a manual action by the visitor (confirming the error) or via the API.
+     *
+     * @see {@link CONNECTION_STATE_CHANGE} if you need to listen to changes.
+     * @return A promise that resolves to the current connection state of the conversation
+     * or is rejected with a {@link UnbluApiError} if the call fails.
+     */
+    async getConnectionState() {
+        this.checkNotDestroyed();
+        return this.conversationModule.getConnectionState(this.conversationId);
+    }
+    /**
+     * Returns the current state the conversation is in.
+     * @return A promise that resolves to the current state of the conversation
+     * or is rejected with a {@link UnbluApiError} if the call fails.
+     */
+    async getConversationState() {
+        this.checkNotDestroyed();
+        return this.conversationModule.getConversationState(this.conversationId);
+    }
+    /**
+     * @see {@link CALL_STATE_CHANGE} if you need to listen to changes.
+     * @return A promise that resolves to the current call state of the local user
+     * or is rejected with a {@link UnbluApiError} if the call fails.
+     */
+    async getCallState() {
+        this.checkNotDestroyed();
+        return this.conversationModule.getCallState(this.conversationId);
+    }
+    /**
+     * Creates a new PIN invitation for this conversation.
+     *
+     * - If the local person doesn't have the right to invite a visitor,
+     * the returned promise will be rejected with the unblu error type {@link UnbluErrorType.ACTION_NOT_GRANTED}.
+     * @see {@link INVITATIONS_CHANGE} if you need to listen to changes for new invitations on this conversation.
+     * @return A promise that resolves to a new {@link Invitation} object with all relevant metadata.
+     * or is rejected with a {@link UnbluApiError} if the call fails.
+     */
+    async createAnonymousPinInvitation() {
+        this.checkNotDestroyed();
+        return this.conversationModule.createAnonymousPinInvitation(this.conversationId);
+    }
+    /**
+     * Creates a new EMail invitation for this conversation.
+     *
+     * - If the local person doesn't have the right to invite a visitor,
+     * the returned promise will be rejected with the unblu error type {@link UnbluErrorType.ACTION_NOT_GRANTED}.
+     * - If a non valid email address is provided,
+     * the returned promise will be rejected with the unblu error type {@link UnbluErrorType.INVALID_FUNCTION_ARGUMENTS}.
+     * @param email The email which the invitation should be send. It must be a valid email address.
+     * @see {@link INVITATIONS_CHANGE} If you need to listen to changes for new invitations on this conversation.
+     * @return A promise that resolves to a new {@link Invitation} object with all relevant metadata.
+     * or is rejected with a {@link UnbluApiError} if the call fails.
+     */
+    async createAnonymousEmailInvitation(email) {
+        this.checkNotDestroyed();
+        return this.conversationModule.createAnonymousEmailInvitation(this.conversationId, email);
+    }
+    /**
+     * Revoke an invitation.
+     *
+     * - If the local person doesn't have the right to invite a visitor,
+     * the returned promise will be rejected with the unblu error type {@link UnbluErrorType.ACTION_NOT_GRANTED}.
+     * @param invitationId The invitation id.
+     * @return A Promise that resolves to null or is rejected with a {@link UnbluApiError} if the call fails.
+     */
+    async revokeInvitation(invitationId) {
+        this.checkNotDestroyed();
+        return this.conversationModule.revokeInvitation(this.conversationId, invitationId);
+    }
+    /**
+     * Renews an invitation PIN if the invitation is expired.
+     *
+     * - If the local person doesn't have the right to invite a visitor,
+     * the returned promise will be rejected with the unblu error type {@link UnbluErrorType.ACTION_NOT_GRANTED}.
+     * @param invitationId The invitation id.
+     * @return A promise that resolves to a new {@link Invitation} object with all relevant metadata.
+     */
+    async renewInvitationPin(invitationId) {
+        this.checkNotDestroyed();
+        return this.conversationModule.renewInvitationPin(this.conversationId, invitationId);
+    }
+    /**
+     * Set custom visitor data on the conversation.
+     *
+     * @param visitorData Custom data for the visitor in any format.
+     */
+    async setVisitorData(visitorData) {
+        this.checkNotDestroyed();
+        return this.conversationModule.setVisitorData(visitorData);
+    }
+    /**
+     * Get all visitor invitations created by the local person for this conversation.
+     * @return A promise that resolves to a new {@link Invitation} array with all relevant metadata.
+     * or is rejected with a {@link UnbluApiError} if the call fails.
+     */
+    async getInvitations() {
+        this.checkNotDestroyed();
+        return this.conversationModule.getInvitations(this.conversationId);
+    }
+    /**
+     * Starts a voice call in this conversation.
+     *
+     * - If a call is already active, this call will be ignored.
+     * - If the local person doesn't have the right to start a voice call,
+     * the returned promise will be rejected with the unblu error type {@link UnbluErrorType.ACTION_NOT_GRANTED}.
+     * @see {@link CALL_STATE_CHANGE} If you need to listen to changes.
+     * @return A Promise that resolves to null or is rejected with a {@link UnbluApiError} if the call fails.
+     */
+    async startAudioCall() {
+        this.checkNotDestroyed();
+        return this.conversationModule.startAudioCall(this.conversationId);
+    }
+    /**
+     * Starts a video call in this conversation.
+     *
+     * - If a call is already active, this call will be ignored.
+     * - If the local person doesn't have the right to start a video call,
+     * the returned promise will be rejected with the unblu error type {@link UnbluErrorType.ACTION_NOT_GRANTED}.
+     * @see {@link CALL_STATE_CHANGE} If you need to listen to changes.
+     * @return A Promise that resolves to null or is rejected with a {@link UnbluApiError} if the call fails.
+     */
+    async startVideoCall() {
+        this.checkNotDestroyed();
+        return this.conversationModule.startVideoCall(this.conversationId);
+    }
+    /**
+     * Ends and closes this conversation.
+     *
+     * If the local person doesn't have the right to end the conversation,
+     * the returned promise will be rejected with the unblu error type {@link UnbluErrorType.ACTION_NOT_GRANTED}.
+     * @see {@link END} fired after this call.
+     * @see {@link closeConversation} for details on closing a conversation.
+     * @return A Promise that resolves to null or is rejected with a {@link UnbluApiError} if the call fails.
+     */
+    async endConversation() {
+        this.checkNotDestroyed();
+        return this.conversationModule.endConversation(this.conversationId);
+    }
+    /**
+     * Leaves and closes this conversation.
+     *
+     * By leaving, the visitor is removed from the active participant list of the conversation.
+     * Once a conversation is left, the visitor can not re-open it. It will not be visible in the conversation history either.
+     *
+     * If the local person doesn't have the right to leave the conversation,
+     * the returned promise will be rejected with the unblu error type {@link UnbluErrorType.ACTION_NOT_GRANTED}.
+     * @see {@link CLOSE} fired after this call.
+     * @see {@link closeConversation} for details on closing a conversation without leaving.
+     * @return A Promise that resolves to null or is rejected with a {@link UnbluApiError} if the call fails.
+     */
+    async leaveConversation() {
+        this.checkNotDestroyed();
+        return this.conversationModule.leaveConversation(this.conversationId);
+    }
+    /**
+     * Closes this conversation locally.
+     *
+     * When called, the connection to this conversation is closed and the overview is displayed.
+     *
+     * **Note that:**
+     * - Closing does NOT end the conversation.
+     * - The person does NOT leave the conversation.
+     * - All Conversation api instances for this conversation will be destroyed.
+     *
+     * The conversation can be joined again either via the UI or using {@link UnbluApi.openConversation}.
+     * @see {@link CLOSE} fired after this call.
+     * @see {@link endConversation} for details on ending a conversation.
+     * @see {@link leavingConversation} for details on leaving a conversation.
+     * @see {@link destroy} for details on destroying a conversation.
+     * @return A Promise that resolves to null or is rejected with a {@link UnbluApiError} if the call fails.
+     */
+    async closeConversation() {
+        this.checkNotDestroyed();
+        return this.conversationModule.closeConversation(this.conversationId);
+    }
+    checkNotDestroyed() {
+        if (this.destroyed)
+            throw new UnbluApiError(UnbluErrorType.ILLEGAL_STATE, 'Error: trying to execute method on destroyed conversation object.');
+    }
+    /**
+     * Returns weather this conversation is destroyed or not.
+     *
+     * Conversations are destroyed if {@link destroy} is called or the conversation is closed.
+     * This usually happens when the user navigates back to an overview or into an other conversation.
+     * @see {@link destroy}
+     * @see {@link CLOSE}
+     * @return Weather this conversation is destroyed or not.
+     */
+    isDestroyed() {
+        return this.destroyed;
+    }
+    /**
+     * Destroys this conversation API instance.
+     *
+     * Calling destroy will unregister all event listeners and prohibit any further calls to this object.
+     * Once the conversation is destroyed, any subsequent calls will reject the returned promise with {@link UnbluErrorType.ILLEGAL_STATE} as the reason.
+     *
+     * **Note that:**
+     * - Destroying does NOT close the conversation .
+     * - Destroying does NOT end the conversation.
+     * - Destroying does NOT leave the conversation.
+     * - Other instances of the same Conversation will NOT be destroyed.
+     *
+     * This call simply destroys this local API instance to the conversation.
+     *
+     * A destroyed but still open conversation can be accessed again using {@link UnbluApi.getActiveConversation}.
+     *
+     * @see {@link isDestroyed}
+     * @see {@link closeConversation} for details on how to close a conversation
+     * @see {@link endConversation} for details on how to end a conversation
+     */
+    destroy() {
+        if (this.destroyed)
+            return;
+        this.destroyed = true;
+        this.eventEmitter.reset();
+        for (let event in this.internalListeners) {
+            this.offInternal(event);
+        }
+    }
+}
+/**
+ * Event emitted when the {@link ConnectionState} of this conversation changes.
+ * @event connectionStateChange
+ * @see {@link on} for listener registration
+ */
+Conversation.CONNECTION_STATE_CHANGE = 'connectionStateChange';
+/**
+ * Event emitted when the {@link ConversationState} of this conversation changes.
+ * @event conversationStateChange
+ * @see {@link on} for listener registration
+ */
+Conversation.CONVERSATION_STATE_CHANGE = 'conversationStateChange';
+/**
+ * Event emitted when the {@link CallState} of this conversation changes.
+ * @event callStateChange
+ * @see {@link on} for listener registration
+ */
+Conversation.CALL_STATE_CHANGE = 'callStateChange';
+/**
+ * Event emitted when the conversation ends.
+ * @deprecated The end event is not always available, depending on the configuration. Use the {@link CONVERSATION_STATE_CHANGE} event instead.
+ * @event end
+ * @see {@link on} for listener registration
+ */
+Conversation.END = 'end';
+/**
+ * Event emitted when the conversation is closed.
+ *
+ * This may happen due to a UI-navigation or an API-call.
+ *
+ * @event close
+ * @see {@link on} for listener registration
+ */
+Conversation.CLOSE = 'close';
+/**
+ * Event emitted when an {@link Invitation} is added to or removed from this conversation, or if an existing invitation changes.
+ * The event emits an array of all visitor invitations created by the local person, all other invitations will not be present.
+ * @event invitationsChange
+ * @see {@link on} for listener registration
+ */
+Conversation.INVITATIONS_CHANGE = 'invitationsChange';
+/**
+ * Event emitted every time a custom action is configured to trigger a JS API event for the current client when a custom action is invoked
+ *
+ * @event customActionInvocation
+ * @see {@link CustomActionInvocationListener}
+ * @see {@link on} for listener registration
+ */
+Conversation.CUSTOM_ACTION_INVOCATION = 'customActionInvocation';
+//# sourceMappingURL=conversation.js.map

package/dist/lib/shared/conversation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conversation.js","sourceRoot":"","sources":["../../../src/shared/conversation.ts"],"names":[],"mappings":"AAUA,OAAO,EAAC,aAAa,EAAE,cAAc,EAAC,MAAM,mBAAmB,CAAA;AAC/D,OAAO,EAAC,YAAY,EAAW,MAAM,+BAA+B,CAAA;AAgBpE;;;;;;;;GAQG;AACH,MAAM,OAAO,YAAY;IA8DrB;;OAEG;IACH,YAAoB,kBAAsC,EAAU,cAAsB;QAAtE,uBAAkB,GAAlB,kBAAkB,CAAoB;QAAU,mBAAc,GAAd,cAAc,CAAQ;QAPlF,iBAAY,GAAG,IAAI,YAAY,EAAE,CAAA;QACjC,sBAAiB,GAAqC,EAAE,CAAA;QACxD,cAAS,GAAG,KAAK,CAAA;QAMrB,4DAA4D;QAC5D,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;IACrD,CAAC;IA4DD;;;;OAIG;IACI,EAAE,CAAC,KAA4B,EAAE,QAAkB;QACtD,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,MAAM,yBAAyB,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;QACxE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QACrC,IAAI,yBAAyB;YACzB,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAC,KAA4B,EAAE,QAAkB;QACvD,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QACtD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,KAAK,CAAC;YACtC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;QAC3B,OAAO,OAAO,CAAA;IAClB,CAAC;IAEO,UAAU,CAAC,SAAgC;QAC/C,IAAI,gBAA+B,CAAA;QACnC,QAAQ,SAAS,EAAE;YACf,KAAK,YAAY,CAAC,uBAAuB;gBACrC,gBAAgB,GAAG,CAAC,KAAyC,EAAE,EAAE;oBAC7D,IAAI,KAAK,CAAC,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,cAAc;wBAChD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;gBACtE,CAAC,CAAA;gBACD,MAAK;YACT,KAAK,YAAY,CAAC,yBAAyB;gBACvC,gBAAgB,GAAG,CAAC,KAAmC,EAAE,EAAE;oBACvD,IAAI,KAAK,CAAC,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,cAAc;wBAChD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;gBACxE,CAAC,CAAA;gBACD,MAAK;YACT,KAAK,YAAY,CAAC,iBAAiB;gBAC/B,gBAAgB,GAAG,CAAC,KAAmC,EAAE,EAAE;oBACvD,IAAI,KAAK,CAAC,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,cAAc;wBAChD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;gBAChE,CAAC,CAAA;gBACD,MAAK;YACT,KAAK,YAAY,CAAC,kBAAkB;gBAChC,gBAAgB,GAAG,CAAC,KAAqC,EAAE,EAAE;oBACzD,IAAI,KAAK,CAAC,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,cAAc;wBAChD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAClE,CAAC,CAAA;gBACD,MAAK;YACT,KAAK,YAAY,CAAC,wBAAwB;gBACzC,gBAAgB,GAAG,CAAC,KAAoC,EAAE,EAAE;oBACrD,IAAI,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,IAAI,IAAI,CAAC,cAAc;wBACjD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;gBACtD,CAAC,CAAA;gBACD,MAAK;YACT;gBACI,gBAAgB,GAAG,CAAC,KAAoB,EAAE,EAAE;oBACxC,IAAI,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,cAAc,EAAE;wBACnC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;qBACrC;gBACL,CAAC,CAAA;gBACD,MAAK;SACZ;QACD,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,GAAG,gBAAgB,CAAA;QACpD,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,gDAAgD,EAAE,SAAS,EAAE,QAAQ,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAClK,CAAC;IAEO,WAAW,CAAC,SAAgC;QAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAA;QAClD,IAAI,QAAQ,IAAI,IAAI;YAChB,OAAM;QACV,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAA;QACxC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,6CAA6C,EAAE,SAAS,EAAE,QAAQ,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACxJ,CAAC;IAED;;OAEG;IACI,iBAAiB;QACpB,OAAO,IAAI,CAAC,cAAc,CAAA;IAC9B,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,kBAAkB;QAC3B,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IAC1E,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,oBAAoB;QAC7B,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IAC5E,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY;QACrB,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IACpE,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,4BAA4B;QACrC,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,4BAA4B,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IACpF,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,8BAA8B,CAAC,KAAa;QACrD,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,8BAA8B,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAA;IAC7F,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,gBAAgB,CAAC,YAAoB;QAC9C,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAA;IACtF,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,kBAAkB,CAAC,YAAoB;QAChD,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAA;IACxF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc,CAAC,WAAmB;QAC3C,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc;QACvB,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IACtE,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,cAAc;QACvB,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IACtE,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,cAAc;QACvB,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IACtE,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,eAAe;QACxB,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IACvE,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,iBAAiB;QAC1B,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,iBAAiB;QAC1B,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACxB,OAAO,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IACzE,CAAC;IAEO,iBAAiB;QACrB,IAAI,IAAI,CAAC,SAAS;YAAE,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,aAAa,EAAE,mEAAmE,CAAC,CAAA;IAClJ,CAAC;IAED;;;;;;;;OAQG;IACI,WAAW;QACd,OAAO,IAAI,CAAC,SAAS,CAAA;IACzB,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,OAAO;QACV,IAAI,IAAI,CAAC,SAAS;YAAE,OAAM;QAC1B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;QACrB,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAA;QACzB,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,iBAAiB,EAAE;YACtC,IAAI,CAAC,WAAW,CAAC,KAA8B,CAAC,CAAA;SACnD;IACL,CAAC;;AArcD;;;;GAIG;AACoB,oCAAuB,GAA4B,uBAAuB,AAAnD,CAAmD;AAEjG;;;;GAIG;AACoB,sCAAyB,GAA8B,yBAAyB,AAAvD,CAAuD;AAEvG;;;;GAIG;AACoB,8BAAiB,GAAsB,iBAAiB,AAAvC,CAAuC;AAE/E;;;;;GAKG;AACoB,gBAAG,GAAU,KAAK,AAAf,CAAe;AAEzC;;;;;;;GAOG;AACoB,kBAAK,GAAY,OAAO,AAAnB,CAAmB;AAE/C;;;;;GAKG;AACoB,+BAAkB,GAAwB,mBAAmB,AAA3C,CAA2C;AAEpF;;;;;;GAMG;AACoB,qCAAwB,GAA6B,wBAAwB,AAArD,CAAqD"}

package/dist/lib/shared/internal/api-bridge.d.ts

@@ -0,0 +1,36 @@
+import { EventCallback } from './event';
+export declare class ApiBridge {
+    private mountPoint;
+    private mountName;
+    private internal;
+    private readonly eventHandler;
+    /**
+     * instantiates the bridge that links the UNBLU internal API provided by the collaboration server with the UNBLU JS-API
+     * @param mountPoint the global unblu object under which the internal API is registered.
+     */
+    constructor(mountPoint: any, mountName: string);
+    waitUntilLoaded(timeout: number, promise?: Promise<void>): Promise<void>;
+    private checkLoaded;
+    checkCompatibility(): void;
+    /**
+     * Calls an API function of the internal unblu collaboration server API.
+     * @param moduleName The module to which the function belongs.
+     * @param functionName The function to call.
+     * @param args The arguments to pass to the function.
+     */
+    callApiFunction(moduleName: string, functionName: string, args: any[]): Promise<any>;
+    /**
+     * Registers a callback for an event emitted by the internal unblu collaboration server API.
+     * @param module The module that emits the event.
+     * @param event The event name.
+     * @param callback The callback which will be called every time the event is emitted.
+     */
+    on(module: string, event: string, callback: EventCallback): Promise<void>;
+    /**
+     * Unregisters a callback for an event emitted by the internal unblu collaboration server API.
+     * @param module The module that emits the event.
+     * @param event The event name.
+     * @param callback Optionally callback which will be removed, if none is provided all listeners of the event will be removed.
+     */
+    off(module: string, event: string, callback?: EventCallback): Promise<void>;
+}

package/dist/lib/shared/internal/api-bridge.js

@@ -0,0 +1,97 @@
+import { UnbluApiError, UnbluErrorType } from '../unblu-api-error';
+import { CATEGORY_ACTION_NOT_GRANTED, CATEGORY_EXECUTION_EXCEPTION, CATEGORY_INVALID_FUNCTION_ARGUMENTS, CATEGORY_INVALID_FUNCTION_CALL, CATEGORY_TIMEOUT } from './java-error-codes';
+const SUPPORTED_MAJOR_VERSION = 2;
+export class ApiBridge {
+    /**
+     * instantiates the bridge that links the UNBLU internal API provided by the collaboration server with the UNBLU JS-API
+     * @param mountPoint the global unblu object under which the internal API is registered.
+     */
+    constructor(mountPoint, mountName) {
+        this.mountPoint = mountPoint;
+        this.mountName = mountName;
+    }
+    async waitUntilLoaded(timeout, promise) {
+        const timeoutTimestamp = Date.now() + timeout;
+        return new Promise((resolve, reject) => {
+            const waitForLoaded = () => {
+                if (timeoutTimestamp - Date.now() > 0) {
+                    if (this.checkLoaded())
+                        return resolve();
+                    setTimeout(waitForLoaded, 50);
+                }
+                else {
+                    reject(new UnbluApiError(UnbluErrorType.INITIALIZATION_TIMEOUT, 'Timeout while waiting for collaboration server API to be loaded.'));
+                }
+            };
+            waitForLoaded();
+        });
+    }
+    checkLoaded() {
+        const error = this.mountPoint['loadError'];
+        if (error) {
+            throw new UnbluApiError(error.type, error.detail);
+        }
+        this.internal = this.mountPoint[this.mountName];
+        return this.internal != null;
+    }
+    checkCompatibility() {
+        if (!this.internal) {
+            throw new UnbluApiError(UnbluErrorType.INCOMPATIBLE_UNBLU_VERSION, 'Incompatible unblu collaboration server, no API bridge provided.');
+        }
+        else if (typeof this.internal.getApiVersion !== 'function') {
+            throw new UnbluApiError(UnbluErrorType.INCOMPATIBLE_UNBLU_VERSION, 'Incompatible unblu collaboration server, incompatible API bridge.');
+        }
+        const version = this.internal.getApiVersion();
+        if (+version[0] != SUPPORTED_MAJOR_VERSION) {
+            throw new UnbluApiError(UnbluErrorType.INCOMPATIBLE_UNBLU_VERSION, `Incompatible collaboration server version. 
+                Supported API version: ${SUPPORTED_MAJOR_VERSION}.x.x.
+                collaboration server API version: ${version}.`);
+        }
+    }
+    /**
+     * Calls an API function of the internal unblu collaboration server API.
+     * @param moduleName The module to which the function belongs.
+     * @param functionName The function to call.
+     * @param args The arguments to pass to the function.
+     */
+    async callApiFunction(moduleName, functionName, args) {
+        try {
+            return await this.internal.execute(moduleName, functionName, args);
+        }
+        catch (e) {
+            switch (e.type) {
+                case CATEGORY_INVALID_FUNCTION_CALL:
+                    throw new UnbluApiError(UnbluErrorType.INVALID_FUNCTION_CALL, e.message);
+                case CATEGORY_INVALID_FUNCTION_ARGUMENTS:
+                    throw new UnbluApiError(UnbluErrorType.INVALID_FUNCTION_ARGUMENTS, e.message);
+                case CATEGORY_ACTION_NOT_GRANTED:
+                    throw new UnbluApiError(UnbluErrorType.ACTION_NOT_GRANTED, e.message);
+                case CATEGORY_EXECUTION_EXCEPTION:
+                    throw new UnbluApiError(UnbluErrorType.EXECUTION_EXCEPTION, e.message);
+                case CATEGORY_TIMEOUT:
+                    throw new UnbluApiError(UnbluErrorType.TIMEOUT, e.message);
+                default:
+                    throw new UnbluApiError(UnbluErrorType.EXECUTION_EXCEPTION, '' + e);
+            }
+        }
+    }
+    /**
+     * Registers a callback for an event emitted by the internal unblu collaboration server API.
+     * @param module The module that emits the event.
+     * @param event The event name.
+     * @param callback The callback which will be called every time the event is emitted.
+     */
+    on(module, event, callback) {
+        return this.internal.registerEventListener(module, event, callback);
+    }
+    /**
+     * Unregisters a callback for an event emitted by the internal unblu collaboration server API.
+     * @param module The module that emits the event.
+     * @param event The event name.
+     * @param callback Optionally callback which will be removed, if none is provided all listeners of the event will be removed.
+     */
+    off(module, event, callback) {
+        return this.internal.removeEventListener(module, event, callback);
+    }
+}
+//# sourceMappingURL=api-bridge.js.map

package/dist/lib/shared/internal/api-bridge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-bridge.js","sourceRoot":"","sources":["../../../../src/shared/internal/api-bridge.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,aAAa,EAAE,cAAc,EAAC,MAAM,oBAAoB,CAAA;AAChE,OAAO,EACH,2BAA2B,EAC3B,4BAA4B,EAC5B,mCAAmC,EACnC,8BAA8B,EAC9B,gBAAgB,EACnB,MAAM,oBAAoB,CAAA;AAG3B,MAAM,uBAAuB,GAAG,CAAC,CAAA;AAgBjC,MAAM,OAAO,SAAS;IAIlB;;;OAGG;IACH,YAAoB,UAAe,EAAU,SAAiB;QAA1C,eAAU,GAAV,UAAU,CAAK;QAAU,cAAS,GAAT,SAAS,CAAQ;IAC9D,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,OAAe,EAAE,OAAuB;QACjE,MAAM,gBAAgB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAA;QAC7C,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACzC,MAAM,aAAa,GAAG,GAAG,EAAE;gBACvB,IAAI,gBAAgB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE;oBACnC,IAAI,IAAI,CAAC,WAAW,EAAE;wBAAE,OAAO,OAAO,EAAE,CAAA;oBACxC,UAAU,CAAC,aAAa,EAAE,EAAE,CAAC,CAAA;iBAChC;qBAAM;oBACH,MAAM,CAAC,IAAI,aAAa,CAAC,cAAc,CAAC,sBAAsB,EAAE,kEAAkE,CAAC,CAAC,CAAA;iBACvI;YACL,CAAC,CAAA;YACD,aAAa,EAAE,CAAA;QACnB,CAAC,CAAC,CAAA;IACN,CAAC;IAEO,WAAW;QACf,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAA;QAC1C,IAAI,KAAK,EAAE;YACP,MAAM,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;SACpD;QACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAC/C,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAA;IAChC,CAAC;IAGM,kBAAkB;QACrB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAChB,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,0BAA0B,EAAE,kEAAkE,CAAC,CAAA;SACzI;aAAM,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,KAAK,UAAU,EAAE;YAC1D,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,0BAA0B,EAAE,mEAAmE,CAAC,CAAA;SAC1I;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAA;QAC7C,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,uBAAuB,EAAE;YACxC,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,0BAA0B,EAAE;yCACtC,uBAAuB;oDACZ,OAAO,GAAG,CAAC,CAAA;SACtD;IACL,CAAC;IAGD;;;;;OAKG;IACI,KAAK,CAAC,eAAe,CAAC,UAAkB,EAAE,YAAoB,EAAE,IAAW;QAC9E,IAAI;YACA,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,YAAY,EAAE,IAAI,CAAC,CAAA;SACrE;QAAC,OAAO,CAAC,EAAE;YACR,QAAQ,CAAC,CAAC,IAAI,EAAE;gBACZ,KAAK,8BAA8B;oBAC/B,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,CAAA;gBAC5E,KAAK,mCAAmC;oBACpC,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAAC,CAAA;gBACjF,KAAK,2BAA2B;oBAC5B,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,CAAA;gBACzE,KAAK,4BAA4B;oBAC7B,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,mBAAmB,EAAE,CAAC,CAAC,OAAO,CAAC,CAAA;gBAC1E,KAAK,gBAAgB;oBACjB,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,CAAA;gBAC9D;oBACI,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,mBAAmB,EAAE,EAAE,GAAG,CAAC,CAAC,CAAA;aAC1E;SACJ;IACL,CAAC;IAED;;;;;OAKG;IACI,EAAE,CAAC,MAAc,EAAE,KAAa,EAAE,QAAuB;QAC5D,OAAO,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAA;IACvE,CAAC;IAED;;;;;OAKG;IACI,GAAG,CAAC,MAAc,EAAE,KAAa,EAAE,QAAwB;QAC9D,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAA;IACrE,CAAC;CAEJ"}

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

@@ -0,0 +1,6 @@
+export interface Event<T> {
+    module: string;
+    name: string;
+    data: T;
+}
+export type EventCallback = (event: Event<any>) => void;

package/dist/lib/shared/internal/event.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=event.js.map

package/dist/lib/shared/internal/event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.js","sourceRoot":"","sources":["../../../../src/shared/internal/event.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,6 @@
+/**
+ * @hidden
+ */
+export declare interface InitializedUnbluApi {
+    deinitialize(): Promise<void>;
+}

package/dist/lib/shared/internal/initialized-unblu-api.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=initialized-unblu-api.js.map

package/dist/lib/shared/internal/initialized-unblu-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initialized-unblu-api.js","sourceRoot":"","sources":["../../../../src/shared/internal/initialized-unblu-api.ts"],"names":[],"mappings":""}

package/dist/lib/shared/internal/initialized-unblu-element.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @hidden
+ */
+export declare interface InitializedUnbluElement extends HTMLElement {
+    deinitialize(): Promise<void>;
+}

package/dist/lib/shared/internal/initialized-unblu-element.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=initialized-unblu-element.js.map

package/dist/lib/shared/internal/initialized-unblu-element.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"initialized-unblu-element.js","sourceRoot":"","sources":["../../../../src/shared/internal/initialized-unblu-element.ts"],"names":[],"mappings":""}

package/dist/lib/shared/internal/java-error-codes.d.ts

@@ -0,0 +1,5 @@
+export declare const CATEGORY_INVALID_FUNCTION_CALL = 1;
+export declare const CATEGORY_INVALID_FUNCTION_ARGUMENTS = 2;
+export declare const CATEGORY_EXECUTION_EXCEPTION = 3;
+export declare const CATEGORY_ACTION_NOT_GRANTED = 4;
+export declare const CATEGORY_TIMEOUT = 5;

package/dist/lib/shared/internal/java-error-codes.js

@@ -0,0 +1,6 @@
+export const CATEGORY_INVALID_FUNCTION_CALL = 1;
+export const CATEGORY_INVALID_FUNCTION_ARGUMENTS = 2;
+export const CATEGORY_EXECUTION_EXCEPTION = 3;
+export const CATEGORY_ACTION_NOT_GRANTED = 4;
+export const CATEGORY_TIMEOUT = 5;
+//# sourceMappingURL=java-error-codes.js.map

package/dist/lib/shared/internal/java-error-codes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"java-error-codes.js","sourceRoot":"","sources":["../../../../src/shared/internal/java-error-codes.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAA;AAC/C,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,CAAA;AACpD,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAA;AAC7C,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAA;AAC5C,MAAM,CAAC,MAAM,gBAAgB,GAAE,CAAC,CAAA"}

package/dist/lib/shared/internal/module/agent-availability-module.d.ts

@@ -0,0 +1,14 @@
+import { InternalModule } from './module';
+import { ApiBridge } from '../api-bridge';
+import { AgentAvailabilityState } from '../../model/agent-availability-state';
+export type AgentAvailabilityEventType = 'availableChange' | 'availabilityChange';
+declare const enum AgentAvailabilityFunction {
+    isAgentAvailable = "isAgentAvailable",
+    getAgentAvailabilityState = "getAgentAvailabilityState"
+}
+export declare class AgentAvailabilityModule extends InternalModule<AgentAvailabilityFunction, AgentAvailabilityEventType> {
+    constructor(bridge: ApiBridge);
+    isAgentAvailable(): Promise<boolean>;
+    getAgentAvailabilityState(): Promise<AgentAvailabilityState>;
+}
+export {};

package/dist/lib/shared/internal/module/agent-availability-module.js

@@ -0,0 +1,13 @@
+import { InternalModule } from './module';
+export class AgentAvailabilityModule extends InternalModule {
+    constructor(bridge) {
+        super(bridge, 'agentavailability');
+    }
+    isAgentAvailable() {
+        return this.callApiFunction("isAgentAvailable" /* AgentAvailabilityFunction.isAgentAvailable */, []);
+    }
+    getAgentAvailabilityState() {
+        return this.callApiFunction("getAgentAvailabilityState" /* AgentAvailabilityFunction.getAgentAvailabilityState */, []);
+    }
+}
+//# sourceMappingURL=agent-availability-module.js.map

package/dist/lib/shared/internal/module/agent-availability-module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent-availability-module.js","sourceRoot":"","sources":["../../../../../src/shared/internal/module/agent-availability-module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,cAAc,EAAC,MAAM,UAAU,CAAA;AAcvC,MAAM,OAAO,uBAAwB,SAAQ,cAAqE;IAC9G,YAAY,MAAiB;QACzB,KAAK,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;IACtC,CAAC;IAEM,gBAAgB;QACnB,OAAO,IAAI,CAAC,eAAe,sEAA6C,EAAE,CAAC,CAAA;IAC/E,CAAC;IAEM,yBAAyB;QAC5B,OAAO,IAAI,CAAC,eAAe,wFAAsD,EAAE,CAAC,CAAA;IACxF,CAAC;CACJ"}