virtualizorjs 1.0.5 → 2.1.0

package/CODE_OF_CONDUCT.md

@@ -1,128 +0,0 @@
-# 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

@@ -1,92 +0,0 @@
-
-# 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/SECURITY.md

@@ -1,26 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-| Version | Supported          |
-| ------- | ------------------ |
-| 1.0.1   | ✅ |
-| 1.0.0-beta   | ❌ |
-
-## 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

@@ -1,33 +0,0 @@
-const VirtualizorClient = require("virtualizorjs");
-
-const { CreateVPS } = new VirtualizorClient({
-  host: "< IP or Hostname of Virtualizor Server >",
-  port: 4085, // Default port for Virtualizor API
-  adminapikey: "< Your API KEY >",
-  adminapipass: "< 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

@@ -1,36 +0,0 @@
-const VirtualizorClient = require('virtualizorjs'); 
-
-const Client = new VirtualizorClient({
-  host: '< IP or Hostname of Virtualizor Server >',
-  port: 4085,
-  adminapikey: "< Your API KEY >",
-  adminapipass: "< Your API PASS >",
-});
-
-const { StartVPS } = Client;
-
-StartVPS(1);
-
-// Event listener for when a virtual server is created
-Client.on('vpsCreated', (response) => {
-  console.log(`Virtual Server Created! Details:`, response);
-  // Output: Virtual Server Created! Details: { ...virtualizorResponse }
-});
-
-// Event listener for when a virtual server is started
-Client.on('vpsStarted', (response) => {
-  console.log(`Virtual Server Started! Details:`, response);
-  // Output: Virtual Server Started! Details: { ...virtualizorResponse }
-});
-
-// Event listener for when a virtual server is stopped
-Client.on('vpsStopped', (response) => {
-  console.log(`Virtual Server Stopped! Details:`, response);
-    // Output: Virtual Server Stopped! Details: { ...virtualizorResponse }
-});
-
-// Event listener for when a virtual server is restarted
-Client.on('vpsRestarted', (response) => {
-  console.log(`Virtual Server Restarted! Details:`, response);
-    // Output: Virtual Server Restarted! Details: { ...virtualizorResponse }
-});

package/examples/listvps.js

@@ -1,117 +0,0 @@
-const VirtualizorClient = require("virtualizorjs");
-
-const { ListVPS } = new VirtualizorClient({
-  host: "< IP or Hostname of Virtualizor Server >",
-  port: 4085, // Default port for Virtualizor API
-  adminapikey: "< Your API KEY >",
-  adminapipass: "< 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/src/Actions.js

@@ -1,79 +0,0 @@
-/**
- * @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 get a VPS Info
-   * @type {string}
-  */
-  GetVPS: "vs",
-
-  /**
-   * Action to list all VPS.
-   * @type {string}
-   */
-  ListVPS: "listvs",
-
-  /**
-   * 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",
-};