@itentialopensource/adapter-meraki 1.0.3 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (40) hide show
  1. package/AUTH.md +14 -18
  2. package/CALLS.md +4264 -0
  3. package/CHANGELOG.md +16 -0
  4. package/CONTRIBUTING.md +1 -160
  5. package/ENHANCE.md +2 -2
  6. package/README.md +23 -18
  7. package/SYSTEMINFO.md +15 -2
  8. package/adapter.js +164 -335
  9. package/adapterBase.js +411 -920
  10. package/changelogs/changelog.md +198 -0
  11. package/metadata.json +61 -0
  12. package/package.json +24 -24
  13. package/pronghorn.json +470 -138
  14. package/propertiesSchema.json +358 -31
  15. package/refs?service=git-upload-pack +0 -0
  16. package/report/adapterInfo.json +8 -8
  17. package/report/updateReport1690417926405.json +119 -0
  18. package/sampleProperties.json +74 -27
  19. package/test/integration/adapterTestBasicGet.js +2 -4
  20. package/test/integration/adapterTestConnectivity.js +91 -42
  21. package/test/integration/adapterTestIntegration.js +130 -2
  22. package/test/unit/adapterBaseTestUnit.js +388 -313
  23. package/test/unit/adapterTestUnit.js +332 -112
  24. package/utils/adapterInfo.js +1 -1
  25. package/utils/addAuth.js +1 -1
  26. package/utils/artifactize.js +1 -1
  27. package/utils/checkMigrate.js +1 -1
  28. package/utils/entitiesToDB.js +2 -2
  29. package/utils/findPath.js +1 -1
  30. package/utils/methodDocumentor.js +225 -0
  31. package/utils/modify.js +13 -15
  32. package/utils/packModificationScript.js +1 -1
  33. package/utils/pre-commit.sh +2 -0
  34. package/utils/taskMover.js +309 -0
  35. package/utils/tbScript.js +89 -34
  36. package/utils/tbUtils.js +41 -21
  37. package/utils/testRunner.js +1 -1
  38. package/utils/troubleshootingAdapter.js +9 -6
  39. package/versions.json +0 -542
  40. package/workflows/README.md +0 -3
@@ -0,0 +1,198 @@
1
+
2
+ ## 1.0.4 [08-01-2023]
3
+
4
+ * Update adapter base and import order
5
+
6
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!27
7
+
8
+ ---
9
+
10
+ ## 1.0.3 [07-10-2023]
11
+
12
+ * Migrate adapter base to have broker changes
13
+
14
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!25
15
+
16
+ ---
17
+
18
+ ## 1.0.2 [05-10-2023]
19
+
20
+ * Migrate adapter base to have broker changes
21
+
22
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!25
23
+
24
+ ---
25
+
26
+ ## 1.0.1 [04-04-2023]
27
+
28
+ * Utils version has been updated in package.json, and the changes are being migrated to the adapter
29
+
30
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!23
31
+
32
+ ---
33
+
34
+ ## 1.0.0 [11-15-2022]
35
+
36
+ * Major/adapt 2285
37
+
38
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!22
39
+
40
+ ---
41
+
42
+ ## 0.8.4 [05-14-2022]
43
+
44
+ * Migrate the adapter to the latest foundation
45
+
46
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!19
47
+
48
+ ---
49
+
50
+ ## 0.8.3 [05-08-2022] & 0.8.2 [05-02-2022] & 0.8.1 [04-13-2022] & 0.8.0 [01-21-2022]
51
+
52
+ - Multiple versions and releases due to this being one of the adapters heavily involved in the new addapter/broker integration effort.
53
+ - Add some items to .gitignore (e.g. DS_Store) to keep them out of the repos.
54
+ - Changes to the README (some typo fixes - Add how to extend the adapter). Split the README into various markdown files (AUTH, BROKER, CALLS, ENHANCE, PROPERTIES, SUMMARY, SYSTEMINFO, TROUBLESHOOT)
55
+ - Fix the issues with Confluence in the markdowns (Tables, Lists, Links)
56
+ - Add scripts for easier authentication, removing hooks, etc
57
+ - Script changes (install script as well as database changes in other scripts)
58
+ - Double # of path vars on generic call
59
+ - Update versions of foundation (e.g. adapter-utils)
60
+ - Update npm publish so it supports https
61
+ - Update dependencies
62
+ - Add preinstall for minimist
63
+ - Fix new lint issues that came from eslint dependency change
64
+ - Add more thorough Unit tests for standard files (Package, Pronghorn, Properties (Schema and Sample)
65
+ - Add the adapter type in the package.json
66
+ - Add AdapterInfo.js script
67
+ - Add json-query dependency
68
+ - Add the propertiesDecorators.json for product encryption
69
+ - Change the name of internal IAP/Adapter methods to avoid collisions and make more obvious in Workflow - iapRunAdapterBasicGet, iapRunAdapterConnectivity, iapRunAdapterHealthcheck, iapTroubleshootAdapter, iapGetAdapterQueue, iapUnsuspendAdapter, iapSuspendAdapter, iapFindAdapterPath, iapUpdateAdapterConfiguration, iapGetAdapterWorkflowFunctions
70
+ - Add the adapter config in the database support - iapMoveAdapterEntitiesToDB
71
+ - Add standard broker calls - hasEntities, getDevice, getDevicesFiltered, isAlive, getConfig and iapGetDeviceCount
72
+ - Add genericAdapterRequest that does not use the base_path and version so that the path can be unique - genericAdapterRequestNoBasePath
73
+ - Add AdapterInfo.json
74
+ - Add systemName for documentation
75
+
76
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!18
77
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!17
78
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!16
79
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!15
80
+
81
+ ---
82
+
83
+ ## 0.7.3 [06-08-2021]
84
+
85
+ - Update pronghorn.json and adpater.js for sending api call body directly
86
+
87
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!14
88
+
89
+ ---
90
+
91
+ ## 0.7.2 [03-10-2021]
92
+
93
+ - migration to bring up to the latest foundation
94
+ - Change to .eslintignore (adapter_modification directory)
95
+ - Change to README.md (new properties, new scripts, new processes)
96
+ - Changes to adapterBase.js (new methods)
97
+ - Changes to package.json (new scripts, dependencies)
98
+ - Changes to propertiesSchema.json (new properties and changes to existing)
99
+ - Changes to the Unit test
100
+ - Adding several test files, utils files and .generic entity
101
+ - Fix order of scripts and dependencies in package.json
102
+ - Fix order of properties in propertiesSchema.json
103
+ - Update sampleProperties, unit and integration tests to have all new properties.
104
+ - Add all new calls to adapter.js and pronghorn.json
105
+ - Add suspend piece to older methods
106
+
107
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!13
108
+
109
+ ---
110
+
111
+ ## 0.7.1 [07-08-2020]
112
+
113
+ - Update to the latest adapter foundation
114
+
115
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!12
116
+
117
+ ---
118
+
119
+ ## 0.7.0 [03-02-2020]
120
+
121
+ - Add new version calls based on additional query parameters that Meraki has made available.
122
+
123
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!11
124
+
125
+ ---
126
+
127
+ ## 0.6.0 [02-03-2020]
128
+
129
+ - Add new calls to the adapter that were in the new Postman Collection for Meraki (built swagger and put in report)
130
+
131
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!10
132
+
133
+ ---
134
+
135
+ ## 0.5.2 [01-13-2020]
136
+
137
+ - Bring the adapter up to the latest adapter foundation
138
+
139
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!8
140
+
141
+ ---
142
+
143
+ ## 0.5.1 [11-19-2019]
144
+
145
+ - Update the healthcheck url to one that was used in the lab
146
+
147
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!7
148
+
149
+ ---
150
+
151
+ ## 0.5.0 [11-08-2019]
152
+
153
+ - Update the adapter to the latest adapter foundation.
154
+ - Updating to adapter-utils 4.24.3 (automatic)
155
+ - Add sample token schemas (manual)
156
+ - Adding placement property to getToken response schema (manual - before encrypt)
157
+ - Adding sso default into action.json for getToken (manual - before response object)
158
+ - Add new adapter properties for metrics & mock (save_metric, mongo and return_raw) (automatic - check place manual before stub)
159
+ - Update sample properties to include new properties (manual)
160
+ - Update integration test for raw mockdata (automatic)
161
+ - Update test properties (manual)
162
+ - Changes to artifactize (automatic)
163
+ - Update type in sampleProperties so it is correct for the adapter (manual)
164
+ - Update the readme (automatic)
165
+
166
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!6
167
+
168
+ ---
169
+
170
+ ## 0.4.0 [09-17-2019]
171
+
172
+ - Update the adapter to the latest adapter foundation
173
+
174
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!5
175
+
176
+ ---
177
+
178
+ ## 0.3.1 [08-30-2019]
179
+
180
+ - Added the slash into the entity paths. Migrator does not currently update action files. This was fixed in the adapter builder a while ago but needed to be manually fixed in this adapter.
181
+
182
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!4
183
+
184
+ ---
185
+
186
+ ## 0.3.0 [07-30-2019] & 0.2.0 [07-18-2019]
187
+ - Migrate to the latest adapter foundation, categorize and prepare for app artifact
188
+
189
+ See merge request itentialopensource/adapters/sd-wan/adapter-meraki!3
190
+
191
+ ---
192
+
193
+ ## 0.1.1 [06-18-2019]
194
+ - Initial Commit
195
+
196
+ See merge request itentialopensource/adapters/adapter-meraki!2
197
+
198
+ ---
package/metadata.json ADDED
@@ -0,0 +1,61 @@
1
+ {
2
+ "name": "adapter-meraki",
3
+ "vendor": "Cisco",
4
+ "product": "Meraki",
5
+ "osVersion": [],
6
+ "apiVersions": [
7
+ "v1"
8
+ ],
9
+ "iapVersions": [
10
+ "2021.1.x",
11
+ "2021.2.x",
12
+ "2022.1.x",
13
+ "2023.1.x"
14
+ ],
15
+ "method": "REST API",
16
+ "type": "Adapter",
17
+ "example": "",
18
+ "domains": [
19
+ "Inventory",
20
+ "SD-WAN/SASE"
21
+ ],
22
+ "tags": [],
23
+ "deprecated": {
24
+ "isDeprecated": false
25
+ },
26
+ "brokerSince": "1.1.0",
27
+ "documentation": {
28
+ "storeLink": "",
29
+ "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-meraki",
30
+ "repoLink": "https://gitlab.com/itentialopensource/adapters/sd-wan/adapter-meraki",
31
+ "docLink": "https://docs.itential.com/opensource/docs/meraki",
32
+ "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
33
+ "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
34
+ "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
35
+ "webLink": "https://www.itential.com/adapters/cisco-meraki/",
36
+ "vendorLink": "https://www.cisco.com/",
37
+ "productLink": "https://meraki.cisco.com/",
38
+ "apiLinks": [
39
+ "https://developer.cisco.com/meraki/api-latest/"
40
+ ]
41
+ },
42
+ "relatedItems": {
43
+ "adapters": [],
44
+ "integrations": [],
45
+ "ecosystemApplications": [],
46
+ "automations": [
47
+ {
48
+ "name": "Meraki SD-WAN Management",
49
+ "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.",
50
+ "versions": [
51
+ "^0.2.5"
52
+ ],
53
+ "repoLink": "https://gitlab.com/itentialopensource/pre-built-automations/meraki-sd-wan-management",
54
+ "docLink": "<TBD>",
55
+ "webLink": "https://www.itential.com/automations/sd-wan-branch-management/"
56
+ }
57
+ ],
58
+ "transformations": [],
59
+ "useCases": []
60
+ }
61
+ }
package/package.json CHANGED
@@ -1,15 +1,16 @@
1
1
  {
2
2
  "name": "@itentialopensource/adapter-meraki",
3
- "version": "1.0.3",
3
+ "version": "1.1.0",
4
4
  "description": "This adapter integrates with system described as: merakiDashboardApi.",
5
5
  "main": "adapter.js",
6
6
  "systemName": "Meraki",
7
7
  "wizardVersion": "2.44.7",
8
- "engineVersion": "1.61.6",
8
+ "engineVersion": "1.67.0",
9
9
  "adapterType": "http",
10
10
  "scripts": {
11
11
  "artifactize": "npm i && node utils/packModificationScript.js",
12
- "preinstall": "node utils/setup.js && npm install --package-lock-only --ignore-scripts && npx npm-force-resolutions",
12
+ "preinstall": "node utils/setup.js",
13
+ "deinstall": "node utils/removeHooks.js",
13
14
  "lint": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js",
14
15
  "lint:errors": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js --quiet",
15
16
  "test:baseunit": "mocha test/unit/adapterBaseTestUnit.js --LOG=error",
@@ -23,7 +24,7 @@
23
24
  "adapter:migrate": "node utils/modify.js -m",
24
25
  "adapter:update": "node utils/modify.js -u",
25
26
  "adapter:revert": "node utils/modify.js -r",
26
- "troubleshoot": "node utils/tbScript.js",
27
+ "troubleshoot": "node utils/tbScript.js troubleshoot",
27
28
  "healthcheck": "node utils/tbScript.js healthcheck",
28
29
  "basicget": "node utils/tbScript.js basicget",
29
30
  "connectivity": "node utils/tbScript.js connectivity",
@@ -53,32 +54,31 @@
53
54
  "author": "Itential",
54
55
  "homepage": "https://gitlab.com/itentialopensource/adapters/sd-wan/adapter-meraki#readme",
55
56
  "dependencies": {
56
- "@itentialopensource/adapter-utils": "^4.49.0",
57
- "ajv": "^6.12.0",
58
- "axios": "^0.21.0",
59
- "commander": "^2.20.0",
60
- "fs-extra": "^8.1.0",
57
+ "@itentialopensource/adapter-utils": "^5.1.0",
58
+ "ajv": "^8.12.0",
59
+ "axios": "^1.4.0",
60
+ "commander": "^11.0.0",
61
+ "dns-lookup-promise": "^1.0.4",
62
+ "esprima": "^4.0.1",
63
+ "fs-extra": "^11.1.1",
61
64
  "json-query": "^2.2.2",
62
- "mocha": "^9.0.1",
65
+ "mocha": "^10.2.0",
63
66
  "mocha-param": "^2.0.1",
64
- "mongodb": "^4.1.0",
65
- "network-diagnostics": "^0.5.3",
67
+ "mongodb": "^4.16.0",
66
68
  "nyc": "^15.1.0",
69
+ "ping": "^0.4.4",
70
+ "prompts": "^2.4.2",
67
71
  "readline-sync": "^1.4.10",
68
- "semver": "^7.3.2",
69
- "winston": "^3.3.3"
72
+ "semver": "^7.5.3",
73
+ "winston": "^3.9.0"
70
74
  },
71
75
  "devDependencies": {
72
- "chai": "^4.3.4",
73
- "eslint": "^7.29.0",
74
- "eslint-config-airbnb-base": "^14.2.1",
75
- "eslint-plugin-import": "^2.23.4",
76
- "eslint-plugin-json": "^3.0.0",
77
- "package-json-validator": "^0.6.3",
78
- "testdouble": "^3.16.1"
79
- },
80
- "resolutions": {
81
- "minimist": "^1.2.5"
76
+ "chai": "^4.3.7",
77
+ "eslint": "^8.44.0",
78
+ "eslint-config-airbnb-base": "^15.0.0",
79
+ "eslint-plugin-import": "^2.27.5",
80
+ "eslint-plugin-json": "^3.1.0",
81
+ "testdouble": "^3.18.0"
82
82
  },
83
83
  "private": false
84
84
  }