@camunda8/sdk 8.4.0 → 8.4.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/.eslintrc.json +34 -0
- package/CHANGELOG.md +61 -21
- package/CODE_OF_CONDUCT.md +73 -0
- package/CONTRIBUTING.md +116 -0
- package/LICENSE +3 -3
- package/README.md +229 -33
- package/dist/admin/index.d.ts +2 -0
- package/dist/admin/index.js +30 -0
- package/dist/admin/index.js.map +1 -0
- package/dist/admin/lib/AdminApiClient.d.ts +121 -0
- package/dist/admin/lib/AdminApiClient.js +254 -0
- package/dist/admin/lib/AdminApiClient.js.map +1 -0
- package/dist/admin/lib/AdminDto.d.ts +98 -0
- package/dist/admin/lib/AdminDto.js +3 -0
- package/dist/admin/lib/AdminDto.js.map +1 -0
- package/dist/c8/index.d.ts +42 -0
- package/dist/c8/index.js +95 -0
- package/dist/c8/index.js.map +1 -0
- package/dist/index.d.ts +15 -14
- package/dist/index.js +14 -16
- package/dist/index.js.map +1 -1
- package/dist/lib/CertificateAuthority.d.ts +2 -0
- package/dist/lib/CertificateAuthority.js +15 -0
- package/dist/lib/CertificateAuthority.js.map +1 -0
- package/dist/lib/ClientConstructor.d.ts +6 -0
- package/dist/lib/ClientConstructor.js +3 -0
- package/dist/lib/ClientConstructor.js.map +1 -0
- package/dist/lib/Configuration.d.ts +113 -0
- package/dist/lib/Configuration.js +367 -0
- package/dist/lib/Configuration.js.map +1 -0
- package/dist/lib/ConstructOAuthProvider.d.ts +3 -0
- package/dist/lib/ConstructOAuthProvider.js +14 -0
- package/dist/lib/ConstructOAuthProvider.js.map +1 -0
- package/dist/lib/CreateUserAgentString.d.ts +2 -0
- package/dist/lib/CreateUserAgentString.js +11 -0
- package/dist/lib/CreateUserAgentString.js.map +1 -0
- package/dist/lib/Delay.d.ts +1 -0
- package/dist/lib/Delay.js +6 -0
- package/dist/lib/Delay.js.map +1 -0
- package/dist/lib/EnvironmentSetup.d.ts +11 -0
- package/dist/lib/EnvironmentSetup.js +35 -0
- package/dist/lib/EnvironmentSetup.js.map +1 -0
- package/dist/lib/GetPackageVersion.d.ts +1 -0
- package/dist/lib/GetPackageVersion.js +32 -0
- package/dist/lib/GetPackageVersion.js.map +1 -0
- package/dist/lib/LosslessJsonParser.d.ts +103 -0
- package/dist/lib/LosslessJsonParser.js +252 -0
- package/dist/lib/LosslessJsonParser.js.map +1 -0
- package/dist/lib/RequireConfiguration.d.ts +2 -0
- package/dist/lib/RequireConfiguration.js +11 -0
- package/dist/lib/RequireConfiguration.js.map +1 -0
- package/dist/lib/SuppressZeebeLogging.d.ts +2 -0
- package/dist/lib/SuppressZeebeLogging.js +14 -0
- package/dist/lib/SuppressZeebeLogging.js.map +1 -0
- package/dist/lib/ValueOrDefault.d.ts +1 -0
- package/dist/lib/ValueOrDefault.js +8 -0
- package/dist/lib/ValueOrDefault.js.map +1 -0
- package/dist/lib/index.d.ts +12 -0
- package/dist/lib/index.js +32 -0
- package/dist/lib/index.js.map +1 -0
- package/dist/modeler/index.d.ts +2 -0
- package/dist/modeler/index.js +30 -0
- package/dist/modeler/index.js.map +1 -0
- package/dist/modeler/lib/ModelerAPIClient.d.ts +210 -0
- package/dist/modeler/lib/ModelerAPIClient.js +417 -0
- package/dist/modeler/lib/ModelerAPIClient.js.map +1 -0
- package/dist/modeler/lib/ModelerDto.d.ts +187 -0
- package/dist/modeler/lib/ModelerDto.js +3 -0
- package/dist/modeler/lib/ModelerDto.js.map +1 -0
- package/dist/oauth/index.d.ts +15 -0
- package/dist/oauth/index.js +8 -0
- package/dist/oauth/index.js.map +1 -0
- package/dist/oauth/lib/IOAuthProvider.d.ts +4 -0
- package/dist/oauth/lib/IOAuthProvider.js +3 -0
- package/dist/oauth/lib/IOAuthProvider.js.map +1 -0
- package/dist/oauth/lib/NullAuthProvider.d.ts +5 -0
- package/dist/oauth/lib/NullAuthProvider.js +16 -0
- package/dist/oauth/lib/NullAuthProvider.js.map +1 -0
- package/dist/oauth/lib/OAuthProvider.d.ts +44 -0
- package/dist/oauth/lib/OAuthProvider.js +316 -0
- package/dist/oauth/lib/OAuthProvider.js.map +1 -0
- package/dist/operate/index.d.ts +2 -0
- package/dist/operate/index.js +30 -0
- package/dist/operate/index.js.map +1 -0
- package/dist/operate/lib/OperateApiClient.d.ts +204 -0
- package/dist/operate/lib/OperateApiClient.js +440 -0
- package/dist/operate/lib/OperateApiClient.js.map +1 -0
- package/dist/operate/lib/OperateDto.d.ts +126 -0
- package/dist/operate/lib/OperateDto.js +125 -0
- package/dist/operate/lib/OperateDto.js.map +1 -0
- package/dist/operate/lib/TestableOperateApiClient.d.ts +7 -0
- package/dist/operate/lib/TestableOperateApiClient.js +15 -0
- package/dist/operate/lib/TestableOperateApiClient.js.map +1 -0
- package/dist/operate/lib/parseSearchResults.d.ts +4 -0
- package/dist/operate/lib/parseSearchResults.js +26 -0
- package/dist/operate/lib/parseSearchResults.js.map +1 -0
- package/dist/optimize/index.d.ts +2 -0
- package/dist/optimize/index.js +30 -0
- package/dist/optimize/index.js.map +1 -0
- package/dist/optimize/lib/APIObjects.d.ts +191 -0
- package/dist/optimize/lib/APIObjects.js +3 -0
- package/dist/optimize/lib/APIObjects.js.map +1 -0
- package/dist/optimize/lib/OptimizeApiClient.d.ts +269 -0
- package/dist/optimize/lib/OptimizeApiClient.js +410 -0
- package/dist/optimize/lib/OptimizeApiClient.js.map +1 -0
- package/dist/optimize/lib/ReportResults.d.ts +23 -0
- package/dist/optimize/lib/ReportResults.js +28 -0
- package/dist/optimize/lib/ReportResults.js.map +1 -0
- package/dist/proto/zeebe.proto +996 -0
- package/dist/tasklist/index.d.ts +2 -0
- package/dist/tasklist/index.js +30 -0
- package/dist/tasklist/index.js.map +1 -0
- package/dist/tasklist/lib/TasklistApiClient.d.ts +104 -0
- package/dist/tasklist/lib/TasklistApiClient.js +233 -0
- package/dist/tasklist/lib/TasklistApiClient.js.map +1 -0
- package/dist/tasklist/lib/TasklistDto.d.ts +147 -0
- package/dist/tasklist/lib/TasklistDto.js +26 -0
- package/dist/tasklist/lib/TasklistDto.js.map +1 -0
- package/dist/tasklist/lib/utils.d.ts +15 -0
- package/dist/tasklist/lib/utils.js +25 -0
- package/dist/tasklist/lib/utils.js.map +1 -0
- package/dist/zeebe/index.d.ts +21 -0
- package/dist/zeebe/index.js +53 -0
- package/dist/zeebe/index.js.map +1 -0
- package/dist/zeebe/lib/BpmnParser.d.ts +38 -0
- package/dist/zeebe/lib/BpmnParser.js +274 -0
- package/dist/zeebe/lib/BpmnParser.js.map +1 -0
- package/dist/zeebe/lib/ConnectionFactory.d.ts +25 -0
- package/dist/zeebe/lib/ConnectionFactory.js +43 -0
- package/dist/zeebe/lib/ConnectionFactory.js.map +1 -0
- package/dist/zeebe/lib/ConnectionStatusEvent.d.ts +6 -0
- package/dist/zeebe/lib/ConnectionStatusEvent.js +10 -0
- package/dist/zeebe/lib/ConnectionStatusEvent.js.map +1 -0
- package/dist/zeebe/lib/GetPackageVersion.d.ts +1 -0
- package/dist/zeebe/lib/GetPackageVersion.js +32 -0
- package/dist/zeebe/lib/GetPackageVersion.js.map +1 -0
- package/dist/zeebe/lib/GrpcClient.d.ts +75 -0
- package/dist/zeebe/lib/GrpcClient.js +467 -0
- package/dist/zeebe/lib/GrpcClient.js.map +1 -0
- package/dist/zeebe/lib/GrpcError.d.ts +19 -0
- package/dist/zeebe/lib/GrpcError.js +23 -0
- package/dist/zeebe/lib/GrpcError.js.map +1 -0
- package/dist/zeebe/lib/GrpcMiddleware.d.ts +21 -0
- package/dist/zeebe/lib/GrpcMiddleware.js +78 -0
- package/dist/zeebe/lib/GrpcMiddleware.js.map +1 -0
- package/dist/zeebe/lib/MockStdOut.d.ts +7 -0
- package/dist/zeebe/lib/MockStdOut.js +19 -0
- package/dist/zeebe/lib/MockStdOut.js.map +1 -0
- package/dist/zeebe/lib/Queue.d.ts +8 -0
- package/dist/zeebe/lib/Queue.js +15 -0
- package/dist/zeebe/lib/Queue.js.map +1 -0
- package/dist/zeebe/lib/SimpleLogger.d.ts +8 -0
- package/dist/zeebe/lib/SimpleLogger.js +47 -0
- package/dist/zeebe/lib/SimpleLogger.js.map +1 -0
- package/dist/zeebe/lib/StatefulLogInterceptor.d.ts +29 -0
- package/dist/zeebe/lib/StatefulLogInterceptor.js +81 -0
- package/dist/zeebe/lib/StatefulLogInterceptor.js.map +1 -0
- package/dist/zeebe/lib/TypedEmitter.d.ts +16 -0
- package/dist/zeebe/lib/TypedEmitter.js +24 -0
- package/dist/zeebe/lib/TypedEmitter.js.map +1 -0
- package/dist/zeebe/lib/ZBJsonLogger.d.ts +5 -0
- package/dist/zeebe/lib/ZBJsonLogger.js +12 -0
- package/dist/zeebe/lib/ZBJsonLogger.js.map +1 -0
- package/dist/zeebe/lib/ZBLogger.d.ts +20 -0
- package/dist/zeebe/lib/ZBLogger.js +134 -0
- package/dist/zeebe/lib/ZBLogger.js.map +1 -0
- package/dist/zeebe/lib/ZBWorkerBase.d.ts +78 -0
- package/dist/zeebe/lib/ZBWorkerBase.js +417 -0
- package/dist/zeebe/lib/ZBWorkerBase.js.map +1 -0
- package/dist/zeebe/lib/cancelProcesses.d.ts +1 -0
- package/dist/zeebe/lib/cancelProcesses.js +40 -0
- package/dist/zeebe/lib/cancelProcesses.js.map +1 -0
- package/dist/zeebe/lib/createUniqueTaskType.d.ts +0 -0
- package/dist/zeebe/lib/createUniqueTaskType.js +65 -0
- package/dist/zeebe/lib/createUniqueTaskType.js.map +1 -0
- package/dist/zeebe/lib/index.d.ts +2 -0
- package/dist/zeebe/lib/index.js +19 -0
- package/dist/zeebe/lib/index.js.map +1 -0
- package/dist/zeebe/lib/interfaces-1.0.d.ts +303 -0
- package/dist/zeebe/lib/interfaces-1.0.js +5 -0
- package/dist/zeebe/lib/interfaces-1.0.js.map +1 -0
- package/dist/zeebe/lib/interfaces-grpc-1.0.d.ts +679 -0
- package/dist/zeebe/lib/interfaces-grpc-1.0.js +22 -0
- package/dist/zeebe/lib/interfaces-grpc-1.0.js.map +1 -0
- package/dist/zeebe/lib/interfaces-published-contract.d.ts +67 -0
- package/dist/zeebe/lib/interfaces-published-contract.js +3 -0
- package/dist/zeebe/lib/interfaces-published-contract.js.map +1 -0
- package/dist/zeebe/lib/stringifyVariables.d.ts +18 -0
- package/dist/zeebe/lib/stringifyVariables.js +28 -0
- package/dist/zeebe/lib/stringifyVariables.js.map +1 -0
- package/dist/zeebe/lib/utils.d.ts +7 -0
- package/dist/zeebe/lib/utils.js +48 -0
- package/dist/zeebe/lib/utils.js.map +1 -0
- package/dist/zeebe/types.d.ts +3 -0
- package/dist/zeebe/types.js +20 -0
- package/dist/zeebe/types.js.map +1 -0
- package/dist/zeebe/zb/ZBWorker.d.ts +7 -0
- package/dist/zeebe/zb/ZBWorker.js +73 -0
- package/dist/zeebe/zb/ZBWorker.js.map +1 -0
- package/dist/zeebe/zb/ZeebeGrpcClient.d.ts +587 -0
- package/dist/zeebe/zb/ZeebeGrpcClient.js +1021 -0
- package/dist/zeebe/zb/ZeebeGrpcClient.js.map +1 -0
- package/package.json +120 -30
- package/release.config.js +49 -0
- package/renovate.json +9 -0
- package/smoke-test/package-lock.json +29 -0
- package/smoke-test/package.json +15 -0
- package/smoke-test/smoke-test.js +45 -0
- package/test-d/index.test-d.ts +31 -0
- package/.github/workflows/build-docs.yml +0 -39
- package/.github/workflows/tag-and-publish.yml +0 -48
- package/.prettierignore +0 -2
- package/img/video.png +0 -0
- package/jest.config.js +0 -5
- package/src/__tests__/exports.spec.ts +0 -7
- package/src/index.ts +0 -17
- package/tsconfig.build.json +0 -8
- package/tsconfig.json +0 -10
- package/tsconfig.tsbuildinfo +0 -1
- package/typedoc.json +0 -10
|
@@ -0,0 +1,679 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import { MaybeTimeDuration } from 'typed-duration';
|
|
3
|
+
import { IInputVariables, IProcessVariables, JSONDoc } from './interfaces-1.0';
|
|
4
|
+
export interface StreamActivatedJobsRequest {
|
|
5
|
+
/**
|
|
6
|
+
* the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition type="payment-service" />)
|
|
7
|
+
*/
|
|
8
|
+
type: string;
|
|
9
|
+
/**
|
|
10
|
+
* the name of the worker activating the jobs, mostly used for logging purposes
|
|
11
|
+
*/
|
|
12
|
+
worker: string;
|
|
13
|
+
/**
|
|
14
|
+
* a job returned after this call will not be activated by another call until the
|
|
15
|
+
* timeout (in ms) has been reached
|
|
16
|
+
*/
|
|
17
|
+
timeout: number;
|
|
18
|
+
/**
|
|
19
|
+
* a list of variables to fetch as the job variables; if empty, all visible variables at
|
|
20
|
+
* the time of activation for the scope of the job will be returned
|
|
21
|
+
*/
|
|
22
|
+
fetchVariable: string[];
|
|
23
|
+
/**
|
|
24
|
+
* a list of identifiers of tenants for which to stream jobs
|
|
25
|
+
*/
|
|
26
|
+
tenantIds: string[];
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Request object to send the broker to request jobs for the worker.
|
|
30
|
+
*/
|
|
31
|
+
export interface ActivateJobsRequest {
|
|
32
|
+
/**
|
|
33
|
+
* The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
|
|
34
|
+
* type="payment-service" />)
|
|
35
|
+
*/
|
|
36
|
+
type: string;
|
|
37
|
+
/** The name of the worker activating the jobs, mostly used for logging purposes */
|
|
38
|
+
worker: string;
|
|
39
|
+
/**
|
|
40
|
+
* The duration the broker allows for jobs activated by this call to complete
|
|
41
|
+
* before timing them out releasing them for retry on the broker.
|
|
42
|
+
* The broker checks time outs every 30 seconds, so the broker timeout is guaranteed in at-most timeout + 29s
|
|
43
|
+
* be guaranteed.
|
|
44
|
+
*/
|
|
45
|
+
timeout: MaybeTimeDuration;
|
|
46
|
+
/**
|
|
47
|
+
* The maximum jobs to activate by this request
|
|
48
|
+
*/
|
|
49
|
+
maxJobsToActivate: number;
|
|
50
|
+
/**
|
|
51
|
+
* A list of variables to fetch as the job variables; if empty, all visible variables at
|
|
52
|
+
* the time of activation for the scope of the job will be returned
|
|
53
|
+
*/
|
|
54
|
+
fetchVariable?: string[];
|
|
55
|
+
/**
|
|
56
|
+
* The request will be completed when atleast one job is activated or after the requestTimeout.
|
|
57
|
+
* if the requestTimeout = 0, the request will be completed after a default configured timeout in the broker.
|
|
58
|
+
* To immediately complete the request when no job is activated set the requestTimeout to a negative value
|
|
59
|
+
*
|
|
60
|
+
*/
|
|
61
|
+
requestTimeout: MaybeTimeDuration;
|
|
62
|
+
/**
|
|
63
|
+
* a list of IDs of tenants for which to activate jobs
|
|
64
|
+
*/
|
|
65
|
+
tenantIds?: string[];
|
|
66
|
+
}
|
|
67
|
+
export interface ActivatedJob {
|
|
68
|
+
/** The key, a unique identifier for the job */
|
|
69
|
+
readonly key: string;
|
|
70
|
+
/**
|
|
71
|
+
* The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
|
|
72
|
+
* type="payment-service" />)
|
|
73
|
+
*/
|
|
74
|
+
readonly type: string;
|
|
75
|
+
/** The job's process instance key */
|
|
76
|
+
readonly processInstanceKey: string;
|
|
77
|
+
/** The bpmn process ID of the job process definition */
|
|
78
|
+
readonly bpmnProcessId: string;
|
|
79
|
+
/** The version of the job process definition */
|
|
80
|
+
readonly processDefinitionVersion: number;
|
|
81
|
+
/** The key of the job process definition */
|
|
82
|
+
readonly processDefinitionKey: string;
|
|
83
|
+
/** The associated task element ID */
|
|
84
|
+
readonly elementId: string;
|
|
85
|
+
/**
|
|
86
|
+
* The unique key identifying the associated task, unique within the scope of the
|
|
87
|
+
* process instance
|
|
88
|
+
*/
|
|
89
|
+
readonly elementInstanceKey: string;
|
|
90
|
+
/**
|
|
91
|
+
* A set of custom headers defined during modelling
|
|
92
|
+
*/
|
|
93
|
+
readonly customHeaders: string;
|
|
94
|
+
/** The name of the worker that activated this job */
|
|
95
|
+
readonly worker: string;
|
|
96
|
+
readonly retries: number;
|
|
97
|
+
/**
|
|
98
|
+
* When the job will timeout on the broker if it is not completed by this worker.
|
|
99
|
+
* In epoch milliseconds
|
|
100
|
+
*/
|
|
101
|
+
readonly deadline: string;
|
|
102
|
+
/**
|
|
103
|
+
* All visible variables in the task scope, computed at activation time, constrained by any
|
|
104
|
+
* fetchVariables value in the ActivateJobRequest.
|
|
105
|
+
*/
|
|
106
|
+
readonly variables: string;
|
|
107
|
+
/**
|
|
108
|
+
* the id of the tenant that owns the job
|
|
109
|
+
*/
|
|
110
|
+
readonly tenantId: string;
|
|
111
|
+
}
|
|
112
|
+
export interface ActivateJobsResponse {
|
|
113
|
+
jobs: ActivatedJob[];
|
|
114
|
+
}
|
|
115
|
+
export interface CreateProcessInstanceBaseRequest {
|
|
116
|
+
/** the BPMN process ID of the process definition */
|
|
117
|
+
bpmnProcessId: string;
|
|
118
|
+
/** the version of the process; if not specified it will use the latest version */
|
|
119
|
+
version?: number;
|
|
120
|
+
/**
|
|
121
|
+
* JSON document that will instantiate the variables for the root variable scope of the
|
|
122
|
+
* process instance.
|
|
123
|
+
*/
|
|
124
|
+
variables: string;
|
|
125
|
+
/**
|
|
126
|
+
* the tenant id of the process definition
|
|
127
|
+
*/
|
|
128
|
+
tenantId?: string;
|
|
129
|
+
}
|
|
130
|
+
export interface CreateProcessInstanceRequest extends CreateProcessInstanceBaseRequest {
|
|
131
|
+
/**
|
|
132
|
+
* List of start instructions. If empty (default) the process instance
|
|
133
|
+
* will start at the start event. If non-empty the process instance will apply start
|
|
134
|
+
* instructions after it has been created
|
|
135
|
+
*/
|
|
136
|
+
startInstructions: ProcessInstanceCreationStartInstruction[];
|
|
137
|
+
}
|
|
138
|
+
export interface ProcessInstanceCreationStartInstruction {
|
|
139
|
+
/**
|
|
140
|
+
* future extensions might include
|
|
141
|
+
* - different types of start instructions
|
|
142
|
+
* - ability to set local variables for different flow scopes
|
|
143
|
+
* for now, however, the start instruction is implicitly a
|
|
144
|
+
* "startBeforeElement" instruction
|
|
145
|
+
*/
|
|
146
|
+
elementId: string;
|
|
147
|
+
}
|
|
148
|
+
export interface CreateProcessInstanceResponse {
|
|
149
|
+
/**
|
|
150
|
+
* The unique key identifying the process definition (e.g. returned from a process
|
|
151
|
+
* in the DeployResourceResponse message)
|
|
152
|
+
*/
|
|
153
|
+
readonly processDefinitionKey: string;
|
|
154
|
+
/**
|
|
155
|
+
* The BPMN process ID of the process definition
|
|
156
|
+
*/
|
|
157
|
+
readonly bpmnProcessId: string;
|
|
158
|
+
/**
|
|
159
|
+
* The version of the process; set to -1 to use the latest version
|
|
160
|
+
*/
|
|
161
|
+
readonly version: number;
|
|
162
|
+
/**
|
|
163
|
+
* Stringified JSON document that will instantiate the variables for the root variable scope of the
|
|
164
|
+
* process instance; it must be a JSON object, as variables will be mapped in a
|
|
165
|
+
* key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
|
|
166
|
+
* "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a\
|
|
167
|
+
* valid argument, as the root of the JSON document is an array and not an object.
|
|
168
|
+
*/
|
|
169
|
+
readonly processInstanceKey: string;
|
|
170
|
+
/**
|
|
171
|
+
* the tenant identifier of the created process instance
|
|
172
|
+
*/
|
|
173
|
+
readonly tenantId: string;
|
|
174
|
+
}
|
|
175
|
+
export interface CreateProcessInstanceWithResultRequest {
|
|
176
|
+
request: CreateProcessInstanceBaseRequest;
|
|
177
|
+
/**
|
|
178
|
+
* timeout in milliseconds. the request will be closed if the process is not completed before the requestTimeout.
|
|
179
|
+
* if requestTimeout = 0, uses the generic requestTimeout configured in the gateway.
|
|
180
|
+
*/
|
|
181
|
+
requestTimeout: number;
|
|
182
|
+
/**
|
|
183
|
+
* list of names of variables to be included in `CreateProcessInstanceWithResultResponse.variables`.
|
|
184
|
+
* If empty, all visible variables in the root scope will be returned.
|
|
185
|
+
*/
|
|
186
|
+
fetchVariables?: string[];
|
|
187
|
+
}
|
|
188
|
+
interface CreateProcessInstanceWithResultResponseBase {
|
|
189
|
+
/**
|
|
190
|
+
* the key of the process definition which was used to create the process instance
|
|
191
|
+
*/
|
|
192
|
+
readonly processDefinitionKey: string;
|
|
193
|
+
/**
|
|
194
|
+
* the BPMN process ID of the process definition which was used to create the process
|
|
195
|
+
* instance
|
|
196
|
+
*/
|
|
197
|
+
readonly bpmnProcessId: string;
|
|
198
|
+
/**
|
|
199
|
+
* the version of the process definition which was used to create the process instance
|
|
200
|
+
*/
|
|
201
|
+
readonly version: number;
|
|
202
|
+
/**
|
|
203
|
+
* the unique identifier of the created process instance; to be used wherever a request
|
|
204
|
+
* needs a process instance key (e.g. CancelProcessInstanceRequest)
|
|
205
|
+
*/
|
|
206
|
+
readonly processInstanceKey: string;
|
|
207
|
+
/**
|
|
208
|
+
* the tenant identifier of the process definition
|
|
209
|
+
*/
|
|
210
|
+
readonly tenantId: string;
|
|
211
|
+
}
|
|
212
|
+
export interface CreateProcessInstanceWithResultResponse<Result> extends CreateProcessInstanceWithResultResponseBase {
|
|
213
|
+
/**
|
|
214
|
+
* consisting of all visible variables to the root scope
|
|
215
|
+
*/
|
|
216
|
+
readonly variables: Result;
|
|
217
|
+
}
|
|
218
|
+
export interface CreateProcessInstanceWithResultResponseOnWire extends CreateProcessInstanceWithResultResponseBase {
|
|
219
|
+
/**
|
|
220
|
+
* consisting of all visible variables to the root scope
|
|
221
|
+
*/
|
|
222
|
+
readonly variables: string;
|
|
223
|
+
}
|
|
224
|
+
/**
|
|
225
|
+
* Describes the Raft role of the broker for a given partition
|
|
226
|
+
*/
|
|
227
|
+
export declare enum PartitionBrokerRole {
|
|
228
|
+
LEADER = 0,
|
|
229
|
+
BROKER = 1,
|
|
230
|
+
INACTIVE = 2
|
|
231
|
+
}
|
|
232
|
+
/**
|
|
233
|
+
* Describes the current health of the partition
|
|
234
|
+
*/
|
|
235
|
+
export declare enum PartitionBrokerHealth {
|
|
236
|
+
HEALTHY = 0,
|
|
237
|
+
UNHEALTHY = 1,
|
|
238
|
+
DEAD = 2
|
|
239
|
+
}
|
|
240
|
+
export interface Partition {
|
|
241
|
+
partitionId: number;
|
|
242
|
+
/** the role of the broker for this partition */
|
|
243
|
+
role: PartitionBrokerRole;
|
|
244
|
+
/** the health of this partition */
|
|
245
|
+
health: PartitionBrokerHealth;
|
|
246
|
+
}
|
|
247
|
+
export interface BrokerInfo {
|
|
248
|
+
nodeId: number;
|
|
249
|
+
host: string;
|
|
250
|
+
port: number;
|
|
251
|
+
partitions: Partition[];
|
|
252
|
+
}
|
|
253
|
+
export interface TopologyResponse {
|
|
254
|
+
readonly brokers: BrokerInfo[];
|
|
255
|
+
readonly clusterSize: number;
|
|
256
|
+
readonly partitionsCount: number;
|
|
257
|
+
readonly replicationFactor: number;
|
|
258
|
+
readonly gatewayVersion: string;
|
|
259
|
+
}
|
|
260
|
+
export interface ProcessRequestObject {
|
|
261
|
+
name?: string;
|
|
262
|
+
definition: Buffer;
|
|
263
|
+
}
|
|
264
|
+
export interface ProcessMetadata {
|
|
265
|
+
/**
|
|
266
|
+
* the bpmn process ID, as parsed during deployment; together with the version forms a
|
|
267
|
+
* unique identifier for a specific process definition
|
|
268
|
+
*/
|
|
269
|
+
readonly bpmnProcessId: string;
|
|
270
|
+
/** the assigned process version */
|
|
271
|
+
readonly version: number;
|
|
272
|
+
/** the assigned key, which acts as a unique identifier for this process */
|
|
273
|
+
readonly processDefinitionKey: string;
|
|
274
|
+
/**
|
|
275
|
+
* the resource name (see: ProcessRequestObject.name) from which this process was
|
|
276
|
+
* parsed
|
|
277
|
+
*/
|
|
278
|
+
readonly resourceName: string;
|
|
279
|
+
/**
|
|
280
|
+
* the tenant identifier of the deployed process
|
|
281
|
+
*/
|
|
282
|
+
tenantId: string;
|
|
283
|
+
}
|
|
284
|
+
export interface DecisionMetadata {
|
|
285
|
+
/**
|
|
286
|
+
* the dmn decision ID, as parsed during deployment; together with the
|
|
287
|
+
* versions forms a unique identifier for a specific decision
|
|
288
|
+
*/
|
|
289
|
+
dmnDecisionId: string;
|
|
290
|
+
/** the dmn name of the decision, as parsed during deployment */
|
|
291
|
+
dmnDecisionName: string;
|
|
292
|
+
/** the assigned decision version */
|
|
293
|
+
version: number;
|
|
294
|
+
/**
|
|
295
|
+
* the assigned decision key, which acts as a unique identifier for this
|
|
296
|
+
* decision
|
|
297
|
+
*/
|
|
298
|
+
decisionKey: string;
|
|
299
|
+
/**
|
|
300
|
+
* the dmn ID of the decision requirements graph that this decision is part
|
|
301
|
+
* of, as parsed during deployment
|
|
302
|
+
*/
|
|
303
|
+
dmnDecisionRequirementsId: string;
|
|
304
|
+
/**
|
|
305
|
+
* the assigned key of the decision requirements graph that this decision is
|
|
306
|
+
* part of
|
|
307
|
+
*/
|
|
308
|
+
decisionRequirementsKey: string;
|
|
309
|
+
/** the tenant id of the deployed decision */
|
|
310
|
+
tenantId: string;
|
|
311
|
+
}
|
|
312
|
+
export interface DecisionRequirementsMetadata {
|
|
313
|
+
/**
|
|
314
|
+
* the dmn decision requirements ID, as parsed during deployment; together
|
|
315
|
+
* with the versions forms a unique identifier for a specific decision
|
|
316
|
+
*/
|
|
317
|
+
dmnDecisionRequirementsId: string;
|
|
318
|
+
/** the dmn name of the decision requirements, as parsed during deployment */
|
|
319
|
+
dmnDecisionRequirementsName: string;
|
|
320
|
+
/** the assigned decision requirements version */
|
|
321
|
+
version: number;
|
|
322
|
+
/**
|
|
323
|
+
* the assigned decision requirements key, which acts as a unique identifier
|
|
324
|
+
* for this decision requirements
|
|
325
|
+
*/
|
|
326
|
+
decisionRequirementsKey: string;
|
|
327
|
+
/**
|
|
328
|
+
* the resource name (see: Resource.name) from which this decision
|
|
329
|
+
* requirements was parsed
|
|
330
|
+
*/
|
|
331
|
+
resourceName: string;
|
|
332
|
+
/** the tenant id of the deployed decision requirements */
|
|
333
|
+
tenantId: string;
|
|
334
|
+
}
|
|
335
|
+
export interface FormMetadata {
|
|
336
|
+
/**
|
|
337
|
+
* the form ID, as parsed during deployment; together with the
|
|
338
|
+
* versions forms a unique identifier for a specific form
|
|
339
|
+
*/
|
|
340
|
+
readonly formId: string;
|
|
341
|
+
/** the assigned form version */
|
|
342
|
+
readonly version: number;
|
|
343
|
+
/** the assigned key, which acts as a unique identifier for this form */
|
|
344
|
+
readonly formKey: string;
|
|
345
|
+
/** the resource name */
|
|
346
|
+
readonly resourceName: string;
|
|
347
|
+
/** the tenant id of the deployed form */
|
|
348
|
+
readonly tenantId: string;
|
|
349
|
+
}
|
|
350
|
+
export interface ProcessDeployment {
|
|
351
|
+
process: ProcessMetadata;
|
|
352
|
+
}
|
|
353
|
+
export interface DecisionDeployment {
|
|
354
|
+
decision: DecisionMetadata;
|
|
355
|
+
}
|
|
356
|
+
export interface DecisionRequirementsDeployment {
|
|
357
|
+
decisionRequirements: DecisionRequirementsMetadata;
|
|
358
|
+
}
|
|
359
|
+
export interface FormDeployment {
|
|
360
|
+
form: FormMetadata;
|
|
361
|
+
}
|
|
362
|
+
export type Deployment = ProcessDeployment | DecisionDeployment | DecisionRequirementsDeployment | FormDeployment;
|
|
363
|
+
export interface DeployResourceResponse<T> {
|
|
364
|
+
/** the unique key identifying the deployment */
|
|
365
|
+
readonly key: string;
|
|
366
|
+
/** a list of deployed resources, e.g. processes */
|
|
367
|
+
readonly deployments: T[];
|
|
368
|
+
/** the tenant id of the deployed resources */
|
|
369
|
+
tenantId: string;
|
|
370
|
+
}
|
|
371
|
+
export interface DeployResourceRequest {
|
|
372
|
+
/** list of resources to deploy */
|
|
373
|
+
resources: Resource[];
|
|
374
|
+
/**
|
|
375
|
+
* the tenant id of the resources to deploy
|
|
376
|
+
*/
|
|
377
|
+
tenantId?: string;
|
|
378
|
+
}
|
|
379
|
+
export interface Resource {
|
|
380
|
+
/** the resource name, e.g. myProcess.bpmn or myDecision.dmn */
|
|
381
|
+
name: string;
|
|
382
|
+
/** the file content as a UTF8-encoded string */
|
|
383
|
+
content: Buffer;
|
|
384
|
+
}
|
|
385
|
+
export interface ListProcessResponse {
|
|
386
|
+
readonly processes: ProcessMetadata[];
|
|
387
|
+
}
|
|
388
|
+
export interface PublishMessageRequest<Variables = IInputVariables> {
|
|
389
|
+
/** Should match the "Message Name" in a BPMN Message Catch */
|
|
390
|
+
name: string;
|
|
391
|
+
/** The value to match with the field specified as "Subscription Correlation Key" in BPMN */
|
|
392
|
+
correlationKey: string;
|
|
393
|
+
/** The number of seconds for the message to buffer on the broker, awaiting correlation. Omit or set to zero for no buffering. */
|
|
394
|
+
timeToLive?: MaybeTimeDuration;
|
|
395
|
+
/** Unique ID for this message */
|
|
396
|
+
messageId?: string;
|
|
397
|
+
variables?: Variables;
|
|
398
|
+
/** the tenantId of the message */
|
|
399
|
+
tenantId?: string;
|
|
400
|
+
}
|
|
401
|
+
export interface PublishMessageResponse {
|
|
402
|
+
/** the unique ID of the message that was published */
|
|
403
|
+
key: string;
|
|
404
|
+
/** the tenantId of the message */
|
|
405
|
+
tenantId: string;
|
|
406
|
+
}
|
|
407
|
+
export interface PublishStartMessageRequest<Variables = IProcessVariables> {
|
|
408
|
+
/** Should match the "Message Name" in a BPMN Message Catch */
|
|
409
|
+
name: string;
|
|
410
|
+
/**
|
|
411
|
+
* The number of seconds for the message to buffer on the broker, awaiting correlation.
|
|
412
|
+
* Omit or set to zero for no buffering.
|
|
413
|
+
*/
|
|
414
|
+
timeToLive: MaybeTimeDuration;
|
|
415
|
+
/** Unique ID for this message */
|
|
416
|
+
messageId?: string;
|
|
417
|
+
correlationKey?: string;
|
|
418
|
+
variables: Variables;
|
|
419
|
+
/** the tenantId for the message */
|
|
420
|
+
tenantId?: string;
|
|
421
|
+
}
|
|
422
|
+
export interface UpdateJobRetriesRequest {
|
|
423
|
+
readonly jobKey: string;
|
|
424
|
+
retries: number;
|
|
425
|
+
}
|
|
426
|
+
export interface FailJobRequest {
|
|
427
|
+
readonly jobKey: string;
|
|
428
|
+
retries: number;
|
|
429
|
+
errorMessage: string;
|
|
430
|
+
retryBackOff: number;
|
|
431
|
+
}
|
|
432
|
+
export interface ThrowErrorRequest {
|
|
433
|
+
/** the unique job identifier, as obtained when activating the job */
|
|
434
|
+
jobKey: string;
|
|
435
|
+
/** the error code that will be matched with an error catch event */
|
|
436
|
+
errorCode: string;
|
|
437
|
+
/** an optional error message that provides additional context */
|
|
438
|
+
errorMessage?: string;
|
|
439
|
+
/**
|
|
440
|
+
* JSON document that will instantiate the variables at the local scope of the error catch
|
|
441
|
+
* event that catches the thrown error; it must be a JSON object, as variables will be mapped in a
|
|
442
|
+
* key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
|
|
443
|
+
* "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
|
|
444
|
+
* valid argument, as the root of the JSON document is an array and not an object.
|
|
445
|
+
*/
|
|
446
|
+
variables?: JSONDoc;
|
|
447
|
+
}
|
|
448
|
+
export interface CompleteJobRequest<Variables = IProcessVariables> {
|
|
449
|
+
readonly jobKey: string;
|
|
450
|
+
variables: Variables;
|
|
451
|
+
}
|
|
452
|
+
interface SetVariablesRequestBase {
|
|
453
|
+
readonly elementInstanceKey: string;
|
|
454
|
+
/**
|
|
455
|
+
* if true, the variables will be merged strictly into the local scope (as indicated by
|
|
456
|
+
* elementInstanceKey); this means the variables is not propagated to upper scopes.
|
|
457
|
+
* for example, let's say we have two scopes, '1' and '2', with each having effective variables as:
|
|
458
|
+
* 1 => `{ "foo" : 2 }`, and 2 => `{ "bar" : 1 }`. if we send an update request with
|
|
459
|
+
* elementInstanceKey = 2, variables `{ "foo" : 5 }`, and local is true, then scope 1 will
|
|
460
|
+
* be unchanged, and scope 2 will now be `{ "bar" : 1, "foo" 5 }`. if local was false, however,
|
|
461
|
+
* then scope 1 would be `{ "foo": 5 }`, and scope 2 would be `{ "bar" : 1 }`.
|
|
462
|
+
*/
|
|
463
|
+
local: boolean;
|
|
464
|
+
}
|
|
465
|
+
export interface SetVariablesRequest<Variables = IProcessVariables> extends SetVariablesRequestBase {
|
|
466
|
+
variables: Partial<Variables>;
|
|
467
|
+
}
|
|
468
|
+
export interface SetVariablesRequestOnTheWire extends SetVariablesRequestBase {
|
|
469
|
+
variables: string;
|
|
470
|
+
}
|
|
471
|
+
export interface ResolveIncidentRequest {
|
|
472
|
+
readonly incidentKey: string;
|
|
473
|
+
}
|
|
474
|
+
export interface ActivateInstruction {
|
|
475
|
+
/** the id of the element that should be activated */
|
|
476
|
+
elementId: string;
|
|
477
|
+
/**
|
|
478
|
+
* the key of the ancestor scope the element instance should be created in;
|
|
479
|
+
* set to -1 to create the new element instance within an existing element
|
|
480
|
+
* instance of the flow scope
|
|
481
|
+
*/
|
|
482
|
+
ancestorElementInstanceKey: string;
|
|
483
|
+
/** instructions describing which variables should be created */
|
|
484
|
+
variableInstructions: VariableInstruction[];
|
|
485
|
+
}
|
|
486
|
+
export interface VariableInstruction {
|
|
487
|
+
/**
|
|
488
|
+
* JSON document that will instantiate the variables for the root variable scope of the
|
|
489
|
+
* process instance; it must be a JSON object, as variables will be mapped in a
|
|
490
|
+
* key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
|
|
491
|
+
* "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
|
|
492
|
+
* valid argument, as the root of the JSON document is an array and not an object.
|
|
493
|
+
*/
|
|
494
|
+
variables: JSONDoc;
|
|
495
|
+
/**
|
|
496
|
+
* the id of the element in which scope the variables should be created;
|
|
497
|
+
* leave empty to create the variables in the global scope of the process instance
|
|
498
|
+
*/
|
|
499
|
+
scopeId: string;
|
|
500
|
+
}
|
|
501
|
+
export interface TerminateInstruction {
|
|
502
|
+
/** the id of the element that should be terminated */
|
|
503
|
+
elementInstanceKey: string;
|
|
504
|
+
}
|
|
505
|
+
export interface ModifyProcessInstanceRequest {
|
|
506
|
+
/** the key of the process instance that should be modified */
|
|
507
|
+
processInstanceKey: string;
|
|
508
|
+
/**
|
|
509
|
+
* instructions describing which elements should be activated in which scopes,
|
|
510
|
+
* and which variables should be created
|
|
511
|
+
*/
|
|
512
|
+
activateInstructions?: ActivateInstruction[];
|
|
513
|
+
/** instructions describing which elements should be terminated */
|
|
514
|
+
terminateInstructions?: TerminateInstruction[];
|
|
515
|
+
}
|
|
516
|
+
export type ModifyProcessInstanceResponse = Record<string, never>;
|
|
517
|
+
export interface MigrateProcessInstanceRequest {
|
|
518
|
+
processInstanceKey: string;
|
|
519
|
+
migrationPlan: MigrationPlan;
|
|
520
|
+
}
|
|
521
|
+
interface MigrationPlan {
|
|
522
|
+
targetProcessDefinitionKey: string;
|
|
523
|
+
mappingInstructions: MappingInstruction[];
|
|
524
|
+
}
|
|
525
|
+
interface MappingInstruction {
|
|
526
|
+
sourceElementId: string;
|
|
527
|
+
targetElementId: string;
|
|
528
|
+
}
|
|
529
|
+
export type MigrateProcessInstanceResponse = Record<string, never>;
|
|
530
|
+
export type EvaluateDecisionRequest = {
|
|
531
|
+
/**
|
|
532
|
+
* the unique key identifying the decision to be evaluated (e.g. returned
|
|
533
|
+
* from a decision in the DeployResourceResponse message)
|
|
534
|
+
*/
|
|
535
|
+
decisionKey: string;
|
|
536
|
+
/**
|
|
537
|
+
* JSON document that will instantiate the variables for the decision to be
|
|
538
|
+
* evaluated; it must be a JSON object, as variables will be mapped in a
|
|
539
|
+
* key-value fashion, e.g. { "a": 1, "b": 2 } will create two variables,
|
|
540
|
+
* named "a" and "b" respectively, with their associated values.
|
|
541
|
+
* [{ "a": 1, "b": 2 }] would not be a valid argument, as the root of the
|
|
542
|
+
* JSON document is an array and not an object.
|
|
543
|
+
*/
|
|
544
|
+
variables: JSONDoc;
|
|
545
|
+
/**
|
|
546
|
+
* the tenant identifier of the decision
|
|
547
|
+
*/
|
|
548
|
+
tenantId?: string;
|
|
549
|
+
} | {
|
|
550
|
+
/** the ID of the decision to be evaluated */
|
|
551
|
+
decisionId: string;
|
|
552
|
+
/**
|
|
553
|
+
* JSON document that will instantiate the variables for the decision to be
|
|
554
|
+
* evaluated; it must be a JSON object, as variables will be mapped in a
|
|
555
|
+
* key-value fashion, e.g. { "a": 1, "b": 2 } will create two variables,
|
|
556
|
+
* named "a" and "b" respectively, with their associated values.
|
|
557
|
+
* [{ "a": 1, "b": 2 }] would not be a valid argument, as the root of the
|
|
558
|
+
* JSON document is an array and not an object.
|
|
559
|
+
*/
|
|
560
|
+
variables: JSONDoc;
|
|
561
|
+
/**
|
|
562
|
+
* the tenant identifier of the decision
|
|
563
|
+
*/
|
|
564
|
+
tenantId?: string;
|
|
565
|
+
};
|
|
566
|
+
export interface EvaluateDecisionResponse {
|
|
567
|
+
/**
|
|
568
|
+
* the unique key identifying the decision which was evaluated (e.g. returned
|
|
569
|
+
* from a decision in the DeployResourceResponse message)
|
|
570
|
+
*/
|
|
571
|
+
decisionKey: string;
|
|
572
|
+
/** the ID of the decision which was evaluated */
|
|
573
|
+
decisionId: string;
|
|
574
|
+
/** the name of the decision which was evaluated */
|
|
575
|
+
decisionName: string;
|
|
576
|
+
/** the version of the decision which was evaluated */
|
|
577
|
+
decisionVersion: number;
|
|
578
|
+
/**
|
|
579
|
+
* the ID of the decision requirements graph that the decision which was
|
|
580
|
+
* evaluated is part of.
|
|
581
|
+
*/
|
|
582
|
+
decisionRequirementsId: string;
|
|
583
|
+
/**
|
|
584
|
+
* the unique key identifying the decision requirements graph that the
|
|
585
|
+
* decision which was evaluated is part of.
|
|
586
|
+
*/
|
|
587
|
+
decisionRequirementsKey: string;
|
|
588
|
+
/**
|
|
589
|
+
* JSON document that will instantiate the result of the decision which was
|
|
590
|
+
* evaluated; it will be a JSON object, as the result output will be mapped
|
|
591
|
+
* in a key-value fashion, e.g. { "a": 1 }.
|
|
592
|
+
*/
|
|
593
|
+
decisionOutput: string;
|
|
594
|
+
/** a list of decisions that were evaluated within the requested decision evaluation */
|
|
595
|
+
evaluatedDecisions: EvaluatedDecision[];
|
|
596
|
+
/**
|
|
597
|
+
* an optional string indicating the ID of the decision which
|
|
598
|
+
* failed during evaluation
|
|
599
|
+
*/
|
|
600
|
+
failedDecisionId: string;
|
|
601
|
+
/** an optional message describing why the decision which was evaluated failed */
|
|
602
|
+
failureMessage: string;
|
|
603
|
+
/** the tenant identifier of the decision */
|
|
604
|
+
tenantId?: string;
|
|
605
|
+
}
|
|
606
|
+
export interface EvaluatedDecision {
|
|
607
|
+
/**
|
|
608
|
+
* the unique key identifying the decision which was evaluated (e.g. returned
|
|
609
|
+
* from a decision in the DeployResourceResponse message)
|
|
610
|
+
*/
|
|
611
|
+
decisionKey: string;
|
|
612
|
+
/** the ID of the decision which was evaluated */
|
|
613
|
+
decisionId: string;
|
|
614
|
+
/** the name of the decision which was evaluated */
|
|
615
|
+
decisionName: string;
|
|
616
|
+
/** the version of the decision which was evaluated */
|
|
617
|
+
decisionVersion: number;
|
|
618
|
+
/** the type of the decision which was evaluated */
|
|
619
|
+
decisionType: string;
|
|
620
|
+
/**
|
|
621
|
+
* JSON document that will instantiate the result of the decision which was
|
|
622
|
+
* evaluated; it will be a JSON object, as the result output will be mapped
|
|
623
|
+
* in a key-value fashion, e.g. { "a": 1 }.
|
|
624
|
+
*/
|
|
625
|
+
decisionOutput: string;
|
|
626
|
+
/** the decision rules that matched within this decision evaluation */
|
|
627
|
+
matchedRules: MatchedDecisionRule[];
|
|
628
|
+
/** the decision inputs that were evaluated within this decision evaluation */
|
|
629
|
+
evaluatedInputs: EvaluatedDecisionInput[];
|
|
630
|
+
/** the tenant identifier of the evaluated decision */
|
|
631
|
+
tenantId: string;
|
|
632
|
+
}
|
|
633
|
+
export interface EvaluatedDecisionInput {
|
|
634
|
+
/** the id of the evaluated decision input */
|
|
635
|
+
inputId: string;
|
|
636
|
+
/** the name of the evaluated decision input */
|
|
637
|
+
inputName: string;
|
|
638
|
+
/** the value of the evaluated decision input */
|
|
639
|
+
inputValue: string;
|
|
640
|
+
}
|
|
641
|
+
export interface EvaluatedDecisionOutput {
|
|
642
|
+
/** the id of the evaluated decision output */
|
|
643
|
+
outputId: string;
|
|
644
|
+
/** the name of the evaluated decision output */
|
|
645
|
+
outputName: string;
|
|
646
|
+
/** the value of the evaluated decision output */
|
|
647
|
+
outputValue: string;
|
|
648
|
+
}
|
|
649
|
+
export interface MatchedDecisionRule {
|
|
650
|
+
/** the id of the matched rule */
|
|
651
|
+
ruleId: string;
|
|
652
|
+
/** the index of the matched rule */
|
|
653
|
+
ruleIndex: number;
|
|
654
|
+
/** the evaluated decision outputs */
|
|
655
|
+
evaluatedOutputs: EvaluatedDecisionOutput[];
|
|
656
|
+
}
|
|
657
|
+
export interface DeleteResourceRequest {
|
|
658
|
+
/**
|
|
659
|
+
* The key of the resource that should be deleted. This can either be the key
|
|
660
|
+
* of a process definition, the key of a decision requirements definition or the key of a form.
|
|
661
|
+
*/
|
|
662
|
+
resourceKey: string;
|
|
663
|
+
}
|
|
664
|
+
export interface BroadcastSignalRequest {
|
|
665
|
+
/** The name of the signal */
|
|
666
|
+
signalName: string;
|
|
667
|
+
/**
|
|
668
|
+
* the signal variables as a JSON document; to be valid, the root of the document must be an
|
|
669
|
+
* object, e.g. { "a": "foo" }. [ "foo" ] would not be valid.
|
|
670
|
+
*/
|
|
671
|
+
variables: string;
|
|
672
|
+
/** the id of the tenant that owns the signal. */
|
|
673
|
+
tenantId?: string;
|
|
674
|
+
}
|
|
675
|
+
export interface BroadcastSignalResponse {
|
|
676
|
+
/** the unique ID of the signal that was broadcasted. */
|
|
677
|
+
key: string;
|
|
678
|
+
}
|
|
679
|
+
export {};
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.PartitionBrokerHealth = exports.PartitionBrokerRole = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Describes the Raft role of the broker for a given partition
|
|
6
|
+
*/
|
|
7
|
+
var PartitionBrokerRole;
|
|
8
|
+
(function (PartitionBrokerRole) {
|
|
9
|
+
PartitionBrokerRole[PartitionBrokerRole["LEADER"] = 0] = "LEADER";
|
|
10
|
+
PartitionBrokerRole[PartitionBrokerRole["BROKER"] = 1] = "BROKER";
|
|
11
|
+
PartitionBrokerRole[PartitionBrokerRole["INACTIVE"] = 2] = "INACTIVE";
|
|
12
|
+
})(PartitionBrokerRole || (exports.PartitionBrokerRole = PartitionBrokerRole = {}));
|
|
13
|
+
/**
|
|
14
|
+
* Describes the current health of the partition
|
|
15
|
+
*/
|
|
16
|
+
var PartitionBrokerHealth;
|
|
17
|
+
(function (PartitionBrokerHealth) {
|
|
18
|
+
PartitionBrokerHealth[PartitionBrokerHealth["HEALTHY"] = 0] = "HEALTHY";
|
|
19
|
+
PartitionBrokerHealth[PartitionBrokerHealth["UNHEALTHY"] = 1] = "UNHEALTHY";
|
|
20
|
+
PartitionBrokerHealth[PartitionBrokerHealth["DEAD"] = 2] = "DEAD";
|
|
21
|
+
})(PartitionBrokerHealth || (exports.PartitionBrokerHealth = PartitionBrokerHealth = {}));
|
|
22
|
+
//# sourceMappingURL=interfaces-grpc-1.0.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"interfaces-grpc-1.0.js","sourceRoot":"","sources":["../../../src/zeebe/lib/interfaces-grpc-1.0.ts"],"names":[],"mappings":";;;AAgPA;;GAEG;AACH,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC9B,iEAAU,CAAA;IACV,iEAAU,CAAA;IACV,qEAAY,CAAA;AACb,CAAC,EAJW,mBAAmB,mCAAnB,mBAAmB,QAI9B;AAED;;GAEG;AACH,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAChC,uEAAW,CAAA;IACX,2EAAa,CAAA;IACb,iEAAQ,CAAA;AACT,CAAC,EAJW,qBAAqB,qCAArB,qBAAqB,QAIhC"}
|