@sedni/cloud_common 1.0.0 → 1.0.2

package/app/models/Channel.js

@@ -1,4 +1,5 @@
 const mongoose = require("mongoose");
+const mongooseAutopopulate = require("mongoose-autopopulate");
 const mongoosePaginate = require("mongoose-paginate-v2");
 const mongooseAggregatePaginate = require("mongoose-aggregate-paginate-v2");
 
@@ -15,8 +16,10 @@ const channelSchema = new mongoose.Schema({
         index: true,
     },
     channel_unit_id: {
-        type: String,
+        type: mongoose.Schema.Types.ObjectId,
+        ref: "Unit",
         required: true,
+        autopopulate: true,
     },
     channel_parsed : {
         type: Object,
@@ -24,7 +27,7 @@ const channelSchema = new mongoose.Schema({
     },
     channel_last_bucket_sync: {
         type: Date,
-        required: true,
+        required: false,
     },
 }, {
     timestamps: {
@@ -36,6 +39,8 @@ const channelSchema = new mongoose.Schema({
         transform: function (doc, ret) 
         {
             ret.id = ret._id;
+            ret.channel_unit = ret.channel_unit_id;
+            ret.channel_unit_id = ret.channel_unit_id.unit_id;
             delete ret._id;
             delete ret.__v;
         },
@@ -66,5 +71,6 @@ channelSchema.index({ "unit_internal_description" : 1 });
  */
 channelSchema.plugin(mongoosePaginate);
 channelSchema.plugin(mongooseAggregatePaginate);
+channelSchema.plugin(mongooseAutopopulate);
 
 module.exports = channelSchema;

package/app/models/ChannelDataBucket.js

@@ -1,6 +1,7 @@
 const mongoose = require("mongoose");
-const mongoose_paginate = require("mongoose-paginate-v2");
-const mongoose_aggregate_paginate = require("mongoose-aggregate-paginate-v2");
+const mongooseAutopopulate = require("mongoose-autopopulate");
+const mongoosePaginate = require("mongoose-paginate-v2");
+const mongooseAggregatePaginate = require("mongoose-aggregate-paginate-v2");
 
 const channeldataBucketSchema = new mongoose.Schema({
     start_date: {
@@ -73,8 +74,9 @@ channeldataBucketSchema.index({ start_date: 1, end_date: 1 });
  * /////////////     PLUGINS     /////////////////
  * ///////////////////////////////////////////////
  */
-channeldataBucketSchema.plugin(mongoose_paginate);
-channeldataBucketSchema.plugin(mongoose_aggregate_paginate);
+channeldataBucketSchema.plugin(mongoosePaginate);
+channeldataBucketSchema.plugin(mongooseAggregatePaginate);
+channeldataBucketSchema.plugin(mongooseAutopopulate);
 
 
 /**
@@ -191,7 +193,7 @@ channeldataBucketSchema.statics.lastTimeSynced = async function(options)
 channeldataBucketSchema.statics.getNotUploadedData = async function(options)
 {
     // Get the last time the data was synced
-    let last_sync = options?.last_sync ?? await this.lastTimeSynced(options);
+    const last_sync = options?.last_sync ?? await this.lastTimeSynced(options);
 
     // Get all the buckets that synced is lt size and end_date is gt last_sync
     const buckets = await this.find({  

package/app/models/Event.js

@@ -1,7 +1,8 @@
 const mongoose = require("mongoose");
-const mongoose_paginate = require("mongoose-paginate-v2");
-const mongoose_aggregate_paginate = require("mongoose-aggregate-paginate-v2");
-const { EventCategories } = require("app/types/event.types");
+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 eventSchema = new mongoose.Schema({
     event_message: {
@@ -12,6 +13,10 @@ const eventSchema = new mongoose.Schema({
         type: String,
         required: true
     },
+    event_user: {
+        type: String,
+        required: false
+    },
     event_category: {
         type: String,
         required: true,
@@ -57,22 +62,27 @@ const eventSchema = new mongoose.Schema({
  */
 
 /**
- * Index used primarily for filtering by channel_tag 
+ * Index used primarily for filtering by timestamp 
  */
-historySchema.index({ "channel_tag" : 1 });
+eventSchema.index({ "event_timestamp" : 1 });
 
 /**
- * Index used primarily for filtering by timestamp 
+ * Index used primarily for filtering by event_type 
  */
-historySchema.index({ "timestamp" : 1 });
+eventSchema.index({ "event_type" : 1 });
 
+/**
+ * Index used primarily for filtering by event_category 
+ */
+eventSchema.index({ "event_category" : 1 });
 
 /**
  * ///////////////////////////////////////////////
  * /////////////     PLUGINS     /////////////////
  * ///////////////////////////////////////////////
  */
-historySchema.plugin(mongoose_paginate);
-historySchema.plugin(mongoose_aggregate_paginate);
+eventSchema.plugin(mongoosePaginate);
+eventSchema.plugin(mongooseAggregatePaginate);
+eventSchema.plugin(mongooseAutopopulate);
 
 module.exports = eventSchema;

package/app/models/History.js

@@ -1,24 +1,25 @@
 const mongoose = require("mongoose");
-const mongoose_paginate = require("mongoose-paginate-v2");
-const mongoose_aggregate_paginate = require("mongoose-aggregate-paginate-v2");
-const { AlarmTypes, AlarmPriorities, AlarmStates, DiamarAlarmStates } = require("@types/alarm.types");
+const mongooseAutopopulate = require("mongoose-autopopulate");
+const mongoosePaginate = require("mongoose-paginate-v2");
+const mongooseAggregatePaginate = require("mongoose-aggregate-paginate-v2");
+const { AlarmTypes, AlarmPriorities, CloudAlarmStates, DiamarAlarmStates } = require("../types/alarm.types");
 
 const historySchema = new mongoose.Schema({
-    timestamp: {
-        type: Date,
-        required: true,
-        default: Date.now,
-    },
     channel_tag: {
         type: String,
         required: true,
     },
+    alarm_timestamp: {
+        type: Date,
+        required: true,
+        default: Date.now,
+    },
     alarm_priority: {
         type: String,
         required: true,
         enum: Object.values(AlarmPriorities),
     },
-    original_alarm_state: {
+    alarm_original_state: {
         type: String,
         required: true,
         enum: Object.values(DiamarAlarmStates),
@@ -26,7 +27,7 @@ const historySchema = new mongoose.Schema({
     alarm_state: {
         type: String,
         required: true,
-        enum: Object.values(AlarmStates),
+        enum: Object.values(CloudAlarmStates),
     },
     alarm_type: {
         type: String,
@@ -41,9 +42,6 @@ const historySchema = new mongoose.Schema({
         type: String,
         required: false,
     },
-    metadata: {
-        type: Object,
-    }
 }, {
     timestamps: {
         createdAt: false,
@@ -57,17 +55,14 @@ const historySchema = new mongoose.Schema({
             ret.id = ret._id;
             delete ret._id;
             delete ret.__v;
+            ret.alarm_timestamp = ret.alarm_timestamp.getTime();
             ret.alarm = {
                 priority: ret.alarm_priority,
-                state: ret.original_alarm_state ?? "Inactive",
+                state: ret.alarm_original_state ?? "Inactive",
                 type: ret.alarm_type,
                 value: ret.alarm_value === null ? "inf" : `${ret.alarm_value}`,
-                timestamp: new Date(ret.timestamp).getTime()
+                timestamp: new Date(ret.alarm_timestamp).getTime()
             };
-            delete ret.alarm_priority;
-            delete ret.alarm_state;
-            delete ret.alarm_type;
-            delete ret.alarm_value;
         },
     },
 });
@@ -94,8 +89,8 @@ historySchema.index({ "timestamp" : 1 });
  * /////////////     PLUGINS     /////////////////
  * ///////////////////////////////////////////////
  */
-historySchema.plugin(mongoose_paginate);
-historySchema.plugin(mongoose_aggregate_paginate);
-
+historySchema.plugin(mongoosePaginate);
+historySchema.plugin(mongooseAggregatePaginate);
+historySchema.plugin(mongooseAutopopulate);
 
 module.exports = historySchema;

package/app/models/Unit.js

@@ -1,4 +1,5 @@
 const mongoose = require("mongoose");
+const mongooseAutopopulate = require("mongoose-autopopulate");
 const mongoosePaginate = require("mongoose-paginate-v2");
 const mongooseAggregatePaginate = require("mongoose-aggregate-paginate-v2");
 
@@ -61,5 +62,6 @@ unitSchema.index({ "unit_internal_description" : 1 });
  */
 unitSchema.plugin(mongoosePaginate);
 unitSchema.plugin(mongooseAggregatePaginate);
+unitSchema.plugin(mongooseAutopopulate);
 
 module.exports = unitSchema;

package/app/models/docs/Channel.json

@@ -1,3 +1,58 @@
 {
-    
+    "components": {
+        "schemas": {
+            "Channel": {
+                "type": "object",
+                "properties": {
+                    "id": {
+                        "type": "string",
+                        "format": "ObjectId",
+                        "description": "MongoDB ObjectId",
+                        "example": "507f1f77bcf86cd799439011",
+                        "readOnly": true
+                    },
+                    "channel_tag": {
+                        "type": "string",
+                        "description": "Channel tag",
+                        "example": "MOTOR_PS_TEMP",
+                        "readOnly": true
+                    },
+                    "channel_description": {
+                        "type": "string",
+                        "description": "Channel description",
+                        "example": "Motor Power Supply Temperature",
+                        "readOnly": true
+                    },
+                    "channel_unit_id" : {
+                        "type": "string",
+                        "format": "ObjectId",
+                        "description": "Unit of the channel",
+                        "example": "507f1f77bcf86cd799439011",
+                        "readOnly": true
+                    },
+                    "channel_parsed": {
+                        "type" : "object",
+                        "description": "Parsed channel data",
+                        "readOnly": true
+                    }
+                },
+                "required": [
+                    "channel_tag",
+                    "channel_description",
+                    "channel_unit_id",
+                    "channel_parsed"
+                ]
+            }
+        },
+        "examples": {
+            "Channel": {
+                "value": {
+                    "id": "507f1f77bcf86cd799439011",
+                    "channel_tag": "MOTOR_PS_TEMP",
+                    "channel_description": "Motor Power Supply Temperature",
+                    "channel_type": "Analogic"
+                }
+            }
+        }
+    }
 }

package/app/models/docs/ChannelDataBucket.json

@@ -1,3 +1,101 @@
 {
-    
+    "components": {
+        "schemas": {
+            "ChannelData": {
+                "type": "object",
+                "description": "ChannelData object. This is the bucket where the data is stored, in batches of 1 hour.",
+                "properties": {
+                    "id": {
+                        "type": "string",
+                        "format": "ObjectId",
+                        "description": "MongoDB ObjectId",
+                        "example": "507f1f77bcf86cd799439011",
+                        "readOnly": true
+                    },
+                    "start_date": {
+                        "type": "string",
+                        "format": "date-time",
+                        "description": "Start date of the data",
+                        "example": "2024-07-03T10:15:30Z",
+                        "readOnly": true
+                    },
+                    "end_date": {
+                        "type": "string",
+                        "format": "date-time",
+                        "description": "End date of the data",
+                        "example": "2024-07-03T11:15:30Z",
+                        "readOnly": true
+                    },
+                    "data": {
+                        "type": "array",
+                        "description": "Data array of DataPoint objects",
+                        "items": {
+                            "$ref": "#/components/schemas/DataPoint"
+                        },
+                        "readOnly": false
+                    },
+                    "size" : {
+                        "type" : "integer",
+                        "format" : "int64",
+                        "description" : "Size of the data array",
+                        "example" : 60,
+                        "readOnly": true
+                    },
+                    "synced" : {
+                        "type" : "TODO",
+                        "description" : "TODO",
+                        "example" : "TODO",
+                        "readOnly": true
+                    },
+                    "sum" : {
+                        "type" : "number",
+                        "format" : "double",
+                        "description" : "Sum of the data",
+                        "example" : 69.420,
+                        "readOnly": true
+                    }
+                }
+            },
+            "DataPoint" : {
+                "type": "object",
+                "description": "DataPoint object. This is the object that is sent to and from the API. It includes only the timestamp and the value. No id is included because the data is stored inside a larger bucket in the database.",
+                "properties": {
+                    "timestamp" : {
+                        "type" : "integer",
+                        "format" : "int64",
+                        "description" : "Timestamp of the data",
+                        "example" : 1710251647000,
+                        "readOnly": true
+                    },
+                    "value" : {
+                        "type" : "number",
+                        "format" : "double",
+                        "description" : "Value of the data",
+                        "example" : 69.420,
+                        "readOnly": true
+                    }
+                }
+            }
+        },
+        "examples" : {
+            "ChannelData": {
+                "id" : "507f1f77bcf86cd799439011",
+                "start_date" : "2024-07-03T10:15:30Z",
+                "end_date" : "2024-07-03T11:15:30Z",
+                "data" : [
+                    {
+                        "timestamp" : 1710251647000,
+                        "value" : 69.420
+                    }
+                ],
+                "size" : 60,
+                "synced" : "TODO",
+                "sum" : 69.420
+            },
+            "DataPoint" : {
+                "timestamp" : 1710251647000,
+                "value" : 69.420
+            }
+        }
+    }
 }

package/app/models/docs/ChannelWithData.json

@@ -0,0 +1,58 @@
+{
+    "components": {
+        "schemas": {
+            "ChannelWithData": {
+                "allOf": [
+                    {
+                        "$ref": "#/components/schemas/Channel"
+                    },
+                    {
+                        "type": "object",
+                        "properties": {
+                            "channel_latest_value": {
+                                "type": "string",
+                                "description": "Latest value of the channel",
+                                "example": "25.0",
+                                "readOnly": true
+                            },
+                            "channel_latest_timestamp": {
+                                "type": "string",
+                                "format": "date-time",
+                                "description": "Timestamp of the latest value",
+                                "example": 1700034034,
+                                "readOnly": true
+                            },
+                            "channel_alarm_state": {
+                                "type": "string",
+                                "description": "Alarm state of the channel",
+                                "example": "NoAlarm",
+                                "readOnly": true
+                            }
+                        }
+                    }
+                ],
+                "required": [
+                    "channel_tag",
+                    "channel_description",
+                    "channel_type",
+                    "channel_latest_value",
+                    "channel_latest_timestamp",
+                    "channel_alarm_state"
+                ]
+            }
+        },
+        "examples": {
+            "ChannelWithData": {
+                "value": {
+                    "id": "507f1f77bcf86cd799439011",
+                    "channel_tag": "MOTOR_PS_TEMP",
+                    "channel_description": "Motor Power Supply Temperature",
+                    "channel_type": "Analogic",
+                    "channel_latest_value": 420.69,
+                    "channel_latest_timestamp": 1700034034,
+                    "channel_alarm_state": "NoAlarm"
+                }
+            }
+        }
+    }
+}

package/app/models/docs/DataPoint.json

@@ -0,0 +1,32 @@
+{
+    "components": {
+        "schemas": {
+            "DataPoint" : {
+                "type": "object",
+                "description": "DataPoint object. This is the object that is sent to and from the API. It includes only the timestamp and the value. No id is included because the data is stored inside a larger bucket in the database.",
+                "properties": {
+                    "timestamp" : {
+                        "type" : "integer",
+                        "format" : "int64",
+                        "description" : "Timestamp of the data",
+                        "example" : 1710251647000,
+                        "readOnly": true
+                    },
+                    "value" : {
+                        "type" : "number",
+                        "format" : "double",
+                        "description" : "Value of the data",
+                        "example" : 69.420,
+                        "readOnly": true
+                    }
+                }
+            }
+        },
+        "examples" : {
+            "DataPoint" : {
+                "timestamp" : 1710251647000,
+                "value" : 69.420
+            }
+        }
+    }
+}

package/app/models/docs/Event.json

@@ -1,3 +1,78 @@
 {
-    
+    "components": {
+        "schemas": {
+            "Event": {
+                "type": "object",
+                "description": "Event object. This is the object that is sent to and from the API. It includes the id as a string, the timestamp as a number and the creation timestamp is not included.",
+                "properties": {
+                    "id": {
+                        "type": "string",
+                        "format": "ObjectId",
+                        "description": "MongoDB ObjectId",
+                        "example": "507f1f77bcf86cd799439011",
+                        "readOnly": true
+                    },
+                    "event_message": {
+                        "type": "string",
+                        "format": "text",
+                        "description": "Event message",
+                        "example": "Event message"
+                    },
+                    "event_source": {
+                        "type": "string",
+                        "format": "text",
+                        "description": "Hostname of the source of the event",
+                        "example": "RMS1"
+                    },
+                    "event_category": {
+                        "type": "string",
+                        "format": "text",
+                        "description": "Event category",
+                        "example": "Login",
+                        "enum": ["Login", "Backup", "Config", "Control"]
+                    },
+                    "event_type": {
+                        "type": "string",
+                        "format": "text",
+                        "description": "Event type",
+                        "example": "Login"
+                    },
+                    "event_timestamp": {
+                        "type": "number",
+                        "format": "timestamp",
+                        "description": "Event timestamp",
+                        "example": 1709899759
+                    },
+                    "event_data" : {
+                        "type": "object",
+                        "description": "Event data. Not validated, just stored"
+                    }
+                },
+                "required": [
+                    "event_message",
+                    "event_source",
+                    "event_category",
+                    "event_type",
+                    "event_timestamp"
+                ]
+            }
+        },
+        "examples" : {
+            "Event" : {
+                "value" : {
+                    "id": "507f1f77bcf86cd799439011",
+                    "event_message": "Profile Root logged in for the next 600 seconds, replacing profile Root.",
+                    "event_source": "RMS1",
+                    "event_category": "Login",
+                    "event_type": "LoiginSuccessful",
+                    "event_timestamp": 1709899759,
+                    "event_data" : {
+                        "profile": "Root",
+                        "duration": 600,
+                        "replaced_profile": "Monitor"
+                    }
+                }
+            }
+        }
+    }
 }

package/app/models/docs/History.json

@@ -1,3 +1,103 @@
 {
-    
+    "components": {
+        "schemas": {
+            "History": {
+                "type": "object",
+                "properties": {
+                    "id": {
+                        "type": "string",
+                        "format": "ObjectId",
+                        "description": "MongoDB ObjectId",
+                        "example": "507f1f77bcf86cd799439011",
+                        "readOnly": true
+                    },
+                    "channel_tag": {
+                        "type": "string",
+                        "format": "text",
+                        "description": "Channel tag",
+                        "example": "Channel tag",
+                        "readOnly": true
+                    },
+                    "alarm_timestamp": {
+                        "type": "string",
+                        "format": "date-time",
+                        "description": "Alarm timestamp",
+                        "example": "2020-12-31T23:59:59Z",
+                        "readOnly": true
+                    },
+                    "alarm_priority": {
+                        "type": "string",
+                        "format": "text",
+                        "description": "Alarm priority",
+                        "example": "Alarm",
+                        "enum": "%%ALARM_PRIORITY_ENUM%%",
+                        "readOnly": true
+                    },
+                    "alarm_original_state" : {
+                        "type": "string",
+                        "format": "text",
+                        "description": "Alarm original state",
+                        "example": "Inactive",
+                        "enum": "%%DIAMAR_ALARM_STATE_ENUM%%",
+                        "readOnly": true
+                    },
+                    "alarm_state" : {
+                        "type": "string",
+                        "format": "text",
+                        "description": "Alarm new state",
+                        "example": "Inactive",
+                        "enum": "%%CLOUD_ALARM_STATE_ENUM%%",
+                        "readOnly": true
+                    },
+                    "alarm_type": {
+                        "type": "string",
+                        "format": "text",
+                        "description": "Alarm type",
+                        "example" : "AlarmOpen",
+                        "enum": "%%ALARM_TYPE_ENUM%%",
+                        "readOnly": true
+                    },
+                    "alarm_value": {
+                        "type": "number",
+                        "format": "double",
+                        "description": "Alarm value",
+                        "example": 0.0,
+                        "readOnly": true
+                    },
+                    "alarm_message": {
+                        "type": "string",
+                        "format": "text",
+                        "description": "Alarm message",
+                        "example": "Alarm message",
+                        "readOnly": true
+                    }
+                },
+                "required": [
+                    "channel_tag",
+                    "alarm_timestamp",
+                    "alarm_priority",
+                    "alarm_original_state",
+                    "alarm_state",
+                    "alarm_type",
+                    "alarm_value",
+                    "alarm_message"
+                ]
+            }
+        },
+        "examples" : {
+            "History": {
+                "value": {
+                    "id": "507f1f77bcf86cd799439011",
+                    "channel_tag": "Channel tag",
+                    "alarm_timestamp": "2020-12-31T23:59:59Z",
+                    "alarm_priority": "Alarm",
+                    "alarm_original_state": "Inactive",
+                    "alarm_state": "Inactive",
+                    "alarm_type": "AlarmOpen",
+                    "alarm_value": 0.0,
+                    "alarm_message": "AlarmOpen Value: [OP]"
+                }
+            }
+        }
+    }
 }

package/app/models/docs/Unit.json

@@ -1,3 +1,67 @@
 {
-    
+    "components": {
+        "schemas": {
+            "Unit": {
+                "type": "object",
+                "properties": {
+                    "id": {
+                        "type": "string",
+                        "format": "ObjectId",
+                        "description": "MongoDB ObjectId",
+                        "example": "507f1f77bcf86cd799439011",
+                        "readOnly": true
+                    },
+                    "unit_id": {
+                        "type": "string",
+                        "description": "Unit identifier in Diamar",
+                        "example": "127",
+                        "readOnly": true
+                    },
+                    "unit_internal_description": {
+                        "type": "string",
+                        "description": "Unit description",
+                        "example": "Motor Power Supply",
+                        "readOnly": true
+                    },
+                    "unit_enabled" : {
+                        "type": "boolean",
+                        "description": "Unit enabled",
+                        "example": true,
+                        "readOnly": true
+                    },
+                    "unit_type" : {
+                        "type": "string",
+                        "description": "Unit type",
+                        "example": "DIM36",
+                        "readOnly": true
+                    },
+                    "unit_cabinet_id" : {
+                        "type": "string",
+                        "description": "Cabinet identifier",
+                        "example": "Cabinet 1",
+                        "readOnly": true
+                    }
+                },
+                "required": [
+                    "unit_id",
+                    "unit_internal_description",
+                    "unit_enabled",
+                    "unit_type",
+                    "unit_cabinet_id"
+                ]
+            }
+        },
+        "examples": {
+            "Unit": {
+                "value": {
+                    "id": "507f1f77bcf86cd799439011",
+                    "unit_id": "127",
+                    "unit_internal_description": "Motor Power Supply",
+                    "unit_enabled": true,
+                    "unit_type": "DIM36",
+                    "unit_cabinet_id": "Cabinet 1"
+                }
+            }
+        }
+    }
 }

package/app/types/alarm.types.js

@@ -3,7 +3,7 @@ const AlarmPriorities =
     CRITICAL:   "Critical",
     ALARM:      "Alarm",
     WARNING:    "Warning",
-}
+};
 
 const DiamarAlarmStates =
 {
@@ -23,6 +23,7 @@ const CloudAlarmStates =
     WARNING_ACK:    "WarningAcknowledged",
     RETURN_NO_ACK:  "Unacknowledged",
     INHIBITED:      "Inhibited",
+    UNDEFINED:      "Undefined",
 };
 
 const AlarmTypes =
@@ -40,7 +41,7 @@ const AlarmTypes =
     ALARM_FAIL:     "AlarmFail",
     ALARM_INH:      "AlarmInh",
     ALARM_UNK:      "AlarmUnk",
-}
+};
 
 module.exports =
 {

package/eslint.config.js

@@ -0,0 +1,38 @@
+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"],
+                },
+            ],
+        }
+    },
+];

package/index.js

@@ -1,11 +1,11 @@
 /**
  * SCHEMAS
  */
-const Channel = require("app/models/channel");
-const ChannelDataBucket = require("app/models/channelDataBucket");
-const Event = require("app/models/event");
-const History = require("app/models/history");
-const Unit = require("app/models/unit");
+const Channel = require("./app/models/Channel");
+const ChannelDataBucket = require("./app/models/ChannelDataBucket.js");
+const Event = require("./app/models/Event.js");
+const History = require("./app/models/History.js");
+const Unit = require("./app/models/Unit.js");
 
 const Schemas = {
     Channel,
@@ -18,11 +18,11 @@ const Schemas = {
 /**
  * DOCS
  */
-const ChannelDocs = require("app/models/docs/channel.docs");
-const ChannelDataBucketDocs = require("app/models/docs/channelDataBucket.docs");
-const EventDocs = require("app/models/docs/event.docs");
-const HistoryDocs = require("app/models/docs/history.docs");
-const UnitDocs = require("app/models/docs/unit.docs");
+const ChannelDocs = require("./app/models/docs/Channel.json");
+const ChannelDataBucketDocs = require("./app/models/docs/ChannelDataBucket.json");
+const EventDocs = require("./app/models/docs/Event.json");
+const HistoryDocs = require("./app/models/docs/History.json");
+const UnitDocs = require("./app/models/docs/Unit.json");
 
 const Docs = {
     ChannelDocs,
@@ -35,19 +35,29 @@ const Docs = {
 /**
  * TYPES
  */
-const { AlarmTypes, AlarmPriorities, AlarmStates, DiamarAlarmStates } = require("app/types/alarm.types");
-const { EventCategories } = require("app/types/event.types");
+const { AlarmTypes, AlarmPriorities, CloudAlarmStates, DiamarAlarmStates } = require("./app/types/alarm.types");
+const { EventCategories } = require("./app/types/event.types");
 
 const Types = {
     AlarmTypes,
     AlarmPriorities,
-    AlarmStates,
+    CloudAlarmStates,
     DiamarAlarmStates,
     EventCategories,
 };
 
+/**
+ * EXTERNAL
+ */
+const mongoose = require("mongoose");
+const mongoosePaginate = require("mongoose-paginate-v2");
+const mongooseAggregatePaginate = require("mongoose-aggregate-paginate-v2");
+
 module.exports = {
     Schemas,
     Docs,
     Types,
+    mongoose,
+    mongoosePaginate,
+    mongooseAggregatePaginate,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sedni/cloud_common",
-    "version": "1.0.0",
+    "version": "1.0.2",
     "description": "Common package for all types, resources and tools of Diamar Cloud",
     "main": "index.js",
     "scripts": {
@@ -14,12 +14,15 @@
     "dependencies": {
         "mongoose": "^8.7.1",
         "mongoose-aggregate-paginate-v2": "^1.1.2",
+        "mongoose-autopopulate": "^1.1.0",
         "mongoose-paginate-v2": "^1.8.5"
     },
     "devDependencies": {
+        "@eslint/js": "^9.12.0",
         "chai": "^5.1.1",
-        "eslint": "^8.57.0",
-        "eslint-plugin-node": "^11.1.0",
+        "eslint": "^9.12.0",
+        "eslint-plugin-n": "^17.11.0",
+        "globals": "^15.11.0",
         "mocha": "^10.7.3",
         "nyc": "^17.0.0",
         "supertest": "^7.0.0"

package/.eslintrc.js

@@ -1,32 +0,0 @@
-module.exports = {
-    env: {
-        node: true,
-        commonjs: true,
-        es2021: true,
-        mocha: true,
-    },
-    extends: [ "eslint:recommended", "plugin:node/recommended" ],
-    parserOptions: {
-        ecmaVersion: "latest",
-    },
-    rules: {
-        indent: [ "error", 4, { SwitchCase: 1 } ],
-        quotes: [ "error", "double" ],
-        semi: [ "error", "always" ],
-        "no-unused-vars": [
-            "error",
-            {
-                varsIgnorePattern: "should|expect|supertest|assert",
-            },
-        ],
-        curly: [ "error", "all" ],
-        "brace-style": [ "error", "allman" ],
-        "node/no-unpublished-require": [
-            "error",
-            {
-                allowModules: [ "swagger-ui-express" ],
-            },
-        ],
-        "node/no-missing-require": "off",
-    },
-};