@itentialopensource/adapter-utils 6.1.7 → 6.1.9

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 (2) hide show
  1. package/package.json +1 -1
  2. package/schemas/propertiesSchema.json +74 -13
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@itentialopensource/adapter-utils",
3
- "version": "6.1.7",
3
+ "version": "6.1.9",
4
4
  "description": "Itential Adapter Utility Libraries",
5
5
  "scripts": {
6
6
  "postinstall": "node utils/setup.js",
package/schemas/propertiesSchema.json CHANGED
@@ -904,6 +904,14 @@
904
904
  "security/ca.pem"
905
905
  ]
906
906
  },
907
+ "ca_file_content": {
908
+ "type": "string",
909
+ "description": "The content of the CA file used for SSL",
910
+ "default": "",
911
+ "examples": [
912
+ "-----BEGIN CERTIFICATE-----"
913
+ ]
914
+ },
907
915
  "key_file": {
908
916
  "type": "string",
909
917
  "description": "The fully qualified path name to the key file used for SSL",
@@ -993,32 +1001,48 @@
993
1001
  "mongo": {
994
1002
  "type": "object",
995
1003
  "properties": {
1004
+ "url": {
1005
+ "type": "string",
1006
+ "description": "Mongo's complete connection URL. This property overrides host, port, database, username, password and replSet settings.",
1007
+ "examples": [
1008
+ "mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]",
1009
+ "mongodb+srv://[username:password@]cluster0.xxxxx.mongodb.net/[defaultauthdb][?options]",
1010
+ "mongodb+srv://cluster0.xxxxx.mongodb.net/[defaultauthdb][?options]"
1011
+ ]
1012
+ },
996
1013
  "host": {
997
1014
  "type": "string",
998
- "description": "host where mongo database can be found",
1015
+ "description": "Host information for the Mongo server",
999
1016
  "default": "",
1000
1017
  "examples": [
1001
- "localhost"
1018
+ "localhost",
1019
+ "cluster0.xxxxx.mongodb.net",
1020
+ "my-cluster.example.com"
1002
1021
  ]
1003
1022
  },
1004
1023
  "port": {
1005
1024
  "type": "integer",
1006
- "description": "port on which to connect to the mongo database",
1025
+ "description": "Port information for the Mongo server. Not used when using mongodb+srv:// protocol",
1007
1026
  "default": 443,
1008
1027
  "minimum": 0,
1009
1028
  "maximum": 65535
1010
1029
  },
1011
1030
  "database": {
1012
1031
  "type": "string",
1013
- "description": "The name of the database to store adapter information in",
1032
+ "description": "The database for the adapter to use for its data.",
1014
1033
  "default": "",
1015
1034
  "examples": [
1016
1035
  "adapter-xyz"
1017
1036
  ]
1018
1037
  },
1038
+ "dbAuth": {
1039
+ "type": "boolean",
1040
+ "description": "Whether to use authentication for MongoDB connection. Default is false.",
1041
+ "default": false
1042
+ },
1019
1043
  "username": {
1020
1044
  "type": "string",
1021
- "description": "The user to connect to the database with",
1045
+ "description": "If credentials are required to access Mongo, this is the user to login as.",
1022
1046
  "default": "",
1023
1047
  "examples": [
1024
1048
  "username"
@@ -1026,7 +1050,7 @@
1026
1050
  },
1027
1051
  "password": {
1028
1052
  "type": "string",
1029
- "description": "The password to connect to the database with",
1053
+ "description": "If credentials are required to access Mongo, this is the password to login with.",
1030
1054
  "default": "",
1031
1055
  "examples": [
1032
1056
  "password"
@@ -1034,12 +1058,17 @@
1034
1058
  },
1035
1059
  "replSet": {
1036
1060
  "type": "string",
1037
- "description": "The replica set for the database",
1061
+ "description": "If the database is set up to use replica sets, define it here so it can be added to the database connection. Not used when using mongodb+srv:// protocol",
1038
1062
  "default": "",
1039
1063
  "examples": [
1040
1064
  "my_repolica_set"
1041
1065
  ]
1042
1066
  },
1067
+ "addSrv": {
1068
+ "type": "boolean",
1069
+ "description": "Whether the connection requires the mongodb+srv:// protocol. If true, uses mongodb+srv:// protocol. Note: mongodb+srv:// can also be used for non-Atlas deployments that support DNS SRV records",
1070
+ "default": false
1071
+ },
1043
1072
  "db_ssl": {
1044
1073
  "type": "object",
1045
1074
  "description": "SSL for mongo database connection",
@@ -1080,6 +1109,38 @@
1080
1109
  }
1081
1110
  }
1082
1111
  }
1112
+ },
1113
+ "dependencies": {
1114
+ "dbAuth": {
1115
+ "oneOf": [
1116
+ {
1117
+ "properties": {
1118
+ "dbAuth": {
1119
+ "const": false
1120
+ }
1121
+ }
1122
+ },
1123
+ {
1124
+ "properties": {
1125
+ "dbAuth": {
1126
+ "const": true
1127
+ },
1128
+ "username": {
1129
+ "type": "string",
1130
+ "minLength": 1
1131
+ },
1132
+ "password": {
1133
+ "type": "string",
1134
+ "minLength": 1
1135
+ }
1136
+ },
1137
+ "required": [
1138
+ "username",
1139
+ "password"
1140
+ ]
1141
+ }
1142
+ ]
1143
+ }
1083
1144
  }
1084
1145
  },
1085
1146
  "devicebroker": {
@@ -1147,7 +1208,7 @@
1147
1208
  },
1148
1209
  "requestFields": {
1149
1210
  "type": "object",
1150
- "description": "The json object with response fields of the call to getDevice",
1211
+ "description": "The json object with request fields of the call to getDevice",
1151
1212
  "additionalProperties": {
1152
1213
  "type": [
1153
1214
  "string",
@@ -1290,7 +1351,7 @@
1290
1351
  },
1291
1352
  "requestFields": {
1292
1353
  "type": "object",
1293
- "description": "The json object with response fields of the call to getDevice",
1354
+ "description": "The json object with request fields of the call to getDevice",
1294
1355
  "additionalProperties": {
1295
1356
  "type": [
1296
1357
  "string",
@@ -1401,7 +1462,7 @@
1401
1462
  },
1402
1463
  "requestFields": {
1403
1464
  "type": "object",
1404
- "description": "The json object with response fields of the call to getDevice",
1465
+ "description": "The json object with request fields of the call to getDevice",
1405
1466
  "additionalProperties": {
1406
1467
  "type": [
1407
1468
  "string",
@@ -1497,7 +1558,7 @@
1497
1558
  },
1498
1559
  "requestFields": {
1499
1560
  "type": "object",
1500
- "description": "The json object with response fields of the call to getDevice",
1561
+ "description": "The json object with request fields of the call to getDevice",
1501
1562
  "additionalProperties": {
1502
1563
  "type": [
1503
1564
  "string",
@@ -1582,7 +1643,7 @@
1582
1643
  },
1583
1644
  "requestFields": {
1584
1645
  "type": "object",
1585
- "description": "The json object with response fields of the call to getDevice",
1646
+ "description": "The json object with request fields of the call to getDevice",
1586
1647
  "additionalProperties": {
1587
1648
  "type": [
1588
1649
  "string",
@@ -1746,7 +1807,7 @@
1746
1807
  },
1747
1808
  "requestFields": {
1748
1809
  "type": "object",
1749
- "description": "The json object with response fields of the call to populate the cache",
1810
+ "description": "The json object with request fields of the call to populate the cache",
1750
1811
  "additionalProperties": {
1751
1812
  "type": [
1752
1813
  "string",