wispjs 2.1.3 → 2.1.4

package/dist/wisp_api/apis/schedules.d.ts

@@ -0,0 +1,179 @@
+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 declare class SchedulesAPI {
+    private core;
+    constructor(core: WispAPICore);
+    /**
+     * Retrieves all of the Schedules for the Server
+     *
+     * @public
+     */
+    List(): Promise<GetSchedulesResponse>;
+    /**
+     * Retrieves the Details for the Schedule
+     *
+     * @param id The ID of the Schedule
+     *
+     * @public
+     */
+    GetDetails(id: string): Promise<Schedule>;
+    /**
+     * 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
+     */
+    Create(name: string, minute: string, hour: string, dow: string, dom: string, active: boolean): Promise<Schedule>;
+    /**
+     * 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
+     */
+    Update(id: string, name: string, minute: string, hour: string, dow: string, dom: string, active: boolean): Promise<Schedule>;
+    /**
+     * Triggers the Schedule
+     *
+     * @param id The ID of the Schedule
+     *
+     * @public
+     */
+    Trigger(id: string): Promise<void>;
+    /**
+     * Deletes the Schedule
+     *
+     * @param id The ID of the Schedule
+     *
+     * @public
+     */
+    Delete(id: string): Promise<void>;
+    /**
+     * 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
+     */
+    CreateTask(id: string, action: ScheduleTaskAction, timeOffset: number, payload: string | null): Promise<ScheduleTask>;
+    /**
+     * 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
+     */
+    UpdateTask(scheduleID: string, taskID: string, action: ScheduleTaskAction, timeOffset: number, payload: string | null): Promise<ScheduleTask>;
+    /**
+     * Delete the Task
+     *
+     * @param scheduleID The ID of the Schedule that contains the Task
+     * @param taskID The ID of the Task
+     *
+     * @public
+     */
+    DeleteTask(scheduleID: string, taskID: string): Promise<void>;
+}

package/dist/wisp_api/apis/schedules.js

@@ -0,0 +1,167 @@
+/**
+ * Handles interactions with Server Schedules
+ *
+ * @public
+ */
+export class SchedulesAPI {
+    constructor(core) {
+        this.core = core;
+    }
+    /**
+     * Retrieves all of the Schedules for the Server
+     *
+     * @public
+     */
+    async List() {
+        const response = await this.core.makeRequest("GET", "schedules", { include: "tasks" });
+        const data = await response.json();
+        return data;
+    }
+    /**
+     * Retrieves the Details for the Schedule
+     *
+     * @param id The ID of the Schedule
+     *
+     * @public
+     */
+    async GetDetails(id) {
+        const response = await this.core.makeRequest("GET", `schedules/${id}`, { include: "tasks" });
+        const data = 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, minute, hour, dow, dom, active) {
+        const requestData = {
+            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 = 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, name, minute, hour, dow, dom, active) {
+        const requestData = {
+            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 = await response.json();
+        return data;
+    }
+    /**
+     * Triggers the Schedule
+     *
+     * @param id The ID of the Schedule
+     *
+     * @public
+     */
+    async Trigger(id) {
+        await this.core.makeRequest("POST", `schedules/${id}`);
+    }
+    /**
+     * Deletes the Schedule
+     *
+     * @param id The ID of the Schedule
+     *
+     * @public
+     */
+    async Delete(id) {
+        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, action, timeOffset, payload) {
+        const requestData = {
+            action: action,
+            time_offset: timeOffset,
+            payload: payload
+        };
+        const response = await this.core.makeRequest("POST", `schedules/${id}/tasks`, requestData);
+        const data = 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, taskID, action, timeOffset, payload) {
+        const requestData = {
+            action: action,
+            time_offset: timeOffset,
+            payload: payload
+        };
+        const response = await this.core.makeRequest("PATCH", `schedules/${scheduleID}/tasks/${taskID}`, requestData);
+        const data = 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, taskID) {
+        await this.core.makeRequest("DELETE", `schedules/${scheduleID}/tasks/${taskID}`);
+    }
+}

package/dist/wisp_api/apis/servers.d.ts

@@ -0,0 +1,120 @@
+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;
+        };
+    };
+}
+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 declare class ServersAPI {
+    private core;
+    constructor(core: WispAPICore);
+    /**
+     * Sends a command to the Server
+     *
+     * @param command The full command string to send to the Server
+     *
+     * @public
+     */
+    SendCommand(command: string): Promise<void>;
+    /**
+     * Gets the Websocket connection (and upload) details for the Server
+     *
+     * @public
+     */
+    GetWebsocketDetails(): Promise<GetWebsocketDetailsResponse>;
+    /**
+     * 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
+     */
+    SetName(name: string): Promise<GetDetailsResponse>;
+    /**
+     * Retrieves the basic, technical details of the Server
+     *
+     * @public
+     */
+    GetDetails(): Promise<GetDetailsResponse>;
+    /**
+     * Retrieves technical details of the Server's resources
+     * (CPU, Memory, Disk, Network)
+     *
+     * @public
+     */
+    GetResources(): Promise<GetResourcesResponse>;
+    /**
+     * 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
+     */
+    PowerRequest(action: PowerRequest): Promise<void>;
+}

package/dist/wisp_api/apis/servers.js

@@ -0,0 +1,76 @@
+/**
+ * Handles generic Server interaction, such as Sending Commands, managing Power State, and getting Details
+ *
+ * @public
+ */
+export class ServersAPI {
+    constructor(core) {
+        this.core = core;
+    }
+    /**
+     * Sends a command to the Server
+     *
+     * @param command The full command string to send to the Server
+     *
+     * @public
+     */
+    async SendCommand(command) {
+        await this.core.makeRequest("POST", "command", { command: command });
+    }
+    /**
+     * Gets the Websocket connection (and upload) details for the Server
+     *
+     * @public
+     */
+    async GetWebsocketDetails() {
+        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) {
+        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() {
+        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() {
+        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) {
+        await this.core.makeRequest("POST", "power", { signal: action });
+    }
+}

package/dist/wisp_api/apis/startup.d.ts

@@ -0,0 +1,52 @@
+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 declare class StartupAPI {
+    private core;
+    constructor(core: WispAPICore);
+    /**
+     * Gets all Startup details for the Server
+     *
+     * @public
+     */
+    Get(): Promise<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
+     */
+    Update(startup: UpdateStartup): Promise<StartupDetails>;
+}

package/dist/wisp_api/apis/startup.js

@@ -0,0 +1,35 @@
+/**
+ * Handles interaction with Server Startup information
+ *
+ * @public
+ */
+export class StartupAPI {
+    constructor(core) {
+        this.core = core;
+    }
+    /**
+     * Gets all Startup details for the Server
+     *
+     * @public
+     */
+    async Get() {
+        const response = await this.core.makeRequest("GET", "startup");
+        const 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) {
+        const response = await this.core.makeRequest("PUT", "startup", startup);
+        const data = await response.json();
+        return data;
+    }
+}