@fabasoad/sarif-to-slack 0.2.5 → 1.0.0

package/dist/utils/FileUtils.js

@@ -0,0 +1,51 @@
+import fs from 'fs';
+import Logger from '../Logger';
+import * as path from 'path';
+/**
+ * Traverse directory recursively and returns list of files with the requested
+ * extension.
+ * @param dir A root directory. Starting point.
+ * @param extension An instance of {@link SarifFileExtension} type.
+ * @param fileList Collected list of files.
+ * @private
+ */
+function listFilesRecursively(dir, extension, fileList = []) {
+    const entries = fs.readdirSync(dir);
+    entries.forEach((entry) => {
+        const fullPath = path.join(dir, entry);
+        if (fs.statSync(fullPath).isDirectory()) {
+            listFilesRecursively(fullPath, extension, fileList);
+        }
+        else if (path.extname(fullPath).toLowerCase() === `.${extension}`) {
+            fileList.push(fullPath);
+        }
+    });
+    return fileList;
+}
+/**
+ * Extract list of files based on the parameters from the given {@link SarifOptions}
+ * object.
+ * @param opts An instance of {@link SarifOptions} type.
+ * @internal
+ */
+export function extractListOfFiles(opts) {
+    if (!fs.existsSync(opts.path)) {
+        throw new Error(`Provided path does not exist: ${opts.path}`);
+    }
+    const stats = fs.statSync(opts.path);
+    if (stats.isDirectory()) {
+        Logger.info(`Provided path is a directory: ${opts.path}`);
+        const files = opts.recursive
+            && listFilesRecursively(opts.path, opts.extension ?? 'sarif')
+            || fs.readdirSync(opts.path);
+        Logger.info(`Found ${files.length} files in ${opts.path} directory with ${opts.extension} extension`);
+        Logger.debug(`Found files: ${files.join(', ')}`);
+        return files;
+    }
+    if (stats.isFile()) {
+        Logger.info(`Provided path is a file: ${opts.path}`);
+        return [opts.path];
+    }
+    throw new Error(`Provided path is neither a file nor a directory: ${opts.path}`);
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRmlsZVV0aWxzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3V0aWxzL0ZpbGVVdGlscy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsTUFBTSxJQUFJLENBQUE7QUFDbkIsT0FBTyxNQUFNLE1BQU0sV0FBVyxDQUFBO0FBRTlCLE9BQU8sS0FBSyxJQUFJLE1BQU0sTUFBTSxDQUFBO0FBRTVCOzs7Ozs7O0dBT0c7QUFDSCxTQUFTLG9CQUFvQixDQUMzQixHQUFXLEVBQ1gsU0FBNkIsRUFDN0IsV0FBcUIsRUFBRTtJQUV2QixNQUFNLE9BQU8sR0FBYSxFQUFFLENBQUMsV0FBVyxDQUFDLEdBQUcsQ0FBQyxDQUFBO0lBQzdDLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQyxLQUFhLEVBQVEsRUFBRTtRQUN0QyxNQUFNLFFBQVEsR0FBVyxJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxLQUFLLENBQUMsQ0FBQTtRQUM5QyxJQUFJLEVBQUUsQ0FBQyxRQUFRLENBQUMsUUFBUSxDQUFDLENBQUMsV0FBVyxFQUFFLEVBQUUsQ0FBQztZQUN4QyxvQkFBb0IsQ0FBQyxRQUFRLEVBQUUsU0FBUyxFQUFFLFFBQVEsQ0FBQyxDQUFBO1FBQ3JELENBQUM7YUFBTSxJQUFJLElBQUksQ0FBQyxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUMsV0FBVyxFQUFFLEtBQUssSUFBSSxTQUFTLEVBQUUsRUFBRSxDQUFDO1lBQ3BFLFFBQVEsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLENBQUE7UUFDekIsQ0FBQztJQUNILENBQUMsQ0FBQyxDQUFBO0lBQ0YsT0FBTyxRQUFRLENBQUE7QUFDakIsQ0FBQztBQUVEOzs7OztHQUtHO0FBQ0gsTUFBTSxVQUFVLGtCQUFrQixDQUFDLElBQWtCO0lBQ25ELElBQUksQ0FBQyxFQUFFLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDO1FBQzlCLE1BQU0sSUFBSSxLQUFLLENBQUMsaUNBQWlDLElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQyxDQUFBO0lBQy9ELENBQUM7SUFFRCxNQUFNLEtBQUssR0FBYSxFQUFFLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQTtJQUU5QyxJQUFJLEtBQUssQ0FBQyxXQUFXLEVBQUUsRUFBRSxDQUFDO1FBQ3hCLE1BQU0sQ0FBQyxJQUFJLENBQUMsaUNBQWlDLElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQyxDQUFBO1FBQ3pELE1BQU0sS0FBSyxHQUFhLElBQUksQ0FBQyxTQUFTO2VBQ2pDLG9CQUFvQixDQUFDLElBQUksQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLFNBQVMsSUFBSSxPQUFPLENBQUM7ZUFDMUQsRUFBRSxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUE7UUFDOUIsTUFBTSxDQUFDLElBQUksQ0FBQyxTQUFTLEtBQUssQ0FBQyxNQUFNLGFBQWEsSUFBSSxDQUFDLElBQUksbUJBQW1CLElBQUksQ0FBQyxTQUFTLFlBQVksQ0FBQyxDQUFBO1FBQ3JHLE1BQU0sQ0FBQyxLQUFLLENBQUMsZ0JBQWdCLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFBO1FBQ2hELE9BQU8sS0FBSyxDQUFBO0lBQ2QsQ0FBQztJQUVELElBQUksS0FBSyxDQUFDLE1BQU0sRUFBRSxFQUFFLENBQUM7UUFDbkIsTUFBTSxDQUFDLElBQUksQ0FBQyw0QkFBNEIsSUFBSSxDQUFDLElBQUksRUFBRSxDQUFDLENBQUE7UUFDcEQsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQTtJQUNwQixDQUFDO0lBRUQsTUFBTSxJQUFJLEtBQUssQ0FBQyxvREFBb0QsSUFBSSxDQUFDLElBQUksRUFBRSxDQUFDLENBQUE7QUFDbEYsQ0FBQyJ9

package/dist/utils/SarifUtils.js

@@ -1,66 +1,32 @@
 /**
- * This function finds the respective tool for the given result.
- * @param run An instance of {@link Run} object.
- * @param result An instance of {@link Result} object.
- * @private
+ * Returns {@link ToolComponent} instance for the given {@link Run}. It does not
+ * count extensions but returns {@link ToolComponent} directly from "run.tool.driver",
+ * despite the fact if extension exists or not.
+ * @internal
  */
-function findToolComponentByResult(run, result) {
-    let tool;
-    if (result.rule?.toolComponent?.index != null) {
-        tool = run.tool.extensions?.[result.rule.toolComponent.index];
-    }
-    if (!tool) {
-        tool = run.tool.driver;
-    }
-    return tool;
+export function findToolComponentDriver(run) {
+    return run.tool.driver;
 }
 /**
- * This function tries to find the respective rule for the given result.
- * @param run An instance of {@link Run} object.
- * @param result An instance of {@link Result} object.
+ * Returns {@link ToolComponent} instance for the given {@link Run} from the extensions
+ * list if applicable. Returns {@linkcode undefined} if provided {@link Result}
+ * does not link to extension.
  * @internal
  */
-export function findRuleByResult(run, result) {
-    const ruleData = {};
-    if (result.rule) {
-        if (result.rule?.index != null) {
-            ruleData.index = result.rule.index;
-        }
-        if (result.rule?.id) {
-            ruleData.id = result.rule.id;
-        }
-    }
-    if (ruleData.index == null && result.ruleIndex != null) {
-        ruleData.index = result.ruleIndex;
-    }
-    if (!ruleData.id && result.ruleId) {
-        ruleData.id = result.ruleId;
-    }
-    const tool = findToolComponentByResult(run, result);
-    if (ruleData.index != null
-        && tool?.rules
-        && ruleData.index < tool.rules.length) {
-        return tool.rules[ruleData.index];
-    }
-    // If failed to find rule by index then try to find by ruleId
-    if (ruleData.id && tool?.rules) {
-        return tool.rules.find((r) => r.id === ruleData.id);
+export function tryFindToolComponentExtension(run, result) {
+    let tool;
+    if (result.rule?.toolComponent?.index != null) {
+        tool = run.tool.extensions?.[result.rule.toolComponent.index];
     }
-    return undefined;
+    return tool;
 }
 /**
- * This function searches respective rule for the given result, and then gets
- * the property of interest from it.
- * @param run An instance of {@link Run} object.
- * @param result An instance of {@link Result} object.
- * @param propertyName The property name that you want to get the value from.
+ * It tries to find respective {@link ToolComponent} from the {@link Result}. At
+ * first, it tries to find it in the list of extensions if applicable, otherwise
+ * it gets it directly from "run.tool.driver".
  * @internal
  */
-export function tryGetRulePropertyByResult(run, result, propertyName) {
-    const rule = findRuleByResult(run, result);
-    if (rule && rule.properties && propertyName in rule.properties) {
-        return rule.properties[propertyName];
-    }
-    return undefined;
+export function findToolComponent(run, result) {
+    return tryFindToolComponentExtension(run, result) ?? findToolComponentDriver(run);
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiU2FyaWZVdGlscy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy91dGlscy9TYXJpZlV0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBOzs7OztHQUtHO0FBQ0gsU0FBUyx5QkFBeUIsQ0FBQyxHQUFRLEVBQUUsTUFBYztJQUN6RCxJQUFJLElBQStCLENBQUE7SUFDbkMsSUFBSSxNQUFNLENBQUMsSUFBSSxFQUFFLGFBQWEsRUFBRSxLQUFLLElBQUksSUFBSSxFQUFFLENBQUM7UUFDOUMsSUFBSSxHQUFHLEdBQUcsQ0FBQyxJQUFJLENBQUMsVUFBVSxFQUFFLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxhQUFhLENBQUMsS0FBSyxDQUFDLENBQUE7SUFDL0QsQ0FBQztJQUVELElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQztRQUNWLElBQUksR0FBRyxHQUFHLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQTtJQUN4QixDQUFDO0lBRUQsT0FBTyxJQUFJLENBQUE7QUFDYixDQUFDO0FBRUQ7Ozs7O0dBS0c7QUFDSCxNQUFNLFVBQVUsZ0JBQWdCLENBQUMsR0FBUSxFQUFFLE1BQWM7SUFDdkQsTUFBTSxRQUFRLEdBQW9DLEVBQUUsQ0FBQTtJQUVwRCxJQUFJLE1BQU0sQ0FBQyxJQUFJLEVBQUUsQ0FBQztRQUNoQixJQUFJLE1BQU0sQ0FBQyxJQUFJLEVBQUUsS0FBSyxJQUFJLElBQUksRUFBRSxDQUFDO1lBQy9CLFFBQVEsQ0FBQyxLQUFLLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUE7UUFDcEMsQ0FBQztRQUNELElBQUksTUFBTSxDQUFDLElBQUksRUFBRSxFQUFFLEVBQUUsQ0FBQztZQUNwQixRQUFRLENBQUMsRUFBRSxHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFBO1FBQzlCLENBQUM7SUFDSCxDQUFDO0lBRUQsSUFBSSxRQUFRLENBQUMsS0FBSyxJQUFJLElBQUksSUFBSSxNQUFNLENBQUMsU0FBUyxJQUFJLElBQUksRUFBRSxDQUFDO1FBQ3ZELFFBQVEsQ0FBQyxLQUFLLEdBQUcsTUFBTSxDQUFDLFNBQVMsQ0FBQTtJQUNuQyxDQUFDO0lBRUQsSUFBSSxDQUFDLFFBQVEsQ0FBQyxFQUFFLElBQUksTUFBTSxDQUFDLE1BQU0sRUFBRSxDQUFDO1FBQ2xDLFFBQVEsQ0FBQyxFQUFFLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQTtJQUM3QixDQUFDO0lBRUQsTUFBTSxJQUFJLEdBQWtCLHlCQUF5QixDQUFDLEdBQUcsRUFBRSxNQUFNLENBQUMsQ0FBQTtJQUVsRSxJQUFJLFFBQVEsQ0FBQyxLQUFLLElBQUksSUFBSTtXQUNyQixJQUFJLEVBQUUsS0FBSztXQUNYLFFBQVEsQ0FBQyxLQUFLLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUN4QyxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxDQUFBO0lBQ25DLENBQUM7SUFFRCw2REFBNkQ7SUFDN0QsSUFBSSxRQUFRLENBQUMsRUFBRSxJQUFJLElBQUksRUFBRSxLQUFLLEVBQUUsQ0FBQztRQUMvQixPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUNwQixDQUFDLENBQXNCLEVBQVcsRUFBRSxDQUFDLENBQUMsQ0FBQyxFQUFFLEtBQUssUUFBUSxDQUFDLEVBQUUsQ0FDMUQsQ0FBQTtJQUNILENBQUM7SUFFRCxPQUFPLFNBQVMsQ0FBQTtBQUNsQixDQUFDO0FBUUQ7Ozs7Ozs7R0FPRztBQUNILE1BQU0sVUFBVSwwQkFBMEIsQ0FBSSxHQUFRLEVBQUUsTUFBYyxFQUFFLFlBQTBCO0lBQ2hHLE1BQU0sSUFBSSxHQUFvQyxnQkFBZ0IsQ0FBQyxHQUFHLEVBQUUsTUFBTSxDQUFDLENBQUE7SUFDM0UsSUFBSSxJQUFJLElBQUksSUFBSSxDQUFDLFVBQVUsSUFBSSxZQUFZLElBQUksSUFBSSxDQUFDLFVBQVUsRUFBRSxDQUFDO1FBQy9ELE9BQU8sSUFBSSxDQUFDLFVBQVUsQ0FBQyxZQUFZLENBQU0sQ0FBQTtJQUMzQyxDQUFDO0lBRUQsT0FBTyxTQUFTLENBQUE7QUFDbEIsQ0FBQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiU2FyaWZVdGlscy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy91dGlscy9TYXJpZlV0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBOzs7OztHQUtHO0FBQ0gsTUFBTSxVQUFVLHVCQUF1QixDQUFDLEdBQVE7SUFDOUMsT0FBTyxHQUFHLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQTtBQUN4QixDQUFDO0FBRUQ7Ozs7O0dBS0c7QUFDSCxNQUFNLFVBQVUsNkJBQTZCLENBQUMsR0FBUSxFQUFFLE1BQWM7SUFDcEUsSUFBSSxJQUErQixDQUFBO0lBQ25DLElBQUksTUFBTSxDQUFDLElBQUksRUFBRSxhQUFhLEVBQUUsS0FBSyxJQUFJLElBQUksRUFBRSxDQUFDO1FBQzlDLElBQUksR0FBRyxHQUFHLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsYUFBYSxDQUFDLEtBQUssQ0FBQyxDQUFBO0lBQy9ELENBQUM7SUFDRCxPQUFPLElBQUksQ0FBQTtBQUNiLENBQUM7QUFFRDs7Ozs7R0FLRztBQUNILE1BQU0sVUFBVSxpQkFBaUIsQ0FBQyxHQUFRLEVBQUUsTUFBYztJQUN4RCxPQUFPLDZCQUE2QixDQUFDLEdBQUcsRUFBRSxNQUFNLENBQUMsSUFBSSx1QkFBdUIsQ0FBQyxHQUFHLENBQUMsQ0FBQTtBQUNuRixDQUFDIn0=

package/etc/sarif-to-slack.api.md

@@ -1,99 +1,161 @@
-## API Report File for "@fabasoad/sarif-to-slack"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import type { Log } from 'sarif';
-
-// @public
-export enum CalculateResultsBy {
-    Level = 0,
-    Severity = 1
-}
-
-// @public
-export type FooterOptions = IncludeAwareWithValueOptions & {
-    type?: FooterType;
-};
-
-// @public
-export enum FooterType {
-    Markdown = "mrkdwn",
-    PlainText = "plain_text"
-}
-
-// @public
-export enum GroupResultsBy {
-    Run = 1,
-    ToolName = 0,
-    Total = 2
-}
-
-// @public
-export type IncludeAwareOptions = {
-    include: boolean;
-};
-
-// @public
-export type IncludeAwareWithValueOptions = IncludeAwareOptions & {
-    value?: string;
-};
-
-// @public
-export enum LogLevel {
-    Debug = 2,
-    Error = 5,
-    Fatal = 6,
-    Info = 3,
-    Silly = 0,
-    Trace = 1,
-    Warning = 4
-}
-
-// @public
-export type LogOptions = {
-    level?: LogLevel;
-    template?: string;
-    colored?: boolean;
-};
-
-// @public
-export type SarifLog = Log;
-
-// @public
-export type SarifToSlackOutput = {
-    groupBy?: GroupResultsBy;
-    calculateBy?: CalculateResultsBy;
-};
-
-// @public
-export class SarifToSlackService {
-    static create(opts: SarifToSlackServiceOptions): Promise<SarifToSlackService>;
-    send(sarifPath: string): Promise<void>;
-    sendAll(): Promise<void>;
-    get slackMessages(): ReadonlyMap<string, SlackMessage>;
-}
-
-// @public
-export type SarifToSlackServiceOptions = {
-    webhookUrl: string;
-    sarifPath: string;
-    username?: string;
-    iconUrl?: string;
-    color?: string;
-    log?: LogOptions;
-    header?: IncludeAwareWithValueOptions;
-    footer?: FooterOptions;
-    actor?: IncludeAwareWithValueOptions;
-    run?: IncludeAwareOptions;
-    output?: SarifToSlackOutput;
-};
-
-// @public
-export interface SlackMessage {
-    sarif: SarifLog;
-    send: () => Promise<string>;
-}
-
-```
+## API Report File for "@fabasoad/sarif-to-slack"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public
+export class Color {
+    constructor(color?: string);
+    get value(): string | undefined;
+}
+
+// Warning: (ae-forgotten-export) The symbol "ColorGroupCommon" needs to be exported by the entry point index.d.ts
+//
+// @public
+export type ColorGroupByLevel = ColorGroupCommon & {
+    error?: Color;
+    warning?: Color;
+    note?: Color;
+};
+
+// @public
+export type ColorGroupBySeverity = ColorGroupCommon & {
+    critical?: Color;
+    high?: Color;
+    medium?: Color;
+    low?: Color;
+};
+
+// @public
+export type ColorOptions = {
+    byLevel?: ColorGroupByLevel;
+    bySeverity?: ColorGroupBySeverity;
+};
+
+// @public
+export type FooterOptions = IncludeAwareWithValueOptions & {
+    type?: FooterType;
+};
+
+// @public
+export enum FooterType {
+    Markdown = "mrkdwn",
+    PlainText = "plain_text"
+}
+
+// @public
+export type IncludeAwareOptions = {
+    include: boolean;
+};
+
+// @public
+export type IncludeAwareWithValueOptions = IncludeAwareOptions & {
+    value?: string;
+};
+
+// @public
+export enum LogLevel {
+    Debug = 2,
+    Error = 5,
+    Fatal = 6,
+    Info = 3,
+    Silly = 0,
+    Trace = 1,
+    Warning = 4
+}
+
+// @public
+export type LogOptions = {
+    level?: LogLevel;
+    template?: string;
+    colored?: boolean;
+};
+
+// @public
+export enum RepresentationType {
+    CompactGroupByRunPerLevel = 0,
+    CompactGroupByRunPerSeverity = 1,
+    CompactGroupBySarifPerLevel = 4,
+    CompactGroupBySarifPerSeverity = 5,
+    CompactGroupByToolNamePerLevel = 2,
+    CompactGroupByToolNamePerSeverity = 3,
+    CompactTotalPerLevel = 6,
+    CompactTotalPerSeverity = 7
+}
+
+// @public
+export type SarifFileExtension = 'sarif' | 'json';
+
+// @public
+export type SarifOptions = {
+    path: string;
+    recursive?: boolean;
+    extension?: SarifFileExtension;
+};
+
+// @public
+export class SarifToSlackClient {
+    // (undocumented)
+    static create(opts: SarifToSlackClientOptions): Promise<SarifToSlackClient>;
+    send(): Promise<void>;
+}
+
+// @public
+export type SarifToSlackClientOptions = {
+    webhookUrl: string;
+    sarif: SarifOptions;
+    username?: string;
+    iconUrl?: string;
+    color?: Color | ColorOptions;
+    log?: LogOptions;
+    header?: IncludeAwareWithValueOptions;
+    footer?: FooterOptions;
+    actor?: IncludeAwareWithValueOptions;
+    run?: IncludeAwareOptions;
+    representation?: RepresentationType;
+    sendIf?: SendIf;
+};
+
+// @public
+export enum SendIf {
+    Always = 20,
+    Empty = 22,
+    LevelError = 11,
+    LevelNone = 16,
+    LevelNoneOrHigher = 17,
+    LevelNote = 14,
+    LevelNoteOrHigher = 15,
+    LevelUnknown = 18,
+    LevelUnknownOrHigher = 19,
+    LevelWarning = 12,
+    LevelWarningOrHigher = 13,
+    Never = 23,
+    SeverityCritical = 0,
+    SeverityHigh = 1,
+    SeverityHighOrHigher = 2,
+    SeverityLow = 5,
+    SeverityLowOrHigher = 6,
+    SeverityMedium = 3,
+    SeverityMediumOrHigher = 4,
+    SeverityNone = 7,
+    SeverityNoneOrHigher = 8,
+    SeverityUnknown = 9,
+    SeverityUnknownOrHigher = 10,
+    Some = 21
+}
+
+// @public
+export interface SlackMessage {
+    send: () => Promise<string>;
+    // (undocumented)
+    withActor(actor?: string): void;
+    // (undocumented)
+    withFooter(text?: string, type?: FooterType): void;
+    // (undocumented)
+    withHeader(header?: string): void;
+    // (undocumented)
+    withRun(): void;
+}
+
+```

package/jest.config.json

@@ -10,8 +10,8 @@
   ],
   "coverageThreshold": {
     "global": {
-      "branches": 10,
-      "functions": 10,
+      "branches": 3,
+      "functions": 3,
       "lines": 15,
       "statements": 15
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fabasoad/sarif-to-slack",
-  "version": "0.2.5",
+  "version": "1.0.0",
   "description": "TypeScript library to send results of SARIF file to Slack webhook URL.",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -44,18 +44,18 @@
   "dependencies": {
     "@slack/webhook": "7.0.5",
     "@types/sarif": "2.1.7",
-    "immutable": "5.1.3",
     "tslog": "4.9.3"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.1.3",
-    "@microsoft/api-documenter": "7.26.30",
-    "@microsoft/api-extractor": "7.52.9",
+    "@biomejs/biome": "2.2.0",
+    "@microsoft/api-documenter": "7.26.31",
+    "@microsoft/api-extractor": "7.52.10",
     "@types/jest": "30.0.0",
+    "@types/uuid": "10.0.0",
     "jest": "30.0.5",
     "jest-circus": "30.0.5",
-    "ts-jest": "29.4.0",
+    "ts-jest": "29.4.1",
     "tsup": "8.5.0",
-    "typescript": "5.8.3"
+    "typescript": "5.9.2"
   }
 }

package/scripts/save-metadata.sh

@@ -1,13 +1,15 @@
 #!/usr/bin/env sh
 
 version=$(jq -r '.version' package.json)
-echo "/**" > src/metadata.ts
-echo " * These values are used for the default footer in Slack message and in logging." >> src/metadata.ts
-echo " *" >> src/metadata.ts
-echo " * @privateRemarks" >> src/metadata.ts
-echo " * This file is autogenerated by scripts/save-metadata.sh" >> src/metadata.ts
-echo " * Do not edit it manually!" >> src/metadata.ts
-echo " *" >> src/metadata.ts
-echo " * @internal" >> src/metadata.ts
-echo " */" >> src/metadata.ts
-echo "export const LIB_VERSION = '${version}'" >> src/metadata.ts
+sha=$(git rev-parse --verify HEAD)
+build_at=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
+
+jq -n \
+  --arg v "${version}" \
+  --arg s "${sha}" \
+  --arg b "${build_at}" \
+  '{
+    version: $v,
+    sha: $s,
+    buildAt: $b
+  }' > src/metadata.json

package/src/Logger.ts

@@ -36,4 +36,8 @@ export default class Logger {
   public static debug(...args: unknown[]): void {
     Logger.instance.debug(...args)
   }
+
+  public static trace(...args: unknown[]): void {
+    Logger.instance.trace(...args)
+  }
 }