@fabasoad/sarif-to-slack 1.3.1 → 1.3.3

package/dist/utils/StringUtils.d.ts

@@ -0,0 +1,2 @@
+export declare function randomAlphabetic(length: number): string;
+//# sourceMappingURL=StringUtils.d.ts.map

package/dist/utils/StringUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StringUtils.d.ts","sourceRoot":"","sources":["../../src/utils/StringUtils.ts"],"names":[],"mappings":"AAAA,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAMvD"}

package/dist/utils/StringUtils.js

@@ -0,0 +1,5 @@
+export function randomAlphabetic(length) {
+    const alphabet = 'abcdefghijklmnopqrstuvwxyz';
+    return Array.from({ length }, () => alphabet[Math.floor(Math.random() * alphabet.length)]).join('');
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiU3RyaW5nVXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdXRpbHMvU3RyaW5nVXRpbHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsTUFBTSxVQUFVLGdCQUFnQixDQUFDLE1BQWM7SUFDN0MsTUFBTSxRQUFRLEdBQUcsNEJBQTRCLENBQUE7SUFDN0MsT0FBTyxLQUFLLENBQUMsSUFBSSxDQUNmLEVBQUUsTUFBTSxFQUFFLEVBQ1YsR0FBVyxFQUFFLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxHQUFHLFFBQVEsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUNwRSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQTtBQUNaLENBQUMifQ==

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

@@ -60,24 +60,6 @@ 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,
@@ -87,7 +69,13 @@ export enum RepresentationType {
     CompactGroupByToolNamePerLevel = 2,
     CompactGroupByToolNamePerSeverity = 3,
     CompactTotalPerLevel = 6,
-    CompactTotalPerSeverity = 7
+    CompactTotalPerSeverity = 7,
+    TableGroupByRunPerLevel = 8,
+    TableGroupByRunPerSeverity = 9,
+    TableGroupBySarifPerLevel = 12,
+    TableGroupBySarifPerSeverity = 13,
+    TableGroupByToolNamePerLevel = 10,
+    TableGroupByToolNamePerSeverity = 11
 }
 
 // @public
@@ -102,19 +90,16 @@ export type SarifOptions = {
 
 // @public
 export class SarifToSlackClient {
-    // (undocumented)
-    static create(opts: SarifToSlackClientOptions): Promise<SarifToSlackClient>;
+    static create(webhookUrl: string, opts: SarifToSlackClientOptions): Promise<SarifToSlackClient>;
     send(): Promise<void>;
 }
 
 // @public
 export type SarifToSlackClientOptions = {
-    webhookUrl: string;
     sarif: SarifOptions;
     username?: string;
     iconUrl?: string;
     color?: ColorOptions;
-    log?: LogOptions;
     header?: IncludeAwareWithValueOptions;
     footer?: FooterOptions;
     actor?: IncludeAwareWithValueOptions;
@@ -151,17 +136,4 @@ export enum SendIf {
     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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fabasoad/sarif-to-slack",
-  "version": "1.3.1",
+  "version": "1.3.3",
   "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.6",
     "@types/sarif": "2.1.7",
-    "tslog": "4.9.3"
+    "tslog": "4.10.2",
+    "zod": "4.1.12"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.2.2",
-    "@microsoft/api-documenter": "7.26.32",
-    "@microsoft/api-extractor": "7.52.11",
+    "@biomejs/biome": "2.2.5",
+    "@microsoft/api-documenter": "7.26.36",
+    "@microsoft/api-extractor": "7.52.15",
     "@types/jest": "30.0.0",
-    "@types/uuid": "10.0.0",
-    "jest": "30.0.5",
-    "jest-circus": "30.0.5",
-    "ts-jest": "29.4.1",
+    "jest": "30.2.0",
+    "jest-circus": "30.2.0",
+    "ts-jest": "29.4.4",
     "tsup": "8.5.0",
-    "typescript": "5.9.2"
+    "typescript": "5.9.3"
   }
 }

package/src/Logger.ts

@@ -1,43 +1,81 @@
-import { ILogObj, Logger as TSLogger } from 'tslog'
-import { LogLevel, LogOptions } from './types'
+import { type ILogObj, Logger as TSLogger } from 'tslog'
+import { z, type ZodSafeParseResult } from 'zod';
+import { isDebug } from './system';
+
+const LogLevelItems = ['silly', 'trace', 'debug', 'info', 'warning', 'error', 'fatal'] as const;
+type LogLevel = (typeof LogLevelItems)[number];
 
 /**
  * Logger class for managing logging operations.
  * @internal
  */
 export default class Logger {
-  private static DEFAULT_LOG_LEVEL: LogLevel = LogLevel.Info
-  private static DEFAULT_LOG_TEMPLATE: string = '[{{logLevelName}}] [{{name}}] {{dateIsoStr}} '
-  private static DEFAULT_LOG_COLORED: boolean = true
-
-  private static instance: TSLogger<ILogObj>
-
-  public static initialize(opts?: LogOptions): void {
-    if (!Logger.instance) {
-      Logger.instance = new TSLogger({
-        name: '@fabasoad/sarif-to-slack',
-        minLevel: process.env.ACTIONS_STEP_DEBUG === 'true' ? LogLevel.Silly : (opts?.level ?? Logger.DEFAULT_LOG_LEVEL),
-        type: 'pretty',
-        prettyLogTimeZone: 'UTC',
-        prettyLogTemplate: opts?.template ?? Logger.DEFAULT_LOG_TEMPLATE,
-        stylePrettyLogs: opts?.colored ?? Logger.DEFAULT_LOG_COLORED,
-      })
+  private static APP_NAME: string = '@fabasoad/sarif-to-slack';
+  private static DEFAULT_LOG_LEVEL: LogLevel = 'info';
+  private static DEFAULT_LOG_TEMPLATE: string = '[{{logLevelName}}] [{{name}}] {{dateIsoStr}} ';
+  private static DEFAULT_LOG_COLORED: boolean = true;
+
+  private readonly _instance: TSLogger<ILogObj>;
+
+  private isLogLevel(v: string): v is LogLevel {
+    return (LogLevelItems as ReadonlyArray<string>).includes(v);
+  }
+
+  private getMinLevel(): number {
+    let result: LogLevel = Logger.DEFAULT_LOG_LEVEL;
+
+    if (isDebug()) {
+      result = 'silly';
+    } else {
+      const parseResult: ZodSafeParseResult<LogLevel> = z
+        .string()
+        .refine((v: string): boolean => this.isLogLevel(v))
+        .transform((v: string): LogLevel => v as LogLevel)
+        .safeParse(process.env.SARIF_TO_SLACK_LOG_LEVEL);
+      if (parseResult.success) {
+        result = parseResult.data;
+      }
     }
+
+    return LogLevelItems.findIndex((v: LogLevel): boolean => v === result);
+  }
+
+  private getLogTemplate(): string {
+    const result: ZodSafeParseResult<string> =
+      z.string().safeParse(process.env.SARIF_TO_SLACK_LOG_TEMPLATE);
+    return result.success ? result.data : Logger.DEFAULT_LOG_TEMPLATE;
+  }
+
+  private getLogColored(): boolean {
+    const result: ZodSafeParseResult<boolean> =
+      z.stringbool().safeParse(process.env.SARIF_TO_SLACK_LOG_COLORED);
+    return result.success ? result.data : Logger.DEFAULT_LOG_COLORED;
+  }
+
+  public constructor(memberName?: string) {
+    this._instance = new TSLogger({
+      name: `${Logger.APP_NAME}${memberName === undefined ? '' : `::${memberName}`}`,
+      minLevel: this.getMinLevel(),
+      type: 'pretty',
+      prettyLogTimeZone: 'UTC',
+      prettyLogTemplate: this.getLogTemplate(),
+      stylePrettyLogs: this.getLogColored(),
+    })
   }
 
-  public static warn(...args: unknown[]): void {
-    Logger.instance.warn(...args)
+  public info(...args: unknown[]): void {
+    this._instance.info(...args);
   }
 
-  public static info(...args: unknown[]): void {
-    Logger.instance.info(...args)
+  public warn(...args: unknown[]): void {
+    this._instance.warn(...args);
   }
 
-  public static debug(...args: unknown[]): void {
-    Logger.instance.debug(...args)
+  public trace(...args: unknown[]): void {
+    this._instance.trace(...args);
   }
 
-  public static trace(...args: unknown[]): void {
-    Logger.instance.trace(...args)
+  public debug(...args: unknown[]): void {
+    this._instance.debug(...args);
   }
 }

package/src/SarifToSlackClient.ts

@@ -1,23 +1,22 @@
-import { promises as fs } from 'fs'
-import { Log } from 'sarif'
+import { promises as fs } from 'node:fs'
+import type { Log } from 'sarif'
 import Logger from './Logger'
 import {
-  LogOptions,
-  RunData,
-  SarifModel,
-  SarifOptions,
-  SarifToSlackClientOptions,
+  type RunData,
+  type SarifModel,
+  type SarifOptions,
+  type SarifToSlackClientOptions,
   SecurityLevel,
   SecuritySeverity
 } from './types'
-import System from './System'
+import { logMetadata } from './system'
 import { extractListOfFiles } from './utils/FileUtils'
 import { createRepresentation } from './representations/RepresentationFactory'
 import { createFinding } from './model/Finding'
 import { findToolComponent, findToolComponentDriver } from './utils/SarifUtils'
 import { identifyColor } from './model/color/ColorIdentification'
 import FindingArray from './model/FindingArray'
-import { createSlackMessage, SlackMessage } from './model/SlackMessage'
+import { createSlackMessage, type SlackMessage } from './model/SlackMessage'
 import { SendIf, sendIfLogMessage } from './model/SendIf'
 
 /**
@@ -25,29 +24,40 @@ import { SendIf, sendIfLogMessage } from './model/SendIf'
  * @public
  */
 export class SarifToSlackClient {
-  private _message?: SlackMessage
-  private _sarifModel?: SarifModel
+  private readonly _logger = new Logger('SarifToSlackClient');
+  private _message?: SlackMessage;
+  private _sarifModel?: SarifModel;
 
-  private _sendIf: SendIf = SendIf.Always
+  private _sendIf: SendIf = SendIf.Always;
 
-  private constructor(log?: LogOptions) {
-    Logger.initialize(log)
-    System.initialize()
+  private constructor() {
+    logMetadata();
   }
 
   private static *createRunIdGenerator(): Generator<number> {
-    let runId: number = 1
+    let runId: number = 1;
     while (true) {
-      yield runId++
+      yield runId++;
     }
   }
 
-  public static async create(opts: SarifToSlackClientOptions): Promise<SarifToSlackClient> {
-    const instance = new SarifToSlackClient(opts.log)
-    instance._sendIf = opts.sendIf ?? instance._sendIf
-    instance._sarifModel = await SarifToSlackClient.buildModel(opts.sarif)
-    instance._message = await SarifToSlackClient.initialize(instance._sarifModel, opts)
-    return instance
+  /**
+   * Creates an instance of {@link SarifToSlackClient} class. It already has all
+   * properties and fields initialized.
+   * @param webhookUrl - Slack webhook URL.
+   * @param opts - An instance of {@link SarifToSlackClientOptions} type.
+   *
+   * @see SarifToSlackClientOptions
+   *
+   * @public
+   */
+  public static async create(webhookUrl: string, opts: SarifToSlackClientOptions): Promise<SarifToSlackClient> {
+    const instance = new SarifToSlackClient();
+    instance._logger.trace(opts);
+    instance._sendIf = opts.sendIf ?? instance._sendIf;
+    instance._sarifModel = await SarifToSlackClient.buildModel(opts.sarif);
+    instance._message = await SarifToSlackClient.initialize(webhookUrl, opts, instance._sarifModel);
+    return instance;
   }
 
   private static async buildModel(sarifOpts: SarifOptions): Promise<SarifModel> {
@@ -64,7 +74,7 @@ export class SarifToSlackClient {
 
       for (const run of sarifLog.runs) {
         const runId: IteratorResult<number> = runIdGenerator.next()
-        let runMetadata: RunData | undefined = undefined
+        let runMetadata: RunData | undefined
         for (const result of run.results ?? []) {
           runMetadata = {
             id: runId.value,
@@ -85,16 +95,19 @@ export class SarifToSlackClient {
   /**
    * The main function to initialize a list of {@link SlackMessage} objects based
    * on the given SARIF file(s).
-   * @param sarifModel - An instance of SarifModel object.
+   * @param webhookUrl - Slack webhook URL.
    * @param opts - An instance of {@link SarifToSlackClientOptions} object.
+   * @param sarifModel - An instance of SarifModel object.
    * @returns A map where key is the SARIF file and value is an instance of
    * {@link SlackMessage} object.
+   * @internal
    */
   private static async initialize(
+    webhookUrl: string,
+    opts: SarifToSlackClientOptions,
     sarifModel: SarifModel,
-    opts: Omit<SarifToSlackClientOptions, 'sarif' | 'log' | 'sendIf'>
   ): Promise<SlackMessage> {
-    const message: SlackMessage = createSlackMessage(opts.webhookUrl, {
+    const message: SlackMessage = createSlackMessage(webhookUrl, {
       username: opts.username,
       iconUrl: opts.iconUrl,
       color: identifyColor(sarifModel.findings, opts.color),
@@ -130,9 +143,9 @@ export class SarifToSlackClient {
         throw new Error('Slack message was not prepared.')
       }
       const text: string = await this._message.send()
-      Logger.info('Message sent. Status:', text)
+      this._logger.info('Message sent. Status:', text)
     } else {
-      Logger.info(sendIfLogMessage(this._sendIf))
+      this._logger.info(sendIfLogMessage(this._sendIf))
     }
   }
 

package/src/index.ts

@@ -12,7 +12,6 @@
  * import {
  *   Color,
  *   FooterType,
- *   LogLevel,
  *   RepresentationType,
  *   SarifToSlackClient,
  *   SendIf
@@ -46,11 +45,6 @@
  *     recursive: true,
  *     extension: 'sarif',
  *   },
- *   log: {
- *     level: LogLevel.Info,
- *     template: '[{{logLevelName}}] [{{name}}] {{dateIsoStr}} ',
- *     colored: false,
- *   },
  *   header: {
  *     include: true,
  *     value: 'SARIF Analysis Results'
@@ -85,15 +79,12 @@ export {
   ColorGroupBySeverity
 } from './model/color/ColorOptions'
 export { SendIf } from './model/SendIf'
-export { SlackMessage } from './model/SlackMessage'
 export { SarifToSlackClient } from './SarifToSlackClient'
 export {
   FooterOptions,
   FooterType,
   IncludeAwareOptions,
   IncludeAwareWithValueOptions,
-  LogLevel,
-  LogOptions,
   RepresentationType,
   SarifFileExtension,
   SarifOptions,

package/src/model/Finding.ts

@@ -1,7 +1,7 @@
 import type { ReportingDescriptor, Result } from 'sarif'
-import { RunData, SecurityLevel, SecuritySeverity } from '../types'
+import { type RunData, SecurityLevel, SecuritySeverity } from '../types'
 import Logger from '../Logger'
-import { CommonProcessor } from '../processors/CommonProcessor'
+import type { CommonProcessor } from '../processors/CommonProcessor'
 import { createProcessor } from '../processors/ProcessorFactory'
 
 /**
@@ -43,17 +43,18 @@ export function createFinding(opts: FindingOptions): Finding {
  * @private
  */
 class FindingImpl implements Finding {
-  private readonly _runMetadata: RunData
-  private readonly _result: Result
-  private readonly _sarifPath: string
-  private readonly _rule?: ReportingDescriptor
-  private readonly _processor: CommonProcessor
+  private readonly _logger = new Logger('FindingImpl');
+  private readonly _runMetadata: RunData;
+  private readonly _result: Result;
+  private readonly _sarifPath: string;
+  private readonly _rule?: ReportingDescriptor;
+  private readonly _processor: CommonProcessor;
 
-  private _cvssScoreCacheProcessed: boolean = false
-  private _cvssScoreCache: number | undefined = undefined
+  private _cvssScoreCacheProcessed: boolean = false;
+  private _cvssScoreCache: number | undefined = undefined;
 
-  private _levelCacheProcessed: boolean = false
-  private _levelCache: Result.level | undefined = undefined
+  private _levelCacheProcessed: boolean = false;
+  private _levelCache: Result.level | undefined = undefined;
 
   constructor(opts: FindingOptions) {
     this._processor = createProcessor(opts.runMetadata.run, opts.result)
@@ -98,7 +99,7 @@ class FindingImpl implements Finding {
     }
 
     if (this._levelCache === undefined) {
-      Logger.debug(`Unknown level of ${this._rule?.id} rule`)
+      this._logger.debug(`Unknown level of ${this._rule?.id} rule`)
       return SecurityLevel.Unknown
     }
 
@@ -112,7 +113,7 @@ class FindingImpl implements Finding {
 
   public get severity(): SecuritySeverity {
     if (this.cvssScore == null || this.cvssScore < 0 || this.cvssScore > 10) {
-      Logger.debug(`Unsupported CVSS score ${this.cvssScore} in ${this._rule?.id} rule`)
+      this._logger.debug(`Unsupported CVSS score ${this.cvssScore} in ${this._rule?.id} rule`)
       return SecuritySeverity.Unknown
     }
 

package/src/model/FindingArray.ts

@@ -1,4 +1,4 @@
-import Finding from './Finding'
+import type Finding from './Finding'
 import { SecurityLevel, SecuritySeverity } from '../types'
 import ExtendedArray from '../utils/ExtendedArray'
 

package/src/model/SlackMessage.ts

@@ -1,9 +1,9 @@
-import { AnyBlock } from '@slack/types'
-import { ContextBlock, HeaderBlock } from '@slack/types/dist/block-kit/blocks'
-import { TextObject } from '@slack/types/dist/block-kit/composition-objects'
+import type { AnyBlock } from '@slack/types'
+import type { ContextBlock, HeaderBlock } from '@slack/types/dist/block-kit/blocks'
+import type { TextObject } from '@slack/types/dist/block-kit/composition-objects'
 import { IncomingWebhook } from '@slack/webhook'
 import { FooterType } from '../types'
-import Representation from '../representations/Representation'
+import type Representation from '../representations/Representation'
 import { version } from '../metadata.json'
 
 /**
@@ -19,7 +19,7 @@ export type SlackMessageOptions = {
 
 /**
  * Interface for a Slack message that can be sent.
- * @public
+ * @internal
  */
 export interface SlackMessage {
   /**