@mintlify/validation 0.1.237 → 0.1.239

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

@@ -0,0 +1,10 @@
+import { ConfigType } from '@mintlify/models';
+import { NavigationConfig } from '../schemas/v2/properties/navigation/index.js';
+/**
+ * Priority
+ * 1. versions (including locales)
+ * 2. anchors (global anchors)
+ * 3. tabs (tabs)
+ * 4. groups
+ */
+export declare const updateNavigationToDocsConfig: (config: ConfigType) => NavigationConfig;

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

@@ -0,0 +1,240 @@
+import { omit } from 'lodash';
+const DEFAULT_TAB = {
+    tab: 'Documentation',
+};
+const DEFAULT_ANCHOR = {
+    anchor: 'Documentation',
+    icon: 'book-open',
+    hidden: true,
+};
+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;
+    return url.startsWith('https://') || url.startsWith('http://');
+};
+/**
+ * Get global divisions from config
+ * 1. External links
+ * 2. always there
+ */
+const getGlobalDivisions = (config) => {
+    const { tabs, anchors, versions } = config;
+    const globalConfig = {};
+    if ((versions === null || versions === void 0 ? void 0 : versions.length) &&
+        versions.every((version) => typeof version === 'object' && isRemoteUrl(version.url)))
+        globalConfig.versions = versions.map((version) => ({
+            version: version.name,
+            href: version.url,
+        }));
+    if ((tabs === null || tabs === void 0 ? void 0 : tabs.length) && tabs.every((tab) => !tab.version && isRemoteUrl(tab.url))) {
+        globalConfig.tabs = tabs.map((tab) => (Object.assign(Object.assign({ tab: tab.name, href: tab.url }, (tab.isDefaultHidden ? { hidden: tab.isDefaultHidden } : {})), (tab.openapi ? { openapi: tab.openapi } : {}))));
+    }
+    if ((anchors === null || anchors === void 0 ? void 0 : anchors.length) && anchors.every((anchor) => !anchor.version && isRemoteUrl(anchor.url))) {
+        globalConfig.anchors = anchors.map((anchor) => (Object.assign(Object.assign(Object.assign(Object.assign({ anchor: anchor.name, href: anchor.url }, (anchor.icon ? { icon: formatIcon(anchor.icon, anchor.iconType) } : {})), (typeof anchor.color === 'string'
+            ? { color: { light: anchor.color, dark: anchor.color } }
+            : {})), (anchor.isDefaultHidden ? { hidden: anchor.isDefaultHidden } : {})), (anchor.openapi ? { openapi: anchor.openapi } : {}))));
+    }
+    return globalConfig;
+};
+const findPagesForPrefix = (groups, division, versionName) => {
+    const matchedGroups = [];
+    const unmatchedGroups = [];
+    const prefix = division === null || division === void 0 ? void 0 : division.url;
+    if (isRemoteUrl(prefix)) {
+        return { matchedGroups, unmatchedGroups: groups };
+    }
+    groups.forEach((group) => {
+        const groupPages = [];
+        const unmatchedGroupPages = [];
+        const isGroupVersionMatch = group.version === versionName || group.version === undefined || !versionName;
+        if (isGroupVersionMatch) {
+            group.pages.forEach((page) => {
+                if (typeof page === 'string') {
+                    if (!prefix || page.startsWith(prefix)) {
+                        groupPages.push(page);
+                    }
+                    else {
+                        unmatchedGroupPages.push(page);
+                    }
+                }
+                else {
+                    const { matchedGroups: nestedGroups, unmatchedGroups: nestedUnmatchedGroups } = findPagesForPrefix([page], division, versionName);
+                    groupPages.push(...nestedGroups);
+                    if (nestedUnmatchedGroups.length) {
+                        unmatchedGroupPages.push(page);
+                    }
+                }
+            });
+        }
+        if (groupPages.length) {
+            matchedGroups.push(Object.assign(Object.assign({ group: group.group }, (group.icon ? { icon: formatIcon(group.icon, group.iconType) } : {})), { pages: groupPages }));
+        }
+        if (unmatchedGroupPages.length) {
+            unmatchedGroups.push(Object.assign(Object.assign({}, group), { pages: unmatchedGroupPages }));
+        }
+    });
+    return { matchedGroups, unmatchedGroups };
+};
+const processDivisions = (type, divisions = [], navigationGroups = [], shouldInsertRemainingGroups = false, versionName, config) => {
+    var _a, _b;
+    let remainingGroups = filterGroupsByVersion(navigationGroups, versionName);
+    const result = divisions
+        .map((division) => {
+        if (division.version !== versionName && versionName && division.version) {
+            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) {
+                baseDivision.icon = formatIcon(division.icon, division.iconType);
+            }
+            if (division.color) {
+                baseDivision.color = division.color;
+            }
+        }
+        const { matchedGroups, unmatchedGroups } = findPagesForPrefix(remainingGroups, division, versionName);
+        remainingGroups = unmatchedGroups;
+        if (matchedGroups.length) {
+            return Object.assign(Object.assign({}, omit(baseDivision, 'href')), { groups: matchedGroups });
+        }
+        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)
+                ? { tab: config.primaryTab.name, 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 }));
+        }
+    }
+    if (type === 'tabs') {
+        return { tabs: result, anchors: [], remainingGroups };
+    }
+    return { anchors: result, tabs: [], remainingGroups };
+};
+const findPagesForVersionOrLanguage = (groups, version, prefixes) => {
+    const matchedGroups = [];
+    groups.forEach((group) => {
+        const groupPages = [];
+        if (group.version === version || group.version === undefined) {
+            group.pages.forEach((page) => {
+                if (typeof page === 'string') {
+                    const isGatedByDivision = Object.entries(prefixes).some(([href, versions]) => versions.includes(version) && page.startsWith(href));
+                    if (isGatedByDivision || Object.keys(prefixes).some((href) => !page.startsWith(href))) {
+                        groupPages.push(page);
+                    }
+                }
+                else {
+                    const { matchedGroups: nestedGroups } = findPagesForVersionOrLanguage([page], version, prefixes);
+                    groupPages.push(...nestedGroups);
+                }
+            });
+        }
+        if (groupPages.length) {
+            matchedGroups.push(Object.assign(Object.assign({ group: group.group }, (group.icon ? { icon: formatIcon(group.icon, group.iconType) } : {})), { pages: groupPages }));
+        }
+    });
+    return { matchedGroups };
+};
+const processVersionsOrLanguages = (versions = [], navigationGroups = [], prefixes) => {
+    const isLocale = versions.every((version) => typeof version === 'object' && version.locale);
+    const result = versions.map((version) => {
+        if (isLocale && typeof version === 'object' && version.locale) {
+            const baseLanguage = {
+                language: version.locale,
+            };
+            const { matchedGroups } = findPagesForVersionOrLanguage(navigationGroups, version.name, prefixes);
+            return Object.assign(Object.assign({}, baseLanguage), { groups: matchedGroups });
+        }
+        else {
+            const versionName = typeof version === 'string' ? version : version.name;
+            const baseVersion = {
+                version: versionName,
+            };
+            const { matchedGroups } = findPagesForVersionOrLanguage(navigationGroups, versionName, prefixes);
+            return Object.assign(Object.assign({}, baseVersion), { groups: matchedGroups });
+        }
+    });
+    return {
+        isLocale,
+        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;
+    const { tabs: globalTabs, anchors: globalAnchors, versions: globalVersions, } = getGlobalDivisions(config);
+    // 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) {
+                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, 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 }));
+                }
+            }
+            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 };
+        }
+        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) } : {}))));
+            return { groups: parsedGroups };
+        }
+        return undefined;
+    };
+    if ((versions === null || versions === void 0 ? void 0 : versions.length) && !(globalVersions === null || globalVersions === void 0 ? void 0 : globalVersions.length)) {
+        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));
+            const tabPrefixes = tabs === null || tabs === void 0 ? void 0 : tabs.filter((tab) => tab.version === versionName && !isRemoteUrl(tab.url));
+            anchorPrefixes === null || anchorPrefixes === void 0 ? void 0 : anchorPrefixes.forEach((anchor) => (acc[anchor.url] = [...(acc[anchor.url] || []), versionName]));
+            tabPrefixes === null || tabPrefixes === void 0 ? void 0 : tabPrefixes.forEach((tab) => (acc[tab.url] = [...(acc[tab.url] || []), versionName]));
+            return acc;
+        }, {});
+        const { versions: versionsResult, isLocale } = processVersionsOrLanguages(versions, groups, prefixes);
+        versionsResult.forEach((version, index) => {
+            var _a;
+            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);
+            }
+        });
+        const navigationConfig = (isLocale ? { languages: versionsResult } : { versions: versionsResult });
+        if ((globalTabs === null || globalTabs === void 0 ? void 0 : globalTabs.length) || (globalAnchors === null || globalAnchors === void 0 ? void 0 : globalAnchors.length)) {
+            navigationConfig.global = Object.assign(Object.assign({}, ((globalTabs === null || globalTabs === void 0 ? void 0 : globalTabs.length) ? { tabs: globalTabs } : {})), ((globalAnchors === null || globalAnchors === void 0 ? void 0 : globalAnchors.length) ? { anchors: globalAnchors } : {}));
+        }
+        return navigationConfig;
+    }
+    const navigationConfig = (getUpdatedNavigation(groups, tabs, anchors, undefined, config) || {
+        groups: [],
+    });
+    if ((globalTabs === null || globalTabs === void 0 ? void 0 : globalTabs.length) || (globalAnchors === null || globalAnchors === void 0 ? void 0 : globalAnchors.length)) {
+        navigationConfig.global = Object.assign(Object.assign({}, ((globalTabs === null || globalTabs === void 0 ? void 0 : globalTabs.length) ? { tabs: globalTabs } : {})), ((globalAnchors === null || globalAnchors === void 0 ? void 0 : globalAnchors.length) ? { anchors: globalAnchors } : {}));
+    }
+    return navigationConfig;
+};

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

@@ -0,0 +1,6 @@
+import { ConfigType } from '@mintlify/models';
+import { z } from 'zod';
+import { docsConfigSchema } from '../schemas/v2/index.js';
+type ConfigV2Type = z.infer<typeof docsConfigSchema>;
+export declare function upgradeToDocsConfig(config: ConfigType): ConfigV2Type;
+export {};

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

@@ -0,0 +1,223 @@
+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 { capitalize } from 'lodash';
+import { updateNavigationToDocsConfig } from './updateNavigationToDocsConfig.js';
+function updateRounded(config) {
+    return config.rounded === 'sharp' ? 'sharp' : 'regular';
+}
+function updateEyebrows(config) {
+    var _a;
+    return ((_a = config.eyebrow) === null || _a === void 0 ? void 0 : _a.display) === 'section' ? 'section' : 'breadcrumbs';
+}
+function updateCodeblocks(config) {
+    var _a;
+    return ((_a = config.codeBlock) === null || _a === void 0 ? void 0 : _a.mode) === 'dark' ? 'dark' : 'auto';
+}
+function updateApiPlayground(config) {
+    var _a, _b, _c, _d;
+    const oldMode = (_b = (_a = config.api) === null || _a === void 0 ? void 0 : _a.playground) === null || _b === void 0 ? void 0 : _b.mode;
+    const disableProxy = (_d = (_c = config.api) === null || _c === void 0 ? void 0 : _c.playground) === null || _d === void 0 ? void 0 : _d.disableProxy;
+    if (!oldMode && disableProxy === undefined)
+        return undefined;
+    const display = (() => {
+        switch (oldMode) {
+            case 'show':
+                return 'interactive';
+            case 'hide':
+            case undefined:
+                return 'none';
+            default:
+                return oldMode;
+        }
+    })();
+    const proxy = disableProxy !== undefined ? !disableProxy : undefined;
+    return { display, proxy };
+}
+function updateTopbarPrimary(config) {
+    const ctaButton = config.topbarCtaButton;
+    if ((ctaButton === null || ctaButton === void 0 ? void 0 : ctaButton.type) === undefined || ctaButton.type === 'link') {
+        return {
+            type: 'button',
+            label: ctaButton === null || ctaButton === void 0 ? void 0 : ctaButton.name,
+            href: ctaButton === null || ctaButton === void 0 ? void 0 : ctaButton.url,
+        };
+    }
+    return {
+        type: 'github',
+        href: ctaButton.url,
+    };
+}
+function updateFont(config) {
+    const font = config.font;
+    if (!font)
+        return undefined;
+    if ('family' in font) {
+        return transformFontDetails(font);
+    }
+    function transformFontDetails(details) {
+        const { url } = details, rest = __rest(details, ["url"]);
+        return Object.assign(Object.assign({}, rest), (url ? { source: url } : {}));
+    }
+    if ('headings' in font) {
+        font.headings = transformFontDetails(font.headings);
+    }
+    if ('body' in font) {
+        font.body = transformFontDetails(font.body);
+    }
+    return font;
+}
+function updateFooterSocials(config) {
+    var _a, _b, _c;
+    if (!((_a = config.footer) === null || _a === void 0 ? void 0 : _a.socials) && !config.footerSocials)
+        return undefined;
+    const footerSocials = (_c = (_b = config.footer) === null || _b === void 0 ? void 0 : _b.socials) !== null && _c !== void 0 ? _c : config.footerSocials;
+    if (Array.isArray(footerSocials)) {
+        return footerSocials.reduce((acc, social) => {
+            acc[social.type] = social.url;
+            return acc;
+        }, {});
+    }
+    return footerSocials;
+}
+export function upgradeToDocsConfig(config) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v;
+    const fonts = updateFont(config);
+    const playground = updateApiPlayground(config);
+    const rounded = updateRounded(config);
+    const eyebrows = updateEyebrows(config);
+    const codeblocks = updateCodeblocks(config);
+    const v2Config = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ $schema: 'https://mintlify.com/docs.json', theme: 'mint', name: config.name, colors: {
+            primary: config.colors.primary,
+            light: config.colors.light,
+            dark: config.colors.dark,
+        }, favicon: config.favicon, navigation: updateNavigationToDocsConfig(config) }, (config.openapi ? { openapi: config.openapi } : {})), (config.rounded || config.eyebrow || config.codeBlock
+        ? {
+            styling: {
+                rounded,
+                eyebrows,
+                codeblocks,
+            },
+        }
+        : {})), { logo: config.logo }), (playground || ((_c = (_b = (_a = config.api) === null || _a === void 0 ? void 0 : _a.request) === null || _b === void 0 ? void 0 : _b.example) === null || _c === void 0 ? void 0 : _c.languages)
+        ? {
+            api: Object.assign(Object.assign({}, (playground
+                ? Object.assign({ display: playground.display }, (playground.proxy !== undefined ? { proxy: playground.proxy } : {})) : {})), (((_f = (_e = (_d = config.api) === null || _d === void 0 ? void 0 : _d.request) === null || _e === void 0 ? void 0 : _e.example) === null || _f === void 0 ? void 0 : _f.languages)
+                ? {
+                    examples: {
+                        languages: config.api.request.example.languages,
+                    },
+                }
+                : {})),
+        }
+        : {})), (config.modeToggle
+        ? {
+            appearance: {
+                default: (_g = config.modeToggle.default) !== null && _g !== void 0 ? _g : 'system',
+                strict: (_h = config.modeToggle.isHidden) !== null && _h !== void 0 ? _h : false,
+            },
+        }
+        : {})), (config.background || config.backgroundImage
+        ? {
+            background: Object.assign(Object.assign(Object.assign({}, (config.backgroundImage ? { image: config.backgroundImage } : {})), { decoration: (_k = (_j = config.background) === null || _j === void 0 ? void 0 : _j.style) !== null && _k !== void 0 ? _k : 'none' }), (config.colors.background
+                ? {
+                    color: {
+                        light: (_l = config.colors.background.light) !== null && _l !== void 0 ? _l : '',
+                        dark: (_m = config.colors.background.dark) !== null && _m !== void 0 ? _m : '',
+                    },
+                }
+                : {})),
+        }
+        : {})), { topbar: {
+            links: (_o = config.topbarLinks) === null || _o === void 0 ? void 0 : _o.map((item) => {
+                if (item.type === 'link' || item.type === undefined) {
+                    return {
+                        label: item.name,
+                        href: item.url,
+                    };
+                }
+                else {
+                    return {
+                        label: capitalize(item.type),
+                        href: item.url,
+                    };
+                }
+            }),
+            primary: updateTopbarPrimary(config),
+        } }), (config.feedback
+        ? {
+            feedback: Object.assign(Object.assign(Object.assign({}, (config.feedback.thumbsRating !== undefined
+                ? {
+                    thumbs: config.feedback.thumbsRating,
+                }
+                : {})), (config.feedback.suggestEdit !== undefined
+                ? {
+                    edits: config.feedback.suggestEdit,
+                }
+                : {})), (config.feedback.raiseIssue !== undefined
+                ? {
+                    issues: config.feedback.raiseIssue,
+                }
+                : {})),
+        }
+        : {})), (config.search
+        ? {
+            search: config.search,
+        }
+        : {})), (config.metadata || ((_p = config.seo) === null || _p === void 0 ? void 0 : _p.indexHiddenPages) !== undefined
+        ? {
+            seo: Object.assign(Object.assign({}, (config.metadata ? { metatags: config.metadata } : {})), { indexing: ((_q = config.seo) === null || _q === void 0 ? void 0 : _q.indexHiddenPages) ? 'navigable' : 'all' }),
+        }
+        : {})), (config.footer || config.footerSocials
+        ? {
+            footer: Object.assign(Object.assign({}, (((_r = config.footer) === null || _r === void 0 ? void 0 : _r.socials) || config.footerSocials
+                ? { socials: updateFooterSocials(config) }
+                : {})), (((_s = config.footer) === null || _s === void 0 ? void 0 : _s.links)
+                ? {
+                    links: config.footer.links.map((group) => {
+                        return {
+                            header: group.title,
+                            items: group.links.map((link) => {
+                                return {
+                                    label: link.label,
+                                    href: link.url,
+                                };
+                            }),
+                        };
+                    }),
+                }
+                : {})),
+        }
+        : {})), (config.integrations || config.analytics
+        ? {
+            integrations: Object.assign(Object.assign(Object.assign(Object.assign({}, config.analytics), (((_t = config.integrations) === null || _t === void 0 ? void 0 : _t.intercom)
+                ? {
+                    intercom: {
+                        appId: config.integrations.intercom,
+                    },
+                }
+                : {})), (((_u = config.integrations) === null || _u === void 0 ? void 0 : _u.frontchat)
+                ? {
+                    frontchat: {
+                        snippetId: config.integrations.frontchat,
+                    },
+                }
+                : {})), (((_v = config.integrations) === null || _v === void 0 ? void 0 : _v.osano)
+                ? {
+                    osano: {
+                        scriptSource: config.integrations.osano,
+                    },
+                }
+                : {})),
+        }
+        : {})), (fonts ? fonts : {}));
+    return v2Config;
+}