@betterdb/semantic-cache 0.6.0 → 0.8.0

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2026-present BetterDB Inc.
+
+Portions of this software are licensed as follows:
+
+- All content residing under the "doc/" directory of this repository is licensed under the "Creative Commons: CC BY-SA 4.0 license".
+
+- All content that resides under the "proprietary/" directory of this repository, if that directory exists, is licensed under the license defined in "proprietary/LICENSE".
+
+- All third-party components incorporated into the BetterDB Software are licensed under the original license provided by the owner of the applicable component.
+
+- Content outside of the above-mentioned directories or restrictions above is available under the "MIT Expat" license as defined below.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/SemanticCache.d.ts

@@ -175,8 +175,6 @@ export declare class SemanticCache {
     private applyCostToPendingMiss;
     private assertInitialized;
     private assertDimension;
-    private isIndexNotFoundError;
-    private parseDimensionFromInfo;
 }
 export interface ThresholdEffectivenessResult {
     category: string;

package/dist/SemanticCache.js

@@ -6,6 +6,7 @@ const node_crypto_2 = require("node:crypto");
 const api_1 = require("@opentelemetry/api");
 const errors_1 = require("./errors");
 const telemetry_1 = require("./telemetry");
+const valkey_search_kit_1 = require("@betterdb/valkey-search-kit");
 const utils_1 = require("./utils");
 const defaultCostTable_1 = require("./defaultCostTable");
 const cluster_1 = require("./cluster");
@@ -151,7 +152,7 @@ class SemanticCache {
             await this.client.call('FT.DROPINDEX', this.indexName);
         }
         catch (err) {
-            if (!this.isIndexNotFoundError(err)) {
+            if (!(0, valkey_search_kit_1.isIndexNotFoundError)(err)) {
                 throw new errors_1.ValkeyCommandError('FT.DROPINDEX', err);
             }
         }
@@ -833,16 +834,7 @@ class SemanticCache {
         catch (err) {
             throw new errors_1.ValkeyCommandError('FT.INFO', err);
         }
-        const info = raw;
-        let numDocs = 0;
-        let indexingState = 'unknown';
-        for (let i = 0; i < info.length - 1; i += 2) {
-            const key = String(info[i]);
-            if (key === 'num_docs')
-                numDocs = parseInt(String(info[i + 1]), 10) || 0;
-            else if (key === 'indexing')
-                indexingState = String(info[i + 1]);
-        }
+        const { numDocs, indexingState } = (0, valkey_search_kit_1.parseFtInfoStats)(raw);
         return { name: this.indexName, numDocs, dimension: this._dimension, indexingState };
     }
     /**
@@ -1173,7 +1165,7 @@ class SemanticCache {
         // Try reading an existing index
         try {
             const info = (await this.client.call('FT.INFO', this.indexName));
-            const dim = this.parseDimensionFromInfo(info);
+            const dim = (0, valkey_search_kit_1.parseDimensionFromInfo)(info);
             const hasBinaryRefs = this.parseHasBinaryRefsFromInfo(info);
             if (dim > 0)
                 return { dim, hasBinaryRefs };
@@ -1184,7 +1176,7 @@ class SemanticCache {
         catch (err) {
             if (err instanceof errors_1.EmbeddingError)
                 throw err;
-            if (!this.isIndexNotFoundError(err)) {
+            if (!(0, valkey_search_kit_1.isIndexNotFoundError)(err)) {
                 throw new errors_1.ValkeyCommandError('FT.INFO', err);
             }
         }
@@ -1417,49 +1409,6 @@ class SemanticCache {
             throw new errors_1.SemanticCacheUsageError(`Embedding dimension mismatch: index expects ${this._dimension}, embedFn returned ${embedding.length}. Call flush() then initialize() to rebuild.`);
         }
     }
-    isIndexNotFoundError(err) {
-        const msg = err instanceof Error ? err.message.toLowerCase() : '';
-        return (msg.includes('unknown index name') ||
-            msg.includes('no such index') ||
-            msg.includes('not found'));
-    }
-    parseDimensionFromInfo(info) {
-        for (let i = 0; i < info.length - 1; i += 2) {
-            const key = String(info[i]);
-            if (key !== 'attributes' && key !== 'fields')
-                continue;
-            const attributes = info[i + 1];
-            if (!Array.isArray(attributes))
-                continue;
-            for (const attr of attributes) {
-                if (!Array.isArray(attr))
-                    continue;
-                let isVector = false;
-                let dim = 0;
-                for (let j = 0; j < attr.length - 1; j++) {
-                    const attrKey = String(attr[j]);
-                    if (attrKey === 'type' && String(attr[j + 1]) === 'VECTOR')
-                        isVector = true;
-                    if (attrKey.toLowerCase() === 'dim')
-                        dim = parseInt(String(attr[j + 1]), 10) || 0;
-                    // Valkey Search 1.2 nests dimension inside an 'index' sub-array
-                    if (attrKey === 'index' && Array.isArray(attr[j + 1])) {
-                        const indexArr = attr[j + 1];
-                        for (let k = 0; k < indexArr.length - 1; k++) {
-                            if (String(indexArr[k]) === 'dimensions') {
-                                const d = parseInt(String(indexArr[k + 1]), 10) || 0;
-                                if (d > 0)
-                                    dim = d;
-                            }
-                        }
-                    }
-                }
-                if (isVector && dim > 0)
-                    return dim;
-            }
-        }
-        return 0;
-    }
 }
 exports.SemanticCache = SemanticCache;
 // --- Judge helpers ---

package/dist/analytics.d.ts

@@ -11,14 +11,35 @@ export interface ValkeyLike {
 export interface Analytics {
     init(client: ValkeyLike, name: string, configProps?: Record<string, unknown>): Promise<void>;
     capture(event: string, properties?: Record<string, unknown>): void;
+    flush(): Promise<void>;
     shutdown(): Promise<void>;
 }
 export interface AnalyticsOptions {
-    apiKey?: string;
-    host?: string;
     disabled?: boolean;
     /** Interval in ms for periodic stats snapshots. Default: 300_000 (5 min). 0 to disable. */
     statsIntervalMs?: number;
 }
 export declare const NOOP_ANALYTICS: Analytics;
+type PostHogClient = {
+    capture: (opts: {
+        distinctId?: string;
+        event: string;
+        properties?: Record<string, unknown>;
+    }) => void;
+    flush: () => Promise<void>;
+    shutdown: () => Promise<void>;
+};
+export declare class PostHogAnalytics implements Analytics {
+    private posthog;
+    private distinctId;
+    private deploymentId;
+    private readonly flushOnExit;
+    constructor(posthog: PostHogClient);
+    init(client: ValkeyLike, name: string, configProps?: Record<string, unknown>): Promise<void>;
+    private resolveDeploymentId;
+    capture(event: string, properties?: Record<string, unknown>): void;
+    flush(): Promise<void>;
+    shutdown(): Promise<void>;
+}
 export declare function createAnalytics(opts?: AnalyticsOptions): Promise<Analytics>;
+export {};

package/dist/analytics.js

@@ -39,8 +39,11 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NOOP_ANALYTICS = void 0;
+exports.PostHogAnalytics = exports.NOOP_ANALYTICS = void 0;
 exports.createAnalytics = createAnalytics;
+const node_fs_1 = require("node:fs");
+const node_os_1 = require("node:os");
+const node_path_1 = require("node:path");
 const EVENT_PREFIX = 'semantic_cache:';
 // Build-time placeholders — replaced by scripts/inject-telemetry-defaults.mjs
 // When the placeholder is NOT replaced, the startsWith('__') guard treats it as unset.
@@ -49,41 +52,126 @@ const BAKED_POSTHOG_HOST = '__BETTERDB_POSTHOG_HOST__';
 exports.NOOP_ANALYTICS = {
     async init() { },
     capture() { },
+    async flush() { },
     async shutdown() { },
 };
 function isTelemetryOptedOut() {
     const val = process.env.BETTERDB_TELEMETRY;
     return val !== undefined && ['false', '0', 'no', 'off'].includes(val.toLowerCase());
 }
+const INSTALL_ID_ENV = 'BETTERDB_INSTANCE_ID';
+// Holds a minted id for the rest of the process when persistence fails, so
+// repeated calls (or parallel init) return one stable ephemeral identity.
+let ephemeralInstallId;
+function installIdPath() {
+    const base = process.env.XDG_STATE_HOME;
+    const root = base ? base : (0, node_path_1.join)((0, node_os_1.homedir)(), '.betterdb');
+    return (0, node_path_1.join)(root, 'instance_id');
+}
+/**
+ * Stable per-install identity for product analytics. Persisted on the local
+ * machine (not in Valkey), so a fleet of processes sharing one Valkey is
+ * counted as many installs rather than collapsing to one. Pin it via
+ * BETTERDB_INSTANCE_ID for ephemeral containers that would otherwise mint a
+ * fresh id every run. Falls back to an ephemeral per-process id when no
+ * writable location is available.
+ */
+function getInstallId() {
+    const override = process.env[INSTALL_ID_ENV];
+    if (override)
+        return override;
+    const path = installIdPath();
+    try {
+        const existing = (0, node_fs_1.readFileSync)(path, 'utf8').trim();
+        if (existing)
+            return existing;
+    }
+    catch {
+        // no existing id
+    }
+    const newId = ephemeralInstallId ?? crypto.randomUUID();
+    try {
+        (0, node_fs_1.mkdirSync)((0, node_path_1.dirname)(path), { recursive: true });
+        (0, node_fs_1.writeFileSync)(path, newId);
+    }
+    catch {
+        // Persistence failed — hold the id for the rest of this process so
+        // repeated calls return a stable ephemeral identity.
+        ephemeralInstallId = newId;
+    }
+    return newId;
+}
 class PostHogAnalytics {
     posthog;
     distinctId = '';
+    deploymentId = '';
+    // Library consumers are frequently short-lived scripts that never call
+    // shutdown(), so PostHog's buffered events (flushAt=20, flushInterval=10s)
+    // would be dropped when the process exits before the queue drains. Flush
+    // when the event loop empties so lifecycle events are actually delivered.
+    // Only enabled instances reach here — the opt-out path returns
+    // NOOP_ANALYTICS and registers nothing, keeping disabled consumers silent.
+    flushOnExit = () => {
+        void this.flush();
+    };
     constructor(posthog) {
         this.posthog = posthog;
+        process.once('beforeExit', this.flushOnExit);
     }
     async init(client, name, configProps) {
+        this.distinctId = getInstallId();
+        this.deploymentId = await this.resolveDeploymentId(client, name);
+        const merged = { ...(configProps ?? {}) };
+        if (this.deploymentId)
+            merged.deployment_id = this.deploymentId;
+        this.capture('cache_init', merged);
+        // Flush the start event immediately so it lands even for processes that exit
+        // before the flush interval or the beforeExit hook fires.
+        await this.flush();
+    }
+    async resolveDeploymentId(client, name) {
+        // The Valkey-scoped id groups all clients pointed at the same store, so a
+        // shared-Valkey fleet can still be rolled up into one deployment.
         const idKey = `${name}:__instance_id`;
-        let id = await client.get(idKey);
-        if (!id) {
-            id = crypto.randomUUID();
+        try {
+            const existing = await client.get(idKey);
+            if (existing)
+                return existing;
+            const id = crypto.randomUUID();
             await client.set(idKey, id);
+            return id;
+        }
+        catch {
+            return '';
         }
-        this.distinctId = id;
-        this.capture('cache_init', configProps);
     }
     capture(event, properties) {
         try {
+            const props = { ...(properties ?? {}) };
+            if (this.deploymentId && props.deployment_id === undefined) {
+                props.deployment_id = this.deploymentId;
+            }
             this.posthog.capture({
                 distinctId: this.distinctId,
                 event: `${EVENT_PREFIX}${event}`,
-                properties,
+                properties: props,
             });
         }
         catch {
             // never throw from analytics
         }
     }
+    async flush() {
+        try {
+            await this.posthog.flush();
+        }
+        catch {
+            // swallow
+        }
+    }
     async shutdown() {
+        // Explicit shutdown supersedes the beforeExit backstop.
+        process.removeListener('beforeExit', this.flushOnExit);
         try {
             await this.posthog.shutdown();
         }
@@ -92,18 +180,16 @@ class PostHogAnalytics {
         }
     }
 }
+exports.PostHogAnalytics = PostHogAnalytics;
 async function createAnalytics(opts) {
     if (opts?.disabled || isTelemetryOptedOut()) {
         return exports.NOOP_ANALYTICS;
     }
-    // Key resolution: opts.apiKey → BETTERDB_POSTHOG_API_KEY env var → baked wheel value
-    const bakedKey = BAKED_POSTHOG_API_KEY.startsWith('__') ? undefined : BAKED_POSTHOG_API_KEY;
-    const apiKey = opts?.apiKey ?? process.env.BETTERDB_POSTHOG_API_KEY ?? bakedKey;
+    const apiKey = BAKED_POSTHOG_API_KEY.startsWith('__') ? undefined : BAKED_POSTHOG_API_KEY;
     if (!apiKey) {
         return exports.NOOP_ANALYTICS;
     }
-    const bakedHost = BAKED_POSTHOG_HOST.startsWith('__') ? undefined : BAKED_POSTHOG_HOST;
-    const host = opts?.host ?? process.env.BETTERDB_POSTHOG_HOST ?? bakedHost;
+    const host = BAKED_POSTHOG_HOST.startsWith('__') ? undefined : BAKED_POSTHOG_HOST;
     try {
         // @ts-ignore — posthog-node is an optional peer dep
         const { PostHog } = await Promise.resolve().then(() => __importStar(require('posthog-node')));

package/dist/types.d.ts

@@ -90,10 +90,6 @@ export interface SemanticCacheOptions {
         registry?: Registry;
     };
     analytics?: {
-        /** PostHog API key. Overrides the build-time baked key if set. */
-        apiKey?: string;
-        /** PostHog host. Overrides the build-time baked host if set. */
-        host?: string;
         /** Disable analytics. Also controlled by BETTERDB_TELEMETRY env var. */
         disabled?: boolean;
         /** Interval in ms for periodic stats snapshots. Default: 300_000 (5 min). 0 to disable. */

package/dist/utils.d.ts

@@ -1,10 +1,6 @@
 /** SHA-256 hex digest of a string. */
 export declare function sha256(text: string): string;
-/** Escape a string for safe use as a Valkey Search TAG filter value.
- * Spaces are included because Valkey Search treats unescaped spaces as term
- * separators (OR semantics), which would broaden the filter unintentionally.
- */
-export declare function escapeTag(value: string): string;
+export { escapeTag, encodeFloat32, parseFtSearchResponse } from '@betterdb/valkey-search-kit';
 export type ContentBlock = TextBlock | BinaryBlock | ToolCallBlock | ToolResultBlock | ReasoningBlock;
 export interface TextBlock {
     type: 'text';
@@ -58,26 +54,3 @@ export declare function extractText(blocks: ContentBlock[]): string;
  * Used for the binary_refs TAG field on cache entries.
  */
 export declare function extractBinaryRefs(blocks: ContentBlock[]): string[];
-/**
- * Encode number[] as a little-endian Float32 Buffer.
- * Used to store embeddings as binary HSET field values.
- */
-export declare function encodeFloat32(vec: number[]): Buffer;
-/**
- * Parse a raw FT.SEARCH response from iovalkey's client.call().
- *
- * iovalkey returns FT.SEARCH results in the following shape:
- *   [totalCount, key1, [field1, val1, field2, val2, ...], key2, [...], ...]
- *
- * - totalCount is a string (e.g. "2")
- * - Each key is a string
- * - Each field list is a flat string array: [fieldName, value, fieldName, value, ...]
- *
- * Returns an array of { key: string, fields: Record<string, string> }.
- * Returns [] if totalCount is "0" or the response is empty/malformed.
- * Never throws — on any parse error, returns [].
- */
-export declare function parseFtSearchResponse(raw: unknown): Array<{
-    key: string;
-    fields: Record<string, string>;
-}>;

package/dist/utils.js

@@ -1,23 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseFtSearchResponse = exports.encodeFloat32 = exports.escapeTag = void 0;
 exports.sha256 = sha256;
-exports.escapeTag = escapeTag;
 exports.extractText = extractText;
 exports.extractBinaryRefs = extractBinaryRefs;
-exports.encodeFloat32 = encodeFloat32;
-exports.parseFtSearchResponse = parseFtSearchResponse;
 const node_crypto_1 = require("node:crypto");
 /** SHA-256 hex digest of a string. */
 function sha256(text) {
     return (0, node_crypto_1.createHash)('sha256').update(text).digest('hex');
 }
-/** Escape a string for safe use as a Valkey Search TAG filter value.
- * Spaces are included because Valkey Search treats unescaped spaces as term
- * separators (OR semantics), which would broaden the filter unintentionally.
- */
-function escapeTag(value) {
-    return value.replace(/[,.<>{}[\]"':;!@#$%^&*()\-+=~|/\\ ]/g, '\\$&');
-}
+var valkey_search_kit_1 = require("@betterdb/valkey-search-kit");
+Object.defineProperty(exports, "escapeTag", { enumerable: true, get: function () { return valkey_search_kit_1.escapeTag; } });
+Object.defineProperty(exports, "encodeFloat32", { enumerable: true, get: function () { return valkey_search_kit_1.encodeFloat32; } });
+Object.defineProperty(exports, "parseFtSearchResponse", { enumerable: true, get: function () { return valkey_search_kit_1.parseFtSearchResponse; } });
 /**
  * Extract all text from a ContentBlock array, joining TextBlock.text values with a space.
  * Used to derive the embedding text from a multi-modal prompt.
@@ -38,70 +33,3 @@ function extractBinaryRefs(blocks) {
         .map((b) => b.ref)
         .sort();
 }
-/**
- * Encode number[] as a little-endian Float32 Buffer.
- * Used to store embeddings as binary HSET field values.
- */
-function encodeFloat32(vec) {
-    const buf = Buffer.alloc(vec.length * 4);
-    for (let i = 0; i < vec.length; i++) {
-        buf.writeFloatLE(vec[i], i * 4);
-    }
-    return buf;
-}
-/**
- * Parse a raw FT.SEARCH response from iovalkey's client.call().
- *
- * iovalkey returns FT.SEARCH results in the following shape:
- *   [totalCount, key1, [field1, val1, field2, val2, ...], key2, [...], ...]
- *
- * - totalCount is a string (e.g. "2")
- * - Each key is a string
- * - Each field list is a flat string array: [fieldName, value, fieldName, value, ...]
- *
- * Returns an array of { key: string, fields: Record<string, string> }.
- * Returns [] if totalCount is "0" or the response is empty/malformed.
- * Never throws — on any parse error, returns [].
- */
-function parseFtSearchResponse(raw) {
-    try {
-        if (!Array.isArray(raw) || raw.length < 1) {
-            return [];
-        }
-        const totalCount = typeof raw[0] === 'string' ? parseInt(raw[0], 10) : Number(raw[0]);
-        if (!totalCount || totalCount <= 0) {
-            return [];
-        }
-        const results = [];
-        let i = 1;
-        while (i < raw.length) {
-            const key = raw[i];
-            if (typeof key !== 'string') {
-                i++;
-                continue;
-            }
-            const fieldList = raw[i + 1];
-            const fields = {};
-            if (Array.isArray(fieldList)) {
-                const len = fieldList.length - (fieldList.length % 2);
-                for (let j = 0; j < len; j += 2) {
-                    const fieldName = String(fieldList[j]);
-                    const fieldValue = String(fieldList[j + 1]);
-                    fields[fieldName] = fieldValue;
-                }
-                i += 2;
-            }
-            else {
-                // No field list follows the key (e.g. RETURN 0 mode)
-                results.push({ key, fields });
-                i++;
-                continue;
-            }
-            results.push({ key, fields });
-        }
-        return results;
-    }
-    catch {
-        return [];
-    }
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@betterdb/semantic-cache",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "Valkey-native semantic cache for LLM applications with built-in OpenTelemetry and Prometheus instrumentation",
   "keywords": [
     "valkey",
@@ -93,18 +93,11 @@
     "dist",
     "README.md"
   ],
-  "scripts": {
-    "build": "tsc && node scripts/inject-telemetry-defaults.mjs",
-    "typecheck": "tsc --noEmit",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "clean": "rm -rf dist",
-    "update:pricing": "node scripts/update-model-prices.mjs"
-  },
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
     "posthog-node": ">=4.0.0",
-    "prom-client": "^15.1.3"
+    "prom-client": "^15.1.3",
+    "@betterdb/valkey-search-kit": "0.1.0"
   },
   "engines": {
     "node": ">=20.0.0"
@@ -137,5 +130,13 @@
     "openai": {
       "optional": true
     }
+  },
+  "scripts": {
+    "build": "tsc && node scripts/inject-telemetry-defaults.mjs",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "clean": "rm -rf dist",
+    "update:pricing": "node scripts/update-model-prices.mjs"
   }
-}
+}