Make Draupnir refer to it self in help output. (#358)

Title is the full description of this issue. This PR fixes #357
the-draupnir-project · Apr 19, 2024 · 9239c23 · 9239c23
1 parent 49c5ada
commit 9239c23
Show file tree

Hide file tree

Showing 18 changed files with 50 additions and 50 deletions.
diff --git a/src/Draupnir.ts b/src/Draupnir.ts
@@ -60,7 +60,7 @@ export class Draupnir implements Client {
      */
     public unlistedUserRedactionQueue = new UnlistedUserRedactionQueue();
 
-    private readonly commandTable = findCommandTable("mjolnir");
+    private readonly commandTable = findCommandTable("draupnir");
     public taskQueue: ThrottlingQueue;
     /**
      * Reporting back to the management room.

diff --git a/src/commands/Ban.tsx b/src/commands/Ban.tsx
@@ -86,7 +86,7 @@ async function ban(
 
 defineInterfaceCommand({
     designator: ["ban"],
-    table: "mjolnir",
+    table: "draupnir",
     parameters: parameters([
         {
             name: "entity",
@@ -126,6 +126,6 @@ defineInterfaceCommand({
 })
 
 defineMatrixInterfaceAdaptor({
-    interfaceCommand: findTableCommand("mjolnir", "ban"),
+    interfaceCommand: findTableCommand("draupnir", "ban"),
     renderer: tickCrossRenderer
 })
diff --git a/src/commands/CommandHandler.ts b/src/commands/CommandHandler.ts
@@ -48,7 +48,7 @@ import "./DeactivateCommand";
 import "./HijackRoomCommand";
 import "./ShutdownRoomCommand";
 
-defineCommandTable("mjolnir").importTable(findCommandTable("synapse admin"));
+defineCommandTable("draupnir").importTable(findCommandTable("synapse admin"));
 import "./Ban";
 import "./CreateBanListCommand";
 import "./Help";
@@ -79,7 +79,7 @@ export async function handleCommand(
         const readItems = readCommand(normalisedCommand)
         const stream = new ArgumentStream(readItems);
         const command = commandTable.findAMatchingCommand(stream)
-            ?? findTableCommand("mjolnir", "help");
+            ?? findTableCommand("draupnir", "help");
         const adaptor = findMatrixInterfaceAdaptor(command);
         const draupnirContext: DraupnirContext = {
             ...draupnir.commandContext,

diff --git a/src/commands/CreateBanListCommand.ts b/src/commands/CreateBanListCommand.ts
@@ -63,7 +63,7 @@ export async function createList(
 
 defineInterfaceCommand({
     designator: ["list", "create"],
-    table: "mjolnir",
+    table: "draupnir",
     parameters: parameters([
         {
             name: "shortcode",
@@ -79,7 +79,7 @@ defineInterfaceCommand({
 })
 
 defineMatrixInterfaceAdaptor({
-    interfaceCommand: findTableCommand("mjolnir", "list", "create"),
+    interfaceCommand: findTableCommand("draupnir", "list", "create"),
     renderer: tickCrossRenderer
 })
 

diff --git a/src/commands/Help.tsx b/src/commands/Help.tsx
@@ -53,16 +53,16 @@ function renderMjolnirHelp(mjolnirTable: CommandTable): DocumentNode {
 
 defineInterfaceCommand({
     parameters: parameters([], new RestDescription('command parts', findPresentationType("any"))),
-    table: "mjolnir",
+    table: "draupnir",
     command: async function() {
-        return Ok(findCommandTable("mjolnir"))
+        return Ok(findCommandTable("draupnir"))
     },
     designator: ["help"],
     summary: "Display this message"
 })
 
 defineMatrixInterfaceAdaptor({
-    interfaceCommand: findTableCommand("mjolnir", "help"),
+    interfaceCommand: findTableCommand("draupnir", "help"),
     renderer: async function(client, commandRoomId, event, result: ActionResult<CommandTable>) {
         if (isError(result)) {
             throw new TypeError("This command isn't supposed to fail");

diff --git a/src/commands/ImportCommand.ts b/src/commands/ImportCommand.ts
@@ -85,7 +85,7 @@ export async function importCommand(
 
 defineInterfaceCommand<DraupnirBaseExecutor>({
     designator: ["import"],
-    table: "mjolnir",
+    table: "draupnir",
     parameters: parameters([
         {
             name: "import from room",
@@ -101,6 +101,6 @@ defineInterfaceCommand<DraupnirBaseExecutor>({
 })
 
 defineMatrixInterfaceAdaptor({
-    interfaceCommand: findTableCommand("mjolnir", "import"),
+    interfaceCommand: findTableCommand("draupnir", "import"),
     renderer: tickCrossRenderer
 })
diff --git a/src/commands/KickCommand.tsx b/src/commands/KickCommand.tsx
@@ -103,7 +103,7 @@ export async function kickCommand(
 
 defineInterfaceCommand({
     designator: ["kick"],
-    table: "mjolnir",
+    table: "draupnir",
     parameters: parameters([
         {
             name: "user",
@@ -137,7 +137,7 @@ defineInterfaceCommand({
 })
 
 defineMatrixInterfaceAdaptor({
-    interfaceCommand: findTableCommand("mjolnir", "kick"),
+    interfaceCommand: findTableCommand("draupnir", "kick"),
     renderer: async function (this, client, commandRoomdID, event, result: ActionResult<UsersToKick>) {
         tickCrossRenderer.call(this, client, commandRoomdID, event, result);
         if (isError(result)) {

diff --git a/src/commands/PermissionCheckCommand.ts b/src/commands/PermissionCheckCommand.ts
@@ -34,7 +34,7 @@ import { tickCrossRenderer } from "./interface-manager/MatrixHelpRenderer";
 
 defineInterfaceCommand({
     designator: ["verify"],
-    table: "mjolnir",
+    table: "draupnir",
     parameters: parameters([]),
     command: async function (this: DraupnirContext, _keywords: ParsedKeywords): Promise<ActionResult<unknown>> {
         const enabledProtection = this.draupnir.protectedRoomsSet.protections.allProtections;
@@ -53,6 +53,6 @@ defineInterfaceCommand({
 })
 
 defineMatrixInterfaceAdaptor({
-    interfaceCommand: findTableCommand("mjolnir", "verify"),
+    interfaceCommand: findTableCommand("draupnir", "verify"),
     renderer: tickCrossRenderer
 })
diff --git a/src/commands/ProtectionsCommands.tsx b/src/commands/ProtectionsCommands.tsx
@@ -39,7 +39,7 @@ import { renderMatrixAndSend } from "./interface-manager/DeadDocumentMatrix";
 
 defineInterfaceCommand({
     designator: ["protections", "enable"],
-    table: "mjolnir",
+    table: "draupnir",
     parameters: parameters([
         {
             name: 'protection name',
@@ -75,13 +75,13 @@ defineInterfaceCommand({
 })
 
 defineMatrixInterfaceAdaptor({
-    interfaceCommand: findTableCommand("mjolnir", "protections", "enable"),
+    interfaceCommand: findTableCommand("draupnir", "protections", "enable"),
     renderer: tickCrossRenderer
 });
 
 defineInterfaceCommand({
     designator: ["protections", "disable"],
-    table: "mjolnir",
+    table: "draupnir",
     parameters: parameters([
         {
             name: 'protection name',
@@ -104,7 +104,7 @@ defineInterfaceCommand({
 })
 
 defineMatrixInterfaceAdaptor({
-    interfaceCommand: findTableCommand("mjolnir", "protections", "disable"),
+    interfaceCommand: findTableCommand("draupnir", "protections", "disable"),
     renderer: tickCrossRenderer
 });
 
@@ -127,7 +127,7 @@ interface SettingChangeSummary<Key extends string = string, TSettings extends Un
 
 defineInterfaceCommand({
     designator: ["protections", "config", "set"],
-    table: "mjolnir",
+    table: "draupnir",
     parameters: parameters([...CommonProtectionSettingParameters, {
         name: 'new value',
         acceptor: findPresentationType('any'),
@@ -156,7 +156,7 @@ defineInterfaceCommand({
 
 defineInterfaceCommand({
     designator: ["protections", "config", "add"],
-    table: "mjolnir",
+    table: "draupnir",
     parameters: parameters([
         {
             name: 'item',
@@ -192,7 +192,7 @@ defineInterfaceCommand({
 
 defineInterfaceCommand({
     designator: ["protections", "config", "remove"],
-    table: "mjolnir",
+    table: "draupnir",
     parameters: parameters([
         {
             name: 'item',
@@ -251,7 +251,7 @@ async function settingChangeSummaryRenderer(this: unknown, client: MatrixSendCli
 
 for (const designator of ["add", "set", "remove"]) {
     defineMatrixInterfaceAdaptor({
-        interfaceCommand: findTableCommand("mjolnir", "protections", "config", designator),
+        interfaceCommand: findTableCommand("draupnir", "protections", "config", designator),
         renderer: settingChangeSummaryRenderer,
     })
 }
@@ -331,7 +331,7 @@ interface ProtectionsSummary {
 
 defineInterfaceCommand({
     designator: ["protections"],
-    table: "mjolnir",
+    table: "draupnir",
     parameters: parameters([]),
     command: async function (this: DraupnirContext, keywords: ParsedKeywords, protectionName: string): Promise<ActionResult<ProtectionsSummary[]>> {
         const enabledProtections = this.draupnir.protectedRoomsSet.protections.allProtections;
@@ -357,7 +357,7 @@ defineInterfaceCommand({
 })
 
 defineMatrixInterfaceAdaptor({
-    interfaceCommand: findTableCommand("mjolnir", "protections"),
+    interfaceCommand: findTableCommand("draupnir", "protections"),
     renderer: async function(client, commandRoomID, event, result: ActionResult<ProtectionsSummary[]>) {
         await tickCrossRenderer.call(this, client, commandRoomID, event, result);
         if (isError(result)) {

diff --git a/src/commands/RedactCommand.ts b/src/commands/RedactCommand.ts
@@ -79,7 +79,7 @@ export async function redactCommand(
 
 defineInterfaceCommand({
     designator: ["redact"],
-    table: "mjolnir",
+    table: "draupnir",
     parameters: parameters([
         {
             name: "entity",
@@ -117,6 +117,6 @@ defineInterfaceCommand({
 });
 
 defineMatrixInterfaceAdaptor({
-    interfaceCommand: findTableCommand("mjolnir", "redact"),
+    interfaceCommand: findTableCommand("draupnir", "redact"),
     renderer: tickCrossRenderer
 })
diff --git a/src/commands/ResolveAlias.tsx b/src/commands/ResolveAlias.tsx
@@ -44,7 +44,7 @@ async function resolveAliasCommand(
 }
 
 defineInterfaceCommand({
-    table: "mjolnir",
+    table: "draupnir",
     designator: ["resolve"],
     parameters: parameters([{
         name: "alias",
@@ -55,7 +55,7 @@ defineInterfaceCommand({
 })
 
 defineMatrixInterfaceAdaptor({
-    interfaceCommand: findTableCommand("mjolnir", "resolve"),
+    interfaceCommand: findTableCommand("draupnir", "resolve"),
     renderer: async function(this, client, commandRoomID, event, result: ActionResult<MatrixRoomID>) {
         if (isError(result)) {
             await tickCrossRenderer.call(this, client, commandRoomID, event, result);

diff --git a/src/commands/Rooms.tsx b/src/commands/Rooms.tsx
@@ -37,7 +37,7 @@ import { ActionException, ActionExceptionKind, ActionResult, MatrixRoomID, Matri
 import { resolveRoomReferenceSafe } from "matrix-protection-suite-for-matrix-bot-sdk";
 
 defineInterfaceCommand({
-    table: "mjolnir",
+    table: "draupnir",
     designator: ["rooms"],
     summary: "List all of the protected rooms.",
     parameters: parameters([]),
@@ -58,7 +58,7 @@ function renderProtectedRooms(rooms: MatrixRoomID[]): DocumentNode {
 }
 
 defineMatrixInterfaceAdaptor({
-    interfaceCommand: findTableCommand("mjolnir", "rooms"),
+    interfaceCommand: findTableCommand("draupnir", "rooms"),
     renderer: async function (client, commandRoomId, event, result: ActionResult<MatrixRoomID[]>) {
         tickCrossRenderer.call(this, ...arguments);
         if (isError(result)) {
@@ -72,7 +72,7 @@ defineMatrixInterfaceAdaptor({
 })
 
 defineInterfaceCommand({
-    table: "mjolnir",
+    table: "draupnir",
     designator: ["rooms", "add"],
     summary: "Protect the room using the watched policy lists, banning users and synchronizing server ACL.",
     parameters: parameters([
@@ -96,7 +96,7 @@ defineInterfaceCommand({
 })
 
 defineInterfaceCommand({
-    table: "mjolnir",
+    table: "draupnir",
     designator: ["rooms", "remove"],
     summary: "Stop protecting the room and leave.",
     parameters: parameters([
@@ -132,7 +132,7 @@ defineInterfaceCommand({
 
 for (const designator of [["rooms", "add"], ["rooms", "remove"]]) {
     defineMatrixInterfaceAdaptor({
-        interfaceCommand: findTableCommand("mjolnir", ...designator),
+        interfaceCommand: findTableCommand("draupnir", ...designator),
         renderer: tickCrossRenderer,
     })
 }
diff --git a/src/commands/Rules.tsx b/src/commands/Rules.tsx
@@ -83,7 +83,7 @@ export interface ListMatches {
 
 defineInterfaceCommand({
     designator: ["rules"],
-    table: "mjolnir",
+    table: "draupnir",
     parameters: parameters([]),
     command: async function (this: DraupnirContext): Promise<ActionResult<ListMatches[]>> {
         const infoResult = await listInfo(this.draupnir);
@@ -102,13 +102,13 @@ defineInterfaceCommand({
 })
 
 defineMatrixInterfaceAdaptor({
-    interfaceCommand: findTableCommand("mjolnir", "rules"),
+    interfaceCommand: findTableCommand("draupnir", "rules"),
     renderer: renderListMatches
 })
 
 defineInterfaceCommand({
     designator: ["rules", "matching"],
-    table: "mjolnir",
+    table: "draupnir",
     parameters: parameters([
         {
             name: "entity",
@@ -140,6 +140,6 @@ defineInterfaceCommand({
 
 // I'm pretty sure that both commands could merge and use the same rendeer.
 defineMatrixInterfaceAdaptor({
-    interfaceCommand: findTableCommand("mjolnir", "rules", "matching"),
+    interfaceCommand: findTableCommand("draupnir", "rules", "matching"),
     renderer: renderListMatches
 })
diff --git a/src/commands/SetDisplayNameCommand.ts b/src/commands/SetDisplayNameCommand.ts
@@ -7,7 +7,7 @@ import { ActionError, ActionResult, Ok } from "matrix-protection-suite";
 
 
 defineInterfaceCommand({
-    table: "mjolnir",
+    table: "draupnir",
     designator: ["displayname"],
     summary: "Sets the displayname of the draupnir instance to the specified value in all rooms.",
     parameters: parameters(
@@ -34,6 +34,6 @@ export async function execSetDisplayNameCommand(this: DraupnirContext, _keywords
 }
 
 defineMatrixInterfaceAdaptor({
-    interfaceCommand: findTableCommand("mjolnir", "displayname"),
+    interfaceCommand: findTableCommand("draupnir", "displayname"),
     renderer: tickCrossRenderer
 })
diff --git a/src/commands/SetPowerLevelCommand.ts b/src/commands/SetPowerLevelCommand.ts
@@ -56,7 +56,7 @@ async function setPowerLevelCommand(
 }
 
 defineInterfaceCommand({
-    table: "mjolnir",
+    table: "draupnir",
     designator: ["powerlevel"],
     parameters: parameters([
         {

diff --git a/src/commands/StatusCommand.tsx b/src/commands/StatusCommand.tsx
@@ -39,7 +39,7 @@ import { DocumentNode } from "./interface-manager/DeadDocument";
 
 defineInterfaceCommand({
     designator: ["status"],
-    table: "mjolnir",
+    table: "draupnir",
     parameters: parameters([]),
     command: async function (this: DraupnirContext): Promise<ActionResult<StatusInfo>> {
         return Ok(await draupnirStatusInfo(this.draupnir))
@@ -121,7 +121,7 @@ export function renderStatusInfo(info: StatusInfo): DocumentNode {
 }
 
 defineMatrixInterfaceAdaptor({
-    interfaceCommand: findTableCommand("mjolnir", "status"),
+    interfaceCommand: findTableCommand("draupnir", "status"),
     renderer: async function (this, client, commandRoomID, event, result: ActionResult<StatusInfo>): Promise<void> {
         if (isError(result)) {
             await tickCrossRenderer.call(this, client, commandRoomID, event, result);

diff --git a/src/commands/Unban.ts b/src/commands/Unban.ts
@@ -110,7 +110,7 @@ async function unban(
 
 defineInterfaceCommand({
     designator: ["unban"],
-    table: "mjolnir",
+    table: "draupnir",
     parameters: parameters([
         {
             name: "entity",
@@ -150,6 +150,6 @@ defineInterfaceCommand({
 })
 
 defineMatrixInterfaceAdaptor({
-    interfaceCommand: findTableCommand("mjolnir", "unban"),
+    interfaceCommand: findTableCommand("draupnir", "unban"),
     renderer: tickCrossRenderer
 })