@mintlify/common 1.0.1076 → 1.0.1078

package/dist/navigation/filterDivisions.js

@@ -7,7 +7,7 @@ import { isEqualIgnoringLeadingSlash } from '../paths/isEqualIgnoringLeadingSlas
 import { checkNavAccess } from './checkNavAccess.js';
 import { getFirstPageFromNavigation } from './getFirstPageFromNavigation.js';
 import { isPage } from './isPage.js';
-import { updateFirstHrefInDivision } from './updateFirstHrefInDivision.js';
+import { pathsDifferByOneSegment, updateFirstHrefInDivision, } from './updateFirstHrefInDivision.js';
 const DIVISION_NAME_MAP = {
     tabs: 'tab',
     anchors: 'anchor',
@@ -155,6 +155,7 @@ export const filterDivisions = ({ currentPath, currentVersion, currentLanguage,
                             item,
                             isActive,
                             cache,
+                            currentPath,
                             currentVersion,
                             currentLanguage,
                             userGroups,
@@ -260,8 +261,8 @@ function upsertGlobalDivisions(navigationDivisions, globalConfig) {
     });
 }
 function buildDivisionItem(param) {
-    var _a;
-    const { item, isActive, cache, currentVersion, currentLanguage, userGroups, divisionKey, menuDivision, isPreview = false, parentDivisionNames = [], } = param;
+    var _a, _b;
+    const { item, isActive, cache, currentPath, currentVersion, currentLanguage, userGroups, divisionKey, menuDivision, isPreview = false, parentDivisionNames = [], } = param;
     const { dropdownCache } = cache;
     let href = '';
     // TODO: support this for other divisions (versions, languages, etc.)
@@ -282,11 +283,17 @@ function buildDivisionItem(param) {
     // 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);
-        href = isUserDefinedHref ? item.href : (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') {
-            href = '';
+        if (!isUserDefinedHref && divisionKey === 'dropdowns' && !isActive && currentPath) {
+            href =
+                (_b = findCorrespondingDropdownHref(item, currentPath, userGroups !== null && userGroups !== void 0 ? userGroups : new Set(), isPreview)) !== null && _b !== void 0 ? _b : '';
+        }
+        if (!href) {
+            href = isUserDefinedHref ? item.href : (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') {
+                href = '';
+            }
         }
     }
     const baseResult = Object.assign(Object.assign({ name: findDivisionName(item) }, divisionItem), { href: href, isActive, isGlobal: false });
@@ -306,6 +313,7 @@ function buildDivisionItem(param) {
                 item: menuItem,
                 isActive: false, // menu items are not active by default
                 cache,
+                currentPath,
                 currentVersion,
                 currentLanguage,
                 userGroups,
@@ -322,6 +330,52 @@ function buildDivisionItem(param) {
     }
     return baseResult;
 }
+function findCorrespondingDropdownHref(item, currentPath, userGroups, isPreview) {
+    let exactMatch;
+    let segmentMatch;
+    function walk(entry) {
+        if (exactMatch !== undefined || typeof entry !== 'object')
+            return;
+        if (isPage(entry)) {
+            if (!checkNavAccess(entry, userGroups, isPreview))
+                return;
+            if (isEqualIgnoringLeadingSlash(entry.href, currentPath)) {
+                exactMatch = entry.href;
+            }
+            else if (segmentMatch === undefined &&
+                pathsDifferByOneSegment(entry.href, currentPath, 'version')) {
+                segmentMatch = entry.href;
+            }
+            return;
+        }
+        if ('hidden' in entry && entry.hidden)
+            return;
+        if ('root' in entry && typeof entry.root === 'object') {
+            walk(entry.root);
+        }
+        if ('pages' in entry && Array.isArray(entry.pages)) {
+            for (const page of entry.pages) {
+                if (typeof page === 'object')
+                    walk(page);
+            }
+        }
+        if ('groups' in entry && Array.isArray(entry.groups)) {
+            for (const group of entry.groups) {
+                walk(group);
+            }
+        }
+        for (const key of divisions) {
+            const subDivisions = readObjectArrayProperty(entry, key);
+            if (!subDivisions)
+                continue;
+            for (const subDivision of subDivisions) {
+                walk(subDivision);
+            }
+        }
+    }
+    walk(item);
+    return exactMatch !== null && exactMatch !== void 0 ? exactMatch : segmentMatch;
+}
 function getFirstPageFromCurrentDivisions(item, currentVersion, currentLanguage, userGroups, isPreview = false) {
     var _a, _b;
     if ('versions' in item && currentVersion) {
@@ -629,6 +683,7 @@ function findMostRelevantDivisions(currentPath, decoratedNav, currentVersion, cu
                                 item,
                                 isActive,
                                 cache,
+                                currentPath,
                                 currentVersion,
                                 currentLanguage,
                                 userGroups,

package/dist/navigation/filterDivisions.test.js

@@ -668,3 +668,124 @@ describe('filterDivisions with partial auth', () => {
         });
     });
 });
+describe('filterDivisions dropdown corresponding pages', () => {
+    const defaultArgs = {
+        decoratedNav: { groups: [] },
+        currentPath: '',
+        userGroups: new Set(),
+        currentVersion: '',
+        currentLanguage: undefined,
+        shouldUseDivisionMatch: true,
+        cache: {
+            dropdownCache: new Map(),
+        },
+    };
+    const versionedDropdownNav = {
+        dropdowns: [
+            {
+                dropdown: 'Version 0.22',
+                groups: [
+                    {
+                        group: 'Get Started',
+                        pages: [
+                            { title: 'Overview', href: '/vega/0.22/overview' },
+                            { title: 'Install', href: '/vega/0.22/install' },
+                            { title: 'New Feature', href: '/vega/0.22/new-feature' },
+                        ],
+                    },
+                ],
+            },
+            {
+                dropdown: 'Version 0.21',
+                groups: [
+                    {
+                        group: 'Get Started',
+                        pages: [
+                            { title: 'Overview', href: '/vega/0.21/overview' },
+                            { title: 'Install', href: '/vega/0.21/install' },
+                        ],
+                    },
+                ],
+            },
+        ],
+    };
+    it('points inactive dropdowns at the corresponding page when one exists', () => {
+        var _a;
+        const result = filterDivisions(Object.assign(Object.assign({}, defaultArgs), { decoratedNav: versionedDropdownNav, currentPath: '/vega/0.21/install' }));
+        expect((_a = result.dropdowns.find((d) => d.name === 'Version 0.22')) === null || _a === void 0 ? void 0 : _a.href).toBe('/vega/0.22/install');
+    });
+    it('keeps the first page href for the active dropdown', () => {
+        const result = filterDivisions(Object.assign(Object.assign({}, defaultArgs), { decoratedNav: versionedDropdownNav, currentPath: '/vega/0.21/install' }));
+        const active = result.dropdowns.find(isActiveDivision);
+        expect(active === null || active === void 0 ? void 0 : active.name).toBe('Version 0.21');
+        expect(active === null || active === void 0 ? void 0 : active.href).toBe('/vega/0.21/overview');
+    });
+    it('falls back to the first page when no corresponding page exists', () => {
+        var _a;
+        const result = filterDivisions(Object.assign(Object.assign({}, defaultArgs), { decoratedNav: versionedDropdownNav, currentPath: '/vega/0.22/new-feature' }));
+        expect((_a = result.dropdowns.find((d) => d.name === 'Version 0.21')) === null || _a === void 0 ? void 0 : _a.href).toBe('/vega/0.21/overview');
+    });
+    it('prefers a shared page at the same href over a segment match', () => {
+        var _a;
+        const result = filterDivisions(Object.assign(Object.assign({}, defaultArgs), { decoratedNav: {
+                dropdowns: [
+                    {
+                        dropdown: 'Guides',
+                        pages: [
+                            { title: 'Intro', href: '/guides/intro' },
+                            { title: 'Changelog', href: '/changelog/latest' },
+                        ],
+                    },
+                    {
+                        dropdown: 'Reference',
+                        pages: [
+                            { title: 'Intro', href: '/reference/intro' },
+                            { title: 'Changelog', href: '/changelog/latest' },
+                        ],
+                    },
+                ],
+            }, currentPath: '/changelog/latest' }));
+        expect((_a = result.dropdowns.find((d) => d.name === 'Reference')) === null || _a === void 0 ? void 0 : _a.href).toBe('/changelog/latest');
+    });
+    it('skips corresponding pages the viewer cannot access', () => {
+        var _a, _b;
+        const decoratedNav = {
+            dropdowns: [
+                {
+                    dropdown: 'Version 0.22',
+                    pages: [
+                        { title: 'Overview', href: '/vega/0.22/overview' },
+                        { title: 'Install', href: '/vega/0.22/install', groups: ['admin'] },
+                    ],
+                },
+                {
+                    dropdown: 'Version 0.21',
+                    pages: [
+                        { title: 'Overview', href: '/vega/0.21/overview' },
+                        { title: 'Install', href: '/vega/0.21/install' },
+                    ],
+                },
+            ],
+        };
+        const anonymous = filterDivisions(Object.assign(Object.assign({}, defaultArgs), { decoratedNav, currentPath: '/vega/0.21/install' }));
+        expect((_a = anonymous.dropdowns.find((d) => d.name === 'Version 0.22')) === null || _a === void 0 ? void 0 : _a.href).toBe('/vega/0.22/overview');
+        const admin = filterDivisions(Object.assign(Object.assign({}, defaultArgs), { decoratedNav, currentPath: '/vega/0.21/install', userGroups: new Set(['admin']) }));
+        expect((_b = admin.dropdowns.find((d) => d.name === 'Version 0.22')) === null || _b === void 0 ? void 0 : _b.href).toBe('/vega/0.22/install');
+    });
+    it('matches corresponding pages for dropdowns nested inside tabs', () => {
+        var _a;
+        const result = filterDivisions(Object.assign(Object.assign({}, defaultArgs), { decoratedNav: {
+                tabs: [
+                    {
+                        tab: 'Get Started',
+                        dropdowns: versionedDropdownNav.dropdowns,
+                    },
+                    {
+                        tab: 'Support',
+                        pages: [{ title: 'Help', href: '/support/help' }],
+                    },
+                ],
+            }, currentPath: '/vega/0.21/install' }));
+        expect((_a = result.dropdowns.find((d) => d.name === 'Version 0.22')) === null || _a === void 0 ? void 0 : _a.href).toBe('/vega/0.22/install');
+    });
+});