@fabasoad/sarif-to-slack 0.1.0 → 0.2.0

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -31,7 +31,7 @@ If applicable, add screenshots to help explain your problem.
 #### Technical information (please complete the following information)
 
 - OS: [e.g. Windows 10 Enterprise v.1909 (OS Build 18363.720)]
-- `sarif-to-slack-action` version [e.g. 0.1.0]
+- `sarif-to-slack` version [e.g. 0.1.1]
 
 #### Additional context
 

package/.github/pull_request_template.md

@@ -4,12 +4,12 @@
 
 Please check if your PR fulfills the following requirements:
 
-- [ ] I have read the [CONTRIBUTING](https://github.com/fabasoad/sarif-to-slack-action/blob/main/CONTRIBUTING.md)
+- [ ] I have read the [CONTRIBUTING](https://github.com/fabasoad/sarif-to-slack/blob/main/CONTRIBUTING.md)
 doc.
 - [ ] Tests for the changes have been added (for bug fixes / features).
 - [ ] Docs have been reviewed and added / updated if needed (for bug fixes / features).
-- [ ] Build (`yarn run build`) was run locally and any changes were pushed.
-- [ ] Tests (`yarn test`) has passed locally and any fixes were made for failures.
+- [ ] Build (`make build`) was run locally and any changes were pushed.
+- [ ] Tests (`make test`) has passed locally and any fixes were made for failures.
 
 ## Pull request type
 

package/.github/workflows/linting.yml

@@ -6,13 +6,27 @@ on: # yamllint disable-line rule:truthy
   push:
     branches:
       - main
+  workflow_dispatch:
+    inputs:
+      linter:
+        description: |
+          The linter to run. Supported values: `js-lint`, `pre-commit`.
+        required: false
+        default: all
+        type: choice
+        options:
+          - all
+          - js-lint
+          - pre-commit
 
 jobs:
   js-lint:
     name: JS Lint
+    if: ${{ (github.event.inputs.linter || 'all') == 'all' || github.event.inputs.linter == 'js-lint' }}
     uses: fabasoad/reusable-workflows/.github/workflows/wf-js-lint.yml@main
   pre-commit:
     name: Pre-commit
+    if: ${{ (github.event.inputs.linter || 'all') == 'all' || github.event.inputs.linter == 'pre-commit' }}
     uses: fabasoad/reusable-workflows/.github/workflows/wf-pre-commit.yml@main
     with:
       skip-hooks: "audit, build, lint, test"

package/.github/workflows/release.yml

@@ -28,6 +28,8 @@ jobs:
     steps:
       - name: Checkout ${{ github.repository }}
         uses: actions/checkout@v4
+        with:
+          token: "${{ secrets.GH_TOKEN }}"
 
       - name: Setup Node
         uses: actions/setup-node@v4

package/.github/workflows/unit-tests.yml

@@ -9,6 +9,7 @@ on: # yamllint disable-line rule:truthy
       - jest.config.json
       - package.json
       - src/**
+      - tests/**
       - tsconfig.json
   push:
     branches:

package/.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 ---
 default_install_hook_types: ["pre-commit", "pre-push"]
 default_stages: ["pre-commit", "pre-push"]
-exclude: ^(dist/.*|etc/.*|lib/.*|node_modules/.*|temp/.*)$
+exclude: ^(dist/.*|etc/.*|node_modules/.*|temp/.*)$
 minimum_pre_commit_version: 4.0.0
 repos:
   - repo: local
@@ -29,7 +29,7 @@ repos:
         stages: ["pre-push"]
   # Security
       - id: audit
-        name: NPM audit
+        name: npm audit
         entry: make audit
         language: system
         pass_filenames: false

package/CONTRIBUTING.md

@@ -33,7 +33,7 @@ In short, when you submit code changes, your submissions are understood to be
 under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers
 the project. Feel free to contact the maintainers if that's a concern.
 
-## Report bugs using [GitHub Issues](https://github.com/fabasoad/sarif-to-slack-action/issues)
+## Report bugs using [GitHub Issues](https://github.com/fabasoad/sarif-to-slack/issues)
 
 We use GitHub issues to track public bugs. Report a bug by opening a new issue.
 It's that easy!

package/Makefile

@@ -2,7 +2,7 @@
 
 .PHONY: audit
 audit:
-	@npm audit --all
+	@npm audit --audit-level moderate --package-lock-only --include dev
 
 .PHONY: build
 build:

package/README.md

@@ -1,11 +1,11 @@
 # SARIF to Slack TypeScript Library
 
 [![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://stand-with-ukraine.pp.ua)
-![Releases](https://img.shields.io/github/v/release/fabasoad/sarif-to-slack-action?include_prereleases)
-![unit-tests](https://github.com/fabasoad/sarif-to-slack-action/actions/workflows/unit-tests.yml/badge.svg)
-![security](https://github.com/fabasoad/sarif-to-slack-action/actions/workflows/security.yml/badge.svg)
-![linting](https://github.com/fabasoad/sarif-to-slack-action/actions/workflows/linting.yml/badge.svg)
-[![codecov](https://codecov.io/gh/fabasoad/sarif-to-slack-action/branch/main/graph/badge.svg?token=908QOYME6H)](https://codecov.io/gh/fabasoad/sarif-to-slack-action)
+![Releases](https://img.shields.io/github/v/release/fabasoad/sarif-to-slack?include_prereleases)
+![unit-tests](https://github.com/fabasoad/sarif-to-slack/actions/workflows/unit-tests.yml/badge.svg)
+![security](https://github.com/fabasoad/sarif-to-slack/actions/workflows/security.yml/badge.svg)
+![linting](https://github.com/fabasoad/sarif-to-slack/actions/workflows/linting.yml/badge.svg)
+[![codecov](https://codecov.io/gh/fabasoad/sarif-to-slack/branch/main/graph/badge.svg?token=I4FV5Q328I)](https://codecov.io/gh/fabasoad/sarif-to-slack)
 
 TypeScript library to send results of SARIF file to Slack webhook URL.
 
@@ -16,19 +16,50 @@ TypeScript library to send results of SARIF file to Slack webhook URL.
   * [Contents](#contents)
   * [How to use](#how-to-use)
   * [Sample](#sample)
+  * [References](#references)
   * [Contributions](#contributions)
 <!-- TOC -->
 
 ## How to use
 
 ```typescript
+import { SarifToSlackService, FooterType } from '@fabasoad/sarif-to-slack';
 
+const service = await SarifToSlackService.create({
+  webhookUrl: 'https://hooks.slack.com/services/your/webhook/url',
+  sarifPath: 'path/to/your/sarif/file.sarif',
+  logLevel: 'info',
+  username: 'SARIF Bot',
+  iconUrl: 'https://example.com/icon.png',
+  color: '#36a64f',
+  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,
+  },
+});
+await service.sendAll();
 ```
 
 ## Sample
 
 <img alt="Sample" src="sample.png" width="450"/>
 
+## References
+
+* [API Report](./etc/sarif-to-slack.api.md)
+
 ## Contributions
 
 ![Alt](https://repobeats.axiom.co/api/embed/a0989b54292b5c9e03ce1dd4cb23f68072f88f46.svg "Repobeats analytics image")

package/api-extractor.json

@@ -45,7 +45,7 @@
    *
    * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
    */
-  "mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
+  "mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts",
 
   /**
    * A list of NPM package names whose exports should be treated as part of this package.

package/biome.json

@@ -3,12 +3,12 @@
     "enabled": true,
     "rules": {
       "recommended": false,
-      "a11y": { "noBlankTarget": "error" },
+      "a11y": "off",
       "complexity": {
+        "noAdjacentSpacesInRegex": "error",
+        "noArguments": "error",
         "noExtraBooleanCast": "error",
-        "noMultipleSpacesInRegularExpressionLiterals": "error",
-        "noUselessCatch": "error",
-        "noWith": "error"
+        "noUselessCatch": "error"
       },
       "correctness": {
         "noChildrenProp": "error",
@@ -19,7 +19,7 @@
         "noGlobalObjectCalls": "error",
         "noInnerDeclarations": "error",
         "noInvalidConstructorSuper": "error",
-        "noNewSymbol": "error",
+        "noInvalidBuiltinInstantiation": "error",
         "noNonoctalDecimalEscape": "error",
         "noPrecisionLoss": "error",
         "noSelfAssign": "error",
@@ -35,12 +35,14 @@
         "useIsNan": "error",
         "useJsxKeyInIterable": "error",
         "useValidForDirection": "error",
+        "useValidTypeof": "error",
         "useYield": "error"
       },
-      "security": { "noDangerouslySetInnerHtml": "error" },
+      "security": {
+        "noBlankTarget": "error",
+        "noDangerouslySetInnerHtml": "error"
+      },
       "style": {
-        "noArguments": "error",
-        "noVar": "error",
         "useBlockStatements": "error",
         "useConst": "error",
         "useSingleVarDeclarator": "error"
@@ -67,15 +69,16 @@
         "noPrototypeBuiltins": "error",
         "noRedeclare": "error",
         "noShadowRestrictedNames": "error",
+        "noVar": "error",
+        "noWith": "error",
         "noUnsafeNegation": "error",
-        "useGetterReturn": "error",
-        "useValidTypeof": "error"
+        "useGetterReturn": "error"
       }
     },
-    "ignore": ["dist/**"]
+    "includes": ["src/**", "tests/**"]
   },
   "javascript": {
     "globals": ["Atomics", "SharedArrayBuffer", "jest", "afterEach", "beforeAll", "beforeEach", "expect", "test", "describe"]
   },
-  "overrides": [{ "include": ["**/*.spec.ts", "**/*.spec.tsx"] }]
+  "overrides": [{ "includes": ["**/*.spec.ts", "**/*.spec.tsx"] }]
 }

package/dist/Logger.d.ts

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

package/dist/Logger.d.ts.map

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

package/dist/Logger.js

@@ -0,0 +1,25 @@
+import { Logger as TSLogger } from 'tslog';
+import { LogLevel } from './types';
+/**
+ * Logger class for managing logging operations.
+ * @internal
+ */
+export default class Logger {
+    static instance = new TSLogger();
+    static initialize({ logLevel = LogLevel.Info }) {
+        if (!Logger.instance) {
+            Logger.instance = new TSLogger({
+                minLevel: process.env.ACTIONS_STEP_DEBUG === 'true' ? 0 : logLevel,
+                type: 'pretty',
+                prettyLogTimeZone: 'UTC',
+            });
+        }
+    }
+    static info(...args) {
+        Logger.instance.info(args);
+    }
+    static debug(...args) {
+        Logger.instance.debug(args);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiTG9nZ2VyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL0xvZ2dlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsTUFBTSxJQUFJLFFBQVEsRUFBVyxNQUFNLE9BQU8sQ0FBQTtBQUNuRCxPQUFPLEVBQUUsUUFBUSxFQUFFLE1BQU0sU0FBUyxDQUFBO0FBVWxDOzs7R0FHRztBQUNILE1BQU0sQ0FBQyxPQUFPLE9BQU8sTUFBTTtJQUNqQixNQUFNLENBQUMsUUFBUSxHQUFzQixJQUFJLFFBQVEsRUFBRSxDQUFDO0lBRXJELE1BQU0sQ0FBQyxVQUFVLENBQUMsRUFBRSxRQUFRLEdBQUcsUUFBUSxDQUFDLElBQUksRUFBaUI7UUFDbEUsSUFBSSxDQUFDLE1BQU0sQ0FBQyxRQUFRLEVBQUUsQ0FBQztZQUNyQixNQUFNLENBQUMsUUFBUSxHQUFHLElBQUksUUFBUSxDQUFDO2dCQUM3QixRQUFRLEVBQUUsT0FBTyxDQUFDLEdBQUcsQ0FBQyxrQkFBa0IsS0FBSyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsUUFBUTtnQkFDbEUsSUFBSSxFQUFFLFFBQVE7Z0JBQ2QsaUJBQWlCLEVBQUUsS0FBSzthQUN6QixDQUFDLENBQUE7UUFDSixDQUFDO0lBQ0gsQ0FBQztJQUVNLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxJQUFjO1FBQ2xDLE1BQU0sQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFBO0lBQzVCLENBQUM7SUFFTSxNQUFNLENBQUMsS0FBSyxDQUFDLEdBQUcsSUFBYztRQUNuQyxNQUFNLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBQTtJQUM3QixDQUFDIn0=

package/dist/Processors.d.ts

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

package/dist/Processors.d.ts.map

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

package/dist/Processors.js

@@ -0,0 +1,91 @@
+import * as fs from 'fs';
+import * as path from 'path';
+import Logger from './Logger';
+/**
+ * Processes a color string and converts it to a specific hex code if it matches
+ * a CI status identifier.
+ * @param color - The color string to process, which can be a CI status identifier
+ * or a custom color.
+ * @returns The processed color as a hex string or undefined if the input is not
+ * a recognized CI status identifier.
+ * @internal
+ */
+export function processColor(color) {
+    switch (color) {
+        case 'success':
+            Logger.info(`Converting "${color}" to #008000`);
+            return '#008000';
+        case 'failure':
+            Logger.info(`Converting "${color}" to #ff0000`);
+            return '#ff0000';
+        case 'cancelled':
+            Logger.info(`Converting "${color}" to #0047ab`);
+            return '#0047ab';
+        case 'skipped':
+            Logger.info(`Converting "${color}" to #808080`);
+            return '#808080';
+        default:
+            Logger.debug(`"${color}" color is not a CI status identifier. Returning as is...`);
+            return color;
+    }
+}
+/**
+ * Processes a log level string or number and converts it to a numeric log level.
+ * @param logLevel
+ * @returns The numeric log level corresponding to the input string or number.
+ * @throws Error If the input string does not match any known log level.
+ * @internal
+ */
+export function processLogLevel(logLevel) {
+    if (typeof logLevel === 'string') {
+        switch (logLevel.toLowerCase()) {
+            case 'silly':
+                return 0;
+            case 'trace':
+                return 1;
+            case 'debug':
+                return 2;
+            case 'info':
+                return 3;
+            case 'warning':
+                return 4;
+            case 'error':
+                return 5;
+            case 'fatal':
+                return 6;
+            default:
+                throw new Error(`Unknown log level: ${logLevel}`);
+        }
+    }
+    return logLevel;
+}
+/**
+ * Processes the SARIF path, which can be a file or a directory. If it's a
+ * directory, it returns an array of paths to all `.sarif` files, otherwise it
+ * returns an array with a single path to the file.
+ * @param sarifPath - The path to the SARIF file or directory.
+ * @returns An array of strings representing the paths to the SARIF files.
+ * @throws Error If the path does not exist, or if it is neither a file nor a
+ * directory.
+ * @internal
+ */
+export function processSarifPath(sarifPath) {
+    if (!fs.existsSync(sarifPath)) {
+        throw new Error(`"sarif-path" does not exist: ${sarifPath}`);
+    }
+    const sarifStats = fs.statSync(sarifPath);
+    if (sarifStats.isDirectory()) {
+        Logger.info(`"sarif-path" is a directory: ${sarifPath}`);
+        const files = fs.readdirSync(sarifPath);
+        const filteredFiles = files.filter((file) => path.extname(file).toLowerCase() === '.sarif');
+        Logger.info(`Found ${filteredFiles.length} SARIF files in ${sarifPath} directory`);
+        Logger.debug(`Filtered SARIF files: ${filteredFiles.join(', ')}`);
+        return filteredFiles.map((file) => path.join(sarifPath, file));
+    }
+    if (sarifStats.isFile()) {
+        Logger.info(`"sarif-path" is a file: ${sarifPath}`);
+        return [sarifPath];
+    }
+    throw new Error(`"sarif-path" is neither a file nor a directory: ${sarifPath}`);
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUHJvY2Vzc29ycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9Qcm9jZXNzb3JzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxFQUFFLE1BQU0sSUFBSSxDQUFBO0FBQ3hCLE9BQU8sS0FBSyxJQUFJLE1BQU0sTUFBTSxDQUFBO0FBQzVCLE9BQU8sTUFBTSxNQUFNLFVBQVUsQ0FBQTtBQUc3Qjs7Ozs7Ozs7R0FRRztBQUNILE1BQU0sVUFBVSxZQUFZLENBQUMsS0FBYztJQUN6QyxRQUFRLEtBQUssRUFBRSxDQUFDO1FBQ2QsS0FBSyxTQUFTO1lBQ1osTUFBTSxDQUFDLElBQUksQ0FBQyxlQUFlLEtBQUssY0FBYyxDQUFDLENBQUE7WUFDL0MsT0FBTyxTQUFTLENBQUE7UUFDbEIsS0FBSyxTQUFTO1lBQ1osTUFBTSxDQUFDLElBQUksQ0FBQyxlQUFlLEtBQUssY0FBYyxDQUFDLENBQUE7WUFDL0MsT0FBTyxTQUFTLENBQUE7UUFDbEIsS0FBSyxXQUFXO1lBQ2QsTUFBTSxDQUFDLElBQUksQ0FBQyxlQUFlLEtBQUssY0FBYyxDQUFDLENBQUE7WUFDL0MsT0FBTyxTQUFTLENBQUE7UUFDbEIsS0FBSyxTQUFTO1lBQ1osTUFBTSxDQUFDLElBQUksQ0FBQyxlQUFlLEtBQUssY0FBYyxDQUFDLENBQUE7WUFDL0MsT0FBTyxTQUFTLENBQUE7UUFDbEI7WUFDRSxNQUFNLENBQUMsS0FBSyxDQUFDLElBQUksS0FBSywyREFBMkQsQ0FBQyxDQUFBO1lBQ2xGLE9BQU8sS0FBSyxDQUFBO0lBQ2hCLENBQUM7QUFDSCxDQUFDO0FBRUQ7Ozs7OztHQU1HO0FBQ0gsTUFBTSxVQUFVLGVBQWUsQ0FBQyxRQUE0QjtJQUMxRCxJQUFJLE9BQU8sUUFBUSxLQUFLLFFBQVEsRUFBRSxDQUFDO1FBQ2pDLFFBQVEsUUFBUSxDQUFDLFdBQVcsRUFBRSxFQUFFLENBQUM7WUFDL0IsS0FBSyxPQUFPO2dCQUNWLE9BQU8sQ0FBQyxDQUFBO1lBQ1YsS0FBSyxPQUFPO2dCQUNWLE9BQU8sQ0FBQyxDQUFBO1lBQ1YsS0FBSyxPQUFPO2dCQUNWLE9BQU8sQ0FBQyxDQUFBO1lBQ1YsS0FBSyxNQUFNO2dCQUNULE9BQU8sQ0FBQyxDQUFBO1lBQ1YsS0FBSyxTQUFTO2dCQUNaLE9BQU8sQ0FBQyxDQUFBO1lBQ1YsS0FBSyxPQUFPO2dCQUNWLE9BQU8sQ0FBQyxDQUFBO1lBQ1YsS0FBSyxPQUFPO2dCQUNWLE9BQU8sQ0FBQyxDQUFBO1lBQ1Y7Z0JBQ0UsTUFBTSxJQUFJLEtBQUssQ0FBQyxzQkFBc0IsUUFBUSxFQUFFLENBQUMsQ0FBQTtRQUNyRCxDQUFDO0lBQ0gsQ0FBQztJQUNELE9BQU8sUUFBUSxDQUFBO0FBQ2pCLENBQUM7QUFFRDs7Ozs7Ozs7O0dBU0c7QUFDSCxNQUFNLFVBQVUsZ0JBQWdCLENBQUMsU0FBaUI7SUFDaEQsSUFBSSxDQUFDLEVBQUUsQ0FBQyxVQUFVLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQztRQUM5QixNQUFNLElBQUksS0FBSyxDQUFDLGdDQUFnQyxTQUFTLEVBQUUsQ0FBQyxDQUFBO0lBQzlELENBQUM7SUFFRCxNQUFNLFVBQVUsR0FBYSxFQUFFLENBQUMsUUFBUSxDQUFDLFNBQVMsQ0FBQyxDQUFBO0lBRW5ELElBQUksVUFBVSxDQUFDLFdBQVcsRUFBRSxFQUFFLENBQUM7UUFDN0IsTUFBTSxDQUFDLElBQUksQ0FBQyxnQ0FBZ0MsU0FBUyxFQUFFLENBQUMsQ0FBQTtRQUN4RCxNQUFNLEtBQUssR0FBYSxFQUFFLENBQUMsV0FBVyxDQUFDLFNBQVMsQ0FBQyxDQUFBO1FBQ2pELE1BQU0sYUFBYSxHQUFhLEtBQUssQ0FBQyxNQUFNLENBQUMsQ0FBQyxJQUFZLEVBQUUsRUFBRSxDQUM1RCxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLFdBQVcsRUFBRSxLQUFLLFFBQVEsQ0FDOUMsQ0FBQTtRQUNELE1BQU0sQ0FBQyxJQUFJLENBQUMsU0FBUyxhQUFhLENBQUMsTUFBTSxtQkFBbUIsU0FBUyxZQUFZLENBQUMsQ0FBQTtRQUNsRixNQUFNLENBQUMsS0FBSyxDQUFDLHlCQUF5QixhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQTtRQUNqRSxPQUFPLGFBQWEsQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFZLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxFQUFFLElBQUksQ0FBQyxDQUFDLENBQUE7SUFDeEUsQ0FBQztJQUVELElBQUksVUFBVSxDQUFDLE1BQU0sRUFBRSxFQUFFLENBQUM7UUFDeEIsTUFBTSxDQUFDLElBQUksQ0FBQywyQkFBMkIsU0FBUyxFQUFFLENBQUMsQ0FBQTtRQUNuRCxPQUFPLENBQUMsU0FBUyxDQUFDLENBQUE7SUFDcEIsQ0FBQztJQUVELE1BQU0sSUFBSSxLQUFLLENBQUMsbURBQW1ELFNBQVMsRUFBRSxDQUFDLENBQUE7QUFDakYsQ0FBQyJ9

package/dist/SarifToSlackService.d.ts

@@ -0,0 +1,39 @@
+import { SarifToSlackServiceOptions, SlackMessage } from './types';
+/**
+ * Service to convert SARIF files to Slack messages and send them.
+ * @public
+ */
+export declare class SarifToSlackService {
+    private readonly _slackMessages;
+    private constructor();
+    /**
+     * Gets the Slack messages prepared for each SARIF file.
+     * @returns A read-only map where keys are SARIF file paths and values are SlackMessage instances.
+     * @public
+     */
+    get slackMessages(): ReadonlyMap<string, SlackMessage>;
+    /**
+     * Creates an instance of SarifToSlackService.
+     * @param opts - Options for the service, including webhook URL, SARIF path, and other configurations.
+     * @returns A promise that resolves to an instance of SarifToSlackService.
+     * @throws Error if no SARIF files are found at the provided path.
+     * @public
+     */
+    static create(opts: SarifToSlackServiceOptions): Promise<SarifToSlackService>;
+    /**
+     * Sends all prepared Slack messages.
+     * @returns A promise that resolves when all messages have been sent.
+     * @throws Error if a Slack message was not prepared for a SARIF path.
+     * @public
+     */
+    sendAll(): Promise<void>;
+    /**
+     * Sends a Slack message for a specific SARIF path.
+     * @param sarifPath - The path of the SARIF file for which the message should be sent.
+     * @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(sarifPath: string): Promise<void>;
+}
+//# sourceMappingURL=SarifToSlackService.d.ts.map

package/dist/SarifToSlackService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SarifToSlackService.d.ts","sourceRoot":"","sources":["../src/SarifToSlackService.ts"],"names":[],"mappings":"AAIA,OAAO,EAEL,0BAA0B,EAC1B,YAAY,EACb,MAAM,SAAS,CAAA;AAmChB;;;GAGG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA4B;IAE3D,OAAO;IAIP;;;;OAIG;IACH,IAAW,aAAa,IAAI,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,CAE5D;IAED;;;;;;OAMG;WACiB,MAAM,CAAC,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAU1F;;;;;OAKG;IACU,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAMrC;;;;;;OAMG;IACU,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAQpD"}

package/dist/SarifToSlackService.js

@@ -0,0 +1,95 @@
+import { promises as fs } from 'fs';
+import Logger from './Logger';
+import { processColor, processLogLevel, processSarifPath } from './Processors';
+import { SlackMessageBuilder } from './SlackMessageBuilder';
+async function initialize(opts) {
+    const slackMessages = new Map();
+    const sarifFiles = processSarifPath(opts.sarifPath);
+    if (sarifFiles.length === 0) {
+        throw new Error(`No SARIF files found at the provided path: ${opts.sarifPath}`);
+    }
+    for (const sarifFile of sarifFiles) {
+        const jsonString = await fs.readFile(sarifFile, 'utf8');
+        const messageBuilder = new SlackMessageBuilder(opts.webhookUrl, {
+            username: opts.username,
+            iconUrl: opts.iconUrl,
+            color: processColor(opts.color),
+            sarif: JSON.parse(jsonString)
+        });
+        if (opts.header?.include) {
+            messageBuilder.withHeader(opts.header?.value);
+        }
+        if (opts.footer?.include) {
+            messageBuilder.withFooter(opts.footer?.value, opts.footer?.type);
+        }
+        if (opts.actor?.include) {
+            messageBuilder.withActor(opts.actor?.value);
+        }
+        if (opts.run?.include) {
+            messageBuilder.withRun();
+        }
+        slackMessages.set(sarifFile, messageBuilder);
+    }
+    return slackMessages;
+}
+/**
+ * Service to convert SARIF files to Slack messages and send them.
+ * @public
+ */
+export class SarifToSlackService {
+    _slackMessages;
+    constructor() {
+        this._slackMessages = new Map();
+    }
+    /**
+     * Gets the Slack messages prepared for each SARIF file.
+     * @returns A read-only map where keys are SARIF file paths and values are SlackMessage instances.
+     * @public
+     */
+    get slackMessages() {
+        return this._slackMessages;
+    }
+    /**
+     * Creates an instance of SarifToSlackService.
+     * @param opts - Options for the service, including webhook URL, SARIF path, and other configurations.
+     * @returns A promise that resolves to an instance of SarifToSlackService.
+     * @throws Error if no SARIF files are found at the provided path.
+     * @public
+     */
+    static async create(opts) {
+        Logger.initialize({
+            logLevel: processLogLevel(opts.logLevel)
+        });
+        const instance = new SarifToSlackService();
+        const map = await initialize(opts);
+        map.forEach((val, key) => instance._slackMessages.set(key, val));
+        return instance;
+    }
+    /**
+     * Sends all prepared Slack messages.
+     * @returns A promise that resolves when all messages have been sent.
+     * @throws Error if a Slack message was not prepared for a SARIF path.
+     * @public
+     */
+    async sendAll() {
+        for (const sarifPath of this._slackMessages.keys()) {
+            await this.send(sarifPath);
+        }
+    }
+    /**
+     * Sends a Slack message for a specific SARIF path.
+     * @param sarifPath - The path of the SARIF file for which the message should be sent.
+     * @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
+     */
+    async send(sarifPath) {
+        const message = this._slackMessages.get(sarifPath);
+        if (!message) {
+            throw new Error(`Slack message was not prepared for SARIF path: ${sarifPath}.`);
+        }
+        const text = await message.send();
+        Logger.info(`Message sent for ${sarifPath} file. Status:`, text);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiU2FyaWZUb1NsYWNrU2VydmljZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9TYXJpZlRvU2xhY2tTZXJ2aWNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxRQUFRLElBQUksRUFBRSxFQUFFLE1BQU0sSUFBSSxDQUFDO0FBQ3BDLE9BQU8sTUFBTSxNQUFNLFVBQVUsQ0FBQTtBQUM3QixPQUFPLEVBQUUsWUFBWSxFQUFFLGVBQWUsRUFBRSxnQkFBZ0IsRUFBRSxNQUFNLGNBQWMsQ0FBQTtBQUM5RSxPQUFPLEVBQUUsbUJBQW1CLEVBQUUsTUFBTSx1QkFBdUIsQ0FBQTtBQU8zRCxLQUFLLFVBQVUsVUFBVSxDQUFDLElBQWdDO0lBQ3hELE1BQU0sYUFBYSxHQUFHLElBQUksR0FBRyxFQUF3QixDQUFDO0lBQ3RELE1BQU0sVUFBVSxHQUFhLGdCQUFnQixDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsQ0FBQTtJQUM3RCxJQUFJLFVBQVUsQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFLENBQUM7UUFDNUIsTUFBTSxJQUFJLEtBQUssQ0FBQyw4Q0FBOEMsSUFBSSxDQUFDLFNBQVMsRUFBRSxDQUFDLENBQUE7SUFDakYsQ0FBQztJQUVELEtBQUssTUFBTSxTQUFTLElBQUksVUFBVSxFQUFFLENBQUM7UUFDbkMsTUFBTSxVQUFVLEdBQVcsTUFBTSxFQUFFLENBQUMsUUFBUSxDQUFDLFNBQVMsRUFBRSxNQUFNLENBQUMsQ0FBQTtRQUUvRCxNQUFNLGNBQWMsR0FBRyxJQUFJLG1CQUFtQixDQUFDLElBQUksQ0FBQyxVQUFVLEVBQUU7WUFDOUQsUUFBUSxFQUFFLElBQUksQ0FBQyxRQUFRO1lBQ3ZCLE9BQU8sRUFBRSxJQUFJLENBQUMsT0FBTztZQUNyQixLQUFLLEVBQUUsWUFBWSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUM7WUFDL0IsS0FBSyxFQUFFLElBQUksQ0FBQyxLQUFLLENBQUMsVUFBVSxDQUFVO1NBQ3ZDLENBQUMsQ0FBQTtRQUNGLElBQUksSUFBSSxDQUFDLE1BQU0sRUFBRSxPQUFPLEVBQUUsQ0FBQztZQUN6QixjQUFjLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsS0FBSyxDQUFDLENBQUE7UUFDL0MsQ0FBQztRQUNELElBQUksSUFBSSxDQUFDLE1BQU0sRUFBRSxPQUFPLEVBQUUsQ0FBQztZQUN6QixjQUFjLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsS0FBSyxFQUFFLElBQUksQ0FBQyxNQUFNLEVBQUUsSUFBSSxDQUFDLENBQUE7UUFDbEUsQ0FBQztRQUNELElBQUksSUFBSSxDQUFDLEtBQUssRUFBRSxPQUFPLEVBQUUsQ0FBQztZQUN4QixjQUFjLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxLQUFLLEVBQUUsS0FBSyxDQUFDLENBQUE7UUFDN0MsQ0FBQztRQUNELElBQUksSUFBSSxDQUFDLEdBQUcsRUFBRSxPQUFPLEVBQUUsQ0FBQztZQUN0QixjQUFjLENBQUMsT0FBTyxFQUFFLENBQUE7UUFDMUIsQ0FBQztRQUNELGFBQWEsQ0FBQyxHQUFHLENBQUMsU0FBUyxFQUFFLGNBQWMsQ0FBQyxDQUFBO0lBQzlDLENBQUM7SUFDRCxPQUFPLGFBQWEsQ0FBQztBQUN2QixDQUFDO0FBRUQ7OztHQUdHO0FBQ0gsTUFBTSxPQUFPLG1CQUFtQjtJQUNiLGNBQWMsQ0FBNEI7SUFFM0Q7UUFDRSxJQUFJLENBQUMsY0FBYyxHQUFHLElBQUksR0FBRyxFQUF3QixDQUFDO0lBQ3hELENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsSUFBVyxhQUFhO1FBQ3RCLE9BQU8sSUFBSSxDQUFDLGNBQWMsQ0FBQztJQUM3QixDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0ksTUFBTSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsSUFBZ0M7UUFDekQsTUFBTSxDQUFDLFVBQVUsQ0FBQztZQUNoQixRQUFRLEVBQUUsZUFBZSxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUM7U0FDekMsQ0FBQyxDQUFBO1FBQ0YsTUFBTSxRQUFRLEdBQXdCLElBQUksbUJBQW1CLEVBQUUsQ0FBQTtRQUMvRCxNQUFNLEdBQUcsR0FBOEIsTUFBTSxVQUFVLENBQUMsSUFBSSxDQUFDLENBQUE7UUFDN0QsR0FBRyxDQUFDLE9BQU8sQ0FBQyxDQUFDLEdBQWlCLEVBQUUsR0FBVyxFQUFFLEVBQUUsQ0FBQyxRQUFRLENBQUMsY0FBYyxDQUFDLEdBQUcsQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLENBQUMsQ0FBQTtRQUN0RixPQUFPLFFBQVEsQ0FBQTtJQUNqQixDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSSxLQUFLLENBQUMsT0FBTztRQUNsQixLQUFLLE1BQU0sU0FBUyxJQUFJLElBQUksQ0FBQyxjQUFjLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQztZQUNuRCxNQUFNLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLENBQUM7UUFDN0IsQ0FBQztJQUNILENBQUM7SUFFRDs7Ozs7O09BTUc7SUFDSSxLQUFLLENBQUMsSUFBSSxDQUFDLFNBQWlCO1FBQ2pDLE1BQU0sT0FBTyxHQUE2QixJQUFJLENBQUMsY0FBYyxDQUFDLEdBQUcsQ0FBQyxTQUFTLENBQUMsQ0FBQTtRQUM1RSxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7WUFDYixNQUFNLElBQUksS0FBSyxDQUFDLGtEQUFrRCxTQUFTLEdBQUcsQ0FBQyxDQUFBO1FBQ2pGLENBQUM7UUFDRCxNQUFNLElBQUksR0FBVyxNQUFNLE9BQU8sQ0FBQyxJQUFJLEVBQUUsQ0FBQTtRQUN6QyxNQUFNLENBQUMsSUFBSSxDQUFDLG9CQUFvQixTQUFTLGdCQUFnQixFQUFFLElBQUksQ0FBQyxDQUFBO0lBQ2xFLENBQUM7Q0FDRiJ9

package/dist/SlackMessageBuilder.d.ts

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

package/dist/SlackMessageBuilder.d.ts.map

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