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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +5 -32
  2. package/dist/8.10/element-instance.d.ts +107 -0
  3. package/dist/8.10/element-instance.js +2 -2
  4. package/dist/8.10/system-configuration.d.ts +0 -18
  5. package/dist/8.10/system-configuration.js +1 -9
  6. package/package.json +3 -3
package/README.md CHANGED
@@ -1,35 +1,8 @@
1
1
  # @camunda/camunda-api-zod-schemas
2
2
 
3
- 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.
3
+ [Zod](https://zod.dev/) schemas and TypeScript types for the Camunda 8
4
+ REST API.
4
5
 
5
- It aims to help developers build robust and type-safe applications when interacting with Camunda 8.
6
-
7
- 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/)
8
-
9
- ## Installation
10
-
11
- You can install the package using your favorite package manager:
12
-
13
- ```bash
14
- # pnpm
15
- pnpm add @camunda/camunda-api-zod-schemas
16
-
17
- # npm
18
- npm install @camunda/camunda-api-zod-schemas
19
-
20
- # yarn
21
- yarn add @camunda/camunda-api-zod-schemas
22
- ```
23
-
24
- ## Usage
25
-
26
- 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`.
27
-
28
- Refer to the exported members from `lib/8.8/index.ts` and other files in the `lib` directory for available schemas and types.
29
-
30
- ## Publishing a new version
31
-
32
- 1. Increment the version in `package.json`, dependency-versions in the npm workspace packages, run `npm i`, and push changes to `main`.
33
- 2. Run the [Publish Zod Schemas to npm](https://github.com/camunda/camunda/actions/workflows/publish-zod-schemas.yml) GitHub action.
34
- - By default, the dry-run option is enabled. Uncheck it to publish the new version.
35
- 3. Update the `@camunda/camunda-api-zod-schemas` package versions in Operate, Admin and Tasklist.
6
+ Full documentation — installation, usage, and publishing — lives in
7
+ the Camunda Platform Developer Documentation:
8
+ [Camunda API Zod schemas](https://camunda.github.io/camunda/frontend/camunda-api-zod-schemas/).
package/dist/8.10/element-instance.d.ts CHANGED
@@ -325,6 +325,113 @@ declare const queryElementInstancesRequestBodySchema: z.ZodObject<{
325
325
  $in: z.ZodOptional<z.ZodArray<z.ZodString>>;
326
326
  }, z.core.$strip>]>>;
327
327
  elementInstanceScopeKey: z.ZodOptional<z.ZodString>;
328
+ $or: z.ZodOptional<z.ZodArray<z.ZodObject<{
329
+ processDefinitionId: z.ZodOptional<z.ZodString>;
330
+ state: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
331
+ ACTIVE: "ACTIVE";
332
+ COMPLETED: "COMPLETED";
333
+ TERMINATED: "TERMINATED";
334
+ }>, z.ZodUnion<readonly [z.ZodEnum<{
335
+ ACTIVE: "ACTIVE";
336
+ COMPLETED: "COMPLETED";
337
+ TERMINATED: "TERMINATED";
338
+ }>, z.ZodObject<{
339
+ $eq: z.ZodOptional<z.ZodEnum<{
340
+ ACTIVE: "ACTIVE";
341
+ COMPLETED: "COMPLETED";
342
+ TERMINATED: "TERMINATED";
343
+ }>>;
344
+ $neq: z.ZodOptional<z.ZodEnum<{
345
+ ACTIVE: "ACTIVE";
346
+ COMPLETED: "COMPLETED";
347
+ TERMINATED: "TERMINATED";
348
+ }>>;
349
+ $exists: z.ZodOptional<z.ZodBoolean>;
350
+ $in: z.ZodOptional<z.ZodArray<z.ZodEnum<{
351
+ ACTIVE: "ACTIVE";
352
+ COMPLETED: "COMPLETED";
353
+ TERMINATED: "TERMINATED";
354
+ }>>>;
355
+ $notIn: z.ZodOptional<z.ZodArray<z.ZodEnum<{
356
+ ACTIVE: "ACTIVE";
357
+ COMPLETED: "COMPLETED";
358
+ TERMINATED: "TERMINATED";
359
+ }>>>;
360
+ $like: z.ZodOptional<z.ZodString>;
361
+ }, z.core.$strip>]>]>>;
362
+ type: z.ZodOptional<z.ZodEnum<{
363
+ UNSPECIFIED: "UNSPECIFIED";
364
+ PROCESS: "PROCESS";
365
+ SUB_PROCESS: "SUB_PROCESS";
366
+ EVENT_SUB_PROCESS: "EVENT_SUB_PROCESS";
367
+ INTERMEDIATE_CATCH_EVENT: "INTERMEDIATE_CATCH_EVENT";
368
+ INTERMEDIATE_THROW_EVENT: "INTERMEDIATE_THROW_EVENT";
369
+ BOUNDARY_EVENT: "BOUNDARY_EVENT";
370
+ SERVICE_TASK: "SERVICE_TASK";
371
+ RECEIVE_TASK: "RECEIVE_TASK";
372
+ USER_TASK: "USER_TASK";
373
+ MANUAL_TASK: "MANUAL_TASK";
374
+ TASK: "TASK";
375
+ MULTI_INSTANCE_BODY: "MULTI_INSTANCE_BODY";
376
+ CALL_ACTIVITY: "CALL_ACTIVITY";
377
+ BUSINESS_RULE_TASK: "BUSINESS_RULE_TASK";
378
+ SCRIPT_TASK: "SCRIPT_TASK";
379
+ SEND_TASK: "SEND_TASK";
380
+ UNKNOWN: "UNKNOWN";
381
+ AD_HOC_SUB_PROCESS: "AD_HOC_SUB_PROCESS";
382
+ AD_HOC_SUB_PROCESS_INNER_INSTANCE: "AD_HOC_SUB_PROCESS_INNER_INSTANCE";
383
+ START_EVENT: "START_EVENT";
384
+ END_EVENT: "END_EVENT";
385
+ EXCLUSIVE_GATEWAY: "EXCLUSIVE_GATEWAY";
386
+ INCLUSIVE_GATEWAY: "INCLUSIVE_GATEWAY";
387
+ PARALLEL_GATEWAY: "PARALLEL_GATEWAY";
388
+ EVENT_BASED_GATEWAY: "EVENT_BASED_GATEWAY";
389
+ SEQUENCE_FLOW: "SEQUENCE_FLOW";
390
+ }>>;
391
+ elementId: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
392
+ $eq: z.ZodOptional<z.ZodString>;
393
+ $neq: z.ZodOptional<z.ZodString>;
394
+ $exists: z.ZodOptional<z.ZodBoolean>;
395
+ $in: z.ZodOptional<z.ZodArray<z.ZodString>>;
396
+ $notIn: z.ZodOptional<z.ZodArray<z.ZodString>>;
397
+ $like: z.ZodOptional<z.ZodString>;
398
+ }, z.core.$strip>, z.ZodString]>>;
399
+ elementName: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
400
+ $eq: z.ZodOptional<z.ZodString>;
401
+ $neq: z.ZodOptional<z.ZodString>;
402
+ $exists: z.ZodOptional<z.ZodBoolean>;
403
+ $in: z.ZodOptional<z.ZodArray<z.ZodString>>;
404
+ $notIn: z.ZodOptional<z.ZodArray<z.ZodString>>;
405
+ $like: z.ZodOptional<z.ZodString>;
406
+ }, z.core.$strip>, z.ZodString]>>;
407
+ hasIncident: z.ZodOptional<z.ZodBoolean>;
408
+ tenantId: z.ZodOptional<z.ZodString>;
409
+ elementInstanceKey: z.ZodOptional<z.ZodString>;
410
+ processInstanceKey: z.ZodOptional<z.ZodString>;
411
+ processDefinitionKey: z.ZodOptional<z.ZodString>;
412
+ incidentKey: z.ZodOptional<z.ZodString>;
413
+ startDate: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
414
+ $eq: z.ZodOptional<z.ZodString>;
415
+ $neq: z.ZodOptional<z.ZodString>;
416
+ $exists: z.ZodOptional<z.ZodBoolean>;
417
+ $gt: z.ZodOptional<z.ZodString>;
418
+ $gte: z.ZodOptional<z.ZodString>;
419
+ $lt: z.ZodOptional<z.ZodString>;
420
+ $lte: z.ZodOptional<z.ZodString>;
421
+ $in: z.ZodOptional<z.ZodArray<z.ZodString>>;
422
+ }, z.core.$strip>]>>;
423
+ endDate: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
424
+ $eq: z.ZodOptional<z.ZodString>;
425
+ $neq: z.ZodOptional<z.ZodString>;
426
+ $exists: z.ZodOptional<z.ZodBoolean>;
427
+ $gt: z.ZodOptional<z.ZodString>;
428
+ $gte: z.ZodOptional<z.ZodString>;
429
+ $lt: z.ZodOptional<z.ZodString>;
430
+ $lte: z.ZodOptional<z.ZodString>;
431
+ $in: z.ZodOptional<z.ZodArray<z.ZodString>>;
432
+ }, z.core.$strip>]>>;
433
+ elementInstanceScopeKey: z.ZodOptional<z.ZodString>;
434
+ }, z.core.$strip>>>;
328
435
  }, z.core.$strip>>;
329
436
  }, z.core.$strip>;
330
437
  type QueryElementInstancesRequestBody = z.infer<typeof queryElementInstancesRequestBodySchema>;
package/dist/8.10/element-instance.js CHANGED
@@ -1,4 +1,4 @@
1
- import { advancedDateTimeFilterSchema, advancedStringFilterSchema, getEnumFilterSchema, getQueryRequestBodySchema, getQueryResponseBodySchema } from "./common.js";
1
+ import { advancedDateTimeFilterSchema, advancedStringFilterSchema, getEnumFilterSchema, getOrFilterSchema, getQueryRequestBodySchema, getQueryResponseBodySchema } from "./common.js";
2
2
  import { queryIncidentsRequestBodySchema, queryIncidentsResponseBodySchema } from "./incident.js";
3
3
  import { z } from "zod";
4
4
  //#region lib/8.10/element-instance.ts
@@ -83,7 +83,7 @@ var queryElementInstancesRequestBodySchema = getQueryRequestBodySchema({
83
83
  "incidentKey",
84
84
  "tenantId"
85
85
  ],
86
- filter: elementInstanceFilterSchema
86
+ filter: getOrFilterSchema(elementInstanceFilterSchema)
87
87
  });
88
88
  var queryElementInstancesResponseBodySchema = getQueryResponseBodySchema(elementInstanceSchema);
89
89
  var queryElementInstances = {
package/dist/8.10/system-configuration.d.ts CHANGED
@@ -14,9 +14,7 @@ declare const componentsConfigurationSchema: z.ZodObject<{
14
14
  }, z.core.$strip>;
15
15
  type ComponentsConfiguration = z.infer<typeof componentsConfigurationSchema>;
16
16
  declare const deploymentConfigurationSchema: z.ZodObject<{
17
- isEnterprise: z.ZodBoolean;
18
17
  isMultiTenancyEnabled: z.ZodBoolean;
19
- contextPath: z.ZodString;
20
18
  maxRequestSize: z.ZodNumber;
21
19
  }, z.core.$strip>;
22
20
  type DeploymentConfiguration = z.infer<typeof deploymentConfigurationSchema>;
@@ -26,11 +24,7 @@ declare const authenticationConfigurationSchema: z.ZodObject<{
26
24
  }, z.core.$strip>;
27
25
  type AuthenticationConfiguration = z.infer<typeof authenticationConfigurationSchema>;
28
26
  declare const cloudConfigurationSchema: z.ZodObject<{
29
- organizationId: z.ZodNullable<z.ZodString>;
30
- clusterId: z.ZodNullable<z.ZodString>;
31
27
  stage: z.ZodNullable<z.ZodString>;
32
- mixpanelToken: z.ZodNullable<z.ZodString>;
33
- mixpanelAPIHost: z.ZodNullable<z.ZodString>;
34
28
  }, z.core.$strip>;
35
29
  type CloudConfiguration = z.infer<typeof cloudConfigurationSchema>;
36
30
  declare const systemConfigurationSchema: z.ZodObject<{
@@ -46,9 +40,7 @@ declare const systemConfigurationSchema: z.ZodObject<{
46
40
  active: z.ZodArray<z.ZodString>;
47
41
  }, z.core.$strip>;
48
42
  deployment: z.ZodObject<{
49
- isEnterprise: z.ZodBoolean;
50
43
  isMultiTenancyEnabled: z.ZodBoolean;
51
- contextPath: z.ZodString;
52
44
  maxRequestSize: z.ZodNumber;
53
45
  }, z.core.$strip>;
54
46
  authentication: z.ZodObject<{
@@ -56,11 +48,7 @@ declare const systemConfigurationSchema: z.ZodObject<{
56
48
  isLoginDelegated: z.ZodBoolean;
57
49
  }, z.core.$strip>;
58
50
  cloud: z.ZodObject<{
59
- organizationId: z.ZodNullable<z.ZodString>;
60
- clusterId: z.ZodNullable<z.ZodString>;
61
51
  stage: z.ZodNullable<z.ZodString>;
62
- mixpanelToken: z.ZodNullable<z.ZodString>;
63
- mixpanelAPIHost: z.ZodNullable<z.ZodString>;
64
52
  }, z.core.$strip>;
65
53
  }, z.core.$strip>;
66
54
  type SystemConfiguration = z.infer<typeof systemConfigurationSchema>;
@@ -77,9 +65,7 @@ declare const getSystemConfigurationResponseBodySchema: z.ZodObject<{
77
65
  active: z.ZodArray<z.ZodString>;
78
66
  }, z.core.$strip>;
79
67
  deployment: z.ZodObject<{
80
- isEnterprise: z.ZodBoolean;
81
68
  isMultiTenancyEnabled: z.ZodBoolean;
82
- contextPath: z.ZodString;
83
69
  maxRequestSize: z.ZodNumber;
84
70
  }, z.core.$strip>;
85
71
  authentication: z.ZodObject<{
@@ -87,11 +73,7 @@ declare const getSystemConfigurationResponseBodySchema: z.ZodObject<{
87
73
  isLoginDelegated: z.ZodBoolean;
88
74
  }, z.core.$strip>;
89
75
  cloud: z.ZodObject<{
90
- organizationId: z.ZodNullable<z.ZodString>;
91
- clusterId: z.ZodNullable<z.ZodString>;
92
76
  stage: z.ZodNullable<z.ZodString>;
93
- mixpanelToken: z.ZodNullable<z.ZodString>;
94
- mixpanelAPIHost: z.ZodNullable<z.ZodString>;
95
77
  }, z.core.$strip>;
96
78
  }, z.core.$strip>;
97
79
  type GetSystemConfigurationResponseBody = z.infer<typeof getSystemConfigurationResponseBodySchema>;
package/dist/8.10/system-configuration.js CHANGED
@@ -10,22 +10,14 @@ var jobMetricsConfigurationSchema = z.object({
10
10
  });
11
11
  var componentsConfigurationSchema = z.object({ active: z.array(z.string()) });
12
12
  var deploymentConfigurationSchema = z.object({
13
- isEnterprise: z.boolean(),
14
13
  isMultiTenancyEnabled: z.boolean(),
15
- contextPath: z.string(),
16
14
  maxRequestSize: z.number()
17
15
  });
18
16
  var authenticationConfigurationSchema = z.object({
19
17
  canLogout: z.boolean(),
20
18
  isLoginDelegated: z.boolean()
21
19
  });
22
- var cloudConfigurationSchema = z.object({
23
- organizationId: z.string().nullable(),
24
- clusterId: z.string().nullable(),
25
- stage: z.string().nullable(),
26
- mixpanelToken: z.string().nullable(),
27
- mixpanelAPIHost: z.string().nullable()
28
- });
20
+ var cloudConfigurationSchema = z.object({ stage: z.string().nullable() });
29
21
  var systemConfigurationSchema = z.object({
30
22
  jobMetrics: jobMetricsConfigurationSchema,
31
23
  components: componentsConfigurationSchema,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@camunda/camunda-api-zod-schemas",
3
- "version": "0.0.66",
3
+ "version": "0.0.67",
4
4
  "license": "LicenseRef-Camunda-1.0",
5
5
  "description": "Zod schemas and TypeScript types for Camunda 8 unified API",
6
6
  "author": "Vinicius Goulart <vinicius.goulart@camunda.com>",
@@ -599,9 +599,9 @@
599
599
  "publishConfig": {
600
600
  "access": "public"
601
601
  },
602
- "packageManager": "npm@11.14.1",
602
+ "packageManager": "npm@11.15.0",
603
603
  "devDependencies": {
604
- "@types/node": "25.8.0",
604
+ "@types/node": "25.9.0",
605
605
  "changelogen": "0.6.2",
606
606
  "typescript": "6.0.3",
607
607
  "vite": "8.0.10",