FlowStep interface exported
Last updated: 2026-03-05T10:53:28.859Z
Location
Metrics
LOC: 64
Complexity: 1
Params: 0
Signature
interface FlowStep
Summary
A single step in a FlowScript
Source Code
export interface FlowStep {
/** Step identifier — unique within the flow */
id: string;
/** Action to perform */
action: FlowActionType;
// ── Target element ────────────────────────────────────────────────────
/** CSS selector for the target element (required for most actions) */
selector?: string;
/** Smart selectors ordered by priority (first = best) */
smartSelectors?: SmartSelector[];
/** Preferred selector strategy to try first */
selectorStrategy?: SelectorStrategy;
// ── Value / source ────────────────────────────────────────────────────
/** How the fill value is determined — generator or fixed */
valueSource?: FlowValueSource;
// ── Navigate / URL ────────────────────────────────────────────────────
/** Target URL for `navigate` steps */
url?: string;
// ── Select ────────────────────────────────────────────────────────────
/** Index of the option to select (0-based) */
selectIndex?: number;
/** Text content of the option to select */
selectText?: string;
// ── Key press ─────────────────────────────────────────────────────────
/** Key identifier for `press-key` (e.g. "Enter", "Tab") */
key?: string;
// ── Wait ──────────────────────────────────────────────────────────────
/** Timeout in ms for `wait` steps (default: 10_000) */
waitTimeout?: number;
// ── Scroll ────────────────────────────────────────────────────────────
/** Scroll coordinates for `scroll` steps */
scrollPosition?: { x: number; y: number };
// ── Assert ────────────────────────────────────────────────────────────
/** Assertion config for `assert` steps */
assertion?: FlowAssertion;
// ── Timing ────────────────────────────────────────────────────────────
/** Delay before executing this step (ms) — recorded from original timing */
delayBefore?: number;
/** Delay after executing this step (ms) */
delayAfter?: number;
// ── Caption ───────────────────────────────────────────────────────────
/** Caption configuration for `caption` steps */
caption?: CaptionConfig;
// ── Effects ───────────────────────────────────────────────────────────
/** Visual effects applied to the target element during this step */
effects?: StepEffect[];
// ── Metadata ──────────────────────────────────────────────────────────
/** Human-readable label for display */
label?: string;
/** Whether this step is optional (skip on failure instead of abort) */
optional?: boolean;
}
No outgoing dependencies.
Impact (Incoming)
| Source | Type |
|---|---|
| parseFlowScript | uses |
| isValidFieldType | uses |
| OrchestratorCallbacks | uses |
| executeStep | uses |
| validFlowStep | uses |
| assertFailed | uses |