nexus-ai-pro 2.2.0 → 2.4.0

package/dist-cjs/agent/middleware/filesystem.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filesystemContext = filesystemContext;
+function filesystemContext(options) {
+    const maxChars = options.maxChars ?? 32_000;
+    const offload = options.offload === true
+        ? {}
+        : options.offload === false || options.offload === undefined
+            ? undefined
+            : options.offload;
+    if (offload && !options.source.writeFile) {
+        throw new TypeError('filesystemContext() offloading needs a source with writeFile()');
+    }
+    const loaded = new Map();
+    const load = async () => {
+        const sections = [];
+        let budget = maxChars;
+        for (const file of options.include ?? []) {
+            if (budget <= 0)
+                break;
+            let text;
+            try {
+                text = await options.source.readFile(file);
+            }
+            catch {
+                continue;
+            }
+            const cut = text.length > budget ? `${text.slice(0, budget)}\n[cut: ${text.length - budget} more characters]` : text;
+            budget -= text.length;
+            sections.push(`<file path="${file}">\n${cut}\n</file>`);
+        }
+        if (options.listing && options.source.listFiles) {
+            try {
+                const entries = await options.source.listFiles(options.listing.directory ?? '.');
+                const max = options.listing.maxEntries ?? 200;
+                const shown = entries.slice(0, max).join('\n');
+                sections.push(`<listing directory="${options.listing.directory ?? '.'}">\n${shown}${entries.length > max ? `\n[${entries.length - max} more]` : ''}\n</listing>`);
+            }
+            catch {
+            }
+        }
+        return sections.length ? `Files from the workspace:\n\n${sections.join('\n\n')}` : undefined;
+    };
+    return {
+        name: 'filesystem-context',
+        async beforeModel({ request, state, threadId }) {
+            if (!options.include?.length && !options.listing)
+                return;
+            const turn = state.messages.filter((message) => message.role === 'user').length;
+            const key = `${threadId}:${turn}`;
+            let pending = loaded.get(key);
+            if (!pending) {
+                pending = load();
+                loaded.set(key, pending);
+                if (loaded.size > 256)
+                    loaded.delete(loaded.keys().next().value);
+            }
+            const text = await pending;
+            if (!text)
+                return;
+            const systemCount = request.messages.findIndex((message) => message.role !== 'system');
+            const at = systemCount === -1 ? request.messages.length : systemCount;
+            const context = { role: 'system', content: text };
+            return { ...request, messages: [...request.messages.slice(0, at), context, ...request.messages.slice(at)] };
+        },
+        async wrapToolCall(call, next) {
+            const result = await next();
+            if (!offload || !result.ok || (offload.exclude ?? ['read_file']).includes(call.name))
+                return result;
+            const value = result.result;
+            if (value?.type === 'tool_output')
+                return result;
+            const text = typeof value === 'string' ? value : JSON.stringify(value);
+            if (text === undefined || text.length <= (offload.overChars ?? 20_000))
+                return result;
+            const directory = (offload.directory ?? '.context').replace(/\/+$/, '');
+            const file = `${directory}/${`${call.name}-${call.id}`.replace(/[^A-Za-z0-9._-]/g, '_')}.txt`;
+            await options.source.writeFile?.(file, text);
+            const preview = text.slice(0, offload.previewChars ?? 1_000);
+            return {
+                ok: true,
+                result: `${preview}\n\n[This result is ${text.length} characters; the first ${preview.length} are above. The whole result is in ${file}: read it with read_file when you need the rest.]`,
+            };
+        },
+    };
+}

package/dist-cjs/agent/middleware/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Middleware for `createAgent()`, each its own import: retries, fallbacks, model choice, tool
+ * selection, context editing, personal data, approvals, limits, and the filesystem as context.
+ *
+ * Each is ordinary `AgentMiddleware` built on the same hooks an application's own middleware uses,
+ * so any of them can be read, copied, and changed. None adds a dependency, and a bundler keeps only
+ * the ones imported.
+ */
+export { limitToolCalls, redactMessages, type RedactOptions, summarizeHistory, type SummarizeOptions, } from './basic.js';
+export { type ClearedToolResult, type ContextEdit, contextEditor, type ContextEditorOptions, estimateRequestTokens, } from './context-editor.js';
+export { type ContextOffloadOptions, filesystemContext, type FilesystemContextOptions, type FilesystemContextSource, } from './filesystem.js';
+export { humanApproval, type HumanApprovalOptions } from './approval.js';
+export { modelCallLimit, ModelCallLimitError, type ModelCallLimitOptions } from './limits.js';
+export { type DynamicModelContext, dynamicModel, modelFallback, type ModelFallbackEvent, type ModelFallbackOptions, type ModelFallbackTarget, } from './models.js';
+export { PiiBlockedError, type PiiFinding, type PiiKind, piiMiddleware, type PiiMiddlewareOptions, type PiiStrategy, type PiiWhere, } from './pii.js';
+export { modelRetry, type ModelRetryOptions, type RetryEvent, toolRetry, type ToolRetryOptions } from './retry.js';
+export type { RetryBackoff } from './shared.js';
+export { type ToolSelection, type ToolSelectionContext, toolSelector, type ToolSelectorOptions, } from './tool-selector.js';
+export type { AgentMiddleware, AgentMiddlewareContext, AgentModelCallContext, AgentToolCall, AgentToolResult, } from '../create-agent.js';

package/dist-cjs/agent/middleware/index.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toolSelector = exports.toolRetry = exports.modelRetry = exports.piiMiddleware = exports.PiiBlockedError = exports.modelFallback = exports.dynamicModel = exports.ModelCallLimitError = exports.modelCallLimit = exports.humanApproval = exports.filesystemContext = exports.estimateRequestTokens = exports.contextEditor = exports.summarizeHistory = exports.redactMessages = exports.limitToolCalls = void 0;
+var basic_js_1 = require("./basic.js");
+Object.defineProperty(exports, "limitToolCalls", { enumerable: true, get: function () { return basic_js_1.limitToolCalls; } });
+Object.defineProperty(exports, "redactMessages", { enumerable: true, get: function () { return basic_js_1.redactMessages; } });
+Object.defineProperty(exports, "summarizeHistory", { enumerable: true, get: function () { return basic_js_1.summarizeHistory; } });
+var context_editor_js_1 = require("./context-editor.js");
+Object.defineProperty(exports, "contextEditor", { enumerable: true, get: function () { return context_editor_js_1.contextEditor; } });
+Object.defineProperty(exports, "estimateRequestTokens", { enumerable: true, get: function () { return context_editor_js_1.estimateRequestTokens; } });
+var filesystem_js_1 = require("./filesystem.js");
+Object.defineProperty(exports, "filesystemContext", { enumerable: true, get: function () { return filesystem_js_1.filesystemContext; } });
+var approval_js_1 = require("./approval.js");
+Object.defineProperty(exports, "humanApproval", { enumerable: true, get: function () { return approval_js_1.humanApproval; } });
+var limits_js_1 = require("./limits.js");
+Object.defineProperty(exports, "modelCallLimit", { enumerable: true, get: function () { return limits_js_1.modelCallLimit; } });
+Object.defineProperty(exports, "ModelCallLimitError", { enumerable: true, get: function () { return limits_js_1.ModelCallLimitError; } });
+var models_js_1 = require("./models.js");
+Object.defineProperty(exports, "dynamicModel", { enumerable: true, get: function () { return models_js_1.dynamicModel; } });
+Object.defineProperty(exports, "modelFallback", { enumerable: true, get: function () { return models_js_1.modelFallback; } });
+var pii_js_1 = require("./pii.js");
+Object.defineProperty(exports, "PiiBlockedError", { enumerable: true, get: function () { return pii_js_1.PiiBlockedError; } });
+Object.defineProperty(exports, "piiMiddleware", { enumerable: true, get: function () { return pii_js_1.piiMiddleware; } });
+var retry_js_1 = require("./retry.js");
+Object.defineProperty(exports, "modelRetry", { enumerable: true, get: function () { return retry_js_1.modelRetry; } });
+Object.defineProperty(exports, "toolRetry", { enumerable: true, get: function () { return retry_js_1.toolRetry; } });
+var tool_selector_js_1 = require("./tool-selector.js");
+Object.defineProperty(exports, "toolSelector", { enumerable: true, get: function () { return tool_selector_js_1.toolSelector; } });

package/dist-cjs/agent/middleware/limits.d.ts

@@ -0,0 +1,42 @@
+import type { AgentMiddleware } from '../create-agent.js';
+/** Options for `modelCallLimit()`. Set `run`, `thread`, or both. */
+export interface ModelCallLimitOptions {
+    /** Model calls in one run: from a user message to the answer, a resumed approval included. */
+    run?: number;
+    /**
+     * Model calls over a thread's whole life, every run on it included. Counted in the agent's store
+     * when it has one, so every process shares the count and it survives a restart; otherwise in this
+     * process. A budget, not a lock: two runs on one thread at the same moment may each pass it once.
+     */
+    thread?: number;
+    /**
+     * What happens at a limit: `end` answers with `message` and stops with `stopReason: 'stopped'`,
+     * without calling the model; `error` fails the run with a `ModelCallLimitError`. Defaults to `end`.
+     */
+    onLimit?: 'end' | 'error';
+    /** The answer a run ends with under `end`. Defaults to a sentence naming the limit. */
+    message?: string;
+}
+/** Thrown by `modelCallLimit()` under `onLimit: 'error'`. */
+export declare class ModelCallLimitError extends Error {
+    /** Which limit was reached. */
+    readonly scope: 'run' | 'thread';
+    /** The limit. */
+    readonly limit: number;
+    /** Always `MODEL_CALL_LIMIT`. */
+    readonly code = "MODEL_CALL_LIMIT";
+    constructor(
+    /** Which limit was reached. */
+    scope: 'run' | 'thread', 
+    /** The limit. */
+    limit: number);
+}
+/**
+ * Caps the model calls of a run, of a thread, or both.
+ *
+ * `maxIterations` stops one run that keeps calling tools; this is a budget an application sets per
+ * run and per conversation, so a thread a user keeps coming back to cannot spend without bound. The
+ * run count is read from the transcript, so it survives a restart. A run that reaches a limit ends
+ * with an answer rather than an error, unless you ask for one.
+ */
+export declare function modelCallLimit(options: ModelCallLimitOptions): AgentMiddleware;

package/dist-cjs/agent/middleware/limits.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelCallLimitError = void 0;
+exports.modelCallLimit = modelCallLimit;
+const shared_js_1 = require("./shared.js");
+class ModelCallLimitError extends Error {
+    scope;
+    limit;
+    code = 'MODEL_CALL_LIMIT';
+    constructor(scope, limit) {
+        super(`The agent reached its limit of ${limit} model calls per ${scope}`);
+        this.scope = scope;
+        this.limit = limit;
+        this.name = 'ModelCallLimitError';
+    }
+}
+exports.ModelCallLimitError = ModelCallLimitError;
+const NAMESPACE = ['nexus', 'agent', 'model-calls'];
+function modelCallLimit(options) {
+    if (options.run === undefined && options.thread === undefined) {
+        throw new RangeError('modelCallLimit() needs a run limit, a thread limit, or both');
+    }
+    const local = new Map();
+    return {
+        name: 'model-call-limit',
+        async wrapModelCall(request, next, context) {
+            let reached;
+            if (options.run !== undefined && (0, shared_js_1.modelCallsInTurn)(context.state.messages) >= options.run) {
+                reached = ['run', options.run];
+            }
+            let used = 0;
+            if (!reached && options.thread !== undefined) {
+                used = context.store
+                    ? ((await context.store.get(NAMESPACE, context.threadId))?.value ?? 0)
+                    : (local.get(context.threadId) ?? 0);
+                if (used >= options.thread)
+                    reached = ['thread', options.thread];
+            }
+            if (reached) {
+                const [scope, limit] = reached;
+                if (options.onLimit === 'error')
+                    throw new ModelCallLimitError(scope, limit);
+                return context.stop(options.message ?? `I stopped here: this ${scope} reached its limit of ${limit} model calls.`);
+            }
+            if (options.thread !== undefined) {
+                if (context.store)
+                    await context.store.put(NAMESPACE, context.threadId, used + 1);
+                else {
+                    local.set(context.threadId, used + 1);
+                    if (local.size > 10_000)
+                        local.delete(local.keys().next().value);
+                }
+            }
+            return next(request);
+        },
+    };
+}

package/dist-cjs/agent/middleware/models.d.ts

@@ -0,0 +1,48 @@
+import type { CompletionRequest } from '../../types/messages.js';
+import type { AgentMiddleware, AgentMiddlewareContext, AgentModelClient } from '../create-agent.js';
+/** A model to fall back to: a model name for the agent's own client, or another client. */
+export type ModelFallbackTarget = string | {
+    client: AgentModelClient;
+    model?: string;
+};
+/** One fallback about to happen. */
+export interface ModelFallbackEvent {
+    /** The model that failed. */
+    from: string;
+    /** The model tried next. */
+    to: string;
+    /** What the failed call threw. */
+    error: unknown;
+}
+/** Options for `modelFallback()`. */
+export interface ModelFallbackOptions {
+    /** Whether an error moves on to the next model. Defaults to every error but a cancellation. */
+    fallbackOn?: (error: unknown, model: string) => boolean;
+    /** Called before each fallback, for logs and metrics. */
+    onFallback?: (event: ModelFallbackEvent) => void;
+}
+/**
+ * Tries other models, in order, when the model call fails.
+ *
+ * The client's router already falls back between providers for one request; this is the fallback
+ * it cannot make: to a client of a different kind, or once the client's own routes are exhausted. A
+ * target with its own client is called through `complete()`, never streamed, and middleware after
+ * this one does not wrap it.
+ */
+export declare function modelFallback(models: readonly ModelFallbackTarget[], options?: ModelFallbackOptions): AgentMiddleware;
+/** What `dynamicModel()` decides from: the step's context and the request about to be sent. */
+export type DynamicModelContext = AgentMiddlewareContext & {
+    request: CompletionRequest;
+};
+/**
+ * Chooses the model for each call from the run so far.
+ *
+ * A cheap model for the first steps and a stronger one once the task proves hard, a model with a
+ * longer context once the transcript grows, or a tenant's own model. Returning nothing keeps the
+ * model the request already names.
+ *
+ * ```ts
+ * dynamicModel(({ state }) => (state.iterations >= 4 ? 'gpt-5' : 'gpt-5-mini'))
+ * ```
+ */
+export declare function dynamicModel(select: (context: DynamicModelContext) => string | undefined | Promise<string | undefined>): AgentMiddleware;

package/dist-cjs/agent/middleware/models.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.modelFallback = modelFallback;
+exports.dynamicModel = dynamicModel;
+const shared_js_1 = require("./shared.js");
+function modelFallback(models, options = {}) {
+    if (models.length === 0)
+        throw new RangeError('modelFallback() needs at least one model to fall back to');
+    return {
+        name: 'model-fallback',
+        async wrapModelCall(request, next, context) {
+            try {
+                return await next(request);
+            }
+            catch (first) {
+                let error = first;
+                let from = request.model;
+                for (const target of models) {
+                    if ((0, shared_js_1.isCancellation)(error, context.signal) || !(options.fallbackOn?.(error, from) ?? true))
+                        throw error;
+                    const model = typeof target === 'string' ? target : (target.model ?? request.model);
+                    options.onFallback?.({ from, to: model, error });
+                    try {
+                        return typeof target === 'string'
+                            ? await next({ ...request, model })
+                            : await target.client.complete({ ...request, model });
+                    }
+                    catch (failure) {
+                        error = failure;
+                        from = model;
+                    }
+                }
+                throw error;
+            }
+        },
+    };
+}
+function dynamicModel(select) {
+    return {
+        name: 'dynamic-model',
+        async beforeModel(context) {
+            const model = await select(context);
+            if (!model || model === context.request.model)
+                return;
+            return { ...context.request, model };
+        },
+    };
+}

package/dist-cjs/agent/middleware/pii.d.ts

@@ -0,0 +1,67 @@
+import type { AgentMiddleware } from '../create-agent.js';
+/** The personal data and secrets `piiMiddleware()` finds on its own. */
+export type PiiKind = 'email' | 'credit-card' | 'ssn' | 'phone' | 'iban' | 'ip-address' | 'secret';
+/**
+ * What happens to a match: `redact` replaces it with its kind, `mask` keeps its last four
+ * characters, `hash` replaces it with a stable token so two values stay distinguishable, and `block`
+ * refuses the whole message.
+ */
+export type PiiStrategy = 'redact' | 'mask' | 'hash' | 'block';
+/** Where a match was found. */
+export type PiiWhere = 'input' | 'output' | 'tool';
+/** One match, as `onDetect` sees it: never the value itself. */
+export interface PiiFinding {
+    /** Its kind: a built-in kind or a name from `patterns`. */
+    kind: string;
+    /** Where it was found. */
+    where: PiiWhere;
+    /** What was done with it. */
+    strategy: PiiStrategy;
+}
+/** Options for `piiMiddleware()`. */
+export interface PiiMiddlewareOptions {
+    /** The built-in kinds to find. Defaults to all of them. */
+    kinds?: readonly PiiKind[];
+    /** Kinds of your own, by name: `{ 'employee-id': /\bEMP-\d{6}\b/ }`. */
+    patterns?: Readonly<Record<string, RegExp>>;
+    /**
+     * What happens to a match, for every kind or per kind: `'mask'`, or
+     * `{ email: 'hash', 'credit-card': 'block' }`. Kinds not named are redacted.
+     */
+    strategy?: PiiStrategy | Readonly<Record<string, PiiStrategy>>;
+    /**
+     * Where to look. `input` is every message sent to the model but the system prompt; `output` is
+     * the model's answer; `toolResults` cleans a result before it enters the transcript, so it is never
+     * checkpointed either. Defaults to input and tool results.
+     */
+    apply?: {
+        input?: boolean;
+        output?: boolean;
+        toolResults?: boolean;
+    };
+    /** Called for each match, for an audit trail. */
+    onDetect?: (finding: PiiFinding) => void;
+}
+/** Thrown when a match under the `block` strategy is found in the model's input or output. */
+export declare class PiiBlockedError extends Error {
+    /** The kind that was found. */
+    readonly kind: string;
+    /** Where it was found. */
+    readonly where: PiiWhere;
+    /** Always `PII_BLOCKED`. */
+    readonly code = "PII_BLOCKED";
+    constructor(
+    /** The kind that was found. */
+    kind: string, 
+    /** Where it was found. */
+    where: PiiWhere);
+}
+/**
+ * Keeps personal data and secrets away from the model, the transcript, or both.
+ *
+ * Finds emails, card numbers (checked with Luhn), US social security numbers, phone numbers, IBANs
+ * (checked with their checksum), IP addresses, and common API keys and private keys, plus any kinds
+ * of your own; and redacts, masks, hashes, or blocks each. The validated kinds keep false positives
+ * low: an order number is not a card number unless its checksum says so.
+ */
+export declare function piiMiddleware(options?: PiiMiddlewareOptions): AgentMiddleware;

package/dist-cjs/agent/middleware/pii.js

@@ -0,0 +1,147 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PiiBlockedError = void 0;
+exports.piiMiddleware = piiMiddleware;
+const checksums_js_1 = require("../../utils/checksums.js");
+const shared_js_1 = require("./shared.js");
+class PiiBlockedError extends Error {
+    kind;
+    where;
+    code = 'PII_BLOCKED';
+    constructor(kind, where) {
+        super(`The ${where === 'input' ? 'request' : 'response'} contains ${kind}, which is blocked`);
+        this.kind = kind;
+        this.where = where;
+        this.name = 'PiiBlockedError';
+    }
+}
+exports.PiiBlockedError = PiiBlockedError;
+const DETECTORS = {
+    secret: {
+        pattern: /-----BEGIN [A-Z ]*PRIVATE KEY-----[\s\S]*?-----END [A-Z ]*PRIVATE KEY-----|\b(?:sk-[A-Za-z0-9_-]{20,}|AKIA[0-9A-Z]{16}|gh[pousr]_[A-Za-z0-9]{36,}|xox[abprs]-[A-Za-z0-9-]{10,}|AIza[0-9A-Za-z_-]{35})\b/g,
+    },
+    email: { pattern: /\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}\b/g },
+    'credit-card': { pattern: /\b\d(?:[ -]?\d){12,18}\b/g, valid: checksums_js_1.luhn },
+    iban: { pattern: /\b[A-Z]{2}\d{2}(?: ?[A-Z0-9]{4}){2,7}(?: ?[A-Z0-9]{1,4})?\b/g, valid: checksums_js_1.ibanChecksum },
+    ssn: { pattern: /\b(?!000|666|9\d\d)\d{3}-(?!00)\d{2}-(?!0000)\d{4}\b/g },
+    'ip-address': { pattern: /\b(?:(?:25[0-5]|2[0-4]\d|1?\d?\d)\.){3}(?:25[0-5]|2[0-4]\d|1?\d?\d)\b/g },
+    phone: {
+        pattern: /(?<![\w+])\+?(?:\(\d{1,4}\)|\d{1,4})(?:[ .-]?(?:\(\d{1,4}\)|\d{2,4})){2,4}(?!\w)/g,
+        valid: checksums_js_1.phoneNumber,
+    },
+};
+const ORDER = ['secret', 'email', 'credit-card', 'iban', 'ssn', 'ip-address', 'phone'];
+function piiMiddleware(options = {}) {
+    const kinds = new Set(options.kinds ?? ORDER);
+    const detectors = [
+        ...ORDER.filter((kind) => kinds.has(kind)).map((kind) => [kind, DETECTORS[kind]]),
+        ...Object.entries(options.patterns ?? {}).map(([kind, pattern]) => [
+            kind,
+            { pattern: pattern.flags.includes('g') ? pattern : new RegExp(pattern.source, `${pattern.flags}g`) },
+        ]),
+    ];
+    const apply = { input: true, output: false, toolResults: true, ...options.apply };
+    const strategyOf = (kind) => typeof options.strategy === 'string' ? options.strategy : (options.strategy?.[kind] ?? 'redact');
+    const clean = (text, where) => {
+        let current = text;
+        for (const [kind, detector] of detectors) {
+            const strategy = strategyOf(kind);
+            let blocked = false;
+            current = current.replace(detector.pattern, (match) => {
+                if (detector.valid && !detector.valid(match))
+                    return match;
+                options.onDetect?.({ kind, where, strategy });
+                if (strategy === 'block')
+                    blocked = true;
+                return replace(match, kind, strategy);
+            });
+            if (blocked)
+                return { blocked: kind };
+        }
+        return { text: current };
+    };
+    const cleanMessage = (message, where) => {
+        if (typeof message.content === 'string') {
+            const result = clean(message.content, where);
+            if ('blocked' in result)
+                throw new PiiBlockedError(result.blocked, where);
+            return result.text === message.content ? message : { ...message, content: result.text };
+        }
+        let changed = false;
+        const content = message.content.map((part) => {
+            if (part.type !== 'text')
+                return part;
+            const result = clean(part.text, where);
+            if ('blocked' in result)
+                throw new PiiBlockedError(result.blocked, where);
+            if (result.text === part.text)
+                return part;
+            changed = true;
+            return { ...part, text: result.text };
+        });
+        return changed ? { ...message, content } : message;
+    };
+    return {
+        name: 'pii',
+        beforeModel({ request }) {
+            if (!apply.input)
+                return;
+            return {
+                ...request,
+                messages: request.messages.map((message) => message.role === 'system' ? message : cleanMessage(message, 'input')),
+            };
+        },
+        afterModel({ response }) {
+            if (!apply.output || !response.content)
+                return;
+            const result = clean(response.content, 'output');
+            if ('blocked' in result)
+                throw new PiiBlockedError(result.blocked, 'output');
+            return result.text === response.content ? undefined : { ...response, content: result.text };
+        },
+        async wrapToolCall(_call, next) {
+            const result = await next();
+            if (!apply.toolResults || !result.ok)
+                return result;
+            let blocked;
+            const walk = (value) => {
+                if (blocked)
+                    return value;
+                if (typeof value === 'string') {
+                    const cleaned = clean(value, 'tool');
+                    if ('blocked' in cleaned) {
+                        blocked = cleaned.blocked;
+                        return value;
+                    }
+                    return cleaned.text;
+                }
+                if (Array.isArray(value))
+                    return value.map(walk);
+                if (isToolOutput(value)) {
+                    const content = value.content.map((part) => part.type === 'text' ? { ...part, text: walk(part.text) } : part);
+                    return { ...value, content };
+                }
+                if (value && typeof value === 'object' && Object.getPrototypeOf(value) === Object.prototype) {
+                    return Object.fromEntries(Object.entries(value).map(([key, entry]) => [key, walk(entry)]));
+                }
+                return value;
+            };
+            const cleaned = walk(result.result);
+            if (blocked)
+                return { ok: false, error: `The tool's result was withheld: it contains ${blocked}` };
+            return { ...result, result: cleaned };
+        },
+    };
+}
+function replace(match, kind, strategy) {
+    if (strategy === 'mask') {
+        const visible = match.replace(/[^A-Za-z0-9]/g, '').slice(-4);
+        return `${'*'.repeat(Math.max(4, match.length - visible.length))}${visible}`;
+    }
+    if (strategy === 'hash')
+        return `[${kind}:${(0, shared_js_1.shortHash)(match)}]`;
+    return `[${kind}]`;
+}
+function isToolOutput(value) {
+    return value?.type === 'tool_output' && Array.isArray(value.content);
+}

package/dist-cjs/agent/middleware/retry.d.ts

@@ -0,0 +1,66 @@
+import type { NexusResponse } from '../../types/response.js';
+import type { AgentMiddleware, AgentToolCall, AgentToolResult } from '../create-agent.js';
+import { type RetryBackoff } from './shared.js';
+/** One retry about to happen. */
+export interface RetryEvent {
+    /** The attempt that failed, from 1. */
+    attempt: number;
+    /** How long until the next attempt, in milliseconds. */
+    delayMs: number;
+    /** The error a model call threw, when it threw. */
+    error?: unknown;
+    /** The failed tool call's result, for a tool retry. */
+    result?: AgentToolResult;
+    /** The tool's name, for a tool retry. */
+    tool?: string;
+}
+/** Options for `modelRetry()`. */
+export interface ModelRetryOptions {
+    /** Attempts in all, the first included. Defaults to 3. */
+    attempts?: number;
+    /** How long to wait between attempts. */
+    backoff?: RetryBackoff;
+    /**
+     * Whether an error is worth another attempt. Defaults to every error not marked
+     * `retryable: false`, such as a provider's authentication error, and never a cancellation.
+     */
+    retryOn?: (error: unknown, attempt: number) => boolean;
+    /** Whether a response that did arrive is tried again, such as an empty one. Defaults to never. */
+    retryResponse?: (response: NexusResponse, attempt: number) => boolean;
+    /** Called before each new attempt, for logs and metrics. */
+    onRetry?: (event: RetryEvent) => void;
+}
+/**
+ * Tries a failed model call again, with exponential backoff.
+ *
+ * The client already retries one provider request; this retries the agent's step as a whole, after
+ * the client gave up, and can retry a response that arrived but is unusable. A streamed call that
+ * fails halfway streams again from the start. Waits stop when the run is cancelled.
+ */
+export declare function modelRetry(options?: ModelRetryOptions): AgentMiddleware;
+/** Options for `toolRetry()`. */
+export interface ToolRetryOptions {
+    /** Attempts in all, the first included. Defaults to 3. */
+    attempts?: number;
+    /** How long to wait between attempts. */
+    backoff?: RetryBackoff;
+    /**
+     * Which calls may run again: tool names, `'all'`, or a function of the call. Defaults to calls
+     * that are safe to repeat, whose tool declares capabilities and none of them writes, runs a
+     * command or code, reaches the network, or is the application's own. A call that may already have
+     * changed something is retried only when you say so.
+     */
+    tools?: readonly string[] | 'all' | ((call: AgentToolCall) => boolean);
+    /** Whether a result is a failure worth another attempt. Defaults to any result with `ok: false`. */
+    retryOn?: (result: AgentToolResult, call: AgentToolCall, attempt: number) => boolean;
+    /** Called before each new attempt, for logs and metrics. */
+    onRetry?: (event: RetryEvent) => void;
+}
+/**
+ * Runs a failed tool call again, with exponential backoff.
+ *
+ * By default only a call that cannot have changed anything is repeated: retrying a payment or a
+ * write that timed out after it landed would do it twice. Name the tools that are idempotent to
+ * retry those too.
+ */
+export declare function toolRetry(options?: ToolRetryOptions): AgentMiddleware;