wispjs 2.1.3 → 2.2.0

package/README.md

@@ -1,7 +1,7 @@
 # WispJS
 <p align="left">
     <a href="https://discord.gg/5JUqZjzmYJ" alt="Discord Invite"><img src="https://img.shields.io/discord/981394195812085770?label=Support&logo=discord&logoColor=white" /></a>
-    <a href="https://www.npmjs.com/package/@cfc-servers/wispjs" alt="NPM Package Link"><img src="https://img.shields.io/npm/v/%40cfc-servers%2Fwispjs?label=NPM&logo=npm" /></a>
+    <a href="https://www.npmjs.com/package/wispjs" alt="NPM Package Link"><img src="https://img.shields.io/npm/v/%40cfc-servers%2Fwispjs?label=NPM&logo=npm" /></a>
     <a href="https://docs.wispjs.com" alt="Docs Link"><img src="https://img.shields.io/badge/Docs-docs.wispjs.com-blue?logo=readthedocs" /></a>
 </p>
 
@@ -20,7 +20,7 @@ We're always looking for notes about what this does/doesn't work for! Please lea
 
 ## Installation
 ```
-npm i @cfc-servers/wispjs@v2
+npm i wispjs@v2
 ```
 
 ## What can I do with this?
@@ -58,7 +58,7 @@ _(while logged in)_ and generate a new Token.
 
 In general, your WispJS code will start like this:
 ```js
-import { WispInterface } from "@cfc-servers/wispjs"
+import { WispInterface } from "wispjs"
 
 const domain = "<your.wisp.domain>"
 
@@ -81,7 +81,7 @@ For almost everything else in the Wisp panel, you use the HTTP API. Databases, s
 
 In WispJS, you access each of these as you might expect:
 ```js
-import { WispInterface } from "@cfc-servers/wispjs"
+import { WispInterface } from "wispjs"
 
 ...
 

package/{wisp.ts → dist/wisp.d.ts}

@@ -1,12 +1,10 @@
 import { WispAPI } from "./wisp_api/index.js";
 import { WispSocket } from "./wisp_socket/index.js";
-
 export interface WispInterface {
-  socket: WispSocket;
-  api: WispAPI;
-  logger: any;
+    socket: WispSocket;
+    api: WispAPI;
+    logger: any;
 }
-
 /**
  * The primary Wisp Interface, exposing interactions with both the HTTP and Websockets API
  *
@@ -17,27 +15,12 @@ export interface WispInterface {
  *
  * @public
  */
-export class WispInterface {
-  constructor(domain: string, uuid: string, token: string, ghPAT?: string) {
-    this.logger = {
-      info: (msg: any) => {
-        console.log(msg);
-      },
-      error: (msg: string) => {
-        console.error(msg);
-      }
-    };
-
-    this.api = new WispAPI(domain, uuid, token, this.logger);
-    this.socket = new WispSocket(this.logger, this.api, ghPAT);
-  }
-
-  /**
-   * Manually disconnects from the Websocket connection(s)
-   *
-   * @public
-   */
-  async disconnect() {
-    await this.socket.disconnect();
-  }
+export declare class WispInterface {
+    constructor(domain: string, uuid: string, token: string, ghPAT?: string);
+    /**
+     * Manually disconnects from the Websocket connection(s)
+     *
+     * @public
+     */
+    disconnect(): Promise<void>;
 }

package/dist/wisp.js

@@ -0,0 +1,34 @@
+import { WispAPI } from "./wisp_api/index.js";
+import { WispSocket } from "./wisp_socket/index.js";
+/**
+ * The primary Wisp Interface, exposing interactions with both the HTTP and Websockets API
+ *
+ * @param domain The Domain of the Pterodactyl/Wisp panel (e.g. `my.gamepanel.gg`)
+ * @param uuid The UUID of the server to reference in all API requests
+ * @param token The panel API token to use for authorization
+ * @param ghPAT The Github Personal Access Token used for Cloning/Pulling of private repositories. This may be omitted if you do not need to interact with private repositories
+ *
+ * @public
+ */
+export class WispInterface {
+    constructor(domain, uuid, token, ghPAT) {
+        this.logger = {
+            info: (msg) => {
+                console.log(msg);
+            },
+            error: (msg) => {
+                console.error(msg);
+            }
+        };
+        this.api = new WispAPI(domain, uuid, token, this.logger);
+        this.socket = new WispSocket(this.logger, this.api, ghPAT);
+    }
+    /**
+     * Manually disconnects from the Websocket connection(s)
+     *
+     * @public
+     */
+    async disconnect() {
+        await this.socket.disconnect();
+    }
+}

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

@@ -0,0 +1,55 @@
+import { WispAPICore } from "./index";
+import type { PaginationData } from "./index";
+/**
+ * An Allocation object
+ *
+ * @internal
+ */
+export interface Allocation {
+    object: "allocation";
+    attributes: {
+        id: number;
+        /** Whether or not this Allocation is the primary one for the Server */
+        primary: boolean;
+        ip: string;
+        port: number;
+    };
+}
+/**
+ * The response object from the GetAllocations call
+ *
+ * @remarks
+ * Used in {@link AllocationsAPI.List}
+ *
+ * @public
+ */
+export interface GetAllocationsResponse {
+    object: "list";
+    data: Allocation[];
+    meta: {
+        pagination: PaginationData;
+    };
+}
+/**
+ * Handles the listing and updating of a Server's IP/Port Allocations
+ *
+ * @public
+ */
+export declare class AllocationsAPI {
+    private core;
+    constructor(core: WispAPICore);
+    /**
+     * Lists all Allocations for the Server
+     *
+     * @public
+     */
+    List(): Promise<GetAllocationsResponse>;
+    /**
+     * Sets the new primary Allocation for the server
+     *
+     * @param id Allocation ID of the new primary allocation
+     *
+     * @public
+     */
+    Update(id: string): Promise<Allocation>;
+}

package/dist/wisp_api/apis/allocations.js

@@ -0,0 +1,32 @@
+/**
+ * Handles the listing and updating of a Server's IP/Port Allocations
+ *
+ * @public
+ */
+export class AllocationsAPI {
+    constructor(core) {
+        this.core = core;
+    }
+    /**
+     * Lists all Allocations for the Server
+     *
+     * @public
+     */
+    async List() {
+        const response = await this.core.makeRequest("GET", "allocations");
+        const data = await response.json();
+        return data;
+    }
+    /**
+     * Sets the new primary Allocation for the server
+     *
+     * @param id Allocation ID of the new primary allocation
+     *
+     * @public
+     */
+    async Update(id) {
+        const response = await this.core.makeRequest("PUT", `allocations/${id}`);
+        const data = await response.json();
+        return data;
+    }
+}

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

@@ -0,0 +1,68 @@
+import { WispAPICore } from "./index";
+import type { PaginationData } from "./index";
+/**
+ * Device information
+ *
+ * @example
+ * ```json
+ * {
+ *    "city_name": "Seattle",
+ *    "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:120.0) Gecko/20100101 Firefox/120.0",
+ *    "country_name": "US",
+ *    "country_iso_code": "US"
+ * }
+ * ```
+ *
+ * @internal
+ */
+export interface Device {
+    city_name: string;
+    user_agent: string;
+    country_name: string;
+    country_iso_code: string;
+}
+/**
+ * An Audit Log struct
+ *
+ * @internal
+ */
+export interface AuditLog {
+    object: "audit_log";
+    attributes: {
+        action: string;
+        subaction: string;
+        device: Device | undefined;
+        metadata: any;
+        created_at: string;
+    };
+}
+/**
+ * The respones object from the GetAuditLogs call
+ *
+ * @remarks
+ * Used in {@link AuditLogsAPI.List}
+ *
+ * @public
+ */
+export interface GetAuditLogsResponse {
+    object: "list";
+    data: AuditLog[];
+    meta: {
+        pagination: PaginationData;
+    };
+}
+/**
+ * Interface that handles Listing of all Audit Logs
+ *
+ * @public
+ */
+export declare class AuditLogsAPI {
+    private core;
+    constructor(core: WispAPICore);
+    /**
+     * List all Audit Log events for the server
+     *
+     * @public
+     */
+    List(): Promise<GetAuditLogsResponse>;
+}

package/dist/wisp_api/apis/audit_log.js

@@ -0,0 +1,21 @@
+/**
+ * Interface that handles Listing of all Audit Logs
+ *
+ * @public
+ */
+export class AuditLogsAPI {
+    constructor(core) {
+        this.core = core;
+    }
+    // TODO: Handle pagination
+    /**
+     * List all Audit Log events for the server
+     *
+     * @public
+     */
+    async List() {
+        const response = await this.core.makeRequest("GET", "audit-logs");
+        const data = await response.json();
+        return data;
+    }
+}

package/{wisp_api/apis/backups.ts → dist/wisp_api/apis/backups.d.ts}

@@ -1,7 +1,5 @@
 import { WispAPICore } from "./index";
 import type { PaginationData } from "./index";
-import type { DownloadFileResponse } from "./filesystem";
-
 /**
  * A Backup Object
  * @example
@@ -35,9 +33,8 @@ export interface Backup {
         locked: boolean;
         creating: boolean;
         created_at: string;
-    }
+    };
 }
-
 /**
  * Response object used in the GetBackups call
  *
@@ -51,37 +48,29 @@ export interface GetBackupsResponse {
     data: Backup[];
     meta: {
         pagination: PaginationData;
-    }
+    };
 }
-
 export type BackupErrorCode = "server.backups.creation_would_exceed_limit";
 export interface BackupError {
     code: BackupErrorCode;
     data: any;
 }
 export interface CreateBackupFailure {
-    errors: BackupError[] | undefined
+    errors: BackupError[] | undefined;
 }
 export type CreateBackupResponse = Backup | CreateBackupFailure;
-
 /**
  * Handles basic server backup tasks, such as creating, restoring, and deleting backups
  */
-export class BackupsAPI {
-    constructor(private core: WispAPICore) {}
-
+export declare class BackupsAPI {
+    private core;
+    constructor(core: WispAPICore);
     /**
      * Lists all current backups for the server
      *
      * @public
      */
-    async List(): Promise<GetBackupsResponse> {
-        const response = await this.core.makeRequest("GET", "backups");
-        const data: GetBackupsResponse = await response.json();
-
-        return data;
-    }
-
+    List(): Promise<GetBackupsResponse>;
     /**
      * Creates a new backup for the server
      *
@@ -95,22 +84,12 @@ export class BackupsAPI {
      *
      * @param name The name of the Backup
      *
-     * @throws {@link BackupErrorCode} 
+     * @throws {@link BackupErrorCode}
      * If the server returns an error code, it will be thrown verbatim here
      *
      * @public
      */
-    async Create(name: string): Promise<CreateBackupResponse> {
-        const response = await this.core.makeRequest("POST", "backups", { name: name });
-        const data: CreateBackupResponse = await response.json()
-
-        if ("errors" in data && data.errors) {
-            throw new Error(data.errors[0].code);
-        }
-
-        return data
-    }
-
+    Create(name: string): Promise<CreateBackupResponse>;
     /**
      * Toggles the "Locked" status of the Backup
      *
@@ -118,13 +97,7 @@ export class BackupsAPI {
      *
      * @public
      */
-    async ToggleLock(id: string): Promise<Backup> {
-        const response = await this.core.makeRequest("POST", `backups/${id}/locked`);
-        const data: Backup = await response.json();
-
-        return data;
-    }
-
+    ToggleLock(id: string): Promise<Backup>;
     /**
      * Deploys the Backup to the Server
      *
@@ -136,10 +109,7 @@ export class BackupsAPI {
      *
      * @public
      */
-    async Deploy(id: string): Promise<Response> {
-        return await this.core.makeRequest("POST", `backups/${id}/deploy`);
-    }
-
+    Deploy(id: string): Promise<Response>;
     /**
      * Retrieves a URL from which the Backup can be downloaded
      *
@@ -148,13 +118,7 @@ export class BackupsAPI {
      *
      * @public
      */
-    async GetDownloadURL(id: string): Promise<string> {
-        const response = await this.core.makeRequest("GET", `backups/${id}/download`);
-        const data: DownloadFileResponse = await response.json();
-
-        return data.url;
-    }
-
+    GetDownloadURL(id: string): Promise<string>;
     /**
      * Deletes the Backup
      *
@@ -162,7 +126,5 @@ export class BackupsAPI {
      *
      * @public
      */
-    async Delete(id: string): Promise<void> {
-        await this.core.makeRequest("DELETE", `backups/${id}`);
-    }
+    Delete(id: string): Promise<void>;
 }

package/dist/wisp_api/apis/backups.js

@@ -0,0 +1,93 @@
+/**
+ * Handles basic server backup tasks, such as creating, restoring, and deleting backups
+ */
+export class BackupsAPI {
+    constructor(core) {
+        this.core = core;
+    }
+    /**
+     * Lists all current backups for the server
+     *
+     * @public
+     */
+    async List() {
+        const response = await this.core.makeRequest("GET", "backups");
+        const data = await response.json();
+        return data;
+    }
+    /**
+     * Creates a new backup for the server
+     *
+     * @remarks
+     * ⚠️  This can fail to create a Backup even if the function completes successfully
+     * For example, if the backup would exceed the size limit (and the limit is not 0), the system wouldn't know it failed until it hit the limit.
+     *
+     * ⚠️  "It is recomended to stop your server before starting a backup. Backups created while the server is on can contain corupted data."
+     *
+     * Multiple Backups can exist with the same name.
+     *
+     * @param name The name of the Backup
+     *
+     * @throws {@link BackupErrorCode}
+     * If the server returns an error code, it will be thrown verbatim here
+     *
+     * @public
+     */
+    async Create(name) {
+        const response = await this.core.makeRequest("POST", "backups", { name: name });
+        const data = await response.json();
+        if ("errors" in data && data.errors) {
+            throw new Error(data.errors[0].code);
+        }
+        return data;
+    }
+    /**
+     * Toggles the "Locked" status of the Backup
+     *
+     * @param id The ID of the Backup
+     *
+     * @public
+     */
+    async ToggleLock(id) {
+        const response = await this.core.makeRequest("POST", `backups/${id}/locked`);
+        const data = await response.json();
+        return data;
+    }
+    /**
+     * Deploys the Backup to the Server
+     *
+     * @remarks
+     * **⚠️  This can be dangerous!**
+     * The Backup will overwrite the entire Server, erasing any new data since the Backup's creation
+     *
+     * @param id The ID of the Backup
+     *
+     * @public
+     */
+    async Deploy(id) {
+        return await this.core.makeRequest("POST", `backups/${id}/deploy`);
+    }
+    /**
+     * Retrieves a URL from which the Backup can be downloaded
+     *
+     * @param id The ID of the Backup
+     * @returns The download URL
+     *
+     * @public
+     */
+    async GetDownloadURL(id) {
+        const response = await this.core.makeRequest("GET", `backups/${id}/download`);
+        const data = await response.json();
+        return data.url;
+    }
+    /**
+     * Deletes the Backup
+     *
+     * @param id The ID of the Backup
+     *
+     * @public
+     */
+    async Delete(id) {
+        await this.core.makeRequest("DELETE", `backups/${id}`);
+    }
+}

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

@@ -0,0 +1,61 @@
+import { WispAPICore } from "./index";
+import type { PaginationData } from "./index";
+export interface DatabaseRelationship {
+    object: "database_host";
+    attributes: {
+        id: number;
+        name: string;
+        host: string;
+        port: number;
+        phpmyadmin_url: string | null;
+    };
+}
+export interface Database {
+    object: "database";
+    attributes: {
+        id: number;
+        name: string;
+        remote: string;
+        username: string;
+        password: string;
+        relationships: DatabaseRelationship[];
+    };
+}
+export interface GetDatabasesResponse {
+    object: "list";
+    data: Database[];
+    meta: {
+        pagination: PaginationData;
+    };
+}
+/**
+ * Handles Creating, Listing, Updating, and Deleting of Databases for the Server
+ *
+ * @public
+ */
+export declare class DatabasesAPI {
+    private core;
+    constructor(core: WispAPICore);
+    /**
+     * Lists all Databases associated with the Server
+     *
+     * @public
+     */
+    List(): Promise<GetDatabasesResponse>;
+    /**
+     * Deletes the Database from the Server
+     *
+     * @param id The ID of the Backup
+     *
+     * @public
+     */
+    Delete(id: string): Promise<Response>;
+    /**
+     * Rotates the password for the Backup
+     *
+     * @param id The ID of the Backup
+     *
+     * @public
+     */
+    RotatePassword(id: string): Promise<Response>;
+}

package/dist/wisp_api/apis/databases.js

@@ -0,0 +1,43 @@
+/**
+ * Handles Creating, Listing, Updating, and Deleting of Databases for the Server
+ *
+ * @public
+ */
+export class DatabasesAPI {
+    constructor(core) {
+        this.core = core;
+    }
+    // TODO: Handle Pagination
+    /**
+     * Lists all Databases associated with the Server
+     *
+     * @public
+     */
+    async List() {
+        const response = await this.core.makeRequest("GET", "databases", { include: "hosts" });
+        const data = await response.json();
+        return data;
+    }
+    // TODO: verify response
+    /**
+     * Deletes the Database from the Server
+     *
+     * @param id The ID of the Backup
+     *
+     * @public
+     */
+    async Delete(id) {
+        return await this.core.makeRequest("DELETE", `databases/${id}`);
+    }
+    // TODO: Verify response
+    /**
+     * Rotates the password for the Backup
+     *
+     * @param id The ID of the Backup
+     *
+     * @public
+     */
+    async RotatePassword(id) {
+        return await this.core.makeRequest("POST", `databases/${id}`);
+    }
+}

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

@@ -0,0 +1,19 @@
+import { WispAPICore } from "./index";
+/**
+ * Handles the syncing of the FastDL feature
+ *
+ * @public
+ */
+export declare class FastDLAPI {
+    private core;
+    constructor(core: WispAPICore);
+    /**
+     * Begins a FastDL Sync for the server
+     *
+     * @remarks
+     * ⚠️  If a Sync is already in progress, this function will succeed even though the process will fail.
+     *
+     * @public
+     */
+    Sync(): Promise<void>;
+}

package/dist/wisp_api/apis/fastdl.js

@@ -0,0 +1,21 @@
+/**
+ * Handles the syncing of the FastDL feature
+ *
+ * @public
+ */
+export class FastDLAPI {
+    constructor(core) {
+        this.core = core;
+    }
+    /**
+     * Begins a FastDL Sync for the server
+     *
+     * @remarks
+     * ⚠️  If a Sync is already in progress, this function will succeed even though the process will fail.
+     *
+     * @public
+     */
+    async Sync() {
+        await this.core.makeRequest("POST", "fastdl");
+    }
+}