@cleocode/lafs-protocol 1.0.0 → 1.2.0

package/README.md

@@ -4,7 +4,10 @@
 
 LAFS defines a standard envelope format for structured responses from LLM-powered agents and tools. It complements transport protocols like [MCP](https://modelcontextprotocol.io/) and [A2A](https://github.com/google/A2A) by standardizing what comes back — not how it gets there.
 
-**Current version:** 0.5.0 | [Spec](lafs.md) | [Migration Guides](migrations/)
+**Current version:** 1.0.0 | [📚 Documentation](https://codluv.gitbook.io/lafs-protocol/) | [Spec](lafs.md) | [Migration Guides](migrations/)
+
+[![GitBook](https://img.shields.io/badge/docs-gitbook-blue)](https://codluv.gitbook.io/lafs-protocol/)
+[![npm](https://img.shields.io/npm/v/@cleocode/lafs-protocol)](https://www.npmjs.com/package/@cleocode/lafs-protocol)
 
 ## What LAFS provides
 
@@ -17,7 +20,7 @@ LAFS defines a standard envelope format for structured responses from LLM-powere
 | **Tooling** | `src/` | TypeScript validation, conformance runner, CLI diagnostic tool |
 | **Tests** | `tests/` | 31 tests covering envelope, pagination, strict mode, error handling |
 | **Fixtures** | `fixtures/` | 14 JSON fixtures (valid + invalid) for conformance testing |
-| **Docs** | `docs/` | Positioning, vision, conformance tiers, deprecation policy |
+| **Docs** | `docs/` | [GitBook documentation](https://codluv.gitbook.io/lafs-protocol/) with guides, SDK reference, and specs |
 
 ## Install
 
@@ -64,7 +67,7 @@ npm run typecheck
 {
   "$schema": "https://lafs.dev/schemas/v1/envelope.schema.json",
   "_meta": {
-    "specVersion": "0.5.0",
+    "specVersion": "1.0.0",
     "schemaVersion": "1.0.0",
     "timestamp": "2026-02-13T00:00:00Z",
     "operation": "example.list",
@@ -139,6 +142,7 @@ CONTRIBUTING.md                  # Contributor guidelines, RFC process
 
 | Version | Phase | Description |
 |---------|-------|-------------|
+| **v1.0.0** | **3** | **Production release: Token budgets, agent discovery, MCP integration, complete SDKs** |
 | v0.5.0 | 2B | Conditional pagination, MVI field selection/expansion, context ledger schema |
 | v0.4.0 | 2A | Optional page/error, extensions, strict/lenient mode, warnings |
 | v0.3.0 | 1 | Strategic positioning, vision alignment, adoption tiers |

package/dist/schemas/v1/envelope.schema.json

@@ -67,6 +67,12 @@
                     "type": "integer",
                     "minimum": 0
                 },
+                "sessionId": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 256,
+                    "description": "Session identifier for correlating multi-step agent workflows"
+                },
                 "warnings": {
                     "type": "array",
                     "items": {

package/dist/src/a2a/bridge.d.ts

@@ -0,0 +1,129 @@
+/**
+ * LAFS A2A Bridge
+ *
+ * Integration with official @a2a-js/sdk for Agent-to-Agent communication.
+ * LAFS provides envelope wrapping and token budget support.
+ */
+import { A2AClient } from '@a2a-js/sdk/client';
+import { Artifact, Part, SendMessageResponse, JSONRPCErrorResponse } from '@a2a-js/sdk';
+export interface LafsA2AConfig {
+    defaultBudget?: {
+        maxTokens?: number;
+        maxItems?: number;
+    };
+    envelopeResponses?: boolean;
+}
+export interface LafsEnvelope {
+    $schema: string;
+    _meta: {
+        specVersion: string;
+        operation: string;
+        requestId: string;
+        mvi: string;
+        _tokenEstimate?: {
+            estimated: number;
+            budget?: number;
+        };
+    };
+    success: boolean;
+    result: unknown;
+    error: null | {
+        code: string;
+        message: string;
+        category: string;
+        retryable: boolean;
+    };
+}
+/**
+ * Wrap A2A client with LAFS envelope support
+ *
+ * @example
+ * ```typescript
+ * import { ClientFactory } from '@a2a-js/sdk/client';
+ * import { withLafsEnvelope } from '@lafs/envelope/a2a';
+ *
+ * const factory = new ClientFactory();
+ * const a2aClient = await factory.createFromUrl('http://localhost:4000');
+ *
+ * const client = withLafsEnvelope(a2aClient, {
+ *   envelopeResponses: true,
+ *   defaultBudget: { maxTokens: 4000 }
+ * });
+ *
+ * const result = await client.sendMessage({
+ *   message: { role: 'user', parts: [{ text: 'Hello' }] }
+ * });
+ *
+ * // Access LAFS envelope
+ * const envelope = result.getLafsEnvelope();
+ * console.log(envelope._meta._tokenEstimate);
+ * ```
+ */
+export declare function withLafsEnvelope(client: A2AClient, config?: LafsA2AConfig): LafsA2AClient;
+export declare class LafsA2AClient {
+    private client;
+    private config;
+    constructor(client: A2AClient, config: LafsA2AConfig);
+    sendMessage(params: {
+        message: {
+            role: 'user' | 'agent';
+            parts: Part[];
+        };
+        budget?: {
+            maxTokens?: number;
+            maxItems?: number;
+        };
+    }): Promise<LafsA2AResult>;
+    private generateId;
+}
+export declare class LafsA2AResult {
+    private result;
+    private budget;
+    constructor(result: SendMessageResponse, budget: {
+        maxTokens?: number;
+        maxItems?: number;
+    });
+    /**
+     * Get the underlying A2A result
+     */
+    getA2AResult(): SendMessageResponse;
+    /**
+     * Check if result is an error
+     */
+    isError(): boolean;
+    /**
+     * Get error details if result is an error
+     */
+    getError(): JSONRPCErrorResponse | null;
+    /**
+     * Extract LAFS envelope from A2A artifact
+     */
+    getLafsEnvelope(): LafsEnvelope | null;
+    /**
+     * Check if result contains LAFS envelope
+     */
+    hasLafsEnvelope(): boolean;
+    /**
+     * Get token estimate from envelope
+     */
+    getTokenEstimate(): {
+        estimated: number;
+        budget?: number;
+    } | null;
+    private isLafsEnvelope;
+}
+/**
+ * Create a LAFS artifact for A2A
+ *
+ * @example
+ * ```typescript
+ * const artifact = createLafsArtifact({
+ *   success: true,
+ *   result: { data: '...' },
+ *   meta: { operation: 'analysis.run' }
+ * });
+ *
+ * task.artifacts.push(artifact);
+ * ```
+ */
+export declare function createLafsArtifact(envelope: LafsEnvelope): Artifact;

package/dist/src/a2a/bridge.js

@@ -0,0 +1,173 @@
+/**
+ * LAFS A2A Bridge
+ *
+ * Integration with official @a2a-js/sdk for Agent-to-Agent communication.
+ * LAFS provides envelope wrapping and token budget support.
+ */
+/**
+ * Wrap A2A client with LAFS envelope support
+ *
+ * @example
+ * ```typescript
+ * import { ClientFactory } from '@a2a-js/sdk/client';
+ * import { withLafsEnvelope } from '@lafs/envelope/a2a';
+ *
+ * const factory = new ClientFactory();
+ * const a2aClient = await factory.createFromUrl('http://localhost:4000');
+ *
+ * const client = withLafsEnvelope(a2aClient, {
+ *   envelopeResponses: true,
+ *   defaultBudget: { maxTokens: 4000 }
+ * });
+ *
+ * const result = await client.sendMessage({
+ *   message: { role: 'user', parts: [{ text: 'Hello' }] }
+ * });
+ *
+ * // Access LAFS envelope
+ * const envelope = result.getLafsEnvelope();
+ * console.log(envelope._meta._tokenEstimate);
+ * ```
+ */
+export function withLafsEnvelope(client, config = {}) {
+    return new LafsA2AClient(client, config);
+}
+export class LafsA2AClient {
+    client;
+    config;
+    constructor(client, config) {
+        this.client = client;
+        this.config = config;
+    }
+    async sendMessage(params) {
+        // Merge budget with defaults
+        const budget = {
+            ...this.config.defaultBudget,
+            ...params.budget
+        };
+        // Send via official A2A SDK
+        const result = await this.client.sendMessage({
+            message: {
+                kind: 'message',
+                messageId: this.generateId(),
+                role: params.message.role,
+                parts: params.message.parts
+            }
+        });
+        // Wrap result with LAFS envelope support
+        return new LafsA2AResult(result, budget);
+    }
+    generateId() {
+        return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+            const r = Math.random() * 16 | 0;
+            const v = c === 'x' ? r : (r & 0x3 | 0x8);
+            return v.toString(16);
+        });
+    }
+}
+export class LafsA2AResult {
+    result;
+    budget;
+    constructor(result, budget) {
+        this.result = result;
+        this.budget = budget;
+    }
+    /**
+     * Get the underlying A2A result
+     */
+    getA2AResult() {
+        return this.result;
+    }
+    /**
+     * Check if result is an error
+     */
+    isError() {
+        return 'error' in this.result;
+    }
+    /**
+     * Get error details if result is an error
+     */
+    getError() {
+        if (this.isError()) {
+            return this.result;
+        }
+        return null;
+    }
+    /**
+     * Extract LAFS envelope from A2A artifact
+     */
+    getLafsEnvelope() {
+        if (this.isError()) {
+            return null;
+        }
+        const successResult = this.result;
+        // Check if result is a Task
+        if (successResult.result?.kind !== 'task') {
+            return null;
+        }
+        const task = successResult.result;
+        if (!task.artifacts || task.artifacts.length === 0) {
+            return null;
+        }
+        // Find LAFS envelope in artifacts
+        for (const artifact of task.artifacts) {
+            for (const part of artifact.parts) {
+                if (part.kind === 'data' && this.isLafsEnvelope(part.data)) {
+                    return part.data;
+                }
+            }
+        }
+        return null;
+    }
+    /**
+     * Check if result contains LAFS envelope
+     */
+    hasLafsEnvelope() {
+        return this.getLafsEnvelope() !== null;
+    }
+    /**
+     * Get token estimate from envelope
+     */
+    getTokenEstimate() {
+        const envelope = this.getLafsEnvelope();
+        return envelope?._meta?._tokenEstimate ?? null;
+    }
+    isLafsEnvelope(data) {
+        return (typeof data === 'object' &&
+            data !== null &&
+            '$schema' in data &&
+            '_meta' in data &&
+            'success' in data);
+    }
+}
+/**
+ * Create a LAFS artifact for A2A
+ *
+ * @example
+ * ```typescript
+ * const artifact = createLafsArtifact({
+ *   success: true,
+ *   result: { data: '...' },
+ *   meta: { operation: 'analysis.run' }
+ * });
+ *
+ * task.artifacts.push(artifact);
+ * ```
+ */
+export function createLafsArtifact(envelope) {
+    return {
+        artifactId: generateId(),
+        name: 'lafs_response',
+        parts: [{
+                kind: 'data',
+                data: envelope
+            }]
+    };
+}
+function generateId() {
+    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+        const r = Math.random() * 16 | 0;
+        const v = c === 'x' ? r : (r & 0x3 | 0x8);
+        return v.toString(16);
+    });
+}

package/dist/src/a2a/index.d.ts

@@ -0,0 +1,36 @@
+/**
+ * LAFS Agent-to-Agent (A2A) Integration
+ *
+ * This module provides integration between LAFS and the official
+ * @a2a-js/sdk for Agent-to-Agent communication.
+ *
+ * @example
+ * ```typescript
+ * import { ClientFactory } from '@a2a-js/sdk/client';
+ * import { withLafsEnvelope } from '@cleocode/lafs-protocol/a2a';
+ *
+ * // Create official A2A client
+ * const factory = new ClientFactory();
+ * const a2aClient = await factory.createFromUrl('http://agent.example.com');
+ *
+ * // Wrap with LAFS support
+ * const client = withLafsEnvelope(a2aClient, {
+ *   defaultBudget: { maxTokens: 4000 }
+ * });
+ *
+ * // Send message
+ * const result = await client.sendMessage({
+ *   message: {
+ *     role: 'user',
+ *     parts: [{ text: 'Analyze data' }]
+ *   }
+ * });
+ *
+ * // Extract LAFS envelope from response
+ * const envelope = result.getLafsEnvelope();
+ * if (envelope) {
+ *   console.log(envelope._meta._tokenEstimate);
+ * }
+ * ```
+ */
+export { withLafsEnvelope, LafsA2AClient, LafsA2AResult, createLafsArtifact, type LafsA2AConfig, type LafsEnvelope } from './bridge.js';

package/dist/src/a2a/index.js

@@ -0,0 +1,36 @@
+/**
+ * LAFS Agent-to-Agent (A2A) Integration
+ *
+ * This module provides integration between LAFS and the official
+ * @a2a-js/sdk for Agent-to-Agent communication.
+ *
+ * @example
+ * ```typescript
+ * import { ClientFactory } from '@a2a-js/sdk/client';
+ * import { withLafsEnvelope } from '@cleocode/lafs-protocol/a2a';
+ *
+ * // Create official A2A client
+ * const factory = new ClientFactory();
+ * const a2aClient = await factory.createFromUrl('http://agent.example.com');
+ *
+ * // Wrap with LAFS support
+ * const client = withLafsEnvelope(a2aClient, {
+ *   defaultBudget: { maxTokens: 4000 }
+ * });
+ *
+ * // Send message
+ * const result = await client.sendMessage({
+ *   message: {
+ *     role: 'user',
+ *     parts: [{ text: 'Analyze data' }]
+ *   }
+ * });
+ *
+ * // Extract LAFS envelope from response
+ * const envelope = result.getLafsEnvelope();
+ * if (envelope) {
+ *   console.log(envelope._meta._tokenEstimate);
+ * }
+ * ```
+ */
+export { withLafsEnvelope, LafsA2AClient, LafsA2AResult, createLafsArtifact } from './bridge.js';

package/dist/src/circuit-breaker/index.d.ts

@@ -0,0 +1,121 @@
+/**
+ * LAFS Circuit Breaker Module
+ *
+ * Provides circuit breaker pattern for resilient service calls
+ */
+export type CircuitState = 'CLOSED' | 'OPEN' | 'HALF_OPEN';
+export interface CircuitBreakerConfig {
+    name: string;
+    failureThreshold?: number;
+    resetTimeout?: number;
+    halfOpenMaxCalls?: number;
+    successThreshold?: number;
+}
+export interface CircuitBreakerMetrics {
+    state: CircuitState;
+    failures: number;
+    successes: number;
+    lastFailureTime?: Date;
+    consecutiveSuccesses: number;
+    totalCalls: number;
+}
+export declare class CircuitBreakerError extends Error {
+    constructor(message: string);
+}
+/**
+ * Circuit breaker for protecting against cascading failures
+ *
+ * @example
+ * ```typescript
+ * import { CircuitBreaker } from '@cleocode/lafs-protocol/circuit-breaker';
+ *
+ * const breaker = new CircuitBreaker({
+ *   name: 'external-api',
+ *   failureThreshold: 5,
+ *   resetTimeout: 30000
+ * });
+ *
+ * try {
+ *   const result = await breaker.execute(async () => {
+ *     return await externalApi.call();
+ *   });
+ * } catch (error) {
+ *   if (error instanceof CircuitBreakerError) {
+ *     console.log('Circuit breaker is open');
+ *   }
+ * }
+ * ```
+ */
+export declare class CircuitBreaker {
+    private config;
+    private state;
+    private failures;
+    private successes;
+    private lastFailureTime?;
+    private consecutiveSuccesses;
+    private totalCalls;
+    private halfOpenCalls;
+    private resetTimer?;
+    constructor(config: CircuitBreakerConfig);
+    /**
+     * Execute a function with circuit breaker protection
+     */
+    execute<T>(fn: () => Promise<T>): Promise<T>;
+    /**
+     * Get current circuit breaker state
+     */
+    getState(): CircuitState;
+    /**
+     * Get circuit breaker metrics
+     */
+    getMetrics(): CircuitBreakerMetrics;
+    /**
+     * Manually open the circuit breaker
+     */
+    forceOpen(): void;
+    /**
+     * Manually close the circuit breaker
+     */
+    forceClose(): void;
+    private onSuccess;
+    private onFailure;
+    private transitionTo;
+    private shouldAttemptReset;
+    private scheduleReset;
+    private reset;
+}
+/**
+ * Circuit breaker registry for managing multiple breakers
+ *
+ * @example
+ * ```typescript
+ * const registry = new CircuitBreakerRegistry();
+ *
+ * registry.add('payment-api', {
+ *   failureThreshold: 3,
+ *   resetTimeout: 60000
+ * });
+ *
+ * const paymentBreaker = registry.get('payment-api');
+ * ```
+ */
+export declare class CircuitBreakerRegistry {
+    private breakers;
+    add(name: string, config: Omit<CircuitBreakerConfig, 'name'>): CircuitBreaker;
+    get(name: string): CircuitBreaker | undefined;
+    getOrCreate(name: string, config: Omit<CircuitBreakerConfig, 'name'>): CircuitBreaker;
+    getAllMetrics(): Record<string, CircuitBreakerMetrics>;
+    resetAll(): void;
+}
+/**
+ * Create a circuit breaker middleware for Express
+ *
+ * @example
+ * ```typescript
+ * app.use('/external-api', circuitBreakerMiddleware({
+ *   name: 'external-api',
+ *   failureThreshold: 5
+ * }));
+ * ```
+ */
+export declare function circuitBreakerMiddleware(config: CircuitBreakerConfig): (req: any, res: any, next: any) => Promise<void>;