Merge pull request #185 from SocketDev/cg/updateFullScansEndpoints

Updates to the full scans endpoints

Author: charliegerard

.github/workflows/ci.yml

@@ -28,4 +28,4 @@ jobs:
     uses: SocketDev/workflows/.github/workflows/reusable-base.yml@master
     with:
       npm-test-script: 'ci-test'
-      node-versions: '14,16,18,19'
+      node-versions: '16,18,19'

index.js

@@ -1,6 +1,8 @@
 'use strict'
 
+const fs = require('node:fs')
 const path = require('node:path')
+const { pipeline } = require('node:stream/promises')
 
 const { ErrorWithCause } = require('pony-cause')
 
@@ -261,14 +263,16 @@ class SocketSdk {
 
   /**
    * @param {string} orgSlug
+   * @param {{[key: string]: any }} queryParams
    * @returns {Promise<SocketSdkResultType<'getOrgFullScanList'>>}
    */
-    async getOrgFullScanList (orgSlug) {
+    async getOrgFullScanList (orgSlug, queryParams) {
       const orgSlugParam = encodeURIComponent(orgSlug)
+      const formattedQueryParams = new URLSearchParams(queryParams)
 
       try {
         const client = await this.#getClient()
-        const data = await client.get(`orgs/${orgSlugParam}/full-scans`).json()
+        const data = await client.get(`orgs/${orgSlugParam}/full-scans?${formattedQueryParams}`).json()
         return { success: true, status: 200, data }
       } catch (err) {
         return /** @type {SocketSdkErrorType<'getOrgFullScanList'>} */ (this.#handleApiError(err))
@@ -278,16 +282,23 @@ class SocketSdk {
   /**
    * @param {string} orgSlug
    * @param {string} fullScanId
+   * @param {string} file
    * @returns {Promise<SocketSdkResultType<'getOrgFullScan'>>}
    */
-    async getOrgFullScan (orgSlug, fullScanId) {
+    async getOrgFullScan (orgSlug, fullScanId, file) {
       const orgSlugParam = encodeURIComponent(orgSlug)
       const fullScanIdParam = encodeURIComponent(fullScanId)
-
       try {
         const client = await this.#getClient()
-        const readStream = await client.stream(`orgs/${orgSlugParam}/full-scans/${fullScanIdParam}`).pipe(process.stdout)
-
+        let readStream
+        if (file) {
+          readStream = await pipeline(
+            client.stream(`orgs/${orgSlugParam}/full-scans/${fullScanIdParam}`),
+            fs.createWriteStream(file)
+          )
+        } else {
+          readStream = await client.stream(`orgs/${orgSlugParam}/full-scans/${fullScanIdParam}`).pipe(process.stdout)
+        }
         return { success: true, status: 200, data: readStream }
       } catch (err) {
         return /** @type {SocketSdkErrorType<'getOrgFullScan'>} */ (this.#handleApiError(err))

package-lock.json

@@ -31,11 +31,11 @@
   },
   "devDependencies": {
     "@socketsecurity/eslint-config": "^4.0.1",
-    "@tsconfig/node14": "^14.1.2",
+    "@tsconfig/node16": "^16.1.3",
     "@types/chai": "^4.3.4",
     "@types/chai-as-promised": "^7.1.5",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^14.18.36",
+    "@types/node": "^16.0.0",
     "@types/tap": "^15.0.7",
     "@typescript-eslint/eslint-plugin": "^6.7.3",
     "@typescript-eslint/parser": "^6.7.3",

package.json

@@ -1,5 +1,5 @@
 {
-  "extends": "@tsconfig/node14/tsconfig.json",
+  "extends": "@tsconfig/node16/tsconfig.json",
   "files": [
     "index.js"
   ],