@camunda8/orchestration-cluster-api 8.9.0-alpha.32 → 8.9.0-alpha.34

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+# [8.9.0-alpha.34](https://github.com/camunda/orchestration-cluster-api-js/compare/v8.9.0-alpha.33...v8.9.0-alpha.34) (2026-04-09)
+
+
+### Bug Fixes
+
+* add missing examples for all template methods (green) ([6fabac5](https://github.com/camunda/orchestration-cluster-api-js/commit/6fabac5bf3423037d4d7d05d9c176d0a45422b5c)), closes [#122](https://github.com/camunda/orchestration-cluster-api-js/issues/122)
+* Update scripts/check-method-example-completeness.cjs ([8503c12](https://github.com/camunda/orchestration-cluster-api-js/commit/8503c120b65bf4002fbe153e1b790ed6e2342130))
+
+# [8.9.0-alpha.33](https://github.com/camunda/orchestration-cluster-api-js/compare/v8.9.0-alpha.32...v8.9.0-alpha.33) (2026-04-09)
+
+
+### Bug Fixes
+
+* exclude union response schemas from VOID_RESPONSES set ([52c36ab](https://github.com/camunda/orchestration-cluster-api-js/commit/52c36abaacaf79398f47f35b4bbd28d25663ae17)), closes [#120](https://github.com/camunda/orchestration-cluster-api-js/issues/120)
+* remove accidentally committed .tmp-clone gitlink ([9301965](https://github.com/camunda/orchestration-cluster-api-js/commit/9301965ce991135bff9dcc4301cc026c8fc92d4c))
+
 # [8.9.0-alpha.32](https://github.com/camunda/orchestration-cluster-api-js/compare/v8.9.0-alpha.31...v8.9.0-alpha.32) (2026-04-09)
 
 

package/README.md

@@ -50,6 +50,104 @@ In the vast majority of use-cases, this will not be an issue; but you should be
 - Check the [CHANGELOG](https://github.com/camunda/orchestration-cluster-api-js/releases).
 - As a sanity check during server version upgrade, rebuild applications with the matching SDK major version to identify any affected runtime surfaces.
 
+## Migrating from 8.8
+
+SDK 9.x (for Camunda 8.9) introduces two categories of breaking type changes relative to SDK 8.x (for Camunda 8.8). Neither change affects runtime behavior — existing code that compiled against 8.x will run identically — but the compiler will flag type mismatches until you update.
+
+### Search results: optional → required fields
+
+The search result types changed several fields from **optional** to **required**:
+
+**`SearchQueryPageResponse` (page metadata)**
+
+| Field | SDK 8.x (Camunda 8.8) | SDK 9.x (Camunda 8.9) |
+|-------|----------------------|----------------------|
+| `totalItems` | `totalItems?: number` | `totalItems: number` |
+| `hasMoreTotalItems` | `hasMoreTotalItems?: boolean` | `hasMoreTotalItems: boolean` |
+| `endCursor` | `endCursor?: EndCursor` | `endCursor: EndCursor \| null` |
+| `startCursor` | `startCursor?: StartCursor` | `startCursor: StartCursor \| null` |
+
+**`*SearchQueryResult` types (result containers)**
+
+| Field | SDK 8.x (Camunda 8.8) | SDK 9.x (Camunda 8.9) |
+|-------|----------------------|----------------------|
+| `items` | `items?: T[]` | `items: T[]` |
+| `page` | `page?: SearchQueryPageResponse` | `page: SearchQueryPageResponse` |
+
+This reflects upstream OpenAPI spec changes where these fields are now always present in the response, with `null` indicating "no value" for cursors rather than being absent.
+
+**What to change**: Update code that checks for these fields using optional chaining or `undefined` comparisons. The `items` array and `page` object are now always present, so optional chaining on them is unnecessary:
+
+<!-- snippet-exempt: migration example showing before/after patterns -->
+
+```ts
+// Before (8.x) — checking for undefined
+if (result.page?.endCursor !== undefined) {
+  nextPage(result.page.endCursor);
+}
+const count = result.items?.length ?? 0;
+
+// After (9.x) — page and items are always present; check cursors for null
+if (result.page.endCursor !== null) {
+  nextPage(result.page.endCursor);
+}
+const count = result.items.length;
+```
+
+If you have a custom `PagedResponse` type, update its `page` shape to match:
+
+<!-- snippet-exempt: migration example showing type definition update -->
+
+```ts
+// Before (8.x)
+type PagedResponse<T> = {
+  items?: T[];
+  page?: {
+    totalItems?: number;
+    endCursor?: string;
+    startCursor?: string;
+    hasMoreTotalItems?: boolean;
+  };
+};
+
+// After (9.x)
+type PagedResponse<T> = {
+  items: T[];
+  page: {
+    totalItems: number;
+    endCursor: EndCursor | null;
+    startCursor: StartCursor | null;
+    hasMoreTotalItems: boolean;
+  };
+};
+```
+
+### Branded key types for `tenantId`
+
+The `tenantId` field on request types (e.g. `CreateDeploymentData`) changed from `string` to the branded `TenantId` type. A plain `string` is no longer assignable:
+
+<!-- snippet-exempt: migration example showing branded type usage -->
+
+```ts
+import { TenantId } from '@camunda8/orchestration-cluster-api';
+
+// Before (8.x) — plain string worked
+await camunda.createDeployment({
+  tenantId: 'my-tenant',
+  resources: [file],
+});
+
+// After (9.x) — use the branded type helper
+await camunda.createDeployment({
+  tenantId: TenantId.assumeExists('my-tenant'),
+  resources: [file],
+});
+```
+
+`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.
+
+> **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.
+
 ## 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.

package/dist/{chunk-5B3A2LNR.js → chunk-DP5HJTAU.js}

@@ -4412,7 +4412,7 @@ function installAuthInterceptor(client2, getStrategy, getAuthHeaders) {
 }
 
 // src/runtime/version.ts
-var packageVersion = "8.9.0-alpha.32";
+var packageVersion = "8.9.0-alpha.34";
 
 // src/runtime/supportLogger.ts
 var NoopSupportLogger = class {
@@ -6088,7 +6088,7 @@ function deepFreeze2(obj) {
   }
   return obj;
 }
-var VOID_RESPONSES = /* @__PURE__ */ new Set(["zDeleteAuthorizationResponse", "zUpdateAuthorizationResponse", "zCancelBatchOperationResponse", "zResumeBatchOperationResponse", "zSuspendBatchOperationResponse", "zPinClockResponse", "zResetClockResponse", "zDeleteGlobalClusterVariableResponse", "zDeleteTenantClusterVariableResponse", "zDeleteDecisionInstanceResponse", "zDeleteDocumentResponse", "zActivateAdHocSubProcessActivitiesResponse", "zCreateElementInstanceVariablesResponse", "zDeleteGlobalTaskListenerResponse", "zDeleteGroupResponse", "zUnassignClientFromGroupResponse", "zAssignClientToGroupResponse", "zUnassignMappingRuleFromGroupResponse", "zAssignMappingRuleToGroupResponse", "zUnassignUserFromGroupResponse", "zAssignUserToGroupResponse", "zResolveIncidentResponse", "zUpdateJobResponse", "zCompleteJobResponse", "zThrowJobErrorResponse", "zFailJobResponse", "zDeleteMappingRuleResponse", "zGetStartProcessFormResponse", "zCancelProcessInstanceResponse", "zDeleteProcessInstanceResponse", "zMigrateProcessInstanceResponse", "zModifyProcessInstanceResponse", "zDeleteRoleResponse", "zUnassignRoleFromClientResponse", "zAssignRoleToClientResponse", "zUnassignRoleFromGroupResponse", "zAssignRoleToGroupResponse", "zUnassignRoleFromMappingRuleResponse", "zAssignRoleToMappingRuleResponse", "zUnassignRoleFromUserResponse", "zAssignRoleToUserResponse", "zGetStatusResponse", "zDeleteTenantResponse", "zUnassignClientFromTenantResponse", "zAssignClientToTenantResponse", "zUnassignGroupFromTenantResponse", "zAssignGroupToTenantResponse", "zUnassignMappingRuleFromTenantResponse", "zAssignMappingRuleToTenantResponse", "zUnassignRoleFromTenantResponse", "zAssignRoleToTenantResponse", "zUnassignUserFromTenantResponse", "zAssignUserToTenantResponse", "zDeleteUserResponse", "zUpdateUserTaskResponse", "zUnassignUserTaskResponse", "zAssignUserTaskResponse", "zCompleteUserTaskResponse", "zGetUserTaskFormResponse"]);
+var VOID_RESPONSES = /* @__PURE__ */ new Set(["zDeleteAuthorizationResponse", "zUpdateAuthorizationResponse", "zCancelBatchOperationResponse", "zResumeBatchOperationResponse", "zSuspendBatchOperationResponse", "zPinClockResponse", "zResetClockResponse", "zDeleteGlobalClusterVariableResponse", "zDeleteTenantClusterVariableResponse", "zDeleteDecisionInstanceResponse", "zDeleteDocumentResponse", "zActivateAdHocSubProcessActivitiesResponse", "zCreateElementInstanceVariablesResponse", "zDeleteGlobalTaskListenerResponse", "zDeleteGroupResponse", "zUnassignClientFromGroupResponse", "zAssignClientToGroupResponse", "zUnassignMappingRuleFromGroupResponse", "zAssignMappingRuleToGroupResponse", "zUnassignUserFromGroupResponse", "zAssignUserToGroupResponse", "zResolveIncidentResponse", "zUpdateJobResponse", "zCompleteJobResponse", "zThrowJobErrorResponse", "zFailJobResponse", "zDeleteMappingRuleResponse", "zCancelProcessInstanceResponse", "zDeleteProcessInstanceResponse", "zMigrateProcessInstanceResponse", "zModifyProcessInstanceResponse", "zDeleteRoleResponse", "zUnassignRoleFromClientResponse", "zAssignRoleToClientResponse", "zUnassignRoleFromGroupResponse", "zAssignRoleToGroupResponse", "zUnassignRoleFromMappingRuleResponse", "zAssignRoleToMappingRuleResponse", "zUnassignRoleFromUserResponse", "zAssignRoleToUserResponse", "zGetStatusResponse", "zDeleteTenantResponse", "zUnassignClientFromTenantResponse", "zAssignClientToTenantResponse", "zUnassignGroupFromTenantResponse", "zAssignGroupToTenantResponse", "zUnassignMappingRuleFromTenantResponse", "zAssignMappingRuleToTenantResponse", "zUnassignRoleFromTenantResponse", "zAssignRoleToTenantResponse", "zUnassignUserFromTenantResponse", "zAssignUserToTenantResponse", "zDeleteUserResponse", "zUpdateUserTaskResponse", "zUnassignUserTaskResponse", "zAssignUserTaskResponse", "zCompleteUserTaskResponse"]);
 var CancelError = class extends Error {
   constructor() {
     super("Cancelled");
@@ -16721,4 +16721,4 @@ export {
   withTimeoutTE,
   eventuallyTE
 };
-//# sourceMappingURL=chunk-5B3A2LNR.js.map
+//# sourceMappingURL=chunk-DP5HJTAU.js.map