@uipath/uipath-typescript 1.3.7 → 1.3.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/assets/index.cjs +64 -274
- package/dist/assets/index.d.ts +1 -0
- package/dist/assets/index.mjs +64 -274
- package/dist/attachments/index.cjs +62 -271
- package/dist/attachments/index.d.ts +1 -0
- package/dist/attachments/index.mjs +62 -271
- package/dist/buckets/index.cjs +93 -274
- package/dist/buckets/index.d.ts +51 -1
- package/dist/buckets/index.mjs +93 -274
- package/dist/cases/index.cjs +580 -336
- package/dist/cases/index.d.ts +690 -3
- package/dist/cases/index.mjs +581 -337
- package/dist/conversational-agent/index.cjs +110 -285
- package/dist/conversational-agent/index.d.ts +63 -12
- package/dist/conversational-agent/index.mjs +110 -286
- package/dist/core/index.cjs +39 -289
- package/dist/core/index.d.ts +9 -98
- package/dist/core/index.mjs +40 -275
- package/dist/document-understanding/index.cjs +18 -1
- package/dist/document-understanding/index.d.ts +636 -610
- package/dist/document-understanding/index.mjs +18 -1
- package/dist/entities/index.cjs +64 -274
- package/dist/entities/index.d.ts +1 -0
- package/dist/entities/index.mjs +64 -274
- package/dist/feedback/index.cjs +313 -276
- package/dist/feedback/index.d.ts +418 -12
- package/dist/feedback/index.mjs +313 -276
- package/dist/index.cjs +777 -297
- package/dist/index.d.ts +2005 -721
- package/dist/index.mjs +777 -283
- package/dist/index.umd.js +966 -162
- package/dist/jobs/index.cjs +64 -274
- package/dist/jobs/index.d.ts +1 -0
- package/dist/jobs/index.mjs +64 -274
- package/dist/maestro-processes/index.cjs +1789 -1686
- package/dist/maestro-processes/index.d.ts +431 -2
- package/dist/maestro-processes/index.mjs +1790 -1687
- package/dist/processes/index.cjs +64 -274
- package/dist/processes/index.d.ts +1 -0
- package/dist/processes/index.mjs +64 -274
- package/dist/queues/index.cjs +64 -274
- package/dist/queues/index.d.ts +1 -0
- package/dist/queues/index.mjs +64 -274
- package/dist/tasks/index.cjs +64 -274
- package/dist/tasks/index.d.ts +1 -0
- package/dist/tasks/index.mjs +64 -274
- package/package.json +8 -10
package/dist/buckets/index.cjs
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var coreTelemetry = require('@uipath/core-telemetry');
|
|
4
4
|
|
|
5
5
|
/******************************************************************************
|
|
6
6
|
Copyright (c) Microsoft Corporation.
|
|
@@ -653,6 +653,27 @@ var PaginationType;
|
|
|
653
653
|
/**
|
|
654
654
|
* Collection of utility functions for working with objects
|
|
655
655
|
*/
|
|
656
|
+
/**
|
|
657
|
+
* Resolves a field value from an object, supporting both direct keys (e.g., '@odata.count')
|
|
658
|
+
* and dot-separated nested paths (e.g., 'pagination.totalCount').
|
|
659
|
+
* Direct key match takes priority over nested traversal.
|
|
660
|
+
*/
|
|
661
|
+
function resolveNestedField(data, fieldPath) {
|
|
662
|
+
if (!data) {
|
|
663
|
+
return undefined;
|
|
664
|
+
}
|
|
665
|
+
if (fieldPath in data) {
|
|
666
|
+
return data[fieldPath];
|
|
667
|
+
}
|
|
668
|
+
if (!fieldPath.includes('.')) {
|
|
669
|
+
return undefined;
|
|
670
|
+
}
|
|
671
|
+
let value = data;
|
|
672
|
+
for (const part of fieldPath.split('.')) {
|
|
673
|
+
value = value?.[part];
|
|
674
|
+
}
|
|
675
|
+
return value;
|
|
676
|
+
}
|
|
656
677
|
/**
|
|
657
678
|
* Filters out undefined values from an object
|
|
658
679
|
* @param obj The source object
|
|
@@ -902,6 +923,10 @@ const BUCKET_TOKEN_PARAMS = {
|
|
|
902
923
|
TOKEN_PARAM: 'continuationToken'
|
|
903
924
|
};
|
|
904
925
|
|
|
926
|
+
/**
|
|
927
|
+
* Converts a UTC timestamp string (e.g., "5/8/2026 11:20:17 AM") to ISO 8601 UTC format.
|
|
928
|
+
* Returns the original value if parsing fails.
|
|
929
|
+
*/
|
|
905
930
|
/**
|
|
906
931
|
* Transforms data by mapping fields according to the provided field mapping
|
|
907
932
|
* @param data The source data to transform
|
|
@@ -1290,7 +1315,8 @@ class PaginationHelpers {
|
|
|
1290
1315
|
// Extract and transform items from response
|
|
1291
1316
|
// Handle both plain array responses and envelope responses ({ value: [...], totalRecordCount: N })
|
|
1292
1317
|
const rawItems = Array.isArray(response.data) ? response.data : response.data?.[itemsField];
|
|
1293
|
-
const
|
|
1318
|
+
const rawTotalCount = Array.isArray(response.data) ? undefined : resolveNestedField(response.data, totalCountField);
|
|
1319
|
+
const totalCount = typeof rawTotalCount === 'number' ? rawTotalCount : undefined;
|
|
1294
1320
|
// Parse items - automatically handle JSON string responses
|
|
1295
1321
|
const parsedItems = typeof rawItems === 'string' ? JSON.parse(rawItems) : (rawItems || []);
|
|
1296
1322
|
const items = transformFn ? parsedItems.map(transformFn) : parsedItems;
|
|
@@ -1587,9 +1613,17 @@ class BaseService {
|
|
|
1587
1613
|
const pageSizeParam = paginationParams?.pageSizeParam || ODATA_OFFSET_PARAMS.PAGE_SIZE_PARAM;
|
|
1588
1614
|
const offsetParam = paginationParams?.offsetParam || ODATA_OFFSET_PARAMS.OFFSET_PARAM;
|
|
1589
1615
|
const countParam = paginationParams?.countParam || ODATA_OFFSET_PARAMS.COUNT_PARAM;
|
|
1616
|
+
// When true (default), converts pageNumber to a skip/offset value (e.g., page 3 with pageSize 10 → skip 20).
|
|
1617
|
+
// When false, passes pageNumber directly as the offset param — used by APIs that accept a page number instead of a record offset.
|
|
1618
|
+
const convertToSkip = paginationParams?.convertToSkip ?? true;
|
|
1590
1619
|
requestParams[pageSizeParam] = limitedPageSize;
|
|
1591
|
-
if (
|
|
1592
|
-
|
|
1620
|
+
if (convertToSkip) {
|
|
1621
|
+
if (params.pageNumber && params.pageNumber > 1) {
|
|
1622
|
+
requestParams[offsetParam] = (params.pageNumber - 1) * limitedPageSize;
|
|
1623
|
+
}
|
|
1624
|
+
}
|
|
1625
|
+
else {
|
|
1626
|
+
requestParams[offsetParam] = params.pageNumber || 1;
|
|
1593
1627
|
}
|
|
1594
1628
|
{
|
|
1595
1629
|
requestParams[countParam] = true;
|
|
@@ -1620,7 +1654,8 @@ class BaseService {
|
|
|
1620
1654
|
// Extract items and metadata
|
|
1621
1655
|
// Handle both plain array responses and envelope responses ({ value: [...], totalRecordCount: N })
|
|
1622
1656
|
const items = Array.isArray(response.data) ? response.data : (response.data[itemsField] || []);
|
|
1623
|
-
const
|
|
1657
|
+
const rawTotalCount = Array.isArray(response.data) ? undefined : resolveNestedField(response.data, totalCountField);
|
|
1658
|
+
const totalCount = typeof rawTotalCount === 'number' ? rawTotalCount : undefined;
|
|
1624
1659
|
const continuationToken = response.data[continuationTokenField];
|
|
1625
1660
|
// Determine if there are more pages
|
|
1626
1661
|
const hasMore = this.determineHasMorePages(paginationType, {
|
|
@@ -1897,278 +1932,33 @@ const BucketMap = {
|
|
|
1897
1932
|
};
|
|
1898
1933
|
|
|
1899
1934
|
/**
|
|
1900
|
-
* SDK Telemetry constants
|
|
1901
|
-
|
|
1902
|
-
|
|
1903
|
-
|
|
1904
|
-
|
|
1905
|
-
|
|
1906
|
-
|
|
1907
|
-
|
|
1908
|
-
|
|
1909
|
-
|
|
1910
|
-
const
|
|
1911
|
-
const CLOUD_CLIENT_ID = "CloudClientId";
|
|
1912
|
-
const CLOUD_REDIRECT_URI = "CloudRedirectUri";
|
|
1913
|
-
const APP_NAME = "ApplicationName";
|
|
1914
|
-
const CLOUD_ROLE_NAME = "uipath-ts-sdk";
|
|
1915
|
-
// Service and logger names
|
|
1916
|
-
const SDK_SERVICE_NAME = "UiPath.TypeScript.Sdk";
|
|
1917
|
-
const SDK_LOGGER_NAME = "uipath-ts-sdk-telemetry";
|
|
1918
|
-
// Event names
|
|
1919
|
-
const SDK_RUN_EVENT = "Sdk.Run";
|
|
1920
|
-
// Default value for unknown/empty attributes
|
|
1921
|
-
const UNKNOWN = "";
|
|
1922
|
-
|
|
1923
|
-
/**
|
|
1924
|
-
* Log exporter that sends ALL logs as Application Insights custom events
|
|
1925
|
-
*/
|
|
1926
|
-
class ApplicationInsightsEventExporter {
|
|
1927
|
-
constructor(connectionString) {
|
|
1928
|
-
this.connectionString = connectionString;
|
|
1929
|
-
}
|
|
1930
|
-
export(logs, resultCallback) {
|
|
1931
|
-
try {
|
|
1932
|
-
logs.forEach(logRecord => {
|
|
1933
|
-
this.sendAsCustomEvent(logRecord);
|
|
1934
|
-
});
|
|
1935
|
-
resultCallback({ code: 0 });
|
|
1936
|
-
}
|
|
1937
|
-
catch (error) {
|
|
1938
|
-
console.debug('Failed to export logs to Application Insights:', error);
|
|
1939
|
-
resultCallback({ code: 2, error });
|
|
1940
|
-
}
|
|
1941
|
-
}
|
|
1942
|
-
shutdown() {
|
|
1943
|
-
return Promise.resolve();
|
|
1944
|
-
}
|
|
1945
|
-
sendAsCustomEvent(logRecord) {
|
|
1946
|
-
// Get event name from body or attributes
|
|
1947
|
-
const eventName = logRecord.body || SDK_RUN_EVENT;
|
|
1948
|
-
const payload = {
|
|
1949
|
-
name: 'Microsoft.ApplicationInsights.Event',
|
|
1950
|
-
time: new Date().toISOString(),
|
|
1951
|
-
iKey: this.extractInstrumentationKey(),
|
|
1952
|
-
data: {
|
|
1953
|
-
baseType: 'EventData',
|
|
1954
|
-
baseData: {
|
|
1955
|
-
ver: 2,
|
|
1956
|
-
name: eventName,
|
|
1957
|
-
properties: this.convertAttributesToProperties(logRecord.attributes || {})
|
|
1958
|
-
}
|
|
1959
|
-
},
|
|
1960
|
-
tags: {
|
|
1961
|
-
'ai.cloud.role': CLOUD_ROLE_NAME,
|
|
1962
|
-
'ai.cloud.roleInstance': SDK_VERSION
|
|
1963
|
-
}
|
|
1964
|
-
};
|
|
1965
|
-
this.sendToApplicationInsights(payload);
|
|
1966
|
-
}
|
|
1967
|
-
extractInstrumentationKey() {
|
|
1968
|
-
const match = this.connectionString.match(/InstrumentationKey=([^;]+)/);
|
|
1969
|
-
return match ? match[1] : '';
|
|
1970
|
-
}
|
|
1971
|
-
convertAttributesToProperties(attributes) {
|
|
1972
|
-
const properties = {};
|
|
1973
|
-
Object.entries(attributes || {}).forEach(([key, value]) => {
|
|
1974
|
-
properties[key] = String(value);
|
|
1975
|
-
});
|
|
1976
|
-
return properties;
|
|
1977
|
-
}
|
|
1978
|
-
async sendToApplicationInsights(payload) {
|
|
1979
|
-
try {
|
|
1980
|
-
const ingestionEndpoint = this.extractIngestionEndpoint();
|
|
1981
|
-
if (!ingestionEndpoint) {
|
|
1982
|
-
console.debug('No ingestion endpoint found in connection string');
|
|
1983
|
-
return;
|
|
1984
|
-
}
|
|
1985
|
-
const url = `${ingestionEndpoint}/v2/track`;
|
|
1986
|
-
const response = await fetch(url, {
|
|
1987
|
-
method: 'POST',
|
|
1988
|
-
headers: {
|
|
1989
|
-
'Content-Type': 'application/json',
|
|
1990
|
-
},
|
|
1991
|
-
body: JSON.stringify(payload)
|
|
1992
|
-
});
|
|
1993
|
-
if (!response.ok) {
|
|
1994
|
-
console.debug(`Failed to send event telemetry: ${response.status} ${response.statusText}`);
|
|
1995
|
-
}
|
|
1996
|
-
}
|
|
1997
|
-
catch (error) {
|
|
1998
|
-
console.debug('Error sending event telemetry to Application Insights:', error);
|
|
1999
|
-
}
|
|
2000
|
-
}
|
|
2001
|
-
extractIngestionEndpoint() {
|
|
2002
|
-
const match = this.connectionString.match(/IngestionEndpoint=([^;]+)/);
|
|
2003
|
-
return match ? match[1] : '';
|
|
2004
|
-
}
|
|
2005
|
-
}
|
|
2006
|
-
/**
|
|
2007
|
-
* Singleton telemetry client
|
|
2008
|
-
*/
|
|
2009
|
-
class TelemetryClient {
|
|
2010
|
-
constructor() {
|
|
2011
|
-
this.isInitialized = false;
|
|
2012
|
-
}
|
|
2013
|
-
static getInstance() {
|
|
2014
|
-
if (!TelemetryClient.instance) {
|
|
2015
|
-
TelemetryClient.instance = new TelemetryClient();
|
|
2016
|
-
}
|
|
2017
|
-
return TelemetryClient.instance;
|
|
2018
|
-
}
|
|
2019
|
-
/**
|
|
2020
|
-
* Initialize telemetry
|
|
2021
|
-
*/
|
|
2022
|
-
initialize(config) {
|
|
2023
|
-
if (this.isInitialized) {
|
|
2024
|
-
return;
|
|
2025
|
-
}
|
|
2026
|
-
this.isInitialized = true;
|
|
2027
|
-
if (config) {
|
|
2028
|
-
this.telemetryContext = config;
|
|
2029
|
-
}
|
|
2030
|
-
try {
|
|
2031
|
-
const connectionString = this.getConnectionString();
|
|
2032
|
-
if (!connectionString) {
|
|
2033
|
-
return;
|
|
2034
|
-
}
|
|
2035
|
-
this.setupTelemetryProvider(connectionString);
|
|
2036
|
-
}
|
|
2037
|
-
catch (error) {
|
|
2038
|
-
// Silent failure - telemetry errors shouldn't break functionality
|
|
2039
|
-
console.debug('Failed to initialize OpenTelemetry:', error);
|
|
2040
|
-
}
|
|
2041
|
-
}
|
|
2042
|
-
getConnectionString() {
|
|
2043
|
-
const connectionString = CONNECTION_STRING;
|
|
2044
|
-
return connectionString;
|
|
2045
|
-
}
|
|
2046
|
-
setupTelemetryProvider(connectionString) {
|
|
2047
|
-
const exporter = new ApplicationInsightsEventExporter(connectionString);
|
|
2048
|
-
const processor = new sdkLogs.BatchLogRecordProcessor(exporter);
|
|
2049
|
-
this.logProvider = new sdkLogs.LoggerProvider({
|
|
2050
|
-
processors: [processor]
|
|
2051
|
-
});
|
|
2052
|
-
this.logger = this.logProvider.getLogger(SDK_LOGGER_NAME);
|
|
2053
|
-
}
|
|
2054
|
-
/**
|
|
2055
|
-
* Track a telemetry event
|
|
2056
|
-
*/
|
|
2057
|
-
track(eventName, name, extraAttributes = {}) {
|
|
2058
|
-
try {
|
|
2059
|
-
// Skip if logger not initialized
|
|
2060
|
-
if (!this.logger) {
|
|
2061
|
-
return;
|
|
2062
|
-
}
|
|
2063
|
-
const finalDisplayName = name || eventName;
|
|
2064
|
-
const attributes = this.getEnrichedAttributes(extraAttributes, eventName);
|
|
2065
|
-
// Emit as log
|
|
2066
|
-
this.logger.emit({
|
|
2067
|
-
body: finalDisplayName,
|
|
2068
|
-
attributes: attributes,
|
|
2069
|
-
timestamp: Date.now(),
|
|
2070
|
-
});
|
|
2071
|
-
}
|
|
2072
|
-
catch (error) {
|
|
2073
|
-
// Silent failure
|
|
2074
|
-
console.debug('Failed to track telemetry event:', error);
|
|
2075
|
-
}
|
|
2076
|
-
}
|
|
2077
|
-
/**
|
|
2078
|
-
* Get enriched attributes for telemetry events
|
|
2079
|
-
*/
|
|
2080
|
-
getEnrichedAttributes(extraAttributes, eventName) {
|
|
2081
|
-
const attributes = {
|
|
2082
|
-
[APP_NAME]: SDK_SERVICE_NAME,
|
|
2083
|
-
[VERSION]: SDK_VERSION,
|
|
2084
|
-
[SERVICE]: eventName,
|
|
2085
|
-
[CLOUD_URL]: this.createCloudUrl(),
|
|
2086
|
-
[CLOUD_ORGANIZATION_NAME]: this.telemetryContext?.orgName || UNKNOWN,
|
|
2087
|
-
[CLOUD_TENANT_NAME]: this.telemetryContext?.tenantName || UNKNOWN,
|
|
2088
|
-
[CLOUD_REDIRECT_URI]: this.telemetryContext?.redirectUri || UNKNOWN,
|
|
2089
|
-
[CLOUD_CLIENT_ID]: this.telemetryContext?.clientId || UNKNOWN,
|
|
2090
|
-
...extraAttributes,
|
|
2091
|
-
};
|
|
2092
|
-
return attributes;
|
|
2093
|
-
}
|
|
2094
|
-
/**
|
|
2095
|
-
* Create cloud URL from base URL, organization ID, and tenant ID
|
|
2096
|
-
*/
|
|
2097
|
-
createCloudUrl() {
|
|
2098
|
-
const baseUrl = this.telemetryContext?.baseUrl;
|
|
2099
|
-
const orgId = this.telemetryContext?.orgName;
|
|
2100
|
-
const tenantId = this.telemetryContext?.tenantName;
|
|
2101
|
-
if (!baseUrl || !orgId || !tenantId) {
|
|
2102
|
-
return UNKNOWN;
|
|
2103
|
-
}
|
|
2104
|
-
return `${baseUrl}/${orgId}/${tenantId}`;
|
|
2105
|
-
}
|
|
2106
|
-
}
|
|
2107
|
-
// Export singleton instance
|
|
2108
|
-
const telemetryClient = TelemetryClient.getInstance();
|
|
1935
|
+
* SDK Telemetry constants.
|
|
1936
|
+
*
|
|
1937
|
+
* Only the SDK's identity (version, service name, role name, …) lives
|
|
1938
|
+
* here. The Application Insights connection string is injected into
|
|
1939
|
+
* `@uipath/core-telemetry` itself at publish time, and the generic attribute
|
|
1940
|
+
* keys (`Version`, `Service`, `CloudOrganizationName`, …) are owned by
|
|
1941
|
+
* `@uipath/core-telemetry` and consumed there — they are not part of the
|
|
1942
|
+
* SDK's public API.
|
|
1943
|
+
*/
|
|
1944
|
+
/** SDK version placeholder — patched by the SDK publish workflow. */
|
|
1945
|
+
const CLOUD_ROLE_NAME = 'uipath-ts-sdk';
|
|
2109
1946
|
|
|
2110
1947
|
/**
|
|
2111
|
-
*
|
|
2112
|
-
*/
|
|
2113
|
-
/**
|
|
2114
|
-
* Common tracking logic shared between method and function decorators
|
|
2115
|
-
*/
|
|
2116
|
-
function createTrackedFunction(originalFunction, nameOrOptions, fallbackName, opts) {
|
|
2117
|
-
return function (...args) {
|
|
2118
|
-
// Determine if we should track this call
|
|
2119
|
-
let shouldTrack = true;
|
|
2120
|
-
if (opts.condition !== undefined) {
|
|
2121
|
-
if (typeof opts.condition === 'function') {
|
|
2122
|
-
shouldTrack = opts.condition.apply(this, args);
|
|
2123
|
-
}
|
|
2124
|
-
else {
|
|
2125
|
-
shouldTrack = opts.condition;
|
|
2126
|
-
}
|
|
2127
|
-
}
|
|
2128
|
-
// Track the event if enabled
|
|
2129
|
-
if (shouldTrack) {
|
|
2130
|
-
// Use the full name provided in the decorator (e.g., "Queue.GetAll")
|
|
2131
|
-
const serviceMethod = typeof nameOrOptions === 'string'
|
|
2132
|
-
? nameOrOptions
|
|
2133
|
-
: fallbackName;
|
|
2134
|
-
// Use 'Sdk.Run' as the name and serviceMethod as the service
|
|
2135
|
-
telemetryClient.track(serviceMethod, SDK_RUN_EVENT, opts.attributes);
|
|
2136
|
-
}
|
|
2137
|
-
// Execute the original function
|
|
2138
|
-
return originalFunction.apply(this, args);
|
|
2139
|
-
};
|
|
2140
|
-
}
|
|
2141
|
-
/**
|
|
2142
|
-
* Track decorator that can be used to automatically track function calls
|
|
1948
|
+
* UiPath TypeScript SDK Telemetry
|
|
2143
1949
|
*
|
|
2144
|
-
*
|
|
2145
|
-
*
|
|
2146
|
-
*
|
|
2147
|
-
*
|
|
2148
|
-
|
|
2149
|
-
|
|
2150
|
-
|
|
2151
|
-
|
|
2152
|
-
|
|
2153
|
-
|
|
2154
|
-
|
|
2155
|
-
|
|
2156
|
-
*
|
|
2157
|
-
* @track("Processes.Start", { attributes: { customProp: "value" } })
|
|
2158
|
-
* function myFunction() { ... }
|
|
2159
|
-
*/
|
|
2160
|
-
function track(nameOrOptions, options) {
|
|
2161
|
-
return function decorator(_target, propertyKey, descriptor) {
|
|
2162
|
-
const opts = typeof nameOrOptions === 'object' ? nameOrOptions : {};
|
|
2163
|
-
if (descriptor && typeof descriptor.value === 'function') {
|
|
2164
|
-
// Method decorator
|
|
2165
|
-
descriptor.value = createTrackedFunction(descriptor.value, nameOrOptions, propertyKey || 'unknown_method', opts);
|
|
2166
|
-
return descriptor;
|
|
2167
|
-
}
|
|
2168
|
-
// Function decorator
|
|
2169
|
-
return (originalFunction) => createTrackedFunction(originalFunction, nameOrOptions, originalFunction.name || 'unknown_function', opts);
|
|
2170
|
-
};
|
|
2171
|
-
}
|
|
1950
|
+
* Constructs the SDK's own `TelemetryClient` and binds the SDK-local
|
|
1951
|
+
* `track` / `trackEvent` to it. Each consumer of `@uipath/core-telemetry`
|
|
1952
|
+
* does this independently, so events carry their own consumer's identity
|
|
1953
|
+
* and tenant context.
|
|
1954
|
+
*/
|
|
1955
|
+
// Keyed by `CLOUD_ROLE_NAME` so every SDK subpath bundle resolves to the
|
|
1956
|
+
// same `TelemetryClient` instance at runtime. A single `initialize(...)`
|
|
1957
|
+
// from the `UiPath` constructor therefore wires up `@track` decorators
|
|
1958
|
+
// across every subpath bundle (`assets`, `feedback`, `tasks`, …).
|
|
1959
|
+
const sdkClient = coreTelemetry.getOrCreateClient(CLOUD_ROLE_NAME);
|
|
1960
|
+
const track = coreTelemetry.createTrack(sdkClient);
|
|
1961
|
+
coreTelemetry.createTrackEvent(sdkClient);
|
|
2172
1962
|
|
|
2173
1963
|
class BucketService extends FolderScopedService {
|
|
2174
1964
|
/**
|
|
@@ -2206,6 +1996,32 @@ class BucketService extends FolderScopedService {
|
|
|
2206
1996
|
// Transform response from PascalCase to camelCase
|
|
2207
1997
|
return pascalToCamelCaseKeys(response.data);
|
|
2208
1998
|
}
|
|
1999
|
+
/**
|
|
2000
|
+
* Retrieves a single orchestrator storage bucket by name.
|
|
2001
|
+
*
|
|
2002
|
+
* @param name - Bucket name to search for
|
|
2003
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
|
|
2004
|
+
* @returns Promise resolving to a single bucket
|
|
2005
|
+
* {@link BucketGetResponse}
|
|
2006
|
+
* @example
|
|
2007
|
+
* ```typescript
|
|
2008
|
+
* import { Buckets } from '@uipath/uipath-typescript/buckets';
|
|
2009
|
+
*
|
|
2010
|
+
* const buckets = new Buckets(sdk);
|
|
2011
|
+
*
|
|
2012
|
+
* // By folder ID
|
|
2013
|
+
* await buckets.getByName('MyBucket', { folderId: <folderId> });
|
|
2014
|
+
*
|
|
2015
|
+
* // By folder key (GUID)
|
|
2016
|
+
* await buckets.getByName('MyBucket', { folderKey: '<folderKey>' });
|
|
2017
|
+
*
|
|
2018
|
+
* // By folder path
|
|
2019
|
+
* await buckets.getByName('MyBucket', { folderPath: '<folderPath>' });
|
|
2020
|
+
* ```
|
|
2021
|
+
*/
|
|
2022
|
+
async getByName(name, options = {}) {
|
|
2023
|
+
return this.getByNameLookup('Bucket', BUCKET_ENDPOINTS.GET_BY_FOLDER, name, options, (raw) => pascalToCamelCaseKeys(raw));
|
|
2024
|
+
}
|
|
2209
2025
|
/**
|
|
2210
2026
|
* Gets all buckets across folders with optional filtering and folder scoping
|
|
2211
2027
|
*
|
|
@@ -2495,6 +2311,9 @@ class BucketService extends FolderScopedService {
|
|
|
2495
2311
|
__decorate([
|
|
2496
2312
|
track('Buckets.GetById')
|
|
2497
2313
|
], BucketService.prototype, "getById", null);
|
|
2314
|
+
__decorate([
|
|
2315
|
+
track('Buckets.GetByName')
|
|
2316
|
+
], BucketService.prototype, "getByName", null);
|
|
2498
2317
|
__decorate([
|
|
2499
2318
|
track('Buckets.GetAll')
|
|
2500
2319
|
], BucketService.prototype, "getAll", null);
|
package/dist/buckets/index.d.ts
CHANGED
|
@@ -106,6 +106,7 @@ interface RequestWithPaginationOptions extends RequestSpec {
|
|
|
106
106
|
offsetParam?: string;
|
|
107
107
|
tokenParam?: string;
|
|
108
108
|
countParam?: string;
|
|
109
|
+
convertToSkip?: boolean;
|
|
109
110
|
};
|
|
110
111
|
};
|
|
111
112
|
}
|
|
@@ -395,6 +396,11 @@ type BucketGetAllOptions = RequestOptions & PaginationOptions & {
|
|
|
395
396
|
};
|
|
396
397
|
interface BucketGetByIdOptions extends BaseOptions {
|
|
397
398
|
}
|
|
399
|
+
/**
|
|
400
|
+
* Options for getting a single bucket by name
|
|
401
|
+
*/
|
|
402
|
+
interface BucketGetByNameOptions extends FolderScopedOptions {
|
|
403
|
+
}
|
|
398
404
|
/**
|
|
399
405
|
* Maps header names to their values
|
|
400
406
|
*
|
|
@@ -605,6 +611,26 @@ interface BucketServiceModel {
|
|
|
605
611
|
* ```
|
|
606
612
|
*/
|
|
607
613
|
getById(bucketId: number, folderId: number, options?: BucketGetByIdOptions): Promise<BucketGetResponse>;
|
|
614
|
+
/**
|
|
615
|
+
* Retrieves a single orchestrator storage bucket by name.
|
|
616
|
+
*
|
|
617
|
+
* @param name - Bucket name to search for
|
|
618
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
|
|
619
|
+
* @returns Promise resolving to a single bucket
|
|
620
|
+
* {@link BucketGetResponse}
|
|
621
|
+
* @example
|
|
622
|
+
* ```typescript
|
|
623
|
+
* // By folder ID
|
|
624
|
+
* await buckets.getByName('MyBucket', { folderId: <folderId> });
|
|
625
|
+
*
|
|
626
|
+
* // By folder key (GUID)
|
|
627
|
+
* await buckets.getByName('MyBucket', { folderKey: '<folderKey>' });
|
|
628
|
+
*
|
|
629
|
+
* // By folder path
|
|
630
|
+
* await buckets.getByName('MyBucket', { folderPath: '<folderPath>' });
|
|
631
|
+
* ```
|
|
632
|
+
*/
|
|
633
|
+
getByName(name: string, options?: BucketGetByNameOptions): Promise<BucketGetResponse>;
|
|
608
634
|
/**
|
|
609
635
|
* Gets metadata for files in a bucket with optional filtering and pagination
|
|
610
636
|
*
|
|
@@ -703,6 +729,30 @@ declare class BucketService extends FolderScopedService implements BucketService
|
|
|
703
729
|
* ```
|
|
704
730
|
*/
|
|
705
731
|
getById(id: number, folderId: number, options?: BucketGetByIdOptions): Promise<BucketGetResponse>;
|
|
732
|
+
/**
|
|
733
|
+
* Retrieves a single orchestrator storage bucket by name.
|
|
734
|
+
*
|
|
735
|
+
* @param name - Bucket name to search for
|
|
736
|
+
* @param options - Folder scoping (`folderId` / `folderKey` / `folderPath`) and optional query parameters (`expand`, `select`)
|
|
737
|
+
* @returns Promise resolving to a single bucket
|
|
738
|
+
* {@link BucketGetResponse}
|
|
739
|
+
* @example
|
|
740
|
+
* ```typescript
|
|
741
|
+
* import { Buckets } from '@uipath/uipath-typescript/buckets';
|
|
742
|
+
*
|
|
743
|
+
* const buckets = new Buckets(sdk);
|
|
744
|
+
*
|
|
745
|
+
* // By folder ID
|
|
746
|
+
* await buckets.getByName('MyBucket', { folderId: <folderId> });
|
|
747
|
+
*
|
|
748
|
+
* // By folder key (GUID)
|
|
749
|
+
* await buckets.getByName('MyBucket', { folderKey: '<folderKey>' });
|
|
750
|
+
*
|
|
751
|
+
* // By folder path
|
|
752
|
+
* await buckets.getByName('MyBucket', { folderPath: '<folderPath>' });
|
|
753
|
+
* ```
|
|
754
|
+
*/
|
|
755
|
+
getByName(name: string, options?: BucketGetByNameOptions): Promise<BucketGetResponse>;
|
|
706
756
|
/**
|
|
707
757
|
* Gets all buckets across folders with optional filtering and folder scoping
|
|
708
758
|
*
|
|
@@ -864,4 +914,4 @@ declare class BucketService extends FolderScopedService implements BucketService
|
|
|
864
914
|
}
|
|
865
915
|
|
|
866
916
|
export { BucketOptions, BucketService, BucketService as Buckets };
|
|
867
|
-
export type { BlobItem, BucketGetAllOptions, BucketGetByIdOptions, BucketGetFileMetaDataOptions, BucketGetFileMetaDataResponse, BucketGetFileMetaDataWithPaginationOptions, BucketGetReadUriOptions, BucketGetResponse, BucketGetUriOptions, BucketGetUriResponse, BucketServiceModel, BucketUploadFileOptions, BucketUploadResponse, ResponseDictionary };
|
|
917
|
+
export type { BlobItem, BucketGetAllOptions, BucketGetByIdOptions, BucketGetByNameOptions, BucketGetFileMetaDataOptions, BucketGetFileMetaDataResponse, BucketGetFileMetaDataWithPaginationOptions, BucketGetReadUriOptions, BucketGetResponse, BucketGetUriOptions, BucketGetUriResponse, BucketServiceModel, BucketUploadFileOptions, BucketUploadResponse, ResponseDictionary };
|