wispjs 2.1.3 → 2.1.4

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;
-  }
-}

package/wisp_api/apis/subusers.ts

@@ -1,159 +0,0 @@
-import { WispAPICore } from "./index";
-import type { PaginationData } from "./index";
-
-export type SupportPermissionType = "server:support.update";
-export type ControlPermissionType = "server:control.console" | "server:control.command" | "server:control.start" | "server:control.stop" | "server:control.restart";
-export type SubuserPermissionType = "server:subuser.read" | "server:subuser.update" | "server:subuser.create" | "server:subuser.delete";
-export type AllocationPermissionType = "server:allocation.read" | "server:allocation.update";
-export type StartupPermissionType = "server:startup.read" | "server:startup.update";
-export type DatabasePermissionType = "server:database.read" | "server:database.update" | "server:database.create" | "server:database.update";
-export type FilePermissionType = "server:file.sftp" | "server:file.list" | "server:file.read" | "server:file.write" | "server:file.delete" | "server:file.archive" | "server:file.git" | "server:file.steam_workshop";
-export type SchedulePermissionType = "server:schedule.read" | "server:schedule.update" | "server:schedule.create" | "server:schedule.delete";
-export type BackupPermissionType = "server:backup.read" | "server:backup.update" | "server:backup.create" | "server:backup.delete" | "server:backup.deploy" | "server:backup.download";
-export type DetailsPermissionType = "server:details.read" | "server:details.update";
-export type AuditPermissionType = "server:audit.read";
-export type FastDLPermissionType = "server:fastdl.read" | "server:fastdl.update";
-export type ModPermissionType = "server:mod.read" | "server:mod.update";
-export type MonitorPermissionType = "server:monitor.read" | "server:monitor.update";
-export type ReinstallPermissionType = "server:reinstall.update";
-export type Permission = SupportPermissionType | ControlPermissionType | SubuserPermissionType | AllocationPermissionType | StartupPermissionType | DatabasePermissionType | FilePermissionType | SchedulePermissionType | BackupPermissionType | DetailsPermissionType | AuditPermissionType | FastDLPermissionType | ModPermissionType | MonitorPermissionType | ReinstallPermissionType;
-
-export interface User {
-  object: "user";
-  attributes: {
-    email: string;
-    name_first: string;
-    naem_last: string;
-    has_2fa: boolean;
-  }
-}
-
-export interface Subuser {
-  object: "server_subuser";
-  attributes: {
-    id: number;
-    permissions: Permission[];
-    created_at: string;
-    updated_at: string;
-    relationships: {
-      user: User;
-    }
-  }
-}
-
-export interface GetSubusersResponse {
-  object: "list";
-  data: Subuser[];
-  meta: {
-    pagination: PaginationData;
-  }
-}
-
-export interface GetAllSubuserPermissionsResponse {
-  permissions: Permission[];
-  assignable: Permission[];
-}
-
-/**
- * Handles interfacing with the Subusers API
- *
- * @public
- */
-export class SubusersAPI {
-  constructor(private core: WispAPICore) {}
-
-
-  /**
-   * Lists all Subusers for the Server
-   *
-   * @public
-   */
-  async List(): Promise<GetSubusersResponse> {
-    const response = await this.core.makeRequest("GET", "subusers", { include: "user" });
-    const data: GetSubusersResponse = await response.json();
-
-    return data;
-  }
-
-
-  /**
-   * Retrieves the details for the Subuser
-   *
-   * @param id The ID of the Subuser
-   *
-   * @public
-   */
-  async GetDetails(id: string): Promise<Subuser> {
-    const response = await this.core.makeRequest("GET", `subusers/${id}`, { include: "user" });
-    const data: Subuser = await response.json();
-
-    return data;
-  }
-
-
-  /**
-   * Get all permissions available to Subusers
-   *
-   * @public
-   */
-  async GetAllPermissions(): Promise<GetAllSubuserPermissionsResponse> {
-    const response = await this.core.makeRequest("GET", "subusers/permissions");
-    const data: GetAllSubuserPermissionsResponse = await response.json();
-
-    return data;
-  }
-
-
-  /**
-   * Creates a new Subuser
-   *
-   * @param email The email for the Subuser
-   * @param permissions The Permissions to grant to the Subuser
-   *
-   * @public
-   */
-  async Create(email: string, permissions: Permission[]): Promise<Subuser> {
-    const requestData = {
-      email: email,
-      permissions: permissions
-    }
-
-    const response = await this.core.makeRequest("POST", "subusers", requestData);
-    const data: Subuser = await response.json();
-
-    return data;
-  }
-
-
-  /**
-   * Updates the Subuser
-   *
-   * @param id The ID of the Subuser
-   * @param email The new email of the Subuser
-   * @param permissions The new permissions for the Subuser
-   *
-   * @public
-   */
-  async Update(id: string, email: string, permissions: Permission[]): Promise<Subuser> {
-    const data = {
-      email: email,
-      permissions: permissions
-    }
-
-    const response = await this.core.makeRequest("PATCH", `subusers/${id}`, data);
-    const responseData: Subuser = await response.json();
-
-    return responseData;
-  }
-
-  /**
-   * Deletes the Subuser
-   *
-   * @param id The ID of the Subuser
-   *
-   * @public
-   */
-  async Delete(id: string): Promise<void> {
-    await this.core.makeRequest("DELETE", `subusers/${id}`);
-  }
-}

package/wisp_api/index.ts

@@ -1,57 +0,0 @@
-import { WispAPICore } from "./apis/index.js";
-import { AllocationsAPI } from "./apis/allocations.js";
-import { AuditLogsAPI } from "./apis/audit_log.js";
-import { BackupsAPI } from "./apis/backups.js";
-import { DatabasesAPI } from "./apis/databases.js";
-import { FastDLAPI } from "./apis/fastdl.js";
-import { FilesystemAPI } from "./apis/filesystem.js";
-import { ModsAPI } from "./apis/mods.js";
-import { SchedulesAPI } from "./apis/schedules.js";
-import { ServersAPI } from "./apis/servers.js";
-import { StartupAPI } from "./apis/startup.js";
-import { SubusersAPI } from "./apis/subusers.js";
-
-/**
- * An Interface for the Wisp HTTP API
- *
- * @public
- */
-export class WispAPI {
-  private core: WispAPICore;
-
-  public Allocations: AllocationsAPI;
-  public AuditLogs: AuditLogsAPI;
-  public Backups: BackupsAPI;
-  public Databases: DatabasesAPI;
-  public FastDL: FastDLAPI;
-  public Filesystem: FilesystemAPI;
-  public Mods: ModsAPI;
-  public Schedules: SchedulesAPI;
-  public Servers: ServersAPI;
-  public Startup: StartupAPI;
-  public Subusers: SubusersAPI;
-
-  /**
-   * @param domain The domain name for your panel
-   * @param uuid The UUID of the Server that all future API calls will reference
-   * @param token The panel API token to use for authorization
-   * @param logger The logger to use for all API logging
-   *
-   * @internal
-   */
-  constructor(domain: string, uuid: string, token: string, logger: any) {
-    this.core = new WispAPICore(domain, uuid, token, logger);
-
-    this.Allocations = new AllocationsAPI(this.core);
-    this.AuditLogs = new AuditLogsAPI(this.core);
-    this.Backups = new BackupsAPI(this.core);
-    this.Databases = new DatabasesAPI(this.core);
-    this.FastDL = new FastDLAPI(this.core);
-    this.Filesystem = new FilesystemAPI(this.core);
-    this.Mods = new ModsAPI(this.core);
-    this.Schedules = new SchedulesAPI(this.core);
-    this.Servers = new ServersAPI(this.core);
-    this.Startup = new StartupAPI(this.core);
-    this.Subusers = new SubusersAPI(this.core);
-  }
-}