feat: add new GetUser command (#308)

Author: charleschen

src/commands/getUser.ts

@@ -0,0 +1,4 @@
+import {schemaCommandFactory} from '../utils/commandFactory';
+import {Command} from '../generated/schemas';
+
+export const getUser = schemaCommandFactory(Command.GET_USER);

src/commands/index.ts

@@ -23,6 +23,7 @@ import {getChannel} from './getChannel';
 import {getInstanceConnectedParticipants} from './getInstanceConnectedParticipants';
 import {getRelationships} from './getRelationships';
 import {inviteUserEmbedded} from './inviteUserEmbedded';
+import {getUser} from './getUser';
 
 export {Commands, SetActivity};
 
@@ -50,6 +51,7 @@ function commands(sendCommand: TSendCommand) {
     getInstanceConnectedParticipants: getInstanceConnectedParticipants(sendCommand),
     getRelationships: getRelationships(sendCommand),
     inviteUserEmbedded: inviteUserEmbedded(sendCommand),
+    getUser: getUser(sendCommand),
   };
 }
 

src/generated/schema.json

@@ -88,7 +88,8 @@
               "gateway.connect",
               "account.global_name.update",
               "payment_sources.country_code",
-              "sdk.social_layer"
+              "sdk.social_layer",
+              "lobbies.write"
             ]
           }
         },
@@ -355,5 +356,36 @@
       "additionalProperties": false
     },
     "response": null
+  },
+  "GET_USER": {
+    "request": {
+      "type": "object",
+      "properties": {"id": {"type": "string", "maxLength": 64}},
+      "required": ["id"],
+      "additionalProperties": false
+    },
+    "response": {
+      "type": ["object", "null"],
+      "description": "Discord User",
+      "properties": {
+        "id": {"type": "string", "description": "User ID"},
+        "username": {"type": "string"},
+        "global_name": {"type": ["string", "null"], "description": "Global Discord name. Not unique."},
+        "discriminator": {"type": "string", "description": "Global name discriminator. Will be 0 if a unique username"},
+        "avatar": {"type": ["string", "null"], "description": "User Avatar ID"},
+        "flags": {"type": "number", "description": "Public user flags"},
+        "bot": {"type": "boolean", "description": "If a bot user."},
+        "avatar_decoration_data": {
+          "type": ["object", "null"],
+          "description": "Details about avatar decoration",
+          "properties": {"asset": {"type": "string"}, "skuId": {"type": "string"}, "expiresAt": {"type": "number"}},
+          "required": ["asset"],
+          "additionalProperties": false
+        },
+        "premium_type": {"type": ["number", "null"], "description": "Nitro premium type"}
+      },
+      "required": ["id", "username", "discriminator", "flags", "bot"],
+      "additionalProperties": false
+    }
   }
 }

src/generated/schemas.ts

@@ -249,6 +249,27 @@ export const InviteUserEmbeddedRequestSchema = z.object({
 });
 export type InviteUserEmbeddedRequest = zInfer<typeof InviteUserEmbeddedRequestSchema>;
 
+// GET_USER
+export const GetUserRequestSchema = z.object({id: z.string().max(64)});
+export type GetUserRequest = zInfer<typeof GetUserRequestSchema>;
+export const GetUserResponseSchema = z.union([
+  z.object({
+    id: z.string(),
+    username: z.string(),
+    global_name: z.union([z.string(), z.null()]).optional(),
+    discriminator: z.string(),
+    avatar: z.union([z.string(), z.null()]).optional(),
+    flags: z.number(),
+    bot: z.boolean(),
+    avatar_decoration_data: z
+      .union([z.object({asset: z.string(), skuId: z.string().optional(), expiresAt: z.number().optional()}), z.null()])
+      .optional(),
+    premium_type: z.union([z.number(), z.null()]).optional(),
+  }),
+  z.null(),
+]);
+export type GetUserResponse = zInfer<typeof GetUserResponseSchema>;
+
 /**
  * RPC Commands which support schemas.
  */
@@ -261,6 +282,7 @@ export enum Command {
   SHARE_LINK = 'SHARE_LINK',
   GET_RELATIONSHIPS = 'GET_RELATIONSHIPS',
   INVITE_USER_EMBEDDED = 'INVITE_USER_EMBEDDED',
+  GET_USER = 'GET_USER',
 }
 
 const emptyResponseSchema = z.object({}).optional().nullable();
@@ -302,4 +324,8 @@ export const Schemas = {
     request: InviteUserEmbeddedRequestSchema,
     response: emptyResponseSchema,
   },
+  [Command.GET_USER]: {
+    request: GetUserRequestSchema,
+    response: GetUserResponseSchema,
+  },
 } as const;

src/mock.ts

@@ -182,4 +182,14 @@ export const commandsMockDefault: IDiscordSDK['commands'] = {
       ],
     }),
   inviteUserEmbedded: () => Promise.resolve(null),
+  getUser: () => {
+    return Promise.resolve({
+      username: 'mock_friend_username',
+      flags: 0,
+      bot: false,
+      discriminator: 'mock_friend_discriminator',
+      id: 'mock_friend_id_1',
+      avatar: null,
+    });
+  },
 };

src/schema/common.ts

@@ -39,6 +39,7 @@ export enum Commands {
   SHARE_LINK = 'SHARE_LINK',
   GET_RELATIONSHIPS = 'GET_RELATIONSHIPS',
   INVITE_USER_EMBEDDED = 'INVITE_USER_EMBEDDED',
+  GET_USER = 'GET_USER',
 }
 
 export const ReceiveFramePayload = zod

src/schema/responses.ts

@@ -185,6 +185,7 @@ function parseResponseData({cmd, data}: zod.infer<typeof ResponseFrame>) {
     case Commands.SHARE_LINK:
     case Commands.GET_RELATIONSHIPS:
     case Commands.INVITE_USER_EMBEDDED:
+    case Commands.GET_USER:
       const {response} = Schemas[cmd];
       return response.parse(data);
     default: