@camunda/camunda-api-zod-schemas 0.0.3 → 0.0.5

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 (7) hide show
  1. package/dist/8.8/batch-operation.js +4 -1
  2. package/dist/8.8/decision-instance.js +7 -7
  3. package/dist/batch-operation.d.ts +11 -2
  4. package/dist/decision-instance.d.ts +13 -13
  5. package/dist/index.d.ts +3 -3
  6. package/dist/process-instance.d.ts +12 -0
  7. package/package.json +1 -1
package/dist/8.8/batch-operation.js CHANGED
@@ -4,7 +4,10 @@ const batchOperationTypeSchema = z.enum([
4
4
  "CANCEL_PROCESS_INSTANCE",
5
5
  "RESOLVE_INCIDENT",
6
6
  "MIGRATE_PROCESS_INSTANCE",
7
- "MODIFY_PROCESS_INSTANCE"
7
+ "MODIFY_PROCESS_INSTANCE",
8
+ "DELETE_DECISION_DEFINITION",
9
+ "DELETE_PROCESS_DEFINITION",
10
+ "DELETE_PROCESS_INSTANCE"
8
11
  ]);
9
12
  const batchOperationStateSchema = z.enum([
10
13
  "CREATED",
package/dist/8.8/decision-instance.js CHANGED
@@ -4,7 +4,7 @@ import { matchedDecisionRuleItemSchema, evaluatedDecisionInputItemSchema } from
4
4
  const decisionDefinitionTypeSchema = z.enum(["DECISION_TABLE", "LITERAL_EXPRESSION", "UNSPECIFIED", "UNKNOWN"]);
5
5
  const decisionInstanceStateSchema = z.enum(["EVALUATED", "FAILED", "UNSPECIFIED", "UNKNOWN"]);
6
6
  const decisionInstanceSchema = z.object({
7
- decisionInstanceId: z.string(),
7
+ decisionEvaluationInstanceKey: z.string(),
8
8
  state: decisionInstanceStateSchema,
9
9
  evaluationDate: z.string(),
10
10
  evaluationFailure: z.string(),
@@ -14,7 +14,7 @@ const decisionInstanceSchema = z.object({
14
14
  decisionDefinitionType: decisionDefinitionTypeSchema,
15
15
  result: z.string(),
16
16
  tenantId: z.string(),
17
- decisionInstanceKey: z.string(),
17
+ decisionEvaluationKey: z.string(),
18
18
  processDefinitionKey: z.string(),
19
19
  processInstanceKey: z.string(),
20
20
  decisionDefinitionKey: z.string(),
@@ -22,8 +22,8 @@ const decisionInstanceSchema = z.object({
22
22
  });
23
23
  const queryDecisionInstancesRequestBodySchema = getQueryRequestBodySchema({
24
24
  sortFields: [
25
- "decisionInstanceKey",
26
- "decisionInstanceId",
25
+ "decisionEvaluationKey",
26
+ "decisionEvaluationInstanceKey",
27
27
  "state",
28
28
  "evaluationDate",
29
29
  "evaluationFailure",
@@ -42,7 +42,7 @@ const queryDecisionInstancesRequestBodySchema = getQueryRequestBodySchema({
42
42
  evaluationDate: advancedDateTimeFilterSchema,
43
43
  decisionDefinitionKey: basicStringFilterSchema,
44
44
  ...decisionInstanceSchema.pick({
45
- decisionInstanceId: true,
45
+ decisionEvaluationInstanceKey: true,
46
46
  state: true,
47
47
  evaluationFailure: true,
48
48
  decisionDefinitionId: true,
@@ -50,7 +50,7 @@ const queryDecisionInstancesRequestBodySchema = getQueryRequestBodySchema({
50
50
  decisionDefinitionVersion: true,
51
51
  decisionDefinitionType: true,
52
52
  tenantId: true,
53
- decisionInstanceKey: true,
53
+ decisionEvaluationKey: true,
54
54
  processDefinitionKey: true,
55
55
  processInstanceKey: true,
56
56
  elementInstanceKey: true
@@ -69,7 +69,7 @@ const queryDecisionInstances = {
69
69
  };
70
70
  const getDecisionInstance = {
71
71
  method: "GET",
72
- getUrl: ({ decisionInstanceId }) => `/${API_VERSION}/decision-instances/${decisionInstanceId}`
72
+ getUrl: ({ decisionEvaluationInstanceKey }) => `/${API_VERSION}/decision-instances/${decisionEvaluationInstanceKey}`
73
73
  };
74
74
  export {
75
75
  decisionDefinitionTypeSchema,
package/dist/batch-operation.d.ts CHANGED
@@ -1,10 +1,13 @@
1
1
  import { z } from 'zod';
2
2
  import { Endpoint } from './common';
3
3
  declare const batchOperationTypeSchema: z.ZodEnum<{
4
+ DELETE_PROCESS_INSTANCE: "DELETE_PROCESS_INSTANCE";
4
5
  CANCEL_PROCESS_INSTANCE: "CANCEL_PROCESS_INSTANCE";
5
6
  RESOLVE_INCIDENT: "RESOLVE_INCIDENT";
6
7
  MIGRATE_PROCESS_INSTANCE: "MIGRATE_PROCESS_INSTANCE";
7
8
  MODIFY_PROCESS_INSTANCE: "MODIFY_PROCESS_INSTANCE";
9
+ DELETE_DECISION_DEFINITION: "DELETE_DECISION_DEFINITION";
10
+ DELETE_PROCESS_DEFINITION: "DELETE_PROCESS_DEFINITION";
8
11
  }>;
9
12
  type BatchOperationType = z.infer<typeof batchOperationTypeSchema>;
10
13
  declare const batchOperationStateSchema: z.ZodEnum<{
@@ -38,10 +41,13 @@ declare const batchOperationSchema: z.ZodObject<{
38
41
  FAILED: "FAILED";
39
42
  }>;
40
43
  batchOperationType: z.ZodEnum<{
44
+ DELETE_PROCESS_INSTANCE: "DELETE_PROCESS_INSTANCE";
41
45
  CANCEL_PROCESS_INSTANCE: "CANCEL_PROCESS_INSTANCE";
42
46
  RESOLVE_INCIDENT: "RESOLVE_INCIDENT";
43
47
  MIGRATE_PROCESS_INSTANCE: "MIGRATE_PROCESS_INSTANCE";
44
48
  MODIFY_PROCESS_INSTANCE: "MODIFY_PROCESS_INSTANCE";
49
+ DELETE_DECISION_DEFINITION: "DELETE_DECISION_DEFINITION";
50
+ DELETE_PROCESS_DEFINITION: "DELETE_PROCESS_DEFINITION";
45
51
  }>;
46
52
  startDate: z.ZodOptional<z.ZodString>;
47
53
  endDate: z.ZodOptional<z.ZodString>;
@@ -87,10 +93,13 @@ declare const queryBatchOperationsRequestBodySchema: z.ZodObject<{
87
93
  filter: z.ZodOptional<z.ZodObject<{
88
94
  batchOperationKey: z.ZodOptional<z.ZodString>;
89
95
  operationType: z.ZodOptional<z.ZodEnum<{
96
+ DELETE_PROCESS_INSTANCE: "DELETE_PROCESS_INSTANCE";
90
97
  CANCEL_PROCESS_INSTANCE: "CANCEL_PROCESS_INSTANCE";
91
98
  RESOLVE_INCIDENT: "RESOLVE_INCIDENT";
92
99
  MIGRATE_PROCESS_INSTANCE: "MIGRATE_PROCESS_INSTANCE";
93
100
  MODIFY_PROCESS_INSTANCE: "MODIFY_PROCESS_INSTANCE";
101
+ DELETE_DECISION_DEFINITION: "DELETE_DECISION_DEFINITION";
102
+ DELETE_PROCESS_DEFINITION: "DELETE_PROCESS_DEFINITION";
94
103
  }>>;
95
104
  state: z.ZodOptional<z.ZodEnum<{
96
105
  CREATED: "CREATED";
@@ -108,7 +117,7 @@ type QueryBatchOperationsRequestBody = z.infer<typeof queryBatchOperationsReques
108
117
  declare const queryBatchOperationsResponseBodySchema: z.ZodType<import('./common').QueryResponseBody<{
109
118
  batchOperationKey: string;
110
119
  state: "CREATED" | "ACTIVE" | "SUSPENDED" | "COMPLETED" | "PARTIALLY_COMPLETED" | "CANCELED" | "INCOMPLETED" | "FAILED";
111
- batchOperationType: "CANCEL_PROCESS_INSTANCE" | "RESOLVE_INCIDENT" | "MIGRATE_PROCESS_INSTANCE" | "MODIFY_PROCESS_INSTANCE";
120
+ batchOperationType: "DELETE_PROCESS_INSTANCE" | "CANCEL_PROCESS_INSTANCE" | "RESOLVE_INCIDENT" | "MIGRATE_PROCESS_INSTANCE" | "MODIFY_PROCESS_INSTANCE" | "DELETE_DECISION_DEFINITION" | "DELETE_PROCESS_DEFINITION";
112
121
  operationsTotalCount: number;
113
122
  operationsFailedCount: number;
114
123
  operationsCompletedCount: number;
@@ -117,7 +126,7 @@ declare const queryBatchOperationsResponseBodySchema: z.ZodType<import('./common
117
126
  }>, unknown, z.core.$ZodTypeInternals<import('./common').QueryResponseBody<{
118
127
  batchOperationKey: string;
119
128
  state: "CREATED" | "ACTIVE" | "SUSPENDED" | "COMPLETED" | "PARTIALLY_COMPLETED" | "CANCELED" | "INCOMPLETED" | "FAILED";
120
- batchOperationType: "CANCEL_PROCESS_INSTANCE" | "RESOLVE_INCIDENT" | "MIGRATE_PROCESS_INSTANCE" | "MODIFY_PROCESS_INSTANCE";
129
+ batchOperationType: "DELETE_PROCESS_INSTANCE" | "CANCEL_PROCESS_INSTANCE" | "RESOLVE_INCIDENT" | "MIGRATE_PROCESS_INSTANCE" | "MODIFY_PROCESS_INSTANCE" | "DELETE_DECISION_DEFINITION" | "DELETE_PROCESS_DEFINITION";
121
130
  operationsTotalCount: number;
122
131
  operationsFailedCount: number;
123
132
  operationsCompletedCount: number;
package/dist/decision-instance.d.ts CHANGED
@@ -15,7 +15,7 @@ declare const decisionInstanceStateSchema: z.ZodEnum<{
15
15
  }>;
16
16
  type DecisionInstanceState = z.infer<typeof decisionInstanceStateSchema>;
17
17
  declare const decisionInstanceSchema: z.ZodObject<{
18
- decisionInstanceId: z.ZodString;
18
+ decisionEvaluationInstanceKey: z.ZodString;
19
19
  state: z.ZodEnum<{
20
20
  UNSPECIFIED: "UNSPECIFIED";
21
21
  UNKNOWN: "UNKNOWN";
@@ -35,7 +35,7 @@ declare const decisionInstanceSchema: z.ZodObject<{
35
35
  }>;
36
36
  result: z.ZodString;
37
37
  tenantId: z.ZodString;
38
- decisionInstanceKey: z.ZodString;
38
+ decisionEvaluationKey: z.ZodString;
39
39
  processDefinitionKey: z.ZodString;
40
40
  processInstanceKey: z.ZodString;
41
41
  decisionDefinitionKey: z.ZodString;
@@ -54,10 +54,10 @@ declare const queryDecisionInstancesRequestBodySchema: z.ZodObject<{
54
54
  decisionDefinitionName: "decisionDefinitionName";
55
55
  decisionDefinitionVersion: "decisionDefinitionVersion";
56
56
  decisionDefinitionType: "decisionDefinitionType";
57
- decisionInstanceKey: "decisionInstanceKey";
58
- decisionInstanceId: "decisionInstanceId";
57
+ decisionEvaluationInstanceKey: "decisionEvaluationInstanceKey";
59
58
  evaluationDate: "evaluationDate";
60
59
  evaluationFailure: "evaluationFailure";
60
+ decisionEvaluationKey: "decisionEvaluationKey";
61
61
  elementInstanceKey: "elementInstanceKey";
62
62
  processInstanceId: "processInstanceId";
63
63
  }>;
@@ -91,9 +91,9 @@ declare const queryDecisionInstancesRequestBodySchema: z.ZodObject<{
91
91
  DECISION_TABLE: "DECISION_TABLE";
92
92
  LITERAL_EXPRESSION: "LITERAL_EXPRESSION";
93
93
  }>>;
94
- decisionInstanceKey: z.ZodOptional<z.ZodString>;
95
- decisionInstanceId: z.ZodOptional<z.ZodString>;
94
+ decisionEvaluationInstanceKey: z.ZodOptional<z.ZodString>;
96
95
  evaluationFailure: z.ZodOptional<z.ZodString>;
96
+ decisionEvaluationKey: z.ZodOptional<z.ZodString>;
97
97
  elementInstanceKey: z.ZodOptional<z.ZodString>;
98
98
  evaluationDate: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
99
99
  $eq: z.ZodOptional<z.ZodString>;
@@ -116,7 +116,7 @@ declare const queryDecisionInstancesRequestBodySchema: z.ZodObject<{
116
116
  }, z.core.$strip>;
117
117
  type QueryDecisionInstancesRequestBody = z.infer<typeof queryDecisionInstancesRequestBodySchema>;
118
118
  declare const queryDecisionInstancesResponseBodySchema: z.ZodType<import('./common').QueryResponseBody<{
119
- decisionInstanceId: string;
119
+ decisionEvaluationInstanceKey: string;
120
120
  state: "UNSPECIFIED" | "UNKNOWN" | "FAILED" | "EVALUATED";
121
121
  evaluationDate: string;
122
122
  evaluationFailure: string;
@@ -126,13 +126,13 @@ declare const queryDecisionInstancesResponseBodySchema: z.ZodType<import('./comm
126
126
  decisionDefinitionType: "UNSPECIFIED" | "UNKNOWN" | "DECISION_TABLE" | "LITERAL_EXPRESSION";
127
127
  result: string;
128
128
  tenantId: string;
129
- decisionInstanceKey: string;
129
+ decisionEvaluationKey: string;
130
130
  processDefinitionKey: string;
131
131
  processInstanceKey: string;
132
132
  decisionDefinitionKey: string;
133
133
  elementInstanceKey: string;
134
134
  }>, unknown, z.core.$ZodTypeInternals<import('./common').QueryResponseBody<{
135
- decisionInstanceId: string;
135
+ decisionEvaluationInstanceKey: string;
136
136
  state: "UNSPECIFIED" | "UNKNOWN" | "FAILED" | "EVALUATED";
137
137
  evaluationDate: string;
138
138
  evaluationFailure: string;
@@ -142,7 +142,7 @@ declare const queryDecisionInstancesResponseBodySchema: z.ZodType<import('./comm
142
142
  decisionDefinitionType: "UNSPECIFIED" | "UNKNOWN" | "DECISION_TABLE" | "LITERAL_EXPRESSION";
143
143
  result: string;
144
144
  tenantId: string;
145
- decisionInstanceKey: string;
145
+ decisionEvaluationKey: string;
146
146
  processDefinitionKey: string;
147
147
  processInstanceKey: string;
148
148
  decisionDefinitionKey: string;
@@ -150,7 +150,7 @@ declare const queryDecisionInstancesResponseBodySchema: z.ZodType<import('./comm
150
150
  }>, unknown>>;
151
151
  type QueryDecisionInstancesResponseBody = z.infer<typeof queryDecisionInstancesResponseBodySchema>;
152
152
  declare const getDecisionInstanceResponseBodySchema: z.ZodObject<{
153
- decisionInstanceId: z.ZodString;
153
+ decisionEvaluationInstanceKey: z.ZodString;
154
154
  state: z.ZodEnum<{
155
155
  UNSPECIFIED: "UNSPECIFIED";
156
156
  UNKNOWN: "UNKNOWN";
@@ -170,7 +170,7 @@ declare const getDecisionInstanceResponseBodySchema: z.ZodObject<{
170
170
  }>;
171
171
  result: z.ZodString;
172
172
  tenantId: z.ZodString;
173
- decisionInstanceKey: z.ZodString;
173
+ decisionEvaluationKey: z.ZodString;
174
174
  processDefinitionKey: z.ZodString;
175
175
  processInstanceKey: z.ZodString;
176
176
  decisionDefinitionKey: z.ZodString;
@@ -192,6 +192,6 @@ declare const getDecisionInstanceResponseBodySchema: z.ZodObject<{
192
192
  }, z.core.$strip>;
193
193
  type GetDecisionInstanceResponseBody = z.infer<typeof getDecisionInstanceResponseBodySchema>;
194
194
  declare const queryDecisionInstances: Endpoint;
195
- declare const getDecisionInstance: Endpoint<Pick<DecisionInstance, 'decisionInstanceId'>>;
195
+ declare const getDecisionInstance: Endpoint<Pick<DecisionInstance, 'decisionEvaluationInstanceKey'>>;
196
196
  export { decisionDefinitionTypeSchema, decisionInstanceStateSchema, decisionInstanceSchema, queryDecisionInstancesRequestBodySchema, queryDecisionInstancesResponseBodySchema, getDecisionInstanceResponseBodySchema, queryDecisionInstances, getDecisionInstance, };
197
197
  export type { DecisionDefinitionType, DecisionInstanceState, DecisionInstance, QueryDecisionInstancesRequestBody, QueryDecisionInstancesResponseBody, GetDecisionInstanceResponseBody, };
package/dist/index.d.ts CHANGED
@@ -42,7 +42,7 @@ declare const endpoints: {
42
42
  readonly evaluateDecision: import('./common').Endpoint<undefined>;
43
43
  readonly queryDecisionInstances: import('./common').Endpoint<undefined>;
44
44
  readonly getDecisionInstance: import('./common').Endpoint<Pick<{
45
- decisionInstanceId: string;
45
+ decisionEvaluationInstanceKey: string;
46
46
  state: "UNSPECIFIED" | "UNKNOWN" | "FAILED" | "EVALUATED";
47
47
  evaluationDate: string;
48
48
  evaluationFailure: string;
@@ -52,12 +52,12 @@ declare const endpoints: {
52
52
  decisionDefinitionType: "UNSPECIFIED" | "UNKNOWN" | "DECISION_TABLE" | "LITERAL_EXPRESSION";
53
53
  result: string;
54
54
  tenantId: string;
55
- decisionInstanceKey: string;
55
+ decisionEvaluationKey: string;
56
56
  processDefinitionKey: string;
57
57
  processInstanceKey: string;
58
58
  decisionDefinitionKey: string;
59
59
  elementInstanceKey: string;
60
- }, "decisionInstanceId">>;
60
+ }, "decisionEvaluationInstanceKey">>;
61
61
  readonly queryDecisionRequirements: import('./common').Endpoint<undefined>;
62
62
  readonly getDecisionRequirements: import('./common').Endpoint<Pick<{
63
63
  decisionRequirementsName: string;
package/dist/process-instance.d.ts CHANGED
@@ -791,10 +791,13 @@ type CreateIncidentResolutionBatchOperationRequestBody = z.infer<typeof createIn
791
791
  declare const createIncidentResolutionBatchOperationResponseBodySchema: z.ZodObject<{
792
792
  batchOperationKey: z.ZodString;
793
793
  batchOperationType: z.ZodEnum<{
794
+ DELETE_PROCESS_INSTANCE: "DELETE_PROCESS_INSTANCE";
794
795
  CANCEL_PROCESS_INSTANCE: "CANCEL_PROCESS_INSTANCE";
795
796
  RESOLVE_INCIDENT: "RESOLVE_INCIDENT";
796
797
  MIGRATE_PROCESS_INSTANCE: "MIGRATE_PROCESS_INSTANCE";
797
798
  MODIFY_PROCESS_INSTANCE: "MODIFY_PROCESS_INSTANCE";
799
+ DELETE_DECISION_DEFINITION: "DELETE_DECISION_DEFINITION";
800
+ DELETE_PROCESS_DEFINITION: "DELETE_PROCESS_DEFINITION";
798
801
  }>;
799
802
  }, z.core.$strip>;
800
803
  type CreateIncidentResolutionBatchOperationResponseBody = z.infer<typeof createIncidentResolutionBatchOperationResponseBodySchema>;
@@ -1097,10 +1100,13 @@ type CreateCancellationBatchOperationRequestBody = z.infer<typeof createCancella
1097
1100
  declare const createCancellationBatchOperationResponseBodySchema: z.ZodObject<{
1098
1101
  batchOperationKey: z.ZodString;
1099
1102
  batchOperationType: z.ZodEnum<{
1103
+ DELETE_PROCESS_INSTANCE: "DELETE_PROCESS_INSTANCE";
1100
1104
  CANCEL_PROCESS_INSTANCE: "CANCEL_PROCESS_INSTANCE";
1101
1105
  RESOLVE_INCIDENT: "RESOLVE_INCIDENT";
1102
1106
  MIGRATE_PROCESS_INSTANCE: "MIGRATE_PROCESS_INSTANCE";
1103
1107
  MODIFY_PROCESS_INSTANCE: "MODIFY_PROCESS_INSTANCE";
1108
+ DELETE_DECISION_DEFINITION: "DELETE_DECISION_DEFINITION";
1109
+ DELETE_PROCESS_DEFINITION: "DELETE_PROCESS_DEFINITION";
1104
1110
  }>;
1105
1111
  }, z.core.$strip>;
1106
1112
  type CreateCancellationBatchOperationResponseBody = z.infer<typeof createCancellationBatchOperationResponseBodySchema>;
@@ -1410,10 +1416,13 @@ type CreateMigrationBatchOperationRequestBody = z.infer<typeof createMigrationBa
1410
1416
  declare const createMigrationBatchOperationResponseBodySchema: z.ZodObject<{
1411
1417
  batchOperationKey: z.ZodString;
1412
1418
  batchOperationType: z.ZodEnum<{
1419
+ DELETE_PROCESS_INSTANCE: "DELETE_PROCESS_INSTANCE";
1413
1420
  CANCEL_PROCESS_INSTANCE: "CANCEL_PROCESS_INSTANCE";
1414
1421
  RESOLVE_INCIDENT: "RESOLVE_INCIDENT";
1415
1422
  MIGRATE_PROCESS_INSTANCE: "MIGRATE_PROCESS_INSTANCE";
1416
1423
  MODIFY_PROCESS_INSTANCE: "MODIFY_PROCESS_INSTANCE";
1424
+ DELETE_DECISION_DEFINITION: "DELETE_DECISION_DEFINITION";
1425
+ DELETE_PROCESS_DEFINITION: "DELETE_PROCESS_DEFINITION";
1417
1426
  }>;
1418
1427
  }, z.core.$strip>;
1419
1428
  type CreateMigrationBatchOperationResponseBody = z.infer<typeof createMigrationBatchOperationResponseBodySchema>;
@@ -1720,10 +1729,13 @@ type CreateModificationBatchOperationRequestBody = z.infer<typeof createModifica
1720
1729
  declare const createModificationBatchOperationResponseBodySchema: z.ZodObject<{
1721
1730
  batchOperationKey: z.ZodString;
1722
1731
  batchOperationType: z.ZodEnum<{
1732
+ DELETE_PROCESS_INSTANCE: "DELETE_PROCESS_INSTANCE";
1723
1733
  CANCEL_PROCESS_INSTANCE: "CANCEL_PROCESS_INSTANCE";
1724
1734
  RESOLVE_INCIDENT: "RESOLVE_INCIDENT";
1725
1735
  MIGRATE_PROCESS_INSTANCE: "MIGRATE_PROCESS_INSTANCE";
1726
1736
  MODIFY_PROCESS_INSTANCE: "MODIFY_PROCESS_INSTANCE";
1737
+ DELETE_DECISION_DEFINITION: "DELETE_DECISION_DEFINITION";
1738
+ DELETE_PROCESS_DEFINITION: "DELETE_PROCESS_DEFINITION";
1727
1739
  }>;
1728
1740
  }, z.core.$strip>;
1729
1741
  type CreateModificationBatchOperationResponseBody = z.infer<typeof createModificationBatchOperationResponseBodySchema>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@camunda/camunda-api-zod-schemas",
3
- "version": "0.0.3",
3
+ "version": "0.0.5",
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>",