@mui/internal-docs-infra 0.2.3-canary.9 → 0.3.1-canary.0

package/esm/withDocsInfra/withDocsInfra.d.ts

@@ -47,6 +47,14 @@ export interface WithDocsInfraOptions {
   additionalTurbopackRules?: Record<string, {
     loaders: string[];
   }>;
+  /**
+   * Performance logging options
+   */
+  performance?: {
+    logging: boolean;
+    notableMs?: number;
+    showWrapperMeasures?: boolean;
+  };
   /**
    * Defer AST parsing option for code highlighter output.
    * 'gzip' - Default, outputs gzipped HAST for best performance.
@@ -67,6 +75,37 @@ export interface DocsInfraMdxOptions {
    * Additional rehype plugins to add to the default docs-infra plugins
    */
   additionalRehypePlugins?: Array<string | [string, ...any[]]>;
+  /**
+   * Whether to automatically extract page metadata (title, description, headings) from MDX files
+   * and maintain an index in the parent directory's page.mdx file.
+   *
+   * Index files themselves (e.g., pattern/page.mdx) are automatically excluded from extraction.
+   *
+   * Can be:
+   * - `false` - Disabled
+   * - `true` - Enabled with default filter: `{ include: ['app', 'src/app'], exclude: [] }`
+   * - `{ include: string[], exclude: string[] }` - Enabled with custom path filters
+   *
+   * @default true
+   */
+  extractToIndex?: boolean | {
+    /** Path prefixes that files must match to have metadata extracted */
+    include: string[];
+    /** Path prefixes to exclude from metadata extraction */
+    exclude: string[];
+  };
+  /**
+   * Base directory for path filtering. Defaults to process.cwd().
+   * Only needed when calling the plugin directly (not via withDocsInfra).
+   */
+  baseDir?: string;
+  /**
+   * Throw an error if any index is out of date or missing.
+   * Useful for CI environments to ensure indexes are committed.
+   *
+   * @default false
+   */
+  errorIfIndexOutOfDate?: boolean;
 }
 /**
  * Get default MDX options for docs-infra

package/esm/withDocsInfra/withDocsInfra.js

@@ -1,6 +1,6 @@
-import _extends from "@babel/runtime/helpers/esm/extends";
 import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
 import _toConsumableArray from "@babel/runtime/helpers/esm/toConsumableArray";
+import _extends from "@babel/runtime/helpers/esm/extends";
 // Define webpack options interface based on Next.js webpack function signature
 
 /**
@@ -9,7 +9,35 @@ import _toConsumableArray from "@babel/runtime/helpers/esm/toConsumableArray";
 export function getDocsInfraMdxOptions() {
   var _customOptions$remark, _customOptions$additi, _customOptions$rehype, _customOptions$additi2;
   var customOptions = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  var defaultRemarkPlugins = [['remark-gfm'], ['@mui/internal-docs-infra/pipeline/transformMarkdownCode']];
+  var _customOptions$extrac = customOptions.extractToIndex,
+    extractToIndex = _customOptions$extrac === void 0 ? true : _customOptions$extrac,
+    baseDir = customOptions.baseDir,
+    _customOptions$errorI = customOptions.errorIfIndexOutOfDate,
+    errorIfIndexOutOfDate = _customOptions$errorI === void 0 ? Boolean(process.env.CI) : _customOptions$errorI;
+
+  // Normalize extractToIndex to options object
+  var extractToIndexOptions;
+  if (extractToIndex === false) {
+    extractToIndexOptions = false;
+  } else if (extractToIndex === true) {
+    // Default filter: include all files under app/ and src/app/
+    // Index files (pattern/page.mdx) are automatically excluded by the matching logic
+    // Use process.cwd() as default baseDir (the directory where Next.js is running)
+    extractToIndexOptions = {
+      include: ['app', 'src/app'],
+      exclude: [],
+      baseDir: baseDir != null ? baseDir : process.cwd()
+    };
+  } else {
+    extractToIndexOptions = _extends(_extends({}, extractToIndex), {}, {
+      baseDir: baseDir != null ? baseDir : process.cwd()
+    });
+  }
+  var defaultRemarkPlugins = [['remark-gfm'], ['@mui/internal-docs-infra/pipeline/transformMarkdownMetadata', {
+    extractToIndex: extractToIndexOptions,
+    markerPath: '.next/cache/docs-infra/index-updates',
+    errorIfIndexOutOfDate: errorIfIndexOutOfDate
+  }], ['@mui/internal-docs-infra/pipeline/transformMarkdownRelativePaths'], ['@mui/internal-docs-infra/pipeline/transformMarkdownBlockquoteCallouts'], ['@mui/internal-docs-infra/pipeline/transformMarkdownCode'], ['@mui/internal-docs-infra/pipeline/transformMarkdownDemoLinks']];
   var defaultRehypePlugins = [['@mui/internal-docs-infra/pipeline/transformHtmlCodePrecomputed']];
 
   // Build final plugin arrays
@@ -40,6 +68,8 @@ export function withDocsInfra() {
     additionalDemoPatterns = _options$additionalDe === void 0 ? {} : _options$additionalDe,
     _options$additionalTu = options.additionalTurbopackRules,
     additionalTurbopackRules = _options$additionalTu === void 0 ? {} : _options$additionalTu,
+    _options$performance = options.performance,
+    performance = _options$performance === void 0 ? {} : _options$performance,
     _options$deferCodePar = options.deferCodeParsing,
     deferCodeParsing = _options$deferCodePar === void 0 ? 'gzip' : _options$deferCodePar;
   var output = 'hastGzip';
@@ -55,15 +85,28 @@ export function withDocsInfra() {
     var pageExtensions = [].concat(basePageExtensions, _toConsumableArray(additionalPageExtensions));
 
     // Build Turbopack rules
-    var turbopackRules = _defineProperty(_defineProperty({}, demoPathPattern, {
+    var turbopackRules = _defineProperty(_defineProperty(_defineProperty({}, demoPathPattern, {
       loaders: [{
         loader: '@mui/internal-docs-infra/pipeline/loadPrecomputedCodeHighlighter',
         options: {
+          performance: performance,
           output: output
         }
       }]
     }), clientDemoPathPattern, {
-      loaders: ['@mui/internal-docs-infra/pipeline/loadPrecomputedCodeHighlighterClient']
+      loaders: [{
+        loader: '@mui/internal-docs-infra/pipeline/loadPrecomputedCodeHighlighterClient',
+        options: {
+          performance: performance
+        }
+      }]
+    }), './app/sitemap/index.ts', {
+      loaders: [{
+        loader: '@mui/internal-docs-infra/pipeline/loadPrecomputedSitemap',
+        options: {
+          performance: performance
+        }
+      }]
     });
 
     // Add additional demo patterns to Turbopack rules
@@ -73,6 +116,7 @@ export function withDocsInfra() {
           loaders: [{
             loader: '@mui/internal-docs-infra/pipeline/loadPrecomputedCodeHighlighter',
             options: {
+              performance: performance,
               output: output
             }
           }]
@@ -82,7 +126,12 @@ export function withDocsInfra() {
     if (additionalDemoPatterns.client) {
       additionalDemoPatterns.client.forEach(function (pattern) {
         turbopackRules[pattern] = {
-          loaders: ['@mui/internal-docs-infra/pipeline/loadPrecomputedCodeHighlighterClient']
+          loaders: [{
+            loader: '@mui/internal-docs-infra/pipeline/loadPrecomputedCodeHighlighterClient',
+            options: {
+              performance: performance
+            }
+          }]
         };
       });
     }
@@ -118,6 +167,7 @@ export function withDocsInfra() {
           use: [defaultLoaders.babel, {
             loader: '@mui/internal-docs-infra/pipeline/loadPrecomputedCodeHighlighter',
             options: {
+              performance: performance,
               output: output
             }
           }]
@@ -126,7 +176,23 @@ export function withDocsInfra() {
         // Client files for live demos - processes externals
         webpackConfig.module.rules.push({
           test: new RegExp('/demos/[^/]+/client\\.ts$'),
-          use: [defaultLoaders.babel, '@mui/internal-docs-infra/pipeline/loadPrecomputedCodeHighlighterClient']
+          use: [defaultLoaders.babel, {
+            loader: '@mui/internal-docs-infra/pipeline/loadPrecomputedCodeHighlighterClient',
+            options: {
+              performance: performance
+            }
+          }]
+        });
+
+        // Sitemap loader
+        webpackConfig.module.rules.push({
+          test: new RegExp('/sitemap/index\\.ts$'),
+          use: [defaultLoaders.babel, {
+            loader: '@mui/internal-docs-infra/pipeline/loadPrecomputedSitemap',
+            options: {
+              performance: performance
+            }
+          }]
         });
 
         // Add webpack rules for additional demo patterns
@@ -144,6 +210,7 @@ export function withDocsInfra() {
               use: [defaultLoaders.babel, {
                 loader: '@mui/internal-docs-infra/pipeline/loadPrecomputedCodeHighlighter',
                 options: {
+                  performance: performance,
                   output: output
                 }
               }]
@@ -161,7 +228,12 @@ export function withDocsInfra() {
 
             webpackConfig.module.rules.push({
               test: new RegExp("".concat(regexPattern, "$")),
-              use: [defaultLoaders.babel, '@mui/internal-docs-infra/pipeline/loadPrecomputedCodeHighlighterClient']
+              use: [defaultLoaders.babel, {
+                loader: '@mui/internal-docs-infra/pipeline/loadPrecomputedCodeHighlighterClient',
+                options: {
+                  performance: performance
+                }
+              }]
             });
           });
         }

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@mui/internal-docs-infra",
-  "version": "0.2.3-canary.9",
+  "version": "0.3.1-canary.0",
   "author": "MUI Team",
   "description": "MUI Infra - internal documentation creation tools.",
+  "bin": {
+    "docs-infra": "./esm/cli/index.js"
+  },
   "keywords": [
     "react",
     "react-component",
@@ -23,7 +26,12 @@
   "dependencies": {
     "@babel/runtime": "^7.28.4",
     "@babel/standalone": "^7.28.5",
+    "@orama/orama": "^3.1.16",
+    "@orama/plugin-qps": "^3.1.16",
+    "@orama/stemmers": "^3.1.16",
+    "@orama/stopwords": "^3.1.16",
     "@wooorm/starry-night": "^3.8.0",
+    "chalk": "^5.6.2",
     "clipboard-copy": "^4.0.1",
     "fflate": "^0.8.2",
     "hast-util-to-jsx-runtime": "^2.3.6",
@@ -32,10 +40,12 @@
     "kebab-case": "^2.0.2",
     "lz-string": "^1.5.0",
     "path-module": "^0.1.2",
-    "prettier": "^3.6.2",
+    "prettier": "~3.7.4",
+    "proper-lockfile": "^4.1.2",
     "uint8-to-base64": "^0.2.1",
     "unist-util-visit": "^5.0.0",
-    "vscode-oniguruma": "^2.0.1"
+    "vscode-oniguruma": "^2.0.1",
+    "yargs": "^18.0.0"
   },
   "peerDependencies": {
     "@types/react": "^17.0.0 || ^18.0.0 || ^19.0.0",
@@ -56,7 +66,6 @@
   "engines": {
     "node": ">=22.12.0"
   },
-  "gitSha": "5e2086fe1de7af3c8403a2052ed42a98b66a4ab9",
   "type": "commonjs",
   "exports": {
     "./package.json": "./package.json",
@@ -120,6 +129,18 @@
         "default": "./esm/createDemoData/types.js"
       }
     },
+    "./createSitemap": {
+      "default": {
+        "types": "./esm/createSitemap/index.d.ts",
+        "default": "./esm/createSitemap/index.js"
+      }
+    },
+    "./createSitemap/types": {
+      "default": {
+        "types": "./esm/createSitemap/types.d.ts",
+        "default": "./esm/createSitemap/types.js"
+      }
+    },
     "./useCode": {
       "default": {
         "types": "./esm/useCode/index.d.ts",
@@ -156,6 +177,18 @@
         "default": "./esm/usePreference/index.js"
       }
     },
+    "./useSearch": {
+      "default": {
+        "types": "./esm/useSearch/index.d.ts",
+        "default": "./esm/useSearch/index.js"
+      }
+    },
+    "./useSearch/types": {
+      "default": {
+        "types": "./esm/useSearch/types.d.ts",
+        "default": "./esm/useSearch/types.js"
+      }
+    },
     "./useUrlHashState": {
       "default": {
         "types": "./esm/useUrlHashState/index.d.ts",
@@ -168,12 +201,54 @@
         "default": "./esm/withDocsInfra/index.js"
       }
     },
+    "./pipeline/getFileConventions": {
+      "default": {
+        "types": "./esm/pipeline/getFileConventions/index.d.ts",
+        "default": "./esm/pipeline/getFileConventions/index.js"
+      }
+    },
+    "./pipeline/transformMarkdownBlockquoteCallouts": {
+      "default": {
+        "types": "./esm/pipeline/transformMarkdownBlockquoteCallouts/index.d.ts",
+        "default": "./esm/pipeline/transformMarkdownBlockquoteCallouts/index.js"
+      }
+    },
+    "./pipeline/transformMarkdownDemoLinks": {
+      "default": {
+        "types": "./esm/pipeline/transformMarkdownDemoLinks/index.d.ts",
+        "default": "./esm/pipeline/transformMarkdownDemoLinks/index.js"
+      }
+    },
+    "./pipeline/transformMarkdownMetadata": {
+      "default": {
+        "types": "./esm/pipeline/transformMarkdownMetadata/index.d.ts",
+        "default": "./esm/pipeline/transformMarkdownMetadata/index.js"
+      }
+    },
+    "./pipeline/transformMarkdownMetadata/types": {
+      "default": {
+        "types": "./esm/pipeline/transformMarkdownMetadata/types.d.ts",
+        "default": "./esm/pipeline/transformMarkdownMetadata/types.js"
+      }
+    },
+    "./pipeline/transformMarkdownRelativePaths": {
+      "default": {
+        "types": "./esm/pipeline/transformMarkdownRelativePaths/index.d.ts",
+        "default": "./esm/pipeline/transformMarkdownRelativePaths/index.js"
+      }
+    },
     "./pipeline/hastUtils": {
       "default": {
         "types": "./esm/pipeline/hastUtils/index.d.ts",
         "default": "./esm/pipeline/hastUtils/index.js"
       }
     },
+    "./pipeline/loadCodeVariant": {
+      "default": {
+        "types": "./esm/pipeline/loadCodeVariant/index.d.ts",
+        "default": "./esm/pipeline/loadCodeVariant/index.js"
+      }
+    },
     "./pipeline/loaderUtils": {
       "default": {
         "types": "./esm/pipeline/loaderUtils/index.d.ts",
@@ -192,12 +267,30 @@
         "default": "./esm/pipeline/loadPrecomputedCodeHighlighterClient/index.js"
       }
     },
+    "./pipeline/loadPrecomputedSitemap": {
+      "default": {
+        "types": "./esm/pipeline/loadPrecomputedSitemap/index.d.ts",
+        "default": "./esm/pipeline/loadPrecomputedSitemap/index.js"
+      }
+    },
     "./pipeline/loadServerCodeMeta": {
       "default": {
         "types": "./esm/pipeline/loadServerCodeMeta/index.d.ts",
         "default": "./esm/pipeline/loadServerCodeMeta/index.js"
       }
     },
+    "./pipeline/loadServerPageIndex": {
+      "default": {
+        "types": "./esm/pipeline/loadServerPageIndex/index.d.ts",
+        "default": "./esm/pipeline/loadServerPageIndex/index.js"
+      }
+    },
+    "./pipeline/loadServerSitemap": {
+      "default": {
+        "types": "./esm/pipeline/loadServerSitemap/index.d.ts",
+        "default": "./esm/pipeline/loadServerSitemap/index.js"
+      }
+    },
     "./pipeline/loadServerSource": {
       "default": {
         "types": "./esm/pipeline/loadServerSource/index.d.ts",
@@ -210,6 +303,12 @@
         "default": "./esm/pipeline/parseSource/index.js"
       }
     },
+    "./pipeline/syncPageIndex": {
+      "default": {
+        "types": "./esm/pipeline/syncPageIndex/index.d.ts",
+        "default": "./esm/pipeline/syncPageIndex/index.js"
+      }
+    },
     "./pipeline/transformHtmlCodePrecomputed": {
       "default": {
         "types": "./esm/pipeline/transformHtmlCodePrecomputed/index.d.ts",
@@ -229,5 +328,6 @@
       }
     },
     "./esm": null
-  }
+  },
+  "gitSha": "574e1c4cb0ffb5cdcfb946acb4087fad4ed61f44"
 }

package/esm/CodeHighlighter/transformParsedSource.d.ts

@@ -1,3 +0,0 @@
-import type { Nodes } from 'hast';
-import { ParseSource, Transforms } from "./types.js";
-export declare function transformParsedSource(source: string, parsedSource: Nodes, filename: string, transforms: Transforms, parseSource: ParseSource): Promise<Record<string, any>>;