camunda/orchestration-cluster-api-js
Last release:
The Camunda 8 Orchestration Cluster TypeScript SDK provides a type safe, promise based JS client for the Camunda 8 Orchestration Cluster REST API. It helps developers call orchestration cluster endpoints with built in auth options, retry behavior, optional schema validation, and helpers for polling and tenantId defaults.
Project status
- Actively maintained, with very recent updates (last upstream push 2026-09-16, latest tagged update v10.0.0-alpha.45 on 2026-09-15) and a continuous stream of changes through September 2026.
- Apparent update cadence is fairly frequent, roughly weekly to every few days in late August and September 2026 (for example, v10.0.0-alpha.45 on 9/15, alpha.44 on 9/10, alpha.43 on 8/28).
AI summary generated
Recent updates
v10.0.0-alpha.46
v10.0.0-alpha.46 updates the SDK to use the renamed job lease token field `jobLeaseToken` instead of `leaseToken`. The code changes propagate through the OpenAPI-generated client, runtime job handling, and worker proxies so that fenced job commands are sent with the new field name.
Breakingv10.0.0-alpha.45
v10.0.0-alpha.45 adds worker support for Zeebe's dependent-presence (x-present-when) around job activation leasing via a new withLease surface. The code introduces leaseToken-dependent typing, threads leaseToken into fenced job commands, and adds a new terminal error (PresentWhenUnsupportedError) that is used to stop futile retries when the server response does not match the requested dependent contract. Additionally, the generated OpenAPI-derived types are updated (for example, ElementId branding and nullable $or fields).
Featuresv10.0.0-alpha.44
v10.0.0-alpha.44 release notes only document a single change, regenerating and updating agentInstance examples. The provided code diff, however, includes many additional repository and workflow changes (new examples, CI hardening, release pipeline changes, and tooling config changes) that are not mentioned in the release notes.
Featuresv9.1.5
v9.1.5 includes a documented runtime bug fix that changes job-worker activation retry behavior on transport errors. The code diff also shows substantial updates to the bundled upstream Zeebe gateway protocol specs (OpenAPI/proto YAML) plus an added example app, none of which are mentioned in the release notes.
Breakingv10.0.0-alpha.43
v10.0.0-alpha.43 introduces a new clock binding feature via `createEngineClock`, intended to synchronize the SDK's poll and retry cadence with the Camunda engine's own clock. The release notes mention this feature, and the code adds new exported APIs and runtime clock interfaces, plus a dedicated test suite for the new behavior.
Featuresv10.0.0-alpha.42
v10.0.0-alpha.42 adds a new `createTestClock` implementation and a repo-wide clock contract conformance test suite. The main functional change is additional clock tooling to make tests deterministic without hand-rolled virtual clocks.
Featuresv10.0.0-alpha.41
Release v10.0.0-alpha.41 introduces a new clock exposure to job handlers: handlers can now access the injected SDK clock via job.clock. The change adds a narrowed HandlerClock (now, sleep only) to the enriched job object and includes related safeguards for worker-thread serialization.
Featuresv10.0.0-alpha.40
v10.0.0-alpha.40 introduces a clock/injection mechanism intended to make runtime scheduling, retries, and polling use an injected clock rather than relying directly on process time. The code changes also adjust how OAuth token retry timeouts and telemetry durations are measured to avoid issues when the injected clock is pinned.
Featuresv10.0.0-alpha.39
v10.0.0-alpha.39 primarily fixes the Effect client so that the Promise-style `.paginate` helpers remain present on Effect `search*` methods and work as streams. The diff also includes additional internal fixes around generated key re-exports and a refactor of worker graceful shutdown behavior.
v10.0.0-alpha.38
v10.0.0-alpha.38 introduces a new injectable Clock abstraction to control the SDK's internal runtime cadence (poll loops, retry backoff, and backpressure decay). The client now accepts an optional clock in CamundaOptions and wires it into the runtime (including BackpressureManager) while exporting clock utilities from the package entrypoint.
Featuresv10.0.0-alpha.37
v10.0.0-alpha.37 is a small alpha release that addresses a worker-side dynamic import issue for handler modules, ensuring handler module references are imported using proper file:// specifiers. The code change introduces a dedicated helper for module specifier conversion, and updates some dev tooling dependencies.
v10.0.0-alpha.36
v10.0.0-alpha.36 is nominally a bug fix release that updates the repository's agent instance examples to use the batched-history API. However, the generated SDK and OpenAPI-derived types indicate larger contract changes around agent instance creation and history handling, plus additions to message subscription filtering/sorting.
v10.0.0-alpha.35
This release notes only call out added example coverage for the cluster rebalance operations (trigger, get, cancel). However, the actual diff shows the SDK/OpenAPI spec was updated with a new REST endpoint (/cluster/v2/rebalance) and corresponding generated client support plus new request/response types.
Featuresv10.0.0-alpha.34
This pre-release adds a new async-generator pagination API by attaching a `.paginate()` method to `search*` operations at runtime. It introduces a shared pagination engine in `src/runtime/pagination.ts` and a binder in `src/runtime/searchPagination.ts` that wires pagination into generated client search methods.
Featuresv10.0.0-alpha.33
Release v10.0.0-alpha.33 regenerates large parts of the SDK from an updated upstream OpenAPI spec. The release notes only mention example coverage and faster unit tests, but the code diff also introduces new cluster-admin runtime backup operations and substantial schema changes for agent instance definitions that can break existing TypeScript code.
BreakingFeaturesv10.0.0-alpha.32
This release primarily introduces an Effect-native job worker API surface (activateJobs loop as a typed Effect workflow) via the `./effect` subpath. It also updates generated SDK artifacts based on a gateway protocol OpenAPI spec change, and bumps the `effect` dependency to a newer release candidate.
Featuresv10.0.0-alpha.31
This release removes the experimental `./fp` functional surface and introduces a first-class Effect v4 surface via a new opt-in `./effect` subpath. The Promise-based main `.` entry remains Promise-first, with the runtime graph for the main entry intended to stay free of Effect.
BreakingFeaturesv10.0.0-alpha.30
v10.0.0-alpha.30 updates the generated SDK to include new cluster-admin functionality for exporting and cluster-wide history backup operations, alongside additive schema/type updates from the upstream OpenAPI spec. The published release notes only mention example coverage, but the code diff shows substantial new API surface area in the client.
Featuresv10.0.0-alpha.29
Release v10.0.0-alpha.29 mainly claims to add example coverage for the existing `restoreAsClusterAdmin` and `getClusterTopology` operations. However, the code diff shows multiple OpenAPI/spec-driven SDK additions and type shape changes beyond just examples.
Featuresv10.0.0-alpha.28
v10.0.0-alpha.28 largely contains a regenerated SDK from an updated Zeebe gateway OpenAPI spec, adding new API surface (cluster-admin operations and history backups) and updating request/response schemas. The published release notes only mention example coverage updates, so most of the functional API/spec changes in the diff are undocumented.
Features