jupyterlab-chat 0.8.0 → 0.9.0

package/lib/factory.d.ts

@@ -1,4 +1,4 @@
-import { IAttachmentOpenerRegistry, IChatCommandRegistry } from '@jupyter/chat';
+import { IAttachmentOpenerRegistry, IChatCommandRegistry, IInputToolbarRegistry } 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 { ILabChatConfig, IWidgetConfig } from './token';
+import { IInputToolbarRegistryFactory, 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,
@@ -50,9 +50,9 @@ export declare class ChatWidgetFactory extends ABCWidgetFactory<LabChatPanel, La
     protected createNewWidget(context: ChatWidgetFactory.IContext): LabChatPanel;
     private _themeManager;
     private _rmRegistry;
-    private _documentManager?;
     private _chatCommandRegistry?;
     private _attachmentOpenerRegistry?;
+    private _inputToolbarRegistry?;
 }
 export declare namespace ChatWidgetFactory {
     interface IContext extends DocumentRegistry.IContext<LabChatModel> {
@@ -61,13 +61,14 @@ export declare namespace ChatWidgetFactory {
         documentManager?: IDocumentManager;
         chatCommandRegistry?: IChatCommandRegistry;
         attachmentOpenerRegistry?: IAttachmentOpenerRegistry;
+        inputToolbarRegistry?: IInputToolbarRegistry;
     }
     interface IOptions<T extends LabChatPanel> extends DocumentRegistry.IWidgetFactoryOptions<T> {
         themeManager: IThemeManager | null;
         rmRegistry: IRenderMimeRegistry;
-        documentManager?: IDocumentManager;
         chatCommandRegistry?: IChatCommandRegistry;
         attachmentOpenerRegistry?: IAttachmentOpenerRegistry;
+        inputToolbarFactory?: IInputToolbarRegistryFactory;
     }
 }
 export declare class LabChatModelFactory implements DocumentRegistry.IModelFactory<LabChatModel> {
@@ -122,4 +123,5 @@ export declare class LabChatModelFactory implements DocumentRegistry.IModelFacto
     private _commands?;
     private _activeCellManager;
     private _selectionWatcher;
+    private _documentManager;
 }

package/lib/factory.js

@@ -50,9 +50,11 @@ export class ChatWidgetFactory extends ABCWidgetFactory {
         super(options);
         this._themeManager = options.themeManager;
         this._rmRegistry = options.rmRegistry;
-        this._documentManager = options.documentManager;
         this._chatCommandRegistry = options.chatCommandRegistry;
         this._attachmentOpenerRegistry = options.attachmentOpenerRegistry;
+        if (options.inputToolbarFactory) {
+            this._inputToolbarRegistry = options.inputToolbarFactory.create();
+        }
     }
     /**
      * Create a new widget given a context.
@@ -63,9 +65,9 @@ export class ChatWidgetFactory extends ABCWidgetFactory {
     createNewWidget(context) {
         context.rmRegistry = this._rmRegistry;
         context.themeManager = this._themeManager;
-        context.documentManager = this._documentManager;
         context.chatCommandRegistry = this._chatCommandRegistry;
         context.attachmentOpenerRegistry = this._attachmentOpenerRegistry;
+        context.inputToolbarRegistry = this._inputToolbarRegistry;
         return new LabChatPanel({
             context,
             content: new ChatWidget(context)
@@ -74,7 +76,7 @@ export class ChatWidgetFactory extends ABCWidgetFactory {
 }
 export class LabChatModelFactory {
     constructor(options) {
-        var _a, _b;
+        var _a, _b, _c;
         this.collaborative = true;
         this._disposed = false;
         this._user = options.user;
@@ -82,6 +84,7 @@ export class LabChatModelFactory {
         this._commands = options.commands;
         this._activeCellManager = (_a = options.activeCellManager) !== null && _a !== void 0 ? _a : null;
         this._selectionWatcher = (_b = options.selectionWatcher) !== null && _b !== void 0 ? _b : null;
+        this._documentManager = (_c = options.documentManager) !== null && _c !== void 0 ? _c : null;
     }
     /**
      * The name of the model.
@@ -144,7 +147,8 @@ export class LabChatModelFactory {
             widgetConfig: this._widgetConfig,
             commands: this._commands,
             activeCellManager: this._activeCellManager,
-            selectionWatcher: this._selectionWatcher
+            selectionWatcher: this._selectionWatcher,
+            documentManager: this._documentManager
         });
     }
 }

package/lib/model.d.ts

@@ -40,6 +40,10 @@ export declare class LabChatModel extends ChatModel implements DocumentRegistry.
     fromJSON(data: PartialJSONObject): void;
     messagesInserted(index: number, messages: IChatMessage[]): void;
     sendMessage(message: INewMessage): Promise<boolean | void> | boolean | void;
+    /**
+     * Override the clear messages method.
+     */
+    clearMessages(): void;
     updateMessage(id: string, updatedMessage: IChatMessage): Promise<boolean | void> | boolean | void;
     deleteMessage(id: string): Promise<boolean | void> | boolean | void;
     /**

package/lib/model.js

@@ -210,6 +210,12 @@ export class LabChatModel extends ChatModel {
         }
         this.sharedModel.addMessage(msg);
     }
+    /**
+     * Override the clear messages method.
+     */
+    clearMessages() {
+        // No-op as we may not need to clear the messages in file based chat.
+    }
     updateMessage(id, updatedMessage) {
         var _a;
         const index = this.sharedModel.getMessageIndex(id);

package/lib/token.d.ts

@@ -1,4 +1,4 @@
-import { IConfig, IActiveCellManager, ISelectionWatcher, ChatWidget } from '@jupyter/chat';
+import { IConfig, IActiveCellManager, ISelectionWatcher, ChatWidget, IInputToolbarRegistry } from '@jupyter/chat';
 import { WidgetTracker } from '@jupyterlab/apputils';
 import { DocumentRegistry } from '@jupyterlab/docregistry';
 import { Token } from '@lumino/coreutils';
@@ -89,3 +89,16 @@ 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>;

package/lib/token.js

@@ -57,3 +57,7 @@ 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');

package/lib/widget.d.ts

@@ -8,7 +8,7 @@ import { CommandRegistry } from '@lumino/commands';
 import { Message } from '@lumino/messaging';
 import { Panel } from '@lumino/widgets';
 import { LabChatModel } from './model';
-import { IDocumentManager } from '@jupyterlab/docmanager';
+import { IInputToolbarRegistryFactory } from './token';
 /**
  * DocumentWidget: widget that represents the view or editor for a file type.
  */
@@ -88,9 +88,9 @@ export declare class ChatPanel extends SidePanel {
     private _openChat;
     private _rmRegistry;
     private _themeManager;
-    private _documentManager?;
     private _chatCommandRegistry?;
     private _attachmentOpenerRegistry?;
+    private _inputToolbarFactory?;
 }
 /**
  * The chat panel namespace.
@@ -105,9 +105,9 @@ export declare namespace ChatPanel {
         rmRegistry: IRenderMimeRegistry;
         themeManager: IThemeManager | null;
         defaultDirectory: string;
-        documentManager?: IDocumentManager;
         chatCommandRegistry?: IChatCommandRegistry;
         attachmentOpenerRegistry?: IAttachmentOpenerRegistry;
+        inputToolbarFactory?: IInputToolbarRegistryFactory;
     }
 }
 /**

package/lib/widget.js

@@ -105,9 +105,9 @@ export class ChatPanel extends SidePanel {
         this._rmRegistry = options.rmRegistry;
         this._themeManager = options.themeManager;
         this._defaultDirectory = options.defaultDirectory;
-        this._documentManager = options.documentManager;
         this._chatCommandRegistry = options.chatCommandRegistry;
         this._attachmentOpenerRegistry = options.attachmentOpenerRegistry;
+        this._inputToolbarFactory = options.inputToolbarFactory;
         const addChat = new CommandToolbarButton({
             commands: this._commands,
             id: CommandIDs.createChat,
@@ -152,14 +152,19 @@ export class ChatPanel extends SidePanel {
         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,
-            documentManager: this._documentManager,
             chatCommandRegistry: this._chatCommandRegistry,
-            attachmentOpenerRegistry: this._attachmentOpenerRegistry
+            attachmentOpenerRegistry: this._attachmentOpenerRegistry,
+            inputToolbarRegistry
         });
         this.addWidget(new ChatSection({
             widget,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jupyterlab-chat",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "The library to build a chat based on shared document",
   "keywords": [
     "jupyter",
@@ -42,7 +42,7 @@
     "watch:src": "tsc -w --sourceMap"
   },
   "dependencies": {
-    "@jupyter/chat": "^0.8.0",
+    "@jupyter/chat": "^0.9.0",
     "@jupyter/collaborative-drive": "^3.0.0",
     "@jupyter/ydoc": "^2.0.0 || ^3.0.0",
     "@jupyterlab/application": "^4.2.0",

package/src/factory.ts

@@ -8,6 +8,7 @@ import {
   IActiveCellManager,
   IAttachmentOpenerRegistry,
   IChatCommandRegistry,
+  IInputToolbarRegistry,
   ISelectionWatcher
 } from '@jupyter/chat';
 import { IThemeManager } from '@jupyterlab/apputils';
@@ -21,7 +22,11 @@ import { ISignal, Signal } from '@lumino/signaling';
 import { LabChatModel } from './model';
 import { LabChatPanel } from './widget';
 import { YChat } from './ychat';
-import { ILabChatConfig, IWidgetConfig } from './token';
+import {
+  IInputToolbarRegistryFactory,
+  ILabChatConfig,
+  IWidgetConfig
+} from './token';
 
 /**
  * The object provided by the chatDocument extension.
@@ -76,9 +81,11 @@ export class ChatWidgetFactory extends ABCWidgetFactory<
     super(options);
     this._themeManager = options.themeManager;
     this._rmRegistry = options.rmRegistry;
-    this._documentManager = options.documentManager;
     this._chatCommandRegistry = options.chatCommandRegistry;
     this._attachmentOpenerRegistry = options.attachmentOpenerRegistry;
+    if (options.inputToolbarFactory) {
+      this._inputToolbarRegistry = options.inputToolbarFactory.create();
+    }
   }
 
   /**
@@ -90,9 +97,9 @@ export class ChatWidgetFactory extends ABCWidgetFactory<
   protected createNewWidget(context: ChatWidgetFactory.IContext): LabChatPanel {
     context.rmRegistry = this._rmRegistry;
     context.themeManager = this._themeManager;
-    context.documentManager = this._documentManager;
     context.chatCommandRegistry = this._chatCommandRegistry;
     context.attachmentOpenerRegistry = this._attachmentOpenerRegistry;
+    context.inputToolbarRegistry = this._inputToolbarRegistry;
     return new LabChatPanel({
       context,
       content: new ChatWidget(context)
@@ -101,9 +108,9 @@ export class ChatWidgetFactory extends ABCWidgetFactory<
 
   private _themeManager: IThemeManager | null;
   private _rmRegistry: IRenderMimeRegistry;
-  private _documentManager?: IDocumentManager;
   private _chatCommandRegistry?: IChatCommandRegistry;
   private _attachmentOpenerRegistry?: IAttachmentOpenerRegistry;
+  private _inputToolbarRegistry?: IInputToolbarRegistry;
 }
 
 export namespace ChatWidgetFactory {
@@ -113,15 +120,16 @@ export namespace ChatWidgetFactory {
     documentManager?: IDocumentManager;
     chatCommandRegistry?: IChatCommandRegistry;
     attachmentOpenerRegistry?: IAttachmentOpenerRegistry;
+    inputToolbarRegistry?: IInputToolbarRegistry;
   }
 
   export interface IOptions<T extends LabChatPanel>
     extends DocumentRegistry.IWidgetFactoryOptions<T> {
     themeManager: IThemeManager | null;
     rmRegistry: IRenderMimeRegistry;
-    documentManager?: IDocumentManager;
     chatCommandRegistry?: IChatCommandRegistry;
     attachmentOpenerRegistry?: IAttachmentOpenerRegistry;
+    inputToolbarFactory?: IInputToolbarRegistryFactory;
   }
 }
 
@@ -134,6 +142,7 @@ export class LabChatModelFactory
     this._commands = options.commands;
     this._activeCellManager = options.activeCellManager ?? null;
     this._selectionWatcher = options.selectionWatcher ?? null;
+    this._documentManager = options.documentManager ?? null;
   }
 
   collaborative = true;
@@ -206,7 +215,8 @@ export class LabChatModelFactory
       widgetConfig: this._widgetConfig,
       commands: this._commands,
       activeCellManager: this._activeCellManager,
-      selectionWatcher: this._selectionWatcher
+      selectionWatcher: this._selectionWatcher,
+      documentManager: this._documentManager
     });
   }
 
@@ -216,4 +226,5 @@ export class LabChatModelFactory
   private _commands?: CommandRegistry;
   private _activeCellManager: IActiveCellManager | null;
   private _selectionWatcher: ISelectionWatcher | null;
+  private _documentManager: IDocumentManager | null;
 }

package/src/model.ts

@@ -173,6 +173,13 @@ export class LabChatModel extends ChatModel implements DocumentRegistry.IModel {
     this.sharedModel.addMessage(msg);
   }
 
+  /**
+   * Override the clear messages method.
+   */
+  clearMessages(): void {
+    // No-op as we may not need to clear the messages in file based chat.
+  }
+
   updateMessage(
     id: string,
     updatedMessage: IChatMessage

package/src/token.ts

@@ -8,7 +8,8 @@ import {
   chatIcon,
   IActiveCellManager,
   ISelectionWatcher,
-  ChatWidget
+  ChatWidget,
+  IInputToolbarRegistry
 } from '@jupyter/chat';
 import { WidgetTracker } from '@jupyterlab/apputils';
 import { DocumentRegistry } from '@jupyterlab/docregistry';
@@ -125,3 +126,21 @@ export const IActiveCellManagerToken = new Token<IActiveCellManager>(
 export const ISelectionWatcherToken = new Token<ISelectionWatcher>(
   'jupyterlab-chat: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 const IInputToolbarRegistryFactory =
+  new Token<IInputToolbarRegistryFactory>(
+    'jupyterlab-chat:IInputToolbarRegistryFactory'
+  );

package/src/widget.tsx

@@ -8,6 +8,7 @@ import {
   IAttachmentOpenerRegistry,
   IChatCommandRegistry,
   IChatModel,
+  IInputToolbarRegistry,
   readIcon
 } from '@jupyter/chat';
 import { ICollaborativeDrive } from '@jupyter/collaborative-drive';
@@ -33,8 +34,11 @@ import { AccordionPanel, Panel } from '@lumino/widgets';
 import React, { useState } from 'react';
 
 import { LabChatModel } from './model';
-import { CommandIDs, chatFileType } from './token';
-import { IDocumentManager } from '@jupyterlab/docmanager';
+import {
+  CommandIDs,
+  IInputToolbarRegistryFactory,
+  chatFileType
+} from './token';
 
 const MAIN_PANEL_CLASS = 'jp-lab-chat-main-panel';
 const TITLE_UNREAD_CLASS = 'jp-lab-chat-title-unread';
@@ -104,9 +108,9 @@ export class ChatPanel extends SidePanel {
     this._rmRegistry = options.rmRegistry;
     this._themeManager = options.themeManager;
     this._defaultDirectory = options.defaultDirectory;
-    this._documentManager = options.documentManager;
     this._chatCommandRegistry = options.chatCommandRegistry;
     this._attachmentOpenerRegistry = options.attachmentOpenerRegistry;
+    this._inputToolbarFactory = options.inputToolbarFactory;
 
     const addChat = new CommandToolbarButton({
       commands: this._commands,
@@ -163,14 +167,20 @@ export class ChatPanel extends SidePanel {
       content.collapse(i);
     }
 
+    // Create the toolbar registry.
+    let inputToolbarRegistry: IInputToolbarRegistry | undefined;
+    if (this._inputToolbarFactory) {
+      inputToolbarRegistry = this._inputToolbarFactory.create();
+    }
+
     // Create a new widget.
     const widget = new ChatWidget({
       model: model,
       rmRegistry: this._rmRegistry,
       themeManager: this._themeManager,
-      documentManager: this._documentManager,
       chatCommandRegistry: this._chatCommandRegistry,
-      attachmentOpenerRegistry: this._attachmentOpenerRegistry
+      attachmentOpenerRegistry: this._attachmentOpenerRegistry,
+      inputToolbarRegistry
     });
 
     this.addWidget(
@@ -289,9 +299,9 @@ export class ChatPanel extends SidePanel {
   private _openChat: ReactWidget;
   private _rmRegistry: IRenderMimeRegistry;
   private _themeManager: IThemeManager | null;
-  private _documentManager?: IDocumentManager;
   private _chatCommandRegistry?: IChatCommandRegistry;
   private _attachmentOpenerRegistry?: IAttachmentOpenerRegistry;
+  private _inputToolbarFactory?: IInputToolbarRegistryFactory;
 }
 
 /**
@@ -307,9 +317,9 @@ export namespace ChatPanel {
     rmRegistry: IRenderMimeRegistry;
     themeManager: IThemeManager | null;
     defaultDirectory: string;
-    documentManager?: IDocumentManager;
     chatCommandRegistry?: IChatCommandRegistry;
     attachmentOpenerRegistry?: IAttachmentOpenerRegistry;
+    inputToolbarFactory?: IInputToolbarRegistryFactory;
   }
 }
 

package/style/base.css

@@ -20,13 +20,3 @@
 .jp-lab-chat-title-unread .lm-TabBar-tabLabel::before {
   content: '* ';
 }
-
-.jp-chat-command-name {
-  font-weight: normal;
-  margin: 5px;
-}
-
-.jp-chat-command-description {
-  color: gray;
-  margin: 5px;
-}