@camunda8/sdk 8.6.13 → 8.6.14

package/CHANGELOG.md

@@ -1,3 +1,33 @@
+## [8.6.14](https://github.com/camunda/camunda-8-js-sdk/compare/v8.6.13...v8.6.14) (2024-10-24)
+
+
+### Bug Fixes
+
+* **camunda8:** correctly parse autostart parameter of JobWorker ([cb95946](https://github.com/camunda/camunda-8-js-sdk/commit/cb95946ab989f86a5992900292db2227be0824db))
+* **camunda8:** type variables in async process instance start as never ([3055734](https://github.com/camunda/camunda-8-js-sdk/commit/3055734f521341aff850b6545c8919d38d9642a6))
+* **lossless-parser:** correctly parse number array ([d69729a](https://github.com/camunda/camunda-8-js-sdk/commit/d69729ad07f05649a59b9f89282dc01f87698b4f)), closes [#258](https://github.com/camunda/camunda-8-js-sdk/issues/258)
+* **lossless-parser:** throw on encountering Date, Map, or Set ([bb5d8ea](https://github.com/camunda/camunda-8-js-sdk/commit/bb5d8ea666d7d6f0da9823f7ecf0a187708eab6b)), closes [#254](https://github.com/camunda/camunda-8-js-sdk/issues/254)
+* **zeebe:** do not override explicit ZEEBE_GRPC_ADDRESS with default ZEEBE_ADDRESS ([cd6080f](https://github.com/camunda/camunda-8-js-sdk/commit/cd6080fcaa8073e4655f72127af30db11f9ef743)), closes [#245](https://github.com/camunda/camunda-8-js-sdk/issues/245)
+* **zeebe:** throw on client if array passed as variables to CompleteJob ([40a6316](https://github.com/camunda/camunda-8-js-sdk/commit/40a63164a7588ea81fa0df16e9538fa5366dc049)), closes [#247](https://github.com/camunda/camunda-8-js-sdk/issues/247)
+
+
+### Features
+
+* **camunda8:** add C8RestClient ([8e93c92](https://github.com/camunda/camunda-8-js-sdk/commit/8e93c92bfb3684b530428f253f5de05c771e4215)), closes [#235](https://github.com/camunda/camunda-8-js-sdk/issues/235)
+* **camunda8:** add modifyAuthorization method ([0d97f68](https://github.com/camunda/camunda-8-js-sdk/commit/0d97f681ad1a1c9d295f43c83f342b6eb5cfa3da))
+* **camunda8:** complete deployResources feature ([8043ac9](https://github.com/camunda/camunda-8-js-sdk/commit/8043ac9afe5f6f6ec6e8bdfa90dbf40def6a0510))
+* **camunda8:** implement createProcessInstanceWithResult ([4ec4fa1](https://github.com/camunda/camunda-8-js-sdk/commit/4ec4fa1b6c1554bbac04ba275da3e1bba2dbf012))
+* **camunda8:** implement deleteResource over REST ([1dcb101](https://github.com/camunda/camunda-8-js-sdk/commit/1dcb1019b96788d952363d776a6976b99588d541)), closes [#251](https://github.com/camunda/camunda-8-js-sdk/issues/251)
+* **camunda8:** implement deployResources REST API ([debd212](https://github.com/camunda/camunda-8-js-sdk/commit/debd2122e713e98e3180a0bf0b200a1560788b81))
+* **camunda8:** implement publishMessage over REST ([057a9fe](https://github.com/camunda/camunda-8-js-sdk/commit/057a9feaf1a6e13011f130ca201947e39de54390)), closes [#250](https://github.com/camunda/camunda-8-js-sdk/issues/250)
+* **camunda8:** support broadcastSignal over REST ([43f82a4](https://github.com/camunda/camunda-8-js-sdk/commit/43f82a44f69f0217003775d422c741555f1fe6b1)), closes [#248](https://github.com/camunda/camunda-8-js-sdk/issues/248)
+* **camunda8:** support pluggable winston logging for C8RestClient ([d41d3f8](https://github.com/camunda/camunda-8-js-sdk/commit/d41d3f8de6afe2d8d3daff207519a52119f26cc9))
+* **camunda8:** support updateElementInstanceVariables ([7de82b7](https://github.com/camunda/camunda-8-js-sdk/commit/7de82b75c9a08fe34444d549e3c9c2077a768b3e)), closes [#249](https://github.com/camunda/camunda-8-js-sdk/issues/249)
+* **repo:** support passing middleware ([1b7715e](https://github.com/camunda/camunda-8-js-sdk/commit/1b7715e0e2778b058d7e0d8b67f29a27007c06af)), closes [#261](https://github.com/camunda/camunda-8-js-sdk/issues/261)
+* **zeebe:** add operationReference field to gRPC methods ([2e5af66](https://github.com/camunda/camunda-8-js-sdk/commit/2e5af662f9ecc1ee23115eb4232e0633afde3efe)), closes [#237](https://github.com/camunda/camunda-8-js-sdk/issues/237)
+* **zeebe:** create and cancel process instances over REST ([a49d217](https://github.com/camunda/camunda-8-js-sdk/commit/a49d217f95b9b550bedd9af79fe9d950ad31add2))
+* **zeebe:** lossless parse REST variables and customheaders ([f19a252](https://github.com/camunda/camunda-8-js-sdk/commit/f19a2520778836c34a3685d584c4969380672804)), closes [#244](https://github.com/camunda/camunda-8-js-sdk/issues/244)
+
 ## [8.6.13](https://github.com/camunda/camunda-8-js-sdk/compare/v8.6.12...v8.6.13) (2024-09-26)
 
 

package/README.md

@@ -59,7 +59,7 @@ Entity keys in Camunda 8 are stored and represented as `int64` numbers. The rang
 
 Some number values - for example: "_total returned results_ " - may be specified as `int64` in the API specifications. Although these numbers will usually not contain unsafe values, they are always serialised to `string`.
 
-For `int64` values whose type is not known ahead of time, such as job variables, you can pass an annotated data transfer object (DTO) to decode them reliably. If no DTO is specified, the default behavior of the SDK is to serialise all numbers to JavaScript `number`, and if a number value is detected at a runtime that cannot be accurately stored as `number`, to throw an exception.
+For `int64` values whose type is not known ahead of time, such as job variables, you can pass an annotated data transfer object (DTO) to decode them reliably. If no DTO is specified, the default behavior of the SDK is to serialise all numbers to JavaScript `number`, and to throw an exception if a number value is detected at a runtime that cannot be accurately represented as the JavaScript `number` type (that is, a value greater than 2^53-1).
 
 ## Authorization
 
@@ -222,9 +222,31 @@ Here is an example of turning on debugging for the OAuth and Operate components:
 DEBUG=camunda:oauth,camunda:operate node app.js
 ```
 
+## Process Variable Typing
+
+Process variables - the `variables` of Zeebe messages, jobs, and process instance creation requests and responses - are stored in the broker as key:value pairs. They are transported as a JSON string. The SDK parses the JSON string into a JavaScript object.
+
+Various Zeebe methods accept DTO classes for variable input and output. These DTO classes are used to provide design-time type information on the `variables` object. They are also used to safely decode 64-bit integer values that cannot be accurately represented by the JavaScript `number` type.
+
+To create a DTO to represent the expected shape and type of the `variables` object, extend the `LosslessDto` class:
+
+```typescript
+class myVariableDTO extends LosslessDto {
+	firstName!: string
+	lastName!: string
+	age!: number
+	optionalValue?: number
+	@Int64String
+	veryBigInteger?: string
+	constructor(data: Partial<myVariableDTO>) {
+		super(data)
+	}
+}
+```
+
 ## Typing of Zeebe worker variables
 
-The variable payload in a Zeebe worker task handler is available as an object `job.variables`. By default, this is of type `any`.
+The variable payload in a Zeebe worker task handler is available as an object `job.variables`. By default, this is of type `any` for the gRPC API, and `unknown` for the REST API.
 
 The `ZBClient.createWorker()` method accepts an `inputVariableDto` to control the parsing of number values and provide design-time type information. Passing an `inputVariableDto` class to a Zeebe worker is optional. If a DTO class is passed to the Zeebe worker, it is used for two purposes:
 

package/dist/admin/lib/AdminApiClient.js

@@ -31,6 +31,7 @@ class AdminApiClient {
                     (0, lib_1.makeBeforeRetryHandlerFor401TokenRetry)(this.getHeaders.bind(this)),
                 ],
                 beforeError: [lib_1.gotBeforeErrorHook],
+                beforeRequest: config.middleware ?? [],
             },
         }));
         debug('prefixUrl', `${prefixUrl}`);

package/dist/admin/lib/AdminApiClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"AdminApiClient.js","sourceRoot":"","sources":["../../../src/admin/lib/AdminApiClient.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAqB;AACrB,8CAAqB;AAErB,mCAYkB;AAKlB,MAAM,KAAK,GAAG,IAAA,eAAC,EAAC,sBAAsB,CAAC,CAAA;AAEvC;;;GAGG;AACH,MAAa,cAAc;IAK1B,YAAY,OAGX;QACA,MAAM,MAAM,GAAG,oCAA8B,CAAC,0BAA0B,CACvE,OAAO,EAAE,MAAM,IAAI,EAAE,CACrB,CAAA;QACD,MAAM,SAAS,GAAG,IAAA,0BAAoB,EACrC,MAAM,CAAC,wBAAwB,EAC/B,0BAA0B,CAC1B,CAAA;QAED,IAAI,CAAC,aAAa;YACjB,OAAO,EAAE,aAAa,IAAI,IAAA,4BAAsB,EAAC,MAAM,CAAC,CAAA;QAEzD,IAAI,CAAC,eAAe,GAAG,IAAA,2BAAqB,EAAC,MAAM,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,GAAG,IAAA,gCAA0B,EAAC,MAAM,CAAC,CAAC,IAAI,CAClD,CAAC,oBAAoB,EAAE,EAAE,CACxB,aAAG,CAAC,MAAM,CAAC;YACV,SAAS;YACT,KAAK,EAAE,oBAAc;YACrB,KAAK,EAAE;gBACN,oBAAoB;aACpB;YACD,QAAQ,EAAE,CAAC,qBAAe,CAAC;YAC3B,KAAK,EAAE;gBACN,WAAW,EAAE;oBACZ,IAAA,4CAAsC,EACrC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAC1B;iBACD;gBACD,WAAW,EAAE,CAAC,wBAAkB,CAAC;aACjC;SACD,CAAC,CACH,CAAA;QACD,KAAK,CAAC,WAAW,EAAE,GAAG,SAAS,EAAE,CAAC,CAAA;IACnC,CAAC;IAEO,KAAK,CAAC,UAAU;QACvB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QAC1D,MAAM,OAAO,GAAG;YACf,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,UAAU,KAAK,EAAE;YAChC,YAAY,EAAE,IAAI,CAAC,eAAe;YAClC,MAAM,EAAE,KAAK;SACb,CAAA;QACD,OAAO,OAAO,CAAA;IACf,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,YAAY,WAAW,UAAU,EAAE;YAC9C,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,GAIlB;QACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,IAAI,CAAC,YAAY,GAAG,CAAC,WAAW,UAAU,EAAE;YAC5C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACpB,UAAU,EAAE,GAAG,CAAC,UAAU;gBAC1B,WAAW,EAAE,GAAG,CAAC,WAAW;aAC5B,CAAC;YACF,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CACd,WAAmB,EACnB,QAAgB;QAEhB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,YAAY,WAAW,YAAY,QAAQ,EAAE,EAAE;YAC1D,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,WAAmB,EAAE,QAAgB;QACvD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,MAAM,CAAC,YAAY,WAAW,YAAY,QAAQ,EAAE,EAAE;YACtD,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW;QAChB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,UAAU,EAAE;YACvB,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAClB,oBAA2C;QAE3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,GAAG,GAAG;YACX,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC;YAC1C,OAAO;SACP,CAAA;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IACzC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,YAAY,WAAW,EAAE,EAAE;YACtC,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,WAAmB;QACtC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,MAAM,CAAC,YAAY,WAAW,EAAE,EAAE;YAClC,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa;QAClB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,qBAAqB,EAAE;YAClC,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,YAAY,WAAW,UAAU,EAAE;YAC9C,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,EAClB,WAAW,EACX,UAAU,EACV,WAAW,GAKX;QACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,GAAG,GAAG;YACX,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC;YACjD,OAAO;SACP,CAAA;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,WAAW,UAAU,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IAChE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,WAAmB,EAAE,UAAkB;QACzD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,MAAM,CAAC,YAAY,WAAW,YAAY,UAAU,EAAE,EAAE;YACxD,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CACjB,WAAmB,EACnB,WAKC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,GAAG,CAAC,YAAY,WAAW,cAAc,EAAE;YAC3C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACpB,WAAW;aACX,CAAC;YACF,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ;QACb,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,GAAG,CAAC,SAAS,EAAE;YACf,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CACjB,KAAa,EACb,QAAgC;QAEhC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,IAAI,CAAC,WAAW,KAAK,EAAE,EAAE;YACzB,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;SAClC,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,KAAa;QAC/B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,MAAM,CAAC,WAAW,KAAK,EAAE,EAAE;YAC3B,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;CACD;AAvUD,wCAuUC"}
+{"version":3,"file":"AdminApiClient.js","sourceRoot":"","sources":["../../../src/admin/lib/AdminApiClient.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAqB;AACrB,8CAAqB;AAErB,mCAYkB;AAKlB,MAAM,KAAK,GAAG,IAAA,eAAC,EAAC,sBAAsB,CAAC,CAAA;AAEvC;;;GAGG;AACH,MAAa,cAAc;IAK1B,YAAY,OAGX;QACA,MAAM,MAAM,GAAG,oCAA8B,CAAC,0BAA0B,CACvE,OAAO,EAAE,MAAM,IAAI,EAAE,CACrB,CAAA;QACD,MAAM,SAAS,GAAG,IAAA,0BAAoB,EACrC,MAAM,CAAC,wBAAwB,EAC/B,0BAA0B,CAC1B,CAAA;QAED,IAAI,CAAC,aAAa;YACjB,OAAO,EAAE,aAAa,IAAI,IAAA,4BAAsB,EAAC,MAAM,CAAC,CAAA;QAEzD,IAAI,CAAC,eAAe,GAAG,IAAA,2BAAqB,EAAC,MAAM,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,GAAG,IAAA,gCAA0B,EAAC,MAAM,CAAC,CAAC,IAAI,CAClD,CAAC,oBAAoB,EAAE,EAAE,CACxB,aAAG,CAAC,MAAM,CAAC;YACV,SAAS;YACT,KAAK,EAAE,oBAAc;YACrB,KAAK,EAAE;gBACN,oBAAoB;aACpB;YACD,QAAQ,EAAE,CAAC,qBAAe,CAAC;YAC3B,KAAK,EAAE;gBACN,WAAW,EAAE;oBACZ,IAAA,4CAAsC,EACrC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAC1B;iBACD;gBACD,WAAW,EAAE,CAAC,wBAAkB,CAAC;gBACjC,aAAa,EAAE,MAAM,CAAC,UAAU,IAAI,EAAE;aACtC;SACD,CAAC,CACH,CAAA;QACD,KAAK,CAAC,WAAW,EAAE,GAAG,SAAS,EAAE,CAAC,CAAA;IACnC,CAAC;IAEO,KAAK,CAAC,UAAU;QACvB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QAC1D,MAAM,OAAO,GAAG;YACf,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,UAAU,KAAK,EAAE;YAChC,YAAY,EAAE,IAAI,CAAC,eAAe;YAClC,MAAM,EAAE,KAAK;SACb,CAAA;QACD,OAAO,OAAO,CAAA;IACf,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,YAAY,WAAW,UAAU,EAAE;YAC9C,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,GAIlB;QACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,IAAI,CAAC,YAAY,GAAG,CAAC,WAAW,UAAU,EAAE;YAC5C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACpB,UAAU,EAAE,GAAG,CAAC,UAAU;gBAC1B,WAAW,EAAE,GAAG,CAAC,WAAW;aAC5B,CAAC;YACF,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CACd,WAAmB,EACnB,QAAgB;QAEhB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,YAAY,WAAW,YAAY,QAAQ,EAAE,EAAE;YAC1D,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,WAAmB,EAAE,QAAgB;QACvD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,MAAM,CAAC,YAAY,WAAW,YAAY,QAAQ,EAAE,EAAE;YACtD,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW;QAChB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,UAAU,EAAE;YACvB,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAClB,oBAA2C;QAE3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,GAAG,GAAG;YACX,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC;YAC1C,OAAO;SACP,CAAA;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IACzC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,YAAY,WAAW,EAAE,EAAE;YACtC,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,WAAmB;QACtC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,MAAM,CAAC,YAAY,WAAW,EAAE,EAAE;YAClC,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa;QAClB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,qBAAqB,EAAE;YAClC,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,YAAY,WAAW,UAAU,EAAE;YAC9C,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,EAClB,WAAW,EACX,UAAU,EACV,WAAW,GAKX;QACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,GAAG,GAAG;YACX,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC;YACjD,OAAO;SACP,CAAA;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,WAAW,UAAU,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IAChE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,WAAmB,EAAE,UAAkB;QACzD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,MAAM,CAAC,YAAY,WAAW,YAAY,UAAU,EAAE,EAAE;YACxD,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CACjB,WAAmB,EACnB,WAKC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,GAAG,CAAC,YAAY,WAAW,cAAc,EAAE;YAC3C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACpB,WAAW;aACX,CAAC;YACF,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ;QACb,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,GAAG,CAAC,SAAS,EAAE;YACf,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CACjB,KAAa,EACb,QAAgC;QAEhC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,IAAI,CAAC,WAAW,KAAK,EAAE,EAAE;YACzB,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;SAClC,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,KAAa;QAC/B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,MAAM,CAAC,WAAW,KAAK,EAAE,EAAE;YAC3B,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;CACD;AAxUD,wCAwUC"}

package/dist/c8/index.d.ts

@@ -1,10 +1,12 @@
 import { AdminApiClient } from '../admin';
-import { CamundaPlatform8Configuration, DeepPartial } from '../lib';
+import { Camunda8ClientConfiguration } from '../lib';
 import { ModelerApiClient } from '../modeler';
 import { OperateApiClient } from '../operate';
 import { OptimizeApiClient } from '../optimize';
 import { TasklistApiClient } from '../tasklist';
 import { ZeebeGrpcClient, ZeebeRestClient } from '../zeebe';
+import { Logger } from './lib/C8Logger';
+import { CamundaRestClient } from './lib/CamundaRestClient';
 /**
  * A single point of configuration for all Camunda Platform 8 clients.
  *
@@ -16,12 +18,12 @@ import { ZeebeGrpcClient, ZeebeRestClient } from '../zeebe';
  *
  * const c8 = new Camunda8()
  * const zeebe = c8.getZeebeGrpcApiClient()
- * const zeebeRest = c8.getZeebeRestClient()
  * const operate = c8.getOperateApiClient()
  * const optimize = c8.getOptimizeApiClient()
  * const tasklist = c8.getTasklistApiClient()
  * const modeler = c8.getModelerApiClient()
  * const admin = c8.getAdminApiClient()
+ * const c8Rest = c8.getCamundaRestClient()
  * ```
  */
 export declare class Camunda8 {
@@ -34,12 +36,21 @@ export declare class Camunda8 {
     private zeebeRestClient?;
     private configuration;
     private oAuthProvider;
-    constructor(config?: DeepPartial<CamundaPlatform8Configuration>);
-    getOperateApiClient(): OperateApiClient;
-    getAdminApiClient(): AdminApiClient;
-    getModelerApiClient(): ModelerApiClient;
-    getOptimizeApiClient(): OptimizeApiClient;
-    getTasklistApiClient(): TasklistApiClient;
-    getZeebeGrpcApiClient(): ZeebeGrpcClient;
-    getZeebeRestClient(): ZeebeRestClient;
+    private camundaRestClient?;
+    log: Logger;
+    /**
+     * All constructor parameters for configuration are optional. If no configuration is provided, the SDK will use environment variables to configure itself.
+     */
+    constructor(config?: Camunda8ClientConfiguration);
+    getOperateApiClient(config?: Camunda8ClientConfiguration): OperateApiClient;
+    getAdminApiClient(config?: Camunda8ClientConfiguration): AdminApiClient;
+    getModelerApiClient(config?: Camunda8ClientConfiguration): ModelerApiClient;
+    getOptimizeApiClient(config?: Camunda8ClientConfiguration): OptimizeApiClient;
+    getTasklistApiClient(config?: Camunda8ClientConfiguration): TasklistApiClient;
+    getZeebeGrpcApiClient(config?: Camunda8ClientConfiguration): ZeebeGrpcClient;
+    /**
+     * @deprecated from 8.6.0. Please use getCamundaRestClient() instead.
+     */
+    getZeebeRestClient(config?: Camunda8ClientConfiguration): ZeebeRestClient;
+    getCamundaRestClient(config?: Camunda8ClientConfiguration): CamundaRestClient;
 }

package/dist/c8/index.js

@@ -8,6 +8,8 @@ const operate_1 = require("../operate");
 const optimize_1 = require("../optimize");
 const tasklist_1 = require("../tasklist");
 const zeebe_1 = require("../zeebe");
+const C8Logger_1 = require("./lib/C8Logger");
+const CamundaRestClient_1 = require("./lib/CamundaRestClient");
 /**
  * A single point of configuration for all Camunda Platform 8 clients.
  *
@@ -19,83 +21,99 @@ const zeebe_1 = require("../zeebe");
  *
  * const c8 = new Camunda8()
  * const zeebe = c8.getZeebeGrpcApiClient()
- * const zeebeRest = c8.getZeebeRestClient()
  * const operate = c8.getOperateApiClient()
  * const optimize = c8.getOptimizeApiClient()
  * const tasklist = c8.getTasklistApiClient()
  * const modeler = c8.getModelerApiClient()
  * const admin = c8.getAdminApiClient()
+ * const c8Rest = c8.getCamundaRestClient()
  * ```
  */
 class Camunda8 {
+    /**
+     * All constructor parameters for configuration are optional. If no configuration is provided, the SDK will use environment variables to configure itself.
+     */
     constructor(config = {}) {
         this.configuration =
             lib_1.CamundaEnvironmentConfigurator.mergeConfigWithEnvironment(config);
         this.oAuthProvider = (0, lib_1.constructOAuthProvider)(this.configuration);
+        this.log = (0, C8Logger_1.getLogger)(config);
     }
-    getOperateApiClient() {
+    getOperateApiClient(config = {}) {
         if (!this.operateApiClient) {
             this.operateApiClient = new operate_1.OperateApiClient({
-                config: this.configuration,
+                config: { ...this.configuration, ...config },
                 oAuthProvider: this.oAuthProvider,
             });
         }
         return this.operateApiClient;
     }
-    getAdminApiClient() {
+    getAdminApiClient(config = {}) {
         if (!this.adminApiClient) {
             this.adminApiClient = new admin_1.AdminApiClient({
-                config: this.configuration,
+                config: { ...this.configuration, ...config },
                 oAuthProvider: this.oAuthProvider,
             });
         }
         return this.adminApiClient;
     }
-    getModelerApiClient() {
+    getModelerApiClient(config = {}) {
         if (!this.modelerApiClient) {
             this.modelerApiClient = new modeler_1.ModelerApiClient({
-                config: this.configuration,
+                config: { ...this.configuration, ...config },
                 oAuthProvider: this.oAuthProvider,
             });
         }
         return this.modelerApiClient;
     }
-    getOptimizeApiClient() {
+    getOptimizeApiClient(config = {}) {
         if (!this.optimizeApiClient) {
             this.optimizeApiClient = new optimize_1.OptimizeApiClient({
-                config: this.configuration,
+                config: { ...this.configuration, ...config },
                 oAuthProvider: this.oAuthProvider,
             });
         }
         return this.optimizeApiClient;
     }
-    getTasklistApiClient() {
+    getTasklistApiClient(config = {}) {
         if (!this.tasklistApiClient) {
             this.tasklistApiClient = new tasklist_1.TasklistApiClient({
-                config: this.configuration,
+                config: { ...this.configuration, ...config },
                 oAuthProvider: this.oAuthProvider,
             });
         }
         return this.tasklistApiClient;
     }
-    getZeebeGrpcApiClient() {
+    getZeebeGrpcApiClient(config = {}) {
         if (!this.zeebeGrpcApiClient) {
             this.zeebeGrpcApiClient = new zeebe_1.ZeebeGrpcClient({
-                config: this.configuration,
+                config: { ...this.configuration, ...config },
                 oAuthProvider: this.oAuthProvider,
             });
         }
         return this.zeebeGrpcApiClient;
     }
-    getZeebeRestClient() {
+    /**
+     * @deprecated from 8.6.0. Please use getCamundaRestClient() instead.
+     */
+    getZeebeRestClient(config = {}) {
         if (!this.zeebeRestClient) {
             this.zeebeRestClient = new zeebe_1.ZeebeRestClient({
-                config: this.configuration,
+                config: { ...this.configuration, ...config },
                 oAuthProvider: this.oAuthProvider,
             });
         }
         return this.zeebeRestClient;
     }
+    getCamundaRestClient(config = {}) {
+        if (!this.camundaRestClient) {
+            this.camundaRestClient = new CamundaRestClient_1.CamundaRestClient({
+                config: { ...this.configuration, ...config },
+                oAuthProvider: this.oAuthProvider,
+            });
+        }
+        return this.camundaRestClient;
+    }
 }
 exports.Camunda8 = Camunda8;
 //# sourceMappingURL=index.js.map

package/dist/c8/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/c8/index.ts"],"names":[],"mappings":";;;AAAA,oCAAyC;AACzC,gCAKe;AACf,wCAA6C;AAE7C,wCAA6C;AAC7C,0CAA+C;AAC/C,0CAA+C;AAC/C,oCAA2D;AAE3D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,QAAQ;IAWpB,YAAY,SAAqD,EAAE;QAClE,IAAI,CAAC,aAAa;YACjB,oCAA8B,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAA;QAClE,IAAI,CAAC,aAAa,GAAG,IAAA,4BAAsB,EAAC,IAAI,CAAC,aAAa,CAAC,CAAA;IAChE,CAAC;IAEM,mBAAmB;QACzB,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5B,IAAI,CAAC,gBAAgB,GAAG,IAAI,0BAAgB,CAAC;gBAC5C,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC7B,CAAC;IAEM,iBAAiB;QACvB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAC1B,IAAI,CAAC,cAAc,GAAG,IAAI,sBAAc,CAAC;gBACxC,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAA;IAC3B,CAAC;IAEM,mBAAmB;QACzB,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5B,IAAI,CAAC,gBAAgB,GAAG,IAAI,0BAAgB,CAAC;gBAC5C,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC7B,CAAC;IAEM,oBAAoB;QAC1B,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,iBAAiB,GAAG,IAAI,4BAAiB,CAAC;gBAC9C,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAA;IAC9B,CAAC;IAEM,oBAAoB;QAC1B,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,iBAAiB,GAAG,IAAI,4BAAiB,CAAC;gBAC9C,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAA;IAC9B,CAAC;IAEM,qBAAqB;QAC3B,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC9B,IAAI,CAAC,kBAAkB,GAAG,IAAI,uBAAe,CAAC;gBAC7C,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,kBAAkB,CAAA;IAC/B,CAAC;IAEM,kBAAkB;QACxB,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YAC3B,IAAI,CAAC,eAAe,GAAG,IAAI,uBAAe,CAAC;gBAC1C,MAAM,EAAE,IAAI,CAAC,aAAa;gBAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,eAAe,CAAA;IAC5B,CAAC;CACD;AAtFD,4BAsFC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/c8/index.ts"],"names":[],"mappings":";;;AAAA,oCAAyC;AACzC,gCAKe;AACf,wCAA6C;AAE7C,wCAA6C;AAC7C,0CAA+C;AAC/C,0CAA+C;AAC/C,oCAA2D;AAE3D,6CAAkD;AAClD,+DAA2D;AAE3D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,QAAQ;IAapB;;OAEG;IACH,YAAY,SAAsC,EAAE;QACnD,IAAI,CAAC,aAAa;YACjB,oCAA8B,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAA;QAClE,IAAI,CAAC,aAAa,GAAG,IAAA,4BAAsB,EAAC,IAAI,CAAC,aAAa,CAAC,CAAA;QAC/D,IAAI,CAAC,GAAG,GAAG,IAAA,oBAAS,EAAC,MAAM,CAAC,CAAA;IAC7B,CAAC;IAEM,mBAAmB,CACzB,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5B,IAAI,CAAC,gBAAgB,GAAG,IAAI,0BAAgB,CAAC;gBAC5C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC7B,CAAC;IAEM,iBAAiB,CACvB,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAC1B,IAAI,CAAC,cAAc,GAAG,IAAI,sBAAc,CAAC;gBACxC,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAA;IAC3B,CAAC;IAEM,mBAAmB,CACzB,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5B,IAAI,CAAC,gBAAgB,GAAG,IAAI,0BAAgB,CAAC;gBAC5C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC7B,CAAC;IAEM,oBAAoB,CAC1B,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,iBAAiB,GAAG,IAAI,4BAAiB,CAAC;gBAC9C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAA;IAC9B,CAAC;IAEM,oBAAoB,CAC1B,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,iBAAiB,GAAG,IAAI,4BAAiB,CAAC;gBAC9C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAA;IAC9B,CAAC;IAEM,qBAAqB,CAC3B,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC9B,IAAI,CAAC,kBAAkB,GAAG,IAAI,uBAAe,CAAC;gBAC7C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,kBAAkB,CAAA;IAC/B,CAAC;IAED;;OAEG;IACI,kBAAkB,CACxB,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YAC3B,IAAI,CAAC,eAAe,GAAG,IAAI,uBAAe,CAAC;gBAC1C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,eAAe,CAAA;IAC5B,CAAC;IAEM,oBAAoB,CAC1B,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,iBAAiB,GAAG,IAAI,qCAAiB,CAAC;gBAC9C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAA;IAC9B,CAAC;CACD;AAzHD,4BAyHC"}

package/dist/c8/lib/C8Dto.d.ts

@@ -0,0 +1,282 @@
+import { LosslessNumber } from 'lossless-json';
+import { LosslessDto } from '../../lib';
+import { ICustomHeaders, IInputVariables, JSONDoc } from '../../zeebe/types';
+export declare class RestApiJob<Variables = LosslessDto, CustomHeaders = LosslessDto> extends LosslessDto {
+    jobKey: string;
+    type: string;
+    processInstanceKey: string;
+    processDefinitionId: string;
+    processDefinitionVersion: number;
+    processDefinitionKey: string;
+    elementId: string;
+    elementInstanceKey: string;
+    customHeaders: CustomHeaders;
+    worker: string;
+    retries: number;
+    deadline: string;
+    variables: Variables;
+    tenantId: string;
+}
+/**
+ * JSON object with changed task attribute values.
+ */
+export interface TaskChangeSet {
+    dueDate?: Date | string;
+    followUpDate?: Date | string;
+    candidateUsers?: string[];
+    candidateGroups?: string[];
+}
+/** JSON object with changed job attribute values. */
+export interface JobUpdateChangeset {
+    retries?: number;
+    /**  The duration of the new timeout in ms, starting from the current moment. */
+    timeout?: number;
+}
+export interface NewUserInfo {
+    password: string;
+    id: number;
+    username: string;
+    name: string;
+    email: string;
+    enabled: boolean;
+}
+export type Ctor<T> = new (obj: any) => T;
+export declare class ProcessDeployment extends LosslessDto {
+    processDefinitionId: string;
+    processDefinitionVersion: number;
+    processDefinitionKey: string;
+    resourceName: string;
+    tenantId: string;
+}
+export declare class DecisionDeployment extends LosslessDto {
+    dmnDecisionId: string;
+    version: number;
+    decisionKey: string;
+    dmnDecisionName: string;
+    tenantId: string;
+    dmnDecisionRequirementsId: string;
+    dmnDecisionRequirementsKey: string;
+}
+export declare class DecisionRequirementsDeployment extends LosslessDto {
+    dmnDecisionRequirementsId: string;
+    version: number;
+    dmnDecisionRequirementsName: string;
+    tenantId: string;
+    dmnDecisionRequirementsKey: string;
+    resourceName: string;
+}
+export declare class FormDeployment {
+    formId: string;
+    version: number;
+    formKey: string;
+    resourceName: string;
+    tenantId: string;
+}
+export declare class DeployResourceResponseDto extends LosslessDto {
+    deploymentKey: string;
+    deployments: ({
+        processDefinition: ProcessDeployment;
+    } | {
+        decisionDefinition: DecisionDeployment;
+    } | {
+        decisionRequirements: DecisionRequirementsDeployment;
+    } | {
+        form: FormDeployment;
+    })[];
+    tenantId: string;
+}
+export declare class DeployResourceResponse extends DeployResourceResponseDto {
+    processes: ProcessDeployment[];
+    decisions: DecisionDeployment[];
+    decisionRequirements: DecisionRequirementsDeployment[];
+    forms: FormDeployment[];
+}
+export declare class CreateProcessInstanceResponse<T = Record<string, never>> {
+    /**
+     * The unique key identifying the process definition (e.g. returned from a process
+     * in the DeployResourceResponse message)
+     */
+    readonly processDefinitionKey: string;
+    /**
+     * The BPMN process ID of the process definition
+     */
+    readonly processDefinitionId: string;
+    /**
+     * The version of the process; set to -1 to use the latest version
+     */
+    readonly version: number;
+    readonly processInstanceKey: string;
+    /**
+     * the tenant identifier of the created process instance
+     */
+    readonly tenantId: string;
+    /**
+     * If `awaitCompletion` is true, this will be populated with the output variables. Otherwise, it will be an empty object.
+     */
+    readonly variables: T;
+}
+export interface MigrationMappingInstruction {
+    /** The element ID to migrate from. */
+    sourceElementId: string;
+    /** The element ID to migrate into. */
+    targetElementId: string;
+}
+/** Migrates a process instance to a new process definition.
+ * This request can contain multiple mapping instructions to define mapping between the active process instance's elements and target process definition elements.
+ */
+export interface MigrationRequest {
+    processInstanceKey: string;
+    /** The key of process definition to migrate the process instance to. */
+    targetProcessDefinitionKey: string;
+    mappingInstructions: MigrationMappingInstruction[];
+    /** A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided. */
+    operationReference?: number | LosslessNumber;
+}
+/** The signal was broadcast. */
+export declare class BroadcastSignalResponse extends LosslessDto {
+    /** The unique ID of the signal that was broadcast. */
+    signalKey: string;
+    /** The tenant ID of the signal that was broadcast. */
+    tenantId: string;
+}
+export interface UpdateElementVariableRequest {
+    /**
+     * The key of the element instance to update the variables for.
+     * This can be the process instance key (as obtained during instance creation), or a given element,
+     * such as a service task (see the elementInstanceKey on the job message). */
+    elementInstanceKey: string;
+    variables: JSONDoc | LosslessDto;
+    /**
+     * Defaults to false.
+     * If set to true, the variables are merged strictly into the local scope (as specified by the elementInstanceKey). Otherwise, the variables are propagated to upper scopes and set at the outermost one.
+     * Let’s consider the following example:
+     * There are two scopes '1' and '2'. Scope '1' is the parent scope of '2'. The effective variables of the scopes are: 1 => { "foo" : 2 } 2 => { "bar" : 1 }
+     * An update request with elementInstanceKey as '2', variables { "foo" : 5 }, and local set to true leaves scope '1' unchanged and adjusts scope '2' to { "bar" : 1, "foo" 5 }.
+     * By default, with local set to false, scope '1' will be { "foo": 5 } and scope '2' will be { "bar" : 1 }.
+     */
+    local?: boolean;
+    /**
+     * A reference key chosen by the user that will be part of all records resulting from this operation.
+     * Must be > 0 if provided.
+     */
+    operationReference?: number;
+}
+export declare class CorrelateMessageResponse extends LosslessDto {
+    /** the unique ID of the message that was published */
+    key: string;
+    /** the tenantId of the message */
+    tenantId: string;
+    /** The key of the first process instance the message correlated with */
+    processInstanceKey: string;
+}
+export declare class PublishMessageResponse extends LosslessDto {
+    /** the unique ID of the message that was published */
+    key: string;
+    /** the tenantId of the message */
+    tenantId: string;
+}
+export interface CreateProcessBaseRequest<V extends JSONDoc | LosslessDto> {
+    /**
+     * the version of the process; if not specified it will use the latest version
+     */
+    version?: number;
+    /**
+     * JSON document that will instantiate the variables for the root variable scope of the
+     * process instance.
+     */
+    variables: V;
+    /** The tenantId for a multi-tenant enabled cluster. */
+    tenantId?: string;
+    /** a reference key chosen by the user and will be part of all records resulted from this operation */
+    operationReference?: number | LosslessNumber;
+    /**
+     * List of start instructions. If empty (default) the process instance
+     * will start at the start event. If non-empty the process instance will apply start
+     * instructions after it has been created
+     */
+    startInstructions?: ProcessInstanceCreationStartInstruction[];
+    /**
+     * Wait for the process instance to complete. If the process instance completion does not occur within the requestTimeout, the request will be closed. Defaults to false.
+     */
+    /**
+     * Timeout (in ms) the request waits for the process to complete. By default or when set to 0, the generic request timeout configured in the cluster is applied.
+     */
+    requestTimeout?: number;
+}
+export interface ProcessInstanceCreationStartInstruction {
+    /**
+     * future extensions might include
+     * - different types of start instructions
+     * - ability to set local variables for different flow scopes
+     * for now, however, the start instruction is implicitly a
+     * "startBeforeElement" instruction
+     */
+    elementId: string;
+}
+export interface CreateProcessInstanceFromProcessDefinitionId<V extends JSONDoc | LosslessDto> extends CreateProcessBaseRequest<V> {
+    /**
+     * the BPMN process ID of the process definition
+     */
+    processDefinitionId: string;
+}
+export interface CreateProcessInstanceFromProcessDefinition<V extends JSONDoc | LosslessDto> extends CreateProcessBaseRequest<V> {
+    /**
+     * the key of the process definition
+     */
+    processDefinitionKey: string;
+}
+export type CreateProcessInstanceReq<T extends JSONDoc | LosslessDto> = CreateProcessInstanceFromProcessDefinitionId<T> | CreateProcessInstanceFromProcessDefinition<T>;
+export interface PatchAuthorizationRequest {
+    /** The key of the owner of the authorization. */
+    ownerKey: string;
+    /** Indicates if permissions should be added or removed. */
+    action: 'ADD' | 'REMOVE';
+    /** The type of resource to add/remove perissions to/from. */
+    resourceType: 'AUTHORIZATION' | 'MESSAGE' | 'JOB' | 'APPLICATION' | 'TENANT' | 'DEPLOYMENT' | 'PROCESS_DEFINITION' | 'USER_TASK' | 'DECISION_REQUIREMENTS_DEFINITION' | 'DECISION_DEFINITION' | 'USER_GROUP' | 'USER' | 'ROLE';
+    /** The permissions to add/remove. */
+    permissions: {
+        /** Specifies the type of permissions. */
+        permissionType: 'CREATE' | 'READ' | 'UPDATE' | 'DELETE';
+        /** A list of resource IDs the permission relates to. */
+        resourceIds: [];
+    }[];
+}
+export interface RestJob<Variables = IInputVariables, CustomHeaderShape = ICustomHeaders> {
+    /** The key, a unique identifier for the job */
+    readonly jobKey: string;
+    /**
+     * The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
+     * type="payment-service" />)
+     */
+    readonly type: string;
+    /** The job's process instance key */
+    readonly processInstanceKey: string;
+    /** The bpmn process ID of the job process definition */
+    readonly bpmnProcessId: string;
+    /** The version of the job process definition */
+    readonly processDefinitionVersion: number;
+    /** The associated task element ID */
+    readonly elementId: string;
+    /**
+     * The unique key identifying the associated task, unique within the scope of the
+     * process instance
+     */
+    readonly elementInstanceKey: string;
+    /**
+     * A set of custom headers defined during modelling
+     */
+    readonly customHeaders: Readonly<CustomHeaderShape>;
+    /** The name of the worker that activated this job */
+    readonly worker: string;
+    readonly retries: number;
+    /** Epoch milliseconds */
+    readonly deadline: string;
+    /**
+     * All visible variables in the task scope, computed at activation time.
+     */
+    readonly variables: Readonly<Variables>;
+    /**
+     * The `tenantId` of the job in a multi-tenant cluster
+     */
+    readonly tenantId: string;
+}