virtualizorjs 1.0.0-beta → 1.0.0

package/.github/workflows/npm-publish-github-packages.yml

@@ -0,0 +1,36 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - run: npm ci
+      - run: npm test
+
+  publish-gpr:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://npm.pkg.github.com/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

package/.github/workflows/release-package.yml

@@ -0,0 +1,46 @@
+name: Release Package
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '14'
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Build Release Package
+        run: npm run build
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          files: |
+            dist/*
+          release_name: Release ${{ github.event_name }} ${{ github.sha }}
+
+      - name: Upload Release Asset
+        id: upload-release-asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: dist/*
+          asset_name: virtualizorjs-${{ github.sha }}.zip
+          asset_content_type: application/zip

package/README.md

@@ -4,16 +4,17 @@ Since there is no SDK's for Node.js for the Virtualizor API, I decided to create
 
 VirtualizorJS simplifies the management of Virtualizor servers with a streamlined and developer-friendly API for Node.js. Perform actions such as creating, starting, stopping, and restarting virtual servers effortlessly. Ideal for seamless integration into your Node.js applications, providing a powerful toolkit for Virtualizor server management.
 
-[![npm version](https://badge.fury.io/js/virtualizorjs.svg)](https://badge.fury.io/js/virtualizorjs)
+[![npm version](https://badge.fury.io/js/virtualizorjs.png)](https://badge.fury.io/js/virtualizorjs)
 
 ## Important
- - As of `19 January 2024` Not all Virtualizor API functions are tested fully. ( i m busy (just lazy lmao))
+ - This library is still in development and there is more to add but for now it's stable and ready to use, all the methods have been tested and work as expected.
 
 ## Table of Contents
 - [Installation](#installation)
 - [Usage](#usage)
 - [Examples](#examples)
 - [API Documentation](#api-documentation)
+- [Roadmap](#roadmap)
 - [Contributing](#contributing)
 - [License](#license)
 
@@ -33,8 +34,8 @@ const VirtualizorClient = require('virtualizorjs');
 const { ListVPS } = new VirtualizorClient({
   host: '< IP or Hostname of Virtualizor Server >',
   port: 4083,
-  key: "< Your API KEY >",
-  pass: "< Your API PASS >",
+  adminapikey: "< Your API KEY >",
+  adminapipass: "< Your API PASS >",
 });
 
 // Using const client = new VirtualizorClient({ ... }) is also valid, but you will have to use client.ListVPS() instead of ListVPS() which just looks ugly.
@@ -60,8 +61,8 @@ const VirtualizorClient = require('virtualizorjs');
 const { on: eventOn } = new VirtualizorClient({
   host: '< IP or Hostname of Virtualizor Server >',
   port: 4083,
-  key: "< Your API KEY >",
-  pass: "< Your API PASS >",
+  adminapikey: "< Your API KEY >",
+  adminapipass: "< Your API PASS >",
 });
 
 // - Event Types - :
@@ -106,6 +107,7 @@ eventOn('vpsRestarted', (response) => {
 ## Documentation
 
 - Check the [Wiki](https://github.com/kkMihai/virtualizorjs/wiki) for detailed documentation.
+- If you use frameworks such as [Next.js](https://nextjs.org/) make sure to use it only Server-Side for security reasons.
 
 ## Roadmap
   - [ ] Add Proxmox KVM Support

package/SECURITY.md

@@ -4,7 +4,7 @@
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 1.0.0   | :white_check_mark: |
+| 1.0.0-beta   | :white_check_mark: |
 
 ## Reporting a Vulnerability
 

package/examples/createvps.js

@@ -3,8 +3,8 @@ const VirtualizorClient = require("virtualizorjs");
 const { CreateVPS } = new VirtualizorClient({
   host: "< IP or Hostname of Virtualizor Server >",
   port: 4083, // Default port for Virtualizor API
-  key: "< Your API KEY >",
-  pass: "< Your API PASS >",
+  adminapikey: "< Your API KEY >",
+  adminapipass: "< Your API PASS >",
 });
 
 async function exampleUsage() {

package/examples/eventhandling.js

@@ -3,8 +3,8 @@ const VirtualizorClient = require('virtualizorjs');
 const { on: eventOn } = new VirtualizorClient({
   host: '< IP or Hostname of Virtualizor Server >',
   port: 4083,
-  key: "< Your API KEY >",
-  pass: "< Your API PASS >",
+  adminapikey: "< Your API KEY >",
+  adminapipass: "< Your API PASS >",
 });
 
 // Event listener for when a virtual server is created

package/examples/listvps.js

@@ -3,8 +3,8 @@ const VirtualizorClient = require("virtualizorjs");
 const { ListVPS } = new VirtualizorClient({
   host: "< IP or Hostname of Virtualizor Server >",
   port: 4083, // Default port for Virtualizor API
-  key: "< Your API KEY >",
-  pass: "< Your API PASS >",
+  adminapikey: "< Your API KEY >",
+  adminapipass: "< Your API PASS >",
 });
 
 async function exampleUsage() {

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "virtualizorjs",
-  "version": "1.0.0-beta",
+  "version": "1.0.0",
   "description": "VirtualizorJS simplifies the management of Virtualizor servers with a streamlined and developer-friendly API for Node.js. Perform actions such as creating, starting, stopping, and restarting virtual servers effortlessly. Ideal for seamless integration into your Node.js applications, providing a powerful toolkit for Virtualizor server management.",
-  "main": "/src/VirtualizorClient.js",
+  "main": "./src/VirtualizorClient.js",
+  "scripts": {},
   "keywords": [
     "virtualizor",
     "api",
@@ -21,12 +22,15 @@
     "powerful",
     "fast"
   ],
+  "publishConfig": {
+    "@kkMihai:registry": "https://npm.pkg.github.com"
+  },
   "author": "kkMihai",
   "license": "MIT",
   "github": "https://github.com/kkMihai/virtualizorjs",
   "repository": {
     "type": "git",
-    "url": "https://github.com/kkMihai/virtualizorjs.git"
+    "url": "git+https://github.com/kkMihai/virtualizorjs.git"
   },
   "bugs": {
     "url": "https://github.com/kkMihai/virtualizorjs/issues"

package/src/Actions.js

@@ -15,12 +15,18 @@ module.exports = {
    * @type {string}
    */
   VPSManage: "vpsmanage",
+ 
+  /**
+   * Action to get a VPS Info
+   * @type {string}
+  */
+  GetVPS: "vs",
 
   /**
    * Action to list all VPS.
    * @type {string}
    */
-  ListVPS: "vs",
+  ListVPS: "listvs",
 
   /**
    * Action to start a VPS.

package/src/VirtualizorClient.js

@@ -16,24 +16,22 @@ const Actions = require("./actions");
 /**
  * @class VirtualizorClient
  * @description - This class is used to make http requests to Virtualizor API
- * @version 1.0.0
  * @author kkMihai <kkmihai@duck.com>
- * @param {Object} optionsv - Options for VirtualizorClient
- * @param {String} options.host - Hostname of the Virtualizor server (IP or domain)
- * @param {String} options.port - Port of the Virtualizor server (default: 4083)
- * @param {String} options.key - API key
- * @param {String} options.pass - API password
- * @param {Boolean} options.isRawResponse - If true, the response will be the raw response from the API, Recommended to set this to false
+ * @param {String} host - Hostname of the Virtualizor server (IP or domain)
+ * @param {String} port - Port of the Virtualizor server (default: 4083)
+ * @param {String} adminapikey - API admin api key
+ * @param {String} adminapipass - API admin api pass
+ * @param {Boolean} isRawResponse - If true, the response will be the raw response from the API, Recommended to set this to false
  * @returns {VirtualizorClient} VirtualizorClient
  */
 
 class VirtualizorClient extends EventEmitter {
-  constructor({ host, port, key, pass, isRawResponse = false }) {
+  constructor({ host, port, adminapikey, adminapipass, isRawResponse = false }) {
     super();
     this.host = host;
     this.port = port;
-    this.key = key;
-    this.pass = pass;
+    this.adminapikey = adminapikey;
+    this.adminapipass = adminapipass;
     this.isRawResponse = isRawResponse
 
     /**
@@ -49,7 +47,7 @@ class VirtualizorClient extends EventEmitter {
     this.GetVPSRam = this.GetVPSRam.bind(this);
     this.GetVPSCPU = this.GetVPSCPU.bind(this);
     this.GetVPSDisk = this.GetVPSDisk.bind(this);
-    this.GetServerBandwidth = this.GetServerBandwidth.bind(this);
+    this.GetVPSBandwidth = this.GetVPSBandwidth.bind(this);
     this.GetPlans = this.GetPlans.bind(this);
   }
 
@@ -62,15 +60,20 @@ class VirtualizorClient extends EventEmitter {
    */
   buildQueryString(params) {
     params.api = "json";
+    Object.keys(params).forEach((key) => {
+      if (params[key] === undefined) {
+        delete params[key];
+      }
+    });
     const queryParams = new URLSearchParams(params);
     return `?${queryParams.toString()}`;
   }
 
   /**
    * @description - This method is used to make http/s request and should not be used externally
-   * @param {String} path
-   * @param {String} method
-   * @param {String} postData
+   * @param {String} path - Path of the request
+   * @param {String} method - Method of the request
+   * @param {String} postData - This is used to send data in POST request in the form of query string
    * @returns {Promise} Promise
    * @memberof VirtualizorClient
    * @private
@@ -79,17 +82,21 @@ class VirtualizorClient extends EventEmitter {
     const options = {
       host: this.host,
       port: this.port,
+      protocol: "https:",
       path: path,
       method: method,
       headers: {
         "Content-Type": "application/x-www-form-urlencoded",
       },
-      agent: new https.Agent({ rejectUnauthorized: false }),
+      agent: new https.Agent({ rejectUnauthorized: false ,requestCert: false }),
     };
 
     return new Promise((resolve, reject) => {
       const req = https.request(options, (res) => {
         let data = "";
+    
+      console.log(data);
+
 
         res.on("data", (chunk) => {
           data += chunk;
@@ -128,9 +135,9 @@ class VirtualizorClient extends EventEmitter {
     virtualizationType,
     nodeSelection,
     userEmail,
-    userPassword,
+    userpassword,
     serverHostname,
-    rootPassword,
+    rootpassword,
     osId,
     ipAddress,
     storageSpace,
@@ -158,17 +165,17 @@ class VirtualizorClient extends EventEmitter {
       virt: virtualizationType,
       node_select: nodeSelection,
       user_email: userEmail,
-      user_pass: userPassword,
+      user_pass: userpassword,
       hostname: serverHostname,
-      root_pass: rootPassword,
+      root_pass: rootpassword,
       os_id: osId,
       ips: ipAddress,
       space: handleDiskSpace(storageSpace),
       ram: serverRam,
       bandwidth: bandwidthLimit,
       cores: cpuCores,
-      key: this.key,
-      pass: this.pass,
+      adminapikey: this.adminapikey,
+      adminapipass: this.adminapipass,
     };
 
     const path = `/index.php${this.buildQueryString(queryParams)}`;
@@ -190,40 +197,33 @@ class VirtualizorClient extends EventEmitter {
    * @param {String} id - ID of the virtual server
    * @returns {Promise} Promise
    * @memberof VirtualizorClient
+   * @Tested - Yes
    */
   async GetVPS(id) {
     const queryParams = {
-      act: Actions.VPSManage,
-      changeserid: id,
-      key: this.key,
-      pass: this.pass,
+      act: Actions.GetVPS,
+      vpsid: id,
+      adminapikey: this.adminapikey,
+      adminapipass: this.adminapipass,
     };
 
     const path = `/index.php${this.buildQueryString(queryParams)}`;
 
     try {
-      const res = await this.makeHttpRequest(path);
+
+      if (!id) {
+        return Promise.reject(new Error("vpsid is required"));
+      }
+
+      const res = await this.makeHttpRequest(path, "POST");
       let resData = res;
 
       if (!this.isRawResponse) {
-        resData = {
-          ip: res.info.ip,
-          hostname: res.info.hostname,
-          status: res.info.status,
-          os: res.info.vps.os_name,
-          cores: res.info.vps.cores,
-          ram: res.info.vps.ram,
-          space: res.info.vps.space,
-          bandwidth: {
-            limit: res.info.bandwidth.limit,
-            used: res.info.bandwidth.used,
-            free: res.info.bandwidth.free,
-          },
-          datacenter: res.info.server_name,
-        };
+        resData = res.vs[id];
       }
 
       return Promise.resolve(resData);
+
     } catch (err) {
       return Promise.reject(err);
     }
@@ -232,92 +232,29 @@ class VirtualizorClient extends EventEmitter {
   /**
  * @description - This method is used to list all virtual servers
  * @returns {Promise} Promise
- * @param {Number} [vpsid] - Search using id
- * @param {String} [vpsname] - Search using vid
- * @param {String} [vpsip] - Results will be returned on the basis of the ip
- * @param {String} [vpshostname] - VPS is searched on the basis of the hostname passed
- * @param {String} [vpsstatus] - VPS is searched on the basis of the status of the vps
- *   (type 's' for suspended, type 'u' for unsuspended)
- * @param {String} [vstype] - VPS is searched on the basis of the type of virtualization,
- *   refer below table for valid values
- * @param {String} [speedcap] - VPS is searched on the basis of the type of speed cap
- *   (type 1 for enabled, 2 for disabled)
- * @param {String} [user] - Search for the vps according to the user
- * @param {String} [vsgid] - Search for the vps according to the server group
- * @param {String} [vserid] - VPS is searched on the basis of the server
- * @param {String} [plid] - VPS is searched on the basis of plan that it has been assigned
- * @param {String} [bpid] - VPS is searched on the basis of backup plan that it has been assigned
- * @param {Number} [reslen] - Number of records to be returned, default is 50
- * @param {Number} [page] - Page number, each page show 50 records
  * @memberof VirtualizorClient
+ * @Tested - Yes
  */
-async ListVPS(
-  vpsid,
-  vpsname,
-  vpsip,
-  vpshostname,
-  vpsstatus,
-  vstype,
-  speedcap,
-  user,
-  vsgid,
-  vserid,
-  plid,
-  bpid,
-  reslen,
-  page
-) {
+async ListVPS() {
   const queryParams = {
-    act: Actions.ListVPS,
-    key: this.key,
-    pass: this.pass,
-    vpsid,
-    vpsname,
-    vpsip,
-    vpshostname,
-    vpsstatus,
-    vstype,
-    speedcap,
-    user,
-    vsgid,
-    vserid,
-    plid,
-    bpid,
-    reslen,
-    page,
+    act: Actions.GetVPS,
+    adminapikey: this.adminapikey,
+    adminapipass: this.adminapipass,
   };
 
   const path = `/index.php${this.buildQueryString(queryParams)}`;
 
   try {
-    const res = await this.makeHttpRequest(path, "POST");
+
+    const res = await this.makeHttpRequest(path, "GET");
     let resData = res;
 
-    if (!this.isRawResponse && res.data.vs) {
-      resData = Object.keys(res.data.vs).reduce((acc, key) => {
-        const vps = res.data.vs[key];
-
-        if (vps && vps.vpsid && vps.hostname && vps.os_name) {
-          acc.push({
-            id: vps.vpsid,
-            name: vps.vps_name,
-            hostname: vps.hostname,
-            os: vps.os_name,
-            cores: vps.cores,
-            ram: vps.ram,
-            space: vps.space,
-            bandwidth: vps.bandwidth,
-            serverName: vps.server_name,
-            status: vps.status,
-            ip: vps.ips,
-          });
-        }
-
-        return acc;
-      }, []);
+    if (!this.isRawResponse) {
+      resData = res.vs
     }
 
     return Promise.resolve(resData);
+
   } catch (err) {
     return Promise.reject(err);
   }
@@ -329,24 +266,32 @@ async ListVPS(
    * @param {String} vpsId - ID of the virtual server
    * @returns {Promise} Promise
    * @memberof VirtualizorClient
+   * @Tested - Yes
    */
   async StartVPS(vpsId) {
     const queryParams = {
-      act: Actions.StartVPS,
+      action: Actions.StartVPS,
       vpsid: vpsId,
-      key: this.key,
-      pass: this.pass,
+      adminapikey: this.adminapikey,
+      adminapipass: this.adminapipass,
     };
 
-    const path = `/index.php${this.buildQueryString(queryParams)}&action=vs`;
+    const path = `/index.php${this.buildQueryString(queryParams)}`;
 
     try {
-      const res = await this.makeHttpRequest(path);
+
+      if (!vpsId) {
+        return Promise.reject(new Error("vpsid is required"));
+      }
+
+      const res = await this.makeHttpRequest(path, "GET", `act=vs`);
       this.emit("vpsStarted", res);
+
       return Promise.resolve({
-        message: res.done && res.done.msg,
-        time_taken: res.time_taken,
-      });
+        message: res.done && res.done_msg,
+        error: res.error_msg || false
+      })
+
     } catch (err) {
       return Promise.reject(err);
     }
@@ -357,24 +302,25 @@ async ListVPS(
    * @param {String} vpsId - ID of the virtual server
    * @returns {Promise} Promise
    * @memberof VirtualizorClient
+   * @Tested - Yes
    */
   async StopVPS(vpsId) {
     const queryParams = {
-      act: Actions.StopVPS,
+      action: Actions.StopVPS,
       vpsid: vpsId,
-      key: this.key,
-      pass: this.pass,
+      adminapikey: this.adminapikey,
+      adminapipass: this.adminapipass,
     };
 
-    const path = `/index.php${this.buildQueryString(queryParams)}&action=vs`;
+    const path = `/index.php${this.buildQueryString(queryParams)}`;
 
     try {
-      const res = await this.makeHttpRequest(path);
+      const res = await this.makeHttpRequest(path, "GET", `act=vs`);
       this.emit("vpsStopped", res);
       return Promise.resolve({
-        message: res.done && res.done.msg,
-        time_taken: res.time_taken,
-      });
+        message: res.done && res.done_msg,
+        error: res.error_msg || false,
+      })
     } catch (err) {
       return Promise.reject(err);
     }
@@ -388,21 +334,21 @@ async ListVPS(
    */
   async RestartVPS(vpsId) {
     const queryParams = {
-      act: Actions.RestartVPS,
+      action: Actions.RestartVPS,
       vpsid: vpsId,
-      key: this.key,
-      pass: this.pass,
+      adminapikey: this.adminapikey,
+      adminapipass: this.adminapipass,
     };
 
-    const path = `/index.php${this.buildQueryString(queryParams)}&action=vs`;
+    const path = `/index.php${this.buildQueryString(queryParams)}`;
 
     try {
-      const res = await this.makeHttpRequest(path);
+      const res = await this.makeHttpRequest(path, "GET", `act=vs`);
       this.emit("vpsRestarted", res);
       return Promise.resolve({
-        message: res.done && res.done.msg,
-        time_taken: res.time_taken,
-      });
+        message: res.done && res.done_msg,
+        error: res.error_msg || false
+      })
     } catch (err) {
       return Promise.reject(err);
     }
@@ -417,9 +363,9 @@ async ListVPS(
   async GetVPSRam(vpsId) {
     const queryParams = {
       act: Actions.GetVPSRam,
-      changeserid: vpsId,
-      key: this.key,
-      pass: this.pass,
+      svs: vpsId,
+      adminapikey: this.adminapikey,
+      adminapipass: this.adminapipass,
     };
 
     const path = `/index.php${this.buildQueryString(queryParams)}`;
@@ -444,15 +390,16 @@ async ListVPS(
   async GetVPSCPU(vpsId) {
     const queryParams = {
       act: Actions.GetVPSCPU,
-      changeserid: vpsId,
-      key: this.key,
-      pass: this.pass,
+      svs: vpsId,
+      adminapikey: this.adminapikey,
+      adminapipass: this.adminapipass,
     };
 
     const path = `/index.php${this.buildQueryString(queryParams)}`;
 
     try {
       const res = await this.makeHttpRequest(path);
+
       return Promise.resolve({
         cpu: res.cpu,
         time_taken: res.time_taken,
@@ -472,18 +419,21 @@ async ListVPS(
     const queryParams = {
       act: Actions.GetVPSDisk,
       changeserid: vpsId,
-      key: this.key,
-      pass: this.pass,
+      adminapikey: this.adminapikey,
+      adminapipass: this.adminapipass,
     };
 
     const path = `/index.php${this.buildQueryString(queryParams)}`;
 
     try {
       const res = await this.makeHttpRequest(path);
+      
       return Promise.resolve({
-        disk: res.disk,
+        info: res.disk,
         time_taken: res.time_taken,
       });
+
+
     } catch (err) {
       return Promise.reject(err);
     }
@@ -491,15 +441,17 @@ async ListVPS(
 
   /**
    * @description - This method is used to get bandwidth information of a virtual server
+   * @param {String} vpsId - ID of the virtual server
    * @param {String} month - Month for which bandwidth information is required (YYYY-MM)
    * @returns {Promise} Promise
    * @memberof VirtualizorClient
    */
-  async GetServerBandwidth(month) {
+  async GetVPSBandwidth({vpsId, month}) {
     const queryParams = {
       act: Actions.GetServerBandwidth,
-      key: this.key,
-      pass: this.pass,
+      changeserid: vpsId,
+      adminapikey: this.adminapikey,
+      adminapipass: this.adminapipass,
     };
 
     const path = `/index.php${this.buildQueryString(queryParams)}`;
@@ -518,15 +470,18 @@ async ListVPS(
   async GetPlans() {
     const queryParams = {
       act: Actions.GetPlans,
-      key: this.key,
-      pass: this.pass,
+      adminapikey: this.adminapikey,
+      adminapipass: this.adminapipass,
     };
 
     const path = `/index.php${this.buildQueryString(queryParams)}`;
 
     try {
       const res = await this.makeHttpRequest(path);
-      return Promise.resolve(res);
+      return Promise.resolve({
+        plans: res.plans,
+        time_taken: res.time_taken,
+      });
     } catch (err) {
       return Promise.reject(err);
     }