@justair/justair-library 4.4.2-alpha → 4.4.4

package/package.json

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

package/src/models/measurements.js

@@ -8,6 +8,40 @@ const correctionSnapshotSchema = new mongoose.Schema(
   { _id: false } // Not generating separate _id for each correction
 );
 
+// Annotation Schema
+const annotationSchema = new mongoose.Schema(
+  {
+    measurementIdentifier: {
+      type: String,
+      required: true,
+      trim: true,
+      // Examples: "PM2_5", "PM10", "NO2", "O3", etc.
+    },
+    comment: {
+      type: String,
+      required: true,
+      trim: true,
+    },
+    adminId: {
+      type: mongoose.Types.ObjectId,
+      ref: "Admin",
+      required: true,
+    },
+    timestamp: {
+      type: Date,
+      default: Date.now,
+      required: true,
+    },
+  },
+  {
+    _id: true,
+    timestamps: false,
+  }
+);
+
+// Add index for efficient querying
+annotationSchema.index({ measurementIdentifier: 1, timestamp: -1 });
+
 // Audit Schema
 const auditSchema = mongoose.Schema(
   {
@@ -17,6 +51,7 @@ const auditSchema = mongoose.Schema(
     deletedAt: { type: Date, default: Date.now },
     measurements: Object,
     monitorState: String,
+    monitorSupplier: String,
     normalizedMeasurements: Object,
     flags: Object,
     appliedCorrections: {
@@ -25,6 +60,7 @@ const auditSchema = mongoose.Schema(
       default: {},
     },
     correctedNormalizedMeasurements: Object,
+    annotations: [annotationSchema], // Include annotations in audit trail
   },
   {
     timestamps: true,
@@ -41,6 +77,7 @@ const measurementsSchema = mongoose.Schema(
     timeUpdated: Date,
     measurements: Object,
     monitorState: String,
+    monitorSupplier: String,
     normalizedMeasurements: Object,
     flags: Object,
     appliedCorrections: {
@@ -49,6 +86,10 @@ const measurementsSchema = mongoose.Schema(
       default: {},
     },
     correctedNormalizedMeasurements: Object,
+    annotations: {
+      type: [annotationSchema],
+      default: [],
+    },
   },
   {
     timestamps: true,
@@ -58,6 +99,12 @@ const measurementsSchema = mongoose.Schema(
 measurementsSchema.index({ monitorId: 1 });
 measurementsSchema.index({ timeUpdated: 1 });
 
+measurementsSchema.index({
+  "annotations.measurementIdentifier": 1,
+  "annotations.timestamp": -1,
+});
+measurementsSchema.index({ "annotations.userId": 1 });
+
 // Pre-hook to log single document deletions
 measurementsSchema.pre("findOneAndDelete", async function () {
   const docToDelete = await this.model.findOne(this.getFilter());
@@ -69,11 +116,13 @@ measurementsSchema.pre("findOneAndDelete", async function () {
       timeUpdated: docToDelete.timeUpdated,
       measurements: docToDelete.measurements,
       monitorState: docToDelete.monitorState,
+      monitorSupplier: docToDelete.monitorSupplier,
       normalizedMeasurements: docToDelete.normalizedMeasurements,
       flags: docToDelete.flags,
       appliedCorrections: docToDelete.appliedCorrections,
       correctedNormalizedMeasurements:
         docToDelete.correctedNormalizedMeasurements,
+      annotations: docToDelete.annotations, // Include annotations in audit
       deletedAt: new Date(),
     });
     await auditLog.save();
@@ -93,10 +142,12 @@ measurementsSchema.pre("deleteMany", async function () {
       timeUpdated: doc.timeUpdated,
       measurements: doc.measurements,
       monitorState: doc.monitorState,
+      monitorSupplier: doc.monitorSupplier,
       normalizedMeasurements: doc.normalizedMeasurements,
       flags: doc.flags,
       appliedCorrections: doc.appliedCorrections,
       correctedNormalizedMeasurements: doc.correctedNormalizedMeasurements,
+      annotations: doc.annotations, // Include annotations in audit
       deletedAt: new Date(),
     }));
 
@@ -117,11 +168,13 @@ measurementsSchema.pre("deleteOne", async function () {
       timeUpdated: docToDelete.timeUpdated,
       measurements: docToDelete.measurements,
       monitorState: docToDelete.monitorState,
+      monitorSupplier: docToDelete.monitorSupplier,
       normalizedMeasurements: docToDelete.normalizedMeasurements,
       flags: docToDelete.flags,
       appliedCorrections: docToDelete.appliedCorrections,
       correctedNormalizedMeasurements:
         docToDelete.correctedNormalizedMeasurements,
+      annotations: docToDelete.annotations, // Include annotations in audit
       deletedAt: new Date(),
     });
     await auditLog.save();
@@ -139,11 +192,13 @@ measurementsSchema.pre("findOneAndUpdate", async function () {
       timeUpdated: docToUpdate.timeUpdated,
       measurements: docToUpdate.measurements,
       monitorState: docToUpdate.monitorState,
+      monitorSupplier: docToUpdate.monitorSupplier,
       normalizedMeasurements: docToUpdate.normalizedMeasurements,
       flags: docToUpdate.flags,
       appliedCorrections: docToUpdate.appliedCorrections,
       correctedNormalizedMeasurements:
         docToUpdate.correctedNormalizedMeasurements,
+      annotations: docToUpdate.annotations, // Include annotations in audit
       deletedAt: null, // No deletion happening, so set it to null or undefined
     });
     await auditLog.save();
@@ -161,10 +216,12 @@ measurementsSchema.pre("updateMany", async function () {
       timeUpdated: doc.timeUpdated,
       measurements: doc.measurements,
       monitorState: doc.monitorState,
+      monitorSupplier: doc.monitorSupplier,
       normalizedMeasurements: doc.normalizedMeasurements,
       flags: doc.flags,
       appliedCorrections: doc.appliedCorrections,
       correctedNormalizedMeasurements: doc.correctedNormalizedMeasurements,
+      annotations: doc.annotations, // Include annotations in audit
       deletedAt: null, // No deletion happening
     }));
 
@@ -174,4 +231,10 @@ measurementsSchema.pre("updateMany", async function () {
 
 const Measurements = mongoose.model("Measurements", measurementsSchema);
 
-export { measurementsSchema, Measurements, Audit, auditSchema };
+export {
+  measurementsSchema,
+  Measurements,
+  Audit,
+  auditSchema,
+  annotationSchema,
+};