README.md: document the UI WS server configuration section

Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>

diff --git a/README.md b/README.md
index 7a54bf208443a863e7f41339e969a5f024eac1c8..42f8f85eaf56f3a45868f27e6b115fe704489655 100644 (file)
--- a/README.md
+++ b/README.md
@@ -64,8 +64,9 @@ logRotate | true/false | true | boolean | enable daily log files rotation
 logMaxFiles | | 7 | integer | maximum number of log files to keep
 logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | winston logging level
 logFile | | combined.log | string | log file relative path
-logErrorFile | | error.log | string | error log file relative path 
-performanceStorage | | { "enabled": false, "type": "jsonfile", "file:///performanceRecords.json" } | { enabled: string; type: string; URI: string; } where type can be 'jsonfile' or 'mongodb' | performance storage configuration section
+logErrorFile | | error.log | string | error log file relative path
+uiWebSocketServer | | { "enabled": true, "options": { "host: "localhost", "port": 80 } } | { enabled: boolean; options: ServerOptions; } | UI WebSocket server configuration section 
+performanceStorage | | { "enabled": false, "type": "jsonfile", "file:///performanceRecords.json" } | { enabled: boolean; type: string; URI: string; } where type can be 'jsonfile' or 'mongodb' | performance storage configuration section
 stationTemplateURLs | | {}[] | { file: string; numberOfStations: number; }[] | array of charging station templates URIs configuration section (template file name and number of stations)
 
 #### Worker process model: 

diff --git a/package-lock.json b/package-lock.json
index a735b957e9f6a6009a0919b22de5336d04de0f34..654ee535aa7c2fa923f6c82293a5b612e8f65849 100644 (file)
--- a/package-lock.json
+++ b/package-lock.json
@@ -1277,6 +1277,14 @@
         "comment-parser": "1.2.4",
         "esquery": "^1.4.0",
         "jsdoc-type-pratt-parser": "2.0.0"
+      },
+      "dependencies": {
+        "comment-parser": {
+          "version": "1.2.4",
+          "resolved": "https://registry.npmjs.org/comment-parser/-/comment-parser-1.2.4.tgz",
+          "integrity": "sha512-pm0b+qv+CkWNriSTMsfnjChF9kH0kxz55y44Wo5le9qLxMj5xDQAaEd9ZN1ovSuk9CsrncWaFwgpOMg7ClJwkw==",
+          "dev": true
+        }
       }
     },
     "@eslint/eslintrc": {
@@ -5087,9 +5095,9 @@
       "dev": true
     },
     "comment-parser": {
-      "version": "1.2.4",
-      "resolved": "https://registry.npmjs.org/comment-parser/-/comment-parser-1.2.4.tgz",
-      "integrity": "sha512-pm0b+qv+CkWNriSTMsfnjChF9kH0kxz55y44Wo5le9qLxMj5xDQAaEd9ZN1ovSuk9CsrncWaFwgpOMg7ClJwkw==",
+      "version": "1.3.0",
+      "resolved": "https://registry.npmjs.org/comment-parser/-/comment-parser-1.3.0.tgz",
+      "integrity": "sha512-hRpmWIKgzd81vn0ydoWoyPoALEOnF4wt8yKD35Ib1D6XC2siLiYaiqfGkYrunuKdsXGwpBpHU3+9r+RVw2NZfA==",
       "dev": true
     },
     "commist": {
@@ -6956,31 +6964,37 @@
       }
     },
     "eslint-plugin-jsdoc": {
-      "version": "37.0.3",
-      "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-37.0.3.tgz",
-      "integrity": "sha512-Qg/gIZAfcrM4Qu/JzcnxPGD45Je6wPLFzMZQboeqit/CL4aY6wuzBTkgUMiWXfw/PaPl+sb0GF1XdBlV23ReDA==",
+      "version": "37.1.0",
+      "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-37.1.0.tgz",
+      "integrity": "sha512-DpkFzX5Sqkqzy4MCgowhDXmusWcF1Gn7wYnphdGfWmIkoQr6SwL0jEtltGAVyF5Rj6ACi6ydw0oCCI5hF3yz6w==",
       "dev": true,
       "requires": {
         "@es-joy/jsdoccomment": "0.12.0",
-        "comment-parser": "1.2.4",
-        "debug": "^4.3.2",
+        "comment-parser": "1.3.0",
+        "debug": "^4.3.3",
+        "escape-string-regexp": "^4.0.0",
         "esquery": "^1.4.0",
         "jsdoc-type-pratt-parser": "^2.0.0",
-        "lodash": "^4.17.21",
         "regextras": "^0.8.0",
         "semver": "^7.3.5",
         "spdx-expression-parse": "^3.0.1"
       },
       "dependencies": {
         "debug": {
-          "version": "4.3.2",
-          "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.2.tgz",
-          "integrity": "sha512-mOp8wKcvj7XxC78zLgw/ZA+6TSgkoE2C/ienthhRD298T7UNwAg9diBpLRxC0mOezLl4B0xV7M0cCO6P/O0Xhw==",
+          "version": "4.3.3",
+          "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.3.tgz",
+          "integrity": "sha512-/zxw5+vh1Tfv+4Qn7a5nsbcJKPaSvCDhojn6FEl9vupwK2VCSDtEiEtqr8DFtzYFOdz63LBkxec7DYuc2jon6Q==",
           "dev": true,
           "requires": {
             "ms": "2.1.2"
           }
         },
+        "escape-string-regexp": {
+          "version": "4.0.0",
+          "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz",
+          "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==",
+          "dev": true
+        },
         "lru-cache": {
           "version": "6.0.0",
           "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz",

diff --git a/package.json b/package.json
index acdea7465cb052c6d053e5955ad1d1acd52d2752..db515ae21e48151fa3bb8e919eeb3c93ce92a766 100644 (file)
--- a/package.json
+++ b/package.json
@@ -106,7 +106,7 @@
     "cross-env": "^7.0.3",
     "eslint": "^8.3.0",
     "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-jsdoc": "^37.0.3",
+    "eslint-plugin-jsdoc": "^37.1.0",
     "eslint-plugin-node": "^11.1.0",
     "expect": "^27.4.2",
     "mocha": "^9.1.3",