@jupyter/chat 0.23.0-alpha.3 → 0.23.0

package/lib/__tests__/model.spec.js

@@ -2,9 +2,6 @@
  * 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
- */
 import { AbstractChatModel } from '../model';
 import { MockChatModel, MockChatContext } from './mocks';
 describe('test chat model', () => {
@@ -125,4 +122,21 @@ describe('test chat model', () => {
             expect(model.config.sendWithShiftEnter).toBeTruthy();
         });
     });
+    describe('awareness', () => {
+        it('should surface the model awareness on the context', () => {
+            class AwareChatModel extends MockChatModel {
+                constructor() {
+                    super(...arguments);
+                    this.awareness = {};
+                }
+            }
+            const model = new AwareChatModel();
+            const context = new MockChatContext({ model });
+            expect(context.awareness).toBe(model.awareness);
+        });
+        it('should be undefined when the model has no awareness', () => {
+            const context = new MockChatContext({ model: new MockChatModel() });
+            expect(context.awareness).toBeUndefined();
+        });
+    });
 });

package/lib/model.d.ts

@@ -1,5 +1,6 @@
 import { IDocumentManager } from '@jupyterlab/docmanager';
 import { ITranslator, TranslationBundle } from '@jupyterlab/translation';
+import type { IAwareness } from '@jupyter/ydoc';
 import { CommandRegistry } from '@lumino/commands';
 import { IDisposable } from '@lumino/disposable';
 import { ISignal } from '@lumino/signaling';
@@ -27,6 +28,13 @@ export interface IChatModel extends IDisposable {
      * The promise resolving when the model is ready.
      */
     readonly ready: Promise<void>;
+    /**
+     * The awareness channel of the underlying shared document, when the chat is
+     * backed by one. Lets extensions read collaborative state attached to the
+     * chat (e.g. session information published by AI personas) through a
+     * supported API instead of reaching into a concrete implementation.
+     */
+    readonly awareness?: IAwareness;
     /**
      * The indexes list of the messages currently in the viewport.
      */
@@ -470,6 +478,11 @@ export interface IChatContext {
      * Current user connected with the chat panel
      */
     readonly user: IUser | undefined;
+    /**
+     * The awareness channel of the underlying shared document, when the chat is
+     * backed by one.
+     */
+    readonly awareness?: IAwareness;
 }
 /**
  * An abstract base class implementing `IChatContext`. This can be extended into
@@ -482,6 +495,7 @@ export declare abstract class AbstractChatContext implements IChatContext {
     get name(): string;
     get messages(): IMessageContent[];
     get user(): IUser | undefined;
+    get awareness(): IAwareness | undefined;
     /**
      * ABSTRACT: Should return a list of users who have connected to this chat.
      */

package/lib/model.js

@@ -488,4 +488,7 @@ export class AbstractChatContext {
         var _a;
         return (_a = this._model) === null || _a === void 0 ? void 0 : _a.user;
     }
+    get awareness() {
+        return this._model.awareness;
+    }
 }

package/lib/widgets/multichat-panel.js

@@ -133,6 +133,7 @@ export class MultiChatPanel extends PanelWithToolbar {
                     this.open(addChatArgs);
                 },
                 icon: addIcon,
+                label: this._trans.__('New chat'),
                 tooltip: this._trans.__('Create a new chat')
             });
             addChat.addClass(ADD_BUTTON_CLASS);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/chat",
-  "version": "0.23.0-alpha.3",
+  "version": "0.23.0",
   "description": "A package that provides UI components that can be used to create a chat in a Jupyterlab extension.",
   "keywords": [
     "jupyter",
@@ -46,6 +46,7 @@
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
     "@jupyter/react-components": "^0.15.2",
+    "@jupyter/ydoc": "^3.0.0 || ^4.0.0",
     "@jupyterlab/application": "^4.6.0",
     "@jupyterlab/apputils": "^4.7.0",
     "@jupyterlab/codeeditor": "^4.6.0",

package/src/__tests__/model.spec.ts

@@ -7,6 +7,8 @@
  * Example of [Jest](https://jestjs.io/docs/getting-started) unit tests
  */
 
+import type { IAwareness } from '@jupyter/ydoc';
+
 import { AbstractChatModel, IChatContext, IChatModel } from '../model';
 import { IMessage, IMessageContent, INewMessage } from '../types';
 import { MockChatModel, MockChatContext } from './mocks';
@@ -149,4 +151,20 @@ describe('test chat model', () => {
       expect(model.config.sendWithShiftEnter).toBeTruthy();
     });
   });
+
+  describe('awareness', () => {
+    it('should surface the model awareness on the context', () => {
+      class AwareChatModel extends MockChatModel {
+        readonly awareness = {} as IAwareness;
+      }
+      const model = new AwareChatModel();
+      const context = new MockChatContext({ model });
+      expect(context.awareness).toBe(model.awareness);
+    });
+
+    it('should be undefined when the model has no awareness', () => {
+      const context = new MockChatContext({ model: new MockChatModel() });
+      expect(context.awareness).toBeUndefined();
+    });
+  });
 });

package/src/model.ts

@@ -9,6 +9,7 @@ import {
   nullTranslator,
   TranslationBundle
 } from '@jupyterlab/translation';
+import type { IAwareness } from '@jupyter/ydoc';
 import { ArrayExt } from '@lumino/algorithm';
 import { CommandRegistry } from '@lumino/commands';
 import { PromiseDelegate } from '@lumino/coreutils';
@@ -53,6 +54,14 @@ export interface IChatModel extends IDisposable {
    */
   readonly ready: Promise<void>;
 
+  /**
+   * The awareness channel of the underlying shared document, when the chat is
+   * backed by one. Lets extensions read collaborative state attached to the
+   * chat (e.g. session information published by AI personas) through a
+   * supported API instead of reaching into a concrete implementation.
+   */
+  readonly awareness?: IAwareness;
+
   /**
    * The indexes list of the messages currently in the viewport.
    */
@@ -894,6 +903,11 @@ export interface IChatContext {
    * Current user connected with the chat panel
    */
   readonly user: IUser | undefined;
+  /**
+   * The awareness channel of the underlying shared document, when the chat is
+   * backed by one.
+   */
+  readonly awareness?: IAwareness;
 }
 
 /**
@@ -917,6 +931,10 @@ export abstract class AbstractChatContext implements IChatContext {
     return this._model?.user;
   }
 
+  get awareness(): IAwareness | undefined {
+    return this._model.awareness;
+  }
+
   /**
    * ABSTRACT: Should return a list of users who have connected to this chat.
    */

package/src/widgets/multichat-panel.tsx

@@ -102,6 +102,7 @@ export class MultiChatPanel extends PanelWithToolbar {
           this.open(addChatArgs);
         },
         icon: addIcon,
+        label: this._trans.__('New chat'),
         tooltip: this._trans.__('Create a new chat')
       });
       addChat.addClass(ADD_BUTTON_CLASS);