Support importing/exporting XML files (intersystems-community#1171)

Author: isc-bsaviano

docs/Studio.md

@@ -48,6 +48,10 @@ The [InterSystems ObjectScript extension](https://marketplace.visualstudio.com/i
 
 The [InterSystems ObjectScript extension](https://marketplace.visualstudio.com/items?itemName=intersystems-community.vscode-objectscript) provides commands for creating new Interoperability classes. Commands are provided for Business Operation, Business Process, Business Rule, Business Service and Data Transformation classes. These commands are modeled after the wizards in Studio's [`File` → `New...` → `Production` menu](https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GSTD_Commands#GSTD_Commands_File). The commands are shown in the `New File...` menu, which can be opened from the `File` menu (`File` → `New File...`) or the `Get Started` welcome page.
 
+## XML Import/Export Commands
+
+The [InterSystems ObjectScript extension](https://marketplace.visualstudio.com/items?itemName=intersystems-community.vscode-objectscript) provides commands for importing and exporting XML files. The commands can be invoked from [the command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) under the titles `Import XML Files...` and `Export Documents to XML File...`. These commands require an active server connection (the one from the currently opened document will be used if one is open), and the server's version must be 2023.2 or greater.
+
 ## Keyboard Shortcuts
 
 In general, VS Code keyboard shortcuts are infinitely customizable <a href="https://code.visualstudio.com/docs/getstarted/keybindings">as described in the docs</a>. However, the IDE comes configured with a number of shortcuts that match Studio. <a href="https://code.visualstudio.com/docs/getstarted/keybindings#_keyboard-shortcuts-reference">Download a cheat sheet here</a>.  

package.json

@@ -91,6 +91,8 @@
     "onCommand:vscode-objectscript.openErrorLocation",
     "onCommand:vscode-objectscript.launchWebSocketTerminal",
     "onCommand:vscode-objectscript.intersystems-servermanager.webterminal",
+    "onCommand:vscode-objectscript.importXMLFiles",
+    "onCommand:vscode-objectscript.exportToXMLFile",
     "onTerminalProfile:vscode-objectscript.webSocketTerminal",
     "onLanguage:objectscript",
     "onLanguage:objectscript-int",
@@ -355,6 +357,14 @@
         {
           "command": "vscode-objectscript.intersystems-servermanager.webterminal",
           "when": "false"
+        },
+        {
+          "command": "vscode-objectscript.importXMLFiles",
+          "when": "vscode-objectscript.connectActive && workspaceFolderCount != 0"
+        },
+        {
+          "command": "vscode-objectscript.exportToXMLFile",
+          "when": "vscode-objectscript.connectActive && workspaceFolderCount != 0"
         }
       ],
       "view/title": [
@@ -1146,6 +1156,16 @@
         "command": "vscode-objectscript.intersystems-servermanager.webterminal",
         "title": "Launch WebSocket Terminal",
         "icon": "$(terminal)"
+      },
+      {
+        "category": "ObjectScript",
+        "command": "vscode-objectscript.importXMLFiles",
+        "title": "Import XML Files..."
+      },
+      {
+        "category": "ObjectScript",
+        "command": "vscode-objectscript.exportToXMLFile",
+        "title": "Export Documents to XML File..."
       }
     ],
     "keybindings": [

src/api/index.ts

@@ -240,6 +240,12 @@ export class AtelierAPI {
     );
   }
 
+  /** Return the server's name in `intersystems.servers` if it exists, else its `host:port/pathPrefix` */
+  public get serverId(): string {
+    const { serverName, host, port, pathPrefix } = this.config;
+    return serverName && serverName !== "" ? serverName : `${host}:${port}${pathPrefix}`;
+  }
+
   public async request(
     minVersion: number,
     method: string,
@@ -723,4 +729,25 @@ export class AtelierAPI {
   public async getCSPDebugId(): Promise<Atelier.Response<Atelier.Content<number>>> {
     return this.request(2, "GET", "%SYS/cspdebugid");
   }
+
+  // v7+
+  public async actionXMLExport(body: string[]): Promise<Atelier.Response<Atelier.Content<string[]>>> {
+    return this.request(7, "POST", `${this.ns}/action/xml/export`, body);
+  }
+
+  // v7+
+  public async actionXMLLoad(
+    body: { file: string; content: string[]; selected?: string[] }[]
+  ): Promise<Atelier.Response<Atelier.Content<{ file: string; imported: string[]; status: string }[]>>> {
+    return this.request(7, "POST", `${this.ns}/action/xml/load`, body);
+  }
+
+  // v7+
+  public async actionXMLList(
+    body: { file: string; content: string[] }[]
+  ): Promise<
+    Atelier.Response<Atelier.Content<{ file: string; documents: { name: string; ts: string }[]; status: string }[]>>
+  > {
+    return this.request(7, "POST", `${this.ns}/action/xml/list`, body);
+  }
 }