@docusaurus/mdx-loader 3.1.1 → 3.2.1

package/lib/index.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { mdxLoader } from './loader';
-import type { TOCItem as TOCItemImported } from './remark/toc';
+import type { TOCItem as TOCItemImported } from './remark/toc/types';
 export default mdxLoader;
 export type TOCItem = TOCItemImported;
 export type Format = 'md' | 'mdx';

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,SAAS,EAAC,MAAM,UAAU,CAAC;AAEnC,OAAO,KAAK,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,cAAc,CAAC;AAE7D,eAAe,SAAS,CAAC;AAEzB,MAAM,MAAM,OAAO,GAAG,eAAe,CAAC;AAEtC,MAAM,MAAM,MAAM,GAAG,IAAI,GAAG,KAAK,CAAC;AAElC,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE5C,MAAM,MAAM,gBAAgB,CAAC,WAAW,EAAE,QAAQ,EAAE,MAAM,GAAG,SAAS,IAAI;IACxE,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,sCAAsC;IACtC,QAAQ,CAAC,GAAG,EAAE,SAAS,OAAO,EAAE,CAAC;IACjC,yCAAyC;IACzC,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,IAAI,GAAG,CAAC,OAAO,CAAC;CACjB,CAAC;AAEF,YAAY,EAAC,OAAO,EAAE,SAAS,EAAC,MAAM,UAAU,CAAC;AACjD,YAAY,EAAC,UAAU,EAAC,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,SAAS,EAAC,MAAM,UAAU,CAAC;AAEnC,OAAO,KAAK,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,oBAAoB,CAAC;AAEnE,eAAe,SAAS,CAAC;AAEzB,MAAM,MAAM,OAAO,GAAG,eAAe,CAAC;AAEtC,MAAM,MAAM,MAAM,GAAG,IAAI,GAAG,KAAK,CAAC;AAElC,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE5C,MAAM,MAAM,gBAAgB,CAAC,WAAW,EAAE,QAAQ,EAAE,MAAM,GAAG,SAAS,IAAI;IACxE,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,sCAAsC;IACtC,QAAQ,CAAC,GAAG,EAAE,SAAS,OAAO,EAAE,CAAC;IACjC,yCAAyC;IACzC,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,IAAI,GAAG,CAAC,OAAO,CAAC;CACjB,CAAC;AAEF,YAAY,EAAC,OAAO,EAAE,SAAS,EAAC,MAAM,UAAU,CAAC;AACjD,YAAY,EAAC,UAAU,EAAC,MAAM,aAAa,CAAC"}

package/lib/remark/contentTitle/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/remark/contentTitle/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAUH,KAAK,MAAM,GAAG,GAAG,CAAC;AAMlB;;;;GAIG;AACH,QAAA,MAAM,MAAM,EAAE,MA0Bb,CAAC;AAEF,eAAe,MAAM,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/remark/contentTitle/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAUH,KAAK,MAAM,GAAG,GAAG,CAAC;AAMlB;;;;GAIG;AACH,QAAA,MAAM,MAAM,EAAE,MAiCb,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/lib/remark/contentTitle/index.js

@@ -17,17 +17,24 @@ const plugin = function plugin(options = {}) {
     return async (root, vfile) => {
         const { toString } = await import('mdast-util-to-string');
         const { visit, EXIT } = await import('unist-util-visit');
-        visit(root, 'heading', (headingNode, index, parent) => {
-            if (headingNode.depth === 1) {
-                vfile.data.contentTitle = toString(headingNode);
-                if (removeContentTitle) {
-                    // @ts-expect-error: TODO how to fix?
-                    parent.children.splice(index, 1);
+        visit(root, ['heading', 'thematicBreak'], (node, index, parent) => {
+            if (node.type === 'heading') {
+                const headingNode = node;
+                if (headingNode.depth === 1) {
+                    vfile.data.contentTitle = toString(headingNode);
+                    if (removeContentTitle) {
+                        // @ts-expect-error: TODO how to fix?
+                        parent.children.splice(index, 1);
+                    }
+                    return EXIT; // We only handle the very first heading
+                }
+                // We only handle contentTitle if it's the very first heading found
+                if (headingNode.depth >= 1) {
+                    return EXIT;
                 }
-                return EXIT; // We only handle the very first heading
             }
-            // We only handle contentTitle if it's the very first heading found
-            if (headingNode.depth >= 1) {
+            // We only handle contentTitle when it's above the first thematic break
+            if (node.type === 'thematicBreak') {
                 return EXIT;
             }
             return undefined;

package/lib/remark/contentTitle/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/remark/contentTitle/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAgBH;;;;GAIG;AACH,MAAM,MAAM,GAAW,SAAS,MAAM,CACpC,UAAyB,EAAE;IAE3B,mBAAmB;IACnB,MAAM,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,IAAI,KAAK,CAAC;IAE/D,OAAO,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;QAC3B,MAAM,EAAC,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,sBAAsB,CAAC,CAAC;QACxD,MAAM,EAAC,KAAK,EAAE,IAAI,EAAC,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC;QAEvD,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,WAAoB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;YAC7D,IAAI,WAAW,CAAC,KAAK,KAAK,CAAC,EAAE;gBAC3B,KAAK,CAAC,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;gBAChD,IAAI,kBAAkB,EAAE;oBACtB,qCAAqC;oBACrC,MAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;iBACnC;gBACD,OAAO,IAAI,CAAC,CAAC,wCAAwC;aACtD;YACD,mEAAmE;YACnE,IAAI,WAAW,CAAC,KAAK,IAAI,CAAC,EAAE;gBAC1B,OAAO,IAAI,CAAC;aACb;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,MAAM,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/remark/contentTitle/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAgBH;;;;GAIG;AACH,MAAM,MAAM,GAAW,SAAS,MAAM,CACpC,UAAyB,EAAE;IAE3B,mBAAmB;IACnB,MAAM,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,IAAI,KAAK,CAAC;IAE/D,OAAO,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;QAC3B,MAAM,EAAC,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,sBAAsB,CAAC,CAAC;QACxD,MAAM,EAAC,KAAK,EAAE,IAAI,EAAC,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC;QAEvD,KAAK,CAAC,IAAI,EAAE,CAAC,SAAS,EAAE,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;YAChE,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;gBAC3B,MAAM,WAAW,GAAG,IAAe,CAAC;gBACpC,IAAI,WAAW,CAAC,KAAK,KAAK,CAAC,EAAE;oBAC3B,KAAK,CAAC,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;oBAChD,IAAI,kBAAkB,EAAE;wBACtB,qCAAqC;wBACrC,MAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;qBACnC;oBACD,OAAO,IAAI,CAAC,CAAC,wCAAwC;iBACtD;gBACD,mEAAmE;gBACnE,IAAI,WAAW,CAAC,KAAK,IAAI,CAAC,EAAE;oBAC1B,OAAO,IAAI,CAAC;iBACb;aACF;YACD,uEAAuE;YACvE,IAAI,IAAI,CAAC,IAAI,KAAK,eAAe,EAAE;gBACjC,OAAO,IAAI,CAAC;aACb;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,MAAM,CAAC"}

package/lib/remark/toc/index.d.ts

@@ -4,12 +4,11 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-type Plugin = any;
-export type TOCItem = {
-    readonly value: string;
-    readonly id: string;
-    readonly level: number;
-};
-declare const plugin: Plugin;
-export default plugin;
+import type { Root } from 'mdast';
+import type { Transformer } from 'unified';
+interface PluginOptions {
+    name?: string;
+}
+export default function plugin(options?: PluginOptions): Transformer<Root>;
+export {};
 //# sourceMappingURL=index.d.ts.map

package/lib/remark/toc/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/remark/toc/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAoBH,KAAK,MAAM,GAAG,GAAG,CAAC;AAElB,MAAM,MAAM,OAAO,GAAG;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB,CAAC;AAuDF,QAAA,MAAM,MAAM,EAAE,MAiCb,CAAC;AAEF,eAAe,MAAM,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/remark/toc/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAUH,OAAO,KAAK,EAAU,IAAI,EAAC,MAAM,OAAO,CAAC;AAEzC,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,SAAS,CAAC;AASzC,UAAU,aAAa;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAiID,MAAM,CAAC,OAAO,UAAU,MAAM,CAAC,OAAO,GAAE,aAAkB,GAAG,WAAW,CAAC,IAAI,CAAC,CA6B7E"}

package/lib/remark/toc/index.js

@@ -6,106 +6,111 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const parser_1 = require("@babel/parser");
-const traverse_1 = tslib_1.__importDefault(require("@babel/traverse"));
-const stringify_object_1 = tslib_1.__importDefault(require("stringify-object"));
-const utils_1 = require("../utils");
-const parseOptions = {
-    plugins: ['jsx'],
-    sourceType: 'module',
-};
-const isImport = (child) => child.type === 'mdxjsEsm' && child.value.startsWith('import');
-const hasImports = (index) => index > -1;
-const isExport = (child) => child.type === 'mdxjsEsm' && child.value.startsWith('export');
-const isTarget = (child, name) => {
-    let found = false;
-    const ast = (0, parser_1.parse)(child.value, parseOptions);
-    (0, traverse_1.default)(ast, {
-        VariableDeclarator: (path) => {
-            if (path.node.id.name === name) {
-                found = true;
+const utils_1 = require("./utils");
+function createTocSliceImportName({ tocExportName, componentName, }) {
+    // The name of the toc slice import alias doesn't matter much
+    // We just need to ensure it's valid and won't conflict with other names
+    return `__${tocExportName}${componentName}`;
+}
+async function collectImportsExports({ root, tocExportName, }) {
+    const { visit } = await import('unist-util-visit');
+    const markdownImports = new Map();
+    let existingTocExport = null;
+    visit(root, 'mdxjsEsm', (node) => {
+        if (!node.data?.estree) {
+            return;
+        }
+        if ((0, utils_1.isNamedExport)(node, tocExportName)) {
+            existingTocExport = node;
+        }
+        (0, utils_1.getImportDeclarations)(node.data.estree).forEach((declaration) => {
+            if (!(0, utils_1.isMarkdownImport)(declaration)) {
+                return;
             }
-        },
+            const componentName = (0, utils_1.findDefaultImportName)(declaration);
+            if (!componentName) {
+                return;
+            }
+            markdownImports.set(componentName, {
+                declaration,
+            });
+        });
     });
-    return found;
-};
-const getOrCreateExistingTargetIndex = async (children, name) => {
-    let importsIndex = -1;
-    let targetIndex = -1;
-    children.forEach((child, index) => {
-        if (isImport(child)) {
-            importsIndex = index;
+    return { markdownImports, existingTocExport };
+}
+async function collectTOCItems({ root, tocExportName, markdownImports, }) {
+    const { toString } = await import('mdast-util-to-string');
+    const { visit } = await import('unist-util-visit');
+    const tocItems = [];
+    visit(root, (child) => {
+        if (child.type === 'heading') {
+            visitHeading(child);
         }
-        else if (isExport(child) && isTarget(child, name)) {
-            targetIndex = index;
+        else if (child.type === 'mdxJsxFlowElement') {
+            visitJSXElement(child);
         }
     });
-    if (targetIndex === -1) {
-        const target = await createExportNode(name, []);
-        targetIndex = hasImports(importsIndex) ? importsIndex + 1 : 0;
-        children.splice(targetIndex, 0, target);
+    return { tocItems };
+    // Visit Markdown headings
+    function visitHeading(node) {
+        const value = toString(node);
+        // depth:1 headings are titles and not included in the TOC
+        if (!value || node.depth < 2) {
+            return;
+        }
+        tocItems.push({
+            type: 'heading',
+            heading: node,
+        });
     }
-    return targetIndex;
-};
-const plugin = function plugin(options = {}) {
-    const name = options.name || 'toc';
+    // Visit JSX elements, such as <Partial/>
+    function visitJSXElement(node) {
+        const componentName = node.name;
+        if (!componentName) {
+            return;
+        }
+        const importDeclaration = markdownImports.get(componentName)?.declaration;
+        if (!importDeclaration) {
+            return;
+        }
+        const tocSliceImportName = createTocSliceImportName({
+            tocExportName,
+            componentName,
+        });
+        tocItems.push({
+            type: 'slice',
+            importName: tocSliceImportName,
+        });
+        (0, utils_1.addTocSliceImportIfNeeded)({
+            importDeclaration,
+            tocExportName,
+            tocSliceImportName,
+        });
+    }
+}
+function plugin(options = {}) {
+    const tocExportName = options.name || 'toc';
     return async (root) => {
-        const { toString } = await import('mdast-util-to-string');
-        const { visit } = await import('unist-util-visit');
-        const headings = [];
-        visit(root, 'heading', (child) => {
-            const value = toString(child);
-            // depth:1 headings are titles and not included in the TOC
-            if (!value || child.depth < 2) {
-                return;
-            }
-            headings.push({
-                value: (0, utils_1.toValue)(child, toString),
-                id: child.data.id,
-                level: child.depth,
-            });
+        const { markdownImports, existingTocExport } = await collectImportsExports({
+            root,
+            tocExportName,
         });
-        const { children } = root;
-        const targetIndex = await getOrCreateExistingTargetIndex(children, name);
-        if (headings?.length) {
-            children[targetIndex] = await createExportNode(name, headings);
+        // If user explicitly writes "export const toc" in his mdx file
+        // We keep it as is do not override their explicit toc structure
+        // See https://github.com/facebook/docusaurus/pull/7530#discussion_r1458087876
+        if (existingTocExport) {
+            return;
         }
-    };
-};
-exports.default = plugin;
-async function createExportNode(name, object) {
-    const { valueToEstree } = await import('estree-util-value-to-estree');
-    return {
-        type: 'mdxjsEsm',
-        value: `export const ${name} = ${(0, stringify_object_1.default)(object)}`,
-        data: {
-            estree: {
-                type: 'Program',
-                body: [
-                    {
-                        type: 'ExportNamedDeclaration',
-                        declaration: {
-                            type: 'VariableDeclaration',
-                            declarations: [
-                                {
-                                    type: 'VariableDeclarator',
-                                    id: {
-                                        type: 'Identifier',
-                                        name,
-                                    },
-                                    init: valueToEstree(object),
-                                },
-                            ],
-                            kind: 'const',
-                        },
-                        specifiers: [],
-                        source: null,
-                    },
-                ],
-                sourceType: 'module',
-            },
-        },
+        const { tocItems } = await collectTOCItems({
+            root,
+            tocExportName,
+            markdownImports,
+        });
+        root.children.push(await (0, utils_1.createTOCExportNodeAST)({
+            tocExportName,
+            tocItems,
+        }));
     };
 }
+exports.default = plugin;
 //# sourceMappingURL=index.js.map

package/lib/remark/toc/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/remark/toc/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,0CAAwD;AACxD,uEAAuC;AACvC,gFAA+C;AAC/C,oCAAiC;AAuBjC,MAAM,YAAY,GAAkB;IAClC,OAAO,EAAE,CAAC,KAAK,CAAC;IAChB,UAAU,EAAE,QAAQ;CACrB,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,KAAU,EAAoB,EAAE,CAChD,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;AAChE,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;AACjD,MAAM,QAAQ,GAAG,CAAC,KAAU,EAAoB,EAAE,CAChD,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;AAMhE,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAE,IAAY,EAAE,EAAE;IAChD,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,MAAM,GAAG,GAAG,IAAA,cAAK,EAAC,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IAC7C,IAAA,kBAAQ,EAAC,GAAG,EAAE;QACZ,kBAAkB,EAAE,CAAC,IAAI,EAAE,EAAE;YAC3B,IAAK,IAAI,CAAC,IAAI,CAAC,EAAiB,CAAC,IAAI,KAAK,IAAI,EAAE;gBAC9C,KAAK,GAAG,IAAI,CAAC;aACd;QACH,CAAC;KACF,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,8BAA8B,GAAG,KAAK,EAC1C,QAAgB,EAChB,IAAY,EACZ,EAAE;IACF,IAAI,YAAY,GAAG,CAAC,CAAC,CAAC;IACtB,IAAI,WAAW,GAAG,CAAC,CAAC,CAAC;IAErB,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAChC,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE;YACnB,YAAY,GAAG,KAAK,CAAC;SACtB;aAAM,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE;YACnD,WAAW,GAAG,KAAK,CAAC;SACrB;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,WAAW,KAAK,CAAC,CAAC,EAAE;QACtB,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAEhD,WAAW,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9D,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;KACzC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,MAAM,GAAW,SAAS,MAAM,CACpC,UAAyB,EAAE;IAE3B,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,KAAK,CAAC;IAEnC,OAAO,KAAK,EAAE,IAAI,EAAE,EAAE;QACpB,MAAM,EAAC,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,sBAAsB,CAAC,CAAC;QACxD,MAAM,EAAC,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC;QAEjD,MAAM,QAAQ,GAAc,EAAE,CAAC;QAE/B,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,KAAc,EAAE,EAAE;YACxC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;YAE9B,0DAA0D;YAC1D,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE;gBAC7B,OAAO;aACR;YAED,QAAQ,CAAC,IAAI,CAAC;gBACZ,KAAK,EAAE,IAAA,eAAO,EAAC,KAAK,EAAE,QAAQ,CAAC;gBAC/B,EAAE,EAAE,KAAK,CAAC,IAAK,CAAC,EAAG;gBACnB,KAAK,EAAE,KAAK,CAAC,KAAK;aACnB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,EAAC,QAAQ,EAAC,GAAG,IAAc,CAAC;QAClC,MAAM,WAAW,GAAG,MAAM,8BAA8B,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAEzE,IAAI,QAAQ,EAAE,MAAM,EAAE;YACpB,QAAQ,CAAC,WAAW,CAAC,GAAG,MAAM,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;SAChE;IACH,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,MAAM,CAAC;AAEtB,KAAK,UAAU,gBAAgB,CAAC,IAAY,EAAE,MAAW;IACvD,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC,6BAA6B,CAAC,CAAC;IAEpE,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,gBAAgB,IAAI,MAAM,IAAA,0BAAe,EAAC,MAAM,CAAC,EAAE;QAC1D,IAAI,EAAE;YACJ,MAAM,EAAE;gBACN,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE;oBACJ;wBACE,IAAI,EAAE,wBAAwB;wBAC9B,WAAW,EAAE;4BACX,IAAI,EAAE,qBAAqB;4BAC3B,YAAY,EAAE;gCACZ;oCACE,IAAI,EAAE,oBAAoB;oCAC1B,EAAE,EAAE;wCACF,IAAI,EAAE,YAAY;wCAClB,IAAI;qCACL;oCACD,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC;iCAC5B;6BACF;4BACD,IAAI,EAAE,OAAO;yBACd;wBACD,UAAU,EAAE,EAAE;wBACd,MAAM,EAAE,IAAI;qBACb;iBACF;gBACD,UAAU,EAAE,QAAQ;aACrB;SACF;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/remark/toc/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,mCAOiB;AAsBjB,SAAS,wBAAwB,CAAC,EAChC,aAAa,EACb,aAAa,GAId;IACC,6DAA6D;IAC7D,wEAAwE;IACxE,OAAO,KAAK,aAAa,GAAG,aAAa,EAAE,CAAC;AAC9C,CAAC;AAED,KAAK,UAAU,qBAAqB,CAAC,EACnC,IAAI,EACJ,aAAa,GAId;IAIC,MAAM,EAAC,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAEjD,MAAM,eAAe,GAAG,IAAI,GAAG,EAA4C,CAAC;IAC5E,IAAI,iBAAiB,GAAoB,IAAI,CAAC;IAE9C,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE;QAC/B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE;YACtB,OAAO;SACR;QACD,IAAI,IAAA,qBAAa,EAAC,IAAI,EAAE,aAAa,CAAC,EAAE;YACtC,iBAAiB,GAAG,IAAI,CAAC;SAC1B;QAED,IAAA,6BAAqB,EAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YAC9D,IAAI,CAAC,IAAA,wBAAgB,EAAC,WAAW,CAAC,EAAE;gBAClC,OAAO;aACR;YACD,MAAM,aAAa,GAAG,IAAA,6BAAqB,EAAC,WAAW,CAAC,CAAC;YACzD,IAAI,CAAC,aAAa,EAAE;gBAClB,OAAO;aACR;YACD,eAAe,CAAC,GAAG,CAAC,aAAa,EAAE;gBACjC,WAAW;aACZ,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,EAAC,eAAe,EAAE,iBAAiB,EAAC,CAAC;AAC9C,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,EAC7B,IAAI,EACJ,aAAa,EACb,eAAe,GAKhB;IAIC,MAAM,EAAC,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,sBAAsB,CAAC,CAAC;IACxD,MAAM,EAAC,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAEjD,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;QACpB,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE;YAC5B,YAAY,CAAC,KAAK,CAAC,CAAC;SACrB;aAAM,IAAI,KAAK,CAAC,IAAI,KAAK,mBAAmB,EAAE;YAC7C,eAAe,CAAC,KAAK,CAAC,CAAC;SACxB;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,EAAC,QAAQ,EAAC,CAAC;IAElB,0BAA0B;IAC1B,SAAS,YAAY,CAAC,IAAa;QACjC,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,0DAA0D;QAC1D,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,EAAE;YAC5B,OAAO;SACR;QACD,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;IACL,CAAC;IAED,yCAAyC;IACzC,SAAS,eAAe,CAAC,IAAuB;QAC9C,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC;QAChC,IAAI,CAAC,aAAa,EAAE;YAClB,OAAO;SACR;QACD,MAAM,iBAAiB,GAAG,eAAe,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,WAAW,CAAC;QAC1E,IAAI,CAAC,iBAAiB,EAAE;YACtB,OAAO;SACR;QAED,MAAM,kBAAkB,GAAG,wBAAwB,CAAC;YAClD,aAAa;YACb,aAAa;SACd,CAAC,CAAC;QAEH,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,OAAO;YACb,UAAU,EAAE,kBAAkB;SAC/B,CAAC,CAAC;QAEH,IAAA,iCAAyB,EAAC;YACxB,iBAAiB;YACjB,aAAa;YACb,kBAAkB;SACnB,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,SAAwB,MAAM,CAAC,UAAyB,EAAE;IACxD,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,IAAI,KAAK,CAAC;IAE5C,OAAO,KAAK,EAAE,IAAI,EAAE,EAAE;QACpB,MAAM,EAAC,eAAe,EAAE,iBAAiB,EAAC,GAAG,MAAM,qBAAqB,CAAC;YACvE,IAAI;YACJ,aAAa;SACd,CAAC,CAAC;QAEH,+DAA+D;QAC/D,gEAAgE;QAChE,8EAA8E;QAC9E,IAAI,iBAAiB,EAAE;YACrB,OAAO;SACR;QAED,MAAM,EAAC,QAAQ,EAAC,GAAG,MAAM,eAAe,CAAC;YACvC,IAAI;YACJ,aAAa;YACb,eAAe;SAChB,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,IAAI,CAChB,MAAM,IAAA,8BAAsB,EAAC;YAC3B,aAAa;YACb,QAAQ;SACT,CAAC,CACH,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AA7BD,yBA6BC"}

package/lib/remark/toc/types.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { Heading } from 'mdast';
+export type TOCItem = {
+    readonly value: string;
+    readonly id: string;
+    readonly level: number;
+};
+export type TOCHeading = {
+    readonly type: 'heading';
+    readonly heading: Heading;
+};
+export type TOCSlice = {
+    readonly type: 'slice';
+    readonly importName: string;
+};
+export type TOCItems = (TOCHeading | TOCSlice)[];
+//# sourceMappingURL=types.d.ts.map

package/lib/remark/toc/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/remark/toc/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAInC,MAAM,MAAM,OAAO,GAAG;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B,CAAC;AAGF,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,CAAC,UAAU,GAAG,QAAQ,CAAC,EAAE,CAAC"}

package/lib/remark/toc/types.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/remark/toc/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/remark/toc/types.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}

package/lib/remark/toc/utils.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { Node } from 'unist';
+import type { MdxjsEsm } from 'mdast-util-mdx';
+import type { TOCItems } from './types';
+import type { Program, ImportDeclaration, ImportSpecifier } from 'estree';
+export declare function getImportDeclarations(program: Program): ImportDeclaration[];
+export declare function isMarkdownImport(node: Node): node is ImportDeclaration;
+export declare function findDefaultImportName(importDeclaration: ImportDeclaration): string | undefined;
+export declare function findNamedImportSpecifier(importDeclaration: ImportDeclaration, localName: string): ImportSpecifier | undefined;
+export declare function addTocSliceImportIfNeeded({ importDeclaration, tocExportName, tocSliceImportName, }: {
+    importDeclaration: ImportDeclaration;
+    tocExportName: string;
+    tocSliceImportName: string;
+}): void;
+export declare function isNamedExport(node: Node, exportName: string): node is MdxjsEsm;
+export declare function createTOCExportNodeAST({ tocExportName, tocItems, }: {
+    tocExportName: string;
+    tocItems: TOCItems;
+}): Promise<MdxjsEsm>;
+//# sourceMappingURL=utils.d.ts.map

package/lib/remark/toc/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/remark/toc/utils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,OAAO,CAAC;AAChC,OAAO,KAAK,EACV,QAAQ,EAET,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAsB,QAAQ,EAAW,MAAM,SAAS,CAAC;AACrE,OAAO,KAAK,EACV,OAAO,EAEP,iBAAiB,EACjB,eAAe,EAChB,MAAM,QAAQ,CAAC;AAEhB,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,iBAAiB,EAAE,CAI3E;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,IAAI,iBAAiB,CAMtE;AAED,wBAAgB,qBAAqB,CACnC,iBAAiB,EAAE,iBAAiB,GACnC,MAAM,GAAG,SAAS,CAIpB;AAED,wBAAgB,wBAAwB,CACtC,iBAAiB,EAAE,iBAAiB,EACpC,SAAS,EAAE,MAAM,GAChB,eAAe,GAAG,SAAS,CAM7B;AAID,wBAAgB,yBAAyB,CAAC,EACxC,iBAAiB,EACjB,aAAa,EACb,kBAAkB,GACnB,EAAE;IACD,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;CAC5B,GAAG,IAAI,CASP;AAED,wBAAgB,aAAa,CAC3B,IAAI,EAAE,IAAI,EACV,UAAU,EAAE,MAAM,GACjB,IAAI,IAAI,QAAQ,CAyBlB;AAED,wBAAsB,sBAAsB,CAAC,EAC3C,aAAa,EACb,QAAQ,GACT,EAAE;IACD,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,QAAQ,CAAC;CACpB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAiEpB"}

package/lib/remark/toc/utils.js

@@ -0,0 +1,135 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTOCExportNodeAST = exports.isNamedExport = exports.addTocSliceImportIfNeeded = exports.findNamedImportSpecifier = exports.findDefaultImportName = exports.isMarkdownImport = exports.getImportDeclarations = void 0;
+const utils_1 = require("../utils");
+function getImportDeclarations(program) {
+    return program.body.filter((item) => item.type === 'ImportDeclaration');
+}
+exports.getImportDeclarations = getImportDeclarations;
+function isMarkdownImport(node) {
+    if (node.type !== 'ImportDeclaration') {
+        return false;
+    }
+    const importPath = node.source.value;
+    return typeof importPath === 'string' && /\.mdx?$/.test(importPath);
+}
+exports.isMarkdownImport = isMarkdownImport;
+function findDefaultImportName(importDeclaration) {
+    return importDeclaration.specifiers.find((o) => o.type === 'ImportDefaultSpecifier')?.local.name;
+}
+exports.findDefaultImportName = findDefaultImportName;
+function findNamedImportSpecifier(importDeclaration, localName) {
+    return importDeclaration?.specifiers.find((specifier) => specifier.type === 'ImportSpecifier' &&
+        specifier.local.name === localName);
+}
+exports.findNamedImportSpecifier = findNamedImportSpecifier;
+// Before: import Partial from "partial"
+// After: import Partial, {toc as __tocPartial} from "partial"
+function addTocSliceImportIfNeeded({ importDeclaration, tocExportName, tocSliceImportName, }) {
+    // We only add the toc slice named import if it doesn't exist already
+    if (!findNamedImportSpecifier(importDeclaration, tocSliceImportName)) {
+        importDeclaration.specifiers.push({
+            type: 'ImportSpecifier',
+            imported: { type: 'Identifier', name: tocExportName },
+            local: { type: 'Identifier', name: tocSliceImportName },
+        });
+    }
+}
+exports.addTocSliceImportIfNeeded = addTocSliceImportIfNeeded;
+function isNamedExport(node, exportName) {
+    if (node.type !== 'mdxjsEsm') {
+        return false;
+    }
+    const program = node.data?.estree;
+    if (!program) {
+        return false;
+    }
+    if (program.body.length !== 1) {
+        return false;
+    }
+    const exportDeclaration = program.body[0];
+    if (exportDeclaration.type !== 'ExportNamedDeclaration') {
+        return false;
+    }
+    const variableDeclaration = exportDeclaration.declaration;
+    if (variableDeclaration?.type !== 'VariableDeclaration') {
+        return false;
+    }
+    const { id } = variableDeclaration.declarations[0];
+    if (id.type !== 'Identifier') {
+        return false;
+    }
+    return id.name === exportName;
+}
+exports.isNamedExport = isNamedExport;
+async function createTOCExportNodeAST({ tocExportName, tocItems, }) {
+    function createTOCSliceAST(tocSlice) {
+        return {
+            type: 'SpreadElement',
+            argument: { type: 'Identifier', name: tocSlice.importName },
+        };
+    }
+    async function createTOCHeadingAST({ heading }) {
+        const { toString } = await import('mdast-util-to-string');
+        const { valueToEstree } = await import('estree-util-value-to-estree');
+        const value = {
+            value: (0, utils_1.toValue)(heading, toString),
+            id: heading.data.id,
+            level: heading.depth,
+        };
+        return valueToEstree(value);
+    }
+    async function createTOCItemAST(tocItem) {
+        switch (tocItem.type) {
+            case 'slice':
+                return createTOCSliceAST(tocItem);
+            case 'heading':
+                return createTOCHeadingAST(tocItem);
+            default: {
+                throw new Error(`unexpected toc item type`);
+            }
+        }
+    }
+    return {
+        type: 'mdxjsEsm',
+        value: '',
+        data: {
+            estree: {
+                type: 'Program',
+                body: [
+                    {
+                        type: 'ExportNamedDeclaration',
+                        declaration: {
+                            type: 'VariableDeclaration',
+                            declarations: [
+                                {
+                                    type: 'VariableDeclarator',
+                                    id: {
+                                        type: 'Identifier',
+                                        name: tocExportName,
+                                    },
+                                    init: {
+                                        type: 'ArrayExpression',
+                                        elements: await Promise.all(tocItems.map(createTOCItemAST)),
+                                    },
+                                },
+                            ],
+                            kind: 'const',
+                        },
+                        specifiers: [],
+                        source: null,
+                    },
+                ],
+                sourceType: 'module',
+            },
+        },
+    };
+}
+exports.createTOCExportNodeAST = createTOCExportNodeAST;
+//# sourceMappingURL=utils.js.map

package/lib/remark/toc/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/remark/toc/utils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,oCAAiC;AAcjC,SAAgB,qBAAqB,CAAC,OAAgB;IACpD,OAAO,OAAO,CAAC,IAAI,CAAC,MAAM,CACxB,CAAC,IAAI,EAA6B,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,mBAAmB,CACvE,CAAC;AACJ,CAAC;AAJD,sDAIC;AAED,SAAgB,gBAAgB,CAAC,IAAU;IACzC,IAAI,IAAI,CAAC,IAAI,KAAK,mBAAmB,EAAE;QACrC,OAAO,KAAK,CAAC;KACd;IACD,MAAM,UAAU,GAAI,IAA0B,CAAC,MAAM,CAAC,KAAK,CAAC;IAC5D,OAAO,OAAO,UAAU,KAAK,QAAQ,IAAI,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AACtE,CAAC;AAND,4CAMC;AAED,SAAgB,qBAAqB,CACnC,iBAAoC;IAEpC,OAAO,iBAAiB,CAAC,UAAU,CAAC,IAAI,CACtC,CAAC,CAAO,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,wBAAwB,CACjD,EAAE,KAAK,CAAC,IAAI,CAAC;AAChB,CAAC;AAND,sDAMC;AAED,SAAgB,wBAAwB,CACtC,iBAAoC,EACpC,SAAiB;IAEjB,OAAO,iBAAiB,EAAE,UAAU,CAAC,IAAI,CACvC,CAAC,SAAS,EAAgC,EAAE,CAC1C,SAAS,CAAC,IAAI,KAAK,iBAAiB;QACpC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CACrC,CAAC;AACJ,CAAC;AATD,4DASC;AAED,wCAAwC;AACxC,8DAA8D;AAC9D,SAAgB,yBAAyB,CAAC,EACxC,iBAAiB,EACjB,aAAa,EACb,kBAAkB,GAKnB;IACC,qEAAqE;IACrE,IAAI,CAAC,wBAAwB,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,EAAE;QACpE,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC;YAChC,IAAI,EAAE,iBAAiB;YACvB,QAAQ,EAAE,EAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,aAAa,EAAC;YACnD,KAAK,EAAE,EAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,kBAAkB,EAAC;SACtD,CAAC,CAAC;KACJ;AACH,CAAC;AAjBD,8DAiBC;AAED,SAAgB,aAAa,CAC3B,IAAU,EACV,UAAkB;IAElB,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE;QAC5B,OAAO,KAAK,CAAC;KACd;IACD,MAAM,OAAO,GAAI,IAAiB,CAAC,IAAI,EAAE,MAAM,CAAC;IAChD,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,KAAK,CAAC;KACd;IACD,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QAC7B,OAAO,KAAK,CAAC;KACd;IACD,MAAM,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAE,CAAC;IAC3C,IAAI,iBAAiB,CAAC,IAAI,KAAK,wBAAwB,EAAE;QACvD,OAAO,KAAK,CAAC;KACd;IACD,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,WAAW,CAAC;IAC1D,IAAI,mBAAmB,EAAE,IAAI,KAAK,qBAAqB,EAAE;QACvD,OAAO,KAAK,CAAC;KACd;IACD,MAAM,EAAC,EAAE,EAAC,GAAG,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAE,CAAC;IAClD,IAAI,EAAE,CAAC,IAAI,KAAK,YAAY,EAAE;QAC5B,OAAO,KAAK,CAAC;KACd;IAED,OAAO,EAAE,CAAC,IAAI,KAAK,UAAU,CAAC;AAChC,CAAC;AA5BD,sCA4BC;AAEM,KAAK,UAAU,sBAAsB,CAAC,EAC3C,aAAa,EACb,QAAQ,GAIT;IACC,SAAS,iBAAiB,CAAC,QAAkB;QAC3C,OAAO;YACL,IAAI,EAAE,eAAe;YACrB,QAAQ,EAAE,EAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,CAAC,UAAU,EAAC;SAC1D,CAAC;IACJ,CAAC;IAED,KAAK,UAAU,mBAAmB,CAAC,EAAC,OAAO,EAAa;QACtD,MAAM,EAAC,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,sBAAsB,CAAC,CAAC;QACxD,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC,6BAA6B,CAAC,CAAC;QACpE,MAAM,KAAK,GAAY;YACrB,KAAK,EAAE,IAAA,eAAO,EAAC,OAAO,EAAE,QAAQ,CAAC;YACjC,EAAE,EAAE,OAAO,CAAC,IAAK,CAAC,EAAG;YACrB,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC;QACF,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED,KAAK,UAAU,gBAAgB,CAAC,OAAyB;QACvD,QAAQ,OAAO,CAAC,IAAI,EAAE;YACpB,KAAK,OAAO;gBACV,OAAO,iBAAiB,CAAC,OAAO,CAAC,CAAC;YACpC,KAAK,SAAS;gBACZ,OAAO,mBAAmB,CAAC,OAAO,CAAC,CAAC;YACtC,OAAO,CAAC,CAAC;gBACP,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;aAC7C;SACF;IACH,CAAC;IAED,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,EAAE;QACT,IAAI,EAAE;YACJ,MAAM,EAAE;gBACN,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE;oBACJ;wBACE,IAAI,EAAE,wBAAwB;wBAC9B,WAAW,EAAE;4BACX,IAAI,EAAE,qBAAqB;4BAC3B,YAAY,EAAE;gCACZ;oCACE,IAAI,EAAE,oBAAoB;oCAC1B,EAAE,EAAE;wCACF,IAAI,EAAE,YAAY;wCAClB,IAAI,EAAE,aAAa;qCACpB;oCACD,IAAI,EAAE;wCACJ,IAAI,EAAE,iBAAiB;wCACvB,QAAQ,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;qCAC5D;iCACF;6BACF;4BACD,IAAI,EAAE,OAAO;yBACd;wBACD,UAAU,EAAE,EAAE;wBACd,MAAM,EAAE,IAAI;qBACb;iBACF;gBACD,UAAU,EAAE,QAAQ;aACrB;SACF;KACF,CAAC;AACJ,CAAC;AAvED,wDAuEC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/mdx-loader",
-  "version": "3.1.1",
+  "version": "3.2.1",
   "description": "Docusaurus Loader for MDX",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -18,11 +18,9 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@babel/parser": "^7.22.7",
-    "@babel/traverse": "^7.22.8",
-    "@docusaurus/logger": "3.1.1",
-    "@docusaurus/utils": "3.1.1",
-    "@docusaurus/utils-validation": "3.1.1",
+    "@docusaurus/logger": "3.2.1",
+    "@docusaurus/utils": "3.2.1",
+    "@docusaurus/utils-validation": "3.2.1",
     "@mdx-js/mdx": "^3.0.0",
     "@slorber/remark-comment": "^1.0.0",
     "escape-html": "^1.0.3",
@@ -46,7 +44,7 @@
     "webpack": "^5.88.1"
   },
   "devDependencies": {
-    "@docusaurus/types": "3.1.1",
+    "@docusaurus/types": "3.2.1",
     "@types/escape-html": "^1.0.2",
     "@types/mdast": "^4.0.2",
     "@types/stringify-object": "^3.3.1",
@@ -66,5 +64,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "8017f6a6776ba1bd7065e630a52fe2c2654e2f1b"
+  "gitHead": "f268e15264e208e6faf26117258162e988b53773"
 }

package/src/index.ts

@@ -7,7 +7,7 @@
 
 import {mdxLoader} from './loader';
 
-import type {TOCItem as TOCItemImported} from './remark/toc';
+import type {TOCItem as TOCItemImported} from './remark/toc/types';
 
 export default mdxLoader;
 

package/src/remark/contentTitle/index.ts

@@ -34,17 +34,24 @@ const plugin: Plugin = function plugin(
     const {toString} = await import('mdast-util-to-string');
     const {visit, EXIT} = await import('unist-util-visit');
 
-    visit(root, 'heading', (headingNode: Heading, index, parent) => {
-      if (headingNode.depth === 1) {
-        vfile.data.contentTitle = toString(headingNode);
-        if (removeContentTitle) {
-          // @ts-expect-error: TODO how to fix?
-          parent!.children.splice(index, 1);
+    visit(root, ['heading', 'thematicBreak'], (node, index, parent) => {
+      if (node.type === 'heading') {
+        const headingNode = node as Heading;
+        if (headingNode.depth === 1) {
+          vfile.data.contentTitle = toString(headingNode);
+          if (removeContentTitle) {
+            // @ts-expect-error: TODO how to fix?
+            parent!.children.splice(index, 1);
+          }
+          return EXIT; // We only handle the very first heading
+        }
+        // We only handle contentTitle if it's the very first heading found
+        if (headingNode.depth >= 1) {
+          return EXIT;
         }
-        return EXIT; // We only handle the very first heading
       }
-      // We only handle contentTitle if it's the very first heading found
-      if (headingNode.depth >= 1) {
+      // We only handle contentTitle when it's above the first thematic break
+      if (node.type === 'thematicBreak') {
         return EXIT;
       }
       return undefined;

package/src/remark/toc/index.ts

@@ -5,154 +5,183 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {parse, type ParserOptions} from '@babel/parser';
-import traverse from '@babel/traverse';
-import stringifyObject from 'stringify-object';
-import {toValue} from '../utils';
-import type {Identifier} from '@babel/types';
-import type {Node, Parent} from 'unist';
-import type {Heading, Literal} from 'mdast';
+import {
+  addTocSliceImportIfNeeded,
+  createTOCExportNodeAST,
+  findDefaultImportName,
+  getImportDeclarations,
+  isMarkdownImport,
+  isNamedExport,
+} from './utils';
+import type {Heading, Root} from 'mdast';
 // @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
 import type {Transformer} from 'unified';
 import type {
   MdxjsEsm,
+  MdxJsxFlowElement,
   // @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
 } from 'mdast-util-mdx';
-
-// TODO as of April 2023, no way to import/re-export this ESM type easily :/
-// TODO upgrade to TS 5.3
-// See https://github.com/microsoft/TypeScript/issues/49721#issuecomment-1517839391
-// import type {Plugin} from 'unified';
-type Plugin = any; // TODO fix this asap
-
-export type TOCItem = {
-  readonly value: string;
-  readonly id: string;
-  readonly level: number;
-};
-
-const parseOptions: ParserOptions = {
-  plugins: ['jsx'],
-  sourceType: 'module',
-};
-
-const isImport = (child: any): child is Literal =>
-  child.type === 'mdxjsEsm' && child.value.startsWith('import');
-const hasImports = (index: number) => index > -1;
-const isExport = (child: any): child is Literal =>
-  child.type === 'mdxjsEsm' && child.value.startsWith('export');
+import type {TOCItems} from './types';
+import type {ImportDeclaration} from 'estree';
 
 interface PluginOptions {
   name?: string;
 }
 
-const isTarget = (child: Literal, name: string) => {
-  let found = false;
-  const ast = parse(child.value, parseOptions);
-  traverse(ast, {
-    VariableDeclarator: (path) => {
-      if ((path.node.id as Identifier).name === name) {
-        found = true;
+// ComponentName (default export) => ImportDeclaration mapping
+type MarkdownImports = Map<string, {declaration: ImportDeclaration}>;
+
+// MdxjsEsm node representing an already existing "export const toc" declaration
+type ExistingTOCExport = MdxjsEsm | null;
+
+function createTocSliceImportName({
+  tocExportName,
+  componentName,
+}: {
+  tocExportName: string;
+  componentName: string;
+}) {
+  // The name of the toc slice import alias doesn't matter much
+  // We just need to ensure it's valid and won't conflict with other names
+  return `__${tocExportName}${componentName}`;
+}
+
+async function collectImportsExports({
+  root,
+  tocExportName,
+}: {
+  root: Root;
+  tocExportName: string;
+}): Promise<{
+  markdownImports: MarkdownImports;
+  existingTocExport: ExistingTOCExport;
+}> {
+  const {visit} = await import('unist-util-visit');
+
+  const markdownImports = new Map<string, {declaration: ImportDeclaration}>();
+  let existingTocExport: MdxjsEsm | null = null;
+
+  visit(root, 'mdxjsEsm', (node) => {
+    if (!node.data?.estree) {
+      return;
+    }
+    if (isNamedExport(node, tocExportName)) {
+      existingTocExport = node;
+    }
+
+    getImportDeclarations(node.data.estree).forEach((declaration) => {
+      if (!isMarkdownImport(declaration)) {
+        return;
+      }
+      const componentName = findDefaultImportName(declaration);
+      if (!componentName) {
+        return;
       }
-    },
+      markdownImports.set(componentName, {
+        declaration,
+      });
+    });
   });
-  return found;
-};
-
-const getOrCreateExistingTargetIndex = async (
-  children: Node[],
-  name: string,
-) => {
-  let importsIndex = -1;
-  let targetIndex = -1;
-
-  children.forEach((child, index) => {
-    if (isImport(child)) {
-      importsIndex = index;
-    } else if (isExport(child) && isTarget(child, name)) {
-      targetIndex = index;
+
+  return {markdownImports, existingTocExport};
+}
+
+async function collectTOCItems({
+  root,
+  tocExportName,
+  markdownImports,
+}: {
+  root: Root;
+  tocExportName: string;
+  markdownImports: MarkdownImports;
+}): Promise<{
+  // The toc items we collected in the tree
+  tocItems: TOCItems;
+}> {
+  const {toString} = await import('mdast-util-to-string');
+  const {visit} = await import('unist-util-visit');
+
+  const tocItems: TOCItems = [];
+
+  visit(root, (child) => {
+    if (child.type === 'heading') {
+      visitHeading(child);
+    } else if (child.type === 'mdxJsxFlowElement') {
+      visitJSXElement(child);
     }
   });
 
-  if (targetIndex === -1) {
-    const target = await createExportNode(name, []);
+  return {tocItems};
 
-    targetIndex = hasImports(importsIndex) ? importsIndex + 1 : 0;
-    children.splice(targetIndex, 0, target);
+  // Visit Markdown headings
+  function visitHeading(node: Heading) {
+    const value = toString(node);
+    // depth:1 headings are titles and not included in the TOC
+    if (!value || node.depth < 2) {
+      return;
+    }
+    tocItems.push({
+      type: 'heading',
+      heading: node,
+    });
   }
 
-  return targetIndex;
-};
-
-const plugin: Plugin = function plugin(
-  options: PluginOptions = {},
-): Transformer {
-  const name = options.name || 'toc';
+  // Visit JSX elements, such as <Partial/>
+  function visitJSXElement(node: MdxJsxFlowElement) {
+    const componentName = node.name;
+    if (!componentName) {
+      return;
+    }
+    const importDeclaration = markdownImports.get(componentName)?.declaration;
+    if (!importDeclaration) {
+      return;
+    }
 
-  return async (root) => {
-    const {toString} = await import('mdast-util-to-string');
-    const {visit} = await import('unist-util-visit');
+    const tocSliceImportName = createTocSliceImportName({
+      tocExportName,
+      componentName,
+    });
 
-    const headings: TOCItem[] = [];
+    tocItems.push({
+      type: 'slice',
+      importName: tocSliceImportName,
+    });
 
-    visit(root, 'heading', (child: Heading) => {
-      const value = toString(child);
+    addTocSliceImportIfNeeded({
+      importDeclaration,
+      tocExportName,
+      tocSliceImportName,
+    });
+  }
+}
 
-      // depth:1 headings are titles and not included in the TOC
-      if (!value || child.depth < 2) {
-        return;
-      }
+export default function plugin(options: PluginOptions = {}): Transformer<Root> {
+  const tocExportName = options.name || 'toc';
 
-      headings.push({
-        value: toValue(child, toString),
-        id: child.data!.id!,
-        level: child.depth,
-      });
+  return async (root) => {
+    const {markdownImports, existingTocExport} = await collectImportsExports({
+      root,
+      tocExportName,
     });
 
-    const {children} = root as Parent;
-    const targetIndex = await getOrCreateExistingTargetIndex(children, name);
-
-    if (headings?.length) {
-      children[targetIndex] = await createExportNode(name, headings);
+    // If user explicitly writes "export const toc" in his mdx file
+    // We keep it as is do not override their explicit toc structure
+    // See https://github.com/facebook/docusaurus/pull/7530#discussion_r1458087876
+    if (existingTocExport) {
+      return;
     }
-  };
-};
-
-export default plugin;
-
-async function createExportNode(name: string, object: any): Promise<MdxjsEsm> {
-  const {valueToEstree} = await import('estree-util-value-to-estree');
-
-  return {
-    type: 'mdxjsEsm',
-    value: `export const ${name} = ${stringifyObject(object)}`,
-    data: {
-      estree: {
-        type: 'Program',
-        body: [
-          {
-            type: 'ExportNamedDeclaration',
-            declaration: {
-              type: 'VariableDeclaration',
-              declarations: [
-                {
-                  type: 'VariableDeclarator',
-                  id: {
-                    type: 'Identifier',
-                    name,
-                  },
-                  init: valueToEstree(object),
-                },
-              ],
-              kind: 'const',
-            },
-            specifiers: [],
-            source: null,
-          },
-        ],
-        sourceType: 'module',
-      },
-    },
+
+    const {tocItems} = await collectTOCItems({
+      root,
+      tocExportName,
+      markdownImports,
+    });
+
+    root.children.push(
+      await createTOCExportNodeAST({
+        tocExportName,
+        tocItems,
+      }),
+    );
   };
 }

package/src/remark/toc/types.ts

@@ -0,0 +1,29 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import type {Heading} from 'mdast';
+
+// Note: this type is exported from mdx-loader and used in theme
+// Need to keep it retro compatible
+export type TOCItem = {
+  readonly value: string;
+  readonly id: string;
+  readonly level: number;
+};
+
+export type TOCHeading = {
+  readonly type: 'heading';
+  readonly heading: Heading;
+};
+
+// A TOC slice represents a TOCItem[] imported from a partial
+export type TOCSlice = {
+  readonly type: 'slice';
+  readonly importName: string;
+};
+
+export type TOCItems = (TOCHeading | TOCSlice)[];

package/src/remark/toc/utils.ts

@@ -0,0 +1,177 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import {toValue} from '../utils';
+import type {Node} from 'unist';
+import type {
+  MdxjsEsm,
+  // @ts-expect-error: TODO see https://github.com/microsoft/TypeScript/issues/49721
+} from 'mdast-util-mdx';
+import type {TOCHeading, TOCItem, TOCItems, TOCSlice} from './types';
+import type {
+  Program,
+  SpreadElement,
+  ImportDeclaration,
+  ImportSpecifier,
+} from 'estree';
+
+export function getImportDeclarations(program: Program): ImportDeclaration[] {
+  return program.body.filter(
+    (item): item is ImportDeclaration => item.type === 'ImportDeclaration',
+  );
+}
+
+export function isMarkdownImport(node: Node): node is ImportDeclaration {
+  if (node.type !== 'ImportDeclaration') {
+    return false;
+  }
+  const importPath = (node as ImportDeclaration).source.value;
+  return typeof importPath === 'string' && /\.mdx?$/.test(importPath);
+}
+
+export function findDefaultImportName(
+  importDeclaration: ImportDeclaration,
+): string | undefined {
+  return importDeclaration.specifiers.find(
+    (o: Node) => o.type === 'ImportDefaultSpecifier',
+  )?.local.name;
+}
+
+export function findNamedImportSpecifier(
+  importDeclaration: ImportDeclaration,
+  localName: string,
+): ImportSpecifier | undefined {
+  return importDeclaration?.specifiers.find(
+    (specifier): specifier is ImportSpecifier =>
+      specifier.type === 'ImportSpecifier' &&
+      specifier.local.name === localName,
+  );
+}
+
+// Before: import Partial from "partial"
+// After: import Partial, {toc as __tocPartial} from "partial"
+export function addTocSliceImportIfNeeded({
+  importDeclaration,
+  tocExportName,
+  tocSliceImportName,
+}: {
+  importDeclaration: ImportDeclaration;
+  tocExportName: string;
+  tocSliceImportName: string;
+}): void {
+  // We only add the toc slice named import if it doesn't exist already
+  if (!findNamedImportSpecifier(importDeclaration, tocSliceImportName)) {
+    importDeclaration.specifiers.push({
+      type: 'ImportSpecifier',
+      imported: {type: 'Identifier', name: tocExportName},
+      local: {type: 'Identifier', name: tocSliceImportName},
+    });
+  }
+}
+
+export function isNamedExport(
+  node: Node,
+  exportName: string,
+): node is MdxjsEsm {
+  if (node.type !== 'mdxjsEsm') {
+    return false;
+  }
+  const program = (node as MdxjsEsm).data?.estree;
+  if (!program) {
+    return false;
+  }
+  if (program.body.length !== 1) {
+    return false;
+  }
+  const exportDeclaration = program.body[0]!;
+  if (exportDeclaration.type !== 'ExportNamedDeclaration') {
+    return false;
+  }
+  const variableDeclaration = exportDeclaration.declaration;
+  if (variableDeclaration?.type !== 'VariableDeclaration') {
+    return false;
+  }
+  const {id} = variableDeclaration.declarations[0]!;
+  if (id.type !== 'Identifier') {
+    return false;
+  }
+
+  return id.name === exportName;
+}
+
+export async function createTOCExportNodeAST({
+  tocExportName,
+  tocItems,
+}: {
+  tocExportName: string;
+  tocItems: TOCItems;
+}): Promise<MdxjsEsm> {
+  function createTOCSliceAST(tocSlice: TOCSlice): SpreadElement {
+    return {
+      type: 'SpreadElement',
+      argument: {type: 'Identifier', name: tocSlice.importName},
+    };
+  }
+
+  async function createTOCHeadingAST({heading}: TOCHeading) {
+    const {toString} = await import('mdast-util-to-string');
+    const {valueToEstree} = await import('estree-util-value-to-estree');
+    const value: TOCItem = {
+      value: toValue(heading, toString),
+      id: heading.data!.id!,
+      level: heading.depth,
+    };
+    return valueToEstree(value);
+  }
+
+  async function createTOCItemAST(tocItem: TOCItems[number]) {
+    switch (tocItem.type) {
+      case 'slice':
+        return createTOCSliceAST(tocItem);
+      case 'heading':
+        return createTOCHeadingAST(tocItem);
+      default: {
+        throw new Error(`unexpected toc item type`);
+      }
+    }
+  }
+
+  return {
+    type: 'mdxjsEsm',
+    value: '', // See https://github.com/facebook/docusaurus/pull/9684#discussion_r1457595181
+    data: {
+      estree: {
+        type: 'Program',
+        body: [
+          {
+            type: 'ExportNamedDeclaration',
+            declaration: {
+              type: 'VariableDeclaration',
+              declarations: [
+                {
+                  type: 'VariableDeclarator',
+                  id: {
+                    type: 'Identifier',
+                    name: tocExportName,
+                  },
+                  init: {
+                    type: 'ArrayExpression',
+                    elements: await Promise.all(tocItems.map(createTOCItemAST)),
+                  },
+                },
+              ],
+              kind: 'const',
+            },
+            specifiers: [],
+            source: null,
+          },
+        ],
+        sourceType: 'module',
+      },
+    },
+  };
+}