@patternfly/chatbot 2.2.1 → 6.3.0-prerelease.1

package/dist/esm/ChatbotConversationHistoryNav/ChatbotConversationHistoryNav.test.js

@@ -13,6 +13,7 @@ import { fireEvent, render, screen, waitFor } from '@testing-library/react';
 import { ChatbotDisplayMode } from '../Chatbot/Chatbot';
 import ChatbotConversationHistoryNav from './ChatbotConversationHistoryNav';
 import { EmptyStateStatus, Spinner } from '@patternfly/react-core';
+import { OutlinedCommentsIcon, SearchIcon } from '@patternfly/react-icons';
 const ERROR = {
     bodyText: (React.createElement(React.Fragment, null,
         "To try again, check your connection and reload this page. If the issue persists,",
@@ -26,6 +27,16 @@ const ERROR = {
     status: EmptyStateStatus.danger,
     onClick: () => alert('Clicked Reload')
 };
+const NO_RESULTS = {
+    bodyText: 'Adjust your search query and try again. Check your spelling or try a more general term.',
+    titleText: 'No results found',
+    icon: SearchIcon
+};
+const EMPTY_STATE = {
+    bodyText: 'Access timely assistance by starting a conversation with an AI model.',
+    titleText: 'Start a new chat',
+    icon: OutlinedCommentsIcon
+};
 const ERROR_WITHOUT_BUTTON = {
     bodyText: (React.createElement(React.Fragment, null,
         "To try again, check your connection and reload this page. If the issue persists,",
@@ -157,4 +168,16 @@ describe('ChatbotConversationHistoryNav', () => {
         render(React.createElement(ChatbotConversationHistoryNav, { onDrawerToggle: onDrawerToggle, isDrawerOpen: true, displayMode: ChatbotDisplayMode.fullscreen, setIsDrawerOpen: jest.fn(), reverseButtonOrder: false, handleTextInputChange: jest.fn(), conversations: initialConversations, isLoading: true, errorState: ERROR }));
         expect(screen.getByRole('dialog', { name: /Loading/i })).toBeTruthy();
     });
+    it('should accept emptyState', () => {
+        render(React.createElement(ChatbotConversationHistoryNav, { onDrawerToggle: onDrawerToggle, isDrawerOpen: true, displayMode: ChatbotDisplayMode.fullscreen, setIsDrawerOpen: jest.fn(), reverseButtonOrder: false, handleTextInputChange: jest.fn(), conversations: initialConversations, emptyState: EMPTY_STATE }));
+        expect(screen.getByRole('dialog', {
+            name: /Start a new chat Access timely assistance by starting a conversation with an AI model./i
+        })).toBeTruthy();
+    });
+    it('should accept no results state', () => {
+        render(React.createElement(ChatbotConversationHistoryNav, { onDrawerToggle: onDrawerToggle, isDrawerOpen: true, displayMode: ChatbotDisplayMode.fullscreen, setIsDrawerOpen: jest.fn(), reverseButtonOrder: false, handleTextInputChange: jest.fn(), conversations: initialConversations, noResultsState: NO_RESULTS }));
+        expect(screen.getByRole('dialog', {
+            name: /No results found Adjust your search query and try again. Check your spelling or try a more general term./i
+        })).toBeTruthy();
+    });
 });

package/dist/esm/Message/Message.d.ts

@@ -1,5 +1,5 @@
 import React, { ReactNode } from 'react';
-import { AlertProps, AvatarProps, LabelGroupProps } from '@patternfly/react-core';
+import { AlertProps, AvatarProps, ButtonProps, FormProps, LabelGroupProps } from '@patternfly/react-core';
 import { ActionProps } from '../ResponseActions/ResponseActions';
 import { SourcesCardProps } from '../SourcesCard';
 import { QuickStart, QuickstartAction } from './QuickStarts/types';
@@ -104,6 +104,22 @@ export interface MessageProps extends Omit<React.HTMLProps<HTMLDivElement>, 'rol
     openLinkInNewTab?: boolean;
     /** Optional inline error message that can be displayed in the message */
     error?: AlertProps;
+    /** Props for links */
+    linkProps?: ButtonProps;
+    /** Whether message is in edit mode */
+    isEditable?: boolean;
+    /** Placeholder for edit input */
+    editPlaceholder?: string;
+    /** Label for the English word "Update" used in edit mode. */
+    updateWord?: string;
+    /** Label for the English word "Cancel" used in edit mode. */
+    cancelWord?: string;
+    /** Callback function for when edit mode update button is clicked */
+    onEditUpdate?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
+    /** Callback functionf or when edit cancel update button is clicked */
+    onEditCancel?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
+    /** Props for edit form */
+    editFormProps?: FormProps;
 }
 export declare const MessageBase: React.FunctionComponent<MessageProps>;
 declare const Message: React.ForwardRefExoticComponent<Omit<MessageProps, "ref"> & React.RefAttributes<HTMLDivElement>>;

package/dist/esm/Message/Message.js

@@ -41,8 +41,13 @@ import rehypeExternalLinks from 'rehype-external-links';
 import rehypeSanitize from 'rehype-sanitize';
 import LinkMessage from './LinkMessage/LinkMessage';
 import ErrorMessage from './ErrorMessage/ErrorMessage';
+import MessageInput from './MessageInput';
 export const MessageBase = (_a) => {
-    var { role, content, extraContent, name, avatar, timestamp, isLoading, actions, sources, botWord = 'AI', loadingWord = 'Loading message', codeBlockProps, quickResponses, quickResponseContainerProps = { numLabels: 5 }, attachments, hasRoundAvatar = true, avatarProps, quickStarts, userFeedbackForm, userFeedbackComplete, isLiveRegion = true, innerRef, tableProps, openLinkInNewTab = true, additionalRehypePlugins = [], error } = _a, props = __rest(_a, ["role", "content", "extraContent", "name", "avatar", "timestamp", "isLoading", "actions", "sources", "botWord", "loadingWord", "codeBlockProps", "quickResponses", "quickResponseContainerProps", "attachments", "hasRoundAvatar", "avatarProps", "quickStarts", "userFeedbackForm", "userFeedbackComplete", "isLiveRegion", "innerRef", "tableProps", "openLinkInNewTab", "additionalRehypePlugins", "error"]);
+    var { role, content, extraContent, name, avatar, timestamp, isLoading, actions, sources, botWord = 'AI', loadingWord = 'Loading message', codeBlockProps, quickResponses, quickResponseContainerProps = { numLabels: 5 }, attachments, hasRoundAvatar = true, avatarProps, quickStarts, userFeedbackForm, userFeedbackComplete, isLiveRegion = true, innerRef, tableProps, openLinkInNewTab = true, additionalRehypePlugins = [], linkProps, error, isEditable, editPlaceholder = 'Edit prompt message...', updateWord = 'Update', cancelWord = 'Cancel', onEditUpdate, onEditCancel, editFormProps } = _a, props = __rest(_a, ["role", "content", "extraContent", "name", "avatar", "timestamp", "isLoading", "actions", "sources", "botWord", "loadingWord", "codeBlockProps", "quickResponses", "quickResponseContainerProps", "attachments", "hasRoundAvatar", "avatarProps", "quickStarts", "userFeedbackForm", "userFeedbackComplete", "isLiveRegion", "innerRef", "tableProps", "openLinkInNewTab", "additionalRehypePlugins", "linkProps", "error", "isEditable", "editPlaceholder", "updateWord", "cancelWord", "onEditUpdate", "onEditCancel", "editFormProps"]);
+    const [messageText, setMessageText] = React.useState(content);
+    React.useEffect(() => {
+        setMessageText(content);
+    }, [content]);
     const { beforeMainContent, afterMainContent, endContent } = extraContent || {};
     let rehypePlugins = [rehypeUnwrapImages];
     if (openLinkInNewTab) {
@@ -60,6 +65,51 @@ export const MessageBase = (_a) => {
     // Keep timestamps consistent between Timestamp component and aria-label
     const date = new Date();
     const dateString = timestamp !== null && timestamp !== void 0 ? timestamp : `${date.toLocaleDateString()} ${date.toLocaleTimeString()}`;
+    const renderMessage = () => {
+        if (isLoading) {
+            return React.createElement(MessageLoading, { loadingWord: loadingWord });
+        }
+        if (isEditable) {
+            return (React.createElement(React.Fragment, null,
+                beforeMainContent && React.createElement(React.Fragment, null, beforeMainContent),
+                React.createElement(MessageInput, Object.assign({ content: content, editPlaceholder: editPlaceholder, updateWord: updateWord, cancelWord: cancelWord, onEditUpdate: (event, text) => {
+                        onEditUpdate && onEditUpdate(event);
+                        setMessageText(text);
+                    }, onEditCancel: onEditCancel }, editFormProps))));
+        }
+        return (React.createElement(React.Fragment, null,
+            beforeMainContent && React.createElement(React.Fragment, null, beforeMainContent),
+            error ? (React.createElement(ErrorMessage, Object.assign({}, error))) : (React.createElement(Markdown, { components: {
+                    p: (props) => React.createElement(TextMessage, Object.assign({ component: ContentVariants.p }, props)),
+                    code: (_a) => {
+                        var { children } = _a, props = __rest(_a, ["children"]);
+                        return (React.createElement(CodeBlockMessage, Object.assign({}, props, codeBlockProps), children));
+                    },
+                    h1: (props) => React.createElement(TextMessage, Object.assign({ component: ContentVariants.h1 }, props)),
+                    h2: (props) => React.createElement(TextMessage, Object.assign({ component: ContentVariants.h2 }, props)),
+                    h3: (props) => React.createElement(TextMessage, Object.assign({ component: ContentVariants.h3 }, props)),
+                    h4: (props) => React.createElement(TextMessage, Object.assign({ component: ContentVariants.h4 }, props)),
+                    h5: (props) => React.createElement(TextMessage, Object.assign({ component: ContentVariants.h5 }, props)),
+                    h6: (props) => React.createElement(TextMessage, Object.assign({ component: ContentVariants.h6 }, props)),
+                    blockquote: (props) => React.createElement(TextMessage, Object.assign({ component: ContentVariants.blockquote }, props)),
+                    ul: (props) => React.createElement(UnorderedListMessage, Object.assign({}, props)),
+                    ol: (props) => React.createElement(OrderedListMessage, Object.assign({}, props)),
+                    li: (props) => React.createElement(ListItemMessage, Object.assign({}, props)),
+                    table: (props) => React.createElement(TableMessage, Object.assign({}, props, tableProps)),
+                    tbody: (props) => React.createElement(TbodyMessage, Object.assign({}, props)),
+                    thead: (props) => React.createElement(TheadMessage, Object.assign({}, props)),
+                    tr: (props) => React.createElement(TrMessage, Object.assign({}, props)),
+                    td: (props) => {
+                        // Conflicts with Td type
+                        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                        const { width } = props, rest = __rest(props, ["width"]);
+                        return React.createElement(TdMessage, Object.assign({}, rest));
+                    },
+                    th: (props) => React.createElement(ThMessage, Object.assign({}, props)),
+                    img: (props) => React.createElement(ImageMessage, Object.assign({}, props)),
+                    a: (props) => (React.createElement(LinkMessage, Object.assign({ href: props.href, rel: props.rel, target: props.target }, linkProps), props.children))
+                }, remarkPlugins: [remarkGfm], rehypePlugins: rehypePlugins }, messageText))));
+    };
     return (React.createElement("section", Object.assign({ "aria-label": `Message from ${role} - ${dateString}`, className: `pf-chatbot__message pf-chatbot__message--${role}`, "aria-live": isLiveRegion ? 'polite' : undefined, "aria-atomic": isLiveRegion ? false : undefined, ref: innerRef }, props),
         React.createElement(Avatar, Object.assign({ className: `pf-chatbot__message-avatar ${hasRoundAvatar ? 'pf-chatbot__message-avatar--round' : ''} ${avatarClassName ? avatarClassName : ''}`, src: avatar, alt: "" }, avatarProps)),
         React.createElement("div", { className: "pf-chatbot__message-contents" },
@@ -70,39 +120,8 @@ export const MessageBase = (_a) => {
                 React.createElement(Timestamp, { date: date }, timestamp)),
             React.createElement("div", { className: "pf-chatbot__message-response" },
                 React.createElement("div", { className: "pf-chatbot__message-and-actions" },
-                    isLoading ? (React.createElement(MessageLoading, { loadingWord: loadingWord })) : (React.createElement(React.Fragment, null,
-                        beforeMainContent && React.createElement(React.Fragment, null, beforeMainContent),
-                        error ? (React.createElement(ErrorMessage, Object.assign({}, error))) : (React.createElement(Markdown, { components: {
-                                p: (props) => React.createElement(TextMessage, Object.assign({ component: ContentVariants.p }, props)),
-                                code: (_a) => {
-                                    var { children } = _a, props = __rest(_a, ["children"]);
-                                    return (React.createElement(CodeBlockMessage, Object.assign({}, props, codeBlockProps), children));
-                                },
-                                h1: (props) => React.createElement(TextMessage, Object.assign({ component: ContentVariants.h1 }, props)),
-                                h2: (props) => React.createElement(TextMessage, Object.assign({ component: ContentVariants.h2 }, props)),
-                                h3: (props) => React.createElement(TextMessage, Object.assign({ component: ContentVariants.h3 }, props)),
-                                h4: (props) => React.createElement(TextMessage, Object.assign({ component: ContentVariants.h4 }, props)),
-                                h5: (props) => React.createElement(TextMessage, Object.assign({ component: ContentVariants.h5 }, props)),
-                                h6: (props) => React.createElement(TextMessage, Object.assign({ component: ContentVariants.h6 }, props)),
-                                blockquote: (props) => React.createElement(TextMessage, Object.assign({ component: ContentVariants.blockquote }, props)),
-                                ul: (props) => React.createElement(UnorderedListMessage, Object.assign({}, props)),
-                                ol: (props) => React.createElement(OrderedListMessage, Object.assign({}, props)),
-                                li: (props) => React.createElement(ListItemMessage, Object.assign({}, props)),
-                                table: (props) => React.createElement(TableMessage, Object.assign({}, props, tableProps)),
-                                tbody: (props) => React.createElement(TbodyMessage, Object.assign({}, props)),
-                                thead: (props) => React.createElement(TheadMessage, Object.assign({}, props)),
-                                tr: (props) => React.createElement(TrMessage, Object.assign({}, props)),
-                                td: (props) => {
-                                    // Conflicts with Td type
-                                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-                                    const { width } = props, rest = __rest(props, ["width"]);
-                                    return React.createElement(TdMessage, Object.assign({}, rest));
-                                },
-                                th: (props) => React.createElement(ThMessage, Object.assign({}, props)),
-                                img: (props) => React.createElement(ImageMessage, Object.assign({}, props)),
-                                a: (props) => (React.createElement(LinkMessage, { href: props.href, rel: props.rel, target: props.target }, props.children))
-                            }, remarkPlugins: [remarkGfm], rehypePlugins: rehypePlugins }, content)),
-                        afterMainContent && React.createElement(React.Fragment, null, afterMainContent))),
+                    renderMessage(),
+                    afterMainContent && React.createElement(React.Fragment, null, afterMainContent),
                     !isLoading && sources && React.createElement(SourcesCard, Object.assign({}, sources)),
                     quickStarts && quickStarts.quickStart && (React.createElement(QuickStartTile, { quickStart: quickStarts.quickStart, onSelectQuickStart: quickStarts.onSelectQuickStart, minuteWord: quickStarts.minuteWord, minuteWordPlural: quickStarts.minuteWordPlural, prerequisiteWord: quickStarts.prerequisiteWord, prerequisiteWordPlural: quickStarts.prerequisiteWordPlural, quickStartButtonAriaLabel: quickStarts.quickStartButtonAriaLabel })),
                     !isLoading && actions && React.createElement(ResponseActions, { actions: actions }),

package/dist/esm/Message/Message.test.js

@@ -597,6 +597,12 @@ describe('Message', () => {
         // we are mocking rehype libraries, so we can't test target _blank addition on links directly with RTL
         expect(rehypeExternalLinks).not.toHaveBeenCalled();
     });
+    it('should handle extra link props correctly', () => __awaiter(void 0, void 0, void 0, function* () {
+        const spy = jest.fn();
+        render(React.createElement(Message, { avatar: "./img", role: "user", name: "User", content: `[PatternFly](https://www.patternfly.org/)`, linkProps: { onClick: spy } }));
+        yield userEvent.click(screen.getByRole('link', { name: /PatternFly/i }));
+        expect(spy).toHaveBeenCalledTimes(1);
+    }));
     it('should handle error correctly', () => {
         render(React.createElement(Message, { avatar: "./img", role: "user", name: "User", error: ERROR }));
         expect(screen.getByRole('heading', { name: /Could not load chat/i })).toBeTruthy();
@@ -614,4 +620,50 @@ describe('Message', () => {
         expect(screen.getByRole('heading', { name: /Could not load chat/i })).toBeTruthy();
         expect(screen.queryByText('Test')).toBeFalsy();
     });
+    it('should handle isEditable when there is message content', () => {
+        render(React.createElement(Message, { avatar: "./img", role: "user", name: "User", isEditable: true, content: "Test" }));
+        expect(screen.getByRole('textbox')).toBeTruthy();
+        expect(screen.getByRole('textbox')).toHaveValue('Test');
+        expect(screen.getByRole('button', { name: /Update/i })).toBeTruthy();
+        expect(screen.getByRole('button', { name: /Cancel/i })).toBeTruthy();
+    });
+    it('should handle isEditable when there is no message content', () => {
+        render(React.createElement(Message, { avatar: "./img", role: "user", name: "User", isEditable: true }));
+        expect(screen.getByRole('textbox')).toBeTruthy();
+        expect(screen.getByRole('textbox')).toHaveValue('');
+        expect(screen.getByRole('textbox')).toHaveAttribute('placeholder', 'Edit prompt message...');
+        expect(screen.getByRole('button', { name: /Update/i })).toBeTruthy();
+        expect(screen.getByRole('button', { name: /Cancel/i })).toBeTruthy();
+    });
+    it('should be able to change edit placeholder', () => {
+        render(React.createElement(Message, { avatar: "./img", role: "user", name: "User", isEditable: true, editPlaceholder: "I am a placeholder" }));
+        expect(screen.getByRole('textbox')).toBeTruthy();
+        expect(screen.getByRole('textbox')).toHaveValue('');
+        expect(screen.getByRole('textbox')).toHaveAttribute('placeholder', 'I am a placeholder');
+    });
+    it('should be able to change updateWord', () => {
+        render(React.createElement(Message, { avatar: "./img", role: "user", name: "User", isEditable: true, updateWord: "Submit" }));
+        expect(screen.getByRole('button', { name: /Submit/i })).toBeTruthy();
+    });
+    it('should be able to change cancelWord', () => {
+        render(React.createElement(Message, { avatar: "./img", role: "user", name: "User", isEditable: true, cancelWord: "Don't submit" }));
+        expect(screen.getByRole('button', { name: /Don't submit/i })).toBeTruthy();
+    });
+    it('should be able to add onEditUpdate', () => __awaiter(void 0, void 0, void 0, function* () {
+        const spy = jest.fn();
+        render(React.createElement(Message, { avatar: "./img", role: "user", name: "User", isEditable: true, onEditUpdate: spy }));
+        yield userEvent.click(screen.getByRole('button', { name: /Update/i }));
+        expect(spy).toHaveBeenCalledTimes(1);
+    }));
+    it('should be able to add onEditCancel', () => __awaiter(void 0, void 0, void 0, function* () {
+        const spy = jest.fn();
+        render(React.createElement(Message, { avatar: "./img", role: "user", name: "User", isEditable: true, onEditCancel: spy }));
+        yield userEvent.click(screen.getByRole('button', { name: /Cancel/i }));
+        expect(spy).toHaveBeenCalledTimes(1);
+    }));
+    it('should be able to add  editFormProps', () => {
+        const { container } = render(React.createElement(Message, { avatar: "./img", role: "user", name: "User", isEditable: true, editFormProps: { className: 'test' } }));
+        const form = container.querySelector('form');
+        expect(form).toHaveClass('test');
+    });
 });

package/dist/esm/Message/MessageInput.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+import { FormProps } from '@patternfly/react-core';
+export interface MessageInputProps extends FormProps {
+    /** Placeholder for edit input */
+    editPlaceholder?: string;
+    /** Label for the English word "Update" used in edit mode. */
+    updateWord?: string;
+    /** Label for the English word "Cancel" used in edit mode. */
+    cancelWord?: string;
+    /** Callback function for when edit mode update button is clicked */
+    onEditUpdate?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>, value: string) => void;
+    /** Callback functionf or when edit cancel update button is clicked */
+    onEditCancel?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
+    /** Message text */
+    content?: string;
+}
+declare const MessageInput: React.FunctionComponent<MessageInputProps>;
+export default MessageInput;

package/dist/esm/Message/MessageInput.js

@@ -0,0 +1,29 @@
+// ============================================================================
+// Chatbot Main - Message Input
+// ============================================================================
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import React from 'react';
+import { ActionGroup, Button, Form, TextArea } from '@patternfly/react-core';
+const MessageInput = (_a) => {
+    var { editPlaceholder = 'Edit prompt message...', updateWord = 'Update', cancelWord = 'Cancel', onEditUpdate, onEditCancel, content } = _a, props = __rest(_a, ["editPlaceholder", "updateWord", "cancelWord", "onEditUpdate", "onEditCancel", "content"]);
+    const [messageText, setMessageText] = React.useState(content !== null && content !== void 0 ? content : '');
+    const onChange = (event, value) => {
+        setMessageText(value);
+    };
+    return (React.createElement(Form, Object.assign({}, props),
+        React.createElement(TextArea, { placeholder: editPlaceholder, value: messageText, onChange: onChange, "aria-label": editPlaceholder, autoResize: true }),
+        React.createElement(ActionGroup, { className: "pf-chatbot__message-edit-buttons" },
+            React.createElement(Button, { variant: "primary", onClick: (event) => onEditUpdate && onEditUpdate(event, messageText) }, updateWord),
+            React.createElement(Button, { variant: "secondary", onClick: onEditCancel }, cancelWord))));
+};
+export default MessageInput;

package/dist/esm/MessageBar/MicrophoneButton.js

@@ -58,7 +58,7 @@ export const MicrophoneButton = (_a) => {
             };
             setSpeechRecognition(recognition);
         }
-    }, [onSpeechRecognition]);
+    }, [onSpeechRecognition, language, onIsListeningChange]);
     if (!speechRecognition) {
         return null;
     }

package/dist/esm/MessageBox/MessageBox.js

@@ -23,26 +23,26 @@ const MessageBoxBase = ({ announcement, ariaLabel = 'Scrollable message log', ch
             setAtTop(scrollTop === 0);
             setAtBottom(Math.round(scrollTop) + Math.round(clientHeight) >= Math.round(scrollHeight) - 1); // rounding means it could be within a pixel of the bottom
         }
-    }, []);
+    }, [messageBoxRef]);
     const checkOverflow = React.useCallback(() => {
         const element = messageBoxRef.current;
         if (element) {
             const { scrollHeight, clientHeight } = element;
             setIsOverflowing(scrollHeight >= clientHeight);
         }
-    }, []);
+    }, [messageBoxRef]);
     const scrollToTop = React.useCallback(() => {
         const element = messageBoxRef.current;
         if (element) {
             element.scrollTo({ top: 0, behavior: 'smooth' });
         }
-    }, []);
+    }, [messageBoxRef]);
     const scrollToBottom = React.useCallback(() => {
         const element = messageBoxRef.current;
         if (element) {
             element.scrollTo({ top: element.scrollHeight, behavior: 'smooth' });
         }
-    }, []);
+    }, [messageBoxRef]);
     // Detect scroll position
     React.useEffect(() => {
         const element = messageBoxRef.current;
@@ -56,7 +56,7 @@ const MessageBoxBase = ({ announcement, ariaLabel = 'Scrollable message log', ch
                 element.removeEventListener('scroll', handleScroll);
             };
         }
-    }, [checkOverflow, handleScroll]);
+    }, [checkOverflow, handleScroll, messageBoxRef]);
     return (React.createElement(React.Fragment, null,
         React.createElement(JumpButton, { position: "top", isHidden: isOverflowing && atTop, onClick: scrollToTop }),
         React.createElement("div", { role: "region", tabIndex: 0, "aria-label": ariaLabel, className: `pf-chatbot__messagebox ${position === 'bottom' && 'pf-chatbot__messagebox--bottom'} ${className !== null && className !== void 0 ? className : ''}`, ref: innerRef !== null && innerRef !== void 0 ? innerRef : messageBoxRef },

package/dist/esm/SourcesCard/SourcesCard.d.ts

@@ -5,7 +5,7 @@ export interface SourcesCardProps extends CardProps {
     className?: string;
     /** Flag indicating if the pagination is disabled. */
     isDisabled?: boolean;
-    /** Label for the English word "of". */
+    /** @deprecated ofWord has been deprecated. Label for the English word "of." */
     ofWord?: string;
     /** Accessible label for the pagination component. */
     paginationAriaLabel?: string;
@@ -14,6 +14,8 @@ export interface SourcesCardProps extends CardProps {
         title?: string;
         link: string;
         body?: React.ReactNode | string;
+        isExternal?: boolean;
+        hasShowMore?: boolean;
     }[];
     /** Label for the English word "source" */
     sourceWord?: string;
@@ -29,6 +31,10 @@ export interface SourcesCardProps extends CardProps {
     onPreviousClick?: (event: React.SyntheticEvent<HTMLButtonElement>, page: number) => void;
     /** Function called when page is changed. */
     onSetPage?: (event: React.MouseEvent | React.KeyboardEvent | MouseEvent, newPage: number) => void;
+    /** Label for English words "show more" */
+    showMoreWords?: string;
+    /** Label for English words "show less" */
+    showLessWords?: string;
 }
 declare const SourcesCard: React.FunctionComponent<SourcesCardProps>;
 export default SourcesCard;

package/dist/esm/SourcesCard/SourcesCard.js

@@ -14,10 +14,15 @@ var __rest = (this && this.__rest) || function (s, e) {
 // ============================================================================
 import React from 'react';
 // Import PatternFly components
-import { Button, ButtonVariant, Card, CardBody, CardFooter, CardTitle, Icon, pluralize, Truncate } from '@patternfly/react-core';
+import { Button, ButtonVariant, Card, CardBody, CardFooter, CardTitle, ExpandableSection, ExpandableSectionVariant, Icon, pluralize, Truncate } from '@patternfly/react-core';
+import { ExternalLinkSquareAltIcon } from '@patternfly/react-icons';
 const SourcesCard = (_a) => {
-    var { className, isDisabled, ofWord = 'of', paginationAriaLabel = 'Pagination', sources, sourceWord = 'source', sourceWordPlural = 'sources', toNextPageAriaLabel = 'Go to next page', toPreviousPageAriaLabel = 'Go to previous page', onNextClick, onPreviousClick, onSetPage } = _a, props = __rest(_a, ["className", "isDisabled", "ofWord", "paginationAriaLabel", "sources", "sourceWord", "sourceWordPlural", "toNextPageAriaLabel", "toPreviousPageAriaLabel", "onNextClick", "onPreviousClick", "onSetPage"]);
+    var { className, isDisabled, paginationAriaLabel = 'Pagination', sources, sourceWord = 'source', sourceWordPlural = 'sources', toNextPageAriaLabel = 'Go to next page', toPreviousPageAriaLabel = 'Go to previous page', onNextClick, onPreviousClick, onSetPage, showMoreWords = 'show more', showLessWords = 'show less' } = _a, props = __rest(_a, ["className", "isDisabled", "paginationAriaLabel", "sources", "sourceWord", "sourceWordPlural", "toNextPageAriaLabel", "toPreviousPageAriaLabel", "onNextClick", "onPreviousClick", "onSetPage", "showMoreWords", "showLessWords"]);
     const [page, setPage] = React.useState(1);
+    const [isExpanded, setIsExpanded] = React.useState(false);
+    const onToggle = (_event, isExpanded) => {
+        setIsExpanded(isExpanded);
+    };
     const handleNewPage = (_evt, newPage) => {
         setPage(newPage);
         onSetPage && onSetPage(_evt, newPage);
@@ -32,8 +37,11 @@ const SourcesCard = (_a) => {
         React.createElement("span", null, pluralize(sources.length, sourceWord, sourceWordPlural)),
         React.createElement(Card, Object.assign({ className: "pf-chatbot__sources-card" }, props),
             React.createElement(CardTitle, { className: "pf-chatbot__sources-card-title" },
-                React.createElement("a", { href: sources[page - 1].link }, renderTitle(sources[page - 1].title))),
-            sources[page - 1].body && (React.createElement(CardBody, { className: `pf-chatbot__sources-card-body ${sources.length === 1 && 'pf-chatbot__sources-card-no-footer'}` }, sources[page - 1].body)),
+                React.createElement(Button, { component: "a", variant: ButtonVariant.link, href: sources[page - 1].link, icon: sources[page - 1].isExternal ? React.createElement(ExternalLinkSquareAltIcon, null) : undefined, iconPosition: "end", isInline: true, rel: sources[page - 1].isExternal ? 'noreferrer' : undefined, target: sources[page - 1].isExternal ? '_blank' : undefined }, renderTitle(sources[page - 1].title))),
+            sources[page - 1].body && (React.createElement(CardBody, { className: `pf-chatbot__sources-card-body` }, sources[page - 1].hasShowMore ? (
+            // prevents extra VO announcements of button text - parent Message has aria-live
+            React.createElement("div", { "aria-live": "off" },
+                React.createElement(ExpandableSection, { variant: ExpandableSectionVariant.truncate, toggleText: isExpanded ? showLessWords : showMoreWords, onToggle: onToggle, isExpanded: isExpanded, truncateMaxLines: 2 }, sources[page - 1].body))) : (React.createElement("div", { className: "pf-chatbot__sources-card-body-text" }, sources[page - 1].body)))),
             sources.length > 1 && (React.createElement(CardFooter, { className: "pf-chatbot__sources-card-footer-container" },
                 React.createElement("div", { className: "pf-chatbot__sources-card-footer" },
                     React.createElement("nav", { className: `pf-chatbot__sources-card-footer-buttons ${className}`, "aria-label": paginationAriaLabel },
@@ -45,6 +53,10 @@ const SourcesCard = (_a) => {
                             React.createElement(Icon, { iconSize: "lg" },
                                 React.createElement("svg", { className: "pf-v6-svg", viewBox: "0 0 280 500", fill: "currentColor", "aria-hidden": "true", role: "img", width: "1em", height: "1em" },
                                     React.createElement("path", { d: "M31.7 239l136-136c9.4-9.4 24.6-9.4 33.9 0l22.6 22.6c9.4 9.4 9.4 24.6 0 33.9L127.9 256l96.4 96.4c9.4 9.4 9.4 24.6 0 33.9L201.7 409c-9.4 9.4-24.6 9.4-33.9 0l-136-136c-9.5-9.4-9.5-24.6-.1-34z" })))),
+                        React.createElement("span", { "aria-hidden": "true" },
+                            page,
+                            "/",
+                            sources.length),
                         React.createElement(Button, { variant: ButtonVariant.plain, isDisabled: isDisabled || page === sources.length, "aria-label": toNextPageAriaLabel, "data-action": "next", onClick: (event) => {
                                 const newPage = page + 1 <= sources.length ? page + 1 : sources.length;
                                 onNextClick && onNextClick(event, newPage);
@@ -52,12 +64,6 @@ const SourcesCard = (_a) => {
                             } },
                             React.createElement(Icon, { isInline: true, iconSize: "lg" },
                                 React.createElement("svg", { className: "pf-v6-svg", viewBox: "0 0 180 500", fill: "currentColor", "aria-hidden": "true", role: "img", width: "1em", height: "1em" },
-                                    React.createElement("path", { d: "M224.3 273l-136 136c-9.4 9.4-24.6 9.4-33.9 0l-22.6-22.6c-9.4-9.4-9.4-24.6 0-33.9l96.4-96.4-96.4-96.4c-9.4-9.4-9.4-24.6 0-33.9L54.3 103c9.4-9.4 24.6-9.4 33.9 0l136 136c9.5 9.4 9.5 24.6.1 34z" }))))),
-                    React.createElement("span", { "aria-hidden": "true" },
-                        page,
-                        " ",
-                        ofWord,
-                        " ",
-                        sources.length)))))));
+                                    React.createElement("path", { d: "M224.3 273l-136 136c-9.4 9.4-24.6 9.4-33.9 0l-22.6-22.6c-9.4-9.4-9.4-24.6 0-33.9l96.4-96.4-96.4-96.4c-9.4-9.4-9.4-24.6 0-33.9L54.3 103c9.4-9.4 24.6-9.4 33.9 0l136 136c9.5 9.4 9.5 24.6.1 34z" })))))))))));
 };
 export default SourcesCard;

package/dist/esm/SourcesCard/SourcesCard.test.js

@@ -13,17 +13,13 @@ import userEvent from '@testing-library/user-event';
 import '@testing-library/jest-dom';
 import SourcesCard from './SourcesCard';
 describe('SourcesCard', () => {
-    it('should render card', () => {
-        const { container } = render(React.createElement(SourcesCard, { sources: [{ link: '' }] }));
-        expect(container).toMatchSnapshot();
-    });
     it('should render card correctly if one source with only a link is passed in', () => {
         render(React.createElement(SourcesCard, { sources: [{ link: '' }] }));
         expect(screen.getByText('1 source')).toBeTruthy();
         expect(screen.getByText('Source 1')).toBeTruthy();
         // no buttons or navigation when there is only 1 source
         expect(screen.queryByRole('button')).toBeFalsy();
-        expect(screen.queryByText('1 of 1')).toBeFalsy();
+        expect(screen.queryByText('1/1')).toBeFalsy();
     });
     it('should render card correctly if one source with a title is passed in', () => {
         render(React.createElement(SourcesCard, { sources: [{ title: 'How to make an apple pie', link: '' }] }));
@@ -48,7 +44,7 @@ describe('SourcesCard', () => {
             ] }));
         expect(screen.getByText('2 sources')).toBeTruthy();
         expect(screen.getByText('How to make an apple pie')).toBeTruthy();
-        expect(screen.getByText('1 of 2')).toBeTruthy();
+        expect(screen.getByText('1/2')).toBeTruthy();
         screen.getByRole('button', { name: /Go to previous page/i });
         screen.getByRole('button', { name: /Go to next page/i });
     });
@@ -58,12 +54,12 @@ describe('SourcesCard', () => {
                 { title: 'How to make cookies', link: '' }
             ] }));
         expect(screen.getByText('How to make an apple pie')).toBeTruthy();
-        expect(screen.getByText('1 of 2')).toBeTruthy();
+        expect(screen.getByText('1/2')).toBeTruthy();
         expect(screen.getByRole('button', { name: /Go to previous page/i })).toBeDisabled();
         yield userEvent.click(screen.getByRole('button', { name: /Go to next page/i }));
         expect(screen.queryByText('How to make an apple pie')).toBeFalsy();
         expect(screen.getByText('How to make cookies')).toBeTruthy();
-        expect(screen.getByText('2 of 2')).toBeTruthy();
+        expect(screen.getByText('2/2')).toBeTruthy();
         expect(screen.getByRole('button', { name: /Go to previous page/i })).toBeEnabled();
         expect(screen.getByRole('button', { name: /Go to next page/i })).toBeDisabled();
     }));
@@ -83,13 +79,6 @@ describe('SourcesCard', () => {
         expect(screen.getByRole('button', { name: /Go to previous page/i })).toBeDisabled();
         expect(screen.getByRole('button', { name: /Go to next page/i })).toBeDisabled();
     });
-    it('should change ofWord appropriately', () => {
-        render(React.createElement(SourcesCard, { sources: [
-                { title: 'How to make an apple pie', link: '' },
-                { title: 'How to make cookies', link: '' }
-            ], ofWord: 'de' }));
-        expect(screen.getByText('1 de 2')).toBeTruthy();
-    });
     it('should render navigation aria label appropriately', () => {
         render(React.createElement(SourcesCard, { sources: [
                 { title: 'How to make an apple pie', link: '' },
@@ -159,4 +148,25 @@ describe('SourcesCard', () => {
         yield userEvent.click(screen.getByRole('button', { name: /Go to previous page/i }));
         expect(spy).toHaveBeenCalledTimes(2);
     }));
+    it('should handle showMore appropriately', () => __awaiter(void 0, void 0, void 0, function* () {
+        render(React.createElement(SourcesCard, { sources: [
+                {
+                    title: 'Getting started with Red Hat OpenShift',
+                    link: '#',
+                    body: 'Red Hat OpenShift on IBM Cloud is a managed offering to create your own cluster of compute hosts where you can deploy and manage containerized apps on IBM Cloud ...',
+                    hasShowMore: true
+                },
+                {
+                    title: 'Azure Red Hat OpenShift documentation',
+                    link: '#',
+                    body: 'Microsoft Azure Red Hat OpenShift allows you to deploy a production ready Red Hat OpenShift cluster in Azure ...'
+                },
+                {
+                    title: 'OKD Documentation: Home',
+                    link: '#',
+                    body: 'OKD is a distribution of Kubernetes optimized for continuous application development and multi-tenant deployment. OKD also serves as the upstream code base upon ...'
+                }
+            ] }));
+        expect(screen.getByRole('region')).toHaveAttribute('class', 'pf-v6-c-expandable-section__content');
+    }));
 });

package/dist/esm/tracking/console_tracking_provider.d.ts

@@ -1,10 +1,9 @@
-import { TrackingSpi } from './tracking_spi';
+import { InitProps, TrackingSpi } from './tracking_spi';
 import { TrackingApi, TrackingEventProperties } from './tracking_api';
 export declare class ConsoleTrackingProvider implements TrackingSpi, TrackingApi {
+    private verbose;
     trackPageView(url: string | undefined): void;
-    registerProvider(): void;
-    initialize(): void;
-    identify(userID: string): void;
+    initialize(props: InitProps): void;
+    identify(userID: string, userProperties?: TrackingEventProperties): void;
     trackSingleItem(item: string, properties?: TrackingEventProperties): void;
-    getKey(): string;
 }

package/dist/esm/tracking/console_tracking_provider.js

@@ -1,23 +1,30 @@
 export class ConsoleTrackingProvider {
+    constructor() {
+        this.verbose = false;
+    }
     trackPageView(url) {
-        // eslint-disable-next-line no-console
-        console.log('ConsoleProvider pageView', url);
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('ConsoleProvider pageView ', url);
+        }
     }
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    registerProvider() { }
-    initialize() {
-        // eslint-disable-next-line no-console
-        console.log('ConsoleProvider initialize');
+    initialize(props) {
+        this.verbose = props.verbose;
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('ConsoleProvider initialize');
+        }
     }
-    identify(userID) {
-        // eslint-disable-next-line no-console
-        console.log('ConsoleProvider identify', userID);
+    identify(userID, userProperties = {}) {
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('ConsoleProvider identify ', userID, userProperties);
+        }
     }
     trackSingleItem(item, properties) {
-        // eslint-disable-next-line no-console
-        console.log('ConsoleProvider: ' + item, properties);
-    }
-    getKey() {
-        return 'console';
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('ConsoleProvider: ' + item, properties);
+        }
     }
 }

package/dist/esm/tracking/posthog_tracking_provider.d.ts

@@ -1,9 +1,9 @@
 import { TrackingApi, TrackingEventProperties } from './tracking_api';
 import { InitProps, TrackingSpi } from './tracking_spi';
 export declare class PosthogTrackingProvider implements TrackingSpi, TrackingApi {
-    getKey(): string;
+    private verbose;
     initialize(props: InitProps): void;
-    identify(userID: string): void;
+    identify(userID: string, userProperties?: TrackingEventProperties): void;
     trackPageView(url: string | undefined): void;
     trackSingleItem(item: string, properties?: TrackingEventProperties): void;
 }