@soos-io/api-client - npm Package Compare versions

Comparing version 0.2.14 to 0.2.15-pre.1

dist/utilities.d.ts

@@ -13,4 +13,4 @@ import { ScanStatus, ScanType } from "./enums";
 declare const formatBytes: (bytes: number, decimals?: number) => string;
-declare const verifyScanStatus: (scanStatus: ScanStatus) => boolean;
+declare const getExitCodeFromStatus: (scanStatus: ScanStatus) => number;
 declare const getVulnerabilitiesByScanType: (issues: IIssuesModel | null, scanType: ScanType) => number | undefined;
-export { isNil, ensureValue, ensureEnumValue, ensureNonEmptyValue, sleep, isUrlAvailable, obfuscateProperties, convertStringToBase64, getEnvVariable, formatBytes, verifyScanStatus, getVulnerabilitiesByScanType, };
+export { isNil, ensureValue, ensureEnumValue, ensureNonEmptyValue, sleep, isUrlAvailable, obfuscateProperties, convertStringToBase64, getEnvVariable, formatBytes, getExitCodeFromStatus, getVulnerabilitiesByScanType, };

dist/utilities.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getVulnerabilitiesByScanType = exports.verifyScanStatus = exports.formatBytes = exports.getEnvVariable = exports.convertStringToBase64 = exports.obfuscateProperties = exports.isUrlAvailable = exports.sleep = exports.ensureNonEmptyValue = exports.ensureEnumValue = exports.ensureValue = exports.isNil = void 0;
+exports.getVulnerabilitiesByScanType = exports.getExitCodeFromStatus = exports.formatBytes = exports.getEnvVariable = exports.convertStringToBase64 = exports.obfuscateProperties = exports.isUrlAvailable = exports.sleep = exports.ensureNonEmptyValue = exports.ensureEnumValue = exports.ensureValue = exports.isNil = void 0;
 const tslib_1 = require("tslib");
@@ -104,19 +104,19 @@ const axios_1 = tslib_1.__importStar(require("axios"));
 exports.formatBytes = formatBytes;
-const verifyScanStatus = (scanStatus) => {
-    let fail = false;
+const getExitCodeFromStatus = (scanStatus) => {
+    let exitCode = 0;
     if (scanStatus === enums_1.ScanStatus.FailedWithIssues) {
         SOOSLogger_1.soosLogger.warn("Analysis Complete. Failures reported.");
-        fail = true;
+        exitCode = 2;
     }
     else if (scanStatus === enums_1.ScanStatus.Incomplete) {
         SOOSLogger_1.soosLogger.warn("Analysis Incomplete. It may have been cancelled or superseded by another scan.");
-        fail = true;
+        exitCode = 1;
     }
     else if (scanStatus === enums_1.ScanStatus.Error) {
         SOOSLogger_1.soosLogger.warn("Analysis Error.");
-        fail = true;
+        exitCode = 1;
     }
-    return fail;
+    return exitCode;
 };
-exports.verifyScanStatus = verifyScanStatus;
+exports.getExitCodeFromStatus = getExitCodeFromStatus;
 const getVulnerabilitiesByScanType = (issues, scanType) => {
@@ -123,0 +123,0 @@ if (isNil(issues))

dist/utilities.test.js

@@ -61,15 +61,15 @@ "use strict";
 });
-describe("verifyScanStatus", () => {
-    test("should return false for Finished", () => {
-        expect((0, utilities_1.verifyScanStatus)(enums_1.ScanStatus.Finished)).toBe(false);
+describe("getExitCodeFromStatus", () => {
+    test("should return 0 for Finished", () => {
+        expect((0, utilities_1.getExitCodeFromStatus)(enums_1.ScanStatus.Finished)).toBe(0);
     });
-    test("should return true for an Incomplete status", () => {
-        expect((0, utilities_1.verifyScanStatus)(enums_1.ScanStatus.Incomplete)).toBe(true);
+    test("should return 1 for an Incomplete status", () => {
+        expect((0, utilities_1.getExitCodeFromStatus)(enums_1.ScanStatus.Incomplete)).toBe(1);
     });
-    test("should return true for an Error status", () => {
-        expect((0, utilities_1.verifyScanStatus)(enums_1.ScanStatus.Error)).toBe(true);
+    test("should return 1 for an Error status", () => {
+        expect((0, utilities_1.getExitCodeFromStatus)(enums_1.ScanStatus.Error)).toBe(1);
     });
-    test("should return true for a FailedWithIssues status", () => {
-        expect((0, utilities_1.verifyScanStatus)(enums_1.ScanStatus.FailedWithIssues)).toBe(true);
+    test("should return 2 for a FailedWithIssues status", () => {
+        expect((0, utilities_1.getExitCodeFromStatus)(enums_1.ScanStatus.FailedWithIssues)).toBe(2);
     });
 });

jest.config.ts

@@ -0,0 +0,0 @@ module.exports = {

package.json

 {
   "name": "@soos-io/api-client",
-  "version": "0.2.14",
+  "version": "0.2.15-pre.1",
   "description": "This is the SOOS API Client for registered clients leveraging the various integrations to the SOOS platform.",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -0,0 +0,0 @@ # [About SOOS](https://soos.io/)

No alert changes

Improved metrics

Total package byte prevSize

75343

increased by0.19%

No dependency changes