update payload object, entity.presentDetails inputs, test, event

Author: vegeris

packages/types/src/events/entity-details-requested.ts

@@ -1,10 +1,17 @@
 export interface EntityDetailsRequestedEvent {
   type: 'entity_details_requested';
   user: string;
-  external_ref: {
+  trigger_id: string;
+  link: {
+    url: string;
+    domain: string;
+  };
+  user_locale: string;
+  event_ts: string;
+  external_ref?: {
     id: string;
     type?: string;
   };
-  trigger_id: string;
-  event_ts: string;
+  message_ts?: string;
+  channel?: string;
 }

packages/types/src/message-metadata.ts

@@ -27,6 +27,10 @@ export interface MessageMetadataEventPayloadObject {
   [key: string]: string | number | boolean;
 }
 
+export interface MessageMetadataEventPayloadAttributes {
+  [key: string]: string | number | boolean | MessageMetadataEventPayloadAttributes;
+}
+
 /**
  * @description Metadata that represents an entity.
  */
@@ -38,7 +42,19 @@ export interface EntityMetadata {
   /**
    * @description Schema for the given entity type.
    */
-  entity_payload: object;
+  entity_payload: {
+    // biome-ignore lint/complexity/noBannedTypes: Allow Object
+    attributes: Object;
+    // biome-ignore lint/complexity/noBannedTypes: Allow Object
+    fields?: Object;
+    // biome-ignore lint/complexity/noBannedTypes: Allow Object
+    custom_fields?: Object[];
+    // biome-ignore lint/complexity/noBannedTypes: Allow Object
+    slack_file?: Object;
+    display_order?: string[];
+    // biome-ignore lint/complexity/noBannedTypes: Allow Object
+    actions?: Object;
+  };
   /**
    * @description Reference (and optional type) used to identify an entity within the developer's system.
    */

packages/web-api/src/types/request/entity.ts

@@ -4,7 +4,7 @@ import type { TokenOverridable } from './common';
 // https://api.slack.com/methods/entity.presentDetails
 export type EntityPresentDetailsArguments = TokenOverridable & {
   /**
-   * @description Eentity metadata that will be presented in the flexpane.
+   * @description Entity metadata to be presented in the flexpane.
    * */
   metadata?: EntityMetadata;
   /**
@@ -24,9 +24,14 @@ export type EntityPresentDetailsArguments = TokenOverridable & {
   /** @description Error response preventing flexpane data from being returned. */
   error?: {
     // Error status indicating why the entity could not be presented.
-    // Accepted values: ["restricted", "internal_error", "not_found", "user_not_authed", "custom"]
     status: string;
-    // If status is 'custom', you can use this field to provide a specific message.
+    // If status is 'custom', you can use this field to provide a message to the client.
     custom_message?: string;
+    // String format, eg. 'markdown'.
+    message_format?: string;
+    // If status is 'custom', you can use this field to provide a title to the client.
+    custom_title?: string;
+    // Set of action buttons to be shown in case of a specific error.
+    actions?: Object[];
   };
 };

packages/web-api/test/types/methods/chat.test-d.ts

@@ -421,7 +421,11 @@ expectAssignable<Parameters<typeof web.chat.postMessage>>([
       entities: [
         {
           entity_type: 'slack#/entities/file',
-          entity_payload: {},
+          entity_payload: {
+            attributes: {}
+          },
+          external_ref: {id: ""},
+          url: ""
         },
       ],
     },
@@ -643,7 +647,11 @@ expectAssignable<Parameters<typeof web.chat.unfurl>>([
       entities: [
         {
           entity_type: 'slack#/entities/file',
-          entity_payload: {},
+          entity_payload: {
+            attributes: {}
+          },
+          external_ref: {id: ""},
+          url: "",
           app_unfurl_url: 'https://google.com',
         },
       ],