wispjs 2.4.0 → 3.0.0

package/wisp_api/apis/index.ts

@@ -1,135 +0,0 @@
-export type RequestTypes = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
-
-export interface PaginationData {
-  total: number;
-  count: number;
-  perPage: number;
-  currentPage: number;
-  totalPages: number;
-}
-
-export interface WispAPICore {
-  domain: string;
-  uuid: string;
-  token: string;
-  logger: any;
-}
-
-/**
- * The Core of the API, handling low-level operations such as making requests and setting the server UUID
- *
- * @public
- */
-export class WispAPICore {
-  constructor(domain: string, uuid: string, token: string, logger: any) {
-    this.domain = domain;
-    this.uuid = uuid;
-    this.token = token;
-    this.logger = logger;
-  }
-
-  /**
-   * Sets the Server UUID
-   *
-   * @remarks
-   * ℹ️  This can be updated at any time, making all future API calls reference the new Server UUID
-   *
-   * @public
-   */
-  setUUID(uuid: string) {
-    this.uuid = uuid;
-  }
-
-  /**
-   * Generates a URL for the given path
-   *
-   * @param path The API path
-   *
-   * @internal
-   */
-  makeURL(path: string) {
-    return `https://${this.domain}/api/client/servers/${this.uuid}/${path}`;
-  }
-
-  // TODO: Handle standard field-level error messages:
-  // {"errors":[{"code":"required","detail":"The path field is required","source":{"field":"path"}}]}
-  /**
-   * Makes a request with the headers and request data set automatically.
-   *
-   * @remarks
-   * The data field is formatted appropriately for whichever request type is given.
-   *
-   * @param method A standared request method.
-   * @param path The API path to send the request to.
-   * @param data The data to include with the request.
-   *
-   * @internal
-   */
-  async makeRequest(method: RequestTypes, path: string, data?: any) {
-    let url = this.makeURL(path);
-    const headers = new Headers({
-      "Content-Type": "application/json",
-      "Accept": "application/vnd.wisp.v1+json",
-      "Authorization": `Bearer ${this.token}`,
-      "User-Agent": "WispJS (https://github.com/CFC-Servers/wispjs, 1.0.0)"
-    });
-
-    const request = async () => {
-      let response: Response;
-
-      console.log(`${method} -> ${url}`);
-
-      switch(method) {
-        case "GET":
-          if (data !== null) {
-            const params = new URLSearchParams(data);
-            const uri = new URL(url);
-
-            uri.search = params.toString();
-            url = uri.toString();
-            console.log(`Updated GET URL: ${url}`);
-          }
-
-          response = await fetch(url, { method: "GET", headers: headers });
-          break;
-
-        case "POST":
-          data = JSON.stringify(data);
-          response = await fetch(url, { method: "POST", headers: headers, body: data });
-          break;
-
-        case "PUT":
-          data = data ? JSON.stringify(data) : "";
-          response = await fetch(url, { method: "PUT", headers: headers, body: data });
-          break;
-
-        case "PATCH":
-          data = JSON.stringify(data);
-          response = await fetch(url, { method: "PATCH", headers: headers, body: data });
-          break;
-
-        case "DELETE":
-          response = await fetch(url, { method: "DELETE", headers: headers });
-          break;
-
-        default:
-          throw new Error(`Invalid method: ${method}`);
-      }
-
-      if (!response.ok) {
-        const status = response.status;
-        const statusText = response.statusText;
-        this.logger.error(`Request failed: ${method} -> ${url}: ${status} - ${statusText}`);
-
-        const text = await response.text();
-        this.logger.error(text);
-
-        throw new Error(`Request failed! Status: ${status} - ${statusText}`);
-      }
-
-      return response;
-    }
-
-    return await request();
-  }
-}

package/wisp_api/apis/mods.ts

@@ -1,53 +0,0 @@
-import { WispAPICore } from "./index";
-
-export interface Mod {
-  object: "mod";
-  attributes: {
-    id: number;
-    name: string;
-    description: string;
-    version: string;
-    category: string;
-    install_count: number;
-    server_state: number;
-  }
-}
-
-export interface GetModsResponse {
-  object: "list";
-  data: Mod[];
-}
-
-/**
- * Handles Listing and Installating of Mods
- *
- * @public
- */
-export class ModsAPI {
-  constructor(private core: WispAPICore) {}
-
-
-  /**
-   * Lists all Mods available to the Server
-   *
-   * @public
-   */
-  async List(): Promise<GetModsResponse> {
-    const response = await this.core.makeRequest("GET", "mods");
-    const data: GetModsResponse = await response.json();
-
-    return data;
-  }
-
-
-  /**
-   * Installs or Uninstalls the Mod with the given id
-   *
-   * @param id The ID of the Mod to Install/Uninstall
-   *
-   * @public
-   */
-  async ToggleInstall(id: string): Promise<void> {
-    await this.core.makeRequest("POST", `mods/${id}`);
-  }
-}

package/wisp_api/apis/schedules.ts

@@ -1,270 +0,0 @@
-import { WispAPICore } from "./index";
-import type { PaginationData } from "./index";
-
-/**
- * A Cron-formatted scheduling object
- *
- * @internal
- */
-export interface CronSchedule {
-  minute: string;
-  hour: string;
-  day_of_week: string;
-  day_of_month: string;
-}
-
-export interface Schedule {
-  object: "schedule";
-  attributes: {
-    id: number;
-    name: string;
-    cron: CronSchedule;
-    is_active: boolean;
-    is_processing: boolean;
-    last_run_at: string | null;
-    next_run_at: string | null;
-    created_at: string;
-    updated_at: string;
-  }
-}
-
-/**
- * A response object for the GetSchedule call
- *
- * @remarks
- * Used in {@link SchedulesAPI.List}
- *
- * @public
- */
-export interface GetSchedulesResponse {
-  object: "list";
-  data: Schedule[];
-  meta: {
-    pagination: PaginationData;
-  }
-}
-
-export interface CreateScheduleRequest {
-  name: string;
-  cron_minute: string;
-  cron_hour: string;
-  cron_day_of_week: string;
-  cron_day_of_month: string;
-  is_active: boolean;
-}
-
-export interface ScheduleTask {
-  object: "schedule_task";
-  attributes: {
-    id: number;
-    sequence_id: number;
-    action: string;
-    payload: string;
-    time_offset: string;
-    is_processing: boolean;
-    created_at: string;
-    updated_at: string;
-  }
-}
-
-export type ScheduleTaskAction = "command" | "power" | "backup";
-
-export interface CreateScheduleTaskRequest {
-  action: ScheduleTaskAction;
-  time_offset: number;
-  payload: string | null;
-}
-
-/**
- * Handles interactions with Server Schedules
- *
- * @public
- */
-export class SchedulesAPI {
-  constructor(private core: WispAPICore) {}
-
-
-  /**
-   * Retrieves all of the Schedules for the Server
-   *
-   * @public
-   */
-  async List(): Promise<GetSchedulesResponse> {
-    const response = await this.core.makeRequest("GET", "schedules", { include: "tasks" });
-    const data: GetSchedulesResponse = await response.json();
-
-    return data
-  }
-
-
-  /**
-   * Retrieves the Details for the Schedule
-   *
-   * @param id The ID of the Schedule
-   *
-   * @public
-   */
-  async GetDetails(id: string): Promise<Schedule> {
-    const response = await this.core.makeRequest("GET", `schedules/${id}`, { include: "tasks" });
-    const data: Schedule = await response.json();
-
-    return data;
-  }
-
-
-  /**
-   * Creates a new Schedule
-   *
-   * @example
-   * Creates a Schedule that runs at 12am every day
-   * ```
-   * await wisp.api.Schedules.Create("Example", "0", "0", "*", "*", true);
-   * ```
-   *
-   * @param name The name of the Schedule
-   * @param minute The Cron minute string
-   * @param hour The Cron hour string
-   * @param dow The Cron day of week string
-   * @param dom The Cron day of month string
-   * @param active Whether to enable the Schedle on creation
-   *
-   * @public
-   */
-  async Create(name: string, minute: string, hour: string, dow: string, dom: string, active: boolean): Promise<Schedule> {
-    const requestData: CreateScheduleRequest = {
-      name: name,
-      cron_minute: minute,
-      cron_hour: hour,
-      cron_day_of_week: dow,
-      cron_day_of_month: dom,
-      is_active: active
-    }
-
-    const response = await this.core.makeRequest("POST", "schedules", requestData);
-    const data: Schedule = await response.json();
-
-    return data;
-  }
-
-
-  /**
-   * Updates the values of the Schedule
-   *
-   * @param id The ID of the Schedule
-   * @param name The name of the Schedule
-   * @param minute The Cron minute string
-   * @param hour The Cron hour string
-   * @param dow The Cron day of week string
-   * @param dom The Cron day of month string
-   * @param active Whether to enable the Schedle on creation
-   *
-   * @public
-   */
-  async Update(id: string, name: string, minute: string, hour: string, dow: string, dom: string, active: boolean): Promise<Schedule> {
-    const requestData: CreateScheduleRequest = {
-      name: name,
-      cron_minute: minute,
-      cron_hour: hour,
-      cron_day_of_week: dow,
-      cron_day_of_month: dom,
-      is_active: active
-    }
-
-    const response = await this.core.makeRequest("PATCH", `schedules/${id}`, requestData);
-    const data: Schedule = await response.json();
-
-    return data;
-  }
-
-
-  /**
-   * Triggers the Schedule
-   *
-   * @param id The ID of the Schedule
-   *
-   * @public
-   */
-  async Trigger(id: string): Promise<void> {
-    await this.core.makeRequest("POST", `schedules/${id}`);
-  }
-
-
-  /**
-   * Deletes the Schedule
-   *
-   * @param id The ID of the Schedule
-   *
-   * @public
-   */
-  async Delete(id: string): Promise<void> {
-    await this.core.makeRequest("DELETE", `schedules/${id}`);
-  }
-
-
-  /**
-   * Creates a new Task for a Schedule
-   *
-   * @remarks
-   * ℹ️  Payload is not required for backup action!
-   *
-   * @param id The ID of the Schedule to create a Task for
-   * @param action The Task action. One of: ["command", "power", "backup"]
-   * @param timeOffset The time offset of the Task
-   * @param payload The payload to provide to the Task
-   *
-   * @public
-   */
-  async CreateTask(id: string, action: ScheduleTaskAction, timeOffset: number, payload: string | null): Promise<ScheduleTask> {
-    const requestData: CreateScheduleTaskRequest = {
-      action: action,
-      time_offset: timeOffset,
-      payload: payload
-    }
-
-    const response = await this.core.makeRequest("POST", `schedules/${id}/tasks`, requestData);
-    const data: ScheduleTask = await response.json();
-
-    return data;
-  }
-
-
-  /**
-   * Update the Task
-   *
-   * @remarks
-   * ℹ️  Payload is not required for backup action!
-   *
-   * @param scheduleID The ID of the Schedule that contains the Task
-   * @param taskID The ID of the Task
-   * @param action The Task action. One of: ["command", "power", "backup"]
-   * @param timeOffset The time offset of the Task
-   * @param payload The payload to provide to the Task
-   *
-   * @public
-   */
-  async UpdateTask(scheduleID: string, taskID: string, action: ScheduleTaskAction, timeOffset: number, payload: string | null): Promise<ScheduleTask> {
-    const requestData: CreateScheduleTaskRequest = {
-      action: action,
-      time_offset: timeOffset,
-      payload: payload
-    }
-
-    const response = await this.core.makeRequest("PATCH", `schedules/${scheduleID}/tasks/${taskID}`, requestData);
-    const data: ScheduleTask = await response.json();
-
-    return data;
-  }
-
-
-  /**
-   * Delete the Task
-   *
-   * @param scheduleID The ID of the Schedule that contains the Task
-   * @param taskID The ID of the Task
-   *
-   * @public
-   */
-  async DeleteTask(scheduleID: string, taskID: string): Promise<void> {
-    await this.core.makeRequest("DELETE", `schedules/${scheduleID}/tasks/${taskID}`);
-  }
-}

package/wisp_api/apis/servers.ts

@@ -1,155 +0,0 @@
-import { WispAPICore } from "./index";
-
-export type PowerRequest = "start" | "stop" | "restart" | "kill";
-export interface GetDetailsResponse {
-  object: "server";
-  attributes: {
-    id: number;
-    uuid: string;
-    uuid_short: string;
-    name: string;
-    description: string|null;
-    monitor: boolean;
-    support_op: boolean;
-    installed: number;
-    limits: {
-      memory: number;
-      swap: number;
-      disk: number;
-      io: number;
-      cpu: number;
-    }
-    feature_limits: {
-      databases: number;
-      backup_megabytes: number;
-    }
-  }
-  // TODO: Get permissions types from permission api
-  // TODO: This isn't present on the SetName response
-  // meta: {
-  //   extra_objects: { object: "permissions", attributes: ["server:support.update"] }
-  // }
-}
-
-export interface GetWebsocketDetailsResponse {
-  url: string;
-  upload_url: string;
-  token: string;
-}
-
-export interface GetResourcesResponse {
-  status: number;
-  proc: {
-    memory: {
-      total: number;
-      limit: number;
-    }
-    cpu: {
-      total: number;
-      limit: number;
-    }
-    disk: {
-      used: number;
-      limit: number;
-      io_limit: number;
-    }
-    network: {
-      [key:string]: {
-        rx_bytes: number;
-        rx_packets: number;
-        rx_errors: number;
-        rx_dropped: number;
-        tx_bytes: number;
-        tx_packets: number;
-        tx_errors: number;
-        tx_dropped: number;
-      }
-    }
-  }
-}
-
-/**
- * Handles generic Server interaction, such as Sending Commands, managing Power State, and getting Details
- *
- * @public
- */
-export class ServersAPI {
-  constructor(private core: WispAPICore) {}
-
-
-  /**
-   * Sends a command to the Server
-   *
-   * @param command The full command string to send to the Server
-   *
-   * @public
-   */
-  async SendCommand(command: string): Promise<void> {
-    await this.core.makeRequest("POST", "command", { command: command });
-  }
-
-
-  /**
-   * Gets the Websocket connection (and upload) details for the Server
-   *
-   * @public
-   */
-  async GetWebsocketDetails(): Promise<GetWebsocketDetailsResponse> {
-    const response = await this.core.makeRequest("GET", "websocket");
-    return await response.json();
-  }
-
-
-  /**
-   * Sets the name of the Server as it appears in the panel
-   * (Same thing as setting the name in the "Server Details" menu)
-   *
-   * @param name The new name of the server
-   *
-   * @public
-   */
-  async SetName(name: string): Promise<GetDetailsResponse> {
-    const response = await this.core.makeRequest("PATCH", "details", { name: name });
-    return await response.json();
-  }
-
-
-  /**
-   * Retrieves the basic, technical details of the Server
-   *
-   * @public
-   */
-  async GetDetails(): Promise<GetDetailsResponse> {
-    const response = await this.core.makeRequest("GET", "");
-    return await response.json();
-  }
-
-  /**
-   * Retrieves technical details of the Server's resources
-   * (CPU, Memory, Disk, Network)
-   *
-   * @public
-   */
-  async GetResources(): Promise<GetResourcesResponse> {
-    const response = await this.core.makeRequest("GET", "resources");
-    return await response.json();
-  }
-
-
-  /**
-   * Instructs the Server to start up, shut down, restart, or force quit
-   *
-   * @example
-   * Example of stopping the server
-   * ```
-   * await wisp.api.PowerRequest("stop");
-   * ```
-   *
-   * @param action The power action to send. One of: ["start", "stop", "restart", "kill"]
-   *
-   * @public
-   */
-  async PowerRequest(action: PowerRequest): Promise<void> {
-    await this.core.makeRequest("POST", "power", { signal: action });
-  }
-}

package/wisp_api/apis/startup.ts

@@ -1,65 +0,0 @@
-import { WispAPICore } from "./index";
-
-export interface UpdateStartup {
-  environment: { [key: string]: any };
-}
-
-export interface StartupDetail {
-  object: "server_variable";
-  attributes: {
-    name: string;
-    description: string;
-    env_variable: string;
-    default_value: string;
-    tickable: boolean;
-    user_editable: boolean;
-    rules: string;
-    server_value: string;
-  };
-}
-
-export interface StartupDetails {
-  object: "list";
-  data: StartupDetail[];
-  meta: {
-    startup_command: string;
-  };
-}
-
-/**
- * Handles interaction with Server Startup information
- *
- * @public
- */
-export class StartupAPI {
-  constructor(private core: WispAPICore) {}
-
-  /**
-   * Gets all Startup details for the Server
-   *
-   * @public
-   */
-  async Get(): Promise<StartupDetails> {
-    const response = await this.core.makeRequest("GET", "startup");
-    const startupDetails: StartupDetails = await response.json();
-
-    return startupDetails;
-  }
-
-  /**
-   * Updates the Startup details for the Server
-   *
-   * @remarks 
-   * ℹ️  Pass the variables with their new value to update them. Response will contain the new updated startup
-   *
-   * @param startup The Startup values to update
-   *
-   * @public
-   */
-  async Update(startup: UpdateStartup): Promise<StartupDetails> {
-    const response = await this.core.makeRequest("PUT", "startup", startup);
-    const data: StartupDetails = await response.json();
-
-    return data;
-  }
-}