acode-plugin-types 1.11.7-patch.1

package/src/plugins/terminal/Terminal.d.ts

@@ -0,0 +1,123 @@
+/**
+ * Logger function type for terminal operations.
+ */
+type TerminalLogger = (message: string, ...args: unknown[]) => void;
+
+/**
+ * Terminal module providing Alpine Linux sandbox management for Acode.
+ * Handles installation, lifecycle management, backup/restore, and process control
+ * for the AXS environment.
+ */
+interface Terminal {
+	/**
+	 * Starts the AXS environment by writing init scripts and executing the sandbox.
+	 *
+	 * @param installing - Whether AXS is being started during installation
+	 * @param logger - Function to log standard output
+	 * @param err_logger - Function to log errors
+	 * @returns Promise resolving to `true` if installation completes with exit code 0, or `undefined` if not installing
+	 */
+	startAxs(
+		installing?: boolean,
+		logger?: TerminalLogger,
+		err_logger?: TerminalLogger,
+	): Promise<boolean | undefined>;
+
+	/**
+	 * Stops the AXS process by forcefully killing it.
+	 *
+	 * @returns Promise resolving when the process is stopped
+	 */
+	stopAxs(): Promise<void>;
+
+	/**
+	 * Checks if the AXS process is currently running.
+	 *
+	 * @returns Promise resolving to `true` if AXS is running, `false` otherwise
+	 */
+	isAxsRunning(): Promise<boolean>;
+
+	/**
+	 * Installs Alpine by downloading binaries and extracting the root filesystem.
+	 * Also sets up additional dependencies for F-Droid variant.
+	 *
+	 * @param logger - Function to log standard output
+	 * @param err_logger - Function to log errors
+	 * @returns Promise resolving to `true` if installation completes with exit code 0, `false` otherwise
+	 */
+	install(
+		logger?: TerminalLogger,
+		err_logger?: TerminalLogger,
+	): Promise<boolean>;
+
+	/**
+	 * Checks if Alpine is already installed.
+	 *
+	 * @returns Promise resolving to `true` if all required files and directories exist
+	 */
+	isInstalled(): Promise<boolean>;
+
+	/**
+	 * Checks if the current device architecture is supported.
+	 *
+	 * @returns Promise resolving to `true` if architecture is supported (`arm64-v8a`, `armeabi-v7a`, or `x86_64`), otherwise `false`
+	 */
+	isSupported(): Promise<boolean>;
+
+	/**
+	 * Creates a backup of the Alpine Linux installation.
+	 * Creates a compressed tar archive of the Alpine installation.
+	 *
+	 * @returns Promise resolving to the file URI of the created backup file (`aterm_backup.tar`)
+	 * @throws Rejects with "Alpine is not installed." if Alpine is not currently installed
+	 * @throws Rejects with command output if backup creation fails
+	 *
+	 * @example
+	 * try {
+	 *   const backupPath = await Terminal.backup();
+	 *   console.log(`Backup created at: ${backupPath}`);
+	 * } catch (error) {
+	 *   console.error(`Backup failed: ${error}`);
+	 * }
+	 */
+	backup(): Promise<string>;
+
+	/**
+	 * Restores Alpine Linux installation from a backup file.
+	 * Restores the Alpine installation from a previously created backup file (`aterm_backup.tar`).
+	 * This function stops any running Alpine processes, removes existing installation files,
+	 * and extracts the backup to restore the previous state.
+	 *
+	 * @returns Promise resolving to "ok" when restoration completes successfully
+	 * @throws Rejects with "Backup File does not exist" if `aterm_backup.tar` is not found
+	 * @throws Rejects with command output if restoration fails
+	 *
+	 * @example
+	 * try {
+	 *   await Terminal.restore();
+	 *   console.log("Alpine installation restored successfully");
+	 * } catch (error) {
+	 *   console.error(`Restore failed: ${error}`);
+	 * }
+	 */
+	restore(): Promise<string>;
+
+	/**
+	 * Uninstalls the Alpine Linux installation.
+	 * Completely removes the Alpine Linux installation from the device by deleting all
+	 * Alpine-related files and directories. This function stops any running Alpine processes
+	 * before removal.
+	 *
+	 * @returns Promise resolving to "ok" when uninstallation completes successfully
+	 * @throws Rejects with command output if uninstallation fails
+	 *
+	 * @example
+	 * try {
+	 *   await Terminal.uninstall();
+	 *   console.log("Alpine installation removed successfully");
+	 * } catch (error) {
+	 *   console.error(`Uninstall failed: ${error}`);
+	 * }
+	 */
+	uninstall(): Promise<string>;
+}

package/src/plugins/terminal/index.d.ts

@@ -0,0 +1,2 @@
+/// <reference path="./Executor.d.ts" />
+/// <reference path="./Terminal.d.ts" />

package/src/plugins/websocket/WebSocket.d.ts

@@ -0,0 +1,224 @@
+/**
+ * Ready state constants for WebSocket connection.
+ */
+type WebSocketReadyState = 0 | 1 | 2 | 3;
+
+/**
+ * Binary type for WebSocket messages.
+ * Note: 'blob' is not supported but checked for browser compatibility.
+ */
+type WebSocketBinaryType = "" | "arraybuffer" | "blob";
+
+/**
+ * Event handler type for WebSocket open events.
+ */
+type WebSocketOpenHandler = (event: Event) => void;
+
+/**
+ * Extended MessageEvent with binary indicator.
+ */
+interface WebSocketMessageEvent extends MessageEvent {
+	readonly binary: boolean;
+}
+
+/**
+ * Event handler type for WebSocket message events.
+ */
+type WebSocketMessageHandler = (event: WebSocketMessageEvent) => void;
+
+/**
+ * Event handler type for WebSocket close events.
+ */
+type WebSocketCloseHandler = (event: CloseEvent) => void;
+
+/**
+ * Extended Error event with optional message property.
+ */
+interface WebSocketErrorEvent extends Event {
+	message?: string;
+}
+
+/**
+ * Event handler type for WebSocket error events.
+ */
+type WebSocketErrorHandler = (event: WebSocketErrorEvent) => void;
+
+/**
+ * Represents an active WebSocket connection instance.
+ * Extends EventTarget for native event handling support.
+ */
+interface CordovaWebSocketInstance extends EventTarget {
+	/**
+	 * Unique identifier for this WebSocket instance.
+	 */
+	readonly instanceId: string;
+
+	/**
+	 * The extensions selected by the server.
+	 */
+	readonly extensions: string;
+
+	/**
+	 * The current state of the connection.
+	 * - 0: CONNECTING
+	 * - 1: OPEN
+	 * - 2: CLOSING
+	 * - 3: CLOSED
+	 */
+	readonly readyState: WebSocketReadyState;
+
+	/**
+	 * The URL of the WebSocket connection.
+	 */
+	readonly url: string;
+
+	/**
+	 * The binary data type used by the connection.
+	 * Set to 'arraybuffer' to receive binary data as ArrayBuffer.
+	 * Empty string means text mode (default).
+	 */
+	binaryType: WebSocketBinaryType;
+
+	/**
+	 * Event handler called when the connection is opened.
+	 */
+	onopen: WebSocketOpenHandler | null;
+
+	/**
+	 * Event handler called when a message is received.
+	 */
+	onmessage: WebSocketMessageHandler | null;
+
+	/**
+	 * Event handler called when the connection is closed.
+	 */
+	onclose: WebSocketCloseHandler | null;
+
+	/**
+	 * Event handler called when an error occurs.
+	 */
+	onerror: WebSocketErrorHandler | null;
+
+	/**
+	 * Sends data through the WebSocket connection.
+	 *
+	 * @param message - The data to send. Can be a string, ArrayBuffer, or ArrayBufferView.
+	 * @param binary - If true, sends the message as binary data. For ArrayBuffer/ArrayBufferView, this is automatically set to true.
+	 * @throws Error if the WebSocket is not in OPEN state.
+	 *
+	 * @example
+	 * // Send text message
+	 * ws.send('Hello, World!');
+	 *
+	 * // Send binary data
+	 * const buffer = new Uint8Array([0x48, 0x65, 0x6c, 0x6c, 0x6f]);
+	 * ws.send(buffer);
+	 */
+	send(message: string | ArrayBuffer | ArrayBufferView, binary?: boolean): void;
+
+	/**
+	 * Closes the WebSocket connection.
+	 *
+	 * @param code - The status code explaining why the connection is being closed.
+	 * @param reason - A human-readable string explaining why the connection is being closed.
+	 *
+	 * @example
+	 * ws.close(1000, 'Normal closure');
+	 */
+	close(code?: number, reason?: string): void;
+}
+
+/**
+ * Static constants for WebSocket ready states.
+ */
+interface CordovaWebSocketInstanceStatic {
+	readonly CONNECTING: 0;
+	readonly OPEN: 1;
+	readonly CLOSING: 2;
+	readonly CLOSED: 3;
+}
+
+/**
+ * Cordova WebSocket plugin interface.
+ * Provides native WebSocket functionality for Cordova applications.
+ * Available globally at `cordova.websocket`.
+ */
+interface CordovaWebSocket {
+	/**
+	 * Whether to log debug messages.
+	 */
+	DEBUG: boolean;
+
+	/**
+	 * Creates a new WebSocket connection to the specified URL.
+	 *
+	 * @param url - The URL to connect to (e.g., 'wss://example.com/socket').
+	 * @param protocols - Optional subprotocol(s) to use.
+	 * @param headers - Optional custom headers to send with the connection request.
+	 * @param binaryType - Optional binary type for the connection ('arraybuffer' or empty string).
+	 * @returns Promise resolving to a WebSocketInstance on successful connection.
+	 *
+	 * @example
+	 * const ws = await cordova.websocket.connect('wss://echo.websocket.org');
+	 * ws.onmessage = (event) => console.log('Received:', event.data);
+	 * ws.send('Hello!');
+	 */
+	connect(
+		url: string,
+		protocols?: string | string[] | null,
+		headers?: Record<string, string> | null,
+		binaryType?: WebSocketBinaryType,
+	): Promise<CordovaWebSocketInstance>;
+
+	/**
+	 * Lists all active WebSocket client instance IDs.
+	 *
+	 * @returns Promise resolving to an array of active instance IDs.
+	 *
+	 * @example
+	 * const clients = await cordova.websocket.listClients();
+	 * console.log('Active connections:', clients);
+	 */
+	listClients(): Promise<string[]>;
+
+	/**
+	 * Utility function to send a message through a WebSocket by its instance ID.
+	 * Useful when you've lost the reference to the WebSocketInstance object.
+	 *
+	 * @param instanceId - The ID of the WebSocket instance.
+	 * @param message - The data to send. Can be a string, ArrayBuffer, or ArrayBufferView.
+	 * @param binary - If true, sends the message as binary data.
+	 * @returns Promise resolving when the message is sent.
+	 *
+	 * @example
+	 * await cordova.websocket.send('instance-123', 'Hello!');
+	 */
+	send(
+		instanceId: string,
+		message: string | ArrayBuffer | ArrayBufferView,
+		binary?: boolean,
+	): Promise<void>;
+
+	/**
+	 * Utility function to close a WebSocket connection by its instance ID.
+	 * Useful when you've lost the reference to the WebSocketInstance object.
+	 *
+	 * @param instanceId - The ID of the WebSocket instance to close.
+	 * @param code - Optional status code explaining why the connection is being closed.
+	 * @param reason - Optional human-readable string explaining why the connection is being closed.
+	 * @returns Promise resolving when the close operation has completed.
+	 *
+	 * @example
+	 * await cordova.websocket.close('instance-123', 1000, 'Done');
+	 */
+	close(instanceId: string, code?: number, reason?: string): Promise<void>;
+}
+
+interface Cordova {
+	/**
+	 * Native WebSocket plugin providing WebSocket functionality.
+	 */
+	websocket: CordovaWebSocket;
+}
+
+declare const cordova: Cordova;

package/src/plugins/websocket/index.d.ts

@@ -0,0 +1 @@
+/// <reference path="./WebSocket.d.ts" />

package/src/sideBarApps.d.ts

@@ -0,0 +1,39 @@
+declare namespace Acode {
+	/**
+	 * The SideBar Apps API allows you to add mini app to the sidebar of the Acode editor.
+	 * This provides a way to extend the editor's functionality with
+	 * custom UI components that are easily accessible from the sidebar.
+	 */
+	interface SidebarApps {
+		/**
+		 * Adds a new app to the sidebar.
+		 * @param icon Icon class name to display for the app
+		 * @param id  Unique identifier for the app
+		 * @param title Display title of the app
+		 * @param initFunction Called when app is first initialized, receives container element
+		 * @param prepend  Whether to add app at start (true) or end (false) of sidebar
+		 * @param onSelected Called whenever app tab is selected, receives container element
+		 */
+		add(
+			icon: string,
+			id: string,
+			title: string,
+			initFunction: (container: HTMLElement) => void,
+			prepend?: boolean,
+			onSelected?: (container: HTMLElement) => void,
+		): void;
+
+		/**
+		 * Gets the container element for the app with the given ID.
+		 * @param id ID of the app to get
+		 */
+		get(id: string): HTMLElement | undefined;
+
+		/**
+		 * Removes the app with the given ID from the sidebar.
+		 * @param id ID of the app to remove
+		 * @returns
+		 */
+		remove(id: string): void;
+	}
+}