@aikidosec/ci-api-client 1.0.11 → 1.0.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aikidosec/ci-api-client",
-  "version": "1.0.11",
+  "version": "1.0.15",
   "description": "CLI api client to easily integrate the Aikido public CI API into custom deploy scripts",
   "license": "MIT",
   "author": "Bert Devriese <bert@builtinbruges.com>",
@@ -17,35 +17,38 @@
   "scripts": {
     "start": "nodemon --watch 'src/**/*.ts' --esm --exec 'ts-node' src/index.ts",
     "build": "tsc -p .",
-    "local": "yarn build && yarn global add file:$PWD; aikido-api-client",
-    "local-rm": "yarn global remove aikido-api-client",
+    "local": "npm run build && npm install -g file:$PWD; aikido-api-client",
+    "local-rm": "npm uninstall -g @aikidosec/ci-api-client",
     "format": "prettier --write 'src/**/*.ts'",
     "//": {
-      "refresh": "rm -rf ./node_modules ./yarn.lock && yarn"
+      "refresh": "rm -rf ./node_modules ./npm-shrinkwrap.json && npm install && npm shrinkwrap"
     }
   },
   "dependencies": {
-    "axios": "^1.4.0",
-    "chalk": "^5.3.0",
-    "commander": "^11.0.0",
-    "configstore": "^6.0.0",
-    "dotenv": "^16.3.1",
-    "ora": "^6.3.1"
+    "axios": "1.8.3",
+    "chalk": "5.3.0",
+    "commander": "11.0.0",
+    "configstore": "6.0.0",
+    "dotenv": "16.3.1",
+    "ora": "6.3.1"
   },
   "devDependencies": {
-    "@types/chalk": "^2.2.0",
-    "@types/commander": "^2.12.2",
-    "@types/configstore": "^6.0.0",
-    "@types/dotenv": "^8.2.0",
-    "@types/node": "^20.3.3",
-    "nodemon": "^2.0.22",
-    "prettier": "^2.8.8",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.1.6"
+    "@types/chalk": "2.2.0",
+    "@types/commander": "2.12.2",
+    "@types/configstore": "6.0.0",
+    "@types/dotenv": "8.2.0",
+    "@types/node": "20.3.3",
+    "nodemon": "2.0.22",
+    "prettier": "2.8.8",
+    "ts-node": "10.9.1",
+    "typescript": "5.1.6"
   },
   "keywords": [
     "aikido",
     "security",
     "cli"
-  ]
+  ],
+  "overrides": {
+    "form-data@<=4.0.4": "4.0.4"
+  }
 }

package/src/aikidoApi.ts

@@ -39,6 +39,7 @@ export type TScanApiOptions = {
   version: string;
   is_release_gating?: boolean;
   base_branch?: string;
+  sla_mode?: boolean;
 };
 
 export type TStartScanResult = {

package/src/commands/scan.ts

@@ -245,7 +245,7 @@ export const scan = async ({
 const parseCliOptions = (userCliOptions: TScanUserCliOptions) => {
   // Version provided to the API corresponds with the version in package.json
   // of the cli client
-  const apiOptions: TScanApiOptions = { version: '1.0.11' };
+  const apiOptions: TScanApiOptions = { version: '1.0.15' };
   const cliOptions: TScanCliOptions = { pollInterval: 5 };
 
   if (userCliOptions.pullRequestTitle) {

package/src/commands/scanRelease.ts

@@ -62,6 +62,7 @@ type TScanUserCliOptions = {
   minimumSeverityLevel?: string;
   pollInterval?: number;
   baseBranch?: string;
+  slaMode?: boolean;
 };
 
 async function cli(
@@ -114,7 +115,12 @@ async function cli(
     } else {
       loader?.fail('Scan completed with issues');
 
-      if (pollResult.new_issues_found) {
+      if (apiOptions.sla_mode) {
+        outputLog(
+          chalk.gray(
+            chalk.bold('Issues outside of SLA found: ') + pollResult.issues_outside_sla)
+        );
+      } else if (pollResult.new_issues_found) {
         outputLog(
           chalk.gray(
             chalk.bold('Open issues found: ') + pollResult.new_issues_found
@@ -239,7 +245,7 @@ export const scan = async ({
 const parseCliOptions = (userCliOptions: TScanUserCliOptions) => {
   // Version provided to the API corresponds with the version in package.json
   // of the cli client
-  const apiOptions: TScanApiOptions = { version: '1.0.11' };
+  const apiOptions: TScanApiOptions = { version: '1.0.15' };
   const cliOptions: TScanCliOptions = { pollInterval: 10 };
 
   if (userCliOptions.pullRequestTitle) {
@@ -275,6 +281,9 @@ const parseCliOptions = (userCliOptions: TScanUserCliOptions) => {
   if (userCliOptions.baseBranch) {
     apiOptions.base_branch = userCliOptions.baseBranch;
   }
+  if (userCliOptions.slaMode) {
+    apiOptions.sla_mode = true;
+  }
   if (
     userCliOptions.pollInterval &&
     (isNaN(userCliOptions.pollInterval) || userCliOptions.pollInterval <= 0)
@@ -350,6 +359,10 @@ export const cliSetup = (program: Command) =>
         'Base branch for the release gated scan.'
       )
     )
+    .option(
+      '--sla-mode',
+      'Let Aikido only fail only on open issues that have gone out of SLA.'
+    )
     .description('Run a release scan of an Aikido repo.')
     .action(cli);
 

package/src/index.ts

@@ -20,7 +20,7 @@ program
   .description(
     'CLI api client to easily integrate the Aikido public CI API into custom deploy scripts'
   )
-  .version('1.0.11');
+  .version('1.0.15');
 
 // Load in all app commands and set them up in the `program` instance
 apiKey.cliSetup(program);