@mintlify/common 1.0.1299 → 1.0.1301

package/dist/mdx/getMDXOptions.js

@@ -5,6 +5,7 @@ import { remarkMdxExpandExpressions, } from './plugins/remark/remarkMdxExpandExp
 import { remarkMdxPageStyles } from './plugins/remark/remarkMdxPageStyles.js';
 import { remarkMdxDetectJs } from './plugins/remark/remarkMdxRemoveJs.js';
 import { remarkMdxRemoveUnknownJsx } from './plugins/remark/remarkMdxRemoveUnknownJsx/index.js';
+import { remarkMdxRemoveUnsafeSmil } from './plugins/remark/remarkMdxRemoveUnsafeSmil.js';
 import { remarkMermaid } from './plugins/remark/remarkMermaid.js';
 import { remarkNoCopyLanguage } from './plugins/remark/remarkNoCopyLanguage.js';
 import { remarkParseTitleMarkdown, remarkRenderTitleMarkdown, } from './plugins/remark/remarkTitleMarkdown.js';
@@ -70,6 +71,7 @@ export const getMDXOptions = ({ data, remarkPlugins = [], earlyRemarkPlugins = [
             ...remarkPlugins,
             remarkRenderTitleMarkdown,
             remarkMapExplicitAnchors,
+            remarkMdxRemoveUnsafeSmil,
             [
                 remarkMdxRemoveUnknownJsx,
                 { allowlist: ['style', ...allowedComponents, ...knownComponents] },

package/dist/mdx/plugins/remark/index.d.ts

@@ -6,6 +6,7 @@ export * from './remarkRemoveImports.js';
 export * from './remarkExtractTableOfContents.js';
 export * from './remarkMdxRemoveUnusedVariables.js';
 export * from './remarkMdxRemoveUnknownJsx/index.js';
+export * from './remarkMdxRemoveUnsafeSmil.js';
 export * from './remarkMdxExpandExpressions.js';
 export * from './remarkMdxClientComponentBoundaries.js';
 export * from './remarkMermaid.js';

package/dist/mdx/plugins/remark/index.js

@@ -6,6 +6,7 @@ export * from './remarkRemoveImports.js';
 export * from './remarkExtractTableOfContents.js';
 export * from './remarkMdxRemoveUnusedVariables.js';
 export * from './remarkMdxRemoveUnknownJsx/index.js';
+export * from './remarkMdxRemoveUnsafeSmil.js';
 export * from './remarkMdxExpandExpressions.js';
 export * from './remarkMdxClientComponentBoundaries.js';
 export * from './remarkMermaid.js';

package/dist/mdx/plugins/remark/remarkMdxRemoveUnsafeSmil.d.ts

@@ -0,0 +1,7 @@
+import type { Root } from 'mdast';
+import type { MdxJsxFlowElement, MdxJsxTextElement } from 'mdast-util-mdx-jsx';
+type JsxElement = MdxJsxFlowElement | MdxJsxTextElement;
+type SmilCandidate = Partial<Pick<JsxElement, 'name' | 'attributes'>>;
+export declare const isUnsafeSmilElement: ({ name, attributes }: SmilCandidate) => boolean;
+export declare const remarkMdxRemoveUnsafeSmil: () => (tree: Root) => void;
+export {};

package/dist/mdx/plugins/remark/remarkMdxRemoveUnsafeSmil.js

@@ -0,0 +1,34 @@
+import { remove } from 'unist-util-remove';
+import { isMdxJsxElement, SMIL_ELEMENT_NAMES } from '../../utils.js';
+const SMIL_ELEMENTS = new Set(SMIL_ELEMENT_NAMES.map((name) => name.toLowerCase()));
+const ANIMATION_VALUE_ATTRIBUTES = new Set(['values', 'from', 'to', 'by']);
+const REFERENCE_ATTRIBUTES = new Set(['href', 'xlink:href', 'xlinkhref']);
+const SCRIPTABLE_TARGETS = new Set(['href', 'xlinkhref', 'src', 'style']);
+const SCRIPTABLE_URL = /(?:javascript|vbscript|data):/;
+const normalize = (value) => Array.from(value)
+    .filter((character) => character > ' ')
+    .join('')
+    .toLowerCase();
+const targetsScriptableAttribute = (attributeName) => {
+    const localName = attributeName.slice(attributeName.lastIndexOf(':') + 1);
+    return SCRIPTABLE_TARGETS.has(localName) || localName.startsWith('on');
+};
+function isSafeSmilAttribute(attribute) {
+    if (attribute.type === 'mdxJsxExpressionAttribute')
+        return false;
+    const name = attribute.name.toLowerCase();
+    if (name.startsWith('on'))
+        return false;
+    if (typeof attribute.value !== 'string')
+        return attribute.value == null;
+    const value = normalize(attribute.value);
+    if (name === 'attributename')
+        return !targetsScriptableAttribute(value);
+    if (REFERENCE_ATTRIBUTES.has(name))
+        return value.startsWith('#');
+    return !ANIMATION_VALUE_ATTRIBUTES.has(name) || !SCRIPTABLE_URL.test(value);
+}
+export const isUnsafeSmilElement = ({ name, attributes = [] }) => name != null && SMIL_ELEMENTS.has(name.toLowerCase()) && !attributes.every(isSafeSmilAttribute);
+export const remarkMdxRemoveUnsafeSmil = () => (tree) => {
+    remove(tree, { cascade: false }, (node) => isMdxJsxElement(node) && isUnsafeSmilElement(node));
+};

package/dist/mdx/utils.d.ts

@@ -3,6 +3,7 @@ import { MdxFlowExpression, MdxjsEsm, MdxJsxAttribute, MdxJsxExpressionAttribute
 import type { MdxJsxFlowElement, MdxJsxTextElement } from 'mdast-util-mdx-jsx';
 import type { Node } from 'unist';
 import type { MdxNodeBodyChildType } from '../types/mdx/index.js';
+export declare const SMIL_ELEMENT_NAMES: readonly ["animate", "animateMotion", "animateTransform", "mpath", "set"];
 export declare const isMdxJsEsm: (node: Node) => node is MdxjsEsm;
 export declare const isMdxExpression: (node: Node) => node is MdxFlowExpression | MdxTextExpression;
 export declare function estreeIsProgram<T extends MdxFlowExpression | MdxTextExpression | MdxjsEsm>(node: T): node is T & {

package/dist/mdx/utils.js

@@ -1,3 +1,10 @@
+export const SMIL_ELEMENT_NAMES = [
+    'animate',
+    'animateMotion',
+    'animateTransform',
+    'mpath',
+    'set',
+];
 export const isMdxJsEsm = (node) => node.type === 'mdxjsEsm';
 export const isMdxExpression = (node) => node.type === 'mdxFlowExpression' || node.type === 'mdxTextExpression';
 export function estreeIsProgram(node) {
@@ -142,6 +149,7 @@ export const allowedComponents = [
     'sup',
     'u',
     'svg',
+    ...SMIL_ELEMENT_NAMES,
     'table',
     'tbody',
     'td',

package/dist/navigation/filterDivisions.js

@@ -291,13 +291,17 @@ function buildDivisionItem(param) {
     const divisionItem = Object.fromEntries(Object.entries(item).filter(([key]) => !keysToDrop.includes(key)));
     // if href is absolute url, use it, otherwise use the href from the first page
     if (!href) {
-        const isUserDefinedHref = 'href' in item && isAbsoluteUrl(item.href);
+        const userHref = 'href' in item ? item.href : undefined;
+        const hasChildNav = divisionKey === 'languages' || keysToDrop.some((key) => key in item);
+        const isUserDefinedHref = !!userHref &&
+            (isAbsoluteUrl(userHref) ||
+                (!hasChildNav && userHref.startsWith('/') && !userHref.startsWith('//')));
         if (!isUserDefinedHref && divisionKey === 'dropdowns' && !isActive && currentPath) {
             href =
                 (_c = (_b = findCorrespondingDropdownHref(item, currentPath, userGroups !== null && userGroups !== void 0 ? userGroups : new Set(), isPreview)) !== null && _b !== void 0 ? _b : findSamePageInDropdownVersion(page === null || page === void 0 ? void 0 : page.href, findDivisionName(item), currentPath, rootNav, userGroups !== null && userGroups !== void 0 ? userGroups : new Set(), isPreview)) !== null && _c !== void 0 ? _c : '';
         }
         if (!href) {
-            href = isUserDefinedHref ? item.href : (page === null || page === void 0 ? void 0 : page.href) || '/';
+            href = isUserDefinedHref ? userHref : (page === null || page === void 0 ? void 0 : page.href) || '/';
             // when users switch languages, we should stay on the same page
             // instead of switching to the first page in the new language
             if (!isUserDefinedHref && divisionKey === 'languages') {

package/dist/navigation/filterDivisions.test.js

@@ -970,3 +970,78 @@ describe('filterDivisions dropdown corresponding pages', () => {
         });
     });
 });
+describe('filterDivisions root-relative division hrefs', () => {
+    const defaultArgs = {
+        decoratedNav: { groups: [] },
+        currentPath: '/guides/intro',
+        userGroups: new Set(),
+        currentVersion: '',
+        currentLanguage: undefined,
+        shouldUseDivisionMatch: true,
+        cache: {
+            dropdownCache: new Map(),
+        },
+    };
+    const guidesGroups = [{ group: 'Start', pages: [{ title: 'Intro', href: '/guides/intro' }] }];
+    const platformGroups = [
+        { group: 'Platform', pages: [{ title: 'Analytics', href: '/platform/analytics' }] },
+    ];
+    it.each(['tabs', 'anchors', 'dropdowns'])('uses a root-relative href on %s without child navigation', (key) => {
+        var _a;
+        const divisionName = { tabs: 'tab', anchors: 'anchor', dropdowns: 'dropdown' }[key];
+        const result = filterDivisions(Object.assign(Object.assign({}, defaultArgs), { decoratedNav: {
+                [key]: [
+                    { [divisionName]: 'Guides', groups: guidesGroups },
+                    { [divisionName]: 'Analytics', href: '/platform/analytics' },
+                ],
+            } }));
+        expect((_a = result[key].find((d) => d.name === 'Analytics')) === null || _a === void 0 ? void 0 : _a.href).toBe('/platform/analytics');
+    });
+    it('uses a root-relative href on a menu item without child navigation', () => {
+        var _a, _b;
+        const result = filterDivisions(Object.assign(Object.assign({}, defaultArgs), { decoratedNav: {
+                tabs: [
+                    {
+                        tab: 'Guides',
+                        menu: [
+                            { item: 'Intro', groups: guidesGroups },
+                            { item: 'Analytics', href: '/platform/analytics' },
+                        ],
+                    },
+                    { tab: 'Platform', groups: platformGroups },
+                ],
+            } }));
+        const menu = (_a = result.tabs.find((t) => t.name === 'Guides')) === null || _a === void 0 ? void 0 : _a.menu;
+        expect((_b = menu === null || menu === void 0 ? void 0 : menu.find((m) => m.name === 'Analytics')) === null || _b === void 0 ? void 0 : _b.href).toBe('/platform/analytics');
+    });
+    it('keeps the first page href when the division also has child navigation', () => {
+        var _a;
+        const result = filterDivisions(Object.assign(Object.assign({}, defaultArgs), { decoratedNav: {
+                tabs: [
+                    { tab: 'Guides', groups: guidesGroups },
+                    { tab: 'Platform', href: '/elsewhere', groups: platformGroups },
+                ],
+            } }));
+        expect((_a = result.tabs.find((t) => t.name === 'Platform')) === null || _a === void 0 ? void 0 : _a.href).toBe('/platform/analytics');
+    });
+    it('leaves language hrefs on the current page', () => {
+        var _a;
+        const result = filterDivisions(Object.assign(Object.assign({}, defaultArgs), { decoratedNav: {
+                languages: [
+                    { language: 'en', groups: guidesGroups },
+                    { language: 'fr', href: '/fr/guides/intro' },
+                ],
+            } }));
+        expect((_a = result.languages.find((l) => l.language === 'fr')) === null || _a === void 0 ? void 0 : _a.href).toBe('');
+    });
+    it('does not treat protocol-relative hrefs as internal', () => {
+        var _a;
+        const result = filterDivisions(Object.assign(Object.assign({}, defaultArgs), { decoratedNav: {
+                tabs: [
+                    { tab: 'Guides', groups: guidesGroups },
+                    { tab: 'Other', href: '//evil.example.com' },
+                ],
+            } }));
+        expect((_a = result.tabs.find((t) => t.name === 'Other')) === null || _a === void 0 ? void 0 : _a.href).toBe('/');
+    });
+});