@mui/internal-docs-infra 0.4.1-canary.8 → 0.5.1-canary.0

package/{esm/CodeControllerContext/CodeControllerContext.d.ts → CodeControllerContext/CodeControllerContext.d.mts}

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import type { ControlledCode } from "../CodeHighlighter/types.js";
+import type { ControlledCode } from "../CodeHighlighter/types.mjs";
 export type Selection = {
   variant: string;
   fileName?: string;

package/CodeControllerContext/index.d.mts

@@ -0,0 +1 @@
+export * from "./CodeControllerContext.mjs";

package/CodeControllerContext/index.mjs

@@ -0,0 +1 @@
+export * from "./CodeControllerContext.mjs";

package/CodeExternalsContext/index.d.mts

@@ -0,0 +1 @@
+export * from "./CodeExternalsContext.mjs";

package/CodeExternalsContext/index.mjs

@@ -0,0 +1 @@
+export * from "./CodeExternalsContext.mjs";

package/CodeHighlighter/CodeHighlighter.d.mts

@@ -0,0 +1,2 @@
+import type { CodeHighlighterProps } from "./types.mjs";
+export declare function CodeHighlighter<T extends {}>(props: CodeHighlighterProps<T>): import("react/jsx-runtime").JSX.Element;

package/{esm/CodeHighlighter/CodeHighlighter.js → CodeHighlighter/CodeHighlighter.mjs}

@@ -1,12 +1,12 @@
 import * as React from 'react';
-import { loadCodeVariant } from "../pipeline/loadCodeVariant/loadCodeVariant.js";
-import { loadCodeFallback } from "../pipeline/loadCodeVariant/loadCodeFallback.js";
-import { CodeHighlighterClient } from "./CodeHighlighterClient.js";
-import { maybeCodeInitialData } from "../pipeline/loadCodeVariant/maybeCodeInitialData.js";
-import { hasAllVariants } from "../pipeline/loadCodeVariant/hasAllCodeVariants.js";
-import { getFileNameFromUrl, getLanguageFromExtension } from "../pipeline/loaderUtils/index.js";
-import { codeToFallbackProps } from "./codeToFallbackProps.js";
-import * as Errors from "./errors.js";
+import { loadCodeVariant } from "../pipeline/loadCodeVariant/loadCodeVariant.mjs";
+import { loadCodeFallback } from "../pipeline/loadCodeVariant/loadCodeFallback.mjs";
+import { CodeHighlighterClient } from "./CodeHighlighterClient.mjs";
+import { maybeCodeInitialData } from "../pipeline/loadCodeVariant/maybeCodeInitialData.mjs";
+import { hasAllVariants } from "../pipeline/loadCodeVariant/hasAllCodeVariants.mjs";
+import { getFileNameFromUrl, getLanguageFromExtension } from "../pipeline/loaderUtils/index.mjs";
+import { codeToFallbackProps } from "./codeToFallbackProps.mjs";
+import * as Errors from "./errors.mjs";
 import { jsx as _jsx } from "react/jsx-runtime";
 const DEBUG = false; // Set to true for debugging purposes
 

package/CodeHighlighter/CodeHighlighterClient.d.mts

@@ -0,0 +1,2 @@
+import { CodeHighlighterClientProps } from "./types.mjs";
+export declare function CodeHighlighterClient(props: CodeHighlighterClientProps): import("react/jsx-runtime").JSX.Element;

package/{esm/CodeHighlighter/CodeHighlighterClient.js → CodeHighlighter/CodeHighlighterClient.mjs}

@@ -1,15 +1,15 @@
 'use client';
 
 import * as React from 'react';
-import { useCodeContext } from "../CodeProvider/CodeContext.js";
-import { CodeHighlighterContext } from "./CodeHighlighterContext.js";
-import { maybeCodeInitialData } from "../pipeline/loadCodeVariant/maybeCodeInitialData.js";
-import { hasAllVariants } from "../pipeline/loadCodeVariant/hasAllCodeVariants.js";
-import { CodeHighlighterFallbackContext } from "./CodeHighlighterFallbackContext.js";
-import { useControlledCode } from "../CodeControllerContext/index.js";
-import { codeToFallbackProps } from "./codeToFallbackProps.js";
-import { mergeCodeMetadata } from "../pipeline/loadCodeVariant/mergeCodeMetadata.js";
-import * as Errors from "./errors.js";
+import { useCodeContext } from "../CodeProvider/CodeContext.mjs";
+import { CodeHighlighterContext } from "./CodeHighlighterContext.mjs";
+import { maybeCodeInitialData } from "../pipeline/loadCodeVariant/maybeCodeInitialData.mjs";
+import { hasAllVariants } from "../pipeline/loadCodeVariant/hasAllCodeVariants.mjs";
+import { CodeHighlighterFallbackContext } from "./CodeHighlighterFallbackContext.mjs";
+import { useControlledCode } from "../CodeControllerContext/index.mjs";
+import { codeToFallbackProps } from "./codeToFallbackProps.mjs";
+import { mergeCodeMetadata } from "../pipeline/loadCodeVariant/mergeCodeMetadata.mjs";
+import * as Errors from "./errors.mjs";
 import { jsx as _jsx } from "react/jsx-runtime";
 const DEBUG = false; // Set to true for debugging purposes
 

package/{esm/CodeHighlighter/CodeHighlighterContext.d.ts → CodeHighlighter/CodeHighlighterContext.d.mts}

@@ -1,6 +1,6 @@
 import * as React from 'react';
-import { Code, ControlledCode } from "./types.js";
-import { Selection } from "../CodeControllerContext/index.js";
+import { Code, ControlledCode } from "./types.mjs";
+import { Selection } from "../CodeControllerContext/index.mjs";
 export interface CodeHighlighterContextType {
   code?: Code;
   setCode?: React.Dispatch<React.SetStateAction<ControlledCode | undefined>>;

package/{esm/CodeHighlighter/CodeHighlighterFallbackContext.d.ts → CodeHighlighter/CodeHighlighterFallbackContext.d.mts}

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { ContentLoadingVariant } from "./types.js";
+import { ContentLoadingVariant } from "./types.mjs";
 export interface CodeHighlighterFallbackContext extends ContentLoadingVariant {
   extraVariants?: Record<string, ContentLoadingVariant>;
 }

package/{esm/CodeHighlighter/codeToFallbackProps.d.ts → CodeHighlighter/codeToFallbackProps.d.mts}

@@ -1,2 +1,2 @@
-import { BaseContentLoadingProps, Code } from "./types.js";
+import { BaseContentLoadingProps, Code } from "./types.mjs";
 export declare function codeToFallbackProps(variant: string, code?: Code, fileName?: string, needsAllFiles?: boolean, needsAllVariants?: boolean): BaseContentLoadingProps;

package/{esm/CodeHighlighter/codeToFallbackProps.js → CodeHighlighter/codeToFallbackProps.mjs}

@@ -1,4 +1,4 @@
-import { stringOrHastToJsx } from "../pipeline/hastUtils/index.js";
+import { stringOrHastToJsx } from "../pipeline/hastUtils/index.mjs";
 function toExtraSource(variantCode, fileName) {
   return Object.entries(variantCode.extraFiles || {}).reduce((acc, [name, file]) => {
     if (name !== fileName && typeof file === 'object' && file?.source) {

package/CodeHighlighter/index.d.mts

@@ -0,0 +1 @@
+export * from "./CodeHighlighter.mjs";

package/CodeHighlighter/index.mjs

@@ -0,0 +1 @@
+export * from "./CodeHighlighter.mjs";

package/{esm/CodeHighlighter/parseControlledCode.d.ts → CodeHighlighter/parseControlledCode.d.mts}

@@ -1,4 +1,4 @@
-import type { Code, ControlledCode, ParseSource } from "./types.js";
+import type { Code, ControlledCode, ParseSource } from "./types.mjs";
 /**
  * Pure function to parse controlled code and convert it to regular Code format.
  * Handles the conversion from ControlledCode (string|null sources) to Code (HAST nodes).

package/{esm/CodeProvider/CodeContext.d.ts → CodeProvider/CodeContext.d.mts}

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import type { LoadCodeMeta, LoadSource, LoadVariantMeta, ParseSource, SourceTransformers, SourceEnhancers, Code, ControlledCode, LoadFallbackCodeOptions, LoadVariantOptions, Externals, VariantCode } from "../CodeHighlighter/types.js";
+import type { LoadCodeMeta, LoadSource, LoadVariantMeta, ParseSource, SourceTransformers, SourceEnhancers, Code, ControlledCode, LoadFallbackCodeOptions, LoadVariantOptions, Externals, VariantCode } from "../CodeHighlighter/types.mjs";
 export type LoadFallbackCodeFn = (url: string, initialVariant: string, loaded: Code | undefined, options?: LoadFallbackCodeOptions) => Promise<{
   code: Code;
   processedGlobalsCode?: Array<Code>;

package/{esm/CodeProvider/CodeProvider.d.ts → CodeProvider/CodeProvider.d.mts}

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import type { LoadCodeMeta, LoadSource, LoadVariantMeta, SourceEnhancers } from "../CodeHighlighter/types.js";
+import type { LoadCodeMeta, LoadSource, LoadVariantMeta, SourceEnhancers } from "../CodeHighlighter/types.mjs";
 export declare function CodeProvider({
   children,
   loadCodeMeta,

package/{esm/CodeProvider/CodeProvider.js → CodeProvider/CodeProvider.mjs}

@@ -2,15 +2,15 @@
 
 import * as React from 'react';
 import { createStarryNight } from '@wooorm/starry-night';
-import { CodeContext } from "./CodeContext.js";
-import { extensionMap, grammars } from "../pipeline/parseSource/grammars.js";
-import { starryNightGutter } from "../pipeline/parseSource/addLineGutters.js";
+import { CodeContext } from "./CodeContext.mjs";
+import { extensionMap, grammars } from "../pipeline/parseSource/grammars.mjs";
+import { starryNightGutter } from "../pipeline/parseSource/addLineGutters.mjs";
 // Import the heavy functions
-import { loadCodeFallback } from "../pipeline/loadCodeVariant/loadCodeFallback.js";
-import { loadCodeVariant } from "../pipeline/loadCodeVariant/loadCodeVariant.js";
-import { parseCode } from "../pipeline/loadCodeVariant/parseCode.js";
-import { parseControlledCode } from "../CodeHighlighter/parseControlledCode.js";
-import { computeHastDeltas, getAvailableTransforms } from "../pipeline/loadCodeVariant/computeHastDeltas.js";
+import { loadCodeFallback } from "../pipeline/loadCodeVariant/loadCodeFallback.mjs";
+import { loadCodeVariant } from "../pipeline/loadCodeVariant/loadCodeVariant.mjs";
+import { parseCode } from "../pipeline/loadCodeVariant/parseCode.mjs";
+import { parseControlledCode } from "../CodeHighlighter/parseControlledCode.mjs";
+import { computeHastDeltas, getAvailableTransforms } from "../pipeline/loadCodeVariant/computeHastDeltas.mjs";
 import { jsx as _jsx } from "react/jsx-runtime";
 export function CodeProvider({
   children,

package/CodeProvider/index.d.mts

@@ -0,0 +1 @@
+export * from "./CodeProvider.mjs";

package/CodeProvider/index.mjs

@@ -0,0 +1 @@
+export * from "./CodeProvider.mjs";

package/{esm/abstractCreateDemo/abstractCreateDemo.d.ts → abstractCreateDemo/abstractCreateDemo.d.mts}

@@ -1,6 +1,6 @@
 import * as React from 'react';
-import type { Code, CodeHighlighterProps, ContentLoadingProps, ContentProps, LoadCodeMeta, LoadSource, LoadVariantMeta, ParseSource } from "../CodeHighlighter/types.js";
-import { DemoGlobalData } from "../createDemoData/types.js";
+import type { Code, CodeHighlighterProps, ContentLoadingProps, ContentProps, LoadCodeMeta, LoadSource, LoadVariantMeta, ParseSource } from "../CodeHighlighter/types.mjs";
+import { DemoGlobalData } from "../createDemoData/types.mjs";
 type CreateDemoMeta = {
   name?: string;
   slug?: string;

package/{esm/abstractCreateDemo/abstractCreateDemo.js → abstractCreateDemo/abstractCreateDemo.mjs}

@@ -1,6 +1,6 @@
 import * as React from 'react';
-import { CodeHighlighter } from "../CodeHighlighter/index.js";
-import { createDemoDataWithVariants } from "../createDemoData/index.js";
+import { CodeHighlighter } from "../CodeHighlighter/index.mjs";
+import { createDemoDataWithVariants } from "../createDemoData/index.mjs";
 import { jsx as _jsx } from "react/jsx-runtime";
 export function abstractCreateDemo(options, url, variants, meta) {
   const demoData = createDemoDataWithVariants(url, variants, meta);

package/abstractCreateDemo/index.d.mts

@@ -0,0 +1 @@
+export * from "./abstractCreateDemo.mjs";

package/abstractCreateDemo/index.mjs

@@ -0,0 +1 @@
+export * from "./abstractCreateDemo.mjs";

package/{esm/abstractCreateDemoClient/abstractCreateDemoClient.d.ts → abstractCreateDemoClient/abstractCreateDemoClient.d.mts}

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import type { Externals } from "../CodeHighlighter/types.js";
+import type { Externals } from "../CodeHighlighter/types.mjs";
 type CreateDemoClientMeta = {
   name?: string;
   slug?: string;

package/{esm/abstractCreateDemoClient/abstractCreateDemoClient.js → abstractCreateDemoClient/abstractCreateDemoClient.mjs}

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { CodeExternalsContext } from "../CodeExternalsContext/index.js";
+import { CodeExternalsContext } from "../CodeExternalsContext/index.mjs";
 import { jsx as _jsx } from "react/jsx-runtime";
 /**
  * Abstract factory function for creating demo client providers.

package/abstractCreateDemoClient/index.d.mts

@@ -0,0 +1 @@
+export * from "./abstractCreateDemoClient.mjs";

package/abstractCreateDemoClient/index.mjs

@@ -0,0 +1 @@
+export * from "./abstractCreateDemoClient.mjs";

package/cli/index.mjs

@@ -0,0 +1,10 @@
+import { createRequire } from 'node:module';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import runValidate from "./runValidate.mjs";
+function getVersion() {
+  return createRequire(import.meta.url)('../../package.json').version;
+}
+yargs().scriptName('docs-infra').usage('$0 <command> [args]').command(runValidate).demandCommand(1, 'You need at least one command before moving on').strict().help()
+// MUI_VERSION is set through the code-infra build command.
+.version("0.5.0" || getVersion()).parse(hideBin(process.argv));

package/{esm/cli/runValidate.js → cli/runValidate.mjs}

@@ -5,8 +5,8 @@ import path from 'node:path';
 import { unified } from 'unified';
 import remarkParse from 'remark-parse';
 import remarkMdx from 'remark-mdx';
-import { nameMark, performanceMeasure } from "../pipeline/loadPrecomputedCodeHighlighter/performanceLogger.js";
-import { transformMarkdownMetadata } from "../pipeline/transformMarkdownMetadata/transformMarkdownMetadata.js";
+import { nameMark, performanceMeasure } from "../pipeline/loadPrecomputedCodeHighlighter/performanceLogger.mjs";
+import { transformMarkdownMetadata } from "../pipeline/transformMarkdownMetadata/transformMarkdownMetadata.mjs";
 const completeMessage = message => `✓ ${chalk.green(message)}`;
 const functionName = 'Run Validate';
 

package/{esm/createDemoData/createDemoData.d.ts → createDemoData/createDemoData.d.mts}

@@ -1,4 +1,4 @@
-import { CreateDemoDataMeta, DemoData, DemoGlobalData, DemoGlobalProvider } from "./types.js";
+import { CreateDemoDataMeta, DemoData, DemoGlobalData, DemoGlobalProvider } from "./types.mjs";
 /**
  * Creates demo data for displaying code examples with syntax highlighting.
  * A variant is a different implementation style of the same component.

package/{esm/createDemoData/createDemoData.js → createDemoData/createDemoData.mjs}

@@ -1,4 +1,4 @@
-import { extractNameAndSlugFromUrl } from "../pipeline/loaderUtils/index.js";
+import { extractNameAndSlugFromUrl } from "../pipeline/loaderUtils/index.mjs";
 /**
  * Creates demo data for displaying code examples with syntax highlighting.
  * A variant is a different implementation style of the same component.

package/createDemoData/index.d.mts

@@ -0,0 +1 @@
+export * from "./createDemoData.mjs";

package/createDemoData/index.mjs

@@ -0,0 +1 @@
+export * from "./createDemoData.mjs";

package/{esm/createDemoData/types.d.ts → createDemoData/types.d.mts}

@@ -1,4 +1,4 @@
-import type { Code } from "../CodeHighlighter/types.js";
+import type { Code } from "../CodeHighlighter/types.mjs";
 export type CreateDemoDataMeta = {
   name?: string;
   slug?: string;

package/{esm/createSitemap/createSitemap.d.ts → createSitemap/createSitemap.d.mts}

@@ -1,5 +1,5 @@
 import type * as React from 'react';
-import type { Sitemap } from "./types.js";
+import type { Sitemap } from "./types.mjs";
 type CreateSitemapMeta = {
   name?: string;
   slug?: string;

package/{esm/createSitemap/createSitemap.js → createSitemap/createSitemap.mjs}

@@ -9,7 +9,7 @@ function isNextJsContext() {
   typeof process.env.__NEXT_PROCESSED_ENV === 'string' ||
   // Next.js build
   typeof process.env.NEXT_PHASE === 'string') // Next.js build phase
-  ;
+;
 }
 
 /**

package/createSitemap/index.d.mts

@@ -0,0 +1 @@
+export * from "./createSitemap.mjs";

package/createSitemap/index.mjs

@@ -0,0 +1 @@
+export * from "./createSitemap.mjs";

package/createSitemap/types.d.mts

@@ -0,0 +1,97 @@
+import type { Metadata } from 'next';
+/**
+ * Section data structure from sitemap
+ */
+export interface SitemapSection {
+  title: string;
+  children?: Record<string, SitemapSection>;
+}
+/**
+ * Part data structure from sitemap (for component parts)
+ */
+export interface SitemapPart {
+  props?: string[];
+  dataAttributes?: string[];
+  cssVariables?: string[];
+}
+/**
+ * Export data structure from sitemap (for exported functions/components)
+ */
+export interface SitemapExport {
+  props?: string[];
+  dataAttributes?: string[];
+  cssVariables?: string[];
+}
+/**
+ * Page data structure from sitemap
+ */
+export interface SitemapPage {
+  title?: string;
+  slug: string;
+  path: string;
+  description?: string;
+  keywords?: string[];
+  sections?: Record<string, SitemapSection>;
+  parts?: Record<string, SitemapPart>;
+  exports?: Record<string, SitemapExport>;
+  tags?: string[];
+  skipDetailSection?: boolean;
+  audience?: Audience;
+  index?: boolean;
+  image?: {
+    url: string;
+    alt?: string;
+  };
+}
+/**
+ * Section data from sitemap
+ */
+export interface SitemapSectionData {
+  title: string;
+  prefix: string;
+  pages: SitemapPage[];
+}
+/**
+ * Orama schema property types
+ * See: https://docs.orama.com/docs/orama-js/usage/create#schema-properties-and-types
+ */
+export type OramaSchemaType = 'string' | 'number' | 'boolean' | 'string[]' | 'number[]' | 'boolean[]' | `vector[${number}]`;
+/**
+ * Sitemap structure
+ */
+export interface Sitemap {
+  schema: Record<string, OramaSchemaType>;
+  data: Record<string, SitemapSectionData>;
+}
+export type Audience = 'private' | 'introductory' | 'intermediate' | 'advanced' | 'business';
+/**
+ * Page metadata type extending Next.js `Metadata`.
+ *
+ * Adds the `audience` field under `other` using the WHATWG MetaExtensions `audience` meta name.
+ * All standard Next.js metadata fields (title, description, openGraph, etc.) remain available.
+ *
+ * @see https://nextjs.org/docs/app/api-reference/functions/generate-metadata#metadata-fields
+ */
+export type NextMetadata = Metadata & {
+  other?: {
+    /**
+     * Categorize the principal intended audience for the page.
+     * Uses the WHATWG MetaExtensions `audience` meta name.
+     *
+     * When omitted, the page is public and intended for all audiences.
+     *
+     * - `'private'`: Internal page, not intended for public consumption.
+     *   Should be paired with `robots: { index: false }` to exclude from public indexing.
+     * - `'introductory'`: Content aimed at beginners.
+     * - `'intermediate'`: Content aimed at intermediate users.
+     * - `'advanced'`: Content aimed at advanced users.
+     * - `'business'`: Content aimed at prospective customers and decision-makers
+     *   (e.g. marketing pages, pricing, product overviews).
+     *
+     * @see https://wiki.whatwg.org/wiki/MetaExtensions
+     * @see https://brittlebit.org/specifications/html-meta-audience/specification-for-html-meta-element-with-name-value-audience.html
+     */
+    audience?: Audience;
+    [key: string]: unknown;
+  };
+};