updated interactive payloads for org apps

slackapi · Nov 25, 2020 · 9e89cee · 9e89cee
1 parent 8b803f5
commit 9e89cee
Show file tree

Hide file tree

Showing 8 changed files with 103 additions and 22 deletions.
diff --git a/src/App.ts b/src/App.ts
@@ -86,7 +86,7 @@ export interface Authorize {
 
 /** Authorization function inputs - authenticated data about an event for the authorization function */
 export interface AuthorizeSourceData {
-  teamId: string;
+  teamId: string | undefined;
   enterpriseId?: string;
   userId?: string;
   conversationId?: string;
@@ -631,10 +631,10 @@ export default class App {
     let { client } = this;
     const token = selectToken(context);
     if (token !== undefined) {
-      let pool = this.clients[source.teamId];
+      let pool = this.clients[source.teamId!];
       if (pool === undefined) {
         // eslint-disable-next-line no-multi-assign
-        pool = this.clients[source.teamId] = new WebClientPool();
+        pool = this.clients[source.teamId!] = new WebClientPool();
       }
       client = pool.getOrCreate(token, this.clientOptions);
     }
@@ -717,30 +717,54 @@ function buildSource(
     teamId:
       type === IncomingEventType.Event || type === IncomingEventType.Command
         ? ((body as (SlackEventMiddlewareArgs | SlackCommandMiddlewareArgs)['body']).team_id as string)
-        : type === IncomingEventType.Action ||
-          type === IncomingEventType.Options ||
-          type === IncomingEventType.ViewAction ||
-          type === IncomingEventType.Shortcut
+        : (type === IncomingEventType.Action ||
+            type === IncomingEventType.Options ||
+            type === IncomingEventType.ViewAction ||
+            type === IncomingEventType.Shortcut) &&
+          body.team !== null
+        ? ((body as (
+            | SlackActionMiddlewareArgs
+            | SlackOptionsMiddlewareArgs
+            | SlackViewMiddlewareArgs
+            | SlackShortcutMiddlewareArgs
+          )['body']).team!.id as string)
+        : (type === IncomingEventType.Action ||
+            type === IncomingEventType.Options ||
+            type === IncomingEventType.ViewAction ||
+            type === IncomingEventType.Shortcut) &&
+          body.user !== undefined
         ? ((body as (
             | SlackActionMiddlewareArgs
             | SlackOptionsMiddlewareArgs
             | SlackViewMiddlewareArgs
             | SlackShortcutMiddlewareArgs
-          )['body']).team.id as string)
-        : assertNever(type),
+          )['body']).user.team_id as string)
+        : undefined,
     enterpriseId:
       type === IncomingEventType.Event || type === IncomingEventType.Command
         ? ((body as (SlackEventMiddlewareArgs | SlackCommandMiddlewareArgs)['body']).enterprise_id as string)
-        : type === IncomingEventType.Action ||
-          type === IncomingEventType.Options ||
-          type === IncomingEventType.ViewAction ||
-          type === IncomingEventType.Shortcut
+        : (type === IncomingEventType.Action ||
+            type === IncomingEventType.Options ||
+            type === IncomingEventType.ViewAction ||
+            type === IncomingEventType.Shortcut) &&
+          body.team !== null
+        ? ((body as (
+            | SlackActionMiddlewareArgs
+            | SlackOptionsMiddlewareArgs
+            | SlackViewMiddlewareArgs
+            | SlackShortcutMiddlewareArgs
+          )['body']).team!.enterprise_id as string)
+        : (type === IncomingEventType.Action ||
+            type === IncomingEventType.Options ||
+            type === IncomingEventType.ViewAction ||
+            type === IncomingEventType.Shortcut) &&
+          body.enterprise !== undefined
         ? ((body as (
             | SlackActionMiddlewareArgs
             | SlackOptionsMiddlewareArgs
             | SlackViewMiddlewareArgs
             | SlackShortcutMiddlewareArgs
-          )['body']).team.enterprise_id as string)
+          )['body']).enterprise!.id as string)
         : undefined,
     userId:
       type === IncomingEventType.Event

diff --git a/src/types/actions/block-action.ts b/src/types/actions/block-action.ts
@@ -209,7 +209,7 @@ export interface BlockAction<ElementAction extends BasicElementAction = BlockEle
     domain: string;
     enterprise_id?: string; // undocumented
     enterprise_name?: string; // undocumented
-  };
+  } | null;
   user: {
     id: string;
     name: string;
@@ -237,6 +237,14 @@ export interface BlockAction<ElementAction extends BasicElementAction = BlockEle
 
   // this appears in the block_suggestions schema, but we're not sure when its present or what its type would be
   app_unfurl?: any;
+
+  // exists for enterprise installs
+  is_enterprise_install?: boolean;
+  enterprise?: {
+    id: string;
+    name: string;
+  };
+
 }
 
 /*

diff --git a/src/types/actions/dialog-action.ts b/src/types/actions/dialog-action.ts
@@ -13,7 +13,7 @@ export interface DialogSubmitAction {
     domain: string;
     enterprise_id?: string; // undocumented
     enterprise_name?: string; // undocumented
-  };
+  } | null;
   user: {
     id: string;
     name: string;
@@ -26,6 +26,13 @@ export interface DialogSubmitAction {
   action_ts: string;
   token: string;
   response_url: string;
+
+  // exists for enterprise installs
+  is_enterprise_install?: boolean;
+  enterprise?: {
+    id: string;
+    name: string;
+  };
 }
 
 /**

diff --git a/src/types/actions/interactive-message.ts b/src/types/actions/interactive-message.ts
@@ -38,7 +38,7 @@ export interface InteractiveMessage<Action extends InteractiveAction = Interacti
     domain: string;
     enterprise_id?: string; // undocumented
     enterprise_name?: string; // undocumented
-  };
+  } | null;
   user: {
     id: string;
     name: string;
@@ -59,6 +59,13 @@ export interface InteractiveMessage<Action extends InteractiveAction = Interacti
   message_ts?: string;
   // NOTE: the original_message is not available from ephemeral messages
   original_message?: { [key: string]: string };
+
+  // exists for enterprise installs
+  is_enterprise_install?: boolean;
+  enterprise?: {
+    id: string;
+    name: string;
+  };
 }
 
 /*

diff --git a/src/types/options/index.ts b/src/types/options/index.ts
@@ -26,7 +26,7 @@ export interface OptionsRequest<Source extends OptionsSource = OptionsSource> ex
     domain: string;
     enterprise_id?: string; // undocumented
     enterprise_name?: string; // undocumented
-  };
+  } | null;
   channel?: {
     id: string;
     name: string;
@@ -52,6 +52,13 @@ export interface OptionsRequest<Source extends OptionsSource = OptionsSource> ex
 
   // this appears in the block_suggestions schema, but we're not sure when its present or what its type would be
   app_unfurl?: any;
+
+  // exists for enterprise installs
+  is_enterprise_install?: boolean;
+  enterprise?: {
+    id: string;
+    name: string;
+  };
 }
 
 /**

diff --git a/src/types/shortcuts/global-shortcut.ts b/src/types/shortcuts/global-shortcut.ts
@@ -12,12 +12,20 @@ export interface GlobalShortcut {
     username: string;
     team_id: string;
   };
+  // team is null for org apps shortcut payload
   team: {
     id: string;
     domain: string;
     enterprise_id?: string;
     enterprise_name?: string;
-  };
+  } | null;
   token: string;
   action_ts: string;
+
+  // exists for enterprise installs
+  is_enterprise_install?: boolean;
+  enterprise?: {
+    id: string;
+    name: string;
+  };
 }
diff --git a/src/types/shortcuts/message-shortcut.ts b/src/types/shortcuts/message-shortcut.ts
@@ -21,6 +21,7 @@ export interface MessageShortcut {
     id: string;
     name: string;
     team_id?: string; // undocumented
+    username?: string; // shows up on org app msg actions
   };
   channel: {
     id: string;
@@ -31,7 +32,14 @@ export interface MessageShortcut {
     domain: string;
     enterprise_id?: string; // undocumented
     enterprise_name?: string; // undocumented
-  };
+  } | null;
   token: string;
   action_ts: string; // undocumented
+
+  // exists for enterprise installs
+  is_enterprise_install?: boolean;
+  enterprise?: {
+    id: string;
+    name: string;
+  };
 }
diff --git a/src/types/view/index.ts b/src/types/view/index.ts
@@ -39,7 +39,7 @@ export interface ViewSubmitAction {
     domain: string;
     enterprise_id?: string; // undocumented
     enterprise_name?: string; // undocumented
-  };
+  } | null;
   user: {
     id: string;
     name: string;
@@ -48,6 +48,12 @@ export interface ViewSubmitAction {
   view: ViewOutput;
   api_app_id: string;
   token: string;
+  // exists for enterprise installs
+  is_enterprise_install?: boolean;
+  enterprise?: {
+    id: string;
+    name: string;
+  };
 }
 
 /**
@@ -62,7 +68,7 @@ export interface ViewClosedAction {
     domain: string;
     enterprise_id?: string; // undocumented
     enterprise_name?: string; // undocumented
-  };
+  } | null;
   user: {
     id: string;
     name: string;
@@ -72,6 +78,12 @@ export interface ViewClosedAction {
   api_app_id: string;
   token: string;
   is_cleared: boolean;
+  // exists for enterprise installs
+  is_enterprise_install?: boolean;
+  enterprise?: {
+    id: string;
+    name: string;
+  };
 }
 
 /**