WebAV SDK for JavaScript / TypeScript

Features

Scan user uploaded files for viruses using the WebTender WebAV API. Improve the security of your application by scanning files for viruses before they are served to your users.

• Scan files by URL
• Scan files by uploading
• Query file status
• Get recently scanned files

TypeScript support!

Asynchronous Scanning

Compatible with light weight Node.js servers with limited memory.

This package simply implements the WebAV REST API, making it very light weight and easy to get scanning today.

Learn more here: WebAV API Docs

Installation

Pick your poison:

npm install --save @webtender/webav-sdk-js

pnpm install @webtender/webav-sdk-js

yarn add @webtender/webav-sdk-js

bun add @webtender/webav-sdk-js

Get your API Key

You can get your API key from the WebTender Console

View pricing here

Usage

The client will automatically look for a process.env variables to get the API key and secret.

You can place these in a .env and use the dotenv package.

WEBTENDER_API_KEY=your-api-key
WEBTENDER_API_SECRET=your-api-secret

Simply construct with no arguments to use the environment variables.

import WebAV from '@webtender/webav-sdk-js';
import dotenv from 'dotenv';

// Load .env
dotenv.config();

const av = new WebAV();

Alternatively use the constructor to pass the API key and secret. No need for dotenv in this case.

import WebAV from '@webtender/webav-sdk-js';

const av = new WebAV('your-api-key', 'your-api-secret');

const av = new WebAV();

// You can scan by a public URL, or a signed S3 url.
const queuedFile = await av.scanByUrl("https://link.testfile.org/15MB");

// Or via upload (limited to 100MB)
const fileName = "testfile.txt";
const fileStream = fs.createReadStream(fileName);
const queuedFile = await av.scanByUpload(fileStream, fileName);

You can subscribe to a webhook via the WebTender Console to get notified when the file is ready.

Or after some time you can query the status of the file

const fileStatus = await av.getStatus(queuedFile.id);

// Or await the result, this may take several minutes for large files
const scanResult = await av.waitFor(queuedFile.id);
console.log(scanResult.virus_status_label); // Hopefully => "Passed"

// Get recently scanned files
const paginatedFiles = await av.getRecentStatuses();
for (const fileStatus of paginatedFiles.data) {
  console.log(
    fileStatus.id,
    fileStatus.virus_status_label,
    fileStatus.virus_status
  );
}

Security Notice

This package is intended to be used on your server, DO NOT provide your API key to end-users!