http library
Supported application-facing HTTP scenario-driver API.
Classes
- AdapterCompleteness
- AdapterOutput
- AdapterRequest
- CommandResult
- CucumberExpression
- A compiled Cucumber Expression. It deliberately keeps the feature text plain: placeholders are automation glue, not feature metadata.
- Diagnostic
- Ed25519ReleaseSigner
- Deterministic Ed25519 release-record signer. Private key material is supplied by the caller and is never persisted by this package.
- EndpointBaseUrlResolver
-
Resolves a logical endpoint's base URL from declared runner configuration.
A feature never receives a host URL; deployments choose it through a named
environment variable such as
CALCULATOR_TEST_API_URL. - EvidenceEnvelope
- EvidenceRecord
- The one current semantic evidence record.
- EvidenceRequirement
- EvidenceSlot
- EvidenceTypeDefinition
- EvidenceWriter
- ExecutionResult
- ExecutionResultWriter
- ExecutionSourceIdentity
-
FlutterDriverFactory<
W extends ScenarioWorld> -
Flutter projects implement this in a project-owned
testWidgetsentrypoint so the runner never creates a second Flutter test world. - FrameworkAdapter
- GherkinElement
- A parsed feature, rule, or scenario element.
- GherkinExamples
- An Examples table attached to a scenario outline.
- GherkinParser
- Parses Zuke's metadata-aware Gherkin dialect.
- GherkinParseResult
- Result of parsing one feature document.
- GherkinScenario
- A parsed executable Gherkin scenario.
- GherkinStep
- One executable step in a Gherkin scenario.
- GherkinTag
- A tag attached to a Gherkin element.
- HttpAssertions
- A bounded, deterministic request assertion surface used by generated HTTP steps. It intentionally accepts logical endpoint IDs only.
-
HttpDriverFactory<
W extends ScenarioWorld> - HTTP projects implement this with their logical endpoint registry and fixture lifecycle. The runner only depends on the world contract.
- HttpRequestSpec
- Logical HTTP request data used by a scenario driver.
- HttpResponseSpec
- HTTP response data returned by a scenario driver.
-
HttpScenarioDriver<
W extends ScenarioWorld> - HttpServerFactory
- ImplementsRequirement
- Associates a declaration with one or more governed backend requirements.
- JsonHttpDriver
- Project-owned HTTP driver primitive. Endpoint IDs are resolved through the generated contract map; features never carry environment URLs.
- MapScenarioWorld
- MetadataBlock
- A raw metadata block and its source location.
- MetadataExtractorResult
- Metadata collected from a workspace's specification files.
- PackageIdentity
- ParsedBinding
- Metadata describing a generated UI binding.
- ParsedControlRef
- A control reference required by a specification.
- ParsedEndpoint
- Metadata describing a logical endpoint.
- ParsedFeature
- A complete parsed Gherkin feature.
- ParsedMetadata
-
Metadata extracted from a
# spec-beginblock. - ParsedPerformance
- A performance threshold declared by a specification.
- ParsedRule
- A parsed Gherkin rule and its scenarios.
- ParseError
- A parser error with its source location.
- PresentsRequirement
- Associates a declaration with one or more requirements presented in a UI.
- ProvidesControl
- Declares a runtime provider for one or more governed controls.
- ResolvedScenarioContract
- The parsed Gherkin nodes matched by a generated scenario contract.
- RuleId
- A canonical governed requirement identifier.
- RunnerExecutionContext
- Identity and output coordinates exported to a managed test process.
- ScenarioExampleCase
- One executable instance of a Gherkin scenario.
-
ScenarioExecutor<
W extends ScenarioWorld> - ScenarioId
- A stable governed scenario identifier.
- ScenarioResult
- ScenarioWorld
- Sha256Digest
- Canonical SHA-256 digest used by current evidence and ledger contracts.
- SignedAttestationVerifier
- Verifies a separately signed external-control attestation.
- SourceIdentity
- SourceLocation
- Source coordinates for a parsed element.
- StepDataTable
- A Gherkin step data table.
-
StepDefinition<
W extends ScenarioWorld> - StepDocString
- A Gherkin step doc string.
-
StepMatch<
W extends ScenarioWorld> -
StepParameterType<
T> - A typed transformation used by generated Gherkin step support.
- StepParameterTypeRegistry
- Registry for Cucumber-style parameter transformations.
-
StepRegistry<
W extends ScenarioWorld> - StepResult
- SuiteEvidenceEmitter
- Emits deterministic passed suite evidence for non-Gherkin test bodies.
- SuiteResult
- Raw result produced by an ordinary test adapter. It is deliberately not an EvidenceRecord: only the CLI may bind a result to current workspace digests and publish semantic evidence.
-
TargetDriverFactory<
W extends ScenarioWorld> - TargetIdentity
- Stable target/package identity used by current extraction and evidence.
- TopologyNode
- TrustBundle
- TrustedReleaseVerifier
- TrustKey
- VerifiesRequirement
- Associates a test declaration with requirement and evidence identifiers.
- WorkspaceDiscovery
- Discovers and parses a Zuke workspace from disk.
- WorkspaceDiscoveryResult
- Parsed workspace data and the inputs used to produce it.
- WorkspacePackage
- WorkspaceRunner
- WorkspaceTarget
- ZukeBinding
- Associates a UI declaration with a generated Zuke binding identifier.
- ZukeBindingDescriptor
- Generated binding metadata consumed by target-specific runners.
- ZukeConfig
-
Workspace configuration loaded from
zuke.yaml. - ZukeEvent
- Immutable runtime event emitted by a scenario.
- ZukeEventBus
- In-memory event bus for one test execution.
- ZukeFeatureFlags
- Mutable feature-flag view used by a scenario runtime.
- ZukeFeatureLoader
- Resolves a feature from a Zuke workspace without project-specific current-working-directory fallbacks in every test entrypoint.
- ZukeScenarioContract
- A generated, stable reference to one governed Gherkin scenario.
- ZukeScenarioPattern
- Matches generated scenario contracts without repeating raw IDs.
Enums
- BindingInstanceCardinality
- Runtime multiplicity of widgets represented by one logical UI binding.
- CommandStatus
- CompletenessStatus
- ControlProviderKind
- Roles that a control provider can play in an application topology.
- DiagnosticOwner
- DiagnosticSeverity
- EnforcementLayer
- Application layer at which a control is enforced.
- EvidenceMode
- EvidenceStatus
- GherkinKeyword
- Gherkin element kinds recognized by the parser.
- ScenarioStatus
- StepStatus
- StepTier
- Resolution order is semantic, not an accidental priority convention. Project steps can refine vendor vocabulary, but cannot shadow generated feature steps; ambiguity remains an error within the selected tier.
- SuiteStatus
Extension Types
- ControlId
- A canonical governed control identifier.
Constants
- attestationSigningDomain → const String
- releaseSigningDomain → const String
- Immutable signing domains. A domain change is a breaking artifact change and must be called out in migration documentation and changelogs.
Functions
-
attestationSigningPayload(
Map< String, Object?> unsigned) → List<int> -
buildStepRegistry<
W extends ScenarioWorld> (Iterable< StepDefinition< definitions) → StepRegistry<W> >W> - Builds a registry from an expression-friendly iterable of definitions.
-
canonicalBindingCardinality(
String cardinality) → String - Canonicalizes accepted binding-cardinality spellings.
-
canonicalBindingInstanceCardinality(
String cardinality) → String - Canonicalizes accepted runtime-widget cardinality spellings.
-
canonicalJson(
Object? value) → String - Deterministic JSON encoding used for hashes, signatures, and lock files.
-
httpVendorSteps<
W extends ScenarioWorld> ({required HttpResponseSpec? latestResponse(W world), bool matchesSchema(Object? body, String schemaId)?}) → List< StepDefinition< W> > - Reusable HTTP vocabulary. Projects supply the response produced by their preceding logical-endpoint step; vendor steps never embed an environment URL or make a second request.
-
matchScenarioContracts<
T extends ZukeScenarioContract> (Iterable< T> contracts, ZukeScenarioPattern pattern) → List<T> -
Selects
contractsin declaration order, requiring at least one match. -
releaseSigningPayload(
Map< String, Object?> unsigned) → List<int> -
resolveScenarioContract(
ParsedFeature feature, ZukeScenarioContract contract) → ResolvedScenarioContract -
Resolves
contractagainstfeatureand rejects any generated-contract drift before a scenario can emit evidence. -
resolveScenarioContracts<
T extends ZukeScenarioContract> (ParsedFeature feature, Iterable< T> contracts, ZukeScenarioPattern pattern) → List<ResolvedScenarioContract> - Matches and resolves generated contracts before a harness registers tests.
-
scenarioExampleCaseAt(
GherkinScenario scenario, {required int examplesIndex, required int rowIndex}) → ScenarioExampleCase - Resolves one executable case and validates its indexes.
-
scenarioExampleCases(
GherkinScenario scenario) → Iterable< ScenarioExampleCase> -
Enumerates every executable case for
scenarioin source order. -
scenarioFilterFromEnvironment(
Map< String, String> environment) → Set<String> - Parses the runner's stable scenario-ID allow-list.
-
shouldRunScenario(
String scenarioId, Set< String> selectedScenarioIds) → bool -
Returns whether
scenarioIdis selected, treating an empty filter as all.
Typedefs
-
StepAction<
W extends ScenarioWorld> = FutureOr< void> Function(W world, GherkinStep step, Map<String, String> arguments) -
TransformedStepAction<
W extends ScenarioWorld> = FutureOr< void> Function(W world, GherkinStep step, List<Object?> values) - Callback used by generated Cucumber Expression support. Values have already passed through their registered parameter transformers.
Exceptions / Errors
- AmbiguousStepException
- InvalidWorkspaceConfigError
- Raised when a current-looking workspace configuration is malformed.
- LegacyWorkspaceConfigError
- Raised when a workspace uses a configuration schema from an older Zuke release. The CLI maps this to its migration diagnostic.
- UnresolvedStepException
- WorkspaceConfigError
- Base error raised when a workspace configuration cannot be used by the current frontend parser.