@uipath/uipath-typescript 1.3.6 → 1.3.8

package/dist/cases/index.mjs

@@ -662,6 +662,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,26 @@ const ODATA_PAGINATION = {
     /** Default field name for total count in a paginated OData response */
     TOTAL_COUNT_FIELD: '@odata.count'
 };
+/**
+ * SLA Summary pagination constants for page-number-based pagination
+ */
+const SLA_SUMMARY_PAGINATION = {
+    /** Field name for items in SLA summary response */
+    ITEMS_FIELD: 'data',
+    /** Dot-notation path for total count in nested pagination object */
+    TOTAL_COUNT_FIELD: 'pagination.totalCount'
+};
+/**
+ * SLA Summary OFFSET pagination parameter names (page-number style, no skip conversion)
+ */
+const SLA_SUMMARY_OFFSET_PARAMS = {
+    /** Page size parameter name */
+    PAGE_SIZE_PARAM: 'PageSize',
+    /** Page number parameter name (sent directly, not converted to skip) */
+    OFFSET_PARAM: 'PageNumber',
+    /** No count param needed */
+    COUNT_PARAM: undefined
+};
 /**
  * Process Instance pagination constants for token-based pagination
  */
@@ -939,6 +980,14 @@ const PROCESS_INSTANCE_TOKEN_PARAMS = {
     TOKEN_PARAM: 'nextPage'
 };
 
+/**
+ * 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.
+ */
+function toISOUtc(value) {
+    const date = new Date(value + ' UTC');
+    return isNaN(date.getTime()) ? value : date.toISOString();
+}
 /**
  * Transforms data by mapping fields according to the provided field mapping
  * @param data The source data to transform
@@ -1398,7 +1447,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;
@@ -1574,8 +1624,9 @@ class BaseService {
     constructor(instance, headers) {
         // Private field - not visible via Object.keys() or any reflection
         _BaseService_apiClient.set(this, void 0);
-        const { config, context, tokenManager } = SDKInternalsRegistry.get(instance);
+        const { config, context, tokenManager, folderKey } = SDKInternalsRegistry.get(instance);
         __classPrivateFieldSet(this, _BaseService_apiClient, new ApiClient(config, context, tokenManager, headers ? { headers } : {}), "f");
+        this.config = { folderKey };
     }
     /**
      * Gets a valid authentication token, refreshing if necessary.
@@ -1694,9 +1745,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;
@@ -1727,7 +1786,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, {
@@ -1777,6 +1837,7 @@ _BaseService_apiClient = new WeakMap();
  */
 const ORCHESTRATOR_BASE = 'orchestrator_';
 const PIMS_BASE = 'pims_';
+const INSIGHTS_RTM_BASE = 'insightsrtm_';
 
 /**
  * Orchestrator Service Endpoints
@@ -1832,6 +1893,10 @@ const MAESTRO_ENDPOINTS = {
         GET_ELEMENT_EXECUTIONS: (instanceId) => `${PIMS_BASE}/api/v1/element-executions/case-instances/${instanceId}`,
         REOPEN: (instanceId) => `${PIMS_BASE}/api/v1/cases/${instanceId}/reopen`,
     },
+    INSIGHTS: {
+        /** SLA summary for case instances */
+        SLA_SUMMARY: `${INSIGHTS_RTM_BASE}/caseManagement/slaSummary`,
+    },
 };
 
 /**
@@ -1840,7 +1905,7 @@ const MAESTRO_ENDPOINTS = {
 // 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.6";
+const SDK_VERSION = "1.3.8";
 const VERSION = "Version";
 const SERVICE = "Service";
 const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
@@ -2241,6 +2306,41 @@ var DebugMode;
  * Case Instance Types
  * Types and interfaces for Maestro case instance management
  */
+/**
+ * SLA status for a case instance
+ */
+var SlaSummaryStatus;
+(function (SlaSummaryStatus) {
+    /** Case is within SLA deadline */
+    SlaSummaryStatus["ON_TRACK"] = "On Track";
+    /** Case is approaching SLA deadline based on at-risk percentage threshold */
+    SlaSummaryStatus["AT_RISK"] = "At Risk";
+    /** Case has exceeded SLA deadline */
+    SlaSummaryStatus["OVERDUE"] = "Overdue";
+    /** Case instance has completed */
+    SlaSummaryStatus["COMPLETED"] = "Completed";
+    /** SLA status cannot be determined (no SLA deadline defined) */
+    SlaSummaryStatus["UNKNOWN"] = "Unknown";
+})(SlaSummaryStatus || (SlaSummaryStatus = {}));
+/**
+ * Instance status values for case instances and process instances
+ */
+var InstanceStatus;
+(function (InstanceStatus) {
+    /** Instance status not yet populated by the backend */
+    InstanceStatus["UNKNOWN"] = "";
+    InstanceStatus["CANCELLED"] = "Cancelled";
+    InstanceStatus["CANCELING"] = "Canceling";
+    InstanceStatus["COMPLETED"] = "Completed";
+    InstanceStatus["FAULTED"] = "Faulted";
+    InstanceStatus["PAUSED"] = "Paused";
+    InstanceStatus["PAUSING"] = "Pausing";
+    InstanceStatus["PENDING"] = "Pending";
+    InstanceStatus["RESUMING"] = "Resuming";
+    InstanceStatus["RETRYING"] = "Retrying";
+    InstanceStatus["RUNNING"] = "Running";
+    InstanceStatus["UPGRADING"] = "Upgrading";
+})(InstanceStatus || (InstanceStatus = {}));
 /**
  * Case stage task type
  */
@@ -2275,6 +2375,8 @@ var EscalationTriggerType;
 (function (EscalationTriggerType) {
     EscalationTriggerType["SLA_BREACHED"] = "sla-breached";
     EscalationTriggerType["AT_RISK"] = "at-risk";
+    /** Default value when no escalation rule is defined */
+    EscalationTriggerType["NONE"] = "None";
 })(EscalationTriggerType || (EscalationTriggerType = {}));
 /**
  * SLA duration unit
@@ -2342,6 +2444,11 @@ function createCaseInstanceMethods(instanceData, service) {
             if (!instanceData.instanceId)
                 throw new Error('Case instance ID is undefined');
             return service.getActionTasks(instanceData.instanceId, options);
+        },
+        async getSlaSummary(options) {
+            if (!instanceData.instanceId)
+                throw new Error('Case instance ID is undefined');
+            return service.getSlaSummary({ ...options, caseInstanceId: instanceData.instanceId });
         }
     };
 }
@@ -3507,6 +3614,70 @@ class CaseInstancesService extends BaseService {
         };
         return await this.taskService.getAll(enhancedOptions);
     }
+    /**
+     * Get SLA summary for all case instances across folders.
+     *
+     * Returns SLA status, due times, escalation info, and instance metadata for each case instance.
+     * The default page size is 50, so only the top 50 items are returned when no pagination options are provided.
+     *
+     * @param options - Optional filtering and pagination options
+     * @returns Promise resolving to {@link SlaSummaryResponse}, paginated or non-paginated based on options
+     * @example
+     * ```typescript
+     * // Non-paginated (returns top 50 items by default)
+     * const summary = await caseInstances.getSlaSummary();
+     * console.log(`Found ${summary.totalCount} cases`);
+     *
+     * // Filter by case instance ID
+     * const filtered = await caseInstances.getSlaSummary({
+     *   caseInstanceId: '<caseInstanceId>'
+     * });
+     *
+     * // Filter by time range
+     * const timeFiltered = await caseInstances.getSlaSummary({
+     *   startTimeUtc: new Date('2026-01-01'),
+     *   endTimeUtc: new Date('2026-01-31')
+     * });
+     *
+     * // With pagination
+     * const page1 = await caseInstances.getSlaSummary({ pageSize: 25 });
+     * if (page1.hasNextPage) {
+     *   const page2 = await caseInstances.getSlaSummary({ cursor: page1.nextCursor });
+     * }
+     *
+     * // Jump to specific page
+     * const page3 = await caseInstances.getSlaSummary({ jumpToPage: 3, pageSize: 25 });
+     * ```
+     */
+    async getSlaSummary(options) {
+        const apiOptions = options ? {
+            ...options,
+            startTimeUtc: options.startTimeUtc?.toISOString(),
+            endTimeUtc: options.endTimeUtc?.toISOString()
+        } : undefined;
+        return PaginationHelpers.getAll({
+            serviceAccess: this.createPaginationServiceAccess(),
+            getEndpoint: () => MAESTRO_ENDPOINTS.INSIGHTS.SLA_SUMMARY,
+            method: HTTP_METHODS.POST,
+            excludeFromPrefix: ['caseInstanceId', 'startTimeUtc', 'endTimeUtc'],
+            transformFn: (item) => ({
+                ...item,
+                slaDueTime: toISOUtc(item.slaDueTime),
+                lastModifiedTime: toISOUtc(item.lastModifiedTime)
+            }),
+            pagination: {
+                paginationType: PaginationType.OFFSET,
+                itemsField: SLA_SUMMARY_PAGINATION.ITEMS_FIELD,
+                totalCountField: SLA_SUMMARY_PAGINATION.TOTAL_COUNT_FIELD,
+                paginationParams: {
+                    pageSizeParam: SLA_SUMMARY_OFFSET_PARAMS.PAGE_SIZE_PARAM,
+                    offsetParam: SLA_SUMMARY_OFFSET_PARAMS.OFFSET_PARAM,
+                    countParam: SLA_SUMMARY_OFFSET_PARAMS.COUNT_PARAM,
+                    convertToSkip: false
+                }
+            }
+        }, apiOptions);
+    }
 }
 __decorate([
     track('CaseInstances.GetAll')
@@ -3535,5 +3706,8 @@ __decorate([
 __decorate([
     track('CaseInstances.GetActionTasks')
 ], CaseInstancesService.prototype, "getActionTasks", null);
+__decorate([
+    track('CaseInstances.GetSlaSummary')
+], CaseInstancesService.prototype, "getSlaSummary", null);
 
-export { CaseInstancesService as CaseInstances, CaseInstancesService, CasesService as Cases, CasesService, EscalationActionType, EscalationRecipientScope, EscalationTriggerType, SLADurationUnit, StageTaskType, createCaseInstanceWithMethods };
+export { CaseInstancesService as CaseInstances, CaseInstancesService, CasesService as Cases, CasesService, EscalationActionType, EscalationRecipientScope, EscalationTriggerType, InstanceStatus, SLADurationUnit, SlaSummaryStatus, StageTaskType, createCaseInstanceWithMethods };