Merge pull request #891 from the-draupnir-project/gnuxie/mps-interface-adaptor

Extract out and depend upon @the-draupnir-project/mps-interface-adaptor

This is just a very simple PR to extract the contents of `src/command/interface-manager` and `src/capabilities/CommonRenderers.tsx` to a library that can be used by other bots that depend on the matrix-protection-suite and interface-manager. Since this is essentially glue code that hasn't made its way into abstractions yet that other bots would need to duplicate to get started.

And we're doing this because we're thinking of making a contributor bot for fun primarily, gathering feedback, and encouraging testing .

Author: Gnuxie

package.json

@@ -53,6 +53,7 @@
     "@sinclair/typebox": "0.34.13",
     "@the-draupnir-project/interface-manager": "4.1.0",
     "@the-draupnir-project/matrix-basic-types": "1.3.0",
+    "@the-draupnir-project/mps-interface-adaptor": "^0.4.1",
     "better-sqlite3": "^9.4.3",
     "body-parser": "^1.20.2",
     "config": "^3.3.9",
@@ -62,8 +63,8 @@
     "jsdom": "^24.0.0",
     "matrix-appservice-bridge": "^10.3.1",
     "matrix-bot-sdk": "npm:@vector-im/matrix-bot-sdk@^0.7.1-element.6",
-    "matrix-protection-suite": "npm:@gnuxie/matrix-protection-suite@3.4.0",
-    "matrix-protection-suite-for-matrix-bot-sdk": "npm:@gnuxie/matrix-protection-suite-for-matrix-bot-sdk@3.1.4",
+    "matrix-protection-suite": "npm:@gnuxie/matrix-protection-suite@3.5.0",
+    "matrix-protection-suite-for-matrix-bot-sdk": "npm:@gnuxie/matrix-protection-suite-for-matrix-bot-sdk@3.5.0",
     "pg": "^8.8.0",
     "yaml": "^2.3.2"
   },

src/Draupnir.ts

@@ -34,19 +34,12 @@ import { ThrottlingQueue } from "./queues/ThrottlingQueue";
 import ManagementRoomOutput from "./managementroom/ManagementRoomOutput";
 import { ReportPoller } from "./report/ReportPoller";
 import { StandardReportManager } from "./report/ReportManager";
-import { MatrixReactionHandler } from "./commands/interface-manager/MatrixReactionHandler";
 import {
   MatrixSendClient,
   SynapseAdminClient,
 } from "matrix-protection-suite-for-matrix-bot-sdk";
 import { IConfig } from "./config";
 import { LogLevel } from "matrix-bot-sdk";
-import {
-  ARGUMENT_PROMPT_LISTENER,
-  DEFAUILT_ARGUMENT_PROMPT_LISTENER,
-  makeListenerForArgumentPrompt as makeListenerForArgumentPrompt,
-  makeListenerForPromptDefault,
-} from "./commands/interface-manager/MatrixPromptForAccept";
 import { RendererMessageCollector } from "./capabilities/RendererMessageCollector";
 import { DraupnirRendererMessageCollector } from "./capabilities/DraupnirRendererMessageCollector";
 import { renderProtectionFailedToStart } from "./protections/ProtectedRoomsSetRenderers";
@@ -60,10 +53,6 @@ import {
   MatrixRoomReference,
   userServerName,
 } from "@the-draupnir-project/matrix-basic-types";
-import {
-  MatrixAdaptorContext,
-  sendMatrixEventsFromDeadDocument,
-} from "./commands/interface-manager/MPSMatrixInterfaceAdaptor";
 import {
   makeDraupnirCommandDispatcher,
   makeDraupnirJSCommandDispatcher,
@@ -77,13 +66,21 @@ import {
   StandardPresentationArgumentStream,
 } from "@the-draupnir-project/interface-manager";
 import { ManagementRoomDetail } from "./managementroom/ManagementRoomDetail";
-import {
-  COMMAND_CONFIRMATION_LISTENER,
-  makeConfirmationPromptListener,
-} from "./commands/interface-manager/MatrixPromptForConfirmation";
 import { SynapseHttpAntispam } from "./webapis/SynapseHTTPAntispam/SynapseHttpAntispam";
 import { DraupnirStores } from "./backingstore/DraupnirStores";
 import { HomeserverUserPurgingDeactivate } from "./protections/HomeserverUserPolicyApplication/HomeserverUserPurgingDeactivate";
+import {
+  ARGUMENT_PROMPT_LISTENER,
+  COMMAND_CONFIRMATION_LISTENER,
+  DEFAUILT_ARGUMENT_PROMPT_LISTENER,
+  makeConfirmationPromptListener,
+  makeListenerForArgumentPrompt,
+  makeListenerForPromptDefault,
+  MatrixAdaptorContext,
+  MatrixReactionHandler,
+  sendMatrixEventsFromDeadDocument,
+} from "@the-draupnir-project/mps-interface-adaptor";
+
 const log = new Logger("Draupnir");
 
 // webAPIS should not be included on the Draupnir class.
@@ -171,7 +168,6 @@ export class Draupnir implements Client, MatrixAdaptorContext {
     );
     this.reactionHandler = new MatrixReactionHandler(
       this.managementRoom.toRoomIDOrAlias(),
-      client,
       clientUserID,
       clientPlatform
     );

src/appservice/bot/AppserviceBotCommandDispatcher.ts

@@ -16,18 +16,18 @@ import {
   StandardJSInterfaceCommandDispatcher,
   StandardMatrixInterfaceCommandDispatcher,
 } from "@the-draupnir-project/interface-manager";
-import {
-  MPSCommandDispatcherCallbacks,
-  MatrixEventContext,
-  invocationInformationFromMatrixEventcontext,
-} from "../../commands/interface-manager/MPSMatrixInterfaceAdaptor";
 import { AppserviceAdaptorContext } from "./AppserviceBotPrerequisite";
 import { AppserviceBotCommands } from "./AppserviceBotCommandTable";
 import { AppserviceBotHelpCommand } from "./AppserviceBotHelp";
 import {
   AppserviceBotInterfaceAdaptor,
   AppserviceAdaptorContextToCommandContextTranslator,
 } from "./AppserviceBotInterfaceAdaptor";
+import {
+  invocationInformationFromMatrixEventcontext,
+  MatrixEventContext,
+  MPSCommandDispatcherCallbacks,
+} from "@the-draupnir-project/mps-interface-adaptor";
 
 function makeAppserviceCommandNormaliser(
   appserviceContext: AppserviceAdaptorContext

src/appservice/bot/AppserviceBotHelp.tsx

@@ -12,10 +12,13 @@ import {
   describeCommand,
 } from "@the-draupnir-project/interface-manager";
 import { ActionResult, Ok } from "matrix-protection-suite";
-import { MatrixAdaptorContext } from "../../commands/interface-manager/MPSMatrixInterfaceAdaptor";
 import { AppserviceBotCommands } from "./AppserviceBotCommandTable";
-import { renderTableHelp } from "../../commands/interface-manager/MatrixHelpRenderer";
 import { AppserviceBotInterfaceAdaptor } from "./AppserviceBotInterfaceAdaptor";
+import {
+  MatrixAdaptorContext,
+  renderTableHelp,
+} from "@the-draupnir-project/mps-interface-adaptor";
+import { DOCUMENTATION_URL } from "../../config";
 
 export const AppserviceBotHelpCommand = describeCommand({
   rest: {
@@ -34,7 +37,9 @@ export const AppserviceBotHelpCommand = describeCommand({
 });
 
 function renderAppserviceBotHelp(): Result<DocumentNode> {
-  return Ok(<root>{renderTableHelp(AppserviceBotCommands)}</root>);
+  return Ok(
+    <root>{renderTableHelp(AppserviceBotCommands, DOCUMENTATION_URL)}</root>
+  );
 }
 
 AppserviceBotInterfaceAdaptor.describeRenderer(AppserviceBotHelpCommand, {

src/appservice/bot/AppserviceBotInterfaceAdaptor.ts

@@ -11,13 +11,13 @@ import {
   StandardAdaptorContextToCommandContextTranslator,
   StandardMatrixInterfaceAdaptor,
 } from "@the-draupnir-project/interface-manager";
+import { AppserviceAdaptorContext } from "./AppserviceBotPrerequisite";
 import {
-  MatrixEventContext,
   invocationInformationFromMatrixEventcontext,
-  MPSMatrixInterfaceAdaptorCallbacks,
+  MatrixEventContext,
   MPSCommandDispatcherCallbacks,
-} from "../../commands/interface-manager/MPSMatrixInterfaceAdaptor";
-import { AppserviceAdaptorContext } from "./AppserviceBotPrerequisite";
+  MPSMatrixInterfaceAdaptorCallbacks,
+} from "@the-draupnir-project/mps-interface-adaptor";
 
 export const AppserviceAdaptorContextToCommandContextTranslator =
   new StandardAdaptorContextToCommandContextTranslator<AppserviceAdaptorContext>();

src/appservice/bot/AppserviceBotPrerequisite.ts

@@ -7,9 +7,11 @@
 // https://github.com/the-draupnir-project/Draupnir
 // </text>
 
-import { MatrixAdaptorContext } from "../../commands/interface-manager/MPSMatrixInterfaceAdaptor";
+import { MatrixAdaptorContext } from "@the-draupnir-project/mps-interface-adaptor";
 import { MjolnirAppService } from "../AppService";
+import { MatrixSendClient } from "matrix-protection-suite-for-matrix-bot-sdk";
 
 export interface AppserviceAdaptorContext extends MatrixAdaptorContext {
   appservice: MjolnirAppService;
+  client: MatrixSendClient;
 }

src/appservice/bot/AppserviceCommandHandler.ts

@@ -28,15 +28,15 @@ import {
   StandardPresentationArgumentStream,
   Presentation,
 } from "@the-draupnir-project/interface-manager";
-import { MatrixEventContext } from "../../commands/interface-manager/MPSMatrixInterfaceAdaptor";
-import { MatrixReactionHandler } from "../../commands/interface-manager/MatrixReactionHandler";
+import "./AppserviceBotCommands";
 import {
   ARGUMENT_PROMPT_LISTENER,
   DEFAUILT_ARGUMENT_PROMPT_LISTENER,
   makeListenerForArgumentPrompt,
   makeListenerForPromptDefault,
-} from "../../commands/interface-manager/MatrixPromptForAccept";
-import "./AppserviceBotCommands";
+  MatrixEventContext,
+  MatrixReactionHandler,
+} from "@the-draupnir-project/mps-interface-adaptor";
 
 export type AppserviceBaseExecutor = (
   this: AppserviceAdaptorContext,
@@ -58,7 +58,6 @@ export class AppserviceCommandHandler {
   ) {
     this.reactionHandler = new MatrixReactionHandler(
       this.appservice.accessControlRoomID,
-      this.appservice.bridge.getBot().getClient(),
       this.appservice.botUserID,
       clientPlatform
     );