feat(types): update types to orchestration-cluster-api types

* add type additional type checks in TaskExecution.js

Author: yT0n1

lib/TaskExecution.js

@@ -182,7 +182,7 @@ export default class TaskExecution extends EventEmitter {
         incident = getIncident(getProcessInstanceIncidentResult.response);
       }
 
-      const isCompleted = [ 'COMPLETED', 'TERMINATED', 'CANCELED' ].includes(state);
+      const isCompleted = [ 'COMPLETED', 'TERMINATED', 'CANCELED' ].includes(state ?? '');
 
       if (isCompleted || hasIncident) {
         const getProcessInstanceVariablesResult = await this._api.getProcessInstanceVariables(processInstanceKey);
@@ -215,7 +215,7 @@ export default class TaskExecution extends EventEmitter {
 
         const variables = getVariables(
           getProcessInstanceVariablesResult.response.items,
-          getProcessInstanceElementInstancesResult.response.items,
+          getProcessInstanceElementInstancesResult.response.items ?? [],
           processInstance,
           element.id
         );
@@ -282,16 +282,21 @@ export default class TaskExecution extends EventEmitter {
 /**
  * Get the process instance key from the response.
  *
- * @param {CreateProcessInstanceResponse} response
+ * @param {import('./types').CreateProcessInstanceResult} response
  *
- * @returns {string|null} The process instance key or null if not found.
+ * @returns {string | null} The process instance key or null if not found.
  */
 function getProcessInstanceKey(response) {
   const { processInstanceKey } = response;
 
   return processInstanceKey || null;
 }
 
+/**
+ * @param {import('./types').ProcessInstanceSearchQueryResult} response
+ * @param {string} processInstanceKey
+ * @return {import('./types').ProcessInstanceResult | null}
+ */
 function getProcessInstance(response, processInstanceKey) {
   const { items = [] } = response;
 
@@ -302,6 +307,11 @@ function getProcessInstance(response, processInstanceKey) {
   return items.find(item => item.processInstanceKey === processInstanceKey) || null;
 }
 
+/**
+ * @param {import('./types').ProcessInstanceSearchQueryResult} response
+ * @param {string} processInstanceKey
+ * @return {import('./types').ProcessInstanceStateEnum | null}
+ */
 function getProcessInstanceState(response, processInstanceKey) {
   const processInstance = getProcessInstance(response, processInstanceKey);
 
@@ -312,6 +322,11 @@ function getProcessInstanceState(response, processInstanceKey) {
   return processInstance.state;
 }
 
+/**
+ * @param {import('./types').ProcessInstanceSearchQueryResult} response
+ * @param {string} processInstanceKey
+ * @returns {boolean}
+ */
 function hasProcessInstanceIncident(response, processInstanceKey) {
   const processInstance = getProcessInstance(response, processInstanceKey);
 
@@ -322,6 +337,14 @@ function hasProcessInstanceIncident(response, processInstanceKey) {
   return processInstance.hasIncident || false;
 }
 
+/**
+ *
+ * @param {import('./types').VariableSearchResult[]} getVariablesResponseItems
+ * @param {import('./types').ElementInstanceResult[]} getElementInstancesResponseItems
+ * @param {import('./types').ProcessInstanceResult} processInstance
+ * @param elementId
+ * @returns {object}
+ */
 export function getVariables(getVariablesResponseItems, getElementInstancesResponseItems, processInstance, elementId) {
   const variables = {};
 
@@ -348,6 +371,11 @@ export function getVariables(getVariablesResponseItems, getElementInstancesRespo
   return variables;
 }
 
+/**
+ *
+ * @param {import('./types').IncidentSearchQueryResult} response
+ * @return {import('./types').IncidentResult | null}
+ */
 function getIncident(response) {
   const { items = [] } = response;
 
@@ -358,11 +386,19 @@ function getIncident(response) {
   return items[0];
 }
 
+/**
+ *
+ * @param {import('./types').VariableSearchResult} variable
+ * @param {import('./types').ElementInstanceResult[]} elementInstances
+ * @param {import('./types').ProcessInstanceResult} processInstance
+ * @param {string} elementId
+ * @return {null | string}
+ */
 function getScope(variable, elementInstances, processInstance, elementId) {
   const { scopeKey } = variable;
 
   const elementInstance = elementInstances.find(elementInstance => {
-    return elementInstance.elementInstanceKey === scopeKey && elementInstance.elementId === elementId;
+    return String(elementInstance.elementInstanceKey) === String(scopeKey) && elementInstance.elementId === elementId;
   });
 
   if (elementInstance) {
@@ -371,7 +407,7 @@ function getScope(variable, elementInstances, processInstance, elementId) {
 
   const { processInstanceKey } = processInstance;
 
-  if (scopeKey === processInstanceKey) {
+  if (String(scopeKey) === String(processInstanceKey)) {
     return SCOPES.PROCESS;
   }
 
@@ -381,16 +417,16 @@ function getScope(variable, elementInstances, processInstance, elementId) {
 /**
  * Get the process definition key from the deployment response.
  *
- * @param {import('@camunda8/sdk/dist/c8/lib/C8Dto').DeployResourceResponse} deployResponse
+ * @param {import('./types').ExtendedDeploymentResult} deployResponse
  * @param {string} processId
  *
- * @returns {string|null}
+ * @returns {string | null}
  */
 export function getProcessDefinitionKey(deployResponse, processId) {
   const { deployments = [] } = deployResponse;
 
   for (const deployment of deployments) {
-    if ('processDefinition' in deployment) {
+    if (deployment.processDefinition) {
       const { processDefinition } = deployment;
 
       if (processDefinition.processDefinitionId === processId) {
@@ -400,4 +436,4 @@ export function getProcessDefinitionKey(deployResponse, processId) {
   }
 
   return null;
-}
+}

lib/types.ts

@@ -1,114 +1,135 @@
 import type {
-  CreateProcessInstanceResponse,
-  DeployResourceResponse,
-  SearchProcessInstanceResponse,
-  SearchVariablesResponse,
-  SearchElementInstancesResponse,
-  SearchIncidentsResponse
-} from '@camunda8/sdk/dist/c8/lib/C8Dto';
+    CamundaClient,
+    CreateProcessInstanceResult,
+    ElementInstanceResult,
+    ElementInstanceSearchQueryResult,
+    IncidentResult,
+    IncidentSearchQueryResult,
+    ProcessInstanceResult,
+    ProcessInstanceSearchQueryResult,
+    ProcessInstanceStateEnum,
+    VariableSearchQueryResult,
+    VariableSearchResult
+} from '@camunda8/orchestration-cluster-api';
+import type {ModdleElement} from "bpmn-js/lib/model/Types";
+
+declare type ExtendedDeploymentResult = Awaited<ReturnType<CamundaClient['createDeployment']>>
+
+export type {
+    CreateProcessInstanceResult,
+    ElementInstanceSearchQueryResult,
+    IncidentSearchQueryResult,
+    ProcessInstanceSearchQueryResult,
+    ProcessInstanceResult,
+    VariableSearchQueryResult,
+    ExtendedDeploymentResult,
+    ProcessInstanceStateEnum,
+    VariableSearchResult,
+    ElementInstanceResult,
+    IncidentResult
+}
 
-import type {
-  ModdleElement
-} from "bpmn-js/lib/model/Types";
 
 export type Input = {
-  [elementId: string]: string;
+    [elementId: string]: string;
 };
 
 export type Output = {
-  [elementId: string]: ElementOutput
+    [elementId: string]: ElementOutput
 };
 
 export type VARIABLE_SCOPE = 'LOCAL' | 'PROCESS';
 
 export type ElementOutputVariables = {
-  [id: string]: {
-    name: string;
-    value: any;
-    scope: VARIABLE_SCOPE;
-  }
+    [id: string]: {
+        name: string;
+        value: any;
+        scope: VARIABLE_SCOPE;
+    }
 };
 
 export type ElementOutput = {
-  success: boolean;
-  variables?: ElementOutputVariables;
-  error?: TaskExecutionError;
-  incident?: any;
-  operateUrl?: string;
-  [key: string]: any;
+    success: boolean;
+    variables?: ElementOutputVariables;
+    error?: TaskExecutionError;
+    incident?: any;
+    operateUrl?: string;
+    [key: string]: any;
 } | undefined;
 
 export type Config = {
-  input: Input;
-  output: Output;
+    input: Input;
+    output: Output;
 };
 
 export type Variable = {
-  name: string;
-  type?: string;
-  info?: string;
-  isList?: boolean;
-  entries?: Variable[];
-  scope?: ModdleElement;
+    name: string;
+    type?: string;
+    info?: string;
+    isList?: boolean;
+    entries?: Variable[];
+    scope?: ModdleElement;
 };
 
 export type Variables = Variable[];
 
 export type ApiResponse<T> =
-  | {
-      success: true;
-      response: T;
-    }
-  | {
-      success: false;
-      error: string;
-    }
+    | {
+    success: true;
+    response: T;
+}
+    | {
+    success: false;
+    error: string;
+}
 
 export type TaskExecutionApi = {
-  deploy: () => Promise<ApiResponse<DeployResourceResponse>>;
-  startInstance: (processDefinitionKey: string, elementId: string, variables: { [key: string]: any }) => Promise<ApiResponse<CreateProcessInstanceResponse>>;
-  getProcessInstance: (processInstanceKey: string) => Promise<ApiResponse<SearchProcessInstanceResponse>>;
-  getProcessInstanceVariables: (processInstanceKey: string) => Promise<ApiResponse<SearchVariablesResponse>>;
-  getProcessInstanceElementInstances: (processInstanceKey: string) => Promise<ApiResponse<SearchElementInstancesResponse>>;
-  getProcessInstanceIncident: (processInstanceKey: string) => Promise<ApiResponse<SearchIncidentsResponse>>;
+    deploy: () => Promise<ApiResponse<ExtendedDeploymentResult>>;
+    startInstance: (processDefinitionKey: string, elementId: string, variables: {
+        [key: string]: any
+    }) => Promise<ApiResponse<CreateProcessInstanceResult>>;
+    getProcessInstance: (processInstanceKey: string) => Promise<ApiResponse<ProcessInstanceSearchQueryResult>>;
+    getProcessInstanceVariables: (processInstanceKey: string) => Promise<ApiResponse<VariableSearchQueryResult>>;
+    getProcessInstanceElementInstances: (processInstanceKey: string) => Promise<ApiResponse<ElementInstanceSearchQueryResult>>;
+    getProcessInstanceIncident: (processInstanceKey: string) => Promise<ApiResponse<IncidentSearchQueryResult>>;
 };
 
 export type TaskExecutionStatus =
-  'idle' |
-  'deploying' |
-  'starting-instance' |
-  'executing';
+    'idle' |
+    'deploying' |
+    'starting-instance' |
+    'executing';
 
 export type TaskExecutionEvents =
-  'taskExecution.status.changed' |
-  'taskExecution.finished' |
-  'taskExecution.error' |
-  'taskExecution.interrupted';
+    'taskExecution.status.changed' |
+    'taskExecution.finished' |
+    'taskExecution.error' |
+    'taskExecution.interrupted';
 
 export type TaskExecutionResult = {
-  success: boolean;
-  variables?: ElementOutputVariables;
-  error?: TaskExecutionError;
-  incident?: any;
+    success: boolean;
+    variables?: ElementOutputVariables;
+    error?: TaskExecutionError;
+    incident?: any;
 }
 
 export type TaskExecutionError = {
-  message: string;
-  response?: any;
+    message: string;
+    response?: any;
 };
 
-export type { Element, ModdleElement } from 'bpmn-js/lib/model/Types';
+export type {Element, ModdleElement} from 'bpmn-js/lib/model/Types';
 
 export type Plugin = {
-  priority?: number;
-  render: Function;
-  type: string;
-  [key: string]: any;
+    priority?: number;
+    render: Function;
+    type: string;
+    [key: string]: any;
 };
 
 export type PluginContextValue = {
-  plugins: Plugin[];
-  registerPlugin: (plugin: Plugin) => void;
-  unregisterPlugin: (plugin: Plugin) => void;
-  getPlugins: (pluginPoint: string) => Plugin[];
+    plugins: Plugin[];
+    registerPlugin: (plugin: Plugin) => void;
+    unregisterPlugin: (plugin: Plugin) => void;
+    getPlugins: (pluginPoint: string) => Plugin[];
 };