@uipath/uipath-typescript 1.2.2 → 1.3.0

package/dist/jobs/index.cjs

@@ -1644,6 +1644,36 @@ class FolderScopedService extends BaseService {
     }
 }
 
+/**
+ * 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);
+}
+
 /**
  * Base path constants for different services
  */
@@ -1657,6 +1687,13 @@ const ORCHESTRATOR_BASE = 'orchestrator_';
  */
 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 Attachment Service Endpoints
+ */
+const ORCHESTRATOR_ATTACHMENT_ENDPOINTS = {
+    GET_BY_ID: (id) => `${ORCHESTRATOR_BASE}/odata/Attachments(${id})`,
 };
 
 /**
@@ -1680,7 +1717,7 @@ const JobMap = {
 // 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";
@@ -1906,8 +1943,9 @@ function createTrackedFunction(originalFunction, nameOrOptions, fallbackName, op
         // Track the event if enabled
         if (shouldTrack) {
             // Use the full name provided in the decorator (e.g., "Queue.GetAll")
-            const serviceMethod = nameOrOptions
-                ;
+            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);
         }
@@ -1936,7 +1974,7 @@ function createTrackedFunction(originalFunction, nameOrOptions, fallbackName, op
  */
 function track(nameOrOptions, options) {
     return function decorator(_target, propertyKey, descriptor) {
-        const opts = {};
+        const opts = typeof nameOrOptions === 'object' ? nameOrOptions : {};
         if (descriptor && typeof descriptor.value === 'function') {
             // Method decorator
             descriptor.value = createTrackedFunction(descriptor.value, nameOrOptions, propertyKey || 'unknown_method', opts);
@@ -1947,27 +1985,90 @@ function track(nameOrOptions, options) {
     };
 }
 
+/**
+ * Maps fields for Attachment entities to ensure consistent naming
+ */
+const AttachmentsMap = {
+    creationTime: 'createdTime',
+    lastModificationTime: 'lastModifiedTime'
+};
+
+/**
+ * Maps fields for Bucket entities to ensure consistent naming
+ */
+const BucketMap = {
+    fullPath: 'path',
+    items: 'blobItems',
+    verb: 'httpMethod'
+};
+
+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 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.
+     *
+     * Returns jobs with full details including state, timing, and input/output arguments.
+     * Pass `folderId` to scope the query to a specific folder.
      *
-     * @param options - Query options including optional folderId and pagination options
-     * @returns Promise resolving to array of jobs or paginated response
+     * !!! 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
-     * import { Jobs } from '@uipath/uipath-typescript/jobs';
-     *
-     * const jobs = new Jobs(sdk);
-     *
      * // 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({
@@ -1981,10 +2082,19 @@ class JobService extends FolderScopedService {
      * 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,
@@ -2002,10 +2112,111 @@ class JobService extends FolderScopedService {
             },
         }, 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
@@ -2032,5 +2243,22 @@ exports.ServerlessJobType = void 0;
     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 = {}));
+
 exports.JobService = JobService;
 exports.Jobs = JobService;
+exports.createJobWithMethods = createJobWithMethods;

package/dist/jobs/index.d.ts

@@ -523,9 +523,9 @@ interface ProcessMetadata {
     id?: number;
 }
 /**
- * Interface for job response
+ * Raw job response from the API before method attachment
  */
-interface JobGetResponse extends FolderProperties {
+interface RawJobGetResponse extends FolderProperties {
     /** The unique numeric identifier of the job */
     id: number;
     /** The unique job identifier (GUID) */
@@ -552,6 +552,8 @@ interface JobGetResponse extends FolderProperties {
     inputArguments: string | null;
     /** Output parameters as a JSON string resulted from job execution */
     outputArguments: string | null;
+    /** Attachment key for file-based output when output is too large for inline arguments */
+    outputFile: string | null;
     /** Environment variables as a JSON string passed to the job execution */
     environmentVariables: string | null;
     /** Additional information about the current job */
@@ -627,6 +629,7 @@ type JobGetAllOptions = RequestOptions & PaginationOptions & {
     folderId?: number;
 };
 
+type JobGetResponse = RawJobGetResponse & JobMethods;
 /**
  * Service for managing UiPath Orchestrator Jobs.
  *
@@ -645,9 +648,15 @@ type JobGetAllOptions = RequestOptions & PaginationOptions & {
  */
 interface JobServiceModel {
     /**
-     * Gets all jobs across folders with optional filtering
+     * Gets all jobs across folders with optional filtering and pagination.
      *
-     * @param options - Query options including optional folderId and pagination options
+     * Returns jobs with full details including state, timing, and input/output arguments.
+     * Pass `folderId` to scope the query to a specific folder.
+     *
+     * !!! 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
@@ -679,29 +688,105 @@ interface JobServiceModel {
      * ```
      */
     getAll<T extends JobGetAllOptions = JobGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<JobGetResponse> : NonPaginatedResponse<JobGetResponse>>;
+    /**
+     * 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();
+     * }
+     * ```
+     */
+    getOutput(jobKey: string, folderId: number): Promise<Record<string, unknown> | null>;
 }
+/**
+ * Methods available on job response objects.
+ * These are bound to the job data and delegate to the service.
+ */
+interface JobMethods {
+    /**
+     * Gets the output of this 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.
+     *
+     * @returns Promise resolving to the parsed output as `Record<string, unknown>`, or `null` if no output exists
+     *
+     * @example
+     * ```typescript
+     * const allJobs = await jobs.getAll();
+     * const completedJob = allJobs.items.find(j => j.state === JobState.Successful);
+     *
+     * if (completedJob) {
+     *   const output = await completedJob.getOutput();
+     * }
+     * ```
+     */
+    getOutput(): Promise<Record<string, unknown> | null>;
+}
+/**
+ * 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
+ */
+declare function createJobWithMethods(jobData: RawJobGetResponse, service: JobServiceModel): JobGetResponse;
 
 /**
  * Service for interacting with UiPath Orchestrator Jobs API
  */
 declare class JobService extends FolderScopedService implements JobServiceModel {
+    private attachmentService;
     /**
-     * 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: IUiPath);
+    /**
+     * 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({
@@ -715,10 +800,61 @@ declare class JobService extends FolderScopedService implements JobServiceModel
      * if (page1.hasNextPage) {
      *   const page2 = await jobs.getAll({ cursor: page1.nextCursor });
      * }
+     *
+     * // Jump to specific page
+     * const page5 = await jobs.getAll({
+     *   jumpToPage: 5,
+     *   pageSize: 10
+     * });
      * ```
      */
     getAll<T extends JobGetAllOptions = JobGetAllOptions>(options?: T): Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<JobGetResponse> : NonPaginatedResponse<JobGetResponse>>;
+    /**
+     * 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();
+     * }
+     * ```
+     */
+    getOutput(jobKey: string, folderId: number): Promise<Record<string, unknown> | null>;
+    /**
+     * Fetches a job by its Key (GUID) using the GetByKey endpoint.
+     * Only selects fields needed for output extraction.
+     */
+    private fetchJobByKey;
+    /**
+     * 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
+     */
+    private downloadOutputFile;
 }
 
-export { JobService, JobSubState, JobService as Jobs, ServerlessJobType };
-export type { JobGetAllOptions, JobGetResponse, JobServiceModel, ProcessMetadata };
+export { JobService, JobState, JobSubState, JobService as Jobs, ServerlessJobType, createJobWithMethods };
+export type { JobGetAllOptions, JobGetResponse, JobMethods, JobServiceModel, ProcessMetadata, RawJobGetResponse };