@camunda8/sdk 8.7.6 → 8.7.7

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.
Files changed (77) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +31 -31
  3. package/dist/admin/lib/AdminApiClient.d.ts +16 -16
  4. package/dist/admin/lib/AdminApiClient.js +16 -16
  5. package/dist/c8/index.d.ts +13 -2
  6. package/dist/c8/index.js +8 -2
  7. package/dist/c8/index.js.map +1 -1
  8. package/dist/c8/lib/C8Logger.d.ts +5 -0
  9. package/dist/c8/lib/C8Logger.js.map +1 -1
  10. package/dist/c8/lib/CamundaJobWorker.d.ts +14 -1
  11. package/dist/c8/lib/CamundaJobWorker.js.map +1 -1
  12. package/dist/c8/lib/CamundaRestClient.d.ts +67 -3
  13. package/dist/c8/lib/CamundaRestClient.js +1 -1
  14. package/dist/c8/lib/RestApiJobClassFactory.js +6 -0
  15. package/dist/c8/lib/RestApiJobClassFactory.js.map +1 -1
  16. package/dist/index.d.ts +12 -1
  17. package/dist/index.js +14 -2
  18. package/dist/index.js.map +1 -1
  19. package/dist/lib/Configuration.d.ts +93 -81
  20. package/dist/lib/Configuration.js +112 -69
  21. package/dist/lib/Configuration.js.map +1 -1
  22. package/dist/lib/ConstructOAuthProvider.d.ts +1 -1
  23. package/dist/lib/CreateDtoInstance.d.ts +2 -2
  24. package/dist/lib/CreateDtoInstance.js +2 -2
  25. package/dist/lib/EnvironmentSetup.d.ts +3 -2
  26. package/dist/lib/EnvironmentSetup.js +18 -15
  27. package/dist/lib/EnvironmentSetup.js.map +1 -1
  28. package/dist/lib/LosslessJsonParser.d.ts +12 -2
  29. package/dist/lib/LosslessJsonParser.js +12 -2
  30. package/dist/lib/LosslessJsonParser.js.map +1 -1
  31. package/dist/lib/RequireConfiguration.d.ts +2 -2
  32. package/dist/lib/RequireConfiguration.js +1 -1
  33. package/dist/lib/RequireConfiguration.js.map +1 -1
  34. package/dist/lib/index.d.ts +0 -1
  35. package/dist/lib/index.js +0 -1
  36. package/dist/lib/index.js.map +1 -1
  37. package/dist/modeler/lib/ModelerAPIClient.d.ts +7 -1
  38. package/dist/modeler/lib/ModelerAPIClient.js +7 -1
  39. package/dist/modeler/lib/ModelerAPIClient.js.map +1 -1
  40. package/dist/oauth/index.d.ts +6 -0
  41. package/dist/oauth/index.js +3 -1
  42. package/dist/oauth/index.js.map +1 -1
  43. package/dist/oauth/lib/BasicAuthProvider.d.ts +5 -0
  44. package/dist/oauth/lib/BasicAuthProvider.js +5 -0
  45. package/dist/oauth/lib/BasicAuthProvider.js.map +1 -1
  46. package/dist/oauth/lib/BearerAuthProvider.d.ts +23 -1
  47. package/dist/oauth/lib/BearerAuthProvider.js +23 -1
  48. package/dist/oauth/lib/BearerAuthProvider.js.map +1 -1
  49. package/dist/oauth/lib/CookieAuthProvider.d.ts +17 -0
  50. package/dist/oauth/lib/CookieAuthProvider.js +22 -1
  51. package/dist/oauth/lib/CookieAuthProvider.js.map +1 -1
  52. package/dist/oauth/lib/IOAuthProvider.d.ts +55 -1
  53. package/dist/oauth/lib/NullAuthProvider.d.ts +6 -0
  54. package/dist/oauth/lib/NullAuthProvider.js +6 -0
  55. package/dist/oauth/lib/NullAuthProvider.js.map +1 -1
  56. package/dist/oauth/lib/OAuthProvider.d.ts +22 -0
  57. package/dist/oauth/lib/OAuthProvider.js +22 -0
  58. package/dist/oauth/lib/OAuthProvider.js.map +1 -1
  59. package/dist/operate/lib/OperateApiClient.d.ts +16 -13
  60. package/dist/operate/lib/OperateApiClient.js +16 -13
  61. package/dist/operate/lib/OperateApiClient.js.map +1 -1
  62. package/dist/optimize/lib/APIObjects.d.ts +9 -9
  63. package/dist/optimize/lib/OptimizeApiClient.d.ts +16 -14
  64. package/dist/optimize/lib/OptimizeApiClient.js +16 -14
  65. package/dist/optimize/lib/OptimizeApiClient.js.map +1 -1
  66. package/dist/tasklist/lib/TasklistApiClient.d.ts +13 -10
  67. package/dist/tasklist/lib/TasklistApiClient.js +13 -10
  68. package/dist/tasklist/lib/TasklistApiClient.js.map +1 -1
  69. package/dist/zeebe/zb/ZeebeGrpcClient.d.ts +33 -23
  70. package/dist/zeebe/zb/ZeebeGrpcClient.js +54 -23
  71. package/dist/zeebe/zb/ZeebeGrpcClient.js.map +1 -1
  72. package/dist/zeebe/zb/ZeebeRESTClient.d.ts +1 -1
  73. package/dist/zeebe/zb/ZeebeRESTClient.js +1 -1
  74. package/package.json +6 -5
  75. package/dist/lib/SuppressZeebeLogging.d.ts +0 -2
  76. package/dist/lib/SuppressZeebeLogging.js +0 -14
  77. package/dist/lib/SuppressZeebeLogging.js.map +0 -1
@@ -3,7 +3,7 @@
3
3
  import { ReadStream } from 'node:fs';
4
4
  import { Response } from 'got';
5
5
  import PCancelable from 'p-cancelable';
6
- import { Camunda8ClientConfiguration, CamundaPlatform8Configuration, LosslessDto } from '../../lib';
6
+ import { Camunda8ClientConfiguration, LosslessDto } from '../../lib';
7
7
  import { IOAuthProvider } from '../../oauth';
8
8
  import { ActivateJobsRequest, BroadcastSignalReq, CompleteJobRequest, ErrorJobWithVariables, FailJobRequest, JSONDoc, PublishMessageRequest, TopologyResponse } from '../../zeebe/types';
9
9
  import { AssignUserTaskRequest, BroadcastSignalResponse, CorrelateMessageResponse, CreateDocumentLinkRequest, CreateProcessInstanceReq, CreateProcessInstanceResponse, Ctor, DeployResourceResponse, DownloadDocumentRequest, EvaluateDecisionRequest, EvaluateDecisionResponse, JobUpdateChangeset, JobWithMethods, JsonApiEndpointRequest, MigrationRequest, ModifyProcessInstanceRequest, NewUserInfo, PatchAuthorizationRequest, PublishMessageResponse, RawApiEndpointRequest, SearchProcessInstanceRequest, SearchProcessInstanceResponse, SearchTasksRequest, SearchUserTasksResponse, SearchVariablesRequest, SearchVariablesResponse, TaskChangeSet, UpdateElementVariableRequest, UploadDocumentRequest, UploadDocumentResponse, UploadDocumentsResponse, UserTask, UserTaskVariablesRequest, UserTaskVariablesResponse } from './C8Dto';
@@ -14,7 +14,7 @@ import { CamundaJobWorker, CamundaJobWorkerConfig } from './CamundaJobWorker';
14
14
  *
15
15
  * Logging: to enable debug tracing during development, you can set `DEBUG=camunda:zeebe-rest`.
16
16
  *
17
- * For production, you can pass in an instance of [winston.Logger](https://github.com/winstonjs/winston) to the constructor as `logger`.
17
+ * For production, you can pass in an logger compatible with {@link Logger} to the constructor as `logger`.
18
18
  *
19
19
  * `CAMUNDA_LOG_LEVEL` in the environment or the constructor options can be used to set the log level to one of 'error', 'warn', 'info', 'http', 'verbose', 'debug', or 'silly'.
20
20
  *
@@ -371,7 +371,71 @@ export declare class CamundaRestClient {
371
371
  * @since 8.6.0
372
372
  */
373
373
  updateElementInstanceVariables(req: UpdateElementVariableRequest): Promise<Response<string>>;
374
- getConfig(): CamundaPlatform8Configuration;
374
+ getConfig(): {
375
+ zeebeGrpcSettings: {
376
+ ZEEBE_INSECURE_CONNECTION: boolean;
377
+ ZEEBE_CLIENT_LOG_LEVEL: string;
378
+ ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
379
+ ZEEBE_GRPC_CLIENT_RETRY: boolean;
380
+ ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
381
+ ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
382
+ ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: number | undefined;
383
+ ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
384
+ GRPC_KEEPALIVE_TIME_MS: number;
385
+ GRPC_KEEPALIVE_TIMEOUT_MS: number;
386
+ GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
387
+ GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
388
+ GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
389
+ GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
390
+ GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
391
+ GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
392
+ GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
393
+ ZEEBE_CLIENT_LOG_TYPE: string;
394
+ ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
395
+ ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
396
+ };
397
+ CAMUNDA_JOB_WORKER_MAX_BACKOFF_MS: number;
398
+ CAMUNDA_CUSTOM_USER_AGENT_STRING: string | undefined;
399
+ CAMUNDA_OAUTH_DISABLED: boolean;
400
+ CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
401
+ CAMUNDA_LOG_LEVEL: string;
402
+ ZEEBE_GRPC_ADDRESS: string;
403
+ ZEEBE_REST_ADDRESS: string;
404
+ ZEEBE_ADDRESS: string | undefined;
405
+ ZEEBE_CLIENT_ID: string | undefined;
406
+ ZEEBE_CLIENT_SECRET: string | undefined;
407
+ CAMUNDA_OAUTH_URL: string | undefined;
408
+ CAMUNDA_OAUTH_TOKEN: string | undefined;
409
+ CAMUNDA_TOKEN_SCOPE: string | undefined;
410
+ CAMUNDA_TENANT_ID: string | undefined;
411
+ CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string | undefined;
412
+ ZEEBE_TOKEN_AUDIENCE: string;
413
+ CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
414
+ CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
415
+ CAMUNDA_MODELER_OAUTH_AUDIENCE: string | undefined;
416
+ CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
417
+ CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
418
+ CAMUNDA_TOKEN_CACHE_DIR: string | undefined;
419
+ CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
420
+ CAMUNDA_SECURE_CONNECTION: boolean;
421
+ CAMUNDA_COOKIE_AUTH_URL: string;
422
+ CAMUNDA_COOKIE_AUTH_USERNAME: string;
423
+ CAMUNDA_COOKIE_AUTH_PASSWORD: string;
424
+ CAMUNDA_CUSTOM_ROOT_CERT_PATH: string | undefined;
425
+ CAMUNDA_CUSTOM_ROOT_CERT_STRING: string | undefined;
426
+ CAMUNDA_CUSTOM_CERT_CHAIN_PATH: string | undefined;
427
+ CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: string | undefined;
428
+ CAMUNDA_OPERATE_BASE_URL: string | undefined;
429
+ CAMUNDA_OPTIMIZE_BASE_URL: string | undefined;
430
+ CAMUNDA_TASKLIST_BASE_URL: string | undefined;
431
+ CAMUNDA_MODELER_BASE_URL: string;
432
+ CAMUNDA_CONSOLE_BASE_URL: string | undefined;
433
+ CAMUNDA_CONSOLE_CLIENT_ID: string | undefined;
434
+ CAMUNDA_CONSOLE_CLIENT_SECRET: string | undefined;
435
+ CAMUNDA_BASIC_AUTH_USERNAME: string | undefined;
436
+ CAMUNDA_BASIC_AUTH_PASSWORD: string | undefined;
437
+ CAMUNDA_AUTH_STRATEGY: string;
438
+ };
375
439
  /**
376
440
  * Search for process and local variables based on given criteria.
377
441
  *
@@ -26,7 +26,7 @@ class DefaultLosslessDto extends lib_1.LosslessDto {
26
26
  *
27
27
  * Logging: to enable debug tracing during development, you can set `DEBUG=camunda:zeebe-rest`.
28
28
  *
29
- * For production, you can pass in an instance of [winston.Logger](https://github.com/winstonjs/winston) to the constructor as `logger`.
29
+ * For production, you can pass in an logger compatible with {@link Logger} to the constructor as `logger`.
30
30
  *
31
31
  * `CAMUNDA_LOG_LEVEL` in the environment or the constructor options can be used to set the log level to one of 'error', 'warn', 'info', 'http', 'verbose', 'debug', or 'silly'.
32
32
  *
@@ -2,6 +2,12 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.createSpecializedRestApiJobClass = void 0;
4
4
  const C8Dto_1 = require("./C8Dto");
5
+ /**
6
+ * REST Job class factory that creates specialized RestApiJob classes based on input variables and custom headers.
7
+ * This factory caches the created classes to avoid creating the same class multiple times.
8
+ * It uses a memoization technique to store the classes in a Map, where the key is a stringified version of the input variables and custom headers.
9
+ * A Specialized REST Job class is the generic Job Dto specialised with the LosslessDto for the variables and custom headers payload.
10
+ */
5
11
  const factory = createMemoizedSpecializedRestApiJobClassFactory();
6
12
  // Creates a specialized RestApiJob class that is cached based on input variables and custom headers.
7
13
  const createSpecializedRestApiJobClass = (inputVariableDto, customHeaders) => {
@@ -1 +1 @@
1
- {"version":3,"file":"RestApiJobClassFactory.js","sourceRoot":"","sources":["../../../src/c8/lib/RestApiJobClassFactory.ts"],"names":[],"mappings":";;;AAGA,mCAAoC;AAEpC,MAAM,OAAO,GAAG,+CAA+C,EAAE,CAAA;AAEjE,qGAAqG;AAC9F,MAAM,gCAAgC,GAAG,CAI/C,gBAA6C,EAC7C,aAA8C,EAC7C,EAAE;IACH,0EAA0E;IAC1E,OAAO,OAAO,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAA;AAChD,CAAC,CAAA;AATY,QAAA,gCAAgC,oCAS5C;AAED,SAAS,+CAA+C;IACvD,MAAM,KAAK,GAAG,IAAI,GAAG,EAAe,CAAA;IAEpC,OAAO,UAIN,gBAA6C,EAC7C,gBAAiD;QAEjD,0DAA0D;QAC1D,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;YAC/B,gBAAgB;YAChB,gBAAgB;SAChB,CAAC,CAAA;QAEF,0BAA0B;QAC1B,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC3B,CAAC;QAED,qDAAqD;QACrD,MAAM,kBAGJ,SAAQ,kBAAoC;SAAG;QAEjD,kEAAkE;QAClE,OAAO,CAAC,cAAc,CACrB,aAAa,EACb,gBAAgB,EAChB,kBAAkB,CAAC,SAAS,EAC5B,WAAW,CACX,CAAA;QACD,OAAO,CAAC,cAAc,CACrB,aAAa,EACb,gBAAgB,EAChB,kBAAkB,CAAC,SAAS,EAC5B,eAAe,CACf,CAAA;QAED,+BAA+B;QAC/B,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAA;QAEvC,uBAAuB;QACvB,OAAO,kBAAkB,CAAA;IAC1B,CAAC,CAAA;AACF,CAAC"}
1
+ {"version":3,"file":"RestApiJobClassFactory.js","sourceRoot":"","sources":["../../../src/c8/lib/RestApiJobClassFactory.ts"],"names":[],"mappings":";;;AAGA,mCAAoC;AAEpC;;;;;GAKG;AAEH,MAAM,OAAO,GAAG,+CAA+C,EAAE,CAAA;AAEjE,qGAAqG;AAC9F,MAAM,gCAAgC,GAAG,CAI/C,gBAA6C,EAC7C,aAA8C,EAC7C,EAAE;IACH,0EAA0E;IAC1E,OAAO,OAAO,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAA;AAChD,CAAC,CAAA;AATY,QAAA,gCAAgC,oCAS5C;AAED,SAAS,+CAA+C;IACvD,MAAM,KAAK,GAAG,IAAI,GAAG,EAAe,CAAA;IAEpC,OAAO,UAIN,gBAA6C,EAC7C,gBAAiD;QAEjD,0DAA0D;QAC1D,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;YAC/B,gBAAgB;YAChB,gBAAgB;SAChB,CAAC,CAAA;QAEF,0BAA0B;QAC1B,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC3B,CAAC;QAED,qDAAqD;QACrD,MAAM,kBAGJ,SAAQ,kBAAoC;SAAG;QAEjD,kEAAkE;QAClE,OAAO,CAAC,cAAc,CACrB,aAAa,EACb,gBAAgB,EAChB,kBAAkB,CAAC,SAAS,EAC5B,WAAW,CACX,CAAA;QACD,OAAO,CAAC,cAAc,CACrB,aAAa,EACb,gBAAgB,EAChB,kBAAkB,CAAC,SAAS,EAC5B,eAAe,CACf,CAAA;QAED,+BAA+B;QAC/B,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAA;QAEvC,uBAAuB;QACvB,OAAO,kBAAkB,CAAA;IAC1B,CAAC,CAAA;AACF,CAAC"}
package/dist/index.d.ts CHANGED
@@ -1,18 +1,29 @@
1
1
  import * as Admin from './admin';
2
2
  import { Camunda8 } from './c8';
3
3
  import { CamundaRestClient } from './c8/lib/CamundaRestClient';
4
- import { BigIntValue, ChildDto, Int64String, LosslessDto, createDtoInstance } from './lib';
4
+ import { BigIntValue, BigIntValueArray, ChildDto, Int64String, Int64StringArray, LosslessDto, createDtoInstance } from './lib';
5
5
  import * as Modeler from './modeler';
6
6
  import * as Auth from './oauth';
7
7
  import * as Operate from './operate';
8
8
  import * as Optimize from './optimize';
9
9
  import * as Tasklist from './tasklist';
10
10
  import * as Zeebe from './zeebe';
11
+ export { CamundaSDKConfiguration } from './lib';
11
12
  export { HTTPError } from './lib';
13
+ /**
14
+ * These are decorators and infrastructure that are used to create Dtos for the Camunda 8 SDK.
15
+ * A `LosslessDto` is used to represent data that is sent and received by the SDK - including job variables and headers.
16
+ * They enable the lossless transformation of `int64` number values between the SDK and the Camunda 8 API —
17
+ * representing the `int64` numbers as either `string` or `bigint` type in the SDK.
18
+ *
19
+ * See the {@link LosslessDto} for more information.
20
+ */
12
21
  export declare const Dto: {
13
22
  ChildDto: typeof ChildDto;
14
23
  BigIntValue: typeof BigIntValue;
24
+ BigIntValueArray: typeof BigIntValueArray;
15
25
  Int64String: typeof Int64String;
26
+ Int64StringArray: typeof Int64StringArray;
16
27
  LosslessDto: typeof LosslessDto;
17
28
  createDtoInstance: typeof createDtoInstance;
18
29
  };
package/dist/index.js CHANGED
@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
23
23
  return result;
24
24
  };
25
25
  Object.defineProperty(exports, "__esModule", { value: true });
26
- exports.Zeebe = exports.Tasklist = exports.Optimize = exports.Operate = exports.Modeler = exports.CamundaRestClient = exports.Camunda8 = exports.Auth = exports.Admin = exports.Dto = exports.HTTPError = void 0;
26
+ exports.Zeebe = exports.Tasklist = exports.Optimize = exports.Operate = exports.Modeler = exports.CamundaRestClient = exports.Camunda8 = exports.Auth = exports.Admin = exports.Dto = exports.HTTPError = exports.CamundaSDKConfiguration = void 0;
27
27
  const Admin = __importStar(require("./admin"));
28
28
  exports.Admin = Admin;
29
29
  const c8_1 = require("./c8");
@@ -44,11 +44,23 @@ exports.Tasklist = Tasklist;
44
44
  const Zeebe = __importStar(require("./zeebe"));
45
45
  exports.Zeebe = Zeebe;
46
46
  var lib_2 = require("./lib");
47
- Object.defineProperty(exports, "HTTPError", { enumerable: true, get: function () { return lib_2.HTTPError; } });
47
+ Object.defineProperty(exports, "CamundaSDKConfiguration", { enumerable: true, get: function () { return lib_2.CamundaSDKConfiguration; } });
48
+ var lib_3 = require("./lib");
49
+ Object.defineProperty(exports, "HTTPError", { enumerable: true, get: function () { return lib_3.HTTPError; } });
50
+ /**
51
+ * These are decorators and infrastructure that are used to create Dtos for the Camunda 8 SDK.
52
+ * A `LosslessDto` is used to represent data that is sent and received by the SDK - including job variables and headers.
53
+ * They enable the lossless transformation of `int64` number values between the SDK and the Camunda 8 API —
54
+ * representing the `int64` numbers as either `string` or `bigint` type in the SDK.
55
+ *
56
+ * See the {@link LosslessDto} for more information.
57
+ */
48
58
  exports.Dto = {
49
59
  ChildDto: lib_1.ChildDto,
50
60
  BigIntValue: lib_1.BigIntValue,
61
+ BigIntValueArray: lib_1.BigIntValueArray,
51
62
  Int64String: lib_1.Int64String,
63
+ Int64StringArray: lib_1.Int64StringArray,
52
64
  LosslessDto: lib_1.LosslessDto,
53
65
  createDtoInstance: lib_1.createDtoInstance,
54
66
  };
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAgC;AA4B/B,sBAAK;AA3BN,6BAA+B;AA6B9B,yFA7BQ,aAAQ,OA6BR;AA5BT,kEAA8D;AA6B7D,kGA7BQ,qCAAiB,OA6BR;AA5BlB,+BAMc;AACd,mDAAoC;AAsBnC,0BAAO;AArBR,8CAA+B;AAkB9B,oBAAI;AAjBL,mDAAoC;AAqBnC,0BAAO;AApBR,qDAAsC;AAqBrC,4BAAQ;AApBT,qDAAsC;AAqBrC,4BAAQ;AApBT,+CAAgC;AAqB/B,sBAAK;AAnBN,6BAAiC;AAAxB,gGAAA,SAAS,OAAA;AAEL,QAAA,GAAG,GAAG;IAClB,QAAQ,EAAR,cAAQ;IACR,WAAW,EAAX,iBAAW;IACX,WAAW,EAAX,iBAAW;IACX,WAAW,EAAX,iBAAW;IACX,iBAAiB,EAAjB,uBAAiB;CACjB,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAgC;AA0C/B,sBAAK;AAzCN,6BAA+B;AA2C9B,yFA3CQ,aAAQ,OA2CR;AA1CT,kEAA8D;AA2C7D,kGA3CQ,qCAAiB,OA2CR;AA1ClB,+BAQc;AACd,mDAAoC;AAkCnC,0BAAO;AAjCR,8CAA+B;AA8B9B,oBAAI;AA7BL,mDAAoC;AAiCnC,0BAAO;AAhCR,qDAAsC;AAiCrC,4BAAQ;AAhCT,qDAAsC;AAiCrC,4BAAQ;AAhCT,+CAAgC;AAiC/B,sBAAK;AA/BN,6BAA+C;AAAtC,8GAAA,uBAAuB,OAAA;AAEhC,6BAAiC;AAAxB,gGAAA,SAAS,OAAA;AAElB;;;;;;;GAOG;AACU,QAAA,GAAG,GAAG;IAClB,QAAQ,EAAR,cAAQ;IACR,WAAW,EAAX,iBAAW;IACX,gBAAgB,EAAhB,sBAAgB;IAChB,WAAW,EAAX,iBAAW;IACX,gBAAgB,EAAhB,sBAAgB;IAChB,WAAW,EAAX,iBAAW;IACX,iBAAiB,EAAjB,uBAAiB;CACjB,CAAA"}
@@ -1,6 +1,36 @@
1
1
  import { BeforeRequestHook } from 'got';
2
2
  import { Logger } from '../c8/lib/C8Logger';
3
- declare const getMainEnv: () => {
3
+ /**
4
+ * These are the configuration parameters for the Camunda 8 SDK.
5
+ * You can pass these into a constructor to create a new client, and any explicit values you pass in will override the environment variables.
6
+ * Otherwise, any of these values can be set in the environment variables and will be used by the SDK.
7
+ *
8
+ * Note that although some values are passed to the constructor in the subkey `zeebeGrpcSettings`, they need no special treatment as environment variables.
9
+ * Simply use the same name as the key in the `zeebeGrpcSettings` object for the environment variable, and the SDK will pick it up.
10
+ */
11
+ export declare const CamundaSDKConfiguration: {
12
+ zeebeGrpcSettings: {
13
+ ZEEBE_INSECURE_CONNECTION: boolean;
14
+ ZEEBE_CLIENT_LOG_LEVEL: string;
15
+ ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
16
+ ZEEBE_GRPC_CLIENT_RETRY: boolean;
17
+ ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
18
+ ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
19
+ ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: number | undefined;
20
+ ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
21
+ GRPC_KEEPALIVE_TIME_MS: number;
22
+ GRPC_KEEPALIVE_TIMEOUT_MS: number;
23
+ GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
24
+ GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
25
+ GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
26
+ GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
27
+ GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
28
+ GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
29
+ GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
30
+ ZEEBE_CLIENT_LOG_TYPE: string;
31
+ ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
32
+ ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
33
+ };
4
34
  CAMUNDA_JOB_WORKER_MAX_BACKOFF_MS: number;
5
35
  CAMUNDA_CUSTOM_USER_AGENT_STRING: string | undefined;
6
36
  CAMUNDA_OAUTH_DISABLED: boolean;
@@ -43,7 +73,27 @@ declare const getMainEnv: () => {
43
73
  CAMUNDA_BASIC_AUTH_PASSWORD: string | undefined;
44
74
  CAMUNDA_AUTH_STRATEGY: string;
45
75
  };
46
- declare const getZeebeEnv: () => {
76
+ export type CamundaPlatform8Configuration = typeof CamundaSDKConfiguration;
77
+ type ConfigWithMiddleware = CamundaPlatform8Configuration & {
78
+ middleware?: BeforeRequestHook[];
79
+ };
80
+ export declare class CamundaEnvironmentConfigurator {
81
+ static mergeConfigWithEnvironment: (config: DeepPartial<ConfigWithMiddleware>) => ConfigWithMiddleware;
82
+ }
83
+ export type DeepPartial<T> = {
84
+ [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
85
+ };
86
+ export type Camunda8ClientConfiguration = DeepPartial<CamundaPlatform8Configuration> & {
87
+ /** An optional logger. If no logger is supplied, [winston](https://github.com/winstonjs/winston) will be used. */
88
+ logger?: Logger;
89
+ };
90
+ /**
91
+ * This section creates a type-safe runtime dictionary of environment variables. This is used for Require Configuration.
92
+ */
93
+ /**
94
+ * All the environment variables.
95
+ */
96
+ export declare const CamundaEnvironmentVariables: {
47
97
  ZEEBE_INSECURE_CONNECTION: boolean;
48
98
  ZEEBE_CLIENT_LOG_LEVEL: string;
49
99
  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
@@ -64,85 +114,47 @@ declare const getZeebeEnv: () => {
64
114
  ZEEBE_CLIENT_LOG_TYPE: string;
65
115
  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
66
116
  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
117
+ CAMUNDA_JOB_WORKER_MAX_BACKOFF_MS: number;
118
+ CAMUNDA_CUSTOM_USER_AGENT_STRING: string | undefined;
119
+ CAMUNDA_OAUTH_DISABLED: boolean;
120
+ CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
121
+ CAMUNDA_LOG_LEVEL: string;
122
+ ZEEBE_GRPC_ADDRESS: string;
123
+ ZEEBE_REST_ADDRESS: string;
124
+ ZEEBE_ADDRESS: string | undefined;
125
+ ZEEBE_CLIENT_ID: string | undefined;
126
+ ZEEBE_CLIENT_SECRET: string | undefined;
127
+ CAMUNDA_OAUTH_URL: string | undefined;
128
+ CAMUNDA_OAUTH_TOKEN: string | undefined;
129
+ CAMUNDA_TOKEN_SCOPE: string | undefined;
130
+ CAMUNDA_TENANT_ID: string | undefined;
131
+ CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string | undefined;
132
+ ZEEBE_TOKEN_AUDIENCE: string;
133
+ CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
134
+ CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
135
+ CAMUNDA_MODELER_OAUTH_AUDIENCE: string | undefined;
136
+ CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
137
+ CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
138
+ CAMUNDA_TOKEN_CACHE_DIR: string | undefined;
139
+ CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
140
+ CAMUNDA_SECURE_CONNECTION: boolean;
141
+ CAMUNDA_COOKIE_AUTH_URL: string;
142
+ CAMUNDA_COOKIE_AUTH_USERNAME: string;
143
+ CAMUNDA_COOKIE_AUTH_PASSWORD: string;
144
+ CAMUNDA_CUSTOM_ROOT_CERT_PATH: string | undefined;
145
+ CAMUNDA_CUSTOM_ROOT_CERT_STRING: string | undefined;
146
+ CAMUNDA_CUSTOM_CERT_CHAIN_PATH: string | undefined;
147
+ CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: string | undefined;
148
+ CAMUNDA_OPERATE_BASE_URL: string | undefined;
149
+ CAMUNDA_OPTIMIZE_BASE_URL: string | undefined;
150
+ CAMUNDA_TASKLIST_BASE_URL: string | undefined;
151
+ CAMUNDA_MODELER_BASE_URL: string;
152
+ CAMUNDA_CONSOLE_BASE_URL: string | undefined;
153
+ CAMUNDA_CONSOLE_CLIENT_ID: string | undefined;
154
+ CAMUNDA_CONSOLE_CLIENT_SECRET: string | undefined;
155
+ CAMUNDA_BASIC_AUTH_USERNAME: string | undefined;
156
+ CAMUNDA_BASIC_AUTH_PASSWORD: string | undefined;
157
+ CAMUNDA_AUTH_STRATEGY: string;
67
158
  };
68
- type CamundaEnvironmentVariables = ReturnType<typeof getMainEnv> & ReturnType<typeof getZeebeEnv>;
69
- export type CamundaEnvironmentVariable = keyof CamundaEnvironmentVariables;
70
159
  export declare const CamundaEnvironmentVariableDictionary: ("CAMUNDA_JOB_WORKER_MAX_BACKOFF_MS" | "CAMUNDA_CUSTOM_USER_AGENT_STRING" | "CAMUNDA_OAUTH_DISABLED" | "CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS" | "CAMUNDA_LOG_LEVEL" | "ZEEBE_GRPC_ADDRESS" | "ZEEBE_REST_ADDRESS" | "ZEEBE_ADDRESS" | "ZEEBE_CLIENT_ID" | "ZEEBE_CLIENT_SECRET" | "CAMUNDA_OAUTH_URL" | "CAMUNDA_OAUTH_TOKEN" | "CAMUNDA_TOKEN_SCOPE" | "CAMUNDA_TENANT_ID" | "CAMUNDA_ZEEBE_OAUTH_AUDIENCE" | "ZEEBE_TOKEN_AUDIENCE" | "CAMUNDA_OPERATE_OAUTH_AUDIENCE" | "CAMUNDA_TASKLIST_OAUTH_AUDIENCE" | "CAMUNDA_MODELER_OAUTH_AUDIENCE" | "CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE" | "CAMUNDA_CONSOLE_OAUTH_AUDIENCE" | "CAMUNDA_TOKEN_CACHE_DIR" | "CAMUNDA_TOKEN_DISK_CACHE_DISABLE" | "CAMUNDA_SECURE_CONNECTION" | "CAMUNDA_COOKIE_AUTH_URL" | "CAMUNDA_COOKIE_AUTH_USERNAME" | "CAMUNDA_COOKIE_AUTH_PASSWORD" | "CAMUNDA_CUSTOM_ROOT_CERT_PATH" | "CAMUNDA_CUSTOM_ROOT_CERT_STRING" | "CAMUNDA_CUSTOM_CERT_CHAIN_PATH" | "CAMUNDA_CUSTOM_PRIVATE_KEY_PATH" | "CAMUNDA_OPERATE_BASE_URL" | "CAMUNDA_OPTIMIZE_BASE_URL" | "CAMUNDA_TASKLIST_BASE_URL" | "CAMUNDA_MODELER_BASE_URL" | "CAMUNDA_CONSOLE_BASE_URL" | "CAMUNDA_CONSOLE_CLIENT_ID" | "CAMUNDA_CONSOLE_CLIENT_SECRET" | "CAMUNDA_BASIC_AUTH_USERNAME" | "CAMUNDA_BASIC_AUTH_PASSWORD" | "CAMUNDA_AUTH_STRATEGY" | "ZEEBE_INSECURE_CONNECTION" | "ZEEBE_CLIENT_LOG_LEVEL" | "ZEEBE_GRPC_CLIENT_EAGER_CONNECT" | "ZEEBE_GRPC_CLIENT_RETRY" | "ZEEBE_GRPC_CLIENT_MAX_RETRIES" | "ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS" | "ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS" | "ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS" | "GRPC_KEEPALIVE_TIME_MS" | "GRPC_KEEPALIVE_TIMEOUT_MS" | "GRPC_INITIAL_RECONNECT_BACKOFF_MS" | "GRPC_MAX_RECONNECT_BACKOFF_MS" | "GRPC_MIN_RECONNECT_BACKOFF_MS" | "GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS" | "GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS" | "GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS" | "GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA" | "ZEEBE_CLIENT_LOG_TYPE" | "ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS" | "ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS")[];
71
- export declare class CamundaEnvironmentConfigurator {
72
- static ENV: () => {
73
- zeebeGrpcSettings: {
74
- ZEEBE_INSECURE_CONNECTION: boolean;
75
- ZEEBE_CLIENT_LOG_LEVEL: string;
76
- ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
77
- ZEEBE_GRPC_CLIENT_RETRY: boolean;
78
- ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
79
- ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
80
- ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: number | undefined;
81
- ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
82
- GRPC_KEEPALIVE_TIME_MS: number;
83
- GRPC_KEEPALIVE_TIMEOUT_MS: number;
84
- GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
85
- GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
86
- GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
87
- GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
88
- GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
89
- GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
90
- GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
91
- ZEEBE_CLIENT_LOG_TYPE: string;
92
- ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
93
- ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
94
- };
95
- CAMUNDA_JOB_WORKER_MAX_BACKOFF_MS: number;
96
- CAMUNDA_CUSTOM_USER_AGENT_STRING: string | undefined;
97
- CAMUNDA_OAUTH_DISABLED: boolean;
98
- CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
99
- CAMUNDA_LOG_LEVEL: string;
100
- ZEEBE_GRPC_ADDRESS: string;
101
- ZEEBE_REST_ADDRESS: string;
102
- ZEEBE_ADDRESS: string | undefined;
103
- ZEEBE_CLIENT_ID: string | undefined;
104
- ZEEBE_CLIENT_SECRET: string | undefined;
105
- CAMUNDA_OAUTH_URL: string | undefined;
106
- CAMUNDA_OAUTH_TOKEN: string | undefined;
107
- CAMUNDA_TOKEN_SCOPE: string | undefined;
108
- CAMUNDA_TENANT_ID: string | undefined;
109
- CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string | undefined;
110
- ZEEBE_TOKEN_AUDIENCE: string;
111
- CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
112
- CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
113
- CAMUNDA_MODELER_OAUTH_AUDIENCE: string | undefined;
114
- CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
115
- CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
116
- CAMUNDA_TOKEN_CACHE_DIR: string | undefined;
117
- CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
118
- CAMUNDA_SECURE_CONNECTION: boolean;
119
- CAMUNDA_COOKIE_AUTH_URL: string;
120
- CAMUNDA_COOKIE_AUTH_USERNAME: string;
121
- CAMUNDA_COOKIE_AUTH_PASSWORD: string;
122
- CAMUNDA_CUSTOM_ROOT_CERT_PATH: string | undefined;
123
- CAMUNDA_CUSTOM_ROOT_CERT_STRING: string | undefined;
124
- CAMUNDA_CUSTOM_CERT_CHAIN_PATH: string | undefined;
125
- CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: string | undefined;
126
- CAMUNDA_OPERATE_BASE_URL: string | undefined;
127
- CAMUNDA_OPTIMIZE_BASE_URL: string | undefined;
128
- CAMUNDA_TASKLIST_BASE_URL: string | undefined;
129
- CAMUNDA_MODELER_BASE_URL: string;
130
- CAMUNDA_CONSOLE_BASE_URL: string | undefined;
131
- CAMUNDA_CONSOLE_CLIENT_ID: string | undefined;
132
- CAMUNDA_CONSOLE_CLIENT_SECRET: string | undefined;
133
- CAMUNDA_BASIC_AUTH_USERNAME: string | undefined;
134
- CAMUNDA_BASIC_AUTH_PASSWORD: string | undefined;
135
- CAMUNDA_AUTH_STRATEGY: string;
136
- };
137
- static mergeConfigWithEnvironment: (config: DeepPartial<CamundaPlatform8Configuration>) => CamundaPlatform8Configuration;
138
- }
139
- export type CamundaPlatform8Configuration = ReturnType<typeof CamundaEnvironmentConfigurator.ENV> & {
140
- middleware?: BeforeRequestHook[];
141
- };
142
- export type DeepPartial<T> = {
143
- [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
144
- };
145
- export type Camunda8ClientConfiguration = DeepPartial<CamundaPlatform8Configuration> & {
146
- logger?: Logger;
147
- };
148
160
  export {};