jupyterlab-chat 0.6.2 → 0.7.0

package/lib/model.d.ts

@@ -32,11 +32,13 @@ export declare class LabChatModel extends ChatModel implements DocumentRegistry.
     get readOnly(): boolean;
     set readOnly(value: boolean);
     get disposed(): ISignal<LabChatModel, void>;
+    set id(value: string | undefined);
     dispose(): void;
     toString(): string;
     fromString(data: string): void;
     toJSON(): PartialJSONObject;
     fromJSON(data: PartialJSONObject): void;
+    messagesInserted(index: number, messages: IChatMessage[]): void;
     sendMessage(message: INewMessage): Promise<boolean | void> | boolean | void;
     updateMessage(id: string, updatedMessage: IChatMessage): Promise<boolean | void> | boolean | void;
     deleteMessage(id: string): Promise<boolean | void> | boolean | void;
@@ -53,6 +55,7 @@ export declare class LabChatModel extends ChatModel implements DocumentRegistry.
     private _onchange;
     readonly defaultKernelName: string;
     readonly defaultKernelLanguage: string;
+    private _ready;
     private _sharedModel;
     private _dirty;
     private _readOnly;

package/lib/model.js

@@ -3,7 +3,7 @@
  * Distributed under the terms of the Modified BSD License.
  */
 import { ChatModel } from '@jupyter/chat';
-import { UUID } from '@lumino/coreutils';
+import { PromiseDelegate, UUID } from '@lumino/coreutils';
 import { Signal } from '@lumino/signaling';
 import { YChat } from './ychat';
 const WRITING_DELAY = 1000;
@@ -70,6 +70,7 @@ export class LabChatModel extends ChatModel {
         };
         this.defaultKernelName = '';
         this.defaultKernelLanguage = '';
+        this._ready = new PromiseDelegate();
         this._dirty = false;
         this._readOnly = false;
         this._disposed = new Signal(this);
@@ -84,7 +85,6 @@ export class LabChatModel extends ChatModel {
         else {
             this._sharedModel = YChat.create();
         }
-        this.id = this._sharedModel.id;
         this.sharedModel.changed.connect(this._onchange, this);
         this.config = widgetConfig.config;
         widgetConfig.configChanged.connect((_, config) => {
@@ -119,6 +119,12 @@ export class LabChatModel extends ChatModel {
     get disposed() {
         return this._disposed;
     }
+    set id(value) {
+        super.id = value;
+        if (value) {
+            this._ready.resolve();
+        }
+    }
     dispose() {
         if (this.isDisposed) {
             return;
@@ -140,6 +146,13 @@ export class LabChatModel extends ChatModel {
     fromJSON(data) {
         // nothing to do
     }
+    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(() => {
+            super.messagesInserted(index, messages);
+        });
+    }
     sendMessage(message) {
         this._resetWritingStatus();
         if (this._timeoutWriting !== null) {

package/lib/widget.d.ts

@@ -1,5 +1,5 @@
 import { ChatWidget, IAutocompletionRegistry, IChatModel } from '@jupyter/chat';
-import { ICollaborativeDrive } from '@jupyter/docprovider';
+import { ICollaborativeDrive } from '@jupyter/collaborative-drive';
 import { IThemeManager } from '@jupyterlab/apputils';
 import { DocumentWidget } from '@jupyterlab/docregistry';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';

package/lib/ychat.d.ts

@@ -59,6 +59,8 @@ export declare class YChat extends YDocument<IChatChanges> {
     get id(): string;
     get users(): JSONObject;
     get messages(): string[];
+    getSource(): JSONObject;
+    setSource(value: JSONObject): void;
     getUser(username: string | undefined): IUser | undefined;
     setUser(value: IUser): void;
     getMessage(index: number): IYmessage | undefined;

package/lib/ychat.js

@@ -112,6 +112,28 @@ export class YChat extends YDocument {
     get messages() {
         return JSONExt.deepCopy(this._messages.toJSON());
     }
+    getSource() {
+        const users = this._users.toJSON();
+        const messages = this._messages.toJSON();
+        const metadata = this._metadata.toJSON();
+        return { users, messages, metadata };
+    }
+    setSource(value) {
+        if (!value) {
+            return;
+        }
+        this.transact(() => {
+            var _a, _b, _c;
+            const messages = (_a = value['messages']) !== null && _a !== void 0 ? _a : [];
+            messages.forEach(message => {
+                this._messages.push([message]);
+            });
+            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 : {};
+            Object.entries(metadata).forEach(([key, val]) => this._metadata.set(key, val));
+        });
+    }
     getUser(username) {
         if (!username) {
             return undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jupyterlab-chat",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "description": "The library to build a chat based on shared document",
   "keywords": [
     "jupyter",
@@ -51,9 +51,9 @@
     "watch:src": "tsc -w --sourceMap"
   },
   "dependencies": {
-    "@jupyter/chat": "^0.6.2",
-    "@jupyter/docprovider": "^2.1.4",
-    "@jupyter/ydoc": "^1.1.1",
+    "@jupyter/chat": "^0.7.0",
+    "@jupyter/collaborative-drive": "^3.0.0",
+    "@jupyter/ydoc": "^2.0.0 || ^3.0.0",
     "@jupyterlab/application": "^4.2.0",
     "@jupyterlab/apputils": "^4.3.0",
     "@jupyterlab/coreutils": "^6.2.0",

package/src/model.ts

@@ -7,7 +7,7 @@ import { ChatModel, IChatMessage, INewMessage, IUser } from '@jupyter/chat';
 import { IChangedArgs } from '@jupyterlab/coreutils';
 import { DocumentRegistry } from '@jupyterlab/docregistry';
 import { User } from '@jupyterlab/services';
-import { PartialJSONObject, UUID } from '@lumino/coreutils';
+import { PartialJSONObject, PromiseDelegate, UUID } from '@lumino/coreutils';
 import { ISignal, Signal } from '@lumino/signaling';
 
 import { IWidgetConfig } from './token';
@@ -44,8 +44,6 @@ export class LabChatModel extends ChatModel implements DocumentRegistry.IModel {
       this._sharedModel = YChat.create();
     }
 
-    this.id = this._sharedModel.id;
-
     this.sharedModel.changed.connect(this._onchange, this);
 
     this.config = widgetConfig.config;
@@ -93,6 +91,13 @@ export class LabChatModel extends ChatModel implements DocumentRegistry.IModel {
     return this._disposed;
   }
 
+  set id(value: string | undefined) {
+    super.id = value;
+    if (value) {
+      this._ready.resolve();
+    }
+  }
+
   dispose(): void {
     if (this.isDisposed) {
       return;
@@ -119,6 +124,14 @@ export class LabChatModel extends ChatModel implements DocumentRegistry.IModel {
     // nothing to do
   }
 
+  messagesInserted(index: number, messages: IChatMessage[]): 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(() => {
+      super.messagesInserted(index, messages);
+    });
+  }
+
   sendMessage(message: INewMessage): Promise<boolean | void> | boolean | void {
     this._resetWritingStatus();
     if (this._timeoutWriting !== null) {
@@ -260,6 +273,7 @@ export class LabChatModel extends ChatModel implements DocumentRegistry.IModel {
   readonly defaultKernelName: string = '';
   readonly defaultKernelLanguage: string = '';
 
+  private _ready = new PromiseDelegate<void>();
   private _sharedModel: YChat;
 
   private _dirty = false;

package/src/widget.tsx

@@ -9,7 +9,7 @@ import {
   IChatModel,
   readIcon
 } from '@jupyter/chat';
-import { ICollaborativeDrive } from '@jupyter/docprovider';
+import { ICollaborativeDrive } from '@jupyter/collaborative-drive';
 import { IThemeManager } from '@jupyterlab/apputils';
 import { PathExt } from '@jupyterlab/coreutils';
 import { DocumentWidget } from '@jupyterlab/docregistry';

package/src/ychat.ts

@@ -96,6 +96,37 @@ export class YChat extends YDocument<IChatChanges> {
     return JSONExt.deepCopy(this._messages.toJSON());
   }
 
+  getSource(): JSONObject {
+    const users = this._users.toJSON();
+    const messages = this._messages.toJSON();
+    const metadata = this._metadata.toJSON();
+
+    return { users, messages, metadata };
+  }
+
+  setSource(value: JSONObject): void {
+    if (!value) {
+      return;
+    }
+
+    this.transact(() => {
+      const messages = (value['messages'] as unknown as Array<IYmessage>) ?? [];
+      messages.forEach(message => {
+        this._messages.push([message]);
+      });
+
+      const users = value['users'] ?? {};
+      Object.entries(users).forEach(([key, val]) =>
+        this._users.set(key, val as IUser)
+      );
+
+      const metadata = value['metadata'] ?? {};
+      Object.entries(metadata).forEach(([key, val]) =>
+        this._metadata.set(key, val as any)
+      );
+    });
+  }
+
   getUser(username: string | undefined): IUser | undefined {
     if (!username) {
       return undefined;