@camunda/camunda-api-zod-schemas 0.0.2 → 0.0.4
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.
|
@@ -11,16 +11,17 @@ const batchOperationStateSchema = z.enum([
|
|
|
11
11
|
"ACTIVE",
|
|
12
12
|
"SUSPENDED",
|
|
13
13
|
"COMPLETED",
|
|
14
|
-
"
|
|
14
|
+
"PARTIALLY_COMPLETED",
|
|
15
15
|
"CANCELED",
|
|
16
|
-
"INCOMPLETED"
|
|
16
|
+
"INCOMPLETED",
|
|
17
|
+
"FAILED"
|
|
17
18
|
]);
|
|
18
19
|
const batchOperationItemStateSchema = z.enum(["ACTIVE", "COMPLETED", "CANCELED", "FAILED"]);
|
|
19
20
|
const batchOperationSchema = z.object({
|
|
20
21
|
batchOperationKey: z.string(),
|
|
21
22
|
state: batchOperationStateSchema,
|
|
22
23
|
batchOperationType: batchOperationTypeSchema,
|
|
23
|
-
startDate: z.string(),
|
|
24
|
+
startDate: z.string().optional(),
|
|
24
25
|
endDate: z.string().optional(),
|
|
25
26
|
operationsTotalCount: z.number().int(),
|
|
26
27
|
operationsFailedCount: z.number().int(),
|
|
@@ -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
|
-
|
|
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
|
-
|
|
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
|
-
"
|
|
26
|
-
"
|
|
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
|
-
|
|
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
|
-
|
|
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: ({
|
|
72
|
+
getUrl: ({ decisionEvaluationInstanceKey }) => `/${API_VERSION}/decision-instances/${decisionEvaluationInstanceKey}`
|
|
73
73
|
};
|
|
74
74
|
export {
|
|
75
75
|
decisionDefinitionTypeSchema,
|
|
@@ -12,9 +12,10 @@ declare const batchOperationStateSchema: z.ZodEnum<{
|
|
|
12
12
|
ACTIVE: "ACTIVE";
|
|
13
13
|
SUSPENDED: "SUSPENDED";
|
|
14
14
|
COMPLETED: "COMPLETED";
|
|
15
|
-
|
|
15
|
+
PARTIALLY_COMPLETED: "PARTIALLY_COMPLETED";
|
|
16
16
|
CANCELED: "CANCELED";
|
|
17
17
|
INCOMPLETED: "INCOMPLETED";
|
|
18
|
+
FAILED: "FAILED";
|
|
18
19
|
}>;
|
|
19
20
|
type BatchOperationState = z.infer<typeof batchOperationStateSchema>;
|
|
20
21
|
declare const batchOperationItemStateSchema: z.ZodEnum<{
|
|
@@ -31,9 +32,10 @@ declare const batchOperationSchema: z.ZodObject<{
|
|
|
31
32
|
ACTIVE: "ACTIVE";
|
|
32
33
|
SUSPENDED: "SUSPENDED";
|
|
33
34
|
COMPLETED: "COMPLETED";
|
|
34
|
-
|
|
35
|
+
PARTIALLY_COMPLETED: "PARTIALLY_COMPLETED";
|
|
35
36
|
CANCELED: "CANCELED";
|
|
36
37
|
INCOMPLETED: "INCOMPLETED";
|
|
38
|
+
FAILED: "FAILED";
|
|
37
39
|
}>;
|
|
38
40
|
batchOperationType: z.ZodEnum<{
|
|
39
41
|
CANCEL_PROCESS_INSTANCE: "CANCEL_PROCESS_INSTANCE";
|
|
@@ -41,7 +43,7 @@ declare const batchOperationSchema: z.ZodObject<{
|
|
|
41
43
|
MIGRATE_PROCESS_INSTANCE: "MIGRATE_PROCESS_INSTANCE";
|
|
42
44
|
MODIFY_PROCESS_INSTANCE: "MODIFY_PROCESS_INSTANCE";
|
|
43
45
|
}>;
|
|
44
|
-
startDate: z.ZodString
|
|
46
|
+
startDate: z.ZodOptional<z.ZodString>;
|
|
45
47
|
endDate: z.ZodOptional<z.ZodString>;
|
|
46
48
|
operationsTotalCount: z.ZodNumber;
|
|
47
49
|
operationsFailedCount: z.ZodNumber;
|
|
@@ -95,30 +97,31 @@ declare const queryBatchOperationsRequestBodySchema: z.ZodObject<{
|
|
|
95
97
|
ACTIVE: "ACTIVE";
|
|
96
98
|
SUSPENDED: "SUSPENDED";
|
|
97
99
|
COMPLETED: "COMPLETED";
|
|
98
|
-
|
|
100
|
+
PARTIALLY_COMPLETED: "PARTIALLY_COMPLETED";
|
|
99
101
|
CANCELED: "CANCELED";
|
|
100
102
|
INCOMPLETED: "INCOMPLETED";
|
|
103
|
+
FAILED: "FAILED";
|
|
101
104
|
}>>;
|
|
102
105
|
}, z.core.$strip>>;
|
|
103
106
|
}, z.core.$strip>;
|
|
104
107
|
type QueryBatchOperationsRequestBody = z.infer<typeof queryBatchOperationsRequestBodySchema>;
|
|
105
108
|
declare const queryBatchOperationsResponseBodySchema: z.ZodType<import('./common').QueryResponseBody<{
|
|
106
109
|
batchOperationKey: string;
|
|
107
|
-
state: "CREATED" | "ACTIVE" | "SUSPENDED" | "COMPLETED" | "
|
|
110
|
+
state: "CREATED" | "ACTIVE" | "SUSPENDED" | "COMPLETED" | "PARTIALLY_COMPLETED" | "CANCELED" | "INCOMPLETED" | "FAILED";
|
|
108
111
|
batchOperationType: "CANCEL_PROCESS_INSTANCE" | "RESOLVE_INCIDENT" | "MIGRATE_PROCESS_INSTANCE" | "MODIFY_PROCESS_INSTANCE";
|
|
109
|
-
startDate: string;
|
|
110
112
|
operationsTotalCount: number;
|
|
111
113
|
operationsFailedCount: number;
|
|
112
114
|
operationsCompletedCount: number;
|
|
115
|
+
startDate?: string | undefined;
|
|
113
116
|
endDate?: string | undefined;
|
|
114
117
|
}>, unknown, z.core.$ZodTypeInternals<import('./common').QueryResponseBody<{
|
|
115
118
|
batchOperationKey: string;
|
|
116
|
-
state: "CREATED" | "ACTIVE" | "SUSPENDED" | "COMPLETED" | "
|
|
119
|
+
state: "CREATED" | "ACTIVE" | "SUSPENDED" | "COMPLETED" | "PARTIALLY_COMPLETED" | "CANCELED" | "INCOMPLETED" | "FAILED";
|
|
117
120
|
batchOperationType: "CANCEL_PROCESS_INSTANCE" | "RESOLVE_INCIDENT" | "MIGRATE_PROCESS_INSTANCE" | "MODIFY_PROCESS_INSTANCE";
|
|
118
|
-
startDate: string;
|
|
119
121
|
operationsTotalCount: number;
|
|
120
122
|
operationsFailedCount: number;
|
|
121
123
|
operationsCompletedCount: number;
|
|
124
|
+
startDate?: string | undefined;
|
|
122
125
|
endDate?: string | undefined;
|
|
123
126
|
}>, unknown>>;
|
|
124
127
|
type QueryBatchOperationsResponseBody = z.infer<typeof queryBatchOperationsResponseBodySchema>;
|
|
@@ -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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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, '
|
|
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
|
-
|
|
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
|
-
|
|
55
|
+
decisionEvaluationKey: string;
|
|
56
56
|
processDefinitionKey: string;
|
|
57
57
|
processInstanceKey: string;
|
|
58
58
|
decisionDefinitionKey: string;
|
|
59
59
|
elementInstanceKey: string;
|
|
60
|
-
}, "
|
|
60
|
+
}, "decisionEvaluationInstanceKey">>;
|
|
61
61
|
readonly queryDecisionRequirements: import('./common').Endpoint<undefined>;
|
|
62
62
|
readonly getDecisionRequirements: import('./common').Endpoint<Pick<{
|
|
63
63
|
decisionRequirementsName: string;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@camunda/camunda-api-zod-schemas",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.4",
|
|
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>",
|
|
@@ -203,12 +203,12 @@
|
|
|
203
203
|
"publishConfig": {
|
|
204
204
|
"access": "public"
|
|
205
205
|
},
|
|
206
|
-
"packageManager": "npm@11.
|
|
206
|
+
"packageManager": "npm@11.6.0",
|
|
207
207
|
"devDependencies": {
|
|
208
208
|
"@types/node": "24.3.0",
|
|
209
209
|
"changelogen": "0.6.2",
|
|
210
210
|
"typescript": "5.9.2",
|
|
211
|
-
"vite": "7.1.
|
|
211
|
+
"vite": "7.1.5",
|
|
212
212
|
"vite-plugin-circular-dependency": "0.5.0",
|
|
213
213
|
"vite-plugin-dts": "4.5.4",
|
|
214
214
|
"zod": "^4.0.17"
|