@camunda8/sdk 8.7.24 → 8.7.25

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [8.7.25](https://github.com/camunda/camunda-8-js-sdk/compare/v8.7.24...v8.7.25) (2025-07-29)
+
+
+### Bug Fixes
+
+* export SearchUsersRequest type ([5c44ffe](https://github.com/camunda/camunda-8-js-sdk/commit/5c44ffe8074e3899df847710ec95a64477d9d61b))
+
+
+### Features
+
+* export Camunda Rest Types. fixes [#564](https://github.com/camunda/camunda-8-js-sdk/issues/564) ([b4b0d53](https://github.com/camunda/camunda-8-js-sdk/commit/b4b0d53522513622f0db1f96de62906d2bbaff80))
+
 ## [8.7.24](https://github.com/camunda/camunda-8-js-sdk/compare/v8.7.23...v8.7.24) (2025-07-25)
 
 

package/README.md

@@ -4,11 +4,11 @@
 
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
-Full API Docs are [here](https://camunda.github.io/camunda-8-js-sdk/).
+[Full API Docs](https://camunda.github.io/camunda-8-js-sdk/).
 
 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).
 
-See the QUICKSTART.md file in [the repository](https://github.com/camunda/camunda-8-js-sdk) for a quick start.
+See the [Getting Started Example](https://docs.camunda.io/docs/next/guides/getting-started-example/) in the Camunda Docs for a quick start.
 
 ## What does "supported" mean?
 
@@ -32,15 +32,23 @@ npm i @camunda8/sdk
 
 ## Usage
 
-In this release, the functionality of Camunda 8 is exposed via dedicated clients for the component APIs.
+The functionality of Camunda 8 is exposed via dedicated clients for the component APIs. The recommended API client for Camunda 8.8 is the Orchestration Cluster API, using the `CamundaRestClient`.
 
 ```typescript
 import { Camunda8 } from '@camunda8/sdk'
 
+// Optional: Import types for CamundaRestClient requests and responses
+import type { CamundaRestTypes} from '@camunda8/sdk'
+
 const c8 = new Camunda8()
-const restClient = c8.getCamundaRestClient() // New REST API
+
+// Camunda 8 Orchestration API - recommended API from 8.8.0
+const restClient = c8.getCamundaRestClient()
+
+// Zeebe gRPC client - not recommended for new users
 const zeebe = c8.getZeebeGrpcApiClient()
-const zeebeRest = c8.getZeebeRestClient() // Deprecated
+
+// Camunda v1 REST API clients
 const operate = c8.getOperateApiClient()
 const optimize = c8.getOptimizeApiClient()
 const tasklist = c8.getTasklistApiClient()
@@ -58,9 +66,9 @@ Any configuration passed in to the `Camunda8` constructor is merged over any con
 
 ## 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/camunda-8-js-sdk/issues/78) for more details.
+Entity keys in Camunda 8.6 and earlier 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.
 
-For `int64` values whose type is not known ahead of time, such as job variables, you can pass an annotated data transfer object (DTO) to decode them reliably. If no DTO is specified, the default behavior of the SDK is to serialise all numbers to JavaScript `number`, and to throw an exception if a number value is detected at a runtime that cannot be accurately represented as the JavaScript `number` type (that is, a value greater than 2^53-1).
+For `int64` values whose type is not known ahead of time, such as job variables, you can pass an annotated data transfer object (DTO) to decode them reliably. See the section on [Process Variable Typing](#process-variable-typing). If no DTO is specified, the default behavior of the SDK is to serialise all numbers to JavaScript `number`, and to throw an exception if a number value is detected at a runtime that cannot be accurately represented as the JavaScript `number` type (that is, a value greater than 2^53-1).
 
 ## Authorization
 
@@ -206,6 +214,16 @@ CAMUNDA_CUSTOM_PRIVATE_KEY_PATH # path to mTLS (client-side) key
 
 ## Connection configuration examples
 
+### Camunda 8 Run 8.8
+
+This is the configuration for [Camunda 8 Run](https://developers.camunda.com/install-camunda-8/) - a local Camunda 8 instance that is the best way to get started.
+
+```bash
+export ZEEBE_REST_ADDRESS='http://localhost:8080'
+export ZEEBE_GRPC_ADDRESS='grpc://localhost:26500'
+export CAMUNDA_AUTH_STRATEGY=NONE
+```
+
 ### Self-Managed
 
 This is the complete environment configuration needed to run against the Dockerised Self-Managed stack in the `docker` subdirectory:
@@ -226,9 +244,6 @@ 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:
@@ -268,16 +283,13 @@ export ZEEBE_GRPC_ADDRESS='grpcs://5c34c0a7-7f29-4424-8414-125615f7a9b9.syd-1.ze
 export ZEEBE_REST_ADDRESS='https://syd-1.zeebe.camunda.io/5c34c0a7-7f29-4424-8414-125615f7a9b9'
 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'
 export CAMUNDA_AUTH_STRATEGY='OAUTH'
 
-# 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'
@@ -298,7 +310,7 @@ You can supply a custom logger via the constructor. For example, to use the [Pin
 ```typescript
 import pino from 'pino'
 
-import { Camunda8 } from '../../c8/index'
+import { Camunda8 } from '@camunda8/sdk'
 
 const level = process.env.CAMUNDA_LOG_LEVEL ?? 'trace'
 const logger = pino({ level }) // Logging level controlled via the logging library

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

@@ -1,9 +1,9 @@
 /// <reference types="node" />
-/// <reference types="node" />
 import { ReadStream } from 'fs';
 import { LosslessNumber } from 'lossless-json';
 import { LosslessDto } from '../../lib';
 import { ICustomHeaders, IInputVariables, IProcessVariables, JobCompletionInterfaceRest, JSONDoc } from '../../zeebe/types';
+import { DeployResourceResponseDto, SearchSortRequest } from './C8DtoInternal';
 export declare class RestApiJob<Variables = LosslessDto, CustomHeaders = LosslessDto> extends LosslessDto {
     jobKey: string;
     type: string;
@@ -41,7 +41,6 @@ export interface NewUserInfo {
     name: string;
     email: string;
 }
-export type Ctor<T> = new (obj: any) => T;
 export declare class ProcessDeployment extends LosslessDto {
     /** This is the ID of the process definition. It is a human-readable string defined in the process model */
     processDefinitionId: string;
@@ -76,19 +75,6 @@ export declare class FormDeployment {
     resourceName: string;
     tenantId: string;
 }
-export declare class DeployResourceResponseDto extends LosslessDto {
-    deploymentKey: string;
-    deployments: ({
-        processDefinition: ProcessDeployment;
-    } | {
-        decisionDefinition: DecisionDeployment;
-    } | {
-        decisionRequirements: DecisionRequirementsDeployment;
-    } | {
-        form: FormDeployment;
-    })[];
-    tenantId: string;
-}
 export declare class DeployResourceResponse extends DeployResourceResponseDto {
     processes: ProcessDeployment[];
     decisions: DecisionDeployment[];
@@ -119,6 +105,8 @@ export declare class CreateProcessInstanceResponse<T = Record<string, never>> {
      */
     readonly variables: T;
 }
+export declare class CreateProcessInstanceWithResultResponse<T> extends CreateProcessInstanceResponse<T> {
+}
 export interface MigrationMappingInstruction {
     /** The element ID to migrate from. */
     sourceElementId: string;
@@ -179,7 +167,7 @@ export declare class PublishMessageResponse extends LosslessDto {
     /** the tenantId of the message */
     tenantId: string;
 }
-export interface CreateProcessBaseRequest<V extends JSONDoc | LosslessDto> {
+interface CreateProcessBaseRequest<V extends JSONDoc | LosslessDto> {
     /**
      * the version of the process; if not specified it will use the latest version
      */
@@ -217,19 +205,19 @@ export interface ProcessInstanceCreationStartInstruction {
      */
     elementId: string;
 }
-export interface CreateProcessInstanceFromProcessDefinitionId<V extends JSONDoc | LosslessDto> extends CreateProcessBaseRequest<V> {
+interface CreateProcessInstanceFromProcessDefinitionId<V extends JSONDoc | LosslessDto> extends CreateProcessBaseRequest<V> {
     /**
      * the BPMN process ID of the process definition
      */
     processDefinitionId: string;
 }
-export interface CreateProcessInstanceFromProcessDefinition<V extends JSONDoc | LosslessDto> extends CreateProcessBaseRequest<V> {
+interface CreateProcessInstanceFromProcessDefinition<V extends JSONDoc | LosslessDto> extends CreateProcessBaseRequest<V> {
     /**
      * the key of the process definition
      */
     processDefinitionKey: string;
 }
-export type CreateProcessInstanceReq<T extends JSONDoc | LosslessDto> = CreateProcessInstanceFromProcessDefinitionId<T> | CreateProcessInstanceFromProcessDefinition<T>;
+export type CreateProcessInstanceRequest<T extends JSONDoc | LosslessDto> = CreateProcessInstanceFromProcessDefinitionId<T> | CreateProcessInstanceFromProcessDefinition<T>;
 export interface PatchAuthorizationRequest {
     /** The key of the owner of the authorization. */
     ownerKey: string;
@@ -284,7 +272,7 @@ export interface RestJob<Variables = IInputVariables, CustomHeaderShape = ICusto
      */
     readonly tenantId: string;
 }
-export type JobWithMethods<VariablesDto, CustomHeadersDto> = RestJob<VariablesDto, CustomHeadersDto> & JobCompletionInterfaceRest<IProcessVariables>;
+export type ActivatedJob<VariablesDto, CustomHeadersDto> = RestJob<VariablesDto, CustomHeadersDto> & JobCompletionInterfaceRest<IProcessVariables>;
 interface SearchPageRequestSearchAfter {
     /** The index of items to start searching from. */
     from: number;
@@ -301,7 +289,7 @@ interface SearchPageRequestSearchBefore {
 }
 export type SearchPageRequest = SearchPageRequestSearchAfter | SearchPageRequestSearchBefore;
 /** Generic search request interface that can be used for most search operations */
-export interface BaseSearchRequest<TSortFields extends string, TFilter> {
+interface BaseSearchRequest<TSortFields extends string, TFilter> {
     /** Pagination criteria. */
     page?: SearchPageRequest;
     /** Sort field criteria. */
@@ -348,7 +336,7 @@ export interface AdvancedNumberFilter {
     /** Checks if the property is less than or equal to the provided value. */
     $lte?: number;
 }
-export interface VariableSearchFilterRequest {
+export interface VariableSearchRequestFilter {
     /** The key for this variable. */
     variableKey?: string | AdvancedStringFilter;
     /** Name of the variable. */
@@ -364,13 +352,7 @@ export interface VariableSearchFilterRequest {
     /** Whether the value is truncated or not. */
     isTruncated?: boolean;
 }
-export type SearchSortRequest<T = string> = Array<{
-    /** The field to sort by. */
-    field: T;
-    /** The order in which to sort the related field. Default value: ASC */
-    order?: 'ASC' | 'DESC';
-}>;
-export interface CamundaRestSearchResponsePagination {
+interface SearchResponsePagination {
     /** Total items matching the criteria. */
     totalItems: number;
     /** The cursor for the first item in the result set. Use this in the searchBefore field of an ensuing request. */
@@ -378,13 +360,13 @@ export interface CamundaRestSearchResponsePagination {
     /** The cursor for the last item in the result set. Use this in the searchAfter field of an ensuing request. */
     endCursor: string;
 }
-interface PaginatedCamundaRestSearchResponse<T> {
+interface PaginatedSearchResponse<T> {
     /** Pagination information about the search results. */
-    page: CamundaRestSearchResponsePagination;
+    page: SearchResponsePagination;
     /** The matching items. */
     items: T[];
 }
-interface VariableDetails {
+export interface VariableDetails {
     /** The key for this variable. */
     variableKey: string;
     /** The key of the scope of this variable. */
@@ -400,9 +382,9 @@ interface VariableDetails {
     /** Whether the value is truncated or not. */
     isTruncated: boolean;
 }
-export interface SearchVariablesRequest extends BaseSearchRequest<'value' | 'name' | 'tenantId' | 'variableKey' | 'scopeKey' | 'processInstanceKey', VariableSearchFilterRequest> {
+export interface SearchVariablesRequest extends BaseSearchRequest<'value' | 'name' | 'tenantId' | 'variableKey' | 'scopeKey' | 'processInstanceKey', VariableSearchRequestFilter> {
 }
-export interface CamundaRestSearchVariablesResponse extends PaginatedCamundaRestSearchResponse<VariableDetails> {
+export interface SearchVariablesResponse extends PaginatedSearchResponse<VariableDetails> {
 }
 export type SearchUserTasksSortRequest = SearchSortRequest<'creationDate' | 'completionDate' | 'dueDate' | 'followUpDate' | 'priority'>;
 export interface AdvancedDateTimeFilter {
@@ -424,7 +406,7 @@ export interface AdvancedDateTimeFilter {
     $in: string[];
 }
 /** User task filter request. */
-export interface SearchUserTasksFilter {
+export interface SearchUserTasksRequestFilter {
     /** The key for this user task. */
     userTaskKey?: string;
     /** The state of the user task. */
@@ -472,9 +454,9 @@ export interface SearchUserTasksFilter {
         value: string;
     }>;
 }
-export interface SearchTasksRequest extends BaseSearchRequestWithOptionalFilter<'creationDate' | 'completionDate' | 'dueDate' | 'followUpDate' | 'priority', SearchUserTasksFilter> {
+export interface SearchTasksRequest extends BaseSearchRequestWithOptionalFilter<'creationDate' | 'completionDate' | 'dueDate' | 'followUpDate' | 'priority', SearchUserTasksRequestFilter> {
 }
-interface UserTaskDetails {
+export interface UserTaskDetails {
     /** The key of the user task. */
     userTaskKey: string;
     /** The key of the element instance. */
@@ -486,7 +468,7 @@ interface UserTaskDetails {
     /** The key of the form. */
     formKey: string;
 }
-export interface CamundaRestSearchUserTasksResponse extends PaginatedCamundaRestSearchResponse<UserTaskDetails> {
+export interface SearchUserTasksResponse extends PaginatedSearchResponse<UserTaskDetails> {
 }
 export interface UserTask {
     /** The name for this user task. */
@@ -545,14 +527,14 @@ export interface AssignUserTaskRequest {
     /** A custom action value that will be accessible from user task events resulting from this endpoint invocation. If not provided, it will default to "assign". */
     action?: string;
 }
-export interface UserTaskVariablesRequest extends BaseSearchRequestWithOptionalFilter<'value' | 'name' | 'tenantId' | 'variableKey' | 'scopeKey' | 'processInstanceKey', {
+export interface SearchUserTaskVariablesRequest extends BaseSearchRequestWithOptionalFilter<'value' | 'name' | 'tenantId' | 'variableKey' | 'scopeKey' | 'processInstanceKey', {
     /** Name of the variable. */
     name: string;
 }> {
     userTaskKey: string;
 }
 /** The user task variables search response for CamundaRestClient. */
-export interface CamundaRestUserTaskVariablesResponse extends PaginatedCamundaRestSearchResponse<{
+export interface SearchUserTaskVariablesResponse extends PaginatedSearchResponse<{
     /** The key for this variable. */
     variableKey: string;
     /** The key of the scope of this variable. */
@@ -577,7 +559,7 @@ export interface AdvancedProcessInstanceStateFilter {
     /** Checks if the property matches the provided like value. Supported wildcard characters depend on the configured search client. */
     $like: string;
 }
-export interface ProcessInstanceSearchFilter {
+export interface SearchProcessInstanceRequestFilter {
     /** The key of this process instance. */
     processInstanceKey?: string | AdvancedStringFilter;
     /** The process definition ID. */
@@ -611,7 +593,7 @@ export interface ProcessInstanceSearchFilter {
     }>;
 }
 /** This is the 8.8 API.  */
-export interface SearchProcessInstanceRequest extends BaseSearchRequest<'processInstanceKey' | 'processDefinitionId' | 'processDefinitionName' | 'processDefinitionVersion' | 'processDefinitionVersionTag' | 'processDefinitionKey' | 'parentProcessInstanceKey' | 'parentFlowNodeInstanceKey' | 'state' | 'startDate' | 'endDate' | 'tenantId' | 'hasIncident', ProcessInstanceSearchFilter> {
+export interface SearchProcessInstanceRequest extends BaseSearchRequest<'processInstanceKey' | 'processDefinitionId' | 'processDefinitionName' | 'processDefinitionVersion' | 'processDefinitionVersionTag' | 'processDefinitionKey' | 'parentProcessInstanceKey' | 'parentFlowNodeInstanceKey' | 'state' | 'startDate' | 'endDate' | 'tenantId' | 'hasIncident', SearchProcessInstanceRequestFilter> {
 }
 export interface ProcessInstanceDetails {
     /** The key of the process instance. */
@@ -639,7 +621,7 @@ export interface ProcessInstanceDetails {
     /** Has an incident. */
     hasIncident: boolean;
 }
-export interface CamundaRestSearchProcessInstanceResponse extends PaginatedCamundaRestSearchResponse<ProcessInstanceDetails> {
+export interface SearchProcessInstanceResponse extends PaginatedSearchResponse<ProcessInstanceDetails> {
 }
 export interface DownloadDocumentRequest {
     /** The ID of the document to download. */
@@ -660,9 +642,9 @@ export interface UploadDocumentRequest {
     documentId?: string;
     /** A file ReadStream created with fs.createReadStream() */
     file: ReadStream;
-    metadata?: UploadDocumentMetadata;
+    metadata?: DocumentMetadata;
 }
-export interface UploadDocumentMetadata {
+export interface DocumentMetadata {
     /** The content type of the document. */
     contentType?: string;
     /** The name of the file. */
@@ -689,7 +671,7 @@ export declare class UploadDocumentResponse extends LosslessDto {
     documentId: string;
     /** The hash of the document. */
     contentHash: string;
-    metadata: UploadDocumentMetadata;
+    metadata: DocumentMetadata;
 }
 export declare class UploadDocumentsResponse {
     /** Documents that were successfully created. */
@@ -829,35 +811,18 @@ export declare class EvaluateDecisionResponse extends LosslessDto {
     decisionInstanceKey: string;
     evaluatedDecisions: EvaluatedDecision[];
 }
-export type UnknownRequestBody = Record<string, any>;
-export interface BaseApiEndpointRequest<T extends UnknownRequestBody = UnknownRequestBody> {
-    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
-    /** The URL path of the API endpoint. */
-    urlPath: string;
-    /** The request body. */
-    body?: T;
-    /** TODO: multi-part form support needs to be implemented */
-    formData?: FormData;
-    /** The query parameters. */
-    queryParams?: {
-        [key: string]: string | number | boolean | undefined;
-    };
-    /** The headers. */
-    headers?: {
-        [key: string]: string | number | boolean;
-    };
-    /** A custom JSON parsing function */
-    parseJson?: typeof JSON.parse;
-}
-export interface JsonApiEndpointRequest<T extends UnknownRequestBody = UnknownRequestBody> extends BaseApiEndpointRequest<T> {
-    /** JSON-parse response? Default: true */
-    json?: true | undefined;
-}
-export interface RawApiEndpointRequest<T extends UnknownRequestBody = UnknownRequestBody> extends BaseApiEndpointRequest<T> {
-    /** JSON-parse response? */
-    json: false;
+declare class UserItem extends LosslessDto {
+    /** The ID of the user. */
+    id: string;
+    /** The key of the user. */
+    key: string;
+    /** The username of the user. */
+    username: string;
+    /** The name of the user. */
+    name: string;
+    /** The email of the user. */
+    email: string;
 }
-export type ApiEndpointRequest<T extends UnknownRequestBody = UnknownRequestBody> = JsonApiEndpointRequest<T> | RawApiEndpointRequest<T>;
 export interface SearchUsersRequest {
     /** Pagination criteria. */
     page: SearchPageRequest;
@@ -873,22 +838,10 @@ export interface SearchUsersRequest {
         email?: string;
     };
 }
-declare class UserItem extends LosslessDto {
-    /** The ID of the user. */
-    id: string;
-    /** The key of the user. */
-    key: string;
-    /** The username of the user. */
-    username: string;
-    /** The name of the user. */
-    name: string;
-    /** The email of the user. */
-    email: string;
-}
 /** The user search result. */
 export declare class SearchUsersResponse extends LosslessDto {
     /** Pagination information about the search results. */
-    page: CamundaRestSearchResponsePagination;
+    page: SearchResponsePagination;
     /** The matching users. */
     items: UserItem[];
 }
@@ -916,7 +869,7 @@ export interface GetProcessDefinitionResponse {
     /** The key for this process definition. */
     processDefinitionKey: string;
 }
-export interface ProcessDefinitionSearchFilter {
+export interface ProcessDefinitionSearchRequestFilter {
     /** Name of this process definition. */
     name?: string;
     /** Resource name of this process definition. */
@@ -932,9 +885,9 @@ export interface ProcessDefinitionSearchFilter {
     /** The key for this process definition. */
     processDefinitionKey?: string;
 }
-export interface SearchProcessDefinitionsRequest extends BaseSearchRequest<'processDefinitionKey' | 'name' | 'resourceName' | 'version' | 'versionTag' | 'processDefinitionId' | 'tenantId', ProcessDefinitionSearchFilter> {
+export interface SearchProcessDefinitionsRequest extends BaseSearchRequest<'processDefinitionKey' | 'name' | 'resourceName' | 'version' | 'versionTag' | 'processDefinitionId' | 'tenantId', ProcessDefinitionSearchRequestFilter> {
 }
-interface DefinitionDetails {
+export interface ProcessDefinitionDetails {
     /** Name of this process definition. */
     name: string;
     /** Resource name for this process definition. */
@@ -950,9 +903,9 @@ interface DefinitionDetails {
     /** The key for this process definition. */
     processDefinitionKey: string;
 }
-export interface CamundaRestSearchProcessDefinitionsResponse extends PaginatedCamundaRestSearchResponse<DefinitionDetails> {
+export interface SearchProcessDefinitionsResponse extends PaginatedSearchResponse<ProcessDefinitionDetails> {
 }
-export interface ElementInstanceSearchFilter {
+export interface ElementInstanceSearchRequestFilter {
     processDefinitionId?: string;
     state?: 'ACTIVE' | 'COMPLETED' | 'TERMINATED';
     type?: 'UNSPECIFIED' | 'PROCESS' | 'SUB_PROCESS' | 'EVENT_SUB_PROCESS' | 'AD_HOC_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' | 'UNKNOWN';
@@ -965,7 +918,7 @@ export interface ElementInstanceSearchFilter {
     processDefinitionKey?: string;
     incidentKey?: string;
 }
-export interface SearchElementInstancesRequest extends BaseSearchRequest<'elementInstanceKey' | 'processInstanceKey' | 'processDefinitionKey' | 'processDefinitionId' | 'startDate' | 'endDate' | 'elementId' | 'type' | 'state' | 'incidentKey' | 'tenantId', ElementInstanceSearchFilter> {
+export interface SearchElementInstancesRequest extends BaseSearchRequest<'elementInstanceKey' | 'processInstanceKey' | 'processDefinitionKey' | 'processDefinitionId' | 'startDate' | 'endDate' | 'elementId' | 'type' | 'state' | 'incidentKey' | 'tenantId', ElementInstanceSearchRequestFilter> {
 }
 export interface ElementInstanceDetails {
     /** The process definition ID associated to this element instance. */
@@ -995,13 +948,9 @@ export interface ElementInstanceDetails {
     /** Incident key associated with this element instance. */
     incidentKey?: string;
 }
-export interface SearchElementInstancesResponse {
-    page: CamundaRestSearchResponsePagination;
-    items: Array<ElementInstanceDetails>;
-}
-export interface CamundaRestSearchElementInstancesResponse extends PaginatedCamundaRestSearchResponse<ElementInstanceDetails> {
+export interface SearchElementInstancesResponse extends PaginatedSearchResponse<ElementInstanceDetails> {
 }
-export interface IncidentSearchFilter {
+export interface IncidentSearchRequestFilter {
     /** The process definition ID associated to this incident. */
     processDefinitionId?: string;
     /** Incident error type with a defined set of values. */
@@ -1027,7 +976,7 @@ export interface IncidentSearchFilter {
     /** The job key, if exists, associated with this incident. */
     jobKey?: string;
 }
-export interface SearchIncidentsRequest extends BaseSearchRequest<'incidentKey' | 'processInstanceKey' | 'processDefinitionKey' | 'processDefinitionId' | 'errorType' | 'errorMessage' | 'elementId' | 'elementInstanceKey' | 'creationTime' | 'state' | 'jobKey' | 'tenantId', IncidentSearchFilter> {
+export interface SearchIncidentsRequest extends BaseSearchRequest<'incidentKey' | 'processInstanceKey' | 'processDefinitionKey' | 'processDefinitionId' | 'errorType' | 'errorMessage' | 'elementId' | 'elementInstanceKey' | 'creationTime' | 'state' | 'jobKey' | 'tenantId', IncidentSearchRequestFilter> {
 }
 interface IncidentDetails {
     processDefinitionId: string;
@@ -1043,7 +992,7 @@ interface IncidentDetails {
     elementInstanceKey: string;
     jobKey: string;
 }
-export interface CamundaRestSearchIncidentsResponse extends PaginatedCamundaRestSearchResponse<IncidentDetails> {
+export interface SearchIncidentsResponse extends PaginatedSearchResponse<IncidentDetails> {
 }
 export interface DecisionInstanceSearchFilter {
     /** The decision instance key. */
@@ -1069,7 +1018,7 @@ export interface DecisionInstanceSearchFilter {
     /** The decision type. */
     decisionType?: 'DECISION_TABLE' | 'LITERAL_EXPRESSION' | 'UNSPECIFIED' | 'UNKNOWN';
 }
-export interface CamundaRestSearchDecisionInstancesRequest extends BaseSearchRequest<'decisionInstanceKey' | 'decisionDefinitionId' | 'decisionDefinitionKey' | 'decisionDefinitionName' | 'decisionDefinitionVersion' | 'processDefinitionKey' | 'processInstanceKey' | 'state' | 'evaluationDate' | 'tenantId' | 'decisionType', DecisionInstanceSearchFilter> {
+export interface SearchDecisionInstancesRequest extends BaseSearchRequest<'decisionInstanceKey' | 'decisionDefinitionId' | 'decisionDefinitionKey' | 'decisionDefinitionName' | 'decisionDefinitionVersion' | 'processDefinitionKey' | 'processInstanceKey' | 'state' | 'evaluationDate' | 'tenantId' | 'decisionType', DecisionInstanceSearchFilter> {
 }
 interface DecisionInstanceDetails {
     /** The decision instance key. */
@@ -1101,7 +1050,7 @@ interface DecisionInstanceDetails {
     /** The ID of the decision instance. */
     decisionInstanceId: string;
 }
-export interface CamundaRestSearchDecisionInstancesResponse extends PaginatedCamundaRestSearchResponse<DecisionInstanceDetails> {
+export interface SearchDecisionInstancesResponse extends PaginatedSearchResponse<DecisionInstanceDetails> {
 }
 /**
  * Response from getting a single decision instance by its key.

package/dist/c8/lib/C8Dto.js

@@ -6,8 +6,9 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetVariableResponse = exports.SearchUsersResponse = exports.EvaluateDecisionResponse = exports.EvaluatedDecision = exports.EvaluatedInput = exports.MatchedRule = exports.EvaluatedOutput = exports.UploadDocumentsResponse = exports.UploadDocumentResponse = exports.PublishMessageResponse = exports.CorrelateMessageResponse = exports.BroadcastSignalResponse = exports.CreateProcessInstanceResponse = exports.DeployResourceResponse = exports.DeployResourceResponseDto = exports.FormDeployment = exports.DecisionRequirementsDeployment = exports.DecisionDeployment = exports.ProcessDeployment = exports.RestApiJob = void 0;
+exports.GetVariableResponse = exports.SearchUsersResponse = exports.EvaluateDecisionResponse = exports.EvaluatedDecision = exports.EvaluatedInput = exports.MatchedRule = exports.EvaluatedOutput = exports.UploadDocumentsResponse = exports.UploadDocumentResponse = exports.PublishMessageResponse = exports.CorrelateMessageResponse = exports.BroadcastSignalResponse = exports.CreateProcessInstanceWithResultResponse = exports.CreateProcessInstanceResponse = exports.DeployResourceResponse = exports.FormDeployment = exports.DecisionRequirementsDeployment = exports.DecisionDeployment = exports.ProcessDeployment = exports.RestApiJob = void 0;
 const lib_1 = require("../../lib");
+const C8DtoInternal_1 = require("./C8DtoInternal");
 class RestApiJob extends lib_1.LosslessDto {
 }
 exports.RestApiJob = RestApiJob;
@@ -53,13 +54,7 @@ exports.FormDeployment = FormDeployment;
 __decorate([
     lib_1.Int64String
 ], FormDeployment.prototype, "formKey", void 0);
-class DeployResourceResponseDto extends lib_1.LosslessDto {
-}
-exports.DeployResourceResponseDto = DeployResourceResponseDto;
-__decorate([
-    lib_1.Int64String
-], DeployResourceResponseDto.prototype, "deploymentKey", void 0);
-class DeployResourceResponse extends DeployResourceResponseDto {
+class DeployResourceResponse extends C8DtoInternal_1.DeployResourceResponseDto {
 }
 exports.DeployResourceResponse = DeployResourceResponse;
 class CreateProcessInstanceResponse {
@@ -71,6 +66,9 @@ __decorate([
 __decorate([
     lib_1.Int64String
 ], CreateProcessInstanceResponse.prototype, "processInstanceKey", void 0);
+class CreateProcessInstanceWithResultResponse extends CreateProcessInstanceResponse {
+}
+exports.CreateProcessInstanceWithResultResponse = CreateProcessInstanceWithResultResponse;
 /** The signal was broadcast. */
 class BroadcastSignalResponse extends lib_1.LosslessDto {
 }

package/dist/c8/lib/C8Dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"C8Dto.js","sourceRoot":"","sources":["../../../src/c8/lib/C8Dto.ts"],"names":[],"mappings":";;;;;;;;;AAIA,mCAA8D;AAS9D,MAAa,UAGX,SAAQ,iBAAW;CAoBpB;AAvBD,gCAuBC;AAlBA;IADC,iBAAW;0CACG;AAGf;IADC,iBAAW;sDACe;AAI3B;IADC,iBAAW;wDACiB;AAG7B;IADC,iBAAW;sDACe;AAK3B;IADC,iBAAW;4CACK;AAuClB,MAAa,iBAAkB,SAAQ,iBAAW;CASjD;AATD,8CASC;AAHA;IADC,iBAAW;+DACiB;AAK9B,MAAa,kBAAmB,SAAQ,iBAAW;CAWlD;AAXD,gDAWC;AAPA;IADC,iBAAW;uDACQ;AAKpB;IADC,iBAAW;mEACoB;AAIjC,MAAa,8BAA+B,SAAQ,iBAAW;CAQ9D;AARD,wEAQC;AAFA;IADC,iBAAW;+EACoB;AAGjC,MAAa,cAAc;CAO1B;AAPD,wCAOC;AAHA;IADC,iBAAW;+CACI;AAKjB,MAAa,yBAA0B,SAAQ,iBAAW;CAUzD;AAVD,8DAUC;AARA;IADC,iBAAW;gEACU;AAUvB,MAAa,sBAAuB,SAAQ,yBAAyB;CAKpE;AALD,wDAKC;AAED,MAAa,6BAA6B;CAyBzC;AAzBD,sEAyBC;AAnBS;IADR,iBAAW;2EAC0B;AAU7B;IADR,iBAAW;yEACwB;AA8BrC,gCAAgC;AAChC,MAAa,uBAAwB,SAAQ,iBAAW;CAMvD;AAND,0DAMC;AAHA;IAFC,iBAAW;IACZ,sDAAsD;0DACpC;AA4BnB,MAAa,wBAAyB,SAAQ,iBAAW;CASxD;AATD,4DASC;AANA;IADC,iBAAW;4DACO;AAKnB;IADC,iBAAW;oEACe;AAG5B,MAAa,sBAAuB,SAAQ,iBAAW;CAMtD;AAND,wDAMC;AAHA;IADC,iBAAW;0DACO;AAsmBpB,MAAa,sBAAuB,SAAQ,iBAAW;IAAvD;;QACC,uDAAuD;QACvD,KAAC,uBAAuB,CAAC,GAAG,SAAS,CAAA;IAQtC,CAAC;CAAA;AAVD,wDAUC;AAED,MAAa,uBAAuB;CAUnC;AAVD,0DAUC;AAuED,MAAa,eAAgB,SAAQ,iBAAW;CAO/C;AAPD,0CAOC;AAED,MAAa,WAAY,SAAQ,iBAAW;CAO3C;AAPD,kCAOC;AADA;IADC,IAAA,cAAQ,EAAC,eAAe,CAAC;qDACU;AAGrC,MAAa,cAAe,SAAQ,iBAAW;CAO9C;AAPD,wCAOC;AAED,MAAa,iBAAkB,SAAQ,iBAAW;CAmBjD;AAnBD,8CAmBC;AALA;IADC,IAAA,cAAQ,EAAC,WAAW,CAAC;uDACM;AAE5B;IADC,IAAA,cAAQ,EAAC,cAAc,CAAC;0DACS;AAKnC,MAAa,wBAAyB,SAAQ,iBAAW;CAyBxD;AAzBD,4DAyBC;AADA;IADC,IAAA,cAAQ,EAAC,iBAAiB,CAAC;oEACY;AA4DzC,MAAM,QAAS,SAAQ,iBAAW;CAYjC;AATA;IADC,iBAAW;oCACD;AAWZ,8BAA8B;AAC9B,MAAa,mBAAoB,SAAQ,iBAAW;CAMnD;AAND,kDAMC;AADA;IADC,IAAA,cAAQ,EAAC,QAAQ,CAAC;kDACD;AAGnB,MAAa,mBAAmB;CAO/B;AAPD,kDAOC"}
+{"version":3,"file":"C8Dto.js","sourceRoot":"","sources":["../../../src/c8/lib/C8Dto.ts"],"names":[],"mappings":";;;;;;;;;AAIA,mCAA8D;AAS9D,mDAA8E;AAE9E,MAAa,UAGX,SAAQ,iBAAW;CAoBpB;AAvBD,gCAuBC;AAlBA;IADC,iBAAW;0CACG;AAGf;IADC,iBAAW;sDACe;AAI3B;IADC,iBAAW;wDACiB;AAG7B;IADC,iBAAW;sDACe;AAK3B;IADC,iBAAW;4CACK;AAoClB,MAAa,iBAAkB,SAAQ,iBAAW;CASjD;AATD,8CASC;AAHA;IADC,iBAAW;+DACiB;AAK9B,MAAa,kBAAmB,SAAQ,iBAAW;CAWlD;AAXD,gDAWC;AAPA;IADC,iBAAW;uDACQ;AAKpB;IADC,iBAAW;mEACoB;AAIjC,MAAa,8BAA+B,SAAQ,iBAAW;CAQ9D;AARD,wEAQC;AAFA;IADC,iBAAW;+EACoB;AAGjC,MAAa,cAAc;CAO1B;AAPD,wCAOC;AAHA;IADC,iBAAW;+CACI;AAKjB,MAAa,sBAAuB,SAAQ,yCAAyB;CAKpE;AALD,wDAKC;AAED,MAAa,6BAA6B;CAyBzC;AAzBD,sEAyBC;AAnBS;IADR,iBAAW;2EAC0B;AAU7B;IADR,iBAAW;yEACwB;AAWrC,MAAa,uCAEX,SAAQ,6BAAgC;CAAG;AAF7C,0FAE6C;AAqB7C,gCAAgC;AAChC,MAAa,uBAAwB,SAAQ,iBAAW;CAMvD;AAND,0DAMC;AAHA;IAFC,iBAAW;IACZ,sDAAsD;0DACpC;AA4BnB,MAAa,wBAAyB,SAAQ,iBAAW;CASxD;AATD,4DASC;AANA;IADC,iBAAW;4DACO;AAKnB;IADC,iBAAW;oEACe;AAG5B,MAAa,sBAAuB,SAAQ,iBAAW;CAMtD;AAND,wDAMC;AAHA;IADC,iBAAW;0DACO;AA+lBpB,MAAa,sBAAuB,SAAQ,iBAAW;IAAvD;;QACC,uDAAuD;QACvD,KAAC,uBAAuB,CAAC,GAAG,SAAS,CAAA;IAQtC,CAAC;CAAA;AAVD,wDAUC;AAED,MAAa,uBAAuB;CAUnC;AAVD,0DAUC;AAuED,MAAa,eAAgB,SAAQ,iBAAW;CAO/C;AAPD,0CAOC;AAED,MAAa,WAAY,SAAQ,iBAAW;CAO3C;AAPD,kCAOC;AADA;IADC,IAAA,cAAQ,EAAC,eAAe,CAAC;qDACU;AAGrC,MAAa,cAAe,SAAQ,iBAAW;CAO9C;AAPD,wCAOC;AAED,MAAa,iBAAkB,SAAQ,iBAAW;CAmBjD;AAnBD,8CAmBC;AALA;IADC,IAAA,cAAQ,EAAC,WAAW,CAAC;uDACM;AAE5B;IADC,IAAA,cAAQ,EAAC,cAAc,CAAC;0DACS;AAKnC,MAAa,wBAAyB,SAAQ,iBAAW;CAyBxD;AAzBD,4DAyBC;AADA;IADC,IAAA,cAAQ,EAAC,iBAAiB,CAAC;oEACY;AAGzC,MAAM,QAAS,SAAQ,iBAAW;CAYjC;AATA;IADC,iBAAW;oCACD;AA4BZ,8BAA8B;AAC9B,MAAa,mBAAoB,SAAQ,iBAAW;CAMnD;AAND,kDAMC;AADA;IADC,IAAA,cAAQ,EAAC,QAAQ,CAAC;kDACD;AAGnB,MAAa,mBAAmB;CAO/B;AAPD,kDAOC"}

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

@@ -0,0 +1,53 @@
+/// <reference types="node" />
+import { LosslessDto } from '../../lib';
+import { DecisionDeployment, DecisionRequirementsDeployment, FormDeployment, ProcessDeployment } from './C8Dto';
+export declare class DeployResourceResponseDto extends LosslessDto {
+    deploymentKey: string;
+    deployments: ({
+        processDefinition: ProcessDeployment;
+    } | {
+        decisionDefinition: DecisionDeployment;
+    } | {
+        decisionRequirements: DecisionRequirementsDeployment;
+    } | {
+        form: FormDeployment;
+    })[];
+    tenantId: string;
+}
+export type Ctor<T> = new (obj: any) => T;
+export type UnknownRequestBody = Record<string, any>;
+export interface JsonApiEndpointRequest<T extends UnknownRequestBody = UnknownRequestBody> extends BaseApiEndpointRequest<T> {
+    /** JSON-parse response? Default: true */
+    json?: true | undefined;
+}
+export interface RawApiEndpointRequest<T extends UnknownRequestBody = UnknownRequestBody> extends BaseApiEndpointRequest<T> {
+    /** JSON-parse response? */
+    json: false;
+}
+export type ApiEndpointRequest<T extends UnknownRequestBody = UnknownRequestBody> = JsonApiEndpointRequest<T> | RawApiEndpointRequest<T>;
+export type SearchSortRequest<T = string> = Array<{
+    /** The field to sort by. */
+    field: T;
+    /** The order in which to sort the related field. Default value: ASC */
+    order?: 'ASC' | 'DESC';
+}>;
+interface BaseApiEndpointRequest<T extends UnknownRequestBody = UnknownRequestBody> {
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    /** The URL path of the API endpoint. */
+    urlPath: string;
+    /** The request body. */
+    body?: T;
+    /** TODO: multi-part form support needs to be implemented */
+    formData?: FormData;
+    /** The query parameters. */
+    queryParams?: {
+        [key: string]: string | number | boolean | undefined;
+    };
+    /** The headers. */
+    headers?: {
+        [key: string]: string | number | boolean;
+    };
+    /** A custom JSON parsing function */
+    parseJson?: typeof JSON.parse;
+}
+export {};

package/dist/c8/lib/C8DtoInternal.js

@@ -0,0 +1,17 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeployResourceResponseDto = void 0;
+const lib_1 = require("../../lib");
+class DeployResourceResponseDto extends lib_1.LosslessDto {
+}
+exports.DeployResourceResponseDto = DeployResourceResponseDto;
+__decorate([
+    lib_1.Int64String
+], DeployResourceResponseDto.prototype, "deploymentKey", void 0);
+//# sourceMappingURL=C8DtoInternal.js.map

package/dist/c8/lib/C8DtoInternal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"C8DtoInternal.js","sourceRoot":"","sources":["../../../src/c8/lib/C8DtoInternal.ts"],"names":[],"mappings":";;;;;;;;;AAAA,mCAAoD;AASpD,MAAa,yBAA0B,SAAQ,iBAAW;CAUzD;AAVD,8DAUC;AARA;IADC,iBAAW;gEACU"}