@mintlify/validation 0.1.264 → 0.1.266

package/dist/mint-config/upgrades/updateNavigationToDocsConfig.js

@@ -1,3 +1,4 @@
+import isAbsoluteUrl from 'is-absolute-url';
 import _ from 'lodash';
 const DEFAULT_TAB = {
     tab: 'Documentation',
@@ -52,8 +53,8 @@ const findPagesForPrefix = (groups, division, versionName, ignoredDivisions = []
         if (isGroupVersionMatch) {
             group.pages.forEach((page) => {
                 if (typeof page === 'string') {
-                    if ((!prefix || page.startsWith(prefix)) &&
-                        !ignoredDivisions.some((d) => page.startsWith(d.url))) {
+                    if ((!prefix || ensureLeadingSlash(page).startsWith(ensureLeadingSlash(prefix))) &&
+                        !ignoredDivisions.some((d) => ensureLeadingSlash(page).startsWith(ensureLeadingSlash(d.url)))) {
                         groupPages.push(page);
                     }
                     else {
@@ -78,8 +79,7 @@ const findPagesForPrefix = (groups, division, versionName, ignoredDivisions = []
     });
     return { matchedGroups, unmatchedGroups };
 };
-const processDivisions = (type, divisions = [], navigationGroups = [], shouldInsertRemainingGroups = false, versionName, config) => {
-    var _a, _b;
+const processDivisions = (type, divisions = [], navigationGroups = [], shouldInsertRemainingGroups = false, versionName, config, otherDivisions) => {
     let remainingGroups = filterGroupsByVersion(navigationGroups, versionName);
     const result = divisions
         .map((division) => {
@@ -100,26 +100,41 @@ const processDivisions = (type, divisions = [], navigationGroups = [], shouldIns
                 };
             }
         }
-        const ignoredDivisions = divisions.filter((d) => d.url.startsWith(division.url) && d.url !== division.url);
+        const ignoredDivisions = divisions.filter((d) => ensureLeadingSlash(d.url).startsWith(ensureLeadingSlash(division.url)) &&
+            d.url !== division.url);
+        let moreTabs = [];
+        let moreAnchors = [];
+        // process the other divisions
+        if (otherDivisions === null || otherDivisions === void 0 ? void 0 : otherDivisions.length) {
+            const matchedDivisions = otherDivisions.filter((d) => {
+                return ensureLeadingSlash(d.url).startsWith(ensureLeadingSlash(division.url));
+            });
+            if (matchedDivisions.length) {
+                const { tabs, anchors } = processDivisions(type === 'tabs' ? 'anchors' : 'tabs', matchedDivisions, navigationGroups, false, versionName, config);
+                moreTabs = tabs;
+                moreAnchors = anchors;
+            }
+        }
         const { matchedGroups, unmatchedGroups } = findPagesForPrefix(remainingGroups, division, versionName, ignoredDivisions);
         remainingGroups = unmatchedGroups;
         if (matchedGroups.length) {
-            return Object.assign(Object.assign({}, _.omit(baseDivision, 'href')), { groups: matchedGroups });
+            if (matchedGroups.length) {
+                const divisionWithoutHref = _.omit(baseDivision, 'href');
+                if (moreTabs.length)
+                    return Object.assign(Object.assign({}, divisionWithoutHref), { tabs: moreTabs });
+                if (moreAnchors.length)
+                    return Object.assign(Object.assign({}, divisionWithoutHref), { anchors: moreAnchors });
+                return Object.assign(Object.assign({}, divisionWithoutHref), { groups: matchedGroups });
+            }
         }
+        if (!matchedGroups.length && !isAbsoluteUrl(division.url))
+            return undefined;
         return baseDivision;
     })
         .filter(Boolean);
     if (remainingGroups.length && shouldInsertRemainingGroups) {
         const { matchedGroups } = findPagesForPrefix(remainingGroups, undefined, versionName, []);
-        if (type === 'tabs') {
-            result.unshift(Object.assign(Object.assign({}, (((_a = config === null || config === void 0 ? void 0 : config.primaryTab) === null || _a === void 0 ? void 0 : _a.name)
-                ? Object.assign({ tab: config.primaryTab.name }, (config.primaryTab.isDefaultHidden !== undefined && {
-                    hidden: config.primaryTab.isDefaultHidden,
-                })) : DEFAULT_TAB)), { groups: matchedGroups }));
-        }
-        else {
-            result.push(Object.assign(Object.assign({}, (((_b = config === null || config === void 0 ? void 0 : config.topAnchor) === null || _b === void 0 ? void 0 : _b.name) ? { anchor: config.topAnchor.name } : DEFAULT_ANCHOR)), { groups: matchedGroups }));
-        }
+        result.unshift(Object.assign(Object.assign({}, getPrimaryConfig(type === 'tabs' ? 'tab' : 'anchor', config)), { groups: matchedGroups }));
     }
     if (type === 'tabs') {
         return { tabs: result, anchors: [], remainingGroups };
@@ -162,9 +177,12 @@ const processVersionsOrLanguages = (versions = [], navigationGroups = [], prefix
         }
         else {
             const versionName = typeof version === 'string' ? version : version.name;
+            const versionHref = typeof version === 'string' ? undefined : version.url;
             const baseVersion = {
                 version: versionName,
             };
+            if (versionHref)
+                return Object.assign(Object.assign({}, baseVersion), { href: versionHref });
             const { matchedGroups } = findPagesForVersionOrLanguage(navigationGroups, versionName, prefixes);
             return Object.assign(Object.assign({}, baseVersion), { groups: matchedGroups });
         }
@@ -174,36 +192,57 @@ const processVersionsOrLanguages = (versions = [], navigationGroups = [], prefix
         versions: result,
     };
 };
-/**
- * Priority
- * 1. versions (including locales)
- * 2. anchors (global anchors)
- * 3. tabs (tabs)
- * 4. groups
- */
 export const updateNavigationToDocsConfig = (config) => {
-    const { navigation: groups, tabs, anchors, versions } = config;
+    let { tabs, anchors, versions } = config;
+    const groups = config.navigation;
     const { tabs: globalTabs, anchors: globalAnchors, versions: globalVersions, } = getGlobalDivisions(config);
+    const hasTabs = tabs === null || tabs === void 0 ? void 0 : tabs.length;
+    const hasAnchors = anchors === null || anchors === void 0 ? void 0 : anchors.length;
+    tabs = (globalTabs === null || globalTabs === void 0 ? void 0 : globalTabs.length) ? [] : tabs;
+    anchors = (globalAnchors === null || globalAnchors === void 0 ? void 0 : globalAnchors.length) ? [] : anchors;
+    versions = (globalVersions === null || globalVersions === void 0 ? void 0 : globalVersions.length) ? [] : versions;
     // process divisions
-    const getUpdatedNavigation = (groups, tabs, anchors, versionName, config) => {
-        var _a, _b;
-        if ((anchors === null || anchors === void 0 ? void 0 : anchors.length) && !(globalAnchors === null || globalAnchors === void 0 ? void 0 : globalAnchors.length)) {
-            const { anchors: anchorsResult, remainingGroups } = processDivisions('anchors', anchors, groups, false, versionName, config);
-            if (remainingGroups.length || (tabs === null || tabs === void 0 ? void 0 : tabs.length)) {
-                if ((tabs === null || tabs === void 0 ? void 0 : tabs.length) && !(globalTabs === null || globalTabs === void 0 ? void 0 : globalTabs.length)) {
-                    const { tabs: tabsResult } = processDivisions('tabs', tabs, remainingGroups.length ? remainingGroups : groups, true, versionName, config);
-                    anchorsResult.push(Object.assign(Object.assign({}, (((_a = config === null || config === void 0 ? void 0 : config.topAnchor) === null || _a === void 0 ? void 0 : _a.name) ? { anchor: config.topAnchor.name } : DEFAULT_ANCHOR)), { tabs: tabsResult }));
-                }
-                else {
-                    const { matchedGroups } = findPagesForPrefix(remainingGroups, undefined, versionName);
-                    anchorsResult.push(Object.assign(Object.assign({}, (((_b = config === null || config === void 0 ? void 0 : config.topAnchor) === null || _b === void 0 ? void 0 : _b.name) ? { anchor: config.topAnchor.name } : DEFAULT_ANCHOR)), { groups: matchedGroups }));
+    const getUpdatedNavigation = (groups, config, versionName) => {
+        const topLevelDivision = findMostInclusiveDivision(tabs, anchors);
+        if (topLevelDivision === 'anchors') {
+            if (hasAnchors) {
+                const { anchors: anchorsResult, remainingGroups } = processDivisions('anchors', anchors, groups, false, versionName, config, tabs);
+                if (remainingGroups.length || (tabs === null || tabs === void 0 ? void 0 : tabs.length)) {
+                    if (tabs === null || tabs === void 0 ? void 0 : tabs.length) {
+                        const { tabs: tabsResult } = processDivisions('tabs', tabs, remainingGroups.length ? remainingGroups : groups, true, versionName, config);
+                        anchorsResult.unshift(Object.assign(Object.assign({}, getPrimaryConfig('anchor', config)), { tabs: tabsResult }));
+                    }
+                    else {
+                        const { matchedGroups } = findPagesForPrefix(remainingGroups, undefined, versionName);
+                        anchorsResult.unshift(Object.assign(Object.assign({}, getPrimaryConfig('anchor', config)), { groups: matchedGroups }));
+                    }
                 }
+                return { anchors: anchorsResult };
+            }
+            if (hasTabs) {
+                const { tabs: tabsResult } = processDivisions('tabs', tabs, groups, true, versionName, config);
+                return { tabs: tabsResult };
             }
-            return { anchors: anchorsResult };
         }
-        if ((tabs === null || tabs === void 0 ? void 0 : tabs.length) && !(globalTabs === null || globalTabs === void 0 ? void 0 : globalTabs.length)) {
-            const { tabs: tabsResult } = processDivisions('tabs', tabs, groups, true, versionName, config);
-            return { tabs: tabsResult };
+        else {
+            if (hasTabs) {
+                const { tabs: tabsResult, remainingGroups } = processDivisions('tabs', tabs, groups, false, versionName, config, anchors);
+                if (remainingGroups.length || (anchors === null || anchors === void 0 ? void 0 : anchors.length)) {
+                    if (anchors === null || anchors === void 0 ? void 0 : anchors.length) {
+                        const { anchors: anchorsResult } = processDivisions('anchors', anchors, remainingGroups.length ? remainingGroups : groups, true, versionName, config);
+                        tabsResult.unshift(Object.assign(Object.assign({}, getPrimaryConfig('tab', config)), { anchors: anchorsResult }));
+                    }
+                    else {
+                        const { matchedGroups } = findPagesForPrefix(remainingGroups, undefined, versionName);
+                        tabsResult.unshift(Object.assign(Object.assign({}, getPrimaryConfig('tab', config)), { groups: matchedGroups }));
+                    }
+                }
+                return { tabs: tabsResult };
+            }
+            if (hasAnchors) {
+                const { anchors: anchorsResult } = processDivisions('anchors', anchors, groups, true, versionName, config);
+                return { anchors: anchorsResult };
+            }
         }
         if (groups.length) {
             const parsedGroups = filterGroupsByVersion(groups, versionName).map((group) => (Object.assign({ group: group.group, pages: group.pages }, (group.icon ? { icon: formatIcon(group.icon, group.iconType) } : {}))));
@@ -212,6 +251,7 @@ export const updateNavigationToDocsConfig = (config) => {
         return undefined;
     };
     if ((versions === null || versions === void 0 ? void 0 : versions.length) && !(globalVersions === null || globalVersions === void 0 ? void 0 : globalVersions.length)) {
+        // divisions that match the versions
         const prefixes = versions.reduce((acc, version) => {
             const versionName = typeof version === 'string' ? version : version.name;
             const anchorPrefixes = anchors === null || anchors === void 0 ? void 0 : anchors.filter((anchor) => anchor.version === versionName && !isRemoteUrl(anchor.url));
@@ -223,11 +263,20 @@ export const updateNavigationToDocsConfig = (config) => {
         const { versions: versionsResult, isLocale } = processVersionsOrLanguages(versions, groups, prefixes);
         versionsResult.forEach((version, index) => {
             var _a;
+            if (typeof version === 'object' && 'href' in version) {
+                return;
+            }
             const versionName = typeof versions[index] === 'string'
                 ? version.version
                 : ((_a = versions[index]) === null || _a === void 0 ? void 0 : _a.name) || version.language;
-            if ('groups' in version) {
-                const updatedNavigationPerVersion = getUpdatedNavigation(version.groups, tabs, anchors, versionName, config);
+            if ('groups' in version && version.groups.length) {
+                const updatedNavigationPerVersion = getUpdatedNavigation(version.groups, config, versionName);
+                if (updatedNavigationPerVersion) {
+                    versionsResult[index] = Object.assign(Object.assign({}, _.omit(version, 'groups')), updatedNavigationPerVersion);
+                }
+            }
+            else {
+                const updatedNavigationPerVersion = getUpdatedNavigation(groups, config, versionName);
                 if (updatedNavigationPerVersion) {
                     versionsResult[index] = Object.assign(Object.assign({}, _.omit(version, 'groups')), updatedNavigationPerVersion);
                 }
@@ -239,7 +288,7 @@ export const updateNavigationToDocsConfig = (config) => {
         }
         return navigationConfig;
     }
-    const navigationConfig = (getUpdatedNavigation(groups, tabs, anchors, undefined, config) || {
+    const navigationConfig = (getUpdatedNavigation(groups, config) || {
         groups: [],
     });
     if ((globalTabs === null || globalTabs === void 0 ? void 0 : globalTabs.length) || (globalAnchors === null || globalAnchors === void 0 ? void 0 : globalAnchors.length)) {
@@ -247,3 +296,44 @@ export const updateNavigationToDocsConfig = (config) => {
     }
     return navigationConfig;
 };
+/**
+ * Decide which division is most relevant to the top level navigation
+ * 1. if tabs doesn't exist, return anchors, vice versa
+ * 2. if both exist, return the most inclusive division
+ *  2.1 if tabs are more inclusive, return tabs
+ *  2.2 if anchors are more inclusive, return anchors
+ */
+function findMostInclusiveDivision(tabs, anchors) {
+    if (!(tabs === null || tabs === void 0 ? void 0 : tabs.length))
+        return 'anchors';
+    if (!(anchors === null || anchors === void 0 ? void 0 : anchors.length))
+        return 'tabs';
+    const inclusiveTabs = tabs.filter((tab) => {
+        return anchors.some((anchor) => ensureLeadingSlash(tab.url).startsWith(ensureLeadingSlash(anchor.url)));
+    });
+    const inclusiveAnchors = anchors.filter((anchor) => {
+        return tabs.some((tab) => ensureLeadingSlash(anchor.url).startsWith(ensureLeadingSlash(tab.url)));
+    });
+    // this means that there is a division that covers all paths
+    if (inclusiveTabs.length === tabs.length)
+        return 'tabs';
+    if (inclusiveAnchors.length === anchors.length)
+        return 'anchors';
+    // compare the number of inclusive divisions
+    return inclusiveTabs.length > inclusiveAnchors.length ? 'tabs' : 'anchors';
+}
+function ensureLeadingSlash(path) {
+    return path.startsWith('/') ? path : `/${path}`;
+}
+const getPrimaryConfig = (type, config) => {
+    var _a, _b;
+    if (type === 'anchor') {
+        return Object.assign(Object.assign({}, (((_a = config === null || config === void 0 ? void 0 : config.topAnchor) === null || _a === void 0 ? void 0 : _a.name) ? { anchor: config.topAnchor.name } : DEFAULT_ANCHOR)), (((_b = config === null || config === void 0 ? void 0 : config.topAnchor) === null || _b === void 0 ? void 0 : _b.icon)
+            ? { icon: formatIcon(config.topAnchor.icon, config.topAnchor.iconType) }
+            : {}));
+    }
+    return Object.assign({}, ((config === null || config === void 0 ? void 0 : config.primaryTab)
+        ? Object.assign({ tab: config.primaryTab.name }, (config.primaryTab.isDefaultHidden !== undefined && {
+            hidden: config.primaryTab.isDefaultHidden,
+        })) : DEFAULT_TAB));
+};