@stll/calculations 0.1.0 → 0.1.2

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

@@ -1,3 +1,4 @@
+import { panic } from "better-result";
 import { MoneyTotals, cents } from "@stll/money";
 //#region src/index.ts
 /**
@@ -81,7 +82,7 @@ const runCalculation = ({ kind, values, scopeValues }) => {
 			kind,
 			reason: "no-scope"
 		} : percentOfTotal(kind, values, scopeValues);
-		default: return kind;
+		default: return panic(`Unhandled kind: ${String(kind)}`);
 	}
 };
 const countEmpty = (values) => values.filter((value) => value.type === "empty").length;
@@ -96,7 +97,7 @@ const uniqueKey = (value) => {
 		case "number": return `n:${value.value}`;
 		case "money": return `m:${value.currency}:${value.amountCents}`;
 		case "text": return `t:${value.value}`;
-		default: return value;
+		default: return panic(`Unhandled value: ${String(value)}`);
 	}
 };
 const countUnique = (values) => {
@@ -131,7 +132,7 @@ const classify = (values) => {
 			else buckets.set(value.currency, [value.amountCents]);
 			break;
 		}
-		default: return value;
+		default: return panic(`Unhandled value: ${String(value)}`);
 	}
 	if (numbers.length > 0 && buckets.size > 0) return {
 		type: "unsupported",
@@ -192,7 +193,7 @@ const reduceNumeric = (kind, values) => {
 				totals: totals.entries()
 			};
 		}
-		default: return classified;
+		default: return panic(`Unhandled classified: ${String(classified)}`);
 	}
 };
 /**
@@ -256,7 +257,7 @@ const singleTotal = (values) => {
 				unit: currency
 			};
 		}
-		default: return classified;
+		default: return panic(`Unhandled classified: ${String(classified)}`);
 	}
 };
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stll/calculations",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Typed, unit-safe reducers for workspace column calculations.",
   "keywords": [
     "calculations",
@@ -39,22 +39,23 @@
     "build": "tsdown",
     "pack:dry-run": "bun pm pack --dry-run",
     "test": "bun test src",
-    "test:property": "bun test $(grep -rlF 'fc.assert' src)",
+    "test:property": "bun test --preload @stll/property-testing/preload $(grep -rlE 'fc\\.assert|assertProperty' 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",
+    "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": "oxfmt .",
+    "format": "bun ../../scripts/run-oxfmt.ts .",
     "prepack": "bun run build"
   },
   "dependencies": {
-    "@stll/money": "^0.1.0"
+    "@stll/money": "^0.3.0",
+    "better-result": "3.0.1"
   },
   "devDependencies": {
     "@stll/property-testing": "0.0.0",
     "@stll/typescript-config": "0.0.0",
-    "@types/bun": "1.3.14",
-    "fast-check": "^4.9.0",
-    "tsdown": "0.22.14"
+    "bun-types": "1.4.2",
+    "fast-check": "^4.10.1",
+    "tsdown": "0.23.0"
   },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts"