Merge pull request #200 from gjsjohnmurray/do-182

Extend `intersystems.servers` objects to contain optional `superServer` object

Author: gjsjohnmurray

package-lock.json

@@ -50,7 +50,7 @@
     "tough-cookie": "^4.1.3"
   },
   "devDependencies": {
-    "@intersystems-community/intersystems-servermanager": "latest",
+    "@intersystems-community/intersystems-servermanager": "^3.4.1",
     "@types/vscode": "^1.75.0",
     "@types/glob": "^7.1.1",
     "@types/mocha": "^9.0.0",
@@ -181,6 +181,38 @@
                     ],
                     "additionalProperties": false
                   },
+                  "superServer": {
+                    "type": "object",
+                    "description": "InterSystems server's superserver.",
+                    "properties": {
+                      "host": {
+                        "type": "string",
+                        "description": "Hostname or IP address of the InterSystems server. If omitted, uses the value of 'webServer.host'.",
+                        "anyOf": [
+                          {
+                            "format": "hostname"
+                          },
+                          {
+                            "format": "ipv4"
+                          },
+                          {
+                            "format": "ipv6"
+                          }
+                        ]
+                      },
+                      "port": {
+                        "type": "integer",
+                        "description": "TCP port number the superserver listens on.",
+                        "minimum": 1,
+                        "maximum": 65535,
+                        "default": 1972
+                      }
+                    },
+                    "required": [
+                      "port"
+                    ],
+                    "additionalProperties": false
+                  },
                   "username": {
                     "type": "string",
                     "description": "Username to connect as. If not set here it must be provided when connecting."

package.json

@@ -38,6 +38,10 @@ export async function getServerSpec(
 	server.webServer.scheme = server.webServer.scheme || "http";
 	server.webServer.port = server.webServer.port || (server.webServer.scheme === "https" ? 443 : 80);
 	server.webServer.pathPrefix = server.webServer.pathPrefix || "";
+	if (server.superServer) {
+		// Fall back to default if appropriate
+		server.superServer.host = server.superServer.host || server.webServer.host;
+	}
 
 
 	// When authentication provider is being used we should only have a password if it came from the deprecated

src/api/getServerSpec.ts

@@ -6,6 +6,10 @@ Package defining the interfaces used in the API that is published by the `inters
 
 # Changelog
 
+### v3.4.1
+
+- Add optional `superServer` object.
+
 ### v3.0.4
 
 - Export constants correctly.

types/README.md

@@ -14,8 +14,14 @@ export interface IWebServerSpec {
 	pathPrefix?: string;
 }
 
+export interface ISuperServerSpec {
+	host?: string;
+	port: number;
+}
+
 export interface IJSONServerSpec {
 	webServer: IWebServerSpec;
+	superServer?: ISuperServerSpec;
 	username?: string;
 	password?: string;
 	description?: string;

types/index.d.ts

@@ -1,6 +1,6 @@
 {
   "name": "@intersystems-community/intersystems-servermanager",
-  "version": "3.0.4",
+  "version": "3.4.1",
   "description": "InterSystems Server Manager VS Code extension API interfaces and constants",
   "types": "index.d.ts",
   "main": "index.js",