reference · type index
Keep the contract visible in code.
Map local reports, plans, outcomes and receipts beside the preview job, event, artifact, workflow and error types.
Types are the client boundary, not the language authority. Versioned engine payloads keep raw escape hatches, and remote unions remain additive.
Reports, plans and outcomes.
The local module exports the stable subset the driver guarantees and retains the full engine object when a newer release adds fields.
LocalCheckReport ├── findings[] · cost · permits · requirements · waves ├── warnings[] └── raw LocalPlan ├── tasks[] · waves[][] · cost · permits · requirements └── raw LocalRunOutcome └── exitCode · ok · events[]
Jobs, events and artifacts.
NikaEvent is a discriminated union. NikaJob owns terminal status, timestamps and the optional exit code. Artifact methods select the byte representation.
JobStatus = pending | running | completed | failed | cancelled NikaEvent = started | task_start | task_complete | task_failed artifact_written | completed | failed | cancelled
Catch from specific to general.
NikaJobCancelledError extends NikaJobError, which extends NikaError. API, connection and timeout errors are siblings under the same base.
NikaError
├── NikaAPIError
├── NikaConnectionError
├── NikaTimeoutError
└── NikaJobError
└── NikaJobCancelledError