@uipath/uipath-typescript 1.5.0 → 1.5.1

package/dist/queues/index.mjs

@@ -1117,6 +1117,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;
+}
 
 /**
  * Constants used throughout the pagination system
@@ -1880,9 +1971,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({
@@ -1892,8 +1986,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',
         };
@@ -2030,6 +2127,10 @@ class QueueService extends FolderScopedService {
     async getAll(options) {
         // Transformation function for queues
         const transformQueueResponse = (queue) => transformData(pascalToCamelCaseKeys(queue), QueueMap);
+        // Rewrite renamed SDK field names → API names inside OData strings
+        // before delegating, mirroring the transformRequest pattern used for
+        // request bodies.
+        const apiOptions = options ? transformOptions(options, QueueMap) : options;
         return PaginationHelpers.getAll({
             serviceAccess: this.createPaginationServiceAccess(),
             getEndpoint: (folderId) => folderId ? QUEUE_ENDPOINTS.GET_BY_FOLDER : QUEUE_ENDPOINTS.GET_ALL,
@@ -2045,7 +2146,7 @@ class QueueService extends FolderScopedService {
                     countParam: ODATA_OFFSET_PARAMS.COUNT_PARAM
                 }
             }
-        }, options);
+        }, apiOptions);
     }
     /**
      * Gets a single queue by ID
@@ -2066,8 +2167,8 @@ class QueueService extends FolderScopedService {
      */
     async getById(id, folderId, options = {}) {
         const headers = createHeaders({ [FOLDER_ID]: folderId });
-        const keysToPrefix = Object.keys(options);
-        const apiOptions = addPrefixToKeys(options, ODATA_PREFIX, keysToPrefix);
+        const apiFieldOptions = transformOptions(options, QueueMap);
+        const apiOptions = addPrefixToKeys(apiFieldOptions, ODATA_PREFIX, Object.keys(apiFieldOptions));
         const response = await this.get(QUEUE_ENDPOINTS.GET_BY_ID(id), {
             headers,
             params: apiOptions

package/dist/tasks/index.cjs

@@ -983,6 +983,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;
+}
 
 /**
  * Constants used throughout the pagination system
@@ -2276,6 +2367,10 @@ class TaskService extends BaseService {
             const transformedTask = transformData(pascalToCamelCaseKeys(task), TaskMap);
             return createTaskWithMethods(applyDataTransforms(transformedTask, { field: 'status', valueMap: TaskStatusMap }), this);
         };
+        // Rewrite renamed SDK field names → API names inside OData strings
+        // before delegating, mirroring the transformRequest pattern used for
+        // request bodies.
+        const apiOptions = options ? transformOptions(options, TaskMap) : options;
         return PaginationHelpers.getAll({
             serviceAccess: this.createPaginationServiceAccess(),
             getEndpoint: () => endpoint,
@@ -2292,7 +2387,7 @@ class TaskService extends BaseService {
                     countParam: ODATA_OFFSET_PARAMS.COUNT_PARAM // OData OFFSET parameter
                 }
             }
-        }, options);
+        }, apiOptions);
     }
     /**
      * Gets a task by ID
@@ -2328,9 +2423,10 @@ class TaskService extends BaseService {
         const headers = createHeaders({ [FOLDER_ID]: folderId });
         // Add default expand parameters
         const modifiedOptions = this.addDefaultExpand(restOptions);
-        // prefix all keys in options
-        const keysToPrefix = Object.keys(modifiedOptions);
-        const apiOptions = addPrefixToKeys(modifiedOptions, ODATA_PREFIX, keysToPrefix);
+        // Rewrite renamed SDK field names → API names inside OData strings,
+        // then prefix all keys for OData.
+        const apiFieldOptions = transformOptions(modifiedOptions, TaskMap);
+        const apiOptions = addPrefixToKeys(apiFieldOptions, ODATA_PREFIX, Object.keys(apiFieldOptions));
         const response = await this.get(TASK_ENDPOINTS.GET_BY_ID(id), {
             params: apiOptions,
             headers

package/dist/tasks/index.mjs

@@ -981,6 +981,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;
+}
 
 /**
  * Constants used throughout the pagination system
@@ -2274,6 +2365,10 @@ class TaskService extends BaseService {
             const transformedTask = transformData(pascalToCamelCaseKeys(task), TaskMap);
             return createTaskWithMethods(applyDataTransforms(transformedTask, { field: 'status', valueMap: TaskStatusMap }), this);
         };
+        // Rewrite renamed SDK field names → API names inside OData strings
+        // before delegating, mirroring the transformRequest pattern used for
+        // request bodies.
+        const apiOptions = options ? transformOptions(options, TaskMap) : options;
         return PaginationHelpers.getAll({
             serviceAccess: this.createPaginationServiceAccess(),
             getEndpoint: () => endpoint,
@@ -2290,7 +2385,7 @@ class TaskService extends BaseService {
                     countParam: ODATA_OFFSET_PARAMS.COUNT_PARAM // OData OFFSET parameter
                 }
             }
-        }, options);
+        }, apiOptions);
     }
     /**
      * Gets a task by ID
@@ -2326,9 +2421,10 @@ class TaskService extends BaseService {
         const headers = createHeaders({ [FOLDER_ID]: folderId });
         // Add default expand parameters
         const modifiedOptions = this.addDefaultExpand(restOptions);
-        // prefix all keys in options
-        const keysToPrefix = Object.keys(modifiedOptions);
-        const apiOptions = addPrefixToKeys(modifiedOptions, ODATA_PREFIX, keysToPrefix);
+        // Rewrite renamed SDK field names → API names inside OData strings,
+        // then prefix all keys for OData.
+        const apiFieldOptions = transformOptions(modifiedOptions, TaskMap);
+        const apiOptions = addPrefixToKeys(apiFieldOptions, ODATA_PREFIX, Object.keys(apiFieldOptions));
         const response = await this.get(TASK_ENDPOINTS.GET_BY_ID(id), {
             params: apiOptions,
             headers