@uipath/uipath-typescript 1.2.1 → 1.3.0
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/dist/assets/index.cjs +1 -1
- package/dist/assets/index.d.ts +2 -1
- package/dist/assets/index.mjs +1 -1
- package/dist/attachments/index.cjs +1944 -0
- package/dist/attachments/index.d.ts +399 -0
- package/dist/attachments/index.mjs +1941 -0
- package/dist/buckets/index.cjs +1 -1
- package/dist/buckets/index.d.ts +4 -2
- package/dist/buckets/index.mjs +1 -1
- package/dist/cases/index.cjs +95 -48
- package/dist/cases/index.d.ts +31 -2
- package/dist/cases/index.mjs +95 -48
- package/dist/conversational-agent/index.cjs +1 -1
- package/dist/conversational-agent/index.d.ts +10 -5
- package/dist/conversational-agent/index.mjs +1 -1
- package/dist/core/index.cjs +109 -17
- package/dist/core/index.d.ts +1 -1
- package/dist/core/index.mjs +109 -17
- package/dist/entities/index.cjs +11 -27
- package/dist/entities/index.d.ts +38 -26
- package/dist/entities/index.mjs +11 -27
- package/dist/index.cjs +683 -284
- package/dist/index.d.ts +549 -75
- package/dist/index.mjs +683 -285
- package/dist/index.umd.js +680 -281
- package/dist/jobs/index.cjs +2264 -0
- package/dist/jobs/index.d.ts +860 -0
- package/dist/jobs/index.mjs +2260 -0
- package/dist/maestro-processes/index.cjs +1 -1
- package/dist/maestro-processes/index.mjs +1 -1
- package/dist/processes/index.cjs +67 -1
- package/dist/processes/index.d.ts +80 -15
- package/dist/processes/index.mjs +68 -2
- package/dist/queues/index.cjs +1 -1
- package/dist/queues/index.d.ts +2 -1
- package/dist/queues/index.mjs +1 -1
- package/dist/tasks/index.cjs +1319 -1272
- package/dist/tasks/index.d.ts +331 -287
- package/dist/tasks/index.mjs +1319 -1272
- package/package.json +23 -2
package/dist/buckets/index.cjs
CHANGED
|
@@ -1722,7 +1722,7 @@ const BucketMap = {
|
|
|
1722
1722
|
// Connection string placeholder that will be replaced during build
|
|
1723
1723
|
const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
|
|
1724
1724
|
// SDK Version placeholder
|
|
1725
|
-
const SDK_VERSION = "1.
|
|
1725
|
+
const SDK_VERSION = "1.3.0";
|
|
1726
1726
|
const VERSION = "Version";
|
|
1727
1727
|
const SERVICE = "Service";
|
|
1728
1728
|
const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
|
package/dist/buckets/index.d.ts
CHANGED
|
@@ -347,7 +347,8 @@ interface BucketGetResponse {
|
|
|
347
347
|
type BucketGetAllOptions = RequestOptions & PaginationOptions & {
|
|
348
348
|
folderId?: number;
|
|
349
349
|
};
|
|
350
|
-
|
|
350
|
+
interface BucketGetByIdOptions extends BaseOptions {
|
|
351
|
+
}
|
|
351
352
|
/**
|
|
352
353
|
* Maps header names to their values
|
|
353
354
|
*
|
|
@@ -401,7 +402,8 @@ interface BucketGetUriOptions extends BaseOptions {
|
|
|
401
402
|
/**
|
|
402
403
|
* Request options for getting a read URI for a file in a bucket
|
|
403
404
|
*/
|
|
404
|
-
|
|
405
|
+
interface BucketGetReadUriOptions extends BucketGetUriOptions {
|
|
406
|
+
}
|
|
405
407
|
/**
|
|
406
408
|
* Request options for getting files in a bucket
|
|
407
409
|
*/
|
package/dist/buckets/index.mjs
CHANGED
|
@@ -1720,7 +1720,7 @@ const BucketMap = {
|
|
|
1720
1720
|
// Connection string placeholder that will be replaced during build
|
|
1721
1721
|
const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
|
|
1722
1722
|
// SDK Version placeholder
|
|
1723
|
-
const SDK_VERSION = "1.
|
|
1723
|
+
const SDK_VERSION = "1.3.0";
|
|
1724
1724
|
const VERSION = "Version";
|
|
1725
1725
|
const SERVICE = "Service";
|
|
1726
1726
|
const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
|
package/dist/cases/index.cjs
CHANGED
|
@@ -1789,6 +1789,8 @@ const TASK_ENDPOINTS = {
|
|
|
1789
1789
|
COMPLETE_APP_TASK: `${ORCHESTRATOR_BASE}/tasks/AppTasks/CompleteAppTask`,
|
|
1790
1790
|
COMPLETE_GENERIC_TASK: `${ORCHESTRATOR_BASE}/tasks/GenericTasks/CompleteTask`,
|
|
1791
1791
|
GET_TASK_FORM_BY_ID: `${ORCHESTRATOR_BASE}/forms/TaskForms/GetTaskFormById`,
|
|
1792
|
+
GET_GENERIC_TASK_BY_ID: `${ORCHESTRATOR_BASE}/tasks/GenericTasks/GetTaskDataById`,
|
|
1793
|
+
GET_APP_TASK_BY_ID: `${ORCHESTRATOR_BASE}/tasks/AppTasks/GetAppTaskById`,
|
|
1792
1794
|
};
|
|
1793
1795
|
|
|
1794
1796
|
/**
|
|
@@ -1830,7 +1832,7 @@ const MAESTRO_ENDPOINTS = {
|
|
|
1830
1832
|
// Connection string placeholder that will be replaced during build
|
|
1831
1833
|
const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
|
|
1832
1834
|
// SDK Version placeholder
|
|
1833
|
-
const SDK_VERSION = "1.
|
|
1835
|
+
const SDK_VERSION = "1.3.0";
|
|
1834
1836
|
const VERSION = "Version";
|
|
1835
1837
|
const SERVICE = "Service";
|
|
1836
1838
|
const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
|
|
@@ -2396,11 +2398,24 @@ const CASE_INSTANCE_TASK_FILTER = (caseInstanceId) => `Tags/any(tags:tags/Displa
|
|
|
2396
2398
|
*/
|
|
2397
2399
|
const CASE_INSTANCE_TASK_EXPAND = 'AssignedToUser,Activities';
|
|
2398
2400
|
|
|
2401
|
+
/**
|
|
2402
|
+
* Types of tasks available in Action Center.
|
|
2403
|
+
* Each type determines the task's behavior, UI rendering, and completion requirements.
|
|
2404
|
+
*/
|
|
2399
2405
|
var TaskType;
|
|
2400
2406
|
(function (TaskType) {
|
|
2407
|
+
/** A form-based task that renders a UiPath form layout for user input */
|
|
2401
2408
|
TaskType["Form"] = "FormTask";
|
|
2409
|
+
/** An externally managed task handled outside of Action Center */
|
|
2402
2410
|
TaskType["External"] = "ExternalTask";
|
|
2411
|
+
/** A task powered by a UiPath App */
|
|
2403
2412
|
TaskType["App"] = "AppTask";
|
|
2413
|
+
/** A document validation task for reviewing and correcting extracted document data */
|
|
2414
|
+
TaskType["DocumentValidation"] = "DocumentValidationTask";
|
|
2415
|
+
/** A document classification task for categorizing documents */
|
|
2416
|
+
TaskType["DocumentClassification"] = "DocumentClassificationTask";
|
|
2417
|
+
/** A data labeling task for annotating training data */
|
|
2418
|
+
TaskType["DataLabeling"] = "DataLabelingTask";
|
|
2404
2419
|
})(TaskType || (TaskType = {}));
|
|
2405
2420
|
var TaskPriority;
|
|
2406
2421
|
(function (TaskPriority) {
|
|
@@ -2454,6 +2469,42 @@ var TaskActivityType;
|
|
|
2454
2469
|
TaskActivityType["FirstOpened"] = "FirstOpened";
|
|
2455
2470
|
})(TaskActivityType || (TaskActivityType = {}));
|
|
2456
2471
|
|
|
2472
|
+
/**
|
|
2473
|
+
* Maps numeric TaskStatus values (from API) to TaskStatus enum values.
|
|
2474
|
+
* Extend this file with additional field mappings as needed.
|
|
2475
|
+
*/
|
|
2476
|
+
const TaskStatusMap = {
|
|
2477
|
+
0: TaskStatus.Unassigned,
|
|
2478
|
+
1: TaskStatus.Pending,
|
|
2479
|
+
2: TaskStatus.Completed,
|
|
2480
|
+
};
|
|
2481
|
+
// Field mapping for time-related fields to ensure consistent naming
|
|
2482
|
+
const TaskMap = {
|
|
2483
|
+
completionTime: 'completedTime',
|
|
2484
|
+
deletionTime: 'deletedTime',
|
|
2485
|
+
lastModificationTime: 'lastModifiedTime',
|
|
2486
|
+
creationTime: 'createdTime',
|
|
2487
|
+
organizationUnitId: 'folderId'
|
|
2488
|
+
};
|
|
2489
|
+
/**
|
|
2490
|
+
* Default expand parameters
|
|
2491
|
+
*/
|
|
2492
|
+
const DEFAULT_TASK_EXPAND = 'AssignedToUser,CreatorUser,LastModifierUser';
|
|
2493
|
+
|
|
2494
|
+
const TASK_TYPE_ENDPOINTS = {
|
|
2495
|
+
[TaskType.Form]: TASK_ENDPOINTS.GET_TASK_FORM_BY_ID,
|
|
2496
|
+
[TaskType.App]: TASK_ENDPOINTS.GET_APP_TASK_BY_ID,
|
|
2497
|
+
[TaskType.DocumentValidation]: TASK_ENDPOINTS.GET_GENERIC_TASK_BY_ID,
|
|
2498
|
+
[TaskType.DocumentClassification]: TASK_ENDPOINTS.GET_GENERIC_TASK_BY_ID,
|
|
2499
|
+
[TaskType.External]: TASK_ENDPOINTS.GET_GENERIC_TASK_BY_ID,
|
|
2500
|
+
[TaskType.DataLabeling]: TASK_ENDPOINTS.GET_GENERIC_TASK_BY_ID,
|
|
2501
|
+
};
|
|
2502
|
+
var ActionCenterEventNames;
|
|
2503
|
+
(function (ActionCenterEventNames) {
|
|
2504
|
+
ActionCenterEventNames["TOKENREFRESHED"] = "AC.tokenRefreshed";
|
|
2505
|
+
ActionCenterEventNames["REFRESHTOKEN"] = "AC.refreshToken";
|
|
2506
|
+
})(ActionCenterEventNames || (ActionCenterEventNames = {}));
|
|
2507
|
+
|
|
2457
2508
|
/**
|
|
2458
2509
|
* Creates methods for a task
|
|
2459
2510
|
*
|
|
@@ -2511,28 +2562,6 @@ function createTaskWithMethods(taskData, service) {
|
|
|
2511
2562
|
return Object.assign({}, taskData, methods);
|
|
2512
2563
|
}
|
|
2513
2564
|
|
|
2514
|
-
/**
|
|
2515
|
-
* Maps numeric TaskStatus values (from API) to TaskStatus enum values.
|
|
2516
|
-
* Extend this file with additional field mappings as needed.
|
|
2517
|
-
*/
|
|
2518
|
-
const TaskStatusMap = {
|
|
2519
|
-
0: TaskStatus.Unassigned,
|
|
2520
|
-
1: TaskStatus.Pending,
|
|
2521
|
-
2: TaskStatus.Completed,
|
|
2522
|
-
};
|
|
2523
|
-
// Field mapping for time-related fields to ensure consistent naming
|
|
2524
|
-
const TaskMap = {
|
|
2525
|
-
completionTime: 'completedTime',
|
|
2526
|
-
deletionTime: 'deletedTime',
|
|
2527
|
-
lastModificationTime: 'lastModifiedTime',
|
|
2528
|
-
creationTime: 'createdTime',
|
|
2529
|
-
organizationUnitId: 'folderId'
|
|
2530
|
-
};
|
|
2531
|
-
/**
|
|
2532
|
-
* Default expand parameters
|
|
2533
|
-
*/
|
|
2534
|
-
const DEFAULT_TASK_EXPAND = 'AssignedToUser,CreatorUser,LastModifierUser';
|
|
2535
|
-
|
|
2536
2565
|
/**
|
|
2537
2566
|
* Service for interacting with UiPath Tasks API
|
|
2538
2567
|
*/
|
|
@@ -2727,29 +2756,38 @@ class TaskService extends BaseService {
|
|
|
2727
2756
|
}
|
|
2728
2757
|
/**
|
|
2729
2758
|
* Gets a task by ID
|
|
2730
|
-
* IMPORTANT: For form tasks, folderId must be provided.
|
|
2731
|
-
*
|
|
2732
2759
|
* @param id - The ID of the task to retrieve
|
|
2733
|
-
* @param options - Optional query parameters
|
|
2734
|
-
* @param folderId - Optional folder ID (REQUIRED
|
|
2735
|
-
* @returns Promise resolving to the task
|
|
2736
|
-
*
|
|
2760
|
+
* @param options - Optional query parameters including taskType for faster retrieval {@link TaskGetByIdOptions}
|
|
2761
|
+
* @param folderId - Optional folder ID (REQUIRED when options.taskType is provided)
|
|
2762
|
+
* @returns Promise resolving to the task
|
|
2763
|
+
* {@link TaskGetResponse}
|
|
2737
2764
|
* @example
|
|
2738
2765
|
* ```typescript
|
|
2739
|
-
*
|
|
2766
|
+
* // Get a task by ID
|
|
2767
|
+
* const task = await tasks.getById(<taskId>);
|
|
2740
2768
|
*
|
|
2741
|
-
*
|
|
2769
|
+
* // Get a form task by ID
|
|
2770
|
+
* const formTask = await tasks.getById(<taskId>, {}, <folderId>);
|
|
2742
2771
|
*
|
|
2743
|
-
* //
|
|
2744
|
-
*
|
|
2772
|
+
* // Access form task properties
|
|
2773
|
+
* console.log(formTask.formLayout);
|
|
2745
2774
|
*
|
|
2746
|
-
* //
|
|
2775
|
+
* // Get a document validation task by ID (faster with taskType provided in the options)
|
|
2776
|
+
* const dvTask = await tasks.getById(<taskId>, { taskType: TaskType.DocumentValidation }, <folderId>);
|
|
2747
2777
|
* ```
|
|
2748
2778
|
*/
|
|
2749
2779
|
async getById(id, options = {}, folderId) {
|
|
2780
|
+
const { taskType, ...restOptions } = options;
|
|
2781
|
+
// If taskType is provided, skip the generic GET_BY_ID call and go directly to the type-specific endpoint
|
|
2782
|
+
if (taskType && taskType in TASK_TYPE_ENDPOINTS) {
|
|
2783
|
+
if (!folderId) {
|
|
2784
|
+
throw new ValidationError({ message: 'folderId is required when taskType is provided' });
|
|
2785
|
+
}
|
|
2786
|
+
return this.getByTaskType(id, folderId, taskType, restOptions);
|
|
2787
|
+
}
|
|
2750
2788
|
const headers = createHeaders({ [FOLDER_ID]: folderId });
|
|
2751
2789
|
// Add default expand parameters
|
|
2752
|
-
const modifiedOptions = this.addDefaultExpand(
|
|
2790
|
+
const modifiedOptions = this.addDefaultExpand(restOptions);
|
|
2753
2791
|
// prefix all keys in options
|
|
2754
2792
|
const keysToPrefix = Object.keys(modifiedOptions);
|
|
2755
2793
|
const apiOptions = addPrefixToKeys(modifiedOptions, ODATA_PREFIX, keysToPrefix);
|
|
@@ -2759,10 +2797,10 @@ class TaskService extends BaseService {
|
|
|
2759
2797
|
});
|
|
2760
2798
|
// Transform response from PascalCase to camelCase and normalize time fields
|
|
2761
2799
|
const transformedTask = transformData(pascalToCamelCaseKeys(response.data), TaskMap);
|
|
2762
|
-
//
|
|
2763
|
-
|
|
2764
|
-
|
|
2765
|
-
return this.
|
|
2800
|
+
// Get task type from response and fetch type-specific data
|
|
2801
|
+
const resolvedFolderId = folderId || transformedTask.folderId;
|
|
2802
|
+
if (transformedTask.type in TASK_TYPE_ENDPOINTS) {
|
|
2803
|
+
return this.getByTaskType(id, resolvedFolderId, transformedTask.type, restOptions);
|
|
2766
2804
|
}
|
|
2767
2805
|
return createTaskWithMethods(applyDataTransforms(transformedTask, { field: 'status', valueMap: TaskStatusMap }), this);
|
|
2768
2806
|
}
|
|
@@ -2951,24 +2989,33 @@ class TaskService extends BaseService {
|
|
|
2951
2989
|
};
|
|
2952
2990
|
}
|
|
2953
2991
|
/**
|
|
2954
|
-
*
|
|
2992
|
+
* Routes to the type-specific endpoint based on task type.
|
|
2993
|
+
*/
|
|
2994
|
+
getByTaskType(id, folderId, taskType, options = {}) {
|
|
2995
|
+
const endpoint = TASK_TYPE_ENDPOINTS[taskType];
|
|
2996
|
+
const extraParams = taskType === TaskType.Form ? { expandOnFormLayout: true, ...options } : options;
|
|
2997
|
+
return this.getTaskByTypeEndpoint(id, folderId, endpoint, extraParams);
|
|
2998
|
+
}
|
|
2999
|
+
/**
|
|
3000
|
+
* Fetches a task from a type-specific endpoint.
|
|
2955
3001
|
*
|
|
2956
|
-
* @param id - The
|
|
3002
|
+
* @param id - The task ID
|
|
2957
3003
|
* @param folderId - Required folder ID
|
|
2958
|
-
* @param
|
|
2959
|
-
* @
|
|
3004
|
+
* @param endpoint - The type-specific endpoint to call
|
|
3005
|
+
* @param extraParams - Additional query parameters (e.g. form options)
|
|
3006
|
+
* @returns Promise resolving to the task
|
|
2960
3007
|
*/
|
|
2961
|
-
async
|
|
3008
|
+
async getTaskByTypeEndpoint(id, folderId, endpoint, extraParams = {}) {
|
|
2962
3009
|
const headers = createHeaders({ [FOLDER_ID]: folderId });
|
|
2963
|
-
const response = await this.get(
|
|
3010
|
+
const response = await this.get(endpoint, {
|
|
2964
3011
|
params: {
|
|
2965
3012
|
taskId: id,
|
|
2966
|
-
...
|
|
3013
|
+
...extraParams
|
|
2967
3014
|
},
|
|
2968
3015
|
headers
|
|
2969
3016
|
});
|
|
2970
|
-
const
|
|
2971
|
-
return createTaskWithMethods(applyDataTransforms(
|
|
3017
|
+
const transformedTask = transformData(response.data, TaskMap);
|
|
3018
|
+
return createTaskWithMethods(applyDataTransforms(transformedTask, { field: 'status', valueMap: TaskStatusMap }), this);
|
|
2972
3019
|
}
|
|
2973
3020
|
/**
|
|
2974
3021
|
* Adds default expand parameters to options
|
package/dist/cases/index.d.ts
CHANGED
|
@@ -422,10 +422,23 @@ interface UserLoginInfo {
|
|
|
422
422
|
displayName: string;
|
|
423
423
|
id: number;
|
|
424
424
|
}
|
|
425
|
+
/**
|
|
426
|
+
* Types of tasks available in Action Center.
|
|
427
|
+
* Each type determines the task's behavior, UI rendering, and completion requirements.
|
|
428
|
+
*/
|
|
425
429
|
declare enum TaskType {
|
|
430
|
+
/** A form-based task that renders a UiPath form layout for user input */
|
|
426
431
|
Form = "FormTask",
|
|
432
|
+
/** An externally managed task handled outside of Action Center */
|
|
427
433
|
External = "ExternalTask",
|
|
428
|
-
App
|
|
434
|
+
/** A task powered by a UiPath App */
|
|
435
|
+
App = "AppTask",
|
|
436
|
+
/** A document validation task for reviewing and correcting extracted document data */
|
|
437
|
+
DocumentValidation = "DocumentValidationTask",
|
|
438
|
+
/** A document classification task for categorizing documents */
|
|
439
|
+
DocumentClassification = "DocumentClassificationTask",
|
|
440
|
+
/** A data labeling task for annotating training data */
|
|
441
|
+
DataLabeling = "DataLabelingTask"
|
|
429
442
|
}
|
|
430
443
|
declare enum TaskPriority {
|
|
431
444
|
Low = "Low",
|
|
@@ -588,7 +601,23 @@ type TaskCompleteOptions = {
|
|
|
588
601
|
data?: any;
|
|
589
602
|
action?: string;
|
|
590
603
|
} | {
|
|
591
|
-
type:
|
|
604
|
+
type: TaskType.DocumentValidation;
|
|
605
|
+
data?: any;
|
|
606
|
+
action?: string;
|
|
607
|
+
} | {
|
|
608
|
+
type: TaskType.DocumentClassification;
|
|
609
|
+
data?: any;
|
|
610
|
+
action?: string;
|
|
611
|
+
} | {
|
|
612
|
+
type: TaskType.DataLabeling;
|
|
613
|
+
data?: any;
|
|
614
|
+
action?: string;
|
|
615
|
+
} | {
|
|
616
|
+
type: TaskType.Form;
|
|
617
|
+
data: any;
|
|
618
|
+
action: string;
|
|
619
|
+
} | {
|
|
620
|
+
type: TaskType.App;
|
|
592
621
|
data: any;
|
|
593
622
|
action: string;
|
|
594
623
|
};
|
package/dist/cases/index.mjs
CHANGED
|
@@ -1787,6 +1787,8 @@ const TASK_ENDPOINTS = {
|
|
|
1787
1787
|
COMPLETE_APP_TASK: `${ORCHESTRATOR_BASE}/tasks/AppTasks/CompleteAppTask`,
|
|
1788
1788
|
COMPLETE_GENERIC_TASK: `${ORCHESTRATOR_BASE}/tasks/GenericTasks/CompleteTask`,
|
|
1789
1789
|
GET_TASK_FORM_BY_ID: `${ORCHESTRATOR_BASE}/forms/TaskForms/GetTaskFormById`,
|
|
1790
|
+
GET_GENERIC_TASK_BY_ID: `${ORCHESTRATOR_BASE}/tasks/GenericTasks/GetTaskDataById`,
|
|
1791
|
+
GET_APP_TASK_BY_ID: `${ORCHESTRATOR_BASE}/tasks/AppTasks/GetAppTaskById`,
|
|
1790
1792
|
};
|
|
1791
1793
|
|
|
1792
1794
|
/**
|
|
@@ -1828,7 +1830,7 @@ const MAESTRO_ENDPOINTS = {
|
|
|
1828
1830
|
// Connection string placeholder that will be replaced during build
|
|
1829
1831
|
const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
|
|
1830
1832
|
// SDK Version placeholder
|
|
1831
|
-
const SDK_VERSION = "1.
|
|
1833
|
+
const SDK_VERSION = "1.3.0";
|
|
1832
1834
|
const VERSION = "Version";
|
|
1833
1835
|
const SERVICE = "Service";
|
|
1834
1836
|
const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
|
|
@@ -2394,11 +2396,24 @@ const CASE_INSTANCE_TASK_FILTER = (caseInstanceId) => `Tags/any(tags:tags/Displa
|
|
|
2394
2396
|
*/
|
|
2395
2397
|
const CASE_INSTANCE_TASK_EXPAND = 'AssignedToUser,Activities';
|
|
2396
2398
|
|
|
2399
|
+
/**
|
|
2400
|
+
* Types of tasks available in Action Center.
|
|
2401
|
+
* Each type determines the task's behavior, UI rendering, and completion requirements.
|
|
2402
|
+
*/
|
|
2397
2403
|
var TaskType;
|
|
2398
2404
|
(function (TaskType) {
|
|
2405
|
+
/** A form-based task that renders a UiPath form layout for user input */
|
|
2399
2406
|
TaskType["Form"] = "FormTask";
|
|
2407
|
+
/** An externally managed task handled outside of Action Center */
|
|
2400
2408
|
TaskType["External"] = "ExternalTask";
|
|
2409
|
+
/** A task powered by a UiPath App */
|
|
2401
2410
|
TaskType["App"] = "AppTask";
|
|
2411
|
+
/** A document validation task for reviewing and correcting extracted document data */
|
|
2412
|
+
TaskType["DocumentValidation"] = "DocumentValidationTask";
|
|
2413
|
+
/** A document classification task for categorizing documents */
|
|
2414
|
+
TaskType["DocumentClassification"] = "DocumentClassificationTask";
|
|
2415
|
+
/** A data labeling task for annotating training data */
|
|
2416
|
+
TaskType["DataLabeling"] = "DataLabelingTask";
|
|
2402
2417
|
})(TaskType || (TaskType = {}));
|
|
2403
2418
|
var TaskPriority;
|
|
2404
2419
|
(function (TaskPriority) {
|
|
@@ -2452,6 +2467,42 @@ var TaskActivityType;
|
|
|
2452
2467
|
TaskActivityType["FirstOpened"] = "FirstOpened";
|
|
2453
2468
|
})(TaskActivityType || (TaskActivityType = {}));
|
|
2454
2469
|
|
|
2470
|
+
/**
|
|
2471
|
+
* Maps numeric TaskStatus values (from API) to TaskStatus enum values.
|
|
2472
|
+
* Extend this file with additional field mappings as needed.
|
|
2473
|
+
*/
|
|
2474
|
+
const TaskStatusMap = {
|
|
2475
|
+
0: TaskStatus.Unassigned,
|
|
2476
|
+
1: TaskStatus.Pending,
|
|
2477
|
+
2: TaskStatus.Completed,
|
|
2478
|
+
};
|
|
2479
|
+
// Field mapping for time-related fields to ensure consistent naming
|
|
2480
|
+
const TaskMap = {
|
|
2481
|
+
completionTime: 'completedTime',
|
|
2482
|
+
deletionTime: 'deletedTime',
|
|
2483
|
+
lastModificationTime: 'lastModifiedTime',
|
|
2484
|
+
creationTime: 'createdTime',
|
|
2485
|
+
organizationUnitId: 'folderId'
|
|
2486
|
+
};
|
|
2487
|
+
/**
|
|
2488
|
+
* Default expand parameters
|
|
2489
|
+
*/
|
|
2490
|
+
const DEFAULT_TASK_EXPAND = 'AssignedToUser,CreatorUser,LastModifierUser';
|
|
2491
|
+
|
|
2492
|
+
const TASK_TYPE_ENDPOINTS = {
|
|
2493
|
+
[TaskType.Form]: TASK_ENDPOINTS.GET_TASK_FORM_BY_ID,
|
|
2494
|
+
[TaskType.App]: TASK_ENDPOINTS.GET_APP_TASK_BY_ID,
|
|
2495
|
+
[TaskType.DocumentValidation]: TASK_ENDPOINTS.GET_GENERIC_TASK_BY_ID,
|
|
2496
|
+
[TaskType.DocumentClassification]: TASK_ENDPOINTS.GET_GENERIC_TASK_BY_ID,
|
|
2497
|
+
[TaskType.External]: TASK_ENDPOINTS.GET_GENERIC_TASK_BY_ID,
|
|
2498
|
+
[TaskType.DataLabeling]: TASK_ENDPOINTS.GET_GENERIC_TASK_BY_ID,
|
|
2499
|
+
};
|
|
2500
|
+
var ActionCenterEventNames;
|
|
2501
|
+
(function (ActionCenterEventNames) {
|
|
2502
|
+
ActionCenterEventNames["TOKENREFRESHED"] = "AC.tokenRefreshed";
|
|
2503
|
+
ActionCenterEventNames["REFRESHTOKEN"] = "AC.refreshToken";
|
|
2504
|
+
})(ActionCenterEventNames || (ActionCenterEventNames = {}));
|
|
2505
|
+
|
|
2455
2506
|
/**
|
|
2456
2507
|
* Creates methods for a task
|
|
2457
2508
|
*
|
|
@@ -2509,28 +2560,6 @@ function createTaskWithMethods(taskData, service) {
|
|
|
2509
2560
|
return Object.assign({}, taskData, methods);
|
|
2510
2561
|
}
|
|
2511
2562
|
|
|
2512
|
-
/**
|
|
2513
|
-
* Maps numeric TaskStatus values (from API) to TaskStatus enum values.
|
|
2514
|
-
* Extend this file with additional field mappings as needed.
|
|
2515
|
-
*/
|
|
2516
|
-
const TaskStatusMap = {
|
|
2517
|
-
0: TaskStatus.Unassigned,
|
|
2518
|
-
1: TaskStatus.Pending,
|
|
2519
|
-
2: TaskStatus.Completed,
|
|
2520
|
-
};
|
|
2521
|
-
// Field mapping for time-related fields to ensure consistent naming
|
|
2522
|
-
const TaskMap = {
|
|
2523
|
-
completionTime: 'completedTime',
|
|
2524
|
-
deletionTime: 'deletedTime',
|
|
2525
|
-
lastModificationTime: 'lastModifiedTime',
|
|
2526
|
-
creationTime: 'createdTime',
|
|
2527
|
-
organizationUnitId: 'folderId'
|
|
2528
|
-
};
|
|
2529
|
-
/**
|
|
2530
|
-
* Default expand parameters
|
|
2531
|
-
*/
|
|
2532
|
-
const DEFAULT_TASK_EXPAND = 'AssignedToUser,CreatorUser,LastModifierUser';
|
|
2533
|
-
|
|
2534
2563
|
/**
|
|
2535
2564
|
* Service for interacting with UiPath Tasks API
|
|
2536
2565
|
*/
|
|
@@ -2725,29 +2754,38 @@ class TaskService extends BaseService {
|
|
|
2725
2754
|
}
|
|
2726
2755
|
/**
|
|
2727
2756
|
* Gets a task by ID
|
|
2728
|
-
* IMPORTANT: For form tasks, folderId must be provided.
|
|
2729
|
-
*
|
|
2730
2757
|
* @param id - The ID of the task to retrieve
|
|
2731
|
-
* @param options - Optional query parameters
|
|
2732
|
-
* @param folderId - Optional folder ID (REQUIRED
|
|
2733
|
-
* @returns Promise resolving to the task
|
|
2734
|
-
*
|
|
2758
|
+
* @param options - Optional query parameters including taskType for faster retrieval {@link TaskGetByIdOptions}
|
|
2759
|
+
* @param folderId - Optional folder ID (REQUIRED when options.taskType is provided)
|
|
2760
|
+
* @returns Promise resolving to the task
|
|
2761
|
+
* {@link TaskGetResponse}
|
|
2735
2762
|
* @example
|
|
2736
2763
|
* ```typescript
|
|
2737
|
-
*
|
|
2764
|
+
* // Get a task by ID
|
|
2765
|
+
* const task = await tasks.getById(<taskId>);
|
|
2738
2766
|
*
|
|
2739
|
-
*
|
|
2767
|
+
* // Get a form task by ID
|
|
2768
|
+
* const formTask = await tasks.getById(<taskId>, {}, <folderId>);
|
|
2740
2769
|
*
|
|
2741
|
-
* //
|
|
2742
|
-
*
|
|
2770
|
+
* // Access form task properties
|
|
2771
|
+
* console.log(formTask.formLayout);
|
|
2743
2772
|
*
|
|
2744
|
-
* //
|
|
2773
|
+
* // Get a document validation task by ID (faster with taskType provided in the options)
|
|
2774
|
+
* const dvTask = await tasks.getById(<taskId>, { taskType: TaskType.DocumentValidation }, <folderId>);
|
|
2745
2775
|
* ```
|
|
2746
2776
|
*/
|
|
2747
2777
|
async getById(id, options = {}, folderId) {
|
|
2778
|
+
const { taskType, ...restOptions } = options;
|
|
2779
|
+
// If taskType is provided, skip the generic GET_BY_ID call and go directly to the type-specific endpoint
|
|
2780
|
+
if (taskType && taskType in TASK_TYPE_ENDPOINTS) {
|
|
2781
|
+
if (!folderId) {
|
|
2782
|
+
throw new ValidationError({ message: 'folderId is required when taskType is provided' });
|
|
2783
|
+
}
|
|
2784
|
+
return this.getByTaskType(id, folderId, taskType, restOptions);
|
|
2785
|
+
}
|
|
2748
2786
|
const headers = createHeaders({ [FOLDER_ID]: folderId });
|
|
2749
2787
|
// Add default expand parameters
|
|
2750
|
-
const modifiedOptions = this.addDefaultExpand(
|
|
2788
|
+
const modifiedOptions = this.addDefaultExpand(restOptions);
|
|
2751
2789
|
// prefix all keys in options
|
|
2752
2790
|
const keysToPrefix = Object.keys(modifiedOptions);
|
|
2753
2791
|
const apiOptions = addPrefixToKeys(modifiedOptions, ODATA_PREFIX, keysToPrefix);
|
|
@@ -2757,10 +2795,10 @@ class TaskService extends BaseService {
|
|
|
2757
2795
|
});
|
|
2758
2796
|
// Transform response from PascalCase to camelCase and normalize time fields
|
|
2759
2797
|
const transformedTask = transformData(pascalToCamelCaseKeys(response.data), TaskMap);
|
|
2760
|
-
//
|
|
2761
|
-
|
|
2762
|
-
|
|
2763
|
-
return this.
|
|
2798
|
+
// Get task type from response and fetch type-specific data
|
|
2799
|
+
const resolvedFolderId = folderId || transformedTask.folderId;
|
|
2800
|
+
if (transformedTask.type in TASK_TYPE_ENDPOINTS) {
|
|
2801
|
+
return this.getByTaskType(id, resolvedFolderId, transformedTask.type, restOptions);
|
|
2764
2802
|
}
|
|
2765
2803
|
return createTaskWithMethods(applyDataTransforms(transformedTask, { field: 'status', valueMap: TaskStatusMap }), this);
|
|
2766
2804
|
}
|
|
@@ -2949,24 +2987,33 @@ class TaskService extends BaseService {
|
|
|
2949
2987
|
};
|
|
2950
2988
|
}
|
|
2951
2989
|
/**
|
|
2952
|
-
*
|
|
2990
|
+
* Routes to the type-specific endpoint based on task type.
|
|
2991
|
+
*/
|
|
2992
|
+
getByTaskType(id, folderId, taskType, options = {}) {
|
|
2993
|
+
const endpoint = TASK_TYPE_ENDPOINTS[taskType];
|
|
2994
|
+
const extraParams = taskType === TaskType.Form ? { expandOnFormLayout: true, ...options } : options;
|
|
2995
|
+
return this.getTaskByTypeEndpoint(id, folderId, endpoint, extraParams);
|
|
2996
|
+
}
|
|
2997
|
+
/**
|
|
2998
|
+
* Fetches a task from a type-specific endpoint.
|
|
2953
2999
|
*
|
|
2954
|
-
* @param id - The
|
|
3000
|
+
* @param id - The task ID
|
|
2955
3001
|
* @param folderId - Required folder ID
|
|
2956
|
-
* @param
|
|
2957
|
-
* @
|
|
3002
|
+
* @param endpoint - The type-specific endpoint to call
|
|
3003
|
+
* @param extraParams - Additional query parameters (e.g. form options)
|
|
3004
|
+
* @returns Promise resolving to the task
|
|
2958
3005
|
*/
|
|
2959
|
-
async
|
|
3006
|
+
async getTaskByTypeEndpoint(id, folderId, endpoint, extraParams = {}) {
|
|
2960
3007
|
const headers = createHeaders({ [FOLDER_ID]: folderId });
|
|
2961
|
-
const response = await this.get(
|
|
3008
|
+
const response = await this.get(endpoint, {
|
|
2962
3009
|
params: {
|
|
2963
3010
|
taskId: id,
|
|
2964
|
-
...
|
|
3011
|
+
...extraParams
|
|
2965
3012
|
},
|
|
2966
3013
|
headers
|
|
2967
3014
|
});
|
|
2968
|
-
const
|
|
2969
|
-
return createTaskWithMethods(applyDataTransforms(
|
|
3015
|
+
const transformedTask = transformData(response.data, TaskMap);
|
|
3016
|
+
return createTaskWithMethods(applyDataTransforms(transformedTask, { field: 'status', valueMap: TaskStatusMap }), this);
|
|
2970
3017
|
}
|
|
2971
3018
|
/**
|
|
2972
3019
|
* Adds default expand parameters to options
|
|
@@ -51,7 +51,7 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
|
|
|
51
51
|
// Connection string placeholder that will be replaced during build
|
|
52
52
|
const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
|
|
53
53
|
// SDK Version placeholder
|
|
54
|
-
const SDK_VERSION = "1.
|
|
54
|
+
const SDK_VERSION = "1.3.0";
|
|
55
55
|
const VERSION = "Version";
|
|
56
56
|
const SERVICE = "Service";
|
|
57
57
|
const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
|
|
@@ -4085,11 +4085,14 @@ interface ConversationSessionOptions {
|
|
|
4085
4085
|
logLevel?: LogLevel;
|
|
4086
4086
|
}
|
|
4087
4087
|
/** Response for creating a conversation (includes methods) */
|
|
4088
|
-
|
|
4088
|
+
interface ConversationCreateResponse extends ConversationGetResponse {
|
|
4089
|
+
}
|
|
4089
4090
|
/** Response for updating a conversation (includes methods) */
|
|
4090
|
-
|
|
4091
|
+
interface ConversationUpdateResponse extends ConversationGetResponse {
|
|
4092
|
+
}
|
|
4091
4093
|
/** Response for deleting a conversation (raw data, no methods needed) */
|
|
4092
|
-
|
|
4094
|
+
interface ConversationDeleteResponse extends RawConversationGetResponse {
|
|
4095
|
+
}
|
|
4093
4096
|
interface ConversationCreateOptions {
|
|
4094
4097
|
/** Human-readable label for the conversation (max 100 chars) */
|
|
4095
4098
|
label?: string;
|
|
@@ -4284,7 +4287,8 @@ interface RawAgentGetByIdResponse extends RawAgentGetResponse {
|
|
|
4284
4287
|
/**
|
|
4285
4288
|
* Options for creating a conversation from an agent
|
|
4286
4289
|
*/
|
|
4287
|
-
|
|
4290
|
+
interface AgentCreateConversationOptions extends ConversationCreateOptions {
|
|
4291
|
+
}
|
|
4288
4292
|
/**
|
|
4289
4293
|
* Scoped conversation service for a specific agent.
|
|
4290
4294
|
* Auto-fills agentId and folderId from the agent.
|
|
@@ -4376,7 +4380,8 @@ interface UserSettingsGetResponse {
|
|
|
4376
4380
|
updatedTime: string;
|
|
4377
4381
|
}
|
|
4378
4382
|
/** Response for updating user settings */
|
|
4379
|
-
|
|
4383
|
+
interface UserSettingsUpdateResponse extends UserSettingsGetResponse {
|
|
4384
|
+
}
|
|
4380
4385
|
/**
|
|
4381
4386
|
* Options for updating user settings
|
|
4382
4387
|
*
|
|
@@ -49,7 +49,7 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
|
|
|
49
49
|
// Connection string placeholder that will be replaced during build
|
|
50
50
|
const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
|
|
51
51
|
// SDK Version placeholder
|
|
52
|
-
const SDK_VERSION = "1.
|
|
52
|
+
const SDK_VERSION = "1.3.0";
|
|
53
53
|
const VERSION = "Version";
|
|
54
54
|
const SERVICE = "Service";
|
|
55
55
|
const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
|