@jupyter/chat 0.23.2 → 0.24.0

package/lib/__tests__/mocks.d.ts

@@ -4,6 +4,6 @@ export declare class MockChatContext extends AbstractChatContext implements ICha
     get users(): never[];
 }
 export declare class MockChatModel extends AbstractChatModel implements IChatModel {
-    sendMessage(message: INewMessage): Promise<boolean | void> | boolean | void;
+    sendMessage(message: INewMessage): null;
     createChatContext(): IChatContext;
 }

package/lib/__tests__/mocks.js

@@ -11,6 +11,7 @@ export class MockChatContext extends AbstractChatContext {
 export class MockChatModel extends AbstractChatModel {
     sendMessage(message) {
         // No-op
+        return null;
     }
     createChatContext() {
         return new MockChatContext({ model: this });

package/lib/__tests__/model.spec.js

@@ -24,6 +24,7 @@ describe('test chat model', () => {
             }
             sendMessage(message) {
                 // No-op
+                return null;
             }
             createChatContext() {
                 return new MockChatContext({ model: this });

package/lib/model.d.ts

@@ -100,9 +100,9 @@ export interface IChatModel extends IDisposable {
      * Default to no-op.
      *
      * @param message - the message to send.
-     * @returns whether the message has been sent or not, or nothing if not needed.
+     * @returns the message id if sent, or null.
      */
-    sendMessage(message: INewMessage): Promise<boolean | void> | boolean | void;
+    sendMessage(message: INewMessage): Promise<string | null> | string | null;
     /**
      * Clear the message list.
      */
@@ -289,7 +289,7 @@ export declare abstract class AbstractChatModel implements IChatModel {
      * @param message - the message to send.
      * @returns whether the message has been sent or not.
      */
-    abstract sendMessage(message: INewMessage): Promise<boolean | void> | boolean | void;
+    abstract sendMessage(message: INewMessage): Promise<string | null> | string | null;
     /**
      * Clear the message list.
      */

package/package.json

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

package/src/__tests__/mocks.ts

@@ -21,8 +21,9 @@ export class MockChatContext
 }
 
 export class MockChatModel extends AbstractChatModel implements IChatModel {
-  sendMessage(message: INewMessage): Promise<boolean | void> | boolean | void {
+  sendMessage(message: INewMessage): null {
     // No-op
+    return null;
   }
 
   createChatContext(): IChatContext {

package/src/__tests__/model.spec.ts

@@ -33,10 +33,9 @@ describe('test chat model', () => {
         message.body = 'formatted msg';
         return message;
       }
-      sendMessage(
-        message: INewMessage
-      ): Promise<boolean | void> | boolean | void {
+      sendMessage(message: INewMessage): null {
         // No-op
+        return null;
       }
 
       createChatContext(): IChatContext {

package/src/model.ts

@@ -142,9 +142,9 @@ export interface IChatModel extends IDisposable {
    * Default to no-op.
    *
    * @param message - the message to send.
-   * @returns whether the message has been sent or not, or nothing if not needed.
+   * @returns the message id if sent, or null.
    */
-  sendMessage(message: INewMessage): Promise<boolean | void> | boolean | void;
+  sendMessage(message: INewMessage): Promise<string | null> | string | null;
 
   /**
    * Clear the message list.
@@ -548,7 +548,7 @@ export abstract class AbstractChatModel implements IChatModel {
    */
   abstract sendMessage(
     message: INewMessage
-  ): Promise<boolean | void> | boolean | void;
+  ): Promise<string | null> | string | null;
 
   /**
    * Clear the message list.