fix: add docs for slack arguments

dhis2 · May 23, 2023 · de11f5b · de11f5b
1 parent 5102e8a
commit de11f5b
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 3 deletions.
diff --git a/server/src/services/NotificationService/NotificationMessager.js b/server/src/services/NotificationService/NotificationMessager.js
@@ -14,7 +14,7 @@ class NotificationMessager {
         this.type = type
     }
 
-    sendNotification() {
+    send() {
         throw new Error('Method "sendNotification" must be implemented.')
     }
 }

diff --git a/server/src/services/NotificationService/NotificationService.js b/server/src/services/NotificationService/NotificationService.js
@@ -1,5 +1,5 @@
 const Schmervice = require('@hapipal/schmervice')
-const { SlackWebhookMessager } = require('./SlackWebHookMessager.js')
+const { SlackWebhookMessager } = require('./SlackWebhookMessager.js')
 
 class NotificationService extends Schmervice.Service {
     constructor(server, schmerviceOptions, { messagers }) {

diff --git a/server/src/services/NotificationService/SlackWebHookMessager.js b/server/src/services/NotificationService/SlackWebHookMessager.js
@@ -13,6 +13,28 @@ class SlackWebhookMessager extends NotificationMessager {
         this.webhook = new IncomingWebhook(slackWebhookURL)
     }
 
+    /**
+     * @param slackWebHookSendArguments
+     * see https://github.com/slackapi/node-slack-sdk/blob/3498055d6c86beb82d51ddd583e123461379f5b7/packages/webhook/src/IncomingWebhook.ts#L99
+     * shape of {
+        username?: string;
+        icon_emoji?: string;
+        icon_url?: string;
+        channel?: string;
+        text?: string;
+        link_names?: boolean;
+        agent?: Agent;
+        timeout?: number;
+        attachments?: MessageAttachment[];
+        blocks?: (KnownBlock | Block)[];
+        unfurl_links?: boolean;
+        unfurl_media?: boolean;
+        metadata?: {
+            event_type: string;
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            event_payload: Record<string, any>;
+        }
+     */
     async send(slackWebHookSendArguments) {
         debug(
             'Sending notification',
@@ -53,7 +75,7 @@ class SlackWebhookMessager extends NotificationMessager {
                 type: 'section',
                 text: {
                     type: 'mrkdwn',
-                    text: `*Source Code*:\n <${sourceUrl}>`,
+                    text: `*Source code*:\n <${sourceUrl}>`,
                 },
                 accessory: {
                     type: 'button',