Improve bot-related property types in context object

seratch · Mar 16, 2024 · 2ee62f0 · 2ee62f0
1 parent 2785568
commit 2ee62f0
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/src/context/context.ts b/src/context/context.ts
@@ -14,8 +14,8 @@ export interface PreAuthorizeSlackAppContext {
   actorEnterpriseId?: string;
   actorTeamId?: string;
   actorUserId?: string;
-  botId?: string;
-  botUserId?: string;
+  botId?: string; // this will always exist when initializing SlackAppContext
+  botUserId?: string; // this will always exist when initializing SlackAppContext
   responseUrl?: string;
   channelId?: string;
   triggerId?: string;
@@ -32,6 +32,8 @@ export type Respond = (params: WebhookParams) => Promise<Response>;
 export type SlackAppContext = {
   client: SlackAPIClient;
   botToken: string;
+  botId: string; // this must exist here
+  botUserId: string; // this must exist here
   userToken?: string;
   authorizeResult: AuthorizeResult;
 } & PreAuthorizeSlackAppContext;

diff --git a/src_deno/context/context.ts b/src_deno/context/context.ts
@@ -14,8 +14,8 @@ export interface PreAuthorizeSlackAppContext {
   actorEnterpriseId?: string;
   actorTeamId?: string;
   actorUserId?: string;
-  botId?: string;
-  botUserId?: string;
+  botId?: string; // this will always exist when initializing SlackAppContext
+  botUserId?: string; // this will always exist when initializing SlackAppContext
   responseUrl?: string;
   channelId?: string;
   triggerId?: string;
@@ -32,6 +32,8 @@ export type Respond = (params: WebhookParams) => Promise<Response>;
 export type SlackAppContext = {
   client: SlackAPIClient;
   botToken: string;
+  botId: string; // this must exist here
+  botUserId: string; // this must exist here
   userToken?: string;
   authorizeResult: AuthorizeResult;
 } & PreAuthorizeSlackAppContext;

diff --git a/test/app.test.ts b/test/app.test.ts
@@ -62,8 +62,11 @@ describe("SlackApp", () => {
     // Events API
     const appMentionEvent: EventLazyHandler<"app_mention"> = async ({
       payload,
+      context,
     }) => {
       const type: "app_mention" = payload.type;
+      const botUserId: string = context.botUserId;
+      const botId: string = context.botId;
     };
     app.event("app_mention", appMentionEvent);