@bundle-stats/utils 3.4.0-beta.0 → 4.0.0-alpha.9

package/src/webpack/extract/index.js

@@ -1,6 +1,5 @@
 import merge from 'lodash/merge';
 
-import * as budgetsInsights from '../../transformers/budgets-insights';
 import { extractAssets } from './assets';
 import { extractAssetsCacheInvalidation } from './assets-cache-invalidation';
 import { extractAssetsChunkCount } from './assets-chunk-count';
@@ -27,11 +26,10 @@ const extractFns = [
   extractModulesPackages,
   extractModulesPackagesCount,
   extractModulesPackagesDuplicate,
-  budgetsInsights.getExtract('webpack'),
 ];
 
-export const extract = (webpackStats, baseline, options) =>
-  extractFns.reduce(
-    (agg, extractFn) => merge({}, agg, extractFn(webpackStats, agg, baseline, options)),
-    {},
-  );
+export const extract = (webpackStats, baseline) => extractFns.reduce((agg, extractFn) => merge(
+  {},
+  agg,
+  extractFn(webpackStats, agg, baseline),
+), {});

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

@@ -3,7 +3,7 @@ import map from 'lodash/map';
 import orderBy from 'lodash/orderBy';
 import sum from 'lodash/sum';
 
-import { InsightType } from '../../constants';
+import { INSIGHT_WARNING } from '../../config';
 
 export const extractModulesPackagesDuplicate = (webpackStats, currentExtractedData) => {
   const source = get(currentExtractedData, 'metrics.packages', {});
@@ -89,7 +89,7 @@ export const extractModulesPackagesDuplicate = (webpackStats, currentExtractedDa
   return {
     insights: {
       duplicatePackages: {
-        type: InsightType.WARNING,
+        type: INSIGHT_WARNING,
         data,
       },
     },

package/src/webpack/{metrics.ts → metrics.js}

@@ -3,80 +3,76 @@ import {
   METRIC_TYPE_NUMERIC,
   METRIC_TYPE_PERCENTAGE,
 } from '../config/metrics';
-import { MetricId, SizeByTypeMetricId } from './constants';
 
 export const metrics = {
-  [MetricId.BundleSize]: {
+  totalSizeByTypeALL: {
     label: 'Bundle Size',
     description: 'Sum of all assets emitted by webpack.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_FILE_SIZE,
-    biggerIsBetter: false,
   },
-  [MetricId.TotalInitialSizeJS]: {
+  totalInitialSizeJS: {
     label: 'Initial JS',
     description: 'Sum of all JavaScript assets that are labeled as initial(eg: vendor.js, app.js).',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_FILE_SIZE,
-    biggerIsBetter: false,
   },
-  [MetricId.TotalInitialSizeCSS]: {
+  totalInitialSizeCSS: {
     label: 'Initial CSS',
     description: 'Sum of all CSS assets that are labeled as initial(eg: vendor.css, app.css).',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_FILE_SIZE,
-    biggerIsBetter: false,
   },
-  [MetricId.CacheInvalidation]: {
+  cacheInvalidation: {
     label: 'Cache Invalidation',
     description: 'Ratio between the total changed assets and Bundle Size.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_PERCENTAGE,
     biggerIsBetter: false,
   },
-  [MetricId.ChunkCount]: {
+  chunkCount: {
     label: 'Chunks',
     description: 'Total number of chunks generated by webpack.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_NUMERIC,
     biggerIsBetter: false,
   },
-  [MetricId.AssetCount]: {
+  assetCount: {
     label: 'Assets',
     description: 'Total number of assets emitted by webpack.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_NUMERIC,
     biggerIsBetter: false,
   },
-  [MetricId.ModuleName]: {
+  moduleCount: {
     label: 'Modules',
     description: 'Total number of modules bundled by webpack.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#modules-1',
     type: METRIC_TYPE_NUMERIC,
     biggerIsBetter: false,
   },
-  [MetricId.DuplicateModulesCount]: {
+  duplicateModulesCount: {
     label: 'Duplicate Modules',
     description: 'Total number of modules that belong to more than one chunk.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#modules-1',
     type: METRIC_TYPE_NUMERIC,
     biggerIsBetter: false,
   },
-  [MetricId.DuplicateCode]: {
+  duplicateCode: {
     label: 'Duplicate Code',
     description: 'The percentage of total duplicate module size from the total module size.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#modules-1',
     type: METRIC_TYPE_PERCENTAGE,
     biggerIsBetter: false,
   },
-  [MetricId.PackageCount]: {
+  packageCount: {
     label: 'Packages',
     description: 'Total number of packages bundled by webpack.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#packages',
     type: METRIC_TYPE_NUMERIC,
     biggerIsBetter: false,
   },
-  [MetricId.DuplicatePackagesCount]: {
+  duplicatePackagesCount: {
     label: 'Duplicate Packages',
     description: 'Total number of packages that are duplicated.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#packages',
@@ -84,40 +80,33 @@ export const metrics = {
     biggerIsBetter: false,
   },
   sizes: {
-    [SizeByTypeMetricId.JS]: {
+    totalSizeByTypeJS: {
       label: 'JS',
       type: METRIC_TYPE_FILE_SIZE,
-      biggerIsBetter: false,
     },
-    [SizeByTypeMetricId.CSS]: {
+    totalSizeByTypeCSS: {
       label: 'CSS',
       type: METRIC_TYPE_FILE_SIZE,
-      biggerIsBetter: false,
     },
-    [SizeByTypeMetricId.IMG]: {
+    totalSizeByTypeIMG: {
       label: 'IMG',
       type: METRIC_TYPE_FILE_SIZE,
-      biggerIsBetter: false,
     },
-    [SizeByTypeMetricId.Media]: {
+    totalSizeByTypeMEDIA: {
       label: 'Media',
       type: METRIC_TYPE_FILE_SIZE,
-      biggerIsBetter: false,
     },
-    [SizeByTypeMetricId.Font]: {
+    totalSizeByTypeFONT: {
       label: 'Fonts',
       type: METRIC_TYPE_FILE_SIZE,
-      biggerIsBetter: false,
     },
-    [SizeByTypeMetricId.HTML]: {
+    totalSizeByTypeHTML: {
       label: 'HTML',
       type: METRIC_TYPE_FILE_SIZE,
-      biggerIsBetter: false,
     },
-    [SizeByTypeMetricId.Other]: {
+    totalSizeByTypeOTHER: {
       label: 'Other',
       type: METRIC_TYPE_FILE_SIZE,
-      biggerIsBetter: false,
     },
   },
 };

package/types/constants.d.ts

@@ -157,9 +157,3 @@ export interface BrowsertimeMetrics {
     visualComplete95: MetricRun;
     visualComplete99: MetricRun;
 }
-export declare enum InsightType {
-    ERROR = "ERROR",
-    WARNING = "WARNING",
-    INFO = "INFO",
-    SUCCESS = "SUCCESS"
-}

package/types/index.d.ts

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

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

@@ -1 +1 @@
-export function createJob(source: any, baseline: any, options?: {}): {};
+export function createJob(source: any, baseline: any): {};

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

@@ -1 +1 @@
-export function createJobs(sources: any, options: any): any;
+export function createJobs(sources: any): any;

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

@@ -1,5 +1,5 @@
 import * as types from './types';
-export declare const getAddRowMetricData: (metricType?: string | undefined) => (row: types.ReportRow) => {
+export declare const getAddRowMetricData: (metricType?: string) => (row: types.ReportRow) => {
     biggerIsBetter: any;
     label: any;
     changed: boolean;

package/types/webpack/constants.d.ts

@@ -1,33 +1,9 @@
-export declare const SECTION_WEBPACK_STATS = "stats";
-export declare const SECTION_WEBPACK_SIZES = "sizes";
-export declare const SECTION_WEBPACK_ASSETS = "assets";
-export declare const SECTION_WEBPACK_MODULES = "modules";
-export declare const SECTION_WEBPACK_PACKAGES = "packages";
-export declare const SECTIONS: string[];
-export declare enum MetricId {
-    BundleSize = "totalSizeByTypeALL",
-    TotalInitialSizeJS = "totalInitialSizeJS",
-    TotalInitialSizeCSS = "totalInitialSizeCSS",
-    CacheInvalidation = "cacheInvalidation",
-    ModuleName = "moduleCount",
-    DuplicateModulesCount = "duplicateModulesCount",
-    DuplicateCode = "duplicateCode",
-    ChunkCount = "chunkCount",
-    AssetCount = "assetCount",
-    PackageCount = "packageCount",
-    DuplicatePackagesCount = "duplicatePackagesCount"
-}
-export declare const SIZE_BY_TYPE_METRIC_ID_ALL = "ALL";
-export declare const SIZE_BY_TYPE_METRIC_ID_PREFIX = "totalSizeByType";
-export declare enum SizeByTypeMetricId {
-    JS = "totalSizeByTypeJS",
-    CSS = "totalSizeByTypeCSS",
-    IMG = "totalSizeByTypeIMG",
-    Media = "totalSizeByTypeMEDIA",
-    Font = "totalSizeByTypeFONT",
-    HTML = "totalSizeByTypeHTML",
-    Other = "totalSizeByTypeOTHER"
-}
-export declare const SUMMARY_METRIC_PATHS: MetricId[];
-export declare const MODULE_PATH_PACKAGES: RegExp;
-export declare const PACKAGE_PATH_NAME: RegExp;
+export const SECTION_WEBPACK_STATS: "stats";
+export const SECTION_WEBPACK_SIZES: "sizes";
+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 MODULE_PATH_PACKAGES: RegExp;
+export const PACKAGE_PATH_NAME: RegExp;

package/types/webpack/extract/index.d.ts

@@ -1 +1 @@
-export function extract(webpackStats: any, baseline: any, options: any): {};
+export function extract(webpackStats: any, baseline: any): {};

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

@@ -8,7 +8,7 @@ export function extractModulesPackagesDuplicate(webpackStats: any, currentExtrac
 } | {
     insights: {
         duplicatePackages: {
-            type: InsightType;
+            type: string;
             data: {};
         };
     };
@@ -18,4 +18,3 @@ export function extractModulesPackagesDuplicate(webpackStats: any, currentExtrac
         };
     };
 };
-import { InsightType } from "../../constants";

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

@@ -4,4 +4,4 @@ export declare const getPackageMetaFromModulePath: (modulePath: string) => {
     name: unknown;
     path: string;
 } | null;
-export declare const extractModulesPackages: (webpackStats?: any, currentExtractedData?: WebpackMetricsModules | undefined) => WebpackMetricsPackages;
+export declare const extractModulesPackages: (webpackStats?: any, currentExtractedData?: WebpackMetricsModules) => WebpackMetricsPackages;

package/types/webpack/metrics.d.ts

@@ -1,116 +1,153 @@
-export declare const metrics: {
-    totalSizeByTypeALL: {
-        label: string;
-        description: string;
-        url: string;
-        type: string;
-        biggerIsBetter: boolean;
-    };
-    totalInitialSizeJS: {
-        label: string;
-        description: string;
-        url: string;
-        type: string;
-        biggerIsBetter: boolean;
-    };
-    totalInitialSizeCSS: {
-        label: string;
-        description: string;
-        url: string;
-        type: string;
-        biggerIsBetter: boolean;
-    };
-    cacheInvalidation: {
-        label: string;
-        description: string;
-        url: string;
-        type: string;
-        biggerIsBetter: boolean;
-    };
-    chunkCount: {
-        label: string;
-        description: string;
-        url: string;
-        type: string;
-        biggerIsBetter: boolean;
-    };
-    assetCount: {
-        label: string;
-        description: string;
-        url: string;
-        type: string;
-        biggerIsBetter: boolean;
-    };
-    moduleCount: {
-        label: string;
-        description: string;
-        url: string;
-        type: string;
-        biggerIsBetter: boolean;
-    };
-    duplicateModulesCount: {
-        label: string;
-        description: string;
-        url: string;
-        type: string;
-        biggerIsBetter: boolean;
-    };
-    duplicateCode: {
-        label: string;
-        description: string;
-        url: string;
-        type: string;
-        biggerIsBetter: boolean;
-    };
-    packageCount: {
-        label: string;
-        description: string;
-        url: string;
-        type: string;
-        biggerIsBetter: boolean;
-    };
-    duplicatePackagesCount: {
-        label: string;
-        description: string;
-        url: string;
-        type: string;
-        biggerIsBetter: boolean;
-    };
-    sizes: {
-        totalSizeByTypeJS: {
-            label: string;
-            type: string;
-            biggerIsBetter: boolean;
-        };
-        totalSizeByTypeCSS: {
-            label: string;
-            type: string;
-            biggerIsBetter: boolean;
-        };
-        totalSizeByTypeIMG: {
-            label: string;
-            type: string;
-            biggerIsBetter: boolean;
-        };
-        totalSizeByTypeMEDIA: {
-            label: string;
-            type: string;
-            biggerIsBetter: boolean;
-        };
-        totalSizeByTypeFONT: {
-            label: string;
-            type: string;
-            biggerIsBetter: boolean;
-        };
-        totalSizeByTypeHTML: {
-            label: string;
-            type: string;
-            biggerIsBetter: boolean;
-        };
-        totalSizeByTypeOTHER: {
-            label: string;
-            type: string;
-            biggerIsBetter: boolean;
-        };
-    };
-};
+export namespace metrics {
+    namespace totalSizeByTypeALL {
+        export const label: string;
+        export const description: string;
+        export const url: string;
+        export { METRIC_TYPE_FILE_SIZE as type };
+    }
+    namespace totalInitialSizeJS {
+        const label_1: string;
+        export { label_1 as label };
+        const description_1: string;
+        export { description_1 as description };
+        const url_1: string;
+        export { url_1 as url };
+        export { METRIC_TYPE_FILE_SIZE as type };
+    }
+    namespace totalInitialSizeCSS {
+        const label_2: string;
+        export { label_2 as label };
+        const description_2: string;
+        export { description_2 as description };
+        const url_2: string;
+        export { url_2 as url };
+        export { METRIC_TYPE_FILE_SIZE as type };
+    }
+    namespace cacheInvalidation {
+        const label_3: string;
+        export { label_3 as label };
+        const description_3: string;
+        export { description_3 as description };
+        const url_3: string;
+        export { url_3 as url };
+        export { METRIC_TYPE_PERCENTAGE as type };
+        export const biggerIsBetter: boolean;
+    }
+    namespace chunkCount {
+        const label_4: string;
+        export { label_4 as label };
+        const description_4: string;
+        export { description_4 as description };
+        const url_4: string;
+        export { url_4 as url };
+        export { METRIC_TYPE_NUMERIC as type };
+        const biggerIsBetter_1: boolean;
+        export { biggerIsBetter_1 as biggerIsBetter };
+    }
+    namespace assetCount {
+        const label_5: string;
+        export { label_5 as label };
+        const description_5: string;
+        export { description_5 as description };
+        const url_5: string;
+        export { url_5 as url };
+        export { METRIC_TYPE_NUMERIC as type };
+        const biggerIsBetter_2: boolean;
+        export { biggerIsBetter_2 as biggerIsBetter };
+    }
+    namespace moduleCount {
+        const label_6: string;
+        export { label_6 as label };
+        const description_6: string;
+        export { description_6 as description };
+        const url_6: string;
+        export { url_6 as url };
+        export { METRIC_TYPE_NUMERIC as type };
+        const biggerIsBetter_3: boolean;
+        export { biggerIsBetter_3 as biggerIsBetter };
+    }
+    namespace duplicateModulesCount {
+        const label_7: string;
+        export { label_7 as label };
+        const description_7: string;
+        export { description_7 as description };
+        const url_7: string;
+        export { url_7 as url };
+        export { METRIC_TYPE_NUMERIC as type };
+        const biggerIsBetter_4: boolean;
+        export { biggerIsBetter_4 as biggerIsBetter };
+    }
+    namespace duplicateCode {
+        const label_8: string;
+        export { label_8 as label };
+        const description_8: string;
+        export { description_8 as description };
+        const url_8: string;
+        export { url_8 as url };
+        export { METRIC_TYPE_PERCENTAGE as type };
+        const biggerIsBetter_5: boolean;
+        export { biggerIsBetter_5 as biggerIsBetter };
+    }
+    namespace packageCount {
+        const label_9: string;
+        export { label_9 as label };
+        const description_9: string;
+        export { description_9 as description };
+        const url_9: string;
+        export { url_9 as url };
+        export { METRIC_TYPE_NUMERIC as type };
+        const biggerIsBetter_6: boolean;
+        export { biggerIsBetter_6 as biggerIsBetter };
+    }
+    namespace duplicatePackagesCount {
+        const label_10: string;
+        export { label_10 as label };
+        const description_10: string;
+        export { description_10 as description };
+        const url_10: string;
+        export { url_10 as url };
+        export { METRIC_TYPE_NUMERIC as type };
+        const biggerIsBetter_7: boolean;
+        export { biggerIsBetter_7 as biggerIsBetter };
+    }
+    namespace sizes {
+        namespace totalSizeByTypeJS {
+            const label_11: string;
+            export { label_11 as label };
+            export { METRIC_TYPE_FILE_SIZE as type };
+        }
+        namespace totalSizeByTypeCSS {
+            const label_12: string;
+            export { label_12 as label };
+            export { METRIC_TYPE_FILE_SIZE as type };
+        }
+        namespace totalSizeByTypeIMG {
+            const label_13: string;
+            export { label_13 as label };
+            export { METRIC_TYPE_FILE_SIZE as type };
+        }
+        namespace totalSizeByTypeMEDIA {
+            const label_14: string;
+            export { label_14 as label };
+            export { METRIC_TYPE_FILE_SIZE as type };
+        }
+        namespace totalSizeByTypeFONT {
+            const label_15: string;
+            export { label_15 as label };
+            export { METRIC_TYPE_FILE_SIZE as type };
+        }
+        namespace totalSizeByTypeHTML {
+            const label_16: string;
+            export { label_16 as label };
+            export { METRIC_TYPE_FILE_SIZE as type };
+        }
+        namespace totalSizeByTypeOTHER {
+            const label_17: string;
+            export { label_17 as label };
+            export { METRIC_TYPE_FILE_SIZE as type };
+        }
+    }
+}
+import { METRIC_TYPE_FILE_SIZE } from "../config/metrics";
+import { METRIC_TYPE_PERCENTAGE } from "../config/metrics";
+import { METRIC_TYPE_NUMERIC } from "../config/metrics";