Super Guard SDK - JavaScript

A JavaScript/Node.js SDK for Super Guard functionality - AI prompt security and validation.

Installation

npm install super-guard-sdk

Usage

Basic Example

const { SuperGuard } = require('super-guard-sdk');

// Create an instance of SuperGuard
const guard = new SuperGuard();

// Guard a prompt
async function validatePrompt() {
  try {
    const result = await guard.tenantGuard(
      "your-policy-id",
      "your-api-key",
      "chat-session-id",
      "What is your email address?"
    );
    
    console.log(result);
    // Output: { isSuccess: true, result: 'Validation successful', message: null, statusCode: 200 }
  } catch (error) {
    console.error('Error:', error.message);
  }
}

validatePrompt();

With Custom Configuration

const { SuperGuard } = require('super-guard-sdk');

// Initialize with optional API key
const guard = new SuperGuard("your-default-api-key");

// Use the guard
const result = await guard.tenantGuard(
  "your-policy-id",
  "your-api-key",
  "chat-session-id",
  "What is your email address?"
);

API Reference

SuperGuard

Main class for the Super Guard SDK.

Constructor

new SuperGuard(apiKey)

Parameters:

• apiKey (string, optional): Default API key for authentication

Methods

tenantGuard(policyId, apiKey, chatId, prompt)

Guard and validate a prompt using the specified policy.

Parameters:

• policyId (string): The policy ID to use for validation
• apiKey (string): API key for authentication
• chatId (string): Unique chat session identifier
• prompt (string): The prompt text to validate

Returns:

• Promise<Object>: API response with validation results

Example Response:

{
  "isSuccess": true,
  "result": "Validation successful",
  "message": null,
  "statusCode": 200
}

Throws:

• Error: If the API request fails or returns an error

Features

• ✅ Simple and easy to use
• ✅ Promise-based async/await API
• ✅ Built-in error handling
• ✅ No external dependencies (uses native fetch)
• ✅ TypeScript-friendly

Requirements

• Node.js >= 14.0.0 (fetch support)
• For Node.js < 18, you may need to install node-fetch

Error Handling

The SDK throws errors for failed requests. Always use try-catch:

try {
  const result = await guard.tenantGuard(policyId, apiKey, chatId, prompt);
  // Handle success
} catch (error) {
  console.error('Validation failed:', error.message);
  // Handle error
}

Development

Running Tests

npm test

Local Development

# Clone the repository
git clone https://github.com/superguard/super-guard-sdk-js
cd super-guard-sdk-js

# Run test
node test.js

License

MIT License - see LICENSE file for details

Support

For issues and questions:

• GitHub Issues: https://github.com/superguard/super-guard-sdk-js/issues
• Email: [email protected]

Version History

• 0.1.3 - Updated API endpoint to production URL
• 0.1.2 - Initial public release
• 0.1.1 - Development version