feat: add survey command

Author: virtual-designer

src/main/typescript/commands/automation/SurveyCommand.ts

@@ -0,0 +1,68 @@
+import { ActionRowBuilder, ButtonBuilder, HeadingLevel } from "@discordjs/builders";
+import { TakesArgument } from "@framework/arguments/ArgumentTypes";
+import { ErrorType } from "@framework/arguments/InvalidArgumentError";
+import StringArgument from "@framework/arguments/StringArgument";
+import type { Buildable } from "@framework/commands/Command";
+import { Command } from "@framework/commands/Command";
+import type Context from "@framework/commands/Context";
+import { ButtonStyle, heading } from "discord.js";
+
+type SurveyCommandArgs = {
+    name: string;
+};
+
+@TakesArgument<SurveyCommandArgs>({
+    names: ["name"],
+    types: [StringArgument],
+    optional: false,
+    errorMessages: [
+        {
+            [ErrorType.Required]: "Please provide a survey name to send!"
+        }
+    ]
+})
+class SurveyCommand extends Command {
+    public override readonly name = "survey";
+    public override readonly description: string = "Shows a survey form to fill out.";
+    public override readonly defer = true;
+    public override readonly usage = ["<name: String>"];
+
+    public override build(): Buildable[] {
+        return [
+            this.buildChatInput().addStringOption(option =>
+                option
+                    .setName("name")
+                    .setDescription("The name of the survey to send.")
+                    .setRequired(true)
+            )
+        ];
+    }
+
+    public override async execute(context: Context, args: SurveyCommandArgs): Promise<void> {
+        const { name } = args;
+
+        const survey = context.config?.survey_system?.surveys[name];
+
+        if (!survey) {
+            await context.error("This survey does not exist.");
+            return;
+        }
+
+        await context.reply({
+            ephemeral: true,
+            content: `${heading(survey.name, HeadingLevel.Two)}\n\n${
+                survey.description ?? "Please fill out the form by clicking the button below."
+            }`,
+            components: [
+                new ActionRowBuilder<ButtonBuilder>().addComponents(
+                    new ButtonBuilder()
+                        .setCustomId("survey_" + name)
+                        .setLabel("Fill out survey")
+                        .setStyle(ButtonStyle.Secondary)
+                )
+            ]
+        });
+    }
+}
+
+export default SurveyCommand;

src/main/typescript/types/GuildConfigSchema.ts

@@ -18,6 +18,7 @@
  */
 
 import { LoggingSchema } from "@main/types/LoggingSchema";
+import { SurveySystemConfig } from "@main/types/SurveySystemConfig";
 import { z } from "zod";
 import { MessageRuleSchema } from "./MessageRuleSchema";
 import { ModerationAction } from "./ModerationAction";
@@ -166,7 +167,8 @@ export const GuildConfigSchema = z.object({
                 })
                 .optional()
         })
-        .optional()
+        .optional(),
+    survey_system: SurveySystemConfig.optional()
     /*
     quickmute: z
         .object({

src/main/typescript/types/SurveySystemConfig.ts

@@ -0,0 +1,38 @@
+import { zSnowflake } from "@main/types/SnowflakeSchema";
+import { z } from "zod";
+
+const SurveyQuestion = z.object({
+    type: z.enum(["paragraph", "short"]),
+    question: z.string(),
+    required: z.boolean().default(true),
+    maxLength: z.number().int().optional(),
+    minLength: z.number().int().optional(),
+    placeholder: z.string().optional(),
+    default_value: z.string().optional()
+});
+
+export const SurveySystemConfig = z.object({
+    enabled: z.boolean().default(false),
+    default_log_channel: zSnowflake.optional(),
+    surveys: z
+        .record(
+            z.string().regex(/^[a-z0-9_-]+$/i),
+            z.object({
+                name: z.string(),
+                questions: z.array(SurveyQuestion).nonempty(),
+                required_channels: z.array(zSnowflake).default([]),
+                required_roles: z.array(zSnowflake).default([]),
+                required_permissions: z.array(z.string()).default([]),
+                required_users: z.array(zSnowflake).default([]),
+                description: z.string().optional(),
+                end_message: z.string().optional(),
+                log_channel: zSnowflake.optional()
+            })
+        )
+        .describe(
+            `
+    A record of surveys. The key is the interaction custom ID of the survey, and the value is the survey itself.
+    `
+        )
+        .default({})
+});