openai-cache 1.0.14 → 1.0.22

package/README.md

@@ -1,6 +1,8 @@
 # Cache OpenAI
 A simple caching layer for [OpenAI API](https://www.npmjs.com/package/openai), designed to reduce redundant API calls and save time and costs. It works by intercepting API requests and storing their responses in a cache. When the same request is made again, the cached response is returned instead of making a new API call.
 
+It supports **text responses**, **binary responses** (e.g. images), and **streaming** (SSE).
+
 It is based on the [cacheable](https://cacheable.org/docs/) library, which provides a simple interface for caching data with support for various storage backends (like in-memory, Redis, SQLite, etc). This allows you to easily integrate caching into your OpenAI API usage without having to manage the caching logic yourself.
 
 You can use any Keyv storage backend (like Redis, filesystem, etc) to store the cached responses. 
@@ -50,6 +52,12 @@ const response = await client.responses.create({
 console.log(response.output_text);
 ```
 
+## Environment Variables
+
+| Variable | Values | Description |
+|---|---|---|
+| `OPENAI_CACHE` | `disabled` | Bypass the cache: responses are still written but never read from cache. Useful for testing/debugging without changing code. |
+
 ## PRO/CON
 - **PRO**: Reduces redundant API calls, saving time and costs.
 data.

package/dist/openai_cache copy.d.ts

@@ -0,0 +1,54 @@
+import { Cacheable } from "cacheable";
+type FetchFn = typeof globalThis.fetch;
+type FetchInput = Parameters<FetchFn>[0];
+type FetchInit = Parameters<FetchFn>[1];
+type FetchResponse = Awaited<ReturnType<FetchFn>>;
+/**
+ * OpenAICachingCacheable is a wrapper around the Fetch API that adds caching capabilities for OpenAI requests.
+ * It uses a Cacheable instance to store and retrieve cached responses based on a hash of the request details.
+ */
+export default class OpenAICache {
+    private readonly _cache;
+    private readonly _markResponseEnabled;
+    static readonly MarkResponseName = "X_FROM_OPENAI_CACHE";
+    /**
+     * Creates a new instance of OpenAICache.
+     *
+     * @param cache cacheable instance
+     * @param options.markResponseEnabled whether to mark cached responses with an additional property in the JSON body (default: true).
+     * This can be useful for downstream logic that needs to differentiate between live and cached responses, but it does modify
+     * the original response body so it is optional. so the response is { X_FROM_OPENAI_CACHE: true, ...originalResponseBody }
+     */
+    constructor(cache?: Cacheable, { markResponseEnabled }?: {
+        markResponseEnabled?: boolean;
+    });
+    /**
+     * Cleans the OpenAI cache by deleting all cached values.
+     */
+    cleanCache(): Promise<void>;
+    /**
+     * return a fetch function that can be passed to OpenAI client for caching support
+     *
+     * ```js
+     * const openai = new OpenAI({
+     *   fetch: openaiCache.getFetchFn()
+     * });
+     * ```
+     */
+    getFetchFn(): (input: FetchInput, init?: FetchInit) => Promise<FetchResponse>;
+    /**
+     * This is the fetch() implementation that adds caching for OpenAI requests.
+     *
+     * @param input The resource that you wish to fetch.
+     * @param init An options object containing any custom settings that you want to apply to the request.
+     * @returns A Promise that resolves to the Response to that request.
+     */
+    private _fetch;
+    /**
+     * Remove transfer/content encodings that no longer apply once the body is materialized
+     * and optionally set a correct content-length for the cached payload.
+     */
+    private static _normalizeHeaders;
+    private static _serializeBodyForHash;
+}
+export {};

package/dist/openai_cache copy.js

@@ -0,0 +1,157 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// node imports
+const node_crypto_1 = __importDefault(require("node:crypto"));
+const node_buffer_1 = require("node:buffer");
+const cacheable_1 = require("cacheable");
+///////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////////////////////////////////////////
+//	OpenAICache
+///////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////////////////////////////////////////
+/**
+ * OpenAICachingCacheable is a wrapper around the Fetch API that adds caching capabilities for OpenAI requests.
+ * It uses a Cacheable instance to store and retrieve cached responses based on a hash of the request details.
+ */
+class OpenAICache {
+    /**
+     * Creates a new instance of OpenAICache.
+     *
+     * @param cache cacheable instance
+     * @param options.markResponseEnabled whether to mark cached responses with an additional property in the JSON body (default: true).
+     * This can be useful for downstream logic that needs to differentiate between live and cached responses, but it does modify
+     * the original response body so it is optional. so the response is { X_FROM_OPENAI_CACHE: true, ...originalResponseBody }
+     */
+    constructor(cache, { markResponseEnabled = false } = {}) {
+        this._cache = cache !== null && cache !== void 0 ? cache : new cacheable_1.Cacheable();
+        this._markResponseEnabled = markResponseEnabled;
+    }
+    /**
+     * Cleans the OpenAI cache by deleting all cached values.
+     */
+    async cleanCache() {
+        await this._cache.clear();
+    }
+    /**
+     * return a fetch function that can be passed to OpenAI client for caching support
+     *
+     * ```js
+     * const openai = new OpenAI({
+     *   fetch: openaiCache.getFetchFn()
+     * });
+     * ```
+     */
+    getFetchFn() {
+        return this._fetch.bind(this);
+    }
+    /**
+     * This is the fetch() implementation that adds caching for OpenAI requests.
+     *
+     * @param input The resource that you wish to fetch.
+     * @param init An options object containing any custom settings that you want to apply to the request.
+     * @returns A Promise that resolves to the Response to that request.
+     */
+    async _fetch(input, init) {
+        var _a, _b;
+        // Extract the URL from the input (string or Request)
+        const url = typeof input === "string" ? input : input instanceof Request ? input.url : input.toString();
+        // Normalize HTTP method
+        const method = ((init === null || init === void 0 ? void 0 : init.method) || "GET").toUpperCase();
+        // Generate body hash payload
+        const bodyForHash = OpenAICache._serializeBodyForHash(init === null || init === void 0 ? void 0 : init.body);
+        // If body type unsupported, skip caching
+        if (bodyForHash === null)
+            return fetch(input, init);
+        // Build cache key and file path
+        const cacheKey = node_crypto_1.default.createHash("sha256")
+            .update(`${method}:${url}:${bodyForHash}`)
+            .digest("hex");
+        const cached = (await this._cache.get(cacheKey));
+        if (cached !== undefined && process.env.OPENAI_CACHE !== "disabled") {
+            const bodyEncoding = (_a = cached.bodyEncoding) !== null && _a !== void 0 ? _a : "utf8";
+            const cachedBodyBuffer = node_buffer_1.Buffer.from(cached.body, bodyEncoding);
+            // Return cached response
+            let newResponse = new Response(cachedBodyBuffer, {
+                status: cached.status,
+                headers: cached.headers,
+            });
+            // honor this._markResponseEnabled option to indicate cache hit
+            const contentTypeIsJson = ((_b = newResponse.headers.get("content-type")) === null || _b === void 0 ? void 0 : _b.includes("application/json")) ? true : false;
+            if (this._markResponseEnabled && contentTypeIsJson) {
+                try {
+                    // decode JSON from cachedBodyBuffer
+                    const bodyJson = JSON.parse(cachedBodyBuffer.toString());
+                    // Set the magic property to indicate this response is from cache
+                    bodyJson.X_FROM_OPENAI_CACHE = true;
+                    // Rebuild response with modified body
+                    const modifiedBodyBuffer = node_buffer_1.Buffer.from(JSON.stringify(bodyJson));
+                    newResponse = new Response(modifiedBodyBuffer, { status: cached.status, headers: cached.headers, });
+                }
+                catch (error) {
+                    // If parsing fails, return the original cached response without modification
+                    console.warn("Failed to parse cached response body as JSON for header modification:", error);
+                }
+            }
+            // Return cached response (body already buffered)
+            return newResponse;
+        }
+        // Perform network fetch
+        const response = await fetch(input, init);
+        const clonedResponse = response.clone();
+        // Materialize response body for caching
+        const responseBuffer = node_buffer_1.Buffer.from(await clonedResponse.arrayBuffer());
+        // Collect headers and normalize them
+        const headers = Array.from(clonedResponse.headers.entries());
+        const normalizedHeaders = OpenAICache._normalizeHeaders(headers, responseBuffer.length);
+        if (response.ok) {
+            await this._cache.set(cacheKey, {
+                status: clonedResponse.status,
+                headers: normalizedHeaders,
+                body: responseBuffer.toString("base64"),
+                bodyEncoding: "base64",
+            });
+        }
+        // Return live response (body already buffered)
+        return new Response(responseBuffer, { status: response.status, headers: normalizedHeaders });
+    }
+    ///////////////////////////////////////////////////////////////////////////////
+    ///////////////////////////////////////////////////////////////////////////////
+    //	Private functions
+    ///////////////////////////////////////////////////////////////////////////////
+    ///////////////////////////////////////////////////////////////////////////////
+    /**
+     * Remove transfer/content encodings that no longer apply once the body is materialized
+     * and optionally set a correct content-length for the cached payload.
+     */
+    static _normalizeHeaders(headers, bodyLength) {
+        const drop = new Set([
+            "content-encoding", // body is already decoded by fetch()
+            "transfer-encoding",
+            "content-length", // will be recalculated
+        ]);
+        const filtered = headers.filter(([name]) => drop.has(name.toLowerCase()) === false);
+        if (bodyLength !== undefined) {
+            filtered.push(["content-length", String(bodyLength)]);
+        }
+        return filtered;
+    }
+    // Serialize body into a deterministic string for hashing
+    static _serializeBodyForHash(body) {
+        if (body === undefined || body === null)
+            return "";
+        if (typeof body === "string")
+            return body;
+        if (node_buffer_1.Buffer.isBuffer(body))
+            return body.toString("base64");
+        if (body instanceof ArrayBuffer)
+            return node_buffer_1.Buffer.from(body).toString("base64");
+        if (ArrayBuffer.isView(body))
+            return node_buffer_1.Buffer.from(body.buffer, body.byteOffset, body.byteLength).toString("base64");
+        return null; // unsupported body type
+    }
+}
+OpenAICache.MarkResponseName = "X_FROM_OPENAI_CACHE";
+exports.default = OpenAICache;

package/dist/openai_cache.d.ts

@@ -6,10 +6,29 @@ type FetchResponse = Awaited<ReturnType<FetchFn>>;
 /**
  * OpenAICachingCacheable is a wrapper around the Fetch API that adds caching capabilities for OpenAI requests.
  * It uses a Cacheable instance to store and retrieve cached responses based on a hash of the request details.
+ * - **OPENAI_CACHE** environment variable can be set to "disabled" to disable cache and always fetch
+ * live responses (while still allowing manual cache management via cleanCache() and direct cache access)
+ *
+ * Example usage:
+ *
+ * ```js
+ * import { Cacheable } from 'cacheable';
+ * import OpenAICache from 'openai-cache';
+ * import KeyvSqlite from '@keyv/sqlite';
+ * import { OpenAI } from 'openai';
+ *
+ * const cache = new Cacheable({ secondary: new KeyvSqlite('sqlite://./openai_cache.sqlite') });
+ * const openaiCache = new OpenAICache(cache);
+ * const openaiClient = new OpenAI({
+ *   fetch: openaiCache.getFetchFn()
+ * });
+ * ```
  */
 export default class OpenAICache {
     private readonly _cache;
     private readonly _markResponseEnabled;
+    private readonly _verboseLevel;
+    private disabledCacheWarningLogged;
     static readonly MarkResponseName = "X_FROM_OPENAI_CACHE";
     /**
      * Creates a new instance of OpenAICache.
@@ -19,8 +38,9 @@ export default class OpenAICache {
      * This can be useful for downstream logic that needs to differentiate between live and cached responses, but it does modify
      * the original response body so it is optional. so the response is { X_FROM_OPENAI_CACHE: true, ...originalResponseBody }
      */
-    constructor(cache?: Cacheable, { markResponseEnabled }?: {
+    constructor(cache?: Cacheable, { markResponseEnabled, verboseLevel, }?: {
         markResponseEnabled?: boolean;
+        verboseLevel?: number;
     });
     /**
      * Cleans the OpenAI cache by deleting all cached values.
@@ -44,11 +64,18 @@ export default class OpenAICache {
      * @returns A Promise that resolves to the Response to that request.
      */
     private _fetch;
+    /**
+     * Wraps a streaming response in a pass-through ReadableStream that caches the
+     * full body in the background once the stream completes.
+     */
+    private static _createCachingStreamResponse;
     /**
      * Remove transfer/content encodings that no longer apply once the body is materialized
      * and optionally set a correct content-length for the cached payload.
      */
     private static _normalizeHeaders;
+    private static _isStreamingResponse;
     private static _serializeBodyForHash;
 }
 export {};
+//# sourceMappingURL=openai_cache.d.ts.map

package/dist/openai_cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openai_cache.d.ts","sourceRoot":"","sources":["../src/openai_cache.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAUtC,KAAK,OAAO,GAAG,OAAO,UAAU,CAAC,KAAK,CAAC;AACvC,KAAK,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AACzC,KAAK,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AAExC,KAAK,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;AAelD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IAC/B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAY;IACnC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAU;IAC/C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,0BAA0B,CAAkB;IACpD,gBAAuB,gBAAgB,yBAAyB;IAEhE;;;;;;;OAOG;gBACS,KAAK,CAAC,EAAE,SAAS,EAAE,EAC9B,mBAA2B,EAC3B,YAAgB,GAChB,GAAE;QACF,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B,YAAY,CAAC,EAAE,MAAM,CAAA;KAChB;IAMN;;OAEG;IACU,UAAU;IAIvB;;;;;;;;OAQG;IACI,UAAU,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,SAAS,KAAK,OAAO,CAAC,aAAa,CAAC;IAIpF;;;;;;OAMG;YACW,MAAM;IA6HpB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,4BAA4B;IAwC3C;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAehC,OAAO,CAAC,MAAM,CAAC,oBAAoB;IASnC,OAAO,CAAC,MAAM,CAAC,qBAAqB;CAmBpC"}

package/dist/openai_cache.js

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const node_crypto_1 = __importDefault(require("node:crypto"));
 const node_buffer_1 = require("node:buffer");
 const cacheable_1 = require("cacheable");
+const chalk_1 = __importDefault(require("chalk"));
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////
 //	OpenAICache
@@ -15,8 +16,30 @@ const cacheable_1 = require("cacheable");
 /**
  * OpenAICachingCacheable is a wrapper around the Fetch API that adds caching capabilities for OpenAI requests.
  * It uses a Cacheable instance to store and retrieve cached responses based on a hash of the request details.
+ * - **OPENAI_CACHE** environment variable can be set to "disabled" to disable cache and always fetch
+ * live responses (while still allowing manual cache management via cleanCache() and direct cache access)
+ *
+ * Example usage:
+ *
+ * ```js
+ * import { Cacheable } from 'cacheable';
+ * import OpenAICache from 'openai-cache';
+ * import KeyvSqlite from '@keyv/sqlite';
+ * import { OpenAI } from 'openai';
+ *
+ * const cache = new Cacheable({ secondary: new KeyvSqlite('sqlite://./openai_cache.sqlite') });
+ * const openaiCache = new OpenAICache(cache);
+ * const openaiClient = new OpenAI({
+ *   fetch: openaiCache.getFetchFn()
+ * });
+ * ```
  */
 class OpenAICache {
+    _cache;
+    _markResponseEnabled;
+    _verboseLevel;
+    disabledCacheWarningLogged = false;
+    static MarkResponseName = "X_FROM_OPENAI_CACHE";
     /**
      * Creates a new instance of OpenAICache.
      *
@@ -25,9 +48,10 @@ class OpenAICache {
      * This can be useful for downstream logic that needs to differentiate between live and cached responses, but it does modify
      * the original response body so it is optional. so the response is { X_FROM_OPENAI_CACHE: true, ...originalResponseBody }
      */
-    constructor(cache, { markResponseEnabled = false } = {}) {
-        this._cache = cache !== null && cache !== void 0 ? cache : new cacheable_1.Cacheable();
+    constructor(cache, { markResponseEnabled = false, verboseLevel = 0, } = {}) {
+        this._cache = cache ?? new cacheable_1.Cacheable();
         this._markResponseEnabled = markResponseEnabled;
+        this._verboseLevel = verboseLevel;
     }
     /**
      * Cleans the OpenAI cache by deleting all cached values.
@@ -55,31 +79,56 @@ class OpenAICache {
      * @returns A Promise that resolves to the Response to that request.
      */
     async _fetch(input, init) {
-        var _a, _b;
         // Extract the URL from the input (string or Request)
         const url = typeof input === "string" ? input : input instanceof Request ? input.url : input.toString();
         // Normalize HTTP method
-        const method = ((init === null || init === void 0 ? void 0 : init.method) || "GET").toUpperCase();
+        const method = (init?.method || "GET").toUpperCase();
+        // debugger
         // Generate body hash payload
-        const bodyForHash = OpenAICache._serializeBodyForHash(init === null || init === void 0 ? void 0 : init.body);
+        const bodyForHash = OpenAICache._serializeBodyForHash(init?.body);
         // If body type unsupported, skip caching
-        if (bodyForHash === null)
+        if (bodyForHash === null) {
+            if (this._verboseLevel > 1) {
+                console.warn(chalk_1.default.yellow(`Skipping cache for ${method} ${url} due to unsupported body type`));
+            }
             return fetch(input, init);
+        }
         // Build cache key and file path
         const cacheKey = node_crypto_1.default.createHash("sha256")
             .update(`${method}:${url}:${bodyForHash}`)
             .digest("hex");
-        const cached = (await this._cache.get(cacheKey));
-        if (cached !== undefined && process.env.OPENAI_CACHE !== "disabled") {
-            const bodyEncoding = (_a = cached.bodyEncoding) !== null && _a !== void 0 ? _a : "utf8";
-            const cachedBodyBuffer = node_buffer_1.Buffer.from(cached.body, bodyEncoding);
+        // console.log("cacheKey", cacheKey, bodyForHash);
+        // Log a warning if cache is disabled via environment variable, but only once to avoid spamming the console
+        if (process.env.OPENAI_CACHE === "disabled" && this.disabledCacheWarningLogged === false) {
+            if (this._verboseLevel > 0) {
+                console.warn(chalk_1.default.red("OpenAI cache is disabled via OPENAI_CACHE=disabled. All requests will be live and no caching will occur."));
+            }
+            this.disabledCacheWarningLogged = true;
+        }
+        const cachedValue = await this._cache.get(cacheKey);
+        if (cachedValue !== undefined && process.env.OPENAI_CACHE !== "disabled") {
+            const bodyEncoding = cachedValue.bodyEncoding ?? "utf8";
+            const cachedBodyBuffer = node_buffer_1.Buffer.from(cachedValue.body, bodyEncoding);
+            // For streaming SSE responses, return directly without JSON modification
+            if (OpenAICache._isStreamingResponse(cachedValue.headers)) {
+                if (this._verboseLevel > 1) {
+                    console.log(chalk_1.default.green(`Cache hit for streamed ${method} ${url}`));
+                }
+                return new Response(cachedBodyBuffer, {
+                    status: cachedValue.status,
+                    headers: cachedValue.headers,
+                });
+            }
+            if (this._verboseLevel > 1) {
+                console.log(chalk_1.default.green(`Cache hit for non-streamed ${method} ${url}`));
+            }
             // Return cached response
             let newResponse = new Response(cachedBodyBuffer, {
-                status: cached.status,
-                headers: cached.headers,
+                status: cachedValue.status,
+                headers: cachedValue.headers,
             });
             // honor this._markResponseEnabled option to indicate cache hit
-            const contentTypeIsJson = ((_b = newResponse.headers.get("content-type")) === null || _b === void 0 ? void 0 : _b.includes("application/json")) ? true : false;
+            const contentTypeIsJson = newResponse.headers.get("content-type")?.includes("application/json") ? true : false;
             if (this._markResponseEnabled && contentTypeIsJson) {
                 try {
                     // decode JSON from cachedBodyBuffer
@@ -88,7 +137,7 @@ class OpenAICache {
                     bodyJson.X_FROM_OPENAI_CACHE = true;
                     // Rebuild response with modified body
                     const modifiedBodyBuffer = node_buffer_1.Buffer.from(JSON.stringify(bodyJson));
-                    newResponse = new Response(modifiedBodyBuffer, { status: cached.status, headers: cached.headers, });
+                    newResponse = new Response(modifiedBodyBuffer, { status: cachedValue.status, headers: cachedValue.headers, });
                 }
                 catch (error) {
                     // If parsing fails, return the original cached response without modification
@@ -100,6 +149,19 @@ class OpenAICache {
         }
         // Perform network fetch
         const response = await fetch(input, init);
+        // For streaming SSE responses, pipe through to enable progressive streaming + background caching
+        if (OpenAICache._isStreamingResponse(response.headers)) {
+            if (this._verboseLevel > 1) {
+                console.log(chalk_1.default.yellow(`Cache miss for streamed ${method} ${url} - caching in background as it streams in`));
+            }
+            if (!response.ok || !response.body) {
+                return response;
+            }
+            return OpenAICache._createCachingStreamResponse(response, this._cache, cacheKey);
+        }
+        if (this._verboseLevel > 1) {
+            console.log(chalk_1.default.yellow(`Cache miss for non-streamed ${method} ${url} - caching in background`));
+        }
         const clonedResponse = response.clone();
         // Materialize response body for caching
         const responseBuffer = node_buffer_1.Buffer.from(await clonedResponse.arrayBuffer());
@@ -122,6 +184,42 @@ class OpenAICache {
     //	Private functions
     ///////////////////////////////////////////////////////////////////////////////
     ///////////////////////////////////////////////////////////////////////////////
+    /**
+     * Wraps a streaming response in a pass-through ReadableStream that caches the
+     * full body in the background once the stream completes.
+     */
+    static _createCachingStreamResponse(response, cache, cacheKey) {
+        const responseStatus = response.status;
+        const responseHeaders = Array.from(response.headers.entries());
+        const chunks = [];
+        const reader = response.body.getReader();
+        const passThrough = new ReadableStream({
+            async pull(controller) {
+                const { done, value } = await reader.read();
+                if (done) {
+                    controller.close();
+                    const fullBody = node_buffer_1.Buffer.concat(chunks);
+                    const normalizedHeaders = OpenAICache._normalizeHeaders(responseHeaders, fullBody.length);
+                    cache.set(cacheKey, {
+                        status: responseStatus,
+                        headers: normalizedHeaders,
+                        body: fullBody.toString("base64"),
+                        bodyEncoding: "base64",
+                    }).catch(() => { });
+                    return;
+                }
+                chunks.push(value);
+                controller.enqueue(value);
+            },
+            cancel() {
+                reader.cancel();
+            },
+        });
+        return new Response(passThrough, {
+            status: responseStatus,
+            headers: responseHeaders,
+        });
+    }
     /**
      * Remove transfer/content encodings that no longer apply once the body is materialized
      * and optionally set a correct content-length for the cached payload.
@@ -138,20 +236,34 @@ class OpenAICache {
         }
         return filtered;
     }
+    // Detect streaming SSE responses by content-type header
+    static _isStreamingResponse(headers) {
+        if (headers instanceof Headers) {
+            return headers.get("content-type")?.includes("text/event-stream") ?? false;
+        }
+        const ct = headers.find(([name]) => name.toLowerCase() === "content-type");
+        return ct?.[1]?.includes("text/event-stream") ?? false;
+    }
     // Serialize body into a deterministic string for hashing
     static _serializeBodyForHash(body) {
+        // Handle null or undefined body
         if (body === undefined || body === null)
             return "";
+        // Handle string body
         if (typeof body === "string")
             return body;
+        // Handle Buffer body
         if (node_buffer_1.Buffer.isBuffer(body))
             return body.toString("base64");
+        // Handle ArrayBuffer body
         if (body instanceof ArrayBuffer)
             return node_buffer_1.Buffer.from(body).toString("base64");
+        // Handle typed arrays (Uint8Array, Int8Array, etc.)
         if (ArrayBuffer.isView(body))
             return node_buffer_1.Buffer.from(body.buffer, body.byteOffset, body.byteLength).toString("base64");
-        return null; // unsupported body type
+        // Return null for unsupported body types to skip caching
+        return null;
     }
 }
-OpenAICache.MarkResponseName = "X_FROM_OPENAI_CACHE";
 exports.default = OpenAICache;
+//# sourceMappingURL=openai_cache.js.map

package/dist/openai_cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openai_cache.js","sourceRoot":"","sources":["../src/openai_cache.ts"],"names":[],"mappings":";;;;;AAAA,eAAe;AACf,8DAAiC;AACjC,6CAAqC;AACrC,yCAAsC;AACtC,kDAA0B;AAsB1B,+EAA+E;AAC/E,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAC/E,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAqB,WAAW;IACd,MAAM,CAAY;IAClB,oBAAoB,CAAU;IAC9B,aAAa,CAAS;IAC/B,0BAA0B,GAAY,KAAK,CAAC;IAC7C,MAAM,CAAU,gBAAgB,GAAG,qBAAqB,CAAC;IAEhE;;;;;;;OAOG;IACH,YAAY,KAAiB,EAAE,EAC9B,mBAAmB,GAAG,KAAK,EAC3B,YAAY,GAAG,CAAC,MAIb,EAAE;QACL,IAAI,CAAC,MAAM,GAAG,KAAK,IAAI,IAAI,qBAAS,EAAE,CAAC;QACvC,IAAI,CAAC,oBAAoB,GAAG,mBAAmB,CAAC;QAChD,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,UAAU;QACtB,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;IAED;;;;;;;;OAQG;IACI,UAAU;QAChB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,MAAM,CAAC,KAAiB,EAAE,IAAgB;QACvD,qDAAqD;QACrD,MAAM,GAAG,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,YAAY,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;QACxG,wBAAwB;QACxB,MAAM,MAAM,GAAG,CAAC,IAAI,EAAE,MAAM,IAAI,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QAErD,WAAW;QAEX,6BAA6B;QAC7B,MAAM,WAAW,GAAG,WAAW,CAAC,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAClE,yCAAyC;QACzC,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;YAC1B,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC,EAAE,CAAC;gBAC5B,OAAO,CAAC,IAAI,CAAC,eAAK,CAAC,MAAM,CAAC,sBAAsB,MAAM,IAAI,GAAG,+BAA+B,CAAC,CAAC,CAAC;YAChG,CAAC;YACD,OAAO,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC3B,CAAC;QAID,gCAAgC;QAChC,MAAM,QAAQ,GAAG,qBAAM,CAAC,UAAU,CAAC,QAAQ,CAAC;aAC1C,MAAM,CAAC,GAAG,MAAM,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC;aACzC,MAAM,CAAC,KAAK,CAAC,CAAC;QAEhB,kDAAkD;QAElD,2GAA2G;QAC3G,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,KAAK,UAAU,IAAI,IAAI,CAAC,0BAA0B,KAAK,KAAK,EAAE,CAAC;YAC1F,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC,EAAE,CAAC;gBAC5B,OAAO,CAAC,IAAI,CAAC,eAAK,CAAC,GAAG,CAAC,0GAA0G,CAAC,CAAC,CAAC;YACrI,CAAC;YACD,IAAI,CAAC,0BAA0B,GAAG,IAAI,CAAC;QACxC,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAsB,QAAQ,CAAC,CAAA;QACxE,IAAI,WAAW,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,KAAK,UAAU,EAAE,CAAC;YAC1E,MAAM,YAAY,GAAmB,WAAW,CAAC,YAAY,IAAI,MAAM,CAAC;YACxE,MAAM,gBAAgB,GAAG,oBAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;YAGrE,yEAAyE;YACzE,IAAI,WAAW,CAAC,oBAAoB,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC3D,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC,EAAE,CAAC;oBAC5B,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,0BAA0B,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC;gBACrE,CAAC;gBACD,OAAO,IAAI,QAAQ,CAAC,gBAAgB,EAAE;oBACrC,MAAM,EAAE,WAAW,CAAC,MAAM;oBAC1B,OAAO,EAAE,WAAW,CAAC,OAAO;iBAC5B,CAAC,CAAC;YACJ,CAAC;YAED,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC,EAAE,CAAC;gBAC5B,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,8BAA8B,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC;YACzE,CAAC;YAED,yBAAyB;YACzB,IAAI,WAAW,GAAG,IAAI,QAAQ,CAAC,gBAAgB,EAAE;gBAChD,MAAM,EAAE,WAAW,CAAC,MAAM;gBAC1B,OAAO,EAAE,WAAW,CAAC,OAAO;aAC5B,CAAC,CAAC;YACH,+DAA+D;YAC/D,MAAM,iBAAiB,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;YAC/G,IAAI,IAAI,CAAC,oBAAoB,IAAI,iBAAiB,EAAE,CAAC;gBACpD,IAAI,CAAC;oBACJ,oCAAoC;oBACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC,CAAC;oBACzD,iEAAiE;oBACjE,QAAQ,CAAC,mBAAmB,GAAG,IAAI,CAAC;oBACpC,sCAAsC;oBACtC,MAAM,kBAAkB,GAAG,oBAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;oBACjE,WAAW,GAAG,IAAI,QAAQ,CAAC,kBAAkB,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,CAAC,CAAC;gBAC/G,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBAChB,6EAA6E;oBAC7E,OAAO,CAAC,IAAI,CAAC,uEAAuE,EAAE,KAAK,CAAC,CAAC;gBAC9F,CAAC;YACF,CAAC;YACD,iDAAiD;YACjD,OAAO,WAAW,CAAC;QACpB,CAAC;QAED,wBAAwB;QACxB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAE1C,iGAAiG;QACjG,IAAI,WAAW,CAAC,oBAAoB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YACxD,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC,EAAE,CAAC;gBAC5B,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,2BAA2B,MAAM,IAAI,GAAG,2CAA2C,CAAC,CAAC,CAAC;YAChH,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACpC,OAAO,QAAQ,CAAC;YACjB,CAAC;YACD,OAAO,WAAW,CAAC,4BAA4B,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAClF,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC,EAAE,CAAC;YAC5B,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,+BAA+B,MAAM,IAAI,GAAG,0BAA0B,CAAC,CAAC,CAAC;QACnG,CAAC;QAED,MAAM,cAAc,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;QACxC,wCAAwC;QACxC,MAAM,cAAc,GAAG,oBAAM,CAAC,IAAI,CAAC,MAAM,cAAc,CAAC,WAAW,EAAE,CAAC,CAAC;QACvE,qCAAqC;QACrC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;QAC7D,MAAM,iBAAiB,GAAG,WAAW,CAAC,iBAAiB,CAAC,OAAO,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;QAExF,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE;gBAC/B,MAAM,EAAE,cAAc,CAAC,MAAM;gBAC7B,OAAO,EAAE,iBAAiB;gBAC1B,IAAI,EAAE,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBACvC,YAAY,EAAE,QAAQ;aACtB,CAAC,CAAC;QACJ,CAAC;QAED,+CAA+C;QAC/C,OAAO,IAAI,QAAQ,CAAC,cAAc,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED,+EAA+E;IAC/E,+EAA+E;IAC/E,oBAAoB;IACpB,+EAA+E;IAC/E,+EAA+E;IAE/E;;;OAGG;IACK,MAAM,CAAC,4BAA4B,CAC1C,QAAuB,EACvB,KAAgB,EAChB,QAAgB;QAEhB,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,CAAC;QACvC,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/D,MAAM,MAAM,GAAiB,EAAE,CAAC;QAChC,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAK,CAAC,SAAS,EAAE,CAAC;QAE1C,MAAM,WAAW,GAAG,IAAI,cAAc,CAAa;YAClD,KAAK,CAAC,IAAI,CAAC,UAAU;gBACpB,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC5C,IAAI,IAAI,EAAE,CAAC;oBACV,UAAU,CAAC,KAAK,EAAE,CAAC;oBACnB,MAAM,QAAQ,GAAG,oBAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBACvC,MAAM,iBAAiB,GAAG,WAAW,CAAC,iBAAiB,CAAC,eAAe,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;oBAC1F,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE;wBACnB,MAAM,EAAE,cAAc;wBACtB,OAAO,EAAE,iBAAiB;wBAC1B,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC;wBACjC,YAAY,EAAE,QAAQ;qBACtB,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;oBACpB,OAAO;gBACR,CAAC;gBACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACnB,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC;YACD,MAAM;gBACL,MAAM,CAAC,MAAM,EAAE,CAAC;YACjB,CAAC;SACD,CAAC,CAAC;QAEH,OAAO,IAAI,QAAQ,CAAC,WAAW,EAAE;YAChC,MAAM,EAAE,cAAc;YACtB,OAAO,EAAE,eAAe;SACxB,CAAC,CAAC;IACJ,CAAC;IAGD;;;OAGG;IACK,MAAM,CAAC,iBAAiB,CAAC,OAA2B,EAAE,UAAmB;QAChF,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC;YACpB,kBAAkB,EAAE,qCAAqC;YACzD,mBAAmB;YACnB,gBAAgB,EAAE,uBAAuB;SACzC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,KAAK,CAAC,CAAC;QACpF,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC9B,QAAQ,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED,wDAAwD;IAChD,MAAM,CAAC,oBAAoB,CAAC,OAAqC;QACxE,IAAI,OAAO,YAAY,OAAO,EAAE,CAAC;YAChC,OAAO,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,mBAAmB,CAAC,IAAI,KAAK,CAAC;QAC5E,CAAC;QACD,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAC;QAC3E,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,mBAAmB,CAAC,IAAI,KAAK,CAAC;IACxD,CAAC;IAED,yDAAyD;IACjD,MAAM,CAAC,qBAAqB,CAAC,IAAsC;QAC1E,gCAAgC;QAChC,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI;YAAE,OAAO,EAAE,CAAC;QAEnD,qBAAqB;QACrB,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QAE1C,qBAAqB;QACrB,IAAI,oBAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAE1D,0BAA0B;QAC1B,IAAI,IAAI,YAAY,WAAW;YAAE,OAAO,oBAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAE7E,oDAAoD;QACpD,IAAI,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC;YAAE,OAAO,oBAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEnH,yDAAyD;QACzD,OAAO,IAAI,CAAC;IACb,CAAC;;AA7QF,8BA8QC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "openai-cache",
-	"version": "1.0.14",
+	"version": "1.0.22",
 	"main": "dist/openai_cache.js",
 	"types": "dist/openai_cache.d.ts",
 	"exports": {
@@ -25,7 +25,7 @@
 		"prepublishOnly": "npm run test && npm run build",
 		"test": "tsx --test ./test/*_test.ts",
 		"test:watch": "tsx --test --watch ./test/*_test.ts",
-		"publish:all": "npm run build && npm run version:patch && npm publish --access public",
+		"publish:all": "npm run build && npm run version:patch && git add . && git commit -m 'version bump' && npm publish --access public",
 		"version:patch": "npm version patch",
 		"version:minor": "npm version minor",
 		"version:major": "npm version major",
@@ -56,15 +56,17 @@
 	},
 	"devDependencies": {
 		"@keyv/sqlite": "^4.0.8",
-		"@types/node": "^25.1.0",
+		"@openai/agents": "^0.8.1",
+		"@types/node": "^25.5.2",
 		"keyv": "^5.6.0",
 		"openai": "^6.17.0",
 		"ts-node": "^10.9.2",
 		"tsx": "^4.21.0",
-		"typescript": "^5.9.3",
+		"typescript": "^6.0.2",
 		"zod": "^4.3.6"
 	},
 	"dependencies": {
-		"cacheable": "^2.3.3"
+		"cacheable": "^2.3.3",
+		"chalk": "^5.6.2"
 	}
-}
+}