Skip to main content
NikaCheckResult deliberately stays open:
A local check returns the engine’s whole report (report_version: 1): the same audit nika check --json prints. The fields an application usually reads, measured on engine 0.123.0: Pass access to judge the access plan under a pin, as nika check --access does:
A pin the engine refuses keeps clean: true (the file holds) with verdicts.access_ready: false, and verdicts.blockers names the refusal in the engine’s words (Access pins). Apart from clean, exitCode and verdicts, the SDK types these fields as unknown: narrow them in your code. Findings are report data; configuration, engine resolution, transport and protocol failures throw typed errors. Keep application policy outside the SDK, and preserve unknown fields when storing or forwarding the report. Permits and admission shows a complete policy check.
The SDK has no separate dry-run-plan method. Do not manufacture a TypeScript plan contract from engine output. Use check() for admission and nika run <file> --dry-run --json (plan_version: 1) when an operator needs the CLI’s plan.
Remote checks intentionally reject the local-only model and nativeStrict overrides rather than silently ignoring them. For a contained served name, the remote result is the resident’s typed acknowledgement or workflow refusal, without local findings or an exit code. An explicit local path instead captures a local engine report and snapshot; successful capture requires the resident to acknowledge that exact snapshot. See remote checks for the two forms.

Run and cancel

Admit only after application policy accepts the check report.

Errors

Separate dirty reports from thrown boundary failures.