@itentialopensource/adapter-meraki 1.1.0 → 1.2.2

package/CHANGELOG.md

@@ -1,4 +1,28 @@
 
+## 1.2.2 [09-11-2023]
+
+* remove example
+
+See merge request itentialopensource/adapters/sd-wan/adapter-meraki!32
+
+---
+
+## 1.2.1 [09-11-2023]
+
+* Additional migration and metadata changes
+
+See merge request itentialopensource/adapters/sd-wan/adapter-meraki!31
+
+---
+
+## 1.2.0 [08-16-2023]
+
+* Minor/2023 migration
+
+See merge request itentialopensource/adapters/sd-wan/adapter-meraki!30
+
+---
+
 ## 1.1.0 [08-11-2023]
 
 * Minor/2023 migration

package/README.md

@@ -14,6 +14,7 @@ Some of the page links in this document and links to other GitLab files do not w
   - [Testing](#testing)
 - [Configuration](./PROPERTIES.md)
 - [Using this Adapter](./CALLS.md)
+  - [Authentication](./AUTH.md)
 - [Additional Information](#additional-information)
   - [Enhancements](./ENHANCE.md)
   - [Contributing](./CONTRIBUTING.md)
@@ -47,17 +48,20 @@ These instructions will help you get a copy of the project on your local machine
 
 ### Helpful Background Information
 
-There is adapter documentation available on the Itential Developer Site <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">HERE</a>. This documentation includes information and examples that are helpful for:
+There is <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter documentation available on the Itential Documentation Site</a>. This documentation includes information and examples that are helpful for:
 
 ```text
 Authentication
-Properties
+IAP Service Instance Configuration
 Code Files
-Action Files
-Schema Files
-Mock Data Files
+Endpoint Configuration (Action & Schema)
+Mock Data
+Adapter Generic Methods
+Headers
+Security
 Linting and Testing
-Troubleshooting
+Build an Adapter
+Troubleshooting an Adapter
 ```
 
 Others will be added over time.
@@ -175,7 +179,7 @@ tar -xvf adapter-meraki.tar
 
 ```bash
 cd adapter-meraki
-npm run install
+npm install
 npm run lint:errors
 npm run test
 ```

package/adapterBase.js

@@ -1027,6 +1027,24 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.hasEntities(entityType, entityList, callback);
   }
 
+  /**
+   * @summary Determines if this adapter supports any in a list of entities
+   *
+   * @function hasEntitiesAuth
+   * @param {String} entityType - the entity type to check for
+   * @param {Array} entityList - the list of entities we are looking for
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {Callback} callback - A map where the entity is the key and the
+   *                              value is true or false
+   */
+  hasEntitiesAuth(entityType, entityList, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-hasEntitiesAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.hasEntitiesAuth(entityType, entityList, callOptions, callback);
+  }
+
   /**
    * @summary Get Appliance that match the deviceName
    *
@@ -1043,6 +1061,23 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.getDevice(deviceName, callback);
   }
 
+  /**
+   * @summary Get Appliance that match the deviceName
+   *
+   * @function getDeviceAuth
+   * @param {String} deviceName - the deviceName to find (required)
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   *                                 (appliance) or the error
+   */
+  getDeviceAuth(deviceName, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-getDeviceAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getDeviceAuth(deviceName, callOptions, callback);
+  }
+
   /**
    * @summary Get Appliances that match the filter
    *
@@ -1059,6 +1094,23 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.getDevicesFiltered(options, callback);
   }
 
+  /**
+   * @summary Get Appliances that match the filter
+   *
+   * @function getDevicesFilteredAuth
+   * @param {Object} options - the data to use to filter the appliances (optional)
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   *                                 (appliances) or the error
+   */
+  getDevicesFilteredAuth(options, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-getDevicesFilteredAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getDevicesFilteredAuth(options, callOptions, callback);
+  }
+
   /**
    * @summary Gets the status for the provided appliance
    *
@@ -1075,6 +1127,23 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.isAlive(deviceName, callback);
   }
 
+  /**
+   * @summary Gets the status for the provided appliance
+   *
+   * @function isAliveAuth
+   * @param {String} deviceName - the deviceName of the appliance. (required)
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {configCallback} callback - callback function to return the result
+   *                                    (appliance isAliveAuth) or the error
+   */
+  isAliveAuth(deviceName, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-isAliveAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.isAliveAuth(deviceName, callOptions, callback);
+  }
+
   /**
    * @summary Gets a config for the provided Appliance
    *
@@ -1092,6 +1161,24 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.getConfig(deviceName, format, callback);
   }
 
+  /**
+   * @summary Gets a config for the provided Appliance
+   *
+   * @function getConfigAuth
+   * @param {String} deviceName - the deviceName of the appliance. (required)
+   * @param {String} format - the desired format of the config. (optional)
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {configCallback} callback - callback function to return the result
+   *                                    (appliance config) or the error
+   */
+  getConfigAuth(deviceName, format, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-getConfigAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getConfigAuth(deviceName, format, callOptions, callback);
+  }
+
   /**
    * @summary Gets the device count from the system
    *
@@ -1107,6 +1194,22 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.iapGetDeviceCount(callback);
   }
 
+  /**
+   * @summary Gets the device count from the system
+   *
+   * @function iapGetDeviceCountAuth
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {getCallback} callback - callback function to return the result
+   *                                    (count) or the error
+   */
+  iapGetDeviceCountAuth(callOptions, callback) {
+    const origin = `${this.id}-adapterBase-iapGetDeviceCountAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.iapGetDeviceCountAuth(callOptions, callback);
+  }
+
   /* ********************************************** */
   /*                                                */
   /*          EXPOSES GENERIC HANDLER               */

package/metadata.json

@@ -1,5 +1,6 @@
 {
   "name": "adapter-meraki",
+  "webName": "Adapter for Integration to Cisco Meraki",
   "vendor": "Cisco",
   "product": "Meraki",
   "osVersion": [],
@@ -12,14 +13,19 @@
     "2022.1.x",
     "2023.1.x"
   ],
-  "method": "REST API",
+  "method": "REST",
   "type": "Adapter",
-  "example": "",
   "domains": [
     "Inventory",
-    "SD-WAN/SASE"
+    "SD-WAN (SASE)"
+  ],
+  "tags": [
+    "Configuration Management"
+  ],
+  "useCases": [
+    "Device Onboarding",
+    "Reboot Device"
   ],
-  "tags": [],
   "deprecated": {
     "isDeprecated": false
   },
@@ -29,6 +35,10 @@
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-meraki",
     "repoLink": "https://gitlab.com/itentialopensource/adapters/sd-wan/adapter-meraki",
     "docLink": "https://docs.itential.com/opensource/docs/meraki",
+    "demoLinks": [
+      "https://www.itential.com/automations/sd-wan-branch-management",
+      "https://www.itential.com/solutions/sdwan-automation-orchestration/"
+    ],
     "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
     "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
     "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
@@ -39,14 +49,17 @@
       "https://developer.cisco.com/meraki/api-latest/"
     ]
   },
+  "assets": [],
   "relatedItems": {
     "adapters": [],
     "integrations": [],
     "ecosystemApplications": [],
-    "automations": [
+    "workflowProjects": [
       {
         "name": "Meraki SD-WAN Management",
+        "webName": "Create a Meraki Network for an Organization",
         "overview": "The SD-WAN Branch Management pre-built consists of a series of small modular workflows that creates a 'network' for a given organization and claims one or many access points in that network.",
+        "isDependency": false,
         "versions": [
           "^0.2.5"
         ],
@@ -55,7 +68,7 @@
         "webLink": "https://www.itential.com/automations/sd-wan-branch-management/"
       }
     ],
-    "transformations": [],
-    "useCases": []
+    "transformationProjects": [],
+    "exampleProjects": []
   }
 }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@itentialopensource/adapter-meraki",
-  "version": "1.1.0",
+  "version": "1.2.2",
   "description": "This adapter integrates with system described as: merakiDashboardApi.",
   "main": "adapter.js",
   "systemName": "Meraki",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.0",
+  "engineVersion": "1.67.8",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -54,12 +54,12 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/sd-wan/adapter-meraki#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.1.0",
+    "@itentialopensource/adapter-utils": "^5.1.7",
+    "acorn": "^8.10.0",
     "ajv": "^8.12.0",
     "axios": "^1.4.0",
     "commander": "^11.0.0",
     "dns-lookup-promise": "^1.0.4",
-    "esprima": "^4.0.1",
     "fs-extra": "^11.1.1",
     "json-query": "^2.2.2",
     "mocha": "^10.2.0",

package/propertiesSchema.json

@@ -1063,6 +1063,38 @@
                 "description": "The method of the call to getDevicesFiltered",
                 "default": "GET"
               },
+              "pagination": {
+                "type": "object",
+                "description": "todo",
+                "properties": {
+                  "offsetVar": {
+                    "type": "string",
+                    "description": "Name of variable that defines how to go to next set of results"
+                  },
+                  "limitVar": {
+                    "type": "string",
+                    "description": "Name of variable that defines the max results returned in a request"
+                  },
+                  "incrementBy": {
+                    "type": "string",
+                    "enum": [
+                      "limit",
+                      "page"
+                    ],
+                    "description": "How to incremenet offset. Default limit",
+                    "default": "limit"
+                  },
+                  "requestLocation": {
+                    "type": "string",
+                    "enum": [
+                      "query",
+                      "body"
+                    ],
+                    "description": "Where in request the pagination data goes",
+                    "default": "query"
+                  }
+                }
+              },
               "query": {
                 "type": "object",
                 "description": "The json object with query parameters of the call to getDevicesFiltered",
@@ -1487,6 +1519,38 @@
                       "description": "The method of the call to getDevice",
                       "default": "GET"
                     },
+                    "pagination": {
+                      "type": "object",
+                      "description": "todo",
+                      "properties": {
+                        "offsetVar": {
+                          "type": "string",
+                          "description": "Name of variable that defines how to go to next set of results"
+                        },
+                        "limitVar": {
+                          "type": "string",
+                          "description": "Name of variable that defines the max results returned in a request"
+                        },
+                        "incrementBy": {
+                          "type": "string",
+                          "enum": [
+                            "limit",
+                            "page"
+                          ],
+                          "description": "How to incremenet offset. Default limit",
+                          "default": "limit"
+                        },
+                        "requestLocation": {
+                          "type": "string",
+                          "enum": [
+                            "query",
+                            "body"
+                          ],
+                          "description": "Where in request the pagination data goes",
+                          "default": "query"
+                        }
+                      }
+                    },
                     "query": {
                       "type": "object",
                       "description": "The json object with query parameters of the call to getDevice",