@stll/calculations 0.1.1 → 0.1.3

package/dist/index.d.ts

@@ -1,11 +1,11 @@
 import { CentsAmount, MoneyTotalsEntry } from "@stll/money";
 //#region src/index.d.ts
-declare const CALCULATION_KINDS: readonly ["count", "count-unique", "count-empty", "count-filled", "percent-empty", "percent-filled", "sum", "average", "median", "min", "max", "range", "percent-of-total"];
-type CalculationKind = (typeof CALCULATION_KINDS)[number];
+export declare const CALCULATION_KINDS: readonly ["count", "count-unique", "count-empty", "count-filled", "percent-empty", "percent-filled", "sum", "average", "median", "min", "max", "range", "percent-of-total"];
+export type CalculationKind = (typeof CALCULATION_KINDS)[number];
 /** Kinds that reduce the values themselves rather than counting rows. */
-declare const NUMERIC_CALCULATION_KINDS: readonly ["sum", "average", "median", "min", "max", "range", "percent-of-total"];
-type NumericCalculationKind = (typeof NUMERIC_CALCULATION_KINDS)[number];
-declare const isNumericCalculationKind: (kind: CalculationKind) => kind is NumericCalculationKind;
+export declare const NUMERIC_CALCULATION_KINDS: readonly ["sum", "average", "median", "min", "max", "range", "percent-of-total"];
+export type NumericCalculationKind = (typeof NUMERIC_CALCULATION_KINDS)[number];
+export declare const isNumericCalculationKind: (kind: CalculationKind) => kind is NumericCalculationKind;
 /**
  * One row's contribution to a calculation.
  *
@@ -13,7 +13,7 @@ declare const isNumericCalculationKind: (kind: CalculationKind) => kind is Numer
  * rather than a null value so "no value" is never confused with the number
  * zero, which is what makes count-empty and average disagree correctly.
  */
-type CalculationValue = {
+export type CalculationValue = {
   type: "empty";
 } | {
   type: "number";
@@ -26,7 +26,7 @@ type CalculationValue = {
   type: "text";
   value: string;
 };
-type CalculationUnsupportedReason =
+export type CalculationUnsupportedReason =
 /** A numeric reduction over values that are not numbers. */
 "non-numeric" |
 /** Numbers mixed with money, or money the reduction cannot combine. */
@@ -35,7 +35,7 @@ type CalculationUnsupportedReason =
 "no-values" |
 /** A share of the whole, asked without being told what the whole is. */
 "no-scope";
-type CalculationResult =
+export type CalculationResult =
 /** A number of rows. */
 {
   type: "count";
@@ -64,7 +64,7 @@ type CalculationResult =
   kind: CalculationKind;
   reason: CalculationUnsupportedReason;
 };
-type RunCalculationParams = {
+export type RunCalculationParams = {
   kind: CalculationKind;
   /** The values in the column, in row order. */
   values: readonly CalculationValue[];
@@ -76,6 +76,6 @@ type RunCalculationParams = {
    */
   scopeValues?: readonly CalculationValue[] | undefined;
 };
-declare const runCalculation: ({ kind, values, scopeValues }: RunCalculationParams) => CalculationResult;
+export declare const runCalculation: ({ kind, values, scopeValues }: RunCalculationParams) => CalculationResult;
 //#endregion
-export { CALCULATION_KINDS, CalculationKind, CalculationResult, CalculationUnsupportedReason, CalculationValue, type CentsAmount, type MoneyTotalsEntry, NUMERIC_CALCULATION_KINDS, NumericCalculationKind, RunCalculationParams, isNumericCalculationKind, runCalculation };
+export type { CentsAmount, MoneyTotalsEntry };

package/dist/index.js

@@ -124,9 +124,17 @@ const classify = (values) => {
 			reason: "non-numeric"
 		};
 		case "number":
+			if (!Number.isFinite(value.value)) return {
+				type: "unsupported",
+				reason: "non-numeric"
+			};
 			numbers.push(value.value);
 			break;
 		case "money": {
+			if (!Number.isFinite(value.amountCents)) return {
+				type: "unsupported",
+				reason: "non-numeric"
+			};
 			const bucket = buckets.get(value.currency);
 			if (bucket) bucket.push(value.amountCents);
 			else buckets.set(value.currency, [value.amountCents]);
@@ -179,14 +187,18 @@ const reduceNumeric = (kind, values) => {
 				kind,
 				reason: classified.reason
 			};
-		case "numbers": return {
-			type: "number",
-			kind,
-			value: REDUCERS[kind](classified.values)
-		};
+		case "numbers": return finiteNumberResult(kind, REDUCERS[kind](classified.values));
 		case "money": {
 			const totals = new MoneyTotals();
-			for (const [currency, amounts] of classified.buckets) totals.add(currency, cents(Math.round(REDUCERS[kind](amounts))));
+			for (const [currency, amounts] of classified.buckets) {
+				const reduced = REDUCERS[kind](amounts);
+				if (!Number.isFinite(reduced)) return {
+					type: "unsupported",
+					kind,
+					reason: "non-numeric"
+				};
+				totals.add(currency, cents(Math.round(reduced)));
+			}
 			return {
 				type: "money",
 				kind,
@@ -196,6 +208,15 @@ const reduceNumeric = (kind, values) => {
 		default: return panic(`Unhandled classified: ${String(classified)}`);
 	}
 };
+const finiteNumberResult = (kind, value) => Number.isFinite(value) ? {
+	type: "number",
+	kind,
+	value
+} : {
+	type: "unsupported",
+	kind,
+	reason: "non-numeric"
+};
 /**
 * The column's total as a share of the view's total.
 *
@@ -240,25 +261,25 @@ const singleTotal = (values) => {
 			type: "unsupported",
 			reason: classified.reason
 		};
-		case "numbers": return {
-			type: "total",
-			value: REDUCERS.sum(classified.values),
-			unit: "number"
-		};
+		case "numbers": return finiteTotal(REDUCERS.sum(classified.values), "number");
 		case "money": {
 			if (classified.buckets.size > 1) return {
 				type: "unsupported",
 				reason: "mixed-units"
 			};
 			const [currency, amounts] = [...classified.buckets.entries()].at(0) ?? ["", []];
-			return {
-				type: "total",
-				value: REDUCERS.sum(amounts),
-				unit: currency
-			};
+			return finiteTotal(REDUCERS.sum(amounts), currency);
 		}
 		default: return panic(`Unhandled classified: ${String(classified)}`);
 	}
 };
+const finiteTotal = (value, unit) => Number.isFinite(value) ? {
+	type: "total",
+	value,
+	unit
+} : {
+	type: "unsupported",
+	reason: "non-numeric"
+};
 //#endregion
 export { CALCULATION_KINDS, NUMERIC_CALCULATION_KINDS, isNumericCalculationKind, runCalculation };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stll/calculations",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Typed, unit-safe reducers for workspace column calculations.",
   "keywords": [
     "calculations",
@@ -39,23 +39,23 @@
     "build": "tsdown",
     "pack:dry-run": "bun pm pack --dry-run",
     "test": "bun test src",
-    "test:property": "bun test --preload @stll/property-testing/preload $(grep -rlF 'fc.assert' src)",
-    "typecheck": "bun ../../packages/scripts/src/tsc-native.ts --noEmit",
-    "lint": "cd ../.. && bun --bun oxlint -c oxlint.config.ts --report-unused-disable-directives-severity=error --deny-warnings --type-aware packages/calculations",
+    "test:property": "bun test --preload @stll/property-testing/preload $(grep -rlE 'fc\\.assert|assertProperty' src)",
+    "typecheck": "bun check --no-pretty --all --project=tsconfig.json",
+    "lint": "cd ../.. && bun --bun oxlint -c oxlint.config.ts --report-unused-disable-directives-severity=error --type-aware --type-check packages/calculations",
     "lint:fix": "cd ../.. && bun --bun oxlint -c oxlint.config.ts --type-aware --fix packages/calculations",
     "format": "bun ../../scripts/run-oxfmt.ts .",
     "prepack": "bun run build"
   },
   "dependencies": {
-    "@stll/money": "^0.2.0",
-    "better-result": "3.0.0"
+    "@stll/money": "^0.3.1",
+    "better-result": "3.0.1"
   },
   "devDependencies": {
     "@stll/property-testing": "0.0.0",
     "@stll/typescript-config": "0.0.0",
-    "bun-types": "1.4.2",
-    "fast-check": "^4.9.0",
-    "tsdown": "0.22.14"
+    "bun-types": "1.4.3",
+    "fast-check": "^4.10.2",
+    "tsdown": "0.23.0"
   },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts"