We now set the api version number based on the value returned from getServer. We also have some checks on the calls to later api methods to warn the user that the calls won't work.

Author: Kenneth Shepherd

Diff for: api/index.ts

@@ -3,18 +3,20 @@ import * as httpsModule from 'https';
 import { outputConsole, currentWorkspaceFolder } from '../utils';
 import { config } from '../extension';
 
+const DEFAULT_API_VERSION: number = 3;
+
 export class AtelierAPI {
   private cookies: string[] = [];
   private _config: any;
   private _namespace: string;
-  private _apiVersion: string;
+  private static _apiVersion: number;
 
   private get ns(): string {
     return this._namespace || this._config.ns;
   }
 
-  private get apiVersion(): string {
-    return this._apiVersion || this._config.apiVersion;
+  private get apiVersion(): number {
+    return AtelierAPI._apiVersion || DEFAULT_API_VERSION;
   }
 
   constructor() {
@@ -25,8 +27,8 @@ export class AtelierAPI {
     this._namespace = namespace;
   }
 
-  setApiVersion(apiVersion: string) {
-    this._apiVersion = apiVersion;
+  setApiVersion(apiVersion: number) {
+    AtelierAPI._apiVersion = apiVersion;
   }
 
   updateCookies(cookies: string[]) {
@@ -143,7 +145,7 @@ export class AtelierAPI {
   serverInfo(): Promise<any> {
     return this.request('GET');
   }
-
+  // api v1+
   getDocNames({
     generated = false,
     category = '*',
@@ -155,63 +157,69 @@ export class AtelierAPI {
     type?: string;
     filter?: string;
   }): Promise<any> {
-    return this.request('GET', `${this.apiVersion}/${this.ns}/docnames/${category}/${type}`, null, {
+    return this.request('GET', `v${this.apiVersion}/${this.ns}/docnames/${category}/${type}`, null, {
       filter,
       generated
     });
   }
-
+  // api v1+
   getDoc(name: string, format?: string): Promise<any> {
     let params = {};
     if (format) {
       params = {
         format
       };
     }
-    return this.request('GET', `${this.apiVersion}/${this.ns}/doc/${name}`, params);
+    return this.request('GET', `v${this.apiVersion}/${this.ns}/doc/${name}`, params);
   }
-
+  // v1+
   putDoc(name: string, data: { enc: boolean; content: string[] }, ignoreConflict?: boolean): Promise<any> {
     let params = { ignoreConflict };
-    return this.request('PUT', `${this.apiVersion}/${this.ns}/doc/${name}`, data, params);
+    return this.request('PUT', `v${this.apiVersion}/${this.ns}/doc/${name}`, data, params);
   }
-
+  // v1+
   actionIndex(docs: string[]): Promise<any> {
-    return this.request('POST', `${this.apiVersion}/${this.ns}/action/index`, docs);
+    return this.request('POST', `v${this.apiVersion}/${this.ns}/action/index`, docs);
   }
-
+  // v2+
   actionSearch(params: { query: string; files?: string; sys?: boolean; gen?: boolean; max?: number }): Promise<any> {
-    return this.request('GET', `${this.apiVersion}/${this.ns}/action/search`, null, params);
+    return this.apiVersion >= 2 ? 
+      this.request('GET', `v${this.apiVersion}/${this.ns}/action/search`, null, params) : 
+      Promise.reject(`Method 'search' not supported by API version ${this.apiVersion}`);
   }
-
+  // v1+
   actionQuery(query: string, parameters: string[]): Promise<any> {
-    return this.request('POST', `${this.apiVersion}/${this.ns}/action/query`, {
+    return this.request('POST', `v${this.apiVersion}/${this.ns}/action/query`, {
       query,
       parameters
     });
   }
-
+  // v1+
   actionCompile(docs: string[], flags?: string, source = false): Promise<any> {
-    return this.request('POST', `${this.apiVersion}/${this.ns}/action/compile`, docs, { flags, source });
+    return this.request('POST', `v${this.apiVersion}/${this.ns}/action/compile`, docs, { flags, source });
   }
 
   cvtXmlUdl(source: string): Promise<any> {
-    return this.request('POST', `${this.apiVersion}/${this.ns}/cvt/xml/doc`, source, {}, { 'Content-Type': 'application/xml' });
+    return this.request('POST', `v${this.apiVersion}/${this.ns}/cvt/xml/doc`, source, {}, { 'Content-Type': 'application/xml' });
   }
-
+  // v2+
   getmacrodefinition(docname: string, macroname: string, includes: string[]) {
-    return this.request('POST', `${this.apiVersion}/${this.ns}/action/getmacrodefinition`, {
-      docname,
-      macroname,
-      includes
-    });
-  }
-
+    return this.apiVersion >= 2 ? 
+      this.request('POST', `v${this.apiVersion}/${this.ns}/action/getmacrodefinition`, {
+        docname,
+        macroname,
+        includes
+      }) :
+      Promise.reject(`Method 'getmacrodefinition' not supported by API version ${this.apiVersion}`);
+  }
+  // v2+
   getmacrolocation(docname: string, macroname: string, includes: string[]) {
-    return this.request('POST', `${this.apiVersion}/${this.ns}/action/getmacrolocation`, {
-      docname,
-      macroname,
-      includes
-    });
+    return this.apiVersion >= 2 ? 
+      this.request('POST', `v${this.apiVersion}/${this.ns}/action/getmacrolocation`, {
+        docname,
+        macroname,
+        includes
+      }) :
+      Promise.reject(`Method 'getmacrolocation' not supported by API version ${this.apiVersion}`);
   }
 }

Diff for: extension.ts

@@ -90,6 +90,9 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
       .serverInfo()
       .then(info => {
         panel.text = `${conn.label}:${conn.ns} - Connected`;
+        if (info && info.result && info.result.content && info.result.content.api > 0) {
+          api.setApiVersion(info.result.content.api);
+        }
         explorerProvider.refresh();
       })
       .catch(error => {

Diff for: package.json

@@ -369,19 +369,6 @@
           "type": "boolean",
           "default": false
         },
-        "objectscript.conn.apiVersion": {
-          "description": "Version of the API to use.",
-          "type": "string",
-          "enum": [
-						"v2",
-						"v3"
-					],
-					"enumDescriptions": [
-						"Use v2 api",
-						"Use v3 api"
-					],
-          "default": "v3"
-        },
         "objectscript.export": {
           "type": "object",
           "description": "Export only the necessary stuff "