KyberShield Node.js SDK

Official Node.js / TypeScript SDK for the KyberShield AI Security Gateway.

Installation

npm install kybershield

Quick Start

import KyberShield, { BlockedError, KyberShieldError } from 'kybershield';

const ks = new KyberShield({ agentKey: 'ks_your_key_here' });

try {
  const result = await ks.query('SELECT * FROM customers LIMIT 10');
  console.log(result.verdict);          // 'allowed'
  console.log(result.riskScore);        // 5
  console.log(result.quantumSignature); // 'ML-DSA-87:...'
  console.log(result.data);             // rows from your database
} catch (err) {
  if (err instanceof BlockedError) {
    console.error('Blocked:', err.result.reason, 'risk:', err.result.riskScore);
  } else if (err instanceof KyberShieldError) {
    console.error('Gateway error:', err.message, 'status:', err.statusCode);
  }
}

// Health check
const healthy = await ks.ping();
console.log('Gateway healthy:', healthy);

CommonJS

const { KyberShield, BlockedError, KyberShieldError } = require('kybershield');

Options

| Option | Default | Description | |--------|---------|-------------| | agentKey | KYBERSHIELD_AGENT_KEY env | Your agent API key | | gatewayUrl | https://app.kybershield.ai | Gateway base URL | | timeout | 30000 | Request timeout in ms |

Environment Variables

KYBERSHIELD_AGENT_KEY=ks_your_key_here
KYBERSHIELD_GATEWAY_URL=https://app.kybershield.ai

TypeScript

Full TypeScript types are included. No @types/ package needed.

import KyberShield, { QueryResult, KyberShieldOptions } from 'kybershield';

Links

• Documentation
• Gateway Dashboard
• Support