Sync dev to main (#72)

* feat: mention each command with series support (#69)

* feat: registering commands

* feat: add commands

* feat: add types for command

* feat: adding logic for mention each

* feat: mention each logic to respond with users who have role mentioned in the message

* feat: adding types because i have to :O

* feat: sweet logic which returns me the users who have roles mentioned in the command

* feat: changed the input args for the function

* feat: tested with cases

* feat: tested with cases

* refact: imports and some beauties XD

* created: types file cause had to

* nuked: cause renamed ito

* feat: common who doesnt like smaller util functions?

* refact: imports

* chore: to handle pre hooks

* chore: annoying linter

* chore: annoying linter

* refactor: resolving PR comments

* refactor: sorting imports as well as fix for pr comments

* chore: because lint decided to be pain in my code

* chore: resolving comments for PR

* chore: XD

* Member data validation (#70)

* added controller to get user details

* added endpoint for getting discord member details

* added new test

* changed user-id to discord-id

---------

Co-authored-by: Vaibhav Desai <[email protected]>
Co-authored-by: Ritik Jaiswal <[email protected]>

Author: 3 people

src/constants/commands.ts

@@ -8,3 +8,63 @@ export const VERIFY = {
   description:
     "Generate a link with user specific token to link with RDS backend.",
 };
+
+export const MENTION_EACH = {
+  name: "mention",
+  description: "mention each user with this role",
+  options: [
+    {
+      name: "list",
+      description: "get user in list",
+      type: 2, // 2 is type SUB_COMMAND_GROUP
+      options: [
+        {
+          name: "get",
+          description: "get me the role ",
+          type: 1, // 1 is type SUB_COMMAND
+          options: [
+            {
+              name: "user",
+              description: "The user to get",
+              type: 9, // 6 is type USER
+              required: true,
+            },
+            {
+              name: "message",
+              description: "What message to send to user ?",
+              type: 3, // 7 is type CHANNEL
+              required: true,
+            },
+          ],
+        },
+      ],
+    },
+    {
+      name: "series",
+      description: "get user in series",
+      type: 2,
+      options: [
+        {
+          name: "get",
+          description: "get me the role",
+          type: 1,
+          options: [
+            {
+              name: "user",
+              description: "The user to get",
+              type: 9, // 8 is type ROLE
+              required: true,
+            },
+            {
+              name: "message",
+              description:
+                "The channel permissions to get. If omitted, the guild permissions will be returned",
+              type: 3,
+              required: true,
+            },
+          ],
+        },
+      ],
+    },
+  ],
+};

src/controllers/baseHandler.ts

@@ -1,18 +1,26 @@
-import { HELLO, VERIFY } from "../constants/commands";
-import { env } from "../typeDefinitions/default.types";
-import { discordMessageRequest } from "../typeDefinitions/discordMessage.types";
-import { getCommandName } from "../utils/getCommandName";
-import JSONResponse from "../utils/JsonResponse";
-import { lowerCaseMessageCommands } from "../utils/lowerCaseMessageCommand";
 import { commandNotFound } from "./commandNotFound";
 import { helloCommand } from "./helloCommand";
 import { verifyCommand } from "./verifyCommand";
+import { mentionEachUser } from "./mentionEachUser";
+
+import { getCommandName } from "../utils/getCommandName";
+import JSONResponse from "../utils/JsonResponse";
+import { lowerCaseMessageCommands } from "../utils/lowerCaseMessageCommand";
+
+import { env } from "../typeDefinitions/default.types";
+import {
+  discordMessageRequest,
+  messageRequestDataOptions,
+} from "../typeDefinitions/discordMessage.types";
+
+import { HELLO, MENTION_EACH, VERIFY } from "../constants/commands";
 
 export async function baseHandler(
   message: discordMessageRequest,
   env: env
 ): Promise<JSONResponse> {
   const command = lowerCaseMessageCommands(message);
+
   switch (command) {
     case getCommandName(HELLO): {
       return helloCommand(message.member.user.id);
@@ -26,6 +34,17 @@ export async function baseHandler(
         env
       );
     }
+    case getCommandName(MENTION_EACH): {
+      const data = message.data?.options as Array<messageRequestDataOptions>;
+
+      return await mentionEachUser(
+        {
+          displayType: data[0].name,
+          options: data[0].options[0].options,
+        },
+        env
+      );
+    }
     default: {
       return commandNotFound();
     }

src/controllers/getGuildMemberDetailsHandler.ts

@@ -0,0 +1,26 @@
+import * as response from "../constants/responses";
+import { env } from "../typeDefinitions/default.types";
+import JSONResponse from "../utils/JsonResponse";
+import { IRequest } from "itty-router";
+import { verifyAuthToken } from "../utils/verifyAuthToken";
+import { getGuildMemberDetails } from "../utils/getGuildMemberDetails";
+
+export async function getGuildMemberDetailsHandler(
+  request: IRequest,
+  env: env
+) {
+  const authHeader = request.headers.get("Authorization");
+  if (!authHeader) {
+    return new JSONResponse(response.BAD_SIGNATURE);
+  }
+  try {
+    await verifyAuthToken(authHeader, env);
+
+    const { id: discordId } = request.params;
+
+    const res = await getGuildMemberDetails(discordId, env);
+    return new JSONResponse(res);
+  } catch (err) {
+    return new JSONResponse(response.BAD_SIGNATURE);
+  }
+}

src/controllers/mentionEachUser.ts

@@ -0,0 +1,36 @@
+import { discordTextResponse } from "../utils/discordResponse";
+import { filterUserByRoles } from "../utils/filterUsersByRole";
+import { getMembersInServer } from "../utils/getMembersInServer";
+
+import { env } from "../typeDefinitions/default.types";
+import {
+  UserArray,
+  MentionEachUserOptions,
+} from "../typeDefinitions/filterUsersByRole";
+import { checkDisplayType } from "../utils/checkDisplayType";
+
+export async function mentionEachUser(
+  message: { displayType: string; options: Array<MentionEachUserOptions> },
+  env: env
+) {
+  const getMembersInServerResponse = await getMembersInServer(env);
+
+  // displaytype is list or series  & options is first level of options array on desctructure
+  const { displayType, options } = message;
+  const [roleToBeTaggedObj, displayMessageObj] = options;
+
+  const roleId = roleToBeTaggedObj.value;
+  const msgToBeSent = displayMessageObj.value;
+
+  const usersWithMatchingRole = filterUserByRoles(
+    getMembersInServerResponse as UserArray[],
+    roleId
+  );
+
+  const responseData = checkDisplayType({
+    displayType,
+    msgToBeSent,
+    usersWithMatchingRole,
+  });
+  return discordTextResponse(responseData);
+}

src/index.ts

@@ -12,6 +12,7 @@ import {
 } from "./controllers/guildRoleHandler";
 import { getMembersInServerHandler } from "./controllers/getMembersInServer";
 import { changeNickname } from "./controllers/changeNickname";
+import { getGuildMemberDetailsHandler } from "./controllers/getGuildMemberDetailsHandler";
 
 const router = Router();
 
@@ -29,6 +30,8 @@ router.put("/roles/add", addGroupRoleHandler);
 
 router.get("/discord-members", getMembersInServerHandler);
 
+router.get("/member/:id", getGuildMemberDetailsHandler);
+
 router.post("/", async (request, env) => {
   const message: discordMessageRequest = await request.json();
   if (message.type === InteractionType.PING) {

src/register.ts

@@ -1,4 +1,4 @@
-import { HELLO, VERIFY } from "./constants/commands";
+import { HELLO, MENTION_EACH, VERIFY } from "./constants/commands";
 import { config } from "dotenv";
 import { DISCORD_BASE_URL } from "./constants/urls";
 import { registerCommands } from "./utils/registerCommands";
@@ -17,7 +17,7 @@ async function registerGuildCommands(
   discordApplicationId?: string,
   discordGuildId?: string
 ) {
-  const commands = [HELLO, VERIFY];
+  const commands = [HELLO, VERIFY, MENTION_EACH];
 
   try {
     if (!discordBotToken) throw new Error("Please provide a BOT TOKEN");

src/typeDefinitions/discordMessage.types.d.ts

@@ -14,6 +14,7 @@ export interface messageRequestDataOptions {
   name: string;
   type: number;
   value: string;
+  options: Array<messageRequestDataOptions>;
 }
 
 export interface messageRequestMember {
@@ -52,3 +53,30 @@ export interface guildRoleResponse {
   mentionable: boolean;
   tags?: object;
 }
+
+export interface discordMemberDetails {
+  avatar: string;
+  communication_disabled_until: string;
+  flags: number;
+  joined_at: string;
+  nick: string;
+  pending: boolean;
+  premium_since: string;
+  roles: Array<string>;
+  user: {
+    id: string;
+    username: string;
+    avatar: string;
+    discriminator: string;
+    public_flags: number;
+    flags: number;
+    banner: string;
+    accent_color: string;
+    global_name: string;
+    avatar_decoration: string;
+    display_name: string;
+    banner_color: string;
+  };
+  mute: boolean;
+  deaf: boolean;
+}

src/typeDefinitions/filterUsersByRole.d.ts

@@ -0,0 +1,12 @@
+export type UserArray = {
+  user: {
+    id: string;
+  };
+  roles: string[];
+};
+
+export type MentionEachUserOptions = {
+  name: string;
+  type: number;
+  value: string;
+};

src/typeDefinitions/register.types.d.ts

@@ -1,4 +1,7 @@
 export interface commandTypes {
   name: string;
   description: string;
+  type?: number;
+  required?: boolean;
+  options?: commandTypes[];
 }

src/utils/checkDisplayType.ts

@@ -0,0 +1,19 @@
+export function checkDisplayType({
+  displayType,
+  msgToBeSent,
+  usersWithMatchingRole,
+}: {
+  displayType: string;
+  msgToBeSent: string;
+  usersWithMatchingRole: string[];
+}) {
+  if (displayType === "list") {
+    return `Coming soon. We are working on this feature. We feel sorry for not serving you what you expect this command to do for now.(T_T)`;
+  } else {
+    if (usersWithMatchingRole.length > 0) {
+      return `${displayType && msgToBeSent} ${usersWithMatchingRole}`;
+    } else {
+      return `Sorry no user found under this role.`;
+    }
+  }
+}