Expose the display roles module to plugins

CHANGELOG.md

@@ -43,6 +43,8 @@ Please report any bugs you encounter by [creating a GitHub issue](https://github
 * System messages now have a formatter
 * The `beforeNewThread` hook's parameters now also include the original DM message object
 * Plugins can now access the `threads` module (via `pluginApi.threads`) to create and fetch threads
+* Plugins can now access the `displayRoles` module (via `pluginApi.displayRoles`) to get, set, and reset display role overrides for moderators,
+  and to get the final role that will be displayed in moderator replies (by default or per-thread)
 
 **Internal/technical updates:**
 * Modmail now uses [Express](https://expressjs.com/) as its web server for logs/attachments

src/data/Thread.js

@@ -9,7 +9,7 @@ const attachments = require("./attachments");
 const { formatters } = require("../formatters");
 const { callAfterThreadCloseHooks } = require("../hooks/afterThreadClose");
 const snippets = require("./snippets");
-const { getModeratorThreadDisplayRoleName } = require("./moderatorRoleOverrides");
+const { getModeratorThreadDisplayRoleName } = require("./displayRoles");
 
 const ThreadMessage = require("./ThreadMessage");
 

src/modules/roles.js

@@ -8,7 +8,7 @@ const {
 
   getModeratorThreadDisplayRoleName,
   getModeratorDefaultDisplayRoleName,
-} = require("../data/moderatorRoleOverrides");
+} = require("../data/displayRoles");
 
 const ROLE_OVERRIDES_METADATA_KEY = "moderatorRoleOverrides";
 

src/pluginApi.js

@@ -3,6 +3,7 @@ const { CommandManager } = require("knub-command-manager");
 const { Client } = require("eris");
 const Knex = require("knex");
 const threads = require("./data/threads");
+const displayRoles = require("./data/displayRoles");
 
 /**
  * @typedef {object} PluginAPI
@@ -16,6 +17,7 @@ const threads = require("./data/threads");
  * @property {FormattersExport} formats
  * @property {express.Application} webserver
  * @property {threads} threads
+ * @property {displayRoles} displayRoles
  */
 
 /**

src/plugins.js

@@ -8,6 +8,7 @@ const childProcess = require("child_process");
 const pacote = require("pacote");
 const path = require("path");
 const threads = require("./data/threads");
+const displayRoles = require("./data/displayRoles");
 
 const pluginSources = {
   npm: {
@@ -130,6 +131,7 @@ module.exports = {
       formats,
       webserver,
       threads,
+      displayRoles,
     };
   },
 };