commit c29e8a707df624aa1162538a2dfe751fb46dee21 · dunkirk.sh/cachet

+105

src/slack.d.ts

···

       1
       +
       /**

     

       2
       +
        * Response from Slack's users.info API endpoint

     

       3
       +
        */

     

       4
       +
       export interface SlackUserInfoResponse {

     

       5
       +
         /** Whether the request was successful */

     

       6
       +
         ok: boolean;

     

       7
       +
         /** The user information if found */

     

       8
       +
         user?: SlackUser;

     

       9
       +
         /** Error message if request failed */

     

       10
       +
         error?: string;

     

       11
       +
       }

     

       12
       +
       

     

       13
       +
       /**

     

       14
       +
        * Response from Slack's emoji.list API endpoint

     

       15
       +
        */

     

       16
       +
       export interface SlackEmojiListResponse {

     

       17
       +
         /** Whether the request was successful */

     

       18
       +
         ok: boolean;

     

       19
       +
         /** Map of emoji names to their image URLs */

     

       20
       +
         emoji?: Record<string, string>;

     

       21
       +
         /** Error message if request failed */

     

       22
       +
         error?: string;

     

       23
       +
       }

     

       24
       +
       

     

       25
       +
       /**

     

       26
       +
        * A Slack user's information

     

       27
       +
        */

     

       28
       +
       export interface SlackUser {

     

       29
       +
         /** Unique identifier for the user */

     

       30
       +
         id: string;

     

       31
       +
         /** ID of the team the user belongs to */

     

       32
       +
         team_id: string;

     

       33
       +
         /** Username */

     

       34
       +
         name: string;

     

       35
       +
         /** Whether the user has been deactivated */

     

       36
       +
         deleted: boolean;

     

       37
       +
         /** User's color preference */

     

       38
       +
         color: string;

     

       39
       +
         /** User's full name */

     

       40
       +
         real_name: string;

     

       41
       +
         /** User's timezone identifier */

     

       42
       +
         tz: string;

     

       43
       +
         /** Display label for the timezone */

     

       44
       +
         tz_label: string;

     

       45
       +
         /** Timezone offset in seconds */

     

       46
       +
         tz_offset: number;

     

       47
       +
         /** Extended profile information */

     

       48
       +
         profile: SlackUserProfile;

     

       49
       +
         /** Whether user is a workspace admin */

     

       50
       +
         is_admin: boolean;

     

       51
       +
         /** Whether user is a workspace owner */

     

       52
       +
         is_owner: boolean;

     

       53
       +
         /** Whether user is the primary workspace owner */

     

       54
       +
         is_primary_owner: boolean;

     

       55
       +
         /** Whether user has restricted access */

     

       56
       +
         is_restricted: boolean;

     

       57
       +
         /** Whether user has ultra restricted access */

     

       58
       +
         is_ultra_restricted: boolean;

     

       59
       +
         /** Whether user is a bot */

     

       60
       +
         is_bot: boolean;

     

       61
       +
         /** Timestamp of last update to user info */

     

       62
       +
         updated: number;

     

       63
       +
         /** Whether user is an app user */

     

       64
       +
         is_app_user: boolean;

     

       65
       +
         /** Whether user has two-factor auth enabled */

     

       66
       +
         has_2fa: boolean;

     

       67
       +
       }

     

       68
       +
       

     

       69
       +
       /**

     

       70
       +
        * Extended profile information for a Slack user

     

       71
       +
        */

     

       72
       +
       export interface SlackUserProfile {

     

       73
       +
         /** Hash of user's profile picture */

     

       74
       +
         avatar_hash: string;

     

       75
       +
         /** User's status text */

     

       76
       +
         status_text: string;

     

       77
       +
         /** Emoji shown in user's status */

     

       78
       +
         status_emoji: string;

     

       79
       +
         /** User's full name */

     

       80
       +
         real_name: string;

     

       81
       +
         /** User's display name */

     

       82
       +
         display_name: string;

     

       83
       +
         /** Normalized version of real name */

     

       84
       +
         real_name_normalized: string;

     

       85
       +
         /** Normalized version of display name */

     

       86
       +
         display_name_normalized: string;

     

       87
       +
         /** User's email address */

     

       88
       +
         email: string;

     

       89
       +
         /** Original size profile image URL */

     

       90
       +
         image_original: string;

     

       91
       +
         /** 24x24 profile image URL */

     

       92
       +
         image_24: string;

     

       93
       +
         /** 32x32 profile image URL */

     

       94
       +
         image_32: string;

     

       95
       +
         /** 48x48 profile image URL */

     

       96
       +
         image_48: string;

     

       97
       +
         /** 72x72 profile image URL */

     

       98
       +
         image_72: string;

     

       99
       +
         /** 192x192 profile image URL */

     

       100
       +
         image_192: string;

     

       101
       +
         /** 512x512 profile image URL */

     

       102
       +
         image_512: string;

     

       103
       +
         /** Team ID the profile belongs to */

     

       104
       +
         team: string;

     

       105
       +
       }

+140

src/slackWrapper.ts

···

       1
       +
       import { createHmac, timingSafeEqual } from "node:crypto";

     

       2
       +
       import type {

     

       3
       +
         SlackEmojiListResponse,

     

       4
       +
         SlackUser,

     

       5
       +
         SlackUserInfoResponse,

     

       6
       +
       } from "./slack";

     

       7
       +
       

     

       8
       +
       /**

     

       9
       +
        * Interface for mapping emoji names to their URLs

     

       10
       +
        */

     

       11
       +
       interface SlackEmoji {

     

       12
       +
         [key: string]: string;

     

       13
       +
       }

     

       14
       +
       

     

       15
       +
       /**

     

       16
       +
        * Configuration options for initializing the SlackWrapper

     

       17
       +
        */

     

       18
       +
       interface SlackConfig {

     

       19
       +
         /** Slack signing secret for request verification */

     

       20
       +
         signingSecret?: string;

     

       21
       +
         /** Slack bot user OAuth token */

     

       22
       +
         botToken?: string;

     

       23
       +
       }

     

       24
       +
       

     

       25
       +
       /**

     

       26
       +
        * Wrapper class for Slack API interactions

     

       27
       +
        */

     

       28
       +
       class SlackWrapper {

     

       29
       +
         private signingSecret: string;

     

       30
       +
         private botToken: string;

     

       31
       +
       

     

       32
       +
         /**

     

       33
       +
          * Creates a new SlackWrapper instance

     

       34
       +
          * @param config Optional configuration object containing signing secret and bot token

     

       35
       +
          * @throws Error if required credentials are missing

     

       36
       +
          */

     

       37
       +
         constructor(config?: SlackConfig) {

     

       38
       +
           this.signingSecret =

     

       39
       +
             config?.signingSecret || process.env.SLACK_SIGNING_SECRET || "";

     

       40
       +
           this.botToken = config?.botToken || process.env.SLACK_BOT_TOKEN || "";

     

       41
       +
       

     

       42
       +
           const missingFields = [];

     

       43
       +
           if (!this.signingSecret) missingFields.push("signing secret");

     

       44
       +
           if (!this.botToken) missingFields.push("bot token");

     

       45
       +
       

     

       46
       +
           if (missingFields.length > 0) {

     

       47
       +
             throw new Error(

     

       48
       +
               `Missing required Slack credentials: ${missingFields.join(" and ")} either pass them to the class or set them as environment variables`,

     

       49
       +
             );

     

       50
       +
           }

     

       51
       +
         }

     

       52
       +
       

     

       53
       +
         /**

     

       54
       +
          * Tests authentication with current credentials

     

       55
       +
          * @returns Promise resolving to true if auth is valid

     

       56
       +
          * @throws Error if authentication fails

     

       57
       +
          */

     

       58
       +
         async testAuth(): Promise<boolean> {

     

       59
       +
           const response = await fetch("https://slack.com/api/auth.test", {

     

       60
       +
             headers: {

     

       61
       +
               Authorization: `Bearer ${this.botToken}`,

     

       62
       +
               "Content-Type": "application/json",

     

       63
       +
             },

     

       64
       +
           });

     

       65
       +
       

     

       66
       +
           const data = await response.json();

     

       67
       +
           if (!data.ok) {

     

       68
       +
             throw new Error(`Authentication failed: ${data.error}`);

     

       69
       +
           }

     

       70
       +
       

     

       71
       +
           return true;

     

       72
       +
         }

     

       73
       +
       

     

       74
       +
         /**

     

       75
       +
          * Retrieves information about a Slack user

     

       76
       +
          * @param userId The ID of the user to look up

     

       77
       +
          * @returns Promise resolving to the user's information

     

       78
       +
          * @throws Error if the API request fails

     

       79
       +
          */

     

       80
       +
         async getUserInfo(userId: string): Promise<SlackUser> {

     

       81
       +
           const response = await fetch(

     

       82
       +
             `https://slack.com/api/users.info?user=${userId}`,

     

       83
       +
             {

     

       84
       +
               method: "POST",

     

       85
       +
               headers: {

     

       86
       +
                 Authorization: `Bearer ${this.botToken}`,

     

       87
       +
                 "Content-Type": "application/json",

     

       88
       +
               },

     

       89
       +
               body: JSON.stringify({ user: userId }),

     

       90
       +
             },

     

       91
       +
           );

     

       92
       +
       

     

       93
       +
           const data: SlackUserInfoResponse = await response.json();

     

       94
       +
           if ((!data.ok && data.error !== "user_not_found") || !data.user) {

     

       95
       +
             throw new Error(data.error);

     

       96
       +
           }

     

       97
       +
       

     

       98
       +
           return data.user;

     

       99
       +
         }

     

       100
       +
       

     

       101
       +
         /**

     

       102
       +
          * Retrieves the list of custom emojis from the Slack workspace

     

       103
       +
          * @returns Promise resolving to the emoji list

     

       104
       +
          * @throws Error if the API request fails

     

       105
       +
          */

     

       106
       +
         async getEmojiList(): Promise<Record<string, string>> {

     

       107
       +
           const response = await fetch("https://slack.com/api/emoji.list", {

     

       108
       +
             headers: {

     

       109
       +
               Authorization: `Bearer ${this.botToken}`,

     

       110
       +
               "Content-Type": "application/json",

     

       111
       +
             },

     

       112
       +
           });

     

       113
       +
       

     

       114
       +
           const data: SlackEmojiListResponse = await response.json();

     

       115
       +
           if (!data.ok || !data.emoji) {

     

       116
       +
             throw new Error(`Failed to get emoji list: ${data.error}`);

     

       117
       +
           }

     

       118
       +
       

     

       119
       +
           return data.emoji;

     

       120
       +
         }

     

       121
       +
       

     

       122
       +
         /**

     

       123
       +
          * Verifies a Slack request signature

     

       124
       +
          * @param signature The signature from the request header

     

       125
       +
          * @param timestamp The timestamp from the request header

     

       126
       +
          * @param body The raw request body

     

       127
       +
          * @returns boolean indicating if the signature is valid

     

       128
       +
          */

     

       129
       +
         verifySignature(signature: string, timestamp: string, body: string): boolean {

     

       130
       +
           const baseString = `v0:${timestamp}:${body}`;

     

       131
       +
           const hmac = createHmac("sha256", this.signingSecret);

     

       132
       +
           const computedSignature = `v0=${hmac.update(baseString).digest("hex")}`;

     

       133
       +
           return timingSafeEqual(

     

       134
       +
             Buffer.from(signature).valueOf() as Uint8Array,

     

       135
       +
             Buffer.from(computedSignature).valueOf() as Uint8Array,

     

       136
       +
           );

     

       137
       +
         }

     

       138
       +
       }

     

       139
       +
       

     

       140
       +
       export { SlackWrapper };