@itentialopensource/adapter-redis_cloud 0.1.1 → 0.2.1

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.
package/adapterBase.js CHANGED
@@ -1027,6 +1027,24 @@ class AdapterBase extends EventEmitterCl {
1027
1027
  return this.requestHandlerInst.hasEntities(entityType, entityList, callback);
1028
1028
  }
1029
1029
 
1030
+ /**
1031
+ * @summary Determines if this adapter supports any in a list of entities
1032
+ *
1033
+ * @function hasEntitiesAuth
1034
+ * @param {String} entityType - the entity type to check for
1035
+ * @param {Array} entityList - the list of entities we are looking for
1036
+ * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
1037
+ *
1038
+ * @param {Callback} callback - A map where the entity is the key and the
1039
+ * value is true or false
1040
+ */
1041
+ hasEntitiesAuth(entityType, entityList, callOptions, callback) {
1042
+ const origin = `${this.id}-adapterBase-hasEntitiesAuth`;
1043
+ log.trace(origin);
1044
+
1045
+ return this.requestHandlerInst.hasEntitiesAuth(entityType, entityList, callOptions, callback);
1046
+ }
1047
+
1030
1048
  /**
1031
1049
  * @summary Get Appliance that match the deviceName
1032
1050
  *
@@ -1043,6 +1061,23 @@ class AdapterBase extends EventEmitterCl {
1043
1061
  return this.requestHandlerInst.getDevice(deviceName, callback);
1044
1062
  }
1045
1063
 
1064
+ /**
1065
+ * @summary Get Appliance that match the deviceName
1066
+ *
1067
+ * @function getDeviceAuth
1068
+ * @param {String} deviceName - the deviceName to find (required)
1069
+ * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
1070
+ *
1071
+ * @param {getCallback} callback - a callback function to return the result
1072
+ * (appliance) or the error
1073
+ */
1074
+ getDeviceAuth(deviceName, callOptions, callback) {
1075
+ const origin = `${this.id}-adapterBase-getDeviceAuth`;
1076
+ log.trace(origin);
1077
+
1078
+ return this.requestHandlerInst.getDeviceAuth(deviceName, callOptions, callback);
1079
+ }
1080
+
1046
1081
  /**
1047
1082
  * @summary Get Appliances that match the filter
1048
1083
  *
@@ -1059,6 +1094,23 @@ class AdapterBase extends EventEmitterCl {
1059
1094
  return this.requestHandlerInst.getDevicesFiltered(options, callback);
1060
1095
  }
1061
1096
 
1097
+ /**
1098
+ * @summary Get Appliances that match the filter
1099
+ *
1100
+ * @function getDevicesFilteredAuth
1101
+ * @param {Object} options - the data to use to filter the appliances (optional)
1102
+ * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
1103
+ *
1104
+ * @param {getCallback} callback - a callback function to return the result
1105
+ * (appliances) or the error
1106
+ */
1107
+ getDevicesFilteredAuth(options, callOptions, callback) {
1108
+ const origin = `${this.id}-adapterBase-getDevicesFilteredAuth`;
1109
+ log.trace(origin);
1110
+
1111
+ return this.requestHandlerInst.getDevicesFilteredAuth(options, callOptions, callback);
1112
+ }
1113
+
1062
1114
  /**
1063
1115
  * @summary Gets the status for the provided appliance
1064
1116
  *
@@ -1075,6 +1127,23 @@ class AdapterBase extends EventEmitterCl {
1075
1127
  return this.requestHandlerInst.isAlive(deviceName, callback);
1076
1128
  }
1077
1129
 
1130
+ /**
1131
+ * @summary Gets the status for the provided appliance
1132
+ *
1133
+ * @function isAliveAuth
1134
+ * @param {String} deviceName - the deviceName of the appliance. (required)
1135
+ * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
1136
+ *
1137
+ * @param {configCallback} callback - callback function to return the result
1138
+ * (appliance isAliveAuth) or the error
1139
+ */
1140
+ isAliveAuth(deviceName, callOptions, callback) {
1141
+ const origin = `${this.id}-adapterBase-isAliveAuth`;
1142
+ log.trace(origin);
1143
+
1144
+ return this.requestHandlerInst.isAliveAuth(deviceName, callOptions, callback);
1145
+ }
1146
+
1078
1147
  /**
1079
1148
  * @summary Gets a config for the provided Appliance
1080
1149
  *
@@ -1092,6 +1161,24 @@ class AdapterBase extends EventEmitterCl {
1092
1161
  return this.requestHandlerInst.getConfig(deviceName, format, callback);
1093
1162
  }
1094
1163
 
1164
+ /**
1165
+ * @summary Gets a config for the provided Appliance
1166
+ *
1167
+ * @function getConfigAuth
1168
+ * @param {String} deviceName - the deviceName of the appliance. (required)
1169
+ * @param {String} format - the desired format of the config. (optional)
1170
+ * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
1171
+ *
1172
+ * @param {configCallback} callback - callback function to return the result
1173
+ * (appliance config) or the error
1174
+ */
1175
+ getConfigAuth(deviceName, format, callOptions, callback) {
1176
+ const origin = `${this.id}-adapterBase-getConfigAuth`;
1177
+ log.trace(origin);
1178
+
1179
+ return this.requestHandlerInst.getConfigAuth(deviceName, format, callOptions, callback);
1180
+ }
1181
+
1095
1182
  /**
1096
1183
  * @summary Gets the device count from the system
1097
1184
  *
@@ -1107,6 +1194,22 @@ class AdapterBase extends EventEmitterCl {
1107
1194
  return this.requestHandlerInst.iapGetDeviceCount(callback);
1108
1195
  }
1109
1196
 
1197
+ /**
1198
+ * @summary Gets the device count from the system
1199
+ *
1200
+ * @function iapGetDeviceCountAuth
1201
+ * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
1202
+ *
1203
+ * @param {getCallback} callback - callback function to return the result
1204
+ * (count) or the error
1205
+ */
1206
+ iapGetDeviceCountAuth(callOptions, callback) {
1207
+ const origin = `${this.id}-adapterBase-iapGetDeviceCountAuth`;
1208
+ log.trace(origin);
1209
+
1210
+ return this.requestHandlerInst.iapGetDeviceCountAuth(callOptions, callback);
1211
+ }
1212
+
1110
1213
  /* ********************************************** */
1111
1214
  /* */
1112
1215
  /* EXPOSES GENERIC HANDLER */
@@ -0,0 +1,9 @@
1
+
2
+ ## 0.1.1 [08-17-2023]
3
+
4
+ * Bug fixes and performance improvements
5
+
6
+ See commit c2e2675
7
+
8
+ ---
9
+
package/metadata.json CHANGED
@@ -1,51 +1,55 @@
1
1
  {
2
- "name": "adapter-redis_cloud",
3
- "vendor": "Redis",
4
- "product": "Redis",
5
- "osVersion": [
6
- "v1"
7
- ],
8
- "apiVersions": [
9
- "v1"
10
- ],
11
- "iapVersions": [
12
- "2021.1.x",
13
- "2021.2.x",
14
- "2022.1.x",
15
- "2023.1.x"
16
- ],
17
- "method": "REST API",
18
- "type": "Adapter",
19
- "example": "",
20
- "domains": [
21
- "Persistence"
22
- ],
23
- "tags": [],
24
- "deprecated": {
25
- "isDeprecated": false
26
- },
27
- "brokerSince": "",
28
- "documentation": {
29
- "storeLink": "",
30
- "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-redis_cloud",
31
- "repoLink": "https://gitlab.com/itentialopensource/adapters/persistence/adapter-redis_cloud.git",
32
- "docLink": "",
33
- "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
34
- "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
35
- "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
36
- "webLink": "https://www.itential.com/adapters/redis-cloud/",
37
- "vendorLink": "https://redis.com/",
38
- "productLink": "https://redis.com/",
39
- "apiLinks": [
40
- "https://api.redislabs.com/v1/swagger-ui/index.html"
41
- ]
42
- },
43
- "relatedItems": {
44
- "adapters": [],
45
- "integrations": [],
46
- "ecosystemApplications": [],
47
- "automations": [],
48
- "transformations": [],
49
- "useCases": []
50
- }
2
+ "name": "adapter-redis_cloud",
3
+ "webName": "Adapter for Integration to Redis Cloud",
4
+ "vendor": "Redis",
5
+ "product": "Cloud",
6
+ "osVersion": [
7
+ "v1"
8
+ ],
9
+ "apiVersions": [
10
+ "v1"
11
+ ],
12
+ "iapVersions": [
13
+ "2021.1.x",
14
+ "2021.2.x",
15
+ "2022.1.x",
16
+ "2023.1.x"
17
+ ],
18
+ "method": "REST",
19
+ "type": "Adapter",
20
+ "domains": [
21
+ "Data Storage"
22
+ ],
23
+ "tags": [],
24
+ "useCases": [],
25
+ "deprecated": {
26
+ "isDeprecated": false
27
+ },
28
+ "brokerSince": "",
29
+ "documentation": {
30
+ "storeLink": "",
31
+ "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-redis_cloud",
32
+ "repoLink": "https://gitlab.com/itentialopensource/adapters/persistence/adapter-redis_cloud",
33
+ "docLink": "",
34
+ "demoLinks": [],
35
+ "trainingLinks": [],
36
+ "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
37
+ "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
38
+ "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
39
+ "webLink": "",
40
+ "vendorLink": "https://redis.com/",
41
+ "productLink": "https://redis.com/",
42
+ "apiLinks": [
43
+ "https://api.redislabs.com/v1/swagger-ui/index.html"
44
+ ]
45
+ },
46
+ "assets": [],
47
+ "relatedItems": {
48
+ "adapters": [],
49
+ "integrations": [],
50
+ "ecosystemApplications": [],
51
+ "workflowProjects": [],
52
+ "transformationProjects": [],
53
+ "exampleProjects": []
54
+ }
51
55
  }
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@itentialopensource/adapter-redis_cloud",
3
- "version": "0.1.1",
3
+ "version": "0.2.1",
4
4
  "description": "This adapter integrates with system described as: redisCloud.",
5
5
  "main": "adapter.js",
6
6
  "wizardVersion": "2.44.7",
7
- "engineVersion": "1.67.5",
7
+ "engineVersion": "1.67.14",
8
8
  "adapterType": "http",
9
9
  "scripts": {
10
10
  "artifactize": "npm i && node utils/packModificationScript.js",
@@ -54,23 +54,23 @@
54
54
  "author": "Itential",
55
55
  "homepage": "https://gitlab.com/itentialopensource/adapters/persistence/adapter-redis_cloud#readme",
56
56
  "dependencies": {
57
- "@itentialopensource/adapter-utils": "^5.1.0",
57
+ "@itentialopensource/adapter-utils": "^5.3.2",
58
+ "acorn": "^8.10.0",
58
59
  "ajv": "^8.12.0",
59
- "axios": "^1.4.0",
60
+ "axios": "^1.6.3",
60
61
  "commander": "^11.0.0",
61
62
  "dns-lookup-promise": "^1.0.4",
62
- "esprima": "^4.0.1",
63
63
  "fs-extra": "^11.1.1",
64
64
  "json-query": "^2.2.2",
65
65
  "mocha": "^10.2.0",
66
66
  "mocha-param": "^2.0.1",
67
67
  "mongodb": "^4.16.0",
68
68
  "nyc": "^15.1.0",
69
+ "ping": "^0.4.4",
70
+ "prompts": "^2.4.2",
69
71
  "readline-sync": "^1.4.10",
70
72
  "semver": "^7.5.3",
71
- "winston": "^3.9.0",
72
- "prompts": "^2.4.2",
73
- "ping": "^0.4.4"
73
+ "winston": "^3.9.0"
74
74
  },
75
75
  "devDependencies": {
76
76
  "chai": "^4.3.7",
package/pronghorn.json CHANGED
@@ -988,7 +988,7 @@
988
988
  "path": "/iapGetAdapterInventory"
989
989
  },
990
990
  "task": true
991
- },
991
+ },
992
992
  {
993
993
  "name": "getUserById",
994
994
  "summary": "Get user by id",
@@ -83,6 +83,14 @@
83
83
  "https"
84
84
  ]
85
85
  },
86
+ "service": {
87
+ "type": "string",
88
+ "description": "Service we are integrating with -- used with AWS Authentication",
89
+ "examples": [
90
+ "ec2",
91
+ "route53"
92
+ ]
93
+ },
86
94
  "authentication": {
87
95
  "$ref": "#/definitions/authentication"
88
96
  },
@@ -131,7 +139,8 @@
131
139
  "jwt_token",
132
140
  "request_token",
133
141
  "no_authentication",
134
- "multi_step_authentication"
142
+ "multi_step_authentication",
143
+ "aws_authentication"
135
144
  ]
136
145
  },
137
146
  "username": {
@@ -1063,6 +1072,38 @@
1063
1072
  "description": "The method of the call to getDevicesFiltered",
1064
1073
  "default": "GET"
1065
1074
  },
1075
+ "pagination": {
1076
+ "type": "object",
1077
+ "description": "todo",
1078
+ "properties": {
1079
+ "offsetVar": {
1080
+ "type": "string",
1081
+ "description": "Name of variable that defines how to go to next set of results"
1082
+ },
1083
+ "limitVar": {
1084
+ "type": "string",
1085
+ "description": "Name of variable that defines the max results returned in a request"
1086
+ },
1087
+ "incrementBy": {
1088
+ "type": "string",
1089
+ "enum": [
1090
+ "limit",
1091
+ "page"
1092
+ ],
1093
+ "description": "How to incremenet offset. Default limit",
1094
+ "default": "limit"
1095
+ },
1096
+ "requestLocation": {
1097
+ "type": "string",
1098
+ "enum": [
1099
+ "query",
1100
+ "body"
1101
+ ],
1102
+ "description": "Where in request the pagination data goes",
1103
+ "default": "query"
1104
+ }
1105
+ }
1106
+ },
1066
1107
  "query": {
1067
1108
  "type": "object",
1068
1109
  "description": "The json object with query parameters of the call to getDevicesFiltered",
@@ -1487,6 +1528,38 @@
1487
1528
  "description": "The method of the call to getDevice",
1488
1529
  "default": "GET"
1489
1530
  },
1531
+ "pagination": {
1532
+ "type": "object",
1533
+ "description": "todo",
1534
+ "properties": {
1535
+ "offsetVar": {
1536
+ "type": "string",
1537
+ "description": "Name of variable that defines how to go to next set of results"
1538
+ },
1539
+ "limitVar": {
1540
+ "type": "string",
1541
+ "description": "Name of variable that defines the max results returned in a request"
1542
+ },
1543
+ "incrementBy": {
1544
+ "type": "string",
1545
+ "enum": [
1546
+ "limit",
1547
+ "page"
1548
+ ],
1549
+ "description": "How to incremenet offset. Default limit",
1550
+ "default": "limit"
1551
+ },
1552
+ "requestLocation": {
1553
+ "type": "string",
1554
+ "enum": [
1555
+ "query",
1556
+ "body"
1557
+ ],
1558
+ "description": "Where in request the pagination data goes",
1559
+ "default": "query"
1560
+ }
1561
+ }
1562
+ },
1490
1563
  "query": {
1491
1564
  "type": "object",
1492
1565
  "description": "The json object with query parameters of the call to getDevice",
Binary file