code-client

Typescript consumer of the Snyk Code public APi


This package is published using:

Installation

``shell script
$ npm install --save @snyk/code-client
`

Usage

$3

`javascript
import codeClient from '@snyk/code-client';

// An address of server which will be used in order to send code and analyse it.
const baseURL = 'https://www.snyk.io';
`

$3

`javascript
const loginResponse = await codeClient.startSession({
baseURL,
// An identificator for the editor using the Snyk APIs
source: 'atom',
});

if (loginResponse.type === 'error') {
// Handle error and alert user
}

const { sessionToken, loginURL } = loginResponse.value;
`

$3

`javascript
const sessionResponse = await codeClient.checkSession({ baseURL, sessionToken });
if (sessionResponse.type === 'error') {
// Handle error and alert user
}

const isLoggedIn = sessionResponse.value; // boolean
`

$3

`javascript
/* Building bundle process started with provided data /
codeClient.emitter.on('scanFilesProgress', (processed: number) => {
console.log(Indexed ${processed} files);
});

/* Bundle upload process is started with provided data /
codeClient.emitter.on('uploadBundleProgress', (processed: number, total: number) => {
console.log(Upload bundle progress: ${processed}/${total});
});

/* Receives an error object and logs an error message /
codeClient.emitter.on('sendError', error => {
console.log(error);
});

/ Logs HTTP requests sent to the API /
codeClient.emitter.on('apiRequestLog', message => {
console.log(message);
});
`

Complete list of events:

- supportedFilesLoaded: uploading supported file extensions, can be also used for instantiating file watcher
- scanFilesProgress: emits a number of files being found
- createBundleProgress: emits a progress in instantiating packages for analysis
- uploadBundleProgress: emits a progress in uploading files
- analyseProgress: emits a progress in analysis job
- error: emits in case of an error

$3

`javascript
const results = await codeClient.analyzeFolders({
connection: { baseURL, sessionToken, source },
analysisOptions: {
severity: 1,
},
fileOptions: {
paths: ['/home/user/repo'],
symlinksEnabled: false,
},
});
`

$3

`javascript
const results = await codeClient.analyzeFolders({
connection: { baseURL, sessionToken, source },
analysisOptions: {
severity: 1,
limitToFiles: ['recently-changed-file.js'],
},
fileOptions: {
paths: ['/home/user/repo'],
symlinksEnabled: false,
},
});
`

$3

`javascript
const results = await codeClient.analyzeFolders({
connection: { baseURL, sessionToken, source },
analysisOptions: {
severity: 1,
},
fileOptions: {
paths: ['/home/user/repo'],
symlinksEnabled: false,
},
reportOptions: {
enabled: true,
projectName: 'example-project',
},
});
`

$3

`javascript
const results = await codeClient.extendAnalysis({
...previousAnalysisResults,
files: {
'/home/user/repo/main.js',
'/home/user/repo/app.js',
},
});

`

$3

`javascript
const results = await codeClient.analyzeScmProject({
connection: { baseURL, sessionToken, source },
analysisOptions: {
severity: 1,
},
reportOptions: {
projectId: '',
commitId: '',
},
});
`

$3

If there are any errors the result of every call will contain the following:

`javascript
const { error, statusCode, statusText } = result;
`

CLI

There is a way to run separate calls using a CLI

$3

Help manifest: time npm run cli -- help bundle:create

`
Usage: CLI bundle:create [options]

create a new bundle and return its ID with meta info

Options:
--patterns [string...] supported file patterns
--ignore [path...] ignored path glob
--path [path...] source code dir
--url service URL
--token user token
--org organization
--source source identifier (default: "code-client")
-H, --headers [string...] custom headers e.g. "X-Custom-Header: some value". Can have multiple values diveded by space
--debug enable debug mode
-h, --help display help for command
`

Example call:

`bash
npm run cli -- bundle:create --url="" --token="" --headers="" --patterns=".*" --path=""
``