@bundle-stats/utils 3.2.1 → 3.3.0-alpha.1

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

@@ -3,62 +3,66 @@ import {
   METRIC_TYPE_NUMERIC,
   METRIC_TYPE_PERCENTAGE,
 } from '../config/metrics';
+import { MetricId, SizeByTypeMetricId } from './constants';
 
 export const metrics = {
-  totalSizeByTypeALL: {
+  [MetricId.BundleSize]: {
     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,
   },
-  totalInitialSizeJS: {
+  [MetricId.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,
   },
-  totalInitialSizeCSS: {
+  [MetricId.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,
   },
-  cacheInvalidation: {
+  [MetricId.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,
   },
-  chunkCount: {
+  [MetricId.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,
   },
-  assetCount: {
+  [MetricId.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,
   },
-  moduleCount: {
+  [MetricId.ModuleName]: {
     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,
   },
-  packageCount: {
+  [MetricId.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,
   },
-  duplicatePackagesCount: {
+  [MetricId.DuplicatePackagesCount]: {
     label: 'Duplicate Packages',
     description: 'Total number of packages that are duplicated.',
     url: 'https://relative-ci.com/documentation/metrics-and-data#packages',
@@ -66,33 +70,40 @@ export const metrics = {
     biggerIsBetter: false,
   },
   sizes: {
-    totalSizeByTypeJS: {
+    [SizeByTypeMetricId.JS]: {
       label: 'JS',
       type: METRIC_TYPE_FILE_SIZE,
+      biggerIsBetter: false,
     },
-    totalSizeByTypeCSS: {
+    [SizeByTypeMetricId.CSS]: {
       label: 'CSS',
       type: METRIC_TYPE_FILE_SIZE,
+      biggerIsBetter: false,
     },
-    totalSizeByTypeIMG: {
+    [SizeByTypeMetricId.IMG]: {
       label: 'IMG',
       type: METRIC_TYPE_FILE_SIZE,
+      biggerIsBetter: false,
     },
-    totalSizeByTypeMEDIA: {
+    [SizeByTypeMetricId.Media]: {
       label: 'Media',
       type: METRIC_TYPE_FILE_SIZE,
+      biggerIsBetter: false,
     },
-    totalSizeByTypeFONT: {
+    [SizeByTypeMetricId.Font]: {
       label: 'Fonts',
       type: METRIC_TYPE_FILE_SIZE,
+      biggerIsBetter: false,
     },
-    totalSizeByTypeHTML: {
+    [SizeByTypeMetricId.HTML]: {
       label: 'HTML',
       type: METRIC_TYPE_FILE_SIZE,
+      biggerIsBetter: false,
     },
-    totalSizeByTypeOTHER: {
+    [SizeByTypeMetricId.Other]: {
       label: 'Other',
       type: METRIC_TYPE_FILE_SIZE,
+      biggerIsBetter: false,
     },
   },
 };

package/types/constants.d.ts

@@ -154,3 +154,9 @@ 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,5 +1,7 @@
 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): {};
+export function createJob(source: any, baseline: any, options?: {}): {};

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

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

package/types/transformers/budgets-insights.d.ts

@@ -0,0 +1,36 @@
+import { InsightType } from '../constants';
+interface OptionBudgetMetric {
+    metric: string;
+    value: number;
+}
+interface Options {
+    budgets?: Array<OptionBudgetMetric>;
+}
+interface BudgetInsight {
+    currentValue: number;
+    budgetValue: number;
+    failed: boolean;
+}
+interface BudgetInsightInfo {
+    type: InsightType;
+    message: {
+        template: string;
+        data: Record<string, unknown>;
+    };
+    source: {
+        metricId: string;
+        budgetInsight: BudgetInsight;
+    };
+}
+interface BudgetInsights {
+    [metricId: string]: BudgetInsight;
+}
+interface BudgetsInsightsOutput {
+    insights: {
+        budgets: BudgetInsights;
+    };
+}
+export declare const getExtract: (source: string) => (_: unknown, currentExtractedData: any, __: unknown, options?: Options) => BudgetsInsightsOutput | null;
+export declare const INFO_MESSAGE_TEMPLATE = "<%= metricLabel %> value (<%= currentValue %>) is <%= diffLabel %> <%= budgetValue %> budget";
+export declare const getInfo: (globalMetricId: string, budgetInsight: BudgetInsight) => BudgetInsightInfo;
+export {};

package/types/transformers/index.d.ts

@@ -0,0 +1 @@
+export * as budgetInsights from './budgets-insights';

package/types/webpack/constants.d.ts

@@ -1,9 +1,31 @@
-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;
+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",
+    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;

package/types/webpack/extract/budgets-insights.d.ts

@@ -0,0 +1,22 @@
+interface OptionBudgetMetric {
+    metric: string;
+    value: number;
+}
+interface Options {
+    budgets?: Array<OptionBudgetMetric>;
+}
+interface BudgetInsight {
+    currentValue: number;
+    budgetValue: number;
+    failed: boolean;
+}
+interface BudgetsInsights {
+    [metricId: string]: BudgetInsight;
+}
+interface ExtractBudgetsInsights {
+    insights: {
+        budgets: BudgetsInsights;
+    };
+}
+export default function extractBudgetsInsights(_: unknown, currentExtractedData: any, __: unknown, options?: Options): ExtractBudgetsInsights | null;
+export {};

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

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

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

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

package/types/webpack/metrics.d.ts

@@ -1,131 +1,102 @@
-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 packageCount {
-        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 duplicatePackagesCount {
-        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_NUMERIC as type };
-        const biggerIsBetter_5: boolean;
-        export { biggerIsBetter_5 as biggerIsBetter };
-    }
-    namespace sizes {
-        namespace totalSizeByTypeJS {
-            const label_9: string;
-            export { label_9 as label };
-            export { METRIC_TYPE_FILE_SIZE as type };
-        }
-        namespace totalSizeByTypeCSS {
-            const label_10: string;
-            export { label_10 as label };
-            export { METRIC_TYPE_FILE_SIZE as type };
-        }
-        namespace totalSizeByTypeIMG {
-            const label_11: string;
-            export { label_11 as label };
-            export { METRIC_TYPE_FILE_SIZE as type };
-        }
-        namespace totalSizeByTypeMEDIA {
-            const label_12: string;
-            export { label_12 as label };
-            export { METRIC_TYPE_FILE_SIZE as type };
-        }
-        namespace totalSizeByTypeFONT {
-            const label_13: string;
-            export { label_13 as label };
-            export { METRIC_TYPE_FILE_SIZE as type };
-        }
-        namespace totalSizeByTypeHTML {
-            const label_14: string;
-            export { label_14 as label };
-            export { METRIC_TYPE_FILE_SIZE as type };
-        }
-        namespace totalSizeByTypeOTHER {
-            const label_15: string;
-            export { label_15 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";
+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;
+    };
+    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;
+        };
+    };
+};