@bundle-stats/utils 4.2.0-beta.0 → 4.2.0-beta.2

package/types/constants.d.ts

@@ -1,9 +1,16 @@
+import { InsightType } from './config/insights';
+export declare enum Source {
+    webpack = "webpack",
+    lighthouse = "lighthouse",
+    browsertime = "browsertime"
+}
+export type SourceData = Record<string, unknown>;
 export declare enum MetricTypeType {
-    'METRIC_TYPE_NUMERIC' = 0,
-    'METRIC_TYPE_SCORE' = 1,
-    'METRIC_TYPE_FILE_SIZE' = 2,
-    'METRIC_TYPE_DURATION' = 3,
-    'METRIC_TYPE_PERCENTAGE' = 4
+    'METRIC_TYPE_NUMERIC' = "METRIC_TYPE_NUMERIC",
+    'METRIC_TYPE_SCORE' = "METRIC_TYPE_SCORE",
+    'METRIC_TYPE_FILE_SIZE' = "METRIC_TYPE_FILE_SIZE",
+    'METRIC_TYPE_DURATION' = "METRIC_TYPE_DURATION",
+    'METRIC_TYPE_PERCENTAGE' = "METRIC_TYPE_PERCENTAGE"
 }
 export interface MetricTypeConfig {
     label: string;
@@ -15,13 +22,13 @@ export interface MetricType extends MetricTypeConfig {
     biggerIsBetter: boolean;
 }
 export declare enum MetricRunInfoDeltaType {
-    'HIGH_NEGATIVE' = 0,
-    'NEGATIVE' = 1,
-    'LOW_NEGATIVE' = 2,
-    'NO_CHANGE' = 3,
-    'LOW_POSITIVE' = 4,
-    'POSITIVE' = 5,
-    'HIGH_POSITIVE' = 6
+    'HIGH_NEGATIVE' = "HIGH_NEGATIVE",
+    'NEGATIVE' = "NEGATIVE",
+    'LOW_NEGATIVE' = "LOW_NEGATIVE",
+    'NO_CHANGE' = "NO_CHANGE",
+    'LOW_POSITIVE' = "LOW_POSITIVE",
+    'POSITIVE' = "POSITIVE",
+    'HIGH_POSITIVE' = "HIGH_POSITIVE"
 }
 export interface MetricRun {
     value: number;
@@ -30,12 +37,58 @@ export interface MetricRunInfo {
     value: number;
     displayValue: string;
     delta?: number;
+    deltaPercentage?: number;
+    deltaType?: MetricRunInfoDeltaType;
     displayDelta?: string;
     displayDeltaPercentage?: string;
-    deltaType?: MetricRunInfoDeltaType;
 }
-export interface Metric {
-    value: number;
+export type JobSection<T = object> = Record<Source, T>;
+export declare enum JobSectionId {
+    meta = "meta",
+    insights = "insights",
+    summary = "summary",
+    metrics = "metrics",
+    rawData = "rawData"
+}
+export interface JobSummaryItem {
+    baseline: number;
+    current: number;
+}
+export interface JobInsight<T = object> {
+    type: InsightType;
+    data: T;
+}
+export interface JobInsightAssetsSizeTotalData {
+    text: string;
+    md: string;
+    info: MetricRunInfo;
+}
+export type JobInsightDuplicatePackagesData = Record<string, Array<string>>;
+export interface JobInsightDuplicatePackagesV3Data {
+    text: string;
+    packages: Record<string, Array<string>>;
+}
+export type JobSummarySource = Record<string, JobSummaryItem>;
+export type JobSummary = JobSection<JobSummarySource>;
+export interface JobInsights {
+    [Source.webpack]: {
+        assetsSizeTotal: JobInsight<JobInsightAssetsSizeTotalData>;
+        duplicatePackages?: JobInsight<JobInsightDuplicatePackagesData>;
+        duplicatePackagesV3?: JobInsight<JobInsightDuplicatePackagesV3Data>;
+    };
+}
+export type JobMetricsSource = Record<string, MetricRun | Record<string, MetricRun>>;
+export type JobMetrics = JobSection<JobMetricsSource>;
+export interface JobData {
+    [JobSectionId.meta]?: JobSection;
+    [JobSectionId.insights]?: JobInsights;
+    [JobSectionId.summary]?: JobSummary;
+    [JobSectionId.metrics]?: JobMetrics;
+    [JobSectionId.rawData]?: JobSection;
+}
+export interface Job extends JobData {
+    internalBuildNumber: number;
+    label: string;
 }
 export interface LighthouseSource {
     lighthouseVersion: string;

package/types/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./browsertime";
 export * from "./config";
+export * from "./constants";
 export * from "./jobs";
 export * from "./report";
 export * from "./utils";

package/types/jobs/create-job.d.ts

@@ -1 +1,2 @@
-export function createJob(source: any, baseline: any): {};
+import { JobData, SourceData } from '../constants';
+export declare const createJob: (source: SourceData, baseline?: JobData) => JobData;

package/types/jobs/create-jobs.d.ts

@@ -1 +1,2 @@
-export function createJobs(sources: any): any;
+import { Job, SourceData } from '../constants';
+export declare const createJobs: (sources: Array<SourceData>) => Array<Job>;

package/types/jobs/create-summary.d.ts

@@ -1 +1,4 @@
-export function createSummary(metricPaths: any, baselineSourceMetrics: any, currentSourceMetrics: any): any;
+import { JobMetricsSource, JobSummaryItem } from '../constants';
+type JobSummary = Record<string, JobSummaryItem>;
+export declare const createSummary: (metricPaths: Array<string>, baselineMetricsSource: JobMetricsSource | null | undefined, currentMetricsSource: JobMetricsSource) => JobSummary;
+export {};

package/types/jobs/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./create-job";
-export * from "./create-jobs";
+export * from './create-job';
+export * from './create-jobs';

package/types/lighthouse/filter.d.ts

@@ -1 +1 @@
-export function filter(source: Object): any;
+export function filter(source: Object): import('../constants').LighthouseSource;

package/types/report/add-row-metric-data.d.ts

@@ -3,6 +3,15 @@ export declare const getAddRowMetricData: (metricType?: string) => (row: types.R
     biggerIsBetter: any;
     label: any;
     changed: boolean;
-    runs: any[];
+    runs: ({
+        value: number;
+        displayValue: string;
+        delta?: number | undefined;
+        deltaPercentage?: number | undefined;
+        deltaType?: import("..").MetricRunInfoDeltaType | undefined;
+        displayDelta?: string | undefined;
+        displayDeltaPercentage?: string | undefined;
+        name?: string | undefined;
+    } | null)[];
     key: string;
 };

package/types/report/create.d.ts

@@ -1,14 +1,16 @@
-export declare const createReport: (jobs: Array<any>) => {
-    constructor: Function;
-    toString(): string;
-    toLocaleString(): string;
-    valueOf(): Object;
-    hasOwnProperty(v: PropertyKey): boolean;
-    isPrototypeOf(v: Object): boolean;
-    propertyIsEnumerable(v: PropertyKey): boolean;
-    insights?: any;
+import { MetricRunInfo, Job } from '../constants';
+interface ReportMetricRunInfo extends MetricRunInfo {
+    label: string;
+}
+type ReportSummary = Record<string, Array<ReportMetricRunInfo>>;
+interface JobRun {
+    internalBuildNumber: number;
+}
+interface Report {
     createdAt: string;
     version: string;
-    runs: any[];
-    summary: {};
-};
+    summary: ReportSummary;
+    runs: Array<JobRun>;
+}
+export declare const createReport: (jobs: Array<Job>) => Report;
+export {};

package/types/utils/component-links.d.ts

@@ -25,7 +25,7 @@ export declare const BUNDLE_MODULES: ComponentLink;
 export declare const BUNDLE_MODULES_DUPLICATE: ComponentLink;
 export declare const getBundleModulesBySearch: (search: string) => ComponentLink;
 export declare const getBundleModulesByChunk: (chunkIds: Array<string>, chunkId: string, fileType?: string) => ComponentLink;
-export declare const BUNLDE_PACKAGES_COUNT: ComponentLink;
+export declare const BUNDLE_PACKAGES_COUNT: ComponentLink;
 export declare const BUNDLE_PACKAGES_DUPLICATE: ComponentLink;
 export declare const getBundleAssetsFileTypeComponentLink: (fileType: string, label: string) => ComponentLink;
 export declare const getBundlePackagesByNameComponentLink: (search: string) => ComponentLink;

package/types/utils/metrics.d.ts

@@ -1,3 +1,3 @@
 export function createGetMetricType(metrics: Object): Function;
 export const getGlobalMetricType: Function;
-export function getMetricRunInfo(metric: any, currentValue: number, baselineValue: number): any;
+export function getMetricRunInfo(metric: import('../constants').MetricType, currentValue: number, baselineValue: number): import('../constants').MetricRunInfo;

package/types/webpack/constants.d.ts

@@ -4,6 +4,7 @@ export const SECTION_WEBPACK_ASSETS: "assets";
 export const SECTION_WEBPACK_MODULES: "modules";
 export const SECTION_WEBPACK_PACKAGES: "packages";
 export const SECTIONS: string[];
-export const SUMMARY_METRIC_PATHS: string[];
+export const SUMMARY_METRIC_PATHS: Metric[];
 export const MODULE_PATH_PACKAGES: RegExp;
 export const PACKAGE_PATH_NAME: RegExp;
+import { Metric } from "./types";

package/types/webpack/extract/assets-size-total-insight.d.ts

@@ -1,12 +1,13 @@
 export function extractAssetsSizeTotalInsight(_: any, currentExtractedData: any, baselineBundleStats: any): {
     insights: {
         assetsSizeTotal: {
-            type: string;
+            type: InsightType;
             data: {
                 text: string;
                 md: string;
-                info: any;
+                info: import("../..").MetricRunInfo;
             };
         };
     };
 };
+import { InsightType } from "../../config/insights";

package/types/webpack/extract/modules-packages-duplicate.d.ts

@@ -1,20 +1,13 @@
-export function extractModulesPackagesDuplicate(webpackStats: any, currentExtractedData: any): {
-    metrics: {
-        duplicatePackagesCount: {
-            value: any;
-        };
-    };
-    insights?: undefined;
-} | {
+import { Job, JobInsight, JobInsightDuplicatePackagesV3Data, JobInsights, MetricRun } from '../../constants';
+interface ModulesPackagesDuplicateData {
     insights: {
-        duplicatePackages: {
-            type: string;
-            data: {};
-        };
+        duplicatePackages?: JobInsights['webpack']['duplicatePackages'];
+        duplicatePackagesV3: JobInsights['webpack']['duplicatePackagesV3'];
     };
     metrics: {
-        duplicatePackagesCount: {
-            value: any;
-        };
+        duplicatePackagesCount: MetricRun;
     };
-};
+}
+export declare const getDuplicatePackagesInsight: (duplicatePackagesMap: Record<string, Array<string>>, baselineDuplicatePackagesMap?: Record<string, Array<string>>) => JobInsight<JobInsightDuplicatePackagesV3Data>;
+export declare const extractModulesPackagesDuplicate: (_: any, currentExtractedData: any, baselineJob?: Job) => ModulesPackagesDuplicateData;
+export {};

package/types/webpack/extract/modules-packages.d.ts

@@ -1,7 +1,7 @@
 import { MetricsModules, MetricsPackages } from '../types';
 export declare const getPackageMetaFromModulePath: (modulePath: string) => {
     id: string;
-    name: unknown;
+    name: string;
     path: string;
 } | null;
 export declare const extractModulesPackages: (_?: unknown, currentExtractedData?: MetricsModules) => MetricsPackages;

package/types/webpack/types.d.ts

@@ -1,9 +1,31 @@
-import { Metric, MetricRun } from '../constants';
-interface MetaChunk {
+import { MetricRun } from '../constants';
+export declare const METRIC_TOTALS_SUFIX_ALL = "ALL";
+export declare const METRIC_TOTALS_PREFIX = "totalSizeByType";
+export declare enum Metric {
+    BUNDLE_SIZE = "totalSizeByTypeALL",
+    INITIAL_SIZE_JS = "totalInitialSizeJS",
+    INITIAL_SIZE_CSS = "totalInitialSizeCSS",
+    CACHE_INVALIDATION = "cacheInvalidation",
+    ASSET_COUNT = "assetCount",
+    CHUNK_COUNT = "chunkCount",
+    MODULE_COUNT = "moduleCount",
+    DUPLICATE_MODULES_COUNT = "duplicateModulesCount",
+    DUPLICATE_CODE = "duplicateCode",
+    PACKAGE_COUNT = "packageCount",
+    DUPLICATE_PACKAGES_COUNT = "duplicatePackagesCount",
+    TOTAL_SIZE_JS = "totalSizeByTypeJS",
+    TOTAL_SIZE_CSS = "totalSizeByTypeCSS",
+    TOTAL_SIZE_IMG = "totalSizeByTypeIMG",
+    TOTAL_SIZE_MEDIA = "totalSizeByTypeMEDIA",
+    TOTAL_SIZE_FONT = "totalSizeByTypeFONT",
+    TOTAL_SIZE_HTML = "totalSizeByTypeHTML",
+    TOTAL_SIZE_OTHER = "totalSizeByTypeOTHER"
+}
+export interface MetaChunk {
     id: string;
     name: string;
 }
-export interface Asset extends Metric {
+export interface Asset extends MetricRun {
     name: string;
     isEntry: boolean;
     isInitial: boolean;
@@ -19,11 +41,10 @@ export interface MetricsAssets {
         chunks: Array<MetaChunk>;
     };
 }
-export interface Module extends Metric {
+export interface Module extends MetricRun {
     name: string;
-    chunkIds: Array<string>;
+    chunkIds: Array<String>;
     duplicated: boolean;
-    reasons?: Array<string>;
 }
 export type Modules = Record<string, Module>;
 export interface MetricsModules {
@@ -34,7 +55,8 @@ export interface MetricsModules {
         moduleCount: MetricRun;
     };
 }
-export interface Package extends Metric {
+export interface Package extends MetricRun {
+    name: string;
     path: string;
 }
 export type Packages = Record<string, Package>;
@@ -43,4 +65,3 @@ export interface MetricsPackages {
         packages: Packages;
     };
 }
-export {};

package/src/config/insights.js

@@ -1,5 +0,0 @@
-export const INSIGHT_ERROR = 'ERROR';
-export const INSIGHT_INFO = 'INFO';
-export const INSIGHT_WARNING = 'WARNING';
-
-export const INSIGHTS = [INSIGHT_ERROR, INSIGHT_INFO, INSIGHT_WARNING];

package/src/jobs/create-job.js

@@ -1,46 +0,0 @@
-import get from 'lodash/get';
-import merge from 'lodash/merge';
-import set from 'lodash/set';
-
-import { SOURCE_PATHS } from '../config';
-import { createSummary } from './create-summary';
-import * as webpack from '../webpack';
-import * as lighthouse from '../lighthouse';
-import * as browsertime from '../browsertime';
-
-const SOURCE_FNS = { webpack, lighthouse, browsertime };
-const GENERIC_PROPS = ['meta', 'insights', 'metrics'];
-
-/*
- * Create job from stats
- */
-export const createJob = (source, baseline) => SOURCE_PATHS.reduce((agg, sourcePath) => {
-  const rawData = get(source, sourcePath);
-
-  if (!rawData) {
-    return agg;
-  }
-
-  const sourceModule = SOURCE_FNS[sourcePath];
-
-  if (!sourceModule) {
-    return agg;
-  }
-
-  const extractedData = sourceModule.extract(rawData, baseline);
-  const summary = createSummary(
-    SOURCE_FNS[sourcePath].SUMMARY_METRIC_PATHS,
-    get(baseline, `metrics.${sourcePath}`, {}),
-    get(extractedData, 'metrics', {}),
-  );
-
-  return merge(
-    {},
-    agg,
-    { rawData: set({}, sourcePath, rawData) },
-    { summary: set({}, sourcePath, summary) },
-    ...GENERIC_PROPS.map((genericPropName) => ({
-      [genericPropName]: set({}, sourcePath, extractedData[genericPropName]),
-    })),
-  );
-}, {});

package/src/jobs/create-jobs.js

@@ -1,26 +0,0 @@
-import last from 'lodash/last';
-import reverse from 'lodash/reverse';
-
-import { createJob } from './create-job';
-
-/*
- * Create jobs from sources
- */
-export const createJobs = (sources) => {
-  const jobs = reverse([...sources]).reduce((agg, source, idx) => {
-    const job = createJob(source, last(agg));
-    const internalBuildNumber = job.internalBuildNumber || idx + 1;
-    const label = `Job #${internalBuildNumber}`;
-
-    return [
-      {
-        ...job,
-        internalBuildNumber,
-        label,
-      },
-      ...agg,
-    ];
-  }, []);
-
-  return jobs;
-};

package/src/jobs/create-summary.js

@@ -1,16 +0,0 @@
-import get from 'lodash/get';
-import merge from 'lodash/merge';
-
-export const createSummary = (
-  metricPaths, baselineSourceMetrics, currentSourceMetrics,
-) => metricPaths.map((metric) => {
-  const baselineValue = get(baselineSourceMetrics, `${metric}.value`, 0);
-  const currentValue = get(currentSourceMetrics, `${metric}.value`, 0);
-
-  return {
-    [metric]: {
-      baseline: baselineValue,
-      current: currentValue,
-    },
-  };
-}).reduce((agg, current) => merge({}, agg, current), {});

package/src/webpack/extract/modules-packages-duplicate.js

@@ -1,102 +0,0 @@
-import get from 'lodash/get';
-import map from 'lodash/map';
-import orderBy from 'lodash/orderBy';
-import sum from 'lodash/sum';
-
-import { INSIGHT_WARNING } from '../../config';
-
-export const extractModulesPackagesDuplicate = (webpackStats, currentExtractedData) => {
-  const source = get(currentExtractedData, 'metrics.packages', {});
-
-  // Group packages by the public name
-  const packagesByName = Object.entries(source).reduce((agg, [packageId, packageData]) => {
-    const { name } = packageData;
-    const existingPackageData = agg[name];
-
-    return {
-      ...agg,
-      [name]: {
-        ...existingPackageData,
-        children: [
-          ...(existingPackageData?.children || []),
-          {
-            name: packageId,
-            value: packageData.value,
-          },
-        ],
-      },
-    };
-  }, {});
-
-  // Filter, sum and count duplicate packages
-  const { count, duplicatePackages } = Object.entries(packagesByName).reduce(
-    (agg, [name, data]) => {
-      // Count duplicate instances (substract the initial instance)
-      // example: package-a, package-b:package-a -> duplicateInstances = 1
-      const duplicateInstances = data.children.length - 1;
-
-      // No duplicates, skip
-      if (duplicateInstances === 0) {
-        return agg;
-      }
-
-      return {
-        count: agg.count + duplicateInstances,
-        duplicatePackages: [
-          ...(agg.duplicatePackages || []),
-          {
-            name,
-            value: sum(map(data.children, 'value')),
-            ...data,
-          },
-        ],
-      };
-    },
-    { count: 0, duplicatePackages: [] },
-  );
-
-  if (!count) {
-    return {
-      metrics: {
-        duplicatePackagesCount: {
-          value: count,
-        },
-      },
-    };
-  }
-
-  const duplicatePackagesByName = orderBy(duplicatePackages, 'value', 'desc').reduce(
-    (agg, { name, ...duplicatePackageData }) => ({
-      ...agg,
-      [name]: {
-        ...duplicatePackageData,
-        children: orderBy(duplicatePackageData.children, 'value', 'desc'),
-      },
-    }),
-    {},
-  );
-
-  // Generate v2 data structure
-  // @TODO remove in v3.0
-  const data = Object.entries(duplicatePackagesByName).reduce(
-    (agg, [packageName, duplicatePackageData]) => ({
-      ...agg,
-      [packageName]: duplicatePackageData.children.map(({ name }) => name),
-    }),
-    {},
-  );
-
-  return {
-    insights: {
-      duplicatePackages: {
-        type: INSIGHT_WARNING,
-        data,
-      },
-    },
-    metrics: {
-      duplicatePackagesCount: {
-        value: count,
-      },
-    },
-  };
-};