@uipath/uipath-typescript 1.5.0 → 1.5.1

package/dist/buckets/index.cjs

@@ -1128,6 +1128,97 @@ function addPrefixToKeys(obj, prefix, keys) {
     }
     return result;
 }
+/**
+ * Creates a new map with the keys and values reversed
+ * @param map The original map to reverse
+ * @returns A new map with keys and values swapped
+ *
+ * @example
+ * ```typescript
+ * const original = { key1: 'value1', key2: 'value2' };
+ * const reversed = reverseMap(original);
+ * // reversed = { value1: 'key1', value2: 'key2' }
+ * ```
+ */
+function reverseMap(map) {
+    return Object.entries(map).reduce((acc, [key, value]) => {
+        acc[value] = key;
+        return acc;
+    }, {});
+}
+/**
+ * OData query-string keys whose values may contain field identifiers that
+ * need rewriting from SDK names → API names.
+ */
+const ODATA_FIELD_PARAM_KEYS = ['filter', 'orderby', 'select', 'expand'];
+/**
+ * Matches one token at a time in an OData expression:
+ *   1. A single-quoted string literal, allowing the `''` escape sequence —
+ *      consumed atomically so identifiers inside the literal can't match.
+ *   2. An OData identifier (`[A-Za-z_][A-Za-z0-9_]*`).
+ * Anything else (whitespace, operators, parens, commas) is left alone by
+ * `String.prototype.replace`, which only substitutes matched substrings.
+ */
+const ODATA_TOKEN_RE = /'(?:[^']|'')*'|[A-Za-z_][A-Za-z0-9_]*/g;
+/**
+ * Rewrites SDK field identifiers to API field identifiers inside an OData
+ * expression string (`$filter`, `$orderby`, `$select`, `$expand`).
+ *
+ * Field maps (e.g. `JobMap`) rename API fields → SDK fields on responses, so
+ * SDK consumers see the renamed names. Without this rewrite, the same name
+ * in a `filter` string would be forwarded verbatim and the API (which still
+ * uses the original name) would reject it.
+ *
+ * Quoted string literals (with the OData `''` escape) are preserved exactly:
+ * the token regex consumes them whole, so identifiers inside literals never
+ * match. Identifier tokens are looked up in the reversed field map.
+ *
+ * @example
+ * ```typescript
+ * const requestMap = { processName: 'releaseName' };
+ * rewriteODataIdentifiers("processName eq 'processName'", requestMap);
+ * // "releaseName eq 'processName'"  — identifier rewritten, literal preserved
+ * ```
+ */
+function rewriteODataIdentifiers(expression, requestMap) {
+    if (!expression)
+        return expression;
+    return expression.replace(ODATA_TOKEN_RE, (match) => match.startsWith("'") ? match : (requestMap[match] ?? match));
+}
+/**
+ * Symmetric counterpart of {@link transformRequest} for OData query options:
+ * rewrites SDK field identifiers inside the recognized OData string params
+ * (`filter`, `orderby`, `select`, `expand`) to their API names using the
+ * reversed form of a response field map. Returns a shallow copy with the
+ * relevant values rewritten; other keys pass through unchanged.
+ *
+ * Use at the OData edge so SDK consumers can refer to renamed fields by
+ * their SDK name throughout — for reading the response and for filtering /
+ * sorting / projecting / expanding.
+ *
+ * @param options The OData query options as authored with SDK field names
+ * @param responseMap The response field map (API → SDK); reversed internally
+ *
+ * @example
+ * ```typescript
+ * // JobMap renames releaseName → processName on responses.
+ * transformOptions({ filter: "processName eq 'X'" }, JobMap);
+ * // { filter: "releaseName eq 'X'" }
+ * ```
+ */
+function transformOptions(options, responseMap) {
+    const requestMap = reverseMap(responseMap);
+    if (Object.keys(requestMap).length === 0)
+        return options;
+    const result = { ...options };
+    for (const key of ODATA_FIELD_PARAM_KEYS) {
+        const value = result[key];
+        if (typeof value === 'string') {
+            result[key] = rewriteODataIdentifiers(value, requestMap);
+        }
+    }
+    return result;
+}
 /**
  * Transforms an array-based dictionary with separate keys and values arrays
  * into a standard JavaScript object/record
@@ -1925,9 +2016,12 @@ class FolderScopedService extends BaseService {
      * @param name - Resource name to search for
      * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) + OData query options (`expand`, `select`)
      * @param transform - Maps a raw OData item to the typed response (e.g. PascalCase → camelCase via field map)
+     * @param responseFieldMap - Optional response field map (API → SDK), reversed internally by
+     *   `transformOptions` to rewrite SDK field names back to API names in user-supplied
+     *   `expand` / `select` (symmetric counterpart to `transform`)
      * @throws ValidationError when inputs are malformed; NotFoundError when no match
      */
-    async getByNameLookup(resourceType, endpoint, name, options, transform) {
+    async getByNameLookup(resourceType, endpoint, name, options, transform, responseFieldMap) {
         const validatedName = validateName(resourceType, name);
         const { folderId, folderKey, folderPath, ...queryOptions } = options;
         const headers = resolveFolderHeaders({
@@ -1937,8 +2031,11 @@ class FolderScopedService extends BaseService {
             resourceType: `${resourceType}.getByName`,
             fallbackFolderKey: this.config.folderKey,
         });
+        const apiFieldOptions = responseFieldMap
+            ? transformOptions(queryOptions, responseFieldMap)
+            : queryOptions;
         const apiOptions = {
-            ...addPrefixToKeys(queryOptions, ODATA_PREFIX, Object.keys(queryOptions)),
+            ...addPrefixToKeys(apiFieldOptions, ODATA_PREFIX, Object.keys(apiFieldOptions)),
             '$filter': `Name eq '${validatedName.replace(SINGLE_QUOTE_RE, "''")}'`,
             '$top': '1',
         };
@@ -2183,6 +2280,9 @@ class BucketService extends FolderScopedService {
         });
         // Transformation function for blob items
         const transformBlobItem = (item) => transformData(item, BucketMap);
+        // Rewrite renamed SDK field names → API names inside OData strings
+        // before delegating.
+        const apiRestOptions = transformOptions(restOptions, BucketMap);
         return PaginationHelpers.getAll({
             serviceAccess: this.createPaginationServiceAccess(),
             getEndpoint: () => BUCKET_ENDPOINTS.GET_FILE_META_DATA(bucketId),
@@ -2198,7 +2298,7 @@ class BucketService extends FolderScopedService {
             },
             excludeFromPrefix: ['prefix'], // Bucket-specific param, not OData
             headers,
-        }, restOptions);
+        }, apiRestOptions);
     }
     async uploadFile(bucketIdOrOptions, path, content, options) {
         // Normalize the two overload forms into a single internal shape.
@@ -2282,9 +2382,10 @@ class BucketService extends FolderScopedService {
             resourceType: 'Buckets.getReadUri',
             fallbackFolderKey: this.config.folderKey,
         });
+        const apiRestOptions = transformOptions(restOptions, BucketMap);
         const queryOptions = {
             expiryInMinutes,
-            ...addPrefixToKeys(restOptions, ODATA_PREFIX, Object.keys(restOptions))
+            ...addPrefixToKeys(apiRestOptions, ODATA_PREFIX, Object.keys(apiRestOptions))
         };
         return this._getUri(BUCKET_ENDPOINTS.GET_READ_URI(bucketId), bucketId, resolvedPath, headers, queryOptions);
     }
@@ -2404,6 +2505,9 @@ class BucketService extends FolderScopedService {
             fallbackFolderKey: this.config.folderKey,
         });
         const transformBucketFile = (file) => transformData(pascalToCamelCaseKeys(file), BucketMap);
+        // Rewrite renamed SDK field names → API names inside OData strings
+        // before delegating.
+        const apiRestOptions = transformOptions(restOptions, BucketMap);
         return PaginationHelpers.getAll({
             serviceAccess: this.createPaginationServiceAccess(),
             getEndpoint: () => BUCKET_ENDPOINTS.GET_FILES(bucketId),
@@ -2420,7 +2524,7 @@ class BucketService extends FolderScopedService {
             },
             excludeFromPrefix: ['directory', 'recursive', 'fileNameRegex'],
             headers,
-        }, { ...restOptions, directory: '/', recursive: true });
+        }, { ...apiRestOptions, directory: '/', recursive: true });
     }
     /**
      * Deletes a file from a bucket
@@ -2467,9 +2571,10 @@ class BucketService extends FolderScopedService {
      */
     async _getWriteUri(options) {
         const { bucketId, path, expiryInMinutes, headers, ...restOptions } = options;
+        const apiRestOptions = transformOptions(restOptions, BucketMap);
         const queryOptions = {
             expiryInMinutes,
-            ...addPrefixToKeys(restOptions, ODATA_PREFIX, Object.keys(restOptions))
+            ...addPrefixToKeys(apiRestOptions, ODATA_PREFIX, Object.keys(apiRestOptions))
         };
         return this._getUri(BUCKET_ENDPOINTS.GET_WRITE_URI(bucketId), bucketId, path, headers, queryOptions);
     }

package/dist/buckets/index.d.ts

@@ -326,6 +326,14 @@ interface FolderScopedOptions extends BaseOptions {
     folderPath?: string;
 }
 
+/**
+ * Type for field mapping configuration
+ * Maps source field names to target field names
+ */
+type FieldMapping = {
+    [sourceField: string]: string;
+};
+
 /**
  * Base service for services that need folder-specific functionality.
  *
@@ -367,9 +375,12 @@ declare class FolderScopedService extends BaseService {
      * @param name - Resource name to search for
      * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) + OData query options (`expand`, `select`)
      * @param transform - Maps a raw OData item to the typed response (e.g. PascalCase → camelCase via field map)
+     * @param responseFieldMap - Optional response field map (API → SDK), reversed internally by
+     *   `transformOptions` to rewrite SDK field names back to API names in user-supplied
+     *   `expand` / `select` (symmetric counterpart to `transform`)
      * @throws ValidationError when inputs are malformed; NotFoundError when no match
      */
-    protected getByNameLookup<TRaw extends object, T>(resourceType: string, endpoint: string, name: string, options: FolderScopedOptions, transform: (raw: TRaw) => T): Promise<T>;
+    protected getByNameLookup<TRaw extends object, T>(resourceType: string, endpoint: string, name: string, options: FolderScopedOptions, transform: (raw: TRaw) => T, responseFieldMap?: FieldMapping): Promise<T>;
 }
 
 declare enum BucketOptions {

package/dist/buckets/index.mjs

@@ -1126,6 +1126,97 @@ function addPrefixToKeys(obj, prefix, keys) {
     }
     return result;
 }
+/**
+ * Creates a new map with the keys and values reversed
+ * @param map The original map to reverse
+ * @returns A new map with keys and values swapped
+ *
+ * @example
+ * ```typescript
+ * const original = { key1: 'value1', key2: 'value2' };
+ * const reversed = reverseMap(original);
+ * // reversed = { value1: 'key1', value2: 'key2' }
+ * ```
+ */
+function reverseMap(map) {
+    return Object.entries(map).reduce((acc, [key, value]) => {
+        acc[value] = key;
+        return acc;
+    }, {});
+}
+/**
+ * OData query-string keys whose values may contain field identifiers that
+ * need rewriting from SDK names → API names.
+ */
+const ODATA_FIELD_PARAM_KEYS = ['filter', 'orderby', 'select', 'expand'];
+/**
+ * Matches one token at a time in an OData expression:
+ *   1. A single-quoted string literal, allowing the `''` escape sequence —
+ *      consumed atomically so identifiers inside the literal can't match.
+ *   2. An OData identifier (`[A-Za-z_][A-Za-z0-9_]*`).
+ * Anything else (whitespace, operators, parens, commas) is left alone by
+ * `String.prototype.replace`, which only substitutes matched substrings.
+ */
+const ODATA_TOKEN_RE = /'(?:[^']|'')*'|[A-Za-z_][A-Za-z0-9_]*/g;
+/**
+ * Rewrites SDK field identifiers to API field identifiers inside an OData
+ * expression string (`$filter`, `$orderby`, `$select`, `$expand`).
+ *
+ * Field maps (e.g. `JobMap`) rename API fields → SDK fields on responses, so
+ * SDK consumers see the renamed names. Without this rewrite, the same name
+ * in a `filter` string would be forwarded verbatim and the API (which still
+ * uses the original name) would reject it.
+ *
+ * Quoted string literals (with the OData `''` escape) are preserved exactly:
+ * the token regex consumes them whole, so identifiers inside literals never
+ * match. Identifier tokens are looked up in the reversed field map.
+ *
+ * @example
+ * ```typescript
+ * const requestMap = { processName: 'releaseName' };
+ * rewriteODataIdentifiers("processName eq 'processName'", requestMap);
+ * // "releaseName eq 'processName'"  — identifier rewritten, literal preserved
+ * ```
+ */
+function rewriteODataIdentifiers(expression, requestMap) {
+    if (!expression)
+        return expression;
+    return expression.replace(ODATA_TOKEN_RE, (match) => match.startsWith("'") ? match : (requestMap[match] ?? match));
+}
+/**
+ * Symmetric counterpart of {@link transformRequest} for OData query options:
+ * rewrites SDK field identifiers inside the recognized OData string params
+ * (`filter`, `orderby`, `select`, `expand`) to their API names using the
+ * reversed form of a response field map. Returns a shallow copy with the
+ * relevant values rewritten; other keys pass through unchanged.
+ *
+ * Use at the OData edge so SDK consumers can refer to renamed fields by
+ * their SDK name throughout — for reading the response and for filtering /
+ * sorting / projecting / expanding.
+ *
+ * @param options The OData query options as authored with SDK field names
+ * @param responseMap The response field map (API → SDK); reversed internally
+ *
+ * @example
+ * ```typescript
+ * // JobMap renames releaseName → processName on responses.
+ * transformOptions({ filter: "processName eq 'X'" }, JobMap);
+ * // { filter: "releaseName eq 'X'" }
+ * ```
+ */
+function transformOptions(options, responseMap) {
+    const requestMap = reverseMap(responseMap);
+    if (Object.keys(requestMap).length === 0)
+        return options;
+    const result = { ...options };
+    for (const key of ODATA_FIELD_PARAM_KEYS) {
+        const value = result[key];
+        if (typeof value === 'string') {
+            result[key] = rewriteODataIdentifiers(value, requestMap);
+        }
+    }
+    return result;
+}
 /**
  * Transforms an array-based dictionary with separate keys and values arrays
  * into a standard JavaScript object/record
@@ -1923,9 +2014,12 @@ class FolderScopedService extends BaseService {
      * @param name - Resource name to search for
      * @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) + OData query options (`expand`, `select`)
      * @param transform - Maps a raw OData item to the typed response (e.g. PascalCase → camelCase via field map)
+     * @param responseFieldMap - Optional response field map (API → SDK), reversed internally by
+     *   `transformOptions` to rewrite SDK field names back to API names in user-supplied
+     *   `expand` / `select` (symmetric counterpart to `transform`)
      * @throws ValidationError when inputs are malformed; NotFoundError when no match
      */
-    async getByNameLookup(resourceType, endpoint, name, options, transform) {
+    async getByNameLookup(resourceType, endpoint, name, options, transform, responseFieldMap) {
         const validatedName = validateName(resourceType, name);
         const { folderId, folderKey, folderPath, ...queryOptions } = options;
         const headers = resolveFolderHeaders({
@@ -1935,8 +2029,11 @@ class FolderScopedService extends BaseService {
             resourceType: `${resourceType}.getByName`,
             fallbackFolderKey: this.config.folderKey,
         });
+        const apiFieldOptions = responseFieldMap
+            ? transformOptions(queryOptions, responseFieldMap)
+            : queryOptions;
         const apiOptions = {
-            ...addPrefixToKeys(queryOptions, ODATA_PREFIX, Object.keys(queryOptions)),
+            ...addPrefixToKeys(apiFieldOptions, ODATA_PREFIX, Object.keys(apiFieldOptions)),
             '$filter': `Name eq '${validatedName.replace(SINGLE_QUOTE_RE, "''")}'`,
             '$top': '1',
         };
@@ -2181,6 +2278,9 @@ class BucketService extends FolderScopedService {
         });
         // Transformation function for blob items
         const transformBlobItem = (item) => transformData(item, BucketMap);
+        // Rewrite renamed SDK field names → API names inside OData strings
+        // before delegating.
+        const apiRestOptions = transformOptions(restOptions, BucketMap);
         return PaginationHelpers.getAll({
             serviceAccess: this.createPaginationServiceAccess(),
             getEndpoint: () => BUCKET_ENDPOINTS.GET_FILE_META_DATA(bucketId),
@@ -2196,7 +2296,7 @@ class BucketService extends FolderScopedService {
             },
             excludeFromPrefix: ['prefix'], // Bucket-specific param, not OData
             headers,
-        }, restOptions);
+        }, apiRestOptions);
     }
     async uploadFile(bucketIdOrOptions, path, content, options) {
         // Normalize the two overload forms into a single internal shape.
@@ -2280,9 +2380,10 @@ class BucketService extends FolderScopedService {
             resourceType: 'Buckets.getReadUri',
             fallbackFolderKey: this.config.folderKey,
         });
+        const apiRestOptions = transformOptions(restOptions, BucketMap);
         const queryOptions = {
             expiryInMinutes,
-            ...addPrefixToKeys(restOptions, ODATA_PREFIX, Object.keys(restOptions))
+            ...addPrefixToKeys(apiRestOptions, ODATA_PREFIX, Object.keys(apiRestOptions))
         };
         return this._getUri(BUCKET_ENDPOINTS.GET_READ_URI(bucketId), bucketId, resolvedPath, headers, queryOptions);
     }
@@ -2402,6 +2503,9 @@ class BucketService extends FolderScopedService {
             fallbackFolderKey: this.config.folderKey,
         });
         const transformBucketFile = (file) => transformData(pascalToCamelCaseKeys(file), BucketMap);
+        // Rewrite renamed SDK field names → API names inside OData strings
+        // before delegating.
+        const apiRestOptions = transformOptions(restOptions, BucketMap);
         return PaginationHelpers.getAll({
             serviceAccess: this.createPaginationServiceAccess(),
             getEndpoint: () => BUCKET_ENDPOINTS.GET_FILES(bucketId),
@@ -2418,7 +2522,7 @@ class BucketService extends FolderScopedService {
             },
             excludeFromPrefix: ['directory', 'recursive', 'fileNameRegex'],
             headers,
-        }, { ...restOptions, directory: '/', recursive: true });
+        }, { ...apiRestOptions, directory: '/', recursive: true });
     }
     /**
      * Deletes a file from a bucket
@@ -2465,9 +2569,10 @@ class BucketService extends FolderScopedService {
      */
     async _getWriteUri(options) {
         const { bucketId, path, expiryInMinutes, headers, ...restOptions } = options;
+        const apiRestOptions = transformOptions(restOptions, BucketMap);
         const queryOptions = {
             expiryInMinutes,
-            ...addPrefixToKeys(restOptions, ODATA_PREFIX, Object.keys(restOptions))
+            ...addPrefixToKeys(apiRestOptions, ODATA_PREFIX, Object.keys(apiRestOptions))
         };
         return this._getUri(BUCKET_ENDPOINTS.GET_WRITE_URI(bucketId), bucketId, path, headers, queryOptions);
     }