@fabasoad/sarif-to-slack 1.2.3 → 1.3.0

package/src/model/color/ColorIdentification.ts

@@ -0,0 +1,198 @@
+import Finding from '../Finding'
+import FindingArray from '../FindingArray'
+import { SecurityLevel, SecuritySeverity } from '../../types'
+import Logger from '../../Logger'
+import {
+  ColorGroupByLevel,
+  ColorGroupBySeverity,
+  ColorGroupCommon,
+  ColorOptions
+} from './ColorOptions'
+import { Color } from './Color';
+
+function logColorTaken(color: Color | undefined, prop: string): void {
+  Logger.debug(`Message has ${color?.color} color taken from '${prop}' property.`)
+}
+
+function logPropDefinedButNoFindings<K extends keyof Pick<Finding, 'level' | 'severity'>>(key: K, val: string): void {
+  const prop: string = key === 'level' ? 'byLevel' : 'bySeverity'
+  Logger.trace(`'${prop}.${val}' property is defined but no findings with "${val}" ${key} is found. Continue color identification...`)
+}
+
+function logPropIsNotDefined<K extends keyof Pick<Finding, 'level' | 'severity'>>(key: K, val: string): void {
+  const prop: string = key === 'level' ? 'byLevel' : 'bySeverity'
+  Logger.trace(`'${prop}.${val}' property is not defined. Continue color identification...`)
+}
+
+function identifyColorCommon<K extends keyof Pick<Finding, 'level' | 'severity'>>(
+  findings: FindingArray,
+  prop: K,
+  none: Finding[K],
+  unknown: Finding[K],
+  color: ColorGroupCommon
+): string | undefined {
+  if (color.none) {
+    if (findings.findByProperty(prop, none) != null) {
+      logColorTaken(color.none, `${prop === 'severity' ? 'bySeverity' : 'byLevel'}.none`)
+      return color.none.color
+    } else {
+      logPropDefinedButNoFindings(prop, 'none')
+    }
+  } else {
+    logPropIsNotDefined(prop, 'none')
+  }
+
+  if (color.unknown) {
+    if (findings.findByProperty(prop, unknown) != null) {
+      logColorTaken(color.unknown, `${prop === 'severity' ? 'bySeverity' : 'byLevel'}.unknown`)
+      return color.unknown.color
+    } else {
+      logPropDefinedButNoFindings(prop, 'unknown')
+    }
+  } else {
+    logPropIsNotDefined(prop, 'unknown')
+  }
+
+  return undefined
+}
+
+function identifyColorBySeverity(findings: FindingArray, color: ColorGroupBySeverity): string | undefined {
+  if (color.critical) {
+    if (findings.findByProperty('severity', SecuritySeverity.Critical) != null) {
+      logColorTaken(color.critical, 'bySeverity.critical')
+      return color.critical.color
+    } else {
+      logPropDefinedButNoFindings('severity', 'critical')
+    }
+  } else {
+    logPropIsNotDefined('severity', 'critical')
+  }
+
+  if (color.high) {
+    if (findings.findByProperty('severity', SecuritySeverity.High) != null) {
+      logColorTaken(color.high, 'bySeverity.high')
+      return color.high.color
+    } else {
+      logPropDefinedButNoFindings('severity', 'high')
+    }
+  } else {
+    logPropIsNotDefined('severity', 'high')
+  }
+
+  if (color.medium) {
+    if (findings.findByProperty('severity', SecuritySeverity.Medium) != null) {
+      logColorTaken(color.medium, 'bySeverity.medium')
+      return color.medium.color
+    } else {
+      logPropDefinedButNoFindings('severity', 'medium')
+    }
+  } else {
+    logPropIsNotDefined('severity', 'medium')
+  }
+
+  if (color.low) {
+    if (findings.findByProperty('severity', SecuritySeverity.Low) != null) {
+      logColorTaken(color.low, 'bySeverity.low')
+      return color.low.color
+    } else {
+      logPropDefinedButNoFindings('severity', 'low')
+    }
+  } else {
+    logPropIsNotDefined('severity', 'low')
+  }
+
+  return identifyColorCommon(findings, 'severity', SecuritySeverity.None, SecuritySeverity.Unknown, color)
+}
+
+function identifyColorByLevel(findings: FindingArray, color: ColorGroupByLevel): string | undefined {
+  if (color.error) {
+    if (findings.findByProperty('level', SecurityLevel.Error) != null) {
+      logColorTaken(color.error, 'byLevel.error')
+      return color.error.color
+    } else {
+      logPropDefinedButNoFindings('level', 'error')
+    }
+  } else {
+    logPropIsNotDefined('level', 'error')
+  }
+
+  if (color.warning) {
+    if (findings.findByProperty('level', SecurityLevel.Warning) != null) {
+      logColorTaken(color.warning, 'byLevel.warning')
+      return color.warning.color
+    } else {
+      logPropDefinedButNoFindings('level', 'warning')
+    }
+  } else {
+    logPropIsNotDefined('level', 'warning')
+  }
+
+  if (color.note != null) {
+    if (findings.findByProperty('level', SecurityLevel.Note) != null) {
+      logColorTaken(color.note, 'byLevel.note')
+      return color.note.color
+    } else {
+      logPropDefinedButNoFindings('level', 'note')
+    }
+  } else {
+    logPropIsNotDefined('level', 'note')
+  }
+
+  return identifyColorCommon(findings, 'level', SecurityLevel.None, SecurityLevel.Unknown, color)
+}
+
+/**
+ * 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 FindingArray} object.
+ * @param colorOpts An instance of {@link ColorOptions} type.
+ * @internal
+ */
+export function identifyColor(findings: FindingArray, colorOpts?: ColorOptions): string | undefined {
+  if (!colorOpts) {
+    Logger.debug('Message has no color as color options are not defined.')
+    return undefined
+  }
+  Logger.trace(`Identifying color for ${findings.length} findings and the following color options:`, JSON.stringify(colorOpts, null, 2))
+
+  if (colorOpts.bySeverity) {
+    const color: string | undefined = identifyColorBySeverity(findings, colorOpts.bySeverity)
+    if (color) {
+      return color
+    }
+    Logger.trace('None of the properties in \'bySeverity\' group is applicable. Continue color identification...')
+  } else {
+    Logger.trace('\'bySeverity\' group is not defined. Continue color identification...')
+  }
+
+  if (colorOpts.byLevel) {
+    const color: string | undefined = identifyColorByLevel(findings, colorOpts.byLevel)
+    if (color) {
+      return color
+    }
+    Logger.trace('None of the properties in \'byLevel\' group is applicable. Continue color identification...')
+  } else {
+    Logger.trace('\'byLevel\' group is not defined. Continue color identification...')
+  }
+
+  if (findings.length === 0) {
+    Logger.trace('There are no findings in the provided SARIF file(s). Checking if color is defined in "empty" property...')
+    if (colorOpts.empty?.color) {
+      logColorTaken(colorOpts.empty, 'empty')
+      return colorOpts.empty.color
+    } else {
+      Logger.trace('"empty" color is not defined. Continue color identification...')
+    }
+  } else {
+    Logger.trace(`"empty" color is not taken into account because there are ${findings.length} findings in the provided SARIF file(s). Continue color identification...`)
+  }
+
+  if (colorOpts.default?.color) {
+    logColorTaken(colorOpts.default, 'default')
+  } else {
+    Logger.debug('Message has no color as none of the defined color options is applicable.')
+  }
+
+  return colorOpts?.default?.color
+}

package/src/model/color/ColorOptions.ts

@@ -0,0 +1,63 @@
+import { Color } from './Color'
+
+/**
+ * Base type that has common fields for both {@link ColorGroupByLevel} and
+ * {@link ColorGroupBySeverity}.
+ * @public
+ */
+export type ColorGroupCommon = {
+  none?: Color,
+  unknown?: 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,
+  /**
+   * Color when no findings are found.
+   */
+  empty?: Color,
+}

package/src/types.ts

@@ -1,5 +1,5 @@
 import { Run } from 'sarif'
-import { ColorOptions } from './model/Color'
+import { ColorOptions } from './model/color/ColorOptions'
 import FindingArray from './model/FindingArray'
 import { SendIf } from './model/SendIf'
 

package/tests/integration/SendSarifToSlack.spec.ts

@@ -107,22 +107,22 @@ describe('(integration): SendSarifToSlack', (): void => {
       username: process.env.SARIF_TO_SLACK_USERNAME,
       iconUrl: process.env.SARIF_TO_SLACK_ICON_URL,
       color: {
-        default: new Color(process.env.SARIF_TO_SLACK_COLOR),
-        empty: new Color(process.env.SARIF_TO_SLACK_COLOR_EMPTY),
+        default: Color.from(process.env.SARIF_TO_SLACK_COLOR),
+        empty: Color.from(process.env.SARIF_TO_SLACK_COLOR_EMPTY),
         byLevel: {
-          error: new Color(process.env.SARIF_TO_SLACK_COLOR_ERROR),
-          warning: new Color(process.env.SARIF_TO_SLACK_COLOR_WARNING),
-          note: new Color(process.env.SARIF_TO_SLACK_COLOR_NOTE),
-          none: new Color(process.env.SARIF_TO_SLACK_COLOR_NONE),
-          unknown: new Color(process.env.SARIF_TO_SLACK_COLOR_UNKNOWN),
+          error: Color.from(process.env.SARIF_TO_SLACK_COLOR_ERROR),
+          warning: Color.from(process.env.SARIF_TO_SLACK_COLOR_WARNING),
+          note: Color.from(process.env.SARIF_TO_SLACK_COLOR_NOTE),
+          none: Color.from(process.env.SARIF_TO_SLACK_COLOR_NONE),
+          unknown: Color.from(process.env.SARIF_TO_SLACK_COLOR_UNKNOWN),
         },
         bySeverity: {
-          critical: new Color(process.env.SARIF_TO_SLACK_COLOR_CRITICAL),
-          high: new Color(process.env.SARIF_TO_SLACK_COLOR_HIGH),
-          medium: new Color(process.env.SARIF_TO_SLACK_COLOR_MEDIUM),
-          low: new Color(process.env.SARIF_TO_SLACK_COLOR_LOW),
-          none: new Color(process.env.SARIF_TO_SLACK_COLOR_NONE),
-          unknown: new Color(process.env.SARIF_TO_SLACK_COLOR_UNKNOWN),
+          critical: Color.from(process.env.SARIF_TO_SLACK_COLOR_CRITICAL),
+          high: Color.from(process.env.SARIF_TO_SLACK_COLOR_HIGH),
+          medium: Color.from(process.env.SARIF_TO_SLACK_COLOR_MEDIUM),
+          low: Color.from(process.env.SARIF_TO_SLACK_COLOR_LOW),
+          none: Color.from(process.env.SARIF_TO_SLACK_COLOR_NONE),
+          unknown: Color.from(process.env.SARIF_TO_SLACK_COLOR_UNKNOWN),
         },
       },
       sarif: {

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

@@ -1 +0,0 @@
-{"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,cAAc;IAUtB,OAAO,CAAC,QAAQ;CAcjB;AAED;;;GAGG;AACH,KAAK,gBAAgB,GAAG;IACtB,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB,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;IAClC;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAA"}

package/dist/model/Color.js

@@ -1,115 +0,0 @@
-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 color parameter 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.assertHexColor();
-    }
-    /**
-     * Returns a valid string that represents a color in hex format, or undefined.
-     */
-    get value() {
-        return this._color;
-    }
-    assertHexColor() {
-        if (this._color) {
-            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) {
-    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;
-    }
-    return undefined;
-}
-function identifyColorBySeverity(findings, color) {
-    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);
-}
-function identifyColorByLevel(findings, color) {
-    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);
-}
-/**
- * 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 FindingArray} object.
- * @param colorOpts An instance of {@link ColorOptions} type.
- * @internal
- */
-export function identifyColor(findings, colorOpts) {
-    if (!colorOpts) {
-        return undefined;
-    }
-    if (colorOpts.bySeverity) {
-        const color = identifyColorBySeverity(findings, colorOpts.bySeverity);
-        if (color !== undefined) {
-            return color;
-        }
-    }
-    if (colorOpts.byLevel) {
-        const color = identifyColorByLevel(findings, colorOpts.byLevel);
-        if (color !== undefined) {
-            return color;
-        }
-    }
-    if (findings.length === 0 && colorOpts.empty?.value !== undefined) {
-        return colorOpts.empty.value;
-    }
-    return colorOpts?.default?.value;
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ29sb3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvbW9kZWwvQ29sb3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLGFBQWEsRUFBRSxnQkFBZ0IsRUFBRSxNQUFNLFVBQVUsQ0FBQTtBQUkxRDs7O0dBR0c7QUFDSCxNQUFNLE9BQU8sS0FBSztJQUNDLE1BQU0sQ0FBUztJQUVoQzs7Ozs7Ozs7T0FRRztJQUNILFlBQW1CLEtBQWM7UUFDL0IsSUFBSSxDQUFDLE1BQU0sR0FBRyxJQUFJLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxDQUFBO1FBQ2xDLElBQUksQ0FBQyxjQUFjLEVBQUUsQ0FBQTtJQUN2QixDQUFDO0lBRUQ7O09BRUc7SUFDSCxJQUFXLEtBQUs7UUFDZCxPQUFPLElBQUksQ0FBQyxNQUFNLENBQUE7SUFDcEIsQ0FBQztJQUVPLGNBQWM7UUFDcEIsSUFBSSxJQUFJLENBQUMsTUFBTSxFQUFFLENBQUM7WUFDaEIsTUFBTSxhQUFhLEdBQUcsb0VBQW9FLENBQUE7WUFFMUYsSUFBSSxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUM7Z0JBQ3JDLE1BQU0sSUFBSSxLQUFLLENBQUMsdUJBQXVCLElBQUksQ0FBQyxNQUFNLEdBQUcsQ0FBQyxDQUFBO1lBQ3hELENBQUM7UUFDSCxDQUFDO0lBQ0gsQ0FBQztJQUVPLFFBQVEsQ0FBQyxJQUFhO1FBQzVCLFFBQVEsSUFBSSxFQUFFLENBQUM7WUFDYixLQUFLLFNBQVM7Z0JBQ1osT0FBTyxTQUFTLENBQUE7WUFDbEIsS0FBSyxTQUFTO2dCQUNaLE9BQU8sU0FBUyxDQUFBO1lBQ2xCLEtBQUssV0FBVztnQkFDZCxPQUFPLFNBQVMsQ0FBQTtZQUNsQixLQUFLLFNBQVM7Z0JBQ1osT0FBTyxTQUFTLENBQUE7WUFDbEI7Z0JBQ0UsT0FBTyxJQUFJLENBQUE7UUFDZixDQUFDO0lBQ0gsQ0FBQztDQUNGO0FBK0RELFNBQVMsbUJBQW1CLENBQzFCLFFBQXNCLEVBQ3RCLElBQU8sRUFDUCxJQUFnQixFQUNoQixPQUFtQixFQUNuQixLQUF1QjtJQUV2QixJQUFJLEtBQUssQ0FBQyxJQUFJLElBQUksSUFBSSxJQUFJLFFBQVEsQ0FBQyxjQUFjLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFDO1FBQ3RFLE9BQU8sS0FBSyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUE7SUFDekIsQ0FBQztJQUVELElBQUksS0FBSyxDQUFDLE9BQU8sSUFBSSxJQUFJLElBQUksUUFBUSxDQUFDLGNBQWMsQ0FBQyxJQUFJLEVBQUUsT0FBTyxDQUFDLElBQUksSUFBSSxFQUFFLENBQUM7UUFDNUUsT0FBTyxLQUFLLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQTtJQUM1QixDQUFDO0lBRUQsT0FBTyxTQUFTLENBQUE7QUFDbEIsQ0FBQztBQUVELFNBQVMsdUJBQXVCLENBQUMsUUFBc0IsRUFBRSxLQUEyQjtJQUNsRixJQUFJLEtBQUssQ0FBQyxRQUFRLElBQUksSUFBSSxJQUFJLFFBQVEsQ0FBQyxjQUFjLENBQUMsVUFBVSxFQUFFLGdCQUFnQixDQUFDLFFBQVEsQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFDO1FBQ3JHLE9BQU8sS0FBSyxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUE7SUFDN0IsQ0FBQztJQUVELElBQUksS0FBSyxDQUFDLElBQUksSUFBSSxJQUFJLElBQUksUUFBUSxDQUFDLGNBQWMsQ0FBQyxVQUFVLEVBQUUsZ0JBQWdCLENBQUMsSUFBSSxDQUFDLElBQUksSUFBSSxFQUFFLENBQUM7UUFDN0YsT0FBTyxLQUFLLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQTtJQUN6QixDQUFDO0lBRUQsSUFBSSxLQUFLLENBQUMsTUFBTSxJQUFJLElBQUksSUFBSSxRQUFRLENBQUMsY0FBYyxDQUFDLFVBQVUsRUFBRSxnQkFBZ0IsQ0FBQyxNQUFNLENBQUMsSUFBSSxJQUFJLEVBQUUsQ0FBQztRQUNqRyxPQUFPLEtBQUssQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFBO0lBQzNCLENBQUM7SUFFRCxJQUFJLEtBQUssQ0FBQyxHQUFHLElBQUksSUFBSSxJQUFJLFFBQVEsQ0FBQyxjQUFjLENBQUMsVUFBVSxFQUFFLGdCQUFnQixDQUFDLEdBQUcsQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFDO1FBQzNGLE9BQU8sS0FBSyxDQUFDLEdBQUcsQ0FBQyxLQUFLLENBQUE7SUFDeEIsQ0FBQztJQUVELE9BQU8sbUJBQW1CLENBQUMsUUFBUSxFQUFFLFVBQVUsRUFBRSxnQkFBZ0IsQ0FBQyxJQUFJLEVBQUUsZ0JBQWdCLENBQUMsT0FBTyxFQUFFLEtBQUssQ0FBQyxDQUFBO0FBQzFHLENBQUM7QUFFRCxTQUFTLG9CQUFvQixDQUFDLFFBQXNCLEVBQUUsS0FBd0I7SUFDNUUsSUFBSSxLQUFLLENBQUMsS0FBSyxJQUFJLElBQUksSUFBSSxRQUFRLENBQUMsY0FBYyxDQUFDLE9BQU8sRUFBRSxhQUFhLENBQUMsS0FBSyxDQUFDLElBQUksSUFBSSxFQUFFLENBQUM7UUFDekYsT0FBTyxLQUFLLENBQUMsS0FBSyxDQUFDLEtBQUssQ0FBQTtJQUMxQixDQUFDO0lBRUQsSUFBSSxLQUFLLENBQUMsT0FBTyxJQUFJLElBQUksSUFBSSxRQUFRLENBQUMsY0FBYyxDQUFDLE9BQU8sRUFBRSxhQUFhLENBQUMsT0FBTyxDQUFDLElBQUksSUFBSSxFQUFFLENBQUM7UUFDN0YsT0FBTyxLQUFLLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQTtJQUM1QixDQUFDO0lBRUQsSUFBSSxLQUFLLENBQUMsSUFBSSxJQUFJLElBQUksSUFBSSxRQUFRLENBQUMsY0FBYyxDQUFDLE9BQU8sRUFBRSxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksSUFBSSxFQUFFLENBQUM7UUFDdkYsT0FBTyxLQUFLLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQTtJQUN6QixDQUFDO0lBRUQsT0FBTyxtQkFBbUIsQ0FBQyxRQUFRLEVBQUUsT0FBTyxFQUFFLGFBQWEsQ0FBQyxJQUFJLEVBQUUsYUFBYSxDQUFDLE9BQU8sRUFBRSxLQUFLLENBQUMsQ0FBQTtBQUNqRyxDQUFDO0FBRUQ7Ozs7Ozs7R0FPRztBQUNILE1BQU0sVUFBVSxhQUFhLENBQUMsUUFBc0IsRUFBRSxTQUF3QjtJQUM1RSxJQUFJLENBQUMsU0FBUyxFQUFFLENBQUM7UUFDZixPQUFPLFNBQVMsQ0FBQTtJQUNsQixDQUFDO0lBRUQsSUFBSSxTQUFTLENBQUMsVUFBVSxFQUFFLENBQUM7UUFDekIsTUFBTSxLQUFLLEdBQXVCLHVCQUF1QixDQUFDLFFBQVEsRUFBRSxTQUFTLENBQUMsVUFBVSxDQUFDLENBQUE7UUFDekYsSUFBSSxLQUFLLEtBQUssU0FBUyxFQUFFLENBQUM7WUFDeEIsT0FBTyxLQUFLLENBQUE7UUFDZCxDQUFDO0lBQ0gsQ0FBQztJQUVELElBQUksU0FBUyxDQUFDLE9BQU8sRUFBRSxDQUFDO1FBQ3RCLE1BQU0sS0FBSyxHQUF1QixvQkFBb0IsQ0FBQyxRQUFRLEVBQUUsU0FBUyxDQUFDLE9BQU8sQ0FBQyxDQUFBO1FBQ25GLElBQUksS0FBSyxLQUFLLFNBQVMsRUFBRSxDQUFDO1lBQ3hCLE9BQU8sS0FBSyxDQUFBO1FBQ2QsQ0FBQztJQUNILENBQUM7SUFFRCxJQUFJLFFBQVEsQ0FBQyxNQUFNLEtBQUssQ0FBQyxJQUFJLFNBQVMsQ0FBQyxLQUFLLEVBQUUsS0FBSyxLQUFLLFNBQVMsRUFBRSxDQUFDO1FBQ2xFLE9BQU8sU0FBUyxDQUFDLEtBQUssQ0FBQyxLQUFLLENBQUE7SUFDOUIsQ0FBQztJQUVELE9BQU8sU0FBUyxFQUFFLE9BQU8sRUFBRSxLQUFLLENBQUE7QUFDbEMsQ0FBQyJ9

package/src/model/Color.ts

@@ -1,206 +0,0 @@
-import { SecurityLevel, SecuritySeverity } from '../types'
-import Finding from './Finding'
-import FindingArray from './FindingArray'
-
-/**
- * This class represents a color in hex format.
- * @public
- */
-export class Color {
-  private readonly _color?: string
-
-  /**
-   * 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 color parameter 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
-   */
-  public constructor(color?: string) {
-    this._color = this.mapColor(color)
-    this.assertHexColor()
-  }
-
-  /**
-   * Returns a valid string that represents a color in hex format, or undefined.
-   */
-  public get value(): string | undefined {
-    return this._color
-  }
-
-  private assertHexColor(): void {
-    if (this._color) {
-      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}"`)
-      }
-    }
-  }
-
-  private mapColor(from?: string): string | undefined {
-    switch (from) {
-      case 'success':
-        return '#008000'
-      case 'failure':
-        return '#ff0000'
-      case 'cancelled':
-        return '#0047ab'
-      case 'skipped':
-        return '#808080'
-      default:
-        return from
-    }
-  }
-}
-
-/**
- * Base type that has common fields for both {@link ColorGroupByLevel} and
- * {@link ColorGroupBySeverity}.
- */
-type ColorGroupCommon = {
-  none?: Color,
-  unknown?: 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,
-  /**
-   * Color when no findings are found.
-   */
-  empty?: Color,
-}
-
-function identifyColorCommon<K extends keyof Finding>(
-  findings: FindingArray,
-  prop: K,
-  none: Finding[K],
-  unknown: Finding[K],
-  color: ColorGroupCommon
-): string | undefined {
-  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
-  }
-
-  return undefined
-}
-
-function identifyColorBySeverity(findings: FindingArray, color: ColorGroupBySeverity): string | undefined {
-  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)
-}
-
-function identifyColorByLevel(findings: FindingArray, color: ColorGroupByLevel): string | undefined {
-  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)
-}
-
-/**
- * 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 FindingArray} object.
- * @param colorOpts An instance of {@link ColorOptions} type.
- * @internal
- */
-export function identifyColor(findings: FindingArray, colorOpts?: ColorOptions): string | undefined {
-  if (!colorOpts) {
-    return undefined
-  }
-
-  if (colorOpts.bySeverity) {
-    const color: string | undefined = identifyColorBySeverity(findings, colorOpts.bySeverity)
-    if (color !== undefined) {
-      return color
-    }
-  }
-
-  if (colorOpts.byLevel) {
-    const color: string | undefined = identifyColorByLevel(findings, colorOpts.byLevel)
-    if (color !== undefined) {
-      return color
-    }
-  }
-
-  if (findings.length === 0 && colorOpts.empty?.value !== undefined) {
-    return colorOpts.empty.value
-  }
-
-  return colorOpts?.default?.value
-}