@mui/internal-bundle-size-checker 1.0.9-canary.5 → 1.0.9-canary.50

package/README.md

@@ -19,9 +19,12 @@ bundle-size-checker [options]
 
 Options:
 
-- `--analyze`: Creates a webpack-bundle-analyzer report for each bundle
-- `--accurateBundles`: Displays used bundles accurately at the cost of more CPU cycles
+- `--analyze`: Creates a report for each bundle (using rollup-plugin-visualizer)
+- `--debug`: Build with readable output (no name mangling or whitespace collapse, but still tree-shake)
+- `--verbose`: Show more detailed information during compilation
 - `--output`, `-o`: Path to output the size snapshot JSON file
+- `--filter`, `-F`: Filter entry points by glob pattern(s) applied to their IDs
+- `--concurrency`, `-c`: Number of workers to use for parallel processing
 
 ### Configuration
 

package/build/browser.d.ts

@@ -0,0 +1,2 @@
+export { calculateSizeDiff } from "./sizeDiff.js";
+export { fetchSnapshot } from "./fetchSnapshot.js";

package/build/builder.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Get sizes for a vite bundle
+ * @param {ObjectEntry} entry - The entry configuration
+ * @param {CommandLineArgs} args - Command line arguments
+ * @param {Record<string, string>} [replacements] - String replacements to apply
+ * @returns {Promise<{ sizes: Map<string, SizeSnapshotEntry>, treemapPath: string }>}
+ */
+export function getBundleSizes(entry: ObjectEntry, args: CommandLineArgs, replacements?: Record<string, string>): Promise<{
+    sizes: Map<string, SizeSnapshotEntry>;
+    treemapPath: string;
+}>;
+export type ManifestChunk = {
+    /**
+     * - Hashed filename of the chunk
+     */
+    file: string;
+    /**
+     * - Optional name of the chunk
+     */
+    name?: string | undefined;
+    /**
+     * - Original source path
+     */
+    src?: string | undefined;
+    /**
+     * - Associated CSS files
+     */
+    css?: string[] | undefined;
+    /**
+     * - Indicates if this is an entry point
+     */
+    isEntry?: boolean | undefined;
+    /**
+     * - Indicates if this is a dynamic entry point
+     */
+    isDynamicEntry?: boolean | undefined;
+    /**
+     * - Imported chunk keys
+     */
+    imports?: string[] | undefined;
+    /**
+     * - Dynamically imported chunk keys
+     */
+    dynamicImports?: string[] | undefined;
+};
+export type Manifest = Record<string, ManifestChunk>;

package/build/cli.d.ts

@@ -0,0 +1 @@
+export type SizeSnapshot = import("./sizeDiff.js").SizeSnapshot;

package/build/configLoader.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Validates and normalizes an upload configuration object
+ * @param {UploadConfig} uploadConfig - The upload configuration to normalize
+ * @param {Object} ciInfo - CI environment information
+ * @param {string} [ciInfo.branch] - Branch name from CI environment
+ * @param {boolean} [ciInfo.isPr] - Whether this is a pull request from CI environment
+ * @param {string} [ciInfo.prBranch] - PR branch name from CI environment
+ * @param {string} [ciInfo.slug] - Repository slug from CI environment
+ * @returns {NormalizedUploadConfig} - Normalized upload config
+ * @throws {Error} If required fields are missing
+ */
+export function applyUploadConfigDefaults(uploadConfig: UploadConfig, ciInfo: {
+    branch?: string | undefined;
+    isPr?: boolean | undefined;
+    prBranch?: string | undefined;
+    slug?: string | undefined;
+}): NormalizedUploadConfig;
+/**
+ * Attempts to load the config file from the given directory
+ * @param {string} rootDir - The directory to search for the config file
+ * @returns {Promise<NormalizedBundleSizeCheckerConfig>} A promise that resolves to the normalized config object
+ */
+export function loadConfig(rootDir: string): Promise<NormalizedBundleSizeCheckerConfig>;

package/build/constants.d.ts

@@ -0,0 +1 @@
+export const DASHBOARD_ORIGIN: "https://frontend-public.mui.com";

package/build/defineConfig.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Define a configuration for the bundle size checker.
+ * This is just a pass-through function for better TypeScript typing.
+ *
+ * @param {BundleSizeCheckerConfig} config - Configuration object
+ * @returns {BundleSizeCheckerConfig} The configuration object
+ */
+export default function defineConfig(config: BundleSizeCheckerConfig): BundleSizeCheckerConfig;

package/build/fetchSnapshot.d.ts

@@ -0,0 +1,7 @@
+/**
+ *
+ * @param {string} repo - The name of the repository e.g. 'mui/material-ui'
+ * @param {string} sha - The commit SHA
+ * @returns {Promise<import('./sizeDiff.js').SizeSnapshot>} - The size snapshot data
+ */
+export function fetchSnapshot(repo: string, sha: string): Promise<import("./sizeDiff.js").SizeSnapshot>;

package/build/fetchSnapshotWithFallback.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Attempts to fetch a snapshot with fallback to parent commits
+ * @param {string} repo - Repository name
+ * @param {string} commit - The commit SHA to start from
+ * @param {number} [fallbackDepth=3] - How many parent commits to try as fallback
+ * @returns {Promise<{snapshot: import('./sizeDiff.js').SizeSnapshot | null, actualCommit: string | null}>}
+ */
+export function fetchSnapshotWithFallback(repo: string, commit: string, fallbackDepth?: number): Promise<{
+    snapshot: import("./sizeDiff.js").SizeSnapshot | null;
+    actualCommit: string | null;
+}>;

package/build/formatUtils.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Format utilities for consistent display of sizes and percentages
+ */
+export const byteSizeFormatter: Intl.NumberFormat;
+export const byteSizeChangeFormatter: Intl.NumberFormat;
+export const displayPercentFormatter: Intl.NumberFormat;

package/build/git.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Gets parent commits for a given commit SHA using git CLI
+ * @param {string} repo - Repository name (e.g., 'mui/material-ui') - ignored for git CLI
+ * @param {string} commit - The commit SHA to start from
+ * @param {number} depth - How many commits to retrieve (including the starting commit)
+ * @returns {Promise<string[]>} Array of commit SHAs in chronological order (excluding the starting commit)
+ */
+export function getParentCommits(repo: string, commit: string, depth?: number): Promise<string[]>;
+/**
+ * Compares two commits and returns merge base information using git CLI
+ * @param {string} base - Base commit SHA
+ * @param {string} head - Head commit SHA
+ * @returns {Promise<string>} Object with merge base commit info
+ */
+export function getMergeBase(base: string, head: string): Promise<string>;
+/**
+ * Gets the current repository owner and name from git remote
+ * @returns {Promise<{owner: string | null, name: string | null}>}
+ */
+export function getCurrentRepoInfo(): Promise<{
+    owner: string | null;
+    name: string | null;
+}>;

package/build/github.d.ts

@@ -0,0 +1,2 @@
+/** @type {import('@octokit/rest').Octokit} */
+export const octokit: import("@octokit/rest").Octokit;

package/build/index.d.ts

@@ -0,0 +1,4 @@
+import defineConfig from './defineConfig.js';
+import { loadConfig } from './configLoader.js';
+import { renderMarkdownReport } from './renderMarkdownReport.js';
+export { defineConfig, loadConfig, renderMarkdownReport };

package/build/notifyPr.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Creates or updates a comment on a pull request with the specified content.
+ * Uses an HTML comment marker to identify and update existing comments.
+ * Searches page-by-page (newest first) and stops early when comment is found.
+ *
+ * @param {string} repo - The repository in format "owner/repo"
+ * @param {number} prNumber - The pull request number
+ * @param {string} id - Unique identifier to mark the comment for future updates
+ * @param {string} content - The content to post or update in the comment
+ * @returns {Promise<void>}
+ */
+export function notifyPr(repo: string, prNumber: number, id: string, content: string): Promise<void>;

package/build/renderMarkdownReport.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Generates a Markdown report for bundle size changes
+ * @param {ComparisonResult} comparison - Comparison result from calculateSizeDiff
+ * @param {Object} [options] - Additional options
+ * @param {string[]} [options.track] - Array of bundle IDs to track. If specified, totals will only include tracked bundles and all tracked bundles will be shown prominently
+ * @param {number} [options.maxDetailsLines=100] - Maximum number of bundles to show in details section
+ * @returns {string} Markdown report
+ */
+export function renderMarkdownReportContent(comparison: ComparisonResult, { track, maxDetailsLines }?: {
+    track?: string[] | undefined;
+    maxDetailsLines?: number | undefined;
+}): string;
+/**
+ *
+ * @param {PrInfo} prInfo
+ * @param {Object} [options] - Additional options
+ * @param {string[]} [options.track] - Array of bundle IDs to track
+ * @param {number} [options.fallbackDepth=3] - How many parent commits to try as fallback when base snapshot is missing
+ * @param {number} [options.maxDetailsLines=100] - Maximum number of bundles to show in details section
+ * @param {(base: string, head: string) => Promise<string>} [options.getMergeBase] - Custom function to get merge base commit
+ * @returns {Promise<string>} Markdown report
+ */
+export function renderMarkdownReport(prInfo: PrInfo, options?: {
+    track?: string[] | undefined;
+    fallbackDepth?: number | undefined;
+    maxDetailsLines?: number | undefined;
+    getMergeBase?: ((base: string, head: string) => Promise<string>) | undefined;
+}): Promise<string>;
+export type ColumnDefinition = {
+    /**
+     * - The property key to extract from data objects
+     */
+    field: string;
+    /**
+     * - Column header (defaults to field name)
+     */
+    header?: string | undefined;
+    /**
+     * - Column alignment
+     */
+    align?: "left" | "right" | "center" | undefined;
+};
+export type Size = import("./sizeDiff.js").Size;
+export type SizeSnapshot = import("./sizeDiff.js").SizeSnapshot;
+export type ComparisonResult = import("./sizeDiff.js").ComparisonResult;

package/build/sizeDiff.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Calculates size difference between two snapshots
+ *
+ * @param {SizeSnapshot} baseSnapshot - Base snapshot (previous)
+ * @param {SizeSnapshot} targetSnapshot - Target snapshot (current)
+ * @returns {ComparisonResult} Comparison result with entries, totals, and file counts
+ */
+export function calculateSizeDiff(baseSnapshot: SizeSnapshot, targetSnapshot: SizeSnapshot): ComparisonResult;
+export type SizeSnapshot = {
+    [x: string]: SizeSnapshotEntry;
+};
+export type Size = {
+    /**
+     * - Bundle identifier
+     */
+    id: string;
+    /**
+     * - Parsed size information
+     */
+    parsed: {
+        previous: number;
+        current: number;
+        absoluteDiff: number;
+        relativeDiff: number | null;
+    };
+    /**
+     * - Gzipped size information
+     */
+    gzip: {
+        previous: number;
+        current: number;
+        absoluteDiff: number;
+        relativeDiff: number | null;
+    };
+};
+export type ComparisonResult = {
+    /**
+     * - Size entries for each bundle
+     */
+    entries: Size[];
+    /**
+     * - Total size information
+     */
+    totals: {
+        totalParsed: number;
+        totalGzip: number;
+        totalParsedPercent: number;
+        totalGzipPercent: number;
+    };
+    /**
+     * - File count information
+     */
+    fileCounts: {
+        added: number;
+        removed: number;
+        changed: number;
+        total: number;
+    };
+};

package/build/strings.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Inspired by https://github.com/parshap/node-sanitize-filename
+ *
+ * Replaces characters in strings that are illegal/unsafe for filenames.
+ * Unsafe characters are either removed or replaced by a substitute set
+ * in the optional `options` object.
+ *
+ * Illegal Characters on Various Operating Systems
+ * / ? < > \ : * | "
+ * https://kb.acronis.com/content/39790
+ *
+ * Unicode Control codes
+ * C0 0x00-0x1f & C1 (0x80-0x9f)
+ * http://en.wikipedia.org/wiki/C0_and_C1_control_codes
+ *
+ * Reserved filenames on Unix-based systems (".", "..")
+ * Reserved filenames in Windows ("CON", "PRN", "AUX", "NUL", "COM1",
+ * "COM2", "COM3", "COM4", "COM5", "COM6", "COM7", "COM8", "COM9",
+ * "LPT1", "LPT2", "LPT3", "LPT4", "LPT5", "LPT6", "LPT7", "LPT8", and
+ * "LPT9") case-insesitively and with or without filename extensions.
+ * @param {string} input
+ */
+export function escapeFilename(input: string, replacement?: string): string;

package/build/uploadSnapshot.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Uploads the size snapshot to S3
+ * @param {string} snapshotPath - The path to the size snapshot JSON file
+ * @param {NormalizedUploadConfig} uploadConfig - The normalized upload configuration
+ * @param {string} [commitSha] - Optional commit SHA (defaults to current Git HEAD)
+ * @returns {Promise<{key:string}>}
+ */
+export function uploadSnapshot(snapshotPath: string, uploadConfig: NormalizedUploadConfig, commitSha?: string): Promise<{
+    key: string;
+}>;

package/build/worker.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Get sizes for a bundle
+ * @param {{ entry: ObjectEntry, args: CommandLineArgs, index: number, total: number, replace?: Record<string, string> }} options
+ * @returns {Promise<Array<[string, SizeSnapshotEntry]>>}
+ */
+export default function getSizes({ entry, args, index, total, replace }: {
+    entry: ObjectEntry;
+    args: CommandLineArgs;
+    index: number;
+    total: number;
+    replace?: Record<string, string>;
+}): Promise<Array<[string, SizeSnapshotEntry]>>;

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@mui/internal-bundle-size-checker",
-  "version": "1.0.9-canary.5",
+  "version": "1.0.9-canary.50",
   "description": "Bundle size checker for MUI packages.",
   "type": "module",
   "main": "./src/index.js",
+  "types": "./build/index.d.ts",
   "bin": {
     "bundle-size-checker": "./bin/bundle-size-checker.js"
   },
@@ -14,45 +15,38 @@
   },
   "sideEffects": false,
   "exports": {
-    ".": "./src/index.js",
+    ".": {
+      "types": "./build/index.d.ts",
+      "default": "./src/index.js"
+    },
     "./package.json": "./package.json",
-    "./browser": "./src/browser.js"
+    "./browser": {
+      "types": "./build/browser.d.ts",
+      "default": "./src/browser.js"
+    }
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.515.0",
-    "@aws-sdk/credential-providers": "^3.787.0",
-    "@babel/core": "^7.27.4",
+    "@aws-sdk/client-s3": "^3.901.0",
+    "@aws-sdk/credential-providers": "^3.901.0",
     "@octokit/rest": "^22.0.0",
-    "@babel/preset-react": "^7.18.6",
-    "@babel/preset-typescript": "^7.27.1",
-    "babel-loader": "^10.0.0",
-    "chalk": "^5.4.1",
-    "compression-webpack-plugin": "^10.0.0",
-    "css-loader": "^7.1.2",
-    "env-ci": "^11.1.0",
-    "execa": "^7.2.0",
-    "fast-glob": "^3.3.2",
-    "file-loader": "^6.2.0",
+    "chalk": "^5.6.2",
+    "env-ci": "^11.2.0",
+    "execa": "^9.6.0",
     "git-url-parse": "^16.1.0",
     "micromatch": "^4.0.8",
-    "piscina": "^4.2.1",
-    "rollup-plugin-visualizer": "^6.0.1",
-    "terser-webpack-plugin": "^5.3.10",
-    "vite": "^6.3.5",
-    "webpack": "^5.90.3",
-    "webpack-bundle-analyzer": "^4.10.1",
-    "yargs": "^17.7.2"
+    "piscina": "^5.1.3",
+    "rollup-plugin-visualizer": "^6.0.4",
+    "vite": "^7.1.9",
+    "yargs": "^18.0.0"
   },
   "devDependencies": {
     "@types/env-ci": "^3.1.4",
     "@types/micromatch": "^4.0.9",
-    "@types/webpack": "^5.28.5",
-    "@types/webpack-bundle-analyzer": "^4.7.0",
     "@types/yargs": "^17.0.33"
   },
-  "gitSha": "8ddf4c81e7d28c0a1b0aa151d76697873870f123",
+  "gitSha": "fa6637adec099d6853ce0526bcb030b1d68907a5",
   "scripts": {
-    "typescript": "tsc -p tsconfig.json",
+    "build": "tsc -p tsconfig.build.json",
     "test": "pnpm -w test --project @mui/internal-bundle-size-checker"
   }
 }