@uipath/uipath-typescript 1.3.11 → 1.4.0

package/dist/conversational-agent/index.cjs

@@ -779,6 +779,32 @@ function filterUndefined(obj) {
  */
 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
@@ -1363,8 +1389,9 @@ class PaginationHelpers {
             });
         }
         // 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
@@ -1410,7 +1437,7 @@ 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,
                 transformFn: config.transformFn,
                 method: config.method,
@@ -1668,6 +1695,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) {
@@ -1675,7 +1704,8 @@ class BaseService {
                     }
                 }
                 else {
-                    requestParams[offsetParam] = params.pageNumber || 1;
+                    const sdkPageNumber = params.pageNumber || 1;
+                    requestParams[offsetParam] = zeroBased ? sdkPageNumber - 1 : sdkPageNumber;
                 }
                 {
                     requestParams[countParam] = true;
@@ -1704,8 +1734,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];
@@ -4947,37 +4978,58 @@ class ExchangeService extends BaseService {
         super(instance, buildConversationalAgentHeaders(options));
     }
     /**
-     * Gets all exchanges for a conversation with optional filtering and pagination
+     * Gets exchanges for a conversation with pagination and optional sort parameters
      *
-     * The method returns either:
-     * - A NonPaginatedResponse with items array (when no pagination parameters are provided)
-     * - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
+     * Returns a paginated response. When called without `pageSize`/`cursor`, the
+     * backend applies its default page size — inspect `hasNextPage`/`nextCursor`
+     * to navigate further pages.
      *
      * @param conversationId - The conversation ID to get exchanges for
      * @param options - Options for querying exchanges including optional pagination parameters
-     * @returns Promise resolving to either an array of exchanges {@link NonPaginatedResponse}<{@link ExchangeGetResponse}> or a {@link PaginatedResponse}<{@link ExchangeGetResponse}> when pagination options are used
+     * @returns Promise resolving to a {@link PaginatedResponse}<{@link ExchangeGetResponse}>
      *
-     * @example
+     * @example Basic usage - default page size and sort order
      * ```typescript
-     * // Get all exchanges (non-paginated)
-     * const conversationExchanges = await exchanges.getAll(conversationId);
-     *
-     * // First page with pagination
-     * const firstPageOfExchanges = await exchanges.getAll(conversationId, { pageSize: 10 });
+     * // First page
+     * const firstPage = await exchanges.getAll(conversationId);
      *
      * // Navigate using cursor
-     * if (firstPageOfExchanges.hasNextPage) {
-     *   const nextPageOfExchanges = await exchanges.getAll(conversationId, { cursor: firstPageOfExchanges.nextCursor });
+     * if (firstPage.hasNextPage) {
+     *   const nextPage = await exchanges.getAll(conversationId, { cursor: firstPage.nextCursor });
+     * }
+     * ```
+     *
+     * @example With explicit page size and exchange/message sort orders
+     * ```typescript
+     * import { SortOrder } from '@uipath/uipath-typescript/conversational-agent';
+     *
+     * const firstPage = await exchanges.getAll(conversationId, {
+     *   pageSize: 10,
+     *   exchangeSort: SortOrder.Descending,
+     *   messageSort: SortOrder.Ascending
+     * });
+     *
+     * // Navigate using cursor and same parameters
+     * if (firstPage.hasNextPage) {
+     *   const nextPage = await exchanges.getAll(conversationId, {
+     *     pageSize: 10,
+     *     exchangeSort: SortOrder.Descending,
+     *     messageSort: SortOrder.Ascending,
+     *     cursor: firstPage.nextCursor
+     *   });
      * }
      * ```
      */
     async getAll(conversationId, options) {
-        const transformFn = transformExchange;
-        return PaginationHelpers.getAll({
+        const { pageSize, cursor, jumpToPage, ...additionalParams } = options ?? {};
+        const paginationParams = cursor ? { cursor, pageSize } : jumpToPage ? { jumpToPage, pageSize } : { pageSize };
+        return PaginationHelpers.getAllPaginated({
             serviceAccess: this.createPaginationServiceAccess(),
             getEndpoint: () => EXCHANGE_ENDPOINTS.LIST(conversationId),
-            transformFn,
-            pagination: {
+            paginationParams,
+            additionalParams,
+            transformFn: transformExchange,
+            options: {
                 paginationType: PaginationType.TOKEN,
                 itemsField: CONVERSATIONAL_PAGINATION.ITEMS_FIELD,
                 continuationTokenField: CONVERSATIONAL_PAGINATION.CONTINUATION_TOKEN_FIELD,
@@ -4985,9 +5037,8 @@ class ExchangeService extends BaseService {
                     pageSizeParam: CONVERSATIONAL_TOKEN_PARAMS.PAGE_SIZE_PARAM,
                     tokenParam: CONVERSATIONAL_TOKEN_PARAMS.TOKEN_PARAM
                 }
-            },
-            excludeFromPrefix: Object.keys(options || {}) // Conversational params are not OData
-        }, options);
+            }
+        });
     }
     /**
      * Gets an exchange by ID with its messages
@@ -5969,28 +6020,23 @@ class ConversationService extends BaseService {
         return createConversationWithMethods(transformedData, this, this, this._exchangeService);
     }
     /**
-     * Gets all conversations with optional filtering and pagination
+     * Gets conversations with pagination and optional sort/filter parameters
      *
-     * The method returns either:
-     * - A NonPaginatedResponse with items array (when no pagination parameters are provided)
-     * - A PaginatedResponse with navigation cursors (when any pagination parameter is provided)
+     * Returns a paginated response. When called without `pageSize`/`cursor`, a
+     * default page size is applied - inspect `hasNextPage`/`nextCursor`
+     * to navigate further pages.
      *
-     * @param options - Options for querying conversations including optional pagination parameters
-     * @returns Promise resolving to either an array of conversations {@link NonPaginatedResponse}<{@link ConversationGetResponse}> or a {@link PaginatedResponse}<{@link ConversationGetResponse}> when pagination options are used
+     * @param options - Options for querying conversations
+     * @returns Promise resolving to a {@link PaginatedResponse}<{@link ConversationGetResponse}>
      *
-     * @example Basic usage - get all conversations
+     * @example Basic usage - default sort, pagination, and without filtering
      * ```typescript
-     * const allConversations = await conversationalAgent.conversations.getAll();
+     * // First page
+     * const firstPage = await conversationalAgent.conversations.getAll();
      *
-     * for (const conversation of allConversations.items) {
+     * for (const conversation of firstPage.items) {
      *   console.log(`${conversation.label} - created: ${conversation.createdTime}`);
      * }
-     * ```
-     *
-     * @example With pagination
-     * ```typescript
-     * // First page
-     * const firstPage = await conversationalAgent.conversations.getAll({ pageSize: 10 });
      *
      * // Navigate using cursor
      * if (firstPage.hasNextPage) {
@@ -6000,37 +6046,59 @@ class ConversationService extends BaseService {
      * }
      * ```
      *
-     * @example Sorted with limit
+     * @example With explicit page size and sort order (by last-activity timestamp)
      * ```typescript
-     * const result = await conversationalAgent.conversations.getAll({
-     *   sort: SortOrder.Descending,
-     *   pageSize: 20
+     * import { SortOrder } from '@uipath/uipath-typescript/conversational-agent';
+     *
+     * // First page
+     * const firstPage = await conversationalAgent.conversations.getAll({
+     *   pageSize: 10,
+     *   sort: SortOrder.Descending
      * });
+     *
+     * // Navigate using cursor and same parameters
+     * if (firstPage.hasNextPage) {
+     *   const nextPage = await conversationalAgent.conversations.getAll({
+     *     pageSize: 10,
+     *     sort: SortOrder.Descending,
+     *     cursor: firstPage.nextCursor
+     *   });
+     * }
      * ```
      *
-     * @example Filter by agent and search by label
+     * @example With agent-filter and label-search
      * ```typescript
-     * const filtered = await conversationalAgent.conversations.getAll({
+     * const firstPage = await conversationalAgent.conversations.getAll({
      *   agentId: <agentId>,
      *   label: 'budget'
      * });
+     *
+     * // Navigate using cursor and same parameters
+     * if (firstPage.hasNextPage) {
+     *   const nextPage = await conversationalAgent.conversations.getAll({
+     *     agentId: <agentId>,
+     *     label: 'budget',
+     *     cursor: firstPage.nextCursor
+     *   });
+     * }
      * ```
      */
     async getAll(options) {
-        // Transform function to convert API timestamps to SDK naming convention and add methods
         const transformFn = (conversation) => {
             const transformedData = transformData(conversation, ConversationMap);
             return createConversationWithMethods(transformedData, this, this, this._exchangeService);
         };
+        const { pageSize, cursor, jumpToPage, ...filterOptions } = options ?? {};
         // Translate SDK filter names (agentKey/agentId/label) to backend names before forwarding
-        const apiOptions = options
-            ? transformRequest(options, ConversationGetAllFilterMap)
-            : undefined;
-        return PaginationHelpers.getAll({
+        const additionalParams = transformRequest(filterOptions, ConversationGetAllFilterMap);
+        const paginationParams = cursor ? { cursor, pageSize } : jumpToPage ? { jumpToPage, pageSize } : { pageSize };
+        return PaginationHelpers.getAllPaginated({
             serviceAccess: this.createPaginationServiceAccess(),
             getEndpoint: () => CONVERSATION_ENDPOINTS.LIST,
+            paginationParams,
+            additionalParams,
             transformFn,
-            pagination: {
+            options: {
                 paginationType: PaginationType.TOKEN,
                 itemsField: CONVERSATIONAL_PAGINATION.ITEMS_FIELD,
                 continuationTokenField: CONVERSATIONAL_PAGINATION.CONTINUATION_TOKEN_FIELD,
@@ -6038,9 +6106,8 @@ class ConversationService extends BaseService {
                     pageSizeParam: CONVERSATIONAL_TOKEN_PARAMS.PAGE_SIZE_PARAM,
                     tokenParam: CONVERSATIONAL_TOKEN_PARAMS.TOKEN_PARAM
                 }
-            },
-            excludeFromPrefix: Object.keys(apiOptions || {}) // Conversational params are not OData
-        }, apiOptions);
+            }
+        });
     }
     /**
      * Updates a conversation by ID
@@ -6074,7 +6141,7 @@ class ConversationService extends BaseService {
      */
     async deleteById(id) {
         const response = await this.delete(CONVERSATION_ENDPOINTS.DELETE(id));
-        return response.data;
+        return transformData(response.data, ConversationMap);
     }
     // ==================== Attachments ====================
     /**