@carbon/ai-chat 0.1.6-alpha0 → 0.1.6

package/dist/cjs/Carousel.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/Chat.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 
@@ -1349,11 +1349,22 @@ class ChatActionsImpl {
      */
     receiveChunk(chunk, messageID, options = {}) {
         const isCompleteItem = cdsAichatInternal.isStreamCompleteItem(chunk);
-        if (isCompleteItem || cdsAichatInternal.isStreamPartialItem(chunk)) {
+        const isPartialItem = cdsAichatInternal.isStreamPartialItem(chunk);
+        const { store } = this.serviceManager;
+        const isStopGeneratingVisible = store.getState().botInputState.stopStreamingButtonState.isVisible;
+        if (isPartialItem) {
+            const streamingData = chunk.partial_item.streaming_metadata;
+            if (streamingData.stream_id) {
+                store.dispatch(cdsAichatInternal.actions.setStreamID(streamingData.stream_id));
+            }
+            if (streamingData.cancellable && !isStopGeneratingVisible) {
+                store.dispatch(cdsAichatInternal.actions.setStopStreamingButtonVisible(true));
+            }
+        }
+        if (isCompleteItem || isPartialItem) {
             if (!messageID) {
                 messageID = chunk.streaming_metadata.response_id;
             }
-            const { store } = this.serviceManager;
             if (!store.getState().allMessagesByID[messageID]) {
                 store.dispatch(cdsAichatInternal.actions.streamingStart(messageID));
             }
@@ -1377,6 +1388,12 @@ class ChatActionsImpl {
                 disableFadeAnimation: true,
             });
         }
+        if ((isCompleteItem || cdsAichatInternal.isStreamFinalResponse(chunk)) && isStopGeneratingVisible) {
+            // Once a complete or final response is received, reset the visible and disabled states for the "stop streaming"
+            // button.
+            store.dispatch(cdsAichatInternal.actions.setStopStreamingButtonDisabled(false));
+            store.dispatch(cdsAichatInternal.actions.setStopStreamingButtonVisible(false));
+        }
     }
     /**
      * Provides the store parameters to track the event accordingly.
@@ -4372,6 +4389,163 @@ class MessageService {
             }
         }
     }
+    /**
+     * This function sends a message event request to the assistant to trigger stop streaming from the watsonx
+     * Assistant backend.
+     *
+     * @param streamID The ID of the stream to stop.
+     */
+    async stopStreaming(streamID) {
+        const { store } = this.serviceManager;
+        const eventMessage = cdsAichatInternal.createEventMessageRequest({ name: cdsAichatInternal.EVENT_STOP_STREAMING, stream_id: streamID });
+        // Create a Promise that the caller can wait on that we'll resolve if/when the message is finally successfully sent.
+        const sendMessagePromise = cdsAichatInternal.resolvablePromise();
+        const soloMessageRequest = { message: eventMessage, sendMessagePromise };
+        await this.sendMessageRequest(soloMessageRequest);
+        const { stopStreamingButtonState } = store.getState().botInputState;
+        if (stopStreamingButtonState.isDisabled && sendMessagePromise.isRejected) {
+            store.dispatch(cdsAichatInternal.actions.setStopStreamingButtonDisabled(false));
+        }
+    }
+    /**
+     * This function is for sending message requests independently of the message queue. This can be useful for sending
+     * messages not part of the
+     *
+     * @param current The current message being sent.
+     */
+    async sendMessageRequest(current) {
+        const transactionID = cdsAichatInternal.uuid(cdsAichatInternal.UUIDType.MISCELLANEOUS);
+        const allowStream = this.serviceManager.store.getState().streaming.enabled;
+        const fetchParameters = createFetchParameters(this.serviceManager, transactionID, allowStream);
+        const chatRequest = await this.createChatRequest(current.message);
+        try {
+            await this.doFetchSingly(chatRequest, fetchParameters, current);
+        }
+        catch (error) {
+            cdsAichatInternal.consoleError('An error occurred trying to send a message request.', error);
+        }
+    }
+    /**
+     * This function will open a fetch event source to handle responses separately from message queue.
+     */
+    async doFetchSingly(chatRequest, fetchParameters, current) {
+        const { serviceManager, messageURL } = this;
+        const { fetch } = serviceManager;
+        const abortController = new AbortController();
+        // The promise that will be resolved when the whole response is done (streaming or not).
+        const donePromise = cdsAichatInternal.resolvablePromise();
+        // The timeout timer used to trigger a timeout if we stop getting streaming messages.
+        let streamTimeoutTimer;
+        // When web chat gets the beginning of a response from the server, it does not know right away if the response
+        // will just be an immediate regular message response or if it will contain a stream to come later (there seems
+        // to be a short delay between onopen and onmessage). This timer is a hack to try and determine which case we're
+        // dealing with. This affects the display on the stream loading indicator as well as disabling the input field.
+        let streamStartingTimer;
+        /**
+         * Handles when a streaming timeout or error occurs.
+         */
+        const handleError = () => {
+            cdsAichatInternal.consoleError('[solo streaming] A timeout or error while streaming has occurred.');
+            // Make sure to actually close the stream.
+            abortController.abort();
+        };
+        /**
+         * Starts or restarts the timeout on the streaming.
+         */
+        const startTimeout = () => {
+            if (streamTimeoutTimer) {
+                clearTimeout(streamTimeoutTimer);
+            }
+            streamTimeoutTimer = setTimeout(handleError, STREAMING_MESSAGE_TIMEOUT_MS);
+        };
+        /**
+         * Called when a response is received from the fetch call. If an error is thrown from here, it will abort the
+         * processing of the stream.
+         */
+        const onOpen = async (response) => {
+            cdsAichatInternal.debugLog('[solo streaming] onOpen', response);
+            if (!response) {
+                // This generally only occurs in test cases that failed to configure a response on the mock.
+                cdsAichatInternal.consoleError('No result was received for solo message request', JSON.stringify(chatRequest, null, 2));
+                throw new Error('No result was received for solo message request');
+            }
+            if (response.headers.get(cdsAichatInternal.HEADER_CONTENT_TYPE) !== cdsAichatInternal.MIME_STREAM) {
+                // Make sure to sink the entire response so we guarantee it will be available after the fetch closes the
+                // connection. This relies on the fetchWrapper to cache the result.
+                await response.text();
+                donePromise.doResolve();
+                // Throwing this stops the library from processing the response as a streaming response. This will be
+                // caught by the onerror handler. This will terminate the whole fetch process and we will then process the
+                // response below.
+                throw NOT_STREAMING;
+            }
+            // At this point, it means that we are going to start streaming.
+            cdsAichatInternal.debugLog('[solo streaming] onOpen - Waiting for streaming to start');
+            startTimeout();
+        };
+        /**
+         * Called when an error occurs. If an error is thrown from here, it will prevent the library from attempting to
+         * retry the connection.
+         */
+        const onError = (error) => {
+            if (error !== NOT_STREAMING) {
+                cdsAichatInternal.consoleError('[solo streaming] onError', error);
+                handleError();
+            }
+            current.sendMessagePromise.doReject(error);
+            // This will stop the client from attempting to retry the stream.
+            throw error;
+        };
+        /**
+         * Called when the response is closed.
+         */
+        const onClose = () => {
+            cdsAichatInternal.debugLog('[solo streaming] onClose');
+            donePromise.doResolve();
+        };
+        /**
+         * Called when a message event is received on a streaming response.
+         */
+        const onMessage = (event) => {
+            if (donePromise.isResolved) {
+                cdsAichatInternal.debugLog('[solo streaming] onMessage Ignoring message', cdsAichatInternal.tryJSONParse(event.data), event);
+                return;
+            }
+            if (cdsAichatInternal.isEnableDebugLog()) {
+                cdsAichatInternal.debugLog('[solo streaming] onMessage', cdsAichatInternal.tryJSONParse(event.data), event);
+            }
+            const eventType = event.event;
+            if (eventType === 'done' || eventType === 'server_error') {
+                current.sendMessagePromise.doResolve();
+                // This is a signal for the client to close the stream.
+                abortController.abort();
+            }
+        };
+        // Kick off the fetch request.
+        fetchEventSource(messageURL, {
+            ...fetchParameters,
+            // Used to close the stream by the client.
+            signal: abortController.signal,
+            fetch,
+            // This prevents the library from closing the stream if the document becomes visibly hidden (like if the user
+            // minimizes the browser window).
+            openWhenHidden: true,
+            body: JSON.stringify(chatRequest),
+            onopen: onOpen,
+            onerror: onError,
+            onclose: onClose,
+            onmessage: onMessage,
+        }).catch(error => {
+            if (error !== NOT_STREAMING) {
+                cdsAichatInternal.consoleError('Error occurred during a singly message fetch', error);
+            }
+            current.sendMessagePromise.doReject(error);
+        });
+        // This will wait for either a regular response to complete or for an entire stream to complete or for a timeout
+        // (while streaming) to occur.
+        await donePromise;
+        clearTimeout(streamStartingTimer);
+    }
     /**
      * Handles a regular, non-streaming response from the server.
      */
@@ -7372,6 +7546,42 @@ const reducers = {
             },
         };
     },
+    [cdsAichatInternal.SET_STOP_STREAMING_BUTTON_VISIBLE]: (state, { isVisible }) => {
+        return {
+            ...state,
+            botInputState: {
+                ...state.botInputState,
+                stopStreamingButtonState: {
+                    ...state.botInputState.stopStreamingButtonState,
+                    isVisible,
+                },
+            },
+        };
+    },
+    [cdsAichatInternal.SET_STOP_STREAMING_BUTTON_DISABLED]: (state, { isDisabled }) => {
+        return {
+            ...state,
+            botInputState: {
+                ...state.botInputState,
+                stopStreamingButtonState: {
+                    ...state.botInputState.stopStreamingButtonState,
+                    isDisabled,
+                },
+            },
+        };
+    },
+    [cdsAichatInternal.SET_STREAM_ID]: (state, { currentStreamID }) => {
+        return {
+            ...state,
+            botInputState: {
+                ...state.botInputState,
+                stopStreamingButtonState: {
+                    ...state.botInputState.stopStreamingButtonState,
+                    currentStreamID,
+                },
+            },
+        };
+    },
 };
 /**
  * Adds the given full message to the redux store. This will add it global to the global map as well as add the

package/dist/cjs/GenesysMessengerServiceDesk.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 
@@ -205,7 +205,7 @@ class GenesysMessengerServiceDesk extends ServiceDeskImpl.ServiceDeskImpl {
     async handleFileAttachments(message, agentID) {
         const files = this.getFileAttachments(message);
         const items = files.map(({ filename, url }) => cdsAichatInternal.assertType({
-            response_type: cdsAichatInternal.InternalMessageResponseType.BUTTON,
+            response_type: cdsAichatInternal.MessageResponseTypes.BUTTON,
             kind: cdsAichatInternal.ButtonItemKind.LINK,
             button_type: cdsAichatInternal.ButtonItemType.URL,
             url,

package/dist/cjs/HumanAgentServiceImpl.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/NiceDFOServiceDesk.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 
@@ -1904,7 +1904,7 @@ class NiceDFOServiceDesk extends ServiceDeskImpl.ServiceDeskImpl {
             if (message.attachments?.length) {
                 message.attachments.forEach((attachment) => {
                     messageItems.push(cdsAichatInternal.assertType({
-                        response_type: cdsAichatInternal.InternalMessageResponseType.BUTTON,
+                        response_type: cdsAichatInternal.MessageResponseTypes.BUTTON,
                         kind: cdsAichatInternal.ButtonItemKind.LINK,
                         button_type: cdsAichatInternal.ButtonItemType.URL,
                         url: attachment.url,

package/dist/cjs/PDFViewerContainer.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/ReactPlayer.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/SFServiceDesk.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/ServiceDeskImpl.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/Table.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/ZendeskServiceDesk.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/_node-resolve_empty.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/agentActions.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/aiChatEntry.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/anonymousUserIDStorage.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/ar-dz.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/ar-kw.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/ar-ly.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/ar-ma.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/ar-sa.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/ar-tn.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/ar.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/ar2.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/cds-aichat-container.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00
 
 
 

package/dist/cjs/cds-aichat-custom-element.js

@@ -13,9 +13,9 @@ is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND
 or implied. See the License for the specific language governing permissions and limitations under
 the License.
 
-@carbon/ai-chat 0.1.6-alpha0
+@carbon/ai-chat 0.1.6
 
-Built: Jan 22 2025 1:15 pm -05:00
+Built: Feb 3 2025 9:58 am -05:00