Migrate SelfGrantableRoles to new Plugin structure

backend/src/plugins/SelfGrantableRoles/SelfGrantableRolesPlugin.ts

@@ -0,0 +1,95 @@
+import { PluginOptions } from "knub";
+import { SelfGrantableRolesPluginType, ConfigSchema, defaultSelfGrantableRoleEntry } from "./types";
+import { zeppelinPlugin } from "../ZeppelinPluginBlueprint";
+import { trimPluginDescription } from "src/utils";
+import { RoleAddCmd } from "./commands/RoleAddCmd";
+import { RoleRemoveCmd } from "./commands/RoleRemoveCmd";
+import { RoleHelpCmd } from "./commands/RoleHelpCmd";
+
+const defaultOptions: PluginOptions<SelfGrantableRolesPluginType> = {
+  config: {
+    entries: {},
+    mention_roles: false,
+  },
+};
+
+export const SelfGrantableRolesPlugin = zeppelinPlugin<SelfGrantableRolesPluginType>()("self_grantable_roles", {
+  configSchema: ConfigSchema,
+  defaultOptions,
+
+  info: {
+    prettyName: "Self-grantable roles",
+    description: trimPluginDescription(`
+            Allows users to grant themselves roles via a command
+        `),
+    configurationGuide: trimPluginDescription(`
+      ### Basic configuration
+      In this example, users can add themselves platform roles on the channel 473087035574321152 by using the
+      \`!role\` command. For example, \`!role pc ps4\` to add both the "pc" and "ps4" roles as specified below.
+      
+      ~~~yml
+      self_grantable_roles:
+        config:
+          entries:
+            basic:
+              roles:
+                "543184300250759188": ["pc", "computer"]
+                "534710505915547658": ["ps4", "ps", "playstation"]
+                "473085927053590538": ["xbox", "xb1", "xb"]
+        overrides:
+          - channel: "473087035574321152"
+            config:
+              entries:
+                basic:
+                  roles:
+                    can_use: true
+      ~~~
+      
+      ### Maximum number of roles
+      This is identical to the basic example above, but users can only choose 1 role.
+      
+      ~~~yml
+      self_grantable_roles:
+        config:
+          entries:
+            basic:
+              roles:
+                "543184300250759188": ["pc", "computer"]
+                "534710505915547658": ["ps4", "ps", "playstation"]
+                "473085927053590538": ["xbox", "xb1", "xb"]
+              max_roles: 1
+        overrides:
+          - channel: "473087035574321152"
+            config:
+              entries:
+                basic:
+                  roles:
+                    can_use: true
+      ~~~
+    `),
+  },
+
+  configPreprocessor: options => {
+    const config = options.config;
+    for (const [key, entry] of Object.entries(config.entries)) {
+      // Apply default entry config
+      config.entries[key] = { ...defaultSelfGrantableRoleEntry, ...entry };
+
+      // Normalize alias names
+      if (entry.roles) {
+        for (const [roleId, aliases] of Object.entries(entry.roles)) {
+          entry.roles[roleId] = aliases.map(a => a.toLowerCase());
+        }
+      }
+    }
+
+    return { ...options, config };
+  },
+
+  // prettier-ignore
+  commands: [
+    RoleHelpCmd,
+    RoleRemoveCmd,
+    RoleAddCmd,
+  ]
+});