Deploying to gh-pages from @ 4fb36d7 🚀

camunda · May 8, 2024 · 17f2eb7 · 17f2eb7
1 parent 3bb58c8
commit 17f2eb7
Show file tree

Hide file tree

Showing 243 changed files with 773 additions and 773 deletions.
diff --git a/classes/index.Admin.AdminApiClient.html b/classes/index.Admin.AdminApiClient.html
diff --git a/classes/index.Auth.NullAuthProvider.html b/classes/index.Auth.NullAuthProvider.html
diff --git a/classes/index.Auth.OAuthProvider.html b/classes/index.Auth.OAuthProvider.html
diff --git a/classes/index.Camunda8.html b/classes/index.Camunda8.html
diff --git a/classes/index.Modeler.ModelerApiClient.html b/classes/index.Modeler.ModelerApiClient.html
diff --git a/classes/index.Operate.OperateApiClient.html b/classes/index.Operate.OperateApiClient.html
diff --git a/classes/index.Operate.OperateDto.ChangeStatus.html b/classes/index.Operate.OperateDto.ChangeStatus.html
diff --git a/classes/index.Operate.OperateDto.DecisionDefinition.html b/classes/index.Operate.OperateDto.DecisionDefinition.html
diff --git a/classes/index.Operate.OperateDto.DecisionInstance.html b/classes/index.Operate.OperateDto.DecisionInstance.html
diff --git a/classes/index.Operate.OperateDto.DecisionInstanceInput.html b/classes/index.Operate.OperateDto.DecisionInstanceInput.html
diff --git a/classes/index.Operate.OperateDto.DecisionInstanceOutput.html b/classes/index.Operate.OperateDto.DecisionInstanceOutput.html
diff --git a/classes/index.Operate.OperateDto.DecisionRequirements.html b/classes/index.Operate.OperateDto.DecisionRequirements.html
diff --git a/classes/index.Operate.OperateDto.FlownodeInstance.html b/classes/index.Operate.OperateDto.FlownodeInstance.html
diff --git a/classes/index.Operate.OperateDto.Incident.html b/classes/index.Operate.OperateDto.Incident.html
diff --git a/classes/index.Operate.OperateDto.ProcessDefinition.html b/classes/index.Operate.OperateDto.ProcessDefinition.html
diff --git a/classes/index.Operate.OperateDto.ProcessInstance.html b/classes/index.Operate.OperateDto.ProcessInstance.html
diff --git a/classes/index.Operate.OperateDto.ProcessInstanceStatistics.html b/classes/index.Operate.OperateDto.ProcessInstanceStatistics.html
diff --git a/classes/index.Operate.OperateDto.Variable.html b/classes/index.Operate.OperateDto.Variable.html
diff --git a/classes/index.Optimize.OptimizeApiClient.html b/classes/index.Optimize.OptimizeApiClient.html
diff --git a/classes/index.Tasklist.TasklistApiClient.html b/classes/index.Tasklist.TasklistApiClient.html
diff --git a/classes/index.Tasklist.TasklistDto.Form.html b/classes/index.Tasklist.TasklistDto.Form.html
diff --git a/classes/index.Tasklist.TasklistDto.TaskResponse.html b/classes/index.Tasklist.TasklistDto.TaskResponse.html
diff --git a/classes/index.Tasklist.TasklistDto.TaskSearchResponse.html b/classes/index.Tasklist.TasklistDto.TaskSearchResponse.html
diff --git a/classes/index.Zeebe.BpmnParser.html b/classes/index.Zeebe.BpmnParser.html
diff --git a/classes/index.Zeebe.ZBWorker.html b/classes/index.Zeebe.ZBWorker.html
diff --git a/classes/index.Zeebe.ZeebeGrpcClient.html b/classes/index.Zeebe.ZeebeGrpcClient.html
diff --git a/classes/index._internal_.HTTPError.html b/classes/index._internal_.HTTPError.html
diff --git a/classes/index._internal_.LosslessDto.html b/classes/index._internal_.LosslessDto.html
diff --git a/classes/index._internal_.StatefulLogInterceptor.html b/classes/index._internal_.StatefulLogInterceptor.html
diff --git a/classes/index._internal_.TypedEmitter.html b/classes/index._internal_.TypedEmitter.html
diff --git a/classes/index._internal_.ZBLogger.html b/classes/index._internal_.ZBLogger.html
diff --git a/classes/index._internal_.ZBWorkerBase.html b/classes/index._internal_.ZBWorkerBase.html
diff --git a/classes/zeebe_types._internal_.GrpcClient.html b/classes/zeebe_types._internal_.GrpcClient.html
diff --git a/enums/index.Zeebe.Types.PartitionBrokerHealth.html b/enums/index.Zeebe.Types.PartitionBrokerHealth.html
diff --git a/enums/index.Zeebe.Types.PartitionBrokerRole.html b/enums/index.Zeebe.Types.PartitionBrokerRole.html
diff --git a/index.html b/index.html
@@ -32,7 +32,7 @@
 <p>You can turn off the disk caching by setting <code>CAMUNDA_TOKEN_DISK_CACHE_DISABLE</code> to true. This will cache tokens in-memory only.</p>
 <p>By default, the token cache directory is <code>$HOME/.camunda</code>. You can specify a different directory by providing a full file path value for <code>CAMUNDA_TOKEN_CACHE_DIR</code>.</p>
 <p>Here is an example of specifying a different cache directory via the constructor:</p>
-<pre><code class="language-typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Camunda8</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@camunda8/sdk&#39;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">c8</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">Camunda8</span><span class="hl-1">({</span><br/><span class="hl-1">    </span><span class="hl-4">config:</span><span class="hl-1"> {</span><br/><span class="hl-1">        </span><span class="hl-4">CAMUNDA_TOKEN_CACHE_DIR:</span><span class="hl-1"> </span><span class="hl-2">&#39;/tmp/cache&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">    },</span><br/><span class="hl-1">})</span>
+<pre><code class="language-typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Camunda8</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@camunda8/sdk&#39;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">c8</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">Camunda8</span><span class="hl-1">({</span><br/><span class="hl-1">    </span><span class="hl-4">CAMUNDA_TOKEN_CACHE_DIR:</span><span class="hl-1"> </span><span class="hl-2">&#39;/tmp/cache&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">})</span>
 </code><button>Copy</button></pre>
 <p>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, the SDK will throw an exception.</p>
 <a id="md:connection-configuration-examples" class="tsd-anchor"></a><h2><a href="#md:connection-configuration-examples">Connection configuration examples</a></h2><a id="md:self-managed" class="tsd-anchor"></a><h3><a href="#md:self-managed">Self-Managed</a></h3><p>This is the complete environment configuration needed to run against the Dockerised Self-Managed stack in the <code>docker</code> subdirectory:</p>
@@ -42,7 +42,7 @@
 <pre><code><span class="hl-6">CAMUNDA_TOKEN_SCOPE</span>
 </code><button>Copy</button></pre>
 <p>Here is an example of doing this via the constructor, rather than via the environment:</p>
-<pre><code class="language-typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Camunda8</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@camunda8/sdk&#39;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">c8</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">Camunda8</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-4">config:</span><span class="hl-1"> {</span><br/><span class="hl-1">    </span><span class="hl-4">ZEEBE_ADDRESS:</span><span class="hl-1"> </span><span class="hl-2">&#39;localhost:26500&#39;</span><br/><span class="hl-1">    </span><span class="hl-6">ZEEBE_CLIENT_ID</span><span class="hl-1">: </span><span class="hl-2">&#39;zeebe&#39;</span><br/><span class="hl-1">    </span><span class="hl-6">ZEEBE_CLIENT_SECRET</span><span class="hl-1">: </span><span class="hl-2">&#39;zecret&#39;</span><br/><span class="hl-1">    </span><span class="hl-6">CAMUNDA_OAUTH_URL</span><span class="hl-1">: </span><span class="hl-2">&#39;http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token&#39;</span><br/><span class="hl-1">    </span><span class="hl-6">CAMUNDA_TASKLIST_BASE_URL</span><span class="hl-1">: </span><span class="hl-2">&#39;http://localhost:8082&#39;</span><br/><span class="hl-1">    </span><span class="hl-6">CAMUNDA_OPERATE_BASE_URL</span><span class="hl-1">: </span><span class="hl-2">&#39;http://localhost:8081&#39;</span><br/><span class="hl-1">    </span><span class="hl-6">CAMUNDA_OPTIMIZE_BASE_URL</span><span class="hl-1">: </span><span class="hl-2">&#39;http://localhost:8083&#39;</span><br/><span class="hl-1">    </span><span class="hl-6">CAMUNDA_MODELER_BASE_URL</span><span class="hl-1">: </span><span class="hl-2">&#39;http://localhost:8070/api&#39;</span><br/><span class="hl-1">    </span><span class="hl-6">CAMUNDA_TENANT_ID</span><span class="hl-1">: </span><span class="hl-2">&#39;&#39;</span><span class="hl-1"> </span><span class="hl-7">// We can override values in the env by passing an empty string value</span><br/><span class="hl-1">    </span><span class="hl-6">CAMUNDA_SECURE_CONNECTION</span><span class="hl-1">: </span><span class="hl-5">false</span><br/><span class="hl-1">  }</span><br/><span class="hl-1">})</span>
+<pre><code class="language-typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Camunda8</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@camunda8/sdk&#39;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">c8</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">Camunda8</span><span class="hl-1">({</span><br/><span class="hl-1">    </span><span class="hl-4">ZEEBE_ADDRESS:</span><span class="hl-1"> </span><span class="hl-2">&#39;localhost:26500&#39;</span><br/><span class="hl-1">    </span><span class="hl-6">ZEEBE_CLIENT_ID</span><span class="hl-1">: </span><span class="hl-2">&#39;zeebe&#39;</span><br/><span class="hl-1">    </span><span class="hl-6">ZEEBE_CLIENT_SECRET</span><span class="hl-1">: </span><span class="hl-2">&#39;zecret&#39;</span><br/><span class="hl-1">    </span><span class="hl-6">CAMUNDA_OAUTH_URL</span><span class="hl-1">: </span><span class="hl-2">&#39;http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token&#39;</span><br/><span class="hl-1">    </span><span class="hl-6">CAMUNDA_TASKLIST_BASE_URL</span><span class="hl-1">: </span><span class="hl-2">&#39;http://localhost:8082&#39;</span><br/><span class="hl-1">    </span><span class="hl-6">CAMUNDA_OPERATE_BASE_URL</span><span class="hl-1">: </span><span class="hl-2">&#39;http://localhost:8081&#39;</span><br/><span class="hl-1">    </span><span class="hl-6">CAMUNDA_OPTIMIZE_BASE_URL</span><span class="hl-1">: </span><span class="hl-2">&#39;http://localhost:8083&#39;</span><br/><span class="hl-1">    </span><span class="hl-6">CAMUNDA_MODELER_BASE_URL</span><span class="hl-1">: </span><span class="hl-2">&#39;http://localhost:8070/api&#39;</span><br/><span class="hl-1">    </span><span class="hl-6">CAMUNDA_TENANT_ID</span><span class="hl-1">: </span><span class="hl-2">&#39;&#39;</span><span class="hl-1"> </span><span class="hl-7">// We can override values in the env by passing an empty string value</span><br/><span class="hl-1">    </span><span class="hl-6">CAMUNDA_SECURE_CONNECTION</span><span class="hl-1">: </span><span class="hl-5">false</span><br/><span class="hl-1">})</span>
 </code><button>Copy</button></pre>
 <a id="md:camunda-saas" class="tsd-anchor"></a><h3><a href="#md:camunda-saas">Camunda SaaS</a></h3><p>Here is a complete configuration example for connection to Camunda SaaS:</p>
 <pre><code class="language-bash"><span class="hl-5">export</span><span class="hl-1"> </span><span class="hl-4">ZEEBE_ADDRESS</span><span class="hl-1">=</span><span class="hl-2">&#39;5c34c0a7-7f29-4424-8414-125615f7a9b9.syd-1.zeebe.camunda.io:443&#39;</span><br/><span class="hl-5">export</span><span class="hl-1"> </span><span class="hl-4">ZEEBE_CLIENT_ID</span><span class="hl-1">=</span><span class="hl-2">&#39;yvvURO9TmBnP3zx4Xd8Ho6apgeiZTjn6&#39;</span><br/><span class="hl-5">export</span><span class="hl-1"> </span><span class="hl-4">ZEEBE_CLIENT_SECRET</span><span class="hl-1">=</span><span class="hl-2">&#39;iJJu-SHgUtuJTTAMnMLdcb8WGF8s2mHfXhXutEwe8eSbLXn98vUpoxtuLk5uG0en&#39;</span><br/><span class="hl-7"># export CAMUNDA_CREDENTIALS_SCOPES=&#39;Zeebe,Tasklist,Operate,Optimize&#39; # What APIs these client creds are authorised for</span><br/><span class="hl-5">export</span><span class="hl-1"> </span><span class="hl-4">CAMUNDA_TASKLIST_BASE_URL</span><span class="hl-1">=</span><span class="hl-2">&#39;https://syd-1.tasklist.camunda.io/5c34c0a7-7f29-4424-8414-125615f7a9b9&#39;</span><br/><span class="hl-5">export</span><span class="hl-1"> </span><span class="hl-4">CAMUNDA_OPTIMIZE_BASE_URL</span><span class="hl-1">=</span><span class="hl-2">&#39;https://syd-1.optimize.camunda.io/5c34c0a7-7f29-4424-8414-125615f7a9b9&#39;</span><br/><span class="hl-5">export</span><span class="hl-1"> </span><span class="hl-4">CAMUNDA_OPERATE_BASE_URL</span><span class="hl-1">=</span><span class="hl-2">&#39;https://syd-1.operate.camunda.io/5c34c0a7-7f29-4424-8414-125615f7a9b9&#39;</span><br/><span class="hl-5">export</span><span class="hl-1"> </span><span class="hl-4">CAMUNDA_OAUTH_URL</span><span class="hl-1">=</span><span class="hl-2">&#39;https://login.cloud.camunda.io/oauth/token&#39;</span><br/><br/><span class="hl-7"># This is on by default, but we include it in case it got turned off for local tests</span><br/><span class="hl-5">export</span><span class="hl-1"> </span><span class="hl-4">CAMUNDA_SECURE_CONNECTION</span><span class="hl-1">=</span><span class="hl-5">true</span><br/><br/><span class="hl-7"># Admin Console and Modeler API Client</span><br/><span class="hl-5">export</span><span class="hl-1"> </span><span class="hl-4">CAMUNDA_CONSOLE_CLIENT_ID</span><span class="hl-1">=</span><span class="hl-2">&#39;e-JdgKfJy9hHSXzi&#39;</span><br/><span class="hl-5">export</span><span class="hl-1"> </span><span class="hl-4">CAMUNDA_CONSOLE_CLIENT_SECRET</span><span class="hl-1">=</span><span class="hl-2">&#39;DT8Pe-ANC6e3Je_ptLyzZvBNS0aFwaIV&#39;</span><br/><span class="hl-5">export</span><span class="hl-1"> </span><span class="hl-4">CAMUNDA_CONSOLE_BASE_URL</span><span class="hl-1">=</span><span class="hl-2">&#39;https://api.cloud.camunda.io&#39;</span><br/><span class="hl-5">export</span><span class="hl-1"> </span><span class="hl-4">CAMUNDA_CONSOLE_OAUTH_AUDIENCE</span><span class="hl-1">=</span><span class="hl-2">&#39;api.cloud.camunda.io&#39;</span>