@uipath/uipath-typescript 1.3.6 → 1.3.8

package/dist/feedback/index.cjs

@@ -652,6 +652,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
@@ -873,6 +894,15 @@ const ODATA_OFFSET_PARAMS = {
     /** OData count parameter name */
     COUNT_PARAM: '$count'
 };
+/**
+ * Feedback category pagination response shape constants
+ */
+const FEEDBACK_CATEGORY_PAGINATION = {
+    /** Field name for items in feedback category response */
+    ITEMS_FIELD: 'categories',
+    /** Field name for total count in feedback category response */
+    TOTAL_COUNT_FIELD: 'totalCount'
+};
 /**
  * Feedback OFFSET pagination parameter names (take/skip style)
  */
@@ -894,6 +924,10 @@ const BUCKET_TOKEN_PARAMS = {
     TOKEN_PARAM: 'continuationToken'
 };
 
+/**
+ * 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.
+ */
 /**
  * Transforms data by mapping fields according to the provided field mapping
  * @param data The source data to transform
@@ -1166,7 +1200,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;
@@ -1342,8 +1377,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.
@@ -1462,9 +1498,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;
@@ -1495,7 +1539,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, {
@@ -1559,6 +1604,14 @@ const LLMOPS_BASE = 'llmopstenant_';
 const FEEDBACK_ENDPOINTS = {
     GET_ALL: `${LLMOPS_BASE}/api/Feedback`,
     GET_BY_ID: (id) => `${LLMOPS_BASE}/api/Feedback/${id}`,
+    SUBMIT: `${LLMOPS_BASE}/api/Feedback`,
+    UPDATE: (id) => `${LLMOPS_BASE}/api/Feedback/${id}`,
+    DELETE: (id) => `${LLMOPS_BASE}/api/Feedback/${id}`,
+    CATEGORY: {
+        GET_ALL: `${LLMOPS_BASE}/api/Feedback/category`,
+        CREATE: `${LLMOPS_BASE}/api/Feedback/category`,
+        DELETE: (id) => `${LLMOPS_BASE}/api/Feedback/category/${id}`,
+    },
 };
 
 /**
@@ -1567,7 +1620,7 @@ const FEEDBACK_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";
@@ -1843,10 +1896,10 @@ class FeedbackService extends BaseService {
      * Gets all feedback across all agents in the tenant, with optional filters.
      *
      * Retrieves a list of feedback entries, optionally filtered by agent, trace, span, status, or agent version.
-     * When no pagination options are provided, the API returns up to 100 items. When pagination options are provided without a pageSize, the SDK defaults to 50 items per page.
+     * When no pagination options are provided, the SDK returns up to 100 items. When pagination options are provided without a pageSize, the SDK defaults to 50 items per page.
      *
      * @param options - Optional query parameters for filtering and pagination
-     * @returns Promise resolving to {@link NonPaginatedResponse} of {@link FeedbackGetResponse} without pagination options, or {@link PaginatedResponse} of {@link FeedbackGetResponse} when pagination options are used.
+     * @returns Promise resolving to {@link NonPaginatedResponse} of {@link FeedbackResponse} without pagination options, or {@link PaginatedResponse} of {@link FeedbackResponse} when pagination options are used.
      * @example
      * ```typescript
      * import { Feedback, FeedbackStatus } from '@uipath/uipath-typescript/feedback';
@@ -1898,7 +1951,7 @@ class FeedbackService extends BaseService {
      *
      * @param id - Feedback ID (GUID) of the feedback entry
      * @param options - Required options including folderKey for folder-level authorization {@link FeedbackOptions}
-     * @returns Promise resolving to {@link FeedbackGetResponse}
+     * @returns Promise resolving to {@link FeedbackResponse}
      * @example
      * ```typescript
      * import { Feedback } from '@uipath/uipath-typescript/feedback';
@@ -1916,11 +1969,223 @@ class FeedbackService extends BaseService {
     async getById(id, options) {
         if (!id)
             throw new ValidationError({ message: 'Feedback ID is required for getById' });
-        if (!options?.folderKey)
+        if (!options.folderKey)
             throw new ValidationError({ message: 'folderKey is required for getById' });
         const response = await this.get(FEEDBACK_ENDPOINTS.GET_BY_ID(id), { headers: createHeaders({ [FOLDER_KEY]: options?.folderKey }) });
         return transformData(response.data, FeedbackMap);
     }
+    /**
+     * Submits a feedback entry.
+     *
+     * @param traceId - Trace identifier linking feedback to a specific agent execution
+     * @param isPositive - Whether the feedback is positive (thumbs up) or negative (thumbs down)
+     * @param options - Additional feedback data and folderKey for authorization {@link FeedbackSubmitOptions}
+     * @returns Promise resolving to the submitted {@link FeedbackResponse}
+     * @example
+     * ```typescript
+     * import { Feedback } from '@uipath/uipath-typescript/feedback';
+     *
+     * const feedback = new Feedback(sdk);
+     *
+     * // Obtain traceId and folderKey from an existing feedback entry
+     * const allFeedback = await feedback.getAll({ pageSize: 1 });
+     * const traceId = allFeedback.items[0].traceId;
+     * const folderKey = allFeedback.items[0].folderKey!;
+     *
+     * const item = await feedback.submit(traceId, true, { folderKey });
+     * console.log(item.id, item.status);
+     * ```
+     */
+    async submit(traceId, isPositive, options) {
+        if (!traceId)
+            throw new ValidationError({ message: 'traceId is required for submit' });
+        if (!options.folderKey)
+            throw new ValidationError({ message: 'folderKey is required for submit' });
+        const { folderKey, ...rest } = options;
+        const response = await this.post(FEEDBACK_ENDPOINTS.SUBMIT, { traceId, isPositive, ...rest }, { headers: createHeaders({ [FOLDER_KEY]: folderKey }) });
+        return transformData(response.data, FeedbackMap);
+    }
+    /**
+     * Updates already submitted feedback.
+     *
+     * @param id - Feedback ID (GUID) of the entry to update
+     * @param isPositive - Whether the feedback is positive (thumbs up) or negative (thumbs down)
+     * @param options - Updated feedback data and folderKey for authorization {@link FeedbackUpdateOptions}
+     * @returns Promise resolving to the updated {@link FeedbackResponse}
+     * @example
+     * ```typescript
+     * import { Feedback } from '@uipath/uipath-typescript/feedback';
+     *
+     * const feedback = new Feedback(sdk);
+     *
+     * const allFeedback = await feedback.getAll({ pageSize: 1 });
+     * const feedbackId = allFeedback.items[0].id;
+     * const folderKey = allFeedback.items[0].folderKey!;
+     *
+     * const updated = await feedback.updateById(feedbackId, false, {
+     *   comment: 'On reflection, not great.',
+     *   folderKey,
+     * });
+     * console.log(updated.isPositive, updated.comment);
+     * ```
+     */
+    async updateById(id, isPositive, options) {
+        if (!id)
+            throw new ValidationError({ message: 'Feedback ID is required for updateById' });
+        if (!options.folderKey)
+            throw new ValidationError({ message: 'folderKey is required for updateById' });
+        const { folderKey, ...rest } = options;
+        const response = await this.post(FEEDBACK_ENDPOINTS.UPDATE(id), { isPositive, ...rest }, { headers: createHeaders({ [FOLDER_KEY]: folderKey }) });
+        return transformData(response.data, FeedbackMap);
+    }
+    /**
+     * Deletes a feedback entry by its ID.
+     *
+     * @param id - Feedback ID (GUID) of the entry to delete
+     * @param options - Required options including folderKey for folder-level authorization {@link FeedbackOptions}
+     * @returns Promise resolving to void on success
+     * @example
+     * ```typescript
+     * import { Feedback } from '@uipath/uipath-typescript/feedback';
+     *
+     * const feedback = new Feedback(sdk);
+     *
+     * const allFeedback = await feedback.getAll({ pageSize: 1 });
+     * const feedbackId = allFeedback.items[0].id;
+     * const folderKey = allFeedback.items[0].folderKey!;
+     *
+     * await feedback.deleteById(feedbackId, { folderKey });
+     * ```
+     */
+    async deleteById(id, options) {
+        if (!id)
+            throw new ValidationError({ message: 'Feedback ID is required for deleteById' });
+        if (!options.folderKey)
+            throw new ValidationError({ message: 'folderKey is required for deleteById' });
+        await this.delete(FEEDBACK_ENDPOINTS.DELETE(id), { headers: createHeaders({ [FOLDER_KEY]: options.folderKey }) });
+    }
+    /**
+     * Creates a new feedback category.
+     *
+     * Custom categories can be used to label feedback entries beyond the default system categories.
+     * Once created, reference the category by its `id` when submitting or updating feedback.
+     * If `isPositive` and `isNegative` are omitted, the backend defaults both to `true`.
+     *
+     * @param category - Name of the category to create (max 256 characters, unique per tenant)
+     * @param options - Optional flags controlling whether the category applies to positive and/or negative feedback {@link FeedbackCreateCategoryOptions}
+     * @returns Promise resolving to the created {@link FeedbackCategoryResponse}
+     * @example
+     * ```typescript
+     * import { Feedback } from '@uipath/uipath-typescript/feedback';
+     *
+     * const feedback = new Feedback(sdk);
+     *
+     * // Minimum — applies to both positive and negative feedback by default
+     * const category = await feedback.createCategory('Hallucination');
+     * console.log(category.id, category.category);
+     *
+     * // With explicit flags
+     * const negativeOnly = await feedback.createCategory('Off-topic', {
+     *   isPositive: false,
+     *   isNegative: true,
+     * });
+     * ```
+     */
+    async createCategory(category, options) {
+        if (!category)
+            throw new ValidationError({ message: 'category name is required for createCategory' });
+        const body = { category };
+        if (options?.isPositive !== undefined)
+            body.isPositive = options.isPositive;
+        if (options?.isNegative !== undefined)
+            body.isNegative = options.isNegative;
+        const response = await this.post(FEEDBACK_ENDPOINTS.CATEGORY.CREATE, body);
+        return transformData(response.data, FeedbackMap);
+    }
+    /**
+     * Gets all feedback categories for the tenant.
+     *
+     * Returns both system default categories (Output, Agent Error, Agent Plan Execution)
+     * and any custom categories created for this tenant.
+     * When no pagination options are provided, the SDK returns up to 100 items. When pagination options are provided without a pageSize, the SDK defaults to 50 items per page.
+     *
+     * @param options - Optional filters and pagination options {@link FeedbackGetCategoriesOptions}
+     * @returns Promise resolving to {@link NonPaginatedResponse} of {@link FeedbackCategoryResponse} without pagination options, or {@link PaginatedResponse} of {@link FeedbackCategoryResponse} when pagination options are used.
+     * @example
+     * ```typescript
+     * import { Feedback } from '@uipath/uipath-typescript/feedback';
+     *
+     * const feedback = new Feedback(sdk);
+     *
+     * // Get all categories
+     * const categories = await feedback.getCategories();
+     * console.log(categories.items.map(c => c.category));
+     *
+     * // Get only categories applicable to negative feedback
+     * const negativeCategories = await feedback.getCategories({ isNegative: true });
+     *
+     * // Paginated
+     * const page1 = await feedback.getCategories({ pageSize: 10 });
+     * ```
+     */
+    async getCategories(options) {
+        const transformCategory = (item) => transformData(item, FeedbackMap);
+        return PaginationHelpers.getAll({
+            serviceAccess: this.createPaginationServiceAccess(),
+            getEndpoint: () => FEEDBACK_ENDPOINTS.CATEGORY.GET_ALL,
+            transformFn: transformCategory,
+            pagination: {
+                paginationType: PaginationType.OFFSET,
+                itemsField: FEEDBACK_CATEGORY_PAGINATION.ITEMS_FIELD,
+                totalCountField: FEEDBACK_CATEGORY_PAGINATION.TOTAL_COUNT_FIELD,
+                paginationParams: {
+                    pageSizeParam: FEEDBACK_OFFSET_PARAMS.PAGE_SIZE_PARAM,
+                    offsetParam: FEEDBACK_OFFSET_PARAMS.OFFSET_PARAM,
+                    countParam: FEEDBACK_OFFSET_PARAMS.COUNT_PARAM,
+                },
+            },
+            excludeFromPrefix: Object.keys(options || {}),
+        }, options);
+    }
+    /**
+     * Deletes a feedback category by its ID.
+     *
+     * System default categories (Output, Agent Error, Agent Plan Execution) cannot be deleted —
+     * attempting to do so throws a `409 Conflict` error.
+     * Use `forceDelete` to delete a custom category that already has feedback entries associated with it.
+     *
+     * @param id - Category ID (GUID) of the category to delete
+     * @param options - Optional deletion options {@link FeedbackDeleteCategoryOptions}
+     * @returns Promise resolving to void on success
+     * @example
+     * ```typescript
+     * import { Feedback } from '@uipath/uipath-typescript/feedback';
+     *
+     * const feedback = new Feedback(sdk);
+     *
+     * // Only custom categories (isDefault: false) can be deleted
+     * const categories = await feedback.getCategories();
+     * const customCategory = categories.items.find(c => !c.isDefault);
+     * if (customCategory) {
+     *   await feedback.deleteCategory(customCategory.id);
+     * }
+     * ```
+     * @example
+     * ```typescript
+     * // Force-delete a custom category that has associated feedback entries
+     * const categories = await feedback.getCategories();
+     * const customCategory = categories.items.find(c => !c.isDefault);
+     * if (customCategory) {
+     *   await feedback.deleteCategory(customCategory.id, { forceDelete: true });
+     * }
+     * ```
+     */
+    async deleteCategory(id, options) {
+        if (!id)
+            throw new ValidationError({ message: 'Category ID is required for deleteCategory' });
+        const params = options?.forceDelete !== undefined ? { forceDelete: options.forceDelete } : undefined;
+        await this.delete(FEEDBACK_ENDPOINTS.CATEGORY.DELETE(id), { params });
+    }
 }
 __decorate([
     track('Feedback.GetAll')
@@ -1928,6 +2193,24 @@ __decorate([
 __decorate([
     track('Feedback.GetById')
 ], FeedbackService.prototype, "getById", null);
+__decorate([
+    track('Feedback.Submit')
+], FeedbackService.prototype, "submit", null);
+__decorate([
+    track('Feedback.UpdateById')
+], FeedbackService.prototype, "updateById", null);
+__decorate([
+    track('Feedback.DeleteById')
+], FeedbackService.prototype, "deleteById", null);
+__decorate([
+    track('Feedback.CreateCategory')
+], FeedbackService.prototype, "createCategory", null);
+__decorate([
+    track('Feedback.GetCategories')
+], FeedbackService.prototype, "getCategories", null);
+__decorate([
+    track('Feedback.DeleteCategory')
+], FeedbackService.prototype, "deleteCategory", null);
 
 /**
  * Status of a feedback entry in the review workflow