@uipath/uipath-typescript 1.3.7 → 1.3.9

package/dist/buckets/index.mjs

@@ -1,4 +1,4 @@
-import { BatchLogRecordProcessor, LoggerProvider } from '@opentelemetry/sdk-logs';
+import { getOrCreateClient, createTrack, createTrackEvent } from '@uipath/core-telemetry';
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -651,6 +651,27 @@ var PaginationType;
 /**
  * Collection of utility functions for working with objects
  */
+/**
+ * Resolves a field value from an object, supporting both direct keys (e.g., '@odata.count')
+ * and dot-separated nested paths (e.g., 'pagination.totalCount').
+ * Direct key match takes priority over nested traversal.
+ */
+function resolveNestedField(data, fieldPath) {
+    if (!data) {
+        return undefined;
+    }
+    if (fieldPath in data) {
+        return data[fieldPath];
+    }
+    if (!fieldPath.includes('.')) {
+        return undefined;
+    }
+    let value = data;
+    for (const part of fieldPath.split('.')) {
+        value = value?.[part];
+    }
+    return value;
+}
 /**
  * Filters out undefined values from an object
  * @param obj The source object
@@ -900,6 +921,10 @@ const BUCKET_TOKEN_PARAMS = {
     TOKEN_PARAM: 'continuationToken'
 };
 
+/**
+ * Converts a UTC timestamp string (e.g., "5/8/2026 11:20:17 AM") to ISO 8601 UTC format.
+ * Returns the original value if parsing fails.
+ */
 /**
  * Transforms data by mapping fields according to the provided field mapping
  * @param data The source data to transform
@@ -1288,7 +1313,8 @@ 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];
-        const totalCount = Array.isArray(response.data) ? undefined : response.data?.[totalCountField];
+        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
         const parsedItems = typeof rawItems === 'string' ? JSON.parse(rawItems) : (rawItems || []);
         const items = transformFn ? parsedItems.map(transformFn) : parsedItems;
@@ -1585,9 +1611,17 @@ class BaseService {
                 const pageSizeParam = paginationParams?.pageSizeParam || ODATA_OFFSET_PARAMS.PAGE_SIZE_PARAM;
                 const offsetParam = paginationParams?.offsetParam || ODATA_OFFSET_PARAMS.OFFSET_PARAM;
                 const countParam = paginationParams?.countParam || ODATA_OFFSET_PARAMS.COUNT_PARAM;
+                // 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;
                 requestParams[pageSizeParam] = limitedPageSize;
-                if (params.pageNumber && params.pageNumber > 1) {
-                    requestParams[offsetParam] = (params.pageNumber - 1) * limitedPageSize;
+                if (convertToSkip) {
+                    if (params.pageNumber && params.pageNumber > 1) {
+                        requestParams[offsetParam] = (params.pageNumber - 1) * limitedPageSize;
+                    }
+                }
+                else {
+                    requestParams[offsetParam] = params.pageNumber || 1;
                 }
                 {
                     requestParams[countParam] = true;
@@ -1618,7 +1652,8 @@ class BaseService {
         // 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] || []);
-        const totalCount = Array.isArray(response.data) ? undefined : response.data[totalCountField];
+        const rawTotalCount = Array.isArray(response.data) ? undefined : resolveNestedField(response.data, totalCountField);
+        const totalCount = typeof rawTotalCount === 'number' ? rawTotalCount : undefined;
         const continuationToken = response.data[continuationTokenField];
         // Determine if there are more pages
         const hasMore = this.determineHasMorePages(paginationType, {
@@ -1895,278 +1930,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.7";
-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 BatchLogRecordProcessor(exporter);
-        this.logProvider = new 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 = getOrCreateClient(CLOUD_ROLE_NAME);
+const track = createTrack(sdkClient);
+createTrackEvent(sdkClient);
 
 class BucketService extends FolderScopedService {
     /**
@@ -2204,6 +1994,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
      *
@@ -2493,6 +2309,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);