agentcheck-sdk 0.3.0 → 0.5.0

package/dist/index.d.ts

@@ -4,6 +4,9 @@ export { DelegationProvider } from "./provider";
 export { delegationGuard } from "./guard";
 export { AgentToolChecker } from "./langchain";
 export { DelegationDashboard } from "./dashboard";
+export { quickStart } from "./quickstart";
+export { templates } from "./templates";
+export { TelemetryPlugin } from "./telemetry";
 export type { WebhookEvent } from "./webhook";
 export type { ScopeVerifier, DelegationProviderConfig } from "./provider";
 export type { GuardConfig } from "./guard";

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RateLimitError = exports.ValidationError = exports.NotFoundError = exports.AuthenticationError = exports.AgentCheckError = exports.DelegationDashboard = exports.AgentToolChecker = exports.delegationGuard = exports.DelegationProvider = exports.WebhookHandler = exports.AgentCheckClient = void 0;
+exports.RateLimitError = exports.ValidationError = exports.NotFoundError = exports.AuthenticationError = exports.AgentCheckError = exports.TelemetryPlugin = exports.templates = exports.quickStart = exports.DelegationDashboard = exports.AgentToolChecker = exports.delegationGuard = exports.DelegationProvider = exports.WebhookHandler = exports.AgentCheckClient = void 0;
 // Individual commands (basic menu)
 var client_1 = require("./client");
 Object.defineProperty(exports, "AgentCheckClient", { enumerable: true, get: function () { return client_1.AgentCheckClient; } });
@@ -15,6 +15,12 @@ var langchain_1 = require("./langchain");
 Object.defineProperty(exports, "AgentToolChecker", { enumerable: true, get: function () { return langchain_1.AgentToolChecker; } });
 var dashboard_1 = require("./dashboard");
 Object.defineProperty(exports, "DelegationDashboard", { enumerable: true, get: function () { return dashboard_1.DelegationDashboard; } });
+var quickstart_1 = require("./quickstart");
+Object.defineProperty(exports, "quickStart", { enumerable: true, get: function () { return quickstart_1.quickStart; } });
+var templates_1 = require("./templates");
+Object.defineProperty(exports, "templates", { enumerable: true, get: function () { return templates_1.templates; } });
+var telemetry_1 = require("./telemetry");
+Object.defineProperty(exports, "TelemetryPlugin", { enumerable: true, get: function () { return telemetry_1.TelemetryPlugin; } });
 var errors_1 = require("./errors");
 Object.defineProperty(exports, "AgentCheckError", { enumerable: true, get: function () { return errors_1.AgentCheckError; } });
 Object.defineProperty(exports, "AuthenticationError", { enumerable: true, get: function () { return errors_1.AuthenticationError; } });

package/dist/quickstart.d.ts

@@ -0,0 +1,29 @@
+import { AgentCheckClient } from "./client";
+import { DelegationDashboard } from "./dashboard";
+import { AgentToolChecker } from "./langchain";
+import { DelegationProvider, ScopeVerifier } from "./provider";
+export interface QuickStartConfig {
+    apiKey?: string;
+    baseUrl?: string;
+    verifyScope?: ScopeVerifier;
+}
+export interface AgentCheckBundle {
+    client: AgentCheckClient;
+    provider: DelegationProvider;
+    dashboard: DelegationDashboard;
+    checker: (agentName: string) => AgentToolChecker;
+}
+/**
+ * Setup everything in one call.
+ *
+ * Usage:
+ *   const ac = quickStart({ apiKey: "ak_live_..." });
+ *   // or reads from AGENTCHECK_API_KEY env var
+ *   const ac = quickStart();
+ *
+ *   ac.provider.canAct("bot", "action");
+ *   ac.client.record({ ... });
+ *   ac.dashboard.render();
+ *   const safe = ac.checker("bot").wrap("tool", fn);
+ */
+export declare function quickStart(config?: QuickStartConfig): AgentCheckBundle;

package/dist/quickstart.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.quickStart = quickStart;
+const client_1 = require("./client");
+const dashboard_1 = require("./dashboard");
+const langchain_1 = require("./langchain");
+const provider_1 = require("./provider");
+/**
+ * Setup everything in one call.
+ *
+ * Usage:
+ *   const ac = quickStart({ apiKey: "ak_live_..." });
+ *   // or reads from AGENTCHECK_API_KEY env var
+ *   const ac = quickStart();
+ *
+ *   ac.provider.canAct("bot", "action");
+ *   ac.client.record({ ... });
+ *   ac.dashboard.render();
+ *   const safe = ac.checker("bot").wrap("tool", fn);
+ */
+function quickStart(config = {}) {
+    const apiKey = config.apiKey || process.env.AGENTCHECK_API_KEY || "";
+    const baseUrl = config.baseUrl ||
+        process.env.AGENTCHECK_BASE_URL ||
+        "https://agentcheck.spaceplanning.work";
+    if (!apiKey) {
+        throw new Error("Provide apiKey or set AGENTCHECK_API_KEY environment variable");
+    }
+    const client = new client_1.AgentCheckClient(apiKey, baseUrl);
+    const provider = new provider_1.DelegationProvider(client, {
+        verifyScope: config.verifyScope,
+    });
+    const dashboard = new dashboard_1.DelegationDashboard(client);
+    return {
+        client,
+        provider,
+        dashboard,
+        checker: (agentName) => new langchain_1.AgentToolChecker(provider, agentName),
+    };
+}

package/dist/telemetry.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Telemetry Plugin - Opt-in usage tracking.
+ *
+ * NOT enabled by default. You must explicitly enable it.
+ *
+ * What it tracks:
+ * - Which SDK features are used (record, list, revoke, etc.)
+ * - SDK language and version
+ * - Agent names (for your own analytics)
+ *
+ * What it does NOT track:
+ * - Scope content, email addresses, API keys, payloads
+ */
+export declare class TelemetryPlugin {
+    private static instance;
+    private apiKey;
+    private baseUrl;
+    private buffer;
+    private enabled;
+    private timer;
+    private flushInterval;
+    constructor(apiKey: string, baseUrl?: string, flushInterval?: number);
+    /** Start collecting telemetry (opt-in). */
+    enable(): void;
+    /** Stop collecting telemetry. */
+    disable(): void;
+    /** Record a telemetry event (no-op if not enabled). */
+    static track(event: string, feature?: string, agentName?: string, metadata?: Record<string, unknown>): void;
+    private flush;
+}

package/dist/telemetry.js

@@ -0,0 +1,78 @@
+"use strict";
+/**
+ * Telemetry Plugin - Opt-in usage tracking.
+ *
+ * NOT enabled by default. You must explicitly enable it.
+ *
+ * What it tracks:
+ * - Which SDK features are used (record, list, revoke, etc.)
+ * - SDK language and version
+ * - Agent names (for your own analytics)
+ *
+ * What it does NOT track:
+ * - Scope content, email addresses, API keys, payloads
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TelemetryPlugin = void 0;
+class TelemetryPlugin {
+    constructor(apiKey, baseUrl = "https://agentcheck.spaceplanning.work", flushInterval = 60000) {
+        this.buffer = [];
+        this.enabled = false;
+        this.timer = null;
+        this.apiKey = apiKey;
+        this.baseUrl = baseUrl.replace(/\/$/, "");
+        this.flushInterval = flushInterval;
+    }
+    /** Start collecting telemetry (opt-in). */
+    enable() {
+        this.enabled = true;
+        TelemetryPlugin.instance = this;
+        this.timer = setInterval(() => this.flush(), this.flushInterval);
+    }
+    /** Stop collecting telemetry. */
+    disable() {
+        this.enabled = false;
+        TelemetryPlugin.instance = null;
+        if (this.timer)
+            clearInterval(this.timer);
+        this.flush();
+    }
+    /** Record a telemetry event (no-op if not enabled). */
+    static track(event, feature, agentName, metadata) {
+        const instance = TelemetryPlugin.instance;
+        if (!instance || !instance.enabled)
+            return;
+        instance.buffer.push({
+            event,
+            sdk_language: "typescript",
+            sdk_version: "0.4.0",
+            feature,
+            agent_name: agentName,
+            metadata,
+        });
+        if (instance.buffer.length >= 50) {
+            instance.flush();
+        }
+    }
+    async flush() {
+        if (!this.buffer.length)
+            return;
+        const events = [...this.buffer];
+        this.buffer = [];
+        try {
+            await fetch(`${this.baseUrl}/api/v1/telemetry`, {
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                    "X-API-Key": this.apiKey,
+                },
+                body: JSON.stringify({ events }),
+            });
+        }
+        catch {
+            // Telemetry should never break the app
+        }
+    }
+}
+exports.TelemetryPlugin = TelemetryPlugin;
+TelemetryPlugin.instance = null;

package/dist/templates.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Scope Templates - Pre-built scope definitions for common use cases.
+ *
+ * Usage:
+ *   import { templates } from "agentcheck-sdk";
+ *   client.record({
+ *     agent: "maintenance-bot",
+ *     scope: templates.manufacturing({ maxOrderAmount: 10000 }),
+ *     authorized_by: "manager@company.com",
+ *   });
+ */
+export declare const templates: {
+    manufacturing(opts?: {
+        maxOrderAmount?: number;
+        currency?: string;
+    }): string;
+    customerSupport(opts?: {
+        maxRefund?: number;
+        currency?: string;
+    }): string;
+    devops(opts?: {
+        environments?: string[];
+    }): string;
+    finance(opts?: {
+        maxTransaction?: number;
+        currency?: string;
+        assetClasses?: string[];
+    }): string;
+    dataPipeline(opts?: {
+        databases?: string[];
+    }): string;
+    general(actions: string[]): string;
+};

package/dist/templates.js

@@ -0,0 +1,40 @@
+"use strict";
+/**
+ * Scope Templates - Pre-built scope definitions for common use cases.
+ *
+ * Usage:
+ *   import { templates } from "agentcheck-sdk";
+ *   client.record({
+ *     agent: "maintenance-bot",
+ *     scope: templates.manufacturing({ maxOrderAmount: 10000 }),
+ *     authorized_by: "manager@company.com",
+ *   });
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.templates = void 0;
+exports.templates = {
+    manufacturing(opts = {}) {
+        const { maxOrderAmount = 10000, currency = "USD" } = opts;
+        return `Monitor equipment 24/7. Order replacement parts up to ${currency} ${maxOrderAmount.toLocaleString()}. Generate maintenance reports. Alert on anomalies.`;
+    },
+    customerSupport(opts = {}) {
+        const { maxRefund = 500, currency = "USD" } = opts;
+        return `Access customer profiles (read-only). Issue refunds up to ${currency} ${maxRefund.toLocaleString()}. Create support tickets. Escalate to human agent for amounts over ${currency} ${maxRefund.toLocaleString()}.`;
+    },
+    devops(opts = {}) {
+        const envs = (opts.environments || ["staging"]).join(", ");
+        return `Deploy to ${envs}. Rollback on failure. Monitor server health. Restart services on crash. Cannot modify production database directly.`;
+    },
+    finance(opts = {}) {
+        const { maxTransaction = 10000, currency = "USD" } = opts;
+        const assets = (opts.assetClasses || ["stocks", "bonds"]).join(", ");
+        return `Execute trades up to ${currency} ${maxTransaction.toLocaleString()} per transaction. Asset classes: ${assets}. Generate daily P&L reports. Cannot withdraw funds.`;
+    },
+    dataPipeline(opts = {}) {
+        const dbs = (opts.databases || ["analytics"]).join(", ");
+        return `Read from production database. Write to ${dbs} database(s). Run ETL jobs on schedule. Cannot modify production schema. Cannot delete records.`;
+    },
+    general(actions) {
+        return `Allowed actions: ${actions.join(", ")}.`;
+    },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agentcheck-sdk",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Record what your AI agent is allowed to do",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",