@fabasoad/sarif-to-slack 1.1.0 → 1.2.0

package/dist/types.d.ts

@@ -1,19 +1,5 @@
 import { ColorOptions } from './model/Color';
-/**
- * Interface for a Slack message that can be sent.
- * @public
- */
-export interface SlackMessage {
-    /**
-     * Sends the Slack message.
-     * @returns A promise that resolves to the response from the Slack webhook.
-     */
-    send: () => Promise<string>;
-    withActor(actor?: string): void;
-    withFooter(text?: string, type?: FooterType): void;
-    withHeader(header?: string): void;
-    withRun(): void;
-}
+import { SendIf } from './model/SendIf';
 /**
  * Enum representing log levels for the service.
  * @public
@@ -208,121 +194,6 @@ export type SarifOptions = {
     recursive?: boolean;
     extension?: SarifFileExtension;
 };
-/**
- * This enum represents the condition on when message should be sent. If this
- * condition is satisfied then message is sent, otherwise - message is not sent.
- * @public
- */
-export declare enum SendIf {
-    /**
-     * Send message only if there is at least one finding with "Critical" severity.
-     * Since it is the higher possible severity, it is the same as "Critical" or
-     * higher.
-     */
-    SeverityCritical = 0,
-    /**
-     * Send message only if there is at least one finding with "High" severity.
-     */
-    SeverityHigh = 1,
-    /**
-     * Send message only if there is at least one finding with "High" severity or
-     * higher, that includes "High" and "Critical".
-     */
-    SeverityHighOrHigher = 2,
-    /**
-     * Send message only if there is at least one finding with "Medium" severity.
-     */
-    SeverityMedium = 3,
-    /**
-     * Send message only if there is at least one finding with "Medium" severity
-     * or higher, that includes "Medium", "High" and "Critical".
-     */
-    SeverityMediumOrHigher = 4,
-    /**
-     * Send message only if there is at least one finding with "Low" severity.
-     */
-    SeverityLow = 5,
-    /**
-     * Send message only if there is at least one finding with "Low" severity or
-     * higher, that includes "Low", "Medium", "High" and "Critical".
-     */
-    SeverityLowOrHigher = 6,
-    /**
-     * Send message only if there is at least one finding with "None" severity.
-     */
-    SeverityNone = 7,
-    /**
-     * Send message only if there is at least one finding with "None" severity or
-     * higher, that includes "None", "Low", "Medium", "High" and "Critical".
-     */
-    SeverityNoneOrHigher = 8,
-    /**
-     * Send message only if there is at least one finding with "Unknown" severity.
-     */
-    SeverityUnknown = 9,
-    /**
-     * Send message only if there is at least one finding with "Unknown" severity
-     * or higher, that includes "Unknown", "None", "Low", "Medium", "High" and "Critical".
-     */
-    SeverityUnknownOrHigher = 10,
-    /**
-     * Send message only if there is at least one finding with "Error" level.
-     * Since it is the higher possible level, it is the same as "Error" or higher.
-     */
-    LevelError = 11,
-    /**
-     * Send message only if there is at least one finding with "Warning" level.
-     */
-    LevelWarning = 12,
-    /**
-     * Send message only if there is at least one finding with "Warning" level or
-     * higher, that includes "Warning" and "Error".
-     */
-    LevelWarningOrHigher = 13,
-    /**
-     * Send message only if there is at least one finding with "Note" level.
-     */
-    LevelNote = 14,
-    /**
-     * Send message only if there is at least one finding with "Note" level or
-     * higher, that includes "Note", "Warning" and "Error.
-     */
-    LevelNoteOrHigher = 15,
-    /**
-     * Send message only if there is at least one finding with "None" level.
-     */
-    LevelNone = 16,
-    /**
-     * Send message only if there is at least one finding with "None" level or
-     * higher, that includes "None", "Note", "Warning" and "Error.
-     */
-    LevelNoneOrHigher = 17,
-    /**
-     * Send message only if there is at least one finding with "Unknown" level.
-     */
-    LevelUnknown = 18,
-    /**
-     * Send message only if there is at least one finding with "Unknown" level or
-     * higher, that includes "Unknown", "None", "Note", "Warning" and "Error.
-     */
-    LevelUnknownOrHigher = 19,
-    /**
-     * Always send a message.
-     */
-    Always = 20,
-    /**
-     * Send a message if at least 1 vulnerability is found.
-     */
-    Some = 21,
-    /**
-     * Send a message only if no vulnerabilities are found.
-     */
-    Empty = 22,
-    /**
-     * Never send a message.
-     */
-    Never = 23
-}
 /**
  * Options for the SarifToSlackClient.
  * @public

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAG5C;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;IAC3B,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAClD,UAAU,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,OAAO,IAAI,IAAI,CAAA;CAChB;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAClB;;;OAGG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,KAAK,IAAI;IACT;;;OAGG;IACH,KAAK,IAAI;IACT;;;OAGG;IACH,IAAI,IAAI;IACR;;;OAGG;IACH,OAAO,IAAI;IACX;;;OAGG;IACH,KAAK,IAAI;IACT;;;OAGG;IACH,KAAK,IAAI;CACV;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG,mBAAmB,GAAG;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;GAGG;AACH,oBAAY,UAAU;IACpB;;OAEG;IACH,SAAS,eAAe;IACxB;;;OAGG;IACH,QAAQ,WAAW;CACpB;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,4BAA4B,GAAG;IACzD,IAAI,CAAC,EAAE,UAAU,CAAA;CAClB,CAAA;AAED;;;;GAIG;AACH,oBAAY,kBAAkB;IAC5B;;;;;;;;;OASG;IACH,yBAAyB,IAAI;IAC7B;;;;;;;;;OASG;IACH,4BAA4B,IAAI;IAChC;;;;;;;OAOG;IACH,8BAA8B,IAAI;IAClC;;;;;;;OAOG;IACH,iCAAiC,IAAI;IACrC;;;;;;;;;OASG;IACH,2BAA2B,IAAI;IAC/B;;;;;;;;;;OAUG;IACH,8BAA8B,IAAI;IAClC;;;;;;;OAOG;IACH,oBAAoB,IAAI;IACxB;;;;;;;OAOG;IACH,uBAAuB,IAAI;CAC5B;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,MAAM,CAAA;AAEjD;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,kBAAkB,CAAC;CAChC,CAAA;AAED;;;;GAIG;AACH,oBAAY,MAAM;IAChB;;;;OAIG;IACH,gBAAgB,IAAA;IAChB;;OAEG;IACH,YAAY,IAAA;IACZ;;;OAGG;IACH,oBAAoB,IAAA;IACpB;;OAEG;IACH,cAAc,IAAA;IACd;;;OAGG;IACH,sBAAsB,IAAA;IACtB;;OAEG;IACH,WAAW,IAAA;IACX;;;OAGG;IACH,mBAAmB,IAAA;IACnB;;OAEG;IACH,YAAY,IAAA;IACZ;;;OAGG;IACH,oBAAoB,IAAA;IACpB;;OAEG;IACH,eAAe,IAAA;IACf;;;OAGG;IACH,uBAAuB,KAAA;IACvB;;;OAGG;IACH,UAAU,KAAA;IACV;;OAEG;IACH,YAAY,KAAA;IACZ;;;OAGG;IACH,oBAAoB,KAAA;IACpB;;OAEG;IACH,SAAS,KAAA;IACT;;;OAGG;IACH,iBAAiB,KAAA;IACjB;;OAEG;IACH,SAAS,KAAA;IACT;;;OAGG;IACH,iBAAiB,KAAA;IACjB;;OAEG;IACH,YAAY,KAAA;IACZ;;;OAGG;IACH,oBAAoB,KAAA;IACpB;;OAEG;IACH,MAAM,KAAA;IACN;;OAEG;IACH,IAAI,KAAA;IACJ;;OAEG;IACH,KAAK,KAAA;IACL;;OAEG;IACH,KAAK,KAAA;CACN;AAED;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,YAAY,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,GAAG,CAAC,EAAE,UAAU,CAAC;IACjB,MAAM,CAAC,EAAE,4BAA4B,CAAC;IACtC,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,KAAK,CAAC,EAAE,4BAA4B,CAAC;IACrC,GAAG,CAAC,EAAE,mBAAmB,CAAC;IAC1B,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE5C,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAEvC;;;GAGG;AACH,oBAAY,QAAQ;IAClB;;;OAGG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,KAAK,IAAI;IACT;;;OAGG;IACH,KAAK,IAAI;IACT;;;OAGG;IACH,IAAI,IAAI;IACR;;;OAGG;IACH,OAAO,IAAI;IACX;;;OAGG;IACH,KAAK,IAAI;IACT;;;OAGG;IACH,KAAK,IAAI;CACV;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG,mBAAmB,GAAG;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;GAGG;AACH,oBAAY,UAAU;IACpB;;OAEG;IACH,SAAS,eAAe;IACxB;;;OAGG;IACH,QAAQ,WAAW;CACpB;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,4BAA4B,GAAG;IACzD,IAAI,CAAC,EAAE,UAAU,CAAA;CAClB,CAAA;AAED;;;;GAIG;AACH,oBAAY,kBAAkB;IAC5B;;;;;;;;;OASG;IACH,yBAAyB,IAAI;IAC7B;;;;;;;;;OASG;IACH,4BAA4B,IAAI;IAChC;;;;;;;OAOG;IACH,8BAA8B,IAAI;IAClC;;;;;;;OAOG;IACH,iCAAiC,IAAI;IACrC;;;;;;;;;OASG;IACH,2BAA2B,IAAI;IAC/B;;;;;;;;;;OAUG;IACH,8BAA8B,IAAI;IAClC;;;;;;;OAOG;IACH,oBAAoB,IAAI;IACxB;;;;;;;OAOG;IACH,uBAAuB,IAAI;CAC5B;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,MAAM,CAAA;AAEjD;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,kBAAkB,CAAC;CAChC,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,YAAY,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,GAAG,CAAC,EAAE,UAAU,CAAC;IACjB,MAAM,CAAC,EAAE,4BAA4B,CAAC;IACtC,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,KAAK,CAAC,EAAE,4BAA4B,CAAC;IACrC,GAAG,CAAC,EAAE,mBAAmB,CAAC;IAC1B,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAA"}

package/dist/types.js

@@ -144,122 +144,6 @@ export var RepresentationType;
      */
     RepresentationType[RepresentationType["CompactTotalPerSeverity"] = 7] = "CompactTotalPerSeverity";
 })(RepresentationType || (RepresentationType = {}));
-/**
- * This enum represents the condition on when message should be sent. If this
- * condition is satisfied then message is sent, otherwise - message is not sent.
- * @public
- */
-export var SendIf;
-(function (SendIf) {
-    /**
-     * Send message only if there is at least one finding with "Critical" severity.
-     * Since it is the higher possible severity, it is the same as "Critical" or
-     * higher.
-     */
-    SendIf[SendIf["SeverityCritical"] = 0] = "SeverityCritical";
-    /**
-     * Send message only if there is at least one finding with "High" severity.
-     */
-    SendIf[SendIf["SeverityHigh"] = 1] = "SeverityHigh";
-    /**
-     * Send message only if there is at least one finding with "High" severity or
-     * higher, that includes "High" and "Critical".
-     */
-    SendIf[SendIf["SeverityHighOrHigher"] = 2] = "SeverityHighOrHigher";
-    /**
-     * Send message only if there is at least one finding with "Medium" severity.
-     */
-    SendIf[SendIf["SeverityMedium"] = 3] = "SeverityMedium";
-    /**
-     * Send message only if there is at least one finding with "Medium" severity
-     * or higher, that includes "Medium", "High" and "Critical".
-     */
-    SendIf[SendIf["SeverityMediumOrHigher"] = 4] = "SeverityMediumOrHigher";
-    /**
-     * Send message only if there is at least one finding with "Low" severity.
-     */
-    SendIf[SendIf["SeverityLow"] = 5] = "SeverityLow";
-    /**
-     * Send message only if there is at least one finding with "Low" severity or
-     * higher, that includes "Low", "Medium", "High" and "Critical".
-     */
-    SendIf[SendIf["SeverityLowOrHigher"] = 6] = "SeverityLowOrHigher";
-    /**
-     * Send message only if there is at least one finding with "None" severity.
-     */
-    SendIf[SendIf["SeverityNone"] = 7] = "SeverityNone";
-    /**
-     * Send message only if there is at least one finding with "None" severity or
-     * higher, that includes "None", "Low", "Medium", "High" and "Critical".
-     */
-    SendIf[SendIf["SeverityNoneOrHigher"] = 8] = "SeverityNoneOrHigher";
-    /**
-     * Send message only if there is at least one finding with "Unknown" severity.
-     */
-    SendIf[SendIf["SeverityUnknown"] = 9] = "SeverityUnknown";
-    /**
-     * Send message only if there is at least one finding with "Unknown" severity
-     * or higher, that includes "Unknown", "None", "Low", "Medium", "High" and "Critical".
-     */
-    SendIf[SendIf["SeverityUnknownOrHigher"] = 10] = "SeverityUnknownOrHigher";
-    /**
-     * Send message only if there is at least one finding with "Error" level.
-     * Since it is the higher possible level, it is the same as "Error" or higher.
-     */
-    SendIf[SendIf["LevelError"] = 11] = "LevelError";
-    /**
-     * Send message only if there is at least one finding with "Warning" level.
-     */
-    SendIf[SendIf["LevelWarning"] = 12] = "LevelWarning";
-    /**
-     * Send message only if there is at least one finding with "Warning" level or
-     * higher, that includes "Warning" and "Error".
-     */
-    SendIf[SendIf["LevelWarningOrHigher"] = 13] = "LevelWarningOrHigher";
-    /**
-     * Send message only if there is at least one finding with "Note" level.
-     */
-    SendIf[SendIf["LevelNote"] = 14] = "LevelNote";
-    /**
-     * Send message only if there is at least one finding with "Note" level or
-     * higher, that includes "Note", "Warning" and "Error.
-     */
-    SendIf[SendIf["LevelNoteOrHigher"] = 15] = "LevelNoteOrHigher";
-    /**
-     * Send message only if there is at least one finding with "None" level.
-     */
-    SendIf[SendIf["LevelNone"] = 16] = "LevelNone";
-    /**
-     * Send message only if there is at least one finding with "None" level or
-     * higher, that includes "None", "Note", "Warning" and "Error.
-     */
-    SendIf[SendIf["LevelNoneOrHigher"] = 17] = "LevelNoneOrHigher";
-    /**
-     * Send message only if there is at least one finding with "Unknown" level.
-     */
-    SendIf[SendIf["LevelUnknown"] = 18] = "LevelUnknown";
-    /**
-     * Send message only if there is at least one finding with "Unknown" level or
-     * higher, that includes "Unknown", "None", "Note", "Warning" and "Error.
-     */
-    SendIf[SendIf["LevelUnknownOrHigher"] = 19] = "LevelUnknownOrHigher";
-    /**
-     * Always send a message.
-     */
-    SendIf[SendIf["Always"] = 20] = "Always";
-    /**
-     * Send a message if at least 1 vulnerability is found.
-     */
-    SendIf[SendIf["Some"] = 21] = "Some";
-    /**
-     * Send a message only if no vulnerabilities are found.
-     */
-    SendIf[SendIf["Empty"] = 22] = "Empty";
-    /**
-     * Never send a message.
-     */
-    SendIf[SendIf["Never"] = 23] = "Never";
-})(SendIf || (SendIf = {}));
 /**
  * Enum of security severity.
  * @privateRemarks Order should remain unchanged. It is used in multiple places,
@@ -291,4 +175,4 @@ export var SecurityLevel;
     SecurityLevel[SecurityLevel["Warning"] = 3] = "Warning";
     SecurityLevel[SecurityLevel["Error"] = 4] = "Error";
 })(SecurityLevel || (SecurityLevel = {}));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBb0JBOzs7R0FHRztBQUNILE1BQU0sQ0FBTixJQUFZLFFBbUNYO0FBbkNELFdBQVksUUFBUTtJQUNsQjs7O09BR0c7SUFDSCx5Q0FBUyxDQUFBO0lBQ1Q7O09BRUc7SUFDSCx5Q0FBUyxDQUFBO0lBQ1Q7OztPQUdHO0lBQ0gseUNBQVMsQ0FBQTtJQUNUOzs7T0FHRztJQUNILHVDQUFRLENBQUE7SUFDUjs7O09BR0c7SUFDSCw2Q0FBVyxDQUFBO0lBQ1g7OztPQUdHO0lBQ0gseUNBQVMsQ0FBQTtJQUNUOzs7T0FHRztJQUNILHlDQUFTLENBQUE7QUFDWCxDQUFDLEVBbkNXLFFBQVEsS0FBUixRQUFRLFFBbUNuQjtBQW9CRDs7O0dBR0c7QUFDSCxNQUFNLENBQU4sSUFBWSxVQVVYO0FBVkQsV0FBWSxVQUFVO0lBQ3BCOztPQUVHO0lBQ0gsc0NBQXdCLENBQUE7SUFDeEI7OztPQUdHO0lBQ0gsaUNBQW1CLENBQUE7QUFDckIsQ0FBQyxFQVZXLFVBQVUsS0FBVixVQUFVLFFBVXJCO0FBV0Q7Ozs7R0FJRztBQUNILE1BQU0sQ0FBTixJQUFZLGtCQWtGWDtBQWxGRCxXQUFZLGtCQUFrQjtJQUM1Qjs7Ozs7Ozs7O09BU0c7SUFDSCxxR0FBNkIsQ0FBQTtJQUM3Qjs7Ozs7Ozs7O09BU0c7SUFDSCwyR0FBZ0MsQ0FBQTtJQUNoQzs7Ozs7OztPQU9HO0lBQ0gsK0dBQWtDLENBQUE7SUFDbEM7Ozs7Ozs7T0FPRztJQUNILHFIQUFxQyxDQUFBO0lBQ3JDOzs7Ozs7Ozs7T0FTRztJQUNILHlHQUErQixDQUFBO0lBQy9COzs7Ozs7Ozs7O09BVUc7SUFDSCwrR0FBa0MsQ0FBQTtJQUNsQzs7Ozs7OztPQU9HO0lBQ0gsMkZBQXdCLENBQUE7SUFDeEI7Ozs7Ozs7T0FPRztJQUNILGlHQUEyQixDQUFBO0FBQzdCLENBQUMsRUFsRlcsa0JBQWtCLEtBQWxCLGtCQUFrQixRQWtGN0I7QUFnQ0Q7Ozs7R0FJRztBQUNILE1BQU0sQ0FBTixJQUFZLE1BNkdYO0FBN0dELFdBQVksTUFBTTtJQUNoQjs7OztPQUlHO0lBQ0gsMkRBQWdCLENBQUE7SUFDaEI7O09BRUc7SUFDSCxtREFBWSxDQUFBO0lBQ1o7OztPQUdHO0lBQ0gsbUVBQW9CLENBQUE7SUFDcEI7O09BRUc7SUFDSCx1REFBYyxDQUFBO0lBQ2Q7OztPQUdHO0lBQ0gsdUVBQXNCLENBQUE7SUFDdEI7O09BRUc7SUFDSCxpREFBVyxDQUFBO0lBQ1g7OztPQUdHO0lBQ0gsaUVBQW1CLENBQUE7SUFDbkI7O09BRUc7SUFDSCxtREFBWSxDQUFBO0lBQ1o7OztPQUdHO0lBQ0gsbUVBQW9CLENBQUE7SUFDcEI7O09BRUc7SUFDSCx5REFBZSxDQUFBO0lBQ2Y7OztPQUdHO0lBQ0gsMEVBQXVCLENBQUE7SUFDdkI7OztPQUdHO0lBQ0gsZ0RBQVUsQ0FBQTtJQUNWOztPQUVHO0lBQ0gsb0RBQVksQ0FBQTtJQUNaOzs7T0FHRztJQUNILG9FQUFvQixDQUFBO0lBQ3BCOztPQUVHO0lBQ0gsOENBQVMsQ0FBQTtJQUNUOzs7T0FHRztJQUNILDhEQUFpQixDQUFBO0lBQ2pCOztPQUVHO0lBQ0gsOENBQVMsQ0FBQTtJQUNUOzs7T0FHRztJQUNILDhEQUFpQixDQUFBO0lBQ2pCOztPQUVHO0lBQ0gsb0RBQVksQ0FBQTtJQUNaOzs7T0FHRztJQUNILG9FQUFvQixDQUFBO0lBQ3BCOztPQUVHO0lBQ0gsd0NBQU0sQ0FBQTtJQUNOOztPQUVHO0lBQ0gsb0NBQUksQ0FBQTtJQUNKOztPQUVHO0lBQ0gsc0NBQUssQ0FBQTtJQUNMOztPQUVHO0lBQ0gsc0NBQUssQ0FBQTtBQUNQLENBQUMsRUE3R1csTUFBTSxLQUFOLE1BQU0sUUE2R2pCO0FBcUJEOzs7Ozs7R0FNRztBQUNILE1BQU0sQ0FBTixJQUFZLGdCQU9YO0FBUEQsV0FBWSxnQkFBZ0I7SUFDMUIsNkRBQVcsQ0FBQTtJQUNYLHVEQUFRLENBQUE7SUFDUixxREFBTyxDQUFBO0lBQ1AsMkRBQVUsQ0FBQTtJQUNWLHVEQUFRLENBQUE7SUFDUiwrREFBWSxDQUFBO0FBQ2QsQ0FBQyxFQVBXLGdCQUFnQixLQUFoQixnQkFBZ0IsUUFPM0I7QUFFRDs7Ozs7O0dBTUc7QUFDSCxNQUFNLENBQU4sSUFBWSxhQU1YO0FBTkQsV0FBWSxhQUFhO0lBQ3ZCLHVEQUFXLENBQUE7SUFDWCxpREFBUSxDQUFBO0lBQ1IsaURBQVEsQ0FBQTtJQUNSLHVEQUFXLENBQUE7SUFDWCxtREFBUyxDQUFBO0FBQ1gsQ0FBQyxFQU5XLGFBQWEsS0FBYixhQUFhLFFBTXhCIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBS0E7OztHQUdHO0FBQ0gsTUFBTSxDQUFOLElBQVksUUFtQ1g7QUFuQ0QsV0FBWSxRQUFRO0lBQ2xCOzs7T0FHRztJQUNILHlDQUFTLENBQUE7SUFDVDs7T0FFRztJQUNILHlDQUFTLENBQUE7SUFDVDs7O09BR0c7SUFDSCx5Q0FBUyxDQUFBO0lBQ1Q7OztPQUdHO0lBQ0gsdUNBQVEsQ0FBQTtJQUNSOzs7T0FHRztJQUNILDZDQUFXLENBQUE7SUFDWDs7O09BR0c7SUFDSCx5Q0FBUyxDQUFBO0lBQ1Q7OztPQUdHO0lBQ0gseUNBQVMsQ0FBQTtBQUNYLENBQUMsRUFuQ1csUUFBUSxLQUFSLFFBQVEsUUFtQ25CO0FBb0JEOzs7R0FHRztBQUNILE1BQU0sQ0FBTixJQUFZLFVBVVg7QUFWRCxXQUFZLFVBQVU7SUFDcEI7O09BRUc7SUFDSCxzQ0FBd0IsQ0FBQTtJQUN4Qjs7O09BR0c7SUFDSCxpQ0FBbUIsQ0FBQTtBQUNyQixDQUFDLEVBVlcsVUFBVSxLQUFWLFVBQVUsUUFVckI7QUFXRDs7OztHQUlHO0FBQ0gsTUFBTSxDQUFOLElBQVksa0JBa0ZYO0FBbEZELFdBQVksa0JBQWtCO0lBQzVCOzs7Ozs7Ozs7T0FTRztJQUNILHFHQUE2QixDQUFBO0lBQzdCOzs7Ozs7Ozs7T0FTRztJQUNILDJHQUFnQyxDQUFBO0lBQ2hDOzs7Ozs7O09BT0c7SUFDSCwrR0FBa0MsQ0FBQTtJQUNsQzs7Ozs7OztPQU9HO0lBQ0gscUhBQXFDLENBQUE7SUFDckM7Ozs7Ozs7OztPQVNHO0lBQ0gseUdBQStCLENBQUE7SUFDL0I7Ozs7Ozs7Ozs7T0FVRztJQUNILCtHQUFrQyxDQUFBO0lBQ2xDOzs7Ozs7O09BT0c7SUFDSCwyRkFBd0IsQ0FBQTtJQUN4Qjs7Ozs7OztPQU9HO0lBQ0gsaUdBQTJCLENBQUE7QUFDN0IsQ0FBQyxFQWxGVyxrQkFBa0IsS0FBbEIsa0JBQWtCLFFBa0Y3QjtBQW1ERDs7Ozs7O0dBTUc7QUFDSCxNQUFNLENBQU4sSUFBWSxnQkFPWDtBQVBELFdBQVksZ0JBQWdCO0lBQzFCLDZEQUFXLENBQUE7SUFDWCx1REFBUSxDQUFBO0lBQ1IscURBQU8sQ0FBQTtJQUNQLDJEQUFVLENBQUE7SUFDVix1REFBUSxDQUFBO0lBQ1IsK0RBQVksQ0FBQTtBQUNkLENBQUMsRUFQVyxnQkFBZ0IsS0FBaEIsZ0JBQWdCLFFBTzNCO0FBRUQ7Ozs7OztHQU1HO0FBQ0gsTUFBTSxDQUFOLElBQVksYUFNWDtBQU5ELFdBQVksYUFBYTtJQUN2Qix1REFBVyxDQUFBO0lBQ1gsaURBQVEsQ0FBQTtJQUNSLGlEQUFRLENBQUE7SUFDUix1REFBVyxDQUFBO0lBQ1gsbURBQVMsQ0FBQTtBQUNYLENBQUMsRUFOVyxhQUFhLEtBQWIsYUFBYSxRQU14QiJ9

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

@@ -32,6 +32,7 @@ export type ColorOptions = {
     default?: Color;
     byLevel?: ColorGroupByLevel;
     bySeverity?: ColorGroupBySeverity;
+    empty?: Color;
 };
 
 // @public

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fabasoad/sarif-to-slack",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "TypeScript library to send results of SARIF file to Slack webhook URL.",
   "main": "dist/index.cjs",
   "module": "dist/index.js",

package/src/SarifToSlackClient.ts

@@ -1,7 +1,6 @@
 import { promises as fs } from 'fs'
 import { Log } from 'sarif'
 import Logger from './Logger'
-import { SlackMessageBuilder } from './SlackMessageBuilder'
 import {
   LogOptions,
   RunData,
@@ -9,9 +8,7 @@ import {
   SarifOptions,
   SarifToSlackClientOptions,
   SecurityLevel,
-  SecuritySeverity,
-  SendIf,
-  SlackMessage
+  SecuritySeverity
 } from './types'
 import System from './System'
 import { extractListOfFiles } from './utils/FileUtils'
@@ -19,7 +16,9 @@ import { createRepresentation } from './representations/RepresentationFactory'
 import { createFinding } from './model/Finding'
 import { findToolComponent, findToolComponentDriver } from './utils/SarifUtils'
 import { identifyColor } from './model/Color'
-import FindingsArray from './model/FindingsArray'
+import FindingArray from './model/FindingArray'
+import { createSlackMessage, SlackMessage } from './model/SlackMessage'
+import { SendIf, sendIfLogMessage } from './model/SendIf'
 
 /**
  * Service to convert SARIF files to Slack messages and send them.
@@ -45,12 +44,9 @@ export class SarifToSlackClient {
 
   public static async create(opts: SarifToSlackClientOptions): Promise<SarifToSlackClient> {
     const instance = new SarifToSlackClient(opts.log)
-    Logger.trace('opts', opts)
     instance._sendIf = opts.sendIf ?? instance._sendIf
     instance._sarifModel = await SarifToSlackClient.buildModel(opts.sarif)
-    Logger.trace('instance._sarifModel', instance._sarifModel)
     instance._message = await SarifToSlackClient.initialize(instance._sarifModel, opts)
-    Logger.trace('instance._message', instance._message)
     return instance;
   }
 
@@ -60,7 +56,7 @@ export class SarifToSlackClient {
       throw new Error(`No SARIF files found at the provided path: ${sarifOpts.path}`)
     }
 
-    const model: SarifModel = { sarifFiles, runs: [], findings: new FindingsArray() }
+    const model: SarifModel = { sarifFiles, runs: [], findings: new FindingArray() }
     const runIdGenerator: Generator<number> = SarifToSlackClient.createRunIdGenerator()
     for (const sarifPath of sarifFiles) {
       const sarifJson: string = await fs.readFile(sarifPath, 'utf8')
@@ -99,7 +95,7 @@ export class SarifToSlackClient {
     sarifModel: SarifModel,
     opts: Omit<SarifToSlackClientOptions, 'sarif' | 'log' | 'sendIf'>
   ): Promise<SlackMessage> {
-    const message: SlackMessage = new SlackMessageBuilder(opts.webhookUrl, {
+    const message: SlackMessage = createSlackMessage(opts.webhookUrl, {
       username: opts.username,
       iconUrl: opts.iconUrl,
       color: identifyColor(sarifModel.findings, opts.color),
@@ -137,7 +133,7 @@ export class SarifToSlackClient {
       const text: string = await this._message.send()
       Logger.info('Message sent. Status:', text)
     } else {
-      Logger.info('Message was not sent based on the sendIf parameter:', SendIf[this._sendIf])
+      Logger.info(sendIfLogMessage(this._sendIf))
     }
   }
 

package/src/index.ts

@@ -23,6 +23,8 @@
  *   username: 'SARIF to Slack Bot',
  *   iconUrl: 'https://example.com/icon.png',
  *   color: {
+ *     default: new Color('failure'),
+ *     empty: new Color('success'),
  *     bySeverity: {
  *       critical: new Color('#ff0000'),
  *       high: new Color('#ff4500'),
@@ -30,7 +32,13 @@
  *       low: new Color('#ffff00'),
  *       none: new Color('#808080'),
  *       unknown: new Color('#800080'),
- *       empty: new Color('#d3d3d3'),
+ *     },
+ *     byLevel: {
+ *       error: new Color('#ff0000'),
+ *       warning: new Color('#ffa500'),
+ *       note: new Color('#ffff00'),
+ *       none: new Color('#808080'),
+ *       unknown: new Color('#800080'),
  *     },
  *   },
  *   sarif: {
@@ -75,6 +83,8 @@ export {
   ColorGroupByLevel,
   ColorGroupBySeverity
 } from './model/Color'
+export { SendIf } from './model/SendIf'
+export { SlackMessage } from './model/SlackMessage'
 export { SarifToSlackClient } from './SarifToSlackClient'
 export {
   FooterOptions,
@@ -86,7 +96,5 @@ export {
   RepresentationType,
   SarifFileExtension,
   SarifOptions,
-  SarifToSlackClientOptions,
-  SendIf,
-  SlackMessage,
+  SarifToSlackClientOptions
 } from './types'

package/src/model/Color.ts

@@ -1,6 +1,6 @@
 import { SecurityLevel, SecuritySeverity } from '../types'
-import { Finding } from './Finding'
-import FindingsArray from './FindingsArray'
+import Finding from './Finding'
+import FindingArray from './FindingArray'
 
 /**
  * This class represents a color in hex format.
@@ -20,7 +20,7 @@ export class Color {
    */
   public constructor(color?: string) {
     this._color = this.mapColor(color)
-    this.validateHexColor()
+    this.assertHexColor()
   }
 
   /**
@@ -30,7 +30,7 @@ export class Color {
     return this._color
   }
 
-  private validateHexColor(): void {
+  private assertHexColor(): void {
     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})$/;
 
@@ -64,7 +64,6 @@ export class Color {
 type ColorGroupCommon = {
   none?: Color,
   unknown?: Color,
-  empty?: Color,
 }
 
 /**
@@ -113,10 +112,14 @@ export type ColorOptions = {
    * 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: FindingsArray,
+  findings: FindingArray,
   prop: K,
   none: Finding[K],
   unknown: Finding[K],
@@ -131,14 +134,10 @@ function identifyColorCommon<K extends keyof Finding>(
     return color.unknown.value
   }
 
-  if (color.empty != null && findings.length === 0) {
-    return color.empty.value
-  }
-
   return defaultColor?.value
 }
 
-function identifyColorBySeverity(findings: FindingsArray, color: ColorGroupBySeverity, defaultColor?: Color): string | undefined {
+function identifyColorBySeverity(findings: FindingArray, color: ColorGroupBySeverity, defaultColor?: Color): string | undefined {
   if (color.critical != null && findings.findByProperty('severity', SecuritySeverity.Critical) != null) {
     return color.critical.value
   }
@@ -158,7 +157,7 @@ function identifyColorBySeverity(findings: FindingsArray, color: ColorGroupBySev
   return identifyColorCommon(findings, 'severity', SecuritySeverity.None, SecuritySeverity.Unknown, color, defaultColor)
 }
 
-function identifyColorByLevel(findings: FindingsArray, color: ColorGroupByLevel, defaultColor?: Color): string | undefined {
+function identifyColorByLevel(findings: FindingArray, color: ColorGroupByLevel, defaultColor?: Color): string | undefined {
   if (color.error != null && findings.findByProperty('level', SecurityLevel.Error) != null) {
     return color.error.value
   }
@@ -178,18 +177,22 @@ function identifyColorByLevel(findings: FindingsArray, color: ColorGroupByLevel,
  * 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 findings An instance of {@link FindingArray} object.
  * @param colorOpts An instance of {@link ColorOptions} type.
  * @internal
  */
-export function identifyColor(findings: FindingsArray, colorOpts?: ColorOptions): string | undefined {
-  if (colorOpts?.bySeverity != null) {
-    return identifyColorBySeverity(findings, colorOpts.bySeverity, colorOpts.default)
-  }
+export function identifyColor(findings: FindingArray, colorOpts?: ColorOptions): string | undefined {
+  let result: string | undefined = colorOpts?.bySeverity
+    ? identifyColorBySeverity(findings, colorOpts.bySeverity, colorOpts.default)
+    : undefined
 
-  if (colorOpts?.byLevel != null) {
-    return identifyColorByLevel(findings, colorOpts.byLevel, colorOpts.default)
-  }
+  result ??= colorOpts?.byLevel
+    ? identifyColorByLevel(findings, colorOpts.byLevel, colorOpts.default)
+    : result
+
+  result ??= findings.length === 0 ? colorOpts?.empty?.value : result
+
+  result ??= colorOpts?.default?.value
 
-  return colorOpts?.default?.value
+  return result
 }

package/src/model/Finding.ts

@@ -18,7 +18,7 @@ export type FindingOptions = {
  * This interface represents a finding from SARIF file.
  * @internal
  */
-export interface Finding {
+export default interface Finding {
   get sarifPath(): string,
   get runId(): number,
   get toolName(): string,
@@ -33,7 +33,7 @@ export interface Finding {
  * @internal
  */
 export function createFinding(opts: FindingOptions): Finding {
-  return new SarifFinding(opts)
+  return new FindingImpl(opts)
 }
 
 /**
@@ -42,7 +42,7 @@ export function createFinding(opts: FindingOptions): Finding {
  * create a new {@link Finding}.
  * @private
  */
-class SarifFinding implements Finding {
+class FindingImpl implements Finding {
   private readonly _runMetadata: RunData
   private readonly _result: Result
   private readonly _sarifPath: string

package/src/model/{FindingsArray.ts → FindingArray.ts}

@@ -1,13 +1,13 @@
-import { Finding } from './Finding'
-import ExtendedArray from '../utils/ExtendedArray'
+import Finding from './Finding'
 import { SecurityLevel, SecuritySeverity } from '../types'
+import ExtendedArray from '../utils/ExtendedArray'
 
 /**
  * This class represents an array of {@link Finding} objects and adds additional
  * useful methods to it.
  * @internal
  */
-export default class FindingsArray extends ExtendedArray<Finding> {
+export default class FindingArray extends ExtendedArray<Finding> {
 
   public hasSeverityOrHigher(severity: SecuritySeverity): boolean {
     return Object