@camunda8/orchestration-cluster-api 1.2.0 → 1.2.2

package/CHANGELOG.md

@@ -1,9 +1,21 @@
-# [1.2.0](https://github.com/camunda/orchestration-cluster-api-js/compare/v1.1.5...v1.2.0) (2025-11-13)
+## [1.2.2](https://github.com/camunda/orchestration-cluster-api-js/compare/v1.2.1...v1.2.2) (2025-12-01)
+
+
+### Bug Fixes
+
+* set default requestTimeout to 0 ([c18a22a](https://github.com/camunda/orchestration-cluster-api-js/commit/c18a22a0f5dacfcd6b16ac16d8260307a17f87d9))
 
+## [1.2.1](https://github.com/camunda/orchestration-cluster-api-js/compare/v1.2.0...v1.2.1) (2025-11-28)
+
+### Bug Fixes
+
+- add job.error method ([285e743](https://github.com/camunda/orchestration-cluster-api-js/commit/285e743a0d6f0020ba5b25bf7f048748edcd63b4))
+
+# [1.2.0](https://github.com/camunda/orchestration-cluster-api-js/compare/v1.1.5...v1.2.0) (2025-11-13)
 
 ### Features
 
-* add silly level logging ([a8a4aad](https://github.com/camunda/orchestration-cluster-api-js/commit/a8a4aadd3556d5c441d63d2a9b3943a68dc747e5))
+- add silly level logging ([a8a4aad](https://github.com/camunda/orchestration-cluster-api-js/commit/a8a4aadd3556d5c441d63d2a9b3943a68dc747e5))
 
 ## [1.1.5](https://github.com/camunda/orchestration-cluster-api-js/compare/v1.1.4...v1.1.5) (2025-11-13)
 

package/README.md

@@ -35,7 +35,7 @@ Keep configuration out of application code. Let the factory read `CAMUNDA_*` var
 ```ts
 import createCamundaClient from '@camunda8/orchestration-cluster-api';
 
-// Zero‑config construction: reads CAMUNDA_* from process.env once.
+// Zero‑config construction: reads CAMUNDA_* from process.env. If no configuration is present, defaults to Camunda 8 Run on localhost.
 const camunda = createCamundaClient();
 
 const topology = await camunda.getTopology();
@@ -102,6 +102,14 @@ You can call `client.configure({ config: { ... } })` to re‑hydrate. The expose
 
 ## Validation
 
+This allows you to validate that requests to the API from your application and responses from the API have the expected types and shape declared in the type system.
+
+This protects your application from runtime bugs or errors in the type system leading to undefined states hitting your business logic.
+
+Recommended to use `fanatical` or `strict` in development and then switch to `strict` or `warn` in production.
+
+Or you can just YOLO it and leave it on `none` all the time.
+
 Controlled by `CAMUNDA_SDK_VALIDATION` (or `config` override). Grammar:
 
 ```
@@ -113,12 +121,17 @@ Examples:
 
 ```bash
 CAMUNDA_SDK_VALIDATION=warn           # warn on both
-CAMUNDA_SDK_VALIDATION=req:strict,res:warn
+CAMUNDA_SDK_VALIDATION=req:strict,res:warn # strict on requests, warn on responses
 CAMUNDA_SDK_VALIDATION=none
 ```
 
 Behavior:
 
+- `none` - no validation performed
+- `warn` - emit warning on invalid shape
+- `strict` - fail on type mismatch or missing required fields
+- `fanatical` - fail on type mismatch, missing required fields, or unknown additional fields
+
 ## Advanced HTTP Retry: Cockatiel Adapter (Optional)
 
 The SDK includes built‑in transient HTTP retry (429, 503, network errors) using a p‑retry based engine plus a fallback implementation. For advanced resilience patterns (circuit breakers, timeouts, custom classification, combining policies) you can integrate [cockatiel](https://github.com/connor4312/cockatiel).
@@ -237,18 +250,6 @@ To disable, unset the env variable or set `CAMUNDA_SUPPORT_LOG_ENABLED=false`.
 
 Refer to `./docs/CONFIG_REFERENCE.md` for the full list of related environment variables.
 
-## Contributing
-
-We welcome issues and pull requests. Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) guide before opening a PR to understand:
-
-- Deterministic builds policy (no committed timestamps) – see CONTRIBUTING
-- Commit message conventions (Conventional Commits with enforced subject length)
-- Release workflow & how to dry‑run semantic‑release locally
-- Testing strategy (unit vs integration)
-- Performance and security considerations
-
-If you plan to help migrate to npm Trusted Publishing (OIDC), open an issue so we can coordinate workflow permission changes (`id-token: write`) and removal of the legacy `NPM_TOKEN` secret.
-
 ### Custom Classification Example
 
 Retry only network errors + 429/503, plus optionally 500 on safe GET endpoints you mark:
@@ -422,6 +423,7 @@ Your `jobHandler` must ultimately invoke exactly one of:
 - `job.complete({ variables? })` OR `job.complete()`
 - `job.fail({ errorMessage, retries?, retryBackoff? })`
 - `job.cancelWorkflow({})` (cancels the process instance)
+- `job.error({ errorCode, errorMessage? })` (throws a business error)
 - `job.ignore()` (marks as done locally without reporting to broker – can be used for decoupled flows)
 
 Each action returns an opaque unique symbol receipt (`JobActionReceipt`). The handler's declared return type (`Promise<JobActionReceipt>`) is intentional:
@@ -1119,10 +1121,6 @@ const client = createCamundaClient({
 });
 ```
 
-## License
-
-Apache 2.0
-
 ## API Documentation
 
 Generate an HTML API reference site with TypeDoc (public entry points only):
@@ -1132,3 +1130,17 @@ npm run docs:api
 ```
 
 Output: static site in `docs/api` (open `docs/api/index.html` in a browser or serve the folder, e.g. `npx http-server docs/api`). Entry points: `src/index.ts`, `src/logger.ts`, `src/fp/index.ts`. Internal generated code, scripts, tests are excluded and private / protected members are filtered. Regenerate after changing public exports.
+
+## Contributing
+
+We welcome issues and pull requests. Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) guide before opening a PR to understand:
+
+- Deterministic builds policy (no committed timestamps) – see CONTRIBUTING
+- Commit message conventions (Conventional Commits with enforced subject length)
+- Release workflow & how to dry‑run semantic‑release locally
+- Testing strategy (unit vs integration)
+- Performance and security considerations
+
+## License
+
+Apache 2.0

package/dist/{chunk-7RIALC7K.js → chunk-HAWDB7KV.js}

@@ -113,7 +113,7 @@ var EventualConsistencyTimeoutError = class extends Error {
 // src/runtime/jobWorker.ts
 var JobActionReceipt = "JOB_ACTION_RECEIPT";
 var _workerCounter = 0;
-var DEFAULT_LONGPOLL_TIMEOUT = 55e3;
+var DEFAULT_LONGPOLL_TIMEOUT = 0;
 var JobWorker = class {
   _client;
   _cfg;
@@ -9624,7 +9624,7 @@ function installAuthInterceptor(client2, getStrategy, getAuthHeaders) {
 }
 
 // src/runtime/version.ts
-var packageVersion = "1.2.0";
+var packageVersion = "1.2.2";
 
 // src/runtime/supportLogger.ts
 var NoopSupportLogger = class {
@@ -10603,6 +10603,14 @@ function enrichActivatedJob(raw, client2, log) {
     }
     return JobActionReceipt;
   };
+  job.error = async (error) => {
+    try {
+      await client2.throwJobError({ ...error, jobKey: raw.jobKey });
+    } finally {
+      ack();
+    }
+    return JobActionReceipt;
+  };
   job.cancelWorkflow = async () => {
     try {
       await client2.cancelProcessInstance({
@@ -18872,4 +18880,4 @@ export {
   withTimeoutTE,
   eventuallyTE
 };
-//# sourceMappingURL=chunk-7RIALC7K.js.map
+//# sourceMappingURL=chunk-HAWDB7KV.js.map