@uipath/uipath-typescript 1.2.2 → 1.3.0

package/dist/index.umd.js

@@ -4522,6 +4522,7 @@
      */
     const JOB_ENDPOINTS = {
         GET_ALL: `${ORCHESTRATOR_BASE}/odata/Jobs`,
+        GET_BY_KEY: (identifier) => `${ORCHESTRATOR_BASE}/odata/Jobs/UiPath.Server.Configuration.OData.GetByKey(identifier=${identifier})`,
     };
     /**
      * Orchestrator Asset Service Endpoints
@@ -9176,7 +9177,7 @@
     // 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.2.2";
+    const SDK_VERSION = "1.3.0";
     const VERSION = "Version";
     const SERVICE = "Service";
     const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
@@ -11680,11 +11681,7 @@
                 expansionLevel: options.expansionLevel
             });
             const response = await this.get(DATA_FABRIC_ENDPOINTS.ENTITY.GET_RECORD_BY_ID(entityId, recordId), { params });
-            // Convert PascalCase response to camelCase
-            const camelResponse = pascalToCamelCaseKeys(response.data);
-            // Apply EntityMap transformations
-            const transformedResponse = transformData(camelResponse, EntityMap);
-            return transformedResponse;
+            return response.data;
         }
         /**
          * Inserts a single record into an entity by entity ID
@@ -11717,9 +11714,7 @@
                 params,
                 ...options
             });
-            // Convert PascalCase response to camelCase
-            const camelResponse = pascalToCamelCaseKeys(response.data);
-            return camelResponse;
+            return response.data;
         }
         /**
          * Inserts data into an entity by entity ID using batch insert
@@ -11760,9 +11755,7 @@
                 params,
                 ...options
             });
-            // Convert PascalCase response to camelCase
-            const camelResponse = pascalToCamelCaseKeys(response.data);
-            return camelResponse;
+            return response.data;
         }
         /**
          * Updates a single record in an entity by entity ID
@@ -11796,9 +11789,7 @@
                 params,
                 ...options
             });
-            // Convert PascalCase response to camelCase
-            const camelResponse = pascalToCamelCaseKeys(response.data);
-            return camelResponse;
+            return response.data;
         }
         /**
          * Updates data in an entity by entity ID
@@ -11840,9 +11831,7 @@
                 params,
                 ...options
             });
-            // Convert PascalCase response to camelCase
-            const camelResponse = pascalToCamelCaseKeys(response.data);
-            return camelResponse;
+            return response.data;
         }
         /**
          * Deletes data from an entity by entity ID
@@ -11872,9 +11861,7 @@
                 params,
                 ...options
             });
-            // Convert PascalCase response to camelCase
-            const camelResponse = pascalToCamelCaseKeys(response.data);
-            return camelResponse;
+            return response.data;
         }
         /**
          * Gets all entities in the system
@@ -11926,7 +11913,7 @@
          *
          * // Get the recordId from getAllRecords()
          * const records = await entities.getAllRecords(entityId);
-         * const recordId = records[0].id;
+         * const recordId = records[0].Id;
          *
          * // Download attachment for a specific record and field
          * const blob = await entities.downloadAttachment(entityId, recordId, 'Documents');
@@ -11960,7 +11947,7 @@
          *
          * // Get the recordId from getAllRecords()
          * const records = await entities.getAllRecords(entityId);
-         * const recordId = records[0].id;
+         * const recordId = records[0].Id;
          *
          * // Upload a file attachment
          * const response = await entities.uploadAttachment(entityId, recordId, 'Documents', file);
@@ -11976,9 +11963,7 @@
             }
             const params = createParams({ expansionLevel: options?.expansionLevel });
             const response = await this.post(DATA_FABRIC_ENDPOINTS.ENTITY.UPLOAD_ATTACHMENT(entityId, recordId, fieldName), formData, { params });
-            // Convert PascalCase response to camelCase
-            const camelResponse = pascalToCamelCaseKeys(response.data);
-            return camelResponse;
+            return response.data;
         }
         /**
          * Removes an attachment from a File-type field of an entity record
@@ -12000,7 +11985,7 @@
          *
          * // Get the recordId from getAllRecords()
          * const records = await entities.getAllRecords(entityId);
-         * const recordId = records[0].id;
+         * const recordId = records[0].Id;
          *
          * // Delete attachment for a specific record and field
          * await entities.deleteAttachment(entityId, recordId, 'Documents');
@@ -14719,6 +14704,36 @@
         BucketOptions["AccessDataThroughOrchestrator"] = "AccessDataThroughOrchestrator";
     })(exports.BucketOptions || (exports.BucketOptions = {}));
 
+    /**
+     * Creates methods for a job response object.
+     *
+     * @param jobData - The raw job data from API
+     * @param service - The job service instance
+     * @returns Object containing job methods
+     */
+    function createJobMethods(jobData, service) {
+        return {
+            async getOutput() {
+                if (!jobData.key)
+                    throw new Error('Job key is undefined');
+                if (!jobData.folderId)
+                    throw new Error('Job folderId is undefined');
+                return service.getOutput(jobData.key, jobData.folderId);
+            },
+        };
+    }
+    /**
+     * Creates a job response with bound methods.
+     *
+     * @param jobData - The raw job data from API
+     * @param service - The job service instance
+     * @returns A job object with added methods
+     */
+    function createJobWithMethods(jobData, service) {
+        const methods = createJobMethods(jobData, service);
+        return Object.assign({}, jobData, methods);
+    }
+
     /**
      * Maps fields for Job entities to ensure consistent naming
      * Semantic renames only — case conversion handled by pascalToCamelCaseKeys()
@@ -14734,27 +14749,81 @@
         release: 'process',
     };
 
+    /**
+     * Maps fields for Attachment entities to ensure consistent naming
+     */
+    const AttachmentsMap = {
+        creationTime: 'createdTime',
+        lastModificationTime: 'lastModifiedTime'
+    };
+
+    class AttachmentService extends BaseService {
+        /**
+         * Gets an attachment by ID
+         * @param id - The UUID of the attachment to retrieve
+         * @param options - Optional query parameters (expand, select)
+         * @returns Promise resolving to the attachment
+         *
+         * @example
+         * ```typescript
+         * import { Attachments } from '@uipath/uipath-typescript/attachments';
+         *
+         * const attachments = new Attachments(sdk);
+         * const attachment = await attachments.getById('12345678-1234-1234-1234-123456789abc');
+         * ```
+         */
+        async getById(id, options = {}) {
+            if (!id) {
+                throw new ValidationError({ message: 'id is required for getById' });
+            }
+            // Prefix all keys in options with $ for OData
+            const keysToPrefix = Object.keys(options);
+            const apiOptions = addPrefixToKeys(options, ODATA_PREFIX, keysToPrefix);
+            const response = await this.get(ORCHESTRATOR_ATTACHMENT_ENDPOINTS.GET_BY_ID(id), {
+                params: apiOptions,
+            });
+            // Transform response from PascalCase to camelCase, then apply field maps
+            const camelCased = pascalToCamelCaseKeys(response.data);
+            camelCased.blobFileAccess = transformData(camelCased.blobFileAccess, BucketMap);
+            return transformData(camelCased, AttachmentsMap);
+        }
+    }
+    __decorate([
+        track('Attachments.GetById')
+    ], AttachmentService.prototype, "getById", null);
+
     /**
      * Service for interacting with UiPath Orchestrator Jobs API
      */
     class JobService extends FolderScopedService {
         /**
-         * Gets all jobs across folders with optional filtering
+         * Creates an instance of the Jobs service.
          *
-         * @param options - Query options including optional folderId and pagination options
-         * @returns Promise resolving to array of jobs or paginated response
+         * @param instance - UiPath SDK instance providing authentication and configuration
+         */
+        constructor(instance) {
+            super(instance);
+            this.attachmentService = new AttachmentService(instance);
+        }
+        /**
+         * Gets all jobs across folders with optional filtering and pagination.
          *
-         * @example
-         * ```typescript
-         * import { Jobs } from '@uipath/uipath-typescript/jobs';
+         * Returns jobs with full details including state, timing, and input/output arguments.
+         * Pass `folderId` to scope the query to a specific folder.
          *
-         * const jobs = new Jobs(sdk);
+         * !!! info "Input and output fields are not included in `getAll` responses"
+         *     The `inputArguments`, `inputFile`, `outputArguments`, and `outputFile` fields will always be `null` in the `getAll` response. To retrieve a job's output, use the {@link getOutput} method with the job's `key` and `folderId`.
          *
+         * @param options - Query options including optional folderId, filtering, and pagination options
+         * @returns Promise resolving to either an array of jobs {@link NonPaginatedResponse}<{@link JobGetResponse}> or a {@link PaginatedResponse}<{@link JobGetResponse}> when pagination options are used.
+         * {@link JobGetResponse}
+         * @example
+         * ```typescript
          * // Get all jobs
          * const allJobs = await jobs.getAll();
          *
          * // Get all jobs in a specific folder
-         * const folderJobs = await jobs.getAll({ folderId: 123 });
+         * const folderJobs = await jobs.getAll({ folderId: <folderId> });
          *
          * // With filtering
          * const runningJobs = await jobs.getAll({
@@ -14768,10 +14837,19 @@
          * if (page1.hasNextPage) {
          *   const page2 = await jobs.getAll({ cursor: page1.nextCursor });
          * }
+         *
+         * // Jump to specific page
+         * const page5 = await jobs.getAll({
+         *   jumpToPage: 5,
+         *   pageSize: 10
+         * });
          * ```
          */
         async getAll(options) {
-            const transformJobResponse = (job) => transformData(pascalToCamelCaseKeys(job), JobMap);
+            const transformJobResponse = (job) => {
+                const rawJob = transformData(pascalToCamelCaseKeys(job), JobMap);
+                return createJobWithMethods(rawJob, this);
+            };
             return PaginationHelpers.getAll({
                 serviceAccess: this.createPaginationServiceAccess(),
                 getEndpoint: () => JOB_ENDPOINTS.GET_ALL,
@@ -14789,10 +14867,111 @@
                 },
             }, options);
         }
+        /**
+         * Gets the output of a completed job.
+         *
+         * Retrieves the job's output arguments, handling both inline output (stored directly on the job
+         * as a JSON string in `outputArguments`) and file-based output (stored as a blob attachment for
+         * large outputs). Returns the parsed JSON output or `null` if the job has no output.
+         *
+         * @param jobKey - The unique key (GUID) of the job to retrieve output from
+         * @param folderId - The folder ID where the job resides
+         * @returns Promise resolving to the parsed output as `Record<string, unknown>`, or `null` if no output exists
+         *
+         * @example
+         * ```typescript
+         * // Get output from a completed job
+         * const output = await jobs.getOutput(<jobKey>, <folderId>);
+         *
+         * if (output) {
+         *   console.log('Job output:', output);
+         * }
+         * ```
+         *
+         * @example
+         * ```typescript
+         * // Get output using bound method (jobKey and folderId are taken from the job object)
+         * const allJobs = await jobs.getAll();
+         * const completedJob = allJobs.items.find(j => j.state === JobState.Successful);
+         *
+         * if (completedJob) {
+         *   const output = await completedJob.getOutput();
+         * }
+         * ```
+         */
+        async getOutput(jobKey, folderId) {
+            if (!jobKey) {
+                throw new ValidationError({ message: 'jobKey is required for getOutput' });
+            }
+            const job = await this.fetchJobByKey(jobKey, folderId);
+            if (job.OutputArguments) {
+                try {
+                    return JSON.parse(job.OutputArguments);
+                }
+                catch {
+                    throw new ServerError({ message: 'Failed to parse job output arguments as JSON' });
+                }
+            }
+            if (job.OutputFile) {
+                return this.downloadOutputFile(job.OutputFile);
+            }
+            return null;
+        }
+        /**
+         * Fetches a job by its Key (GUID) using the GetByKey endpoint.
+         * Only selects fields needed for output extraction.
+         */
+        async fetchJobByKey(jobKey, folderId) {
+            const headers = createHeaders({ [FOLDER_ID]: folderId });
+            const response = await this.get(JOB_ENDPOINTS.GET_BY_KEY(jobKey), {
+                params: {
+                    $select: 'OutputArguments,OutputFile',
+                },
+                headers,
+            });
+            return response.data;
+        }
+        /**
+         * Downloads the output file content via the Attachments API.
+         * 1. Fetches blob access info from the attachment using AttachmentService
+         * 2. Downloads content from the presigned blob URI
+         * 3. Parses and returns the JSON content
+         */
+        async downloadOutputFile(outputFileKey) {
+            const attachment = await this.attachmentService.getById(outputFileKey);
+            const blobAccess = attachment.blobFileAccess;
+            if (!blobAccess?.uri) {
+                return null;
+            }
+            const blobHeaders = { ...blobAccess.headers };
+            // Add auth header if the blob URI requires authenticated access
+            if (blobAccess.requiresAuth) {
+                const token = await this.getValidAuthToken();
+                blobHeaders['Authorization'] = `Bearer ${token}`;
+            }
+            const blobResponse = await fetch(blobAccess.uri, {
+                method: 'GET',
+                headers: blobHeaders,
+            });
+            if (!blobResponse.ok) {
+                const errorInfo = await errorResponseParser.parse(blobResponse);
+                throw ErrorFactory.createFromHttpStatus(blobResponse.status, errorInfo);
+            }
+            const content = await blobResponse.text();
+            try {
+                return JSON.parse(content);
+            }
+            catch {
+                throw new ServerError({ message: 'Failed to parse job output file as JSON' });
+            }
+        }
     }
     __decorate([
         track('Jobs.GetAll')
     ], JobService.prototype, "getAll", null);
+    __decorate([
+        track('Jobs.GetOutput')
+    ], JobService.prototype, "getOutput", null);
 
     /**
      * Enum for job sub-state
@@ -14819,6 +14998,22 @@
         ServerlessJobType["PythonAgent"] = "PythonAgent";
     })(exports.ServerlessJobType || (exports.ServerlessJobType = {}));
 
+    /**
+     * Common enum for job state used across services
+     */
+    exports.JobState = void 0;
+    (function (JobState) {
+        JobState["Pending"] = "Pending";
+        JobState["Running"] = "Running";
+        JobState["Stopping"] = "Stopping";
+        JobState["Terminating"] = "Terminating";
+        JobState["Faulted"] = "Faulted";
+        JobState["Successful"] = "Successful";
+        JobState["Stopped"] = "Stopped";
+        JobState["Suspended"] = "Suspended";
+        JobState["Resumed"] = "Resumed";
+    })(exports.JobState || (exports.JobState = {}));
+
     /**
      * Maps fields for Process entities to ensure consistent naming
      */
@@ -15275,49 +15470,6 @@
         track('Queues.GetById')
     ], QueueService.prototype, "getById", null);
 
-    /**
-     * Maps fields for Attachment entities to ensure consistent naming
-     */
-    const AttachmentsMap = {
-        creationTime: 'createdTime',
-        lastModificationTime: 'lastModifiedTime'
-    };
-
-    class AttachmentService extends BaseService {
-        /**
-         * Gets an attachment by ID
-         * @param id - The UUID of the attachment to retrieve
-         * @param options - Optional query parameters (expand, select)
-         * @returns Promise resolving to the attachment
-         *
-         * @example
-         * ```typescript
-         * import { Attachments } from '@uipath/uipath-typescript/attachments';
-         *
-         * const attachments = new Attachments(sdk);
-         * const attachment = await attachments.getById('12345678-1234-1234-1234-123456789abc');
-         * ```
-         */
-        async getById(id, options = {}) {
-            if (!id) {
-                throw new ValidationError({ message: 'id is required for getById' });
-            }
-            // Prefix all keys in options with $ for OData
-            const keysToPrefix = Object.keys(options);
-            const apiOptions = addPrefixToKeys(options, ODATA_PREFIX, keysToPrefix);
-            const response = await this.get(ORCHESTRATOR_ATTACHMENT_ENDPOINTS.GET_BY_ID(id), {
-                params: apiOptions,
-            });
-            // Transform response from PascalCase to camelCase, then apply field maps
-            const camelCased = pascalToCamelCaseKeys(response.data);
-            camelCased.blobFileAccess = transformData(camelCased.blobFileAccess, BucketMap);
-            return transformData(camelCased, AttachmentsMap);
-        }
-    }
-    __decorate([
-        track('Attachments.GetById')
-    ], AttachmentService.prototype, "getById", null);
-
     /**
      * UiPath SDK - Legacy class providing all services through property getters.
      *
@@ -15433,22 +15585,6 @@
         }
     }
 
-    /**
-     * Common enum for job state used across services
-     */
-    exports.JobState = void 0;
-    (function (JobState) {
-        JobState["Pending"] = "Pending";
-        JobState["Running"] = "Running";
-        JobState["Stopping"] = "Stopping";
-        JobState["Terminating"] = "Terminating";
-        JobState["Faulted"] = "Faulted";
-        JobState["Successful"] = "Successful";
-        JobState["Stopped"] = "Stopped";
-        JobState["Suspended"] = "Suspended";
-        JobState["Resumed"] = "Resumed";
-    })(exports.JobState || (exports.JobState = {}));
-
     /**
      * Common Constants for Conversational Agent
      */
@@ -15821,6 +15957,7 @@
     exports.createCaseInstanceWithMethods = createCaseInstanceWithMethods;
     exports.createConversationWithMethods = createConversationWithMethods;
     exports.createEntityWithMethods = createEntityWithMethods;
+    exports.createJobWithMethods = createJobWithMethods;
     exports.createProcessInstanceWithMethods = createProcessInstanceWithMethods;
     exports.createProcessWithMethods = createProcessWithMethods;
     exports.createTaskWithMethods = createTaskWithMethods;