wispjs 2.1.3 → 2.1.4

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

@@ -0,0 +1,106 @@
+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 declare class SubusersAPI {
+    private core;
+    constructor(core: WispAPICore);
+    /**
+     * Lists all Subusers for the Server
+     *
+     * @public
+     */
+    List(): Promise<GetSubusersResponse>;
+    /**
+     * Retrieves the details for the Subuser
+     *
+     * @param id The ID of the Subuser
+     *
+     * @public
+     */
+    GetDetails(id: string): Promise<Subuser>;
+    /**
+     * Get all permissions available to Subusers
+     *
+     * @public
+     */
+    GetAllPermissions(): Promise<GetAllSubuserPermissionsResponse>;
+    /**
+     * Creates a new Subuser
+     *
+     * @param email The email for the Subuser
+     * @param permissions The Permissions to grant to the Subuser
+     *
+     * @public
+     */
+    Create(email: string, permissions: Permission[]): Promise<Subuser>;
+    /**
+     * 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
+     */
+    Update(id: string, email: string, permissions: Permission[]): Promise<Subuser>;
+    /**
+     * Deletes the Subuser
+     *
+     * @param id The ID of the Subuser
+     *
+     * @public
+     */
+    Delete(id: string): Promise<void>;
+}

package/dist/wisp_api/apis/subusers.js

@@ -0,0 +1,87 @@
+/**
+ * Handles interfacing with the Subusers API
+ *
+ * @public
+ */
+export class SubusersAPI {
+    constructor(core) {
+        this.core = core;
+    }
+    /**
+     * Lists all Subusers for the Server
+     *
+     * @public
+     */
+    async List() {
+        const response = await this.core.makeRequest("GET", "subusers", { include: "user" });
+        const data = await response.json();
+        return data;
+    }
+    /**
+     * Retrieves the details for the Subuser
+     *
+     * @param id The ID of the Subuser
+     *
+     * @public
+     */
+    async GetDetails(id) {
+        const response = await this.core.makeRequest("GET", `subusers/${id}`, { include: "user" });
+        const data = await response.json();
+        return data;
+    }
+    /**
+     * Get all permissions available to Subusers
+     *
+     * @public
+     */
+    async GetAllPermissions() {
+        const response = await this.core.makeRequest("GET", "subusers/permissions");
+        const data = 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, permissions) {
+        const requestData = {
+            email: email,
+            permissions: permissions
+        };
+        const response = await this.core.makeRequest("POST", "subusers", requestData);
+        const data = 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, email, permissions) {
+        const data = {
+            email: email,
+            permissions: permissions
+        };
+        const response = await this.core.makeRequest("PATCH", `subusers/${id}`, data);
+        const responseData = await response.json();
+        return responseData;
+    }
+    /**
+     * Deletes the Subuser
+     *
+     * @param id The ID of the Subuser
+     *
+     * @public
+     */
+    async Delete(id) {
+        await this.core.makeRequest("DELETE", `subusers/${id}`);
+    }
+}

package/dist/wisp_api/index.d.ts

@@ -0,0 +1,39 @@
+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 declare class WispAPI {
+    private core;
+    Allocations: AllocationsAPI;
+    AuditLogs: AuditLogsAPI;
+    Backups: BackupsAPI;
+    Databases: DatabasesAPI;
+    FastDL: FastDLAPI;
+    Filesystem: FilesystemAPI;
+    Mods: ModsAPI;
+    Schedules: SchedulesAPI;
+    Servers: ServersAPI;
+    Startup: StartupAPI;
+    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);
+}

package/dist/wisp_api/index.js

@@ -0,0 +1,41 @@
+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 {
+    /**
+     * @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, uuid, token, logger) {
+        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);
+    }
+}

package/dist/wisp_socket/index.d.ts

@@ -0,0 +1,161 @@
+import { WebsocketPool } from "./pool.js";
+import { FilesearchResults } from "./pool";
+import type { WispAPI } from "../wisp_api/index.js";
+/**
+ * The Websocket information returned from the API
+ *
+ * @param token The token to use when authenticating with the `auth` command in the Websocket
+ * @param url The actual URL of the Websocket
+ *
+ * @internal
+ */
+export interface WebsocketInfo {
+    token: string;
+    url: string;
+}
+export type WebsocketDetailsPreprocessor = (info: WebsocketInfo) => void;
+export interface WispSocket {
+    pool: WebsocketPool;
+    logger: any;
+    api: WispAPI;
+    url: string | undefined;
+    token: string | undefined;
+    ghToken: string | undefined;
+    consoleCallbacks: ((message: string) => void)[];
+    detailsPreprocessor: WebsocketDetailsPreprocessor | undefined;
+}
+/**
+ * The primary interface to the Websocket API
+ *
+ * @internal
+ */
+export declare class WispSocket {
+    constructor(logger: any, api: any, ghToken: string | undefined);
+    /**
+     * Sets a callback to run on the Websocket Info before saving the details.
+     *
+     * @example
+     * ```js
+     * // Change the URL of the Websocket
+     * wisp.socket.setWebsocketDetailsPreprocessor((info) => {
+     *    info.url = "wss://newurl.com"
+     * })
+     * ```
+     *
+     * @remarks
+     * ℹ️  This can be used to modify the URL or token after its retrieved from the API
+     *
+     * @param preprocessor The callback to run when the data is received from the API
+     *
+     * @public
+     */
+    setWebsocketDetailsPreprocessor(preprocessor: WebsocketDetailsPreprocessor): void;
+    /**
+     * Creates a new Websocket Pool
+     *
+     * @throws Throws an error if the URL or token are not set yet
+     * @internal
+     */
+    createPool(): void;
+    /**
+     * Requests and saves the Websocket details from the API
+     *
+     * @internal
+     */
+    setDetails(): Promise<void>;
+    /**
+     * Disconnects from the websocket
+     *
+     * @internal
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Verifies that the pool is created and ready to use
+     *
+     * @internal
+     */
+    verifyPool(): Promise<void>;
+    /**
+     * Searches all file contents for the given query
+     *
+     * @param query The query string to search for
+     *
+     * @public
+     */
+    filesearch(query: string): Promise<FilesearchResults>;
+    /**
+     * Performs a git pull operation on the given directory
+     *
+     * @param dir The full directory path to perform a pull on
+     *
+     * @public
+     */
+    gitPull(dir: string, useAuth?: boolean): Promise<any>;
+    /**
+     * Clones a new Repo to the given directory
+     *
+     * @param url The HTTPS URL of the repository
+     * @param dir The full path of the directory to clone the repository to
+     * @param branch The branch of the repository to clone
+     *
+     * @public
+     */
+    gitClone(url: string, dir: string, branch: string): Promise<any>;
+    /**
+     * Sets up the console listener worker
+     *
+     * @internal
+     */
+    setupConsoleListener(): void;
+    /**
+     * Adds a new callback that will run any time a console message is rececived
+     *
+     * @param callback The callback to run, takes a single param, `message`, a string
+     *
+     * @public
+     */
+    addConsoleListener(callback: (message: string) => void): void;
+    /**
+     * Removes a previously added console message callback
+     *
+     * @param callback The callback function that was previously added
+     *
+     * @public
+     */
+    removeConsoleListener(callback: (message: string) => void): void;
+    /**
+     * Sends a command to the server and then waits until output with the given prefix is seen in a console message
+     *
+     * @example
+     * Runs a custom lua command that will prefix its output with our nonce, then prints the output from that command
+     * ```lua
+     * -- lua/autorun/server/nonce_example.lua
+     * concommand.Add( "myCommand", function( ply, _, args )
+     *     if IsValid( ply ) then return end
+     *
+     *     local nonce = args[1]
+     *     print( nonce .. "Command output" )
+     * end )
+     * ```
+     * ```js
+     * const nonce = "abc123";
+     * const command = `myCommand "${nonce}"`;
+     * try {
+     *     const output = await wisp.socket.sendCommandNonce(nonce, command);
+     *     console.log("Output from command:", output);
+     * catch (error) {
+     *     console.error(error);
+     * }
+     * ```
+     *
+     * @remarks
+     * ℹ️  This is useful if you run code on your Server that will print output with the same prefix, letting you run commands and also receive output for it
+     *
+     * @param nonce The short, unique string that your output will be prefixed with
+     * @param command The full command string to send
+     * @param timeout How long to wait for output before timing out
+     *
+     * @public
+     */
+    sendCommandNonce(nonce: string, command: string, timeout?: number): Promise<any>;
+}