@soos-io/api-client
Advanced tools
Comparing version 0.2.3-pre.4 to 0.2.3-pre.5
@@ -7,3 +7,2 @@ "use strict"; | ||
const SOOSApiClient_1 = tslib_1.__importDefault(require("./SOOSApiClient")); | ||
const logging_1 = require("../logging"); | ||
const CompletedScanStatuses = [ | ||
@@ -67,3 +66,2 @@ enums_1.ScanStatus.Error, | ||
const response = await this.client.get(scanStatusUrl); | ||
logging_1.soosLogger.info(`scan status test: issues ${response.data.issues}`); | ||
return { | ||
@@ -70,0 +68,0 @@ status: response.data.status, |
@@ -26,2 +26,3 @@ import SOOSAnalysisApiClient, { ICreateScanRequestContributingDeveloperAudit, ICreateScanResponse } from "../api/SOOSAnalysisApiClient"; | ||
scanUrl: string; | ||
scanType: ScanType; | ||
} | ||
@@ -64,3 +65,3 @@ interface ISetupScanParams { | ||
startScan({ clientId, projectHash, analysisId, scanType, scanUrl, }: IStartScanParams): Promise<void>; | ||
waitForScanToFinish({ scanStatusUrl, scanUrl, }: IWaitForScanToFinishParams): Promise<ScanStatus>; | ||
waitForScanToFinish({ scanStatusUrl, scanUrl, scanType, }: IWaitForScanToFinishParams): Promise<ScanStatus>; | ||
generateFormattedOutput({ clientId, projectHash, projectName, branchHash, scanType, analysisId, outputFormat, sourceCodePath, workingDirectory, }: IGenerateFormattedOutputParams): Promise<void>; | ||
@@ -67,0 +68,0 @@ updateScanStatus({ clientId, projectHash, branchHash, scanType, analysisId, status, message, }: IUpdateScanStatusParams): Promise<void>; |
@@ -119,3 +119,3 @@ "use strict"; | ||
} | ||
async waitForScanToFinish({ scanStatusUrl, scanUrl, }) { | ||
async waitForScanToFinish({ scanStatusUrl, scanUrl, scanType, }) { | ||
const scanStatus = await this.analysisApiClient.getScanStatus({ | ||
@@ -127,3 +127,3 @@ scanStatusUrl: scanStatusUrl, | ||
await (0, utilities_1.sleep)(constants_1.SOOS_CONSTANTS.Status.DelayTime); | ||
return await this.waitForScanToFinish({ scanStatusUrl, scanUrl }); | ||
return await this.waitForScanToFinish({ scanStatusUrl, scanUrl, scanType }); | ||
} | ||
@@ -138,6 +138,9 @@ if (scanStatus.errors.length > 0) { | ||
const violations = StringUtilities_1.default.pluralizeTemplate(scanStatus.issues.Violation?.count ?? 0, "violation"); | ||
const substitutions = StringUtilities_1.default.pluralizeTemplate(scanStatus.issues.DependencySubstitution?.count ?? 0, "DependencySubstitution"); | ||
const typos = StringUtilities_1.default.pluralizeTemplate(scanStatus.issues.DependencyTypo?.count ?? 0, "DependencyTypo"); | ||
statusMessage = statusMessage.concat(`${scanStatus.isSuccess ? ", but had" : " because of"} ${vulnerabilities} and ${violations} ${substitutions ? `(${substitutions})` : ""} ${typos ? `(${typos})` : ""}. | ||
`); | ||
let substitutions = null; | ||
let typos = null; | ||
if (scanType === enums_1.ScanType.SBOM || scanType === enums_1.ScanType.SCA) { | ||
substitutions = StringUtilities_1.default.pluralizeTemplate(scanStatus.issues.DependencySubstitution?.count ?? 0, "DependencySubstitution"); | ||
typos = StringUtilities_1.default.pluralizeTemplate(scanStatus.issues.DependencyTypo?.count ?? 0, "DependencyTypo"); | ||
} | ||
statusMessage = statusMessage.concat(`${scanStatus.isSuccess ? ", with" : " because of"} ${vulnerabilities} (${violations})${substitutions ? ` (${substitutions})` : ""}${typos ? ` (${typos})` : ""}.`); | ||
const resultMessage = `${statusMessage}. View the results at: ${scanUrl}`; | ||
@@ -144,0 +147,0 @@ logging_1.soosLogger.info(resultMessage); |
{ | ||
"name": "@soos-io/api-client", | ||
"version": "0.2.3-pre.4", | ||
"version": "0.2.3-pre.5", | ||
"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", |
63502
1425