@uipath/uipath-typescript 1.5.0 → 1.5.1

package/dist/traces/index.cjs

@@ -948,6 +948,17 @@ const TRACEVIEW_SPANS_PAGINATION = {
     /** Total count path — same envelope location as the agents list. */
     TOTAL_COUNT_FIELD: AGENTS_PAGINATION.TOTAL_COUNT_FIELD
 };
+/**
+ * Governance decisions pagination constants — decision rows sit directly
+ * under `items`. This endpoint returns no total-count field, so no
+ * `TOTAL_COUNT_FIELD` is defined; `hasNextPage` falls back to page-fullness
+ * (a full page implies there may be more). Request params reuse
+ * {@link AGENTS_OFFSET_PARAMS} (pageSize + 0-based pageNumber).
+ */
+const GOVERNANCE_DECISIONS_PAGINATION = {
+    /** Field name for the decision-rows array in the response. */
+    ITEMS_FIELD: 'items',
+};
 /**
  * OData OFFSET pagination parameter names (ODATA-style)
  */
@@ -1845,6 +1856,10 @@ const AGENT_TRACES_ENDPOINTS = {
     GET_SPANS_BY_TRACE_ID: (traceId) => `${INSIGHTS_RTM_BASE}/Traceview/spans/${traceId}`,
     /** Paginated spans whose reference hierarchy contains the given reference id. */
     GET_SPANS_BY_REFERENCE: (referenceId) => `${INSIGHTS_RTM_BASE}/Traceview/spans/reference/${referenceId}`,
+    /** Paginated raw governance decision rows. */
+    GET_GOVERNANCE_DECISIONS: `${INSIGHTS_RTM_BASE}/Governance/agentic/traces`,
+    /** Aggregated governance posture (totals + top-N breakdowns). */
+    GET_GOVERNANCE_SUMMARY: `${INSIGHTS_RTM_BASE}/Governance/agentic/summary`,
 };
 
 /**
@@ -1983,6 +1998,52 @@ __decorate([
     track('Traces.GetSpansByIds')
 ], TracesService.prototype, "getSpansByIds", null);
 
+// ─── Governance ─────────────────────────────────────────────────────
+/**
+ * Evaluation mode of a governance decision.
+ */
+exports.AgentGovernanceMode = void 0;
+(function (AgentGovernanceMode) {
+    /** Policy evaluated and logged, but not enforced. */
+    AgentGovernanceMode["Audit"] = "AUDIT";
+    /** Policy evaluated and enforced. */
+    AgentGovernanceMode["Enforce"] = "ENFORCE";
+    /** Unrecognized or missing mode. */
+    AgentGovernanceMode["Unknown"] = "Unknown";
+})(exports.AgentGovernanceMode || (exports.AgentGovernanceMode = {}));
+/**
+ * Verdict of a governance decision (`Deny` = violation).
+ */
+exports.AgentGovernanceVerdict = void 0;
+(function (AgentGovernanceVerdict) {
+    /** Allowed — not a violation. */
+    AgentGovernanceVerdict["Allow"] = "ALLOW";
+    /** Denied — counts as a violation. */
+    AgentGovernanceVerdict["Deny"] = "DENY";
+    /** Unrecognized or missing verdict. */
+    AgentGovernanceVerdict["Unknown"] = "Unknown";
+})(exports.AgentGovernanceVerdict || (exports.AgentGovernanceVerdict = {}));
+/**
+ * Sections the governance summary can compute. `action` and `mode` are opt-in.
+ */
+exports.AgentGovernanceSection = void 0;
+(function (AgentGovernanceSection) {
+    /** Scalar totals (`total`, `violations`). */
+    AgentGovernanceSection["Totals"] = "totals";
+    /** Breakdown by governance hook. */
+    AgentGovernanceSection["Hook"] = "hook";
+    /** Breakdown by agent. */
+    AgentGovernanceSection["Agent"] = "agent";
+    /** Breakdown by policy. */
+    AgentGovernanceSection["Policy"] = "policy";
+    /** Breakdown by governance pack. */
+    AgentGovernanceSection["Pack"] = "pack";
+    /** Breakdown by enforcement action (opt-in). */
+    AgentGovernanceSection["Action"] = "action";
+    /** Breakdown by evaluation mode (opt-in). */
+    AgentGovernanceSection["Mode"] = "mode";
+})(exports.AgentGovernanceSection || (exports.AgentGovernanceSection = {}));
+
 /**
  * Maps a raw span record to a {@link AgentSpanGetResponse}
  */
@@ -1990,6 +2051,22 @@ const transformSpan = (span) => {
     const { expiryTimeUtc, ...rest } = span;
     return { ...rest, expiredTime: expiryTimeUtc };
 };
+// Case-insensitive lookups from a raw API value → enum member (keys upper-cased).
+const GOVERNANCE_MODE_BY_VALUE = new Map(Object.values(exports.AgentGovernanceMode).map((mode) => [mode.toUpperCase(), mode]));
+const GOVERNANCE_VERDICT_BY_VALUE = new Map(Object.values(exports.AgentGovernanceVerdict).map((verdict) => [verdict.toUpperCase(), verdict]));
+/** Maps a raw mode string to {@link AgentGovernanceMode}, case-insensitively; missing/unrecognized → `Unknown`. */
+const toGovernanceMode = (raw) => (raw != null ? GOVERNANCE_MODE_BY_VALUE.get(raw.toUpperCase()) : undefined) ?? exports.AgentGovernanceMode.Unknown;
+/** Maps a raw verdict string to {@link AgentGovernanceVerdict}, case-insensitively; missing/unrecognized → `Unknown`. */
+const toGovernanceVerdict = (raw) => (raw != null ? GOVERNANCE_VERDICT_BY_VALUE.get(raw.toUpperCase()) : undefined) ?? exports.AgentGovernanceVerdict.Unknown;
+/**
+ * Normalizes a raw governance row, mapping the mode and verdict strings to
+ * their enums while leaving the other fields untouched.
+ */
+const transformGovernanceDecision = (row) => ({
+    ...row,
+    mode: toGovernanceMode(row.mode),
+    evaluatorResult: toGovernanceVerdict(row.evaluatorResult),
+});
 /**
  * Service for retrieving UiPath Agent trace metrics.
  */
@@ -2125,10 +2202,6 @@ class AgentTracesService extends BaseService {
     /**
      * Retrieves spans whose reference hierarchy contains the given reference id.
      *
-     * Returns a {@link PaginatedResponse} when pagination options (`pageSize`,
-     * `cursor`, or `jumpToPage`) are provided, otherwise a
-     * {@link NonPaginatedResponse}.
-     *
      * @param referenceId - Reference id matched against each span's reference hierarchy
      * @param options - Optional pagination and hierarchy/time filters
      * @returns Promise resolving to a paginated or non-paginated list of {@link AgentSpanGetResponse}
@@ -2189,6 +2262,141 @@ class AgentTracesService extends BaseService {
             },
         }, apiOptions);
     }
+    /**
+     * Lists individual governance decisions from agent execution traces — each
+     * policy check's allow/deny outcome with its agent, policy, pack, hook, and
+     * mode, plus the trace it belongs to — over the requested window. Filterable
+     * and paginated.
+     *
+     * @remarks Requires the caller to be an organization admin. Non-admin callers get a `403` and the SDK throws an {@link AuthorizationError}.
+     *
+     * @param startTime - Inclusive lower bound for the query window
+     * @param options - Optional window end, filters, and pagination
+     * @returns Promise resolving to a paginated or non-paginated list of {@link AgentGovernanceDecisionGetResponse}
+     * @example
+     * ```typescript
+     * import { AgentTraces } from '@uipath/uipath-typescript/traces';
+     *
+     * const trace = new AgentTraces(sdk);
+     *
+     * // Decision rows since a start time
+     * const result = await trace.getGovernanceDecisions(new Date('2025-05-01T00:00:00Z'));
+     * result.items.forEach((row) => {
+     *   console.log(`${row.hook} ${row.policyId}: ${row.evaluatorResult}`);
+     * });
+     * ```
+     * @example
+     * ```typescript
+     * // Violations only, for one agent, paginated
+     * const page = await trace.getGovernanceDecisions(new Date('2025-05-01T00:00:00Z'), {
+     *   endTime: new Date('2025-06-01T00:00:00Z'),
+     *   violationsOnly: true,
+     *   agentId: '<agentProjectKey>',
+     *   pageSize: 25,
+     * });
+     * if (page.hasNextPage && page.nextCursor) {
+     *   const next = await trace.getGovernanceDecisions(new Date('2025-05-01T00:00:00Z'), { cursor: page.nextCursor });
+     * }
+     * ```
+     * @example
+     * ```typescript
+     * import { isAuthorizationError } from '@uipath/uipath-typescript/core';
+     *
+     * // Non-admin callers get a 403
+     * try {
+     *   await trace.getGovernanceDecisions(new Date('2025-05-01T00:00:00Z'));
+     * } catch (error) {
+     *   if (isAuthorizationError(error)) {
+     *     console.error('Governance data requires an organization admin.');
+     *   }
+     * }
+     * ```
+     */
+    async getGovernanceDecisions(startTime, options) {
+        const { endTime, ...rest } = options ?? {};
+        const apiOptions = {
+            ...rest,
+            startTime: startTime.toISOString(),
+            ...(endTime !== undefined ? { endTime: endTime.toISOString() } : {}),
+        };
+        return PaginationHelpers.getAll({
+            serviceAccess: this.createPaginationServiceAccess(),
+            getEndpoint: () => AGENT_TRACES_ENDPOINTS.GET_GOVERNANCE_DECISIONS,
+            method: HTTP_METHODS.POST,
+            transformFn: transformGovernanceDecision,
+            excludeFromPrefix: Object.keys(apiOptions),
+            pagination: {
+                paginationType: PaginationType.OFFSET,
+                itemsField: GOVERNANCE_DECISIONS_PAGINATION.ITEMS_FIELD,
+                paginationParams: {
+                    pageSizeParam: AGENTS_OFFSET_PARAMS.PAGE_SIZE_PARAM,
+                    offsetParam: AGENTS_OFFSET_PARAMS.OFFSET_PARAM,
+                    countParam: AGENTS_OFFSET_PARAMS.COUNT_PARAM,
+                    convertToSkip: false,
+                    zeroBased: true,
+                },
+            },
+        }, apiOptions);
+    }
+    /**
+     * Summarizes governance decisions across agent execution traces — total
+     * decisions and violations, plus top breakdowns by hook, agent, policy, and
+     * pack — over the requested window. Filterable.
+     *
+     * @remarks Requires the caller to be an organization admin. Non-admin callers get a `403` and the SDK throws an {@link AuthorizationError}.
+     *
+     * @param startTime - Inclusive lower bound for the query window
+     * @param options - Optional window end, top-N, pack scope, and sections
+     * @returns Promise resolving to {@link AgentGovernanceGetSummaryResponse}
+     * @example
+     * ```typescript
+     * import { AgentTraces } from '@uipath/uipath-typescript/traces';
+     *
+     * const trace = new AgentTraces(sdk);
+     *
+     * // Default posture since a start time
+     * const summary = await trace.getGovernanceSummary(new Date('2025-05-01T00:00:00Z'));
+     * console.log(`${summary.violations} / ${summary.total} violations`);
+     * summary.byPolicy.forEach((p) => console.log(`${p.key}: ${p.violationCount}`));
+     * ```
+     * @example
+     * ```typescript
+     * import { AgentGovernanceSection } from '@uipath/uipath-typescript/traces';
+     *
+     * // Top 5 per breakdown, scoped to a pack, including the opt-in action/mode sections
+     * const summary = await trace.getGovernanceSummary(new Date('2025-05-01T00:00:00Z'), {
+     *   topN: 5,
+     *   packName: 'ISO/IEC 42001:2023 Runtime',
+     *   sections: [AgentGovernanceSection.Action, AgentGovernanceSection.Mode],
+     * });
+     * ```
+     * @example
+     * ```typescript
+     * import { isAuthorizationError } from '@uipath/uipath-typescript/core';
+     *
+     * // Non-admin callers get a 403
+     * try {
+     *   await trace.getGovernanceSummary(new Date('2025-05-01T00:00:00Z'));
+     * } catch (error) {
+     *   if (isAuthorizationError(error)) {
+     *     console.error('Governance data requires an organization admin.');
+     *   }
+     * }
+     * ```
+     */
+    async getGovernanceSummary(startTime, options) {
+        const body = { startTime: startTime.toISOString() };
+        if (options?.endTime !== undefined)
+            body.endTime = options.endTime.toISOString();
+        if (options?.topN !== undefined)
+            body.topN = options.topN;
+        if (options?.packName !== undefined)
+            body.packName = options.packName;
+        if (options?.sections !== undefined)
+            body.sections = options.sections;
+        const response = await this.post(AGENT_TRACES_ENDPOINTS.GET_GOVERNANCE_SUMMARY, body);
+        return response.data;
+    }
     buildTraceFilterBody(options) {
         const body = {};
         if (options?.startTime !== undefined)
@@ -2221,6 +2429,12 @@ __decorate([
 __decorate([
     track('AgentTraces.GetSpansByReference')
 ], AgentTracesService.prototype, "getSpansByReference", null);
+__decorate([
+    track('AgentTraces.GetGovernanceDecisions')
+], AgentTracesService.prototype, "getGovernanceDecisions", null);
+__decorate([
+    track('AgentTraces.GetGovernanceSummary')
+], AgentTracesService.prototype, "getGovernanceSummary", null);
 
 exports.AgentTraceExecutionType = exports.SpanExecutionType;
 exports.AgentTraces = AgentTracesService;