@tangle-network/agent-eval 0.187.2 → 0.189.0

package/dist/redact-DPoH1-OW.d.ts

@@ -0,0 +1,158 @@
+//#region src/trace/redact.d.ts
+/**
+ * The redaction core: the one place that decides what must not leave a
+ * process or a machine. Every trace writer, exporter, uploader and share path
+ * calls it.
+ *
+ * Three profiles, each a superset of the one before:
+ *   - `default` removes credentials, found by key name and by value shape, and
+ *     personal data (email addresses, card numbers, SSNs, phone numbers).
+ *     Content is kept. Strings are capped at 1 MiB.
+ *   - `share` also removes phone, IP and postal-address fields, replaces
+ *     account, user, tenant, session and request identifiers with pseudonyms
+ *     that stay consistent within one call, and caps strings at 64 KiB.
+ *   - `strict` also removes prompt, completion, message, tool payload and other
+ *     raw-content fields and embedded media, and caps strings at 4 KiB.
+ *
+ * A string that holds a credential is replaced whole with
+ * `[REDACTED:<detector>]`. Replacing only the matched span can leave part of a
+ * secret behind when a pattern's boundary is wrong. Personal data inside prose
+ * is replaced in place, so the rest of the text stays readable.
+ *
+ * `assessShareSafety` reads a value without changing it and returns SAFE,
+ * SAFE_WITH_WARNINGS, UNSAFE or UNKNOWN. UNKNOWN means the scanner could not
+ * read part of the value (a cycle, binary data, nesting past the depth limit);
+ * it is never reported as safe. `redactForShare` redacts and then assesses the
+ * redacted output, so a detector gap shows up as UNSAFE instead of a leak.
+ *
+ * Reports and findings carry paths, categories and detector ids, never the
+ * values they matched.
+ *
+ * The key classifier and the credential detector list are adapted from
+ * agent-inspect (MIT, commit 3c3cbeda). `scripts/redaction-corpus.json` holds
+ * the must-flag and must-not-flag cases, including the copied agent-inspect
+ * safety corpus with its MIT notice; `pnpm redaction:corpus` runs this module
+ * over every case.
+ */
+type RedactionProfile = 'default' | 'share' | 'strict';
+declare const REDACTION_PROFILES: readonly RedactionProfile[];
+/** What a finding is about. `media` is embedded binary content (a `data:` URI) no text detector can read. */
+type SafetyCategory = 'credential' | 'personal-data' | 'identifier' | 'raw-content' | 'media';
+/**
+ * Version of the detector set and profile rules. Stored work that depends on
+ * redaction behavior (saved optimizer inputs, per-span redaction stamps) keys
+ * on it, so bump it whenever a detector, key list, cap or marker changes.
+ */
+declare const REDACTION_VERSION = "2.0.0";
+interface RedactionFinding {
+  /** JSON Pointer (RFC 6901) to the value or key that was changed. */
+  path: string;
+  category: SafetyCategory;
+  detector: string;
+  action: 'redacted' | 'pseudonymized' | 'truncated';
+}
+interface RedactionReport {
+  version: string;
+  profile: RedactionProfile;
+  /** Values and keys replaced, pseudonymized or truncated. */
+  redactionCount: number;
+  byDetector: Record<string, number>;
+  truncatedCount: number;
+  findings: RedactionFinding[];
+}
+interface RedactOptions {
+  /** Default `default`. */
+  profile?: RedactionProfile;
+  /** Lower the profile's per-string cap. A value above the profile cap is ignored. */
+  maxStringBytes?: number;
+  /**
+   * Exact values the caller knows are secret (an API key the run was given, a
+   * password from the environment). A string or key that contains one, or its
+   * base64, base64url or URL-encoded form, is replaced whole with
+   * `[REDACTED:known-secret]`, whatever shape the value has.
+   */
+  knownSecrets?: readonly string[];
+  /** Add this call's findings to an existing report instead of a new one. */
+  report?: RedactionReport;
+}
+interface AssessOptions {
+  /** Default `default`. */
+  profile?: RedactionProfile;
+  /** As in `RedactOptions`: any surviving occurrence makes the verdict UNSAFE. */
+  knownSecrets?: readonly string[];
+}
+type ShareSafetyStatus = 'SAFE' | 'SAFE_WITH_WARNINGS' | 'UNSAFE' | 'UNKNOWN';
+interface ShareSafetyFinding {
+  category: SafetyCategory;
+  detector: string;
+  severity: 'error' | 'warning';
+  count: number;
+  /** Up to five JSON Pointers where the detector fired. */
+  paths: string[];
+}
+interface ShareSafetyVerdict {
+  status: ShareSafetyStatus;
+  profile: RedactionProfile;
+  findings: ShareSafetyFinding[];
+  /** Parts the scanner could not read, as `<path>: <reason>`. Any entry makes the status UNKNOWN. */
+  unreadable: string[];
+}
+/**
+ * Canonical snake_case form of a field name, so camelCase, kebab-case, dotted
+ * and snake_case spellings match one list: `userPassword`, `user-password` and
+ * `user.password` all become `user_password`.
+ */
+declare function normalizeKey(key: string): string;
+/**
+ * The safety category a field name puts its value in, or undefined for an
+ * ordinary field. Token counts and model limits (`inputTokens`, `max_tokens`,
+ * `token_count`) and names such as `author` are not credentials.
+ */
+declare function classifyKey(key: string): SafetyCategory | undefined;
+/** The first credential detector that matches, or undefined. */
+declare function detectCredential(text: string): string | undefined;
+/** Personal-data detector ids that match somewhere in `text`. */
+declare function detectPersonalData(text: string): string[];
+/**
+ * Return a redacted deep copy of `value` and a report of what changed. Pure:
+ * the input is not mutated. Never throws on the value's shape; cycles, binary
+ * data and nesting past 64 levels are replaced with markers.
+ */
+declare function redact<T>(value: T, options?: RedactOptions): {
+  value: T;
+  report: RedactionReport;
+};
+/**
+ * Redact one free-text string with the value detectors (no field name is
+ * known). Pass `report` to accumulate counts across calls.
+ */
+declare function redactText(text: string, options?: RedactOptions): string;
+/** An empty report to accumulate `redactText` calls into. */
+declare function emptyRedactionReport(profile?: RedactionProfile): RedactionReport;
+/**
+ * Read `value` without changing it and say whether it is safe to share under
+ * `profile`. UNKNOWN when any part could not be read; UNSAFE when any
+ * error-severity finding remains; SAFE_WITH_WARNINGS when only warnings
+ * remain (raw content, embedded media, identifiers under `share`).
+ */
+declare function assessShareSafety(value: unknown, options?: AssessOptions): ShareSafetyVerdict;
+/**
+ * One verdict over several parts (files in a directory, spans in a bundle).
+ * Callers prefix each part's paths with its source before combining.
+ */
+declare function combineVerdicts(profile: RedactionProfile, verdicts: readonly ShareSafetyVerdict[], unreadable?: readonly string[]): ShareSafetyVerdict;
+/** Whether a verdict allows sharing: SAFE or SAFE_WITH_WARNINGS. UNSAFE and UNKNOWN refuse. */
+declare function shareAllowed(verdict: ShareSafetyVerdict): boolean;
+/**
+ * Redact `value` under `profile`, then assess the redacted output. The
+ * verdict describes what would actually be shared: a detector that failed to
+ * remove something shows up as UNSAFE here.
+ */
+declare function redactForShare<T>(value: T, options?: RedactOptions): {
+  value: T;
+  report: RedactionReport;
+  verdict: ShareSafetyVerdict;
+};
+//#endregion
+export { shareAllowed as S, emptyRedactionReport as _, RedactionFinding as a, redactForShare as b, SafetyCategory as c, ShareSafetyVerdict as d, assessShareSafety as f, detectPersonalData as g, detectCredential as h, RedactOptions as i, ShareSafetyFinding as l, combineVerdicts as m, REDACTION_PROFILES as n, RedactionProfile as o, classifyKey as p, REDACTION_VERSION as r, RedactionReport as s, AssessOptions as t, ShareSafetyStatus as u, normalizeKey as v, redactText as x, redact as y };
+//# sourceMappingURL=redact-DPoH1-OW.d.ts.map

package/dist/redact-DPoH1-OW.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"redact-DPoH1-OW.d.ts","names":[],"sources":["../src/trace/redact.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAsCY;cAEC,6BAA6B;;KAG9B;;;;;;cAOC;UAEI;;EAEf;EACA,UAAU;EACV;EACA;;UAGe;EACf;EACA,SAAS;;EAET;EACA,YAAY;EACZ;EACA,UAAU;;UAGK;;EAEf,UAAU;;EAEV;;;;;;;EAOA;;EAEA,SAAS;;UAGM;;EAEf,UAAU;;EAEV;;KAGU;UAEK;EACf,UAAU;EACV;EACA;EACA;;EAEA;;UAGe;EACf,QAAQ;EACR,SAAS;EACT,UAAU;;EAEV;;;;;;;iBA6Dc,aAAa;;;;;;iBAmNb,YAAY,cAAc;;iBAyJ1B,iBAAiB;;iBAQjB,mBAAmB;;;;;;iBAsQnB,OAAO,GACrB,OAAO,GACP,UAAS;EACN,OAAO;EAAG,QAAQ;;;;;;iBAUP,WAAW,cAAc,UAAS;;iBAMlC,qBAAqB,UAAS,mBAA+B;;;;;;;iBAmH7D,kBAAkB,gBAAgB,UAAS,gBAAqB;;;;;iBAoBhE,gBACd,SAAS,kBACT,mBAAmB,sBACnB,iCACC;;iBAsCa,aAAa,SAAS;;;;;;iBAStB,eAAe,GAC7B,OAAO,GACP,UAAS;EACN,OAAO;EAAG,QAAQ;EAAiB,SAAS"}