@uipath/uipath-typescript 1.3.11 → 1.4.1

package/dist/tasks/index.cjs

@@ -386,6 +386,24 @@ exports.TaskActivityType = void 0;
     TaskActivityType["BulkCompleted"] = "BulkCompleted";
     TaskActivityType["FirstOpened"] = "FirstOpened";
 })(exports.TaskActivityType || (exports.TaskActivityType = {}));
+/**
+ * Defines how a task assignment is distributed.
+ *
+ * Defaults to {@link TaskAssignmentCriteria.SingleUser} (a direct single-user
+ * assignment) when not specified. The group-based criteria tell Action Center
+ * how to distribute the task across the members of a directory group.
+ */
+exports.TaskAssignmentCriteria = void 0;
+(function (TaskAssignmentCriteria) {
+    /** Assigned to a single user, like a direct assignment. */
+    TaskAssignmentCriteria["SingleUser"] = "SingleUser";
+    /** Assigned to the group member with the fewest pending tasks. */
+    TaskAssignmentCriteria["Workload"] = "Workload";
+    /** Assigned to all users in the group. */
+    TaskAssignmentCriteria["AllUsers"] = "AllUsers";
+    /** Assigned in a round-robin manner across the group's members. */
+    TaskAssignmentCriteria["RoundRobin"] = "RoundRobin";
+})(exports.TaskAssignmentCriteria || (exports.TaskAssignmentCriteria = {}));
 
 /**
  * Maps numeric TaskStatus values (from API) to TaskStatus enum values.
@@ -463,17 +481,19 @@ function createTaskMethods(taskData, service) {
         async assign(options) {
             if (!taskData.id)
                 throw new Error('Task ID is undefined');
+            const criteria = options.assignmentCriteria !== undefined ? { assignmentCriteria: options.assignmentCriteria } : {};
             const assignmentOptions = 'userId' in options && options.userId !== undefined
-                ? { taskId: taskData.id, userId: options.userId }
-                : { taskId: taskData.id, userNameOrEmail: options.userNameOrEmail };
+                ? { taskId: taskData.id, userId: options.userId, ...criteria }
+                : { taskId: taskData.id, userNameOrEmail: options.userNameOrEmail, ...criteria };
             return service.assign(assignmentOptions);
         },
         async reassign(options) {
             if (!taskData.id)
                 throw new Error('Task ID is undefined');
+            const criteria = options.assignmentCriteria !== undefined ? { assignmentCriteria: options.assignmentCriteria } : {};
             const assignmentOptions = 'userId' in options && options.userId !== undefined
-                ? { taskId: taskData.id, userId: options.userId }
-                : { taskId: taskData.id, userNameOrEmail: options.userNameOrEmail };
+                ? { taskId: taskData.id, userId: options.userId, ...criteria }
+                : { taskId: taskData.id, userNameOrEmail: options.userNameOrEmail, ...criteria };
             return service.reassign(assignmentOptions);
         },
         async unassign() {
@@ -979,6 +999,32 @@ function getLimitedPageSize(pageSize) {
  */
 const isBrowser = typeof window !== 'undefined' && typeof window.document !== 'undefined';
 isBrowser && window.self != window.top && window.location.href.includes('source=ActionCenter');
+const _params = isBrowser ? new URLSearchParams(window.location.search) : null;
+/**
+ * True when the coded app has been loaded inside a host frame that explicitly
+ * opted into token delegation by adding `?host=embed` to the iframe src URL.
+ */
+const isHostEmbedded = isBrowser && window.self !== window.top && _params?.get('host') === 'embed';
+/**
+ * The validated parent origin, read from the `?basedomain=` query param set
+ * by the embedding host in the iframe src URL.
+ * Mirrors the same mechanism used by ActionCenterTokenManager.
+ * Non-null only when `?host=embed` is present and `?basedomain=` is a valid URL.
+ */
+(() => {
+    if (!isHostEmbedded)
+        return null;
+    const basedomain = _params?.get('basedomain');
+    if (!basedomain)
+        return null;
+    try {
+        return new URL(basedomain).origin;
+    }
+    catch {
+        console.warn('embeddingOrigin: basedomain query param is not a valid URL', basedomain);
+        return null;
+    }
+})();
 
 /**
  * Base64 encoding/decoding
@@ -1159,12 +1205,18 @@ class PaginationHelpers {
      * @returns Promise resolving to a paginated result
      */
     static async getAllPaginated(params) {
-        const { serviceAccess, getEndpoint, folderId, headers: providedHeaders, paginationParams, additionalParams, transformFn, method = HTTP_METHODS.GET, options = {} } = params;
+        const { serviceAccess, getEndpoint, folderId, headers: providedHeaders, paginationParams, additionalParams, queryParams, transformFn, method = HTTP_METHODS.GET, options = {} } = params;
         const endpoint = getEndpoint(folderId);
         const headers = providedHeaders ?? (folderId ? createHeaders({ [FOLDER_ID]: folderId }) : {});
+        // On POST, the caller's options go in the body; queryParams stays in the URL.
+        // On GET, everything is URL — queryParams merges with additionalParams.
+        const isPost = method === HTTP_METHODS.POST;
+        const requestSpec = isPost
+            ? { body: additionalParams, params: queryParams }
+            : { params: { ...additionalParams, ...queryParams } };
         const paginatedResponse = await serviceAccess.requestWithPagination(method, endpoint, paginationParams, {
             headers,
-            params: additionalParams,
+            ...requestSpec,
             pagination: {
                 paginationType: options.paginationType || PaginationType.OFFSET,
                 itemsField: options.itemsField || DEFAULT_ITEMS_FIELD,
@@ -1189,7 +1241,7 @@ class PaginationHelpers {
      * @returns Promise resolving to an object with data and totalCount
      */
     static async getAllNonPaginated(params) {
-        const { serviceAccess, getAllEndpoint, getByFolderEndpoint, folderId, headers: providedHeaders, additionalParams, transformFn, method = HTTP_METHODS.GET, options = {} } = params;
+        const { serviceAccess, getAllEndpoint, getByFolderEndpoint, folderId, headers: providedHeaders, additionalParams, queryParams, transformFn, method = HTTP_METHODS.GET, options = {} } = params;
         // Set default field names
         const itemsField = options.itemsField || DEFAULT_ITEMS_FIELD;
         const totalCountField = options.totalCountField || DEFAULT_TOTAL_COUNT_FIELD;
@@ -1199,17 +1251,18 @@ class PaginationHelpers {
         // Make the API call based on method
         let response;
         if (method === HTTP_METHODS.POST) {
-            response = await serviceAccess.post(endpoint, additionalParams, { headers });
+            response = await serviceAccess.post(endpoint, additionalParams, { headers, params: queryParams });
         }
         else {
             response = await serviceAccess.get(endpoint, {
-                params: additionalParams,
+                params: { ...additionalParams, ...queryParams },
                 headers
             });
         }
         // Extract and transform items from response
-        // Handle both plain array responses and envelope responses ({ value: [...], totalRecordCount: N })
-        const rawItems = Array.isArray(response.data) ? response.data : response.data?.[itemsField];
+        // Handle both plain array responses and envelope responses ({ value: [...], totalRecordCount: N }).
+        // itemsField may be a dotted path (e.g. 'data.agents') for nested envelopes.
+        const rawItems = Array.isArray(response.data) ? response.data : resolveNestedField(response.data, itemsField);
         const rawTotalCount = Array.isArray(response.data) ? undefined : resolveNestedField(response.data, totalCountField);
         const totalCount = typeof rawTotalCount === 'number' ? rawTotalCount : undefined;
         // Parse items - automatically handle JSON string responses
@@ -1255,8 +1308,9 @@ class PaginationHelpers {
                 getEndpoint: config.getEndpoint,
                 folderId,
                 headers: config.headers,
-                paginationParams: cursor ? { cursor, pageSize } : jumpToPage ? { jumpToPage, pageSize } : { pageSize },
+                paginationParams: cursor ? { cursor, pageSize } : jumpToPage !== undefined ? { jumpToPage, pageSize } : { pageSize },
                 additionalParams: prefixedOptions,
+                queryParams: config.queryParams,
                 transformFn: config.transformFn,
                 method: config.method,
                 options: {
@@ -1274,6 +1328,7 @@ class PaginationHelpers {
             folderId,
             headers: config.headers,
             additionalParams: prefixedOptions,
+            queryParams: config.queryParams,
             transformFn: config.transformFn,
             method: config.method,
             options: {
@@ -1896,18 +1951,17 @@ class BaseService {
         const params = this.validateAndPreparePaginationParams(paginationType, paginationOptions);
         // Prepare request parameters based on pagination type
         const requestParams = this.preparePaginationRequestParams(paginationType, params, options.pagination);
-        // For POST requests, merge pagination params into body and set params to undefined; for GET, use query params
+        // Route pagination state to wherever the API expects it (body for POST, URL for GET).
+        // Caller-supplied options.body / options.params are respected as-is — the api-client
+        // already handles params (URL) and body (request body) independently for every method.
         if (method.toUpperCase() === 'POST') {
             const existingBody = (options.body && typeof options.body === 'object') ? options.body : {};
             options.body = {
                 ...existingBody,
-                ...options.params,
                 ...requestParams
             };
-            options.params = undefined;
         }
         else {
-            // Merge pagination parameters with existing parameters
             options.params = {
                 ...options.params,
                 ...requestParams
@@ -1944,6 +1998,8 @@ class BaseService {
                 // When true (default), converts pageNumber to a skip/offset value (e.g., page 3 with pageSize 10 → skip 20).
                 // When false, passes pageNumber directly as the offset param — used by APIs that accept a page number instead of a record offset.
                 const convertToSkip = paginationParams?.convertToSkip ?? true;
+                // When true, sends pageNumber - 1 (for 0-based APIs). Default false (1-based).
+                const zeroBased = paginationParams?.zeroBased ?? false;
                 requestParams[pageSizeParam] = limitedPageSize;
                 if (convertToSkip) {
                     if (params.pageNumber && params.pageNumber > 1) {
@@ -1951,7 +2007,8 @@ class BaseService {
                     }
                 }
                 else {
-                    requestParams[offsetParam] = params.pageNumber || 1;
+                    const sdkPageNumber = params.pageNumber || 1;
+                    requestParams[offsetParam] = zeroBased ? sdkPageNumber - 1 : sdkPageNumber;
                 }
                 {
                     requestParams[countParam] = true;
@@ -1980,8 +2037,9 @@ class BaseService {
         const totalCountField = fields.totalCountField || 'totalRecordCount';
         const continuationTokenField = fields.continuationTokenField || 'continuationToken';
         // Extract items and metadata
-        // Handle both plain array responses and envelope responses ({ value: [...], totalRecordCount: N })
-        const items = Array.isArray(response.data) ? response.data : (response.data[itemsField] || []);
+        // Handle both plain array responses and envelope responses ({ value: [...], totalRecordCount: N }).
+        // itemsField may be a dotted path (e.g. 'data.agents') for nested envelopes.
+        const items = Array.isArray(response.data) ? response.data : (resolveNestedField(response.data, itemsField) || []);
         const rawTotalCount = Array.isArray(response.data) ? undefined : resolveNestedField(response.data, totalCountField);
         const totalCount = typeof rawTotalCount === 'number' ? rawTotalCount : undefined;
         const continuationToken = response.data[continuationTokenField];
@@ -2306,6 +2364,26 @@ class TaskService extends BaseService {
      *   }
      * ]);
      * ```
+     *
+     * @example Group assignment
+     * ```typescript
+     * import { TaskAssignmentCriteria } from '@uipath/uipath-typescript/tasks';
+     *
+     * // Assign to a directory group by userId + criteria — Action Center
+     * // distributes the task across the group's members based on the criteria
+     * const result = await tasks.assign({
+     *   taskId: 123,
+     *   userId: 456, // a DirectoryGroup id from tasks.getUsers()
+     *   assignmentCriteria: TaskAssignmentCriteria.AllUsers
+     * });
+     *
+     * // ...or identify the group by name instead of id
+     * const result2 = await tasks.assign({
+     *   taskId: 123,
+     *   userNameOrEmail: "My Group",
+     *   assignmentCriteria: TaskAssignmentCriteria.AllUsers
+     * });
+     * ```
      */
     async assign(taskAssignments) {
         // Normalize input to array
@@ -2357,6 +2435,25 @@ class TaskService extends BaseService {
      *   }
      * ]);
      * ```
+     *
+     * @example Group reassignment
+     * ```typescript
+     * import { TaskAssignmentCriteria } from '@uipath/uipath-typescript/tasks';
+     *
+     * // Reassign to a directory group by userId + criteria
+     * const result = await tasks.reassign({
+     *   taskId: 123,
+     *   userId: 456, // a DirectoryGroup id from tasks.getUsers()
+     *   assignmentCriteria: TaskAssignmentCriteria.AllUsers
+     * });
+     *
+     * // ...or identify the group by name instead of id
+     * const result2 = await tasks.reassign({
+     *   taskId: 123,
+     *   userNameOrEmail: "My Group",
+     *   assignmentCriteria: TaskAssignmentCriteria.AllUsers
+     * });
+     * ```
      */
     async reassign(taskAssignments) {
         // Normalize input to array

package/dist/tasks/index.d.ts

@@ -285,22 +285,49 @@ interface RawTaskGetResponse extends TaskBaseResponse {
     actionLabel?: string | null;
     taskSlaDetails?: TaskSlaDetail[] | null;
     completedByUser?: UserLoginInfo | null;
-    taskAssignmentCriteria?: string;
+    taskAssignmentCriteria?: TaskAssignmentCriteria;
     taskAssignees?: UserLoginInfo[] | null;
     taskSource?: TaskSource | null;
     processingTime?: number | null;
     data?: Record<string, unknown> | null;
 }
+/**
+ * Defines how a task assignment is distributed.
+ *
+ * Defaults to {@link TaskAssignmentCriteria.SingleUser} (a direct single-user
+ * assignment) when not specified. The group-based criteria tell Action Center
+ * how to distribute the task across the members of a directory group.
+ */
+declare enum TaskAssignmentCriteria {
+    /** Assigned to a single user, like a direct assignment. */
+    SingleUser = "SingleUser",
+    /** Assigned to the group member with the fewest pending tasks. */
+    Workload = "Workload",
+    /** Assigned to all users in the group. */
+    AllUsers = "AllUsers",
+    /** Assigned in a round-robin manner across the group's members. */
+    RoundRobin = "RoundRobin"
+}
 /**
  * Options for task assignment operations when called from a task instance
- * Requires either userId or userNameOrEmail, but not both
+ * Requires either userId or userNameOrEmail, but not both. Optionally accepts
+ * an assignment criteria; defaults to a single-user assignment, set a group
+ * criteria (e.g. {@link TaskAssignmentCriteria.AllUsers}) for a directory group.
  */
-type TaskAssignOptions = {
+type TaskAssignOptions = ({
     userId: number;
     userNameOrEmail?: never;
 } | {
     userId?: never;
     userNameOrEmail: string;
+}) & {
+    /**
+     * How the assignment is distributed. Optional — defaults to
+     * {@link TaskAssignmentCriteria.SingleUser} (a direct single-user assignment).
+     * Set a group criteria (e.g. {@link TaskAssignmentCriteria.AllUsers}) to
+     * distribute the task across a directory group's members.
+     */
+    assignmentCriteria?: TaskAssignmentCriteria;
 };
 /**
  * Options for task assignment operations when called from the service
@@ -520,6 +547,26 @@ interface TaskServiceModel {
      *   { taskId: <taskId2>, userNameOrEmail: "user@example.com" }
      * ]);
      * ```
+     *
+     * @example Group assignment
+     * ```typescript
+     * import { TaskAssignmentCriteria } from '@uipath/uipath-typescript/tasks';
+     *
+     * // Assign to a directory group by userId + criteria — Action Center
+     * // distributes the task across the group's members based on the criteria
+     * const result = await tasks.assign({
+     *   taskId: <taskId>,
+     *   userId: <groupId>, // a DirectoryGroup id from tasks.getUsers()
+     *   assignmentCriteria: TaskAssignmentCriteria.AllUsers
+     * });
+     *
+     * // ...or identify the group by name instead of id
+     * const result2 = await tasks.assign({
+     *   taskId: <taskId>,
+     *   userNameOrEmail: "<groupName>",
+     *   assignmentCriteria: TaskAssignmentCriteria.AllUsers
+     * });
+     * ```
      */
     assign(options: TaskAssignmentOptions | TaskAssignmentOptions[]): Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>;
     /**
@@ -554,6 +601,25 @@ interface TaskServiceModel {
      *   { taskId: <taskId2>, userNameOrEmail: "user@example.com" }
      * ]);
      * ```
+     *
+     * @example Group reassignment
+     * ```typescript
+     * import { TaskAssignmentCriteria } from '@uipath/uipath-typescript/tasks';
+     *
+     * // Reassign to a directory group by userId + criteria
+     * const result = await tasks.reassign({
+     *   taskId: <taskId>,
+     *   userId: <groupId>, // a DirectoryGroup id from tasks.getUsers()
+     *   assignmentCriteria: TaskAssignmentCriteria.AllUsers
+     * });
+     *
+     * // ...or identify the group by name instead of id
+     * const result2 = await tasks.reassign({
+     *   taskId: <taskId>,
+     *   userNameOrEmail: "<groupName>",
+     *   assignmentCriteria: TaskAssignmentCriteria.AllUsers
+     * });
+     * ```
      */
     reassign(options: TaskAssignmentOptions | TaskAssignmentOptions[]): Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>;
     /**
@@ -705,6 +771,7 @@ interface RequestWithPaginationOptions extends RequestSpec {
             tokenParam?: string;
             countParam?: string;
             convertToSkip?: boolean;
+            zeroBased?: boolean;
         };
     };
 }
@@ -1065,6 +1132,26 @@ declare class TaskService extends BaseService implements TaskServiceModel {
      *   }
      * ]);
      * ```
+     *
+     * @example Group assignment
+     * ```typescript
+     * import { TaskAssignmentCriteria } from '@uipath/uipath-typescript/tasks';
+     *
+     * // Assign to a directory group by userId + criteria — Action Center
+     * // distributes the task across the group's members based on the criteria
+     * const result = await tasks.assign({
+     *   taskId: 123,
+     *   userId: 456, // a DirectoryGroup id from tasks.getUsers()
+     *   assignmentCriteria: TaskAssignmentCriteria.AllUsers
+     * });
+     *
+     * // ...or identify the group by name instead of id
+     * const result2 = await tasks.assign({
+     *   taskId: 123,
+     *   userNameOrEmail: "My Group",
+     *   assignmentCriteria: TaskAssignmentCriteria.AllUsers
+     * });
+     * ```
      */
     assign(taskAssignments: TaskAssignmentOptions | TaskAssignmentOptions[]): Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>;
     /**
@@ -1103,6 +1190,25 @@ declare class TaskService extends BaseService implements TaskServiceModel {
      *   }
      * ]);
      * ```
+     *
+     * @example Group reassignment
+     * ```typescript
+     * import { TaskAssignmentCriteria } from '@uipath/uipath-typescript/tasks';
+     *
+     * // Reassign to a directory group by userId + criteria
+     * const result = await tasks.reassign({
+     *   taskId: 123,
+     *   userId: 456, // a DirectoryGroup id from tasks.getUsers()
+     *   assignmentCriteria: TaskAssignmentCriteria.AllUsers
+     * });
+     *
+     * // ...or identify the group by name instead of id
+     * const result2 = await tasks.reassign({
+     *   taskId: 123,
+     *   userNameOrEmail: "My Group",
+     *   assignmentCriteria: TaskAssignmentCriteria.AllUsers
+     * });
+     * ```
      */
     reassign(taskAssignments: TaskAssignmentOptions | TaskAssignmentOptions[]): Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>;
     /**
@@ -1187,5 +1293,5 @@ declare class TaskService extends BaseService implements TaskServiceModel {
     private addDefaultExpand;
 }
 
-export { TaskActivityType, TaskPriority, TaskService, TaskSlaCriteria, TaskSlaStatus, TaskSourceName, TaskStatus, TaskType, TaskUserType, TaskService as Tasks, createTaskWithMethods };
+export { TaskActivityType, TaskAssignmentCriteria, TaskPriority, TaskService, TaskSlaCriteria, TaskSlaStatus, TaskSourceName, TaskStatus, TaskType, TaskUserType, TaskService as Tasks, createTaskWithMethods };
 export type { RawTaskCreateResponse, RawTaskGetResponse, Tag, TaskActivity, TaskAssignOptions, TaskAssignment, TaskAssignmentOptions, TaskAssignmentResponse, TaskBaseResponse, TaskCompleteOptions, TaskCompletionOptions, TaskCreateOptions, TaskCreateResponse, TaskGetAllOptions, TaskGetByIdOptions, TaskGetResponse, TaskGetUsersOptions, TaskMethods, TaskServiceModel, TaskSlaDetail, TaskSource, TasksUnassignOptions, UserLoginInfo };