@code-pushup/utils 0.10.5 → 0.10.7

package/index.js

@@ -1470,24 +1470,6 @@ function toUnixPath(path, options) {
 }
 
 // packages/utils/src/lib/reports/scoring.ts
-function calculateScore(refs, scoreFn) {
-  const { numerator, denominator } = refs.reduce(
-    (acc, ref) => {
-      const score = scoreFn(ref);
-      return {
-        numerator: acc.numerator + score * ref.weight,
-        denominator: acc.denominator + ref.weight
-      };
-    },
-    { numerator: 0, denominator: 0 }
-  );
-  if (!numerator && !denominator) {
-    throw new Error(
-      "0 division for score. This can be caused by refs only weighted with 0 or empty refs"
-    );
-  }
-  return numerator / denominator;
-}
 function scoreReport(report) {
   const allScoredAuditsAndGroups = /* @__PURE__ */ new Map();
   const scoredPlugins = report.plugins.map((plugin) => {
@@ -1537,6 +1519,36 @@ function scoreReport(report) {
     categories: scoredCategories
   };
 }
+function calculateScore(refs, scoreFn) {
+  const validatedRefs = parseScoringParameters(refs, scoreFn);
+  const { numerator, denominator } = validatedRefs.reduce(
+    (acc, ref) => ({
+      numerator: acc.numerator + ref.score * ref.weight,
+      denominator: acc.denominator + ref.weight
+    }),
+    { numerator: 0, denominator: 0 }
+  );
+  return numerator / denominator;
+}
+function parseScoringParameters(refs, scoreFn) {
+  if (refs.length === 0) {
+    throw new Error("Reference array cannot be empty.");
+  }
+  if (refs.some((ref) => ref.weight < 0)) {
+    throw new Error("Weight cannot be negative.");
+  }
+  if (refs.every((ref) => ref.weight === 0)) {
+    throw new Error("All references cannot have zero weight.");
+  }
+  const scoredRefs = refs.map((ref) => ({
+    weight: ref.weight,
+    score: scoreFn(ref)
+  }));
+  if (scoredRefs.some((ref) => ref.score < 0 || ref.score > 1)) {
+    throw new Error("All scores must be in range 0-1.");
+  }
+  return scoredRefs;
+}
 
 // packages/utils/src/lib/reports/sorting.ts
 function sortReport(report) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.10.5",
+  "version": "0.10.7",
   "dependencies": {
     "@code-pushup/models": "*",
     "bundle-require": "^4.0.1",

package/src/lib/reports/scoring.d.ts

@@ -22,7 +22,7 @@ export type ScoredReport = Omit<Report, 'plugins' | 'categories'> & {
     })[];
     categories: ScoredCategoryConfig[];
 };
+export declare function scoreReport(report: Report): ScoredReport;
 export declare function calculateScore<T extends {
     weight: number;
 }>(refs: T[], scoreFn: (ref: T) => number): number;
-export declare function scoreReport(report: Report): ScoredReport;