wispjs 2.4.0 → 3.0.0

package/wisp_api/apis/allocations.ts

@@ -1,71 +0,0 @@
-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 class AllocationsAPI {
-  constructor(private core: WispAPICore) {}
-
-
-  /**
-   * Lists all Allocations for the Server
-   *
-   * @public
-   */
-  async List(): Promise<GetAllocationsResponse> {
-    const response = await this.core.makeRequest("GET", "allocations");
-    const data: GetAllocationsResponse = 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: string): Promise<Allocation> {
-    const response = await this.core.makeRequest("PUT", `allocations/${id}`);
-    const data: Allocation = await response.json()
-
-    return data;
-  }
-}

package/wisp_api/apis/audit_log.ts

@@ -1,81 +0,0 @@
-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;
-}
-
-// TODO: Fully define the audit log type
-/**
- * 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 class AuditLogsAPI {
-  constructor(private core: WispAPICore) {}
-
-
-  // TODO: Handle pagination
-  /**
-   * List all Audit Log events for the server
-   *
-   * @public
-   */
-  async List(): Promise<GetAuditLogsResponse> {
-    const response = await this.core.makeRequest("GET", "audit-logs");
-    const data: GetAuditLogsResponse = await response.json();
-
-    return data;
-  }
-}

package/wisp_api/apis/backups.ts

@@ -1,168 +0,0 @@
-import { WispAPICore } from "./index";
-import type { PaginationData } from "./index";
-import type { DownloadFileResponse } from "./filesystem";
-
-/**
- * A Backup Object
- * @example
- * ```json
- * {
- *     "object": "backup",
- *     "attributes": {
- *         "uuid": "26adeafc-74af-43fd-93a5-9afa0486b21b",
- *         "uuid_short": "26adeafc",
- *         "name": "test-1",
- *         "sha256_hash": "56d2965e9167c785647878a391dfe24460c3aa5e1111b385708094bd8837b487",
- *         "bytes": 3266448936,
- *         "locked": false,
- *         "creating": false,
- *         "created_at": "2023-11-28T08:37:39.000000Z"
- *     }
- * }
- * ```
- *
- * @internal
- */
-export interface Backup {
-    object: "backup";
-    attributes: {
-        uuid: string;
-        uuid_short: string;
-        name: string;
-        /** The hash of the Backup. May be null if the Backup is still being created. */
-        sha256_hash: string | null;
-        bytes: number;
-        locked: boolean;
-        creating: boolean;
-        created_at: string;
-    }
-}
-
-/**
- * Response object used in the GetBackups call
- *
- * @remarks
- * Used in {@link BackupsAPI.List}
- *
- * @internal
- */
-export interface GetBackupsResponse {
-    object: "list";
-    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
-}
-export type CreateBackupResponse = Backup | CreateBackupFailure;
-
-/**
- * Handles basic server backup tasks, such as creating, restoring, and deleting backups
- */
-export class BackupsAPI {
-    constructor(private 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;
-    }
-
-    /**
-     * 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: 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
-    }
-
-    /**
-     * Toggles the "Locked" status of the Backup
-     *
-     * @param id The ID of the Backup
-     *
-     * @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;
-    }
-
-    /**
-     * 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: string): Promise<Response> {
-        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: string): Promise<string> {
-        const response = await this.core.makeRequest("GET", `backups/${id}/download`);
-        const data: DownloadFileResponse = await response.json();
-
-        return data.url;
-    }
-
-    /**
-     * Deletes the Backup
-     *
-     * @param id The ID of the Backup
-     *
-     * @public
-     */
-    async Delete(id: string): Promise<void> {
-        await this.core.makeRequest("DELETE", `backups/${id}`);
-    }
-}

package/wisp_api/apis/databases.ts

@@ -1,80 +0,0 @@
-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 class DatabasesAPI {
-  constructor(private core: WispAPICore) {}
-
-  // TODO: Handle Pagination
-  /**
-   * Lists all Databases associated with the Server
-   *
-   * @public
-   */
-  async List(): Promise<GetDatabasesResponse> {
-    const response = await this.core.makeRequest("GET", "databases", { include: "hosts" });
-    const data: GetDatabasesResponse = 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: string): Promise<Response> {
-    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: string): Promise<Response> {
-    return await this.core.makeRequest("POST", `databases/${id}`);
-  }
-}

package/wisp_api/apis/fastdl.ts

@@ -1,22 +0,0 @@
-import { WispAPICore } from "./index";
-
-/**
- * Handles the syncing of the FastDL feature
- *
- * @public
- */
-export class FastDLAPI {
-  constructor(private 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
-   */
-  async Sync(): Promise<void> {
-    await this.core.makeRequest("POST", "fastdl");
-  }
-}

package/wisp_api/apis/filesystem.ts

@@ -1,291 +0,0 @@
-import { WispAPICore } from "./index";
-import type { PaginationData } from "./index";
-
-// TODO: Handle the 204 vs. 200 with errors better
-// TODO: Use the cool `never` thing for all error pieces in here
-
-export interface DirectoryFile {
-  object: "file";
-  attributes: {
-    type: "file" | "directory";
-    name: string;
-    size: number;
-    mime: string;
-    symlink: boolean;
-    created_at: string;
-    modified_at: string;
-  }
-}
-
-export interface DirectoryContents {
-  object: "list";
-  data: DirectoryFile[]
-  meta: {
-    pagination: PaginationData | undefined;
-  }
-}
-export type GetDirectoryContentsErrorCode = "generic.daemon_connection_exception";
-export interface GetDirectoryContentsError {
-    code: GetDirectoryContentsErrorCode;
-    data: {
-        code: number;
-    }
-}
-export interface GetDirectoryContentsFailure {
-    errors: GetDirectoryContentsError[] | undefined
-}
-
-/**
- * The response object for the GetDirectoryContents call
- *
- * @remarks
- * Used in {@link FilesystemAPI.GetDirectoryContents}
- *
- * @public
- */
-export type GetDirectoryContentsResponse = DirectoryContents | GetDirectoryContentsFailure;
-
-export interface FileReadError {
-    code: string;
-    data: {
-        code: number
-    }
-}
-export type FileReadResponse =
-    | { errors: FileReadError[]; content?: never }
-    | { content: string; errors?: never };
-
-
-export interface FileWriteRequest {
-  path: string;
-  content: string;
-}
-
-export interface CopyFileRequest {
-  path: string;
-}
-
-export interface DownloadFileResponse {
-  url: string;
-}
-
-export interface RenameFileRequest {
-  path: string;
-  to: string;
-}
-
-export interface CompressFilesRequest {
-  paths: string[];
-  to: string;
-}
-
-/**
- * Handles interaction with the Server's File System
- *
- * @public
- */
-export class FilesystemAPI {
-  constructor(private core: WispAPICore) {}
-
-
-  /**
-   * Get the Contents of the given Directory
-   *
-   * @param path The path to list
-   *
-   * @throws {@link GetDirectoryContentsErrorCode}
-   *
-   * @public
-   */
-  async GetDirectoryContents(path: string): Promise<GetDirectoryContentsResponse> {
-    const response = await this.core.makeRequest("GET", "files/directory", { path: path });
-    const data: GetDirectoryContentsResponse = await response.json();
-
-    // TODO: Also include the data.code (or handle the 404 case specifically)
-    if ("errors" in data && data.errors) {
-        throw new Error(data.errors[0].code);
-    }
-
-    return data
-  }
-
-
-  /**
-   * Creates a Directory with the given path
-   *
-   * @remarks
-   * ⚠️  This will silently fail if the given path is present and invalid or unreachable
-   * ⚠️  This is always relative to the Server's default directory (usually /home/container)
-   *
-   * @param path The full path to the new Directory
-   *
-   * @public
-   */
-  async CreateDirectory(path: string): Promise<void> {
-    await this.core.makeRequest("POST", "files/directory", { path: path });
-  }
-
-
-  /**
-   * Retrieves the contents of the File at the given path
-   *
-   * @param path The full path to the File to read (After the /home/container/ part)
-   *
-   * @throws "Server returned error code: {number}"
-   * This error is often thrown if the given path doesn't exist, or is not readable. The error code would be 404.
-   *
-   * @public
-   */
-  async ReadFile(path: string): Promise<string> {
-    const response = await this.core.makeRequest("GET", "files/read", { path: path });
-    const data: FileReadResponse = await response.json();
-
-    if (data.errors) {
-        throw new Error(`Server returned error code: ${data.errors[0].data.code}`);
-    }
-
-    return data.content;
-  }
-
-
-  /**
-   * Writes the given content to the File at the given path
-   *
-   * @remarks
-   * ⚠️  Overwrites the file if it already exists
-   * ⚠️  This function silently fails if the target path is not writeable
-   *
-   * @param path The full path to the File
-   * @param content The full content of the File
-   *
-   * @public
-   */
-  async WriteFile(path: string, content: string): Promise<void> {
-    const data: FileWriteRequest = { path: path, content: content };
-    await this.core.makeRequest("POST", "files/write", data);
-  }
-
-
-  /**
-   * Copies the File at the given path
-   *
-   * @remarks
-   * ⚠️  New copy will be written to the same directory, with a name such as `test.txt` -> `test.txt copy-1643810941850`
-   *
-   * @param path The full path to the File to Copy
-   *
-   * @throws "Unexpected response code, Copy may not have succeeded"
-   * If the API returns anything other than a 204, something likely went wrong. Most commonly, this is because the file path didn't exist or wasn't copyable.
-   *
-   * @public
-   */
-  async CopyFile(path: string): Promise<void> {
-    const requestData: CopyFileRequest = { path: path };
-    const response = await this.core.makeRequest("POST", "files/copy", requestData);
-
-    if (response.status != 204) {
-        throw new Error("Unexpected response code, Copy may not have succeeded");
-    }
-  }
-
-
-  /**
-   * Deletes the Files at all of the given paths
-   *
-   * @param paths An array of File Paths to Delete
-   *
-   * @throws "Unexpected response code, Delete may not have succeeded"
-   * If the API returns anything other than a 204, something likely went wrong. Most commonly, this is because the file path didn't exist or wasn't deleteable.
-   *
-   * @public
-   */
-  async DeleteFiles(paths: string[]): Promise<void> {
-    const response = await this.core.makeRequest("POST", "files/delete", { paths: paths });
-
-    if (response.status != 204) {
-        throw new Error("Unexpected response code, Delete may not have succeeded");
-    }
-  }
-
-
-  /**
-   * Retrieves a Download URL for a File
-   *
-   * @remarks
-   * ⚠️  This will return a Download URL even if the given file does not exist
-   *
-   * @param path The full path to the File
-   *
-   * @public
-   */
-  async GetFileDownloadURL(path: string): Promise<string> {
-    const response = await this.core.makeRequest("GET", "files/download", { path: path });
-    const data: DownloadFileResponse = await response.json();
-
-    return data.url;
-  }
-
-
-  /**
-   * Renames (or moves) the given File
-   *
-   * @param path The full path to the File
-   * @param to The new path of the File
-   *
-   * @throws "Unexpected response code, Rename may not have succeeded"
-   * If the API returns anything other than a 204, something likely went wrong. Most commonly, this is because the source or destination path did not exist or was not reachable
-   *
-   * @public
-   */
-  async RenameFile(path: string, to: string): Promise<void> {
-    const requestData: RenameFileRequest = { path: path, to: to };
-    const response = await this.core.makeRequest("PATCH", "files/rename", requestData);
-
-    if (response.status != 204) {
-        throw new Error("Unexpected response code, Rename may not have succeeded");
-    }
-  }
-
-
-  /**
-   * Compresses the Files at the given paths
-   *
-   * @remarks
-   * ⚠️  The resulting file appears to be unpredictably named?
-   *
-   * @param paths An array of Paths to Compress
-   * @param to The Directory to write the Compressed Files to
-   *
-   * @throws "Unexpected response code, Compress may not have succeeded"
-   * If the API returns anything other than a 204, something likely went wrong. Most commonly, this is because the source or destination path did not exist or was not Compressable
-   *
-   * @public
-   */
-  async CompressFiles(paths: string[], to: string): Promise<void> {
-    const requestData: CompressFilesRequest = { paths: paths, to: to };
-    const response = await this.core.makeRequest("POST", "files/compress", requestData);
-
-    if (response.status != 204) {
-        throw new Error("Unexpected response code, Compress may not have succeeded");
-    }
-  }
-
-
-  /**
-   * Decompresses the File at the given path
-   *
-   * @param path The full path to the File to Decompress
-   *
-   * @throws "Unexpected response code, Decompress may not have succeeded"
-   * If the API returns anything other than a 204, something likely went wrong. Most commonly, this is because the given path did not exist or was not reachable
-   *
-   * @public
-   */
-  async DecompressFile(path: string): Promise<void> {
-    const response = await this.core.makeRequest("POST", "files/decompress", { path: path });
-
-    if (response.status != 204) {
-        throw new Error("Unexpected response code, Decompress may not have succeeded");
-    }
-  }
-}