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 upstream activity and updates as recently as October 25, 2026.
- Updates have been frequent, with multiple versions and prereleases appearing across October.
AI summary generated
Recent updates
v11.0.0-alpha.4
The release notes announce `lookupUserTask` support and a typed `tenantId` for expression evaluation. The supplied code diff contains additional API and schema changes, including new clock operations, variable-protection metadata, and request-contract changes; attribution to this release is uncertain because the diff starts at v10.0.1 while the notes compare alpha.3 to alpha.4.
Featuresv10.0.1
The release notes describe a fix so cluster-admin operations honor path-level servers. The supplied diff also contains API and generated-client changes not described in those notes, including version-tag process creation, nullable result fields, and changed default-tenant handling. The diff compares v11.0.0-alpha.3 to v10.0.1 rather than v10.0.0 to v10.0.1, so some differences may reflect branch divergence rather than changes introduced specifically in this release.
BreakingFeaturesv11.0.0-alpha.3
v11.0.0-alpha.3 documents a fix so cluster-admin operations honor path-level server definitions. The code diff also adds several API and generated SDK changes, including clock operations, process-instance creation by version tag, variable protection metadata, and changes to deletion and response schemas that are not described in the release notes.
Featuresv11.0.0-alpha.2
v11.0.0-alpha.2 is primarily a regenerated SDK from an updated OpenAPI/gateway protocol spec. While the release notes only mention regeneration for nullable legacy result fields and batch filter docs, the regenerated TypeScript types and Zod schemas show several potentially breaking contract changes.
v10.0.0
Release v10.0.0 is presented as a major step for the SDK, highlighted by a bootstrap SDK 10.x update targeted at Camunda Server 8.10. The notes also list a wide range of client, runtime, worker, and CI related bug fixes and improvements. However, the provided code diff only shows version and dependency/package metadata changes, not the underlying runtime/client behavioral changes described.
BreakingFeaturesv11.0.0-alpha.1
This alpha release starts SDK 11 development for Camunda server 8.11 and bumps the package major version from 10 to 11. The code diff shows mostly versioning and release-process documentation/config updates, with no runtime API diffs detected.
BreakingFeaturesv10.0.0-alpha.53
v10.0.0-alpha.53 introduces a new runtime randomness abstraction to make internal jitter (retry backoffs, OAuth backoffs, activation backoffs, eventual-consistency polling, and worker startup staggering) reproducible via an injected, seedable RandomSource. The implementation wires a new RandomSource through the core runtime and uses it instead of direct Math.random calls in multiple subsystems.
Featuresv10.0.0-alpha.52
v10.0.0-alpha.52 introduces a tree-shakeable build aimed at bundlers, described in the release notes as improving SDK usability for bundle-size-sensitive consumers. The code diff shows this was implemented via a major refactor that adds a new subpath providing per-operation standalone functions, plus several generation-time changes to enable aggressive dead-code elimination (pure annotations, droppable Zod schemas, and operation-local schema modules).
BreakingFeaturesv10.0.0-alpha.51
v10.0.0-alpha.51 primarily updates the SDK packaging and runtime internals to make the bundle safe for browser environments via a new #platform seam. The release notes mention only this browser-bundling change, but the diff also includes OpenAPI spec updates (new status code and tightened request validation details) and several runtime behavior adjustments.
BreakingFeaturesv10.0.0-alpha.50
v10.0.0-alpha.50 introduces a new configuration option, CAMUNDA_REST_ADDRESS_EXACT, intended to prevent the SDK from automatically appending a /v2 suffix to CAMUNDA_REST_ADDRESS. The implementation updates the config schema, changes the restAddress normalization logic, and adds tests and documentation references for the new option.
Featuresv10.0.0-alpha.49
v10.0.0-alpha.49 primarily targets API documentation generation, specifically restoring the client method reference in published docs. In the process, the release also incorporates upstream OpenAPI specification changes that modify generated validation constraints and spec metadata used by the SDK.
v10.0.0-alpha.48
v10.0.0-alpha.48 primarily fixes non-deterministic regeneration of the committed response fixture by removing wall-clock metadata that was being re-stamped on every build. The code change also updates generation tooling and adds deterministic regression tests to prevent the issue from reappearing.
v10.0.0-alpha.47
Release v10.0.0-alpha.47 updates the generated SDK and OpenAPI-derived artifacts. While the release notes only mention adding example coverage for getClusterUpgradeStatus, the code diff shows that a new cluster upgrade-readiness endpoint, associated client method, and response types were added, along with a schema change making batchOperationType nullable.
Featuresv10.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.
Features