@node-cli/bundlecheck 1.4.0 → 1.4.1

package/dist/index.d.ts

@@ -1,5 +1,321 @@
 /**
- * @file Automatically generated by barrelsby.
+ * @node-cli/bundlecheck - Library API
+ *
+ * Programmatic interface for analyzing npm package bundle sizes.
+ *
  */
-
-export * from "./index";
+/**
+ * =============================================================================
+ * Types
+ * =============================================================================
+ */
+/**
+ * Options for getting bundle stats of a single package.
+ */
+export type GetBundleStatsOptions = {
+    /**
+     * Package name with optional version (e.g., "@mantine/core" or
+     * "@mantine/core@7.0.0").
+     */
+    package: string;
+    /**
+     * Specific exports to measure (e.g., ["Button", "Input"]).
+     */
+    exports?: string[];
+    /**
+     * Additional packages to mark as external (not bundled).
+     */
+    external?: string[];
+    /**
+     * Bundle everything including default externals (react, react-dom).
+     */
+    noExternal?: boolean;
+    /**
+     * Gzip compression level (1-9, default 5).
+     */
+    gzipLevel?: number;
+    /**
+     * Custom npm registry URL.
+     */
+    registry?: string;
+    /**
+     * Target platform: "browser", "node", or "auto" (default: "auto" - auto-detect
+     * from package.json).
+     */
+    platform?: "browser" | "node" | "auto";
+    /**
+     * Bypass cache and force re-analysis.
+     */
+    force?: boolean;
+};
+/**
+ * Result from getBundleStats.
+ */
+export type BundleStats = {
+    /**
+     * Display name of the package (may include subpath).
+     */
+    packageName: string;
+    /**
+     * Resolved package version.
+     */
+    packageVersion: string;
+    /**
+     * Exports that were analyzed.
+     */
+    exports: string[];
+    /**
+     * Raw (minified) bundle size in bytes.
+     */
+    rawSize: number;
+    /**
+     * Gzipped bundle size in bytes (null for node platform).
+     */
+    gzipSize: number | null;
+    /**
+     * Gzip compression level used.
+     */
+    gzipLevel: number;
+    /**
+     * Packages marked as external (not included in bundle).
+     */
+    externals: string[];
+    /**
+     * Package dependencies.
+     */
+    dependencies: string[];
+    /**
+     * Target platform used for bundling.
+     */
+    platform: "browser" | "node";
+    /**
+     * Human-readable raw size (e.g., "45.2 kB").
+     */
+    rawSizeFormatted: string;
+    /**
+     * Human-readable gzip size (e.g., "12.3 kB") or null.
+     */
+    gzipSizeFormatted: string | null;
+    /**
+     * Whether the result was retrieved from cache.
+     */
+    fromCache: boolean;
+};
+/**
+ * Options for getting bundle size trend across versions.
+ */
+export type GetBundleTrendOptions = {
+    /**
+     * Package name (e.g., "@mantine/core") - version is ignored if provided.
+     */
+    package: string;
+    /**
+     * Number of versions to analyze (default 5).
+     */
+    versionCount?: number;
+    /**
+     * Specific exports to measure (e.g., ["Button", "Input"]).
+     */
+    exports?: string[];
+    /**
+     * Additional packages to mark as external (not bundled).
+     */
+    external?: string[];
+    /**
+     * Bundle everything including default externals (react, react-dom).
+     */
+    noExternal?: boolean;
+    /**
+     * Gzip compression level (1-9, default 5).
+     */
+    gzipLevel?: number;
+    /**
+     * Custom npm registry URL.
+     */
+    registry?: string;
+    /**
+     * Target platform: "browser", "node", or "auto" (default: "auto" - auto-detect
+     * from package.json).
+     */
+    platform?: "browser" | "node" | "auto";
+    /**
+     * Bypass cache and force re-analysis.
+     */
+    force?: boolean;
+};
+/**
+ * Single version result in trend analysis.
+ */
+export type TrendVersionResult = {
+    /**
+     * Package version.
+     */
+    version: string;
+    /**
+     * Raw (minified) bundle size in bytes.
+     */
+    rawSize: number;
+    /**
+     * Gzipped bundle size in bytes (null for node platform).
+     */
+    gzipSize: number | null;
+    /**
+     * Human-readable raw size (e.g., "45.2 kB").
+     */
+    rawSizeFormatted: string;
+    /**
+     * Human-readable gzip size (e.g., "12.3 kB") or null.
+     */
+    gzipSizeFormatted: string | null;
+};
+/**
+ * Size change information between oldest and newest versions.
+ */
+export type TrendChange = {
+    /**
+     * Oldest version analyzed.
+     */
+    fromVersion: string;
+    /**
+     * Newest version analyzed.
+     */
+    toVersion: string;
+    /**
+     * Raw size difference in bytes (positive = increase, negative = decrease).
+     */
+    rawDiff: number;
+    /**
+     * Raw size percentage change (null if oldest size was 0).
+     */
+    rawPercent: number | null;
+    /**
+     * Human-readable raw size change (e.g., "+5.2 kB" or "-1.3 kB").
+     */
+    rawDiffFormatted: string;
+    /**
+     * Gzip size difference in bytes (null if not applicable).
+     */
+    gzipDiff: number | null;
+    /**
+     * Gzip size percentage change (null if not applicable or oldest size was 0).
+     */
+    gzipPercent: number | null;
+    /**
+     * Human-readable gzip size change (e.g., "+1.5 kB" or "-0.8 kB") or null.
+     */
+    gzipDiffFormatted: string | null;
+};
+/**
+ * Result from getBundleTrend.
+ */
+export type BundleTrend = {
+    /**
+     * Package name.
+     */
+    packageName: string;
+    /**
+     * Results for each version analyzed (newest first).
+     */
+    versions: TrendVersionResult[];
+    /**
+     * Size change between oldest and newest versions (null if only one version).
+     */
+    change: TrendChange | null;
+};
+/**
+ * Options for fetching package versions.
+ */
+export type GetPackageVersionsOptions = {
+    /**
+     * Package name (e.g., "@mantine/core").
+     */
+    package: string;
+    /**
+     * Custom npm registry URL.
+     */
+    registry?: string;
+};
+/**
+ * Result from getPackageVersions.
+ */
+export type PackageVersions = {
+    /**
+     * All available versions (sorted newest first).
+     */
+    versions: string[];
+    /**
+     * Distribution tags (e.g., { latest: "7.0.0", next: "8.0.0-beta.1" }).
+     */
+    tags: Record<string, string>;
+};
+/**
+ * =============================================================================
+ * Library Functions
+ * =============================================================================
+ */
+/**
+ * Get bundle size statistics for an npm package.
+ *
+ * @example
+ * ```js
+ * import { getBundleStats } from "@node-cli/bundlecheck";
+ *
+ * const stats = await getBundleStats({
+ *   package: "@mantine/core@7.0.0",
+ *   exports: ["Button", "Input"],
+ * });
+ *
+ * console.log(stats.gzipSizeFormatted); // "12.3 kB"
+ * ```
+ *
+ */
+export declare function getBundleStats(options: GetBundleStatsOptions): Promise<BundleStats>;
+/**
+ * Get bundle size trend across multiple versions of a package.
+ *
+ * @example
+ * ```js
+ * import { getBundleTrend } from "@node-cli/bundlecheck";
+ *
+ * const trend = await getBundleTrend({
+ *   package: "@mantine/core",
+ *   versionCount: 5,
+ * });
+ *
+ * console.log(trend.change?.rawDiffFormatted); // "+5.2 kB"
+ * ```
+ *
+ */
+export declare function getBundleTrend(options: GetBundleTrendOptions): Promise<BundleTrend>;
+/**
+ * Get available versions for an npm package.
+ *
+ * @example
+ * ```js
+ * import { getPackageVersions } from "@node-cli/bundlecheck";
+ *
+ * const { versions, tags } = await getPackageVersions({
+ *   package: "@mantine/core",
+ * });
+ *
+ * console.log(tags.latest); // "7.0.0"
+ * ```
+ *
+ */
+export declare function getPackageVersions(options: GetPackageVersionsOptions): Promise<PackageVersions>;
+/**
+ * =============================================================================
+ * Re-exports for advanced usage
+ * =============================================================================
+ */
+/**
+ * - Format bytes to human-readable string (e.g., 1024 → "1 kB").
+ * - Parse a package specifier (e.g., "@scope/name@1.0.0" → { name, version,
+ * subpath }).
+ */
+export { formatBytes, parsePackageSpecifier } from "./bundler.js";
+/**
+ * - Clear the bundle cache.
+ * - Get the number of cached entries.
+ */
+export { clearCache, getCacheCount } from "./cache.js";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@node-cli/bundlecheck",
-	"version": "1.4.0",
+	"version": "1.4.1",
 	"license": "MIT",
 	"author": "Arno Versini",
 	"description": "CLI tool to check the bundle size of npm packages (like bundlephobia)",
@@ -20,8 +20,7 @@
 	],
 	"node": ">=20",
 	"scripts": {
-		"build": "npm-run-all --serial clean build:types build:js build:barrel",
-		"build:barrel": "barrelsby --delete --directory dist --pattern \"**/*.d.ts\" --name \"index.d\"",
+		"build": "npm-run-all --serial clean build:types build:js",
 		"build:js": "swc --strip-leading-paths --source-maps --out-dir dist src",
 		"build:types": "tsc",
 		"clean": "rimraf dist types coverage",
@@ -51,5 +50,5 @@
 		"@vitest/coverage-v8": "4.0.18",
 		"vitest": "4.0.18"
 	},
-	"gitHead": "e6ab3435a49c7cd2a0ef27bd692e3de658a29ef4"
+	"gitHead": "00b91b9bd59c6e8edc7f1730eef4d5042a7fb555"
 }