@cygnuxlabs/tracekit 1.3.0 → 1.4.1

package/dist/verify/index.d.ts

@@ -1,7 +1,7 @@
 export { MAX_ENTRIES, MAX_ENTRY, MAX_TOTAL, Unusable, readZip } from "./zip.js";
 export { StrictJSONError, canonicalize, strictParse, strictParseBytes } from "./jcs.js";
 /** The bundle format version this verifier implements: a bundle needing a later one is UNVERIFIABLE. */
-export declare const VERSION = "1.3.0";
+export declare const VERSION = "1.4.1";
 export declare const EXIT_OK = 0, EXIT_FAIL = 1, EXIT_BAD = 2, EXIT_WARN = 3;
 export type Check = {
     check: string;
@@ -16,19 +16,35 @@ export declare class Report {
     notes: string[];
     integrity: string;
     assurance: string;
+    /** The Findings line: signed findings, an opinion of the run kept apart from its integrity (null: none). */
+    findings: string | null;
     /** Checks the bundle needs that this verifier does not implement. */
     unsupported: string[];
     check(check: string, ok: boolean, detail?: string, problems?: string[], warn?: boolean): void;
     unsupport(what: string): void;
 }
 type J = any;
-/** Verify a v2 bundle (zip bytes) against the verifier's own pinned trust config (JSON bytes). Never throws. */
-export declare function verify(bundle: Uint8Array, trust: Uint8Array): Promise<{
+/**
+ * Verify a v2 bundle (zip bytes) against the verifier's own pinned trust config (JSON bytes). Never throws. `names`: the
+ * files' paths, for the commands a bundle that needs a newer verifier is told to run. `trust` null (the browser page,
+ * when no trust config is chosen): every check that needs no pinned key, and never VERIFIED: a changed record still
+ * FAILS, and an intact bundle is UNVERIFIABLE, since anyone can sign a bundle and its checkpoint with keys of their own.
+ */
+export declare function verify(bundle: Uint8Array, trust: Uint8Array | null, names?: {
+    bundle: string;
+    trust: string;
+}): Promise<{
     report: Report;
     code: number;
 }>;
 /** §4: null when `r` is a v2 record signed by one of `keys` (SPKI DER) with an allowed algorithm that is the key's own,
  * else why not. */
 export declare function verifyRecord(r: J, keys: Uint8Array[], algs: string[]): Promise<string | null>;
-/** The report as text, as the reference CLI prints it; control characters in bundle-derived strings are dropped. */
+/** {run file: its entries in order} of a bundle's `names`: the run's file, runs/<id>.jsonl, or its parts,
+ * runs/<id>.part-0001.jsonl, ..., whose records read in that order are the run's (format-v2.md §9). */
+export declare function runFiles(names: Iterable<string>): Map<string, string[]>;
+/** `x` without control characters and the bidirectional and zero-width format characters that would reorder or hide
+ * the text around them, as the report prints bundle-derived strings. */
+export declare const clean: (x: string) => string;
+/** The report as text, as the reference CLI prints it; `clean` drops characters from bundle-derived strings. */
 export declare function formatReport(rep: Report): string;