feat: Matrix Integration for EmbeddedChat

README.md

@@ -27,6 +27,20 @@ Test credentials:
 
 Installation and usage documentation could be found here [EmbeddedChat installation and usage](https://rocketchat.github.io/EmbeddedChat/docs/docs/Usage/embeddedchat_setup)
 
+### Matrix Support (Experimental)
+
+EmbeddedChat now supports connecting to a Matrix homeserver.
+
+To use Matrix mode, set the `mode` prop to `'matrix'` and provide the `host` and `roomId`.
+
+```jsx
+<EmbeddedChat
+  mode="matrix"
+  host="https://matrix.org"
+  roomId="!roomId:matrix.org"
+/>
+```
+
 ## Development
 
 ### Local Setup

packages/api/package.json

@@ -24,6 +24,7 @@
   },
   "dependencies": {
     "@embeddedchat/auth": "workspace:^",
-    "@rocket.chat/sdk": "^1.0.0-alpha.42"
+    "@rocket.chat/sdk": "^1.0.0-alpha.42",
+    "matrix-js-sdk": "^39.3.0-rc.0"
   }
 }

packages/api/src/EmbeddedChatApi.ts

@@ -6,10 +6,11 @@ import {
   RocketChatAuth,
   ApiError,
 } from "@embeddedchat/auth";
+import { IChatProvider } from "./IChatProvider";
 
 // mutliple typing status can come at the same time they should be processed in order.
 let typingHandlerLock = 0;
-export default class EmbeddedChatApi {
+export default class EmbeddedChatApi implements IChatProvider {
   host: string;
   rid: string;
   rcClient: Rocketchat;

packages/api/src/IChatProvider.ts

@@ -0,0 +1,34 @@
+import { RocketChatAuth } from "@embeddedchat/auth";
+
+export interface IChatProvider {
+  sendTypingStatus(username: string, typing: boolean): Promise<void>;
+
+  addMessageListener(callback: (message: any) => void): void;
+  removeMessageListener(callback: (message: any) => void): void;
+  addMessageDeleteListener(callback: (messageId: string) => void): void;
+  removeMessageDeleteListener(callback: (messageId: string) => void): void;
+  addTypingStatusListener(callback: (users: string[]) => void): void;
+  removeTypingStatusListener(callback: (users: string[]) => void): void;
+  addActionTriggeredListener(callback: (data: any) => void): void;
+  removeActionTriggeredListener(callback: (data: any) => void): void;
+  addUiInteractionListener(callback: (data: any) => void): void;
+  removeUiInteractionListener(callback: (data: any) => void): void;
+
+  login(userOrEmail: string, password: string, code?: string): Promise<any>;
+  logout(): Promise<void>;
+  autoLogin(auth: {
+    flow: "PASSWORD" | "OAUTH" | "TOKEN";
+    credentials: any;
+  }): Promise<void>;
+  googleSSOLogin(signIn: Function, acsCode: string): Promise<any>;
+
+  getRCAppInfo(): Promise<any>;
+  updateUserUsername(userid: string, username: string): Promise<any>;
+  channelInfo(): Promise<any>;
+  getRoomInfo(): Promise<any>;
+  permissionInfo(): Promise<any>;
+
+  setAuth(auth: RocketChatAuth): void;
+  getAuth(): RocketChatAuth;
+  getHost(): string;
+}