@nu-art/slack-shared 0.400.5

package/apis.d.ts

@@ -0,0 +1,42 @@
+import { ApiDefResolver, BodyApi } from '@nu-art/thunderstorm-shared';
+import { PreSendSlackStructuredMessage } from './types.js';
+import { SlackBlock, ThreadPointer } from './base-slack-builder/index.js';
+import { WebAPICallResult } from '@slack/web-api';
+export type Request_PostMessage = {
+    channel: string;
+    message: any;
+};
+export type PostStructuredMessage = {
+    request: {
+        message: PreSendSlackStructuredMessage;
+        thread?: ThreadPointer;
+    };
+    response: {
+        threadPointer?: ThreadPointer;
+    };
+};
+export type PostFiles = {
+    request: {
+        file: any;
+        name: string;
+        thread?: ThreadPointer;
+    };
+    response: WebAPICallResult;
+};
+export type SendUIMessage = {
+    request: {
+        messageBlocks: SlackBlock[];
+        messageReplies: SlackBlock[][];
+        channel?: string;
+    };
+    response: void;
+};
+export type ApiStruct_Slack = {
+    vv1: {
+        postMessage: BodyApi<void, Request_PostMessage>;
+        postStructuredMessage: BodyApi<PostStructuredMessage['response'], PostStructuredMessage['request']>;
+        sendFEMessage: BodyApi<SendUIMessage['response'], SendUIMessage['request']>;
+        postFiles: BodyApi<PostFiles['response'], PostFiles['request']>;
+    };
+};
+export declare const ApiDef_Slack: ApiDefResolver<ApiStruct_Slack>;

package/apis.js

@@ -0,0 +1,9 @@
+import { HttpMethod } from '@nu-art/thunderstorm-shared';
+export const ApiDef_Slack = {
+    vv1: {
+        postMessage: { method: HttpMethod.POST, path: 'v1/slack/post-message' },
+        postStructuredMessage: { method: HttpMethod.POST, path: 'v1/slack/post-structured-message' },
+        sendFEMessage: { method: HttpMethod.POST, path: 'v1/slack/send-fe-message' },
+        postFiles: { method: HttpMethod.POST, path: 'v1/slack/post-files' },
+    }
+};

package/base-slack-builder/BaseSlackBuilder.d.ts

@@ -0,0 +1,75 @@
+import { CustomException, Logger, ServerErrorSeverity } from '@nu-art/ts-common';
+import { SlackBlock, SlackFile, ThreadPointer } from './types.js';
+/**
+ * Base class with logic for composing slack message, will use as base for making FE and BE versions
+ * For better slack error reporting application wide
+ */
+export declare abstract class BaseSlackBuilder extends Logger {
+    protected files: SlackFile[];
+    protected blocks: SlackBlock[];
+    protected replies: SlackBlock[][];
+    protected text: string;
+    protected channel: string;
+    protected constructor(channel?: string, blocks?: SlackBlock[], replies?: SlackBlock[][]);
+    /** Static template function
+     * For error reporting get slack emoji unicode for each severity level
+     * @param severity Severity level from the severity enum
+     */
+    static SeverityEmoji: (severity: ServerErrorSeverity) => ":red_circle:" | ":large_orange_circle:" | ":large_yellow_circle:" | ":large_purple_circle:" | ":large_blue_circle:";
+    /** Static template function
+     * Generate slack message block containing a title and a text body
+     * @param title String to be printed as block title. can include any markdown accepted by slack and emoji uni-codes
+     * @param text String to be printed as block body. can include any markdown accepted by slack and emoji uni-codes
+     */
+    static TextSectionWithTitle: (title: string, text: string) => SlackBlock[];
+    /** Static template function
+     * Return a slack message block that renders a divider (line that separates parts of the message)
+     */
+    static Divider: () => SlackBlock;
+    /** Static template function
+     * Returns a slack message block of a paragraph, accepts all slack markdown and uni-codes
+     * @param text The block text to render
+     */
+    static TextSection: (text: string) => SlackBlock;
+    /** Static template function
+     * Exception notification text, used to resolve header text from TS custom exceptions
+     * @param exception The custom exception to resolve title from
+     */
+    static ExceptionNotificationText: (exception: CustomException) => string;
+    /**
+     * Add files to send in the slack message, accepts both single and multiple files at once
+     * @param files List or a single file to send
+     */
+    addFiles: (files: SlackFile | SlackFile[]) => this;
+    /**
+     * Add new blocks to the slack message to send
+     * @param blocks List or a single block to add to the message
+     */
+    addBlocks: (blocks: SlackBlock | SlackBlock[]) => this;
+    /**
+     * Add reply to the message composed
+     * @param replyBlocks List or single reply to add to the message
+     */
+    addReply: (replyBlocks: SlackBlock | SlackBlock[]) => this;
+    /**
+     * Public send method, will handle the sending process to slack,
+     * First will send the message to the channel
+     * Then will send all files and replys in a thread of the original message
+     */
+    send: () => Promise<void>;
+    /**
+     * Abstract function, implement according to needs in each class.
+     * This function will handle sending of the main message made out of blocks
+     */
+    protected abstract sendMessage: (() => Promise<ThreadPointer | undefined>) | undefined;
+    /**
+     * Abstract function, implement according to needs in each class.
+     * This function will handle sending files to slack in a thread of the original message
+     */
+    protected abstract sendFiles: ((tp: ThreadPointer) => Promise<void>) | undefined;
+    /**
+     * Abstract function, implement according to needs in each class.
+     * This function will handle sending all replys in the thread of the original message
+     */
+    protected abstract sendReplies: ((tp: ThreadPointer) => Promise<void>) | undefined;
+}

package/base-slack-builder/BaseSlackBuilder.js

@@ -0,0 +1,140 @@
+import { asArray, BadImplementationException, Logger, ServerErrorSeverity } from '@nu-art/ts-common';
+import { HttpCodes } from '@nu-art/ts-common/core/exceptions/http-codes';
+/**
+ * Base class with logic for composing slack message, will use as base for making FE and BE versions
+ * For better slack error reporting application wide
+ */
+export class BaseSlackBuilder extends Logger {
+    files = [];
+    blocks = [];
+    replies = [];
+    text = 'Monitor Message'; //default value, need to double-check that;
+    channel;
+    constructor(channel, blocks, replies) {
+        super('BaseSlackBuilder');
+        // if module provided config is not of default slack channel
+        if (!channel) {
+            throw new BadImplementationException('cannot create slack builder instance without channel provided');
+        }
+        this.channel = channel;
+        if (replies)
+            this.replies = replies;
+        if (blocks)
+            this.blocks = blocks;
+    }
+    // ######################## Static Templates ########################
+    /** Static template function
+     * For error reporting get slack emoji unicode for each severity level
+     * @param severity Severity level from the severity enum
+     */
+    static SeverityEmoji = (severity) => {
+        switch (severity) {
+            case ServerErrorSeverity.Critical:
+                return ':red_circle:';
+            case ServerErrorSeverity.Error:
+                return ':large_orange_circle:';
+            case ServerErrorSeverity.Warning:
+                return ':large_yellow_circle:';
+            case ServerErrorSeverity.Info:
+                return ':large_purple_circle:';
+            case ServerErrorSeverity.Debug:
+                return ':large_blue_circle:';
+        }
+    };
+    /** Static template function
+     * Generate slack message block containing a title and a text body
+     * @param title String to be printed as block title. can include any markdown accepted by slack and emoji uni-codes
+     * @param text String to be printed as block body. can include any markdown accepted by slack and emoji uni-codes
+     */
+    static TextSectionWithTitle = (title, text) => {
+        return [
+            {
+                type: 'section',
+                text: {
+                    type: 'mrkdwn',
+                    text: title
+                }
+            },
+            {
+                type: 'divider'
+            },
+            {
+                type: 'section',
+                text: {
+                    type: 'mrkdwn',
+                    text: text
+                }
+            },
+        ];
+    };
+    /** Static template function
+     * Return a slack message block that renders a divider (line that separates parts of the message)
+     */
+    static Divider = () => {
+        return {
+            type: 'divider'
+        };
+    };
+    /** Static template function
+     * Returns a slack message block of a paragraph, accepts all slack markdown and uni-codes
+     * @param text The block text to render
+     */
+    static TextSection = (text) => {
+        return {
+            type: 'section',
+            text: {
+                // @ts-ignore
+                type: 'mrkdwn',
+                text: text,
+            }
+        };
+    };
+    /** Static template function
+     * Exception notification text, used to resolve header text from TS custom exceptions
+     * @param exception The custom exception to resolve title from
+     */
+    static ExceptionNotificationText = (exception) => {
+        return `*${exception.exceptionType}* - ${exception.message}`;
+    };
+    // ######################## Message builder logic ########################
+    /**
+     * Add files to send in the slack message, accepts both single and multiple files at once
+     * @param files List or a single file to send
+     */
+    addFiles = (files) => {
+        asArray(files).forEach(image => this.files.push(image));
+        return this;
+    };
+    /**
+     * Add new blocks to the slack message to send
+     * @param blocks List or a single block to add to the message
+     */
+    addBlocks = (blocks) => {
+        asArray(blocks).forEach(block => this.blocks.push(block));
+        return this;
+    };
+    /**
+     * Add reply to the message composed
+     * @param replyBlocks List or single reply to add to the message
+     */
+    addReply = (replyBlocks) => {
+        const reply = [];
+        asArray(replyBlocks).forEach(block => reply.push(block));
+        this.replies.push(reply);
+        return this;
+    };
+    /**
+     * Public send method, will handle the sending process to slack,
+     * First will send the message to the channel
+     * Then will send all files and replys in a thread of the original message
+     */
+    send = async () => {
+        if (!this.sendMessage)
+            throw new BadImplementationException('cannot send a message without implementing this function');
+        const tp = await this.sendMessage();
+        if (!tp)
+            throw HttpCodes._5XX.INTERNAL_SERVER_ERROR('Error while sending slack message', 'Did not get thread pointer from sending slack message');
+        await this.sendReplies?.(tp);
+        await this.sendFiles?.(tp);
+    };
+}

package/base-slack-builder/index.d.ts

@@ -0,0 +1,2 @@
+export * from './BaseSlackBuilder.js';
+export * from './types.js';

package/base-slack-builder/index.js

@@ -0,0 +1,2 @@
+export * from './BaseSlackBuilder.js';
+export * from './types.js';

package/base-slack-builder/types.d.ts

@@ -0,0 +1,12 @@
+import { Stream } from 'stream';
+import { Block, KnownBlock } from '@slack/web-api';
+export type SlackFile = {
+    file: Buffer | Stream;
+    fileName: string;
+    title?: string;
+};
+export type SlackBlock = Block | KnownBlock;
+export type ThreadPointer = {
+    ts?: string;
+    channel: string;
+};

package/base-slack-builder/types.js

@@ -0,0 +1 @@
+export {};

package/index.d.ts

@@ -0,0 +1,3 @@
+export * from './apis.js';
+export * from './base-slack-builder/index.js';
+export * from './types.js';

package/index.js

@@ -0,0 +1,3 @@
+export * from './apis.js';
+export * from './base-slack-builder/index.js';
+export * from './types.js';

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@nu-art/slack-shared",
+  "version": "0.400.5",
+  "description": "Storm - Express & Typescript based backend framework Shared",
+  "keywords": [
+    "TacB0sS",
+    "infra",
+    "nu-art",
+    "storm",
+    "thunderstorm",
+    "typescript"
+  ],
+  "homepage": "https://github.com/nu-art-js/storm",
+  "bugs": {
+    "url": "https://github.com/nu-art-js/storm/issues"
+  },
+  "publishConfig": {
+    "directory": "dist",
+    "linkDirectory": true
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com:nu-art-js/storm.git"
+  },
+  "license": "Apache-2.0",
+  "author": "TacB0sS",
+  "files": [
+    "**/*"
+  ],
+  "scripts": {
+    "build": "tsc"
+  },
+  "dependencies": {
+    "@nu-art/ts-common": "0.400.5",
+    "@nu-art/thunderstorm-shared": "0.400.5",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "react-router-dom": "^6.9.0",
+    "@slack/web-api": "7.9.3",
+    "@slack/events-api": "^2.3.0",
+    "firebase": "^11.9.0",
+    "firebase-admin": "13.4.0",
+    "firebase-functions": "6.3.2",
+    "google-auth-library": "^10.0.0",
+    "moment": "^2.29.4",
+    "request": "^2.88.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.0.0",
+    "@types/react-dom": "^18.0.0",
+    "@types/react-router": "^5.1.20",
+    "@types/react-router-dom": "^5.3.3"
+  },
+  "unitConfig": {
+    "type": "typescript-lib"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js"
+    },
+    "./*": {
+      "types": "./*.d.ts",
+      "import": "./*.js"
+    }
+  }
+}

package/types.d.ts

@@ -0,0 +1,3 @@
+import { PartialProperties } from '@nu-art/ts-common';
+import { ChatPostMessageArguments } from '@slack/web-api';
+export type PreSendSlackStructuredMessage = PartialProperties<ChatPostMessageArguments, 'channel' | 'text'>;

package/types.js

@@ -0,0 +1 @@
+export {};