@uipath/uipath-typescript 1.4.2 → 1.5.0

package/dist/jobs/index.cjs

@@ -956,7 +956,16 @@ const BUCKET_TOKEN_PARAMS = {
  * Returns the original value if parsing fails.
  */
 /**
- * Transforms data by mapping fields according to the provided field mapping
+ * Transforms data by renaming each key in `data` exactly once, using the
+ * mapping (`sourceField → targetField`). Keys not present in the mapping
+ * pass through unchanged. The original (pre-rename) key is dropped — the
+ * result contains only the renamed key.
+ *
+ * Each rename is independent. If the mapping happens to contain chained
+ * entries (`a → b` and `b → c`), they do NOT compose: a field named `a`
+ * in `data` becomes `b` (not `c`), because the renames are applied based
+ * on the original data's keys, not the running result.
+ *
  * @param data The source data to transform
  * @param fieldMapping Object mapping source field names to target field names
  * @returns Transformed data with mapped field names
@@ -979,21 +988,28 @@ const BUCKET_TOKEN_PARAMS = {
  * //   { userId: '123', name: 'john' },
  * //   { userId: '456', name: 'jane' }
  * // ]
+ *
+ * // No chaining — `a → b` does not become `a → c` even if the map has `b → c`.
+ * transformData({ a: 1 }, { a: 'b', b: 'c' });
+ * // result = { b: 1 }
  * ```
  */
 function transformData(data, fieldMapping) {
+    // Pass null/undefined through unchanged — callers (e.g. AttachmentService.getById)
+    // may invoke this on optional fields that an OData `select` excluded.
+    if (data == null) {
+        return data;
+    }
     // Handle array of objects
     if (Array.isArray(data)) {
         return data.map(item => transformData(item, fieldMapping));
     }
-    // Handle single object
-    const result = { ...data };
-    for (const [sourceField, targetField] of Object.entries(fieldMapping)) {
-        if (sourceField in result) {
-            const value = result[sourceField];
-            delete result[sourceField];
-            result[targetField] = value;
-        }
+    // Walk the ORIGINAL data's keys, look up each in the mapping. One rename
+    // per data key — no mutation of an in-progress result, so chains can't form.
+    const result = {};
+    for (const [key, value] of Object.entries(data)) {
+        const renamedKey = fieldMapping[key] ?? key;
+        result[renamedKey] = value;
     }
     return result;
 }
@@ -1103,6 +1119,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
@@ -2294,8 +2401,9 @@ class JobService extends FolderScopedService {
      * const folderJobs = await jobs.getAll({ folderId: <folderId> });
      *
      * // With filtering
-     * const runningJobs = await jobs.getAll({
-     *   filter: "state eq 'Running'"
+     * const recentInvoiceJobs = await jobs.getAll({
+     *   filter: "processName eq 'InvoiceBot'",
+     *   orderby: 'createdTime desc',
      * });
      *
      * // First page with pagination
@@ -2318,6 +2426,10 @@ class JobService extends FolderScopedService {
             const rawJob = transformData(pascalToCamelCaseKeys(job), JobMap);
             return createJobWithMethods(rawJob, 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, JobMap) : options;
         return PaginationHelpers.getAll({
             serviceAccess: this.createPaginationServiceAccess(),
             getEndpoint: () => JOB_ENDPOINTS.GET_ALL,
@@ -2333,7 +2445,7 @@ class JobService extends FolderScopedService {
                     countParam: ODATA_OFFSET_PARAMS.COUNT_PARAM,
                 },
             },
-        }, options);
+        }, apiOptions);
     }
     /**
      * Gets a job by its unique key (GUID).
@@ -2370,8 +2482,8 @@ class JobService extends FolderScopedService {
             throw new ValidationError({ message: 'folderId is required for getById' });
         }
         const headers = createHeaders({ [FOLDER_ID]: folderId });
-        const keysToPrefix = Object.keys(options ?? {});
-        const apiOptions = options ? addPrefixToKeys(options, ODATA_PREFIX, keysToPrefix) : {};
+        const apiFieldOptions = options ? transformOptions(options, JobMap) : {};
+        const apiOptions = addPrefixToKeys(apiFieldOptions, ODATA_PREFIX, Object.keys(apiFieldOptions));
         const response = await this.get(JOB_ENDPOINTS.GET_BY_KEY(id), {
             params: apiOptions,
             headers,
@@ -2674,6 +2786,9 @@ exports.JobState = void 0;
     JobState["Stopped"] = "Stopped";
     JobState["Suspended"] = "Suspended";
     JobState["Resumed"] = "Resumed";
+    JobState["Cancelled"] = "Cancelled";
+    /** Server-side fallback for an unrecognized or missing job state. */
+    JobState["Unknown"] = "Unknown";
 })(exports.JobState || (exports.JobState = {}));
 
 exports.JobService = JobService;

package/dist/jobs/index.d.ts

@@ -312,7 +312,10 @@ declare enum JobState {
     Successful = "Successful",
     Stopped = "Stopped",
     Suspended = "Suspended",
-    Resumed = "Resumed"
+    Resumed = "Resumed",
+    Cancelled = "Cancelled",
+    /** Server-side fallback for an unrecognized or missing job state. */
+    Unknown = "Unknown"
 }
 interface BaseOptions {
     expand?: string;
@@ -741,8 +744,9 @@ interface JobServiceModel {
      * const folderJobs = await jobs.getAll({ folderId: <folderId> });
      *
      * // With filtering
-     * const runningJobs = await jobs.getAll({
-     *   filter: "state eq 'Running'"
+     * const recentInvoiceJobs = await jobs.getAll({
+     *   filter: "processName eq 'InvoiceBot'",
+     *   orderby: 'createdTime desc',
      * });
      *
      * // First page with pagination
@@ -1001,8 +1005,9 @@ declare class JobService extends FolderScopedService implements JobServiceModel
      * const folderJobs = await jobs.getAll({ folderId: <folderId> });
      *
      * // With filtering
-     * const runningJobs = await jobs.getAll({
-     *   filter: "state eq 'Running'"
+     * const recentInvoiceJobs = await jobs.getAll({
+     *   filter: "processName eq 'InvoiceBot'",
+     *   orderby: 'createdTime desc',
      * });
      *
      * // First page with pagination

package/dist/jobs/index.mjs

@@ -954,7 +954,16 @@ const BUCKET_TOKEN_PARAMS = {
  * Returns the original value if parsing fails.
  */
 /**
- * Transforms data by mapping fields according to the provided field mapping
+ * Transforms data by renaming each key in `data` exactly once, using the
+ * mapping (`sourceField → targetField`). Keys not present in the mapping
+ * pass through unchanged. The original (pre-rename) key is dropped — the
+ * result contains only the renamed key.
+ *
+ * Each rename is independent. If the mapping happens to contain chained
+ * entries (`a → b` and `b → c`), they do NOT compose: a field named `a`
+ * in `data` becomes `b` (not `c`), because the renames are applied based
+ * on the original data's keys, not the running result.
+ *
  * @param data The source data to transform
  * @param fieldMapping Object mapping source field names to target field names
  * @returns Transformed data with mapped field names
@@ -977,21 +986,28 @@ const BUCKET_TOKEN_PARAMS = {
  * //   { userId: '123', name: 'john' },
  * //   { userId: '456', name: 'jane' }
  * // ]
+ *
+ * // No chaining — `a → b` does not become `a → c` even if the map has `b → c`.
+ * transformData({ a: 1 }, { a: 'b', b: 'c' });
+ * // result = { b: 1 }
  * ```
  */
 function transformData(data, fieldMapping) {
+    // Pass null/undefined through unchanged — callers (e.g. AttachmentService.getById)
+    // may invoke this on optional fields that an OData `select` excluded.
+    if (data == null) {
+        return data;
+    }
     // Handle array of objects
     if (Array.isArray(data)) {
         return data.map(item => transformData(item, fieldMapping));
     }
-    // Handle single object
-    const result = { ...data };
-    for (const [sourceField, targetField] of Object.entries(fieldMapping)) {
-        if (sourceField in result) {
-            const value = result[sourceField];
-            delete result[sourceField];
-            result[targetField] = value;
-        }
+    // Walk the ORIGINAL data's keys, look up each in the mapping. One rename
+    // per data key — no mutation of an in-progress result, so chains can't form.
+    const result = {};
+    for (const [key, value] of Object.entries(data)) {
+        const renamedKey = fieldMapping[key] ?? key;
+        result[renamedKey] = value;
     }
     return result;
 }
@@ -1101,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
@@ -2292,8 +2399,9 @@ class JobService extends FolderScopedService {
      * const folderJobs = await jobs.getAll({ folderId: <folderId> });
      *
      * // With filtering
-     * const runningJobs = await jobs.getAll({
-     *   filter: "state eq 'Running'"
+     * const recentInvoiceJobs = await jobs.getAll({
+     *   filter: "processName eq 'InvoiceBot'",
+     *   orderby: 'createdTime desc',
      * });
      *
      * // First page with pagination
@@ -2316,6 +2424,10 @@ class JobService extends FolderScopedService {
             const rawJob = transformData(pascalToCamelCaseKeys(job), JobMap);
             return createJobWithMethods(rawJob, 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, JobMap) : options;
         return PaginationHelpers.getAll({
             serviceAccess: this.createPaginationServiceAccess(),
             getEndpoint: () => JOB_ENDPOINTS.GET_ALL,
@@ -2331,7 +2443,7 @@ class JobService extends FolderScopedService {
                     countParam: ODATA_OFFSET_PARAMS.COUNT_PARAM,
                 },
             },
-        }, options);
+        }, apiOptions);
     }
     /**
      * Gets a job by its unique key (GUID).
@@ -2368,8 +2480,8 @@ class JobService extends FolderScopedService {
             throw new ValidationError({ message: 'folderId is required for getById' });
         }
         const headers = createHeaders({ [FOLDER_ID]: folderId });
-        const keysToPrefix = Object.keys(options ?? {});
-        const apiOptions = options ? addPrefixToKeys(options, ODATA_PREFIX, keysToPrefix) : {};
+        const apiFieldOptions = options ? transformOptions(options, JobMap) : {};
+        const apiOptions = addPrefixToKeys(apiFieldOptions, ODATA_PREFIX, Object.keys(apiFieldOptions));
         const response = await this.get(JOB_ENDPOINTS.GET_BY_KEY(id), {
             params: apiOptions,
             headers,
@@ -2672,6 +2784,9 @@ var JobState;
     JobState["Stopped"] = "Stopped";
     JobState["Suspended"] = "Suspended";
     JobState["Resumed"] = "Resumed";
+    JobState["Cancelled"] = "Cancelled";
+    /** Server-side fallback for an unrecognized or missing job state. */
+    JobState["Unknown"] = "Unknown";
 })(JobState || (JobState = {}));
 
 export { JobService, JobState, JobSubState, JobService as Jobs, ServerlessJobType, StopStrategy, createJobWithMethods };