@justair/justair-library 4.0.0-alpha → 4.1.0-alpha

package/package.json

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

package/src/models/measurements.js

@@ -1,5 +1,13 @@
 import mongoose from "mongoose";
 
+const correctionSnapshotSchema = new mongoose.Schema(
+  {
+    equationType: String,
+    dateCreated: Date,
+  },
+  { _id: false } // Not generating separate _id for each correction
+);
+
 // Audit Schema
 const auditSchema = mongoose.Schema(
   {
@@ -10,6 +18,13 @@ const auditSchema = mongoose.Schema(
     measurements: Object,
     monitorState: String,
     normalizedMeasurements: Object,
+    flags: Object,
+    appliedCorrections: {
+      type: Map,
+      of: correctionSnapshotSchema,
+      default: {},
+    },
+    correctedNormalizedMeasurements: Object,
   },
   {
     timestamps: true,
@@ -27,6 +42,13 @@ const measurementsSchema = mongoose.Schema(
     measurements: Object,
     monitorState: String,
     normalizedMeasurements: Object,
+    flags: Object,
+    appliedCorrections: {
+      type: Map,
+      of: correctionSnapshotSchema,
+      default: {},
+    },
+    correctedNormalizedMeasurements: Object,
   },
   {
     timestamps: true,
@@ -47,6 +69,11 @@ measurementsSchema.pre("findOneAndDelete", async function () {
       timeUpdated: docToDelete.timeUpdated,
       measurements: docToDelete.measurements,
       monitorState: docToDelete.monitorState,
+      normalizedMeasurements: docToDelete.normalizedMeasurements,
+      flags: docToDelete.flags,
+      appliedCorrections: docToDelete.appliedCorrections,
+      correctedNormalizedMeasurements:
+        docToDelete.correctedNormalizedMeasurements,
       deletedAt: new Date(),
     });
     await auditLog.save();
@@ -66,6 +93,10 @@ measurementsSchema.pre("deleteMany", async function () {
       timeUpdated: doc.timeUpdated,
       measurements: doc.measurements,
       monitorState: doc.monitorState,
+      normalizedMeasurements: doc.normalizedMeasurements,
+      flags: doc.flags,
+      appliedCorrections: doc.appliedCorrections,
+      correctedNormalizedMeasurements: doc.correctedNormalizedMeasurements,
       deletedAt: new Date(),
     }));
 
@@ -86,6 +117,11 @@ measurementsSchema.pre("deleteOne", async function () {
       timeUpdated: docToDelete.timeUpdated,
       measurements: docToDelete.measurements,
       monitorState: docToDelete.monitorState,
+      normalizedMeasurements: docToDelete.normalizedMeasurements,
+      flags: docToDelete.flags,
+      appliedCorrections: docToDelete.appliedCorrections,
+      correctedNormalizedMeasurements:
+        docToDelete.correctedNormalizedMeasurements,
       deletedAt: new Date(),
     });
     await auditLog.save();
@@ -103,6 +139,11 @@ measurementsSchema.pre("findOneAndUpdate", async function () {
       timeUpdated: docToUpdate.timeUpdated,
       measurements: docToUpdate.measurements,
       monitorState: docToUpdate.monitorState,
+      normalizedMeasurements: docToUpdate.normalizedMeasurements,
+      flags: docToUpdate.flags,
+      appliedCorrections: docToUpdate.appliedCorrections,
+      correctedNormalizedMeasurements:
+        docToUpdate.correctedNormalizedMeasurements,
       deletedAt: null, // No deletion happening, so set it to null or undefined
     });
     await auditLog.save();
@@ -120,6 +161,10 @@ measurementsSchema.pre("updateMany", async function () {
       timeUpdated: doc.timeUpdated,
       measurements: doc.measurements,
       monitorState: doc.monitorState,
+      normalizedMeasurements: doc.normalizedMeasurements,
+      flags: doc.flags,
+      appliedCorrections: doc.appliedCorrections,
+      correctedNormalizedMeasurements: doc.correctedNormalizedMeasurements,
       deletedAt: null, // No deletion happening
     }));
 

package/src/models/monitors.js

@@ -28,6 +28,17 @@ const monitorAuditSchema = mongoose.Schema(
       type: { type: String, enum: ["Point"], required: true },
       coordinates: { type: [Number], required: true },
     },
+    parameterThresholds: Object,
+    corrections: {
+      type: Map,
+      of: correctionSchema,
+      default: {},
+    },
+    correctionHistory: {
+      type: [correctionHistorySchema],
+      default: [],
+    },
+    applyCorrections: { type: Boolean, default: false },
   },
   {
     timestamps: true,
@@ -37,6 +48,46 @@ const monitorAuditSchema = mongoose.Schema(
 // Create the MonitorAudit model
 const MonitorAudit = mongoose.model("MonitorAudit", monitorAuditSchema);
 
+const correctionSchema = mongoose.Schema(
+  {
+    equationType: {
+      type: String,
+      required: true,
+    },
+    variables: {
+      required: true,
+      type: Object,
+    },
+    dateCreated: {
+      type: Date,
+      default: Date.now,
+    },
+  },
+  { _id: false } // no separate _id for sub-docs
+);
+
+const correctionHistorySchema = mongoose.Schema(
+  {
+    pollutant: {
+      type: String,
+      required: true,
+    },
+    oldValue: {
+      type: correctionSchema,
+      default: undefined,
+    },
+    newValue: {
+      type: correctionSchema,
+      default: undefined,
+    },
+    changedAt: {
+      type: Date,
+      default: Date.now,
+    },
+  },
+  { _id: false }
+);
+
 // Monitors Schema
 const monitorsSchema = mongoose.Schema(
   {
@@ -104,6 +155,17 @@ const monitorsSchema = mongoose.Schema(
     images: [String],
     isActive: { type: Boolean, default: true },
     parameterThresholds: Object,
+    // A Map, keyed by pollutant (e.g. "PM2_5"), storing Correction sub-docs
+    corrections: {
+      type: Map,
+      of: correctionSchema,
+      default: {},
+    },
+    correctionHistory: {
+      type: [correctionHistorySchema],
+      default: [],
+    },
+    applyCorrections: { type: Boolean, default: false },
   },
   {
     timestamps: true,
@@ -133,6 +195,10 @@ monitorsSchema.pre("findOneAndDelete", async function () {
           docToDelete.monitorLatitude,
         ],
       },
+      parameterThresholds: docToDelete.parameterThresholds,
+      corrections: docToDelete.corrections,
+      correctionHistory: docToDelete.correctionHistory,
+      applyCorrections: docToDelete.applyCorrections,
       deletedAt: new Date(),
     });
     await auditLog.save();
@@ -156,6 +222,10 @@ monitorsSchema.pre("deleteMany", async function () {
         type: "Point",
         coordinates: [doc.monitorLongitude, doc.monitorLatitude],
       },
+      parameterThresholds: doc.parameterThresholds,
+      corrections: doc.corrections,
+      correctionHistory: doc.correctionHistory,
+      applyCorrections: doc.applyCorrections,
       deletedAt: new Date(),
     }));
 
@@ -183,6 +253,10 @@ monitorsSchema.pre("deleteOne", async function () {
           docToDelete.monitorLatitude,
         ],
       },
+      parameterThresholds: docToDelete.parameterThresholds,
+      corrections: docToDelete.corrections,
+      correctionHistory: docToDelete.correctionHistory,
+      applyCorrections: docToDelete.applyCorrections,
       deletedAt: new Date(),
     });
     await auditLog.save();
@@ -204,6 +278,10 @@ monitorsSchema.pre("updateMany", async function () {
         type: "Point",
         coordinates: [doc.monitorLongitude, doc.monitorLatitude],
       },
+      parameterThresholds: doc.parameterThresholds,
+      corrections: doc.corrections,
+      correctionHistory: doc.correctionHistory,
+      applyCorrections: doc.applyCorrections,
       deletedAt: null, // Not a deletion, so this field is null
     }));
 

package/src/models/organizations.js

@@ -1,6 +1,26 @@
-import mongoose from "mongoose";
+import mongoose, { Schema } from "mongoose";
 
-const organizationsSchema = mongoose.Schema({
+const correctionSchema = new Schema(
+  {
+    correctionName: String,
+    equationType: {
+      type: String,
+      required: true,
+    },
+    variables: {
+      type: Object,
+      required: true,
+    },
+    dateCreated: {
+      type: Date,
+      default: Date.now,
+    },
+  },
+  { _id: false }
+);
+
+const organizationsSchema = mongoose.Schema(
+  {
     name: String,
     website: String,
     location: Object,
@@ -10,15 +30,17 @@ const organizationsSchema = mongoose.Schema({
     orgDescription: String,
     orgLogo: String,
     customAlertLevels: [Object],
-    connectedMonitors: [{ type: mongoose.Types.ObjectId, ref: 'Monitors' }],
+    connectedMonitors: [{ type: mongoose.Types.ObjectId, ref: "Monitors" }],
     communityMessages: [Object],
     weeklyReportData: [Object],
-    isActive: { type: Boolean, default: true }
-},
-    {
-        timestamps: true
-    });
+    isActive: { type: Boolean, default: true },
+    correctionRules: [correctionSchema],
+  },
+  {
+    timestamps: true,
+  }
+);
 
-const Organizations = mongoose.model('Organizations', organizationsSchema);
+const Organizations = mongoose.model("Organizations", organizationsSchema);
 
-export {organizationsSchema, Organizations};
+export { organizationsSchema, Organizations };