@itentialopensource/adapter-meraki 0.7.3 → 0.8.2

package/entities/.generic/action.json

@@ -4,7 +4,7 @@
       "name": "getGenerics",
       "protocol": "REST",
       "method": "GET",
-      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}?{query}",
+      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,
@@ -25,7 +25,7 @@
       "name": "createGeneric",
       "protocol": "REST",
       "method": "POST",
-      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}?{query}",
+      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,
@@ -46,7 +46,7 @@
       "name": "updateGeneric",
       "protocol": "REST",
       "method": "PUT",
-      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}?{query}",
+      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,
@@ -67,7 +67,7 @@
       "name": "patchGeneric",
       "protocol": "REST",
       "method": "PATCH",
-      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}?{query}",
+      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,
@@ -88,7 +88,7 @@
       "name": "deleteGeneric",
       "protocol": "REST",
       "method": "DELETE",
-      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}?{query}",
+      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,

package/error.json

@@ -96,6 +96,12 @@
       "displayString": "Invalid properties: $VARIABLE$",
       "recommendation": "Verify the properties for the adapter"
     },
+    {
+      "key": "Missing Properties",
+      "icode": "AD.306",
+      "displayString": "Property $VARIABLE$ is required",
+      "recommendation": "Please provide the required property"
+    },
     {
       "key": "Query Not Translated",
       "icode": "AD.310",
@@ -168,6 +174,12 @@
       "displayString": "Failure response received for $VARIABLE$",
       "recommendation": "Check the reason for failure in the stack trace"
     },
+    {
+      "key": "Suspended Adapter",
+      "icode": "AD.600",
+      "displayString": "Adapter is suspended",
+      "recommendation": "Check if external system is functional and unsuspend if appropriate"
+    },
     {
       "key": "Caught Exception",
       "icode": "AD.900",

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@itentialopensource/adapter-meraki",
-  "version": "0.7.3",
+  "version": "0.8.2",
   "description": "This adapter integrates with system described as: merakiDashboardApi.",
   "main": "adapter.js",
-  "wizardVersion": "2.43.12",
-  "engineVersion": "1.58.3",
+  "wizardVersion": "2.44.7",
+  "engineVersion": "1.61.2",
+  "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
-    "preinstall": "node utils/setup.js",
+    "preinstall": "node utils/setup.js && npm install --package-lock-only --ignore-scripts && npx npm-force-resolutions",
     "lint": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js",
     "lint:errors": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js --quiet",
     "test:baseunit": "mocha test/unit/adapterBaseTestUnit.js --LOG=error",
@@ -15,7 +16,7 @@
     "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
     "test:cover": "nyc --reporter html --reporter text mocha --reporter dot test/*",
     "test": "npm run test:baseunit && npm run test:unit && npm run test:integration",
-    "adapter:install": "node utils/tbScript.js install",
+    "adapter:install": "npm i && node utils/tbScript.js install",
     "adapter:checkMigrate": "node utils/checkMigrate.js",
     "adapter:findPath": "node utils/findPath.js",
     "adapter:migrate": "node utils/modify.js -m",
@@ -25,7 +26,7 @@
     "healthcheck": "node utils/tbScript.js healthcheck",
     "basicget": "node utils/tbScript.js basicget",
     "connectivity": "node utils/tbScript.js connectivity",
-    "deploy": "npm publish --registry=http://registry.npmjs.org --access=public",
+    "deploy": "npm publish --registry=https://registry.npmjs.org --access=public",
     "build": "npm run deploy"
   },
   "keywords": [
@@ -51,13 +52,14 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/sd-wan/adapter-meraki#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^4.39.1",
+    "@itentialopensource/adapter-utils": "^4.45.4",
     "ajv": "^6.12.0",
     "axios": "^0.21.0",
     "commander": "^2.20.0",
     "fs-extra": "^8.1.0",
-    "mocha": "^8.1.1",
+    "mocha": "^9.0.1",
     "mocha-param": "^2.0.1",
+    "mongodb": "^4.1.0",
     "network-diagnostics": "^0.5.3",
     "nyc": "^15.1.0",
     "readline-sync": "^1.4.10",
@@ -65,13 +67,16 @@
     "winston": "^3.3.3"
   },
   "devDependencies": {
-    "chai": "^4.2.0",
-    "eslint": "^7.2.0",
-    "eslint-config-airbnb-base": "^14.2.0",
-    "eslint-plugin-import": "^2.21.2",
-    "eslint-plugin-json": "^2.1.1",
+    "chai": "^4.3.4",
+    "eslint": "^7.29.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-json": "^3.0.0",
     "package-json-validator": "^0.6.3",
     "testdouble": "^3.16.1"
   },
+  "resolutions": {
+    "minimist": "^1.2.5"
+  },
   "private": false
 }

package/pronghorn.json

@@ -9,7 +9,7 @@
   ],
   "methods": [
     {
-      "name": "updateAdapterConfiguration",
+      "name": "iapUpdateAdapterConfiguration",
       "summary": "Updates the adapter configuration",
       "description": "Updates the adapter configuration file with the provided changes",
       "input": [
@@ -78,27 +78,25 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/updateAdapterConfiguration"
+        "path": "/iapUpdateAdapterConfiguration"
       },
       "task": true
     },
     {
-      "name": "findPath",
+      "name": "iapFindAdapterPath",
       "summary": "Provides the ability to see if a particular API path is supported by the adapter",
       "description": "Provides the ability to see if a particular API path is supported by the adapter",
-      "input": [
-        {
-          "name": "apiPath",
-          "type": "string",
-          "info": "The API Path you want to check - make sure to not include base path and version",
-          "description": "The API Path you want to check - make sure to not include base path and version",
-          "schema": {
-            "title": "apiPath",
-            "type": "string"
-          },
-          "required": true
-        }
-      ],
+      "input": [{
+        "name": "apiPath",
+        "type": "string",
+        "info": "The API Path you want to check - make sure to not include base path and version",
+        "description": "The API Path you want to check - make sure to not include base path and version",
+        "schema": {
+          "title": "apiPath",
+          "type": "string"
+        },
+        "required": true
+      }],
       "output": {
         "name": "result",
         "type": "object",
@@ -113,36 +111,30 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/findPath"
+        "path": "/iapFindAdapterPath"
       },
       "task": true
     },
     {
-      "name": "troubleshoot",
-      "summary": "Runs troubleshoot script for adapter",
-      "description": "Runs troubleshoot script for adapter",
-      "input": [
-        {
-          "name": "props",
-          "type": "object",
-          "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
-          "required": true,
-          "schema": {
-            "title": "props",
-            "type": "object"
-          }
+      "name": "iapSuspendAdapter",
+      "summary": "Suspends the adapter",
+      "description": "Suspends the adapter",
+      "input": [{
+        "name": "mode",
+        "type": "enum",
+        "enumerals": ["pause", "error"],
+        "info": "How incoming requests are handled. Defaults to 'pause'",
+        "description": "How incoming requests are handled. Defaults to 'pause'",
+        "schema": {
+          "title": "mode",
+          "type": "string"
         },
-        {
-          "name": "persistFlag",
-          "type": "boolean",
-          "info": "Whether the input properties should be saved",
-          "required": true
-        }
-      ],
+        "required": false
+      }],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing the test results",
+        "description": "A JSON Object containing the adapter suspended status",
         "schema": {
           "title": "result",
           "type": "object"
@@ -153,38 +145,42 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/troubleshoot"
+        "path": "/iapSuspendAdapter"
       },
       "task": true
     },
     {
-      "name": "runHealthcheck",
-      "summary": "Runs healthcheck script for adapter",
-      "description": "Runs healthcheck script for adapter",
+      "name": "iapUnsuspendAdapter",
+      "summary": "Unsuspends the adapter",
+      "description": "Unsuspends the adapter",
       "input": [],
       "output": {
         "name": "result",
-        "type": "boolean",
-        "description": "Whether healthcheck passed or failed"
+        "type": "object",
+        "description": "A JSON Object containing the adapter suspended status",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
       },
       "roles": [
         "admin"
       ],
       "route": {
         "verb": "POST",
-        "path": "/runHealthcheck"
+        "path": "/iapUnsuspendAdapter"
       },
       "task": true
     },
     {
-      "name": "runConnectivity",
-      "summary": "Runs connectivity check script for adapter",
-      "description": "Runs connectivity check script for adapter",
+      "name": "iapGetAdapterQueue",
+      "summary": "Return the requests that are waiting in the queue if throttling is enabled",
+      "description": "Return the requests that are waiting in the queue if throttling is enabled",
       "input": [],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing the test results",
+        "description": "A JSON Object containing the adapter queue",
         "schema": {
           "title": "result",
           "type": "object"
@@ -195,15 +191,32 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/runConnectivity"
+        "path": "/iapGetAdapterQueue"
       },
       "task": true
     },
     {
-      "name": "runBasicGet",
-      "summary": "Runs basicGet script for adapter",
-      "description": "Runs basicGet script for adapter",
-      "input": [],
+      "name": "iapTroubleshootAdapter",
+      "summary": "Runs troubleshoot script for adapter",
+      "description": "Runs troubleshoot script for adapter",
+      "input": [
+        {
+          "name": "props",
+          "type": "object",
+          "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
+          "required": true,
+          "schema": {
+            "title": "props",
+            "type": "object"
+          }
+        },
+        {
+          "name": "persistFlag",
+          "type": "boolean",
+          "info": "Whether the input properties should be saved",
+          "required": true
+        }
+      ],
       "output": {
         "name": "result",
         "type": "object",
@@ -218,35 +231,38 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/runBasicGet"
+        "path": "/iapTroubleshootAdapter"
       },
       "task": true
     },
     {
-      "name": "suspend",
-      "summary": "Suspends the adapter",
-      "description": "Suspends the adapter",
-      "input": [
-        {
-          "name": "mode",
-          "type": "enum",
-          "enumerals": [
-            "pause",
-            "error"
-          ],
-          "info": "How incoming requests are handled. Defaults to 'pause'",
-          "description": "How incoming requests are handled. Defaults to 'pause'",
-          "schema": {
-            "title": "mode",
-            "type": "string"
-          },
-          "required": false
-        }
+      "name": "iapRunAdapterHealthcheck",
+      "summary": "Runs healthcheck script for adapter",
+      "description": "Runs healthcheck script for adapter",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "boolean",
+        "description": "Whether healthcheck passed or failed"
+      },
+      "roles": [
+        "admin"
       ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapRunAdapterHealthcheck"
+      },
+      "task": true
+    },
+    {
+      "name": "iapRunAdapterConnectivity",
+      "summary": "Runs connectivity check script for adapter",
+      "description": "Runs connectivity check script for adapter",
+      "input": [],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing the adapter suspended status",
+        "description": "A JSON Object containing the test results",
         "schema": {
           "title": "result",
           "type": "object"
@@ -257,19 +273,19 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/suspend"
+        "path": "/iapRunAdapterConnectivity"
       },
       "task": true
     },
     {
-      "name": "unsuspend",
-      "summary": "Unsuspends the adapter",
-      "description": "Unsuspends the adapter",
+      "name": "iapRunAdapterBasicGet",
+      "summary": "Runs basicGet script for adapter",
+      "description": "Runs basicGet script for adapter",
       "input": [],
       "output": {
         "name": "result",
         "type": "object",
-        "description": "A JSON Object containing the adapter suspended status",
+        "description": "A JSON Object containing the test results",
         "schema": {
           "title": "result",
           "type": "object"
@@ -280,21 +296,21 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/unsuspend"
+        "path": "/iapRunAdapterBasicGet"
       },
       "task": true
     },
     {
-      "name": "getQueue",
-      "summary": "Return the requests that are waiting in the queue if throttling is enabled",
-      "description": "Return the requests that are waiting in the queue if throttling is enabled",
+      "name": "iapMoveAdapterEntitiesToDB",
+      "summary": "Moves entities from an adapter into the IAP database",
+      "description": "Moves entities from an adapter into the IAP database",
       "input": [],
       "output": {
-        "name": "result",
+        "name": "res",
         "type": "object",
-        "description": "A JSON Object containing the adapter queue",
+        "description": "A JSON Object containing status, code and the response from the mongo transaction",
         "schema": {
-          "title": "result",
+          "title": "res",
           "type": "object"
         }
       },
@@ -303,7 +319,7 @@
       ],
       "route": {
         "verb": "POST",
-        "path": "/getQueue"
+        "path": "/iapMoveAdapterEntitiesToDB"
       },
       "task": true
     },
@@ -386,6 +402,175 @@
       },
       "task": true
     },
+    {
+      "name": "getDevice",
+      "summary": "Get the Appliance",
+      "description": "Get the Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getDevice"
+      },
+      "task": false
+    },
+    {
+      "name": "getDevicesFiltered",
+      "summary": "Get Appliances that match the filter",
+      "description": "Get Appliances that match the filter",
+      "input": [
+        {
+          "name": "options",
+          "type": "object",
+          "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
+          "required": true,
+          "schema": {
+            "title": "options",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "array",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "array"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getDevicesFiltered"
+      },
+      "task": false
+    },
+    {
+      "name": "isAlive",
+      "summary": "Checks the status for the provided Appliance",
+      "description": "Checks the status for the provided Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "boolean",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "boolean"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/isAlive"
+      },
+      "task": false
+    },
+    {
+      "name": "getConfig",
+      "summary": "Gets a config for the provided Appliance",
+      "description": "Gets a config for the provided Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        },
+        {
+          "name": "format",
+          "type": "string",
+          "info": "The format to be returned - this is ignored as we always return json",
+          "required": false,
+          "schema": {
+            "title": "format",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getConfig"
+      },
+      "task": false
+    },
+    {
+      "name": "iapGetDeviceCount",
+      "summary": "Gets a device count from the system",
+      "description": "Gets a device count from the system",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapGetDeviceCount"
+      },
+      "task": false
+    },
     {
       "name": "createOrganizationActionBatch",
       "summary": "Create an action batch",

package/propertiesDecorators.json

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