@itentialopensource/adapter-robustel 0.4.6 → 0.5.0

package/propertiesSchema.json

@@ -779,6 +779,14 @@
             "security/ca.pem"
           ]
         },
+        "ca_file_content": {
+          "type": "string",
+          "description": "The content of the CA file used for SSL",
+          "default": "",
+          "examples": [
+            "-----BEGIN CERTIFICATE-----"
+          ]
+        },
         "key_file": {
           "type": "string",
           "description": "The fully qualified path name to the key file used for SSL",
@@ -868,32 +876,48 @@
     "mongo": {
       "type": "object",
       "properties": {
+        "url": {
+          "type": "string",
+          "description": "Mongo's complete connection URL. This property overrides host, port, database, username, password and replSet settings.",
+          "examples": [
+            "mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]",
+            "mongodb+srv://[username:password@]cluster0.xxxxx.mongodb.net/[defaultauthdb][?options]",
+            "mongodb+srv://cluster0.xxxxx.mongodb.net/[defaultauthdb][?options]"
+          ]
+        },
         "host": {
           "type": "string",
-          "description": "host where mongo database can be found",
+          "description": "Host information for the Mongo server",
           "default": "",
           "examples": [
-            "localhost"
+            "localhost",
+            "cluster0.xxxxx.mongodb.net",
+            "my-cluster.example.com"
           ]
         },
         "port": {
           "type": "integer",
-          "description": "port on which to connect to the mongo database",
+          "description": "Port information for the Mongo server. Not used when using mongodb+srv:// protocol",
           "default": 443,
           "minimum": 0,
           "maximum": 65535
         },
         "database": {
           "type": "string",
-          "description": "The name of the database to store adapter information in",
+          "description": "The database for the adapter to use for its data.",
           "default": "",
           "examples": [
             "adapter-xyz"
           ]
         },
+        "dbAuth": {
+          "type": "boolean",
+          "description": "Whether to use authentication for MongoDB connection. Default is false.",
+          "default": false
+        },
         "username": {
           "type": "string",
-          "description": "The user to connect to the database with",
+          "description": "If credentials are required to access Mongo, this is the user to login as.",
           "default": "",
           "examples": [
             "username"
@@ -901,7 +925,7 @@
         },
         "password": {
           "type": "string",
-          "description": "The password to connect to the database with",
+          "description": "If credentials are required to access Mongo, this is the password to login with.",
           "default": "",
           "examples": [
             "password"
@@ -909,12 +933,17 @@
         },
         "replSet": {
           "type": "string",
-          "description": "The replica set for the database",
+          "description": "If the database is set up to use replica sets, define it here so it can be added to the database connection. Not used when using mongodb+srv:// protocol",
           "default": "",
           "examples": [
             "my_repolica_set"
           ]
         },
+        "addSrv": {
+          "type": "boolean",
+          "description": "Whether the connection requires the mongodb+srv:// protocol. If true, uses mongodb+srv:// protocol. Note: mongodb+srv:// can also be used for non-Atlas deployments that support DNS SRV records",
+          "default": false
+        },
         "db_ssl": {
           "type": "object",
           "description": "SSL for mongo database connection",
@@ -955,6 +984,38 @@
             }
           }
         }
+      },
+      "dependencies": {
+        "dbAuth": {
+          "oneOf": [
+            {
+              "properties": {
+                "dbAuth": {
+                  "const": false
+                }
+              }
+            },
+            {
+              "properties": {
+                "dbAuth": {
+                  "const": true
+                },
+                "username": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "password": {
+                  "type": "string",
+                  "minLength": 1
+                }
+              },
+              "required": [
+                "username",
+                "password"
+              ]
+            }
+          ]
+        }
       }
     },
     "devicebroker": {

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.4.2",
-  "configLines": 3056,
-  "scriptLines": 1783,
-  "codeLines": 2943,
-  "testLines": 3529,
-  "testCases": 163,
-  "totalCodeLines": 8255,
+  "version": "0.4.6",
+  "configLines": 3711,
+  "scriptLines": 2498,
+  "codeLines": 2827,
+  "testLines": 4090,
+  "testCases": 176,
+  "totalCodeLines": 9415,
   "wfTasks": 31
 }

package/report/auto-adapter-openapi.json

@@ -0,0 +1,248 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/dashboard/deviceTotal": {
+      "get": {
+        "tags": [
+          "Dashboard"
+        ],
+        "operationId": "getDeviceTotal",
+        "description": "The parameters and request body are for method: getDeviceTotal. Same endpoint also used in methods:",
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "result",
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              },
+              "example": {}
+            }
+          }
+        }
+      }
+    },
+    "/dashboard/networkTotal": {
+      "get": {
+        "tags": [
+          "Dashboard"
+        ],
+        "operationId": "getNetworkTotal",
+        "description": "The parameters and request body are for method: getNetworkTotal. Same endpoint also used in methods:",
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "result",
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              },
+              "example": {}
+            }
+          }
+        }
+      }
+    },
+    "/device/devices/{serialNumber}": {
+      "get": {
+        "tags": [
+          "Device"
+        ],
+        "operationId": "getDeviceDetails",
+        "description": "The parameters and request body are for method: getDeviceDetails. Same endpoint also used in methods:",
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "result",
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "serialNumber",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "title": "serialNumber",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              },
+              "example": {}
+            }
+          }
+        }
+      }
+    },
+    "/devices/{serialNumber}/firmwares": {
+      "get": {
+        "tags": [
+          "Device"
+        ],
+        "operationId": "getDeviceFirmwareList",
+        "description": "The parameters and request body are for method: getDeviceFirmwareList. Same endpoint also used in methods:",
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "result",
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "serialNumber",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "title": "serialNumber",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              },
+              "example": {}
+            }
+          }
+        }
+      }
+    },
+    "/devices/{serialNumber}": {
+      "put": {
+        "tags": [
+          "Device"
+        ],
+        "operationId": "runCommandOnDevice",
+        "description": "The parameters and request body are for method: runCommandOnDevice. Same endpoint also used in methods:",
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "result",
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "serialNumber",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "title": "serialNumber",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "description": "indeterminate body object",
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              }
+            }
+          }
+        }
+      }
+    },
+    "/command/{commandId}": {
+      "get": {
+        "tags": [
+          "Device"
+        ],
+        "operationId": "getFirmwareUpdateResult",
+        "description": "The parameters and request body are for method: getFirmwareUpdateResult. Same endpoint also used in methods:",
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "result",
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "commandId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "title": "commandId",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              },
+              "example": {}
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {}
+  }
+}

package/report/updateReport1748555069445.json

@@ -0,0 +1,120 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "New adapter errors available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors no longer available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors that have been updated (e.g. recommendation changes)",
+      "value": 31
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 15
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 19
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "5.10.16"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 82
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 345
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 662
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 57
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the ENHANCE.md",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the BROKER.md",
+      "value": 70
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 1631
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 79
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 596
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 15
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1489
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 37
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 3716
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 94
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -98,18 +98,22 @@
       "enabled": false,
       "accept_invalid_cert": false,
       "ca_file": "",
+      "ca_file_content": "",
       "key_file": "",
       "cert_file": "",
       "secure_protocol": "",
       "ciphers": ""
     },
     "mongo": {
+      "url": "",
       "host": "",
       "port": 0,
       "database": "",
+      "dbAuth": false,
       "username": "",
       "password": "",
       "replSet": "",
+      "addSrv": false,
       "db_ssl": {
         "enabled": false,
         "accept_invalid_cert": false,