@lingxia/test 0.18.0 → 0.20.0

package/dist/pending.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Asynchronous work that spec code started in the test context, so a spec
+ * that times out without settling can name what it left behind.
+ *
+ * While a run is active the runtime wraps the test context's `setTimeout`,
+ * `setInterval` and `fetch`, and `rawAutomation()` hands out a driver that
+ * does the same for its calls; each call made while a spec owns the context is
+ * recorded under that spec until it fires, is cleared, or settles. The
+ * runner's own timers go through `runnerSetTimeout` / `runnerClearTimeout`,
+ * which are never recorded.
+ */
+export type PendingKind = "timer" | "interval" | "fetch" | "eval" | "action";
+export interface PendingWork {
+    kind: PendingKind;
+    /** What it is: `setTimeout 60000ms`, `GET https://…`, `t.app.logic.eval`. */
+    detail: string;
+    /** The spec that started it (its full name). */
+    owner: string;
+    /** Milliseconds since the owning spec started, when it was started. */
+    at_ms?: number;
+}
+/**
+ * Raw driver authority handed to spec code, one grant per spec. Every proxy
+ * `rawAutomation()` hands out keeps the grant it was made under: a spec the
+ * run abandons has its grant revoked, so a handle it still holds refuses its
+ * next call while the next spec's own handles keep working. Setup code that
+ * runs before the first spec has a grant of its own; between specs there is
+ * none, so a continuation of an ended spec cannot take a fresh handle then.
+ * Revoking the run (`revokeRawAuthority`) refuses every grant.
+ */
+export interface Grant {
+    revoked?: string;
+    /** Host tiers read under this grant: native objects it cannot fence. */
+    readonly unfenced: Set<string>;
+}
+/** Stop spec code driving the app through `rawAutomation()` for the rest of the run. */
+export declare function revokeRawAuthority(reason: string): void;
+/** A new run: `rawAutomation()` works again (earlier proxies stay dead). */
+export declare function restoreRawAuthority(): void;
+/** Why spec code may no longer drive the app, or `undefined`. */
+export declare function rawAuthorityRevoked(): string | undefined;
+/** The grant of the spec whose code runs now. */
+export declare function currentSpecGrant(): Grant | undefined;
+/** The spec holding `grant` was abandoned: its handles refuse from now on. */
+export declare function revokeGrant(grant: Grant | undefined, reason: string): void;
+/** A runner timer: never recorded as spec work, never cancelled with it. */
+export declare function runnerSetTimeout(callback: () => void, ms: number): unknown;
+export declare function runnerClearTimeout(handle: unknown): void;
+/** Start recording spec work in the test context. Idempotent. */
+export declare function installPendingTracker(): void;
+/**
+ * `root` with every promise-returning call recorded as pending work of the
+ * spec that made it (`eval` calls as `eval`), so a raw driver call a
+ * timed-out spec still awaits can be named. Getters and methods run against
+ * the original object, so native receivers keep working.
+ */
+export declare function trackDriver<T extends object>(root: T, path: string, grant?: Grant): T;
+/**
+ * The automation root with its lxapp drivers tracked (`trackDriver`). The
+ * host tiers (`lxapps`, `browser`, `shell`, `device`, `desktop`,
+ * `terminal`) are handed out as the native objects: the Rong host objects
+ * behind them lose their methods when read through a proxy.
+ */
+export declare function trackAutomationRoot<T extends object>(root: T): T;
+/** Put the test context's own timers and `fetch` back. */
+export declare function uninstallPendingTracker(): void;
+/** The spec whose code runs from now on, or `undefined` between specs. */
+export declare function setPendingOwner(name: string | undefined): Grant | undefined;
+/** Timers, fetches and raw driver calls `name` started that have not fired, been cleared or settled. */
+export declare function pendingOf(name: string): PendingWork[];
+/**
+ * Wait up to `ms` for the fetches and raw driver calls `name` left in flight
+ * to settle, including ones their continuations start meanwhile. Resolves
+ * what is still in flight (empty when all settled).
+ */
+export declare function settleCallsOf(name: string, ms: number): Promise<PendingWork[]>;
+/**
+ * Clear the timers and intervals `name` left: a timed-out spec is abandoned,
+ * and its polls must not fire into the specs after it. Returns how many.
+ */
+export declare function cancelTimersOf(name: string): number;
+/** `timer setTimeout 60000ms (at 12ms), fetch GET https://…` */
+export declare function describePending(work: readonly PendingWork[]): string;
+//# sourceMappingURL=pending.d.ts.map

package/dist/pending.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pending.d.ts","sourceRoot":"","sources":["../src/pending.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE7E,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,WAAW,CAAC;IAClB,6EAA6E;IAC7E,MAAM,EAAE,MAAM,CAAC;IACf,gDAAgD;IAChD,KAAK,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAkCD;;;;;;;;GAQG;AACH,MAAM,WAAW,KAAK;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wEAAwE;IACxE,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CAChC;AAOD,wFAAwF;AACxF,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAEvD;AAED,4EAA4E;AAC5E,wBAAgB,mBAAmB,IAAI,IAAI,CAM1C;AAED,iEAAiE;AACjE,wBAAgB,mBAAmB,IAAI,MAAM,GAAG,SAAS,CAExD;AAED,iDAAiD;AACjD,wBAAgB,gBAAgB,IAAI,KAAK,GAAG,SAAS,CAEpD;AAED,8EAA8E;AAC9E,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAE1E;AAkBD,4EAA4E;AAC5E,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,IAAI,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAE1E;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAExD;AAcD,iEAAiE;AACjE,wBAAgB,qBAAqB,IAAI,IAAI,CA0C5C;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,GAAE,KAA+B,GAAG,CAAC,CAwB9G;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,CA0ChE;AAWD,0DAA0D;AAC1D,wBAAgB,uBAAuB,IAAI,IAAI,CAY9C;AAED,0EAA0E;AAC1E,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,CAS3E;AAED,wGAAwG;AACxG,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,EAAE,CAErD;AAED;;;;GAIG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAepF;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAUnD;AAED,gEAAgE;AAChE,wBAAgB,eAAe,CAAC,IAAI,EAAE,SAAS,WAAW,EAAE,GAAG,MAAM,CAOpE"}

package/dist/pending.js

@@ -0,0 +1,311 @@
+/**
+ * Asynchronous work that spec code started in the test context, so a spec
+ * that times out without settling can name what it left behind.
+ *
+ * While a run is active the runtime wraps the test context's `setTimeout`,
+ * `setInterval` and `fetch`, and `rawAutomation()` hands out a driver that
+ * does the same for its calls; each call made while a spec owns the context is
+ * recorded under that spec until it fires, is cleared, or settles. The
+ * runner's own timers go through `runnerSetTimeout` / `runnerClearTimeout`,
+ * which are never recorded.
+ */
+const scope = globalThis;
+function captureNatives() {
+    return {
+        setTimeout: scope.setTimeout,
+        clearTimeout: scope.clearTimeout,
+        setInterval: scope.setInterval,
+        clearInterval: scope.clearInterval,
+        fetch: typeof scope.fetch === "function" ? scope.fetch : undefined,
+    };
+}
+let natives = captureNatives();
+let installed;
+let owner;
+const timers = new Map();
+/** Fetches and raw driver calls in flight, with what settles them. */
+const fetches = new Map();
+const rawCalls = new Map();
+let setupGrant = { unfenced: new Set() };
+let currentGrant = setupGrant;
+let specsStarted = false;
+let revokedReason;
+/** Stop spec code driving the app through `rawAutomation()` for the rest of the run. */
+export function revokeRawAuthority(reason) {
+    revokedReason = reason;
+}
+/** A new run: `rawAutomation()` works again (earlier proxies stay dead). */
+export function restoreRawAuthority() {
+    revokedReason = undefined;
+    if (setupGrant.revoked === undefined)
+        setupGrant.revoked = "it belongs to an earlier run";
+    setupGrant = { unfenced: new Set() };
+    currentGrant = setupGrant;
+    specsStarted = false;
+}
+/** Why spec code may no longer drive the app, or `undefined`. */
+export function rawAuthorityRevoked() {
+    return revokedReason;
+}
+/** The grant of the spec whose code runs now. */
+export function currentSpecGrant() {
+    return currentGrant;
+}
+/** The spec holding `grant` was abandoned: its handles refuse from now on. */
+export function revokeGrant(grant, reason) {
+    if (grant && grant.revoked === undefined)
+        grant.revoked = reason;
+}
+function refused(reason) {
+    return Object.assign(new Error(`The run revoked spec code's automation authority: ${reason}`), {
+        code: "E_AUTOMATION_PRIVILEGE",
+    });
+}
+function checkGrant(grant) {
+    if (revokedReason !== undefined)
+        throw refused(revokedReason);
+    if (grant.revoked !== undefined)
+        throw refused(`this driver belongs to an abandoned spec: ${grant.revoked}`);
+    // A handle setup code took is shared by every spec, so no spec's grant
+    // fences it: the spec using it is one the run cannot fence.
+    if (grant !== currentGrant && currentGrant !== undefined && currentGrant !== setupGrant) {
+        currentGrant.unfenced.add("a rawAutomation() driver taken outside the spec");
+    }
+}
+/** A runner timer: never recorded as spec work, never cancelled with it. */
+export function runnerSetTimeout(callback, ms) {
+    return (installed ?? natives).setTimeout.call(globalThis, callback, ms);
+}
+export function runnerClearTimeout(handle) {
+    (installed ?? natives).clearTimeout.call(globalThis, handle);
+}
+function entry(kind, detail) {
+    if (!owner)
+        return undefined;
+    return { kind, detail, owner: owner.name, at_ms: Date.now() - owner.started };
+}
+function describeRequest(input, init) {
+    const request = input;
+    const url = typeof input === "string" ? input : typeof request?.url === "string" ? request.url : String(input);
+    const method = init?.method ?? (typeof request?.method === "string" ? request.method : "GET");
+    return `${String(method).toUpperCase()} ${url.length > 120 ? `${url.slice(0, 117)}...` : url}`;
+}
+/** Start recording spec work in the test context. Idempotent. */
+export function installPendingTracker() {
+    if (installed)
+        return;
+    natives = captureNatives();
+    const base = natives;
+    installed = base;
+    const trackedTimeout = function (callback, ms, ...args) {
+        const work = typeof callback === "function" ? entry("timer", `setTimeout ${Number(ms ?? 0)}ms`) : undefined;
+        if (!work)
+            return base.setTimeout.call(globalThis, callback, ms, ...args);
+        let handle;
+        handle = base.setTimeout.call(globalThis, (...fired) => {
+            timers.delete(handle);
+            return callback(...fired);
+        }, ms, ...args);
+        timers.set(handle, work);
+        return handle;
+    };
+    const trackedInterval = function (callback, ms, ...args) {
+        const handle = base.setInterval.call(globalThis, callback, ms, ...args);
+        const work = typeof callback === "function" ? entry("interval", `setInterval ${Number(ms ?? 0)}ms`) : undefined;
+        if (work)
+            timers.set(handle, work);
+        return handle;
+    };
+    const clear = (native) => function (handle) {
+        timers.delete(handle);
+        native.call(globalThis, handle);
+    };
+    scope.setTimeout = trackedTimeout;
+    scope.setInterval = trackedInterval;
+    scope.clearTimeout = clear(base.clearTimeout);
+    scope.clearInterval = clear(base.clearInterval);
+    if (base.fetch) {
+        const nativeFetch = base.fetch;
+        scope.fetch = function (input, init) {
+            const call = nativeFetch.call(globalThis, input, init);
+            const work = entry("fetch", describeRequest(input, init));
+            if (work) {
+                const done = () => { fetches.delete(work); };
+                fetches.set(work, Promise.resolve(call).then(done, done));
+            }
+            return call;
+        };
+    }
+}
+/**
+ * `root` with every promise-returning call recorded as pending work of the
+ * spec that made it (`eval` calls as `eval`), so a raw driver call a
+ * timed-out spec still awaits can be named. Getters and methods run against
+ * the original object, so native receivers keep working.
+ */
+export function trackDriver(root, path, grant = { unfenced: new Set() }) {
+    return new Proxy(root, {
+        get(target, prop) {
+            const value = Reflect.get(target, prop, target);
+            if (typeof prop !== "string")
+                return value;
+            if (typeof value === "function") {
+                return (...args) => {
+                    checkGrant(grant);
+                    const result = value.apply(target, args);
+                    const name = `${path}${prop}`;
+                    if (result && typeof result.then === "function") {
+                        const work = entry(prop === "eval" ? "eval" : "action", `${name}()`);
+                        if (work) {
+                            const done = () => { rawCalls.delete(work); };
+                            rawCalls.set(work, Promise.resolve(result).then(done, done));
+                        }
+                        return result;
+                    }
+                    return result && typeof result === "object" ? trackDriver(result, `${name}().`, grant) : result;
+                };
+            }
+            return value && typeof value === "object" ? trackDriver(value, `${path}${prop}.`, grant) : value;
+        },
+    });
+}
+/**
+ * The automation root with its lxapp drivers tracked (`trackDriver`). The
+ * host tiers (`lxapps`, `browser`, `shell`, `device`, `desktop`,
+ * `terminal`) are handed out as the native objects: the Rong host objects
+ * behind them lose their methods when read through a proxy.
+ */
+export function trackAutomationRoot(root) {
+    if (revokedReason !== undefined)
+        throw refused(revokedReason);
+    const grant = currentGrant;
+    if (!grant) {
+        throw refused("no spec is running; a spec that already ended cannot take a new driver");
+    }
+    checkGrant(grant);
+    return new Proxy(root, {
+        get(target, prop) {
+            checkGrant(grant);
+            const value = Reflect.get(target, prop, target);
+            if (isAccessor(target, prop) || (value !== null && typeof value === "object")) {
+                // A host tier (`shell`, `lxapps`, `desktop`, …) comes from a getter.
+                // It is handed out as the native object, whatever `typeof` says (a
+                // Rong host object can be callable): wrapping it hides the methods
+                // on its prototype. It cannot be fenced here once read, so the run
+                // notes it, and stops rather than continue past a spec abandoned
+                // while holding one.
+                if (value !== null && (typeof value === "object" || typeof value === "function")) {
+                    grant.unfenced.add(String(prop));
+                }
+                return value;
+            }
+            if (typeof value !== "function")
+                return value;
+            if (prop !== "lxapp") {
+                return (...args) => {
+                    checkGrant(grant);
+                    const result = value.apply(target, args);
+                    if (result && typeof result === "object" && typeof result.then !== "function") {
+                        grant.unfenced.add(`${String(prop)}()`);
+                    }
+                    return result;
+                };
+            }
+            return (...args) => {
+                checkGrant(grant);
+                const driver = value.apply(target, args);
+                const path = `rawAutomation().lxapp(${args.length > 0 ? JSON.stringify(args[0]) : ""}).`;
+                return driver && typeof driver === "object" ? trackDriver(driver, path, grant) : driver;
+            };
+        },
+    });
+}
+/** Whether `prop` of `target` (or its prototype chain) is a getter. */
+function isAccessor(target, prop) {
+    for (let owner = target; owner; owner = Object.getPrototypeOf(owner)) {
+        const descriptor = Object.getOwnPropertyDescriptor(owner, prop);
+        if (descriptor)
+            return typeof descriptor.get === "function";
+    }
+    return false;
+}
+/** Put the test context's own timers and `fetch` back. */
+export function uninstallPendingTracker() {
+    if (!installed)
+        return;
+    scope.setTimeout = installed.setTimeout;
+    scope.clearTimeout = installed.clearTimeout;
+    scope.setInterval = installed.setInterval;
+    scope.clearInterval = installed.clearInterval;
+    if (installed.fetch)
+        scope.fetch = installed.fetch;
+    installed = undefined;
+    owner = undefined;
+    timers.clear();
+    fetches.clear();
+    rawCalls.clear();
+}
+/** The spec whose code runs from now on, or `undefined` between specs. */
+export function setPendingOwner(name) {
+    owner = name === undefined ? undefined : { name, started: Date.now() };
+    if (name !== undefined) {
+        specsStarted = true;
+        currentGrant = { unfenced: new Set() };
+    }
+    else {
+        currentGrant = specsStarted ? undefined : setupGrant;
+    }
+    return currentGrant;
+}
+/** Timers, fetches and raw driver calls `name` started that have not fired, been cleared or settled. */
+export function pendingOf(name) {
+    return [...rawCalls.keys(), ...fetches.keys(), ...timers.values()].filter((work) => work.owner === name);
+}
+/**
+ * Wait up to `ms` for the fetches and raw driver calls `name` left in flight
+ * to settle, including ones their continuations start meanwhile. Resolves
+ * what is still in flight (empty when all settled).
+ */
+export async function settleCallsOf(name, ms) {
+    const deadline = Date.now() + ms;
+    for (;;) {
+        const open = [...rawCalls, ...fetches].filter(([work]) => work.owner === name);
+        const left = deadline - Date.now();
+        if (open.length === 0 || left <= 0)
+            return open.map(([work]) => work);
+        let handle;
+        await Promise.race([
+            Promise.all(open.map(([, settled]) => settled)),
+            new Promise((resolve) => { handle = runnerSetTimeout(resolve, left); }),
+        ]);
+        runnerClearTimeout(handle);
+        // Continuations of what settled run before the next look.
+        await new Promise((resolve) => { runnerSetTimeout(resolve, 0); });
+    }
+}
+/**
+ * Clear the timers and intervals `name` left: a timed-out spec is abandoned,
+ * and its polls must not fire into the specs after it. Returns how many.
+ */
+export function cancelTimersOf(name) {
+    let cancelled = 0;
+    for (const [handle, work] of [...timers]) {
+        if (work.owner !== name)
+            continue;
+        timers.delete(handle);
+        const native = installed ?? natives;
+        (work.kind === "interval" ? native.clearInterval : native.clearTimeout).call(globalThis, handle);
+        cancelled += 1;
+    }
+    return cancelled;
+}
+/** `timer setTimeout 60000ms (at 12ms), fetch GET https://…` */
+export function describePending(work) {
+    if (work.length === 0) {
+        return "an awaited promise that no timer, fetch or fixture call of the spec backs (e.g. `new Promise(() => {})`, or a raw driver call)";
+    }
+    return work
+        .map((item) => `${item.kind} ${item.detail}${item.at_ms !== undefined ? ` (started ${item.at_ms}ms into the spec)` : ""}`)
+        .join(", ");
+}
+//# sourceMappingURL=pending.js.map

package/dist/pending.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pending.js","sourceRoot":"","sources":["../src/pending.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AA0BH,MAAM,KAAK,GAAG,UAAgD,CAAC;AAE/D,SAAS,cAAc;IACrB,OAAO;QACL,UAAU,EAAE,KAAK,CAAC,UAAqB;QACvC,YAAY,EAAE,KAAK,CAAC,YAAuB;QAC3C,WAAW,EAAE,KAAK,CAAC,WAAsB;QACzC,aAAa,EAAE,KAAK,CAAC,aAAwB;QAC7C,KAAK,EAAE,OAAO,KAAK,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC,CAAE,KAAK,CAAC,KAAiB,CAAC,CAAC,CAAC,SAAS;KAChF,CAAC;AACJ,CAAC;AAED,IAAI,OAAO,GAAY,cAAc,EAAE,CAAC;AACxC,IAAI,SAA8B,CAAC;AACnC,IAAI,KAAoD,CAAC;AACzD,MAAM,MAAM,GAAG,IAAI,GAAG,EAAyD,CAAC;AAChF,sEAAsE;AACtE,MAAM,OAAO,GAAG,IAAI,GAAG,EAAiC,CAAC;AACzD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAiC,CAAC;AAiB1D,IAAI,UAAU,GAAU,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;AAChD,IAAI,YAAY,GAAsB,UAAU,CAAC;AACjD,IAAI,YAAY,GAAG,KAAK,CAAC;AACzB,IAAI,aAAiC,CAAC;AAEtC,wFAAwF;AACxF,MAAM,UAAU,kBAAkB,CAAC,MAAc;IAC/C,aAAa,GAAG,MAAM,CAAC;AACzB,CAAC;AAED,4EAA4E;AAC5E,MAAM,UAAU,mBAAmB;IACjC,aAAa,GAAG,SAAS,CAAC;IAC1B,IAAI,UAAU,CAAC,OAAO,KAAK,SAAS;QAAE,UAAU,CAAC,OAAO,GAAG,8BAA8B,CAAC;IAC1F,UAAU,GAAG,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;IACrC,YAAY,GAAG,UAAU,CAAC;IAC1B,YAAY,GAAG,KAAK,CAAC;AACvB,CAAC;AAED,iEAAiE;AACjE,MAAM,UAAU,mBAAmB;IACjC,OAAO,aAAa,CAAC;AACvB,CAAC;AAED,iDAAiD;AACjD,MAAM,UAAU,gBAAgB;IAC9B,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,WAAW,CAAC,KAAwB,EAAE,MAAc;IAClE,IAAI,KAAK,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS;QAAE,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC;AACnE,CAAC;AAED,SAAS,OAAO,CAAC,MAAc;IAC7B,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,qDAAqD,MAAM,EAAE,CAAC,EAAE;QAC7F,IAAI,EAAE,wBAAwB;KAC/B,CAAC,CAAC;AACL,CAAC;AAED,SAAS,UAAU,CAAC,KAAY;IAC9B,IAAI,aAAa,KAAK,SAAS;QAAE,MAAM,OAAO,CAAC,aAAa,CAAC,CAAC;IAC9D,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS;QAAE,MAAM,OAAO,CAAC,6CAA6C,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IAC7G,uEAAuE;IACvE,4DAA4D;IAC5D,IAAI,KAAK,KAAK,YAAY,IAAI,YAAY,KAAK,SAAS,IAAI,YAAY,KAAK,UAAU,EAAE,CAAC;QACxF,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAC;IAC/E,CAAC;AACH,CAAC;AAED,4EAA4E;AAC5E,MAAM,UAAU,gBAAgB,CAAC,QAAoB,EAAE,EAAU;IAC/D,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;AAC1E,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,MAAe;IAChD,CAAC,SAAS,IAAI,OAAO,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,KAAK,CAAwB,IAAO,EAAE,MAAc;IAC3D,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;AAChF,CAAC;AAED,SAAS,eAAe,CAAC,KAAc,EAAE,IAA0B;IACjE,MAAM,OAAO,GAAG,KAAwD,CAAC;IACzE,MAAM,GAAG,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,OAAO,EAAE,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC/G,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,CAAC,OAAO,OAAO,EAAE,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAC9F,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,IAAI,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;AACjG,CAAC;AAED,iEAAiE;AACjE,MAAM,UAAU,qBAAqB;IACnC,IAAI,SAAS;QAAE,OAAO;IACtB,OAAO,GAAG,cAAc,EAAE,CAAC;IAC3B,MAAM,IAAI,GAAG,OAAO,CAAC;IACrB,SAAS,GAAG,IAAI,CAAC;IACjB,MAAM,cAAc,GAAY,UAAU,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI;QAC7D,MAAM,IAAI,GAAG,OAAO,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,cAAc,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5G,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;QAC1E,IAAI,MAAe,CAAC;QACpB,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,GAAG,KAAgB,EAAE,EAAE;YAChE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACtB,OAAO,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC;QAC5B,CAAC,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;QAChB,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACzB,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IACF,MAAM,eAAe,GAAY,UAAU,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI;QAC9D,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;QACxE,MAAM,IAAI,GAAG,OAAO,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,EAAE,eAAe,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAChH,IAAI,IAAI;YAAE,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACnC,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IACF,MAAM,KAAK,GAAG,CAAC,MAAe,EAAW,EAAE,CAAC,UAAU,MAAM;QAC1D,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACtB,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAClC,CAAC,CAAC;IACF,KAAK,CAAC,UAAU,GAAG,cAAc,CAAC;IAClC,KAAK,CAAC,WAAW,GAAG,eAAe,CAAC;IACpC,KAAK,CAAC,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC9C,KAAK,CAAC,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAChD,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC;QAC/B,KAAK,CAAC,KAAK,GAAG,UAAU,KAAc,EAAE,IAA0B;YAChE,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YACvD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;YAC1D,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,IAAI,GAAG,GAAG,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC7C,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;YAC5D,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAmB,IAAO,EAAE,IAAY,EAAE,QAAe,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAE,EAAE;IACzG,OAAO,IAAI,KAAK,CAAC,IAAI,EAAE;QACrB,GAAG,CAAC,MAAM,EAAE,IAAI;YACd,MAAM,KAAK,GAAY,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;YACzD,IAAI,OAAO,IAAI,KAAK,QAAQ;gBAAE,OAAO,KAAK,CAAC;YAC3C,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;gBAChC,OAAO,CAAC,GAAG,IAAe,EAAE,EAAE;oBAC5B,UAAU,CAAC,KAAK,CAAC,CAAC;oBAClB,MAAM,MAAM,GAAa,KAA0C,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;oBACxF,MAAM,IAAI,GAAG,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC;oBAC9B,IAAI,MAAM,IAAI,OAAQ,MAA6B,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;wBACxE,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC;wBACrE,IAAI,IAAI,EAAE,CAAC;4BACT,MAAM,IAAI,GAAG,GAAG,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;4BAC9C,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;wBAC/D,CAAC;wBACD,OAAO,MAAM,CAAC;oBAChB,CAAC;oBACD,OAAO,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,GAAG,IAAI,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;gBAClG,CAAC,CAAC;YACJ,CAAC;YACD,OAAO,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,IAAI,GAAG,IAAI,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACnG,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAmB,IAAO;IAC3D,IAAI,aAAa,KAAK,SAAS;QAAE,MAAM,OAAO,CAAC,aAAa,CAAC,CAAC;IAC9D,MAAM,KAAK,GAAG,YAAY,CAAC;IAC3B,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,OAAO,CAAC,wEAAwE,CAAC,CAAC;IAC1F,CAAC;IACD,UAAU,CAAC,KAAK,CAAC,CAAC;IAClB,OAAO,IAAI,KAAK,CAAC,IAAI,EAAE;QACrB,GAAG,CAAC,MAAM,EAAE,IAAI;YACd,UAAU,CAAC,KAAK,CAAC,CAAC;YAClB,MAAM,KAAK,GAAY,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;YACzD,IAAI,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,EAAE,CAAC;gBAC9E,qEAAqE;gBACrE,mEAAmE;gBACnE,mEAAmE;gBACnE,mEAAmE;gBACnE,iEAAiE;gBACjE,qBAAqB;gBACrB,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,UAAU,CAAC,EAAE,CAAC;oBACjF,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gBACnC,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,IAAI,OAAO,KAAK,KAAK,UAAU;gBAAE,OAAO,KAAK,CAAC;YAC9C,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;gBACrB,OAAO,CAAC,GAAG,IAAe,EAAE,EAAE;oBAC5B,UAAU,CAAC,KAAK,CAAC,CAAC;oBAClB,MAAM,MAAM,GAAa,KAA0C,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;oBACxF,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAQ,MAA6B,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;wBACtG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAC1C,CAAC;oBACD,OAAO,MAAM,CAAC;gBAChB,CAAC,CAAC;YACJ,CAAC;YACD,OAAO,CAAC,GAAG,IAAe,EAAE,EAAE;gBAC5B,UAAU,CAAC,KAAK,CAAC,CAAC;gBAClB,MAAM,MAAM,GAAa,KAA0C,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBACxF,MAAM,IAAI,GAAG,yBAAyB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;gBACzF,OAAO,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;YAC1F,CAAC,CAAC;QACJ,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED,uEAAuE;AACvE,SAAS,UAAU,CAAC,MAAc,EAAE,IAAiB;IACnD,KAAK,IAAI,KAAK,GAAkB,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAkB,EAAE,CAAC;QACrG,MAAM,UAAU,GAAG,MAAM,CAAC,wBAAwB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAChE,IAAI,UAAU;YAAE,OAAO,OAAO,UAAU,CAAC,GAAG,KAAK,UAAU,CAAC;IAC9D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,uBAAuB;IACrC,IAAI,CAAC,SAAS;QAAE,OAAO;IACvB,KAAK,CAAC,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC;IACxC,KAAK,CAAC,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC;IAC5C,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;IAC1C,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC,aAAa,CAAC;IAC9C,IAAI,SAAS,CAAC,KAAK;QAAE,KAAK,CAAC,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC;IACnD,SAAS,GAAG,SAAS,CAAC;IACtB,KAAK,GAAG,SAAS,CAAC;IAClB,MAAM,CAAC,KAAK,EAAE,CAAC;IACf,OAAO,CAAC,KAAK,EAAE,CAAC;IAChB,QAAQ,CAAC,KAAK,EAAE,CAAC;AACnB,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,eAAe,CAAC,IAAwB;IACtD,KAAK,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;IACvE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,YAAY,GAAG,IAAI,CAAC;QACpB,YAAY,GAAG,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;IACzC,CAAC;SAAM,CAAC;QACN,YAAY,GAAG,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;IACvD,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,wGAAwG;AACxG,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,OAAO,CAAC,GAAG,QAAQ,CAAC,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;AAC3G,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,IAAY,EAAE,EAAU;IAC1D,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC;IACjC,SAAS,CAAC;QACR,MAAM,IAAI,GAAG,CAAC,GAAG,QAAQ,EAAE,GAAG,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;QAC/E,MAAM,IAAI,GAAG,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACnC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC;YAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;QACtE,IAAI,MAAe,CAAC;QACpB,MAAM,OAAO,CAAC,IAAI,CAAC;YACjB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC;YAC/C,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,GAAG,MAAM,GAAG,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;SAC9E,CAAC,CAAC;QACH,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3B,0DAA0D;QAC1D,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,GAAG,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1E,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY;IACzC,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,KAAK,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC;QACzC,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI;YAAE,SAAS;QAClC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACtB,MAAM,MAAM,GAAG,SAAS,IAAI,OAAO,CAAC;QACpC,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QACjG,SAAS,IAAI,CAAC,CAAC;IACjB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,gEAAgE;AAChE,MAAM,UAAU,eAAe,CAAC,IAA4B;IAC1D,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,gIAAgI,CAAC;IAC1I,CAAC;IACD,OAAO,IAAI;SACR,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,aAAa,IAAI,CAAC,KAAK,mBAAmB,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;SACzH,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC"}

package/dist/redact.d.ts

@@ -0,0 +1,41 @@
+/**
+ * `--arg` values end up in every report, and reports get shared.
+ *
+ * Two different guarantees, on purpose:
+ * - An arg passed with `lxdev test --secret-arg` is a declared secret. Its
+ *   value is masked wherever it appears: `meta.args`, events, case records and
+ *   text attachments.
+ * - An ordinary `--arg` whose key is named like a credential (`password`,
+ *   `apiKey`, `DB_TOKEN`) only has its entry in `meta.args` shown as `***`. Its
+ *   value is not searched for elsewhere: a guess from the name must not blank
+ *   every `1000` in a report because someone passed `maxTokens=1000`.
+ *
+ * The spec always reads the real value with `t.arg()`.
+ */
+export declare const REDACTED = "***";
+/**
+ * Split a key into lower-case words at `_`, `-`, `.`, spaces and camelCase
+ * boundaries: `DB_PASSWORD` → db password, `apiKey` → api key,
+ * `APIKey` → api key, `passWithNoTests` → pass with no tests.
+ */
+export declare function keyWords(key: string): string[];
+/**
+ * Whether an arg key names a credential. Only the key's last word counts, as a
+ * whole word: `authToken` and `DB_PASSWORD` do; `tokenCount`, `maxTokens`,
+ * `bypassCache`, `passport` and `passWithNoTests` do not.
+ */
+export declare function looksSecretKey(key: string): boolean;
+export interface Redactor {
+    /** Args for `meta.args`: declared secrets and credential-named keys as `***`. */
+    args(args: Record<string, string>): Record<string, string>;
+    /** Deep copy with every declared secret value masked inside strings. */
+    deep<T>(value: T): T;
+    /** An attachment payload with declared secret values masked in its text. */
+    attachment(data: unknown): unknown;
+}
+/**
+ * @param args  the user args (`t.arg()`)
+ * @param secretKeys  keys passed with `--secret-arg`
+ */
+export declare function createRedactor(args: Record<string, string>, secretKeys?: Iterable<string>): Redactor;
+//# sourceMappingURL=redact.d.ts.map

package/dist/redact.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"redact.d.ts","sourceRoot":"","sources":["../src/redact.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAIH,eAAO,MAAM,QAAQ,QAAQ,CAAC;AAqB9B;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAO9C;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAOnD;AAED,MAAM,WAAW,QAAQ;IACvB,iFAAiF;IACjF,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3D,wEAAwE;IACxE,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC;IACrB,4EAA4E;IAC5E,UAAU,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;CACpC;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC5B,UAAU,GAAE,QAAQ,CAAC,MAAM,CAAM,GAChC,QAAQ,CA2DV"}

package/dist/redact.js

@@ -0,0 +1,168 @@
+/**
+ * `--arg` values end up in every report, and reports get shared.
+ *
+ * Two different guarantees, on purpose:
+ * - An arg passed with `lxdev test --secret-arg` is a declared secret. Its
+ *   value is masked wherever it appears: `meta.args`, events, case records and
+ *   text attachments.
+ * - An ordinary `--arg` whose key is named like a credential (`password`,
+ *   `apiKey`, `DB_TOKEN`) only has its entry in `meta.args` shown as `***`. Its
+ *   value is not searched for elsewhere: a guess from the name must not blank
+ *   every `1000` in a report because someone passed `maxTokens=1000`.
+ *
+ * The spec always reads the real value with `t.arg()`.
+ */
+import { bytesToBase64 } from "./format.js";
+export const REDACTED = "***";
+/** Shorter values are too likely to collide with ordinary report text. */
+const MIN_SCRUB_LENGTH = 4;
+/** A key whose last word is one of these names a credential. */
+const SECRET_WORDS = new Set([
+    "password",
+    "passwd",
+    "pwd",
+    "passphrase",
+    "secret",
+    "token",
+    "credential",
+    "credentials",
+    "apikey",
+]);
+/** Two-word endings that name a credential (`apiKey`, `PRIVATE_KEY`). */
+const SECRET_PAIRS = new Set(["api key", "private key"]);
+/**
+ * Split a key into lower-case words at `_`, `-`, `.`, spaces and camelCase
+ * boundaries: `DB_PASSWORD` → db password, `apiKey` → api key,
+ * `APIKey` → api key, `passWithNoTests` → pass with no tests.
+ */
+export function keyWords(key) {
+    return key
+        .replace(/([a-z0-9])([A-Z])/g, "$1 $2")
+        .replace(/([A-Z]+)([A-Z][a-z])/g, "$1 $2")
+        .split(/[^A-Za-z0-9]+/)
+        .filter((word) => word.length > 0)
+        .map((word) => word.toLowerCase());
+}
+/**
+ * Whether an arg key names a credential. Only the key's last word counts, as a
+ * whole word: `authToken` and `DB_PASSWORD` do; `tokenCount`, `maxTokens`,
+ * `bypassCache`, `passport` and `passWithNoTests` do not.
+ */
+export function looksSecretKey(key) {
+    const words = keyWords(key);
+    const last = words[words.length - 1];
+    if (last === undefined)
+        return false;
+    if (SECRET_WORDS.has(last))
+        return true;
+    const pair = words.length >= 2 ? `${words[words.length - 2]} ${last}` : "";
+    return SECRET_PAIRS.has(pair);
+}
+/**
+ * @param args  the user args (`t.arg()`)
+ * @param secretKeys  keys passed with `--secret-arg`
+ */
+export function createRedactor(args, secretKeys = []) {
+    const declared = new Set(secretKeys);
+    const values = Object.entries(args)
+        .filter(([key, value]) => declared.has(key) && value.length >= MIN_SCRUB_LENGTH)
+        .map(([, value]) => value)
+        // Longest first, so a secret containing another is masked whole.
+        .sort((a, b) => b.length - a.length);
+    const scrub = (text) => {
+        let out = text;
+        for (const value of values)
+            if (out.includes(value))
+                out = out.split(value).join(REDACTED);
+        return out;
+    };
+    const walk = (value, seen) => {
+        if (typeof value === "string")
+            return scrub(value);
+        if (!value || typeof value !== "object")
+            return value;
+        if (value instanceof Uint8Array)
+            return value;
+        if (seen.has(value))
+            return seen.get(value);
+        if (Array.isArray(value)) {
+            const out = [];
+            seen.set(value, out);
+            for (const item of value)
+                out.push(walk(item, seen));
+            return out;
+        }
+        const out = {};
+        seen.set(value, out);
+        for (const [key, item] of Object.entries(value))
+            out[key] = walk(item, seen);
+        return out;
+    };
+    return {
+        args(input) {
+            const out = {};
+            for (const [key, value] of Object.entries(input)) {
+                out[key] = declared.has(key) || looksSecretKey(key) ? REDACTED : value;
+            }
+            return out;
+        },
+        deep(value) {
+            return values.length === 0 ? value : walk(value, new WeakMap());
+        },
+        attachment(data) {
+            if (values.length === 0)
+                return data;
+            if (data && typeof data === "object" && !(data instanceof Uint8Array)) {
+                const record = data;
+                // A pre-encoded payload: only text is searched; images stay byte-exact.
+                if (typeof record.base64 === "string") {
+                    const mimeType = typeof record.mimeType === "string" ? record.mimeType : "";
+                    if (!isText(mimeType))
+                        return data;
+                    const text = decodeUtf8(record.base64);
+                    if (text === undefined)
+                        return data;
+                    const scrubbed = scrub(text);
+                    if (scrubbed === text)
+                        return data;
+                    return { ...record, base64: bytesToBase64(new TextEncoder().encode(scrubbed)) };
+                }
+            }
+            return walk(data, new WeakMap());
+        },
+    };
+}
+function isText(mimeType) {
+    return (mimeType.startsWith("text/") ||
+        mimeType.startsWith("application/json") ||
+        mimeType.startsWith("application/xml") ||
+        /\+(json|xml)\b/.test(mimeType));
+}
+const BASE64_ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+function decodeUtf8(base64) {
+    if (typeof TextDecoder === "undefined")
+        return undefined;
+    const clean = base64.replace(/[\s=]/g, "");
+    const bytes = new Uint8Array(Math.floor((clean.length * 3) / 4));
+    let buffer = 0;
+    let bits = 0;
+    let index = 0;
+    for (const char of clean) {
+        const value = BASE64_ALPHABET.indexOf(char);
+        if (value < 0)
+            return undefined;
+        buffer = (buffer << 6) | value;
+        bits += 6;
+        if (bits >= 8) {
+            bits -= 8;
+            bytes[index++] = (buffer >> bits) & 0xff;
+        }
+    }
+    try {
+        return new TextDecoder("utf-8", { fatal: true }).decode(bytes.subarray(0, index));
+    }
+    catch {
+        return undefined;
+    }
+}
+//# sourceMappingURL=redact.js.map

package/dist/redact.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redact.js","sourceRoot":"","sources":["../src/redact.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,CAAC;AAE9B,0EAA0E;AAC1E,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAE3B,gEAAgE;AAChE,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC;IAC3B,UAAU;IACV,QAAQ;IACR,KAAK;IACL,YAAY;IACZ,QAAQ;IACR,OAAO;IACP,YAAY;IACZ,aAAa;IACb,QAAQ;CACT,CAAC,CAAC;AAEH,yEAAyE;AACzE,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC;AAEzD;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAW;IAClC,OAAO,GAAG;SACP,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC;SACtC,OAAO,CAAC,uBAAuB,EAAE,OAAO,CAAC;SACzC,KAAK,CAAC,eAAe,CAAC;SACtB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;SACjC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;AACvC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,GAAW;IACxC,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACrC,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACrC,IAAI,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACxC,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3E,OAAO,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AAChC,CAAC;AAWD;;;GAGG;AACH,MAAM,UAAU,cAAc,CAC5B,IAA4B,EAC5B,aAA+B,EAAE;IAEjC,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC;IACrC,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;SAChC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,IAAI,gBAAgB,CAAC;SAC/E,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC;QAC1B,iEAAiE;SAChE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;IAEvC,MAAM,KAAK,GAAG,CAAC,IAAY,EAAU,EAAE;QACrC,IAAI,GAAG,GAAG,IAAI,CAAC;QACf,KAAK,MAAM,KAAK,IAAI,MAAM;YAAE,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAAE,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3F,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;IACF,MAAM,IAAI,GAAG,CAAC,KAAc,EAAE,IAA8B,EAAW,EAAE;QACvE,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC;QACnD,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QACtD,IAAI,KAAK,YAAY,UAAU;YAAE,OAAO,KAAK,CAAC;QAC9C,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,MAAM,GAAG,GAAc,EAAE,CAAC;YAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YACrB,KAAK,MAAM,IAAI,IAAI,KAAK;gBAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;YACrD,OAAO,GAAG,CAAC;QACb,CAAC;QACD,MAAM,GAAG,GAA4B,EAAE,CAAC;QACxC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACrB,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAgC,CAAC;YAAE,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACxG,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;IAEF,OAAO;QACL,IAAI,CAAC,KAAK;YACR,MAAM,GAAG,GAA2B,EAAE,CAAC;YACvC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACjD,GAAG,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC;YACzE,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QACD,IAAI,CAAI,KAAQ;YACd,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,CAAC,KAAK,EAAE,IAAI,OAAO,EAAE,CAAO,CAAC;QACzE,CAAC;QACD,UAAU,CAAC,IAAI;YACb,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC;YACrC,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,YAAY,UAAU,CAAC,EAAE,CAAC;gBACtE,MAAM,MAAM,GAAG,IAA+B,CAAC;gBAC/C,wEAAwE;gBACxE,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;oBACtC,MAAM,QAAQ,GAAG,OAAO,MAAM,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC5E,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;wBAAE,OAAO,IAAI,CAAC;oBACnC,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBACvC,IAAI,IAAI,KAAK,SAAS;wBAAE,OAAO,IAAI,CAAC;oBACpC,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;oBAC7B,IAAI,QAAQ,KAAK,IAAI;wBAAE,OAAO,IAAI,CAAC;oBACnC,OAAO,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;gBAClF,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAC,IAAI,EAAE,IAAI,OAAO,EAAE,CAAC,CAAC;QACnC,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,MAAM,CAAC,QAAgB;IAC9B,OAAO,CACL,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC;QAC5B,QAAQ,CAAC,UAAU,CAAC,kBAAkB,CAAC;QACvC,QAAQ,CAAC,UAAU,CAAC,iBAAiB,CAAC;QACtC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAChC,CAAC;AACJ,CAAC;AAED,MAAM,eAAe,GAAG,kEAAkE,CAAC;AAE3F,SAAS,UAAU,CAAC,MAAc;IAChC,IAAI,OAAO,WAAW,KAAK,WAAW;QAAE,OAAO,SAAS,CAAC;IACzD,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAC3C,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACjE,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,KAAK,GAAG,CAAC;YAAE,OAAO,SAAS,CAAC;QAChC,MAAM,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC;QAC/B,IAAI,IAAI,CAAC,CAAC;QACV,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;YACd,IAAI,IAAI,CAAC,CAAC;YACV,KAAK,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC;QAC3C,CAAC;IACH,CAAC;IACD,IAAI,CAAC;QACH,OAAO,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IACpF,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC"}