@mintlify/validation 0.1.254 → 0.1.256

package/dist/mint-config/upgrades/convertMintDecoratedNavToDocsDecoratedNav.d.ts

@@ -0,0 +1,14 @@
+import type { MintConfigType, DecoratedNavigation } from '@mintlify/models';
+import { DocsConfig } from '../schemas/v2/index.js';
+import { DecoratedNavigationConfig } from '../schemas/v2/properties/navigation/index.js';
+type Input = {
+    type: 'mint';
+    mintConfig: MintConfigType;
+    decoratedNavigation: DecoratedNavigation;
+} | {
+    type: 'docs';
+    docsConfig: DocsConfig;
+    decoratedNavigation: DecoratedNavigation;
+};
+export declare const convertMintDecoratedNavToDocsDecoratedNav: (param: Input) => DecoratedNavigationConfig;
+export {};

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

@@ -0,0 +1,98 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { divisions } from '../schemas/v2/properties/index.js';
+import { upgradeToDocsConfig } from './upgradeToDocsConfig.js';
+export const convertMintDecoratedNavToDocsDecoratedNav = (param) => {
+    const { type, decoratedNavigation } = param;
+    let docsConfig;
+    if (type === 'mint') {
+        const { mintConfig } = param;
+        docsConfig = upgradeToDocsConfig(mintConfig);
+    }
+    else {
+        docsConfig = param.docsConfig;
+    }
+    const pagesAcc = {};
+    for (const decoratedNavigationEntry of decoratedNavigation) {
+        mapDecoratedNavigationToPages(decoratedNavigationEntry, pagesAcc);
+    }
+    const decoratedDocsConfig = generateDecoratedDocsNavigationFromPages(pagesAcc, docsConfig.navigation);
+    return decoratedDocsConfig;
+};
+/**
+ * These functions are copied from other packages to avoid circular dependencies
+ */
+const generateDecoratedDocsNavigationFromPages = (filenamePageMetadataMap, docsConfigNav) => {
+    const { global } = docsConfigNav, nav = __rest(docsConfigNav, ["global"]);
+    const generateDecoratedPages = (page) => {
+        const href = optionallyAddLeadingSlash(page);
+        const pageMetadata = filenamePageMetadataMap[href];
+        if (pageMetadata) {
+            return pageMetadata;
+        }
+        else {
+            console.log(`⚠️   "${page}" is defined in the docs.json navigation but the file does not exist.`);
+            return {
+                title: slugToTitle(page),
+                href,
+            };
+        }
+    };
+    const traverseNav = (nav) => {
+        let processed = Object.assign({}, nav);
+        if ('openapi' in processed) {
+            const { openapi: _ } = processed, rest = __rest(processed, ["openapi"]);
+            processed = Object.assign({}, rest);
+        }
+        if ('pages' in processed) {
+            processed.pages = processed.pages.map((page) => typeof page === 'string' ? generateDecoratedPages(page) : traverseNav(page));
+        }
+        ['groups', ...divisions].forEach((division) => {
+            const divisionNav = processed[division];
+            if (Array.isArray(divisionNav)) {
+                processed = Object.assign(Object.assign({}, processed), { [division]: divisionNav.map((item) => traverseNav(item)) });
+            }
+        });
+        return processed;
+    };
+    return Object.assign({ global }, traverseNav(nav));
+};
+const mapDecoratedNavigationToPages = (entry, pagesAcc) => {
+    if (isGroup(entry)) {
+        for (const page of entry.pages) {
+            mapDecoratedNavigationToPages(page, pagesAcc);
+        }
+    }
+    else {
+        pagesAcc[entry.href] = entry;
+    }
+};
+const isGroup = (decoratedNavigation) => {
+    return decoratedNavigation.hasOwnProperty('group') && decoratedNavigation.hasOwnProperty('pages');
+};
+function optionallyAddLeadingSlash(filePath) {
+    if (filePath.startsWith('/')) {
+        return filePath;
+    }
+    return '/' + filePath;
+}
+const slugToTitle = (slug) => {
+    const indexOfQuestionMark = slug.indexOf('?');
+    if (indexOfQuestionMark > -1) {
+        slug = slug.substring(0, indexOfQuestionMark);
+    }
+    const slugArr = slug.split('/');
+    let defaultTitle = slugArr[slugArr.length - 1].split('-').join(' '); //replace all dashes
+    defaultTitle = defaultTitle.split('_').join(' '); //replace all underscores
+    defaultTitle = defaultTitle.charAt(0).toUpperCase() + defaultTitle.slice(1); //capitalize first letter
+    return defaultTitle;
+};

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

@@ -9,7 +9,6 @@ const DEFAULT_ANCHOR = {
 };
 const filterGroupsByVersion = (groups, versionName) => groups.filter((group) => group.version === versionName || group.version === undefined || !versionName);
 const formatIcon = (icon, iconType) => iconType ? { name: icon, style: iconType } : icon;
-const isAnchor = (division) => 'icon' in division || 'color' in division;
 const isRemoteUrl = (url) => {
     if (!url)
         return false;
@@ -88,12 +87,17 @@ const processDivisions = (type, divisions = [], navigationGroups = [], shouldIns
             return undefined;
         }
         const baseDivision = Object.assign(Object.assign(Object.assign(Object.assign({}, (type === 'tabs' ? { tab: division.name } : { anchor: division.name })), { href: division.url }), (division.isDefaultHidden ? { hidden: division.isDefaultHidden } : {})), (division.openapi ? { openapi: division.openapi } : {}));
-        if (isAnchor(division)) {
-            if (division.icon) {
+        if (type === 'anchors') {
+            if ('icon' in division && division.icon) {
                 baseDivision.icon = formatIcon(division.icon, division.iconType);
             }
-            if (division.color) {
-                baseDivision.color = division.color;
+            if ('color' in division && division.color) {
+                // TODO: we need a better way to handle this
+                const color = typeof division.color === 'string' ? division.color : division.color.from;
+                baseDivision.color = {
+                    light: color,
+                    dark: color,
+                };
             }
         }
         const ignoredDivisions = divisions.filter((d) => d.url.startsWith(division.url) && d.url !== division.url);
@@ -222,9 +226,11 @@ export const updateNavigationToDocsConfig = (config) => {
             const versionName = typeof versions[index] === 'string'
                 ? version.version
                 : ((_a = versions[index]) === null || _a === void 0 ? void 0 : _a.name) || version.language;
-            const updatedNavigationPerVersion = getUpdatedNavigation(version.groups, tabs, anchors, versionName, config);
-            if (updatedNavigationPerVersion) {
-                versionsResult[index] = Object.assign(Object.assign({}, _.omit(version, 'groups')), updatedNavigationPerVersion);
+            if ('groups' in version) {
+                const updatedNavigationPerVersion = getUpdatedNavigation(version.groups, tabs, anchors, versionName, config);
+                if (updatedNavigationPerVersion) {
+                    versionsResult[index] = Object.assign(Object.assign({}, _.omit(version, 'groups')), updatedNavigationPerVersion);
+                }
             }
         });
         const navigationConfig = (isLocale ? { languages: versionsResult } : { versions: versionsResult });