@fabasoad/sarif-to-slack 0.1.1 → 0.2.1

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

@@ -7,12 +7,16 @@
  *
  * @example
  * ```typescript
- * import { SarifToSlackService } from 'sarif-to-slack';
+ * import { SarifToSlackService, FooterType } from '@fabasoad/sarif-to-slack';
  *
- * const service = new SarifToSlackService({
+ * const service = await SarifToSlackService.create({
  *   webhookUrl: 'https://hooks.slack.com/services/your/webhook/url',
  *   sarifPath: 'path/to/your/sarif/file.sarif',
- *   logLevel: 'info',
+ *   log: {
+ *     level: 'info',
+ *     template: '[{{logLevelName}}] [{{name}}] {{dateIsoStr}} ',
+ *     colored: false,
+ *   },
  *   username: 'SARIF Bot',
  *   iconUrl: 'https://example.com/icon.png',
  *   color: '#36a64f',
@@ -22,6 +26,7 @@
  *   },
  *   footer: {
  *     include: true,
+ *     type: FooterType.PLAIN_TEXT,
  *     value: 'Generated by @fabasoad/sarif-to-slack'
  *   },
  *   actor: {
@@ -42,12 +47,81 @@
 
 import type { Log } from 'sarif';
 
+/**
+ * Enum representing how to calculate results.
+ * @public
+ */
+export declare enum CalculateResultsBy {
+    /**
+     * Calculates results by the security level of the findings: Error, Warning,
+     * Note and Unknown. At first, it tries to get the security level from runs[].results[].level
+     * property. If it is not defined, it tries to get the security level from the
+     * respective rule of each result, using the rules[].properties['problem.severity']
+     * property.
+     */
+    Level = 0,
+    /**
+     * Calculates results by the security severity of the findings: Critical, High,
+     * Medium, Low, None and Unknown. it tries to get the security severity from the
+     * respective rule of each result, using the rules[].properties['security-severity']
+     * property. This property contains CVSS score, which is then mapped to the
+     * security severity value.
+     */
+    Severity = 1
+}
+
+/**
+ * Options for the footer of a Slack message. "type" is ignored if "value" is
+ * not defined.
+ * @public
+ */
+export declare type FooterOptions = IncludeAwareWithValueOptions & {
+    type?: FooterType;
+};
+
+/**
+ * Enum representing the type of footer in a Slack message.
+ * @public
+ */
+export declare enum FooterType {
+    /**
+     * Represents a plain text footer. Text is not formatted and appears as-is.
+     */
+    PlainText = "plain_text",
+    /**
+     * Represents a footer with Markdown formatting. Text can include formatting
+     * such as bold, italics, and links.
+     */
+    Markdown = "mrkdwn"
+}
+
+/**
+ * Enum representing how to group results.
+ * @public
+ */
+export declare enum GroupResultsBy {
+    /**
+     * Groups results by the tool name. Particularly, groups by the runs[].tool.driver.name
+     * property from the SARIF file(s).
+     */
+    ToolName = 0,
+    /**
+     * Groups results by the run. It provides the result from each run individually.
+     */
+    Run = 1,
+    /**
+     * Does not group results. It provides the result from all the runs from all
+     * the provided SARIF files.
+     */
+    Total = 2
+}
+
 /**
  * Type representing properties that indicate whether to include certain information
  * in the Slack message.
  * @public
  */
-export declare type IncludeAwareProps = {
+export declare type IncludeAwareOptions = {
     include: boolean;
 };
 
@@ -56,7 +130,7 @@ export declare type IncludeAwareProps = {
  * in the Slack message, along with an optional value.
  * @public
  */
-export declare type IncludeAwareWithValueProps = IncludeAwareProps & {
+export declare type IncludeAwareWithValueOptions = IncludeAwareOptions & {
     value?: string;
 };
 
@@ -66,7 +140,8 @@ export declare type IncludeAwareWithValueProps = IncludeAwareProps & {
  */
 export declare enum LogLevel {
     /**
-     * Represents the most verbose logging level, typically used for detailed debugging information.
+     * Represents the most verbose logging level, typically used for detailed
+     * debugging information.
      */
     Silly = 0,
     /**
@@ -74,32 +149,59 @@ export declare enum LogLevel {
      */
     Trace = 1,
     /**
-     * Represents a logging level for debugging information that is less verbose than silly.
+     * Represents a logging level for debugging information that is less verbose
+     * than silly.
      */
     Debug = 2,
     /**
-     * Represents a logging level for general informational messages that highlight the progress of the application.
+     * Represents a logging level for general informational messages that highlight
+     * the progress of the application.
      */
     Info = 3,
     /**
-     * Represents a logging level for potentially harmful situations that require attention.
+     * Represents a logging level for potentially harmful situations that require
+     * attention.
      */
     Warning = 4,
     /**
-     * Represents a logging level for error conditions that do not require immediate action but should be noted.
+     * Represents a logging level for error conditions that do not require immediate
+     * action but should be noted.
      */
     Error = 5,
     /**
-     * Represents a logging level for critical errors that require immediate attention and may cause the application to terminate.
+     * Represents a logging level for critical errors that require immediate attention
+     * and may cause the application to terminate.
      */
     Fatal = 6
 }
 
+/**
+ * Options for logging.
+ * @public
+ */
+export declare type LogOptions = {
+    level?: LogLevel;
+    /**
+     * More details here: https://github.com/fullstack-build/tslog?tab=readme-ov-file#pretty-templates-and-styles-color-settings
+     */
+    template?: string;
+    colored?: boolean;
+};
+
 /**
  * Type representing a SARIF log.
  * @public
  */
-export declare type Sarif = Log;
+export declare type SarifLog = Log;
+
+/**
+ * Options for how to output the results in the Slack message.
+ * @public
+ */
+export declare type SarifToSlackOutput = {
+    groupBy: GroupResultsBy;
+    calculateBy: CalculateResultsBy;
+};
 
 /**
  * Service to convert SARIF files to Slack messages and send them.
@@ -149,11 +251,12 @@ export declare type SarifToSlackServiceOptions = {
     username?: string;
     iconUrl?: string;
     color?: string;
-    logLevel?: LogLevel | string;
-    header?: IncludeAwareWithValueProps;
-    footer?: IncludeAwareWithValueProps;
-    actor?: IncludeAwareWithValueProps;
-    run?: IncludeAwareProps;
+    log?: LogOptions;
+    header?: IncludeAwareWithValueOptions;
+    footer?: FooterOptions;
+    actor?: IncludeAwareWithValueOptions;
+    run?: IncludeAwareOptions;
+    output?: SarifToSlackOutput;
 };
 
 /**
@@ -169,7 +272,7 @@ export declare interface SlackMessage {
     /**
      * The SARIF log associated with this Slack message.
      */
-    sarif: Sarif;
+    sarif: SarifLog;
 }
 
 export { }

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.52.8"
+      "packageVersion": "7.52.9"
     }
   ]
 }

package/dist/types.d.ts

@@ -3,7 +3,7 @@ import type { Log } from 'sarif';
  * Type representing a SARIF log.
  * @public
  */
-export type Sarif = Log;
+export type SarifLog = Log;
 /**
  * Interface for a Slack message that can be sent.
  * @public
@@ -17,7 +17,7 @@ export interface SlackMessage {
     /**
      * The SARIF log associated with this Slack message.
      */
-    sarif: Sarif;
+    sarif: SarifLog;
 }
 /**
  * Enum representing log levels for the service.
@@ -25,7 +25,8 @@ export interface SlackMessage {
  */
 export declare enum LogLevel {
     /**
-     * Represents the most verbose logging level, typically used for detailed debugging information.
+     * Represents the most verbose logging level, typically used for detailed
+     * debugging information.
      */
     Silly = 0,
     /**
@@ -33,23 +34,28 @@ export declare enum LogLevel {
      */
     Trace = 1,
     /**
-     * Represents a logging level for debugging information that is less verbose than silly.
+     * Represents a logging level for debugging information that is less verbose
+     * than silly.
      */
     Debug = 2,
     /**
-     * Represents a logging level for general informational messages that highlight the progress of the application.
+     * Represents a logging level for general informational messages that highlight
+     * the progress of the application.
      */
     Info = 3,
     /**
-     * Represents a logging level for potentially harmful situations that require attention.
+     * Represents a logging level for potentially harmful situations that require
+     * attention.
      */
     Warning = 4,
     /**
-     * Represents a logging level for error conditions that do not require immediate action but should be noted.
+     * Represents a logging level for error conditions that do not require immediate
+     * action but should be noted.
      */
     Error = 5,
     /**
-     * Represents a logging level for critical errors that require immediate attention and may cause the application to terminate.
+     * Represents a logging level for critical errors that require immediate attention
+     * and may cause the application to terminate.
      */
     Fatal = 6
 }
@@ -58,7 +64,7 @@ export declare enum LogLevel {
  * in the Slack message.
  * @public
  */
-export type IncludeAwareProps = {
+export type IncludeAwareOptions = {
     include: boolean;
 };
 /**
@@ -66,9 +72,94 @@ export type IncludeAwareProps = {
  * in the Slack message, along with an optional value.
  * @public
  */
-export type IncludeAwareWithValueProps = IncludeAwareProps & {
+export type IncludeAwareWithValueOptions = IncludeAwareOptions & {
     value?: string;
 };
+/**
+ * Enum representing the type of footer in a Slack message.
+ * @public
+ */
+export declare enum FooterType {
+    /**
+     * Represents a plain text footer. Text is not formatted and appears as-is.
+     */
+    PlainText = "plain_text",
+    /**
+     * Represents a footer with Markdown formatting. Text can include formatting
+     * such as bold, italics, and links.
+     */
+    Markdown = "mrkdwn"
+}
+/**
+ * Options for the footer of a Slack message. "type" is ignored if "value" is
+ * not defined.
+ * @public
+ */
+export type FooterOptions = IncludeAwareWithValueOptions & {
+    type?: FooterType;
+};
+/**
+ * Enum representing how to group results.
+ * @public
+ */
+export declare enum GroupResultsBy {
+    /**
+     * Groups results by the tool name. Particularly, groups by the runs[].tool.driver.name
+     * property from the SARIF file(s).
+     */
+    ToolName = 0,
+    /**
+     * Groups results by the run. It provides the result from each run individually.
+     */
+    Run = 1,
+    /**
+     * Does not group results. It provides the result from all the runs from all
+     * the provided SARIF files.
+     */
+    Total = 2
+}
+/**
+ * Enum representing how to calculate results.
+ * @public
+ */
+export declare enum CalculateResultsBy {
+    /**
+     * Calculates results by the security level of the findings: Error, Warning,
+     * Note and Unknown. At first, it tries to get the security level from runs[].results[].level
+     * property. If it is not defined, it tries to get the security level from the
+     * respective rule of each result, using the rules[].properties['problem.severity']
+     * property.
+     */
+    Level = 0,
+    /**
+     * Calculates results by the security severity of the findings: Critical, High,
+     * Medium, Low, None and Unknown. it tries to get the security severity from the
+     * respective rule of each result, using the rules[].properties['security-severity']
+     * property. This property contains CVSS score, which is then mapped to the
+     * security severity value.
+     */
+    Severity = 1
+}
+/**
+ * Options for how to output the results in the Slack message.
+ * @public
+ */
+export type SarifToSlackOutput = {
+    groupBy: GroupResultsBy;
+    calculateBy: CalculateResultsBy;
+};
+/**
+ * Options for logging.
+ * @public
+ */
+export type LogOptions = {
+    level?: LogLevel;
+    /**
+     * More details here: https://github.com/fullstack-build/tslog?tab=readme-ov-file#pretty-templates-and-styles-color-settings
+     */
+    template?: string;
+    colored?: boolean;
+};
 /**
  * Options for the SarifToSlackService.
  * @public
@@ -79,10 +170,11 @@ export type SarifToSlackServiceOptions = {
     username?: string;
     iconUrl?: string;
     color?: string;
-    logLevel?: LogLevel | string;
-    header?: IncludeAwareWithValueProps;
-    footer?: IncludeAwareWithValueProps;
-    actor?: IncludeAwareWithValueProps;
-    run?: IncludeAwareProps;
+    log?: LogOptions;
+    header?: IncludeAwareWithValueOptions;
+    footer?: FooterOptions;
+    actor?: IncludeAwareWithValueOptions;
+    run?: IncludeAwareOptions;
+    output?: SarifToSlackOutput;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAA;AAEhC;;;GAGG;AACH,MAAM,MAAM,KAAK,GAAG,GAAG,CAAA;AAEvB;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;IAC3B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAA;CACb;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAClB;;OAEG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,IAAI,IAAI;IACR;;OAEG;IACH,OAAO,IAAI;IACX;;OAEG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,KAAK,IAAI;CACV;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,GAAG;IAC3D,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG;IAEvC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC7B,MAAM,CAAC,EAAE,0BAA0B,CAAC;IACpC,MAAM,CAAC,EAAE,0BAA0B,CAAC;IACpC,KAAK,CAAC,EAAE,0BAA0B,CAAC;IACnC,GAAG,CAAC,EAAE,iBAAiB,CAAC;CACzB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAA;AAEhC;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,GAAG,CAAA;AAE1B;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;IAC3B;;OAEG;IACH,KAAK,EAAE,QAAQ,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;;;GAGG;AACH,oBAAY,cAAc;IACxB;;;OAGG;IACH,QAAQ,IAAI;IACZ;;OAEG;IACH,GAAG,IAAI;IACP;;;OAGG;IACH,KAAK,IAAI;CACV;AAED;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B;;;;;;OAMG;IACH,KAAK,IAAI;IACT;;;;;;OAMG;IACH,QAAQ,IAAI;CACb;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,cAAc,CAAC;IACxB,WAAW,EAAE,kBAAkB,CAAC;CACjC,CAAA;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,0BAA0B,GAAG;IAEvC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,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,MAAM,CAAC,EAAE,kBAAkB,CAAC;CAC7B,CAAA"}

package/dist/types.js

@@ -5,7 +5,8 @@
 export var LogLevel;
 (function (LogLevel) {
     /**
-     * Represents the most verbose logging level, typically used for detailed debugging information.
+     * Represents the most verbose logging level, typically used for detailed
+     * debugging information.
      */
     LogLevel[LogLevel["Silly"] = 0] = "Silly";
     /**
@@ -13,24 +14,89 @@ export var LogLevel;
      */
     LogLevel[LogLevel["Trace"] = 1] = "Trace";
     /**
-     * Represents a logging level for debugging information that is less verbose than silly.
+     * Represents a logging level for debugging information that is less verbose
+     * than silly.
      */
     LogLevel[LogLevel["Debug"] = 2] = "Debug";
     /**
-     * Represents a logging level for general informational messages that highlight the progress of the application.
+     * Represents a logging level for general informational messages that highlight
+     * the progress of the application.
      */
     LogLevel[LogLevel["Info"] = 3] = "Info";
     /**
-     * Represents a logging level for potentially harmful situations that require attention.
+     * Represents a logging level for potentially harmful situations that require
+     * attention.
      */
     LogLevel[LogLevel["Warning"] = 4] = "Warning";
     /**
-     * Represents a logging level for error conditions that do not require immediate action but should be noted.
+     * Represents a logging level for error conditions that do not require immediate
+     * action but should be noted.
      */
     LogLevel[LogLevel["Error"] = 5] = "Error";
     /**
-     * Represents a logging level for critical errors that require immediate attention and may cause the application to terminate.
+     * Represents a logging level for critical errors that require immediate attention
+     * and may cause the application to terminate.
      */
     LogLevel[LogLevel["Fatal"] = 6] = "Fatal";
 })(LogLevel || (LogLevel = {}));
-//# sourceMappingURL=types.js.map
+/**
+ * Enum representing the type of footer in a Slack message.
+ * @public
+ */
+export var FooterType;
+(function (FooterType) {
+    /**
+     * Represents a plain text footer. Text is not formatted and appears as-is.
+     */
+    FooterType["PlainText"] = "plain_text";
+    /**
+     * Represents a footer with Markdown formatting. Text can include formatting
+     * such as bold, italics, and links.
+     */
+    FooterType["Markdown"] = "mrkdwn";
+})(FooterType || (FooterType = {}));
+/**
+ * Enum representing how to group results.
+ * @public
+ */
+export var GroupResultsBy;
+(function (GroupResultsBy) {
+    /**
+     * Groups results by the tool name. Particularly, groups by the runs[].tool.driver.name
+     * property from the SARIF file(s).
+     */
+    GroupResultsBy[GroupResultsBy["ToolName"] = 0] = "ToolName";
+    /**
+     * Groups results by the run. It provides the result from each run individually.
+     */
+    GroupResultsBy[GroupResultsBy["Run"] = 1] = "Run";
+    /**
+     * Does not group results. It provides the result from all the runs from all
+     * the provided SARIF files.
+     */
+    GroupResultsBy[GroupResultsBy["Total"] = 2] = "Total";
+})(GroupResultsBy || (GroupResultsBy = {}));
+/**
+ * Enum representing how to calculate results.
+ * @public
+ */
+export var CalculateResultsBy;
+(function (CalculateResultsBy) {
+    /**
+     * Calculates results by the security level of the findings: Error, Warning,
+     * Note and Unknown. At first, it tries to get the security level from runs[].results[].level
+     * property. If it is not defined, it tries to get the security level from the
+     * respective rule of each result, using the rules[].properties['problem.severity']
+     * property.
+     */
+    CalculateResultsBy[CalculateResultsBy["Level"] = 0] = "Level";
+    /**
+     * Calculates results by the security severity of the findings: Critical, High,
+     * Medium, Low, None and Unknown. it tries to get the security severity from the
+     * respective rule of each result, using the rules[].properties['security-severity']
+     * property. This property contains CVSS score, which is then mapped to the
+     * security severity value.
+     */
+    CalculateResultsBy[CalculateResultsBy["Severity"] = 1] = "Severity";
+})(CalculateResultsBy || (CalculateResultsBy = {}));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBd0JBOzs7R0FHRztBQUNILE1BQU0sQ0FBTixJQUFZLFFBbUNYO0FBbkNELFdBQVksUUFBUTtJQUNsQjs7O09BR0c7SUFDSCx5Q0FBUyxDQUFBO0lBQ1Q7O09BRUc7SUFDSCx5Q0FBUyxDQUFBO0lBQ1Q7OztPQUdHO0lBQ0gseUNBQVMsQ0FBQTtJQUNUOzs7T0FHRztJQUNILHVDQUFRLENBQUE7SUFDUjs7O09BR0c7SUFDSCw2Q0FBVyxDQUFBO0lBQ1g7OztPQUdHO0lBQ0gseUNBQVMsQ0FBQTtJQUNUOzs7T0FHRztJQUNILHlDQUFTLENBQUE7QUFDWCxDQUFDLEVBbkNXLFFBQVEsS0FBUixRQUFRLFFBbUNuQjtBQW9CRDs7O0dBR0c7QUFDSCxNQUFNLENBQU4sSUFBWSxVQVVYO0FBVkQsV0FBWSxVQUFVO0lBQ3BCOztPQUVHO0lBQ0gsc0NBQXdCLENBQUE7SUFDeEI7OztPQUdHO0lBQ0gsaUNBQW1CLENBQUE7QUFDckIsQ0FBQyxFQVZXLFVBQVUsS0FBVixVQUFVLFFBVXJCO0FBV0Q7OztHQUdHO0FBQ0gsTUFBTSxDQUFOLElBQVksY0FlWDtBQWZELFdBQVksY0FBYztJQUN4Qjs7O09BR0c7SUFDSCwyREFBWSxDQUFBO0lBQ1o7O09BRUc7SUFDSCxpREFBTyxDQUFBO0lBQ1A7OztPQUdHO0lBQ0gscURBQVMsQ0FBQTtBQUNYLENBQUMsRUFmVyxjQUFjLEtBQWQsY0FBYyxRQWV6QjtBQUVEOzs7R0FHRztBQUNILE1BQU0sQ0FBTixJQUFZLGtCQWlCWDtBQWpCRCxXQUFZLGtCQUFrQjtJQUM1Qjs7Ozs7O09BTUc7SUFDSCw2REFBUyxDQUFBO0lBQ1Q7Ozs7OztPQU1HO0lBQ0gsbUVBQVksQ0FBQTtBQUNkLENBQUMsRUFqQlcsa0JBQWtCLEtBQWxCLGtCQUFrQixRQWlCN0IifQ==

package/dist/utils/SarifUtils.d.ts

@@ -0,0 +1,5 @@
+import type { ReportingDescriptor, Result, Run } from "sarif";
+export declare function findRuleByResult(run: Run, result: Result): ReportingDescriptor | undefined;
+export type RuleProperty = 'security-severity' | 'problem.severity';
+export declare function tryGetRulePropertyByResult<T>(run: Run, result: Result, propertyName: RuleProperty): T | undefined;
+//# sourceMappingURL=SarifUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SarifUtils.d.ts","sourceRoot":"","sources":["../../src/utils/SarifUtils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAE9D,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS,CA8B1F;AAED,MAAM,MAAM,YAAY,GAAG,mBAAmB,GAAG,kBAAkB,CAAA;AAEnE,wBAAgB,0BAA0B,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,GAAG,CAAC,GAAG,SAAS,CAOjH"}

package/dist/utils/SarifUtils.js

@@ -0,0 +1,32 @@
+export function findRuleByResult(run, result) {
+    const ruleData = {};
+    if (result.rule) {
+        if (result.rule?.index) {
+            ruleData.index = result.rule.index;
+        }
+        if (result.rule?.id) {
+            ruleData.id = result.rule.id;
+        }
+    }
+    if (!ruleData.index && result.ruleIndex) {
+        ruleData.index = result.ruleIndex;
+    }
+    if (ruleData.index
+        && run.tool.driver?.rules
+        && ruleData.index < run.tool.driver.rules.length) {
+        return run.tool.driver.rules[ruleData.index];
+    }
+    // If failed to find rule by index then try to find by ruleId
+    if (result.ruleId && run.tool.driver?.rules) {
+        return run.tool.driver.rules.find((r) => r.id === result.ruleId);
+    }
+    return undefined;
+}
+export function tryGetRulePropertyByResult(run, result, propertyName) {
+    const rule = findRuleByResult(run, result);
+    if (rule && rule.properties && propertyName in rule.properties) {
+        return rule.properties[propertyName];
+    }
+    return undefined;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiU2FyaWZVdGlscy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy91dGlscy9TYXJpZlV0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBLE1BQU0sVUFBVSxnQkFBZ0IsQ0FBQyxHQUFRLEVBQUUsTUFBYztJQUN2RCxNQUFNLFFBQVEsR0FBb0MsRUFBRSxDQUFBO0lBRXBELElBQUksTUFBTSxDQUFDLElBQUksRUFBRSxDQUFDO1FBQ2hCLElBQUksTUFBTSxDQUFDLElBQUksRUFBRSxLQUFLLEVBQUUsQ0FBQztZQUN2QixRQUFRLENBQUMsS0FBSyxHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFBO1FBQ3BDLENBQUM7UUFDRCxJQUFJLE1BQU0sQ0FBQyxJQUFJLEVBQUUsRUFBRSxFQUFFLENBQUM7WUFDcEIsUUFBUSxDQUFDLEVBQUUsR0FBRyxNQUFNLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQTtRQUM5QixDQUFDO0lBQ0gsQ0FBQztJQUVELElBQUksQ0FBQyxRQUFRLENBQUMsS0FBSyxJQUFJLE1BQU0sQ0FBQyxTQUFTLEVBQUUsQ0FBQztRQUN4QyxRQUFRLENBQUMsS0FBSyxHQUFHLE1BQU0sQ0FBQyxTQUFTLENBQUE7SUFDbkMsQ0FBQztJQUVELElBQUksUUFBUSxDQUFDLEtBQUs7V0FDYixHQUFHLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxLQUFLO1dBQ3RCLFFBQVEsQ0FBQyxLQUFLLEdBQUcsR0FBRyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLE1BQU0sRUFBRSxDQUFDO1FBQ25ELE9BQU8sR0FBRyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUMsQ0FBQTtJQUM5QyxDQUFDO0lBRUQsNkRBQTZEO0lBQzdELElBQUksTUFBTSxDQUFDLE1BQU0sSUFBSSxHQUFHLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxLQUFLLEVBQUUsQ0FBQztRQUM1QyxPQUFPLEdBQUcsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQy9CLENBQUMsQ0FBc0IsRUFBVyxFQUFFLENBQUMsQ0FBQyxDQUFDLEVBQUUsS0FBSyxNQUFNLENBQUMsTUFBTSxDQUM1RCxDQUFBO0lBQ0gsQ0FBQztJQUVELE9BQU8sU0FBUyxDQUFBO0FBQ2xCLENBQUM7QUFJRCxNQUFNLFVBQVUsMEJBQTBCLENBQUksR0FBUSxFQUFFLE1BQWMsRUFBRSxZQUEwQjtJQUNoRyxNQUFNLElBQUksR0FBb0MsZ0JBQWdCLENBQUMsR0FBRyxFQUFFLE1BQU0sQ0FBQyxDQUFBO0lBQzNFLElBQUksSUFBSSxJQUFJLElBQUksQ0FBQyxVQUFVLElBQUksWUFBWSxJQUFJLElBQUksQ0FBQyxVQUFVLEVBQUUsQ0FBQztRQUMvRCxPQUFPLElBQUksQ0FBQyxVQUFVLENBQUMsWUFBWSxDQUFNLENBQUE7SUFDM0MsQ0FBQztJQUVELE9BQU8sU0FBUyxDQUFBO0FBQ2xCLENBQUMifQ==

package/dist/utils/SortUtils.d.ts

@@ -0,0 +1,5 @@
+import { Map as ImmutableMap } from 'immutable';
+import { SecurityLevel, SecuritySeverity } from '../model/types';
+export declare function sortSecurityLevelMap(map: ImmutableMap<SecurityLevel, number>): ImmutableMap<SecurityLevel, number>;
+export declare function sortSecuritySeverityMap(map: ImmutableMap<SecuritySeverity, number>): ImmutableMap<SecuritySeverity, number>;
+//# sourceMappingURL=SortUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SortUtils.d.ts","sourceRoot":"","sources":["../../src/utils/SortUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,IAAI,YAAY,EAAE,MAAM,WAAW,CAAA;AAC/C,OAAO,EACL,aAAa,EAEb,gBAAgB,EAEjB,MAAM,gBAAgB,CAAA;AAEvB,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,CAKlH;AAED,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,YAAY,CAAC,gBAAgB,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAK3H"}

package/dist/utils/SortUtils.js

@@ -0,0 +1,8 @@
+import { SecurityLevelOrder, SecuritySeverityOrder } from '../model/types';
+export function sortSecurityLevelMap(map) {
+    return map.sortBy((_, level) => level, (a, b) => SecurityLevelOrder.indexOf(a) - SecurityLevelOrder.indexOf(b)).asImmutable();
+}
+export function sortSecuritySeverityMap(map) {
+    return map.sortBy((_, severity) => severity, (a, b) => SecuritySeverityOrder.indexOf(a) - SecuritySeverityOrder.indexOf(b)).asImmutable();
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiU29ydFV0aWxzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3V0aWxzL1NvcnRVdGlscy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLEVBRUwsa0JBQWtCLEVBRWxCLHFCQUFxQixFQUN0QixNQUFNLGdCQUFnQixDQUFBO0FBRXZCLE1BQU0sVUFBVSxvQkFBb0IsQ0FBQyxHQUF3QztJQUMzRSxPQUFPLEdBQUcsQ0FBQyxNQUFNLENBQ2YsQ0FBQyxDQUFTLEVBQUUsS0FBb0IsRUFBaUIsRUFBRSxDQUFDLEtBQUssRUFDekQsQ0FBQyxDQUFnQixFQUFFLENBQWdCLEVBQVUsRUFBRSxDQUFDLGtCQUFrQixDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsR0FBRyxrQkFBa0IsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLENBQzlHLENBQUMsV0FBVyxFQUFFLENBQUE7QUFDakIsQ0FBQztBQUVELE1BQU0sVUFBVSx1QkFBdUIsQ0FBQyxHQUEyQztJQUNqRixPQUFPLEdBQUcsQ0FBQyxNQUFNLENBQ2YsQ0FBQyxDQUFTLEVBQUUsUUFBMEIsRUFBb0IsRUFBRSxDQUFDLFFBQVEsRUFDckUsQ0FBQyxDQUFtQixFQUFFLENBQW1CLEVBQVUsRUFBRSxDQUFDLHFCQUFxQixDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsR0FBRyxxQkFBcUIsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLENBQzFILENBQUMsV0FBVyxFQUFFLENBQUE7QUFDakIsQ0FBQyJ9

package/dist/version.d.ts

@@ -0,0 +1,2 @@
+export declare const LIB_VERSION = "0.2.1";
+//# sourceMappingURL=version.d.ts.map

package/dist/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,WAAW,UAAU,CAAA"}

package/dist/version.js

@@ -0,0 +1,4 @@
+// This file is autogenerated by scripts/save-version.sh
+// Do not edit it manually!
+export const LIB_VERSION = '0.2.1';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmVyc2lvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy92ZXJzaW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLHdEQUF3RDtBQUN4RCwyQkFBMkI7QUFDM0IsTUFBTSxDQUFDLE1BQU0sV0FBVyxHQUFHLE9BQU8sQ0FBQSJ9