@sedni/cloud_common 1.0.8 → 1.2.0

package/app/models/Channel.js

@@ -7,13 +7,10 @@ const channelSchema = new mongoose.Schema({
     channel_tag: {
         type: String,
         required: true,
-        unique: true,
-        index: true,
     },
     channel_description: {
         type: String,
         required: true,
-        index: true,
     },
     channel_unit_id: {
         type: mongoose.Schema.Types.ObjectId,
@@ -54,14 +51,14 @@ const channelSchema = new mongoose.Schema({
  */
 
 /**
- * Index used primarily for filtering by unit_id 
+ * Index used primarily for filtering by channel_tag
  */
-channelSchema.index({ "unit_id" : 1 });
+channelSchema.index({ "channel_tag" : 1 }, { unique: true });
 
 /**
- * Index used primarily for filtering by unit_internal_description 
+ * Index used primarily for filtering by channel_description
  */
-channelSchema.index({ "unit_internal_description" : 1 });
+channelSchema.index({ "channel_description" : 1 });
 
 
 /**

package/app/models/ChannelDataBucket.js

@@ -75,7 +75,12 @@ const channeldataBucketSchema = new mongoose.Schema({
  * Index the start_date and end_date fields for faster queries.
  * The compound index will be used to query the buckets by date range.
  */
-channeldataBucketSchema.index({ start_date: 1, end_date: 1 });
+channeldataBucketSchema.index({ start_date: 1, end_date: 1 }, { background: true });
+
+/**
+ * Index used to delete old buckets automatically.
+ */
+channeldataBucketSchema.index({ start_date: 1 }, { expireAfterSeconds: 60 * 60 * 24 * 365, background: true }); // 1 year
 
 /**
  * ///////////////////////////////////////////////

package/app/models/Event.js

@@ -2,7 +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 { EventCategories } = require("../types/event.types");
+const { EventCategories, EventCriticality } = require("../types/event.types");
 
 const eventSchema = new mongoose.Schema({
     event_message: {
@@ -22,6 +22,11 @@ const eventSchema = new mongoose.Schema({
         required: true,
         enum: Object.values(EventCategories)
     },
+    event_criticality: {
+        type: String,
+        required: true,
+        enum: Object.values(EventCriticality)
+    },
     event_type: {
         type: String,
         required: true
@@ -29,7 +34,6 @@ const eventSchema = new mongoose.Schema({
     event_timestamp: {
         type: Date,
         default: Date.now,
-        expires: 60 * 60 * 24 * 7 * 365 // 1 year
     },
     event_data: {
         type: Object
@@ -40,10 +44,6 @@ const eventSchema = new mongoose.Schema({
         updatedAt: false
     },
     versionKey: false,
-    capped: {
-        size: 1000000,
-        max: 10000
-    },
     toJSON: {
         transform: function (doc, ret) 
         {
@@ -61,11 +61,6 @@ const eventSchema = new mongoose.Schema({
  * ///////////////////////////////////////////////
  */
 
-/**
- * Index used primarily for filtering by timestamp 
- */
-eventSchema.index({ "event_timestamp" : 1 });
-
 /**
  * Index used primarily for filtering by event_type 
  */
@@ -76,6 +71,18 @@ eventSchema.index({ "event_type" : 1 });
  */
 eventSchema.index({ "event_category" : 1 });
 
+/**
+ * Index used to delete old events automatically.
+ * This function will need to be called to create the TTL index.
+ * The index will expire documents after the specified time in seconds.
+ * The default is set to one year, but it can be changed by passing the expirationTimeInSeconds parameter.
+ */
+const oneYear = 60 * 60 * 24 * 365; // One year in seconds
+eventSchema.addTTLIndex = function(ttlField, expirationTimeInSeconds = oneYear)
+{
+    this.index({ [ttlField]: 1 }, { expireAfterSeconds: expirationTimeInSeconds });
+}
+
 /**
  * ///////////////////////////////////////////////
  * /////////////     PLUGINS     /////////////////

package/app/models/History.js

@@ -83,10 +83,16 @@ const historySchema = new mongoose.Schema({
 historySchema.index({ "channel_tag" : 1 });
 
 /**
- * Index used primarily for filtering by timestamp 
+ * Index used to delete old alarms automatically.
+ * This function will need to be called to create the TTL index.
+ * The index will expire documents after the specified time in seconds.
+ * The default is set to one year, but it can be changed by passing the expirationTimeInSeconds parameter.
  */
-historySchema.index({ "timestamp" : 1 });
-
+const oneYear = 60 * 60 * 24 * 365; // One year in seconds
+historySchema.addTTLIndex = function(ttlField, expirationTimeInSeconds = oneYear)
+{
+    this.index({ [ttlField]: 1 }, { expireAfterSeconds: expirationTimeInSeconds });
+}
 
 /**
  * ///////////////////////////////////////////////

package/app/models/Unit.js

@@ -8,7 +8,6 @@ const unitSchema = new mongoose.Schema({
     unit_id: {
         type: String,
         required: true,
-        unique: true,
     },
     unit_enabled: {
         type: Boolean,
@@ -47,9 +46,9 @@ const unitSchema = new mongoose.Schema({
  */
 
 /**
- * Index used primarily for filtering by unit_id 
+ * Index used primarily for filtering by unit_id and ensuring uniqueness
  */
-unitSchema.index({ "unit_id" : 1 });
+unitSchema.index({ "unit_id" : 1 }, { unique: true });
 
 /**
  * Index used primarily for filtering by unit_internal_description 

package/app/types/event.types.js

@@ -10,6 +10,15 @@ const EventCategories =
     POTENTIAL_ATTACK:   "PotentialAttackActivity",
 };
 
+const EventCriticality = {
+    VERBOSE:    "Verbose",
+    INFO:       "Info",
+    WARNING:    "Warning",
+    ERROR:      "Error",
+    CRITICAL:   "Critical",
+};
+
 module.exports = {
     EventCategories,
+    EventCriticality,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sedni/cloud_common",
-    "version": "1.0.8",
+    "version": "1.2.0",
     "description": "Common package for all types, resources and tools of Diamar Cloud",
     "main": "index.js",
     "scripts": {
@@ -13,21 +13,21 @@
     "author": "Jose Luis Silvestre García",
     "license": "ISC",
     "dependencies": {
-        "mongoose": "^8.7.1",
-        "mongoose-aggregate-paginate-v2": "^1.1.2",
+        "mongoose": "^8.17.0",
+        "mongoose-aggregate-paginate-v2": "^1.1.4",
         "mongoose-autopopulate": "^1.1.0",
-        "mongoose-paginate-v2": "^1.8.5"
+        "mongoose-paginate-v2": "^1.9.1"
     },
     "devDependencies": {
-        "@eslint/js": "^9.12.0",
-        "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",
+        "@eslint/js": "^9.32.0",
+        "chai": "^5.2.1",
+        "eslint": "^9.32.0",
+        "eslint-plugin-n": "^17.21.0",
+        "globals": "^16.3.0",
+        "mocha": "^11.7.1",
+        "nyc": "^17.1.0",
         "proxyquire": "^2.1.3",
-        "sinon": "^19.0.2",
-        "supertest": "^7.0.0"
+        "sinon": "^21.0.0",
+        "supertest": "^7.1.4"
     }
 }