# models

Type definitions and immutable builders for version flows and their steps.

[`VersionFlow`](https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models/#api-VersionFlow) is the top-level shape carrying steps, configuration, and metadata; [`FlowStep`](https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models/#api-FlowStep) is the per-step shape carrying an ID, a condition, and an executor. [`createFlow`](https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models/#api-createFlow), [`addStep`](https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models/#api-addStep), [`removeStep`](https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models/#api-removeStep), [`insertStep`](https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models/#api-insertStep), [`insertStepAfter`](https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models/#api-insertStepAfter), and [`insertStepBefore`](https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models/#api-insertStepBefore) are the immutable builders: every operation returns a new [`VersionFlow`](https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models/#api-VersionFlow) rather than mutating in place. [`FlowConfig`](https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models/#api-FlowConfig), [`FlowContext`](https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models/#api-FlowContext), [`FlowResult`](https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models/#api-FlowResult), [`FlowState`](https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models/#api-FlowState), [`FlowStatus`](https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models/#api-FlowStatus), [`FlowStepResult`](https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models/#api-FlowStepResult), and [`FlowStepResultWithId`](https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models/#api-FlowStepResultWithId) describe the runtime surface that the executor threads through each step.

---

Canonical page: https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models/
This file: https://www.hyperfrontend.dev/docs/libraries/versioning/flow/models.md
Documentation index: https://www.hyperfrontend.dev/llms.txt