@uipath/uipath-typescript 1.0.0 → 1.1.0

package/LICENSE

@@ -1,9 +1,9 @@
 MIT License
 
-Copyright 2025 UiPath
+Copyright 2025-present UiPath
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -269,6 +269,7 @@ The SDK provides access to the following services through modular imports:
 - `Buckets` from `@uipath/uipath-typescript/buckets` - Manage storage buckets in Orchestrator
 - `Queues` from `@uipath/uipath-typescript/queues` - Manage Orchestrator queues
 - `Assets` from `@uipath/uipath-typescript/assets` - Manage Orchestrator assets
+- `ConversationalAgent` from `@uipath/uipath-typescript/conversational-agent` - Interact with Conversational Agents (real-time streaming, conversations, sessions)
 
 <details>
 <summary><strong>View Example Usage</strong></summary>
@@ -395,6 +396,7 @@ await entities.deleteRecordsById('entity-uuid', ['record-id-1', 'record-id-2']);
 Check out the [`/samples`](./samples) folder to see sample applications built using the SDK:
 
 - **[process-app](./samples/process-app)**: A Maestro process management application demonstrating OAuth authentication and SDK usage
+- **[conversational-agent-app](./samples/conversational-agent-app)**: A Conversational Agent chat application with real-time streaming, conversation management, file attachments, tool call visualization, and feedback
 
 <div align="right">
 

package/dist/assets/index.cjs

@@ -45,40 +45,31 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
 };
 
 /**
- * Base error class for all UiPath SDK errors
- * Pure TypeScript class with clean interface
+ * Type guards for error response types
  */
-class UiPathError {
-    constructor(type, params) {
-        this.type = type;
-        this.message = params.message;
-        this.statusCode = params.statusCode;
-        this.requestId = params.requestId;
-        this.timestamp = new Date();
-        // Capture stack trace for debugging
-        this.stack = (new Error()).stack;
-    }
-    /**
-     * Returns a clean JSON representation of the error
-     */
-    toJSON() {
-        return {
-            type: this.type,
-            message: this.message,
-            statusCode: this.statusCode,
-            requestId: this.requestId,
-            timestamp: this.timestamp
-        };
-    }
-    /**
-     * Returns detailed debug information including stack trace
-     */
-    getDebugInfo() {
-        return {
-            ...this.toJSON(),
-            stack: this.stack
-        };
-    }
+function isOrchestratorError(error) {
+    return typeof error === 'object' &&
+        error !== null &&
+        'message' in error &&
+        'errorCode' in error &&
+        typeof error.message === 'string' &&
+        typeof error.errorCode === 'number';
+}
+function isEntityError(error) {
+    return typeof error === 'object' &&
+        error !== null &&
+        'error' in error &&
+        typeof error.error === 'string';
+}
+function isPimsError(error) {
+    return typeof error === 'object' &&
+        error !== null &&
+        'type' in error &&
+        'title' in error &&
+        'status' in error &&
+        typeof error.type === 'string' &&
+        typeof error.title === 'string' &&
+        typeof error.status === 'number';
 }
 
 /**
@@ -142,161 +133,6 @@ const ErrorMessages = {
 const ErrorNames = {
     ABORT_ERROR: 'AbortError'};
 
-/**
- * Error thrown when authentication fails (401 errors)
- * Common scenarios:
- * - Invalid credentials
- * - Expired token
- * - Missing authentication
- */
-class AuthenticationError extends UiPathError {
-    constructor(params = {}) {
-        super(ErrorType.AUTHENTICATION, {
-            message: params.message || ErrorMessages.AUTHENTICATION_FAILED,
-            statusCode: params.statusCode ?? HttpStatus.UNAUTHORIZED,
-            requestId: params.requestId
-        });
-    }
-}
-
-/**
- * Error thrown when authorization fails (403 errors)
- * Common scenarios:
- * - Insufficient permissions
- * - Access denied to resource
- * - Invalid scope
- */
-class AuthorizationError extends UiPathError {
-    constructor(params = {}) {
-        super(ErrorType.AUTHORIZATION, {
-            message: params.message || ErrorMessages.ACCESS_DENIED,
-            statusCode: params.statusCode ?? HttpStatus.FORBIDDEN,
-            requestId: params.requestId
-        });
-    }
-}
-
-/**
- * Error thrown when validation fails (400 errors or client-side validation)
- * Common scenarios:
- * - Invalid input parameters
- * - Missing required fields
- * - Invalid data format
- */
-class ValidationError extends UiPathError {
-    constructor(params = {}) {
-        super(ErrorType.VALIDATION, {
-            message: params.message || ErrorMessages.VALIDATION_FAILED,
-            statusCode: params.statusCode ?? HttpStatus.BAD_REQUEST,
-            requestId: params.requestId
-        });
-    }
-}
-
-/**
- * Error thrown when a resource is not found (404 errors)
- * Common scenarios:
- * - Resource doesn't exist
- * - Invalid ID provided
- * - Resource deleted
- */
-class NotFoundError extends UiPathError {
-    constructor(params = {}) {
-        super(ErrorType.NOT_FOUND, {
-            message: params.message || ErrorMessages.RESOURCE_NOT_FOUND,
-            statusCode: params.statusCode ?? HttpStatus.NOT_FOUND,
-            requestId: params.requestId
-        });
-    }
-}
-
-/**
- * Error thrown when rate limit is exceeded (429 errors)
- * Common scenarios:
- * - Too many requests in a time window
- * - API throttling
- */
-class RateLimitError extends UiPathError {
-    constructor(params = {}) {
-        super(ErrorType.RATE_LIMIT, {
-            message: params.message || ErrorMessages.RATE_LIMIT_EXCEEDED,
-            statusCode: params.statusCode ?? HttpStatus.TOO_MANY_REQUESTS,
-            requestId: params.requestId
-        });
-    }
-}
-
-/**
- * Error thrown when server encounters an error (5xx errors)
- * Common scenarios:
- * - Internal server error
- * - Service unavailable
- * - Gateway timeout
- */
-class ServerError extends UiPathError {
-    constructor(params = {}) {
-        super(ErrorType.SERVER, {
-            message: params.message || ErrorMessages.INTERNAL_SERVER_ERROR,
-            statusCode: params.statusCode ?? HttpStatus.INTERNAL_SERVER_ERROR,
-            requestId: params.requestId
-        });
-    }
-    /**
-     * Checks if this is a temporary error that might succeed on retry
-     */
-    get isRetryable() {
-        return this.statusCode === HttpStatus.BAD_GATEWAY ||
-            this.statusCode === HttpStatus.SERVICE_UNAVAILABLE ||
-            this.statusCode === HttpStatus.GATEWAY_TIMEOUT;
-    }
-}
-
-/**
- * Error thrown when network/connection issues occur
- * Common scenarios:
- * - Connection timeout
- * - DNS resolution failure
- * - Network unreachable
- * - Request aborted
- */
-class NetworkError extends UiPathError {
-    constructor(params = {}) {
-        super(ErrorType.NETWORK, {
-            message: params.message || ErrorMessages.NETWORK_ERROR,
-            statusCode: params.statusCode, // Network errors typically don't have HTTP status codes
-            requestId: params.requestId
-        });
-    }
-}
-
-/**
- * Type guards for error response types
- */
-function isOrchestratorError(error) {
-    return typeof error === 'object' &&
-        error !== null &&
-        'message' in error &&
-        'errorCode' in error &&
-        typeof error.message === 'string' &&
-        typeof error.errorCode === 'number';
-}
-function isEntityError(error) {
-    return typeof error === 'object' &&
-        error !== null &&
-        'error' in error &&
-        typeof error.error === 'string';
-}
-function isPimsError(error) {
-    return typeof error === 'object' &&
-        error !== null &&
-        'type' in error &&
-        'title' in error &&
-        'status' in error &&
-        typeof error.type === 'string' &&
-        typeof error.title === 'string' &&
-        typeof error.status === 'number';
-}
-
 /**
  * Parser for Orchestrator/Task error format
  */
@@ -447,6 +283,173 @@ class ErrorResponseParser {
 // Export singleton instance
 const errorResponseParser = new ErrorResponseParser();
 
+/**
+ * Base error class for all UiPath SDK errors
+ * Extends Error for standard error handling compatibility
+ */
+class UiPathError extends Error {
+    constructor(type, params) {
+        super(params.message);
+        this.name = type;
+        this.type = type;
+        this.statusCode = params.statusCode;
+        this.requestId = params.requestId;
+        this.timestamp = new Date();
+        // Maintains proper stack trace for where our error was thrown
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+    }
+    /**
+     * Returns a clean JSON representation of the error
+     */
+    toJSON() {
+        return {
+            type: this.type,
+            message: this.message,
+            statusCode: this.statusCode,
+            requestId: this.requestId,
+            timestamp: this.timestamp
+        };
+    }
+    /**
+     * Returns detailed debug information including stack trace
+     */
+    getDebugInfo() {
+        return {
+            ...this.toJSON(),
+            stack: this.stack
+        };
+    }
+}
+
+/**
+ * Error thrown when authentication fails (401 errors)
+ * Common scenarios:
+ * - Invalid credentials
+ * - Expired token
+ * - Missing authentication
+ */
+class AuthenticationError extends UiPathError {
+    constructor(params = {}) {
+        super(ErrorType.AUTHENTICATION, {
+            message: params.message || ErrorMessages.AUTHENTICATION_FAILED,
+            statusCode: params.statusCode ?? HttpStatus.UNAUTHORIZED,
+            requestId: params.requestId
+        });
+    }
+}
+
+/**
+ * Error thrown when authorization fails (403 errors)
+ * Common scenarios:
+ * - Insufficient permissions
+ * - Access denied to resource
+ * - Invalid scope
+ */
+class AuthorizationError extends UiPathError {
+    constructor(params = {}) {
+        super(ErrorType.AUTHORIZATION, {
+            message: params.message || ErrorMessages.ACCESS_DENIED,
+            statusCode: params.statusCode ?? HttpStatus.FORBIDDEN,
+            requestId: params.requestId
+        });
+    }
+}
+
+/**
+ * Error thrown when validation fails (400 errors or client-side validation)
+ * Common scenarios:
+ * - Invalid input parameters
+ * - Missing required fields
+ * - Invalid data format
+ */
+class ValidationError extends UiPathError {
+    constructor(params = {}) {
+        super(ErrorType.VALIDATION, {
+            message: params.message || ErrorMessages.VALIDATION_FAILED,
+            statusCode: params.statusCode ?? HttpStatus.BAD_REQUEST,
+            requestId: params.requestId
+        });
+    }
+}
+
+/**
+ * Error thrown when a resource is not found (404 errors)
+ * Common scenarios:
+ * - Resource doesn't exist
+ * - Invalid ID provided
+ * - Resource deleted
+ */
+class NotFoundError extends UiPathError {
+    constructor(params = {}) {
+        super(ErrorType.NOT_FOUND, {
+            message: params.message || ErrorMessages.RESOURCE_NOT_FOUND,
+            statusCode: params.statusCode ?? HttpStatus.NOT_FOUND,
+            requestId: params.requestId
+        });
+    }
+}
+
+/**
+ * Error thrown when rate limit is exceeded (429 errors)
+ * Common scenarios:
+ * - Too many requests in a time window
+ * - API throttling
+ */
+class RateLimitError extends UiPathError {
+    constructor(params = {}) {
+        super(ErrorType.RATE_LIMIT, {
+            message: params.message || ErrorMessages.RATE_LIMIT_EXCEEDED,
+            statusCode: params.statusCode ?? HttpStatus.TOO_MANY_REQUESTS,
+            requestId: params.requestId
+        });
+    }
+}
+
+/**
+ * Error thrown when server encounters an error (5xx errors)
+ * Common scenarios:
+ * - Internal server error
+ * - Service unavailable
+ * - Gateway timeout
+ */
+class ServerError extends UiPathError {
+    constructor(params = {}) {
+        super(ErrorType.SERVER, {
+            message: params.message || ErrorMessages.INTERNAL_SERVER_ERROR,
+            statusCode: params.statusCode ?? HttpStatus.INTERNAL_SERVER_ERROR,
+            requestId: params.requestId
+        });
+    }
+    /**
+     * Checks if this is a temporary error that might succeed on retry
+     */
+    get isRetryable() {
+        return this.statusCode === HttpStatus.BAD_GATEWAY ||
+            this.statusCode === HttpStatus.SERVICE_UNAVAILABLE ||
+            this.statusCode === HttpStatus.GATEWAY_TIMEOUT;
+    }
+}
+
+/**
+ * Error thrown when network/connection issues occur
+ * Common scenarios:
+ * - Connection timeout
+ * - DNS resolution failure
+ * - Network unreachable
+ * - Request aborted
+ */
+class NetworkError extends UiPathError {
+    constructor(params = {}) {
+        super(ErrorType.NETWORK, {
+            message: params.message || ErrorMessages.NETWORK_ERROR,
+            statusCode: params.statusCode, // Network errors typically don't have HTTP status codes
+            requestId: params.requestId
+        });
+    }
+}
+
 /**
  * Factory for creating typed errors based on HTTP status codes
  * Follows the Factory pattern for clean error instantiation
@@ -540,29 +543,7 @@ class ApiClient {
      * @throws AuthenticationError if no token available or refresh fails
      */
     async getValidToken() {
-        // Try to get token info from context
-        const tokenInfo = this.executionContext.get('tokenInfo');
-        if (!tokenInfo) {
-            throw new AuthenticationError({ message: 'No authentication token available. Make sure to initialize the SDK first.' });
-        }
-        // For secret-based tokens, they never expire
-        if (tokenInfo.type === 'secret') {
-            return tokenInfo.token;
-        }
-        // If token is not expired, return it
-        if (!this.tokenManager.isTokenExpired(tokenInfo)) {
-            return tokenInfo.token;
-        }
-        try {
-            const newToken = await this.tokenManager.refreshAccessToken();
-            return newToken.access_token;
-        }
-        catch (error) {
-            throw new AuthenticationError({
-                message: `Token refresh failed: ${error.message}. Please re-authenticate.`,
-                statusCode: HttpStatus.UNAUTHORIZED
-            });
-        }
+        return this.tokenManager.getValidToken();
     }
     async getDefaultHeaders() {
         // Get headers from execution context first
@@ -1277,10 +1258,7 @@ class PaginationHelpers {
      */
     static async getAll(config, options) {
         const optionsWithDefaults = options || {};
-        const { folderId, ...restOptions } = optionsWithDefaults;
-        const cursor = options?.cursor;
-        const pageSize = options?.pageSize;
-        const jumpToPage = options?.jumpToPage;
+        const { folderId, pageSize, cursor, jumpToPage, ...restOptions } = optionsWithDefaults;
         // Determine if pagination is requested
         const isPaginationRequested = PaginationHelpers.hasPaginationParameters(options || {});
         // Process parameters (custom processing if provided, otherwise default)
@@ -1668,14 +1646,14 @@ class FolderScopedService extends BaseService {
     }
 }
 
-/**
- * API Endpoint Constants
- * Centralized location for all API endpoints used throughout the SDK
- */
 /**
  * Base path constants for different services
  */
 const ORCHESTRATOR_BASE = 'orchestrator_';
+
+/**
+ * Orchestrator Service Endpoints
+ */
 /**
  * Orchestrator Asset Service Endpoints
  */
@@ -1699,7 +1677,7 @@ const AssetMap = {
 // 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.0.0";
+const SDK_VERSION = "1.1.0";
 const VERSION = "Version";
 const SERVICE = "Service";
 const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
@@ -1876,7 +1854,6 @@ class TelemetryClient {
      */
     getEnrichedAttributes(extraAttributes, eventName) {
         const attributes = {
-            ...extraAttributes,
             [APP_NAME]: SDK_SERVICE_NAME,
             [VERSION]: SDK_VERSION,
             [SERVICE]: eventName,
@@ -1885,6 +1862,7 @@ class TelemetryClient {
             [CLOUD_TENANT_NAME]: this.telemetryContext?.tenantName || UNKNOWN,
             [CLOUD_REDIRECT_URI]: this.telemetryContext?.redirectUri || UNKNOWN,
             [CLOUD_CLIENT_ID]: this.telemetryContext?.clientId || UNKNOWN,
+            ...extraAttributes,
         };
         return attributes;
     }