@fabasoad/sarif-to-slack 0.2.5 → 1.1.0

package/dist/index.d.ts

@@ -2,24 +2,45 @@
  * Sarif to Slack message converter library.
  *
  * @remarks
- * This library provides a service to send a Slack messages based on the provided
+ * This library provides a client 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';
+ * import {
+ *   Color,
+ *   FooterType,
+ *   LogLevel,
+ *   RepresentationType,
+ *   SarifToSlackClient,
+ *   SendIf
+ * } from '@fabasoad/sarif-to-slack';
  *
- * const service = await SarifToSlackService.create({
+ * const client: SarifToSlackClient = await SarifToSlackClient.create({
  *   webhookUrl: 'https://hooks.slack.com/services/your/webhook/url',
- *   sarifPath: 'path/to/your/sarif/file.sarif',
+ *   username: 'SARIF to Slack Bot',
+ *   iconUrl: 'https://example.com/icon.png',
+ *   color: {
+ *     bySeverity: {
+ *       critical: new Color('#ff0000'),
+ *       high: new Color('#ff4500'),
+ *       medium: new Color('#ffa500'),
+ *       low: new Color('#ffff00'),
+ *       none: new Color('#808080'),
+ *       unknown: new Color('#800080'),
+ *       empty: new Color('#d3d3d3'),
+ *     },
+ *   },
+ *   sarif: {
+ *     path: 'path/to/your/sarif-files',
+ *     recursive: true,
+ *     extension: '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'
@@ -36,15 +57,17 @@
  *   run: {
  *     include: true
  *   },
+ *   representation: RepresentationType.CompactGroupByToolNamePerSeverity,
+ *   sendIf: SendIf.MediumOrHigher,
  * });
- * await service.sendAll();
+ * await client.send();
  * ```
  *
- * @see {@link SarifToSlackService}
+ * @see {@link SarifToSlackClient}
  *
  * @packageDocumentation
  */
-export { SarifToSlackService } from './SarifToSlackService';
-export { CalculateResultsBy, FooterType, GroupResultsBy, LogLevel, SlackMessage } from './types';
-export type { FooterOptions, IncludeAwareOptions, IncludeAwareWithValueOptions, LogOptions, SarifLog, SarifToSlackOutput, SarifToSlackServiceOptions } from './types';
+export { Color, ColorOptions, ColorGroupByLevel, ColorGroupBySeverity } from './model/Color';
+export { SarifToSlackClient } from './SarifToSlackClient';
+export { FooterOptions, FooterType, IncludeAwareOptions, IncludeAwareWithValueOptions, LogLevel, LogOptions, RepresentationType, SarifFileExtension, SarifOptions, SarifToSlackClientOptions, SendIf, SlackMessage, } from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EACL,kBAAkB,EAClB,UAAU,EACV,cAAc,EACd,QAAQ,EACR,YAAY,EACb,MAAM,SAAS,CAAA;AAChB,YAAY,EACV,aAAa,EACb,mBAAmB,EACnB,4BAA4B,EAC5B,UAAU,EACV,QAAQ,EACR,kBAAkB,EAClB,0BAA0B,EAC3B,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,OAAO,EACL,KAAK,EACL,YAAY,EACZ,iBAAiB,EACjB,oBAAoB,EACrB,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EACL,aAAa,EACb,UAAU,EACV,mBAAmB,EACnB,4BAA4B,EAC5B,QAAQ,EACR,UAAU,EACV,kBAAkB,EAClB,kBAAkB,EAClB,YAAY,EACZ,yBAAyB,EACzB,MAAM,EACN,YAAY,GACb,MAAM,SAAS,CAAA"}

package/dist/index.js

@@ -3,24 +3,45 @@
  * Sarif to Slack message converter library.
  *
  * @remarks
- * This library provides a service to send a Slack messages based on the provided
+ * This library provides a client 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';
+ * import {
+ *   Color,
+ *   FooterType,
+ *   LogLevel,
+ *   RepresentationType,
+ *   SarifToSlackClient,
+ *   SendIf
+ * } from '@fabasoad/sarif-to-slack';
  *
- * const service = await SarifToSlackService.create({
+ * const client: SarifToSlackClient = await SarifToSlackClient.create({
  *   webhookUrl: 'https://hooks.slack.com/services/your/webhook/url',
- *   sarifPath: 'path/to/your/sarif/file.sarif',
+ *   username: 'SARIF to Slack Bot',
+ *   iconUrl: 'https://example.com/icon.png',
+ *   color: {
+ *     bySeverity: {
+ *       critical: new Color('#ff0000'),
+ *       high: new Color('#ff4500'),
+ *       medium: new Color('#ffa500'),
+ *       low: new Color('#ffff00'),
+ *       none: new Color('#808080'),
+ *       unknown: new Color('#800080'),
+ *       empty: new Color('#d3d3d3'),
+ *     },
+ *   },
+ *   sarif: {
+ *     path: 'path/to/your/sarif-files',
+ *     recursive: true,
+ *     extension: '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'
@@ -37,14 +58,17 @@
  *   run: {
  *     include: true
  *   },
+ *   representation: RepresentationType.CompactGroupByToolNamePerSeverity,
+ *   sendIf: SendIf.MediumOrHigher,
  * });
- * await service.sendAll();
+ * await client.send();
  * ```
  *
- * @see {@link SarifToSlackService}
+ * @see {@link SarifToSlackClient}
  *
  * @packageDocumentation
  */
-export { SarifToSlackService } from './SarifToSlackService';
-export { CalculateResultsBy, FooterType, GroupResultsBy, LogLevel } from './types';
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsMEZBQTBGO0FBRTFGOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0E2Q0c7QUFDSCxPQUFPLEVBQUUsbUJBQW1CLEVBQUUsTUFBTSx1QkFBdUIsQ0FBQTtBQUMzRCxPQUFPLEVBQ0wsa0JBQWtCLEVBQ2xCLFVBQVUsRUFDVixjQUFjLEVBQ2QsUUFBUSxFQUVULE1BQU0sU0FBUyxDQUFBIn0=
+export { Color } from './model/Color';
+export { SarifToSlackClient } from './SarifToSlackClient';
+export { FooterType, LogLevel, RepresentationType, SendIf, } from './types';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsMEZBQTBGO0FBRTFGOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQW9FRztBQUNILE9BQU8sRUFDTCxLQUFLLEVBSU4sTUFBTSxlQUFlLENBQUE7QUFDdEIsT0FBTyxFQUFFLGtCQUFrQixFQUFFLE1BQU0sc0JBQXNCLENBQUE7QUFDekQsT0FBTyxFQUVMLFVBQVUsRUFHVixRQUFRLEVBRVIsa0JBQWtCLEVBSWxCLE1BQU0sR0FFUCxNQUFNLFNBQVMsQ0FBQSJ9

package/dist/model/Color.d.ts

@@ -0,0 +1,80 @@
+/**
+ * This class represents a color in hex format.
+ * @public
+ */
+export declare class Color {
+    private readonly _color?;
+    /**
+     * Creates an instance of {@link Color} class. Before creating an instance of
+     * {@link Color} class, it (if applicable) maps CI status into the hex color,
+     * and also validates {@param color} to be a valid string that represents a
+     * color in hex format.
+     * @param color Can be either undefined, valid color in hex format or GitHub
+     * CI status (one of: success, failure, cancelled, skipped)
+     * @public
+     */
+    constructor(color?: string);
+    /**
+     * Returns a valid string that represents a color in hex format, or undefined.
+     */
+    get value(): string | undefined;
+    private validateHexColor;
+    private mapColor;
+}
+/**
+ * Base type that has common fields for both {@link ColorGroupByLevel} and
+ * {@link ColorGroupBySeverity}.
+ * @private
+ */
+type ColorGroupCommon = {
+    none?: Color;
+    unknown?: Color;
+    empty?: Color;
+};
+/**
+ * Color schema for the findings with the certain level. Color is used by the
+ * level importance, i.e. if at least 1 error finding exists then
+ * {@link ColorGroupByLevel.error} color is used, then if at least 1 warning
+ * finding exists then {@link ColorGroupByLevel.warning} color is used, etc.
+ * @public
+ */
+export type ColorGroupByLevel = ColorGroupCommon & {
+    error?: Color;
+    warning?: Color;
+    note?: Color;
+};
+/**
+ * Color schema for the findings with the certain severity. Color is used by the
+ * severity importance, i.e. if at least 1 critical finding exists then
+ * {@link ColorGroupBySeverity.critical} color is used, then if at least 1 high
+ * finding exists then {@link ColorGroupBySeverity.high} color is used, etc.
+ * @public
+ */
+export type ColorGroupBySeverity = ColorGroupCommon & {
+    critical?: Color;
+    high?: Color;
+    medium?: Color;
+    low?: Color;
+};
+/**
+ * Represents configuration of the color scheme. If both {@link ColorOptions.byLevel}
+ * and {@link ColorOptions.bySeverity} are defined, then {@link ColorOptions.bySeverity}
+ * takes precedence.
+ * @public
+ */
+export type ColorOptions = {
+    /**
+     * Default color if specific color was not found. It is a fallback option.
+     */
+    default?: Color;
+    /**
+     * Color scheme for the findings where certain level is presented.
+     */
+    byLevel?: ColorGroupByLevel;
+    /**
+     * Color scheme for the findings where certain severity is presented.
+     */
+    bySeverity?: ColorGroupBySeverity;
+};
+export {};
+//# sourceMappingURL=Color.d.ts.map

package/dist/model/Color.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Color.d.ts","sourceRoot":"","sources":["../../src/model/Color.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,qBAAa,KAAK;IAChB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAQ;IAEhC;;;;;;;;OAQG;gBACgB,KAAK,CAAC,EAAE,MAAM;IAKjC;;OAEG;IACH,IAAW,KAAK,IAAI,MAAM,GAAG,SAAS,CAErC;IAED,OAAO,CAAC,gBAAgB;IAUxB,OAAO,CAAC,QAAQ;CAcjB;AAED;;;;GAIG;AACH,KAAK,gBAAgB,GAAG;IACtB,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG,gBAAgB,GAAG;IACjD,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,IAAI,CAAC,EAAE,KAAK,CAAC;CACd,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG;IACpD,QAAQ,CAAC,EAAE,KAAK,CAAC;IACjB,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,MAAM,CAAC,EAAE,KAAK,CAAC;IACf,GAAG,CAAC,EAAE,KAAK,CAAC;CACb,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,oBAAoB,CAAC;CACnC,CAAA"}

package/dist/model/Color.js

@@ -0,0 +1,106 @@
+import { SecurityLevel, SecuritySeverity } from '../types';
+/**
+ * This class represents a color in hex format.
+ * @public
+ */
+export class Color {
+    _color;
+    /**
+     * Creates an instance of {@link Color} class. Before creating an instance of
+     * {@link Color} class, it (if applicable) maps CI status into the hex color,
+     * and also validates {@param color} to be a valid string that represents a
+     * color in hex format.
+     * @param color Can be either undefined, valid color in hex format or GitHub
+     * CI status (one of: success, failure, cancelled, skipped)
+     * @public
+     */
+    constructor(color) {
+        this._color = this.mapColor(color);
+        this.validateHexColor();
+    }
+    /**
+     * Returns a valid string that represents a color in hex format, or undefined.
+     */
+    get value() {
+        return this._color;
+    }
+    validateHexColor() {
+        if (this._color != null) {
+            const hexColorRegex = /^#(?:[0-9A-Fa-f]{3}|[0-9A-Fa-f]{4}|[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$/;
+            if (!hexColorRegex.test(this._color)) {
+                throw new Error(`Invalid hex color: "${this._color}"`);
+            }
+        }
+    }
+    mapColor(from) {
+        switch (from) {
+            case 'success':
+                return '#008000';
+            case 'failure':
+                return '#ff0000';
+            case 'cancelled':
+                return '#0047ab';
+            case 'skipped':
+                return '#808080';
+            default:
+                return from;
+        }
+    }
+}
+function identifyColorCommon(findings, prop, none, unknown, color, defaultColor) {
+    if (color.none != null && findings.findByProperty(prop, none) != null) {
+        return color.none.value;
+    }
+    if (color.unknown != null && findings.findByProperty(prop, unknown) != null) {
+        return color.unknown.value;
+    }
+    if (color.empty != null && findings.length === 0) {
+        return color.empty.value;
+    }
+    return defaultColor?.value;
+}
+function identifyColorBySeverity(findings, color, defaultColor) {
+    if (color.critical != null && findings.findByProperty('severity', SecuritySeverity.Critical) != null) {
+        return color.critical.value;
+    }
+    if (color.high != null && findings.findByProperty('severity', SecuritySeverity.High) != null) {
+        return color.high.value;
+    }
+    if (color.medium != null && findings.findByProperty('severity', SecuritySeverity.Medium) != null) {
+        return color.medium.value;
+    }
+    if (color.low != null && findings.findByProperty('severity', SecuritySeverity.Low) != null) {
+        return color.low.value;
+    }
+    return identifyColorCommon(findings, 'severity', SecuritySeverity.None, SecuritySeverity.Unknown, color, defaultColor);
+}
+function identifyColorByLevel(findings, color, defaultColor) {
+    if (color.error != null && findings.findByProperty('level', SecurityLevel.Error) != null) {
+        return color.error.value;
+    }
+    if (color.warning != null && findings.findByProperty('level', SecurityLevel.Warning) != null) {
+        return color.warning.value;
+    }
+    if (color.note != null && findings.findByProperty('level', SecurityLevel.Note) != null) {
+        return color.note.value;
+    }
+    return identifyColorCommon(findings, 'level', SecurityLevel.None, SecurityLevel.Unknown, color, defaultColor);
+}
+/**
+ * Makes an ultimate decision on what color should be Slack message. The decision
+ * is based on the provided {@param colorOpts} parameter and {@param findings}
+ * list.
+ * @param findings An instance of {@link FindingsArray} object.
+ * @param colorOpts An instance of {@link ColorOptions} type.
+ * @internal
+ */
+export function identifyColor(findings, colorOpts) {
+    if (colorOpts?.bySeverity != null) {
+        return identifyColorBySeverity(findings, colorOpts.bySeverity, colorOpts.default);
+    }
+    if (colorOpts?.byLevel != null) {
+        return identifyColorByLevel(findings, colorOpts.byLevel, colorOpts.default);
+    }
+    return colorOpts?.default?.value;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ29sb3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvbW9kZWwvQ29sb3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLGFBQWEsRUFBRSxnQkFBZ0IsRUFBRSxNQUFNLFVBQVUsQ0FBQTtBQUkxRDs7O0dBR0c7QUFDSCxNQUFNLE9BQU8sS0FBSztJQUNDLE1BQU0sQ0FBUztJQUVoQzs7Ozs7Ozs7T0FRRztJQUNILFlBQW1CLEtBQWM7UUFDL0IsSUFBSSxDQUFDLE1BQU0sR0FBRyxJQUFJLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxDQUFBO1FBQ2xDLElBQUksQ0FBQyxnQkFBZ0IsRUFBRSxDQUFBO0lBQ3pCLENBQUM7SUFFRDs7T0FFRztJQUNILElBQVcsS0FBSztRQUNkLE9BQU8sSUFBSSxDQUFDLE1BQU0sQ0FBQTtJQUNwQixDQUFDO0lBRU8sZ0JBQWdCO1FBQ3RCLElBQUksSUFBSSxDQUFDLE1BQU0sSUFBSSxJQUFJLEVBQUUsQ0FBQztZQUN4QixNQUFNLGFBQWEsR0FBRyxvRUFBb0UsQ0FBQztZQUUzRixJQUFJLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQztnQkFDckMsTUFBTSxJQUFJLEtBQUssQ0FBQyx1QkFBdUIsSUFBSSxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUM7WUFDekQsQ0FBQztRQUNILENBQUM7SUFDSCxDQUFDO0lBRU8sUUFBUSxDQUFDLElBQWE7UUFDNUIsUUFBUSxJQUFJLEVBQUUsQ0FBQztZQUNiLEtBQUssU0FBUztnQkFDWixPQUFPLFNBQVMsQ0FBQTtZQUNsQixLQUFLLFNBQVM7Z0JBQ1osT0FBTyxTQUFTLENBQUE7WUFDbEIsS0FBSyxXQUFXO2dCQUNkLE9BQU8sU0FBUyxDQUFBO1lBQ2xCLEtBQUssU0FBUztnQkFDWixPQUFPLFNBQVMsQ0FBQTtZQUNsQjtnQkFDRSxPQUFPLElBQUksQ0FBQTtRQUNmLENBQUM7SUFDSCxDQUFDO0NBQ0Y7QUE2REQsU0FBUyxtQkFBbUIsQ0FDMUIsUUFBdUIsRUFDdkIsSUFBTyxFQUNQLElBQWdCLEVBQ2hCLE9BQW1CLEVBQ25CLEtBQXVCLEVBQ3ZCLFlBQW9CO0lBRXBCLElBQUksS0FBSyxDQUFDLElBQUksSUFBSSxJQUFJLElBQUksUUFBUSxDQUFDLGNBQWMsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLElBQUksSUFBSSxFQUFFLENBQUM7UUFDdEUsT0FBTyxLQUFLLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQTtJQUN6QixDQUFDO0lBRUQsSUFBSSxLQUFLLENBQUMsT0FBTyxJQUFJLElBQUksSUFBSSxRQUFRLENBQUMsY0FBYyxDQUFDLElBQUksRUFBRSxPQUFPLENBQUMsSUFBSSxJQUFJLEVBQUUsQ0FBQztRQUM1RSxPQUFPLEtBQUssQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFBO0lBQzVCLENBQUM7SUFFRCxJQUFJLEtBQUssQ0FBQyxLQUFLLElBQUksSUFBSSxJQUFJLFFBQVEsQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFLENBQUM7UUFDakQsT0FBTyxLQUFLLENBQUMsS0FBSyxDQUFDLEtBQUssQ0FBQTtJQUMxQixDQUFDO0lBRUQsT0FBTyxZQUFZLEVBQUUsS0FBSyxDQUFBO0FBQzVCLENBQUM7QUFFRCxTQUFTLHVCQUF1QixDQUFDLFFBQXVCLEVBQUUsS0FBMkIsRUFBRSxZQUFvQjtJQUN6RyxJQUFJLEtBQUssQ0FBQyxRQUFRLElBQUksSUFBSSxJQUFJLFFBQVEsQ0FBQyxjQUFjLENBQUMsVUFBVSxFQUFFLGdCQUFnQixDQUFDLFFBQVEsQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFDO1FBQ3JHLE9BQU8sS0FBSyxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUE7SUFDN0IsQ0FBQztJQUVELElBQUksS0FBSyxDQUFDLElBQUksSUFBSSxJQUFJLElBQUksUUFBUSxDQUFDLGNBQWMsQ0FBQyxVQUFVLEVBQUUsZ0JBQWdCLENBQUMsSUFBSSxDQUFDLElBQUksSUFBSSxFQUFFLENBQUM7UUFDN0YsT0FBTyxLQUFLLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQTtJQUN6QixDQUFDO0lBRUQsSUFBSSxLQUFLLENBQUMsTUFBTSxJQUFJLElBQUksSUFBSSxRQUFRLENBQUMsY0FBYyxDQUFDLFVBQVUsRUFBRSxnQkFBZ0IsQ0FBQyxNQUFNLENBQUMsSUFBSSxJQUFJLEVBQUUsQ0FBQztRQUNqRyxPQUFPLEtBQUssQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFBO0lBQzNCLENBQUM7SUFFRCxJQUFJLEtBQUssQ0FBQyxHQUFHLElBQUksSUFBSSxJQUFJLFFBQVEsQ0FBQyxjQUFjLENBQUMsVUFBVSxFQUFFLGdCQUFnQixDQUFDLEdBQUcsQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFDO1FBQzNGLE9BQU8sS0FBSyxDQUFDLEdBQUcsQ0FBQyxLQUFLLENBQUE7SUFDeEIsQ0FBQztJQUVELE9BQU8sbUJBQW1CLENBQUMsUUFBUSxFQUFFLFVBQVUsRUFBRSxnQkFBZ0IsQ0FBQyxJQUFJLEVBQUUsZ0JBQWdCLENBQUMsT0FBTyxFQUFFLEtBQUssRUFBRSxZQUFZLENBQUMsQ0FBQTtBQUN4SCxDQUFDO0FBRUQsU0FBUyxvQkFBb0IsQ0FBQyxRQUF1QixFQUFFLEtBQXdCLEVBQUUsWUFBb0I7SUFDbkcsSUFBSSxLQUFLLENBQUMsS0FBSyxJQUFJLElBQUksSUFBSSxRQUFRLENBQUMsY0FBYyxDQUFDLE9BQU8sRUFBRSxhQUFhLENBQUMsS0FBSyxDQUFDLElBQUksSUFBSSxFQUFFLENBQUM7UUFDekYsT0FBTyxLQUFLLENBQUMsS0FBSyxDQUFDLEtBQUssQ0FBQTtJQUMxQixDQUFDO0lBRUQsSUFBSSxLQUFLLENBQUMsT0FBTyxJQUFJLElBQUksSUFBSSxRQUFRLENBQUMsY0FBYyxDQUFDLE9BQU8sRUFBRSxhQUFhLENBQUMsT0FBTyxDQUFDLElBQUksSUFBSSxFQUFFLENBQUM7UUFDN0YsT0FBTyxLQUFLLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQTtJQUM1QixDQUFDO0lBRUQsSUFBSSxLQUFLLENBQUMsSUFBSSxJQUFJLElBQUksSUFBSSxRQUFRLENBQUMsY0FBYyxDQUFDLE9BQU8sRUFBRSxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksSUFBSSxFQUFFLENBQUM7UUFDdkYsT0FBTyxLQUFLLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQTtJQUN6QixDQUFDO0lBRUQsT0FBTyxtQkFBbUIsQ0FBQyxRQUFRLEVBQUUsT0FBTyxFQUFFLGFBQWEsQ0FBQyxJQUFJLEVBQUUsYUFBYSxDQUFDLE9BQU8sRUFBRSxLQUFLLEVBQUUsWUFBWSxDQUFDLENBQUE7QUFDL0csQ0FBQztBQUVEOzs7Ozs7O0dBT0c7QUFDSCxNQUFNLFVBQVUsYUFBYSxDQUFDLFFBQXVCLEVBQUUsU0FBd0I7SUFDN0UsSUFBSSxTQUFTLEVBQUUsVUFBVSxJQUFJLElBQUksRUFBRSxDQUFDO1FBQ2xDLE9BQU8sdUJBQXVCLENBQUMsUUFBUSxFQUFFLFNBQVMsQ0FBQyxVQUFVLEVBQUUsU0FBUyxDQUFDLE9BQU8sQ0FBQyxDQUFBO0lBQ25GLENBQUM7SUFFRCxJQUFJLFNBQVMsRUFBRSxPQUFPLElBQUksSUFBSSxFQUFFLENBQUM7UUFDL0IsT0FBTyxvQkFBb0IsQ0FBQyxRQUFRLEVBQUUsU0FBUyxDQUFDLE9BQU8sRUFBRSxTQUFTLENBQUMsT0FBTyxDQUFDLENBQUE7SUFDN0UsQ0FBQztJQUVELE9BQU8sU0FBUyxFQUFFLE9BQU8sRUFBRSxLQUFLLENBQUE7QUFDbEMsQ0FBQyJ9

package/dist/model/Finding.d.ts

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

package/dist/model/Finding.d.ts.map

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

package/dist/model/Finding.js

@@ -0,0 +1,93 @@
+import { SecurityLevel, SecuritySeverity } from '../types';
+import Logger from '../Logger';
+import { createProcessor } from '../processors/ProcessorFactory';
+/**
+ * Creates a new instance of {@link Finding} class.
+ * @internal
+ */
+export function createFinding(opts) {
+    return new SarifFinding(opts);
+}
+/**
+ * The only implementation of {@link Finding} interface. This class is private
+ * and is not supposed to be exposed. {@link createFinding} should be used to
+ * create a new {@link Finding}.
+ * @private
+ */
+class SarifFinding {
+    _runMetadata;
+    _result;
+    _sarifPath;
+    _rule;
+    _processor;
+    _cvssScoreCacheProcessed = false;
+    _cvssScoreCache = undefined;
+    _levelCacheProcessed = false;
+    _levelCache = undefined;
+    constructor(opts) {
+        this._processor = createProcessor(opts.runMetadata.run, opts.result);
+        this._sarifPath = opts.sarifPath;
+        this._runMetadata = opts.runMetadata;
+        this._result = opts.result;
+        this._rule = this._processor.tryFindRule();
+    }
+    clone() {
+        return createFinding({
+            sarifPath: this._sarifPath,
+            runMetadata: this._runMetadata,
+            result: this._result
+        });
+    }
+    get sarifPath() {
+        return this._sarifPath;
+    }
+    get runId() {
+        return this._runMetadata.id;
+    }
+    get toolName() {
+        return this._processor.findToolComponent().name;
+    }
+    get cvssScore() {
+        if (!this._cvssScoreCacheProcessed) {
+            this._cvssScoreCacheProcessed = true;
+            this._cvssScoreCache = this._processor.tryFindCvssScore();
+        }
+        return this._cvssScoreCache;
+    }
+    get level() {
+        if (!this._levelCacheProcessed) {
+            this._levelCacheProcessed = true;
+            this._levelCache = this._processor.tryFindLevel();
+        }
+        if (this._levelCache === undefined) {
+            Logger.debug(`Unknown level of ${this._rule?.id} rule`);
+            return SecurityLevel.Unknown;
+        }
+        switch (this._levelCache) {
+            case 'error': return SecurityLevel.Error;
+            case 'warning': return SecurityLevel.Warning;
+            case 'note': return SecurityLevel.Note;
+            default: return SecurityLevel.None;
+        }
+    }
+    get severity() {
+        if (this.cvssScore == null || this.cvssScore < 0 || this.cvssScore > 10) {
+            Logger.debug(`Unsupported CVSS score ${this.cvssScore} in ${this._rule?.id} rule`);
+            return SecuritySeverity.Unknown;
+        }
+        if (this.cvssScore >= 9) {
+            return SecuritySeverity.Critical;
+        }
+        if (this.cvssScore >= 7) {
+            return SecuritySeverity.High;
+        }
+        if (this.cvssScore >= 4) {
+            return SecuritySeverity.Medium;
+        }
+        if (this.cvssScore >= 0.1) {
+            return SecuritySeverity.Low;
+        }
+        return SecuritySeverity.None;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRmluZGluZy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9tb2RlbC9GaW5kaW5nLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sRUFBVyxhQUFhLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxVQUFVLENBQUE7QUFDbkUsT0FBTyxNQUFNLE1BQU0sV0FBVyxDQUFBO0FBRTlCLE9BQU8sRUFBRSxlQUFlLEVBQUUsTUFBTSxnQ0FBZ0MsQ0FBQTtBQTBCaEU7OztHQUdHO0FBQ0gsTUFBTSxVQUFVLGFBQWEsQ0FBQyxJQUFvQjtJQUNoRCxPQUFPLElBQUksWUFBWSxDQUFDLElBQUksQ0FBQyxDQUFBO0FBQy9CLENBQUM7QUFFRDs7Ozs7R0FLRztBQUNILE1BQU0sWUFBWTtJQUNDLFlBQVksQ0FBUztJQUNyQixPQUFPLENBQVE7SUFDZixVQUFVLENBQVE7SUFDbEIsS0FBSyxDQUFzQjtJQUMzQixVQUFVLENBQWlCO0lBRXBDLHdCQUF3QixHQUFZLEtBQUssQ0FBQTtJQUN6QyxlQUFlLEdBQXVCLFNBQVMsQ0FBQTtJQUUvQyxvQkFBb0IsR0FBWSxLQUFLLENBQUE7SUFDckMsV0FBVyxHQUE2QixTQUFTLENBQUE7SUFFekQsWUFBWSxJQUFvQjtRQUM5QixJQUFJLENBQUMsVUFBVSxHQUFHLGVBQWUsQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLEdBQUcsRUFBRSxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUE7UUFDcEUsSUFBSSxDQUFDLFVBQVUsR0FBRyxJQUFJLENBQUMsU0FBUyxDQUFBO1FBQ2hDLElBQUksQ0FBQyxZQUFZLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FBQTtRQUNwQyxJQUFJLENBQUMsT0FBTyxHQUFHLElBQUksQ0FBQyxNQUFNLENBQUE7UUFDMUIsSUFBSSxDQUFDLEtBQUssR0FBRyxJQUFJLENBQUMsVUFBVSxDQUFDLFdBQVcsRUFBRSxDQUFBO0lBQzVDLENBQUM7SUFFRCxLQUFLO1FBQ0gsT0FBTyxhQUFhLENBQUM7WUFDbkIsU0FBUyxFQUFFLElBQUksQ0FBQyxVQUFVO1lBQzFCLFdBQVcsRUFBRSxJQUFJLENBQUMsWUFBWTtZQUM5QixNQUFNLEVBQUUsSUFBSSxDQUFDLE9BQU87U0FDckIsQ0FBQyxDQUFBO0lBQ0osQ0FBQztJQUVELElBQVcsU0FBUztRQUNsQixPQUFPLElBQUksQ0FBQyxVQUFVLENBQUE7SUFDeEIsQ0FBQztJQUVELElBQVcsS0FBSztRQUNkLE9BQU8sSUFBSSxDQUFDLFlBQVksQ0FBQyxFQUFFLENBQUE7SUFDN0IsQ0FBQztJQUVELElBQVcsUUFBUTtRQUNqQixPQUFPLElBQUksQ0FBQyxVQUFVLENBQUMsaUJBQWlCLEVBQUUsQ0FBQyxJQUFJLENBQUE7SUFDakQsQ0FBQztJQUVELElBQVcsU0FBUztRQUNsQixJQUFJLENBQUMsSUFBSSxDQUFDLHdCQUF3QixFQUFFLENBQUM7WUFDbkMsSUFBSSxDQUFDLHdCQUF3QixHQUFHLElBQUksQ0FBQTtZQUNwQyxJQUFJLENBQUMsZUFBZSxHQUFHLElBQUksQ0FBQyxVQUFVLENBQUMsZ0JBQWdCLEVBQUUsQ0FBQTtRQUMzRCxDQUFDO1FBQ0QsT0FBTyxJQUFJLENBQUMsZUFBZSxDQUFBO0lBQzdCLENBQUM7SUFFRCxJQUFXLEtBQUs7UUFDZCxJQUFJLENBQUMsSUFBSSxDQUFDLG9CQUFvQixFQUFFLENBQUM7WUFDL0IsSUFBSSxDQUFDLG9CQUFvQixHQUFHLElBQUksQ0FBQTtZQUNoQyxJQUFJLENBQUMsV0FBVyxHQUFHLElBQUksQ0FBQyxVQUFVLENBQUMsWUFBWSxFQUFFLENBQUE7UUFDbkQsQ0FBQztRQUVELElBQUksSUFBSSxDQUFDLFdBQVcsS0FBSyxTQUFTLEVBQUUsQ0FBQztZQUNuQyxNQUFNLENBQUMsS0FBSyxDQUFDLG9CQUFvQixJQUFJLENBQUMsS0FBSyxFQUFFLEVBQUUsT0FBTyxDQUFDLENBQUE7WUFDdkQsT0FBTyxhQUFhLENBQUMsT0FBTyxDQUFBO1FBQzlCLENBQUM7UUFFRCxRQUFRLElBQUksQ0FBQyxXQUFXLEVBQUUsQ0FBQztZQUN6QixLQUFLLE9BQU8sQ0FBQyxDQUFDLE9BQU8sYUFBYSxDQUFDLEtBQUssQ0FBQTtZQUN4QyxLQUFLLFNBQVMsQ0FBQyxDQUFDLE9BQU8sYUFBYSxDQUFDLE9BQU8sQ0FBQTtZQUM1QyxLQUFLLE1BQU0sQ0FBQyxDQUFDLE9BQU8sYUFBYSxDQUFDLElBQUksQ0FBQTtZQUN0QyxPQUFPLENBQUMsQ0FBQyxPQUFPLGFBQWEsQ0FBQyxJQUFJLENBQUE7UUFDcEMsQ0FBQztJQUNILENBQUM7SUFFRCxJQUFXLFFBQVE7UUFDakIsSUFBSSxJQUFJLENBQUMsU0FBUyxJQUFJLElBQUksSUFBSSxJQUFJLENBQUMsU0FBUyxHQUFHLENBQUMsSUFBSSxJQUFJLENBQUMsU0FBUyxHQUFHLEVBQUUsRUFBRSxDQUFDO1lBQ3hFLE1BQU0sQ0FBQyxLQUFLLENBQUMsMEJBQTBCLElBQUksQ0FBQyxTQUFTLE9BQU8sSUFBSSxDQUFDLEtBQUssRUFBRSxFQUFFLE9BQU8sQ0FBQyxDQUFBO1lBQ2xGLE9BQU8sZ0JBQWdCLENBQUMsT0FBTyxDQUFBO1FBQ2pDLENBQUM7UUFFRCxJQUFJLElBQUksQ0FBQyxTQUFTLElBQUksQ0FBQyxFQUFFLENBQUM7WUFDeEIsT0FBTyxnQkFBZ0IsQ0FBQyxRQUFRLENBQUE7UUFDbEMsQ0FBQztRQUVELElBQUksSUFBSSxDQUFDLFNBQVMsSUFBSSxDQUFDLEVBQUUsQ0FBQztZQUN4QixPQUFPLGdCQUFnQixDQUFDLElBQUksQ0FBQTtRQUM5QixDQUFDO1FBRUQsSUFBSSxJQUFJLENBQUMsU0FBUyxJQUFJLENBQUMsRUFBRSxDQUFDO1lBQ3hCLE9BQU8sZ0JBQWdCLENBQUMsTUFBTSxDQUFBO1FBQ2hDLENBQUM7UUFFRCxJQUFJLElBQUksQ0FBQyxTQUFTLElBQUksR0FBRyxFQUFFLENBQUM7WUFDMUIsT0FBTyxnQkFBZ0IsQ0FBQyxHQUFHLENBQUE7UUFDN0IsQ0FBQztRQUVELE9BQU8sZ0JBQWdCLENBQUMsSUFBSSxDQUFBO0lBQzlCLENBQUM7Q0FDRiJ9

package/dist/model/FindingsArray.d.ts

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

package/dist/model/FindingsArray.d.ts.map

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

package/dist/model/FindingsArray.js

@@ -0,0 +1,24 @@
+import ExtendedArray from '../utils/ExtendedArray';
+import { SecurityLevel, SecuritySeverity } from '../types';
+/**
+ * This class represents an array of {@link Finding} objects and adds additional
+ * useful methods to it.
+ * @internal
+ */
+export default class FindingsArray extends ExtendedArray {
+    hasSeverityOrHigher(severity) {
+        return Object
+            .values(SecuritySeverity)
+            .filter((v) => typeof v === 'number')
+            .filter((v) => v >= severity)
+            .some((v) => this.findByProperty('severity', v) != null);
+    }
+    hasLevelOrHigher(level) {
+        return Object
+            .values(SecurityLevel)
+            .filter((v) => typeof v === 'number')
+            .filter((v) => v >= level)
+            .some((v) => this.findByProperty('level', v) != null);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRmluZGluZ3NBcnJheS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9tb2RlbC9GaW5kaW5nc0FycmF5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sYUFBYSxNQUFNLHdCQUF3QixDQUFBO0FBQ2xELE9BQU8sRUFBRSxhQUFhLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxVQUFVLENBQUE7QUFFMUQ7Ozs7R0FJRztBQUNILE1BQU0sQ0FBQyxPQUFPLE9BQU8sYUFBYyxTQUFRLGFBQXNCO0lBRXhELG1CQUFtQixDQUFDLFFBQTBCO1FBQ25ELE9BQU8sTUFBTTthQUNWLE1BQU0sQ0FBQyxnQkFBZ0IsQ0FBQzthQUN4QixNQUFNLENBQUMsQ0FBQyxDQUE0QixFQUF5QixFQUFFLENBQUMsT0FBTyxDQUFDLEtBQUssUUFBUSxDQUFDO2FBQ3RGLE1BQU0sQ0FBQyxDQUFDLENBQW1CLEVBQVcsRUFBRSxDQUFDLENBQUMsSUFBSSxRQUFRLENBQUM7YUFDdkQsSUFBSSxDQUFDLENBQUMsQ0FBbUIsRUFBVyxFQUFFLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxVQUFVLEVBQUUsQ0FBQyxDQUFDLElBQUksSUFBSSxDQUFDLENBQUE7SUFDdkYsQ0FBQztJQUVNLGdCQUFnQixDQUFDLEtBQW9CO1FBQzFDLE9BQU8sTUFBTTthQUNWLE1BQU0sQ0FBQyxhQUFhLENBQUM7YUFDckIsTUFBTSxDQUFDLENBQUMsQ0FBeUIsRUFBc0IsRUFBRSxDQUFDLE9BQU8sQ0FBQyxLQUFLLFFBQVEsQ0FBQzthQUNoRixNQUFNLENBQUMsQ0FBQyxDQUFnQixFQUFXLEVBQUUsQ0FBQyxDQUFDLElBQUksS0FBSyxDQUFDO2FBQ2pELElBQUksQ0FBQyxDQUFDLENBQWdCLEVBQVcsRUFBRSxDQUFDLElBQUksQ0FBQyxjQUFjLENBQUMsT0FBTyxFQUFFLENBQUMsQ0FBQyxJQUFJLElBQUksQ0FBQyxDQUFBO0lBQ2pGLENBQUM7Q0FDRiJ9

package/dist/processors/CodeQLProcessor.d.ts

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

package/dist/processors/CodeQLProcessor.d.ts.map

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

package/dist/processors/CodeQLProcessor.js

@@ -0,0 +1,17 @@
+import { CommonProcessor } from './CommonProcessor';
+/**
+ * This class has extra logic for processing SARIF files produced by CodeQL tool.
+ * @internal
+ */
+export class CodeQLProcessor extends CommonProcessor {
+    /**
+     * Rules in SARIF files produced by CodeQL has additional "problem.severity"
+     * property where level is also defined. This method tries to get level in a
+     * common way but if it fails to do so, then it tries to get level from
+     * "problem.severity" property.
+     */
+    tryFindLevel() {
+        return super.tryFindLevel() ?? this.tryFindRuleProperty('problem.severity');
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ29kZVFMUHJvY2Vzc29yLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3Byb2Nlc3NvcnMvQ29kZVFMUHJvY2Vzc29yLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxlQUFlLEVBQUUsTUFBTSxtQkFBbUIsQ0FBQTtBQUduRDs7O0dBR0c7QUFDSCxNQUFNLE9BQU8sZUFBZ0IsU0FBUSxlQUFlO0lBRWxEOzs7OztPQUtHO0lBQ2EsWUFBWTtRQUMxQixPQUFPLEtBQUssQ0FBQyxZQUFZLEVBQUUsSUFBSSxJQUFJLENBQUMsbUJBQW1CLENBQUMsa0JBQWtCLENBQUMsQ0FBQTtJQUM3RSxDQUFDO0NBQ0YifQ==

package/dist/processors/CommonProcessor.d.ts

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

package/dist/processors/CommonProcessor.d.ts.map

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

package/dist/processors/CommonProcessor.js

@@ -0,0 +1,84 @@
+import * as sarifUtils from '../utils/SarifUtils';
+/**
+ * This class has logic of the SARIF file processing, such as finding rule,
+ * finding tool component, etc. It is used by default for all SARIF files.
+ * Derived classes from this class can implement extra logic for the specific
+ * use cases, such as SARIF files produced by specific tools. For example,
+ * {@link CodeQLProcessor} handles additional logic for processing SARIF files
+ * produced by CodeQL.
+ * @internal
+ */
+export class CommonProcessor {
+    _run;
+    _result;
+    /**
+     * Creates an instance of {@link CommonProcessor} class.
+     * @param run An instance of {@link Run} object.
+     * @param result An instance of {@link Result} object.
+     */
+    constructor(run, result) {
+        this._run = run;
+        this._result = result;
+    }
+    tryFindCvssScore() {
+        return this.tryFindRuleProperty('security-severity');
+    }
+    tryFindLevel() {
+        return this._result.level ?? this.tryFindRule()?.defaultConfiguration?.level;
+    }
+    findToolComponentDriver() {
+        return sarifUtils.findToolComponentDriver(this._run);
+    }
+    tryFindToolComponentExtension() {
+        return sarifUtils.tryFindToolComponentExtension(this._run, this._result);
+    }
+    findToolComponent() {
+        return sarifUtils.findToolComponent(this._run, this._result);
+    }
+    /**
+     * This function tries to find the respective rule for the given result.
+     * @internal
+     */
+    tryFindRule() {
+        const ruleData = {};
+        if (this._result.rule) {
+            if (this._result.rule?.index != null) {
+                ruleData.index = this._result.rule.index;
+            }
+            if (this._result.rule?.id) {
+                ruleData.id = this._result.rule.id;
+            }
+        }
+        if (ruleData.index == null && this._result.ruleIndex != null) {
+            ruleData.index = this._result.ruleIndex;
+        }
+        if (!ruleData.id && this._result.ruleId) {
+            ruleData.id = this._result.ruleId;
+        }
+        const tool = this.findToolComponent();
+        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);
+        }
+        return undefined;
+    }
+    /**
+     * This function searches respective rule for the given result, and then gets
+     * the property of interest from it.
+     * @param propertyName The property name that you want to get the value from.
+     * @protected
+     */
+    tryFindRuleProperty(propertyName) {
+        const rule = this.tryFindRule();
+        if (rule?.properties && propertyName in rule.properties) {
+            return rule.properties[propertyName];
+        }
+        return undefined;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ29tbW9uUHJvY2Vzc29yLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3Byb2Nlc3NvcnMvQ29tbW9uUHJvY2Vzc29yLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sS0FBSyxVQUFVLE1BQU0scUJBQXFCLENBQUE7QUFFakQ7Ozs7Ozs7O0dBUUc7QUFDSCxNQUFNLE9BQU8sZUFBZTtJQUNQLElBQUksQ0FBSztJQUNULE9BQU8sQ0FBUTtJQUVsQzs7OztPQUlHO0lBQ0gsWUFBbUIsR0FBUSxFQUFFLE1BQWM7UUFDekMsSUFBSSxDQUFDLElBQUksR0FBRyxHQUFHLENBQUE7UUFDZixJQUFJLENBQUMsT0FBTyxHQUFHLE1BQU0sQ0FBQTtJQUN2QixDQUFDO0lBRU0sZ0JBQWdCO1FBQ3JCLE9BQU8sSUFBSSxDQUFDLG1CQUFtQixDQUFDLG1CQUFtQixDQUFDLENBQUE7SUFDdEQsQ0FBQztJQUVNLFlBQVk7UUFDakIsT0FBTyxJQUFJLENBQUMsT0FBTyxDQUFDLEtBQUssSUFBSSxJQUFJLENBQUMsV0FBVyxFQUFFLEVBQUUsb0JBQW9CLEVBQUUsS0FBSyxDQUFBO0lBQzlFLENBQUM7SUFFTSx1QkFBdUI7UUFDNUIsT0FBTyxVQUFVLENBQUMsdUJBQXVCLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFBO0lBQ3RELENBQUM7SUFFTSw2QkFBNkI7UUFDbEMsT0FBTyxVQUFVLENBQUMsNkJBQTZCLENBQUMsSUFBSSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUE7SUFDMUUsQ0FBQztJQUVNLGlCQUFpQjtRQUN0QixPQUFPLFVBQVUsQ0FBQyxpQkFBaUIsQ0FBQyxJQUFJLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQTtJQUM5RCxDQUFDO0lBRUQ7OztPQUdHO0lBQ0ksV0FBVztRQUNoQixNQUFNLFFBQVEsR0FBb0MsRUFBRSxDQUFBO1FBRXBELElBQUksSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsQ0FBQztZQUN0QixJQUFJLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxFQUFFLEtBQUssSUFBSSxJQUFJLEVBQUUsQ0FBQztnQkFDckMsUUFBUSxDQUFDLEtBQUssR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUE7WUFDMUMsQ0FBQztZQUNELElBQUksSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsRUFBRSxFQUFFLENBQUM7Z0JBQzFCLFFBQVEsQ0FBQyxFQUFFLEdBQUcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFBO1lBQ3BDLENBQUM7UUFDSCxDQUFDO1FBRUQsSUFBSSxRQUFRLENBQUMsS0FBSyxJQUFJLElBQUksSUFBSSxJQUFJLENBQUMsT0FBTyxDQUFDLFNBQVMsSUFBSSxJQUFJLEVBQUUsQ0FBQztZQUM3RCxRQUFRLENBQUMsS0FBSyxHQUFHLElBQUksQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFBO1FBQ3pDLENBQUM7UUFFRCxJQUFJLENBQUMsUUFBUSxDQUFDLEVBQUUsSUFBSSxJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sRUFBRSxDQUFDO1lBQ3hDLFFBQVEsQ0FBQyxFQUFFLEdBQUcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUE7UUFDbkMsQ0FBQztRQUVELE1BQU0sSUFBSSxHQUFrQixJQUFJLENBQUMsaUJBQWlCLEVBQUUsQ0FBQTtRQUVwRCxJQUFJLFFBQVEsQ0FBQyxLQUFLLElBQUksSUFBSTtlQUNyQixJQUFJLEVBQUUsS0FBSztlQUNYLFFBQVEsQ0FBQyxLQUFLLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLEVBQUUsQ0FBQztZQUN4QyxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxDQUFBO1FBQ25DLENBQUM7UUFFRCw2REFBNkQ7UUFDN0QsSUFBSSxRQUFRLENBQUMsRUFBRSxJQUFJLElBQUksRUFBRSxLQUFLLEVBQUUsQ0FBQztZQUMvQixPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUNwQixDQUFDLENBQXNCLEVBQVcsRUFBRSxDQUFDLENBQUMsQ0FBQyxFQUFFLEtBQUssUUFBUSxDQUFDLEVBQUUsQ0FDMUQsQ0FBQTtRQUNILENBQUM7UUFFRCxPQUFPLFNBQVMsQ0FBQTtJQUNsQixDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDTyxtQkFBbUIsQ0FBSSxZQUFvQjtRQUNuRCxNQUFNLElBQUksR0FBb0MsSUFBSSxDQUFDLFdBQVcsRUFBRSxDQUFBO1FBQ2hFLElBQUksSUFBSSxFQUFFLFVBQVUsSUFBSSxZQUFZLElBQUksSUFBSSxDQUFDLFVBQVUsRUFBRSxDQUFDO1lBQ3hELE9BQU8sSUFBSSxDQUFDLFVBQVUsQ0FBQyxZQUFZLENBQU0sQ0FBQTtRQUMzQyxDQUFDO1FBRUQsT0FBTyxTQUFTLENBQUE7SUFDbEIsQ0FBQztDQUNGIn0=

package/dist/processors/ProcessorFactory.d.ts

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

package/dist/processors/ProcessorFactory.d.ts.map

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

package/dist/processors/ProcessorFactory.js

@@ -0,0 +1,22 @@
+import { CommonProcessor } from './CommonProcessor';
+import { findToolComponent } from '../utils/SarifUtils';
+import { SnykProcessor } from './SnykProcessor';
+import { CodeQLProcessor } from './CodeQLProcessor';
+/**
+ * Creates a new instance of {@link CommonProcessor} class. It tries to find specific
+ * processor based on the tool component for the given {@param run} and
+ * {@param result} and if no specific processors exist, then it returns an
+ * instance of {@link CommonProcessor} class.
+ * @param run An instance of {@link Run} class.
+ * @param result An instance of {@link Result} class.
+ * @internal
+ */
+export function createProcessor(run, result) {
+    const toolComponent = findToolComponent(run, result);
+    switch (toolComponent.name) {
+        case 'CodeQL': return new CodeQLProcessor(run, result);
+        case 'Snyk Open Source': return new SnykProcessor(run, result);
+        default: return new CommonProcessor(run, result);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUHJvY2Vzc29yRmFjdG9yeS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9wcm9jZXNzb3JzL1Byb2Nlc3NvckZhY3RvcnkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLGVBQWUsRUFBRSxNQUFNLG1CQUFtQixDQUFBO0FBRW5ELE9BQU8sRUFBRSxpQkFBaUIsRUFBRSxNQUFNLHFCQUFxQixDQUFBO0FBQ3ZELE9BQU8sRUFBRSxhQUFhLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQTtBQUMvQyxPQUFPLEVBQUUsZUFBZSxFQUFFLE1BQU0sbUJBQW1CLENBQUE7QUFFbkQ7Ozs7Ozs7O0dBUUc7QUFDSCxNQUFNLFVBQVUsZUFBZSxDQUFDLEdBQVEsRUFBRSxNQUFjO0lBQ3RELE1BQU0sYUFBYSxHQUFrQixpQkFBaUIsQ0FBQyxHQUFHLEVBQUUsTUFBTSxDQUFDLENBQUE7SUFDbkUsUUFBUSxhQUFhLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDM0IsS0FBSyxRQUFRLENBQUMsQ0FBQyxPQUFPLElBQUksZUFBZSxDQUFDLEdBQUcsRUFBRSxNQUFNLENBQUMsQ0FBQTtRQUN0RCxLQUFLLGtCQUFrQixDQUFDLENBQUMsT0FBTyxJQUFJLGFBQWEsQ0FBQyxHQUFHLEVBQUUsTUFBTSxDQUFDLENBQUE7UUFDOUQsT0FBTyxDQUFDLENBQUMsT0FBTyxJQUFJLGVBQWUsQ0FBQyxHQUFHLEVBQUUsTUFBTSxDQUFDLENBQUE7SUFDbEQsQ0FBQztBQUNILENBQUMifQ==