@2434addy/agentledger-sdk 0.2.0

package/README.md

@@ -0,0 +1,120 @@
+# @agentledger/sdk
+
+TypeScript SDK for AgentLedger — track, audit, and monitor your AI agents.
+
+## Install
+
+```bash
+npm install @agentledger/sdk
+```
+
+## Quick Start
+
+```typescript
+import { AgentLedger } from '@agentledger/sdk'
+
+const al = new AgentLedger({ apiKey: 'al_live_sk_...' })
+
+// Create an agent
+const agent = await al.createAgent({
+  name: 'My Assistant',
+  description: 'Customer support bot',
+  modelProvider: 'anthropic',
+  modelId: 'claude-sonnet-4-6',
+})
+
+// Create a session
+const session = await al.createSession({ agentId: agent.id })
+
+// Track events (batched automatically)
+al.track({
+  agentId: agent.id,
+  sessionId: session.id,
+  category: 'llm_call',
+  level: 'info',
+  message: 'Called Claude API',
+  metadata: { prompt: 'Hello world' },
+})
+
+// Send all queued events now
+await al.flush()
+```
+
+## API
+
+### `new AgentLedger(config)`
+
+| Option          | Type     | Default                                    | Description              |
+| --------------- | -------- | ------------------------------------------ | ------------------------ |
+| `apiKey`        | `string` | *required*                                 | Your API key             |
+| `baseUrl`       | `string` | `https://api.agentledger.io/api/v1`        | API base URL             |
+| `timeout`       | `number` | `5000`                                     | Request timeout (ms)     |
+| `flushInterval` | `number` | `5000`                                     | Auto-flush interval (ms) |
+| `maxBatchSize`  | `number` | `50`                                       | Max events per batch     |
+| `debug`         | `boolean`| `false`                                    | Log warnings to console  |
+
+### `al.createAgent(input)`
+
+Create a registered agent.
+
+```typescript
+const agent = await al.createAgent({
+  name: 'Email Agent',
+  modelProvider: 'openai',
+  modelId: 'gpt-4o',
+})
+```
+
+### `al.createSession(input)`
+
+Start a new session for an agent.
+
+```typescript
+const session = await al.createSession({ agentId: agent.id })
+```
+
+### `al.track(event)`
+
+Queue an event for batched sending. Fires immediately when the batch reaches `maxBatchSize`.
+
+```typescript
+al.track({
+  agentId: agent.id,
+  sessionId: session.id,
+  category: 'llm_call',
+  level: 'info',
+  message: 'Generated response',
+  metadata: { model: 'claude-sonnet-4-6' },
+  tokensInput: 150,
+  tokensOutput: 420,
+  latencyMs: 1200,
+})
+```
+
+### `al.flush()`
+
+Send all queued events immediately. Returns the created events.
+
+```typescript
+const events = await al.flush()
+```
+
+### `al.shutdown()`
+
+Stop the auto-flush timer and send remaining events. Call before process exit.
+
+```typescript
+process.on('beforeExit', () => al.shutdown())
+```
+
+## Event Categories
+
+`agent_lifecycle` | `llm_call` | `tool_invocation` | `user_action` | `system` | `security` | `guardrail`
+
+## Event Levels
+
+`debug` | `info` | `warn` | `error` | `fatal`
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,106 @@
+interface AgentLedgerConfig {
+    apiKey: string;
+    baseUrl?: string;
+    timeout?: number;
+    flushInterval?: number;
+    maxBatchSize?: number;
+    debug?: boolean;
+}
+type EventCategory = 'agent_lifecycle' | 'llm_call' | 'tool_invocation' | 'user_action' | 'system' | 'security' | 'guardrail';
+type EventLevel = 'debug' | 'info' | 'warn' | 'error' | 'fatal';
+interface CreateAgentInput {
+    name: string;
+    description?: string;
+    modelProvider: string;
+    modelId: string;
+    metadata?: Record<string, unknown>;
+}
+interface Agent {
+    id: string;
+    name: string;
+    description: string | null;
+    modelProvider: string;
+    modelId: string;
+    status: string;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateSessionInput {
+    agentId: string;
+    metadata?: Record<string, unknown>;
+}
+interface Session {
+    id: string;
+    agentId: string;
+    status: string;
+    metadata: Record<string, unknown> | null;
+    startedAt: string;
+}
+interface TrackEventInput {
+    agentId: string;
+    sessionId?: string;
+    category: EventCategory;
+    level: EventLevel;
+    message: string;
+    metadata?: Record<string, unknown>;
+    tokensInput?: number;
+    tokensOutput?: number;
+    costUsd?: number;
+    latencyMs?: number;
+}
+interface TrackedEvent {
+    id: string;
+    agentId: string;
+    sessionId: string | null;
+    category: EventCategory;
+    level: EventLevel;
+    message: string;
+    hash: string;
+    prevHash: string | null;
+    createdAt: string;
+}
+
+declare class AgentLedger {
+    private readonly baseUrl;
+    private readonly apiKey;
+    private readonly timeout;
+    private readonly maxBatchSize;
+    private readonly debug;
+    private queue;
+    private flushTimer;
+    constructor(config: AgentLedgerConfig);
+    createAgent(input: CreateAgentInput): Promise<Agent>;
+    createSession(input: CreateSessionInput): Promise<Session>;
+    /**
+     * Queue an event for batched sending. Events are auto-flushed at
+     * the configured `flushInterval` or when the batch reaches `maxBatchSize`.
+     * Returns immediately — call `flush()` to send synchronously.
+     */
+    track(event: TrackEventInput): void;
+    /**
+     * Send all queued events to the server immediately.
+     * Resolves with the created events, or an empty array if the queue was empty.
+     */
+    flush(): Promise<TrackedEvent[]>;
+    /**
+     * Stop the auto-flush timer and send remaining events.
+     * Call this before your process exits.
+     */
+    shutdown(): Promise<void>;
+    private request;
+    private withRetry;
+}
+
+declare class AgentLedgerError extends Error {
+    code: string;
+    constructor(message: string, code: string);
+}
+declare class AuthenticationError extends AgentLedgerError {
+    constructor();
+}
+declare class NetworkError extends AgentLedgerError {
+    constructor(message: string);
+}
+
+export { type Agent, AgentLedger, type AgentLedgerConfig, AgentLedgerError, AuthenticationError, type CreateAgentInput, type CreateSessionInput, type EventCategory, type EventLevel, NetworkError, type Session, type TrackEventInput, type TrackedEvent };

package/dist/index.d.ts

@@ -0,0 +1,106 @@
+interface AgentLedgerConfig {
+    apiKey: string;
+    baseUrl?: string;
+    timeout?: number;
+    flushInterval?: number;
+    maxBatchSize?: number;
+    debug?: boolean;
+}
+type EventCategory = 'agent_lifecycle' | 'llm_call' | 'tool_invocation' | 'user_action' | 'system' | 'security' | 'guardrail';
+type EventLevel = 'debug' | 'info' | 'warn' | 'error' | 'fatal';
+interface CreateAgentInput {
+    name: string;
+    description?: string;
+    modelProvider: string;
+    modelId: string;
+    metadata?: Record<string, unknown>;
+}
+interface Agent {
+    id: string;
+    name: string;
+    description: string | null;
+    modelProvider: string;
+    modelId: string;
+    status: string;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateSessionInput {
+    agentId: string;
+    metadata?: Record<string, unknown>;
+}
+interface Session {
+    id: string;
+    agentId: string;
+    status: string;
+    metadata: Record<string, unknown> | null;
+    startedAt: string;
+}
+interface TrackEventInput {
+    agentId: string;
+    sessionId?: string;
+    category: EventCategory;
+    level: EventLevel;
+    message: string;
+    metadata?: Record<string, unknown>;
+    tokensInput?: number;
+    tokensOutput?: number;
+    costUsd?: number;
+    latencyMs?: number;
+}
+interface TrackedEvent {
+    id: string;
+    agentId: string;
+    sessionId: string | null;
+    category: EventCategory;
+    level: EventLevel;
+    message: string;
+    hash: string;
+    prevHash: string | null;
+    createdAt: string;
+}
+
+declare class AgentLedger {
+    private readonly baseUrl;
+    private readonly apiKey;
+    private readonly timeout;
+    private readonly maxBatchSize;
+    private readonly debug;
+    private queue;
+    private flushTimer;
+    constructor(config: AgentLedgerConfig);
+    createAgent(input: CreateAgentInput): Promise<Agent>;
+    createSession(input: CreateSessionInput): Promise<Session>;
+    /**
+     * Queue an event for batched sending. Events are auto-flushed at
+     * the configured `flushInterval` or when the batch reaches `maxBatchSize`.
+     * Returns immediately — call `flush()` to send synchronously.
+     */
+    track(event: TrackEventInput): void;
+    /**
+     * Send all queued events to the server immediately.
+     * Resolves with the created events, or an empty array if the queue was empty.
+     */
+    flush(): Promise<TrackedEvent[]>;
+    /**
+     * Stop the auto-flush timer and send remaining events.
+     * Call this before your process exits.
+     */
+    shutdown(): Promise<void>;
+    private request;
+    private withRetry;
+}
+
+declare class AgentLedgerError extends Error {
+    code: string;
+    constructor(message: string, code: string);
+}
+declare class AuthenticationError extends AgentLedgerError {
+    constructor();
+}
+declare class NetworkError extends AgentLedgerError {
+    constructor(message: string);
+}
+
+export { type Agent, AgentLedger, type AgentLedgerConfig, AgentLedgerError, AuthenticationError, type CreateAgentInput, type CreateSessionInput, type EventCategory, type EventLevel, NetworkError, type Session, type TrackEventInput, type TrackedEvent };

package/dist/index.js

@@ -0,0 +1,161 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  AgentLedger: () => AgentLedger,
+  AgentLedgerError: () => AgentLedgerError,
+  AuthenticationError: () => AuthenticationError,
+  NetworkError: () => NetworkError
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/errors.ts
+var AgentLedgerError = class extends Error {
+  constructor(message, code) {
+    super(message);
+    this.code = code;
+    this.name = "AgentLedgerError";
+  }
+};
+var AuthenticationError = class extends AgentLedgerError {
+  constructor() {
+    super("Invalid API key. Check your apiKey in config.", "AUTH_ERROR");
+  }
+};
+var NetworkError = class extends AgentLedgerError {
+  constructor(message) {
+    super(`Network error: ${message}`, "NETWORK_ERROR");
+  }
+};
+
+// src/client.ts
+var AgentLedger = class {
+  constructor(config) {
+    this.queue = [];
+    this.flushTimer = null;
+    if (!config.apiKey) throw new Error("AgentLedger: apiKey is required");
+    this.apiKey = config.apiKey;
+    this.baseUrl = (config.baseUrl || "https://api.agentledger.io/api/v1").replace(/\/$/, "");
+    this.timeout = config.timeout ?? 5e3;
+    this.maxBatchSize = config.maxBatchSize ?? 50;
+    this.debug = config.debug ?? false;
+    const flushInterval = config.flushInterval ?? 5e3;
+    if (flushInterval > 0) {
+      this.flushTimer = setInterval(() => this.flush().catch(() => {
+      }), flushInterval);
+      if (typeof this.flushTimer === "object" && "unref" in this.flushTimer) {
+        this.flushTimer.unref();
+      }
+    }
+  }
+  // ── Agents ──────────────────────────────────────────────────────
+  async createAgent(input) {
+    return this.request("POST", "/agents", input);
+  }
+  // ── Sessions ────────────────────────────────────────────────────
+  async createSession(input) {
+    return this.request("POST", "/sessions", input);
+  }
+  // ── Events ──────────────────────────────────────────────────────
+  /**
+   * Queue an event for batched sending. Events are auto-flushed at
+   * the configured `flushInterval` or when the batch reaches `maxBatchSize`.
+   * Returns immediately — call `flush()` to send synchronously.
+   */
+  track(event) {
+    this.queue.push(event);
+    if (this.queue.length >= this.maxBatchSize) {
+      this.flush().catch(() => {
+      });
+    }
+  }
+  /**
+   * Send all queued events to the server immediately.
+   * Resolves with the created events, or an empty array if the queue was empty.
+   */
+  async flush() {
+    if (this.queue.length === 0) return [];
+    const batch = this.queue.splice(0);
+    try {
+      return await this.request("POST", "/events", { events: batch });
+    } catch (err) {
+      this.queue.unshift(...batch);
+      throw err;
+    }
+  }
+  /**
+   * Stop the auto-flush timer and send remaining events.
+   * Call this before your process exits.
+   */
+  async shutdown() {
+    if (this.flushTimer) {
+      clearInterval(this.flushTimer);
+      this.flushTimer = null;
+    }
+    await this.flush();
+  }
+  // ── HTTP helper ─────────────────────────────────────────────────
+  async request(method, path, body) {
+    return this.withRetry(async () => {
+      const controller = new AbortController();
+      const timer = setTimeout(() => controller.abort(), this.timeout);
+      try {
+        const res = await fetch(`${this.baseUrl}${path}`, {
+          method,
+          headers: {
+            "Content-Type": "application/json",
+            "x-api-key": this.apiKey
+          },
+          body: body ? JSON.stringify(body) : void 0,
+          signal: controller.signal
+        });
+        if (res.status === 401) throw new AuthenticationError();
+        if (!res.ok) {
+          const text = await res.text().catch(() => "");
+          throw new NetworkError(`HTTP ${res.status}: ${text}`);
+        }
+        return await res.json();
+      } finally {
+        clearTimeout(timer);
+      }
+    });
+  }
+  async withRetry(fn, attempts = 3) {
+    for (let i = 0; i < attempts; i++) {
+      try {
+        return await fn();
+      } catch (err) {
+        if (err instanceof AuthenticationError) throw err;
+        if (i === attempts - 1) throw err;
+        if (this.debug) console.warn(`[AgentLedger] Retry ${i + 1}/${attempts - 1}`, err);
+        await new Promise((r) => setTimeout(r, Math.pow(2, i) * 500));
+      }
+    }
+    throw new AgentLedgerError("Unreachable", "INTERNAL");
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AgentLedger,
+  AgentLedgerError,
+  AuthenticationError,
+  NetworkError
+});

package/dist/index.mjs

@@ -0,0 +1,131 @@
+// src/errors.ts
+var AgentLedgerError = class extends Error {
+  constructor(message, code) {
+    super(message);
+    this.code = code;
+    this.name = "AgentLedgerError";
+  }
+};
+var AuthenticationError = class extends AgentLedgerError {
+  constructor() {
+    super("Invalid API key. Check your apiKey in config.", "AUTH_ERROR");
+  }
+};
+var NetworkError = class extends AgentLedgerError {
+  constructor(message) {
+    super(`Network error: ${message}`, "NETWORK_ERROR");
+  }
+};
+
+// src/client.ts
+var AgentLedger = class {
+  constructor(config) {
+    this.queue = [];
+    this.flushTimer = null;
+    if (!config.apiKey) throw new Error("AgentLedger: apiKey is required");
+    this.apiKey = config.apiKey;
+    this.baseUrl = (config.baseUrl || "https://api.agentledger.io/api/v1").replace(/\/$/, "");
+    this.timeout = config.timeout ?? 5e3;
+    this.maxBatchSize = config.maxBatchSize ?? 50;
+    this.debug = config.debug ?? false;
+    const flushInterval = config.flushInterval ?? 5e3;
+    if (flushInterval > 0) {
+      this.flushTimer = setInterval(() => this.flush().catch(() => {
+      }), flushInterval);
+      if (typeof this.flushTimer === "object" && "unref" in this.flushTimer) {
+        this.flushTimer.unref();
+      }
+    }
+  }
+  // ── Agents ──────────────────────────────────────────────────────
+  async createAgent(input) {
+    return this.request("POST", "/agents", input);
+  }
+  // ── Sessions ────────────────────────────────────────────────────
+  async createSession(input) {
+    return this.request("POST", "/sessions", input);
+  }
+  // ── Events ──────────────────────────────────────────────────────
+  /**
+   * Queue an event for batched sending. Events are auto-flushed at
+   * the configured `flushInterval` or when the batch reaches `maxBatchSize`.
+   * Returns immediately — call `flush()` to send synchronously.
+   */
+  track(event) {
+    this.queue.push(event);
+    if (this.queue.length >= this.maxBatchSize) {
+      this.flush().catch(() => {
+      });
+    }
+  }
+  /**
+   * Send all queued events to the server immediately.
+   * Resolves with the created events, or an empty array if the queue was empty.
+   */
+  async flush() {
+    if (this.queue.length === 0) return [];
+    const batch = this.queue.splice(0);
+    try {
+      return await this.request("POST", "/events", { events: batch });
+    } catch (err) {
+      this.queue.unshift(...batch);
+      throw err;
+    }
+  }
+  /**
+   * Stop the auto-flush timer and send remaining events.
+   * Call this before your process exits.
+   */
+  async shutdown() {
+    if (this.flushTimer) {
+      clearInterval(this.flushTimer);
+      this.flushTimer = null;
+    }
+    await this.flush();
+  }
+  // ── HTTP helper ─────────────────────────────────────────────────
+  async request(method, path, body) {
+    return this.withRetry(async () => {
+      const controller = new AbortController();
+      const timer = setTimeout(() => controller.abort(), this.timeout);
+      try {
+        const res = await fetch(`${this.baseUrl}${path}`, {
+          method,
+          headers: {
+            "Content-Type": "application/json",
+            "x-api-key": this.apiKey
+          },
+          body: body ? JSON.stringify(body) : void 0,
+          signal: controller.signal
+        });
+        if (res.status === 401) throw new AuthenticationError();
+        if (!res.ok) {
+          const text = await res.text().catch(() => "");
+          throw new NetworkError(`HTTP ${res.status}: ${text}`);
+        }
+        return await res.json();
+      } finally {
+        clearTimeout(timer);
+      }
+    });
+  }
+  async withRetry(fn, attempts = 3) {
+    for (let i = 0; i < attempts; i++) {
+      try {
+        return await fn();
+      } catch (err) {
+        if (err instanceof AuthenticationError) throw err;
+        if (i === attempts - 1) throw err;
+        if (this.debug) console.warn(`[AgentLedger] Retry ${i + 1}/${attempts - 1}`, err);
+        await new Promise((r) => setTimeout(r, Math.pow(2, i) * 500));
+      }
+    }
+    throw new AgentLedgerError("Unreachable", "INTERNAL");
+  }
+};
+export {
+  AgentLedger,
+  AgentLedgerError,
+  AuthenticationError,
+  NetworkError
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@2434addy/agentledger-sdk",
+  "version": "0.2.0",
+  "description": "TypeScript SDK for AgentLedger — track, audit, and monitor your AI agents.",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "lint": "tsc --noEmit"
+  },
+  "keywords": [
+    "ai-agents",
+    "audit-trail",
+    "compliance",
+    "observability",
+    "monitoring",
+    "langchain",
+    "openai",
+    "crewai"
+  ],
+  "author": "AgentLedger",
+  "license": "MIT",
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/2434addy/AgentLedger.git",
+    "directory": "sdk"
+  }
+}