@cleocode/lafs-protocol 1.0.0 → 1.2.0

package/dist/src/circuit-breaker/index.js

@@ -0,0 +1,249 @@
+/**
+ * LAFS Circuit Breaker Module
+ *
+ * Provides circuit breaker pattern for resilient service calls
+ */
+export class CircuitBreakerError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'CircuitBreakerError';
+    }
+}
+/**
+ * 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 class CircuitBreaker {
+    config;
+    state = 'CLOSED';
+    failures = 0;
+    successes = 0;
+    lastFailureTime;
+    consecutiveSuccesses = 0;
+    totalCalls = 0;
+    halfOpenCalls = 0;
+    resetTimer;
+    constructor(config) {
+        this.config = config;
+        this.config = {
+            failureThreshold: 5,
+            resetTimeout: 30000,
+            halfOpenMaxCalls: 3,
+            successThreshold: 2,
+            ...config
+        };
+    }
+    /**
+     * Execute a function with circuit breaker protection
+     */
+    async execute(fn) {
+        this.totalCalls++;
+        if (this.state === 'OPEN') {
+            if (this.shouldAttemptReset()) {
+                this.transitionTo('HALF_OPEN');
+            }
+            else {
+                throw new CircuitBreakerError(`Circuit breaker '${this.config.name}' is OPEN`);
+            }
+        }
+        if (this.state === 'HALF_OPEN') {
+            if (this.halfOpenCalls >= (this.config.halfOpenMaxCalls || 3)) {
+                throw new CircuitBreakerError(`Circuit breaker '${this.config.name}' is HALF_OPEN (max calls reached)`);
+            }
+            this.halfOpenCalls++;
+        }
+        try {
+            const result = await fn();
+            this.onSuccess();
+            return result;
+        }
+        catch (error) {
+            this.onFailure();
+            throw error;
+        }
+    }
+    /**
+     * Get current circuit breaker state
+     */
+    getState() {
+        return this.state;
+    }
+    /**
+     * Get circuit breaker metrics
+     */
+    getMetrics() {
+        return {
+            state: this.state,
+            failures: this.failures,
+            successes: this.successes,
+            lastFailureTime: this.lastFailureTime,
+            consecutiveSuccesses: this.consecutiveSuccesses,
+            totalCalls: this.totalCalls
+        };
+    }
+    /**
+     * Manually open the circuit breaker
+     */
+    forceOpen() {
+        this.transitionTo('OPEN');
+    }
+    /**
+     * Manually close the circuit breaker
+     */
+    forceClose() {
+        this.transitionTo('CLOSED');
+        this.reset();
+    }
+    onSuccess() {
+        this.successes++;
+        this.consecutiveSuccesses++;
+        if (this.state === 'HALF_OPEN') {
+            if (this.consecutiveSuccesses >= (this.config.successThreshold || 2)) {
+                this.transitionTo('CLOSED');
+                this.reset();
+            }
+        }
+    }
+    onFailure() {
+        this.failures++;
+        this.consecutiveSuccesses = 0;
+        this.lastFailureTime = new Date();
+        if (this.state === 'HALF_OPEN') {
+            this.transitionTo('OPEN');
+            this.scheduleReset();
+        }
+        else if (this.state === 'CLOSED') {
+            if (this.failures >= (this.config.failureThreshold || 5)) {
+                this.transitionTo('OPEN');
+                this.scheduleReset();
+            }
+        }
+    }
+    transitionTo(newState) {
+        console.log(`Circuit breaker '${this.config.name}': ${this.state} -> ${newState}`);
+        this.state = newState;
+        if (newState === 'HALF_OPEN') {
+            this.halfOpenCalls = 0;
+        }
+    }
+    shouldAttemptReset() {
+        if (!this.lastFailureTime)
+            return true;
+        const elapsed = Date.now() - this.lastFailureTime.getTime();
+        return elapsed >= (this.config.resetTimeout || 30000);
+    }
+    scheduleReset() {
+        if (this.resetTimer) {
+            clearTimeout(this.resetTimer);
+        }
+        this.resetTimer = setTimeout(() => {
+            if (this.state === 'OPEN') {
+                this.transitionTo('HALF_OPEN');
+            }
+        }, this.config.resetTimeout || 30000);
+    }
+    reset() {
+        this.failures = 0;
+        this.consecutiveSuccesses = 0;
+        this.halfOpenCalls = 0;
+        if (this.resetTimer) {
+            clearTimeout(this.resetTimer);
+            this.resetTimer = undefined;
+        }
+    }
+}
+/**
+ * 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 class CircuitBreakerRegistry {
+    breakers = new Map();
+    add(name, config) {
+        const breaker = new CircuitBreaker({ ...config, name });
+        this.breakers.set(name, breaker);
+        return breaker;
+    }
+    get(name) {
+        return this.breakers.get(name);
+    }
+    getOrCreate(name, config) {
+        let breaker = this.breakers.get(name);
+        if (!breaker) {
+            breaker = this.add(name, config);
+        }
+        return breaker;
+    }
+    getAllMetrics() {
+        const metrics = {};
+        this.breakers.forEach((breaker, name) => {
+            metrics[name] = breaker.getMetrics();
+        });
+        return metrics;
+    }
+    resetAll() {
+        this.breakers.forEach(breaker => breaker.forceClose());
+    }
+}
+/**
+ * Create a circuit breaker middleware for Express
+ *
+ * @example
+ * ```typescript
+ * app.use('/external-api', circuitBreakerMiddleware({
+ *   name: 'external-api',
+ *   failureThreshold: 5
+ * }));
+ * ```
+ */
+export function circuitBreakerMiddleware(config) {
+    const breaker = new CircuitBreaker(config);
+    return async (req, res, next) => {
+        try {
+            await breaker.execute(async () => {
+                next();
+            });
+        }
+        catch (error) {
+            if (error instanceof CircuitBreakerError) {
+                res.status(503).json({
+                    error: 'Service temporarily unavailable',
+                    reason: 'Circuit breaker is open'
+                });
+            }
+            else {
+                throw error;
+            }
+        }
+    };
+}

package/dist/src/flagSemantics.d.ts

@@ -2,6 +2,8 @@ import type { FlagInput } from "./types.js";
 export interface FlagResolution {
     format: "json" | "human";
     source: "flag" | "project" | "user" | "default";
+    /** When true, suppress non-essential output for scripting */
+    quiet: boolean;
 }
 export declare class LAFSFlagError extends Error {
     code: string;

package/dist/src/flagSemantics.js

@@ -10,20 +10,21 @@ export function resolveOutputFormat(input) {
     if (input.humanFlag && input.jsonFlag) {
         throw new LAFSFlagError("E_FORMAT_CONFLICT", "Cannot combine --human and --json in the same invocation.");
     }
+    const quiet = input.quiet ?? false;
     if (input.requestedFormat) {
-        return { format: input.requestedFormat, source: "flag" };
+        return { format: input.requestedFormat, source: "flag", quiet };
     }
     if (input.humanFlag) {
-        return { format: "human", source: "flag" };
+        return { format: "human", source: "flag", quiet };
     }
     if (input.jsonFlag) {
-        return { format: "json", source: "flag" };
+        return { format: "json", source: "flag", quiet };
     }
     if (input.projectDefault) {
-        return { format: input.projectDefault, source: "project" };
+        return { format: input.projectDefault, source: "project", quiet };
     }
     if (input.userDefault) {
-        return { format: input.userDefault, source: "user" };
+        return { format: input.userDefault, source: "user", quiet };
     }
-    return { format: "json", source: "default" };
+    return { format: "json", source: "default", quiet };
 }

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

@@ -0,0 +1,105 @@
+/**
+ * LAFS Health Check Module
+ *
+ * Provides health check endpoints for monitoring and orchestration
+ */
+export interface HealthCheckConfig {
+    path?: string;
+    checks?: HealthCheckFunction[];
+}
+export type HealthCheckFunction = () => Promise<HealthCheckResult> | HealthCheckResult;
+export interface HealthCheckResult {
+    name: string;
+    status: 'ok' | 'warning' | 'error';
+    message?: string;
+    duration?: number;
+}
+export interface HealthStatus {
+    status: 'healthy' | 'degraded' | 'unhealthy';
+    timestamp: string;
+    version: string;
+    uptime: number;
+    checks: HealthCheckResult[];
+}
+/**
+ * Health check middleware for Express applications
+ *
+ * @example
+ * ```typescript
+ * import express from 'express';
+ * import { healthCheck } from '@cleocode/lafs-protocol/health';
+ *
+ * const app = express();
+ *
+ * // Basic health check
+ * app.use('/health', healthCheck());
+ *
+ * // Custom health checks
+ * app.use('/health', healthCheck({
+ *   checks: [
+ *     async () => ({
+ *       name: 'database',
+ *       status: await checkDatabase() ? 'ok' : 'error'
+ *     })
+ *   ]
+ * }));
+ * ```
+ */
+export declare function healthCheck(config?: HealthCheckConfig): (req: any, res: any) => Promise<void>;
+/**
+ * Create a database health check
+ *
+ * @example
+ * ```typescript
+ * const dbCheck = createDatabaseHealthCheck({
+ *   checkConnection: async () => await db.ping()
+ * });
+ *
+ * app.use('/health', healthCheck({
+ *   checks: [dbCheck]
+ * }));
+ * ```
+ */
+export declare function createDatabaseHealthCheck(config: {
+    checkConnection: () => Promise<boolean>;
+    name?: string;
+}): HealthCheckFunction;
+/**
+ * Create an external service health check
+ *
+ * @example
+ * ```typescript
+ * const apiCheck = createExternalServiceHealthCheck({
+ *   name: 'payment-api',
+ *   url: 'https://api.payment.com/health',
+ *   timeout: 5000
+ * });
+ * ```
+ */
+export declare function createExternalServiceHealthCheck(config: {
+    name: string;
+    url: string;
+    timeout?: number;
+}): HealthCheckFunction;
+/**
+ * Liveness probe - basic check that service is running
+ *
+ * @example
+ * ```typescript
+ * app.get('/health/live', livenessProbe());
+ * ```
+ */
+export declare function livenessProbe(): (req: any, res: any) => void;
+/**
+ * Readiness probe - check that service is ready to accept traffic
+ *
+ * @example
+ * ```typescript
+ * app.get('/health/ready', readinessProbe({
+ *   checks: [dbCheck, cacheCheck]
+ * }));
+ * ```
+ */
+export declare function readinessProbe(config?: {
+    checks?: HealthCheckFunction[];
+}): (req: any, res: any) => Promise<void>;

package/dist/src/health/index.js

@@ -0,0 +1,211 @@
+/**
+ * LAFS Health Check Module
+ *
+ * Provides health check endpoints for monitoring and orchestration
+ */
+/**
+ * Health check middleware for Express applications
+ *
+ * @example
+ * ```typescript
+ * import express from 'express';
+ * import { healthCheck } from '@cleocode/lafs-protocol/health';
+ *
+ * const app = express();
+ *
+ * // Basic health check
+ * app.use('/health', healthCheck());
+ *
+ * // Custom health checks
+ * app.use('/health', healthCheck({
+ *   checks: [
+ *     async () => ({
+ *       name: 'database',
+ *       status: await checkDatabase() ? 'ok' : 'error'
+ *     })
+ *   ]
+ * }));
+ * ```
+ */
+export function healthCheck(config = {}) {
+    const { path = '/health', checks = [] } = config;
+    const startTime = Date.now();
+    return async (req, res) => {
+        const timestamp = new Date().toISOString();
+        const checkResults = [];
+        // Run all health checks
+        for (const check of checks) {
+            const start = Date.now();
+            try {
+                const result = await check();
+                result.duration = Date.now() - start;
+                checkResults.push(result);
+            }
+            catch (error) {
+                checkResults.push({
+                    name: 'unknown',
+                    status: 'error',
+                    message: error instanceof Error ? error.message : 'Check failed',
+                    duration: Date.now() - start
+                });
+            }
+        }
+        // Add default checks
+        checkResults.push({
+            name: 'envelopeValidation',
+            status: 'ok'
+        });
+        checkResults.push({
+            name: 'tokenBudgets',
+            status: 'ok'
+        });
+        // Determine overall status
+        const hasErrors = checkResults.some(c => c.status === 'error');
+        const hasWarnings = checkResults.some(c => c.status === 'warning');
+        const status = hasErrors
+            ? 'unhealthy'
+            : hasWarnings
+                ? 'degraded'
+                : 'healthy';
+        const health = {
+            status,
+            timestamp,
+            version: process.env.npm_package_version || '1.1.0',
+            uptime: Math.floor((Date.now() - startTime) / 1000),
+            checks: checkResults
+        };
+        const statusCode = status === 'healthy' ? 200 : status === 'degraded' ? 200 : 503;
+        res.status(statusCode).json(health);
+    };
+}
+/**
+ * Create a database health check
+ *
+ * @example
+ * ```typescript
+ * const dbCheck = createDatabaseHealthCheck({
+ *   checkConnection: async () => await db.ping()
+ * });
+ *
+ * app.use('/health', healthCheck({
+ *   checks: [dbCheck]
+ * }));
+ * ```
+ */
+export function createDatabaseHealthCheck(config) {
+    return async () => {
+        try {
+            const isConnected = await config.checkConnection();
+            return {
+                name: config.name || 'database',
+                status: isConnected ? 'ok' : 'error',
+                message: isConnected ? 'Connected' : 'Connection failed'
+            };
+        }
+        catch (error) {
+            return {
+                name: config.name || 'database',
+                status: 'error',
+                message: error instanceof Error ? error.message : 'Database check failed'
+            };
+        }
+    };
+}
+/**
+ * Create an external service health check
+ *
+ * @example
+ * ```typescript
+ * const apiCheck = createExternalServiceHealthCheck({
+ *   name: 'payment-api',
+ *   url: 'https://api.payment.com/health',
+ *   timeout: 5000
+ * });
+ * ```
+ */
+export function createExternalServiceHealthCheck(config) {
+    return async () => {
+        const start = Date.now();
+        try {
+            const controller = new AbortController();
+            const timeout = setTimeout(() => controller.abort(), config.timeout || 5000);
+            const response = await fetch(config.url, {
+                signal: controller.signal
+            });
+            clearTimeout(timeout);
+            return {
+                name: config.name,
+                status: response.ok ? 'ok' : 'error',
+                message: response.ok ? 'Service healthy' : `HTTP ${response.status}`,
+                duration: Date.now() - start
+            };
+        }
+        catch (error) {
+            return {
+                name: config.name,
+                status: 'error',
+                message: error instanceof Error ? error.message : 'Service unreachable',
+                duration: Date.now() - start
+            };
+        }
+    };
+}
+/**
+ * Liveness probe - basic check that service is running
+ *
+ * @example
+ * ```typescript
+ * app.get('/health/live', livenessProbe());
+ * ```
+ */
+export function livenessProbe() {
+    return (req, res) => {
+        res.status(200).json({
+            status: 'alive',
+            timestamp: new Date().toISOString()
+        });
+    };
+}
+/**
+ * Readiness probe - check that service is ready to accept traffic
+ *
+ * @example
+ * ```typescript
+ * app.get('/health/ready', readinessProbe({
+ *   checks: [dbCheck, cacheCheck]
+ * }));
+ * ```
+ */
+export function readinessProbe(config = {}) {
+    return async (req, res) => {
+        const checkResults = [];
+        if (config.checks) {
+            for (const check of config.checks) {
+                try {
+                    const result = await check();
+                    checkResults.push(result);
+                }
+                catch (error) {
+                    checkResults.push({
+                        name: 'unknown',
+                        status: 'error',
+                        message: error instanceof Error ? error.message : 'Check failed'
+                    });
+                }
+            }
+        }
+        const hasErrors = checkResults.some(c => c.status === 'error');
+        if (hasErrors) {
+            res.status(503).json({
+                status: 'not ready',
+                checks: checkResults
+            });
+        }
+        else {
+            res.status(200).json({
+                status: 'ready',
+                checks: checkResults
+            });
+        }
+    };
+}

package/dist/src/index.d.ts

@@ -7,3 +7,7 @@ export * from "./tokenEstimator.js";
 export * from "./budgetEnforcement.js";
 export * from "./mcpAdapter.js";
 export * from "./discovery.js";
+export * from "./health/index.js";
+export * from "./shutdown/index.js";
+export * from "./circuit-breaker/index.js";
+export * from "./a2a/index.js";

package/dist/src/index.js

@@ -7,3 +7,9 @@ export * from "./tokenEstimator.js";
 export * from "./budgetEnforcement.js";
 export * from "./mcpAdapter.js";
 export * from "./discovery.js";
+// Operations & Reliability
+export * from "./health/index.js";
+export * from "./shutdown/index.js";
+export * from "./circuit-breaker/index.js";
+// A2A Integration
+export * from "./a2a/index.js";

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

@@ -0,0 +1,69 @@
+/**
+ * LAFS Graceful Shutdown Module
+ *
+ * Handles graceful shutdown of LAFS servers
+ */
+import { Server } from 'http';
+export interface GracefulShutdownConfig {
+    timeout?: number;
+    signals?: NodeJS.Signals[];
+    onShutdown?: () => Promise<void> | void;
+    onClose?: () => Promise<void> | void;
+}
+export interface ShutdownState {
+    isShuttingDown: boolean;
+    activeConnections: number;
+    shutdownStartTime?: Date;
+}
+/**
+ * Enable graceful shutdown for an HTTP server
+ *
+ * @example
+ * ```typescript
+ * import express from 'express';
+ * import { gracefulShutdown } from '@cleocode/lafs-protocol/shutdown';
+ *
+ * const app = express();
+ * const server = app.listen(3000);
+ *
+ * gracefulShutdown(server, {
+ *   timeout: 30000,
+ *   signals: ['SIGTERM', 'SIGINT'],
+ *   onShutdown: async () => {
+ *     console.log('Shutting down...');
+ *     await db.close();
+ *   }
+ * });
+ * ```
+ */
+export declare function gracefulShutdown(server: Server, config?: GracefulShutdownConfig): void;
+/**
+ * Check if server is shutting down
+ */
+export declare function isShuttingDown(): boolean;
+/**
+ * Get shutdown state
+ */
+export declare function getShutdownState(): ShutdownState;
+/**
+ * Force immediate shutdown (emergency use only)
+ */
+export declare function forceShutdown(exitCode?: number): void;
+/**
+ * Middleware to reject requests during shutdown
+ *
+ * @example
+ * ```typescript
+ * app.use(shutdownMiddleware());
+ * ```
+ */
+export declare function shutdownMiddleware(): (req: any, res: any, next: any) => void;
+/**
+ * Wait for shutdown to complete
+ *
+ * @example
+ * ```typescript
+ * await waitForShutdown();
+ * ```
+ */
+export declare function waitForShutdown(): Promise<void>;