virtualizorjs 1.0.0-beta

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -0,0 +1,92 @@
+
+# Contributing to VirtualizorJS
+
+Welcome to VirtualizorJS! We appreciate your interest in contributing to our project. By contributing, you help make VirtualizorJS better for everyone. Please take a moment to review this document before getting started.
+
+## Table of Contents
+
+1. [Code of Conduct](#code-of-conduct)
+2. [How Can I Contribute?](#how-can-i-contribute)
+3. [Getting Started](#getting-started)
+   - [Fork the Repository](#fork-the-repository)
+   - [Clone the Repository](#clone-the-repository)
+   - [Install Dependencies](#install-dependencies)
+   - [Make Changes](#make-changes)
+   - [Test Your Changes](#test-your-changes)
+4. [Submitting a Pull Request](#submitting-a-pull-request)
+5. [Code of Conduct](#code-of-conduct)
+6. [License](#license)
+
+## Code of Conduct
+
+Please review our [Code of Conduct](CODE_OF_CONDUCT.md) to understand the standards and expectations for all contributors.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+If you encounter a bug, please [open an issue](../../issues) and provide as much detail as possible.
+
+### Suggesting Enhancements
+
+Have an idea to enhance VirtualizorJS? Feel free to [open an issue](../../issues) with your suggestion, or even better, submit a pull request.
+
+### Pull Requests
+
+We welcome contributions! Before submitting a pull request, please ensure:
+
+- Your code adheres to the existing coding style.
+- You have documented any new features or changes.
+
+## Getting Started
+
+### Fork the Repository
+
+Click on the "Fork" button at the top right of the repository page to create your copy.
+
+### Clone the Repository
+
+Clone your forked repository to your local machine:
+
+```bash
+git clone https://github.com/kkMihai/virtualizorjs.git
+```
+
+### Install Dependencies
+
+Navigate to the project directory and install dependencies:
+
+```bash
+cd virtualizorjs
+npm install
+```
+
+### Make Changes
+
+Make your changes and add new features or fix bugs.
+
+### Test Your Changes
+
+Ensure that your changes don't introduce new issues. Run tests and fix any failures:
+
+```bash
+npm test
+```
+
+## Submitting a Pull Request
+
+When you're ready to submit your changes:
+
+1. Commit your changes: `git commit -m "Your commit message"`
+2. Push to your fork: `git push origin your-branch`
+3. Open a pull request from your fork to the `main` branch of the original repository.
+
+Our team will review your pull request and provide feedback. Thank you for contributing to VirtualizorJS!
+
+## Code of Conduct
+
+Please follow our [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions.
+
+## License
+
+By contributing to VirtualizorJS, you agree that your contributions will be licensed under the [MIT License](LICENSE).

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 kkMihai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,120 @@
+# VirtualizorJS
+
+Since there is no SDK's for Node.js for the Virtualizor API, I decided to create one, and one that is actually easy to use and useful with **0 Dependencies** keeping it `Lightweight` and `Fast`.
+
+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)
+
+## Important
+ - As of `19 January 2024` Not all Virtualizor API functions are tested fully. ( i m busy (just lazy lmao))
+
+## Table of Contents
+- [Installation](#installation)
+- [Usage](#usage)
+- [Examples](#examples)
+- [API Documentation](#api-documentation)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+```bash
+npm i virtualizorjs@latest
+```
+
+## Usage
+
+```javascript
+
+const VirtualizorClient = require('virtualizorjs');
+
+// Initialize VirtualizorClient
+const { ListVPS } = new VirtualizorClient({
+  host: '< IP or Hostname of Virtualizor Server >',
+  port: 4083,
+  key: "< Your API KEY >",
+  pass: "< 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.
+// Example: Get a list of all VPSs
+ListVPS().then((data) => {
+  console.log(data);
+}).catch((err) => {
+  console.log(err);
+});
+```
+
+# Event Handling Usage
+
+VirtualizorJS uses the [EventEmitter](https://nodejs.org/api/events.html) class to handle events. You can attach **`Event Listeners`** to different events provided by the VirtualizorClient.
+
+- Note: We define the "on" method as "eventOn" to avoid confusion with the EventEmitter's "on" method, However you can do it however you want this is just an example.
+
+```javascript
+const VirtualizorClient = require('virtualizorjs'); 
+
+// We define the "on" method as "eventOn" to avoid confusion with the EventEmitter's "on" method, However you can do it however you want this is just an example.
+// The "eventOn" method is used to attach Event Listeners to different events provided by the VirtualizorClient.
+const { on: eventOn } = new VirtualizorClient({
+  host: '< IP or Hostname of Virtualizor Server >',
+  port: 4083,
+  key: "< Your API KEY >",
+  pass: "< Your API PASS >",
+});
+
+// - Event Types - :
+// 1. vpsCreated
+// 2. vpsStarted
+// 3. vpsStopped
+// 4. vpsRestarted
+
+// Event listener for when a virtual server is created
+eventOn('vpsCreated', (response) => {
+  console.log(`Virtual Server Created! Details:`, response);
+});
+
+// Event listener for when a virtual server is started
+eventOn('vpsStarted', (response) => {
+  console.log(`Virtual Server Started! Details:`, response);
+});
+
+// Event listener for when a virtual server is stopped
+eventOn('vpsStopped', (response) => {
+  console.log(`Virtual Server Stopped! Details:`, response);
+});
+
+// Event listener for when a virtual server is restarted
+eventOn('vpsRestarted', (response) => {
+  console.log(`Virtual Server Restarted! Details:`, response);
+});
+```
+
+## ❓ What's the point of using **`Event Listeners`**?
+ - **`Event Listeners`** are useful when you want to perform an action when a certain event occurs without modifying the source code of the **`VirtualizorJS`** library to avoid breaking changes.
+ - For example, you can use **`Event Listeners`** to send a notification to your `users` when a event is triggered.
+ - You can also use **`Event Listeners`** to perform an action when a event is triggered.
+
+## Examples
+
+- [Get VPS's List](/examples/listvps.js)
+- [Create VPS](/examples/createvps.js)
+- [Using Event Handling](/examples/eventhandling.js)
+
+
+## Documentation
+
+- Check the [Wiki](https://github.com/kkMihai/virtualizorjs/wiki) for detailed documentation.
+
+## Roadmap
+  - [ ] Add Proxmox KVM Support
+  - [ ] Add Virtualization Types enums
+
+## Contributing
+
+- Feel free to contribute by opening issues or submitting pull requests. See [CONTRIBUTING](/CONTRIBUTING.md) for details.
+
+## License
+
+- This project is licensed under the MIT License - see the [LICENSE](/LICENSE) file for details.

package/SECURITY.md

@@ -0,0 +1,25 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.0.0   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+If you discover any security issues within the project, please report them by following these guidelines:
+
+1. **Go to the Issues section:** Visit [GitHub Issues](https://github.com/kkMihai/virtualizorjs/issues) to check if the vulnerability has already been reported or discussed.
+
+2. **Open a New Issue:** If the vulnerability is not reported, please open a new issue.
+
+3. **Provide Details:** Clearly describe the nature of the vulnerability, including steps to reproduce if possible. The more information you provide, the easier it is for us to understand and address the issue.
+
+4. **Expectations:** We will acknowledge your report within a reasonable timeframe and strive to keep you informed of the progress.
+
+5. **Resolution:** Once the vulnerability is validated, we will work on resolving it. The timeline for resolution may vary based on the severity of the issue.
+
+Please note that this security policy applies to supported versions. Ensure you are using a supported version before reporting any vulnerabilities.
+
+Thank you for helping us keep VirtualizorJS secure!

package/examples/createvps.js

@@ -0,0 +1,33 @@
+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 >",
+});
+
+async function exampleUsage() {
+  try {
+     const vps = await CreateVPS({
+      virtualizationType: "kvm",
+      nodeSelection: "node1",
+      userEmail: "user@example.com",
+      userPassword: "password",
+      serverHostname: "serverhostname",
+      rootPassword: "password",
+      osId: "222",
+      ipAddress: "188.0.0.0",
+      storageSpace: "10", // GB
+      serverRam: "1024", // MB
+      bandwidthLimit: "1000", // GB | 0 for unlimited
+      cpuCores: "1",
+    });
+
+    console.log(vps); // Output: { time_taken: 0.022, ... }
+  } catch (error) {
+    console.error("Error:", error);
+  }
+}
+
+exampleUsage();

package/examples/eventhandling.js

@@ -0,0 +1,32 @@
+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 >",
+});
+
+// Event listener for when a virtual server is created
+eventOn('vpsCreated', (response) => {
+  console.log(`Virtual Server Created! Details:`, response);
+  // Output: Virtual Server Created! Details: { ...virtualizorResponse }
+});
+
+// Event listener for when a virtual server is started
+eventOn('vpsStarted', (response) => {
+  console.log(`Virtual Server Started! Details:`, response);
+  // Output: Virtual Server Started! Details: { ...virtualizorResponse }
+});
+
+// Event listener for when a virtual server is stopped
+eventOn('vpsStopped', (response) => {
+  console.log(`Virtual Server Stopped! Details:`, response);
+    // Output: Virtual Server Stopped! Details: { ...virtualizorResponse }
+});
+
+// Event listener for when a virtual server is restarted
+eventOn('vpsRestarted', (response) => {
+  console.log(`Virtual Server Restarted! Details:`, response);
+    // Output: Virtual Server Restarted! Details: { ...virtualizorResponse }
+});

package/examples/listvps.js

@@ -0,0 +1,117 @@
+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 >",
+});
+
+async function exampleUsage() {
+  try {
+    const vpsList = await ListVPS();
+    console.log(vpsList);
+    //Output:
+    // {
+    //   "37": {
+    //     "vpsid": "37",
+    //     "vps_name": "v1001",
+    //     "uuid": "mark7ygoeqtfdf72",
+    //     "serid": 0,
+    //     "time": "1534260671",
+    //     "edittime": "1534499180",
+    //     "virt": "kvm",
+    //     "uid": "55",
+    //     "plid": "1",
+    //     "hostname": "www.mydomainff.com",
+    //     "osid": "270",
+    //     "os_name": "centos-6.5-x86",
+    //     "iso": "",
+    //     "sec_iso": "",
+    //     "boot": "cda",
+    //     "space": "2",
+    //     "inodes": "0",
+    //     "ram": "128",
+    //     "burst": "0",
+    //     "swap": "128",
+    //     "cpu": "1000",
+    //     "cores": "1",
+    //     "cpupin": "-1",
+    //     "cpu_percent": "0.00",
+    //     "bandwidth": "1",
+    //     "network_speed": "0",
+    //     "upload_speed": "-1",
+    //     "io": "0",
+    //     "ubc": "a:0:{}",
+    //     "acpi": "1",
+    //     "apic": "1",
+    //     "pae": "1",
+    //     "shadow": "0",
+    //     "vnc": "1",
+    //     "vncport": "5901",
+    //     "vnc_passwd": "",
+    //     "hvm": "0",
+    //     "suspended": "0",
+    //     "suspend_reason": null,
+    //     "nw_suspended": null,
+    //     "rescue": "0",
+    //     "band_suspend": "0",
+    //     "tuntap": "0",
+    //     "ppp": "0",
+    //     "ploop": "0",
+    //     "dns_nameserver": "a:0:{}",
+    //     "osreinstall_limit": "0",
+    //     "preferences": null,
+    //     "nic_type": "virtio",
+    //     "vif_type": "",
+    //     "virtio": "0",
+    //     "pv_on_hvm": "0",
+    //     "disks": null,
+    //     "kvm_cache": "0",
+    //     "io_mode": "0",
+    //     "cpu_mode": "default",
+    //     "total_iops_sec": "0",
+    //     "read_bytes_sec": "0",
+    //     "write_bytes_sec": "0",
+    //     "kvm_vga": "0",
+    //     "acceleration": "0",
+    //     "vnc_keymap": "en-us",
+    //     "routing": "0",
+    //     "mg": "",
+    //     "used_bandwidth": "0.01",
+    //     "cached_disk": "a:2:{s:4:\"disk\";a:3:{s:4:\"Used\";i:776044;s:9:\"Available\";i:1190036;s:4:\"Use%\";d:39.469999999999998863131622783839702606201171875;}s:5:\"inode\";a:4:{s:6:\"Inodes\";i:122880;s:5:\"IUsed\";i:21323;s:5:\"IFree\";i:101557;s:4:\"Use%\";d:17.35000000000000142108547152020037174224853515625;}}",
+    //     "webuzo": "0",
+    //     "disable_ebtables": "0",
+    //     "install_xentools": "0",
+    //     "admin_managed": "0",
+    //     "rdp": "0",
+    //     "topology_sockets": "0",
+    //     "topology_cores": "0",
+    //     "topology_threads": "0",
+    //     "mac": "00:16:3e:5f:cd:48",
+    //     "notes": null,
+    //     "disable_nw_config": "0",
+    //     "locked": "",
+    //     "openvz_features": "",
+    //     "speed_cap": "",
+    //     "numa": "0",
+    //     "bpid": "0",
+    //     "bserid": "0",
+    //     "timezone": null,
+    //     "usbdevice": "",
+    //     "server_name": "localhost",
+    //     "email": "tt@rrr.com",
+    //     "pid": "0",
+    //     "type": "0",
+    //     "os_distro": "centos",
+    //     "ips": {
+    //       "2": "8.8.8.1"
+    //     }
+    //   }
+    // }
+  } catch (error) {
+    console.error("Error:", error);
+  }
+}
+
+exampleUsage();

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "virtualizorjs",
+  "version": "1.0.0-beta",
+  "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",
+  "keywords": [
+    "virtualizor",
+    "api",
+    "nodejs",
+    "js",
+    "sdk",
+    "wrapper",
+    "virtualizorjs",
+    "virtualizor-js",
+    "virtualizorjs-api",
+    "virtualizorjs-wrapper",
+    "virtualizorjs-sdk",
+    "lightweight",
+    "easy",
+    "simple",
+    "powerful",
+    "fast"
+  ],
+  "author": "kkMihai",
+  "license": "MIT",
+  "github": "https://github.com/kkMihai/virtualizorjs",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kkMihai/virtualizorjs.git"
+  },
+  "bugs": {
+    "url": "https://github.com/kkMihai/virtualizorjs/issues"
+  },
+  "homepage": "https://github.com/kkMihai/virtualizorjs#readme",
+  "engines": {
+    "node": ">=12.0.0"
+  }
+}

package/src/Actions.js

@@ -0,0 +1,73 @@
+/**
+ * @description Actions that can be performed on the server. Made available as an enum incase the API changes.
+ * @enum {string}
+ * @readonly
+ */
+module.exports = {
+  /**
+   * Action to add a new virtual private server (VPS).
+   * @type {string}
+   */
+  AddVPS: "addvs",
+
+  /**
+   * Action to manage a VPS.
+   * @type {string}
+   */
+  VPSManage: "vpsmanage",
+
+  /**
+   * Action to list all VPS.
+   * @type {string}
+   */
+  ListVPS: "vs",
+
+  /**
+   * Action to start a VPS.
+   * @type {string}
+   */
+  StartVPS: "start",
+
+  /**
+   * Action to stop a VPS.
+   * @type {string}
+   */
+  StopVPS: "stop",
+
+  /**
+   * Action to restart a VPS.
+   * @type {string}
+   */
+  RestartVPS: "restart",
+
+  /**
+   * Action to get VPS RAM information.
+   * @type {string}
+   */
+  GetVPSRam: "ram",
+
+  /**
+   * Action to get VPS CPU information.
+   * @type {string}
+   */
+  GetVPSCPU: "cpu",
+
+  /**
+   * Action to get VPS disk information.
+   * @type {string}
+   */
+  GetVPSDisk: "disk",
+
+  /**
+   * Action to get Server Bandwidth information.
+   * @type {string}
+   */
+  GetServerBandwidth: "bandwidth",
+
+  /**
+   *  Action to get VPS Bandwidth information.
+   *  @type {string}
+   */
+
+  GetPlans: "plans",
+};

package/src/VirtualizorClient.js

@@ -0,0 +1,536 @@
+const https = require("https");
+const { URLSearchParams } = require("url");
+const EventEmitter = require("events");
+
+/**
+ * @description - This class contains some the actions supported by Virtualizor API
+ * @class Actions
+ * @static
+ * @readonly
+ * @memberof VirtualizorClient
+ * @enum {string}
+ */
+
+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
+ * @returns {VirtualizorClient} VirtualizorClient
+ */
+
+class VirtualizorClient extends EventEmitter {
+  constructor({ host, port, key, pass, isRawResponse = false }) {
+    super();
+    this.host = host;
+    this.port = port;
+    this.key = key;
+    this.pass = pass;
+    this.isRawResponse = isRawResponse
+
+    /**
+     * @description - Bind Methods
+     * @memberof VirtualizorClient
+     */
+    this.CreateVPS = this.CreateVPS.bind(this);
+    this.GetVPS = this.GetVPS.bind(this);
+    this.ListVPS = this.ListVPS.bind(this);
+    this.StartVPS = this.StartVPS.bind(this);
+    this.StopVPS = this.StopVPS.bind(this);
+    this.RestartVPS = this.RestartVPS.bind(this);
+    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.GetPlans = this.GetPlans.bind(this);
+  }
+
+  /**
+   * @description - This method is used to build query string and should not be used externally
+   * @param {Object} params
+   * @returns {String} query string
+   * @memberof VirtualizorClient
+   * @private
+   */
+  buildQueryString(params) {
+    params.api = "json";
+    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
+   * @returns {Promise} Promise
+   * @memberof VirtualizorClient
+   * @private
+   */
+  makeHttpRequest(path, method = "GET", postData) {
+    const options = {
+      host: this.host,
+      port: this.port,
+      path: path,
+      method: method,
+      headers: {
+        "Content-Type": "application/x-www-form-urlencoded",
+      },
+      agent: new https.Agent({ rejectUnauthorized: false }),
+    };
+
+    return new Promise((resolve, reject) => {
+      const req = https.request(options, (res) => {
+        let data = "";
+
+        res.on("data", (chunk) => {
+          data += chunk;
+        });
+
+        res.on("end", () => {
+          try {
+            const parsedData = JSON.parse(data);
+            resolve(parsedData);
+          } catch (error) {
+            reject(error);
+          }
+        });
+      });
+
+      req.on("error", (error) => {
+        reject(error);
+      });
+
+      if (postData) {
+        req.write(postData);
+      }
+
+      req.end();
+    });
+  }
+
+  /**
+   * @description - This method is used to create a new virtual server
+   * @param {Object} params - Parameters for creating a new virtual server
+   * @param {Object | String} params.storageSpace - Format { Size: Number, st_uuid: String }
+   * @returns {Promise} Promise
+   * @memberof VirtualizorClient
+   */
+  async CreateVPS({
+    virtualizationType,
+    nodeSelection,
+    userEmail,
+    userPassword,
+    serverHostname,
+    rootPassword,
+    osId,
+    ipAddress,
+    storageSpace,
+    serverRam,
+    bandwidthLimit,
+    cpuCores,
+  }) {
+    /**
+     * @description - This method is used to handle storage space parameter, This in GB
+     * @param {Array|Number} space
+     * @returns {Number | Promise} Promise
+     * @memberof VirtualizorClient
+     * @private
+     */
+
+    function handleDiskSpace(space) {
+      if (Array.isArray(space)) {
+        return space.reduce((acc, curr) => acc + curr, 0);
+      }
+      return space;
+    }
+
+    const queryParams = {
+      action: Actions.AddVPS,
+      virt: virtualizationType,
+      node_select: nodeSelection,
+      user_email: userEmail,
+      user_pass: userPassword,
+      hostname: serverHostname,
+      root_pass: rootPassword,
+      os_id: osId,
+      ips: ipAddress,
+      space: handleDiskSpace(storageSpace),
+      ram: serverRam,
+      bandwidth: bandwidthLimit,
+      cores: cpuCores,
+      key: this.key,
+      pass: this.pass,
+    };
+
+    const path = `/index.php${this.buildQueryString(queryParams)}`;
+
+    try {
+      const response = await this.makeHttpRequest(path, "POST");
+      this.emit("vpsCreated", response);
+      return Promise.resolve({
+        message: response.done && response.done.msg,
+        data: response,
+      });
+    } catch (error) {
+      return Promise.reject(error);
+    }
+  }
+
+  /**
+   * @description - This method is used to get information about a virtual server
+   * @param {String} id - ID of the virtual server
+   * @returns {Promise} Promise
+   * @memberof VirtualizorClient
+   */
+  async GetVPS(id) {
+    const queryParams = {
+      act: Actions.VPSManage,
+      changeserid: id,
+      key: this.key,
+      pass: this.pass,
+    };
+
+    const path = `/index.php${this.buildQueryString(queryParams)}`;
+
+    try {
+      const res = await this.makeHttpRequest(path);
+      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,
+        };
+      }
+
+      return Promise.resolve(resData);
+    } catch (err) {
+      return Promise.reject(err);
+    }
+  }
+
+  /**
+ * @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
+ */
+async ListVPS(
+  vpsid,
+  vpsname,
+  vpsip,
+  vpshostname,
+  vpsstatus,
+  vstype,
+  speedcap,
+  user,
+  vsgid,
+  vserid,
+  plid,
+  bpid,
+  reslen,
+  page
+) {
+  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,
+  };
+
+  const path = `/index.php${this.buildQueryString(queryParams)}`;
+
+  try {
+    const res = await this.makeHttpRequest(path, "POST");
+    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;
+      }, []);
+    }
+
+    return Promise.resolve(resData);
+  } catch (err) {
+    return Promise.reject(err);
+  }
+}
+
+
+  /**
+   * @description - This method is used to start a virtual server
+   * @param {String} vpsId - ID of the virtual server
+   * @returns {Promise} Promise
+   * @memberof VirtualizorClient
+   */
+  async StartVPS(vpsId) {
+    const queryParams = {
+      act: Actions.StartVPS,
+      vpsid: vpsId,
+      key: this.key,
+      pass: this.pass,
+    };
+
+    const path = `/index.php${this.buildQueryString(queryParams)}&action=vs`;
+
+    try {
+      const res = await this.makeHttpRequest(path);
+      this.emit("vpsStarted", res);
+      return Promise.resolve({
+        message: res.done && res.done.msg,
+        time_taken: res.time_taken,
+      });
+    } catch (err) {
+      return Promise.reject(err);
+    }
+  }
+
+  /**
+   * @description - This method is used to stop a virtual server
+   * @param {String} vpsId - ID of the virtual server
+   * @returns {Promise} Promise
+   * @memberof VirtualizorClient
+   */
+  async StopVPS(vpsId) {
+    const queryParams = {
+      act: Actions.StopVPS,
+      vpsid: vpsId,
+      key: this.key,
+      pass: this.pass,
+    };
+
+    const path = `/index.php${this.buildQueryString(queryParams)}&action=vs`;
+
+    try {
+      const res = await this.makeHttpRequest(path);
+      this.emit("vpsStopped", res);
+      return Promise.resolve({
+        message: res.done && res.done.msg,
+        time_taken: res.time_taken,
+      });
+    } catch (err) {
+      return Promise.reject(err);
+    }
+  }
+
+  /**
+   * @description - This method is used to restart a virtual server
+   * @param {String} vpsId - ID of the virtual server
+   * @returns {Promise} Promise
+   * @memberof VirtualizorClient
+   */
+  async RestartVPS(vpsId) {
+    const queryParams = {
+      act: Actions.RestartVPS,
+      vpsid: vpsId,
+      key: this.key,
+      pass: this.pass,
+    };
+
+    const path = `/index.php${this.buildQueryString(queryParams)}&action=vs`;
+
+    try {
+      const res = await this.makeHttpRequest(path);
+      this.emit("vpsRestarted", res);
+      return Promise.resolve({
+        message: res.done && res.done.msg,
+        time_taken: res.time_taken,
+      });
+    } catch (err) {
+      return Promise.reject(err);
+    }
+  }
+
+  /**
+   * @description - This method is used to get RAM information of a virtual server
+   * @param {String} vpsId - ID of the virtual server
+   * @returns {Promise} Promise
+   * @memberof VirtualizorClient
+   */
+  async GetVPSRam(vpsId) {
+    const queryParams = {
+      act: Actions.GetVPSRam,
+      changeserid: vpsId,
+      key: this.key,
+      pass: this.pass,
+    };
+
+    const path = `/index.php${this.buildQueryString(queryParams)}`;
+
+    try {
+      const res = await this.makeHttpRequest(path);
+      return Promise.resolve({
+        ram: res.ram,
+        time_taken: res.time_taken,
+      });
+    } catch (err) {
+      return Promise.reject(err);
+    }
+  }
+
+  /**
+   * @description - This method is used to get CPU information of a virtual server
+   * @param {String} vpsId - ID of the virtual server
+   * @returns {Promise} Promise
+   * @memberof VirtualizorClient
+   */
+  async GetVPSCPU(vpsId) {
+    const queryParams = {
+      act: Actions.GetVPSCPU,
+      changeserid: vpsId,
+      key: this.key,
+      pass: this.pass,
+    };
+
+    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,
+      });
+    } catch (err) {
+      return Promise.reject(err);
+    }
+  }
+
+  /**
+   * @description - This method is used to get disk information of a virtual server
+   * @param {String} vpsId - ID of the virtual server
+   * @returns {Promise} Promise
+   * @memberof VirtualizorClient
+   */
+  async GetVPSDisk(vpsId) {
+    const queryParams = {
+      act: Actions.GetVPSDisk,
+      changeserid: vpsId,
+      key: this.key,
+      pass: this.pass,
+    };
+
+    const path = `/index.php${this.buildQueryString(queryParams)}`;
+
+    try {
+      const res = await this.makeHttpRequest(path);
+      return Promise.resolve({
+        disk: res.disk,
+        time_taken: res.time_taken,
+      });
+    } catch (err) {
+      return Promise.reject(err);
+    }
+  }
+
+  /**
+   * @description - This method is used to get bandwidth information of a virtual server
+   * @param {String} month - Month for which bandwidth information is required (YYYY-MM)
+   * @returns {Promise} Promise
+   * @memberof VirtualizorClient
+   */
+  async GetServerBandwidth(month) {
+    const queryParams = {
+      act: Actions.GetServerBandwidth,
+      key: this.key,
+      pass: this.pass,
+    };
+
+    const path = `/index.php${this.buildQueryString(queryParams)}`;
+
+    try {
+      const res = await this.makeHttpRequest(path, "GET", `show=${month}`);
+      return Promise.resolve({
+        bandwidth: res.bandwidth,
+        time_taken: res.time_taken,
+      });
+    } catch (err) {
+      return Promise.reject(err);
+    }
+  }
+
+  async GetPlans() {
+    const queryParams = {
+      act: Actions.GetPlans,
+      key: this.key,
+      pass: this.pass,
+    };
+
+    const path = `/index.php${this.buildQueryString(queryParams)}`;
+
+    try {
+      const res = await this.makeHttpRequest(path);
+      return Promise.resolve(res);
+    } catch (err) {
+      return Promise.reject(err);
+    }
+  }
+}
+
+module.exports = VirtualizorClient;