@jupyter/chat 0.20.0-alpha.2 → 0.20.0-alpha.3

package/lib/widgets/multichat-panel.d.ts

@@ -1,69 +1,92 @@
-import { PanelWithToolbar, SidePanel } from '@jupyterlab/ui-components';
+import { PanelWithToolbar } from '@jupyterlab/ui-components';
+import { Message } from '@lumino/messaging';
 import { ISignal } from '@lumino/signaling';
-import { Panel } from '@lumino/widgets';
 import { ChatWidget } from './chat-widget';
 import { Chat, IInputToolbarRegistryFactory } from '../components';
 import { IChatModel } from '../model';
 /**
  * Generic sidepanel widget including multiple chats and the add chat button.
  */
-export declare class MultiChatPanel extends SidePanel {
+export declare class MultiChatPanel extends PanelWithToolbar {
+    /**
+     * The constructor of the multichat panel.
+     */
     constructor(options: MultiChatPanel.IOptions);
     /**
-     * The sections of the side panel.
+     * The currently displayed chat widget.
      */
-    get sections(): ChatSection[];
+    get current(): SidePanelWidget | undefined;
     /**
-     * A signal emitting when a section is added to the panel.
+     * A signal emitting when a chat widget is opened in the panel.
      */
-    get sectionAdded(): ISignal<MultiChatPanel, ChatSection>;
+    get chatOpened(): ISignal<MultiChatPanel, ChatWidget>;
     /**
-     * Add a new widget to the chat panel.
+     * A signal emitting when the panel visibility changed.
+     */
+    get visibilityChanged(): ISignal<MultiChatPanel, boolean>;
+    /**
+     * Add a chat to the panel by creating or showing its widget.
      *
-     * @param model - the model of the chat widget
-     * @param displayName - the name of the chat.
+     * @param args - the chat args including model and display name.
+     */
+    open(args: MultiChatPanel.IOpenChatArgs): ChatWidget | undefined;
+    /**
+     * Get a loaded model by name, or undefined if not loaded.
+     */
+    getLoadedModel(name: string): IChatModel | undefined;
+    /**
+     * Get all loaded model names.
+     */
+    getLoadedModelNames(): string[];
+    /**
+     * Dispose a model, removing it from loaded models.
      */
-    addChat(args: MultiChatPanel.IAddChatArgs): ChatWidget | undefined;
+    disposeLoadedModel(name: string): void;
+    /**
+     * Emit a signal when the panel visibility changed.
+     */
+    protected onAfterShow(msg: Message): void;
+    protected onBeforeHide(msg: Message): void;
+    /**
+     * Open a specific chat by name, creating a new sidepanel widget.
+     */
+    private _open;
     /**
      * Invoke the update of the list of available chats.
      */
-    updateChatList(): void;
+    updateChatList: () => void;
     /**
      * Update the list of available chats.
      */
     private _updateChatList;
     /**
-     * Open a chat if it exists in the side panel.
+     * Open a chat if its model is already loaded.
      *
      * @param name - the name of the chat.
-     * @returns a boolean, whether the chat existed in the side panel or not.
+     * @returns a boolean, whether the chat model was already loaded or not.
      */
-    openIfExists(name: string): boolean;
+    openIfLoaded(name: string): boolean;
     /**
      * A message handler invoked on an `'after-attach'` message.
      */
     protected onAfterAttach(): void;
     /**
-     * Return the index of the chat in the list (-1 if not opened).
-     *
-     * @param name - the chat name.
+     * A message handler invoked on an `'before-detach'` message.
      */
-    private _getChatIndex;
+    protected onBeforeDetach(): void;
     /**
-     * Expand the chat from its index.
+     * Dispose of the resources held by the widget.
      */
-    private _expandChat;
+    dispose(): void;
     /**
-     * Handle `change` events for the HTMLSelect component.
+     * Update loaded model when the current widget updates its name.
      */
-    private _chatSelected;
+    private _modelNameChanged;
     /**
-     * Triggered when a section is toggled. If the section is opened, all others
-     * sections are closed.
+     * Handle chat selection from the popup.
      */
-    private _onExpansionToggled;
-    private _chatNamesChanged;
-    private _sectionAdded;
+    private _onSelectChat;
+    private _chatOpened;
     private _chatOptions;
     private _inputToolbarFactory?;
     private _updateChatListDebouncer;
@@ -72,6 +95,11 @@ export declare class MultiChatPanel extends SidePanel {
     private _openInMain?;
     private _renameChat?;
     private _openChatWidget?;
+    private _chatSelectorPopup?;
+    private _loadedModels;
+    private _currentWidget?;
+    private _chatNames;
+    private _visibilityChanged;
 }
 /**
  * The chat panel namespace.
@@ -80,7 +108,7 @@ export declare namespace MultiChatPanel {
     /**
      * Options of the constructor of the chat panel.
      */
-    interface IOptions extends SidePanel.IOptions, Omit<Chat.IOptions, 'model' | 'inputToolbarRegistry'> {
+    interface IOptions extends PanelWithToolbar.IOptions, Omit<Chat.IOptions, 'model' | 'inputToolbarRegistry'> {
         /**
          * The input toolbar factory;
          */
@@ -89,13 +117,13 @@ export declare namespace MultiChatPanel {
          * An optional callback to create a chat model.
          *
          * @param name - the name of the chat, optional.
-         * @return an object that can be passed to add a chat section.
+         * @return an object that can be passed to open the chat.
          */
-        createModel?: (name?: string) => Promise<IAddChatArgs>;
+        createModel?: (name?: string) => Promise<IOpenChatArgs>;
         /**
          * An optional callback to get the list of existing chats.
          *
-         * @returns an object with display name as key and the "full" name as value.
+         * @returns an object mapping chat display names to identifiers.
          */
         getChatNames?: () => Promise<{
             [name: string]: string;
@@ -113,95 +141,94 @@ export declare namespace MultiChatPanel {
          * @param newName - the new name of the chat.
          * @returns - a boolean, whether the chat has been renamed or not.
          */
-        renameChat?: (oldName: string, newName: string) => Promise<boolean>;
+        renameChat?: boolean | ((oldName: string) => Promise<string | null>);
     }
     /**
      * The options for the add chat method.
      */
-    interface IAddChatArgs {
+    interface IOpenChatArgs {
         /**
          * The model of the chat.
-         * No-op id undefined.
+         * No-op if undefined.
          */
         model?: IChatModel;
         /**
-         * The display name of the chat in the section title.
+         * The display name of the chat, shown in the toolbar.
          */
         displayName?: string;
     }
 }
 /**
- * The chat section containing a chat widget.
+ * A widget containing the chat and its toolbar.
  */
-export declare class ChatSection extends PanelWithToolbar {
+declare class SidePanelWidget extends PanelWithToolbar {
+    constructor(options: SidePanelWidget.IOptions);
     /**
-     * Constructor of the chat section.
+     * The chat widget embedded in the sidepanel widget.
      */
-    constructor(options: ChatSection.IOptions);
+    get widget(): ChatWidget;
     /**
-     * The display name.
+     * The model of the widget.
      */
-    get displayName(): string;
-    set displayName(value: string);
+    get model(): IChatModel;
     /**
-     * The chat widget of the section.
+     * The displayed name of the widget.
      */
-    get widget(): ChatWidget;
+    get name(): string;
+    set name(value: string);
     /**
-     * The model of the widget.
+     * A signal emitting when the name has changed.
      */
-    get model(): IChatModel;
+    get nameChanged(): ISignal<SidePanelWidget, {
+        old: string;
+        new: string;
+    }>;
     /**
      * Dispose of the resources held by the widget.
      */
     dispose(): void;
     /**
-     *  * Update the section’s title based on the chat name.
-     * */
+     * Update the title based on the chat name.
+     */
     private _updateTitle;
     /**
-     * Change the title when messages are unread.
-     *
-     * TODO: fix it upstream in @jupyterlab/ui-components.
-     * Updating the title create a new Title widget, but does not attach again the
-     * toolbar. The toolbar is attached only when the title widget is attached the first
-     * time.
+     * Enable/disable unread icon.
      */
     private _unreadChanged;
     private _chatWidget;
     private _markAsRead;
-    private _spinner;
     private _displayName;
+    private _titleWidget;
+    private _nameChanged;
 }
 /**
- * The chat section namespace.
+ * The sidepanel widget namespace.
  */
-export declare namespace ChatSection {
+declare namespace SidePanelWidget {
     /**
-     * Options to build a chat section.
+     * The sidepanel widget constructor options.
      */
-    interface IOptions extends Panel.IOptions {
+    interface IOptions {
         /**
-         * The widget to display in the section.
+         * The chat widget.
          */
         widget: ChatWidget;
         /**
-         * An optional callback to open the chat in the main area.
-         *
-         * @param name - the name of the chat to move.
+         * The callback when closing the chat.
          */
-        openInMain?: (name: string) => Promise<boolean>;
+        onClose: (name: string) => void;
         /**
-         * An optional callback to rename a chat.
-         *
-         * @param oldName - the old name of the chat.
-         * @param newName - the new name of the chat.
-         * @returns - a boolean, whether the chat has been renamed or not.
+         * The displayed name of the chat.
          */
-        renameChat?: (oldName: string, newName: string) => Promise<boolean>;
+        displayName?: string;
         /**
-         * The name to display in the section title.
+         * The callback to open the chat in main area.
          */
-        displayName?: string;
+        openInMain?: (name: string) => Promise<boolean>;
+        /**
+         * The callback to rename the chat.
+         */
+        renameChat?: boolean | ((oldName: string) => Promise<string | null>);
     }
 }
+export {};