@sedni/cloud_common 1.0.4 → 1.0.6

package/app/models/ChannelDataBucket.js

@@ -3,6 +3,19 @@ const mongooseAutopopulate = require("mongoose-autopopulate");
 const mongoosePaginate = require("mongoose-paginate-v2");
 const mongooseAggregatePaginate = require("mongoose-aggregate-paginate-v2");
 
+const dataPointSchema = new mongoose.Schema({
+    timestamp: {
+        type: Number,
+        required: true,
+    },
+    value: {
+        type: Number,
+        required: true,
+    }
+}, {
+    _id: false,
+});
+
 const channeldataBucketSchema = new mongoose.Schema({
     start_date: {
         type: Date,
@@ -17,16 +30,11 @@ const channeldataBucketSchema = new mongoose.Schema({
             return new Date(Date.now() + 1000 * 60 * 60); // 1 hour from now
         }
     },
-    data : [{
-        timestamp: {
-            type: Number,
-            required: true,
-        },
-        value: {
-            type: Number,
-            required: true,
-        }
-    }],
+    data : {
+        type: [dataPointSchema],
+        required: true,
+        default: [],
+    },
     size : {
         type: Number,
         required: true,
@@ -99,6 +107,23 @@ channeldataBucketSchema.methods.insertDataPoint = async function(timestamp, valu
     await this.save();
 };
 
+/**
+ * Remove data points outside the specified date range within the bucket.
+ * 
+ * IT WILL NOT SAVE THE BUCKET, YOU NEED TO CALL save() AFTER THIS FUNCTION TO SAVE THE BUCKET
+ * @param {Number | Date} start_date The start date of the date range
+ * @param {Number | Date} end_date The end date of the date range
+*/
+channeldataBucketSchema.methods.removeDataPointsOutsideDateRange = function(start_date, end_date)
+{
+    start_date = start_date instanceof Date ? start_date.getTime() : start_date;
+    end_date = end_date instanceof Date ? end_date.getTime() : end_date;
+    
+    this.data = this.data.filter(data_point => data_point.timestamp >= start_date && data_point.timestamp < end_date);
+    this.size = this.data.length;
+    this.sum = this.data.reduce((sum, data_point) => sum + data_point.value, 0);
+};
+
 /**
  * Check if the bucket is closed, meaning that it is no longer accepting data points.
  * @param {Number} timestamp The timestamp to check if the bucket is closed
@@ -127,7 +152,7 @@ channeldataBucketSchema.statics.insertDataPoint = async function(timestamp, valu
     date.setMilliseconds(0);
 
     // Upsert the data point
-    const bucket = await this.updateOne(
+    const bucket = await this.findOneAndUpdate(
         { 
             start_date: date 
         }, 
@@ -153,7 +178,8 @@ channeldataBucketSchema.statics.insertDataPoint = async function(timestamp, valu
             } 
         }, 
         { 
-            upsert: true 
+            upsert: true,
+            new: true
         }
     );
 
@@ -222,7 +248,27 @@ channeldataBucketSchema.statics.getData = async function(start_date, end_date, p
         }
     });
 
-    return plain ? data.flatMap(bucket => bucket.data) : data;
+    if(!data || data.length === 0)
+    {
+        return [];
+    }
+
+    // Remove the data inside the bucket that is not in the specified date range
+    data[0].removeDataPointsOutsideDateRange(start_date, end_date);
+
+    if(data.length > 1)
+    {
+        data[1].removeDataPointsOutsideDateRange(start_date, end_date);
+    }
+
+    return plain ? data.flatMap(bucket => {
+        return bucket.data.map(data_point => {
+            return {
+                timestamp: data_point.timestamp,
+                value: data_point.value
+            };
+        });
+    }) : data;
 };
 
 

package/app/models/History.js

@@ -42,6 +42,10 @@ const historySchema = new mongoose.Schema({
         type: String,
         required: false,
     },
+    alarm_data: {
+        type: Object,
+        required: false,
+    },
 }, {
     timestamps: {
         createdAt: false,
@@ -55,13 +59,13 @@ const historySchema = new mongoose.Schema({
             ret.id = ret._id;
             delete ret._id;
             delete ret.__v;
-            ret.alarm_timestamp = ret.alarm_timestamp.getTime();
+            ret.alarm_timestamp = new Date(ret.alarm_timestamp).getTime();
             ret.alarm = {
-                priority: ret.alarm_priority,
-                state: ret.alarm_original_state ?? "Inactive",
-                type: ret.alarm_type,
-                value: ret.alarm_value === null ? "inf" : `${ret.alarm_value}`,
-                timestamp: new Date(ret.alarm_timestamp).getTime()
+                alarm_priority: ret.alarm_priority,
+                alarm_state: ret.alarm_original_state ?? "Inactive",
+                alarm_type: ret.alarm_type,
+                alarm_value: ret.alarm_value === null ? "inf" : `${ret.alarm_value}`,
+                alarm_timestamp: new Date(ret.alarm_timestamp).getTime()
             };
         },
     },

package/app/models/Unit.js

@@ -2,6 +2,7 @@ const mongoose = require("mongoose");
 const mongooseAutopopulate = require("mongoose-autopopulate");
 const mongoosePaginate = require("mongoose-paginate-v2");
 const mongooseAggregatePaginate = require("mongoose-aggregate-paginate-v2");
+const { UnitTypes } = require("../types/unit.types");
 
 const unitSchema = new mongoose.Schema({
     unit_id: {
@@ -16,6 +17,7 @@ const unitSchema = new mongoose.Schema({
     unit_type: {
         type: String,
         required: true,
+        enum : Object.values(UnitTypes),
     },
     unit_internal_description: {
         type: String,
@@ -23,7 +25,7 @@ const unitSchema = new mongoose.Schema({
     },
     unit_cabinet_id: {
         type: String,
-        required: true,
+        required: false,
     },
 }, {
     timestamps: true,

package/app/types/channel.types.js

@@ -0,0 +1,43 @@
+const ChannelBaseTypes =
+{
+    VIRTUAL_ANALOG : "VirtualAnalog",
+    VIRTUAL_DIGITAL : "VirtualDigital",
+    VIRTUAL_STRING : "VirtualString",
+    WIRED_ANALOG : "WiredAnalog",
+    WIRED_DIGITAL : "WiredDigital",
+};
+
+const ChannelSpecificTypes =
+{
+    // Wired types
+    DIGITAL_INPUT : "DigitalInput",
+    DIGITAL_OUTPUT : "DigitalOutput",
+    ANALOG_INPUT : "AnalogInput",
+    ANALOG_OUTPUT : "AnalogOutput",
+
+    // Virtual types
+    ANALOG_SOFTWARE : "AnalogSoftware",
+    DIGITAL_SOFTWARE : "DigitalSoftware",
+    VIRTUAL_STRING : "VirtualString",
+    COMMAND : "Command",
+
+    // Virtual logic types
+    BROADCAST_COMMAND : "BroadcastCommand",
+
+    // To be deleted in the near future
+    SOFTWARE: "Software",
+
+    ANALOG_TIMER : "AnalogTimer",
+
+    // Serial types
+    SERIAL_DIGITAL_INPUT : "SerialDigitalInput",
+    SERIAL_DIGITAL_OUTPUT : "SerialDigitalOutput",
+    SERIAL_LINE_COMMAND : "SerialLineCommand",
+    SERIAL_ANALOG_INPUT : "SerialAnalogInput",
+    SERIAL_ANALOG_OUTPUT : "SerialAnalogOutput",
+};
+
+module.exports = {
+    ChannelBaseTypes,
+    ChannelSpecificTypes,
+};

package/app/types/event.types.js

@@ -1,12 +1,13 @@
 const EventCategories = 
 {
-    ACCESS_CONTROL:     "ACCESS_CONTROL",
-    REQUEST_FAILURE:    "REQUEST_FAILURE",
-    OS:                 "OS",
-    CONTROL:            "CONTROL",
-    BACKUP:             "BACKUP",
-    CONFIG_CHANGE:      "CONFIG_CHANGE",
-    LOGS:               "LOGS"
+    ACCESS_CONTROL:     "AccessControl",
+    REQUEST_ERROR:      "RequestErrors",
+    OS:                 "OperatingSystemEvents",
+    CONTROL:            "ControlSystemEvents",
+    BACKUP:             "BackupAndRestoreEvents",
+    CONFIG_CHANGE:      "ConfigurationChanges",
+    LOGS:               "AuditLogEvents",
+    POTENTIAL_ATTACK:   "PotentialAttackActivity",
 };
 
 module.exports = {

package/app/types/unit.types.js

@@ -0,0 +1,15 @@
+const UnitTypes = 
+{
+    AIM18   : "Aim18",
+    DIM36   : "Dim36",
+    DIOM24  : "Diom24",
+    KLIM    : "Klim",
+    LUM     : "Lum",
+    PMM     : "Pmm",
+    SLIM    : "Slim",
+    TIM28   : "Tim28",
+};
+
+module.exports = {
+    UnitTypes
+};

package/index.js

@@ -38,6 +38,7 @@ const Types = {
  * EXTERNAL
  */
 const mongoose = require("mongoose");
+const mongooseAutopopulate = require("mongoose-autopopulate");
 const mongoosePaginate = require("mongoose-paginate-v2");
 const mongooseAggregatePaginate = require("mongoose-aggregate-paginate-v2");
 
@@ -48,4 +49,5 @@ module.exports = {
     mongoose,
     mongoosePaginate,
     mongooseAggregatePaginate,
+    mongooseAutopopulate,
 };

package/package.json

@@ -1,13 +1,14 @@
 {
     "name": "@sedni/cloud_common",
-    "version": "1.0.4",
+    "version": "1.0.6",
     "description": "Common package for all types, resources and tools of Diamar Cloud",
     "main": "index.js",
     "scripts": {
-        "test": "mocha",
+        "test": "cross-env NODE_ENV=internal_test mocha --recursive --exit app/test/*",
         "coverage": "nyc --include 'app/**/*controller.js' mocha",
         "lint": "eslint app/*",
-        "lint:fix": "eslint --fix app/*"
+        "lint:fix": "eslint --fix app/*",
+        "playground": "node playground.js"
     },
     "author": "Jose Luis Silvestre García",
     "license": "ISC",
@@ -19,12 +20,14 @@
     },
     "devDependencies": {
         "@eslint/js": "^9.12.0",
-        "chai": "^5.1.1",
+        "chai": "^4.0.0",
         "eslint": "^9.12.0",
         "eslint-plugin-n": "^17.11.0",
         "globals": "^15.11.0",
         "mocha": "^10.7.3",
         "nyc": "^17.0.0",
+        "proxyquire": "^2.1.3",
+        "sinon": "^19.0.2",
         "supertest": "^7.0.0"
     }
 }

package/eslint.config.js

@@ -1,38 +0,0 @@
-const globals = require("globals");
-const pluginJs = require("@eslint/js");
-const nodePlugin = require("eslint-plugin-n");
-
-module.exports = [
-    pluginJs.configs.recommended,
-    nodePlugin.configs["flat/recommended-script"],
-    {
-        files: ["app/**/*.js", "index.js"],
-        languageOptions: {
-            "ecmaVersion": "latest",
-            "sourceType": "commonjs",
-            "globals": globals.node,
-        },
-        rules: {
-            "prefer-const": ["error"],
-            "no-var": ["error"],
-            "semi": ["error", "always"],
-            "indent": ["error", 4],
-            "quotes": ["error", "double"],
-            "no-unused-vars": [
-                "error",
-                {
-                    "varsIgnorePattern": "should|expect|supertest|assert",
-                },
-            ],
-            "curly": ["error", "all"],
-            "brace-style": ["error", "allman"],
-            "n/no-missing-require" : "off",
-            "n/no-unpublished-require": [
-                "error",
-                {
-                    "allowModules": ["swagger-ui-express"],
-                },
-            ],
-        }
-    },
-];