@jupyter/chat 0.25.0-alpha.2 → 0.25.0-alpha.4

package/lib/model.d.ts

@@ -12,6 +12,10 @@ import { IChatHistory, IConfig, IMessage, IMessageContent, INewMessage, IUser }
  * The chat model interface.
  */
 export interface IChatModel extends IDisposable {
+    /**
+     * The unique id of the chat, when known. Implemented by `AbstractChatModel`.
+     */
+    id?: string;
     /**
      * The chat model name.
      */
@@ -25,9 +29,11 @@ export interface IChatModel extends IDisposable {
      */
     unreadMessages: number[];
     /**
-     * The promise resolving when the model is ready.
+     * A promise that resolves, once the model is ready, with the chat's stable
+     * id. The id matches the backend's `chat.get_id()` and is guaranteed to be
+     * available (and never change) from this point on.
      */
-    readonly ready: Promise<void>;
+    readonly ready: Promise<string>;
     /**
      * The awareness channel of the underlying shared document, when the chat is
      * backed by one. Lets extensions read collaborative state attached to the
@@ -253,13 +259,17 @@ export declare abstract class AbstractChatModel implements IChatModel {
     get lastRead(): number;
     set lastRead(value: number);
     /**
-     * Promise that resolves when the model is ready.
+     * Promise that resolves, when the model is ready, with the chat's stable id.
      */
-    get ready(): Promise<void>;
+    get ready(): Promise<string>;
     /**
-     * Set the model as ready.
+     * Mark the model as ready, resolving `ready` with the chat's stable id.
+     *
+     * The id must match the backend's `chat.get_id()`; callers pass the
+     * server-authoritative id (WebSocket connection frame, or the synchronized
+     * shared-document metadata under RTC).
      */
-    protected setReady(): void;
+    protected setReady(id: string): void;
     /**
      * The chat settings.
      */
@@ -518,6 +528,12 @@ export declare namespace IChatModel {
  * exposing the method that can modify it.
  */
 export interface IChatContext {
+    /**
+     * The chat's stable id. Always available: a chat context is only created once
+     * the model is `ready`, at which point the id is guaranteed to be set (and to
+     * match the backend's `chat.get_id()`).
+     */
+    readonly id: string;
     /**
      * The name of the chat.
      */
@@ -548,6 +564,7 @@ export declare abstract class AbstractChatContext implements IChatContext {
     constructor(options: {
         model: IChatModel;
     });
+    get id(): string;
     get name(): string;
     get messages(): IMessageContent[];
     get user(): IUser | undefined;

package/lib/model.js

@@ -151,16 +151,20 @@ export class AbstractChatModel {
         localStorage.setItem(`@jupyter/chat:${this._id}`, JSON.stringify(storage));
     }
     /**
-     * Promise that resolves when the model is ready.
+     * Promise that resolves, when the model is ready, with the chat's stable id.
      */
     get ready() {
         return this._readyDelegate.promise;
     }
     /**
-     * Set the model as ready.
+     * Mark the model as ready, resolving `ready` with the chat's stable id.
+     *
+     * The id must match the backend's `chat.get_id()`; callers pass the
+     * server-authoritative id (WebSocket connection frame, or the synchronized
+     * shared-document metadata under RTC).
      */
-    setReady() {
-        this._readyDelegate.resolve();
+    setReady(id) {
+        this._readyDelegate.resolve(id);
     }
     /**
      * The chat settings.
@@ -532,6 +536,16 @@ export class AbstractChatContext {
     constructor(options) {
         this._model = options.model;
     }
+    get id() {
+        // A chat context is only created once the model is ready (see the
+        // AbstractChatModel constructor), so the model's id is guaranteed set here.
+        const id = this._model.id;
+        if (id === undefined) {
+            throw new Error('IChatContext.id was read before the model was ready; ' +
+                'a chat context must only be created after `model.ready`.');
+        }
+        return id;
+    }
     get name() {
         return this._model.name;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/chat",
-  "version": "0.25.0-alpha.2",
+  "version": "0.25.0-alpha.4",
   "description": "A package that provides UI components that can be used to create a chat in a Jupyterlab extension.",
   "keywords": [
     "jupyter",

package/src/model.ts

@@ -33,6 +33,11 @@ import {
  * The chat model interface.
  */
 export interface IChatModel extends IDisposable {
+  /**
+   * The unique id of the chat, when known. Implemented by `AbstractChatModel`.
+   */
+  id?: string;
+
   /**
    * The chat model name.
    */
@@ -49,9 +54,11 @@ export interface IChatModel extends IDisposable {
   unreadMessages: number[];
 
   /**
-   * The promise resolving when the model is ready.
+   * A promise that resolves, once the model is ready, with the chat's stable
+   * id. The id matches the backend's `chat.get_id()` and is guaranteed to be
+   * available (and never change) from this point on.
    */
-  readonly ready: Promise<void>;
+  readonly ready: Promise<string>;
 
   /**
    * The awareness channel of the underlying shared document, when the chat is
@@ -309,7 +316,7 @@ export abstract class AbstractChatModel implements IChatModel {
     this._selectionWatcher = options.selectionWatcher ?? null;
     this._documentManager = options.documentManager ?? null;
 
-    this._readyDelegate = new PromiseDelegate<void>();
+    this._readyDelegate = new PromiseDelegate<string>();
 
     this.ready.then(() => {
       this._inputModel.chatContext = this.createChatContext();
@@ -417,17 +424,21 @@ export abstract class AbstractChatModel implements IChatModel {
   }
 
   /**
-   * Promise that resolves when the model is ready.
+   * Promise that resolves, when the model is ready, with the chat's stable id.
    */
-  get ready(): Promise<void> {
+  get ready(): Promise<string> {
     return this._readyDelegate.promise;
   }
 
   /**
-   * Set the model as ready.
+   * Mark the model as ready, resolving `ready` with the chat's stable id.
+   *
+   * The id must match the backend's `chat.get_id()`; callers pass the
+   * server-authoritative id (WebSocket connection frame, or the synchronized
+   * shared-document metadata under RTC).
    */
-  protected setReady(): void {
-    this._readyDelegate.resolve();
+  protected setReady(id: string): void {
+    this._readyDelegate.resolve(id);
   }
 
   /**
@@ -876,7 +887,7 @@ export abstract class AbstractChatModel implements IChatModel {
   private _name: string = '';
   private _config: IConfig;
   protected _trans: TranslationBundle;
-  private _readyDelegate = new PromiseDelegate<void>();
+  private _readyDelegate = new PromiseDelegate<string>();
   private _inputModel: IInputModel;
   private _disposed = new Signal<IChatModel, void>(this);
   private _isDisposed = false;
@@ -999,6 +1010,12 @@ export namespace IChatModel {
  * exposing the method that can modify it.
  */
 export interface IChatContext {
+  /**
+   * The chat's stable id. Always available: a chat context is only created once
+   * the model is `ready`, at which point the id is guaranteed to be set (and to
+   * match the backend's `chat.get_id()`).
+   */
+  readonly id: string;
   /**
    * The name of the chat.
    */
@@ -1031,6 +1048,19 @@ export abstract class AbstractChatContext implements IChatContext {
     this._model = options.model;
   }
 
+  get id(): string {
+    // A chat context is only created once the model is ready (see the
+    // AbstractChatModel constructor), so the model's id is guaranteed set here.
+    const id = this._model.id;
+    if (id === undefined) {
+      throw new Error(
+        'IChatContext.id was read before the model was ready; ' +
+          'a chat context must only be created after `model.ready`.'
+      );
+    }
+    return id;
+  }
+
   get name(): string {
     return this._model.name;
   }