more statuses in compatibility check

Author: William Duncan

README.md

@@ -192,7 +192,7 @@ Get all other pages of paginated results and return the complete data
 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
+ - Returns: <code>[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;"compatible" | "outdated" | "incompatible"></code> `compatible` - versions are fully compatible (only patch version may differ), `outdated` - compatible, but new features unavailable (minor version differs), `incompatible` - breaking changes (major version differs)
 
 
 <a name="cloudnodeaccountchangepasswordcurrentpassword-newpassword"></a>

browser/Cloudnode.js

@@ -150,11 +150,15 @@ class Cloudnode {
         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];
+        if (verA[0] !== verB[0])
+            return "incompatible";
+        if (verA[1] !== verB[1])
+            return "outdated";
+        return "compatible";
     }
     /**
      * Check compatibility with the API
-     * @returns True if this client is compatible with the API server
+     * @returns `compatible` - versions are fully compatible (only patch version may differ), `outdated` - compatible, but new features unavailable (minor version differs), `incompatible` - breaking changes (major version differs)
      */
     async checkCompatibility() {
         const data = await (await fetch(new URL("../", this.#options.baseUrl).toString(), {

browser/Cloudnode.min.js

@@ -104,8 +104,8 @@ export function generateDocSchema (schema: Schema, config: Config, pkg: Package)
         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"
+        type: `Promise<"compatible" | "outdated" | "incompatible">`,
+        description: "`compatible` - versions are fully compatible (only patch version may differ), `outdated` - compatible, but new features unavailable (minor version differs), `incompatible` - breaking changes (major version differs)"
     }, []));
     mainClass.properties.unshift(...always);
     mainNamespace.properties.sort((a, b) => a.displayName.localeCompare(b.displayName));

gen/docs.ts

@@ -154,21 +154,23 @@ class {{config.name}} {
      * @param a First version
      * @param b Second version
      */
-    #compareVersions(a: string, b: string): boolean {
+    #compareVersions(a: string, b: string): "compatible" | "outdated" | "incompatible" {
         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];
+        if (verA[0] !== verB[0]) return "incompatible";
+        if (verA[1] !== verB[1]) return "outdated";
+        return "compatible";
     }
 
     /**
      * Check compatibility with the API
-     * @returns True if this client is compatible with the API server
+     * @returns `compatible` - versions are fully compatible (only patch version may differ), `outdated` - compatible, but new features unavailable (minor version differs), `incompatible` - breaking changes (major version differs)
      */
-    public async checkCompatibility(): Promise<boolean> {
+    public async checkCompatibility() {
         const data: any = await (await fetch(new URL("../", this.#options.baseUrl).toString(), {
             method: "GET",
             headers: {

gen/templates/main.mustache

@@ -13,9 +13,9 @@ declare class Cloudnode {
     constructor(token?: string, options?: Partial<Cloudnode.Options>);
     /**
      * Check compatibility with the API
-     * @returns True if this client is compatible with the API server
+     * @returns `compatible` - versions are fully compatible (only patch version may differ), `outdated` - compatible, but new features unavailable (minor version differs), `incompatible` - breaking changes (major version differs)
      */
-    checkCompatibility(): Promise<boolean>;
+    checkCompatibility(): Promise<"compatible" | "outdated" | "incompatible">;
     /**
      * Get another page of paginated results
      * @param response Response to get a different page of

src/Cloudnode.d.ts

@@ -150,11 +150,15 @@ class Cloudnode {
         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];
+        if (verA[0] !== verB[0])
+            return "incompatible";
+        if (verA[1] !== verB[1])
+            return "outdated";
+        return "compatible";
     }
     /**
      * Check compatibility with the API
-     * @returns True if this client is compatible with the API server
+     * @returns `compatible` - versions are fully compatible (only patch version may differ), `outdated` - compatible, but new features unavailable (minor version differs), `incompatible` - breaking changes (major version differs)
      */
     async checkCompatibility() {
         const data = await (await fetch(new URL("../", this.#options.baseUrl).toString(), {

src/Cloudnode.js

@@ -154,21 +154,23 @@ class Cloudnode {
      * @param a First version
      * @param b Second version
      */
-    #compareVersions(a: string, b: string): boolean {
+    #compareVersions(a: string, b: string): "compatible" | "outdated" | "incompatible" {
         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];
+        if (verA[0] !== verB[0]) return "incompatible";
+        if (verA[1] !== verB[1]) return "outdated";
+        return "compatible";
     }
 
     /**
      * Check compatibility with the API
-     * @returns True if this client is compatible with the API server
+     * @returns `compatible` - versions are fully compatible (only patch version may differ), `outdated` - compatible, but new features unavailable (minor version differs), `incompatible` - breaking changes (major version differs)
      */
-    public async checkCompatibility(): Promise<boolean> {
+    public async checkCompatibility() {
         const data: any = await (await fetch(new URL("../", this.#options.baseUrl).toString(), {
             method: "GET",
             headers: {