Merge pull request #51 from cloudnode-pro/next

Bump API version to 5.11.2

Author: williamd5

README.md

@@ -2,6 +2,6 @@
   "name": "Cloudnode",
   "instanceName": "cloudnode",
   "baseUrl": "https://api.cloudnode.pro/v5/",
-  "apiVersion": "5.10.1",
+  "apiVersion": "5.11.2",
   "browserSdkUrl": "https://cdn.jsdelivr.net/npm/cloudnode-ts@latest/browser/Cloudnode.min.js"
 }

browser/Cloudnode.js

@@ -78,31 +78,35 @@ export function generateDocSchema (schema: Schema, config: Config, pkg: Package)
         new DocSchema.Parameter("token", "string", "API token to use for requests", false),
         new DocSchema.Parameter("options", `Partial<${config.name}.Options>`, "API client options", false, `{baseUrl: "${config.baseUrl}", autoRetry: true, maxRetryDelay: 5, maxRetries: 3}`)
     ], undefined, []));
-    always.push(new DocSchema.Method(`${config.name}.getPage<T>`, "Get another page of paginated results", [
+    always.push(new DocSchema.Method(`${config.instanceName}.getPage<T>`, "Get another page of paginated results", [
         new DocSchema.Parameter("response", `${config.name}.ApiResponse<${config.name}.PaginatedData<T>>`, "Response to get a different page of", true),
         new DocSchema.Parameter("page", "number", "Page to get", true)
     ], {
         type: `Promise<${config.name}.ApiResponse<${config.name}.PaginatedData<T>> | null>`,
         description: "The new page or null if the page is out of bounds"
     }, [{type: `${config.name}.Error`, description: "Error returned by the API"}]));
-    always.push(new DocSchema.Method(`${config.name}.getNextPage<T>`, "Get next page of paginated results", [
+    always.push(new DocSchema.Method(`${config.instanceName}.getNextPage<T>`, "Get next page of paginated results", [
         new DocSchema.Parameter("response", `${config.name}.ApiResponse<${config.name}.PaginatedData<T>>`, "Response to get the next page of", true)
     ], {
         type: `Promise<${config.name}.ApiResponse<${config.name}.PaginatedData<T>> | null>`,
         description: "The next page or null if this is the last page"
     }, [{type: `${config.name}.Error`, description: "Error returned by the API"}]));
-    always.push(new DocSchema.Method(`${config.name}.getPreviousPage<T>`, "Get previous page of paginated results", [
+    always.push(new DocSchema.Method(`${config.instanceName}.getPreviousPage<T>`, "Get previous page of paginated results", [
         new DocSchema.Parameter("response", `${config.name}.ApiResponse<${config.name}.PaginatedData<T>>`, "Response to get the previous page of", true)
     ], {
         type: `Promise<${config.name}.ApiResponse<${config.name}.PaginatedData<T>> | null>`,
         description: "The previous page or null if this is the first page"
     }, [{type: `${config.name}.Error`, description: "Error returned by the API"}]));
-    always.push(new DocSchema.Method(`${config.name}.getAllPages<T>`, "Get all other pages of paginated results and return the complete data\n> **Warning:** Depending on the amount of data, this can take a long time and use a lot of memory.", [
+    always.push(new DocSchema.Method(`${config.instanceName}.getAllPages<T>`, "Get all other pages of paginated results and return the complete data\n> **Warning:** Depending on the amount of data, this can take a long time and use a lot of memory.", [
         new DocSchema.Parameter("response", `${config.name}.ApiResponse<${config.name}.PaginatedData<T>>`, "Response to get all pages of", true)
     ], {
         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<"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));
 

browser/Cloudnode.min.js

@@ -35,17 +35,27 @@ 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
      * @param [options] Options for the API client
      */
     public constructor(token?: string, options: Partial<{{config.name}}.Options> = {{config.name}}.#defaultOptions) {
         const fullOptions = {{config.name}}.#defaultOptions;
-        fullOptions.baseUrl = fullOptions.baseUrl ?? {{config.name}}.#defaultOptions.baseUrl;
-        fullOptions.autoRetry = fullOptions.autoRetry ?? {{config.name}}.#defaultOptions.autoRetry;
-        fullOptions.maxRetryDelay = fullOptions.maxRetryDelay ?? {{config.name}}.#defaultOptions.maxRetryDelay;
-        fullOptions.maxRetries = fullOptions.maxRetries ?? {{config.name}}.#defaultOptions.maxRetries;
+        fullOptions.baseUrl = options.baseUrl ?? {{config.name}}.#defaultOptions.baseUrl;
+        fullOptions.autoRetry = options.autoRetry ?? {{config.name}}.#defaultOptions.autoRetry;
+        fullOptions.maxRetryDelay = options.maxRetryDelay ?? {{config.name}}.#defaultOptions.maxRetryDelay;
+        fullOptions.maxRetries = options.maxRetries ?? {{config.name}}.#defaultOptions.maxRetries;
 
         this.#token = token;
         this.#options = fullOptions;
@@ -80,6 +90,9 @@ class {{config.name}} {
                 options.headers["Content-Type"] = "text/plain";
             }
         }
+
+        options.headers["User-Agent"] = this.#userAgent;
+
         if (this.#token && operation.token !== undefined)
             options.headers["Authorization"] = `Bearer ${this.#token}`;
         if (operation.token !== undefined)
@@ -136,6 +149,37 @@ class {{config.name}} {
         });
     }
 
+    /**
+     * Compare versions to determine compatibility
+     * @param a First version
+     * @param b Second version
+     */
+    #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"];
+
+        if (verA[0] !== verB[0]) return "incompatible";
+        if (verA[1] !== verB[1]) return "outdated";
+        return "compatible";
+    }
+
+    /**
+     * Check compatibility with the API
+     * @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() {
+        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