@mintlify/common 1.0.106 → 1.0.108

package/dist/mdx/getMDXOptions.d.ts

@@ -1,6 +1,8 @@
+import type { SerializeOptions } from '@mintlify/mdx';
 import type { MintConfig, PageMetaTags } from '@mintlify/models';
 import type { Root } from 'remark-mdx';
 import type { Pluggable } from 'unified';
+import { MdxExtracts } from '../types/mdx/MdxExtracts.js';
 type MDXOptionsData = {
     snippetTreeMap: Record<string, Root>;
     allowedComponents: string[];
@@ -8,9 +10,10 @@ type MDXOptionsData = {
     mintConfig?: MintConfig;
     subdomain?: string;
 };
-export declare const getMDXOptions: ({ data, remarkPlugins, rehypePlugins, }: {
+export declare const getMDXOptions: ({ data, remarkPlugins, rehypePlugins, mdxExtracts, }: {
     data: MDXOptionsData;
     remarkPlugins?: Pluggable[] | undefined;
     rehypePlugins?: Pluggable[] | undefined;
-}) => SerializeOptions;
+    mdxExtracts?: MdxExtracts | undefined;
+}) => SerializeOptions['mdxOptions'];
 export {};

package/dist/mdx/getMDXOptions.js

@@ -1,30 +1,31 @@
-import { rehypeCodeBlocks, rehypeLayouts, rehypeListRoles, rehypeMdxExtractExamples, rehypeMdxInjectEndpoint, rehypeRawComponents, rehypeZoomImages, remarkFrames, remarkMdxInjectSnippets, remarkMdxRemoveUnusedVariables, remarkRemoveImports, remarkTableOfContents, } from './plugins/index.js';
+import { rehypeCodeBlocks, rehypeMdxExtractExamples, rehypeMdxExtractEndpoint, rehypeRawComponents, rehypeZoomImages, remarkFrames, remarkMdxInjectSnippets, remarkMdxRemoveUnusedVariables, remarkRemoveImports, remarkExtractTableOfContents, } from './plugins/index.js';
 import rehypeMdxRemoveUnknownJsx from './plugins/rehype/rehypeMdxRemoveUnknownJsx/index.js';
 import { remarkMermaid } from './plugins/remark/remarkMermaid.js';
-export const getMDXOptions = ({ data, remarkPlugins = [], rehypePlugins = [], }) => {
+// avoid running extractors unnecessarily
+const rehypeExtractors = (mdxExtracts, data) => {
+    if (!mdxExtracts)
+        return [];
+    return [
+        [rehypeMdxExtractExamples, mdxExtracts],
+        [rehypeMdxExtractEndpoint, data.pageMetadata, data.mintConfig, mdxExtracts],
+    ];
+};
+export const getMDXOptions = ({ data, remarkPlugins = [], rehypePlugins = [], mdxExtracts, }) => {
     return {
         remarkPlugins: [
             [remarkMdxInjectSnippets, data.snippetTreeMap],
+            [remarkExtractTableOfContents, mdxExtracts],
             remarkMdxRemoveUnusedVariables,
             remarkFrames,
-            remarkTableOfContents,
             remarkRemoveImports,
             remarkMermaid,
             ...remarkPlugins,
         ],
         rehypePlugins: [
-            [
-                rehypeMdxRemoveUnknownJsx,
-                {
-                    allowedComponents: data.allowedComponents,
-                },
-            ],
+            [rehypeMdxRemoveUnknownJsx, data.allowedComponents],
             rehypeCodeBlocks,
-            rehypeListRoles,
-            rehypeMdxExtractExamples,
-            [rehypeMdxInjectEndpoint, data.pageMetadata, data.mintConfig || {}],
+            ...rehypeExtractors(mdxExtracts, data),
             rehypeRawComponents,
-            rehypeLayouts,
             rehypeZoomImages,
             ...rehypePlugins,
         ],

package/dist/mdx/lib/remark-utils.d.ts

@@ -1,13 +1,6 @@
-export function addImportString(tree: any, jsx: any): void;
-export function addImport(tree: any, mod: any, name: any): string;
-export function addDefaultImport(tree: any, mod: any, name: any): string;
-export function addExport(tree: any, name: any, value: any): void;
-export function normalizeTokens(tokens: any): any[][];
-export function simplifyToken(token: any): string | any[];
 export function createMdxJsxAttribute(key: any, value: any): {
     type: string;
     name: any;
     value: any;
 };
 export function toMdxJsxFlowElement(input: any): import("mdast").Content | undefined;
-export function getEsmNode(input: any): import("mdast").Content | undefined;

package/dist/mdx/lib/remark-utils.js

@@ -1,9 +1,7 @@
 import * as acorn from 'acorn';
 import { fromMarkdown } from 'mdast-util-from-markdown';
 import { mdxJsxFromMarkdown } from 'mdast-util-mdx-jsx';
-import { mdxjsEsmFromMarkdown } from 'mdast-util-mdxjs-esm';
 import { mdxJsx } from 'micromark-extension-mdx-jsx';
-import { mdxjsEsm } from 'micromark-extension-mdxjs-esm';
 export const createMdxJsxAttribute = (key, value) => {
     return {
         type: 'mdxJsxAttribute',
@@ -18,119 +16,3 @@ export const toMdxJsxFlowElement = (input) => {
     });
     return tree.children[0];
 };
-export const getEsmNode = (input) => {
-    const tree = fromMarkdown(input, {
-        extensions: [mdxjsEsm({ acorn, addResult: true })],
-        mdastExtensions: [mdxjsEsmFromMarkdown],
-    });
-    return tree.children[0];
-};
-export function addImportString(tree, jsx) {
-    tree.children.unshift(getEsmNode(jsx));
-}
-export function addImport(tree, mod, name) {
-    const jsx = `import { ${name} as _${name} } from '${mod}'`;
-    tree.children.unshift(getEsmNode(jsx));
-    return `_${name}`;
-}
-export function addDefaultImport(tree, mod, name) {
-    const jsx = `import _${name} from '${mod}'`;
-    tree.children.unshift(getEsmNode(jsx));
-    return `_${name}`;
-}
-export function addExport(tree, name, value) {
-    const jsx = `export const ${name} = ${JSON.stringify(value)}`;
-    tree.children.push(getEsmNode(jsx));
-}
-const newlineRe = /\r\n|\r|\n/;
-// Empty lines need to contain a single empty token, denoted with { empty: true }
-function normalizeEmptyLines(line) {
-    if (line.length === 0) {
-        line.push({
-            types: ['plain'],
-            content: '',
-            empty: true,
-        });
-    }
-    else if (line.length === 1 && line[0].content === '') {
-        line[0].empty = true;
-    }
-}
-function appendTypes(types, add) {
-    const typesSize = types.length;
-    if (typesSize > 0 && types[typesSize - 1] === add) {
-        return types;
-    }
-    return types.concat(add);
-}
-// Takes an array of Prism's tokens and groups them by line, turning plain
-// strings into tokens as well. Tokens can become recursive in some cases,
-// which means that their types are concatenated. Plain-string tokens however
-// are always of type "plain".
-// This is not recursive to avoid exceeding the call-stack limit, since it's unclear
-// how nested Prism's tokens can become
-export function normalizeTokens(tokens) {
-    const typeArrStack = [[]];
-    const tokenArrStack = [tokens];
-    const tokenArrIndexStack = [0];
-    const tokenArrSizeStack = [tokens.length];
-    let i = 0;
-    let stackIndex = 0;
-    let currentLine = [];
-    const acc = [currentLine];
-    while (stackIndex > -1) {
-        while ((i = tokenArrIndexStack[stackIndex]++) < tokenArrSizeStack[stackIndex]) {
-            let content;
-            let types = typeArrStack[stackIndex];
-            const tokenArr = tokenArrStack[stackIndex];
-            const token = tokenArr[i];
-            // Determine content and append type to types if necessary
-            if (typeof token === 'string') {
-                types = stackIndex > 0 ? types : ['plain'];
-                content = token;
-            }
-            else {
-                types = appendTypes(types, token.type);
-                if (token.alias) {
-                    types = appendTypes(types, token.alias);
-                }
-                content = token.content;
-            }
-            // If token.content is an array, increase the stack depth and repeat this while-loop
-            if (typeof content !== 'string') {
-                stackIndex++;
-                typeArrStack.push(types);
-                tokenArrStack.push(content);
-                tokenArrIndexStack.push(0);
-                tokenArrSizeStack.push(content.length);
-                continue;
-            }
-            // Split by newlines
-            const splitByNewlines = content.split(newlineRe);
-            const newlineCount = splitByNewlines.length;
-            currentLine.push({ types, content: splitByNewlines[0] });
-            // Create a new line for each string on a new line
-            for (let i = 1; i < newlineCount; i++) {
-                normalizeEmptyLines(currentLine);
-                acc.push((currentLine = []));
-                currentLine.push({ types, content: splitByNewlines[i] });
-            }
-        }
-        // Decreate the stack depth
-        stackIndex--;
-        typeArrStack.pop();
-        tokenArrStack.pop();
-        tokenArrIndexStack.pop();
-        tokenArrSizeStack.pop();
-    }
-    normalizeEmptyLines(currentLine);
-    return acc;
-}
-export function simplifyToken(token) {
-    if (typeof token === 'string')
-        return token;
-    return [
-        token.type,
-        Array.isArray(token.content) ? token.content.map(simplifyToken) : token.content,
-    ];
-}

package/dist/mdx/plugins/rehype/index.d.ts

@@ -1,8 +1,6 @@
-export * from './rehypeMdxInjectEndpoint/index.js';
+export * from './rehypeMdxExtractEndpoint/index.js';
 export * from './rehypeMdxRemoveUnknownJsx/index.js';
 export * from './rehypeMdxExtractExamples.js';
 export * from './rehypeCodeBlocks.js';
-export * from './rehypeLayouts.js';
-export * from './rehypeListRoles.js';
 export * from './rehypeRawComponents.js';
 export * from './rehypeZoomImages.js';

package/dist/mdx/plugins/rehype/index.js

@@ -1,8 +1,6 @@
-export * from './rehypeMdxInjectEndpoint/index.js';
+export * from './rehypeMdxExtractEndpoint/index.js';
 export * from './rehypeMdxRemoveUnknownJsx/index.js';
 export * from './rehypeMdxExtractExamples.js';
 export * from './rehypeCodeBlocks.js';
-export * from './rehypeLayouts.js';
-export * from './rehypeListRoles.js';
 export * from './rehypeRawComponents.js';
 export * from './rehypeZoomImages.js';

package/dist/mdx/plugins/rehype/rehypeMdxExtractEndpoint/index.d.ts

@@ -0,0 +1,4 @@
+import { MintConfig } from '@mintlify/models';
+import type { Node } from 'unist';
+import { MdxExtracts } from '../../../../index.js';
+export declare const rehypeMdxExtractEndpoint: (metadata: unknown, config: MintConfig | undefined, mdxExtracts: MdxExtracts) => <T extends Node<import("unist").Data>>(tree: T) => T | undefined;

package/dist/mdx/plugins/rehype/{rehypeMdxInjectEndpoint → rehypeMdxExtractEndpoint}/index.js

@@ -1,18 +1,16 @@
 import { generateExampleFromSchema } from '@mintlify/validation';
 import { visitParents } from 'unist-util-visit-parents';
 import { isMdxJsxFlowElementHast } from '../../../lib/mdx-utils.js';
-import { addExport } from '../../../lib/remark-utils.js';
 import { findParentSchema } from './findParentSchema.js';
 import { insertSchema } from './insertSchema.js';
 import { parseApiString, parseAuthMethod, parseField } from './parsers.js';
-export const rehypeMdxInjectEndpoint = (metadata, config) => {
+export const rehypeMdxExtractEndpoint = (metadata, config, mdxExtracts) => {
     return (tree) => {
         var _a;
         if (!(metadata &&
             typeof metadata === 'object' &&
             'api' in metadata &&
             typeof metadata.api === 'string')) {
-            addExport(tree, 'endpoint', undefined);
             return;
         }
         let parseResult = undefined;
@@ -21,7 +19,6 @@ export const rehypeMdxInjectEndpoint = (metadata, config) => {
         }
         catch (_b) {
             console.error(`error parsing api string: "${metadata.api}"`);
-            addExport(tree, 'endpoint', undefined);
             return;
         }
         const { servers, path, method } = parseResult;
@@ -86,7 +83,7 @@ export const rehypeMdxInjectEndpoint = (metadata, config) => {
         if (response) {
             response.examples['example'] = { value: generateExampleFromSchema(response.schemaArray[0]) };
         }
-        addExport(tree, 'endpoint', endpoint);
+        mdxExtracts.endpoint = endpoint;
         return tree;
     };
 };

package/dist/mdx/plugins/rehype/rehypeMdxExtractExamples.d.ts

@@ -1,2 +1,3 @@
 import type { Node } from 'unist';
-export declare const rehypeMdxExtractExamples: () => <T extends Node<import("unist").Data>>(tree: T) => T;
+import type { MdxExtracts } from '../../../types/index.js';
+export declare const rehypeMdxExtractExamples: (mdxExtracts: MdxExtracts) => <T extends Node<import("unist").Data>>(tree: T) => T;

package/dist/mdx/plugins/rehype/rehypeMdxExtractExamples.js

@@ -1,6 +1,6 @@
 import { toHtml } from 'hast-util-to-html';
 import { visit } from 'unist-util-visit';
-import { addExport, isMdxJsxFlowElementHast } from '../../lib/index.js';
+import { isMdxJsxFlowElementHast } from '../../lib/index.js';
 const langFilename = (className) => {
     switch (className) {
         case 'language-shell':
@@ -14,7 +14,7 @@ const langFilename = (className) => {
             return language.charAt(0).toUpperCase() + language.slice(1);
     }
 };
-export const rehypeMdxExtractExamples = () => {
+export const rehypeMdxExtractExamples = (mdxExtracts) => {
     return (tree) => {
         let request;
         let response;
@@ -36,7 +36,10 @@ export const rehypeMdxExtractExamples = () => {
                     parent.children.splice(i, 1);
             }
         });
-        addExport(tree, 'codeExamples', { request, response });
+        mdxExtracts.codeExamples = {
+            request,
+            response,
+        };
         return tree;
     };
 };

package/dist/mdx/plugins/rehype/rehypeMdxRemoveUnknownJsx/index.d.ts

@@ -1,5 +1,3 @@
 import type { Node } from 'unist';
-declare const rehypeMdxRemoveUnknownJsx: (options: {
-    allowedComponents?: string[];
-}) => (tree: Node) => Node<import("unist").Data>;
+declare const rehypeMdxRemoveUnknownJsx: (allowedComponents?: string[]) => (tree: Node) => Node<import("unist").Data>;
 export default rehypeMdxRemoveUnknownJsx;

package/dist/mdx/plugins/rehype/rehypeMdxRemoveUnknownJsx/index.js

@@ -1,13 +1,12 @@
 import { map } from 'unist-util-map';
 import { findExportedNodes, isMdxJsxFlowElementHast } from '../../../lib/index.js';
 import { createCommentNode } from './createCommentNode.js';
-const rehypeMdxRemoveUnknownJsx = (options) => (tree) => {
+const rehypeMdxRemoveUnknownJsx = (allowedComponents) => (tree) => {
     const exportedComponentNames = findExportedNodes(tree, 'ArrowFunctionExpression');
     return map(tree, (node) => {
-        var _a;
         if (isMdxJsxFlowElementHast(node)) {
             if (node.name &&
-                !((_a = options.allowedComponents) === null || _a === void 0 ? void 0 : _a.includes(node.name)) &&
+                !(allowedComponents === null || allowedComponents === void 0 ? void 0 : allowedComponents.includes(node.name)) &&
                 !exportedComponentNames.includes(node.name)) {
                 return createCommentNode(node.name);
             }

package/dist/mdx/plugins/remark/index.d.ts

@@ -1,7 +1,7 @@
 export * from './remarkMdxInjectSnippets.js';
 export * from './remarkFrames.js';
 export * from './remarkRemoveImports.js';
-export * from './remarkTableOfContents.js';
+export * from './remarkExtractTableOfContents.js';
 export * from './remarkMdxRemoveUnusedVariables.js';
 export * from './remarkReplaceAllImages.js';
 export * from './remarkMermaid.js';

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

@@ -1,7 +1,7 @@
 export * from './remarkMdxInjectSnippets.js';
 export * from './remarkFrames.js';
 export * from './remarkRemoveImports.js';
-export * from './remarkTableOfContents.js';
+export * from './remarkExtractTableOfContents.js';
 export * from './remarkMdxRemoveUnusedVariables.js';
 export * from './remarkReplaceAllImages.js';
 export * from './remarkMermaid.js';

package/dist/mdx/plugins/remark/remarkExtractTableOfContents.d.ts

@@ -0,0 +1 @@
+export function remarkExtractTableOfContents(mdxExtracts: any): (tree: any) => void;

package/dist/mdx/plugins/remark/{remarkTableOfContents.js → remarkExtractTableOfContents.js}

@@ -1,5 +1,5 @@
 import { slugifyWithCounter } from '@sindresorhus/slugify';
-import { addExport, createMdxJsxAttribute } from '../../lib/remark-utils.js';
+import { createMdxJsxAttribute } from '../../lib/remark-utils.js';
 const getTOCTitle = (node, i = 1, a = []) => {
     var _a, _b;
     if ((node.type === 'text' &&
@@ -16,7 +16,7 @@ const getTOCTitle = (node, i = 1, a = []) => {
     }
     return '';
 };
-export const remarkTableOfContents = () => {
+export const remarkExtractTableOfContents = (mdxExtracts) => {
     // slugifyWithCounter adds a counter (eg. slug, slug-2, slug-3) to the end of the slug if the header
     // already exists. No counter is added for the first occurence.
     const slugify = slugifyWithCounter();
@@ -52,6 +52,8 @@ export const remarkTableOfContents = () => {
                 }
             }
         }
-        addExport(tree, 'tableOfContents', contents);
+        if (mdxExtracts) {
+            mdxExtracts.tableOfContents = contents;
+        }
     };
 };