@fabasoad/sarif-to-slack 1.3.4 → 1.4.0

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

@@ -1,562 +0,0 @@
-/**
- * Sarif to Slack message converter library.
- *
- * @remarks
- * This library provides a client to send a Slack messages based on the provided
- * SARIF (Static Analysis Results Interchange Format) files.
- *
- * @example
- * ```typescript
- * import {
- *   Color,
- *   FooterType,
- *   RepresentationType,
- *   SarifToSlackClient,
- *   SendIf
- * } from '@fabasoad/sarif-to-slack';
- *
- * const client: SarifToSlackClient = await SarifToSlackClient.create({
- *   webhookUrl: 'https://hooks.slack.com/services/your/webhook/url',
- *   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'),
- *       medium: new Color('#ffa500'),
- *       low: new Color('#ffff00'),
- *       none: new Color('#808080'),
- *       unknown: new Color('#800080'),
- *     },
- *     byLevel: {
- *       error: new Color('#ff0000'),
- *       warning: new Color('#ffa500'),
- *       note: new Color('#ffff00'),
- *       none: new Color('#808080'),
- *       unknown: new Color('#800080'),
- *     },
- *   },
- *   sarif: {
- *     path: 'path/to/your/sarif-files',
- *     recursive: true,
- *     extension: 'sarif',
- *   },
- *   header: {
- *     include: true,
- *     value: 'SARIF Analysis Results'
- *   },
- *   footer: {
- *     include: true,
- *     type: FooterType.PLAIN_TEXT,
- *     value: 'Generated by @fabasoad/sarif-to-slack'
- *   },
- *   actor: {
- *     include: true,
- *     value: 'fabasoad'
- *   },
- *   run: {
- *     include: true
- *   },
- *   representation: RepresentationType.CompactGroupByToolNamePerSeverity,
- *   sendIf: SendIf.MediumOrHigher,
- * });
- * await client.send();
- * ```
- *
- * @see {@link SarifToSlackClient}
- *
- * @packageDocumentation
- */
-
-/**
- * This class represents a color in hex format.
- * @public
- */
-export declare class Color {
-    /**
-     * A valid string that represents a color in hex format.
-     * @public
-     */
-    readonly color: string;
-    private constructor();
-    /**
-     * 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).
-     * @returns An instance of {@link Color} or undefined if color parameter is falsy.
-     * @public
-     */
-    static from(color: string | undefined): Color | undefined;
-    private assertHexColor;
-    private mapColor;
-}
-
-/**
- * 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 declare 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 declare type ColorGroupBySeverity = ColorGroupCommon & {
-    critical?: Color;
-    high?: Color;
-    medium?: Color;
-    low?: Color;
-};
-
-/**
- * Base type that has common fields for both {@link ColorGroupByLevel} and
- * {@link ColorGroupBySeverity}.
- * @public
- */
-export declare type ColorGroupCommon = {
-    none?: Color;
-    unknown?: 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 declare 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;
-};
-
-/**
- * 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"
-}
-
-/**
- * Type representing properties that indicate whether to include certain information
- * in the Slack message.
- * @public
- */
-export declare type IncludeAwareOptions = {
-    include: boolean;
-};
-
-/**
- * Type representing properties that indicate whether to include certain information
- * in the Slack message, along with an optional value.
- * @public
- */
-export declare type IncludeAwareWithValueOptions = IncludeAwareOptions & {
-    value?: string;
-};
-
-/**
- * This represents what type of message should be sent. There are various options
- * to show information from SARIF in Slack message.
- * @public
- */
-export declare enum RepresentationType {
-    /**
-     * Compact information about findings grouped by Run with the level representation.
-     * @example
-     * ```text
-     * [Run 1] Grype
-     * Error: 1, Warning: 4
-     * [Run 2] Grype
-     * Warning: 1, Note: 20
-     * ```
-     */
-    CompactGroupByRunPerLevel = 0,
-    /**
-     * Compact information about findings grouped by Run with the severity representation.
-     * @example
-     * ```text
-     * [Run 1] Grype
-     * Critical: 1, High: 3, Medium: 1
-     * [Run 2] Grype
-     * Medium: 1, Low: 20
-     * ```
-     */
-    CompactGroupByRunPerSeverity = 1,
-    /**
-     * Compact information about findings grouped by tool name with the level representation.
-     * @example
-     * ```text
-     * Grype
-     * Error: 1, Warning: 5, Note: 20
-     * ```
-     */
-    CompactGroupByToolNamePerLevel = 2,
-    /**
-     * Compact information about findings grouped by tool name with the severity representation.
-     * @example
-     * ```text
-     * Grype
-     * Critical: 1, High: 3, Medium: 2, Low: 20
-     * ```
-     */
-    CompactGroupByToolNamePerSeverity = 3,
-    /**
-     * Compact information about findings grouped by SARIF file with the level representation.
-     * @example
-     * ```text
-     * grype-results-01.sarif
-     * Error: 1, Warning: 2, Note: 1
-     * grype-results-02.sarif
-     * Warning: 3, Note: 19
-     * ```
-     */
-    CompactGroupBySarifPerLevel = 4,
-    /**
-     * Compact information about findings grouped by SARIF file with the severity
-     * representation.
-     * @example
-     * ```text
-     * grype-results-01.sarif
-     * High: 3, Medium: 1, Low: 11
-     * grype-results-02.sarif
-     * Critical: 1, Medium: 1, Low: 9
-     * ```
-     */
-    CompactGroupBySarifPerSeverity = 5,
-    /**
-     * Compact information about findings with the level representation.
-     * @example
-     * ```text
-     * Total
-     * Error: 1, Warning: 5, Note: 20
-     * ```
-     */
-    CompactTotalPerLevel = 6,
-    /**
-     * Compact information about findings with the severity representation.
-     * @example
-     * ```text
-     * Total
-     * Critical: 1, High: 3, Medium: 2, Low: 20
-     * ```
-     */
-    CompactTotalPerSeverity = 7,
-    /**
-     * Table information about findings grouped by Run with the level representation.
-     * @example
-     * ```text
-     * |       | Unknown | None | Note | Warning | Error | Total |
-     * | ----- | ------- | ---- | ---- | ------- | ----- | ----- |
-     * | 1     | 0       | 0    | 0    | 1       | 0     | 1     |
-     * | 2     | 0       | 0    | 9    | 20      | 10    | 39    |
-     * | 3     | 0       | 0    | 1    | 0       | 1     | 2     |
-     * | 4     | 0       | 0    | 5    | 5       | 0     | 10    |
-     * | ----- | ------- | ---- | ---- | ------- | ----- | ----- |
-     * | Total | 0       | 0    | 15   | 26      | 11    | 52    |
-     * ```
-     */
-    TableGroupByRunPerLevel = 8,
-    /**
-     * Table information about findings grouped by Run with the severity representation.
-     * @example
-     * ```text
-     * |       | Unknown | None | Low | Medium | High | Critical | Total |
-     * | ----- | ------- | ---- | --- | ------ | ---- | -------- | ----- |
-     * | 1     | 0       | 0    | 0   | 1      | 0    | 0        | 1     |
-     * | 2     | 0       | 0    | 9   | 20     | 10   | 0        | 39    |
-     * | 3     | 0       | 0    | 1   | 0      | 1    | 0        | 2     |
-     * | 4     | 0       | 0    | 5   | 5      | 0    | 0        | 10    |
-     * | ----- | ------- | ---- | --- | ------ | ---- | -------- | ----- |
-     * | Total | 0       | 0    | 15  | 26     | 11   | 0        | 52    |
-     * ```
-     */
-    TableGroupByRunPerSeverity = 9,
-    /**
-     * Table information about findings grouped by tool name with the level representation.
-     * @example
-     * ```text
-     * |        | Unknown | None | Note | Warning | Error | Total |
-     * | ------ | ------- | ---- | ---- | ------- | ----- | ----- |
-     * | CodeQL | 0       | 0    | 0    | 1       | 0     | 1     |
-     * | grype  | 0       | 0    | 9    | 20      | 10    | 39    |
-     * | Trivy  | 0       | 0    | 1    | 0       | 1     | 2     |
-     * | WizCLI | 0       | 0    | 5    | 5       | 0     | 10    |
-     * | ------ | ------- | ---- | ---- | ------- | ----- | ----- |
-     * | Total  | 0       | 0    | 15   | 26      | 11    | 52    |
-     * ```
-     */
-    TableGroupByToolNamePerLevel = 10,
-    /**
-     * Table information about findings grouped by tool name with the severity representation.
-     * @example
-     * ```text
-     * |        | Unknown | None | Low | Medium | High | Critical | Total |
-     * | ------ | ------- | ---- | --- | ------ | ---- | -------- | ----- |
-     * | CodeQL | 0       | 0    | 0   | 1      | 0    | 0        | 1     |
-     * | grype  | 0       | 0    | 9   | 20     | 10   | 0        | 39    |
-     * | Trivy  | 0       | 0    | 1   | 0      | 1    | 0        | 2     |
-     * | WizCLI | 0       | 0    | 5   | 5      | 0    | 0        | 10    |
-     * | ------ | ------- | ---- | --- | ------ | ---- | -------- | ----- |
-     * | Total  | 0       | 0    | 15  | 26     | 11   | 0        | 52    |
-     * ```
-     */
-    TableGroupByToolNamePerSeverity = 11,
-    /**
-     * Table information about findings grouped by SARIF file with the level representation.
-     * @example
-     * ```text
-     * |       | Unknown | None | Note | Warning | Error | Total |
-     * | ----- | ------- | ---- | ---- | ------- | ----- | ----- |
-     * | 1     | 0       | 0    | 0    | 1       | 0     | 1     |
-     * | 2     | 0       | 0    | 9    | 20      | 10    | 39    |
-     * | ----- | ------- | ---- | ---- | ------- | ----- | ----- |
-     * | Total | 0       | 0    | 9    | 21      | 10    | 40    |
-     * ```
-     */
-    TableGroupBySarifPerLevel = 12,
-    /**
-     * Table information about findings grouped by SARIF file with the severity representation.
-     * @example
-     * ```text
-     * |       | Unknown | None | Low | Medium | High | Critical | Total |
-     * | ----- | ------- | ---- | --- | ------ | ---- | -------- | ----- |
-     * | 1     | 0       | 0    | 0   | 1      | 0    | 0        | 1     |
-     * | 2     | 0       | 0    | 9   | 20     | 10   | 0        | 39    |
-     * | ----- | ------- | ---- | --- | ------ | ---- | -------- | ----- |
-     * | Total | 0       | 0    | 9   | 21     | 10   | 0        | 40    |
-     * ```
-     */
-    TableGroupBySarifPerSeverity = 13
-}
-
-/**
- * SARIF file extension.
- * @public
- */
-export declare type SarifFileExtension = 'sarif' | 'json';
-
-/**
- * Represents options for the provided SARIF file(s), such as path, should files
- * from this path be retrieved recursively or not, and file extension.
- * @public
- */
-export declare type SarifOptions = {
-    path: string;
-    recursive?: boolean;
-    extension?: SarifFileExtension;
-};
-
-/**
- * Service to convert SARIF files to Slack messages and send them.
- * @public
- */
-export declare class SarifToSlackClient {
-    private readonly _logger;
-    private _message?;
-    private _sarifModel?;
-    private _sendIf;
-    private constructor();
-    private static createRunIdGenerator;
-    /**
-     * Creates an instance of {@link SarifToSlackClient} class. It already has all
-     * properties and fields initialized.
-     * @param webhookUrl - Slack webhook URL.
-     * @param opts - An instance of {@link SarifToSlackClientOptions} type.
-     *
-     * @see SarifToSlackClientOptions
-     *
-     * @public
-     */
-    static create(webhookUrl: string, opts: SarifToSlackClientOptions): Promise<SarifToSlackClient>;
-    private static buildModel;
-    /**
-     * Sends a Slack message.
-     * @returns A promise that resolves when the message has been sent.
-     * @throws Error if a Slack message was not prepared for the given SARIF path.
-     * @public
-     */
-    send(): Promise<void>;
-    private get shouldSendMessage();
-}
-
-/**
- * Options for the SarifToSlackClient.
- * @public
- */
-export declare type SarifToSlackClientOptions = {
-    sarif: SarifOptions;
-    username?: string;
-    iconUrl?: string;
-    color?: ColorOptions;
-    header?: IncludeAwareWithValueOptions;
-    footer?: FooterOptions;
-    actor?: IncludeAwareWithValueOptions;
-    run?: IncludeAwareOptions;
-    representation?: RepresentationType;
-    sendIf?: SendIf;
-};
-
-/**
- * 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
-}
-
-export { }