@camunda8/orchestration-cluster-api 10.0.0-alpha.4 → 10.0.0-alpha.5

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+# [10.0.0-alpha.5](https://github.com/camunda/orchestration-cluster-api-js/compare/v10.0.0-alpha.4...v10.0.0-alpha.5) (2026-05-08)
+
+
+### Features
+
+* add agent instance example coverage ([8a0072d](https://github.com/camunda/orchestration-cluster-api-js/commit/8a0072d03cf426ea895863d7cbdd87178c2e7e2f))
+* v10 migration — bundler 2.4.1, branded type examples, README ([dd4a714](https://github.com/camunda/orchestration-cluster-api-js/commit/dd4a7149682b89d1f8f9c0f627dfef5645b10ea7)), closes [#203](https://github.com/camunda/orchestration-cluster-api-js/issues/203) [#204](https://github.com/camunda/orchestration-cluster-api-js/issues/204)
+
 # [10.0.0-alpha.4](https://github.com/camunda/orchestration-cluster-api-js/compare/v10.0.0-alpha.3...v10.0.0-alpha.4) (2026-04-29)
 
 

package/README.md

@@ -149,10 +149,51 @@ await camunda.createDeployment({
 });
 ```
 
-`TenantId.assumeExists()` validates the string against the tenant ID pattern and brands it at zero runtime cost. See [Branded Keys](#branded-keys) for more on this pattern.
+`TenantId.assumeExists()` validates the string against the tenant ID pattern and returns a branded value. The branded value is just a string at runtime, but `assumeExists()` performs validation and can throw if the input is malformed. See [Branded Keys](#branded-keys) for more on this pattern.
 
 > **Tip**: If your tenant ID comes from a validated source (environment variable, config file), call `TenantId.assumeExists()` once at startup and pass the branded value throughout your application.
 
+## Migrating from 8.9
+
+SDK 10.x (for Camunda 8.10) promotes several identifier and name fields from plain `string` to **branded types** via `CamundaKey<T>`. The wire format and runtime API are unchanged — branded values are still plain strings at runtime and are assignable anywhere a `string` is expected (template literals, logging, JSON serialization). Callers need to brand values using `.assumeExists()` (which performs validation) to satisfy the new types.
+
+### New branded types
+
+| Brand | Used for |
+|-------|----------|
+| `RoleId` | Role identifiers |
+| `GroupId` | Group identifiers |
+| `ClientId` | OAuth client identifiers |
+| `MappingRuleId` | Mapping-rule identifiers |
+| `ClusterVariableName` | Cluster variable names |
+| `AgentInstanceKey` | Agent-instance system keys |
+
+### Migration
+
+<!-- snippet-source: examples/readme.ts | regions: V9ToV10Migration -->
+
+```ts
+// v9 — plain strings were accepted
+// await camunda.assignRoleToGroup({
+//   roleId: 'developer',
+//   groupId: 'engineering',
+// });
+
+// v10 — use the branded type helpers at the boundary
+await camunda.assignRoleToGroup({
+  roleId: RoleId.assumeExists('developer'),
+  groupId: GroupId.assumeExists('engineering'),
+});
+```
+
+Each branded type has an `.assumeExists()` method that validates the string and returns the branded value. Validation runs at call time and can throw if the input is malformed, so call it once at the boundary (startup, config parsing, API response) and pass the branded value through your application. See [Branded Keys](#branded-keys) for more on this pattern.
+
+### What does NOT change
+
+- The wire format is unchanged — all values are still strings on the wire.
+- No method signatures changed name or arity.
+- Branded values are assignable anywhere a `string` is expected (template literals, logging, JSON serialization), so existing string-handling code continues to work.
+
 ## Quick Start (Zero‑Config – Recommended)
 
 Keep configuration out of application code. Let the factory read `CAMUNDA_*` variables from the environment (12‑factor style). This makes rotation, secret management, and environment promotion safer & simpler.
@@ -681,6 +722,7 @@ Example patterns:
 return job.complete({ variables: { processed: true } });
 
 // GOOD: No-arg completion example, sentinel stored for ultimate return
+// biome-ignore lint/correctness/noUnreachable: intentional — showing multiple completion patterns
 const ack = await job.complete();
 // ...
 return ack;

package/dist/{chunk-YMG6EGPW.js → chunk-S3RXIYYE.js}

@@ -1166,6 +1166,26 @@ var client = createClient(createConfig({
 }));
 
 // src/gen/sdk.gen.ts
+var getAgentInstance = (options) => {
+  return (options.client ?? client).get({
+    requestValidator: void 0,
+    responseValidator: void 0,
+    url: "/agent-instances/{agentInstanceKey}",
+    ...options
+  });
+};
+var searchAgentInstances = (options) => {
+  return (options?.client ?? client).post({
+    requestValidator: void 0,
+    responseValidator: void 0,
+    url: "/agent-instances/search",
+    ...options,
+    headers: {
+      "Content-Type": "application/json",
+      ...options?.headers
+    }
+  });
+};
 var searchAuditLogs = (options) => {
   return (options?.client ?? client).post({
     requestValidator: void 0,
@@ -2451,6 +2471,18 @@ var getProcessInstanceStatistics = (options) => {
     ...options
   });
 };
+var searchResources = (options) => {
+  return (options?.client ?? client).post({
+    requestValidator: void 0,
+    responseValidator: void 0,
+    url: "/resources/search",
+    ...options,
+    headers: {
+      "Content-Type": "application/json",
+      ...options?.headers
+    }
+  });
+};
 var getResource = (options) => {
   return (options.client ?? client).get({
     requestValidator: void 0,
@@ -4409,7 +4441,7 @@ function installAuthInterceptor(client2, getStrategy, getAuthHeaders) {
 }
 
 // src/runtime/version.ts
-var packageVersion = "10.0.0-alpha.4";
+var packageVersion = "10.0.0-alpha.5";
 
 // src/runtime/supportLogger.ts
 var NoopSupportLogger = class {
@@ -6386,7 +6418,7 @@ var CamundaClient = class {
   _schemasPromise = null;
   _loadSchemas() {
     if (!this._schemasPromise) {
-      this._schemasPromise = import("./zod.gen-WZT74U4Q.js");
+      this._schemasPromise = import("./zod.gen-UJLBQNEH.js");
     }
     return this._schemasPromise;
   }
@@ -9511,6 +9543,62 @@ var CamundaClient = class {
       return this._invokeWithRetry(() => call(), { opId: "failJob", exempt: true, retryOverride: options?.retry });
     });
   }
+  getAgentInstance(arg, consistencyManagement, options) {
+    if (!consistencyManagement) throw new Error("Missing consistencyManagement parameter for eventually consistent endpoint");
+    const useConsistency = consistencyManagement.consistency;
+    return toCancelable2(async (signal) => {
+      const { agentInstanceKey } = arg || {};
+      let envelope = {};
+      envelope.path = { agentInstanceKey };
+      if (this._validation.settings.req !== "none") {
+        const _schemas = await this._loadSchemas();
+        const maybe = await this._validation.gateRequest("getAgentInstance", _schemas.zGetAgentInstanceData, envelope);
+        if (this._validation.settings.req === "strict") envelope = maybe;
+      }
+      const opts = { client: this._client, signal, throwOnError: false };
+      if (envelope.path) opts.path = envelope.path;
+      const call = async () => {
+        try {
+          const _raw = await getAgentInstance(opts);
+          let data = this._evaluateResponse(_raw, "getAgentInstance", (resp) => {
+            const st = resp.status ?? resp.response?.status;
+            if (!st) return void 0;
+            const candidate = st === 429 || st === 503 || st === 500;
+            if (!candidate) return void 0;
+            let prob = void 0;
+            if (resp.error && typeof resp.error === "object") prob = resp.error;
+            const err = new Error(prob && (prob.title || prob.detail) ? prob.title || prob.detail : "HTTP " + st);
+            err.status = st;
+            err.name = "HttpSdkError";
+            if (prob) {
+              for (const k of ["type", "title", "detail", "instance"]) if (prob[k] !== void 0) err[k] = prob[k];
+            }
+            const isBp = st === 429 || st === 503 && err.title === "RESOURCE_EXHAUSTED" || st === 500 && (typeof err.detail === "string" && /RESOURCE_EXHAUSTED/.test(err.detail));
+            if (!isBp) err.nonRetryable = true;
+            return err;
+          });
+          const _respSchemaName = "zGetAgentInstanceResponse";
+          if (this._isVoidResponse(_respSchemaName)) {
+            data = void 0;
+          }
+          if (this._validation.settings.res !== "none") {
+            const _schemas = await this._loadSchemas();
+            const _schema = _schemas.zGetAgentInstanceResponse;
+            if (_schema) {
+              const maybeR = await this._validation.gateResponse("getAgentInstance", _schema, data);
+              if (this._validation.settings.res === "strict") data = maybeR;
+            }
+          }
+          return data;
+        } catch (e) {
+          throw e;
+        }
+      };
+      const invoke = () => toCancelable2(() => call());
+      if (useConsistency) return eventualPoll("getAgentInstance", true, invoke, { ...useConsistency, logger: this._log });
+      return invoke();
+    });
+  }
   getAuditLog(arg, consistencyManagement, options) {
     if (!consistencyManagement) throw new Error("Missing consistencyManagement parameter for eventually consistent endpoint");
     const useConsistency = consistencyManagement.consistency;
@@ -12709,6 +12797,62 @@ var CamundaClient = class {
       return this._invokeWithRetry(() => call(), { opId: "resumeBatchOperation", exempt: false, retryOverride: options?.retry });
     });
   }
+  searchAgentInstances(arg, consistencyManagement, options) {
+    if (!consistencyManagement) throw new Error("Missing consistencyManagement parameter for eventually consistent endpoint");
+    const useConsistency = consistencyManagement.consistency;
+    return toCancelable2(async (signal) => {
+      const _body = arg;
+      let envelope = {};
+      envelope.body = _body;
+      if (this._validation.settings.req !== "none") {
+        const _schemas = await this._loadSchemas();
+        const maybe = await this._validation.gateRequest("searchAgentInstances", _schemas.zSearchAgentInstancesData, envelope);
+        if (this._validation.settings.req === "strict") envelope = maybe;
+      }
+      const opts = { client: this._client, signal, throwOnError: false };
+      if (envelope.body !== void 0) opts.body = envelope.body;
+      const call = async () => {
+        try {
+          const _raw = await searchAgentInstances(opts);
+          let data = this._evaluateResponse(_raw, "searchAgentInstances", (resp) => {
+            const st = resp.status ?? resp.response?.status;
+            if (!st) return void 0;
+            const candidate = st === 429 || st === 503 || st === 500;
+            if (!candidate) return void 0;
+            let prob = void 0;
+            if (resp.error && typeof resp.error === "object") prob = resp.error;
+            const err = new Error(prob && (prob.title || prob.detail) ? prob.title || prob.detail : "HTTP " + st);
+            err.status = st;
+            err.name = "HttpSdkError";
+            if (prob) {
+              for (const k of ["type", "title", "detail", "instance"]) if (prob[k] !== void 0) err[k] = prob[k];
+            }
+            const isBp = st === 429 || st === 503 && err.title === "RESOURCE_EXHAUSTED" || st === 500 && (typeof err.detail === "string" && /RESOURCE_EXHAUSTED/.test(err.detail));
+            if (!isBp) err.nonRetryable = true;
+            return err;
+          });
+          const _respSchemaName = "zSearchAgentInstancesResponse";
+          if (this._isVoidResponse(_respSchemaName)) {
+            data = void 0;
+          }
+          if (this._validation.settings.res !== "none") {
+            const _schemas = await this._loadSchemas();
+            const _schema = _schemas.zSearchAgentInstancesResponse;
+            if (_schema) {
+              const maybeR = await this._validation.gateResponse("searchAgentInstances", _schema, data);
+              if (this._validation.settings.res === "strict") data = maybeR;
+            }
+          }
+          return data;
+        } catch (e) {
+          throw e;
+        }
+      };
+      const invoke = () => toCancelable2(() => call());
+      if (useConsistency) return eventualPoll("searchAgentInstances", false, invoke, { ...useConsistency, logger: this._log });
+      return invoke();
+    });
+  }
   searchAuditLogs(arg, consistencyManagement, options) {
     if (!consistencyManagement) throw new Error("Missing consistencyManagement parameter for eventually consistent endpoint");
     const useConsistency = consistencyManagement.consistency;
@@ -14299,6 +14443,62 @@ var CamundaClient = class {
       return invoke();
     });
   }
+  searchResources(arg, consistencyManagement, options) {
+    if (!consistencyManagement) throw new Error("Missing consistencyManagement parameter for eventually consistent endpoint");
+    const useConsistency = consistencyManagement.consistency;
+    return toCancelable2(async (signal) => {
+      const _body = arg;
+      let envelope = {};
+      envelope.body = _body;
+      if (this._validation.settings.req !== "none") {
+        const _schemas = await this._loadSchemas();
+        const maybe = await this._validation.gateRequest("searchResources", _schemas.zSearchResourcesData, envelope);
+        if (this._validation.settings.req === "strict") envelope = maybe;
+      }
+      const opts = { client: this._client, signal, throwOnError: false };
+      if (envelope.body !== void 0) opts.body = envelope.body;
+      const call = async () => {
+        try {
+          const _raw = await searchResources(opts);
+          let data = this._evaluateResponse(_raw, "searchResources", (resp) => {
+            const st = resp.status ?? resp.response?.status;
+            if (!st) return void 0;
+            const candidate = st === 429 || st === 503 || st === 500;
+            if (!candidate) return void 0;
+            let prob = void 0;
+            if (resp.error && typeof resp.error === "object") prob = resp.error;
+            const err = new Error(prob && (prob.title || prob.detail) ? prob.title || prob.detail : "HTTP " + st);
+            err.status = st;
+            err.name = "HttpSdkError";
+            if (prob) {
+              for (const k of ["type", "title", "detail", "instance"]) if (prob[k] !== void 0) err[k] = prob[k];
+            }
+            const isBp = st === 429 || st === 503 && err.title === "RESOURCE_EXHAUSTED" || st === 500 && (typeof err.detail === "string" && /RESOURCE_EXHAUSTED/.test(err.detail));
+            if (!isBp) err.nonRetryable = true;
+            return err;
+          });
+          const _respSchemaName = "zSearchResourcesResponse";
+          if (this._isVoidResponse(_respSchemaName)) {
+            data = void 0;
+          }
+          if (this._validation.settings.res !== "none") {
+            const _schemas = await this._loadSchemas();
+            const _schema = _schemas.zSearchResourcesResponse;
+            if (_schema) {
+              const maybeR = await this._validation.gateResponse("searchResources", _schema, data);
+              if (this._validation.settings.res === "strict") data = maybeR;
+            }
+          }
+          return data;
+        } catch (e) {
+          throw e;
+        }
+      };
+      const invoke = () => toCancelable2(() => call());
+      if (useConsistency) return eventualPoll("searchResources", false, invoke, { ...useConsistency, logger: this._log });
+      return invoke();
+    });
+  }
   searchRoles(arg, consistencyManagement, options) {
     if (!consistencyManagement) throw new Error("Missing consistencyManagement parameter for eventually consistent endpoint");
     const useConsistency = consistencyManagement.consistency;
@@ -16727,4 +16927,4 @@ export {
   withTimeoutTE,
   eventuallyTE
 };
-//# sourceMappingURL=chunk-YMG6EGPW.js.map
+//# sourceMappingURL=chunk-S3RXIYYE.js.map