@mintlify/common 1.0.1235 → 1.0.1236

package/dist/navigation/updateFirstHrefInDivision.d.ts

@@ -1,3 +1,4 @@
+import { type PageGroups } from '@mintlify/models';
 import { DecoratedNavigationConfig, DecoratedPageOrGroupConfig, DecoratedGroupConfig } from '@mintlify/validation';
 import { NavigationDivisions } from './filterDivisions.js';
 export declare enum DivisionMatchLevel {
@@ -11,8 +12,13 @@ export declare enum DivisionMatchLevel {
 export type DivisionMatch = {
     href: string;
     matchLevel: DivisionMatchLevel;
+    hidden?: true;
+    noindex?: true;
+    robots?: string;
+    canonicalOverride?: true;
+    groups?: PageGroups;
 };
-export declare function updateFirstHrefInDivision({ type, currentPath, entry, parentGroups, nearestDivisionValue, isActiveGroup, inActiveDivision, currentDivisionValue, allDivisionValues, firstHrefInDivision, navigationDivisions, isHiddenPage, activeGroupNames, activeDivisionOwner, }: {
+export declare function updateFirstHrefInDivision({ type, currentPath, entry, parentGroups, nearestDivisionValue, isActiveGroup, inActiveDivision, currentDivisionValue, allDivisionValues, firstHrefInDivision, navigationDivisions, isHiddenPage, activeGroupNames, activeDivisionOwner, inHiddenSubtree, }: {
     type: 'version' | 'language';
     currentPath: string;
     entry: DecoratedNavigationConfig | DecoratedPageOrGroupConfig;
@@ -27,5 +33,6 @@ export declare function updateFirstHrefInDivision({ type, currentPath, entry, pa
     isHiddenPage: boolean;
     activeGroupNames?: Set<string>;
     activeDivisionOwner?: object;
+    inHiddenSubtree?: boolean;
 }): void;
 export declare function pathsDifferByOneSegment(a: string, b: string, type: 'version' | 'language', languages?: readonly string[]): boolean;

package/dist/navigation/updateFirstHrefInDivision.js

@@ -13,11 +13,18 @@ export var DivisionMatchLevel;
     DivisionMatchLevel[DivisionMatchLevel["UNVERSIONED"] = 5] = "UNVERSIONED";
 })(DivisionMatchLevel || (DivisionMatchLevel = {}));
 const ACCEPTED_BASE_PATHS = ['docs', 'doc', 'documentation', 'help'];
-export function updateFirstHrefInDivision({ type, currentPath, entry, parentGroups, nearestDivisionValue, isActiveGroup, inActiveDivision, currentDivisionValue, allDivisionValues, firstHrefInDivision, navigationDivisions, isHiddenPage, activeGroupNames, activeDivisionOwner, }) {
+export function updateFirstHrefInDivision({ type, currentPath, entry, parentGroups, nearestDivisionValue, isActiveGroup, inActiveDivision, currentDivisionValue, allDivisionValues, firstHrefInDivision, navigationDivisions, isHiddenPage, activeGroupNames, activeDivisionOwner, inHiddenSubtree = false, }) {
     if (typeof entry !== 'object')
         return;
+    const hidden = inHiddenSubtree || ('hidden' in entry && entry.hidden === true);
     if (isPage(entry)) {
-        maybeUpdateFirstHrefInDivision(type, entry.href, nearestDivisionValue, isActiveGroup, inActiveDivision, currentPath, currentDivisionValue, allDivisionValues, firstHrefInDivision, isHiddenPage);
+        maybeUpdateFirstHrefInDivision(type, entry.href, nearestDivisionValue, isActiveGroup, inActiveDivision, currentPath, currentDivisionValue, allDivisionValues, firstHrefInDivision, isHiddenPage, {
+            hidden,
+            noindex: entry.noindex === true,
+            robots: entry.robots,
+            canonicalOverride: Boolean(entry.canonical),
+            groups: entry.groups,
+        });
     }
     if ('pages' in entry && Array.isArray(entry.pages)) {
         const root = 'root' in entry && entry.root != null && typeof entry.root === 'object'
@@ -45,6 +52,7 @@ export function updateFirstHrefInDivision({ type, currentPath, entry, parentGrou
                 isHiddenPage,
                 activeGroupNames,
                 activeDivisionOwner,
+                inHiddenSubtree: hidden,
             });
         }
         for (const page of entry.pages) {
@@ -64,6 +72,7 @@ export function updateFirstHrefInDivision({ type, currentPath, entry, parentGrou
                     isHiddenPage,
                     activeGroupNames,
                     activeDivisionOwner,
+                    inHiddenSubtree: hidden,
                 });
             }
         }
@@ -94,6 +103,7 @@ export function updateFirstHrefInDivision({ type, currentPath, entry, parentGrou
                 isHiddenPage,
                 activeGroupNames,
                 activeDivisionOwner,
+                inHiddenSubtree: hidden,
             });
         }
     }
@@ -169,6 +179,7 @@ export function updateFirstHrefInDivision({ type, currentPath, entry, parentGrou
                 isHiddenPage,
                 activeGroupNames: activeGroupsInVersionContext,
                 activeDivisionOwner,
+                inHiddenSubtree: hidden,
             });
         }
     }
@@ -261,7 +272,7 @@ function parseLanguagePath(segments, languages) {
  * @param versionStrings If defined, the array of version strings
  * @param firstHrefInDivision A map from version strings to the href that should be navigated to when switching to that version
  */
-function maybeUpdateFirstHrefInDivision(type, href, finalVersion, inActiveGroup, inActiveDivision, currentPath, currentVersion, versionStrings, firstHrefInDivision, isHiddenPage) {
+function maybeUpdateFirstHrefInDivision(type, href, finalVersion, inActiveGroup, inActiveDivision, currentPath, currentVersion, versionStrings, firstHrefInDivision, isHiddenPage, target) {
     const versionsToUpdate = finalVersion !== undefined ? [finalVersion] : (versionStrings !== null && versionStrings !== void 0 ? versionStrings : []);
     // now that we support index.mdx, the href might empty string
     // router.push cannot take empty string as url
@@ -287,7 +298,18 @@ function maybeUpdateFirstHrefInDivision(type, href, finalVersion, inActiveGroup,
         const languages = type === 'language' ? versionStrings : undefined;
         if ((existingRef === undefined || DivisionMatchLevel.PATH < existingRef.matchLevel) &&
             pathsDifferByOneSegment(href, currentPath, type, languages)) {
-            firstHrefInDivision.set(finalVersion, { href, matchLevel: DivisionMatchLevel.PATH });
+            const match = { href, matchLevel: DivisionMatchLevel.PATH };
+            if (target.hidden)
+                match.hidden = true;
+            if (target.noindex)
+                match.noindex = true;
+            if (target.robots)
+                match.robots = target.robots;
+            if (target.canonicalOverride)
+                match.canonicalOverride = true;
+            if (target.groups)
+                match.groups = target.groups;
+            firstHrefInDivision.set(finalVersion, match);
         }
     }
     if (inActiveGroup) {

package/dist/navigation/updateFirstHrefInDivision.test.js

@@ -1,3 +1,4 @@
+import { getScopedNavForPath } from './scopeNavToPath.js';
 import { DivisionMatchLevel, updateFirstHrefInDivision, } from './updateFirstHrefInDivision.js';
 const emptyDivisions = {
     tabs: [],
@@ -50,3 +51,63 @@ describe(updateFirstHrefInDivision, () => {
         });
     });
 });
+describe('language translation matches', () => {
+    const page = (href, extra = {}) => (Object.assign({ title: href, href }, extra));
+    const nav = {
+        languages: [
+            {
+                language: 'en',
+                default: true,
+                pages: [
+                    page('/visible'),
+                    page('/hidden-page'),
+                    page('/in-hidden-group'),
+                    page('/gated'),
+                    page('/noindexed'),
+                ],
+            },
+            {
+                language: 'es',
+                groups: [
+                    {
+                        group: 'Visible',
+                        pages: [
+                            page('/es/visible'),
+                            page('/es/hidden-page', { hidden: true }),
+                            page('/es/gated', { groups: ['staff'] }),
+                            page('/es/noindexed', { noindex: true }),
+                        ],
+                    },
+                    { group: 'Hidden', hidden: true, pages: [page('/es/in-hidden-group')] },
+                ],
+            },
+        ],
+    };
+    const esMatch = (currentPath) => getScopedNavForPath({ decoratedNav: nav, currentPath }).firstHrefInLanguage.get('es');
+    it('records the translated page visibility on path matches', () => {
+        expect(esMatch('/visible')).toEqual({
+            href: '/es/visible',
+            matchLevel: DivisionMatchLevel.PATH,
+        });
+        expect(esMatch('/hidden-page')).toEqual({
+            href: '/es/hidden-page',
+            matchLevel: DivisionMatchLevel.PATH,
+            hidden: true,
+        });
+        expect(esMatch('/in-hidden-group')).toEqual({
+            href: '/es/in-hidden-group',
+            matchLevel: DivisionMatchLevel.PATH,
+            hidden: true,
+        });
+        expect(esMatch('/noindexed')).toEqual({
+            href: '/es/noindexed',
+            matchLevel: DivisionMatchLevel.PATH,
+            noindex: true,
+        });
+        expect(esMatch('/gated')).toEqual({
+            href: '/es/gated',
+            matchLevel: DivisionMatchLevel.PATH,
+            groups: ['staff'],
+        });
+    });
+});