@uipath/uipath-typescript 1.3.11 → 1.4.1

package/dist/assets/index.cjs

@@ -721,6 +721,32 @@ function filterUndefined(obj) {
  */
 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
@@ -1232,12 +1258,18 @@ class PaginationHelpers {
      * @returns Promise resolving to a paginated result
      */
     static async getAllPaginated(params) {
-        const { serviceAccess, getEndpoint, folderId, headers: providedHeaders, paginationParams, additionalParams, transformFn, method = HTTP_METHODS.GET, options = {} } = params;
+        const { serviceAccess, getEndpoint, folderId, headers: providedHeaders, paginationParams, additionalParams, queryParams, transformFn, method = HTTP_METHODS.GET, options = {} } = params;
         const endpoint = getEndpoint(folderId);
         const headers = providedHeaders ?? (folderId ? createHeaders({ [FOLDER_ID]: folderId }) : {});
+        // On POST, the caller's options go in the body; queryParams stays in the URL.
+        // On GET, everything is URL — queryParams merges with additionalParams.
+        const isPost = method === HTTP_METHODS.POST;
+        const requestSpec = isPost
+            ? { body: additionalParams, params: queryParams }
+            : { params: { ...additionalParams, ...queryParams } };
         const paginatedResponse = await serviceAccess.requestWithPagination(method, endpoint, paginationParams, {
             headers,
-            params: additionalParams,
+            ...requestSpec,
             pagination: {
                 paginationType: options.paginationType || PaginationType.OFFSET,
                 itemsField: options.itemsField || DEFAULT_ITEMS_FIELD,
@@ -1262,7 +1294,7 @@ class PaginationHelpers {
      * @returns Promise resolving to an object with data and totalCount
      */
     static async getAllNonPaginated(params) {
-        const { serviceAccess, getAllEndpoint, getByFolderEndpoint, folderId, headers: providedHeaders, additionalParams, transformFn, method = HTTP_METHODS.GET, options = {} } = params;
+        const { serviceAccess, getAllEndpoint, getByFolderEndpoint, folderId, headers: providedHeaders, additionalParams, queryParams, transformFn, method = HTTP_METHODS.GET, options = {} } = params;
         // Set default field names
         const itemsField = options.itemsField || DEFAULT_ITEMS_FIELD;
         const totalCountField = options.totalCountField || DEFAULT_TOTAL_COUNT_FIELD;
@@ -1272,17 +1304,18 @@ class PaginationHelpers {
         // Make the API call based on method
         let response;
         if (method === HTTP_METHODS.POST) {
-            response = await serviceAccess.post(endpoint, additionalParams, { headers });
+            response = await serviceAccess.post(endpoint, additionalParams, { headers, params: queryParams });
         }
         else {
             response = await serviceAccess.get(endpoint, {
-                params: additionalParams,
+                params: { ...additionalParams, ...queryParams },
                 headers
             });
         }
         // 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
@@ -1328,8 +1361,9 @@ 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,
+                queryParams: config.queryParams,
                 transformFn: config.transformFn,
                 method: config.method,
                 options: {
@@ -1347,6 +1381,7 @@ class PaginationHelpers {
             folderId,
             headers: config.headers,
             additionalParams: prefixedOptions,
+            queryParams: config.queryParams,
             transformFn: config.transformFn,
             method: config.method,
             options: {
@@ -1538,18 +1573,17 @@ class BaseService {
         const params = this.validateAndPreparePaginationParams(paginationType, paginationOptions);
         // Prepare request parameters based on pagination type
         const requestParams = this.preparePaginationRequestParams(paginationType, params, options.pagination);
-        // For POST requests, merge pagination params into body and set params to undefined; for GET, use query params
+        // Route pagination state to wherever the API expects it (body for POST, URL for GET).
+        // Caller-supplied options.body / options.params are respected as-is — the api-client
+        // already handles params (URL) and body (request body) independently for every method.
         if (method.toUpperCase() === 'POST') {
             const existingBody = (options.body && typeof options.body === 'object') ? options.body : {};
             options.body = {
                 ...existingBody,
-                ...options.params,
                 ...requestParams
             };
-            options.params = undefined;
         }
         else {
-            // Merge pagination parameters with existing parameters
             options.params = {
                 ...options.params,
                 ...requestParams
@@ -1586,6 +1620,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) {
@@ -1593,7 +1629,8 @@ class BaseService {
                     }
                 }
                 else {
-                    requestParams[offsetParam] = params.pageNumber || 1;
+                    const sdkPageNumber = params.pageNumber || 1;
+                    requestParams[offsetParam] = zeroBased ? sdkPageNumber - 1 : sdkPageNumber;
                 }
                 {
                     requestParams[countParam] = true;
@@ -1622,8 +1659,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];
@@ -1872,6 +1910,26 @@ function describeFolderForError(folderId, folderKey, folderPath) {
     return '';
 }
 
+/**
+ * Enum for Asset Value Scope
+ */
+exports.AssetValueScope = void 0;
+(function (AssetValueScope) {
+    AssetValueScope["Global"] = "Global";
+    AssetValueScope["PerRobot"] = "PerRobot";
+})(exports.AssetValueScope || (exports.AssetValueScope = {}));
+/**
+ * Enum for Asset Value Type
+ */
+exports.AssetValueType = void 0;
+(function (AssetValueType) {
+    AssetValueType["Text"] = "Text";
+    AssetValueType["Bool"] = "Bool";
+    AssetValueType["Integer"] = "Integer";
+    AssetValueType["Credential"] = "Credential";
+    AssetValueType["Secret"] = "Secret";
+})(exports.AssetValueType || (exports.AssetValueType = {}));
+
 /**
  * Base path constants for different services
  */
@@ -2042,6 +2100,68 @@ class AssetService extends FolderScopedService {
     async getByName(name, options = {}) {
         return this.getByNameLookup('Asset', ASSET_ENDPOINTS.GET_BY_FOLDER, name, options, (raw) => transformData(pascalToCamelCaseKeys(raw), AssetMap));
     }
+    /**
+     * Updates the value of an existing asset by ID.
+     *
+     * Fetches the asset internally to determine its type, then updates only the value while
+     * preserving the asset's name, scope, and description.
+     *
+     * **Supported value types:** `Text`, `Integer`, and `Bool` only. Other types
+     * (`Credential`, `Secret`) throw a `ValidationError`.
+     *
+     * The `newValue` runtime type must match the asset's `valueType`:
+     * - `Text` → `string`
+     * - `Integer` → `number` (integer)
+     * - `Bool` → `boolean`
+     *
+     * @param id - Asset ID
+     * @param newValue - New value to apply (string for `Text`, number for `Integer`, boolean for `Bool`)
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`)
+     * @returns Promise resolving when the asset has been updated
+     *
+     * @example
+     * ```typescript
+     * import { Assets } from '@uipath/uipath-typescript/assets';
+     *
+     * const assets = new Assets(sdk);
+     *
+     * // Update a Text asset by folder ID
+     * await assets.updateValueById(<assetId>, 'new-value', { folderId: <folderId> });
+     *
+     * // Update an Integer asset by folder key (GUID)
+     * await assets.updateValueById(<assetId>, 42, { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
+     *
+     * // Update a Bool asset by folder path
+     * await assets.updateValueById(<assetId>, true, { folderPath: 'Shared/Finance' });
+     * ```
+     */
+    async updateValueById(id, newValue, options) {
+        if (!id) {
+            throw new ValidationError({ message: 'id is required for updateValueById' });
+        }
+        if (newValue === null || newValue === undefined) {
+            throw new ValidationError({ message: 'newValue is required for updateValueById' });
+        }
+        const headers = resolveFolderHeaders({
+            folderId: options?.folderId,
+            folderKey: options?.folderKey,
+            folderPath: options?.folderPath,
+            resourceType: 'Assets.updateValueById',
+            fallbackFolderKey: this.config.folderKey,
+        });
+        const existingResponse = await this.get(ASSET_ENDPOINTS.GET_BY_ID(id), { headers });
+        const existing = existingResponse.data;
+        const valueField = resolveValueField(id, existing.ValueType, newValue);
+        const body = {
+            Id: id,
+            Name: existing.Name,
+            ValueScope: existing.ValueScope,
+            ValueType: existing.ValueType,
+            Description: existing.Description,
+            [valueField]: newValue,
+        };
+        await this.put(ASSET_ENDPOINTS.GET_BY_ID(id), body, { headers });
+    }
 }
 __decorate([
     track('Assets.GetAll')
@@ -2052,30 +2172,42 @@ __decorate([
 __decorate([
     track('Assets.GetByName')
 ], AssetService.prototype, "getByName", null);
-
-/**
- * Enum for Asset Value Scope
- */
-exports.AssetValueScope = void 0;
-(function (AssetValueScope) {
-    AssetValueScope["Global"] = "Global";
-    AssetValueScope["PerRobot"] = "PerRobot";
-})(exports.AssetValueScope || (exports.AssetValueScope = {}));
-/**
- * Enum for Asset Value Type
- */
-exports.AssetValueType = void 0;
-(function (AssetValueType) {
-    AssetValueType["DBConnectionString"] = "DBConnectionString";
-    AssetValueType["HttpConnectionString"] = "HttpConnectionString";
-    AssetValueType["Text"] = "Text";
-    AssetValueType["Bool"] = "Bool";
-    AssetValueType["Integer"] = "Integer";
-    AssetValueType["Credential"] = "Credential";
-    AssetValueType["WindowsCredential"] = "WindowsCredential";
-    AssetValueType["KeyValueList"] = "KeyValueList";
-    AssetValueType["Secret"] = "Secret";
-})(exports.AssetValueType || (exports.AssetValueType = {}));
+__decorate([
+    track('Assets.UpdateValueById')
+], AssetService.prototype, "updateValueById", null);
+/**
+ * Maps the asset's `valueType` to the PUT body field carrying the new value, validating
+ * that the new value's runtime type matches the asset type.
+ */
+function resolveValueField(id, valueType, newValue) {
+    switch (valueType) {
+        case exports.AssetValueType.Text:
+            if (typeof newValue !== 'string') {
+                throw new ValidationError({
+                    message: `Asset ${id} has valueType Text; newValue must be a string, got ${typeof newValue}`,
+                });
+            }
+            return 'StringValue';
+        case exports.AssetValueType.Integer:
+            if (typeof newValue !== 'number' || !Number.isInteger(newValue)) {
+                throw new ValidationError({
+                    message: `Asset ${id} has valueType Integer; newValue must be an integer number, got ${typeof newValue}`,
+                });
+            }
+            return 'IntValue';
+        case exports.AssetValueType.Bool:
+            if (typeof newValue !== 'boolean') {
+                throw new ValidationError({
+                    message: `Asset ${id} has valueType Bool; newValue must be a boolean, got ${typeof newValue}`,
+                });
+            }
+            return 'BoolValue';
+        default:
+            throw new ValidationError({
+                message: `updateValueById only supports Text, Integer, or Bool assets; asset ${id} has valueType ${valueType}`,
+            });
+    }
+}
 
 exports.AssetService = AssetService;
 exports.Assets = AssetService;

package/dist/assets/index.d.ts

@@ -107,6 +107,7 @@ interface RequestWithPaginationOptions extends RequestSpec {
             tokenParam?: string;
             countParam?: string;
             convertToSkip?: boolean;
+            zeroBased?: boolean;
         };
     };
 }
@@ -382,14 +383,10 @@ declare enum AssetValueScope {
  * Enum for Asset Value Type
  */
 declare enum AssetValueType {
-    DBConnectionString = "DBConnectionString",
-    HttpConnectionString = "HttpConnectionString",
     Text = "Text",
     Bool = "Bool",
     Integer = "Integer",
     Credential = "Credential",
-    WindowsCredential = "WindowsCredential",
-    KeyValueList = "KeyValueList",
     Secret = "Secret"
 }
 /**
@@ -439,6 +436,20 @@ interface AssetGetByIdOptions extends BaseOptions {
  */
 interface AssetGetByNameOptions extends FolderScopedOptions {
 }
+/**
+ * New value accepted by {@link AssetServiceModel.updateValueById}.
+ *
+ * The runtime type must match the asset's `valueType`:
+ * - `Text` → `string`
+ * - `Integer` → `number`
+ * - `Bool` → `boolean`
+ */
+type AssetNewValue = string | number | boolean;
+/**
+ * Options for updating an asset value by ID
+ */
+interface AssetUpdateValueByIdOptions extends FolderScopedOptions {
+}
 
 /**
  * Service for managing UiPath Assets.
@@ -523,6 +534,38 @@ interface AssetServiceModel {
      * ```
      */
     getByName(name: string, options?: AssetGetByNameOptions): Promise<AssetGetResponse>;
+    /**
+     * Updates the value of an existing asset by ID.
+     *
+     * Fetches the asset internally to determine its type, then updates only the value while
+     * preserving the asset's name, scope, and description.
+     *
+     * **Supported value types:** `Text`, `Integer`, and `Bool` only. Other types
+     * (`Credential`, `Secret`) throw a `ValidationError`.
+     *
+     * The `newValue` runtime type must match the asset's `valueType`:
+     * - `Text` → `string`
+     * - `Integer` → `number` (integer)
+     * - `Bool` → `boolean`
+     *
+     * @param id - Asset ID
+     * @param newValue - New value to apply (string for `Text`, number for `Integer`, boolean for `Bool`)
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`)
+     * @returns Promise resolving when the asset has been updated
+     *
+     * @example
+     * ```typescript
+     * // Update a Text asset by folder ID
+     * await assets.updateValueById(<assetId>, 'new-value', { folderId: <folderId> });
+     *
+     * // Update an Integer asset by folder key (GUID)
+     * await assets.updateValueById(<assetId>, 42, { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
+     *
+     * // Update a Bool asset by folder path
+     * await assets.updateValueById(<assetId>, true, { folderPath: 'Shared/Finance' });
+     * ```
+     */
+    updateValueById(id: number, newValue: AssetNewValue, options?: AssetUpdateValueByIdOptions): Promise<void>;
 }
 
 /**
@@ -610,7 +653,43 @@ declare class AssetService extends FolderScopedService implements AssetServiceMo
      * ```
      */
     getByName(name: string, options?: AssetGetByNameOptions): Promise<AssetGetResponse>;
+    /**
+     * Updates the value of an existing asset by ID.
+     *
+     * Fetches the asset internally to determine its type, then updates only the value while
+     * preserving the asset's name, scope, and description.
+     *
+     * **Supported value types:** `Text`, `Integer`, and `Bool` only. Other types
+     * (`Credential`, `Secret`) throw a `ValidationError`.
+     *
+     * The `newValue` runtime type must match the asset's `valueType`:
+     * - `Text` → `string`
+     * - `Integer` → `number` (integer)
+     * - `Bool` → `boolean`
+     *
+     * @param id - Asset ID
+     * @param newValue - New value to apply (string for `Text`, number for `Integer`, boolean for `Bool`)
+     * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`)
+     * @returns Promise resolving when the asset has been updated
+     *
+     * @example
+     * ```typescript
+     * import { Assets } from '@uipath/uipath-typescript/assets';
+     *
+     * const assets = new Assets(sdk);
+     *
+     * // Update a Text asset by folder ID
+     * await assets.updateValueById(<assetId>, 'new-value', { folderId: <folderId> });
+     *
+     * // Update an Integer asset by folder key (GUID)
+     * await assets.updateValueById(<assetId>, 42, { folderKey: '5f6dadf1-3677-49dc-8aca-c2999dd4b3ba' });
+     *
+     * // Update a Bool asset by folder path
+     * await assets.updateValueById(<assetId>, true, { folderPath: 'Shared/Finance' });
+     * ```
+     */
+    updateValueById(id: number, newValue: AssetNewValue, options?: AssetUpdateValueByIdOptions): Promise<void>;
 }
 
 export { AssetService, AssetValueScope, AssetValueType, AssetService as Assets };
-export type { AssetGetAllOptions, AssetGetByIdOptions, AssetGetByNameOptions, AssetGetResponse, AssetServiceModel, CustomKeyValuePair };
+export type { AssetGetAllOptions, AssetGetByIdOptions, AssetGetByNameOptions, AssetGetResponse, AssetNewValue, AssetServiceModel, AssetUpdateValueByIdOptions, CustomKeyValuePair };