@camunda/camunda-api-zod-schemas 0.0.66 → 0.0.68

package/README.md

@@ -1,35 +1,8 @@
 # @camunda/camunda-api-zod-schemas
 
-This is a community-driven open-source project that provides [Zod](https://zod.dev/) schemas and TypeScript type definitions for the Camunda 8 REST API.
+[Zod](https://zod.dev/) schemas and TypeScript types for the Camunda 8
+REST API.
 
-It aims to help developers build robust and type-safe applications when interacting with Camunda 8.
-
-The official Camunda 8 REST API documentation can be found here: [https://docs.camunda.io/docs/next/apis-tools/camunda-api-rest/camunda-api-rest-overview/](https://docs.camunda.io/docs/next/apis-tools/camunda-api-rest/camunda-api-rest-overview/)
-
-## Installation
-
-You can install the package using your favorite package manager:
-
-```bash
-# pnpm
-pnpm add @camunda/camunda-api-zod-schemas
-
-# npm
-npm install @camunda/camunda-api-zod-schemas
-
-# yarn
-yarn add @camunda/camunda-api-zod-schemas
-```
-
-## Usage
-
-The library exports modules that correspond to the different parts of the Camunda API. You can import the schemas and types you need from the main package or specific version sub-modules like `@camunda/camunda-api-zod-schemas/8.8`.
-
-Refer to the exported members from `lib/8.8/index.ts` and other files in the `lib` directory for available schemas and types.
-
-## Publishing a new version
-
-1. Increment the version in `package.json`, dependency-versions in the npm workspace packages, run `npm i`, and push changes to `main`.
-2. Run the [Publish Zod Schemas to npm](https://github.com/camunda/camunda/actions/workflows/publish-zod-schemas.yml) GitHub action.
-   - By default, the dry-run option is enabled. Uncheck it to publish the new version.
-3. Update the `@camunda/camunda-api-zod-schemas` package versions in Operate, Admin and Tasklist.
+Full documentation — installation, usage, and publishing — lives in
+the Camunda Platform Developer Documentation:
+[Camunda API Zod schemas](https://camunda.github.io/camunda/frontend/camunda-api-zod-schemas/).

package/dist/8.10/element-instance.d.ts

@@ -325,6 +325,113 @@ declare const queryElementInstancesRequestBodySchema: z.ZodObject<{
             $in: z.ZodOptional<z.ZodArray<z.ZodString>>;
         }, z.core.$strip>]>>;
         elementInstanceScopeKey: z.ZodOptional<z.ZodString>;
+        $or: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            processDefinitionId: z.ZodOptional<z.ZodString>;
+            state: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+                ACTIVE: "ACTIVE";
+                COMPLETED: "COMPLETED";
+                TERMINATED: "TERMINATED";
+            }>, z.ZodUnion<readonly [z.ZodEnum<{
+                ACTIVE: "ACTIVE";
+                COMPLETED: "COMPLETED";
+                TERMINATED: "TERMINATED";
+            }>, z.ZodObject<{
+                $eq: z.ZodOptional<z.ZodEnum<{
+                    ACTIVE: "ACTIVE";
+                    COMPLETED: "COMPLETED";
+                    TERMINATED: "TERMINATED";
+                }>>;
+                $neq: z.ZodOptional<z.ZodEnum<{
+                    ACTIVE: "ACTIVE";
+                    COMPLETED: "COMPLETED";
+                    TERMINATED: "TERMINATED";
+                }>>;
+                $exists: z.ZodOptional<z.ZodBoolean>;
+                $in: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                    ACTIVE: "ACTIVE";
+                    COMPLETED: "COMPLETED";
+                    TERMINATED: "TERMINATED";
+                }>>>;
+                $notIn: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                    ACTIVE: "ACTIVE";
+                    COMPLETED: "COMPLETED";
+                    TERMINATED: "TERMINATED";
+                }>>>;
+                $like: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>]>]>>;
+            type: z.ZodOptional<z.ZodEnum<{
+                UNSPECIFIED: "UNSPECIFIED";
+                PROCESS: "PROCESS";
+                SUB_PROCESS: "SUB_PROCESS";
+                EVENT_SUB_PROCESS: "EVENT_SUB_PROCESS";
+                INTERMEDIATE_CATCH_EVENT: "INTERMEDIATE_CATCH_EVENT";
+                INTERMEDIATE_THROW_EVENT: "INTERMEDIATE_THROW_EVENT";
+                BOUNDARY_EVENT: "BOUNDARY_EVENT";
+                SERVICE_TASK: "SERVICE_TASK";
+                RECEIVE_TASK: "RECEIVE_TASK";
+                USER_TASK: "USER_TASK";
+                MANUAL_TASK: "MANUAL_TASK";
+                TASK: "TASK";
+                MULTI_INSTANCE_BODY: "MULTI_INSTANCE_BODY";
+                CALL_ACTIVITY: "CALL_ACTIVITY";
+                BUSINESS_RULE_TASK: "BUSINESS_RULE_TASK";
+                SCRIPT_TASK: "SCRIPT_TASK";
+                SEND_TASK: "SEND_TASK";
+                UNKNOWN: "UNKNOWN";
+                AD_HOC_SUB_PROCESS: "AD_HOC_SUB_PROCESS";
+                AD_HOC_SUB_PROCESS_INNER_INSTANCE: "AD_HOC_SUB_PROCESS_INNER_INSTANCE";
+                START_EVENT: "START_EVENT";
+                END_EVENT: "END_EVENT";
+                EXCLUSIVE_GATEWAY: "EXCLUSIVE_GATEWAY";
+                INCLUSIVE_GATEWAY: "INCLUSIVE_GATEWAY";
+                PARALLEL_GATEWAY: "PARALLEL_GATEWAY";
+                EVENT_BASED_GATEWAY: "EVENT_BASED_GATEWAY";
+                SEQUENCE_FLOW: "SEQUENCE_FLOW";
+            }>>;
+            elementId: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+                $eq: z.ZodOptional<z.ZodString>;
+                $neq: z.ZodOptional<z.ZodString>;
+                $exists: z.ZodOptional<z.ZodBoolean>;
+                $in: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                $notIn: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                $like: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>, z.ZodString]>>;
+            elementName: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+                $eq: z.ZodOptional<z.ZodString>;
+                $neq: z.ZodOptional<z.ZodString>;
+                $exists: z.ZodOptional<z.ZodBoolean>;
+                $in: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                $notIn: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                $like: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>, z.ZodString]>>;
+            hasIncident: z.ZodOptional<z.ZodBoolean>;
+            tenantId: z.ZodOptional<z.ZodString>;
+            elementInstanceKey: z.ZodOptional<z.ZodString>;
+            processInstanceKey: z.ZodOptional<z.ZodString>;
+            processDefinitionKey: z.ZodOptional<z.ZodString>;
+            incidentKey: z.ZodOptional<z.ZodString>;
+            startDate: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+                $eq: z.ZodOptional<z.ZodString>;
+                $neq: z.ZodOptional<z.ZodString>;
+                $exists: z.ZodOptional<z.ZodBoolean>;
+                $gt: z.ZodOptional<z.ZodString>;
+                $gte: z.ZodOptional<z.ZodString>;
+                $lt: z.ZodOptional<z.ZodString>;
+                $lte: z.ZodOptional<z.ZodString>;
+                $in: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            }, z.core.$strip>]>>;
+            endDate: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+                $eq: z.ZodOptional<z.ZodString>;
+                $neq: z.ZodOptional<z.ZodString>;
+                $exists: z.ZodOptional<z.ZodBoolean>;
+                $gt: z.ZodOptional<z.ZodString>;
+                $gte: z.ZodOptional<z.ZodString>;
+                $lt: z.ZodOptional<z.ZodString>;
+                $lte: z.ZodOptional<z.ZodString>;
+                $in: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            }, z.core.$strip>]>>;
+            elementInstanceScopeKey: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
 type QueryElementInstancesRequestBody = z.infer<typeof queryElementInstancesRequestBodySchema>;

package/dist/8.10/element-instance.js

@@ -1,4 +1,4 @@
-import { advancedDateTimeFilterSchema, advancedStringFilterSchema, getEnumFilterSchema, getQueryRequestBodySchema, getQueryResponseBodySchema } from "./common.js";
+import { advancedDateTimeFilterSchema, advancedStringFilterSchema, getEnumFilterSchema, getOrFilterSchema, getQueryRequestBodySchema, getQueryResponseBodySchema } from "./common.js";
 import { queryIncidentsRequestBodySchema, queryIncidentsResponseBodySchema } from "./incident.js";
 import { z } from "zod";
 //#region lib/8.10/element-instance.ts
@@ -83,7 +83,7 @@ var queryElementInstancesRequestBodySchema = getQueryRequestBodySchema({
 		"incidentKey",
 		"tenantId"
 	],
-	filter: elementInstanceFilterSchema
+	filter: getOrFilterSchema(elementInstanceFilterSchema)
 });
 var queryElementInstancesResponseBodySchema = getQueryResponseBodySchema(elementInstanceSchema);
 var queryElementInstances = {

package/dist/8.10/index.d.ts

@@ -527,6 +527,7 @@ declare const endpoints: {
         kind: "AD_HOC_SUB_PROCESS" | "BPMN_ELEMENT" | "EXECUTION_LISTENER" | "TASK_LISTENER";
         listenerEventType: "UNSPECIFIED" | "ASSIGNING" | "UPDATING" | "COMPLETING" | "CANCELING" | "START" | "END" | "CREATING" | "CANCEL";
         retries: number;
+        priority: number;
         isDenied: boolean | null;
         deniedReason: string | null;
         hasFailedWithRetriesLeft: boolean;
@@ -554,6 +555,7 @@ declare const endpoints: {
         kind: "AD_HOC_SUB_PROCESS" | "BPMN_ELEMENT" | "EXECUTION_LISTENER" | "TASK_LISTENER";
         listenerEventType: "UNSPECIFIED" | "ASSIGNING" | "UPDATING" | "COMPLETING" | "CANCELING" | "START" | "END" | "CREATING" | "CANCEL";
         retries: number;
+        priority: number;
         isDenied: boolean | null;
         deniedReason: string | null;
         hasFailedWithRetriesLeft: boolean;
@@ -581,6 +583,7 @@ declare const endpoints: {
         kind: "AD_HOC_SUB_PROCESS" | "BPMN_ELEMENT" | "EXECUTION_LISTENER" | "TASK_LISTENER";
         listenerEventType: "UNSPECIFIED" | "ASSIGNING" | "UPDATING" | "COMPLETING" | "CANCELING" | "START" | "END" | "CREATING" | "CANCEL";
         retries: number;
+        priority: number;
         isDenied: boolean | null;
         deniedReason: string | null;
         hasFailedWithRetriesLeft: boolean;
@@ -608,6 +611,7 @@ declare const endpoints: {
         kind: "AD_HOC_SUB_PROCESS" | "BPMN_ELEMENT" | "EXECUTION_LISTENER" | "TASK_LISTENER";
         listenerEventType: "UNSPECIFIED" | "ASSIGNING" | "UPDATING" | "COMPLETING" | "CANCELING" | "START" | "END" | "CREATING" | "CANCEL";
         retries: number;
+        priority: number;
         isDenied: boolean | null;
         deniedReason: string | null;
         hasFailedWithRetriesLeft: boolean;

package/dist/8.10/job.d.ts

@@ -206,6 +206,7 @@ declare const jobSchema: z.ZodObject<{
         CANCEL: "CANCEL";
     }>;
     retries: z.ZodNumber;
+    priority: z.ZodNumber;
     isDenied: z.ZodNullable<z.ZodBoolean>;
     deniedReason: z.ZodNullable<z.ZodString>;
     hasFailedWithRetriesLeft: z.ZodBoolean;
@@ -240,6 +241,7 @@ declare const queryJobsRequestBodySchema: z.ZodObject<{
             elementInstanceKey: "elementInstanceKey";
             jobKey: "jobKey";
             customHeaders: "customHeaders";
+            priority: "priority";
             kind: "kind";
             listenerEventType: "listenerEventType";
             worker: "worker";
@@ -467,6 +469,16 @@ declare const queryJobsRequestBodySchema: z.ZodObject<{
             $in: z.ZodOptional<z.ZodArray<z.ZodString>>;
             $notIn: z.ZodOptional<z.ZodArray<z.ZodString>>;
         }, z.core.$strip>, z.ZodString]>>;
+        priority: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodObject<{
+            $eq: z.ZodOptional<z.ZodNumber>;
+            $neq: z.ZodOptional<z.ZodNumber>;
+            $exists: z.ZodOptional<z.ZodBoolean>;
+            $gt: z.ZodOptional<z.ZodNumber>;
+            $gte: z.ZodOptional<z.ZodNumber>;
+            $lt: z.ZodOptional<z.ZodNumber>;
+            $lte: z.ZodOptional<z.ZodNumber>;
+            $in: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+        }, z.core.$strip>]>>;
         tenantId: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
             $eq: z.ZodOptional<z.ZodString>;
             $neq: z.ZodOptional<z.ZodString>;
@@ -487,6 +499,7 @@ declare const queryJobsResponseBodySchema: z.ZodType<import('./common').QueryRes
     kind: "AD_HOC_SUB_PROCESS" | "BPMN_ELEMENT" | "EXECUTION_LISTENER" | "TASK_LISTENER";
     listenerEventType: "UNSPECIFIED" | "ASSIGNING" | "UPDATING" | "COMPLETING" | "CANCELING" | "START" | "END" | "CREATING" | "CANCEL";
     retries: number;
+    priority: number;
     isDenied: boolean | null;
     deniedReason: string | null;
     hasFailedWithRetriesLeft: boolean;
@@ -513,6 +526,7 @@ declare const queryJobsResponseBodySchema: z.ZodType<import('./common').QueryRes
     kind: "AD_HOC_SUB_PROCESS" | "BPMN_ELEMENT" | "EXECUTION_LISTENER" | "TASK_LISTENER";
     listenerEventType: "UNSPECIFIED" | "ASSIGNING" | "UPDATING" | "COMPLETING" | "CANCELING" | "START" | "END" | "CREATING" | "CANCEL";
     retries: number;
+    priority: number;
     isDenied: boolean | null;
     deniedReason: string | null;
     hasFailedWithRetriesLeft: boolean;

package/dist/8.10/job.js

@@ -1,4 +1,4 @@
-import { advancedStringFilterSchema, basicStringFilterSchema, getEnumFilterSchema, getQueryRequestBodySchema, getQueryResponseBodySchema } from "./common.js";
+import { advancedIntegerFilterSchema, advancedStringFilterSchema, basicStringFilterSchema, getEnumFilterSchema, getQueryRequestBodySchema, getQueryResponseBodySchema } from "./common.js";
 import { z } from "zod";
 //#region lib/8.10/job.ts
 var jobStateSchema = z.enum([
@@ -39,6 +39,7 @@ var jobSchema = z.object({
 	kind: jobKindSchema,
 	listenerEventType: listenerEventTypeSchema,
 	retries: z.number(),
+	priority: z.number().int(),
 	isDenied: z.boolean().nullable(),
 	deniedReason: z.string().nullable(),
 	hasFailedWithRetriesLeft: z.boolean(),
@@ -67,6 +68,7 @@ var queryJobsRequestBodySchema = getQueryRequestBodySchema({
 		"kind",
 		"listenerEventType",
 		"retries",
+		"priority",
 		"isDenied",
 		"deniedReason",
 		"hasFailedWithRetriesLeft",
@@ -94,6 +96,7 @@ var queryJobsRequestBodySchema = getQueryRequestBodySchema({
 		processInstanceKey: basicStringFilterSchema.optional(),
 		elementId: advancedStringFilterSchema.optional(),
 		elementInstanceKey: basicStringFilterSchema.optional(),
+		priority: advancedIntegerFilterSchema.optional(),
 		tenantId: advancedStringFilterSchema.optional()
 	})
 });

package/dist/8.10/system-configuration.d.ts

@@ -14,9 +14,7 @@ declare const componentsConfigurationSchema: z.ZodObject<{
 }, z.core.$strip>;
 type ComponentsConfiguration = z.infer<typeof componentsConfigurationSchema>;
 declare const deploymentConfigurationSchema: z.ZodObject<{
-    isEnterprise: z.ZodBoolean;
     isMultiTenancyEnabled: z.ZodBoolean;
-    contextPath: z.ZodString;
     maxRequestSize: z.ZodNumber;
 }, z.core.$strip>;
 type DeploymentConfiguration = z.infer<typeof deploymentConfigurationSchema>;
@@ -26,11 +24,7 @@ declare const authenticationConfigurationSchema: z.ZodObject<{
 }, z.core.$strip>;
 type AuthenticationConfiguration = z.infer<typeof authenticationConfigurationSchema>;
 declare const cloudConfigurationSchema: z.ZodObject<{
-    organizationId: z.ZodNullable<z.ZodString>;
-    clusterId: z.ZodNullable<z.ZodString>;
     stage: z.ZodNullable<z.ZodString>;
-    mixpanelToken: z.ZodNullable<z.ZodString>;
-    mixpanelAPIHost: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
 type CloudConfiguration = z.infer<typeof cloudConfigurationSchema>;
 declare const systemConfigurationSchema: z.ZodObject<{
@@ -46,9 +40,7 @@ declare const systemConfigurationSchema: z.ZodObject<{
         active: z.ZodArray<z.ZodString>;
     }, z.core.$strip>;
     deployment: z.ZodObject<{
-        isEnterprise: z.ZodBoolean;
         isMultiTenancyEnabled: z.ZodBoolean;
-        contextPath: z.ZodString;
         maxRequestSize: z.ZodNumber;
     }, z.core.$strip>;
     authentication: z.ZodObject<{
@@ -56,11 +48,7 @@ declare const systemConfigurationSchema: z.ZodObject<{
         isLoginDelegated: z.ZodBoolean;
     }, z.core.$strip>;
     cloud: z.ZodObject<{
-        organizationId: z.ZodNullable<z.ZodString>;
-        clusterId: z.ZodNullable<z.ZodString>;
         stage: z.ZodNullable<z.ZodString>;
-        mixpanelToken: z.ZodNullable<z.ZodString>;
-        mixpanelAPIHost: z.ZodNullable<z.ZodString>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 type SystemConfiguration = z.infer<typeof systemConfigurationSchema>;
@@ -77,9 +65,7 @@ declare const getSystemConfigurationResponseBodySchema: z.ZodObject<{
         active: z.ZodArray<z.ZodString>;
     }, z.core.$strip>;
     deployment: z.ZodObject<{
-        isEnterprise: z.ZodBoolean;
         isMultiTenancyEnabled: z.ZodBoolean;
-        contextPath: z.ZodString;
         maxRequestSize: z.ZodNumber;
     }, z.core.$strip>;
     authentication: z.ZodObject<{
@@ -87,11 +73,7 @@ declare const getSystemConfigurationResponseBodySchema: z.ZodObject<{
         isLoginDelegated: z.ZodBoolean;
     }, z.core.$strip>;
     cloud: z.ZodObject<{
-        organizationId: z.ZodNullable<z.ZodString>;
-        clusterId: z.ZodNullable<z.ZodString>;
         stage: z.ZodNullable<z.ZodString>;
-        mixpanelToken: z.ZodNullable<z.ZodString>;
-        mixpanelAPIHost: z.ZodNullable<z.ZodString>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 type GetSystemConfigurationResponseBody = z.infer<typeof getSystemConfigurationResponseBodySchema>;

package/dist/8.10/system-configuration.js

@@ -10,22 +10,14 @@ var jobMetricsConfigurationSchema = z.object({
 });
 var componentsConfigurationSchema = z.object({ active: z.array(z.string()) });
 var deploymentConfigurationSchema = z.object({
-	isEnterprise: z.boolean(),
 	isMultiTenancyEnabled: z.boolean(),
-	contextPath: z.string(),
 	maxRequestSize: z.number()
 });
 var authenticationConfigurationSchema = z.object({
 	canLogout: z.boolean(),
 	isLoginDelegated: z.boolean()
 });
-var cloudConfigurationSchema = z.object({
-	organizationId: z.string().nullable(),
-	clusterId: z.string().nullable(),
-	stage: z.string().nullable(),
-	mixpanelToken: z.string().nullable(),
-	mixpanelAPIHost: z.string().nullable()
-});
+var cloudConfigurationSchema = z.object({ stage: z.string().nullable() });
 var systemConfigurationSchema = z.object({
 	jobMetrics: jobMetricsConfigurationSchema,
 	components: componentsConfigurationSchema,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@camunda/camunda-api-zod-schemas",
-	"version": "0.0.66",
+	"version": "0.0.68",
 	"license": "LicenseRef-Camunda-1.0",
 	"description": "Zod schemas and TypeScript types for Camunda 8 unified API",
 	"author": "Vinicius Goulart <vinicius.goulart@camunda.com>",
@@ -599,9 +599,9 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"packageManager": "npm@11.14.1",
+	"packageManager": "npm@11.15.0",
 	"devDependencies": {
-		"@types/node": "25.8.0",
+		"@types/node": "25.9.0",
 		"changelogen": "0.6.2",
 		"typescript": "6.0.3",
 		"vite": "8.0.10",