chats: interface and failing e2e test to post a new message

Author: angelo-v

chats/rdflib/src/e2e-tests/post-message.e2e.spec.ts

@@ -0,0 +1,21 @@
+import { setupModule } from "../test-support/setupModule";
+
+describe("chats", () => {
+  it("post a new message to a chat", async () => {
+    const chats = setupModule();
+    const chatUri = "http://localhost:3456/chats/QteE42/index.ttl#this";
+    const messageUri = await chats.postMessage({
+      chatUri,
+      text: "Hello, world!",
+      authorWebId: "https://localhost:3456/profile/card#me",
+    });
+    const chat = await chats.readChat(chatUri);
+    expect(chat.latestMessages).toContain(
+      expect.objectContaining({
+        uri: messageUri,
+        authorWebId: "https://localhost:3456/profile/card#me",
+        text: "Hello, world!",
+      }),
+    );
+  });
+});

chats/rdflib/src/e2e-tests/test-data/chats/QteE42/index.ttl

@@ -0,0 +1,3 @@
+<#this>
+    a                                       <http://www.w3.org/ns/pim/meeting#LongChat> ;
+    <http://purl.org/dc/elements/1.1/title> "Post message test" .

chats/rdflib/src/index.ts

@@ -15,6 +15,13 @@ export interface ChatsModule {
    * @param chatUri
    */
   readChat(chatUri: string): Promise<Chat>;
+
+  /**
+   * Post a new message to an existing chat
+   * @param command
+   * @return The URI of the newly created message
+   */
+  postMessage(command: PostMessageCommand): Promise<string>;
 }
 
 /**
@@ -53,8 +60,38 @@ export interface Chat {
  * Represents a message in a chat
  */
 export interface Message {
+  /**
+   * URI identifying the message
+   */
   uri: string;
+  /**
+   * WebID of the message author
+   */
   authorWebId: string;
+  /**
+   * Text of the message
+   */
   text: string;
+  /**
+   * Date and time the message was posted
+   */
   date: Date;
 }
+
+/**
+ * Data needed to post a new message
+ */
+export interface PostMessageCommand {
+  /**
+   * URI of the chat to post to
+   */
+  chatUri: string;
+  /**
+   * Text of the message to post
+   */
+  text: string;
+  /**
+   * WebID of the message author
+   */
+  authorWebId: string;
+}

chats/rdflib/src/module/ChatsModuleRdfLib.ts

@@ -1,4 +1,9 @@
-import { Chat, ChatsModule, CreateChatCommand } from "../index.js";
+import {
+  Chat,
+  ChatsModule,
+  CreateChatCommand,
+  PostMessageCommand,
+} from "../index.js";
 import { Fetcher, IndexedFormula, NamedNode, sym, UpdateManager } from "rdflib";
 
 import {
@@ -94,4 +99,9 @@ export class ChatsModuleRdfLib implements ChatsModule {
     await this.support.fetchNode(anyDocument);
     return anyDocument;
   }
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  postMessage(command: PostMessageCommand): Promise<string> {
+    throw new Error("Method not implemented.");
+  }
 }