agent-first-data 0.8.0 → 0.9.0

package/README.md

@@ -63,7 +63,7 @@ Plain: args.input_path=/data/backup.tar.gz code=log event=startup config.max_fil
 
 ## API Reference
 
-Total: **15 public APIs and 2 types** + **AFDATA logging** (3 protocol builders + 2 redacted value helpers + 4 output functions + 1 internal + 1 utility + 4 CLI helpers + `OutputFormat` + `RedactionPolicy`)
+Public APIs are grouped by role: protocol builders, redaction helpers, output formatters, internal redaction tools, utility/CLI helpers, types, and AFDATA logging integration.
 
 ### Protocol Builders (returns JsonValue)
 
@@ -82,13 +82,14 @@ buildJsonError(message: string, hint?: string, trace?: JsonValue): JsonValue
 buildJson(code: string, fields: JsonValue, trace?: JsonValue): JsonValue
 ```
 
-### Redacted Values (returns JsonValue)
+### Redaction Helpers (returns JsonValue)
 
 Use these before raw HTTP/MCP/SSE serializers that do not call `outputJson`.
 
 ```typescript
 redactedValue(value: unknown): JsonValue
 redactedValueWith(value: unknown, redactionPolicy: RedactionPolicy): JsonValue
+redactedValueWithOptions(value: unknown, redactionOptions: RedactionOptions): JsonValue
 ```
 
 **Use case:** structured protocol payloads (frameworks automatically serialize)
@@ -128,15 +129,18 @@ const notFound = buildJson(
 );
 ```
 
-### CLI/Log Output (returns string)
+### Output Formatters (returns string)
 
-Format values for CLI output and logs. `outputJson` uses full `_secret` redaction by default. `outputJsonWith` supports explicit scoped policies. YAML and Plain always redact `_secret` and apply human-readable formatting.
+Format values for CLI output and logs. `outputJson` uses full `_secret` redaction by default. `outputJsonWith` supports explicit scoped policies. Use `OutputOptions` to pass legacy secret names such as `api_key` or request schema-preserving YAML/plain rendering with `OutputStyle.Raw`.
 
 ```typescript
 outputJson(value: JsonValue): string   // Single-line JSON, original keys, for programs/logs
 outputJsonWith(value: JsonValue, redactionPolicy: RedactionPolicy): string
+outputJsonWithOptions(value: JsonValue, outputOptions: OutputOptions): string
 outputYaml(value: JsonValue): string   // Multi-line YAML, keys stripped, values formatted
+outputYamlWithOptions(value: JsonValue, outputOptions: OutputOptions): string
 outputPlain(value: JsonValue): string  // Single-line logfmt, keys stripped, values formatted
+outputPlainWithOptions(value: JsonValue, outputOptions: OutputOptions): string
 ```
 
 ```typescript
@@ -145,8 +149,25 @@ enum RedactionPolicy {
   RedactionNone = "RedactionNone",
   RedactionStrict = "RedactionStrict",
 }
+
+type RedactionOptions = {
+  policy?: RedactionPolicy;
+  secretNames?: readonly string[]; // legacy names like "api_key" or "authorization"
+}
+
+enum OutputStyle {
+  Readable = "Readable",
+  Raw = "Raw",
+}
+
+type OutputOptions = {
+  redaction?: RedactionOptions;
+  style?: OutputStyle;
+}
 ```
 
+Secret names match exact field names at any nesting level; there is no trim, case folding, hyphen/underscore normalization, glob, regex, or substring matching. `OutputOptions` combines `RedactionOptions` with `OutputStyle.Readable` (default suffix stripping and value formatting) or `OutputStyle.Raw` (no suffix stripping or value formatting).
+
 **Example:**
 ```typescript
 import { outputJson, outputYaml, outputPlain } from "agent-first-data";
@@ -179,6 +200,7 @@ console.log(outputPlain(data));
 
 ```typescript
 internalRedactSecrets(value: JsonValue): void  // Manually redact secrets in-place
+internalRedactSecretsWithOptions(value: JsonValue, redactionOptions: RedactionOptions): void
 ```
 
 Most users don't need this. Output functions automatically protect secrets.
@@ -210,6 +232,7 @@ type OutputFormat = "json" | "yaml" | "plain"
 cliParseOutput(s: string): OutputFormat             // Parse --output flag; throws on unknown
 cliParseLogFilters(entries: string[]): string[]     // Normalize --log: trim, lowercase, dedup, remove empty
 cliOutput(value: JsonValue, format: OutputFormat): string  // Dispatch to outputJson/Yaml/Plain
+cliOutputWithOptions(value: JsonValue, format: OutputFormat, outputOptions: OutputOptions): string
 buildCliError(message: string, hint?: string): JsonValue  // {code:"error", error_code:"invalid_request", hint?, retryable:false, trace:{duration_ms:0}}
 ```
 

package/dist/cli.d.ts

@@ -1,7 +1,7 @@
 /**
  * AFDATA CLI helpers — output format parsing, log filter normalization, error building.
  */
-import { JsonValue } from "./format.js";
+import { JsonValue, type OutputOptions } from "./format.js";
 /** Output format for CLI and pipe/MCP modes. */
 export type OutputFormat = "json" | "yaml" | "plain";
 /**
@@ -29,6 +29,11 @@ export declare function cliParseLogFilters(entries: string[]): string[];
  * cliOutput({ code: "ok" }, "plain") // → "code=ok"
  */
 export declare function cliOutput(value: JsonValue, format: OutputFormat): string;
+/**
+ * Dispatch output formatting with explicit redaction and style.
+ * JSON ignores OutputStyle and preserves original keys and values after redaction.
+ */
+export declare function cliOutputWithOptions(value: JsonValue, format: OutputFormat, outputOptions: OutputOptions): string;
 /**
  * Build a standard CLI parse error value.
  * Use when flag parsing fails or a flag value is invalid.

package/dist/cli.js

@@ -1,7 +1,7 @@
 /**
  * AFDATA CLI helpers — output format parsing, log filter normalization, error building.
  */
-import { outputJson, outputYaml, outputPlain } from "./format.js";
+import { outputJson, outputJsonWithOptions, outputYaml, outputYamlWithOptions, outputPlain, outputPlainWithOptions, } from "./format.js";
 /**
  * Parse the --output flag value into an OutputFormat.
  * Throws on unknown values; catch and pass message to buildCliError.
@@ -47,6 +47,17 @@ export function cliOutput(value, format) {
         return outputPlain(value);
     return outputJson(value);
 }
+/**
+ * Dispatch output formatting with explicit redaction and style.
+ * JSON ignores OutputStyle and preserves original keys and values after redaction.
+ */
+export function cliOutputWithOptions(value, format, outputOptions) {
+    if (format === "yaml")
+        return outputYamlWithOptions(value, outputOptions);
+    if (format === "plain")
+        return outputPlainWithOptions(value, outputOptions);
+    return outputJsonWithOptions(value, outputOptions);
+}
 /**
  * Build a standard CLI parse error value.
  * Use when flag parsing fails or a flag value is invalid.

package/dist/format.d.ts

@@ -1,8 +1,9 @@
 /**
  * AFDATA output formatting and protocol templates.
  *
- * 11 public APIs and 1 type: protocol builders, redacted value helpers,
- * output formatters, redaction, parseSize, and RedactionPolicy.
+ * 16 public APIs and 4 types: protocol builders, redacted value helpers,
+ * output formatters, redaction, parseSize, RedactionPolicy, RedactionOptions,
+ * OutputStyle, and OutputOptions.
  */
 export type JsonValue = string | number | boolean | null | JsonValue[] | {
     [key: string]: JsonValue;
@@ -18,20 +19,49 @@ export declare enum RedactionPolicy {
     RedactionNone = "RedactionNone",
     RedactionStrict = "RedactionStrict"
 }
+export type RedactionOptions = {
+    /** Optional scoped policy. Omitted means default full redaction. */
+    policy?: RedactionPolicy;
+    /**
+     * Field names to treat as secrets in addition to _secret suffixes.
+     * Matching is exact field-name equality at any nesting level.
+     */
+    secretNames?: readonly string[];
+};
+export declare enum OutputStyle {
+    Readable = "Readable",
+    Raw = "Raw"
+}
+export type OutputOptions = {
+    /** Redaction options applied before rendering. */
+    redaction?: RedactionOptions;
+    /** Rendering style for YAML/plain output. Omitted means readable. */
+    style?: OutputStyle;
+};
 /** Format as single-line JSON. Secrets redacted, original keys, raw values. */
 export declare function outputJson(value: JsonValue): string;
 /** Format as single-line JSON with explicit redaction policy. */
 export declare function outputJsonWith(value: JsonValue, redactionPolicy: RedactionPolicy): string;
+/** Format as single-line JSON with explicit output options. */
+export declare function outputJsonWithOptions(value: JsonValue, outputOptions: OutputOptions): string;
 /** Format as multi-line YAML. Keys stripped, values formatted, secrets redacted. */
 export declare function outputYaml(value: JsonValue): string;
+/** Format as multi-line YAML with explicit output options. */
+export declare function outputYamlWithOptions(value: JsonValue, outputOptions: OutputOptions): string;
 /** Format as single-line logfmt. Keys stripped, values formatted, secrets redacted. */
 export declare function outputPlain(value: JsonValue): string;
+/** Format as single-line logfmt with explicit output options. */
+export declare function outputPlainWithOptions(value: JsonValue, outputOptions: OutputOptions): string;
 /** Redact _secret fields in-place. */
 export declare function internalRedactSecrets(value: JsonValue): void;
+/** Redact secret fields in-place using explicit redaction options. */
+export declare function internalRedactSecretsWithOptions(value: JsonValue, redactionOptions: RedactionOptions): void;
 /** Return a JSON-safe copy with default _secret redaction applied. */
 export declare function redactedValue(value: unknown): JsonValue;
 /** Return a JSON-safe copy with an explicit redaction policy applied. */
 export declare function redactedValueWith(value: unknown, redactionPolicy: RedactionPolicy): JsonValue;
+/** Return a JSON-safe copy with explicit redaction options applied. */
+export declare function redactedValueWithOptions(value: unknown, redactionOptions: RedactionOptions): JsonValue;
 /**
  * Parse a human-readable size string into bytes.
  * Accepts bare numbers or numbers followed by a unit letter (B/K/M/G/T).

package/dist/format.js

@@ -1,8 +1,9 @@
 /**
  * AFDATA output formatting and protocol templates.
  *
- * 11 public APIs and 1 type: protocol builders, redacted value helpers,
- * output formatters, redaction, parseSize, and RedactionPolicy.
+ * 16 public APIs and 4 types: protocol builders, redacted value helpers,
+ * output formatters, redaction, parseSize, RedactionPolicy, RedactionOptions,
+ * OutputStyle, and OutputOptions.
  */
 // ═══════════════════════════════════════════
 // Public API: Protocol Builders
@@ -40,6 +41,11 @@ export var RedactionPolicy;
     RedactionPolicy["RedactionNone"] = "RedactionNone";
     RedactionPolicy["RedactionStrict"] = "RedactionStrict";
 })(RedactionPolicy || (RedactionPolicy = {}));
+export var OutputStyle;
+(function (OutputStyle) {
+    OutputStyle["Readable"] = "Readable";
+    OutputStyle["Raw"] = "Raw";
+})(OutputStyle || (OutputStyle = {}));
 /** Format as single-line JSON. Secrets redacted, original keys, raw values. */
 export function outputJson(value) {
     return JSON.stringify(redactedValue(value));
@@ -48,18 +54,40 @@ export function outputJson(value) {
 export function outputJsonWith(value, redactionPolicy) {
     return JSON.stringify(redactedValueWith(value, redactionPolicy));
 }
+/** Format as single-line JSON with explicit output options. */
+export function outputJsonWithOptions(value, outputOptions) {
+    return JSON.stringify(redactedValueWithOptions(value, outputOptions.redaction ?? {}));
+}
 /** Format as multi-line YAML. Keys stripped, values formatted, secrets redacted. */
 export function outputYaml(value) {
-    value = redactedValue(value);
+    return outputYamlWithOptions(value, {});
+}
+/** Format as multi-line YAML with explicit output options. */
+export function outputYamlWithOptions(value, outputOptions) {
+    value = redactedValueWithOptions(value, outputOptions.redaction ?? {});
     const lines = ["---"];
-    renderYamlProcessed(value, 0, lines);
+    if (outputOptions.style === OutputStyle.Raw) {
+        renderYamlRaw(value, 0, lines);
+    }
+    else {
+        renderYamlProcessed(value, 0, lines);
+    }
     return lines.join("\n");
 }
 /** Format as single-line logfmt. Keys stripped, values formatted, secrets redacted. */
 export function outputPlain(value) {
-    value = redactedValue(value);
+    return outputPlainWithOptions(value, {});
+}
+/** Format as single-line logfmt with explicit output options. */
+export function outputPlainWithOptions(value, outputOptions) {
+    value = redactedValueWithOptions(value, outputOptions.redaction ?? {});
     const pairs = [];
-    collectPlainPairs(value, "", pairs);
+    if (outputOptions.style === OutputStyle.Raw) {
+        collectPlainPairsRaw(value, "", pairs);
+    }
+    else {
+        collectPlainPairs(value, "", pairs);
+    }
     pairs.sort(([a], [b]) => jcsCompare(a, b));
     return pairs
         .map(([k, v]) => `${k}=${quoteLogfmtValue(v)}`)
@@ -72,6 +100,10 @@ export function outputPlain(value) {
 export function internalRedactSecrets(value) {
     redactSecrets(value);
 }
+/** Redact secret fields in-place using explicit redaction options. */
+export function internalRedactSecretsWithOptions(value, redactionOptions) {
+    applyRedactionOptions(value, redactionOptions);
+}
 /** Return a JSON-safe copy with default _secret redaction applied. */
 export function redactedValue(value) {
     const v = sanitizeForJson(value);
@@ -84,6 +116,12 @@ export function redactedValueWith(value, redactionPolicy) {
     applyRedactionPolicy(v, redactionPolicy);
     return v;
 }
+/** Return a JSON-safe copy with explicit redaction options applied. */
+export function redactedValueWithOptions(value, redactionOptions) {
+    const v = sanitizeForJson(value);
+    applyRedactionOptions(v, redactionOptions);
+    return v;
+}
 /**
  * Parse a human-readable size string into bytes.
  * Accepts bare numbers or numbers followed by a unit letter (B/K/M/G/T).
@@ -123,61 +161,77 @@ export function parseSize(s) {
 // ═══════════════════════════════════════════
 // Secret Redaction
 // ═══════════════════════════════════════════
-function redactSecrets(value) {
+const EMPTY_SECRET_NAMES = new Set();
+function secretNameSet(redactionOptions) {
+    return new Set(redactionOptions.secretNames ?? []);
+}
+function keyHasSecretSuffix(key) {
+    return key.endsWith("_secret") || key.endsWith("_SECRET");
+}
+function isSecretKey(key, secretNames) {
+    return keyHasSecretSuffix(key) || secretNames.has(key);
+}
+function redactSecrets(value, secretNames = EMPTY_SECRET_NAMES) {
     if (isObject(value)) {
         for (const k of Object.keys(value)) {
-            if (k.endsWith("_secret") || k.endsWith("_SECRET")) {
+            if (isSecretKey(k, secretNames)) {
                 const v = value[k];
                 if (isObject(v) || Array.isArray(v)) {
-                    redactSecrets(v);
+                    redactSecrets(v, secretNames);
                 }
                 else {
                     value[k] = "***";
                 }
             }
             else {
-                redactSecrets(value[k]);
+                redactSecrets(value[k], secretNames);
             }
         }
     }
     else if (Array.isArray(value)) {
         for (const item of value) {
-            redactSecrets(item);
+            redactSecrets(item, secretNames);
         }
     }
 }
-function redactSecretsStrict(value) {
+function redactSecretsStrict(value, secretNames = EMPTY_SECRET_NAMES) {
     if (isObject(value)) {
         for (const k of Object.keys(value)) {
-            if (k.endsWith("_secret") || k.endsWith("_SECRET")) {
+            if (isSecretKey(k, secretNames)) {
                 value[k] = "***";
             }
             else {
-                redactSecretsStrict(value[k]);
+                redactSecretsStrict(value[k], secretNames);
             }
         }
     }
     else if (Array.isArray(value)) {
         for (const item of value) {
-            redactSecretsStrict(item);
+            redactSecretsStrict(item, secretNames);
         }
     }
 }
 function applyRedactionPolicy(value, redactionPolicy) {
+    applyRedactionPolicyWithNames(value, redactionPolicy, EMPTY_SECRET_NAMES);
+}
+function applyRedactionOptions(value, redactionOptions) {
+    applyRedactionPolicyWithNames(value, redactionOptions.policy, secretNameSet(redactionOptions));
+}
+function applyRedactionPolicyWithNames(value, redactionPolicy, secretNames) {
     switch (redactionPolicy) {
         case RedactionPolicy.RedactionTraceOnly:
             if (isObject(value) && value.trace !== undefined) {
-                redactSecrets(value.trace);
+                redactSecrets(value.trace, secretNames);
             }
             break;
         case RedactionPolicy.RedactionNone:
             break;
         case RedactionPolicy.RedactionStrict:
-            redactSecretsStrict(value);
+            redactSecretsStrict(value, secretNames);
             break;
         default:
-            // Safety fallback for unknown values.
-            redactSecrets(value);
+            // Empty/unknown policy falls back to default full redaction.
+            redactSecrets(value, secretNames);
             break;
     }
 }
@@ -483,6 +537,69 @@ function renderYamlProcessed(value, indent, lines) {
         }
     }
 }
+function renderYamlRaw(value, indent, lines) {
+    const prefix = "  ".repeat(indent);
+    if (isObject(value)) {
+        for (const key of sortedObjectKeys(value)) {
+            renderYamlFieldRaw(prefix, key, value[key], indent, lines);
+        }
+    }
+    else if (Array.isArray(value)) {
+        renderYamlArrayRaw(value, indent, lines);
+    }
+    else {
+        lines.push(`${prefix}${yamlScalar(value)}`);
+    }
+}
+function renderYamlFieldRaw(prefix, key, value, indent, lines) {
+    if (isObject(value)) {
+        if (Object.keys(value).length > 0) {
+            lines.push(`${prefix}${key}:`);
+            renderYamlRaw(value, indent + 1, lines);
+        }
+        else {
+            lines.push(`${prefix}${key}: {}`);
+        }
+    }
+    else if (Array.isArray(value)) {
+        if (value.length > 0) {
+            lines.push(`${prefix}${key}:`);
+            renderYamlArrayRaw(value, indent + 1, lines);
+        }
+        else {
+            lines.push(`${prefix}${key}: []`);
+        }
+    }
+    else {
+        lines.push(`${prefix}${key}: ${yamlScalar(value)}`);
+    }
+}
+function renderYamlArrayRaw(arr, indent, lines) {
+    const prefix = "  ".repeat(indent);
+    for (const item of arr) {
+        if (isObject(item)) {
+            if (Object.keys(item).length > 0) {
+                lines.push(`${prefix}-`);
+                renderYamlRaw(item, indent + 1, lines);
+            }
+            else {
+                lines.push(`${prefix}- {}`);
+            }
+        }
+        else if (Array.isArray(item)) {
+            if (item.length > 0) {
+                lines.push(`${prefix}-`);
+                renderYamlArrayRaw(item, indent + 1, lines);
+            }
+            else {
+                lines.push(`${prefix}- []`);
+            }
+        }
+        else {
+            lines.push(`${prefix}- ${yamlScalar(item)}`);
+        }
+    }
+}
 function escapeYamlStr(s) {
     return s.replace(/\\/g, "\\\\").replace(/"/g, '\\"').replace(/\n/g, "\\n").replace(/\r/g, "\\r").replace(/\t/g, "\\t");
 }
@@ -522,6 +639,26 @@ function collectPlainPairs(value, prefix, pairs) {
         }
     }
 }
+function collectPlainPairsRaw(value, prefix, pairs) {
+    if (!isObject(value))
+        return;
+    for (const key of sortedObjectKeys(value)) {
+        const v = value[key];
+        const fullKey = prefix ? `${prefix}.${key}` : key;
+        if (isObject(v)) {
+            collectPlainPairsRaw(v, fullKey, pairs);
+        }
+        else if (Array.isArray(v)) {
+            pairs.push([fullKey, v.map((i) => plainScalarRaw(i)).join(",")]);
+        }
+        else if (v === null) {
+            pairs.push([fullKey, ""]);
+        }
+        else {
+            pairs.push([fullKey, plainScalar(v)]);
+        }
+    }
+}
 function plainScalar(value) {
     if (typeof value === "string")
         return value;
@@ -533,6 +670,12 @@ function plainScalar(value) {
         return value.toString();
     return String(value);
 }
+function plainScalarRaw(value) {
+    if (isObject(value) || Array.isArray(value)) {
+        return JSON.stringify(sortJsonValue(value));
+    }
+    return plainScalar(value);
+}
 function quoteLogfmtValue(value) {
     if (value === "")
         return "";
@@ -598,6 +741,21 @@ function sanitizeForJson(value, stack = new WeakSet()) {
 function isObject(value) {
     return typeof value === "object" && value !== null && !Array.isArray(value);
 }
+function sortedObjectKeys(obj) {
+    return Object.keys(obj).sort(jcsCompare);
+}
+function sortJsonValue(value) {
+    if (Array.isArray(value))
+        return value.map(sortJsonValue);
+    if (isObject(value)) {
+        const out = {};
+        for (const key of sortedObjectKeys(value)) {
+            out[key] = sortJsonValue(value[key]);
+        }
+        return out;
+    }
+    return value;
+}
 function jcsCompare(a, b) {
     const ua = Array.from(a).flatMap((c) => {
         const cp = c.codePointAt(0);

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /**
  * Agent-First Data (AFDATA) — suffix-driven output formatting and protocol templates.
  */
-export { buildJsonOk, buildJsonError, buildJson, RedactionPolicy, outputJson, outputJsonWith, outputYaml, outputPlain, internalRedactSecrets, redactedValue, redactedValueWith, parseSize, } from "./format.js";
+export { buildJsonOk, buildJsonError, buildJson, RedactionPolicy, type RedactionOptions, OutputStyle, type OutputOptions, outputJson, outputJsonWith, outputJsonWithOptions, outputYaml, outputYamlWithOptions, outputPlain, outputPlainWithOptions, internalRedactSecrets, internalRedactSecretsWithOptions, redactedValue, redactedValueWith, redactedValueWithOptions, parseSize, } from "./format.js";
 export { log, span, initJson, initPlain, initYaml } from "./afdata_logging.js";
-export { type OutputFormat, cliParseOutput, cliParseLogFilters, cliOutput, buildCliError } from "./cli.js";
+export { type OutputFormat, cliParseOutput, cliParseLogFilters, cliOutput, cliOutputWithOptions, buildCliError, } from "./cli.js";

package/dist/index.js

@@ -1,6 +1,6 @@
 /**
  * Agent-First Data (AFDATA) — suffix-driven output formatting and protocol templates.
  */
-export { buildJsonOk, buildJsonError, buildJson, RedactionPolicy, outputJson, outputJsonWith, outputYaml, outputPlain, internalRedactSecrets, redactedValue, redactedValueWith, parseSize, } from "./format.js";
+export { buildJsonOk, buildJsonError, buildJson, RedactionPolicy, OutputStyle, outputJson, outputJsonWith, outputJsonWithOptions, outputYaml, outputYamlWithOptions, outputPlain, outputPlainWithOptions, internalRedactSecrets, internalRedactSecretsWithOptions, redactedValue, redactedValueWith, redactedValueWithOptions, parseSize, } from "./format.js";
 export { log, span, initJson, initPlain, initYaml } from "./afdata_logging.js";
-export { cliParseOutput, cliParseLogFilters, cliOutput, buildCliError } from "./cli.js";
+export { cliParseOutput, cliParseLogFilters, cliOutput, cliOutputWithOptions, buildCliError, } from "./cli.js";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "agent-first-data",
-  "version": "0.8.0",
-  "description": "Agent-First Data (AFDATA) — suffix-driven output formatting and protocol templates for AI agents",
+  "version": "0.9.0",
+  "description": "A naming convention that lets AI agents understand your data without being told what it means.",
   "license": "MIT",
   "repository": {
     "type": "git",