@mintlify/common 1.0.1022 → 1.0.1024

package/dist/index.d.ts

@@ -36,3 +36,4 @@ export * from './validateRedirectUrl.js';
 export * from './isAllowedRedirectUri.js';
 export * from './knownMcpClients.js';
 export * from './live-preview.js';
+export * from './paths/isEqualIgnoringLeadingSlash.js';

package/dist/index.js

@@ -36,3 +36,4 @@ export * from './validateRedirectUrl.js';
 export * from './isAllowedRedirectUri.js';
 export * from './knownMcpClients.js';
 export * from './live-preview.js';
+export * from './paths/isEqualIgnoringLeadingSlash.js';

package/dist/mdx/plugins/remark/remarkMermaid.js

@@ -2,6 +2,8 @@ import { visit } from 'unist-util-visit';
 import { MetaOptions } from '../rehype/rehypeCodeBlocks/metaOptions.js';
 const REACT_COMPONENT_NAME = 'Mermaid';
 const RESERVED_KEYS = ['placement', 'actions'];
+const MERMAID_PLACEMENTS = ['top-left', 'top-right', 'bottom-left', 'bottom-right'];
+const DEFAULT_MERMAID_PLACEMENT = 'bottom-right';
 export const remarkMermaid = () => (tree) => {
     var _a;
     const codeblocks = [];
@@ -49,11 +51,16 @@ export const remarkMermaid = () => (tree) => {
                 },
             ];
             if (placement) {
-                attributes.push({
-                    type: 'mdxJsxAttribute',
-                    name: 'placement',
-                    value: placement,
-                });
+                if (MERMAID_PLACEMENTS.includes(placement)) {
+                    attributes.push({
+                        type: 'mdxJsxAttribute',
+                        name: 'placement',
+                        value: placement,
+                    });
+                }
+                else {
+                    console.warn(`Invalid mermaid placement "${placement}" — expected one of: ${MERMAID_PLACEMENTS.join(', ')}. Falling back to ${DEFAULT_MERMAID_PLACEMENT}.`);
+                }
             }
             if (actions !== undefined) {
                 attributes.push({

package/dist/navigation/decoratedNavigationConfig.d.ts

@@ -0,0 +1,2 @@
+import { DecoratedNavigationConfig } from '@mintlify/validation';
+export declare const decoratedNavigationConfig: DecoratedNavigationConfig;

package/dist/navigation/decoratedNavigationConfig.js

@@ -0,0 +1,204 @@
+export const decoratedNavigationConfig = {
+    global: {
+        anchors: [
+            {
+                anchor: 'Documentation',
+                href: 'https://mintlify.com/docs',
+                icon: 'book-open-cover',
+            },
+            {
+                anchor: 'Community',
+                href: 'https://mintlify.com/community',
+                icon: 'slack',
+            },
+        ],
+    },
+    versions: [
+        {
+            version: 'v2',
+            anchors: [
+                {
+                    anchor: 'Documentation',
+                    icon: 'book-open',
+                    tabs: [
+                        {
+                            tab: 'Documentation',
+                            groups: [
+                                {
+                                    group: 'Get Started',
+                                    pages: [
+                                        {
+                                            title: 'Introduction',
+                                            href: '/introduction',
+                                        },
+                                        {
+                                            title: 'Quickstart',
+                                            href: '/quickstart',
+                                        },
+                                        {
+                                            title: 'Development',
+                                            href: '/development',
+                                        },
+                                        {
+                                            group: 'Editing',
+                                            pages: [
+                                                {
+                                                    title: 'Web Editor',
+                                                    href: '/web-editor',
+                                                },
+                                                {
+                                                    title: 'CLI',
+                                                    href: '/cli',
+                                                },
+                                            ],
+                                        },
+                                    ],
+                                },
+                                {
+                                    group: 'Essentials',
+                                    pages: [
+                                        {
+                                            title: 'Markdown',
+                                            href: '/essentials/markdown',
+                                        },
+                                        {
+                                            title: 'Code',
+                                            href: '/essentials/code',
+                                        },
+                                    ],
+                                },
+                            ],
+                        },
+                        {
+                            tab: 'API Reference',
+                            groups: [
+                                {
+                                    group: 'API Documentation',
+                                    pages: [
+                                        {
+                                            title: 'Introduction',
+                                            href: '/api-reference/introduction',
+                                        },
+                                    ],
+                                },
+                                {
+                                    group: 'Endpoint Examples',
+                                    pages: [
+                                        {
+                                            title: 'Get API',
+                                            href: '/api-reference/endpoint/get',
+                                        },
+                                        {
+                                            title: 'Create API',
+                                            href: '/api-reference/endpoint/create',
+                                        },
+                                        {
+                                            title: 'Delete API',
+                                            href: '/api-reference/endpoint/delete',
+                                        },
+                                    ],
+                                },
+                            ],
+                        },
+                    ],
+                },
+            ],
+        },
+        {
+            version: 'v1',
+            anchors: [
+                {
+                    anchor: 'Blog',
+                    href: 'https://mintlify.com/blog',
+                    icon: 'newspaper',
+                },
+                {
+                    anchor: 'Home',
+                    icon: 'book-open',
+                    tabs: [
+                        {
+                            tab: 'Documentation',
+                            groups: [
+                                {
+                                    group: 'Get Started',
+                                    pages: [
+                                        {
+                                            title: 'Introduction',
+                                            href: '/introduction',
+                                        },
+                                        {
+                                            title: 'Quickstart',
+                                            href: '/quickstart',
+                                        },
+                                        {
+                                            title: 'Development',
+                                            href: '/development',
+                                        },
+                                    ],
+                                },
+                            ],
+                        },
+                        {
+                            tab: 'Components',
+                            groups: [
+                                {
+                                    group: 'Organization Components',
+                                    pages: [
+                                        {
+                                            title: 'Accordions',
+                                            description: 'A dropdown component for toggling content',
+                                            icon: 'square-caret-down',
+                                            href: '/content/components/accordion',
+                                        },
+                                        {
+                                            title: 'Accordion Group',
+                                            description: 'Group multiple accordions into a single display.',
+                                            icon: 'table-rows',
+                                            href: '/content/components/accordion-group',
+                                        },
+                                    ],
+                                },
+                                {
+                                    group: 'Context Components',
+                                    pages: [
+                                        {
+                                            title: 'Callout Boxes',
+                                            description: 'Use callouts to create add eye-catching context to your content',
+                                            icon: 'circle-exclamation',
+                                            href: '/content/components/callouts',
+                                        },
+                                        {
+                                            title: 'Code Blocks',
+                                            description: 'Display code with optional syntax highlighting',
+                                            icon: 'code',
+                                            href: '/content/components/code',
+                                        },
+                                        {
+                                            title: 'Code Groups',
+                                            description: 'The CodeGroup component lets you combine code blocks in a display separated by tabs',
+                                            icon: 'rectangle-code',
+                                            href: '/content/components/code-group',
+                                        },
+                                    ],
+                                },
+                            ],
+                        },
+                    ],
+                },
+            ],
+        },
+        {
+            version: 'v0',
+            pages: [
+                {
+                    title: 'Hello World',
+                    href: '/hello-world',
+                },
+                {
+                    title: 'Hello World 2',
+                    href: '/hello-world-2',
+                },
+            ],
+        },
+    ],
+};

package/dist/navigation/filterDivisions.d.ts

@@ -0,0 +1,65 @@
+import { LocaleType } from '@mintlify/models';
+import { DecoratedAnchorConfig, DecoratedDropdownConfig, DecoratedLanguageConfig, DecoratedNavigationConfig, DecoratedPageOrGroupConfig, DecoratedTabConfig, DecoratedVersionConfig, DecoratedMenuItemConfig, DecoratedProductConfig } from '@mintlify/validation';
+import { DivisionMatch } from './updateFirstHrefInDivision.js';
+export type FilterDivisionsParams = {
+    currentPath: string;
+    currentVersion: string | undefined;
+    currentLanguage: LocaleType | undefined;
+    currentProduct?: string;
+    decoratedNav: DecoratedNavigationConfig | DecoratedPageOrGroupConfig | undefined;
+    userGroups: Set<string>;
+    isPreview?: boolean;
+    shouldUseDivisionMatch: boolean;
+    cache: {
+        dropdownCache: Map<string, string>;
+    };
+};
+export type DivisionState = {
+    name: string;
+    href: string;
+    isActive: boolean;
+    isGlobal: boolean;
+};
+export declare const isActiveDivision: <T extends object>(item: T) => item is T & {
+    isActive: true;
+};
+export type TabsResult = DecoratedTabConfig & DivisionState & {
+    menu?: MenuResult[];
+};
+export type AnchorsResult = DecoratedAnchorConfig & DivisionState;
+export type VersionsResult = DecoratedVersionConfig & DivisionState;
+export type LanguagesResult = DecoratedLanguageConfig & DivisionState;
+export type DropdownsResult = DecoratedDropdownConfig & DivisionState;
+export type MenuResult = DecoratedMenuItemConfig & DivisionState;
+export type ProductsResult = DecoratedProductConfig & DivisionState & {
+    menu?: MenuResult[];
+};
+export type FilterDivisionsResult = {
+    tabs: TabsResult[];
+    anchors: AnchorsResult[];
+    versions: VersionsResult[];
+    languages: LanguagesResult[];
+    dropdowns: DropdownsResult[];
+    products: ProductsResult[];
+    groupsOrPages: DecoratedPageOrGroupConfig[];
+    firstHrefInVersion: Map<string | undefined, DivisionMatch>;
+    firstHrefInLanguage: Map<LocaleType | undefined, DivisionMatch>;
+};
+export type NavigationDivisions = {
+    tabs: Array<TabsResult>;
+    anchors: Array<AnchorsResult>;
+    versions: Array<VersionsResult>;
+    languages: Array<LanguagesResult>;
+    dropdowns: Array<DropdownsResult>;
+    products: Array<ProductsResult>;
+    menu: Array<MenuResult>;
+};
+export declare const filterDivisions: ({ currentPath, currentVersion, currentLanguage, currentProduct, decoratedNav, userGroups, shouldUseDivisionMatch, cache, isPreview, }: FilterDivisionsParams) => FilterDivisionsResult;
+/**
+ * TODO: we should add cache for versions and languages in the future
+ * Generate a cache key for the dropdowns
+ * @param dropdowns - the dropdowns to generate a cache key for
+ * @param parentContext - optional parent context to make the key unique across different parent divisions
+ * @returns the cache key
+ */
+export declare function generateCacheKey<T extends 'dropdowns'>(divisions: T extends 'dropdowns' ? DecoratedDropdownConfig[] : never, parentContext?: string): string;