@mintlify/validation 0.1.638 → 0.1.640

package/dist/editor-navigation/conversion/common.d.ts

@@ -0,0 +1,29 @@
+import { GroupConfig, TabConfig, AnchorConfig, LanguageConfig, VersionConfig, DropdownConfig, ProductConfig, MenuItemConfig } from '../../mint-config/schemas/v2/properties/index.js';
+import type { NavigationTree, NavigationNode, NavigationNodeType } from '../types.js';
+export type IdGenerator = () => string;
+export type ParentInfo = {
+    id: string | 0;
+    order: number;
+};
+export type TreeNodeMap = Map<string | 0, NavigationNode[]>;
+export declare const createIdGenerator: () => IdGenerator;
+export declare function isProductConfig(value: unknown): value is ProductConfig;
+export declare function isLanguageConfig(value: unknown): value is LanguageConfig;
+export declare function isVersionConfig(value: unknown): value is VersionConfig;
+export declare function isTabConfig(value: unknown): value is TabConfig;
+export declare function isMenuItemConfig(value: unknown): value is MenuItemConfig;
+export declare function isDropdownConfig(value: unknown): value is DropdownConfig;
+export declare function isAnchorConfig(value: unknown): value is AnchorConfig;
+export declare function isGroupConfig(value: unknown): value is GroupConfig;
+export declare function buildChildrenMap(tree: NavigationTree): TreeNodeMap;
+export declare function mapNodesOfType<TNode extends NavigationNode, TConfig>(nodes: NavigationNode[], type: NavigationNodeType, childrenMap: TreeNodeMap, mapper: (node: TNode, childrenMap: TreeNodeMap) => TConfig): TConfig[];
+export declare function assignIfPresent<K extends string>(target: Partial<Record<K, unknown>>, source: Partial<Record<K, unknown>>, keys: readonly K[]): void;
+export declare const COMMON_DIVISION_NODE_DATA_FIELDS: readonly ["hidden", "href", "asyncapi", "openapi", "global"];
+export declare const TAB_NODE_DATA_FIELDS: readonly ["icon", "hidden", "href", "asyncapi", "openapi", "global"];
+export declare const ANCHOR_NODE_DATA_FIELDS: readonly ["icon", "color", "hidden", "href", "asyncapi", "openapi", "global"];
+export declare const LANGUAGE_NODE_DATA_FIELDS: readonly ["default", "hidden", "href", "asyncapi", "openapi", "global"];
+export declare const VERSION_NODE_DATA_FIELDS: readonly ["default", "hidden", "href", "asyncapi", "openapi", "global"];
+export declare const DROPDOWN_NODE_DATA_FIELDS: readonly ["icon", "color", "description", "hidden", "href", "asyncapi", "openapi", "global"];
+export declare const PRODUCT_NODE_DATA_FIELDS: readonly ["name", "icon", "color", "description", "hidden", "href", "asyncapi", "openapi", "global"];
+export declare const MENU_ITEM_NODE_DATA_FIELDS: readonly ["icon", "description", "hidden", "href", "asyncapi", "openapi", "global"];
+export declare const GROUP_NODE_DATA_FIELDS: readonly ["icon", "hidden", "tag", "expanded", "public", "root", "asyncapi", "openapi"];

package/dist/editor-navigation/conversion/common.js

@@ -0,0 +1,95 @@
+import { generateNodeId } from '../utils.js';
+export const createIdGenerator = () => {
+    let counter = 0;
+    return () => generateNodeId(counter++);
+};
+export function isProductConfig(value) {
+    return typeof value === 'object' && value !== null && 'product' in value;
+}
+export function isLanguageConfig(value) {
+    return typeof value === 'object' && value !== null && 'language' in value;
+}
+export function isVersionConfig(value) {
+    return typeof value === 'object' && value !== null && 'version' in value;
+}
+export function isTabConfig(value) {
+    return typeof value === 'object' && value !== null && 'tab' in value;
+}
+export function isMenuItemConfig(value) {
+    return typeof value === 'object' && value !== null && 'item' in value;
+}
+export function isDropdownConfig(value) {
+    return typeof value === 'object' && value !== null && 'dropdown' in value;
+}
+export function isAnchorConfig(value) {
+    return typeof value === 'object' && value !== null && 'anchor' in value;
+}
+export function isGroupConfig(value) {
+    return typeof value === 'object' && value !== null && 'group' in value;
+}
+export function buildChildrenMap(tree) {
+    const childrenMap = new Map();
+    tree.forEach((node) => {
+        const children = childrenMap.get(node.parent) || [];
+        children.push(node);
+        childrenMap.set(node.parent, children);
+    });
+    childrenMap.forEach((children) => {
+        children.sort((a, b) => a.order - b.order);
+    });
+    return childrenMap;
+}
+export function mapNodesOfType(nodes, type, childrenMap, mapper) {
+    return nodes.filter((n) => n.type === type).map((node) => mapper(node, childrenMap));
+}
+export function assignIfPresent(target, source, keys) {
+    for (const key of keys) {
+        const value = source[key];
+        if (value !== undefined) {
+            target[key] = value;
+        }
+    }
+}
+export const COMMON_DIVISION_NODE_DATA_FIELDS = [
+    'hidden',
+    'href',
+    'asyncapi',
+    'openapi',
+    'global',
+];
+export const TAB_NODE_DATA_FIELDS = ['icon', ...COMMON_DIVISION_NODE_DATA_FIELDS];
+export const ANCHOR_NODE_DATA_FIELDS = [
+    'icon',
+    'color',
+    ...COMMON_DIVISION_NODE_DATA_FIELDS,
+];
+export const LANGUAGE_NODE_DATA_FIELDS = ['default', ...COMMON_DIVISION_NODE_DATA_FIELDS];
+export const VERSION_NODE_DATA_FIELDS = ['default', ...COMMON_DIVISION_NODE_DATA_FIELDS];
+export const DROPDOWN_NODE_DATA_FIELDS = [
+    'icon',
+    'color',
+    'description',
+    ...COMMON_DIVISION_NODE_DATA_FIELDS,
+];
+export const PRODUCT_NODE_DATA_FIELDS = [
+    'name',
+    'icon',
+    'color',
+    'description',
+    ...COMMON_DIVISION_NODE_DATA_FIELDS,
+];
+export const MENU_ITEM_NODE_DATA_FIELDS = [
+    'icon',
+    'description',
+    ...COMMON_DIVISION_NODE_DATA_FIELDS,
+];
+export const GROUP_NODE_DATA_FIELDS = [
+    'icon',
+    'hidden',
+    'tag',
+    'expanded',
+    'public',
+    'root',
+    'asyncapi',
+    'openapi',
+];

package/dist/editor-navigation/conversion/docsjson-to-tree.d.ts

@@ -0,0 +1,3 @@
+import { NavigationConfig } from '../../mint-config/schemas/v2/properties/index.js';
+import type { NavigationTree } from '../types.js';
+export declare function docsConfigToNavigationTree(navigation: NavigationConfig): NavigationTree;

package/dist/editor-navigation/conversion/docsjson-to-tree.js

@@ -0,0 +1,419 @@
+import traverse from 'neotraverse';
+import { isGlobalNode } from '../schema.js';
+import { createIdGenerator, isProductConfig, isLanguageConfig, isVersionConfig, isTabConfig, isMenuItemConfig, isDropdownConfig, isAnchorConfig, isGroupConfig, } from './common.js';
+function pickDefined(obj) {
+    const result = {};
+    for (const key in obj) {
+        if (Object.prototype.hasOwnProperty.call(obj, key)) {
+            const value = obj[key];
+            if (value !== undefined && value !== null) {
+                result[key] = value;
+            }
+        }
+    }
+    return result;
+}
+const NODE_FACTORIES = {
+    products: ({ value, parent, generateId, getNextOrder }) => {
+        if (!isProductConfig(value))
+            return null;
+        const nodeId = generateId();
+        const productNode = {
+            id: nodeId,
+            parent: parent.id,
+            order: getNextOrder(parent.id),
+            text: value.name || value.product,
+            type: 'product',
+            isHidden: value.hidden === true,
+            data: Object.assign({ product: value.product }, pickDefined({
+                name: value.name,
+                icon: value.icon,
+                color: value.color,
+                description: value.description,
+                hidden: value.hidden,
+                openapi: 'openapi' in value ? value.openapi : undefined,
+                asyncapi: 'asyncapi' in value ? value.asyncapi : undefined,
+            })),
+        };
+        return productNode;
+    },
+    languages: ({ value, parent, generateId, getNextOrder }) => {
+        if (!isLanguageConfig(value))
+            return null;
+        const nodeId = generateId();
+        const langNode = {
+            id: nodeId,
+            parent: parent.id,
+            order: getNextOrder(parent.id),
+            text: value.language,
+            type: 'language',
+            isHidden: value.hidden === true,
+            data: Object.assign({ language: value.language }, pickDefined({
+                default: value.default,
+                hidden: value.hidden,
+                openapi: 'openapi' in value ? value.openapi : undefined,
+                asyncapi: 'asyncapi' in value ? value.asyncapi : undefined,
+            })),
+        };
+        return langNode;
+    },
+    versions: ({ value, parent, generateId, getNextOrder }) => {
+        if (!isVersionConfig(value))
+            return null;
+        const nodeId = generateId();
+        const verNode = {
+            id: nodeId,
+            parent: parent.id,
+            order: getNextOrder(parent.id),
+            text: value.version,
+            type: 'version',
+            isHidden: value.hidden === true,
+            data: Object.assign({ version: value.version }, pickDefined({
+                default: value.default,
+                hidden: value.hidden,
+                openapi: 'openapi' in value ? value.openapi : undefined,
+                asyncapi: 'asyncapi' in value ? value.asyncapi : undefined,
+            })),
+        };
+        return verNode;
+    },
+    tabs: ({ value, parent, generateId, getNextOrder }) => {
+        if (!isTabConfig(value))
+            return null;
+        const nodeId = generateId();
+        const tabNode = {
+            id: nodeId,
+            parent: parent.id,
+            order: getNextOrder(parent.id),
+            text: value.tab,
+            type: 'tab',
+            isHidden: value.hidden === true,
+            data: Object.assign({ tab: value.tab }, pickDefined({
+                icon: value.icon,
+                hidden: value.hidden,
+                href: 'href' in value ? value.href : undefined,
+                openapi: 'openapi' in value ? value.openapi : undefined,
+                asyncapi: 'asyncapi' in value ? value.asyncapi : undefined,
+            })),
+        };
+        return tabNode;
+    },
+    dropdowns: ({ value, parent, generateId, getNextOrder }) => {
+        if (!isDropdownConfig(value))
+            return null;
+        const nodeId = generateId();
+        const dropdownNode = {
+            id: nodeId,
+            parent: parent.id,
+            order: getNextOrder(parent.id),
+            text: value.dropdown,
+            type: 'dropdown',
+            isHidden: value.hidden === true,
+            data: Object.assign({ dropdown: value.dropdown }, pickDefined({
+                icon: value.icon,
+                color: value.color,
+                description: value.description,
+                hidden: value.hidden,
+                openapi: 'openapi' in value ? value.openapi : undefined,
+                asyncapi: 'asyncapi' in value ? value.asyncapi : undefined,
+            })),
+        };
+        return dropdownNode;
+    },
+    anchors: ({ value, parent, generateId, getNextOrder }) => {
+        if (!isAnchorConfig(value))
+            return null;
+        const nodeId = generateId();
+        const anchorNode = {
+            id: nodeId,
+            parent: parent.id,
+            order: getNextOrder(parent.id),
+            text: value.anchor,
+            type: 'anchor',
+            isHidden: value.hidden === true,
+            data: Object.assign({ anchor: value.anchor }, pickDefined({
+                icon: value.icon,
+                color: value.color,
+                hidden: value.hidden,
+                href: 'href' in value ? value.href : undefined,
+                openapi: 'openapi' in value ? value.openapi : undefined,
+                asyncapi: 'asyncapi' in value ? value.asyncapi : undefined,
+            })),
+        };
+        return anchorNode;
+    },
+    menu: ({ value, parent, generateId, getNextOrder }) => {
+        if (!isMenuItemConfig(value))
+            return null;
+        const nodeId = generateId();
+        const menuItemNode = {
+            id: nodeId,
+            parent: parent.id,
+            order: getNextOrder(parent.id),
+            text: value.item,
+            type: 'item',
+            isHidden: value.hidden === true,
+            data: Object.assign({ item: value.item }, pickDefined({
+                icon: value.icon,
+                description: value.description,
+                hidden: value.hidden,
+                href: 'href' in value ? value.href : undefined,
+                openapi: 'openapi' in value ? value.openapi : undefined,
+                asyncapi: 'asyncapi' in value ? value.asyncapi : undefined,
+            })),
+        };
+        return menuItemNode;
+    },
+    groups: ({ value, parent, generateId, getNextOrder }) => {
+        if (!isGroupConfig(value))
+            return null;
+        const nodeId = generateId();
+        const groupNode = {
+            id: nodeId,
+            parent: parent.id,
+            order: getNextOrder(parent.id),
+            text: value.group,
+            type: 'group',
+            isHidden: value.hidden === true,
+            data: Object.assign({ group: value.group }, pickDefined({
+                icon: value.icon,
+                hidden: value.hidden,
+                tag: value.tag,
+                expanded: value.expanded,
+                public: value.public,
+                root: value.root,
+                openapi: 'openapi' in value ? value.openapi : undefined,
+                asyncapi: 'asyncapi' in value ? value.asyncapi : undefined,
+            })),
+        };
+        return groupNode;
+    },
+};
+const GLOBAL_NODE_FACTORIES = {
+    languages: ({ value, parent, generateId, getNextOrder }) => {
+        if (!isLanguageConfig(value))
+            return null;
+        return {
+            id: generateId(),
+            parent: parent.id,
+            order: getNextOrder(parent.id),
+            text: value.language,
+            type: 'language',
+            isHidden: value.hidden === true,
+            data: Object.assign({ language: value.language, isGlobal: true }, pickDefined({
+                default: value.default,
+                hidden: value.hidden,
+                href: 'href' in value ? value.href : undefined,
+            })),
+        };
+    },
+    versions: ({ value, parent, generateId, getNextOrder }) => {
+        if (!isVersionConfig(value))
+            return null;
+        return {
+            id: generateId(),
+            parent: parent.id,
+            order: getNextOrder(parent.id),
+            text: value.version,
+            type: 'version',
+            isHidden: value.hidden === true,
+            data: Object.assign({ version: value.version, isGlobal: true }, pickDefined({
+                default: value.default,
+                hidden: value.hidden,
+                href: 'href' in value ? value.href : undefined,
+            })),
+        };
+    },
+    tabs: ({ value, parent, generateId, getNextOrder }) => {
+        if (!isTabConfig(value))
+            return null;
+        return {
+            id: generateId(),
+            parent: parent.id,
+            order: getNextOrder(parent.id),
+            text: value.tab,
+            type: 'tab',
+            isHidden: value.hidden === true,
+            data: Object.assign({ tab: value.tab, isGlobal: true }, pickDefined({
+                icon: value.icon,
+                hidden: value.hidden,
+                href: 'href' in value ? value.href : undefined,
+            })),
+        };
+    },
+    dropdowns: ({ value, parent, generateId, getNextOrder }) => {
+        if (!isDropdownConfig(value))
+            return null;
+        return {
+            id: generateId(),
+            parent: parent.id,
+            order: getNextOrder(parent.id),
+            text: value.dropdown,
+            type: 'dropdown',
+            isHidden: value.hidden === true,
+            data: Object.assign({ dropdown: value.dropdown, isGlobal: true }, pickDefined({
+                icon: value.icon,
+                color: value.color,
+                description: value.description,
+                hidden: value.hidden,
+                href: 'href' in value ? value.href : undefined,
+            })),
+        };
+    },
+    anchors: ({ value, parent, generateId, getNextOrder }) => {
+        if (!isAnchorConfig(value))
+            return null;
+        return {
+            id: generateId(),
+            parent: parent.id,
+            order: getNextOrder(parent.id),
+            text: value.anchor,
+            type: 'anchor',
+            isHidden: value.hidden === true,
+            data: Object.assign({ anchor: value.anchor, isGlobal: true }, pickDefined({
+                icon: value.icon,
+                color: value.color,
+                hidden: value.hidden,
+                href: 'href' in value ? value.href : undefined,
+            })),
+        };
+    },
+    products: ({ value, parent, generateId, getNextOrder }) => {
+        if (!isProductConfig(value))
+            return null;
+        return {
+            id: generateId(),
+            parent: parent.id,
+            order: getNextOrder(parent.id),
+            text: value.name || value.product,
+            type: 'product',
+            isHidden: value.hidden === true,
+            data: Object.assign({ product: value.product, isGlobal: true }, pickDefined({
+                name: value.name,
+                icon: value.icon,
+                color: value.color,
+                description: value.description,
+                hidden: value.hidden,
+                href: 'href' in value ? value.href : undefined,
+            })),
+        };
+    },
+};
+export function docsConfigToNavigationTree(navigation) {
+    const nodes = [];
+    const generateId = createIdGenerator();
+    const parentStack = [{ id: 0, order: 0 }];
+    const orderByParent = new Map();
+    const getNextOrder = (parentId) => {
+        var _a;
+        const current = (_a = orderByParent.get(parentId)) !== null && _a !== void 0 ? _a : 0;
+        orderByParent.set(parentId, current + 1);
+        return current;
+    };
+    const getCurrentParent = () => {
+        var _a;
+        return (_a = parentStack[parentStack.length - 1]) !== null && _a !== void 0 ? _a : { id: 0, order: 0 };
+    };
+    traverse(navigation).forEach(function (value) {
+        var _a, _b, _c;
+        const parentKey = (_a = this.parent) === null || _a === void 0 ? void 0 : _a.key;
+        const grandparentKey = (_c = (_b = this.parent) === null || _b === void 0 ? void 0 : _b.parent) === null || _c === void 0 ? void 0 : _c.key;
+        const currentParent = getCurrentParent();
+        if (!parentKey || typeof parentKey !== 'string')
+            return;
+        if (grandparentKey === 'global' && typeof parentKey === 'string') {
+            const globalFactory = GLOBAL_NODE_FACTORIES[parentKey];
+            if (globalFactory) {
+                const node = globalFactory({
+                    value,
+                    parent: currentParent,
+                    generateId,
+                    getNextOrder,
+                });
+                if (node) {
+                    nodes.push(node);
+                }
+            }
+            return;
+        }
+        if (parentKey === 'pages') {
+            if (typeof value === 'string') {
+                const nodeId = generateId();
+                const text = value.split('/').pop() || value;
+                const node = {
+                    id: nodeId,
+                    parent: currentParent.id,
+                    order: getNextOrder(currentParent.id),
+                    text,
+                    type: 'page',
+                    data: { title: text, href: value },
+                };
+                nodes.push(node);
+            }
+            else if (isGroupConfig(value)) {
+                const nodeId = generateId();
+                const groupNode = {
+                    id: nodeId,
+                    parent: currentParent.id,
+                    order: getNextOrder(currentParent.id),
+                    text: value.group,
+                    type: 'group',
+                    isHidden: value.hidden === true,
+                    data: Object.assign({ group: value.group, fromPages: true }, pickDefined({
+                        icon: value.icon,
+                        hidden: value.hidden,
+                        tag: value.tag,
+                        expanded: value.expanded,
+                        public: value.public,
+                        root: value.root,
+                        openapi: 'openapi' in value ? value.openapi : undefined,
+                        asyncapi: 'asyncapi' in value ? value.asyncapi : undefined,
+                    })),
+                };
+                nodes.push(groupNode);
+                parentStack.push({ id: nodeId, order: 0 });
+                this.after(() => parentStack.pop());
+            }
+            return;
+        }
+        const factory = NODE_FACTORIES[parentKey];
+        if (!factory)
+            return;
+        const node = factory({
+            value,
+            parent: currentParent,
+            generateId,
+            getNextOrder,
+        });
+        if (!node)
+            return;
+        nodes.push(node);
+        parentStack.push({ id: node.id, order: 0 });
+        this.after(() => parentStack.pop());
+    });
+    reorderGlobalNodesFirst(nodes);
+    return nodes;
+}
+function reorderGlobalNodesFirst(nodes) {
+    var _a;
+    const nodesByParent = new Map();
+    for (const node of nodes) {
+        const siblings = (_a = nodesByParent.get(node.parent)) !== null && _a !== void 0 ? _a : [];
+        siblings.push(node);
+        nodesByParent.set(node.parent, siblings);
+    }
+    for (const siblings of nodesByParent.values()) {
+        siblings.sort((a, b) => {
+            const aIsGlobal = isGlobalNode(a);
+            const bIsGlobal = isGlobalNode(b);
+            if (aIsGlobal && !bIsGlobal)
+                return -1;
+            if (!aIsGlobal && bIsGlobal)
+                return 1;
+            return a.order - b.order;
+        });
+        siblings.forEach((node, index) => {
+            node.order = index;
+        });
+    }
+}

package/dist/editor-navigation/conversion/index.d.ts

@@ -0,0 +1,3 @@
+export * from './common.js';
+export { docsConfigToNavigationTree } from './docsjson-to-tree.js';
+export { navigationTreeToDocsConfig } from './tree-to-docsjson.js';

package/dist/editor-navigation/conversion/index.js

@@ -0,0 +1,3 @@
+export * from './common.js';
+export { docsConfigToNavigationTree } from './docsjson-to-tree.js';
+export { navigationTreeToDocsConfig } from './tree-to-docsjson.js';

package/dist/editor-navigation/conversion/tree-to-docsjson.d.ts

@@ -0,0 +1,3 @@
+import { NavigationConfig } from '../../mint-config/schemas/v2/properties/index.js';
+import type { NavigationTree } from '../types.js';
+export declare function navigationTreeToDocsConfig(tree: NavigationTree): NavigationConfig;