@sedni/cloud_common 3.0.3 → 3.0.4

package/dist/models/docs/Event.json

@@ -0,0 +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": "%%EVENT_CATEGORY_ENUM%%"
+                    },
+                    "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/dist/models/docs/History.json

@@ -0,0 +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/dist/models/docs/Unit.json

@@ -0,0 +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/dist/models/docs/index.d.ts

@@ -0,0 +1,448 @@
+declare const Docs: {
+    ChannelDocs: {
+        components: {
+            schemas: {
+                Channel: {
+                    type: string;
+                    properties: {
+                        id: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                        channel_tag: {
+                            type: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                        channel_description: {
+                            type: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                        channel_unit_id: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                        channel_parsed: {
+                            type: string;
+                            description: string;
+                            readOnly: boolean;
+                        };
+                    };
+                    required: string[];
+                };
+            };
+            examples: {
+                Channel: {
+                    value: {
+                        id: string;
+                        channel_tag: string;
+                        channel_description: string;
+                        channel_type: string;
+                    };
+                };
+            };
+        };
+    };
+    ChannelDataBucketDocs: {
+        components: {
+            schemas: {
+                ChannelData: {
+                    type: string;
+                    description: string;
+                    properties: {
+                        id: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                        start_date: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                        end_date: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                        data: {
+                            type: string;
+                            description: string;
+                            items: {
+                                $ref: string;
+                            };
+                            readOnly: boolean;
+                        };
+                        size: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: number;
+                            readOnly: boolean;
+                        };
+                        synced: {
+                            type: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                        sum: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: number;
+                            readOnly: boolean;
+                        };
+                    };
+                };
+            };
+            examples: {
+                ChannelData: {
+                    id: string;
+                    start_date: string;
+                    end_date: string;
+                    data: {
+                        t: number;
+                        v: number;
+                    }[];
+                    size: number;
+                    synced: string;
+                    sum: number;
+                };
+            };
+        };
+    };
+    ChannelWithDataDocs: {
+        components: {
+            schemas: {
+                ChannelWithData: {
+                    allOf: ({
+                        $ref: string;
+                        type?: undefined;
+                        properties?: undefined;
+                    } | {
+                        type: string;
+                        properties: {
+                            channel_latest_value: {
+                                type: string;
+                                description: string;
+                                example: string;
+                                readOnly: boolean;
+                            };
+                            channel_latest_timestamp: {
+                                type: string;
+                                format: string;
+                                description: string;
+                                example: number;
+                                readOnly: boolean;
+                            };
+                            channel_alarm_state: {
+                                type: string;
+                                description: string;
+                                example: string;
+                                readOnly: boolean;
+                            };
+                        };
+                        $ref?: undefined;
+                    })[];
+                    required: string[];
+                };
+            };
+            examples: {
+                ChannelWithData: {
+                    value: {
+                        id: string;
+                        channel_tag: string;
+                        channel_description: string;
+                        channel_type: string;
+                        channel_latest_value: number;
+                        channel_latest_timestamp: number;
+                        channel_alarm_state: string;
+                    };
+                };
+            };
+        };
+    };
+    ChannelDataPointDocs: {
+        components: {
+            schemas: {
+                ChannelDataPoint: {
+                    type: string;
+                    description: string;
+                    properties: {
+                        c: {
+                            type: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                        t: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: number;
+                            readOnly: boolean;
+                        };
+                        v: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: number;
+                            readOnly: boolean;
+                        };
+                    };
+                };
+            };
+            examples: {
+                ChannelDataPoint: {
+                    c: string;
+                    t: number;
+                    v: number;
+                };
+            };
+        };
+    };
+    EventDocs: {
+        components: {
+            schemas: {
+                Event: {
+                    type: string;
+                    description: string;
+                    properties: {
+                        id: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                        event_message: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                        };
+                        event_source: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                        };
+                        event_category: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                            enum: string;
+                        };
+                        event_type: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                        };
+                        event_timestamp: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: number;
+                        };
+                        event_data: {
+                            type: string;
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                };
+            };
+            examples: {
+                Event: {
+                    value: {
+                        id: string;
+                        event_message: string;
+                        event_source: string;
+                        event_category: string;
+                        event_type: string;
+                        event_timestamp: number;
+                        event_data: {
+                            profile: string;
+                            duration: number;
+                            replaced_profile: string;
+                        };
+                    };
+                };
+            };
+        };
+    };
+    HistoryDocs: {
+        components: {
+            schemas: {
+                History: {
+                    type: string;
+                    properties: {
+                        id: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                        channel_tag: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                        alarm_timestamp: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                        alarm_priority: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                            enum: string;
+                            readOnly: boolean;
+                        };
+                        alarm_original_state: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                            enum: string;
+                            readOnly: boolean;
+                        };
+                        alarm_state: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                            enum: string;
+                            readOnly: boolean;
+                        };
+                        alarm_type: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                            enum: string;
+                            readOnly: boolean;
+                        };
+                        alarm_value: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: number;
+                            readOnly: boolean;
+                        };
+                        alarm_message: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                    };
+                    required: string[];
+                };
+            };
+            examples: {
+                History: {
+                    value: {
+                        id: string;
+                        channel_tag: string;
+                        alarm_timestamp: string;
+                        alarm_priority: string;
+                        alarm_original_state: string;
+                        alarm_state: string;
+                        alarm_type: string;
+                        alarm_value: number;
+                        alarm_message: string;
+                    };
+                };
+            };
+        };
+    };
+    UnitDocs: {
+        components: {
+            schemas: {
+                Unit: {
+                    type: string;
+                    properties: {
+                        id: {
+                            type: string;
+                            format: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                        unit_id: {
+                            type: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                        unit_internal_description: {
+                            type: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                        unit_enabled: {
+                            type: string;
+                            description: string;
+                            example: boolean;
+                            readOnly: boolean;
+                        };
+                        unit_type: {
+                            type: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                        unit_cabinet_id: {
+                            type: string;
+                            description: string;
+                            example: string;
+                            readOnly: boolean;
+                        };
+                    };
+                    required: string[];
+                };
+            };
+            examples: {
+                Unit: {
+                    value: {
+                        id: string;
+                        unit_id: string;
+                        unit_internal_description: string;
+                        unit_enabled: boolean;
+                        unit_type: string;
+                        unit_cabinet_id: string;
+                    };
+                };
+            };
+        };
+    };
+};
+export default Docs;