@elizaos/plugin-matrix-typescript 2.0.0-alpha.1

package/src/index.ts

@@ -0,0 +1,105 @@
+/**
+ * Matrix messaging integration plugin for ElizaOS.
+ *
+ * This plugin provides Matrix protocol integration using matrix-js-sdk.
+ */
+
+import type { Plugin, IAgentRuntime } from "@elizaos/core";
+import { logger } from "@elizaos/core";
+
+// Service
+export { MatrixService } from "./service.js";
+
+// Types
+export * from "./types.js";
+
+// Actions
+import { sendMessage } from "./actions/sendMessage.js";
+import { sendReaction } from "./actions/sendReaction.js";
+import { listRooms } from "./actions/listRooms.js";
+import { joinRoom } from "./actions/joinRoom.js";
+
+export { sendMessage, sendReaction, listRooms, joinRoom };
+
+// Providers
+import { roomStateProvider } from "./providers/roomState.js";
+import { userContextProvider } from "./providers/userContext.js";
+
+export { roomStateProvider, userContextProvider };
+
+// Import service for plugin
+import { MatrixService } from "./service.js";
+
+/**
+ * Matrix plugin definition.
+ */
+const matrixPlugin: Plugin = {
+  name: "matrix",
+  description: "Matrix messaging integration plugin for ElizaOS with E2EE support",
+
+  services: [MatrixService],
+
+  actions: [sendMessage, sendReaction, listRooms, joinRoom],
+
+  providers: [roomStateProvider, userContextProvider],
+
+  tests: [],
+
+  init: async (
+    _config: Record<string, string>,
+    runtime: IAgentRuntime
+  ): Promise<void> => {
+    const homeserver = runtime.getSetting("MATRIX_HOMESERVER");
+    const userId = runtime.getSetting("MATRIX_USER_ID");
+    const accessToken = runtime.getSetting("MATRIX_ACCESS_TOKEN");
+
+    logger.info("=".repeat(60));
+    logger.info("Matrix Plugin Configuration");
+    logger.info("=".repeat(60));
+    logger.info(`  Homeserver: ${homeserver ? `✓ ${homeserver}` : "✗ Missing (required)"}`);
+    logger.info(`  User ID: ${userId ? `✓ ${userId}` : "✗ Missing (required)"}`);
+    logger.info(`  Access Token: ${accessToken ? "✓ Set" : "✗ Missing (required)"}`);
+    logger.info("=".repeat(60));
+
+    // Validate required settings
+    const missing: string[] = [];
+    if (!homeserver) missing.push("MATRIX_HOMESERVER");
+    if (!userId) missing.push("MATRIX_USER_ID");
+    if (!accessToken) missing.push("MATRIX_ACCESS_TOKEN");
+
+    if (missing.length > 0) {
+      logger.warn(
+        `Matrix plugin: Missing required configuration: ${missing.join(", ")}`
+      );
+    }
+
+    // Additional optional settings
+    const deviceId = runtime.getSetting("MATRIX_DEVICE_ID");
+    const rooms = runtime.getSetting("MATRIX_ROOMS");
+    const autoJoin = runtime.getSetting("MATRIX_AUTO_JOIN");
+    const encryption = runtime.getSetting("MATRIX_ENCRYPTION");
+    const requireMention = runtime.getSetting("MATRIX_REQUIRE_MENTION");
+
+    if (deviceId) {
+      logger.info(`  Device ID: ${deviceId}`);
+    }
+
+    if (rooms) {
+      logger.info(`  Auto-join Rooms: ${rooms}`);
+    }
+
+    if (autoJoin === "true") {
+      logger.info("  Auto-join Invites: ✓ Enabled");
+    }
+
+    if (encryption === "true") {
+      logger.info("  End-to-End Encryption: ✓ Enabled");
+    }
+
+    if (requireMention === "true") {
+      logger.info("  Require Mention: ✓ Enabled (will only respond to mentions in rooms)");
+    }
+  },
+};
+
+export default matrixPlugin;

package/src/providers/roomState.ts

@@ -0,0 +1,95 @@
+/**
+ * Room state provider for Matrix plugin.
+ */
+
+import type { Provider, ProviderResult, IAgentRuntime, Memory, State } from "@elizaos/core";
+import { MatrixService } from "../service.js";
+import { MATRIX_SERVICE_NAME, getMatrixLocalpart } from "../types.js";
+
+/**
+ * Provider that gives the agent information about the current Matrix room context.
+ */
+export const roomStateProvider: Provider = {
+  name: "matrixRoomState",
+  description: "Provides information about the current Matrix room context",
+
+  get: async (
+    runtime: IAgentRuntime,
+    message: Memory,
+    state: State
+  ): Promise<ProviderResult> => {
+    // Only provide context for Matrix messages
+    if (message.content.source !== "matrix") {
+      return {
+        data: {},
+        values: {},
+        text: "",
+      };
+    }
+
+    const matrixService = runtime.getService(MATRIX_SERVICE_NAME) as MatrixService | undefined;
+
+    if (!matrixService || !matrixService.isConnected()) {
+      return {
+        data: { connected: false },
+        values: { connected: false },
+        text: "",
+      };
+    }
+
+    const agentName = state?.agentName || "The agent";
+
+    // Get room from state if available
+    const room = state?.data?.room as Record<string, unknown> | undefined;
+    const roomId = room?.roomId as string | undefined;
+    const roomName = room?.name as string | undefined;
+    const isEncrypted = room?.isEncrypted as boolean | undefined;
+    const isDirect = room?.isDirect as boolean | undefined;
+    const memberCount = room?.memberCount as number | undefined;
+
+    const userId = matrixService.getUserId();
+    const displayName = getMatrixLocalpart(userId);
+
+    let responseText = "";
+
+    if (isDirect) {
+      responseText = `${agentName} is in a direct message conversation on Matrix.`;
+    } else {
+      const roomLabel = roomName || roomId || "a Matrix room";
+      responseText = `${agentName} is currently in Matrix room "${roomLabel}".`;
+      
+      if (memberCount) {
+        responseText += ` The room has ${memberCount} members.`;
+      }
+    }
+
+    if (isEncrypted) {
+      responseText += " This room has end-to-end encryption enabled.";
+    }
+
+    responseText += `\n\nMatrix is a decentralized communication protocol. ${agentName} is logged in as ${userId}.`;
+
+    return {
+      data: {
+        roomId,
+        roomName,
+        isEncrypted: isEncrypted || false,
+        isDirect: isDirect || false,
+        memberCount: memberCount || 0,
+        userId,
+        displayName,
+        homeserver: matrixService.getHomeserver(),
+        connected: true,
+      },
+      values: {
+        roomId,
+        roomName,
+        isEncrypted: isEncrypted || false,
+        isDirect: isDirect || false,
+        memberCount: memberCount || 0,
+        userId,
+      },
+      text: responseText,
+    };
+  },
+};

package/src/providers/userContext.ts

@@ -0,0 +1,79 @@
+/**
+ * User context provider for Matrix plugin.
+ */
+
+import type { Provider, ProviderResult, IAgentRuntime, Memory, State } from "@elizaos/core";
+import { MatrixService } from "../service.js";
+import {
+  MATRIX_SERVICE_NAME,
+  getMatrixLocalpart,
+  getMatrixUserDisplayName,
+  type MatrixUserInfo,
+} from "../types.js";
+
+/**
+ * Provider that gives the agent information about the Matrix user context.
+ */
+export const userContextProvider: Provider = {
+  name: "matrixUserContext",
+  description: "Provides information about the Matrix user in the current conversation",
+
+  get: async (
+    runtime: IAgentRuntime,
+    message: Memory,
+    state: State
+  ): Promise<ProviderResult> => {
+    // Only provide context for Matrix messages
+    if (message.content.source !== "matrix") {
+      return {
+        data: {},
+        values: {},
+        text: "",
+      };
+    }
+
+    const matrixService = runtime.getService(MATRIX_SERVICE_NAME) as MatrixService | undefined;
+
+    if (!matrixService || !matrixService.isConnected()) {
+      return {
+        data: {},
+        values: {},
+        text: "",
+      };
+    }
+
+    const agentName = state?.agentName || "The agent";
+
+    // Try to get sender info from message metadata
+    const metadata = message.content.metadata as Record<string, unknown> | undefined;
+    const senderInfo = metadata?.senderInfo as MatrixUserInfo | undefined;
+
+    if (!senderInfo) {
+      return {
+        data: {},
+        values: {},
+        text: "",
+      };
+    }
+
+    const displayName = getMatrixUserDisplayName(senderInfo);
+    const localpart = getMatrixLocalpart(senderInfo.userId);
+
+    const responseText = `${agentName} is talking to ${displayName} (${senderInfo.userId}) on Matrix.`;
+
+    return {
+      data: {
+        userId: senderInfo.userId,
+        displayName,
+        localpart,
+        avatarUrl: senderInfo.avatarUrl,
+      },
+      values: {
+        userId: senderInfo.userId,
+        displayName,
+        localpart,
+      },
+      text: responseText,
+    };
+  },
+};