jupyterlab-chat 0.15.0 → 0.16.0

package/lib/model.d.ts

@@ -17,6 +17,33 @@ export declare namespace LabChatModel {
         languagePreference?: string;
     }
 }
+/**
+ * A data model class that represents a user and implements the `IUser` interface.
+ * Currently, this just just ensures that `user.mention_name` is always
+ * accessible by defining it as a getter property.
+ *
+ * The constructor accepts an `identity: User.IIdentity | IUser | null` object.
+ * If `identity == null`, this class provides default values for each required
+ * field.
+ *
+ * TODO: should `identity` (from `LabChatModel.IOptions.user`) ever be `null`?
+ *
+ * TODO: should this be lifted up into `packages/jupyter-chat`?
+ */
+declare class LabChatUser implements IUser {
+    constructor(identity: User.IIdentity | IUser | null);
+    get mention_name(): string;
+    toJSON(): this & {
+        mention_name: string;
+    };
+    username: string;
+    name?: string;
+    display_name?: string;
+    initials?: string;
+    color?: string;
+    avatar_url?: string;
+    bot?: boolean;
+}
 /**
  * The chat document model.
  */
@@ -86,5 +113,6 @@ export declare class LabChatContext extends AbstractChatContext {
     /**
      * The list of users who have connected to this chat.
      */
-    get users(): IUser[];
+    get users(): LabChatUser[];
 }
+export {};

package/lib/ychat.d.ts

@@ -78,6 +78,15 @@ export declare class YChat extends YDocument<IChatChanges> {
     getMessageIndex(id: string): number;
     deleteMessage(index: number): void;
     getAttachment(id: string): IAttachment | undefined;
+    /**
+     * Adds or modifies an attachment in the chat, and returns the ID of the
+     * attachment.
+     *
+     * NOTE: this method does not add an attachment to any message. It merely adds
+     * the attachment data to the chat file and returns an attachment ID. To add
+     * an attachment to a new message, consumers should call this method & add the
+     * returned ID to `NewMessage.attachments`.
+     */
     setAttachment(attachment: IAttachment): string;
     private _usersObserver;
     private _messagesObserver;

package/lib/ychat.js

@@ -211,10 +211,28 @@ export class YChat extends YDocument {
     getAttachment(id) {
         return this._attachments.get(id);
     }
+    /**
+     * Adds or modifies an attachment in the chat, and returns the ID of the
+     * attachment.
+     *
+     * NOTE: this method does not add an attachment to any message. It merely adds
+     * the attachment data to the chat file and returns an attachment ID. To add
+     * an attachment to a new message, consumers should call this method & add the
+     * returned ID to `NewMessage.attachments`.
+     */
     setAttachment(attachment) {
-        var _a;
-        // Search if the attachment already exist to update it, otherwise add it.
-        const id = ((_a = Array.from(this._attachments.entries()).find(([_, att]) => att.type === attachment.type && att.value === attachment.value)) === null || _a === void 0 ? void 0 : _a[0]) || UUID.uuid4();
+        // Use the existing ID if the attachment already exists, otherwise create a
+        // new ID
+        const attachmentJson = JSON.stringify(attachment);
+        let existingId;
+        for (const [id, att] of this._attachments.entries()) {
+            if (JSON.stringify(att) === attachmentJson) {
+                existingId = id;
+                break;
+            }
+        }
+        const id = existingId || UUID.uuid4();
+        // Set the attachment using the computed ID, then return the ID
         this.transact(() => {
             this._attachments.set(id, attachment);
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jupyterlab-chat",
-  "version": "0.15.0",
+  "version": "0.16.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.15.0",
+    "@jupyter/chat": "^0.16.0",
     "@jupyter/collaborative-drive": "^4.0.2",
     "@jupyter/ydoc": "^2.0.0 || ^3.0.0",
     "@jupyterlab/application": "^4.2.0",

package/src/model.ts

@@ -509,9 +509,9 @@ export class LabChatContext extends AbstractChatContext {
   /**
    * The list of users who have connected to this chat.
    */
-  get users(): IUser[] {
+  get users(): LabChatUser[] {
     const model = this._model as LabChatModel;
-    const users: Record<string, IUser> = {};
+    const users: Record<string, LabChatUser> = {};
 
     // Add existing users from the YChat
     // This only includes users who have sent a message in the chat.

package/src/ychat.ts

@@ -197,14 +197,29 @@ export class YChat extends YDocument<IChatChanges> {
     return this._attachments.get(id);
   }
 
+  /**
+   * Adds or modifies an attachment in the chat, and returns the ID of the
+   * attachment.
+   *
+   * NOTE: this method does not add an attachment to any message. It merely adds
+   * the attachment data to the chat file and returns an attachment ID. To add
+   * an attachment to a new message, consumers should call this method & add the
+   * returned ID to `NewMessage.attachments`.
+   */
   setAttachment(attachment: IAttachment): string {
-    // Search if the attachment already exist to update it, otherwise add it.
-    const id =
-      Array.from(this._attachments.entries()).find(
-        ([_, att]) =>
-          att.type === attachment.type && att.value === attachment.value
-      )?.[0] || UUID.uuid4();
+    // Use the existing ID if the attachment already exists, otherwise create a
+    // new ID
+    const attachmentJson = JSON.stringify(attachment);
+    let existingId: string | undefined;
+    for (const [id, att] of this._attachments.entries()) {
+      if (JSON.stringify(att) === attachmentJson) {
+        existingId = id;
+        break;
+      }
+    }
+    const id = existingId || UUID.uuid4();
 
+    // Set the attachment using the computed ID, then return the ID
     this.transact(() => {
       this._attachments.set(id, attachment);
     });