TypeScript SDK

Nika is one application seam around the engine. Your product owns the request, interface and business state. Nika owns parsing, admission, execution, policy, events, receipts and traces. The first integration is two calls — admit and settle:

import { Nika, isNikaRunSucceeded } from '@supernovae-st/nika'

const nika = new Nika({ cwd: process.cwd() })

const run = await nika.run('hello.nika', { maxCostUsd: 0 })
const result = await run.result()

if (!isNikaRunSucceeded(result)) {
  // 'failed' carries the engine's error; 'paused' waits on a human gate
  throw new Error(`run ended as ${result.status}`)
}
console.log(result.outputs)

run() admits the workflow before it returns: an invalid file throws a typed NikaOperationError and no handle is ever handed out. result() is the sole settlement — an admitted workflow that fails resolves as status: 'failed' data, not a throw.

const local = new Nika({ cwd: process.cwd() })
const remote = new Nika({
  url: 'https://nika.example.com',
  token: process.env.NIKA_TOKEN!,
})

Omit url for the native-process transport. Supply url and token for the HTTP transport. A contained served name such as flows/release.nika goes directly to the resident without a local binary or source. An explicit local path such as ./flows/release.nika uses a compatible local engine to capture immutable bytes before HTTP admission.

One lifecycle vocabulary

Intent	Method	Authority
Audit	`check(workflow, options?)`	Engine
Admit + execute	`await run(workflow, options?)`	Engine or server
Observe	`run.events(options?)`	Run session
Settle	`await run.result()`	Run session
Cancel	`run.cancel()`	Run session
Verify proof	`traceVerify(receipt, options?)`	Engine
Recover a durable job	`attachRun(id, options?)`	HTTP only
Read live status	`run.status()`	HTTP only
Discover workflows	`listWorkflows()` · `workflow(name)`	HTTP only
Manage one schedule	`schedule()` · `scheduleStatus()`	HTTP only

run() returns a handle only after admission; the handle is not a terminal result. Events are additive and optional to render; run.result() is the only terminal truth for that observation leg, including a pause. A paused durable job may later resume under engine authority. Configuration, compatibility, transport and protocol failures throw typed SDK errors.

Compatibility aliases from earlier releases

nika.events(run), nika.cancel(run), run.done and the facade-level wrappers remain as compatibility aliases. run.done is the same promise as run.result(). New code should call the methods on the run handle: run.events(), run.result(), run.cancel(), run.status().

Documentation graph

Authority boundary

The SDK does not parse a second Nika language.
It does not reconstruct traces or receipts in TypeScript.
An observer AbortSignal does not cancel a run; call run.cancel().
It does not infer success from an event kind.
It exposes only the pinned engine’s supported routes.

Source and channel contract

Which published source these pages describe

Review the published source

Inspect the source corresponding to the published SDK and native payloads.

Overview

Start

Project

Local API

Runtime

Remote API

Operations

Reference

TypeScript SDK

One lifecycle vocabulary

Documentation graph

Authority boundary

Source and channel contract

Review the published source

​One lifecycle vocabulary

​Documentation graph

​Authority boundary

​Source and channel contract

Review the published source

One lifecycle vocabulary

Documentation graph

Authority boundary

Source and channel contract