promptdefend 1.0.0

package/LICENSE

@@ -0,0 +1,36 @@
+PROMPT DEFEND SDK - PROPRIETARY SOFTWARE LICENSE
+
+Copyright © 2026 Prompt Defend. All Rights Reserved.
+
+This SDK is provided to enable integration with the Prompt Defend API service.
+Use of this SDK is subject to the Prompt Defend Terms of Service.
+
+1. LICENSE GRANT
+
+You are granted a limited, non-exclusive, non-transferable license to use this 
+SDK solely for the purpose of integrating with Prompt Defend's API services 
+under an active subscription.
+
+2. RESTRICTIONS
+
+You may NOT:
+- Modify, adapt, or create derivative works of this SDK
+- Reverse engineer, decompile, or disassemble this SDK
+- Redistribute this SDK outside of your organization
+- Use this SDK to build competing products or services
+- Remove or alter any proprietary notices
+
+3. NO WARRANTY
+
+THIS SDK IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. PROMPT DEFEND 
+DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED.
+
+4. LIMITATION OF LIABILITY
+
+PROMPT DEFEND SHALL NOT BE LIABLE FOR ANY DAMAGES ARISING FROM THE USE OF 
+THIS SDK.
+
+---
+
+For support: support@promptdefend.dev
+Website: https://promptdefend.dev

package/README.md

@@ -0,0 +1,174 @@
+# Prompt Defend Node.js SDK
+
+[![npm version](https://badge.fury.io/js/promptdefend.svg)](https://badge.fury.io/js/promptdefend)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen)](https://nodejs.org)
+
+The official Node.js SDK for the [Prompt Defend](https://promptdefend.dev) AI Security API. Protect your AI applications with our 16-layer guardrail system.
+
+## Installation
+
+```bash
+npm install promptdefend
+```
+
+Or with yarn:
+
+```bash
+yarn add promptdefend
+```
+
+## Quick Start
+
+```javascript
+const { PromptDefend } = require('promptdefend');
+
+// Initialize the client with your API key
+const client = new PromptDefend({ apiKey: 'your-api-key' });
+
+// Scan a prompt for security issues
+const result = await client.scan('What is the weather today?');
+
+if (result.safe) {
+    console.log('✅ Prompt is safe to process');
+} else {
+    console.log(`⚠️ Warning: ${result.reason}`);
+}
+```
+
+## Features
+
+- 🛡️ **16-Layer Protection** - Comprehensive guardrail system
+- 🔒 **Prompt Injection Detection** - Block jailbreak and injection attempts
+- ⚡ **Sub-millisecond Latency** - Average response time ~0.7ms
+- 📦 **TypeScript Support** - Full type definitions included
+- 🔧 **Error Handling** - Comprehensive error classes
+- 🌐 **ESM & CommonJS** - Works with both module systems
+
+## Usage
+
+### ESM (ES Modules)
+
+```javascript
+import { PromptDefend } from 'promptdefend';
+
+const client = new PromptDefend({ apiKey: 'your-api-key' });
+const result = await client.scan('Hello, how are you?');
+```
+
+### CommonJS
+
+```javascript
+const { PromptDefend } = require('promptdefend');
+
+const client = new PromptDefend({ apiKey: 'your-api-key' });
+const result = await client.scan('Hello, how are you?');
+```
+
+### TypeScript
+
+```typescript
+import { PromptDefend, ScanResult, PromptDefendOptions } from 'promptdefend';
+
+const options: PromptDefendOptions = {
+    apiKey: 'your-api-key',
+    baseUrl: 'https://api.promptdefend.dev'
+};
+
+const client = new PromptDefend(options);
+const result: ScanResult = await client.scan('Test prompt');
+
+console.log(result.safe);    // boolean
+console.log(result.reason);  // string
+console.log(result.details); // object
+```
+
+### Custom Configuration
+
+```javascript
+const { PromptDefend } = require('promptdefend');
+
+const client = new PromptDefend({
+    apiKey: 'your-api-key',
+    baseUrl: 'https://api.promptdefend.dev',  // Optional custom endpoint
+    timeout: 60000  // Custom timeout in milliseconds
+});
+```
+
+## Error Handling
+
+The SDK provides specific error classes for different error types:
+
+```javascript
+const { 
+    PromptDefend, 
+    PromptDefendError,
+    AuthenticationError,
+    NetworkError,
+    APIError 
+} = require('promptdefend');
+
+const client = new PromptDefend({ apiKey: 'your-api-key' });
+
+try {
+    const result = await client.scan('Test prompt');
+} catch (error) {
+    if (error instanceof AuthenticationError) {
+        console.error(`Invalid API key: ${error.message}`);
+    } else if (error instanceof NetworkError) {
+        console.error(`Network issue: ${error.message}`);
+    } else if (error instanceof APIError) {
+        console.error(`API error (status ${error.statusCode}): ${error.message}`);
+    } else if (error instanceof PromptDefendError) {
+        console.error(`General error: ${error.message}`);
+    }
+}
+```
+
+## Response Object
+
+The `scan()` method returns a `ScanResult` object with the following properties:
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `safe` | `boolean` | Whether the prompt is safe to process |
+| `reason` | `string` | Explanation of the safety assessment |
+| `details` | `object` | Full detection details from all 16 layers |
+| `fastPath` | `boolean` | Whether allowlist short-circuit was used |
+
+## API Reference
+
+### PromptDefend Class
+
+#### Constructor Options
+
+```typescript
+interface PromptDefendOptions {
+    apiKey: string;      // Required: Your API key
+    baseUrl?: string;    // Optional: Custom API base URL
+    timeout?: number;    // Optional: Request timeout in milliseconds (default: 30000)
+}
+```
+
+#### Methods
+
+| Method | Description |
+|--------|-------------|
+| `scan(promptText: string): Promise<ScanResult>` | Scan a prompt and return results |
+
+## Requirements
+
+- Node.js 18.0.0 or higher
+
+## License
+
+This SDK is proprietary software. See [LICENSE](LICENSE) for details.
+
+## Support
+
+- 📚 [Documentation](https://docs.promptdefend.dev)
+- 📧 [Email Support](mailto:support@promptdefend.dev)
+- 🌐 [Website](https://promptdefend.dev)
+
+---
+
+© 2026 Prompt Defend. All Rights Reserved.

package/index.d.ts

@@ -0,0 +1,115 @@
+/**
+ * TypeScript declarations for PromptJudge Node.js SDK
+ */
+
+declare module 'promptjudge' {
+    export const VERSION: string;
+
+    /**
+     * Base error class for PromptJudge errors.
+     */
+    export class PromptJudgeError extends Error {
+        constructor(message: string);
+    }
+
+    /**
+     * Error thrown when API key is invalid or missing.
+     */
+    export class AuthenticationError extends PromptJudgeError {
+        constructor(message: string);
+    }
+
+    /**
+     * Error thrown when a network error occurs.
+     */
+    export class NetworkError extends PromptJudgeError {
+        constructor(message: string);
+    }
+
+    /**
+     * Error thrown when the API returns an error response.
+     */
+    export class APIError extends PromptJudgeError {
+        statusCode: number | null;
+        constructor(message: string, statusCode?: number | null);
+    }
+
+    /**
+     * Represents the result of a prompt scan.
+     */
+    export class ScanResult {
+        /** Whether the prompt is safe to process */
+        safe: boolean;
+        /** Explanation of the safety assessment */
+        reason: string;
+
+        constructor(safe: boolean, reason: string);
+
+        /** Convert the result to a plain object */
+        toJSON(): { safe: boolean; reason: string };
+
+        /** String representation of the result */
+        toString(): string;
+    }
+
+    /**
+     * Configuration options for PromptJudge client.
+     */
+    export interface PromptJudgeOptions {
+        /** Your PromptJudge API key (required) */
+        apiKey: string;
+        /** Custom API base URL */
+        baseUrl?: string;
+        /** Request timeout in milliseconds (default: 30000) */
+        timeout?: number;
+    }
+
+    /**
+     * PromptJudge API client.
+     * 
+     * @example
+     * ```typescript
+     * import { PromptJudge } from 'promptjudge';
+     * 
+     * const client = new PromptJudge({ apiKey: 'your-api-key' });
+     * const result = await client.scan('Hello, how are you?');
+     * console.log(result.safe);
+     * ```
+     */
+    export class PromptJudge {
+        /** Your PromptJudge API key */
+        apiKey: string;
+        /** API base URL */
+        baseUrl: string;
+        /** Request timeout in milliseconds */
+        timeout: number;
+
+        /**
+         * Create a PromptJudge client.
+         * @param options - Configuration options
+         */
+        constructor(options: PromptJudgeOptions);
+
+        /**
+         * Scan a prompt for security issues.
+         * 
+         * @param promptText - The prompt text to analyze
+         * @returns Promise resolving to the scan result
+         * @throws {AuthenticationError} If the API key is invalid
+         * @throws {NetworkError} If a network error occurs
+         * @throws {APIError} If the API returns an error response
+         */
+        scan(promptText: string): Promise<ScanResult>;
+    }
+
+    /**
+     * Convenience function to scan a prompt without creating a client instance.
+     * 
+     * @param apiKey - Your PromptJudge API key
+     * @param promptText - The prompt text to analyze
+     * @returns Promise resolving to the scan result
+     */
+    export function scan(apiKey: string, promptText: string): Promise<ScanResult>;
+
+    export default PromptJudge;
+}

package/index.js

@@ -0,0 +1,250 @@
+/**
+ * PromptJudge Node.js SDK
+ * A client library for the PromptJudge AI Security API.
+ * 
+ * @module promptjudge
+ * @version 1.0.0
+ * @license MIT
+ */
+
+'use strict';
+
+const VERSION = '1.0.0';
+const DEFAULT_BASE_URL = 'https://api.promptjudge.com';
+const DEFAULT_TIMEOUT = 30000; // 30 seconds in milliseconds
+
+/**
+ * Base error class for PromptJudge errors.
+ */
+class PromptJudgeError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'PromptJudgeError';
+    }
+}
+
+/**
+ * Error thrown when API key is invalid or missing.
+ */
+class AuthenticationError extends PromptJudgeError {
+    constructor(message) {
+        super(message);
+        this.name = 'AuthenticationError';
+    }
+}
+
+/**
+ * Error thrown when a network error occurs.
+ */
+class NetworkError extends PromptJudgeError {
+    constructor(message) {
+        super(message);
+        this.name = 'NetworkError';
+    }
+}
+
+/**
+ * Error thrown when the API returns an error response.
+ */
+class APIError extends PromptJudgeError {
+    constructor(message, statusCode = null) {
+        super(message);
+        this.name = 'APIError';
+        this.statusCode = statusCode;
+    }
+}
+
+/**
+ * Represents the result of a prompt scan.
+ */
+class ScanResult {
+    /**
+     * @param {boolean} safe - Whether the prompt is safe
+     * @param {string} reason - Explanation of the safety assessment
+     */
+    constructor(safe, reason) {
+        this.safe = safe;
+        this.reason = reason;
+    }
+
+    /**
+     * Convert the result to a plain object.
+     * @returns {Object} Plain object representation
+     */
+    toJSON() {
+        return {
+            safe: this.safe,
+            reason: this.reason
+        };
+    }
+
+    /**
+     * String representation of the result.
+     * @returns {string}
+     */
+    toString() {
+        return `ScanResult { safe: ${this.safe}, reason: '${this.reason}' }`;
+    }
+}
+
+/**
+ * PromptJudge API client.
+ * 
+ * @example
+ * const { PromptJudge } = require('promptjudge');
+ * 
+ * const client = new PromptJudge({ apiKey: 'your-api-key' });
+ * const result = await client.scan('Hello, how are you?');
+ * console.log(result.safe);
+ */
+class PromptJudge {
+    /**
+     * Create a PromptJudge client.
+     * 
+     * @param {Object} options - Configuration options
+     * @param {string} options.apiKey - Your PromptJudge API key (required)
+     * @param {string} [options.baseUrl] - Custom API base URL
+     * @param {number} [options.timeout] - Request timeout in milliseconds
+     */
+    constructor(options = {}) {
+        const { apiKey, baseUrl, timeout } = options;
+
+        if (!apiKey) {
+            throw new AuthenticationError('API key is required');
+        }
+
+        this.apiKey = apiKey;
+        this.baseUrl = (baseUrl || DEFAULT_BASE_URL).replace(/\/$/, '');
+        this.timeout = timeout || DEFAULT_TIMEOUT;
+    }
+
+    /**
+     * Scan a prompt for security issues.
+     * 
+     * @param {string} promptText - The prompt text to analyze
+     * @returns {Promise<ScanResult>} The scan result
+     * @throws {AuthenticationError} If the API key is invalid
+     * @throws {NetworkError} If a network error occurs
+     * @throws {APIError} If the API returns an error response
+     * 
+     * @example
+     * const result = await client.scan('What is the weather today?');
+     * if (result.safe) {
+     *   console.log('Prompt is safe to process');
+     * } else {
+     *   console.log(`Warning: ${result.reason}`);
+     * }
+     */
+    async scan(promptText) {
+        if (typeof promptText !== 'string') {
+            throw new TypeError('promptText must be a string');
+        }
+
+        if (!promptText.trim()) {
+            throw new Error('promptText cannot be empty');
+        }
+
+        const url = `${this.baseUrl}/v1/scan`;
+        const payload = { prompt: promptText };
+
+        let response;
+
+        try {
+            const controller = new AbortController();
+            const timeoutId = setTimeout(() => controller.abort(), this.timeout);
+
+            response = await fetch(url, {
+                method: 'POST',
+                headers: {
+                    'Authorization': `Bearer ${this.apiKey}`,
+                    'Content-Type': 'application/json',
+                    'User-Agent': `promptjudge-node/${VERSION}`
+                },
+                body: JSON.stringify(payload),
+                signal: controller.signal
+            });
+
+            clearTimeout(timeoutId);
+        } catch (error) {
+            if (error.name === 'AbortError') {
+                throw new NetworkError('Request timed out. Please try again.');
+            }
+            if (error.code === 'ENOTFOUND' || error.code === 'ECONNREFUSED') {
+                throw new NetworkError('Failed to connect to the API. Please check your internet connection.');
+            }
+            throw new NetworkError(`Network error occurred: ${error.message}`);
+        }
+
+        // Handle authentication errors
+        if (response.status === 401) {
+            throw new AuthenticationError('Invalid API key. Please check your credentials.');
+        }
+
+        if (response.status === 403) {
+            throw new AuthenticationError('Access forbidden. Your API key may not have the required permissions.');
+        }
+
+        // Handle other error responses
+        if (!response.ok) {
+            let errorMessage = 'Unknown error';
+            try {
+                const errorData = await response.json();
+                errorMessage = errorData.error || errorData.message || errorMessage;
+            } catch {
+                try {
+                    errorMessage = await response.text() || errorMessage;
+                } catch {
+                    // Use default error message
+                }
+            }
+
+            throw new APIError(`API error: ${errorMessage}`, response.status);
+        }
+
+        // Parse successful response
+        let data;
+        try {
+            data = await response.json();
+        } catch {
+            throw new APIError('Invalid JSON response from API');
+        }
+
+        if (typeof data.safe === 'undefined' || typeof data.reason === 'undefined') {
+            throw new APIError("Invalid response format: missing 'safe' or 'reason' field");
+        }
+
+        return new ScanResult(Boolean(data.safe), String(data.reason));
+    }
+}
+
+/**
+ * Convenience function to scan a prompt without creating a client instance.
+ * 
+ * @param {string} apiKey - Your PromptJudge API key
+ * @param {string} promptText - The prompt text to analyze
+ * @returns {Promise<ScanResult>} The scan result
+ * 
+ * @example
+ * const { scan } = require('promptjudge');
+ * const result = await scan('your-api-key', 'Hello world');
+ * console.log(result.safe);
+ */
+async function scan(apiKey, promptText) {
+    const client = new PromptJudge({ apiKey });
+    return client.scan(promptText);
+}
+
+// CommonJS exports
+module.exports = {
+    PromptJudge,
+    ScanResult,
+    PromptJudgeError,
+    AuthenticationError,
+    NetworkError,
+    APIError,
+    scan,
+    VERSION
+};
+
+// ES Module named exports (for dual-mode packages)
+module.exports.default = PromptJudge;

package/index.mjs

@@ -0,0 +1,172 @@
+/**
+ * PromptJudge Node.js SDK (ES Module version)
+ * A client library for the PromptJudge AI Security API.
+ * 
+ * @module promptjudge
+ * @version 1.0.0
+ * @license MIT
+ */
+
+const VERSION = '1.0.0';
+const DEFAULT_BASE_URL = 'https://api.promptjudge.com';
+const DEFAULT_TIMEOUT = 30000;
+
+/**
+ * Base error class for PromptJudge errors.
+ */
+export class PromptJudgeError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'PromptJudgeError';
+    }
+}
+
+/**
+ * Error thrown when API key is invalid or missing.
+ */
+export class AuthenticationError extends PromptJudgeError {
+    constructor(message) {
+        super(message);
+        this.name = 'AuthenticationError';
+    }
+}
+
+/**
+ * Error thrown when a network error occurs.
+ */
+export class NetworkError extends PromptJudgeError {
+    constructor(message) {
+        super(message);
+        this.name = 'NetworkError';
+    }
+}
+
+/**
+ * Error thrown when the API returns an error response.
+ */
+export class APIError extends PromptJudgeError {
+    constructor(message, statusCode = null) {
+        super(message);
+        this.name = 'APIError';
+        this.statusCode = statusCode;
+    }
+}
+
+/**
+ * Represents the result of a prompt scan.
+ */
+export class ScanResult {
+    constructor(safe, reason) {
+        this.safe = safe;
+        this.reason = reason;
+    }
+
+    toJSON() {
+        return {
+            safe: this.safe,
+            reason: this.reason
+        };
+    }
+
+    toString() {
+        return `ScanResult { safe: ${this.safe}, reason: '${this.reason}' }`;
+    }
+}
+
+/**
+ * PromptJudge API client.
+ */
+export class PromptJudge {
+    constructor(options = {}) {
+        const { apiKey, baseUrl, timeout } = options;
+
+        if (!apiKey) {
+            throw new AuthenticationError('API key is required');
+        }
+
+        this.apiKey = apiKey;
+        this.baseUrl = (baseUrl || DEFAULT_BASE_URL).replace(/\/$/, '');
+        this.timeout = timeout || DEFAULT_TIMEOUT;
+    }
+
+    async scan(promptText) {
+        if (typeof promptText !== 'string') {
+            throw new TypeError('promptText must be a string');
+        }
+
+        if (!promptText.trim()) {
+            throw new Error('promptText cannot be empty');
+        }
+
+        const url = `${this.baseUrl}/v1/scan`;
+        const payload = { prompt: promptText };
+
+        let response;
+
+        try {
+            const controller = new AbortController();
+            const timeoutId = setTimeout(() => controller.abort(), this.timeout);
+
+            response = await fetch(url, {
+                method: 'POST',
+                headers: {
+                    'Authorization': `Bearer ${this.apiKey}`,
+                    'Content-Type': 'application/json',
+                    'User-Agent': `promptjudge-node/${VERSION}`
+                },
+                body: JSON.stringify(payload),
+                signal: controller.signal
+            });
+
+            clearTimeout(timeoutId);
+        } catch (error) {
+            if (error.name === 'AbortError') {
+                throw new NetworkError('Request timed out. Please try again.');
+            }
+            throw new NetworkError(`Network error occurred: ${error.message}`);
+        }
+
+        if (response.status === 401) {
+            throw new AuthenticationError('Invalid API key. Please check your credentials.');
+        }
+
+        if (response.status === 403) {
+            throw new AuthenticationError('Access forbidden. Your API key may not have the required permissions.');
+        }
+
+        if (!response.ok) {
+            let errorMessage = 'Unknown error';
+            try {
+                const errorData = await response.json();
+                errorMessage = errorData.error || errorData.message || errorMessage;
+            } catch {
+                // Use default error message
+            }
+            throw new APIError(`API error: ${errorMessage}`, response.status);
+        }
+
+        let data;
+        try {
+            data = await response.json();
+        } catch {
+            throw new APIError('Invalid JSON response from API');
+        }
+
+        if (typeof data.safe === 'undefined' || typeof data.reason === 'undefined') {
+            throw new APIError("Invalid response format: missing 'safe' or 'reason' field");
+        }
+
+        return new ScanResult(Boolean(data.safe), String(data.reason));
+    }
+}
+
+/**
+ * Convenience function to scan a prompt without creating a client instance.
+ */
+export async function scan(apiKey, promptText) {
+    const client = new PromptJudge({ apiKey });
+    return client.scan(promptText);
+}
+
+export { VERSION };
+export default PromptJudge;

package/package.json

@@ -0,0 +1,61 @@
+{
+    "name": "promptdefend",
+    "version": "1.0.0",
+    "description": "Node.js SDK for the Prompt Defend AI Security API - 16-Layer Guardrail Protection",
+    "main": "index.js",
+    "types": "index.d.ts",
+    "exports": {
+        ".": {
+            "require": "./index.js",
+            "import": "./index.mjs",
+            "types": "./index.d.ts"
+        }
+    },
+    "scripts": {
+        "test": "node --test",
+        "lint": "eslint .",
+        "format": "prettier --write .",
+        "prepublishOnly": "npm test"
+    },
+    "keywords": [
+        "promptdefend",
+        "prompt-defend",
+        "ai",
+        "security",
+        "prompt-injection",
+        "jailbreak",
+        "guardrails",
+        "llm",
+        "api",
+        "sdk",
+        "ai-security",
+        "chatgpt",
+        "openai",
+        "claude",
+        "safety"
+    ],
+    "author": "Prompt Defend <support@promptdefend.dev>",
+    "license": "SEE LICENSE IN LICENSE",
+    "homepage": "https://promptdefend.dev",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/promptdefend/promptdefend-node"
+    },
+    "bugs": {
+        "url": "https://promptdefend.dev/support"
+    },
+    "engines": {
+        "node": ">=18.0.0"
+    },
+    "files": [
+        "index.js",
+        "index.mjs",
+        "index.d.ts",
+        "README.md",
+        "LICENSE"
+    ],
+    "devDependencies": {
+        "eslint": "^8.50.0",
+        "prettier": "^3.0.0"
+    }
+}