@justair/justair-library 7.8.0-alpha.eb2cc63 → 7.8.0

package/README.md

@@ -99,7 +99,7 @@ The following parameters were added to `HEAVY_METALS` and are now included in `s
 
 ### New met parameters in 7.4.0
 
-The following parameters were added to `PARAMETERS` and are now included in `parametersEnum`. Consuming services that display or filter parameters without a `type` filter (admin pickers, notification threshold UIs, reporting) will start showing them on install, even though no service writes them yet.
+The following parameters were added to `PARAMETERS` and are now included in `parametersEnum`. Consuming services that display or filter parameters without a `type` filter (admin pickers, notification threshold UIs, reporting) will start showing them on install.
 
 | id | Name | Unit |
 |---|---|---|
@@ -109,6 +109,18 @@ The following parameters were added to `PARAMETERS` and are now included in `par
 
 These are **not** interchangeable with the bare `T` / `RH` / `DP` ids, which are enclosure-internal readings used only by correction equations and fog detection. Never fall back from one kind to the other. See "Ambient vs internal met parameters" in `CLAUDE.md` before wiring these up.
 
+Processing-Engine writes these as of JA-3061 and CalculateAQIService averages them into `monitorProperties.metProperties` as of JA-3626.
+
+### New met parameter in 7.8.0
+
+| id | Name | Unit |
+|---|---|---|
+| `HI` | Heat Index | `°F` |
+
+Same install-time visibility caveat as the 7.4.0 section above.
+
+`HI` is **derived, not measured**. Processing-Engine computes it from that reading's own `T_AMB` / `RH_AMB` pair using the NOAA formula (JA-3120); no supplier reports it. It takes no `_AMB` suffix because there is no internal counterpart — an enclosure Heat Index would describe the inside of the housing. Never compute it from the bare `T` / `RH`.
+
 ### Object shape
 
 Each constant is an object with the following fields:

package/dist/constants/pollutants.d.ts

@@ -423,7 +423,7 @@ export namespace PARAMETERS {
         let impacts_23: any;
         export { impacts_23 as impacts };
     }
-    namespace R {
+    namespace HI {
         let id_24: string;
         export { id_24 as id };
         let label_24: string;
@@ -441,7 +441,7 @@ export namespace PARAMETERS {
         let impacts_24: any;
         export { impacts_24 as impacts };
     }
-    namespace SR {
+    namespace R {
         let id_25: string;
         export { id_25 as id };
         let label_25: string;
@@ -459,7 +459,7 @@ export namespace PARAMETERS {
         let impacts_25: any;
         export { impacts_25 as impacts };
     }
-    namespace P {
+    namespace SR {
         let id_26: string;
         export { id_26 as id };
         let label_26: string;
@@ -477,7 +477,7 @@ export namespace PARAMETERS {
         let impacts_26: any;
         export { impacts_26 as impacts };
     }
-    namespace PAR {
+    namespace P {
         let id_27: string;
         export { id_27 as id };
         let label_27: string;
@@ -495,7 +495,7 @@ export namespace PARAMETERS {
         let impacts_27: any;
         export { impacts_27 as impacts };
     }
-    namespace ARM {
+    namespace PAR {
         let id_28: string;
         export { id_28 as id };
         let label_28: string;
@@ -513,7 +513,7 @@ export namespace PARAMETERS {
         let impacts_28: any;
         export { impacts_28 as impacts };
     }
-    namespace ARW {
+    namespace ARM {
         let id_29: string;
         export { id_29 as id };
         let label_29: string;
@@ -531,7 +531,7 @@ export namespace PARAMETERS {
         let impacts_29: any;
         export { impacts_29 as impacts };
     }
-    namespace ARD {
+    namespace ARW {
         let id_30: string;
         export { id_30 as id };
         let label_30: string;
@@ -549,7 +549,7 @@ export namespace PARAMETERS {
         let impacts_30: any;
         export { impacts_30 as impacts };
     }
-    namespace ARH {
+    namespace ARD {
         let id_31: string;
         export { id_31 as id };
         let label_31: string;
@@ -567,9 +567,7 @@ export namespace PARAMETERS {
         let impacts_31: any;
         export { impacts_31 as impacts };
     }
-}
-export namespace HEAVY_METALS {
-    export namespace AS {
+    namespace ARH {
         let id_32: string;
         export { id_32 as id };
         let label_32: string;
@@ -580,14 +578,16 @@ export namespace HEAVY_METALS {
         export { unit_32 as unit };
         let type_32: string;
         export { type_32 as type };
-        let rfc_32: number;
+        let rfc_32: any;
         export { rfc_32 as rfc };
-        let origin_32: string;
+        let origin_32: any;
         export { origin_32 as origin };
-        let impacts_32: string;
+        let impacts_32: any;
         export { impacts_32 as impacts };
     }
-    export namespace BA {
+}
+export namespace HEAVY_METALS {
+    export namespace AS {
         let id_33: string;
         export { id_33 as id };
         let label_33: string;
@@ -598,14 +598,14 @@ export namespace HEAVY_METALS {
         export { unit_33 as unit };
         let type_33: string;
         export { type_33 as type };
-        let rfc_33: any;
+        let rfc_33: number;
         export { rfc_33 as rfc };
         let origin_33: string;
         export { origin_33 as origin };
         let impacts_33: string;
         export { impacts_33 as impacts };
     }
-    export namespace C6H6 {
+    export namespace BA {
         let id_34: string;
         export { id_34 as id };
         let label_34: string;
@@ -616,14 +616,14 @@ export namespace HEAVY_METALS {
         export { unit_34 as unit };
         let type_34: string;
         export { type_34 as type };
-        let rfc_34: number;
+        let rfc_34: any;
         export { rfc_34 as rfc };
         let origin_34: string;
         export { origin_34 as origin };
         let impacts_34: string;
         export { impacts_34 as impacts };
     }
-    export namespace BE {
+    export namespace C6H6 {
         let id_35: string;
         export { id_35 as id };
         let label_35: string;
@@ -641,7 +641,7 @@ export namespace HEAVY_METALS {
         let impacts_35: string;
         export { impacts_35 as impacts };
     }
-    export namespace CD {
+    export namespace BE {
         let id_36: string;
         export { id_36 as id };
         let label_36: string;
@@ -659,7 +659,7 @@ export namespace HEAVY_METALS {
         let impacts_36: string;
         export { impacts_36 as impacts };
     }
-    export namespace CR {
+    export namespace CD {
         let id_37: string;
         export { id_37 as id };
         let label_37: string;
@@ -677,7 +677,7 @@ export namespace HEAVY_METALS {
         let impacts_37: string;
         export { impacts_37 as impacts };
     }
-    export namespace CO_1 {
+    export namespace CR {
         let id_38: string;
         export { id_38 as id };
         let label_38: string;
@@ -688,15 +688,14 @@ export namespace HEAVY_METALS {
         export { unit_38 as unit };
         let type_38: string;
         export { type_38 as type };
-        let rfc_38: any;
+        let rfc_38: number;
         export { rfc_38 as rfc };
         let origin_38: string;
         export { origin_38 as origin };
         let impacts_38: string;
         export { impacts_38 as impacts };
     }
-    export { CO_1 as CO };
-    export namespace CU {
+    export namespace CO_1 {
         let id_39: string;
         export { id_39 as id };
         let label_39: string;
@@ -714,7 +713,8 @@ export namespace HEAVY_METALS {
         let impacts_39: string;
         export { impacts_39 as impacts };
     }
-    export namespace FE {
+    export { CO_1 as CO };
+    export namespace CU {
         let id_40: string;
         export { id_40 as id };
         let label_40: string;
@@ -732,7 +732,7 @@ export namespace HEAVY_METALS {
         let impacts_40: string;
         export { impacts_40 as impacts };
     }
-    export namespace PB {
+    export namespace FE {
         let id_41: string;
         export { id_41 as id };
         let label_41: string;
@@ -743,14 +743,14 @@ export namespace HEAVY_METALS {
         export { unit_41 as unit };
         let type_41: string;
         export { type_41 as type };
-        let rfc_41: number;
+        let rfc_41: any;
         export { rfc_41 as rfc };
         let origin_41: string;
         export { origin_41 as origin };
         let impacts_41: string;
         export { impacts_41 as impacts };
     }
-    export namespace MN {
+    export namespace PB {
         let id_42: string;
         export { id_42 as id };
         let label_42: string;
@@ -768,7 +768,7 @@ export namespace HEAVY_METALS {
         let impacts_42: string;
         export { impacts_42 as impacts };
     }
-    export namespace NI {
+    export namespace MN {
         let id_43: string;
         export { id_43 as id };
         let label_43: string;
@@ -779,14 +779,14 @@ export namespace HEAVY_METALS {
         export { unit_43 as unit };
         let type_43: string;
         export { type_43 as type };
-        let rfc_43: any;
+        let rfc_43: number;
         export { rfc_43 as rfc };
         let origin_43: string;
         export { origin_43 as origin };
         let impacts_43: string;
         export { impacts_43 as impacts };
     }
-    export namespace SE {
+    export namespace NI {
         let id_44: string;
         export { id_44 as id };
         let label_44: string;
@@ -804,7 +804,7 @@ export namespace HEAVY_METALS {
         let impacts_44: string;
         export { impacts_44 as impacts };
     }
-    export namespace ZN {
+    export namespace SE {
         let id_45: string;
         export { id_45 as id };
         let label_45: string;
@@ -822,5 +822,23 @@ export namespace HEAVY_METALS {
         let impacts_45: string;
         export { impacts_45 as impacts };
     }
+    export namespace ZN {
+        let id_46: string;
+        export { id_46 as id };
+        let label_46: string;
+        export { label_46 as label };
+        let name_46: string;
+        export { name_46 as name };
+        let unit_46: string;
+        export { unit_46 as unit };
+        let type_46: string;
+        export { type_46 as type };
+        let rfc_46: any;
+        export { rfc_46 as rfc };
+        let origin_46: string;
+        export { origin_46 as origin };
+        let impacts_46: string;
+        export { impacts_46 as impacts };
+    }
 }
 //# sourceMappingURL=pollutants.d.ts.map

package/dist/models/users.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../src/models/users.js"],"names":[],"mappings":"AA8FA,8BAwIE;AAiCF,wBAAmD;AA7PnD,iDAA4D;AAC5D,6CAAmD;AAUnD,4DA0BC"}
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../src/models/users.js"],"names":[],"mappings":"AA8FA,8BAuIE;AAiCF,wBAAmD;AA5PnD,iDAA4D;AAC5D,6CAAmD;AAUnD,4DA0BC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@justair/justair-library",
-  "version": "7.8.0-alpha.eb2cc63",
+  "version": "7.8.0",
   "description": "JustAir Internal Library",
   "main": "src/index.js",
   "type": "module",

package/src/constants/pollutants.js

@@ -1,5 +1,8 @@
-// Parameters measured by air quality sensors in real time.
+// Parameters measured by air quality sensors in real time, plus values derived from them.
 // These correspond to the values stored in Monitors.parameters and used across the platform.
+// Most entries are read off a sensor channel. HI and DP are always derived during normalization,
+// and DP_AMB is derived when the supplier does not report dew point. See "Ambient vs internal met
+// parameters" in CLAUDE.md.
 export const PARAMETERS = {
   CO: {
     id: "CO",
@@ -215,6 +218,7 @@ export const PARAMETERS = {
     origin: null,
     impacts: null,
   },
+  // ---- end of the T/RH/DP pairs. Everything below is unpaired. ----
   WD: {
     id: "WD",
     label: "Wind Direction",
@@ -245,6 +249,23 @@ export const PARAMETERS = {
     origin: null,
     impacts: null,
   },
+  // Derived, not measured. Processing-Engine computes HI from the T_AMB/RH_AMB pair on each
+  // reading (JA-3120, NOAA/Rothfusz); no supplier reports it, so nothing should ever map a raw
+  // channel onto this id. Deliberately sits BELOW the T/RH/DP block rather than next to T_AMB:
+  // a bare id under that block's header reads as "enclosure-internal", and wiring HI to the
+  // internal T/RH pair is the one mistake that must not happen. It takes no _AMB suffix because
+  // there is no internal counterpart to tell it apart from — an enclosure Heat Index would
+  // describe the inside of a plastic box.
+  HI: {
+    id: "HI",
+    label: "Heat Index",
+    name: "Heat Index (HI)",
+    unit: "°F",
+    type: "Weather",
+    rfc: null,
+    origin: null,
+    impacts: null,
+  },
   R: {
     id: "R",
     label: "Rain",

package/src/constants/tests/pollutants.test.js

@@ -83,6 +83,24 @@ describe("PARAMETERS", () => {
     expect(PARAMETERS[key].unit).toBe(bare.unit);
     expect(PARAMETERS[key].type).toBe(bare.type);
   });
+
+  // JA-3119: Heat Index is derived from the ambient pair, so it has to share their unit and
+  // sit outside the _AMB set — a "HI_AMB" would imply an internal Heat Index exists.
+  describe("HI (Heat Index)", () => {
+    test("is declared as a Weather parameter in °F", () => {
+      expect(PARAMETERS.HI).toBeDefined();
+      expect(PARAMETERS.HI.unit).toBe("°F");
+      expect(PARAMETERS.HI.type).toBe("Weather");
+    });
+
+    test("shares T_AMB's unit, since it is an apparent temperature", () => {
+      expect(PARAMETERS.HI.unit).toBe(PARAMETERS.T_AMB.unit);
+    });
+
+    test("has no _AMB counterpart", () => {
+      expect(PARAMETERS.HI_AMB).toBeUndefined();
+    });
+  });
 });
 
 describe("HEAVY_METALS", () => {

package/src/models/users.js

@@ -147,7 +147,6 @@ const usersSchema = mongoose.Schema(
     optInEmail: { type: Boolean, default: false },
     isActive: { type: Boolean, default: true },
     hasOnboarded: { type: Boolean, default: false },
-    hasSeenV2WhatsNew: { type: Boolean, default: false },
     isSharingLocation: { type: Boolean, default: false },
     toolTips: Object,
     alertPreferenceLevel: {