@uipath/uipath-typescript 1.0.0-beta.10

package/dist/utils/transform.js

@@ -0,0 +1,334 @@
+/**
+ * Transforms data by mapping fields according to the provided field mapping
+ * @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
+ *
+ * @example
+ * ```typescript
+ * // Single object transformation
+ * const data = { id: '123', userName: 'john' };
+ * const mapping = { id: 'userId', userName: 'name' };
+ * const result = transformData(data, mapping);
+ * // result = { userId: '123', name: 'john' }
+ *
+ * // Array transformation
+ * const dataArray = [
+ *   { id: '123', userName: 'john' },
+ *   { id: '456', userName: 'jane' }
+ * ];
+ * const result = transformData(dataArray, mapping);
+ * // result = [
+ * //   { userId: '123', name: 'john' },
+ * //   { userId: '456', name: 'jane' }
+ * // ]
+ * ```
+ */
+export function transformData(data, fieldMapping) {
+    // 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;
+        }
+    }
+    return result;
+}
+/**
+ * Converts a string from PascalCase to camelCase
+ * @param str The PascalCase string to convert
+ * @returns The camelCase version of the string
+ *
+ * @example
+ * ```typescript
+ * pascalToCamelCase('HelloWorld'); // 'helloWorld'
+ * pascalToCamelCase('TaskAssignmentCriteria'); // 'taskAssignmentCriteria'
+ * ```
+ */
+export function pascalToCamelCase(str) {
+    if (!str)
+        return str;
+    return str.charAt(0).toLowerCase() + str.slice(1);
+}
+/**
+ * Converts a string from camelCase to PascalCase
+ * @param str The camelCase string to convert
+ * @returns The PascalCase version of the string
+ *
+ * @example
+ * ```typescript
+ * camelToPascalCase('helloWorld'); // 'HelloWorld'
+ * camelToPascalCase('taskAssignmentCriteria'); // 'TaskAssignmentCriteria'
+ * ```
+ */
+export function camelToPascalCase(str) {
+    if (!str)
+        return str;
+    return str.charAt(0).toUpperCase() + str.slice(1);
+}
+/**
+ * Generic function to transform object keys using a provided case conversion function
+ * @param data The object to transform
+ * @param convertCase The function to convert each key
+ * @returns A new object with transformed keys
+ */
+function transformCaseKeys(data, convertCase) {
+    // Handle array of objects
+    if (Array.isArray(data)) {
+        return data.map(item => {
+            // If the array element is a primitive (string, number, etc.), return it as is
+            if (item === null || typeof item !== 'object' || item instanceof String) {
+                return item;
+            }
+            // Only recursively transform if it's actually an object
+            return transformCaseKeys(item, convertCase);
+        });
+    }
+    const result = {};
+    for (const [key, value] of Object.entries(data)) {
+        const transformedKey = convertCase(key);
+        // Recursively transform nested objects and arrays
+        if (value !== null && typeof value === 'object') {
+            result[transformedKey] = transformCaseKeys(value, convertCase);
+        }
+        else {
+            result[transformedKey] = value;
+        }
+    }
+    return result;
+}
+/**
+ * Transforms an object's keys from PascalCase to camelCase
+ * @param data The object with PascalCase keys
+ * @returns A new object with all keys converted to camelCase
+ *
+ * @example
+ * ```typescript
+ * // Simple object
+ * pascalToCamelCaseKeys({ Id: "123", TaskName: "Invoice" });
+ * // Result: { id: "123", taskName: "Invoice" }
+ *
+ * // Nested object
+ * pascalToCamelCaseKeys({
+ *   TaskId: "456",
+ *   TaskDetails: { AssignedUser: "John", Priority: "High" }
+ * });
+ * // Result: {
+ * //   taskId: "456",
+ * //   taskDetails: { assignedUser: "John", priority: "High" }
+ * // }
+ *
+ * // Array of objects
+ * pascalToCamelCaseKeys([
+ *   { Id: "1", IsComplete: false },
+ *   { Id: "2", IsComplete: true }
+ * ]);
+ * // Result: [
+ * //   { id: "1", isComplete: false },
+ * //   { id: "2", isComplete: true }
+ * // ]
+ * ```
+ */
+export function pascalToCamelCaseKeys(data) {
+    return transformCaseKeys(data, pascalToCamelCase);
+}
+/**
+ * Transforms an object's keys from camelCase to PascalCase
+ * @param data The object with camelCase keys
+ * @returns A new object with all keys converted to PascalCase
+ *
+ * @example
+ * ```typescript
+ * // Simple object
+ * camelToPascalCaseKeys({ userId: "789", isActive: true });
+ * // Result: { UserId: "789", IsActive: true }
+ *
+ * // Nested object
+ * camelToPascalCaseKeys({
+ *   taskId: "ABC123",
+ *   submissionData: { customerName: "XYZ Corp" }
+ * });
+ * // Result: {
+ * //   TaskId: "ABC123",
+ * //   SubmissionData: { CustomerName: "XYZ Corp" }
+ * // }
+ *
+ * // Array of objects
+ * camelToPascalCaseKeys([
+ *   { userId: "u1", roleType: "admin" },
+ *   { userId: "u2", roleType: "user" }
+ * ]);
+ * // Result: [
+ * //   { UserId: "u1", RoleType: "admin" },
+ * //   { UserId: "u2", RoleType: "user" }
+ * // ]
+ * ```
+ */
+export function camelToPascalCaseKeys(data) {
+    return transformCaseKeys(data, camelToPascalCase);
+}
+/**
+ * Maps a field value in an object using a provided mapping object.
+ * Returns a new object with the mapped field value.
+ *
+ * @param obj The object to map
+ * @param field The field name to map
+ * @param valueMap The mapping object (from input value to output value)
+ * @returns A new object with the mapped field value
+ *
+ * @example
+ * const statusMap = { 0: 'Unassigned', 1: 'Pending', 2: 'Completed' };
+ * const task = { status: 1, id: 123 };
+ * const mapped = mapFieldValue(task, 'status', statusMap);
+ * // mapped = { status: 'Pending', id: 123 }
+ */
+export function _mapFieldValue(obj, field, valueMap) {
+    const lookupKey = String(obj[field]);
+    return {
+        ...obj,
+        [field]: lookupKey in valueMap
+            ? valueMap[lookupKey]
+            : obj[field],
+    };
+}
+/**
+ * General API response transformer with optional field value mapping.
+ *
+ * @param data - The API response data to transform
+ * @param options - Optional mapping options:
+ *   - field: The field name to map (optional)
+ *   - valueMap: The mapping object for the field (optional)
+ *   - transform: A function to further transform the data (optional)
+ * @returns The transformed data, with field value mapped if specified
+ *
+ * @example
+ * // Just transform
+ * const result = applyDataTransforms(data);
+ *
+ * // Map a field value, then transform
+ * const result = applyDataTransforms(data, { field: 'status', valueMap: StatusMap });
+ *
+ * // Map a field value, then apply a custom transform
+ * const result = applyDataTransforms(data, { field: 'status', valueMap: StatusMap, transform: customTransform });
+ */
+export function applyDataTransforms(data, options) {
+    let result = data;
+    if (options?.field && options?.valueMap) {
+        result = _mapFieldValue(result, options.field, options.valueMap);
+    }
+    if (options?.transform) {
+        result = options.transform(result);
+    }
+    return result;
+}
+/**
+ * Adds a prefix to specified keys in an object, returning a new object.
+ * Only the provided keys are prefixed; all others are left unchanged.
+ *
+ * @param obj The source object
+ * @param prefix The prefix to add (e.g., '$')
+ * @param keys The keys to prefix (e.g., ['expand', 'filter'])
+ * @returns A new object with specified keys prefixed
+ *
+ * @example
+ * addPrefixToKeys({ expand: 'a', foo: 1 }, '$', ['expand']) // { $expand: 'a', foo: 1 }
+ */
+export function addPrefixToKeys(obj, prefix, keys) {
+    const result = {};
+    for (const [key, value] of Object.entries(obj)) {
+        if (keys.includes(key)) {
+            result[`${prefix}${key}`] = value;
+        }
+        else {
+            result[key] = value;
+        }
+    }
+    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' }
+ * ```
+ */
+export function reverseMap(map) {
+    return Object.entries(map).reduce((acc, [key, value]) => {
+        acc[value] = key;
+        return acc;
+    }, {});
+}
+/**
+ * Renames fields in an object in-place
+ * @param obj The object to modify
+ * @param fieldMappings Object mapping source field names to target field names
+ * @returns The modified object (same reference as input)
+ *
+ * @example
+ * ```typescript
+ * // Rename fields in query parameters
+ * const queryParams = { limit: 10, offset: 0, filter: 'active' };
+ * renameObjectFields(queryParams, { limit: 'takeHint' });
+ * // queryParams = { takeHint: 10, offset: 0, filter: 'active' }
+ *
+ * // Multiple field renames
+ * const params = { username: 'john', password: '12345' };
+ * renameObjectFields(params, { username: 'userName', password: 'pwd' });
+ * // params = { userName: 'john', pwd: '12345' }
+ * ```
+ */
+export function renameObjectFields(obj, fieldMappings) {
+    for (const [sourceField, targetField] of Object.entries(fieldMappings)) {
+        if (sourceField in obj) {
+            obj[targetField] = obj[sourceField];
+            delete obj[sourceField];
+        }
+    }
+    return obj;
+}
+/**
+ * Transforms an array-based dictionary with separate keys and values arrays
+ * into a standard JavaScript object/record
+ *
+ * @param dictionary Object containing keys and values arrays
+ * @returns A standard record object with direct key-value mapping
+ *
+ * @example
+ * ```typescript
+ * const arrayDict = {
+ *   keys: ['Content-Type', 'x-ms-blob-type'],
+ *   values: ['application/json', 'BlockBlob']
+ * };
+ * const record = arrayDictionaryToRecord(arrayDict);
+ * // result = {
+ * //   'Content-Type': 'application/json',
+ * //   'x-ms-blob-type': 'BlockBlob'
+ * // }
+ * ```
+ */
+export function arrayDictionaryToRecord(dictionary) {
+    if (!dictionary || !dictionary.keys || !dictionary.values) {
+        return {};
+    }
+    if (dictionary.keys.length !== dictionary.values.length) {
+        console.warn('Keys and values arrays have different lengths');
+    }
+    const record = {};
+    const length = Math.min(dictionary.keys.length, dictionary.values.length);
+    for (let i = 0; i < length; i++) {
+        record[dictionary.keys[i]] = dictionary.values[i];
+    }
+    return record;
+}
+//# sourceMappingURL=transform.js.map

package/dist/utils/transform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform.js","sourceRoot":"","sources":["../../src/utils/transform.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAa,EACb,YAA0B;IAE1B,0BAA0B;IAC1B,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAiB,CAAC;IAC7E,CAAC;IAED,uBAAuB;IACvB,MAAM,MAAM,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;IAE3B,KAAK,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;QACtE,IAAI,WAAW,IAAI,MAAM,EAAE,CAAC;YAC1B,MAAM,KAAK,GAAG,MAAM,CAAC,WAAsB,CAAC,CAAC;YAC7C,OAAO,MAAM,CAAC,WAAsB,CAAC,CAAC;YACrC,MAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;QACvC,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAW;IAC3C,IAAI,CAAC,GAAG;QAAE,OAAO,GAAG,CAAC;IACrB,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAW;IAC3C,IAAI,CAAC,GAAG;QAAE,OAAO,GAAG,CAAC;IACrB,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACpD,CAAC;AAED;;;;;GAKG;AACH,SAAS,iBAAiB,CACxB,IAAa,EACb,WAAoC;IAEpC,0BAA0B;IAC1B,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YACrB,8EAA8E;YAC9E,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,YAAY,MAAM,EAAE,CAAC;gBACxE,OAAO,IAAI,CAAC;YACd,CAAC;YACD,wDAAwD;YACxD,OAAO,iBAAiB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,MAAM,GAAwB,EAAE,CAAC;IAEvC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAChD,MAAM,cAAc,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;QAExC,kDAAkD;QAClD,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAChD,MAAM,CAAC,cAAc,CAAC,GAAG,iBAAiB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QACjE,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC;QACjC,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,UAAU,qBAAqB,CAAmB,IAAa;IACnE,OAAO,iBAAiB,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,UAAU,qBAAqB,CAAmB,IAAa;IACnE,OAAO,iBAAiB,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,cAAc,CAK5B,GAAM,EACN,KAAQ,EACR,QAAW;IAEX,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IACrC,OAAO;QACL,GAAG,GAAG;QACN,CAAC,KAAK,CAAC,EACL,SAAS,IAAI,QAAQ;YACnB,CAAC,CAAC,QAAQ,CAAC,SAAoB,CAAC;YAChC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC;KACjB,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,mBAAmB,CACjC,IAAO,EACP,OAIC;IAED,IAAI,MAAM,GAAG,IAAI,CAAC;IAClB,IAAI,OAAO,EAAE,KAAK,IAAI,OAAO,EAAE,QAAQ,EAAE,CAAC;QACxC,MAAM,GAAG,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IACnE,CAAC;IACD,IAAI,OAAO,EAAE,SAAS,EAAE,CAAC;QACvB,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAC7B,GAAM,EACN,MAAc,EACd,IAAc;IAEd,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,CAAC,GAAG,MAAM,GAAG,GAAG,EAAE,CAAC,GAAG,KAAK,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACtB,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,UAAU,CAAmC,GAAM;IACjE,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACtD,GAAG,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC;QACjB,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAA4B,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,kBAAkB,CAChC,GAAM,EACN,aAAqC;IAErC,KAAK,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;QACvE,IAAI,WAAW,IAAI,GAAG,EAAE,CAAC;YACtB,GAA2B,CAAC,WAAW,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC;YAC7D,OAAO,GAAG,CAAC,WAAW,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,uBAAuB,CACrC,UAAgD;IAEhD,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC1D,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACxD,OAAO,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;IAChE,CAAC;IAED,MAAM,MAAM,GAA2B,EAAE,CAAC;IAE1C,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC1E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAChC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/package.json

@@ -0,0 +1,56 @@
+{
+    "name": "@uipath/uipath-typescript",
+    "version": "1.0.0-beta.10",
+    "description": "UiPath TypeScript SDK",
+    "type": "module",
+    "main": "./dist/index.js",
+    "module": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "import": "./dist/index.js",
+            "require": "./dist/index.js",
+            "types": "./dist/index.d.ts"
+        }
+    },
+    "files": [
+        "dist",
+        "README.md"
+    ],
+    "scripts": {
+        "build": "tsc",
+        "clean": "rimraf dist && rimraf node_modules && rimraf package-lock.json",
+        "docs:api": "typedoc"
+    },
+    "dependencies": {
+        "@opentelemetry/sdk-logs": "^0.204.0",
+        "axios": "^1.12.0",
+        "eventemitter3": "^5.0.1",
+        "file-type": "^21.0.0",
+        "mime-types": "^3.0.1",
+        "uuid": "^9.0.1",
+        "ws": "^8.16.0",
+        "zod": "^3.22.4",
+        "typedoc": "^0.28.13",
+        "typedoc-plugin-markdown": "^4.8.1",
+        "rimraf": "^6.0.1"
+    },
+    "devDependencies": {
+        "@types/jest": "^29.5.14",
+        "@types/mime-types": "^3.0.1",
+        "@types/node": "^20.11.19",
+        "@types/uuid": "^9.0.8",
+        "@types/ws": "^8.5.10",
+        "dotenv": "^17.2.0",
+        "jest": "^29.7.0",
+        "ts-jest": "^29.4.0",
+        "typescript": "^5.3.3"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/UiPath/uipath-typescript.git"
+    },
+    "workspaces": [
+        "packages/*"
+    ]
+}