@camunda8/orchestration-cluster-api 9.1.4 → 9.1.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.
- package/CHANGELOG.md +12 -0
- package/dist/{chunk-4NRTES5E.js → chunk-JV6P7LF3.js} +68 -9
- package/dist/chunk-JV6P7LF3.js.map +1 -0
- package/dist/fp/index.cjs +72 -11
- package/dist/fp/index.cjs.map +1 -1
- package/dist/fp/index.d.cts +1 -1
- package/dist/fp/index.d.ts +1 -1
- package/dist/fp/index.js +1 -1
- package/dist/{index-CJBSKpFZ.d.ts → index-BIErHz2h.d.ts} +92 -32
- package/dist/{index-DKqh2mnN.d.cts → index-MCY6xbCc.d.cts} +92 -32
- package/dist/index.cjs +73 -12
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/dist/{zod.gen-I6G7OTVZ.js → zod.gen-UYZKIAHB.js} +7 -5
- package/dist/zod.gen-UYZKIAHB.js.map +1 -0
- package/package.json +1 -1
- package/dist/chunk-4NRTES5E.js.map +0 -1
- package/dist/zod.gen-I6G7OTVZ.js.map +0 -1
package/dist/fp/index.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { d as CamundaFpClient, AB as DomainError, AC as DomainErrorTag, E as Either, AE as FnKeys, AF as Fpify, AH as HttpError, AI as Left, AJ as Right, AL as TaskEither, AA as classifyDomainError, e as createCamundaFpClient, AD as eventuallyTE, AG as foldDomainError, i as isLeft, f as isRight, AK as retryTE, AM as withTimeoutTE } from '../index-
|
|
1
|
+
export { d as CamundaFpClient, AB as DomainError, AC as DomainErrorTag, E as Either, AE as FnKeys, AF as Fpify, AH as HttpError, AI as Left, AJ as Right, AL as TaskEither, AA as classifyDomainError, e as createCamundaFpClient, AD as eventuallyTE, AG as foldDomainError, i as isLeft, f as isRight, AK as retryTE, AM as withTimeoutTE } from '../index-MCY6xbCc.cjs';
|
|
2
2
|
import 'zod';
|
|
3
3
|
import '../logger-D-p21VHo.cjs';
|
|
4
4
|
import 'node:worker_threads';
|
package/dist/fp/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { d as CamundaFpClient, AB as DomainError, AC as DomainErrorTag, E as Either, AE as FnKeys, AF as Fpify, AH as HttpError, AI as Left, AJ as Right, AL as TaskEither, AA as classifyDomainError, e as createCamundaFpClient, AD as eventuallyTE, AG as foldDomainError, i as isLeft, f as isRight, AK as retryTE, AM as withTimeoutTE } from '../index-
|
|
1
|
+
export { d as CamundaFpClient, AB as DomainError, AC as DomainErrorTag, E as Either, AE as FnKeys, AF as Fpify, AH as HttpError, AI as Left, AJ as Right, AL as TaskEither, AA as classifyDomainError, e as createCamundaFpClient, AD as eventuallyTE, AG as foldDomainError, i as isLeft, f as isRight, AK as retryTE, AM as withTimeoutTE } from '../index-BIErHz2h.js';
|
|
2
2
|
import 'zod';
|
|
3
3
|
import '../logger-D-p21VHo.js';
|
|
4
4
|
import 'node:worker_threads';
|
package/dist/fp/index.js
CHANGED
|
@@ -3007,13 +3007,15 @@ type DeploymentResourceResult = {
|
|
|
3007
3007
|
type DeleteResourceRequest = {
|
|
3008
3008
|
operationReference?: OperationReference;
|
|
3009
3009
|
/**
|
|
3010
|
-
* Indicates if the historic data
|
|
3011
|
-
*
|
|
3012
|
-
*
|
|
3013
|
-
* This flag is
|
|
3014
|
-
* (
|
|
3015
|
-
*
|
|
3016
|
-
*
|
|
3010
|
+
* Indicates if the historic data associated with the resource should also be deleted
|
|
3011
|
+
* asynchronously.
|
|
3012
|
+
*
|
|
3013
|
+
* This flag is effective for process definitions and decision requirements definitions.
|
|
3014
|
+
* For other resource types (forms, generic resources) it is ignored and no history is
|
|
3015
|
+
* deleted. For a decision requirements definition the `batchOperation` field in the
|
|
3016
|
+
* response carries the created batch operation. For a process definition the history is
|
|
3017
|
+
* deleted as part of the definition's draining/deletion lifecycle and no batch operation is
|
|
3018
|
+
* returned.
|
|
3017
3019
|
*
|
|
3018
3020
|
*/
|
|
3019
3021
|
deleteHistory?: boolean;
|
|
@@ -3026,9 +3028,14 @@ type DeleteResourceResponse = {
|
|
|
3026
3028
|
/**
|
|
3027
3029
|
* The batch operation created for asynchronously deleting the historic data.
|
|
3028
3030
|
*
|
|
3029
|
-
*
|
|
3030
|
-
* is a process definition
|
|
3031
|
-
*
|
|
3031
|
+
* Populated when `deleteHistory` is `true` and either the resource is a decision
|
|
3032
|
+
* requirements definition, or the resource is a process definition that is already fully
|
|
3033
|
+
* deleted from the runtime state (its history is purged directly by a batch operation).
|
|
3034
|
+
*
|
|
3035
|
+
* For a process definition that still exists in the runtime state, deletion first drains
|
|
3036
|
+
* the definition and its history is removed asynchronously as part of that lifecycle, so no
|
|
3037
|
+
* batch operation is returned and this field is `null`. It is also `null` for forms and
|
|
3038
|
+
* generic resources.
|
|
3032
3039
|
*
|
|
3033
3040
|
*/
|
|
3034
3041
|
batchOperation: BatchOperationCreatedResult | null;
|
|
@@ -6296,12 +6303,14 @@ type ProcessDefinitionFilter = {
|
|
|
6296
6303
|
/**
|
|
6297
6304
|
* Filter by the process definition's state.
|
|
6298
6305
|
* When not set, process definitions in any state are returned.
|
|
6299
|
-
* Set to `ACTIVE` to exclude deleted definitions (recommended for most use cases).
|
|
6306
|
+
* Set to `ACTIVE` to exclude draining and deleted definitions (recommended for most use cases).
|
|
6307
|
+
* Set to `DRAINING` to return only definitions that are being deleted but still have
|
|
6308
|
+
* active process instances draining.
|
|
6300
6309
|
* Set to `DELETED` to return only definitions that have been deleted but are still
|
|
6301
6310
|
* retained in secondary storage.
|
|
6302
6311
|
*
|
|
6303
6312
|
*/
|
|
6304
|
-
state?: 'ACTIVE' | 'DELETED';
|
|
6313
|
+
state?: 'ACTIVE' | 'DRAINING' | 'DELETED';
|
|
6305
6314
|
};
|
|
6306
6315
|
type ProcessDefinitionSearchQueryResult = SearchQueryResponse & {
|
|
6307
6316
|
/**
|
|
@@ -6344,8 +6353,11 @@ type ProcessDefinitionResult = {
|
|
|
6344
6353
|
hasStartForm: boolean;
|
|
6345
6354
|
/**
|
|
6346
6355
|
* The state of this process definition.
|
|
6356
|
+
* `DRAINING` indicates the definition is being deleted but still has active process
|
|
6357
|
+
* instances draining before it is removed.
|
|
6358
|
+
*
|
|
6347
6359
|
*/
|
|
6348
|
-
state: 'ACTIVE' | 'DELETED';
|
|
6360
|
+
state: 'ACTIVE' | 'DRAINING' | 'DELETED';
|
|
6349
6361
|
};
|
|
6350
6362
|
/**
|
|
6351
6363
|
* Process definition element statistics request.
|
|
@@ -6563,7 +6575,7 @@ type ProcessInstanceCreationInstructionById = {
|
|
|
6563
6575
|
*/
|
|
6564
6576
|
processDefinitionId: ProcessDefinitionId;
|
|
6565
6577
|
/**
|
|
6566
|
-
* The version of the process.
|
|
6578
|
+
* The version of the process. If omitted, the latest active version is used.
|
|
6567
6579
|
*
|
|
6568
6580
|
*/
|
|
6569
6581
|
processDefinitionVersion?: number;
|
|
@@ -16672,7 +16684,7 @@ declare const createDeployment: <ThrowOnError extends boolean = true>(options: O
|
|
|
16672
16684
|
*
|
|
16673
16685
|
* Upload a document to the Camunda 8 cluster.
|
|
16674
16686
|
*
|
|
16675
|
-
* Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
|
|
16687
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP, in-memory (non-production), local (non-production)
|
|
16676
16688
|
*
|
|
16677
16689
|
*/
|
|
16678
16690
|
declare const createDocument: <ThrowOnError extends boolean = true>(options: Options<CreateDocumentData, ThrowOnError>) => RequestResult<CreateDocumentResponses, CreateDocumentErrors, ThrowOnError, "fields">;
|
|
@@ -16693,7 +16705,7 @@ declare const createDocument: <ThrowOnError extends boolean = true>(options: Opt
|
|
|
16693
16705
|
* each of which contains the file name of the document that failed to upload and the reason for the failure.
|
|
16694
16706
|
* The client can choose to retry the whole batch or individual documents based on the response.
|
|
16695
16707
|
*
|
|
16696
|
-
* Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
|
|
16708
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP, in-memory (non-production), local (non-production)
|
|
16697
16709
|
*
|
|
16698
16710
|
*/
|
|
16699
16711
|
declare const createDocuments: <ThrowOnError extends boolean = true>(options: Options<CreateDocumentsData, ThrowOnError>) => RequestResult<CreateDocumentsResponses, CreateDocumentsErrors, ThrowOnError, "fields">;
|
|
@@ -16702,7 +16714,7 @@ declare const createDocuments: <ThrowOnError extends boolean = true>(options: Op
|
|
|
16702
16714
|
*
|
|
16703
16715
|
* Delete a document from the Camunda 8 cluster.
|
|
16704
16716
|
*
|
|
16705
|
-
* Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
|
|
16717
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP, in-memory (non-production), local (non-production)
|
|
16706
16718
|
*
|
|
16707
16719
|
*/
|
|
16708
16720
|
declare const deleteDocument: <ThrowOnError extends boolean = true>(options: Options<DeleteDocumentData, ThrowOnError>) => RequestResult<DeleteDocumentResponses, DeleteDocumentErrors, ThrowOnError, "fields">;
|
|
@@ -16711,7 +16723,7 @@ declare const deleteDocument: <ThrowOnError extends boolean = true>(options: Opt
|
|
|
16711
16723
|
*
|
|
16712
16724
|
* Download a document from the Camunda 8 cluster.
|
|
16713
16725
|
*
|
|
16714
|
-
* Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
|
|
16726
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP, in-memory (non-production), local (non-production)
|
|
16715
16727
|
*
|
|
16716
16728
|
*/
|
|
16717
16729
|
declare const getDocument: <ThrowOnError extends boolean = true>(options: Options<GetDocumentData, ThrowOnError>) => RequestResult<GetDocumentResponses, GetDocumentErrors, ThrowOnError, "fields">;
|
|
@@ -16720,7 +16732,7 @@ declare const getDocument: <ThrowOnError extends boolean = true>(options: Option
|
|
|
16720
16732
|
*
|
|
16721
16733
|
* Create a link to a document in the Camunda 8 cluster.
|
|
16722
16734
|
*
|
|
16723
|
-
* Note that this is currently supported for document stores of type: AWS, GCP
|
|
16735
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP
|
|
16724
16736
|
*
|
|
16725
16737
|
*/
|
|
16726
16738
|
declare const createDocumentLink: <ThrowOnError extends boolean = true>(options: Options<CreateDocumentLinkData, ThrowOnError>) => RequestResult<CreateDocumentLinkResponses, CreateDocumentLinkErrors, ThrowOnError, "fields">;
|
|
@@ -17148,6 +17160,8 @@ declare const getProcessDefinitionInstanceVersionStatistics: <ThrowOnError exten
|
|
|
17148
17160
|
* Creates and starts an instance of the specified process.
|
|
17149
17161
|
* The process definition to use to create the instance can be specified either using its unique key
|
|
17150
17162
|
* (as returned by Deploy resources), or using the BPMN process id and a version.
|
|
17163
|
+
* If only the process definition id is given, the latest ACTIVE version is used.
|
|
17164
|
+
* If no ACTIVE version exists, the request is rejected as not found.
|
|
17151
17165
|
*
|
|
17152
17166
|
* Waits for the completion of the process instance before returning a result
|
|
17153
17167
|
* when awaitCompletion is enabled.
|
|
@@ -17323,10 +17337,18 @@ declare const getResourceContent: <ThrowOnError extends boolean = true>(options:
|
|
|
17323
17337
|
*
|
|
17324
17338
|
* By default, only the resource itself is deleted from the runtime state. To also delete the
|
|
17325
17339
|
* historic data associated with a resource, set the `deleteHistory` flag in the request body
|
|
17326
|
-
* to `true`.
|
|
17327
|
-
*
|
|
17328
|
-
*
|
|
17329
|
-
*
|
|
17340
|
+
* to `true`. History deletion is supported for process definitions and decision requirements
|
|
17341
|
+
* definitions; for other resource types (forms, generic resources) the flag is ignored and no
|
|
17342
|
+
* history is deleted.
|
|
17343
|
+
*
|
|
17344
|
+
* The two supported types differ in how the history is removed. For a decision requirements
|
|
17345
|
+
* definition the history is deleted asynchronously via a batch operation whose details are
|
|
17346
|
+
* returned in the `batchOperation` field of the response. For a process definition that still
|
|
17347
|
+
* exists in the runtime state, the definition first drains its running instances and its
|
|
17348
|
+
* history is deleted asynchronously once the definition is fully removed cluster-wide; no batch
|
|
17349
|
+
* operation is returned in the response. If the process definition has already been removed
|
|
17350
|
+
* from the runtime state and the deletion is later re-triggered with `deleteHistory` set to
|
|
17351
|
+
* `true`, a batch operation is created immediately and returned in the `batchOperation` field.
|
|
17330
17352
|
*/
|
|
17331
17353
|
declare const deleteResource: <ThrowOnError extends boolean = true>(options: Options<DeleteResourceData, ThrowOnError>) => RequestResult<DeleteResourceResponses, DeleteResourceErrors, ThrowOnError, "fields">;
|
|
17332
17354
|
/**
|
|
@@ -17814,6 +17836,18 @@ interface JobWorkerConfig<In extends z.ZodTypeAny = any, Out extends z.ZodTypeAn
|
|
|
17814
17836
|
customHeadersSchema?: Headers;
|
|
17815
17837
|
/** Backoff between polls - default 1ms */
|
|
17816
17838
|
pollIntervalMs?: number;
|
|
17839
|
+
/**
|
|
17840
|
+
* Floor (ms) of the exponential backoff applied between *failed* activation
|
|
17841
|
+
* requests (connection refused, connect timeout, broker restart, LAN blip …).
|
|
17842
|
+
* The first retry waits ≈ this/2–this ms; subsequent consecutive failures
|
|
17843
|
+
* double the window up to {@link pollBackoffMaxMs}, with jitter, and reset to
|
|
17844
|
+
* zero on the first successful poll. Default `1000`. Set to `0` to disable backoff (failed polls then fall back to {@link pollIntervalMs} rather than retrying immediately).
|
|
17845
|
+
*/
|
|
17846
|
+
pollBackoffMinMs?: number;
|
|
17847
|
+
/**
|
|
17848
|
+
* Ceiling (ms) of the between-failed-poll exponential backoff. Default `30000`.
|
|
17849
|
+
*/
|
|
17850
|
+
pollBackoffMaxMs?: number;
|
|
17817
17851
|
jobHandler: (job: Job<In, Headers>) => Promise<JobActionReceipt> | JobActionReceipt;
|
|
17818
17852
|
/** Immediately start polling for work - default `true` */
|
|
17819
17853
|
autoStart?: boolean;
|
|
@@ -17864,6 +17898,8 @@ declare class JobWorker {
|
|
|
17864
17898
|
private _stopped;
|
|
17865
17899
|
private _pollTimer;
|
|
17866
17900
|
private _inFlightActivation;
|
|
17901
|
+
/** Consecutive failed activation requests; drives the retry backoff, reset on success. */
|
|
17902
|
+
private _consecutiveActivationErrors;
|
|
17867
17903
|
private _log;
|
|
17868
17904
|
constructor(client: CamundaClient, cfg: JobWorkerConfig);
|
|
17869
17905
|
get name(): string;
|
|
@@ -17980,6 +18016,18 @@ interface ThreadedJobWorkerConfig<In extends z.ZodTypeAny = any, Out extends z.Z
|
|
|
17980
18016
|
customHeadersSchema?: Headers;
|
|
17981
18017
|
/** Backoff between polls - default 1ms */
|
|
17982
18018
|
pollIntervalMs?: number;
|
|
18019
|
+
/**
|
|
18020
|
+
* Floor (ms) of the exponential backoff applied between *failed* activation
|
|
18021
|
+
* requests (connection refused, connect timeout, broker restart, LAN blip …).
|
|
18022
|
+
* The first retry waits ≈ this/2–this ms; subsequent consecutive failures
|
|
18023
|
+
* double the window up to {@link pollBackoffMaxMs}, with jitter, and reset to
|
|
18024
|
+
* zero on the first successful poll. Default `1000`. Set to `0` to disable backoff (failed polls then fall back to {@link pollIntervalMs} rather than retrying immediately).
|
|
18025
|
+
*/
|
|
18026
|
+
pollBackoffMinMs?: number;
|
|
18027
|
+
/**
|
|
18028
|
+
* Ceiling (ms) of the between-failed-poll exponential backoff. Default `30000`.
|
|
18029
|
+
*/
|
|
18030
|
+
pollBackoffMaxMs?: number;
|
|
17983
18031
|
/** Immediately start polling for work - default `true` */
|
|
17984
18032
|
autoStart?: boolean;
|
|
17985
18033
|
/** Concurrency limit — default `10`. Overridden by CAMUNDA_WORKER_MAX_CONCURRENT_JOBS env var. */
|
|
@@ -18036,6 +18084,8 @@ declare class ThreadedJobWorker {
|
|
|
18036
18084
|
private _stopped;
|
|
18037
18085
|
private _pollTimer;
|
|
18038
18086
|
private _inFlightActivation;
|
|
18087
|
+
/** Consecutive failed activation requests; drives the retry backoff, reset on success. */
|
|
18088
|
+
private _consecutiveActivationErrors;
|
|
18039
18089
|
private _log;
|
|
18040
18090
|
private _jobQueue;
|
|
18041
18091
|
constructor(client: CamundaClient, pool: ThreadPool, cfg: ThreadedJobWorkerConfig);
|
|
@@ -20951,7 +21001,7 @@ declare class CamundaClient {
|
|
|
20951
21001
|
*
|
|
20952
21002
|
* Upload a document to the Camunda 8 cluster.
|
|
20953
21003
|
*
|
|
20954
|
-
* Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
|
|
21004
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP, in-memory (non-production), local (non-production)
|
|
20955
21005
|
*
|
|
20956
21006
|
*
|
|
20957
21007
|
* @example Upload a document
|
|
@@ -20978,7 +21028,7 @@ declare class CamundaClient {
|
|
|
20978
21028
|
*
|
|
20979
21029
|
* Create a link to a document in the Camunda 8 cluster.
|
|
20980
21030
|
*
|
|
20981
|
-
* Note that this is currently supported for document stores of type: AWS, GCP
|
|
21031
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP
|
|
20982
21032
|
*
|
|
20983
21033
|
*
|
|
20984
21034
|
* @example Create a document link
|
|
@@ -21015,7 +21065,7 @@ declare class CamundaClient {
|
|
|
21015
21065
|
* each of which contains the file name of the document that failed to upload and the reason for the failure.
|
|
21016
21066
|
* The client can choose to retry the whole batch or individual documents based on the response.
|
|
21017
21067
|
*
|
|
21018
|
-
* Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
|
|
21068
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP, in-memory (non-production), local (non-production)
|
|
21019
21069
|
*
|
|
21020
21070
|
*
|
|
21021
21071
|
* @example Upload multiple documents
|
|
@@ -21164,6 +21214,8 @@ declare class CamundaClient {
|
|
|
21164
21214
|
* Creates and starts an instance of the specified process.
|
|
21165
21215
|
* The process definition to use to create the instance can be specified either using its unique key
|
|
21166
21216
|
* (as returned by Deploy resources), or using the BPMN process id and a version.
|
|
21217
|
+
* If only the process definition id is given, the latest ACTIVE version is used.
|
|
21218
|
+
* If no ACTIVE version exists, the request is rejected as not found.
|
|
21167
21219
|
*
|
|
21168
21220
|
* Waits for the completion of the process instance before returning a result
|
|
21169
21221
|
* when awaitCompletion is enabled.
|
|
@@ -21359,7 +21411,7 @@ declare class CamundaClient {
|
|
|
21359
21411
|
*
|
|
21360
21412
|
* Delete a document from the Camunda 8 cluster.
|
|
21361
21413
|
*
|
|
21362
|
-
* Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
|
|
21414
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP, in-memory (non-production), local (non-production)
|
|
21363
21415
|
*
|
|
21364
21416
|
*
|
|
21365
21417
|
* @example Delete a document
|
|
@@ -21502,10 +21554,18 @@ declare class CamundaClient {
|
|
|
21502
21554
|
*
|
|
21503
21555
|
* By default, only the resource itself is deleted from the runtime state. To also delete the
|
|
21504
21556
|
* historic data associated with a resource, set the `deleteHistory` flag in the request body
|
|
21505
|
-
* to `true`.
|
|
21506
|
-
*
|
|
21507
|
-
*
|
|
21508
|
-
*
|
|
21557
|
+
* to `true`. History deletion is supported for process definitions and decision requirements
|
|
21558
|
+
* definitions; for other resource types (forms, generic resources) the flag is ignored and no
|
|
21559
|
+
* history is deleted.
|
|
21560
|
+
*
|
|
21561
|
+
* The two supported types differ in how the history is removed. For a decision requirements
|
|
21562
|
+
* definition the history is deleted asynchronously via a batch operation whose details are
|
|
21563
|
+
* returned in the `batchOperation` field of the response. For a process definition that still
|
|
21564
|
+
* exists in the runtime state, the definition first drains its running instances and its
|
|
21565
|
+
* history is deleted asynchronously once the definition is fully removed cluster-wide; no batch
|
|
21566
|
+
* operation is returned in the response. If the process definition has already been removed
|
|
21567
|
+
* from the runtime state and the deletion is later re-triggered with `deleteHistory` set to
|
|
21568
|
+
* `true`, a batch operation is created immediately and returned in the `batchOperation` field.
|
|
21509
21569
|
*
|
|
21510
21570
|
* @example Delete a resource
|
|
21511
21571
|
* ```ts
|
|
@@ -21917,7 +21977,7 @@ declare class CamundaClient {
|
|
|
21917
21977
|
*
|
|
21918
21978
|
* Download a document from the Camunda 8 cluster.
|
|
21919
21979
|
*
|
|
21920
|
-
* Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
|
|
21980
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP, in-memory (non-production), local (non-production)
|
|
21921
21981
|
*
|
|
21922
21982
|
*
|
|
21923
21983
|
* @example Download a document
|
|
@@ -3007,13 +3007,15 @@ type DeploymentResourceResult = {
|
|
|
3007
3007
|
type DeleteResourceRequest = {
|
|
3008
3008
|
operationReference?: OperationReference;
|
|
3009
3009
|
/**
|
|
3010
|
-
* Indicates if the historic data
|
|
3011
|
-
*
|
|
3012
|
-
*
|
|
3013
|
-
* This flag is
|
|
3014
|
-
* (
|
|
3015
|
-
*
|
|
3016
|
-
*
|
|
3010
|
+
* Indicates if the historic data associated with the resource should also be deleted
|
|
3011
|
+
* asynchronously.
|
|
3012
|
+
*
|
|
3013
|
+
* This flag is effective for process definitions and decision requirements definitions.
|
|
3014
|
+
* For other resource types (forms, generic resources) it is ignored and no history is
|
|
3015
|
+
* deleted. For a decision requirements definition the `batchOperation` field in the
|
|
3016
|
+
* response carries the created batch operation. For a process definition the history is
|
|
3017
|
+
* deleted as part of the definition's draining/deletion lifecycle and no batch operation is
|
|
3018
|
+
* returned.
|
|
3017
3019
|
*
|
|
3018
3020
|
*/
|
|
3019
3021
|
deleteHistory?: boolean;
|
|
@@ -3026,9 +3028,14 @@ type DeleteResourceResponse = {
|
|
|
3026
3028
|
/**
|
|
3027
3029
|
* The batch operation created for asynchronously deleting the historic data.
|
|
3028
3030
|
*
|
|
3029
|
-
*
|
|
3030
|
-
* is a process definition
|
|
3031
|
-
*
|
|
3031
|
+
* Populated when `deleteHistory` is `true` and either the resource is a decision
|
|
3032
|
+
* requirements definition, or the resource is a process definition that is already fully
|
|
3033
|
+
* deleted from the runtime state (its history is purged directly by a batch operation).
|
|
3034
|
+
*
|
|
3035
|
+
* For a process definition that still exists in the runtime state, deletion first drains
|
|
3036
|
+
* the definition and its history is removed asynchronously as part of that lifecycle, so no
|
|
3037
|
+
* batch operation is returned and this field is `null`. It is also `null` for forms and
|
|
3038
|
+
* generic resources.
|
|
3032
3039
|
*
|
|
3033
3040
|
*/
|
|
3034
3041
|
batchOperation: BatchOperationCreatedResult | null;
|
|
@@ -6296,12 +6303,14 @@ type ProcessDefinitionFilter = {
|
|
|
6296
6303
|
/**
|
|
6297
6304
|
* Filter by the process definition's state.
|
|
6298
6305
|
* When not set, process definitions in any state are returned.
|
|
6299
|
-
* Set to `ACTIVE` to exclude deleted definitions (recommended for most use cases).
|
|
6306
|
+
* Set to `ACTIVE` to exclude draining and deleted definitions (recommended for most use cases).
|
|
6307
|
+
* Set to `DRAINING` to return only definitions that are being deleted but still have
|
|
6308
|
+
* active process instances draining.
|
|
6300
6309
|
* Set to `DELETED` to return only definitions that have been deleted but are still
|
|
6301
6310
|
* retained in secondary storage.
|
|
6302
6311
|
*
|
|
6303
6312
|
*/
|
|
6304
|
-
state?: 'ACTIVE' | 'DELETED';
|
|
6313
|
+
state?: 'ACTIVE' | 'DRAINING' | 'DELETED';
|
|
6305
6314
|
};
|
|
6306
6315
|
type ProcessDefinitionSearchQueryResult = SearchQueryResponse & {
|
|
6307
6316
|
/**
|
|
@@ -6344,8 +6353,11 @@ type ProcessDefinitionResult = {
|
|
|
6344
6353
|
hasStartForm: boolean;
|
|
6345
6354
|
/**
|
|
6346
6355
|
* The state of this process definition.
|
|
6356
|
+
* `DRAINING` indicates the definition is being deleted but still has active process
|
|
6357
|
+
* instances draining before it is removed.
|
|
6358
|
+
*
|
|
6347
6359
|
*/
|
|
6348
|
-
state: 'ACTIVE' | 'DELETED';
|
|
6360
|
+
state: 'ACTIVE' | 'DRAINING' | 'DELETED';
|
|
6349
6361
|
};
|
|
6350
6362
|
/**
|
|
6351
6363
|
* Process definition element statistics request.
|
|
@@ -6563,7 +6575,7 @@ type ProcessInstanceCreationInstructionById = {
|
|
|
6563
6575
|
*/
|
|
6564
6576
|
processDefinitionId: ProcessDefinitionId;
|
|
6565
6577
|
/**
|
|
6566
|
-
* The version of the process.
|
|
6578
|
+
* The version of the process. If omitted, the latest active version is used.
|
|
6567
6579
|
*
|
|
6568
6580
|
*/
|
|
6569
6581
|
processDefinitionVersion?: number;
|
|
@@ -16672,7 +16684,7 @@ declare const createDeployment: <ThrowOnError extends boolean = true>(options: O
|
|
|
16672
16684
|
*
|
|
16673
16685
|
* Upload a document to the Camunda 8 cluster.
|
|
16674
16686
|
*
|
|
16675
|
-
* Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
|
|
16687
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP, in-memory (non-production), local (non-production)
|
|
16676
16688
|
*
|
|
16677
16689
|
*/
|
|
16678
16690
|
declare const createDocument: <ThrowOnError extends boolean = true>(options: Options<CreateDocumentData, ThrowOnError>) => RequestResult<CreateDocumentResponses, CreateDocumentErrors, ThrowOnError, "fields">;
|
|
@@ -16693,7 +16705,7 @@ declare const createDocument: <ThrowOnError extends boolean = true>(options: Opt
|
|
|
16693
16705
|
* each of which contains the file name of the document that failed to upload and the reason for the failure.
|
|
16694
16706
|
* The client can choose to retry the whole batch or individual documents based on the response.
|
|
16695
16707
|
*
|
|
16696
|
-
* Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
|
|
16708
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP, in-memory (non-production), local (non-production)
|
|
16697
16709
|
*
|
|
16698
16710
|
*/
|
|
16699
16711
|
declare const createDocuments: <ThrowOnError extends boolean = true>(options: Options<CreateDocumentsData, ThrowOnError>) => RequestResult<CreateDocumentsResponses, CreateDocumentsErrors, ThrowOnError, "fields">;
|
|
@@ -16702,7 +16714,7 @@ declare const createDocuments: <ThrowOnError extends boolean = true>(options: Op
|
|
|
16702
16714
|
*
|
|
16703
16715
|
* Delete a document from the Camunda 8 cluster.
|
|
16704
16716
|
*
|
|
16705
|
-
* Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
|
|
16717
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP, in-memory (non-production), local (non-production)
|
|
16706
16718
|
*
|
|
16707
16719
|
*/
|
|
16708
16720
|
declare const deleteDocument: <ThrowOnError extends boolean = true>(options: Options<DeleteDocumentData, ThrowOnError>) => RequestResult<DeleteDocumentResponses, DeleteDocumentErrors, ThrowOnError, "fields">;
|
|
@@ -16711,7 +16723,7 @@ declare const deleteDocument: <ThrowOnError extends boolean = true>(options: Opt
|
|
|
16711
16723
|
*
|
|
16712
16724
|
* Download a document from the Camunda 8 cluster.
|
|
16713
16725
|
*
|
|
16714
|
-
* Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
|
|
16726
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP, in-memory (non-production), local (non-production)
|
|
16715
16727
|
*
|
|
16716
16728
|
*/
|
|
16717
16729
|
declare const getDocument: <ThrowOnError extends boolean = true>(options: Options<GetDocumentData, ThrowOnError>) => RequestResult<GetDocumentResponses, GetDocumentErrors, ThrowOnError, "fields">;
|
|
@@ -16720,7 +16732,7 @@ declare const getDocument: <ThrowOnError extends boolean = true>(options: Option
|
|
|
16720
16732
|
*
|
|
16721
16733
|
* Create a link to a document in the Camunda 8 cluster.
|
|
16722
16734
|
*
|
|
16723
|
-
* Note that this is currently supported for document stores of type: AWS, GCP
|
|
16735
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP
|
|
16724
16736
|
*
|
|
16725
16737
|
*/
|
|
16726
16738
|
declare const createDocumentLink: <ThrowOnError extends boolean = true>(options: Options<CreateDocumentLinkData, ThrowOnError>) => RequestResult<CreateDocumentLinkResponses, CreateDocumentLinkErrors, ThrowOnError, "fields">;
|
|
@@ -17148,6 +17160,8 @@ declare const getProcessDefinitionInstanceVersionStatistics: <ThrowOnError exten
|
|
|
17148
17160
|
* Creates and starts an instance of the specified process.
|
|
17149
17161
|
* The process definition to use to create the instance can be specified either using its unique key
|
|
17150
17162
|
* (as returned by Deploy resources), or using the BPMN process id and a version.
|
|
17163
|
+
* If only the process definition id is given, the latest ACTIVE version is used.
|
|
17164
|
+
* If no ACTIVE version exists, the request is rejected as not found.
|
|
17151
17165
|
*
|
|
17152
17166
|
* Waits for the completion of the process instance before returning a result
|
|
17153
17167
|
* when awaitCompletion is enabled.
|
|
@@ -17323,10 +17337,18 @@ declare const getResourceContent: <ThrowOnError extends boolean = true>(options:
|
|
|
17323
17337
|
*
|
|
17324
17338
|
* By default, only the resource itself is deleted from the runtime state. To also delete the
|
|
17325
17339
|
* historic data associated with a resource, set the `deleteHistory` flag in the request body
|
|
17326
|
-
* to `true`.
|
|
17327
|
-
*
|
|
17328
|
-
*
|
|
17329
|
-
*
|
|
17340
|
+
* to `true`. History deletion is supported for process definitions and decision requirements
|
|
17341
|
+
* definitions; for other resource types (forms, generic resources) the flag is ignored and no
|
|
17342
|
+
* history is deleted.
|
|
17343
|
+
*
|
|
17344
|
+
* The two supported types differ in how the history is removed. For a decision requirements
|
|
17345
|
+
* definition the history is deleted asynchronously via a batch operation whose details are
|
|
17346
|
+
* returned in the `batchOperation` field of the response. For a process definition that still
|
|
17347
|
+
* exists in the runtime state, the definition first drains its running instances and its
|
|
17348
|
+
* history is deleted asynchronously once the definition is fully removed cluster-wide; no batch
|
|
17349
|
+
* operation is returned in the response. If the process definition has already been removed
|
|
17350
|
+
* from the runtime state and the deletion is later re-triggered with `deleteHistory` set to
|
|
17351
|
+
* `true`, a batch operation is created immediately and returned in the `batchOperation` field.
|
|
17330
17352
|
*/
|
|
17331
17353
|
declare const deleteResource: <ThrowOnError extends boolean = true>(options: Options<DeleteResourceData, ThrowOnError>) => RequestResult<DeleteResourceResponses, DeleteResourceErrors, ThrowOnError, "fields">;
|
|
17332
17354
|
/**
|
|
@@ -17814,6 +17836,18 @@ interface JobWorkerConfig<In extends z.ZodTypeAny = any, Out extends z.ZodTypeAn
|
|
|
17814
17836
|
customHeadersSchema?: Headers;
|
|
17815
17837
|
/** Backoff between polls - default 1ms */
|
|
17816
17838
|
pollIntervalMs?: number;
|
|
17839
|
+
/**
|
|
17840
|
+
* Floor (ms) of the exponential backoff applied between *failed* activation
|
|
17841
|
+
* requests (connection refused, connect timeout, broker restart, LAN blip …).
|
|
17842
|
+
* The first retry waits ≈ this/2–this ms; subsequent consecutive failures
|
|
17843
|
+
* double the window up to {@link pollBackoffMaxMs}, with jitter, and reset to
|
|
17844
|
+
* zero on the first successful poll. Default `1000`. Set to `0` to disable backoff (failed polls then fall back to {@link pollIntervalMs} rather than retrying immediately).
|
|
17845
|
+
*/
|
|
17846
|
+
pollBackoffMinMs?: number;
|
|
17847
|
+
/**
|
|
17848
|
+
* Ceiling (ms) of the between-failed-poll exponential backoff. Default `30000`.
|
|
17849
|
+
*/
|
|
17850
|
+
pollBackoffMaxMs?: number;
|
|
17817
17851
|
jobHandler: (job: Job<In, Headers>) => Promise<JobActionReceipt> | JobActionReceipt;
|
|
17818
17852
|
/** Immediately start polling for work - default `true` */
|
|
17819
17853
|
autoStart?: boolean;
|
|
@@ -17864,6 +17898,8 @@ declare class JobWorker {
|
|
|
17864
17898
|
private _stopped;
|
|
17865
17899
|
private _pollTimer;
|
|
17866
17900
|
private _inFlightActivation;
|
|
17901
|
+
/** Consecutive failed activation requests; drives the retry backoff, reset on success. */
|
|
17902
|
+
private _consecutiveActivationErrors;
|
|
17867
17903
|
private _log;
|
|
17868
17904
|
constructor(client: CamundaClient, cfg: JobWorkerConfig);
|
|
17869
17905
|
get name(): string;
|
|
@@ -17980,6 +18016,18 @@ interface ThreadedJobWorkerConfig<In extends z.ZodTypeAny = any, Out extends z.Z
|
|
|
17980
18016
|
customHeadersSchema?: Headers;
|
|
17981
18017
|
/** Backoff between polls - default 1ms */
|
|
17982
18018
|
pollIntervalMs?: number;
|
|
18019
|
+
/**
|
|
18020
|
+
* Floor (ms) of the exponential backoff applied between *failed* activation
|
|
18021
|
+
* requests (connection refused, connect timeout, broker restart, LAN blip …).
|
|
18022
|
+
* The first retry waits ≈ this/2–this ms; subsequent consecutive failures
|
|
18023
|
+
* double the window up to {@link pollBackoffMaxMs}, with jitter, and reset to
|
|
18024
|
+
* zero on the first successful poll. Default `1000`. Set to `0` to disable backoff (failed polls then fall back to {@link pollIntervalMs} rather than retrying immediately).
|
|
18025
|
+
*/
|
|
18026
|
+
pollBackoffMinMs?: number;
|
|
18027
|
+
/**
|
|
18028
|
+
* Ceiling (ms) of the between-failed-poll exponential backoff. Default `30000`.
|
|
18029
|
+
*/
|
|
18030
|
+
pollBackoffMaxMs?: number;
|
|
17983
18031
|
/** Immediately start polling for work - default `true` */
|
|
17984
18032
|
autoStart?: boolean;
|
|
17985
18033
|
/** Concurrency limit — default `10`. Overridden by CAMUNDA_WORKER_MAX_CONCURRENT_JOBS env var. */
|
|
@@ -18036,6 +18084,8 @@ declare class ThreadedJobWorker {
|
|
|
18036
18084
|
private _stopped;
|
|
18037
18085
|
private _pollTimer;
|
|
18038
18086
|
private _inFlightActivation;
|
|
18087
|
+
/** Consecutive failed activation requests; drives the retry backoff, reset on success. */
|
|
18088
|
+
private _consecutiveActivationErrors;
|
|
18039
18089
|
private _log;
|
|
18040
18090
|
private _jobQueue;
|
|
18041
18091
|
constructor(client: CamundaClient, pool: ThreadPool, cfg: ThreadedJobWorkerConfig);
|
|
@@ -20951,7 +21001,7 @@ declare class CamundaClient {
|
|
|
20951
21001
|
*
|
|
20952
21002
|
* Upload a document to the Camunda 8 cluster.
|
|
20953
21003
|
*
|
|
20954
|
-
* Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
|
|
21004
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP, in-memory (non-production), local (non-production)
|
|
20955
21005
|
*
|
|
20956
21006
|
*
|
|
20957
21007
|
* @example Upload a document
|
|
@@ -20978,7 +21028,7 @@ declare class CamundaClient {
|
|
|
20978
21028
|
*
|
|
20979
21029
|
* Create a link to a document in the Camunda 8 cluster.
|
|
20980
21030
|
*
|
|
20981
|
-
* Note that this is currently supported for document stores of type: AWS, GCP
|
|
21031
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP
|
|
20982
21032
|
*
|
|
20983
21033
|
*
|
|
20984
21034
|
* @example Create a document link
|
|
@@ -21015,7 +21065,7 @@ declare class CamundaClient {
|
|
|
21015
21065
|
* each of which contains the file name of the document that failed to upload and the reason for the failure.
|
|
21016
21066
|
* The client can choose to retry the whole batch or individual documents based on the response.
|
|
21017
21067
|
*
|
|
21018
|
-
* Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
|
|
21068
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP, in-memory (non-production), local (non-production)
|
|
21019
21069
|
*
|
|
21020
21070
|
*
|
|
21021
21071
|
* @example Upload multiple documents
|
|
@@ -21164,6 +21214,8 @@ declare class CamundaClient {
|
|
|
21164
21214
|
* Creates and starts an instance of the specified process.
|
|
21165
21215
|
* The process definition to use to create the instance can be specified either using its unique key
|
|
21166
21216
|
* (as returned by Deploy resources), or using the BPMN process id and a version.
|
|
21217
|
+
* If only the process definition id is given, the latest ACTIVE version is used.
|
|
21218
|
+
* If no ACTIVE version exists, the request is rejected as not found.
|
|
21167
21219
|
*
|
|
21168
21220
|
* Waits for the completion of the process instance before returning a result
|
|
21169
21221
|
* when awaitCompletion is enabled.
|
|
@@ -21359,7 +21411,7 @@ declare class CamundaClient {
|
|
|
21359
21411
|
*
|
|
21360
21412
|
* Delete a document from the Camunda 8 cluster.
|
|
21361
21413
|
*
|
|
21362
|
-
* Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
|
|
21414
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP, in-memory (non-production), local (non-production)
|
|
21363
21415
|
*
|
|
21364
21416
|
*
|
|
21365
21417
|
* @example Delete a document
|
|
@@ -21502,10 +21554,18 @@ declare class CamundaClient {
|
|
|
21502
21554
|
*
|
|
21503
21555
|
* By default, only the resource itself is deleted from the runtime state. To also delete the
|
|
21504
21556
|
* historic data associated with a resource, set the `deleteHistory` flag in the request body
|
|
21505
|
-
* to `true`.
|
|
21506
|
-
*
|
|
21507
|
-
*
|
|
21508
|
-
*
|
|
21557
|
+
* to `true`. History deletion is supported for process definitions and decision requirements
|
|
21558
|
+
* definitions; for other resource types (forms, generic resources) the flag is ignored and no
|
|
21559
|
+
* history is deleted.
|
|
21560
|
+
*
|
|
21561
|
+
* The two supported types differ in how the history is removed. For a decision requirements
|
|
21562
|
+
* definition the history is deleted asynchronously via a batch operation whose details are
|
|
21563
|
+
* returned in the `batchOperation` field of the response. For a process definition that still
|
|
21564
|
+
* exists in the runtime state, the definition first drains its running instances and its
|
|
21565
|
+
* history is deleted asynchronously once the definition is fully removed cluster-wide; no batch
|
|
21566
|
+
* operation is returned in the response. If the process definition has already been removed
|
|
21567
|
+
* from the runtime state and the deletion is later re-triggered with `deleteHistory` set to
|
|
21568
|
+
* `true`, a batch operation is created immediately and returned in the `batchOperation` field.
|
|
21509
21569
|
*
|
|
21510
21570
|
* @example Delete a resource
|
|
21511
21571
|
* ```ts
|
|
@@ -21917,7 +21977,7 @@ declare class CamundaClient {
|
|
|
21917
21977
|
*
|
|
21918
21978
|
* Download a document from the Camunda 8 cluster.
|
|
21919
21979
|
*
|
|
21920
|
-
* Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production)
|
|
21980
|
+
* Note that this is currently supported for document stores of type: AWS, Azure, GCP, in-memory (non-production), local (non-production)
|
|
21921
21981
|
*
|
|
21922
21982
|
*
|
|
21923
21983
|
* @example Download a document
|