@hue-run/sdk 0.13.2 → 0.14.0

package/CLI.md

@@ -42,7 +42,7 @@ project manifest are refused because managers can update ancestor locks; Python
 The generated `hue.setup.mjs` or `hue_setup.py` always selects `captureContent: false` /
 `capture_content=False`. For a supported application, setup installs the dependency and adds the
 managed import and middleware registration to the existing entrypoint; an unreferenced helper is
-not a completed integration. TypeScript uses `@hue-run/sdk@0.13.2`, `@opentelemetry/api@1.9.1` and
+not a completed integration. TypeScript uses `@hue-run/sdk@0.14.0`, `@opentelemetry/api@1.9.1` and
 `@opentelemetry/context-async-hooks@2.11.0`; Python setup uses its separately tested package pin.
 Content capture requires an ordinary account-managed key and a later explicit application decision.
 
@@ -469,7 +469,7 @@ node packages/sdk-typescript/scripts/verify-package.mjs --artifacts-dir .artifac
 # Set project to an existing supported fixture; use the same directory on resume.
 project=/absolute/path/to/supported-fixture
 node packages/sdk-typescript/scripts/verify-setup-live.mjs \
-  --archive .artifacts/typescript/hue-run-sdk-0.13.2.tgz \
+  --archive .artifacts/typescript/hue-run-sdk-0.14.0.tgz \
   --origin https://STAGING_ORIGIN \
   --project "$project" --command setup \
   --evidence .context/setup-staging-before-claim.json
@@ -480,7 +480,7 @@ the private local handoff and finish the real browser claim, then reconcile the
 
 ```sh
 node packages/sdk-typescript/scripts/verify-setup-live.mjs \
-  --archive .artifacts/typescript/hue-run-sdk-0.13.2.tgz \
+  --archive .artifacts/typescript/hue-run-sdk-0.14.0.tgz \
   --origin https://STAGING_ORIGIN \
   --project "$project" --command claim \
   --evidence .context/setup-staging-after-claim.json
@@ -523,10 +523,10 @@ production agent lacks. Pin the SDK and bring its `zod` peer along, so the agent
 gains no dependency:
 
 ```sh
-npx --yes --package @hue-run/sdk@0.13.2 --package "zod@^4.6.5" hue eval --case "Refund an eligible charge" --command "node agent.js" --env-file .env.hue
-npx --yes --package @hue-run/sdk@0.13.2 --package "zod@^4.6.5" hue eval --case https://app.hue.run/projects/demo/scenarios/<id> --command "python agent.py" --timeout 120 --baseline <experiment id>
-npx --yes --package @hue-run/sdk@0.13.2 --package "zod@^4.6.5" hue eval --set "Billing regressions" --scorer-version <id> --command "node agent.js" --save-version
-npx --yes --package @hue-run/sdk@0.13.2 --package "zod@^4.6.5" hue eval --worker --command "node agent.js" --agent-key support-agent --revision <new-agent-revision> --env-file .env.hue
+npx --yes --package @hue-run/sdk@0.14.0 --package "zod@^4.6.5" hue eval --case "Refund an eligible charge" --command "node agent.js" --env-file .env.hue
+npx --yes --package @hue-run/sdk@0.14.0 --package "zod@^4.6.5" hue eval --case https://app.hue.run/projects/demo/scenarios/<id> --command "python agent.py" --timeout 120 --baseline <experiment id>
+npx --yes --package @hue-run/sdk@0.14.0 --package "zod@^4.6.5" hue eval --set "Billing regressions" --scorer-version <id> --command "node agent.js" --save-version
+npx --yes --package @hue-run/sdk@0.14.0 --package "zod@^4.6.5" hue eval --worker --command "node agent.js" --agent-key support-agent --revision <new-agent-revision> --env-file .env.hue
 ```
 
 Without the second `--package`, `hue eval` exits with `hue eval needs zod`, even for `--help`;
@@ -562,7 +562,7 @@ export default function runMyAgent(inputs: JsonValue, context: SimulationTargetC
 ```
 
 ```sh
-npx --yes --package @hue-run/sdk@0.13.2 --package "zod@^4.6.5" hue eval --case "Refund an eligible charge" ./hue-agent.ts --content --env-file .env.hue
+npx --yes --package @hue-run/sdk@0.14.0 --package "zod@^4.6.5" hue eval --case "Refund an eligible charge" ./hue-agent.ts --content --env-file .env.hue
 ```
 
 `--scenario` remains an alias for `--case` for existing scripts. Pass one selection flag.
@@ -667,21 +667,21 @@ A Scenario or eval set whose dataset version is not saved cannot back an experim
 exits 1 and asks for **Save eval-set version** in Hue or `--save-version`, which freezes that
 version at its current revision. Connection settings are `HUE_API_KEY` and `HUE_BASE_URL`
 (default `https://app.hue.run`), loaded from `--env-file <path>` (or its alias `--env-path`) first when given; `--origin`
-overrides the origin. Telemetry content capture stays off unless `--content` is passed; the
-examples pass it so the run's case spans carry content. Model and tool spans inside the agent come
+overrides the origin. Starting with TypeScript 0.14.0, telemetry content capture defaults on; `--no-content` opts out.
+Earlier releases require `--content`; the examples include it for compatibility. Model and tool spans inside the agent come
 only from the agent's own instrumentation. Case outputs, error messages and explanations are
-stored in Hue whether or not `--content` is passed, so a case's answer can be graded and read on
+stored in Hue independently of the telemetry capture setting, so a case's answer can be graded and read on
 its run page. A `--command`'s stdout is its answer unless it writes a result file, and is stored,
 so it must not print credentials or debug logs there; before storing, `hue eval` replaces the
 credentials it handed the case (the world token and MCP headers, a legacy MCP token, attempt
 bearers) and every Hue control-plane credential in its environment with `[redacted]`, in the
 answer, an adapter's thrown message and name, generated file names and the local checkpoint.
 `--no-output` keeps outputs, error messages and explanations out of a one-shot run's stored
-results; with `--content` the case span still carries the output. `--worker` always stores them, because a run launched from Hue is read
+results; captured telemetry still carries the output. Pass `--no-output --no-content` to omit both. `--worker` always stores them, because a run launched from Hue is read
 on its run page (that is `runLocalAgent()`'s contract), and refuses `--no-output`. An interrupted
 one-shot run keeps the choice it started with, so one run never mixes stored and unstored outputs:
-rerunning it with other `--no-output` or `--content` flags is refused with the flags it started
-with. Resume a run that an earlier SDK started without `--content` by passing `--no-output`.
+rerunning it with another output or telemetry capture policy is refused with the flags that resume it.
+To resume a metadata-only trace from an earlier release, add `--no-content` and keep its original `--no-output` choice.
 
 Files the agent writes to `output/` are uploaded as generated documents with or without
 `--no-output`, and they are not redacted the way the answer is: `hue eval` replaces the same

package/EVALUATIONS.md

@@ -303,7 +303,7 @@ and require a Hue deployment that serves case `inputFiles` on experiment
 items, subject `files`, and the artifact reservation, upload, completion and download APIs. The
 Python SDK has no equivalent.
 
-The TypeScript 0.13.2 `hue eval --worker --command "…"` wrapper supplies both callbacks, so one
+Since TypeScript 0.13.2, the `hue eval --worker --command "…"` wrapper supplies both callbacks, so one
 command worker accepts direct and world cases, including mixed eval sets. It keeps the launch
 directory for relative application entry points; private case inputs/output still use
 `HUE_CASE_*`. An adapter-file worker opts into the direct callback with `--capability direct:v1`

package/README.md

@@ -35,7 +35,7 @@ import { createHue, HueExportError } from "@hue-run/sdk";
 const hue = createHue({
   apiKey: process.env.HUE_API_KEY!, // a project service key, on the server only
   serviceName: "my-agent",
-  captureContent: true, // required: true records content; false sends metadata only
+  captureContent: true, // Also works with older releases; false sends metadata only
   onExportIssue: (issue) => console.error(issue), // sanitized counts, never server bodies
 });
 
@@ -57,7 +57,7 @@ try {
 await hue.shutdown(); // flushes and releases providers owned by this client
 ```
 
-`captureContent` is required. The example sets `true`, the recommended choice: trace inspection,
+Starting with TypeScript 0.14.0, `captureContent` defaults to `true`. Earlier releases require an explicit choice. The example sets `true`: trace inspection,
 evaluations and judges read the prompts, responses and tool inputs/outputs it records. Choose
 `false` for metadata only when a policy forbids sending that content; see
 [Privacy and content](#privacy-and-content).
@@ -649,11 +649,11 @@ before), wraps `runSimulation()` and `runLocalAgent()` for an adapter file or a
 `hue eval --case "<name>" ./hue-agent.ts --content` creates a fresh run from a published case's
 immutable pins, runs the agent with an isolated world when the case pins one, waits
 for Hue's outcome checks and prints the run URL and per-case PASS/FAIL verdicts with an exit code;
-`--worker` registers the same adapter for runs launched from Hue. In TypeScript 0.13.2, a
+`--worker` registers the same adapter for runs launched from Hue. Since TypeScript 0.13.2, a
 command worker handles both world and answer-only cases; adapter workers opt into direct cases
 with `--capability direct:v1`. Upgrade an existing command registration under a new `--revision`.
-It needs a Read and write key in `HUE_API_KEY` (never printed). Content capture stays off unless `--content` is
-passed; the example passes it so case spans carry content. Case outputs, error messages and
+It needs a Read and write key in `HUE_API_KEY` (never printed). Content capture defaults on; `--no-content` opts out. The example passes `--content` explicitly
+for compatibility with older releases. Case outputs, error messages and
 explanations are stored in Hue either way (`--no-output` keeps them out of a one-shot run's
 results); a command's stdout is its stored answer, with the credentials `hue eval` handed the case
 replaced by `[redacted]`.

package/dist/cli/eval.js

@@ -78,7 +78,8 @@ Output and limits:
   --name <run name>               Run name (default: <agent key> @ <revision>, hashes shortened)
   --baseline <experiment id|url>  Compare verdicts with a previous experiment
   --json                          Print one JSON document on stdout; progress goes to stderr
-  --content                       Capture telemetry content (span inputs, outputs and messages)
+  --content                       Capture telemetry content (the default)
+  --no-content                    Omit telemetry inputs, outputs and messages
   --no-output                     One-shot: do not store case outputs, error messages and
                                   explanations (stored by default; --worker always stores); with
                                   --content the case span still carries the output
@@ -141,7 +142,8 @@ function parse(argv) {
                 name: { type: "string" },
                 baseline: { type: "string" },
                 json: { type: "boolean", default: false },
-                content: { type: "boolean", default: false },
+                content: { type: "boolean" },
+                "no-content": { type: "boolean", default: false },
                 "no-output": { type: "boolean", default: false },
                 "trace-not-accepted": { type: "string" },
                 "save-version": { type: "boolean", default: false },
@@ -817,9 +819,9 @@ export function explain(error) {
     if (error instanceof CheckpointIdentityError && error.startedWith) {
         const flags = [
             error.startedWith.persistResultContent === false ? "--no-output" : "",
-            error.startedWith.captureContent === true ? "--content" : "",
+            error.startedWith.captureContent === false ? "--no-content" : "",
         ].filter(Boolean);
-        return `This unfinished run was started ${flags.length ? `with ${flags.join(" and ")}` : "without --no-output or --content"}; rerun with the same flags to resume it, or remove its checkpoint directory to start over`;
+        return `This unfinished run was started ${flags.length ? `with ${flags.join(" and ")}` : "without --no-output or --no-content"}; rerun with the same flags to resume it, or remove its checkpoint directory to start over`;
     }
     // The error's own message points at an in-memory report the user cannot reach.
     if (error instanceof HueExportError)
@@ -1446,6 +1448,8 @@ export async function runEvalCommand(argv) {
     let json = false;
     try {
         const { values, positionals } = parse(argv);
+        if (values.content && values["no-content"])
+            throw new UsageError("Choose either --content or --no-content");
         // A usage error before anything is prepared or created: no run is left to recover from it.
         traceNotAcceptedPolicy(values["trace-not-accepted"]);
         json = values.json;
@@ -1522,7 +1526,7 @@ export async function runEvalCommand(argv) {
             apiKey,
             baseUrl,
             serviceName: key,
-            captureContent: values.content,
+            captureContent: values.content ?? !values["no-content"],
             timeoutMillis: CASE_TRACE_EXPORT_MILLIS,
         });
         return values.worker

package/dist/config.js

@@ -37,8 +37,8 @@ export function validateOptions(options) {
             liveSpans: false,
         };
     }
-    if (typeof options.captureContent !== "boolean")
-        throw new TypeError("Choose captureContent explicitly: true or false");
+    if (options.captureContent !== undefined && typeof options.captureContent !== "boolean")
+        throw new TypeError("captureContent must be a boolean");
     if (typeof options.apiKey !== "string" ||
         !options.apiKey ||
         options.apiKey.length > 4096 ||
@@ -83,5 +83,12 @@ export function validateOptions(options) {
         throw new TypeError("liveSpans must be a boolean");
     // Setup credentials send installer telemetry only, never in-progress placeholders.
     const liveSpans = options.liveSpans !== false && !options.apiKey.startsWith("hue_setup_");
-    return { ...options, baseUrl: url.origin, timeoutMillis, maxQueueBytes, liveSpans };
+    return {
+        ...options,
+        captureContent: options.captureContent ?? true,
+        baseUrl: url.origin,
+        timeoutMillis,
+        maxQueueBytes,
+        liveSpans,
+    };
 }

package/dist/types.d.ts

@@ -13,10 +13,11 @@ export type Signal = "traces" | "logs";
 /** Options accepted by every Hue client and transport, whether enabled or disabled. */
 export interface SharedHueOptions {
     /**
-     * Whether helpers record prompts, responses, tool arguments and results. Required for an enabled
-     * client, with no default; a disabled client (`enabled: false`) defaults it to `false`.
+     * Whether helpers record prompts, responses, tool arguments and results. Defaults to `true`
+     * for an enabled client; set `false` explicitly for metadata-only export. A disabled client
+     * (`enabled: false`) exports nothing and defaults it to `false`.
      */
-    captureContent: boolean;
+    captureContent?: boolean;
     /** Hue origin, `https://app.hue.run` by default. An origin only: no path, query, fragment or credentials. */
     baseUrl?: string;
     /** Recorded as the `service.version` resource attribute of an owned client. */
@@ -52,7 +53,8 @@ export interface SharedHueOptions {
 }
 /**
  * Options for a client that owns its OpenTelemetry providers. An enabled client needs a project
- * key, a service name and an explicit `captureContent` choice. The kill switch (`enabled: false`)
+ * key and a service name. Content capture defaults to `true`; `captureContent: false` opts out.
+ * The kill switch (`enabled: false`)
  * exports nothing while helpers keep running application code, so it needs no key and
  * `captureContent` defaults to `false`.
  */

package/dist/version.d.ts

@@ -1,2 +1,2 @@
 /** Package version shared by the instrumentation scope and the export User-Agent. */
-export declare const sdkVersion = "0.13.2";
+export declare const sdkVersion = "0.14.0";

package/dist/version.js

@@ -1,3 +1,3 @@
 // Generated by scripts/write-version.mjs from package.json; do not edit by hand.
 /** Package version shared by the instrumentation scope and the export User-Agent. */
-export const sdkVersion = "0.13.2";
+export const sdkVersion = "0.14.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hue-run/sdk",
-  "version": "0.13.2",
+  "version": "0.14.0",
   "private": false,
   "license": "MIT",
   "publishConfig": {