@uipath/uipath-typescript 1.4.2 → 1.5.1

package/dist/conversational-agent/index.cjs

@@ -1023,7 +1023,16 @@ const CONVERSATIONAL_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
@@ -1046,21 +1055,28 @@ const CONVERSATIONAL_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;
 }
@@ -2821,6 +2837,7 @@ class ToolCallEventHelper extends ConversationEventHelperBase {
         this.startEventMaybe = startEventMaybe;
         this._endHandlers = new Array();
         this._confirmHandlers = new Array();
+        this._executingHandlers = new Array();
         this.addStartEventTimestamp(startEventMaybe);
     }
     /**
@@ -2905,6 +2922,21 @@ class ToolCallEventHelper extends ConversationEventHelperBase {
         this.assertNotEnded();
         this.emit({ confirmToolCall });
     }
+    /**
+     * Registers a handler for executingToolCall events.
+     * Fired when the tool is about to be executed. For client-side tools,
+     * the client should begin executing its handler upon receiving this.
+     * @returns Cleanup function to remove the handler.
+     * @internal
+     */
+    onExecutingToolCall(cb) {
+        this._executingHandlers.push(cb);
+        return () => {
+            const index = this._executingHandlers.indexOf(cb);
+            if (index >= 0)
+                this._executingHandlers.splice(index, 1);
+        };
+    }
     /**
      * Sends an error start event for this tool call.
      */
@@ -2984,6 +3016,10 @@ class ToolCallEventHelperImpl extends ToolCallEventHelper {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             this._confirmHandlers.forEach(cb => cb(toolCallEvent.confirmToolCall));
         }
+        if (toolCallEvent.executingToolCall) {
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            this._executingHandlers.forEach(cb => cb(toolCallEvent.executingToolCall));
+        }
         if (toolCallEvent.endToolCall) {
             this.setEnded();
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -3580,7 +3616,9 @@ class ExchangeEventHelper extends ConversationEventHelperBase {
         this.emit({ metaEvent });
     }
     /**
-     * Ends the exchange with optional end event data.
+     * Ends the exchange. Stops further events for that exchange from being received.
+     * Can be called from either the client side (to stop an in-progress response) or
+     * the server/agent side (to signal natural completion).
      * @throws Error if exchange has already ended.
      */
     sendExchangeEnd(endExchange = {}) {

package/dist/conversational-agent/index.d.ts

@@ -887,6 +887,16 @@ interface SessionEndingEvent {
      */
     timeToLiveMS: number;
 }
+/**
+ * A client-side tool that the client supports, declared during exchange start
+ * so the server knows which tools to route client-side.
+ * @internal
+ */
+interface ClientSideTool {
+    name: string;
+    inputSchema?: JSONValue;
+    outputSchema?: JSONValue;
+}
 /**
  * Signals the start of an exchange of messages within a conversation.
  */
@@ -903,6 +913,12 @@ interface ExchangeStartEvent {
      * The time the exchange started.
      */
     timestamp?: string;
+    /**
+     * Optional list of client-side tools the client supports. The server validates these against the agent's
+     * design-time definitions and forwards them to the runtime so it knows which tools to route client-side.
+     * @internal
+     */
+    clientSideTools?: ClientSideTool[];
 }
 /**
  * Signals the end of an exchange of messages within a conversation.
@@ -1156,6 +1172,16 @@ interface ToolCallStartEvent {
      * `requireConfirmation` is true so the client can render an editable form.
      */
     inputSchema?: JSONValue;
+    /**
+     * Output schema — used by the client to render the result form for client-side tools.
+     * @internal
+     */
+    outputSchema?: JSONValue;
+    /**
+     * Indicates this tool call should be executed client-side rather than server-side.
+     * @internal
+     */
+    isClientSideTool?: boolean;
 }
 /**
  * Sent by the client to approve or reject a tool call that was emitted with
@@ -1198,6 +1224,20 @@ interface ToolCallEndEvent {
      */
     metaData?: MetaData;
 }
+/**
+ * Signals to the client that the tool is about to be executed. Emitted in all scenarios
+ * (server-side and client-side tools). For client-side tools, the client should begin
+ * executing its registered handler upon receiving this event.
+ * @internal
+ */
+interface ExecutingToolCallEvent {
+    /**
+     * The time the tool call began executing.
+     */
+    timestamp?: string;
+    /** The final tool input, reflecting any modifications made during tool-call confirmation. */
+    input?: ToolCallInputValue;
+}
 /**
  * Allows additional events to be sent in the context of the enclosing event stream.
  */
@@ -1238,6 +1278,12 @@ interface ToolCallEvent {
      * emitted with `requireConfirmation: true`.
      */
     confirmToolCall?: ToolCallConfirmationEvent;
+    /**
+     * Signals that the tool is about to be executed. For client-side tools,
+     * the client should begin executing its handler upon receiving this event.
+     * @internal
+     */
+    executingToolCall?: ExecutingToolCallEvent;
     /**
      * Allows additional events to be sent in the context of the enclosing event stream.
      */
@@ -1916,6 +1962,19 @@ type CompletedToolCall = ToolCallStartEvent & ToolCallEndEvent & {
  *   }
  * });
  * ```
+ *
+ * @example Handling client-side tool execution
+ * ```typescript
+ * message.onToolCallStart((toolCall) => {
+ *   const { isClientSideTool, toolName } = toolCall.startEvent;
+ *   if (!isClientSideTool) return;
+ *
+ *   toolCall.onExecutingToolCall(async (event) => {
+ *     const result = await runLocalProcess(toolName, event.input);
+ *     toolCall.sendToolCallEnd({ output: result });
+ *   });
+ * });
+ * ```
  */
 interface ToolCallStream {
     /** Unique identifier for this tool call */
@@ -1987,6 +2046,24 @@ interface ToolCallStream {
      * ```
      */
     onToolCallConfirm(callback: (confirmToolCall: ToolCallConfirmationEvent) => void): () => void;
+    /**
+     * Registers a handler for executingToolCall events. Fired when the tool is about
+     * to be executed. For client-side tools, the client should begin executing its
+     * handler upon receiving this event.
+     *
+     * @param cb - Callback receiving the executing event
+     * @returns Cleanup function to remove the handler
+     *
+     * @example Handling client-side tool execution
+     * ```typescript
+     * toolCall.onExecutingToolCall(async (event) => {
+     *   const result = await executeLocally(toolCall.startEvent.toolName, event.input);
+     *   toolCall.sendToolCallEnd({ output: result });
+     * });
+     * ```
+     * @internal
+     */
+    onExecutingToolCall(cb: (event: ExecutingToolCallEvent) => void): () => void;
     /**
      * Ends the tool call
      *
@@ -3018,12 +3095,23 @@ interface ExchangeStream {
      */
     getMessage(messageId: string): MessageStream | undefined;
     /**
-     * Ends the exchange
+     * Ends the exchange. Stops further events for that exchange from being received.
+     * Use this to stop an in-progress agent response from the client side.
      *
      * @param endExchange - Optional end event data
      *
-     * @example Manually ending an exchange
+     * @example Manually ending an exchange and stopping a response mid-stream
+     * ```typescript
+     * session.onExchangeStart((exchange) => {
+     *   stopButton.addEventListener('click', () => exchange.sendExchangeEnd());
+     * });
+     * ```
+     *
+     * @example End an exchange after sending a message
      * ```typescript
+     * const exchange = session.startExchange();
+     * exchange.sendMessageWithContentPart({ data: 'Hello!' });
+     * // Later, stop the response
      * exchange.sendExchangeEnd();
      * ```
      */
@@ -4805,6 +4893,7 @@ type FeatureFlags = Record<string, unknown>;
  *     S -->|onExchangeStart| E["ExchangeStream"]
  *     S -->|onSessionEnd| SE(["session closed"])
  *     E -->|onMessageStart| M["MessageStream"]
+ *     E -->|sendExchangeEnd| STOP(["stop response"])
  *     E -->|onExchangeEnd| EE(["exchange complete"])
  *     M -->|onContentPartStart| CP["ContentPartStream"]
  *     M -->|onToolCallStart| TC["ToolCallStream"]
@@ -4848,10 +4937,20 @@ type FeatureFlags = Record<string, unknown>;
  *   exchange.sendMessageWithContentPart({ data: 'Hello!' });
  * });
  *
- * // 5. End session when done
+ * // 5. Stop a response mid-stream
+ * // Use sendExchangeEnd() on any active exchange to stop the agent
+ * session.onSessionStarted(() => {
+ *   const exchange = session.startExchange();
+ *   exchange.sendMessageWithContentPart({ data: 'Tell me a long story' });
+ *
+ *   // Stop after 5 seconds
+ *   setTimeout(() => exchange.sendExchangeEnd(), 5000);
+ * });
+ *
+ * // 6. End session when done
  * conversation.endSession();
  *
- * // 6. Retrieve conversation history (offline)
+ * // 7. Retrieve conversation history (offline)
  * const exchanges = await conversation.exchanges.getAll();
  * ```
  */
@@ -5184,6 +5283,7 @@ declare abstract class ToolCallEventHelper extends ConversationEventHelperBase<T
     readonly startEventMaybe: ToolCallStartEvent | undefined;
     protected readonly _endHandlers: ToolCallEndHandler[];
     protected readonly _confirmHandlers: ToolCallConfirmationHandler[];
+    protected readonly _executingHandlers: ExecutingToolCallHandler[];
     constructor(message: MessageEventHelper, toolCallId: string, 
     /**
      * ToolCallStartEvent used to initialize the ToolCallEventHelper. Will be undefined if some other sub-event was
@@ -5235,6 +5335,14 @@ declare abstract class ToolCallEventHelper extends ConversationEventHelperBase<T
      * @throws Error if tool call has already ended.
      */
     sendToolCallConfirm(confirmToolCall: ToolCallConfirmationEvent): void;
+    /**
+     * Registers a handler for executingToolCall events.
+     * Fired when the tool is about to be executed. For client-side tools,
+     * the client should begin executing its handler upon receiving this.
+     * @returns Cleanup function to remove the handler.
+     * @internal
+     */
+    onExecutingToolCall(cb: ExecutingToolCallHandler): () => void;
     /**
      * Sends an error start event for this tool call.
      */
@@ -5519,7 +5627,9 @@ declare abstract class ExchangeEventHelper extends ConversationEventHelperBase<E
      */
     sendMetaEvent(metaEvent: MetaEvent): void;
     /**
-     * Ends the exchange with optional end event data.
+     * Ends the exchange. Stops further events for that exchange from being received.
+     * Can be called from either the client side (to stop an in-progress response) or
+     * the server/agent side (to signal natural completion).
      * @throws Error if exchange has already ended.
      */
     sendExchangeEnd(endExchange?: ExchangeEndEvent): void;
@@ -6167,6 +6277,7 @@ type ToolCallEndHandler = (endToolCall: ToolCallEndEvent) => void;
 type ToolCallStartHandler = (toolCall: ToolCallEventHelper) => void;
 type ToolCallStartHandlerAsync = (toolCall: ToolCallEventHelper) => Promise<ToolCallEndEvent | void>;
 type ToolCallConfirmationHandler = (confirmToolCall: ToolCallConfirmationEvent) => void;
+type ExecutingToolCallHandler = (event: ExecutingToolCallEvent) => void;
 type ToolCallConfirmHandler = (args: ToolCallConfirmationHandlerArgs) => void;
 type ToolCallCompletedHandler = (completedToolCall: CompletedToolCall) => void;
 type ContentPartCompletedHandler = (completedContentPart: CompletedContentPart) => void;
@@ -7082,4 +7193,4 @@ declare class ConversationalAgentService extends BaseService implements Conversa
 }
 
 export { AgentMap, AsyncInputStreamEventHelper, AsyncInputStreamEventHelperImpl, AsyncToolCallEventHelper, AsyncToolCallEventHelperImpl, CitationErrorType, ContentPartEventHelper, ContentPartEventHelperImpl, ContentPartHelper, ConversationEventHelperBase, ConversationEventHelperManager, ConversationEventHelperManagerImpl, ConversationEventInvalidOperationError, ConversationEventValidationError, ConversationGetAllFilterMap, ConversationMap, ConversationalAgentService as ConversationalAgent, ConversationalAgentService, EventErrorId, ExchangeEventHelper, ExchangeEventHelperImpl, ExchangeMap, ExchangeService, ExchangeService as Exchanges, FeedbackRating, InputStreamSpeechSensitivity, InterruptType, MessageEventHelper, MessageEventHelperImpl, MessageMap, MessageRole, MessageService, MessageService as Messages, SessionEventHelper, SessionEventHelperImpl, SortOrder, ToolCallEventHelper, ToolCallEventHelperImpl, UserSettingsService as UserSettings, UserSettingsMap, UserSettingsService, assertCitationSourceMedia, assertCitationSourceUrl, assertExternalValue, assertInlineValue, createAgentWithMethods, createConversationWithMethods, isCitationSourceMedia, isCitationSourceUrl, isExternalValue, isInlineValue, transformExchange, transformExchanges, transformMessage };
-export type { AgentAppearance, AgentConversationServiceModel, AgentCreateConversationOptions, AgentGetByIdResponse, AgentGetResponse, AgentInput, AgentMethods, AgentStartingPrompt, AnyErrorEndHandler, AnyErrorEndHandlerArgs, AnyErrorStartHandler, AnyErrorStartHandlerArgs, AsyncInputStream, AsyncInputStreamChunkEvent, AsyncInputStreamChunkHandler, AsyncInputStreamEndEvent, AsyncInputStreamEndHandler, AsyncInputStreamEvent, AsyncInputStreamStartEvent, AsyncToolCallStartHandler, AsyncToolCallStartHandlerAsync, AsyncToolCallStream, ChunkHandler, Citation, CitationEndEvent, CitationError, CitationEvent, CitationOptions, CitationSource, CitationSourceBase, CitationSourceMedia, CitationSourceUrl, CitationStartEvent, CompletedContentPart, CompletedMessage, CompletedToolCall, ContentPart, ContentPartChunkEvent, ContentPartCompletedHandler, ContentPartData, ContentPartEndEvent, ContentPartEndHandler, ContentPartEvent, ContentPartGetResponse, ContentPartInterrupted, ContentPartStartEvent, ContentPartStartEventOptions, ContentPartStartEventWithData, ContentPartStartHandler, ContentPartStartHandlerAsync, ContentPartStartMetaData, ContentPartStream, ConversationAttachmentCreateResponse, ConversationAttachmentUploadResponse, ConversationCreateOptions, ConversationCreateResponse, ConversationDeleteResponse, ConversationEvent, ConversationEventEmitter, ConversationEventErrorSource, ConversationEventHandler, ConversationEventHelperManagerConfig, ConversationEventHelperProperties, ConversationExchangeServiceModel, ConversationGetAllOptions, ConversationGetResponse, ConversationJobStartOverrides, ConversationMethods, ConversationServiceModel, ConversationSessionMethods, ConversationSessionOptions, ConversationUpdateOptions, ConversationUpdateResponse, ConversationalAgentOptions, ConversationalAgentServiceModel, CreateFeedbackOptions, DeletedHandler, ErrorEndEvent, ErrorEndEventOptions, ErrorEndHandler, ErrorEndHandlerArgs, ErrorEvent, ErrorStartEvent, ErrorStartEventOptions, ErrorStartHandler, ErrorStartHandlerArgs, Exchange, ExchangeEndEvent, ExchangeEndHandler, ExchangeEvent, ExchangeGetAllOptions, ExchangeGetByIdOptions, ExchangeGetResponse, ExchangeServiceModel, ExchangeStartEvent, ExchangeStartEventOptions, ExchangeStartHandler, ExchangeStartHandlerAsync, ExchangeStream, ExternalValue, FeatureFlags, FeedbackCreateResponse, FileUploadAccess, GenericInterruptStartEvent, InlineOrExternalValue, InlineValue, InputStreamStartEventOptions, InputStreamStartHandler, Interrupt, InterruptCompletedHandler, InterruptCompletedHandlerArgs, InterruptEndEvent, InterruptEndHandler, InterruptEndHandlerArgs, InterruptEvent, InterruptStartEvent, InterruptStartHandler, InterruptStartHandlerArgs, JSONArray, JSONObject, JSONPrimitive, JSONValue, LabelUpdatedEvent, LabelUpdatedHandler, MakeOptional, MakeRequired, Message, MessageCompletedHandler, MessageEndEvent, MessageEndHandler, MessageEvent, MessageGetResponse, MessageServiceModel, MessageStartEvent, MessageStartEventOptions, MessageStartHandler, MessageStartHandlerAsync, MessageStream, MetaData, MetaEvent, MetaEventHandler, RawAgentGetByIdResponse, RawAgentGetResponse, RawConversationGetResponse, SendMessageWithContentPartOptions, SessionCapabilities, SessionEndEvent, SessionEndHandler, SessionEndingEvent, SessionEndingHandler, SessionStartEvent, SessionStartEventOptions, SessionStartHandler, SessionStartHandlerAsync, SessionStartedEvent, SessionStartedHandler, SessionStream, Simplify, ToolCall, ToolCallCompletedHandler, ToolCallConfirmHandler, ToolCallConfirmationEndValue, ToolCallConfirmationEvent, ToolCallConfirmationHandler, ToolCallConfirmationHandlerArgs, ToolCallConfirmationInterruptStartEvent, ToolCallConfirmationValue, ToolCallEndEvent, ToolCallEndHandler, ToolCallEvent, ToolCallInputValue, ToolCallOutputValue, ToolCallResult, ToolCallStartEvent, ToolCallStartEventWithId, ToolCallStartHandler, ToolCallStartHandlerAsync, ToolCallStream, UnhandledErrorEndHandler, UnhandledErrorEndHandlerArgs, UnhandledErrorStartHandler, UnhandledErrorStartHandlerArgs, UserSettingsGetResponse, UserSettingsServiceModel, UserSettingsUpdateOptions, UserSettingsUpdateResponse };
+export type { AgentAppearance, AgentConversationServiceModel, AgentCreateConversationOptions, AgentGetByIdResponse, AgentGetResponse, AgentInput, AgentMethods, AgentStartingPrompt, AnyErrorEndHandler, AnyErrorEndHandlerArgs, AnyErrorStartHandler, AnyErrorStartHandlerArgs, AsyncInputStream, AsyncInputStreamChunkEvent, AsyncInputStreamChunkHandler, AsyncInputStreamEndEvent, AsyncInputStreamEndHandler, AsyncInputStreamEvent, AsyncInputStreamStartEvent, AsyncToolCallStartHandler, AsyncToolCallStartHandlerAsync, AsyncToolCallStream, ChunkHandler, Citation, CitationEndEvent, CitationError, CitationEvent, CitationOptions, CitationSource, CitationSourceBase, CitationSourceMedia, CitationSourceUrl, CitationStartEvent, ClientSideTool, CompletedContentPart, CompletedMessage, CompletedToolCall, ContentPart, ContentPartChunkEvent, ContentPartCompletedHandler, ContentPartData, ContentPartEndEvent, ContentPartEndHandler, ContentPartEvent, ContentPartGetResponse, ContentPartInterrupted, ContentPartStartEvent, ContentPartStartEventOptions, ContentPartStartEventWithData, ContentPartStartHandler, ContentPartStartHandlerAsync, ContentPartStartMetaData, ContentPartStream, ConversationAttachmentCreateResponse, ConversationAttachmentUploadResponse, ConversationCreateOptions, ConversationCreateResponse, ConversationDeleteResponse, ConversationEvent, ConversationEventEmitter, ConversationEventErrorSource, ConversationEventHandler, ConversationEventHelperManagerConfig, ConversationEventHelperProperties, ConversationExchangeServiceModel, ConversationGetAllOptions, ConversationGetResponse, ConversationJobStartOverrides, ConversationMethods, ConversationServiceModel, ConversationSessionMethods, ConversationSessionOptions, ConversationUpdateOptions, ConversationUpdateResponse, ConversationalAgentOptions, ConversationalAgentServiceModel, CreateFeedbackOptions, DeletedHandler, ErrorEndEvent, ErrorEndEventOptions, ErrorEndHandler, ErrorEndHandlerArgs, ErrorEvent, ErrorStartEvent, ErrorStartEventOptions, ErrorStartHandler, ErrorStartHandlerArgs, Exchange, ExchangeEndEvent, ExchangeEndHandler, ExchangeEvent, ExchangeGetAllOptions, ExchangeGetByIdOptions, ExchangeGetResponse, ExchangeServiceModel, ExchangeStartEvent, ExchangeStartEventOptions, ExchangeStartHandler, ExchangeStartHandlerAsync, ExchangeStream, ExecutingToolCallEvent, ExecutingToolCallHandler, ExternalValue, FeatureFlags, FeedbackCreateResponse, FileUploadAccess, GenericInterruptStartEvent, InlineOrExternalValue, InlineValue, InputStreamStartEventOptions, InputStreamStartHandler, Interrupt, InterruptCompletedHandler, InterruptCompletedHandlerArgs, InterruptEndEvent, InterruptEndHandler, InterruptEndHandlerArgs, InterruptEvent, InterruptStartEvent, InterruptStartHandler, InterruptStartHandlerArgs, JSONArray, JSONObject, JSONPrimitive, JSONValue, LabelUpdatedEvent, LabelUpdatedHandler, MakeOptional, MakeRequired, Message, MessageCompletedHandler, MessageEndEvent, MessageEndHandler, MessageEvent, MessageGetResponse, MessageServiceModel, MessageStartEvent, MessageStartEventOptions, MessageStartHandler, MessageStartHandlerAsync, MessageStream, MetaData, MetaEvent, MetaEventHandler, RawAgentGetByIdResponse, RawAgentGetResponse, RawConversationGetResponse, SendMessageWithContentPartOptions, SessionCapabilities, SessionEndEvent, SessionEndHandler, SessionEndingEvent, SessionEndingHandler, SessionStartEvent, SessionStartEventOptions, SessionStartHandler, SessionStartHandlerAsync, SessionStartedEvent, SessionStartedHandler, SessionStream, Simplify, ToolCall, ToolCallCompletedHandler, ToolCallConfirmHandler, ToolCallConfirmationEndValue, ToolCallConfirmationEvent, ToolCallConfirmationHandler, ToolCallConfirmationHandlerArgs, ToolCallConfirmationInterruptStartEvent, ToolCallConfirmationValue, ToolCallEndEvent, ToolCallEndHandler, ToolCallEvent, ToolCallInputValue, ToolCallOutputValue, ToolCallResult, ToolCallStartEvent, ToolCallStartEventWithId, ToolCallStartHandler, ToolCallStartHandlerAsync, ToolCallStream, UnhandledErrorEndHandler, UnhandledErrorEndHandlerArgs, UnhandledErrorStartHandler, UnhandledErrorStartHandlerArgs, UserSettingsGetResponse, UserSettingsServiceModel, UserSettingsUpdateOptions, UserSettingsUpdateResponse };

package/dist/conversational-agent/index.mjs

@@ -1021,7 +1021,16 @@ const CONVERSATIONAL_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
@@ -1044,21 +1053,28 @@ const CONVERSATIONAL_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;
 }
@@ -2819,6 +2835,7 @@ class ToolCallEventHelper extends ConversationEventHelperBase {
         this.startEventMaybe = startEventMaybe;
         this._endHandlers = new Array();
         this._confirmHandlers = new Array();
+        this._executingHandlers = new Array();
         this.addStartEventTimestamp(startEventMaybe);
     }
     /**
@@ -2903,6 +2920,21 @@ class ToolCallEventHelper extends ConversationEventHelperBase {
         this.assertNotEnded();
         this.emit({ confirmToolCall });
     }
+    /**
+     * Registers a handler for executingToolCall events.
+     * Fired when the tool is about to be executed. For client-side tools,
+     * the client should begin executing its handler upon receiving this.
+     * @returns Cleanup function to remove the handler.
+     * @internal
+     */
+    onExecutingToolCall(cb) {
+        this._executingHandlers.push(cb);
+        return () => {
+            const index = this._executingHandlers.indexOf(cb);
+            if (index >= 0)
+                this._executingHandlers.splice(index, 1);
+        };
+    }
     /**
      * Sends an error start event for this tool call.
      */
@@ -2982,6 +3014,10 @@ class ToolCallEventHelperImpl extends ToolCallEventHelper {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             this._confirmHandlers.forEach(cb => cb(toolCallEvent.confirmToolCall));
         }
+        if (toolCallEvent.executingToolCall) {
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            this._executingHandlers.forEach(cb => cb(toolCallEvent.executingToolCall));
+        }
         if (toolCallEvent.endToolCall) {
             this.setEnded();
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -3578,7 +3614,9 @@ class ExchangeEventHelper extends ConversationEventHelperBase {
         this.emit({ metaEvent });
     }
     /**
-     * Ends the exchange with optional end event data.
+     * Ends the exchange. Stops further events for that exchange from being received.
+     * Can be called from either the client side (to stop an in-progress response) or
+     * the server/agent side (to signal natural completion).
      * @throws Error if exchange has already ended.
      */
     sendExchangeEnd(endExchange = {}) {

package/dist/core/index.cjs

@@ -4822,7 +4822,7 @@ class EmbeddedTokenManager {
  * SDK's public API.
  */
 /** SDK version placeholder — patched by the SDK publish workflow. */
-const SDK_VERSION = '1.4.2';
+const SDK_VERSION = '1.5.1';
 const CLOUD_ROLE_NAME = 'uipath-ts-sdk';
 const SDK_SERVICE_NAME = 'UiPath.TypeScript.Sdk';
 const SDK_LOGGER_NAME = 'uipath-ts-sdk-telemetry';

package/dist/core/index.mjs

@@ -4820,7 +4820,7 @@ class EmbeddedTokenManager {
  * SDK's public API.
  */
 /** SDK version placeholder — patched by the SDK publish workflow. */
-const SDK_VERSION = '1.4.2';
+const SDK_VERSION = '1.5.1';
 const CLOUD_ROLE_NAME = 'uipath-ts-sdk';
 const SDK_SERVICE_NAME = 'UiPath.TypeScript.Sdk';
 const SDK_LOGGER_NAME = 'uipath-ts-sdk-telemetry';