jupyterlab-chat 0.22.0 → 0.23.0-alpha.0

package/lib/__tests__/jupyterlab_collaborative_chat.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/__tests__/jupyterlab_collaborative_chat.spec.js

@@ -1,13 +1,41 @@
-"use strict";
 /*
  * Copyright (c) Jupyter Development Team.
  * Distributed under the terms of the Modified BSD License.
  */
-/**
- * Example of [Jest](https://jestjs.io/docs/getting-started) unit tests
- */
-describe('jupyterlab-chat', () => {
-    it('should be tested', () => {
-        expect(1 + 1).toEqual(2);
+import { enforceAutosaveEnabled } from '../autosave';
+describe('enforceAutosaveEnabled', () => {
+    it('should set autosave to true when it is missing', () => {
+        const state = {};
+        const awareness = {
+            getLocalState: () => state,
+            setLocalStateField: (field, value) => {
+                state[field] = value;
+            }
+        };
+        enforceAutosaveEnabled(awareness);
+        expect(state.autosave).toBe(true);
+    });
+    it('should set autosave to true when it is false', () => {
+        const state = { autosave: false };
+        const awareness = {
+            getLocalState: () => state,
+            setLocalStateField: (field, value) => {
+                state[field] = value;
+            }
+        };
+        enforceAutosaveEnabled(awareness);
+        expect(state.autosave).toBe(true);
+    });
+    it('should keep autosave true when already enabled', () => {
+        const state = { autosave: true };
+        let called = false;
+        const awareness = {
+            getLocalState: () => state,
+            setLocalStateField: () => {
+                called = true;
+            }
+        };
+        enforceAutosaveEnabled(awareness);
+        expect(called).toBe(false);
     });
 });

package/lib/autosave.d.ts

@@ -0,0 +1,8 @@
+import type { IAwareness } from '@jupyter/ydoc';
+type AutosaveAwareness = Pick<IAwareness, 'getLocalState' | 'setLocalStateField'>;
+/**
+ * Chat files should always advertise autosave=true so server-side RTC saving
+ * remains enabled even when global autosave is disabled.
+ */
+export declare function enforceAutosaveEnabled(awareness: AutosaveAwareness): void;
+export {};

package/lib/autosave.js

@@ -0,0 +1,14 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+/**
+ * Chat files should always advertise autosave=true so server-side RTC saving
+ * remains enabled even when global autosave is disabled.
+ */
+export function enforceAutosaveEnabled(awareness) {
+    var _a;
+    if (((_a = awareness.getLocalState()) === null || _a === void 0 ? void 0 : _a.autosave) !== true) {
+        awareness.setLocalStateField('autosave', true);
+    }
+}

package/lib/model.d.ts

@@ -91,6 +91,7 @@ export declare class LabChatModel extends AbstractChatModel implements DocumentR
     onAwarenessChange: () => void;
     private _buildMentionList;
     private _resetWritingStatus;
+    private _enforceAutosaveEnabled;
     private _onchange;
     readonly defaultKernelName: string;
     readonly defaultKernelLanguage: string;

package/lib/model.js

@@ -5,6 +5,7 @@
 import { AbstractChatModel, AbstractChatContext } from '@jupyter/chat';
 import { UUID } from '@lumino/coreutils';
 import { Signal } from '@lumino/signaling';
+import { enforceAutosaveEnabled } from './autosave';
 import { YChat } from './ychat';
 const WRITING_DELAY = 1000;
 /**
@@ -103,6 +104,9 @@ export class LabChatModel extends AbstractChatModel {
             }
             this.updateWriters(writers);
         };
+        this._enforceAutosaveEnabled = () => {
+            enforceAutosaveEnabled(this.sharedModel.awareness);
+        };
         this._onchange = async (_, changes) => {
             if (changes.messageListChanges) {
                 const msgDelta = changes.messageListChanges;
@@ -221,6 +225,12 @@ export class LabChatModel extends AbstractChatModel {
                     }
                 });
             }
+            // Create a chat ID if not created when the document is not dirty.
+            if (changes.stateChange && !this._sharedModel.id) {
+                if (changes.stateChange.some(change => change.name === 'dirty' && !change.newValue)) {
+                    this._sharedModel.id = UUID.uuid4();
+                }
+            }
         };
         this.defaultKernelName = '';
         this.defaultKernelLanguage = '';
@@ -238,12 +248,14 @@ export class LabChatModel extends AbstractChatModel {
         else {
             this._sharedModel = YChat.create();
         }
-        this.sharedModel.changed.connect(this._onchange, this);
+        this._sharedModel.changed.connect(this._onchange, this);
         this.config = widgetConfig.config;
         widgetConfig.configChanged.connect((_, config) => {
             this.config = config;
         });
         this.sharedModel.awareness.on('change', this.onAwarenessChange);
+        this.sharedModel.awareness.on('change', this._enforceAutosaveEnabled);
+        this._enforceAutosaveEnabled();
         this.input.valueChanged.connect((_, value) => this.onInputChanged(value));
         this.messageEditionAdded.connect(this.onMessageEditionAdded);
     }
@@ -282,6 +294,8 @@ export class LabChatModel extends AbstractChatModel {
             return;
         }
         super.dispose();
+        this.sharedModel.awareness.off('change', this.onAwarenessChange);
+        this.sharedModel.awareness.off('change', this._enforceAutosaveEnabled);
         this._sharedModel.dispose();
         Signal.clearData(this);
     }

package/lib/ychat.d.ts

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

package/lib/ychat.js

@@ -185,6 +185,13 @@ export class YChat extends YDocument {
     get id() {
         return this._metadata.get('id') || '';
     }
+    set id(value) {
+        this.transact(() => {
+            if (!this._metadata.get('id')) {
+                this._metadata.set('id', value);
+            }
+        });
+    }
     get users() {
         const userDict = JSONExt.deepCopy(this._users.toJSON());
         return userDict;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jupyterlab-chat",
-  "version": "0.22.0",
+  "version": "0.23.0-alpha.0",
   "description": "The library to build a chat based on shared document",
   "keywords": [
     "jupyter",
@@ -42,31 +42,31 @@
     "watch:src": "tsc -w --sourceMap"
   },
   "dependencies": {
-    "@jupyter/chat": "^0.22.0",
-    "@jupyter/collaborative-drive": "^4.0.2",
-    "@jupyter/ydoc": "^2.0.0 || ^3.0.0",
-    "@jupyterlab/application": "^4.2.0",
-    "@jupyterlab/apputils": "^4.3.0",
-    "@jupyterlab/coreutils": "^6.2.0",
-    "@jupyterlab/docmanager": "^4.2.0",
-    "@jupyterlab/docregistry": "^4.2.0",
-    "@jupyterlab/launcher": "^4.2.0",
-    "@jupyterlab/notebook": "^4.2.0",
-    "@jupyterlab/rendermime": "^4.2.0",
-    "@jupyterlab/services": "^7.2.0",
-    "@jupyterlab/settingregistry": "^4.2.0",
-    "@jupyterlab/translation": "^4.2.0",
-    "@jupyterlab/ui-components": "^4.2.0",
-    "@lumino/commands": "^2.0.0",
-    "@lumino/coreutils": "^2.0.0",
-    "@lumino/signaling": "^2.0.0",
-    "@lumino/widgets": "^2.0.0",
+    "@jupyter/chat": "^0.23.0-alpha.0",
+    "@jupyter/collaborative-drive": "^4.4.0",
+    "@jupyter/ydoc": "^3.0.0 || ^4.0.0",
+    "@jupyterlab/application": "^4.6.0",
+    "@jupyterlab/apputils": "^4.7.0",
+    "@jupyterlab/coreutils": "^6.6.0",
+    "@jupyterlab/docmanager": "^4.6.0",
+    "@jupyterlab/docregistry": "^4.6.0",
+    "@jupyterlab/launcher": "^4.6.0",
+    "@jupyterlab/notebook": "^4.6.0",
+    "@jupyterlab/rendermime": "^4.6.0",
+    "@jupyterlab/services": "^7.6.0",
+    "@jupyterlab/settingregistry": "^4.6.0",
+    "@jupyterlab/translation": "^4.6.0",
+    "@jupyterlab/ui-components": "^4.6.0",
+    "@lumino/commands": "^2.3.3",
+    "@lumino/coreutils": "^2.2.2",
+    "@lumino/signaling": "^2.1.5",
+    "@lumino/widgets": "^2.8.0",
     "react": "^18.2.0",
     "y-protocols": "^1.0.5",
     "yjs": "^13.5.40"
   },
   "devDependencies": {
-    "@jupyterlab/testing": "^4.2.0",
+    "@jupyterlab/testing": "^4.6.0",
     "@types/jest": "^29.2.0",
     "@types/json-schema": "^7.0.11",
     "@types/react": "^18.2.0",
@@ -78,7 +78,7 @@
     "rimraf": "^5.0.1",
     "source-map-loader": "^1.0.2",
     "style-loader": "^3.3.1",
-    "typescript": "~5.0.2",
+    "typescript": "~5.9.3",
     "yjs": "^13.5.0"
   },
   "sideEffects": [

package/src/__tests__/jupyterlab_collaborative_chat.spec.ts

@@ -3,12 +3,46 @@
  * Distributed under the terms of the Modified BSD License.
  */
 
-/**
- * Example of [Jest](https://jestjs.io/docs/getting-started) unit tests
- */
+import { enforceAutosaveEnabled } from '../autosave';
+
+describe('enforceAutosaveEnabled', () => {
+  it('should set autosave to true when it is missing', () => {
+    const state: Record<string, unknown> = {};
+    const awareness = {
+      getLocalState: () => state,
+      setLocalStateField: (field: string, value: unknown) => {
+        state[field] = value;
+      }
+    };
+
+    enforceAutosaveEnabled(awareness);
+    expect(state.autosave).toBe(true);
+  });
+
+  it('should set autosave to true when it is false', () => {
+    const state: Record<string, unknown> = { autosave: false };
+    const awareness = {
+      getLocalState: () => state,
+      setLocalStateField: (field: string, value: unknown) => {
+        state[field] = value;
+      }
+    };
+
+    enforceAutosaveEnabled(awareness);
+    expect(state.autosave).toBe(true);
+  });
+
+  it('should keep autosave true when already enabled', () => {
+    const state: Record<string, unknown> = { autosave: true };
+    let called = false;
+    const awareness = {
+      getLocalState: () => state,
+      setLocalStateField: () => {
+        called = true;
+      }
+    };
 
-describe('jupyterlab-chat', () => {
-  it('should be tested', () => {
-    expect(1 + 1).toEqual(2);
+    enforceAutosaveEnabled(awareness);
+    expect(called).toBe(false);
   });
 });

package/src/autosave.ts

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+import type { IAwareness } from '@jupyter/ydoc';
+
+type AutosaveAwareness = Pick<
+  IAwareness,
+  'getLocalState' | 'setLocalStateField'
+>;
+
+/**
+ * Chat files should always advertise autosave=true so server-side RTC saving
+ * remains enabled even when global autosave is disabled.
+ */
+export function enforceAutosaveEnabled(awareness: AutosaveAwareness): void {
+  if (awareness.getLocalState()?.autosave !== true) {
+    awareness.setLocalStateField('autosave', true);
+  }
+}

package/src/model.ts

@@ -20,6 +20,7 @@ import { User } from '@jupyterlab/services';
 import { PartialJSONObject, UUID } from '@lumino/coreutils';
 import { ISignal, Signal } from '@lumino/signaling';
 
+import { enforceAutosaveEnabled } from './autosave';
 import { IWidgetConfig } from './token';
 import { IChatChanges, IYmessage, YChat } from './ychat';
 
@@ -105,7 +106,7 @@ export class LabChatModel
       this._sharedModel = YChat.create();
     }
 
-    this.sharedModel.changed.connect(this._onchange, this);
+    this._sharedModel.changed.connect(this._onchange, this);
 
     this.config = widgetConfig.config;
 
@@ -114,6 +115,8 @@ export class LabChatModel
     });
 
     this.sharedModel.awareness.on('change', this.onAwarenessChange);
+    this.sharedModel.awareness.on('change', this._enforceAutosaveEnabled);
+    this._enforceAutosaveEnabled();
 
     this.input.valueChanged.connect((_, value) => this.onInputChanged(value));
     this.messageEditionAdded.connect(this.onMessageEditionAdded);
@@ -163,6 +166,8 @@ export class LabChatModel
       return;
     }
     super.dispose();
+    this.sharedModel.awareness.off('change', this.onAwarenessChange);
+    this.sharedModel.awareness.off('change', this._enforceAutosaveEnabled);
     this._sharedModel.dispose();
     Signal.clearData(this);
   }
@@ -397,6 +402,10 @@ export class LabChatModel
     this._timeoutWriting = null;
   }
 
+  private _enforceAutosaveEnabled = () => {
+    enforceAutosaveEnabled(this.sharedModel.awareness);
+  };
+
   private _onchange = async (_: YChat, changes: IChatChanges) => {
     if (changes.messageListChanges) {
       const msgDelta = changes.messageListChanges;
@@ -530,6 +539,17 @@ export class LabChatModel
         }
       });
     }
+
+    // Create a chat ID if not created when the document is not dirty.
+    if (changes.stateChange && !this._sharedModel.id) {
+      if (
+        changes.stateChange.some(
+          change => change.name === 'dirty' && !change.newValue
+        )
+      ) {
+        this._sharedModel.id = UUID.uuid4();
+      }
+    }
   };
 
   readonly defaultKernelName: string = '';

package/src/ychat.ts

@@ -109,6 +109,14 @@ export class YChat extends YDocument<IChatChanges> {
     return (this._metadata.get('id') as string) || '';
   }
 
+  set id(value: string) {
+    this.transact(() => {
+      if (!this._metadata.get('id')) {
+        this._metadata.set('id', value);
+      }
+    });
+  }
+
   get users(): Record<string, IUser> {
     const userDict = JSONExt.deepCopy(this._users.toJSON()) as Record<
       string,