From 87402d6b51dfe54aca8d69d16516fc50e5eb1369 Mon Sep 17 00:00:00 2001 From: Josh Wulf Date: Mon, 8 Apr 2024 17:00:14 +1200 Subject: [PATCH 1/7] Release 8.5.0 (#124) * ci(repo): create npm publish workflow (#100) * Remove-docs (#101) * docs(repo): remove docs * docs(repo): add docs folder to .gitignore * ci(repo): update publish workflow (#102) * ci(repo): configure renovate to run against alpha branch (#103) * ci(repo): configure renovate to run against alpha branch * ci(repo): add workflow step to merge to alpha from main on release * chore(release): 8.5.0-alpha.1 [skip ci] # [8.5.0-alpha.1](https://github.com/camunda/camunda-8-js-sdk/compare/v8.4.0...v8.5.0-alpha.1) (2024-04-04) ### Features * **oauth:** support optional scope in OAuth request ([#25](https://github.com/camunda/camunda-8-js-sdk/issues/25)) ([0451b80](https://github.com/camunda/camunda-8-js-sdk/commit/0451b802594f76518830b9bdff515d67fc0231b9)) * **operate:** add multitenant support and lossless Json parsing ([#82](https://github.com/camunda/camunda-8-js-sdk/issues/82)) ([cf49a71](https://github.com/camunda/camunda-8-js-sdk/commit/cf49a717e2632af845529b3c1fde85ee1b0b347b)), closes [#78](https://github.com/camunda/camunda-8-js-sdk/issues/78) [#67](https://github.com/camunda/camunda-8-js-sdk/issues/67) * **repo:** add enhanced debug output for http errors ([#88](https://github.com/camunda/camunda-8-js-sdk/issues/88)) ([881b039](https://github.com/camunda/camunda-8-js-sdk/commit/881b03965cc37431885a76291f7c0aa762f26227)), closes [#87](https://github.com/camunda/camunda-8-js-sdk/issues/87) * **tasklist:** add multitenant support to tasklist ([#85](https://github.com/camunda/camunda-8-js-sdk/issues/85)) ([46bb564](https://github.com/camunda/camunda-8-js-sdk/commit/46bb564365afc3bc6758cd436490a459708128e6)) * **zeebe:** add MigrateProcessInstance ([#97](https://github.com/camunda/camunda-8-js-sdk/issues/97)) ([2a9a123](https://github.com/camunda/camunda-8-js-sdk/commit/2a9a1232b160962f86b9450edd9047a8a933068a)), closes [#49](https://github.com/camunda/camunda-8-js-sdk/issues/49) * **zeebe:** implement deleteResource ([#73](https://github.com/camunda/camunda-8-js-sdk/issues/73)) ([0cd08b7](https://github.com/camunda/camunda-8-js-sdk/commit/0cd08b7b85d23ab44e42b36b2d9b48c1cfcb8c63)) * **zeebe:** implement lossless parsing of job payload ([#95](https://github.com/camunda/camunda-8-js-sdk/issues/95)) ([57f3ea8](https://github.com/camunda/camunda-8-js-sdk/commit/57f3ea85d4cf86256301f5f2a9bcead09c01a199)), closes [#81](https://github.com/camunda/camunda-8-js-sdk/issues/81) * **zeebe:** normalise useragent, thread config ([#94](https://github.com/camunda/camunda-8-js-sdk/issues/94)) ([c1c4211](https://github.com/camunda/camunda-8-js-sdk/commit/c1c4211db11173c56d2410f489503ef9acf185f2)) * **zeebe:** remove deployProcess method ([#71](https://github.com/camunda/camunda-8-js-sdk/issues/71)) ([6cb98f0](https://github.com/camunda/camunda-8-js-sdk/commit/6cb98f0ff3baf643015bacfa690f4f119caf6083)) * test(repo): skip jest global setup for unit tests (#106) Fixes #105 * build(repo): parallelise publish workflow * build(repo): fix parallelisation * fix(repo): add note on "supported" (#107) Fixes #70 * chore(release): 8.5.0-alpha.2 [skip ci] # [8.5.0-alpha.2](https://github.com/camunda/camunda-8-js-sdk/compare/v8.5.0-alpha.1...v8.5.0-alpha.2) (2024-04-05) ### Bug Fixes * **repo:** add note on "supported" ([#107](https://github.com/camunda/camunda-8-js-sdk/issues/107)) ([fc45d61](https://github.com/camunda/camunda-8-js-sdk/commit/fc45d618bc459a06fbf76bd6907511d08e1f583b)), closes [#70](https://github.com/camunda/camunda-8-js-sdk/issues/70) * fix(repo): only git commit on npm publish success * chore(release): 8.5.0-alpha.3 [skip ci] # [8.5.0-alpha.3](https://github.com/camunda/camunda-8-js-sdk/compare/v8.5.0-alpha.2...v8.5.0-alpha.3) (2024-04-05) ### Bug Fixes * **repo:** only git commit on npm publish success ([9012764](https://github.com/camunda/camunda-8-js-sdk/commit/901276451845c5dbd926af0a6563d5564d3e87b9)) * chore(release): 8.5.0-alpha.3 [skip ci] # [8.5.0-alpha.3](https://github.com/camunda/camunda-8-js-sdk/compare/v8.5.0-alpha.2...v8.5.0-alpha.3) (2024-04-05) ### Bug Fixes * **repo:** only git commit on npm publish success ([9012764](https://github.com/camunda/camunda-8-js-sdk/commit/901276451845c5dbd926af0a6563d5564d3e87b9)) * build(repo): configure semantic release (#109) fixes #108 * fix(repo): use ts-patch to transform module mapping in output (#112) * fix(repo): use ts-patch to transform module mapping in output fixes #110 * build(repo): add missing tsconfig-paths * chore(release): 8.5.0-alpha.4 [skip ci] # [8.5.0-alpha.4](https://github.com/camunda/camunda-8-js-sdk/compare/v8.5.0-alpha.3...v8.5.0-alpha.4) (2024-04-05) ### Bug Fixes * **repo:** use ts-patch to transform module mapping in output ([#112](https://github.com/camunda/camunda-8-js-sdk/issues/112)) ([7efdcf3](https://github.com/camunda/camunda-8-js-sdk/commit/7efdcf3478a0d68b4f1cbc62c1526ba7275008b0)), closes [#110](https://github.com/camunda/camunda-8-js-sdk/issues/110) * chore(release): 8.5.0-alpha.4 [skip ci] # [8.5.0-alpha.4](https://github.com/camunda/camunda-8-js-sdk/compare/v8.5.0-alpha.3...v8.5.0-alpha.4) (2024-04-05) ### Bug Fixes * **repo:** use ts-patch to transform module mapping in output ([#112](https://github.com/camunda/camunda-8-js-sdk/issues/112)) ([7efdcf3](https://github.com/camunda/camunda-8-js-sdk/commit/7efdcf3478a0d68b4f1cbc62c1526ba7275008b0)), closes [#110](https://github.com/camunda/camunda-8-js-sdk/issues/110) * ci(repo): parallelise tests and use npm install in CI (#116) fixes #115 * Jwulf/issue114 (#117) * fix(repo): use relative paths in source fixes #114 * test(repo): fix relative path in jest setup * test(repo): fix relative path to zeebe * test(repo): convert tests to relative paths * revert(github): remove spurious commitlint config file * fix(repo): make fix type commits release a new package * ci(repo): wrap long lines in commit messages * ci(repo): wrap footer lines at 100 characters in semantic-release config * ci(repo): break commit msgs to 100 chars via husky hook * ci(repo): disable husky during semantic-release * chore(release): 8.5.0-alpha.5 [skip ci] # [8.5.0-alpha.5](https://github.com/camunda/camunda-8-js-sdk/compare/v8.5.0-alpha.4...v8.5.0-alpha.5) (2024-04-07) ### Bug Fixes * **repo:** make fix type commits release a new package ([ded83cf](https://github.com/camunda/camunda-8-js-sdk/commit/ded83cfaf437a2f62a5ef134d7616538facda614)) * chore(release): 8.5.0-alpha.5 [skip ci] # [8.5.0-alpha.5](https://github.com/camunda/camunda-8-js-sdk/compare/v8.5.0-alpha.4...v8.5.0-alpha.5) (2024-04-07) ### Bug Fixes * **repo:** make fix type commits release a new package ([ded83cf](https://github.com/camunda/camunda-8-js-sdk/commit/ded83cfaf437a2f62a5ef134d7616538facda614)) * Issue118 (#119) * test(repo): add smoke test and type surface tests fixes #118 * ci(repo): run smoke test in CI * fix(camunda8): respect OAuth disabled flag * fix(issue118): add smoke test and type surface tests * test(repo): add smoke test and type surface tests fixes #118 * ci(repo): run smoke test in CI * fix(camunda8): respect OAuth disabled flag * release(repo): trigger a new release * chore(release): 8.5.0-alpha.6 [skip ci] # [8.5.0-alpha.6](https://github.com/camunda/camunda-8-js-sdk/compare/v8.5.0-alpha.5...v8.5.0-alpha.6) (2024-04-08) ### Bug Fixes * **issue118:** add smoke test and type surface tests ([fe0c709](https://github.com/camunda/camunda-8-js-sdk/commit/fe0c70925cf3df610b049e776eed5bffe56ef604)), closes [#118](https://github.com/camunda/camunda-8-js-sdk/issues/118) * chore(release): 8.5.0-alpha.6 [skip ci] # [8.5.0-alpha.6](https://github.com/camunda/camunda-8-js-sdk/compare/v8.5.0-alpha.5...v8.5.0-alpha.6) (2024-04-08) ### Bug Fixes * **issue118:** add smoke test and type surface tests ([fe0c709](https://github.com/camunda/camunda-8-js-sdk/commit/fe0c70925cf3df610b049e776eed5bffe56ef604)), closes [#118](https://github.com/camunda/camunda-8-js-sdk/issues/118) * ci(repo): add CodeQL scanning (#120) fixes #51 --------- Co-authored-by: semantic-release-bot --- .eslintrc.json | 3 + .github/workflows/code-scanning.yml | 34 + .github/workflows/commitlint.yml | 9 +- .github/workflows/multitenancy.yml | 57 - .github/workflows/pr-test.yml | 155 ++ .github/workflows/publish.yml | 219 +++ .github/workflows/saas.yml | 40 - .github/workflows/singletenant.yml | 55 - .github/workflows/tag-and-publish.yml | 76 - .github/workflows/unit.yml | 25 + .gitignore | 2 + .npmignore | 13 + .releaserc | 16 - .vscode/settings.json | 3 +- CHANGELOG.md | 56 +- CONTRIBUTING.md | 33 +- README.md | 20 +- commitlint.config.js | 26 +- docs/.nojekyll | 1 - docs/assets/highlight.css | 99 -- docs/assets/icons.js | 15 - docs/assets/icons.svg | 1 - docs/assets/main.js | 59 - docs/assets/navigation.js | 1 - docs/assets/search.js | 1 - docs/assets/style.css | 1414 ----------------- docs/classes/index.Admin.AdminApiClient.html | 39 - docs/classes/index.Auth.NullAuthProvider.html | 3 - docs/classes/index.Auth.OAuthProvider.html | 36 - docs/classes/index.Camunda8.html | 86 - .../index.Modeler.ModelerApiClient.html | 127 -- .../index.Operate.OperateApiClient.html | 65 - ...index.Operate.OperateDto.ChangeStatus.html | 8 - ...Operate.OperateDto.DecisionDefinition.html | 16 - ...x.Operate.OperateDto.DecisionInstance.html | 21 - ...rate.OperateDto.DecisionInstanceInput.html | 9 - ...ate.OperateDto.DecisionInstanceOutput.html | 11 - ...erate.OperateDto.DecisionRequirements.html | 13 - ...x.Operate.OperateDto.FlownodeInstance.html | 15 - .../index.Operate.OperateDto.Incident.html | 15 - ....Operate.OperateDto.ProcessDefinition.html | 11 - ...ex.Operate.OperateDto.ProcessInstance.html | 16 - ....OperateDto.ProcessInstanceStatistics.html | 11 - .../index.Operate.OperateDto.Variable.html | 12 - .../index.Optimize.OptimizeApiClient.html | 83 - .../index.Tasklist.TasklistApiClient.html | 46 - .../index.Tasklist.TasklistDto.Form.html | 12 - ...dex.Tasklist.TasklistDto.TaskResponse.html | 26 - ...sklist.TasklistDto.TaskSearchResponse.html | 29 - docs/classes/index.Zeebe.BpmnParser.html | 26 - docs/classes/index.Zeebe.ZBWorker.html | 26 - docs/classes/index.Zeebe.ZeebeGrpcClient.html | 225 --- .../classes/index._internal_.LosslessDto.html | 6 - ...dex._internal_.StatefulLogInterceptor.html | 22 - .../index._internal_.TypedEmitter.html | 7 - docs/classes/index._internal_.ZBLogger.html | 17 - .../index._internal_.ZBWorkerBase.html | 55 - .../zeebe_types._internal_.GrpcClient.html | 92 -- ...dex.Zeebe.Types.PartitionBrokerHealth.html | 5 - ...index.Zeebe.Types.PartitionBrokerRole.html | 5 - docs/hierarchy.html | 1 - docs/index.html | 107 -- .../index.Admin.AdminDto.Cluster.html | 11 - .../index.Admin.AdminDto.ClusterClient.html | 4 - ...minDto.ClusterClientConnectionDetails.html | 5 - ...ndex.Admin.AdminDto.CreateClusterBody.html | 6 - ...x.Admin.AdminDto.CreatedClusterClient.html | 4 - .../index.Admin.AdminDto.Member.html | 5 - .../index.Admin.AdminDto.Parameters.html | 4 - .../interfaces/index.Auth.IOAuthProvider.html | 2 - docs/interfaces/index.Auth.Token.html | 7 - docs/interfaces/index.Auth.TokenError.html | 3 - ...eler.ModelerDto.CreateCollaboratorDto.html | 4 - ...ndex.Modeler.ModelerDto.CreateFileDto.html | 10 - ...ex.Modeler.ModelerDto.CreateFolderDto.html | 7 - ...Modeler.ModelerDto.CreateMilestoneDto.html | 5 - .../index.Modeler.ModelerDto.FileDto.html | 3 - ...ex.Modeler.ModelerDto.FileMetadataDto.html | 13 - ...x.Modeler.ModelerDto.FolderContentDto.html | 3 - .../index.Modeler.ModelerDto.FolderDto.html | 3 - ....Modeler.ModelerDto.FolderMetadataDto.html | 9 - .../index.Modeler.ModelerDto.InfoDto.html | 7 - ...index.Modeler.ModelerDto.MilestoneDto.html | 3 - ...deler.ModelerDto.MilestoneMetadataDto.html | 8 - ...dex.Modeler.ModelerDto.PathElementDto.html | 3 - ...ler.ModelerDto.ProjectCollaboratorDto.html | 5 - ...dex.Modeler.ModelerDto.ProjectContent.html | 3 - .../index.Modeler.ModelerDto.ProjectDto.html | 3 - ...Modeler.ModelerDto.ProjectMetadataDto.html | 7 - ...odelerDto.PubSearchDtoFileMetadataDto.html | 7 - ...rDto.PubSearchDtoMilestoneMetadataDto.html | 7 - ...to.PubSearchDtoProjectCollaboratorDto.html | 7 - ...lerDto.PubSearchDtoProjectMetadataDto.html | 7 - ...Dto.PubSearchResultDtoFileMetadataDto.html | 3 - ...ubSearchResultDtoMilestoneMetadataDto.html | 3 - ...SearchResultDtoProjectCollaboratorDto.html | 3 - ....PubSearchResultDtoProjectMetadataDto.html | 3 - .../index.Modeler.ModelerDto.SortDto.html | 3 - ...ndex.Modeler.ModelerDto.UpdateFileDto.html | 9 - ...ex.Modeler.ModelerDto.UpdateFolderDto.html | 7 - .../index.Modeler.ModelerDto.UserDto.html | 3 - .../index.Operate.OperateDto.Query.html | 5 - ...ndex.Operate.OperateDto.SearchResults.html | 4 - ...dex.Optimize.OptimizeDto.CloudEventV1.html | 100 -- ...ze.OptimizeDto.CloudEventV1Attributes.html | 82 - ...izeDto.CloudEventV1OptionalAttributes.html | 54 - ...imize.OptimizeDto.DashboardDefinition.html | 8 - ...index.Optimize.OptimizeDto.ReportData.html | 11 - ...timize.OptimizeDto.ReportDataExporter.html | 2 - ...x.Optimize.OptimizeDto.ReportDataPage.html | 6 - .../index.Optimize.OptimizeDto.Variable.html | 7 - ...ex.Optimize.OptimizeDto.VariableLabel.html | 4 - ...x.Optimize.OptimizeDto.VariableLabels.html | 3 - ...index.Tasklist.TasklistDto.DateFilter.html | 3 - ....TasklistDto.DraftSearchVariableValue.html | 4 - ....Tasklist.TasklistDto.TaskByVariables.html | 4 - ...listDto.TaskSearchAfterOrEqualRequest.html | 31 - ...st.TasklistDto.TaskSearchAfterRequest.html | 31 - ...istDto.TaskSearchBeforeOrEqualRequest.html | 31 - ...t.TasklistDto.TaskSearchBeforeRequest.html | 31 - ...ist.TasklistDto.TaskSearchRequestBase.html | 28 - .../index.Tasklist.TasklistDto.User.html | 6 - .../index.Tasklist.TasklistDto.Variable.html | 6 - ...ex.Tasklist.TasklistDto.VariableInput.html | 3 - ...st.TasklistDto.VariableSearchResponse.html | 6 - ...to.VariableSearchResponseWithoutDraft.html | 5 - .../index._internal_.Characteristics.html | 3 - docs/interfaces/index._internal_.Emitter.html | 4 - .../index._internal_.IncludeVariable.html | 3 - docs/interfaces/index._internal_.JSONDoc.html | 1 - docs/interfaces/index._internal_.Logger.html | 4 - .../index._internal_.TaskOrderBy.html | 3 - ...._internal_.ZBWorkerConstructorConfig.html | 11 - .../zeebe_types.ActivateInstruction.html | 9 - .../zeebe_types.ActivateJobsRequest.html | 23 - .../zeebe_types.ActivateJobsResponse.html | 2 - docs/interfaces/zeebe_types.ActivatedJob.html | 32 - .../zeebe_types.BroadcastSignalReq.html | 4 - .../zeebe_types.BroadcastSignalRequest.html | 8 - .../zeebe_types.BroadcastSignalRes.html | 2 - .../zeebe_types.BroadcastSignalResponse.html | 3 - docs/interfaces/zeebe_types.BrokerInfo.html | 5 - .../zeebe_types.CamundaCloudConfig.html | 9 - .../zeebe_types.CompleteJobRequest.html | 3 - .../zeebe_types.CreateProcessBaseRequest.html | 10 - ...ypes.CreateProcessInstanceBaseRequest.html | 10 - .../zeebe_types.CreateProcessInstanceReq.html | 14 - ...be_types.CreateProcessInstanceRequest.html | 14 - ...e_types.CreateProcessInstanceResponse.html | 15 - ...es.CreateProcessInstanceWithResultReq.html | 16 - ...reateProcessInstanceWithResultRequest.html | 8 - ...eateProcessInstanceWithResultResponse.html | 15 - ...ocessInstanceWithResultResponseOnWire.html | 15 - .../zeebe_types.DecisionDeployment.html | 2 - .../zeebe_types.DecisionMetadata.html | 19 - ..._types.DecisionRequirementsDeployment.html | 2 - ...be_types.DecisionRequirementsMetadata.html | 16 - .../zeebe_types.DeleteResourceRequest.html | 4 - .../zeebe_types.DeployResourceRequest.html | 5 - .../zeebe_types.DeployResourceResponse.html | 7 - .../zeebe_types.ErrorJobWithVariables.html | 4 - .../zeebe_types.EvaluateDecisionResponse.html | 29 - .../zeebe_types.EvaluatedDecision.html | 22 - .../zeebe_types.EvaluatedDecisionInput.html | 7 - .../zeebe_types.EvaluatedDecisionOutput.html | 7 - .../zeebe_types.FailJobRequest.html | 5 - .../zeebe_types.FormDeployment.html | 2 - docs/interfaces/zeebe_types.FormMetadata.html | 12 - .../zeebe_types.ICustomHeaders.html | 1 - .../zeebe_types.IInputVariables.html | 1 - .../zeebe_types.IOutputVariables.html | 1 - .../zeebe_types.IProcessVariables.html | 1 - docs/interfaces/zeebe_types.JSONDoc.html | 1 - docs/interfaces/zeebe_types.Job.html | 25 - .../zeebe_types.JobCompletionInterface.html | 19 - .../zeebe_types.JobFailureConfiguration.html | 6 - .../zeebe_types.ListProcessResponse.html | 2 - .../zeebe_types.MatchedDecisionRule.html | 7 - ...be_types.ModifyProcessInstanceRequest.html | 8 - .../zeebe_types.OAuthProviderConfig.html | 13 - .../zeebe_types.OperationOptionsNoRetry.html | 3 - ...zeebe_types.OperationOptionsWithRetry.html | 4 - docs/interfaces/zeebe_types.Partition.html | 6 - .../zeebe_types.ProcessDeployment.html | 2 - ...ocessInstanceCreationStartInstruction.html | 9 - .../zeebe_types.ProcessMetadata.html | 13 - .../zeebe_types.ProcessRequestObject.html | 3 - .../zeebe_types.PublishMessageRequest.html | 12 - .../zeebe_types.PublishMessageResponse.html | 5 - ...eebe_types.PublishStartMessageRequest.html | 12 - .../zeebe_types.ResolveIncidentRequest.html | 2 - docs/interfaces/zeebe_types.Resource.html | 5 - .../zeebe_types.SetVariablesRequest.html | 11 - ...be_types.SetVariablesRequestOnTheWire.html | 11 - ...eebe_types.StreamActivatedJobsRequest.html | 13 - .../zeebe_types.TerminateInstruction.html | 3 - .../zeebe_types.ThrowErrorRequest.html | 13 - .../zeebe_types.TopologyResponse.html | 6 - .../zeebe_types.UpdateJobRetriesRequest.html | 3 - .../zeebe_types.VariableInstruction.html | 10 - .../zeebe_types.ZBClientOptions.html | 20 - .../zeebe_types.ZBCustomLogger.html | 7 - docs/interfaces/zeebe_types.ZBGrpc.html | 26 - docs/interfaces/zeebe_types.ZBLogMessage.html | 7 - .../zeebe_types.ZBLoggerConfig.html | 11 - .../zeebe_types.ZBLoggerOptions.html | 8 - .../zeebe_types.ZBWorkerConfig.html | 41 - .../zeebe_types.ZBWorkerOptions.html | 16 - docs/interfaces/zeebe_types.ZeebeJob.html | 43 - ...ProcessInstanceWithResultResponseBase.html | 13 - .../zeebe_types._internal_.CustomSSL.html | 5 - ...zeebe_types._internal_.GrpcClientCtor.html | 81 - ...._internal_.GrpcClientExtendedOptions.html | 3 - ...es._internal_.SetVariablesRequestBase.html | 10 - docs/modules/index.Admin.AdminDto.html | 10 - docs/modules/index.Admin.html | 3 - docs/modules/index.Auth.html | 6 - docs/modules/index.Modeler.ModelerDto.html | 30 - docs/modules/index.Modeler.html | 3 - docs/modules/index.Operate.OperateDto.html | 15 - docs/modules/index.Operate.html | 3 - docs/modules/index.Optimize.OptimizeDto.html | 16 - docs/modules/index.Optimize.html | 3 - docs/modules/index.Tasklist.TasklistDto.html | 18 - docs/modules/index.Tasklist.html | 3 - docs/modules/index.Zeebe.Types.html | 4 - docs/modules/index.Zeebe.html | 6 - docs/modules/index._internal_.html | 25 - docs/modules/index.html | 11 - docs/modules/zeebe_types._internal_.html | 7 - docs/modules/zeebe_types.html | 92 -- ...ex.Admin.AdminDto.ClusterStatusstring.html | 1 - ...index.Admin.AdminDto.OrganizationRole.html | 1 - ...imize.OptimizeDto.DashboardCollection.html | 1 - ...mize.OptimizeDto.EntityImportResponse.html | 1 - ...Optimize.OptimizeDto.ReportCollection.html | 1 - ...imize.OptimizeDto.SingleProcessReport.html | 1 - ...dex.Optimize.OptimizeDto.VariableType.html | 1 - .../index.Tasklist.TasklistDto.TaskState.html | 1 - docs/types/index._internal_.DeepPartial.html | 1 - ...nternal_.EnhanceWithTenantIdIfMissing.html | 1 - docs/types/index._internal_.EventKey.html | 1 - docs/types/index._internal_.EventMap.html | 1 - .../types/index._internal_.EventReceiver.html | 1 - ...ndex._internal_.GrpcConnectionProfile.html | 1 - docs/types/index._internal_.JSON.html | 1 - docs/types/index._internal_.JSONDoc-1.html | 1 - docs/types/index._internal_.LogFn.html | 1 - docs/types/index._internal_.State.html | 1 - ...dex._internal_.TokenGrantAudienceType.html | 1 - .../zeebe_types.ConnectionErrorHandler.html | 1 - docs/types/zeebe_types.Deployment.html | 1 - docs/types/zeebe_types.ErrorJobOutcome.html | 1 - .../zeebe_types.EvaluateDecisionRequest.html | 18 - ...eebe_types.JOB_ACTION_ACKNOWLEDGEMENT.html | 1 - docs/types/zeebe_types.JSON.html | 1 - docs/types/zeebe_types.Loglevel.html | 1 - ...e_types.ModifyProcessInstanceResponse.html | 1 - ...es.MustReturnJobActionAcknowledgement.html | 1 - docs/types/zeebe_types.OperationOptions.html | 1 - .../zeebe_types.ZBWorkerTaskHandler.html | 1 - docs/variables/index.Dto.html | 10 - docs/variables/index.Zeebe.Logging.html | 23 - ...eebe.Types.JOB_ACTION_ACKNOWLEDGEMENT.html | 1 - ...ndex._internal_.ConnectionStatusEvent.html | 1 - ...be_types.JOB_ACTION_ACKNOWLEDGEMENT-1.html | 1 - lerna.json | 17 - package-lock.json | 619 +++++++- package.json | 32 +- release.config.js | 49 + renovate.json | 3 + smoke-test/package-lock.json | 29 + smoke-test/package.json | 15 + smoke-test/smoke-test.js | 45 + smoke-test/tsconfig.json | 9 + src/__tests__/admin/admin.spec.ts | 3 +- src/__tests__/config/jest.cleanup.ts | 17 +- src/__tests__/lib/LosslessJsonParser.spec.ts | 4 +- src/__tests__/modeler/modeler.spec.ts | 3 +- src/__tests__/oauth/OAuthProvider.spec.ts | 12 +- .../operate/multitenancy/operate-mt.spec.ts | 5 +- src/__tests__/operate/operate.spec.ts | 5 +- src/__tests__/optimize/optimize.spec.ts | 3 +- .../tasklist/tasklist.integration.spec.ts | 9 +- src/__tests__/tasklist/tasklist.spec.ts | 3 +- .../Client-BroadcastSignal.spec.ts | 3 +- .../integration/Client-BrokenBpmn.spec.ts | 3 +- .../Client-ConnectionError.spec.ts | 3 +- ...nt-CreateProcessInstanceWithResult.spec.ts | 5 +- .../integration/Client-DeleteResource.spec.ts | 4 +- .../integration/Client-DeployProcess.spec.ts | 3 +- .../integration/Client-DeployResource.spec.ts | 3 +- .../Client-EvaluateDecision.spec.ts | 3 +- .../integration/Client-MessageStart.spec.ts | 4 +- .../Client-MigrateProcessInstance.spec.ts | 5 +- .../Client-ModifyProcessInstance.spec.ts | 3 +- .../integration/Client-PublishMessage.spec.ts | 2 +- .../integration/Client-ThrowError.spec.ts | 2 +- .../integration/Client-integration.spec.ts | 3 +- .../zeebe/integration/Client-onReady.spec.ts | 3 +- .../integration/Client-setVariables.spec.ts | 3 +- .../integration/Client-startProcess.spec.ts | 3 +- .../zeebe/integration/Topology.spec.ts | 3 +- .../integration/TypeSurfaceAreaTest.spec.ts | 3 +- .../integration/Worker-1.0-complete.spec.ts | 3 +- .../zeebe/integration/Worker-Dto.spec.ts | 3 +- .../Worker-Failure-Backoff-Retry.spec.ts | 3 +- .../Worker-Failure-Retries.spec.ts | 3 +- .../zeebe/integration/Worker-Failure.spec.ts | 3 +- .../zeebe/integration/Worker-LongPoll.spec.ts | 2 +- .../integration/Worker-RaiseIncident.spec.ts | 3 +- .../integration/Worker-fetchVariable.spec.ts | 3 +- .../integration/Worker-integration.spec.ts | 3 +- .../zeebe/integration/Worker-onReady.spec.ts | 3 +- .../createProcessInstance-mt.spec.ts | 6 +- .../multitenancy/deployprocess-mt.spec.ts | 3 +- .../multitenancy/signalbroadcast-mt.spec.ts | 6 +- src/admin/lib/AdminApiClient.ts | 4 +- src/c8/index.ts | 26 +- src/lib/ClientConstructor.ts | 2 +- src/lib/Configuration.ts | 2 +- src/lib/ConstructOAuthProvider.ts | 2 +- src/lib/LosslessJsonParser.ts | 2 +- src/lib/RequireConfiguration.ts | 2 +- src/modeler/lib/ModelerAPIClient.ts | 5 +- src/oauth/lib/NullAuthProvider.ts | 3 +- src/oauth/lib/OAuthProvider.ts | 10 +- src/operate/lib/OperateApiClient.ts | 5 +- src/operate/lib/OperateDto.ts | 3 +- src/operate/lib/TestableOperateApiClient.ts | 2 +- src/operate/lib/parseSearchResults.ts | 3 +- src/optimize/lib/OptimizeApiClient.ts | 5 +- src/tasklist/lib/TasklistApiClient.ts | 4 +- src/tasklist/lib/TasklistDto.ts | 2 +- src/tasklist/lib/utils.ts | 2 +- src/zeebe/lib/GrpcClient.ts | 5 +- src/zeebe/lib/ZBWorkerBase.ts | 2 +- src/zeebe/lib/cancelProcesses.ts | 2 +- src/zeebe/lib/stringifyVariables.ts | 2 +- src/zeebe/zb/ZeebeGrpcClient.ts | 12 +- test-d/index.test-d.ts | 31 + tsconfig.json | 14 +- zeebe-extra/.github/workflows/build-docs.yml | 4 +- zeebe-extra/CHANGELOG.md | 94 +- zeebe-extra/DEVELOP.md | 2 +- zeebe-extra/package.json | 6 +- 346 files changed, 1497 insertions(+), 5418 deletions(-) create mode 100644 .github/workflows/code-scanning.yml delete mode 100644 .github/workflows/multitenancy.yml create mode 100644 .github/workflows/pr-test.yml create mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/saas.yml delete mode 100644 .github/workflows/singletenant.yml delete mode 100644 .github/workflows/tag-and-publish.yml create mode 100644 .github/workflows/unit.yml delete mode 100644 .releaserc delete mode 100644 docs/.nojekyll delete mode 100644 docs/assets/highlight.css delete mode 100644 docs/assets/icons.js delete mode 100644 docs/assets/icons.svg delete mode 100644 docs/assets/main.js delete mode 100644 docs/assets/navigation.js delete mode 100644 docs/assets/search.js delete mode 100644 docs/assets/style.css delete mode 100644 docs/classes/index.Admin.AdminApiClient.html delete mode 100644 docs/classes/index.Auth.NullAuthProvider.html delete mode 100644 docs/classes/index.Auth.OAuthProvider.html delete mode 100644 docs/classes/index.Camunda8.html delete mode 100644 docs/classes/index.Modeler.ModelerApiClient.html delete mode 100644 docs/classes/index.Operate.OperateApiClient.html delete mode 100644 docs/classes/index.Operate.OperateDto.ChangeStatus.html delete mode 100644 docs/classes/index.Operate.OperateDto.DecisionDefinition.html delete mode 100644 docs/classes/index.Operate.OperateDto.DecisionInstance.html delete mode 100644 docs/classes/index.Operate.OperateDto.DecisionInstanceInput.html delete mode 100644 docs/classes/index.Operate.OperateDto.DecisionInstanceOutput.html delete mode 100644 docs/classes/index.Operate.OperateDto.DecisionRequirements.html delete mode 100644 docs/classes/index.Operate.OperateDto.FlownodeInstance.html delete mode 100644 docs/classes/index.Operate.OperateDto.Incident.html delete mode 100644 docs/classes/index.Operate.OperateDto.ProcessDefinition.html delete mode 100644 docs/classes/index.Operate.OperateDto.ProcessInstance.html delete mode 100644 docs/classes/index.Operate.OperateDto.ProcessInstanceStatistics.html delete mode 100644 docs/classes/index.Operate.OperateDto.Variable.html delete mode 100644 docs/classes/index.Optimize.OptimizeApiClient.html delete mode 100644 docs/classes/index.Tasklist.TasklistApiClient.html delete mode 100644 docs/classes/index.Tasklist.TasklistDto.Form.html delete mode 100644 docs/classes/index.Tasklist.TasklistDto.TaskResponse.html delete mode 100644 docs/classes/index.Tasklist.TasklistDto.TaskSearchResponse.html delete mode 100644 docs/classes/index.Zeebe.BpmnParser.html delete mode 100644 docs/classes/index.Zeebe.ZBWorker.html delete mode 100644 docs/classes/index.Zeebe.ZeebeGrpcClient.html delete mode 100644 docs/classes/index._internal_.LosslessDto.html delete mode 100644 docs/classes/index._internal_.StatefulLogInterceptor.html delete mode 100644 docs/classes/index._internal_.TypedEmitter.html delete mode 100644 docs/classes/index._internal_.ZBLogger.html delete mode 100644 docs/classes/index._internal_.ZBWorkerBase.html delete mode 100644 docs/classes/zeebe_types._internal_.GrpcClient.html delete mode 100644 docs/enums/index.Zeebe.Types.PartitionBrokerHealth.html delete mode 100644 docs/enums/index.Zeebe.Types.PartitionBrokerRole.html delete mode 100644 docs/hierarchy.html delete mode 100644 docs/index.html delete mode 100644 docs/interfaces/index.Admin.AdminDto.Cluster.html delete mode 100644 docs/interfaces/index.Admin.AdminDto.ClusterClient.html delete mode 100644 docs/interfaces/index.Admin.AdminDto.ClusterClientConnectionDetails.html delete mode 100644 docs/interfaces/index.Admin.AdminDto.CreateClusterBody.html delete mode 100644 docs/interfaces/index.Admin.AdminDto.CreatedClusterClient.html delete mode 100644 docs/interfaces/index.Admin.AdminDto.Member.html delete mode 100644 docs/interfaces/index.Admin.AdminDto.Parameters.html delete mode 100644 docs/interfaces/index.Auth.IOAuthProvider.html delete mode 100644 docs/interfaces/index.Auth.Token.html delete mode 100644 docs/interfaces/index.Auth.TokenError.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.CreateCollaboratorDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.CreateFileDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.CreateFolderDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.CreateMilestoneDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.FileDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.FileMetadataDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.FolderContentDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.FolderDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.FolderMetadataDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.InfoDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.MilestoneDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.MilestoneMetadataDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.PathElementDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.ProjectCollaboratorDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.ProjectContent.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.ProjectDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.ProjectMetadataDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.PubSearchDtoFileMetadataDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.PubSearchDtoMilestoneMetadataDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.PubSearchDtoProjectCollaboratorDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.PubSearchDtoProjectMetadataDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoFileMetadataDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoMilestoneMetadataDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoProjectCollaboratorDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoProjectMetadataDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.SortDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.UpdateFileDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.UpdateFolderDto.html delete mode 100644 docs/interfaces/index.Modeler.ModelerDto.UserDto.html delete mode 100644 docs/interfaces/index.Operate.OperateDto.Query.html delete mode 100644 docs/interfaces/index.Operate.OperateDto.SearchResults.html delete mode 100644 docs/interfaces/index.Optimize.OptimizeDto.CloudEventV1.html delete mode 100644 docs/interfaces/index.Optimize.OptimizeDto.CloudEventV1Attributes.html delete mode 100644 docs/interfaces/index.Optimize.OptimizeDto.CloudEventV1OptionalAttributes.html delete mode 100644 docs/interfaces/index.Optimize.OptimizeDto.DashboardDefinition.html delete mode 100644 docs/interfaces/index.Optimize.OptimizeDto.ReportData.html delete mode 100644 docs/interfaces/index.Optimize.OptimizeDto.ReportDataExporter.html delete mode 100644 docs/interfaces/index.Optimize.OptimizeDto.ReportDataPage.html delete mode 100644 docs/interfaces/index.Optimize.OptimizeDto.Variable.html delete mode 100644 docs/interfaces/index.Optimize.OptimizeDto.VariableLabel.html delete mode 100644 docs/interfaces/index.Optimize.OptimizeDto.VariableLabels.html delete mode 100644 docs/interfaces/index.Tasklist.TasklistDto.DateFilter.html delete mode 100644 docs/interfaces/index.Tasklist.TasklistDto.DraftSearchVariableValue.html delete mode 100644 docs/interfaces/index.Tasklist.TasklistDto.TaskByVariables.html delete mode 100644 docs/interfaces/index.Tasklist.TasklistDto.TaskSearchAfterOrEqualRequest.html delete mode 100644 docs/interfaces/index.Tasklist.TasklistDto.TaskSearchAfterRequest.html delete mode 100644 docs/interfaces/index.Tasklist.TasklistDto.TaskSearchBeforeOrEqualRequest.html delete mode 100644 docs/interfaces/index.Tasklist.TasklistDto.TaskSearchBeforeRequest.html delete mode 100644 docs/interfaces/index.Tasklist.TasklistDto.TaskSearchRequestBase.html delete mode 100644 docs/interfaces/index.Tasklist.TasklistDto.User.html delete mode 100644 docs/interfaces/index.Tasklist.TasklistDto.Variable.html delete mode 100644 docs/interfaces/index.Tasklist.TasklistDto.VariableInput.html delete mode 100644 docs/interfaces/index.Tasklist.TasklistDto.VariableSearchResponse.html delete mode 100644 docs/interfaces/index.Tasklist.TasklistDto.VariableSearchResponseWithoutDraft.html delete mode 100644 docs/interfaces/index._internal_.Characteristics.html delete mode 100644 docs/interfaces/index._internal_.Emitter.html delete mode 100644 docs/interfaces/index._internal_.IncludeVariable.html delete mode 100644 docs/interfaces/index._internal_.JSONDoc.html delete mode 100644 docs/interfaces/index._internal_.Logger.html delete mode 100644 docs/interfaces/index._internal_.TaskOrderBy.html delete mode 100644 docs/interfaces/index._internal_.ZBWorkerConstructorConfig.html delete mode 100644 docs/interfaces/zeebe_types.ActivateInstruction.html delete mode 100644 docs/interfaces/zeebe_types.ActivateJobsRequest.html delete mode 100644 docs/interfaces/zeebe_types.ActivateJobsResponse.html delete mode 100644 docs/interfaces/zeebe_types.ActivatedJob.html delete mode 100644 docs/interfaces/zeebe_types.BroadcastSignalReq.html delete mode 100644 docs/interfaces/zeebe_types.BroadcastSignalRequest.html delete mode 100644 docs/interfaces/zeebe_types.BroadcastSignalRes.html delete mode 100644 docs/interfaces/zeebe_types.BroadcastSignalResponse.html delete mode 100644 docs/interfaces/zeebe_types.BrokerInfo.html delete mode 100644 docs/interfaces/zeebe_types.CamundaCloudConfig.html delete mode 100644 docs/interfaces/zeebe_types.CompleteJobRequest.html delete mode 100644 docs/interfaces/zeebe_types.CreateProcessBaseRequest.html delete mode 100644 docs/interfaces/zeebe_types.CreateProcessInstanceBaseRequest.html delete mode 100644 docs/interfaces/zeebe_types.CreateProcessInstanceReq.html delete mode 100644 docs/interfaces/zeebe_types.CreateProcessInstanceRequest.html delete mode 100644 docs/interfaces/zeebe_types.CreateProcessInstanceResponse.html delete mode 100644 docs/interfaces/zeebe_types.CreateProcessInstanceWithResultReq.html delete mode 100644 docs/interfaces/zeebe_types.CreateProcessInstanceWithResultRequest.html delete mode 100644 docs/interfaces/zeebe_types.CreateProcessInstanceWithResultResponse.html delete mode 100644 docs/interfaces/zeebe_types.CreateProcessInstanceWithResultResponseOnWire.html delete mode 100644 docs/interfaces/zeebe_types.DecisionDeployment.html delete mode 100644 docs/interfaces/zeebe_types.DecisionMetadata.html delete mode 100644 docs/interfaces/zeebe_types.DecisionRequirementsDeployment.html delete mode 100644 docs/interfaces/zeebe_types.DecisionRequirementsMetadata.html delete mode 100644 docs/interfaces/zeebe_types.DeleteResourceRequest.html delete mode 100644 docs/interfaces/zeebe_types.DeployResourceRequest.html delete mode 100644 docs/interfaces/zeebe_types.DeployResourceResponse.html delete mode 100644 docs/interfaces/zeebe_types.ErrorJobWithVariables.html delete mode 100644 docs/interfaces/zeebe_types.EvaluateDecisionResponse.html delete mode 100644 docs/interfaces/zeebe_types.EvaluatedDecision.html delete mode 100644 docs/interfaces/zeebe_types.EvaluatedDecisionInput.html delete mode 100644 docs/interfaces/zeebe_types.EvaluatedDecisionOutput.html delete mode 100644 docs/interfaces/zeebe_types.FailJobRequest.html delete mode 100644 docs/interfaces/zeebe_types.FormDeployment.html delete mode 100644 docs/interfaces/zeebe_types.FormMetadata.html delete mode 100644 docs/interfaces/zeebe_types.ICustomHeaders.html delete mode 100644 docs/interfaces/zeebe_types.IInputVariables.html delete mode 100644 docs/interfaces/zeebe_types.IOutputVariables.html delete mode 100644 docs/interfaces/zeebe_types.IProcessVariables.html delete mode 100644 docs/interfaces/zeebe_types.JSONDoc.html delete mode 100644 docs/interfaces/zeebe_types.Job.html delete mode 100644 docs/interfaces/zeebe_types.JobCompletionInterface.html delete mode 100644 docs/interfaces/zeebe_types.JobFailureConfiguration.html delete mode 100644 docs/interfaces/zeebe_types.ListProcessResponse.html delete mode 100644 docs/interfaces/zeebe_types.MatchedDecisionRule.html delete mode 100644 docs/interfaces/zeebe_types.ModifyProcessInstanceRequest.html delete mode 100644 docs/interfaces/zeebe_types.OAuthProviderConfig.html delete mode 100644 docs/interfaces/zeebe_types.OperationOptionsNoRetry.html delete mode 100644 docs/interfaces/zeebe_types.OperationOptionsWithRetry.html delete mode 100644 docs/interfaces/zeebe_types.Partition.html delete mode 100644 docs/interfaces/zeebe_types.ProcessDeployment.html delete mode 100644 docs/interfaces/zeebe_types.ProcessInstanceCreationStartInstruction.html delete mode 100644 docs/interfaces/zeebe_types.ProcessMetadata.html delete mode 100644 docs/interfaces/zeebe_types.ProcessRequestObject.html delete mode 100644 docs/interfaces/zeebe_types.PublishMessageRequest.html delete mode 100644 docs/interfaces/zeebe_types.PublishMessageResponse.html delete mode 100644 docs/interfaces/zeebe_types.PublishStartMessageRequest.html delete mode 100644 docs/interfaces/zeebe_types.ResolveIncidentRequest.html delete mode 100644 docs/interfaces/zeebe_types.Resource.html delete mode 100644 docs/interfaces/zeebe_types.SetVariablesRequest.html delete mode 100644 docs/interfaces/zeebe_types.SetVariablesRequestOnTheWire.html delete mode 100644 docs/interfaces/zeebe_types.StreamActivatedJobsRequest.html delete mode 100644 docs/interfaces/zeebe_types.TerminateInstruction.html delete mode 100644 docs/interfaces/zeebe_types.ThrowErrorRequest.html delete mode 100644 docs/interfaces/zeebe_types.TopologyResponse.html delete mode 100644 docs/interfaces/zeebe_types.UpdateJobRetriesRequest.html delete mode 100644 docs/interfaces/zeebe_types.VariableInstruction.html delete mode 100644 docs/interfaces/zeebe_types.ZBClientOptions.html delete mode 100644 docs/interfaces/zeebe_types.ZBCustomLogger.html delete mode 100644 docs/interfaces/zeebe_types.ZBGrpc.html delete mode 100644 docs/interfaces/zeebe_types.ZBLogMessage.html delete mode 100644 docs/interfaces/zeebe_types.ZBLoggerConfig.html delete mode 100644 docs/interfaces/zeebe_types.ZBLoggerOptions.html delete mode 100644 docs/interfaces/zeebe_types.ZBWorkerConfig.html delete mode 100644 docs/interfaces/zeebe_types.ZBWorkerOptions.html delete mode 100644 docs/interfaces/zeebe_types.ZeebeJob.html delete mode 100644 docs/interfaces/zeebe_types._internal_.CreateProcessInstanceWithResultResponseBase.html delete mode 100644 docs/interfaces/zeebe_types._internal_.CustomSSL.html delete mode 100644 docs/interfaces/zeebe_types._internal_.GrpcClientCtor.html delete mode 100644 docs/interfaces/zeebe_types._internal_.GrpcClientExtendedOptions.html delete mode 100644 docs/interfaces/zeebe_types._internal_.SetVariablesRequestBase.html delete mode 100644 docs/modules/index.Admin.AdminDto.html delete mode 100644 docs/modules/index.Admin.html delete mode 100644 docs/modules/index.Auth.html delete mode 100644 docs/modules/index.Modeler.ModelerDto.html delete mode 100644 docs/modules/index.Modeler.html delete mode 100644 docs/modules/index.Operate.OperateDto.html delete mode 100644 docs/modules/index.Operate.html delete mode 100644 docs/modules/index.Optimize.OptimizeDto.html delete mode 100644 docs/modules/index.Optimize.html delete mode 100644 docs/modules/index.Tasklist.TasklistDto.html delete mode 100644 docs/modules/index.Tasklist.html delete mode 100644 docs/modules/index.Zeebe.Types.html delete mode 100644 docs/modules/index.Zeebe.html delete mode 100644 docs/modules/index._internal_.html delete mode 100644 docs/modules/index.html delete mode 100644 docs/modules/zeebe_types._internal_.html delete mode 100644 docs/modules/zeebe_types.html delete mode 100644 docs/types/index.Admin.AdminDto.ClusterStatusstring.html delete mode 100644 docs/types/index.Admin.AdminDto.OrganizationRole.html delete mode 100644 docs/types/index.Optimize.OptimizeDto.DashboardCollection.html delete mode 100644 docs/types/index.Optimize.OptimizeDto.EntityImportResponse.html delete mode 100644 docs/types/index.Optimize.OptimizeDto.ReportCollection.html delete mode 100644 docs/types/index.Optimize.OptimizeDto.SingleProcessReport.html delete mode 100644 docs/types/index.Optimize.OptimizeDto.VariableType.html delete mode 100644 docs/types/index.Tasklist.TasklistDto.TaskState.html delete mode 100644 docs/types/index._internal_.DeepPartial.html delete mode 100644 docs/types/index._internal_.EnhanceWithTenantIdIfMissing.html delete mode 100644 docs/types/index._internal_.EventKey.html delete mode 100644 docs/types/index._internal_.EventMap.html delete mode 100644 docs/types/index._internal_.EventReceiver.html delete mode 100644 docs/types/index._internal_.GrpcConnectionProfile.html delete mode 100644 docs/types/index._internal_.JSON.html delete mode 100644 docs/types/index._internal_.JSONDoc-1.html delete mode 100644 docs/types/index._internal_.LogFn.html delete mode 100644 docs/types/index._internal_.State.html delete mode 100644 docs/types/index._internal_.TokenGrantAudienceType.html delete mode 100644 docs/types/zeebe_types.ConnectionErrorHandler.html delete mode 100644 docs/types/zeebe_types.Deployment.html delete mode 100644 docs/types/zeebe_types.ErrorJobOutcome.html delete mode 100644 docs/types/zeebe_types.EvaluateDecisionRequest.html delete mode 100644 docs/types/zeebe_types.JOB_ACTION_ACKNOWLEDGEMENT.html delete mode 100644 docs/types/zeebe_types.JSON.html delete mode 100644 docs/types/zeebe_types.Loglevel.html delete mode 100644 docs/types/zeebe_types.ModifyProcessInstanceResponse.html delete mode 100644 docs/types/zeebe_types.MustReturnJobActionAcknowledgement.html delete mode 100644 docs/types/zeebe_types.OperationOptions.html delete mode 100644 docs/types/zeebe_types.ZBWorkerTaskHandler.html delete mode 100644 docs/variables/index.Dto.html delete mode 100644 docs/variables/index.Zeebe.Logging.html delete mode 100644 docs/variables/index.Zeebe.Types.JOB_ACTION_ACKNOWLEDGEMENT.html delete mode 100644 docs/variables/index._internal_.ConnectionStatusEvent.html delete mode 100644 docs/variables/zeebe_types.JOB_ACTION_ACKNOWLEDGEMENT-1.html delete mode 100644 lerna.json create mode 100644 release.config.js create mode 100644 smoke-test/package-lock.json create mode 100644 smoke-test/package.json create mode 100644 smoke-test/smoke-test.js create mode 100644 smoke-test/tsconfig.json create mode 100644 test-d/index.test-d.ts diff --git a/.eslintrc.json b/.eslintrc.json index 259d5c5c..adfb9e34 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -27,5 +27,8 @@ ], "import/newline-after-import": "error", "prettier/prettier": "error" + }, + "env": { + "node": true } } diff --git a/.github/workflows/code-scanning.yml b/.github/workflows/code-scanning.yml new file mode 100644 index 00000000..5ca406c1 --- /dev/null +++ b/.github/workflows/code-scanning.yml @@ -0,0 +1,34 @@ +name: "Code Scanning" + +on: + push: + branches: [main, alpha] + pull_request: + branches: [main, alpha] + paths-ignore: + - "**/*.md" + +jobs: + CodeQL-Build: + runs-on: ubuntu-latest + + permissions: + # required for all workflows + security-events: write + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v3 + with: + languages: "typescript, javascript" + config: | + paths-ignore: + - '**/__tests__' + - '**/test' + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v3 diff --git a/.github/workflows/commitlint.yml b/.github/workflows/commitlint.yml index b3797e85..c888d052 100644 --- a/.github/workflows/commitlint.yml +++ b/.github/workflows/commitlint.yml @@ -15,9 +15,6 @@ jobs: with: node-version: "18" # Specify a Node.js version - - name: Remove package-lock.json # This is to work around https://github.com/npm/cli/issues/4828 - run: rm -f package-lock.json - - name: Install dependencies run: npm install @@ -25,10 +22,10 @@ jobs: run: npx commitlint --from=${{ github.event.pull_request.base.sha }} --to=${{ github.event.pull_request.head.sha }} --verbose - name: Run Prettier - run: lerna run prettify + run: npm run format - name: Run ESLint - run: lerna run lint + run: npm run lint - name: Commit and push if changes run: | @@ -40,7 +37,7 @@ jobs: git checkout ${{ github.head_ref }} # Add, commit, and push changes, ignoring package-lock.json - git diff --name-only | grep -v 'package-lock.json' | xargs git add + git diff --name-only | xargs git add git diff --staged --quiet || git commit -m "Apply Prettier formatting" git push origin ${{ github.head_ref }} env: diff --git a/.github/workflows/multitenancy.yml b/.github/workflows/multitenancy.yml deleted file mode 100644 index 346377d3..00000000 --- a/.github/workflows/multitenancy.yml +++ /dev/null @@ -1,57 +0,0 @@ -name: Multitenant Integration Tests - -on: [push] - -jobs: - local_integration: - runs-on: ubuntu-latest - environment: - name: selfhosted - steps: - - name: Check out the repo - uses: actions/checkout@v4 - - - name: Use Node.js - uses: actions/setup-node@v4 - with: - node-version: "18" # Specify a Node.js version - - # This is to force nx arch-specific packages to correctly install - # This is to work around https://github.com/npm/cli/issues/4828 - - name: Remove package-lock.json - run: rm -f package-lock.json - - - name: Install dependencies - run: npm install - - # Workaround for https://github.com/actions/runner-images/issues/2821 - - name: Remove mono blocking 8084 port - run: sudo kill -9 $(sudo lsof -t -i:8084) - - - name: Set up Docker - run: | - docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }} registry.camunda.cloud - - - name: Set up Docker Compose - run: | - docker-compose -f docker/docker-compose-multitenancy.yml -f docker/docker-compose-modeler.yaml up -d - - - name: Run Integration Tests - run: | - npm run test:multitenancy - env: - CAMUNDA_SECURE_CONNECTION: false - ZEEBE_ADDRESS: localhost:26500 - ZEEBE_CLIENT_ID: zeebe - ZEEBE_CLIENT_SECRET: zecret - CAMUNDA_OAUTH_URL: http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token - CAMUNDA_TASKLIST_BASE_URL: http://localhost:8082 - CAMUNDA_OPERATE_BASE_URL: http://localhost:8081 - CAMUNDA_OPTIMIZE_BASE_URL: http://localhost:8083 - CAMUNDA_MODELER_BASE_URL: http://localhost:8070/api - # Needed for Multi-Tenancy - CAMUNDA_TENANT_ID: - - - name: Cleanup - if: always() - run: docker-compose -f docker/docker-compose-multitenancy.yml -f docker/docker-compose-modeler.yaml down diff --git a/.github/workflows/pr-test.yml b/.github/workflows/pr-test.yml new file mode 100644 index 00000000..233f8723 --- /dev/null +++ b/.github/workflows/pr-test.yml @@ -0,0 +1,155 @@ +name: Pull Request tests + +on: [pull_request] + +jobs: + unit-tests: + runs-on: ubuntu-latest + steps: + - name: Check out the repo + uses: actions/checkout@v4 + + - name: Use Node.js + uses: actions/setup-node@v4 + with: + node-version: "18" # Specify a Node.js version + + - name: Install dependencies + run: npm install + + - name: Build and Smoke Test + run: npm run test:smoketest + + - name: Run Unit Tests + run: | + npm run test + + local_integration: + runs-on: ubuntu-latest + environment: + name: selfhosted + steps: + - name: Check out the repo + uses: actions/checkout@v4 + + - name: Use Node.js + uses: actions/setup-node@v4 + with: + node-version: "18" # Specify a Node.js version + + - name: Install dependencies + run: npm install + + # Workaround for https://github.com/actions/runner-images/issues/2821 + - name: Remove mono blocking 8084 port + run: sudo kill -9 $(sudo lsof -t -i:8084) + + - name: Set up Docker + run: | + docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }} registry.camunda.cloud + + - name: Set up Docker Compose + run: | + docker-compose -f docker/docker-compose.yml -f docker/docker-compose-modeler.yaml up -d + + - name: Run Integration Tests + run: | + npm run test:local-integration + env: + CAMUNDA_SECURE_CONNECTION: false + ZEEBE_ADDRESS: localhost:26500 + ZEEBE_CLIENT_ID: zeebe + ZEEBE_CLIENT_SECRET: zecret + CAMUNDA_OAUTH_URL: http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token + CAMUNDA_TASKLIST_BASE_URL: http://localhost:8082 + CAMUNDA_OPERATE_BASE_URL: http://localhost:8081 + CAMUNDA_OPTIMIZE_BASE_URL: http://localhost:8083 + CAMUNDA_MODELER_BASE_URL: http://localhost:8070/api + + - name: Cleanup + if: always() + run: docker-compose -f docker/docker-compose.yml -f docker/docker-compose-modeler.yaml down + + local_multitenancy_integration: + runs-on: ubuntu-latest + environment: + name: selfhosted + steps: + - name: Check out the repo + uses: actions/checkout@v4 + + - name: Use Node.js + uses: actions/setup-node@v4 + with: + node-version: "18" # Specify a Node.js version + + - name: Install dependencies + run: npm install + + # Workaround for https://github.com/actions/runner-images/issues/2821 + - name: Remove mono blocking 8084 port + run: sudo kill -9 $(sudo lsof -t -i:8084) + + - name: Set up Docker + run: | + docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }} registry.camunda.cloud + + - name: Set up Docker Compose + run: | + docker-compose -f docker/docker-compose-multitenancy.yml -f docker/docker-compose-modeler.yaml up -d + + - name: Run Integration Tests + run: | + npm run test:multitenancy + env: + CAMUNDA_SECURE_CONNECTION: false + ZEEBE_ADDRESS: localhost:26500 + ZEEBE_CLIENT_ID: zeebe + ZEEBE_CLIENT_SECRET: zecret + CAMUNDA_OAUTH_URL: http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token + CAMUNDA_TASKLIST_BASE_URL: http://localhost:8082 + CAMUNDA_OPERATE_BASE_URL: http://localhost:8081 + CAMUNDA_OPTIMIZE_BASE_URL: http://localhost:8083 + CAMUNDA_MODELER_BASE_URL: http://localhost:8070/api + # Needed for Multi-Tenancy + CAMUNDA_TENANT_ID: + + - name: Cleanup + if: always() + run: docker-compose -f docker/docker-compose-multitenancy.yml -f docker/docker-compose-modeler.yaml down + + saas_integration: + runs-on: ubuntu-latest + environment: integration + steps: + - name: Check out the repo + uses: actions/checkout@v4 + + - name: Use Node.js + uses: actions/setup-node@v4 + with: + node-version: "18" # Specify a Node.js version + + - name: Install dependencies + run: npm install + + - name: Run Integration Tests + run: | + npm run test:integration + env: + ZEEBE_ADDRESS: ${{ secrets.ZEEBE_ADDRESS }} + ZEEBE_CLIENT_ID: ${{ secrets.ZEEBE_CLIENT_ID }} + ZEEBE_AUTHORIZATION_SERVER_URL: ${{ secrets.ZEEBE_AUTHORIZATION_SERVER_URL }} + ZEEBE_CLIENT_SECRET: ${{ secrets.ZEEBE_CLIENT_SECRET }} + ZEEBE_TOKEN_AUDIENCE: ${{ secrets.ZEEBE_TOKEN_AUDIENCE }} + CAMUNDA_CREDENTIALS_SCOPES: ${{ secrets.CAMUNDA_CREDENTIALS_SCOPES }} + CAMUNDA_OAUTH_URL: ${{ secrets.CAMUNDA_OAUTH_URL }} + CAMUNDA_TASKLIST_BASE_URL: ${{ secrets.CAMUNDA_TASKLIST_BASE_URL }} + CAMUNDA_OPERATE_BASE_URL: ${{ secrets.CAMUNDA_OPERATE_BASE_URL }} + CAMUNDA_OPTIMIZE_BASE_URL: ${{ secrets.CAMUNDA_OPTIMIZE_BASE_URL }} + CAMUNDA_MODELER_BASE_URL: https://modeler.cloud.camunda.io/api + CAMUNDA_CONSOLE_CLIENT_ID: ${{ secrets.CAMUNDA_CONSOLE_CLIENT_ID }} + CAMUNDA_CONSOLE_CLIENT_SECRET: ${{ secrets.CAMUNDA_CONSOLE_CLIENT_SECRET }} + CAMUNDA_CONSOLE_BASE_URL: ${{ secrets.CAMUNDA_CONSOLE_BASE_URL }} + CAMUNDA_CONSOLE_OAUTH_AUDIENCE: ${{ secrets.CAMUNDA_CONSOLE_OAUTH_AUDIENCE}} + CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: 10000 #89: Intermittent 401 unauthorised in integration tests diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 00000000..228d21c5 --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,219 @@ +name: Publish a new version + +on: + push: + branches: + - main + - alpha + +jobs: + unit-tests: + runs-on: ubuntu-latest + steps: + - name: Check out the repo + uses: actions/checkout@v4 + + - name: Use Node.js + uses: actions/setup-node@v4 + with: + node-version: "18" # Specify a Node.js version + + - name: Install dependencies + run: npm i + + - name: Build and Smoke Test + run: npm run test:smoketest + + - name: Run Unit Tests + run: | + npm run test + + local_integration: + runs-on: ubuntu-latest + environment: + name: selfhosted + steps: + - name: Check out the repo + uses: actions/checkout@v4 + + - name: Use Node.js + uses: actions/setup-node@v4 + with: + node-version: "18" # Specify a Node.js version + + - name: Install dependencies + run: npm install + + # Workaround for https://github.com/actions/runner-images/issues/2821 + - name: Remove mono blocking 8084 port + run: sudo kill -9 $(sudo lsof -t -i:8084) + + - name: Set up Docker + run: | + docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }} registry.camunda.cloud + + - name: Set up Docker Compose + run: | + docker-compose -f docker/docker-compose.yml -f docker/docker-compose-modeler.yaml up -d + + - name: Run Integration Tests + run: | + npm run test:local-integration + env: + CAMUNDA_SECURE_CONNECTION: false + ZEEBE_ADDRESS: localhost:26500 + ZEEBE_CLIENT_ID: zeebe + ZEEBE_CLIENT_SECRET: zecret + CAMUNDA_OAUTH_URL: http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token + CAMUNDA_TASKLIST_BASE_URL: http://localhost:8082 + CAMUNDA_OPERATE_BASE_URL: http://localhost:8081 + CAMUNDA_OPTIMIZE_BASE_URL: http://localhost:8083 + CAMUNDA_MODELER_BASE_URL: http://localhost:8070/api + + - name: Cleanup + if: always() + run: docker-compose -f docker/docker-compose.yml -f docker/docker-compose-modeler.yaml down + + local_multitenancy_integration: + runs-on: ubuntu-latest + environment: + name: selfhosted + steps: + - name: Check out the repo + uses: actions/checkout@v4 + + - name: Use Node.js + uses: actions/setup-node@v4 + with: + node-version: "18" # Specify a Node.js version + + - name: Install dependencies + run: npm install + + # Workaround for https://github.com/actions/runner-images/issues/2821 + - name: Remove mono blocking 8084 port + run: sudo kill -9 $(sudo lsof -t -i:8084) + + - name: Set up Docker + run: | + docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }} registry.camunda.cloud + + - name: Set up Docker Compose + run: | + docker-compose -f docker/docker-compose-multitenancy.yml -f docker/docker-compose-modeler.yaml up -d + + - name: Run Integration Tests + run: | + npm run test:multitenancy + env: + CAMUNDA_SECURE_CONNECTION: false + ZEEBE_ADDRESS: localhost:26500 + ZEEBE_CLIENT_ID: zeebe + ZEEBE_CLIENT_SECRET: zecret + CAMUNDA_OAUTH_URL: http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token + CAMUNDA_TASKLIST_BASE_URL: http://localhost:8082 + CAMUNDA_OPERATE_BASE_URL: http://localhost:8081 + CAMUNDA_OPTIMIZE_BASE_URL: http://localhost:8083 + CAMUNDA_MODELER_BASE_URL: http://localhost:8070/api + # Needed for Multi-Tenancy + CAMUNDA_TENANT_ID: + + - name: Cleanup + if: always() + run: docker-compose -f docker/docker-compose-multitenancy.yml -f docker/docker-compose-modeler.yaml down + + saas_integration: + runs-on: ubuntu-latest + environment: integration + steps: + - name: Check out the repo + uses: actions/checkout@v4 + + - name: Use Node.js + uses: actions/setup-node@v4 + with: + node-version: "18" # Specify a Node.js version + + - name: Install dependencies + run: npm install + + - name: Run Integration Tests + run: | + npm run test:integration + env: + ZEEBE_ADDRESS: ${{ secrets.ZEEBE_ADDRESS }} + ZEEBE_CLIENT_ID: ${{ secrets.ZEEBE_CLIENT_ID }} + ZEEBE_AUTHORIZATION_SERVER_URL: ${{ secrets.ZEEBE_AUTHORIZATION_SERVER_URL }} + ZEEBE_CLIENT_SECRET: ${{ secrets.ZEEBE_CLIENT_SECRET }} + ZEEBE_TOKEN_AUDIENCE: ${{ secrets.ZEEBE_TOKEN_AUDIENCE }} + CAMUNDA_CREDENTIALS_SCOPES: ${{ secrets.CAMUNDA_CREDENTIALS_SCOPES }} + CAMUNDA_OAUTH_URL: ${{ secrets.CAMUNDA_OAUTH_URL }} + CAMUNDA_TASKLIST_BASE_URL: ${{ secrets.CAMUNDA_TASKLIST_BASE_URL }} + CAMUNDA_OPERATE_BASE_URL: ${{ secrets.CAMUNDA_OPERATE_BASE_URL }} + CAMUNDA_OPTIMIZE_BASE_URL: ${{ secrets.CAMUNDA_OPTIMIZE_BASE_URL }} + CAMUNDA_MODELER_BASE_URL: https://modeler.cloud.camunda.io/api + CAMUNDA_CONSOLE_CLIENT_ID: ${{ secrets.CAMUNDA_CONSOLE_CLIENT_ID }} + CAMUNDA_CONSOLE_CLIENT_SECRET: ${{ secrets.CAMUNDA_CONSOLE_CLIENT_SECRET }} + CAMUNDA_CONSOLE_BASE_URL: ${{ secrets.CAMUNDA_CONSOLE_BASE_URL }} + CAMUNDA_CONSOLE_OAUTH_AUDIENCE: ${{ secrets.CAMUNDA_CONSOLE_OAUTH_AUDIENCE}} + CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: 10000 #89: Intermittent 401 unauthorised in integration tests + + tag-and-publish: + needs: + [ + saas_integration, + local_multitenancy_integration, + local_integration, + unit-tests, + ] + runs-on: ubuntu-latest + environment: + name: publish + steps: + - name: Checkout repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Setup Node + uses: actions/setup-node@v4 + with: + node-version: "18" + cache: "npm" + - name: Install + run: npm i + - name: Build + run: npm run build + - name: Build Docs + run: npm run docs + - name: Semantic Release + run: npx semantic-release + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + NPM_TOKEN: ${{ secrets.NPM_TOKEN }} + HUSKY: 0 + + - name: Checkout alpha branch + if: github.ref == 'refs/heads/main' + uses: actions/checkout@v2 + with: + ref: alpha + + - name: Merge main into alpha + if: github.ref == 'refs/heads/main' + run: | + git fetch origin main + git merge origin/main + + - name: Push changes + if: github.ref == 'refs/heads/main' + uses: ad-m/github-push-action@master + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + branch: alpha + + - name: Deploy Docs + if: github.ref == 'refs/heads/main' + uses: JamesIves/github-pages-deploy-action@v4 + with: + folder: docs + branch: gh-pages diff --git a/.github/workflows/saas.yml b/.github/workflows/saas.yml deleted file mode 100644 index 4fb9e562..00000000 --- a/.github/workflows/saas.yml +++ /dev/null @@ -1,40 +0,0 @@ -name: SaaS Integration Tests - -on: [push] - -jobs: - integration: - runs-on: ubuntu-latest - environment: integration - steps: - - name: Check out the repo - uses: actions/checkout@v4 - - - name: Use Node.js - uses: actions/setup-node@v4 - with: - node-version: "18" # Specify a Node.js version - - - name: Install dependencies - run: npm install - - - name: Run Integration Tests - run: | - npm run test:integration - env: - ZEEBE_ADDRESS: ${{ secrets.ZEEBE_ADDRESS }} - ZEEBE_CLIENT_ID: ${{ secrets.ZEEBE_CLIENT_ID }} - ZEEBE_AUTHORIZATION_SERVER_URL: ${{ secrets.ZEEBE_AUTHORIZATION_SERVER_URL }} - ZEEBE_CLIENT_SECRET: ${{ secrets.ZEEBE_CLIENT_SECRET }} - ZEEBE_TOKEN_AUDIENCE: ${{ secrets.ZEEBE_TOKEN_AUDIENCE }} - CAMUNDA_CREDENTIALS_SCOPES: ${{ secrets.CAMUNDA_CREDENTIALS_SCOPES }} - CAMUNDA_OAUTH_URL: ${{ secrets.CAMUNDA_OAUTH_URL }} - CAMUNDA_TASKLIST_BASE_URL: ${{ secrets.CAMUNDA_TASKLIST_BASE_URL }} - CAMUNDA_OPERATE_BASE_URL: ${{ secrets.CAMUNDA_OPERATE_BASE_URL }} - CAMUNDA_OPTIMIZE_BASE_URL: ${{ secrets.CAMUNDA_OPTIMIZE_BASE_URL }} - CAMUNDA_MODELER_BASE_URL: https://modeler.cloud.camunda.io/api - CAMUNDA_CONSOLE_CLIENT_ID: ${{ secrets.CAMUNDA_CONSOLE_CLIENT_ID }} - CAMUNDA_CONSOLE_CLIENT_SECRET: ${{ secrets.CAMUNDA_CONSOLE_CLIENT_SECRET }} - CAMUNDA_CONSOLE_BASE_URL: ${{ secrets.CAMUNDA_CONSOLE_BASE_URL }} - CAMUNDA_CONSOLE_OAUTH_AUDIENCE: ${{ secrets.CAMUNDA_CONSOLE_OAUTH_AUDIENCE}} - CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: 10000 #89: Intermittent 401 unauthorised in integration tests diff --git a/.github/workflows/singletenant.yml b/.github/workflows/singletenant.yml deleted file mode 100644 index db4cd863..00000000 --- a/.github/workflows/singletenant.yml +++ /dev/null @@ -1,55 +0,0 @@ -name: Single Tenant Integration Tests - -on: [push] - -jobs: - local_integration: - runs-on: ubuntu-latest - environment: - name: selfhosted - steps: - - name: Check out the repo - uses: actions/checkout@v3 - - - name: Use Node.js - uses: actions/setup-node@v3 - with: - node-version: "18" # Specify a Node.js version - - # This is to force nx arch-specific packages to correctly install - # This is to work around https://github.com/npm/cli/issues/4828 - - name: Remove package-lock.json - run: rm -f package-lock.json - - - name: Install dependencies - run: npm install - - # Workaround for https://github.com/actions/runner-images/issues/2821 - - name: Remove mono blocking 8084 port - run: sudo kill -9 $(sudo lsof -t -i:8084) - - - name: Set up Docker - run: | - docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }} registry.camunda.cloud - - - name: Set up Docker Compose - run: | - docker-compose -f docker/docker-compose.yml -f docker/docker-compose-modeler.yaml up -d - - - name: Run Integration Tests - run: | - npm run test:local-integration - env: - CAMUNDA_SECURE_CONNECTION: false - ZEEBE_ADDRESS: localhost:26500 - ZEEBE_CLIENT_ID: zeebe - ZEEBE_CLIENT_SECRET: zecret - CAMUNDA_OAUTH_URL: http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token - CAMUNDA_TASKLIST_BASE_URL: http://localhost:8082 - CAMUNDA_OPERATE_BASE_URL: http://localhost:8081 - CAMUNDA_OPTIMIZE_BASE_URL: http://localhost:8083 - CAMUNDA_MODELER_BASE_URL: http://localhost:8070/api - - - name: Cleanup - if: always() - run: docker-compose -f docker/docker-compose.yml -f docker/docker-compose-modeler.yaml down diff --git a/.github/workflows/tag-and-publish.yml b/.github/workflows/tag-and-publish.yml deleted file mode 100644 index 2d7843b8..00000000 --- a/.github/workflows/tag-and-publish.yml +++ /dev/null @@ -1,76 +0,0 @@ -name: Tag and publish a new version - -on: - workflow_dispatch: - inputs: - version: - description: "Version" - required: true - -jobs: - tag-and-publish: - runs-on: ubuntu-latest - environment: - name: publish - services: - elasticsearch: - image: docker.elastic.co/elasticsearch/elasticsearch:7.17.5 - env: - discovery.type: single-node - cluster.name: docker-cluster - bootstrap.memory_lock: true - xpack.security.enabled: false - ES_JAVA_OPTS: -Xms1024m -Xmx1024m - ports: - - 9200:9200 - - 9300:9300 - zeebe: - image: camunda/zeebe:8.4.5 - env: - JAVA_TOOL_OPTIONS: "-Xms512m -Xmx512m" - ZEEBE_BROKER_EXPORTERS_ELASTICSEARCH_CLASSNAME: io.camunda.zeebe.exporter.ElasticsearchExporter - ZEEBE_BROKER_EXPORTERS_ELASTICSEARCH_ARGS_URL: http://elasticsearch:9200 - ZEEBE_BROKER_EXPORTERS_ELASTICSEARCH_ARGS_BULK_SIZE: 1 - ZEEBE_BROKER_BACKPRESSURE_ENABLED: false - ports: - - 26500:26500 - steps: - - name: Checkout repository - uses: actions/checkout@v3 - with: - fetch-depth: 0 - - name: Setup Node - uses: actions/setup-node@v3 - with: - node-version: 16.17.0 - cache: "npm" - - name: Install - run: npm ci --ignore-scripts - - name: Run integration tests - run: npm run test:integration - - name: Run tests - run: npm run test - - name: Run local integration tests - run: npm run test:local - - name: Build - run: npm run build - - name: Set version - run: | - git config user.name 'github-actions[bot]' - git config user.email 'github-actions[bot]@users.noreply.github.com' - npm version ${{ inputs.version }} -m "Publish v%s" - - name: Publish to NPM - env: - NPM_TOKEN: ${{ secrets.NPM_TOKEN }} - run: npm publish --access=public - - name: Push changes - run: git push --follow-tags - - - name: Build Docs - run: npm run docs - - - name: Deploy Docs - uses: JamesIves/github-pages-deploy-action@v4 - with: - folder: docs - branch: gh-pages diff --git a/.github/workflows/unit.yml b/.github/workflows/unit.yml new file mode 100644 index 00000000..47e3e312 --- /dev/null +++ b/.github/workflows/unit.yml @@ -0,0 +1,25 @@ +name: Unit Tests + +on: [push] + +jobs: + unit-tests: + runs-on: ubuntu-latest + steps: + - name: Check out the repo + uses: actions/checkout@v4 + + - name: Use Node.js + uses: actions/setup-node@v4 + with: + node-version: "18" # Specify a Node.js version + + - name: Install dependencies + run: npm install + + - name: Build + run: npm run build + + - name: Run Unit Tests + run: | + npm run test diff --git a/.gitignore b/.gitignore index 2d6f11a4..773d97df 100644 --- a/.gitignore +++ b/.gitignore @@ -133,3 +133,5 @@ dist *.env !docker/.env + +docs \ No newline at end of file diff --git a/.npmignore b/.npmignore index 1784c8c8..e33b1c04 100644 --- a/.npmignore +++ b/.npmignore @@ -7,3 +7,16 @@ src .vscode .husky docs +coverage +zeebe-extra +commitlint.config.js +.editorconfig +.eslintrc.js +.prettier* +prettier* +ts-jest.log +.eslintignore +.releaserc +typedoc.json +lerna.json +docker* \ No newline at end of file diff --git a/.releaserc b/.releaserc deleted file mode 100644 index b447a09a..00000000 --- a/.releaserc +++ /dev/null @@ -1,16 +0,0 @@ -{ - "branches": ["main"], - "repositoryUrl": "https://github.com/camunda-community-hub/camunda-8-js-sdk.git", - "plugins": [ - "@semantic-release/commit-analyzer", - "@semantic-release/release-notes-generator", - "@semantic-release/changelog", - "@semantic-release/npm", - { - "path": "semantic-release-lerna", - "generateNotes": false - }, - "@semantic-release/github", - "@semantic-release/git" - ] -} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json index 8e962fe3..dc96b7fb 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -6,7 +6,8 @@ "zeebe", "github", "modeler", - "operate" + "operate", + "camunda8" ], "editor.formatOnSave": true, diff --git a/CHANGELOG.md b/CHANGELOG.md index a7282bda..32632eaa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,53 @@ +# [8.5.0-alpha.6](https://github.com/camunda/camunda-8-js-sdk/compare/v8.5.0-alpha.5...v8.5.0-alpha.6) (2024-04-08) + + +### Bug Fixes + +* **issue118:** add smoke test and type surface tests ([fe0c709](https://github.com/camunda/camunda-8-js-sdk/commit/fe0c70925cf3df610b049e776eed5bffe56ef604)), closes [#118](https://github.com/camunda/camunda-8-js-sdk/issues/118) + +# [8.5.0-alpha.5](https://github.com/camunda/camunda-8-js-sdk/compare/v8.5.0-alpha.4...v8.5.0-alpha.5) (2024-04-07) + + +### Bug Fixes + +* **repo:** make fix type commits release a new package ([ded83cf](https://github.com/camunda/camunda-8-js-sdk/commit/ded83cfaf437a2f62a5ef134d7616538facda614)) + +# [8.5.0-alpha.4](https://github.com/camunda/camunda-8-js-sdk/compare/v8.5.0-alpha.3...v8.5.0-alpha.4) (2024-04-05) + + +### Bug Fixes + +* **repo:** use ts-patch to transform module mapping in output ([#112](https://github.com/camunda/camunda-8-js-sdk/issues/112)) ([7efdcf3](https://github.com/camunda/camunda-8-js-sdk/commit/7efdcf3478a0d68b4f1cbc62c1526ba7275008b0)), closes [#110](https://github.com/camunda/camunda-8-js-sdk/issues/110) + +# [8.5.0-alpha.3](https://github.com/camunda/camunda-8-js-sdk/compare/v8.5.0-alpha.2...v8.5.0-alpha.3) (2024-04-05) + + +### Bug Fixes + +* **repo:** only git commit on npm publish success ([9012764](https://github.com/camunda/camunda-8-js-sdk/commit/901276451845c5dbd926af0a6563d5564d3e87b9)) + +# [8.5.0-alpha.2](https://github.com/camunda/camunda-8-js-sdk/compare/v8.5.0-alpha.1...v8.5.0-alpha.2) (2024-04-05) + + +### Bug Fixes + +* **repo:** add note on "supported" ([#107](https://github.com/camunda/camunda-8-js-sdk/issues/107)) ([fc45d61](https://github.com/camunda/camunda-8-js-sdk/commit/fc45d618bc459a06fbf76bd6907511d08e1f583b)), closes [#70](https://github.com/camunda/camunda-8-js-sdk/issues/70) + +# [8.5.0-alpha.1](https://github.com/camunda/camunda-8-js-sdk/compare/v8.4.0...v8.5.0-alpha.1) (2024-04-04) + + +### Features + +* **oauth:** support optional scope in OAuth request ([#25](https://github.com/camunda/camunda-8-js-sdk/issues/25)) ([0451b80](https://github.com/camunda/camunda-8-js-sdk/commit/0451b802594f76518830b9bdff515d67fc0231b9)) +* **operate:** add multitenant support and lossless Json parsing ([#82](https://github.com/camunda/camunda-8-js-sdk/issues/82)) ([cf49a71](https://github.com/camunda/camunda-8-js-sdk/commit/cf49a717e2632af845529b3c1fde85ee1b0b347b)), closes [#78](https://github.com/camunda/camunda-8-js-sdk/issues/78) [#67](https://github.com/camunda/camunda-8-js-sdk/issues/67) +* **repo:** add enhanced debug output for http errors ([#88](https://github.com/camunda/camunda-8-js-sdk/issues/88)) ([881b039](https://github.com/camunda/camunda-8-js-sdk/commit/881b03965cc37431885a76291f7c0aa762f26227)), closes [#87](https://github.com/camunda/camunda-8-js-sdk/issues/87) +* **tasklist:** add multitenant support to tasklist ([#85](https://github.com/camunda/camunda-8-js-sdk/issues/85)) ([46bb564](https://github.com/camunda/camunda-8-js-sdk/commit/46bb564365afc3bc6758cd436490a459708128e6)) +* **zeebe:** add MigrateProcessInstance ([#97](https://github.com/camunda/camunda-8-js-sdk/issues/97)) ([2a9a123](https://github.com/camunda/camunda-8-js-sdk/commit/2a9a1232b160962f86b9450edd9047a8a933068a)), closes [#49](https://github.com/camunda/camunda-8-js-sdk/issues/49) +* **zeebe:** implement deleteResource ([#73](https://github.com/camunda/camunda-8-js-sdk/issues/73)) ([0cd08b7](https://github.com/camunda/camunda-8-js-sdk/commit/0cd08b7b85d23ab44e42b36b2d9b48c1cfcb8c63)) +* **zeebe:** implement lossless parsing of job payload ([#95](https://github.com/camunda/camunda-8-js-sdk/issues/95)) ([57f3ea8](https://github.com/camunda/camunda-8-js-sdk/commit/57f3ea85d4cf86256301f5f2a9bcead09c01a199)), closes [#81](https://github.com/camunda/camunda-8-js-sdk/issues/81) +* **zeebe:** normalise useragent, thread config ([#94](https://github.com/camunda/camunda-8-js-sdk/issues/94)) ([c1c4211](https://github.com/camunda/camunda-8-js-sdk/commit/c1c4211db11173c56d2410f489503ef9acf185f2)) +* **zeebe:** remove deployProcess method ([#71](https://github.com/camunda/camunda-8-js-sdk/issues/71)) ([6cb98f0](https://github.com/camunda/camunda-8-js-sdk/commit/6cb98f0ff3baf643015bacfa690f4f119caf6083)) + # Change Log All notable changes to this project will be documented in this file. @@ -7,9 +57,9 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline ### Bug Fixes -- REST getForm returns a flattened shape of the form compared to GraphQL ([58ec6d1](https://github.com/camunda-community-hub/camunda-8-js-sdk/commit/58ec6d1de08e39cb4699326b67ebbf6a398fb30f)) +- REST getForm returns a flattened shape of the form compared to GraphQL ([58ec6d1](https://github.com/camunda/camunda-8-js-sdk/commit/58ec6d1de08e39cb4699326b67ebbf6a398fb30f)) ### Features -- configure specs to import configuration from .env file ([00804d1](https://github.com/camunda-community-hub/camunda-8-js-sdk/commit/00804d132c0e1840846a5af9eee26351f9580c74)) -- **tasklist:** enable multiple clusters via constructor options ([#16](https://github.com/camunda-community-hub/camunda-8-js-sdk/issues/16)) ([fb12e25](https://github.com/camunda-community-hub/camunda-8-js-sdk/commit/fb12e258321e6bba03d11d38119c740f0e242773)) +- configure specs to import configuration from .env file ([00804d1](https://github.com/camunda/camunda-8-js-sdk/commit/00804d132c0e1840846a5af9eee26351f9580c74)) +- **tasklist:** enable multiple clusters via constructor options ([#16](https://github.com/camunda/camunda-8-js-sdk/issues/16)) ([fb12e25](https://github.com/camunda/camunda-8-js-sdk/commit/fb12e258321e6bba03d11d38119c740f0e242773)) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 87c99382..3a8766ae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,22 +7,31 @@ Thank you for considering contributing to @camunda8/sdk! We welcome contribution To get started with contributing, please follow these steps: 1. Fork the repository and clone it to your local machine. -2. Install the dependencies by running `npm install`. -3. Make your changes or additions to the codebase. -4. Write tests to cover your changes and ensure existing tests pass. -5. Run the tests using `npm test` to make sure everything is working correctly. -6. Commit your changes and push them to your forked repository. -7. Submit a pull request to the main repository. +2. Check out the `alpha` branch. This is the development branch. +3. Install the dependencies by running `npm install`. +4. Make your changes or additions to the codebase. +5. Write tests to cover your changes and ensure existing tests pass. +6. Run the tests using `npm test` to make sure everything is working correctly. See below for details on running integration tests. +7. Commit your changes and push them to your forked repository. Use [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) format for the commit message. See the note below. +8. Submit a pull request to the main repository. +9. When your PR is merged into the `alpha` branch, an alpha package is published to NPM. +10. When the `alpha` branch is merged into `main`, a new package is published to NPM. + +## A note on commit messages + +The repository uses []`semantic-release`](https://github.com/semantic-release/semantic-release) to create releases. Because we track the Camunda 8 Platform minor version, we treat feature implementation during a minor release cycle as a patch release rather than a minor release. + +Creating a commit with a `feat` commit message will cause the package version patch release number to increment. To update the minor version, a commit with the type `minor` is needed. ## Running tests -Run all the unit tests with `lerna run test`. +Run all the unit tests with `npm run test`. ### Integration tests Integration tests can be run against Self-Managed or against Camunda SaaS. -To run integration tests against Camunda SaaS, but credentials for a Camunda SaaS API Client with scopes for all components in the environment, then run the integration tests against Camunda SaaS with `lerna run test:integration`. +To run integration tests against Camunda SaaS, but credentials for a Camunda SaaS API Client with scopes for all components in the environment, then run the integration tests against Camunda SaaS with `npm run test:integration`. To run the integration tests against Self-Managed, you can use either your own Self-Managed instance, or start one locally using Docker. @@ -79,6 +88,8 @@ export CAMUNDA_TEST_TYPE='local' export CAMUNDA_TENANT_ID='' ``` +Now run the integration tests against Self-Managed with `npm run test:multitenancy`. + ## Code Style We follow a specific code style in our project to maintain consistency. Please make sure to adhere to the following guidelines: @@ -88,11 +99,11 @@ We follow a specific code style in our project to maintain consistency. Please m ## Issue Reporting -If you encounter any bugs or issues while using @camunda/sdk, please report them in the [issue tracker](https://github.com/camunda-community-hub/camunda-8-js-sdk/issues). Provide as much detail as possible, including steps to reproduce the issue. +If you encounter any bugs or issues while using @camunda/sdk, please report them in the [issue tracker](https://github.com/camunda/camunda-8-js-sdk/issues). Provide as much detail as possible, including steps to reproduce the issue. ## Feature Requests -If you have any ideas or feature requests for @camunda/sdk, please submit them in the [issue tracker](https://github.com/camunda-community-hub/camunda-8-js-sdk/issues). We appreciate your feedback and suggestions. +If you have any ideas or feature requests for @camunda/sdk, please submit them in the [issue tracker](https://github.com/camunda/camunda-8-js-sdk/issues). We appreciate your feedback and suggestions. ## License @@ -100,6 +111,6 @@ By contributing to @camunda/sdk, you agree that your contributions will be licen ## Contact -If you have any questions or need further assistance, feel free to reach out to us at [your-email@example.com]. +If you have any questions or need further assistance, open an issue in the repository. Happy contributing! diff --git a/README.md b/README.md index 1b7f8faa..15b013a5 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,21 @@ [![NPM](https://nodei.co/npm/@camunda8/sdk.png)](https://www.npmjs.com/package/@camunda8/sdk) -This is the official Camunda 8 JavaScript SDK. It is written in TypeScript and runs on Node.js. See details on why [this is not in a web browser](https://github.com/camunda-community-hub/camunda-8-js-sdk/issues/79)). +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) + +This is the official Camunda 8 JavaScript SDK. It is written in TypeScript and runs on Node.js. See why [this does not run in a web browser](https://github.com/camunda/camunda-8-js-sdk/issues/79). + +## What does "supported" mean? + +This is the official supported-by-Camunda Nodejs SDK for Camunda Platform 8. + +The Node.js SDK will not always support all features of Camunda Platform 8 immediately upon their release. Complete API coverage for a platform release will lag behind the platform release. + +Prioritisation of implementing features is influenced by customer demand. + +## Semantic versioning + +The SDK package tracks Camunda Platform 8 minor versioning. Feature releases to support current Platform minor version features result in a patch release of the SDK. ## Using the SDK in your project @@ -38,7 +52,7 @@ The configuration object fields and the environment variables have exactly the s ## A note on how int64 is handled in the JavaScript SDK -Entity keys in Camunda 8 are stored and represented as `int64` numbers. The range of `int64` extends to numbers that cannot be represented by the JavaScript `number` type. To deal with this, `int64` keys are serialised by the SDK to the JavaScript `string` type. See [this issue](https://github.com/camunda-community-hub/camunda-8-js-sdk/issues/78) for more details. +Entity keys in Camunda 8 are stored and represented as `int64` numbers. The range of `int64` extends to numbers that cannot be represented by the JavaScript `number` type. To deal with this, `int64` keys are serialised by the SDK to the JavaScript `string` type. See [this issue](https://github.com/camunda/camunda-8-js-sdk/issues/78) for more details. 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`. @@ -184,7 +198,7 @@ The SDK uses the [`debug`](https://github.com/debug-js/debug) library. To enable | Value | Component | | ---------------------- | -------------------- | -| `camunda:adminconsole` | Administration API | +| `camunda:adminconsole` | Administration API | | `camunda:modeler` | Modeler API | | `camunda:operate` | Operate API | | `camunda:optimize` | Optimize API | diff --git a/commitlint.config.js b/commitlint.config.js index 5a9bf016..678ea2b1 100644 --- a/commitlint.config.js +++ b/commitlint.config.js @@ -1,3 +1,25 @@ +// eslint-disable-next-line no-undef module.exports = { - extends: ['@commitlint/config-conventional'], - }; \ No newline at end of file + extends: ['@commitlint/config-conventional'], + rules: { + 'type-enum': [ + 2, + 'always', + [ + 'build', + 'chore', + 'ci', + 'docs', + 'feat', + 'fix', + 'perf', + 'refactor', + 'revert', + 'style', + 'test', + 'release', // force a new patch release regardless of the commit message + 'minor', // create a new minor release to match the Camunda Platform version + ], + ], + }, +} diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e2ac6616..00000000 --- a/docs/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css deleted file mode 100644 index be186b16..00000000 --- a/docs/assets/highlight.css +++ /dev/null @@ -1,99 +0,0 @@ -:root { - --light-hl-0: #795E26; - --dark-hl-0: #DCDCAA; - --light-hl-1: #000000; - --dark-hl-1: #D4D4D4; - --light-hl-2: #A31515; - --dark-hl-2: #CE9178; - --light-hl-3: #AF00DB; - --dark-hl-3: #C586C0; - --light-hl-4: #001080; - --dark-hl-4: #9CDCFE; - --light-hl-5: #0000FF; - --dark-hl-5: #569CD6; - --light-hl-6: #0070C1; - --dark-hl-6: #4FC1FF; - --light-hl-7: #008000; - --dark-hl-7: #6A9955; - --light-hl-8: #267F99; - --dark-hl-8: #4EC9B0; - --light-hl-9: #098658; - --dark-hl-9: #B5CEA8; - --light-hl-10: #000000FF; - --dark-hl-10: #D4D4D4; - --light-code-background: #FFFFFF; - --dark-code-background: #1E1E1E; -} - -@media (prefers-color-scheme: light) { :root { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --code-background: var(--light-code-background); -} } - -@media (prefers-color-scheme: dark) { :root { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --code-background: var(--dark-code-background); -} } - -:root[data-theme='light'] { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --code-background: var(--light-code-background); -} - -:root[data-theme='dark'] { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --code-background: var(--dark-code-background); -} - -.hl-0 { color: var(--hl-0); } -.hl-1 { color: var(--hl-1); } -.hl-2 { color: var(--hl-2); } -.hl-3 { color: var(--hl-3); } -.hl-4 { color: var(--hl-4); } -.hl-5 { color: var(--hl-5); } -.hl-6 { color: var(--hl-6); } -.hl-7 { color: var(--hl-7); } -.hl-8 { color: var(--hl-8); } -.hl-9 { color: var(--hl-9); } -.hl-10 { color: var(--hl-10); } -pre, code { background: var(--code-background); } diff --git a/docs/assets/icons.js b/docs/assets/icons.js deleted file mode 100644 index b79c9e89..00000000 --- a/docs/assets/icons.js +++ /dev/null @@ -1,15 +0,0 @@ -(function(svg) { - svg.innerHTML = ``; - svg.style.display = 'none'; - if (location.protocol === 'file:') { - if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', updateUseElements); - else updateUseElements() - function updateUseElements() { - document.querySelectorAll('use').forEach(el => { - if (el.getAttribute('href').includes('#icon-')) { - el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); - } - }); - } - } -})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg deleted file mode 100644 index 7dead611..00000000 --- a/docs/assets/icons.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js deleted file mode 100644 index 7352c367..00000000 --- a/docs/assets/main.js +++ /dev/null @@ -1,59 +0,0 @@ -"use strict"; -"use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||this.scrollToHash()}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.updateIndexHeadingVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.updateIndexHeadingVisibility()}updateIndexHeadingVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); -/*! Bundled license information: - -lunr/lunr.js: - (** - * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 - * Copyright (C) 2020 Oliver Nightingale - * @license MIT - *) - (*! - * lunr.utils - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Set - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.tokenizer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Pipeline - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Vector - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.stemmer - * Copyright (C) 2020 Oliver Nightingale - * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt - *) - (*! - * lunr.stopWordFilter - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.trimmer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.TokenSet - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Index - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Builder - * Copyright (C) 2020 Oliver Nightingale - *) -*/ diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js deleted file mode 100644 index 8a6c9abe..00000000 --- a/docs/assets/navigation.js +++ /dev/null @@ -1 +0,0 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE61cbZPcJhL+L3tffUnsOHeJ6+qq9s32ODs7vt2NXeVUysVIzAy3kpggtPb6Kv/9AEkjhKBptPPJL+rneRA0dAOt+f1/J5J+lSevTliV068nz072RO7UP0ueNwWtvzf//d1OloV6dq/+dfLqxbOTbMeKXNDq5NXvB4J/sUpSUZHi3yGWz73FZxThFa9rBa4vJB8Ys4LUtY/Rsh6zP3/x81/PDqS3kki6aYorvl1obEb3kgsEvx8ISd097ml+WTKprBECtjlE++lMNWGLouxNYbqPXNxTcUZqiqIczCHa8x0RJFMoVkuW1QOzodqQzEfugBwv+ekfFv+kXyFeb6+O+RZVVjQ5/UAEI+uC4ngdEMT/7nZ1fcEzHG9nDPG5PgDR+ZxgzHZH6vuVyNWwPuIoLQDE23vLOa9qKZpMzRj11w3b4lSCcEjzgtL9eyIkI8WgItXk8ghYtg7lD7/88/lPL2yHq3akyuhHJnd3tCKVXOSLzZLVNau2UR0IHBV+oJX8lT7GRTpDFOGS7HGEyhBFeEMzyh5sl4RYe+sY9Ruxz9SQVzSTjFfvBd8we3IGJLyomJSedFFmbYQhGk11gEvZ/f15jFDN39dVlM5YxahMFItSGasY1R2/p9UboZz5tMkZVe6tI1iU2w+LiQ2jqdvW1MaJBq2HbgX2xRQfciz344u//rC0TvOSWd09zmHMwzH8pT99MZaj3MXH1FuhKM+LpoaDnkPaAaDlsjM5L9ioR5HMLQzNPwzGBZWEFVBeAAlOeMAWCKrcucOf8RwKca6oC43r5HM71IOG1Ja0XKe4QmsPMapASEqqWBJGZcAgfKCdgCqSB0Omf8xtXGyhWIktqdg3on3jhodihaPjgvwikzXidM/cUR7nzZbMwXaaNI94G0UTWjDUM9Qycd0UhTZWge+B5eGdgiF0jaGkfoVmXWEpFwHOqeNp2gXA62S0OszE6IxRlOVSCB5t2WA55bMHeMlzWtgvOh7j7jFqmDtbIMT0bIMlLsy0qx4vCrLmgqise6Qx6QCPjJcivni+VnnaTK0OitDgRU7nvtEBHNdZqgbVkldzX8jGQ2qz+gzRW9pkqaJrTiSZxW+BQR3TpSqiS7U6pgs56LjSTAkU9/z+cuHwWcWGJyt0IDClmO2xWF892M3uKB8DnNTI3WVByzm+NcaCKoL/V+WjT1oy/RwoVeP8M9UMFqEy931w7zDbH6Z4UK1Z31Iisp2ye9L6BhBh9Z8+F2Js2JYcxXujfImtOUqvzPSOG1o3hTyaj4To0tpyRH8BOdNadVTfibDOatkReyvNm265SF80OxDE+9s+n5spj6AIjXn5kgMGdeo5/HWA17PPim7RHX7kNn21p2J0kDred3WPUZutzhbYxfVsgyVuF7cj1Za2Zyeht/dQ2zBo435BM1abA7gNq5g+OUkQmYIxUouqlvoaZYZQD02RWVT7Jug3CC2DTxFcNfJpii0BRvKG/tkwYVLbFOfwwSG51wX/UqmZNWPkXCh4iFRlLAcmuYe+h0C0ar3PdEXBHA+fYBFCM3rJQSaI6Bnu3s2nyg0ckPD0Tj2q479RH9P+p6ECOsr30BoIGLOtgA+dgnu4R1A4NnWoaGxyVNCxSbKSfQOCU/scGZ1aYzA8dXyWLfI2ize5uY778Bzsaw+/jYVvHga7UykFWzeSwiMbURtYsLqaiVekOI7+lA0shiD1bs2JyH2LGE7cQwEp3tC9zmFVfpwqNCBx/Jdf9d/AS4OITs+A03tPtlBdUERLoyEdROWRVwFTfNTbXJE1LeYKGDBaJdnHx2iUT+vtYXsLPIjZt3ywOw/oeOmPZPJxUeqhVAv8nld14F7Rq+iDxyRbv5n1gi40WhLCqm1Bu8jeghPUPOiYYD/S4XIR0EHC5SK+KIgIso4WMszqCrhCJT+hsNg/R4XC3hgIswc+yxbF/ZqLMvTyXlINAOtale10GiCIbWBM4JBOzZMZw8EdUXsiAscRr86ABFcrQTaybU7vwR9I0UDrvF8twBMr6zx77M2hJTnYkRY8ptQ27nSjqFfi8s+GFHqbSGvoZiIygB6yhFYcRz5J94xuuKDHen0fW0o7jtSAJOXOeFxOnqprkcSOD1NFNOaJeZiXNyUPc06W0gQ8x0p+ldASmiYHraQYXV3zzBtplq/jtMFmjPpkuN417ILh6ldfAhDNMCZCyAzjE6Xr4C7ePMTlFvqdYRpjgiIzxfI6qzwT/J6Kt5QUdsEarZrSR+2FjQVHR1Vj83EdH1JjWsdnK7xbnX0+Pb9brK7VH79erz5eXV68uVxeXt8NQm5RsS0WxoOlxWf7slLtrMPVc63IYAelLv3nETBXbwUyaUtTNQ96ckc4NoZ49Zcno2JPf592ZmDXnZOyqXLyc6ht/XMw17PTa7cpk3zaacA33dTvpX82mYef5XQeBb5ti8yjEO3fQrhu0j7/5eWPP7zEziSsSocKaUAf/tnUiZ//Qe4YoMU5ZVte5xxl66DSHt72YSaYwQTEE2jBk8Omlry8vb1K0u5BEPPQO+cyUNAa7dfzyTePIY3Lr5KqeZW355X+vUdUziGBj+7lYacSy0EDugEK+DD/NJPsQQ38ovtELXTCamt6MNCr9ebv+LqGUnqfhIXBSwAZY1gjniD29rkCoMm1MUSqliiSZ6SWt2xbmV1SlHoKSRNADYAfliQUnzRTSJoAbpwDuIiUChy65hTD3pmCy2Ib3s1NCPAJqU08hYACvNwX1DgzdoinkHhVeBcf9LqClgkA0WJ9MJot6iFIFsdMzBBwjtj8t5z/hsj5BKKTZe0UY2YXjyie1oD53T6heVJDnjIUU54jNGVVfWTiaA1q2cBz50OJ1b7gj2WoQNzWnkIwAn05JJq+B2DI7UKjGW/ih6cKJ7+hDwyL6jCixpY3Ar94eVGwjO6BdBkPKkUGORX9MEjIfG6ngq+eHvAlh63jRYEyD6RodJXPYXSRbxQCYsTyHoRWOSCS6MNH0aBG9BB6gnCLG7FKvppG59MrwoqErG1sDhJzUSYsOmPzGDF6UbGNIdJFewjwlpI89Am3TTs2B4nNYOMnmGMPUrejm8DtAEDyLoomsLsIiB76RR+bFPFjPpj9cGQbrB532xEzOzsKDKsHFhHSM6gRtN1TNYKgzjwCOEjqitXyUFmCXHM9GEhiSWS2GxabmyZw8WdLeDCgBM/Z5nHmBgUCQ6Kj7+SR+2UPBpQwVal6hW4P5675DZWBityRjB+XItXmw3PEDkhI7nD8HaU/WIJ0fSk4OpJMEAj63jnMBqL9tRshUw4lkTyIpqBDm2OPoO5cf7XWH2Jh+UcgUKRZF6zeLRWGbNFz1ItKkUEubX4YQsgM4byX8kDhYtmaFw+0/7gCK+aHxYT0NgFFrQ0Trw6ivB5MosSquttR1JkABAZFpZrDpX2Qjn+9IBSsuKCiZFXiZYgPBIrsBP9iNnHYl5kgQHq+5wXfPqKnpQsAC5bMp5Fm9yEFw3tbAIerNcIPhQcDSXw6a2/psFd8jn2E2mxPgJ+5dJgtc5hY3y4iCLUZTKTEupURQTcYR0m36IxtbI4hxg/VyB6mPvxIJ67NtjmGGN/mkT1IrWGYXVdvCN8c9T9GZ9aYt6TKi+nvYI4vjnyIWN28L4GccgeTxulnDd1BmNpSZ7ycVMn5zsw60yjz5ODLWeY8Cn5ITAlTxzUVw1Zv4X4k1N3sxzjUzCrog/0hzpSnt4lxBfaH/m9UEBtL3NcpS7XYqkjUiEr5xKlx5NPsvuJfCppvacxD4+iYvrurg9Rc2xh3v4roYk3EVPaYH8Nnh+I0nN+6PyJratf++D9ttnyB3l0AAA==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js deleted file mode 100644 index ce2c7883..00000000 --- a/docs/assets/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE9S9a3MbOZI2+ldOtL52a8W6c+PEiaAl2tZYFnUk2r3dGxsKmixJHFMsDS/u9myc/36qAF4KWQkULomS3i/j1rCQeDITSAAPEsD//rIq/lr/8p///b+/fJ8vZ7/8Z/DrL8vJc/7Lf/5S/pn//cuvv2xXi/Kv52K2XeTr/2D/7+nT5nlR/jRdTNbrvCz+yy//3697CeFRxMWmOAj4MVnNJ9+OIsrfEDG//vIyWeXLzaH+o9wkjsPkIPr+fvPzJW+VfnL4TlFJ9XWtot5ZEB3qOX+aL2Y6euxqOq0VaKnydIeNRsVDxTuxv4XaCI6YfUHZ/0e0/4/YHNz+74bVBH+9mz9eLjdfJ4utPlyxTLdeq9W9t01P3zZ15BKDlL8n0d1mNV8+aoMSy3RrkFrde4Ok+gapI5cY5KpYr8vq1yadWixjbJBjRPx3nn/L/6P6ed0Irew3VnStDLBHVQaz5/lSEqLZb2YRthdkoujBy/x8Ma8+3texEyTUIX6qUSUvUas47h0tNC2W681qO90UK9NaT8SyrQiADFmD2a7z1eCx/AD0Il1UzfJHZJv17Lf5+reX1fzHZJO74SwG283Tzar4MZ/l5raDpf1gXOVr48Z0sitEhig4i44N/THffMwnpc5rY1xCUW/o+AdW6I5FHfqCgGe6ykud7ILCCShMhemgqL2JCNHM8kVubSFQmNRC2/XGspHXylK3IybYuiHtS9PbycFMHtqSHSRYmtBKN5NV+d+27UkoTYjqLi8bhl2kPBalbeFcrmUDPxSmbU+WmEBhKkx/Pc03+WK+3lzemHsOFCZsS1/Wlo17X5C2HX3On79ZB8pDYdp2ZIkJFHbABBZC9QUdthbaf2SzQgni44J2F1HBED9flv/fw2Qqq1QopQ3hUF42oWb/2GM42ZXXByIKkcGasl8vZy7QajKo4b3kq+f5ej0v14suCEUxBCCFZsb67syytSGF6Rrddjs38KwMyslOjIndMJuQNUEpUMuWaAwWjMyugE3Hag3Q0jh4XiyX+XRTdoWLfDOZLyz7VUPMW4iUOCjX0Nm0mAT4n8Phu+H94OLidnh3R6oBlNyRKudXl8Pr8f3lhQdl6rK78syX8cfR7eWfg/Hl6Pr+bnj7dXh7/+X2yoer5FX5UDY466e9OIA9/m4z2WzXa5ENZby1Ur96MadujQQhU1u/1lhYq50Nf79FVq6jjHHHYPZbQAqm+GuZr8yngDs6+lCYDhBfDVkCOhamA/SymCzH9c0xI0S10k6QlNt1Voh0t6Alsg6KkbfyBsBT1u4dcbZsSdtHiCZcFjPsuqku3FX+WA4GdoAPZd9Ig+R4DtkHdnbbKUXeGAE43hSdMHpriBAqa4aWvUYL6mNehv/JxrohCuXfSGM8YtLN9JBIqylH3igRkLxhOmP11jgxyKyB+oY8fZqUc+eF5XziUPiNNM8doNODDAvT7ZUib5YiuFPrpfcp0JK8MQKgFhSXEdA1W1PZQT2UfSMNkOPRzRCUSNopJVuSvGzmz/N/53fOZjvAPG3ItEbd4uvNZP292uuiBN+Q6Qt88VLFVGLDiyJ9QWd5eZTARYG+YJfr1dlPGsB7Ub6gLubL75a23Rd9IzGMwdkbznKdxlWSzTk4XVesXOx1AHgqiLPF2jZNKpbrYkFi0NOjLE9g99GcBG1NmCe4+/hNArcmzJt1WcgmMu5eliewLEyTQN1LogPa3CjeFXhXmAR9WPK1dttQHDYbbA1TtDCvxtvDDZCCJB9QdwsBd6R1QT6AHtfN7liBLB9wOQ/lDrUmhwhmvXMjmZZtOI9F6Lrzru1YgzipCTCwUk17aeIEs+DNrhc6AGwKIgXKm4k9vmN5V1hwV3e0epws5/9mve22PlFTbOnCMmT7uSCpsM1K/PNXGrZqlVuMVTtNJUDy58lcn1msI9mXJIOyKv2r327rUPYlyaDMlz/mm/wmX87qqQcmkKAEF2i1/NPt5ukAB+Selj+ZHcOrd4dx8T1XbYFUwtk3Wl2gQimx7GRaSl3fb4zqOwGl2irnRaVc5rRQLrtB3fvP3SrN/36Zr/L1/dxAa6GMW/XMcm18A6heKEOgvWq9gGneygS1VjvZzub5cmqgc62EcdWN/jRcrQrVEHMQwj507Vm5eW0n+zJ6unJ9VNXfz/L1dDV/adlQlUIB5e1g1f1wOUIPq+KQxI8t/AEPd+hEVaTSk1rRVhMADfFT1tfbxULn1G4lEH5rYQfDc9bSWk0OWmNCtF2jDcjEMwo0dd/gLRRB5No6he46yx8m2wVX5nwyfcrNaj7ByhscTW5IdWs9CEDDpiPtRcIisFL0Ym4M5ViMyERglNs83eWrH/nqy2phCA2W9YGvcUBC02rYYQhqVOozikpkyKkHQnTb9aZ4vi2KzXm+MsYHC/tAuF3n7+eL3CZ2gKI+0G1s49oGD2iGWJQbfaZAtLO4mpJq2kgM9VAu4nPTrnko5MN1lfDtKj8vtkvThg+K+kA3Xz4s5o9PfOC7zf+1VVw0IkEpEeGpk+pcKSPvp9ILZVxQiQtwPSzNVTjlAMoXfZ8nL8bDZ70kETaC4FHDpZln1xRU101iuNHN8HYwHjqDOz0KsgfZssvKDja5I92L8YZzdDO+/Hz5J4lRD5K8oR0P7j5dXd6N3dHWJHlDez66vhtdEZj2KMgb1s+ji+HV8NYd61GQN6y7bJlzy4l+o7SXGXW9FrtpPyrByyRjfT553i5nk7vJ5M4QJSzrxZa8hs9FdcfGihUZQKpVd2mskuRtZXCbP6zy9dP4qfrfYjH7LL2CRTU7R6UQYTbmqxxpRC0cD4vt+ulz/lysftqsrZDihLhsV6ONwjSYJrPZviVfPlzn+cx4lYVL8NG+niff84v8W7lsmuYzh5WNSo4P3Ot8WVZj3yCx8j5wliPFap7/yN+vimfbZiqT4c+utkibpX1gnK+HbHvUtFfVy/nAlf+YTzeVk+ybpUSEV7S2zkYFeBoDmfhP+U9DiGJJn9h4zKsscV3P7zGD2RDiCbHljE0sSTVDq+2H7aavmQTX/mezXBezPSWhDoOdpAN0dVp623XXYvVIIX2rtyGaVElHZngaRejQPPNlgBkepBAdov3JClOXNUvRYdofnzDDhJWiw8ROHnxYvUwNEDXL0OEp++zD/HELjva39HKhhBMWAwpXgUKPuj0IEDVoc9RdvtnMl4+yhW87rFNMlDlQw2cd3FHqbqcp4SLK61xFdjX6cH81/Dq88qHPqbQqQjV1WPb7D7c353scw8GH4e39+ej6enguo4kp1FbV+Zr63w7Ht390pPe+rtfU9/PgvxiOy6GMuaTWWqzxLej+x/348vNw9GV8fzcsW+FF15bA6n9Nu1xeX44vB1f7HlndKTgeXQ1vB9fnw/vPXVmnHcVr2uh1bfMWbMLwfBoObwZXl1+HrAn7MoC0qlfVtuqw3Sl8qK1jnffd8Ha4a3T37wbnn0bv33vVvaXWjm3AA3WX+itq7Fr3y+uudZfX2LHuH8fjm4DhYSHn3XD8+3B4fX9zef3hzqsJ2it+NUtUGMruOR7efi375++X449VZLoYjAcdWaQNwKuNCTfD28+X4wOi88HVVSejg6Te12khZdzirbTuGO/NQlZr1zPE2mJ+/MeNLHOJmDbY1fQqs+HfR7efyrX71ej6w83o6qqrBZS82te0AoNyiEz+FwPyaruzwvng85fri8H9+Ze78ejz/Ze7EtDgQ9U078ol/vUHextoSKagL1FtRtWN+vcXl3eDd1fDC3cdGvI8Ix+PPg2rSdT72+Fd+dfH6p/R1YVTmzSogVw7/K0LYxVMHrZwwNl8yMISqe6rFe5YywB6O3Tge3Fhnlt5/TENx+bc/liGE17eW+7ORy5zAlyYP8zD64FjK8ZEecPLmyB35+DLRdkSzwmMLZHqr2XzoxXkekjl+ms/uxMC5KrIBXvTZZeUT66KVK7H9sVPmXhoYDLB3nTZHesgV0Uq1/P4cD44/zgsZ4myUyTGY0RdoGfs5dz206E+Ns2lUgKV7E2bcu7y5XZY22BxVwMT6a9P8NXS7Wg0vj8f3o7vbwbjj2SLsIZY33qwus4/Direj1KRplzfmtzcXn6tBuBPwz9oVUEEe5+dvBvcDYmm302J/sc+SvhNkf5nVHT4MZHeZ1F08BGJ3mcbdOgRid7RE3ATKpFd4XflK9rEkutRCKn0WlnJoIRThis8TTCySW3Hyxlm2DfONZintGOlHFF8tkllx8s5IhlZpbBLCjpiGVulrksKOmL5s9qYMAbSKGWIonbAn3v6ULF4nevuV7NTLvVjNJoNcF8P/Fznfrm9BrbHbJR1Gxy7kclxuxVHjU51N05bODXFqxPq1WjtQ78p1pX81LAa4sr0mLAGMtjlP+aTWf2GexN8QnF/KGf5tPzyNl+/lM0/H63GT6viLyvAMkn+sE9ms/NisZh8K8oh3bLXN2U49nxwsHmymj7VK7BrDLgcSqTVV5vc2ZyoGEqc/Lnq6rSqXZCvF6fEVXZXa1DHsvQetQYlFKfEtX2ZuXhQKE7fVyvBLn10X95Dmy8WtsMxEEDd7u2B1Ut7aPv2wIAAD+3fHhsQQOzNy+VDYevLXVn6tv+56lWbYukS9OsyiG3mBg8IoO8HbvCaMnxZ77x4LqXN19IT1Pp2FETRjxKHelyGCkEIfZ8pl1//zKd2iyMogdjjLtCE4vR9xQUalECJrixc/ocLOiiBvlfsZLv0iZoIR3wN4qt6HUvNfR0/tGOjhIdAyqGwXmPjMQ6k0l0Zg8prpWUEyY98tVa+jtIC5OQowAzQXor8FuTNU7Ga/zuf1R9ds8cplUcLexca89XzfO1mWEQSLdTqeWsKoA05tDD5fJYCKCKJFuouwhNARSQ5Q0Uez60RMabRCJVAG5taHgM0AqX1PqCuRBngFz48qR5XNQNdF+gT+Er5ULkZ5lX7Q+UWcIXHYblVXFovLoK2+S7rl+45gtJ5aFNbIl1/UyG27HBmkO16nAq2Q5czg27c51So7TpdK+B6r7srVhvTbrYrQ9uvHub5wszfdRgn++KGttqrLxv656vSkqZjvgCsLsIZnBAvt9/u2PKp/IQidraKo/b3YqN6LNEe4slBtGnHabeoRJl1UXs/i1KVneDOFHmZPBqGL01FdoK780i5JvTjES7YpyJoL7/N19vFhrivtwil7fHzTf6seHrbFefJXr6ta9osLLsptdhMDOdXRmrt5ftXq7mUrDY27ZaQu5KvPPduYrGccovmkA1pbHfOap0oQKzJ8QHTZT0r4HRex7YAnRYlrqXZwIrAPIrx4vTy5/FP1ZPnmk4/yvHi9MmmhGU2j8VcfhBDBFIY6yabp+Eify5FGY9oQlHicctwGdqEcjK3WXeK1iCjIxB4ljSEDGDdp1/WufH0ZFfmlceOOgpLC+2VJ2NmBEyWVEwTVN1fVQ/9nG8ms8lmYuo3UPZVeyGGxaobQoNQNS8UoF0z04RoN+6jOB1Gfk2wVnMpFKv9bEoT6nr+/LLIq2joDlaQ5QfudLIslvPpZEGDGIrzA3qV/5gb772heGuS/EDdmE4GUZgbq6mgbhNgkzGCvnUU5BXou59kUN/99AaWb0QTWPUoyCtQCqvWRZGBhfMRm3kI+fzjeQfVGslJTYKFqYjXyTQrZPV67ssha994BVAv+drrgAYW29WAYA5CXyIIrT2qBdJqNEZQ2o/FWjDtJrwITofprhZQq8kugtN+qiuDKdtwdFkmKuS8qS1GfDVBsLeou65w2VTEVxfOu4m6S02XbUR8xem8f6i9mnPYOJSs6Vx3DPWmSs0dH5JeKpP29jYHcc6HaldQd/lHsB2Irwip9gH1WtN57figadsBZd/GJqCAxm0b8GAUHztsIk73PbZWsEwQCdajJDKowlqQ/W7NTsPSr8tPo2jsGOqGWcg4ahykJUutC9OSp8axujDV2oBtepAMr3Uf0oZrxf7haO35P12wVqQaDtaeVjO0rCmxprStFbVmaF0awC5coAJwcwQ45+SG3QBwLEy82GTSzaawKKKToyQrK9aso0hZIQFqfu1FC8ymr+2cTO5dO/ZXnB458L9tczgrBlhEZ88Bt8zavtRurjD1Jij7NphgioUENIoPBpNsIaEL1mYahGO1ngTJoTbXtoerGOyWt/Xib2KF2wDktMgVrKMYSKwWjk2oB1GUYOs+P3xiu37EBLzqElIKyGoVidqHqoHKodo1UROwFo1UDte2mZoAtlmfyRFbL9EsIBuuI1pB2ywlTGDbLC7loK3XlxaQySztsGhrgY0GX+ug+zZm9M1xy35SrzPA2szrmxitp/Yaw2p9m8p5iG0T9qa2h5WDhPMesUlMcNoolqvhvltsooTTlrFcCfd9YyNPuGweKzzhvINsEKubG4Z0/Vop8u1tKCtm2FS7yiati2JrWa4S2f6ySVvjpIR1u2oUf92TXzgcu9NfTcsQX0hDtBTTB2qzrpFhtV7VGMM1nGm3ALaZZ+tDtlnPyABbr2aM4RJZ2GElo4SM3lFlPi0Xi77+3hOCx37nCdiFbN8JBWm36ySFiPjXchx6G2tUAMZhhVqzBuH6FOKzXp2i8FpuSKJYmfqeddDcjORlVaof2yluRPKwItVXgOImJA+rUQMPENyA5GElqj/Wyi6woVuFel8/0N145G8Fqt+iCG868rf6VKpz1GX3JORBG/Fy8N2vGq2hbqvaw3iaL1Xu64Gf6zTDvQZHAGYP4ynrNngYTyZHOuvXehhPjc7lYTxTvDoP46nR2j+MZ4pV8TCeGqLxw3imyMop3kRIDjFBVytMitDs6T41Rsun+0xRTmaz8c4a4+okx8ayTeJyENzFpoymjAdwRH5466EcMdYX+cN8Oa+uRbWztkKYY6xCni0R67BtHZgg31j/67PswW9zuFwWJWLuxIt8yg4B0zQJXBqxnZuV2FoZleTPxpfloD5ZTnMKC9dlebLvvgpX69bk0Nt211EoTIuI8hMhXA3bFEOJs5rdsyeVnKHKJPm16t1mspmvN/Op9UxCJdAz9vxf27z89/2i+IsMPpBJ3wcvl9Nybr2UvkKl0/nqMohtvBdta89aeXrbVV5ZlitqigCGySK2JazC1qaIHHrbfp2s5pNv8sdldWxal0Fsy4Poh2K167O25sRFEeP9x93omhCzXBxpS5g85FVNpZi1XWuFEryugd2aLBDgbyZ7W44p8xW7fJZiMgvEeZrPOoOWy+oAscNiUi7OEXeD0K1vCuCc7vFDO5a1TvPaLgSryptlDfDUBFERwApMUjZ4F3/my6d8NddhifBKNPKvrKG3Jl85Ifye/3SHyIV4wzjbr4IJrCnI8oZYSGmzxqqRz+aEEj6yag1U77FVkjZQD8CU7aEht1NNPlH0QrngTnW5Jmn7CsmdavOVqo+ohXvTyWzbSqUAuodFgBaZjeyXtJfLl60m51CvRyj+duYkTVh+piWi9QhnJogCLpMTLZx2IymC1G0w1cL6Y7LY0oDdS6JGq+hro+3GqbPx8m+vt9Vw+e1uOwN66G91FSg6nBqpW4+rY6Xpcmq0jn2uDpeo06nxrrbCYX4nwAdZ/hGzTDE60Dtx5LgV8c0e/duLaR1EMx9xjC6CkbIZIjwnLqMNX/nrxrUlnuyFeMKYV3FwUs3SLwjANqR5R/1+Ml9sV4TAjwI9YX+BmUpWdIAIXyLTkwYuDJ2Im4Kf00V7NA4dbiDTswZ2XAuO3I1d0UVszafgoJ0ZFF3cwgupjqA1Xkl1QLxiBwlcsR6k+I3X+YytUTU3E1ujdU2cb9x88kkH/CjPE3J7JlBE7M4DYkiRmbv5ZnO9knrptzODb6DyM4sXTEc4k2/Cd5nN66C0mtE3YTrN6nVwUu1PNaFT71DpaGPHATWxuzFAOkit9zCbYJ13MXXwluNqsV1Nc7uZWxM0kOcRuf340UTtPobIENfGEcuDLxf8ZL5Y9PVHEBwS7fDRtBhFVJYgtwrJ2gjNIpgEol340sZoHLskMK0DlzbSby/Py31OvEEAkOCF0ihRN/u/OQEMCr6Zvu+R/oW2Iuz3BPSqJrod52VMMaBAG8L8YHbrWSJkmn7VamUmyIiixA1ck+MTaXVO4rp2ToIKOS7Xjyblr6uNGR2PIq/L8YM0X84IcB6leLMnhS09InTbE1BFNMctAU385qsFFLP9QkGBszZHMDvYVsndl3j9WYGAhHY6cDALxTxAxGk1AWjD49ZbRIA03UQTsdWghOJ1Goba0G6Mdj9EfBur3Y42RM+lyvULzgxBHYsT42LXpFZ7PHOT9SfoyqIMYoSGY58IzXLQa8P0z+KbQw84lKZu9cZjGGj51oMXhqw2atkdIa4Ew5KvP4qhiGhHs4a5KEY1HLfV6KaLz2XMwOFSjB266C3WMDhoh0WMLlbjVQyO1HoZo4tzvosTBE1BFOUJr9k8AgdqN58waKUkLbQLr1O53KO/jUdQic+tR1IV0tqIuj/zrw90X+L1R1ABCe3IeTALxYgp4rQaKdvwuIyQIjyKkbEN7XpavLhgrJUnRma2eyaists0a0NkeM5DhGR5sqMNU9nNltNJ/b0KQ1x1AQTYavHs/GmyfGTXbm0NcqfqpV4/rjXQ0MY2wURULEMTszXToIOPXw9n0P6a+I4iiPDJd2BNr5VDaNyjiNdvn2poXvdna5aUtIzJdDP/Md/8dGDgoUKCSDc2XhO//RYNit19t6Yd97T6bGHSJdua0VGgb+xzs0sINcDP7a4ktLN88fxiGA1be/BRogf09bci/t9tvlK8IoXUwEo4B0Gjd1uUKPSeZ5GJkE6RlW+AqAFpPPVhDEf5KEwLnPa3X4zhsCvgBg8OXhNFOIKrt+j6qxaKJ0QQqUJJ2hbe8p6JFhith0vaJKka2NdqteKMUpDkA2rLYyp6KHVeTTEAWL9NbzN/rgcPeJce/1mjeUnmtnsJ7S+k7GpqFNBr2js17OetyuqNnkmRSZK1EN2HUtQI3Z5KMcWsfIBEDdTiCRJTdHpPuahhujzmooHX9EkSNVjrR0lMkebLik25e5o4tFQow7k3iZfKz9fuEBtCaDFWN6VO1k/fislqdjlzcDqQQosy//ulWB2r0Hm3o8XxKoHkFr7Nq9qczFsXQdxKGZ3E5du2UVGED99z4VSOx6T5Q717KK7+qqo9aEEYLeYyvpQD4vDvcl64nCxaN9jUmKXCPPSuyWy+VF3KrtG7jiKIbfpcOW243JTtLLdF2BBCi3Ex+ZYv2i9hV2NsCHHG2FwaXChu2gYCqzWH3Ww9OOunvfg4Yz8MEufFYpFPhWOJVWaDEgJS2ARWXZYCIo8MNvhgSQ/g7spIsNg/iAOGmVZ8SGEKiDXWA5kDqJbIKh+bHj5VYpSd/HfDpHP6X0+cNBHr70Os+ilcweIIHJHrUw1hP90Rutb+uhtcfqSc3dIHD9M5gkcl+1RleghGl2StHsj0CX/FgpSSDDRBfhTnE/Tkx2S+qAZu/iwnGXpELrEa9VC+m9WXU+Mb5UvqipFwX5g6gK939Oe/tuWk2LhdI9hOmhKNLQvsJYuE2+dv+Wr0cJtPi9VsfbksVyAv5ZKJwMAnKtme1GH89bVYL4EmErGelFjt2AAC4DVRnsDO6gtfe6AziyWvEiQeOqyRUocM5Qk5K3B2B+WUcrXBO7RVCXbXJquZkUoFXJDnAfa37ZoxGO6tRJTkAWrzXIkdUP1jJVYw4ZESO5C6J0qsIM62q4nFihVirInxYsfHsj1dmy+omqasCfIAtHH2wQ6m9tEHK5A/GjydHcoftlSdFCY+ng7Zul2d7qKsYS+Aenxd5n8rM4P0QZ3sRDmY8WClI9gkjsOjQe/vN+Zkigrv6UEiAexTZgG8KZwviu1s+KOU+rVniL9e9NUptQYYSy5NsIdshHzJp/CuMVuUoiw/cBlH5I50L8Ys9doStEV/akJudCGPgKsF0LQogS43JNib8jpTYz19yp9Nl1q4BgdRnYBfb7/9M5+ajhtIUz/I6aatz40nX0hbh5dbeG4kJM2jS8D33ybrPIlIcB9l+YIvG6MHm81q/m27MZ5h4kLImVTXsQZAw0YdC8PWrOZnvIGwbSdvZqDpxhyI3/Poo6ea8ziEaeVnRGpXyH1sanQNP6OURl9xG68afcXDyKXXwIib1uso4T6uYbp4GuFQlWRjXSWkWE4WJGNeUxj12EcXjSVYlVHZwhmIfX1GY5VWSFT2qpB7NJZpg0Vlr6o4RmOZHo2o7L2BeWpa3SrhHo1VumBRmVolmCG4zxoV0sVaUwPrpYhzAhupz3o2NrtgyCNVKd5ZYkdTGl04YwPLNiuu9Y4X85ER3PFiOfCZXYhjg0zvVhwLaK573sqbmOx2wjQhu6RHoKidkyMQ4DDg8SzWy+fdeQ4xm6o18GGlPQXAqyqp39KqrCx1KNzvWlrsJjdxnQBp1q7mZmqBbJEMrYBsmwJtBJnG/SdQHBloaZM1XcaJhcmXbQQxqobsBMpzs6d0srkgsuTJQRAd0CPK8WT9fTGvHQEXDwbtf7a/NmAvoe3agENNjQI67emghu21AS3VG1wbIJfkdm1AG0KXawPMMesczG9DbH8w3xyv4pqDNpjG1xxooTO7NqANo+W1AeZIV/nLogxiVU7e+vf55smpyUqF+dSAZ/5Xn9saW5TgHAtgS6i+tW8Gu9LkqN4Xq2d7VLvS5Kjajt1qQNM9dOuEzx0eObpS1vxx6dDYBAG02PYX0TmgAyJo8W2XztYDIpzxNad0F9Lj3g2B1WTRbpYF1+bVJ3fClfL1BTla8aGICYS6BNnR5NXkYcMvztp3oq9qDgmFJxNDgNaE3zLHpsV3GYmVMqxr9vO4cT00hRaIcO8KvazyH/P8L/LmcgIE+1AEW9Ufro9jbFc11Sq2GybLULt2gdTdQsXeu0Bs5/Utpdsx/k6qaOwFECtjE6x0tbEOW/bqOPR3Xa1ce76Rcu0xgERL6r4+I4tIO6ZvJ4/I2J5DFBqW2lN6CBQgC02ScNSJEnQhSRaGOlGDPBS1hB9fSpklBCjreDNTCoqJg4c+SDMJ8NGviAZ0+xOnGug0z5taAXQZ0IiGMOm9XZvdrTKm65tDQepu+bAqnt3AnOxEmC+rjtaQ3nviCI0JoAFW92P18bufTRpUDyQoTe1Ri5iGIbIObdA4hBEOxWkd6DSBFuxC+MK0y6JYa7II4cKmuZ8esGuW3k2M1x2oDOpmKj6B6QpM6zFMfZnSO8cYe2zMtSlw1yR2Ap3Q5DWJ3UC3CbQt2I33n4zBb8qP9a4UMtUBkexXlelkOZvPyn72YVVsX+gUacjtUg3CRtUU3JEiX9bGM0odNXZiO1TChzP2cv2qYZbaa6qMRZ4vmUrYM7dUCuk/fEugzuQxv5urHvoyVuIo0S/0h2KxKP768qK+2ssUPpDqV4XZNqdFfxTof/x2WekpBm/rJBhzJXZ0C6UCNZF+waufwzNeKLS/9+EOeb6cLraz3EO7QSR7VqXK6HkuZbZc2mesCJRLrga+LGaPEO4KWGtTF0K+MNZ5btEUn8ELjAai/aztEfCNxb3lBoqZGs6r/aYm6HK/S2Uo3YISAJ0qYx9Y5dqgydx+1SHjCJpaKUmCTpQjYg2aqilog1dQjLIpqoiEblVzYhYUijWohe7V8uKwJtnQiWKk7ENTvVb6oUslKfgIqYoyQqIbBV0ZCkQtjKLoRBkSzqKpkJS06EQpVxajqQ9GY3Q253Bfn+ITDnx12o1azkwHohJKdXSijhP3gSykIPnRiRJkbEhTISUd0o1yNPwIopqcIPGlmIIxGa2G/9pOFiTEiSjLI3+yq4gc7QlahyupAkzsj1tBNfJEsegpRcO0YHp5JFyMVPPgMo/0i5lqjgFdpZuPgK6nHC0ng+nYATWjpyolQ4Mp6p2osVHTQ6P1T9sYKurO3ijV9ETiWCjp05m+KB09NemZHUzZjggeI5XJeB6Fwn7pHk11SVgfVEl/5I+eanQcEKaeZypIT0USRgjTzh8xpD//IVqxyyY/PlftmkrSsEWogh5JI82VojN3hC4U/VBIeirRMkmYeh0QSpqqEvJKqKK+6SWpmjjL9C5/KFa5K78kSPHDLPEqCBGeALkOPJJoRC8MEoafnjvSUsSZNUJ08cMXmahD6ho/HJGROvZBWqEPcVzWUoiMEUL08ssFaalHxAIhyvnkfyxUI22QXjkfM+Wc2B6VavQ8j7lifpzmgdvRUo2U1UEU9M/nmKhJweTIlfTG4eip6MreYIp54W201CFhbBCV/HE1Wmq5sjSIRl74Ge15iPsKWDIJ8bTw1VPMmY3BlPLDw+ittFwYGGyhRc69aKlBxrogKvnlW/TUo2FaMOU8ciwy1VTsClESDybMJ9fimsYjxXuC1+JMwHSRyaNQyhcd01Euj1wzn+RMR9k8rcq9vuecA3yHCT0m6hHzN92n9JgoS8rmdJ3UY6+oj6bbAcXTZV6PhqK+CJ9OM3s09XxFf3pggV4nucdCaTpO6DXSe4wUpmGIukvwMVGOkC/qNsXHREka9qizJB/TORHVur7jNB8jNYmYpQ4TfYxWku48UzepPiZKEbNO3Sf7GClLyUF1ne7Tpih4mLTxGsYOSpuKhA9gOD5TiiKSvlbqYF+DRzCsINvdqq+DTLiF2gqby/3TbeikVIAVUqqLWNtfqWCz2mtn04qCvGCdrnIWaYSJk123EiX5QcvfLaTBC2V5QdwgIq2wopwjcT8THya07mB3Lhd8t+Esx6/n+krUCuVRiDeMrpHqIMMbwq/5al2fwVjDPArygnW+rl7HHT5/y2ez3HUUhbJ8Rn+cLXIZBkhuFdZEj9E+LtgJLhBujWHwvRu7EObw4I0OSshRWIF0vFO3PT4gZJFlgHC/urh1TiDZWLCbFNBcDa+NWaTO3SA7XaDeGofxha9dHCa5UhZDDFawfNlru44VS7+d1SyCy8eaFhhPQWmxd/OMWzGmhiDNIb1DY1YxX9UyaxwgH0V5xPujQa45IP5BdSc1NeeBmpd4b94HH4LhbrAi3pG7ciWYFn7zJDzyKJgyMjbFux4uHAsa7GVMi39NnPgXfOCSsjDetbHlZjA9/GSFeeNtZJ29yd5418GS08E0wJidTvDTRFuE9ekEvSUXJFMBY4S86+HGE0kmdjK2qKuRz4lDUgyBHlOM/PNLCr285RH54p7QMIwxUN41sOSlMAW8JMv45KzwQOYro8kzn4VOsnxmxvrlupTqeMgL9cuDoeOMx4wPRJv6uaN9Qs3l8mVr+xI7K0t9qkhYhdvisc5MEM0ipWQWxu9iIxitX8WWgaz71yL/vCpC7c1tKdP4GMcByMmhuLGNmP6yAW++fllMfl6bt7QjMlEGKbyXfPU8X1fzaNOEuiM8UQYpvFVhnul3BLYvTQppPSmF3iwmy/HPF3uXQinOEGtbEtV6wmTEqL5/G9sOByTUGw3MJCQE8hGiXbKcCklj2WQ20z9CwwWRYl1Pn/LniR28Q1lSRD/M6YUjpB/26SUqTDYLtiMolyQBZYsvW8Yi35jxF7WGXyvuiusI6s88/3aMp8/FbLs4AGK/aYQoSUB89/K8vJms6rMUUWEu//iZTjTkeBWEaRXZZesQtMKTeqnWqmul69Oys+io90v1a/WZEYp6KQoUj/nmZsebyBocDgQUpMCynk4eyiW3GY5aIRp7LPNVuao8LxiNtKn4v6rU+7l841VmILUkIu+NrRozKEiE5XPZGiaPeTUVNoYDyloiAof5ql9HLxthAq3dy2olG1Ocl9X8ByeF9LElcRwel2X395v6FNUY1elBgImpTkXNZHtiFe31rign6JPlYLNZzb9tN4YexbCeSuXaq7A3g0yTspbrYpYrto9N8IvSvKJmtqkqulmVE8W/acA3hXrTYTqbbCY3xZrNcM+fJkajO64BJtIv/vHkkablAGneUM8fl8Uqp+yziETP6Csb3b2Uq3Uq8HWB3rAviulkkd9Olo8EuEVh3jCzbw+u/SqQmdbYcaF+daiCMiX8ujy/yMerbX69ff5WFlouZNugpvAbQr3psMn/3tCNr0CaP9Sr+bMyX9UEc12W37ZiM4RSTV6Fqf5zvnrML/LZ9iUfLGd39QPtOsjQ4vQoy5Xhsvpq9O2f+XRTrr6qFY+Zx6UiOkC7WxA5Aq5JIcFsxiPjIGX0sRGQY98QV78YN8W+sKGNju4p69+weee7VfE9X92Wa5hDlfly+4xViJTRBsFF1MPBcel4NRxcDG+tqz85lNdEgUnCkb27HX1yQXYoT47s8npwPr78OrTHVpNAg07auD7mk8XmyRQpL0XSwD4OB1fjj384IDg5irA01s4IKL4v1wQI60I8YLwoO5kLvF15KmThMWz/Y/TuvmrKo+vyn0/Xo9+vhhcfhp+H1+MD3sPpEASzvLh926uhuyoeH+fLxxYou69sYrqShmuv7cSAd9vrIpnU/fnuH+tiWX1Um9ppIzgFxbXhNKeaNCYRAO0q+a1ngUzUTGK8fLUqXK12AHm6l+YEtVvDcsz7PyMi8DtLSK95eijI8O+E/Z9k8gry/q+EyuLMDrIEpfzb1iQWquHvpf2fZHKGef9nQGVzbglpXHaIyRTxGKC5Y9mhDpiAABdktY37P9/9Xqy+t7AS+49sRmqbtaZQn/FK86CSZJH+NFnOFvk/im/qVbkIQiiELMKLTblUx5KlDDHZQKJCJG5fTTfzH6ZWEgqZpJTpYXpcvUzPF/OqoD4moRA9pufJ35W+42JQ6S4/s4BBw8rSI9znvBgAqxXxgGf+nBdbExceS9CjeSkWi/Nia9Sk6mXoEf37m3EbrxWRR4L/iwrgQhzE2uEtmoOWN3BV0/3IIqMJQrFUBzCn1em2RfXNw6L4a7Qc/j3NXxQHUdCBUSHDjwrCmDVdFNKrWFC4u+9JeoyApGxfZq3RCwpxmt+OozmRp0IiLqvbkTQXzmQ2WU3my9HSpJnUinTQiJ8n3/NzfnNBvgsAJhMeSfEOgBtFCuPTaJoYHh5MQLCvPbT257nJWLn7nB7HKn8ufuSDxeJqvt5UeaMmDQktTDO3qK/2qo8+aM6ixW87W/sh1ZovAYGe0ktQlsuyV5Yj5rgoe241nFphQ4RQY5SeJGhH1nqKwAjPKp/M5jZojgXJsDyWS6a/Jj8Hs9kqX7f0NgxSozwZsnKOsch/5AtzTLWSZGiK5W1pfHViEgrmWNAFi3HOtAqLGVcOJe0Vkhrq/NCbh+2TKBxmU8RbMB5AZUbGNs0IlXRYKkp6gXTFqMx30Y2q1VrkZlU8z9uWMGhgFUt7xFjfRDWCxwt6QlZRahbRlpfyhKnQOCGCdw3rAyKayP5iMzINjglDJxb2itDCdseCnpCt8s3KYtzaF/OE6nny921Zw7wlrw+FJpT1i+/nWIdpVYCsCfDVawfbzVMZSX/MZzbDBCzuCeV2nY+v7szhHcp5wrXezKzceyjna+TarjfF893dlcXYVSvqCV3LiXEFONWFXkSWK5YPc5shf1+ODhfNxJMDMznnCMXsVJNtluy/vss3m3LSYxGRBYinmEBb0IZZFlSIzdK2lNARc8gyHIbDd8P786vL4fX4/mr04f5q+HVoEwA0dTuVVkiucltuBwPy4fbmfI9mOPgwvL0/H11fD8/H3k2gqvn1bXE7HN/+0akN9jW+vu6fB//F0FwOLSYPDhYQ6307dvjjfnz5eTj6Mr6/G5Zt9OJ1rIKheH0bXV5fji8HV/u+W2Vmj0dXw9vB9fnw/nO3lmrH8vr2egt2ejv2Yag+DYc3g6vLr0PWwP0aQ1rhG9C86tpdK3+o81X033fY2+GuSd6/G5x/Gr1/34EdWup+FXvwUN+9LRT1vo4dLq9fxw7yel/FDh/H45uAoWKB6t1w/PtweH1/c3n94a4Dc7RX/8pWqZCUHXk8vP1a9uTfL8cfq3h2MRgPOrVOG4xXHltuhrefL8cHXOeDKxtS0HaUkdT+mi2njHa8Dddd1VFzkdX9OjPTGg0x/uNm6H0W2qzvFWfkv49uPw1vSzDXH25GV1fdLu7klb++RRigQzzranEir7xri5wPPn+5vhjcn3+5G48+33+5K2ENPlQN9258W3ZeV3toyKejblHNRoMv44/3F5d3g3dXwwsqfRpSO9FiPPo0rKZt72+Hd+VfH6t/RlcXBO3WoB5PmvLuMbi4KCtzVgcK84p5T8k4N66muC5wl+H4dujMgeMiO+kVX26dNzEwgZ6x8z52dz5yn4vgIn3jH14PSFo9JtAzdt5YubMHXy7KNntO5gSJbN89oVx7DMa+dJJK993GBnefri7vxp7Ukov3rNfn0cXwqpwJ+VFLKt17Gxxffr78018jlIn3rFe5WrkbXflSSyq9k/HnfHD+cVjOY29px6C62E70KGfinw61skk5rUKofM+albOoL7fD2hYWlUqYYN99iK//bkej8f358HZ8fzMYfyReXDaEd6MTq/H846BiR+mVakrvRqub28uv1ZD/afiHD7UQ8R3NkN4N7oakS4am3K7GWXpVmoK7muFR64IJ7mhWR60KIrejGQ+1JojcjjQh42hUgrvVhYa3aRNOp5NwEnuyu06n/fYiTAVQ2hijDNW3VTGZTSfrzd38cTmxOBraFECGjV8lciM+vm3hfYkYOpyrvPSMzpVlKDyxNB2q9ptQUDiNC1Fccexuomi9RwzvufXCxB5zb1kSMX5x/j7fVC8vbxcWh2zaBZJhn7HHAku5xXZlY9xGeUJkL4vipwsyUJ4MWV6911w66CKfzhWPWiqwIRLI0D1M5gurXnwsSIblMd/c5asf82nObnx+vyqeW188RLHJBZFhfS5m84efztFGJoYM58v222K+fto97GAOsFGeGtndZrLauMIDQsgwrsp4sPiRXy6n81luc6q6KYAM2zrf7B90t5h7gtJkqDZPq+IvyxsthLJ0iIqXYlE8WhzurpUkQ7N9mfEZv/W5bkQC4bxud/1R7VP7O5QEIUeMb+a8KER5ivx/v/X2qU96N3gjy0idalwvoqXR8FRyhS2xsi1EQesli0TKwusZvWspTgv/zqfbTT56qZ79tZsWNiXQdTIB6z3BdUWoDE942a0co+X7coq6XVnEhkZ5TzhtvG57w6ImoraLFlFItvctai6gWq9dRHuH9e2Lum3M7BJGvJ3R3MUoRxwfB0r22ACcaM+Xm3z1MClXH//Bcm5ZyFqf1r9V38fISv0HK6W6hrtc2Dy/GNd6Ui/aWr9QXnHvRfVupDmUY0EaIPOZOYa5/FJD0+rFSwO1EahvDDQF8WzZGk+eW5Z6pkCqdmbXOl0g1HvneZ3EezdZ57f5v7Zl229DJSvn3Gu/Vc8o7niJ1qaqRHECRbUbTGoNCdgfZeisz6GsYB6FeADYWKnbQWxdsruAbNxXZIURvbvIAaK0l+zpsrKIEeJaOedesq6Ip8vd3F+4FtAGyQkmztCIdauQd+0GYHnXVk1eXMDbdPUGbKyrewNs1fWbkNGu7wu0VShoYFZdY0YBuTU0HHfBbIOEIME5XKx4dIPXJboBOmlItQwZorUkKjzkm+lTk3h2VKEh1acK7vEP0cBTJNRSyCUmIqqQR0c9JajblIeIqaWIU+xE9KCPojI16vH0QCuO+LXFvEz9klyJWtKCztETuQ3XCoPsalyZDeWm0LpM2A5j82ZhMnia4aIFoMlySQeiqvFdF1ZNb1eMYNh2rNzBm3vVaX0pgHPxZBNecNZPe3Eg9eUBKhOoRGnjOFj9P+5qJ06aVVY/W1VTa62VjIti2uaD3WeutV1eLl+2yNa/pFbwuXPtu6FEv35YwBnBaLsxMgD43rn+c3Zz9Md8MquT/rLaha+dW1rxbbcpdc7Sk7dg71DW8vBiznGRPeemuaWgwnACBLWHIZkhFAFcY9qgxLgymDFYwPv5bjL9Pqptv9lirAmiAFpvfmzbtixSDd/a/Q8t5Nz0tFcL8uoN2VRceVXPOC9mrd1CAa8uwwc8zY7bhtCk27aBhIP3/vsyhE+L2hZNcxwHX9q0L2VekV6NJ4dS+rbY6yaN+LtnH8tuebn3kEaQQEo5dzrxHVgHECcNSVqhCrOEpv+cMZ4auFYiFSgt3aHmxyOcoB9lvEXD7tDtU7HkT4PpGHWvqoyvLIc3F7C78m/QjBWyvQnlj9RpmJCpKDNfsfprsmrlspQ4DyLeohE5uL0dUyc77hRVDbouWJuvJ1ubUUgMqgrWz4DIEiB23zkPI9/zVjJFqOuEFzAnPw+ayZhajcYjImkMAVRQXkSG9pOpidDy9DCNtk5EhO4bJJo2vMgf5st51fK/6pFjqCUxKfSQ80X+nOtsFogY68X8gbJti2h5ephTEx5GRAiL0oP7Szw5rIXqr+Z5YSo4mgSIiAdjPKgAzUrbL+ZLw/BbK0UPSZtSEDG5bTO2NnKjJRdo5fJFlgM8mxmYCpfJwuogh3YpBeBhi6fXNZjVguloLIIlkgiosSh6VfOYL4QO5QmWPgALsth5XePYLHCO9iFY0oDJgezoj415IF/45zt+58Z4sv7+cbKcLWpDcJPBQ77ugDeU1WrCHWJ6Kk59POYruPmqSnI/fu681FsUj/onDUC9J7XCmjn2NUWlCbszjcw7FA7ymK0jmGmx0Og+GJZ9STIoi2L5eFMsbB11KEwGqPpn/aLBdaOI6qXJIL2UKjIy5cfEzk5AABmwTRkGxjojAwaqVtgFEBZ0zsVHhltQ8a+dQ47mwSqxQqOjVUfNVP16vtb2Rx1IrSwVnPvNxMYJJ7tyVDBMx4I6FHQo0J44aMEzGxnq4OSvnBNBMxonGo3JIzDTUUN0KTJo0MIzHkPq+PAhhBagzYhSxygdUGhhmo4vdYjo8OIMD078wdUC7XN/vEAH039FxSYrAInC0iSCNtd1tK8j3dKR6em4eyPfuLGo0HyPRnd7xgKM0U6MxiaMvT2M91vMtlosgGnvqrRsqDhUbdFGWrZNLMAY7ZBobI5YQNDbB1FtgVhUqp/uaZXa6bqnod7OsKhYe+eiuWnxW8+icnGtx6kobYJJ+JziTFB1ffK4GOwuU7YBcIJJ0Wfh2lbneqc9UWAbgzOdmnDM5pwIJgsWQwuYcAbUChmUQAatcXcVnGCaoFQIo7PlZL6/HXu0HP49zV90zgngRpWJIgM7y79tNQgKBNu+pAuUsHZWaPTufsCekin/+XQ9+v1qePFh+Hl4fbyf/hA4xbgqLfhbj+QQUzuw5kpDXogC0udylnCbb7arZRk5B6wxD6bfl8Vfi3z2yCYyCmjthV1Pyuz9rUtB1r/uhIJsVKhPQQqaycm2a332owkGlKeDpUsYYZCMdhl04EwPgXhclBFYuMPZABkuhtCVmrwp6kaTLTQdOLo8aROM0QaaDhR9XqoJxnDbQxeO4cQAIrKZCqhBFcvbcpXRnsGHADoWdQBjlcEgB2OY5yEK2iukO8uzw6m65vQVzQdgGeYSQUNCJWUjYf3w8cWmsBoXmzIcDBr3AgJzQkx7a+qtpoHEhoI6dI6lMREZr25MiMkoI1CU11CPmjao41azBvp7HFpjixmJIIwrCIdAC86GUiDextKBaUUw1HHK+QVaoK50gzLwY1MMYjs7kQ+Cwdu5B1roRlREHWmTiXAGVl/OvhNfZNO4za5ZwnlZu2aSqmWhZeUngoT24I5o7cqAy5CZ3QWgD0z3MjAZLqPbVJWwlM3J3G7u1L3GdrGkVu3dY0RPGV1U3Z/e3vGrr9yP0R8fwLv7uTSp9aRZVGeKxHRzXVNIQZiuJJggqIjEVPUnMu82q3zybAIULf0KBmviMJviMkmIMnV2Vvrml2kTQ0tbGE3yLJQpnEZJZyi7V52MgYjlXGHAZ5xM4UjKW8ACE6D6C42moNDSr9DhmjhMeSMmC1FH4k3x+UhzsyGlXRsYfDXSFJSkvCus3buRpmjEYq4g0CdTjcdihRAvAI/XtpJAbYhzBo09ymwMVSHEFSD62qYpQJUQV4D1VxlNcSFlXeGA1ytNEeHFXUGBx8lNQeHFXYfN6dNkucwX59VD2xqbv7XmDgra8AcqYPobrkdMjpn5SjtxLsrQRrVC5IDExxV10EhftHSE8lS0P/dTB7L7ngCG2Om3y93jyUZ9vV6KGlK5Htl8zjdPxUwjv7DWjoVi1KCmVZc1azjFmso6NeqCrwX3WxCzanmo+XaUvKQzxaEzYW+pXj9lX2EBp6zkNoAGycrmEDU3fFqNaJBAag7SaEelDap59qaFVXd0amscabVrTRAR0HqnHtTIHs3ejBTppBvL6tXvv5iyTh1XCsmgxxqA0uyqckMZ9FEDWMZ73FKAdunxBlCN4ogUpnkAMYBo9nSTFKPFW00mLVE3vMnbolFcU0PDAtpM4yxi/dsudpka9WnvLwlaEcTQIwLj4KmCYH5wsQnI8gSjDjyjo4xNZOZnGg1sZny4UWo5u1OOVlBdHAyl0EDUPpHZxGV2NNMEjEt3sDysqQPP6NRmE5n58U0dUGYTryMaixmXCobmyc4mDpMjnjpAdM96NpEYHfrUgaKd+9LEYpb1ojXaaea7ICOeSaaLBIp8CbV+KZbtdA1WxnkG8s9SmHXFJ7vSpnOxnb64adBHAW0fHUfKO5vM/YVO6kfIMSvJ+qPDa5x0j5KbAHZ6eZPykXID0E6vbBI+Wq6GrPN4uXWPo+ptZI+YH+1J+5C5qh2QPGauEyZc3632FTJaw4VX4K6Pm7eFDZ/gXR85bwkfxNDroQR8zCRUKTqg17UppinGOcBor/5MABkuDHVNZhS79WaVysLOxrVZ/bcjsqcD1KbyGMXr6Ilme22w3eJ2HbDzPK8NqjkHqN9ITFkQKwUco3Udtvtsz2aBJby6bj3pa0hxDiArcjQnR5GW9m3aimRbxkIHk50aN1WE7Su7CZVElYZkD6oYNX+HcbMpxrkDuE1iJYAolsGIyXxPAmTatE4HnGa7+oq6TxRkGnpa+emr5jKZkDZC6vWgcZN0nXC0NEjXR8YclXSalMhUo19NKhWyiNyj5e/zFVX85sLeXBSvwfITy3dG7D6i1zXrOq6rlfYR3evadhbj1WrSRnqhofqP91rNlj7qI422o9ivVph4BKir2cU40FAu6vWj8Oyo381ktWGB4d2q+J6vbotagt5zMdvCqzAZcryQSWhvgfExnyw2T8ZADsVMoAjE615eK5O5/9Cd39tL0qBPhUpPxJIaFOlBOdliu2jPzgQYVpqub6/8SXS5XvVP2g5HAYA7M8oWdLl8aL136/ils/OXxSzXujykXuHJoZTWDRl7rRyOJUEAjaNJ9tW/FCvj6ndlSKrftwqdG1JEEPWSllDq7W+8u39Alz2B37snZTCErXZA6z05Fm43RUNT6dm97bqEcDf/t50xTkQBdMCOrj8vtu2nC3FwTSF0AFf5y2I+ZRtg7yfTTftNlzhETAwdyMdy/vLX5Kdm3i2OsCHDCR6yBbsjQkff/plPWx2NlXEfIjTu45JWfLLUvYsL1VeaHLlfTdoDE2Q4w0M89znfTGaTzUQT4v7zbnPbsMotNjehym7rUhSUyQamJhwbCgTFZr2XrQl0tbu5RedqPBQgEEAGTHdxioIy2iWVA6p3vf1dMrp9D37v3Plmz8u9zHaroLWfQBHttmlo3Q5OpyW1wtNuTboANeMDDswkQGhbbPedRmCQWEsQ4MWV1ZA0X7FUJY2A3+rUhjh6a9arcLZsUxgdYN3whiM0im8KSFiAq2ttGuywspSBz65BSlERNU7UYmbKmARNY3WMg6mJQoaBVQ7eJsgaWd4tRCisThAuTBQxmbK1ozeev9lANo12crhWka8Faj0Kvi9Wz7pRr/6tc5R7KIW1G6hR5cmhXLs5BN3cunMTh0n31QFS6aXRPXGD6HY/HSAm3a2Jxrh76UDS7U5NOEbdRwIFISQu2C2gwstp6uXasQBVErldxSfH0toLxZqy6pmUvlWaJdxnTTuRllWf1MrrB1pt09QjsrmZ8NJkJquLJ4CEThCsx69WE1e9Vt+k4tcko5hFlSe7cnoxCTcBeOQRMQGTALznornYsOv3IOtudOGlurg4RlGz9hUyEp2lvWtva41OJQcniqEGqT9RlSM0nKK2wFM1Mq3DD2ghgpMXXJ6xL4VjCkcZ5pYiOR+pQOfkRtURg/1Xbdj233WyzSZUpr+1dtBFts9dlNW1j0Ji7cdCVgDqtr6arzeH/TW9mIwUoZqjtvcWWeUndQntVsHUlkzghSczNEMKWqib3WBpzQbbwajK0ga8WuWLie4WnhxeQxAx0OomxnFxNf/hYkNBCDHAZ/6Vxo6eHF9dBjE87Rx8BbyDDM3HNM0crLshqnCv0bZoCzhVFNGLtHipLma/ipq1Z78SnYm9Zz2xbIWH+I/dKGA1FCAluxwPZNUbDwqYBagCrhSkXdQ1gGoaeqVIreKvAVCr0VaK1n7INYBsOm5I0VoOHiYt1iwGydurRRxSw6zHoi/gdTDNQCQpRnEFnkZTVNV+chDRbi2Z8tJVuNadkkp0JtdLtsMTmEj+8JWmA8WvO/IbUqmJu4CGbl7CsJg4Rw9MXr1HuOuINohAeUob/Xw3mX4fPTzYGqpW3gGWcHDh8IKjZiNuFOioHeP1mjTlpqqqBnRezNoPLuCY6uWpYWm2axUyk6atDU57kiBBZnaIWwVLODF/fMhW91qfRomO2rekYpMGjmjrfBxfgsp0KqeEJjyYVHsoT9NlSJHu7iuQVW5sIUzxlhv79I9xS1G23JSue57ZAPyimE5aH7yT4t2XpobY0gRHy/FTrnOrhqrsqzZKEYVhuFVaxGcjBaj9tdZWdWybLdCAtP1ioOE2XO2JT81wipdybrzznTyNhqBAcCKK0ds9Q2yAG2x/S7vBLa1IEWdTGb/H4Xj7Kqa2BFrV7dabYjW0fqWjgVUpkhT8PuiZ3KYthS0R5gq43hy/Nqtog4sU6W7YkVVuONpgakugrafFiwbpKwV2LO8KS1hT56vn+dIsjmBlyAKJfi+VwrB9Uwe1BW62z9jb3ZqDlqosVW6DgRlb4dhezqu0kSxmNwNOa1duV0Ai1Y8KG6QVEeggE0umBEzZlBQDm8msCh1V7LeTIbDhj8liWxqino9b73ZNSJISrlmmTbF6O+2ycmQp0xq9XonB+DSr1BItQNuHQz2cmsOiLUydwyZ6QLUPnthC1bzkRA+tyW0ntoDNDpHq4bY4PUoBn6zb2ZxdtFVgtN28tN93rof7IIsebr77frYv0DqkqiGj8uhhP0zmi2Mdru0bkeYH8naVa27etAMWZNHD1U2jUAM1SqLQgIhNEw6O04V6KPAaEwOxcusZwVFpsqmABJmh87SBmQz+EmjGo742OMPhXoLPZpzXhjj+2f5sdQu+nQgP4MxGPwk8i2GvFeDzZDN9yme3Ww0uSwIPiCAEdxg8L5el4rb4mlIIIZoOCwCb1XiAgVIOBExxY4SsFMEeRynFwj7H2k+OIixsxHVXgbMKvBCefehtB/i1LOGOcC+FAKKysVmGOl7MubkVTIxFe6vVf1ITYmGtnQGUAK3aXBOifavTAWnX7pooHVpeA6ZAjvOB5zA93rZf9o0UcT8UWwppb3Cymk8OxTUYVkRhFajlLP/bDddOAim0w3jMndvOWcsQIoJcgYrnrqvsLONz10ghsnPXWjdXyQCciFJ0jjdjBsCN9W5VTGbTyXpzN39cThaa1sJLOZtrzaTpxFgFgBNBSru1JBZw3UBWITTbQzYDqDuxVeEzmt22wlM2N70dEUmxLg4fqqrWPn0oUxs30miw3TzdrIof81m+Oi+WD/PHNpRIEWfjTEqRd/nqR776smpNF5MBOIFS2o2FqS+FOJvny/bLGRToDgJIgU0Xc62sJymwmgAPwO7y6SpvjfIt4A5CaAFu15vi+bYoNud5+4MccohQDC3ISTkXGS0v5uvv9ggFGfTwLuatjy2osXEBrsCEIwyT5+1yNjlfFNuZXlxrlnAOa7u3ODQe0sLrPqkL0Dgt0NRZDew2f9RgbFvAHYTQAtQLanJsBjHNFJZeSFNDM4hoBvA0O6MUmklfNISlF8KUyAwimBIczOK5Kh4X+Y/8OPFopu3sP3HN0/nz3TkbLUp5j3mrn8SvCbbevm1bwyBS58m+YLvdgX5HIEkch0cz3LPKrKGcHsqbIjrlqkip1PaH0DBQu3JvwDwVkp11fots7DNXvBvGjkHaoNoXfAMGYlD2FgpsLMSVkXZvFt1HL1qpluBz9/lGsVzmLB1zXCzy1URjuYJBOMHlaFlKUF/WjiaPbPa2q8MKYlMGGbwFHA5McNUKkwFab2ZF+3YJCudQlAwMO09vhWVfkgzK8+TvW70bFFA8QnFqUD/H8+fc1mtNGWTwimoFZQVqX5IMynadj6/urLAcilJ2+orGXb9MLGMmEEAIbPl4Uyxso9GhMBmgl1LeZYXhR/vJThQUEEAGbFqb89sNe6IAMmDVy7E6d5ahoGqFCV3YTndJXKdJcOlGo+VtPpnZDSfHsi5wLOeVUjjGU0tB0l4nqbmOM56h5mQcQ9qU8kZMCIAZrvOAKaGWShb47u7KLmbUSpN1C92NNRSR0Y6aHNCRHvm/We3LyeL/OeDZv00/rzb/T+/3H9yrVzDs67rOQVbjYNbrRfWGxua4At9JadZS+1ijxtOaAsfK415QXzfxg2y1HqVd+YlYWg9IXYqCmbrI8xf2hvsEklMNWLVPrW0Cqx8X3/Plh3L9txnsNq+EDFoJErwUGajh8qlakP4+3zyNd0398uHzfL2eLx/boKnKkgH8x93o+qKYtmHZffZbz7piZeDVqvWkJcA2mu1eN5z+gJrXwpYMiL3V6yfHJ+vvo9UsX71DpxLNFnr83rp+8aDKPF+g0bq16pN9UU0H1FWVzRKqn+3A7Is6gal75nI5XWxn+f4SAC1UoAyNh2Tzb63a1bcFN8wClZZlFCz+mvxclwv97Wr5frtYSHMp9TDKxLmDrg3Tf74DOxfSYXL/ZfcDtFCz3eh8UFPiuvvN5NEUyK4MEYIGSamJopWfNEYyLRbF6v3S3C/7Ykccu0udXlbsigQnVJsyNAmTFU1YtXJecM1npojmM19YAK+siQehlAkxsWYxXxv7rVbOCy6U9dLEJiW8CPEtG+SlJrh6QSpkwVl0HDKETVXdNq/aUDVGIO5bakJQ71kaYxD33jUxqPfdjTGUsd9iuKCr/3nyvXGWWxOHWNRLO723DT33HmKP8FSVNFcE4Sacplx6u/2qWk27TctgKcnHUCIwix1qANKMGSUCw27bhCBMuH8vVt/LFdZEr2Eev6ZpBRfD94MvV+P7f4ze3Q/Ox5dfB+PL0fX9+PLzcPRlbIHopFWiZR+q2alFl8+D/+I1DysQdy5KNEVRondYAkHAlsugdqOyC82qC6rXNrCE0oSoHlcvU85s26ASShOiep78Xak6LvaXWdqAw4QQYjRZOEFo6OLJHRHIpDAB1JJAYYWnms6fF1u7plUvTIjp39/sW3utLBK8ik0+BfcrWyFcaPNGEN+hpEd0Vcv9OFnOFnYQxeIecU6r7YtF9d3DovhrtBz+Pc1fhCQ6kzFBIcynDotinZ9PFotvk+l3K9xAAOWQq9xTscXYto+tBHcqqqsy6s2qeNZcwKB4j+W9zcGqeuobdYYQeVGv6HIthg61nwNT145NjzmEuFzYQ52gDpLTjMI6kptGjI+txD7XnyQyAFgv7K/FTV4m0/nm5/B5vtnYDT5NEd7QrjdlGLLrIMei/mzJE34sO3CtsDeEq3wym9vhOxb1hu6fxbe7TVnPsw2+emFvCI/LxfHTKl8/FYvZ++oxq92t2pbzIC2p3nQy3VnAVhTuuwt6OK+K4sUW466sV3yft5vadTaGAPeFvSGs5m83ZQNbb1c5y++3XkVKJXnD/pBvpk+NNA4DyFCAN6SN5EmTdRyWO0k9j+M3rXFDaKU7IrO6pgxfvKP9EgiC3KdGh5broIbSyoTej+V4ma/08kmR2UBTxtszMATZnnvestCESkt2ythax3qR5Ex82expIpwSLQ7t/V10lUGLRXu/G2Ix3vPWsMtqMl+OlnYLsGNZWjpKQPjEeDvbDQyhtEeU1Qb4/jXQHdNohVcixyPyB/6estWc4VCUMviKsez4wqrdqrFe3BtK1jEtIdbKesPHewFf/w2XVlOvpghvaF8sGasXerZKwLV/G8ppM/VY3rO32ZvE4E49m8BZE+INsR0vgK/70SdH7VDVXrQ3gQUesifHlT/PrValu3Ieka3y5+JHPlgsrubrcq1mOQaiUohRC5eC8E/OjykY8hvJpPAbpWnye5BECXs0TokTTfO0b4Q4QJ0bHLoxhthIonAAap9UoQ23kF9XY4r2KMqf+8+rfEuaNrAX5QtsIy/DAS2ap0ELt76adkBqtbo26lwwV8Oxf2G5G8StVsb6uTRfFQvoDF/BURFi3nNWPQLw7gyhg2JKxvCNOkNCIFK4QsEl1tOb7zbl9P5hu7gqHtkeVpWApMNd4eW6P2uowGGXcisxiKwhP01W5aqvnKeuN/OpxmRYibchzAtmLcZWhdNodDHD9m1RTL9rpSepANakeEG53milDqsg7kV4wccYJ8fGeJDhqw064ttJ8IJuvpxX13ggNyRaQcXEee091bV1jrETirJihlrR2+xqKSOo2f6WGb6yxQ31NnZa2q36zid3lJdaBz5bQF4aneIyxniht13XAvLCbO/OHOV8VfZYd5h7MV5wTiVXktnOmbRuJnPEvBJunbNCulJePueIL39+2fwcUgyjgqAOoiir8Mp5eK2L6QD1X6uJRl6bCvBOgh+sdocS2uCeVv/zW6/9unBNwKcHoZ1D3/9HvP+PhE6Zncj92ljnqLLlNO3BOs3oFVpQ/aZ5g4QjiUj9a+ftVxP/Bxk317n9Ute2jQvr4YV6P0p59WcDZZfn7b6ju8mvEnibT/P5j9p6QVX7/uNOr8xr1mx8bZ6o6RFOeDTGcXlWuXG7ZkUO0A7P+DXhoQX9GMgKhbGxcEuoTmyRADw1XL3hAtWjhGyu7Ibbds5so4E4c3bCbTiDtkG7XX5fFn8tafAehREjrvHh1UbvTPssWP3r7rnvRu12jLegsmwKYG2Rk9ztVJwEnXF2UROYCQ+nhUInmwiBAbKJnHHoZQ/hjqJFYpMt1MTVki1kh7J5Y3DbLKT6hmzmVc4Qazc2SmpkH3U60zrWaDxp4BrhCVjnkl0y1c4pKEOTbLXeTFab7UtFaluDOBGF6A5FwAQSgMK9psbIzG44lUOCrfVO2O+StB32Ee3S5HONFFKtDcrv7CuutVM47qsc4DrqywYw3TqNhi+DkUu/fpNxy2TI0kZgNmC1jwIfquTJw5TxZlU8zBetzR4tZN8qDmBqP+8R7B99qL9AUUOirLP9Zcxz3Wc46lFoX0a7co0gvdo95Nz6qJgUyEldhAmkoxzpIWc+Zf3U/pi8HJ0ggxbetFS6jOvz1jf95OjqImjB/SiHmoefmk8zygFCMe4ga+u/D/J76yTojiUcO4HuOlAPh9ZaUGKkmhHkeU9lyFuc49f16CIEQogxSu/G0YRn9HabmfWk96To+xa5K4UGm0vjP5mqE6StUVWPsNli2pUltxN+j5a2oUzu0nLtp+IE3q6b7mV4xfsymX6fPOYX+QNLmkKIHU3QmCCvyBflKqp6f/JzvnkqZk2iQzfoNMR4Rf14e3OuuAlFE3RDilfM4guqhlCbj6h6QMiIdTwJTxOmIMEr1uqItxPUugC/sUzxuLbd+Cl9X9sD+u06Xw0eyw/uNiuHcaMpxrfN6+ckzc3MS1Nj1NrwNwJp8tIliu50qj6HVpWvvr7LN5vScdYDhAD3FBPrpkBze8ybsZvo2w8jGaqBGEjioD+Hw3fD+/Ory+H1+P5q9OH+avh1eOVbz1NptZ7Ub9mv5XA+lOP5HtNw8GF4e38+ur4enjefG/BjDlX9b8Uut8Px7R+vYI99vW/FDtUDDBWmy2HzHQf/1hBrf2s2+WP/qMb93bBswRevaSEMy1ux1+X15fhycLXv5ew1ktHV8HZwfT68//waVmtH9FZs93Zs9tZsxbB9Gg5vBlfV8zBV8+/CMNJq34wVqiDwOoY41PyKtth37dvhrsHevxucfxq9f9+ZTVoQvKJt+GDxWnZR1P6aNrm8fk2byGt/RZt8HI9vAoaNhbd3w/Hvw+H1/c3l9Ye7zkzTDuJNWKjCU3b58fD2a9nnf78cf6yi4MVgPHgFS7WBeRNj1M3w9vPl+IDufHB11floJcHw+i2qjJG8hded12kzkiF4zRlxjUAZ/3Ez7J622dX66quC30e3n4a3JaTrDzejq6vXWHjKIbwV6zBYhyjY7WJJDuF1rHM++Pzl+mJwf/7lbjz6fP/lrgQ3+FA167vxbdnNaWyjUQs1bY1qORp8GX+8v7i8G7y7Gl7Q6taQ3aFG49GnYTVRfH87vCv/+lj9M7q6IGvbBrV51Zp3pMHFRVklkWpQZAf49yQTUQNsCu1OhzK43w6J9gVwwR32oi+3RBs+mNhO9OA98+58RDUHwgV3o8vwekDYSzCxnejBmzVvCoMvF2XrPid2jqSGbnpOuVIajP3qJ62jm3Y4uPt0dXk39qqivJJOdPw8uhhelXMynypK6+ionY4vP1/+6buhyirpRMdynXU3uvKrorSODse388H5x2E50771McbVhXeoU7lu+HSomy0hfCiH1tKJluV87svtsLZJSKseJr6bPsdXtLej0fj+fHg7vr8ZjD96WTQ3quhSP1bv+cdBxSH7UrBZR5ca3txefq0mGZ+Gf/hTEamk01nau8Hd0MMypym92zHdl1pN8d3OOP3ohYnvdJbpRy1EeqezLj9aIdI71YqYq1KJfw29KPmrtiqo9RPvWtku7/LVj7n9oQhBgvtpOfEu3fl6Q3AyCjsVRYIPv3tatxUo7y2zxvSYb6rDSuPie259DA7IoD6HId7hOplv3hcr9iE/Mnib7w7a2MJXi/SqzTrf3KKXFGtCr5X3jfO6cIZaE+EVLftW8saIJlpRBDna+o0Yq7yUdLMqpvl6fblcb6pzYr/PN0+3+Xq72OzfTWQvzxncZqAvlfJWjRde4fFArOEVFoaoTyT1GcVIEwdI1P728rzcC0CfraPSF1bUtaI/8tV6jt8jRKXisYqulXsRC3fTdMXaulZ5ky8ny43fNlurowP16qH1Lj88E7a+zf+1zdcbwzAqkUAZMvNF/lyWs2t1KnwnqGQjF8gMKL0LZTpZUKHfCyMGXG8fx7H5vD5VaAcuFqRsDeAotBUU7ES00Uzl3ODicxeEpwdZDkCtj0QTIKc8GV3TpbkI9+0CL4ekmxqRHZT2qzL5eWkdSxifycPPTHdiGQ9Hp72YSDw+3blpHE9RezEJdpK6c8OQHKj2ah75oepXMxbh2WovptM9X925Ab0ds/ZixjdnvrdotpZT155tRH342o9BwAHs7m3ieg6byixaZ7G7MI+fI9lUZmo9lt2FiehPZ5OZp+2EdifmIT+oTWUe3cPaXVjJ25ltemPpndvu1miejm/Tj3LKI9zdjne0J7mJ25n6NHeHjYv4UDfZ/Ft2sLtrmsntfDftcqTtjHd36xDyo95eDCU97t25oehOfRMYSvvkN4WZ/B0AV7LzJofAKdWkOgtuq5zGeXB6dX0cC9c3AH40nEJLohPipqo0M2/plCFIu7VUByTckqvkmm1r2+Pqid/0Xcsp8dtcJewYOaVSJKfJLdRqnCgnVcr9YLm5SsrD5ZTa0Z4xt+hl6nPmpF2O+Li5RUNtOXJO2mypT56bq9ty+pxSW+pD6DYNWX0QnbYlE59HN1e35Uw66dqC+Gi67bjZPJ5OP3YSnFK3VU9xUp1eT8oD6+YKyw+tU2pKeHbdon8qz697WPpTHWO3VlV2lN2DrmQn2q2VlZ5q96At3eF2++lh4xCuj4mh+1lch2mDZw3Jjrw7zHq9qkh4+t1+putVQ7qD8PbTPa8K0p2Jt1fQDzvn4Xi8s4oeGDtPJ+X1VZ0q3hK0VlD5pKCxIjLowlO4dljdXsRVgVsUj4v8R25y1AgDWBPjAaT4gKgdwuY7onTwjB9IRwHavY+uB3H3um71UK0jTFGSD6irYlPcTJwdXpfjAeYa3N1hB3Lten+HCmL1z7r0lyvIuhwPMDeT9XcW+t1Q1sR4ALld52PnjKiDEB/tcTMrtq7jzEGIB4DT7XpTPN/dOc8wa3JoYOLnWId/b/LlLJ+NHKI7kEF5unVRLB9vioXdwI3hOqlJtLQrNJkswpeVXFbFfxgdcW6BD6RSqfA/v5bQZvnfv/zn/x6ubPjPX4LT8LRfCn6Y54tZWcl/c93Kaovn6qD4L/+z++1rOcUsVtUX/JP/OPvl1/8++zXtnZ7F//M/v/73vgD7/9n/wb7qlX/1kK96wldB+Vfwaxic9rNQ+CwQPgvLv0JEWCh8FcmERcJnseyzWPgsKf+KkDoT4atUJiwVPsvKv2JEWCZ81ZcJ64umrSyd/JrEp/2oJxoX+KAydoo5QfRCr7J2hn0nuqFX2buPVix6oldZvHf2a3R2GvQD8UvRGb3K6L3er3F02o9B5aI/epXhe8GvcXiankXil6JPepXte+GvcVbqk4pfim7pVfbvReiXomt6lQt6mAt7onOCygW9BPkwEJ0TsB6CeScAfaRyQg9zTyC6J6ic0OtjH4ruCVhPwfpwIHonYH0F68aB6Jyg8kAQYB+KvglYh8H6ciC6JqjsH2AdMBA9E7Beg3kmED0TVvYPMM+EomfCyv4B5plQ9EzIwhfmmRDEr8r+AeaZUPRMWNk/xDwTip4JK/uHmGdC0TNhZf8Q80woeias7B+Gv4bpaRaJfSEUXRNWDgjRXhOKvgkrD4QxFjFC0TlR5YIQc04kOieqXBCmv8bJaZgl4peid6JACjMS3ROx8SX7NTk7PUvE0BKBIYb5B3NkJPoniqXWjEQHRWygOUNhih6KKjdEPfRL0UNR5YYIc3okOiiqvBBh3TES/RNXXoiw7hiL/onl/olF/8SB1ESx6J+4ckKEdfFYdE9cOSFKMAvFYBJQOSHC+ngsuidOpNMF0TuxvP/EonfiTG4i0T0xcw8WYGLRPcmZDGUiuifpSVEmonuSQIoyEd2TMPdgnSIR3ZNIZ2iJ6J1E3nsSMEtL5ChF/ySVE2IstCaie5JMilL0TtKXoxTdk55JUaaif9LKCTEW11PRPal06pyK3kkrH8RYLEhF76SVD2IsFqSid9LKBTEWC1LROWnlgRjrtymYRTPflFPa4DRORUumonNSNpPG+m0qOieVTqZT0TdZ5YAY62OZ6JqMuQad/maib7LKA8kZpk4mOierXJD00C9F72SVD5IA/VJ0T1Y5IQnRL0X/ZJUXEsyRmeifTB7bMrDQqbyQoEsd0T9Z5YUEG/Az0T99ttrBPN4X/dOvnJBgjuyL7ukz92Dxqi96p1+5IMVCRl90Tr/yQIr12r7om37lgBTrjH3RNf3KASnWGfuia/qV/VPMh33RM/1M6sM+WIZWDkhjbDrUhyvRygWpZC0KFqNnbDWKLkfPwHr0rPJDiq5Iz8CS9Iz5CHMm/6n+aeWLDHMn/6n+aeWNrIfrBdalZ5VDMsyn/Kf6p5VLMsyr/Kf6p5VPMsyv/Kf6p5VTMnSWzX+rfcsYggzrdr0GeVA5JSsHrd5p3AdiIYHAGQTUYZBDYFRBhjoMsgiMK+ijcbQHeQTGFvRRxgkSCZxJwNkJSCUwwkAGAbiMswk4QwHpBMYa9NFGAwiFHmcUcLiAU+gx6qCPxv5eAEmfyjH9CG02gFnoMQIBX0v1ALnQYxwCvprqAX6hx2iEPt50AcXQY0xCH226gGToMS6hj4YaQDP0AulsrweIhh7jE/o4TwZ8xhiFPtrIAdnQY5xCGSzRb4HLGK0gYctCyNWF8hAGWIdeyPk6tPcA4qEXSvnTHqAeeoxhwOcsPcA+9BjHgM9aeoB/6DGWAZ9f9QAD0WM8Az7D6gEOoseoBnyG1wM0RC/ibgvwj4HfGN9QjkeYfQEX0WOMQzkgod9CmpX7DaUlASHRY7RDOSKh3wLHRTxCoh0IkBK9SBEhAS3RY+xDOX6hcoHjGAFRjl/ot8BxjIMoBzDsW8BP9BgLUQ5g6LfAbzHvb2iYBhxFj1ER5RCGfgv8xsiIcghDv4UEOWfIUR8DrqLHKIkeyj73AF3RY6REDyWge4Cw6DFaoody0D1AWfQYM9FDaegeYC16jJzooUx0DxAXPUZP9FAyugeoi14SyIdMQF70GEdRDnhoRwYERo/xFHiAABRGjxEV5eCIfwz3NvjmBj4YAyKjx/iKcnjEPwauS/ikBJ+iA0Kjx2iLHkp99wCl0UullFMPcBq9lLsOnxIAXqMnJzZ6gNnopdx1fVwucB0jMcrRF/8YOI8RGeXwi38MnMfIjHL8xT+Ge1N8cyrEPwbOY5xGOQLjHwPnMV6jF6Lrth4gPXqM2ygHYfRjQHz0GL1RjsL4x8B/jOHoSeZ/gP7oMZKjHIfxj4EHGc9RDsT4x8CDjOooB2L8Y+BBRneUIzH+MfAgYzzKoRj/GG4w8h1G3IOAEukx5qMcjPGPgQcZ+1GOxujHgBrpMQakHI7xj4EHGQtSjsf4x8CDjAkpB2T8Y+BBxoaUIzL+MfAgY0TwjZEeYEt6jBTBt0Z6gDDpMV6kHOpxEMB/jBopx3r8Y7hHzDeJ8ZYBqJOA0SPlaI99HADuJGAESTnc4x+D/WJGkfRitGUEgD8JGElSDvj4x2Df+Iz7D20ZAeBQAsaT9GK0ZQSARAkYU9JL0JYRABolYFxJL0E9GAAiJWBsSS9BPRgAKiVgdEkvQT0YAC4l6PGtftyDgE0JGGNSjvv4x8CDjDMpx338Y+BBxpqU4z7+MfAgz8xIcA8CTiXgyRkJ7kHAqgScVUlxDwJaJeApGinuQcCrBJxXSXEPAmIl4IkaKe5BmKvBqRWUsQlgusYuXwPNSGhkbDD/pWhSAkza4FkbKZoxAvM2GH3SQznUAKZuMPqkh5KoAczeCLjv0NQRmMDBCBTJwjeASRxBJp8EBzCRI+ArPmzWHgCCJQj5ig9jQgLAsAScYcG9DBiWgDMsaO5QABiWIORDH/4t8BxnWFDyOQAMS8BolHJehX4LPMdolB7KPgeAYgkYjdJD6ecAUCwBo1F6KP8cAIolYDRKOadCvwV+YzRKDyWgA0CxBJxiydDWDhiWgDMsKAMdAIYl4AwLSkEHgGEJOMPSx3OlgN84w4Jy0AFgWALOsKAEcAAYloCxKOVcCv0W+I0zLH3Ub4BhCTjD0kf9BhiWgDMsKPsaAIYl4AwLSr8GgGEJOMOCkqoBYFgCzrCgrGoAGJYg5iluqN8AwxIwFiVA2c8AMCwBTwc5Q/0GGJaAsSgByvoFgGEJGIsSoKxfABiWgLEoAcr6BYBhCXhiyFnya1QGSvFTQLAEjEQJUNIvAARLwEiUACXyAkCwBIxDCVAiLwD8SsAzRFAiLwAES5Dw5ETUbYBfCRiFEqBEXgDolYAxKPj2ZwDYlYDnilTjBTK2AHYlYAxKOcnCqNIA0CsBp1dQ2i8A/EqQypN6AkCvBIxDkWgH+JWAUSgy7QC/EqSRQjvArwQp9x0aTgC9EqTcdyk6hwD0SsAYlADPlgXsSpBy56ENE5ArAU8nCdDVaADIlYDxJ+WkENs6DQC5EjD+JAjw2S0gVwLGn5TTQhQGIFcCxp8Ekhxa4D1Gn5TzQlww8B6jT8qJIf4xcF/GU4PRsAKolUCRZxIAZiVg5ElQkYpIewPMSpD1FS0ZMCtBn7uvj04uAbMSMPIkQFN2A0CsBIw7CdCs3QDwKgGjTgI0cTcAtErAmJNyyvlrFJymvQx8DJzXl+fWBYBWCRh1Us5PURDAd32F7wCrEjDiRBKEAKkSMN6knPeiGGCG95ncECHgVMIzedQMAaUSMtZE0n5CQKmEZ6G8ZYaAUgnPuO/wtHSQ881Ik3Kqjn4L0r7PuOsyNPcaECrhGc/KL1v82WmSwY9B9jfjTPAk2xDwKSGjTAKcsg0BnxIyyiTAKdsQ8Ckho0wCnLINAZ8SMsokQPOcQ0CnhIwxCXDGNgR0StiL5KEiBHRKyBiTAM1jDgGbEjLCRNI4AZkSMr5ECgJ4j/ElsnYByJSwpwibISBTwuBM0ewBmxIG3H1oswdsShgE8rE3BHRKGITysTcEfErID8LgY28ICJWQH4bBx94QMCohPxCDJpiHgFEJ+ZkYfOwNAaMS8nwVfOwNAaMS8rMxaAJ5CE/HMNZE0uLgARl+QkbSLuAhGX5KptohQNpF46AMcx+aph3CszKhYtgL4XmZUD7shfDITJio1APeY8yJVD3gvVARO+HZmbCvCIeAVwmjM0WgBcRKGKliJ2BWQsaeBGhKegiYlTDi3kO5wRBQKyGjT4IY5QZDwK2EjD8J0KTzEHArYZQoIjggV8JIFTwBuxIyBiVAM9pDwK6Ekfx0QAjYlTA+UzQ4QK+EcU/R4AC/Esbce2icBfxKyDgUCWLAr4ScX4nRRVkICJaQEyxojn0ICJaQEyySTg0YllBx5iYEDEvIGRYZYuA8fvAG76eAYgkTVdcDJEvISRZJpwYsS8hZFkk/BTRLyGmWGD1kCGiWkNMskh4CeJaQ8yySHgKIlpATLQkavwHREiapYlwHTEvImRbJuA6YlpAzLZJxHTAtIWdaJOM6oFpCRqcECRoNAdUS8kwWybgOuJaQcy2ScR1wLSHnWhL0VCegWkJOtUg6FOBawlQx7QRUS8joFEkfAVRLyKkWSR8BXEuYqgY+wLWEnGuR9BHAtYSca0nQdQCgWkJOtUjGMkC1hJxqkYxlgGsJOdeCnrsJAdUScqpF0lMB1RLuqBa8pwKuJWR8SoAe1QkB1xLuuBa8pwKuJeRci6SnAq4l3HEtuPsA1xJyrkXSUwHZEnKyBT1hFAKyJeRki6SnArYl5GyLpKcCtiVkjAqeAh0CtiXs8yRAvMUBuiXkWSzoZmkI6JaQJ7Ggm6UhoFtCnsOCbpaGgG6JeAoL6o4IsC3RGe966a9hVraKDHwMTm7zDBb86DZgWyLOtqDnviJAtkScbEGPfkWAbIk42YKe/ooA2RJxsgU9ABYBriXiXAt6BiwCVEvE6JQAPQYWAaol4lQLmp8QAaYl4kwLmp8QAaIl4kQLmp8QAZ4l4jwLmp8QAZ4l4jwLmp8QAZol4jQLmp8QAZYl4iwLutMeAZYlYkxKgO60R4BliTjLgu60R4BkiTjJgu60R4BjiTjHgu60R4BiiTjFgu60R4BhiTjDgu60R4BhiTjDgu60R4BgiTjBgu60R4BfiTi/kqEJ0xHgVyLOr6Bb7RGgVyJOr6Bb7RGgVyJOr6Bb7RFgVyLOrqBb7REgVyJOrqBb7REgV6JQfoYrAuRKxMkVfMIWAXIl4uRKP/41Sk+TPrgPA5Ar0e4aEjStLALsSsSvIsFvsADkSsTPBGG7zBHgViLOrfRTbESMALcScW6lL7mZA/gu5L5DgwTgViJ+MQmaHhDBm0k4tSIZueDtJPx6EjSXIIL3k0TyUwoRvKGEMyuSRtG4pEThOnhPCb+o5CzAZmsRvKqEkSchmtEQwctKIvkEJYLXlXBeRaYd8J2CWIkAsRIx7kSmHSBWIn51yRl6CCMCxErEby85Qw9hRIBZiTizgp69igCzEsXyu7MiQKxEsWJtFwFmJeLMiiRUAGYl4szKWYrtCEWAWon4hSZoNkgEmJUo5j0P7aWAWYkYeRJWtihtHMC7cYD3OLMiCW6AWYn45SZo7kgEiJWIkSdhD53DR4BZiRh5EvbQc4wRYFYifs1JD29wgFmJ+E0naEJIBJiViJEnYQ899BMBZiVi5EmI51dEgFmJOLMiCYaAWYn4tSc9dK8pAsxKxA8J4e0eMCsRZ1Yk7R4wKxFnViTtHjArEWdWJMMToFaiVHHJE2BWIp7Fgg6RgFiJUu49NO06AsxKxJkViUMAsxIx8iREz9tFgFiJMsWUBfAqEedVJCYGxEqUye99igCvEnFeBbUaYFUixpyEQQ/HADzHmJMQvbAuAqxKlMmvC4gAqRJxUkVmCHhJF+t46GV4ESBVoqyv0g64jvEmIZr4EwFOJWK0SYjenxcBSiVitEkYoPf0RIBTiRhtEgZ4TwKcStSPFMMN4FQinsEiGRYAqRLxFBZJ/wCkSsRzWAI8YAFWJeKsCt4uAKsS8SQWSbsAtEp8phj2YsCrxDyLJejjH4Mb13gaC57nEQNiJT7j20Hoye4YMCvxGZ9yYgNqDJiV+CyWOzsG1Ep8xhnpAL3TDXArMedWcGfHgFyJz/iFOFj3iwG5Ep/JjybEgFyJObmC+zoG7ErcU7kP0CtxT9H/YsCvxD1F/4sBwRL3uPvQmUgMGJaYMyySVgQolpgnskicDTiWuKfofzEgWeKeYuSLAcsS9/iiIcatATyouHElBjRLHCiGvhjwLHEQKLwNiJaY37mCZobFgGiJA/mKLwY8SxwoVnwxIFrigHc/9KJEQLTEAd+NRa8rBERLHMiDZwyIljjoKwIRYFriXRoLtr6IAdMSMzIljLDpUAyIljiUL9ZjwLPEIb8tBw2GgGaJOc2C3tUZA5ol5jksaBpbDHiWmN/7it/YCWiWmF/9KrlgEzhud/kr2ioByxKHiqTpGNAscaTYho0BzRLzDBZ8jykGPEu8uwgWXeDEgGiJ+V2w+J2bgGeJI0XSdAyIlpgTLRHKhcaAaIl5Cgu+xxQDpiVmbAp+HU4MmJaYnw/CL5qIAdMSR4pRD94PG8sP5MXwilh+QAj3NLwklh8QQvejYnhNbCw/kBfDm2IZlRKiiWZx465Y5jo0BSqG18UyIiVE79uM4Y2xnGRBr9yM4Z2xnGNBE6BieGss51jQNKUYcCwx51jQBKEYUCwxvzwWvX0zBgxLzBkWNOcnBgxLzBkWNHUlBgRLzAkWNMEkBvxKzPkVNFkjBvRKzOkVNKUiBvRKzOkVNI0gBuxKzNkVdLM/BuRKzC+URbfkY8CtxJxbQbe3Y0CtxKliRyEG3ErM6JMQvXAzBtRKnMozxmLArMQpdxzaIACxEnNiBd2njQGxEvOUFXSfNgbMSsyZFXSfNgbESpzyW5rRBgF4lZjzKug+bQx4lTjjdwGjDQLwKnHGL9NGGwSgVWJOq6D7tDGgVWLGnYQpemVADIiVmBMr6EZtDHiVOFMszWNArMQZ9xw+IgJmJeZHg7Iz/GN4wTbzHbqvGwNmJd4xK/iiCjAr8Y5ZwRdVgFqJObWC7hjHgFqJObWC7hjHgFmJebaKZOEDmJWYMytZ9GsUnvaTPvgYuI8zK+j+cgyIlZhxJyG6vxwDXiXuS59JiQGrEvNratGt6BiwKvHuaBAe1wCrknBWBd23TgCpknBSBd+3TgCpkqhIlQSQKgknVfDr8hJAqiScVOmjlxcmgFVJOKvSR7cpEsCqJJxV6aO3ZCSAVUnOUnm0SACrknBWpY8eA00ArZIw6iRET6AngFZJemcKnwBaJeFJKxKfAFol4bSKxCeAVkk4rSLxCaBVEk6rSHwCaJWkFyt8AmiVhNMqEp8AWiXhtIrEJ4BWSXrcgVi/TgCrknBWRWY54EDGnMgsB2iVhDEnMssBWiXhtIrEcoBWSQLF2JcAXiXhvIrEcoBYSTix0kfXmQkgVpIdsYISUglgVpLdqzlooEsAtZIE8ou+E0CtJDyHRdJPALWShIrN9ARwKwnnVvDxOgHkShIG8mlDAtiVhLMr6JURCWBXEs6u9PGgAeiVJOQXjqFPRAB6JeH0isTXgF9JOL8iQwHcx48IoRkkCSBYEsahROhtFAngVxJGoURo7kYC6JWEMSj4pbkJYFcSnsWC30aZAHYl2V1uizEKCWBXEn71CsooJIBcSfjVKyhLkABuJeFXr6DsQwKolYQnsaCMQgKolYQ/uoNe4ZEAZiXh7+6gV3gkgFlJ+NM7aPJIApiVhLEnEXqHRwKYlYQfDZIMqIBaSfgTPGiKRwKolYS/woOmeCSAWkn4OzzohR8JoFaSmF/yh/YMQK0kMX8rCe0ZgFpJGH0S4TkbCeBWEn4yCL26N4GP8iSqgAkf5mEESoTmdyTwaR5GoEQ9dM2SwNd5+PM86EW/CXygJ1EcqUzgIz2qV3oaz/QkKlMA5yWpSj3gvYR7D22Z8MGehDsPb/KAYUlSxWUCCaBYEsUVLAlgWBLOsEhsASiWJA0VtgAcS8I5FsmkApAsiepgUAJYlkRxMCgBLEvCWRaZfsB9qvyVBPAsSaryHyBaEkamRGiySwKIloSRKRF6uXQCiJaEkSkRmjuSAKIlYVxKhKZ4JIBnSTL5Hl4CeJYkU+zhJYBnSRiVEqHpIAmgWRLGpERoOkgCWJaEsyz41m4CaJaEMSkRvqORAJol6XPXpejYD2iWpM99l6GSAc+S9Lnz0CNSCSBaEsalRCG6f5UAoiVhXEoU4vMVQLQk/G5bPKshAUxLwi+3LVsGKhk4kKewSKbSgGxJONmC70cngG1JGKES4Y+AJIBtSRmjEpWRCMGcArolZYxKFCb4x+DdM8aoRNVjak0YKaBb0jPuwQyXDN4/46eD8E3FFNAt6Rn3YB+HAd5BY4xKVN1ljMEAb6ExRiVCd49TwLaknG3BtzZTwLaknG3B+2sK6Ja0dybvrymgW9JeT95fU0C3pL1A3l9TQLekvVDeX1NAt6S9SN5fU0C3pL1Y3l9TQLekvUTeX1NAt6SMUZH01xTQLSmnW/D+mgK+JeV8C95fU8C3pMGZvL+mgG9Jg56ivwK+JQ0CRX8FfEsahIr+CviWNIgU/RXwLenuQha8vwK+JQ0SRX8FfEsapIr+CviWlHEqEZrBkQK+JWWUSoRmcKSAbkl3dAveXQHdkoY9RXcFdEsaBoruCuiWNAwV3RXwLSmjVGTdFfAtKedbJN0VEC5pmCi6KyBc0jBVdFdAuKSccJF0V8C4pPzgkKS7Asol5Y8aS7or4FzSqKforoB0SaNA0V0B6ZJGoaK7AtYljSJFdwW0SxrFiu4KeJd0l9OCd1dAvKT8rWNJdwXMS8qZF0l3BdRLyqkXNDEqBdRLunv1GH3BFFAv6e70EN5dAfeSxoGiuwLuJeXci6S7AvIl5eSLpLsC9iXl7IukuwL6JeX0i6S7Av4l5fyLpLsCAiblBIykuwICJuUEjKS7AgYmVZ0gSgEDkyaKXNwUUDApp2Ak3RVQMCmnYCTdFXAwaRIpuivgYNIkVnRXQMKkSaLoroCESXe3s+DdFZAwKSdhJN0VsDApZ2Ek3RW+nJzyLoixnyl8O5kRLRF66VoKn0/ekTB4d4VPKHMSRtJd4TPKaaTorvAp5TRWdFf4nHKaKLpr40nlVNFd4avKaaborvBlZc7CSLorYGFSzsJIuiugYVKe7yLproCHSTNFMnUKiJiUEzGS7gqYmDSLFN0VUDFpFiu6K6BiUk7FSLor4GJSzsVIuisgY9JMcT9SCsiYlJMxku4KyJiUkzGS7grImJSTMWj6bAq4mLQvT6lOARWT9hXnn1NAxaR9OZOWAiYm7auGQMDEpJyJwXN4U8DEpIxsiWJ0BzQFTEzKyJYoRp/rTAETk3ImRhJhABOTcSYG393IABOTcSYmxp8ZB0xMxpmYWCI5AB+zDhijiccZYGIyRrZEMbqnmAEmJjtT5JxlgInJeOILHjQywMRkquNEGaBiMn4tLh4HMkDFZGd9eYTJABWTcSoGD84ZoGIyTsXg8TYDVEzGqRi8a2eAisk4FYNmCmeAicl68kPsGSBisp4iMT4DREzGiRg0BTkDPEzG017w1LcM8DBZT3EFQQZ4mKwnv4IgAzRMxmkYPMBkgIbJOA0jsQWgYTJOw+ABJgM0TMZpGDzAZICGyQLFFCYDNEwWxIoAA2iYjNMwkgADaJiM0zCSAANomIzTMJIAA3iYjPMwkgADiJgsVCwiMkDEZKFiEZEBIibjt7dIAgwgYrJQsYzPABGThYopTAaImCxUUKEZIGKyULEbkQEiJgsVRFoGiJiMEzHokYEM8DBZqOiBgIbJIsU2fAZomIzTMOhZhAywMBlnYdCzCBkgYTJOwqBnETLAwWT8/ha8cQIKJmMsS4re9JABBiZjJEuEnnHIAAGTcQImQW80zAABk0Xy03wZ4F+ySJG0mwECJuP3t+Ap4hlgYDKe/IIetcgAAZPx5BfsYoEM0C9ZrEi3zgD9knH6BT3CkQH2JWMEC/7keQbIl4yTL+hxjwxwLxnnXtATHBmgXjJOvaCnMjLAvGS7S3HRrgGIl4xxKxF6KiMDvEvGM1/QUxkZoF0yTrugpzIywLpknHVBT2VkgHTJOOmCnsrIAOeS8QtxsWz2DDAuGWdc0AMcGSBcMp71gh7gyADfknG+Bb1oLwN0S8bpFvT8RgbYloyzLehFexlgWzLOtqAX7WWAbckYoRKhBzIyQLZknGxBj01kgGvJONeCHpvIANWScaoFvWgvA0xLxpkW9CBEBoiWjBMt6EGIDPAsGedZ0NMNGaBZMk6zoAcWMsCyZJxlQZ+0ywDJkvFcF/SevQxwLBnPdUHv2csAxZJl8tzODDAsGWdY0Dv5MkCwZJxg6eMjESBYMk6woJfyZYBfyTi/gp4+yAC9kjEGJUKz4jPArmScXcFzgzPArmScXUGzmTNArmScXEFvuMsAuZIxAiVGk5kzQK5kjD+Jz9B83wyQKxkjUGI05zgD5ErWl0dKQK1kjD2J0fTkDDArmfw4UQZ4lYxRJ2V/w6Z+gFbJ+HEiXKzotT7jTeIzlE7sA1Klz6++xeT2AaXSP+Nei7FE5j6gVPr85ltcbgg+5U5Dp4l9QKj0GWcSo0nEfcCn9M+427Dm2wd0Sv9MfiNgH7ApfUaYxGfoxO//L+3clhvHlTX9Ln29YkY4E/MG8ww7djhUtlyl1bbkkeSqrp7Y7z4kTsxM5k/3jrlZ5dUAkhRxSnx5QBY0JRdgElQn4ixgSi68JBj1HJwFTMmFlwSjku4sYEouvCTojuVZwJRcgElYPMuVjhY0JRdiEsw8KuL/cFMUlUXvFWIS9NxvWeCUXJBJMGo8YxY8JRdkEoyajTMLnpILMgl6ErMseEouzCRYlWRkAVRyYSbBqqfVLIBKLswkWKt+OgFUst2bfQKo5MJM9JUlC56SCzIJ+jXIWfCUXJBJ0FM0ZMFTckEmQU9BkQVPyQWZBN2MlQVPyQWZBKuaKrLgKdnWDtSHhuApuSbDtfoIFTwlO5wWMAuckgsxCVY1a2SBU3IhJsGpVxJkgVNyISbB6auGwCm5EJOgXt2XBU3JBZgEp978kgVNyQWYBKdGo2VBU3JNh6vuDgKm5AJMgu42ngVNyTVPiypXsJTszc6CIWBKLsAkOH1UCJqSfe08fd0SOCX72nnqHiVwSva179TLdbLgKbkwk6DmD8qCp+SCTILq1ZkFTskFmQT9TosseEouyCR4FSNkwVNyQSbB62uL4Cm5pmlRg6qy4Cm5QJPg9SEkiEou0CR4lWRmQVRyoSbBq/GaWSCVXBPi6qwmC6aSQ+0+9cK6LKBKDlDnzIKp5FBz7OjDXkCVHKDSmQVTybGum/qWKqBKjjXHjr68CaqSCzkxTr1xJQuskgs6MU4fnYKr5MJOjFNDc7MAK7nQE+PUy06yQCs51jA+9RLRLNhKLvzEODU5cBZwJReAYpw+4gRdyYWgGKd3tsArOdULM/QeFHwl14S4+p05WQCWnOqNGXoPCsKSU82TpPegQCy5YBTj9R4UjCUXjmL062qygCy5gBTj9R4UlCWnGomp96DALLmgFAPWDMFZcmEpxus9KEBLrllxvd6DgrTkQlNM0HtQoJZcUYvqrpMFasnVm8XodUX/FZxigj4yBGvJBaeYoI8MwVpyTYwb9JEhYEsuQMUEfWQI2pILUTFBHxkCt+RCVEzQR4bALbkgFRP0kSF4S861//SRIYBLrt4sQR8ZgrjkAlVM1EeGIC65UBUT9R4UyCUXrmKi3oMCuuR641DUe1BQl1xvHIp6Dwrukmty3Kj3oAAvud45FPUeFOjFHOqtQ1HtwlbKqpdOjGontlJWvXRjVLuxlbLqpSOT2pGtlFUvXZnUrmylrHrpzKR2Zitl1Ut3JrU7WymrXlVSlbG0Ula9aKVqxrxWyGoXtVTNmdcKae1KZdSsea2Q1a6HepUAtFJWveim+uVsrZRVL9qpmmmvFbLaRT1Vc+21Qla7HC9UH5pWyGoXBVV1dmmFrHbpTtV83gpZ7dqboPON7M5KaFRTdyuktSuiUY3drZDVLt2pmqVbIatdelNNvtcKWe3SmapNuBWy2qUzVettK2S1S2eqNtlWyGqXzlStsq2Q1S6dqdplWyGrXTpTtcy2QlYbHjlaGa3sKi9VEWgrZdV3eFsrZdVLZ6pm4lbIapfOVA3FrZDVLp2pmopbIatdqZsK0lopq165m4rSWimrXsmbCtNaKate2RvYs5zs0MpvVEN3K6S1C6UJqqm7FbLapUNVC3YrZLV3LuZopax67VB9BnnZoe1aIzXbVCtl1XfyabVSVr30qGpSb4Wsds1Urt7H0EpZ9QLjNHeTVsYqF98m3W+xldLqYed+qlbKqtcO1VeWIDu0ch3dAaeVsupu77ME2aP1Fmn9swTZnzULL/osQfZn2Ln4oZWy6mWGqt4MrZDVLhN0Ui2mrZRVLxN0Um/2bKW0eo1aQl8xyh6tNx/pXzHKDq15edFXjLJD447zUytl1cuaq/pjtEJWu6y5Orpspax65XVAG46yR2sAE/gsskNj7VB9UYyyP2PefRPZnzWTjP4mSfZmITtBdT1phax2mZ+TSs1bKateFtxJ5eatlFWv3amvFUl2Z+E7QXVCaYWsdulN1Q2lFbLaZXqqjiitkNUuvam6l7RCVrv0JtookuzNQnlC9rqKM8n+LJwnZNWbs5Wy6qVDVUeTVshqu73ZPMn+LLgn6J4prZRVD3sfZpI9OtUe1UfLJHt0gkC9lbHKtUP1oTXJDi3QJx5Uc3IrpdUztGi1Mla5pMY7qJbAVsqq2x3ZsjcL+IkHsE1k2Zv1ImogW/ZlvYj6AA7BWfZlvTYJyJZdWeCPbgpvhaz2VN5EX2qz7Mu9m5NaKaluDjVpl5rQspWy6jve+q2UVbc7G7ORcMgcan+qRrFWyqr7Ul0/UxgJh8yh9qgapNFKWfVYqqvWrlbKqtdLJVRbeitl1aedRdFIOmQKAIpGV+WNxEOm5f7Vlzkj+ZAxZmf+G8mHjMFz1Eg6ZIzbmf9G4iFj8Bw1kg4ZE3bmv5F4yBg8R42kQ8aknflvJB4yBnoPtDJWOeP5byQcMoX/RDWNYytktaHzXCtjlW0Rre77RrIhU9mQ7nvRSln1aohWrdatlFUvnWnAB5d4yBQCFHWHsFbKqpfuNCpfb6WsellzTQTSZYdWdx74MrJHXe1R9ehsJCIye/dbt1JWvfapeidYK2XVy/w0qgNHK2XV/d4YkJTIVEqExoCkRMbFvTEgKZFxaW8MSEpk3LQ3BiQlMi7vjQGJiUzFROhlJCcyNWWwmm2xFbLaO0uupESmgKCoJmdshay231EYjKRExu9cZtdKWfWd+OFWyqrvYSIjMZHx057CIEGR8XlPYZCgyBQUBBUGCYpMMHsKgyRFprAgqDBIUmSqDxBSGCQpMoUGQYVBsiKzy4qMZEWm0KCopvRshax29YNVHX1bKatePWFV791WyqrvTlPJikyhQVG/Nq2Vsup1mqoOYK2UVS+dqif3bqWseg0kUB1oWymrXr3SdYpmJC4yFRfB6rJTY+1U9SRtJC0yhQhFq+9hEheZuBMt3kpZ9dKn+r2WrZRWT4e9fUASI1OJke722kpZdbu35UlkZNKOs14rZdX93rYhmZGpzEh3E2+lrHp1l1U9YFspq44Zg5HQyFRopHvBtlJWHVvRjGRGZqqzFGglkhmZaUfplcTIFCgUgVnESGRkJhg10spYZb+31ElgZCowQkudBEZmintLnSRGZkp7S51kRqZgIbjUSWhkKjRCS52ERiYf9pY6iY1MxUbq/citkNWuXQoOgpIbmbxHAY3kRqZyI8D0jSRHppIj9Z7kVshqxz31S6IjU+hQdCoMMhIdmYqOnMrGjURHBsdztTJS2RY0FNXbdlshq40nqJXUyB5qb6pbi5XQyFZopHqrt0JWu+hF6nW3rZDVLl2pOqy3Qla7TE/VZb0Vstp4rbUSF9kChKKaM7UVstplaqpZU1shrV1wUFQTPLZCVrtMTDXFYytktUtXqtnoWiGrXbpSzUfXClnt0pVq6qxWyGrXrtQ7XqIiW3BQ1H23rGRFtrIi3XfLSlRkCw6KQV+srIRF1uQd5cZKWmSrK5Hux95KWfXSncDXy0pgZCsw0r1SWymrXjpUTxvTSln10qNBN85ZSYxsC/zS3dqsJEa2EiPdO8xKYGTbFVL6OddKYGQrMAKnOSuBkW3ASN/4rQRG1u0dWqwkRrYmN9YT4bVSVr12qj6RJDCyzu19GAmMrPN7H0YCI+v2NCIrgZGtbkVA37ISGFm3pxFZCYys2/NasBIY2Xq7FPzsslMLEopq5pxWyGqbHT3BSmBk/c4li62UVa9+KDqmsZIZ2epZBDCNlczI+srp9ZOClczIVmak549qpax6JfU61bGSGdnGjHSqYyUzso0Z6VTHSmZkGzMCw10yI1udiwDVsZIZ2cqMANWxkhnZsKfnWsmMbNjTc61kRram49FdXK1ERrYiI93F1UpkZAsUirqLq5XEyNa7vtFwlMTI1hAy1b3ESl5k454pzUpeZKtvEfqGkhfZyot051wrcZGtuAg4l1mJi2zcnaUSF9mapkf/LBIW2Xo/Ffwssj/jTmbIVsqqlzmqeyFbSYts3MO6VtIiW2mR7rRsJSyyaSfFbitl1fcs3lbCIltwEPjmEhXZelsVWqQlKrJpJ7azlbLqdYLqqrokRTbVCaorUxIV2bS7kUpUZNOe+5+VsMhWWKT7flvJimzNmYxGrqRFtmZNRv0vaZGd9hw6reRFdsIOnVbSIlsvsUL9L2mRnfYcOq2kRbbSIt0n3kpYZNuN4egryh6ddq6BaKW0et5z6LQSFtmMHTqtZEU276TBbqWs+p5Dp5WsyNZbrfTkS62UVa+5mnQHMythkS04KOru/1ayIltZke7+byUrsgUHzedmfY5KWGQLEIp6tICVtMhVWqR73DtJi1whQlH3uHcSF7nD3pnUSV7kKi9K+pnUSWDkKjDSXe6dBEauAiPdKd5JYOQqMNJdy50ERq56GKm55lohq122UN0/20li5CoxUvPNtUJauxIjNeNcK2S1S2/qPs5OEiNXLxdXE5W2Qla7dKbuhuwkMXKVGOmuwk4SI1fzLINFyElk5Kp3kboIOUmMnNm5da6Vsur10ivd6uMkMnIFCqE1y0lk5KqDkZqQrxWy2rU79SEugZGrwEj3iHaSFzmL1SEnaZGrtGjSbURO0iJX/Yuy7uTmJC1ytnJ5PaTISVzk7J6C6yQuchUX6e7ZTtIiV3gQfnXZn5UW6d7cTsIi5/Dm6SQqcjUBM/oqkhW5evU4GreSFTm3dwB1khU5V3tUX1gkKnI1D7OeHLuVsuo4GsJJUORaJmY1S3crZdXz7meR/en3ApacJEWuehapKR1bIatdJqia1LEVstplvdW97Z3ERK6AoJj1pUJSIlcpke4O7yQkcg0S6S4CTkIiVyGR7hDvJCNy9YIsPZlzK2XVlx5Lau7IVkhrFwiU1AvrWyGrvcf9nCRErjCgpGabbIWs9p5y6yQgcgUBJTXnZCtktUumbd1v3Uk+5HbDz5wERK4woKReCN8KWe1pR6mQfMhVPqTfQNBKafVY+1OfExIQuYKAkposshWy2rU79Tkh+ZArBAj9TImHXKy9qdMkJ/GQKwgoGbAJSUDkCgJKet7IVsqq79w90UpZ9WlvtEhC5AoDSrqfs5OAyNXwMzTlJCFyaQ/5OUmIXGFAyeiTSAIil/a6VBIiVxgQ7CNJiFwKe30kCZErEAgOGImIXNrtUsmI3N7F5q2UVa9dqq8uEhG5QoGcfgVXK2XV97C8k4zITbVL9cVIIiJXERF8F9mnLQYNvYvs090YNCchkWsxaOA0LCGRKxwoGX2tk5DIVUgEf6ns0qnGFeowxElI5KpHEfqlEhK5vMf9nMRELtc+1ddpSYlc3u1TSYlcvXALvovs01znqb4LSEjk8h6ad5ISuUqJgD3MSUzkCghKIF7ASUzkCglKupu7k5jIH/aMLV5yIl85EXh1L0GRP9idV/cSFPmCgpLuRu8lJ/KHmmxB957zEhT5woKS7kHtJSjyLRZNt3B4SYp8gUHJqluMl6TIFxiUrLqSekmK/KF2qLrWeUmK/G4gmpeoyBcalHQXZC9RkS80KOkuyF6iIt8C0cBgkazIFxyUrDrnvGRF3uyheS9ZkS88KFn1NOIlLPIFByWnziEvWZEvNCjpnpNeoiJfYFBSc++2Qlq7wKCkuzZ6SYp8I0VgvklU5G1lC2pWs1bKqle2oJ+5vaRFvvAgp9+61UpZ9WI8y3rgv5e0yO/SIi9pkbe1R8FiIWmRt7VL9TknaZG3tUv1SSRhkXe1S/VJJGGRd3u6rpe4yBcglHTfTC9pka+haGi8SFrkKy1C40XSIu/C3niRuMi7uDdeJC7yrgJd0KMSGHk37Q0ACYy8q12qrxeSF/l6f5ee0b6Vsuq7fSqBkS9MKOk+sV4CI1+YUNJ9Yr0ERr4woaS7uXoJjHy9ykt3c/USGPmChJLu5uolL/IFCSXdzdVLXuQLEUq6m6uXuMhXXKS7uXqJi3zFRbqbq5e4yLdb1cHAkrjIFyLkDrr67yUv8tWhyOgaupe8yFdepPvcesmLfOVFus+tl7zIFyKUdJ9bL3GRr/5EIEDAS17kw55120tg5MOevcVLYOQrMNKTN3oJjHzcA4BeEiNfiVHQJ4UkRr5AoQxGiyRGvjChCQwWCYx8QUL6DdKtkNWupxZ9MZe4yBcgBE6tXtIiX3hQ0q+6bKWs+tJhGaz8khb5VHtTXykkLPIFByU9oaWXrMhXVqS7LHvJinxlReCDS1bkqzcR+OASFfkCg9A3kaTIV1KEPrgkRb4mKwIRdl6SIp9qd+orogRFvjoTgcAjL0mRn3ByGy85ka+cSL/WqJWy6jiK20tM5Cd8X0orZLVx3gwvGZGf6kqrr8sSEfmKiEC4pJeIyFdEpLuFeomIfE1UhLpeIiJfEREIrvQSEfmKiEDeMS8RkS8QCOVX8xIR+XplmH45RCtl1YsqFHUnOC8Zka/3huk3RLRSVr1Yz0DIrJeQyOe99BleQiJfIRGIPPQSEvkKiXT3XS8Zka+MSHeC9ZIRheZKpK/9QTKiUCgQioANkhGFA56iQRKicKgJUfQuChIRhQOeo0EColAvFdNT8rdSVn3PfBYkIQqVEEV96AaJiEJ1JgKVJ1m5ZCdXbyBqhbR2YUBJ98YNEhCFCoh0J9UgAVGogEh3Ug0SEAWzl+svSEAUdjIVBcmHQs1jDWXL3qx8SPdoDZIPhYKALNDKgwREoQIi3dEzSEAUKiDSXQ6DBETBVjuLaq4KEhCFgoCS7qAYJB8K7bYxMAwlHwoWX6/ZClntmi9DZw9B4qFQQ8/AthUkHgoFACXdWTJIOhRqLmuwNgdJh4Ldy60QJB4Kdm8LDZIPhZarSN9XggREoSAgtFEECYhCS1akp+QJkhCFmtAa6FtBEqJQGBBQoYIERKGGngFFMUhAFFpGaz1zd5CAKBQElHQP2CD5UKh8SPeADRIPhZrPWr83rJXS6oUAoc8i8VDwezpukHgo+J07AVspq16UIj1ddpB8KFQ+pDvjBsmHQuVDujNukHwoFASE1gvJh0K9ngyYzoMERKHeUAaywgdJiEK9owyENQaJiELYSz0VJCMKNegMxFgGyYhCTWkNcGKQjCjUREX6FZmtlFX3e2NXQqIQ9vKfBEmJQr2yTL8os5Wy6nWS6vuupEQh4Jx/QTKiUFNa69f1tVJaPdYwbvAVJSQK1atI9w0PkhGFuJd1PkhIFGJNEQeGl6REofoV6Z7nQVKiUN2KdM/zIClRqF5Fuud5kJQoxMoV9Fj4IDFRqDmt9UsrWymrXjQj3a89SEwUKibSPdWDxEQh7W6jkhOFyol0x/YgOVEoKCjp/t5BcqJQfYp0f+8gOVFI9RgKVi4JikLaPbZIUBRq1BlICxQkKAppZ4JKThQKCUJpgYLkRGGHEwXJicK0dwFPkJwo1JzWSLWQpChMe1nEgkRFYdrTiiQrCtWfSL+Kt5Wy6mXBBT5iQcKiMNV7PsA5VNKiMO1dwhMkLQqVFoHkFkHSopDrFNVXfwmLQsFBSc/eHiQrCtWdSM/eHiQqCvWCeXDTVJCoKBQYlPRogiBJUch7N7cESYpC3ru5JUhSFPLezS1BkqKQ925uCRIVhYqK9NCGIFFRPOzdxRMlKoqHvUSrUaKiWO+eB9tilLAoNlikr11RwqJ4qH2q7i5R0qJYaRFQuqKkRfGwd3aJkhbFevEZULqipEWx0iKwSkfJi+IBp52KEhfFGnoGVukoeVE0OO9UlLgoVlykB05EiYui2eELUdKiWN2JgMUqSl4UKy9CHSR5Uay8SA/LiJIXxRp8tnhCKblBouRFsfIiPYojSl4UKy/Sozii5EWxOhTpYRlR8qJYkNCkx1lEyYti5UVg042SF8V6P70elhElL4qFCE16nEWUuCgWIDTpgRNR0qJYgNCkB05ESYti4UETMOFHSYtiu/pMnz8SFsWCgyY9tiFKVhQLDZr02IYoUVF0tTf1kSJJUXQYzEfJiaLDORujpESxprQGgCNKTBQLCEKyZVcWDAR0rSgZUXQ4JVyUiCgWCjQd9KkjEVEsEGgy+tSRhCjiO+tbGatc+lHPTx8lH4o7mayjpEOx3neGprDEQ9H7vakg+VCsd9eDqSD5UCwIaNJjSKLkQ7EQoEmP8ogSD8UCgNBeIulQ9LUvdaU5SjoUKx0C+l6UdChWOgT0vSjpUKx0COh7UdKhWOkQ0PeipEOx0iFwXVOUdCgW/jPpgRhRwqEY8H0QUaKhWNEQ2sAlG4qF/0x6oESUcCi2HNZAY5JwKNacRGgDl3AoxjpB9WVZwqFY8A8cXRIOxZqTCI0uCYdiTWGNRpekQ7GmsEajS+KhGOsc1bcUiYdi3DOCRomHYsVDwCIbJR6Ksc5SfX2WeCgWAjTpcRJR4qFYANCkhyZESYdiAUCTHmsQJR2KNX81OjRJPBTrdfdg6ZJ4KFY8BHJfRomHYtrzUogSD8W0x/uixEMx1UScOh6IEhDFCohAnpEoAVGc9ghulIgoTrVL9Q1DEqI41S7VVUQJiGJ1JdJjNqLkQ7HyIT0II0o+FKsvEfBqiZIPxUKAJj1mI0o8FAsAmvQgjCjpUKx0CDgqRUmHYuE/BugWEg7F5kqk5wGMkg7FvHPwlHAoFv5j0KYo6VDMO9qtZEOx4B9jwdldwqFY8I9BU0jCoVjwj3H6/exRwqFY8I9xuj9WlHAoFvxjnB7hFyUcioX/GAcmqKRDqfAf43Tbc5J0KBX+Y5webpAkHUqF/xin7xZJ0qFU+I8B7phJ0qFUAJBxeq8miYdSAUDG672aJB5KBQAZr/dqkngoFQBkgJddkngoFQBkvN6rSeKhVN2JvN6rSQKiVBCQ8aBXJSBKBQIZD3pVIqJUKJABOkCSjChVRuRBr0pIlAoGMh70qoREqWAgE0CvSkiUCgeax4C2OiYJiVLBQPMQ0GvLPi0YyAQwYiQkSoUDmQBGjKREqYAgE8CIkZgoFRJkwEadJCdKhQSZAEaM5ESp+hUFMGIkKEqFBZkARowkRcnWPgUjRqKiVGiQCWDESFaUCg0yEYwYyYpSwUEmgl6VsCgVHmQi6FVJi1IBQiaCXpW4KBUiZCLoVcmLUmFC89kJVJe9WqjQrJeD6rJXCxWalT5QXfZq4UKzUgGqy14tYGjesUB12asFDc1LIague7WwoXmWgeqyVwscmrsPVJe9WvDQ/N/16hIepZqsCGSIT5IepZqtCGSIT5IfpV1+lCQ/SpUf6WG5SeKjVAjRpIflJomPUsVHelhukvgoVXykh+UmiY9SIUSTHpabJD5KFR/pV4gkSY9SqMGEeqa6JOlRqvFnIGlekvQoFT6kZ9lKkh2lsJekPEl2lHbTWSfJjlJlR3qQbZLsKNV01iCaPEl6lCo9AoAnSXqUKj3SQ3iTpEepuhaBo0mS9ChFDHeTZEep4CF0NEkSHqWI6W6S6CgVOISOJkmioxSrzguWOYmOUqwnGbDMSXSUYj3JgGVOsqMU60kGLHOSHaVYTzJg85LsKMV6kgGbl4RHKdWTDNi8JD1KqZ5kwOYl8VFK9SQDhoDkRynVkwzoVcmPUuVH6GgiAVJK9SQDelUCpJTqSQb0qgRIKdWTDOhVCZBSqicZ0KsSIKVUTzKgVyVASlM9yYBelQApTfUkA3pVEqQ01ZMM6FWJkNJUTzKgVyVDSlPVekGvSoiUCiZCRxPJkFLBROhoIhlSKpgIHk0kREpTPcmAESMhUqoQCR1NJEVKuZ5kwIiRFCnlepIBI0ZypFQ5EjqaSI6Ucj3JgBEjSVKqJAkdTSRJSpUkoaOJJEmpkiR0NJEkKVWShI4mkiSlSpLQ0USSpFRJEjqaSJI0VZIEjiaTJElTJUngaDJJkjRVkgSOJpMkSVMlSeBoMkmSNFWSBI4mkyRJUyVJ4GgySZI0VZIEjiaTJElTJUngaDJJkjRVkgSOJpMkSVMlSeBoMkmSNJlqN9Vx8iRJ0lTTXIOpPUmSNJm9W0UnSZImsxc8OkmSNBVWhJzNJkmSJlN1X5XKTxIkTaYeZVQqP0mQNJl6lFEPVZMESVO9HA0EBE0SJE2mBkroBqJJgqSpXo4GYmonCZImW+OB9VCpSYKkqTocgR14kiBpqg5HeiKVSXKkqQWogV8qOdJUs10DB/KpcaT//Ncf58vP0+1xevnfl5fTX3/8r//4jz+enh6/P05//Ov//vF0rv/R/qtI/eN//d8/7Pw///WvP3z9J9R/Uv0nt/8Y67/zUaL+2yrPSm6t3WSkVn8+XLQ/XJO33Njb/mh1F7/R8scUW50pjz96UW4C87yCtj9c+8O1R2TfJOfQXzr01zjY8deU+l/5MP6y4y8//mo/1Rhjx19+/LWW9l9orOl/+dEipfFXf4Pl0tr+l+t/5fHB+g8sF0XWv5bcBP0vO/7q77KELve/xn8bb7oEq7S/0vhryFt8MNtfpj938bjqf7nxVxh/9beKfkgZvzf2AVIMYf2vLiXF0fextJj/bOO2/L9lHD89X9+ut/OdDdIlWG4M0xIjBxpfL8/Xy+X0/DhfL6fb7XqjUsK896xSDvXHaVIex++03eK7sbYz46MskaP9Z2cg6/j8fLrfnx7XP08XKnM60FfxsPXj/PM4z+B/X7+xNwr0jWztiJ3258v9cfssX4V9Vktmf8lM+I/F3Lkc+jq+zo0dOfOvYe0XZ3jyNca4Dxl1EZV0O/2fz9P9wb/PRL+PQ4ONi7l/zL+LjbvlAjQiJ3z1gRY58yc6Hd+ZlPnwTqQcdnuLPd950kFLUOtew81XNWS4Z9On3hK/+JWYx4/5a/y4vr28Xm/zr6m/Tg6eic3JtPurzo/f5xf+ywz9ZbCfX16Ony/n0+X5dH69nE4vJybFGNo/Ab7Cy8u8qrwdv11vxwdfE+bFmGyADnbwy8vjdDleHueXx/X1/PY4MSk2kvHmD/jXvJ/5KkDHxV6j48f5+e28/GfSmk6asVDDMbKImV+edQL57finv71df327Xt9Ox8vx8bidv30+Tmyg+RRWOVOEs//t1/H3PM0en7fL6+fb28/j26dY5en6HOp2qgmaR8N97sfT22n578uqtPynP0+/+aLk2OIGR/39fv5+4ePKWzJjF3eRqtT0ObQYpOofoes7CfZ5FX/i4hMR39WQ1Hfg1DfgBXs38W2nSV1PmCzs6PZA3kV2ok/sD+qaTep72kLO2xPheCjyH8f7n+wBBzIaY4Av1wfQUvXjdno9/8VHUqIjCW3zi5TL9aUI4c0jbQ57vK0obCYGugN1pcjj6dRkvB8/2HJyoEMYL9ifjx98LaVPhyvB3GpWjf4+vVxv34+X89+bNXlWGclqFuEEmgXdT7f5cPB5e2MrCl3S7VA1IxzcP4/neVl9O9UlkQ05R2dzSKgzvh2f/5wHwv3+eTvNa8Pt9/P1ky9zS3gq3WjQR/12/n6+PDarCvlJaGX69nZ9/vN8YUrfEnCzPjVCnaa3fZzf+Z6whLIQAXA1+/bxfvk43u68tY90KAf49KXx7bromGJ/teTrj7OCn8YxyI9jUF9kzGGo52YcKcyot9z82/4aRwobx3/rp7lyD2L7axywlgu1muIf4He4XY8vz8f7Y1lejmxYhsC05QNaF4SIWTHkahidmyb/wxdR1MslMyXZWnDvSEl3/j6OvQ9acLdSNnrqkm+SvFBEipAQdf99eeZqM/1dy+X2UMyfYrhmqgJM+w3Pl1emhixXB5JFE+rHtTX/hmzlXK7VA00/7+fLPEmEjuCo9reEGOutn4/PP04vZ/aLs2OfaiyVY+uAG2iRdr28nPkOumRUpH04DUHoRz0f3z8vL8eJbUB03hu4A7Sm82H7cp81u6dvx/vpSWwGhi7gbTAsq8SADKmTl0Jv/9mDqhb7xBerhfKSJ03jSWPVcHk8CXeS+qT76XneVvjTHH3aWBEPHV2kATamAzrXy6ddlz31SdMsDD1D2v6QvEIR279syl/09NPz56z3vj89n26Pp+cfx/Pl6ePINYnF8kB+XIdleRpf0o7f9uXgqE/7uJWz7dM8d5THRfo42x+Xx+PceBxSa8Tjbtfro/7C7cM8fVinfXl8v66WF7PMP3rY57ztPh2/l4Eya6ZcBVgMqOtc6owwD5CXxqkrTV/9uPdZXX2bn6VPNDpCBlk8HIb4wdwmuMLJB+0MSApHbJ/NefC6xRGxD0ika/Wn1afMS9miBPI5zZhOH+15kMc0CGWakHrJn1IY2tN8ZljYxNNAFE/vd/7rqK7QcW4ezDWtqsj0z36d7C221/aJlachdqwoaWdDaQ/4ON2WqaWOikh1+THUDofxBZ0fo+LLL9getDcq6Ezu+l8eCuPi/NpHxVeD/foxa8PzOQX8Ljr8xig4DO6dBmueIBjdPGnvh2X6w0If7nb8sLHuQxWsP27eTOZjytPKmPkPo/tKP0PmYUdYvF77g77aVpbj9dv5/gBfkP6iMZ4PQ2lfvEj7F/zqJ40n7X1BOhKH3SWvhpwxlSGwHY8rFE3u/1T1sX2A52GpSUO/Svmrhb2uEkXHehIq2+JRQB7TjUTD5JOGsSrlr/SZ+phFhxvPKmsgfx5Vaw59pchjpRhGqZS/Winq8+7P1w/RNVQNHUayaYw5Ozpp+mrM/X06fdufSFS1GHa4aXy0AQwSPFu1Zz2/XT/ZCEiRHWC++hyl/TwLX8/8zE7fsORn35XStsryi9UffKAIwOOZNLcTu5/zpF8CZKu1aT/AN47JT77MZLWjjiqCNsc7T0FK21KgsF/X25+vb9dfTAJjGoexORiDO5zKul5Ofz2fPuTKueTwI5aKLjXAg/Us9eX8Mm9o32/XTwbgvCOihuVxKBtjb0ndUJkgmeIP4TiVooTYF5ChWoz1N3VLdOq216mrrdPeoKjP/ZRMyFn61P6wrjAOLTF1PpPSznhZnyF+mqMP6bL78W+c+VK3raeu0k39tDG5nX67Xs7Pxzep2ltHhqbb2bQ+js/nx+/T+/khTDBpYsaDCEXMv/r4cb2fl0E4n6H4F6Y4YYrw6y0yHsfvW/5MNuYJLz/z4aac3hgu5Af3BCfUj+Pl+2me4I9PjlsdefVg4aCem19OnK7RGfNFu3nhvfOVLjJ1eD28R8w/qiiuAjDcCb97bcltz3TpgCtaazh/NU79mY0oTjsf/XZ8nkfcrCidn/nzKfkqyZ7a7w/4U57fXqQljox+1Gxj/4ts87dDSYoJbp9FhrTEkme33hv+HEPp9903p1w2sid9C1zoyPQDDvshOQ7JUN1fhh3fMahteyg5h+HEYschNoyjXxwKShyvkTz+NfMz56XqbbFQcDMlxQIB9/NmriS6PpTUrTst5838XbjBBOpIkEcnBeh9sggSUCPQlTaP7xAG+48TXLcWrev0c/5PPw3vXyIyYN2NNNcNyY7OpYiVHSLoWpSJ4xsSSO24Br/Z511sJ57MCuhX0NptZybdqPFmSFuvR8qX0+N4fhM/g0wgPEeKOD65U2AqLN5VauOPt/lw9vuDf0SKgTEQqgJup+/STYQeHsu9RrsC7vNhngN+5uWAOXNrXvbFLcqj6riH4+r69lb7QKyQ9Lwd8L62OK5xvzFm4BkrksFDYhHxyr8fZePlPoGdpmK9WDL7U8e1sWA4OKKv7x9vJ75JRmbTPgxOaPABokkR+wyZ3MHBjmxthcdbYHvdYbhkBqwsrII0E56hw9JhpLVK2RynHN35DV73moiNywR1XorQt6w1X1YGob14ejhMnUROFneLPDAHSrgz8d0c1ABvLUXY523jg2Coc4vBOnRd8PgYCY5pc0NXGBt8iMP7FJ/bsAfokj6O2uRXV1a4rnFhsx758sZ3ikgPr8Z4uMQOSXWRKhsYeznDTgD/QNDjOr/LBhlQZ8zsVk/kYaMcdCgOdtOOpfhpV35KpCYErC9U2xhrRw9I44W+EKBprebAvLvw9CUSFFPggdlcdyZOdXz9fvt43u72ITL3VYsXgiZGuCDS8TMczHsfjaEfW0/aTg1dN3z5DpZ9Vwl999rw3Z/L9+4fvuRjGPi+coTOrEN/aOhENPRxFHyrM1To1En61F9+8n0p6q4gecDWYaIbDyv39bS//BiZxKFxPVHuTNKH6BNLZ8FwRHH9FV3nGa5/KdcPOG5MD7e3+D1Of/FBkJgH2c7snZWkt7JqSofFA1N1hmuNww4At9O8JWwHpGGmnC8ab1Rfup5BL0PW+tv1hf0Saqedvnh54pcrzsTWUHwO3UqrHO6+SX5/nwCu83fXD7muEyyHt5Iq+xv7ddaTD+T6MHbdacD1k5TDx/AqFh8fyPvjxbEIeT0LmwP1yrYwUGJtLD863b3tF533en17OQl3ajrt8IJKmssXoCqJs3AGFgnvp/dvYvCS50Ov8tZ4/vX3x7yxsx9AXSCt3/9+Q4L8DfTU5QLcnIqQj9NtPuffN56c1EoKo2WaiMr9F1uhouoG6lQ7r0z7fbprjKC75QGr/5og8HKRGX4shimaTOHgF7gbLfQ0RLK278b42j/rhFWeFk5C9wiLAbEmcGvNYcKwBUYT9utc/Cc+3/hIYfazg9lf/KFI2S081um/18VM6raDWGDNF/vkjmStq1hsBtZx/5noZfQzXZ9S15KY5/9L/PXy63wT788ixKBH5hcP2A469sVh0MoQ++/57MDXV7pBhP0lZKuwW2qC3v9oi82R7w2BmSoO+MiztFfP22QgpxGaanc/wnJMO3MzkaPWw4B9XIqL2o/T8UU6vR4Y1hl+iyYM+o0HFBUqtq3o2El2hJqG4fEW8TcrchffvcW6RaUy+8hgYB5bmoqk+53bqKjpOnedrlyV295s+Mvi/ng53n98ux5vLyvo41oXtdnD9xtSXmb96XLeSqHKJ1ziFwsia0Y36dDPTbGfm2I/D0ZIdxaJxV1oSZZE2TENgOhKcOznnwg1/EVeO1jJmHGXKbnqDkGxQ7lo0OhbZN6ff5ze+W/P1JreHRLHETDCI8xL1WEluqcHGGzNeJnnADeDkmYTBIJLs7fzRXBWNnHGydaMgWqhEvhy+vbJmRxlVHk44g3blYlr0PgICx8zNAznubDah6CDZXn44gbDLeksqBKGQL2cns9SbY2ZYVWI1XpbfQ5ZOmY9XOe3QgS3p0DNQ/VtFfPxdv39Lo2sLA7IwSNNl8JfwdLWvgNNHwf6WoOsYLDYkKyo5I66KHm4nUoR58vHJz9xUsbvIbyQcq6fj40gammBZ40uSCCQODEEstqI1wALeKjrIt9Pj6NcXePEOhEvKE2GdOxwFEX4MQH9ah6H3jxd5PZTJaYD+gGjPTy1d1mLKjzre0sZtxNSe48fiTbcl91ABaJpwAJtoDOcJlFOiUSnRIeQae3r/45sMYBsZr4G/ZO64ePrBhD30JSmPUcdVZkFe0Luq8mTI8xSvfi/NwJ+LlZToYTQvcy7rxbQzf5u6Pq7en5Ao10XpL0KNYL6uPby+AtaQ2ep89Y0zji3+VDC3REN3anszgJ6+vg43h5nHlWY2Gk8QNV23l6O81Ho6d/Xb09rKoSnRau/ihlN44/LndX7Et+Pf1WJpyeZvCExaBN25lsRVdyDiyMyU73peQcrZeoeHFl6Bwdhz9paTEV/oN6KO2NwsY0qDJvyL7x118Zbhs3Q8X5rmBmCuvPvDP2tpZv6a2Bbe225BbgU3kP62xpvASxdk+zOsFmab/EpPQHuzKfSWMen9O2h40yVAMgn1dos9ONsIjCttJQG+p3x2+RIUmGpSoRTv9T2t9PHlR97HWVp2EOrN79fP2+SttLF5GC+eoEqQXN1YJFYHuZm4IK25IfFBsM4tCpFITcUieNxoekeiXmdO8g21tbCQ5QugxjH1+Z6VzCCDnMBcAlaVzCrtdvpCi5IifjmiSZ2ZhqVtO1URt9hbO3LrGtseIllSzS0obXAmPuPo3TKctR/JeAZdr5/vB1/S43J02ieCZ/L3i/60SyytBIO5mcgAuQrxIkpxXibWkVgvThmNsoHKcM2MCB285ZMDXB48t2Or2y0epr3LPbI9giDCoqA++l4e/7xc+7spde32TioaonTps2izhextwTqrJ2H/hgmOHA43qQTBrX4PG2gLzXGph71NGKd0nCD6Kpt6pGgU4dtEz6zKv5TbqI5v2Ak1en4/XTTAxETy1rmIfvv+ZP4MGRBT2YE+5vu+GHsmhJkzXYA94P9JE2RJqyZnzZcJMNhPG1kkByB3n7Eivo1BBsGC53ej2eu+FPA1n6B7Y5lI5GJhQ59S/QJH5gUTo8gwsM4fo4Ml+XOzPYX1GyU4JaJzppyC2gXgpac0/vH43dxWWN74cR6N8KlpTR/u34XjZlnH1xIThe44B/ogo92v9PlRc5CRz+x72Fdofd+gGGhp8v382WTKMpR3T5A1nu6/OjmsJ797fxaVFaRKyiywxq0ii3z4PH7/L7oitqm7ii9iHDV2Lo1sknUo7BGaPqgVIcxDs0IsvMjXU8Y8eRhJMAII8tohMf08jpPL6f78+28Ce1jOyT+MIuIZ8GhA2PJh/EmDrr8FjHCcTixN9gZKK3tfKSfi8SLML8C6BTTRSzjpW+A3GuSseQDTBpRBL3P55p5jeftmRP0gP6HkXzArX/t/1IRw8QmNoyTKNv54rmkof9Ew3yMhzk3N0I2MDp5tn9B586NJIWxesZYIQjdiOLfh3l6ewj6hhTl8wSWkvQAcytJGdopwrFgaQh2tqKUc4TjfrRw0AhZ25ME85WBsTtDTul1Qa+pLWM4envIQIas2u9CGN0w1mRK0ETShClmf0fN7T580fmzgNdZ3/i8CRkU70K1t/iECxVpYm6hEaLh0lakI5xYlEOEAWel7XzEO51/SsWDJbGDFO/08/z8eL1d3xecteGQxvAMfl8JeT+9X2+/FTEMr8K5/Nfp+fNxqilP5CxMzBcJL1J/fczHqfuTjNGljfHz57a8C5nfHOzAvxa9QHEv4AObBsLg4MMqrCocG7xP1ZUAI7KqiEq24MtQZweYdo5Kqn5FG/cHSlhwYOSr0OQjQzuHkVPLQFq2SOC0lm3uUCGu7XSSkFh+Z2yvXmRswppY6MCInsa56JoQNaSJ7lIOahdNwnYFZ8k/oTlkad6wK0jnEC0LjIrDcwEqbovMbQJNmrO23AiNG8/L7SZvaOaRg/utFW0rORa5iCWcHivw4N+Bxf+t2TVHYhs7UgLZ9bAIAwzZg0Q4DpsH49oDC1nN6/n0xs2ydI1urpTL20BFRXMep0qAg9r+0lLYhOn0d8NlH+61i4RukZXv4JiLIP794hNauq66nuvUQdeZRcDmLg1qPrEQ3Sj5w1nMRdfrXYdMritDbhrxOPCHvV1/LbmRVW8RquwFuBG9vn3ef+gbOdNFIIgvAtAmzpwXoYN9tWw1/7ONez3NWw6PB3p4AfVhx24Mta0YpHQ9sr0nXHd/w14lVRgar5SJOHjmrzLEiKVR5p1D7qz71yWT++fHlnCSGZN69q2Rcyt1P7LU/V5SP4pP3dNtgrbC1/kgy6k9GYLTIIluZyDc3pFLClvg4bUGiwTek57O9am72E3DA8dB1rHIknZu2g1TJ5MT8TjZ+2m6XwmzEkHXoqW94nHh6RCf+vCc4Kl1FvNr1je5XsVAw8hYZvBuMKvt7CVogg6cWOX74qh9/H18eVlSgLMtjR5yM/wGTYDyGSLbEx3UZ76fLiU3YonOPF4e9/l7LGm1NzuEp4kQJqijNnmyU6gpBU3ytalg8pQv49/xwFdFGMq8LTRULTK0RGgsxBmq+aX148f2rht2PUyCbjFz+5ppuUhYvr/ktobdxAOP0V2QmKmGpUOAysXSWvmA5Pvhrm8tRUZS8tS9V1bcWJgLwpdN+WNpoAUeceuB8/wiznbUDgVP24uEfWdemm7ZQ6WDyNG9OchX9DuT+fGVk6SlHjLYCRBI+uv9jQujjqEw69YsbOvnQ2ckVOeWljsanaVoAZPARYriKsQCfXdm5WYTp4agCOPs5pZK9AozZTUlyg7P6L4Zh34rQYT7+iz+fHk+v4iZaum67+GGVVrzPPSG7rt277n/no++4yA2f512HuavQQHk3orbjp5LXbHfUC1lZ9N4AFcsOsCgrk6bz2Uf86+6i4Qe1Dpg93q7JdQEOxD1DNtbkFquYiCFhufuLcQ9MzAQQ38SDIGZxczfY64m11Z6sN+b9G1coIWROunCnIeaGLkKUc0Em+JXSUIdprGC096uuutuR8c7PPtvhdwXkjX/uyxzYgbR7wOJniLxMetQm0R9lmaS8jC2tYrbOgPStRJarufGt3nFK1dN8L2UeoTuTeUKSTdbMc1Gtqe4VL87/rvpjNltevt5fi5M475o84sOzBRy5lVy2NtrtpdD0TRs0FettVyyUYNZy3yCdwbEImaTx8zTTFoT9JxYmksNNvMUP3+009AwUe0sAZsEq5blN8ANNaLoKTyJ0JZFWotH0ynQPaiaT8oXctAuR212e+txyS4NupVqqlghu30wXh2ovTlj9WVu9vTj8fiwxd3+43z5fn9aLPTXz8eTPHkbxsA74slpvbt2ZOyGyT3oA5cLOuYHzuLnHeTn8Y09WF5cwHwxexKanIaD07gWM8FAd/HsBak/fTs9fp1Ol/bL5TOpU1z3HcjjLqe03okCqXR5ZtmX5t+3YPjikva0ZM28vr7KBzIngR5hnIcfWVrvvIB2qfLAP0+nj+PbEjlRvMgf48suGTvFb6Qso6P3POKNUnfTMzgVtHhk+a7yh1EbUM+xlIcVO63XG8CYYOUpyy+SD6JWiZ5DKw8Ld1pvAYDZHsuDltnwdXfR8/bI5rRe4bzeBQSzwtaHnS9fP4y5fXTGmEfesrReBwQzQYEEXTR8L48csYdhfQlrkqlxvUbc/UUta6eIGZnYKEh4px4STn89TnPbl5rHlLvb8e+BVeZF2HAEnRdpedScGPeIMJPSIki/gm+yzG0QXpxS0+NJGyf1IcjQM2S0Vd1UWKhdgGlIhxDOEqnZIh9WIyv6ElVMvcl37h72JhNHUGiOzSffN57jPLJMntg0VVtyxkyN1BNEgD+u8hpkfp9jXxncWCPi8CGbYAKZRaoEcYmlxvHwt5xhEovAevQAl15hg6EWLNsT77s+aZ0bpsO2cbm+d/ueec53S4nvk96HXmdcSd8XndD9g0euyDiuvO+rYOyPSN3/YOpcYxqeuof1SviRAs+MRXvk2TNhWMsjvJ/r/LJJNZuYySDCnCLn75frkpVEvcaXnrcmuHlUEYVWfBz5GdDTHPwT3MDPxfcLGLKZlxxc589LTtTlv2xBO101h/4yLllLvdNT1zlSz6Iw9fwVEwz2q667p8Wr5iwyTdPTEc6ZcL5sL/n21Ct0go4fGuty9DDhu3cvttl3GfIaRBqJHsb5xuNh1OTwT8ByZkMT2tz2bUnfrRxvEvPOCvCIKUSI+ysy7f8+Nbs5LnWTY+qTD1+MUyUS2eTt0BJ8vry+nb//qEdIxUnH8Fg2OMkEmgw0UWkeOoofOVTDSJYb/Mh3D62yi3hph6ZpRyyEQOdy+cSitdwuxzetEx11dA3wmN1ODCCChZl2cQKYspAIZyx2pPEwLqw03Wxr7Azm4aGyLWBv4v5ydtLw0LmALX8yBxOzlY2DhGkXKJd9Aa8Qj+i3uc/pzay45em2eHJJdZb+oARt9KX5RUbXU90jjMNrhImVzpef5yUo+PIiwyt49CVqXu5xmtXfn2dh6GAaGwwEPlcvYuC4z9gXPH+fGyIBexvz9YMH6vO93U91Px75AYllr8aD867EpHua7GCCAPN8r56vPNcys2DCOM3z/fV846udp35dE4ybPS90qQSjv7yI16ZR1FM/bU7QxfJ8L7Pycfu8PG+ywtKfgX2h5zHIz6WWJZ3r51LXNQrXlUY3wpJg14iTUWR3/uD80z3zxPUy//Pn5fprXja+n6Q/TKAhwdPqCztybhgYcjY/4HmkmS+z+VWodoGtyAeopcyShj8mSBAfWDzqAYK0WdRGT6Em6cGm3Fgl3QhmGp5yxsFbgeQxMUYW4g5N3ku7cjTk50K6VgaY9/7fwroWWGqiw0BvEc7RRcLLlbNQFgF2GMxwBMjNf6G+32TQoYb2ni3H9/OU77KH6uE7UvP9rBT6HWdhpG06jBuBzbhG3oybMe1QWdxIYegGZPJwqr4dv4nboDx1XIowcqQ0VBdpR8cAvkXsrRxouRZPva4gWXg7/RS3b7GcMQe4BrydL3/y7YR0OZxDiy3l/fT4ceUGpchyS9j1/k7oTLkIWhoowibm7h2hx+wiou2PekYDlqMLehm9XZ+FpsGcgty46tqvJBSGSRRhyx0K38VBlpqKIAh8u3JFi2adyevYX3Pej3tZw7Qe89ec93C0Xb9v0gROzEUvQmvY0rZkb+CNWTwxtLnMjZU7NNg1FRBLzm35TTYTUyPwhSdzw+8icSsFmLmb3bJfv+t6ZSRaNRepUjGm0SMTZIpzS3kcm1jcCc6hOTfdTniqVOcxItar1oxbDYwjWdlQ//20QqNxTzI0t88voJKayGIrzBrHD69AlsHgicXN4JSfb9fL94/rGw/bYT5AZrjKmhEEYcbqb9dI5bFfhJGBL45AhWmnE+73t8V9Qpy06LLbBcOz1fvxz1NTkU7tEhi+GlMzeyaXz6GVZxE4T+rrrKg2h0eNFrArYaDrzSJLC2BJTCWBVOv9+Fi8Loe726egMp557EPzfROzNBfRsyxoALq6vR//KprVtSVZ4/onTSOXx/VPJowRM+LD7brKQq+n+VmLpUNAvEAP8Hllt2sGPIj7m8DfSla4QLlYHoktPEw7sE3LRb2e4NXU76fb93lIvXx+nOYBehf5qDw9fU4wK64yjByNagndQBvsirbRzGvCBKBhY9qN2x8dPBBrPvKWflTX1VzXL5AZt6c4mB0GX95Ar5CAvjqjOYzroH4ecLNrLnP8mM/Du+sPsdDPbNfrjl9wGrosuMxVWRs2SH2IoFVzbnx+/b13gQQ7YB0g1lMFaRGPbBfDPl1AnhYNz+AhTISgCtwGVLLIUvx2n8tp8vF5u8zLXz3m75zyIzPFGmjMlWiTah19m/Whz+X278g23v5t5V09GM4T3W23m8lsL7E9VMR2Y4Trjg+upzB3bljr+pVLfal13evXhUFX+sGza0Xejz9aKz9sfF2rDv1EE/pxNXYLWxw/qr/80CFi30JSNyxOXfmYhobpxt7jwkAMQx9x69Ebjm5dIWPKsRmhSMYNdW9krp3guLyIS6kchQshw7GyeJeLiBOW/RNC18vn2xvCrszAC882l89ls7u+LsDo9jJPJjUxDn2dADevQoA5hGbzeTCxOK2qM1rgIU42TPfv/dSnRL86zfZTnxtYpE+z2Oddhhode/j23sbEbsPEqc2vr69cSaX3B48xdlgVpqFixwFiIjRmCpBFMUAeOv1hTUg/wsjiUIIi3F+vl517HAMNWcxjbpo0JsvhH8tVr3Rk55ORrd1A7LkEiRz5JWiBGlUzOdmMjw1nVfOA569EtLeRCamvqPDUtutLb9lA7isvXCWaLKkbUM8DnBqnNd7eW09dVKAGOHJ5KG5SYWKXFkG/BSlj8WJ48DwdgSfqiPs/ZhVV78vZCGMxlHgWFWFXcYUFzZIIYWKPcWADhTpxjK2qh41DT+X9cAk2H7rGHqA9sAuTl9zTQRyg5tJbK2OFtIdQThsi9ASa/ViGhrPpBJWzeU8SRzF2sVKAW/H19v14Of9dhslN3IJKz+V4uhVzpDRucwsg7M3SdmvdZnlKcPc1Q+jGvM3yYcCz9fXXRYbO86ufQbtZJfrzuJxgtWCZiQ9BGOTehMifPgmvWbTQfIizr2WJxLvJY1xM4bpmjLOtLRLlpeaebg2x6wepqw6pn/lSdwZLEKrr8Ul0jELMMDed/6+MLpQmN7qrY/xRZQlfPRrzPO5dcH0ndFD5qcI2L0IjHXc+9+2++rdt08/SRXmC7mVFigyA8fRKuAmegkvb5YsqD6cmIrjZFQF8O6BecRPM6VIbKuufp+rzBHei0v5x+zw1nfzyxp1Q6UY7QR+IctPCJiUQ8+yycNEbjb/drn+eblsnWk+DEadpJLqBGpCQKJdiT9WXaRwLLLQGDHnywMRsxxDSjeZ8vjIjoIN+d2vrjYt2ZLc2OQiyP46PHy0n7yZzDl3roNV8FrB4+/CWNE4dLzgj37+IbiPLRD9vQ6b48Xbc3FdCNyZI2npD0W90TMNvJuwXibkD4fyxS7tNRwWaxS6bcToKe1J6ABFHBowEDRdis56HRiKoEU9khpeoCatdcsRYTNCOuLzF2/XK0gsmpnrjTHJL2/d5Of6LN2bZ/KA+Jy9WiOyi7ZF+Zz5OwT3hdvp5Pv1ScpHTsMS+18Yes4MDQD5uxT4hEzXyLBkwzEcJo4vskkSc0mg3ntjR53u8S0gZ4tI0Go0X+rCZoNVnI07u2zT6w/ccaL6zgNB9WUNfe2PXFGIfqanDldRHdupyUlfJpu7pO60p1cZt8oNTzpPEjr9WojeCtP75r9QSzjD3PDMGphnBRfg+liFfT3TEYBy8na0JEdY3lrTbQV+aHWzvqBLsoUFFSOi3n87/71bSv98+N36+kTmJWnjgFqLFiKU7X+gkOkLfaiFso2fS8d/hdehBY8GO0dkHZWfEqWfNTh0YpT7apu7kMa3BHyMg0KzjtIemzCN2WDOJTjK8AcaukfBp6p/ExDsaLBG++mL6zXps5YLn6CZCnss8PSOkTh8nGEg8/IeKLej6TcbpRwZdHIxp6n66yn1l1GLmsUpQcwTQy6OkOkWJPr7rewgqme6YABpj5WAKrSZAPp3OLAcD9lpjcXCjtnYbh7GnDc6xco4wMtengBvQe6DJvSV1eTQyn1JW5PBB7XZ9XBeVlh/2WZAxdDv++Pz2dl4SFW4TrbNb6Q94ODIJ6oU/7IYYCOqlIMU0ycwODvqXckkbmyTjIPbwxfuUtVv9Poxtwuw2ihg1cS2btFiN/PxWb5eZx8peBlCKufC9PlTal8Z8SlUdJJdU5D9ZIGjeA+jCqQiFb0lPUtDzaAhsqZi/+Jg0Myt0FNzK/PqT0iSekNpvBf+DD8tTnsAdEomGb0zHFTz0zcObGwIcHY8BZoMsiWN4xEKg5+q8Xs8B9aRFBrhVj4ZAW2h121qx6O1HI4ZnnDUj1GiLJCWnM0tIDy0bt9N3GddJo8rQ4lebyXu+6HF7tyFXnKkzL/6V79efp+N8NJ6VqyV7o7BX0GevDlOrTX84K+NkLjXWVs1JRHkNjFa4zWeK43O516oYqrYBYp6690RoFlgEnZ/bDQcy80GcmFcXjPKv+Y2WybuN+nNUZ9kb5DVPvsggT5MDBajwrI1bhnx+/SXVZsNOr3ch0l7g6KgJcE3vWZ54U7pMQANHbcq1eApXAwSzys4b2cVF+A6/1lRzbmT9fhguMXaMcbyzLbcSvv08aYHNgR0MD9DJXIhQfcSYCwj0CxCSNopTYAAb6pTa9ZGJgQEHgxF6W3EiTezRHgLO3lyesRzVM1ZHcjcuG3AjdthB59xxgyT/YQxM7L0ZtyezsNL6bDtCjQYR6i4oEV7bU3du/mOpvQpqaprzL6MshxFTZka+EBPG8XwNU5rWv/Caszzs52nnfhTuqL0jh2/ONFw5D8x0GD61B+LYj85hRWrLyMO/B/OrIL9z76P+Vq+/CSz1yQHGpS+gdqO50NOc6yDFQcO7tPBYGmwwbiwkgAXe87dI4uOdxQz0tBFYBbpeH88nsVhPLFopwnPc4kYvNgg62/wYgR7aUYuI0pZJoRMkDKQEzQ+3z0tLDcjXQzo67AheSZBO3o+vpyV0sVgZWQdR66aHS/39OPeGav3hvlFodN6fj69LElxuOKLeMjDkbG56WazBlTe9jrvZuJGV+jtOcP/eyFpyFQpB9KUg97nPi8j7kX8IauaFw+L+fOUfUGzhYy/Yay/8UphTsofYrTTdBPVSvQd3fzmqHV+lxsZsf+OqAmj+JGKui7bATWqeBoAkGGVehXw7zb0naCa9SQGSL9pcfQka2QlPxlUKPQbzZAE0hNHCbCwNLWwyeIvUqdQAcED6C5c1yDOXRNcweErgknAmb2pagpbLKmyTzt/QZcdCk1trLbxkRBJMiozhxlQlqalzLJ2CHiqXVcIgKyLdO/05cDWvIjbmLP421H0IJwFiokBv0+ygeFXogpYVkQugQa4WKs4d4xTlX56q6JU30ChKQZCwkNBjJYzOru23SzndbCP0mON3ZouRQbdrGFNwP10ax1OUS5aIBffmIgHevEf1t53BtdETJp5BEmamup8el+tjg58mdtVlgg6P95PW1rC2eFaBpC+RKcAwvpS2V+k2MwFAqKCI+Xa8i49J3yjB85Yi6np5/Dj9OvP9KjGPBQez+FF52ygn2sEWelbez98vxzd5No2sf81q4cRzvaR+kyYfS5UI7D+1XNz8dhpGROla4miP4xQe0p3TsnTw3ebrehDwyGThcjciw8QUMmrTshtA+pnUdXXbdeOc6za5kf1rpGZN/T1StzOn7uGSoHlzeY+NuYIm8Ifei0vL4mkjllFqVe8e2NgPdwtRHI1fjd14HuFNIFVCaaxZeSkVDtC8eP84PWutqeoQod/RvCO+icsmE7uUCPvAF4vZ9hJ0up32uRJ6QFqAieykC4bII8Iy+4wTITYSFHGfi5e+OEawJLHQQXZxRRCX49KrA3rkn+9BeKEfSUKPtoo9B8LIx52610/q5+K0ZtIZ/j0Rn/CWd3r9fCu5HtRcaInhoQgzLihRC2QKY23+8bIJG6d+ggM9mZGsxYzIKjOiDv3walrjs7E3Rc1i1MPtX5boew0SBwaJoQ3w/rlxx3A01VPs/Rh7hskI32zRpL791hM80tUWZ5tZJCAfN099fGKfSKlHkaduaUs9MWzqQVup+61NUBVbHqzElAXKffJgryatDqBrXAra/Pr1CKx7KHYYILenrYU4Zv+mBZ7Sp7tUwUNSFya2DE/Vxgi39N5amTr0OI4W6aV5CdP5xrE5XeJNgIeqpbnmcOGp5p+g5bDo/BuooEwjT2FtgoFyQp4qiC4ou2NFIQ2qQGbk3RvYVKAqiUbzwfPOKgkoup6OP3zzL5WjdCC1XeM43yJEbkmeEvnYrVrTYL4QNvSbR/jUp5GgZl3J15xow9gwsHQY4blhjZYdGa0mmG9Hv/qE2vmm3YkIkupSJNXfInU1NPWQ/NSD6xM0EjxOl+MmUoi+nu+6ne9fxXdo73t870gFNPKKhr6ihh7kHdPotVZn6iamqe+meay5h/GRD2G1noyuysNaEMZfIyzYjlse7FjN7XC4tyPqfLjJGUeuGh3BvGMQjCwIZqQxN0PTN244M7sR7jySmxvvV7vAUAVGirEwgo8TBAG9g8QAoIthd21OXRdJXaNP3fSUyB3X4ztB6+Jj8Vm5zHMQ+Akn5jaCb5fS5IhcRMyWCnHEkuF44X3yvOpp0MIE7eWPH7frr23UemT2I7yGjNYqTmChQnhtHEK2PoAsLwm0iEv93tFQqZG2LnZf5DiuFzhAi5jmQEANtnm9W2l4EpjVAXosmHZNKgDNHMuz5nX9nUWsBJbX4gDP4Uvjx/VNZGpPhvGSkRYK+6cKfYg60uMY1s31U/yEBvtrafYkNx8ehQ5Hy9J2g/0y9w7Za7tNE8iCk+B3Xtp+v80LTr93Vr5/YpMmQIjcUqi9zprAjyUa//7j+vYiLphhoRCQBz6uH9f5HCjc4FiCVXgG6m01fSSyPNYOXvjXZWznLSNtEHI9rg9uULKUG4x4Ated+EbOGjdO3DvfZpYtUrZw3E4JGrRdPm7n9y0k8jSL7QTdhtTkzo5qKAH3jxhdln5TN5SJcQvpWNz6f4k9ECSu2ttIx2/8ulSt299wGsHHp/mtXk7v54cwbk7MLwTfhLrV9+i5e4KOKZ+X433hspv7+miKtgg9Cz8v6lU1NM8cPDZ9XpYMVyI/KMtHAsdgvcFehJpTZ+KeztH1U7DrqpqDBqAmlB8hLT2yud7zrqtYrocMOpiRqIrd3v1Lrx+FR/S18cYpmzp6Q4ja2isX/1LT8BffuTbfJLejLwA9RquEcqXT1t2KHc8PcHeRMlSViLmhfdHHq6itKYP5+MEFusoBftZURbAw1P7zflKNdfQqGANXsU+ZH4CmLJzweJqbLbkxHlsXYJ5ntKs1bXjbkbCtuyuPI2kc2bwjpM/LYzeh5tQnC2YDWFrKq2qpbwxcUOeGD54YPNApkwfkHpDZYKD3+SlNytSo3TeK9m/PMjeCieu/EKpsgpId9er2fUPx/YOPpL+xd0qM44+uknf0Hbuz58h3NkGNV73KhdobQz+9Rjueg4Z3F1ZuOuEjlWaygLEQa3twHGRpcKAbiSJGuPh7Juer1ylp4/mRiILkfpSPMNMuEyQ8BeiW++WH2ZxL6bVC0aGVS095T9OShDX14UgPtybCXXHJuKbsMJizGWmUzahn8uoyO/7qA3b+a0CS4V5q14sbBlZxq9NyHvBjzFw3ktb59WKk8S4e2qHGx8AEkZruIwxI0AW1C0lfbsdXPgVMokLRaa4LlRqro4eyuK4GaA39OS+hr7+16yV5+jcYdafYPy1N1T+60/dDuR85O/vYmMLKBoaX8iBph0HSDqPLD2sC8MGx7Dhwj1hUY9e0z+vQGFkZh6HcjMhUMxIQmQQdWX4dz4trZrlZ88fxcjm9jctL+dmaKgwJYo9fP86P02LhOH8I/yiqxqHG19ufIj3hgV1oNK5WMqvtdgRoWbeSS7T01ydsE5VQdShDNbG2FpstjVuDx5ZftyODMxMLlsUB/H9/0654Jd8yjwEQxqoToTrXxSlzJAWWuhymPphFlHsut1cXpMBSFMND7d/f5P3WkepI80KKvuLf3xavauXSBOo7N0Ed6+9vWlNqej6sJgk0X7qQbabSSPvFGIfGYJegdEJk50Kz/xJasDJLg3+AEPrvb9W3SPsedHDtDKTtXA10TOcD7oXaVBrCEkt2g/0Pe3ulAxg6N/D2NSKhKktXLe8su7opQIexLkzrTbbtGAgXughgTo/sxGKg8l6unefTilrChoLR9ynYt4uc/7kBLezb7jV9Or683ETWH88y47RX6Q4GeWSqSWM1S3gBqs/4nFWOW0s6+bR4Y55uT5837l3OcrnsiqvL4pM4gVFP5b7zdA0sD2UwrUl1oCmQPWWedU+bu1IMuw2xb/p5KJBxKIEJKlKbp0iNyrCkmt2BJq+msqFLJogW2EPuS+4b7k9BfYBMz2uUh+4yMhyZBA069RHlNvX2nDWR8dPjWm4xet5eS888RvtvG3p3Ghpzgu6O2wefljwOT4pCZIRC1B83ckmPFNAJopHt49pVof/s99JNs9tH81AcR7JNk6A6v32B9+NfTwrCMtw5uc+B9XKakWotQUc//LDfT81atoyn6+VFPJqFUPYBNa76G9mJTMIr/ubRmwBDw12o+9K03lE9jl4JXpVGHlNX9Kd+JZD6w1iO2n41cx4HwNQp7Ny5u2s+e2J5Ws+hJ4cMS2vbDxF52NbTSPifoD2jPLGcFhRXKuYV2UckVoS6qPvp8Thf+KVLhl140R0B8rCVDl82k2Cir/IAeRElC+Q9wIjI0lZx06JhT+pI/89//fFx/pjPQJe50n/853/91/8DSH/addUMBwA="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css deleted file mode 100644 index 98a43779..00000000 --- a/docs/assets/style.css +++ /dev/null @@ -1,1414 +0,0 @@ -:root { - /* Light */ - --light-color-background: #f2f4f8; - --light-color-background-secondary: #eff0f1; - --light-color-warning-text: #222; - --light-color-background-warning: #e6e600; - --light-color-icon-background: var(--light-color-background); - --light-color-accent: #c5c7c9; - --light-color-active-menu-item: var(--light-color-accent); - --light-color-text: #222; - --light-color-text-aside: #6e6e6e; - --light-color-link: #1f70c2; - - --light-color-ts-keyword: #056bd6; - --light-color-ts-project: #b111c9; - --light-color-ts-module: var(--light-color-ts-project); - --light-color-ts-namespace: var(--light-color-ts-project); - --light-color-ts-enum: #7e6f15; - --light-color-ts-enum-member: var(--light-color-ts-enum); - --light-color-ts-variable: #4760ec; - --light-color-ts-function: #572be7; - --light-color-ts-class: #1f70c2; - --light-color-ts-interface: #108024; - --light-color-ts-constructor: var(--light-color-ts-class); - --light-color-ts-property: var(--light-color-ts-variable); - --light-color-ts-method: var(--light-color-ts-function); - --light-color-ts-call-signature: var(--light-color-ts-method); - --light-color-ts-index-signature: var(--light-color-ts-property); - --light-color-ts-constructor-signature: var(--light-color-ts-constructor); - --light-color-ts-parameter: var(--light-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --light-color-ts-type-parameter: #a55c0e; - --light-color-ts-accessor: var(--light-color-ts-property); - --light-color-ts-get-signature: var(--light-color-ts-accessor); - --light-color-ts-set-signature: var(--light-color-ts-accessor); - --light-color-ts-type-alias: #d51270; - /* reference not included as links will be colored with the kind that it points to */ - - --light-external-icon: url("data:image/svg+xml;utf8,"); - --light-color-scheme: light; - - /* Dark */ - --dark-color-background: #2b2e33; - --dark-color-background-secondary: #1e2024; - --dark-color-background-warning: #bebe00; - --dark-color-warning-text: #222; - --dark-color-icon-background: var(--dark-color-background-secondary); - --dark-color-accent: #9096a2; - --dark-color-active-menu-item: #5d5d6a; - --dark-color-text: #f5f5f5; - --dark-color-text-aside: #dddddd; - --dark-color-link: #00aff4; - - --dark-color-ts-keyword: #3399ff; - --dark-color-ts-project: #e358ff; - --dark-color-ts-module: var(--dark-color-ts-project); - --dark-color-ts-namespace: var(--dark-color-ts-project); - --dark-color-ts-enum: #f4d93e; - --dark-color-ts-enum-member: var(--dark-color-ts-enum); - --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #a280ff; - --dark-color-ts-class: #8ac4ff; - --dark-color-ts-interface: #6cff87; - --dark-color-ts-constructor: var(--dark-color-ts-class); - --dark-color-ts-property: var(--dark-color-ts-variable); - --dark-color-ts-method: var(--dark-color-ts-function); - --dark-color-ts-call-signature: var(--dark-color-ts-method); - --dark-color-ts-index-signature: var(--dark-color-ts-property); - --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); - --dark-color-ts-parameter: var(--dark-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --dark-color-ts-type-parameter: #e07d13; - --dark-color-ts-accessor: var(--dark-color-ts-property); - --dark-color-ts-get-signature: var(--dark-color-ts-accessor); - --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - --dark-color-ts-type-alias: #ff6492; - /* reference not included as links will be colored with the kind that it points to */ - - --dark-external-icon: url("data:image/svg+xml;utf8,"); - --dark-color-scheme: dark; -} - -@media (prefers-color-scheme: light) { - :root { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); - } -} - -@media (prefers-color-scheme: dark) { - :root { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); - } -} - -html { - color-scheme: var(--color-scheme); -} - -body { - margin: 0; -} - -:root[data-theme="light"] { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); -} - -:root[data-theme="dark"] { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); -} - -.always-visible, -.always-visible .tsd-signatures { - display: inherit !important; -} - -h1, -h2, -h3, -h4, -h5, -h6 { - line-height: 1.2; -} - -h1 > a:not(.link), -h2 > a:not(.link), -h3 > a:not(.link), -h4 > a:not(.link), -h5 > a:not(.link), -h6 > a:not(.link) { - text-decoration: none; - color: var(--color-text); -} - -h1 { - font-size: 1.875rem; - margin: 0.67rem 0; -} - -h2 { - font-size: 1.5rem; - margin: 0.83rem 0; -} - -h3 { - font-size: 1.25rem; - margin: 1rem 0; -} - -h4 { - font-size: 1.05rem; - margin: 1.33rem 0; -} - -h5 { - font-size: 1rem; - margin: 1.5rem 0; -} - -h6 { - font-size: 0.875rem; - margin: 2.33rem 0; -} - -.uppercase { - text-transform: uppercase; -} - -dl, -menu, -ol, -ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -.container { - max-width: 1700px; - padding: 0 2rem; -} - -/* Footer */ -.tsd-generator { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: 3.5rem; -} - -.tsd-generator > p { - margin-top: 0; - margin-bottom: 0; - padding: 0 1rem; -} - -.container-main { - margin: 0 auto; - /* toolbar, footer, margin */ - min-height: calc(100vh - 41px - 56px - 4rem); -} - -@keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } -} -body { - background: var(--color-background); - font-family: "Segoe UI", sans-serif; - font-size: 16px; - color: var(--color-text); -} - -a { - color: var(--color-link); - text-decoration: none; -} -a:hover { - text-decoration: underline; -} -a.external[target="_blank"] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; -} - -code, -pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 0.875rem; - border-radius: 0.8em; -} - -pre { - position: relative; - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; - padding: 10px; - border: 1px solid var(--color-accent); -} -pre code { - padding: 0; - font-size: 100%; -} -pre > button { - position: absolute; - top: 10px; - right: 10px; - opacity: 0; - transition: opacity 0.1s; - box-sizing: border-box; -} -pre:hover > button, -pre > button.visible { - opacity: 1; -} - -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} - -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography .tsd-index-panel h3, -.tsd-index-panel .tsd-typography h3, -.tsd-typography h4, -.tsd-typography h5, -.tsd-typography h6 { - font-size: 1em; -} -.tsd-typography h5, -.tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, -.tsd-typography ul, -.tsd-typography ol { - margin: 1em 0; -} -.tsd-typography table { - border-collapse: collapse; - border: none; -} -.tsd-typography td, -.tsd-typography th { - padding: 6px 13px; - border: 1px solid var(--color-accent); -} -.tsd-typography thead, -.tsd-typography tr:nth-child(even) { - background-color: var(--color-background-secondary); -} - -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); -} -.tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: " / "; -} - -.tsd-comment-tags { - display: flex; - flex-direction: column; -} -dl.tsd-comment-tag-group { - display: flex; - align-items: center; - overflow: hidden; - margin: 0.5em 0; -} -dl.tsd-comment-tag-group dt { - display: flex; - margin-right: 0.5em; - font-size: 0.875em; - font-weight: normal; -} -dl.tsd-comment-tag-group dd { - margin: 0; -} -code.tsd-tag { - padding: 0.25em 0.4em; - border: 0.1em solid var(--color-accent); - margin-right: 0.25em; - font-size: 70%; -} -h1 code.tsd-tag:first-of-type { - margin-left: 0.25em; -} - -dl.tsd-comment-tag-group dd:before, -dl.tsd-comment-tag-group dd:after { - content: " "; -} -dl.tsd-comment-tag-group dd pre, -dl.tsd-comment-tag-group dd:after { - clear: both; -} -dl.tsd-comment-tag-group p { - margin: 0; -} - -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} - -.tsd-filter-visibility h4 { - font-size: 1rem; - padding-top: 0.75rem; - padding-bottom: 0.5rem; - margin: 0; -} -.tsd-filter-item:not(:last-child) { - margin-bottom: 0.5rem; -} -.tsd-filter-input { - display: flex; - width: fit-content; - width: -moz-fit-content; - align-items: center; - user-select: none; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - cursor: pointer; -} -.tsd-filter-input input[type="checkbox"] { - cursor: pointer; - position: absolute; - width: 1.5em; - height: 1.5em; - opacity: 0; -} -.tsd-filter-input input[type="checkbox"]:disabled { - pointer-events: none; -} -.tsd-filter-input svg { - cursor: pointer; - width: 1.5em; - height: 1.5em; - margin-right: 0.5em; - border-radius: 0.33em; - /* Leaving this at full opacity breaks event listeners on Firefox. - Don't remove unless you know what you're doing. */ - opacity: 0.99; -} -.tsd-filter-input input[type="checkbox"]:focus + svg { - transform: scale(0.95); -} -.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { - transform: scale(1); -} -.tsd-checkbox-background { - fill: var(--color-accent); -} -input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { - stroke: var(--color-text); -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { - fill: var(--color-background); - stroke: var(--color-accent); - stroke-width: 0.25rem; -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { - stroke: var(--color-accent); -} - -.tsd-theme-toggle { - padding-top: 0.75rem; -} -.tsd-theme-toggle > h4 { - display: inline; - vertical-align: middle; - margin-right: 0.75rem; -} - -.tsd-hierarchy { - list-style: square; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-full-hierarchy:not(:last-child) { - margin-bottom: 1em; - padding-bottom: 1em; - border-bottom: 1px solid var(--color-accent); -} -.tsd-full-hierarchy, -.tsd-full-hierarchy ul { - list-style: none; - margin: 0; - padding: 0; -} -.tsd-full-hierarchy ul { - padding-left: 1.5rem; -} -.tsd-full-hierarchy a { - padding: 0.25rem 0 !important; - font-size: 1rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} - -.tsd-panel-group.tsd-index-group { - margin-bottom: 0; -} -.tsd-index-panel .tsd-index-list { - list-style: none; - line-height: 1.333em; - margin: 0; - padding: 0.25rem 0 0 0; - overflow: hidden; - display: grid; - grid-template-columns: repeat(3, 1fr); - column-gap: 1rem; - grid-template-rows: auto; -} -@media (max-width: 1024px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(2, 1fr); - } -} -@media (max-width: 768px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); - } -} -.tsd-index-panel .tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} - -.tsd-flag { - display: inline-block; - padding: 0.25em 0.4em; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 75%; - line-height: 1; - font-weight: normal; -} - -.tsd-anchor { - position: relative; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} - -.tsd-navigation.settings { - margin: 1rem 0; -} -.tsd-navigation > a, -.tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.25rem); - display: flex; - align-items: center; -} -.tsd-navigation a, -.tsd-navigation summary > span, -.tsd-page-navigation a { - display: flex; - width: calc(100% - 0.25rem); - align-items: center; - padding: 0.25rem; - color: var(--color-text); - text-decoration: none; - box-sizing: border-box; -} -.tsd-navigation a.current, -.tsd-page-navigation a.current { - background: var(--color-active-menu-item); -} -.tsd-navigation a:hover, -.tsd-page-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul, -.tsd-page-navigation ul { - margin-top: 0; - margin-bottom: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li, -.tsd-page-navigation li { - padding: 0; - max-width: 100%; -} -.tsd-nested-navigation { - margin-left: 3rem; -} -.tsd-nested-navigation > li > details { - margin-left: -1.5rem; -} -.tsd-small-nested-navigation { - margin-left: 1.5rem; -} -.tsd-small-nested-navigation > li > details { - margin-left: -1.5rem; -} - -.tsd-page-navigation ul { - padding-left: 1.75rem; -} - -#tsd-sidebar-links a { - margin-top: 0; - margin-bottom: 0.5rem; - line-height: 1.25rem; -} -#tsd-sidebar-links a:last-of-type { - margin-bottom: 0; -} - -a.tsd-index-link { - padding: 0.25rem 0 !important; - font-size: 1rem; - line-height: 1.25rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} -.tsd-accordion-summary { - list-style-type: none; /* hide marker on non-safari */ - outline: none; /* broken on safari, so just hide it */ -} -.tsd-accordion-summary::-webkit-details-marker { - display: none; /* hide marker on safari */ -} -.tsd-accordion-summary, -.tsd-accordion-summary a { - user-select: none; - -moz-user-select: none; - -webkit-user-select: none; - -ms-user-select: none; - - cursor: pointer; -} -.tsd-accordion-summary a { - width: calc(100% - 1.5rem); -} -.tsd-accordion-summary > * { - margin-top: 0; - margin-bottom: 0; - padding-top: 0; - padding-bottom: 0; -} -.tsd-index-accordion .tsd-accordion-summary > svg { - margin-left: 0.25rem; -} -.tsd-index-content > :not(:first-child) { - margin-top: 0.75rem; -} -.tsd-index-heading { - margin-top: 1.5rem; - margin-bottom: 0.75rem; -} - -.tsd-kind-icon { - margin-right: 0.5rem; - width: 1.25rem; - height: 1.25rem; - min-width: 1.25rem; - min-height: 1.25rem; -} -.tsd-kind-icon path { - transform-origin: center; - transform: scale(1.1); -} -.tsd-signature > .tsd-kind-icon { - margin-right: 0.8rem; -} - -.tsd-panel { - margin-bottom: 2.5rem; -} -.tsd-panel.tsd-member { - margin-bottom: 4rem; -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, -.tsd-panel > h2, -.tsd-panel > h3 { - margin: 1.5rem -1.5rem 0.75rem -1.5rem; - padding: 0 1.5rem 0.75rem 1.5rem; -} -.tsd-panel > h1.tsd-before-signature, -.tsd-panel > h2.tsd-before-signature, -.tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: none; -} - -.tsd-panel-group { - margin: 4rem 0; -} -.tsd-panel-group.tsd-index-group { - margin: 2rem 0; -} -.tsd-panel-group.tsd-index-group details { - margin: 2rem 0; -} - -#tsd-search { - transition: background-color 0.2s; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 2.5rem; - height: 100%; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title, -#tsd-toolbar-links a { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - background-color: var(--color-background); - line-height: initial; - padding: 4px; -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-background-secondary); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current:not(.no-results), -#tsd-search .results li:hover:not(.no-results) { - background-color: var(--color-accent); -} -#tsd-search .results a { - display: flex; - align-items: center; - padding: 0.25rem; - box-sizing: border-box; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; -} -#tsd-search.has-focus { - background-color: var(--color-accent); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title, -#tsd-search.has-focus #tsd-toolbar-links a { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -#tsd-toolbar-links { - position: absolute; - top: 0; - right: 2rem; - height: 100%; - display: flex; - align-items: center; - justify-content: flex-end; -} -#tsd-toolbar-links a { - margin-left: 1.5rem; -} -#tsd-toolbar-links a:hover { - text-decoration: underline; -} - -.tsd-signature { - margin: 0 0 1rem 0; - padding: 1rem 0.5rem; - border: 1px solid var(--color-accent); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} - -.tsd-signature-keyword { - color: var(--color-ts-keyword); - font-weight: normal; -} - -.tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - list-style-type: none; -} -.tsd-signatures .tsd-signature { - margin: 0; - border-color: var(--color-accent); - border-width: 1px 0; - transition: background-color 0.1s; -} -.tsd-description .tsd-signatures .tsd-signature { - border-width: 1px; -} - -ul.tsd-parameter-list, -ul.tsd-type-parameter-list { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameter-list > li.tsd-parameter-signature, -ul.tsd-type-parameter-list > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameter-list h5, -ul.tsd-type-parameter-list h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -.tsd-sources { - margin-top: 1rem; - font-size: 0.875em; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: sticky; - z-index: 1; - top: 0; - left: 0; - width: 100%; - color: var(--color-text); - background: var(--color-background-secondary); - border-bottom: 1px var(--color-accent) solid; - transition: transform 0.3s ease-in-out; -} -.tsd-page-toolbar a { - color: var(--color-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .tsd-toolbar-contents { - display: flex; - justify-content: space-between; - height: 2.5rem; - margin: 0 auto; -} -.tsd-page-toolbar .table-cell { - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} -.tsd-page-toolbar .tsd-toolbar-icon { - box-sizing: border-box; - line-height: 0; - padding: 12px 0; -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.8; - height: 40px; - transition: - opacity 0.1s, - background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.9; -} -.tsd-widget.active { - opacity: 1; - background-color: var(--color-accent); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} - -.tsd-widget.options, -.tsd-widget.menu { - display: none; -} -input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; -} -input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -img { - max-width: 100%; -} - -.tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - vertical-align: middle; - color: var(--color-text); -} - -.tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; -} - -.tsd-anchor-link:hover > .tsd-anchor-icon svg { - visibility: visible; -} - -.deprecated { - text-decoration: line-through !important; -} - -.warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); -} - -.tsd-kind-project { - color: var(--color-ts-project); -} -.tsd-kind-module { - color: var(--color-ts-module); -} -.tsd-kind-namespace { - color: var(--color-ts-namespace); -} -.tsd-kind-enum { - color: var(--color-ts-enum); -} -.tsd-kind-enum-member { - color: var(--color-ts-enum-member); -} -.tsd-kind-variable { - color: var(--color-ts-variable); -} -.tsd-kind-function { - color: var(--color-ts-function); -} -.tsd-kind-class { - color: var(--color-ts-class); -} -.tsd-kind-interface { - color: var(--color-ts-interface); -} -.tsd-kind-constructor { - color: var(--color-ts-constructor); -} -.tsd-kind-property { - color: var(--color-ts-property); -} -.tsd-kind-method { - color: var(--color-ts-method); -} -.tsd-kind-call-signature { - color: var(--color-ts-call-signature); -} -.tsd-kind-index-signature { - color: var(--color-ts-index-signature); -} -.tsd-kind-constructor-signature { - color: var(--color-ts-constructor-signature); -} -.tsd-kind-parameter { - color: var(--color-ts-parameter); -} -.tsd-kind-type-literal { - color: var(--color-ts-type-literal); -} -.tsd-kind-type-parameter { - color: var(--color-ts-type-parameter); -} -.tsd-kind-accessor { - color: var(--color-ts-accessor); -} -.tsd-kind-get-signature { - color: var(--color-ts-get-signature); -} -.tsd-kind-set-signature { - color: var(--color-ts-set-signature); -} -.tsd-kind-type-alias { - color: var(--color-ts-type-alias); -} - -/* if we have a kind icon, don't color the text by kind */ -.tsd-kind-icon ~ span { - color: var(--color-text); -} - -* { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); -} - -*::-webkit-scrollbar { - width: 0.75rem; -} - -*::-webkit-scrollbar-track { - background: var(--color-icon-background); -} - -*::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); -} - -/* mobile */ -@media (max-width: 769px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } - - .container-main { - display: flex; - } - html .col-content { - float: none; - max-width: 100%; - width: 100%; - } - html .col-sidebar { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - width: 75vw; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); - } - html .col-sidebar > *:last-child { - padding-bottom: 20px; - } - html .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - - .to-has-menu .overlay { - animation: fade-in 0.4s; - } - - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; - } - .has-menu .tsd-navigation { - max-height: 100%; - } -} - -/* one sidebar */ -@media (min-width: 770px) { - .container-main { - display: grid; - grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); - grid-template-areas: "sidebar content"; - margin: 2rem auto; - } - - .col-sidebar { - grid-area: sidebar; - } - .col-content { - grid-area: content; - padding: 0 1rem; - } -} -@media (min-width: 770px) and (max-width: 1399px) { - .col-sidebar { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - padding-top: 1rem; - } - .site-menu { - margin-top: 1rem; - } -} - -/* two sidebars */ -@media (min-width: 1200px) { - .container-main { - grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); - grid-template-areas: "sidebar content toc"; - } - - .col-sidebar { - display: contents; - } - - .page-menu { - grid-area: toc; - padding-left: 1rem; - } - .site-menu { - grid-area: sidebar; - } - - .site-menu { - margin-top: 1rem 0; - } - - .page-menu, - .site-menu { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - } -} diff --git a/docs/classes/index.Admin.AdminApiClient.html b/docs/classes/index.Admin.AdminApiClient.html deleted file mode 100644 index f880dd88..00000000 --- a/docs/classes/index.Admin.AdminApiClient.html +++ /dev/null @@ -1,39 +0,0 @@ -AdminApiClient | @camunda8/sdk

Class AdminApiClient

Constructors

constructor -

Properties

oAuthProvider -rest -userAgentString -

Methods

createClient -createCluster -createMember -createSecret -deleteClient -deleteCluster -deleteMember -deleteSecret -getClient -getClients -getCluster -getClusters -getHeaders -getParameters -getSecrets -getUsers -whitelistIPs -

Constructors

constructor

  • new AdminApiClient(options?): AdminApiClient

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
          oAuthProvider?: IOAuthProvider;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>
      • Optional oAuthProvider?: IOAuthProvider

    Returns AdminApiClient

Properties

Private oAuthProvider

oAuthProvider: IOAuthProvider

Private rest

rest: Got

Private userAgentString

userAgentString: string

Methods

createClient

createCluster

createMember

createSecret

  • createSecret(__namedParameters): Promise<null>

  • Parameters

    • __namedParameters: {
          clusterUuid: string;
          secretName: string;
          secretValue: string;
      }
      • clusterUuid: string
      • secretName: string
      • secretValue: string

    Returns Promise<null>

    Description

    Create a new connector secret. See the API Documentation for more details.

    -

deleteClient

deleteCluster

deleteMember

deleteSecret

getClient

getClients

getCluster

getClusters

Private getHeaders

  • getHeaders(): Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

  • Returns Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

getParameters

getSecrets

  • getSecrets(clusterUuid): Promise<{
        [key: string]: string;
    }>

  • Parameters

    • clusterUuid: string

    Returns Promise<{
        [key: string]: string;
    }>

    Description

    Retrieve the connector secrets. See the API Documentation for more details.

    -

getUsers

whitelistIPs

  • whitelistIPs(clusterUuid, ipwhitelist): Promise<unknown>

  • Parameters

    • clusterUuid: string
    • ipwhitelist: [{
          description: string;
          ip: string;
      }]

    Returns Promise<unknown>

    Description

    Add one or more IPs to the whitelist for the cluster. See the API Documentation for more details.

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Auth.NullAuthProvider.html b/docs/classes/index.Auth.NullAuthProvider.html deleted file mode 100644 index e50d7860..00000000 --- a/docs/classes/index.Auth.NullAuthProvider.html +++ /dev/null @@ -1,3 +0,0 @@ -NullAuthProvider | @camunda8/sdk

Class NullAuthProvider

Implements

Constructors

constructor -

Methods

getToken -

Constructors

constructor

Methods

getToken

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Auth.OAuthProvider.html b/docs/classes/index.Auth.OAuthProvider.html deleted file mode 100644 index 220e906b..00000000 --- a/docs/classes/index.Auth.OAuthProvider.html +++ /dev/null @@ -1,36 +0,0 @@ -OAuthProvider | @camunda8/sdk

Class OAuthProvider

Implements

Constructors

constructor -

Properties

audienceMap -authServerUrl -cacheDir -camundaModelerOAuthAudience -clientId -clientSecret -consoleClientId -consoleClientSecret -customRootCert? -failed -failureCount -inflightTokenRequest? -isCamundaSaaS -scope -tokenCache -tokenRefreshThresholdMs -useFileCache -userAgentString -defaultTokenCache -

Methods

addAudienceIfNeeded -evictFromFileCache -evictFromMemoryCache -flushFileCache -flushMemoryCache -getAudience -getCacheKey -getCachedTokenFileName -getToken -isExpired -makeDebouncedTokenRequest -retrieveFromFileCache -sendToFileCache -sendToMemoryCache -

Constructors

constructor

  • new OAuthProvider(options?): OAuthProvider

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>

    Returns OAuthProvider

Properties

Private audienceMap

audienceMap: {
    CONSOLE: string;
    MODELER: string;
    OPERATE: string;
    OPTIMIZE: string;
    TASKLIST: string;
    ZEEBE: string;
}

Type declaration

  • CONSOLE: string
  • MODELER: string
  • OPERATE: string
  • OPTIMIZE: string
  • TASKLIST: string
  • ZEEBE: string

Private authServerUrl

authServerUrl: string

Private cacheDir

cacheDir: string

Private camundaModelerOAuthAudience

camundaModelerOAuthAudience: undefined | string

Private clientId

clientId: undefined | string

Private clientSecret

clientSecret: undefined | string

Private consoleClientId

consoleClientId: undefined | string

Private consoleClientSecret

consoleClientSecret: undefined | string

Private Optional customRootCert

customRootCert?: Buffer

Private failed

failed: boolean = false

Private failureCount

failureCount: number = 0

Private Optional inflightTokenRequest

inflightTokenRequest?: Promise<string>

Private isCamundaSaaS

isCamundaSaaS: boolean

Private scope

scope: undefined | string

tokenCache

tokenCache: {
    [key: string]: Token;
} = {}

Type declaration

Private tokenRefreshThresholdMs

tokenRefreshThresholdMs: number

Private useFileCache

useFileCache: boolean

userAgentString

userAgentString: string

Static Private Readonly defaultTokenCache

defaultTokenCache: string = ...

Methods

Private addAudienceIfNeeded

Private evictFromFileCache

Private evictFromMemoryCache

flushFileCache

flushMemoryCache

Private getAudience

Private getCacheKey

Private getCachedTokenFileName

getToken

Private isExpired

Private makeDebouncedTokenRequest

Private retrieveFromFileCache

Private sendToFileCache

Private sendToMemoryCache

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Camunda8.html b/docs/classes/index.Camunda8.html deleted file mode 100644 index b9486a47..00000000 --- a/docs/classes/index.Camunda8.html +++ /dev/null @@ -1,86 +0,0 @@ -Camunda8 | @camunda8/sdk

Class Camunda8

A single point of configuration for all Camunda Platform 8 clients.

-

This class is a facade for all the clients in the Camunda Platform 8 SDK.

-

Example

import { Camunda8 } from '@camunda8/sdk'

const c8 = new Camunda8()
const zeebe = c8.getZeebeGrpcClient()
const operate = c8.getOperateApiClient()
const optimize = c8.getOptimizeApiClient()
const tasklist = c8.getTasklistApiClient()
const modeler = c8.getModelerApiClient()
const admin = c8.getAdminApiClient()
-
-

Constructors

constructor -

Properties

adminApiClient? -configuration -modelerApiClient? -oAuthProvider -operateApiClient? -optimizeApiClient? -tasklistApiClient? -zeebeGrpcClient? -

Methods

getAdminApiClient -getModelerApiClient -getOperateApiClient -getOptimizeApiClient -getTasklistApiClient -getZeebeApiClient -

Constructors

constructor

  • new Camunda8(config?): Camunda8

  • Parameters

    • config: DeepPartial<{
          CAMUNDA_CONSOLE_BASE_URL: undefined | string;
          CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
          CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
          CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
          CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
          CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
          CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
          CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
          CAMUNDA_MODELER_BASE_URL: string;
          CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
          CAMUNDA_OAUTH_DISABLED: boolean;
          CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
          CAMUNDA_OAUTH_URL: undefined | string;
          CAMUNDA_OPERATE_BASE_URL: undefined | string;
          CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
          CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
          CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
          CAMUNDA_SECURE_CONNECTION: boolean;
          CAMUNDA_TASKLIST_BASE_URL: undefined | string;
          CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
          CAMUNDA_TENANT_ID: undefined | string;
          CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
          CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
          CAMUNDA_TOKEN_SCOPE: undefined | string;
          CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
          ZEEBE_ADDRESS: string;
          ZEEBE_CLIENT_ID: undefined | string;
          ZEEBE_CLIENT_SECRET: undefined | string;
          zeebeGrpcSettings: {
              GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
              GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
              GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
              GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
              GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
              GRPC_KEEPALIVE_TIMEOUT_MS: number;
              GRPC_KEEPALIVE_TIME_MS: number;
              GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
              GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
              ZEEBE_CLIENT_LOG_LEVEL: string;
              ZEEBE_CLIENT_LOG_TYPE: string;
              ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
              ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
              ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
              ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
              ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
              ZEEBE_GRPC_CLIENT_RETRY: boolean;
              ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
              ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
          };
      }> = {}

    Returns Camunda8

Properties

Private Optional adminApiClient

adminApiClient?: AdminApiClient

Private configuration

configuration: {
    CAMUNDA_CONSOLE_BASE_URL: undefined | string;
    CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
    CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
    CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
    CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
    CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
    CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
    CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
    CAMUNDA_MODELER_BASE_URL: string;
    CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
    CAMUNDA_OAUTH_DISABLED: boolean;
    CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
    CAMUNDA_OAUTH_URL: undefined | string;
    CAMUNDA_OPERATE_BASE_URL: undefined | string;
    CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
    CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
    CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
    CAMUNDA_SECURE_CONNECTION: boolean;
    CAMUNDA_TASKLIST_BASE_URL: undefined | string;
    CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
    CAMUNDA_TENANT_ID: undefined | string;
    CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
    CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
    CAMUNDA_TOKEN_SCOPE: undefined | string;
    CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
    ZEEBE_ADDRESS: string;
    ZEEBE_CLIENT_ID: undefined | string;
    ZEEBE_CLIENT_SECRET: undefined | string;
    zeebeGrpcSettings: {
        GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
        GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
        GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
        GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
        GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
        GRPC_KEEPALIVE_TIMEOUT_MS: number;
        GRPC_KEEPALIVE_TIME_MS: number;
        GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
        GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
        ZEEBE_CLIENT_LOG_LEVEL: string;
        ZEEBE_CLIENT_LOG_TYPE: string;
        ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
        ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
        ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
        ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
        ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
        ZEEBE_GRPC_CLIENT_RETRY: boolean;
        ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
        ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
    };
}

Type declaration

  • CAMUNDA_CONSOLE_BASE_URL: undefined | string

    The base url for the Admin Console API.

    -
  • CAMUNDA_CONSOLE_CLIENT_ID: undefined | string

    Credentials for Admin Console and Modeler API

    -
  • CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string

    Credentials for Admin Console and Modeler API

    -
  • CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string

    The audience parameter for an Admin Console OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise

    -
  • CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string

    When using custom or self-signed certificates, provide the path to the certificate chain

    -
  • CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string

    When using custom or self-signed certificates, provide the path to the private key

    -
  • CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string

    In an environment using self-signed certificates, provide the path to the root certificate

    -
  • CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string

    Custom user agent

    -
  • CAMUNDA_MODELER_BASE_URL: string

    The base url for the Modeler API. Defaults to Camunda Saas - https://modeler.cloud.camunda.io/api

    -
  • CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string

    The audience parameter for a Modeler OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise

    -
  • CAMUNDA_OAUTH_DISABLED: boolean

    Set to true to disable OAuth completely

    -
  • CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number

    How soon in milliseconds before its expiration time a cached OAuth token should be considered expired. Defaults to 1000

    -
  • CAMUNDA_OAUTH_URL: undefined | string

    The OAuth token exchange endpoint url

    -
  • CAMUNDA_OPERATE_BASE_URL: undefined | string

    The base url for the Operate API

    -
  • CAMUNDA_OPERATE_OAUTH_AUDIENCE: string

    The audience parameter for an Operate OAuth token request. Defaults to operate.camunda.io

    -
  • CAMUNDA_OPTIMIZE_BASE_URL: undefined | string

    The base url for the Optimize API

    -
  • CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string

    The audience parameter for an Optimize OAuth token request. Defaults to optimize.camunda.io

    -
  • CAMUNDA_SECURE_CONNECTION: boolean

    Control TLS for Zeebe Grpc. Defaults to true. Set to false when using an unsecured gateway

    -
  • CAMUNDA_TASKLIST_BASE_URL: undefined | string

    The base url for the Tasklist API

    -
  • CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string

    The audience parameter for a Tasklist OAuth token request. Defaults to tasklist.camunda.io

    -
  • CAMUNDA_TENANT_ID: undefined | string

    The tenant id when multi-tenancy is enabled

    -
  • CAMUNDA_TOKEN_CACHE_DIR: undefined | string

    The directory to cache OAuth tokens on-disk. Defaults to $HOME/.camunda

    -
  • CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean

    Set to true to disable disk caching of OAuth tokens and use memory caching only

    -
  • CAMUNDA_TOKEN_SCOPE: undefined | string

    Optional scope parameter for OAuth (needed by some OIDC)

    -
  • CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string

    The audience parameter for a Zeebe OAuth token request. Defaults to zeebe.camunda.io

    -
  • ZEEBE_ADDRESS: string

    The address for the Zeebe Gateway. Defaults to localhost:26500

    -
  • ZEEBE_CLIENT_ID: undefined | string

    This is the client ID for the client credentials

    -
  • ZEEBE_CLIENT_SECRET: undefined | string

    This is the client secret for the client credentials

    -
  • zeebeGrpcSettings: {
        GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
        GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
        GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
        GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
        GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
        GRPC_KEEPALIVE_TIMEOUT_MS: number;
        GRPC_KEEPALIVE_TIME_MS: number;
        GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
        GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
        ZEEBE_CLIENT_LOG_LEVEL: string;
        ZEEBE_CLIENT_LOG_TYPE: string;
        ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
        ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
        ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
        ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
        ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
        ZEEBE_GRPC_CLIENT_RETRY: boolean;
        ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
        ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
    }
    • GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number

      This channel argument controls the maximum number -of pings that can be sent when there is no other -data (data frame or header frame) to be sent. -GRPC Core will not continue sending pings if we -run over the limit. Setting it to 0 allows sending -pings without sending data.

      -
    • GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number

      Minimum allowed time between a server receiving -successive ping frames without sending any data -frame. Int valued, milliseconds. Default: 90000

      -
    • GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number

      Defaults to 90000.

      -
    • GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number

      The time between the first and second connection attempts, -in ms. Defaults to 1000.

      -
    • GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number

      This channel argument if set to 1 -(0 : false; 1 : true), allows keepalive pings -to be sent even if there are no calls in flight. -Defaults to 1.

      -
    • GRPC_KEEPALIVE_TIMEOUT_MS: number

      After waiting for a duration of this time, if the keepalive ping sender does not receive the ping ack, it will close the -transport. Int valued, milliseconds. Defaults to 120000.

      -
    • GRPC_KEEPALIVE_TIME_MS: number

      After a duration of this time the client/server pings its peer to see if the transport is still alive. -Int valued, milliseconds. Defaults to 360000.

      -
    • GRPC_MAX_RECONNECT_BACKOFF_MS: string | number

      The maximum time between subsequent connection attempts, -in ms. Defaults to 10000.

      -
    • GRPC_MIN_RECONNECT_BACKOFF_MS: string | number

      The minimum time between subsequent connection attempts, -in ms. Default is 1000ms, but this can cause an SSL Handshake failure. -This causes an intermittent failure in the Worker-LongPoll test when run -against Camunda Cloud. -Raised to 5000ms. -See: https://github.com/grpc/grpc/issues/8382#issuecomment-259482949

      -
    • ZEEBE_CLIENT_LOG_LEVEL: string

      Log level of Zeebe Client and Workers - 'DEBUG' | 'INFO' | 'NONE'. Defaults to 'INFO'

      -
    • ZEEBE_CLIENT_LOG_TYPE: string

      Zeebe client log output can be human-readable 'SIMPLE' or structured 'JSON'. Defaults to 'SIMPLE'

      -
    • ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number

      The gRPC channel can "jitter". This suppresses a connection error message if the channel comes back within this window in milliseconds. Defaults to 3000

      -
    • ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean

      Immediately connect to the Zeebe Gateway (issues a silent topology request). Defaults to false

      -
    • ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number

      This suppresses intermediate errors during initial connection negotiation. On Camunda SaaS this defaults to 6000, on Self-Managed to 0

      -
    • ZEEBE_GRPC_CLIENT_MAX_RETRIES: number

      Maximum number of retries of network operations before failing. Defaults to -1 (infinite retries)

      -
    • ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number

      When retrying failed network operations, retries back off to this maximum period. Defaults to 10s

      -
    • ZEEBE_GRPC_CLIENT_RETRY: boolean

      Automate retrying operations that fail due to network conditions or broker backpressure. Defaults to true

      -
    • ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number

      How long in seconds the long poll Job Activation request is held open by a worker. Defaults to 60

      -
    • ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number

      After a long poll Job Activation request, this is the cool-off period in milliseconds before the worker requests more work. Defaults to 300

      -

Private Optional modelerApiClient

modelerApiClient?: ModelerApiClient

Private oAuthProvider

oAuthProvider: OAuthProvider

Private Optional operateApiClient

operateApiClient?: OperateApiClient

Private Optional optimizeApiClient

optimizeApiClient?: OptimizeApiClient

Private Optional tasklistApiClient

tasklistApiClient?: TasklistApiClient

Private Optional zeebeGrpcClient

zeebeGrpcClient?: ZeebeGrpcClient

Methods

getAdminApiClient

getModelerApiClient

getOperateApiClient

getOptimizeApiClient

getTasklistApiClient

getZeebeApiClient

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Modeler.ModelerApiClient.html b/docs/classes/index.Modeler.ModelerApiClient.html deleted file mode 100644 index e18e9d45..00000000 --- a/docs/classes/index.Modeler.ModelerApiClient.html +++ /dev/null @@ -1,127 +0,0 @@ -ModelerApiClient | @camunda8/sdk

Class ModelerApiClient

Constructors

constructor -

Properties

oAuthProvider -rest -userAgentString -

Methods

addCollaborator -createFile -createFolder -createMilestone -createProject -decodeResponseOrThrow -deleteCollaborator -deleteFile -deleteFolder -deleteMilestone -deleteProject -getFile -getFolder -getHeaders -getInfo -getMilestone -getMilestoneComparison -getProject -renameProject -searchCollaborators -searchFiles -searchMilestones -searchProjects -updateFile -updateFolder -

Constructors

constructor

  • new ModelerApiClient(options?): ModelerApiClient

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
          oAuthProvider?: IOAuthProvider;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>
      • Optional oAuthProvider?: IOAuthProvider

    Returns ModelerApiClient

Properties

Private oAuthProvider

oAuthProvider: IOAuthProvider

Private rest

rest: Got

Private userAgentString

userAgentString: string

Methods

addCollaborator

  • addCollaborator(req): Promise<null>

  • Adds a new collaborator to a project or modifies the permission level of an existing collaborator. -Note: Only users that are part of the authorized organization (see GET /api/v1/info) and logged in to Web Modeler at least once can be added to a project.

    -

    Parameters

    Returns Promise<null>

createFile

  • createFile(req): Promise<FileMetadataDto>

  • This endpoint creates a file.

    -

    To create a file, specify projectId and/or folderId:

    -

    When only folderId is given, the file will be created in that folder. The folder can be in any project of the same organization.

    -

    When projectId is given and folderId is either null or omitted altogether, the file will be created in the root of the project.

    -

    When projectId and folderId are both given, they must be consistent - i.e. the folder is in the project.

    -

    For connector templates, the following constraints apply:

    -

    The value of content.$schema will be replaced with https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json and validated against it.

    -

    The value of name takes precedence over content.name. In case of mismatch, the latter will be adjusted to match the former automatically.

    -

    The value of content.id will be replaced with the file id generated by Web Modeler.

    -

    The value of content.version is managed by Web Modeler and will be updated automatically.

    -

    Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("/"). This form of escaping facilitates the processing of path-like structures within file and folder names.

    -

    Parameters

    Returns Promise<FileMetadataDto>

createFolder

  • createFolder(req): Promise<FolderMetadataDto>

  • Creates a new folder.

    -

    When only parentId is given, the folder will be created in that folder. The folder can be in any project of the same organization.

    -

    When projectId is given and parentId is either null or omitted altogether, the folder will be created in the root of the project.

    -

    When projectId and parentId are both given, they must be consistent - i.e. the parent folder is in the project.

    -

    Parameters

    Returns Promise<FolderMetadataDto>

createMilestone

createProject

Private decodeResponseOrThrow

deleteCollaborator

  • deleteCollaborator(__namedParameters): Promise<null>

  • Parameters

    • __namedParameters: {
          email: string;
          projectId: string;
      }
      • email: string
      • projectId: string

    Returns Promise<null>

deleteFile

  • deleteFile(fileId): Promise<null>

  • Deletes a file. -Note: Deleting a file will also delete other resources attached to the file (comments, call activity/business rule task links, milestones and shares) which might have side-effects. Deletion of resources is recursive and cannot be undone.

    -

    Parameters

    • fileId: string

    Returns Promise<null>

deleteFolder

  • deleteFolder(folderId): Promise<null>

  • Deletes an empty folder. A folder is considered empty if there are no files in it. Deletion of resources is recursive and cannot be undone.

    -

    Parameters

    • folderId: string

    Returns Promise<null>

deleteMilestone

  • deleteMilestone(milestoneId): Promise<null | string>

  • Deletion of resources is recursive and cannot be undone.

    -

    Parameters

    • milestoneId: string

    Returns Promise<null | string>

deleteProject

  • deleteProject(projectId): Promise<null | string>

  • This endpoint deletes an empty project. A project is considered empty if there are no files in it. Deletion of resources is recursive and cannot be undone.

    -

    Parameters

    • projectId: string

    Returns Promise<null | string>

getFile

  • getFile(fileId): Promise<FileDto>

  • Retrieves a file.

    -

    Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an -escape sequence consisting of a backslash followed by a slash ("/"). This form of escaping -facilitates the processing of path-like structures within file and folder names.

    -

    Does this throw if it is not found?

    -

    Parameters

    • fileId: string

    Returns Promise<FileDto>

getFolder

Private getHeaders

  • getHeaders(): Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

  • Returns Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

getInfo

getMilestone

getMilestoneComparison

  • getMilestoneComparison(milestone1Id, milestone2Id): Promise<string>

  • Returns a link to a visual comparison between two milestones where the milestone referenced by milestone1Id acts as a baseline to compare the milestone referenced by milestone2Id against.

    -

    Parameters

    • milestone1Id: string
    • milestone2Id: string

    Returns Promise<string>

getProject

renameProject

searchCollaborators

searchFiles

  • searchFiles(req): Promise<PubSearchResultDtoFileMetadataDto>

  • Searches for files. -filter specifies which fields should match. Only items that match the given fields will be returned.

    -

    Note: Date fields need to be specified in a format compatible with java.time.ZonedDateTime; for example 2023-09-20T11:31:20.206801604Z.

    -

    You can use suffixes to match date ranges:

    -

    Modifier Description -||/y Within a year -||/M Within a month -||/w Within a week -||/d Within a day -||/h Within an hour -||/m Within a minute -||/s Within a second

    -

    sort specifies by which fields and direction (ASC/DESC) the result should be sorted.

    -

    page specifies the page number to return. -size specifies the number of items per page. The default value is 10.

    -

    Note: The simplePath transform any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("/"). This form of escaping facilitates the processing of path-like structures within file and folder names.

    -

    Parameters

    Returns Promise<PubSearchResultDtoFileMetadataDto>

searchMilestones

  • searchMilestones(req): Promise<PubSearchResultDtoMilestoneMetadataDto>

  • Searches for milestones.

    -

    filter specifies which fields should match. Only items that match the given fields will be returned.

    -

    Note: Date fields need to be specified in a format compatible with java.time.ZonedDateTime; for example 2023-09-20T11:31:20.206801604Z.

    -

    You can use suffixes to match date ranges:

    -

    Modifier Description -||/y Within a year -||/M Within a month -||/w Within a week -||/d Within a day -||/h Within an hour -||/m Within a minute -||/s Within a second -sort specifies by which fields and direction (ASC/DESC) the result should be sorted.

    -

    page specifies the page number to return.

    -

    size specifies the number of items per page. The default value is 10.

    -

    Parameters

    Returns Promise<PubSearchResultDtoMilestoneMetadataDto>

searchProjects

  • searchProjects(req): Promise<PubSearchResultDtoProjectMetadataDto>

  • Searches for projects.

    -

    filter specifies which fields should match. Only items that match the given fields will be returned.

    -

    Note: Date fields need to be specified in a format compatible with java.time.ZonedDateTime; for example 2023-09-20T11:31:20.206801604Z.

    -

    You can use suffixes to match date ranges:

    -

    Modifier Description -||/y Within a year -||/M Within a month -||/w Within a week -||/d Within a day -||/h Within an hour -||/m Within a minute -||/s Within a second

    -

    sort specifies by which fields and direction (ASC/DESC) the result should be sorted.

    -

    page specifies the page number to return.

    -

    size specifies the number of items per page. The default value is 10.

    -

    Parameters

    Returns Promise<PubSearchResultDtoProjectMetadataDto>

updateFile

  • updateFile(fileId, update): Promise<FileMetadataDto>

  • Updates the content, name, or location of a file, or all at the same time.

    -

    To move a file, specify projectId and/or folderId: -When only folderId is given, the file will be moved to that folder. The folder can be in another project of the same organization. -When projectId is given and folderId is either null or omitted altogether, the file will be moved to the root of the project. -When projectId and folderId are both given, they must be consistent - i.e. the new parent folder is in the new project. -The field revision holds the current revision of the file. This is used for detecting and preventing concurrent modifications. -For connector templates, the following constraints apply: -The value of content.$schema is not updatable. -The value of content.name can only be changed via name. -The value of content.id is not updatable. -The value of content.version is managed by Web Modeler and will be updated automatically. -Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("/"). This form of escaping facilitates the processing of path-like structures within file and folder names.

    -

    Parameters

    Returns Promise<FileMetadataDto>

updateFolder

  • updateFolder(folderId, update): Promise<FolderMetadataDto>

  • Updates the name or location of a folder, or both at the same time.

    -

    To move a folder, specify projectId and/or parentId:

    -

    When only parentId is given, the file will be moved to that folder. The folder must keep in the same organization.

    -

    When projectId is given and parentId is either null or omitted altogether, the file will be moved to the root of the project.

    -

    When projectId and parentId are both given, they must be consistent - i.e. the new parent folder is in the new project.

    -

    Parameters

    Returns Promise<FolderMetadataDto>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Operate.OperateApiClient.html b/docs/classes/index.Operate.OperateApiClient.html deleted file mode 100644 index 57407655..00000000 --- a/docs/classes/index.Operate.OperateApiClient.html +++ /dev/null @@ -1,65 +0,0 @@ -OperateApiClient | @camunda8/sdk

Class OperateApiClient

Description

The high-level client for Operate.

-

Example

const operate = new OperateApiClient()

operate.searchProcessInstances({
    filter: {
        state: "ACTIVE"
    },
    size: 50
}).then(instances => {
    console.log(instances)
})
-
-

Constructors

constructor -

Properties

oAuthProvider -rest -tenantId -userAgentString -

Methods

addTenantIdToFilter -deleteProcessInstance -getDecisionDefinition -getDecisionInstance -getDecisionRequirements -getDecisionRequirementsXML -getFlownodeInstance -getHeaders -getIncident -getJSONVariablesforProcess -getProcessDefinition -getProcessDefinitionXML -getProcessInstance -getProcessInstanceSequenceFlows -getProcessInstanceStatistics -getVariables -getVariablesforProcess -safeJSONparse -searchDecisionDefinitions -searchDecisionInstances -searchDecisionRequirements -searchFlownodeInstances -searchIncidents -searchProcessDefinitions -searchProcessInstances -searchVariables -

Constructors

constructor

  • new OperateApiClient(options?): OperateApiClient

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
          oAuthProvider?: IOAuthProvider;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>
      • Optional oAuthProvider?: IOAuthProvider

    Returns OperateApiClient

    Example

    const operate = new OperateApiClient()
-
    -

Properties

Private oAuthProvider

oAuthProvider: IOAuthProvider

Private rest

rest: Got

Private tenantId

tenantId: undefined | string

Private userAgentString

userAgentString: string

Methods

Protected addTenantIdToFilter

deleteProcessInstance

  • deleteProcessInstance(processInstanceKey): Promise<ChangeStatus>

  • Parameters

    • processInstanceKey: string | number

    Returns Promise<ChangeStatus>

    Description

    Delete a specific process instance by key.

    -

    Example

    const operate = new OperateApiClient()
    await operate.deleteProcessInstance(2251799819847322)
-
    -

getDecisionDefinition

getDecisionInstance

getDecisionRequirements

getDecisionRequirementsXML

getFlownodeInstance

Private getHeaders

  • getHeaders(): Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

  • Returns Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

getIncident

  • getIncident(key): Promise<Incident>

  • Parameters

    • key: string | number

    Returns Promise<Incident>

    Description

    Retrieve an incident by incident key.

    -

    Example

    const operate = new OperateApiClient()
    const incident = await operate.getIncident(2251799818436725)
    console.log(incident.message)
-
    -

getJSONVariablesforProcess

  • getJSONVariablesforProcess<T>(processInstanceKey): Promise<T>

  • Type Parameters

    • T extends {
          [key: string]: JSONDoc;
      }

    Parameters

    • processInstanceKey: string | number

    Returns Promise<T>

    Description

    Retrieve the variables for a Process Instance as an object, given its key

    -

getProcessDefinition

getProcessDefinitionXML

getProcessInstance

  • getProcessInstance(processInstanceKey): Promise<ProcessInstance>

  • Parameters

    • processInstanceKey: string | number

    Returns Promise<ProcessInstance>

    Description

    Retrieve a specific process instance by id.

    -

    Example

    const operate = new OperateApiClient()
    const instance = await operate.getProcessInstance(2251799819847322)
-
    -

getProcessInstanceSequenceFlows

  • getProcessInstanceSequenceFlows(processInstanceKey): Promise<string[]>

  • Parameters

    • processInstanceKey: string | number

    Returns Promise<string[]>

    Description

    Get sequence flows of process instance by key

    -

getProcessInstanceStatistics

getVariables

getVariablesforProcess

Private safeJSONparse

searchDecisionDefinitions

searchDecisionInstances

searchDecisionRequirements

searchFlownodeInstances

searchIncidents

searchProcessDefinitions

searchProcessInstances

searchVariables

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Operate.OperateDto.ChangeStatus.html b/docs/classes/index.Operate.OperateDto.ChangeStatus.html deleted file mode 100644 index fad534ec..00000000 --- a/docs/classes/index.Operate.OperateDto.ChangeStatus.html +++ /dev/null @@ -1,8 +0,0 @@ -ChangeStatus | @camunda8/sdk

Class ChangeStatus

Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values. -Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

-

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-
-

Hierarchy (view full)

Constructors

constructor -

Properties

deleted -message -

Constructors

constructor

Properties

deleted

deleted: string

message

message: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Operate.OperateDto.DecisionDefinition.html b/docs/classes/index.Operate.OperateDto.DecisionDefinition.html deleted file mode 100644 index 2665d222..00000000 --- a/docs/classes/index.Operate.OperateDto.DecisionDefinition.html +++ /dev/null @@ -1,16 +0,0 @@ -DecisionDefinition | @camunda8/sdk

Class DecisionDefinition

Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values. -Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

-

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-
-

Hierarchy (view full)

Constructors

constructor -

Properties

decisionId -decisionRequirementsId -decisionRequirementsKey -decisionRequirementsName -decisionRequirementsVersion -id -key -name -tenantId -version -

Constructors

constructor

Properties

decisionId

decisionId: string

decisionRequirementsId

decisionRequirementsId: string

decisionRequirementsKey

decisionRequirementsKey: string

decisionRequirementsName

decisionRequirementsName: string

decisionRequirementsVersion

decisionRequirementsVersion: number

id

id: string

key

key: string

name

name: string

tenantId

tenantId: undefined | string

version

version: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Operate.OperateDto.DecisionInstance.html b/docs/classes/index.Operate.OperateDto.DecisionInstance.html deleted file mode 100644 index e97baf8e..00000000 --- a/docs/classes/index.Operate.OperateDto.DecisionInstance.html +++ /dev/null @@ -1,21 +0,0 @@ -DecisionInstance | @camunda8/sdk

Class DecisionInstance

Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values. -Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

-

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-
-

Hierarchy (view full)

Constructors

constructor -

Properties

decisionDefinitionId -decisionId -decisionName -decisionType -decisionVersion -evaluatedInputs -evaluatedOutputs -evaluationDate -evaluationFailure -id -key -processDefinitionKey -result -state -tenantId -

Constructors

constructor

Properties

decisionDefinitionId

decisionDefinitionId: string

decisionId

decisionId: string

decisionName

decisionName: string

decisionType

decisionType: "UNKNOWN" | "UNSPECIFIED" | "DECISION_TABLE" | "LITERAL_EXPRESSION"

decisionVersion

decisionVersion: number

evaluatedInputs

evaluatedInputs: DecisionInstanceInput[]

evaluatedOutputs

evaluatedOutputs: DecisionInstanceOutput[]

evaluationDate

evaluationDate: string

evaluationFailure

evaluationFailure: string

id

id: string

key

key: string

processDefinitionKey

processDefinitionKey: string

result

result: string

state

state: "FAILED" | "EVALUATED" | "UNKNOWN" | "UNSPECIFIED"

tenantId

tenantId: undefined | string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Operate.OperateDto.DecisionInstanceInput.html b/docs/classes/index.Operate.OperateDto.DecisionInstanceInput.html deleted file mode 100644 index ce2299ad..00000000 --- a/docs/classes/index.Operate.OperateDto.DecisionInstanceInput.html +++ /dev/null @@ -1,9 +0,0 @@ -DecisionInstanceInput | @camunda8/sdk

Class DecisionInstanceInput

Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values. -Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

-

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-
-

Hierarchy (view full)

Constructors

constructor -

Properties

id -name -value -

Constructors

constructor

Properties

id

id: string

name

name: string

value

value: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Operate.OperateDto.DecisionInstanceOutput.html b/docs/classes/index.Operate.OperateDto.DecisionInstanceOutput.html deleted file mode 100644 index ef62e610..00000000 --- a/docs/classes/index.Operate.OperateDto.DecisionInstanceOutput.html +++ /dev/null @@ -1,11 +0,0 @@ -DecisionInstanceOutput | @camunda8/sdk

Class DecisionInstanceOutput

Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values. -Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

-

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-
-

Hierarchy (view full)

Constructors

constructor -

Properties

id -name -ruleId -ruleIndex -value -

Constructors

constructor

Properties

id

id: string

name

name: string

ruleId

ruleId: string

ruleIndex

ruleIndex: number

value

value: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Operate.OperateDto.DecisionRequirements.html b/docs/classes/index.Operate.OperateDto.DecisionRequirements.html deleted file mode 100644 index 0fe9ba92..00000000 --- a/docs/classes/index.Operate.OperateDto.DecisionRequirements.html +++ /dev/null @@ -1,13 +0,0 @@ -DecisionRequirements | @camunda8/sdk

Class DecisionRequirements

Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values. -Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

-

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-
-

Hierarchy (view full)

Constructors

constructor -

Properties

decisionRequirementsId -id -key -name -resourceName -tenantId -version -

Constructors

constructor

Properties

decisionRequirementsId

decisionRequirementsId: string

id

id: string

key

key: string

name

name: string

resourceName

resourceName: string

tenantId

tenantId: undefined | string

version

version: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Operate.OperateDto.FlownodeInstance.html b/docs/classes/index.Operate.OperateDto.FlownodeInstance.html deleted file mode 100644 index a433a8d0..00000000 --- a/docs/classes/index.Operate.OperateDto.FlownodeInstance.html +++ /dev/null @@ -1,15 +0,0 @@ -FlownodeInstance | @camunda8/sdk

Class FlownodeInstance

Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values. -Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

-

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-
-

Hierarchy (view full)

Constructors

constructor -

Properties

endDate -incident -incidentKey? -key -processInstanceKey -startDate -state -tenantId -type -

Constructors

constructor

Properties

endDate

endDate: string

incident

incident: boolean

Optional incidentKey

incidentKey?: string

key

key: string

processInstanceKey

processInstanceKey: string

startDate

startDate: string

state

state: "ACTIVE" | "COMPLETED" | "TERMINATED"

tenantId

tenantId: undefined | string

type

type: "UNKNOWN" | "UNSPECIFIED" | "PROCESS" | "SUB_PROCESS" | "EVENT_SUB_PROCESS" | "START_EVENT" | "INTERMEDIATE_CATCH_EVENT" | "INTERMEDIATE_THROW_EVENT" | "BOUNDARY_EVENT" | "END_EVENT" | "SERVICE_TASK" | "RECEIVE_TASK" | "USER_TASK" | "MANUAL_TASK" | "TASK" | "EXCLUSIVE_GATEWAY" | "INCLUSIVE_GATEWAY" | "PARALLEL_GATEWAY" | "EVENT_BASED_GATEWAY" | "SEQUENCE_FLOW" | "MULTI_INSTANCE_BODY" | "CALL_ACTIVITY" | "BUSINESS_RULE_TASK" | "SCRIPT_TASK" | "SEND_TASK"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Operate.OperateDto.Incident.html b/docs/classes/index.Operate.OperateDto.Incident.html deleted file mode 100644 index 44d19760..00000000 --- a/docs/classes/index.Operate.OperateDto.Incident.html +++ /dev/null @@ -1,15 +0,0 @@ -Incident | @camunda8/sdk

Class Incident

Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values. -Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

-

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-
-

Hierarchy (view full)

Constructors

constructor -

Properties

creationTime -jobKey -key -message -processDefinitionKey -processInstanceKey -state -tenantId -type -

Constructors

constructor

Properties

creationTime

creationTime: string

jobKey

jobKey: string

key

key: string

message

message: string

processDefinitionKey

processDefinitionKey: LosslessNumber

processInstanceKey

processInstanceKey: LosslessNumber

state

state: "ACTIVE" | "RESOLVED"

tenantId

tenantId: undefined | string

type

type: "UNKNOWN" | "UNSPECIFIED" | "IO_MAPPING_ERROR" | "JOB_NO_RETRIES" | "CONDITION_ERROR" | "EXTRACT_VALUE_ERROR" | "CALLED_ELEMENT_ERROR" | "UNHANDLED_ERROR_EVENT" | "MESSAGE_SIZE_EXCEEDED" | "CALLED_DECISION_ERROR" | "DECISION_EVALUATION_ERROR"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Operate.OperateDto.ProcessDefinition.html b/docs/classes/index.Operate.OperateDto.ProcessDefinition.html deleted file mode 100644 index 1eb07e5e..00000000 --- a/docs/classes/index.Operate.OperateDto.ProcessDefinition.html +++ /dev/null @@ -1,11 +0,0 @@ -ProcessDefinition | @camunda8/sdk

Class ProcessDefinition

Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values. -Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

-

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-
-

Hierarchy (view full)

Constructors

constructor -

Properties

bpmnProcessId -key -name -version -

Constructors

constructor

Properties

bpmnProcessId

bpmnProcessId: string

key

key: string

ProcessDefinition key is a string in the SDK, but it's an int64 number in the database

-

name

name: string

version

version: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Operate.OperateDto.ProcessInstance.html b/docs/classes/index.Operate.OperateDto.ProcessInstance.html deleted file mode 100644 index 9889cba8..00000000 --- a/docs/classes/index.Operate.OperateDto.ProcessInstance.html +++ /dev/null @@ -1,16 +0,0 @@ -ProcessInstance | @camunda8/sdk

Class ProcessInstance

Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values. -Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

-

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-
-

Hierarchy (view full)

Constructors

constructor -

Properties

bpmnProcessId -endDate -key -parentFlowNodeInstanceKey? -parentKey? -processDefinitionKey -processVersion -startDate -state -tenantId -

Constructors

constructor

Properties

bpmnProcessId

bpmnProcessId: string

endDate

endDate: string

key

key: string

Optional parentFlowNodeInstanceKey

parentFlowNodeInstanceKey?: string

Optional parentKey

parentKey?: string

processDefinitionKey

processDefinitionKey: string

processVersion

processVersion: number

startDate

startDate: string

state

state: "ACTIVE" | "COMPLETED" | "CANCELED"

tenantId

tenantId: undefined | string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Operate.OperateDto.ProcessInstanceStatistics.html b/docs/classes/index.Operate.OperateDto.ProcessInstanceStatistics.html deleted file mode 100644 index 99e3aba2..00000000 --- a/docs/classes/index.Operate.OperateDto.ProcessInstanceStatistics.html +++ /dev/null @@ -1,11 +0,0 @@ -ProcessInstanceStatistics | @camunda8/sdk

Class ProcessInstanceStatistics

Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values. -Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

-

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-
-

Hierarchy (view full)

Constructors

constructor -

Properties

active -activityId -canceled -completed -incidents -

Constructors

constructor

Properties

active

active: string

activityId

activityId: string

canceled

canceled: string

completed

completed: string

incidents

incidents: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Operate.OperateDto.Variable.html b/docs/classes/index.Operate.OperateDto.Variable.html deleted file mode 100644 index 3b3a3cd2..00000000 --- a/docs/classes/index.Operate.OperateDto.Variable.html +++ /dev/null @@ -1,12 +0,0 @@ -Variable | @camunda8/sdk

Class Variable

Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values. -Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

-

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-
-

Hierarchy (view full)

Constructors

constructor -

Properties

key -name -processInstanceKey -scopeKey -truncated -value -

Constructors

constructor

Properties

key

key: string

name

name: string

processInstanceKey

processInstanceKey: string

scopeKey

scopeKey: string

truncated

truncated: boolean

value

value: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Optimize.OptimizeApiClient.html b/docs/classes/index.Optimize.OptimizeApiClient.html deleted file mode 100644 index a8428282..00000000 --- a/docs/classes/index.Optimize.OptimizeApiClient.html +++ /dev/null @@ -1,83 +0,0 @@ -OptimizeApiClient | @camunda8/sdk

Class OptimizeApiClient

Description

The high-level API client for Optimize.

-

Example

const optimize = new OptimizeApiClient()

async function main() {
    await optimize.enableSharing()
    const id = "8a7103a7-c086-48f8-b5b7-a7f83e864688"
    const res = await optimize.exportDashboardDefinitions([id])
    fs.writeFileSync('exported-dashboard.json', JSON.stringify(res, null, 2))
}

main()
-
-

Constructors

constructor -

Properties

oAuthProvider -rest -userAgentString -

Methods

deleteReport -disableSharing -enableSharing -exportDashboardDefinitions -exportReportDefinitions -exportReportResultData -getDashboardIds -getHeaders -getReadiness -getReportIds -importEntities -ingestExternalVariable -labelVariables -

Constructors

constructor

  • new OptimizeApiClient(options?): OptimizeApiClient

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
          oAuthProvider?: IOAuthProvider;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>
      • Optional oAuthProvider?: IOAuthProvider

    Returns OptimizeApiClient

    Example

    const optimize = new OptimizeApiClient()
-
    -

Properties

Private oAuthProvider

oAuthProvider: IOAuthProvider

Private rest

rest: Got

Private userAgentString

userAgentString: string

Methods

deleteReport

  • deleteReport(reportId): Promise<string>

  • Parameters

    • reportId: string

      The ID of the report you wish to delete

      -

    Returns Promise<string>

    Description

    The report deletion API allows you to delete reports by ID from Optimize.

    -

    Camunda 8 documentation

    -

    Example

    const client = new OptimizeApiClient()
    client.deleteReport("e6c5aaa1-6a18-44e7-8480-d562d511ba62")
-
    -

disableSharing

  • disableSharing(): Promise<Response<string>>

  • Returns Promise<Response<string>>

    Description

    This API allows users to disable the sharing functionality for all reports and dashboards in Optimize.

    -

    Note that this setting will be permanently persisted in memory and will take precedence over any other previous configurations (e.g. configuration files).

    -

    When sharing is disabled, previously shared URLs will no longer be accessible. Upon re-enabling sharing, the previously shared URLs will work once again under the same address as before. Calling this endpoint when sharing is already disabled will have no effect.

    -

    Camunda 8 Documentation

    -

    Example

    const client = new OptimizeApiClient()
    client.disableSharing()
-
    -

enableSharing

  • enableSharing(): Promise<Response<string>>

  • Returns Promise<Response<string>>

    Description

    This API allows users to enable the sharing functionality for all reports and dashboards in Optimize.

    -

    Note that this setting will be permanently persisted in memory and will take precedence over any other previous configurations (e.g. configuration files).

    -

    If sharing had been previously enabled and then disabled, re-enabling sharing will allow users to access previously shared URLs under the same address as before. Calling this endpoint when sharing is already enabled will have no effect.

    -

    Camunda 8 Documentation

    -

    Example

    const client = new OptimizeApiClient()
    client.enableSharing()
-
    -

exportDashboardDefinitions

  • exportDashboardDefinitions(dashboardIds): Promise<unknown[]>

  • Parameters

    • dashboardIds: string[]

      Array of dashboard ids

      -

    Returns Promise<unknown[]>

    Description

    This API allows users to export dashboard definitions which can later be imported into another Optimize system.

    -

    Note that exporting a dashboard also exports all reports contained within the dashboard. The dashboards to be exported may be within a Collection or private entities, the API has access to both.

    -

    The obtained list of entity exports can be imported into other Optimize systems either using the dedicated import API or via UI.

    -

    Camunda 8 Documentation

    -

    Example

    const client = new OptimizeApiClient()
    const dashboardDefs = await client.exportDashboardDefinitions(["123", "456"])
-
    -

exportReportDefinitions

  • exportReportDefinitions(reportIds): Promise<unknown[]>

  • Parameters

    • reportIds: string[]

      array of report IDs

      -

    Returns Promise<unknown[]>

    Description

    This API allows users to export report definitions which can later be imported into another Optimize system. The reports to be exported may be within a collection or private entities, the API has access to both.

    -

    The obtained list of entity exports can be imported into other Optimize systems either using the dedicated import API or via UI.

    -

    Camunda 8 Documentation

    -

    Example

    const client = new OptimizeApiClient()
    const reportDefs = await client.exportReportDefinitions(["123", "456"])
-
    -

exportReportResultData

  • exportReportResultData(reportId, limit?, paginationTimeoutSec?): ReportDataExporter

  • Parameters

    • reportId: string
    • limit: number = 2
    • paginationTimeoutSec: number = 60

    Returns ReportDataExporter

    Description

    The data export API allows users to export large amounts of data in a machine-readable format (JSON) from Optimize.

    -

    Example

    const client = new OptimizeApiClient()
    const exporter = client.exportReportResultData("e6c5aaa1-6a18-44e7-8480-d562d511ba62")
    const page1 = await exporter.next()
-
    -

getDashboardIds

  • getDashboardIds(collectionId): Promise<DashboardCollection>

  • Parameters

    • collectionId: number

      The ID of the collection for which to retrieve the dashboard IDs.

      -

    Returns Promise<DashboardCollection>

    Description

    This API allows users to retrieve all dashboard IDs from a given collection.

    -

    The response contains a list of IDs of the dashboards existing in the collection with the given collection ID.

    -

    Camunda 8 Documentation

    -

    Example

    const client = new OptimizeApiClient()
    const dashboardIds = await client.getDashboardIds(1234)
-
    -

Private getHeaders

  • getHeaders(auth?): Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    } | {
        accept: string;
        content-type: string;
        user-agent: string;
    }>

  • Parameters

    • auth: boolean = true

    Returns Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    } | {
        accept: string;
        content-type: string;
        user-agent: string;
    }>

getReadiness

  • getReadiness(): Promise<unknown>

  • Returns Promise<unknown>

    Description

    The purpose of Health-Readiness REST API is to return information indicating whether Optimize is ready to be used.

    -

    Camunda 8 Documentation

    -

    Example

    const client = new OptimizeApiClient()
    try {
       await client.getReadiness()
       console.log('Ready!')
    } catch (e: any) {
       console.log('Error calling readiness point: ' + e.code)
    }
-
    -

getReportIds

  • getReportIds(collectionId): Promise<ReportCollection>

  • Parameters

    • collectionId: number

      the id of the collection

      -

    Returns Promise<ReportCollection>

    Description

    This API allows users to retrieve all report IDs from a given collection. The response contains a list of IDs of the reports existing in the collection with the given collection ID.

    -

    Camunda 8 Documentation

    -

    Example

    const client = new OptimizeApiClient()
    const reports =  await client.getReportIds(1234)
-
    -

importEntities

  • importEntities(collectionId, entities): Promise<EntityImportResponse>

  • Parameters

    • collectionId: number
    • entities: unknown

    Returns Promise<EntityImportResponse>

    Description

    This API allows users to import entity definitions such as reports and dashboards into existing collections. These entity definitions may be obtained either using the report or dashboard export API or via the UI.

    -

    Camunda 8 Documentation

    -

    Example

    const entities = [
       {
           "id": "61ae2232-51e1-4c35-b72c-c7152ba264f9",
           "exportEntityType": "single_process_report",
           "name": "Number: Process instance duration",
           "sourceIndexVersion": 8,
           "collectionId": null,
           "data": {...}
       },
       {
           "id": "b0eb845-e8ed-4824-bd85-8cd69038f2f5",
           "exportEntityType": "dashboard",
           "name": "Dashboard 1",
           "sourceIndexVersion": 5,
           "reports": [
               {
                   "id": "61ae2232-51e1-4c35-b72c-c7152ba264f9",
                   ...
               }
           ],
           "availableFilters": [...],
           "collectionId": null
       }
    ]
    const client = new OptimizeApiClient()
    await client.importEntities(123, entities)
-
    -

ingestExternalVariable

  • ingestExternalVariable(variables): Promise<unknown>

  • Parameters

    Returns Promise<unknown>

    Description

    With the external variable ingestion API, variable data held in external systems can be ingested into Optimize directly, without the need for these variables to be present in your Camunda platform data. This can be useful when external business data, which is relevant for process analysis in Optimize, is to be associated with specific process instances.

    -

    Especially if this data changes over time, it is advisable to use this REST API to persist external variable updates to Optimize, as otherwise Optimize may not be aware of data changes in the external system.

    -

    Example

    const variables = [
     {
       "id": "7689fced-2639-4408-9de1-cf8f72769f43",
       "name": "address",
       "type": "string",
       "value": "Main Street 1",
       "processInstanceId": "c6393461-02bb-4f62-a4b7-f2f8d9bbbac1",
       "processDefinitionKey": "shippingProcess"
     },
     {
       "id": "993f4e73-7f6a-46a6-bd45-f4f8e3470ba1",
       "name": "amount",
       "type": "integer",
       "value": "500",
       "processInstanceId": "8282ed49-2243-44df-be5e-1bf893755d8f",
       "processDefinitionKey": "orderProcess"
     }
    ]
    const client = new OptimizeApiClient()
    client.ingestExternalVariable(variables)
-
    -

labelVariables

  • labelVariables(variableLabels): Promise<unknown>

  • Parameters

    Returns Promise<unknown>

    Description

    With the variable labeling endpoint, variable labels can be added, updated, and deleted from Optimize.

    -

    Camunda 8 Documentation

    -

    Example

    const variableLabels =  {
      "definitionKey": "bookrequest-1-tenant",
      "labels" : [
        {
          "variableName": "bookAvailable",
          "variableType": "Boolean",
          "variableLabel": "book availability"
        },
        {
          "variableName": "person.name",
          "variableType": "String",
          "variableLabel": "first and last name"
        },
        {
          "variableName": "person.hobbies._listSize",
          "variableType": "Long",
          "variableLabel": "amount of hobbies"
        }
      ]
    }
    const client = new OptimizeApiClient()
    await client.labelVariables(variableLabels)
-
    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Tasklist.TasklistApiClient.html b/docs/classes/index.Tasklist.TasklistApiClient.html deleted file mode 100644 index d6deca57..00000000 --- a/docs/classes/index.Tasklist.TasklistApiClient.html +++ /dev/null @@ -1,46 +0,0 @@ -TasklistApiClient | @camunda8/sdk

Class TasklistApiClient

Description

The high-level client for the Tasklist REST API

-

Example


-
-

Constructors

constructor -

Properties

oAuthProvider -rest -userAgentString -

Methods

assignTask -completeTask -getForm -getHeaders -getTask -getVariable -getVariables -replaceDatesWithString -searchTasks -unassignTask -

Constructors

constructor

  • new TasklistApiClient(options?): TasklistApiClient

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
          oAuthProvider?: IOAuthProvider;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>
      • Optional oAuthProvider?: IOAuthProvider

    Returns TasklistApiClient

    Example

    const tasklist = new TasklistApiClient()
    const tasks = await tasklist.getTasks({ state: TaskState.CREATED })
-
    -

    Description

Properties

Private oAuthProvider

oAuthProvider: IOAuthProvider

Private rest

rest: Got

Private userAgentString

userAgentString: string

Methods

assignTask

  • assignTask(__namedParameters): Promise<TaskResponse>

  • Parameters

    • __namedParameters: {
          allowOverrideAssignment?: boolean;
          assignee?: string;
          taskId: string;
      }
      • Optional allowOverrideAssignment?: boolean
      • Optional assignee?: string
      • taskId: string

    Returns Promise<TaskResponse>

    Description

    Assign a task with taskId to assignee or the active user.

    -

    Throws

    Status 400 - An error is returned when the task is not active (not in the CREATED state). -Status 400 - An error is returned when task was already assigned, except the case when JWT authentication token used and allowOverrideAssignment = true. -Status 403 - An error is returned when user doesn't have the permission to assign another user to this task. -Status 404 - An error is returned when the task with the taskId is not found.

    -

completeTask

  • completeTask(taskId, variables?): Promise<TaskResponse>

  • Parameters

    • taskId: string
    • Optional variables: JSONDoc

    Returns Promise<TaskResponse>

    Description

    Complete a task with taskId and optional variables

    -

    Throws

    Status 400 An error is returned when the task is not active (not in the CREATED state).

    -

    Throws

    Status 400 An error is returned if the task was not claimed (assigned) before.

    -

    Throws

    Status 400 An error is returned if the task is not assigned to the current user.

    -

    Throws

    Status 403 User has no permission to access the task (Self-managed only).

    -

    Throws

    Status 404 An error is returned when the task with the taskId is not found.

    -

getForm

  • getForm(formId, processDefinitionKey, version?): Promise<Form>

  • Parameters

    • formId: string
    • processDefinitionKey: string
    • Optional version: string | number

    Returns Promise<Form>

    Description

    Get the form details by form id and processDefinitionKey.

    -

Private getHeaders

  • getHeaders(): Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

  • Returns Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

getTask

getVariable

getVariables

  • getVariables(__namedParameters): Promise<VariableSearchResponse[]>

  • Parameters

    • __namedParameters: {
          includeVariables?: {
              alwaysReturnFullValue: boolean;
              name: string;
          }[];
          taskId: string;
          variableNames?: string[];
      }
      • Optional includeVariables?: {
            alwaysReturnFullValue: boolean;
            name: string;
        }[]
      • taskId: string
      • Optional variableNames?: string[]

    Returns Promise<VariableSearchResponse[]>

    Description

    This method returns a list of task variables for the specified taskId and variableNames. If the variableNames parameter is empty, all variables associated with the task will be returned.

    -

    Throws

    Status 404 - An error is returned when the task with the taskId is not found.

    -

Private replaceDatesWithString

searchTasks

unassignTask

  • unassignTask(taskId): Promise<TaskResponse>

  • Parameters

    • taskId: string

    Returns Promise<TaskResponse>

    Description

    Unassign a task with taskId

    -

    Throws

    Status 400 An error is returned when the task is not active (not in the CREATED state).

    -

    Throws

    Status 400 An error is returned if the task was not claimed (assigned) before.

    -

    Throws

    Status 404 An error is returned when the task with the taskId is not found.

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Tasklist.TasklistDto.Form.html b/docs/classes/index.Tasklist.TasklistDto.Form.html deleted file mode 100644 index 835c23fe..00000000 --- a/docs/classes/index.Tasklist.TasklistDto.Form.html +++ /dev/null @@ -1,12 +0,0 @@ -Form | @camunda8/sdk

Class Form

Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values. -Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

-

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-
-

Hierarchy (view full)

Constructors

constructor -

Properties

id -isDeleted -processDefinitionId -schema -tenantId -version -

Constructors

constructor

Properties

id

id: string

isDeleted

isDeleted: boolean

processDefinitionId

processDefinitionId: string

schema

schema: string

tenantId

tenantId: string

version

version: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Tasklist.TasklistDto.TaskResponse.html b/docs/classes/index.Tasklist.TasklistDto.TaskResponse.html deleted file mode 100644 index 580d88f2..00000000 --- a/docs/classes/index.Tasklist.TasklistDto.TaskResponse.html +++ /dev/null @@ -1,26 +0,0 @@ -TaskResponse | @camunda8/sdk

Class TaskResponse

Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values. -Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

-

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-
-

Hierarchy (view full)

Constructors

constructor -

Properties

assignee -candidateGroups -candidateUsers -completionDate -creationDate -dueDate -followUpDate -formId -formKey -formVersion? -id -implementation -isFormEmbedded? -name -processDefinitionKey -processInstanceKey -processName -taskDefinitionId -taskState -tenantId -

Constructors

constructor

Properties

assignee

assignee: string

candidateGroups

candidateGroups: string[]

candidateUsers

candidateUsers: string[]

completionDate

completionDate: string

creationDate

creationDate: string

dueDate

dueDate: string

followUpDate

followUpDate: string

formId

formId: string

formKey

formKey: string

Optional formVersion

formVersion?: string

id

id: string

implementation

implementation: "JOB_WORKER" | "ZEEBE_USER_TASK"

Optional isFormEmbedded

isFormEmbedded?: boolean

name

name: string

processDefinitionKey

processDefinitionKey: string

processInstanceKey

processInstanceKey: string

processName

processName: string

taskDefinitionId

taskDefinitionId: string

taskState

taskState: "FAILED" | "COMPLETED" | "CANCELED" | "CREATED"

tenantId

tenantId: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Tasklist.TasklistDto.TaskSearchResponse.html b/docs/classes/index.Tasklist.TasklistDto.TaskSearchResponse.html deleted file mode 100644 index ce008aca..00000000 --- a/docs/classes/index.Tasklist.TasklistDto.TaskSearchResponse.html +++ /dev/null @@ -1,29 +0,0 @@ -TaskSearchResponse | @camunda8/sdk

Class TaskSearchResponse

Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values. -Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

-

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-
-

Hierarchy (view full)

Constructors

constructor -

Properties

assignee -candidateGroups -candidateUsers -completionDate -creationDate -dueDate -followUpDate -formId -formKey -formVersion? -id -implementation -isFirst -isFormEmbedded? -name -processDefinitionKey -processInstanceKey -processName -sortValues -taskDefinitionId -taskState -tenantId -variables -

Constructors

constructor

Properties

assignee

assignee: string

candidateGroups

candidateGroups: string[]

candidateUsers

candidateUsers: string[]

completionDate

completionDate: string

creationDate

creationDate: string

dueDate

dueDate: string

followUpDate

followUpDate: string

formId

formId: string

formKey

formKey: string

Optional formVersion

formVersion?: string

id

id: string

implementation

implementation: "JOB_WORKER" | "ZEEBE_USER_TASK"

isFirst

isFirst: boolean

Optional isFormEmbedded

isFormEmbedded?: boolean

name

name: string

processDefinitionKey

processDefinitionKey: string

processInstanceKey

processInstanceKey: string

processName

processName: string

sortValues

sortValues: string[]

taskDefinitionId

taskDefinitionId: string

taskState

taskState: "FAILED" | "COMPLETED" | "CANCELED" | "CREATED"

tenantId

tenantId: string

variables

variables: VariableSearchResponseWithoutDraft[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Zeebe.BpmnParser.html b/docs/classes/index.Zeebe.BpmnParser.html deleted file mode 100644 index 07c89e10..00000000 --- a/docs/classes/index.Zeebe.BpmnParser.html +++ /dev/null @@ -1,26 +0,0 @@ -BpmnParser | @camunda8/sdk

Class BpmnParser

Constructors

constructor -

Properties

parser -parserOptions -taskTypes -

Methods

generateConstantsForBpmnFiles -getMessageNames -getProcessId -getTaskTypes -mergeDedupeAndSort -parseBpmn -scaffold -scanBpmnObjectForMessages -scanBpmnObjectForTasks -

Constructors

constructor

Properties

Static Private parser

parser: XMLParser = ...

Static Private parserOptions

parserOptions: {
    allowBooleanAttributes: boolean;
    attrNodeName: string;
    attributeNamePrefix: string;
    cdataPositionChar: string;
    cdataTagName: string;
    ignoreAttributes: boolean;
    ignoreNameSpace: boolean;
    localeRange: string;
    parseAttributeValue: boolean;
    parseNodeValue: boolean;
    parseTrueNumberOnly: boolean;
    textNodeName: string;
    trimValues: boolean;
} = ...

Type declaration

  • allowBooleanAttributes: boolean
  • attrNodeName: string
  • attributeNamePrefix: string
  • cdataPositionChar: string
  • cdataTagName: string
  • ignoreAttributes: boolean
  • ignoreNameSpace: boolean
  • localeRange: string
  • parseAttributeValue: boolean
  • parseNodeValue: boolean
  • parseTrueNumberOnly: boolean
  • textNodeName: string
  • trimValues: boolean

Static taskTypes

taskTypes: any

Methods

Static generateConstantsForBpmnFiles

  • generateConstantsForBpmnFiles(filenames): Promise<string>

  • Generate TypeScript constants for task types and message names in BPMN files

    -

    Parameters

    • filenames: string | string[]

      a BPMN file path or array of BPMN file paths

      -

    Returns Promise<string>

Static getMessageNames

  • getMessageNames(processes): Promise<string[]>

  • Take one or more parsed BPMN objects and return an array of unique message names.

    -

    Parameters

    • processes: object | object[]

      A parsed BPMN object, or an array of parsed BPMN objects.

      -

    Returns Promise<string[]>

Static getProcessId

Static getTaskTypes

  • getTaskTypes(processes): Promise<string[]>

  • Take one or more parsed BPMN objects and return an array of unique task types.

    -

    Parameters

    • processes: object | object[]

      A parsed BPMN object, or an array of parsed BPMN objects.

      -

    Returns Promise<string[]>

Static Private mergeDedupeAndSort

Static parseBpmn

  • parseBpmn(filenames): object

  • Read BPMN files and return an array of one or more parsed BPMN objects.

    -

    Parameters

    • filenames: string | string[]

      A single BPMN file path, or array of BPMN file paths.

      -

    Returns object

Static scaffold

Static Private scanBpmnObjectForMessages

  • scanBpmnObjectForMessages(bpmnObject): Promise<string[]>

  • Return an array of message names.

    -

    Parameters

    • bpmnObject: object

      A parsed Bpmn object.

      -

    Returns Promise<string[]>

Static Private scanBpmnObjectForTasks

  • scanBpmnObjectForTasks(bpmnObject): Promise<string[]>

  • Return an array of task types.

    -

    Parameters

    • bpmnObject: object

      A parsed Bpmn object.

      -

    Returns Promise<string[]>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Zeebe.ZBWorker.html b/docs/classes/index.Zeebe.ZBWorker.html deleted file mode 100644 index b3cf3e5c..00000000 --- a/docs/classes/index.Zeebe.ZBWorker.html +++ /dev/null @@ -1,26 +0,0 @@ -ZBWorker | @camunda8/sdk

Class ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

Type Parameters

  • WorkerInputVariables
  • CustomHeaderShape
  • WorkerOutputVariables

Hierarchy (view full)

Constructors

constructor -

Properties

activeJobs -cancelWorkflowOnException -grpcClient -logger -maxJobsToActivate -pollCount -taskHandler -taskType -timeout -zbClient -

Methods

close -debug -drainOne -emit -error -handleJob -handleJobs -log -makeCompleteHandlers -off -on -removeAllListeners -

Constructors

constructor

Properties

activeJobs

activeJobs: number = 0

Protected cancelWorkflowOnException

cancelWorkflowOnException: boolean = false

grpcClient

grpcClient: ZBGrpc

Protected logger

logger: StatefulLogInterceptor

maxJobsToActivate

maxJobsToActivate: number

pollCount

pollCount: number = 0

Protected taskHandler

taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

taskType

taskType: string

timeout

timeout: MaybeTimeDuration

Protected zbClient

zbClient: ZeebeGrpcClient

Methods

close

  • close(timeout?): Promise<null>

  • Returns a promise that the worker has stopped accepting tasks and -has drained all current active tasks. Will reject if you try to call it more than once.

    -

    Parameters

    • Optional timeout: number

    Returns Promise<null>

debug

Protected drainOne

emit

  • emit<K>(eventName, params?): void

  • Type Parameters

    • K extends EventKey<{
          close: "close";
          connectionError: "connectionError";
          ready: "ready";
          unknown: "unknown";
      }>

    Parameters

    • eventName: K
    • Optional params: {
          close: "close";
          connectionError: "connectionError";
          ready: "ready";
          unknown: "unknown";
      }[K]

    Returns void

error

Protected handleJob

Protected handleJobs

log

Protected makeCompleteHandlers

off

on

removeAllListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.Zeebe.ZeebeGrpcClient.html b/docs/classes/index.Zeebe.ZeebeGrpcClient.html deleted file mode 100644 index 6e2f3445..00000000 --- a/docs/classes/index.Zeebe.ZeebeGrpcClient.html +++ /dev/null @@ -1,225 +0,0 @@ -ZeebeGrpcClient | @camunda8/sdk

Class ZeebeGrpcClient

Description

A client for interacting with a Zeebe broker. With the connection credentials set in the environment, you can use a "zero-conf" constructor with no arguments.

-

Example

const zbc = new ZeebeGrpcClient()
zbc.topology().then(info =>
    console.log(JSON.stringify(info, null, 2))
)
-
-

Hierarchy (view full)

Constructors

constructor -

Properties

closePromise? -closing -config -connected? -connectionTolerance -customSSL? -gatewayAddress -grpc -logger -loglevel -maxRetries -maxRetryTimeout -oAuthProvider -onConnectionError? -onReady? -options -readied -retry -stdout -tenantId? -useTLS -workerCount -workers -

Methods

_onConnectionError -activateJobs -broadcastSignal -cancelProcessInstance -close -completeJob -constructGrpcClient -createProcessInstance -createProcessInstanceWithResult -createWorker -deleteResource -deployResource -emit -evaluateDecision -executeOperation -failJob -getServiceTypesFromBpmn -modifyProcessInstance -off -on -publishMessage -publishStartMessage -removeAllListeners -resolveIncident -retryOnFailure -setVariables -throwError -topology -updateJobRetries -

Constructors

constructor

  • new ZeebeGrpcClient(options?): ZeebeGrpcClient

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
          oAuthProvider?: IOAuthProvider;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>
      • Optional oAuthProvider?: IOAuthProvider

    Returns ZeebeGrpcClient

Properties

Private Optional closePromise

closePromise?: Promise<null>

Private closing

closing: boolean = false

Private config

config: {
    CAMUNDA_CONSOLE_BASE_URL: undefined | string;
    CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
    CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
    CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
    CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
    CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
    CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
    CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
    CAMUNDA_MODELER_BASE_URL: string;
    CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
    CAMUNDA_OAUTH_DISABLED: boolean;
    CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
    CAMUNDA_OAUTH_URL: undefined | string;
    CAMUNDA_OPERATE_BASE_URL: undefined | string;
    CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
    CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
    CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
    CAMUNDA_SECURE_CONNECTION: boolean;
    CAMUNDA_TASKLIST_BASE_URL: undefined | string;
    CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
    CAMUNDA_TENANT_ID: undefined | string;
    CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
    CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
    CAMUNDA_TOKEN_SCOPE: undefined | string;
    CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
    ZEEBE_ADDRESS: string;
    ZEEBE_CLIENT_ID: undefined | string;
    ZEEBE_CLIENT_SECRET: undefined | string;
    zeebeGrpcSettings: {
        GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
        GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
        GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
        GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
        GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
        GRPC_KEEPALIVE_TIMEOUT_MS: number;
        GRPC_KEEPALIVE_TIME_MS: number;
        GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
        GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
        ZEEBE_CLIENT_LOG_LEVEL: string;
        ZEEBE_CLIENT_LOG_TYPE: string;
        ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
        ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
        ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
        ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
        ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
        ZEEBE_GRPC_CLIENT_RETRY: boolean;
        ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
        ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
    };
}

Type declaration

  • CAMUNDA_CONSOLE_BASE_URL: undefined | string

    The base url for the Admin Console API.

    -
  • CAMUNDA_CONSOLE_CLIENT_ID: undefined | string

    Credentials for Admin Console and Modeler API

    -
  • CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string

    Credentials for Admin Console and Modeler API

    -
  • CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string

    The audience parameter for an Admin Console OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise

    -
  • CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string

    When using custom or self-signed certificates, provide the path to the certificate chain

    -
  • CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string

    When using custom or self-signed certificates, provide the path to the private key

    -
  • CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string

    In an environment using self-signed certificates, provide the path to the root certificate

    -
  • CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string

    Custom user agent

    -
  • CAMUNDA_MODELER_BASE_URL: string

    The base url for the Modeler API. Defaults to Camunda Saas - https://modeler.cloud.camunda.io/api

    -
  • CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string

    The audience parameter for a Modeler OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise

    -
  • CAMUNDA_OAUTH_DISABLED: boolean

    Set to true to disable OAuth completely

    -
  • CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number

    How soon in milliseconds before its expiration time a cached OAuth token should be considered expired. Defaults to 1000

    -
  • CAMUNDA_OAUTH_URL: undefined | string

    The OAuth token exchange endpoint url

    -
  • CAMUNDA_OPERATE_BASE_URL: undefined | string

    The base url for the Operate API

    -
  • CAMUNDA_OPERATE_OAUTH_AUDIENCE: string

    The audience parameter for an Operate OAuth token request. Defaults to operate.camunda.io

    -
  • CAMUNDA_OPTIMIZE_BASE_URL: undefined | string

    The base url for the Optimize API

    -
  • CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string

    The audience parameter for an Optimize OAuth token request. Defaults to optimize.camunda.io

    -
  • CAMUNDA_SECURE_CONNECTION: boolean

    Control TLS for Zeebe Grpc. Defaults to true. Set to false when using an unsecured gateway

    -
  • CAMUNDA_TASKLIST_BASE_URL: undefined | string

    The base url for the Tasklist API

    -
  • CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string

    The audience parameter for a Tasklist OAuth token request. Defaults to tasklist.camunda.io

    -
  • CAMUNDA_TENANT_ID: undefined | string

    The tenant id when multi-tenancy is enabled

    -
  • CAMUNDA_TOKEN_CACHE_DIR: undefined | string

    The directory to cache OAuth tokens on-disk. Defaults to $HOME/.camunda

    -
  • CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean

    Set to true to disable disk caching of OAuth tokens and use memory caching only

    -
  • CAMUNDA_TOKEN_SCOPE: undefined | string

    Optional scope parameter for OAuth (needed by some OIDC)

    -
  • CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string

    The audience parameter for a Zeebe OAuth token request. Defaults to zeebe.camunda.io

    -
  • ZEEBE_ADDRESS: string

    The address for the Zeebe Gateway. Defaults to localhost:26500

    -
  • ZEEBE_CLIENT_ID: undefined | string

    This is the client ID for the client credentials

    -
  • ZEEBE_CLIENT_SECRET: undefined | string

    This is the client secret for the client credentials

    -
  • zeebeGrpcSettings: {
        GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
        GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
        GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
        GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
        GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
        GRPC_KEEPALIVE_TIMEOUT_MS: number;
        GRPC_KEEPALIVE_TIME_MS: number;
        GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
        GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
        ZEEBE_CLIENT_LOG_LEVEL: string;
        ZEEBE_CLIENT_LOG_TYPE: string;
        ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
        ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
        ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
        ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
        ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
        ZEEBE_GRPC_CLIENT_RETRY: boolean;
        ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
        ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
    }
    • GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number

      This channel argument controls the maximum number -of pings that can be sent when there is no other -data (data frame or header frame) to be sent. -GRPC Core will not continue sending pings if we -run over the limit. Setting it to 0 allows sending -pings without sending data.

      -
    • GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number

      Minimum allowed time between a server receiving -successive ping frames without sending any data -frame. Int valued, milliseconds. Default: 90000

      -
    • GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number

      Defaults to 90000.

      -
    • GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number

      The time between the first and second connection attempts, -in ms. Defaults to 1000.

      -
    • GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number

      This channel argument if set to 1 -(0 : false; 1 : true), allows keepalive pings -to be sent even if there are no calls in flight. -Defaults to 1.

      -
    • GRPC_KEEPALIVE_TIMEOUT_MS: number

      After waiting for a duration of this time, if the keepalive ping sender does not receive the ping ack, it will close the -transport. Int valued, milliseconds. Defaults to 120000.

      -
    • GRPC_KEEPALIVE_TIME_MS: number

      After a duration of this time the client/server pings its peer to see if the transport is still alive. -Int valued, milliseconds. Defaults to 360000.

      -
    • GRPC_MAX_RECONNECT_BACKOFF_MS: string | number

      The maximum time between subsequent connection attempts, -in ms. Defaults to 10000.

      -
    • GRPC_MIN_RECONNECT_BACKOFF_MS: string | number

      The minimum time between subsequent connection attempts, -in ms. Default is 1000ms, but this can cause an SSL Handshake failure. -This causes an intermittent failure in the Worker-LongPoll test when run -against Camunda Cloud. -Raised to 5000ms. -See: https://github.com/grpc/grpc/issues/8382#issuecomment-259482949

      -
    • ZEEBE_CLIENT_LOG_LEVEL: string

      Log level of Zeebe Client and Workers - 'DEBUG' | 'INFO' | 'NONE'. Defaults to 'INFO'

      -
    • ZEEBE_CLIENT_LOG_TYPE: string

      Zeebe client log output can be human-readable 'SIMPLE' or structured 'JSON'. Defaults to 'SIMPLE'

      -
    • ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number

      The gRPC channel can "jitter". This suppresses a connection error message if the channel comes back within this window in milliseconds. Defaults to 3000

      -
    • ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean

      Immediately connect to the Zeebe Gateway (issues a silent topology request). Defaults to false

      -
    • ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number

      This suppresses intermediate errors during initial connection negotiation. On Camunda SaaS this defaults to 6000, on Self-Managed to 0

      -
    • ZEEBE_GRPC_CLIENT_MAX_RETRIES: number

      Maximum number of retries of network operations before failing. Defaults to -1 (infinite retries)

      -
    • ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number

      When retrying failed network operations, retries back off to this maximum period. Defaults to 10s

      -
    • ZEEBE_GRPC_CLIENT_RETRY: boolean

      Automate retrying operations that fail due to network conditions or broker backpressure. Defaults to true

      -
    • ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number

      How long in seconds the long poll Job Activation request is held open by a worker. Defaults to 60

      -
    • ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number

      After a long poll Job Activation request, this is the cool-off period in milliseconds before the worker requests more work. Defaults to 300

      -

Optional connected

connected?: boolean = undefined

connectionTolerance

connectionTolerance: MaybeTimeDuration

Private Optional customSSL

customSSL?: CustomSSL

gatewayAddress

gatewayAddress: string

Private grpc

grpc: ZBGrpc

Private logger

logger: StatefulLogInterceptor

loglevel

loglevel: Loglevel

Private maxRetries

maxRetries: number

Private maxRetryTimeout

maxRetryTimeout: MaybeTimeDuration

Private oAuthProvider

oAuthProvider: IOAuthProvider

Optional onConnectionError

onConnectionError?: ((err) => void)

Type declaration

    • (err): void

    • Parameters

      • err: Error

      Returns void

Optional onReady

onReady?: (() => void)

Type declaration

    • (): void

    • Returns void

Private options

options: ZBClientOptions

readied

readied: boolean = false

Private retry

retry: boolean

Private stdout

stdout: ZBCustomLogger

Private Optional tenantId

tenantId?: string

Private useTLS

useTLS: boolean

Private workerCount

workerCount: number = 0

Private workers

workers: ZBWorker<any, any, any>[] = []

Methods

Private _onConnectionError

activateJobs

broadcastSignal

cancelProcessInstance

  • cancelProcessInstance(processInstanceKey): Promise<void>

  • Parameters

    • processInstanceKey: string | number

    Returns Promise<void>

    Description

    Cancel a process instance by process instance key.

    -

    Example

    const zbc = new ZeebeGrpcClient()

    zbc.cancelProcessInstance(processInstanceId)
        .catch(
            (e: any) => console.log(`Error cancelling instance: ${e.message}`)
    )
-
    -

close

  • close(timeout?): Promise<null>

  • Parameters

    • Optional timeout: number

    Returns Promise<null>

    Description

    Gracefully shut down all workers, draining existing tasks, and return when it is safe to exit.

    -

    Example

    const zbc = new ZeebeGrpcClient()

    zbc.createWorker({
      taskType:
    })

    setTimeout(async () => {
      await zbc.close()
      console.log('All work completed.')
    }),
      5 * 60 * 1000 // 5 mins
    )
-
    -

completeJob

  • completeJob(completeJobRequest): Promise<void>

  • Parameters

    Returns Promise<void>

    Description

    Explicitly complete a job. The method is useful for manually constructing a worker.

    -

    Example

    const zbc = new ZeebeGrpcClient()
    zbc.activateJobs({
      maxJobsToActivate: 5,
      requestTimeout: 6000,
      timeout: 5 * 60 * 1000,
      type: 'process-payment',
      worker: 'my-worker-uuid'
    }).then(jobs =>
         jobs.forEach(job =>
        // business logic
        zbc.completeJob({
          jobKey: job.key,
          variables: {}
        ))
      )
    })
-
    -

Private constructGrpcClient

  • constructGrpcClient(__namedParameters): {
        grpcClient: ZBGrpc;
        log: StatefulLogInterceptor;
    }

  • Parameters

    • __namedParameters: {
          grpcConfig: {
              namespace: string;
              onConnectionError?: (() => void);
              onReady?: (() => void);
              tasktype?: string;
          };
          logConfig: ZBLoggerConfig;
      }
      • grpcConfig: {
            namespace: string;
            onConnectionError?: (() => void);
            onReady?: (() => void);
            tasktype?: string;
        }
        • namespace: string
        • Optional onConnectionError?: (() => void)
            • (): void

            • Returns void

        • Optional onReady?: (() => void)
            • (): void

            • Returns void

        • Optional tasktype?: string
      • logConfig: ZBLoggerConfig

    Returns {
        grpcClient: ZBGrpc;
        log: StatefulLogInterceptor;
    }

createProcessInstance

  • createProcessInstance<Variables>(config): Promise<CreateProcessInstanceResponse>

  • Type Parameters

    Parameters

    Returns Promise<CreateProcessInstanceResponse>

    Description

    Create a new process instance. Asynchronously returns a process instance id.

    -

    Example

    const zbc = new ZeebeGrpcClient()

    zbc.createProcessInstance({
      bpmnProcessId: 'onboarding-process',
      variables: {
        customerId: 'uuid-3455'
      },
      version: 5 // optional, will use latest by default
    }).then(res => console.log(JSON.stringify(res, null, 2)))

    zbc.createProcessInstance({
      bpmnProcessId: 'SkipFirstTask',
      variables: { id: random },
      startInstructions: [{elementId: 'second_service_task'}]
    }).then(res => (id = res.processInstanceKey))
-
    -

createProcessInstanceWithResult

createWorker

deleteResource

  • deleteResource(resourceId): Promise<Record<string, never>>

  • Delete a resource.

    -

    Parameters

    • resourceId: {
          resourceKey: string;
      }

      The key of the resource that should be deleted. This can either be the key of a process definition, the key of a decision requirements definition or the key of a form.

      -
      • resourceKey: string

    Returns Promise<Record<string, never>>

deployResource

  • deployResource(resource): Promise<DeployResourceResponse<ProcessDeployment>>

  • Parameters

    • resource: {
          processFilename: string;
          tenantId?: string;
      } | {
          name: string;
          process: Buffer;
          tenantId?: string;
      }

    Returns Promise<DeployResourceResponse<ProcessDeployment>>

    Description

    Deploys one or more resources (e.g. processes or decision models) to Zeebe. -Note that this is an atomic call, i.e. either all resources are deployed, or none of them are.

    -

    Errors: -PERMISSION_DENIED:

    -
      -
    • if a deployment to an unauthorized tenant is performed -INVALID_ARGUMENT:
      • -
    • no resources given.
      • -
    • if at least one resource is invalid. A resource is considered invalid if:
        -
      • the content is not deserializable (e.g. detected as BPMN, but it's broken XML)
        • -
      • the content is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
        • -
      -
      • -
    • if multi-tenancy is enabled, and:
        -
      • a tenant id is not provided
        • -
      • a tenant id with an invalid format is provided
        • -
      -
      • -
    • if multi-tenancy is disabled and a tenant id is provided
      • -
    -

    Example

    import {join} from 'path'
    const zbc = new ZeebeGrpcClient()

    zbc.deployResource({ processFilename: join(process.cwd(), 'bpmn', 'onboarding.bpmn' })
    zbc.deployResource({ decisionFilename: join(process.cwd(), 'dmn', 'approval.dmn')})
-
    -
  • deployResource(resource): Promise<DeployResourceResponse<DecisionDeployment>>

  • Parameters

    • resource: {
          decisionFilename: string;
          tenantId?: string;
      } | {
          decision: Buffer;
          name: string;
          tenantId?: string;
      }

    Returns Promise<DeployResourceResponse<DecisionDeployment>>

  • deployResource(resource): Promise<DeployResourceResponse<FormDeployment>>

  • Parameters

    • resource: {
          formFilename: string;
          tenantId?: string;
      } | {
          form: Buffer;
          name: string;
          tenantId?: string;
      }

    Returns Promise<DeployResourceResponse<FormDeployment>>

emit

  • emit<K>(eventName, params?): void

  • Type Parameters

    • K extends EventKey<{
          close: "close";
          connectionError: "connectionError";
          ready: "ready";
          unknown: "unknown";
      }>

    Parameters

    • eventName: K
    • Optional params: {
          close: "close";
          connectionError: "connectionError";
          ready: "ready";
          unknown: "unknown";
      }[K]

    Returns void

evaluateDecision

  • evaluateDecision(evaluateDecisionRequest): Promise<EvaluateDecisionResponse>

  • Parameters

    Returns Promise<EvaluateDecisionResponse>

    Description

    Evaluates a decision. The decision to evaluate can be specified either by using its unique key (as returned by DeployResource), or using the decision ID. When using the decision ID, the latest deployed version of the decision is used.

    -

    Example

    const zbc = new ZeebeGrpcClient()
    zbc.evaluateDecision({
      decisionId: 'my-decision',
      variables: { season: "Fall" }
    }).then(res => console.log(JSON.stringify(res, null, 2)))
-
    -

Private executeOperation

  • executeOperation<T>(operationName, operation, retries?): Promise<T>

  • If this.retry is set true, the operation will be wrapped in an configurable retry on exceptions -of gRPC error code 14 - Transient Network Failure. -See: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md -If this.retry is false, it will be executed with no retry, and the application should handle the exception.

    -

    Type Parameters

    • T

    Parameters

    • operationName: string
    • operation: (() => Promise<T>)

      A gRPC command operation

      -
        • (): Promise<T>

        • Returns Promise<T>

    • Optional retries: number

    Returns Promise<T>

failJob

  • failJob(failJobRequest): Promise<void>

  • Parameters

    Returns Promise<void>

    Description

    Fail a job. This is useful if you are using the decoupled completion pattern or building your own worker. -For the retry count, the current count is available in the job metadata.

    -

    Example

    const zbc = new ZeebeGrpcClient()
    zbc.failJob( {
      jobKey: '345424343451',
      retries: 3,
      errorMessage: 'Could not get a response from the order invoicing API',
      retryBackOff: 30 * 1000 // optional, otherwise available for reactivation immediately
    })
-
    -

getServiceTypesFromBpmn

  • getServiceTypesFromBpmn(files): Promise<string[]>

  • Parameters

    • files: string | string[]

    Returns Promise<string[]>

    Description

    Return an array of task types contained in a BPMN file or array of BPMN files. This can be useful, for example, to do

    -

    Example

    const zbc = new ZeebeGrpcClient()
    zbc.getServiceTypesFromBpmn(['bpmn/onboarding.bpmn', 'bpmn/process-sale.bpmn'])
      .then(tasktypes => console.log('The task types are:', tasktypes))
    
-
    -

modifyProcessInstance

off

on

publishMessage

publishStartMessage

  • publishStartMessage<ProcessVariables>(publishStartMessageRequest): Promise<PublishMessageResponse>

  • Type Parameters

    Parameters

    Returns Promise<PublishMessageResponse>

    Description

    Publish a message to the broker for correlation with a workflow message start event. -For a message targeting a start event, the correlation key is not needed to target a specific running process instance. -However, the hash of the correlationKey is used to determine the partition where this workflow will start. -So we assign a random uuid to balance workflow instances created via start message across partitions.

    -

    We make the correlationKey optional, because the caller can specify a correlationKey + messageId -to guarantee an idempotent message.

    -

    Multiple messages with the same correlationKey + messageId combination will only start a workflow once. -See: https://github.com/zeebe-io/zeebe/issues/1012 and https://github.com/zeebe-io/zeebe/issues/1022

    -

    Example

    const zbc = new ZeebeGrpcClient()
    zbc.publishStartMessage({
      name: 'Start_New_Onboarding_Flow',
      variables: {
        customerId: 'uuid-348-234-8908'
      }
    })

    // To do the same in an idempotent fashion - note: only idempotent during the lifetime of the created instance.
    zbc.publishStartMessage({
      name: 'Start_New_Onboarding_Flow',
      messageId: 'uuid-348-234-8908', // use customerId to make process idempotent per customer
      variables: {
        customerId: 'uuid-348-234-8908'
      }
    })
-
    -

removeAllListeners

resolveIncident

  • resolveIncident(resolveIncidentRequest): Promise<void>

  • Parameters

    Returns Promise<void>

    Description

    Resolve an incident by incident key.

    -

    Example

    type JSONObject = {[key: string]: string | number | boolean | JSONObject}

    const zbc = new ZeebeGrpcClient()

    async updateAndResolveIncident({
      processInstanceId,
      incidentKey,
      variables
    } : {
      processInstanceId: string,
      incidentKey: string,
      variables: JSONObject
    }) {
      await zbc.setVariables({
        elementInstanceKey: processInstanceId,
        variables
      })
      await zbc.updateRetries()
      zbc.resolveIncident({
        incidentKey
      })
      zbc.resolveIncident(incidentKey)
    }
    
-
    -

Private retryOnFailure

  • retryOnFailure<T>(operationName, operation, retries?): Promise<T>

  • This function takes a gRPC operation that returns a Promise as a function, and invokes it. -If the operation throws gRPC error 14, this function will continue to try it until it succeeds -or retries are exhausted.

    -

    Type Parameters

    • T

    Parameters

    • operationName: string
    • operation: (() => Promise<T>)

      A gRPC command operation that may fail if the broker is not available

      -
        • (): Promise<T>

        • Returns Promise<T>

    • retries: number = ...

    Returns Promise<T>

setVariables

  • setVariables<Variables>(request): Promise<void>

  • Type Parameters

    Parameters

    Returns Promise<void>

    Description

    Directly modify the variables is a process instance. This can be used with resolveIncident to update the process and resolve an incident.

    -

    Example

    type JSONObject = {[key: string]: string | number | boolean | JSONObject}

    const zbc = new ZeebeGrpcClient()

    async function updateAndResolveIncident({
      incidentKey,
      processInstanceKey,
      jobKey,
      variableUpdate
    } : {
      incidentKey: string
      processInstanceKey: string
      jobKey: string
      variableUpdate: JSONObject
    }) {
      await zbc.setVariables({
        elementInstanceKey: processInstanceKey,
        variables: variableUpdate
      })
      await zbc.updateJobRetries({
        jobKey,
        retries: 1
      })
      return zbc.resolveIncident({
        incidentKey
      })
    }
-
    -

throwError

  • throwError(throwErrorRequest): Promise<void>

  • Parameters

    Returns Promise<void>

    Description

    Fail a job by throwing a business error (i.e. non-technical) that occurs while processing a job. -The error is handled in the workflow by an error catch event. -If there is no error catch event with the specified errorCode then an incident will be raised instead. -This method is useful when building a worker, for example for the decoupled completion pattern.

    -

    Example

    type JSONObject = {[key: string]: string | number | boolean | JSONObject}

    interface errorResult {
      resultType: 'ERROR' as 'ERROR'
         errorCode: string
      errorMessage: string
    }

    interface successResult {
      resultType: 'SUCCESS' as 'SUCCESS'
      variableUpdate: JSONObject
    }

    type Result = errorResult | successResult

    const zbc = new ZeebeGrpcClient()


    // This could be a listener on a return queue from an external system
    async function handleJob(jobKey: string, result: Result) {
      if (resultType === 'ERROR') {
        const { errorMessage, errorCode } = result
            zbc.throwError({
           jobKey,
           errorCode,
              errorMessage
        })
      } else {
        zbc.completeJob({
          jobKey,
          variables: result.variableUpdate
        })
      }
    }
-
    -

topology

updateJobRetries

  • updateJobRetries(updateJobRetriesRequest): Promise<void>

  • Parameters

    Returns Promise<void>

    Description

    Update the number of retries for a Job. This is useful if a job has zero remaining retries and fails, raising an incident.

    -

    Example

    type JSONObject = {[key: string]: string | number | boolean | JSONObject}

    const zbc = new ZeebeGrpcClient()

    async function updateAndResolveIncident({
      incidentKey,
      processInstanceKey,
      jobKey,
      variableUpdate
    } : {
      incidentKey: string
      processInstanceKey: string
      jobKey: string
      variableUpdate: JSONObject
    }) {
      await zbc.setVariables({
        elementInstanceKey: processInstanceKey,
        variables: variableUpdate
      })
      await zbc.updateJobRetries({
        jobKey,
        retries: 1
      })
      return zbc.resolveIncident({
        incidentKey
      })
    }
-
    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index._internal_.LosslessDto.html b/docs/classes/index._internal_.LosslessDto.html deleted file mode 100644 index f1c41e79..00000000 --- a/docs/classes/index._internal_.LosslessDto.html +++ /dev/null @@ -1,6 +0,0 @@ -LosslessDto | @camunda8/sdk

Class LosslessDto

Extend the LosslessDto class with your own Dto classes to enable lossless parsing of int64 values. -Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

-

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-
-

Hierarchy (view full)

Constructors

constructor -

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index._internal_.StatefulLogInterceptor.html b/docs/classes/index._internal_.StatefulLogInterceptor.html deleted file mode 100644 index 1587a068..00000000 --- a/docs/classes/index._internal_.StatefulLogInterceptor.html +++ /dev/null @@ -1,22 +0,0 @@ -StatefulLogInterceptor | @camunda8/sdk

Class StatefulLogInterceptor

Constructors

constructor -

Properties

blocking -blockingTimer? -characteristics -error -errors -info -initialConnection -log -logs -state -

Methods

close -connectionError -emptyErrors -emptyLogs -logDebug -logDirect -logError -logInfo -ready -wrap -

Constructors

constructor

Properties

blocking

blocking: boolean

Private Optional blockingTimer

blockingTimer?: Timeout

characteristics

characteristics: Characteristics

Private error

error: ((msg) => void) = ...

Type declaration

    • (msg): void

    • Parameters

      • msg: string

      Returns void

errors

errors: never[] = []

Private info

info: ((msg) => void) = ...

Type declaration

    • (msg): void

    • Parameters

      • msg: string

      Returns void

initialConnection

initialConnection: boolean

log

log: ZBLogger

logs

logs: never[] = []

state

state: State = 'ERROR'

Methods

close

connectionError

Private emptyErrors

Private emptyLogs

logDebug

logDirect

logError

logInfo

ready

Private wrap

  • wrap(store): ((logmethod) => ((msg) => void))

  • Parameters

    • store: string[]

    Returns ((logmethod) => ((msg) => void))

      • (logmethod): ((msg) => void)

      • Parameters

        • logmethod: ((msg, ...optionalParameters) => void)
            • (msg, ...optionalParameters): void

            • Parameters

              • msg: string
              • Rest ...optionalParameters: unknown[]

              Returns void

        Returns ((msg) => void)

          • (msg): void

          • Parameters

            • msg: string

            Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index._internal_.TypedEmitter.html b/docs/classes/index._internal_.TypedEmitter.html deleted file mode 100644 index d6856947..00000000 --- a/docs/classes/index._internal_.TypedEmitter.html +++ /dev/null @@ -1,7 +0,0 @@ -TypedEmitter | @camunda8/sdk

Class TypedEmitter<T>

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor -

Properties

emitter -

Methods

emit -off -on -removeAllListeners -

Constructors

constructor

Properties

Private emitter

emitter: EventEmitter = ...

Methods

emit

off

on

removeAllListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index._internal_.ZBLogger.html b/docs/classes/index._internal_.ZBLogger.html deleted file mode 100644 index 6e1a6daf..00000000 --- a/docs/classes/index._internal_.ZBLogger.html +++ /dev/null @@ -1,17 +0,0 @@ -ZBLogger | @camunda8/sdk

Class ZBLogger

Constructors

constructor -

Properties

_tag -colorFn -colorise -id? -loglevel -namespace -pollInterval? -stdout -taskType? -

Methods

_colorise -debug -error -info -log -makeMessage -

Constructors

constructor

Properties

_tag

_tag: "ZBCLIENT" | "ZBWORKER"

Private colorFn

colorFn: Chalk | (<T>(input) => string)

Type declaration

    • <T>(input): string

    • Type Parameters

      • T extends string

      Parameters

      • input: T

      Returns string

Private colorise

colorise: boolean

Private Optional id

id?: string

loglevel

loglevel: Loglevel

Private namespace

namespace: undefined | string

Private Optional pollInterval

pollInterval?: MaybeTimeDuration

Private stdout

stdout: ZBCustomLogger

Private Optional taskType

taskType?: string

Methods

Private _colorise

debug

  • debug(message, ...optionalParameters): void

  • Parameters

    • message: string
    • Rest ...optionalParameters: unknown[]

    Returns void

error

  • error(message, ...optionalParameters): void

  • Parameters

    • message: any
    • Rest ...optionalParameters: unknown[]

    Returns void

info

  • info(message, ...optionalParameters): void

  • Parameters

    • message: unknown
    • Rest ...optionalParameters: any[]

    Returns void

log

  • log(message, ...optionalParameters): void

  • Parameters

    • message: string
    • Rest ...optionalParameters: unknown[]

    Returns void

Private makeMessage

  • makeMessage(frame, level, message, ...optionalParameters): string

  • Parameters

    • frame: StackFrame
    • level: number
    • message: any
    • Rest ...optionalParameters: any[]

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index._internal_.ZBWorkerBase.html b/docs/classes/index._internal_.ZBWorkerBase.html deleted file mode 100644 index ae187d28..00000000 --- a/docs/classes/index._internal_.ZBWorkerBase.html +++ /dev/null @@ -1,55 +0,0 @@ -ZBWorkerBase | @camunda8/sdk

Class ZBWorkerBase<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

Type Parameters

  • WorkerInputVariables = any
  • CustomHeaderShape = any
  • WorkerOutputVariables = any

Hierarchy (view full)

Constructors

constructor -

Properties

activeJobs -activeJobsThresholdForReactivation -backPressureRetryCount -cancelWorkflowOnException -capacityEmitter -closeCallback? -closePromise? -closed -closing -connected -customHeadersDto -debugMode -fetchVariable -grpcClient -id -inputVariableDto -jobStream? -logger -longPoll -maxJobsToActivate -pollCount -pollInterval -pollLoop -pollMutex -readied -stalled -taskHandler -taskType -tenantId? -timeout -zbClient -DEFAULT_JOB_ACTIVATION_TIMEOUT -DEFAULT_MAX_ACTIVE_JOBS -

Methods

activateJobs -close -completeJob -debug -drainOne -emit -error -errorJob -failJob -handleJobResponse -handleJobs -handleStreamEnd -log -makeCompleteHandlers -off -on -poll -removeAllListeners -

Constructors

constructor

Properties

activeJobs

activeJobs: number = 0

Private activeJobsThresholdForReactivation

activeJobsThresholdForReactivation: number

Private backPressureRetryCount

backPressureRetryCount: number = 0

Protected cancelWorkflowOnException

cancelWorkflowOnException: boolean = false

Private capacityEmitter

capacityEmitter: EventEmitter

Private Optional closeCallback

closeCallback?: (() => void)

Type declaration

    • (): void

    • Returns void

Private Optional closePromise

closePromise?: Promise<null>

Private closed

closed: boolean = false

Private closing

closing: boolean = false

Private connected

connected: boolean = true

Private customHeadersDto

customHeadersDto: (new (...args) => CustomHeaderShape)

Type declaration

Private debugMode

debugMode: boolean

Private fetchVariable

fetchVariable: undefined | (keyof WorkerInputVariables)[]

grpcClient

grpcClient: ZBGrpc

Private id

id: string = ...

Private inputVariableDto

inputVariableDto: (new (obj) => WorkerInputVariables)

Type declaration

Private Optional jobStream

jobStream?: ClientReadableStreamImpl<unknown>

Protected logger

logger: StatefulLogInterceptor

Private longPoll

longPoll: MaybeTimeDuration

maxJobsToActivate

maxJobsToActivate: number

pollCount

pollCount: number = 0

Private pollInterval

pollInterval: MaybeTimeDuration

Private pollLoop

pollLoop: Timeout

Private pollMutex

pollMutex: boolean = false

Private readied

readied: boolean = false

Private stalled

stalled: boolean = false

Protected taskHandler

taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

taskType

taskType: string

Private Optional tenantId

tenantId?: string

timeout

timeout: MaybeTimeDuration

Protected zbClient

zbClient: ZeebeGrpcClient

Static Private Readonly DEFAULT_JOB_ACTIVATION_TIMEOUT

DEFAULT_JOB_ACTIVATION_TIMEOUT: Seconds = ...

Static Private Readonly DEFAULT_MAX_ACTIVE_JOBS

DEFAULT_MAX_ACTIVE_JOBS: 32 = 32

Methods

Private activateJobs

  • activateJobs(id): Promise<{
        closing?: undefined;
        error?: undefined;
        stalled: true;
        stream: undefined;
    } | {
        closing: true;
        error?: undefined;
        stalled?: undefined;
        stream: undefined;
    } | {
        closing?: undefined;
        error: Error;
        stalled?: undefined;
        stream: undefined;
    } | {
        closing?: undefined;
        error?: undefined;
        stalled?: undefined;
        stream: {} & {} & EmitterAugmentation1<"metadata", Metadata> & EmitterAugmentation1<"status", StatusObject> & EventEmitter & {} & EmitterAugmentation1<"data", unknown> & IntermediateObjectReadable<unknown> & {
            error?: Error;
        };
    }>

  • Parameters

    • id: string

    Returns Promise<{
        closing?: undefined;
        error?: undefined;
        stalled: true;
        stream: undefined;
    } | {
        closing: true;
        error?: undefined;
        stalled?: undefined;
        stream: undefined;
    } | {
        closing?: undefined;
        error: Error;
        stalled?: undefined;
        stream: undefined;
    } | {
        closing?: undefined;
        error?: undefined;
        stalled?: undefined;
        stream: {} & {} & EmitterAugmentation1<"metadata", Metadata> & EmitterAugmentation1<"status", StatusObject> & EventEmitter & {} & EmitterAugmentation1<"data", unknown> & IntermediateObjectReadable<unknown> & {
            error?: Error;
        };
    }>

close

  • close(timeout?): Promise<null>

  • Returns a promise that the worker has stopped accepting tasks and -has drained all current active tasks. Will reject if you try to call it more than once.

    -

    Parameters

    • Optional timeout: number

    Returns Promise<null>

Private completeJob

  • completeJob(jobKey, completedVariables?): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

  • Parameters

    • jobKey: string
    • completedVariables: {} = {}

      Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

    debug

    Protected drainOne

    emit

    • emit<K>(eventName, params?): void

    • Type Parameters

      • K extends EventKey<{
            close: "close";
            connectionError: "connectionError";
            ready: "ready";
            unknown: "unknown";
        }>

      Parameters

      • eventName: K
      • Optional params: {
            close: "close";
            connectionError: "connectionError";
            ready: "ready";
            unknown: "unknown";
        }[K]

      Returns void

    error

    Private errorJob

    Private failJob

    Private handleJobResponse

    Protected handleJobs

    Private handleStreamEnd

    log

    Protected makeCompleteHandlers

    off

    on

    Private poll

    removeAllListeners

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/zeebe_types._internal_.GrpcClient.html b/docs/classes/zeebe_types._internal_.GrpcClient.html deleted file mode 100644 index 795b2929..00000000 --- a/docs/classes/zeebe_types._internal_.GrpcClient.html +++ /dev/null @@ -1,92 +0,0 @@ -GrpcClient | @camunda8/sdk

    Class GrpcClient

    Hierarchy (view full)

    Constructors

    constructor -

    Properties

    channelClosed -channelState -client -closing -config -connected -connectionTolerance -failTimer? -gRPCRetryCount -host -listNameMethods -longPoll? -oAuth? -packageDefinition -readyTimer? -userAgentString -

    Methods

    close -getAuthToken -interceptor -listMethods -runService -setNotReady -setReady -waitForGrpcChannelReconnect -

    Constructors

    constructor

    Properties

    channelClosed

    channelClosed: boolean = false

    Private channelState

    channelState: number = 0

    client

    client: Client

    Private closing

    closing: boolean = false

    Private config

    config: {
        CAMUNDA_CONSOLE_BASE_URL: undefined | string;
        CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
        CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
        CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
        CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
        CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
        CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
        CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
        CAMUNDA_MODELER_BASE_URL: string;
        CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
        CAMUNDA_OAUTH_DISABLED: boolean;
        CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
        CAMUNDA_OAUTH_URL: undefined | string;
        CAMUNDA_OPERATE_BASE_URL: undefined | string;
        CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
        CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
        CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
        CAMUNDA_SECURE_CONNECTION: boolean;
        CAMUNDA_TASKLIST_BASE_URL: undefined | string;
        CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
        CAMUNDA_TENANT_ID: undefined | string;
        CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
        CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
        CAMUNDA_TOKEN_SCOPE: undefined | string;
        CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
        ZEEBE_ADDRESS: string;
        ZEEBE_CLIENT_ID: undefined | string;
        ZEEBE_CLIENT_SECRET: undefined | string;
        zeebeGrpcSettings: {
            GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
            GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
            GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
            GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
            GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
            GRPC_KEEPALIVE_TIMEOUT_MS: number;
            GRPC_KEEPALIVE_TIME_MS: number;
            GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
            GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
            ZEEBE_CLIENT_LOG_LEVEL: string;
            ZEEBE_CLIENT_LOG_TYPE: string;
            ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
            ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
            ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
            ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
            ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
            ZEEBE_GRPC_CLIENT_RETRY: boolean;
            ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
            ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
        };
    }

    Type declaration

    • CAMUNDA_CONSOLE_BASE_URL: undefined | string

      The base url for the Admin Console API.

      -
    • CAMUNDA_CONSOLE_CLIENT_ID: undefined | string

      Credentials for Admin Console and Modeler API

      -
    • CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string

      Credentials for Admin Console and Modeler API

      -
    • CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string

      The audience parameter for an Admin Console OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise

      -
    • CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string

      When using custom or self-signed certificates, provide the path to the certificate chain

      -
    • CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string

      When using custom or self-signed certificates, provide the path to the private key

      -
    • CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string

      In an environment using self-signed certificates, provide the path to the root certificate

      -
    • CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string

      Custom user agent

      -
    • CAMUNDA_MODELER_BASE_URL: string

      The base url for the Modeler API. Defaults to Camunda Saas - https://modeler.cloud.camunda.io/api

      -
    • CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string

      The audience parameter for a Modeler OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise

      -
    • CAMUNDA_OAUTH_DISABLED: boolean

      Set to true to disable OAuth completely

      -
    • CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number

      How soon in milliseconds before its expiration time a cached OAuth token should be considered expired. Defaults to 1000

      -
    • CAMUNDA_OAUTH_URL: undefined | string

      The OAuth token exchange endpoint url

      -
    • CAMUNDA_OPERATE_BASE_URL: undefined | string

      The base url for the Operate API

      -
    • CAMUNDA_OPERATE_OAUTH_AUDIENCE: string

      The audience parameter for an Operate OAuth token request. Defaults to operate.camunda.io

      -
    • CAMUNDA_OPTIMIZE_BASE_URL: undefined | string

      The base url for the Optimize API

      -
    • CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string

      The audience parameter for an Optimize OAuth token request. Defaults to optimize.camunda.io

      -
    • CAMUNDA_SECURE_CONNECTION: boolean

      Control TLS for Zeebe Grpc. Defaults to true. Set to false when using an unsecured gateway

      -
    • CAMUNDA_TASKLIST_BASE_URL: undefined | string

      The base url for the Tasklist API

      -
    • CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string

      The audience parameter for a Tasklist OAuth token request. Defaults to tasklist.camunda.io

      -
    • CAMUNDA_TENANT_ID: undefined | string

      The tenant id when multi-tenancy is enabled

      -
    • CAMUNDA_TOKEN_CACHE_DIR: undefined | string

      The directory to cache OAuth tokens on-disk. Defaults to $HOME/.camunda

      -
    • CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean

      Set to true to disable disk caching of OAuth tokens and use memory caching only

      -
    • CAMUNDA_TOKEN_SCOPE: undefined | string

      Optional scope parameter for OAuth (needed by some OIDC)

      -
    • CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string

      The audience parameter for a Zeebe OAuth token request. Defaults to zeebe.camunda.io

      -
    • ZEEBE_ADDRESS: string

      The address for the Zeebe Gateway. Defaults to localhost:26500

      -
    • ZEEBE_CLIENT_ID: undefined | string

      This is the client ID for the client credentials

      -
    • ZEEBE_CLIENT_SECRET: undefined | string

      This is the client secret for the client credentials

      -
    • zeebeGrpcSettings: {
          GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
          GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
          GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
          GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
          GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
          GRPC_KEEPALIVE_TIMEOUT_MS: number;
          GRPC_KEEPALIVE_TIME_MS: number;
          GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
          GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
          ZEEBE_CLIENT_LOG_LEVEL: string;
          ZEEBE_CLIENT_LOG_TYPE: string;
          ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
          ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
          ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
          ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
          ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
          ZEEBE_GRPC_CLIENT_RETRY: boolean;
          ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
          ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
      }
      • GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number

        This channel argument controls the maximum number -of pings that can be sent when there is no other -data (data frame or header frame) to be sent. -GRPC Core will not continue sending pings if we -run over the limit. Setting it to 0 allows sending -pings without sending data.

        -
      • GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number

        Minimum allowed time between a server receiving -successive ping frames without sending any data -frame. Int valued, milliseconds. Default: 90000

        -
      • GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number

        Defaults to 90000.

        -
      • GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number

        The time between the first and second connection attempts, -in ms. Defaults to 1000.

        -
      • GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number

        This channel argument if set to 1 -(0 : false; 1 : true), allows keepalive pings -to be sent even if there are no calls in flight. -Defaults to 1.

        -
      • GRPC_KEEPALIVE_TIMEOUT_MS: number

        After waiting for a duration of this time, if the keepalive ping sender does not receive the ping ack, it will close the -transport. Int valued, milliseconds. Defaults to 120000.

        -
      • GRPC_KEEPALIVE_TIME_MS: number

        After a duration of this time the client/server pings its peer to see if the transport is still alive. -Int valued, milliseconds. Defaults to 360000.

        -
      • GRPC_MAX_RECONNECT_BACKOFF_MS: string | number

        The maximum time between subsequent connection attempts, -in ms. Defaults to 10000.

        -
      • GRPC_MIN_RECONNECT_BACKOFF_MS: string | number

        The minimum time between subsequent connection attempts, -in ms. Default is 1000ms, but this can cause an SSL Handshake failure. -This causes an intermittent failure in the Worker-LongPoll test when run -against Camunda Cloud. -Raised to 5000ms. -See: https://github.com/grpc/grpc/issues/8382#issuecomment-259482949

        -
      • ZEEBE_CLIENT_LOG_LEVEL: string

        Log level of Zeebe Client and Workers - 'DEBUG' | 'INFO' | 'NONE'. Defaults to 'INFO'

        -
      • ZEEBE_CLIENT_LOG_TYPE: string

        Zeebe client log output can be human-readable 'SIMPLE' or structured 'JSON'. Defaults to 'SIMPLE'

        -
      • ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number

        The gRPC channel can "jitter". This suppresses a connection error message if the channel comes back within this window in milliseconds. Defaults to 3000

        -
      • ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean

        Immediately connect to the Zeebe Gateway (issues a silent topology request). Defaults to false

        -
      • ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number

        This suppresses intermediate errors during initial connection negotiation. On Camunda SaaS this defaults to 6000, on Self-Managed to 0

        -
      • ZEEBE_GRPC_CLIENT_MAX_RETRIES: number

        Maximum number of retries of network operations before failing. Defaults to -1 (infinite retries)

        -
      • ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number

        When retrying failed network operations, retries back off to this maximum period. Defaults to 10s

        -
      • ZEEBE_GRPC_CLIENT_RETRY: boolean

        Automate retrying operations that fail due to network conditions or broker backpressure. Defaults to true

        -
      • ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number

        How long in seconds the long poll Job Activation request is held open by a worker. Defaults to 60

        -
      • ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number

        After a long poll Job Activation request, this is the cool-off period in milliseconds before the worker requests more work. Defaults to 300

        -

    connected

    connected: boolean = false

    Private connectionTolerance

    connectionTolerance: number

    Private Optional failTimer

    failTimer?: Timeout

    Private gRPCRetryCount

    gRPCRetryCount: number = 0

    host

    host: string

    Private listNameMethods

    listNameMethods: string[]

    Optional longPoll

    longPoll?: MaybeTimeDuration

    Private Optional oAuth

    oAuth?: IOAuthProvider

    Private packageDefinition

    packageDefinition: PackageDefinition

    Private Optional readyTimer

    readyTimer?: Timeout

    Private userAgentString

    userAgentString: string

    Methods

    close

    Private getAuthToken

    Private interceptor

    listMethods

    runService

    Private setNotReady

    Private setReady

    Private waitForGrpcChannelReconnect

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/index.Zeebe.Types.PartitionBrokerHealth.html b/docs/enums/index.Zeebe.Types.PartitionBrokerHealth.html deleted file mode 100644 index 9294155c..00000000 --- a/docs/enums/index.Zeebe.Types.PartitionBrokerHealth.html +++ /dev/null @@ -1,5 +0,0 @@ -PartitionBrokerHealth | @camunda8/sdk

    Enumeration PartitionBrokerHealth

    Describes the current health of the partition

    -

    Enumeration Members

    DEAD -HEALTHY -UNHEALTHY -

    Enumeration Members

    DEAD

    DEAD: 2

    HEALTHY

    HEALTHY: 0

    UNHEALTHY

    UNHEALTHY: 1

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/index.Zeebe.Types.PartitionBrokerRole.html b/docs/enums/index.Zeebe.Types.PartitionBrokerRole.html deleted file mode 100644 index 4366372c..00000000 --- a/docs/enums/index.Zeebe.Types.PartitionBrokerRole.html +++ /dev/null @@ -1,5 +0,0 @@ -PartitionBrokerRole | @camunda8/sdk

    Enumeration PartitionBrokerRole

    Describes the Raft role of the broker for a given partition

    -

    Enumeration Members

    BROKER -INACTIVE -LEADER -

    Enumeration Members

    BROKER

    BROKER: 1

    INACTIVE

    INACTIVE: 2

    LEADER

    LEADER: 0

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html deleted file mode 100644 index 1d6cb343..00000000 --- a/docs/hierarchy.html +++ /dev/null @@ -1 +0,0 @@ -@camunda8/sdk

    @camunda8/sdk

    Class Hierarchy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 7ba58365..00000000 --- a/docs/index.html +++ /dev/null @@ -1,107 +0,0 @@ -@camunda8/sdk

    @camunda8/sdk

    Camunda 8 JavaScript SDK

    NPM

    -

    This is the official Camunda 8 JavaScript SDK. It is written in TypeScript and runs on NodeJS (why not in a web browser?).

    -

    Using the SDK in your project

    Install the SDK as a dependency:

    -
    npm i @camunda8/sdk
-
    -

    Usage

    In this release, the functionality of the Camunda Platform 8 is exposed via dedicated clients for the component APIs.

    -
    import { Camunda8 } from '@camunda8/sdk'

    const c8 = new Camunda8()
    const zeebe = c8.getZeebeGrpcClient()
    const operate = c8.getOperateApiClient()
    const optimize = c8.getOptimizeApiClient()
    const tasklist = c8.getTasklistApiClient()
    const modeler = c8.getModelerApiClient()
    const admin = c8.getAdminApiClient()
-
    -

    Configuration

    The configuration for the SDK can be done by any combination of environment variables and explicit configuration passed to the Camunda8 constructor.

    -

    Any configuration passed in to the Camunda8 constructor is merged over any configuration in the environment.

    -

    The configuration object fields and the environment variables have exactly the same names. See the file src/lib/Configuration.ts for a complete list of configuration.

    -

    A note on how int64 is handled in the JavaScript SDK

    Entity keys in Camunda 8 are stored and represented as int64 numbers. The range of int64 extends to numbers that cannot be represented by the JavaScript number type. To deal with this, int64 keys are serialised by the SDK to the JavaScript string type. See this issue for more details.

    -

    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 Dto object to decode them reliably. If no Dto is specified, the default behaviour of the SDK is to serialise all numbers to JavaScript number, and if a number value is detected at runtime that cannot be accurately stored as number, to throw an Exception.

    -

    OAuth

    Calls to APIs are authorized using a token that is obtained via a client id/secret pair exchange and then passes as an authorisation header on API calls. The SDK handles this transparently for you.

    -

    If your Camunda 8 Platform is secured using token exchange you will need to provide the client id and secret to the SDK.

    -

    Disable OAuth

    To disable OAuth, set the environment variable CAMUNDA_OAUTH_DISABLED. You can use this when, for example, running against a minimal Zeebe broker in a development environment.

    -

    With this environment variable set, the SDK will inject a NullAuthProvider that does nothing.

    -

    Configuring OAuth

    To get a token for use with the application APIs you need to provide the following configuration fields at a minimum, either via the Camunda8 constructor or in environment variables:

    -
    ZEEBE_ADDRESS
    ZEEBE_CLIENT_ID
    ZEEBE_CLIENT_SECRET
    CAMUNDA_OAUTH_URL
-
    -

    To get a token for the Camunda SaaS Admin Console API or the Camunda SaaS Modeler API you need to set the following:

    -
    CAMUNDA_CONSOLE_CLIENT_ID
    CAMUNDA_CONSOLE_CLIENT_SECRET
-
    -

    Token caching

    OAuth tokens are cached in-memory and on-disk. The disk cache is useful, for example, to prevent token endpoint saturation when restarting or rolling over workers. They can all hit the cache instead of requesting new tokens.

    -

    You can turn off the disk caching by setting CAMUNDA_TOKEN_DISK_CACHE_DISABLE to true. This will cache tokens in-memory only.

    -

    By default the token cache directory is $HOME/.camunda. You can specify a different directory by providing a full file path value for CAMUNDA_TOKEN_CACHE_DIR.

    -

    Here is an example of specifying a different cache directory via the constructor:

    -
    import { Camunda8 } from '@camunda8/sdk'

    const c8 = new Camunda8({
        config: {
            CAMUNDA_TOKEN_CACHE_DIR: '/tmp/cache',
        },
    })
-
    -

    If the cache directory does not exist, the SDK will attempt to create it (recursively). If the SDK is unable to create it, or the directory exists but is not writeable by your application then the SDK will throw an exception.

    -

    Token refresh

    Token refresh timing relative to expiration is controlled by the CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS value. By default this is 1000ms. Tokens are renewed this amount of time before they expire.

    -

    If you experience intermittent 401: Unauthorized errors, this may not be sufficient time to refresh the token before it expires in your infrastructure. Increase this value to force a token to be refreshed before it expires.

    -

    Connection Configuration Examples

    Self-Managed

    This is the complete environment configuration needed to run against the Dockerised Self-Managed Stack in the docker subdirectory:

    -
    # Self-Managed
    export ZEEBE_ADDRESS='localhost:26500'
    export ZEEBE_CLIENT_ID='zeebe'
    export ZEEBE_CLIENT_SECRET='zecret'
    export CAMUNDA_OAUTH_URL='http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token'
    export CAMUNDA_TASKLIST_BASE_URL='http://localhost:8082'
    export CAMUNDA_OPERATE_BASE_URL='http://localhost:8081'
    export CAMUNDA_OPTIMIZE_BASE_URL='http://localhost:8083'
    export CAMUNDA_MODELER_BASE_URL='http://localhost:8070/api'

    # Turn off the tenant ID, which may have been set by Multi-tenant tests
    # You can set this in a constructor config, or in the environment if running multi-tenant
    export CAMUNDA_TENANT_ID=''

    # TLS for gRPC is on by default. If the Zeebe broker is not secured by TLS, turn it off
    export CAMUNDA_SECURE_CONNECTION=false
-
    -

    If you are using an OIDC that requires a scope parameter to be passed with the token request, set the following variable:

    -
    CAMUNDA_TOKEN_SCOPE
-
    -

    Here is an example of doing this via the constructor, rather than via the environment:

    -
    import { Camunda8 } from '@camunda8/sdk'

    const c8 = new Camunda8({
      config: {
        ZEEBE_ADDRESS: 'localhost:26500'
        ZEEBE_CLIENT_ID: 'zeebe'
        ZEEBE_CLIENT_SECRET: 'zecret'
        CAMUNDA_OAUTH_URL: 'http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token'
        CAMUNDA_TASKLIST_BASE_URL: 'http://localhost:8082'
        CAMUNDA_OPERATE_BASE_URL: 'http://localhost:8081'
        CAMUNDA_OPTIMIZE_BASE_URL: 'http://localhost:8083'
        CAMUNDA_MODELER_BASE_URL: 'http://localhost:8070/api'
        CAMUNDA_TENANT_ID: '' // We can override values in the env by passing an empty string value
        CAMUNDA_SECURE_CONNECTION: false
      }
    })
-
    -

    Camunda SaaS

    Here is a complete configuration example for connection to Camunda SaaS:

    -
    export ZEEBE_ADDRESS='5c34c0a7-7f29-4424-8414-125615f7a9b9.syd-1.zeebe.camunda.io:443'
    export ZEEBE_CLIENT_ID='yvvURO9TmBnP3zx4Xd8Ho6apgeiZTjn6'
    export ZEEBE_CLIENT_SECRET='iJJu-SHgUtuJTTAMnMLdcb8WGF8s2mHfXhXutEwe8eSbLXn98vUpoxtuLk5uG0en'
    # export CAMUNDA_CREDENTIALS_SCOPES='Zeebe,Tasklist,Operate,Optimize' # What APIs these client creds are authorised for
    export CAMUNDA_TASKLIST_BASE_URL='https://syd-1.tasklist.camunda.io/5c34c0a7-7f29-4424-8414-125615f7a9b9'
    export CAMUNDA_OPTIMIZE_BASE_URL='https://syd-1.optimize.camunda.io/5c34c0a7-7f29-4424-8414-125615f7a9b9'
    export CAMUNDA_OPERATE_BASE_URL='https://syd-1.operate.camunda.io/5c34c0a7-7f29-4424-8414-125615f7a9b9'
    export CAMUNDA_OAUTH_URL='https://login.cloud.camunda.io/oauth/token'

    # This is on by default, but we include it in case it got turned off for local tests
    export CAMUNDA_SECURE_CONNECTION=true

    # Admin Console and Modeler API Client
    export CAMUNDA_CONSOLE_CLIENT_ID='e-JdgKfJy9hHSXzi'
    export CAMUNDA_CONSOLE_CLIENT_SECRET='DT8Pe-ANC6e3Je_ptLyzZvBNS0aFwaIV'
    export CAMUNDA_CONSOLE_BASE_URL='https://api.cloud.camunda.io'
    export CAMUNDA_CONSOLE_OAUTH_AUDIENCE='api.cloud.camunda.io'
-
    -

    Debugging

    The SDK uses the debug library. To enable debugging output, set a value for the DEBUG environment variable. The value is a comma-separated list of debugging namespaces. The SDK has the following namespaces:

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ValueComponent
    camunda:adminconsoleAdmin Console API
    camunda:modelerModeler API
    camunda:operateOperate API
    camunda:optimizeOptimize API
    camunda:tasklistTasklist API
    camunda:oauthOAuth Token Exchange
    camunda:grpcZeebe gRPC channel
    camunda:workerZeebe Worker
    camunda:zeebeclientZeebe Client
    -

    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 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:

    -
      -
    1. To provide design-time type information on the job.variables object.
      2. -
    2. To specify the parsing of JSON number fields. These can potentially represent int64 values that cannot be represented accurately by the JavaScript number type. With a Dto, you can specify that a specific JSON number fields be parsed losslessly to a string or BigInt.
      3. -
    -

    With no Dto specified, there is no design-time type safety. At run-time, all JSON numbers are converted to the JavaScript number type. If a variable field has a number value that cannot be safely represented using the JavaScript number type (a value greater than 2^53 -1) then an exception is thrown.

    -

    To provide a Dto, extend the LosslessDto class, like so:

    -
    class MyVariableDto extends LosslessDto {
        name!: string
        maybeAge?: number
        @Int64String
        veryBigNumber!: string
        @BigIntValue
        veryBigInteger!: bigint
    }
-
    -

    In this case, veryBigNumber is an int64 value. It is transferred as a JSON number on the wire, but the parser will parse it into a string so that no loss of precision occurs. Similarly, veryBigInteger is a very large integer value. In this case, we direct the parser to parse this variable field as a bigint.

    -

    You can nest Dtos like this:

    -
    class MyLargerDto extends LosslessDto {
        id!: string
        @ChildDto(MyVariableDto)
        entry!: MyVariableDto
    }
-
    -

    Typing of Custom Headers

    The Zeebe worker receives custom headers as job.customHeaders. The ZBClient.createWorker() method accepts a customHeadersDto to control the behaviour of custom header parsing of number values and provide design-time type information.

    -

    This follows the same strategy as the job variables, as previously described.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Admin.AdminDto.Cluster.html b/docs/interfaces/index.Admin.AdminDto.Cluster.html deleted file mode 100644 index 04a9016f..00000000 --- a/docs/interfaces/index.Admin.AdminDto.Cluster.html +++ /dev/null @@ -1,11 +0,0 @@ -Cluster | @camunda8/sdk

    Interface Cluster

    interface Cluster {
        channel: {
            name: string;
            uuid: string;
        };
        created: string;
        generation: {
            name: string;
            uuid: string;
        };
        links: {
            connectors: string;
            console: string;
            operate: string;
            optimize: string;
            tasklist: string;
            zeebe: string;
        };
        name: string;
        ownerId: string;
        planType: {
            name: string;
            uuid: string;
        };
        region: {
            name: string;
            uuid: string;
        };
        status: {
            operateStatus: ClusterStatusstring;
            optimizeStatus: ClusterStatusstring;
            ready: ClusterStatusstring;
            tasklistStatus: ClusterStatusstring;
            zeebeStatus: ClusterStatusstring;
        };
        uuid: string;
    }

    Properties

    channel -created -generation -links -name -ownerId -planType -region -status -uuid -

    Properties

    channel

    channel: {
        name: string;
        uuid: string;
    }

    Type declaration

    • name: string
    • uuid: string

    created

    created: string

    generation

    generation: {
        name: string;
        uuid: string;
    }

    Type declaration

    • name: string
    • uuid: string

    links

    links: {
        connectors: string;
        console: string;
        operate: string;
        optimize: string;
        tasklist: string;
        zeebe: string;
    }

    Type declaration

    • connectors: string
    • console: string
    • operate: string
    • optimize: string
    • tasklist: string
    • zeebe: string

    name

    name: string

    ownerId

    ownerId: string

    planType

    planType: {
        name: string;
        uuid: string;
    }

    Type declaration

    • name: string
    • uuid: string

    region

    region: {
        name: string;
        uuid: string;
    }

    Type declaration

    • name: string
    • uuid: string

    status

    status: {
        operateStatus: ClusterStatusstring;
        optimizeStatus: ClusterStatusstring;
        ready: ClusterStatusstring;
        tasklistStatus: ClusterStatusstring;
        zeebeStatus: ClusterStatusstring;
    }

    Type declaration

    uuid

    uuid: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Admin.AdminDto.ClusterClient.html b/docs/interfaces/index.Admin.AdminDto.ClusterClient.html deleted file mode 100644 index 93d64e1e..00000000 --- a/docs/interfaces/index.Admin.AdminDto.ClusterClient.html +++ /dev/null @@ -1,4 +0,0 @@ -ClusterClient | @camunda8/sdk

    Interface ClusterClient

    interface ClusterClient {
        clientId: string;
        name: string;
        permissions: ("Zeebe" | "Operate" | "Tasklist")[];
    }

    Properties

    clientId -name -permissions -

    Properties

    clientId

    clientId: string

    name

    name: string

    permissions

    permissions: ("Zeebe" | "Operate" | "Tasklist")[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Admin.AdminDto.ClusterClientConnectionDetails.html b/docs/interfaces/index.Admin.AdminDto.ClusterClientConnectionDetails.html deleted file mode 100644 index c26b9f10..00000000 --- a/docs/interfaces/index.Admin.AdminDto.ClusterClientConnectionDetails.html +++ /dev/null @@ -1,5 +0,0 @@ -ClusterClientConnectionDetails | @camunda8/sdk

    Interface ClusterClientConnectionDetails

    interface ClusterClientConnectionDetails {
        ZEEBE_ADDRESS: string;
        ZEEBE_AUTHORIZATION_SERVER_URL: string;
        ZEEBE_CLIENT_ID: string;
        name: string;
    }

    Properties

    ZEEBE_ADDRESS -ZEEBE_AUTHORIZATION_SERVER_URL -ZEEBE_CLIENT_ID -name -

    Properties

    ZEEBE_ADDRESS

    ZEEBE_ADDRESS: string

    ZEEBE_AUTHORIZATION_SERVER_URL

    ZEEBE_AUTHORIZATION_SERVER_URL: string

    ZEEBE_CLIENT_ID

    ZEEBE_CLIENT_ID: string

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Admin.AdminDto.CreateClusterBody.html b/docs/interfaces/index.Admin.AdminDto.CreateClusterBody.html deleted file mode 100644 index a2f57500..00000000 --- a/docs/interfaces/index.Admin.AdminDto.CreateClusterBody.html +++ /dev/null @@ -1,6 +0,0 @@ -CreateClusterBody | @camunda8/sdk

    Interface CreateClusterBody

    interface CreateClusterBody {
        channelId: string;
        generationId: string;
        name: string;
        planTypeId: string;
        regionId: string;
    }

    Properties

    channelId -generationId -name -planTypeId -regionId -

    Properties

    channelId

    channelId: string

    generationId

    generationId: string

    name

    name: string

    planTypeId

    planTypeId: string

    regionId

    regionId: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Admin.AdminDto.CreatedClusterClient.html b/docs/interfaces/index.Admin.AdminDto.CreatedClusterClient.html deleted file mode 100644 index c6ca63eb..00000000 --- a/docs/interfaces/index.Admin.AdminDto.CreatedClusterClient.html +++ /dev/null @@ -1,4 +0,0 @@ -CreatedClusterClient | @camunda8/sdk

    Interface CreatedClusterClient

    interface CreatedClusterClient {
        clientId: string;
        clientSecret: string;
        uuid: string;
    }

    Properties

    clientId -clientSecret -uuid -

    Properties

    clientId

    clientId: string

    clientSecret

    clientSecret: string

    uuid

    uuid: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Admin.AdminDto.Member.html b/docs/interfaces/index.Admin.AdminDto.Member.html deleted file mode 100644 index 2d75f82c..00000000 --- a/docs/interfaces/index.Admin.AdminDto.Member.html +++ /dev/null @@ -1,5 +0,0 @@ -Member | @camunda8/sdk

    Interface Member

    interface Member {
        email: string;
        invitePending: boolean;
        name: string;
        roles: OrganizationRole[];
    }

    Properties

    email -invitePending -name -roles -

    Properties

    email

    email: string

    invitePending

    invitePending: boolean

    name

    name: string

    roles

    roles: OrganizationRole[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Admin.AdminDto.Parameters.html b/docs/interfaces/index.Admin.AdminDto.Parameters.html deleted file mode 100644 index 988c2fe4..00000000 --- a/docs/interfaces/index.Admin.AdminDto.Parameters.html +++ /dev/null @@ -1,4 +0,0 @@ -Parameters | @camunda8/sdk

    Interface Parameters

    interface Parameters {
        channels: [{
            allowedGenerations: [{
                name: string;
                uuid: string;
            }];
            defaultGeneration: {
                name: string;
                uuid: string;
            };
            name: string;
            uuid: string;
        }];
        clusterPlanTypes: [{
            name: string;
            uuid: string;
        }];
        regions: [{
            name: string;
            uuid: string;
        }];
    }

    Properties

    channels -clusterPlanTypes -regions -

    Properties

    channels

    channels: [{
        allowedGenerations: [{
            name: string;
            uuid: string;
        }];
        defaultGeneration: {
            name: string;
            uuid: string;
        };
        name: string;
        uuid: string;
    }]

    Type declaration

    • allowedGenerations: [{
          name: string;
          uuid: string;
      }]
    • defaultGeneration: {
          name: string;
          uuid: string;
      }
      • name: string
      • uuid: string
    • name: string
    • uuid: string

    clusterPlanTypes

    clusterPlanTypes: [{
        name: string;
        uuid: string;
    }]

    Type declaration

    • name: string
    • uuid: string

    regions

    regions: [{
        name: string;
        uuid: string;
    }]

    Type declaration

    • name: string
    • uuid: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Auth.IOAuthProvider.html b/docs/interfaces/index.Auth.IOAuthProvider.html deleted file mode 100644 index a35d0662..00000000 --- a/docs/interfaces/index.Auth.IOAuthProvider.html +++ /dev/null @@ -1,2 +0,0 @@ -IOAuthProvider | @camunda8/sdk

    Interface IOAuthProvider

    interface IOAuthProvider {
        getToken(audience): Promise<string>;
    }

    Implemented by

    Methods

    getToken -

    Methods

    getToken

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Auth.Token.html b/docs/interfaces/index.Auth.Token.html deleted file mode 100644 index 38361433..00000000 --- a/docs/interfaces/index.Auth.Token.html +++ /dev/null @@ -1,7 +0,0 @@ -Token | @camunda8/sdk

    Interface Token

    interface Token {
        access_token: string;
        audience: string;
        expires_in: number;
        expiry: number;
        scope: string;
        token_type: string;
    }

    Properties

    access_token -audience -expires_in -expiry -scope -token_type -

    Properties

    access_token

    access_token: string

    audience

    audience: string

    expires_in

    expires_in: number

    expiry

    expiry: number

    scope

    scope: string

    token_type

    token_type: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Auth.TokenError.html b/docs/interfaces/index.Auth.TokenError.html deleted file mode 100644 index fab79c67..00000000 --- a/docs/interfaces/index.Auth.TokenError.html +++ /dev/null @@ -1,3 +0,0 @@ -TokenError | @camunda8/sdk

    Interface TokenError

    interface TokenError {
        error: string;
        error_description: string;
    }

    Properties

    error -error_description -

    Properties

    error

    error: string

    error_description

    error_description: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.CreateCollaboratorDto.html b/docs/interfaces/index.Modeler.ModelerDto.CreateCollaboratorDto.html deleted file mode 100644 index 1ec8e45a..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.CreateCollaboratorDto.html +++ /dev/null @@ -1,4 +0,0 @@ -CreateCollaboratorDto | @camunda8/sdk

    Interface CreateCollaboratorDto

    interface CreateCollaboratorDto {
        email: string;
        projectId: string;
        role: "project_admin" | "editor" | "viewer" | "commenter";
    }

    Properties

    email -projectId -role -

    Properties

    email

    email: string

    projectId

    projectId: string

    role

    role: "project_admin" | "editor" | "viewer" | "commenter"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.CreateFileDto.html b/docs/interfaces/index.Modeler.ModelerDto.CreateFileDto.html deleted file mode 100644 index c7bbadf4..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.CreateFileDto.html +++ /dev/null @@ -1,10 +0,0 @@ -CreateFileDto | @camunda8/sdk

    Interface CreateFileDto

    interface CreateFileDto {
        content: string;
        fileType: string;
        folderId: string;
        name: string;
        pattern: "form" | "bpmn" | "dmn" | "connector_template";
        projectId: string;
    }

    Properties

    content -fileType -folderId -name -pattern -projectId -

    Properties

    content

    content: string

    fileType

    fileType: string

    folderId

    folderId: string

    maxLength: 255, minLength: 1

    -

    name

    name: string

    maxLength: 255, minLength: 1

    -

    pattern

    pattern: "form" | "bpmn" | "dmn" | "connector_template"

    projectId

    projectId: string

    maxLength: 255, minLength: 1

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.CreateFolderDto.html b/docs/interfaces/index.Modeler.ModelerDto.CreateFolderDto.html deleted file mode 100644 index c6d80597..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.CreateFolderDto.html +++ /dev/null @@ -1,7 +0,0 @@ -CreateFolderDto | @camunda8/sdk

    Interface CreateFolderDto

    interface CreateFolderDto {
        name: string;
        parentId: string;
        projectId: string;
    }

    Properties

    name -parentId -projectId -

    Properties

    name

    name: string

    maxLength: 255 minLength: 1

    -

    parentId

    parentId: string

    maxLength: 255 minLength: 1

    -

    projectId

    projectId: string

    maxLength: 255 minLength: 1

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.CreateMilestoneDto.html b/docs/interfaces/index.Modeler.ModelerDto.CreateMilestoneDto.html deleted file mode 100644 index 34df51d2..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.CreateMilestoneDto.html +++ /dev/null @@ -1,5 +0,0 @@ -CreateMilestoneDto | @camunda8/sdk

    Interface CreateMilestoneDto

    interface CreateMilestoneDto {
        fileId: string;
        name: string;
    }

    Properties

    fileId -name -

    Properties

    fileId

    fileId: string

    maxLength: 255 minLength: 1

    -

    name

    name: string

    maxLength: 255 minLength: 1

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.FileDto.html b/docs/interfaces/index.Modeler.ModelerDto.FileDto.html deleted file mode 100644 index 47398199..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.FileDto.html +++ /dev/null @@ -1,3 +0,0 @@ -FileDto | @camunda8/sdk

    Interface FileDto

    interface FileDto {
        content: string;
        metadata: FileMetadataDto;
    }

    Properties

    content -metadata -

    Properties

    content

    content: string

    metadata

    metadata: FileMetadataDto

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.FileMetadataDto.html b/docs/interfaces/index.Modeler.ModelerDto.FileMetadataDto.html deleted file mode 100644 index c57c5885..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.FileMetadataDto.html +++ /dev/null @@ -1,13 +0,0 @@ -FileMetadataDto | @camunda8/sdk

    Interface FileMetadataDto

    interface FileMetadataDto {
        canonicalPath: PathElementDto[];
        created: string;
        createdBy: UserDto;
        folderId: string;
        id: string;
        name: string;
        projectId: string;
        revision: number;
        simplePath: string;
        type: string;
        updated: string;
        updatedBy: UserDto;
    }

    Properties

    canonicalPath -created -createdBy -folderId -id -name -projectId -revision -simplePath -type -updated -updatedBy -

    Properties

    canonicalPath

    canonicalPath: PathElementDto[]

    created

    created: string

    createdBy

    createdBy: UserDto

    folderId

    folderId: string

    id

    id: string

    name

    name: string

    projectId

    projectId: string

    revision

    revision: number

    simplePath

    simplePath: string

    type

    type: string

    updated

    updated: string

    updatedBy

    updatedBy: UserDto

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.FolderContentDto.html b/docs/interfaces/index.Modeler.ModelerDto.FolderContentDto.html deleted file mode 100644 index 84689406..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.FolderContentDto.html +++ /dev/null @@ -1,3 +0,0 @@ -FolderContentDto | @camunda8/sdk

    Interface FolderContentDto

    interface FolderContentDto {
        files: FileMetadataDto[];
        folders: FolderMetadataDto[];
    }

    Properties

    files -folders -

    Properties

    files

    files: FileMetadataDto[]

    folders

    folders: FolderMetadataDto[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.FolderDto.html b/docs/interfaces/index.Modeler.ModelerDto.FolderDto.html deleted file mode 100644 index 3e2d97ac..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.FolderDto.html +++ /dev/null @@ -1,3 +0,0 @@ -FolderDto | @camunda8/sdk

    Interface FolderDto

    interface FolderDto {
        content: FolderContentDto;
        metadata: FolderMetadataDto;
    }

    Properties

    content -metadata -

    Properties

    content

    content: FolderContentDto

    metadata

    metadata: FolderMetadataDto

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.FolderMetadataDto.html b/docs/interfaces/index.Modeler.ModelerDto.FolderMetadataDto.html deleted file mode 100644 index 7b8f93cf..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.FolderMetadataDto.html +++ /dev/null @@ -1,9 +0,0 @@ -FolderMetadataDto | @camunda8/sdk

    Interface FolderMetadataDto

    interface FolderMetadataDto {
        created: string;
        createdBy: UserDto;
        id: string;
        name: string;
        parentId: string;
        projectId: string;
        updated: string;
        updatedBy: UserDto;
    }

    Properties

    created -createdBy -id -name -parentId -projectId -updated -updatedBy -

    Properties

    created

    created: string

    createdBy

    createdBy: UserDto

    id

    id: string

    name

    name: string

    parentId

    parentId: string

    projectId

    projectId: string

    updated

    updated: string

    updatedBy

    updatedBy: UserDto

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.InfoDto.html b/docs/interfaces/index.Modeler.ModelerDto.InfoDto.html deleted file mode 100644 index d83dcbff..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.InfoDto.html +++ /dev/null @@ -1,7 +0,0 @@ -InfoDto | @camunda8/sdk

    Interface InfoDto

    interface InfoDto {
        authorizedOrganization: string;
        createPermission: boolean;
        deletePermission: boolean;
        readPermission: boolean;
        updatePermission: boolean;
        version: string;
    }

    Properties

    authorizedOrganization -createPermission -deletePermission -readPermission -updatePermission -version -

    Properties

    authorizedOrganization

    authorizedOrganization: string

    createPermission

    createPermission: boolean

    deletePermission

    deletePermission: boolean

    readPermission

    readPermission: boolean

    updatePermission

    updatePermission: boolean

    version

    version: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.MilestoneDto.html b/docs/interfaces/index.Modeler.ModelerDto.MilestoneDto.html deleted file mode 100644 index 79d0033e..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.MilestoneDto.html +++ /dev/null @@ -1,3 +0,0 @@ -MilestoneDto | @camunda8/sdk

    Interface MilestoneDto

    interface MilestoneDto {
        content: string;
        metadata: MilestoneMetadataDto;
    }

    Properties

    content -metadata -

    Properties

    content

    content: string

    metadata

    metadata: MilestoneMetadataDto

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.MilestoneMetadataDto.html b/docs/interfaces/index.Modeler.ModelerDto.MilestoneMetadataDto.html deleted file mode 100644 index 349cb319..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.MilestoneMetadataDto.html +++ /dev/null @@ -1,8 +0,0 @@ -MilestoneMetadataDto | @camunda8/sdk

    Interface MilestoneMetadataDto

    interface MilestoneMetadataDto {
        created: string;
        createdBy: UserDto;
        fileId: string;
        id: string;
        name: string;
        updated: string;
        updatedBy: UserDto;
    }

    Properties

    created -createdBy -fileId -id -name -updated -updatedBy -

    Properties

    created

    created: string

    createdBy

    createdBy: UserDto

    fileId

    fileId: string

    id

    id: string

    name

    name: string

    updated

    updated: string

    updatedBy

    updatedBy: UserDto

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.PathElementDto.html b/docs/interfaces/index.Modeler.ModelerDto.PathElementDto.html deleted file mode 100644 index 6bbd3535..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.PathElementDto.html +++ /dev/null @@ -1,3 +0,0 @@ -PathElementDto | @camunda8/sdk

    Interface PathElementDto

    interface PathElementDto {
        id: string;
        name: string;
    }

    Properties

    id -name -

    Properties

    id

    id: string

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.ProjectCollaboratorDto.html b/docs/interfaces/index.Modeler.ModelerDto.ProjectCollaboratorDto.html deleted file mode 100644 index fef73385..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.ProjectCollaboratorDto.html +++ /dev/null @@ -1,5 +0,0 @@ -ProjectCollaboratorDto | @camunda8/sdk

    Interface ProjectCollaboratorDto

    interface ProjectCollaboratorDto {
        email: string;
        name: string;
        projectId: string;
        role: string;
    }

    Properties

    email -name -projectId -role -

    Properties

    email

    email: string

    name

    name: string

    projectId

    projectId: string

    role

    role: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.ProjectContent.html b/docs/interfaces/index.Modeler.ModelerDto.ProjectContent.html deleted file mode 100644 index a0c01944..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.ProjectContent.html +++ /dev/null @@ -1,3 +0,0 @@ -ProjectContent | @camunda8/sdk

    Interface ProjectContent

    interface ProjectContent {
        files: FileMetadataDto[];
        folders: FolderMetadataDto[];
    }

    Properties

    files -folders -

    Properties

    files

    files: FileMetadataDto[]

    folders

    folders: FolderMetadataDto[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.ProjectDto.html b/docs/interfaces/index.Modeler.ModelerDto.ProjectDto.html deleted file mode 100644 index 7a654628..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.ProjectDto.html +++ /dev/null @@ -1,3 +0,0 @@ -ProjectDto | @camunda8/sdk

    Interface ProjectDto

    interface ProjectDto {
        content: ProjectContent;
        metadata: ProjectMetadataDto;
    }

    Properties

    content -metadata -

    Properties

    content

    content: ProjectContent

    metadata

    metadata: ProjectMetadataDto

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.ProjectMetadataDto.html b/docs/interfaces/index.Modeler.ModelerDto.ProjectMetadataDto.html deleted file mode 100644 index f8e6b39d..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.ProjectMetadataDto.html +++ /dev/null @@ -1,7 +0,0 @@ -ProjectMetadataDto | @camunda8/sdk

    Interface ProjectMetadataDto

    interface ProjectMetadataDto {
        created: string;
        createdBy: UserDto;
        id: string;
        name: string;
        updated: string;
        updatedBy: UserDto;
    }

    Properties

    created -createdBy -id -name -updated -updatedBy -

    Properties

    created

    created: string

    createdBy

    createdBy: UserDto

    id

    id: string

    name

    name: string

    updated

    updated: string

    updatedBy

    updatedBy: UserDto

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.PubSearchDtoFileMetadataDto.html b/docs/interfaces/index.Modeler.ModelerDto.PubSearchDtoFileMetadataDto.html deleted file mode 100644 index c2ee1c5d..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.PubSearchDtoFileMetadataDto.html +++ /dev/null @@ -1,7 +0,0 @@ -PubSearchDtoFileMetadataDto | @camunda8/sdk

    Interface PubSearchDtoFileMetadataDto

    interface PubSearchDtoFileMetadataDto {
        filter: Partial<FileMetadataDto>;
        page?: number;
        size?: number;
        sort?: SortDto[];
    }

    Properties

    filter -page? -size? -sort? -

    Properties

    filter

    filter: Partial<FileMetadataDto>

    Optional page

    page?: number

    minimum: 0

    -

    Optional size

    size?: number

    maximum: 50 minimum: 0

    -

    Optional sort

    sort?: SortDto[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.PubSearchDtoMilestoneMetadataDto.html b/docs/interfaces/index.Modeler.ModelerDto.PubSearchDtoMilestoneMetadataDto.html deleted file mode 100644 index fb7785a7..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.PubSearchDtoMilestoneMetadataDto.html +++ /dev/null @@ -1,7 +0,0 @@ -PubSearchDtoMilestoneMetadataDto | @camunda8/sdk

    Interface PubSearchDtoMilestoneMetadataDto

    interface PubSearchDtoMilestoneMetadataDto {
        filter: Partial<MilestoneMetadataDto>;
        page?: number;
        size?: number;
        sort?: SortDto[];
    }

    Properties

    filter -page? -size? -sort? -

    Properties

    filter

    filter: Partial<MilestoneMetadataDto>

    Optional page

    page?: number

    minimum: 0

    -

    Optional size

    size?: number

    maximum: 50 minimum: 0

    -

    Optional sort

    sort?: SortDto[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.PubSearchDtoProjectCollaboratorDto.html b/docs/interfaces/index.Modeler.ModelerDto.PubSearchDtoProjectCollaboratorDto.html deleted file mode 100644 index 6e7ac968..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.PubSearchDtoProjectCollaboratorDto.html +++ /dev/null @@ -1,7 +0,0 @@ -PubSearchDtoProjectCollaboratorDto | @camunda8/sdk

    Interface PubSearchDtoProjectCollaboratorDto

    interface PubSearchDtoProjectCollaboratorDto {
        filter: Partial<ProjectCollaboratorDto>;
        page?: number;
        size?: number;
        sort?: SortDto[];
    }

    Properties

    filter -page? -size? -sort? -

    Properties

    filter

    filter: Partial<ProjectCollaboratorDto>

    Optional page

    page?: number

    minimum 0

    -

    Optional size

    size?: number

    minumum 0, maximum 50

    -

    Optional sort

    sort?: SortDto[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.PubSearchDtoProjectMetadataDto.html b/docs/interfaces/index.Modeler.ModelerDto.PubSearchDtoProjectMetadataDto.html deleted file mode 100644 index aa87c5da..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.PubSearchDtoProjectMetadataDto.html +++ /dev/null @@ -1,7 +0,0 @@ -PubSearchDtoProjectMetadataDto | @camunda8/sdk

    Interface PubSearchDtoProjectMetadataDto

    interface PubSearchDtoProjectMetadataDto {
        filter: Partial<ProjectMetadataDto>;
        page?: number;
        size?: number;
        sort?: SortDto[];
    }

    Properties

    filter -page? -size? -sort? -

    Properties

    filter

    filter: Partial<ProjectMetadataDto>

    Optional page

    page?: number

    minimum: 0

    -

    Optional size

    size?: number

    maximum: 50, minimum: 0

    -

    Optional sort

    sort?: SortDto[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoFileMetadataDto.html b/docs/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoFileMetadataDto.html deleted file mode 100644 index 7c886c65..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoFileMetadataDto.html +++ /dev/null @@ -1,3 +0,0 @@ -PubSearchResultDtoFileMetadataDto | @camunda8/sdk

    Interface PubSearchResultDtoFileMetadataDto

    interface PubSearchResultDtoFileMetadataDto {
        items: FileMetadataDto[];
        total: number;
    }

    Properties

    items -total -

    Properties

    items

    items: FileMetadataDto[]

    total

    total: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoMilestoneMetadataDto.html b/docs/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoMilestoneMetadataDto.html deleted file mode 100644 index 69ff35d9..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoMilestoneMetadataDto.html +++ /dev/null @@ -1,3 +0,0 @@ -PubSearchResultDtoMilestoneMetadataDto | @camunda8/sdk

    Interface PubSearchResultDtoMilestoneMetadataDto

    interface PubSearchResultDtoMilestoneMetadataDto {
        items: MilestoneMetadataDto[];
        total: number;
    }

    Properties

    items -total -

    Properties

    items

    items: MilestoneMetadataDto[]

    total

    total: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoProjectCollaboratorDto.html b/docs/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoProjectCollaboratorDto.html deleted file mode 100644 index e059ad8d..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoProjectCollaboratorDto.html +++ /dev/null @@ -1,3 +0,0 @@ -PubSearchResultDtoProjectCollaboratorDto | @camunda8/sdk

    Interface PubSearchResultDtoProjectCollaboratorDto

    interface PubSearchResultDtoProjectCollaboratorDto {
        items: ProjectCollaboratorDto[];
        total: number;
    }

    Properties

    items -total -

    Properties

    items

    items: ProjectCollaboratorDto[]

    total

    total: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoProjectMetadataDto.html b/docs/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoProjectMetadataDto.html deleted file mode 100644 index 81997254..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoProjectMetadataDto.html +++ /dev/null @@ -1,3 +0,0 @@ -PubSearchResultDtoProjectMetadataDto | @camunda8/sdk

    Interface PubSearchResultDtoProjectMetadataDto

    interface PubSearchResultDtoProjectMetadataDto {
        items: ProjectMetadataDto[];
        total: number;
    }

    Properties

    items -total -

    Properties

    items

    items: ProjectMetadataDto[]

    total

    total: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.SortDto.html b/docs/interfaces/index.Modeler.ModelerDto.SortDto.html deleted file mode 100644 index 84a10256..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.SortDto.html +++ /dev/null @@ -1,3 +0,0 @@ -SortDto | @camunda8/sdk

    Interface SortDto

    interface SortDto {
        direction: "ASC" | "DESC";
        field: string;
    }

    Properties

    direction -field -

    Properties

    direction

    direction: "ASC" | "DESC"

    field

    field: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.UpdateFileDto.html b/docs/interfaces/index.Modeler.ModelerDto.UpdateFileDto.html deleted file mode 100644 index d8415fe5..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.UpdateFileDto.html +++ /dev/null @@ -1,9 +0,0 @@ -UpdateFileDto | @camunda8/sdk

    Interface UpdateFileDto

    interface UpdateFileDto {
        content: string;
        folderId: string;
        name: string;
        projectId: string;
        revision: number;
    }

    Properties

    content -folderId -name -projectId -revision -

    Properties

    content

    content: string

    folderId

    folderId: string

    maxLength: 255, minLength: 1

    -

    name

    name: string

    maxLength: 255, minLength: 1

    -

    projectId

    projectId: string

    maxLength: 255, minLength: 1

    -

    revision

    revision: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.UpdateFolderDto.html b/docs/interfaces/index.Modeler.ModelerDto.UpdateFolderDto.html deleted file mode 100644 index d7443a16..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.UpdateFolderDto.html +++ /dev/null @@ -1,7 +0,0 @@ -UpdateFolderDto | @camunda8/sdk

    Interface UpdateFolderDto

    interface UpdateFolderDto {
        name: string;
        parentId: string;
        projectId: string;
    }

    Properties

    name -parentId -projectId -

    Properties

    name

    name: string

    maxLength: 255 minLength: 1

    -

    parentId

    parentId: string

    maxLength: 255 minLength: 1

    -

    projectId

    projectId: string

    maxLength: 255 minLength: 1

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Modeler.ModelerDto.UserDto.html b/docs/interfaces/index.Modeler.ModelerDto.UserDto.html deleted file mode 100644 index 345b6b97..00000000 --- a/docs/interfaces/index.Modeler.ModelerDto.UserDto.html +++ /dev/null @@ -1,3 +0,0 @@ -UserDto | @camunda8/sdk

    Interface UserDto

    interface UserDto {
        email: string;
        name: string;
    }

    Properties

    email -name -

    Properties

    email

    email: string

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Operate.OperateDto.Query.html b/docs/interfaces/index.Operate.OperateDto.Query.html deleted file mode 100644 index 3dff8ba2..00000000 --- a/docs/interfaces/index.Operate.OperateDto.Query.html +++ /dev/null @@ -1,5 +0,0 @@ -Query | @camunda8/sdk

    Interface Query<T>

    interface Query<T> {
        filter?: Partial<T>;
        searchAfter?: unknown[];
        size?: number;
        sort?: [{
            field: keyof T;
            order: "ASC" | "DESC";
        }];
    }

    Type Parameters

    • T

    Properties

    filter? -searchAfter? -size? -sort? -

    Properties

    Optional filter

    filter?: Partial<T>

    Optional searchAfter

    searchAfter?: unknown[]

    Optional size

    size?: number

    Optional sort

    sort?: [{
        field: keyof T;
        order: "ASC" | "DESC";
    }]

    Type declaration

    • field: keyof T
    • order: "ASC" | "DESC"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Operate.OperateDto.SearchResults.html b/docs/interfaces/index.Operate.OperateDto.SearchResults.html deleted file mode 100644 index 80a82e78..00000000 --- a/docs/interfaces/index.Operate.OperateDto.SearchResults.html +++ /dev/null @@ -1,4 +0,0 @@ -SearchResults | @camunda8/sdk

    Interface SearchResults<T>

    interface SearchResults<T> {
        items: T[];
        sortValues: unknown[];
        total: string;
    }

    Type Parameters

    • T

    Properties

    items -sortValues -total -

    Properties

    items

    items: T[]

    sortValues

    sortValues: unknown[]

    total

    total: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Optimize.OptimizeDto.CloudEventV1.html b/docs/interfaces/index.Optimize.OptimizeDto.CloudEventV1.html deleted file mode 100644 index cb2997b6..00000000 --- a/docs/interfaces/index.Optimize.OptimizeDto.CloudEventV1.html +++ /dev/null @@ -1,100 +0,0 @@ -CloudEventV1 | @camunda8/sdk

    Interface CloudEventV1<T>

    The object interface for CloudEvents 1.0.

    -

    See

    https://github.com/cloudevents/spec/blob/v1.0/spec.md

    -
    interface CloudEventV1<T> {
        data?: T;
        data_base64?: string;
        datacontenttype?: string;
        dataschema?: string;
        id: string;
        source: string;
        specversion: string;
        subject?: string;
        time?: string;
        type: string;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Properties

    data? -data_base64? -datacontenttype? -dataschema? -id -source -specversion -subject? -time? -type -

    Properties

    Optional data

    data?: T

    [OPTIONAL] The event payload. This specification does not place any restriction -on the type of this information. It is encoded into a media format which is -specified by the datacontenttype attribute (e.g. application/json), and adheres -to the dataschema format when those respective attributes are present.

    -

    Optional data_base64

    data_base64?: string

    [OPTIONAL] The event payload encoded as base64 data. This is used when the -data is in binary form.

    -

    See

    https://github.com/cloudevents/spec/blob/v1.0/json-format.md#31-handling-of-data

    -

    Optional datacontenttype

    datacontenttype?: string

    [OPTIONAL] Content type of data value. This attribute enables data to -carry any type of content, whereby format and encoding might differ from that -of the chosen event format. For example, an event rendered using the -JSON envelope format might carry an XML payload -in data, and the consumer is informed by this attribute being set to -"application/xml". The rules for how data content is rendered for different -datacontenttype values are defined in the event format specifications; for -example, the JSON event format defines the relationship in -section 3.1.

    -

    Optional dataschema

    dataschema?: string

    [OPTIONAL] Identifies the schema that data adheres to. Incompatible -changes to the schema SHOULD be reflected by a different URI. See -Versioning of Attributes in the Primer -for more information. -If present, MUST be a non-empty URI.

    -

    id

    id: string

    [REQUIRED] Identifies the event. Producers MUST ensure that source + id -is unique for each distinct event. If a duplicate event is re-sent (e.g. due -to a network error) it MAY have the same id. Consumers MAY assume that -Events with identical source and id are duplicates.

    -

    Required

    Non-empty string. Unique within producer.

    -

    Example

    An event counter maintained by the producer
-
    -

    Example

    A UUID
-
    -

    source

    source: string

    [REQUIRED] Identifies the context in which an event happened. Often this -will include information such as the type of the event source, the -organization publishing the event or the process that produced the event. The -exact syntax and semantics behind the data encoded in the URI is defined by -the event producer. -Producers MUST ensure that source + id is unique for each distinct event. -An application MAY assign a unique source to each distinct producer, which -makes it easy to produce unique IDs since no other producer will have the same -source. The application MAY use UUIDs, URNs, DNS authorities or an -application-specific scheme to create unique source identifiers. -A source MAY include more than one producer. In that case the producers MUST -collaborate to ensure that source + id is unique for each distinct event.

    -

    Required

    Non-empty URI-reference

    -

    specversion

    specversion: string

    [REQUIRED] The version of the CloudEvents specification which the event -uses. This enables the interpretation of the context. Compliant event -producers MUST use a value of 1.0 when referring to this version of the -specification.

    -

    Required

    MUST be a non-empty string.

    -

    Optional subject

    subject?: string

    [OPTIONAL] This describes the subject of the event in the context of the -event producer (identified by source). In publish-subscribe scenarios, a -subscriber will typically subscribe to events emitted by a source, but the -source identifier alone might not be sufficient as a qualifier for any -specific event if the source context has internal sub-structure.

    -

    Identifying the subject of the event in context metadata (opposed to only in -the data payload) is particularly helpful in generic subscription filtering -scenarios where middleware is unable to interpret the data content. In the -above example, the subscriber might only be interested in blobs with names -ending with '.jpg' or '.jpeg' and the subject attribute allows for -constructing a simple and efficient string-suffix filter for that subset of -events.

    -

    If present, MUST be a non-empty string.

    -

    Example

    "https://example.com/storage/tenant/container"
-
    -

    Example

    "mynewfile.jpg"
-
    -

    Optional time

    time?: string

    [OPTIONAL] Timestamp of when the occurrence happened. If the time of the -occurrence cannot be determined then this attribute MAY be set to some other -time (such as the current time) by the CloudEvents producer, however all -producers for the same source MUST be consistent in this respect. In other -words, either they all use the actual time of the occurrence or they all use -the same algorithm to determine the value used.

    -

    Example

    "2020-08-08T14:48:09.769Z"
-
    -

    type

    type: string

    [REQUIRED] This attribute contains a value describing the type of event -related to the originating occurrence. Often this attribute is used for -routing, observability, policy enforcement, etc. The format of this is -producer defined and might include information such as the version of the -type - see -Versioning of Attributes in the Primer -for more information.

    -

    Required

    MUST be a non-empty string

    -

    Should

    SHOULD be prefixed with a reverse-DNS name. The prefixed domain dictates the - organization which defines the semantics of this event type.

    -

    Example

    com.github.pull.create
-
    -

    Example

    com.example.object.delete.v2
-
    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Optimize.OptimizeDto.CloudEventV1Attributes.html b/docs/interfaces/index.Optimize.OptimizeDto.CloudEventV1Attributes.html deleted file mode 100644 index 4a4ab420..00000000 --- a/docs/interfaces/index.Optimize.OptimizeDto.CloudEventV1Attributes.html +++ /dev/null @@ -1,82 +0,0 @@ -CloudEventV1Attributes | @camunda8/sdk

    Interface CloudEventV1Attributes<T>

    interface CloudEventV1Attributes<T> {
        data?: T;
        data_base64?: string;
        datacontenttype?: string;
        dataschema?: string;
        source: string;
        subject?: string;
        time?: string;
        type: string;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Properties

    data? -data_base64? -datacontenttype? -dataschema? -source -subject? -time? -type -

    Properties

    Optional data

    data?: T

    [OPTIONAL] The event payload. This specification does not place any restriction -on the type of this information. It is encoded into a media format which is -specified by the datacontenttype attribute (e.g. application/json), and adheres -to the dataschema format when those respective attributes are present.

    -

    Optional data_base64

    data_base64?: string

    [OPTIONAL] The event payload encoded as base64 data. This is used when the -data is in binary form.

    -

    See

    https://github.com/cloudevents/spec/blob/v1.0/json-format.md#31-handling-of-data

    -

    Optional datacontenttype

    datacontenttype?: string

    [OPTIONAL] Content type of data value. This attribute enables data to -carry any type of content, whereby format and encoding might differ from that -of the chosen event format. For example, an event rendered using the -JSON envelope format might carry an XML payload -in data, and the consumer is informed by this attribute being set to -"application/xml". The rules for how data content is rendered for different -datacontenttype values are defined in the event format specifications; for -example, the JSON event format defines the relationship in -section 3.1.

    -

    Optional dataschema

    dataschema?: string

    [OPTIONAL] Identifies the schema that data adheres to. Incompatible -changes to the schema SHOULD be reflected by a different URI. See -Versioning of Attributes in the Primer -for more information. -If present, MUST be a non-empty URI.

    -

    source

    source: string

    [REQUIRED] Identifies the context in which an event happened. Often this -will include information such as the type of the event source, the -organization publishing the event or the process that produced the event. The -exact syntax and semantics behind the data encoded in the URI is defined by -the event producer. -Producers MUST ensure that source + id is unique for each distinct event. -An application MAY assign a unique source to each distinct producer, which -makes it easy to produce unique IDs since no other producer will have the same -source. The application MAY use UUIDs, URNs, DNS authorities or an -application-specific scheme to create unique source identifiers. -A source MAY include more than one producer. In that case the producers MUST -collaborate to ensure that source + id is unique for each distinct event.

    -

    Required

    Non-empty URI-reference

    -

    Optional subject

    subject?: string

    [OPTIONAL] This describes the subject of the event in the context of the -event producer (identified by source). In publish-subscribe scenarios, a -subscriber will typically subscribe to events emitted by a source, but the -source identifier alone might not be sufficient as a qualifier for any -specific event if the source context has internal sub-structure.

    -

    Identifying the subject of the event in context metadata (opposed to only in -the data payload) is particularly helpful in generic subscription filtering -scenarios where middleware is unable to interpret the data content. In the -above example, the subscriber might only be interested in blobs with names -ending with '.jpg' or '.jpeg' and the subject attribute allows for -constructing a simple and efficient string-suffix filter for that subset of -events.

    -

    If present, MUST be a non-empty string.

    -

    Example

    "https://example.com/storage/tenant/container"
-
    -

    Example

    "mynewfile.jpg"
-
    -

    Optional time

    time?: string

    [OPTIONAL] Timestamp of when the occurrence happened. If the time of the -occurrence cannot be determined then this attribute MAY be set to some other -time (such as the current time) by the CloudEvents producer, however all -producers for the same source MUST be consistent in this respect. In other -words, either they all use the actual time of the occurrence or they all use -the same algorithm to determine the value used.

    -

    Example

    "2020-08-08T14:48:09.769Z"
-
    -

    type

    type: string

    [REQUIRED] This attribute contains a value describing the type of event -related to the originating occurrence. Often this attribute is used for -routing, observability, policy enforcement, etc. The format of this is -producer defined and might include information such as the version of the -type - see -Versioning of Attributes in the Primer -for more information.

    -

    Required

    MUST be a non-empty string

    -

    Should

    SHOULD be prefixed with a reverse-DNS name. The prefixed domain dictates the - organization which defines the semantics of this event type.

    -

    Example

    com.github.pull.create
-
    -

    Example

    com.example.object.delete.v2
-
    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Optimize.OptimizeDto.CloudEventV1OptionalAttributes.html b/docs/interfaces/index.Optimize.OptimizeDto.CloudEventV1OptionalAttributes.html deleted file mode 100644 index 99881974..00000000 --- a/docs/interfaces/index.Optimize.OptimizeDto.CloudEventV1OptionalAttributes.html +++ /dev/null @@ -1,54 +0,0 @@ -CloudEventV1OptionalAttributes | @camunda8/sdk

    Interface CloudEventV1OptionalAttributes<T>

    interface CloudEventV1OptionalAttributes<T> {
        data?: T;
        data_base64?: string;
        datacontenttype?: string;
        dataschema?: string;
        subject?: string;
        time?: string;
        [key: string]: unknown;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Indexable

    [key: string]: unknown

    [OPTIONAL] CloudEvents extension attributes.

    -

    Properties

    data? -data_base64? -datacontenttype? -dataschema? -subject? -time? -

    Properties

    Optional data

    data?: T

    [OPTIONAL] The event payload. This specification does not place any restriction -on the type of this information. It is encoded into a media format which is -specified by the datacontenttype attribute (e.g. application/json), and adheres -to the dataschema format when those respective attributes are present.

    -

    Optional data_base64

    data_base64?: string

    [OPTIONAL] The event payload encoded as base64 data. This is used when the -data is in binary form.

    -

    See

    https://github.com/cloudevents/spec/blob/v1.0/json-format.md#31-handling-of-data

    -

    Optional datacontenttype

    datacontenttype?: string

    [OPTIONAL] Content type of data value. This attribute enables data to -carry any type of content, whereby format and encoding might differ from that -of the chosen event format. For example, an event rendered using the -JSON envelope format might carry an XML payload -in data, and the consumer is informed by this attribute being set to -"application/xml". The rules for how data content is rendered for different -datacontenttype values are defined in the event format specifications; for -example, the JSON event format defines the relationship in -section 3.1.

    -

    Optional dataschema

    dataschema?: string

    [OPTIONAL] Identifies the schema that data adheres to. Incompatible -changes to the schema SHOULD be reflected by a different URI. See -Versioning of Attributes in the Primer -for more information. -If present, MUST be a non-empty URI.

    -

    Optional subject

    subject?: string

    [OPTIONAL] This describes the subject of the event in the context of the -event producer (identified by source). In publish-subscribe scenarios, a -subscriber will typically subscribe to events emitted by a source, but the -source identifier alone might not be sufficient as a qualifier for any -specific event if the source context has internal sub-structure.

    -

    Identifying the subject of the event in context metadata (opposed to only in -the data payload) is particularly helpful in generic subscription filtering -scenarios where middleware is unable to interpret the data content. In the -above example, the subscriber might only be interested in blobs with names -ending with '.jpg' or '.jpeg' and the subject attribute allows for -constructing a simple and efficient string-suffix filter for that subset of -events.

    -

    If present, MUST be a non-empty string.

    -

    Example

    "https://example.com/storage/tenant/container"
-
    -

    Example

    "mynewfile.jpg"
-
    -

    Optional time

    time?: string

    [OPTIONAL] Timestamp of when the occurrence happened. If the time of the -occurrence cannot be determined then this attribute MAY be set to some other -time (such as the current time) by the CloudEvents producer, however all -producers for the same source MUST be consistent in this respect. In other -words, either they all use the actual time of the occurrence or they all use -the same algorithm to determine the value used.

    -

    Example

    "2020-08-08T14:48:09.769Z"
-
    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Optimize.OptimizeDto.DashboardDefinition.html b/docs/interfaces/index.Optimize.OptimizeDto.DashboardDefinition.html deleted file mode 100644 index 8fa2091c..00000000 --- a/docs/interfaces/index.Optimize.OptimizeDto.DashboardDefinition.html +++ /dev/null @@ -1,8 +0,0 @@ -DashboardDefinition | @camunda8/sdk

    Interface DashboardDefinition

    interface DashboardDefinition {
        availableFilters: unknown[];
        collectionId: null | string;
        exportEntityType: "dashboard";
        id: string;
        name: string;
        reports: {
            id: string;
        }[];
        sourceIndexVersion: number;
    }

    Properties

    availableFilters -collectionId -exportEntityType -id -name -reports -sourceIndexVersion -

    Properties

    availableFilters

    availableFilters: unknown[]

    collectionId

    collectionId: null | string

    exportEntityType

    exportEntityType: "dashboard"

    id

    id: string

    name

    name: string

    reports

    reports: {
        id: string;
    }[]

    Type declaration

    • id: string

    sourceIndexVersion

    sourceIndexVersion: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Optimize.OptimizeDto.ReportData.html b/docs/interfaces/index.Optimize.OptimizeDto.ReportData.html deleted file mode 100644 index 613213a5..00000000 --- a/docs/interfaces/index.Optimize.OptimizeDto.ReportData.html +++ /dev/null @@ -1,11 +0,0 @@ -ReportData | @camunda8/sdk

    Interface ReportData

    interface ReportData {
        businessKey: string;
        duration: number;
        endDate: string;
        engineName: string;
        processDefinitionId: string;
        processDefinitionKey: string;
        processInstanceId: string;
        startDate: string;
        tenantId: null;
        variables: unknown;
    }

    Properties

    businessKey -duration -endDate -engineName -processDefinitionId -processDefinitionKey -processInstanceId -startDate -tenantId -variables -

    Properties

    businessKey

    businessKey: string

    duration

    duration: number

    endDate

    endDate: string

    engineName

    engineName: string

    processDefinitionId

    processDefinitionId: string

    processDefinitionKey

    processDefinitionKey: string

    processInstanceId

    processInstanceId: string

    startDate

    startDate: string

    tenantId

    tenantId: null

    variables

    variables: unknown

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Optimize.OptimizeDto.ReportDataExporter.html b/docs/interfaces/index.Optimize.OptimizeDto.ReportDataExporter.html deleted file mode 100644 index 6ed5ed4a..00000000 --- a/docs/interfaces/index.Optimize.OptimizeDto.ReportDataExporter.html +++ /dev/null @@ -1,2 +0,0 @@ -ReportDataExporter | @camunda8/sdk

    Interface ReportDataExporter

    interface ReportDataExporter {
        next: (() => Promise<ReportDataPage>);
    }

    Properties

    next -

    Properties

    next

    next: (() => Promise<ReportDataPage>)

    Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Optimize.OptimizeDto.ReportDataPage.html b/docs/interfaces/index.Optimize.OptimizeDto.ReportDataPage.html deleted file mode 100644 index bda3f185..00000000 --- a/docs/interfaces/index.Optimize.OptimizeDto.ReportDataPage.html +++ /dev/null @@ -1,6 +0,0 @@ -ReportDataPage | @camunda8/sdk

    Interface ReportDataPage

    interface ReportDataPage {
        data: ReportData[];
        numberOfRecordsInResponse: number;
        reportId: string;
        searchRequestId: string;
        totalNumberOfRecords: number;
    }

    Properties

    data -numberOfRecordsInResponse -reportId -searchRequestId -totalNumberOfRecords -

    Properties

    data

    data: ReportData[]

    numberOfRecordsInResponse

    numberOfRecordsInResponse: number

    reportId

    reportId: string

    searchRequestId

    searchRequestId: string

    totalNumberOfRecords

    totalNumberOfRecords: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Optimize.OptimizeDto.Variable.html b/docs/interfaces/index.Optimize.OptimizeDto.Variable.html deleted file mode 100644 index 53575541..00000000 --- a/docs/interfaces/index.Optimize.OptimizeDto.Variable.html +++ /dev/null @@ -1,7 +0,0 @@ -Variable | @camunda8/sdk

    Interface Variable

    interface Variable {
        id: string;
        name: string;
        processDefinitionKey: string;
        processInstanceId: string;
        type: VariableType;
        value: string;
    }

    Properties

    id -name -processDefinitionKey -processInstanceId -type -value -

    Properties

    id

    id: string

    name

    name: string

    processDefinitionKey

    processDefinitionKey: string

    processInstanceId

    processInstanceId: string

    type

    type: VariableType

    value

    value: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Optimize.OptimizeDto.VariableLabel.html b/docs/interfaces/index.Optimize.OptimizeDto.VariableLabel.html deleted file mode 100644 index cc75f729..00000000 --- a/docs/interfaces/index.Optimize.OptimizeDto.VariableLabel.html +++ /dev/null @@ -1,4 +0,0 @@ -VariableLabel | @camunda8/sdk

    Interface VariableLabel

    interface VariableLabel {
        variableLabel: string;
        variableName: string;
        variableType: VariableType;
    }

    Properties

    variableLabel -variableName -variableType -

    Properties

    variableLabel

    variableLabel: string

    variableName

    variableName: string

    variableType

    variableType: VariableType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Optimize.OptimizeDto.VariableLabels.html b/docs/interfaces/index.Optimize.OptimizeDto.VariableLabels.html deleted file mode 100644 index c7f5074c..00000000 --- a/docs/interfaces/index.Optimize.OptimizeDto.VariableLabels.html +++ /dev/null @@ -1,3 +0,0 @@ -VariableLabels | @camunda8/sdk

    Interface VariableLabels

    interface VariableLabels {
        definitionKey: string;
        labels: VariableLabel[];
    }

    Properties

    definitionKey -labels -

    Properties

    definitionKey

    definitionKey: string

    labels

    labels: VariableLabel[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Tasklist.TasklistDto.DateFilter.html b/docs/interfaces/index.Tasklist.TasklistDto.DateFilter.html deleted file mode 100644 index 0bfbd41f..00000000 --- a/docs/interfaces/index.Tasklist.TasklistDto.DateFilter.html +++ /dev/null @@ -1,3 +0,0 @@ -DateFilter | @camunda8/sdk

    Interface DateFilter

    interface DateFilter {
        from: string | Date;
        to: string | Date;
    }

    Properties

    from -to -

    Properties

    from

    from: string | Date

    to

    to: string | Date

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Tasklist.TasklistDto.DraftSearchVariableValue.html b/docs/interfaces/index.Tasklist.TasklistDto.DraftSearchVariableValue.html deleted file mode 100644 index 25173c47..00000000 --- a/docs/interfaces/index.Tasklist.TasklistDto.DraftSearchVariableValue.html +++ /dev/null @@ -1,4 +0,0 @@ -DraftSearchVariableValue | @camunda8/sdk

    Interface DraftSearchVariableValue

    interface DraftSearchVariableValue {
        isValueTruncated: boolean;
        previewValue: string;
        value: string;
    }

    Properties

    isValueTruncated -previewValue -value -

    Properties

    isValueTruncated

    isValueTruncated: boolean

    previewValue

    previewValue: string

    value

    value: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Tasklist.TasklistDto.TaskByVariables.html b/docs/interfaces/index.Tasklist.TasklistDto.TaskByVariables.html deleted file mode 100644 index b90f84dd..00000000 --- a/docs/interfaces/index.Tasklist.TasklistDto.TaskByVariables.html +++ /dev/null @@ -1,4 +0,0 @@ -TaskByVariables | @camunda8/sdk

    Interface TaskByVariables

    interface TaskByVariables {
        name: string;
        operator: "eq";
        value: string;
    }

    Properties

    name -operator -value -

    Properties

    name

    name: string

    operator

    operator: "eq"

    value

    value: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Tasklist.TasklistDto.TaskSearchAfterOrEqualRequest.html b/docs/interfaces/index.Tasklist.TasklistDto.TaskSearchAfterOrEqualRequest.html deleted file mode 100644 index a1aa5153..00000000 --- a/docs/interfaces/index.Tasklist.TasklistDto.TaskSearchAfterOrEqualRequest.html +++ /dev/null @@ -1,31 +0,0 @@ -TaskSearchAfterOrEqualRequest | @camunda8/sdk

    Interface TaskSearchAfterOrEqualRequest

    interface TaskSearchAfterOrEqualRequest {
        assigned?: boolean;
        assignee?: string;
        assignees?: string[];
        candidateGroup?: string;
        candidateGroups?: string[];
        candidateUser?: string;
        candidateUsers?: string[];
        dueDate?: DateFilter;
        followUpDate?: DateFilter;
        implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK";
        includeVariables?: IncludeVariable[];
        pageSize?: number;
        processDefinitionKey?: string;
        processInstanceKey?: string;
        searchAfterOrEqual: string[];
        sort?: TaskOrderBy[];
        state?: TaskState;
        taskDefinitionId?: string;
        taskVariables?: TaskByVariables[];
        tenantIds?: string[];
    }

    Hierarchy

    Properties

    assigned? -assignee? -assignees? -candidateGroup? -candidateGroups? -candidateUser? -candidateUsers? -dueDate? -followUpDate? -implementation? -includeVariables? -pageSize? -processDefinitionKey? -processInstanceKey? -searchAfterOrEqual -sort? -state? -taskDefinitionId? -taskVariables? -tenantIds? -

    Properties

    Optional assigned

    assigned?: boolean

    Optional assignee

    assignee?: string

    Optional assignees

    assignees?: string[]

    Optional candidateGroup

    candidateGroup?: string

    Optional candidateGroups

    candidateGroups?: string[]

    Optional candidateUser

    candidateUser?: string

    Optional candidateUsers

    candidateUsers?: string[]

    Optional dueDate

    dueDate?: DateFilter

    Optional followUpDate

    followUpDate?: DateFilter

    Optional implementation

    implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"

    Optional includeVariables

    includeVariables?: IncludeVariable[]

    An array used to specify a list of variable names that should be included in the response when querying tasks. -This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.

    -

    Optional pageSize

    pageSize?: number

    Optional processDefinitionKey

    processDefinitionKey?: string

    Optional processInstanceKey

    processInstanceKey?: string

    searchAfterOrEqual

    searchAfterOrEqual: string[]

    Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page. -It enables the API to return a page of tasks that directly follow or are equal to the task identified by the provided values, with respect to the sorting order.

    -

    Optional sort

    sort?: TaskOrderBy[]

    Optional state

    state?: TaskState

    Optional taskDefinitionId

    taskDefinitionId?: string

    Optional taskVariables

    taskVariables?: TaskByVariables[]

    An array of filter clauses specifying the variables to filter for. -If defined, the query returns only tasks to which all clauses apply. -However, it's important to note that this filtering mechanism is -designed to work exclusively with truncated variables. This means -variables of a larger size are not compatible with this filter, and -attempts to use them may result in inaccurate or incomplete query results.

    -

    Optional tenantIds

    tenantIds?: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Tasklist.TasklistDto.TaskSearchAfterRequest.html b/docs/interfaces/index.Tasklist.TasklistDto.TaskSearchAfterRequest.html deleted file mode 100644 index c8dbf0a9..00000000 --- a/docs/interfaces/index.Tasklist.TasklistDto.TaskSearchAfterRequest.html +++ /dev/null @@ -1,31 +0,0 @@ -TaskSearchAfterRequest | @camunda8/sdk

    Interface TaskSearchAfterRequest

    interface TaskSearchAfterRequest {
        assigned?: boolean;
        assignee?: string;
        assignees?: string[];
        candidateGroup?: string;
        candidateGroups?: string[];
        candidateUser?: string;
        candidateUsers?: string[];
        dueDate?: DateFilter;
        followUpDate?: DateFilter;
        implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK";
        includeVariables?: IncludeVariable[];
        pageSize?: number;
        processDefinitionKey?: string;
        processInstanceKey?: string;
        searchAfter: string[];
        sort?: TaskOrderBy[];
        state?: TaskState;
        taskDefinitionId?: string;
        taskVariables?: TaskByVariables[];
        tenantIds?: string[];
    }

    Hierarchy

    Properties

    assigned? -assignee? -assignees? -candidateGroup? -candidateGroups? -candidateUser? -candidateUsers? -dueDate? -followUpDate? -implementation? -includeVariables? -pageSize? -processDefinitionKey? -processInstanceKey? -searchAfter -sort? -state? -taskDefinitionId? -taskVariables? -tenantIds? -

    Properties

    Optional assigned

    assigned?: boolean

    Optional assignee

    assignee?: string

    Optional assignees

    assignees?: string[]

    Optional candidateGroup

    candidateGroup?: string

    Optional candidateGroups

    candidateGroups?: string[]

    Optional candidateUser

    candidateUser?: string

    Optional candidateUsers

    candidateUsers?: string[]

    Optional dueDate

    dueDate?: DateFilter

    Optional followUpDate

    followUpDate?: DateFilter

    Optional implementation

    implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"

    Optional includeVariables

    includeVariables?: IncludeVariable[]

    An array used to specify a list of variable names that should be included in the response when querying tasks. -This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.

    -

    Optional pageSize

    pageSize?: number

    Optional processDefinitionKey

    processDefinitionKey?: string

    Optional processInstanceKey

    processInstanceKey?: string

    searchAfter

    searchAfter: string[]

    Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page. -It enables the API to return a page of tasks that directly follow the task identified by the provided values, with respect to the sorting order.

    -

    Optional sort

    sort?: TaskOrderBy[]

    Optional state

    state?: TaskState

    Optional taskDefinitionId

    taskDefinitionId?: string

    Optional taskVariables

    taskVariables?: TaskByVariables[]

    An array of filter clauses specifying the variables to filter for. -If defined, the query returns only tasks to which all clauses apply. -However, it's important to note that this filtering mechanism is -designed to work exclusively with truncated variables. This means -variables of a larger size are not compatible with this filter, and -attempts to use them may result in inaccurate or incomplete query results.

    -

    Optional tenantIds

    tenantIds?: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Tasklist.TasklistDto.TaskSearchBeforeOrEqualRequest.html b/docs/interfaces/index.Tasklist.TasklistDto.TaskSearchBeforeOrEqualRequest.html deleted file mode 100644 index 2957d531..00000000 --- a/docs/interfaces/index.Tasklist.TasklistDto.TaskSearchBeforeOrEqualRequest.html +++ /dev/null @@ -1,31 +0,0 @@ -TaskSearchBeforeOrEqualRequest | @camunda8/sdk

    Interface TaskSearchBeforeOrEqualRequest

    interface TaskSearchBeforeOrEqualRequest {
        assigned?: boolean;
        assignee?: string;
        assignees?: string[];
        candidateGroup?: string;
        candidateGroups?: string[];
        candidateUser?: string;
        candidateUsers?: string[];
        dueDate?: DateFilter;
        followUpDate?: DateFilter;
        implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK";
        includeVariables?: IncludeVariable[];
        pageSize?: number;
        processDefinitionKey?: string;
        processInstanceKey?: string;
        searchBeforeOrEqual: string[];
        sort?: TaskOrderBy[];
        state?: TaskState;
        taskDefinitionId?: string;
        taskVariables?: TaskByVariables[];
        tenantIds?: string[];
    }

    Hierarchy

    Properties

    assigned? -assignee? -assignees? -candidateGroup? -candidateGroups? -candidateUser? -candidateUsers? -dueDate? -followUpDate? -implementation? -includeVariables? -pageSize? -processDefinitionKey? -processInstanceKey? -searchBeforeOrEqual -sort? -state? -taskDefinitionId? -taskVariables? -tenantIds? -

    Properties

    Optional assigned

    assigned?: boolean

    Optional assignee

    assignee?: string

    Optional assignees

    assignees?: string[]

    Optional candidateGroup

    candidateGroup?: string

    Optional candidateGroups

    candidateGroups?: string[]

    Optional candidateUser

    candidateUser?: string

    Optional candidateUsers

    candidateUsers?: string[]

    Optional dueDate

    dueDate?: DateFilter

    Optional followUpDate

    followUpDate?: DateFilter

    Optional implementation

    implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"

    Optional includeVariables

    includeVariables?: IncludeVariable[]

    An array used to specify a list of variable names that should be included in the response when querying tasks. -This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.

    -

    Optional pageSize

    pageSize?: number

    Optional processDefinitionKey

    processDefinitionKey?: string

    Optional processInstanceKey

    processInstanceKey?: string

    searchBeforeOrEqual

    searchBeforeOrEqual: string[]

    Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page. -It enables the API to return a page of tasks that directly precede or are equal to the task identified by the provided values, with respect to the sorting order.

    -

    Optional sort

    sort?: TaskOrderBy[]

    Optional state

    state?: TaskState

    Optional taskDefinitionId

    taskDefinitionId?: string

    Optional taskVariables

    taskVariables?: TaskByVariables[]

    An array of filter clauses specifying the variables to filter for. -If defined, the query returns only tasks to which all clauses apply. -However, it's important to note that this filtering mechanism is -designed to work exclusively with truncated variables. This means -variables of a larger size are not compatible with this filter, and -attempts to use them may result in inaccurate or incomplete query results.

    -

    Optional tenantIds

    tenantIds?: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Tasklist.TasklistDto.TaskSearchBeforeRequest.html b/docs/interfaces/index.Tasklist.TasklistDto.TaskSearchBeforeRequest.html deleted file mode 100644 index c46ce5d4..00000000 --- a/docs/interfaces/index.Tasklist.TasklistDto.TaskSearchBeforeRequest.html +++ /dev/null @@ -1,31 +0,0 @@ -TaskSearchBeforeRequest | @camunda8/sdk

    Interface TaskSearchBeforeRequest

    interface TaskSearchBeforeRequest {
        assigned?: boolean;
        assignee?: string;
        assignees?: string[];
        candidateGroup?: string;
        candidateGroups?: string[];
        candidateUser?: string;
        candidateUsers?: string[];
        dueDate?: DateFilter;
        followUpDate?: DateFilter;
        implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK";
        includeVariables?: IncludeVariable[];
        pageSize?: number;
        processDefinitionKey?: string;
        processInstanceKey?: string;
        searchBefore: string[];
        sort?: TaskOrderBy[];
        state?: TaskState;
        taskDefinitionId?: string;
        taskVariables?: TaskByVariables[];
        tenantIds?: string[];
    }

    Hierarchy

    Properties

    assigned? -assignee? -assignees? -candidateGroup? -candidateGroups? -candidateUser? -candidateUsers? -dueDate? -followUpDate? -implementation? -includeVariables? -pageSize? -processDefinitionKey? -processInstanceKey? -searchBefore -sort? -state? -taskDefinitionId? -taskVariables? -tenantIds? -

    Properties

    Optional assigned

    assigned?: boolean

    Optional assignee

    assignee?: string

    Optional assignees

    assignees?: string[]

    Optional candidateGroup

    candidateGroup?: string

    Optional candidateGroups

    candidateGroups?: string[]

    Optional candidateUser

    candidateUser?: string

    Optional candidateUsers

    candidateUsers?: string[]

    Optional dueDate

    dueDate?: DateFilter

    Optional followUpDate

    followUpDate?: DateFilter

    Optional implementation

    implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"

    Optional includeVariables

    includeVariables?: IncludeVariable[]

    An array used to specify a list of variable names that should be included in the response when querying tasks. -This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.

    -

    Optional pageSize

    pageSize?: number

    Optional processDefinitionKey

    processDefinitionKey?: string

    Optional processInstanceKey

    processInstanceKey?: string

    searchBefore

    searchBefore: string[]

    Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page. -It enables the API to return a page of tasks that directly precede the task identified by the provided values, with respect to the sorting order.

    -

    Optional sort

    sort?: TaskOrderBy[]

    Optional state

    state?: TaskState

    Optional taskDefinitionId

    taskDefinitionId?: string

    Optional taskVariables

    taskVariables?: TaskByVariables[]

    An array of filter clauses specifying the variables to filter for. -If defined, the query returns only tasks to which all clauses apply. -However, it's important to note that this filtering mechanism is -designed to work exclusively with truncated variables. This means -variables of a larger size are not compatible with this filter, and -attempts to use them may result in inaccurate or incomplete query results.

    -

    Optional tenantIds

    tenantIds?: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Tasklist.TasklistDto.TaskSearchRequestBase.html b/docs/interfaces/index.Tasklist.TasklistDto.TaskSearchRequestBase.html deleted file mode 100644 index 56ffaa24..00000000 --- a/docs/interfaces/index.Tasklist.TasklistDto.TaskSearchRequestBase.html +++ /dev/null @@ -1,28 +0,0 @@ -TaskSearchRequestBase | @camunda8/sdk

    Interface TaskSearchRequestBase

    interface TaskSearchRequestBase {
        assigned: boolean;
        assignee: string;
        assignees: string[];
        candidateGroup: string;
        candidateGroups: string[];
        candidateUser: string;
        candidateUsers: string[];
        dueDate: DateFilter;
        followUpDate: DateFilter;
        implementation: "JOB_WORKER" | "ZEEBE_USER_TASK";
        includeVariables: IncludeVariable[];
        pageSize: number;
        processDefinitionKey: string;
        processInstanceKey: string;
        sort: TaskOrderBy[];
        state: TaskState;
        taskDefinitionId: string;
        taskVariables: TaskByVariables[];
        tenantIds: string[];
    }

    Properties

    assigned -assignee -assignees -candidateGroup -candidateGroups -candidateUser -candidateUsers -dueDate -followUpDate -implementation -includeVariables -pageSize -processDefinitionKey -processInstanceKey -sort -state -taskDefinitionId -taskVariables -tenantIds -

    Properties

    assigned

    assigned: boolean

    assignee

    assignee: string

    assignees

    assignees: string[]

    candidateGroup

    candidateGroup: string

    candidateGroups

    candidateGroups: string[]

    candidateUser

    candidateUser: string

    candidateUsers

    candidateUsers: string[]

    dueDate

    dueDate: DateFilter

    followUpDate

    followUpDate: DateFilter

    implementation

    implementation: "JOB_WORKER" | "ZEEBE_USER_TASK"

    includeVariables

    includeVariables: IncludeVariable[]

    An array used to specify a list of variable names that should be included in the response when querying tasks. -This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.

    -

    pageSize

    pageSize: number

    processDefinitionKey

    processDefinitionKey: string

    processInstanceKey

    processInstanceKey: string

    sort

    sort: TaskOrderBy[]

    state

    state: TaskState

    taskDefinitionId

    taskDefinitionId: string

    taskVariables

    taskVariables: TaskByVariables[]

    An array of filter clauses specifying the variables to filter for. -If defined, the query returns only tasks to which all clauses apply. -However, it's important to note that this filtering mechanism is -designed to work exclusively with truncated variables. This means -variables of a larger size are not compatible with this filter, and -attempts to use them may result in inaccurate or incomplete query results.

    -

    tenantIds

    tenantIds: string[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Tasklist.TasklistDto.User.html b/docs/interfaces/index.Tasklist.TasklistDto.User.html deleted file mode 100644 index 977708d4..00000000 --- a/docs/interfaces/index.Tasklist.TasklistDto.User.html +++ /dev/null @@ -1,6 +0,0 @@ -User | @camunda8/sdk

    Interface User

    interface User {
        displayName: string;
        permissions: string[];
        roles: string[];
        salesPlanType: string;
        userId: string;
    }

    Properties

    displayName -permissions -roles -salesPlanType -userId -

    Properties

    displayName

    displayName: string

    permissions

    permissions: string[]

    roles

    roles: string[]

    salesPlanType

    salesPlanType: string

    userId

    userId: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Tasklist.TasklistDto.Variable.html b/docs/interfaces/index.Tasklist.TasklistDto.Variable.html deleted file mode 100644 index 1974c950..00000000 --- a/docs/interfaces/index.Tasklist.TasklistDto.Variable.html +++ /dev/null @@ -1,6 +0,0 @@ -Variable | @camunda8/sdk

    Interface Variable

    interface Variable {
        draft: DraftSearchVariableValue;
        id: string;
        name: string;
        tenantId: string;
        value: string;
    }

    Properties

    draft -id -name -tenantId -value -

    Properties

    draft

    draft: DraftSearchVariableValue

    id

    id: string

    name

    name: string

    tenantId

    tenantId: string

    value

    value: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Tasklist.TasklistDto.VariableInput.html b/docs/interfaces/index.Tasklist.TasklistDto.VariableInput.html deleted file mode 100644 index 9bd336dc..00000000 --- a/docs/interfaces/index.Tasklist.TasklistDto.VariableInput.html +++ /dev/null @@ -1,3 +0,0 @@ -VariableInput | @camunda8/sdk

    Interface VariableInput

    interface VariableInput {
        name: string;
        value: string;
    }

    Properties

    name -value -

    Properties

    name

    name: string

    value

    value: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Tasklist.TasklistDto.VariableSearchResponse.html b/docs/interfaces/index.Tasklist.TasklistDto.VariableSearchResponse.html deleted file mode 100644 index db86d5f4..00000000 --- a/docs/interfaces/index.Tasklist.TasklistDto.VariableSearchResponse.html +++ /dev/null @@ -1,6 +0,0 @@ -VariableSearchResponse | @camunda8/sdk

    Interface VariableSearchResponse

    interface VariableSearchResponse {
        draft: DraftSearchVariableValue;
        id: string;
        name: string;
        previewValue: string;
        value: string;
    }

    Hierarchy (view full)

    Properties

    draft -id -name -previewValue -value -

    Properties

    draft

    draft: DraftSearchVariableValue

    id

    id: string

    name

    name: string

    previewValue

    previewValue: string

    value

    value: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index.Tasklist.TasklistDto.VariableSearchResponseWithoutDraft.html b/docs/interfaces/index.Tasklist.TasklistDto.VariableSearchResponseWithoutDraft.html deleted file mode 100644 index bffc7e91..00000000 --- a/docs/interfaces/index.Tasklist.TasklistDto.VariableSearchResponseWithoutDraft.html +++ /dev/null @@ -1,5 +0,0 @@ -VariableSearchResponseWithoutDraft | @camunda8/sdk

    Interface VariableSearchResponseWithoutDraft

    interface VariableSearchResponseWithoutDraft {
        id: string;
        name: string;
        previewValue: string;
        value: string;
    }

    Hierarchy (view full)

    Properties

    id -name -previewValue -value -

    Properties

    id

    id: string

    name

    name: string

    previewValue

    previewValue: string

    value

    value: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index._internal_.Characteristics.html b/docs/interfaces/index._internal_.Characteristics.html deleted file mode 100644 index c917eefa..00000000 --- a/docs/interfaces/index._internal_.Characteristics.html +++ /dev/null @@ -1,3 +0,0 @@ -Characteristics | @camunda8/sdk

    Interface Characteristics

    interface Characteristics {
        _tag: GrpcConnectionProfile;
        startupTime: number;
    }

    Properties

    _tag -startupTime -

    Properties

    _tag

    _tag: GrpcConnectionProfile

    startupTime

    startupTime: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index._internal_.Emitter.html b/docs/interfaces/index._internal_.Emitter.html deleted file mode 100644 index 4efa662a..00000000 --- a/docs/interfaces/index._internal_.Emitter.html +++ /dev/null @@ -1,4 +0,0 @@ -Emitter | @camunda8/sdk

    Interface Emitter<T>

    interface Emitter<T> {
        emit<K>(eventName, params?): void;
        off<K>(eventName, fn): void;
        on<K>(eventName, fn): void;
    }

    Type Parameters

    Implemented by

    Methods

    emit -off -on -

    Methods

    emit

    off

    on

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index._internal_.IncludeVariable.html b/docs/interfaces/index._internal_.IncludeVariable.html deleted file mode 100644 index c6f0b9ed..00000000 --- a/docs/interfaces/index._internal_.IncludeVariable.html +++ /dev/null @@ -1,3 +0,0 @@ -IncludeVariable | @camunda8/sdk

    Interface IncludeVariable

    interface IncludeVariable {
        alwaysReturnFullValue?: boolean;
        name: string;
    }

    Properties

    alwaysReturnFullValue? -name -

    Properties

    Optional alwaysReturnFullValue

    alwaysReturnFullValue?: boolean

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index._internal_.JSONDoc.html b/docs/interfaces/index._internal_.JSONDoc.html deleted file mode 100644 index b360b76c..00000000 --- a/docs/interfaces/index._internal_.JSONDoc.html +++ /dev/null @@ -1 +0,0 @@ -JSONDoc | @camunda8/sdk

    Interface JSONDoc

    interface JSONDoc {
        [key: string]: JSON;
    }

    Indexable

    [key: string]: JSON

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index._internal_.Logger.html b/docs/interfaces/index._internal_.Logger.html deleted file mode 100644 index 4cfeb326..00000000 --- a/docs/interfaces/index._internal_.Logger.html +++ /dev/null @@ -1,4 +0,0 @@ -Logger | @camunda8/sdk

    Interface Logger

    interface Logger {
        debug: LogFn;
        error: LogFn;
        info: LogFn;
    }

    Properties

    debug -error -info -

    Properties

    debug

    debug: LogFn

    error

    error: LogFn

    info

    info: LogFn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index._internal_.TaskOrderBy.html b/docs/interfaces/index._internal_.TaskOrderBy.html deleted file mode 100644 index 959a425e..00000000 --- a/docs/interfaces/index._internal_.TaskOrderBy.html +++ /dev/null @@ -1,3 +0,0 @@ -TaskOrderBy | @camunda8/sdk

    Interface TaskOrderBy

    interface TaskOrderBy {
        field: "completionTime" | "creationTime" | "followUpDate" | "dueDate";
        order: "ASC" | "DESC";
    }

    Properties

    field -order -

    Properties

    field

    field: "completionTime" | "creationTime" | "followUpDate" | "dueDate"

    order

    order: "ASC" | "DESC"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/index._internal_.ZBWorkerConstructorConfig.html b/docs/interfaces/index._internal_.ZBWorkerConstructorConfig.html deleted file mode 100644 index 702e6c7c..00000000 --- a/docs/interfaces/index._internal_.ZBWorkerConstructorConfig.html +++ /dev/null @@ -1,11 +0,0 @@ -ZBWorkerConstructorConfig | @camunda8/sdk

    Interface ZBWorkerConstructorConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

    interface ZBWorkerConstructorConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> {
        customHeadersDto?: (new (...args) => Readonly<CustomHeaderShape>);
        grpcClient: ZBGrpc;
        id: null | string;
        idColor: Chalk;
        inputVariableDto?: (new (...args) => Readonly<WorkerInputVariables>);
        log: StatefulLogInterceptor;
        options: ZBWorkerOptions<WorkerInputVariables> & ZBClientOptions;
        taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>;
        taskType: string;
        zbClient: ZeebeGrpcClient;
    }

    Type Parameters

    • WorkerInputVariables
    • CustomHeaderShape
    • WorkerOutputVariables

    Properties

    customHeadersDto? -grpcClient -id -idColor -inputVariableDto? -log -options -taskHandler -taskType -zbClient -

    Properties

    Optional customHeadersDto

    customHeadersDto?: (new (...args) => Readonly<CustomHeaderShape>)

    Type declaration

    grpcClient

    grpcClient: ZBGrpc

    id

    id: null | string

    idColor

    idColor: Chalk

    Optional inputVariableDto

    inputVariableDto?: (new (...args) => Readonly<WorkerInputVariables>)

    Type declaration

    log

    log: StatefulLogInterceptor

    options

    options: ZBWorkerOptions<WorkerInputVariables> & ZBClientOptions

    taskHandler

    taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

    taskType

    taskType: string

    zbClient

    zbClient: ZeebeGrpcClient

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ActivateInstruction.html b/docs/interfaces/zeebe_types.ActivateInstruction.html deleted file mode 100644 index 1a2e0449..00000000 --- a/docs/interfaces/zeebe_types.ActivateInstruction.html +++ /dev/null @@ -1,9 +0,0 @@ -ActivateInstruction | @camunda8/sdk

    Interface ActivateInstruction

    interface ActivateInstruction {
        ancestorElementInstanceKey: string;
        elementId: string;
        variableInstructions: VariableInstruction[];
    }

    Properties

    ancestorElementInstanceKey -elementId -variableInstructions -

    Properties

    ancestorElementInstanceKey

    ancestorElementInstanceKey: string

    the key of the ancestor scope the element instance should be created in; -set to -1 to create the new element instance within an existing element -instance of the flow scope

    -

    elementId

    elementId: string

    the id of the element that should be activated

    -

    variableInstructions

    variableInstructions: VariableInstruction[]

    instructions describing which variables should be created

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ActivateJobsRequest.html b/docs/interfaces/zeebe_types.ActivateJobsRequest.html deleted file mode 100644 index a929ad52..00000000 --- a/docs/interfaces/zeebe_types.ActivateJobsRequest.html +++ /dev/null @@ -1,23 +0,0 @@ -ActivateJobsRequest | @camunda8/sdk

    Interface ActivateJobsRequest

    Request object to send the broker to request jobs for the worker.

    -
    interface ActivateJobsRequest {
        fetchVariable?: string[];
        maxJobsToActivate: number;
        requestTimeout: MaybeTimeDuration;
        tenantIds?: string[];
        timeout: MaybeTimeDuration;
        type: string;
        worker: string;
    }

    Properties

    fetchVariable? -maxJobsToActivate -requestTimeout -tenantIds? -timeout -type -worker -

    Properties

    Optional fetchVariable

    fetchVariable?: string[]

    A list of variables to fetch as the job variables; if empty, all visible variables at -the time of activation for the scope of the job will be returned

    -

    maxJobsToActivate

    maxJobsToActivate: number

    The maximum jobs to activate by this request

    -

    requestTimeout

    requestTimeout: MaybeTimeDuration

    The request will be completed when atleast one job is activated or after the requestTimeout. -if the requestTimeout = 0, the request will be completed after a default configured timeout in the broker. -To immediately complete the request when no job is activated set the requestTimeout to a negative value

    -

    Optional tenantIds

    tenantIds?: string[]

    a list of IDs of tenants for which to activate jobs

    -

    timeout

    timeout: MaybeTimeDuration

    The duration the broker allows for jobs activated by this call to complete -before timing them out releasing them for retry on the broker. -The broker checks time outs every 30 seconds, so the broker timeout is guaranteed in at-most timeout + 29s -be guaranteed.

    -

    type

    type: string

    The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition -type="payment-service" />)

    -

    worker

    worker: string

    The name of the worker activating the jobs, mostly used for logging purposes

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ActivateJobsResponse.html b/docs/interfaces/zeebe_types.ActivateJobsResponse.html deleted file mode 100644 index e018f913..00000000 --- a/docs/interfaces/zeebe_types.ActivateJobsResponse.html +++ /dev/null @@ -1,2 +0,0 @@ -ActivateJobsResponse | @camunda8/sdk

    Interface ActivateJobsResponse

    interface ActivateJobsResponse {
        jobs: ActivatedJob[];
    }

    Properties

    jobs -

    Properties

    jobs

    jobs: ActivatedJob[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ActivatedJob.html b/docs/interfaces/zeebe_types.ActivatedJob.html deleted file mode 100644 index 9f9858cf..00000000 --- a/docs/interfaces/zeebe_types.ActivatedJob.html +++ /dev/null @@ -1,32 +0,0 @@ -ActivatedJob | @camunda8/sdk

    Interface ActivatedJob

    interface ActivatedJob {
        bpmnProcessId: string;
        customHeaders: string;
        deadline: string;
        elementId: string;
        elementInstanceKey: string;
        key: string;
        processDefinitionKey: string;
        processDefinitionVersion: number;
        processInstanceKey: string;
        retries: number;
        tenantId: string;
        type: string;
        variables: string;
        worker: string;
    }

    Properties

    bpmnProcessId -customHeaders -deadline -elementId -elementInstanceKey -key -processDefinitionKey -processDefinitionVersion -processInstanceKey -retries -tenantId -type -variables -worker -

    Properties

    Readonly bpmnProcessId

    bpmnProcessId: string

    The bpmn process ID of the job process definition

    -

    Readonly customHeaders

    customHeaders: string

    A set of custom headers defined during modelling

    -

    Readonly deadline

    deadline: string

    When the job will timeout on the broker if it is not completed by this worker. -In epoch milliseconds

    -

    Readonly elementId

    elementId: string

    The associated task element ID

    -

    Readonly elementInstanceKey

    elementInstanceKey: string

    The unique key identifying the associated task, unique within the scope of the -process instance

    -

    Readonly key

    key: string

    The key, a unique identifier for the job

    -

    Readonly processDefinitionKey

    processDefinitionKey: string

    The key of the job process definition

    -

    Readonly processDefinitionVersion

    processDefinitionVersion: number

    The version of the job process definition

    -

    Readonly processInstanceKey

    processInstanceKey: string

    The job's process instance key

    -

    Readonly retries

    retries: number

    Readonly tenantId

    tenantId: string

    the id of the tenant that owns the job

    -

    Readonly type

    type: string

    The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition -type="payment-service" />)

    -

    Readonly variables

    variables: string

    All visible variables in the task scope, computed at activation time, constrained by any -fetchVariables value in the ActivateJobRequest.

    -

    Readonly worker

    worker: string

    The name of the worker that activated this job

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.BroadcastSignalReq.html b/docs/interfaces/zeebe_types.BroadcastSignalReq.html deleted file mode 100644 index 9f66c50e..00000000 --- a/docs/interfaces/zeebe_types.BroadcastSignalReq.html +++ /dev/null @@ -1,4 +0,0 @@ -BroadcastSignalReq | @camunda8/sdk

    Interface BroadcastSignalReq

    interface BroadcastSignalReq {
        signalName: string;
        tenantId?: string;
        variables?: JSONDoc;
    }

    Properties

    signalName -tenantId? -variables? -

    Properties

    signalName

    signalName: string

    Optional tenantId

    tenantId?: string

    Optional variables

    variables?: JSONDoc

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.BroadcastSignalRequest.html b/docs/interfaces/zeebe_types.BroadcastSignalRequest.html deleted file mode 100644 index 27ba76e6..00000000 --- a/docs/interfaces/zeebe_types.BroadcastSignalRequest.html +++ /dev/null @@ -1,8 +0,0 @@ -BroadcastSignalRequest | @camunda8/sdk

    Interface BroadcastSignalRequest

    interface BroadcastSignalRequest {
        signalName: string;
        tenantId?: string;
        variables: string;
    }

    Properties

    signalName -tenantId? -variables -

    Properties

    signalName

    signalName: string

    The name of the signal

    -

    Optional tenantId

    tenantId?: string

    the id of the tenant that owns the signal.

    -

    variables

    variables: string

    the signal variables as a JSON document; to be valid, the root of the document must be an -object, e.g. { "a": "foo" }. [ "foo" ] would not be valid.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.BroadcastSignalRes.html b/docs/interfaces/zeebe_types.BroadcastSignalRes.html deleted file mode 100644 index 6acc9df7..00000000 --- a/docs/interfaces/zeebe_types.BroadcastSignalRes.html +++ /dev/null @@ -1,2 +0,0 @@ -BroadcastSignalRes | @camunda8/sdk

    Interface BroadcastSignalRes

    interface BroadcastSignalRes {
        key: string;
    }

    Properties

    key -

    Properties

    key

    key: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.BroadcastSignalResponse.html b/docs/interfaces/zeebe_types.BroadcastSignalResponse.html deleted file mode 100644 index 9b441fc8..00000000 --- a/docs/interfaces/zeebe_types.BroadcastSignalResponse.html +++ /dev/null @@ -1,3 +0,0 @@ -BroadcastSignalResponse | @camunda8/sdk

    Interface BroadcastSignalResponse

    interface BroadcastSignalResponse {
        key: string;
    }

    Properties

    key -

    Properties

    key

    key: string

    the unique ID of the signal that was broadcasted.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.BrokerInfo.html b/docs/interfaces/zeebe_types.BrokerInfo.html deleted file mode 100644 index ab4c7556..00000000 --- a/docs/interfaces/zeebe_types.BrokerInfo.html +++ /dev/null @@ -1,5 +0,0 @@ -BrokerInfo | @camunda8/sdk

    Interface BrokerInfo

    interface BrokerInfo {
        host: string;
        nodeId: number;
        partitions: Partition[];
        port: number;
    }

    Properties

    host -nodeId -partitions -port -

    Properties

    host

    host: string

    nodeId

    nodeId: number

    partitions

    partitions: Partition[]

    port

    port: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.CamundaCloudConfig.html b/docs/interfaces/zeebe_types.CamundaCloudConfig.html deleted file mode 100644 index fb8b1128..00000000 --- a/docs/interfaces/zeebe_types.CamundaCloudConfig.html +++ /dev/null @@ -1,9 +0,0 @@ -CamundaCloudConfig | @camunda8/sdk

    Interface CamundaCloudConfig

    interface CamundaCloudConfig {
        cacheDir?: string;
        cacheOnDisk?: boolean;
        clientId: string;
        clientSecret: string;
        clusterId: string;
        clusterRegion?: string;
    }

    Properties

    cacheDir? -cacheOnDisk? -clientId -clientSecret -clusterId -clusterRegion? -

    Properties

    Optional cacheDir

    cacheDir?: string

    Optional cacheOnDisk

    cacheOnDisk?: boolean

    clientId

    clientId: string

    Just the UUID of the cluster

    -

    clientSecret

    clientSecret: string

    clusterId

    clusterId: string

    Optional clusterRegion

    clusterRegion?: string

    Defaults to bru-2

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.CompleteJobRequest.html b/docs/interfaces/zeebe_types.CompleteJobRequest.html deleted file mode 100644 index 50bc3520..00000000 --- a/docs/interfaces/zeebe_types.CompleteJobRequest.html +++ /dev/null @@ -1,3 +0,0 @@ -CompleteJobRequest | @camunda8/sdk

    Interface CompleteJobRequest<Variables>

    interface CompleteJobRequest<Variables> {
        jobKey: string;
        variables: Variables;
    }

    Type Parameters

    Properties

    jobKey -variables -

    Properties

    Readonly jobKey

    jobKey: string

    variables

    variables: Variables

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.CreateProcessBaseRequest.html b/docs/interfaces/zeebe_types.CreateProcessBaseRequest.html deleted file mode 100644 index 992ce8b8..00000000 --- a/docs/interfaces/zeebe_types.CreateProcessBaseRequest.html +++ /dev/null @@ -1,10 +0,0 @@ -CreateProcessBaseRequest | @camunda8/sdk

    Interface CreateProcessBaseRequest<V>

    interface CreateProcessBaseRequest<V> {
        bpmnProcessId: string;
        tenantId?: string;
        variables: V;
        version?: number;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    bpmnProcessId -tenantId? -variables -version? -

    Properties

    bpmnProcessId

    bpmnProcessId: string

    the BPMN process ID of the process definition

    -

    Optional tenantId

    tenantId?: string

    The tenantId for a multi-tenant enabled cluster.

    -

    variables

    variables: V

    JSON document that will instantiate the variables for the root variable scope of the -process instance.

    -

    Optional version

    version?: number

    the version of the process; if not specified it will use the latest version

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.CreateProcessInstanceBaseRequest.html b/docs/interfaces/zeebe_types.CreateProcessInstanceBaseRequest.html deleted file mode 100644 index 7d362af2..00000000 --- a/docs/interfaces/zeebe_types.CreateProcessInstanceBaseRequest.html +++ /dev/null @@ -1,10 +0,0 @@ -CreateProcessInstanceBaseRequest | @camunda8/sdk

    Interface CreateProcessInstanceBaseRequest

    interface CreateProcessInstanceBaseRequest {
        bpmnProcessId: string;
        tenantId?: string;
        variables: string;
        version?: number;
    }

    Hierarchy (view full)

    Properties

    bpmnProcessId -tenantId? -variables -version? -

    Properties

    bpmnProcessId

    bpmnProcessId: string

    the BPMN process ID of the process definition

    -

    Optional tenantId

    tenantId?: string

    the tenant id of the process definition

    -

    variables

    variables: string

    JSON document that will instantiate the variables for the root variable scope of the -process instance.

    -

    Optional version

    version?: number

    the version of the process; if not specified it will use the latest version

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.CreateProcessInstanceReq.html b/docs/interfaces/zeebe_types.CreateProcessInstanceReq.html deleted file mode 100644 index 0b11922b..00000000 --- a/docs/interfaces/zeebe_types.CreateProcessInstanceReq.html +++ /dev/null @@ -1,14 +0,0 @@ -CreateProcessInstanceReq | @camunda8/sdk

    Interface CreateProcessInstanceReq<V>

    interface CreateProcessInstanceReq<V> {
        bpmnProcessId: string;
        startInstructions?: ProcessInstanceCreationStartInstruction[];
        tenantId?: string;
        variables: V;
        version?: number;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    bpmnProcessId -startInstructions? -tenantId? -variables -version? -

    Properties

    bpmnProcessId

    bpmnProcessId: string

    the BPMN process ID of the process definition

    -

    Optional startInstructions

    startInstructions?: ProcessInstanceCreationStartInstruction[]

    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

    -

    Optional tenantId

    tenantId?: string

    The tenantId for a multi-tenant enabled cluster.

    -

    variables

    variables: V

    JSON document that will instantiate the variables for the root variable scope of the -process instance.

    -

    Optional version

    version?: number

    the version of the process; if not specified it will use the latest version

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.CreateProcessInstanceRequest.html b/docs/interfaces/zeebe_types.CreateProcessInstanceRequest.html deleted file mode 100644 index 71890a26..00000000 --- a/docs/interfaces/zeebe_types.CreateProcessInstanceRequest.html +++ /dev/null @@ -1,14 +0,0 @@ -CreateProcessInstanceRequest | @camunda8/sdk

    Interface CreateProcessInstanceRequest

    interface CreateProcessInstanceRequest {
        bpmnProcessId: string;
        startInstructions: ProcessInstanceCreationStartInstruction[];
        tenantId?: string;
        variables: string;
        version?: number;
    }

    Hierarchy (view full)

    Properties

    bpmnProcessId -startInstructions -tenantId? -variables -version? -

    Properties

    bpmnProcessId

    bpmnProcessId: string

    the BPMN process ID of the process definition

    -

    startInstructions

    startInstructions: ProcessInstanceCreationStartInstruction[]

    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

    -

    Optional tenantId

    tenantId?: string

    the tenant id of the process definition

    -

    variables

    variables: string

    JSON document that will instantiate the variables for the root variable scope of the -process instance.

    -

    Optional version

    version?: number

    the version of the process; if not specified it will use the latest version

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.CreateProcessInstanceResponse.html b/docs/interfaces/zeebe_types.CreateProcessInstanceResponse.html deleted file mode 100644 index dd021673..00000000 --- a/docs/interfaces/zeebe_types.CreateProcessInstanceResponse.html +++ /dev/null @@ -1,15 +0,0 @@ -CreateProcessInstanceResponse | @camunda8/sdk

    Interface CreateProcessInstanceResponse

    interface CreateProcessInstanceResponse {
        bpmnProcessId: string;
        processDefinitionKey: string;
        processInstanceKey: string;
        tenantId: string;
        version: number;
    }

    Properties

    bpmnProcessId -processDefinitionKey -processInstanceKey -tenantId -version -

    Properties

    Readonly bpmnProcessId

    bpmnProcessId: string

    The BPMN process ID of the process definition

    -

    Readonly processDefinitionKey

    processDefinitionKey: string

    The unique key identifying the process definition (e.g. returned from a process -in the DeployResourceResponse message)

    -

    Readonly processInstanceKey

    processInstanceKey: string

    Stringified JSON document that will instantiate the variables for the root variable scope of the -process instance; it must be a JSON object, as variables will be mapped in a -key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and -"b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
    valid argument, as the root of the JSON document is an array and not an object.

    -

    Readonly tenantId

    tenantId: string

    the tenant identifier of the created process instance

    -

    Readonly version

    version: number

    The version of the process; set to -1 to use the latest version

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.CreateProcessInstanceWithResultReq.html b/docs/interfaces/zeebe_types.CreateProcessInstanceWithResultReq.html deleted file mode 100644 index 147c13a2..00000000 --- a/docs/interfaces/zeebe_types.CreateProcessInstanceWithResultReq.html +++ /dev/null @@ -1,16 +0,0 @@ -CreateProcessInstanceWithResultReq | @camunda8/sdk

    Interface CreateProcessInstanceWithResultReq<T>

    interface CreateProcessInstanceWithResultReq<T> {
        bpmnProcessId: string;
        fetchVariables?: string[];
        requestTimeout?: number;
        tenantId?: string;
        variables: T;
        version?: number;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    bpmnProcessId -fetchVariables? -requestTimeout? -tenantId? -variables -version? -

    Properties

    bpmnProcessId

    bpmnProcessId: string

    the BPMN process ID of the process definition

    -

    Optional fetchVariables

    fetchVariables?: string[]

    list of names of variables to be included in CreateProcessInstanceWithResultResponse.variables. -If empty, all visible variables in the root scope will be returned.

    -

    Optional requestTimeout

    requestTimeout?: number

    timeout in milliseconds. the request will be closed if the process is not completed before the requestTimeout. -if requestTimeout = 0, uses the generic requestTimeout configured in the gateway.

    -

    Optional tenantId

    tenantId?: string

    The tenantId for a multi-tenant enabled cluster.

    -

    variables

    variables: T

    JSON document that will instantiate the variables for the root variable scope of the -process instance.

    -

    Optional version

    version?: number

    the version of the process; if not specified it will use the latest version

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.CreateProcessInstanceWithResultRequest.html b/docs/interfaces/zeebe_types.CreateProcessInstanceWithResultRequest.html deleted file mode 100644 index 6aa638ee..00000000 --- a/docs/interfaces/zeebe_types.CreateProcessInstanceWithResultRequest.html +++ /dev/null @@ -1,8 +0,0 @@ -CreateProcessInstanceWithResultRequest | @camunda8/sdk

    Interface CreateProcessInstanceWithResultRequest

    interface CreateProcessInstanceWithResultRequest {
        fetchVariables?: string[];
        request: CreateProcessInstanceBaseRequest;
        requestTimeout: number;
    }

    Properties

    fetchVariables? -request -requestTimeout -

    Properties

    Optional fetchVariables

    fetchVariables?: string[]

    list of names of variables to be included in CreateProcessInstanceWithResultResponse.variables. -If empty, all visible variables in the root scope will be returned.

    -

    request

    request: CreateProcessInstanceBaseRequest

    requestTimeout

    requestTimeout: number

    timeout in milliseconds. the request will be closed if the process is not completed before the requestTimeout. -if requestTimeout = 0, uses the generic requestTimeout configured in the gateway.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.CreateProcessInstanceWithResultResponse.html b/docs/interfaces/zeebe_types.CreateProcessInstanceWithResultResponse.html deleted file mode 100644 index e97815c8..00000000 --- a/docs/interfaces/zeebe_types.CreateProcessInstanceWithResultResponse.html +++ /dev/null @@ -1,15 +0,0 @@ -CreateProcessInstanceWithResultResponse | @camunda8/sdk

    Interface CreateProcessInstanceWithResultResponse<Result>

    interface CreateProcessInstanceWithResultResponse<Result> {
        bpmnProcessId: string;
        processDefinitionKey: string;
        processInstanceKey: string;
        tenantId: string;
        variables: Result;
        version: number;
    }

    Type Parameters

    • Result

    Hierarchy (view full)

    Properties

    bpmnProcessId -processDefinitionKey -processInstanceKey -tenantId -variables -version -

    Properties

    Readonly bpmnProcessId

    bpmnProcessId: string

    the BPMN process ID of the process definition which was used to create the process -instance

    -

    Readonly processDefinitionKey

    processDefinitionKey: string

    the key of the process definition which was used to create the process instance

    -

    Readonly processInstanceKey

    processInstanceKey: string

    the unique identifier of the created process instance; to be used wherever a request -needs a process instance key (e.g. CancelProcessInstanceRequest)

    -

    Readonly tenantId

    tenantId: string

    the tenant identifier of the process definition

    -

    Readonly variables

    variables: Result

    consisting of all visible variables to the root scope

    -

    Readonly version

    version: number

    the version of the process definition which was used to create the process instance

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.CreateProcessInstanceWithResultResponseOnWire.html b/docs/interfaces/zeebe_types.CreateProcessInstanceWithResultResponseOnWire.html deleted file mode 100644 index d5d794d0..00000000 --- a/docs/interfaces/zeebe_types.CreateProcessInstanceWithResultResponseOnWire.html +++ /dev/null @@ -1,15 +0,0 @@ -CreateProcessInstanceWithResultResponseOnWire | @camunda8/sdk

    Interface CreateProcessInstanceWithResultResponseOnWire

    interface CreateProcessInstanceWithResultResponseOnWire {
        bpmnProcessId: string;
        processDefinitionKey: string;
        processInstanceKey: string;
        tenantId: string;
        variables: string;
        version: number;
    }

    Hierarchy (view full)

    Properties

    bpmnProcessId -processDefinitionKey -processInstanceKey -tenantId -variables -version -

    Properties

    Readonly bpmnProcessId

    bpmnProcessId: string

    the BPMN process ID of the process definition which was used to create the process -instance

    -

    Readonly processDefinitionKey

    processDefinitionKey: string

    the key of the process definition which was used to create the process instance

    -

    Readonly processInstanceKey

    processInstanceKey: string

    the unique identifier of the created process instance; to be used wherever a request -needs a process instance key (e.g. CancelProcessInstanceRequest)

    -

    Readonly tenantId

    tenantId: string

    the tenant identifier of the process definition

    -

    Readonly variables

    variables: string

    consisting of all visible variables to the root scope

    -

    Readonly version

    version: number

    the version of the process definition which was used to create the process instance

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.DecisionDeployment.html b/docs/interfaces/zeebe_types.DecisionDeployment.html deleted file mode 100644 index b83cdd08..00000000 --- a/docs/interfaces/zeebe_types.DecisionDeployment.html +++ /dev/null @@ -1,2 +0,0 @@ -DecisionDeployment | @camunda8/sdk

    Interface DecisionDeployment

    interface DecisionDeployment {
        decision: DecisionMetadata;
    }

    Properties

    decision -

    Properties

    decision

    decision: DecisionMetadata

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.DecisionMetadata.html b/docs/interfaces/zeebe_types.DecisionMetadata.html deleted file mode 100644 index 186b7017..00000000 --- a/docs/interfaces/zeebe_types.DecisionMetadata.html +++ /dev/null @@ -1,19 +0,0 @@ -DecisionMetadata | @camunda8/sdk

    Interface DecisionMetadata

    interface DecisionMetadata {
        decisionKey: number;
        decisionRequirementsKey: number;
        dmnDecisionId: string;
        dmnDecisionName: string;
        dmnDecisionRequirementsId: string;
        tenantId: string;
        version: number;
    }

    Properties

    decisionKey -decisionRequirementsKey -dmnDecisionId -dmnDecisionName -dmnDecisionRequirementsId -tenantId -version -

    Properties

    decisionKey

    decisionKey: number

    the assigned decision key, which acts as a unique identifier for this -decision

    -

    decisionRequirementsKey

    decisionRequirementsKey: number

    the assigned key of the decision requirements graph that this decision is -part of

    -

    dmnDecisionId

    dmnDecisionId: string

    the dmn decision ID, as parsed during deployment; together with the -versions forms a unique identifier for a specific decision

    -

    dmnDecisionName

    dmnDecisionName: string

    the dmn name of the decision, as parsed during deployment

    -

    dmnDecisionRequirementsId

    dmnDecisionRequirementsId: string

    the dmn ID of the decision requirements graph that this decision is part -of, as parsed during deployment

    -

    tenantId

    tenantId: string

    the tenant id of the deployed decision

    -

    version

    version: number

    the assigned decision version

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.DecisionRequirementsDeployment.html b/docs/interfaces/zeebe_types.DecisionRequirementsDeployment.html deleted file mode 100644 index 22334fd1..00000000 --- a/docs/interfaces/zeebe_types.DecisionRequirementsDeployment.html +++ /dev/null @@ -1,2 +0,0 @@ -DecisionRequirementsDeployment | @camunda8/sdk

    Interface DecisionRequirementsDeployment

    interface DecisionRequirementsDeployment {
        decisionRequirements: DecisionRequirementsMetadata;
    }

    Properties

    decisionRequirements -

    Properties

    decisionRequirements

    decisionRequirements: DecisionRequirementsMetadata

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.DecisionRequirementsMetadata.html b/docs/interfaces/zeebe_types.DecisionRequirementsMetadata.html deleted file mode 100644 index a2542efd..00000000 --- a/docs/interfaces/zeebe_types.DecisionRequirementsMetadata.html +++ /dev/null @@ -1,16 +0,0 @@ -DecisionRequirementsMetadata | @camunda8/sdk

    Interface DecisionRequirementsMetadata

    interface DecisionRequirementsMetadata {
        decisionRequirementsKey: number;
        dmnDecisionRequirementsId: string;
        dmnDecisionRequirementsName: string;
        resourceName: string;
        tenantId: string;
        version: number;
    }

    Properties

    decisionRequirementsKey -dmnDecisionRequirementsId -dmnDecisionRequirementsName -resourceName -tenantId -version -

    Properties

    decisionRequirementsKey

    decisionRequirementsKey: number

    the assigned decision requirements key, which acts as a unique identifier -for this decision requirements

    -

    dmnDecisionRequirementsId

    dmnDecisionRequirementsId: string

    the dmn decision requirements ID, as parsed during deployment; together -with the versions forms a unique identifier for a specific decision

    -

    dmnDecisionRequirementsName

    dmnDecisionRequirementsName: string

    the dmn name of the decision requirements, as parsed during deployment

    -

    resourceName

    resourceName: string

    the resource name (see: Resource.name) from which this decision -requirements was parsed

    -

    tenantId

    tenantId: string

    the tenant id of the deployed decision requirements

    -

    version

    version: number

    the assigned decision requirements version

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.DeleteResourceRequest.html b/docs/interfaces/zeebe_types.DeleteResourceRequest.html deleted file mode 100644 index 24a4cbcf..00000000 --- a/docs/interfaces/zeebe_types.DeleteResourceRequest.html +++ /dev/null @@ -1,4 +0,0 @@ -DeleteResourceRequest | @camunda8/sdk

    Interface DeleteResourceRequest

    interface DeleteResourceRequest {
        resourceKey: string;
    }

    Properties

    resourceKey -

    Properties

    resourceKey

    resourceKey: string

    The key of the resource that should be deleted. This can either be the key -of a process definition, the key of a decision requirements definition or the key of a form.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.DeployResourceRequest.html b/docs/interfaces/zeebe_types.DeployResourceRequest.html deleted file mode 100644 index eaf991c9..00000000 --- a/docs/interfaces/zeebe_types.DeployResourceRequest.html +++ /dev/null @@ -1,5 +0,0 @@ -DeployResourceRequest | @camunda8/sdk

    Interface DeployResourceRequest

    interface DeployResourceRequest {
        resources: Resource[];
        tenantId?: string;
    }

    Properties

    resources -tenantId? -

    Properties

    resources

    resources: Resource[]

    list of resources to deploy

    -

    Optional tenantId

    tenantId?: string

    the tenant id of the resources to deploy

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.DeployResourceResponse.html b/docs/interfaces/zeebe_types.DeployResourceResponse.html deleted file mode 100644 index f9734c5a..00000000 --- a/docs/interfaces/zeebe_types.DeployResourceResponse.html +++ /dev/null @@ -1,7 +0,0 @@ -DeployResourceResponse | @camunda8/sdk

    Interface DeployResourceResponse<T>

    interface DeployResourceResponse<T> {
        deployments: T[];
        key: number;
        tenantId: string;
    }

    Type Parameters

    • T

    Properties

    deployments -key -tenantId -

    Properties

    Readonly deployments

    deployments: T[]

    a list of deployed resources, e.g. processes

    -

    Readonly key

    key: number

    the unique key identifying the deployment

    -

    tenantId

    tenantId: string

    the tenant id of the deployed resources

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ErrorJobWithVariables.html b/docs/interfaces/zeebe_types.ErrorJobWithVariables.html deleted file mode 100644 index 3e123adb..00000000 --- a/docs/interfaces/zeebe_types.ErrorJobWithVariables.html +++ /dev/null @@ -1,4 +0,0 @@ -ErrorJobWithVariables | @camunda8/sdk

    Interface ErrorJobWithVariables

    interface ErrorJobWithVariables {
        errorCode: string;
        errorMessage?: string;
        variables: JSONDoc;
    }

    Properties

    errorCode -errorMessage? -variables -

    Properties

    errorCode

    errorCode: string

    Optional errorMessage

    errorMessage?: string

    variables

    variables: JSONDoc

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.EvaluateDecisionResponse.html b/docs/interfaces/zeebe_types.EvaluateDecisionResponse.html deleted file mode 100644 index 34ef834b..00000000 --- a/docs/interfaces/zeebe_types.EvaluateDecisionResponse.html +++ /dev/null @@ -1,29 +0,0 @@ -EvaluateDecisionResponse | @camunda8/sdk

    Interface EvaluateDecisionResponse

    interface EvaluateDecisionResponse {
        decisionId: string;
        decisionKey: string;
        decisionName: string;
        decisionOutput: string;
        decisionRequirementsId: string;
        decisionRequirementsKey: string;
        decisionVersion: number;
        evaluatedDecisions: EvaluatedDecision[];
        failedDecisionId: string;
        failureMessage: string;
        tenantId?: string;
    }

    Properties

    decisionId -decisionKey -decisionName -decisionOutput -decisionRequirementsId -decisionRequirementsKey -decisionVersion -evaluatedDecisions -failedDecisionId -failureMessage -tenantId? -

    Properties

    decisionId

    decisionId: string

    the ID of the decision which was evaluated

    -

    decisionKey

    decisionKey: string

    the unique key identifying the decision which was evaluated (e.g. returned -from a decision in the DeployResourceResponse message)

    -

    decisionName

    decisionName: string

    the name of the decision which was evaluated

    -

    decisionOutput

    decisionOutput: string

    JSON document that will instantiate the result of the decision which was -evaluated; it will be a JSON object, as the result output will be mapped -in a key-value fashion, e.g. { "a": 1 }.

    -

    decisionRequirementsId

    decisionRequirementsId: string

    the ID of the decision requirements graph that the decision which was -evaluated is part of.

    -

    decisionRequirementsKey

    decisionRequirementsKey: string

    the unique key identifying the decision requirements graph that the -decision which was evaluated is part of.

    -

    decisionVersion

    decisionVersion: number

    the version of the decision which was evaluated

    -

    evaluatedDecisions

    evaluatedDecisions: EvaluatedDecision[]

    a list of decisions that were evaluated within the requested decision evaluation

    -

    failedDecisionId

    failedDecisionId: string

    an optional string indicating the ID of the decision which -failed during evaluation

    -

    failureMessage

    failureMessage: string

    an optional message describing why the decision which was evaluated failed

    -

    Optional tenantId

    tenantId?: string

    the tenant identifier of the decision

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.EvaluatedDecision.html b/docs/interfaces/zeebe_types.EvaluatedDecision.html deleted file mode 100644 index 42db0cec..00000000 --- a/docs/interfaces/zeebe_types.EvaluatedDecision.html +++ /dev/null @@ -1,22 +0,0 @@ -EvaluatedDecision | @camunda8/sdk

    Interface EvaluatedDecision

    interface EvaluatedDecision {
        decisionId: string;
        decisionKey: string;
        decisionName: string;
        decisionOutput: string;
        decisionType: string;
        decisionVersion: number;
        evaluatedInputs: EvaluatedDecisionInput[];
        matchedRules: MatchedDecisionRule[];
        tenantId: string;
    }

    Properties

    decisionId -decisionKey -decisionName -decisionOutput -decisionType -decisionVersion -evaluatedInputs -matchedRules -tenantId -

    Properties

    decisionId

    decisionId: string

    the ID of the decision which was evaluated

    -

    decisionKey

    decisionKey: string

    the unique key identifying the decision which was evaluated (e.g. returned -from a decision in the DeployResourceResponse message)

    -

    decisionName

    decisionName: string

    the name of the decision which was evaluated

    -

    decisionOutput

    decisionOutput: string

    JSON document that will instantiate the result of the decision which was -evaluated; it will be a JSON object, as the result output will be mapped -in a key-value fashion, e.g. { "a": 1 }.

    -

    decisionType

    decisionType: string

    the type of the decision which was evaluated

    -

    decisionVersion

    decisionVersion: number

    the version of the decision which was evaluated

    -

    evaluatedInputs

    evaluatedInputs: EvaluatedDecisionInput[]

    the decision inputs that were evaluated within this decision evaluation

    -

    matchedRules

    matchedRules: MatchedDecisionRule[]

    the decision rules that matched within this decision evaluation

    -

    tenantId

    tenantId: string

    the tenant identifier of the evaluated decision

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.EvaluatedDecisionInput.html b/docs/interfaces/zeebe_types.EvaluatedDecisionInput.html deleted file mode 100644 index 4c71f710..00000000 --- a/docs/interfaces/zeebe_types.EvaluatedDecisionInput.html +++ /dev/null @@ -1,7 +0,0 @@ -EvaluatedDecisionInput | @camunda8/sdk

    Interface EvaluatedDecisionInput

    interface EvaluatedDecisionInput {
        inputId: string;
        inputName: string;
        inputValue: string;
    }

    Properties

    inputId -inputName -inputValue -

    Properties

    inputId

    inputId: string

    the id of the evaluated decision input

    -

    inputName

    inputName: string

    the name of the evaluated decision input

    -

    inputValue

    inputValue: string

    the value of the evaluated decision input

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.EvaluatedDecisionOutput.html b/docs/interfaces/zeebe_types.EvaluatedDecisionOutput.html deleted file mode 100644 index 1fbcd090..00000000 --- a/docs/interfaces/zeebe_types.EvaluatedDecisionOutput.html +++ /dev/null @@ -1,7 +0,0 @@ -EvaluatedDecisionOutput | @camunda8/sdk

    Interface EvaluatedDecisionOutput

    interface EvaluatedDecisionOutput {
        outputId: string;
        outputName: string;
        outputValue: string;
    }

    Properties

    outputId -outputName -outputValue -

    Properties

    outputId

    outputId: string

    the id of the evaluated decision output

    -

    outputName

    outputName: string

    the name of the evaluated decision output

    -

    outputValue

    outputValue: string

    the value of the evaluated decision output

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.FailJobRequest.html b/docs/interfaces/zeebe_types.FailJobRequest.html deleted file mode 100644 index 470dfbce..00000000 --- a/docs/interfaces/zeebe_types.FailJobRequest.html +++ /dev/null @@ -1,5 +0,0 @@ -FailJobRequest | @camunda8/sdk

    Interface FailJobRequest

    interface FailJobRequest {
        errorMessage: string;
        jobKey: string;
        retries: number;
        retryBackOff: number;
    }

    Properties

    errorMessage -jobKey -retries -retryBackOff -

    Properties

    errorMessage

    errorMessage: string

    Readonly jobKey

    jobKey: string

    retries

    retries: number

    retryBackOff

    retryBackOff: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.FormDeployment.html b/docs/interfaces/zeebe_types.FormDeployment.html deleted file mode 100644 index 071541cb..00000000 --- a/docs/interfaces/zeebe_types.FormDeployment.html +++ /dev/null @@ -1,2 +0,0 @@ -FormDeployment | @camunda8/sdk

    Interface FormDeployment

    interface FormDeployment {
        form: FormMetadata;
    }

    Properties

    form -

    Properties

    form

    form: FormMetadata

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.FormMetadata.html b/docs/interfaces/zeebe_types.FormMetadata.html deleted file mode 100644 index 66930dc5..00000000 --- a/docs/interfaces/zeebe_types.FormMetadata.html +++ /dev/null @@ -1,12 +0,0 @@ -FormMetadata | @camunda8/sdk

    Interface FormMetadata

    interface FormMetadata {
        formId: string;
        formKey: number;
        resourceName: string;
        tenantId: string;
        version: number;
    }

    Properties

    formId -formKey -resourceName -tenantId -version -

    Properties

    Readonly formId

    formId: string

    the form ID, as parsed during deployment; together with the -versions forms a unique identifier for a specific form

    -

    Readonly formKey

    formKey: number

    the assigned key, which acts as a unique identifier for this form

    -

    Readonly resourceName

    resourceName: string

    the resource name

    -

    Readonly tenantId

    tenantId: string

    the tenant id of the deployed form

    -

    Readonly version

    version: number

    the assigned form version

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ICustomHeaders.html b/docs/interfaces/zeebe_types.ICustomHeaders.html deleted file mode 100644 index aa062689..00000000 --- a/docs/interfaces/zeebe_types.ICustomHeaders.html +++ /dev/null @@ -1 +0,0 @@ -ICustomHeaders | @camunda8/sdk

    Interface ICustomHeaders

    interface ICustomHeaders {
        [key: string]: string | number;
    }

    Indexable

    [key: string]: string | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.IInputVariables.html b/docs/interfaces/zeebe_types.IInputVariables.html deleted file mode 100644 index 7701910c..00000000 --- a/docs/interfaces/zeebe_types.IInputVariables.html +++ /dev/null @@ -1 +0,0 @@ -IInputVariables | @camunda8/sdk

    Interface IInputVariables

    interface IInputVariables {
        [key: string]: JSON;
    }

    Indexable

    [key: string]: JSON

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.IOutputVariables.html b/docs/interfaces/zeebe_types.IOutputVariables.html deleted file mode 100644 index 2f069905..00000000 --- a/docs/interfaces/zeebe_types.IOutputVariables.html +++ /dev/null @@ -1 +0,0 @@ -IOutputVariables | @camunda8/sdk

    Interface IOutputVariables

    interface IOutputVariables {
        [key: string]: JSON;
    }

    Indexable

    [key: string]: JSON

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.IProcessVariables.html b/docs/interfaces/zeebe_types.IProcessVariables.html deleted file mode 100644 index 7b37ad79..00000000 --- a/docs/interfaces/zeebe_types.IProcessVariables.html +++ /dev/null @@ -1 +0,0 @@ -IProcessVariables | @camunda8/sdk

    Interface IProcessVariables

    interface IProcessVariables {
        [key: string]: JSON;
    }

    Indexable

    [key: string]: JSON

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.JSONDoc.html b/docs/interfaces/zeebe_types.JSONDoc.html deleted file mode 100644 index 09bfd169..00000000 --- a/docs/interfaces/zeebe_types.JSONDoc.html +++ /dev/null @@ -1 +0,0 @@ -JSONDoc | @camunda8/sdk

    Interface JSONDoc

    interface JSONDoc {
        [key: string]: JSON | undefined;
    }

    Indexable

    [key: string]: JSON | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.Job.html b/docs/interfaces/zeebe_types.Job.html deleted file mode 100644 index 5a4196d8..00000000 --- a/docs/interfaces/zeebe_types.Job.html +++ /dev/null @@ -1,25 +0,0 @@ -Job | @camunda8/sdk

    Interface Job<Variables, CustomHeaderShape>

    interface Job<Variables, CustomHeaderShape> {
        bpmnProcessId: string;
        customHeaders: Readonly<CustomHeaderShape>;
        deadline: string;
        elementId: string;
        elementInstanceKey: string;
        key: string;
        processDefinitionVersion: number;
        processInstanceKey: string;
        retries: number;
        type: string;
        variables: Readonly<Variables>;
        worker: string;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    bpmnProcessId -customHeaders -deadline -elementId -elementInstanceKey -key -processDefinitionVersion -processInstanceKey -retries -type -variables -worker -

    Properties

    Readonly bpmnProcessId

    bpmnProcessId: string

    The bpmn process ID of the job process definition

    -

    Readonly customHeaders

    customHeaders: Readonly<CustomHeaderShape>

    A set of custom headers defined during modelling

    -

    Readonly deadline

    deadline: string

    Readonly elementId

    elementId: string

    The associated task element ID

    -

    Readonly elementInstanceKey

    elementInstanceKey: string

    The unique key identifying the associated task, unique within the scope of the -process instance

    -

    Readonly key

    key: string

    The key, a unique identifier for the job

    -

    Readonly processDefinitionVersion

    processDefinitionVersion: number

    The version of the job process definition

    -

    Readonly processInstanceKey

    processInstanceKey: string

    The job's process instance key

    -

    Readonly retries

    retries: number

    Readonly type

    type: string

    The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition -type="payment-service" />)

    -

    Readonly variables

    variables: Readonly<Variables>

    All visible variables in the task scope, computed at activation time.

    -

    Readonly worker

    worker: string

    The name of the worker that activated this job

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.JobCompletionInterface.html b/docs/interfaces/zeebe_types.JobCompletionInterface.html deleted file mode 100644 index d0722025..00000000 --- a/docs/interfaces/zeebe_types.JobCompletionInterface.html +++ /dev/null @@ -1,19 +0,0 @@ -JobCompletionInterface | @camunda8/sdk

    Interface JobCompletionInterface<WorkerOutputVariables>

    interface JobCompletionInterface<WorkerOutputVariables> {
        cancelWorkflow: (() => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">);
        complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">);
        error: ErrorJobOutcome;
        fail: {
            (errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
            (failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
        };
        forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT");
    }

    Type Parameters

    • WorkerOutputVariables

    Hierarchy (view full)

    Properties

    cancelWorkflow -complete -error -fail -forward -

    Properties

    cancelWorkflow

    cancelWorkflow: (() => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">)

    Cancel the workflow.

    -

    Type declaration

      • (): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

      • Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

    complete

    complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">)

    Complete the job with a success, optionally passing in a state update to merge -with the process variables on the broker.

    -

    Type declaration

      • (updatedVariables?): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

      • Parameters

        Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

    error

    error: ErrorJobOutcome

    Report a business error (i.e. non-technical) that occurs while processing a job. -The error is handled in the process by an error catch event. -If there is no error catch event with the specified errorCode then an incident will be raised instead.

    -

    fail

    fail: {
        (errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
        (failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
    }

    Fail the job with an informative message as to the cause. Optionally, pass in a -value remaining retries. If no value is passed for retries then the current retry -count is decremented. Pass in 0for retries to raise an incident in Operate. Optionally, -specify a retry backoff period in milliseconds. Default is 0ms (immediate retry) if not -specified.

    -

    Type declaration

    forward

    forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT")

    Mark this job as forwarded to another system for completion. No action is taken by the broker. -This method releases worker capacity to handle another job.

    -

    Type declaration

      • (): "JOB_ACTION_ACKNOWLEDGEMENT"

      • Returns "JOB_ACTION_ACKNOWLEDGEMENT"

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.JobFailureConfiguration.html b/docs/interfaces/zeebe_types.JobFailureConfiguration.html deleted file mode 100644 index c5d36bcf..00000000 --- a/docs/interfaces/zeebe_types.JobFailureConfiguration.html +++ /dev/null @@ -1,6 +0,0 @@ -JobFailureConfiguration | @camunda8/sdk

    Interface JobFailureConfiguration

    interface JobFailureConfiguration {
        errorMessage: string;
        retries?: number;
        retryBackOff?: number;
    }

    Properties

    errorMessage -retries? -retryBackOff? -

    Properties

    errorMessage

    errorMessage: string

    Optional retries

    retries?: number

    If not specified, the library will decrement the "current remaining retries" count by one

    -

    Optional retryBackOff

    retryBackOff?: number

    Optional backoff for subsequent retries, in milliseconds. If not specified, it is zero.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ListProcessResponse.html b/docs/interfaces/zeebe_types.ListProcessResponse.html deleted file mode 100644 index 62897c62..00000000 --- a/docs/interfaces/zeebe_types.ListProcessResponse.html +++ /dev/null @@ -1,2 +0,0 @@ -ListProcessResponse | @camunda8/sdk

    Interface ListProcessResponse

    interface ListProcessResponse {
        processes: ProcessMetadata[];
    }

    Properties

    processes -

    Properties

    Readonly processes

    processes: ProcessMetadata[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.MatchedDecisionRule.html b/docs/interfaces/zeebe_types.MatchedDecisionRule.html deleted file mode 100644 index 72181530..00000000 --- a/docs/interfaces/zeebe_types.MatchedDecisionRule.html +++ /dev/null @@ -1,7 +0,0 @@ -MatchedDecisionRule | @camunda8/sdk

    Interface MatchedDecisionRule

    interface MatchedDecisionRule {
        evaluatedOutputs: EvaluatedDecisionOutput[];
        ruleId: string;
        ruleIndex: number;
    }

    Properties

    evaluatedOutputs -ruleId -ruleIndex -

    Properties

    evaluatedOutputs

    evaluatedOutputs: EvaluatedDecisionOutput[]

    the evaluated decision outputs

    -

    ruleId

    ruleId: string

    the id of the matched rule

    -

    ruleIndex

    ruleIndex: number

    the index of the matched rule

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ModifyProcessInstanceRequest.html b/docs/interfaces/zeebe_types.ModifyProcessInstanceRequest.html deleted file mode 100644 index 060de6e8..00000000 --- a/docs/interfaces/zeebe_types.ModifyProcessInstanceRequest.html +++ /dev/null @@ -1,8 +0,0 @@ -ModifyProcessInstanceRequest | @camunda8/sdk

    Interface ModifyProcessInstanceRequest

    interface ModifyProcessInstanceRequest {
        activateInstructions?: ActivateInstruction[];
        processInstanceKey: string;
        terminateInstructions?: TerminateInstruction[];
    }

    Properties

    activateInstructions? -processInstanceKey -terminateInstructions? -

    Properties

    Optional activateInstructions

    activateInstructions?: ActivateInstruction[]

    instructions describing which elements should be activated in which scopes, -and which variables should be created

    -

    processInstanceKey

    processInstanceKey: string

    the key of the process instance that should be modified

    -

    Optional terminateInstructions

    terminateInstructions?: TerminateInstruction[]

    instructions describing which elements should be terminated

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.OAuthProviderConfig.html b/docs/interfaces/zeebe_types.OAuthProviderConfig.html deleted file mode 100644 index 7be747f1..00000000 --- a/docs/interfaces/zeebe_types.OAuthProviderConfig.html +++ /dev/null @@ -1,13 +0,0 @@ -OAuthProviderConfig | @camunda8/sdk

    Interface OAuthProviderConfig

    interface OAuthProviderConfig {
        audience: string;
        authServerUrl: string;
        cacheDir?: string;
        cacheOnDisk?: boolean;
        clientId: string;
        clientSecret: string;
        customRootCert?: Buffer;
    }

    Properties

    audience -authServerUrl -cacheDir? -cacheOnDisk? -clientId -clientSecret -customRootCert? -

    Properties

    audience

    audience: string

    OAuth Audience

    -

    authServerUrl

    authServerUrl: string

    OAuth Endpoint URL

    -

    Optional cacheDir

    cacheDir?: string

    Override default token cache directory

    -

    Optional cacheOnDisk

    cacheOnDisk?: boolean

    Cache token in memory and on filesystem?

    -

    clientId

    clientId: string

    clientSecret

    clientSecret: string

    Optional customRootCert

    customRootCert?: Buffer

    Custom TLS certificate for OAuth

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.OperationOptionsNoRetry.html b/docs/interfaces/zeebe_types.OperationOptionsNoRetry.html deleted file mode 100644 index 2e95a200..00000000 --- a/docs/interfaces/zeebe_types.OperationOptionsNoRetry.html +++ /dev/null @@ -1,3 +0,0 @@ -OperationOptionsNoRetry | @camunda8/sdk

    Interface OperationOptionsNoRetry

    interface OperationOptionsNoRetry {
        retry: false;
        version?: number;
    }

    Properties

    retry -version? -

    Properties

    retry

    retry: false

    Optional version

    version?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.OperationOptionsWithRetry.html b/docs/interfaces/zeebe_types.OperationOptionsWithRetry.html deleted file mode 100644 index eed86886..00000000 --- a/docs/interfaces/zeebe_types.OperationOptionsWithRetry.html +++ /dev/null @@ -1,4 +0,0 @@ -OperationOptionsWithRetry | @camunda8/sdk

    Interface OperationOptionsWithRetry

    interface OperationOptionsWithRetry {
        maxRetries: number;
        retry: true;
        version?: number;
    }

    Properties

    maxRetries -retry -version? -

    Properties

    maxRetries

    maxRetries: number

    retry

    retry: true

    Optional version

    version?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.Partition.html b/docs/interfaces/zeebe_types.Partition.html deleted file mode 100644 index dae71f0a..00000000 --- a/docs/interfaces/zeebe_types.Partition.html +++ /dev/null @@ -1,6 +0,0 @@ -Partition | @camunda8/sdk

    Interface Partition

    interface Partition {
        health: PartitionBrokerHealth;
        partitionId: number;
        role: PartitionBrokerRole;
    }

    Properties

    health -partitionId -role -

    Properties

    health

    health: PartitionBrokerHealth

    the health of this partition

    -

    partitionId

    partitionId: number

    role

    role: PartitionBrokerRole

    the role of the broker for this partition

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ProcessDeployment.html b/docs/interfaces/zeebe_types.ProcessDeployment.html deleted file mode 100644 index c8377c79..00000000 --- a/docs/interfaces/zeebe_types.ProcessDeployment.html +++ /dev/null @@ -1,2 +0,0 @@ -ProcessDeployment | @camunda8/sdk

    Interface ProcessDeployment

    interface ProcessDeployment {
        process: ProcessMetadata;
    }

    Properties

    process -

    Properties

    process

    process: ProcessMetadata

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ProcessInstanceCreationStartInstruction.html b/docs/interfaces/zeebe_types.ProcessInstanceCreationStartInstruction.html deleted file mode 100644 index 9780f2d6..00000000 --- a/docs/interfaces/zeebe_types.ProcessInstanceCreationStartInstruction.html +++ /dev/null @@ -1,9 +0,0 @@ -ProcessInstanceCreationStartInstruction | @camunda8/sdk

    Interface ProcessInstanceCreationStartInstruction

    interface ProcessInstanceCreationStartInstruction {
        elementId: string;
    }

    Properties

    elementId -

    Properties

    elementId

    elementId: string

    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
      • -
    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ProcessMetadata.html b/docs/interfaces/zeebe_types.ProcessMetadata.html deleted file mode 100644 index 9bb14f74..00000000 --- a/docs/interfaces/zeebe_types.ProcessMetadata.html +++ /dev/null @@ -1,13 +0,0 @@ -ProcessMetadata | @camunda8/sdk

    Interface ProcessMetadata

    interface ProcessMetadata {
        bpmnProcessId: string;
        processDefinitionKey: string;
        resourceName: string;
        tenantId: string;
        version: number;
    }

    Properties

    bpmnProcessId -processDefinitionKey -resourceName -tenantId -version -

    Properties

    Readonly bpmnProcessId

    bpmnProcessId: string

    the bpmn process ID, as parsed during deployment; together with the version forms a -unique identifier for a specific process definition

    -

    Readonly processDefinitionKey

    processDefinitionKey: string

    the assigned key, which acts as a unique identifier for this process

    -

    Readonly resourceName

    resourceName: string

    the resource name (see: ProcessRequestObject.name) from which this process was -parsed

    -

    tenantId

    tenantId: string

    the tenant identifier of the deployed process

    -

    Readonly version

    version: number

    the assigned process version

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ProcessRequestObject.html b/docs/interfaces/zeebe_types.ProcessRequestObject.html deleted file mode 100644 index b410cff5..00000000 --- a/docs/interfaces/zeebe_types.ProcessRequestObject.html +++ /dev/null @@ -1,3 +0,0 @@ -ProcessRequestObject | @camunda8/sdk

    Interface ProcessRequestObject

    interface ProcessRequestObject {
        definition: Buffer;
        name?: string;
    }

    Properties

    definition -name? -

    Properties

    definition

    definition: Buffer

    Optional name

    name?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.PublishMessageRequest.html b/docs/interfaces/zeebe_types.PublishMessageRequest.html deleted file mode 100644 index 0d3aba44..00000000 --- a/docs/interfaces/zeebe_types.PublishMessageRequest.html +++ /dev/null @@ -1,12 +0,0 @@ -PublishMessageRequest | @camunda8/sdk

    Interface PublishMessageRequest<Variables>

    interface PublishMessageRequest<Variables> {
        correlationKey: string;
        messageId?: string;
        name: string;
        tenantId?: string;
        timeToLive?: MaybeTimeDuration;
        variables?: Variables;
    }

    Type Parameters

    Properties

    correlationKey -messageId? -name -tenantId? -timeToLive? -variables? -

    Properties

    correlationKey

    correlationKey: string

    The value to match with the field specified as "Subscription Correlation Key" in BPMN

    -

    Optional messageId

    messageId?: string

    Unique ID for this message

    -

    name

    name: string

    Should match the "Message Name" in a BPMN Message Catch

    -

    Optional tenantId

    tenantId?: string

    the tenantId of the message

    -

    Optional timeToLive

    timeToLive?: MaybeTimeDuration

    The number of seconds for the message to buffer on the broker, awaiting correlation. Omit or set to zero for no buffering.

    -

    Optional variables

    variables?: Variables

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.PublishMessageResponse.html b/docs/interfaces/zeebe_types.PublishMessageResponse.html deleted file mode 100644 index a2602480..00000000 --- a/docs/interfaces/zeebe_types.PublishMessageResponse.html +++ /dev/null @@ -1,5 +0,0 @@ -PublishMessageResponse | @camunda8/sdk

    Interface PublishMessageResponse

    interface PublishMessageResponse {
        key: number;
        tenantId: string;
    }

    Properties

    key -tenantId -

    Properties

    key

    key: number

    the unique ID of the message that was published

    -

    tenantId

    tenantId: string

    the tenantId of the message

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.PublishStartMessageRequest.html b/docs/interfaces/zeebe_types.PublishStartMessageRequest.html deleted file mode 100644 index 146c6671..00000000 --- a/docs/interfaces/zeebe_types.PublishStartMessageRequest.html +++ /dev/null @@ -1,12 +0,0 @@ -PublishStartMessageRequest | @camunda8/sdk

    Interface PublishStartMessageRequest<Variables>

    interface PublishStartMessageRequest<Variables> {
        correlationKey?: string;
        messageId?: string;
        name: string;
        tenantId?: string;
        timeToLive: MaybeTimeDuration;
        variables: Variables;
    }

    Type Parameters

    Properties

    correlationKey? -messageId? -name -tenantId? -timeToLive -variables -

    Properties

    Optional correlationKey

    correlationKey?: string

    Optional messageId

    messageId?: string

    Unique ID for this message

    -

    name

    name: string

    Should match the "Message Name" in a BPMN Message Catch

    -

    Optional tenantId

    tenantId?: string

    the tenantId for the message

    -

    timeToLive

    timeToLive: MaybeTimeDuration

    The number of seconds for the message to buffer on the broker, awaiting correlation. -Omit or set to zero for no buffering.

    -

    variables

    variables: Variables

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ResolveIncidentRequest.html b/docs/interfaces/zeebe_types.ResolveIncidentRequest.html deleted file mode 100644 index 25b4c8b4..00000000 --- a/docs/interfaces/zeebe_types.ResolveIncidentRequest.html +++ /dev/null @@ -1,2 +0,0 @@ -ResolveIncidentRequest | @camunda8/sdk

    Interface ResolveIncidentRequest

    interface ResolveIncidentRequest {
        incidentKey: string;
    }

    Properties

    incidentKey -

    Properties

    Readonly incidentKey

    incidentKey: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.Resource.html b/docs/interfaces/zeebe_types.Resource.html deleted file mode 100644 index c7862ff6..00000000 --- a/docs/interfaces/zeebe_types.Resource.html +++ /dev/null @@ -1,5 +0,0 @@ -Resource | @camunda8/sdk

    Interface Resource

    interface Resource {
        content: Buffer;
        name: string;
    }

    Properties

    content -name -

    Properties

    content

    content: Buffer

    the file content as a UTF8-encoded string

    -

    name

    name: string

    the resource name, e.g. myProcess.bpmn or myDecision.dmn

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.SetVariablesRequest.html b/docs/interfaces/zeebe_types.SetVariablesRequest.html deleted file mode 100644 index fc9bb13f..00000000 --- a/docs/interfaces/zeebe_types.SetVariablesRequest.html +++ /dev/null @@ -1,11 +0,0 @@ -SetVariablesRequest | @camunda8/sdk

    Interface SetVariablesRequest<Variables>

    interface SetVariablesRequest<Variables> {
        elementInstanceKey: string;
        local: boolean;
        variables: Partial<Variables>;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    elementInstanceKey -local -variables -

    Properties

    Readonly elementInstanceKey

    elementInstanceKey: string

    local

    local: boolean

    if true, the variables will be merged strictly into the local scope (as indicated by - elementInstanceKey); this means the variables is not propagated to upper scopes. - for example, let's say we have two scopes, '1' and '2', with each having effective variables as: -1 => { "foo" : 2 }, and 2 => { "bar" : 1 }. if we send an update request with -elementInstanceKey = 2, variables { "foo" : 5 }, and local is true, then scope 1 will -be unchanged, and scope 2 will now be { "bar" : 1, "foo" 5 }. if local was false, however, -then scope 1 would be { "foo": 5 }, and scope 2 would be { "bar" : 1 }.

    -

    variables

    variables: Partial<Variables>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.SetVariablesRequestOnTheWire.html b/docs/interfaces/zeebe_types.SetVariablesRequestOnTheWire.html deleted file mode 100644 index 251f5967..00000000 --- a/docs/interfaces/zeebe_types.SetVariablesRequestOnTheWire.html +++ /dev/null @@ -1,11 +0,0 @@ -SetVariablesRequestOnTheWire | @camunda8/sdk

    Interface SetVariablesRequestOnTheWire

    interface SetVariablesRequestOnTheWire {
        elementInstanceKey: string;
        local: boolean;
        variables: string;
    }

    Hierarchy (view full)

    Properties

    elementInstanceKey -local -variables -

    Properties

    Readonly elementInstanceKey

    elementInstanceKey: string

    local

    local: boolean

    if true, the variables will be merged strictly into the local scope (as indicated by - elementInstanceKey); this means the variables is not propagated to upper scopes. - for example, let's say we have two scopes, '1' and '2', with each having effective variables as: -1 => { "foo" : 2 }, and 2 => { "bar" : 1 }. if we send an update request with -elementInstanceKey = 2, variables { "foo" : 5 }, and local is true, then scope 1 will -be unchanged, and scope 2 will now be { "bar" : 1, "foo" 5 }. if local was false, however, -then scope 1 would be { "foo": 5 }, and scope 2 would be { "bar" : 1 }.

    -

    variables

    variables: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.StreamActivatedJobsRequest.html b/docs/interfaces/zeebe_types.StreamActivatedJobsRequest.html deleted file mode 100644 index e18f0ee1..00000000 --- a/docs/interfaces/zeebe_types.StreamActivatedJobsRequest.html +++ /dev/null @@ -1,13 +0,0 @@ -StreamActivatedJobsRequest | @camunda8/sdk

    Interface StreamActivatedJobsRequest

    interface StreamActivatedJobsRequest {
        fetchVariable: string[];
        tenantIds: string[];
        timeout: number;
        type: string;
        worker: string;
    }

    Properties

    fetchVariable -tenantIds -timeout -type -worker -

    Properties

    fetchVariable

    fetchVariable: string[]

    a list of variables to fetch as the job variables; if empty, all visible variables at -the time of activation for the scope of the job will be returned

    -

    tenantIds

    tenantIds: string[]

    a list of identifiers of tenants for which to stream jobs

    -

    timeout

    timeout: number

    a job returned after this call will not be activated by another call until the -timeout (in ms) has been reached

    -

    type

    type: string

    the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition type="payment-service" />)

    -

    worker

    worker: string

    the name of the worker activating the jobs, mostly used for logging purposes

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.TerminateInstruction.html b/docs/interfaces/zeebe_types.TerminateInstruction.html deleted file mode 100644 index 32fd25b9..00000000 --- a/docs/interfaces/zeebe_types.TerminateInstruction.html +++ /dev/null @@ -1,3 +0,0 @@ -TerminateInstruction | @camunda8/sdk

    Interface TerminateInstruction

    interface TerminateInstruction {
        elementInstanceKey: string;
    }

    Properties

    elementInstanceKey -

    Properties

    elementInstanceKey

    elementInstanceKey: string

    the id of the element that should be terminated

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ThrowErrorRequest.html b/docs/interfaces/zeebe_types.ThrowErrorRequest.html deleted file mode 100644 index cb7faeba..00000000 --- a/docs/interfaces/zeebe_types.ThrowErrorRequest.html +++ /dev/null @@ -1,13 +0,0 @@ -ThrowErrorRequest | @camunda8/sdk

    Interface ThrowErrorRequest

    interface ThrowErrorRequest {
        errorCode: string;
        errorMessage?: string;
        jobKey: string;
        variables?: JSONDoc;
    }

    Properties

    errorCode -errorMessage? -jobKey -variables? -

    Properties

    errorCode

    errorCode: string

    the error code that will be matched with an error catch event

    -

    Optional errorMessage

    errorMessage?: string

    an optional error message that provides additional context

    -

    jobKey

    jobKey: string

    the unique job identifier, as obtained when activating the job

    -

    Optional variables

    variables?: JSONDoc

    JSON document that will instantiate the variables at the local scope of the error catch -event that catches the thrown error; it must be a JSON object, as variables will be mapped in a -key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and -"b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a -valid argument, as the root of the JSON document is an array and not an object.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.TopologyResponse.html b/docs/interfaces/zeebe_types.TopologyResponse.html deleted file mode 100644 index 140ca24a..00000000 --- a/docs/interfaces/zeebe_types.TopologyResponse.html +++ /dev/null @@ -1,6 +0,0 @@ -TopologyResponse | @camunda8/sdk

    Interface TopologyResponse

    interface TopologyResponse {
        brokers: BrokerInfo[];
        clusterSize: number;
        gatewayVersion: string;
        partitionsCount: number;
        replicationFactor: number;
    }

    Properties

    brokers -clusterSize -gatewayVersion -partitionsCount -replicationFactor -

    Properties

    Readonly brokers

    brokers: BrokerInfo[]

    Readonly clusterSize

    clusterSize: number

    Readonly gatewayVersion

    gatewayVersion: string

    Readonly partitionsCount

    partitionsCount: number

    Readonly replicationFactor

    replicationFactor: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.UpdateJobRetriesRequest.html b/docs/interfaces/zeebe_types.UpdateJobRetriesRequest.html deleted file mode 100644 index b068f189..00000000 --- a/docs/interfaces/zeebe_types.UpdateJobRetriesRequest.html +++ /dev/null @@ -1,3 +0,0 @@ -UpdateJobRetriesRequest | @camunda8/sdk

    Interface UpdateJobRetriesRequest

    interface UpdateJobRetriesRequest {
        jobKey: string;
        retries: number;
    }

    Properties

    jobKey -retries -

    Properties

    Readonly jobKey

    jobKey: string

    retries

    retries: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.VariableInstruction.html b/docs/interfaces/zeebe_types.VariableInstruction.html deleted file mode 100644 index 504d35ae..00000000 --- a/docs/interfaces/zeebe_types.VariableInstruction.html +++ /dev/null @@ -1,10 +0,0 @@ -VariableInstruction | @camunda8/sdk

    Interface VariableInstruction

    interface VariableInstruction {
        scopeId: string;
        variables: JSONDoc;
    }

    Properties

    scopeId -variables -

    Properties

    scopeId

    scopeId: string

    the id of the element in which scope the variables should be created; -leave empty to create the variables in the global scope of the process instance

    -

    variables

    variables: JSONDoc

    JSON document that will instantiate the variables for the root variable scope of the -process instance; it must be a JSON object, as variables will be mapped in a -key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and -"b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a -valid argument, as the root of the JSON document is an array and not an object.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ZBClientOptions.html b/docs/interfaces/zeebe_types.ZBClientOptions.html deleted file mode 100644 index e19745a7..00000000 --- a/docs/interfaces/zeebe_types.ZBClientOptions.html +++ /dev/null @@ -1,20 +0,0 @@ -ZBClientOptions | @camunda8/sdk

    Interface ZBClientOptions

    interface ZBClientOptions {
        camundaCloud?: CamundaCloudConfig;
        connectionTolerance?: MaybeTimeDuration;
        customSSL?: CustomSSL;
        eagerConnection?: boolean;
        hostname?: string;
        logNamespace?: string;
        loglevel?: Loglevel;
        longPoll: MaybeTimeDuration;
        maxRetries?: number;
        maxRetryTimeout?: MaybeTimeDuration;
        oAuth?: OAuthProviderConfig;
        onConnectionError?: (() => void);
        onReady?: (() => void);
        pollInterval: MaybeTimeDuration;
        port?: string;
        retry?: boolean;
        stdout?: ZBCustomLogger;
        tenantId?: string;
        useTLS?: boolean;
    }

    Properties

    camundaCloud? -connectionTolerance? -customSSL? -eagerConnection? -hostname? -logNamespace? -loglevel? -longPoll -maxRetries? -maxRetryTimeout? -oAuth? -onConnectionError? -onReady? -pollInterval -port? -retry? -stdout? -tenantId? -useTLS? -

    Properties

    Optional camundaCloud

    camundaCloud?: CamundaCloudConfig

    Optional connectionTolerance

    connectionTolerance?: MaybeTimeDuration

    Optional customSSL

    customSSL?: CustomSSL

    Optional eagerConnection

    eagerConnection?: boolean

    Optional hostname

    hostname?: string

    Optional logNamespace

    logNamespace?: string

    Optional loglevel

    loglevel?: Loglevel

    longPoll

    longPoll: MaybeTimeDuration

    Optional maxRetries

    maxRetries?: number

    Optional maxRetryTimeout

    maxRetryTimeout?: MaybeTimeDuration

    Optional oAuth

    oAuth?: OAuthProviderConfig

    Optional onConnectionError

    onConnectionError?: (() => void)

    Type declaration

      • (): void

      • Returns void

    Optional onReady

    onReady?: (() => void)

    Type declaration

      • (): void

      • Returns void

    pollInterval

    pollInterval: MaybeTimeDuration

    Optional port

    port?: string

    Optional retry

    retry?: boolean

    Optional stdout

    stdout?: ZBCustomLogger

    Optional tenantId

    tenantId?: string

    Optional useTLS

    useTLS?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ZBCustomLogger.html b/docs/interfaces/zeebe_types.ZBCustomLogger.html deleted file mode 100644 index cef80c4c..00000000 --- a/docs/interfaces/zeebe_types.ZBCustomLogger.html +++ /dev/null @@ -1,7 +0,0 @@ -ZBCustomLogger | @camunda8/sdk

    Interface ZBCustomLogger

    interface ZBCustomLogger {
        debug: ((message) => void);
        error: ((message) => void);
        info: ((message) => void);
    }

    Properties

    debug -error -info -

    Properties

    debug

    debug: ((message) => void)

    Receives a JSON-stringified ZBLogMessage

    -

    Type declaration

      • (message): void

      • Parameters

        • message: string

        Returns void

    error

    error: ((message) => void)

    Receives a JSON-stringified ZBLogMessage

    -

    Type declaration

      • (message): void

      • Parameters

        • message: string

        Returns void

    info

    info: ((message) => void)

    Receives a JSON-stringified ZBLogMessage

    -

    Type declaration

      • (message): void

      • Parameters

        • message: string

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ZBGrpc.html b/docs/interfaces/zeebe_types.ZBGrpc.html deleted file mode 100644 index 53b6fcc7..00000000 --- a/docs/interfaces/zeebe_types.ZBGrpc.html +++ /dev/null @@ -1,26 +0,0 @@ -ZBGrpc | @camunda8/sdk

    Interface ZBGrpc

    interface ZBGrpc {
        activateJobsStream: ((req) => ClientReadableStream<unknown>);
        channelClosed: boolean;
        client: Client;
        completeJobSync: ((req) => Promise<void>);
        connected: boolean;
        deleteResourceSync: ((deleteResourceRequest) => Promise<Record<string, never>>);
        host: string;
        longPoll?: MaybeTimeDuration;
        broadcastSignalSync(signal): Promise<BroadcastSignalResponse>;
        cancelProcessInstanceSync(processInstanceKey): Promise<void>;
        close(timeout?): Promise<null>;
        createProcessInstanceSync(createProcessInstanceRequest): Promise<CreateProcessInstanceResponse>;
        createProcessInstanceWithResultSync(createProcessInstanceWithResultRequest): Promise<CreateProcessInstanceWithResultResponseOnWire>;
        deployResourceSync<T>(resource): Promise<DeployResourceResponse<T>>;
        evaluateDecisionSync(evaluateDecisionRequest): Promise<EvaluateDecisionResponse>;
        failJobSync(failJobRequest): Promise<void>;
        listMethods(): string[];
        modifyProcessInstanceSync(request): Promise<ModifyProcessInstanceResponse>;
        publishMessageSync(publishMessageRequest): Promise<PublishMessageResponse>;
        resolveIncidentSync(resolveIncidentRequest): Promise<void>;
        runService(fnName, data, fnAnswer): void;
        setVariablesSync(request): Promise<void>;
        throwErrorSync(throwErrorRequest): Promise<void>;
        topologySync(): Promise<TopologyResponse>;
        updateJobRetriesSync(updateJobRetriesRequest): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    activateJobsStream -channelClosed -client -completeJobSync -connected -deleteResourceSync -host -longPoll? -

    Methods

    broadcastSignalSync -cancelProcessInstanceSync -close -createProcessInstanceSync -createProcessInstanceWithResultSync -deployResourceSync -evaluateDecisionSync -failJobSync -listMethods -modifyProcessInstanceSync -publishMessageSync -resolveIncidentSync -runService -setVariablesSync -throwErrorSync -topologySync -updateJobRetriesSync -

    Properties

    activateJobsStream

    activateJobsStream: ((req) => ClientReadableStream<unknown>)

    Type declaration

      • (req): ClientReadableStream<unknown>

      • Parameters

        Returns ClientReadableStream<unknown>

    channelClosed

    channelClosed: boolean = false

    client

    client: Client

    completeJobSync

    completeJobSync: ((req) => Promise<void>)

    Type declaration

    connected

    connected: boolean = false

    deleteResourceSync

    deleteResourceSync: ((deleteResourceRequest) => Promise<Record<string, never>>)

    Type declaration

      • (deleteResourceRequest): Promise<Record<string, never>>

      • Parameters

        Returns Promise<Record<string, never>>

    host

    host: string

    Optional longPoll

    longPoll?: MaybeTimeDuration

    Methods

    broadcastSignalSync

    cancelProcessInstanceSync

    • cancelProcessInstanceSync(processInstanceKey): Promise<void>

    • Parameters

      • processInstanceKey: {
            processInstanceKey: string | number;
        }
        • processInstanceKey: string | number

      Returns Promise<void>

    close

    createProcessInstanceSync

    createProcessInstanceWithResultSync

    deployResourceSync

    evaluateDecisionSync

    failJobSync

    listMethods

    modifyProcessInstanceSync

    publishMessageSync

    resolveIncidentSync

    runService

    setVariablesSync

    throwErrorSync

    topologySync

    updateJobRetriesSync

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ZBLogMessage.html b/docs/interfaces/zeebe_types.ZBLogMessage.html deleted file mode 100644 index 31086640..00000000 --- a/docs/interfaces/zeebe_types.ZBLogMessage.html +++ /dev/null @@ -1,7 +0,0 @@ -ZBLogMessage | @camunda8/sdk

    Interface ZBLogMessage

    interface ZBLogMessage {
        context: string;
        id: string;
        level: Loglevel;
        message: string;
        time: string;
        timestamp: Date;
    }

    Properties

    context -id -level -message -time -timestamp -

    Properties

    context

    context: string

    id

    id: string

    level

    level: Loglevel

    message

    message: string

    time

    time: string

    timestamp

    timestamp: Date

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ZBLoggerConfig.html b/docs/interfaces/zeebe_types.ZBLoggerConfig.html deleted file mode 100644 index f689c3f7..00000000 --- a/docs/interfaces/zeebe_types.ZBLoggerConfig.html +++ /dev/null @@ -1,11 +0,0 @@ -ZBLoggerConfig | @camunda8/sdk

    Interface ZBLoggerConfig

    interface ZBLoggerConfig {
        _tag: "ZBCLIENT" | "ZBWORKER";
        color?: Chalk;
        colorise?: boolean;
        id?: string;
        loglevel?: Loglevel;
        longPoll?: MaybeTimeDuration;
        namespace: string | string[];
        pollInterval?: MaybeTimeDuration;
        stdout?: ZBCustomLogger;
        taskType?: string;
    }

    Hierarchy (view full)

    Properties

    _tag -color? -colorise? -id? -loglevel? -longPoll? -namespace -pollInterval? -stdout? -taskType? -

    Properties

    _tag

    _tag: "ZBCLIENT" | "ZBWORKER"

    Optional color

    color?: Chalk

    Optional colorise

    colorise?: boolean

    Optional id

    id?: string

    Optional loglevel

    loglevel?: Loglevel

    Optional longPoll

    longPoll?: MaybeTimeDuration

    namespace

    namespace: string | string[]

    Optional pollInterval

    pollInterval?: MaybeTimeDuration

    Optional stdout

    stdout?: ZBCustomLogger

    Optional taskType

    taskType?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ZBLoggerOptions.html b/docs/interfaces/zeebe_types.ZBLoggerOptions.html deleted file mode 100644 index c45ef660..00000000 --- a/docs/interfaces/zeebe_types.ZBLoggerOptions.html +++ /dev/null @@ -1,8 +0,0 @@ -ZBLoggerOptions | @camunda8/sdk

    Interface ZBLoggerOptions

    interface ZBLoggerOptions {
        color?: Chalk;
        loglevel?: Loglevel;
        longPoll?: MaybeTimeDuration;
        namespace: string | string[];
        pollInterval?: MaybeTimeDuration;
        stdout?: ZBCustomLogger;
        taskType?: string;
    }

    Hierarchy (view full)

    Properties

    color? -loglevel? -longPoll? -namespace -pollInterval? -stdout? -taskType? -

    Properties

    Optional color

    color?: Chalk

    Optional loglevel

    loglevel?: Loglevel

    Optional longPoll

    longPoll?: MaybeTimeDuration

    namespace

    namespace: string | string[]

    Optional pollInterval

    pollInterval?: MaybeTimeDuration

    Optional stdout

    stdout?: ZBCustomLogger

    Optional taskType

    taskType?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ZBWorkerConfig.html b/docs/interfaces/zeebe_types.ZBWorkerConfig.html deleted file mode 100644 index 4a95e5d2..00000000 --- a/docs/interfaces/zeebe_types.ZBWorkerConfig.html +++ /dev/null @@ -1,41 +0,0 @@ -ZBWorkerConfig | @camunda8/sdk

    Interface ZBWorkerConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

    interface ZBWorkerConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> {
        connectionTolerance?: MaybeTimeDuration;
        customHeadersDto?: (new (...args) => Readonly<CustomHeaderShape>);
        debug?: boolean;
        failProcessOnException?: boolean;
        fetchVariable?: (keyof WorkerInputVariables)[];
        id?: string;
        inputVariableDto?: (new (...args) => Readonly<WorkerInputVariables>);
        logNamespace?: string;
        loglevel?: Loglevel;
        longPoll?: MaybeTimeDuration;
        maxJobsToActivate?: number;
        onConnectionError?: (() => void);
        onConnectionErrorHandler?: ConnectionErrorHandler;
        onReady?: (() => void);
        pollInterval?: MaybeTimeDuration;
        stdout?: ZBCustomLogger;
        taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>;
        taskType: string;
        timeout?: MaybeTimeDuration;
    }

    Type Parameters

    • WorkerInputVariables
    • CustomHeaderShape
    • WorkerOutputVariables

    Hierarchy (view full)

    Properties

    connectionTolerance? -customHeadersDto? -debug? -failProcessOnException? -fetchVariable? -id? -inputVariableDto? -logNamespace? -loglevel? -longPoll? -maxJobsToActivate? -onConnectionError? -onConnectionErrorHandler? -onReady? -pollInterval? -stdout? -taskHandler -taskType -timeout? -

    Properties

    Optional connectionTolerance

    connectionTolerance?: MaybeTimeDuration

    If your Grpc connection jitters, this is the window before the connectionError

    -

    Optional customHeadersDto

    customHeadersDto?: (new (...args) => Readonly<CustomHeaderShape>)

    Provide an annotated Dto class to control the serialisation of JSON numbers. This allows you to serialise -numbers as strings or BigInts to avoid precision loss. This also gives you design-time type safety.

    -

    Type declaration

    Optional debug

    debug?: boolean

    Enable debug tracking

    -

    Optional failProcessOnException

    failProcessOnException?: boolean

    If a handler throws an unhandled exception, if this is set true, the process will be failed. Defaults to false.

    -

    Optional fetchVariable

    fetchVariable?: (keyof WorkerInputVariables)[]

    Constrain payload to these keys only.

    -

    Optional id

    id?: string

    A custom id for the worker. If none is supplied, a UUID will be generated.

    -

    Optional inputVariableDto

    inputVariableDto?: (new (...args) => Readonly<WorkerInputVariables>)

    Provide an annotated Dto class to control the serialisation of JSON numbers. This allows you to serialise -numbers as strings or BigInts to avoid precision loss. This also gives you design-time type safety.

    -

    Type declaration

    Optional logNamespace

    logNamespace?: string

    Optional loglevel

    loglevel?: Loglevel

    A log level if you want it to differ from the ZBClient

    -

    Optional longPoll

    longPoll?: MaybeTimeDuration

    A custom longpoll timeout. By default long polling is every 30 seconds.

    -

    Optional maxJobsToActivate

    maxJobsToActivate?: number

    Max concurrent tasks for this worker. Default 32.

    -

    Optional onConnectionError

    onConnectionError?: (() => void)

    This handler is called when the worker cannot connect to the broker, or loses its connection.

    -

    Type declaration

      • (): void

      • Returns void

    Optional onConnectionErrorHandler

    onConnectionErrorHandler?: ConnectionErrorHandler

    This handler is called when the worker cannot connect to the broker, or loses its connection.

    -

    Optional onReady

    onReady?: (() => void)

    This handler is called when the worker (re)establishes its connection to the broker

    -

    Type declaration

      • (): void

      • Returns void

    Optional pollInterval

    pollInterval?: MaybeTimeDuration

    Poll Interval in ms. Default 100.

    -

    Optional stdout

    stdout?: ZBCustomLogger

    An implementation of the ZBCustomLogger interface for logging

    -

    taskHandler

    taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

    A job handler - this must return a job action - e.g.: job.complete(), job.error() - in all code paths.

    -

    taskType

    taskType: string

    The task type that this worker will request jobs for.

    -

    Optional timeout

    timeout?: MaybeTimeDuration

    Max seconds to allow before time out of a job given to this worker. Default: 30s. -The broker checks deadline timeouts every 30 seconds, so an

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ZBWorkerOptions.html b/docs/interfaces/zeebe_types.ZBWorkerOptions.html deleted file mode 100644 index ca7c8e6c..00000000 --- a/docs/interfaces/zeebe_types.ZBWorkerOptions.html +++ /dev/null @@ -1,16 +0,0 @@ -ZBWorkerOptions | @camunda8/sdk

    Interface ZBWorkerOptions<InputVars>

    interface ZBWorkerOptions<InputVars> {
        debug?: boolean;
        failProcessOnException?: boolean;
        fetchVariable?: (keyof InputVars)[];
        maxJobsToActivate?: number;
        onConnectionErrorHandler?: ConnectionErrorHandler;
        pollInterval?: MaybeTimeDuration;
        timeout?: MaybeTimeDuration;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    debug? -failProcessOnException? -fetchVariable? -maxJobsToActivate? -onConnectionErrorHandler? -pollInterval? -timeout? -

    Properties

    Optional debug

    debug?: boolean

    Enable debug tracking

    -

    Optional failProcessOnException

    failProcessOnException?: boolean

    If a handler throws an unhandled exception, if this is set true, the process will be failed. Defaults to false.

    -

    Optional fetchVariable

    fetchVariable?: (keyof InputVars)[]

    Constrain payload to these keys only.

    -

    Optional maxJobsToActivate

    maxJobsToActivate?: number

    Max concurrent tasks for this worker. Default 32.

    -

    Optional onConnectionErrorHandler

    onConnectionErrorHandler?: ConnectionErrorHandler

    This handler is called when the worker cannot connect to the broker, or loses its connection.

    -

    Optional pollInterval

    pollInterval?: MaybeTimeDuration

    Poll Interval in ms. Default 100.

    -

    Optional timeout

    timeout?: MaybeTimeDuration

    Max seconds to allow before time out of a job given to this worker. Default: 30s. -The broker checks deadline timeouts every 30 seconds, so an

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types.ZeebeJob.html b/docs/interfaces/zeebe_types.ZeebeJob.html deleted file mode 100644 index 07653953..00000000 --- a/docs/interfaces/zeebe_types.ZeebeJob.html +++ /dev/null @@ -1,43 +0,0 @@ -ZeebeJob | @camunda8/sdk

    Interface ZeebeJob<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

    interface ZeebeJob<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> {
        bpmnProcessId: string;
        cancelWorkflow: (() => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">);
        complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">);
        customHeaders: Readonly<CustomHeaderShape>;
        deadline: string;
        elementId: string;
        elementInstanceKey: string;
        error: ErrorJobOutcome;
        fail: {
            (errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
            (failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
        };
        forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT");
        key: string;
        processDefinitionVersion: number;
        processInstanceKey: string;
        retries: number;
        type: string;
        variables: Readonly<WorkerInputVariables>;
        worker: string;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    bpmnProcessId -cancelWorkflow -complete -customHeaders -deadline -elementId -elementInstanceKey -error -fail -forward -key -processDefinitionVersion -processInstanceKey -retries -type -variables -worker -

    Properties

    Readonly bpmnProcessId

    bpmnProcessId: string

    The bpmn process ID of the job process definition

    -

    cancelWorkflow

    cancelWorkflow: (() => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">)

    Cancel the workflow.

    -

    Type declaration

      • (): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

      • Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

    complete

    complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">)

    Complete the job with a success, optionally passing in a state update to merge -with the process variables on the broker.

    -

    Type declaration

      • (updatedVariables?): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

      • Parameters

        Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

    Readonly customHeaders

    customHeaders: Readonly<CustomHeaderShape>

    A set of custom headers defined during modelling

    -

    Readonly deadline

    deadline: string

    Readonly elementId

    elementId: string

    The associated task element ID

    -

    Readonly elementInstanceKey

    elementInstanceKey: string

    The unique key identifying the associated task, unique within the scope of the -process instance

    -

    error

    error: ErrorJobOutcome

    Report a business error (i.e. non-technical) that occurs while processing a job. -The error is handled in the process by an error catch event. -If there is no error catch event with the specified errorCode then an incident will be raised instead.

    -

    fail

    fail: {
        (errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
        (failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
    }

    Fail the job with an informative message as to the cause. Optionally, pass in a -value remaining retries. If no value is passed for retries then the current retry -count is decremented. Pass in 0for retries to raise an incident in Operate. Optionally, -specify a retry backoff period in milliseconds. Default is 0ms (immediate retry) if not -specified.

    -

    Type declaration

    forward

    forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT")

    Mark this job as forwarded to another system for completion. No action is taken by the broker. -This method releases worker capacity to handle another job.

    -

    Type declaration

      • (): "JOB_ACTION_ACKNOWLEDGEMENT"

      • Returns "JOB_ACTION_ACKNOWLEDGEMENT"

    Readonly key

    key: string

    The key, a unique identifier for the job

    -

    Readonly processDefinitionVersion

    processDefinitionVersion: number

    The version of the job process definition

    -

    Readonly processInstanceKey

    processInstanceKey: string

    The job's process instance key

    -

    Readonly retries

    retries: number

    Readonly type

    type: string

    The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition -type="payment-service" />)

    -

    Readonly variables

    variables: Readonly<WorkerInputVariables>

    All visible variables in the task scope, computed at activation time.

    -

    Readonly worker

    worker: string

    The name of the worker that activated this job

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types._internal_.CreateProcessInstanceWithResultResponseBase.html b/docs/interfaces/zeebe_types._internal_.CreateProcessInstanceWithResultResponseBase.html deleted file mode 100644 index 895dd281..00000000 --- a/docs/interfaces/zeebe_types._internal_.CreateProcessInstanceWithResultResponseBase.html +++ /dev/null @@ -1,13 +0,0 @@ -CreateProcessInstanceWithResultResponseBase | @camunda8/sdk

    Interface CreateProcessInstanceWithResultResponseBase

    interface CreateProcessInstanceWithResultResponseBase {
        bpmnProcessId: string;
        processDefinitionKey: string;
        processInstanceKey: string;
        tenantId: string;
        version: number;
    }

    Hierarchy (view full)

    Properties

    bpmnProcessId -processDefinitionKey -processInstanceKey -tenantId -version -

    Properties

    Readonly bpmnProcessId

    bpmnProcessId: string

    the BPMN process ID of the process definition which was used to create the process -instance

    -

    Readonly processDefinitionKey

    processDefinitionKey: string

    the key of the process definition which was used to create the process instance

    -

    Readonly processInstanceKey

    processInstanceKey: string

    the unique identifier of the created process instance; to be used wherever a request -needs a process instance key (e.g. CancelProcessInstanceRequest)

    -

    Readonly tenantId

    tenantId: string

    the tenant identifier of the process definition

    -

    Readonly version

    version: number

    the version of the process definition which was used to create the process instance

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types._internal_.CustomSSL.html b/docs/interfaces/zeebe_types._internal_.CustomSSL.html deleted file mode 100644 index 031ea80d..00000000 --- a/docs/interfaces/zeebe_types._internal_.CustomSSL.html +++ /dev/null @@ -1,5 +0,0 @@ -CustomSSL | @camunda8/sdk

    Interface CustomSSL

    interface CustomSSL {
        certChain?: Buffer;
        privateKey?: Buffer;
        rootCerts?: Buffer;
        verifyOptions?: VerifyOptions;
    }

    Properties

    certChain? -privateKey? -rootCerts? -verifyOptions? -

    Properties

    Optional certChain

    certChain?: Buffer

    Optional privateKey

    privateKey?: Buffer

    Optional rootCerts

    rootCerts?: Buffer

    Optional verifyOptions

    verifyOptions?: VerifyOptions

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/zeebe_types._internal_.GrpcClientCtor.html b/docs/interfaces/zeebe_types._internal_.GrpcClientCtor.html deleted file mode 100644 index 6b4add0f..00000000 --- a/docs/interfaces/zeebe_types._internal_.GrpcClientCtor.html +++ /dev/null @@ -1,81 +0,0 @@ -GrpcClientCtor | @camunda8/sdk

    Interface GrpcClientCtor

    interface GrpcClientCtor {
        config: {
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        };
        connectionTolerance: MaybeTimeDuration;
        customSSL?: CustomSSL;
        host: string;
        loglevel: Loglevel;
        namespace: string;
        oAuth?: IOAuthProvider;
        options: IParseOptions & IConversionOptions & {} & GrpcClientExtendedOptions;
        packageName: string;
        protoPath: string;
        service: string;
        stdout: ZBCustomLogger;
        tasktype?: string;
        useTLS: boolean;
    }

    Properties

    config -connectionTolerance -customSSL? -host -loglevel -namespace -oAuth? -options -packageName -protoPath -service -stdout -tasktype? -useTLS -

    Properties

    config

    config: {
        CAMUNDA_CONSOLE_BASE_URL: undefined | string;
        CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
        CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
        CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
        CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
        CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
        CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
        CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
        CAMUNDA_MODELER_BASE_URL: string;
        CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
        CAMUNDA_OAUTH_DISABLED: boolean;
        CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
        CAMUNDA_OAUTH_URL: undefined | string;
        CAMUNDA_OPERATE_BASE_URL: undefined | string;
        CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
        CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
        CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
        CAMUNDA_SECURE_CONNECTION: boolean;
        CAMUNDA_TASKLIST_BASE_URL: undefined | string;
        CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
        CAMUNDA_TENANT_ID: undefined | string;
        CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
        CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
        CAMUNDA_TOKEN_SCOPE: undefined | string;
        CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
        ZEEBE_ADDRESS: string;
        ZEEBE_CLIENT_ID: undefined | string;
        ZEEBE_CLIENT_SECRET: undefined | string;
        zeebeGrpcSettings: {
            GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
            GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
            GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
            GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
            GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
            GRPC_KEEPALIVE_TIMEOUT_MS: number;
            GRPC_KEEPALIVE_TIME_MS: number;
            GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
            GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
            ZEEBE_CLIENT_LOG_LEVEL: string;
            ZEEBE_CLIENT_LOG_TYPE: string;
            ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
            ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
            ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
            ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
            ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
            ZEEBE_GRPC_CLIENT_RETRY: boolean;
            ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
            ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
        };
    }

    Type declaration

    • CAMUNDA_CONSOLE_BASE_URL: undefined | string

      The base url for the Admin Console API.

      -
    • CAMUNDA_CONSOLE_CLIENT_ID: undefined | string

      Credentials for Admin Console and Modeler API

      -
    • CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string

      Credentials for Admin Console and Modeler API

      -
    • CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string

      The audience parameter for an Admin Console OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise

      -
    • CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string

      When using custom or self-signed certificates, provide the path to the certificate chain

      -
    • CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string

      When using custom or self-signed certificates, provide the path to the private key

      -
    • CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string

      In an environment using self-signed certificates, provide the path to the root certificate

      -
    • CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string

      Custom user agent

      -
    • CAMUNDA_MODELER_BASE_URL: string

      The base url for the Modeler API. Defaults to Camunda Saas - https://modeler.cloud.camunda.io/api

      -
    • CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string

      The audience parameter for a Modeler OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise

      -
    • CAMUNDA_OAUTH_DISABLED: boolean

      Set to true to disable OAuth completely

      -
    • CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number

      How soon in milliseconds before its expiration time a cached OAuth token should be considered expired. Defaults to 1000

      -
    • CAMUNDA_OAUTH_URL: undefined | string

      The OAuth token exchange endpoint url

      -
    • CAMUNDA_OPERATE_BASE_URL: undefined | string

      The base url for the Operate API

      -
    • CAMUNDA_OPERATE_OAUTH_AUDIENCE: string

      The audience parameter for an Operate OAuth token request. Defaults to operate.camunda.io

      -
    • CAMUNDA_OPTIMIZE_BASE_URL: undefined | string

      The base url for the Optimize API

      -
    • CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string

      The audience parameter for an Optimize OAuth token request. Defaults to optimize.camunda.io

      -
    • CAMUNDA_SECURE_CONNECTION: boolean

      Control TLS for Zeebe Grpc. Defaults to true. Set to false when using an unsecured gateway

      -
    • CAMUNDA_TASKLIST_BASE_URL: undefined | string

      The base url for the Tasklist API

      -
    • CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string

      The audience parameter for a Tasklist OAuth token request. Defaults to tasklist.camunda.io

      -
    • CAMUNDA_TENANT_ID: undefined | string

      The tenant id when multi-tenancy is enabled

      -
    • CAMUNDA_TOKEN_CACHE_DIR: undefined | string

      The directory to cache OAuth tokens on-disk. Defaults to $HOME/.camunda

      -
    • CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean

      Set to true to disable disk caching of OAuth tokens and use memory caching only

      -
    • CAMUNDA_TOKEN_SCOPE: undefined | string

      Optional scope parameter for OAuth (needed by some OIDC)

      -
    • CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string

      The audience parameter for a Zeebe OAuth token request. Defaults to zeebe.camunda.io

      -
    • ZEEBE_ADDRESS: string

      The address for the Zeebe Gateway. Defaults to localhost:26500

      -
    • ZEEBE_CLIENT_ID: undefined | string

      This is the client ID for the client credentials

      -
    • ZEEBE_CLIENT_SECRET: undefined | string

      This is the client secret for the client credentials

      -
    • zeebeGrpcSettings: {
          GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
          GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
          GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
          GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
          GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
          GRPC_KEEPALIVE_TIMEOUT_MS: number;
          GRPC_KEEPALIVE_TIME_MS: number;
          GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
          GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
          ZEEBE_CLIENT_LOG_LEVEL: string;
          ZEEBE_CLIENT_LOG_TYPE: string;
          ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
          ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
          ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
          ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
          ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
          ZEEBE_GRPC_CLIENT_RETRY: boolean;
          ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
          ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
      }
      • GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number

        This channel argument controls the maximum number -of pings that can be sent when there is no other -data (data frame or header frame) to be sent. -GRPC Core will not continue sending pings if we -run over the limit. Setting it to 0 allows sending -pings without sending data.

        -
      • GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number

        Minimum allowed time between a server receiving -successive ping frames without sending any data -frame. Int valued, milliseconds. Default: 90000

        -
      • GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number

        Defaults to 90000.

        -
      • GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number

        The time between the first and second connection attempts, -in ms. Defaults to 1000.

        -
      • GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number

        This channel argument if set to 1 -(0 : false; 1 : true), allows keepalive pings -to be sent even if there are no calls in flight. -Defaults to 1.

        -
      • GRPC_KEEPALIVE_TIMEOUT_MS: number

        After waiting for a duration of this time, if the keepalive ping sender does not receive the ping ack, it will close the -transport. Int valued, milliseconds. Defaults to 120000.

        -
      • GRPC_KEEPALIVE_TIME_MS: number

        After a duration of this time the client/server pings its peer to see if the transport is still alive. -Int valued, milliseconds. Defaults to 360000.

        -
      • GRPC_MAX_RECONNECT_BACKOFF_MS: string | number

        The maximum time between subsequent connection attempts, -in ms. Defaults to 10000.

        -
      • GRPC_MIN_RECONNECT_BACKOFF_MS: string | number

        The minimum time between subsequent connection attempts, -in ms. Default is 1000ms, but this can cause an SSL Handshake failure. -This causes an intermittent failure in the Worker-LongPoll test when run -against Camunda Cloud. -Raised to 5000ms. -See: https://github.com/grpc/grpc/issues/8382#issuecomment-259482949

        -
      • ZEEBE_CLIENT_LOG_LEVEL: string

        Log level of Zeebe Client and Workers - 'DEBUG' | 'INFO' | 'NONE'. Defaults to 'INFO'

        -
      • ZEEBE_CLIENT_LOG_TYPE: string

        Zeebe client log output can be human-readable 'SIMPLE' or structured 'JSON'. Defaults to 'SIMPLE'

        -
      • ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number

        The gRPC channel can "jitter". This suppresses a connection error message if the channel comes back within this window in milliseconds. Defaults to 3000

        -
      • ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean

        Immediately connect to the Zeebe Gateway (issues a silent topology request). Defaults to false

        -
      • ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number

        This suppresses intermediate errors during initial connection negotiation. On Camunda SaaS this defaults to 6000, on Self-Managed to 0

        -
      • ZEEBE_GRPC_CLIENT_MAX_RETRIES: number

        Maximum number of retries of network operations before failing. Defaults to -1 (infinite retries)

        -
      • ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number

        When retrying failed network operations, retries back off to this maximum period. Defaults to 10s

        -
      • ZEEBE_GRPC_CLIENT_RETRY: boolean

        Automate retrying operations that fail due to network conditions or broker backpressure. Defaults to true

        -
      • ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number

        How long in seconds the long poll Job Activation request is held open by a worker. Defaults to 60

        -
      • ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number

        After a long poll Job Activation request, this is the cool-off period in milliseconds before the worker requests more work. Defaults to 300

        -

    connectionTolerance

    connectionTolerance: MaybeTimeDuration

    Optional customSSL

    customSSL?: CustomSSL

    host

    host: string

    loglevel

    loglevel: Loglevel

    namespace

    namespace: string

    Optional oAuth

    oAuth?: IOAuthProvider

    options

    options: IParseOptions & IConversionOptions & {} & GrpcClientExtendedOptions

    Type declaration

      packageName

      packageName: string

      protoPath

      protoPath: string

      service

      service: string

      stdout

      stdout: ZBCustomLogger

      Optional tasktype

      tasktype?: string

      useTLS

      useTLS: boolean

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/interfaces/zeebe_types._internal_.GrpcClientExtendedOptions.html b/docs/interfaces/zeebe_types._internal_.GrpcClientExtendedOptions.html deleted file mode 100644 index 572771ec..00000000 --- a/docs/interfaces/zeebe_types._internal_.GrpcClientExtendedOptions.html +++ /dev/null @@ -1,3 +0,0 @@ -GrpcClientExtendedOptions | @camunda8/sdk

      Interface GrpcClientExtendedOptions

      interface GrpcClientExtendedOptions {
          longPoll?: MaybeTimeDuration;
          pollInterval?: MaybeTimeDuration;
      }

      Properties

      longPoll? -pollInterval? -

      Properties

      Optional longPoll

      longPoll?: MaybeTimeDuration

      Optional pollInterval

      pollInterval?: MaybeTimeDuration

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/interfaces/zeebe_types._internal_.SetVariablesRequestBase.html b/docs/interfaces/zeebe_types._internal_.SetVariablesRequestBase.html deleted file mode 100644 index 0ccf3516..00000000 --- a/docs/interfaces/zeebe_types._internal_.SetVariablesRequestBase.html +++ /dev/null @@ -1,10 +0,0 @@ -SetVariablesRequestBase | @camunda8/sdk

      Interface SetVariablesRequestBase

      interface SetVariablesRequestBase {
          elementInstanceKey: string;
          local: boolean;
      }

      Hierarchy (view full)

      Properties

      elementInstanceKey -local -

      Properties

      Readonly elementInstanceKey

      elementInstanceKey: string

      local

      local: boolean

      if true, the variables will be merged strictly into the local scope (as indicated by - elementInstanceKey); this means the variables is not propagated to upper scopes. - for example, let's say we have two scopes, '1' and '2', with each having effective variables as: -1 => { "foo" : 2 }, and 2 => { "bar" : 1 }. if we send an update request with -elementInstanceKey = 2, variables { "foo" : 5 }, and local is true, then scope 1 will -be unchanged, and scope 2 will now be { "bar" : 1, "foo" 5 }. if local was false, however, -then scope 1 would be { "foo": 5 }, and scope 2 would be { "bar" : 1 }.

      -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/modules/index.Admin.AdminDto.html b/docs/modules/index.Admin.AdminDto.html deleted file mode 100644 index 48ee3331..00000000 --- a/docs/modules/index.Admin.AdminDto.html +++ /dev/null @@ -1,10 +0,0 @@ -AdminDto | @camunda8/sdk

      Namespace AdminDto

      Index

      Interfaces

      Cluster -ClusterClient -ClusterClientConnectionDetails -CreateClusterBody -CreatedClusterClient -Member -Parameters -

      Type Aliases

      ClusterStatusstring -OrganizationRole -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/modules/index.Admin.html b/docs/modules/index.Admin.html deleted file mode 100644 index 7dd268bc..00000000 --- a/docs/modules/index.Admin.html +++ /dev/null @@ -1,3 +0,0 @@ -Admin | @camunda8/sdk

      Namespace Admin

      Index

      Namespaces

      AdminDto -

      Classes

      AdminApiClient -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/modules/index.Auth.html b/docs/modules/index.Auth.html deleted file mode 100644 index 251aef72..00000000 --- a/docs/modules/index.Auth.html +++ /dev/null @@ -1,6 +0,0 @@ -Auth | @camunda8/sdk

      Namespace Auth

      Index

      Classes

      NullAuthProvider -OAuthProvider -

      Interfaces

      IOAuthProvider -Token -TokenError -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/modules/index.Modeler.ModelerDto.html b/docs/modules/index.Modeler.ModelerDto.html deleted file mode 100644 index 11c14539..00000000 --- a/docs/modules/index.Modeler.ModelerDto.html +++ /dev/null @@ -1,30 +0,0 @@ -ModelerDto | @camunda8/sdk

      Namespace ModelerDto

      Index

      Interfaces

      CreateCollaboratorDto -CreateFileDto -CreateFolderDto -CreateMilestoneDto -FileDto -FileMetadataDto -FolderContentDto -FolderDto -FolderMetadataDto -InfoDto -MilestoneDto -MilestoneMetadataDto -PathElementDto -ProjectCollaboratorDto -ProjectContent -ProjectDto -ProjectMetadataDto -PubSearchDtoFileMetadataDto -PubSearchDtoMilestoneMetadataDto -PubSearchDtoProjectCollaboratorDto -PubSearchDtoProjectMetadataDto -PubSearchResultDtoFileMetadataDto -PubSearchResultDtoMilestoneMetadataDto -PubSearchResultDtoProjectCollaboratorDto -PubSearchResultDtoProjectMetadataDto -SortDto -UpdateFileDto -UpdateFolderDto -UserDto -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/modules/index.Modeler.html b/docs/modules/index.Modeler.html deleted file mode 100644 index d2d6678d..00000000 --- a/docs/modules/index.Modeler.html +++ /dev/null @@ -1,3 +0,0 @@ -Modeler | @camunda8/sdk

      Namespace Modeler

      Index

      Namespaces

      ModelerDto -

      Classes

      ModelerApiClient -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/modules/index.Operate.OperateDto.html b/docs/modules/index.Operate.OperateDto.html deleted file mode 100644 index fd4bf4aa..00000000 --- a/docs/modules/index.Operate.OperateDto.html +++ /dev/null @@ -1,15 +0,0 @@ -OperateDto | @camunda8/sdk

      Namespace OperateDto

      Index

      Classes

      ChangeStatus -DecisionDefinition -DecisionInstance -DecisionInstanceInput -DecisionInstanceOutput -DecisionRequirements -FlownodeInstance -Incident -ProcessDefinition -ProcessInstance -ProcessInstanceStatistics -Variable -

      Interfaces

      Query -SearchResults -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/modules/index.Operate.html b/docs/modules/index.Operate.html deleted file mode 100644 index 73e16b6e..00000000 --- a/docs/modules/index.Operate.html +++ /dev/null @@ -1,3 +0,0 @@ -Operate | @camunda8/sdk

      Namespace Operate

      Index

      Namespaces

      OperateDto -

      Classes

      OperateApiClient -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/modules/index.Optimize.OptimizeDto.html b/docs/modules/index.Optimize.OptimizeDto.html deleted file mode 100644 index 1699cc73..00000000 --- a/docs/modules/index.Optimize.OptimizeDto.html +++ /dev/null @@ -1,16 +0,0 @@ -OptimizeDto | @camunda8/sdk

      Namespace OptimizeDto

      Index

      Interfaces

      CloudEventV1 -CloudEventV1Attributes -CloudEventV1OptionalAttributes -DashboardDefinition -ReportData -ReportDataExporter -ReportDataPage -Variable -VariableLabel -VariableLabels -

      Type Aliases

      DashboardCollection -EntityImportResponse -ReportCollection -SingleProcessReport -VariableType -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/modules/index.Optimize.html b/docs/modules/index.Optimize.html deleted file mode 100644 index 6d631c9f..00000000 --- a/docs/modules/index.Optimize.html +++ /dev/null @@ -1,3 +0,0 @@ -Optimize | @camunda8/sdk

      Namespace Optimize

      Index

      Namespaces

      OptimizeDto -

      Classes

      OptimizeApiClient -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/modules/index.Tasklist.TasklistDto.html b/docs/modules/index.Tasklist.TasklistDto.html deleted file mode 100644 index d2d34ac9..00000000 --- a/docs/modules/index.Tasklist.TasklistDto.html +++ /dev/null @@ -1,18 +0,0 @@ -TasklistDto | @camunda8/sdk

      Namespace TasklistDto

      Index

      Classes

      Form -TaskResponse -TaskSearchResponse -

      Interfaces

      DateFilter -DraftSearchVariableValue -TaskByVariables -TaskSearchAfterOrEqualRequest -TaskSearchAfterRequest -TaskSearchBeforeOrEqualRequest -TaskSearchBeforeRequest -TaskSearchRequestBase -User -Variable -VariableInput -VariableSearchResponse -VariableSearchResponseWithoutDraft -

      Type Aliases

      TaskState -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/modules/index.Tasklist.html b/docs/modules/index.Tasklist.html deleted file mode 100644 index 025464e4..00000000 --- a/docs/modules/index.Tasklist.html +++ /dev/null @@ -1,3 +0,0 @@ -Tasklist | @camunda8/sdk

      Namespace Tasklist

      Index

      Namespaces

      TasklistDto -

      Classes

      TasklistApiClient -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/modules/index.Zeebe.Types.html b/docs/modules/index.Zeebe.Types.html deleted file mode 100644 index 9bac5401..00000000 --- a/docs/modules/index.Zeebe.Types.html +++ /dev/null @@ -1,4 +0,0 @@ -Types | @camunda8/sdk

      Namespace Types

      Index

      Enumerations

      PartitionBrokerHealth -PartitionBrokerRole -

      Variables

      JOB_ACTION_ACKNOWLEDGEMENT -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/modules/index.Zeebe.html b/docs/modules/index.Zeebe.html deleted file mode 100644 index e1c6a796..00000000 --- a/docs/modules/index.Zeebe.html +++ /dev/null @@ -1,6 +0,0 @@ -Zeebe | @camunda8/sdk

      Namespace Zeebe

      Index

      Namespaces

      Types -

      Classes

      BpmnParser -ZBWorker -ZeebeGrpcClient -

      Variables

      Logging -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/modules/index._internal_.html b/docs/modules/index._internal_.html deleted file mode 100644 index 7537e4ff..00000000 --- a/docs/modules/index._internal_.html +++ /dev/null @@ -1,25 +0,0 @@ -<internal> | @camunda8/sdk

      Module <internal>

      Index

      Classes

      LosslessDto -StatefulLogInterceptor -TypedEmitter -ZBLogger -ZBWorkerBase -

      Interfaces

      Characteristics -Emitter -IncludeVariable -JSONDoc -Logger -TaskOrderBy -ZBWorkerConstructorConfig -

      Type Aliases

      DeepPartial -EnhanceWithTenantIdIfMissing -EventKey -EventMap -EventReceiver -GrpcConnectionProfile -JSON -JSONDoc -LogFn -State -TokenGrantAudienceType -

      Variables

      ConnectionStatusEvent -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html deleted file mode 100644 index b95b3562..00000000 --- a/docs/modules/index.html +++ /dev/null @@ -1,11 +0,0 @@ -index | @camunda8/sdk

      Module index

      Index

      Modules

      <internal> -

      Namespaces

      Admin -Auth -Modeler -Operate -Optimize -Tasklist -Zeebe -

      Classes

      Camunda8 -

      Variables

      Dto -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/modules/zeebe_types._internal_.html b/docs/modules/zeebe_types._internal_.html deleted file mode 100644 index 3f7c5859..00000000 --- a/docs/modules/zeebe_types._internal_.html +++ /dev/null @@ -1,7 +0,0 @@ -<internal> | @camunda8/sdk

      Module <internal>

      Index

      Classes

      GrpcClient -

      Interfaces

      CreateProcessInstanceWithResultResponseBase -CustomSSL -GrpcClientCtor -GrpcClientExtendedOptions -SetVariablesRequestBase -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/modules/zeebe_types.html b/docs/modules/zeebe_types.html deleted file mode 100644 index 9ca5393b..00000000 --- a/docs/modules/zeebe_types.html +++ /dev/null @@ -1,92 +0,0 @@ -zeebe/types | @camunda8/sdk

      Module zeebe/types

      References

      PartitionBrokerHealth -PartitionBrokerRole -

      Modules

      <internal> -

      Interfaces

      ActivateInstruction -ActivateJobsRequest -ActivateJobsResponse -ActivatedJob -BroadcastSignalReq -BroadcastSignalRequest -BroadcastSignalRes -BroadcastSignalResponse -BrokerInfo -CamundaCloudConfig -CompleteJobRequest -CreateProcessBaseRequest -CreateProcessInstanceBaseRequest -CreateProcessInstanceReq -CreateProcessInstanceRequest -CreateProcessInstanceResponse -CreateProcessInstanceWithResultReq -CreateProcessInstanceWithResultRequest -CreateProcessInstanceWithResultResponse -CreateProcessInstanceWithResultResponseOnWire -DecisionDeployment -DecisionMetadata -DecisionRequirementsDeployment -DecisionRequirementsMetadata -DeleteResourceRequest -DeployResourceRequest -DeployResourceResponse -ErrorJobWithVariables -EvaluateDecisionResponse -EvaluatedDecision -EvaluatedDecisionInput -EvaluatedDecisionOutput -FailJobRequest -FormDeployment -FormMetadata -ICustomHeaders -IInputVariables -IOutputVariables -IProcessVariables -JSONDoc -Job -JobCompletionInterface -JobFailureConfiguration -ListProcessResponse -MatchedDecisionRule -ModifyProcessInstanceRequest -OAuthProviderConfig -OperationOptionsNoRetry -OperationOptionsWithRetry -Partition -ProcessDeployment -ProcessInstanceCreationStartInstruction -ProcessMetadata -ProcessRequestObject -PublishMessageRequest -PublishMessageResponse -PublishStartMessageRequest -ResolveIncidentRequest -Resource -SetVariablesRequest -SetVariablesRequestOnTheWire -StreamActivatedJobsRequest -TerminateInstruction -ThrowErrorRequest -TopologyResponse -UpdateJobRetriesRequest -VariableInstruction -ZBClientOptions -ZBCustomLogger -ZBGrpc -ZBLogMessage -ZBLoggerConfig -ZBLoggerOptions -ZBWorkerConfig -ZBWorkerOptions -ZeebeJob -

      Type Aliases

      ConnectionErrorHandler -Deployment -ErrorJobOutcome -EvaluateDecisionRequest -JOB_ACTION_ACKNOWLEDGEMENT -JSON -Loglevel -ModifyProcessInstanceResponse -MustReturnJobActionAcknowledgement -OperationOptions -ZBWorkerTaskHandler -

      Variables

      JOB_ACTION_ACKNOWLEDGEMENT -

      References

      PartitionBrokerHealth

      Re-exports PartitionBrokerHealth

      PartitionBrokerRole

      Re-exports PartitionBrokerRole

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index.Admin.AdminDto.ClusterStatusstring.html b/docs/types/index.Admin.AdminDto.ClusterStatusstring.html deleted file mode 100644 index fd74df3d..00000000 --- a/docs/types/index.Admin.AdminDto.ClusterStatusstring.html +++ /dev/null @@ -1 +0,0 @@ -ClusterStatusstring | @camunda8/sdk

      Type alias ClusterStatusstring

      ClusterStatusstring: "Healthy" | "Unhealthy" | "Creating" | "Updating"

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index.Admin.AdminDto.OrganizationRole.html b/docs/types/index.Admin.AdminDto.OrganizationRole.html deleted file mode 100644 index ef228496..00000000 --- a/docs/types/index.Admin.AdminDto.OrganizationRole.html +++ /dev/null @@ -1 +0,0 @@ -OrganizationRole | @camunda8/sdk

      Type alias OrganizationRole

      OrganizationRole: "member" | "admin" | "owner" | "supportagent" | "operationsengineer" | "taskuser" | "analyst" | "developer" | "visitor"

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index.Optimize.OptimizeDto.DashboardCollection.html b/docs/types/index.Optimize.OptimizeDto.DashboardCollection.html deleted file mode 100644 index fc326362..00000000 --- a/docs/types/index.Optimize.OptimizeDto.DashboardCollection.html +++ /dev/null @@ -1 +0,0 @@ -DashboardCollection | @camunda8/sdk

      Type alias DashboardCollection

      DashboardCollection: {
          id: string;
      }[]

      Type declaration

      • id: string

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index.Optimize.OptimizeDto.EntityImportResponse.html b/docs/types/index.Optimize.OptimizeDto.EntityImportResponse.html deleted file mode 100644 index e515655a..00000000 --- a/docs/types/index.Optimize.OptimizeDto.EntityImportResponse.html +++ /dev/null @@ -1 +0,0 @@ -EntityImportResponse | @camunda8/sdk

      Type alias EntityImportResponse

      EntityImportResponse: {
          entityType: "dashboard" | "report";
          id: string;
      }[]

      Type declaration

      • entityType: "dashboard" | "report"
      • id: string

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index.Optimize.OptimizeDto.ReportCollection.html b/docs/types/index.Optimize.OptimizeDto.ReportCollection.html deleted file mode 100644 index b70a3e08..00000000 --- a/docs/types/index.Optimize.OptimizeDto.ReportCollection.html +++ /dev/null @@ -1 +0,0 @@ -ReportCollection | @camunda8/sdk

      Type alias ReportCollection

      ReportCollection: {
          id: string;
      }[]

      Type declaration

      • id: string

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index.Optimize.OptimizeDto.SingleProcessReport.html b/docs/types/index.Optimize.OptimizeDto.SingleProcessReport.html deleted file mode 100644 index f18f4455..00000000 --- a/docs/types/index.Optimize.OptimizeDto.SingleProcessReport.html +++ /dev/null @@ -1 +0,0 @@ -SingleProcessReport | @camunda8/sdk

      Type alias SingleProcessReport

      SingleProcessReport: unknown

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index.Optimize.OptimizeDto.VariableType.html b/docs/types/index.Optimize.OptimizeDto.VariableType.html deleted file mode 100644 index b54ffa71..00000000 --- a/docs/types/index.Optimize.OptimizeDto.VariableType.html +++ /dev/null @@ -1 +0,0 @@ -VariableType | @camunda8/sdk

      Type alias VariableType

      VariableType: "string" | "short" | "long" | "double" | "integer" | "boolean" | "date"

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index.Tasklist.TasklistDto.TaskState.html b/docs/types/index.Tasklist.TasklistDto.TaskState.html deleted file mode 100644 index 192a0aca..00000000 --- a/docs/types/index.Tasklist.TasklistDto.TaskState.html +++ /dev/null @@ -1 +0,0 @@ -TaskState | @camunda8/sdk

      Type alias TaskState

      TaskState: "COMPLETED" | "CREATED" | "CANCELED" | "FAILED"

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index._internal_.DeepPartial.html b/docs/types/index._internal_.DeepPartial.html deleted file mode 100644 index 7796d1a6..00000000 --- a/docs/types/index._internal_.DeepPartial.html +++ /dev/null @@ -1 +0,0 @@ -DeepPartial | @camunda8/sdk

      Type alias DeepPartial<T>

      DeepPartial<T>: {
          [K in keyof T]?: T[K] extends object
              ? DeepPartial<T[K]>
              : T[K]
      }

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index._internal_.EnhanceWithTenantIdIfMissing.html b/docs/types/index._internal_.EnhanceWithTenantIdIfMissing.html deleted file mode 100644 index c1040834..00000000 --- a/docs/types/index._internal_.EnhanceWithTenantIdIfMissing.html +++ /dev/null @@ -1 +0,0 @@ -EnhanceWithTenantIdIfMissing | @camunda8/sdk

      Type alias EnhanceWithTenantIdIfMissing<T>

      EnhanceWithTenantIdIfMissing<T>: T extends {
              filter: {
                  tenantId: string | undefined;
              };
          }
          ? T
          : T extends {
                  filter: infer F;
              }
              ? {
                  filter: F & {
                      tenantId: string | undefined;
                  };
              } & Omit<T, "filter">
              : {
                  filter: {
                      tenantId: string | undefined;
                  };
              } & T

      Type Parameters

      • T

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index._internal_.EventKey.html b/docs/types/index._internal_.EventKey.html deleted file mode 100644 index 84195841..00000000 --- a/docs/types/index._internal_.EventKey.html +++ /dev/null @@ -1 +0,0 @@ -EventKey | @camunda8/sdk

      Type alias EventKey<T>

      EventKey<T>: string & keyof T

      Type Parameters

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index._internal_.EventMap.html b/docs/types/index._internal_.EventMap.html deleted file mode 100644 index 4ecfd36d..00000000 --- a/docs/types/index._internal_.EventMap.html +++ /dev/null @@ -1 +0,0 @@ -EventMap | @camunda8/sdk

      Type alias EventMap

      EventMap: Record<string, unknown>

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index._internal_.EventReceiver.html b/docs/types/index._internal_.EventReceiver.html deleted file mode 100644 index ce5c41df..00000000 --- a/docs/types/index._internal_.EventReceiver.html +++ /dev/null @@ -1 +0,0 @@ -EventReceiver | @camunda8/sdk

      Type alias EventReceiver

      EventReceiver: (() => void)

      Type declaration

        • (): void

        • Returns void

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index._internal_.GrpcConnectionProfile.html b/docs/types/index._internal_.GrpcConnectionProfile.html deleted file mode 100644 index 51a45075..00000000 --- a/docs/types/index._internal_.GrpcConnectionProfile.html +++ /dev/null @@ -1 +0,0 @@ -GrpcConnectionProfile | @camunda8/sdk

      Type alias GrpcConnectionProfile

      GrpcConnectionProfile: "CAMUNDA_CLOUD" | "VANILLA"

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index._internal_.JSON.html b/docs/types/index._internal_.JSON.html deleted file mode 100644 index 6b4346de..00000000 --- a/docs/types/index._internal_.JSON.html +++ /dev/null @@ -1 +0,0 @@ -JSON | @camunda8/sdk

      Type alias JSON

      JSON: string | number | boolean | JSON[] | JSONDoc[]

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index._internal_.JSONDoc-1.html b/docs/types/index._internal_.JSONDoc-1.html deleted file mode 100644 index 19b52f6c..00000000 --- a/docs/types/index._internal_.JSONDoc-1.html +++ /dev/null @@ -1 +0,0 @@ -JSONDoc | @camunda8/sdk

      Type alias JSONDoc

      JSONDoc: {
          [key: string]: string | boolean | number | JSONDoc;
      }

      Type declaration

      • [key: string]: string | boolean | number | JSONDoc

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index._internal_.LogFn.html b/docs/types/index._internal_.LogFn.html deleted file mode 100644 index 2bc5a7b9..00000000 --- a/docs/types/index._internal_.LogFn.html +++ /dev/null @@ -1 +0,0 @@ -LogFn | @camunda8/sdk

      Type alias LogFn

      LogFn: ((logMessage) => void)

      Type declaration

        • (logMessage): void

        • Parameters

          • logMessage: string

          Returns void

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index._internal_.State.html b/docs/types/index._internal_.State.html deleted file mode 100644 index 779ed26d..00000000 --- a/docs/types/index._internal_.State.html +++ /dev/null @@ -1 +0,0 @@ -State | @camunda8/sdk

      Type alias State

      State: "ERROR" | "CONNECTED" | "UNKNOWN"

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/index._internal_.TokenGrantAudienceType.html b/docs/types/index._internal_.TokenGrantAudienceType.html deleted file mode 100644 index d8bb091e..00000000 --- a/docs/types/index._internal_.TokenGrantAudienceType.html +++ /dev/null @@ -1 +0,0 @@ -TokenGrantAudienceType | @camunda8/sdk

      Type alias TokenGrantAudienceType

      TokenGrantAudienceType: "OPERATE" | "ZEEBE" | "OPTIMIZE" | "TASKLIST" | "CONSOLE" | "MODELER"

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/zeebe_types.ConnectionErrorHandler.html b/docs/types/zeebe_types.ConnectionErrorHandler.html deleted file mode 100644 index 9b497070..00000000 --- a/docs/types/zeebe_types.ConnectionErrorHandler.html +++ /dev/null @@ -1 +0,0 @@ -ConnectionErrorHandler | @camunda8/sdk

      Type alias ConnectionErrorHandler

      ConnectionErrorHandler: ((error?) => void)

      Type declaration

        • (error?): void

        • Parameters

          • Optional error: unknown

          Returns void

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/zeebe_types.Deployment.html b/docs/types/zeebe_types.Deployment.html deleted file mode 100644 index 8046c9ee..00000000 --- a/docs/types/zeebe_types.Deployment.html +++ /dev/null @@ -1 +0,0 @@ -Deployment | @camunda8/sdk

      Type alias Deployment

      Deployment: ProcessDeployment | DecisionDeployment | DecisionRequirementsDeployment | FormDeployment

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/zeebe_types.ErrorJobOutcome.html b/docs/types/zeebe_types.ErrorJobOutcome.html deleted file mode 100644 index b6855f20..00000000 --- a/docs/types/zeebe_types.ErrorJobOutcome.html +++ /dev/null @@ -1 +0,0 @@ -ErrorJobOutcome | @camunda8/sdk

      Type alias ErrorJobOutcome

      ErrorJobOutcome: ((errorCode, errorMessage?) => Promise<JOB_ACTION_ACKNOWLEDGEMENT>)

      Type declaration

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/zeebe_types.EvaluateDecisionRequest.html b/docs/types/zeebe_types.EvaluateDecisionRequest.html deleted file mode 100644 index 411ddf11..00000000 --- a/docs/types/zeebe_types.EvaluateDecisionRequest.html +++ /dev/null @@ -1,18 +0,0 @@ -EvaluateDecisionRequest | @camunda8/sdk

      Type alias EvaluateDecisionRequest

      EvaluateDecisionRequest: {
          decisionKey: string;
          tenantId?: string;
          variables: JSONDoc;
      } | {
          decisionId: string;
          tenantId?: string;
          variables: JSONDoc;
      }

      Type declaration

      • decisionKey: string

        the unique key identifying the decision to be evaluated (e.g. returned -from a decision in the DeployResourceResponse message)

        -
      • Optional tenantId?: string

        the tenant identifier of the decision

        -
      • variables: JSONDoc

        JSON document that will instantiate the variables for the decision to be -evaluated; it must be a JSON object, as variables will be mapped in a -key-value fashion, e.g. { "a": 1, "b": 2 } will create two variables, -named "a" and "b" respectively, with their associated values. -[{ "a": 1, "b": 2 }] would not be a valid argument, as the root of the -JSON document is an array and not an object.

        -

      Type declaration

      • decisionId: string

        the ID of the decision to be evaluated

        -
      • Optional tenantId?: string

        the tenant identifier of the decision

        -
      • variables: JSONDoc

        JSON document that will instantiate the variables for the decision to be -evaluated; it must be a JSON object, as variables will be mapped in a -key-value fashion, e.g. { "a": 1, "b": 2 } will create two variables, -named "a" and "b" respectively, with their associated values. -[{ "a": 1, "b": 2 }] would not be a valid argument, as the root of the -JSON document is an array and not an object.

        -

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/zeebe_types.JOB_ACTION_ACKNOWLEDGEMENT.html b/docs/types/zeebe_types.JOB_ACTION_ACKNOWLEDGEMENT.html deleted file mode 100644 index 833530b7..00000000 --- a/docs/types/zeebe_types.JOB_ACTION_ACKNOWLEDGEMENT.html +++ /dev/null @@ -1 +0,0 @@ -JOB_ACTION_ACKNOWLEDGEMENT | @camunda8/sdk

      Type alias JOB_ACTION_ACKNOWLEDGEMENT

      JOB_ACTION_ACKNOWLEDGEMENT: typeof JOB_ACTION_ACKNOWLEDGEMENT

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/zeebe_types.JSON.html b/docs/types/zeebe_types.JSON.html deleted file mode 100644 index e23118ae..00000000 --- a/docs/types/zeebe_types.JSON.html +++ /dev/null @@ -1 +0,0 @@ -JSON | @camunda8/sdk

      Type alias JSON

      JSON: string | number | boolean | JSON[] | JSONDoc[] | JSONDoc

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/zeebe_types.Loglevel.html b/docs/types/zeebe_types.Loglevel.html deleted file mode 100644 index cd63f330..00000000 --- a/docs/types/zeebe_types.Loglevel.html +++ /dev/null @@ -1 +0,0 @@ -Loglevel | @camunda8/sdk

      Type alias Loglevel

      Loglevel: "INFO" | "DEBUG" | "NONE" | "ERROR"

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/zeebe_types.ModifyProcessInstanceResponse.html b/docs/types/zeebe_types.ModifyProcessInstanceResponse.html deleted file mode 100644 index 547542dd..00000000 --- a/docs/types/zeebe_types.ModifyProcessInstanceResponse.html +++ /dev/null @@ -1 +0,0 @@ -ModifyProcessInstanceResponse | @camunda8/sdk

      Type alias ModifyProcessInstanceResponse

      ModifyProcessInstanceResponse: Record<string, never>

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/zeebe_types.MustReturnJobActionAcknowledgement.html b/docs/types/zeebe_types.MustReturnJobActionAcknowledgement.html deleted file mode 100644 index fc49bfba..00000000 --- a/docs/types/zeebe_types.MustReturnJobActionAcknowledgement.html +++ /dev/null @@ -1 +0,0 @@ -MustReturnJobActionAcknowledgement | @camunda8/sdk

      Type alias MustReturnJobActionAcknowledgement

      MustReturnJobActionAcknowledgement: JOB_ACTION_ACKNOWLEDGEMENT | Promise<JOB_ACTION_ACKNOWLEDGEMENT>

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/zeebe_types.OperationOptions.html b/docs/types/zeebe_types.OperationOptions.html deleted file mode 100644 index f242e600..00000000 --- a/docs/types/zeebe_types.OperationOptions.html +++ /dev/null @@ -1 +0,0 @@ -OperationOptions | @camunda8/sdk

      Type alias OperationOptions

      OperationOptions: OperationOptionsWithRetry | OperationOptionsNoRetry

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/types/zeebe_types.ZBWorkerTaskHandler.html b/docs/types/zeebe_types.ZBWorkerTaskHandler.html deleted file mode 100644 index 94739444..00000000 --- a/docs/types/zeebe_types.ZBWorkerTaskHandler.html +++ /dev/null @@ -1 +0,0 @@ -ZBWorkerTaskHandler | @camunda8/sdk

      Type alias ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

      ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>: ((job, worker) => MustReturnJobActionAcknowledgement)

      Type Parameters

      Type declaration

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/variables/index.Dto.html b/docs/variables/index.Dto.html deleted file mode 100644 index 8741cf1b..00000000 --- a/docs/variables/index.Dto.html +++ /dev/null @@ -1,10 +0,0 @@ -Dto | @camunda8/sdk

      Variable DtoConst

      Dto: {
          BigIntValue: ((target, propertKey) => void);
          ChildDto: ((childClass) => ((target, propertyKey) => void));
          Int64String: ((target, propertyKey) => void);
          LosslessDto: typeof LosslessDto;
      } = ...

      Type declaration

      • BigIntValue: ((target, propertKey) => void)
          • (target, propertKey): void

          • Decorate Dto bigint fields as @BigInt to specify that the JSON number property should be parsed as a bigint.

            -

            Parameters

            • target: any
            • propertKey: string | symbol

            Returns void

            Example

            class MyDto extends LosslessDto {
              @Int64String
              int64NumberField!: string
              @BigIntValue
              bigintField!: bigint
              @ChildDto(MyChildDto)
              childDtoField!: MyChildDto
              normalField!: string
              normalNumberField!: number
              maybePresentField?: string
            }
-
            -
      • ChildDto: ((childClass) => ((target, propertyKey) => void))
          • (childClass): ((target, propertyKey) => void)

          • Decorate a Dto object field as @ChildDto to specify that the JSON object property should be parsed as a child Dto.

            -

            Parameters

            • childClass: any

            Returns ((target, propertyKey) => void)

              • (target, propertyKey): void

              • Parameters

                • target: any
                • propertyKey: string | symbol

                Returns void

            Example


            class MyChildDto extends LosslessDto {
              someField!: string
            }

            class MyDto extends LosslessDto {
              @Int64String
              int64NumberField!: string
              @BigIntValue
              bigintField!: bigint
              @ChildDto(MyChildDto)
              childDtoField!: MyChildDto
              normalField!: string
              normalNumberField!: number
              maybePresentField?: string
            }
-
            -
      • Int64String: ((target, propertyKey) => void)
          • (target, propertyKey): void

          • Decorate Dto string fields as @Int64String to specify that the JSON number property should be parsed as a string.

            -

            Parameters

            • target: any
            • propertyKey: string | symbol

            Returns void

            Example

            class MyDto extends LosslessDto {
              @Int64String
              int64NumberField!: string
              @BigIntValue
              bigintField!: bigint
              @ChildDto(MyChildDto)
              childDtoField!: MyChildDto
              normalField!: string
              normalNumberField!: number
              maybePresentField?: string
            }
-
            -
      • LosslessDto: typeof LosslessDto

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/variables/index.Zeebe.Logging.html b/docs/variables/index.Zeebe.Logging.html deleted file mode 100644 index 354031f6..00000000 --- a/docs/variables/index.Zeebe.Logging.html +++ /dev/null @@ -1,23 +0,0 @@ -Logging | @camunda8/sdk

      Variable LoggingConst

      Logging: {
          ZBJsonLogger: {
              debug: ((message?, ...optionalParams) => void);
              error: ((message?, ...optionalParams) => void);
              info: ((message?, ...optionalParams) => void);
          };
          ZBLogger: typeof ZBLogger;
          ZBSimpleLogger: Logger;
      } = ...

      Type declaration

      • ZBJsonLogger: {
            debug: ((message?, ...optionalParams) => void);
            error: ((message?, ...optionalParams) => void);
            info: ((message?, ...optionalParams) => void);
        }
        • debug: ((message?, ...optionalParams) => void)
            • (message?, ...optionalParams): void

            • Prints to stdout with newline. Multiple arguments can be passed, with the -first used as the primary message and all additional used as substitution -values similar to printf(3) (the arguments are all passed to util.format()).

              -
              const count = 5;
              console.log('count: %d', count);
              // Prints: count: 5, to stdout
              console.log('count:', count);
              // Prints: count: 5, to stdout
-
              -

              See util.format() for more information.

              -

              Parameters

              • Optional message: any
              • Rest ...optionalParams: any[]

              Returns void

              Since

              v0.1.100

              -
        • error: ((message?, ...optionalParams) => void)
            • (message?, ...optionalParams): void

            • Prints to stderr with newline. Multiple arguments can be passed, with the -first used as the primary message and all additional used as substitution -values similar to printf(3) (the arguments are all passed to util.format()).

              -
              const code = 5;
              console.error('error #%d', code);
              // Prints: error #5, to stderr
              console.error('error', code);
              // Prints: error 5, to stderr
-
              -

              If formatting elements (e.g. %d) are not found in the first string then util.inspect() is called on each argument and the resulting string -values are concatenated. See util.format() for more information.

              -

              Parameters

              • Optional message: any
              • Rest ...optionalParams: any[]

              Returns void

              Since

              v0.1.100

              -
        • info: ((message?, ...optionalParams) => void)
            • (message?, ...optionalParams): void

            • Prints to stdout with newline. Multiple arguments can be passed, with the -first used as the primary message and all additional used as substitution -values similar to printf(3) (the arguments are all passed to util.format()).

              -
              const count = 5;
              console.log('count: %d', count);
              // Prints: count: 5, to stdout
              console.log('count:', count);
              // Prints: count: 5, to stdout
-
              -

              See util.format() for more information.

              -

              Parameters

              • Optional message: any
              • Rest ...optionalParams: any[]

              Returns void

              Since

              v0.1.100

              -
      • ZBLogger: typeof ZBLogger
      • ZBSimpleLogger: Logger

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/variables/index.Zeebe.Types.JOB_ACTION_ACKNOWLEDGEMENT.html b/docs/variables/index.Zeebe.Types.JOB_ACTION_ACKNOWLEDGEMENT.html deleted file mode 100644 index e147bbef..00000000 --- a/docs/variables/index.Zeebe.Types.JOB_ACTION_ACKNOWLEDGEMENT.html +++ /dev/null @@ -1 +0,0 @@ -JOB_ACTION_ACKNOWLEDGEMENT | @camunda8/sdk

      Variable JOB_ACTION_ACKNOWLEDGEMENT

      JOB_ACTION_ACKNOWLEDGEMENT: "JOB_ACTION_ACKNOWLEDGEMENT" = ...

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/variables/index._internal_.ConnectionStatusEvent.html b/docs/variables/index._internal_.ConnectionStatusEvent.html deleted file mode 100644 index 89e5780c..00000000 --- a/docs/variables/index._internal_.ConnectionStatusEvent.html +++ /dev/null @@ -1 +0,0 @@ -ConnectionStatusEvent | @camunda8/sdk

      Variable ConnectionStatusEventConst

      ConnectionStatusEvent: {
          close: "close";
          connectionError: "connectionError";
          ready: "ready";
          unknown: "unknown";
      } = ...

      Type declaration

      • close: "close"
      • connectionError: "connectionError"
      • ready: "ready"
      • unknown: "unknown"

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/docs/variables/zeebe_types.JOB_ACTION_ACKNOWLEDGEMENT-1.html b/docs/variables/zeebe_types.JOB_ACTION_ACKNOWLEDGEMENT-1.html deleted file mode 100644 index cff380a4..00000000 --- a/docs/variables/zeebe_types.JOB_ACTION_ACKNOWLEDGEMENT-1.html +++ /dev/null @@ -1 +0,0 @@ -JOB_ACTION_ACKNOWLEDGEMENT | @camunda8/sdk

      Variable JOB_ACTION_ACKNOWLEDGEMENTConst

      JOB_ACTION_ACKNOWLEDGEMENT: "JOB_ACTION_ACKNOWLEDGEMENT" = ...

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file diff --git a/lerna.json b/lerna.json deleted file mode 100644 index d5ef5fbf..00000000 --- a/lerna.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "$schema": "node_modules/lerna/schemas/lerna-schema.json", - "version": "8.4.0", - "packages": [ - "packages/*" - ], - "command": { - "publish": { - "registry": "https://registry.npmjs.org", - "conventionalCommits": true - }, - "version": { - "conventionalCommits": true - } - }, - "npmClient": "npm" -} diff --git a/package-lock.json b/package-lock.json index 1149966b..3e1cff99 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@camunda8/sdk", - "version": "8.3.0", + "version": "8.5.0-alpha.6", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@camunda8/sdk", - "version": "8.3.0", + "version": "8.5.0-alpha.6", "license": "Apache 2.0", "dependencies": { "@grpc/grpc-js": "1.9.7", @@ -54,8 +54,10 @@ "lint-staged": "^15.2.0", "prettier": "^3.1.1", "semantic-release": "^22.0.12", + "shx": "^0.3.4", "ts-jest": "^29.1.1", "tsconfig-paths": "^4.2.0", + "tsd": "^0.31.0", "typedoc": "^0.25.9", "typedoc-plugin-include-example": "^1.2.0", "typedoc-plugin-missing-exports": "^2.2.0", @@ -1260,6 +1262,32 @@ "node": ">=8" } }, + "node_modules/@cspotcode/source-map-support": { + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz", + "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==", + "dev": true, + "optional": true, + "peer": true, + "dependencies": { + "@jridgewell/trace-mapping": "0.3.9" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@cspotcode/source-map-support/node_modules/@jridgewell/trace-mapping": { + "version": "0.3.9", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz", + "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==", + "dev": true, + "optional": true, + "peer": true, + "dependencies": { + "@jridgewell/resolve-uri": "^3.0.3", + "@jridgewell/sourcemap-codec": "^1.4.10" + } + }, "node_modules/@eslint-community/eslint-utils": { "version": "4.4.0", "dev": true, @@ -3385,6 +3413,47 @@ "node": ">=10" } }, + "node_modules/@tsconfig/node10": { + "version": "1.0.11", + "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.11.tgz", + "integrity": "sha512-DcRjDCujK/kCk/cUe8Xz8ZSpm8mS3mNNpta+jGCA6USEDfktlNvm1+IuZ9eTcDbNk41BHwpHHeW+N1lKCz4zOw==", + "dev": true, + "optional": true, + "peer": true + }, + "node_modules/@tsconfig/node12": { + "version": "1.0.11", + "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.11.tgz", + "integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==", + "dev": true, + "optional": true, + "peer": true + }, + "node_modules/@tsconfig/node14": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz", + "integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==", + "dev": true, + "optional": true, + "peer": true + }, + "node_modules/@tsconfig/node16": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.4.tgz", + "integrity": "sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==", + "dev": true, + "optional": true, + "peer": true + }, + "node_modules/@tsd/typescript": { + "version": "5.4.4", + "resolved": "https://registry.npmjs.org/@tsd/typescript/-/typescript-5.4.4.tgz", + "integrity": "sha512-sqE6Rz9UNHBuCtuREo/PwsuUaegP1KDSfxMd+9K1qPpt7XO8BmkIImUp7zAqyvwXWUHs+sj6osEkkpyE0tFgfA==", + "dev": true, + "engines": { + "node": ">=14.17" + } + }, "node_modules/@types/babel__core": { "version": "7.20.5", "dev": true, @@ -3440,6 +3509,24 @@ "@types/ms": "*" } }, + "node_modules/@types/eslint": { + "version": "8.56.7", + "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-8.56.7.tgz", + "integrity": "sha512-SjDvI/x3zsZnOkYZ3lCt9lOZWZLB2jIlNKz+LBgCtDurK0JZcwucxYHn1w2BJkD34dgX9Tjnak0txtq4WTggEA==", + "dev": true, + "optional": true, + "peer": true, + "dependencies": { + "@types/estree": "*", + "@types/json-schema": "*" + } + }, + "node_modules/@types/estree": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.5.tgz", + "integrity": "sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==", + "dev": true + }, "node_modules/@types/graceful-fs": { "version": "4.1.9", "dev": true, @@ -3893,6 +3980,17 @@ "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" } }, + "node_modules/acorn-walk": { + "version": "8.3.2", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.2.tgz", + "integrity": "sha512-cjkyv4OtNCIeqhHrfS81QWXoCBPExR/J62oyEqepVw8WaQeSqpW2uhuLPh1m9eWhDuOo/jUXVTlifvesOWp/4A==", + "dev": true, + "optional": true, + "peer": true, + "engines": { + "node": ">=0.4.0" + } + }, "node_modules/aggregate-error": { "version": "3.1.0", "dev": true, @@ -3981,6 +4079,14 @@ "node": ">= 8" } }, + "node_modules/arg": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", + "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==", + "dev": true, + "optional": true, + "peer": true + }, "node_modules/argparse": { "version": "1.0.10", "dev": true, @@ -5372,6 +5478,14 @@ "node": ">=8" } }, + "node_modules/create-require": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz", + "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", + "dev": true, + "optional": true, + "peer": true + }, "node_modules/cross-spawn": { "version": "7.0.3", "dev": true, @@ -5784,6 +5898,17 @@ "node": ">=8" } }, + "node_modules/diff": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", + "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", + "dev": true, + "optional": true, + "peer": true, + "engines": { + "node": ">=0.3.1" + } + }, "node_modules/diff-sequences": { "version": "29.6.3", "dev": true, @@ -6332,6 +6457,108 @@ "eslint": ">=7.0.0" } }, + "node_modules/eslint-formatter-pretty": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/eslint-formatter-pretty/-/eslint-formatter-pretty-4.1.0.tgz", + "integrity": "sha512-IsUTtGxF1hrH6lMWiSl1WbGaiP01eT6kzywdY1U+zLc0MP+nwEnUiS9UI8IaOTUhTeQJLlCEWIbXINBH4YJbBQ==", + "dev": true, + "dependencies": { + "@types/eslint": "^7.2.13", + "ansi-escapes": "^4.2.1", + "chalk": "^4.1.0", + "eslint-rule-docs": "^1.1.5", + "log-symbols": "^4.0.0", + "plur": "^4.0.0", + "string-width": "^4.2.0", + "supports-hyperlinks": "^2.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint-formatter-pretty/node_modules/@types/eslint": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-7.29.0.tgz", + "integrity": "sha512-VNcvioYDH8/FxaeTKkM4/TiTwt6pBV9E3OfGmvaw8tPl0rrHCJ4Ll15HRT+pMiFAf/MLQvAzC+6RzUMEL9Ceng==", + "dev": true, + "dependencies": { + "@types/estree": "*", + "@types/json-schema": "*" + } + }, + "node_modules/eslint-formatter-pretty/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/eslint-formatter-pretty/node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/eslint-formatter-pretty/node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/eslint-formatter-pretty/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "node_modules/eslint-formatter-pretty/node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/eslint-formatter-pretty/node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/eslint-import-resolver-node": { "version": "0.3.9", "dev": true, @@ -6481,6 +6708,12 @@ } } }, + "node_modules/eslint-rule-docs": { + "version": "1.1.235", + "resolved": "https://registry.npmjs.org/eslint-rule-docs/-/eslint-rule-docs-1.1.235.tgz", + "integrity": "sha512-+TQ+x4JdTnDoFEXXb3fDvfGOwnyNV7duH8fXWTPD1ieaBmB8omj7Gw/pMBBu4uI2uJCCU8APDaQJzWuXnTsH4A==", + "dev": true + }, "node_modules/eslint-scope": { "version": "7.2.2", "dev": true, @@ -7767,6 +8000,15 @@ "node": ">= 0.4" } }, + "node_modules/interpret": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/interpret/-/interpret-1.4.0.tgz", + "integrity": "sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA==", + "dev": true, + "engines": { + "node": ">= 0.10" + } + }, "node_modules/into-stream": { "version": "7.0.0", "dev": true, @@ -7782,6 +8024,15 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/irregular-plurals": { + "version": "3.5.0", + "resolved": "https://registry.npmjs.org/irregular-plurals/-/irregular-plurals-3.5.0.tgz", + "integrity": "sha512-1ANGLZ+Nkv1ptFb2pa8oG8Lem4krflKuX/gINiHJHjJUKaJHk/SXk5x6K3J+39/p0h1RQ2saROclJJ+QLvETCQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/is-array-buffer": { "version": "3.0.2", "dev": true, @@ -10805,76 +11056,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/meow/node_modules/hosted-git-info": { - "version": "2.8.9", - "dev": true, - "license": "ISC" - }, - "node_modules/meow/node_modules/read-pkg": { - "version": "5.2.0", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/normalize-package-data": "^2.4.0", - "normalize-package-data": "^2.5.0", - "parse-json": "^5.0.0", - "type-fest": "^0.6.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/meow/node_modules/read-pkg-up": { - "version": "7.0.1", - "dev": true, - "license": "MIT", - "dependencies": { - "find-up": "^4.1.0", - "read-pkg": "^5.2.0", - "type-fest": "^0.8.1" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/meow/node_modules/read-pkg-up/node_modules/type-fest": { - "version": "0.8.1", - "dev": true, - "license": "(MIT OR CC0-1.0)", - "engines": { - "node": ">=8" - } - }, - "node_modules/meow/node_modules/read-pkg/node_modules/normalize-package-data": { - "version": "2.5.0", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "hosted-git-info": "^2.1.4", - "resolve": "^1.10.0", - "semver": "2 || 3 || 4 || 5", - "validate-npm-package-license": "^3.0.1" - } - }, - "node_modules/meow/node_modules/read-pkg/node_modules/type-fest": { - "version": "0.6.0", - "dev": true, - "license": "(MIT OR CC0-1.0)", - "engines": { - "node": ">=8" - } - }, - "node_modules/meow/node_modules/semver": { - "version": "5.7.2", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver" - } - }, "node_modules/meow/node_modules/type-fest": { "version": "0.18.1", "dev": true, @@ -14752,6 +14933,21 @@ "node": ">=8" } }, + "node_modules/plur": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/plur/-/plur-4.0.0.tgz", + "integrity": "sha512-4UGewrYgqDFw9vV6zNV+ADmPAUAfJPKtGvb/VdpQAx25X5f3xXdGdyOEVFwkl8Hl/tl7+xbeHqSEM+D5/TirUg==", + "dev": true, + "dependencies": { + "irregular-plurals": "^3.2.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/prelude-ls": { "version": "1.2.1", "dev": true, @@ -14955,6 +15151,83 @@ "dev": true, "license": "MIT" }, + "node_modules/read-pkg": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-5.2.0.tgz", + "integrity": "sha512-Ug69mNOpfvKDAc2Q8DRpMjjzdtrnv9HcSMX+4VsZxD1aZ6ZzrIE7rlzXBtWTyhULSMKg076AW6WR5iZpD0JiOg==", + "dev": true, + "dependencies": { + "@types/normalize-package-data": "^2.4.0", + "normalize-package-data": "^2.5.0", + "parse-json": "^5.0.0", + "type-fest": "^0.6.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/read-pkg-up": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-7.0.1.tgz", + "integrity": "sha512-zK0TB7Xd6JpCLmlLmufqykGE+/TlOePD6qKClNW7hHDKFh/J7/7gCWGR7joEQEW1bKq3a3yUZSObOoWLFQ4ohg==", + "dev": true, + "dependencies": { + "find-up": "^4.1.0", + "read-pkg": "^5.2.0", + "type-fest": "^0.8.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/read-pkg-up/node_modules/type-fest": { + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.8.1.tgz", + "integrity": "sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/read-pkg/node_modules/hosted-git-info": { + "version": "2.8.9", + "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.9.tgz", + "integrity": "sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw==", + "dev": true + }, + "node_modules/read-pkg/node_modules/normalize-package-data": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-2.5.0.tgz", + "integrity": "sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA==", + "dev": true, + "dependencies": { + "hosted-git-info": "^2.1.4", + "resolve": "^1.10.0", + "semver": "2 || 3 || 4 || 5", + "validate-npm-package-license": "^3.0.1" + } + }, + "node_modules/read-pkg/node_modules/semver": { + "version": "5.7.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.2.tgz", + "integrity": "sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g==", + "dev": true, + "bin": { + "semver": "bin/semver" + } + }, + "node_modules/read-pkg/node_modules/type-fest": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.6.0.tgz", + "integrity": "sha512-q+MB8nYR1KDLrgr4G5yemftpMC7/QLqVndBmEEdqzmNj5dcFOO4Oo8qlwZE3ULT3+Zim1F8Kq4cBnikNhlCMlg==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/readable-stream": { "version": "2.3.8", "dev": true, @@ -14969,6 +15242,18 @@ "util-deprecate": "~1.0.1" } }, + "node_modules/rechoir": { + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz", + "integrity": "sha512-HFM8rkZ+i3zrV+4LQjwQ0W+ez98pApMGM3HUrN04j3CqzPOzl9nmP15Y8YXNm8QHGv/eacOVEjqhmWpkRV0NAw==", + "dev": true, + "dependencies": { + "resolve": "^1.1.6" + }, + "engines": { + "node": ">= 0.10" + } + }, "node_modules/redent": { "version": "3.0.0", "dev": true, @@ -15796,6 +16081,23 @@ "node": ">=8" } }, + "node_modules/shelljs": { + "version": "0.8.5", + "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.5.tgz", + "integrity": "sha512-TiwcRcrkhHvbrZbnRcFYMLl30Dfov3HKqzp5tO5b4pt6G/SezKcYhmDg15zXVBswHmctSAQKznqNW2LO5tTDow==", + "dev": true, + "dependencies": { + "glob": "^7.0.0", + "interpret": "^1.0.0", + "rechoir": "^0.6.2" + }, + "bin": { + "shjs": "bin/shjs" + }, + "engines": { + "node": ">=4" + } + }, "node_modules/shiki": { "version": "0.14.7", "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.7.tgz", @@ -15808,6 +16110,22 @@ "vscode-textmate": "^8.0.0" } }, + "node_modules/shx": { + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/shx/-/shx-0.3.4.tgz", + "integrity": "sha512-N6A9MLVqjxZYcVn8hLmtneQWIJtp8IKzMP4eMnx+nqkvXoqinUPCbUFLp2UcWTEIUONhlk0ewxr/jaVGlc+J+g==", + "dev": true, + "dependencies": { + "minimist": "^1.2.3", + "shelljs": "^0.8.5" + }, + "bin": { + "shx": "lib/cli.js" + }, + "engines": { + "node": ">=6" + } + }, "node_modules/side-channel": { "version": "1.0.4", "dev": true, @@ -16181,6 +16499,40 @@ "node": ">=4" } }, + "node_modules/supports-hyperlinks": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/supports-hyperlinks/-/supports-hyperlinks-2.3.0.tgz", + "integrity": "sha512-RpsAZlpWcDwOPQA22aCH4J0t7L8JmAvsCxfOSEwm7cQs3LshN36QaTkwd70DnBOXDWGssw2eUoc8CaRWT0XunA==", + "dev": true, + "dependencies": { + "has-flag": "^4.0.0", + "supports-color": "^7.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/supports-hyperlinks/node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/supports-hyperlinks/node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/supports-preserve-symlinks-flag": { "version": "1.0.0", "dev": true, @@ -16490,6 +16842,51 @@ "node": ">=12" } }, + "node_modules/ts-node": { + "version": "10.9.2", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz", + "integrity": "sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==", + "dev": true, + "optional": true, + "peer": true, + "dependencies": { + "@cspotcode/source-map-support": "^0.8.0", + "@tsconfig/node10": "^1.0.7", + "@tsconfig/node12": "^1.0.7", + "@tsconfig/node14": "^1.0.0", + "@tsconfig/node16": "^1.0.2", + "acorn": "^8.4.1", + "acorn-walk": "^8.1.1", + "arg": "^4.1.0", + "create-require": "^1.1.0", + "diff": "^4.0.1", + "make-error": "^1.1.1", + "v8-compile-cache-lib": "^3.0.1", + "yn": "3.1.1" + }, + "bin": { + "ts-node": "dist/bin.js", + "ts-node-cwd": "dist/bin-cwd.js", + "ts-node-esm": "dist/bin-esm.js", + "ts-node-script": "dist/bin-script.js", + "ts-node-transpile-only": "dist/bin-transpile.js", + "ts-script": "dist/bin-script-deprecated.js" + }, + "peerDependencies": { + "@swc/core": ">=1.2.50", + "@swc/wasm": ">=1.2.50", + "@types/node": "*", + "typescript": ">=2.7" + }, + "peerDependenciesMeta": { + "@swc/core": { + "optional": true + }, + "@swc/wasm": { + "optional": true + } + } + }, "node_modules/tsconfig-paths": { "version": "4.2.0", "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-4.2.0.tgz", @@ -16513,6 +16910,65 @@ "node": ">=4" } }, + "node_modules/tsd": { + "version": "0.31.0", + "resolved": "https://registry.npmjs.org/tsd/-/tsd-0.31.0.tgz", + "integrity": "sha512-yjBiQ5n8OMv/IZOuhDjBy0ZLCoJ7rky/RxRh5W4sJ0oNNCU/kf6s3puPAkGNi59PptDdkcpUm+RsKSdjR2YbNg==", + "dev": true, + "dependencies": { + "@tsd/typescript": "~5.4.3", + "eslint-formatter-pretty": "^4.1.0", + "globby": "^11.0.1", + "jest-diff": "^29.0.3", + "meow": "^9.0.0", + "path-exists": "^4.0.0", + "read-pkg-up": "^7.0.0" + }, + "bin": { + "tsd": "dist/cli.js" + }, + "engines": { + "node": ">=14.16" + } + }, + "node_modules/tsd/node_modules/meow": { + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/meow/-/meow-9.0.0.tgz", + "integrity": "sha512-+obSblOQmRhcyBt62furQqRAQpNyWXo8BuQ5bN7dG8wmwQ+vwHKp/rCFD4CrTP8CsDQD1sjoZ94K417XEUk8IQ==", + "dev": true, + "dependencies": { + "@types/minimist": "^1.2.0", + "camelcase-keys": "^6.2.2", + "decamelize": "^1.2.0", + "decamelize-keys": "^1.1.0", + "hard-rejection": "^2.1.0", + "minimist-options": "4.1.0", + "normalize-package-data": "^3.0.0", + "read-pkg-up": "^7.0.1", + "redent": "^3.0.0", + "trim-newlines": "^3.0.0", + "type-fest": "^0.18.0", + "yargs-parser": "^20.2.3" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/tsd/node_modules/type-fest": { + "version": "0.18.1", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.18.1.tgz", + "integrity": "sha512-OIAYXk8+ISY+qTOwkHtKqzAuxchoMiD9Udx+FSGQDuiRR+PJKJHc2NJAXlbhkGwTt/4/nKZxELY1w3ReWOL8mw==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/tslib": { "version": "2.6.2", "dev": true, @@ -16965,6 +17421,14 @@ "uuid": "dist/bin/uuid" } }, + "node_modules/v8-compile-cache-lib": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz", + "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==", + "dev": true, + "optional": true, + "peer": true + }, "node_modules/v8-to-istanbul": { "version": "9.1.3", "dev": true, @@ -17156,6 +17620,17 @@ "node": ">=12" } }, + "node_modules/yn": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz", + "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==", + "dev": true, + "optional": true, + "peer": true, + "engines": { + "node": ">=6" + } + }, "node_modules/yocto-queue": { "version": "0.1.0", "dev": true, diff --git a/package.json b/package.json index e4e06729..f641b62f 100644 --- a/package.json +++ b/package.json @@ -1,26 +1,24 @@ { "name": "@camunda8/sdk", - "version": "8.3.0", + "version": "8.5.0-alpha.6", "description": "", "main": "dist/index.js", "scripts": { - "build": "npm run clean && npm run compile", + "build": "npm run clean && npm run compile && shx mkdir dist/proto && shx cp src/proto/zeebe.proto dist/proto/", "clean": "rm -rf ./dist && rm -f ./tsconfig.tsbuildinfo", "compile": "tsc --project tsconfig.json", "docs": "rm -rf ./docs && typedoc", - "test": "jest --detectOpenHandles --testPathIgnorePatterns integration local-integration disconnection multitenancy", + "test": "CAMUNDA_UNIT_TEST=true jest --detectOpenHandles --testPathIgnorePatterns integration --testPathIgnorePatterns local-integration --testPathIgnorePatterns disconnection --testPathIgnorePatterns multitenancy --testPathIgnorePatterns __tests__/config", "test:integration": "jest --runInBand --testPathIgnorePatterns disconnection --testPathIgnorePatterns __tests__/config --testPathIgnorePatterns multitenancy --detectOpenHandles --verbose true -u", "test:multitenancy": "jest --runInBand --testPathIgnorePatterns disconnection --testPathIgnorePatterns admin --testPathIgnorePatterns __tests__/config - --detectOpenHandles --verbose true -u", "test:local": "jest --runInBand --verbose true --detectOpenHandles local-integration -u", "test:local-integration": "jest --runInBand --detectOpenHandles --verbose --testPathIgnorePatterns disconnection --testPathIgnorePatterns admin --testPathIgnorePatterns multitenancy --testPathIgnorePatterns __tests__/config -u", "test:docker": "jest --runInBand --testPathIgnorePatterns disconnection --testPathIgnorePatterns __tests__/config local-integration --detectOpenHandles --verbose true", "test:disconnect": "jest --runInBand --verbose true --detectOpenHandles --testPathIgnorePatterns __tests__/config disconnection", - "test&docs": "npm test && npm run docs", - "publish": "npm run build && npm run test && lerna publish", + "test:smoketest": "npm run build && node smoke-test/smoke-test.js && npx tsd --typings dist/", + "prepublishOnly": "npm run build && npm run test", "commit": "cz", - "publish:canary": "npm run build && npm run test && lerna publish --canary", "prepare": "husky install", - "prepublishOnly": "npm run build", "lint": "eslint 'src/**/*.{ts,tsx}'", "format": "prettier --write 'src/**/*.ts'" }, @@ -33,7 +31,7 @@ "license": "Apache 2.0", "repository": { "type": "git", - "url": "git+https://github.com/camunda-community-hub/camunda-8-js-sdk.git" + "url": "git+https://github.com/camunda/camunda-8-js-sdk.git" }, "husky": { "hooks": { @@ -57,19 +55,6 @@ } ] }, - "moduleNameMapper": { - "^lib$": "/src/lib", - "^oauth/(.*)$": "/src/oauth/$1", - "^operate/(.*)$": "/src/operate/$1", - "^operate$": "/src/operate", - "^utils$": "/src/utils", - "^oauth$": "/src/oauth", - "^tasklist$": "/src/tasklist", - "^optimize$": "/src/optimize", - "^modeler$": "/src/modeler", - "^admin$": "/src/admin", - "^zeebe$": "/src/zeebe" - }, "preset": "ts-jest", "testEnvironment": "node", "testPathIgnorePatterns": [ @@ -89,6 +74,9 @@ "prettier --write" ] }, + "tsd": { + "directory": "test-d" + }, "devDependencies": { "@commitlint/cli": "^18.4.3", "@commitlint/config-conventional": "^18.4.3", @@ -115,8 +103,10 @@ "lint-staged": "^15.2.0", "prettier": "^3.1.1", "semantic-release": "^22.0.12", + "shx": "^0.3.4", "ts-jest": "^29.1.1", "tsconfig-paths": "^4.2.0", + "tsd": "^0.31.0", "typedoc": "^0.25.9", "typedoc-plugin-include-example": "^1.2.0", "typedoc-plugin-missing-exports": "^2.2.0", diff --git a/release.config.js b/release.config.js new file mode 100644 index 00000000..d9d830ed --- /dev/null +++ b/release.config.js @@ -0,0 +1,49 @@ +// eslint-disable-next-line no-undef +module.exports = { + branches: [ + 'main', + { + name: 'alpha', + prerelease: true, + }, + ], + repositoryUrl: 'https://github.com/camunda/camunda-8-js-sdk.git', + plugins: [ + [ + '@semantic-release/commit-analyzer', + { + releaseRules: [ + { + type: 'feat', + release: 'patch', + }, + { + type: 'fix', + release: 'patch', + }, + { + type: 'release', + release: 'patch', + }, + { + type: 'minor', + release: 'minor', + }, + ], + }, + ], + + '@semantic-release/release-notes-generator', + '@semantic-release/changelog', + ['@semantic-release/npm', {}], + [ + '@semantic-release/git', + { + assets: ['package.json'], + message: + 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}', + }, + ], + '@semantic-release/git', + ], +} diff --git a/renovate.json b/renovate.json index 5d7d7027..a4892942 100644 --- a/renovate.json +++ b/renovate.json @@ -2,5 +2,8 @@ "$schema": "https://docs.renovatebot.com/renovate-schema.json", "extends": [ "config:recommended" + ], + "baseBranches": [ + "alpha" ] } \ No newline at end of file diff --git a/smoke-test/package-lock.json b/smoke-test/package-lock.json new file mode 100644 index 00000000..9ea68617 --- /dev/null +++ b/smoke-test/package-lock.json @@ -0,0 +1,29 @@ +{ + "name": "smoke-test", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "smoke-test", + "version": "1.0.0", + "license": "ISC", + "dependencies": { + "@types/node": "^20.12.5" + } + }, + "node_modules/@types/node": { + "version": "20.12.5", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.12.5.tgz", + "integrity": "sha512-BD+BjQ9LS/D8ST9p5uqBxghlN+S42iuNxjsUGjeZobe/ciXzk2qb1B6IXc6AnRLS+yFJRpN2IPEHMzwspfDJNw==", + "dependencies": { + "undici-types": "~5.26.4" + } + }, + "node_modules/undici-types": { + "version": "5.26.5", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz", + "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==" + } + } +} diff --git a/smoke-test/package.json b/smoke-test/package.json new file mode 100644 index 00000000..b1bff066 --- /dev/null +++ b/smoke-test/package.json @@ -0,0 +1,15 @@ +{ + "name": "smoke-test", + "version": "1.0.0", + "description": "", + "main": "smoke-test.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "keywords": [], + "author": "", + "license": "ISC", + "dependencies": { + "@types/node": "^20.12.5" + } +} diff --git a/smoke-test/smoke-test.js b/smoke-test/smoke-test.js new file mode 100644 index 00000000..5f574706 --- /dev/null +++ b/smoke-test/smoke-test.js @@ -0,0 +1,45 @@ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-var-requires */ +const { Camunda8 } = require('..') + +console.log('Running smoke test...') + +const camunda = new Camunda8({ + CAMUNDA_OAUTH_DISABLED: true, + ZEEBE_ADDRESS: 'localhost:26500', + ZEEBE_CLIENT_ID: 'zeebeClientId', + ZEEBE_CLIENT_SECRET: 'zeebeClientSecret', + CAMUNDA_CONSOLE_BASE_URL: 'http://localhost:8080', + CAMUNDA_MODELER_BASE_URL: 'http://localhost:8080', + CAMUNDA_TASKLIST_BASE_URL: 'http://localhost:8080', + CAMUNDA_OPERATE_BASE_URL: 'http://localhost:8080', + CAMUNDA_OPTIMIZE_BASE_URL: 'http://localhost:8080', +}) + +// console.log(camunda) + +const zeebe = camunda.getZeebeGrpcApiClient() + +// console.log(zeebe) + +const tasklist = camunda.getTasklistApiClient() + +// console.log(tasklist) + +const modeler = camunda.getModelerApiClient() + +// console.log(modeler) + +const optimize = camunda.getOptimizeApiClient() + +// console.log(optimize) + +const admin = camunda.getAdminApiClient() + +// console.log(admin) + +const operate = camunda.getOperateApiClient() + +// console.log(operate) + +console.log('Smoke test passed!') diff --git a/smoke-test/tsconfig.json b/smoke-test/tsconfig.json new file mode 100644 index 00000000..e260bf63 --- /dev/null +++ b/smoke-test/tsconfig.json @@ -0,0 +1,9 @@ +{ + "compilerOptions": { + "moduleResolution": "node", + "allowJs": true, + "checkJs": true, + "noEmit": true + }, + "include": ["*.js"] +} diff --git a/src/__tests__/admin/admin.spec.ts b/src/__tests__/admin/admin.spec.ts index 6d81efd8..69f5d9e1 100644 --- a/src/__tests__/admin/admin.spec.ts +++ b/src/__tests__/admin/admin.spec.ts @@ -1,6 +1,5 @@ -import { EnvironmentSetup } from 'lib' - import { AdminApiClient } from '../../admin/index' +import { EnvironmentSetup } from '../../lib' beforeAll(() => { EnvironmentSetup.storeEnv() diff --git a/src/__tests__/config/jest.cleanup.ts b/src/__tests__/config/jest.cleanup.ts index 0cbd7971..df2df772 100644 --- a/src/__tests__/config/jest.cleanup.ts +++ b/src/__tests__/config/jest.cleanup.ts @@ -6,15 +6,24 @@ import path from 'path' // eslint-disable-next-line @typescript-eslint/no-var-requires require('tsconfig-paths').register() -import { OAuthProvider } from 'oauth' -import { OperateApiClient } from 'operate' -import { BpmnParser, ZeebeGrpcClient } from 'zeebe' +import { OAuthProvider } from '../../oauth' +import { OperateApiClient } from '../../operate' +import { BpmnParser, ZeebeGrpcClient } from '../../zeebe' export const cleanUp = async () => { // Your cleanup process here. console.log('Removing all cached OAuth tokens...') - const o = new OAuthProvider() + const o = new OAuthProvider({ + config: { + CAMUNDA_OAUTH_URL: 'dummy', + ZEEBE_CLIENT_ID: 'dummy', + ZEEBE_CLIENT_SECRET: 'dummy', + }, + }) o.flushFileCache() + if (process.env.CAMUNDA_UNIT_TEST == 'true') { + return + } console.log('Removing any running test process instances...') const filePath = path.join(__dirname, '..', 'testdata') const files = fs diff --git a/src/__tests__/lib/LosslessJsonParser.spec.ts b/src/__tests__/lib/LosslessJsonParser.spec.ts index dee8148e..6e04fc2a 100644 --- a/src/__tests__/lib/LosslessJsonParser.spec.ts +++ b/src/__tests__/lib/LosslessJsonParser.spec.ts @@ -5,8 +5,8 @@ import { LosslessDto, losslessParse, losslessStringify, -} from 'lib' -import { ProcessInstanceStatistics } from 'operate/lib/OperateDto' +} from '../../lib' +import { ProcessInstanceStatistics } from '../../operate/lib/OperateDto' test('LosslessJsonParser correctly handles nested Dtos', () => { class DecisionInstanceOutput extends LosslessDto { diff --git a/src/__tests__/modeler/modeler.spec.ts b/src/__tests__/modeler/modeler.spec.ts index 002eb396..580f8884 100644 --- a/src/__tests__/modeler/modeler.spec.ts +++ b/src/__tests__/modeler/modeler.spec.ts @@ -1,5 +1,4 @@ -import { EnvironmentSetup } from 'lib' - +import { EnvironmentSetup } from '../../lib' import { ModelerApiClient } from '../../modeler/index' beforeAll(() => { diff --git a/src/__tests__/oauth/OAuthProvider.spec.ts b/src/__tests__/oauth/OAuthProvider.spec.ts index 0f7a884c..96bafc5c 100644 --- a/src/__tests__/oauth/OAuthProvider.spec.ts +++ b/src/__tests__/oauth/OAuthProvider.spec.ts @@ -161,9 +161,9 @@ test('Throws in the constructor if the token cache is not writable', () => { expect(fs.existsSync(tokenCacheDir)).toBe(false) }) -// Added test for https://github.com/camunda-community-hub/camunda-saas-oauth-nodejs/issues/8 +// Added test for https://github.com/camunda/camunda-saas-oauth-nodejs/issues/8 // "Can not renew expired token" -// Updated test for https://github.com/camunda-community-hub/camunda-8-js-sdk/issues/3 +// Updated test for https://github.com/camunda/camunda-8-js-sdk/issues/3 // "Remove expiry timer from oAuth token implementation" test('In-memory cache is populated and evicted after timeout', (done) => { const delay = (timeout: number) => @@ -216,7 +216,7 @@ test('In-memory cache is populated and evicted after timeout', (done) => { }) }) -// Added test for https://github.com/camunda-community-hub/camunda-8-js-sdk/issues/62 +// Added test for https://github.com/camunda/camunda-8-js-sdk/issues/62 // "OAuth token refresh has a race condition" test('In-memory cache is populated and evicted respecting CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS', (done) => { const delay = (timeout: number) => @@ -529,7 +529,7 @@ test('Can set a custom user agent', () => { expect(o.userAgentString.includes(' modeler')).toBe(true) }) -// See: https://github.com/camunda-community-hub/camunda-8-js-sdk/issues/60 +// See: https://github.com/camunda/camunda-8-js-sdk/issues/60 test('Passes no audience for Modeler API when self-hosted', (done) => { const serverPort3006 = 3006 const o = new OAuthProvider({ @@ -563,7 +563,7 @@ test('Passes no audience for Modeler API when self-hosted', (done) => { o.getToken('MODELER') }) -// See: https://github.com/camunda-community-hub/camunda-8-js-sdk/issues/60 +// See: https://github.com/camunda/camunda-8-js-sdk/issues/60 test('Throws if you try to get a Modeler token from SaaS without console creds', async () => { let thrown = false const o = new OAuthProvider({ @@ -586,7 +586,7 @@ test('Throws if you try to get a Modeler token from SaaS without console creds', }) }) -// See: https://github.com/camunda-community-hub/camunda-8-js-sdk/issues/60 +// See: https://github.com/camunda/camunda-8-js-sdk/issues/60 test('Throws if you try to get a Modeler token from Self-hosted without application creds', async () => { let thrown = false const o = new OAuthProvider({ diff --git a/src/__tests__/operate/multitenancy/operate-mt.spec.ts b/src/__tests__/operate/multitenancy/operate-mt.spec.ts index 25f2f5d7..3772c4cc 100644 --- a/src/__tests__/operate/multitenancy/operate-mt.spec.ts +++ b/src/__tests__/operate/multitenancy/operate-mt.spec.ts @@ -1,7 +1,6 @@ -import { delay, restoreZeebeLogging, suppressZeebeLogging } from 'lib' -import { ZeebeGrpcClient } from 'zeebe' - +import { delay, restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { OperateApiClient } from '../../../operate' +import { ZeebeGrpcClient } from '../../../zeebe' jest.setTimeout(15000) suppressZeebeLogging() diff --git a/src/__tests__/operate/operate.spec.ts b/src/__tests__/operate/operate.spec.ts index ff84fe0f..1edb0683 100644 --- a/src/__tests__/operate/operate.spec.ts +++ b/src/__tests__/operate/operate.spec.ts @@ -1,7 +1,6 @@ -import { EnvironmentSetup } from 'lib' -import { TestableOperateApiClient } from 'operate/lib/TestableOperateApiClient' - +import { EnvironmentSetup } from '../../lib' import { OperateApiClient } from '../../operate' +import { TestableOperateApiClient } from '../../operate/lib/TestableOperateApiClient' beforeAll(() => { EnvironmentSetup.storeEnv() diff --git a/src/__tests__/optimize/optimize.spec.ts b/src/__tests__/optimize/optimize.spec.ts index 0d97eedc..e41792dd 100644 --- a/src/__tests__/optimize/optimize.spec.ts +++ b/src/__tests__/optimize/optimize.spec.ts @@ -1,5 +1,4 @@ -import { EnvironmentSetup } from 'lib' - +import { EnvironmentSetup } from '../../lib' import { OptimizeApiClient } from '../../optimize/lib/OptimizeApiClient' beforeAll(() => { diff --git a/src/__tests__/tasklist/tasklist.integration.spec.ts b/src/__tests__/tasklist/tasklist.integration.spec.ts index 339a2b84..ac253e5b 100644 --- a/src/__tests__/tasklist/tasklist.integration.spec.ts +++ b/src/__tests__/tasklist/tasklist.integration.spec.ts @@ -1,14 +1,13 @@ import { join } from 'path' -import { OperateApiClient } from 'operate' +import { OperateApiClient } from '../../operate' +import { TasklistApiClient } from '../../tasklist/index' +import { ZeebeGrpcClient } from '../../zeebe' import { CreateProcessInstanceResponse, DeployResourceResponse, ProcessDeployment, -} from 'zeebe/types' - -import { TasklistApiClient } from '../../tasklist/index' -import { ZeebeGrpcClient } from '../../zeebe' +} from '../../zeebe/types' jest.setTimeout(25000) // increase timeout to allow Tasklist application to create tasks diff --git a/src/__tests__/tasklist/tasklist.spec.ts b/src/__tests__/tasklist/tasklist.spec.ts index 12efee36..a24908b1 100644 --- a/src/__tests__/tasklist/tasklist.spec.ts +++ b/src/__tests__/tasklist/tasklist.spec.ts @@ -1,5 +1,4 @@ -import { EnvironmentSetup } from 'lib' - +import { EnvironmentSetup } from '../../lib' import { TasklistApiClient } from '../../tasklist/index' beforeAll(() => { diff --git a/src/__tests__/zeebe/integration/Client-BroadcastSignal.spec.ts b/src/__tests__/zeebe/integration/Client-BroadcastSignal.spec.ts index 92086bd5..4c88b37e 100644 --- a/src/__tests__/zeebe/integration/Client-BroadcastSignal.spec.ts +++ b/src/__tests__/zeebe/integration/Client-BroadcastSignal.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' diff --git a/src/__tests__/zeebe/integration/Client-BrokenBpmn.spec.ts b/src/__tests__/zeebe/integration/Client-BrokenBpmn.spec.ts index 35a00f91..751e4474 100644 --- a/src/__tests__/zeebe/integration/Client-BrokenBpmn.spec.ts +++ b/src/__tests__/zeebe/integration/Client-BrokenBpmn.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' suppressZeebeLogging() diff --git a/src/__tests__/zeebe/integration/Client-ConnectionError.spec.ts b/src/__tests__/zeebe/integration/Client-ConnectionError.spec.ts index 85147488..661c8823 100644 --- a/src/__tests__/zeebe/integration/Client-ConnectionError.spec.ts +++ b/src/__tests__/zeebe/integration/Client-ConnectionError.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' jest.setTimeout(10000) diff --git a/src/__tests__/zeebe/integration/Client-CreateProcessInstanceWithResult.spec.ts b/src/__tests__/zeebe/integration/Client-CreateProcessInstanceWithResult.spec.ts index 930cd127..7f26a5e0 100644 --- a/src/__tests__/zeebe/integration/Client-CreateProcessInstanceWithResult.spec.ts +++ b/src/__tests__/zeebe/integration/Client-CreateProcessInstanceWithResult.spec.ts @@ -1,8 +1,7 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' -import { DeployResourceResponse, ProcessDeployment } from 'zeebe/types' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' +import { DeployResourceResponse, ProcessDeployment } from '../../../zeebe/types' jest.setTimeout(25000) diff --git a/src/__tests__/zeebe/integration/Client-DeleteResource.spec.ts b/src/__tests__/zeebe/integration/Client-DeleteResource.spec.ts index 603ebefe..330b56ed 100644 --- a/src/__tests__/zeebe/integration/Client-DeleteResource.spec.ts +++ b/src/__tests__/zeebe/integration/Client-DeleteResource.spec.ts @@ -1,5 +1,5 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' -import { ZeebeGrpcClient } from 'zeebe' +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' +import { ZeebeGrpcClient } from '../../../zeebe' jest.setTimeout(20000) diff --git a/src/__tests__/zeebe/integration/Client-DeployProcess.spec.ts b/src/__tests__/zeebe/integration/Client-DeployProcess.spec.ts index 4010ec1a..a4d67781 100644 --- a/src/__tests__/zeebe/integration/Client-DeployProcess.spec.ts +++ b/src/__tests__/zeebe/integration/Client-DeployProcess.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe/index' process.env.ZEEBE_NODE_LOG_LEVEL = process.env.ZEEBE_NODE_LOG_LEVEL || 'NONE' diff --git a/src/__tests__/zeebe/integration/Client-DeployResource.spec.ts b/src/__tests__/zeebe/integration/Client-DeployResource.spec.ts index 88a8b61c..ccfb9de9 100644 --- a/src/__tests__/zeebe/integration/Client-DeployResource.spec.ts +++ b/src/__tests__/zeebe/integration/Client-DeployResource.spec.ts @@ -1,7 +1,6 @@ import fs from 'fs' -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { BpmnParser, ZeebeGrpcClient } from '../../../zeebe/index' process.env.ZEEBE_NODE_LOG_LEVEL = process.env.ZEEBE_NODE_LOG_LEVEL || 'NONE' diff --git a/src/__tests__/zeebe/integration/Client-EvaluateDecision.spec.ts b/src/__tests__/zeebe/integration/Client-EvaluateDecision.spec.ts index 69ccafb6..0b7bd778 100644 --- a/src/__tests__/zeebe/integration/Client-EvaluateDecision.spec.ts +++ b/src/__tests__/zeebe/integration/Client-EvaluateDecision.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe/index' beforeAll(() => suppressZeebeLogging()) diff --git a/src/__tests__/zeebe/integration/Client-MessageStart.spec.ts b/src/__tests__/zeebe/integration/Client-MessageStart.spec.ts index 8f388b06..bbe4b48e 100644 --- a/src/__tests__/zeebe/integration/Client-MessageStart.spec.ts +++ b/src/__tests__/zeebe/integration/Client-MessageStart.spec.ts @@ -1,9 +1,9 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' import { v4 as uuid } from 'uuid' -import { DeployResourceResponse, ProcessDeployment } from 'zeebe/types' +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' +import { DeployResourceResponse, ProcessDeployment } from '../../../zeebe/types' jest.setTimeout(45000) let test1: DeployResourceResponse diff --git a/src/__tests__/zeebe/integration/Client-MigrateProcessInstance.spec.ts b/src/__tests__/zeebe/integration/Client-MigrateProcessInstance.spec.ts index 27d78adc..e78053df 100644 --- a/src/__tests__/zeebe/integration/Client-MigrateProcessInstance.spec.ts +++ b/src/__tests__/zeebe/integration/Client-MigrateProcessInstance.spec.ts @@ -1,8 +1,7 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' -import { DeployResourceResponse, ProcessDeployment } from 'zeebe/types' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe/index' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' +import { DeployResourceResponse, ProcessDeployment } from '../../../zeebe/types' suppressZeebeLogging() diff --git a/src/__tests__/zeebe/integration/Client-ModifyProcessInstance.spec.ts b/src/__tests__/zeebe/integration/Client-ModifyProcessInstance.spec.ts index 33dbdead..5ce01f91 100644 --- a/src/__tests__/zeebe/integration/Client-ModifyProcessInstance.spec.ts +++ b/src/__tests__/zeebe/integration/Client-ModifyProcessInstance.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe/index' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' diff --git a/src/__tests__/zeebe/integration/Client-PublishMessage.spec.ts b/src/__tests__/zeebe/integration/Client-PublishMessage.spec.ts index 0c727676..a764a1b4 100644 --- a/src/__tests__/zeebe/integration/Client-PublishMessage.spec.ts +++ b/src/__tests__/zeebe/integration/Client-PublishMessage.spec.ts @@ -1,6 +1,6 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' import { v4 as uuid } from 'uuid' +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' diff --git a/src/__tests__/zeebe/integration/Client-ThrowError.spec.ts b/src/__tests__/zeebe/integration/Client-ThrowError.spec.ts index 8450d54f..2f2ea0e7 100644 --- a/src/__tests__/zeebe/integration/Client-ThrowError.spec.ts +++ b/src/__tests__/zeebe/integration/Client-ThrowError.spec.ts @@ -1,6 +1,6 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' import { Duration } from 'typed-duration' +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' diff --git a/src/__tests__/zeebe/integration/Client-integration.spec.ts b/src/__tests__/zeebe/integration/Client-integration.spec.ts index b215e415..7770b52c 100644 --- a/src/__tests__/zeebe/integration/Client-integration.spec.ts +++ b/src/__tests__/zeebe/integration/Client-integration.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe/index' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' diff --git a/src/__tests__/zeebe/integration/Client-onReady.spec.ts b/src/__tests__/zeebe/integration/Client-onReady.spec.ts index 237b9ee3..a6a1f65c 100644 --- a/src/__tests__/zeebe/integration/Client-onReady.spec.ts +++ b/src/__tests__/zeebe/integration/Client-onReady.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' jest.setTimeout(30000) diff --git a/src/__tests__/zeebe/integration/Client-setVariables.spec.ts b/src/__tests__/zeebe/integration/Client-setVariables.spec.ts index e9a4d138..060632f0 100644 --- a/src/__tests__/zeebe/integration/Client-setVariables.spec.ts +++ b/src/__tests__/zeebe/integration/Client-setVariables.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' import { diff --git a/src/__tests__/zeebe/integration/Client-startProcess.spec.ts b/src/__tests__/zeebe/integration/Client-startProcess.spec.ts index 9667f3bb..5d6397bd 100644 --- a/src/__tests__/zeebe/integration/Client-startProcess.spec.ts +++ b/src/__tests__/zeebe/integration/Client-startProcess.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' import { CreateProcessInstanceResponse } from '../../../zeebe/lib/interfaces-grpc-1.0' diff --git a/src/__tests__/zeebe/integration/Topology.spec.ts b/src/__tests__/zeebe/integration/Topology.spec.ts index 286e1935..51ff191e 100644 --- a/src/__tests__/zeebe/integration/Topology.spec.ts +++ b/src/__tests__/zeebe/integration/Topology.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' suppressZeebeLogging() diff --git a/src/__tests__/zeebe/integration/TypeSurfaceAreaTest.spec.ts b/src/__tests__/zeebe/integration/TypeSurfaceAreaTest.spec.ts index 3ab82a24..387603b4 100644 --- a/src/__tests__/zeebe/integration/TypeSurfaceAreaTest.spec.ts +++ b/src/__tests__/zeebe/integration/TypeSurfaceAreaTest.spec.ts @@ -1,6 +1,5 @@ -import { ZBWorkerTaskHandler } from 'zeebe/types' - import { ZeebeGrpcClient } from '../../../zeebe/index' +import { ZBWorkerTaskHandler } from '../../../zeebe/types' jest.setTimeout(7000) diff --git a/src/__tests__/zeebe/integration/Worker-1.0-complete.spec.ts b/src/__tests__/zeebe/integration/Worker-1.0-complete.spec.ts index b2899234..2836d758 100644 --- a/src/__tests__/zeebe/integration/Worker-1.0-complete.spec.ts +++ b/src/__tests__/zeebe/integration/Worker-1.0-complete.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' import { CreateProcessInstanceResponse } from '../../../zeebe/lib/interfaces-grpc-1.0' diff --git a/src/__tests__/zeebe/integration/Worker-Dto.spec.ts b/src/__tests__/zeebe/integration/Worker-Dto.spec.ts index 4c83b335..d96999c5 100644 --- a/src/__tests__/zeebe/integration/Worker-Dto.spec.ts +++ b/src/__tests__/zeebe/integration/Worker-Dto.spec.ts @@ -1,5 +1,4 @@ -import { BigIntValue, Int64String, LosslessDto } from 'lib' - +import { BigIntValue, Int64String, LosslessDto } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' test("Let's test worker handler signatures", () => { diff --git a/src/__tests__/zeebe/integration/Worker-Failure-Backoff-Retry.spec.ts b/src/__tests__/zeebe/integration/Worker-Failure-Backoff-Retry.spec.ts index 99ba000c..2dd100d0 100644 --- a/src/__tests__/zeebe/integration/Worker-Failure-Backoff-Retry.spec.ts +++ b/src/__tests__/zeebe/integration/Worker-Failure-Backoff-Retry.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' import { CreateProcessInstanceResponse } from '../../../zeebe/lib/interfaces-grpc-1.0' diff --git a/src/__tests__/zeebe/integration/Worker-Failure-Retries.spec.ts b/src/__tests__/zeebe/integration/Worker-Failure-Retries.spec.ts index 4be2e8c5..f47b3ae2 100644 --- a/src/__tests__/zeebe/integration/Worker-Failure-Retries.spec.ts +++ b/src/__tests__/zeebe/integration/Worker-Failure-Retries.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' import { CreateProcessInstanceResponse } from '../../../zeebe/lib/interfaces-grpc-1.0' diff --git a/src/__tests__/zeebe/integration/Worker-Failure.spec.ts b/src/__tests__/zeebe/integration/Worker-Failure.spec.ts index e1b71f19..e018eea2 100644 --- a/src/__tests__/zeebe/integration/Worker-Failure.spec.ts +++ b/src/__tests__/zeebe/integration/Worker-Failure.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' import { diff --git a/src/__tests__/zeebe/integration/Worker-LongPoll.spec.ts b/src/__tests__/zeebe/integration/Worker-LongPoll.spec.ts index 944266af..ff7277b0 100644 --- a/src/__tests__/zeebe/integration/Worker-LongPoll.spec.ts +++ b/src/__tests__/zeebe/integration/Worker-LongPoll.spec.ts @@ -1,6 +1,6 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' import * as uuid from 'uuid' +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' diff --git a/src/__tests__/zeebe/integration/Worker-RaiseIncident.spec.ts b/src/__tests__/zeebe/integration/Worker-RaiseIncident.spec.ts index 3566be26..161ef501 100644 --- a/src/__tests__/zeebe/integration/Worker-RaiseIncident.spec.ts +++ b/src/__tests__/zeebe/integration/Worker-RaiseIncident.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' diff --git a/src/__tests__/zeebe/integration/Worker-fetchVariable.spec.ts b/src/__tests__/zeebe/integration/Worker-fetchVariable.spec.ts index fdf7d9fb..66bea1c0 100644 --- a/src/__tests__/zeebe/integration/Worker-fetchVariable.spec.ts +++ b/src/__tests__/zeebe/integration/Worker-fetchVariable.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' import { CreateProcessInstanceResponse } from '../../../zeebe/lib/interfaces-grpc-1.0' diff --git a/src/__tests__/zeebe/integration/Worker-integration.spec.ts b/src/__tests__/zeebe/integration/Worker-integration.spec.ts index 5a76cfce..bc0b1626 100644 --- a/src/__tests__/zeebe/integration/Worker-integration.spec.ts +++ b/src/__tests__/zeebe/integration/Worker-integration.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' import { cancelProcesses } from '../../../zeebe/lib/cancelProcesses' import { CreateProcessInstanceResponse } from '../../../zeebe/lib/interfaces-grpc-1.0' diff --git a/src/__tests__/zeebe/integration/Worker-onReady.spec.ts b/src/__tests__/zeebe/integration/Worker-onReady.spec.ts index 3aac8213..d1c60c78 100644 --- a/src/__tests__/zeebe/integration/Worker-onReady.spec.ts +++ b/src/__tests__/zeebe/integration/Worker-onReady.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe' jest.setTimeout(40000) diff --git a/src/__tests__/zeebe/multitenancy/createProcessInstance-mt.spec.ts b/src/__tests__/zeebe/multitenancy/createProcessInstance-mt.spec.ts index ff6fbc61..f3802eeb 100644 --- a/src/__tests__/zeebe/multitenancy/createProcessInstance-mt.spec.ts +++ b/src/__tests__/zeebe/multitenancy/createProcessInstance-mt.spec.ts @@ -1,6 +1,6 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' -import { ZeebeGrpcClient } from 'zeebe' -import { DeployResourceResponse, ProcessDeployment } from 'zeebe/types' +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' +import { ZeebeGrpcClient } from '../../../zeebe' +import { DeployResourceResponse, ProcessDeployment } from '../../../zeebe/types' suppressZeebeLogging() let res: DeployResourceResponse diff --git a/src/__tests__/zeebe/multitenancy/deployprocess-mt.spec.ts b/src/__tests__/zeebe/multitenancy/deployprocess-mt.spec.ts index cbc2504e..bcf10587 100644 --- a/src/__tests__/zeebe/multitenancy/deployprocess-mt.spec.ts +++ b/src/__tests__/zeebe/multitenancy/deployprocess-mt.spec.ts @@ -1,5 +1,4 @@ -import { restoreZeebeLogging, suppressZeebeLogging } from 'lib' - +import { restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' import { ZeebeGrpcClient } from '../../../zeebe/index' const STORED_ENV = {} diff --git a/src/__tests__/zeebe/multitenancy/signalbroadcast-mt.spec.ts b/src/__tests__/zeebe/multitenancy/signalbroadcast-mt.spec.ts index 9abf82af..e8d364ba 100644 --- a/src/__tests__/zeebe/multitenancy/signalbroadcast-mt.spec.ts +++ b/src/__tests__/zeebe/multitenancy/signalbroadcast-mt.spec.ts @@ -1,6 +1,6 @@ -import { delay, restoreZeebeLogging, suppressZeebeLogging } from 'lib' -import { OperateApiClient } from 'operate' -import { ZeebeGrpcClient } from 'zeebe' +import { delay, restoreZeebeLogging, suppressZeebeLogging } from '../../../lib' +import { OperateApiClient } from '../../../operate' +import { ZeebeGrpcClient } from '../../../zeebe' jest.setTimeout(7000) suppressZeebeLogging() diff --git a/src/admin/lib/AdminApiClient.ts b/src/admin/lib/AdminApiClient.ts index 61769ea9..a8e653d1 100644 --- a/src/admin/lib/AdminApiClient.ts +++ b/src/admin/lib/AdminApiClient.ts @@ -1,5 +1,6 @@ import d from 'debug' import got from 'got' + import { CamundaEnvironmentConfigurator, CamundaPlatform8Configuration, @@ -8,8 +9,7 @@ import { RequireConfiguration, constructOAuthProvider, createUserAgentString, -} from 'lib' - +} from '../../lib' import { IOAuthProvider } from '../../oauth' import * as Dto from './AdminDto' diff --git a/src/c8/index.ts b/src/c8/index.ts index 590945df..d95d678e 100644 --- a/src/c8/index.ts +++ b/src/c8/index.ts @@ -1,15 +1,15 @@ -import { AdminApiClient } from 'admin' +import { AdminApiClient } from '../admin' import { CamundaEnvironmentConfigurator, CamundaPlatform8Configuration, DeepPartial, -} from 'lib' -import { ModelerApiClient } from 'modeler' -import { OAuthProvider } from 'oauth' -import { OperateApiClient } from 'operate' -import { OptimizeApiClient } from 'optimize' -import { TasklistApiClient } from 'tasklist' -import { ZeebeGrpcClient } from 'zeebe' +} from '../lib' +import { ModelerApiClient } from '../modeler' +import { OAuthProvider } from '../oauth' +import { OperateApiClient } from '../operate' +import { OptimizeApiClient } from '../optimize' +import { TasklistApiClient } from '../tasklist' +import { ZeebeGrpcClient } from '../zeebe' /** * A single point of configuration for all Camunda Platform 8 clients. @@ -37,13 +37,15 @@ export class Camunda8 { private tasklistApiClient?: TasklistApiClient private zeebeGrpcClient?: ZeebeGrpcClient private configuration: CamundaPlatform8Configuration - private oAuthProvider: OAuthProvider + private oAuthProvider?: OAuthProvider constructor(config: DeepPartial = {}) { this.configuration = CamundaEnvironmentConfigurator.mergeConfigWithEnvironment(config) - - this.oAuthProvider = new OAuthProvider({ config: this.configuration }) + // Respect Oauth disabled flag + if (!this.configuration.CAMUNDA_OAUTH_DISABLED) { + this.oAuthProvider = new OAuthProvider({ config: this.configuration }) + } } public getOperateApiClient(): OperateApiClient { @@ -96,7 +98,7 @@ export class Camunda8 { return this.tasklistApiClient } - public getZeebeApiClient(): ZeebeGrpcClient { + public getZeebeGrpcApiClient(): ZeebeGrpcClient { if (!this.zeebeGrpcClient) { this.zeebeGrpcClient = new ZeebeGrpcClient({ config: this.configuration, diff --git a/src/lib/ClientConstructor.ts b/src/lib/ClientConstructor.ts index 754e27c7..44cd9658 100644 --- a/src/lib/ClientConstructor.ts +++ b/src/lib/ClientConstructor.ts @@ -1,4 +1,4 @@ -import { IOAuthProvider } from 'oauth' +import { IOAuthProvider } from '../oauth' import { CamundaPlatform8Configuration, DeepPartial } from './Configuration' diff --git a/src/lib/Configuration.ts b/src/lib/Configuration.ts index 3013f91c..cc43e2f2 100644 --- a/src/lib/Configuration.ts +++ b/src/lib/Configuration.ts @@ -75,7 +75,7 @@ const getMainEnv = () => optional: true, // No default for this, because on Self-Managed it's not needed, and we omit it if the user doesn't set it. // However, if someone sets up Self-Managed in a way that needs it, we let them set one. - // See: https://github.com/camunda-community-hub/camunda-8-js-sdk/issues/60 + // See: https://github.com/camunda/camunda-8-js-sdk/issues/60 }, /** The audience parameter for an Optimize OAuth token request. Defaults to optimize.camunda.io */ CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: { diff --git a/src/lib/ConstructOAuthProvider.ts b/src/lib/ConstructOAuthProvider.ts index ef5b4ec0..32ef884b 100644 --- a/src/lib/ConstructOAuthProvider.ts +++ b/src/lib/ConstructOAuthProvider.ts @@ -1,4 +1,4 @@ -import { NullAuthProvider, OAuthProvider } from 'oauth' +import { NullAuthProvider, OAuthProvider } from '../oauth' import { CamundaPlatform8Configuration } from './Configuration' diff --git a/src/lib/LosslessJsonParser.ts b/src/lib/LosslessJsonParser.ts index 7b2cc894..637f090b 100644 --- a/src/lib/LosslessJsonParser.ts +++ b/src/lib/LosslessJsonParser.ts @@ -7,7 +7,7 @@ * * It also handles nested Dtos by using the `@ChildDto` decorator. * - * More details on the design here: https://github.com/camunda-community-hub/camunda-8-js-sdk/issues/81#issuecomment-2022213859 + * More details on the design here: https://github.com/camunda/camunda-8-js-sdk/issues/81#issuecomment-2022213859 */ /* eslint-disable @typescript-eslint/no-explicit-any */ diff --git a/src/lib/RequireConfiguration.ts b/src/lib/RequireConfiguration.ts index 1bdc6f94..8e110c88 100644 --- a/src/lib/RequireConfiguration.ts +++ b/src/lib/RequireConfiguration.ts @@ -1,4 +1,4 @@ -import { CamundaEnvironmentVariable } from 'lib' +import { CamundaEnvironmentVariable } from '../lib' export function RequireConfiguration( config: T | undefined, diff --git a/src/modeler/lib/ModelerAPIClient.ts b/src/modeler/lib/ModelerAPIClient.ts index c3853e85..bc21f74b 100644 --- a/src/modeler/lib/ModelerAPIClient.ts +++ b/src/modeler/lib/ModelerAPIClient.ts @@ -1,5 +1,6 @@ import d from 'debug' import got, { Response } from 'got' + import { CamundaEnvironmentConfigurator, CamundaPlatform8Configuration, @@ -7,8 +8,8 @@ import { GetCertificateAuthority, constructOAuthProvider, createUserAgentString, -} from 'lib' -import { IOAuthProvider } from 'oauth' +} from '../../lib' +import { IOAuthProvider } from '../../oauth' import * as Dto from './ModelerDto' diff --git a/src/oauth/lib/NullAuthProvider.ts b/src/oauth/lib/NullAuthProvider.ts index eb089bfd..4aba4e17 100644 --- a/src/oauth/lib/NullAuthProvider.ts +++ b/src/oauth/lib/NullAuthProvider.ts @@ -1,5 +1,6 @@ import debug from 'debug' -import { IOAuthProvider } from 'oauth' + +import { IOAuthProvider } from '..' import { TokenGrantAudienceType } from './IOAuthProvider' diff --git a/src/oauth/lib/OAuthProvider.ts b/src/oauth/lib/OAuthProvider.ts index c786129b..34c46a5b 100644 --- a/src/oauth/lib/OAuthProvider.ts +++ b/src/oauth/lib/OAuthProvider.ts @@ -3,6 +3,8 @@ import https from 'https' import * as os from 'os' import { debug } from 'debug' +import fetch from 'node-fetch' + import { CamundaEnvironmentConfigurator, CamundaPlatform8Configuration, @@ -10,9 +12,7 @@ import { GetCertificateAuthority, RequireConfiguration, createUserAgentString, -} from 'lib' -import fetch from 'node-fetch' - +} from '../../lib' import { IOAuthProvider, Token, TokenError } from '../index' import { TokenGrantAudienceType } from './IOAuthProvider' @@ -138,7 +138,7 @@ export class OAuthProvider implements IOAuthProvider { // We use the Console credential set if it we are requesting from // the SaaS OAuth endpoint, and it is a Modeler or Admin Console token. // Otherwise we use the application credential set, unless a Console credential set exists. - // See: https://github.com/camunda-community-hub/camunda-8-js-sdk/issues/60 + // See: https://github.com/camunda/camunda-8-js-sdk/issues/60 const requestingFromSaaSConsole = this.isCamundaSaaS && (audienceType === 'CONSOLE' || audienceType === 'MODELER') @@ -231,7 +231,7 @@ export class OAuthProvider implements IOAuthProvider { private addAudienceIfNeeded(audienceType: TokenGrantAudienceType) { /** If we are running on Self-Managed (ie: not Camunda SaaS), and no explicit audience was set, * we should not include an audience in the token request. - * See: https://github.com/camunda-community-hub/camunda-8-js-sdk/issues/60 + * See: https://github.com/camunda/camunda-8-js-sdk/issues/60 */ if ( audienceType === 'MODELER' && diff --git a/src/operate/lib/OperateApiClient.ts b/src/operate/lib/OperateApiClient.ts index af37f865..4589c350 100644 --- a/src/operate/lib/OperateApiClient.ts +++ b/src/operate/lib/OperateApiClient.ts @@ -1,5 +1,6 @@ import { debug as d } from 'debug' import got from 'got' + import { CamundaEnvironmentConfigurator, CamundaPlatform8Configuration, @@ -10,8 +11,8 @@ import { createUserAgentString, losslessParse, losslessStringify, -} from 'lib' -import { IOAuthProvider } from 'oauth' +} from '../../lib' +import { IOAuthProvider } from '../../oauth' import { ChangeStatus, diff --git a/src/operate/lib/OperateDto.ts b/src/operate/lib/OperateDto.ts index 33d099f1..fe16649f 100644 --- a/src/operate/lib/OperateDto.ts +++ b/src/operate/lib/OperateDto.ts @@ -1,6 +1,7 @@ -import { ChildDto, Int64String, LosslessDto } from 'lib' import { LosslessNumber } from 'lossless-json' +import { ChildDto, Int64String, LosslessDto } from '../../lib' + export class DecisionDefinition extends LosslessDto { id!: string @Int64String diff --git a/src/operate/lib/TestableOperateApiClient.ts b/src/operate/lib/TestableOperateApiClient.ts index acb886f1..a2332c5f 100644 --- a/src/operate/lib/TestableOperateApiClient.ts +++ b/src/operate/lib/TestableOperateApiClient.ts @@ -1,4 +1,4 @@ -import { ClientConstructor } from 'lib' +import { ClientConstructor } from '../../lib' import { OperateApiClient } from './OperateApiClient' import { Query } from './OperateDto' diff --git a/src/operate/lib/parseSearchResults.ts b/src/operate/lib/parseSearchResults.ts index 029adecb..bc8879d9 100644 --- a/src/operate/lib/parseSearchResults.ts +++ b/src/operate/lib/parseSearchResults.ts @@ -1,6 +1,7 @@ -import { losslessParse } from 'lib' import { parse, stringify } from 'lossless-json' +import { losslessParse } from '../../lib' + import { SearchResults } from './OperateDto' export function parseSearchResults( diff --git a/src/optimize/lib/OptimizeApiClient.ts b/src/optimize/lib/OptimizeApiClient.ts index a53820ae..ca5888fa 100644 --- a/src/optimize/lib/OptimizeApiClient.ts +++ b/src/optimize/lib/OptimizeApiClient.ts @@ -1,5 +1,6 @@ import { debug as d } from 'debug' import got from 'got' + import { CamundaEnvironmentConfigurator, CamundaPlatform8Configuration, @@ -8,8 +9,8 @@ import { RequireConfiguration, constructOAuthProvider, createUserAgentString, -} from 'lib' -import { IOAuthProvider } from 'oauth' +} from '../../lib' +import { IOAuthProvider } from '../../oauth' import { DashboardCollection, diff --git a/src/tasklist/lib/TasklistApiClient.ts b/src/tasklist/lib/TasklistApiClient.ts index c1648e72..ba05f438 100644 --- a/src/tasklist/lib/TasklistApiClient.ts +++ b/src/tasklist/lib/TasklistApiClient.ts @@ -1,5 +1,6 @@ import { debug } from 'debug' import got from 'got' + import { CamundaEnvironmentConfigurator, CamundaPlatform8Configuration, @@ -10,8 +11,7 @@ import { createUserAgentString, losslessParse, losslessStringify, -} from 'lib' - +} from '../../lib' import { IOAuthProvider } from '../../oauth' import { diff --git a/src/tasklist/lib/TasklistDto.ts b/src/tasklist/lib/TasklistDto.ts index 5fadec0b..ec964f73 100644 --- a/src/tasklist/lib/TasklistDto.ts +++ b/src/tasklist/lib/TasklistDto.ts @@ -1,4 +1,4 @@ -import { Int64String, LosslessDto } from 'lib' +import { Int64String, LosslessDto } from '../../lib' export type TaskState = 'COMPLETED' | 'CREATED' | 'CANCELED' | 'FAILED' diff --git a/src/tasklist/lib/utils.ts b/src/tasklist/lib/utils.ts index cbe5df5b..e38856b6 100644 --- a/src/tasklist/lib/utils.ts +++ b/src/tasklist/lib/utils.ts @@ -1,4 +1,4 @@ -import { losslessStringify } from 'lib' +import { losslessStringify } from '../../lib' type JSON = string | number | boolean | JSON[] | JSONDoc[] export interface JSONDoc { diff --git a/src/zeebe/lib/GrpcClient.ts b/src/zeebe/lib/GrpcClient.ts index 28fad012..68d54941 100644 --- a/src/zeebe/lib/GrpcClient.ts +++ b/src/zeebe/lib/GrpcClient.ts @@ -12,10 +12,11 @@ import { import { VerifyOptions } from '@grpc/grpc-js/build/src/channel-credentials' import { Options, PackageDefinition, loadSync } from '@grpc/proto-loader' import d from 'debug' -import { CamundaPlatform8Configuration, createUserAgentString } from 'lib' -import { IOAuthProvider } from 'oauth' import { Duration, MaybeTimeDuration, TimeDuration } from 'typed-duration' +import { CamundaPlatform8Configuration, createUserAgentString } from '../../lib' +import { IOAuthProvider } from '../../oauth' + import { GrpcError } from './GrpcError' import { Loglevel, ZBCustomLogger } from './interfaces-published-contract' diff --git a/src/zeebe/lib/ZBWorkerBase.ts b/src/zeebe/lib/ZBWorkerBase.ts index e19234c4..45f181fe 100644 --- a/src/zeebe/lib/ZBWorkerBase.ts +++ b/src/zeebe/lib/ZBWorkerBase.ts @@ -6,10 +6,10 @@ import { } from '@grpc/grpc-js/build/src/call' import chalk, { Chalk } from 'chalk' import d from 'debug' -import { LosslessDto } from 'lib' import { Duration, MaybeTimeDuration } from 'typed-duration' import * as uuid from 'uuid' +import { LosslessDto } from '../../lib' import { ZeebeGrpcClient } from '../zb/ZeebeGrpcClient' import { ConnectionStatusEvent } from './ConnectionStatusEvent' diff --git a/src/zeebe/lib/cancelProcesses.ts b/src/zeebe/lib/cancelProcesses.ts index 416f26f5..cc74ad59 100644 --- a/src/zeebe/lib/cancelProcesses.ts +++ b/src/zeebe/lib/cancelProcesses.ts @@ -1,4 +1,4 @@ -import { OperateApiClient } from 'operate' +import { OperateApiClient } from '../../operate' const operate = createClient() diff --git a/src/zeebe/lib/stringifyVariables.ts b/src/zeebe/lib/stringifyVariables.ts index a3797551..967dd0b2 100644 --- a/src/zeebe/lib/stringifyVariables.ts +++ b/src/zeebe/lib/stringifyVariables.ts @@ -1,4 +1,4 @@ -import { losslessParse, losslessStringify } from 'lib' +import { losslessParse, losslessStringify } from '../../lib' import { Job } from './interfaces-1.0' import { ActivatedJob } from './interfaces-grpc-1.0' diff --git a/src/zeebe/zb/ZeebeGrpcClient.ts b/src/zeebe/zb/ZeebeGrpcClient.ts index 35b0307f..a495af0c 100644 --- a/src/zeebe/zb/ZeebeGrpcClient.ts +++ b/src/zeebe/zb/ZeebeGrpcClient.ts @@ -3,6 +3,10 @@ import * as path from 'path' import chalk from 'chalk' import d from 'debug' +import promiseRetry from 'promise-retry' +import { Duration, MaybeTimeDuration } from 'typed-duration' +import { v4 as uuid } from 'uuid' + import { CamundaEnvironmentConfigurator, CamundaPlatform8Configuration, @@ -11,12 +15,8 @@ import { RequireConfiguration, constructOAuthProvider, losslessStringify, -} from 'lib' -import { IOAuthProvider } from 'oauth' -import promiseRetry from 'promise-retry' -import { Duration, MaybeTimeDuration } from 'typed-duration' -import { v4 as uuid } from 'uuid' - +} from '../../lib' +import { IOAuthProvider } from '../../oauth' import { BpmnParser, parseVariables, diff --git a/test-d/index.test-d.ts b/test-d/index.test-d.ts new file mode 100644 index 00000000..c3dea6d2 --- /dev/null +++ b/test-d/index.test-d.ts @@ -0,0 +1,31 @@ +import { expectType } from 'tsd' + +import { + Admin, + Camunda8, + Modeler, + Operate, + Optimize, + Tasklist, + Zeebe, +} from '..' + +expectType(new Camunda8({ CAMUNDA_OAUTH_DISABLED: true })) +expectType( + new Camunda8({ CAMUNDA_OAUTH_DISABLED: true }).getOperateApiClient() +) +expectType( + new Camunda8({ CAMUNDA_OAUTH_DISABLED: true }).getAdminApiClient() +) +expectType( + new Camunda8({ CAMUNDA_OAUTH_DISABLED: true }).getModelerApiClient() +) +expectType( + new Camunda8({ CAMUNDA_OAUTH_DISABLED: true }).getOptimizeApiClient() +) +expectType( + new Camunda8({ CAMUNDA_OAUTH_DISABLED: true }).getTasklistApiClient() +) +expectType( + new Camunda8({ CAMUNDA_OAUTH_DISABLED: true }).getZeebeGrpcApiClient() +) diff --git a/tsconfig.json b/tsconfig.json index 0911e2ec..0e648550 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -25,17 +25,7 @@ { "name": "typescript-tslint-plugin" } - ], - "baseUrl": "./src", - "paths": { - "lib": ["./lib"], - "oauth": ["./oauth"], - "operate": ["./operate"], - "modeler": ["./modeler"], - "tasklist": ["./tasklist"], - "optimize": ["./optimize"], - "c8console": ["./c8console"] - } + ] }, - "exclude": ["node_modules", "src/__tests__/*"] + "exclude": ["node_modules", "src/__tests__/*", "test-d"] } diff --git a/zeebe-extra/.github/workflows/build-docs.yml b/zeebe-extra/.github/workflows/build-docs.yml index caccb8ae..a9a69833 100644 --- a/zeebe-extra/.github/workflows/build-docs.yml +++ b/zeebe-extra/.github/workflows/build-docs.yml @@ -34,11 +34,11 @@ jobs: - 26500:26500 steps: - name: Checkout repository - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 - name: Setup Node - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: 16.17.0 cache: "npm" diff --git a/zeebe-extra/CHANGELOG.md b/zeebe-extra/CHANGELOG.md index 8af83c80..e4b3adbb 100644 --- a/zeebe-extra/CHANGELOG.md +++ b/zeebe-extra/CHANGELOG.md @@ -7,7 +7,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline ### Features -- **tasklist:** enable multiple clusters via constructor options ([#16](https://github.com/camunda-community-hub/camunda-8-js-sdk/issues/16)) ([fb12e25](https://github.com/camunda-community-hub/camunda-8-js-sdk/commit/fb12e258321e6bba03d11d38119c740f0e242773)) +- **tasklist:** enable multiple clusters via constructor options ([#16](https://github.com/camunda/camunda-8-js-sdk/issues/16)) ([fb12e25](https://github.com/camunda/camunda-8-js-sdk/commit/fb12e258321e6bba03d11d38119c740f0e242773)) # 8.3.1 @@ -15,7 +15,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline _New shiny stuff_ -- You can now deploy forms to the Zeebe broker using `ZBClient.deployResource()`. See [#332](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/332) for more details. +- You can now deploy forms to the Zeebe broker using `ZBClient.deployResource()`. See [#332](https://github.com/camunda/zeebe-client-node-js/issues/332) for more details. # 8.3.0 @@ -23,31 +23,31 @@ _New shiny stuff_ _Changes in APIs or behaviour that may affect existing applications that use zeebe-node._ -- Several method signatures for `CreateProcessInstance` and `CreateProcessInstanceWithResult` have been removed, leaving only the method that takes an object parameter. See [#330](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/330#issuecomment-1672535320) for more details. +- Several method signatures for `CreateProcessInstance` and `CreateProcessInstanceWithResult` have been removed, leaving only the method that takes an object parameter. See [#330](https://github.com/camunda/zeebe-client-node-js/issues/330#issuecomment-1672535320) for more details. ## Known Issues _Things that don't work or don't work as expected, and which will be addressed in a future release_ -- The `onConnectionError` event fires correctly for Camunda SaaS, but fires a false positive when connecting to a Self-Managed instance. See [#340](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/340) for more details. +- The `onConnectionError` event fires correctly for Camunda SaaS, but fires a false positive when connecting to a Self-Managed instance. See [#340](https://github.com/camunda/zeebe-client-node-js/issues/340) for more details. ## New Features _New shiny stuff._ -- Camunda Platform 8.3.0 introduces multi-tenancy. To support this, the Node.js client adds an optional `tenantId` parameter to `DeployResource`, `DeployProcess`, `CreateProcessInstance`, `CreateProcessInstanceWithResult`, and `PublishMessage`. You can also specify a `tenantId` in the ZBClient constructor or via the environment variable `ZEEBE_TENANT_ID`. In the case that you specify it via the environment or constructor, it will be transparently added to all method invocations. See [#330](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/330) for more details. +- Camunda Platform 8.3.0 introduces multi-tenancy. To support this, the Node.js client adds an optional `tenantId` parameter to `DeployResource`, `DeployProcess`, `CreateProcessInstance`, `CreateProcessInstanceWithResult`, and `PublishMessage`. You can also specify a `tenantId` in the ZBClient constructor or via the environment variable `ZEEBE_TENANT_ID`. In the case that you specify it via the environment or constructor, it will be transparently added to all method invocations. See [#330](https://github.com/camunda/zeebe-client-node-js/issues/330) for more details. - `@grpc/grpc-js` has been updated to 1.9.7, and `@grpc/proto-loader` has been updated to 0.7.10. _Things that were broken and are now fixed._ -- The `onReady` and `onConnection` event tests now pass, so these events should be usable. See [#215](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/215) for more details. +- The `onReady` and `onConnection` event tests now pass, so these events should be usable. See [#215](https://github.com/camunda/zeebe-client-node-js/issues/215) for more details. ## Fixes _Things that were broken and are now fixed._ -- An error message "Grpc Stream Error: 16 UNAUTHENTICATED: Failed to parse bearer token, see cause for details" would be logged intermittently. This was because under particular conditions an expired token cached on disk could be used for API calls. To prevent this, the disk-cached token is evicted at the same time as the in-memory token. See [#336](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/336) for more details. -- The `onReady` and `onConnection` event tests now pass for Camunda SaaS. The `onReady` event fires correctly for Self-Managed started with docker-compose. See [#215](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/215) and [#340](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/340) for more details. +- An error message "Grpc Stream Error: 16 UNAUTHENTICATED: Failed to parse bearer token, see cause for details" would be logged intermittently. This was because under particular conditions an expired token cached on disk could be used for API calls. To prevent this, the disk-cached token is evicted at the same time as the in-memory token. See [#336](https://github.com/camunda/zeebe-client-node-js/issues/336) for more details. +- The `onReady` and `onConnection` event tests now pass for Camunda SaaS. The `onReady` event fires correctly for Self-Managed started with docker-compose. See [#215](https://github.com/camunda/zeebe-client-node-js/issues/215) and [#340](https://github.com/camunda/zeebe-client-node-js/issues/340) for more details. # Version 8.2.5 @@ -55,7 +55,7 @@ _Things that were broken and are now fixed._ _New shiny stuff._ -- Throwing a BPMN Error, either from the `ZBClient` or in the job handler of a `ZBWorker`, accepted an error message and an error code. The gRPC API for ThrowError now accepts a `variables` field, but the Node client did not allow you to set variables along with the error code and message. The Node client now accepts an object for `job.error` that includes a `variables` field, as does `ZBClient.throwError`, allowing you to set variables when throwing a BPMN error. See [#323](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/323), the README file, and the [Client API documentation](https://camunda-community-hub.github.io/zeebe-client-node-js/) for more details. +- Throwing a BPMN Error, either from the `ZBClient` or in the job handler of a `ZBWorker`, accepted an error message and an error code. The gRPC API for ThrowError now accepts a `variables` field, but the Node client did not allow you to set variables along with the error code and message. The Node client now accepts an object for `job.error` that includes a `variables` field, as does `ZBClient.throwError`, allowing you to set variables when throwing a BPMN error. See [#323](https://github.com/camunda/zeebe-client-node-js/issues/323), the README file, and the [Client API documentation](https://camunda.github.io/zeebe-client-node-js/) for more details. ## Chores @@ -69,7 +69,7 @@ _Things that shouldn't have a visible impact._ _Things that were broken and are now fixed._ -- Custom root certificates were not being passed to the Camunda SaaS OAuth provider. This caused a failure to connect when an SSL terminating firewall that uses a custom root certificate sits between the client and Camunda SaaS. Custom root certificates are now passed to the Camunda SaaS OAuth provider, and are used when making the connection. Thanks to [@nikku](https://github.com/nikku) for reporting this and providing the patch. See [#319](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/319) for more details. +- Custom root certificates were not being passed to the Camunda SaaS OAuth provider. This caused a failure to connect when an SSL terminating firewall that uses a custom root certificate sits between the client and Camunda SaaS. Custom root certificates are now passed to the Camunda SaaS OAuth provider, and are used when making the connection. Thanks to [@nikku](https://github.com/nikku) for reporting this and providing the patch. See [#319](https://github.com/camunda/zeebe-client-node-js/issues/319) for more details. # Version 8.2.3 @@ -77,7 +77,7 @@ _Things that were broken and are now fixed._ _Things that were broken and are now fixed._ -- The object signature for `job.fail()` did not correctly apply an explicit value for `retries`. As a result, job retries would decrement automatically if this signature and option were used. The value is now correctly parsed and applied, and job retry count can be explicitly set in the `job.fail()` command with the object signature. Thanks to [@patozgg](https://github.com/patozgg) for reporting this. See [#316](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/316) for more details. +- The object signature for `job.fail()` did not correctly apply an explicit value for `retries`. As a result, job retries would decrement automatically if this signature and option were used. The value is now correctly parsed and applied, and job retry count can be explicitly set in the `job.fail()` command with the object signature. Thanks to [@patozgg](https://github.com/patozgg) for reporting this. See [#316](https://github.com/camunda/zeebe-client-node-js/issues/316) for more details. # Version 8.2.2 @@ -93,13 +93,13 @@ _Things that shouldn't have a visible impact._ _New shiny stuff._ -- Add `ZBClient.broadcastSignal`, enabling the client to broadcast a signal. See [#312](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/312) for more details. +- Add `ZBClient.broadcastSignal`, enabling the client to broadcast a signal. See [#312](https://github.com/camunda/zeebe-client-node-js/issues/312) for more details. ## Fixes _Things that were broken and are now fixed._ -- Previously, the `timeToLive` property of `ZBClient.publishMessage` was required, although it was documented as optional. In this release, both `timeToLive` and `variables` have been made optional. If no value is supplied for `timeToLive`, it defaults to 0. Thanks to [@nhomble]() for raising this issue. See [#311](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/311) for more details. +- Previously, the `timeToLive` property of `ZBClient.publishMessage` was required, although it was documented as optional. In this release, both `timeToLive` and `variables` have been made optional. If no value is supplied for `timeToLive`, it defaults to 0. Thanks to [@nhomble]() for raising this issue. See [#311](https://github.com/camunda/zeebe-client-node-js/issues/311) for more details. # Version 8.2.0 @@ -107,7 +107,7 @@ _Things that were broken and are now fixed._ _New shiny stuff._ -- Add `ZBClient.evaluateDecision`, enabling a DMN table to be evaluated on a Zeebe 8.2 and later broker. See [#296](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/296) for more details. +- Add `ZBClient.evaluateDecision`, enabling a DMN table to be evaluated on a Zeebe 8.2 and later broker. See [#296](https://github.com/camunda/zeebe-client-node-js/issues/296) for more details. # Version 8.1.8 @@ -115,7 +115,7 @@ _New shiny stuff._ _Things that were broken and are now fixed._ -- The OAuth token was being evicted from the in-memory cache immediately, resulting in the file cache being used for every request. This release correctly sets the expiry time for the in-memory token cache. See [#307](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/307) for more details. Thanks to [@walliee](https://github.com/Walliee) for the fix. +- The OAuth token was being evicted from the in-memory cache immediately, resulting in the file cache being used for every request. This release correctly sets the expiry time for the in-memory token cache. See [#307](https://github.com/camunda/zeebe-client-node-js/issues/307) for more details. Thanks to [@walliee](https://github.com/Walliee) for the fix. # Version 8.1.7 @@ -123,7 +123,7 @@ _Things that were broken and are now fixed._ _Things that were broken and are now fixed._ -- With `cacheOnDisk` disabled, the OAuthProvider could cause excessive requests to the token endpoint, leading to blacklisting and denial-of-service. This version makes several adjustments to mitigate this: it caches the token in memory, reuses a single inflight request to the token endpoint, and backs off the token endpoint on a request failure. See [#301](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/301) for more details. Thanks to [@nhomble](https://github.com/nhomble) for raising this issue. +- With `cacheOnDisk` disabled, the OAuthProvider could cause excessive requests to the token endpoint, leading to blacklisting and denial-of-service. This version makes several adjustments to mitigate this: it caches the token in memory, reuses a single inflight request to the token endpoint, and backs off the token endpoint on a request failure. See [#301](https://github.com/camunda/zeebe-client-node-js/issues/301) for more details. Thanks to [@nhomble](https://github.com/nhomble) for raising this issue. # Version 8.1.6 @@ -139,8 +139,8 @@ _Things that shouldn't have a visible impact._ _New shiny stuff._ -- The ZBClient now implements the `modifyProcessInstance` API, introduced in Zeebe 8.1. This allows you to modify a running process instance, moving execution tokens and changing variables. This can be used, for example, to migrate a running process instance to a new version of the process model. See [#294](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/294) for more details. -- The ZBClient `createProcessInstance` method now allows you to specify `startInstructions` (introduced in Zeebe 8.1), allowing you to start a new process instance from an arbitrary point. Along with `modifyProcessInstance`, this is a powerful primitive for building migration functionality. See [[#295](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/295)] for more details. +- The ZBClient now implements the `modifyProcessInstance` API, introduced in Zeebe 8.1. This allows you to modify a running process instance, moving execution tokens and changing variables. This can be used, for example, to migrate a running process instance to a new version of the process model. See [#294](https://github.com/camunda/zeebe-client-node-js/issues/294) for more details. +- The ZBClient `createProcessInstance` method now allows you to specify `startInstructions` (introduced in Zeebe 8.1), allowing you to start a new process instance from an arbitrary point. Along with `modifyProcessInstance`, this is a powerful primitive for building migration functionality. See [[#295](https://github.com/camunda/zeebe-client-node-js/issues/295)] for more details. # Version 8.1.4 @@ -148,14 +148,14 @@ _New shiny stuff._ _Things that were broken and are now fixed._ -- The @grpc dependencies are now pinned to a specific version - 1.8.7 for grpc-js and 0.7.4 for proto-loader. This is to avoid broken upstream dependencies impacting installs. Previously, with the dependency unpinned, an install on different days could result in a library that worked, or did not work, depending on the state of the upstream libraries. Now, the same dependencies are installed every time, resulting in a consistent experience. Thanks to [@nikku](https://github.com/nikku) and [@barmac](https://github.com/barmac) from the [Camunda Modeler](https://github.com/camunda/camunda-modeler) team for identifying this. See [#290](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/290) for more context. -- The `docker` subdirectory is back, with a `docker-compose.yml` file to start a local broker for testing purposes. See [#289](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/289) for more details. +- The @grpc dependencies are now pinned to a specific version - 1.8.7 for grpc-js and 0.7.4 for proto-loader. This is to avoid broken upstream dependencies impacting installs. Previously, with the dependency unpinned, an install on different days could result in a library that worked, or did not work, depending on the state of the upstream libraries. Now, the same dependencies are installed every time, resulting in a consistent experience. Thanks to [@nikku](https://github.com/nikku) and [@barmac](https://github.com/barmac) from the [Camunda Modeler](https://github.com/camunda/camunda-modeler) team for identifying this. See [#290](https://github.com/camunda/zeebe-client-node-js/issues/290) for more context. +- The `docker` subdirectory is back, with a `docker-compose.yml` file to start a local broker for testing purposes. See [#289](https://github.com/camunda/zeebe-client-node-js/issues/289) for more details. ## New Features _New shiny stuff._ -- A custom SSL certificate is now able to be used for the oAuth endpoint. The `got` library used for the token exchange needs the certificate explicitly, and it can now be passed in as a `customRootCert` property to the `oAuth` property in the ZBClient constructor. Thanks to [luca-waldmann-cimt](https://github.com/luca-waldmann-cimt) for the feature. See [#284](https://github.com/camunda-community-hub/zeebe-client-node-js/pull/284) for more details. +- A custom SSL certificate is now able to be used for the oAuth endpoint. The `got` library used for the token exchange needs the certificate explicitly, and it can now be passed in as a `customRootCert` property to the `oAuth` property in the ZBClient constructor. Thanks to [luca-waldmann-cimt](https://github.com/luca-waldmann-cimt) for the feature. See [#284](https://github.com/camunda/zeebe-client-node-js/pull/284) for more details. # Version 8.1.2 @@ -163,13 +163,13 @@ _New shiny stuff._ _Things that were broken and are now fixed._ -- In 8.1.1, the update to the version of `got` introduced a regression that broke the OAuth token request with certain gateway configurations. This is now reverted, and a test has been introduced to ensure this regression does not happen again. See [#280](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/280) for more details. +- In 8.1.1, the update to the version of `got` introduced a regression that broke the OAuth token request with certain gateway configurations. This is now reverted, and a test has been introduced to ensure this regression does not happen again. See [#280](https://github.com/camunda/zeebe-client-node-js/issues/280) for more details. ## New Features _New shiny stuff._ -- Applications can now extend the user agent identifier by setting a value for the environment variable `ZEEBE_CLIENT_CUSTOM_AGENT_STRING`. This will be appended to the standard user agent string. See [#279](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/279) for more details. +- Applications can now extend the user agent identifier by setting a value for the environment variable `ZEEBE_CLIENT_CUSTOM_AGENT_STRING`. This will be appended to the standard user agent string. See [#279](https://github.com/camunda/zeebe-client-node-js/issues/279) for more details. # Version 8.1.1 @@ -177,7 +177,7 @@ _New shiny stuff._ _Things that shouldn't have a visible impact._ -- Bump got to 11.8.5 to fix [CVE-2022-33987](https://github.com/advisories/GHSA-pfrx-2q88-qq97). Thanks to [@nithinssabu](https://github.com/nithinssabu) for the PR. See [#275](https://github.com/camunda-community-hub/zeebe-client-node-js/pull/275) for more detail. +- Bump got to 11.8.5 to fix [CVE-2022-33987](https://github.com/advisories/GHSA-pfrx-2q88-qq97). Thanks to [@nithinssabu](https://github.com/nithinssabu) for the PR. See [#275](https://github.com/camunda/zeebe-client-node-js/pull/275) for more detail. # Version 8.1 @@ -191,9 +191,9 @@ _Changes in APIs or behaviour that may affect existing applications that use zee _Things that were broken and are now fixed._ -- Previously, the `connectionTolerance` option to `createWorker` did not take a `MaybeTimeDuration`, requiring users to provide a number (the value units is milliseconds). The signature has now been fixed, and `connectionTolerance` can now take a number or a typed Duration. See [#260](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/260) for more detail. Thanks to [@dancrumb](https://github.com/dancrumb) for reporting this. -- Previously, the autogenerated code for a BPMN model used the deprecated worker constructor and did not return the job acknowledgement token. It now uses the object constructor and correctly returns the job acknowledgement token. See [#257](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/257) for more details. Thanks to [@megankirkbride](https://github.com/megankirkbride) for reporting this issue. -- Previously, the OAuth token request sent by the library used JSON encoding. This worked with Camunda SaaS, but would fail with Keycloak in self-managed. The library now correctly encodes the request as x-www-form-urlencoded. See [#272](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/272) for more details. Thanks to [@AdrianErnstLGLN](https://github.com/AdrianErnstLGLN) for reporting this issue and providing a patch. +- Previously, the `connectionTolerance` option to `createWorker` did not take a `MaybeTimeDuration`, requiring users to provide a number (the value units is milliseconds). The signature has now been fixed, and `connectionTolerance` can now take a number or a typed Duration. See [#260](https://github.com/camunda/zeebe-client-node-js/issues/260) for more detail. Thanks to [@dancrumb](https://github.com/dancrumb) for reporting this. +- Previously, the autogenerated code for a BPMN model used the deprecated worker constructor and did not return the job acknowledgement token. It now uses the object constructor and correctly returns the job acknowledgement token. See [#257](https://github.com/camunda/zeebe-client-node-js/issues/257) for more details. Thanks to [@megankirkbride](https://github.com/megankirkbride) for reporting this issue. +- Previously, the OAuth token request sent by the library used JSON encoding. This worked with Camunda SaaS, but would fail with Keycloak in self-managed. The library now correctly encodes the request as x-www-form-urlencoded. See [#272](https://github.com/camunda/zeebe-client-node-js/issues/272) for more details. Thanks to [@AdrianErnstLGLN](https://github.com/AdrianErnstLGLN) for reporting this issue and providing a patch. # Version 8.0.3 @@ -201,7 +201,7 @@ _Things that were broken and are now fixed._ _Things that were broken and are now fixed._ -- Previously, the `fetchVariable` option passed to `createWorker` had no effect. All variables were always fetched by workers. This option setting is now respected, allowing you to constrain the variables fetched by workers. See [#264](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/264) for details. Thanks to [@Veckatimest](https://github.com/Veckatimest) for reporting this. +- Previously, the `fetchVariable` option passed to `createWorker` had no effect. All variables were always fetched by workers. This option setting is now respected, allowing you to constrain the variables fetched by workers. See [#264](https://github.com/camunda/zeebe-client-node-js/issues/264) for details. Thanks to [@Veckatimest](https://github.com/Veckatimest) for reporting this. # Version 8.0.2 @@ -209,7 +209,7 @@ _Things that were broken and are now fixed._ _Things that were broken and are now fixed._ -- Custom SSL certificates configured via environment variables now work correctly. See [PR #263](https://github.com/camunda-community-hub/zeebe-client-node-js/pull/263) for the details. Thanks to [@barmac](https://github.com/barmac) for the PR. +- Custom SSL certificates configured via environment variables now work correctly. See [PR #263](https://github.com/camunda/zeebe-client-node-js/pull/263) for the details. Thanks to [@barmac](https://github.com/barmac) for the PR. # Version 8.0.0 @@ -219,7 +219,7 @@ Version 8.0.0 is the release to support Camunda Platform 8. The semver change do _New shiny stuff._ -- Zeebe 8.0.0 and later support an optional retry backoff for failed jobs. This is a communication to the broker about how long it should delay before making the job available for activation again. This is implemented as a new interface for `job.fail`. See [[#248](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/248)] for more details. +- Zeebe 8.0.0 and later support an optional retry backoff for failed jobs. This is a communication to the broker about how long it should delay before making the job available for activation again. This is implemented as a new interface for `job.fail`. See [[#248](https://github.com/camunda/zeebe-client-node-js/issues/248)] for more details. # Version 2.4.0 @@ -227,13 +227,13 @@ _New shiny stuff._ _Changes in APIs or behaviour that may affect existing applications that use zeebe-node._ -- The C-based gRPC implementation has been removed in this release. It is unmaintained, and does not build with Node 17. The Zeebe Node client now uses the pure JS gRPC implementation and requires Node version 12.22.5+, 14.17.5+, or 16.6.1+. See [#201](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/201) and [#247](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/247) for more details. +- The C-based gRPC implementation has been removed in this release. It is unmaintained, and does not build with Node 17. The Zeebe Node client now uses the pure JS gRPC implementation and requires Node version 12.22.5+, 14.17.5+, or 16.6.1+. See [#201](https://github.com/camunda/zeebe-client-node-js/issues/201) and [#247](https://github.com/camunda/zeebe-client-node-js/issues/247) for more details. ## Known Issues _Things that don't work or don't work as expected, and which will be addressed in a future release_ -- The `onConnectionError` and `onReady` events do not work as expected. Applications that rely on these should not upgrade until this is fixed. See [#215](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/215). +- The `onConnectionError` and `onReady` events do not work as expected. Applications that rely on these should not upgrade until this is fixed. See [#215](https://github.com/camunda/zeebe-client-node-js/issues/215). # Version 1.3.5 @@ -241,8 +241,8 @@ _Things that don't work or don't work as expected, and which will be addressed i _Things that were broken and are now fixed._ -- Incident resolution via `ZBClient.resolveIncident()` now works. Thanks to [mrsateeshp](https://github.com/mrsateeshp) for the Pull Request. See [#242](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/242) for more details. -- Auth token retries now have an automatic back-off to avoid saturating the endpoint and getting blacklisted if invalid credentials are supplied. See [#244](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/244) for more details. +- Incident resolution via `ZBClient.resolveIncident()` now works. Thanks to [mrsateeshp](https://github.com/mrsateeshp) for the Pull Request. See [#242](https://github.com/camunda/zeebe-client-node-js/issues/242) for more details. +- Auth token retries now have an automatic back-off to avoid saturating the endpoint and getting blacklisted if invalid credentials are supplied. See [#244](https://github.com/camunda/zeebe-client-node-js/issues/244) for more details. # Version 1.3.3 @@ -250,13 +250,13 @@ _Things that were broken and are now fixed._ _Changes in APIs or behaviour that may affect existing applications that use zeebe-node._ -- Previously, you could pass an entire URL to the `clusterId` field in the `camundaCloud` option in the `ZBClient` constructor. The library would parse this and extract the cluster ID. With the changes to support multiple regions, this no longer works. From version 1.4.0, you must pass in only the cluster Id, not the complete URL. See [#232](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/232). +- Previously, you could pass an entire URL to the `clusterId` field in the `camundaCloud` option in the `ZBClient` constructor. The library would parse this and extract the cluster ID. With the changes to support multiple regions, this no longer works. From version 1.4.0, you must pass in only the cluster Id, not the complete URL. See [#232](https://github.com/camunda/zeebe-client-node-js/issues/232). ## New Features _New shiny stuff._ -- With Camunda Cloud 1.1, the DNS schema for the hosted service has been upgraded to include regions. To support this, the `camundaCloud` object in the ZBClient constructor now has an optional `clusterRegion` field. When no value is specified it defaults to `bru-2` (Belgium). See [#232](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/232). +- With Camunda Cloud 1.1, the DNS schema for the hosted service has been upgraded to include regions. To support this, the `camundaCloud` object in the ZBClient constructor now has an optional `clusterRegion` field. When no value is specified it defaults to `bru-2` (Belgium). See [#232](https://github.com/camunda/zeebe-client-node-js/issues/232). ## Chores @@ -271,7 +271,7 @@ _Things that shouldn't have a visible impact._ _Things that were broken and are now fixed._ -- Setting `maxRetries` and `maxRetryTimeout` in the ZBClient constructor had no effect. Only setting the environment variables `ZEEBE_CLIENT_MAX_RETRIES` and `ZEEBE_CLIENT_MAX_RETRY_TIMEOUT` had an effect. Now, the constructor options take effect. The constructor options will be overridden by the environment variables if those are set. See [#228](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/228). +- Setting `maxRetries` and `maxRetryTimeout` in the ZBClient constructor had no effect. Only setting the environment variables `ZEEBE_CLIENT_MAX_RETRIES` and `ZEEBE_CLIENT_MAX_RETRY_TIMEOUT` had an effect. Now, the constructor options take effect. The constructor options will be overridden by the environment variables if those are set. See [#228](https://github.com/camunda/zeebe-client-node-js/issues/228). # Version 1.3.1 @@ -279,7 +279,7 @@ _Things that were broken and are now fixed._ _Things that were broken and are now fixed._ -- The user agent was added to requests for an OAuth token, but not for gRPC calls. It is now set in the gRPC call metadata for all gRPC calls. Thanks to [@zelldon](https://github.com/Zelldon) for opening the issue and helping track it down. See [#225](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/225). +- The user agent was added to requests for an OAuth token, but not for gRPC calls. It is now set in the gRPC call metadata for all gRPC calls. Thanks to [@zelldon](https://github.com/Zelldon) for opening the issue and helping track it down. See [#225](https://github.com/camunda/zeebe-client-node-js/issues/225). # Version 1.3.0 @@ -291,22 +291,22 @@ Versions 1.0 - 1.2 were released two years ago, under the old numbering scheme. _Things that don't work or don't work as expected, and which will be addressed in a future release_ -- `onReady` and `onConnectionError` events are not firing reliably. At the moment, the `onConnectionError` is called even when a gateway is present and accessible, and `onReady` is not called. See [#215](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/215). -- The TLS connection does not work with self-managed Zeebe brokers secured with TLS. See [#218](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/218) and [#219](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/219). -- An exception in the gRPC layer can cause an application to exit. The workaround for this at the moment is to add a handler on the process for uncaught exceptions. See [#217](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/217). +- `onReady` and `onConnectionError` events are not firing reliably. At the moment, the `onConnectionError` is called even when a gateway is present and accessible, and `onReady` is not called. See [#215](https://github.com/camunda/zeebe-client-node-js/issues/215). +- The TLS connection does not work with self-managed Zeebe brokers secured with TLS. See [#218](https://github.com/camunda/zeebe-client-node-js/issues/218) and [#219](https://github.com/camunda/zeebe-client-node-js/issues/219). +- An exception in the gRPC layer can cause an application to exit. The workaround for this at the moment is to add a handler on the process for uncaught exceptions. See [#217](https://github.com/camunda/zeebe-client-node-js/issues/217). ## Breaking changes _Changes in APIs or behaviour that may affect existing applications that use zeebe-node._ -- The Zeebe API has changed in 1.0.0 and uses a gRPC protocol that is incompatible with pre-1.0.0 brokers. _The 1.0.0 package will not work with a pre-1.0.0 broker_. Nor will a pre-1.0.0 version of `zeebe-node` work with a 1.0.0 broker. See [#208](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/208). -- The worker task handler has a new type signature: `job => Promise`. This means that all code branches in the worker handler must return a `complete` method call (deprecated), or one of the new `job.complete`, `job.fail`, `job.error`, `job.forward`, or `job.cancelWorkflowInstance` methods. This signature means that the type system can now do an exhaustiveness check to detect code paths that will always time out in the worker. See [#210](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/210). +- The Zeebe API has changed in 1.0.0 and uses a gRPC protocol that is incompatible with pre-1.0.0 brokers. _The 1.0.0 package will not work with a pre-1.0.0 broker_. Nor will a pre-1.0.0 version of `zeebe-node` work with a 1.0.0 broker. See [#208](https://github.com/camunda/zeebe-client-node-js/issues/208). +- The worker task handler has a new type signature: `job => Promise`. This means that all code branches in the worker handler must return a `complete` method call (deprecated), or one of the new `job.complete`, `job.fail`, `job.error`, `job.forward`, or `job.cancelWorkflowInstance` methods. This signature means that the type system can now do an exhaustiveness check to detect code paths that will always time out in the worker. See [#210](https://github.com/camunda/zeebe-client-node-js/issues/210). ## Deprecations _Things that are deprecated and will be removed in a future release. Existing code will work for now, but should be migrated at some point. New code should not use these features._ -- The previous methods with the word `workflow` in them (e.g.: `deployWorkflow`, `startWorkflowInstance`) are deprecated. In the 1.0.0 package they transparently call the new methods with `process` in them (e.g.: `deployProcess`, `startProcessInstance`), so existing code does not need to be rewritten. However, new code should not use these deprecated methods. These methods are scheduled to be removed in whichever comes first: the 1.2.0 release, or three months from the release of the 1.0.0 release. See [#208](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/208). +- The previous methods with the word `workflow` in them (e.g.: `deployWorkflow`, `startWorkflowInstance`) are deprecated. In the 1.0.0 package they transparently call the new methods with `process` in them (e.g.: `deployProcess`, `startProcessInstance`), so existing code does not need to be rewritten. However, new code should not use these deprecated methods. These methods are scheduled to be removed in whichever comes first: the 1.2.0 release, or three months from the release of the 1.0.0 release. See [#208](https://github.com/camunda/zeebe-client-node-js/issues/208). - The `complete` parameter in the worker task handler callback is deprecated, and will be removed in a future release. Use the new methods on the `job` object instead. - The non-object constructors for `createWorker` are deprecated, and will be removed in a future release. Use the object constructor instead. @@ -314,9 +314,9 @@ _Things that are deprecated and will be removed in a future release. Existing co _New shiny stuff._ -- The worker task handler now has a new signature: `job => Promise`. The `complete` parameter is deprecated, and the job object now has the methods `job.complete`, `job.fail`, `job.error`, `job.forward`. See [#209](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/209). -- The `job` object has a new method `job.cancelWorkflowInstance`. This allows you to cancel a workflow from within a worker, and return a `Promise` in the worker handler. See [#211](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/211). -- Attempting to call two outcome methods on a job (for example: `job.complete()` and `job.fail()`, or the deprecated `complete.success()` and `complete.error()`) will now log an error to the console, alerting you to the behaviour and identifying the task type of the worker. See [#213](https://github.com/camunda-community-hub/zeebe-client-node-js/issues/213). +- The worker task handler now has a new signature: `job => Promise`. The `complete` parameter is deprecated, and the job object now has the methods `job.complete`, `job.fail`, `job.error`, `job.forward`. See [#209](https://github.com/camunda/zeebe-client-node-js/issues/209). +- The `job` object has a new method `job.cancelWorkflowInstance`. This allows you to cancel a workflow from within a worker, and return a `Promise` in the worker handler. See [#211](https://github.com/camunda/zeebe-client-node-js/issues/211). +- Attempting to call two outcome methods on a job (for example: `job.complete()` and `job.fail()`, or the deprecated `complete.success()` and `complete.error()`) will now log an error to the console, alerting you to the behaviour and identifying the task type of the worker. See [#213](https://github.com/camunda/zeebe-client-node-js/issues/213). # Version 0.26.0 diff --git a/zeebe-extra/DEVELOP.md b/zeebe-extra/DEVELOP.md index 32472ffd..f42fd1fd 100644 --- a/zeebe-extra/DEVELOP.md +++ b/zeebe-extra/DEVELOP.md @@ -64,7 +64,7 @@ sudo apt install -y build-essential curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.2/install.sh | bash source ~/.bashrc nvm install 14 -git clone https://github.com/camunda-community-hub/zeebe-client-node-js.git +git clone https://github.com/camunda/zeebe-client-node-js.git cd zeebe-client-node-js npm i diff --git a/zeebe-extra/package.json b/zeebe-extra/package.json index 063829be..893fe02d 100644 --- a/zeebe-extra/package.json +++ b/zeebe-extra/package.json @@ -18,13 +18,13 @@ "Uber", "Cadence" ], - "homepage": "https://camunda-community-hub.github.io/camunda-8-js-sdk/", + "homepage": "https://camunda.github.io/camunda-8-js-sdk/", "bugs": { - "url": "https://github.com/camunda-community-hub/camunda-8-js-sdk/issues" + "url": "https://github.com/camunda/camunda-8-js-sdk/issues" }, "repository": { "type": "git", - "url": "git+https://github.com/camunda-community-hub/camunda-8-js-sdk.git" + "url": "git+https://github.com/camunda/camunda-8-js-sdk.git" }, "private": false, "publishConfig": { From 4d725846cb6806741c4e167f8132307742f01739 Mon Sep 17 00:00:00 2001 From: Josh Wulf Date: Mon, 8 Apr 2024 17:04:09 +1200 Subject: [PATCH 2/7] release: trigger a new release From fd52cf081e612b5c649427522ae8319aecfa970b Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Mon, 8 Apr 2024 05:17:46 +0000 Subject: [PATCH 3/7] chore(release): 8.4.1 [skip ci] ## [8.4.1](https://github.com/camunda/camunda-8-js-sdk/compare/v8.4.0...v8.4.1) (2024-04-08) ### Features * **oauth:** support optional scope in OAuth request ([#25](https://github.com/camunda/camunda-8-js-sdk/issues/25)) ([0451b80](https://github.com/camunda/camunda-8-js-sdk/commit/0451b802594f76518830b9bdff515d67fc0231b9)) * **operate:** add multitenant support and lossless Json parsing ([#82](https://github.com/camunda/camunda-8-js-sdk/issues/82)) ([cf49a71](https://github.com/camunda/camunda-8-js-sdk/commit/cf49a717e2632af845529b3c1fde85ee1b0b347b)), closes [#78](https://github.com/camunda/camunda-8-js-sdk/issues/78) [#67](https://github.com/camunda/camunda-8-js-sdk/issues/67) * **repo:** add enhanced debug output for http errors ([#88](https://github.com/camunda/camunda-8-js-sdk/issues/88)) ([881b039](https://github.com/camunda/camunda-8-js-sdk/commit/881b03965cc37431885a76291f7c0aa762f26227)), closes [#87](https://github.com/camunda/camunda-8-js-sdk/issues/87) * **tasklist:** add multitenant support to tasklist ([#85](https://github.com/camunda/camunda-8-js-sdk/issues/85)) ([46bb564](https://github.com/camunda/camunda-8-js-sdk/commit/46bb564365afc3bc6758cd436490a459708128e6)) * **zeebe:** add MigrateProcessInstance ([#97](https://github.com/camunda/camunda-8-js-sdk/issues/97)) ([2a9a123](https://github.com/camunda/camunda-8-js-sdk/commit/2a9a1232b160962f86b9450edd9047a8a933068a)), closes [#49](https://github.com/camunda/camunda-8-js-sdk/issues/49) * **zeebe:** implement deleteResource ([#73](https://github.com/camunda/camunda-8-js-sdk/issues/73)) ([0cd08b7](https://github.com/camunda/camunda-8-js-sdk/commit/0cd08b7b85d23ab44e42b36b2d9b48c1cfcb8c63)) * **zeebe:** implement lossless parsing of job payload ([#95](https://github.com/camunda/camunda-8-js-sdk/issues/95)) ([57f3ea8](https://github.com/camunda/camunda-8-js-sdk/commit/57f3ea85d4cf86256301f5f2a9bcead09c01a199)), closes [#81](https://github.com/camunda/camunda-8-js-sdk/issues/81) * **zeebe:** normalise useragent, thread config ([#94](https://github.com/camunda/camunda-8-js-sdk/issues/94)) ([c1c4211](https://github.com/camunda/camunda-8-js-sdk/commit/c1c4211db11173c56d2410f489503ef9acf185f2)) * **zeebe:** remove deployProcess method ([#71](https://github.com/camunda/camunda-8-js-sdk/issues/71)) ([6cb98f0](https://github.com/camunda/camunda-8-js-sdk/commit/6cb98f0ff3baf643015bacfa690f4f119caf6083)) --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index f641b62f..5eaa4f58 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@camunda8/sdk", - "version": "8.5.0-alpha.6", + "version": "8.4.1", "description": "", "main": "dist/index.js", "scripts": { From f41ec5d770b3c13671b1cd4d6c766ce1f5d6ea91 Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Mon, 8 Apr 2024 05:17:47 +0000 Subject: [PATCH 4/7] chore(release): 8.4.1 [skip ci] ## [8.4.1](https://github.com/camunda/camunda-8-js-sdk/compare/v8.4.0...v8.4.1) (2024-04-08) ### Features * **oauth:** support optional scope in OAuth request ([#25](https://github.com/camunda/camunda-8-js-sdk/issues/25)) ([0451b80](https://github.com/camunda/camunda-8-js-sdk/commit/0451b802594f76518830b9bdff515d67fc0231b9)) * **operate:** add multitenant support and lossless Json parsing ([#82](https://github.com/camunda/camunda-8-js-sdk/issues/82)) ([cf49a71](https://github.com/camunda/camunda-8-js-sdk/commit/cf49a717e2632af845529b3c1fde85ee1b0b347b)), closes [#78](https://github.com/camunda/camunda-8-js-sdk/issues/78) [#67](https://github.com/camunda/camunda-8-js-sdk/issues/67) * **repo:** add enhanced debug output for http errors ([#88](https://github.com/camunda/camunda-8-js-sdk/issues/88)) ([881b039](https://github.com/camunda/camunda-8-js-sdk/commit/881b03965cc37431885a76291f7c0aa762f26227)), closes [#87](https://github.com/camunda/camunda-8-js-sdk/issues/87) * **tasklist:** add multitenant support to tasklist ([#85](https://github.com/camunda/camunda-8-js-sdk/issues/85)) ([46bb564](https://github.com/camunda/camunda-8-js-sdk/commit/46bb564365afc3bc6758cd436490a459708128e6)) * **zeebe:** add MigrateProcessInstance ([#97](https://github.com/camunda/camunda-8-js-sdk/issues/97)) ([2a9a123](https://github.com/camunda/camunda-8-js-sdk/commit/2a9a1232b160962f86b9450edd9047a8a933068a)), closes [#49](https://github.com/camunda/camunda-8-js-sdk/issues/49) * **zeebe:** implement deleteResource ([#73](https://github.com/camunda/camunda-8-js-sdk/issues/73)) ([0cd08b7](https://github.com/camunda/camunda-8-js-sdk/commit/0cd08b7b85d23ab44e42b36b2d9b48c1cfcb8c63)) * **zeebe:** implement lossless parsing of job payload ([#95](https://github.com/camunda/camunda-8-js-sdk/issues/95)) ([57f3ea8](https://github.com/camunda/camunda-8-js-sdk/commit/57f3ea85d4cf86256301f5f2a9bcead09c01a199)), closes [#81](https://github.com/camunda/camunda-8-js-sdk/issues/81) * **zeebe:** normalise useragent, thread config ([#94](https://github.com/camunda/camunda-8-js-sdk/issues/94)) ([c1c4211](https://github.com/camunda/camunda-8-js-sdk/commit/c1c4211db11173c56d2410f489503ef9acf185f2)) * **zeebe:** remove deployProcess method ([#71](https://github.com/camunda/camunda-8-js-sdk/issues/71)) ([6cb98f0](https://github.com/camunda/camunda-8-js-sdk/commit/6cb98f0ff3baf643015bacfa690f4f119caf6083)) --- CHANGELOG.md | 15 +++++++++++++++ package-lock.json | 4 ++-- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 32632eaa..3ec5cdd0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,18 @@ +## [8.4.1](https://github.com/camunda/camunda-8-js-sdk/compare/v8.4.0...v8.4.1) (2024-04-08) + + +### Features + +* **oauth:** support optional scope in OAuth request ([#25](https://github.com/camunda/camunda-8-js-sdk/issues/25)) ([0451b80](https://github.com/camunda/camunda-8-js-sdk/commit/0451b802594f76518830b9bdff515d67fc0231b9)) +* **operate:** add multitenant support and lossless Json parsing ([#82](https://github.com/camunda/camunda-8-js-sdk/issues/82)) ([cf49a71](https://github.com/camunda/camunda-8-js-sdk/commit/cf49a717e2632af845529b3c1fde85ee1b0b347b)), closes [#78](https://github.com/camunda/camunda-8-js-sdk/issues/78) [#67](https://github.com/camunda/camunda-8-js-sdk/issues/67) +* **repo:** add enhanced debug output for http errors ([#88](https://github.com/camunda/camunda-8-js-sdk/issues/88)) ([881b039](https://github.com/camunda/camunda-8-js-sdk/commit/881b03965cc37431885a76291f7c0aa762f26227)), closes [#87](https://github.com/camunda/camunda-8-js-sdk/issues/87) +* **tasklist:** add multitenant support to tasklist ([#85](https://github.com/camunda/camunda-8-js-sdk/issues/85)) ([46bb564](https://github.com/camunda/camunda-8-js-sdk/commit/46bb564365afc3bc6758cd436490a459708128e6)) +* **zeebe:** add MigrateProcessInstance ([#97](https://github.com/camunda/camunda-8-js-sdk/issues/97)) ([2a9a123](https://github.com/camunda/camunda-8-js-sdk/commit/2a9a1232b160962f86b9450edd9047a8a933068a)), closes [#49](https://github.com/camunda/camunda-8-js-sdk/issues/49) +* **zeebe:** implement deleteResource ([#73](https://github.com/camunda/camunda-8-js-sdk/issues/73)) ([0cd08b7](https://github.com/camunda/camunda-8-js-sdk/commit/0cd08b7b85d23ab44e42b36b2d9b48c1cfcb8c63)) +* **zeebe:** implement lossless parsing of job payload ([#95](https://github.com/camunda/camunda-8-js-sdk/issues/95)) ([57f3ea8](https://github.com/camunda/camunda-8-js-sdk/commit/57f3ea85d4cf86256301f5f2a9bcead09c01a199)), closes [#81](https://github.com/camunda/camunda-8-js-sdk/issues/81) +* **zeebe:** normalise useragent, thread config ([#94](https://github.com/camunda/camunda-8-js-sdk/issues/94)) ([c1c4211](https://github.com/camunda/camunda-8-js-sdk/commit/c1c4211db11173c56d2410f489503ef9acf185f2)) +* **zeebe:** remove deployProcess method ([#71](https://github.com/camunda/camunda-8-js-sdk/issues/71)) ([6cb98f0](https://github.com/camunda/camunda-8-js-sdk/commit/6cb98f0ff3baf643015bacfa690f4f119caf6083)) + # [8.5.0-alpha.6](https://github.com/camunda/camunda-8-js-sdk/compare/v8.5.0-alpha.5...v8.5.0-alpha.6) (2024-04-08) diff --git a/package-lock.json b/package-lock.json index 3e1cff99..b41d3586 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@camunda8/sdk", - "version": "8.5.0-alpha.6", + "version": "8.4.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@camunda8/sdk", - "version": "8.5.0-alpha.6", + "version": "8.4.1", "license": "Apache 2.0", "dependencies": { "@grpc/grpc-js": "1.9.7", From 18f5ecccd8c4aab00d996706ec58417e6a0de623 Mon Sep 17 00:00:00 2001 From: Josh Wulf Date: Mon, 8 Apr 2024 18:31:45 +1200 Subject: [PATCH 5/7] minor(repo): force minor release From afab1790a453b806561e68b62bda0d86c16ed38c Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Mon, 8 Apr 2024 06:46:33 +0000 Subject: [PATCH 6/7] chore(release): 8.5.0 [skip ci] # [8.5.0](https://github.com/camunda/camunda-8-js-sdk/compare/v8.4.1...v8.5.0) (2024-04-08) ### Bug Fixes * **issue118:** add smoke test and type surface tests ([fe0c709](https://github.com/camunda/camunda-8-js-sdk/commit/fe0c70925cf3df610b049e776eed5bffe56ef604)), closes [#118](https://github.com/camunda/camunda-8-js-sdk/issues/118) * **repo:** add note on "supported" ([#107](https://github.com/camunda/camunda-8-js-sdk/issues/107)) ([fc45d61](https://github.com/camunda/camunda-8-js-sdk/commit/fc45d618bc459a06fbf76bd6907511d08e1f583b)), closes [#70](https://github.com/camunda/camunda-8-js-sdk/issues/70) * **repo:** make fix type commits release a new package ([ded83cf](https://github.com/camunda/camunda-8-js-sdk/commit/ded83cfaf437a2f62a5ef134d7616538facda614)) * **repo:** only git commit on npm publish success ([9012764](https://github.com/camunda/camunda-8-js-sdk/commit/901276451845c5dbd926af0a6563d5564d3e87b9)) * **repo:** use ts-patch to transform module mapping in output ([#112](https://github.com/camunda/camunda-8-js-sdk/issues/112)) ([7efdcf3](https://github.com/camunda/camunda-8-js-sdk/commit/7efdcf3478a0d68b4f1cbc62c1526ba7275008b0)), closes [#110](https://github.com/camunda/camunda-8-js-sdk/issues/110) --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index f641b62f..090e292b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@camunda8/sdk", - "version": "8.5.0-alpha.6", + "version": "8.5.0", "description": "", "main": "dist/index.js", "scripts": { From 666e3fe1a40b7866386d52eb621b83214649aa6a Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Mon, 8 Apr 2024 06:46:34 +0000 Subject: [PATCH 7/7] chore(release): 8.5.0 [skip ci] # [8.5.0](https://github.com/camunda/camunda-8-js-sdk/compare/v8.4.1...v8.5.0) (2024-04-08) ### Bug Fixes * **issue118:** add smoke test and type surface tests ([fe0c709](https://github.com/camunda/camunda-8-js-sdk/commit/fe0c70925cf3df610b049e776eed5bffe56ef604)), closes [#118](https://github.com/camunda/camunda-8-js-sdk/issues/118) * **repo:** add note on "supported" ([#107](https://github.com/camunda/camunda-8-js-sdk/issues/107)) ([fc45d61](https://github.com/camunda/camunda-8-js-sdk/commit/fc45d618bc459a06fbf76bd6907511d08e1f583b)), closes [#70](https://github.com/camunda/camunda-8-js-sdk/issues/70) * **repo:** make fix type commits release a new package ([ded83cf](https://github.com/camunda/camunda-8-js-sdk/commit/ded83cfaf437a2f62a5ef134d7616538facda614)) * **repo:** only git commit on npm publish success ([9012764](https://github.com/camunda/camunda-8-js-sdk/commit/901276451845c5dbd926af0a6563d5564d3e87b9)) * **repo:** use ts-patch to transform module mapping in output ([#112](https://github.com/camunda/camunda-8-js-sdk/issues/112)) ([7efdcf3](https://github.com/camunda/camunda-8-js-sdk/commit/7efdcf3478a0d68b4f1cbc62c1526ba7275008b0)), closes [#110](https://github.com/camunda/camunda-8-js-sdk/issues/110) --- CHANGELOG.md | 10 ++++++++++ package-lock.json | 4 ++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 73a5ba79..f39f9c2f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,13 @@ +# [8.5.0](https://github.com/camunda/camunda-8-js-sdk/compare/v8.4.1...v8.5.0) (2024-04-08) + + +### Bug Fixes + +* **issue118:** add smoke test and type surface tests ([fe0c709](https://github.com/camunda/camunda-8-js-sdk/commit/fe0c70925cf3df610b049e776eed5bffe56ef604)), closes [#118](https://github.com/camunda/camunda-8-js-sdk/issues/118) +* **repo:** add note on "supported" ([#107](https://github.com/camunda/camunda-8-js-sdk/issues/107)) ([fc45d61](https://github.com/camunda/camunda-8-js-sdk/commit/fc45d618bc459a06fbf76bd6907511d08e1f583b)), closes [#70](https://github.com/camunda/camunda-8-js-sdk/issues/70) +* **repo:** make fix type commits release a new package ([ded83cf](https://github.com/camunda/camunda-8-js-sdk/commit/ded83cfaf437a2f62a5ef134d7616538facda614)) +* **repo:** only git commit on npm publish success ([9012764](https://github.com/camunda/camunda-8-js-sdk/commit/901276451845c5dbd926af0a6563d5564d3e87b9)) +* **repo:** use ts-patch to transform module mapping in output ([#112](https://github.com/camunda/camunda-8-js-sdk/issues/112)) ([7efdcf3](https://github.com/camunda/camunda-8-js-sdk/commit/7efdcf3478a0d68b4f1cbc62c1526ba7275008b0)), closes [#110](https://github.com/camunda/camunda-8-js-sdk/issues/110) ## [8.4.1](https://github.com/camunda/camunda-8-js-sdk/compare/v8.4.0...v8.4.1) (2024-04-08) diff --git a/package-lock.json b/package-lock.json index 3e1cff99..4dcab213 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@camunda8/sdk", - "version": "8.5.0-alpha.6", + "version": "8.5.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@camunda8/sdk", - "version": "8.5.0-alpha.6", + "version": "8.5.0", "license": "Apache 2.0", "dependencies": { "@grpc/grpc-js": "1.9.7",