@epam/ai-dial-overlay 0.31.0-rc.9 → 0.31.1

package/README.md

@@ -67,6 +67,15 @@ const run = async () => {
     overlayConversationId: 'some-conversation-id',
     // optional, if DIAL should redirect to sign in the same browser window
     signInInSameWindow: false,
+    // optional, auto-sign in options
+    signInOptions: {
+      // optional, If the DIAL should automatically sign in without user interaction (provided there is an active provider session)
+      autoSignIn: true,
+      //provider which will be used for the sign in
+      signInProvider: 'provider_name',
+      //optional, should be true if provider page couldn't be open in iframe and hostDomain and DIAL have different providers or application id within one provider
+      signInInNewWindow: true,
+    },
   });
 
   // overlay loaded application and ready to send and receive information from the application

package/index.esm.js

@@ -276,6 +276,15 @@ class ChatOverlay {
             return this.send(OverlayRequests.getConversations);
         });
     }
+    /**
+     * Get all selected conversations
+     * @returns {OverlayConversation[]} all selected conversations visible in chat
+     */
+    getSelectedConversations() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.send(OverlayRequests.getSelectedConversations);
+        });
+    }
     /**
      * Select conversation
      * @param {string} id - id of conversation to select
@@ -289,19 +298,97 @@ class ChatOverlay {
             return this.send(OverlayRequests.selectConversation, request);
         });
     }
+    /**
+     * Delete conversation
+     * @param {string} id - id of conversation to delete
+     */
+    deleteConversation(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const request = {
+                id,
+            };
+            return this.send(OverlayRequests.deleteConversation, request);
+        });
+    }
+    /**
+     * Rename conversation
+     * @param {string} id - id of conversation to rename
+     * @param {string} newName - new name of conversation
+     * @returns Returns renamed conversation info
+     */
+    renameConversation(id, newName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const request = {
+                id,
+                newName,
+            };
+            return this.send(OverlayRequests.renameConversation, request);
+        });
+    }
+    /**
+     * Create playback conversation
+     * @param {string} id - id of conversation from create playback
+     * @returns Returns newly created playback conversation info
+     */
+    createPlaybackConversation(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const request = {
+                id,
+            };
+            return this.send(OverlayRequests.createPlaybackConversation, request);
+        });
+    }
+    /**
+     * Export conversation
+     * @param {string} id - id of conversation to export
+     * @returns Returns exported conversation object
+     */
+    exportConversation(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const request = {
+                id,
+            };
+            return this.send(OverlayRequests.exportConversation, request);
+        });
+    }
+    /**
+     * Import conversation
+     * @param {LatestExportConversationsFormat} importedConversation - conversation object to import
+     * @returns Returns imported conversation info
+     */
+    importConversation(importedConversation) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const request = {
+                importConversation: importedConversation,
+            };
+            return this.send(OverlayRequests.importConversation, request);
+        });
+    }
     /**
      * Create conversation
      * @param {string} parentPath - path to create conversation in. If not defined or null conversation will be created in user Root
      * @returns Returns created conversation info
      */
-    createConversation(parentPath) {
+    createConversation(parentPath, local) {
         return __awaiter(this, void 0, void 0, function* () {
             const request = {
                 parentPath,
+                local,
             };
             return this.send(OverlayRequests.createConversation, request);
         });
     }
+    /**
+     * Create local conversation which will be not visible before first assistant message
+     *
+     * Note: after first assistant message local conversation will be saved in `newConversationsFolderId` option path, or in user Root if it's not defined or null
+     * @returns Returns created local conversation info
+     */
+    createLocalConversation() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.send(OverlayRequests.createLocalConversation);
+        });
+    }
     /**
      * Send message into the first selected conversation
      * @param content {string} text of message that should be sent to the chat
@@ -574,44 +661,44 @@ class ChatOverlayManager {
     }
     /**
      * Destroys overlay with specified id and removes from this.overlays
-     * @param id {string} id of overlay that should be deleted
+     * @param overlayId {string} id of overlay that should be deleted
      */
-    removeOverlay(id) {
-        const { overlay, container, toggleButton } = this.getOverlay(id);
+    removeOverlay(overlayId) {
+        const { overlay, container, toggleButton } = this.getOverlay(overlayId);
         overlay.destroy();
-        this.overlays = this.overlays.filter(({ options }) => options.id !== id);
+        this.overlays = this.overlays.filter(({ options }) => options.id !== overlayId);
         document.body.removeChild(container);
         document.body.removeChild(toggleButton);
     }
-    openFullscreen(id) {
-        const { overlay } = this.getOverlay(id);
+    openFullscreen(overlayId) {
+        const { overlay } = this.getOverlay(overlayId);
         overlay.openFullscreen();
     }
     /**
      * Shows overlay with specified id
-     * @param id {string} id of overlay that should be shown
+     * @param overlayId {string} id of overlay that should be shown
      */
-    showOverlay(id) {
-        const overlay = this.getOverlay(id);
+    showOverlay(overlayId) {
+        const overlay = this.getOverlay(overlayId);
         overlay.isHidden = false;
         overlay.container.style.transform = 'scale(1) translate(0, 0)';
     }
     /**
      * Hides overlay with specified id
-     * @param id {string} id of overlay that should be hidden
+     * @param overlayId {string} id of overlay that should be hidden
      */
-    hideOverlay(id) {
-        const overlay = this.getOverlay(id);
+    hideOverlay(overlayId) {
+        const overlay = this.getOverlay(overlayId);
         overlay.isHidden = true;
         overlay.container.style.transform = `scale(1) ${overlay.position.transform}`;
     }
     /**
      * Checks the current viewport and updates position, styles if needed
-     * @param id {string} id of overlay that should be updated
+     * @param overlayId {string} id of overlay that should be updated
      */
-    updateOverlay(id) {
+    updateOverlay(overlayId) {
         var _a;
-        const { container, options, isHidden } = this.getOverlay(id);
+        const { container, options, isHidden } = this.getOverlay(overlayId);
         const mobileHeight = `${window.innerHeight}px`;
         const isMobileView = this.isMobileView();
         const position = getPosition()[(_a = options.position) !== null && _a !== void 0 ? _a : 'right-bottom'];
@@ -634,60 +721,102 @@ class ChatOverlayManager {
                 : options.height || defaultOverlayPlacementOptions.height,
         });
     }
-    setSystemPrompt(id, systemPrompt) {
-        const { overlay } = this.getOverlay(id);
+    setSystemPrompt(overlayId, systemPrompt) {
+        const { overlay } = this.getOverlay(overlayId);
         return overlay.setSystemPrompt(systemPrompt);
     }
-    getMessages(id) {
+    getMessages(overlayId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { overlay } = this.getOverlay(id);
+            const { overlay } = this.getOverlay(overlayId);
             return overlay.getMessages();
         });
     }
-    sendMessage(id, content) {
+    sendMessage(overlayId, content) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { overlay } = this.getOverlay(id);
+            const { overlay } = this.getOverlay(overlayId);
             return overlay.sendMessage(content);
         });
     }
-    getConversations(id) {
+    getConversations(overlayId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { overlay } = this.getOverlay(id);
+            const { overlay } = this.getOverlay(overlayId);
             return overlay.getConversations();
         });
     }
-    createConversation(id, parentPath) {
+    getSelectedConversations(overlayId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { overlay } = this.getOverlay(id);
+            const { overlay } = this.getOverlay(overlayId);
+            return overlay.getSelectedConversations();
+        });
+    }
+    createConversation(overlayId, parentPath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { overlay } = this.getOverlay(overlayId);
             return overlay.createConversation(parentPath);
         });
     }
-    selectConversation(id, conversationId) {
+    createLocalConversation(overlayId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { overlay } = this.getOverlay(id);
+            const { overlay } = this.getOverlay(overlayId);
+            return overlay.createLocalConversation();
+        });
+    }
+    selectConversation(overlayId, conversationId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { overlay } = this.getOverlay(overlayId);
             return overlay.selectConversation(conversationId);
         });
     }
-    setOverlayOptions(id, options) {
+    renameConversation(overlayId, conversationId, newName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { overlay } = this.getOverlay(overlayId);
+            return overlay.renameConversation(conversationId, newName);
+        });
+    }
+    setOverlayOptions(overlayId, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { overlay } = this.getOverlay(id);
+            const { overlay } = this.getOverlay(overlayId);
             return overlay.setOverlayOptions(options);
         });
     }
-    subscribe(id, eventType, callback) {
-        const { overlay } = this.getOverlay(id);
+    deleteConversation(overlayId, conversationId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { overlay } = this.getOverlay(overlayId);
+            return overlay.deleteConversation(conversationId);
+        });
+    }
+    createPlaybackConversation(overlayId, conversationId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { overlay } = this.getOverlay(overlayId);
+            return overlay.createPlaybackConversation(conversationId);
+        });
+    }
+    exportConversation(overlayId, conversationId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { overlay } = this.getOverlay(overlayId);
+            return overlay.exportConversation(conversationId);
+        });
+    }
+    importConversation(overlayId, importedConversation) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { overlay } = this.getOverlay(overlayId);
+            return overlay.importConversation(importedConversation);
+        });
+    }
+    subscribe(overlayId, eventType, callback) {
+        const { overlay } = this.getOverlay(overlayId);
         return overlay.subscribe(eventType, callback);
     }
     /**
      * Get reference to overlay from this.overlay with specified id
      * Throws exception if there is no such overlay with specified id
-     * @param id {string} id of overlay that should be returned
+     * @param overlayId {string} id of overlay that should be returned
      * @returns {Overlay} reference to overlay with specified id
      */
-    getOverlay(id) {
-        const overlay = this.overlays.find(({ options }) => options.id === id);
+    getOverlay(overlayId) {
+        const overlay = this.overlays.find(({ options }) => options.id === overlayId);
         if (!overlay)
-            throw new Error(`There is no overlay with ${id}`);
+            throw new Error(`There is no overlay with ${overlayId}`);
         return overlay;
     }
     /**

package/package.json

@@ -2,9 +2,9 @@
   "name": "@epam/ai-dial-overlay",
   "description": "Package for opening dial in overlay",
   "homepage": "https://epam-rail.com",
-  "version": "0.31.0-rc.9",
+  "version": "0.31.1",
   "dependencies": {
-    "@epam/ai-dial-shared": "0.31.0-rc.9"
+    "@epam/ai-dial-shared": "0.31.1"
   },
   "type": "module",
   "bugs": {

package/src/lib/ChatOverlay.d.ts

@@ -1,4 +1,4 @@
-import { ChatOverlayOptions, CreateConversationResponse, DeferredRequest, GetConversationsResponse, GetMessagesResponse, OverlayRequest, OverlayRequests, SelectConversationResponse, SendMessageResponse, SetSystemPromptResponse, Styles, Task } from '@epam/ai-dial-shared';
+import { ChatOverlayOptions, CreateConversationResponse, CreateLocalConversationResponse, CreatePlaybackConversationResponse, DeferredRequest, ExportConversationResponse, GetConversationsResponse, GetMessagesResponse, GetSelectedConversationsResponse, ImportConversationResponse, LatestExportConversationsFormat, OverlayRequest, OverlayRequests, RenameConversationResponse, SelectConversationResponse, SendMessageResponse, SetSystemPromptResponse, Styles, Task } from '@epam/ai-dial-shared';
 interface Subscription {
     eventType: string;
     callback: (payload: unknown) => void;
@@ -94,18 +94,60 @@ export declare class ChatOverlay {
      * @returns {OverlayConversation[]} all conversations visible in chat
      */
     getConversations(): Promise<GetConversationsResponse>;
+    /**
+     * Get all selected conversations
+     * @returns {OverlayConversation[]} all selected conversations visible in chat
+     */
+    getSelectedConversations(): Promise<GetSelectedConversationsResponse>;
     /**
      * Select conversation
      * @param {string} id - id of conversation to select
      * @returns Returns selected conversation info
      */
     selectConversation(id: string): Promise<SelectConversationResponse>;
+    /**
+     * Delete conversation
+     * @param {string} id - id of conversation to delete
+     */
+    deleteConversation(id: string): Promise<void>;
+    /**
+     * Rename conversation
+     * @param {string} id - id of conversation to rename
+     * @param {string} newName - new name of conversation
+     * @returns Returns renamed conversation info
+     */
+    renameConversation(id: string, newName: string): Promise<RenameConversationResponse>;
+    /**
+     * Create playback conversation
+     * @param {string} id - id of conversation from create playback
+     * @returns Returns newly created playback conversation info
+     */
+    createPlaybackConversation(id: string): Promise<CreatePlaybackConversationResponse>;
+    /**
+     * Export conversation
+     * @param {string} id - id of conversation to export
+     * @returns Returns exported conversation object
+     */
+    exportConversation(id: string): Promise<ExportConversationResponse>;
+    /**
+     * Import conversation
+     * @param {LatestExportConversationsFormat} importedConversation - conversation object to import
+     * @returns Returns imported conversation info
+     */
+    importConversation(importedConversation: LatestExportConversationsFormat): Promise<ImportConversationResponse>;
     /**
      * Create conversation
      * @param {string} parentPath - path to create conversation in. If not defined or null conversation will be created in user Root
      * @returns Returns created conversation info
      */
-    createConversation(parentPath?: string | null): Promise<CreateConversationResponse>;
+    createConversation(parentPath?: string | null, local?: boolean | null): Promise<CreateConversationResponse>;
+    /**
+     * Create local conversation which will be not visible before first assistant message
+     *
+     * Note: after first assistant message local conversation will be saved in `newConversationsFolderId` option path, or in user Root if it's not defined or null
+     * @returns Returns created local conversation info
+     */
+    createLocalConversation(): Promise<CreateLocalConversationResponse>;
     /**
      * Send message into the first selected conversation
      * @param content {string} text of message that should be sent to the chat

package/src/lib/ChatOverlayManager.d.ts

@@ -1,5 +1,5 @@
 import { ChatOverlay } from './ChatOverlay';
-import { ChatOverlayOptions } from '@epam/ai-dial-shared';
+import { ChatOverlayOptions, LatestExportConversationsFormat } from '@epam/ai-dial-shared';
 export type OverlayPosition = 'left-bottom' | 'left-top' | 'right-bottom' | 'right-top';
 export interface Position {
     top: string;
@@ -64,40 +64,47 @@ export declare class ChatOverlayManager {
     createCloseButton(): HTMLButtonElement;
     /**
      * Destroys overlay with specified id and removes from this.overlays
-     * @param id {string} id of overlay that should be deleted
+     * @param overlayId {string} id of overlay that should be deleted
      */
-    removeOverlay(id: string): void;
-    openFullscreen(id: string): void;
+    removeOverlay(overlayId: string): void;
+    openFullscreen(overlayId: string): void;
     /**
      * Shows overlay with specified id
-     * @param id {string} id of overlay that should be shown
+     * @param overlayId {string} id of overlay that should be shown
      */
-    showOverlay(id: string): void;
+    showOverlay(overlayId: string): void;
     /**
      * Hides overlay with specified id
-     * @param id {string} id of overlay that should be hidden
+     * @param overlayId {string} id of overlay that should be hidden
      */
-    hideOverlay(id: string): void;
+    hideOverlay(overlayId: string): void;
     /**
      * Checks the current viewport and updates position, styles if needed
-     * @param id {string} id of overlay that should be updated
+     * @param overlayId {string} id of overlay that should be updated
      */
-    updateOverlay(id: string): void;
-    setSystemPrompt(id: string, systemPrompt: string): Promise<void>;
-    getMessages(id: string): Promise<import("@epam/ai-dial-shared").GetMessagesResponse>;
-    sendMessage(id: string, content: string): Promise<void>;
-    getConversations(id: string): Promise<import("@epam/ai-dial-shared").GetConversationsResponse>;
-    createConversation(id: string, parentPath?: string | null): Promise<import("@epam/ai-dial-shared").CreateConversationResponse>;
-    selectConversation(id: string, conversationId: string): Promise<import("@epam/ai-dial-shared").SelectConversationResponse>;
-    setOverlayOptions(id: string, options: ChatOverlayOptions): Promise<void>;
-    subscribe(id: string, eventType: string, callback: (payload?: unknown) => void): () => void;
+    updateOverlay(overlayId: string): void;
+    setSystemPrompt(overlayId: string, systemPrompt: string): Promise<void>;
+    getMessages(overlayId: string): Promise<import("@epam/ai-dial-shared").GetMessagesResponse>;
+    sendMessage(overlayId: string, content: string): Promise<void>;
+    getConversations(overlayId: string): Promise<import("@epam/ai-dial-shared").GetConversationsResponse>;
+    getSelectedConversations(overlayId: string): Promise<import("@epam/ai-dial-shared").GetSelectedConversationsResponse>;
+    createConversation(overlayId: string, parentPath?: string | null): Promise<import("@epam/ai-dial-shared").CreateConversationResponse>;
+    createLocalConversation(overlayId: string): Promise<import("@epam/ai-dial-shared").CreateLocalConversationResponse>;
+    selectConversation(overlayId: string, conversationId: string): Promise<import("@epam/ai-dial-shared").SelectConversationResponse>;
+    renameConversation(overlayId: string, conversationId: string, newName: string): Promise<import("@epam/ai-dial-shared").RenameConversationResponse>;
+    setOverlayOptions(overlayId: string, options: ChatOverlayOptions): Promise<void>;
+    deleteConversation(overlayId: string, conversationId: string): Promise<void>;
+    createPlaybackConversation(overlayId: string, conversationId: string): Promise<import("@epam/ai-dial-shared").CreatePlaybackConversationResponse>;
+    exportConversation(overlayId: string, conversationId: string): Promise<import("@epam/ai-dial-shared").ExportConversationResponse>;
+    importConversation(overlayId: string, importedConversation: LatestExportConversationsFormat): Promise<import("@epam/ai-dial-shared").ImportConversationResponse>;
+    subscribe(overlayId: string, eventType: string, callback: (payload?: unknown) => void): () => void;
     /**
      * Get reference to overlay from this.overlay with specified id
      * Throws exception if there is no such overlay with specified id
-     * @param id {string} id of overlay that should be returned
+     * @param overlayId {string} id of overlay that should be returned
      * @returns {Overlay} reference to overlay with specified id
      */
-    protected getOverlay(id: string): Overlay;
+    protected getOverlay(overlayId: string): Overlay;
     /**
      * Checks that window has mobile view
      * @returns {boolean} Returns true if window has mobile view