@amaster.ai/bpm-client 1.0.0-beta.0

package/dist/index.d.cts

@@ -0,0 +1,179 @@
+import { ClientResult, HttpClient } from '@amaster.ai/http-client';
+
+type CamundaVariableType = "String" | "Boolean" | "Integer" | "Long" | "Double" | "Date" | "Json";
+type CamundaVariableValue = string | number | boolean | Date | null | undefined | Record<string, unknown> | unknown[];
+type CamundaVariable = {
+    value: CamundaVariableValue;
+    type?: CamundaVariableType;
+};
+type VariableSubmission = {
+    variables: Record<string, CamundaVariable>;
+};
+type ProcessInstance = {
+    id: string;
+    definitionId?: string;
+    businessKey?: string;
+    ended?: boolean;
+    suspended?: boolean;
+};
+type ProcessInstanceQueryParams = {
+    processDefinitionKey?: string;
+    active?: boolean;
+    firstResult?: number;
+    maxResults?: number;
+};
+type HistoryProcessInstance = {
+    id: string;
+    businessKey: string;
+    processDefinitionId: string;
+    processDefinitionKey: string;
+    processDefinitionName: string;
+    processDefinitionVersion: number;
+    startTime: string;
+    endTime: string | null;
+    durationInMillis: number | null;
+    startUserId: string;
+    startActivityId: string;
+    deleteReason: string | null;
+    state: string;
+    superProcessInstanceId?: string;
+    superCaseInstanceId?: string;
+};
+type HistoryProcessInstanceQueryParams = {
+    startedBy?: string;
+    finished?: boolean;
+    processDefinitionKey?: string;
+    sortBy?: string;
+    sortOrder?: "asc" | "desc";
+    firstResult?: number;
+    maxResults?: number;
+};
+type ProcessVariable = {
+    id: string;
+    name: string;
+    type: string;
+    value: CamundaVariableValue;
+    processInstanceId: string;
+    createTime?: string;
+    activityInstanceId?: string;
+    taskId?: string;
+    executionId?: string;
+    errorMessage?: string;
+};
+type ActivityInstance = {
+    id: string;
+    activityId: string;
+    activityName: string;
+    activityType: string;
+    processInstanceId: string;
+    executionId: string;
+    startTime: string;
+    endTime?: string;
+};
+type Task = {
+    id: string;
+    name: string;
+    description?: string | null;
+    assignee?: string | null;
+    created?: string | null;
+    due?: string | null;
+    priority?: number;
+    processInstanceId?: string | null;
+    processDefinitionId?: string | null;
+    taskDefinitionKey?: string | null;
+    businessKey?: string | null;
+    taskState?: string | null;
+};
+type TaskCount = {
+    count: number;
+};
+type TaskFormField = {
+    id: string;
+    label?: string;
+    type?: string;
+    defaultValue?: CamundaVariableValue;
+    properties?: Record<string, unknown>;
+    validationConstraints?: Array<{
+        name: string;
+        config?: unknown;
+    }>;
+    [key: string]: unknown;
+};
+type TaskFormSchema = {
+    key?: string;
+    contextPath?: string;
+    fields?: TaskFormField[];
+    [key: string]: unknown;
+};
+type TaskFormVariable = {
+    type: string;
+    value: CamundaVariableValue;
+    valueInfo?: Record<string, unknown>;
+};
+type TaskFormVariables = Record<string, TaskFormVariable>;
+type HistoryTask = {
+    id: string;
+    name: string;
+    assignee: string;
+    startTime: string;
+    endTime: string;
+    duration: number;
+    taskState: string;
+    processInstanceId: string;
+};
+type TaskQueryParams = {
+    processInstanceId?: string;
+    assignee?: string;
+    candidateUser?: string;
+    candidateGroup?: string;
+    name?: string;
+    nameLike?: string;
+    taskDefinitionKey?: string;
+    firstResult?: number;
+    maxResults?: number;
+    sortBy?: string;
+    sortOrder?: "asc" | "desc";
+    [key: string]: string | number | boolean | undefined;
+};
+type HistoryTaskQueryParams = {
+    taskAssignee?: string;
+    processInstanceId?: string;
+    finished?: boolean;
+    unfinished?: boolean;
+    firstResult?: number;
+    maxResults?: number;
+    sortBy?: string;
+    sortOrder?: "asc" | "desc";
+    [key: string]: string | number | boolean | undefined;
+};
+type BpmClient = {
+    startProcess(processKey: string, inputs?: Record<string, CamundaVariableValue> | VariableSubmission): Promise<ClientResult<ProcessInstance>>;
+    getProcessInstances(params?: ProcessInstanceQueryParams): Promise<ClientResult<ProcessInstance[]>>;
+    getProcessInstance(processInstanceId: string): Promise<ClientResult<ProcessInstance>>;
+    deleteProcessInstance(processInstanceId: string, params?: {
+        skipCustomListeners?: boolean;
+    }): Promise<ClientResult<null>>;
+    getActiveActivities(processInstanceId: string): Promise<ClientResult<ActivityInstance[]>>;
+    getTasks(params?: TaskQueryParams): Promise<ClientResult<Task[]>>;
+    getTaskCount(params?: TaskQueryParams): Promise<ClientResult<TaskCount>>;
+    getTask(taskId: string): Promise<ClientResult<Task>>;
+    getTaskFormSchema(taskId: string, opts?: {
+        redirect?: string;
+    }): Promise<ClientResult<TaskFormSchema>>;
+    getTaskFormVariables(taskId: string): Promise<ClientResult<TaskFormVariables>>;
+    completeTask(taskId: string, inputs: Record<string, CamundaVariableValue> | VariableSubmission): Promise<ClientResult<null>>;
+    getHistoryTasks(params?: HistoryTaskQueryParams): Promise<ClientResult<HistoryTask[]>>;
+    getHistoryTaskCount(params?: HistoryTaskQueryParams): Promise<ClientResult<TaskCount>>;
+    getHistoryProcessInstances(params?: HistoryProcessInstanceQueryParams): Promise<ClientResult<HistoryProcessInstance[]>>;
+    getHistoryProcessInstanceCount(params?: HistoryProcessInstanceQueryParams): Promise<ClientResult<{
+        count: number;
+    }>>;
+    getHistoryProcessInstance(processInstanceId: string): Promise<ClientResult<HistoryProcessInstance>>;
+    getProcessVariables(params: {
+        processInstanceId: string;
+        variableName?: string;
+    }): Promise<ClientResult<ProcessVariable[]>>;
+};
+declare function createBpmClient(http?: HttpClient): BpmClient;
+
+export { type ActivityInstance, type BpmClient, type CamundaVariable, type CamundaVariableType, type CamundaVariableValue, type HistoryProcessInstance, type HistoryProcessInstanceQueryParams, type HistoryTask, type HistoryTaskQueryParams, type ProcessInstance, type ProcessInstanceQueryParams, type ProcessVariable, type Task, type TaskCount, type TaskFormField, type TaskFormSchema, type TaskFormVariable, type TaskFormVariables, type TaskQueryParams, type VariableSubmission, createBpmClient };

package/dist/index.d.ts

@@ -0,0 +1,179 @@
+import { ClientResult, HttpClient } from '@amaster.ai/http-client';
+
+type CamundaVariableType = "String" | "Boolean" | "Integer" | "Long" | "Double" | "Date" | "Json";
+type CamundaVariableValue = string | number | boolean | Date | null | undefined | Record<string, unknown> | unknown[];
+type CamundaVariable = {
+    value: CamundaVariableValue;
+    type?: CamundaVariableType;
+};
+type VariableSubmission = {
+    variables: Record<string, CamundaVariable>;
+};
+type ProcessInstance = {
+    id: string;
+    definitionId?: string;
+    businessKey?: string;
+    ended?: boolean;
+    suspended?: boolean;
+};
+type ProcessInstanceQueryParams = {
+    processDefinitionKey?: string;
+    active?: boolean;
+    firstResult?: number;
+    maxResults?: number;
+};
+type HistoryProcessInstance = {
+    id: string;
+    businessKey: string;
+    processDefinitionId: string;
+    processDefinitionKey: string;
+    processDefinitionName: string;
+    processDefinitionVersion: number;
+    startTime: string;
+    endTime: string | null;
+    durationInMillis: number | null;
+    startUserId: string;
+    startActivityId: string;
+    deleteReason: string | null;
+    state: string;
+    superProcessInstanceId?: string;
+    superCaseInstanceId?: string;
+};
+type HistoryProcessInstanceQueryParams = {
+    startedBy?: string;
+    finished?: boolean;
+    processDefinitionKey?: string;
+    sortBy?: string;
+    sortOrder?: "asc" | "desc";
+    firstResult?: number;
+    maxResults?: number;
+};
+type ProcessVariable = {
+    id: string;
+    name: string;
+    type: string;
+    value: CamundaVariableValue;
+    processInstanceId: string;
+    createTime?: string;
+    activityInstanceId?: string;
+    taskId?: string;
+    executionId?: string;
+    errorMessage?: string;
+};
+type ActivityInstance = {
+    id: string;
+    activityId: string;
+    activityName: string;
+    activityType: string;
+    processInstanceId: string;
+    executionId: string;
+    startTime: string;
+    endTime?: string;
+};
+type Task = {
+    id: string;
+    name: string;
+    description?: string | null;
+    assignee?: string | null;
+    created?: string | null;
+    due?: string | null;
+    priority?: number;
+    processInstanceId?: string | null;
+    processDefinitionId?: string | null;
+    taskDefinitionKey?: string | null;
+    businessKey?: string | null;
+    taskState?: string | null;
+};
+type TaskCount = {
+    count: number;
+};
+type TaskFormField = {
+    id: string;
+    label?: string;
+    type?: string;
+    defaultValue?: CamundaVariableValue;
+    properties?: Record<string, unknown>;
+    validationConstraints?: Array<{
+        name: string;
+        config?: unknown;
+    }>;
+    [key: string]: unknown;
+};
+type TaskFormSchema = {
+    key?: string;
+    contextPath?: string;
+    fields?: TaskFormField[];
+    [key: string]: unknown;
+};
+type TaskFormVariable = {
+    type: string;
+    value: CamundaVariableValue;
+    valueInfo?: Record<string, unknown>;
+};
+type TaskFormVariables = Record<string, TaskFormVariable>;
+type HistoryTask = {
+    id: string;
+    name: string;
+    assignee: string;
+    startTime: string;
+    endTime: string;
+    duration: number;
+    taskState: string;
+    processInstanceId: string;
+};
+type TaskQueryParams = {
+    processInstanceId?: string;
+    assignee?: string;
+    candidateUser?: string;
+    candidateGroup?: string;
+    name?: string;
+    nameLike?: string;
+    taskDefinitionKey?: string;
+    firstResult?: number;
+    maxResults?: number;
+    sortBy?: string;
+    sortOrder?: "asc" | "desc";
+    [key: string]: string | number | boolean | undefined;
+};
+type HistoryTaskQueryParams = {
+    taskAssignee?: string;
+    processInstanceId?: string;
+    finished?: boolean;
+    unfinished?: boolean;
+    firstResult?: number;
+    maxResults?: number;
+    sortBy?: string;
+    sortOrder?: "asc" | "desc";
+    [key: string]: string | number | boolean | undefined;
+};
+type BpmClient = {
+    startProcess(processKey: string, inputs?: Record<string, CamundaVariableValue> | VariableSubmission): Promise<ClientResult<ProcessInstance>>;
+    getProcessInstances(params?: ProcessInstanceQueryParams): Promise<ClientResult<ProcessInstance[]>>;
+    getProcessInstance(processInstanceId: string): Promise<ClientResult<ProcessInstance>>;
+    deleteProcessInstance(processInstanceId: string, params?: {
+        skipCustomListeners?: boolean;
+    }): Promise<ClientResult<null>>;
+    getActiveActivities(processInstanceId: string): Promise<ClientResult<ActivityInstance[]>>;
+    getTasks(params?: TaskQueryParams): Promise<ClientResult<Task[]>>;
+    getTaskCount(params?: TaskQueryParams): Promise<ClientResult<TaskCount>>;
+    getTask(taskId: string): Promise<ClientResult<Task>>;
+    getTaskFormSchema(taskId: string, opts?: {
+        redirect?: string;
+    }): Promise<ClientResult<TaskFormSchema>>;
+    getTaskFormVariables(taskId: string): Promise<ClientResult<TaskFormVariables>>;
+    completeTask(taskId: string, inputs: Record<string, CamundaVariableValue> | VariableSubmission): Promise<ClientResult<null>>;
+    getHistoryTasks(params?: HistoryTaskQueryParams): Promise<ClientResult<HistoryTask[]>>;
+    getHistoryTaskCount(params?: HistoryTaskQueryParams): Promise<ClientResult<TaskCount>>;
+    getHistoryProcessInstances(params?: HistoryProcessInstanceQueryParams): Promise<ClientResult<HistoryProcessInstance[]>>;
+    getHistoryProcessInstanceCount(params?: HistoryProcessInstanceQueryParams): Promise<ClientResult<{
+        count: number;
+    }>>;
+    getHistoryProcessInstance(processInstanceId: string): Promise<ClientResult<HistoryProcessInstance>>;
+    getProcessVariables(params: {
+        processInstanceId: string;
+        variableName?: string;
+    }): Promise<ClientResult<ProcessVariable[]>>;
+};
+declare function createBpmClient(http?: HttpClient): BpmClient;
+
+export { type ActivityInstance, type BpmClient, type CamundaVariable, type CamundaVariableType, type CamundaVariableValue, type HistoryProcessInstance, type HistoryProcessInstanceQueryParams, type HistoryTask, type HistoryTaskQueryParams, type ProcessInstance, type ProcessInstanceQueryParams, type ProcessVariable, type Task, type TaskCount, type TaskFormField, type TaskFormSchema, type TaskFormVariable, type TaskFormVariables, type TaskQueryParams, type VariableSubmission, createBpmClient };

package/dist/index.js

@@ -0,0 +1,296 @@
+import { createHttpClient } from '@amaster.ai/http-client';
+
+// src/bpm-client.ts
+function isVariableSubmission(x) {
+  return x !== null && x !== void 0 && typeof x === "object" && "variables" in x && typeof x.variables === "object" && x.variables !== null;
+}
+function formatDateForCamunda(date) {
+  let isoString;
+  if (date instanceof Date) {
+    isoString = date.toISOString();
+  } else if (typeof date === "number") {
+    isoString = new Date(date).toISOString();
+  } else if (typeof date === "string") {
+    try {
+      isoString = new Date(date).toISOString();
+    } catch {
+      isoString = date;
+    }
+  } else {
+    isoString = new Date(date).toISOString();
+  }
+  return isoString.replace(/z$/i, "+0000");
+}
+function inferType(value) {
+  if (value === null || value === void 0) {
+    return void 0;
+  }
+  if (typeof value === "string") {
+    return "String";
+  }
+  if (typeof value === "boolean") {
+    return "Boolean";
+  }
+  if (typeof value === "number") {
+    return Number.isInteger(value) ? "Long" : "Double";
+  }
+  if (value instanceof Date) {
+    return "Date";
+  }
+  if (typeof value === "object") {
+    return "Json";
+  }
+  return void 0;
+}
+function processVariableValue(v) {
+  if (v && typeof v === "object" && "value" in v && ("type" in v || Object.keys(v).length <= 2)) {
+    const variable = v;
+    if (variable.value instanceof Date) {
+      return {
+        value: formatDateForCamunda(variable.value),
+        type: "Date"
+      };
+    }
+    if (variable.type === "Date" && (typeof variable.value === "string" || typeof variable.value === "number")) {
+      return {
+        value: formatDateForCamunda(variable.value),
+        type: "Date"
+      };
+    }
+    return variable;
+  }
+  if (v instanceof Date) {
+    return {
+      value: formatDateForCamunda(v),
+      type: "Date"
+    };
+  }
+  const camundaValue = v;
+  return { value: camundaValue, type: inferType(camundaValue) };
+}
+function toVariableSubmission(inputs) {
+  if (!inputs) {
+    return { variables: {} };
+  }
+  if (isVariableSubmission(inputs)) {
+    const variables2 = {};
+    for (const [k, v] of Object.entries(inputs.variables)) {
+      variables2[k] = processVariableValue(v);
+    }
+    return { variables: variables2 };
+  }
+  const variables = {};
+  for (const [k, v] of Object.entries(inputs)) {
+    variables[k] = processVariableValue(v);
+  }
+  return { variables };
+}
+function encodeQuery(params) {
+  if (!params) {
+    return "";
+  }
+  const sp = new URLSearchParams();
+  for (const [k, v] of Object.entries(params)) {
+    if (v === void 0 || v === null) {
+      continue;
+    }
+    sp.append(k, String(v));
+  }
+  const q = sp.toString();
+  return q ? `?${q}` : "";
+}
+function noContentToNull(r) {
+  if (r.status === 204) {
+    return { ...r, data: null };
+  }
+  return r;
+}
+function createBpmClient(http = createHttpClient()) {
+  return {
+    startProcess(processKey, inputs) {
+      if (!processKey) {
+        return Promise.resolve({
+          data: null,
+          error: { message: "Process key is required", status: 400 },
+          status: 400
+        });
+      }
+      return http.request({
+        url: `/api/bpm/start/${processKey}`,
+        method: "post",
+        headers: { "Content-Type": "application/json" },
+        data: toVariableSubmission(inputs)
+      });
+    },
+    getProcessInstances(params) {
+      return http.request({
+        url: `/api/bpm/process-instance${encodeQuery(params)}`,
+        method: "get"
+      });
+    },
+    getProcessInstance(processInstanceId) {
+      if (!processInstanceId) {
+        return Promise.resolve({
+          data: null,
+          error: { message: "Process instance ID is required", status: 400 },
+          status: 400
+        });
+      }
+      return http.request({
+        url: `/api/bpm/process-instance/${processInstanceId}`,
+        method: "get"
+      });
+    },
+    async deleteProcessInstance(processInstanceId, params) {
+      if (!processInstanceId) {
+        return {
+          data: null,
+          error: { message: "Process instance ID is required", status: 400 },
+          status: 400
+        };
+      }
+      const q = params?.skipCustomListeners ? "?skipCustomListeners=true" : "";
+      const result = await http.request({
+        url: `/api/bpm/process-instance/${processInstanceId}${q}`,
+        method: "delete"
+      });
+      return noContentToNull(result);
+    },
+    getActiveActivities(processInstanceId) {
+      if (!processInstanceId) {
+        return Promise.resolve({
+          data: null,
+          error: { message: "Process instance ID is required", status: 400 },
+          status: 400
+        });
+      }
+      return http.request({
+        url: `/api/bpm/process-instance/${processInstanceId}/activity-instances`,
+        method: "get"
+      });
+    },
+    getTasks(params) {
+      return http.request({
+        url: `/api/bpm/task${encodeQuery(params)}`,
+        method: "get"
+      });
+    },
+    getTaskCount(params) {
+      return http.request({
+        url: `/api/bpm/task/count${encodeQuery(params)}`,
+        method: "get"
+      });
+    },
+    getTask(taskId) {
+      if (!taskId) {
+        return Promise.resolve({
+          data: null,
+          error: { message: "Task ID is required", status: 400 },
+          status: 400
+        });
+      }
+      return http.request({
+        url: `/api/bpm/task/${taskId}`,
+        method: "get"
+      });
+    },
+    getTaskFormSchema(taskId, opts) {
+      if (!taskId) {
+        return Promise.resolve({
+          data: null,
+          error: { message: "Task ID is required", status: 400 },
+          status: 400
+        });
+      }
+      const q = encodeQuery(opts?.redirect ? { redirect: opts.redirect } : void 0);
+      return http.request({
+        url: `/api/bpm/task/${taskId}/form-schema${q}`,
+        method: "get"
+      });
+    },
+    getTaskFormVariables(taskId) {
+      if (!taskId) {
+        return Promise.resolve({
+          data: null,
+          error: { message: "Task ID is required", status: 400 },
+          status: 400
+        });
+      }
+      return http.request({
+        url: `/api/bpm/task/${taskId}/form-variables`,
+        method: "get"
+      });
+    },
+    async completeTask(taskId, inputs) {
+      if (!taskId) {
+        return {
+          data: null,
+          error: { message: "Task ID is required", status: 400 },
+          status: 400
+        };
+      }
+      const r = await http.request({
+        url: `/api/bpm/task/${taskId}/complete`,
+        method: "post",
+        headers: { "Content-Type": "application/json" },
+        data: toVariableSubmission(inputs)
+      });
+      return noContentToNull(r);
+    },
+    getHistoryTasks(params) {
+      return http.request({
+        url: `/api/bpm/history/task${encodeQuery(params)}`,
+        method: "get"
+      });
+    },
+    getHistoryTaskCount(params) {
+      return http.request({
+        url: `/api/bpm/history/task/count${encodeQuery(params)}`,
+        method: "get"
+      });
+    },
+    getHistoryProcessInstances(params) {
+      return http.request({
+        url: `/api/bpm/history/process-instance${encodeQuery(params)}`,
+        method: "get"
+      });
+    },
+    getHistoryProcessInstanceCount(params) {
+      return http.request({
+        url: `/api/bpm/history/process-instance/count${encodeQuery(params)}`,
+        method: "get"
+      });
+    },
+    getHistoryProcessInstance(processInstanceId) {
+      if (!processInstanceId) {
+        return Promise.resolve({
+          data: null,
+          error: { message: "Process instance ID is required", status: 400 },
+          status: 400
+        });
+      }
+      return http.request({
+        url: `/api/bpm/history/process-instance/${processInstanceId}`,
+        method: "get"
+      });
+    },
+    getProcessVariables(params) {
+      if (!params.processInstanceId) {
+        return Promise.resolve({
+          data: null,
+          error: { message: "Process instance ID is required", status: 400 },
+          status: 400
+        });
+      }
+      const q = encodeQuery(params);
+      return http.request({
+        url: `/api/bpm/history/variable-instance${q}`,
+        method: "get"
+      });
+    }
+  };
+}
+
+export { createBpmClient };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map