@aikidosec/ci-api-client 1.0.7 → 1.0.9

package/README.md

@@ -80,6 +80,7 @@ Options:
   --minimum-severity-level <level>       Set the minimum severity level. Accepted options are: LOW, MEDIUM, HIGH and CRITICAL. (choices: "LOW",
                                          "MEDIUM", "HIGH", "CRITICAL")
   --poll-interval [interval]             The poll interval when checking for an updated scan result (preset: 5)
+  --base-branch <branchname>             Optional: base branch for the release gated scan.
   -h, --help                             display help for command
 ```
 

package/lib/aikidoApi.d.ts

@@ -15,6 +15,7 @@ export type TScanApiOptions = {
     minimum_severity?: string;
     version: string;
     is_release_gating?: boolean;
+    base_branch?: string;
 };
 export type TStartScanResult = {
     scan_id: number;

package/lib/commands/scan.js

@@ -6,7 +6,7 @@ import { outputError, outputHttpError, outputLog, startSpinner, } from '../outpu
 async function cli(repoId, baseCommitId, headCommitId, branchName, options, command) {
     const apiKey = getApiKey();
     if (!apiKey) {
-        outputError('Please set an api key using: aikido-cli apikey <key>');
+        outputError('Please set an api key using: aikido-cli-client apikey <key>');
     }
     const { apiOptions, cliOptions } = parseCliOptions(options);
     let loader;
@@ -118,7 +118,7 @@ export const scan = async ({ repoId, baseCommitId, headCommitId, branchName, opt
     pollStatus();
 };
 const parseCliOptions = (userCliOptions) => {
-    const apiOptions = { version: '1.0.7' };
+    const apiOptions = { version: '1.0.9' };
     const cliOptions = { pollInterval: 5 };
     if (userCliOptions.pullRequestTitle) {
         apiOptions.pull_request_metadata = {

package/lib/commands/scanRelease.d.ts

@@ -23,6 +23,7 @@ type TScanUserCliOptions = {
     failOnIacScan?: boolean;
     minimumSeverityLevel?: string;
     pollInterval?: number;
+    baseBranch?: string;
 };
 declare function cli(repoId: string, commitId: string, options: TScanUserCliOptions, command: string): Promise<void>;
 export declare const scan: ({ repoId, commitId, options, pollInterval, onStart, onStartComplete, onStartFail, onScanStart, onNextPoll, onScanComplete, onScanFail, }: TScanArguments) => Promise<void>;

package/lib/commands/scanRelease.js

@@ -6,7 +6,7 @@ import { outputError, outputHttpError, outputLog, startSpinner, } from '../outpu
 async function cli(repoId, commitId, options, command) {
     const apiKey = getApiKey();
     if (!apiKey) {
-        outputError('Please set an api key using: aikido-cli apikey <key>');
+        outputError('Please set an api key using: aikido-cli-client apikey <key>');
     }
     const { apiOptions, cliOptions } = parseCliOptions(options);
     let loader;
@@ -52,7 +52,12 @@ async function cli(repoId, commitId, options, command) {
     const onFail = (error) => {
         loader?.fail();
         if (error.response?.status && error.response?.status === 404) {
-            outputError('Please verify your commit SHA');
+            if (error.response?.data?.reason_phrase) {
+                outputError(error.response?.data?.reason_phrase);
+            }
+            else {
+                outputError('Please verify your repository id or commit SHA');
+            }
         }
         else {
             outputHttpError(error);
@@ -115,7 +120,7 @@ export const scan = async ({ repoId, commitId, options, pollInterval = 10, onSta
     pollStatus();
 };
 const parseCliOptions = (userCliOptions) => {
-    const apiOptions = { version: '1.0.7' };
+    const apiOptions = { version: '1.0.9' };
     const cliOptions = { pollInterval: 10 };
     if (userCliOptions.pullRequestTitle) {
         apiOptions.pull_request_metadata = {
@@ -147,6 +152,9 @@ const parseCliOptions = (userCliOptions) => {
     if (userCliOptions.minimumSeverityLevel) {
         apiOptions.minimum_severity = userCliOptions.minimumSeverityLevel;
     }
+    if (userCliOptions.baseBranch) {
+        apiOptions.base_branch = userCliOptions.baseBranch;
+    }
     if (userCliOptions.pollInterval &&
         (isNaN(userCliOptions.pollInterval) || userCliOptions.pollInterval <= 0)) {
         outputError('Please provide a valid poll interval');
@@ -177,6 +185,7 @@ export const cliSetup = (program) => program
     .addOption(new Option('--poll-interval [interval]', 'The poll interval when checking for an updated scan result')
     .preset(10)
     .argParser(parseFloat))
+    .addOption(new Option('--base-branch <branchname>', 'Base branch for the release gated scan.'))
     .description('Run a release scan of an Aikido repo.')
     .action(cli);
 export default { cli, cliSetup, scan };

package/lib/commands/upload.js

@@ -7,7 +7,7 @@ import { promisify } from 'util';
 async function cli(options, command) {
     const apiKey = getApiKey();
     if (!apiKey) {
-        outputError('Please set an api key using: aikido-cli apikey <key>');
+        outputError('Please set an api key using: aikido-cli-client apikey <key>');
     }
     const { apiOptions, cliOptions } = await parseCliOptions(options);
     let loader = startSpinner('Uploading custom scan');

package/lib/index.js

@@ -11,7 +11,7 @@ export const program = new Command();
 program
     .name('Aikido API Client')
     .description('CLI api client to easily integrate the Aikido public CI API into custom deploy scripts')
-    .version('1.0.7');
+    .version('1.0.9');
 apiKey.cliSetup(program);
 scan.cliSetup(program);
 scanRelease.cliSetup(program);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aikidosec/ci-api-client",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "CLI api client to easily integrate the Aikido public CI API into custom deploy scripts",
   "license": "MIT",
   "author": "Bert Devriese <bert@builtinbruges.com>",

package/src/aikidoApi.ts

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

package/src/commands/scan.ts

@@ -76,7 +76,7 @@ async function cli(
   const apiKey = getApiKey();
 
   if (!apiKey) {
-    outputError('Please set an api key using: aikido-cli apikey <key>');
+    outputError('Please set an api key using: aikido-cli-client apikey <key>');
   }
 
   // Process command options and group them into apiOptions hash
@@ -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.7' };
+  const apiOptions: TScanApiOptions = { version: '1.0.9' };
   const cliOptions: TScanCliOptions = { pollInterval: 5 };
 
   if (userCliOptions.pullRequestTitle) {

package/src/commands/scanRelease.ts

@@ -61,6 +61,7 @@ type TScanUserCliOptions = {
   failOnIacScan?: boolean;
   minimumSeverityLevel?: string;
   pollInterval?: number;
+  baseBranch?: string;
 };
 
 async function cli(
@@ -73,7 +74,7 @@ async function cli(
   const apiKey = getApiKey();
 
   if (!apiKey) {
-    outputError('Please set an api key using: aikido-cli apikey <key>');
+    outputError('Please set an api key using: aikido-cli-client apikey <key>');
   }
 
   // Process command options and group them into apiOptions hash
@@ -144,9 +145,13 @@ async function cli(
     loader?.fail();
 
     if (error.response?.status && error.response?.status === 404) {
-      outputError(
-        'Please verify your commit SHA'
-      );
+      if(error.response?.data?.reason_phrase) {
+        outputError(error.response?.data?.reason_phrase);
+      } else {
+        outputError(
+          'Please verify your repository id or commit SHA'
+        );
+      }
     } else {
       outputHttpError(error);
     }
@@ -238,7 +243,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.7' };
+  const apiOptions: TScanApiOptions = { version: '1.0.9' };
   const cliOptions: TScanCliOptions = { pollInterval: 10 };
 
   if (userCliOptions.pullRequestTitle) {
@@ -271,6 +276,9 @@ const parseCliOptions = (userCliOptions: TScanUserCliOptions) => {
   if (userCliOptions.minimumSeverityLevel) {
     apiOptions.minimum_severity = userCliOptions.minimumSeverityLevel;
   }
+  if (userCliOptions.baseBranch) {
+    apiOptions.base_branch = userCliOptions.baseBranch;
+  }
   if (
     userCliOptions.pollInterval &&
     (isNaN(userCliOptions.pollInterval) || userCliOptions.pollInterval <= 0)
@@ -343,6 +351,12 @@ export const cliSetup = (program: Command) =>
         .preset(10)
         .argParser(parseFloat)
     )
+    .addOption(
+      new Option(
+        '--base-branch <branchname>',
+        'Base branch for the release gated scan.'
+      )
+    ) 
     .description('Run a release scan of an Aikido repo.')
     .action(cli);
 

package/src/commands/upload.ts

@@ -44,7 +44,7 @@ async function cli(options: TUploadUserCliOptions, command: string) {
   const apiKey = getApiKey();
 
   if (!apiKey) {
-    outputError('Please set an api key using: aikido-cli apikey <key>');
+    outputError('Please set an api key using: aikido-cli-client apikey <key>');
   }
 
   // Process command options and group them into apiOptions hash

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.7');
+  .version('1.0.9');
 
 // Load in all app commands and set them up in the `program` instance
 apiKey.cliSetup(program);