ts-node-client 2.0.0 → 2.1.0

package/README.md

@@ -7,14 +7,12 @@
 
 [![npm package](https://nodei.co/npm/ts-node-client.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/ts-node-client/)
 
-TrustSource node client
-
-> node module to transfer dependency information to TrustSource server.
+> TrustSource node client - node module to transfer dependency information to TrustSource server.
 
 ## Requirements
-
 * node >= 8.9.0
-* if you are using npm < 8.0.0 we recommend switch to ts-node-client version  1.5.2 until we provide more elegant solution
+* npm < 8.0.0 use **ts-node-client@1.***
+* npm >= 8.0.0 use **ts-node-client@2.***
 
 ## Installation
 Run: `npm install --save-dev ts-node-client` or `yarn add --dev ts-node-client`
@@ -47,8 +45,8 @@ You also may initiate transfer to TrustSource server manually by executing follo
 
 ```
 node_modules/.bin/ts-node-client
-node_modules/.bin/ts-node-client -k apiKey -p Project
-node_modules/.bin/ts-node-client -c config.json
+node_modules/.bin/ts-node-client -k apiKey -p Project --breakOnWarnings false --breakOnViolations true
+node_modules/.bin/ts-node-client -c config.json 
 ```
 ```
 npm / node module to transfer dependency information to TrustSource server.
@@ -61,93 +59,102 @@ Options:
   --binaryLinks   Binary links separated by comma                    [default: null]
   --url           url                                                [default: null]
   --config, -c    Config path                                        [default: null]
-  --proxy         Proxy url like 'https://user:password@host:port'    [default: null]
-  --version, -v   Prints a version                                   [default: false]
+  --proxy         Proxy url like 'https://user:password@host:port'   [default: null]
+  --version       Prints a version                                   [default: null]
+  --saveAs, -o              Save as file (file name prefix)          [default: null]
+  --saveAsFormat, -f      Save as format (scan / cydx / spdx)       [default: null]
   --debug                                                            [default: null]
   --simulate                                                         [default: null]
   --includeDevDependencies                                           [default: null]
   --meteor                                                           [default: null]
-  --brakeOnWarnings                                                  [default: null]
-  --brakeOnViolations                                                [default: null]
+  --breakOnWarnings                                                  [default: null]
+  --breakOnViolations                                                [default: null]
   --help          Prints a usage statement                           [boolean]
+
 ```
+PLEASE NOTE: if you want to pass param into function
+you should add value, for example:
+
+`--breakOnViolations true` or `--saveAs sbom`
+
+## Software bill of materials
+
+[View SBOM  <img alt="TrustSource" src="https://app.trustsource.io/logo.png" width="70"/>](https://app.trustsource.io/api/v1/public-BoM/ae0832c6-5a55-4aa8-8c45-75528d0833fb) 
+
+## Known problems
+
+####  Error: The programmatic API was removed in npm v8.0.0
+You should upgrade to 2.* versions of ts-node-client
 
 ## Changelog
 
-#### 2.0.0 
-#### if you are using npm < 8.0.0 we recommend switch to ts-node-client version  1.5.2 until we provide more elegant solution
+#### 2.1.*
+- Migrate 1.6.* - 1.8.* changes to version 2.1
+
+#### 2.0.*
+- Support new scan tool and fix problem with programmatic API for >= npm@8.0.0
 - Stop usage of [`global-npm`](https://github.com/dracupid/global-npm) until we find new resolution
 - Get back `npm` as local dependency
 
-#### 1.5.2
-- Describe `Error: The programmatic API was removed in npm v8.0.0`
+#### 1.8.*
+- SBOM
+- **--saveAs** and **--saveAsFormat**
+- Bump minimist from 1.2.5 to 1.2.6
+- Bump urijs from 1.19.10 to 1.19.11
+- replace packageurl-js with simple local function
+- improve docs
+
+#### 1.7.*
+- request -> axios
+- fix dependencies
+- doc fixes
+
+#### 1.6.*
+- **--breakOnWarnings** and **--breakOnViolations**
+- Bump devDependencies
 
-#### 1.5.1
+#### 1.5.*
+- Describe `Error: The programmatic API was removed in npm v8.0.0`
 - Bump devDependencies
 - Introduce sonarjs
 
-#### 1.4.3
+#### 1.4.*
 - Bump glob-parent from 5.1.1 to 5.1.2
 - Bump path-parse from 1.0.6 to 1.0.7
-
-#### 1.4.2
 - Bump lodash from 4.17.19 to 4.17.21
-
-#### 1.4.1
 - Bump y18n from 4.0.0 to 4.0.1
-
-#### 1.4.0
 - Added:
     - option **--includeDevDependencies**. It is allow to scan dev dependencies
 
-#### 1.3.1
+#### 1.3.*
 - Use [`global-npm`](https://github.com/dracupid/global-npm) (meaning `npm` is no longer a dependency of `ts-node-client`)
 
-#### 1.2.3
+#### 1.2.*
 - Added:
     - option **--brakeOnViolations**. It is fail build in case any violations after scan transferred.
     - option **--brakeOnWarnings**. It is fail build in case any warning after scan transferred.
 
-#### 1.1.2
+#### 1.1.*
 - userName is not required param for scans
 - Support usage of scan meta param binaryLinks inside Options definition
 
-
-#### 1.0.0
+#### 1.0.*
 - Node JS and dependencies updates "node": ">= 8.12.0"
 
-#### 0.3.4 - 0.3.6
+#### 0.3.*
 - Improve variable usage and tasks migration
-
-#### 0.3.3
 - Support usage of scan meta params: branch and tag inside Options definition
-
-#### 0.3.2
 - Skip npmDependency without names
-
-#### 0.3.1
 - Update travis config
-
-#### 0.3.0
 - Update dependency to resolve vulnerabilities
 
-#### 0.2.5
+#### 0.2.*
 - Added proxy support and config
-
-#### 0.2.4
 - Update travis config
-
-#### 0.2.3
 - Updated README.md with `app.trustsource.io`
-
-#### 0.2.2
 - Updated default url to `app.trustsource.io`
-
-#### 0.2.1
 - Added windows support
 - Fixed json 
-
-#### 0.2.0
 - **Removed:**
     - options: **--credentials** and **--credentialsFile** instead you should use **--config**.
     - option **--baseUrl** instead you should use **--url**.

package/bin/ts-node-client.js

@@ -54,12 +54,17 @@ const getOptions = () => {
             },
             proxy: {
                 default: null,
-                describe: 'Proxy url'
+                describe: 'Proxy url like \'https://user:password@host:port\''
             },
-            version: {
-                alias: 'v',
-                default: false,
-                describe: 'Prints a version'
+            saveAs: {
+                alias: 'o',
+                default: null,
+                describe: 'Save as file (file name prefix)'
+            },
+            saveAsFormat: {
+                alias: 'f',
+                default: null,
+                describe: 'Save as format (scan / cydx / spdx)'
             },
             debug: {
                 default: null,
@@ -73,19 +78,20 @@ const getOptions = () => {
                 default: null,
                 describe: 'meteor'
             },
-            brakeOnWarnings: {
+            breakOnWarnings: {
                 default: null,
-                describe: 'brakeOnWarnings'
+                describe: 'breakOnWarnings'
             },
-            brakeOnViolations: {
+            breakOnViolations: {
                 default: null,
-                describe: 'brakeOnViolations'
+                describe: 'breakOnViolations'
             },
             includeDevDependencies: {
                 default: null,
                 describe: 'includeDevDependencies'
             }
         })
+        .version()
         .usage(pckgJson.description)
         .help('help', 'Prints a usage statement')
         .fail((msg, err, yargsObject) => {
@@ -100,10 +106,10 @@ const getOptions = () => {
     }
     options = (({
         // eslint-disable-next-line max-len
-        apiKey, project, branch, tag, binaryLinks, config, debug, simulate, meteor, url, proxy, brakeOnWarnings, brakeOnViolations, includeDevDependencies
+        apiKey, project, branch, tag, binaryLinks, config, debug, saveAs, saveAsFormat, simulate, meteor, url, proxy, breakOnWarnings, breakOnViolations, includeDevDependencies
     }) => ({
         // eslint-disable-next-line max-len
-        apiKey, project, branch, tag, binaryLinks, config, debug, simulate, scanMeteor: meteor, url, proxy, brakeOnWarnings, brakeOnViolations, includeDevDependencies
+        apiKey, project, branch, tag, binaryLinks, config, debug, saveAs, saveAsFormat, simulate, scanMeteor: meteor, url, proxy, breakOnWarnings, breakOnViolations, includeDevDependencies
     }))(options);
     Object.keys(options).forEach((key) => options[key] === null && delete options[key]);
     return options;
@@ -144,19 +150,21 @@ validateOptions(options);
 
 if (options.debug) {
     console.log('invoking ts-node-client: ');
-    console.log(`${FILL}debug =`, options.debug);
-    console.log(`${FILL}simulate =`, options.simulate);
-    console.log(`${FILL}includeDevDependencies =`, options.includeDevDependencies);
-    console.log(`${FILL}scanMeteor =`, options.scanMeteor);
-    console.log(`${FILL}brakeOnViolations =`, options.brakeOnViolations);
-    console.log(`${FILL}brakeOnWarnings =`, options.brakeOnWarnings);
-    console.log(`${FILL}apiKey = |%s|`, options.apiKey);
-    console.log(`${FILL}project = |%s|`, options.project);
-    console.log(`${FILL}branch = |%s|`, options.branch);
-    console.log(`${FILL}tag = |%s|`, options.tag);
-    console.log(`${FILL}binaryLinks = |%s|`, options.binaryLinks);
-    console.log(`${FILL}url = |%s|`, options.url);
-    console.log(`${FILL}proxy = |%s|`, options.proxy);
+    console.log(`${FILL}debug = %s`, options.debug);
+    console.log(`${FILL}simulate = %s`, options.simulate);
+    console.log(`${FILL}includeDevDependencies = %s`, options.includeDevDependencies);
+    console.log(`${FILL}scanMeteor = %s`, options.scanMeteor);
+    console.log(`${FILL}saveAs = %s`, options.saveAs);
+    console.log(`${FILL}saveAsFormat = %s`, options.saveAsFormat);
+    console.log(`${FILL}breakOnViolations = %s`, options.breakOnViolations);
+    console.log(`${FILL}breakOnWarnings = %s`, options.breakOnWarnings);
+    console.log(`${FILL}apiKey = %s`, options.apiKey);
+    console.log(`${FILL}project = %s`, options.project);
+    console.log(`${FILL}branch = %s`, options.branch);
+    console.log(`${FILL}tag = %s`, options.tag);
+    console.log(`${FILL}binaryLinks = %s`, options.binaryLinks);
+    console.log(`${FILL}url = %s`, options.url);
+    console.log(`${FILL}proxy = %s`, options.proxy);
 }
 
 let exitCode = 0;

package/lib/cli.js

@@ -7,6 +7,8 @@
 /* eslint-enable */
 
 const debuglog = (require('debuglog'))('ts-node-client');
+const fs = require('fs');
+const Convertor = require('./convertor');
 
 const stdlog = console.log;
 const MODULE_NAME = 'ts-node-client:cli';
@@ -47,6 +49,22 @@ function scan(options, scanDone) {
             return undefined;
         }
         return scanResult;
+    }).then((scanResult) => {
+        if (options.saveAs) {
+            const date = new Date();
+            let printData = JSON.stringify(scanResult, 0, 2);
+            let printExt = 'scan';
+            if (options.saveAsFormat) {
+                const allowedTypes = ['scan', 'spdx', 'cydx'];
+                if (allowedTypes.indexOf(options.saveAsFormat) > 0) {
+                    printData = JSON.stringify(Convertor.scanTo(options.saveAsFormat, scanResult), 0, 2);
+                    printExt = options.saveAsFormat;
+                }
+            }
+            const formatedDate = date.toISOString().substr(0, 19).split(':').join('-').split('T').join('-');
+            fs.writeFileSync(`${options.saveAs || 'ts-scan'}-${formatedDate}-${options.saveAsFormat ? printExt : 'scan'}.json`, printData);
+        }
+        return scanResult;
     }).then((scanResult) => {
         if (scanResult) {
             return npmScanner.transfer(scanResult);

package/lib/convertor.js

@@ -0,0 +1,244 @@
+/* eslint-disable */
+/**********************************************************
+ * Copyright (c) 2017. Enterprise Architecture Group, EACG
+ *
+ * SPDX-License-Identifier:  Apache-2.0
+ *********************************************************/
+/* eslint-enable */
+const PackageURL = require('./pkg');
+
+const Convertor = {};
+
+Convertor.scanTo = function scanTo(type, scan) {
+    if (type.toLowerCase() === 'cydx') {
+        return Convertor.scanToCydx(scan);
+    }
+    if (type.toLowerCase() === 'spdx') {
+        return Convertor.scanToSpdx(scan);
+    }
+    return scan;
+};
+
+function ComponentKey(key, parts) {
+    if (!key || typeof key.split !== 'function') {
+    // throw new Error('key must be a string');
+    } else {
+        parts = parts || { mgr: true, component: true, version: true };
+
+        const partsCnt = (parts.mgr ? 1 : 0) + (parts.component ? 1 : 0) + (parts.version ? 1 : 0);
+        const splitParts = key.split(':');
+        // component may exists of more than one part
+        if ((parts.component && splitParts.length < partsCnt) || (!parts.component && splitParts.length !== partsCnt)) {
+            // throw new Error('invalid key format:' + key);
+        } else {
+            let compStartIdx = 0; let
+                compEndIdx = splitParts.length;
+            if (parts.mgr) {
+                // eslint-disable-next-line prefer-destructuring
+                this.manager = splitParts[0];
+                // eslint-disable-next-line no-plusplus
+                compStartIdx++;
+            }
+            if (parts.version) {
+                this.version = splitParts[splitParts.length - 1];
+                // eslint-disable-next-line no-plusplus
+                compEndIdx--;
+            }
+            if (parts.component) {
+                this.component = '';
+                // eslint-disable-next-line no-plusplus
+                for (let i = compStartIdx; i < compEndIdx; i++) {
+                    if (this.component) {
+                        this.component += ':';
+                    }
+                    this.component += splitParts[i];
+                }
+            }
+        }
+    }
+}
+
+function getPackageUrl(componentKey, version) {
+    const result = new ComponentKey(componentKey, { mgr: true, component: true });
+    if (result && result.component && result.manager !== 'im') {
+        const parts = result.component.split(':');
+        const org = parts.length > 1 ? parts[0] : null;
+        const key = parts.length > 1 ? parts[1] : parts[0];
+        if (key) {
+            return PackageURL.get(result.manager, org, key, version);
+        }
+        return null;
+    }
+    return null;
+}
+
+function getSpdxFormattedKey(componentKey) {
+    return componentKey.split(':').join('-');
+}
+
+function dependencyToCydxComponent(dependency) {
+    const {
+        name, key, description, homepageUrl, repoUrl, licenses, versions
+    } = dependency;
+    const version = versions && versions[0];
+    const purl = getPackageUrl(key, version);
+    const comp = {
+        type: 'library',
+        'bom-ref': purl,
+        name,
+        version,
+        description,
+        purl,
+        externalReferences: []
+    };
+    if (licenses && licenses[0] && licenses[0].name) {
+        comp.licenses = [
+            {
+                license: {
+                    id: licenses[0].name
+                }
+            }
+        ];
+    }
+    if (repoUrl) {
+        comp.externalReferences.push({
+            type: 'vcs',
+            url: repoUrl
+        });
+    }
+    if (homepageUrl) {
+        comp.externalReferences.push({
+            type: 'website',
+            url: homepageUrl
+        });
+    }
+    return comp;
+}
+
+function dependencyToSpdxComponent(dependency) {
+    const {
+        name, key, homepageUrl, repoUrl, licenses, versions
+    } = dependency;
+    const version = versions && versions[0];
+    const comp = {
+        SPDXID: `SPDXRef-${getSpdxFormattedKey(key)}`,
+        // TODO implement Copyright meta
+        copyrightText: '',
+        filesAnalyzed: false,
+        name,
+        versionInfo: version
+    };
+    if (licenses && licenses[0] && licenses[0].name) {
+        comp.licenseConcluded = licenses[0].name;
+        comp.licenseDeclared = licenses[0].name;
+        comp.licenseInfoFromFiles = [licenses[0].name];
+    }
+    if (repoUrl) {
+        comp.downloadLocation = repoUrl;
+    }
+    if (homepageUrl) {
+        comp.homepage = homepageUrl;
+    }
+    return comp;
+}
+
+function handleDependency(list, dependency, type, relationships, parent) {
+    let component;
+    if (type === 'cydx') {
+        component = dependencyToCydxComponent(dependency);
+    } else if (type === 'spdx') {
+        component = dependencyToSpdxComponent(dependency);
+    } else {
+        component = dependency;
+    }
+    if (component) {
+        const hasComponent = list.find((item) => (item.SPDXID && item.SPDXID === component.SPDXID)
+          || (item['bom-ref'] && item['bom-ref'] === component['bom-ref']));
+        if (!hasComponent) {
+            list.push(component);
+        }
+    }
+    if (relationships && parent) {
+        if (parent.creationInfo) {
+            relationships.push({
+                spdxElementId: parent.SPDXID,
+                relatedSpdxElement: component.SPDXID,
+                relationshipType: 'DESCRIBES'
+            });
+        }
+        relationships.push({
+            spdxElementId: parent.SPDXID,
+            relatedSpdxElement: component.SPDXID,
+            relationshipType: 'CONTAINS'
+        });
+    }
+    if (dependency.dependencies) {
+        dependency.dependencies.forEach((child) => {
+            handleDependency(list, child, type, relationships, component);
+        });
+    }
+}
+
+Convertor.scanToCydx = function scanTo(scan) {
+    const date = new Date();
+    const cydx = {
+        bomFormat: 'CycloneDX',
+        specVersion: '1.3',
+        serialNumber: 'urn:uuid:ea788421-7eb0-448b-833e-b32dd0f39d0c',
+        version: 1,
+        metadata: {
+            timestamp: date.toISOString(),
+            tools: [
+                {
+                    vendor: 'CycloneDX',
+                    name: 'Node.js module',
+                    version: '3.6.0'
+                }
+            ]
+        },
+        components: []
+    };
+    if (scan.dependencies && scan.dependencies[0]) {
+        cydx.components = [];
+        handleDependency(cydx.components, scan.dependencies[0], 'cydx');
+        if (cydx.components.length > 0) {
+            // eslint-disable-next-line prefer-destructuring
+            cydx.metadata.component = cydx.components[0];
+            cydx.components.shift();
+        }
+    }
+    return cydx;
+};
+
+Convertor.scanToSpdx = function scanTo(scan) {
+    const date = new Date();
+    const spdx = {
+        SPDXID: 'SPDXRef-DOCUMENT',
+        spdxVersion: 'SPDX-2.0',
+        creationInfo: {
+            created: date.toISOString(),
+            creators: [
+                'Tool: ts-node-client > 1.8.1',
+                'Organization: TrustSource'
+            ],
+            licenseListVersion: '2.5'
+        },
+        dataLicense: 'CC0-1.0'
+    };
+    if (scan.dependencies && scan.dependencies[0]) {
+        spdx.packages = [];
+        spdx.relationships = [];
+        handleDependency(spdx.packages, scan.dependencies[0], 'spdx', spdx.relationships, spdx);
+        if (spdx.packages.length > 0) {
+            const first = spdx.packages[0];
+            spdx.name = first.name;
+            spdx.documentDescribes = [first.SPDXID];
+            spdx.documentNamespace = `https://app.trustsource.io/spdx/${spdx.name}`;
+        }
+    }
+    return spdx;
+};
+
+
+module.exports = Convertor;
+

package/lib/dependency.js

@@ -2,7 +2,7 @@
 /**********************************************************
  * Copyright (c) 2017. Enterprise Architecture Group, EACG
  *
- * SPDX-License-Identifier:	Apache-2.0
+ * SPDX-License-Identifier:  Apache-2.0
  *********************************************************/
 /* eslint-enable */
 
@@ -21,7 +21,9 @@ function Dependency(name, version, keyPrefix, description, priv, licenses, homep
     this.dependencies = [];
 
     Object.defineProperty(this, 'versions', {
-        get() { return versions.sort(compare); },
+        get() {
+            return versions.sort(compare);
+        },
         enumerable: true
     });
 

package/lib/pkg.js

@@ -0,0 +1,32 @@
+/* eslint-disable */
+/**********************************************************
+ * Copyright (c) 2022. Enterprise Architecture Group, EACG
+ *
+ * SPDX-License-Identifier:  Apache-2.0
+ *********************************************************/
+/* eslint-enable */
+
+const PackageURL = {};
+
+PackageURL.get = function get(manager, org, key, version) {
+    // scheme:type/namespace/name@version?qualifiers#subpath
+    const parts = [];
+    let partVersion;
+    if (manager) {
+        parts.push(encodeURI(manager));
+    }
+    if (org) {
+        parts.push(encodeURI(org).replace('%3A', ':'));
+    }
+    if (key) {
+        parts.push(encodeURI(key).replace('%3A', ':'));
+    }
+    if (version) {
+        partVersion = `@${encodeURI(version).replace('%3A', ':')}`;
+    }
+    return `pkg:${parts.join('/')}${partVersion}`;
+};
+
+
+module.exports = PackageURL;
+

package/lib/rest-client.js

@@ -5,8 +5,7 @@
  * SPDX-License-Identifier:	Apache-2.0
  *********************************************************/
 /* eslint-enable */
-
-const request = require('request');
+const axios = require('axios').default;
 const debuglog = (require('debuglog'))('ts-rest-client');
 const pckgJson = require('../package.json');
 
@@ -21,7 +20,7 @@ function RestClient(options) {
 }
 
 function checkWarnings(options) {
-    return options.brakeOnWarnings;
+    return options.breakOnWarnings;
 }
 
 function hasWarnings(analysis) {
@@ -30,7 +29,7 @@ function hasWarnings(analysis) {
 }
 
 function checkViolations(options) {
-    return options.brakeOnViolations;
+    return options.breakOnViolations;
 }
 
 function hasViolations(analysis) {
@@ -38,45 +37,42 @@ function hasViolations(analysis) {
     return stats ? stats.legal.violations + stats.vulnerability.violations + stats.viability.violations + stats.versioning.violations : 0;
 }
 
-function checkAnalysisResults(options, getReqOpts, cb, error, response, body, i) {
-    request(getReqOpts, (getError, getResponse, getBody) => {
-        if (!getError && getResponse && getResponse.statusCode === 200 && getBody.analysisStatus === 'Finished') {
-            if (checkViolations(options) && hasViolations(getBody)) {
-                throw new Error(`Analysis found ${hasViolations(getBody)} violations, see more details: ${getBody.url}`);
-            }
-            if (checkWarnings(options) && hasWarnings(getBody)) {
-                throw new Error(`Analysis found ${hasWarnings(getBody)} warnings, see more details: ${getBody.url}`);
-            }
-            // eslint-disable-next-line no-underscore-dangle
-            getBody.scanId = getBody._id;
-            cb(null, getBody);
-        } else if (!getError && getResponse && (getResponse.statusCode === 200 || getResponse.statusCode === 404)) {
-            const retryPeriod = i * 5000;
-            console.log('Analysis is', (getBody.analysisStatus || 'Scheduled'), 'Retry in ', retryPeriod / 1000, 'sec');
-            setTimeout(() => {
-                i += 1;
-                checkAnalysisResults(options, getReqOpts, cb, error, response, body, i);
-            }, retryPeriod);
-        } else {
-            debuglog('unexpected getResponse: error=', getError, 'response=', getResponse);
-            const result = {
-                message: 'unexpected getResponse'
-            };
-            if (getError) {
-                result.error = getError;
-            }
-            if (getResponse && getResponse.statusCode) {
-                result.code = getResponse.statusCode;
-            }
-            if (getBody) {
-                result.body = getBody;
+function checkAnalysisResults(options, getReqOpts, cb, i) {
+    axios(getReqOpts)
+        .then((response) => {
+            const scanData = response && response.data;
+            if (response && response.status === 200 && scanData && scanData.analysisStatus === 'Finished') {
+                if (checkViolations(options) && hasViolations(scanData)) {
+                    cb(`Analysis found ${hasViolations(scanData)} violations, see more details: ${response.data.url}`);
+                }
+                if (checkWarnings(options) && hasWarnings(scanData)) {
+                    cb(`Analysis found ${hasWarnings(scanData)} warnings, see more details: ${response.data.url}`);
+                }
+                // eslint-disable-next-line no-underscore-dangle
+                cb(null, { scanId: scanData._id });
+            } else {
+                const retryPeriod = i * 5000;
+                console.log('Analysis is', ((scanData && scanData.analysisStatus) || 'Scheduled'), 'Retry in ', retryPeriod / 1000, 'sec');
+                setTimeout(() => {
+                    i += 1;
+                    checkAnalysisResults(options, getReqOpts, cb, i);
+                }, retryPeriod);
             }
-            if (!result.code && !getError.error) {
-                result.response = JSON.stringify(getResponse);
+        })
+        .catch((error) => {
+            const errorData = error && typeof error.toJSON === 'function' ? error.toJSON() : false;
+            if (errorData && (errorData.status === 404)) {
+                const retryPeriod = i * 5000;
+                console.log('Analysis is Scheduled', 'Retry in ', retryPeriod / 1000, 'sec');
+                setTimeout(() => {
+                    i += 1;
+                    checkAnalysisResults(options, getReqOpts, cb, i);
+                }, retryPeriod);
+            } else {
+                debuglog('unexpected getResponse: error=', error);
+                cb(JSON.stringify(error));
             }
-            cb(result);
-        }
-    });
+        });
 }
 
 exports.RestClient = RestClient;
@@ -86,8 +82,8 @@ RestClient.prototype.transfer = function transfer(scan, cb) {
     debuglog('transfer started, options:', options);
 
     const reqOpts = options.requestOptions || {};
-    reqOpts.method = 'POST';
-    reqOpts.uri = `${options.url}/api/v1/scans`;
+    reqOpts.method = 'post';
+    reqOpts.url = `${options.url}/api/v1/scans`;
     if (options.proxy) {
         reqOpts.proxy = options.proxy;
     }
@@ -97,12 +93,12 @@ RestClient.prototype.transfer = function transfer(scan, cb) {
         'X-ApiKey': options.apiKey
     };
     reqOpts.json = true;
-    reqOpts.body = scan;
+    reqOpts.data = scan;
     if (options.branch) {
-        reqOpts.body.branch = options.branch;
+        reqOpts.data.branch = options.branch;
     }
     if (options.tag) {
-        reqOpts.body.tag = options.tag;
+        reqOpts.data.tag = options.tag;
     }
     if (options.binaryLinks) {
         let links = options.binaryLinks.split(',');
@@ -110,40 +106,24 @@ RestClient.prototype.transfer = function transfer(scan, cb) {
             links = links.map((value) => ({
                 name: value
             }));
-            reqOpts.body.binaryLinks = links;
+            reqOpts.data.binaryLinks = links;
         }
     }
-
-    request(reqOpts, (error, response, body) => {
-        if (!error && response && response.statusCode === 201) {
-            if (options.brakeOnWarnings || options.brakeOnViolations) {
+    return axios(reqOpts)
+        .then((response) => {
+            if (options.breakOnWarnings || options.breakOnViolations) {
                 const getReqOpts = reqOpts;
-                getReqOpts.method = 'GET';
-                getReqOpts.uri += `/${body.scanId}`;
-                delete getReqOpts.body;
+                getReqOpts.method = 'get';
+                getReqOpts.url += `/${response.data.scanId}`;
+                delete getReqOpts.data;
                 let i = 1; // eslint-disable-line prefer-const
-                checkAnalysisResults(options, getReqOpts, cb, error, response, body, i);
+                checkAnalysisResults(options, getReqOpts, cb, i);
             } else {
-                cb(null, body);
-            }
-        } else {
-            debuglog('unexpected response: error=', error, 'response=', response);
-            const result = {
-                message: 'unexpected response'
-            };
-            if (error) {
-                result.error = error;
-            }
-            if (response && response.statusCode) {
-                result.code = response.statusCode;
+                cb(null, response.data);
             }
-            if (body) {
-                result.body = body;
-            }
-            if (!result.code && !error.error) {
-                result.response = JSON.stringify(response);
-            }
-            cb(result);
-        }
-    });
+        })
+        .catch((error) => {
+            debuglog('unexpected response: error=', error);
+            cb(JSON.stringify(error));
+        });
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ts-node-client",
   "description": "npm / node module to transfer dependency information to TrustSource server.",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "private": false,
   "homepage": "https://app.trustsource.io/",
   "author": {
@@ -22,28 +22,27 @@
   },
   "scripts": {
     "scan": "node ./bin/ts-node-client.js",
-    "scan-with-brakes": "ts-node-client --brakeOnViolations true --brakeOnWarnings true",
-    "scan-prod": "ts-node-client --debug",
+    "scan-with-brakes": "node ./bin/ts-node-client.js --breakOnViolations true --breakOnWarnings false",
+    "scan-to-file": "node ./bin/ts-node-client.js --saveAs test --saveAsFormat cydx",
     "lint": "eslint bin lib test",
     "lint-fix": "eslint bin lib test --fix",
     "test": "mocha test",
     "precommit": "npm run lint && npm run test"
   },
   "dependencies": {
-    "debuglog": "^1.0.1",
-    "npm": "6.14.15",
-    "request": "^2.88.2",
-    "semver": "^7.3.4",
-    "yargs": "^15.4.1"
+    "npm": "6.14.17",
+    "axios": "0.26.1",
+    "debuglog": "1.0.1",
+    "semver": "7.3.5",
+    "yargs": "^17.5.0"
   },
   "devDependencies": {
     "eslint": "^7.32.0",
     "eslint-config-airbnb-base": "^14.2.1",
     "eslint-plugin-import": "^2.25.2",
     "eslint-plugin-sonarjs": "^0.10.0",
-    "mocha": "^9.1.3",
-    "nock": "^12.0.3",
-    "ts-node-client": "1.5.2"
+    "mocha": "^9.2.2",
+    "nock": "^12.0.3"
   },
   "keywords": [
     "node",
@@ -51,6 +50,8 @@
     "meteor",
     "plugin",
     "opensource",
+    "cydx",
+    "spdx",
     "dependency-analysis"
   ]
 }

package/test/error-test.js

@@ -9,7 +9,7 @@
 
 
 const assert = require('assert');
-const util = require('util');
+const util = require('util');
 
 const SHOULD_CONTAIN = 'should contain \'name\' and \'message\' fields';
 

package/test/rest-test.js

@@ -9,7 +9,7 @@
 
 const assert = require('assert');
 const nock = require('nock');
-const { RestClient } = require('../lib/rest-client');
+const { RestClient } = require('../lib/rest-client');
 
 const JSON_TYPE = 'application/json';
 const url = 'http://localhost:3000';
@@ -39,10 +39,10 @@ describe('RestClient', () => {
         let restClient;
 
         beforeEach(() => {
-            restClient = new RestClient({ url: 'http://localhost:3000' });
+            restClient = new RestClient({ url: 'http://localhost:3000', apiKey: 'test' });
         });
 
-        it('should call callback with response data if no error orccurs', (done) => {
+        it('should call callback with response data if no error occurs', (done) => {
             nock(url, {
                 reqheaders: {
                     'Content-Type': JSON_TYPE