@justair/justair-library 4.15.0-alpha.d287cce → 5.0.0-alpha.56f07df

package/README.md

@@ -32,6 +32,64 @@ npm set //registry.npmjs.org/:_authToken=YOUR_ACCESS_TOKEN
 import { Monitors, Measurements, createLoggerInstance, Database } from '@justair/justair-library';
 ```
 
+## Constants
+
+The library exposes two entry points — one for Node.js services (models + constants) and one
+constants-only entry for browser environments like JustAir-Client.
+
+### Backend services
+
+```javascript
+import { PARAMETERS, HEAVY_METALS } from '@justair/justair-library';
+
+// Use .id for string comparisons and DB queries
+measurements.find({ parameter: PARAMETERS.PM2_5.id });
+
+// Use .label for user-facing display
+console.log(PARAMETERS.PM2_5.label); // "PM₂.₅"
+
+// Use .type to filter by category
+const gases = Object.values(PARAMETERS).filter(p => p.type === 'Gas');
+
+// Access health data for a sample parameter
+console.log(HEAVY_METALS.AS.rfc);     // 0.03
+console.log(HEAVY_METALS.AS.impacts); // "Short-term exposure..."
+```
+
+### JustAir-Client (browser)
+
+Use the constants-only entry point — no Mongoose dependency:
+
+```javascript
+import { PARAMETERS, HEAVY_METALS } from '@justair/justair-library/constants';
+```
+
+### New sample parameters in 5.0.0
+
+The following parameters were added to `HEAVY_METALS` and are now included in `sampleParametersEnum`. Consuming services that display or filter sample parameters (UI dropdowns, notification thresholds, reporting) should be updated to handle these values:
+
+| id | Name |
+|---|---|
+| `BE` | Beryllium |
+| `COBALT` | Cobalt |
+| `MN` | Manganese |
+| `SE` | Selenium |
+
+### Object shape
+
+Each constant is an object with the following fields:
+
+| Field | Type | Description |
+|---|---|---|
+| `id` | `string` | System-facing identifier stored in the database (e.g. `"PM2_5"`) |
+| `label` | `string` | Short user-facing name with Unicode subscripts (e.g. `"PM₂.₅"`) |
+| `name` | `string` | Full descriptive name (e.g. `"Particulate Matter 2.5 (PM₂.₅)"`) |
+| `unit` | `string` | Measurement unit (e.g. `"µg/m³"`) |
+| `type` | `string` | Category: `"Particulate Matter"`, `"Gas"`, `"Volatile Organic Compound"`, `"Weather"`, `"Heavy Metal"`, `"Heavy Metal - Essential Nutrient"` |
+| `rfc` | `number \| null` | EPA IRIS chronic inhalation reference concentration (µg/m³) |
+| `origin` | `string \| null` | Description of pollution source |
+| `impacts` | `string \| null` | Human health impact description |
+
 ## Development Workflow
 
 ### Testing locally (fast iteration)
@@ -45,12 +103,12 @@ For rapid local development without waiting for CI:
    npm pack
    ```
 
-   This creates a `.tgz` file (e.g., `justair-justair-library-4.9.2.tgz`).
+   This creates a `.tgz` file (e.g., `justair-justair-library-5.0.0.tgz`).
 
 2. **Install in a consuming service:**
 
    ```bash
-   npm install /path/to/justair-library/justair-justair-library-4.9.2.tgz
+   npm install /path/to/justair-library/justair-justair-library-5.0.0.tgz
    ```
 
    Or use `npm link` for live development:

package/dist/constants/pollutants.d.ts

@@ -0,0 +1,609 @@
+export namespace PARAMETERS {
+    namespace PM1 {
+        let id: string;
+        let label: string;
+        let name: string;
+        let unit: string;
+        let type: string;
+        let rfc: any;
+        let origin: any;
+        let impacts: any;
+    }
+    namespace PM2_5 {
+        let id_1: string;
+        export { id_1 as id };
+        let label_1: string;
+        export { label_1 as label };
+        let name_1: string;
+        export { name_1 as name };
+        let unit_1: string;
+        export { unit_1 as unit };
+        let type_1: string;
+        export { type_1 as type };
+        let rfc_1: any;
+        export { rfc_1 as rfc };
+        let origin_1: string;
+        export { origin_1 as origin };
+        let impacts_1: string;
+        export { impacts_1 as impacts };
+    }
+    namespace PM10 {
+        let id_2: string;
+        export { id_2 as id };
+        let label_2: string;
+        export { label_2 as label };
+        let name_2: string;
+        export { name_2 as name };
+        let unit_2: string;
+        export { unit_2 as unit };
+        let type_2: string;
+        export { type_2 as type };
+        let rfc_2: any;
+        export { rfc_2 as rfc };
+        let origin_2: string;
+        export { origin_2 as origin };
+        let impacts_2: string;
+        export { impacts_2 as impacts };
+    }
+    namespace BC {
+        let id_3: string;
+        export { id_3 as id };
+        let label_3: string;
+        export { label_3 as label };
+        let name_3: string;
+        export { name_3 as name };
+        let unit_3: string;
+        export { unit_3 as unit };
+        let type_3: string;
+        export { type_3 as type };
+        let rfc_3: any;
+        export { rfc_3 as rfc };
+        let origin_3: any;
+        export { origin_3 as origin };
+        let impacts_3: any;
+        export { impacts_3 as impacts };
+    }
+    namespace BRC {
+        let id_4: string;
+        export { id_4 as id };
+        let label_4: string;
+        export { label_4 as label };
+        let name_4: string;
+        export { name_4 as name };
+        let unit_4: string;
+        export { unit_4 as unit };
+        let type_4: string;
+        export { type_4 as type };
+        let rfc_4: any;
+        export { rfc_4 as rfc };
+        let origin_4: any;
+        export { origin_4 as origin };
+        let impacts_4: any;
+        export { impacts_4 as impacts };
+    }
+    namespace UFP {
+        let id_5: string;
+        export { id_5 as id };
+        let label_5: string;
+        export { label_5 as label };
+        let name_5: string;
+        export { name_5 as name };
+        let unit_5: string;
+        export { unit_5 as unit };
+        let type_5: string;
+        export { type_5 as type };
+        let rfc_5: any;
+        export { rfc_5 as rfc };
+        let origin_5: any;
+        export { origin_5 as origin };
+        let impacts_5: any;
+        export { impacts_5 as impacts };
+    }
+    namespace O3 {
+        let id_6: string;
+        export { id_6 as id };
+        let label_6: string;
+        export { label_6 as label };
+        let name_6: string;
+        export { name_6 as name };
+        let unit_6: string;
+        export { unit_6 as unit };
+        let type_6: string;
+        export { type_6 as type };
+        let rfc_6: any;
+        export { rfc_6 as rfc };
+        let origin_6: string;
+        export { origin_6 as origin };
+        let impacts_6: string;
+        export { impacts_6 as impacts };
+    }
+    namespace NO {
+        let id_7: string;
+        export { id_7 as id };
+        let label_7: string;
+        export { label_7 as label };
+        let name_7: string;
+        export { name_7 as name };
+        let unit_7: string;
+        export { unit_7 as unit };
+        let type_7: string;
+        export { type_7 as type };
+        let rfc_7: any;
+        export { rfc_7 as rfc };
+        let origin_7: any;
+        export { origin_7 as origin };
+        let impacts_7: any;
+        export { impacts_7 as impacts };
+    }
+    namespace NO2 {
+        let id_8: string;
+        export { id_8 as id };
+        let label_8: string;
+        export { label_8 as label };
+        let name_8: string;
+        export { name_8 as name };
+        let unit_8: string;
+        export { unit_8 as unit };
+        let type_8: string;
+        export { type_8 as type };
+        let rfc_8: any;
+        export { rfc_8 as rfc };
+        let origin_8: string;
+        export { origin_8 as origin };
+        let impacts_8: string;
+        export { impacts_8 as impacts };
+    }
+    namespace SO2 {
+        let id_9: string;
+        export { id_9 as id };
+        let label_9: string;
+        export { label_9 as label };
+        let name_9: string;
+        export { name_9 as name };
+        let unit_9: string;
+        export { unit_9 as unit };
+        let type_9: string;
+        export { type_9 as type };
+        let rfc_9: any;
+        export { rfc_9 as rfc };
+        let origin_9: any;
+        export { origin_9 as origin };
+        let impacts_9: any;
+        export { impacts_9 as impacts };
+    }
+    namespace CO {
+        let id_10: string;
+        export { id_10 as id };
+        let label_10: string;
+        export { label_10 as label };
+        let name_10: string;
+        export { name_10 as name };
+        let unit_10: string;
+        export { unit_10 as unit };
+        let type_10: string;
+        export { type_10 as type };
+        let rfc_10: any;
+        export { rfc_10 as rfc };
+        let origin_10: any;
+        export { origin_10 as origin };
+        let impacts_10: any;
+        export { impacts_10 as impacts };
+    }
+    namespace CO2 {
+        let id_11: string;
+        export { id_11 as id };
+        let label_11: string;
+        export { label_11 as label };
+        let name_11: string;
+        export { name_11 as name };
+        let unit_11: string;
+        export { unit_11 as unit };
+        let type_11: string;
+        export { type_11 as type };
+        let rfc_11: any;
+        export { rfc_11 as rfc };
+        let origin_11: any;
+        export { origin_11 as origin };
+        let impacts_11: any;
+        export { impacts_11 as impacts };
+    }
+    namespace CH4 {
+        let id_12: string;
+        export { id_12 as id };
+        let label_12: string;
+        export { label_12 as label };
+        let name_12: string;
+        export { name_12 as name };
+        let unit_12: string;
+        export { unit_12 as unit };
+        let type_12: string;
+        export { type_12 as type };
+        let rfc_12: any;
+        export { rfc_12 as rfc };
+        let origin_12: any;
+        export { origin_12 as origin };
+        let impacts_12: any;
+        export { impacts_12 as impacts };
+    }
+    namespace H2S {
+        let id_13: string;
+        export { id_13 as id };
+        let label_13: string;
+        export { label_13 as label };
+        let name_13: string;
+        export { name_13 as name };
+        let unit_13: string;
+        export { unit_13 as unit };
+        let type_13: string;
+        export { type_13 as type };
+        let rfc_13: any;
+        export { rfc_13 as rfc };
+        let origin_13: any;
+        export { origin_13 as origin };
+        let impacts_13: any;
+        export { impacts_13 as impacts };
+    }
+    namespace VOC {
+        let id_14: string;
+        export { id_14 as id };
+        let label_14: string;
+        export { label_14 as label };
+        let name_14: string;
+        export { name_14 as name };
+        let unit_14: string;
+        export { unit_14 as unit };
+        let type_14: string;
+        export { type_14 as type };
+        let rfc_14: any;
+        export { rfc_14 as rfc };
+        let origin_14: any;
+        export { origin_14 as origin };
+        let impacts_14: any;
+        export { impacts_14 as impacts };
+    }
+    namespace T {
+        let id_15: string;
+        export { id_15 as id };
+        let label_15: string;
+        export { label_15 as label };
+        let name_15: string;
+        export { name_15 as name };
+        let unit_15: string;
+        export { unit_15 as unit };
+        let type_15: string;
+        export { type_15 as type };
+        let rfc_15: any;
+        export { rfc_15 as rfc };
+        let origin_15: any;
+        export { origin_15 as origin };
+        let impacts_15: any;
+        export { impacts_15 as impacts };
+    }
+    namespace RH {
+        let id_16: string;
+        export { id_16 as id };
+        let label_16: string;
+        export { label_16 as label };
+        let name_16: string;
+        export { name_16 as name };
+        let unit_16: string;
+        export { unit_16 as unit };
+        let type_16: string;
+        export { type_16 as type };
+        let rfc_16: any;
+        export { rfc_16 as rfc };
+        let origin_16: any;
+        export { origin_16 as origin };
+        let impacts_16: any;
+        export { impacts_16 as impacts };
+    }
+    namespace DP {
+        let id_17: string;
+        export { id_17 as id };
+        let label_17: string;
+        export { label_17 as label };
+        let name_17: string;
+        export { name_17 as name };
+        let unit_17: string;
+        export { unit_17 as unit };
+        let type_17: string;
+        export { type_17 as type };
+        let rfc_17: any;
+        export { rfc_17 as rfc };
+        let origin_17: any;
+        export { origin_17 as origin };
+        let impacts_17: any;
+        export { impacts_17 as impacts };
+    }
+    namespace WS {
+        let id_18: string;
+        export { id_18 as id };
+        let label_18: string;
+        export { label_18 as label };
+        let name_18: string;
+        export { name_18 as name };
+        let unit_18: string;
+        export { unit_18 as unit };
+        let type_18: string;
+        export { type_18 as type };
+        let rfc_18: any;
+        export { rfc_18 as rfc };
+        let origin_18: any;
+        export { origin_18 as origin };
+        let impacts_18: any;
+        export { impacts_18 as impacts };
+    }
+    namespace WD {
+        let id_19: string;
+        export { id_19 as id };
+        let label_19: string;
+        export { label_19 as label };
+        let name_19: string;
+        export { name_19 as name };
+        let unit_19: string;
+        export { unit_19 as unit };
+        let type_19: string;
+        export { type_19 as type };
+        let rfc_19: any;
+        export { rfc_19 as rfc };
+        let origin_19: any;
+        export { origin_19 as origin };
+        let impacts_19: any;
+        export { impacts_19 as impacts };
+    }
+}
+export namespace HEAVY_METALS {
+    namespace C6H6 {
+        let id_20: string;
+        export { id_20 as id };
+        let label_20: string;
+        export { label_20 as label };
+        let name_20: string;
+        export { name_20 as name };
+        let unit_20: string;
+        export { unit_20 as unit };
+        let type_20: string;
+        export { type_20 as type };
+        let rfc_20: number;
+        export { rfc_20 as rfc };
+        let origin_20: string;
+        export { origin_20 as origin };
+        let impacts_20: string;
+        export { impacts_20 as impacts };
+    }
+    namespace AS {
+        let id_21: string;
+        export { id_21 as id };
+        let label_21: string;
+        export { label_21 as label };
+        let name_21: string;
+        export { name_21 as name };
+        let unit_21: string;
+        export { unit_21 as unit };
+        let type_21: string;
+        export { type_21 as type };
+        let rfc_21: number;
+        export { rfc_21 as rfc };
+        let origin_21: string;
+        export { origin_21 as origin };
+        let impacts_21: string;
+        export { impacts_21 as impacts };
+    }
+    namespace BA {
+        let id_22: string;
+        export { id_22 as id };
+        let label_22: string;
+        export { label_22 as label };
+        let name_22: string;
+        export { name_22 as name };
+        let unit_22: string;
+        export { unit_22 as unit };
+        let type_22: string;
+        export { type_22 as type };
+        let rfc_22: any;
+        export { rfc_22 as rfc };
+        let origin_22: string;
+        export { origin_22 as origin };
+        let impacts_22: string;
+        export { impacts_22 as impacts };
+    }
+    namespace BE {
+        let id_23: string;
+        export { id_23 as id };
+        let label_23: string;
+        export { label_23 as label };
+        let name_23: string;
+        export { name_23 as name };
+        let unit_23: string;
+        export { unit_23 as unit };
+        let type_23: string;
+        export { type_23 as type };
+        let rfc_23: number;
+        export { rfc_23 as rfc };
+        let origin_23: string;
+        export { origin_23 as origin };
+        let impacts_23: string;
+        export { impacts_23 as impacts };
+    }
+    namespace COBALT {
+        let id_24: string;
+        export { id_24 as id };
+        let label_24: string;
+        export { label_24 as label };
+        let name_24: string;
+        export { name_24 as name };
+        let unit_24: string;
+        export { unit_24 as unit };
+        let type_24: string;
+        export { type_24 as type };
+        let rfc_24: any;
+        export { rfc_24 as rfc };
+        let origin_24: string;
+        export { origin_24 as origin };
+        let impacts_24: string;
+        export { impacts_24 as impacts };
+    }
+    namespace NI {
+        let id_25: string;
+        export { id_25 as id };
+        let label_25: string;
+        export { label_25 as label };
+        let name_25: string;
+        export { name_25 as name };
+        let unit_25: string;
+        export { unit_25 as unit };
+        let type_25: string;
+        export { type_25 as type };
+        let rfc_25: any;
+        export { rfc_25 as rfc };
+        let origin_25: string;
+        export { origin_25 as origin };
+        let impacts_25: string;
+        export { impacts_25 as impacts };
+    }
+    namespace CD {
+        let id_26: string;
+        export { id_26 as id };
+        let label_26: string;
+        export { label_26 as label };
+        let name_26: string;
+        export { name_26 as name };
+        let unit_26: string;
+        export { unit_26 as unit };
+        let type_26: string;
+        export { type_26 as type };
+        let rfc_26: number;
+        export { rfc_26 as rfc };
+        let origin_26: string;
+        export { origin_26 as origin };
+        let impacts_26: string;
+        export { impacts_26 as impacts };
+    }
+    namespace CR {
+        let id_27: string;
+        export { id_27 as id };
+        let label_27: string;
+        export { label_27 as label };
+        let name_27: string;
+        export { name_27 as name };
+        let unit_27: string;
+        export { unit_27 as unit };
+        let type_27: string;
+        export { type_27 as type };
+        let rfc_27: number;
+        export { rfc_27 as rfc };
+        let origin_27: string;
+        export { origin_27 as origin };
+        let impacts_27: string;
+        export { impacts_27 as impacts };
+    }
+    namespace PB {
+        let id_28: string;
+        export { id_28 as id };
+        let label_28: string;
+        export { label_28 as label };
+        let name_28: string;
+        export { name_28 as name };
+        let unit_28: string;
+        export { unit_28 as unit };
+        let type_28: string;
+        export { type_28 as type };
+        let rfc_28: number;
+        export { rfc_28 as rfc };
+        let origin_28: string;
+        export { origin_28 as origin };
+        let impacts_28: string;
+        export { impacts_28 as impacts };
+    }
+    namespace FE {
+        let id_29: string;
+        export { id_29 as id };
+        let label_29: string;
+        export { label_29 as label };
+        let name_29: string;
+        export { name_29 as name };
+        let unit_29: string;
+        export { unit_29 as unit };
+        let type_29: string;
+        export { type_29 as type };
+        let rfc_29: any;
+        export { rfc_29 as rfc };
+        let origin_29: string;
+        export { origin_29 as origin };
+        let impacts_29: string;
+        export { impacts_29 as impacts };
+    }
+    namespace MN {
+        let id_30: string;
+        export { id_30 as id };
+        let label_30: string;
+        export { label_30 as label };
+        let name_30: string;
+        export { name_30 as name };
+        let unit_30: string;
+        export { unit_30 as unit };
+        let type_30: string;
+        export { type_30 as type };
+        let rfc_30: number;
+        export { rfc_30 as rfc };
+        let origin_30: string;
+        export { origin_30 as origin };
+        let impacts_30: string;
+        export { impacts_30 as impacts };
+    }
+    namespace SE {
+        let id_31: string;
+        export { id_31 as id };
+        let label_31: string;
+        export { label_31 as label };
+        let name_31: string;
+        export { name_31 as name };
+        let unit_31: string;
+        export { unit_31 as unit };
+        let type_31: string;
+        export { type_31 as type };
+        let rfc_31: any;
+        export { rfc_31 as rfc };
+        let origin_31: string;
+        export { origin_31 as origin };
+        let impacts_31: string;
+        export { impacts_31 as impacts };
+    }
+    namespace CU {
+        let id_32: string;
+        export { id_32 as id };
+        let label_32: string;
+        export { label_32 as label };
+        let name_32: string;
+        export { name_32 as name };
+        let unit_32: string;
+        export { unit_32 as unit };
+        let type_32: string;
+        export { type_32 as type };
+        let rfc_32: any;
+        export { rfc_32 as rfc };
+        let origin_32: string;
+        export { origin_32 as origin };
+        let impacts_32: string;
+        export { impacts_32 as impacts };
+    }
+    namespace ZN {
+        let id_33: string;
+        export { id_33 as id };
+        let label_33: string;
+        export { label_33 as label };
+        let name_33: string;
+        export { name_33 as name };
+        let unit_33: string;
+        export { unit_33 as unit };
+        let type_33: string;
+        export { type_33 as type };
+        let rfc_33: any;
+        export { rfc_33 as rfc };
+        let origin_33: string;
+        export { origin_33 as origin };
+        let impacts_33: string;
+        export { impacts_33 as impacts };
+    }
+}
+//# sourceMappingURL=pollutants.d.ts.map

package/dist/constants/pollutants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pollutants.d.ts","sourceRoot":"","sources":["../../src/constants/pollutants.js"],"names":[],"mappings":""}

package/dist/constants/tests/pollutants.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=pollutants.test.d.ts.map

package/dist/constants/tests/pollutants.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pollutants.test.d.ts","sourceRoot":"","sources":["../../../src/constants/tests/pollutants.test.js"],"names":[],"mappings":""}