@mintlify/common 1.0.1153 → 1.0.1154

package/dist/navigation/decoratedNavTree.d.ts

@@ -0,0 +1,11 @@
+import type { DecoratedDivisionConfig, DecoratedGroupConfig, DecoratedNavigationConfig, DecoratedPageConfig } from '@mintlify/validation';
+export type DecoratedNavNode = DecoratedNavigationConfig | DecoratedDivisionConfig | DecoratedGroupConfig | DecoratedPageConfig;
+export type DecoratedNavPageEntry = {
+    title: string;
+    mode?: string;
+};
+export declare function decoratedNavDivisions(node: DecoratedNavNode): DecoratedDivisionConfig[];
+export declare function decoratedNavChildren(node: DecoratedNavNode): DecoratedNavNode[];
+export declare const decoratedNavContains: (node: DecoratedNavNode, path: string) => boolean;
+export declare const findDecoratedNavPage: (node: DecoratedNavNode, path: string) => DecoratedNavPageEntry | null;
+export declare function decoratedNavSections(nav: DecoratedNavNode, path: string): DecoratedNavNode[];

package/dist/navigation/decoratedNavTree.js

@@ -0,0 +1,72 @@
+import { replaceSlashIndex } from '../slug/replaceSlashIndex.js';
+import { isPage } from './isPage.js';
+const normalizeNavPath = (p) => replaceSlashIndex(p.replace(/^\/+/, '').replace(/\/+$/, ''));
+const hrefOf = (node) => isPage(node) ? node.href : 'href' in node ? node.href : undefined;
+export function decoratedNavDivisions(node) {
+    if (isPage(node))
+        return [];
+    if ('languages' in node)
+        return node.languages;
+    if ('versions' in node)
+        return node.versions;
+    if ('products' in node)
+        return node.products;
+    if ('tabs' in node)
+        return node.tabs;
+    if ('anchors' in node)
+        return node.anchors;
+    if ('dropdowns' in node)
+        return node.dropdowns;
+    return [];
+}
+export function decoratedNavChildren(node) {
+    if (isPage(node))
+        return [];
+    if ('group' in node)
+        return node.root ? [node.root, ...node.pages] : node.pages;
+    if ('pages' in node)
+        return node.pages;
+    if ('groups' in node)
+        return node.groups;
+    if ('menu' in node)
+        return node.menu;
+    return [];
+}
+const matches = (node, path) => {
+    const href = hrefOf(node);
+    return href !== undefined && normalizeNavPath(href) === path;
+};
+function contains(node, path) {
+    if (matches(node, path))
+        return true;
+    return (decoratedNavChildren(node).some((c) => contains(c, path)) ||
+        decoratedNavDivisions(node).some((c) => contains(c, path)));
+}
+function findPage(node, path) {
+    if (isPage(node))
+        return matches(node, path) ? { title: node.title, mode: node.mode } : null;
+    for (const child of [...decoratedNavChildren(node), ...decoratedNavDivisions(node)]) {
+        const found = findPage(child, path);
+        if (found)
+            return found;
+    }
+    return null;
+}
+export const decoratedNavContains = (node, path) => contains(node, normalizeNavPath(path));
+export const findDecoratedNavPage = (node, path) => findPage(node, normalizeNavPath(path));
+// the nodes whose own pages (not a nested division's) hold the path: the
+// root for a flat nav, else the innermost division chain down to the page
+export function decoratedNavSections(nav, path) {
+    const target = normalizeNavPath(path);
+    const out = [];
+    const walk = (node) => {
+        for (const division of decoratedNavDivisions(node)) {
+            if (contains(division, target))
+                walk(division);
+        }
+        if (decoratedNavChildren(node).some((c) => contains(c, target)))
+            out.push(node);
+    };
+    walk(nav);
+    return out;
+}

package/dist/navigation/decoratedNavTree.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/navigation/decoratedNavTree.test.js

@@ -0,0 +1,51 @@
+import { decoratedNavContains, decoratedNavSections, findDecoratedNavPage, } from './decoratedNavTree.js';
+const nav = {
+    tabs: [
+        {
+            tab: 'Guides',
+            groups: [
+                { group: 'Start', pages: [{ href: '/guides/intro', title: 'Intro' }] },
+                { group: 'More', pages: [{ href: '/guides/deploy', title: 'Deploy', mode: 'custom' }] },
+            ],
+        },
+        { tab: 'API', pages: [{ href: '/api/overview', title: 'Overview' }] },
+    ],
+};
+describe('decoratedNavContains', () => {
+    it('finds pages through divisions and groups, ignoring slashes and /index', () => {
+        expect(decoratedNavContains(nav, '/guides/deploy')).toBe(true);
+        expect(decoratedNavContains(nav, 'guides/deploy/')).toBe(true);
+        expect(decoratedNavContains(nav, '/api/overview/index')).toBe(true);
+        expect(decoratedNavContains(nav, '/nowhere')).toBe(false);
+    });
+});
+describe('findDecoratedNavPage', () => {
+    it('returns the page title and mode', () => {
+        expect(findDecoratedNavPage(nav, '/guides/deploy')).toEqual({
+            title: 'Deploy',
+            mode: 'custom',
+        });
+        expect(findDecoratedNavPage(nav, '/api/overview')).toEqual({
+            title: 'Overview',
+            mode: undefined,
+        });
+        expect(findDecoratedNavPage(nav, '/nowhere')).toBeNull();
+    });
+});
+describe('decoratedNavSections', () => {
+    it('returns the division whose own pages hold the path', () => {
+        const sections = decoratedNavSections(nav, '/guides/intro');
+        expect(sections).toHaveLength(1);
+        expect(sections[0]).toBe(nav.tabs[0]);
+        expect(decoratedNavSections(nav, '/nowhere')).toEqual([]);
+    });
+    it('returns the root for a flat nav', () => {
+        const flat = {
+            pages: [
+                { href: '/a', title: 'A' },
+                { href: '/b', title: 'B' },
+            ],
+        };
+        expect(decoratedNavSections(flat, '/a')).toEqual([flat]);
+    });
+});

package/dist/navigation/index.d.ts

@@ -4,6 +4,7 @@ export * from './generatePathToBreadcrumbsMap.js';
 export * from './getFirstPageFromNavigation.js';
 export * from './generatePathToBreadcrumbsMapForDocsConfig.js';
 export * from './getAllPathsInDocsNav.js';
+export * from './decoratedNavTree.js';
 export * from './getAllPathsInDecoratedNav.js';
 export * from './checkNavAccess.js';
 export * from './filterDivisions.js';

package/dist/navigation/index.js

@@ -4,6 +4,7 @@ export * from './generatePathToBreadcrumbsMap.js';
 export * from './getFirstPageFromNavigation.js';
 export * from './generatePathToBreadcrumbsMapForDocsConfig.js';
 export * from './getAllPathsInDocsNav.js';
+export * from './decoratedNavTree.js';
 export * from './getAllPathsInDecoratedNav.js';
 export * from './checkNavAccess.js';
 export * from './filterDivisions.js';