jupyterlab-chat 0.19.0-alpha.2 → 0.19.0

package/lib/model.d.ts

@@ -1,4 +1,4 @@
-import { AbstractChatModel, AbstractChatContext, IChatContext, IChatMessage, IChatModel, INewMessage, IUser } from '@jupyter/chat';
+import { AbstractChatModel, AbstractChatContext, IChatContext, IChatModel, IMessageContent, INewMessage, IUser } from '@jupyter/chat';
 import { IChangedArgs } from '@jupyterlab/coreutils';
 import { DocumentRegistry } from '@jupyterlab/docregistry';
 import { User } from '@jupyterlab/services';
@@ -65,13 +65,13 @@ export declare class LabChatModel extends AbstractChatModel implements DocumentR
     toJSON(): PartialJSONObject;
     fromJSON(data: PartialJSONObject): void;
     createChatContext(): IChatContext;
-    messagesInserted(index: number, messages: IChatMessage[]): Promise<void>;
+    messagesInserted(index: number, messages: IMessageContent[]): Promise<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;
+    updateMessage(id: string, updatedMessage: IMessageContent): Promise<boolean | void> | boolean | void;
     deleteMessage(id: string): Promise<boolean | void> | boolean | void;
     /**
      * Function called when the input content changed.

package/lib/model.js

@@ -104,8 +104,8 @@ export class LabChatModel extends AbstractChatModel {
             this.updateWriters(writers);
         };
         this._onchange = async (_, changes) => {
-            if (changes.messageChanges) {
-                const msgDelta = changes.messageChanges;
+            if (changes.messageListChanges) {
+                const msgDelta = changes.messageListChanges;
                 let index = 0;
                 for (const delta of msgDelta) {
                     if (delta.retain) {
@@ -113,7 +113,7 @@ export class LabChatModel extends AbstractChatModel {
                     }
                     else if (delta.insert) {
                         const messages = delta.insert.map(ymessage => {
-                            const { sender, attachments: attachmentIds, mentions: mentionsIds, ...baseMessage } = ymessage;
+                            const { sender, attachments: attachmentIds, mentions: mentionsIds, ...baseMessage } = ymessage.toJSON();
                             // Build the base message with sender.
                             const msg = {
                                 ...baseMessage,
@@ -152,6 +152,51 @@ export class LabChatModel extends AbstractChatModel {
                     }
                 }
             }
+            if (changes.messageChanges) {
+                // Update change in the message.
+                changes.messageChanges.forEach(change => {
+                    const message = this.messages[change.index];
+                    if (change.type === 'remove') {
+                        delete message[change.key];
+                    }
+                    else if (change.newValue !== undefined) {
+                        const key = change.key;
+                        const value = change.newValue;
+                        if (key === 'attachments') {
+                            const attachments = [];
+                            value.forEach(attachmentId => {
+                                const attachment = this.sharedModel.getAttachment(attachmentId);
+                                if (attachment) {
+                                    attachments.push(attachment);
+                                }
+                            });
+                            if (attachments.length) {
+                                message.update({ attachments });
+                            }
+                            else {
+                                message.update({ attachments: undefined });
+                            }
+                        }
+                        else if (key === 'mentions') {
+                            const mentions = value.map(user => this.sharedModel.getUser(user) || {
+                                username: 'User undefined',
+                                mention_name: 'User-undefined'
+                            });
+                            if (mentions === null || mentions === void 0 ? void 0 : mentions.length) {
+                                message.update({ mentions });
+                            }
+                        }
+                        else if (['body', 'time', 'raw_time', 'deleted', 'edited'].includes(key)) {
+                            const update = {};
+                            update[key] = value;
+                            message.update(update);
+                        }
+                        else {
+                            console.error(`The attribute '${key}' of message cannot be updated`);
+                        }
+                    }
+                });
+            }
             if (changes.metadataChanges) {
                 changes.metadataChanges.forEach(change => {
                     // no need to search for update or add, if the new value contains ID, let's

package/lib/ychat.d.ts

@@ -1,10 +1,11 @@
-import { IAttachment, IChatMessage, IUser } from '@jupyter/chat';
+import { IAttachment, IMessageContent, IUser } from '@jupyter/chat';
 import { Delta, DocumentChange, IMapChange, YDocument } from '@jupyter/ydoc';
 import { JSONObject, PartialJSONValue } from '@lumino/coreutils';
+import * as Y from 'yjs';
 /**
  * The type for a YMessage.
  */
-export type IYmessage = IChatMessage<string, string>;
+export type IYmessage = IMessageContent<string, string>;
 /**
  * The type for a YMessage.
  */
@@ -16,7 +17,11 @@ export interface IChatChanges extends DocumentChange {
     /**
      * Changes in messages.
      */
-    messageChanges?: MessageChange;
+    messageListChanges?: MessageListChange;
+    /**
+     * Changes of one message.
+     */
+    messageChanges?: MessageChange[];
     /**
      * Changes in users.
      */
@@ -30,10 +35,16 @@ export interface IChatChanges extends DocumentChange {
      */
     metadataChanges?: MetadataChange[];
 }
+/**
+ * The message list change type.
+ */
+export type MessageListChange = Delta<Y.Map<any>[]>;
 /**
  * The message change type.
  */
-export type MessageChange = Delta<IYmessage[]>;
+export type MessageChange = IMapChange<any> & {
+    index: number;
+};
 /**
  * The user change type.
  */
@@ -73,8 +84,8 @@ export declare class YChat extends YDocument<IChatChanges> {
     getUser(username: string | undefined): IUser | undefined;
     setUser(user: IUser): void;
     getMessage(index: number): IYmessage | undefined;
-    addMessage(value: IYmessage): void;
-    updateMessage(index: number, value: IYmessage): void;
+    addMessage(msg: IYmessage): void;
+    updateMessage(index: number, msg: IYmessage): void;
     getMessageIndex(id: string): number;
     deleteMessage(index: number): void;
     getAttachment(id: string): IAttachment | undefined;

package/lib/ychat.js

@@ -4,6 +4,7 @@
  */
 import { YDocument } from '@jupyter/ydoc';
 import { JSONExt, UUID } from '@lumino/coreutils';
+import * as Y from 'yjs';
 /**
  * The jupyterlab chat shared document.
  */
@@ -50,10 +51,55 @@ export class YChat extends YDocument {
             });
             this._changed.emit({ userChanges });
         };
-        this._messagesObserver = (event) => {
-            const messageChanges = event.delta;
-            this._changed.emit({
-                messageChanges: messageChanges
+        this._messagesObserver = (events) => {
+            events.forEach(event => {
+                if (event instanceof Y.YArrayEvent) {
+                    // Change on the message list.
+                    const messageListChanges = event.delta;
+                    this._changed.emit({
+                        messageListChanges
+                    });
+                }
+                else if (event instanceof Y.YMapEvent) {
+                    // Change on existing message(s), let's update the whole message.
+                    const messageChanges = new Array();
+                    event.keysChanged.forEach(key => {
+                        const change = event.changes.keys.get(key);
+                        if (change) {
+                            const index = this.getMessageIndex(event.target.get('id'));
+                            switch (change.action) {
+                                case 'add':
+                                    messageChanges.push({
+                                        index,
+                                        key,
+                                        newValue: event.target.get(key),
+                                        type: 'add'
+                                    });
+                                    break;
+                                case 'delete':
+                                    messageChanges.push({
+                                        index,
+                                        key,
+                                        oldValue: change.oldValue,
+                                        type: 'remove'
+                                    });
+                                    break;
+                                case 'update':
+                                    messageChanges.push({
+                                        index,
+                                        key: key,
+                                        oldValue: change.oldValue,
+                                        newValue: event.target.get(key),
+                                        type: 'change'
+                                    });
+                                    break;
+                            }
+                        }
+                    });
+                    this._changed.emit({
+                        messageChanges
+                    });
+                }
             });
         };
         this._attachmentsObserver = (event) => {
@@ -122,7 +168,7 @@ export class YChat extends YDocument {
         this._users = this.ydoc.getMap('users');
         this._users.observe(this._usersObserver);
         this._messages = this.ydoc.getArray('messages');
-        this._messages.observe(this._messagesObserver);
+        this._messages.observeDeep(this._messagesObserver);
         this._attachments = this.ydoc.getMap('attachments');
         this._attachments.observe(this._attachmentsObserver);
         this._metadata = this.ydoc.getMap('metadata');
@@ -162,9 +208,15 @@ export class YChat extends YDocument {
         this.transact(() => {
             var _a, _b, _c;
             const messages = (_a = value['messages']) !== null && _a !== void 0 ? _a : [];
+            const ymessages = [];
             messages.forEach(message => {
-                this._messages.push([message]);
+                const ymessage = new Y.Map();
+                for (const [key, value] of Object.entries(message)) {
+                    ymessage.set(key, value);
+                }
+                ymessages.push(ymessage);
             });
+            this._messages.push(ymessages);
             const users = (_b = value['users']) !== null && _b !== void 0 ? _b : {};
             Object.entries(users).forEach(([key, val]) => this._users.set(key, val));
             const metadata = (_c = value['metadata']) !== null && _c !== void 0 ? _c : {};
@@ -187,21 +239,29 @@ export class YChat extends YDocument {
         });
     }
     getMessage(index) {
-        return this._messages.get(index);
+        return this._messages.get(index).toJSON();
     }
-    addMessage(value) {
+    addMessage(msg) {
         this.transact(() => {
-            this._messages.push([value]);
+            const ymessage = new Y.Map();
+            for (const [key, value] of Object.entries(msg)) {
+                ymessage.set(key, value);
+            }
+            this._messages.push([ymessage]);
         });
     }
-    updateMessage(index, value) {
+    updateMessage(index, msg) {
         this.transact(() => {
-            this._messages.delete(index);
-            this._messages.insert(index, [value]);
+            const original = this._messages.get(index);
+            for (const [key, value] of Object.entries(msg)) {
+                if (original.get(key) !== value) {
+                    original.set(key, value);
+                }
+            }
         });
     }
     getMessageIndex(id) {
-        return this._messages.toArray().findIndex(msg => msg.id === id);
+        return this._messages.toArray().findIndex(msg => msg.get('id') === id);
     }
     deleteMessage(index) {
         this.transact(() => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jupyterlab-chat",
-  "version": "0.19.0-alpha.2",
+  "version": "0.19.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.19.0-alpha.2",
+    "@jupyter/chat": "^0.19.0",
     "@jupyter/collaborative-drive": "^4.0.2",
     "@jupyter/ydoc": "^2.0.0 || ^3.0.0",
     "@jupyterlab/application": "^4.2.0",

package/src/model.ts

@@ -8,9 +8,9 @@ import {
   AbstractChatContext,
   IAttachment,
   IChatContext,
-  IChatMessage,
   IChatModel,
   IInputModel,
+  IMessageContent,
   INewMessage,
   IUser
 } from '@jupyter/chat';
@@ -189,7 +189,7 @@ export class LabChatModel
 
   async messagesInserted(
     index: number,
-    messages: IChatMessage[]
+    messages: IMessageContent[]
   ): 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).
@@ -246,7 +246,7 @@ export class LabChatModel
 
   updateMessage(
     id: string,
-    updatedMessage: IChatMessage
+    updatedMessage: IMessageContent
   ): Promise<boolean | void> | boolean | void {
     const index = this.sharedModel.getMessageIndex(id);
     let message = this.sharedModel.getMessage(index);
@@ -398,8 +398,8 @@ export class LabChatModel
   }
 
   private _onchange = async (_: YChat, changes: IChatChanges) => {
-    if (changes.messageChanges) {
-      const msgDelta = changes.messageChanges;
+    if (changes.messageListChanges) {
+      const msgDelta = changes.messageListChanges;
       let index = 0;
       for (const delta of msgDelta) {
         if (delta.retain) {
@@ -411,10 +411,10 @@ export class LabChatModel
               attachments: attachmentIds,
               mentions: mentionsIds,
               ...baseMessage
-            } = ymessage;
+            } = ymessage.toJSON() as IYmessage;
 
             // Build the base message with sender.
-            const msg: IChatMessage = {
+            const msg: IMessageContent = {
               ...baseMessage,
               sender: this.sharedModel.getUser(sender) || {
                 username: 'User undefined',
@@ -457,6 +457,54 @@ export class LabChatModel
       }
     }
 
+    if (changes.messageChanges) {
+      // Update change in the message.
+      changes.messageChanges.forEach(change => {
+        const message = this.messages[change.index];
+        if (change.type === 'remove') {
+          delete message[change.key as keyof IMessageContent];
+        } else if (change.newValue !== undefined) {
+          const key = change.key;
+          const value = change.newValue;
+          if (key === 'attachments') {
+            const attachments: IAttachment[] = [];
+            (value as string[]).forEach(attachmentId => {
+              const attachment = this.sharedModel.getAttachment(attachmentId);
+              if (attachment) {
+                attachments.push(attachment);
+              }
+            });
+            if (attachments.length) {
+              message.update({ attachments });
+            } else {
+              message.update({ attachments: undefined });
+            }
+          } else if (key === 'mentions') {
+            const mentions: IUser[] = (value as string[]).map(
+              user =>
+                this.sharedModel.getUser(user) || {
+                  username: 'User undefined',
+                  mention_name: 'User-undefined'
+                }
+            );
+            if (mentions?.length) {
+              message.update({ mentions });
+            }
+          } else if (
+            ['body', 'time', 'raw_time', 'deleted', 'edited'].includes(key)
+          ) {
+            const update: Partial<IMessageContent> = {};
+            update[key as keyof IMessageContent] = value;
+            message.update(update);
+          } else {
+            console.error(
+              `The attribute '${key}' of message cannot be updated`
+            );
+          }
+        }
+      });
+    }
+
     if (changes.metadataChanges) {
       changes.metadataChanges.forEach(change => {
         // no need to search for update or add, if the new value contains ID, let's

package/src/ychat.ts

@@ -3,7 +3,7 @@
  * Distributed under the terms of the Modified BSD License.
  */
 
-import { IAttachment, IChatMessage, IUser } from '@jupyter/chat';
+import { IAttachment, IMessageContent, IUser } from '@jupyter/chat';
 import { Delta, DocumentChange, IMapChange, YDocument } from '@jupyter/ydoc';
 import { JSONExt, JSONObject, PartialJSONValue, UUID } from '@lumino/coreutils';
 import * as Y from 'yjs';
@@ -11,7 +11,7 @@ import * as Y from 'yjs';
 /**
  * The type for a YMessage.
  */
-export type IYmessage = IChatMessage<string, string>;
+export type IYmessage = IMessageContent<string, string>;
 
 /**
  * The type for a YMessage.
@@ -25,7 +25,11 @@ export interface IChatChanges extends DocumentChange {
   /**
    * Changes in messages.
    */
-  messageChanges?: MessageChange;
+  messageListChanges?: MessageListChange;
+  /**
+   * Changes of one message.
+   */
+  messageChanges?: MessageChange[];
   /**
    * Changes in users.
    */
@@ -40,10 +44,15 @@ export interface IChatChanges extends DocumentChange {
   metadataChanges?: MetadataChange[];
 }
 
+/**
+ * The message list change type.
+ */
+export type MessageListChange = Delta<Y.Map<any>[]>;
+
 /**
  * The message change type.
  */
-export type MessageChange = Delta<IYmessage[]>;
+export type MessageChange = IMapChange<any> & { index: number };
 
 /**
  * The user change type.
@@ -72,8 +81,8 @@ export class YChat extends YDocument<IChatChanges> {
     this._users = this.ydoc.getMap<IUser>('users');
     this._users.observe(this._usersObserver);
 
-    this._messages = this.ydoc.getArray<IYmessage>('messages');
-    this._messages.observe(this._messagesObserver);
+    this._messages = this.ydoc.getArray<Y.Map<any>>('messages');
+    this._messages.observeDeep(this._messagesObserver);
 
     this._attachments = this.ydoc.getMap<IAttachment>('attachments');
     this._attachments.observe(this._attachmentsObserver);
@@ -132,9 +141,15 @@ export class YChat extends YDocument<IChatChanges> {
 
     this.transact(() => {
       const messages = (value['messages'] as unknown as Array<IYmessage>) ?? [];
+      const ymessages: Y.Map<any>[] = [];
       messages.forEach(message => {
-        this._messages.push([message]);
+        const ymessage = new Y.Map<any>();
+        for (const [key, value] of Object.entries(message)) {
+          ymessage.set(key, value);
+        }
+        ymessages.push(ymessage);
       });
+      this._messages.push(ymessages);
 
       const users = value['users'] ?? {};
       Object.entries(users).forEach(([key, val]) =>
@@ -167,24 +182,32 @@ export class YChat extends YDocument<IChatChanges> {
   }
 
   getMessage(index: number): IYmessage | undefined {
-    return this._messages.get(index);
+    return this._messages.get(index).toJSON() as IYmessage;
   }
 
-  addMessage(value: IYmessage): void {
+  addMessage(msg: IYmessage): void {
     this.transact(() => {
-      this._messages.push([value]);
+      const ymessage = new Y.Map<any>();
+      for (const [key, value] of Object.entries(msg)) {
+        ymessage.set(key, value);
+      }
+      this._messages.push([ymessage]);
     });
   }
 
-  updateMessage(index: number, value: IYmessage): void {
+  updateMessage(index: number, msg: IYmessage): void {
     this.transact(() => {
-      this._messages.delete(index);
-      this._messages.insert(index, [value]);
+      const original = this._messages.get(index);
+      for (const [key, value] of Object.entries(msg)) {
+        if (original.get(key) !== value) {
+          original.set(key, value);
+        }
+      }
     });
   }
 
   getMessageIndex(id: string): number {
-    return this._messages.toArray().findIndex(msg => msg.id === id);
+    return this._messages.toArray().findIndex(msg => msg.get('id') === id);
   }
 
   deleteMessage(index: number): void {
@@ -258,14 +281,60 @@ export class YChat extends YDocument<IChatChanges> {
       }
     });
 
-    this._changed.emit({ userChanges } as Partial<IChatChanges>);
+    this._changed.emit({ userChanges });
   };
 
-  private _messagesObserver = (event: Y.YArrayEvent<IYmessage>): void => {
-    const messageChanges = event.delta;
-    this._changed.emit({
-      messageChanges: messageChanges
-    } as Partial<IChatChanges>);
+  private _messagesObserver = (
+    events: (Y.YArrayEvent<Y.Map<any>> | Y.YMapEvent<any>)[]
+  ): void => {
+    events.forEach(event => {
+      if (event instanceof Y.YArrayEvent) {
+        // Change on the message list.
+        const messageListChanges = event.delta;
+        this._changed.emit({
+          messageListChanges
+        } as Partial<IChatChanges>);
+      } else if (event instanceof Y.YMapEvent) {
+        // Change on existing message(s), let's update the whole message.
+        const messageChanges = new Array<MessageChange>();
+        event.keysChanged.forEach(key => {
+          const change = event.changes.keys.get(key);
+          if (change) {
+            const index = this.getMessageIndex(event.target.get('id'));
+            switch (change.action) {
+              case 'add':
+                messageChanges.push({
+                  index,
+                  key,
+                  newValue: event.target.get(key),
+                  type: 'add'
+                });
+                break;
+              case 'delete':
+                messageChanges.push({
+                  index,
+                  key,
+                  oldValue: change.oldValue,
+                  type: 'remove'
+                });
+                break;
+              case 'update':
+                messageChanges.push({
+                  index,
+                  key: key,
+                  oldValue: change.oldValue,
+                  newValue: event.target.get(key),
+                  type: 'change'
+                });
+                break;
+            }
+          }
+        });
+        this._changed.emit({
+          messageChanges
+        });
+      }
+    });
   };
 
   private _attachmentsObserver = (event: Y.YMapEvent<IAttachment>): void => {
@@ -300,7 +369,7 @@ export class YChat extends YDocument<IChatChanges> {
       }
     });
 
-    this._changed.emit({ attachmentChanges } as Partial<IChatChanges>);
+    this._changed.emit({ attachmentChanges });
   };
 
   private _metadataObserver = (event: Y.YMapEvent<IMetadata>): void => {
@@ -332,11 +401,11 @@ export class YChat extends YDocument<IChatChanges> {
       }
     });
 
-    this._changed.emit({ metadataChanges } as Partial<IChatChanges>);
+    this._changed.emit({ metadataChanges });
   };
 
   private _users: Y.Map<IUser>;
-  private _messages: Y.Array<IYmessage>;
+  private _messages: Y.Array<Y.Map<any>>;
   private _attachments: Y.Map<IAttachment>;
   private _metadata: Y.Map<IMetadata>;
 }