acode-plugin-types 1.11.7-patch.1

package/src/fileSystem.d.ts

@@ -0,0 +1,113 @@
+declare namespace Acode {
+	/**
+	 * The fs module provides a simplified API for interacting with the file system in Acode, primarily for basic file and directory operations.
+	 *  This does not support symbolic links (symlink), due to limitation of the Android platform.
+	 * To perform file operations, you first need to create a file system object by providing a URL (path) to the file or directory.
+	 */
+	interface FS {
+		/**
+		 * Create a file system object from a URL
+		 * @param url URL of the file or directory
+		 * @returns File system object
+		 */
+		(url0: `http:${string}` | `https:${string}`, ...url: string[]): FileUrl;
+		(...url: string[]): FileSystem;
+
+		extend(
+			test: (url: string) => boolean,
+			fs: (url: string) => FileSystem,
+		): void;
+
+		remove(test: (url: string) => boolean): void;
+	}
+
+	interface FileUrl {
+		/**
+		 * Reads the contents of a file. Optionally accepts an encoding parameter (encoding) for text files.
+		 */
+		readFile(): Promise<ArrayBuffer>;
+		readFile(encoding: "utf-8"): Promise<string>;
+		readFile(encoding: "json"): Promise<unknown>;
+
+		/**
+		 * Writes data to a file.
+		 */
+		writeFile(content: string | ArrayBuffer): Promise<void>;
+	}
+
+	interface FileSystem {
+		/**
+		 * Returns a list of entries (files and directories) within the specified directory.
+		 */
+		lsDir(): Promise<File[]>;
+
+		/**
+		 * Reads the contents of a file. Optionally accepts an encoding parameter (encoding) for text files.
+		 */
+		readFile(): Promise<ArrayBuffer>;
+		readFile(encoding: "utf-8"): Promise<string>;
+		readFile(encoding: "json"): Promise<unknown>;
+
+		/**
+		 * Writes data to a file.
+		 */
+		writeFile(content: string | ArrayBuffer): Promise<void>;
+
+		/**
+		 * Creates a new file with the specified name and content.
+		 * If a file with the same name exists, it will be overwritten.
+		 */
+		createFile(name: string, content?: string): Promise<string>;
+
+		/**
+		 * Creates a new directory with the specified name.
+		 * @param name
+		 * @returns
+		 */
+		createDirectory(name: string): Promise<string>;
+
+		/**
+		 * Deletes the file or directory specified by the URL.
+		 * @returns
+		 */
+		delete(): Promise<void>;
+
+		/**
+		 * Copies the file or directory to the specified destination./
+		 */
+		copyTo(destination: string): Promise<string>;
+
+		/**
+		 * It allows you to move a file or directory from its current location to a new destination.
+		 */
+		moveTo(destination: string): Promise<string>;
+
+		/**
+		 * It allows for the renaming of a file or directory.
+		 */
+		renameTo(newName: string): Promise<string>;
+
+		/**
+		 * Checks if the specified file or directory exists.
+		 */
+		exists(): Promise<boolean>;
+
+		/** Retrieves information about the file or directory. */
+		stat(): Promise<Stat>;
+	}
+
+	interface File {
+		name: string;
+		url: string;
+		isFile: boolean;
+		isDirectory: boolean;
+		isLink: boolean;
+	}
+
+	interface Stat extends File {
+		size: number;
+		modifiedDate: number;
+		canRead: boolean;
+		canWrite: boolean;
+	}
+}

package/src/handlers/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="./intent.d.ts" />
+/// <reference path="./keyboard.d.ts" />
+/// <reference path="./windowResize.d.ts" />

package/src/handlers/intent.d.ts

@@ -0,0 +1,47 @@
+declare namespace Acode {
+	/**
+	 * The Intent API provides functionality to handle intents from other apps and implement custom URI scheme handling in Acode plugins.
+	 */
+	interface Intent {
+		/**
+		 *Adds an intent handler function that will be called when intents are received.
+		 */
+		addHandler(handler: (event: IntentEvent) => void): void;
+
+		/**
+		 * Removes a previously added intent handler.
+		 */
+		removeHandler(handler: (event: IntentEvent) => void): void;
+	}
+
+	interface IntentEvent {
+		/**
+		 * The module name from the URI.
+		 */
+		module: string;
+
+		/**
+		 * The action to perform.
+		 */
+		action: string;
+
+		/**
+		 * Additional data value.
+		 */
+		value: string;
+
+		/**
+		 *  Prevents default intent handling.
+		 */
+		preventDefault: () => void;
+
+		/**
+		 * Stops other handlers from executing.
+		 */
+		stopPropagation: () => void;
+
+		readonly defaultPrevented: boolean;
+
+		readonly propagationStopped: boolean;
+	}
+}

package/src/handlers/keyboard.d.ts

@@ -0,0 +1,30 @@
+declare namespace Acode {
+	interface Keyboard {
+		/**
+		 * Handles keyboard events
+		 */
+		(e: KeyboardEvent): void;
+		/**
+		 * Add an event listener for keyboard events.
+		 * @param eventName Name of the event to listen for.
+		 * @param callback Function to execute when the event occurs.
+		 */
+		on(eventName: "key", callback: (ev: KeyboardEvent) => void): void;
+		on(eventName: KeyboardEventName, callback: () => void): void;
+
+		/**
+		 * Remove an event listener.
+		 * @param eventName Name of the event to remove listener from.
+		 * @param callback The callback function to remove.
+		 */
+		off(eventName: "key", callback: (ev: KeyboardEvent) => void): void;
+		off(eventName: KeyboardEventName, callback: () => void): void;
+	}
+
+	type KeyboardEventName =
+		| "key"
+		| "keyboardShow"
+		| "keyboardHide"
+		| "keyboardShowStart"
+		| "keyboardHideStart";
+}

package/src/handlers/windowResize.d.ts

@@ -0,0 +1,13 @@
+declare namespace Acode {
+	type WindowResizeEventName = "resize" | "resizeStart";
+
+	interface WindowResize {
+		(): void;
+
+		/** Adds event listener */
+		on(event: WindowResizeEventName, listener: () => void): void;
+
+		/** Removes event listener */
+		off(event: WindowResizeEventName, listener: () => void): void;
+	}
+}

package/src/index.d.ts

@@ -0,0 +1,12 @@
+/// <reference path="./ace/index.d.ts" />
+/// <reference path="./acode.d.ts" />
+/// <reference path="./components/index.d.ts" />
+/// <reference path="./dialogs/index.d.ts" />
+/// <reference path="./fileSystem.d.ts" />
+/// <reference path="./handlers/index.d.ts" />
+/// <reference path="./lib/index.d.ts" />
+/// <reference path="./pages/index.d.ts" />
+/// <reference path="./plugins/index.d.ts" />
+/// <reference path="./sideBarApps.d.ts" />
+/// <reference path="./theme/index.d.ts" />
+/// <reference path="./utils/index.d.ts" />

package/src/lib/actionStack.d.ts

@@ -0,0 +1,60 @@
+declare namespace Acode {
+	interface ActionStack {
+		/**
+		 * Length of stack
+		 */
+		readonly length: number;
+
+		/**
+		 * Function to be called when app is closed
+		 */
+		onCloseApp: () => void;
+
+		/** Adds a new action to the stack. */
+		push(action: Action): void;
+
+		/**
+		 * Executes and removes the most recent action from the stack.
+		 * @param repeat Number of actions to pop and execute
+		 */
+		pop(repeat?: number): void;
+
+		/**
+		 * Retrieves an action from the stack by its ID.
+		 * @param id The action identifier
+		 */
+		get(id: string): Action | undefined;
+
+		/**
+		 * Removes an action from the stack without executing it.
+		 * @param id The action identifier
+		 */
+		remove(id: string): void;
+
+		/**
+		 * Checks if an action exists in the stack.
+		 * @param id The action identifier
+		 */
+		has(id: string): boolean;
+
+		/**
+		 * Sets a marker at the current stack position.
+		 */
+		setMark(): void;
+
+		/**
+		 * Removes all actions added after the last marker.
+		 */
+		clearFromMark(): void;
+		freeze(): void;
+		unfreeze(): void;
+	}
+
+	interface Action {
+		/** Unique identifier for the action */
+		id: string;
+
+		/** Callback function to execute when back is pressed */
+		action: () => void;
+	}
+}

package/src/lib/editorFile.d.ts

@@ -0,0 +1,344 @@
+declare namespace Acode {
+	/**
+	 * The Editor File API provides functionality to create, manage, interact with files/tabs in the Acode editor.
+	 * It handles file operations, state management, editor session control, custom editor tab, etc.
+	 */
+	class EditorFile {
+		/**
+		 * Whether to hide quicktools for this tab
+		 */
+		hideQuickTools: boolean;
+
+		/**
+		 * Custom stylesheets for tab
+		 */
+		stylesheets: string | string[];
+
+		/**
+		 * If editor was focused before resize
+		 */
+		focusedBefore: boolean;
+
+		/**
+		 * State of the editor for this file.
+		 */
+		focused: boolean;
+
+		/**
+		 * Has completed loading text?
+		 */
+		loaded: boolean;
+
+		/** Is still loading text? */
+		loading: boolean;
+
+		/**
+		 * Weather file is deleted from source.
+		 */
+		deletedFile: boolean;
+
+		/**
+		 * EditSession of the file
+		 */
+		session: Ace.EditSession;
+
+		/**
+		 * Encoding of the text e.g. 'gbk'
+		 */
+		encoding: string;
+
+		/**
+		 * Is file readonly?
+		 */
+		readOnly: boolean;
+
+		/**
+		 * Should mark changes when session text changes?
+		 */
+		markChanged: boolean;
+
+		onsave?: (event: FileEvent) => void;
+		onchange?: (event: FileEvent) => void;
+		onfocus?: (event: FileEvent) => void;
+		onblur?: (event: FileEvent) => void;
+		onclose?: (event: FileEvent) => void;
+		onrename?: (event: FileEvent) => void;
+		onload?: (event: FileEvent) => void;
+		onloaderror?: (event: FileEvent) => void;
+		onloadstart?: (event: FileEvent) => void;
+		onloadend?: (event: FileEvent) => void;
+		onchangemode?: (event: FileEvent) => void;
+		onrun?: (event: FileEvent) => void;
+		oncanrun?: (event: FileEvent) => void;
+
+		/**
+		 * Creates a new EditorFile.
+		 * @param name Name of the file
+		 * @param options File creation options
+		 */
+		constructor(name: string, options: FileOptions);
+
+		readonly type: string;
+
+		readonly tabIcon: string;
+
+		readonly content: HTMLElement;
+
+		/**
+		 * File unique id.
+		 */
+		id: string;
+
+		/**
+		 * File name
+		 */
+		filename: string;
+
+		/**
+		 * Location of the file i.e. dirname
+		 */
+		location: string;
+
+		/**
+		 * File location on the device
+		 */
+		uri: string;
+
+		/**
+		 * End of line character
+		 */
+		eol: "windows" | "unix";
+
+		/**
+		 * Is editable?
+		 */
+		editable: boolean;
+
+		/**
+		 * Has unsaved changes?
+		 */
+		isUnsaved: boolean;
+
+		/**
+		 * File name (for plugin compatibility)
+		 */
+		readonly name: string;
+
+		/**
+		 * Cache file URL
+		 */
+		readonly cacheFile: string;
+
+		/**
+		 * File icon class
+		 */
+		readonly icon: string;
+
+		/**
+		 * File tab element
+		 */
+		readonly tab: string;
+
+		/**
+		 * Storage access framework mode
+		 */
+		readonly SAFMode: "single" | "tree" | undefined;
+
+		/**
+		 * Writes file content to cache.
+		 */
+		writeToCache(): Promise<void>;
+
+		/**
+		 * Checks if file has unsaved changes.
+		 */
+		isChanged(): Promise<boolean>;
+
+		/**
+		 * Checks if file can be run.
+		 */
+		canRun(): Promise<boolean>;
+
+		readCanRun(): Promise<boolean>;
+
+		/**
+		 * Sets whether to show run button.
+		 */
+		writeCanRun(cb: () => boolean | Promise<boolean>): Promise<boolean>;
+
+		/**
+		 * Remove and closes the file.
+		 * @param force if true, will prompt to save the file
+		 * @default false
+		 */
+		remove(force: boolean): Promise<void>;
+
+		/**
+		 * Saves the file to its current location.
+		 */
+		save(): Promise<boolean>;
+
+		/**
+		 * Saves the file to a new location.
+		 */
+		saveAs(): Promise<boolean>;
+
+		/**
+		 * Sets syntax highlighting mode for the file.
+		 */
+		setMode(mode: string): void;
+
+		/**
+		 * Makes this file the active file in the editor.
+		 */
+		makeActive(): void;
+
+		/**
+		 * Removes active state from the file.
+		 */
+		removeActive(): void;
+
+		/**
+		 * Opens file with system app.
+		 */
+		openWith(): void;
+
+		/**
+		 * Opens file for editing with system app.
+		 */
+		editWith(): void;
+
+		/**
+		 * Shares the file.
+		 */
+		share(): void;
+
+		runAction(): void;
+
+		/** Runs the file. */
+		run(): void;
+
+		/**
+		 * Runs the file in app.
+		 */
+		runFile(): void;
+
+		render(): void;
+
+		/**
+		 * Adds event listener.
+		 */
+		on(event: FileEventType, callback: (event: FileEvent) => void): void;
+
+		/**
+		 * Removes event listener.
+		 */
+		off(event: FileEventType, callback: (event: FileEvent) => void): void;
+
+		/**
+		 * Add stylesheet to tab's shadow DOM
+		 * @param  style URL or CSS string
+		 */
+		addStyle(style: string): void;
+
+		/**
+		 * Set custom title function for special tab types
+		 * @param titleFn Function that returns the title string
+		 */
+		setCustomTitle(titleFn: () => void): void;
+	}
+
+	interface FileOptions {
+		/** Whether file needs to be saved
+		 * @default false
+		 */
+		isUnsaved?: boolean;
+
+		/** Make file active
+		 * @default true
+		 */
+		render?: boolean;
+
+		/** ID for the file */
+		id?: string;
+
+		/** URI of the file */
+		uri?: string;
+
+		/** Session text */
+		text?: string;
+
+		/** Enable file editing
+		 * @default true
+		 */
+		editable?: boolean;
+
+		/** File does not exist at source
+		 * @default false
+		 */
+		deletedFile?: boolean;
+
+		/** Storage access framework mode */
+		SAFMode?: "single" | "tree";
+
+		/** Text encoding */
+		encoding?: string;
+
+		/** Cursor position */
+		cursorPos?: object;
+
+		/** Scroll left position */
+		scrollLeft?: number;
+
+		/** Scroll top position */
+		scrollTop?: number;
+
+		/** Code folds */
+		folds?: Ace.Fold[];
+
+		/** Type of content (e.g., 'editor')
+		 * @default "editor"
+		 */
+		type?: string;
+
+		/** Icon class for the file tab
+		 * @default "file file_type_default"
+		 */
+		tabIcon?: string;
+
+		/** Custom content element or HTML string. Strings are sanitized using DOMPurify */
+		content?: string | HTMLElement;
+
+		/** Custom stylesheets for tab. Can be URL, or CSS string */
+		stylesheets?: string | string[];
+
+		/** Whether to hide quicktools for this tab
+		 * @default false
+		 */
+		hideQuickTools?: boolean;
+	}
+
+	interface FileEvent {
+		target: EditorFile;
+		stopPropagation(): void;
+		preventDefault(): void;
+		readonly BUBBLING_PHASE: boolean;
+		readonly defaultPrevented: boolean;
+	}
+
+	type FileEventType =
+		| "run"
+		| "save"
+		| "change"
+		| "focus"
+		| "blur"
+		| "close"
+		| "rename"
+		| "load"
+		| "loadError"
+		| "loadStart"
+		| "loadEnd"
+		| "changeMode"
+		| "changeEncoding"
+		| "changeReadOnly";
+}