npm - @itentialopensource/adapter-sevone - Versions diffs - 2.2.4 → 2.4.0 - Mend

@itentialopensource/adapter-sevone 2.2.4 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (311) hide show

package/propertiesDecorators.json ADDED Viewed

@@ -0,0 +1,14 @@
+[
+  {
+    "type": "encryption",
+    "pointer": "/authentication/password"
+  },
+  {
+    "type": "encryption",
+    "pointer": "/authentication/token"
+  },
+  {
+    "type": "encryption",
+    "pointer": "/mongo/password"
+  }
+]

package/propertiesSchema.json CHANGED Viewed

@@ -74,6 +74,11 @@
       "description": "When true the path variables are encoded in the url",
       "default": true
     },
+    "encode_queryvars": {
+      "type": "boolean",
+      "description": "When true the query parameters are encoded in the url",
+      "default": true
+    },
     "save_metric": {
       "type": [
         "boolean",
@@ -116,6 +121,9 @@
     },
     "mongo": {
       "$ref": "#/definitions/mongo"
+    },
+    "devicebroker": {
+      "$ref": "#/definitions/devicebroker"
     }
   },
   "required": [
@@ -255,6 +263,21 @@
           "type": "boolean",
           "description": "This property turns on logging of Authentication Information and should only be true when debugging authentication and connectivity",
           "default": false
+        },
+        "client_id": {
+          "type": "string",
+          "description": "The client id for OAuth requests - can also use username depending on schema",
+          "default": ""
+        },
+        "client_secret": {
+          "type": "string",
+          "description": "The client secret for OAuth requests - can also use password depending on schema",
+          "default": ""
+        },
+        "grant_type": {
+          "type": "string",
+          "description": "The grant type for OAuth requests - can also provide in schema",
+          "default": ""
         }
       },
       "required": [
@@ -843,6 +866,419 @@
           }
         }
       }
+    },
+    "devicebroker": {
+      "type": "object",
+      "properties": {
+        "getDevice": {
+          "type": "array",
+          "description": "Broker call(s) to getDevice",
+          "items": {
+            "properties": {
+              "path": {
+                "type": "string",
+                "description": "The fully qualified path of the call to getDevice (e.g. /rest/api/device/{deviceid})",
+                "default": ""
+              },
+              "method": {
+                "type": "string",
+                "description": "The method of the call to getDevice",
+                "default": "GET"
+              },
+              "query": {
+                "type": "object",
+                "description": "The json object with query parameters of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "body": {
+                "type": "object",
+                "description": "The json object with body of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "headers": {
+                "type": "object",
+                "description": "The json object with headers of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "handleFailure": {
+                "type": "string",
+                "enum": [
+                  "ignore",
+                  "fail"
+                ],
+                "description": "return failure or ignore failure",
+                "default": "ignore"
+              },
+              "requestFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {}
+              },
+              "responseDatakey": {
+                "type": "string",
+                "description": "place in the response where the data is - supports jsonquery",
+                "default": ""
+              },
+              "responseFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "The field in response to getDevice that contains the name of the device",
+                    "default": "name"
+                  },
+                  "ostype": {
+                    "type": "string",
+                    "description": "The field in response to getDevice that contains the ostype of the device",
+                    "default": "ostype"
+                  },
+                  "ostypePrefix": {
+                    "type": "string",
+                    "description": "Any prefix that should be added to the ostype of the device (e.g. aws-)",
+                    "default": ""
+                  },
+                  "port": {
+                    "type": "string",
+                    "description": "The field in response to getDevice that contains the port of the device",
+                    "default": ""
+                  },
+                  "ipaddress": {
+                    "type": "string",
+                    "description": "The field in response to getDevice that contains the ip address of the device",
+                    "default": ""
+                  }
+                }
+              }
+            }
+          }
+        },
+        "getDevicesFiltered": {
+          "type": "array",
+          "description": "Broker call(s) to getDevicesFiltered",
+          "items": {
+            "properties": {
+              "path": {
+                "type": "string",
+                "description": "The fully qualified path of the call to getDevicesFiltered (e.g. /rest/api/device/{deviceid})",
+                "default": ""
+              },
+              "method": {
+                "type": "string",
+                "description": "The method of the call to getDevicesFiltered",
+                "default": "GET"
+              },
+              "query": {
+                "type": "object",
+                "description": "The json object with query parameters of the call to getDevicesFiltered",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "body": {
+                "type": "object",
+                "description": "The json object with body of the call to getDevicesFiltered",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "headers": {
+                "type": "object",
+                "description": "The json object with headers of the call to getDevicesFiltered",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "handleFailure": {
+                "type": "string",
+                "enum": [
+                  "ignore",
+                  "fail"
+                ],
+                "description": "return failure or ignore failure",
+                "default": "ignore"
+              },
+              "requestFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {}
+              },
+              "responseDatakey": {
+                "type": "string",
+                "description": "place in the response where the data is - supports jsonquery",
+                "default": ""
+              },
+              "responseFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getDevicesFiltered",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "The field in response to getDevicesFiltered that contains the name of the device",
+                    "default": "name"
+                  },
+                  "ostype": {
+                    "type": "string",
+                    "description": "The field in response to getDevicesFiltered that contains the ostype of the device",
+                    "default": "ostype"
+                  },
+                  "ostypePrefix": {
+                    "type": "string",
+                    "description": "Any prefix that should be added to the ostype of the device (e.g. aws-)",
+                    "default": ""
+                  },
+                  "port": {
+                    "type": "string",
+                    "description": "The field in response to getDevicesFiltered that contains the port of the device",
+                    "default": ""
+                  },
+                  "ipaddress": {
+                    "type": "string",
+                    "description": "The field in response to getDevicesFiltered that contains the ip address of the device",
+                    "default": ""
+                  }
+                }
+              }
+            }
+          }
+        },
+        "isAlive": {
+          "type": "array",
+          "description": "Broker call(s) to determine if the device isAlive",
+          "items": {
+            "properties": {
+              "path": {
+                "type": "string",
+                "description": "The fully qualified path of the call to isAlive (e.g. /rest/api/device/{deviceid})",
+                "default": ""
+              },
+              "method": {
+                "type": "string",
+                "description": "The method of the call to isAlive",
+                "default": "GET"
+              },
+              "query": {
+                "type": "object",
+                "description": "The json object with query parameters of the call to isAlive",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "body": {
+                "type": "object",
+                "description": "The json object with body of the call to isAlive",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "headers": {
+                "type": "object",
+                "description": "The json object with headers of the call to isAlive",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "handleFailure": {
+                "type": "string",
+                "enum": [
+                  "ignore",
+                  "fail"
+                ],
+                "description": "return failure or ignore isAlive",
+                "default": "ignore"
+              },
+              "requestFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {}
+              },
+              "responseDatakey": {
+                "type": "string",
+                "description": "place in the response where the data is - supports jsonquery",
+                "default": ""
+              },
+              "responseFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to isAlive",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {
+                  "status": {
+                    "type": "string",
+                    "description": "The field in response to isAlive that contains the status of the device",
+                    "default": "name"
+                  },
+                  "statusValue": {
+                    "type": "string",
+                    "description": "The expected value in the status field",
+                    "default": "true"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "getConfig": {
+          "type": "array",
+          "description": "Broker call(s) to getConfig",
+          "items": {
+            "properties": {
+              "path": {
+                "type": "string",
+                "description": "The fully qualified path of the call to getConfig (e.g. /rest/api/device/{deviceid})",
+                "default": ""
+              },
+              "method": {
+                "type": "string",
+                "description": "The method of the call to getConfig",
+                "default": "GET"
+              },
+              "query": {
+                "type": "object",
+                "description": "The json object with query parameters of the call to getConfig",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "body": {
+                "type": "object",
+                "description": "The json object with body of the call to getConfig",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "headers": {
+                "type": "object",
+                "description": "The json object with headers of the call to getConfig",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "handleFailure": {
+                "type": "string",
+                "enum": [
+                  "ignore",
+                  "fail"
+                ],
+                "description": "return failure or ignore getConfig",
+                "default": "ignore"
+              },
+              "requestFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {}
+              },
+              "responseDatakey": {
+                "type": "string",
+                "description": "place in the response where the data is - supports jsonquery",
+                "default": ""
+              },
+              "responseFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getConfig",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {}
+              }
+            }
+          }
+        },
+        "getCount": {
+          "type": "array",
+          "description": "Broker call(s) to getCount",
+          "items": {
+            "properties": {
+              "path": {
+                "type": "string",
+                "description": "The fully qualified path of the call to getCount (e.g. /rest/api/device/{deviceid})",
+                "default": ""
+              },
+              "method": {
+                "type": "string",
+                "description": "The method of the call to getCount",
+                "default": "GET"
+              },
+              "query": {
+                "type": "object",
+                "description": "The json object with query parameters of the call to getCount",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "body": {
+                "type": "object",
+                "description": "The json object with body of the call to getCount",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "headers": {
+                "type": "object",
+                "description": "The json object with headers of the call to getCount",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "handleFailure": {
+                "type": "string",
+                "enum": [
+                  "ignore",
+                  "fail"
+                ],
+                "description": "return failure or ignore getCount",
+                "default": "ignore"
+              },
+              "requestFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {}
+              },
+              "responseDatakey": {
+                "type": "string",
+                "description": "place in the response where the data is - supports jsonquery",
+                "default": ""
+              },
+              "responseFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getConfig",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {}
+              }
+            }
+          }
+        }
+      }
     }
   }
 }

package/refs?service=git-upload-pack CHANGED Viewed

Binary file

package/report/adapterInfo.json ADDED Viewed

@@ -0,0 +1,10 @@
+{
+  "version": "2.3.1",
+  "configLines": 40081,
+  "scriptLines": 1707,
+  "codeLines": 26988,
+  "testLines": 28283,
+  "testCases": 1342,
+  "totalCodeLines": 56978,
+  "wfTasks": 352
+}

package/report/updateReport1653680202971.json ADDED Viewed

@@ -0,0 +1,120 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "New adapter errors available for use",
+      "value": 1
+    },
+    {
+      "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": 30
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 14
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 7
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 22
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^4.45.6"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 71
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 338
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 642
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 48
+    },
+    {
+      "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": 13659
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 879
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 13494
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 405
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1783
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 28936
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 1284
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}