@uipath/uipath-typescript 1.2.2 → 1.3.1
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 +5 -8
- package/dist/assets/index.d.ts +3 -1
- package/dist/assets/index.mjs +5 -8
- package/dist/attachments/index.cjs +5 -8
- package/dist/attachments/index.d.ts +3 -1
- package/dist/attachments/index.mjs +5 -8
- package/dist/buckets/index.cjs +5 -8
- package/dist/buckets/index.d.ts +3 -1
- package/dist/buckets/index.mjs +5 -8
- package/dist/cases/index.cjs +5 -8
- package/dist/cases/index.d.ts +3 -1
- package/dist/cases/index.mjs +5 -8
- package/dist/conversational-agent/index.cjs +38 -16
- package/dist/conversational-agent/index.d.ts +26 -4
- package/dist/conversational-agent/index.mjs +38 -16
- package/dist/core/index.cjs +2 -2
- package/dist/core/index.d.ts +2 -2
- package/dist/core/index.mjs +2 -2
- package/dist/entities/index.cjs +697 -317
- package/dist/entities/index.d.ts +572 -58
- package/dist/entities/index.mjs +698 -318
- package/dist/index.cjs +727 -161
- package/dist/index.d.ts +697 -69
- package/dist/index.mjs +727 -162
- package/dist/index.umd.js +727 -161
- package/dist/jobs/index.cjs +278 -20
- package/dist/jobs/index.d.ts +214 -19
- package/dist/jobs/index.mjs +278 -21
- package/dist/maestro-processes/index.cjs +5 -8
- package/dist/maestro-processes/index.d.ts +3 -1
- package/dist/maestro-processes/index.mjs +5 -8
- package/dist/processes/index.cjs +5 -8
- package/dist/processes/index.d.ts +3 -1
- package/dist/processes/index.mjs +5 -8
- package/dist/queues/index.cjs +5 -8
- package/dist/queues/index.d.ts +3 -1
- package/dist/queues/index.mjs +5 -8
- package/dist/tasks/index.cjs +5 -8
- package/dist/tasks/index.d.ts +3 -1
- package/dist/tasks/index.mjs +5 -8
- package/package.json +1 -1
|
@@ -230,6 +230,8 @@ declare class BaseService {
|
|
|
230
230
|
*
|
|
231
231
|
* @param instance - UiPath SDK instance providing authentication and configuration.
|
|
232
232
|
* Services receive this via dependency injection in the modular pattern.
|
|
233
|
+
* @param headers - Optional default headers to include in every request (e.g. `x-uipath-external-user-id` for
|
|
234
|
+
* CAS external-app auth)
|
|
233
235
|
*
|
|
234
236
|
* @example
|
|
235
237
|
* ```typescript
|
|
@@ -249,7 +251,7 @@ declare class BaseService {
|
|
|
249
251
|
* const entities = new Entities(sdk);
|
|
250
252
|
* ```
|
|
251
253
|
*/
|
|
252
|
-
constructor(instance: IUiPath);
|
|
254
|
+
constructor(instance: IUiPath, headers?: Record<string, string>);
|
|
253
255
|
/**
|
|
254
256
|
* Gets a valid authentication token, refreshing if necessary.
|
|
255
257
|
* Use this when you need to manually add Authorization headers (e.g., direct uploads).
|
|
@@ -4634,7 +4636,11 @@ interface ConversationalAgentServiceModel {
|
|
|
4634
4636
|
* Options for ConversationalAgentService constructor
|
|
4635
4637
|
*/
|
|
4636
4638
|
interface ConversationalAgentOptions {
|
|
4637
|
-
/**
|
|
4639
|
+
/**
|
|
4640
|
+
* External user ID required when authenticating via an app-scoped external app
|
|
4641
|
+
* (client credential grant). Must be set when the access token was issued for an
|
|
4642
|
+
* external app client; omit for standard UiPath user tokens.
|
|
4643
|
+
*/
|
|
4638
4644
|
externalUserId?: string;
|
|
4639
4645
|
/** Log level for debugging */
|
|
4640
4646
|
logLevel?: LogLevel;
|
|
@@ -6093,8 +6099,9 @@ declare class ConversationService extends BaseService implements ConversationSer
|
|
|
6093
6099
|
* Creates an instance of the Conversations service.
|
|
6094
6100
|
*
|
|
6095
6101
|
* @param instance - UiPath SDK instance providing authentication and configuration
|
|
6102
|
+
* @param options - Optional configuration (e.g. externalUserId for external app auth)
|
|
6096
6103
|
*/
|
|
6097
|
-
constructor(instance: IUiPath$1);
|
|
6104
|
+
constructor(instance: IUiPath$1, options?: ConversationalAgentOptions);
|
|
6098
6105
|
/**
|
|
6099
6106
|
* Creates a new conversation
|
|
6100
6107
|
*
|
|
@@ -6338,6 +6345,13 @@ declare class ConversationService extends BaseService implements ConversationSer
|
|
|
6338
6345
|
* ```
|
|
6339
6346
|
*/
|
|
6340
6347
|
declare class ExchangeService extends BaseService implements ExchangeServiceModel {
|
|
6348
|
+
/**
|
|
6349
|
+
* Creates an instance of the ExchangeService.
|
|
6350
|
+
*
|
|
6351
|
+
* @param instance - UiPath SDK instance providing authentication and configuration
|
|
6352
|
+
* @param options - Optional configuration (e.g. externalUserId for external app auth)
|
|
6353
|
+
*/
|
|
6354
|
+
constructor(instance: IUiPath$1, options?: ConversationalAgentOptions);
|
|
6341
6355
|
/**
|
|
6342
6356
|
* Gets all exchanges for a conversation with optional filtering and pagination
|
|
6343
6357
|
*
|
|
@@ -6452,6 +6466,13 @@ declare class ExchangeService extends BaseService implements ExchangeServiceMode
|
|
|
6452
6466
|
* ```
|
|
6453
6467
|
*/
|
|
6454
6468
|
declare class MessageService extends BaseService implements MessageServiceModel {
|
|
6469
|
+
/**
|
|
6470
|
+
* Creates an instance of the MessageService.
|
|
6471
|
+
*
|
|
6472
|
+
* @param instance - UiPath SDK instance providing authentication and configuration
|
|
6473
|
+
* @param options - Optional configuration (e.g. externalUserId for external app auth)
|
|
6474
|
+
*/
|
|
6475
|
+
constructor(instance: IUiPath$1, options?: ConversationalAgentOptions);
|
|
6455
6476
|
/**
|
|
6456
6477
|
* Gets a message by ID
|
|
6457
6478
|
*
|
|
@@ -6513,8 +6534,9 @@ declare class ConversationalAgentService extends BaseService implements Conversa
|
|
|
6513
6534
|
* Creates an instance of the ConversationalAgent service.
|
|
6514
6535
|
*
|
|
6515
6536
|
* @param instance - UiPath SDK instance providing authentication and configuration
|
|
6537
|
+
* @param options - Optional configuration (e.g. externalUserId for external app auth)
|
|
6516
6538
|
*/
|
|
6517
|
-
constructor(instance: IUiPath$1);
|
|
6539
|
+
constructor(instance: IUiPath$1, options?: ConversationalAgentOptions);
|
|
6518
6540
|
/**
|
|
6519
6541
|
* Registers a handler that is called whenever the WebSocket connection status changes.
|
|
6520
6542
|
*
|
|
@@ -49,7 +49,7 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
|
|
|
49
49
|
// Connection string placeholder that will be replaced during build
|
|
50
50
|
const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
|
|
51
51
|
// SDK Version placeholder
|
|
52
|
-
const SDK_VERSION = "1.
|
|
52
|
+
const SDK_VERSION = "1.3.1";
|
|
53
53
|
const VERSION = "Version";
|
|
54
54
|
const SERVICE = "Service";
|
|
55
55
|
const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
|
|
@@ -796,26 +796,27 @@ const RESPONSE_TYPES = {
|
|
|
796
796
|
BLOB: 'blob',
|
|
797
797
|
ARRAYBUFFER: 'arraybuffer'
|
|
798
798
|
};
|
|
799
|
+
/**
|
|
800
|
+
* Header key for external user ID (used in both HTTP and WebSocket for external app auth
|
|
801
|
+
* in Conversational Agents Service)
|
|
802
|
+
*/
|
|
803
|
+
const EXTERNAL_USER_ID = 'x-uipath-external-user-id';
|
|
799
804
|
/**
|
|
800
805
|
* Query parameter keys sent during WebSocket connection
|
|
801
806
|
*/
|
|
802
807
|
const WEBSOCKET_QUERY_PARAMS = {
|
|
803
808
|
ORGANIZATION_ID: 'x-uipath-internal-accountid',
|
|
804
809
|
TENANT_ID: 'x-uipath-internal-tenantid',
|
|
805
|
-
EXTERNAL_USER_ID
|
|
810
|
+
EXTERNAL_USER_ID,
|
|
806
811
|
};
|
|
807
812
|
|
|
808
813
|
class ApiClient {
|
|
809
814
|
constructor(config, executionContext, tokenManager, clientConfig = {}) {
|
|
810
|
-
this.defaultHeaders = {};
|
|
811
815
|
this.config = config;
|
|
812
816
|
this.executionContext = executionContext;
|
|
813
817
|
this.clientConfig = clientConfig;
|
|
814
818
|
this.tokenManager = tokenManager;
|
|
815
819
|
}
|
|
816
|
-
setDefaultHeaders(headers) {
|
|
817
|
-
this.defaultHeaders = { ...this.defaultHeaders, ...headers };
|
|
818
|
-
}
|
|
819
820
|
/**
|
|
820
821
|
* Gets a valid authentication token, refreshing if necessary.
|
|
821
822
|
* Used internally for API requests and exposed for services that need manual auth headers.
|
|
@@ -831,7 +832,6 @@ class ApiClient {
|
|
|
831
832
|
return {
|
|
832
833
|
'Authorization': `Bearer ${token}`,
|
|
833
834
|
'Content-Type': CONTENT_TYPES.JSON,
|
|
834
|
-
...this.defaultHeaders,
|
|
835
835
|
...this.clientConfig.headers
|
|
836
836
|
};
|
|
837
837
|
}
|
|
@@ -1695,6 +1695,8 @@ class BaseService {
|
|
|
1695
1695
|
*
|
|
1696
1696
|
* @param instance - UiPath SDK instance providing authentication and configuration.
|
|
1697
1697
|
* Services receive this via dependency injection in the modular pattern.
|
|
1698
|
+
* @param headers - Optional default headers to include in every request (e.g. `x-uipath-external-user-id` for
|
|
1699
|
+
* CAS external-app auth)
|
|
1698
1700
|
*
|
|
1699
1701
|
* @example
|
|
1700
1702
|
* ```typescript
|
|
@@ -1714,11 +1716,11 @@ class BaseService {
|
|
|
1714
1716
|
* const entities = new Entities(sdk);
|
|
1715
1717
|
* ```
|
|
1716
1718
|
*/
|
|
1717
|
-
constructor(instance) {
|
|
1719
|
+
constructor(instance, headers) {
|
|
1718
1720
|
// Private field - not visible via Object.keys() or any reflection
|
|
1719
1721
|
_BaseService_apiClient.set(this, void 0);
|
|
1720
1722
|
const { config, context, tokenManager } = SDKInternalsRegistry.get(instance);
|
|
1721
|
-
__classPrivateFieldSet(this, _BaseService_apiClient, new ApiClient(config, context, tokenManager), "f");
|
|
1723
|
+
__classPrivateFieldSet(this, _BaseService_apiClient, new ApiClient(config, context, tokenManager, headers ? { headers } : {}), "f");
|
|
1722
1724
|
}
|
|
1723
1725
|
/**
|
|
1724
1726
|
* Gets a valid authentication token, refreshing if necessary.
|
|
@@ -5009,6 +5011,15 @@ function transformMessage(message) {
|
|
|
5009
5011
|
* ```
|
|
5010
5012
|
*/
|
|
5011
5013
|
class ExchangeService extends BaseService {
|
|
5014
|
+
/**
|
|
5015
|
+
* Creates an instance of the ExchangeService.
|
|
5016
|
+
*
|
|
5017
|
+
* @param instance - UiPath SDK instance providing authentication and configuration
|
|
5018
|
+
* @param options - Optional configuration (e.g. externalUserId for external app auth)
|
|
5019
|
+
*/
|
|
5020
|
+
constructor(instance, options) {
|
|
5021
|
+
super(instance, options?.externalUserId ? { [EXTERNAL_USER_ID]: options.externalUserId } : undefined);
|
|
5022
|
+
}
|
|
5012
5023
|
/**
|
|
5013
5024
|
* Gets all exchanges for a conversation with optional filtering and pagination
|
|
5014
5025
|
*
|
|
@@ -5981,13 +5992,14 @@ class ConversationService extends BaseService {
|
|
|
5981
5992
|
* Creates an instance of the Conversations service.
|
|
5982
5993
|
*
|
|
5983
5994
|
* @param instance - UiPath SDK instance providing authentication and configuration
|
|
5995
|
+
* @param options - Optional configuration (e.g. externalUserId for external app auth)
|
|
5984
5996
|
*/
|
|
5985
|
-
constructor(instance) {
|
|
5986
|
-
super(instance);
|
|
5997
|
+
constructor(instance, options) {
|
|
5998
|
+
super(instance, options?.externalUserId ? { [EXTERNAL_USER_ID]: options.externalUserId } : undefined);
|
|
5987
5999
|
/** Event helper for conversation events */
|
|
5988
6000
|
this._eventHelper = null;
|
|
5989
|
-
this._sessionManager = new SessionManager(instance);
|
|
5990
|
-
this._exchangeService = new ExchangeService(instance);
|
|
6001
|
+
this._sessionManager = new SessionManager(instance, options);
|
|
6002
|
+
this._exchangeService = new ExchangeService(instance, options);
|
|
5991
6003
|
}
|
|
5992
6004
|
// ==================== Conversation CRUD Operations ====================
|
|
5993
6005
|
/**
|
|
@@ -6369,6 +6381,15 @@ __decorate([
|
|
|
6369
6381
|
* ```
|
|
6370
6382
|
*/
|
|
6371
6383
|
class MessageService extends BaseService {
|
|
6384
|
+
/**
|
|
6385
|
+
* Creates an instance of the MessageService.
|
|
6386
|
+
*
|
|
6387
|
+
* @param instance - UiPath SDK instance providing authentication and configuration
|
|
6388
|
+
* @param options - Optional configuration (e.g. externalUserId for external app auth)
|
|
6389
|
+
*/
|
|
6390
|
+
constructor(instance, options) {
|
|
6391
|
+
super(instance, options?.externalUserId ? { [EXTERNAL_USER_ID]: options.externalUserId } : undefined);
|
|
6392
|
+
}
|
|
6372
6393
|
/**
|
|
6373
6394
|
* Gets a message by ID
|
|
6374
6395
|
*
|
|
@@ -6439,11 +6460,12 @@ class ConversationalAgentService extends BaseService {
|
|
|
6439
6460
|
* Creates an instance of the ConversationalAgent service.
|
|
6440
6461
|
*
|
|
6441
6462
|
* @param instance - UiPath SDK instance providing authentication and configuration
|
|
6463
|
+
* @param options - Optional configuration (e.g. externalUserId for external app auth)
|
|
6442
6464
|
*/
|
|
6443
|
-
constructor(instance) {
|
|
6444
|
-
super(instance);
|
|
6465
|
+
constructor(instance, options) {
|
|
6466
|
+
super(instance, options?.externalUserId ? { [EXTERNAL_USER_ID]: options.externalUserId } : undefined);
|
|
6445
6467
|
// Create conversation service with WebSocket support
|
|
6446
|
-
this.conversations = new ConversationService(instance);
|
|
6468
|
+
this.conversations = new ConversationService(instance, options);
|
|
6447
6469
|
}
|
|
6448
6470
|
/**
|
|
6449
6471
|
* Registers a handler that is called whenever the WebSocket connection status changes.
|
package/dist/core/index.cjs
CHANGED
|
@@ -5278,7 +5278,7 @@ function normalizeBaseUrl(url) {
|
|
|
5278
5278
|
// Connection string placeholder that will be replaced during build
|
|
5279
5279
|
const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
|
|
5280
5280
|
// SDK Version placeholder
|
|
5281
|
-
const SDK_VERSION = "1.
|
|
5281
|
+
const SDK_VERSION = "1.3.1";
|
|
5282
5282
|
const VERSION = "Version";
|
|
5283
5283
|
const SERVICE = "Service";
|
|
5284
5284
|
const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
|
|
@@ -5667,7 +5667,7 @@ var _UiPath_instances, _UiPath_config, _UiPath_authService, _UiPath_initialized,
|
|
|
5667
5667
|
*
|
|
5668
5668
|
* Supports two usage patterns:
|
|
5669
5669
|
* 1. Full config in constructor — for server-side or explicit configuration
|
|
5670
|
-
* 2. No config / partial config — loads from meta tags injected by @uipath/coded-apps plugin
|
|
5670
|
+
* 2. No config / partial config — loads from meta tags injected by @uipath/coded-apps-dev plugin
|
|
5671
5671
|
*
|
|
5672
5672
|
* @example
|
|
5673
5673
|
* ```typescript
|
package/dist/core/index.d.ts
CHANGED
|
@@ -91,7 +91,7 @@ interface IUiPath {
|
|
|
91
91
|
*
|
|
92
92
|
* Supports two usage patterns:
|
|
93
93
|
* 1. Full config in constructor — for server-side or explicit configuration
|
|
94
|
-
* 2. No config / partial config — loads from meta tags injected by @uipath/coded-apps plugin
|
|
94
|
+
* 2. No config / partial config — loads from meta tags injected by @uipath/coded-apps-dev plugin
|
|
95
95
|
*
|
|
96
96
|
* @example
|
|
97
97
|
* ```typescript
|
|
@@ -519,7 +519,7 @@ declare const telemetryClient: TelemetryClient;
|
|
|
519
519
|
* SDK Telemetry constants
|
|
520
520
|
*/
|
|
521
521
|
declare const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
|
|
522
|
-
declare const SDK_VERSION = "1.
|
|
522
|
+
declare const SDK_VERSION = "1.3.1";
|
|
523
523
|
declare const VERSION = "Version";
|
|
524
524
|
declare const SERVICE = "Service";
|
|
525
525
|
declare const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
|
package/dist/core/index.mjs
CHANGED
|
@@ -5276,7 +5276,7 @@ function normalizeBaseUrl(url) {
|
|
|
5276
5276
|
// Connection string placeholder that will be replaced during build
|
|
5277
5277
|
const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
|
|
5278
5278
|
// SDK Version placeholder
|
|
5279
|
-
const SDK_VERSION = "1.
|
|
5279
|
+
const SDK_VERSION = "1.3.1";
|
|
5280
5280
|
const VERSION = "Version";
|
|
5281
5281
|
const SERVICE = "Service";
|
|
5282
5282
|
const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
|
|
@@ -5665,7 +5665,7 @@ var _UiPath_instances, _UiPath_config, _UiPath_authService, _UiPath_initialized,
|
|
|
5665
5665
|
*
|
|
5666
5666
|
* Supports two usage patterns:
|
|
5667
5667
|
* 1. Full config in constructor — for server-side or explicit configuration
|
|
5668
|
-
* 2. No config / partial config — loads from meta tags injected by @uipath/coded-apps plugin
|
|
5668
|
+
* 2. No config / partial config — loads from meta tags injected by @uipath/coded-apps-dev plugin
|
|
5669
5669
|
*
|
|
5670
5670
|
* @example
|
|
5671
5671
|
* ```typescript
|