@node-llm/testing 0.1.0

package/dist/Mocker.js

@@ -0,0 +1,247 @@
+import { providerRegistry } from "@node-llm/core";
+const EXECUTION_METHODS = ["chat", "stream", "paint", "transcribe", "moderate", "embed"];
+export class Mocker {
+    mocks = [];
+    strict = false;
+    constructor() {
+        this.setupInterceptor();
+    }
+    chat(query) {
+        return this.addMock("chat", (req) => {
+            const chatReq = req;
+            if (!query)
+                return true;
+            const lastMessage = [...chatReq.messages].reverse().find((m) => m.role === "user");
+            if (!lastMessage)
+                return false;
+            const content = this.getContentString(lastMessage.content);
+            if (typeof query === "string")
+                return content === query;
+            if (query instanceof RegExp)
+                return typeof content === "string" && query.test(content);
+            return false;
+        });
+    }
+    stream(chunks) {
+        const lastMock = this.mocks[this.mocks.length - 1];
+        if (!lastMock || (lastMock.method !== "chat" && lastMock.method !== "stream")) {
+            throw new Error("Mocker: .stream() must follow a .chat() or .addMock('stream') definition.");
+        }
+        lastMock.method = "stream";
+        lastMock.response = { chunks };
+        return this;
+    }
+    placeholder(query) {
+        return this.addMock("chat", (req) => {
+            const chatReq = req;
+            return chatReq.messages.some((m) => {
+                const content = this.getContentString(m.content);
+                if (typeof query === "string")
+                    return content === query;
+                return typeof content === "string" && query.test(content);
+            });
+        });
+    }
+    callsTool(name, args = {}) {
+        const lastMock = this.mocks[this.mocks.length - 1];
+        if (!lastMock || lastMock.method !== "chat") {
+            throw new Error("Mocker: .callsTool() must follow a .chat() definition.");
+        }
+        lastMock.response = {
+            content: null,
+            tool_calls: [
+                {
+                    id: `call_${Math.random().toString(36).slice(2, 9)}`,
+                    type: "function",
+                    function: { name, arguments: JSON.stringify(args) }
+                }
+            ],
+            finish_reason: "tool_calls"
+        };
+        return this;
+    }
+    embed(input) {
+        return this.addMock("embed", (req) => {
+            const embReq = req;
+            if (!input)
+                return true;
+            return JSON.stringify(embReq.input) === JSON.stringify(input);
+        });
+    }
+    paint(prompt) {
+        return this.addMock("paint", (req) => {
+            const paintReq = req;
+            if (!prompt)
+                return true;
+            if (typeof prompt === "string")
+                return paintReq.prompt === prompt;
+            return prompt.test(paintReq.prompt);
+        });
+    }
+    transcribe(file) {
+        return this.addMock("transcribe", (req) => {
+            const transReq = req;
+            if (!file)
+                return true;
+            if (typeof file === "string")
+                return transReq.file === file;
+            return file.test(transReq.file);
+        });
+    }
+    moderate(input) {
+        return this.addMock("moderate", (req) => {
+            const modReq = req;
+            if (!input)
+                return true;
+            const content = Array.isArray(modReq.input) ? modReq.input.join(" ") : modReq.input;
+            if (input instanceof RegExp)
+                return input.test(content);
+            return JSON.stringify(modReq.input) === JSON.stringify(input);
+        });
+    }
+    respond(response) {
+        const lastMock = this.mocks[this.mocks.length - 1];
+        if (!lastMock)
+            throw new Error("Mocker: No mock definition started.");
+        if (typeof response === "string") {
+            lastMock.response = { content: response, text: response };
+        }
+        else {
+            lastMock.response = response;
+        }
+        return this;
+    }
+    /**
+     * Returns debug information about defined mocks.
+     * Useful for troubleshooting what mocks are defined.
+     */
+    getDebugInfo() {
+        const methods = this.mocks.map((m) => m.method);
+        return {
+            totalMocks: this.mocks.length,
+            methods: [...new Set(methods)]
+        };
+    }
+    clear() {
+        this.mocks = [];
+        providerRegistry.setInterceptor(undefined);
+    }
+    addMock(method, matcher) {
+        this.mocks.push({ method, match: matcher, response: { content: "Mock response" } });
+        return this;
+    }
+    getContentString(content) {
+        if (content === null || content === undefined)
+            return null;
+        if (typeof content === "string")
+            return content;
+        if (Array.isArray(content)) {
+            return content.map((part) => (part.type === "text" ? part.text : "")).join("");
+        }
+        return String(content);
+    }
+    setupInterceptor() {
+        providerRegistry.setInterceptor((provider) => {
+            return new Proxy(provider, {
+                get: (target, prop) => {
+                    const originalValue = Reflect.get(target, prop);
+                    const methodName = prop.toString();
+                    if (methodName === "id")
+                        return target.id;
+                    if (EXECUTION_METHODS.includes(methodName)) {
+                        if (methodName === "stream") {
+                            return async function* (request) {
+                                const matchingMocks = this.mocks.filter((m) => m.method === methodName && m.match(request));
+                                const mock = matchingMocks[matchingMocks.length - 1];
+                                if (mock) {
+                                    const res = typeof mock.response === "function" ? mock.response(request) : mock.response;
+                                    if (res.error)
+                                        throw res.error;
+                                    const chunks = res.chunks || [];
+                                    for (let i = 0; i < chunks.length; i++) {
+                                        const chunk = chunks[i];
+                                        yield typeof chunk === "string"
+                                            ? { content: chunk, done: i === chunks.length - 1 }
+                                            : chunk;
+                                    }
+                                    return;
+                                }
+                                if (this.strict)
+                                    throw new Error("Mocker: Unexpected LLM call to 'stream'");
+                                const original = originalValue
+                                    ? originalValue.apply(target, [request])
+                                    : undefined;
+                                if (original)
+                                    yield* original;
+                            }.bind(this);
+                        }
+                        // Promise-based methods
+                        return (async (request) => {
+                            const matchingMocks = this.mocks.filter((m) => m.method === methodName && m.match(request));
+                            const mock = matchingMocks[matchingMocks.length - 1];
+                            if (mock) {
+                                const res = typeof mock.response === "function" ? mock.response(request) : mock.response;
+                                if (res.error)
+                                    throw res.error;
+                                switch (methodName) {
+                                    case "chat": {
+                                        return {
+                                            content: res.content !== undefined && res.content !== null
+                                                ? String(res.content)
+                                                : null,
+                                            tool_calls: res.tool_calls || [],
+                                            usage: res.usage || { input_tokens: 10, output_tokens: 10, total_tokens: 20 },
+                                            finish_reason: res.finish_reason || (res.tool_calls?.length ? "tool_calls" : "stop")
+                                        };
+                                    }
+                                    case "embed": {
+                                        const embReq = request;
+                                        return {
+                                            vectors: res.vectors || [[0.1, 0.2, 0.3]],
+                                            model: embReq.model || "mock-embed",
+                                            input_tokens: 10,
+                                            dimensions: res.vectors?.[0]?.length || 3
+                                        };
+                                    }
+                                    case "paint": {
+                                        const paintReq = request;
+                                        return {
+                                            url: res.url || "http://mock.com/image.png",
+                                            revised_prompt: res.revised_prompt || paintReq.prompt
+                                        };
+                                    }
+                                    case "transcribe": {
+                                        const transReq = request;
+                                        return {
+                                            text: res.text || "Mock transcript",
+                                            model: transReq.model || "mock-whisper"
+                                        };
+                                    }
+                                    case "moderate": {
+                                        const modReq = request;
+                                        return {
+                                            id: res.id || "mod-123",
+                                            model: modReq.model || "mock-mod",
+                                            results: res.results || [
+                                                { flagged: false, categories: {}, category_scores: {} }
+                                            ]
+                                        };
+                                    }
+                                    default:
+                                        return res;
+                                }
+                            }
+                            if (this.strict)
+                                throw new Error(`Mocker: Unexpected LLM call to '${methodName}'`);
+                            return originalValue ? originalValue.apply(target, [request]) : undefined;
+                        }).bind(this);
+                    }
+                    return originalValue;
+                }
+            });
+        });
+    }
+}
+export function mockLLM() {
+    return new Mocker();
+}

package/dist/Scrubber.d.ts

@@ -0,0 +1,18 @@
+export declare const DEFAULT_SECRET_PATTERNS: RegExp[];
+export interface ScrubberOptions {
+    customScrubber?: (data: unknown) => unknown;
+    sensitivePatterns?: RegExp[];
+    sensitiveKeys?: string[];
+}
+export declare class Scrubber {
+    private customScrubber?;
+    private sensitivePatterns;
+    private sensitiveKeys;
+    constructor(options?: ScrubberOptions);
+    /**
+     * Applies scrubbing to the data using default patterns and custom logic.
+     */
+    scrub(data: unknown): unknown;
+    private deepScrub;
+}
+//# sourceMappingURL=Scrubber.d.ts.map

package/dist/Scrubber.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Scrubber.d.ts","sourceRoot":"","sources":["../src/Scrubber.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,uBAAuB,UAInC,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,cAAc,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC;IAC5C,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED,qBAAa,QAAQ;IACnB,OAAO,CAAC,cAAc,CAAC,CAA6B;IACpD,OAAO,CAAC,iBAAiB,CAAW;IACpC,OAAO,CAAC,aAAa,CAAc;gBAEvB,OAAO,GAAE,eAAoB;IAazC;;OAEG;IACI,KAAK,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO;IAYpC,OAAO,CAAC,SAAS;CAuClB"}

package/dist/Scrubber.js

@@ -0,0 +1,68 @@
+export const DEFAULT_SECRET_PATTERNS = [
+    /sk-[a-zA-Z0-9]{20,}/g, // OpenAI/Anthropic likely patterns
+    /x-[a-zA-Z0-9]{20,}/g, // Generic API keys
+    /[a-zA-Z0-9]{32,}/g // Long hashes/keys
+];
+export class Scrubber {
+    customScrubber;
+    sensitivePatterns;
+    sensitiveKeys;
+    constructor(options = {}) {
+        this.customScrubber = options.customScrubber;
+        this.sensitivePatterns = [...DEFAULT_SECRET_PATTERNS, ...(options.sensitivePatterns || [])];
+        this.sensitiveKeys = new Set([
+            "key",
+            "api_key",
+            "token",
+            "auth",
+            "authorization",
+            ...(options.sensitiveKeys || []).map((k) => k.toLowerCase())
+        ]);
+    }
+    /**
+     * Applies scrubbing to the data using default patterns and custom logic.
+     */
+    scrub(data) {
+        // 1. Perform deep regex scrubbing and key-based scrubbing
+        let result = this.deepScrub(data);
+        // 2. Run custom hook on the scrubbed data if provided
+        if (this.customScrubber) {
+            result = this.customScrubber(result);
+        }
+        return result;
+    }
+    deepScrub(val) {
+        if (typeof val === "string") {
+            let scrubbed = val;
+            for (const pattern of this.sensitivePatterns) {
+                scrubbed = scrubbed.replace(pattern, "[REDACTED]");
+            }
+            return scrubbed;
+        }
+        if (Array.isArray(val)) {
+            return val.map((v) => this.deepScrub(v));
+        }
+        if (val !== null && typeof val === "object") {
+            const obj = val;
+            const newObj = {};
+            for (const key in obj) {
+                if (!Object.prototype.hasOwnProperty.call(obj, key))
+                    continue;
+                const lowerKey = key.toLowerCase();
+                const value = obj[key];
+                // SENSITIVE KEY LOGIC:
+                // Only redact if the key looks like a credential AND the value is a string.
+                // We don't want to redact 'total_tokens' or 'input_tokens' which are numbers.
+                const isCredentialKey = this.sensitiveKeys.has(lowerKey);
+                if (isCredentialKey && typeof value === "string") {
+                    newObj[key] = "[REDACTED]";
+                }
+                else {
+                    newObj[key] = this.deepScrub(value);
+                }
+            }
+            return newObj;
+        }
+        return val;
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./vcr.js";
+export * from "./Mocker.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from "./vcr.js";
+export * from "./Mocker.js";

package/dist/vcr.d.ts

@@ -0,0 +1,57 @@
+export type VCRMode = "record" | "replay" | "auto" | "passthrough";
+export interface VCRInteraction {
+    method: string;
+    request: any;
+    response: any;
+    chunks?: any[];
+}
+export interface VCRCassette {
+    name: string;
+    version?: "1.0";
+    metadata?: {
+        recordedAt?: string;
+        recordedFrom?: string;
+        provider?: string;
+        duration?: number;
+    };
+    interactions: VCRInteraction[];
+}
+export interface VCROptions {
+    mode?: VCRMode;
+    scrub?: (data: any) => any;
+    cassettesDir?: string;
+    scope?: string | string[];
+    sensitivePatterns?: RegExp[];
+    sensitiveKeys?: string[];
+}
+export declare class VCR {
+    private cassette;
+    private interactionIndex;
+    private mode;
+    private filePath;
+    private scrubber;
+    private recordStartTime;
+    constructor(name: string, options?: VCROptions);
+    get currentMode(): VCRMode;
+    stop(): Promise<void>;
+    private get interactionsCount();
+    execute(method: string, originalMethod: (...args: any[]) => Promise<any>, request: any): Promise<any>;
+    executeStream(method: string, originalMethod: (...args: any[]) => AsyncIterable<any>, request: any): AsyncIterable<any>;
+    private clone;
+    private slugify;
+}
+export declare function setupVCR(name: string, options?: VCROptions): VCR;
+/**
+ * One-line DX Sugar for VCR testing.
+ */
+export declare function withVCR(fn: () => Promise<void>): () => Promise<void>;
+export declare function withVCR(name: string, fn: () => Promise<void>): () => Promise<void>;
+export declare function withVCR(options: VCROptions, fn: () => Promise<void>): () => Promise<void>;
+export declare function withVCR(name: string, options: VCROptions, fn: () => Promise<void>): () => Promise<void>;
+export declare function configureVCR(options: VCROptions): void;
+export declare function resetVCRConfig(): void;
+/**
+ * Organizes cassettes by hierarchical subdirectories.
+ */
+export declare function describeVCR(name: string, fn: () => void | Promise<void>): void | Promise<void>;
+//# sourceMappingURL=vcr.d.ts.map

package/dist/vcr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vcr.d.ts","sourceRoot":"","sources":["../src/vcr.ts"],"names":[],"mappings":"AAmBA,MAAM,MAAM,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,aAAa,CAAC;AAEnE,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,GAAG,CAAC;IACd,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,QAAQ,CAAC,EAAE;QACT,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,YAAY,EAAE,cAAc,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED,qBAAa,GAAG;IACd,OAAO,CAAC,QAAQ,CAAc;IAC9B,OAAO,CAAC,gBAAgB,CAAK;IAC7B,OAAO,CAAC,IAAI,CAAU;IACtB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,eAAe,CAAa;gBAExB,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,UAAe;IA+FlD,IAAI,WAAW,YAEd;IAEK,IAAI;IAkBV,OAAO,KAAK,iBAAiB,GAE5B;IAEY,OAAO,CAClB,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,EAChD,OAAO,EAAE,GAAG,GACX,OAAO,CAAC,GAAG,CAAC;IAwBD,aAAa,CACzB,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,aAAa,CAAC,GAAG,CAAC,EACtD,OAAO,EAAE,GAAG,GACX,aAAa,CAAC,GAAG,CAAC;IAgCrB,OAAO,CAAC,KAAK;IAQb,OAAO,CAAC,OAAO;CAShB;AAID,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,UAAe,OAuB9D;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,EAAE,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;AACtE,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;AACpF,wBAAgB,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;AAC3F,wBAAgB,OAAO,CACrB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,UAAU,EACnB,EAAE,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GACtB,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;AAiDvB,wBAAgB,YAAY,CAAC,OAAO,EAAE,UAAU,QAE/C;AAED,wBAAgB,cAAc,IAAI,IAAI,CAErC;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAkB9F"}