@fabasoad/sarif-to-slack 0.2.2 → 0.2.4

package/dist/model/SarifModelPerRun.js

@@ -1,4 +1,4 @@
-import { tryGetRulePropertyByResult } from '../utils/SarifUtils';
+import { findToolComponentByResult, tryGetRulePropertyByResult } from '../utils/SarifUtils';
 import { SecurityLevel, SecuritySeverity } from './types';
 import Logger from '../Logger';
 import { Map as ImmutableMap } from 'immutable';
@@ -14,7 +14,7 @@ export class SarifModelPerRun {
     _securitySeverityMap;
     _securityLevelMap;
     constructor(run) {
-        this.toolName = run.tool.driver.name;
+        this.toolName = findToolComponentByResult(run, run.results?.[0]).name;
         this._securitySeverityMap = ImmutableMap().asMutable();
         this._securityLevelMap = ImmutableMap().asMutable();
         this.buildSecuritySeverityMap(run);
@@ -87,4 +87,4 @@ export class SarifModelPerRun {
         return sortSecurityLevelMap(this._securityLevelMap);
     }
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiU2FyaWZNb2RlbFBlclJ1bi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9tb2RlbC9TYXJpZk1vZGVsUGVyUnVuLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sRUFBRSwwQkFBMEIsRUFBRSxNQUFNLHFCQUFxQixDQUFBO0FBQ2hFLE9BQU8sRUFBRSxhQUFhLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxTQUFTLENBQUE7QUFDekQsT0FBTyxNQUFNLE1BQU0sV0FBVyxDQUFBO0FBQzlCLE9BQU8sRUFBRSxHQUFHLElBQUksWUFBWSxFQUFFLE1BQU0sV0FBVyxDQUFBO0FBQy9DLE9BQU8sRUFDTCxvQkFBb0IsRUFDcEIsdUJBQXVCLEVBQ3hCLE1BQU0sb0JBQW9CLENBQUM7QUFFNUI7Ozs7O0dBS0c7QUFDSCxNQUFNLE9BQU8sZ0JBQWdCO0lBQ1gsUUFBUSxDQUFRO0lBRWYsb0JBQW9CLENBQXdDO0lBQzVELGlCQUFpQixDQUFxQztJQUV2RSxZQUFZLEdBQVE7UUFDbEIsSUFBSSxDQUFDLFFBQVEsR0FBRyxHQUFHLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUE7UUFFcEMsSUFBSSxDQUFDLG9CQUFvQixHQUFHLFlBQVksRUFBNEIsQ0FBQyxTQUFTLEVBQUUsQ0FBQTtRQUNoRixJQUFJLENBQUMsaUJBQWlCLEdBQUcsWUFBWSxFQUF5QixDQUFDLFNBQVMsRUFBRSxDQUFBO1FBRTFFLElBQUksQ0FBQyx3QkFBd0IsQ0FBQyxHQUFHLENBQUMsQ0FBQTtRQUNsQyxJQUFJLENBQUMscUJBQXFCLENBQUMsR0FBRyxDQUFDLENBQUE7SUFDakMsQ0FBQztJQUVPLHdCQUF3QixDQUFDLEtBQWM7UUFDN0MsSUFBSSxLQUFLLEtBQUssU0FBUyxFQUFFLENBQUM7WUFDeEIsT0FBTyxnQkFBZ0IsQ0FBQyxPQUFPLENBQUE7UUFDakMsQ0FBQztRQUVELElBQUksS0FBSyxJQUFJLENBQUMsSUFBSSxLQUFLLElBQUksRUFBRSxFQUFFLENBQUM7WUFDOUIsT0FBTyxnQkFBZ0IsQ0FBQyxRQUFRLENBQUE7UUFDbEMsQ0FBQztRQUVELElBQUksS0FBSyxJQUFJLENBQUMsRUFBRSxDQUFDO1lBQ2YsT0FBTyxnQkFBZ0IsQ0FBQyxJQUFJLENBQUE7UUFDOUIsQ0FBQztRQUVELElBQUksS0FBSyxJQUFJLENBQUMsRUFBRSxDQUFDO1lBQ2YsT0FBTyxnQkFBZ0IsQ0FBQyxNQUFNLENBQUE7UUFDaEMsQ0FBQztRQUVELElBQUksS0FBSyxJQUFJLEdBQUcsRUFBRSxDQUFDO1lBQ2pCLE9BQU8sZ0JBQWdCLENBQUMsR0FBRyxDQUFBO1FBQzdCLENBQUM7UUFFRCxJQUFJLEtBQUssSUFBSSxDQUFDLEVBQUUsQ0FBQztZQUNmLE9BQU8sZ0JBQWdCLENBQUMsSUFBSSxDQUFBO1FBQzlCLENBQUM7UUFFRCxNQUFNLENBQUMsSUFBSSxDQUFDLGdCQUFnQixLQUFLLDJDQUEyQyxDQUFDLENBQUE7UUFDN0UsT0FBTyxnQkFBZ0IsQ0FBQyxPQUFPLENBQUE7SUFDakMsQ0FBQztJQUVPLHFCQUFxQixDQUFDLEtBQWM7UUFDMUMsSUFBSSxLQUFLLEtBQUssU0FBUyxFQUFFLENBQUM7WUFDeEIsT0FBTyxhQUFhLENBQUMsT0FBTyxDQUFBO1FBQzlCLENBQUM7UUFFRCxJQUFJLEtBQUssQ0FBQyxXQUFXLEVBQUUsS0FBSyxPQUFPLEVBQUUsQ0FBQztZQUNwQyxPQUFPLGFBQWEsQ0FBQyxLQUFLLENBQUE7UUFDNUIsQ0FBQztRQUVELElBQUksS0FBSyxDQUFDLFdBQVcsRUFBRSxLQUFLLFNBQVMsRUFBRSxDQUFDO1lBQ3RDLE9BQU8sYUFBYSxDQUFDLE9BQU8sQ0FBQTtRQUM5QixDQUFDO1FBRUQsSUFBSSxLQUFLLENBQUMsV0FBVyxFQUFFLEtBQUssTUFBTSxFQUFFLENBQUM7WUFDbkMsT0FBTyxhQUFhLENBQUMsSUFBSSxDQUFBO1FBQzNCLENBQUM7UUFFRCxNQUFNLENBQUMsSUFBSSxDQUFDLGVBQWUsS0FBSyx1Q0FBdUMsQ0FBQyxDQUFBO1FBQ3hFLE9BQU8sYUFBYSxDQUFDLE9BQU8sQ0FBQTtJQUM5QixDQUFDO0lBRU8sd0JBQXdCLENBQUMsR0FBUTtRQUN2QyxNQUFNLE9BQU8sR0FBYSxHQUFHLENBQUMsT0FBTyxJQUFJLEVBQUUsQ0FBQTtRQUMzQyxLQUFLLE1BQU0sTUFBTSxJQUFJLE9BQU8sRUFBRSxDQUFDO1lBQzdCLE1BQU0sUUFBUSxHQUFxQixJQUFJLENBQUMsd0JBQXdCLENBQzlELDBCQUEwQixDQUFDLEdBQUcsRUFBRSxNQUFNLEVBQUUsbUJBQW1CLENBQUMsQ0FDN0QsQ0FBQTtZQUNELE1BQU0sS0FBSyxHQUFXLElBQUksQ0FBQyxvQkFBb0IsQ0FBQyxHQUFHLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFBO1lBQ2xFLElBQUksQ0FBQyxvQkFBb0IsQ0FBQyxHQUFHLENBQUMsUUFBUSxFQUFFLEtBQUssR0FBRyxDQUFDLENBQUMsQ0FBQTtRQUNwRCxDQUFDO0lBQ0gsQ0FBQztJQUVPLG1CQUFtQixDQUFDLEdBQVEsRUFBRSxNQUFjO1FBQ2xELElBQUksTUFBTSxDQUFDLEtBQUssRUFBRSxDQUFDO1lBQ2pCLE9BQU8sTUFBTSxDQUFDLEtBQUssQ0FBQTtRQUNyQixDQUFDO1FBRUQsT0FBTywwQkFBMEIsQ0FBQyxHQUFHLEVBQUUsTUFBTSxFQUFFLGtCQUFrQixDQUFDLENBQUE7SUFDcEUsQ0FBQztJQUVPLHFCQUFxQixDQUFDLEdBQVE7UUFDcEMsTUFBTSxPQUFPLEdBQWEsR0FBRyxDQUFDLE9BQU8sSUFBSSxFQUFFLENBQUE7UUFDM0MsS0FBSyxNQUFNLE1BQU0sSUFBSSxPQUFPLEVBQUUsQ0FBQztZQUM3QixNQUFNLEtBQUssR0FBa0IsSUFBSSxDQUFDLHFCQUFxQixDQUNyRCxJQUFJLENBQUMsbUJBQW1CLENBQUMsR0FBRyxFQUFFLE1BQU0sQ0FBQyxDQUN0QyxDQUFBO1lBQ0QsTUFBTSxLQUFLLEdBQVcsSUFBSSxDQUFDLGlCQUFpQixDQUFDLEdBQUcsQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUE7WUFDNUQsSUFBSSxDQUFDLGlCQUFpQixDQUFDLEdBQUcsQ0FBQyxLQUFLLEVBQUUsS0FBSyxHQUFHLENBQUMsQ0FBQyxDQUFBO1FBQzlDLENBQUM7SUFDSCxDQUFDO0lBRUQsSUFBVyxtQkFBbUI7UUFDNUIsT0FBTyx1QkFBdUIsQ0FBQyxJQUFJLENBQUMsb0JBQW9CLENBQUMsQ0FBQTtJQUMzRCxDQUFDO0lBRUQsSUFBVyxnQkFBZ0I7UUFDekIsT0FBTyxvQkFBb0IsQ0FBQyxJQUFJLENBQUMsaUJBQWlCLENBQUMsQ0FBQTtJQUNyRCxDQUFDO0NBQ0YifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiU2FyaWZNb2RlbFBlclJ1bi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9tb2RlbC9TYXJpZk1vZGVsUGVyUnVuLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sRUFDTCx5QkFBeUIsRUFDekIsMEJBQTBCLEVBQzNCLE1BQU0scUJBQXFCLENBQUE7QUFDNUIsT0FBTyxFQUFFLGFBQWEsRUFBRSxnQkFBZ0IsRUFBRSxNQUFNLFNBQVMsQ0FBQTtBQUN6RCxPQUFPLE1BQU0sTUFBTSxXQUFXLENBQUE7QUFDOUIsT0FBTyxFQUFFLEdBQUcsSUFBSSxZQUFZLEVBQUUsTUFBTSxXQUFXLENBQUE7QUFDL0MsT0FBTyxFQUNMLG9CQUFvQixFQUNwQix1QkFBdUIsRUFDeEIsTUFBTSxvQkFBb0IsQ0FBQztBQUU1Qjs7Ozs7R0FLRztBQUNILE1BQU0sT0FBTyxnQkFBZ0I7SUFDWCxRQUFRLENBQVE7SUFFZixvQkFBb0IsQ0FBd0M7SUFDNUQsaUJBQWlCLENBQXFDO0lBRXZFLFlBQVksR0FBUTtRQUNsQixJQUFJLENBQUMsUUFBUSxHQUFHLHlCQUF5QixDQUFDLEdBQUcsRUFBRSxHQUFHLENBQUMsT0FBTyxFQUFFLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUE7UUFFckUsSUFBSSxDQUFDLG9CQUFvQixHQUFHLFlBQVksRUFBNEIsQ0FBQyxTQUFTLEVBQUUsQ0FBQTtRQUNoRixJQUFJLENBQUMsaUJBQWlCLEdBQUcsWUFBWSxFQUF5QixDQUFDLFNBQVMsRUFBRSxDQUFBO1FBRTFFLElBQUksQ0FBQyx3QkFBd0IsQ0FBQyxHQUFHLENBQUMsQ0FBQTtRQUNsQyxJQUFJLENBQUMscUJBQXFCLENBQUMsR0FBRyxDQUFDLENBQUE7SUFDakMsQ0FBQztJQUVPLHdCQUF3QixDQUFDLEtBQWM7UUFDN0MsSUFBSSxLQUFLLEtBQUssU0FBUyxFQUFFLENBQUM7WUFDeEIsT0FBTyxnQkFBZ0IsQ0FBQyxPQUFPLENBQUE7UUFDakMsQ0FBQztRQUVELElBQUksS0FBSyxJQUFJLENBQUMsSUFBSSxLQUFLLElBQUksRUFBRSxFQUFFLENBQUM7WUFDOUIsT0FBTyxnQkFBZ0IsQ0FBQyxRQUFRLENBQUE7UUFDbEMsQ0FBQztRQUVELElBQUksS0FBSyxJQUFJLENBQUMsRUFBRSxDQUFDO1lBQ2YsT0FBTyxnQkFBZ0IsQ0FBQyxJQUFJLENBQUE7UUFDOUIsQ0FBQztRQUVELElBQUksS0FBSyxJQUFJLENBQUMsRUFBRSxDQUFDO1lBQ2YsT0FBTyxnQkFBZ0IsQ0FBQyxNQUFNLENBQUE7UUFDaEMsQ0FBQztRQUVELElBQUksS0FBSyxJQUFJLEdBQUcsRUFBRSxDQUFDO1lBQ2pCLE9BQU8sZ0JBQWdCLENBQUMsR0FBRyxDQUFBO1FBQzdCLENBQUM7UUFFRCxJQUFJLEtBQUssSUFBSSxDQUFDLEVBQUUsQ0FBQztZQUNmLE9BQU8sZ0JBQWdCLENBQUMsSUFBSSxDQUFBO1FBQzlCLENBQUM7UUFFRCxNQUFNLENBQUMsSUFBSSxDQUFDLGdCQUFnQixLQUFLLDJDQUEyQyxDQUFDLENBQUE7UUFDN0UsT0FBTyxnQkFBZ0IsQ0FBQyxPQUFPLENBQUE7SUFDakMsQ0FBQztJQUVPLHFCQUFxQixDQUFDLEtBQWM7UUFDMUMsSUFBSSxLQUFLLEtBQUssU0FBUyxFQUFFLENBQUM7WUFDeEIsT0FBTyxhQUFhLENBQUMsT0FBTyxDQUFBO1FBQzlCLENBQUM7UUFFRCxJQUFJLEtBQUssQ0FBQyxXQUFXLEVBQUUsS0FBSyxPQUFPLEVBQUUsQ0FBQztZQUNwQyxPQUFPLGFBQWEsQ0FBQyxLQUFLLENBQUE7UUFDNUIsQ0FBQztRQUVELElBQUksS0FBSyxDQUFDLFdBQVcsRUFBRSxLQUFLLFNBQVMsRUFBRSxDQUFDO1lBQ3RDLE9BQU8sYUFBYSxDQUFDLE9BQU8sQ0FBQTtRQUM5QixDQUFDO1FBRUQsSUFBSSxLQUFLLENBQUMsV0FBVyxFQUFFLEtBQUssTUFBTSxFQUFFLENBQUM7WUFDbkMsT0FBTyxhQUFhLENBQUMsSUFBSSxDQUFBO1FBQzNCLENBQUM7UUFFRCxNQUFNLENBQUMsSUFBSSxDQUFDLGVBQWUsS0FBSyx1Q0FBdUMsQ0FBQyxDQUFBO1FBQ3hFLE9BQU8sYUFBYSxDQUFDLE9BQU8sQ0FBQTtJQUM5QixDQUFDO0lBRU8sd0JBQXdCLENBQUMsR0FBUTtRQUN2QyxNQUFNLE9BQU8sR0FBYSxHQUFHLENBQUMsT0FBTyxJQUFJLEVBQUUsQ0FBQTtRQUMzQyxLQUFLLE1BQU0sTUFBTSxJQUFJLE9BQU8sRUFBRSxDQUFDO1lBQzdCLE1BQU0sUUFBUSxHQUFxQixJQUFJLENBQUMsd0JBQXdCLENBQzlELDBCQUEwQixDQUFDLEdBQUcsRUFBRSxNQUFNLEVBQUUsbUJBQW1CLENBQUMsQ0FDN0QsQ0FBQTtZQUNELE1BQU0sS0FBSyxHQUFXLElBQUksQ0FBQyxvQkFBb0IsQ0FBQyxHQUFHLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFBO1lBQ2xFLElBQUksQ0FBQyxvQkFBb0IsQ0FBQyxHQUFHLENBQUMsUUFBUSxFQUFFLEtBQUssR0FBRyxDQUFDLENBQUMsQ0FBQTtRQUNwRCxDQUFDO0lBQ0gsQ0FBQztJQUVPLG1CQUFtQixDQUFDLEdBQVEsRUFBRSxNQUFjO1FBQ2xELElBQUksTUFBTSxDQUFDLEtBQUssRUFBRSxDQUFDO1lBQ2pCLE9BQU8sTUFBTSxDQUFDLEtBQUssQ0FBQTtRQUNyQixDQUFDO1FBRUQsT0FBTywwQkFBMEIsQ0FBQyxHQUFHLEVBQUUsTUFBTSxFQUFFLGtCQUFrQixDQUFDLENBQUE7SUFDcEUsQ0FBQztJQUVPLHFCQUFxQixDQUFDLEdBQVE7UUFDcEMsTUFBTSxPQUFPLEdBQWEsR0FBRyxDQUFDLE9BQU8sSUFBSSxFQUFFLENBQUE7UUFDM0MsS0FBSyxNQUFNLE1BQU0sSUFBSSxPQUFPLEVBQUUsQ0FBQztZQUM3QixNQUFNLEtBQUssR0FBa0IsSUFBSSxDQUFDLHFCQUFxQixDQUNyRCxJQUFJLENBQUMsbUJBQW1CLENBQUMsR0FBRyxFQUFFLE1BQU0sQ0FBQyxDQUN0QyxDQUFBO1lBQ0QsTUFBTSxLQUFLLEdBQVcsSUFBSSxDQUFDLGlCQUFpQixDQUFDLEdBQUcsQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUE7WUFDNUQsSUFBSSxDQUFDLGlCQUFpQixDQUFDLEdBQUcsQ0FBQyxLQUFLLEVBQUUsS0FBSyxHQUFHLENBQUMsQ0FBQyxDQUFBO1FBQzlDLENBQUM7SUFDSCxDQUFDO0lBRUQsSUFBVyxtQkFBbUI7UUFDNUIsT0FBTyx1QkFBdUIsQ0FBQyxJQUFJLENBQUMsb0JBQW9CLENBQUMsQ0FBQTtJQUMzRCxDQUFDO0lBRUQsSUFBVyxnQkFBZ0I7UUFDekIsT0FBTyxvQkFBb0IsQ0FBQyxJQUFJLENBQUMsaUJBQWlCLENBQUMsQ0FBQTtJQUNyRCxDQUFDO0NBQ0YifQ==

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

@@ -1,278 +1,278 @@
-/**
- * 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, FooterType } from '@fabasoad/sarif-to-slack';
- *
- * const service = await SarifToSlackService.create({
- *   webhookUrl: 'https://hooks.slack.com/services/your/webhook/url',
- *   sarifPath: 'path/to/your/sarif/file.sarif',
- *   log: {
- *     level: LogLevel.Info,
- *     template: '[{{logLevelName}}] [{{name}}] {{dateIsoStr}} ',
- *     colored: false,
- *   },
- *   username: 'SARIF Bot',
- *   iconUrl: 'https://example.com/icon.png',
- *   color: '#36a64f',
- *   header: {
- *     include: true,
- *     value: 'SARIF Analysis Results'
- *   },
- *   footer: {
- *     include: true,
- *     type: FooterType.PLAIN_TEXT,
- *     value: 'Generated by @fabasoad/sarif-to-slack'
- *   },
- *   actor: {
- *     include: true,
- *     value: 'fabasoad'
- *   },
- *   run: {
- *     include: true
- *   },
- * });
- * await service.sendAll();
- * ```
- *
- * @see {@link SarifToSlackService}
- *
- * @packageDocumentation
- */
-
-import type { Log } from 'sarif';
-
-/**
- * Enum representing how to calculate results.
- * @public
- */
-export declare enum CalculateResultsBy {
-    /**
-     * Calculates results by the security level of the findings: Error, Warning,
-     * Note and Unknown. At first, it tries to get the security level from runs[].results[].level
-     * property. If it is not defined, it tries to get the security level from the
-     * respective rule of each result, using the rules[].properties['problem.severity']
-     * property.
-     */
-    Level = 0,
-    /**
-     * Calculates results by the security severity of the findings: Critical, High,
-     * Medium, Low, None and Unknown. it tries to get the security severity from the
-     * respective rule of each result, using the rules[].properties['security-severity']
-     * property. This property contains CVSS score, which is then mapped to the
-     * security severity value.
-     */
-    Severity = 1
-}
-
-/**
- * Options for the footer of a Slack message. "type" is ignored if "value" is
- * not defined.
- * @public
- */
-export declare type FooterOptions = IncludeAwareWithValueOptions & {
-    type?: FooterType;
-};
-
-/**
- * Enum representing the type of footer in a Slack message.
- * @public
- */
-export declare enum FooterType {
-    /**
-     * Represents a plain text footer. Text is not formatted and appears as-is.
-     */
-    PlainText = "plain_text",
-    /**
-     * Represents a footer with Markdown formatting. Text can include formatting
-     * such as bold, italics, and links.
-     */
-    Markdown = "mrkdwn"
-}
-
-/**
- * Enum representing how to group results.
- * @public
- */
-export declare enum GroupResultsBy {
-    /**
-     * Groups results by the tool name. Particularly, groups by the runs[].tool.driver.name
-     * property from the SARIF file(s).
-     */
-    ToolName = 0,
-    /**
-     * Groups results by the run. It provides the result from each run individually.
-     */
-    Run = 1,
-    /**
-     * Does not group results. It provides the result from all the runs from all
-     * the provided SARIF files.
-     */
-    Total = 2
-}
-
-/**
- * Type representing properties that indicate whether to include certain information
- * in the Slack message.
- * @public
- */
-export declare type IncludeAwareOptions = {
-    include: boolean;
-};
-
-/**
- * Type representing properties that indicate whether to include certain information
- * in the Slack message, along with an optional value.
- * @public
- */
-export declare type IncludeAwareWithValueOptions = IncludeAwareOptions & {
-    value?: string;
-};
-
-/**
- * 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
-}
-
-/**
- * Options for logging.
- * @public
- */
-export declare type LogOptions = {
-    level?: LogLevel;
-    /**
-     * More details here: https://github.com/fullstack-build/tslog?tab=readme-ov-file#pretty-templates-and-styles-color-settings
-     */
-    template?: string;
-    colored?: boolean;
-};
-
-/**
- * Type representing a SARIF log.
- * @public
- */
-export declare type SarifLog = Log;
-
-/**
- * Options for how to output the results in the Slack message.
- * @public
- */
-export declare type SarifToSlackOutput = {
-    groupBy?: GroupResultsBy;
-    calculateBy?: CalculateResultsBy;
-};
-
-/**
- * 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>;
-}
-
-/**
- * Options for the SarifToSlackService.
- * @public
- */
-export declare type SarifToSlackServiceOptions = {
-    webhookUrl: string;
-    sarifPath: string;
-    username?: string;
-    iconUrl?: string;
-    color?: string;
-    log?: LogOptions;
-    header?: IncludeAwareWithValueOptions;
-    footer?: FooterOptions;
-    actor?: IncludeAwareWithValueOptions;
-    run?: IncludeAwareOptions;
-    output?: SarifToSlackOutput;
-};
-
-/**
- * Interface for a Slack message that can be sent.
- * @public
- */
-export declare 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: SarifLog;
-}
-
-export { }
+/**
+ * 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, FooterType } from '@fabasoad/sarif-to-slack';
+ *
+ * const service = await SarifToSlackService.create({
+ *   webhookUrl: 'https://hooks.slack.com/services/your/webhook/url',
+ *   sarifPath: 'path/to/your/sarif/file.sarif',
+ *   log: {
+ *     level: LogLevel.Info,
+ *     template: '[{{logLevelName}}] [{{name}}] {{dateIsoStr}} ',
+ *     colored: false,
+ *   },
+ *   username: 'SARIF Bot',
+ *   iconUrl: 'https://example.com/icon.png',
+ *   color: '#36a64f',
+ *   header: {
+ *     include: true,
+ *     value: 'SARIF Analysis Results'
+ *   },
+ *   footer: {
+ *     include: true,
+ *     type: FooterType.PLAIN_TEXT,
+ *     value: 'Generated by @fabasoad/sarif-to-slack'
+ *   },
+ *   actor: {
+ *     include: true,
+ *     value: 'fabasoad'
+ *   },
+ *   run: {
+ *     include: true
+ *   },
+ * });
+ * await service.sendAll();
+ * ```
+ *
+ * @see {@link SarifToSlackService}
+ *
+ * @packageDocumentation
+ */
+
+import type { Log } from 'sarif';
+
+/**
+ * Enum representing how to calculate results.
+ * @public
+ */
+export declare enum CalculateResultsBy {
+    /**
+     * Calculates results by the security level of the findings: Error, Warning,
+     * Note and Unknown. At first, it tries to get the security level from runs[].results[].level
+     * property. If it is not defined, it tries to get the security level from the
+     * respective rule of each result, using the rules[].properties['problem.severity']
+     * property.
+     */
+    Level = 0,
+    /**
+     * Calculates results by the security severity of the findings: Critical, High,
+     * Medium, Low, None and Unknown. it tries to get the security severity from the
+     * respective rule of each result, using the rules[].properties['security-severity']
+     * property. This property contains CVSS score, which is then mapped to the
+     * security severity value.
+     */
+    Severity = 1
+}
+
+/**
+ * Options for the footer of a Slack message. "type" is ignored if "value" is
+ * not defined.
+ * @public
+ */
+export declare type FooterOptions = IncludeAwareWithValueOptions & {
+    type?: FooterType;
+};
+
+/**
+ * Enum representing the type of footer in a Slack message.
+ * @public
+ */
+export declare enum FooterType {
+    /**
+     * Represents a plain text footer. Text is not formatted and appears as-is.
+     */
+    PlainText = "plain_text",
+    /**
+     * Represents a footer with Markdown formatting. Text can include formatting
+     * such as bold, italics, and links.
+     */
+    Markdown = "mrkdwn"
+}
+
+/**
+ * Enum representing how to group results.
+ * @public
+ */
+export declare enum GroupResultsBy {
+    /**
+     * Groups results by the tool name. Particularly, groups by the runs[].tool.driver.name
+     * property from the SARIF file(s).
+     */
+    ToolName = 0,
+    /**
+     * Groups results by the run. It provides the result from each run individually.
+     */
+    Run = 1,
+    /**
+     * Does not group results. It provides the result from all the runs from all
+     * the provided SARIF files.
+     */
+    Total = 2
+}
+
+/**
+ * Type representing properties that indicate whether to include certain information
+ * in the Slack message.
+ * @public
+ */
+export declare type IncludeAwareOptions = {
+    include: boolean;
+};
+
+/**
+ * Type representing properties that indicate whether to include certain information
+ * in the Slack message, along with an optional value.
+ * @public
+ */
+export declare type IncludeAwareWithValueOptions = IncludeAwareOptions & {
+    value?: string;
+};
+
+/**
+ * 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
+}
+
+/**
+ * Options for logging.
+ * @public
+ */
+export declare type LogOptions = {
+    level?: LogLevel;
+    /**
+     * More details here: https://github.com/fullstack-build/tslog?tab=readme-ov-file#pretty-templates-and-styles-color-settings
+     */
+    template?: string;
+    colored?: boolean;
+};
+
+/**
+ * Type representing a SARIF log.
+ * @public
+ */
+export declare type SarifLog = Log;
+
+/**
+ * Options for how to output the results in the Slack message.
+ * @public
+ */
+export declare type SarifToSlackOutput = {
+    groupBy?: GroupResultsBy;
+    calculateBy?: CalculateResultsBy;
+};
+
+/**
+ * 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>;
+}
+
+/**
+ * Options for the SarifToSlackService.
+ * @public
+ */
+export declare type SarifToSlackServiceOptions = {
+    webhookUrl: string;
+    sarifPath: string;
+    username?: string;
+    iconUrl?: string;
+    color?: string;
+    log?: LogOptions;
+    header?: IncludeAwareWithValueOptions;
+    footer?: FooterOptions;
+    actor?: IncludeAwareWithValueOptions;
+    run?: IncludeAwareOptions;
+    output?: SarifToSlackOutput;
+};
+
+/**
+ * Interface for a Slack message that can be sent.
+ * @public
+ */
+export declare 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: SarifLog;
+}
+
+export { }

package/dist/tsdoc-metadata.json

@@ -1,11 +1,11 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.52.9"
-    }
-  ]
-}
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.52.9"
+    }
+  ]
+}