@mui/internal-code-infra 0.0.4-canary.10 → 0.0.4-canary.100

package/LICENSE

@@ -1,4 +1,4 @@
-The MIT License (MIT)
+MIT License
 
 Copyright (c) 2019 Material-UI SAS
 

package/README.md

@@ -37,22 +37,36 @@ This is stored in the `docs` top-level directory.
 
 Whenever new packages are added to the repo (that will get published to npm) or a private package is turned into a public one, follow the below steps before invoking the publish workflow of the previous section.
 
-1. Goto your repo's code base on your system, open terminal and run:
+> [!NOTE]
+> This applies to packages published to npm, which is where Trusted Publishing needs the package to already exist. Packages that set `publishConfig.registry` to another registry are skipped by this check and need none of these steps.
+
+1. Go to your repo's code base on your system, then log in to npm using
+
+```bash
+npm login
+```
+
+2. Once logged-in, open terminal and run:
 
 ```bash
 pnpm code-infra publish-new-package
 ```
 
 This command detects the new public packages in the repo and asks for your confirmation before publishing them to the npm registry. Add the `--dryRun` flag to skip the actual publishing.
+If publishing fails with npm asking for `otp`, run the command again with 6 digit auth code from your authenticator app where you've added npm; Google Authenticator, Authy or similar:
+
+```bash
+pnpm code-infra publish-new-package --otp=123456
+```
 
-2. Goto the settings link for each packages, ie, https://www.npmjs.com/package/<pkg-name>/access , and setup `Trusted Publisher`.
-3. In `Select your publisher` step in the above link, click on the `Github Actions` button to configure Github actions based trusted publishing.
-4. Fill in the details of the repo -
+3. Go to the settings link for each package, e.g., `https://www.npmjs.com/package/<pkg-name>/access`, and setup `Trusted Publisher`.
+4. In the `Select your publisher` step in the above link, click on the `GitHub Actions` button to configure GitHub Actions-based trusted publishing.
+5. Fill in the details of the repo -
    1. `Organization or user` as `mui`,
    2. `Repository` as per the new package
    3. `Workflow filename*` should be `publish.yml`
-   4. `Environment name` should be `npm-publish`
-5. In the `Publishing access` section, toggle the recommended option of `Require two-factor authentication and disallow tokens`.
-6. Finally, save the changes by clicking on `Update Package Settings` button.
+   4. `Environment name` should be `npm-publish` or `npm-publish-internal` based on whether the package is user facing package or internal package respectively.
+6. In the `Publishing access` section, toggle the recommended option of `Require two-factor authentication and disallow tokens`.
+7. Finally, save the changes by clicking on `Update Package Settings` button.
 
 After following these steps, the `Publish` workflow can be invoked again.

package/build/babel-config.d.mts

@@ -13,9 +13,10 @@ export type ReactCompilationMode = 'annotation' | 'syntax' | 'infer' | 'all';
  * @param {string} param0.runtimeVersion
  * @param {string} [param0.reactCompilerReactVersion]
  * @param {ReactCompilationMode} [param0.reactCompilerMode]
+ * @param {{ allowedCallees?: Record<string, string[]> }} [param0.displayName] - Options for the display name plugin.
  * @returns {import('@babel/core').TransformOptions} The base Babel configuration.
  */
-export declare function getBaseConfig({ debug, optimizeClsx, removePropTypes, noResolveImports, bundle, runtimeVersion, outExtension, reactCompilerReactVersion, reactCompilerMode }: {
+export declare function getBaseConfig({ debug, optimizeClsx, removePropTypes, noResolveImports, bundle, runtimeVersion, outExtension, reactCompilerReactVersion, reactCompilerMode, displayName, }: {
     debug?: boolean;
     optimizeClsx?: boolean;
     removePropTypes?: boolean;
@@ -25,6 +26,9 @@ export declare function getBaseConfig({ debug, optimizeClsx, removePropTypes, no
     runtimeVersion: string;
     reactCompilerReactVersion?: string;
     reactCompilerMode?: ReactCompilationMode;
+    displayName?: {
+        allowedCallees?: Record<string, string[]>;
+    };
 }): import('@babel/core').TransformOptions;
 export type Options = {
     bundle?: 'esm' | 'cjs';

package/build/brokenLinksChecker/crawlWorker.d.mts

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

package/build/brokenLinksChecker/index.d.mts

@@ -1,22 +1,103 @@
 export type LinkStructure = Map<string, Set<string>>;
 export type SerializedLinkStructure = {
+    /**
+     * - Object mapping page URLs to arrays of target IDs
+     */
     targets: Record<string, string[]>;
 };
+export type CrawlWorkerInput = {
+    /**
+     * - The page URL to crawl
+     */
+    pageUrl: string;
+    /**
+     * - Fully resolved crawl options
+     */
+    options: ResolvedCrawlOptions;
+};
+export type CrawlWorkerPageData = {
+    /**
+     * - The normalized page URL
+     */
+    url: string;
+    /**
+     * - HTTP status code
+     */
+    status: number;
+    /**
+     * - Array of anchor targets (e.g., '#intro')
+     */
+    targets: string[];
+    /**
+     * - Content-type of the page
+     */
+    contentType: string;
+};
+export type CrawlWorkerOutput = {
+    /**
+     * - Serialized page data
+     */
+    pageData: CrawlWorkerPageData;
+    /**
+     * - Links discovered on the page
+     */
+    links: Link[];
+    /**
+     * - HTML validation results, or null if validation was skipped/passed
+     */
+    htmlValidateResults: {
+        pageUrl: string;
+        results: import('html-validate').Result[];
+    } | null;
+};
 export type PageData = {
+    /**
+     * - The normalized page URL (without trailing slash unless root)
+     */
     url: string;
+    /**
+     * - HTTP status code from the response (e.g., 200, 404, 500)
+     */
     status: number;
+    /**
+     * - Set of available anchor targets on the page, keyed by hash (e.g., '#intro')
+     */
     targets: Set<string>;
+    /**
+     * - Content-type of the page (e.g., 'text/html', 'text/markdown')
+     */
     contentType: string;
 };
 export type Link = {
+    /**
+     * - URL of the page where this link was found, or null for seed URLs
+     */
     src: string | null;
+    /**
+     * - Accessible name/text content of the link element, or null for seed URLs
+     */
     text: string | null;
+    /**
+     * - The href attribute value (may be relative or absolute, with or without hash)
+     */
     href: string;
+    /**
+     * - Content-type of the source page (e.g., 'text/html', 'text/markdown')
+     */
     contentType?: string | null;
 };
 export type IgnoreRule = {
+    /**
+     * - Pattern(s) to match source page path
+     */
     path?: (string | RegExp) | (string | RegExp)[];
+    /**
+     * - Pattern(s) to match broken link href
+     */
     href?: (string | RegExp) | (string | RegExp)[];
+    /**
+     * - Pattern(s) to match source page content-type
+     */
     contentType?: (string | RegExp) | (string | RegExp)[];
 };
 export type NormalizedIgnoreRule = {
@@ -25,29 +106,138 @@ export type NormalizedIgnoreRule = {
     contentType: (string | RegExp)[] | undefined;
 };
 export type CrawlOptions = {
+    /**
+     * - Shell command to start the dev server (e.g., 'npm run dev'). If null, assumes server is already running
+     */
     startCommand?: string | null;
+    /**
+     * - Base URL of the site to crawl (e.g., 'http://localhost:3000')
+     */
     host: string;
+    /**
+     * - File path to write discovered link targets to. If null, targets are not persisted
+     */
     outPath?: string | null;
+    /**
+     * - Array of regex patterns to exclude from crawling (e.g., [/^\/api\//] to skip /api/* routes)
+     */
     ignoredPaths?: RegExp[];
+    /**
+     * - CSS selectors for elements whose nested links should be ignored (e.g., ['.sidebar', 'footer'])
+     */
     ignoredContent?: string[];
+    /**
+     * - Set of element IDs to ignore as link targets (defaults to '__next', '__NEXT_DATA__')
+     */
     ignoredTargets?: Set<string>;
+    /**
+     * - Pre-populated map of known valid targets to skip crawling (useful for external pages)
+     */
     knownTargets?: Map<string, Set<string>>;
+    /**
+     * - URLs to fetch known targets from (fetched JSON will be merged with knownTargets)
+     */
     knownTargetsDownloadUrl?: string[];
+    /**
+     * - Number of concurrent page fetches (defaults to 4)
+     */
     concurrency?: number;
+    /**
+     * - Starting URLs for the crawl (defaults to ['/'])
+     */
     seedUrls?: string[];
+    /**
+     * - Rules to ignore broken links. Each rule can have path, href, contentType, and/or has properties. All specified properties must match (AND logic). Within a property, multiple values use OR logic.
+     */
     ignores?: IgnoreRule[];
+    /**
+     * - Enable HTML validation on crawled pages. `false` (default): disabled. `true`: validate with recommended rules. Object: use as html-validate config — `mui:recommended` is always applied as the baseline, so most callers only need to set `rules`. Array: per-path config overrides — `mui:recommended` is applied once as the baseline and every entry whose `path` matches the page URL is layered on top; later matching entries win on conflicting rule keys. If an entry omits `extends`, it behaves like a rule patch and typically only changes the rules it names. If an entry includes `extends` (for example, re-extending `mui:recommended`), it can re-introduce or reset baseline presets rather than acting as a pure patch. An entry without `path` matches every page. If no entry matches, the page is not validated.
+     */
+    htmlValidate?: HtmlValidateOption;
+    /**
+     * - Log extra diagnostics during crawling (e.g. resolved html-validate config per page). Defaults to `false`.
+     */
+    verbose?: boolean;
 };
-export type ResolvedCrawlOptions = Omit<Required<CrawlOptions>, 'ignores'> & {
+export type HtmlValidateOverride = {
+    /**
+     * - Pattern(s) to match the page URL. Strings use exact match. Omit to match every page.
+     */
+    path?: (string | RegExp) | (string | RegExp)[];
+    /**
+     * - html-validate config (or `true` for `mui:recommended`).
+     */
+    config: true | import('html-validate').ConfigData;
+};
+export type HtmlValidateOption = boolean | import('html-validate').ConfigData | HtmlValidateOverride[];
+export type ResolvedHtmlValidateEntry = {
+    path: (string | RegExp)[] | undefined;
+    config: import('html-validate').ConfigData;
+};
+export type ResolvedCrawlOptions = Omit<Required<CrawlOptions>, 'ignores' | 'htmlValidate'> & {
     ignores: NormalizedIgnoreRule[];
+    htmlValidate: ResolvedHtmlValidateEntry[];
 };
-export type Issue = {
+export type BrokenLinkIssue = {
+    /**
+     * - Type of issue: 'broken-link' for 404 pages, 'broken-target' for missing anchors
+     */
     type: 'broken-link' | 'broken-target';
+    /**
+     * - Human-readable description of the issue (e.g., 'Target not found', 'Page returned error 404')
+     */
     message: string;
+    /**
+     * - The link object that has the issue
+     */
     link: Link;
 };
+export type HtmlValidateIssue = {
+    /**
+     * - Issue type discriminator
+     */
+    type: 'html-validate';
+    /**
+     * - Human-readable description of the issue
+     */
+    message: string;
+    /**
+     * - The page URL where the issue was found
+     */
+    pageUrl: string;
+    /**
+     * - The html-validate rule that triggered this issue (e.g., 'no-dup-id')
+     */
+    ruleId: string;
+    /**
+     * - Severity level (1 = warning, 2 = error)
+     */
+    severity: number;
+    /**
+     * - Source location of the issue
+     */
+    location: {
+        line: number;
+        column: number;
+    };
+    /**
+     * - DOM selector for the element, or null
+     */
+    selector: string | null;
+};
+export type Issue = BrokenLinkIssue | HtmlValidateIssue;
 export type CrawlResult = {
+    /**
+     * - All links discovered during the crawl
+     */
     links: Set<Link>;
+    /**
+     * - All pages crawled, keyed by normalized URL
+     */
     pages: Map<string, PageData>;
+    /**
+     * - All issues found (broken links, broken targets, and HTML validation issues)
+     */
     issues: Issue[];
 };
 /**

package/build/changelog/fetchChangelogs.d.mts

@@ -4,6 +4,9 @@ export type FetchCommitsOptions = {
     repo: string;
     lastRelease: string;
     release: string;
+    /**
+     * - GitHub organization name, defaults to 'mui'
+     */
     org?: string;
 };
 /**

package/build/changelog/types.d.ts

@@ -13,6 +13,8 @@ export interface FetchedCommitDetails {
     } | null;
     mergedAt: string | null;
     createdAt: string | null;
+    prTitle: string;
+    prBody: string;
 }
 /**
  * Parsed label information from a commit.
@@ -212,7 +214,7 @@ export interface IntroConfig {
      * - {{teamCount}}: Number of team members
      * - {{communityCount}}: Number of community contributors
      *
-     * Example: "We'd like to extend a big thank you to the {{contributorCount}} contributors who made this release possible"
+     * Example: "A big thanks to the {{contributorCount}} contributors who made this release possible."
      *
      * Set to `false` or omit to disable the thank you message.
      */

package/build/cli/cmdArgosPush.d.mts

@@ -1,6 +1,12 @@
 #!/usr/bin/env node
 export type Args = {
+    /**
+     * - Run with verbose logging
+     */
     verbose?: boolean;
+    /**
+     * - Screenshots folder path
+     */
     folder: string;
 };
 /**
@@ -8,5 +14,5 @@ export type Args = {
  * @property {boolean} [verbose] - Run with verbose logging
  * @property {string} folder - Screenshots folder path
  */
-declare const _default: import("yargs").CommandModule<{}, Args>;
-export default /** @type {import('yargs').CommandModule<{}, Args>} */ _default;
+declare const _default: import('yargs').CommandModule<{}, Args>;
+export default _default;

package/build/cli/cmdBuild.d.mts

@@ -1,18 +1,64 @@
 export type Args = {
+    /**
+     * - The bundles to build.
+     */
     bundle: import('../utils/build.mjs').BundleType[];
+    /**
+     * - The large files to build.
+     */
     hasLargeFiles: boolean;
+    /**
+     * - Whether to skip generating a package.json file in the /esm folder.
+     */
     skipBundlePackageJson: boolean;
+    /**
+     * - Whether to enable verbose logging.
+     */
     verbose: boolean;
+    /**
+     * - Whether to build types for the package.
+     */
     buildTypes: boolean;
+    /**
+     * - Whether to build types for the package.
+     */
     skipTsc: boolean;
+    /**
+     * - Whether to skip checking for Babel runtime dependencies in the package.
+     */
     skipBabelRuntimeCheck: boolean;
+    /**
+     * - Whether to skip generating the package.json file in the bundle output.
+     */
     skipPackageJson: boolean;
+    /**
+     * - Whether to skip checking for main field in package.json.
+     */
     skipMainCheck: boolean;
+    /**
+     * - Globs to be ignored by Babel.
+     */
     ignore: string[];
+    /**
+     * - Files/Directories to be copied. Can be a glob pattern.
+     */
     copy?: string[];
+    /**
+     * - Whether to use the React compiler.
+     */
     enableReactCompiler?: boolean;
+    /**
+     * - Whether to build types using typescript native (tsgo).
+     */
     tsgo?: boolean;
+    /**
+     * - Deprecated no-op; flat builds are always used.
+     */
     flat?: boolean;
+    /**
+     * - Whether to enumerate glob patterns in exports/imports into concrete entries.
+     */
+    expand: boolean;
 };
-declare const _default: import("yargs").CommandModule<{}, Args>;
-export default /** @type {import('yargs').CommandModule<{}, Args>} */ _default;
+declare const _default: import('yargs').CommandModule<{}, Args>;
+export default _default;

package/build/cli/cmdCopyFiles.d.mts

@@ -1,8 +1,20 @@
 export type Args = {
+    /**
+     * Run in silent mode without logging
+     */
     silent?: boolean;
+    /**
+     * Exclude default files from the copy operation
+     */
     excludeDefaults?: boolean;
+    /**
+     * Glob patterns to copy
+     */
     glob?: string[];
+    /**
+     * Extra files to copy
+     */
     files?: string[];
 };
-declare const _default: import("yargs").CommandModule<{}, Args>;
-export default /** @type {import('yargs').CommandModule<{}, Args>} */ _default;
+declare const _default: import('yargs').CommandModule<{}, Args>;
+export default _default;

package/build/cli/cmdExtractErrorCodes.d.mts

@@ -2,5 +2,5 @@ export type Args = import('../utils/extractErrorCodes.mjs').Args;
 /**
  * @typedef {import('../utils/extractErrorCodes.mjs').Args} Args
  */
-declare const _default: import("yargs").CommandModule<{}, import("../utils/extractErrorCodes.mjs").Args>;
-export default /** @type {import('yargs').CommandModule<{}, Args>} */ _default;
+declare const _default: import('yargs').CommandModule<{}, Args>;
+export default _default;

package/build/cli/cmdGenerateChangelog.d.mts

@@ -1,8 +1,23 @@
 export type Args = {
+    /**
+     * Path to the changelog configuration file
+     */
     config: string;
+    /**
+     * The git reference (tag/commit) of the last release
+     */
     lastRelease: string;
+    /**
+     * The git reference (tag/commit) of the new release
+     */
     release: string;
+    /**
+     * The version number for the new release
+     */
     releaseVersion: string;
+    /**
+     * The current working directory to run the command in
+     */
     cwd: string;
 };
 /**
@@ -13,5 +28,5 @@ export type Args = {
  * @property {string} releaseVersion The version number for the new release
  * @property {string} cwd The current working directory to run the command in
  */
-declare const _default: import("yargs").CommandModule<{}, Args>;
-export default /** @type {import('yargs').CommandModule<{}, Args>} */ _default;
+declare const _default: import('yargs').CommandModule<{}, Args>;
+export default _default;

package/build/cli/cmdGithubAuth.d.mts

@@ -7,5 +7,5 @@ export type Args = {
  * @property {boolean} authorize
  * @property {boolean} clear
  */
-declare const _default: import("yargs").CommandModule<{}, Args>;
-export default /** @type {import('yargs').CommandModule<{}, Args>} */ _default;
+declare const _default: import('yargs').CommandModule<{}, Args>;
+export default _default;

package/build/cli/cmdListWorkspaces.d.mts

@@ -1,9 +1,21 @@
 #!/usr/bin/env node
 export type PublicPackage = import('../utils/pnpm.mjs').PublicPackage;
 export type Args = {
+    /**
+     * - Whether to filter to only public packages
+     */
     publicOnly?: boolean;
+    /**
+     * - Output format (name, path, or json)
+     */
     output?: 'json' | 'path' | 'name' | 'publish-dir';
+    /**
+     * - Git reference to filter changes since
+     */
     sinceRef?: string;
+    /**
+     * - Same as filtering packages with --filter in pnpm. Only include packages matching the filter. See https://pnpm.io/filtering.
+     */
     filter?: string[];
 };
 /**
@@ -13,5 +25,5 @@ export type Args = {
  * @property {string} [sinceRef] - Git reference to filter changes since
  * @property {string[]} [filter] - Same as filtering packages with --filter in pnpm. Only include packages matching the filter. See https://pnpm.io/filtering.
  */
-declare const _default: import("yargs").CommandModule<{}, Args>;
-export default /** @type {import('yargs').CommandModule<{}, Args>} */ _default;
+declare const _default: import('yargs').CommandModule<{}, Args>;
+export default _default;

package/build/cli/cmdNetlifyIgnore.d.mts

@@ -1,7 +1,17 @@
 #!/usr/bin/env node
 export type Args = {
+    /**
+     * - List of workspace names to process
+     */
     workspaces: string[];
+    /**
+     * - Check mode - error if the generated content differs from current
+     */
     check?: boolean;
+    /**
+     * - Branch to compare PRs against (default: master)
+     */
+    baseBranch?: string;
 };
-declare const _default: import("yargs").CommandModule<{}, Args>;
-export default /** @type {import('yargs').CommandModule<{}, Args>} */ _default;
+declare const _default: import('yargs').CommandModule<{}, Args>;
+export default _default;

package/build/cli/cmdPublish.d.mts

@@ -1,13 +1,32 @@
 #!/usr/bin/env node
 export type PublicPackage = import('../utils/pnpm.mjs').PublicPackage;
 export type PublishOptions = import('../utils/pnpm.mjs').PublishOptions;
+export type PublishSummaryEntry = import('../utils/pnpm.mjs').PublishSummaryEntry;
 export type Args = {
-    dry-run: boolean;
-    github-release: boolean;
+    /**
+     * Run in dry-run mode without publishing
+     */
+    "dry-run": boolean;
+    /**
+     * Create a GitHub draft release after publishing
+     */
+    "github-release": boolean;
+    /**
+     * NPM dist tag to publish to
+     */
     tag: string;
+    /**
+     * Runs in CI environment
+     */
     ci: boolean;
+    /**
+     * Git SHA to use for the GitHub release workflow (local only)
+     */
     sha?: string;
+    /**
+     * Same as filtering packages with --filter in pnpm. Only publish packages matching the filter. See https://pnpm.io/filtering.
+     */
     filter?: string[];
 };
-declare const _default: import("yargs").CommandModule<{}, Args>;
-export default /** @type {import('yargs').CommandModule<{}, Args>} */ _default;
+declare const _default: import('yargs').CommandModule<{}, Args>;
+export default _default;

package/build/cli/cmdPublishCanary.d.mts

@@ -3,14 +3,32 @@ export type PublicPackage = import('../utils/pnpm.mjs').PublicPackage;
 export type VersionInfo = import('../utils/pnpm.mjs').VersionInfo;
 export type PublishOptions = import('../utils/pnpm.mjs').PublishOptions;
 export type Args = {
+    /**
+     * - Whether to run in dry-run mode
+     */
     dryRun?: boolean;
+    /**
+     * - Whether to create GitHub releases for canary packages
+     */
     githubRelease?: boolean;
+    /**
+     * - Same as filtering packages with --filter in pnpm. Only publish packages matching the filter. See https://pnpm.io/filtering.
+     */
     filter?: string[];
 };
 export type Commit = {
+    /**
+     * - Commit SHA
+     */
     sha: string;
+    /**
+     * - Commit message
+     */
     message: string;
+    /**
+     * - Commit author
+     */
     author: string;
 };
-declare const _default: import("yargs").CommandModule<{}, Args>;
-export default /** @type {import('yargs').CommandModule<{}, Args>} */ _default;
+declare const _default: import('yargs').CommandModule<{}, Args>;
+export default _default;

package/build/cli/cmdPublishNewPackage.d.mts

@@ -1,9 +1,17 @@
 export type Args = {
+    /**
+     * If true, will only log the commands without executing them
+     */
     dryRun?: boolean;
+    /**
+     * 6 digit auth code to forward to npm for two-factor authentication
+     */
+    otp?: string;
 };
 /**
  * @typedef {Object} Args
  * @property {boolean} [dryRun] If true, will only log the commands without executing them
+ * @property {string} [otp] 6 digit auth code to forward to npm for two-factor authentication
  */
-declare const _default: import("yargs").CommandModule<{}, Args>;
-export default /** @type {import('yargs').CommandModule<{}, Args>} */ _default;
+declare const _default: import('yargs').CommandModule<{}, Args>;
+export default _default;

package/build/cli/cmdRenameScope.d.mts

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+export type Args = {
+    /**
+     * Source and target scope
+     */
+    alias: [string, string];
+};
+/**
+ * @typedef {Object} Args
+ * @property {[string, string]} alias Source and target scope
+ */
+/**
+ * @param {string} alias
+ * @returns {[string, string]}
+ */
+export declare function parseAlias(alias: string): [string, string];
+declare const _default: import('yargs').CommandModule<{}, Args>;
+export default _default;