@camunda/camunda-api-zod-schemas 0.0.1
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.
- package/README.md +28 -0
- package/dist/8.8/ad-hoc-sub-process.d.ts +2 -0
- package/dist/8.8/ad-hoc-sub-process.js +67 -0
- package/dist/8.8/authentication.d.ts +2 -0
- package/dist/8.8/authentication.js +35 -0
- package/dist/8.8/authorization.d.ts +2 -0
- package/dist/8.8/authorization.js +113 -0
- package/dist/8.8/batch-operation.d.ts +2 -0
- package/dist/8.8/batch-operation.js +96 -0
- package/dist/8.8/clock.d.ts +2 -0
- package/dist/8.8/clock.js +18 -0
- package/dist/8.8/cluster.d.ts +2 -0
- package/dist/8.8/cluster.js +36 -0
- package/dist/8.8/decision-definition.d.ts +2 -0
- package/dist/8.8/decision-definition.js +103 -0
- package/dist/8.8/decision-instance.d.ts +2 -0
- package/dist/8.8/decision-instance.js +83 -0
- package/dist/8.8/decision-requirements.d.ts +2 -0
- package/dist/8.8/decision-requirements.js +43 -0
- package/dist/8.8/document.d.ts +2 -0
- package/dist/8.8/document.js +110 -0
- package/dist/8.8/element-instance.d.ts +2 -0
- package/dist/8.8/element-instance.js +116 -0
- package/dist/8.8/group.d.ts +2 -0
- package/dist/8.8/group.js +188 -0
- package/dist/8.8/incident.d.ts +2 -0
- package/dist/8.8/incident.js +91 -0
- package/dist/8.8/index.d.ts +2 -0
- package/dist/8.8/index.js +240 -0
- package/dist/8.8/job.d.ts +2 -0
- package/dist/8.8/job.js +211 -0
- package/dist/8.8/license.d.ts +2 -0
- package/dist/8.8/license.js +16 -0
- package/dist/8.8/mapping-rule.d.ts +2 -0
- package/dist/8.8/mapping-rule.js +73 -0
- package/dist/8.8/message.d.ts +2 -0
- package/dist/8.8/message.js +45 -0
- package/dist/8.8/process-definition.d.ts +2 -0
- package/dist/8.8/process-definition.js +92 -0
- package/dist/8.8/process-instance.d.ts +2 -0
- package/dist/8.8/process-instance.js +255 -0
- package/dist/8.8/resource.d.ts +2 -0
- package/dist/8.8/resource.js +107 -0
- package/dist/8.8/role.d.ts +2 -0
- package/dist/8.8/role.js +202 -0
- package/dist/8.8/signal.d.ts +2 -0
- package/dist/8.8/signal.js +22 -0
- package/dist/8.8/tenant.d.ts +2 -0
- package/dist/8.8/tenant.js +173 -0
- package/dist/8.8/usage-metrics.d.ts +2 -0
- package/dist/8.8/usage-metrics.js +20 -0
- package/dist/8.8/user-task.d.ts +2 -0
- package/dist/8.8/user-task.js +161 -0
- package/dist/8.8/user.d.ts +2 -0
- package/dist/8.8/user.js +77 -0
- package/dist/8.8/variable.d.ts +2 -0
- package/dist/8.8/variable.js +41 -0
- package/dist/8.8.d.ts +2 -0
- package/dist/8.8.js +411 -0
- package/dist/ad-hoc-sub-process.d.ts +100 -0
- package/dist/authentication.d.ts +27 -0
- package/dist/authorization.d.ts +320 -0
- package/dist/batch-operation.d.ts +188 -0
- package/dist/clock.d.ts +10 -0
- package/dist/cluster.d.ts +78 -0
- package/dist/common.d.ts +118 -0
- package/dist/common.js +131 -0
- package/dist/decision-definition.d.ts +165 -0
- package/dist/decision-instance.d.ts +197 -0
- package/dist/decision-requirements.d.ts +64 -0
- package/dist/document.d.ts +87 -0
- package/dist/element-instance.d.ts +342 -0
- package/dist/group-role.d.ts +15 -0
- package/dist/group-role.js +15 -0
- package/dist/group.d.ts +209 -0
- package/dist/incident.d.ts +301 -0
- package/dist/index.d.ts +1025 -0
- package/dist/job.d.ts +588 -0
- package/dist/license.d.ts +12 -0
- package/dist/mapping-rule.d.ts +82 -0
- package/dist/message.d.ts +33 -0
- package/dist/process-definition.d.ts +345 -0
- package/dist/process-instance.d.ts +1306 -0
- package/dist/processes.d.ts +49 -0
- package/dist/processes.js +40 -0
- package/dist/resource.d.ts +111 -0
- package/dist/role.d.ts +207 -0
- package/dist/signal.d.ts +16 -0
- package/dist/tenant.d.ts +266 -0
- package/dist/usage-metrics.d.ts +21 -0
- package/dist/user-task.d.ts +357 -0
- package/dist/user.d.ts +91 -0
- package/dist/variable.d.ts +102 -0
- package/package.json +220 -0
package/README.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# @camunda/camunda-api-zod-schemas
|
|
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.
|
|
4
|
+
|
|
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.
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { getCollectionResponseBodySchema, API_VERSION } from "../common.js";
|
|
3
|
+
const activityTypeSchema = z.enum([
|
|
4
|
+
"UNSPECIFIED",
|
|
5
|
+
"PROCESS",
|
|
6
|
+
"SUB_PROCESS",
|
|
7
|
+
"EVENT_SUB_PROCESS",
|
|
8
|
+
"INTERMEDIATE_CATCH_EVENT",
|
|
9
|
+
"INTERMEDIATE_THROW_EVENT",
|
|
10
|
+
"BOUNDARY_EVENT",
|
|
11
|
+
"SERVICE_TASK",
|
|
12
|
+
"RECEIVE_TASK",
|
|
13
|
+
"USER_TASK",
|
|
14
|
+
"MANUAL_TASK",
|
|
15
|
+
"TASK",
|
|
16
|
+
"MULTI_INSTANCE_BODY",
|
|
17
|
+
"CALL_ACTIVITY",
|
|
18
|
+
"BUSINESS_RULE_TASK",
|
|
19
|
+
"SCRIPT_TASK",
|
|
20
|
+
"SEND_TASK",
|
|
21
|
+
"UNKNOWN"
|
|
22
|
+
]);
|
|
23
|
+
const adHocSubProcessActivityFilterSchema = z.object({
|
|
24
|
+
processDefinitionKey: z.string(),
|
|
25
|
+
adHocSubProcessId: z.string()
|
|
26
|
+
});
|
|
27
|
+
const queryActivatableActivitiesRequestBodySchema = z.object({
|
|
28
|
+
filter: adHocSubProcessActivityFilterSchema
|
|
29
|
+
});
|
|
30
|
+
const activatableActivitySchema = z.object({
|
|
31
|
+
processDefinitionKey: z.string(),
|
|
32
|
+
processDefinitionId: z.string(),
|
|
33
|
+
adHocSubProcessId: z.string(),
|
|
34
|
+
elementId: z.string(),
|
|
35
|
+
elementName: z.string(),
|
|
36
|
+
type: activityTypeSchema,
|
|
37
|
+
documentation: z.string(),
|
|
38
|
+
tenantId: z.string()
|
|
39
|
+
});
|
|
40
|
+
const queryActivatableActivitiesResponseBodySchema = getCollectionResponseBodySchema(activatableActivitySchema);
|
|
41
|
+
const activateActivityWithinAdHocSubProcessRequestBodySchema = z.object({
|
|
42
|
+
elementId: z.string()
|
|
43
|
+
});
|
|
44
|
+
const activateActivityWithinAdHocSubProcessResponseBodySchema = z.object({
|
|
45
|
+
elements: z.array(
|
|
46
|
+
z.object({
|
|
47
|
+
elementId: z.string()
|
|
48
|
+
})
|
|
49
|
+
)
|
|
50
|
+
});
|
|
51
|
+
const queryActivatableActivities = {
|
|
52
|
+
method: "POST",
|
|
53
|
+
getUrl: () => `/${API_VERSION}/element-instances/ad-hoc-activities/search`
|
|
54
|
+
};
|
|
55
|
+
const activateAdHocSubProcessActivities = {
|
|
56
|
+
method: "POST",
|
|
57
|
+
getUrl: ({ adHocSubProcessInstanceKey }) => `/${API_VERSION}/element-instances/ad-hoc-activities/${adHocSubProcessInstanceKey}/activation`
|
|
58
|
+
};
|
|
59
|
+
export {
|
|
60
|
+
activateActivityWithinAdHocSubProcessRequestBodySchema,
|
|
61
|
+
activateActivityWithinAdHocSubProcessResponseBodySchema,
|
|
62
|
+
activateAdHocSubProcessActivities,
|
|
63
|
+
activityTypeSchema,
|
|
64
|
+
queryActivatableActivities,
|
|
65
|
+
queryActivatableActivitiesRequestBodySchema,
|
|
66
|
+
queryActivatableActivitiesResponseBodySchema
|
|
67
|
+
};
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { API_VERSION } from "../common.js";
|
|
3
|
+
const currentUserSchema = z.object({
|
|
4
|
+
username: z.string(),
|
|
5
|
+
displayName: z.string(),
|
|
6
|
+
email: z.string(),
|
|
7
|
+
authorizedComponents: z.array(z.string()),
|
|
8
|
+
tenants: z.array(
|
|
9
|
+
z.object({
|
|
10
|
+
key: z.number(),
|
|
11
|
+
tenantId: z.string(),
|
|
12
|
+
name: z.string(),
|
|
13
|
+
description: z.string().optional()
|
|
14
|
+
})
|
|
15
|
+
),
|
|
16
|
+
groups: z.array(z.string()),
|
|
17
|
+
roles: z.array(z.string()),
|
|
18
|
+
salesPlanType: z.string().nullable(),
|
|
19
|
+
c8Links: z.array(
|
|
20
|
+
z.object({
|
|
21
|
+
name: z.string(),
|
|
22
|
+
link: z.string()
|
|
23
|
+
})
|
|
24
|
+
),
|
|
25
|
+
canLogout: z.boolean(),
|
|
26
|
+
apiUser: z.boolean().optional()
|
|
27
|
+
});
|
|
28
|
+
const getCurrentUser = {
|
|
29
|
+
method: "GET",
|
|
30
|
+
getUrl: () => `/${API_VERSION}/authentication/me`
|
|
31
|
+
};
|
|
32
|
+
export {
|
|
33
|
+
currentUserSchema,
|
|
34
|
+
getCurrentUser
|
|
35
|
+
};
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { getQueryRequestBodySchema, getQueryResponseBodySchema, API_VERSION } from "../common.js";
|
|
3
|
+
const permissionTypeSchema = z.enum([
|
|
4
|
+
"ACCESS",
|
|
5
|
+
"CREATE",
|
|
6
|
+
"CREATE_BATCH_OPERATION_CANCEL_PROCESS_INSTANCE",
|
|
7
|
+
"CREATE_BATCH_OPERATION_DELETE_PROCESS_INSTANCE",
|
|
8
|
+
"CREATE_BATCH_OPERATION_MIGRATE_PROCESS_INSTANCE",
|
|
9
|
+
"CREATE_BATCH_OPERATION_MODIFY_PROCESS_INSTANCE",
|
|
10
|
+
"CREATE_BATCH_OPERATION_RESOLVE_INCIDENT",
|
|
11
|
+
"CREATE_BATCH_OPERATION_DELETE_DECISION_INSTANCE",
|
|
12
|
+
"CREATE_BATCH_OPERATION_DELETE_DECISION_DEFINITION",
|
|
13
|
+
"CREATE_BATCH_OPERATION_DELETE_PROCESS_DEFINITION",
|
|
14
|
+
"CREATE_PROCESS_INSTANCE",
|
|
15
|
+
"CREATE_DECISION_INSTANCE",
|
|
16
|
+
"READ",
|
|
17
|
+
"READ_PROCESS_INSTANCE",
|
|
18
|
+
"READ_USER_TASK",
|
|
19
|
+
"READ_DECISION_INSTANCE",
|
|
20
|
+
"READ_PROCESS_DEFINITION",
|
|
21
|
+
"READ_DECISION_DEFINITION",
|
|
22
|
+
"UPDATE",
|
|
23
|
+
"UPDATE_PROCESS_INSTANCE",
|
|
24
|
+
"UPDATE_USER_TASK",
|
|
25
|
+
"DELETE",
|
|
26
|
+
"DELETE_PROCESS",
|
|
27
|
+
"DELETE_DRD",
|
|
28
|
+
"DELETE_FORM",
|
|
29
|
+
"DELETE_RESOURCE",
|
|
30
|
+
"DELETE_PROCESS_INSTANCE",
|
|
31
|
+
"DELETE_DECISION_INSTANCE"
|
|
32
|
+
]);
|
|
33
|
+
const resourceTypeSchema = z.enum([
|
|
34
|
+
"AUTHORIZATION",
|
|
35
|
+
"MAPPING_RULE",
|
|
36
|
+
"MESSAGE",
|
|
37
|
+
"BATCH",
|
|
38
|
+
"BATCH_OPERATION",
|
|
39
|
+
"APPLICATION",
|
|
40
|
+
"SYSTEM",
|
|
41
|
+
"TENANT",
|
|
42
|
+
"RESOURCE",
|
|
43
|
+
"PROCESS_DEFINITION",
|
|
44
|
+
"DECISION_REQUIREMENTS_DEFINITION",
|
|
45
|
+
"DECISION_DEFINITION",
|
|
46
|
+
"GROUP",
|
|
47
|
+
"USER",
|
|
48
|
+
"ROLE"
|
|
49
|
+
]);
|
|
50
|
+
const ownerTypeSchema = z.enum(["USER", "CLIENT", "ROLE", "GROUP", "MAPPING", "UNSPECIFIED"]);
|
|
51
|
+
const authorizationSchema = z.object({
|
|
52
|
+
ownerId: z.string(),
|
|
53
|
+
ownerType: ownerTypeSchema,
|
|
54
|
+
resourceType: resourceTypeSchema,
|
|
55
|
+
resourceId: z.string(),
|
|
56
|
+
permissionTypes: z.array(permissionTypeSchema),
|
|
57
|
+
authorizationKey: z.string()
|
|
58
|
+
});
|
|
59
|
+
const createAuthorizationRequestBodySchema = authorizationSchema.pick({
|
|
60
|
+
ownerId: true,
|
|
61
|
+
ownerType: true,
|
|
62
|
+
resourceType: true,
|
|
63
|
+
resourceId: true,
|
|
64
|
+
permissionTypes: true
|
|
65
|
+
});
|
|
66
|
+
const updateAuthorizationRequestBodySchema = createAuthorizationRequestBodySchema.partial();
|
|
67
|
+
const queryAuthorizationsRequestBodySchema = getQueryRequestBodySchema({
|
|
68
|
+
sortFields: ["ownerId", "ownerType", "resourceId", "resourceType"],
|
|
69
|
+
filter: z.object({
|
|
70
|
+
resourceId: z.array(z.string()),
|
|
71
|
+
...authorizationSchema.pick({
|
|
72
|
+
ownerId: true,
|
|
73
|
+
ownerType: true,
|
|
74
|
+
resourceType: true
|
|
75
|
+
}).shape
|
|
76
|
+
}).partial()
|
|
77
|
+
});
|
|
78
|
+
const queryAuthorizationsResponseBodySchema = getQueryResponseBodySchema(authorizationSchema);
|
|
79
|
+
const createAuthorization = {
|
|
80
|
+
method: "POST",
|
|
81
|
+
getUrl: () => `/${API_VERSION}/authorizations`
|
|
82
|
+
};
|
|
83
|
+
const updateAuthorization = {
|
|
84
|
+
method: "PUT",
|
|
85
|
+
getUrl: ({ authorizationKey }) => `/${API_VERSION}/authorizations/${authorizationKey}`
|
|
86
|
+
};
|
|
87
|
+
const getAuthorization = {
|
|
88
|
+
method: "GET",
|
|
89
|
+
getUrl: ({ authorizationKey }) => `/${API_VERSION}/authorizations/${authorizationKey}`
|
|
90
|
+
};
|
|
91
|
+
const deleteAuthorization = {
|
|
92
|
+
method: "DELETE",
|
|
93
|
+
getUrl: ({ authorizationKey }) => `/${API_VERSION}/authorizations/${authorizationKey}`
|
|
94
|
+
};
|
|
95
|
+
const queryAuthorizations = {
|
|
96
|
+
method: "POST",
|
|
97
|
+
getUrl: () => `/${API_VERSION}/authorizations/search`
|
|
98
|
+
};
|
|
99
|
+
export {
|
|
100
|
+
authorizationSchema,
|
|
101
|
+
createAuthorization,
|
|
102
|
+
createAuthorizationRequestBodySchema,
|
|
103
|
+
deleteAuthorization,
|
|
104
|
+
getAuthorization,
|
|
105
|
+
ownerTypeSchema,
|
|
106
|
+
permissionTypeSchema,
|
|
107
|
+
queryAuthorizations,
|
|
108
|
+
queryAuthorizationsRequestBodySchema,
|
|
109
|
+
queryAuthorizationsResponseBodySchema,
|
|
110
|
+
resourceTypeSchema,
|
|
111
|
+
updateAuthorization,
|
|
112
|
+
updateAuthorizationRequestBodySchema
|
|
113
|
+
};
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { getQueryRequestBodySchema, getQueryResponseBodySchema, API_VERSION } from "../common.js";
|
|
3
|
+
const batchOperationTypeSchema = z.enum([
|
|
4
|
+
"CANCEL_PROCESS_INSTANCE",
|
|
5
|
+
"RESOLVE_INCIDENT",
|
|
6
|
+
"MIGRATE_PROCESS_INSTANCE",
|
|
7
|
+
"MODIFY_PROCESS_INSTANCE"
|
|
8
|
+
]);
|
|
9
|
+
const batchOperationStateSchema = z.enum([
|
|
10
|
+
"CREATED",
|
|
11
|
+
"ACTIVE",
|
|
12
|
+
"SUSPENDED",
|
|
13
|
+
"COMPLETED",
|
|
14
|
+
"COMPLETED_WITH_ERRORS",
|
|
15
|
+
"CANCELED",
|
|
16
|
+
"INCOMPLETED"
|
|
17
|
+
]);
|
|
18
|
+
const batchOperationItemStateSchema = z.enum(["ACTIVE", "COMPLETED", "CANCELED", "FAILED"]);
|
|
19
|
+
const batchOperationSchema = z.object({
|
|
20
|
+
batchOperationKey: z.string(),
|
|
21
|
+
state: batchOperationStateSchema,
|
|
22
|
+
batchOperationType: batchOperationTypeSchema,
|
|
23
|
+
startDate: z.string(),
|
|
24
|
+
endDate: z.string().optional(),
|
|
25
|
+
operationsTotalCount: z.number().int(),
|
|
26
|
+
operationsFailedCount: z.number().int(),
|
|
27
|
+
operationsCompletedCount: z.number().int()
|
|
28
|
+
});
|
|
29
|
+
const batchOperationItemSchema = z.object({
|
|
30
|
+
batchOperationKey: z.string(),
|
|
31
|
+
itemKey: z.string(),
|
|
32
|
+
processInstanceKey: z.string(),
|
|
33
|
+
state: batchOperationItemStateSchema,
|
|
34
|
+
processedDate: z.string().optional(),
|
|
35
|
+
errorMessage: z.string().optional()
|
|
36
|
+
});
|
|
37
|
+
const queryBatchOperationsRequestBodySchema = getQueryRequestBodySchema({
|
|
38
|
+
sortFields: ["batchOperationKey", "operationType", "state", "startDate", "endDate"],
|
|
39
|
+
filter: z.object({
|
|
40
|
+
batchOperationKey: z.string(),
|
|
41
|
+
operationType: batchOperationTypeSchema,
|
|
42
|
+
state: batchOperationStateSchema
|
|
43
|
+
}).partial()
|
|
44
|
+
});
|
|
45
|
+
const queryBatchOperationsResponseBodySchema = getQueryResponseBodySchema(batchOperationSchema);
|
|
46
|
+
const queryBatchOperationItemsRequestBodySchema = getQueryRequestBodySchema({
|
|
47
|
+
sortFields: ["batchOperationKey", "itemKey", "processInstanceKey", "state"],
|
|
48
|
+
filter: z.object({
|
|
49
|
+
batchOperationKey: z.string(),
|
|
50
|
+
itemKey: z.string(),
|
|
51
|
+
processInstanceKey: z.string(),
|
|
52
|
+
state: batchOperationItemStateSchema
|
|
53
|
+
}).partial()
|
|
54
|
+
});
|
|
55
|
+
const queryBatchOperationItemsResponseBodySchema = getQueryResponseBodySchema(batchOperationItemSchema);
|
|
56
|
+
const getBatchOperation = {
|
|
57
|
+
method: "GET",
|
|
58
|
+
getUrl: ({ batchOperationKey }) => `/${API_VERSION}/batch-operations/${batchOperationKey}`
|
|
59
|
+
};
|
|
60
|
+
const queryBatchOperations = {
|
|
61
|
+
method: "POST",
|
|
62
|
+
getUrl: () => `/${API_VERSION}/batch-operations/search`
|
|
63
|
+
};
|
|
64
|
+
const cancelBatchOperation = {
|
|
65
|
+
method: "PUT",
|
|
66
|
+
getUrl: ({ batchOperationKey }) => `/${API_VERSION}/batch-operations/${batchOperationKey}/cancellation`
|
|
67
|
+
};
|
|
68
|
+
const suspendBatchOperation = {
|
|
69
|
+
method: "PUT",
|
|
70
|
+
getUrl: ({ batchOperationKey }) => `/${API_VERSION}/batch-operations/${batchOperationKey}/suspension`
|
|
71
|
+
};
|
|
72
|
+
const resumeBatchOperation = {
|
|
73
|
+
method: "PUT",
|
|
74
|
+
getUrl: ({ batchOperationKey }) => `/${API_VERSION}/batch-operations/${batchOperationKey}/resumption`
|
|
75
|
+
};
|
|
76
|
+
const queryBatchOperationItems = {
|
|
77
|
+
method: "POST",
|
|
78
|
+
getUrl: () => `/${API_VERSION}/batch-operation-items/search`
|
|
79
|
+
};
|
|
80
|
+
export {
|
|
81
|
+
batchOperationItemSchema,
|
|
82
|
+
batchOperationItemStateSchema,
|
|
83
|
+
batchOperationSchema,
|
|
84
|
+
batchOperationStateSchema,
|
|
85
|
+
batchOperationTypeSchema,
|
|
86
|
+
cancelBatchOperation,
|
|
87
|
+
getBatchOperation,
|
|
88
|
+
queryBatchOperationItems,
|
|
89
|
+
queryBatchOperationItemsRequestBodySchema,
|
|
90
|
+
queryBatchOperationItemsResponseBodySchema,
|
|
91
|
+
queryBatchOperations,
|
|
92
|
+
queryBatchOperationsRequestBodySchema,
|
|
93
|
+
queryBatchOperationsResponseBodySchema,
|
|
94
|
+
resumeBatchOperation,
|
|
95
|
+
suspendBatchOperation
|
|
96
|
+
};
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { API_VERSION } from "../common.js";
|
|
3
|
+
const pinClockRequestBodySchema = z.object({
|
|
4
|
+
timestamp: z.number().int()
|
|
5
|
+
});
|
|
6
|
+
const pinClock = {
|
|
7
|
+
method: "PUT",
|
|
8
|
+
getUrl: () => `/${API_VERSION}/clock`
|
|
9
|
+
};
|
|
10
|
+
const resetClock = {
|
|
11
|
+
method: "POST",
|
|
12
|
+
getUrl: () => `/${API_VERSION}/clock/reset`
|
|
13
|
+
};
|
|
14
|
+
export {
|
|
15
|
+
pinClock,
|
|
16
|
+
pinClockRequestBodySchema,
|
|
17
|
+
resetClock
|
|
18
|
+
};
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { API_VERSION } from "../common.js";
|
|
3
|
+
const partitionRoleSchema = z.enum(["leader", "follower", "inactive"]);
|
|
4
|
+
const partitionHealthSchema = z.enum(["healthy", "unhealthy", "dead"]);
|
|
5
|
+
const partitionSchema = z.object({
|
|
6
|
+
partitionId: z.number().int(),
|
|
7
|
+
role: partitionRoleSchema,
|
|
8
|
+
health: partitionHealthSchema
|
|
9
|
+
});
|
|
10
|
+
const brokerInfoSchema = z.object({
|
|
11
|
+
nodeId: z.number().int(),
|
|
12
|
+
host: z.string(),
|
|
13
|
+
port: z.number().int(),
|
|
14
|
+
partitions: z.array(partitionSchema),
|
|
15
|
+
version: z.string()
|
|
16
|
+
});
|
|
17
|
+
const getTopologyResponseBodySchema = z.object({
|
|
18
|
+
brokers: z.array(brokerInfoSchema).nullable(),
|
|
19
|
+
clusterSize: z.number().int().nullable(),
|
|
20
|
+
partitionsCount: z.number().int().nullable(),
|
|
21
|
+
replicationFactor: z.number().int().nullable(),
|
|
22
|
+
gatewayVersion: z.string().nullable(),
|
|
23
|
+
lastCompletedChangeId: z.string().nullable()
|
|
24
|
+
});
|
|
25
|
+
const getTopology = {
|
|
26
|
+
method: "GET",
|
|
27
|
+
getUrl: () => `/${API_VERSION}/topology`
|
|
28
|
+
};
|
|
29
|
+
export {
|
|
30
|
+
brokerInfoSchema,
|
|
31
|
+
getTopology,
|
|
32
|
+
getTopologyResponseBodySchema,
|
|
33
|
+
partitionHealthSchema,
|
|
34
|
+
partitionRoleSchema,
|
|
35
|
+
partitionSchema
|
|
36
|
+
};
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { getQueryRequestBodySchema, getQueryResponseBodySchema, API_VERSION } from "../common.js";
|
|
3
|
+
const decisionDefinitionSchema = z.object({
|
|
4
|
+
decisionDefinitionId: z.string(),
|
|
5
|
+
name: z.string(),
|
|
6
|
+
version: z.number(),
|
|
7
|
+
decisionRequirementsId: z.string(),
|
|
8
|
+
tenantId: z.string(),
|
|
9
|
+
decisionDefinitionKey: z.string(),
|
|
10
|
+
decisionRequirementsKey: z.string()
|
|
11
|
+
});
|
|
12
|
+
const queryDecisionDefinitionsRequestBodySchema = getQueryRequestBodySchema({
|
|
13
|
+
sortFields: [
|
|
14
|
+
"decisionDefinitionKey",
|
|
15
|
+
"decisionDefinitionId",
|
|
16
|
+
"name",
|
|
17
|
+
"version",
|
|
18
|
+
"decisionRequirementsId",
|
|
19
|
+
"decisionRequirementsKey",
|
|
20
|
+
"tenantId"
|
|
21
|
+
],
|
|
22
|
+
filter: decisionDefinitionSchema.partial()
|
|
23
|
+
});
|
|
24
|
+
const queryDecisionDefinitionsResponseBodySchema = getQueryResponseBodySchema(decisionDefinitionSchema);
|
|
25
|
+
const getDecisionDefinitionXmlResponseBodySchema = z.string();
|
|
26
|
+
const evaluatedDecisionInputItemSchema = z.object({
|
|
27
|
+
inputId: z.string(),
|
|
28
|
+
inputName: z.string(),
|
|
29
|
+
inputValue: z.string()
|
|
30
|
+
});
|
|
31
|
+
const evaluatedDecisionOutputItemSchema = z.object({
|
|
32
|
+
outputId: z.string(),
|
|
33
|
+
outputName: z.string(),
|
|
34
|
+
outputValue: z.string()
|
|
35
|
+
});
|
|
36
|
+
const matchedDecisionRuleItemSchema = z.object({
|
|
37
|
+
ruleId: z.string(),
|
|
38
|
+
ruleIndex: z.number().int(),
|
|
39
|
+
evaluatedOutputs: z.array(evaluatedDecisionOutputItemSchema)
|
|
40
|
+
});
|
|
41
|
+
const evaluatedDecisionResultSchema = z.object({
|
|
42
|
+
decisionDefinitionId: z.string(),
|
|
43
|
+
decisionDefinitionName: z.string(),
|
|
44
|
+
decisionDefinitionVersion: z.number().int(),
|
|
45
|
+
decisionDefinitionType: z.string(),
|
|
46
|
+
output: z.string(),
|
|
47
|
+
tenantId: z.string(),
|
|
48
|
+
matchedRules: z.array(matchedDecisionRuleItemSchema),
|
|
49
|
+
evaluatedInputs: z.array(evaluatedDecisionInputItemSchema),
|
|
50
|
+
decisionDefinitionKey: z.string()
|
|
51
|
+
});
|
|
52
|
+
const evaluateDecisionRequestBodySchema = z.object({
|
|
53
|
+
decisionDefinitionId: z.string().optional(),
|
|
54
|
+
variables: z.record(z.string(), z.unknown()).optional(),
|
|
55
|
+
tenantId: z.string().optional(),
|
|
56
|
+
decisionDefinitionKey: z.string().optional()
|
|
57
|
+
});
|
|
58
|
+
const evaluateDecisionResponseBodySchema = z.object({
|
|
59
|
+
decisionDefinitionId: z.string(),
|
|
60
|
+
decisionDefinitionName: z.string(),
|
|
61
|
+
decisionDefinitionVersion: z.number().int(),
|
|
62
|
+
decisionRequirementsId: z.string(),
|
|
63
|
+
output: z.string(),
|
|
64
|
+
failedDecisionDefinitionId: z.string().optional(),
|
|
65
|
+
failureMessage: z.string().optional(),
|
|
66
|
+
tenantId: z.string(),
|
|
67
|
+
decisionDefinitionKey: z.string(),
|
|
68
|
+
decisionRequirementsKey: z.string(),
|
|
69
|
+
decisionInstanceKey: z.string(),
|
|
70
|
+
evaluatedDecisions: z.array(evaluatedDecisionResultSchema)
|
|
71
|
+
});
|
|
72
|
+
const queryDecisionDefinitions = {
|
|
73
|
+
method: "POST",
|
|
74
|
+
getUrl: () => `/${API_VERSION}/decision-definitions/search`
|
|
75
|
+
};
|
|
76
|
+
const getDecisionDefinition = {
|
|
77
|
+
method: "GET",
|
|
78
|
+
getUrl: ({ decisionDefinitionKey }) => `/${API_VERSION}/decision-definitions/${decisionDefinitionKey}`
|
|
79
|
+
};
|
|
80
|
+
const getDecisionDefinitionXml = {
|
|
81
|
+
method: "GET",
|
|
82
|
+
getUrl: ({ decisionDefinitionKey }) => `/${API_VERSION}/decision-definitions/${decisionDefinitionKey}/xml`
|
|
83
|
+
};
|
|
84
|
+
const evaluateDecision = {
|
|
85
|
+
method: "POST",
|
|
86
|
+
getUrl: () => `/${API_VERSION}/decision-definitions/evaluation`
|
|
87
|
+
};
|
|
88
|
+
export {
|
|
89
|
+
decisionDefinitionSchema,
|
|
90
|
+
evaluateDecision,
|
|
91
|
+
evaluateDecisionRequestBodySchema,
|
|
92
|
+
evaluateDecisionResponseBodySchema,
|
|
93
|
+
evaluatedDecisionInputItemSchema,
|
|
94
|
+
evaluatedDecisionOutputItemSchema,
|
|
95
|
+
evaluatedDecisionResultSchema,
|
|
96
|
+
getDecisionDefinition,
|
|
97
|
+
getDecisionDefinitionXml,
|
|
98
|
+
getDecisionDefinitionXmlResponseBodySchema,
|
|
99
|
+
matchedDecisionRuleItemSchema,
|
|
100
|
+
queryDecisionDefinitions,
|
|
101
|
+
queryDecisionDefinitionsRequestBodySchema,
|
|
102
|
+
queryDecisionDefinitionsResponseBodySchema
|
|
103
|
+
};
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { getQueryRequestBodySchema, basicStringFilterSchema, advancedDateTimeFilterSchema, getQueryResponseBodySchema, API_VERSION } from "../common.js";
|
|
3
|
+
import { matchedDecisionRuleItemSchema, evaluatedDecisionInputItemSchema } from "./decision-definition.js";
|
|
4
|
+
const decisionDefinitionTypeSchema = z.enum(["DECISION_TABLE", "LITERAL_EXPRESSION", "UNSPECIFIED", "UNKNOWN"]);
|
|
5
|
+
const decisionInstanceStateSchema = z.enum(["EVALUATED", "FAILED", "UNSPECIFIED", "UNKNOWN"]);
|
|
6
|
+
const decisionInstanceSchema = z.object({
|
|
7
|
+
decisionInstanceId: z.string(),
|
|
8
|
+
state: decisionInstanceStateSchema,
|
|
9
|
+
evaluationDate: z.string(),
|
|
10
|
+
evaluationFailure: z.string(),
|
|
11
|
+
decisionDefinitionId: z.string(),
|
|
12
|
+
decisionDefinitionName: z.string(),
|
|
13
|
+
decisionDefinitionVersion: z.number(),
|
|
14
|
+
decisionDefinitionType: decisionDefinitionTypeSchema,
|
|
15
|
+
result: z.string(),
|
|
16
|
+
tenantId: z.string(),
|
|
17
|
+
decisionInstanceKey: z.string(),
|
|
18
|
+
processDefinitionKey: z.string(),
|
|
19
|
+
processInstanceKey: z.string(),
|
|
20
|
+
decisionDefinitionKey: z.string(),
|
|
21
|
+
elementInstanceKey: z.string()
|
|
22
|
+
});
|
|
23
|
+
const queryDecisionInstancesRequestBodySchema = getQueryRequestBodySchema({
|
|
24
|
+
sortFields: [
|
|
25
|
+
"decisionInstanceKey",
|
|
26
|
+
"decisionInstanceId",
|
|
27
|
+
"state",
|
|
28
|
+
"evaluationDate",
|
|
29
|
+
"evaluationFailure",
|
|
30
|
+
"processDefinitionKey",
|
|
31
|
+
"processInstanceKey",
|
|
32
|
+
"processInstanceId",
|
|
33
|
+
"decisionDefinitionKey",
|
|
34
|
+
"decisionDefinitionId",
|
|
35
|
+
"decisionDefinitionName",
|
|
36
|
+
"decisionDefinitionVersion",
|
|
37
|
+
"decisionDefinitionType",
|
|
38
|
+
"tenantId",
|
|
39
|
+
"elementInstanceKey"
|
|
40
|
+
],
|
|
41
|
+
filter: z.object({
|
|
42
|
+
evaluationDate: advancedDateTimeFilterSchema,
|
|
43
|
+
decisionDefinitionKey: basicStringFilterSchema,
|
|
44
|
+
...decisionInstanceSchema.pick({
|
|
45
|
+
decisionInstanceId: true,
|
|
46
|
+
state: true,
|
|
47
|
+
evaluationFailure: true,
|
|
48
|
+
decisionDefinitionId: true,
|
|
49
|
+
decisionDefinitionName: true,
|
|
50
|
+
decisionDefinitionVersion: true,
|
|
51
|
+
decisionDefinitionType: true,
|
|
52
|
+
tenantId: true,
|
|
53
|
+
decisionInstanceKey: true,
|
|
54
|
+
processDefinitionKey: true,
|
|
55
|
+
processInstanceKey: true,
|
|
56
|
+
elementInstanceKey: true
|
|
57
|
+
}).shape
|
|
58
|
+
}).partial()
|
|
59
|
+
});
|
|
60
|
+
const queryDecisionInstancesResponseBodySchema = getQueryResponseBodySchema(decisionInstanceSchema);
|
|
61
|
+
const getDecisionInstanceResponseBodySchema = z.object({
|
|
62
|
+
evaluatedInputs: z.array(evaluatedDecisionInputItemSchema).optional(),
|
|
63
|
+
matchedRules: z.array(matchedDecisionRuleItemSchema).optional(),
|
|
64
|
+
...decisionInstanceSchema.shape
|
|
65
|
+
});
|
|
66
|
+
const queryDecisionInstances = {
|
|
67
|
+
method: "POST",
|
|
68
|
+
getUrl: () => `/${API_VERSION}/decision-instances/search`
|
|
69
|
+
};
|
|
70
|
+
const getDecisionInstance = {
|
|
71
|
+
method: "GET",
|
|
72
|
+
getUrl: ({ decisionInstanceId }) => `/${API_VERSION}/decision-instances/${decisionInstanceId}`
|
|
73
|
+
};
|
|
74
|
+
export {
|
|
75
|
+
decisionDefinitionTypeSchema,
|
|
76
|
+
decisionInstanceSchema,
|
|
77
|
+
decisionInstanceStateSchema,
|
|
78
|
+
getDecisionInstance,
|
|
79
|
+
getDecisionInstanceResponseBodySchema,
|
|
80
|
+
queryDecisionInstances,
|
|
81
|
+
queryDecisionInstancesRequestBodySchema,
|
|
82
|
+
queryDecisionInstancesResponseBodySchema
|
|
83
|
+
};
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { getQueryRequestBodySchema, getQueryResponseBodySchema, API_VERSION } from "../common.js";
|
|
3
|
+
const decisionRequirementsSchema = z.object({
|
|
4
|
+
decisionRequirementsName: z.string(),
|
|
5
|
+
version: z.number(),
|
|
6
|
+
decisionRequirementsId: z.string(),
|
|
7
|
+
resourceName: z.string(),
|
|
8
|
+
tenantId: z.string(),
|
|
9
|
+
decisionRequirementsKey: z.string()
|
|
10
|
+
});
|
|
11
|
+
const queryDecisionRequirementsRequestBodySchema = getQueryRequestBodySchema({
|
|
12
|
+
sortFields: [
|
|
13
|
+
"decisionRequirementsKey",
|
|
14
|
+
"decisionRequirementsName",
|
|
15
|
+
"version",
|
|
16
|
+
"decisionRequirementsId",
|
|
17
|
+
"tenantId"
|
|
18
|
+
],
|
|
19
|
+
filter: decisionRequirementsSchema.partial()
|
|
20
|
+
});
|
|
21
|
+
const queryDecisionRequirementsResponseBodySchema = getQueryResponseBodySchema(decisionRequirementsSchema);
|
|
22
|
+
const getDecisionRequirementsXmlResponseBodySchema = z.string();
|
|
23
|
+
const queryDecisionRequirements = {
|
|
24
|
+
method: "POST",
|
|
25
|
+
getUrl: () => `/${API_VERSION}/decision-requirements/search`
|
|
26
|
+
};
|
|
27
|
+
const getDecisionRequirements = {
|
|
28
|
+
method: "GET",
|
|
29
|
+
getUrl: ({ decisionRequirementsKey }) => `/${API_VERSION}/decision-requirements/${decisionRequirementsKey}`
|
|
30
|
+
};
|
|
31
|
+
const getDecisionRequirementsXml = {
|
|
32
|
+
method: "GET",
|
|
33
|
+
getUrl: ({ decisionRequirementsKey }) => `/${API_VERSION}/decision-requirements/${decisionRequirementsKey}/xml`
|
|
34
|
+
};
|
|
35
|
+
export {
|
|
36
|
+
decisionRequirementsSchema,
|
|
37
|
+
getDecisionRequirements,
|
|
38
|
+
getDecisionRequirementsXml,
|
|
39
|
+
getDecisionRequirementsXmlResponseBodySchema,
|
|
40
|
+
queryDecisionRequirements,
|
|
41
|
+
queryDecisionRequirementsRequestBodySchema,
|
|
42
|
+
queryDecisionRequirementsResponseBodySchema
|
|
43
|
+
};
|