@palveron/sdk 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+All notable changes to `@palveron/sdk` will be documented in this file.
+
+This project follows [Semantic Versioning](https://semver.org/).
+
+## [1.0.0] — 2026-05-17
+
+### Added
+- Initial public release of `@palveron/sdk` on npm
+- `Palveron` client class with full API coverage
+- Policy verification via `verify()` method with multi-modal attachments
+  (image, audio, video, document, code)
+- `check()` convenience method for text-only verification
+- `verifyWithFile()` convenience method (Node.js, auto MIME detection)
+- `listPolicies()` and `health()` endpoints
+- `diagnostics()` method for runtime introspection
+- `RequestContext` for MCP / agentic context
+  (`mcpServer`, `toolName`, `chainDepth`, `sourceSystem`, `sessionId`)
+- Typed error hierarchy: `PalveronError`, `PalveronAuthenticationError`,
+  `PalveronRateLimitError`, `PalveronValidationError`, `PalveronTimeoutError`,
+  `PalveronCircuitOpenError`
+- `retryAfterMs` on rate limit errors
+- Retry with exponential backoff + jitter
+- Circuit breaker with configurable threshold and cooldown
+- Custom headers support for proxy / auth scenarios
+- Custom `baseUrl` for on-premise / self-hosted gateways
+- TypeScript type definitions for every API surface
+- Dual ESM + CommonJS output, source maps, declaration maps
+- Zero runtime dependencies; works in Node.js 18+, Deno, Bun, Cloudflare
+  Workers, Vercel Edge

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Palveron
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,249 @@
+<p align="center">
+  <h1 align="center">@palveron/sdk</h1>
+  <p align="center">Official TypeScript / JavaScript SDK for the Palveron AI Governance Gateway</p>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@palveron/sdk"><img src="https://img.shields.io/npm/v/@palveron/sdk.svg?style=flat-square&color=cb3837" alt="npm version"></a>
+  <a href="https://www.npmjs.com/package/@palveron/sdk"><img src="https://img.shields.io/npm/dm/@palveron/sdk.svg?style=flat-square" alt="npm downloads"></a>
+  <a href="https://github.com/palveron/sdk-typescript/actions"><img src="https://img.shields.io/github/actions/workflow/status/palveron/sdk-typescript/ci.yml?style=flat-square" alt="CI"></a>
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-green.svg?style=flat-square" alt="License: MIT"></a>
+  <a href="https://docs.palveron.com"><img src="https://img.shields.io/badge/docs-palveron.com-5A67D8?style=flat-square" alt="Documentation"></a>
+</p>
+
+---
+
+Every AI interaction your application makes — governed, audited, and optionally anchored to the blockchain. In one line of code.
+
+- **Zero dependencies** — uses native `fetch`; works in Node.js 18+, Deno, Bun, Cloudflare Workers, Vercel Edge
+- **Multi-modal** — text, images, audio, documents, code
+- **Enterprise-grade** — retry with exponential backoff, circuit breaker, typed errors
+- **On-prem ready** — point to any Palveron Gateway endpoint
+
+## Installation
+
+```bash
+npm install @palveron/sdk
+# or
+pnpm add @palveron/sdk
+# or
+yarn add @palveron/sdk
+```
+
+## Quick Start
+
+```typescript
+import { Palveron } from '@palveron/sdk';
+
+const palveron = new Palveron({ apiKey: process.env.PALVERON_API_KEY! });
+
+// Verify any prompt before sending it to an LLM
+const result = await palveron.verify({ prompt: userInput });
+
+if (result.decision === 'BLOCKED') {
+  console.error(`Blocked: ${result.reason}`);
+  return;
+}
+
+// result.decision is 'ALLOWED' or 'MODIFIED'
+// result.output contains the (possibly sanitized) text
+// result.traceId links to the immutable audit trail
+```
+
+## Features
+
+- **Policy Enforcement** — every prompt routed through your active guardrails before it reaches an LLM
+- **Trace Verification** — every decision logged with an integrity hash for tamper detection
+- **Agent Registration & Governance** — list and audit the agents covered by your account
+- **Blockchain Attestation** — high-severity traces anchored to Flare for cryptographic audit trails
+- **EU AI Act / DORA / GDPR** — compliance-ready audit fields out of the box
+
+## Configuration
+
+```typescript
+const palveron = new Palveron({
+  apiKey: 'pv_live_xxx',                  // Required — project or agent API key
+  baseUrl: 'https://gateway.palveron.com', // Custom endpoint for on-prem
+  timeout: 30_000,                         // Request timeout in ms
+  maxRetries: 3,                           // Retry attempts on transient failures
+  retryBaseDelay: 500,                     // Base delay for exponential backoff (ms)
+  headers: { 'X-Tenant': 'acme' },         // Custom headers on every request
+  circuitBreakerThreshold: 5,              // Failures before circuit opens
+  circuitBreakerCooldown: 30_000,          // Cooldown before half-open retry (ms)
+});
+```
+
+## API Reference
+
+Full reference at **[docs.palveron.com/sdks](https://docs.palveron.com/sdks)**. Quick summary:
+
+### `verify(request)` — Core governance check
+
+```typescript
+const result = await palveron.verify({
+  prompt: 'Transfer $50,000 to account DE89370400440532013000',
+  metadata: { userId: 'u_123', department: 'finance' },
+  attachments: [{
+    contentType: 'application/pdf',
+    data: base64EncodedPdf,
+    filename: 'contract.pdf',
+  }],
+  context: {
+    mcpServer: 'https://mcp.internal.corp',
+    toolName: 'bank_transfer',
+    chainDepth: 2,
+    sourceSystem: 'crewai',
+    sessionId: 'sess_abc',
+  },
+});
+```
+
+**Returns `VerifyResponse`:**
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `decision` | `'ALLOWED' \| 'BLOCKED' \| 'MODIFIED' \| 'ERROR'` | Governance decision |
+| `output` | `string` | Sanitized output (PII redacted if MODIFIED) |
+| `reason` | `string` | Human-readable explanation |
+| `traceId` | `string` | Unique audit trail ID |
+| `integrityHash` | `string` | SHA-256 hash for tamper detection |
+| `shouldAnchor` | `boolean` | Whether trace will be anchored to Flare blockchain |
+| `flareStatus` | `string` | `LOCAL_ONLY`, `PENDING`, `ANCHORED`, `SKIPPED`, `FAILED` |
+| `flareTxHash` | `string \| null` | Blockchain transaction hash (after anchoring) |
+| `contentType` | `string` | Detected content type |
+| `findings` | `Finding[]` | Security findings (PII, secrets, policy violations) |
+| `latencyMs` | `number` | Round-trip latency in milliseconds |
+
+### `check(prompt)` — Quick text-only verification
+
+```typescript
+const { decision } = await palveron.check('Is this prompt safe?');
+```
+
+### `verifyWithFile(prompt, filePath)` — File attachment (Node.js only)
+
+```typescript
+const result = await palveron.verifyWithFile(
+  'Analyze this document for compliance',
+  './report.pdf'
+);
+```
+
+### `listPolicies(env?)` — List active policies
+
+```typescript
+const { policies } = await palveron.listPolicies('prod');
+```
+
+### `health()` — Gateway health check
+
+```typescript
+const health = await palveron.health();
+console.log(health.status); // 'healthy'
+```
+
+### `diagnostics()` — SDK diagnostics
+
+```typescript
+const diag = palveron.diagnostics();
+// { sdkVersion, baseUrl, timeout, maxRetries, circuitState }
+```
+
+## Examples
+
+### LLM gateway with governance
+
+```typescript
+import { Palveron } from '@palveron/sdk';
+import OpenAI from 'openai';
+
+const palveron = new Palveron({ apiKey: process.env.PALVERON_API_KEY! });
+const openai = new OpenAI();
+
+async function askWithGovernance(userPrompt: string) {
+  const gate = await palveron.verify({ prompt: userPrompt });
+  if (gate.decision === 'BLOCKED') {
+    throw new Error(`Blocked by policy: ${gate.reason}`);
+  }
+  // `gate.output` is the (possibly sanitized) prompt — always use it
+  // instead of the raw input so downstream LLMs never see PII / secrets.
+  return openai.chat.completions.create({
+    model: 'gpt-4o',
+    messages: [{ role: 'user', content: gate.output }],
+  });
+}
+```
+
+### Agentic / MCP audit context
+
+```typescript
+const result = await palveron.verify({
+  prompt: 'Execute bank transfer',
+  context: {
+    mcpServer: 'https://banking-mcp.corp.internal',
+    toolName: 'transfer_funds',
+    chainDepth: 3,
+    sourceSystem: 'crewai',
+    sessionId: 'agent_session_42',
+  },
+});
+```
+
+### On-premise / self-hosted gateway
+
+```typescript
+const palveron = new Palveron({
+  apiKey: process.env.PALVERON_API_KEY!,
+  baseUrl: 'https://gateway.internal.acme.corp:8080',
+  timeout: 10_000,
+  maxRetries: 5,
+});
+```
+
+## Error Handling
+
+All errors extend `PalveronError` with structured metadata:
+
+```typescript
+import { PalveronError, PalveronRateLimitError } from '@palveron/sdk';
+
+try {
+  await palveron.verify({ prompt: input });
+} catch (err) {
+  if (err instanceof PalveronRateLimitError) {
+    // err.retryAfterMs — wait this long before retrying
+    await sleep(err.retryAfterMs);
+    return retry();
+  }
+  if (err instanceof PalveronError) {
+    console.error(err.code, err.statusCode, err.requestId);
+  }
+}
+```
+
+| Error Class | Code | Retryable | When |
+|-------------|------|:---------:|------|
+| `PalveronAuthenticationError` | `AUTHENTICATION_FAILED` | No | Invalid or expired API key |
+| `PalveronRateLimitError` | `RATE_LIMITED` | Yes | Quota exceeded (includes `retryAfterMs`) |
+| `PalveronValidationError` | `VALIDATION_ERROR` | No | Malformed request (includes `field`) |
+| `PalveronTimeoutError` | `TIMEOUT` | Yes | Gateway didn't respond in time |
+| `PalveronCircuitOpenError` | `CIRCUIT_OPEN` | No | Too many consecutive failures |
+
+## Requirements
+
+- Node.js **18 or newer** (uses native `fetch`)
+- TypeScript **5.0 or newer** (recommended; SDK works in plain JavaScript too)
+- Also runs in Deno, Bun, Cloudflare Workers, Vercel Edge
+
+## Links
+
+- **Documentation** — [docs.palveron.com](https://docs.palveron.com)
+- **SDK reference** — [docs.palveron.com/sdks](https://docs.palveron.com/sdks)
+- **Dashboard** — [palveron.com](https://palveron.com)
+- **Support** — [hello@palveron.com](mailto:hello@palveron.com)
+- **GitHub** — [palveron/sdk-typescript](https://github.com/palveron/sdk-typescript)
+- **Changelog** — [CHANGELOG.md](https://github.com/palveron/sdk-typescript/blob/main/CHANGELOG.md)
+
+## License
+
+[MIT](./LICENSE) — Copyright © 2026 Palveron.

package/dist/index.d.mts

@@ -0,0 +1,225 @@
+type Decision = 'ALLOWED' | 'BLOCKED' | 'MODIFIED' | 'ERROR';
+type RiskLevel = 'minimal' | 'limited' | 'high' | 'unacceptable';
+type Sensitivity = 'low' | 'medium' | 'high';
+interface PalveronConfig {
+    /** API key (starts with pv_live_ or pv_test_) */
+    apiKey: string;
+    /** Gateway base URL (default: https://gateway.palveron.com) */
+    baseUrl?: string;
+    /** Request timeout in ms (default: 30000) */
+    timeout?: number;
+    /** Max retry attempts on transient failures (default: 3) */
+    maxRetries?: number;
+    /** Base delay for exponential backoff in ms (default: 500) */
+    retryBaseDelay?: number;
+    /** Custom logger (default: console) */
+    logger?: PalveronLogger;
+    /** Custom headers added to every request */
+    headers?: Record<string, string>;
+    /** Circuit breaker: max consecutive failures before opening (default: 5) */
+    circuitBreakerThreshold?: number;
+    /** Circuit breaker: cooldown in ms before half-open retry (default: 30000) */
+    circuitBreakerCooldown?: number;
+}
+interface PalveronLogger {
+    debug(message: string, meta?: Record<string, unknown>): void;
+    info(message: string, meta?: Record<string, unknown>): void;
+    warn(message: string, meta?: Record<string, unknown>): void;
+    error(message: string, meta?: Record<string, unknown>): void;
+}
+interface Attachment {
+    /** MIME type (e.g. "image/png", "audio/wav", "application/pdf") */
+    contentType: string;
+    /** Base64-encoded data */
+    data: string;
+    /** Optional filename */
+    filename?: string;
+    /** Optional per-attachment metadata (GPS, resolution, etc.) */
+    metadata?: Record<string, unknown>;
+}
+interface RequestContext {
+    /** MCP server URL if applicable */
+    mcpServer?: string;
+    /** MCP tool name */
+    toolName?: string;
+    /** Agent chain depth for recursive calls */
+    chainDepth?: number;
+    /** Source system identifier ("ros2", "unity", "cursor-ide", etc.) */
+    sourceSystem?: string;
+    /** Session ID for conversation tracking */
+    sessionId?: string;
+}
+interface VerifyRequest {
+    /** The prompt or input text to verify */
+    prompt: string;
+    /** Pre-extracted text from attachments (optional, server extracts if absent) */
+    extractedText?: string;
+    /** Arbitrary metadata passed through to the trace */
+    metadata?: Record<string, unknown>;
+    /** Multi-modal attachments (images, audio, documents, code) */
+    attachments?: Attachment[];
+    /** Agentic context (MCP, tool chains, source systems) */
+    context?: RequestContext;
+}
+interface Finding {
+    risk: 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL';
+    category: string;
+    description: string;
+    confidence: number;
+}
+interface VerifyResponse {
+    /** Governance decision */
+    decision: Decision;
+    /** Modified/sanitized output (present when decision is MODIFIED) */
+    output: string;
+    /** Human-readable reason for the decision */
+    reason: string;
+    /** Unique trace ID for audit trail */
+    traceId: string;
+    /** SHA-256 integrity hash of the governance decision */
+    integrityHash: string;
+    /** Whether this trace will be anchored to Flare blockchain */
+    shouldAnchor: boolean;
+    /** Flare blockchain status */
+    flareStatus: string;
+    /** Flare transaction hash (populated after anchoring) */
+    flareTxHash: string | null;
+    /** Detected content type */
+    contentType: string;
+    /** Security findings (secrets, PII, policy violations) */
+    findings: Finding[];
+    /** Server-side latency in milliseconds */
+    latencyMs: number;
+}
+interface PolicyListResponse {
+    policies: Array<{
+        id: string;
+        name: string;
+        prompt: string;
+        environment: string;
+        contentTypes: string[];
+        createdAt: string;
+        updatedAt: string;
+    }>;
+}
+interface HealthResponse {
+    status: 'healthy' | 'degraded' | 'unhealthy';
+    version: string;
+    uptime: number;
+    checks: Record<string, {
+        status: string;
+        latencyMs: number;
+    }>;
+}
+declare class PalveronError extends Error {
+    readonly code: string;
+    readonly statusCode: number;
+    readonly requestId: string | null;
+    readonly retryable: boolean;
+    constructor(message: string, opts: {
+        code: string;
+        statusCode: number;
+        requestId?: string | null;
+        retryable?: boolean;
+    });
+}
+declare class PalveronAuthenticationError extends PalveronError {
+    constructor(message: string, requestId?: string | null);
+}
+declare class PalveronRateLimitError extends PalveronError {
+    readonly retryAfterMs: number;
+    constructor(message: string, retryAfterMs: number, requestId?: string | null);
+}
+declare class PalveronValidationError extends PalveronError {
+    readonly field: string | null;
+    constructor(message: string, field?: string, requestId?: string | null);
+}
+declare class PalveronCircuitOpenError extends PalveronError {
+    constructor();
+}
+declare class PalveronTimeoutError extends PalveronError {
+    constructor(timeoutMs: number, requestId?: string | null);
+}
+declare class Palveron {
+    private readonly config;
+    private readonly circuit;
+    constructor(config: PalveronConfig);
+    /**
+     * Send a governance verification request.
+     * This is the primary method — every LLM call should go through this.
+     *
+     * @example
+     * ```typescript
+     * const result = await palveron.verify({ prompt: 'User input here' });
+     * if (result.decision === 'BLOCKED') {
+     *   throw new Error(result.reason);
+     * }
+     * ```
+     */
+    verify(request: VerifyRequest): Promise<VerifyResponse>;
+    /**
+     * Quick verification for text-only prompts.
+     *
+     * @example
+     * ```typescript
+     * const result = await palveron.check('Is this prompt safe?');
+     * console.log(result.decision); // 'ALLOWED'
+     * ```
+     */
+    check(prompt: string): Promise<VerifyResponse>;
+    /**
+     * Verify a prompt with a file attachment.
+     * Reads the file, Base64-encodes it, and sends it with the correct MIME type.
+     * Node.js only — use verify() with pre-encoded data in browsers.
+     *
+     * @example
+     * ```typescript
+     * const result = await palveron.verifyWithFile(
+     *   'Analyze this document',
+     *   '/path/to/report.pdf'
+     * );
+     * ```
+     */
+    verifyWithFile(prompt: string, filePath: string): Promise<VerifyResponse>;
+    /**
+     * List all active policies for the project.
+     */
+    listPolicies(env?: string): Promise<PolicyListResponse>;
+    /**
+     * Check gateway health status.
+     */
+    health(): Promise<HealthResponse>;
+    /**
+     * Get SDK and connection diagnostics.
+     */
+    diagnostics(): {
+        sdkVersion: string;
+        baseUrl: string;
+        timeout: number;
+        maxRetries: number;
+        circuitState: string;
+    };
+    private request;
+    private backoffDelay;
+    private sleep;
+    private generateRequestId;
+    private inferMimeType;
+}
+/**
+ * Create a Palveron client instance.
+ *
+ * @example
+ * ```typescript
+ * import { createClient } from '@palveron/sdk';
+ *
+ * const palveron = createClient({
+ *   apiKey: process.env.PALVERON_API_KEY!,
+ *   baseUrl: 'https://gateway.acme.corp:8080', // on-prem
+ * });
+ *
+ * const result = await palveron.verify({ prompt: userInput });
+ * ```
+ */
+declare function createClient(config: PalveronConfig): Palveron;
+
+export { type Attachment, type Decision, type Finding, type HealthResponse, Palveron, PalveronAuthenticationError, PalveronCircuitOpenError, type PalveronConfig, PalveronError, type PalveronLogger, PalveronRateLimitError, PalveronTimeoutError, PalveronValidationError, type PolicyListResponse, type RequestContext, type RiskLevel, type Sensitivity, type VerifyRequest, type VerifyResponse, createClient, Palveron as default };