jupyterlab-chat 0.16.0 → 0.18.0

package/lib/factory.d.ts

@@ -1,4 +1,4 @@
-import { IAttachmentOpenerRegistry, IChatCommandRegistry, IInputToolbarRegistry, IMessageFooterRegistry } from '@jupyter/chat';
+import { IAttachmentOpenerRegistry, IChatCommandRegistry, IInputToolbarRegistry, IMessageFooterRegistry, IInputToolbarRegistryFactory } from '@jupyter/chat';
 import { IThemeManager } from '@jupyterlab/apputils';
 import { IDocumentManager } from '@jupyterlab/docmanager';
 import { ABCWidgetFactory, DocumentRegistry } from '@jupyterlab/docregistry';
@@ -8,7 +8,7 @@ import { ISignal } from '@lumino/signaling';
 import { LabChatModel } from './model';
 import { LabChatPanel } from './widget';
 import { YChat } from './ychat';
-import { IInputToolbarRegistryFactory, ILabChatConfig, IWidgetConfig } from './token';
+import { ILabChatConfig, IWidgetConfig } from './token';
 /**
  * The object provided by the chatDocument extension.
  * It is used to set the current config (from settings) to newly created chat widget,

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 export * from './factory';
 export * from './model';
 export * from './token';
+export * from './utils';
 export * from './widget';
 export * from './ychat';

package/lib/index.js

@@ -5,5 +5,6 @@
 export * from './factory';
 export * from './model';
 export * from './token';
+export * from './utils';
 export * from './widget';
 export * from './ychat';

package/lib/model.d.ts

@@ -54,12 +54,10 @@ export declare class LabChatModel extends AbstractChatModel implements DocumentR
     get sharedModel(): YChat;
     get contentChanged(): ISignal<this, void>;
     get stateChanged(): ISignal<this, IChangedArgs<any, any, string>>;
-    get ready(): Promise<void>;
     get dirty(): boolean;
     set dirty(value: boolean);
     get readOnly(): boolean;
     set readOnly(value: boolean);
-    get disposed(): ISignal<LabChatModel, void>;
     set id(value: string | undefined);
     dispose(): void;
     toString(): string;
@@ -96,11 +94,9 @@ export declare class LabChatModel extends AbstractChatModel implements DocumentR
     private _onchange;
     readonly defaultKernelName: string;
     readonly defaultKernelLanguage: string;
-    private _ready;
     private _sharedModel;
     private _dirty;
     private _readOnly;
-    private _disposed;
     private _contentChanged;
     private _stateChanged;
     private _timeoutWriting;

package/lib/model.js

@@ -3,7 +3,7 @@
  * Distributed under the terms of the Modified BSD License.
  */
 import { AbstractChatModel, AbstractChatContext } from '@jupyter/chat';
-import { PromiseDelegate, UUID } from '@lumino/coreutils';
+import { UUID } from '@lumino/coreutils';
 import { Signal } from '@lumino/signaling';
 import { YChat } from './ychat';
 const WRITING_DELAY = 1000;
@@ -172,10 +172,8 @@ export class LabChatModel extends AbstractChatModel {
         };
         this.defaultKernelName = '';
         this.defaultKernelLanguage = '';
-        this._ready = new PromiseDelegate();
         this._dirty = false;
         this._readOnly = false;
-        this._disposed = new Signal(this);
         this._contentChanged = new Signal(this);
         this._stateChanged = new Signal(this);
         this._timeoutWriting = null;
@@ -209,9 +207,6 @@ export class LabChatModel extends AbstractChatModel {
     get stateChanged() {
         return this._stateChanged;
     }
-    get ready() {
-        return this._ready.promise;
-    }
     get dirty() {
         return this._dirty;
     }
@@ -224,13 +219,10 @@ export class LabChatModel extends AbstractChatModel {
     set readOnly(value) {
         this._readOnly = value;
     }
-    get disposed() {
-        return this._disposed;
-    }
     set id(value) {
         super.id = value;
         if (value) {
-            this._ready.resolve();
+            this.setReady();
         }
     }
     dispose() {
@@ -239,7 +231,6 @@ export class LabChatModel extends AbstractChatModel {
         }
         super.dispose();
         this._sharedModel.dispose();
-        this._disposed.emit();
         Signal.clearData(this);
     }
     toString() {
@@ -260,7 +251,7 @@ export class LabChatModel extends AbstractChatModel {
     async messagesInserted(index, messages) {
         // Ensure the chat has an ID before inserting the messages, to properly catch the
         // unread messages (the last read message is saved using the chat ID).
-        return this._ready.promise.then(() => {
+        return this.ready.then(() => {
             super.messagesInserted(index, messages);
         });
     }

package/lib/token.d.ts

@@ -1,9 +1,10 @@
-import { IConfig, IActiveCellManager, ISelectionWatcher, ChatWidget, IInputToolbarRegistry } from '@jupyter/chat';
+import { IConfig, IActiveCellManager, ISelectionWatcher, ChatWidget } from '@jupyter/chat';
 import { WidgetTracker } from '@jupyterlab/apputils';
 import { DocumentRegistry } from '@jupyterlab/docregistry';
 import { Token } from '@lumino/coreutils';
 import { ISignal } from '@lumino/signaling';
-import { ChatPanel, LabChatPanel } from './widget';
+import { LabChatPanel } from './widget';
+import { MultiChatPanel as ChatPanel } from '@jupyter/chat';
 /**
  * The file type for a chat document.
  */
@@ -64,6 +65,10 @@ export declare const CommandIDs: {
      * Open a chat file.
      */
     openChat: string;
+    /**
+     * Create and open.
+     */
+    createAndOpen: string;
     /**
      * Move a main widget to the side panel.
      */
@@ -76,6 +81,10 @@ export declare const CommandIDs: {
      * Focus the input of the current chat.
      */
     focusInput: string;
+    /**
+     * Rename the current chat.
+     */
+    renameChat: string;
 };
 /**
  * The chat panel token.
@@ -89,19 +98,6 @@ export declare const IActiveCellManagerToken: Token<IActiveCellManager>;
  * The selection watcher plugin.
  */
 export declare const ISelectionWatcherToken: Token<ISelectionWatcher>;
-/**
- * The input toolbar registry factory.
- */
-export interface IInputToolbarRegistryFactory {
-    /**
-     * Create an input toolbar registry.
-     */
-    create: () => IInputToolbarRegistry;
-}
-/**
- * The token of the factory to create an input toolbar registry.
- */
-export declare const IInputToolbarRegistryFactory: Token<IInputToolbarRegistryFactory>;
 /**
  * The token to add a welcome message to the chat.
  * This token is not provided by default, but can be provided by third party extensions

package/lib/token.js

@@ -32,6 +32,10 @@ export const CommandIDs = {
      * Open a chat file.
      */
     openChat: 'jupyterlab-chat:open',
+    /**
+     * Create and open.
+     */
+    createAndOpen: 'jupyterlab-chat:createAndOpen',
     /**
      * Move a main widget to the side panel.
      */
@@ -43,7 +47,11 @@ export const CommandIDs = {
     /**
      * Focus the input of the current chat.
      */
-    focusInput: 'jupyterlab-chat:focusInput'
+    focusInput: 'jupyterlab-chat:focusInput',
+    /**
+     * Rename the current chat.
+     */
+    renameChat: 'jupyterlab-chat:renameChat'
 };
 /**
  * The chat panel token.
@@ -57,10 +65,6 @@ export const IActiveCellManagerToken = new Token('jupyterlab-chat:IActiveCellMan
  * The selection watcher plugin.
  */
 export const ISelectionWatcherToken = new Token('jupyterlab-chat:ISelectionWatcher');
-/**
- * The token of the factory to create an input toolbar registry.
- */
-export const IInputToolbarRegistryFactory = new Token('jupyterlab-chat:IInputToolbarRegistryFactory');
 /**
  * The token to add a welcome message to the chat.
  * This token is not provided by default, but can be provided by third party extensions

package/lib/utils.d.ts

@@ -0,0 +1,7 @@
+/**
+ *
+ * @param defaultDirectory - the default directory.
+ * @param path - the path of the chat file.
+ * @returns - the display name of the chat.
+ */
+export declare function getDisplayName(path: string, defaultDirectory?: string): string;

package/lib/utils.js

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+import { PathExt } from '@jupyterlab/coreutils';
+import { chatFileType } from './token';
+/**
+ *
+ * @param defaultDirectory - the default directory.
+ * @param path - the path of the chat file.
+ * @returns - the display name of the chat.
+ */
+export function getDisplayName(path, defaultDirectory) {
+    const inDefault = defaultDirectory
+        ? !PathExt.relative(defaultDirectory, path).startsWith('..')
+        : true;
+    const pattern = new RegExp(`${chatFileType.extensions[0]}$`, 'g');
+    return (inDefault
+        ? defaultDirectory
+            ? PathExt.relative(defaultDirectory, path)
+            : path
+        : '/' + path).replace(pattern, '');
+}

package/lib/widget.d.ts

@@ -1,14 +1,6 @@
-import { ChatWidget, IAttachmentOpenerRegistry, IChatCommandRegistry, IChatModel, IMessageFooterRegistry } from '@jupyter/chat';
-import { Contents } from '@jupyterlab/services';
-import { IThemeManager } from '@jupyterlab/apputils';
+import { ChatWidget } from '@jupyter/chat';
 import { DocumentWidget } from '@jupyterlab/docregistry';
-import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
-import { SidePanel } from '@jupyterlab/ui-components';
-import { CommandRegistry } from '@lumino/commands';
-import { Message } from '@lumino/messaging';
-import { Panel } from '@lumino/widgets';
 import { LabChatModel } from './model';
-import { IInputToolbarRegistryFactory } from './token';
 /**
  * DocumentWidget: widget that represents the view or editor for a file type.
  */
@@ -27,104 +19,3 @@ export declare class LabChatPanel extends DocumentWidget<ChatWidget, LabChatMode
      */
     private _unreadChanged;
 }
-/**
- * Sidepanel widget including the chats and the add chat button.
- */
-export declare class ChatPanel extends SidePanel {
-    /**
-     * The constructor of the chat panel.
-     */
-    constructor(options: ChatPanel.IOptions);
-    /**
-     * Getter and setter of the defaultDirectory.
-     */
-    get defaultDirectory(): string;
-    set defaultDirectory(value: string);
-    /**
-     * Add a new widget to the chat panel.
-     *
-     * @param model - the model of the chat widget
-     * @param name - the name of the chat.
-     */
-    addChat(model: IChatModel): ChatWidget;
-    /**
-     * Update the list of available chats in the default directory.
-     */
-    updateChatList: () => Promise<void>;
-    /**
-     * Open a chat if it exists in the side panel.
-     *
-     * @param path - the path of the chat.
-     * @returns a boolean, whether the chat existed in the side panel or not.
-     */
-    openIfExists(path: string): boolean;
-    /**
-     * A message handler invoked on an `'after-show'` message.
-     */
-    protected onAfterShow(msg: Message): void;
-    /**
-     * Return the index of the chat in the list (-1 if not opened).
-     *
-     * @param name - the chat name.
-     */
-    private _getChatIndex;
-    /**
-     * Expand the chat from its index.
-     */
-    private _expandChat;
-    /**
-     * Handle `change` events for the HTMLSelect component.
-     */
-    private _chatSelected;
-    /**
-     * Triggered when a section is toogled. If the section is opened, all others
-     * sections are closed.
-     */
-    private _onExpansionToggled;
-    private _chatNamesChanged;
-    private _commands;
-    private _defaultDirectory;
-    private _contentsManager;
-    private _openChat;
-    private _rmRegistry;
-    private _themeManager;
-    private _chatCommandRegistry?;
-    private _attachmentOpenerRegistry?;
-    private _inputToolbarFactory?;
-    private _messageFooterRegistry?;
-    private _welcomeMessage?;
-}
-/**
- * The chat panel namespace.
- */
-export declare namespace ChatPanel {
-    /**
-     * Options of the constructor of the chat panel.
-     */
-    interface IOptions extends SidePanel.IOptions {
-        commands: CommandRegistry;
-        contentsManager: Contents.IManager;
-        rmRegistry: IRenderMimeRegistry;
-        themeManager: IThemeManager | null;
-        defaultDirectory: string;
-        chatCommandRegistry?: IChatCommandRegistry;
-        attachmentOpenerRegistry?: IAttachmentOpenerRegistry;
-        inputToolbarFactory?: IInputToolbarRegistryFactory;
-        messageFooterRegistry?: IMessageFooterRegistry;
-        welcomeMessage?: string;
-    }
-}
-/**
- * The chat section namespace.
- */
-export declare namespace ChatSection {
-    /**
-     * Options to build a chat section.
-     */
-    interface IOptions extends Panel.IOptions {
-        commands: CommandRegistry;
-        defaultDirectory: string;
-        widget: ChatWidget;
-        path: string;
-    }
-}

package/lib/widget.js

@@ -2,20 +2,9 @@
  * Copyright (c) Jupyter Development Team.
  * Distributed under the terms of the Modified BSD License.
  */
-import { ChatWidget, readIcon } from '@jupyter/chat';
-import { PathExt } from '@jupyterlab/coreutils';
 import { DocumentWidget } from '@jupyterlab/docregistry';
-import { addIcon, closeIcon, CommandToolbarButton, HTMLSelect, launchIcon, PanelWithToolbar, ReactWidget, SidePanel, Spinner, ToolbarButton } from '@jupyterlab/ui-components';
-import { Signal } from '@lumino/signaling';
-import React, { useState } from 'react';
-import { CommandIDs, chatFileType } from './token';
 const MAIN_PANEL_CLASS = 'jp-lab-chat-main-panel';
 const TITLE_UNREAD_CLASS = 'jp-lab-chat-title-unread';
-const SIDEPANEL_CLASS = 'jp-lab-chat-sidepanel';
-const ADD_BUTTON_CLASS = 'jp-lab-chat-add';
-const OPEN_SELECT_CLASS = 'jp-lab-chat-open';
-const SECTION_CLASS = 'jp-lab-chat-section';
-const TOOLBAR_CLASS = 'jp-lab-chat-toolbar';
 /**
  * DocumentWidget: widget that represents the view or editor for a file type.
  */
@@ -55,309 +44,3 @@ export class LabChatPanel extends DocumentWidget {
         return this.context.model;
     }
 }
-/**
- * Sidepanel widget including the chats and the add chat button.
- */
-export class ChatPanel extends SidePanel {
-    /**
-     * The constructor of the chat panel.
-     */
-    constructor(options) {
-        super(options);
-        /**
-         * Update the list of available chats in the default directory.
-         */
-        this.updateChatList = async () => {
-            const extension = chatFileType.extensions[0];
-            this._contentsManager
-                .get(this._defaultDirectory)
-                .then((contentModel) => {
-                const chatsNames = {};
-                contentModel.content
-                    .filter(f => f.type === 'file' && f.name.endsWith(extension))
-                    .forEach(f => {
-                    chatsNames[PathExt.basename(f.name, extension)] = f.path;
-                });
-                this._chatNamesChanged.emit(chatsNames);
-            })
-                .catch(e => console.error('Error getting the chat files from drive', e));
-        };
-        /**
-         * Handle `change` events for the HTMLSelect component.
-         */
-        this._chatSelected = (event) => {
-            const select = event.target;
-            const path = select.value;
-            const name = select.options[select.selectedIndex].textContent;
-            if (name === '-') {
-                return;
-            }
-            this._commands.execute(CommandIDs.openChat, {
-                filepath: path,
-                inSidePanel: true
-            });
-            event.target.selectedIndex = 0;
-        };
-        this._chatNamesChanged = new Signal(this);
-        this.addClass(SIDEPANEL_CLASS);
-        this._commands = options.commands;
-        this._contentsManager = options.contentsManager;
-        this._rmRegistry = options.rmRegistry;
-        this._themeManager = options.themeManager;
-        this._defaultDirectory = options.defaultDirectory;
-        this._chatCommandRegistry = options.chatCommandRegistry;
-        this._attachmentOpenerRegistry = options.attachmentOpenerRegistry;
-        this._inputToolbarFactory = options.inputToolbarFactory;
-        this._messageFooterRegistry = options.messageFooterRegistry;
-        this._welcomeMessage = options.welcomeMessage;
-        const addChat = new CommandToolbarButton({
-            commands: this._commands,
-            id: CommandIDs.createChat,
-            args: { inSidePanel: true },
-            icon: addIcon
-        });
-        addChat.addClass(ADD_BUTTON_CLASS);
-        this.toolbar.addItem('createChat', addChat);
-        this._openChat = ReactWidget.create(React.createElement(ChatSelect, { chatNamesChanged: this._chatNamesChanged, handleChange: this._chatSelected.bind(this) }));
-        this._openChat.addClass(OPEN_SELECT_CLASS);
-        this.toolbar.addItem('openChat', this._openChat);
-        const content = this.content;
-        content.expansionToggled.connect(this._onExpansionToggled, this);
-    }
-    /**
-     * Getter and setter of the defaultDirectory.
-     */
-    get defaultDirectory() {
-        return this._defaultDirectory;
-    }
-    set defaultDirectory(value) {
-        if (value === this._defaultDirectory) {
-            return;
-        }
-        this._defaultDirectory = value;
-        // Update the list of discoverable chat (in default directory)
-        this.updateChatList();
-        // Update the sections names.
-        this.widgets.forEach(w => {
-            w.defaultDirectory = value;
-        });
-    }
-    /**
-     * Add a new widget to the chat panel.
-     *
-     * @param model - the model of the chat widget
-     * @param name - the name of the chat.
-     */
-    addChat(model) {
-        // Collapse all chats
-        const content = this.content;
-        for (let i = 0; i < this.widgets.length; i++) {
-            content.collapse(i);
-        }
-        // Create the toolbar registry.
-        let inputToolbarRegistry;
-        if (this._inputToolbarFactory) {
-            inputToolbarRegistry = this._inputToolbarFactory.create();
-        }
-        // Create a new widget.
-        const widget = new ChatWidget({
-            model: model,
-            rmRegistry: this._rmRegistry,
-            themeManager: this._themeManager,
-            chatCommandRegistry: this._chatCommandRegistry,
-            attachmentOpenerRegistry: this._attachmentOpenerRegistry,
-            inputToolbarRegistry,
-            messageFooterRegistry: this._messageFooterRegistry,
-            welcomeMessage: this._welcomeMessage
-        });
-        this.addWidget(new ChatSection({
-            widget,
-            commands: this._commands,
-            path: model.name,
-            defaultDirectory: this._defaultDirectory
-        }));
-        return widget;
-    }
-    /**
-     * Open a chat if it exists in the side panel.
-     *
-     * @param path - the path of the chat.
-     * @returns a boolean, whether the chat existed in the side panel or not.
-     */
-    openIfExists(path) {
-        const index = this._getChatIndex(path);
-        if (index > -1) {
-            this._expandChat(index);
-        }
-        return index > -1;
-    }
-    /**
-     * A message handler invoked on an `'after-show'` message.
-     */
-    onAfterShow(msg) {
-        var _a;
-        // Wait for the component to be rendered.
-        (_a = this._openChat.renderPromise) === null || _a === void 0 ? void 0 : _a.then(() => this.updateChatList());
-    }
-    /**
-     * Return the index of the chat in the list (-1 if not opened).
-     *
-     * @param name - the chat name.
-     */
-    _getChatIndex(path) {
-        return this.widgets.findIndex(w => w.path === path);
-    }
-    /**
-     * Expand the chat from its index.
-     */
-    _expandChat(index) {
-        if (!this.widgets[index].isVisible) {
-            this.content.expand(index);
-        }
-    }
-    /**
-     * Triggered when a section is toogled. If the section is opened, all others
-     * sections are closed.
-     */
-    _onExpansionToggled(panel, index) {
-        if (!this.widgets[index].isVisible) {
-            return;
-        }
-        for (let i = 0; i < this.widgets.length; i++) {
-            if (i !== index) {
-                panel.collapse(i);
-            }
-        }
-    }
-}
-/**
- * The chat section containing a chat widget.
- */
-class ChatSection extends PanelWithToolbar {
-    /**
-     * Constructor of the chat section.
-     */
-    constructor(options) {
-        var _a;
-        super(options);
-        /**
-         * 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.
-         */
-        this._unreadChanged = (_, unread) => {
-            this._markAsRead.enabled = unread.length > 0;
-            // this.title.label = `${unread.length ? '* ' : ''}${this._name}`;
-        };
-        this._spinner = new Spinner();
-        this.addWidget(options.widget);
-        this.addWidget(this._spinner);
-        this.addClass(SECTION_CLASS);
-        this._defaultDirectory = options.defaultDirectory;
-        this._path = options.path;
-        this._updateTitle();
-        this.toolbar.addClass(TOOLBAR_CLASS);
-        this._markAsRead = new ToolbarButton({
-            icon: readIcon,
-            iconLabel: 'Mark chat as read',
-            className: 'jp-mod-styled',
-            onClick: () => (this.model.unreadMessages = [])
-        });
-        const moveToMain = new ToolbarButton({
-            icon: launchIcon,
-            iconLabel: 'Move the chat to the main area',
-            className: 'jp-mod-styled',
-            onClick: () => {
-                this.model.dispose();
-                options.commands.execute(CommandIDs.openChat, {
-                    filepath: this._path
-                });
-                this.dispose();
-            }
-        });
-        const closeButton = new ToolbarButton({
-            icon: closeIcon,
-            iconLabel: 'Close the chat',
-            className: 'jp-mod-styled',
-            onClick: () => {
-                this.model.dispose();
-                this.dispose();
-            }
-        });
-        this.toolbar.addItem('jupyterlabChat-markRead', this._markAsRead);
-        this.toolbar.addItem('jupyterlabChat-moveMain', moveToMain);
-        this.toolbar.addItem('jupyterlabChat-close', closeButton);
-        (_a = this.model.unreadChanged) === null || _a === void 0 ? void 0 : _a.connect(this._unreadChanged);
-        this._markAsRead.enabled = this.model.unreadMessages.length > 0;
-        options.widget.node.style.height = '100%';
-        /**
-         * Remove the spinner when the chat is ready.
-         */
-        const model = this.model;
-        model.ready.then(() => {
-            this._spinner.dispose();
-        });
-    }
-    /**
-     * The path of the chat.
-     */
-    get path() {
-        return this._path;
-    }
-    /**
-     * Set the default directory property.
-     */
-    set defaultDirectory(value) {
-        this._defaultDirectory = value;
-        this._updateTitle();
-    }
-    /**
-     * The model of the widget.
-     */
-    get model() {
-        return this.widgets[0].model;
-    }
-    /**
-     * Dispose of the resources held by the widget.
-     */
-    dispose() {
-        var _a;
-        (_a = this.model.unreadChanged) === null || _a === void 0 ? void 0 : _a.disconnect(this._unreadChanged);
-        super.dispose();
-    }
-    /**
-     * Update the section's title, depending on the default directory and chat file name.
-     * If the chat file is in the default directory, the section's name is its relative
-     * path to that default directory. Otherwise, it is it absolute path.
-     */
-    _updateTitle() {
-        const inDefault = this._defaultDirectory
-            ? !PathExt.relative(this._defaultDirectory, this._path).startsWith('..')
-            : true;
-        const pattern = new RegExp(`${chatFileType.extensions[0]}$`, 'g');
-        this.title.label = (inDefault
-            ? this._defaultDirectory
-                ? PathExt.relative(this._defaultDirectory, this._path)
-                : this._path
-            : '/' + this._path).replace(pattern, '');
-        this.title.caption = this._path;
-    }
-}
-/**
- * A component to select a chat from the drive.
- */
-function ChatSelect({ chatNamesChanged, handleChange }) {
-    // An object associating a chat name to its path. Both are purely indicative, the name
-    // is the section title and the path is used as caption.
-    const [chatNames, setChatNames] = useState({});
-    // Update the chat list.
-    chatNamesChanged.connect((_, chatNames) => {
-        setChatNames(chatNames);
-    });
-    return (React.createElement(HTMLSelect, { onChange: handleChange },
-        React.createElement("option", { value: "-" }, "Open a chat"),
-        Object.keys(chatNames).map(name => (React.createElement("option", { value: chatNames[name] }, name)))));
-}