@fabasoad/sarif-to-slack 0.1.0 → 0.1.1

package/.pre-commit-config.yaml

@@ -29,7 +29,7 @@ repos:
         stages: ["pre-push"]
   # Security
       - id: audit
-        name: NPM audit
+        name: npm audit
         entry: make audit
         language: system
         pass_filenames: false

package/api-extractor.json

@@ -45,7 +45,7 @@
    *
    * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
    */
-  "mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
+  "mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts",
 
   /**
    * A list of NPM package names whose exports should be treated as part of this package.

package/dist/Logger.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Logger.d.ts.map

package/dist/Logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logger.d.ts","sourceRoot":"","sources":["../src/Logger.ts"],"names":[],"mappings":""}

package/dist/Logger.js

@@ -0,0 +1,23 @@
+import { Logger as TSLogger } from 'tslog';
+import { LogLevel } from './types';
+/**
+ * Logger class for managing logging operations.
+ * @internal
+ */
+export default class Logger {
+    static instance = new TSLogger();
+    static initialize({ logLevel = LogLevel.Info }) {
+        if (!Logger.instance) {
+            Logger.instance = new TSLogger({
+                minLevel: process.env.ACTIONS_STEP_DEBUG === 'true' ? 0 : logLevel,
+            });
+        }
+    }
+    static info(...args) {
+        Logger.instance.info(args);
+    }
+    static debug(...args) {
+        Logger.instance.debug(args);
+    }
+}
+//# sourceMappingURL=Logger.js.map

package/dist/Logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logger.js","sourceRoot":"","sources":["../src/Logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,QAAQ,EAAW,MAAM,OAAO,CAAA;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAUlC;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACjB,MAAM,CAAC,QAAQ,GAAsB,IAAI,QAAQ,EAAE,CAAC;IAErD,MAAM,CAAC,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAiB;QAClE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACrB,MAAM,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC;gBAC7B,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ;aACnE,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,IAAI,CAAC,GAAG,IAAc;QAClC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC5B,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,GAAG,IAAc;QACnC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAC7B,CAAC"}

package/dist/Processors.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Processors.d.ts.map

package/dist/Processors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Processors.d.ts","sourceRoot":"","sources":["../src/Processors.ts"],"names":[],"mappings":""}

package/dist/Processors.js

@@ -0,0 +1,91 @@
+import * as fs from 'fs';
+import * as path from 'path';
+import Logger from './Logger';
+/**
+ * Processes a color string and converts it to a specific hex code if it matches
+ * a CI status identifier.
+ * @param color - The color string to process, which can be a CI status identifier
+ * or a custom color.
+ * @returns The processed color as a hex string or undefined if the input is not
+ * a recognized CI status identifier.
+ * @internal
+ */
+export function processColor(color) {
+    switch (color) {
+        case 'success':
+            Logger.info(`Converting "${color}" to #008000`);
+            return '#008000';
+        case 'failure':
+            Logger.info(`Converting "${color}" to #ff0000`);
+            return '#ff0000';
+        case 'cancelled':
+            Logger.info(`Converting "${color}" to #0047ab`);
+            return '#0047ab';
+        case 'skipped':
+            Logger.info(`Converting "${color}" to #808080`);
+            return '#808080';
+        default:
+            Logger.debug(`"${color}" color is not a CI status identifier. Returning as is...`);
+            return color;
+    }
+}
+/**
+ * Processes a log level string or number and converts it to a numeric log level.
+ * @param logLevel
+ * @returns The numeric log level corresponding to the input string or number.
+ * @throws Error If the input string does not match any known log level.
+ * @internal
+ */
+export function processLogLevel(logLevel) {
+    if (typeof logLevel === 'string') {
+        switch (logLevel.toLowerCase()) {
+            case 'silly':
+                return 0;
+            case 'trace':
+                return 1;
+            case 'debug':
+                return 2;
+            case 'info':
+                return 3;
+            case 'warning':
+                return 4;
+            case 'error':
+                return 5;
+            case 'fatal':
+                return 6;
+            default:
+                throw new Error(`Unknown log level: ${logLevel}`);
+        }
+    }
+    return logLevel;
+}
+/**
+ * Processes the SARIF path, which can be a file or a directory. If it's a
+ * directory, it returns an array of paths to all `.sarif` files, otherwise it
+ * returns an array with a single path to the file.
+ * @param sarifPath - The path to the SARIF file or directory.
+ * @returns An array of strings representing the paths to the SARIF files.
+ * @throws Error If the path does not exist, or if it is neither a file nor a
+ * directory.
+ * @internal
+ */
+export function processSarifPath(sarifPath) {
+    if (!fs.existsSync(sarifPath)) {
+        throw new Error(`"sarif-path" does not exist: ${sarifPath}`);
+    }
+    const sarifStats = fs.statSync(sarifPath);
+    if (sarifStats.isDirectory()) {
+        Logger.info(`"sarif-path" is a directory: ${sarifPath}`);
+        const files = fs.readdirSync(sarifPath);
+        const filteredFiles = files.filter((file) => path.extname(file).toLowerCase() === '.sarif');
+        Logger.info(`Found ${filteredFiles.length} SARIF files in ${sarifPath} directory`);
+        Logger.debug(`Filtered SARIF files: ${filteredFiles.join(', ')}`);
+        return filteredFiles.map((file) => path.join(sarifPath, file));
+    }
+    if (sarifStats.isFile()) {
+        Logger.info(`"sarif-path" is a file: ${sarifPath}`);
+        return [sarifPath];
+    }
+    throw new Error(`"sarif-path" is neither a file nor a directory: ${sarifPath}`);
+}
+//# sourceMappingURL=Processors.js.map

package/dist/Processors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Processors.js","sourceRoot":"","sources":["../src/Processors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAA;AACxB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AAC5B,OAAO,MAAM,MAAM,UAAU,CAAA;AAG7B;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,SAAS;YACZ,MAAM,CAAC,IAAI,CAAC,eAAe,KAAK,cAAc,CAAC,CAAA;YAC/C,OAAO,SAAS,CAAA;QAClB,KAAK,SAAS;YACZ,MAAM,CAAC,IAAI,CAAC,eAAe,KAAK,cAAc,CAAC,CAAA;YAC/C,OAAO,SAAS,CAAA;QAClB,KAAK,WAAW;YACd,MAAM,CAAC,IAAI,CAAC,eAAe,KAAK,cAAc,CAAC,CAAA;YAC/C,OAAO,SAAS,CAAA;QAClB,KAAK,SAAS;YACZ,MAAM,CAAC,IAAI,CAAC,eAAe,KAAK,cAAc,CAAC,CAAA;YAC/C,OAAO,SAAS,CAAA;QAClB;YACE,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,2DAA2D,CAAC,CAAA;YAClF,OAAO,KAAK,CAAA;IAChB,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAC,QAA4B;IAC1D,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,QAAQ,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC;YAC/B,KAAK,OAAO;gBACV,OAAO,CAAC,CAAA;YACV,KAAK,OAAO;gBACV,OAAO,CAAC,CAAA;YACV,KAAK,OAAO;gBACV,OAAO,CAAC,CAAA;YACV,KAAK,MAAM;gBACT,OAAO,CAAC,CAAA;YACV,KAAK,SAAS;gBACZ,OAAO,CAAC,CAAA;YACV,KAAK,OAAO;gBACV,OAAO,CAAC,CAAA;YACV,KAAK,OAAO;gBACV,OAAO,CAAC,CAAA;YACV;gBACE,MAAM,IAAI,KAAK,CAAC,sBAAsB,QAAQ,EAAE,CAAC,CAAA;QACrD,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,gBAAgB,CAAC,SAAiB;IAChD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,gCAAgC,SAAS,EAAE,CAAC,CAAA;IAC9D,CAAC;IAED,MAAM,UAAU,GAAa,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;IAEnD,IAAI,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC;QAC7B,MAAM,CAAC,IAAI,CAAC,gCAAgC,SAAS,EAAE,CAAC,CAAA;QACxD,MAAM,KAAK,GAAa,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,CAAA;QACjD,MAAM,aAAa,GAAa,KAAK,CAAC,MAAM,CAAC,CAAC,IAAY,EAAE,EAAE,CAC5D,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,KAAK,QAAQ,CAC9C,CAAA;QACD,MAAM,CAAC,IAAI,CAAC,SAAS,aAAa,CAAC,MAAM,mBAAmB,SAAS,YAAY,CAAC,CAAA;QAClF,MAAM,CAAC,KAAK,CAAC,yBAAyB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACjE,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAA;IACxE,CAAC;IAED,IAAI,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;QACxB,MAAM,CAAC,IAAI,CAAC,2BAA2B,SAAS,EAAE,CAAC,CAAA;QACnD,OAAO,CAAC,SAAS,CAAC,CAAA;IACpB,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,mDAAmD,SAAS,EAAE,CAAC,CAAA;AACjF,CAAC"}

package/dist/SarifToSlackService.d.ts

@@ -0,0 +1,39 @@
+import { SarifToSlackServiceOptions, SlackMessage } from './types';
+/**
+ * Service to convert SARIF files to Slack messages and send them.
+ * @public
+ */
+export declare class SarifToSlackService {
+    private readonly _slackMessages;
+    private constructor();
+    /**
+     * Gets the Slack messages prepared for each SARIF file.
+     * @returns A read-only map where keys are SARIF file paths and values are SlackMessage instances.
+     * @public
+     */
+    get slackMessages(): ReadonlyMap<string, SlackMessage>;
+    /**
+     * Creates an instance of SarifToSlackService.
+     * @param opts - Options for the service, including webhook URL, SARIF path, and other configurations.
+     * @returns A promise that resolves to an instance of SarifToSlackService.
+     * @throws Error if no SARIF files are found at the provided path.
+     * @public
+     */
+    static create(opts: SarifToSlackServiceOptions): Promise<SarifToSlackService>;
+    /**
+     * Sends all prepared Slack messages.
+     * @returns A promise that resolves when all messages have been sent.
+     * @throws Error if a Slack message was not prepared for a SARIF path.
+     * @public
+     */
+    sendAll(): Promise<void>;
+    /**
+     * Sends a Slack message for a specific SARIF path.
+     * @param sarifPath - The path of the SARIF file for which the message should be sent.
+     * @returns A promise that resolves when the message has been sent.
+     * @throws Error if a Slack message was not prepared for the given SARIF path.
+     * @public
+     */
+    send(sarifPath: string): Promise<void>;
+}
+//# sourceMappingURL=SarifToSlackService.d.ts.map

package/dist/SarifToSlackService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SarifToSlackService.d.ts","sourceRoot":"","sources":["../src/SarifToSlackService.ts"],"names":[],"mappings":"AAIA,OAAO,EAEL,0BAA0B,EAC1B,YAAY,EACb,MAAM,SAAS,CAAA;AAmChB;;;GAGG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA4B;IAE3D,OAAO;IAIP;;;;OAIG;IACH,IAAW,aAAa,IAAI,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,CAE5D;IAED;;;;;;OAMG;WACiB,MAAM,CAAC,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAU1F;;;;;OAKG;IACU,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAMrC;;;;;;OAMG;IACU,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAQpD"}

package/dist/SarifToSlackService.js

@@ -0,0 +1,95 @@
+import { promises as fs } from 'fs';
+import Logger from './Logger';
+import { processColor, processLogLevel, processSarifPath } from './Processors';
+import { SlackMessageBuilder } from './SlackMessageBuilder';
+async function initialize(opts) {
+    const slackMessages = new Map();
+    const sarifFiles = processSarifPath(opts.sarifPath);
+    if (sarifFiles.length === 0) {
+        throw new Error(`No SARIF files found at the provided path: ${opts.sarifPath}`);
+    }
+    for (const sarifFile of sarifFiles) {
+        const jsonString = await fs.readFile(sarifFile, 'utf8');
+        const messageBuilder = new SlackMessageBuilder(opts.webhookUrl, {
+            username: opts.username,
+            iconUrl: opts.iconUrl,
+            color: processColor(opts.color),
+            sarif: JSON.parse(jsonString)
+        });
+        if (opts.header?.include) {
+            messageBuilder.withHeader(opts.header?.value);
+        }
+        if (opts.footer?.include) {
+            messageBuilder.withFooter(opts.footer?.value);
+        }
+        if (opts.actor?.include) {
+            messageBuilder.withActor(opts.actor?.value);
+        }
+        if (opts.run?.include) {
+            messageBuilder.withRun();
+        }
+        slackMessages.set(sarifFile, messageBuilder);
+    }
+    return slackMessages;
+}
+/**
+ * Service to convert SARIF files to Slack messages and send them.
+ * @public
+ */
+export class SarifToSlackService {
+    _slackMessages;
+    constructor() {
+        this._slackMessages = new Map();
+    }
+    /**
+     * Gets the Slack messages prepared for each SARIF file.
+     * @returns A read-only map where keys are SARIF file paths and values are SlackMessage instances.
+     * @public
+     */
+    get slackMessages() {
+        return this._slackMessages;
+    }
+    /**
+     * Creates an instance of SarifToSlackService.
+     * @param opts - Options for the service, including webhook URL, SARIF path, and other configurations.
+     * @returns A promise that resolves to an instance of SarifToSlackService.
+     * @throws Error if no SARIF files are found at the provided path.
+     * @public
+     */
+    static async create(opts) {
+        Logger.initialize({
+            logLevel: processLogLevel(opts.logLevel)
+        });
+        const instance = new SarifToSlackService();
+        const map = await initialize(opts);
+        map.forEach((val, key) => instance._slackMessages.set(key, val));
+        return instance;
+    }
+    /**
+     * Sends all prepared Slack messages.
+     * @returns A promise that resolves when all messages have been sent.
+     * @throws Error if a Slack message was not prepared for a SARIF path.
+     * @public
+     */
+    async sendAll() {
+        for (const sarifPath of this._slackMessages.keys()) {
+            await this.send(sarifPath);
+        }
+    }
+    /**
+     * Sends a Slack message for a specific SARIF path.
+     * @param sarifPath - The path of the SARIF file for which the message should be sent.
+     * @returns A promise that resolves when the message has been sent.
+     * @throws Error if a Slack message was not prepared for the given SARIF path.
+     * @public
+     */
+    async send(sarifPath) {
+        const message = this._slackMessages.get(sarifPath);
+        if (!message) {
+            throw new Error(`Slack message was not prepared for SARIF path: ${sarifPath}.`);
+        }
+        const text = await message.send();
+        Logger.info(`Message sent for ${sarifPath} file. Status:`, text);
+    }
+}
+//# sourceMappingURL=SarifToSlackService.js.map

package/dist/SarifToSlackService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SarifToSlackService.js","sourceRoot":"","sources":["../src/SarifToSlackService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,EAAE,EAAE,MAAM,IAAI,CAAC;AACpC,OAAO,MAAM,MAAM,UAAU,CAAA;AAC7B,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAC9E,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAO3D,KAAK,UAAU,UAAU,CAAC,IAAgC;IACxD,MAAM,aAAa,GAAG,IAAI,GAAG,EAAwB,CAAC;IACtD,MAAM,UAAU,GAAa,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IAC7D,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,8CAA8C,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;IACjF,CAAC;IAED,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,MAAM,UAAU,GAAW,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;QAE/D,MAAM,cAAc,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,UAAU,EAAE;YAC9D,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC/B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAU;SACvC,CAAC,CAAA;QACF,IAAI,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;YACzB,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;QAC/C,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;YACzB,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;QAC/C,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC;YACxB,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;QAC7C,CAAC;QACD,IAAI,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,CAAC;YACtB,cAAc,CAAC,OAAO,EAAE,CAAA;QAC1B,CAAC;QACD,aAAa,CAAC,GAAG,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;IAC9C,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IACb,cAAc,CAA4B;IAE3D;QACE,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,EAAwB,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAgC;QACzD,MAAM,CAAC,UAAU,CAAC;YAChB,QAAQ,EAAE,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC;SACzC,CAAC,CAAA;QACF,MAAM,QAAQ,GAAwB,IAAI,mBAAmB,EAAE,CAAA;QAC/D,MAAM,GAAG,GAA8B,MAAM,UAAU,CAAC,IAAI,CAAC,CAAA;QAC7D,GAAG,CAAC,OAAO,CAAC,CAAC,GAAiB,EAAE,GAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAA;QACtF,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO;QAClB,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,EAAE,CAAC;YACnD,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,IAAI,CAAC,SAAiB;QACjC,MAAM,OAAO,GAA6B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;QAC5E,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,kDAAkD,SAAS,GAAG,CAAC,CAAA;QACjF,CAAC;QACD,MAAM,IAAI,GAAW,MAAM,OAAO,CAAC,IAAI,EAAE,CAAA;QACzC,MAAM,CAAC,IAAI,CAAC,oBAAoB,SAAS,gBAAgB,EAAE,IAAI,CAAC,CAAA;IAClE,CAAC;CACF"}

package/dist/SlackMessageBuilder.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=SlackMessageBuilder.d.ts.map

package/dist/SlackMessageBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SlackMessageBuilder.d.ts","sourceRoot":"","sources":["../src/SlackMessageBuilder.ts"],"names":[],"mappings":""}

package/dist/SlackMessageBuilder.js

@@ -0,0 +1,143 @@
+import { IncomingWebhook } from '@slack/webhook';
+/**
+ * Class for building and sending Slack messages based on SARIF logs.
+ * @internal
+ */
+export class SlackMessageBuilder {
+    webhook;
+    gitHubServerUrl;
+    color;
+    header;
+    footer;
+    actor;
+    runId;
+    sarif;
+    constructor(url, opts) {
+        this.webhook = new IncomingWebhook(url, {
+            username: opts.username || 'SARIF results',
+            icon_url: opts.iconUrl
+        });
+        this.color = opts.color;
+        this.sarif = opts.sarif;
+        this.gitHubServerUrl = process.env.GITHUB_SERVER_URL || 'https://github.com';
+    }
+    withHeader(header) {
+        this.header = {
+            type: 'header',
+            text: {
+                type: 'plain_text',
+                text: header || process.env.GITHUB_REPOSITORY || 'SARIF results'
+            }
+        };
+    }
+    withActor(actor) {
+        this.actor = actor || process.env.GITHUB_ACTOR;
+    }
+    withRun() {
+        this.runId = process.env.GITHUB_RUN_ID;
+    }
+    withFooter(footer) {
+        const repoName = 'fabasoad/sarif-to-slack-action';
+        this.footer = {
+            type: 'context',
+            elements: [{
+                    type: footer ? 'plain_text' : 'mrkdwn',
+                    text: footer || `Generated by <${this.gitHubServerUrl}/${repoName}|${repoName}>`
+                }],
+        };
+    }
+    async send() {
+        const blocks = [];
+        if (this.header) {
+            blocks.push(this.header);
+        }
+        blocks.push({
+            type: 'section',
+            text: {
+                type: 'mrkdwn',
+                text: this.buildText()
+            }
+        });
+        if (this.footer) {
+            blocks.push(this.footer);
+        }
+        const { text } = await this.webhook.send({
+            attachments: [{ color: this.color, blocks }]
+        });
+        return text;
+    }
+    buildText() {
+        const text = [];
+        if (this.actor) {
+            const actorUrl = `${this.gitHubServerUrl}/${this.actor}`;
+            text.push(`_Triggered by <${actorUrl}|${this.actor}>_`);
+        }
+        text.push(this.composeSummary());
+        if (this.runId) {
+            let runText = 'Job ';
+            if (process.env.GITHUB_REPOSITORY) {
+                runText += `<${this.gitHubServerUrl}/${process.env.GITHUB_REPOSITORY}/actions/runs/${this.runId}|#${this.runId}>`;
+            }
+            else {
+                runText += `#${this.runId}`;
+            }
+            text.push(runText);
+        }
+        return text.join('\n');
+    }
+    composeRunSummary(toolName, map) {
+        const levelsText = [];
+        for (const [level, count] of map.entries()) {
+            const levelCapitalized = level.charAt(0).toUpperCase() + level.slice(1);
+            levelsText.push(`*${levelCapitalized}*: ${count}`);
+        }
+        return `*${toolName}*\n${levelsText.join(', ')}`;
+    }
+    composeSummary() {
+        const data = new Map();
+        for (const run of this.sarif.runs) {
+            const toolName = run.tool.driver.name;
+            if (!data.has(toolName)) {
+                data.set(toolName, new Map());
+            }
+            const results = run.results ?? [];
+            for (const result of results) {
+                const level = this.tryGetLevel(run, result);
+                const count = data.get(toolName)?.get(level) || 0;
+                data.get(toolName)?.set(level, count + 1);
+            }
+        }
+        const summaries = [];
+        for (const [toolName, map] of data.entries()) {
+            summaries.push(this.composeRunSummary(toolName, map));
+        }
+        return summaries.join('\n');
+    }
+    tryGetLevel(run, result) {
+        if (result.level) {
+            return result.level;
+        }
+        const ruleData = {};
+        if (result.rule) {
+            if (result.rule?.index) {
+                ruleData.index = result.rule.index;
+            }
+            if (result.rule?.id) {
+                ruleData.id = result.rule.id;
+            }
+        }
+        if (!ruleData.index && result.ruleIndex) {
+            ruleData.index = result.ruleIndex;
+        }
+        if (ruleData.index
+            && run.tool.driver?.rules
+            && ruleData.index < run.tool.driver.rules.length) {
+            const rule = run.tool.driver.rules[ruleData.index];
+            if (rule.properties && 'problem.severity' in rule.properties) {
+                return rule.properties['problem.severity'];
+            }
+        }
+        return 'unknown';
+    }
+}
+//# sourceMappingURL=SlackMessageBuilder.js.map

package/dist/SlackMessageBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SlackMessageBuilder.js","sourceRoot":"","sources":["../src/SlackMessageBuilder.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAiBhD;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IACb,OAAO,CAAiB;IACxB,eAAe,CAAQ;IACvB,KAAK,CAAS;IAEvB,MAAM,CAAc;IACpB,MAAM,CAAe;IACrB,KAAK,CAAS;IACd,KAAK,CAAS;IAEN,KAAK,CAAO;IAE5B,YAAY,GAAW,EAAE,IAAgC;QACvD,IAAI,CAAC,OAAO,GAAG,IAAI,eAAe,CAAC,GAAG,EAAE;YACtC,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,eAAe;YAC1C,QAAQ,EAAE,IAAI,CAAC,OAAO;SACvB,CAAC,CAAA;QACF,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;QACvB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;QACvB,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,oBAAoB,CAAA;IAC9E,CAAC;IAED,UAAU,CAAC,MAAe;QACxB,IAAI,CAAC,MAAM,GAAG;YACZ,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE;gBACJ,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,eAAe;aACjE;SACF,CAAA;IACH,CAAC;IAED,SAAS,CAAC,KAAc;QACtB,IAAI,CAAC,KAAK,GAAG,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,CAAA;IAChD,CAAC;IAED,OAAO;QACL,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,CAAA;IACxC,CAAC;IAED,UAAU,CAAC,MAAe;QACxB,MAAM,QAAQ,GAAG,gCAAgC,CAAA;QACjD,IAAI,CAAC,MAAM,GAAG;YACZ,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,CAAC;oBACT,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ;oBACtC,IAAI,EAAE,MAAM,IAAI,iBAAiB,IAAI,CAAC,eAAe,IAAI,QAAQ,IAAI,QAAQ,GAAG;iBACjF,CAAC;SACH,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI;QACR,MAAM,MAAM,GAAe,EAAE,CAAA;QAC7B,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC1B,CAAC;QACD,MAAM,CAAC,IAAI,CAAC;YACV,IAAI,EAAE,SAAS;YACf,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE;aACvB;SACF,CAAC,CAAA;QACF,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC1B,CAAC;QACD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;YACvC,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;SAC7C,CAAC,CAAA;QACF,OAAO,IAAI,CAAA;IACb,CAAC;IAEO,SAAS;QACf,MAAM,IAAI,GAAa,EAAE,CAAA;QACzB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,KAAK,EAAE,CAAA;YACxD,IAAI,CAAC,IAAI,CAAC,kBAAkB,QAAQ,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,CAAA;QACzD,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAA;QAChC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,OAAO,GAAW,MAAM,CAAA;YAC5B,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC;gBAClC,OAAO,IAAI,IAAI,IAAI,CAAC,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,iBAAiB,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,GAAG,CAAA;YACnH,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAA;YAC7B,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACpB,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACxB,CAAC;IAEO,iBAAiB,CAAC,QAAgB,EAAE,GAAwB;QAClE,MAAM,UAAU,GAAa,EAAE,CAAA;QAC/B,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC;YAC3C,MAAM,gBAAgB,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YACvE,UAAU,CAAC,IAAI,CAAC,IAAI,gBAAgB,MAAM,KAAK,EAAE,CAAC,CAAA;QACpD,CAAC;QACD,OAAO,IAAI,QAAQ,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAA;IAClD,CAAC;IAEO,cAAc;QACpB,MAAM,IAAI,GAAG,IAAI,GAAG,EAA+B,CAAA;QACnD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAA;YACrC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACxB,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,GAAG,EAAkB,CAAC,CAAA;YAC/C,CAAC;YACD,MAAM,OAAO,GAAa,GAAG,CAAC,OAAO,IAAI,EAAE,CAAA;YAC3C,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,MAAM,KAAK,GAAW,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;gBACnD,MAAM,KAAK,GAAW,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;gBACzD,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;YAC3C,CAAC;QACH,CAAC;QACD,MAAM,SAAS,GAAa,EAAE,CAAA;QAC9B,KAAK,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;YAC7C,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAA;QACvD,CAAC;QACD,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC7B,CAAC;IAEO,WAAW,CAAC,GAAQ,EAAE,MAAc;QAC1C,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,OAAO,MAAM,CAAC,KAAK,CAAA;QACrB,CAAC;QAED,MAAM,QAAQ,GAAa,EAAE,CAAA;QAE7B,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAChB,IAAI,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;gBACvB,QAAQ,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAA;YACpC,CAAC;YACD,IAAI,MAAM,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC;gBACpB,QAAQ,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAA;YAC9B,CAAC;QACH,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACxC,QAAQ,CAAC,KAAK,GAAG,MAAM,CAAC,SAAS,CAAA;QACnC,CAAC;QAED,IAAI,QAAQ,CAAC,KAAK;eACb,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK;eACtB,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACnD,MAAM,IAAI,GAAwB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;YACvE,IAAI,IAAI,CAAC,UAAU,IAAI,kBAAkB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBAC7D,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAW,CAAA;YACtD,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Sarif to Slack message converter library.
+ *
+ * @remarks
+ * This library provides a service to send a Slack messages based on the provided
+ * SARIF (Static Analysis Results Interchange Format) files.
+ *
+ * @example
+ * ```typescript
+ * import { SarifToSlackService } from 'sarif-to-slack';
+ *
+ * const service = new SarifToSlackService({
+ *   webhookUrl: 'https://hooks.slack.com/services/your/webhook/url',
+ *   sarifPath: 'path/to/your/sarif/file.sarif',
+ *   logLevel: 'info',
+ *   username: 'SARIF Bot',
+ *   iconUrl: 'https://example.com/icon.png',
+ *   color: '#36a64f',
+ *   header: {
+ *     include: true,
+ *     value: 'SARIF Analysis Results'
+ *   },
+ *   footer: {
+ *     include: true,
+ *     value: 'Generated by @fabasoad/sarif-to-slack'
+ *   },
+ *   actor: {
+ *     include: true,
+ *     value: 'fabasoad'
+ *   },
+ *   run: {
+ *     include: true
+ *   },
+ * });
+ * await service.sendAll();
+ * ```
+ *
+ * @see {@link SarifToSlackService}
+ *
+ * @packageDocumentation
+ */
+export { SarifToSlackService } from './SarifToSlackService';
+export { IncludeAwareProps, IncludeAwareWithValueProps, LogLevel, Sarif, SarifToSlackServiceOptions, SlackMessage, } from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EACL,iBAAiB,EACjB,0BAA0B,EAC1B,QAAQ,EACR,KAAK,EACL,0BAA0B,EAC1B,YAAY,GACb,MAAM,SAAS,CAAA"}

package/dist/index.js

@@ -0,0 +1,45 @@
+// Copyright (c) Yevhen Fabizhevskyi. All rights reserved. Licensed under the MIT license.
+/**
+ * Sarif to Slack message converter library.
+ *
+ * @remarks
+ * This library provides a service to send a Slack messages based on the provided
+ * SARIF (Static Analysis Results Interchange Format) files.
+ *
+ * @example
+ * ```typescript
+ * import { SarifToSlackService } from 'sarif-to-slack';
+ *
+ * const service = new SarifToSlackService({
+ *   webhookUrl: 'https://hooks.slack.com/services/your/webhook/url',
+ *   sarifPath: 'path/to/your/sarif/file.sarif',
+ *   logLevel: 'info',
+ *   username: 'SARIF Bot',
+ *   iconUrl: 'https://example.com/icon.png',
+ *   color: '#36a64f',
+ *   header: {
+ *     include: true,
+ *     value: 'SARIF Analysis Results'
+ *   },
+ *   footer: {
+ *     include: true,
+ *     value: 'Generated by @fabasoad/sarif-to-slack'
+ *   },
+ *   actor: {
+ *     include: true,
+ *     value: 'fabasoad'
+ *   },
+ *   run: {
+ *     include: true
+ *   },
+ * });
+ * await service.sendAll();
+ * ```
+ *
+ * @see {@link SarifToSlackService}
+ *
+ * @packageDocumentation
+ */
+export { SarifToSlackService } from './SarifToSlackService';
+export { LogLevel, } from './types';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,0FAA0F;AAE1F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAGL,QAAQ,GAIT,MAAM,SAAS,CAAA"}

package/dist/sarif-to-slack.d.ts

@@ -106,7 +106,7 @@ export declare type Sarif = Log;
  * @public
  */
 export declare class SarifToSlackService {
-    private _slackMessages;
+    private readonly _slackMessages;
     private constructor();
     /**
      * Gets the Slack messages prepared for each SARIF file.

package/dist/types.d.ts

@@ -0,0 +1,88 @@
+import type { Log } from 'sarif';
+/**
+ * Type representing a SARIF log.
+ * @public
+ */
+export type Sarif = Log;
+/**
+ * Interface for a Slack message that can be sent.
+ * @public
+ */
+export interface SlackMessage {
+    /**
+     * Sends the Slack message.
+     * @returns A promise that resolves to the response from the Slack webhook.
+     */
+    send: () => Promise<string>;
+    /**
+     * The SARIF log associated with this Slack message.
+     */
+    sarif: Sarif;
+}
+/**
+ * Enum representing log levels for the service.
+ * @public
+ */
+export declare enum LogLevel {
+    /**
+     * Represents the most verbose logging level, typically used for detailed debugging information.
+     */
+    Silly = 0,
+    /**
+     * Represents a logging level for tracing the flow of the application.
+     */
+    Trace = 1,
+    /**
+     * Represents a logging level for debugging information that is less verbose than silly.
+     */
+    Debug = 2,
+    /**
+     * Represents a logging level for general informational messages that highlight the progress of the application.
+     */
+    Info = 3,
+    /**
+     * Represents a logging level for potentially harmful situations that require attention.
+     */
+    Warning = 4,
+    /**
+     * Represents a logging level for error conditions that do not require immediate action but should be noted.
+     */
+    Error = 5,
+    /**
+     * Represents a logging level for critical errors that require immediate attention and may cause the application to terminate.
+     */
+    Fatal = 6
+}
+/**
+ * Type representing properties that indicate whether to include certain information
+ * in the Slack message.
+ * @public
+ */
+export type IncludeAwareProps = {
+    include: boolean;
+};
+/**
+ * Type representing properties that indicate whether to include certain information
+ * in the Slack message, along with an optional value.
+ * @public
+ */
+export type IncludeAwareWithValueProps = IncludeAwareProps & {
+    value?: string;
+};
+/**
+ * Options for the SarifToSlackService.
+ * @public
+ */
+export type SarifToSlackServiceOptions = {
+    webhookUrl: string;
+    sarifPath: string;
+    username?: string;
+    iconUrl?: string;
+    color?: string;
+    logLevel?: LogLevel | string;
+    header?: IncludeAwareWithValueProps;
+    footer?: IncludeAwareWithValueProps;
+    actor?: IncludeAwareWithValueProps;
+    run?: IncludeAwareProps;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAA;AAEhC;;;GAGG;AACH,MAAM,MAAM,KAAK,GAAG,GAAG,CAAA;AAEvB;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;IAC3B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAA;CACb;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAClB;;OAEG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,IAAI,IAAI;IACR;;OAEG;IACH,OAAO,IAAI;IACX;;OAEG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,KAAK,IAAI;CACV;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,GAAG;IAC3D,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG;IAEvC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC7B,MAAM,CAAC,EAAE,0BAA0B,CAAC;IACpC,MAAM,CAAC,EAAE,0BAA0B,CAAC;IACpC,KAAK,CAAC,EAAE,0BAA0B,CAAC;IACnC,GAAG,CAAC,EAAE,iBAAiB,CAAC;CACzB,CAAA"}

package/dist/types.js

@@ -0,0 +1,36 @@
+/**
+ * Enum representing log levels for the service.
+ * @public
+ */
+export var LogLevel;
+(function (LogLevel) {
+    /**
+     * Represents the most verbose logging level, typically used for detailed debugging information.
+     */
+    LogLevel[LogLevel["Silly"] = 0] = "Silly";
+    /**
+     * Represents a logging level for tracing the flow of the application.
+     */
+    LogLevel[LogLevel["Trace"] = 1] = "Trace";
+    /**
+     * Represents a logging level for debugging information that is less verbose than silly.
+     */
+    LogLevel[LogLevel["Debug"] = 2] = "Debug";
+    /**
+     * Represents a logging level for general informational messages that highlight the progress of the application.
+     */
+    LogLevel[LogLevel["Info"] = 3] = "Info";
+    /**
+     * Represents a logging level for potentially harmful situations that require attention.
+     */
+    LogLevel[LogLevel["Warning"] = 4] = "Warning";
+    /**
+     * Represents a logging level for error conditions that do not require immediate action but should be noted.
+     */
+    LogLevel[LogLevel["Error"] = 5] = "Error";
+    /**
+     * Represents a logging level for critical errors that require immediate attention and may cause the application to terminate.
+     */
+    LogLevel[LogLevel["Fatal"] = 6] = "Fatal";
+})(LogLevel || (LogLevel = {}));
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAwBA;;;GAGG;AACH,MAAM,CAAN,IAAY,QA6BX;AA7BD,WAAY,QAAQ;IAClB;;OAEG;IACH,yCAAS,CAAA;IACT;;OAEG;IACH,yCAAS,CAAA;IACT;;OAEG;IACH,yCAAS,CAAA;IACT;;OAEG;IACH,uCAAQ,CAAA;IACR;;OAEG;IACH,6CAAW,CAAA;IACX;;OAEG;IACH,yCAAS,CAAA;IACT;;OAEG;IACH,yCAAS,CAAA;AACX,CAAC,EA7BW,QAAQ,KAAR,QAAQ,QA6BnB"}

package/package.json

@@ -1,14 +1,17 @@
 {
   "name": "@fabasoad/sarif-to-slack",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "TypeScript library to send results of SARIF file to Slack webhook URL.",
   "main": "dist/index.js",
+  "module": "dist/index.js",
   "typings": "dist/index.d.ts",
+  "private": false,
   "scripts": {
     "lint": "biome lint --write src",
     "test": "jest --config=jest.config.json --json --outputFile=jest-report.json --coverage",
     "clean": "rm -rf coverage && rm -rf temp",
     "clean:unsafe": "rm -f package-lock.json && rm -rf node_modules && rm -rf dist && rm -rf lib",
+    "tsc": "tsc",
     "build": "tsc && api-extractor run --local --verbose",
     "prepublishOnly": "npm run build",
     "version:patch": "npm version patch --commit-hooks --git-tag-version --message 'chore: bump to version %s'",

package/src/SarifToSlackService.ts

@@ -46,9 +46,10 @@ async function initialize(opts: SarifToSlackServiceOptions): Promise<Map<string,
  * @public
  */
 export class SarifToSlackService {
-  private _slackMessages: ReadonlyMap<string, SlackMessage>;
+  private readonly _slackMessages: Map<string, SlackMessage>;
 
   private constructor() {
+    this._slackMessages = new Map<string, SlackMessage>();
   }
 
   /**
@@ -72,7 +73,8 @@ export class SarifToSlackService {
       logLevel: processLogLevel(opts.logLevel)
     })
     const instance: SarifToSlackService = new SarifToSlackService()
-    instance._slackMessages = await initialize(opts)
+    const map: Map<string, SlackMessage> = await initialize(opts)
+    map.forEach((val: SlackMessage, key: string) => instance._slackMessages.set(key, val))
     return instance
   }
 

package/tsconfig.json

@@ -1,21 +1,35 @@
 {
   "$schema": "http://json.schemastore.org/tsconfig",
   "compilerOptions": {
-    "target": "es2024",
-    "module": "commonjs",
+    "baseUrl": ".",
+    "outDir": "dist",
     "declaration": true,
-    "sourceMap": true,
+    "declarationDir": "dist",
     "declarationMap": true,
-    "stripInternal": true,
-    "types": ["node", "jest"],
+    "target": "es2024",
+    "lib": ["es2024"],
+    "module": "es2022",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "noImplicitThis": true,
+    "alwaysStrict": true,
+    "noFallthroughCasesInSwitch": true,
+    "forceConsistentCasingInFileNames": true,
+    "downlevelIteration": true,
+    "strict": true,
+    "noImplicitAny": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "allowSyntheticDefaultImports": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "typeRoots": ["node_modules/@types", "@types"],
+    "skipLibCheck": true,
     "newLine": "lf",
-    "lib": [
-      "es2024"
-    ],
-    "outDir": "lib"
+    "sourceMap": true,
+    "stripInternal": true,
+    "types": ["node", "jest"]
   },
-  "include": [
-    "src/**/*.ts"
-  ],
-  "exclude": ["node_modules", "tests"]
+  "include": ["src"],
+  "exclude": ["node_modules", "dist", "tests"]
 }