Create validation package (#589)

.changeset/shiny-emus-refuse.md

@@ -0,0 +1,5 @@
+---
+"@actnowcoalition/actnow.js": minor
+---
+
+Create validation package

src/assert/README.md

@@ -1,12 +1,6 @@
-# @actnowcoalition/assert
+## Usage
 
-Assertion functions
-
-## Installing
-
-```sh
-yarn add @actnowcoalition/assert
-```
+> Assertion functions
 
 ## License
 

src/index.ts

@@ -4,3 +4,4 @@ export * from "./number-format";
 export * from "./regions";
 export * from "./time-utils";
 export * from "./ui-components";
+export * from "./validate";

src/metrics/README.md

@@ -1,15 +1,7 @@
-# @actnowcoalition/metrics
+## Design Overview / Usage
 
 > Classes for representing metrics and loading metric data
 
-## Installing
-
-```sh
-yarn add @actnowcoalition/metrics
-```
-
-## Design Overview / Usage
-
 ### Main classes
 
 The metrics package contains a few key classes:

src/number-format/README.md

@@ -1,13 +1,7 @@
-# @actnowcoalition/number-format
+## Usage
 
 > Number formatting utility functions
 
-## Installing
-
-```sh
-yarn add @actnowcoalition/number-format
-```
-
 ## License
 
 [MIT](./LICENSE)

src/regions/README.md

@@ -1,9 +1,7 @@
-# @actnowcoalition/regions
+## Usage
 
 > A package containing classes and datasets to represent geographic areas and administrative divisions with a uniform interface.
 
-## Usage
-
 The `Region` class defines the main elements that represent an administrative division.
 
 ```tsx
@@ -73,12 +71,6 @@ const irl = nations.findByRegionId("IRL");
 console.log(irl.fullName); // Ireland
 ```
 
-## Installing
-
-```sh
-yarn add @actnowcoalition/regions
-```
-
 ## License
 
 [MIT](./LICENSE)

src/time-utils/README.md

@@ -1,13 +1,7 @@
-# @actnowcoalition/time-utils
+## Usage
 
 > Utility functions to handle and format time
 
-## Installing
-
-```sh
-yarn add @actnowcoalition/time-utils
-```
-
 ## License
 
 [MIT](./LICENSE)

src/ui-components/README.md

@@ -1,13 +1,7 @@
-# @actnowcoalition/ui-components
+## Usage
 
 > UI components for Act Now
 
-## Installing
-
-```sh
-yarn add @actnowcoalition/ui-components
-```
-
 ## License
 
 [MIT](./LICENSE)

src/ui-components/components/MetricLegendCategorical/MetricLegendCategorical.tsx

@@ -2,8 +2,8 @@ import React from "react";
 
 import { Stack, Typography } from "@mui/material";
 
-import { assert } from "../../../assert";
 import { Category, Metric } from "../../../metrics";
+import { validate } from "../../../validate";
 import { LegendCategorical } from "../LegendCategorical";
 import { useMetricCatalog } from "../MetricCatalogContext";
 
@@ -29,7 +29,7 @@ export const MetricLegendCategorical = ({
   const metricCatalog = useMetricCatalog();
   metric = metricCatalog.getMetric(metric);
   const items = metric.categorySet?.categories;
-  assert(
+  validate(
     items,
     "Metric must define categories in order to use MetricLegendCategorical. " +
       `No categories found for metric: ${metric}`

src/validate/README.md

@@ -0,0 +1,7 @@
+## Usage
+
+> Validation functions
+
+## License
+
+[MIT](./LICENSE)

src/validate/index.test.ts

@@ -0,0 +1,26 @@
+import { throwValidationError, validate } from "./index";
+
+describe("validate", () => {
+  test("throws an error if condition is falsy", () => {
+    const errorMsg = "Error message";
+    expect(() => validate(false)).toThrow();
+    expect(() => validate(0)).toThrow();
+    expect(() => validate(undefined)).toThrow();
+    expect(() => validate(null)).toThrow();
+    expect(() => validate("")).toThrow();
+    expect(() => validate(false, errorMsg)).toThrowError(errorMsg);
+  });
+
+  test("pass if condition is truthy", () => {
+    expect(() => validate(true)).not.toThrow();
+    expect(() => validate(1)).not.toThrow();
+  });
+});
+
+describe("throwActNowJsError", () => {
+  const errorMsg = "Error message";
+  test("throws an error with the given message", () => {
+    expect(() => throwValidationError()).toThrow();
+    expect(() => throwValidationError(errorMsg)).toThrowError(errorMsg);
+  });
+});

src/validate/index.ts

@@ -0,0 +1,30 @@
+/**
+ * Test if the `condition` is truthy. If `condition` is false, it throws
+ * an error with an optional message. If the message parameter is missing,
+ * it throws an error with a default message.
+ */
+export function validate(
+  condition: unknown,
+  errorMessage?: string
+): asserts condition {
+  if (!condition) {
+    throw new ActNowJsError(errorMessage);
+  }
+}
+
+/**
+ * Throws an Error with the (optionally) provided error message.
+ */
+export function throwValidationError(errorMessage?: string): never {
+  throw new ActNowJsError(errorMessage);
+}
+
+/**
+ * An ActNowJsError class to differentiate from default and internal errors.
+ */
+export class ActNowJsError extends Error {
+  constructor(public readonly errorMessage?: string) {
+    super(errorMessage);
+    this.name = "ActNowJsError";
+  }
+}