initial support for server's settings from intersystems.servers

Author: daimor

package.json

@@ -445,66 +445,96 @@
         "objectscript.conn": {
           "type": "object",
           "description": "Server Access",
-          "scope": "resource"
-        },
-        "objectscript.conn.active": {
-          "description": "Active",
-          "type": "boolean",
-          "default": false
-        },
-        "objectscript.conn.host": {
-          "description": "Hostname",
-          "format": "hostname",
-          "type": "string",
-          "default": "localhost"
-        },
-        "objectscript.conn.port": {
-          "description": "Port number",
-          "type": "number",
-          "default": 52773
-        },
-        "objectscript.conn.username": {
-          "description": "Username",
-          "type": "string",
-          "default": "_SYSTEM"
-        },
-        "objectscript.conn.password": {
-          "description": "User's Password",
-          "type": "string",
-          "default": "SYS"
-        },
-        "objectscript.conn.ns": {
-          "description": "Server Namespace",
-          "type": "string",
-          "default": "USER"
-        },
-        "objectscript.conn.https": {
-          "description": "Use SSL to access to API",
-          "type": "boolean",
-          "default": false
-        },
-        "objectscript.conn.docker-compose": {
-          "description": "Connect to server running in docker-compose",
-          "type": "object",
-          "scope": "resource"
-        },
-        "objectscript.conn.docker-compose.service": {
-          "description": "Name of service in docker-compose",
-          "type": "string"
-        },
-        "objectscript.conn.docker-compose.internalPort": {
-          "description": "Target port inside the service in docker-compose",
-          "type": "number",
-          "default": 52773
-        },
-        "objectscript.conn.docker-compose.file": {
-          "description": "docker-compose file",
-          "type": "string",
-          "default": "docker-compose.yml"
-        },
-        "objectscript.conn.links": {
-          "description": "Extra links for the server",
-          "type": "object"
+          "scope": "resource",
+          "additionalProperties": false,
+          "default": {
+            "active": true,
+            "host": "localhost",
+            "port": 52773,
+            "ns": "USER"
+          },
+          "required": [
+            "active"
+          ],
+          "properties": {
+            "active": {
+              "type": "boolean",
+              "description": "This connection is active"
+            },
+            "server": {
+              "type": "string",
+              "pattern": "^[A-Za-z0-9-._~]+$",
+              "markdownDescription": "Server defined in `intersystems.servers`"
+            },
+            "host": {
+              "type": "string",
+              "description": "Hostname or IP address of the web server.",
+              "anyOf": [
+                {
+                  "format": "hostname"
+                },
+                {
+                  "format": "ipv4"
+                },
+                {
+                  "format": "ipv6"
+                }
+              ],
+              "default": "localhost"
+            },
+            "port": {
+              "type": "integer",
+              "description": "TCP port number the web server listens on.",
+              "minimum": 1,
+              "maximum": 65535,
+              "default": 52773
+            },
+            "ns": {
+              "description": "Server Namespace",
+              "type": "string",
+              "default": "USER"
+            },
+            "username": {
+              "type": "string",
+              "description": "Username to connect as. If not set here it must be provided when connecting.",
+              "default": "_SYSTEM"
+            },
+            "password": {
+              "type": "string",
+              "description": "Password of username. If not set here it must be provided when connecting.",
+              "default": "SYS"
+            },
+            "https": {
+              "description": "Use SSL to access to API",
+              "type": "boolean",
+              "default": false
+            },
+            "links": {
+              "description": "Extra links for the server",
+              "type": "object"
+            },
+            "docker-compose": {
+              "type": "object",
+              "description": "Connect to server running in docker-compose",
+              "additionalProperties": false,
+              "properties": {
+                "service": {
+                  "description": "Name of service in docker-compose",
+                  "type": "string"
+                },
+                "internalPort": {
+                  "description": "Target port inside the service in docker-compose",
+                  "type": "number",
+                  "default": 52773
+                },
+                "file": {
+                  "description": "docker-compose file",
+                  "type": "string",
+                  "default": "docker-compose.yml"
+                }
+              }
+            }
+          }
         },
         "objectscript.export": {
           "type": "object",

src/api/atelier.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Atelier API
+ */
+
+interface ResponseStatus {
+  errors: string[];
+  summary: string;
+}
+
+interface ResponseResult<T> {
+  content: T;
+}
+
+export interface Response<T = any> {
+  status: ResponseStatus;
+  console: string[];
+  result: ResponseResult<T>;
+}
+
+interface ServerInfoFeature {
+  name: string;
+  enabled: string;
+}
+
+export interface ServerInfo {
+  version: string;
+  id: string;
+  api: number;
+  features: ServerInfoFeature[];
+  namespaces: string[];
+}
+
+export interface AtelierSearchMatch {
+  text: string;
+  line?: number;
+  member?: string;
+  attr?: string;
+  attrline?: number;
+}
+
+export interface AtelierSearchResult {
+  doc: string;
+  matches: AtelierSearchMatch[];
+}
+
+export interface AtelierJob {
+  pid: number;
+  namespace: string;
+  routine: string;
+  state: string;
+  device: string;
+}