@mui/internal-docs-infra 0.1.1-alpha.1 → 0.1.1-alpha.11

package/createDemoData/createDemoData.js

@@ -0,0 +1,75 @@
+import { extractNameAndSlugFromUrl } from "../pipeline/loaderUtils/index.js";
+/**
+ * Creates demo data for displaying code examples with syntax highlighting.
+ * A variant is a different implementation style of the same component.
+ * Returns a data object containing demo metadata and components instead of a complete demo component.
+ * Note: It is recommended to use abstractCreateDemo to create a complete demo component rather than just demo data.
+ * @param url Depends on `import.meta.url` to determine the source file location.
+ * @param variants The variants of the component to be rendered in the demo.
+ * @param meta Additional meta for the demo.
+ */
+export function createDemoDataWithVariants(url, variants, meta) {
+  var _meta$name, _meta$slug;
+  if (!url.startsWith('file:')) {
+    throw new Error('createDemoData() requires the `url` parameter to be a file URL. Use `import.meta.url` to get the current file URL.');
+  }
+  if (!meta || !meta.precompute && !meta.skipPrecompute) {
+    throw new Error('createDemoData() was unable to precompute the code. Ensure the createDemoData() function is called within a path used for demo indexes. Run `pnpm run check:conventions:demo`');
+  }
+  var precompute = meta.precompute;
+
+  // Generate name and slug from URL if not provided in meta
+  var generatedMeta = extractNameAndSlugFromUrl(url);
+  var name = (_meta$name = meta.name) != null ? _meta$name : generatedMeta.name;
+  var slug = (_meta$slug = meta.slug) != null ? _meta$slug : generatedMeta.slug;
+  var displayName = (meta == null ? void 0 : meta.displayName) || "".concat(name.replace(/ /g, ''), "Demo");
+  return {
+    name: name,
+    slug: slug,
+    displayName: displayName,
+    precompute: precompute,
+    CodeExternalsProvider: meta == null ? void 0 : meta.CodeExternalsProvider,
+    url: url,
+    components: variants
+  };
+}
+
+/**
+ * Creates demo data for displaying code examples with syntax highlighting.
+ * Returns a data object containing demo metadata and components instead of a complete demo component.
+ * Note: It is recommended to use abstractCreateDemo to create a complete demo component rather than just demo data.
+ * @param url Depends on `import.meta.url` to determine the source file location.
+ * @param component The component to be rendered in the demo.
+ * @param meta Additional meta for the demo.
+ */
+export function createDemoData(url, component, meta) {
+  return createDemoDataWithVariants(url, {
+    Default: component
+  }, meta);
+}
+
+/**
+ * Creates a demo data object for a global provider component with different variants.
+ *
+ * @param url The URL of the demo file.
+ * @param globalProviders The variants of the global provider to be rendered in the demo.
+ * @param meta Additional metadata for the demo data.
+ * @returns Demo data object.
+ */
+export function createDemoGlobalWithVariants(url, globalProviders, meta) {
+  return createDemoDataWithVariants(url, globalProviders, meta);
+}
+
+/**
+ * Creates a demo data object for a global provider component.
+ *
+ * @param url The URL of the demo file.
+ * @param globalProvider The global provider to be rendered in the demo.
+ * @param meta Additional metadata for the demo data.
+ * @returns Demo data object.
+ */
+export function createDemoGlobal(url, globalProvider, meta) {
+  return createDemoGlobalWithVariants(url, {
+    Default: globalProvider
+  }, meta);
+}

package/createDemoData/index.d.ts

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

package/createDemoData/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/createDemoData/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}

package/createDemoData/index.js

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

package/createDemoData/types.d.ts

@@ -0,0 +1,28 @@
+import type { Code } from "../CodeHighlighter/types.js";
+export type CreateDemoDataMeta = {
+  name?: string;
+  slug?: string;
+  displayName?: string;
+  skipPrecompute?: boolean;
+  precompute?: Code;
+  CodeExternalsProvider?: React.ComponentType<{
+    children: React.ReactNode;
+  }>;
+};
+export type DemoData<T extends React.ComponentType<any> = React.ComponentType> = {
+  name: string;
+  slug: string;
+  displayName: string;
+  precompute: Code | undefined;
+  CodeExternalsProvider: React.ComponentType<{
+    children: React.ReactNode;
+  }> | undefined;
+  url: string;
+  components: {
+    [key: string]: T;
+  };
+};
+export type DemoGlobalProvider = React.ComponentType<{
+  children: React.ReactNode;
+}>;
+export type DemoGlobalData = DemoData<DemoGlobalProvider>;

package/createDemoData/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/createDemoData/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAErD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,qBAAqB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAAE,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;KAAE,CAAC,CAAC;CAC5E,CAAC;AAEF,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,aAAa,IAAI;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,IAAI,GAAG,SAAS,CAAC;IAC7B,qBAAqB,EAAE,KAAK,CAAC,aAAa,CAAC;QAAE,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;KAAE,CAAC,GAAG,SAAS,CAAC;IACtF,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAA;KAAE,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,aAAa,CAAC;IAAE,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAAE,CAAC,CAAC;AACpF,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC,kBAAkB,CAAC,CAAC"}

package/createDemoData/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,16 +1,19 @@
 {
   "name": "@mui/internal-docs-infra",
-  "version": "0.1.1-alpha.1",
+  "version": "0.1.1-alpha.11",
   "author": "MUI Team",
   "description": "MUI Infra - internal documentation creation tools.",
-  "type": "module",
   "main": "./index.js",
   "exports": {
     "./package.json": "./package.json",
     ".": "./index.js",
     "./*": "./*/index.js",
     "./*/types": "./*/types.js",
-    "./*/errors": "./*/errors.js"
+    "./*/errors": "./*/errors.js",
+    "./pipeline": "./pipeline/index.js",
+    "./pipeline/*": "./pipeline/*/index.js",
+    "./pipeline/*/types": "./pipeline/*/types.js",
+    "./pipeline/*/errors": "./pipeline/*/errors.js"
   },
   "keywords": [
     "react",
@@ -40,10 +43,12 @@
     "js-sha256": "^0.11.1",
     "jsondiffpatch": "^0.7.3",
     "kebab-case": "^2.0.2",
+    "lz-string": "^1.5.0",
     "prettier": "^3.5.3",
     "rehype-parse": "^9.0.1",
     "rehype-remark": "^10.0.1",
     "rehype-sanitize": "^6.0.0",
+    "remark-parse": "^11.0.0",
     "remark-stringify": "^11.0.0",
     "unified": "^11.0.5",
     "unist-util-visit": "^5.0.0",
@@ -59,12 +64,13 @@
       "optional": true
     }
   },
-  "publishConfig": {
-    "access": "public",
-    "directory": "build"
-  },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=22.0.0"
   },
-  "private": false
+  "private": false,
+  "type": "module",
+  "module": "./index.js",
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/pipeline/hastUtils/hastUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hastUtils.d.ts","sourceRoot":"","sources":["../../../src/pipeline/hastUtils/hastUtils.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,MAAM,CAAC;AAM/C,wBAAgB,SAAS,CAAC,IAAI,EAAE,SAAS,GAAG,KAAK,CAAC,SAAS,CAE1D;AAED,wBAAgB,eAAe,CAAC,UAAU,EAAE,SAAS,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,GAAG,KAAK,CAAC,SAAS,CAa7F;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAiB9F;AAED,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,EACjD,WAAW,CAAC,EAAE,OAAO,GACpB,KAAK,CAAC,SAAS,CAqBjB"}

package/{hast/hast.js → pipeline/hastUtils/hastUtils.js}

@@ -1,3 +1,4 @@
+import _typeof from "@babel/runtime/helpers/esm/typeof";
 import { Fragment, jsx, jsxs } from 'react/jsx-runtime';
 import { toText } from 'hast-util-to-text';
 import { toJsxRuntime } from 'hast-util-to-jsx-runtime';
@@ -57,7 +58,7 @@ export function stringOrHastToJsx(source, highlighted) {
   } else {
     hast = source;
   }
-  if (highlighted) {
+  if (highlighted && _typeof(hast) === 'object') {
     return hastToJsx(hast);
   }
   return toText(hast, {

package/pipeline/hastUtils/index.d.ts

@@ -0,0 +1 @@
+export * from "./hastUtils.js";

package/pipeline/hastUtils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/pipeline/hastUtils/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}

package/pipeline/hastUtils/index.js

@@ -0,0 +1 @@
+export * from "./hastUtils.js";

package/pipeline/loadPrecomputedCodeHighlighter/emitExternalsProvider.d.ts

@@ -0,0 +1,54 @@
+export interface LoaderContext {
+  resourcePath: string;
+  addDependency(dependency: string): void;
+  emitFile?(name: string, content: string): void;
+}
+export interface ExternalsProviderInfo {
+  fileName: string;
+  content: string;
+  relativePath: string;
+}
+/**
+ * Creates a relative import path from source file to target file
+ */
+declare function createRelativePath(fromFile: string, toFile: string): string;
+/**
+ * Creates a structured path for generated externals files based on the source file location
+ * Example: app/components/checkbox/demos/basic/index.ts -> generated/demo-externals/app/components/checkbox/demos/basic.tsx
+ */
+declare function createGeneratedFilePath(resourcePath: string, projectRoot: string): Promise<{
+  filePath: string;
+  relativePath: string;
+}>;
+/**
+ * Determines the appropriate build directory for temporary files
+ * to avoid checking generated files into source control.
+ */
+declare function getBuildDirectory(resourcePath: string): Promise<string>;
+/**
+ * Finds the project root by looking for 'app' directory or common project markers
+ */
+declare function findProjectRoot(startPath: string): Promise<string>;
+/**
+ * Ensures that the generated demo externals directory is added to .gitignore
+ * to prevent accidentally committing these generated files.
+ */
+declare function ensureGitignoreEntry(projectRoot: string): Promise<void>;
+/**
+ * Emits an externals provider file using the best available method:
+ * 1. Use emitFile if available (webpack)
+ * 2. Fall back to structured filesystem writing to generated/demo-externals/ (turbopack/other bundlers)
+ *
+ * @param loaderContext - The loader context with emitFile capability
+ * @param externalsProviderInfo - The externals provider file information
+ * @returns The import path to use for the generated file
+ */
+export declare function emitExternalsProvider(loaderContext: LoaderContext, externalsProviderInfo: ExternalsProviderInfo): Promise<string>;
+export declare const testHelpers: {
+  createRelativePath: typeof createRelativePath;
+  createGeneratedFilePath: typeof createGeneratedFilePath;
+  getBuildDirectory: typeof getBuildDirectory;
+  findProjectRoot: typeof findProjectRoot;
+  ensureGitignoreEntry: typeof ensureGitignoreEntry;
+};
+export {};

package/pipeline/loadPrecomputedCodeHighlighter/emitExternalsProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"emitExternalsProvider.d.ts","sourceRoot":"","sources":["../../../src/pipeline/loadPrecomputedCodeHighlighter/emitExternalsProvider.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,aAAa;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,QAAQ,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,iBAAS,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAIpE;AAED;;;GAGG;AACH,iBAAe,uBAAuB,CACpC,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE,CAAC,CAoCrD;AAED;;;GAGG;AACH,iBAAe,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAwCtE;AAED;;GAEG;AACH,iBAAe,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CA+DjE;AAED;;;GAGG;AACH,iBAAe,oBAAoB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAkFtE;AAED;;;;;;;;GAQG;AACH,wBAAsB,qBAAqB,CACzC,aAAa,EAAE,aAAa,EAC5B,qBAAqB,EAAE,qBAAqB,GAC3C,OAAO,CAAC,MAAM,CAAC,CAgCjB;AAGD,eAAO,MAAM,WAAW;;;;;;CAMvB,CAAC"}