a function to check if the API and the client are compatible

William Duncan · William Duncan · commit 53e45ccef14e · 2023-03-14T13:23:50.000+02:00
diff --git a/README.md b/README.md
@@ -77,6 +77,7 @@ console.log(newsletter._response.status); // 200
    - [`cloudnode.getNextPage<T>(response)`](#cloudnodegetnextpagetresponse)
    - [`cloudnode.getPreviousPage<T>(response)`](#cloudnodegetpreviouspagetresponse)
    - [`cloudnode.getAllPages<T>(response)`](#cloudnodegetallpagestresponse)
+   - [`cloudnode.checkCompatibility()`](#cloudnodecheckcompatibility)
    - [`cloudnode.account.changePassword(currentPassword, newPassword)`](#cloudnodeaccountchangepasswordcurrentpassword-newpassword)
    - [`cloudnode.account.get()`](#cloudnodeaccountget)
    - [`cloudnode.account.getEmail()`](#cloudnodeaccountgetemail)
@@ -184,6 +185,16 @@ Get all other pages of paginated results and return the complete data
  - Returns: <code>[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Cloudnode.PaginatedData](#interface-cloudnodepaginateddatat)&lt;T>></code> All of the data in 1 page
  - Throws: <code>[Cloudnode.Error](#interface-cloudnodeerror)</code> Error returned by the API
 
+<a name="cloudnodecheckcompatibility"></a>
+
+### `cloudnode.checkCompatibility()`
+
+Check compatibility with the API
+
+
+ - Returns: <code>[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)></code> True if this client is compatible with the API server
+
+
 <a name="cloudnodeaccountchangepasswordcurrentpassword-newpassword"></a>
 
 ### `cloudnode.account.changePassword(currentPassword, newPassword)`
diff --git a/browser/Cloudnode.js b/browser/Cloudnode.js
@@ -29,6 +29,14 @@ class Cloudnode {
         maxRetryDelay: 5,
         maxRetries: 3
     };
+    /**
+     * API version
+     */
+    #apiVersion = `5.11.2`;
+    /**
+     * Client user agent
+     */
+    #userAgent = `cloudnode/1.9.1`;
     /**
      * Construct a new Cloudnode API client
      * @param token API token to use for requests
@@ -72,7 +80,7 @@ class Cloudnode {
                 options.headers["Content-Type"] = "text/plain";
             }
         }
-        options.headers["User-Agent"] = `cloudnode/1.9.1`;
+        options.headers["User-Agent"] = this.#userAgent;
         if (this.#token && operation.token !== undefined)
             options.headers["Authorization"] = `Bearer ${this.#token}`;
         if (operation.token !== undefined)
@@ -132,6 +140,31 @@ class Cloudnode {
             send(0);
         });
     }
+    /**
+     * Compare versions to determine compatibility
+     * @param a First version
+     * @param b Second version
+     */
+    #compareVersions(a, b) {
+        const partsA = a.split(".");
+        const partsB = b.split(".");
+        const verA = [partsA[0] || "0", partsA[1] || "0"];
+        const verB = [partsB[0] || "0", partsB[1] || "0"];
+        return verA[0] === verB[0] && verA[1] === verB[1];
+    }
+    /**
+     * Check compatibility with the API
+     * @returns True if this client is compatible with the API server
+     */
+    async checkCompatibility() {
+        const data = await (await fetch(new URL("../", this.#options.baseUrl).toString(), {
+            method: "GET",
+            headers: {
+                "User-Agent": this.#userAgent
+            }
+        })).json();
+        return this.#compareVersions(data.version, this.#apiVersion);
+    }
     /**
      * Get another page of paginated results
      * @param response Response to get a different page of
diff --git a/browser/Cloudnode.min.js b/browser/Cloudnode.min.js
diff --git a/gen/docs.ts b/gen/docs.ts
@@ -103,6 +103,10 @@ export function generateDocSchema (schema: Schema, config: Config, pkg: Package)
         type: `Promise<${config.name}.PaginatedData<T>>`,
         description: "All of the data in 1 page"
     }, [{type: `${config.name}.Error`, description: "Error returned by the API"}]));
+    always.push(new DocSchema.Method(`${config.instanceName}.checkCompatibility`, "Check compatibility with the API", [], {
+        type: `Promise<boolean>`,
+        description: "True if this client is compatible with the API server"
+    }, []));
     mainClass.properties.unshift(...always);
     mainNamespace.properties.sort((a, b) => a.displayName.localeCompare(b.displayName));
 
diff --git a/gen/templates/main.mustache b/gen/templates/main.mustache
@@ -35,6 +35,16 @@ class {{config.name}} {
         maxRetries: 3
     };
 
+    /**
+     * API version
+     */
+    readonly #apiVersion = `{{config.apiVersion}}`;
+
+    /**
+     * Client user agent
+     */
+    readonly #userAgent = `{{config.instanceName}}/{{pkg.version}}`;
+
     /**
      * Construct a new {{config.name}} API client
      * @param token API token to use for requests
@@ -81,7 +91,7 @@ class {{config.name}} {
             }
         }
 
-        options.headers["User-Agent"] = `{{config.instanceName}}/{{pkg.version}}`;
+        options.headers["User-Agent"] = this.#userAgent;
 
         if (this.#token && operation.token !== undefined)
             options.headers["Authorization"] = `Bearer ${this.#token}`;
@@ -139,6 +149,35 @@ class {{config.name}} {
         });
     }
 
+    /**
+     * Compare versions to determine compatibility
+     * @param a First version
+     * @param b Second version
+     */
+    #compareVersions(a: string, b: string): boolean {
+        const partsA = a.split(".");
+        const partsB = b.split(".");
+
+        const verA = [partsA[0] || "0", partsA[1] || "0"];
+        const verB = [partsB[0] || "0", partsB[1] || "0"];
+
+        return verA[0] === verB[0] && verA[1] === verB[1];
+    }
+
+    /**
+     * Check compatibility with the API
+     * @returns True if this client is compatible with the API server
+     */
+    public async checkCompatibility(): Promise<boolean> {
+        const data: any = await (await fetch(new URL("../", this.#options.baseUrl).toString(), {
+            method: "GET",
+            headers: {
+                "User-Agent": this.#userAgent
+            }
+        })).json();
+        return this.#compareVersions(data.version, this.#apiVersion);
+    }
+
     /**
      * Get another page of paginated results
      * @param response Response to get a different page of
diff --git a/src/Cloudnode.d.ts b/src/Cloudnode.d.ts
@@ -11,6 +11,11 @@ declare class Cloudnode {
      * @param [options] Options for the API client
      */
     constructor(token?: string, options?: Partial<Cloudnode.Options>);
+    /**
+     * Check compatibility with the API
+     * @returns True if this client is compatible with the API server
+     */
+    checkCompatibility(): Promise<boolean>;
     /**
      * Get another page of paginated results
      * @param response Response to get a different page of
diff --git a/src/Cloudnode.js b/src/Cloudnode.js
@@ -29,6 +29,14 @@ class Cloudnode {
         maxRetryDelay: 5,
         maxRetries: 3
     };
+    /**
+     * API version
+     */
+    #apiVersion = `5.11.2`;
+    /**
+     * Client user agent
+     */
+    #userAgent = `cloudnode/1.9.1`;
     /**
      * Construct a new Cloudnode API client
      * @param token API token to use for requests
@@ -72,7 +80,7 @@ class Cloudnode {
                 options.headers["Content-Type"] = "text/plain";
             }
         }
-        options.headers["User-Agent"] = `cloudnode/1.9.1`;
+        options.headers["User-Agent"] = this.#userAgent;
         if (this.#token && operation.token !== undefined)
             options.headers["Authorization"] = `Bearer ${this.#token}`;
         if (operation.token !== undefined)
@@ -132,6 +140,31 @@ class Cloudnode {
             send(0);
         });
     }
+    /**
+     * Compare versions to determine compatibility
+     * @param a First version
+     * @param b Second version
+     */
+    #compareVersions(a, b) {
+        const partsA = a.split(".");
+        const partsB = b.split(".");
+        const verA = [partsA[0] || "0", partsA[1] || "0"];
+        const verB = [partsB[0] || "0", partsB[1] || "0"];
+        return verA[0] === verB[0] && verA[1] === verB[1];
+    }
+    /**
+     * Check compatibility with the API
+     * @returns True if this client is compatible with the API server
+     */
+    async checkCompatibility() {
+        const data = await (await fetch(new URL("../", this.#options.baseUrl).toString(), {
+            method: "GET",
+            headers: {
+                "User-Agent": this.#userAgent
+            }
+        })).json();
+        return this.#compareVersions(data.version, this.#apiVersion);
+    }
     /**
      * Get another page of paginated results
      * @param response Response to get a different page of
diff --git a/src/Cloudnode.ts b/src/Cloudnode.ts
@@ -35,6 +35,16 @@ class Cloudnode {
         maxRetries: 3
     };
 
+    /**
+     * API version
+     */
+    readonly #apiVersion = `5.11.2`;
+
+    /**
+     * Client user agent
+     */
+    readonly #userAgent = `cloudnode/1.9.1`;
+
     /**
      * Construct a new Cloudnode API client
      * @param token API token to use for requests
@@ -81,7 +91,7 @@ class Cloudnode {
             }
         }
 
-        options.headers["User-Agent"] = `cloudnode/1.9.1`;
+        options.headers["User-Agent"] = this.#userAgent;
 
         if (this.#token && operation.token !== undefined)
             options.headers["Authorization"] = `Bearer ${this.#token}`;
@@ -139,6 +149,35 @@ class Cloudnode {
         });
     }
 
+    /**
+     * Compare versions to determine compatibility
+     * @param a First version
+     * @param b Second version
+     */
+    #compareVersions(a: string, b: string): boolean {
+        const partsA = a.split(".");
+        const partsB = b.split(".");
+
+        const verA = [partsA[0] || "0", partsA[1] || "0"];
+        const verB = [partsB[0] || "0", partsB[1] || "0"];
+
+        return verA[0] === verB[0] && verA[1] === verB[1];
+    }
+
+    /**
+     * Check compatibility with the API
+     * @returns True if this client is compatible with the API server
+     */
+    public async checkCompatibility(): Promise<boolean> {
+        const data: any = await (await fetch(new URL("../", this.#options.baseUrl).toString(), {
+            method: "GET",
+            headers: {
+                "User-Agent": this.#userAgent
+            }
+        })).json();
+        return this.#compareVersions(data.version, this.#apiVersion);
+    }
+
     /**
      * Get another page of paginated results
      * @param response Response to get a different page of
