@patternfly/quickstarts 5.4.1 → 5.4.2

package/dist/index.js

@@ -14,7 +14,7 @@ var server = require('react-dom/server');
 var CopyIcon = require('@patternfly/react-icons/dist/js/icons/copy-icon');
 var LightbulbIcon = require('@patternfly/react-icons/dist/js/icons/lightbulb-icon');
 var FireIcon = require('@patternfly/react-icons/dist/js/icons/fire-icon');
-var showdown = require('showdown');
+var marked = require('marked');
 var SyncAltIcon = require('@patternfly/react-icons/dist/js/icons/sync-alt-icon');
 var CheckCircleIcon = require('@patternfly/react-icons/dist/js/icons/check-circle-icon');
 var ExclamationCircleIcon = require('@patternfly/react-icons/dist/js/icons/exclamation-circle-icon');
@@ -1320,16 +1320,7 @@ const useMultilineCopyClipboardShowdownExtension = () => {
 
 // eslint-disable-next-line @typescript-eslint/no-require-imports
 const DOMPurify = require('dompurify');
-const markdownConvert = (markdown, extensions) => {
-    const converter = new showdown.Converter({
-        tables: true,
-        openLinksInNewWindow: true,
-        strikethrough: true,
-        emoji: false,
-    });
-    if (extensions) {
-        converter.addExtension(extensions);
-    }
+const markdownConvert = (markdown, extensions) => tslib.__awaiter(void 0, void 0, void 0, function* () {
     DOMPurify.addHook('beforeSanitizeElements', function (node) {
         // nodeType 1 = element type
         // transform anchor tags
@@ -1356,16 +1347,36 @@ const markdownConvert = (markdown, extensions) => {
             node.setAttribute('xlink:show', 'new');
         }
     });
-    return DOMPurify.sanitize(converter.makeHtml(markdown), {
-        USE_PROFILES: {
-            html: true,
-            svg: true,
-        },
-    });
-};
+    // Replace code fences with non markdown formatting relates tokens so that marked doesn't try to parse them as code spans
+    const markdownWithSubstitutedCodeFences = markdown.replace(/```/g, '@@@');
+    const parsedMarkdown = yield marked.marked.parse(markdownWithSubstitutedCodeFences);
+    // Swap the temporary tokens back to code fences before we run the extensions
+    let md = parsedMarkdown.replace(/@@@/g, '```');
+    if (extensions) {
+        // Convert code spans back to md format before we run the custom extension regexes
+        md = md.replace(/<code>(.*)<\/code>/g, '`$1`');
+        extensions.forEach(({ regex, replace }) => {
+            if (regex) {
+                md = md.replace(regex, replace);
+            }
+        });
+        // Convert any remaining backticks back into code spans
+        md = md.replace(/`(.*)`/g, '<code>$1</code>');
+    }
+    return DOMPurify.sanitize(md);
+});
 const SyncMarkdownView = ({ content, emptyMsg, extensions, renderExtension, exactHeight, inline, className, }) => {
     const { getResource } = React__namespace.useContext(QuickStartContext);
-    const markup = React__namespace.useMemo(() => markdownConvert(content || emptyMsg || getResource('Not available'), extensions), [content, emptyMsg, extensions, getResource]);
+    const [markup, setMarkup] = React__namespace.useState('');
+    React__namespace.useEffect(() => {
+        function getMd() {
+            return tslib.__awaiter(this, void 0, void 0, function* () {
+                const md = yield markdownConvert(content || emptyMsg || getResource('Not available'), extensions);
+                setMarkup(md);
+            });
+        }
+        getMd();
+    }, [content, emptyMsg, getResource, extensions]);
     const innerProps = {
         renderExtension: (extensions === null || extensions === void 0 ? void 0 : extensions.length) > 0 ? renderExtension : undefined,
         exactHeight,
@@ -2030,12 +2041,22 @@ const TaskIcon = ({ taskIndex, taskStatus }) => {
 const QuickStartTaskHeader = ({ title, taskIndex, subtitle, taskStatus, size, isActiveTask, onTaskSelect, children, }) => {
     const titleRef = React__namespace.useRef(null);
     const { focusOnQuickStart } = React__namespace.useContext(QuickStartContext);
+    const [parsedTitle, setParsedTitle] = React__namespace.useState('');
     React__namespace.useEffect(() => {
         if (focusOnQuickStart && isActiveTask) {
             // Focus the WizardNavItem button element that contains the title
             titleRef.current.parentNode.focus();
         }
     }, [focusOnQuickStart, isActiveTask]);
+    React__namespace.useEffect(() => {
+        function getParsedTitle() {
+            return tslib.__awaiter(this, void 0, void 0, function* () {
+                const convertedMdTitle = yield markdownConvert(title);
+                setParsedTitle(removeParagraphWrap(convertedMdTitle));
+            });
+        }
+        getParsedTitle();
+    }, [title]);
     const classNames = reactStyles.css('pfext-quick-start-task-header__title', {
         'pfext-quick-start-task-header__title-success': taskStatus === exports.QuickStartTaskStatus.SUCCESS,
         'pfext-quick-start-task-header__title-failed': taskStatus === (exports.QuickStartTaskStatus.FAILED || exports.QuickStartTaskStatus.VISITED),
@@ -2051,7 +2072,7 @@ const QuickStartTaskHeader = ({ title, taskIndex, subtitle, taskStatus, size, is
     const content = (React__namespace.createElement("div", { className: "pfext-quick-start-task-header", ref: titleRef },
         React__namespace.createElement(TaskIcon, { taskIndex: taskIndex, taskStatus: taskStatus }),
         React__namespace.createElement(reactCore.Title, { headingLevel: "h3", size: size, className: classNames },
-            React__namespace.createElement("span", { dangerouslySetInnerHTML: { __html: removeParagraphWrap(markdownConvert(title)) } }),
+            React__namespace.createElement("span", { dangerouslySetInnerHTML: { __html: parsedTitle } }),
             isActiveTask && subtitle && (React__namespace.createElement("span", { className: "pfext-quick-start-task-header__subtitle", "data-test-id": "quick-start-task-subtitle" },
                 ' ',
                 subtitle))),
@@ -2248,6 +2269,7 @@ const QuickStartPanelContent = (_a) => {
     const titleRef = React__namespace.useRef(null);
     const { getResource, activeQuickStartState, focusOnQuickStart } = React__namespace.useContext(QuickStartContext);
     const [contentRef, setContentRef] = React__namespace.useState();
+    const [displayName, setDisplayName] = React__namespace.useState('');
     const shadows = useScrollShadows(contentRef);
     const quickStart = quickStarts.find((qs) => qs.metadata.name === activeQuickStartID);
     const taskNumber = activeQuickStartState === null || activeQuickStartState === void 0 ? void 0 : activeQuickStartState.taskNumber;
@@ -2275,13 +2297,22 @@ const QuickStartPanelContent = (_a) => {
             titleRef.current.focus();
         }
     }, [focusOnQuickStart, quickStart]);
+    React__namespace.useEffect(() => {
+        function getDisplayName() {
+            return tslib.__awaiter(this, void 0, void 0, function* () {
+                const convertedMdDisplayName = yield markdownConvert(quickStart === null || quickStart === void 0 ? void 0 : quickStart.spec.displayName);
+                setDisplayName(removeParagraphWrap(convertedMdDisplayName));
+            });
+        }
+        getDisplayName();
+    }, [quickStart]);
     const content = quickStart ? (React__namespace.createElement(reactCore.DrawerPanelContent, Object.assign({ isResizable: isResizable, className: "pfext-quick-start__base", "data-testid": `qs-drawer-${camelize(quickStart.spec.displayName)}`, "data-qs": `qs-step-${getStep()}`, "data-test": "quickstart drawer" }, props),
         React__namespace.createElement("div", { className: headerClasses },
             React__namespace.createElement(reactCore.DrawerHead, null,
                 React__namespace.createElement("div", { className: "pfext-quick-start-panel-content__title", tabIndex: -1, ref: titleRef },
                     React__namespace.createElement(reactCore.Title, { headingLevel: "h2", size: "xl", className: "pfext-quick-start-panel-content__name", style: { marginRight: 'var(--pf-v5-global--spacer--md)' } },
                         React__namespace.createElement("span", { dangerouslySetInnerHTML: {
-                                __html: removeParagraphWrap(markdownConvert(quickStart === null || quickStart === void 0 ? void 0 : quickStart.spec.displayName)),
+                                __html: displayName,
                             } }),
                         ' ',
                         React__namespace.createElement("small", { className: "pfext-quick-start-panel-content__duration" }, (quickStart === null || quickStart === void 0 ? void 0 : quickStart.spec.durationMinutes)