// Props
import { DriftDetector } from "smithers-orchestrator";
type DriftDetectorProps = {
id?: string; // default "drift"; ids {id}-capture, {id}-compare
captureAgent: AgentLike;
compareAgent: AgentLike;
captureOutput: OutputTarget;
compareOutput: OutputTarget; // include `drifted: boolean`
baseline: unknown;
alertIf?: (comparison: any) => boolean; // default: comparison.drifted === true
alert?: ReactElement;
poll?: { intervalMs?: number; maxPolls?: number }; // default maxPolls = 100; intervalMs is reserved, not yet passed to the Loop
skipIf?: boolean;
};
<Workflow name="api-drift-check">
<DriftDetector
captureAgent={snapshotAgent}
compareAgent={diffAgent}
captureOutput={outputs.capture}
compareOutput={outputs.compare}
baseline={{ endpoints: ["/users", "/orders"], schemaHash: "abc123" }}
alert={
<Task id="notify" output={outputs.notify} agent={slackAgent}>
API drift detected. Notify the team.
</Task>
}
/>
</Workflow>
Notes
- Without
poll, the component runs once; withpoll, it wraps in a Loop. - When comparison output exists,
alertIfdecides whether to renderalert; withoutalertIf,comparison.drifted === trueis the trigger. - Without
alert, the component compares but takes no action on drift.
Source
The<DriftDetector> implementation and the files it imports, straight from the package source. This section is generated; edit the source, not this block.
import React from "react";
import { SmithersContext } from "@smithers-orchestrator/react-reconciler/context";
import { Task } from "./Task.js";
import { Sequence } from "./Sequence.js";
import { Branch } from "./Branch.js";
import { Loop } from "./Ralph.js";
/** @typedef {import("./DriftDetectorProps.ts").DriftDetectorProps} DriftDetectorProps */
/**
* @param {unknown} value
* @returns {value is Record<string, unknown>}
*/
function isRecord(value) {
return Boolean(value) && typeof value === "object" && !Array.isArray(value);
}
/**
* @param {unknown} comparison
* @param {((comparison: unknown) => boolean) | undefined} alertIf
* @returns {boolean}
*/
function shouldAlert(comparison, alertIf) {
if (comparison == null) {
return false;
}
if (alertIf) {
return Boolean(alertIf(comparison));
}
return isRecord(comparison) && comparison.drifted === true;
}
/**
* @param {DriftDetectorProps} props
*/
export function DriftDetector(props) {
if (props.skipIf)
return null;
const prefix = props.id ?? "drift";
const ctx = React.useContext(SmithersContext);
const comparison = ctx?.outputMaybe(props.compareOutput, { nodeId: `${prefix}-compare` });
const drifted = shouldAlert(comparison, props.alertIf);
const captureTask = React.createElement(Task, {
id: `${prefix}-capture`,
output: props.captureOutput,
agent: props.captureAgent,
children: `Capture the current state for drift detection. Baseline reference: ${typeof props.baseline === "string"
? props.baseline
: JSON.stringify(props.baseline)}`,
});
const compareTask = React.createElement(Task, {
id: `${prefix}-compare`,
output: props.compareOutput,
agent: props.compareAgent,
dependsOn: [`${prefix}-capture`],
children: `Compare the captured current state against the baseline and determine if meaningful drift has occurred. Include a "drifted" boolean and "significance" string in your response. Baseline: ${typeof props.baseline === "string"
? props.baseline
: JSON.stringify(props.baseline)}`,
});
const alertBranch = props.alert
? React.createElement(Branch, {
if: drifted,
then: props.alert,
})
: null;
const sequenceChildren = [captureTask, compareTask];
if (alertBranch)
sequenceChildren.push(alertBranch);
const sequence = React.createElement(Sequence, null, ...sequenceChildren);
if (props.poll) {
const maxPolls = props.poll.maxPolls ?? 100;
if (!Number.isFinite(maxPolls)) {
throw new TypeError("DriftDetector poll.maxPolls must be a finite number.");
}
return React.createElement(Loop, {
id: `${prefix}-poll`,
until: false,
maxIterations: maxPolls,
onMaxReached: "return-last",
}, sequence);
}
return sequence;
}
// @smithers-type-exports-begin
/** @typedef {import("./OutputSnapshot.ts").OutputSnapshot} OutputSnapshot */
/** @typedef {import("./SmithersCtxOptions.ts").SmithersCtxOptions} SmithersCtxOptions */
// @smithers-type-exports-end
import React from "react";
import { SmithersCtx } from "@smithers-orchestrator/driver/SmithersCtx";
import { SmithersError } from "@smithers-orchestrator/errors/SmithersError";
export { SmithersCtx } from "@smithers-orchestrator/driver/SmithersCtx";
/** @type {React.Context<SmithersCtx<any> | null>} */
export const SmithersContext = React.createContext(null);
SmithersContext.displayName = "SmithersContext";
/**
* @template Schema
* @returns {{ SmithersContext: React.Context<SmithersCtx<Schema> | null>, useCtx: () => SmithersCtx<Schema> }}
*/
export function createSmithersContext() {
/** @type {React.Context<SmithersCtx<Schema> | null>} */
const Context = React.createContext(null);
Context.displayName = "SmithersContext";
/**
* @returns {SmithersCtx<Schema>}
*/
function useCtx() {
const ctx = React.useContext(Context);
if (!ctx) {
throw new SmithersError("CONTEXT_OUTSIDE_WORKFLOW", "useCtx() must be called inside a <Workflow> created by createSmithers()");
}
return ctx;
}
return { SmithersContext: Context, useCtx };
}
// @smithers-type-exports-begin
/**
* @template D
* @typedef {import("./InferDeps.ts").InferDeps<D>} InferDeps
*/
/** @typedef {import("./OutputTarget.ts").OutputTarget} OutputTarget */
// @smithers-type-exports-end
import React from "react";
import { renderToStaticMarkup } from "react-dom/server";
import { markdownComponents } from "../markdownComponents.js";
import { zodSchemaToJsonExample } from "../zod-to-example.js";
import { SmithersError } from "@smithers-orchestrator/errors/SmithersError";
import { SmithersContext } from "@smithers-orchestrator/react-reconciler/context";
import { AspectContext } from "../aspects/AspectContext.js";
import { AntigravityAgent } from "@smithers-orchestrator/agents/AntigravityAgent";
import { ClaudeCodeAgent } from "@smithers-orchestrator/agents/ClaudeCodeAgent";
import { GeminiAgent } from "@smithers-orchestrator/agents/GeminiAgent";
import { PiAgent } from "@smithers-orchestrator/agents/PiAgent";
/** @typedef {import("@smithers-orchestrator/agents/AgentLike").AgentLike} AgentLike */
/** @typedef {import("./DepsSpec.ts").DepsSpec} DepsSpec */
/**
* @template Row, Output, D
* @typedef {import("./TaskProps.ts").TaskProps<Row, Output, D>} TaskProps
*/
/**
* Reverse the HTML-entity escaping that renderToStaticMarkup applies to text
* (& < > " '). Without this, a prompt like `a < b && c` reaches the agent as
* `a < b && c`, and injected JSON schema hints (`"key"`) arrive as
* `"key"`, both of which corrupt the agent-facing text.
* `&` is decoded last so an escaped literal (`&lt;`, meaning the source
* text `<`) is not double-decoded into `<`.
* @param {string} html
* @returns {string}
*/
function decodeHtmlEntities(html) {
return html
.replace(/</g, "<")
.replace(/>/g, ">")
.replace(/"/g, '"')
.replace(/'/g, "'")
.replace(/'/g, "'")
.replace(/&/g, "&");
}
/**
* Render a prompt React node to plain markdown text.
*
* If the prompt is a React element (e.g. a compiled MDX component), we inject
* `markdownComponents` via the standard MDX `components` prop so that
* renderToStaticMarkup outputs clean markdown instead of HTML. The static
* render entity-escapes all text, so we decode the entities back to literal
* characters before handing the prompt to the agent.
* @param {unknown} prompt
* @returns {string}
*/
export function renderPromptToText(prompt) {
if (prompt == null)
return "";
if (typeof prompt === "string")
return prompt;
if (typeof prompt === "number")
return String(prompt);
try {
let element;
if (React.isValidElement(prompt)) {
// Inject markdown components into the element so MDX components
// render fragments instead of HTML tags.
element = React.cloneElement(prompt, {
components: markdownComponents,
});
}
else {
element = React.createElement(React.Fragment, null, prompt);
}
return decodeHtmlEntities(renderToStaticMarkup(element))
.replace(/\n{3,}/g, "\n\n")
.trim();
}
catch (err) {
const result = String(prompt ?? "");
if (result === "[object Object]") {
throw new SmithersError("MDX_PRELOAD_INACTIVE", `MDX prompt could not be rendered — the prompt resolved to [object Object] instead of a React component.\n\n` +
`This usually means the MDX preload is not active. Common causes:\n` +
` • bunfig.toml uses [run] preload instead of top-level preload (the [run] section doesn't apply to dynamic imports)\n` +
` • bunfig.toml is not in the current working directory\n` +
` • mdxPlugin() is not registered in the preload script\n` +
` • The MDX file is imported without a default import (use: import MyPrompt from "./prompt.mdx")\n\n` +
`Original error: ${err instanceof Error ? err.message : String(err)}`);
}
return result;
}
}
/**
* @param {unknown} value
* @returns {value is import("zod").ZodObject<import("zod").ZodRawShape>}
*/
function isZodObject(value) {
return Boolean(value && typeof value === "object" && "shape" in value);
}
/**
* @param {DepsSpec | undefined} deps
* @param {Record<string, string> | undefined} needs
* @returns {string[] | undefined}
*/
function deriveDepNodeIds(deps, needs) {
if (!deps)
return undefined;
const ids = new Set();
for (const key of Object.keys(deps)) {
const nodeId = needs?.[key] ?? key;
if (nodeId)
ids.add(nodeId);
}
return ids.size > 0 ? [...ids] : undefined;
}
/**
* @param {string[] | undefined} dependsOn
* @param {string[] | undefined} depNodeIds
* @returns {string[] | undefined}
*/
function mergeDependsOn(dependsOn, depNodeIds) {
const merged = new Set();
for (const id of dependsOn ?? [])
merged.add(id);
for (const id of depNodeIds ?? [])
merged.add(id);
return merged.size > 0 ? [...merged] : undefined;
}
/**
* @param {any} ctx
* @param {DepsSpec | undefined} deps
* @param {Record<string, string> | undefined} needs
* @param {boolean | undefined} depsOptional
* @returns {Record<string, unknown> | null}
*/
function resolveDeps(ctx, deps, needs, depsOptional) {
if (!deps)
return Object.create(null);
const keys = Object.keys(deps);
if (keys.length === 0)
return Object.create(null);
const resolved = Object.create(null);
for (const key of keys) {
const target = deps[key];
const nodeId = needs?.[key] ?? key;
const value = ctx.outputMaybe(target, { nodeId });
if (value === undefined) {
// Optional deps mode: omit unresolved keys instead of deferring the
// whole task. Used when the task is already gated by `needs`/`dependsOn`
// and upstream tasks may legitimately fail (continueOnFail) without
// producing an output row.
if (depsOptional)
continue;
return null;
}
resolved[key] = value;
}
return resolved;
}
/**
* @param {AgentLike} agent
* @param {string[] | undefined} allowTools
* @returns {AgentLike}
*/
function applyCliToolAllowlist(agent, allowTools) {
if (!allowTools) {
return agent;
}
if (agent instanceof ClaudeCodeAgent) {
const opts = { ...agent.opts };
if (allowTools.length === 0) {
return new ClaudeCodeAgent({
...opts,
allowedTools: [],
tools: "",
});
}
return new ClaudeCodeAgent({
...opts,
allowedTools: [...allowTools],
});
}
if (agent instanceof PiAgent) {
const opts = { ...agent.opts };
if (allowTools.length === 0) {
return new PiAgent({
...opts,
tools: [],
noTools: true,
});
}
return new PiAgent({
...opts,
tools: [...allowTools],
noTools: false,
});
}
if (agent instanceof GeminiAgent) {
const opts = { ...agent.opts };
return new GeminiAgent({
...opts,
allowedTools: [...allowTools],
});
}
if (agent instanceof AntigravityAgent) {
const opts = { ...agent.opts };
return new AntigravityAgent({
...opts,
allowedTools: [...allowTools],
});
}
return agent;
}
/**
* @param {unknown} ctx
* @param {string[] | undefined} allowTools
* @returns {string[] | undefined}
*/
function resolveCliToolAllowlist(ctx, allowTools) {
if (allowTools !== undefined) {
return allowTools;
}
const cliAgentToolsDefault = ctx && typeof ctx === "object"
? ctx.__smithersRuntime?.cliAgentToolsDefault
: undefined;
return cliAgentToolsDefault === "explicit-only" ? [] : undefined;
}
/**
* @template Row, Output, D
* @param {TaskProps<Row, Output, D>} props
* @returns {React.ReactElement | null}
*/
export function Task(props) {
const { children, agent, fallbackAgent, deps, depsOptional, ...rest } = props;
const taskContext = props.smithersContext ?? SmithersContext;
const ctx = React.useContext(taskContext);
const aspectCtx = React.useContext(AspectContext);
const depNodeIds = deriveDepNodeIds(deps, rest.needs);
if (deps && !ctx) {
throw new SmithersError("CONTEXT_OUTSIDE_WORKFLOW", "Task deps require a workflow context. Build the workflow with createSmithers().");
}
const resolvedDeps = deps ? resolveDeps(ctx, deps, rest.needs, depsOptional) : undefined;
if (deps && resolvedDeps == null) {
// Deps not yet available — component defers until upstream tasks complete.
// This is normal reactive behavior; the task will re-render once deps are
// ready. Record the deferral so the engine can distinguish a transient wait
// from a permanent one: a deferral that survives to quiescence means a
// dependency that can never resolve (e.g. a deps key that maps to a node id
// no task produces), which would otherwise be a silent skip.
ctx?.recordDeferredDep?.(props.id, depNodeIds ?? []);
return null;
}
// Build aspect metadata to attach to the task element so the engine can
// enforce budgets and track metrics at execution time.
const aspectMeta = aspectCtx ? buildAspectMeta(aspectCtx) : undefined;
const agentChain = Array.isArray(agent)
? fallbackAgent
? [...agent, fallbackAgent]
: agent
: agent && fallbackAgent
? [agent, fallbackAgent]
: agent;
const effectiveAllowTools = resolveCliToolAllowlist(ctx, rest.allowTools);
const restrictedAgentChain = Array.isArray(agentChain)
? agentChain.map((entry) => applyCliToolAllowlist(entry, effectiveAllowTools))
: agentChain
? applyCliToolAllowlist(agentChain, effectiveAllowTools)
: agentChain;
const nextDependsOn = mergeDependsOn(rest.dependsOn, depNodeIds);
const childValue = typeof children === "function" && (agent || deps)
? children(resolvedDeps ?? Object.create(null))
: children;
if (agent) {
// Auto-inject `schema` prop into React element children when output is a ZodObject
let childElement = childValue;
const schemaForInjection = props.outputSchema ??
(isZodObject(props.output) ? props.output : undefined);
if (React.isValidElement(childValue) && schemaForInjection) {
childElement = React.cloneElement(childValue, {
schema: zodSchemaToJsonExample(schemaForInjection),
});
}
const prompt = renderPromptToText(childElement);
return React.createElement("smithers:task", {
...rest,
dependsOn: nextDependsOn,
waitAsync: rest.async === true,
agent: restrictedAgentChain,
__smithersKind: "agent",
...aspectMeta,
}, prompt);
}
if (typeof children === "function" && !deps) {
const nextProps = {
...rest,
dependsOn: nextDependsOn,
waitAsync: rest.async === true,
__smithersKind: "compute",
__smithersComputeFn: children,
...aspectMeta,
};
return React.createElement("smithers:task", nextProps, null);
}
const nextProps = {
...rest,
dependsOn: nextDependsOn,
waitAsync: rest.async === true,
__smithersKind: "static",
__smithersPayload: childValue,
__payload: childValue,
...aspectMeta,
};
return React.createElement("smithers:task", nextProps, null);
}
/**
* Build the __aspects metadata object from the current AspectContext.
* This is attached to the smithers:task element props so the engine can read
* budgets and tracking config at execution time.
* @param {{
* tokenBudget?: unknown;
* latencySlo?: unknown;
* tracking?: unknown;
* accumulator?: unknown;
* }} aspectCtx
* @returns {{ __aspects: Record<string, unknown> }}
*/
function buildAspectMeta(aspectCtx) {
return {
__aspects: {
tokenBudget: aspectCtx.tokenBudget,
latencySlo: aspectCtx.latencySlo,
tracking: aspectCtx.tracking,
accumulator: aspectCtx.accumulator,
},
};
}
import React from "react";
/** @typedef {import("./SequenceProps.ts").SequenceProps} SequenceProps */
/**
* @param {SequenceProps} props
*/
export function Sequence(props) {
if (props.skipIf)
return null;
// Sequence carries only a display label; pass a sanitized bag (align with
// the sanitizing structural components) so control props don't leak through.
// `label` names the phase group in run views (graph, the Claude /workflows
// mirror) and is preserved in the persisted frame XML.
const next = props.label === undefined ? {} : { label: props.label };
return React.createElement("smithers:sequence", next, props.children);
}
import React from "react";
import { SmithersError } from "@smithers-orchestrator/errors/SmithersError";
/** @typedef {import("./BranchProps.ts").BranchProps} BranchProps */
/**
* @param {BranchProps} props
*/
export function Branch(props) {
// <Branch> resolves its subtree from the `then`/`else` props; any JSX children
// would be silently dropped, removing those tasks from the graph with no
// feedback. Fail fast instead. (Checked before skipIf so a stray-children
// mistake still surfaces even on a skipped branch.)
if (props.children !== undefined && props.children !== null) {
throw new SmithersError("INVALID_INPUT", `<Branch> does not take children. Use the "then" and "else" props instead, e.g. ` +
`<Branch if={cond} then={<Task .../>} else={<Task .../>} />. ` +
`Children passed to <Branch> are silently ignored and would drop those tasks from the graph.`);
}
if (props.skipIf)
return null;
const chosen = props.if ? props.then : (props.else ?? null);
// The branch is resolved to `chosen` at render time, so the host element
// carries no props of its own (align with the sanitizing structural components).
return React.createElement("smithers:branch", {}, chosen);
}
// @smithers-type-exports-begin
/** @typedef {import("./RalphProps.ts").RalphProps} RalphProps */
// @smithers-type-exports-end
import React from "react";
/** @typedef {import("./LoopProps.ts").LoopProps} LoopProps */
/**
* @param {LoopProps} props
*/
export function Loop(props) {
if (props.skipIf)
return null;
// Sanitize to the loop's host props (align with other structural components);
// key/skipIf are React/control props and children are passed separately.
const next = {
id: props.id,
until: props.until,
maxIterations: props.maxIterations,
onMaxReached: props.onMaxReached,
continueAsNewEvery: props.continueAsNewEvery,
};
return React.createElement("smithers:ralph", next, props.children);
}
/** @deprecated Use `Loop` instead. */
export const Ralph = Loop;
import type React from "react";
import type { AgentLike } from "@smithers-orchestrator/agents/AgentLike";
import type { OutputTarget } from "./OutputTarget.ts";
export type DriftDetectorProps = {
/** ID prefix for generated task/component ids. */
id?: string;
/** Agent that captures the current state snapshot. */
captureAgent: AgentLike;
/** Agent that compares current state against the baseline. */
compareAgent: AgentLike;
/** Output schema for the captured state. */
captureOutput: OutputTarget;
/** Output schema for the comparison result. Should include `drifted: boolean` and `significance: string`. */
compareOutput: OutputTarget;
/** Static baseline data, or a function/agent that fetches it. */
baseline: unknown;
/** Condition function that determines whether to fire the alert. If omitted, uses `comparison.drifted === true`. */
alertIf?: (comparison: unknown) => boolean;
/** Element to render when drift is detected (e.g. a Task that sends a notification). */
alert?: React.ReactElement;
/** If set, wraps the detector in a Loop for periodic polling. */
poll?: {
/** Reserved for future delayed polling; maxPolls currently controls Loop iterations. */
intervalMs?: number;
maxPolls?: number;
};
/** Skip the entire component. */
skipIf?: boolean;
};