capman 0.6.0 → 0.6.2

package/dist/cjs/engine.js

@@ -10,6 +10,9 @@ const version_1 = require("./version");
 // ─── CapmanEngine ─────────────────────────────────────────────────────────────
 class CapmanEngine {
     constructor(options) {
+        this.manifestVersion = 0;
+        /** Resolves when the post-loadManifest re-encode completes. Awaited by buildEmbeddingScores(). */
+        this.pendingEmbedding = null;
         // ── LLM rate limiting state ────────────────────────────────────────────────
         this.llmCallsThisMinute = 0;
         this.llmWindowStart = Date.now();
@@ -20,6 +23,7 @@ class CapmanEngine {
         this.mode = options.mode ?? 'balanced';
         this.llm = options.llm;
         this.baseUrl = options.baseUrl;
+        this.environment = options.environment;
         this.auth = options.auth;
         this.headers = options.headers;
         this.threshold = options.threshold ?? 50;
@@ -45,8 +49,20 @@ class CapmanEngine {
         // Use FileLearningStore explicitly for persistence across restarts
         this.learning = options.learning === false
             ? null
-            : (options.learning ?? new learning_1.MemoryLearningStore());
-        logger_1.logger.info(`CapmanEngine initialized — mode: ${this.mode}, cache: ${this.cache ? 'enabled' : 'disabled'}, learning: ${this.learning ? 'enabled' : 'disabled'}`);
+            : (options.learning ?? new learning_1.MemoryLearningStore(options.learningHalfLifeDays ?? 30));
+        this.embedding = options.embedding;
+        if (this.embedding) {
+            // Pre-encode all capability texts at construction time — one batch call.
+            // Concatenate name + description for richer semantic surface.
+            const texts = this.manifest.capabilities.map(c => `${c.name}: ${c.description}`);
+            this.embedding.encode(texts).then(vecs => {
+                this.capEmbeddings = vecs;
+                logger_1.logger.info('Capability embeddings pre-encoded');
+            }).catch(err => {
+                logger_1.logger.warn(`EmbeddingProvider pre-encode failed — embedding signal disabled: ${err instanceof Error ? err.message : String(err)}`);
+            });
+        }
+        logger_1.logger.info(`CapmanEngine initialized — mode: ${this.mode}, cache: ${this.cache ? 'enabled' : 'disabled'}, learning: ${this.learning ? 'enabled' : 'disabled'}, embedding: ${this.embedding ? 'enabled' : 'disabled'}`);
         // ── Manifest version compatibility check ─────────────────────────────────
         this.checkManifestVersion(options.manifest);
     }
@@ -70,6 +86,9 @@ class CapmanEngine {
         }
         const start = Date.now();
         const steps = [];
+        // Capture manifest version at entry — used to guard the cache write.
+        // If loadManifest() is called mid-flight, we skip writing stale results.
+        const manifestVersion = this.manifestVersion;
         // ── Step 1: Check cache ──────────────────────────────────────────────────
         const cacheStart = Date.now();
         if (this.cache) {
@@ -127,6 +146,7 @@ class CapmanEngine {
         // ── Step 2.5: Apply learning boost ───────────────────────────────────────
         matchResult = await this.applyBoostToMatchResult(query, matchResult, resolvedVia);
         // ── Step 3: Privacy check ────────────────────────────────────────────────
+        let privacyFailed = false;
         if (matchResult.capability) {
             const privacyError = (0, resolver_1.checkPrivacy)(matchResult.capability, this.auth);
             steps.push({
@@ -135,13 +155,23 @@ class CapmanEngine {
                 durationMs: 0,
                 detail: privacyError ?? `level: ${matchResult.capability.privacy.level}`,
             });
+            // Warn on deprecated or sunset capabilities — never silently fail
+            this.checkCapabilityLifecycle(matchResult.capability);
+            // Log when engine mode differs from capability's preferred mode
+            this.checkMatchHint(matchResult.capability);
+            // Short-circuit: if privacy fails, skip disambiguation to avoid burning an LLM
+            // call on a request that _resolve() will block anyway. privacyFailed propagates
+            // to Step 4a so the mode guard check is clean and explicit.
+            if (privacyError)
+                privacyFailed = true;
         }
         // ── Step 4a: Compute verdict + optional margin-aware LLM disambiguation ──
         let { verdict, margin } = this.computeVerdict(matchResult);
         if (verdict === 'marginal' &&
             this.marginAwareLLM &&
             this.llm &&
-            this.mode === 'balanced') {
+            !privacyFailed &&
+            (this.mode === 'balanced' || this.mode === 'accurate')) {
             matchResult = await this.disambiguateLLM(query, matchResult, steps);
             // Recompute verdict after disambiguation
             const recomputed = this.computeVerdict(matchResult);
@@ -164,11 +194,19 @@ class CapmanEngine {
         //    queries that resolve to the same capability share a cache entry
         if (this.cache && resolution.success && matchResult.capability
             && matchResult.capability.privacy.level === 'public') {
-            const queryKey = (0, cache_1.normalizeQuery)(query);
-            const capKey = (0, cache_1.buildCacheKey)(query, matchResult.capability.id, matchResult.extractedParams);
-            await this.cache.set(queryKey, matchResult);
-            await this.cache.set(capKey, matchResult);
-            // capKey always starts with 'cap:' — structurally distinct from queryKey
+            // Optimistic concurrency guard — skip cache write if manifest was swapped
+            // mid-flight. The result was computed against a now-stale manifest and
+            // must not pollute the cache for the new one.
+            if (this.manifestVersion === manifestVersion) {
+                const queryKey = (0, cache_1.normalizeQuery)(query);
+                const capKey = (0, cache_1.buildCacheKey)(query, matchResult.capability.id, matchResult.extractedParams);
+                await this.cache.set(queryKey, matchResult);
+                await this.cache.set(capKey, matchResult);
+                // capKey always starts with 'cap:' — structurally distinct from queryKey
+            }
+            else {
+                logger_1.logger.warn('loadManifest() called mid-flight — skipping cache write for stale result');
+            }
         }
         // ── Step 5b: Compute missingParams ───────────────────────────────────────
         // Spec: LLM attempts extraction first when available. missingParams is last resort.
@@ -208,8 +246,19 @@ class CapmanEngine {
                             }
                         }
                     }
-                    catch {
-                        // LLM param extraction failed — fall through to missingParams below
+                    catch (err) {
+                        const isParseError = err instanceof SyntaxError;
+                        if (isParseError) {
+                            // JSON parse failure: refund the rate-limit slot but don't open circuit breaker
+                            // The llm is reachable - the response format was just bad
+                            this.llmCallsThisMinute = Math.max(0, this.llmCallsThisMinute - 1);
+                        }
+                        else {
+                            // Hard failure (timeout, network): refund slot and increment fail counter
+                            this.recordLLMFailure();
+                        }
+                        logger_1.logger.warn(`LLM param extraction failed: ${err instanceof Error ? err.message : String(err)}`);
+                        // fall through to missingParams below
                     }
                 }
             }
@@ -295,6 +344,20 @@ class CapmanEngine {
             await this.cache.clear();
     }
     checkManifestVersion(manifest) {
+        // ── Schema version check ─────────────────────────────────────────────────
+        // schemaVersion tracks manifest format — "1" for v0.6+.
+        // Manifests without schemaVersion are pre-v0.6 — warn but allow.
+        const CURRENT_SCHEMA_VERSION = '1';
+        if (!manifest.schemaVersion) {
+            console.warn(`[capman] Manifest is missing schemaVersion — it was generated with capman < 0.6. ` +
+                `Regenerate with: npx capman generate`);
+        }
+        else if (manifest.schemaVersion !== CURRENT_SCHEMA_VERSION) {
+            console.warn(`[capman] Manifest schemaVersion "${manifest.schemaVersion}" differs from ` +
+                `engine's expected "${CURRENT_SCHEMA_VERSION}". ` +
+                `Regenerate with: npx capman generate`);
+        }
+        // ── Package version check ────────────────────────────────────────────────
         if (!manifest.version)
             return;
         const SEMVER_RE = /^\d+\.\d+\.\d+$/;
@@ -302,8 +365,8 @@ class CapmanEngine {
             const [mMaj, mMin] = manifest.version.split('.').map(Number);
             const [eMaj, eMin] = version_1.VERSION.split('.').map(Number);
             if (mMaj !== eMaj || mMin !== eMin) {
-                console.warn(`[capman] Manifest version "${manifest.version}" was generated with a ` +
-                    `different engine version than "${version_1.VERSION}". This is usually fine across patch versions. ` +
+                console.warn(`[capman] Manifest was generated with capman "${manifest.version}" ` +
+                    `but engine is "${version_1.VERSION}". This is usually fine across patch versions. ` +
                     `If you experience unexpected matching issues, regenerate with: npx capman generate`);
             }
         }
@@ -312,6 +375,80 @@ class CapmanEngine {
                 `to engine version "${version_1.VERSION}" — version strings are not valid semver.`);
         }
     }
+    checkCapabilityLifecycle(capability) {
+        const lc = capability.lifecycle;
+        if (!lc || lc.status === 'stable' || lc.status === 'beta' || lc.status === 'experimental') {
+            if (lc?.status === 'beta') {
+                logger_1.logger.warn(`Capability "${capability.id}" is in beta — behavior may change`);
+            }
+            if (lc?.status === 'experimental') {
+                logger_1.logger.warn(`Capability "${capability.id}" is experimental — use with caution`);
+            }
+            return;
+        }
+        if (lc.status === 'deprecated') {
+            const sunsetPassed = lc.sunsetAt && new Date(lc.sunsetAt) < new Date();
+            if (sunsetPassed) {
+                // Sunset date has passed — strongest warning
+                console.warn(`[capman] ⚠️  Capability "${capability.id}" passed its sunset date (${lc.sunsetAt}). ` +
+                    `It may be removed in a future version.` +
+                    (lc.successor ? ` Use "${lc.successor}" instead.` : '') +
+                    (lc.note ? ` Note: ${lc.note}` : ''));
+            }
+            else {
+                logger_1.logger.warn(`Capability "${capability.id}" is deprecated.` +
+                    (lc.sunsetAt ? ` Sunset: ${lc.sunsetAt}.` : '') +
+                    (lc.successor ? ` Use "${lc.successor}" instead.` : '') +
+                    (lc.note ? ` Note: ${lc.note}` : ''));
+            }
+        }
+    }
+    /** Cosine similarity between two equal-length vectors */
+    cosineSim(a, b) {
+        if (a.length !== b.length || a.length === 0) {
+            logger_1.logger.warn(`cosineSim: dimension mismatch (${a.length} vs ${b.length}) — returning 0`);
+            return 0;
+        }
+        let dot = 0, normA = 0, normB = 0;
+        for (let i = 0; i < a.length; i++) {
+            dot += a[i] * b[i];
+            normA += a[i] * a[i];
+            normB += b[i] * b[i];
+        }
+        const denom = Math.sqrt(normA) * Math.sqrt(normB);
+        return denom === 0 ? 0 : dot / denom;
+    }
+    /** Encode query and return cosine similarity scores (0–100) keyed by capability ID */
+    async buildEmbeddingScores(query) {
+        if (!this.embedding || !this.capEmbeddings)
+            return undefined;
+        // Wait for any in-flight re-encode from loadManifest() to finish.
+        // Without this, the first ask() after loadManifest returns uses stale embeddings.
+        if (this.pendingEmbedding)
+            await this.pendingEmbedding;
+        try {
+            const [queryVec] = await this.embedding.encode([query]);
+            const scores = new Map();
+            this.manifest.capabilities.forEach((cap, i) => {
+                const sim = this.cosineSim(queryVec, this.capEmbeddings[i]);
+                // Cosine sim is -1..1; map to 0–100, negatives floored to 0
+                scores.set(cap.id, Math.max(0, Math.round(sim * 100)));
+            });
+            return scores;
+        }
+        catch (err) {
+            logger_1.logger.warn(`Embedding encode failed — skipping embedding signal: ${err instanceof Error ? err.message : String(err)}`);
+            return undefined;
+        }
+    }
+    checkMatchHint(capability) {
+        const hint = capability.matchHint?.preferredMode;
+        if (!hint || hint === this.mode)
+            return;
+        // Advisory only — log but never enforce
+        logger_1.logger.warn(`Capability "${capability.id}" prefers mode "${hint}" but engine is in "${this.mode}" mode. ` +
+            `Set mode: '${hint}' in EngineOptions to honor this hint.`);
+    }
     /**
      * Replaces the active manifest without creating a new engine instance.
      * Useful for hot-reloading manifests in long-running servers without
@@ -326,11 +463,31 @@ class CapmanEngine {
      */
     async loadManifest(manifest) {
         this.checkManifestVersion(manifest);
+        // Assign all derived state atomically before any await — an in-flight ask()
+        // must never see a new manifest paired with a stale bm25Index or ceiling.
         this.manifest = manifest;
         this.bm25Index = (0, matcher_1.buildBM25Index)(manifest.capabilities);
         this.bm25Ceiling = this.calibrateBM25Ceiling();
         this.adaptiveMargin = this.calibrateAdaptiveMargin();
+        this.manifestVersion++;
+        // server selection updates automatically after loadManifest()
         await this.clearCache();
+        // Re-encode capabilities after manifest swap — stale embeddings misalign with new capabilities
+        if (this.embedding) {
+            const texts = manifest.capabilities.map(c => `${c.name}: ${c.description}`);
+            this.pendingEmbedding = this.embedding.encode(texts).then(vecs => {
+                this.capEmbeddings = vecs;
+                this.pendingEmbedding = null;
+                logger_1.logger.info('Capability embeddings re-encoded after manifest reload');
+            }).catch(err => {
+                this.capEmbeddings = undefined;
+                this.pendingEmbedding = null;
+                logger_1.logger.warn(`EmbeddingProvider re-encode failed after loadManifest: ${err instanceof Error ? err.message : String(err)}`);
+            });
+        }
+        else {
+            this.pendingEmbedding = null;
+        }
     }
     /**
      * Explain what would happen for a query — without executing it.
@@ -572,13 +729,15 @@ class CapmanEngine {
         let matchResult;
         let resolvedVia = 'keyword';
         // Fuzzy options — never applied in cheap mode
+        const embeddingScores = await this.buildEmbeddingScores(query);
         const fuzzyOpts = {
             fuzzyMatch: this.fuzzyMatch,
             fuzzyThreshold: this.fuzzyThreshold,
             bm25Index: this.bm25Index,
-            bm25Ceiling: this.bm25Ceiling,
             bm25K1: this.bm25K1,
             bm25B: this.bm25B,
+            bm25Ceiling: this.bm25Ceiling,
+            embeddingScores,
         };
         switch (this.mode) {
             case 'cheap': {
@@ -601,20 +760,33 @@ class CapmanEngine {
                     else {
                         const t = Date.now();
                         try {
-                            matchResult = await (0, matcher_1.matchWithLLM)(query, this.manifest, { llm: this.llm });
-                            this.recordLLMSuccess();
-                            resolvedVia = 'llm';
-                            // Merge keyword scores into LLM candidates so boost has real signal for alternatives
-                            const kwResult = (0, matcher_1.match)(query, this.manifest, fuzzyOpts);
-                            matchResult = {
-                                ...matchResult,
-                                candidates: matchResult.candidates.map(c => ({
-                                    ...c,
-                                    score: c.matched
-                                        ? c.score // keep LLM confidence for winner
-                                        : (kwResult.candidates.find(kc => kc.capabilityId === c.capabilityId)?.score ?? 0),
-                                })),
-                            };
+                            const kwResultAccurate = (0, matcher_1.match)(query, this.manifest, fuzzyOpts);
+                            const top3Accurate = kwResultAccurate.candidates
+                                .sort((a, b) => b.score - a.score)
+                                .filter(c => c.score > 0)
+                                .slice(0, 3)
+                                .map(c => this.manifest.capabilities.find(cap => cap.id === c.capabilityId))
+                                .filter(Boolean);
+                            // Skip LLM if no candidates scored above zero — no meaningful top-3 to discriminate
+                            if (top3Accurate.length === 0) {
+                                matchResult = kwResultAccurate;
+                            }
+                            else {
+                                const llmResult = await (0, matcher_1.matchWithLLM)(query, top3Accurate, { llm: this.llm, app: this.manifest.app });
+                                this.recordLLMSuccess();
+                                resolvedVia = 'llm';
+                                // If LLM says OOS but keyword had a match, the correct capability may have
+                                // been rank 4+. Fall back to keyword result rather than returning OOS.
+                                matchResult = llmResult.capability === null ? kwResultAccurate : {
+                                    ...llmResult,
+                                    candidates: llmResult.candidates.map(c => ({
+                                        ...c,
+                                        score: c.matched
+                                            ? c.score
+                                            : (kwResultAccurate.candidates.find(kc => kc.capabilityId === c.capabilityId)?.score ?? 0),
+                                    })),
+                                };
+                            }
                             steps?.push({ type: 'llm_match', status: 'pass', durationMs: Date.now() - t, detail: `confidence: ${matchResult.confidence}%` });
                         }
                         catch (err) {
@@ -659,19 +831,32 @@ class CapmanEngine {
                         logger_1.logger.debug(`Query escalated to LLM: "${query}"`);
                         const t2 = Date.now();
                         try {
-                            matchResult = await (0, matcher_1.matchWithLLM)(query, this.manifest, { llm: this.llm });
-                            this.recordLLMSuccess();
-                            resolvedVia = 'llm';
-                            // keywordResult already computed above in balanced mode — merge scores
-                            matchResult = {
-                                ...matchResult,
-                                candidates: matchResult.candidates.map(c => ({
-                                    ...c,
-                                    score: c.matched
-                                        ? c.score
-                                        : (keywordResult.candidates.find(kc => kc.capabilityId === c.capabilityId)?.score ?? 0),
-                                })),
-                            };
+                            const top3Balanced = keywordResult.candidates
+                                .sort((a, b) => b.score - a.score)
+                                .filter(c => c.score > 0)
+                                .slice(0, 3)
+                                .map(c => this.manifest.capabilities.find(cap => cap.id === c.capabilityId))
+                                .filter(Boolean);
+                            // Balanced mode only escalates when keyword confidence is low but > 0 —
+                            // top3 should always be non-empty here, but guard anyway
+                            if (top3Balanced.length === 0) {
+                                matchResult = keywordResult;
+                            }
+                            else {
+                                const llmResult = await (0, matcher_1.matchWithLLM)(query, top3Balanced, { llm: this.llm, app: this.manifest.app });
+                                this.recordLLMSuccess();
+                                resolvedVia = 'llm';
+                                // If LLM returns OOS but keyword had a scored candidate, fall back to keyword
+                                matchResult = llmResult.capability === null ? keywordResult : {
+                                    ...llmResult,
+                                    candidates: llmResult.candidates.map(c => ({
+                                        ...c,
+                                        score: c.matched
+                                            ? c.score
+                                            : (keywordResult.candidates.find(kc => kc.capabilityId === c.capabilityId)?.score ?? 0),
+                                    })),
+                                };
+                            }
                             steps?.push({ type: 'llm_match', status: 'pass', durationMs: Date.now() - t2, detail: `confidence: ${matchResult.confidence}%` });
                         }
                         catch (err) {
@@ -687,7 +872,11 @@ class CapmanEngine {
                 break;
             }
         }
-        return { matchResult: matchResult, resolvedVia };
+        if (matchResult === undefined) {
+            const exhaustive = this.mode;
+            throw new Error(`_runMatch: unhandled MatchMode "${exhaustive}"`);
+        }
+        return { matchResult, resolvedVia };
     }
     /**
      * Applies learning boost to a MatchResult and returns the updated result.
@@ -758,7 +947,15 @@ class CapmanEngine {
                 const hits = wordIndex[candidate.capabilityId] ?? 0;
                 if (hits > 0) {
                     // Logarithmic boost — diminishing returns after first few hits
-                    boost += Math.min(5, Math.log2(hits + 1) * 2);
+                    const rawBoost = Math.min(5, Math.log2(hits + 1) * 2);
+                    // IDF weighting — common words ("get", "show", "user") appear in many
+                    // capabilities and accumulate learning hits that carry little signal.
+                    // Reuses BM25 df/N so no separate computation is needed.
+                    const df = this.bm25Index.df[word] ?? 0;
+                    const idf = df > 0
+                        ? Math.log((this.bm25Index.N - df + 0.5) / (df + 0.5) + 1)
+                        : 0;
+                    boost += rawBoost * Math.min(1, idf);
                 }
             }
             const cappedBoost = Math.min(15, Math.round(boost));
@@ -772,10 +969,26 @@ class CapmanEngine {
             };
         });
     }
+    /**
+     * Resolves the effective baseUrl from manifest.servers[] or EngineOptions.baseUrl.
+     * Priority: environment-matched server > first server > explicit baseUrl > undefined
+     */
+    resolveBaseUrl() {
+        const servers = this.manifest.servers;
+        if (!servers?.length)
+            return this.baseUrl;
+        if (this.environment) {
+            const match = servers.find(s => s.environment === this.environment);
+            if (match)
+                return match.url.replace(/\/$/, '');
+        }
+        // Fallback to first server
+        return servers[0].url.replace(/\/$/, '');
+    }
     // ── Private helpers ────────────────────────────────────────────────────────
     resolveOptions(overrides = {}) {
         return {
-            baseUrl: this.baseUrl,
+            baseUrl: this.resolveBaseUrl(),
             auth: this.auth,
             headers: this.headers,
             ...overrides,
@@ -795,16 +1008,7 @@ class CapmanEngine {
         });
     }
     calibrateBM25Ceiling() {
-        let max = 0;
-        for (const cap of this.manifest.capabilities) {
-            if (!cap.examples?.length)
-                continue;
-            const selfWords = new Set((0, matcher_1.tokenize)(cap.examples[0]));
-            const raw = (0, matcher_1.scoreCapability)(selfWords, cap, this.bm25Index, this.bm25K1, this.bm25B);
-            if (raw > max)
-                max = raw;
-        }
-        return max > 0 ? max : 100;
+        return (0, matcher_1.calibrateCeiling)(this.manifest.capabilities, this.bm25Index, this.bm25K1, this.bm25B);
     }
     /**
      * Calibrates the adaptive margin threshold from the manifest's own score
@@ -817,6 +1021,10 @@ class CapmanEngine {
      * For manifests with ≤100 capabilities this is negligible (<10ms).
      * For very large manifests (500+ capabilities), consider passing
      * `adaptiveMarginOverride` to skip calibration.
+     *
+     * Note: constructor total cost also includes BM25 index build O(capabilities × tokens)
+     * and embedding pre-encoding O(capabilities) if an EmbeddingProvider is configured.
+     * For 100 capabilities with embeddings, expect ~100–500ms depending on provider latency.
      */
     calibrateAdaptiveMargin() {
         if (this.manifest.capabilities.length < 2)
@@ -832,10 +1040,14 @@ class CapmanEngine {
         for (const cap of this.manifest.capabilities) {
             if (!cap.examples?.length)
                 continue;
-            const result = (0, matcher_1.match)(cap.examples[0], this.manifest, fuzzyOpts);
-            const sorted = [...result.candidates].sort((a, b) => b.score - a.score);
-            if (sorted.length >= 2) {
-                margins.push(sorted[0].score - sorted[1].score);
+            // Use all examples and take the maximum margin — same rationale as
+            // calibrateBM25Ceiling(): a weak first example skews the calibration.
+            for (const example of cap.examples) {
+                const result = (0, matcher_1.match)(example, this.manifest, fuzzyOpts);
+                const sorted = [...result.candidates].sort((a, b) => b.score - a.score);
+                if (sorted.length >= 2) {
+                    margins.push(sorted[0].score - sorted[1].score);
+                }
             }
         }
         if (margins.length === 0)