@camunda8/orchestration-cluster-api 1.2.2 → 8.8.0

package/CHANGELOG.md

@@ -1,9 +1,14 @@
-## [1.2.2](https://github.com/camunda/orchestration-cluster-api-js/compare/v1.2.1...v1.2.2) (2025-12-01)
+## [1.2.3](https://github.com/camunda/orchestration-cluster-api-js/compare/v1.2.2...v1.2.3) (2025-12-05)
+
+### Bug Fixes
 
+- support fetchVariables in job worker ([b672d8d](https://github.com/camunda/orchestration-cluster-api-js/commit/b672d8d3ec499624a58d1db2b8e920f3ccc77ebc))
+
+## [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))
+- 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)
 

package/README.md

@@ -398,6 +398,8 @@ const worker = client.createJobWorker({
   maxParallelJobs: 10,
   timeoutMs: 15_000, // long‑poll timeout (server side requestTimeout)
   pollIntervalMs: 100, // delay between polls when no jobs / at capacity
+  // Optional: only fetch specific variables during activation
+  fetchVariables: ['orderId'],
   inputSchema: Input, // validates incoming variables if validateSchemas true
   outputSchema: Output, // validates variables passed to complete(...)
   validateSchemas: true, // set false for max throughput (skip Zod)
@@ -416,6 +418,29 @@ process.on('SIGINT', () => {
 });
 ```
 
+Note on variable fetching:
+
+- `fetchVariables: string[]` limits variables returned on activated jobs to the specified keys. If omitted, all visible variables at activation scope are returned. This maps to the REST API field `fetchVariable`.
+
+TypeScript inference:
+
+- When you provide `inputSchema`, the type of `fetchVariables` is constrained to the keys of the inferred `variables` type from that schema. Example:
+
+```ts
+const Input = z.object({ orderId: z.string(), amount: z.number() });
+client.createJobWorker({
+  jobType: 'process-order',
+  maxParallelJobs: 5,
+  jobTimeoutMs: 30_000,
+  inputSchema: Input,
+  // Only allows 'orderId' | 'amount' here at compile-time
+  fetchVariables: ['orderId', 'amount'],
+  jobHandler: async (job) => job.complete(),
+});
+```
+
+- Without `inputSchema`, `fetchVariables` defaults to `string[]`.
+
 ### Job Handler Semantics
 
 Your `jobHandler` must ultimately invoke exactly one of:

package/dist/{chunk-HAWDB7KV.js → chunk-CTXSQJWB.js}

@@ -228,7 +228,9 @@ var JobWorker = class {
       worker: this._name,
       maxJobsToActivate: batchSize,
       requestTimeout: this._cfg.pollTimeoutMs ?? DEFAULT_LONGPOLL_TIMEOUT,
-      timeout: this._cfg.jobTimeoutMs
+      timeout: this._cfg.jobTimeoutMs,
+      // API expects `fetchVariable`; map from config `fetchVariables`
+      ...this._cfg.fetchVariables && this._cfg.fetchVariables.length > 0 ? { fetchVariable: this._cfg.fetchVariables } : {}
     };
     this._log.debug(() => ["activation.request", { batchSize }]);
     let result = [];
@@ -2982,7 +2984,6 @@ __export(zod_gen_exports, {
   zMappingRuleUpdateRequest: () => zMappingRuleUpdateRequest,
   zMappingRuleUpdateResult: () => zMappingRuleUpdateResult,
   zMatchedDecisionRuleItem: () => zMatchedDecisionRuleItem,
-  zMessageCorrelationKey: () => zMessageCorrelationKey,
   zMessageCorrelationRequest: () => zMessageCorrelationRequest,
   zMessageCorrelationResult: () => zMessageCorrelationResult,
   zMessageKey: () => zMessageKey,
@@ -3322,7 +3323,6 @@ var zScopeKey = zLongKey;
 var zIncidentKey = zLongKey;
 var zJobKey = zLongKey;
 var zMessageSubscriptionKey = zLongKey;
-var zMessageCorrelationKey = zLongKey;
 var zDecisionDefinitionId = z.string().min(1).max(256).regex(/^[A-Za-z0-9_@.+-]+$/).register(z.globalRegistry, {
   description: "Id of a decision definition, from the model. Only ids of decision definitions that are deployed are useful."
 });
@@ -4510,9 +4510,7 @@ var zIncidentFilter = z.object({
     description: "Error message which describes the error in more detail."
   })),
   elementId: z.optional(zElementId),
-  creationTime: z.optional(z.iso.datetime().register(z.globalRegistry, {
-    description: "Date of incident creation."
-  })),
+  creationTime: z.optional(zDateTimeFilterProperty),
   state: z.optional(z.enum([
     "ACTIVE",
     "MIGRATED",
@@ -4677,7 +4675,9 @@ var zMessageSubscriptionResult = z.object({
   messageName: z.optional(z.string().register(z.globalRegistry, {
     description: "The name of the message associated with the message subscription."
   })),
-  correlationKey: z.optional(zMessageCorrelationKey),
+  correlationKey: z.optional(z.string().register(z.globalRegistry, {
+    description: "The correlation key of the message subscription."
+  })),
   tenantId: z.optional(zTenantId)
 });
 var zMessageSubscriptionSearchQueryResult = zSearchQueryResponse.and(z.object({
@@ -5861,7 +5861,6 @@ var zJobSearchQuerySortRequest = z.object({
     "endTime",
     "errorCode",
     "errorMessage",
-    "hasFailedWithRetriesLeft",
     "isDenied",
     "jobKey",
     "kind",
@@ -6007,9 +6006,9 @@ var zJobSearchResult = z.object({
     z.string(),
     z.null()
   ])),
-  hasFailedWithRetriesLeft: z.optional(z.boolean().register(z.globalRegistry, {
+  hasFailedWithRetriesLeft: z.boolean().register(z.globalRegistry, {
     description: "Indicates whether the job has failed with retries left."
-  })),
+  }),
   isDenied: z.optional(z.union([
     z.boolean(),
     z.null()
@@ -6052,7 +6051,7 @@ var zProblemDetail = z.object({
   detail: z.optional(z.string().register(z.globalRegistry, {
     description: "An explanation of the problem in more detail."
   })),
-  instance: z.optional(z.string().register(z.globalRegistry, {
+  instance: z.optional(z.url().register(z.globalRegistry, {
     description: "A URI path identifying the origin of the problem."
   }))
 }).register(z.globalRegistry, {
@@ -6346,7 +6345,7 @@ var zMessageCorrelationRequest = z.object({
 });
 var zMessageCorrelationResult = z.object({
   tenantId: z.optional(zTenantId),
-  messageKey: z.optional(zMessageCorrelationKey),
+  messageKey: z.optional(zMessageKey),
   processInstanceKey: z.optional(zProcessInstanceKey)
 }).register(z.globalRegistry, {
   description: "The message key of the correlated message, as well as the first process instance key it\ncorrelated with.\n"
@@ -7369,13 +7368,21 @@ var zSearchUserTaskVariablesData = z.object({
   path: z.object({
     userTaskKey: zUserTaskKey
   }),
-  query: z.optional(z.never())
+  query: z.optional(z.object({
+    truncateValues: z.optional(z.boolean().register(z.globalRegistry, {
+      description: "When true (default), long variable values in the response are truncated. When false, full variable values are returned."
+    }))
+  }))
 });
 var zSearchUserTaskVariablesResponse = zVariableSearchQueryResult;
 var zSearchVariablesData = z.object({
   body: z.optional(zVariableSearchQuery),
   path: z.optional(z.never()),
-  query: z.optional(z.never())
+  query: z.optional(z.object({
+    truncateValues: z.optional(z.boolean().register(z.globalRegistry, {
+      description: "When true (default), long variable values in the response are truncated. When false, full variable values are returned."
+    }))
+  }))
 });
 var zSearchVariablesResponse = zVariableSearchQueryResult;
 var zGetVariableData = z.object({
@@ -9624,7 +9631,7 @@ function installAuthInterceptor(client2, getStrategy, getAuthHeaders) {
 }
 
 // src/runtime/version.ts
-var packageVersion = "1.2.2";
+var packageVersion = "8.8.0";
 
 // src/runtime/supportLogger.ts
 var NoopSupportLogger = class {
@@ -17396,9 +17403,10 @@ var CamundaClient = class {
     if (!consistencyManagement) throw new Error("Missing consistencyManagement parameter for eventually consistent endpoint");
     const useConsistency = consistencyManagement.consistency;
     return toCancelable2(async (signal) => {
-      const { userTaskKey, ..._body } = arg || {};
+      const { userTaskKey, truncateValues, ..._body } = arg || {};
       let envelope = {};
       envelope.path = { userTaskKey };
+      envelope.query = { truncateValues };
       envelope.body = _body;
       if (this._validation.settings.req !== "none") {
         const maybe = await this._validation.gateRequest("searchUserTaskVariables", zSearchUserTaskVariablesData, envelope);
@@ -17406,6 +17414,7 @@ var CamundaClient = class {
       }
       const opts = { client: this._client, signal, throwOnError: false };
       if (envelope.path) opts.path = envelope.path;
+      if (envelope.query) opts.query = envelope.query;
       if (envelope.body !== void 0) opts.body = envelope.body;
       const call = async () => {
         try {
@@ -17452,14 +17461,16 @@ var CamundaClient = class {
     if (!consistencyManagement) throw new Error("Missing consistencyManagement parameter for eventually consistent endpoint");
     const useConsistency = consistencyManagement.consistency;
     return toCancelable2(async (signal) => {
-      const _body = arg;
+      const { truncateValues, ..._body } = arg || {};
       let envelope = {};
+      envelope.query = { truncateValues };
       envelope.body = _body;
       if (this._validation.settings.req !== "none") {
         const maybe = await this._validation.gateRequest("searchVariables", zSearchVariablesData, envelope);
         if (this._validation.settings.req === "strict") envelope = maybe;
       }
       const opts = { client: this._client, signal, throwOnError: false };
+      if (envelope.query) opts.query = envelope.query;
       if (envelope.body !== void 0) opts.body = envelope.body;
       const call = async () => {
         try {
@@ -18880,4 +18891,4 @@ export {
   withTimeoutTE,
   eventuallyTE
 };
-//# sourceMappingURL=chunk-HAWDB7KV.js.map
+//# sourceMappingURL=chunk-CTXSQJWB.js.map