@sekuire/sdk 0.1.10 → 0.1.11

package/README.md

@@ -48,11 +48,75 @@ console.log(response);
 
 ## Features
 
-- ✅ **4 LLM Providers**: OpenAI, Anthropic, Google, Ollama
-- ✅ **Built-in Tools**: Calculator, Web Search, HTTP, File Operations
-- ✅ **Streaming**: Token-by-token responses
-- ✅ **Config-First**: Declarative YAML configuration
-- ✅ **Type-Safe**: Full TypeScript support
+- **4 LLM Providers**: OpenAI, Anthropic, Google, Ollama
+- **Built-in Tools**: Calculator, Web Search, HTTP, File Operations
+- **Streaming**: Token-by-token responses
+- **Config-First**: Declarative YAML configuration
+- **Type-Safe**: Full TypeScript support
+- **Beacon/Heartbeat**: Automatic registration and health reporting
+
+## Deployment Registration (Beacon)
+
+The SDK includes a Beacon system for registering deployed agents with Sekuire and sending periodic heartbeats.
+
+### Getting an Install Token
+
+Before deploying, generate an install token from the dashboard or CLI:
+
+**From Dashboard:**
+1. Go to your workspace
+2. Click "Install Agent"
+3. Generate an install token
+
+**From CLI:**
+```bash
+sekuire install token --workspace ws_xxxx --agent <agent_id>
+```
+
+### Using the SDK with Install Token
+
+Set the required environment variables:
+
+```bash
+export SEKUIRE_AGENT_ID="your-agent-sekuire-id"
+export SEKUIRE_INSTALL_TOKEN="skt_xxxx"  # From dashboard or CLI
+export SEKUIRE_API_URL="https://api.sekuire.ai"  # Optional, defaults to production
+```
+
+Then initialize the SDK:
+
+```typescript
+import { SekuireSDK } from '@sekuire/sdk';
+
+// Create SDK from environment variables (recommended)
+const sdk = SekuireSDK.fromEnv();
+
+// Or with explicit config
+const sdk = new SekuireSDK({
+  agentId: process.env.SEKUIRE_AGENT_ID,
+  installToken: process.env.SEKUIRE_INSTALL_TOKEN,
+  apiUrl: 'https://api.sekuire.ai',
+});
+
+// Start the SDK (bootstraps and begins heartbeat loop)
+await sdk.start();
+
+// Check connection status
+console.log('Connected:', sdk.isConnected());
+
+// Graceful shutdown
+await sdk.shutdown();
+```
+
+### Beacon Configuration Options
+
+| Option | Environment Variable | Description |
+|--------|---------------------|-------------|
+| `installToken` | `SEKUIRE_INSTALL_TOKEN` | Install token from dashboard/CLI (required) |
+| `agentId` | `SEKUIRE_AGENT_ID` | Your agent's sekuire_id (required) |
+| `apiUrl` | `SEKUIRE_API_URL` | API base URL (default: https://api.sekuire.ai) |
+| `heartbeatIntervalSeconds` | - | Heartbeat interval (default: 60) |
+| `capabilities` | - | List of capabilities this agent provides |
 
 ## API Reference
 

package/dist/beacon.d.ts

@@ -3,34 +3,52 @@
  *
  * Automatically registers the agent with Sekuire and sends periodic heartbeats
  * to show online status in the Dashboard.
+ *
+ * Supports two authentication modes:
+ * 1. Install Token (recommended): Use an install token from the dashboard
+ * 2. API Key: Use an API key for SDK-initiated bootstrap (requires workspace)
  */
 export interface BeaconConfig {
     /** Sekuire Core API base URL */
     apiBaseUrl: string;
+    /** Install token from dashboard (preferred for BYOC deployments) */
+    installToken?: string;
     /** API key for authentication (reads from SEKUIRE_API_KEY if not set) */
     apiKey?: string;
     /** Agent ID to register */
     agentId: string;
-    /** Heartbeat interval in milliseconds (default: 60000 = 60 seconds) */
-    heartbeatIntervalMs?: number;
+    /** Workspace ID (required when using API key without install token) */
+    workspaceId?: string;
+    /** Heartbeat interval in seconds (default: 60) */
+    heartbeatIntervalSeconds?: number;
     /** Optional explicit deployment URL (auto-detected if not set) */
     deploymentUrl?: string;
-    /** Optional callback to build a custom heartbeat payload (e.g. signed payloads) */
-    onHeartbeat?: (deploymentUrl: string | undefined) => Promise<Record<string, unknown>>;
+    /** Optional capabilities this agent provides */
+    capabilities?: string[];
     /** Optional callback invoked on status changes */
     onStatusChange?: (status: BeaconStatus) => void;
 }
 export interface BeaconStatus {
     isRunning: boolean;
     installationId?: string;
+    runtimeToken?: string;
     deploymentUrl?: string;
     lastHeartbeat?: Date;
     failedHeartbeats: number;
 }
+export interface BootstrapResponse {
+    installation_id: string;
+    runtime_token: string;
+    refresh_token: string;
+    expires_at: string;
+    heartbeat_interval: number;
+}
 export declare class Beacon {
     private config;
     private intervalId;
     private installationId;
+    private runtimeToken;
+    private refreshToken;
     private lastHeartbeat;
     private failedHeartbeats;
     constructor(config: BeaconConfig);
@@ -48,16 +66,33 @@ export declare class Beacon {
     getStatus(): BeaconStatus;
     /**
      * Bootstrap registration with Sekuire
+     *
+     * Exchanges an install token for runtime credentials (installation_id + runtime_token).
+     * The install token is obtained from the dashboard or CLI.
      */
     private bootstrap;
     /**
-     * Send heartbeat to Sekuire
+     * Send heartbeat (lease renewal) to Sekuire
+     *
+     * Uses the installation-based lease endpoint with runtime token authentication.
      */
     private heartbeat;
+    /**
+     * Refresh the runtime token using the refresh token
+     */
+    private refreshRuntimeToken;
+    /**
+     * Notify status change callback
+     */
+    private notifyStatusChange;
     /**
      * Get API key from environment
      */
     private getApiKey;
+    /**
+     * Get install token from environment
+     */
+    private getInstallToken;
 }
 /**
  * Create a new beacon instance

package/dist/config/loader.d.ts

@@ -71,7 +71,7 @@ export interface LLMConfig {
     base_url?: string;
 }
 export interface MemoryConfig {
-    type: 'in-memory' | 'redis' | 'postgres';
+    type: 'in-memory' | 'buffer' | 'redis' | 'postgres' | 'sqlite' | 'upstash' | 'cloudflare-kv' | 'cloudflare-d1' | 'dynamodb' | 'turso' | 'convex' | string;
     max_messages?: number;
     redis?: {
         url?: string;
@@ -90,6 +90,43 @@ export interface MemoryConfig {
         password?: string;
         tableName?: string;
     };
+    sqlite?: {
+        filename: string;
+        tableName?: string;
+    };
+    upstash?: {
+        url: string;
+        token: string;
+        keyPrefix?: string;
+    };
+    cloudflareKV?: {
+        namespaceId?: string;
+        accountId?: string;
+        apiToken?: string;
+        keyPrefix?: string;
+    };
+    cloudflareD1?: {
+        databaseId?: string;
+        accountId?: string;
+        apiToken?: string;
+        tableName?: string;
+    };
+    dynamodb?: {
+        tableName: string;
+        region?: string;
+        endpoint?: string;
+        createTable?: boolean;
+    };
+    turso?: {
+        url: string;
+        authToken?: string;
+        tableName?: string;
+    };
+    convex?: {
+        url: string;
+        adminKey?: string;
+    };
+    config?: Record<string, unknown>;
 }
 export interface ComplianceConfig {
     framework?: string;