@xeops/scanner-sdk

XeOps Security Scanner SDK for CI/CD integration and programmatic access.

Installation

npm install @xeops/scanner-sdk

Usage

Basic Example

import { XeOpsScannerClient } from '@xeops/scanner-sdk';

const client = new XeOpsScannerClient({
  apiEndpoint: 'https://xeops-scanner-97758009309.europe-west1.run.app',
  apiKey: 'your-api-key'
});

// Start a scan
const scan = await client.startScan({
  targetUrl: 'https://example.com'
});

console.log('Scan ID:', scan.scanId);

// Wait for completion
const result = await client.waitForScanCompletion(scan.scanId, {
  onProgress: (result) => {
    console.log(`Progress: ${result.progress}%`);
  }
});

console.log('Vulnerabilities found:', result.vulnerabilitiesFound);

CI/CD Integration

import { XeOpsScannerClient } from '@xeops/scanner-sdk';
import * as fs from 'fs';

const client = new XeOpsScannerClient({
  apiEndpoint: process.env.XEOPS_API_ENDPOINT!,
  apiKey: process.env.XEOPS_API_KEY!
});

async function securityScan() {
  // Start scan
  const scan = await client.startScan({
    targetUrl: 'https://staging.example.com'
  });

  // Wait for completion with timeout
  const result = await client.waitForScanCompletion(scan.scanId, {
    timeout: 1800000, // 30 minutes
    onProgress: (r) => console.log(`${r.progress}%`)
  });

  // Download PDF report
  const pdf = await client.downloadPdfReport(scan.scanId, true);
  fs.writeFileSync('security-report.pdf', pdf);

  // Fail build if critical/high vulnerabilities found
  const critical = result.metadata?.criticalCount || 0;
  const high = result.metadata?.highCount || 0;

  if (critical > 0 || high > 0) {
    console.error(`Found ${critical} critical and ${high} high vulnerabilities`);
    process.exit(1);
  }
}

securityScan().catch(console.error);

API Reference

XeOpsScannerClient

Constructor

new XeOpsScannerClient(config: ScannerSDKConfig)

Config options:

• apiEndpoint: XeOps API endpoint URL
• apiKey: Your API key
• timeout?: Request timeout in ms (default: 60000)
• maxRetries?: Max retry attempts (default: 3)
• retryDelay?: Delay between retries in ms (default: 1000)
• debug?: Enable debug logging (default: false)

Methods

startScan(request: ScanRequest): Promise

Start a new security scan.

getScanResult(scanId: string): Promise

Get the current status and results of a scan.

waitForScanCompletion(scanId: string, options?: WaitForScanOptions): Promise

Wait for a scan to complete with polling.

Options:

• pollingInterval?: Polling interval in ms (default: 5000)
• timeout?: Maximum wait time in ms (default: 1800000)
• onProgress?: Callback for progress updates

downloadPdfReport(scanId: string, validatePoc?: boolean): Promise

Download PDF report for a completed scan.

getUsage(): Promise

Get usage statistics for your account.

verifyApiKey(): Promise

Verify if the API key is valid.

cancelScan(scanId: string): Promise

Cancel a running scan.

listScans(params?: ListScansParams): Promise<ScanResult[]>

List scans for your account.

License

MIT