@uipath/uipath-typescript 1.3.11 → 1.4.0

package/dist/cases/index.d.ts

@@ -109,6 +109,35 @@ interface GetTopDurationResponse extends GetTopBaseResponse {
     /** Total execution duration in milliseconds */
     duration: number;
 }
+/**
+ * Element count by status for a BPMN element within a process or case
+ */
+interface ElementStats {
+    /** BPMN element identifier */
+    elementId: string;
+    /** Number of successful executions */
+    successCount: number;
+    /** Number of failed executions */
+    failCount: number;
+    /** Number of terminated executions */
+    terminatedCount: number;
+    /** Number of paused executions */
+    pausedCount: number;
+    /** Number of in-progress executions */
+    inProgressCount: number;
+    /** Minimum duration in milliseconds */
+    minDurationMs: number;
+    /** Maximum duration in milliseconds */
+    maxDurationMs: number;
+    /** Average duration in milliseconds */
+    avgDurationMs: number;
+    /** 50th percentile (median) duration in milliseconds */
+    p50DurationMs: number;
+    /** 95th percentile duration in milliseconds */
+    p95DurationMs: number;
+    /** 99th percentile duration in milliseconds */
+    p99DurationMs: number;
+}
 
 /**
  * Simplified universal pagination cursor
@@ -293,8 +322,7 @@ interface CaseGetTopDurationResponse extends GetTopDurationResponse {
  */
 interface CasesServiceModel {
     /**
-     * @returns Promise resolving to array of Case objects
-     * {@link CaseGetAllResponse}
+     * @returns Promise resolving to an array of {@link CaseGetAllWithMethodsResponse}
      * @example
      * ```typescript
      * // Get all case management processes
@@ -308,7 +336,7 @@ interface CasesServiceModel {
      * }
      * ```
      */
-    getAll(): Promise<CaseGetAllResponse[]>;
+    getAll(): Promise<CaseGetAllWithMethodsResponse[]>;
     /**
      * Get the top 5 case processes ranked by run count within a time range.
      *
@@ -502,7 +530,58 @@ interface CasesServiceModel {
      * ```
      */
     getTopExecutionDuration(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopDurationResponse[]>;
+    /**
+     * Get element stats for case instances
+     *
+     * Returns per-element execution counts (success, fail, terminated, paused, in-progress) and
+     * duration percentile metrics (min, max, avg, p50, p95, p99) for BPMN elements within a case.
+     *
+     * @param processKey - Process key to filter by
+     * @param packageId - Package identifier
+     * @param startTime - Start of the time range to query
+     * @param endTime - End of the time range to query
+     * @param packageVersion - Package version to filter by
+     * @returns Promise resolving to an array of {@link ElementStats}
+     * @example
+     * ```typescript
+     * // Get element metrics for a case
+     * const elements = await cases.getElementStats(
+     *   '<processKey>',
+     *   '<packageId>',
+     *   new Date('2026-04-01'),
+     *   new Date(),
+     *   '1.0.1'
+     * );
+     *
+     * // Find elements with failures
+     * const failedElements = elements.filter(e => e.failCount > 0);
+     * for (const element of failedElements) {
+     *   console.log(`Failed element: ${element.elementId}, failures: ${element.failCount}`);
+     * }
+     * ```
+     */
+    getElementStats(processKey: string, packageId: string, startTime: Date, endTime: Date, packageVersion: string): Promise<ElementStats[]>;
+}
+interface CaseMethods {
+    /**
+     * Get element stats for this case
+     *
+     * @param startTime - Start of the time range to query
+     * @param endTime - End of the time range to query
+     * @param packageVersion - Package version to filter by
+     * @returns Promise resolving to an array of {@link ElementStats}
+     */
+    getElementStats(startTime: Date, endTime: Date, packageVersion: string): Promise<ElementStats[]>;
 }
+type CaseGetAllWithMethodsResponse = CaseGetAllResponse & CaseMethods;
+/**
+ * Creates an actionable case by combining API case data with operational methods.
+ *
+ * @param caseData - The case data from API
+ * @param service - The cases service instance
+ * @returns A case object with added methods
+ */
+declare function createCaseWithMethods(caseData: CaseGetAllResponse, service: CasesServiceModel): CaseGetAllWithMethodsResponse;
 
 /**
  * Case Instance Types
@@ -1557,6 +1636,7 @@ interface RequestWithPaginationOptions extends RequestSpec {
             tokenParam?: string;
             countParam?: string;
             convertToSkip?: boolean;
+            zeroBased?: boolean;
         };
     };
 }
@@ -1755,7 +1835,7 @@ declare class BaseService {
 declare class CasesService extends BaseService implements CasesServiceModel {
     /**
      * Get all case management processes with their instance statistics
-     * @returns Promise resolving to array of Case objects
+     * @returns Promise resolving to an array of {@link CaseGetAllWithMethodsResponse}
      *
      * @example
      * ```typescript
@@ -1772,7 +1852,7 @@ declare class CasesService extends BaseService implements CasesServiceModel {
      * }
      * ```
      */
-    getAll(): Promise<CaseGetAllResponse[]>;
+    getAll(): Promise<CaseGetAllWithMethodsResponse[]>;
     /**
      * Get the top 5 case processes ranked by run count within a time range.
      *
@@ -1966,6 +2046,37 @@ declare class CasesService extends BaseService implements CasesServiceModel {
      * ```
      */
     getTopExecutionDuration(startTime: Date, endTime: Date, options?: TopQueryOptions): Promise<CaseGetTopDurationResponse[]>;
+    /**
+     * Get element stats for case instances
+     *
+     * Returns per-element execution counts (success, fail, terminated, paused, in-progress) and
+     * duration percentile metrics (min, max, avg, p50, p95, p99) for BPMN elements within a case.
+     *
+     * @param processKey - Process key to filter by
+     * @param packageId - Package identifier
+     * @param startTime - Start of the time range to query
+     * @param endTime - End of the time range to query
+     * @param packageVersion - Package version to filter by
+     * @returns Promise resolving to an array of {@link ElementStats}
+     * @example
+     * ```typescript
+     * // Get element metrics for a case
+     * const elements = await cases.getElementStats(
+     *   '<processKey>',
+     *   '<packageId>',
+     *   new Date('2026-04-01'),
+     *   new Date(),
+     *   '1.0.1'
+     * );
+     *
+     * // Find elements with failures
+     * const failedElements = elements.filter(e => e.failCount > 0);
+     * for (const element of failedElements) {
+     *   console.log(`Failed element: ${element.elementId}, failures: ${element.failCount}`);
+     * }
+     * ```
+     */
+    getElementStats(processKey: string, packageId: string, startTime: Date, endTime: Date, packageVersion: string): Promise<ElementStats[]>;
     /**
      * Extract a readable case name from the packageId
      * @param packageId - The full package identifier
@@ -2223,5 +2334,5 @@ declare class CaseInstancesService extends BaseService implements CaseInstancesS
     getStagesSlaSummary(options?: CaseInstanceStageSLAOptions): Promise<CaseInstanceStageSLAResponse[]>;
 }
 
-export { CaseInstancesService as CaseInstances, CaseInstancesService, CasesService as Cases, CasesService, EscalationActionType, EscalationRecipientScope, EscalationTriggerType, InstanceFinalStatus, InstanceStatus, SLADurationUnit, SlaSummaryStatus, StageTaskType, TimeInterval, createCaseInstanceWithMethods };
-export type { CaseAppConfig, CaseAppOverview, CaseGetAllResponse, CaseGetStageResponse, CaseGetTopDurationResponse, CaseGetTopFaultedCountResponse, CaseGetTopRunCountResponse, CaseInstanceExecutionHistoryResponse, CaseInstanceGetAllOptions, CaseInstanceGetAllWithPaginationOptions, CaseInstanceGetResponse, CaseInstanceMethods, CaseInstanceOperationOptions, CaseInstanceOperationResponse, CaseInstanceReopenOptions, CaseInstanceRun, CaseInstanceSlaSummaryOptions, CaseInstanceStageSLAOptions, CaseInstanceStageSLAResponse, CaseInstanceStageSLAStage, CaseInstancesServiceModel, CasesServiceModel, ElementExecutionMetadata, ElementGetTopFailedCountResponse, ElementRunMetadata, EscalationAction, EscalationRecipient, EscalationRule, EscalationTriggerMetadata, GetTopBaseResponse, GetTopDurationResponse, GetTopFaultedCountResponse, GetTopRunCountResponse, InstanceStatusTimelineResponse, RawCaseInstanceGetResponse, SlaSummaryResponse, StageSLA, StageTask, TimelineOptions, TopQueryOptions };
+export { CaseInstancesService as CaseInstances, CaseInstancesService, CasesService as Cases, CasesService, EscalationActionType, EscalationRecipientScope, EscalationTriggerType, InstanceFinalStatus, InstanceStatus, SLADurationUnit, SlaSummaryStatus, StageTaskType, TimeInterval, createCaseInstanceWithMethods, createCaseWithMethods };
+export type { CaseAppConfig, CaseAppOverview, CaseGetAllResponse, CaseGetAllWithMethodsResponse, CaseGetStageResponse, CaseGetTopDurationResponse, CaseGetTopFaultedCountResponse, CaseGetTopRunCountResponse, CaseInstanceExecutionHistoryResponse, CaseInstanceGetAllOptions, CaseInstanceGetAllWithPaginationOptions, CaseInstanceGetResponse, CaseInstanceMethods, CaseInstanceOperationOptions, CaseInstanceOperationResponse, CaseInstanceReopenOptions, CaseInstanceRun, CaseInstanceSlaSummaryOptions, CaseInstanceStageSLAOptions, CaseInstanceStageSLAResponse, CaseInstanceStageSLAStage, CaseInstancesServiceModel, CaseMethods, CasesServiceModel, ElementExecutionMetadata, ElementGetTopFailedCountResponse, ElementRunMetadata, ElementStats, EscalationAction, EscalationRecipient, EscalationRule, EscalationTriggerMetadata, GetTopBaseResponse, GetTopDurationResponse, GetTopFaultedCountResponse, GetTopRunCountResponse, InstanceStatusTimelineResponse, RawCaseInstanceGetResponse, SlaSummaryResponse, StageSLA, StageTask, TimelineOptions, TopQueryOptions };

package/dist/cases/index.mjs

@@ -59,6 +59,7 @@ var ProcessType;
  */
 const ORCHESTRATOR_BASE = 'orchestrator_';
 const PIMS_BASE = 'pims_';
+const LLMOPS_BASE = 'llmopstenant_';
 const INSIGHTS_RTM_BASE = 'insightsrtm_';
 
 /**
@@ -98,7 +99,7 @@ const MAESTRO_ENDPOINTS = {
     INSTANCES: {
         GET_ALL: `${PIMS_BASE}/api/v1/instances`,
         GET_BY_ID: (instanceId) => `${PIMS_BASE}/api/v1/instances/${instanceId}`,
-        GET_EXECUTION_HISTORY: (instanceId) => `${PIMS_BASE}/api/v1/spans/${instanceId}`,
+        GET_ELEMENT_EXECUTIONS: (instanceId) => `${PIMS_BASE}/api/v1/instances/${instanceId}/element-executions`,
         GET_BPMN: (instanceId) => `${PIMS_BASE}/api/v1/instances/${instanceId}/bpmn`,
         GET_VARIABLES: (instanceId) => `${PIMS_BASE}/api/v1/instances/${instanceId}/variables`,
         CANCEL: (instanceId) => `${PIMS_BASE}/api/v1/instances/${instanceId}/cancel`,
@@ -110,6 +111,9 @@ const MAESTRO_ENDPOINTS = {
         GET_BY_PROCESS: (processKey) => `${PIMS_BASE}/api/v1/incidents/process/${processKey}`,
         GET_BY_INSTANCE: (instanceId) => `${PIMS_BASE}/api/v1/instances/${instanceId}/incidents`,
     },
+    TRACES: {
+        GET_SPANS: (traceId) => `${LLMOPS_BASE}/api/Traces/spans?traceId=${traceId}`,
+    },
     CASES: {
         GET_CASE_JSON: (instanceId) => `${PIMS_BASE}/api/v1/cases/${instanceId}/case-json`,
         GET_ELEMENT_EXECUTIONS: (instanceId) => `${PIMS_BASE}/api/v1/element-executions/case-instances/${instanceId}`,
@@ -130,9 +134,45 @@ const MAESTRO_ENDPOINTS = {
         INSTANCE_STATUS_BY_DATE: `${INSIGHTS_RTM_BASE}/agenticInstanceStatus/InstanceStatusByDate`,
         /** Top processes ranked by total duration */
         TOP_PROCESSES_BY_DURATION: `${INSIGHTS_RTM_BASE}/agenticInstanceStatus/TopProcessesByDuration`,
+        /** Element count by status for agentic instances (process and case) */
+        ELEMENT_COUNT_BY_STATUS: `${INSIGHTS_RTM_BASE}/agenticInstanceStatus/ElementCountByStatus`,
     },
 };
 
+/**
+ * Maestro Cases Models
+ * Model classes for Maestro cases
+ */
+/**
+ * Creates methods for a case object
+ *
+ * @param caseData - The case data (response from API)
+ * @param service - The cases service instance
+ * @returns Object containing case methods
+ */
+function createCaseMethods(caseData, service) {
+    return {
+        getElementStats(startTime, endTime, packageVersion) {
+            if (!caseData.processKey)
+                throw new Error('Process key is undefined');
+            if (!caseData.packageId)
+                throw new Error('Package ID is undefined');
+            return service.getElementStats(caseData.processKey, caseData.packageId, startTime, endTime, packageVersion);
+        }
+    };
+}
+/**
+ * Creates an actionable case by combining API case data with operational methods.
+ *
+ * @param caseData - The case data from API
+ * @param service - The cases service instance
+ * @returns A case object with added methods
+ */
+function createCaseWithMethods(caseData, service) {
+    const methods = createCaseMethods(caseData, service);
+    return Object.assign({}, caseData, methods);
+}
+
 /**
  * Builds the request body for Insights RTM "top" endpoints.
  *
@@ -179,6 +219,28 @@ async function fetchInstanceStatusTimeline(postFn, startTime, endTime, isCaseMan
     });
     return response.data ?? [];
 }
+/**
+ * Builds the request body for the ElementCountByStatus endpoint.
+ *
+ * @param processKey - Process key to filter by
+ * @param packageId - Package identifier
+ * @param startTime - Start of the time range to query
+ * @param endTime - End of the time range to query
+ * @param packageVersion - Package version to filter by
+ * @returns Request body for the ElementCountByStatus endpoint
+ * @internal
+ */
+function buildElementCountByStatusBody(processKey, packageId, startTime, endTime, packageVersion) {
+    return {
+        commonParams: {
+            processKey,
+            packageId,
+            startTime: startTime.getTime(),
+            endTime: endTime.getTime(),
+            version: packageVersion
+        }
+    };
+}
 
 /**
  * Type guards for error response types
@@ -875,6 +937,32 @@ function processODataArrayResponse(oDataResponse, successData) {
  */
 const isBrowser = typeof window !== 'undefined' && typeof window.document !== 'undefined';
 isBrowser && window.self != window.top && window.location.href.includes('source=ActionCenter');
+const _params = isBrowser ? new URLSearchParams(window.location.search) : null;
+/**
+ * True when the coded app has been loaded inside a host frame that explicitly
+ * opted into token delegation by adding `?host=embed` to the iframe src URL.
+ */
+const isHostEmbedded = isBrowser && window.self !== window.top && _params?.get('host') === 'embed';
+/**
+ * The validated parent origin, read from the `?basedomain=` query param set
+ * by the embedding host in the iframe src URL.
+ * Mirrors the same mechanism used by ActionCenterTokenManager.
+ * Non-null only when `?host=embed` is present and `?basedomain=` is a valid URL.
+ */
+(() => {
+    if (!isHostEmbedded)
+        return null;
+    const basedomain = _params?.get('basedomain');
+    if (!basedomain)
+        return null;
+    try {
+        return new URL(basedomain).origin;
+    }
+    catch {
+        console.warn('embeddingOrigin: basedomain query param is not a valid URL', basedomain);
+        return null;
+    }
+})();
 
 /**
  * Base64 encoding/decoding
@@ -1582,8 +1670,9 @@ 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];
+        // Handle both plain array responses and envelope responses ({ value: [...], totalRecordCount: N }).
+        // itemsField may be a dotted path (e.g. 'data.agents') for nested envelopes.
+        const rawItems = Array.isArray(response.data) ? response.data : resolveNestedField(response.data, itemsField);
         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
@@ -1629,7 +1718,7 @@ class PaginationHelpers {
                 getEndpoint: config.getEndpoint,
                 folderId,
                 headers: config.headers,
-                paginationParams: cursor ? { cursor, pageSize } : jumpToPage ? { jumpToPage, pageSize } : { pageSize },
+                paginationParams: cursor ? { cursor, pageSize } : jumpToPage !== undefined ? { jumpToPage, pageSize } : { pageSize },
                 additionalParams: prefixedOptions,
                 transformFn: config.transformFn,
                 method: config.method,
@@ -1887,6 +1976,8 @@ class BaseService {
                 // 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;
+                // When true, sends pageNumber - 1 (for 0-based APIs). Default false (1-based).
+                const zeroBased = paginationParams?.zeroBased ?? false;
                 requestParams[pageSizeParam] = limitedPageSize;
                 if (convertToSkip) {
                     if (params.pageNumber && params.pageNumber > 1) {
@@ -1894,7 +1985,8 @@ class BaseService {
                     }
                 }
                 else {
-                    requestParams[offsetParam] = params.pageNumber || 1;
+                    const sdkPageNumber = params.pageNumber || 1;
+                    requestParams[offsetParam] = zeroBased ? sdkPageNumber - 1 : sdkPageNumber;
                 }
                 {
                     requestParams[countParam] = true;
@@ -1923,8 +2015,9 @@ class BaseService {
         const totalCountField = fields.totalCountField || 'totalRecordCount';
         const continuationTokenField = fields.continuationTokenField || 'continuationToken';
         // 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] || []);
+        // Handle both plain array responses and envelope responses ({ value: [...], totalRecordCount: N }).
+        // itemsField may be a dotted path (e.g. 'data.agents') for nested envelopes.
+        const items = Array.isArray(response.data) ? response.data : (resolveNestedField(response.data, itemsField) || []);
         const rawTotalCount = Array.isArray(response.data) ? undefined : resolveNestedField(response.data, totalCountField);
         const totalCount = typeof rawTotalCount === 'number' ? rawTotalCount : undefined;
         const continuationToken = response.data[continuationTokenField];
@@ -2041,7 +2134,7 @@ function createParams(paramsObj = {}) {
 class CasesService extends BaseService {
     /**
      * Get all case management processes with their instance statistics
-     * @returns Promise resolving to array of Case objects
+     * @returns Promise resolving to an array of {@link CaseGetAllWithMethodsResponse}
      *
      * @example
      * ```typescript
@@ -2065,10 +2158,10 @@ class CasesService extends BaseService {
         const response = await this.get(MAESTRO_ENDPOINTS.PROCESSES.GET_ALL, { params });
         // Extract processes array from response data and add name field
         const cases = response.data?.processes || [];
-        return cases.map(caseItem => ({
+        return cases.map(caseItem => createCaseWithMethods({
             ...caseItem,
             name: this.extractCaseName(caseItem.packageId)
-        }));
+        }, this));
     }
     /**
      * Get the top 5 case processes ranked by run count within a time range.
@@ -2287,6 +2380,40 @@ class CasesService extends BaseService {
         const { data } = await this.post(MAESTRO_ENDPOINTS.INSIGHTS.TOP_PROCESSES_BY_DURATION, buildInsightsTopBody(startTime, endTime, true, options));
         return (data ?? []).map(process => ({ ...process, name: this.extractCaseName(process.packageId) }));
     }
+    /**
+     * Get element stats for case instances
+     *
+     * Returns per-element execution counts (success, fail, terminated, paused, in-progress) and
+     * duration percentile metrics (min, max, avg, p50, p95, p99) for BPMN elements within a case.
+     *
+     * @param processKey - Process key to filter by
+     * @param packageId - Package identifier
+     * @param startTime - Start of the time range to query
+     * @param endTime - End of the time range to query
+     * @param packageVersion - Package version to filter by
+     * @returns Promise resolving to an array of {@link ElementStats}
+     * @example
+     * ```typescript
+     * // Get element metrics for a case
+     * const elements = await cases.getElementStats(
+     *   '<processKey>',
+     *   '<packageId>',
+     *   new Date('2026-04-01'),
+     *   new Date(),
+     *   '1.0.1'
+     * );
+     *
+     * // Find elements with failures
+     * const failedElements = elements.filter(e => e.failCount > 0);
+     * for (const element of failedElements) {
+     *   console.log(`Failed element: ${element.elementId}, failures: ${element.failCount}`);
+     * }
+     * ```
+     */
+    async getElementStats(processKey, packageId, startTime, endTime, packageVersion) {
+        const { data } = await this.post(MAESTRO_ENDPOINTS.INSIGHTS.ELEMENT_COUNT_BY_STATUS, buildElementCountByStatusBody(processKey, packageId, startTime, endTime, packageVersion));
+        return data ?? [];
+    }
     /**
      * Extract a readable case name from the packageId
      * @param packageId - The full package identifier
@@ -2324,6 +2451,9 @@ __decorate([
 __decorate([
     track('Cases.GetTopExecutionDuration')
 ], CasesService.prototype, "getTopExecutionDuration", null);
+__decorate([
+    track('Cases.GetElementStats')
+], CasesService.prototype, "getElementStats", null);
 
 /**
  * Process Incident Status
@@ -3845,4 +3975,4 @@ __decorate([
     track('CaseInstances.GetStagesSlaSummary')
 ], CaseInstancesService.prototype, "getStagesSlaSummary", null);
 
-export { CaseInstancesService as CaseInstances, CaseInstancesService, CasesService as Cases, CasesService, EscalationActionType, EscalationRecipientScope, EscalationTriggerType, InstanceFinalStatus, InstanceStatus, SLADurationUnit, SlaSummaryStatus, StageTaskType, TimeInterval, createCaseInstanceWithMethods };
+export { CaseInstancesService as CaseInstances, CaseInstancesService, CasesService as Cases, CasesService, EscalationActionType, EscalationRecipientScope, EscalationTriggerType, InstanceFinalStatus, InstanceStatus, SLADurationUnit, SlaSummaryStatus, StageTaskType, TimeInterval, createCaseInstanceWithMethods, createCaseWithMethods };