@mxf-dev/core 1.0.0

package/dist/types/MxpTypes.d.ts

@@ -0,0 +1,264 @@
+/**
+ * Copyright 2024 Brad Anderson
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @author Brad Anderson <BradA1878@pm.me>
+ * @repository https://github.com/mxf-dev/mxf
+ * @documentation https://mxf-dev.github.io/mxf/
+ */
+/**
+ * MXP Types and Interfaces
+ *
+ * Defines core types for the Model Exchange Protocol optimization system.
+ * Designed to integrate with existing MXF architecture and services.
+ */
+import { AgentId, ChannelId } from './ChannelContext.js';
+import { ContentFormat } from '../schemas/MessageSchemas.js';
+/**
+ * Cross-environment CryptoKeyPair type (works in both Node.js and browser)
+ */
+export interface MxpCryptoKeyPair {
+    publicKey: unknown;
+    privateKey: unknown;
+}
+/**
+ * MXP Version and Security Levels
+ */
+export declare const MXP_VERSION: "2.0";
+export declare enum SecurityLevel {
+    STANDARD = "standard",// Current MXF security (server-decryptable)
+    ENHANCED = "enhanced",// + audit logging, key escrow
+    REGULATED = "regulated",// + GDPR/HIPAA features, data residency
+    CLASSIFIED = "classified"
+}
+/**
+ * MXP Configuration Interface with Channel and Agent-level Granular Control
+ */
+export interface MxpConfig {
+    version: typeof MXP_VERSION;
+    scope: {
+        channelId?: string;
+        agentId?: string;
+        inheritFromChannel: boolean;
+        overrideSettings: boolean;
+    };
+    modules: {
+        tokenOptimization?: TokenOptimizationConfig;
+        bandwidthOptimization?: BandwidthOptimizationConfig;
+        security?: SecurityConfig;
+        analytics?: AnalyticsConfig;
+    };
+    integration: {
+        useExistingAggregator: boolean;
+        useExistingPatternLearning: boolean;
+        useExistingEventBus: boolean;
+        useExistingMemory: boolean;
+        useSystemLlmService: boolean;
+    };
+}
+/**
+ * Token Optimization Configuration with Granular Feature Control
+ */
+export interface TokenOptimizationConfig {
+    enabled: boolean;
+    strategies: {
+        contextCompression: boolean;
+        promptOptimization: boolean;
+        templateMatching: boolean;
+        entityDeduplication: boolean;
+        toolSchemaReduction: boolean;
+        conversationSummarization: boolean;
+    };
+    settings: {
+        compressionLevel: 'light' | 'standard' | 'aggressive';
+        systemLlmIntegration: boolean;
+        patternLearningIntegration: boolean;
+        contextWindow: {
+            fullContextMessages: number;
+            compressionRatio: number;
+            referenceMode: boolean;
+        };
+        templateEngine: {
+            enabled: boolean;
+            maxTemplates: number;
+            confidenceThreshold: number;
+        };
+    };
+}
+/**
+ * Token Optimization Strategies
+ */
+export type TokenOptimizationStrategy = 'context_compression' | 'prompt_optimization' | 'template_matching' | 'entity_deduplication' | 'tool_schema_reduction' | 'conversation_summarization' | 'all';
+/**
+ * Bandwidth Optimization Configuration
+ */
+export interface BandwidthOptimizationConfig {
+    enabled: boolean;
+    encoding: ContentFormat;
+    compression: 'none' | 'light' | 'standard' | 'aggressive';
+    enhancedBatching: boolean;
+    priorityQueueIntegration: boolean;
+    binaryProtocol: {
+        enabled: boolean;
+        thresholdBytes: number;
+        compressionAlgorithm: 'brotli' | 'gzip' | 'zstd';
+    };
+    messageAggregation: {
+        similarityThreshold: number;
+        maxBatchSize: number;
+        timeoutMs: number;
+    };
+}
+/**
+ * Security Configuration
+ */
+export interface SecurityConfig {
+    enabled: boolean;
+    level: SecurityLevel;
+    features: {
+        auditLogging?: boolean;
+        keyEscrow?: boolean;
+        dataResidency?: string;
+        endToEndEncryption?: boolean;
+        complianceMode?: 'GDPR' | 'HIPAA' | 'SOX' | 'FedRAMP';
+    };
+    keyManagement: {
+        rotationPolicy: 'time' | 'usage' | 'both';
+        rotationInterval: number;
+        keyLength: 256 | 384 | 521;
+        algorithm: 'AES-GCM' | 'ChaCha20-Poly1305';
+        enhanceExistingKeys: boolean;
+    };
+}
+/**
+ * Analytics Configuration
+ */
+export interface AnalyticsConfig {
+    enabled: boolean;
+    realTimeMetrics: boolean;
+    costCalculation: {
+        enabled: boolean;
+        providers: LlmProviderCosts;
+        reportingInterval: 'hourly' | 'daily' | 'weekly' | 'monthly';
+    };
+    performanceTracking: {
+        tokenReduction: boolean;
+        bandwidthSavings: boolean;
+        latencyImpact: boolean;
+        errorRates: boolean;
+    };
+}
+/**
+ * LLM Provider Cost Configuration
+ */
+export interface LlmProviderCosts {
+    [provider: string]: {
+        input: number;
+        output: number;
+    };
+}
+/**
+ * MXP Optimization Result
+ */
+export interface MxpOptimizationResult {
+    operationId: string;
+    timestamp: number;
+    agentId: AgentId;
+    channelId: ChannelId;
+    tokenOptimization?: {
+        originalTokens: number;
+        optimizedTokens: number;
+        reductionPercentage: number;
+        strategy: string;
+    };
+    bandwidthOptimization?: {
+        originalSize: number;
+        compressedSize: number;
+        reductionPercentage: number;
+        encoding: ContentFormat;
+    };
+    security?: {
+        level: SecurityLevel;
+        encryptionApplied: boolean;
+        keyRotated: boolean;
+    };
+    performance: {
+        processingTimeMs: number;
+        memoryUsageMb: number;
+        cpuUtilization: number;
+    };
+    costSavings?: {
+        originalCost: number;
+        optimizedCost: number;
+        savingsAmount: number;
+        savingsPercentage: number;
+    };
+}
+/**
+ * MXP Context Compression Result
+ */
+export interface ContextCompressionResult {
+    originalContext: any;
+    compressedContext: any;
+    compressionRatio: number;
+    contextReference?: string;
+    preservedTokens: number;
+    metadata: {
+        strategy: string;
+        systemLlmUsed: boolean;
+        patternLearningApplied: boolean;
+    };
+}
+/**
+ * MXP Message Template
+ */
+export interface MessageTemplate {
+    templateId: string;
+    pattern: string;
+    placeholders: string[];
+    usage: {
+        frequency: number;
+        lastUsed: number;
+        confidence: number;
+    };
+    tokenSavings: {
+        originalLength: number;
+        templateLength: number;
+        averageSavings: number;
+    };
+}
+/**
+ * MXP Enhanced Key Pair (extends existing ChannelKey)
+ */
+export interface EnhancedKeyPair {
+    keyId: string;
+    secretKey: string;
+    algorithm: string;
+    serverDecryptable: boolean;
+    securityLevel: SecurityLevel;
+    escrowCopy?: string;
+    e2eKeyPair?: MxpCryptoKeyPair;
+    functionalityImpact?: {
+        messageAggregation: boolean;
+        patternLearning: boolean;
+        serverAnalytics: boolean;
+        crossAgentInsights: boolean;
+    };
+    functionalityWarning?: string;
+}
+/**
+ * Default MXP Configuration
+ */
+export declare const DEFAULT_MXP_CONFIG: MxpConfig;
+//# sourceMappingURL=MxpTypes.d.ts.map

package/dist/types/MxpTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MxpTypes.d.ts","sourceRoot":"","sources":["../../src/types/MxpTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;GAKG;AAEH,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,eAAO,MAAM,WAAW,EAAG,KAAc,CAAC;AAE1C,oBAAY,aAAa;IACrB,QAAQ,aAAa,CAAM,4CAA4C;IACvE,QAAQ,aAAa,CAAM,8BAA8B;IACzD,SAAS,cAAc,CAAI,wCAAwC;IACnE,UAAU,eAAe;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB,OAAO,EAAE,OAAO,WAAW,CAAC;IAG5B,KAAK,EAAE;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,kBAAkB,EAAE,OAAO,CAAC;QAC5B,gBAAgB,EAAE,OAAO,CAAC;KAC7B,CAAC;IAGF,OAAO,EAAE;QACL,iBAAiB,CAAC,EAAE,uBAAuB,CAAC;QAC5C,qBAAqB,CAAC,EAAE,2BAA2B,CAAC;QACpD,QAAQ,CAAC,EAAE,cAAc,CAAC;QAC1B,SAAS,CAAC,EAAE,eAAe,CAAC;KAC/B,CAAC;IAGF,WAAW,EAAE;QACT,qBAAqB,EAAE,OAAO,CAAC;QAC/B,0BAA0B,EAAE,OAAO,CAAC;QACpC,mBAAmB,EAAE,OAAO,CAAC;QAC7B,iBAAiB,EAAE,OAAO,CAAC;QAC3B,mBAAmB,EAAE,OAAO,CAAC;KAChC,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,OAAO,EAAE,OAAO,CAAC;IAGjB,UAAU,EAAE;QACR,kBAAkB,EAAE,OAAO,CAAC;QAC5B,kBAAkB,EAAE,OAAO,CAAC;QAC5B,gBAAgB,EAAE,OAAO,CAAC;QAC1B,mBAAmB,EAAE,OAAO,CAAC;QAC7B,mBAAmB,EAAE,OAAO,CAAC;QAC7B,yBAAyB,EAAE,OAAO,CAAC;KACtC,CAAC;IAGF,QAAQ,EAAE;QACN,gBAAgB,EAAE,OAAO,GAAG,UAAU,GAAG,YAAY,CAAC;QACtD,oBAAoB,EAAE,OAAO,CAAC;QAC9B,0BAA0B,EAAE,OAAO,CAAC;QACpC,aAAa,EAAE;YACX,mBAAmB,EAAE,MAAM,CAAC;YAC5B,gBAAgB,EAAE,MAAM,CAAC;YACzB,aAAa,EAAE,OAAO,CAAC;SAC1B,CAAC;QACF,cAAc,EAAE;YACZ,OAAO,EAAE,OAAO,CAAC;YACjB,YAAY,EAAE,MAAM,CAAC;YACrB,mBAAmB,EAAE,MAAM,CAAC;SAC/B,CAAC;KACL,CAAC;CACL;AAED;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAC/B,qBAAqB,GACrB,qBAAqB,GACrB,mBAAmB,GACnB,sBAAsB,GACtB,uBAAuB,GACvB,4BAA4B,GAC5B,KAAK,CAAC;AAEZ;;GAEG;AACH,MAAM,WAAW,2BAA2B;IACxC,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,aAAa,CAAC;IACxB,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,YAAY,CAAC;IAC1D,gBAAgB,EAAE,OAAO,CAAC;IAC1B,wBAAwB,EAAE,OAAO,CAAC;IAClC,cAAc,EAAE;QACZ,OAAO,EAAE,OAAO,CAAC;QACjB,cAAc,EAAE,MAAM,CAAC;QACvB,oBAAoB,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;KACpD,CAAC;IACF,kBAAkB,EAAE;QAChB,mBAAmB,EAAE,MAAM,CAAC;QAC5B,YAAY,EAAE,MAAM,CAAC;QACrB,SAAS,EAAE,MAAM,CAAC;KACrB,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,aAAa,CAAC;IACrB,QAAQ,EAAE;QACN,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAC7B,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC;KACzD,CAAC;IACF,aAAa,EAAE;QACX,cAAc,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;QAC1C,gBAAgB,EAAE,MAAM,CAAC;QACzB,SAAS,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;QAC3B,SAAS,EAAE,SAAS,GAAG,mBAAmB,CAAC;QAC3C,mBAAmB,EAAE,OAAO,CAAC;KAChC,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,OAAO,CAAC;IACzB,eAAe,EAAE;QACb,OAAO,EAAE,OAAO,CAAC;QACjB,SAAS,EAAE,gBAAgB,CAAC;QAC5B,iBAAiB,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;KAChE,CAAC;IACF,mBAAmB,EAAE;QACjB,cAAc,EAAE,OAAO,CAAC;QACxB,gBAAgB,EAAE,OAAO,CAAC;QAC1B,aAAa,EAAE,OAAO,CAAC;QACvB,UAAU,EAAE,OAAO,CAAC;KACvB,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,CAAC,QAAQ,EAAE,MAAM,GAAG;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,SAAS,CAAC;IAErB,iBAAiB,CAAC,EAAE;QAChB,cAAc,EAAE,MAAM,CAAC;QACvB,eAAe,EAAE,MAAM,CAAC;QACxB,mBAAmB,EAAE,MAAM,CAAC;QAC5B,QAAQ,EAAE,MAAM,CAAC;KACpB,CAAC;IAEF,qBAAqB,CAAC,EAAE;QACpB,YAAY,EAAE,MAAM,CAAC;QACrB,cAAc,EAAE,MAAM,CAAC;QACvB,mBAAmB,EAAE,MAAM,CAAC;QAC5B,QAAQ,EAAE,aAAa,CAAC;KAC3B,CAAC;IAEF,QAAQ,CAAC,EAAE;QACP,KAAK,EAAE,aAAa,CAAC;QACrB,iBAAiB,EAAE,OAAO,CAAC;QAC3B,UAAU,EAAE,OAAO,CAAC;KACvB,CAAC;IAEF,WAAW,EAAE;QACT,gBAAgB,EAAE,MAAM,CAAC;QACzB,aAAa,EAAE,MAAM,CAAC;QACtB,cAAc,EAAE,MAAM,CAAC;KAC1B,CAAC;IAEF,WAAW,CAAC,EAAE;QACV,YAAY,EAAE,MAAM,CAAC;QACrB,aAAa,EAAE,MAAM,CAAC;QACtB,aAAa,EAAE,MAAM,CAAC;QACtB,iBAAiB,EAAE,MAAM,CAAC;KAC7B,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC,eAAe,EAAE,GAAG,CAAC;IACrB,iBAAiB,EAAE,GAAG,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE;QACN,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,EAAE,OAAO,CAAC;QACvB,sBAAsB,EAAE,OAAO,CAAC;KACnC,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,KAAK,EAAE;QACH,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,YAAY,EAAE;QACV,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;KAC1B,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,aAAa,EAAE,aAAa,CAAC;IAG7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,mBAAmB,CAAC,EAAE;QAClB,kBAAkB,EAAE,OAAO,CAAC;QAC5B,eAAe,EAAE,OAAO,CAAC;QACzB,eAAe,EAAE,OAAO,CAAC;QACzB,kBAAkB,EAAE,OAAO,CAAC;KAC/B,CAAC;IACF,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,SAoGhC,CAAC"}

package/dist/types/MxpTypes.js

@@ -0,0 +1,132 @@
+/**
+ * Copyright 2024 Brad Anderson
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @author Brad Anderson <BradA1878@pm.me>
+ * @repository https://github.com/mxf-dev/mxf
+ * @documentation https://mxf-dev.github.io/mxf/
+ */
+import { ContentFormat } from '../schemas/MessageSchemas.js';
+/**
+ * MXP Version and Security Levels
+ */
+export const MXP_VERSION = '2.0';
+export var SecurityLevel;
+(function (SecurityLevel) {
+    SecurityLevel["STANDARD"] = "standard";
+    SecurityLevel["ENHANCED"] = "enhanced";
+    SecurityLevel["REGULATED"] = "regulated";
+    SecurityLevel["CLASSIFIED"] = "classified"; // + government/military grade (E2E available)
+})(SecurityLevel || (SecurityLevel = {}));
+/**
+ * Default MXP Configuration
+ */
+export const DEFAULT_MXP_CONFIG = {
+    version: MXP_VERSION,
+    // Default scope - can be applied to any channel or agent
+    scope: {
+        inheritFromChannel: true,
+        overrideSettings: true
+    },
+    modules: {
+        tokenOptimization: {
+            enabled: true,
+            // Granular strategy control - enable key optimizations by default
+            strategies: {
+                contextCompression: true,
+                promptOptimization: true,
+                templateMatching: true,
+                entityDeduplication: false, // More experimental
+                toolSchemaReduction: false, // Requires careful testing
+                conversationSummarization: true
+            },
+            // Optimization settings
+            settings: {
+                compressionLevel: 'standard',
+                systemLlmIntegration: true,
+                patternLearningIntegration: true,
+                contextWindow: {
+                    fullContextMessages: 5,
+                    compressionRatio: 0.2,
+                    referenceMode: true
+                },
+                templateEngine: {
+                    enabled: true,
+                    maxTemplates: 100,
+                    confidenceThreshold: 0.8
+                }
+            }
+        },
+        bandwidthOptimization: {
+            enabled: true,
+            encoding: ContentFormat.JSON,
+            compression: 'standard',
+            enhancedBatching: true,
+            priorityQueueIntegration: true,
+            binaryProtocol: {
+                enabled: true,
+                thresholdBytes: 10240, // 10KB
+                compressionAlgorithm: 'brotli'
+            },
+            messageAggregation: {
+                similarityThreshold: 0.8, // Use existing MxfMessageAggregator threshold
+                maxBatchSize: 64 * 1024, // 64KB
+                timeoutMs: 180000 // Use existing 3-minute failsafe
+            }
+        },
+        security: {
+            enabled: true,
+            level: SecurityLevel.ENHANCED,
+            features: {
+                auditLogging: true,
+                keyEscrow: true,
+                complianceMode: 'GDPR'
+            },
+            keyManagement: {
+                rotationPolicy: 'both',
+                rotationInterval: 30 * 24 * 60 * 60 * 1000, // 30 days
+                keyLength: 256,
+                algorithm: 'AES-GCM',
+                enhanceExistingKeys: true
+            }
+        },
+        analytics: {
+            enabled: true,
+            realTimeMetrics: true,
+            costCalculation: {
+                enabled: true,
+                providers: {
+                    'gpt-4o': { input: 0.03, output: 0.06 },
+                    'claude-3.5-sonnet': { input: 0.025, output: 0.075 },
+                    'gemini-pro': { input: 0.02, output: 0.04 }
+                },
+                reportingInterval: 'daily'
+            },
+            performanceTracking: {
+                tokenReduction: true,
+                bandwidthSavings: true,
+                latencyImpact: true,
+                errorRates: true
+            }
+        }
+    },
+    integration: {
+        useExistingAggregator: true,
+        useExistingPatternLearning: true,
+        useExistingEventBus: true,
+        useExistingMemory: true,
+        useSystemLlmService: true
+    }
+};
+//# sourceMappingURL=MxpTypes.js.map

package/dist/types/MxpTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MxpTypes.js","sourceRoot":"","sources":["../../src/types/MxpTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAUH,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAU7D;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,KAAc,CAAC;AAE1C,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACrB,sCAAqB,CAAA;IACrB,sCAAqB,CAAA;IACrB,wCAAuB,CAAA;IACvB,0CAAyB,CAAA,CAAE,8CAA8C;AAC7E,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB;AA4PD;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAc;IACzC,OAAO,EAAE,WAAW;IAEpB,yDAAyD;IACzD,KAAK,EAAE;QACH,kBAAkB,EAAE,IAAI;QACxB,gBAAgB,EAAE,IAAI;KACzB;IAED,OAAO,EAAE;QACL,iBAAiB,EAAE;YACf,OAAO,EAAE,IAAI;YAEb,kEAAkE;YAClE,UAAU,EAAE;gBACR,kBAAkB,EAAE,IAAI;gBACxB,kBAAkB,EAAE,IAAI;gBACxB,gBAAgB,EAAE,IAAI;gBACtB,mBAAmB,EAAE,KAAK,EAAQ,oBAAoB;gBACtD,mBAAmB,EAAE,KAAK,EAAQ,2BAA2B;gBAC7D,yBAAyB,EAAE,IAAI;aAClC;YAED,wBAAwB;YACxB,QAAQ,EAAE;gBACN,gBAAgB,EAAE,UAAU;gBAC5B,oBAAoB,EAAE,IAAI;gBAC1B,0BAA0B,EAAE,IAAI;gBAChC,aAAa,EAAE;oBACX,mBAAmB,EAAE,CAAC;oBACtB,gBAAgB,EAAE,GAAG;oBACrB,aAAa,EAAE,IAAI;iBACtB;gBACD,cAAc,EAAE;oBACZ,OAAO,EAAE,IAAI;oBACb,YAAY,EAAE,GAAG;oBACjB,mBAAmB,EAAE,GAAG;iBAC3B;aACJ;SACJ;QACD,qBAAqB,EAAE;YACnB,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,aAAa,CAAC,IAAI;YAC5B,WAAW,EAAE,UAAU;YACvB,gBAAgB,EAAE,IAAI;YACtB,wBAAwB,EAAE,IAAI;YAC9B,cAAc,EAAE;gBACZ,OAAO,EAAE,IAAI;gBACb,cAAc,EAAE,KAAK,EAAG,OAAO;gBAC/B,oBAAoB,EAAE,QAAQ;aACjC;YACD,kBAAkB,EAAE;gBAChB,mBAAmB,EAAE,GAAG,EAAG,8CAA8C;gBACzE,YAAY,EAAE,EAAE,GAAG,IAAI,EAAI,OAAO;gBAClC,SAAS,EAAE,MAAM,CAAU,iCAAiC;aAC/D;SACJ;QACD,QAAQ,EAAE;YACN,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,aAAa,CAAC,QAAQ;YAC7B,QAAQ,EAAE;gBACN,YAAY,EAAE,IAAI;gBAClB,SAAS,EAAE,IAAI;gBACf,cAAc,EAAE,MAAM;aACzB;YACD,aAAa,EAAE;gBACX,cAAc,EAAE,MAAM;gBACtB,gBAAgB,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,UAAU;gBACtD,SAAS,EAAE,GAAG;gBACd,SAAS,EAAE,SAAS;gBACpB,mBAAmB,EAAE,IAAI;aAC5B;SACJ;QACD,SAAS,EAAE;YACP,OAAO,EAAE,IAAI;YACb,eAAe,EAAE,IAAI;YACrB,eAAe,EAAE;gBACb,OAAO,EAAE,IAAI;gBACb,SAAS,EAAE;oBACP,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;oBACvC,mBAAmB,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE;oBACpD,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;iBAC9C;gBACD,iBAAiB,EAAE,OAAO;aAC7B;YACD,mBAAmB,EAAE;gBACjB,cAAc,EAAE,IAAI;gBACpB,gBAAgB,EAAE,IAAI;gBACtB,aAAa,EAAE,IAAI;gBACnB,UAAU,EAAE,IAAI;aACnB;SACJ;KACJ;IACD,WAAW,EAAE;QACT,qBAAqB,EAAE,IAAI;QAC3B,0BAA0B,EAAE,IAAI;QAChC,mBAAmB,EAAE,IAAI;QACzB,iBAAiB,EAAE,IAAI;QACvB,mBAAmB,EAAE,IAAI;KAC5B;CACJ,CAAC"}

package/dist/types/NetworkRecoveryTypes.d.ts

@@ -0,0 +1,133 @@
+/**
+ * Copyright 2024 Brad Anderson
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @author Brad Anderson <BradA1878@pm.me>
+ * @repository https://github.com/mxf-dev/mxf
+ * @documentation https://mxf-dev.github.io/mxf/
+ */
+/**
+ * Network Recovery Types
+ *
+ * Type definitions for network error handling, retry logic,
+ * circuit breaker patterns, and graceful degradation strategies.
+ */
+/**
+ * Classification of network and API errors for proper handling strategies
+ */
+export declare enum NetworkErrorType {
+    NETWORK_TIMEOUT = "NETWORK_TIMEOUT",
+    NETWORK_CONNECTION_REFUSED = "NETWORK_CONNECTION_REFUSED",
+    NETWORK_DNS_RESOLUTION = "NETWORK_DNS_RESOLUTION",
+    NETWORK_SOCKET_ERROR = "NETWORK_SOCKET_ERROR",
+    API_BAD_GATEWAY = "API_BAD_GATEWAY",// 502
+    API_SERVICE_UNAVAILABLE = "API_SERVICE_UNAVAILABLE",// 503
+    API_GATEWAY_TIMEOUT = "API_GATEWAY_TIMEOUT",// 504
+    API_INTERNAL_ERROR = "API_INTERNAL_ERROR",// 500
+    AUTH_UNAUTHORIZED = "AUTH_UNAUTHORIZED",// 401
+    AUTH_FORBIDDEN = "AUTH_FORBIDDEN",// 403
+    RATE_LIMITED = "RATE_LIMITED",// 429
+    CLIENT_BAD_REQUEST = "CLIENT_BAD_REQUEST",// 400
+    CLIENT_UNPROCESSABLE = "CLIENT_UNPROCESSABLE",// 422
+    CLIENT_NOT_FOUND = "CLIENT_NOT_FOUND",// 404
+    UNKNOWN_ERROR = "UNKNOWN_ERROR"
+}
+/**
+ * Determines if an error is retryable based on its type
+ */
+export declare function isRetryableError(errorType: NetworkErrorType): boolean;
+/**
+ * Network recovery configuration options
+ */
+export interface NetworkRecoveryConfig {
+    maxRetries: number;
+    baseDelayMs: number;
+    maxDelayMs: number;
+    retryMultiplier: number;
+    circuitBreakerThreshold: number;
+    circuitBreakerCooldownMs: number;
+    circuitBreakerHalfOpenRequests: number;
+    requestTimeoutMs: number;
+    enableGracefulDegradation: boolean;
+    enableDetailedLogging: boolean;
+}
+/**
+ * Default network recovery configuration
+ */
+export declare const DEFAULT_NETWORK_RECOVERY_CONFIG: NetworkRecoveryConfig;
+/**
+ * Circuit breaker states
+ */
+export declare enum CircuitBreakerState {
+    CLOSED = "CLOSED",// Normal operation
+    OPEN = "OPEN",// Blocking requests
+    HALF_OPEN = "HALF_OPEN"
+}
+/**
+ * Circuit breaker status information
+ */
+export interface CircuitBreakerStatus {
+    state: CircuitBreakerState;
+    failureCount: number;
+    lastFailureTime?: Date;
+    nextRetryTime?: Date;
+    successCount: number;
+    totalRequests: number;
+}
+/**
+ * Enhanced error information for better debugging
+ */
+export interface NetworkErrorInfo {
+    type: NetworkErrorType;
+    statusCode?: number;
+    message: string;
+    originalError?: Error;
+    timestamp: Date;
+    retryCount?: number;
+    maxRetries?: number;
+    context?: Record<string, any>;
+}
+/**
+ * Retry attempt information
+ */
+export interface RetryAttempt {
+    attemptNumber: number;
+    delayMs: number;
+    errorType: NetworkErrorType;
+    timestamp: Date;
+}
+/**
+ * Result of a network operation with recovery
+ */
+export interface NetworkOperationResult<T> {
+    success: boolean;
+    data?: T;
+    error?: NetworkErrorInfo;
+    retryAttempts?: RetryAttempt[];
+    circuitBreakerTriggered?: boolean;
+    fallbackUsed?: boolean;
+}
+/**
+ * Classifies an error based on status code and error details
+ */
+export declare function classifyNetworkError(error: any, statusCode?: number): NetworkErrorType;
+/**
+ * Calculates retry delay with exponential backoff and jitter
+ */
+export declare function calculateRetryDelay(attemptNumber: number, config: NetworkRecoveryConfig): number;
+/**
+ * Formats an error for logging with appropriate detail level
+ */
+export declare function formatNetworkError(error: NetworkErrorInfo, includeStack?: boolean): string;
+//# sourceMappingURL=NetworkRecoveryTypes.d.ts.map

package/dist/types/NetworkRecoveryTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkRecoveryTypes.d.ts","sourceRoot":"","sources":["../../src/types/NetworkRecoveryTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;GAKG;AAEH;;GAEG;AACH,oBAAY,gBAAgB;IAExB,eAAe,oBAAoB;IACnC,0BAA0B,+BAA+B;IACzD,sBAAsB,2BAA2B;IACjD,oBAAoB,yBAAyB;IAG7C,eAAe,oBAAoB,CAAe,MAAM;IACxD,uBAAuB,4BAA4B,CAAE,MAAM;IAC3D,mBAAmB,wBAAwB,CAAO,MAAM;IACxD,kBAAkB,uBAAuB,CAAS,MAAM;IAGxD,iBAAiB,sBAAsB,CAAW,MAAM;IACxD,cAAc,mBAAmB,CAAiB,MAAM;IAGxD,YAAY,iBAAiB,CAAqB,MAAM;IAGxD,kBAAkB,uBAAuB,CAAS,MAAM;IACxD,oBAAoB,yBAAyB,CAAK,MAAM;IACxD,gBAAgB,qBAAqB,CAAa,MAAM;IAGxD,aAAa,kBAAkB;CAClC;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,gBAAgB,GAAG,OAAO,CAcrE;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAElC,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IAGxB,uBAAuB,EAAE,MAAM,CAAC;IAChC,wBAAwB,EAAE,MAAM,CAAC;IACjC,8BAA8B,EAAE,MAAM,CAAC;IAGvC,gBAAgB,EAAE,MAAM,CAAC;IAGzB,yBAAyB,EAAE,OAAO,CAAC;IACnC,qBAAqB,EAAE,OAAO,CAAC;CAClC;AAED;;GAEG;AACH,eAAO,MAAM,+BAA+B,EAAE,qBAW7C,CAAC;AAEF;;GAEG;AACH,oBAAY,mBAAmB;IAC3B,MAAM,WAAW,CAAQ,mBAAmB;IAC5C,IAAI,SAAS,CAAY,oBAAoB;IAC7C,SAAS,cAAc;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,KAAK,EAAE,mBAAmB,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,IAAI,CAAC;IACvB,aAAa,CAAC,EAAE,IAAI,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,gBAAgB,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,KAAK,CAAC;IACtB,SAAS,EAAE,IAAI,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,SAAS,EAAE,IAAI,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACrC,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;IAC/B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAChC,KAAK,EAAE,GAAG,EACV,UAAU,CAAC,EAAE,MAAM,GACpB,gBAAgB,CAgDlB;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAC/B,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,qBAAqB,GAC9B,MAAM,CAQR;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAC9B,KAAK,EAAE,gBAAgB,EACvB,YAAY,GAAE,OAAe,GAC9B,MAAM,CAeR"}