@x12i/ai-gateway 7.9.1

package/dist/flex-md-loader.d.ts

@@ -0,0 +1,109 @@
+/**
+ * @x12i/flex-md Loader
+ *
+ * Handles ES Module loading and provides unified API for flex-md operations.
+ * @x12i/flex-md is an ES Module, so we use dynamic import() instead of require().
+ *
+ * Features:
+ * - extractJsonFromFlexMd: Extract and parse JSON from flex-md content
+ * - buildDynamicInstructions: Build output format instructions from schema objects (3.1+)
+ * - Embedded nx-md-parser: flex-md 4.x includes nx-md-parser functionality (no separate package needed)
+ * - Utilizes latest flex-md 4.x APIs: extractFromMarkdown, transformWithOfs, processResponseMarkdown
+ * - Memory/caching: flex-md 4.x functions may utilize internal memory/caching for performance
+ * - Native output format support: Extracts and uses flex-md native output formats from instructions
+ *   based on compliance level when no explicit format is provided
+ */
+/**
+ * Load flex-md module (ES Module) asynchronously
+ * Caches the result to avoid multiple imports
+ */
+export declare function loadFlexMd(): Promise<any>;
+/**
+ * Extract and parse JSON from flex-md content (unstructured parsing only)
+ * Uses flex-md 4.2.0 APIs with latest features for unstructured markdown conversion
+ *
+ * ARCHITECTURE: This function only handles unstructured parsing at ai-gateway layer
+ * Schema-driven parsing happens at skills layer with nx-md-parser
+ *
+ * Supports flex-md native output formats from instructions:
+ * - Extracts flex-md output format from instructions when provided
+ * - Uses the extracted format based on compliance level for parsing
+ * - Falls back to simple markdown parsing when flex-md is unavailable
+ *
+ * @param content - The markdown content to parse (unstructured)
+ * @param options - Optional flex-md options:
+ *   - instructions: Instruction text to guide unstructured parsing
+ *   - complianceLevel: Compliance level ('L0' | 'L1' | 'L2' | 'L3') for format extraction
+ *   - spec: Pre-parsed flex-md output format spec
+ *   - Other flex-md options
+ * @returns Parsed JSON object and method used, or null if parsing fails
+ */
+export declare function extractJsonFromFlexMd(content: string): Promise<{
+    json: any;
+    method: string;
+} | null>;
+/**
+ * Check if flex-md module is available
+ */
+export declare function isFlexMdAvailable(): boolean;
+/**
+ * Get maxTokens for a model from flex-md if available
+ * Tries various flex-md APIs to get model information and maxTokens
+ *
+ * @param provider - Provider name (e.g., 'openai', 'anthropic')
+ * @param model - Model name (e.g., 'gpt-4', 'claude-3-opus')
+ * @returns maxTokens if found, null otherwise
+ */
+export declare function getModelMaxTokensFromFlexMd(provider: string, model: string): Promise<number | null>;
+/**
+ * Get flex-md module directly (must call loadFlexMd() first)
+ */
+export declare function getFlexMdModule(): any;
+export declare function buildDynamicInstructions(schemaObject: Record<string, any> | any, options?: {
+    title?: string;
+    description?: string;
+    includeExamples?: boolean;
+}): Promise<string | null>;
+/**
+ * Enrich instructions with flex-md compliance guidance (flex-md 3.0+ feature)
+ * Adds appropriate flex-md format instructions based on strictness level
+ *
+ * @param instructions - Base instructions text
+ * @param strictnessLevel - Compliance level ('L0' | 'L1' | 'L2' | 'L3')
+ * @returns Enriched instructions with flex-md guidance
+ */
+export declare function enrichInstructionsWithFlexMd(instructions: string, strictnessLevel?: 'L0' | 'L1' | 'L2' | 'L3'): Promise<string>;
+/**
+ * Get strictness defaults for a compliance level (flex-md 3.0+ feature)
+ * Returns configuration object for the specified compliance level
+ *
+ * @param strictnessLevel - Compliance level ('L0' | 'L1' | 'L2' | 'L3')
+ * @returns Configuration object with level-specific defaults
+ */
+export declare function getStrictnessDefaults(strictnessLevel?: 'L0' | 'L1' | 'L2' | 'L3'): Promise<Record<string, any> | null>;
+/**
+ * Enforce flex-md format in instructions (flex-md 3.0+ feature)
+ * Adds enforcement rules based on output format spec and strictness level
+ *
+ * @param instructions - Base instructions text
+ * @param outputFormatSpec - Output format specification (optional)
+ * @param strictnessLevel - Compliance level ('L0' | 'L1' | 'L2' | 'L3')
+ * @returns Instructions with flex-md enforcement rules
+ */
+export declare function enforceFlexMdFormat(instructions: string, outputFormatSpec?: any, strictnessLevel?: 'L0' | 'L1' | 'L2' | 'L3'): Promise<string>;
+/**
+ * Check if instructions meet a specific flex-md compliance level
+ *
+ * @param instructions - Instructions text to check
+ * @param complianceLevel - Required compliance level
+ * @returns true if instructions meet the compliance level
+ */
+export declare function hasFlexMdContract(instructions: string, complianceLevel?: 'L0' | 'L1' | 'L2' | 'L3'): Promise<boolean>;
+/**
+ * Detect the actual compliance level that instructions meet
+ * Checks from highest (L3) to lowest (L0) to find the highest level met
+ *
+ * @param instructions - Instructions text to check
+ * @returns The highest compliance level met ('L0' | 'L1' | 'L2' | 'L3' | null if none)
+ */
+export declare function detectComplianceLevel(instructions: string): Promise<'L0' | 'L1' | 'L2' | 'L3' | null>;