@aikidosec/ci-api-client 1.0.14 → 1.0.15

package/.github/workflows/build-and-release.yml

@@ -3,6 +3,10 @@ on:
   release:
     types: [published]
 
+permissions:
+  contents: read
+  id-token: write
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -14,11 +18,14 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: "20.x"
+          node-version: "22"
           registry-url: "https://registry.npmjs.org"
           scope: "@aikidosec"
           cache: 'npm'
 
+      - name: Update npm
+        run: npm install -g npm@11.10.0 # pinned to 11.10.0 to work around https://github.com/nodejs/node/issues/62425
+
       - name: Install dependencies
         run: npm ci
 
@@ -35,6 +42,4 @@ jobs:
       - name: Publish to NPM
         run: |
           echo "Publishing version ${{ steps.get_version.outputs.tag }} to NPM"
-          npm publish --provenance --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
+          npm publish --access public

package/lib/aikidoApi.d.ts

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

package/lib/commands/scan.js

@@ -118,7 +118,7 @@ export const scan = async ({ repoId, baseCommitId, headCommitId, branchName, opt
     pollStatus();
 };
 const parseCliOptions = (userCliOptions) => {
-    const apiOptions = { version: '1.0.11' };
+    const apiOptions = { version: '1.0.15' };
     const cliOptions = { pollInterval: 5 };
     if (userCliOptions.pullRequestTitle) {
         apiOptions.pull_request_metadata = {

package/lib/commands/scanRelease.d.ts

@@ -24,6 +24,7 @@ type TScanUserCliOptions = {
     minimumSeverityLevel?: string;
     pollInterval?: number;
     baseBranch?: string;
+    slaMode?: boolean;
 };
 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

@@ -35,7 +35,10 @@ async function cli(repoId, commitId, options, command) {
         }
         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));
             }
             if (pollResult.issue_links) {
@@ -120,7 +123,7 @@ export const scan = async ({ repoId, commitId, options, pollInterval = 10, onSta
     pollStatus();
 };
 const parseCliOptions = (userCliOptions) => {
-    const apiOptions = { version: '1.0.11' };
+    const apiOptions = { version: '1.0.15' };
     const cliOptions = { pollInterval: 10 };
     if (userCliOptions.pullRequestTitle) {
         apiOptions.pull_request_metadata = {
@@ -155,6 +158,9 @@ const parseCliOptions = (userCliOptions) => {
     if (userCliOptions.baseBranch) {
         apiOptions.base_branch = userCliOptions.baseBranch;
     }
+    if (userCliOptions.slaMode) {
+        apiOptions.sla_mode = true;
+    }
     if (userCliOptions.pollInterval &&
         (isNaN(userCliOptions.pollInterval) || userCliOptions.pollInterval <= 0)) {
         outputError('Please provide a valid poll interval');
@@ -186,6 +192,7 @@ export const cliSetup = (program) => program
     .preset(10)
     .argParser(parseFloat))
     .addOption(new Option('--base-branch <branchname>', '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);
 export default { cli, cliSetup, 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.12');
+    .version('1.0.15');
 apiKey.cliSetup(program);
 scan.cliSetup(program);
 scanRelease.cliSetup(program);

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@aikidosec/ci-api-client",
-  "version": "1.0.14",
+  "version": "1.0.15",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@aikidosec/ci-api-client",
-      "version": "1.0.14",
+      "version": "1.0.15",
       "license": "MIT",
       "dependencies": {
         "axios": "1.8.3",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aikidosec/ci-api-client",
-  "version": "1.0.14",
+  "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>",

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