@jcode.labs/ragmir 2.17.1 → 2.18.0

package/dist/redaction.js

@@ -1,3 +1,8 @@
+import safeRegex from "safe-regex2";
+import { MAX_REDACTION_PATTERN_CHARACTERS } from "./defaults.js";
+const MAX_REDACTION_FLAGS_CHARACTERS = 8;
+const REDACTION_FLAGS_PATTERN = /^[dgimsuvy]*$/u;
+const compiledPatterns = new WeakMap();
 const BUILT_IN_PATTERNS = [
     {
         name: "private_key",
@@ -76,12 +81,18 @@ const BUILT_IN_PATTERNS = [
         verify: "luhn",
     },
 ];
+const BUILT_IN_PATTERN_SET = new Set(BUILT_IN_PATTERNS);
 export function redactText(input, config) {
+    const { text, counts } = redactTextWithMetadata(input, config);
+    return { text, counts };
+}
+function redactTextWithMetadata(input, config) {
     if (!config.redaction.enabled) {
-        return { text: input, counts: [] };
+        return { text: input, counts: [], preservesSourceLineCoordinates: true };
     }
     let text = input;
     const counts = [];
+    let preservesSourceLineCoordinates = true;
     const patterns = [
         ...(config.redaction.builtIn ? BUILT_IN_PATTERNS : []),
         ...config.redaction.patterns,
@@ -95,13 +106,87 @@ export function redactText(input, config) {
                 return match;
             }
             count += 1;
-            return pattern.replacement ?? `[REDACTED_${pattern.name.toUpperCase()}]`;
+            const replacement = pattern.replacement ?? `[REDACTED_${pattern.name.toUpperCase()}]`;
+            if (match.includes("\n") || replacement.includes("\n")) {
+                preservesSourceLineCoordinates = false;
+            }
+            return replacement;
         });
         if (count > 0) {
             counts.push({ name: pattern.name, count });
         }
     }
-    return { text, counts };
+    return { text, counts, preservesSourceLineCoordinates };
+}
+export function redactDocument(document, config) {
+    const sourceRegions = document.regions ?? pageRegions(document);
+    if (sourceRegions.length === 0) {
+        const redacted = redactTextWithMetadata(document.text, config);
+        return {
+            document: {
+                ...document,
+                text: redacted.text,
+                sourceLineCoordinates: document.sourceLineCoordinates === true && redacted.preservesSourceLineCoordinates,
+            },
+            counts: redacted.counts,
+        };
+    }
+    let text = "";
+    let cursor = 0;
+    const regions = [];
+    const counts = new Map();
+    let preservesSourceLineCoordinates = true;
+    const appendRedacted = (value) => {
+        const redacted = redactTextWithMetadata(value, config);
+        text += redacted.text;
+        preservesSourceLineCoordinates &&= redacted.preservesSourceLineCoordinates;
+        for (const count of redacted.counts) {
+            counts.set(count.name, (counts.get(count.name) ?? 0) + count.count);
+        }
+    };
+    for (const region of [...sourceRegions].sort((left, right) => left.charStart - right.charStart)) {
+        if (region.charStart < cursor || region.charEnd < region.charStart) {
+            throw new Error("Parsed source regions must be ordered and non-overlapping.");
+        }
+        appendRedacted(document.text.slice(cursor, region.charStart));
+        const charStart = text.length;
+        appendRedacted(document.text.slice(region.charStart, region.charEnd));
+        regions.push({ ...region, charStart, charEnd: text.length });
+        cursor = region.charEnd;
+    }
+    appendRedacted(document.text.slice(cursor));
+    const redactionCounts = [...counts.entries()]
+        .sort(([left], [right]) => left.localeCompare(right))
+        .map(([name, count]) => ({ name, count }));
+    const pages = document.pages
+        ? regions.flatMap((region) => region.location.kind === "page"
+            ? [
+                {
+                    pageNumber: region.location.start,
+                    charStart: region.charStart,
+                    charEnd: region.charEnd,
+                },
+            ]
+            : [])
+        : undefined;
+    return {
+        document: {
+            ...document,
+            text,
+            regions,
+            ...(pages ? { pages } : {}),
+            sourceLineCoordinates: document.sourceLineCoordinates === true && preservesSourceLineCoordinates,
+        },
+        counts: redactionCounts,
+    };
+}
+function pageRegions(document) {
+    return (document.pages ?? []).map((page) => ({
+        charStart: page.charStart,
+        charEnd: page.charEnd,
+        contextPath: `Page ${page.pageNumber}`,
+        location: { kind: "page", start: page.pageNumber, end: page.pageNumber },
+    }));
 }
 /**
  * Luhn checksum used by credit card numbers. Applied as a match-then-verify on
@@ -133,7 +218,36 @@ export function totalRedactions(counts) {
     return counts.reduce((total, entry) => total + entry.count, 0);
 }
 function compilePattern(pattern) {
+    const cached = compiledPatterns.get(pattern);
+    if (cached) {
+        return cached;
+    }
+    const safetyError = BUILT_IN_PATTERN_SET.has(pattern)
+        ? null
+        : redactionPatternSafetyError(pattern.pattern, pattern.flags);
+    if (safetyError) {
+        throw new Error(`Redaction pattern "${pattern.name}" is invalid: ${safetyError}`);
+    }
     const flags = pattern.flags?.includes("g") ? pattern.flags : `${pattern.flags ?? ""}g`;
-    return new RegExp(pattern.pattern, flags);
+    const compiled = new RegExp(pattern.pattern, flags);
+    compiledPatterns.set(pattern, compiled);
+    return compiled;
+}
+export function redactionPatternSafetyError(pattern, flags) {
+    if (pattern.length > MAX_REDACTION_PATTERN_CHARACTERS) {
+        return `pattern must contain at most ${MAX_REDACTION_PATTERN_CHARACTERS} characters`;
+    }
+    if (flags !== undefined &&
+        (flags.length > MAX_REDACTION_FLAGS_CHARACTERS || !REDACTION_FLAGS_PATTERN.test(flags))) {
+        return "flags must be unique JavaScript regular-expression flags";
+    }
+    try {
+        const normalizedFlags = flags?.includes("g") ? flags : `${flags ?? ""}g`;
+        new RegExp(pattern, normalizedFlags);
+    }
+    catch {
+        return "pattern or flags cannot be compiled";
+    }
+    return safeRegex(pattern) ? null : "pattern may cause catastrophic backtracking";
 }
 //# sourceMappingURL=redaction.js.map

package/dist/redaction.js.map

@@ -1 +1 @@
-{"version":3,"file":"redaction.js","sourceRoot":"","sources":["../src/redaction.ts"],"names":[],"mappings":"AAEA,MAAM,iBAAiB,GAAuB;IAC5C;QACE,IAAI,EAAE,aAAa;QACnB,OAAO,EAAE,8EAA8E;QACvF,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,2DAA2D;QACpE,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,mBAAmB;QACzB,OAAO,EAAE,gDAAgD;QACzD,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,cAAc;QACpB,OAAO,EAAE,gCAAgC;QACzC,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,cAAc;QACpB,OAAO,EAAE,+CAA+C;QACxD,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,WAAW;QACjB,OAAO,EACL,+HAA+H;QACjI,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,OAAO,EAAE,uCAAuC;QAChD,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,mBAAmB;QACzB,OAAO,EAAE,iCAAiC;QAC1C,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,OAAO,EAAE,6BAA6B;QACtC,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,aAAa;QACnB,OAAO,EAAE,oCAAoC;QAC7C,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,kBAAkB;QACxB,OAAO,EAAE,kDAAkD;QAC3D,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,OAAO,EAAE,6CAA6C;QACtD,KAAK,EAAE,IAAI;KACZ;IACD;QACE,IAAI,EAAE,OAAO;QACb,OAAO,EAAE,8CAA8C;QACvD,KAAK,EAAE,IAAI;KACZ;IACD;QACE,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,qCAAqC;QAC9C,KAAK,EAAE,IAAI;KACZ;IACD;QACE,IAAI,EAAE,aAAa;QACnB,OAAO,EAAE,4BAA4B;QACrC,KAAK,EAAE,GAAG;QACV,MAAM,EAAE,MAAM;KACf;CACF,CAAA;AAED,MAAM,UAAU,UAAU,CACxB,KAAa,EACb,MAAc;IAEd,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QAC9B,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,CAAA;IACpC,CAAC;IAED,IAAI,IAAI,GAAG,KAAK,CAAA;IAChB,MAAM,MAAM,GAAqB,EAAE,CAAA;IACnC,MAAM,QAAQ,GAAG;QACf,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;QACtD,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ;KAC7B,CAAA;IAED,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,MAAM,GAAG,cAAc,CAAC,OAAO,CAAC,CAAA;QACtC,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAA;QACpE,IAAI,KAAK,GAAG,CAAC,CAAA;QACb,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;YACpC,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACjC,OAAO,KAAK,CAAA;YACd,CAAC;YACD,KAAK,IAAI,CAAC,CAAA;YACV,OAAO,OAAO,CAAC,WAAW,IAAI,aAAa,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAA;QAC1E,CAAC,CAAC,CAAA;QACF,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACd,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;QAC5C,CAAC;IACH,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAA;AACzB,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,SAAiB;IACpC,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;IAC5C,IAAI,MAAM,CAAC,MAAM,GAAG,EAAE,IAAI,MAAM,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QAC7C,OAAO,KAAK,CAAA;IACd,CAAC;IACD,IAAI,GAAG,GAAG,CAAC,CAAA;IACX,IAAI,YAAY,GAAG,KAAK,CAAA;IACxB,KAAK,IAAI,KAAK,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAC3D,IAAI,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAA;QACpD,IAAI,YAAY,EAAE,CAAC;YACjB,KAAK,IAAI,CAAC,CAAA;YACV,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACd,KAAK,IAAI,CAAC,CAAA;YACZ,CAAC;QACH,CAAC;QACD,GAAG,IAAI,KAAK,CAAA;QACZ,YAAY,GAAG,CAAC,YAAY,CAAA;IAC9B,CAAC;IACD,OAAO,GAAG,GAAG,EAAE,KAAK,CAAC,CAAA;AACvB,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,MAAwB;IACtD,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;AAChE,CAAC;AAED,SAAS,cAAc,CAAC,OAAyB;IAC/C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,IAAI,EAAE,GAAG,CAAA;IACtF,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;AAC3C,CAAC"}
+{"version":3,"file":"redaction.js","sourceRoot":"","sources":["../src/redaction.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,aAAa,CAAA;AACnC,OAAO,EAAE,gCAAgC,EAAE,MAAM,eAAe,CAAA;AAShE,MAAM,8BAA8B,GAAG,CAAC,CAAA;AACxC,MAAM,uBAAuB,GAAG,gBAAgB,CAAA;AAChD,MAAM,gBAAgB,GAAG,IAAI,OAAO,EAA4B,CAAA;AAEhE,MAAM,iBAAiB,GAAuB;IAC5C;QACE,IAAI,EAAE,aAAa;QACnB,OAAO,EAAE,8EAA8E;QACvF,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,2DAA2D;QACpE,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,mBAAmB;QACzB,OAAO,EAAE,gDAAgD;QACzD,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,cAAc;QACpB,OAAO,EAAE,gCAAgC;QACzC,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,cAAc;QACpB,OAAO,EAAE,+CAA+C;QACxD,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,WAAW;QACjB,OAAO,EACL,+HAA+H;QACjI,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,OAAO,EAAE,uCAAuC;QAChD,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,mBAAmB;QACzB,OAAO,EAAE,iCAAiC;QAC1C,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,OAAO,EAAE,6BAA6B;QACtC,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,aAAa;QACnB,OAAO,EAAE,oCAAoC;QAC7C,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,kBAAkB;QACxB,OAAO,EAAE,kDAAkD;QAC3D,KAAK,EAAE,GAAG;KACX;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,OAAO,EAAE,6CAA6C;QACtD,KAAK,EAAE,IAAI;KACZ;IACD;QACE,IAAI,EAAE,OAAO;QACb,OAAO,EAAE,8CAA8C;QACvD,KAAK,EAAE,IAAI;KACZ;IACD;QACE,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,qCAAqC;QAC9C,KAAK,EAAE,IAAI;KACZ;IACD;QACE,IAAI,EAAE,aAAa;QACnB,OAAO,EAAE,4BAA4B;QACrC,KAAK,EAAE,GAAG;QACV,MAAM,EAAE,MAAM;KACf;CACF,CAAA;AACD,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAmB,iBAAiB,CAAC,CAAA;AAEzE,MAAM,UAAU,UAAU,CACxB,KAAa,EACb,MAAc;IAEd,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,sBAAsB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;IAC9D,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAA;AACzB,CAAC;AAQD,SAAS,sBAAsB,CAAC,KAAa,EAAE,MAAc;IAC3D,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QAC9B,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,8BAA8B,EAAE,IAAI,EAAE,CAAA;IAC1E,CAAC;IAED,IAAI,IAAI,GAAG,KAAK,CAAA;IAChB,MAAM,MAAM,GAAqB,EAAE,CAAA;IACnC,IAAI,8BAA8B,GAAG,IAAI,CAAA;IACzC,MAAM,QAAQ,GAAG;QACf,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;QACtD,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ;KAC7B,CAAA;IAED,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,MAAM,GAAG,cAAc,CAAC,OAAO,CAAC,CAAA;QACtC,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAA;QACpE,IAAI,KAAK,GAAG,CAAC,CAAA;QACb,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;YACpC,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACjC,OAAO,KAAK,CAAA;YACd,CAAC;YACD,KAAK,IAAI,CAAC,CAAA;YACV,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,aAAa,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAA;YACrF,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvD,8BAA8B,GAAG,KAAK,CAAA;YACxC,CAAC;YACD,OAAO,WAAW,CAAA;QACpB,CAAC,CAAC,CAAA;QACF,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACd,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;QAC5C,CAAC;IACH,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,8BAA8B,EAAE,CAAA;AACzD,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,QAAwB,EACxB,MAAc;IAEd,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAA;IAC/D,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,sBAAsB,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAC9D,OAAO;YACL,QAAQ,EAAE;gBACR,GAAG,QAAQ;gBACX,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,qBAAqB,EACnB,QAAQ,CAAC,qBAAqB,KAAK,IAAI,IAAI,QAAQ,CAAC,8BAA8B;aACrF;YACD,MAAM,EAAE,QAAQ,CAAC,MAAM;SACxB,CAAA;IACH,CAAC;IAED,IAAI,IAAI,GAAG,EAAE,CAAA;IACb,IAAI,MAAM,GAAG,CAAC,CAAA;IACd,MAAM,OAAO,GAAmB,EAAE,CAAA;IAClC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAA;IACxC,IAAI,8BAA8B,GAAG,IAAI,CAAA;IACzC,MAAM,cAAc,GAAG,CAAC,KAAa,EAAQ,EAAE;QAC7C,MAAM,QAAQ,GAAG,sBAAsB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QACtD,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAA;QACrB,8BAA8B,KAAK,QAAQ,CAAC,8BAA8B,CAAA;QAC1E,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACpC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAA;QACrE,CAAC;IACH,CAAC,CAAA;IAED,KAAK,MAAM,MAAM,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QAChG,IAAI,MAAM,CAAC,SAAS,GAAG,MAAM,IAAI,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YACnE,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAA;QAC/E,CAAC;QACD,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAA;QAC7D,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAA;QAC7B,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAA;QACrE,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAA;QAC5D,MAAM,GAAG,MAAM,CAAC,OAAO,CAAA;IACzB,CAAC;IACD,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;IAE3C,MAAM,eAAe,GAAG,CAAC,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;SAC1C,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SACpD,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;IAC5C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK;QAC1B,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CACzB,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,MAAM;YAC7B,CAAC,CAAC;gBACE;oBACE,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK;oBACjC,SAAS,EAAE,MAAM,CAAC,SAAS;oBAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;iBACxB;aACF;YACH,CAAC,CAAC,EAAE,CACP;QACH,CAAC,CAAC,SAAS,CAAA;IACb,OAAO;QACL,QAAQ,EAAE;YACR,GAAG,QAAQ;YACX,IAAI;YACJ,OAAO;YACP,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3B,qBAAqB,EACnB,QAAQ,CAAC,qBAAqB,KAAK,IAAI,IAAI,8BAA8B;SAC5E;QACD,MAAM,EAAE,eAAe;KACxB,CAAA;AACH,CAAC;AAED,SAAS,WAAW,CAAC,QAAwB;IAC3C,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC3C,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,WAAW,EAAE,QAAQ,IAAI,CAAC,UAAU,EAAE;QACtC,QAAQ,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE;KACzE,CAAC,CAAC,CAAA;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,SAAiB;IACpC,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;IAC5C,IAAI,MAAM,CAAC,MAAM,GAAG,EAAE,IAAI,MAAM,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QAC7C,OAAO,KAAK,CAAA;IACd,CAAC;IACD,IAAI,GAAG,GAAG,CAAC,CAAA;IACX,IAAI,YAAY,GAAG,KAAK,CAAA;IACxB,KAAK,IAAI,KAAK,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAC3D,IAAI,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAA;QACpD,IAAI,YAAY,EAAE,CAAC;YACjB,KAAK,IAAI,CAAC,CAAA;YACV,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACd,KAAK,IAAI,CAAC,CAAA;YACZ,CAAC;QACH,CAAC;QACD,GAAG,IAAI,KAAK,CAAA;QACZ,YAAY,GAAG,CAAC,YAAY,CAAA;IAC9B,CAAC;IACD,OAAO,GAAG,GAAG,EAAE,KAAK,CAAC,CAAA;AACvB,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,MAAwB;IACtD,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;AAChE,CAAC;AAED,SAAS,cAAc,CAAC,OAAyB;IAC/C,MAAM,MAAM,GAAG,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IAC5C,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,MAAM,CAAA;IACf,CAAC;IACD,MAAM,WAAW,GAAG,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC;QACnD,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,2BAA2B,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;IAC/D,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,sBAAsB,OAAO,CAAC,IAAI,iBAAiB,WAAW,EAAE,CAAC,CAAA;IACnF,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,IAAI,EAAE,GAAG,CAAA;IACtF,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;IACnD,gBAAgB,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IACvC,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,OAAe,EAAE,KAAc;IACzE,IAAI,OAAO,CAAC,MAAM,GAAG,gCAAgC,EAAE,CAAC;QACtD,OAAO,gCAAgC,gCAAgC,aAAa,CAAA;IACtF,CAAC;IACD,IACE,KAAK,KAAK,SAAS;QACnB,CAAC,KAAK,CAAC,MAAM,GAAG,8BAA8B,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EACvF,CAAC;QACD,OAAO,0DAA0D,CAAA;IACnE,CAAC;IACD,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,EAAE,GAAG,CAAA;QACxE,IAAI,MAAM,CAAC,OAAO,EAAE,eAAe,CAAC,CAAA;IACtC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,qCAAqC,CAAA;IAC9C,CAAC;IACD,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,6CAA6C,CAAA;AAClF,CAAC"}

package/dist/research.d.ts

@@ -1,11 +1,16 @@
 import type { Connection } from "@lancedb/lancedb";
+import { type IndexReadSnapshot } from "./store.js";
 import type { CompactSearchResult, Config, ResearchEvidence, ResearchOptions, ResearchReport, SearchResult } from "./types.js";
 export declare function research(query: string, options?: ResearchOptions): Promise<ResearchReport>;
-export declare function researchWithConfig(query: string, options: ResearchOptions, config: Config, connection?: Connection): Promise<ResearchReport>;
+export declare function researchWithConfig(query: string, options: ResearchOptions, config: Config, connection?: Connection, suppliedSnapshot?: IndexReadSnapshot): Promise<ResearchReport>;
 export declare function compactSearchResults(results: SearchResult[], maxLength?: number): CompactSearchResult[];
 export declare function compactResearchReport(report: ResearchReport): Omit<ResearchReport, "evidence"> & {
     evidence: Array<Omit<ResearchEvidence, "text"> & {
         snippet: string;
     }>;
 };
+export declare function rankResearchEvidence(searchResults: Array<{
+    query: string;
+    results: SearchResult[];
+}>, primaryQuery: string): ResearchEvidence[];
 //# sourceMappingURL=research.d.ts.map

package/dist/research.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"research.d.ts","sourceRoot":"","sources":["../src/research.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAWlD,OAAO,KAAK,EAEV,mBAAmB,EACnB,MAAM,EACN,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,YAAY,EACb,MAAM,YAAY,CAAA;AAwDnB,wBAAsB,QAAQ,CAC5B,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,cAAc,CAAC,CAGzB;AAED,wBAAsB,kBAAkB,CACtC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,eAAe,EACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,GACtB,OAAO,CAAC,cAAc,CAAC,CA+FzB;AAED,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,YAAY,EAAE,EACvB,SAAS,SAAyB,GACjC,mBAAmB,EAAE,CAevB;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC,cAAc,EAAE,UAAU,CAAC,GAAG;IAChG,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,GAAG;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;CACtE,CAkBA"}
+{"version":3,"file":"research.d.ts","sourceRoot":"","sources":["../src/research.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAWlD,OAAO,EAA0B,KAAK,iBAAiB,EAAyB,MAAM,YAAY,CAAA;AAElG,OAAO,KAAK,EAEV,mBAAmB,EACnB,MAAM,EAEN,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,YAAY,EAEb,MAAM,YAAY,CAAA;AA2FnB,wBAAsB,QAAQ,CAC5B,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,cAAc,CAAC,CAGzB;AAED,wBAAsB,kBAAkB,CACtC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,eAAe,EACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,EACvB,gBAAgB,CAAC,EAAE,iBAAiB,GACnC,OAAO,CAAC,cAAc,CAAC,CAsGzB;AAED,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,YAAY,EAAE,EACvB,SAAS,SAAyB,GACjC,mBAAmB,EAAE,CAevB;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC,cAAc,EAAE,UAAU,CAAC,GAAG;IAChG,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,GAAG;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;CACtE,CAoBA;AAaD,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,KAAK,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,YAAY,EAAE,CAAA;CAAE,CAAC,EAChE,YAAY,EAAE,MAAM,GACnB,gBAAgB,EAAE,CAuEpB"}