jupyterlab-chat 0.9.0 → 0.10.0

package/lib/factory.d.ts

@@ -52,7 +52,7 @@ export declare class ChatWidgetFactory extends ABCWidgetFactory<LabChatPanel, La
     private _rmRegistry;
     private _chatCommandRegistry?;
     private _attachmentOpenerRegistry?;
-    private _inputToolbarRegistry?;
+    private _inputToolbarFactory?;
 }
 export declare namespace ChatWidgetFactory {
     interface IContext extends DocumentRegistry.IContext<LabChatModel> {

package/lib/factory.js

@@ -52,9 +52,7 @@ export class ChatWidgetFactory extends ABCWidgetFactory {
         this._rmRegistry = options.rmRegistry;
         this._chatCommandRegistry = options.chatCommandRegistry;
         this._attachmentOpenerRegistry = options.attachmentOpenerRegistry;
-        if (options.inputToolbarFactory) {
-            this._inputToolbarRegistry = options.inputToolbarFactory.create();
-        }
+        this._inputToolbarFactory = options.inputToolbarFactory;
     }
     /**
      * Create a new widget given a context.
@@ -67,7 +65,9 @@ export class ChatWidgetFactory extends ABCWidgetFactory {
         context.themeManager = this._themeManager;
         context.chatCommandRegistry = this._chatCommandRegistry;
         context.attachmentOpenerRegistry = this._attachmentOpenerRegistry;
-        context.inputToolbarRegistry = this._inputToolbarRegistry;
+        if (this._inputToolbarFactory) {
+            context.inputToolbarRegistry = this._inputToolbarFactory.create();
+        }
         return new LabChatPanel({
             context,
             content: new ChatWidget(context)

package/lib/model.d.ts

@@ -1,4 +1,4 @@
-import { ChatModel, IChatMessage, IInputModel, INewMessage, IUser } from '@jupyter/chat';
+import { AbstractChatModel, AbstractChatContext, IChatContext, IChatMessage, IChatModel, IInputModel, INewMessage, IUser } from '@jupyter/chat';
 import { IChangedArgs } from '@jupyterlab/coreutils';
 import { DocumentRegistry } from '@jupyterlab/docregistry';
 import { User } from '@jupyterlab/services';
@@ -10,7 +10,7 @@ import { YChat } from './ychat';
  * Chat model namespace.
  */
 export declare namespace LabChatModel {
-    interface IOptions extends ChatModel.IOptions {
+    interface IOptions extends IChatModel.IOptions {
         widgetConfig: IWidgetConfig;
         user: User.IIdentity | null;
         sharedModel?: YChat;
@@ -20,7 +20,7 @@ export declare namespace LabChatModel {
 /**
  * The chat model.
  */
-export declare class LabChatModel extends ChatModel implements DocumentRegistry.IModel {
+export declare class LabChatModel extends AbstractChatModel implements DocumentRegistry.IModel {
     constructor(options: LabChatModel.IOptions);
     readonly collaborative = true;
     get user(): IUser;
@@ -38,7 +38,8 @@ export declare class LabChatModel extends ChatModel implements DocumentRegistry.
     fromString(data: string): void;
     toJSON(): PartialJSONObject;
     fromJSON(data: PartialJSONObject): void;
-    messagesInserted(index: number, messages: IChatMessage[]): void;
+    createChatContext(): IChatContext;
+    messagesInserted(index: number, messages: IChatMessage[]): Promise<void>;
     sendMessage(message: INewMessage): Promise<boolean | void> | boolean | void;
     /**
      * Override the clear messages method.
@@ -55,6 +56,7 @@ export declare class LabChatModel extends ChatModel implements DocumentRegistry.
      * Used to populate the writers list.
      */
     onAwarenessChange: () => void;
+    private _buildMentionList;
     private _resetWritingStatus;
     private _onchange;
     readonly defaultKernelName: string;
@@ -69,3 +71,12 @@ export declare class LabChatModel extends ChatModel implements DocumentRegistry.
     private _timeoutWriting;
     private _user;
 }
+/**
+ * The chat context to be sent to the input model.
+ */
+export declare class LabChatContext extends AbstractChatContext {
+    /**
+     * The list of users who have connected to this chat.
+     */
+    get users(): IUser[];
+}

package/lib/model.js

@@ -2,7 +2,7 @@
  * Copyright (c) Jupyter Development Team.
  * Distributed under the terms of the Modified BSD License.
  */
-import { ChatModel } from '@jupyter/chat';
+import { AbstractChatModel, AbstractChatContext } from '@jupyter/chat';
 import { PromiseDelegate, UUID } from '@lumino/coreutils';
 import { Signal } from '@lumino/signaling';
 import { YChat } from './ychat';
@@ -10,7 +10,7 @@ const WRITING_DELAY = 1000;
 /**
  * The chat model.
  */
-export class LabChatModel extends ChatModel {
+export class LabChatModel extends AbstractChatModel {
     constructor(options) {
         super(options);
         this.collaborative = true;
@@ -48,17 +48,17 @@ export class LabChatModel extends ChatModel {
             }
             this.updateWriters(writers);
         };
-        this._onchange = (_, changes) => {
+        this._onchange = async (_, changes) => {
             if (changes.messageChanges) {
                 const msgDelta = changes.messageChanges;
                 let index = 0;
-                msgDelta.forEach(delta => {
+                for (const delta of msgDelta) {
                     if (delta.retain) {
                         index += delta.retain;
                     }
                     else if (delta.insert) {
                         const messages = delta.insert.map(ymessage => {
-                            const { sender, attachments: attachmentIds, ...baseMessage } = ymessage;
+                            const { sender, attachments: attachmentIds, mentions: mentionsIds, ...baseMessage } = ymessage;
                             // Build the base message with sender.
                             const msg = {
                                 ...baseMessage,
@@ -79,15 +79,21 @@ export class LabChatModel extends ChatModel {
                                     msg.attachments = attachments;
                                 }
                             }
+                            const mentions = mentionsIds === null || mentionsIds === void 0 ? void 0 : mentionsIds.map(user => this.sharedModel.getUser(user) || {
+                                username: 'User undefined'
+                            });
+                            if (mentions === null || mentions === void 0 ? void 0 : mentions.length) {
+                                msg.mentions = mentions;
+                            }
                             return msg;
                         });
-                        this.messagesInserted(index, messages);
+                        await this.messagesInserted(index, messages);
                         index += messages.length;
                     }
                     else if (delta.delete) {
                         this.messagesDeleted(index, delta.delete);
                     }
-                });
+                }
             }
             if (changes.metadataChanges) {
                 changes.metadataChanges.forEach(change => {
@@ -98,6 +104,14 @@ export class LabChatModel extends ChatModel {
                     }
                 });
             }
+            if (changes.userChanges) {
+                // Update the current user if it changes (if it has been mentioned for example).
+                changes.userChanges.forEach(change => {
+                    if (change.key === this._user.username && change.newValue) {
+                        this._user = change.newValue;
+                    }
+                });
+            }
         };
         this.defaultKernelName = '';
         this.defaultKernelLanguage = '';
@@ -178,14 +192,18 @@ export class LabChatModel extends ChatModel {
     fromJSON(data) {
         // nothing to do
     }
-    messagesInserted(index, messages) {
+    createChatContext() {
+        return new LabChatContext({ model: this });
+    }
+    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).
-        this._ready.promise.then(() => {
+        return this._ready.promise.then(() => {
             super.messagesInserted(index, messages);
         });
     }
     sendMessage(message) {
+        var _a;
         this._resetWritingStatus();
         if (this._timeoutWriting !== null) {
             window.clearTimeout(this._timeoutWriting);
@@ -203,11 +221,17 @@ export class LabChatModel extends ChatModel {
             this.sharedModel.setUser(this._user);
         }
         // Add the attachments to the message.
-        if (this.input.attachments.length) {
-            const attachmentIds = this.input.attachments.map(attachment => this.sharedModel.setAttachment(attachment));
+        const attachmentIds = (_a = this.input.attachments) === null || _a === void 0 ? void 0 : _a.map(attachment => this.sharedModel.setAttachment(attachment));
+        if (attachmentIds === null || attachmentIds === void 0 ? void 0 : attachmentIds.length) {
             msg.attachments = attachmentIds;
-            this.input.clearAttachments();
         }
+        this.input.clearAttachments();
+        // Add the mentioned users.
+        const mentions = this._buildMentionList(this.input.mentions, message.body);
+        if (mentions.length) {
+            msg.mentions = mentions;
+        }
+        this.input.clearMentions();
         this.sharedModel.addMessage(msg);
     }
     /**
@@ -235,10 +259,22 @@ export class LabChatModel extends ChatModel {
                 edited: true
             };
         }
+        // Update the attachments.
         const attachmentIds = (_a = updatedMessage.attachments) === null || _a === void 0 ? void 0 : _a.map(attachment => this.sharedModel.setAttachment(attachment));
-        if (attachmentIds) {
+        if (attachmentIds === null || attachmentIds === void 0 ? void 0 : attachmentIds.length) {
             message.attachments = attachmentIds;
         }
+        else {
+            delete message.attachments;
+        }
+        // Update the mentioned users.
+        const mentions = this._buildMentionList(updatedMessage.mentions, updatedMessage.body);
+        if (mentions.length) {
+            message.mentions = mentions;
+        }
+        else {
+            delete message.mentions;
+        }
         this.sharedModel.updateMessage(index, message);
     }
     deleteMessage(id) {
@@ -252,6 +288,28 @@ export class LabChatModel extends ChatModel {
         message.deleted = true;
         this.sharedModel.updateMessage(index, message);
     }
+    _buildMentionList(userMentions, body) {
+        if (!userMentions) {
+            return [];
+        }
+        const mentions = [];
+        userMentions.forEach(user => {
+            // Make sure the user is still mentioned.
+            if (!user.mention_name) {
+                return;
+            }
+            const regex = new RegExp(user.mention_name);
+            if (!regex.exec(body)) {
+                return;
+            }
+            // Save the mention name if necessary.
+            if (!(this.sharedModel.getUser(user.username) === user)) {
+                this.sharedModel.setUser(user);
+            }
+            mentions.push(user.username);
+        });
+        return mentions;
+    }
     _resetWritingStatus() {
         const awareness = this.sharedModel.awareness;
         const states = awareness.getLocalState();
@@ -260,3 +318,28 @@ export class LabChatModel extends ChatModel {
         this._timeoutWriting = null;
     }
 }
+/**
+ * The chat context to be sent to the input model.
+ */
+export class LabChatContext extends AbstractChatContext {
+    /**
+     * The list of users who have connected to this chat.
+     */
+    get users() {
+        const model = this._model;
+        const users = new Set();
+        // Get the user list from the shared YChat
+        Object.values(model.sharedModel.users).forEach(userObject => {
+            users.add(userObject);
+        });
+        // Add the users connected to the chat (even if they never sent a message).
+        model.sharedModel.awareness.getStates().forEach(value => {
+            const user = value.user;
+            if (!user) {
+                return;
+            }
+            users.add(user);
+        });
+        return Array.from(users);
+    }
+}

package/lib/ychat.d.ts

@@ -65,7 +65,7 @@ export declare class YChat extends YDocument<IChatChanges> {
      */
     static create(options?: YDocument.IOptions): YChat;
     get id(): string;
-    get users(): JSONObject;
+    get users(): Record<string, IUser>;
     get messages(): string[];
     get attachments(): JSONObject;
     getSource(): JSONObject;

package/lib/ychat.js

@@ -140,7 +140,8 @@ export class YChat extends YDocument {
         return this._metadata.get('id') || '';
     }
     get users() {
-        return JSONExt.deepCopy(this._users.toJSON());
+        const userDict = JSONExt.deepCopy(this._users.toJSON());
+        return userDict;
     }
     get messages() {
         return JSONExt.deepCopy(this._messages.toJSON());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jupyterlab-chat",
-  "version": "0.9.0",
+  "version": "0.10.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.9.0",
+    "@jupyter/chat": "^0.10.0",
     "@jupyter/collaborative-drive": "^3.0.0",
     "@jupyter/ydoc": "^2.0.0 || ^3.0.0",
     "@jupyterlab/application": "^4.2.0",

package/src/factory.ts

@@ -83,9 +83,7 @@ export class ChatWidgetFactory extends ABCWidgetFactory<
     this._rmRegistry = options.rmRegistry;
     this._chatCommandRegistry = options.chatCommandRegistry;
     this._attachmentOpenerRegistry = options.attachmentOpenerRegistry;
-    if (options.inputToolbarFactory) {
-      this._inputToolbarRegistry = options.inputToolbarFactory.create();
-    }
+    this._inputToolbarFactory = options.inputToolbarFactory;
   }
 
   /**
@@ -99,7 +97,9 @@ export class ChatWidgetFactory extends ABCWidgetFactory<
     context.themeManager = this._themeManager;
     context.chatCommandRegistry = this._chatCommandRegistry;
     context.attachmentOpenerRegistry = this._attachmentOpenerRegistry;
-    context.inputToolbarRegistry = this._inputToolbarRegistry;
+    if (this._inputToolbarFactory) {
+      context.inputToolbarRegistry = this._inputToolbarFactory.create();
+    }
     return new LabChatPanel({
       context,
       content: new ChatWidget(context)
@@ -110,7 +110,7 @@ export class ChatWidgetFactory extends ABCWidgetFactory<
   private _rmRegistry: IRenderMimeRegistry;
   private _chatCommandRegistry?: IChatCommandRegistry;
   private _attachmentOpenerRegistry?: IAttachmentOpenerRegistry;
-  private _inputToolbarRegistry?: IInputToolbarRegistry;
+  private _inputToolbarFactory?: IInputToolbarRegistryFactory;
 }
 
 export namespace ChatWidgetFactory {

package/src/model.ts

@@ -4,9 +4,12 @@
  */
 
 import {
-  ChatModel,
+  AbstractChatModel,
+  AbstractChatContext,
   IAttachment,
+  IChatContext,
   IChatMessage,
+  IChatModel,
   IInputModel,
   INewMessage,
   IUser
@@ -26,7 +29,7 @@ const WRITING_DELAY = 1000;
  * Chat model namespace.
  */
 export namespace LabChatModel {
-  export interface IOptions extends ChatModel.IOptions {
+  export interface IOptions extends IChatModel.IOptions {
     widgetConfig: IWidgetConfig;
     user: User.IIdentity | null;
     sharedModel?: YChat;
@@ -37,7 +40,10 @@ export namespace LabChatModel {
 /**
  * The chat model.
  */
-export class LabChatModel extends ChatModel implements DocumentRegistry.IModel {
+export class LabChatModel
+  extends AbstractChatModel
+  implements DocumentRegistry.IModel
+{
   constructor(options: LabChatModel.IOptions) {
     super(options);
 
@@ -133,10 +139,17 @@ export class LabChatModel extends ChatModel implements DocumentRegistry.IModel {
     // nothing to do
   }
 
-  messagesInserted(index: number, messages: IChatMessage[]): void {
+  createChatContext(): IChatContext {
+    return new LabChatContext({ model: this });
+  }
+
+  async messagesInserted(
+    index: number,
+    messages: IChatMessage[]
+  ): Promise<void> {
     // 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).
-    this._ready.promise.then(() => {
+    return this._ready.promise.then(() => {
       super.messagesInserted(index, messages);
     });
   }
@@ -162,13 +175,20 @@ export class LabChatModel extends ChatModel implements DocumentRegistry.IModel {
     }
 
     // Add the attachments to the message.
-    if (this.input.attachments.length) {
-      const attachmentIds = this.input.attachments.map(attachment =>
-        this.sharedModel.setAttachment(attachment)
-      );
+    const attachmentIds = this.input.attachments?.map(attachment =>
+      this.sharedModel.setAttachment(attachment)
+    );
+    if (attachmentIds?.length) {
       msg.attachments = attachmentIds;
-      this.input.clearAttachments();
     }
+    this.input.clearAttachments();
+
+    // Add the mentioned users.
+    const mentions = this._buildMentionList(this.input.mentions, message.body);
+    if (mentions.length) {
+      msg.mentions = mentions;
+    }
+    this.input.clearMentions();
 
     this.sharedModel.addMessage(msg);
   }
@@ -201,12 +221,28 @@ export class LabChatModel extends ChatModel implements DocumentRegistry.IModel {
         edited: true
       };
     }
+
+    // Update the attachments.
     const attachmentIds = updatedMessage.attachments?.map(attachment =>
       this.sharedModel.setAttachment(attachment)
     );
-    if (attachmentIds) {
+    if (attachmentIds?.length) {
       message.attachments = attachmentIds;
+    } else {
+      delete message.attachments;
+    }
+
+    // Update the mentioned users.
+    const mentions = this._buildMentionList(
+      updatedMessage.mentions,
+      updatedMessage.body
+    );
+    if (mentions.length) {
+      message.mentions = mentions;
+    } else {
+      delete message.mentions;
     }
+
     this.sharedModel.updateMessage(index, message as IYmessage);
   }
 
@@ -258,6 +294,33 @@ export class LabChatModel extends ChatModel implements DocumentRegistry.IModel {
     this.updateWriters(writers);
   };
 
+  private _buildMentionList(
+    userMentions: IUser[] | undefined,
+    body: string
+  ): string[] {
+    if (!userMentions) {
+      return [];
+    }
+    const mentions: string[] = [];
+    userMentions.forEach(user => {
+      // Make sure the user is still mentioned.
+      if (!user.mention_name) {
+        return;
+      }
+      const regex = new RegExp(user.mention_name);
+      if (!regex.exec(body)) {
+        return;
+      }
+
+      // Save the mention name if necessary.
+      if (!(this.sharedModel.getUser(user.username) === user)) {
+        this.sharedModel.setUser(user);
+      }
+      mentions.push(user.username);
+    });
+    return mentions;
+  }
+
   private _resetWritingStatus() {
     const awareness = this.sharedModel.awareness;
     const states = awareness.getLocalState();
@@ -266,11 +329,11 @@ export class LabChatModel extends ChatModel implements DocumentRegistry.IModel {
     this._timeoutWriting = null;
   }
 
-  private _onchange = (_: YChat, changes: IChatChanges) => {
+  private _onchange = async (_: YChat, changes: IChatChanges) => {
     if (changes.messageChanges) {
       const msgDelta = changes.messageChanges;
       let index = 0;
-      msgDelta.forEach(delta => {
+      for (const delta of msgDelta) {
         if (delta.retain) {
           index += delta.retain;
         } else if (delta.insert) {
@@ -278,6 +341,7 @@ export class LabChatModel extends ChatModel implements DocumentRegistry.IModel {
             const {
               sender,
               attachments: attachmentIds,
+              mentions: mentionsIds,
               ...baseMessage
             } = ymessage;
 
@@ -303,14 +367,24 @@ export class LabChatModel extends ChatModel implements DocumentRegistry.IModel {
               }
             }
 
+            const mentions = mentionsIds?.map(
+              user =>
+                this.sharedModel.getUser(user) || {
+                  username: 'User undefined'
+                }
+            );
+
+            if (mentions?.length) {
+              msg.mentions = mentions;
+            }
             return msg;
           });
-          this.messagesInserted(index, messages);
+          await this.messagesInserted(index, messages);
           index += messages.length;
         } else if (delta.delete) {
           this.messagesDeleted(index, delta.delete);
         }
-      });
+      }
     }
 
     if (changes.metadataChanges) {
@@ -322,6 +396,15 @@ export class LabChatModel extends ChatModel implements DocumentRegistry.IModel {
         }
       });
     }
+
+    if (changes.userChanges) {
+      // Update the current user if it changes (if it has been mentioned for example).
+      changes.userChanges.forEach(change => {
+        if (change.key === this._user.username && change.newValue) {
+          this._user = change.newValue;
+        }
+      });
+    }
   };
 
   readonly defaultKernelName: string = '';
@@ -339,3 +422,32 @@ export class LabChatModel extends ChatModel implements DocumentRegistry.IModel {
 
   private _user: IUser;
 }
+
+/**
+ * The chat context to be sent to the input model.
+ */
+export class LabChatContext extends AbstractChatContext {
+  /**
+   * The list of users who have connected to this chat.
+   */
+  get users(): IUser[] {
+    const model = this._model as LabChatModel;
+    const users = new Set<IUser>();
+
+    // Get the user list from the shared YChat
+    Object.values(model.sharedModel.users).forEach(userObject => {
+      users.add(userObject);
+    });
+
+    // Add the users connected to the chat (even if they never sent a message).
+    model.sharedModel.awareness.getStates().forEach(value => {
+      const user = value.user as IUser;
+      if (!user) {
+        return;
+      }
+      users.add(user);
+    });
+
+    return Array.from(users);
+  }
+}

package/src/ychat.ts

@@ -100,8 +100,13 @@ export class YChat extends YDocument<IChatChanges> {
     return (this._metadata.get('id') as string) || '';
   }
 
-  get users(): JSONObject {
-    return JSONExt.deepCopy(this._users.toJSON());
+  get users(): Record<string, IUser> {
+    const userDict = JSONExt.deepCopy(this._users.toJSON()) as Record<
+      string,
+      IUser
+    >;
+
+    return userDict;
   }
 
   get messages(): string[] {