@uipath/uipath-typescript 1.3.8 → 1.3.10

package/dist/buckets/index.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-var sdkLogs = require('@opentelemetry/sdk-logs');
+var coreTelemetry = require('@uipath/core-telemetry');
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -613,14 +613,25 @@ class ApiClient {
             if (!text) {
                 return undefined;
             }
-            return JSON.parse(text);
+            try {
+                return JSON.parse(text);
+            }
+            catch (error) {
+                if (error instanceof SyntaxError) {
+                    throw new ServerError({
+                        message: `Server returned non-JSON response (${response.status} ${response.url}): ${error.message}`,
+                        statusCode: response.status,
+                    });
+                }
+                throw error;
+            }
         }
         catch (error) {
             // If it's already one of our errors, re-throw it
             if (error.type && error.type.includes('Error')) {
                 throw error;
             }
-            // Otherwise, it's likely a network error
+            // Otherwise, it's a genuine network/fetch failure
             throw ErrorFactory.createNetworkError(error);
         }
     }
@@ -1264,9 +1275,9 @@ class PaginationHelpers {
      * @returns Promise resolving to a paginated result
      */
     static async getAllPaginated(params) {
-        const { serviceAccess, getEndpoint, folderId, paginationParams, additionalParams, transformFn, method = HTTP_METHODS.GET, options = {} } = params;
+        const { serviceAccess, getEndpoint, folderId, headers: providedHeaders, paginationParams, additionalParams, transformFn, method = HTTP_METHODS.GET, options = {} } = params;
         const endpoint = getEndpoint(folderId);
-        const headers = folderId ? createHeaders({ [FOLDER_ID]: folderId }) : {};
+        const headers = providedHeaders ?? (folderId ? createHeaders({ [FOLDER_ID]: folderId }) : {});
         const paginatedResponse = await serviceAccess.requestWithPagination(method, endpoint, paginationParams, {
             headers,
             params: additionalParams,
@@ -1294,13 +1305,13 @@ class PaginationHelpers {
      * @returns Promise resolving to an object with data and totalCount
      */
     static async getAllNonPaginated(params) {
-        const { serviceAccess, getAllEndpoint, getByFolderEndpoint, folderId, additionalParams, transformFn, method = HTTP_METHODS.GET, options = {} } = params;
+        const { serviceAccess, getAllEndpoint, getByFolderEndpoint, folderId, headers: providedHeaders, additionalParams, 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;
         // Determine endpoint and headers based on folderId
         const endpoint = folderId ? getByFolderEndpoint : getAllEndpoint;
-        const headers = folderId ? createHeaders({ [FOLDER_ID]: folderId }) : {};
+        const headers = providedHeaders ?? (folderId ? createHeaders({ [FOLDER_ID]: folderId }) : {});
         // Make the API call based on method
         let response;
         if (method === HTTP_METHODS.POST) {
@@ -1359,6 +1370,7 @@ class PaginationHelpers {
                 serviceAccess: config.serviceAccess,
                 getEndpoint: config.getEndpoint,
                 folderId,
+                headers: config.headers,
                 paginationParams: cursor ? { cursor, pageSize } : jumpToPage ? { jumpToPage, pageSize } : { pageSize },
                 additionalParams: prefixedOptions,
                 transformFn: config.transformFn,
@@ -1376,6 +1388,7 @@ class PaginationHelpers {
             getAllEndpoint: config.getEndpoint(),
             getByFolderEndpoint: byFolderEndpoint,
             folderId,
+            headers: config.headers,
             additionalParams: prefixedOptions,
             transformFn: config.transformFn,
             method: config.method,
@@ -1920,6 +1933,8 @@ const BUCKET_ENDPOINTS = {
     GET_FILE_META_DATA: (id) => `${ORCHESTRATOR_BASE}/api/Buckets/${id}/ListFiles`,
     GET_READ_URI: (id) => `${ORCHESTRATOR_BASE}/odata/Buckets(${id})/UiPath.Server.Configuration.OData.GetReadUri`,
     GET_WRITE_URI: (id) => `${ORCHESTRATOR_BASE}/odata/Buckets(${id})/UiPath.Server.Configuration.OData.GetWriteUri`,
+    DELETE_FILE: (id) => `${ORCHESTRATOR_BASE}/odata/Buckets(${id})/UiPath.Server.Configuration.OData.DeleteFile`,
+    GET_FILES: (id) => `${ORCHESTRATOR_BASE}/odata/Buckets(${id})/UiPath.Server.Configuration.OData.GetFiles`,
 };
 
 /**
@@ -1932,278 +1947,33 @@ const BucketMap = {
 };
 
 /**
- * SDK Telemetry constants
- */
-// Connection string placeholder that will be replaced during build
-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";
-// SDK Version placeholder 
-const SDK_VERSION = "1.3.8";
-const VERSION = "Version";
-const SERVICE = "Service";
-const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
-const CLOUD_TENANT_NAME = "CloudTenantName";
-const CLOUD_URL = "CloudUrl";
-const CLOUD_CLIENT_ID = "CloudClientId";
-const CLOUD_REDIRECT_URI = "CloudRedirectUri";
-const APP_NAME = "ApplicationName";
-const CLOUD_ROLE_NAME = "uipath-ts-sdk";
-// Service and logger names
-const SDK_SERVICE_NAME = "UiPath.TypeScript.Sdk";
-const SDK_LOGGER_NAME = "uipath-ts-sdk-telemetry";
-// Event names
-const SDK_RUN_EVENT = "Sdk.Run";
-// Default value for unknown/empty attributes
-const UNKNOWN = "";
-
-/**
- * Log exporter that sends ALL logs as Application Insights custom events
- */
-class ApplicationInsightsEventExporter {
-    constructor(connectionString) {
-        this.connectionString = connectionString;
-    }
-    export(logs, resultCallback) {
-        try {
-            logs.forEach(logRecord => {
-                this.sendAsCustomEvent(logRecord);
-            });
-            resultCallback({ code: 0 });
-        }
-        catch (error) {
-            console.debug('Failed to export logs to Application Insights:', error);
-            resultCallback({ code: 2, error });
-        }
-    }
-    shutdown() {
-        return Promise.resolve();
-    }
-    sendAsCustomEvent(logRecord) {
-        // Get event name from body or attributes
-        const eventName = logRecord.body || SDK_RUN_EVENT;
-        const payload = {
-            name: 'Microsoft.ApplicationInsights.Event',
-            time: new Date().toISOString(),
-            iKey: this.extractInstrumentationKey(),
-            data: {
-                baseType: 'EventData',
-                baseData: {
-                    ver: 2,
-                    name: eventName,
-                    properties: this.convertAttributesToProperties(logRecord.attributes || {})
-                }
-            },
-            tags: {
-                'ai.cloud.role': CLOUD_ROLE_NAME,
-                'ai.cloud.roleInstance': SDK_VERSION
-            }
-        };
-        this.sendToApplicationInsights(payload);
-    }
-    extractInstrumentationKey() {
-        const match = this.connectionString.match(/InstrumentationKey=([^;]+)/);
-        return match ? match[1] : '';
-    }
-    convertAttributesToProperties(attributes) {
-        const properties = {};
-        Object.entries(attributes || {}).forEach(([key, value]) => {
-            properties[key] = String(value);
-        });
-        return properties;
-    }
-    async sendToApplicationInsights(payload) {
-        try {
-            const ingestionEndpoint = this.extractIngestionEndpoint();
-            if (!ingestionEndpoint) {
-                console.debug('No ingestion endpoint found in connection string');
-                return;
-            }
-            const url = `${ingestionEndpoint}/v2/track`;
-            const response = await fetch(url, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json',
-                },
-                body: JSON.stringify(payload)
-            });
-            if (!response.ok) {
-                console.debug(`Failed to send event telemetry: ${response.status} ${response.statusText}`);
-            }
-        }
-        catch (error) {
-            console.debug('Error sending event telemetry to Application Insights:', error);
-        }
-    }
-    extractIngestionEndpoint() {
-        const match = this.connectionString.match(/IngestionEndpoint=([^;]+)/);
-        return match ? match[1] : '';
-    }
-}
-/**
- * Singleton telemetry client
- */
-class TelemetryClient {
-    constructor() {
-        this.isInitialized = false;
-    }
-    static getInstance() {
-        if (!TelemetryClient.instance) {
-            TelemetryClient.instance = new TelemetryClient();
-        }
-        return TelemetryClient.instance;
-    }
-    /**
-     * Initialize telemetry
-     */
-    initialize(config) {
-        if (this.isInitialized) {
-            return;
-        }
-        this.isInitialized = true;
-        if (config) {
-            this.telemetryContext = config;
-        }
-        try {
-            const connectionString = this.getConnectionString();
-            if (!connectionString) {
-                return;
-            }
-            this.setupTelemetryProvider(connectionString);
-        }
-        catch (error) {
-            // Silent failure - telemetry errors shouldn't break functionality
-            console.debug('Failed to initialize OpenTelemetry:', error);
-        }
-    }
-    getConnectionString() {
-        const connectionString = CONNECTION_STRING;
-        return connectionString;
-    }
-    setupTelemetryProvider(connectionString) {
-        const exporter = new ApplicationInsightsEventExporter(connectionString);
-        const processor = new sdkLogs.BatchLogRecordProcessor(exporter);
-        this.logProvider = new sdkLogs.LoggerProvider({
-            processors: [processor]
-        });
-        this.logger = this.logProvider.getLogger(SDK_LOGGER_NAME);
-    }
-    /**
-     * Track a telemetry event
-     */
-    track(eventName, name, extraAttributes = {}) {
-        try {
-            // Skip if logger not initialized
-            if (!this.logger) {
-                return;
-            }
-            const finalDisplayName = name || eventName;
-            const attributes = this.getEnrichedAttributes(extraAttributes, eventName);
-            // Emit as log 
-            this.logger.emit({
-                body: finalDisplayName,
-                attributes: attributes,
-                timestamp: Date.now(),
-            });
-        }
-        catch (error) {
-            // Silent failure
-            console.debug('Failed to track telemetry event:', error);
-        }
-    }
-    /**
-     * Get enriched attributes for telemetry events
-     */
-    getEnrichedAttributes(extraAttributes, eventName) {
-        const attributes = {
-            [APP_NAME]: SDK_SERVICE_NAME,
-            [VERSION]: SDK_VERSION,
-            [SERVICE]: eventName,
-            [CLOUD_URL]: this.createCloudUrl(),
-            [CLOUD_ORGANIZATION_NAME]: this.telemetryContext?.orgName || UNKNOWN,
-            [CLOUD_TENANT_NAME]: this.telemetryContext?.tenantName || UNKNOWN,
-            [CLOUD_REDIRECT_URI]: this.telemetryContext?.redirectUri || UNKNOWN,
-            [CLOUD_CLIENT_ID]: this.telemetryContext?.clientId || UNKNOWN,
-            ...extraAttributes,
-        };
-        return attributes;
-    }
-    /**
-     * Create cloud URL from base URL, organization ID, and tenant ID
-     */
-    createCloudUrl() {
-        const baseUrl = this.telemetryContext?.baseUrl;
-        const orgId = this.telemetryContext?.orgName;
-        const tenantId = this.telemetryContext?.tenantName;
-        if (!baseUrl || !orgId || !tenantId) {
-            return UNKNOWN;
-        }
-        return `${baseUrl}/${orgId}/${tenantId}`;
-    }
-}
-// Export singleton instance
-const telemetryClient = TelemetryClient.getInstance();
+ * SDK Telemetry constants.
+ *
+ * Only the SDK's identity (version, service name, role name, …) lives
+ * here. The Application Insights connection string is injected into
+ * `@uipath/core-telemetry` itself at publish time, and the generic attribute
+ * keys (`Version`, `Service`, `CloudOrganizationName`, …) are owned by
+ * `@uipath/core-telemetry` and consumed there — they are not part of the
+ * SDK's public API.
+ */
+/** SDK version placeholder — patched by the SDK publish workflow. */
+const CLOUD_ROLE_NAME = 'uipath-ts-sdk';
 
 /**
- * SDK Track decorator and function for telemetry
- */
-/**
- * Common tracking logic shared between method and function decorators
- */
-function createTrackedFunction(originalFunction, nameOrOptions, fallbackName, opts) {
-    return function (...args) {
-        // Determine if we should track this call
-        let shouldTrack = true;
-        if (opts.condition !== undefined) {
-            if (typeof opts.condition === 'function') {
-                shouldTrack = opts.condition.apply(this, args);
-            }
-            else {
-                shouldTrack = opts.condition;
-            }
-        }
-        // Track the event if enabled
-        if (shouldTrack) {
-            // Use the full name provided in the decorator (e.g., "Queue.GetAll")
-            const serviceMethod = typeof nameOrOptions === 'string'
-                ? nameOrOptions
-                : fallbackName;
-            // Use 'Sdk.Run' as the name and serviceMethod as the service
-            telemetryClient.track(serviceMethod, SDK_RUN_EVENT, opts.attributes);
-        }
-        // Execute the original function
-        return originalFunction.apply(this, args);
-    };
-}
-/**
- * Track decorator that can be used to automatically track function calls
+ * UiPath TypeScript SDK Telemetry
  *
- * Usage:
- * @track("Service.Method")
- * function myFunction() { ... }
- *
- * @track("Queue.GetAll")
- * async getAll() { ... }
- *
- * @track("Tasks.Create")
- * async create() { ... }
- *
- * @track("Assets.Update", { condition: false })
- * function myFunction() { ... }
- *
- * @track("Processes.Start", { attributes: { customProp: "value" } })
- * function myFunction() { ... }
- */
-function track(nameOrOptions, options) {
-    return function decorator(_target, propertyKey, descriptor) {
-        const opts = typeof nameOrOptions === 'object' ? nameOrOptions : {};
-        if (descriptor && typeof descriptor.value === 'function') {
-            // Method decorator
-            descriptor.value = createTrackedFunction(descriptor.value, nameOrOptions, propertyKey || 'unknown_method', opts);
-            return descriptor;
-        }
-        // Function decorator
-        return (originalFunction) => createTrackedFunction(originalFunction, nameOrOptions, originalFunction.name || 'unknown_function', opts);
-    };
-}
+ * Constructs the SDK's own `TelemetryClient` and binds the SDK-local
+ * `track` / `trackEvent` to it. Each consumer of `@uipath/core-telemetry`
+ * does this independently, so events carry their own consumer's identity
+ * and tenant context.
+ */
+// Keyed by `CLOUD_ROLE_NAME` so every SDK subpath bundle resolves to the
+// same `TelemetryClient` instance at runtime. A single `initialize(...)`
+// from the `UiPath` constructor therefore wires up `@track` decorators
+// across every subpath bundle (`assets`, `feedback`, `tasks`, …).
+const sdkClient = coreTelemetry.getOrCreateClient(CLOUD_ROLE_NAME);
+const track = coreTelemetry.createTrack(sdkClient);
+coreTelemetry.createTrackEvent(sdkClient);
 
 class BucketService extends FolderScopedService {
     /**
@@ -2241,6 +2011,32 @@ class BucketService extends FolderScopedService {
         // Transform response from PascalCase to camelCase
         return pascalToCamelCaseKeys(response.data);
     }
+    /**
+     * Retrieves a single orchestrator storage bucket by name.
+     *
+     * @param name - Bucket name to search for
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
+     * @returns Promise resolving to a single bucket
+     * {@link BucketGetResponse}
+     * @example
+     * ```typescript
+     * import { Buckets } from '@uipath/uipath-typescript/buckets';
+     *
+     * const buckets = new Buckets(sdk);
+     *
+     * // By folder ID
+     * await buckets.getByName('MyBucket', { folderId: <folderId> });
+     *
+     * // By folder key (GUID)
+     * await buckets.getByName('MyBucket', { folderKey: '<folderKey>' });
+     *
+     * // By folder path
+     * await buckets.getByName('MyBucket', { folderPath: '<folderPath>' });
+     * ```
+     */
+    async getByName(name, options = {}) {
+        return this.getByNameLookup('Bucket', BUCKET_ENDPOINTS.GET_BY_FOLDER, name, options, (raw) => pascalToCamelCaseKeys(raw));
+    }
     /**
      * Gets all buckets across folders with optional filtering and folder scoping
      *
@@ -2512,6 +2308,120 @@ class BucketService extends FolderScopedService {
         }
         return transformedData;
     }
+    /**
+     * Lists all files in a bucket.
+     *
+     * Returns a flat, recursive listing of all files in the bucket. Supports regex filtering
+     * and filter / orderby / select / expand. {@link BucketFile} entries include
+     * `isDirectory` so callers can distinguish folders from files.
+     *
+     * 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
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional parameters for regex filtering, query options, and pagination
+     * @returns Promise resolving to either an array of files NonPaginatedResponse<BucketFile> or a PaginatedResponse<BucketFile> when pagination options are used.
+     *
+     * @example
+     * ```typescript
+     * import { Buckets } from '@uipath/uipath-typescript/buckets';
+     *
+     * const buckets = new Buckets(sdk);
+     *
+     * // List all files in the bucket
+     * const files = await buckets.getFiles(<bucketId>, { folderId: <folderId> });
+     *
+     * // Filter by regex pattern
+     * const pdfs = await buckets.getFiles(<bucketId>, {
+     *   folderId: <folderId>,
+     *   fileNameRegex: '.*\\.pdf$'
+     * });
+     *
+     * // First page with pagination
+     * const page1 = await buckets.getFiles(<bucketId>, { folderId: <folderId>, pageSize: 10 });
+     *
+     * // Navigate using cursor
+     * if (page1.hasNextPage) {
+     *   const page2 = await buckets.getFiles(<bucketId>, { folderId: <folderId>, cursor: page1.nextCursor });
+     * }
+     *
+     * // Jump to specific page
+     * const page5 = await buckets.getFiles(<bucketId>, {
+     *   folderId: <folderId>,
+     *   jumpToPage: 5,
+     *   pageSize: 10
+     * });
+     * ```
+     */
+    async getFiles(bucketId, options) {
+        if (!bucketId) {
+            throw new ValidationError({ message: 'bucketId is required for getFiles' });
+        }
+        const { folderId, folderKey, folderPath, ...restOptions } = options ?? {};
+        const headers = resolveFolderHeaders({
+            folderId,
+            folderKey,
+            folderPath,
+            resourceType: 'Buckets.getFiles',
+            fallbackFolderKey: this.config.folderKey,
+        });
+        const transformBucketFile = (file) => transformData(pascalToCamelCaseKeys(file), BucketMap);
+        return PaginationHelpers.getAll({
+            serviceAccess: this.createPaginationServiceAccess(),
+            getEndpoint: () => BUCKET_ENDPOINTS.GET_FILES(bucketId),
+            transformFn: transformBucketFile,
+            pagination: {
+                paginationType: PaginationType.OFFSET,
+                itemsField: ODATA_PAGINATION.ITEMS_FIELD,
+                totalCountField: ODATA_PAGINATION.TOTAL_COUNT_FIELD,
+                paginationParams: {
+                    pageSizeParam: ODATA_OFFSET_PARAMS.PAGE_SIZE_PARAM,
+                    offsetParam: ODATA_OFFSET_PARAMS.OFFSET_PARAM,
+                    countParam: ODATA_OFFSET_PARAMS.COUNT_PARAM,
+                },
+            },
+            excludeFromPrefix: ['directory', 'recursive', 'fileNameRegex'],
+            headers,
+        }, { ...restOptions, directory: '/', recursive: true });
+    }
+    /**
+     * Deletes a file from a bucket
+     *
+     * @param bucketId - The ID of the bucket
+     * @param path - The full path to the file to delete
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`)
+     * @returns Promise resolving when the file is deleted
+     *
+     * @example
+     * ```typescript
+     * import { Buckets } from '@uipath/uipath-typescript/buckets';
+     *
+     * const buckets = new Buckets(sdk);
+     *
+     * // Delete a file from a bucket
+     * await buckets.deleteFile(<bucketId>, '/folder/file.pdf', { folderId: <folderId> });
+     * ```
+     */
+    async deleteFile(bucketId, path, options) {
+        if (!bucketId) {
+            throw new ValidationError({ message: 'bucketId is required for deleteFile' });
+        }
+        if (!path) {
+            throw new ValidationError({ message: 'path is required for deleteFile' });
+        }
+        const headers = resolveFolderHeaders({
+            folderId: options?.folderId,
+            folderKey: options?.folderKey,
+            folderPath: options?.folderPath,
+            resourceType: 'Buckets.deleteFile',
+            fallbackFolderKey: this.config.folderKey,
+        });
+        await this.delete(BUCKET_ENDPOINTS.DELETE_FILE(bucketId), {
+            params: { path },
+            headers,
+        });
+    }
     /**
      * Gets a direct upload URL for a file in the bucket
      *
@@ -2530,6 +2440,9 @@ class BucketService extends FolderScopedService {
 __decorate([
     track('Buckets.GetById')
 ], BucketService.prototype, "getById", null);
+__decorate([
+    track('Buckets.GetByName')
+], BucketService.prototype, "getByName", null);
 __decorate([
     track('Buckets.GetAll')
 ], BucketService.prototype, "getAll", null);
@@ -2542,6 +2455,12 @@ __decorate([
 __decorate([
     track('Buckets.GetReadUri')
 ], BucketService.prototype, "getReadUri", null);
+__decorate([
+    track('Buckets.GetFiles')
+], BucketService.prototype, "getFiles", null);
+__decorate([
+    track('Buckets.DeleteFile')
+], BucketService.prototype, "deleteFile", null);
 
 exports.BucketOptions = void 0;
 (function (BucketOptions) {