@amaster.ai/client 1.1.0-beta.68 → 1.1.0-beta.69
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +11 -11
- package/types/bpm.d.ts +123 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@amaster.ai/client",
|
|
3
|
-
"version": "1.1.0-beta.
|
|
3
|
+
"version": "1.1.0-beta.69",
|
|
4
4
|
"description": "Unified API client for Amaster platform - All services in one package",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -72,16 +72,16 @@
|
|
|
72
72
|
"registry": "https://registry.npmjs.org/"
|
|
73
73
|
},
|
|
74
74
|
"dependencies": {
|
|
75
|
-
"@amaster.ai/
|
|
76
|
-
"@amaster.ai/
|
|
77
|
-
"@amaster.ai/
|
|
78
|
-
"@amaster.ai/
|
|
79
|
-
"@amaster.ai/
|
|
80
|
-
"@amaster.ai/
|
|
81
|
-
"@amaster.ai/
|
|
82
|
-
"@amaster.ai/
|
|
83
|
-
"@amaster.ai/
|
|
84
|
-
"@amaster.ai/
|
|
75
|
+
"@amaster.ai/auth-client": "1.1.0-beta.69",
|
|
76
|
+
"@amaster.ai/asr-client": "1.1.0-beta.69",
|
|
77
|
+
"@amaster.ai/bpm-client": "1.1.0-beta.69",
|
|
78
|
+
"@amaster.ai/copilot-client": "1.1.0-beta.69",
|
|
79
|
+
"@amaster.ai/entity-client": "1.1.0-beta.69",
|
|
80
|
+
"@amaster.ai/http-client": "1.1.0-beta.69",
|
|
81
|
+
"@amaster.ai/function-client": "1.1.0-beta.69",
|
|
82
|
+
"@amaster.ai/tts-client": "1.1.0-beta.69",
|
|
83
|
+
"@amaster.ai/workflow-client": "1.1.0-beta.69",
|
|
84
|
+
"@amaster.ai/s3-client": "1.1.0-beta.69"
|
|
85
85
|
},
|
|
86
86
|
"peerDependencies": {
|
|
87
87
|
"axios": "^1.11.0"
|
package/types/bpm.d.ts
CHANGED
|
@@ -228,6 +228,46 @@ export interface TaskCount {
|
|
|
228
228
|
count: number;
|
|
229
229
|
}
|
|
230
230
|
|
|
231
|
+
/**
|
|
232
|
+
* Task form field metadata
|
|
233
|
+
*/
|
|
234
|
+
export interface TaskFormField {
|
|
235
|
+
id: string;
|
|
236
|
+
label?: string;
|
|
237
|
+
type?: string;
|
|
238
|
+
defaultValue?: CamundaVariableValue;
|
|
239
|
+
properties?: Record<string, unknown>;
|
|
240
|
+
validationConstraints?: Array<{
|
|
241
|
+
name: string;
|
|
242
|
+
config?: unknown;
|
|
243
|
+
}>;
|
|
244
|
+
[key: string]: unknown;
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
/**
|
|
248
|
+
* Task form schema metadata
|
|
249
|
+
*/
|
|
250
|
+
export interface TaskFormSchema {
|
|
251
|
+
key?: string;
|
|
252
|
+
contextPath?: string;
|
|
253
|
+
fields?: TaskFormField[];
|
|
254
|
+
[key: string]: unknown;
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
/**
|
|
258
|
+
* Task form variable value
|
|
259
|
+
*/
|
|
260
|
+
export interface TaskFormVariable {
|
|
261
|
+
type: string;
|
|
262
|
+
value: CamundaVariableValue;
|
|
263
|
+
valueInfo?: Record<string, unknown>;
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
/**
|
|
267
|
+
* Task form variables keyed by variable name
|
|
268
|
+
*/
|
|
269
|
+
export type TaskFormVariables = Record<string, TaskFormVariable>;
|
|
270
|
+
|
|
231
271
|
/**
|
|
232
272
|
* Historical task information
|
|
233
273
|
*/
|
|
@@ -502,6 +542,19 @@ export interface BpmClientAPI {
|
|
|
502
542
|
*/
|
|
503
543
|
getTask(taskId: string): Promise<ClientResult<Task>>;
|
|
504
544
|
|
|
545
|
+
/**
|
|
546
|
+
* Get task form schema metadata
|
|
547
|
+
*/
|
|
548
|
+
getTaskFormSchema(
|
|
549
|
+
taskId: string,
|
|
550
|
+
opts?: { redirect?: string }
|
|
551
|
+
): Promise<ClientResult<TaskFormSchema>>;
|
|
552
|
+
|
|
553
|
+
/**
|
|
554
|
+
* Get task form variables
|
|
555
|
+
*/
|
|
556
|
+
getTaskFormVariables(taskId: string): Promise<ClientResult<TaskFormVariables>>;
|
|
557
|
+
|
|
505
558
|
/**
|
|
506
559
|
* Complete a user task
|
|
507
560
|
*
|
|
@@ -531,6 +584,20 @@ export interface BpmClientAPI {
|
|
|
531
584
|
inputs: Record<string, CamundaVariableValue> | VariableSubmission
|
|
532
585
|
): Promise<ClientResult<null>>;
|
|
533
586
|
|
|
587
|
+
/**
|
|
588
|
+
* Query historical tasks
|
|
589
|
+
*/
|
|
590
|
+
getHistoryTasks(
|
|
591
|
+
params?: HistoryTaskQueryParams
|
|
592
|
+
): Promise<ClientResult<HistoryTask[]>>;
|
|
593
|
+
|
|
594
|
+
/**
|
|
595
|
+
* Get historical task count
|
|
596
|
+
*/
|
|
597
|
+
getHistoryTaskCount(
|
|
598
|
+
params?: HistoryTaskQueryParams
|
|
599
|
+
): Promise<ClientResult<TaskCount>>;
|
|
600
|
+
|
|
534
601
|
// ==================== History & Reporting ====================
|
|
535
602
|
|
|
536
603
|
/**
|
|
@@ -572,6 +639,13 @@ export interface BpmClientAPI {
|
|
|
572
639
|
getHistoryProcessInstanceCount(
|
|
573
640
|
params?: HistoryProcessInstanceQueryParams
|
|
574
641
|
): Promise<ClientResult<{ count: number }>>;
|
|
642
|
+
|
|
643
|
+
/**
|
|
644
|
+
* Get deployed Camunda form definition for a task
|
|
645
|
+
*/
|
|
646
|
+
getTaskDeployedForm(
|
|
647
|
+
taskId: string
|
|
648
|
+
): Promise<ClientResult<CamundaFormDefinition>>;
|
|
575
649
|
}
|
|
576
650
|
|
|
577
651
|
/**
|
|
@@ -619,3 +693,52 @@ export interface HistoryProcessInstanceQueryParams {
|
|
|
619
693
|
/** Pagination: max results to return */
|
|
620
694
|
maxResults?: number;
|
|
621
695
|
}
|
|
696
|
+
|
|
697
|
+
/**
|
|
698
|
+
* Historical task query parameters
|
|
699
|
+
*/
|
|
700
|
+
export interface HistoryTaskQueryParams {
|
|
701
|
+
/** Filter by task assignee */
|
|
702
|
+
taskAssignee?: string;
|
|
703
|
+
/** Filter by process instance ID */
|
|
704
|
+
processInstanceId?: string;
|
|
705
|
+
/** Filter finished tasks */
|
|
706
|
+
finished?: boolean;
|
|
707
|
+
/** Filter unfinished tasks */
|
|
708
|
+
unfinished?: boolean;
|
|
709
|
+
/** Pagination: first result index */
|
|
710
|
+
firstResult?: number;
|
|
711
|
+
/** Pagination: max results to return */
|
|
712
|
+
maxResults?: number;
|
|
713
|
+
/** Sort field */
|
|
714
|
+
sortBy?: string;
|
|
715
|
+
/** Sort order */
|
|
716
|
+
sortOrder?: "asc" | "desc";
|
|
717
|
+
[key: string]: string | number | boolean | undefined;
|
|
718
|
+
}
|
|
719
|
+
|
|
720
|
+
/**
|
|
721
|
+
* Camunda deployed form definition
|
|
722
|
+
*/
|
|
723
|
+
export interface CamundaFormDefinition {
|
|
724
|
+
components?: CamundaFormComponent[];
|
|
725
|
+
type?: string;
|
|
726
|
+
id?: string;
|
|
727
|
+
schemaVersion?: number;
|
|
728
|
+
}
|
|
729
|
+
|
|
730
|
+
/**
|
|
731
|
+
* Camunda form component definition
|
|
732
|
+
*/
|
|
733
|
+
export interface CamundaFormComponent {
|
|
734
|
+
key: string;
|
|
735
|
+
label?: string;
|
|
736
|
+
type: string;
|
|
737
|
+
validate?: {
|
|
738
|
+
required?: boolean;
|
|
739
|
+
readonly?: boolean;
|
|
740
|
+
};
|
|
741
|
+
defaultValue?: CamundaVariableValue;
|
|
742
|
+
values?: Array<{ label: string; value: string }>;
|
|
743
|
+
properties?: Record<string, unknown>;
|
|
744
|
+
}
|