@uipath/uipath-typescript 1.3.11 → 1.4.1

package/dist/buckets/index.cjs

@@ -721,6 +721,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
@@ -1275,12 +1301,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,
@@ -1305,7 +1337,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;
@@ -1315,17 +1347,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
@@ -1371,8 +1404,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: {
@@ -1390,6 +1424,7 @@ class PaginationHelpers {
             folderId,
             headers: config.headers,
             additionalParams: prefixedOptions,
+            queryParams: config.queryParams,
             transformFn: config.transformFn,
             method: config.method,
             options: {
@@ -1581,18 +1616,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
@@ -1629,6 +1663,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) {
@@ -1636,7 +1672,8 @@ class BaseService {
                     }
                 }
                 else {
-                    requestParams[offsetParam] = params.pageNumber || 1;
+                    const sdkPageNumber = params.pageNumber || 1;
+                    requestParams[offsetParam] = zeroBased ? sdkPageNumber - 1 : sdkPageNumber;
                 }
                 {
                     requestParams[countParam] = true;
@@ -1665,8 +1702,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];
@@ -2101,48 +2139,32 @@ class BucketService extends FolderScopedService {
             }
         }, options);
     }
-    /**
-     * Gets metadata for files in a bucket with optional filtering and pagination
-     *
-     * 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)
-     *
-     * @param bucketId - The ID of the bucket to get file metadata from
-     * @param folderId - Required folder ID for organization unit context
-     * @param options - Optional parameters for filtering, pagination and access URL generation
-     * @returns Promise resolving to the list of file metadata in the bucket or paginated result
-     *
-     * @example
-     * ```typescript
-     * import { Buckets } from '@uipath/uipath-typescript/buckets';
-     *
-     * const buckets = new Buckets(sdk);
-     *
-     * // Get metadata for all files in a bucket
-     * const fileMetadata = await buckets.getFileMetaData(123, 456);
-     *
-     * // Get file metadata with a specific prefix
-     * const fileMetadata = await buckets.getFileMetaData(123, 456, {
-     *   prefix: '/folder1'
-     * });
-     *
-     * // First page with pagination
-     * const page1 = await buckets.getFileMetaData(123, 456, { pageSize: 10 });
-     *
-     * // Navigate using cursor
-     * if (page1.hasNextPage) {
-     *   const page2 = await buckets.getFileMetaData(123, 456, { cursor: page1.nextCursor });
-     * }
-     * ```
-     */
-    async getFileMetaData(bucketId, folderId, options) {
+    async getFileMetaData(bucketId, optionsOrFolderId, legacyOptions) {
         if (!bucketId) {
             throw new ValidationError({ message: 'bucketId is required for getFileMetaData' });
         }
-        if (!folderId) {
-            throw new ValidationError({ message: 'folderId is required for getFileMetaData' });
+        // Normalize the two overload forms into a single internal shape.
+        let folderId;
+        let folderKey;
+        let folderPath;
+        let restOptions;
+        if (typeof optionsOrFolderId === 'number') {
+            // Deprecated positional form: getFileMetaData(bucketId, folderId, options?)
+            folderId = optionsOrFolderId;
+            restOptions = (legacyOptions ?? {});
+        }
+        else {
+            // Preferred form: getFileMetaData(bucketId, options?)
+            const opts = optionsOrFolderId ?? {};
+            ({ folderId, folderKey, folderPath, ...restOptions } = opts);
         }
+        const headers = resolveFolderHeaders({
+            folderId,
+            folderKey,
+            folderPath,
+            resourceType: 'Buckets.getFileMetaData',
+            fallbackFolderKey: this.config.folderKey,
+        });
         // Transformation function for blob items
         const transformBlobItem = (item) => transformData(item, BucketMap);
         return PaginationHelpers.getAll({
@@ -2158,93 +2180,97 @@ class BucketService extends FolderScopedService {
                     tokenParam: BUCKET_TOKEN_PARAMS.TOKEN_PARAM
                 }
             },
-            excludeFromPrefix: ['prefix'] // Bucket-specific param, not OData
-        }, { ...options, folderId });
-    }
-    /**
-     * Uploads a file to a bucket
-     *
-     * @param options - Options for file upload including bucket ID, folder ID, path, content, and optional parameters
-     * @returns Promise resolving to a response with success status and HTTP status code
-     *
-     * @example
-     * ```typescript
-     * import { Buckets } from '@uipath/uipath-typescript/buckets';
-     *
-     * const buckets = new Buckets(sdk);
-     *
-     * // Upload a file from browser
-     * const file = new File(['file content'], 'example.txt');
-     * const result = await buckets.uploadFile({
-     *   bucketId: 123,
-     *   folderId: 456,
-     *   path: '/folder/example.txt',
-     *   content: file
-     * });
-     *
-     * // In Node env with Buffer
-     * const buffer = Buffer.from('file content');
-     * const result = await buckets.uploadFile({
-     *   bucketId: 123,
-     *   folderId: 456,
-     *   path: '/folder/example.txt',
-     *   content: buffer
-     * });
-     * ```
-     */
-    async uploadFile(options) {
-        const { bucketId, folderId, path, content } = options;
+            excludeFromPrefix: ['prefix'], // Bucket-specific param, not OData
+            headers,
+        }, restOptions);
+    }
+    async uploadFile(bucketIdOrOptions, path, content, options) {
+        // Normalize the two overload forms into a single internal shape.
+        let bucketId;
+        let resolvedPath;
+        let resolvedContent;
+        let folderId;
+        let folderKey;
+        let folderPath;
+        if (bucketIdOrOptions !== null && typeof bucketIdOrOptions === 'object') {
+            // Deprecated options-only form: uploadFile({ bucketId, path, content, ... })
+            ({ bucketId, path: resolvedPath, content: resolvedContent, folderId, folderKey, folderPath } = bucketIdOrOptions);
+        }
+        else {
+            // Preferred positional form: uploadFile(bucketId, path, content, options?)
+            bucketId = bucketIdOrOptions;
+            resolvedPath = path;
+            resolvedContent = content;
+            const opts = options ?? {};
+            ({ folderId, folderKey, folderPath } = opts);
+        }
         if (!bucketId) {
             throw new ValidationError({ message: 'bucketId is required for uploadFile' });
         }
-        if (!folderId) {
-            throw new ValidationError({ message: 'folderId is required for uploadFile' });
-        }
-        if (!path) {
+        if (!resolvedPath) {
             throw new ValidationError({ message: 'path is required for uploadFile' });
         }
-        if (!content) {
+        if (!resolvedContent) {
             throw new ValidationError({ message: 'content is required for uploadFile' });
         }
+        const headers = resolveFolderHeaders({
+            folderId,
+            folderKey,
+            folderPath,
+            resourceType: 'Buckets.uploadFile',
+            fallbackFolderKey: this.config.folderKey,
+        });
         const uriResponse = await this._getWriteUri({
             bucketId,
-            folderId,
-            path,
+            path: resolvedPath,
+            headers,
         });
         // Upload file to the provided URI
-        const response = await this._uploadToUri(uriResponse, content);
+        const response = await this._uploadToUri(uriResponse, resolvedContent);
         return {
             success: response.status >= 200 && response.status < 300,
             statusCode: response.status
         };
     }
-    /**
-     * Gets a direct download URL for a file in the bucket
-     *
-     * @param options - Contains bucketId, folderId, file path and optional expiry time
-     * @returns Promise resolving to blob file access information
-     *
-     * @example
-     * ```typescript
-     * import { Buckets } from '@uipath/uipath-typescript/buckets';
-     *
-     * const buckets = new Buckets(sdk);
-     *
-     * // Get download URL for a file
-     * const fileAccess = await buckets.getReadUri({
-     *   bucketId: 123,
-     *   folderId: 456,
-     *   path: '/folder/file.pdf'
-     * });
-     * ```
-     */
-    async getReadUri(options) {
-        const { bucketId, folderId, path, expiryInMinutes, ...restOptions } = options;
+    async getReadUri(bucketIdOrOptions, path, options) {
+        // Normalize the two overload forms into a single internal shape.
+        let bucketId;
+        let resolvedPath;
+        let folderId;
+        let folderKey;
+        let folderPath;
+        let expiryInMinutes;
+        let restOptions;
+        if (bucketIdOrOptions !== null && typeof bucketIdOrOptions === 'object') {
+            // Deprecated options-only form: getReadUri({ bucketId, path, ... })
+            const { bucketId: bid, path: p, expiryInMinutes: e, folderId: fid, folderKey: fkey, folderPath: fpath, ...rest } = bucketIdOrOptions;
+            bucketId = bid;
+            resolvedPath = p;
+            expiryInMinutes = e;
+            folderId = fid;
+            folderKey = fkey;
+            folderPath = fpath;
+            restOptions = rest;
+        }
+        else {
+            // Preferred positional form: getReadUri(bucketId, path, options?)
+            bucketId = bucketIdOrOptions;
+            resolvedPath = path;
+            const opts = options ?? {};
+            ({ expiryInMinutes, folderId, folderKey, folderPath, ...restOptions } = opts);
+        }
+        const headers = resolveFolderHeaders({
+            folderId,
+            folderKey,
+            folderPath,
+            resourceType: 'Buckets.getReadUri',
+            fallbackFolderKey: this.config.folderKey,
+        });
         const queryOptions = {
             expiryInMinutes,
             ...addPrefixToKeys(restOptions, ODATA_PREFIX, Object.keys(restOptions))
         };
-        return this._getUri(BUCKET_ENDPOINTS.GET_READ_URI(bucketId), bucketId, folderId, path, queryOptions);
+        return this._getUri(BUCKET_ENDPOINTS.GET_READ_URI(bucketId), bucketId, resolvedPath, headers, queryOptions);
     }
     /**
      * Uploads content to the provided URI
@@ -2274,23 +2300,18 @@ class BucketService extends FolderScopedService {
      * Private method to handle common URI request logic
      * @param endpoint - The API endpoint to call
      * @param bucketId - The bucket ID
-     * @param folderId - The folder ID
      * @param path - The file path
+     * @param headers - Pre-built folder-context headers (built via `resolveFolderHeaders`)
      * @param queryOptions - Additional query parameters
      * @returns Promise resolving to blob file access information
      */
-    async _getUri(endpoint, bucketId, folderId, path, queryOptions = {}) {
+    async _getUri(endpoint, bucketId, path, headers, queryOptions = {}) {
         if (!bucketId) {
             throw new ValidationError({ message: 'bucketId is required for getUri' });
         }
-        if (!folderId) {
-            throw new ValidationError({ message: 'folderId is required for getUri' });
-        }
         if (!path) {
             throw new ValidationError({ message: 'path is required for getUri' });
         }
-        // Create headers with required folder ID
-        const headers = createHeaders({ [FOLDER_ID]: folderId });
         // Filter out undefined values and build query params
         const queryParams = filterUndefined({
             path,
@@ -2425,16 +2446,16 @@ class BucketService extends FolderScopedService {
     /**
      * Gets a direct upload URL for a file in the bucket
      *
-     * @param options - Contains bucketId, folderId, file path, optional expiry time
+     * @param options - Contains bucketId, file path, optional expiry time, and pre-built folder-context headers
      * @returns Promise resolving to blob file access information
      */
     async _getWriteUri(options) {
-        const { bucketId, folderId, path, expiryInMinutes, ...restOptions } = options;
+        const { bucketId, path, expiryInMinutes, headers, ...restOptions } = options;
         const queryOptions = {
             expiryInMinutes,
             ...addPrefixToKeys(restOptions, ODATA_PREFIX, Object.keys(restOptions))
         };
-        return this._getUri(BUCKET_ENDPOINTS.GET_WRITE_URI(bucketId), bucketId, folderId, path, queryOptions);
+        return this._getUri(BUCKET_ENDPOINTS.GET_WRITE_URI(bucketId), bucketId, path, headers, queryOptions);
     }
 }
 __decorate([