acode-plugin-types 1.11.7-patch.1

package/src/lib/editorManager.d.ts

@@ -0,0 +1,127 @@
+declare namespace Acode {
+	/**
+	 * The editorManager allows to interact with the Editor Instance and listen to various events
+	 * of Acode app with the help of various methods and Properties.
+	 * Basically for interacting with the opened files and tabs.
+	 */
+	interface EditorManager {
+		/** This property returns a list of all files. */
+		files: EditorFile[];
+
+		onupdate: () => void;
+		/**
+		 * This property returns the current file.
+		 */
+		activeFile: EditorFile;
+
+		/**
+		 * Adds a file to the manager's file list and updates the UI.
+		 * @param file - The file to be added.
+		 */
+		addFile(file: EditorFile): void;
+
+		/**
+		 * This is an instance of the Ace editor.
+		 */
+		editor: Ace.Editor;
+
+		/**
+		 * This function gets files from the list of opened files.
+		 * @param test the file id, uri, repo, or gist to find the file.
+		 * @param type the type of test.
+		 */
+		getFile(test: string, type: "uri" | "id" | "name"): EditorFile;
+
+		/**
+		 * This function switches the tab to the given file id.
+		 */
+		switchFile(id: string): void;
+
+		/**
+		 * This function returns the number of unsaved files.
+		 */
+		hasUnsavedFiles(): number;
+
+		/**
+		 * Gets the height of the editor
+		 */
+		getEditorHeight(editor: Ace.Editor): number;
+
+		/**
+		 * Gets the height of the editor
+		 */
+		getEditorWidth(editor: Ace.Editor): number;
+
+		/**
+		 * container: HTMLElement
+		 */
+		container: HTMLElement;
+
+		/**
+		 * The header element
+		 */
+		header: HTMLElement;
+
+		/**
+		 * Whether the editor is currently scrolling.
+		 */
+		readonly isScrolling: boolean;
+
+		readonly TIMEOUT_VALUE: number;
+
+		readonly openFileList: HTMLElement;
+
+		/** This function adds a listener for the specified event. */
+		on(
+			event:
+				| "file-content-changed"
+				| "file-loaded"
+				| "remove-file"
+				| "save-file"
+				| "switch-file",
+			listener: (file: EditorFile) => void,
+		): void;
+		on(
+			event: "add-folder" | "remove-folder" | "update-folder",
+			listener: (ev: { url: string; name: string }) => void,
+		): void;
+		on(event: EditorEvent, listener: (...args: any[]) => void): void;
+
+		/** This function removes a listener for the specified event. */
+		off(event: string, listener: (...args: any[]) => void): void;
+
+		/** This function emits an event with the specified arguments. */
+		emit(event: EditorEvent, ...args: any[]): void;
+	}
+
+	/** Editor Event */
+	type EditorEvent =
+		| "add-folder"
+		| "change"
+		| "file-content-changed"
+		| "file-loaded"
+		| "init-open-file-list"
+		| "new-file"
+		| "remove-file"
+		| "remove-folder"
+		| "rename-file"
+		| "save-file"
+		| "switch-file"
+		| "update-folder";
+}
+
+/**
+ * The editorManager allows to interact with the Editor Instance and listen to various events
+ * of Acode app with the help of various methods and Properties.
+ * Basically for interacting with the opened files and tabs.
+ */
+declare const editorManager: Acode.EditorManager;
+
+interface Window {
+	/**
+	 * The editorManager allows to interact with the Editor Instance and listen to various events
+	 * of Acode app with the help of various methods and Properties.
+	 * Basically for interacting with the opened files and tabs.
+	 */
+	editorManager: Acode.EditorManager;
+}

package/src/lib/fileList.d.ts

@@ -0,0 +1,70 @@
+declare namespace Acode {
+	/**
+	 * The File List API provides functionality to manage and interact with files and folders in the Acode workspace.
+	 * It returns a tree structure representing the file system hierarchy.
+	 */
+	interface FileList {
+		/**  Get all files in a folder */
+		(dir: string | (() => object)): Tree[];
+
+		/**
+		 * Adds event listener for file list
+		 * @param event - Event name
+		 * @param callback - Callback function
+		 */
+		on(event: FileListEvent, callback: (tree: Tree) => void): void;
+
+		/**
+		 * Removes event listener for file list
+		 * @param event - Event name
+		 * @param callback - Callback function
+		 */
+		off(event: FileListEvent, callback: (tree: Tree) => void): void;
+	}
+
+	interface Tree {
+		/** Name of the file/folder */
+		name: string;
+
+		/** Absolute URL path */
+		url: string;
+
+		/** Relative path */
+		path: string;
+
+		/** Child files/folders (if directory) */
+		children: Tree[];
+
+		/** Parent folder reference */
+		parent: Tree;
+
+		/** Whether root is in open folder list */
+		readonly isConnected: boolean;
+
+		/** Root folder reference */
+		readonly root: Tree;
+
+		/**
+		 * Updates the file/folder URL and name
+		 */
+		update(url: string, name?: string): void;
+
+		/** Converts tree to JSON representation */
+		toJSON(): TreeJson;
+	}
+
+	interface TreeJson {
+		name: string;
+		url: string;
+		path: string;
+		parent: string;
+		isDirectory: boolean;
+	}
+
+	type FileListEvent =
+		| "add-file"
+		| "remove-file"
+		| "add-folder"
+		| "remove-folder"
+		| "refresh";
+}

package/src/lib/fonts.d.ts

@@ -0,0 +1,29 @@
+declare namespace Acode {
+	/**
+	 * A straightforward API for managing fonts in your Acode project.
+	 */
+	interface Fonts {
+		/**
+		 * Adds a new font to your project.
+		 * @param name Unique identifier for the font
+		 * @param css CSS @font-face declaration
+		 */
+		add(name: string, css: string): void;
+
+		addCustom: (name: string, css: string) => void;
+
+		/** Retrieves a specific font's details. */
+		get(name: string): { name: string; css: string } | undefined;
+
+		/** Lists all available font names. */
+		getNames(): string[];
+
+		remove: (name: string) => boolean;
+
+		has: (name: string) => boolean;
+
+		setFont: (name: string) => Promise<void>;
+
+		loadFont: (name: string) => Promise<string>;
+	}
+}

package/src/lib/index.d.ts

@@ -0,0 +1,9 @@
+/// <reference path="./actionStack.d.ts" />
+/// <reference path="./editorFile.d.ts" />
+/// <reference path="./editorManager.d.ts" />
+/// <reference path="./fileList.d.ts" />
+/// <reference path="./fonts.d.ts" />
+/// <reference path="./openFolder.d.ts" />
+/// <reference path="./projects.d.ts" />
+/// <reference path="./selectionMenu.d.ts" />
+/// <reference path="./settings.d.ts" />

package/src/lib/openFolder.d.ts

@@ -0,0 +1,102 @@
+declare namespace Acode {
+	interface OpenFolder {
+		/**
+		 * @param path The path of the folder to be opened.
+		 */
+		(path: string, options?: OpenFolderOptions): void;
+
+		/**
+		 * Adds file or folder to the list if expanded.
+		 * @param url Url of file or folder to add
+		 * @param type is file or folder
+		 */
+		add(url: string, type: "file" | "folder"): void;
+
+		/** Renames an existing file or folder. */
+		renameItem(oldFile: string, newFile: string, newFilename: string): void;
+
+		/** Removes an existing file or folder. */
+		removeItem(url: string): void;
+
+		/** Removes multiple folders based on a URL pattern */
+		removeFolders(url: string): void;
+
+		/**
+		 * Find the folder that contains the url
+		 * @param {String} url
+		 * @returns {Folder}
+		 */
+		find(url: string): void;
+	}
+
+	type OpenFolderOptions = {
+		/** A name to be assigned to the folder. If not provided, the folder's name from the file system will be used. */
+		name?: string;
+	} & Partial<Pick<Folder, "id" | "saveState" | "listFiles" | "listState">>;
+
+	/** The addedFolder object is the global object which returns an Array of object.
+	 * This object provides essential properties and methods to interact with the currently
+	 * opened folders in the sidenav of Acode app.
+	 * Use these properties and methods to manipulate folder states, reload contents,
+	 * and manage folder visibility effectively.
+	 */
+	type AddedFolder = Folder[];
+
+	interface Folder {
+		/** An ID to be assigned to the folder. If not provided, an ID will be automatically generated. */
+		id: string;
+
+		/** The URL of the folder. */
+		url: string;
+
+		/**  The title of the folder. */
+		title: string;
+
+		/** List all files recursively. */
+		listFiles: boolean;
+
+		/**
+		 *  Indicates whether the state of the folder should be saved when the user closes it.
+		 * @default true
+		 */
+		saveState: boolean;
+
+		/** The HTML element of the folder. */
+		$node: Collapsible;
+
+		clipBoard: ClipBoard;
+
+		/** Removes the folder from the sidenav. */
+		remove: () => void;
+
+		/**  Reloads the folder. */
+		reload: () => void;
+
+		/**  The state of the folders in the folder. K -> dir, V -> open */
+		listState: Map<string, boolean>;
+	}
+
+	interface ClipBoard {
+		url?: string;
+		$el?: HTMLElement;
+		action?: "cut" | "copy";
+	}
+}
+
+/** The addedFolder object is the global object which returns an Array of object.
+ * This object provides essential properties and methods to interact with the currently
+ * opened folders in the sidenav of Acode app.
+ * Use these properties and methods to manipulate folder states, reload contents,
+ * and manage folder visibility effectively.
+ */
+declare const addedFolder: Acode.AddedFolder;
+
+interface Window {
+	/** The addedFolder object is the global object which returns an Array of object.
+	 * This object provides essential properties and methods to interact with the currently
+	 * opened folders in the sidenav of Acode app.
+	 * Use these properties and methods to manipulate folder states, reload contents,
+	 * and manage folder visibility effectively.
+	 */
+	addedFolder: Acode.AddedFolder;
+}

package/src/lib/projects.d.ts

@@ -0,0 +1,28 @@
+declare namespace Acode {
+	/**
+	 * This provide methods to manipulate project templates. This includes listing available projects, retrieving specific project details, and setting new project templates.
+	 * This is particularly useful for creating and managing templates for different types of projects(frameworks), such as HTML templates, react, etc.
+	 */
+	interface Projects {
+		/**
+		 * Returns an array of objects, each containing the name and icon of a project.
+		 */
+		list(): { name: string; icon: string }[];
+
+		/**
+		 * Takes a project name as an argument and returns an object containing the files and icon of that project.
+		 */
+		get(
+			name: string,
+		): { files: Record<string, string>; icon: string } | undefined;
+
+		/**
+		 *  Adds a new project template. It takes the project name, a function that returns a map of files, and an icon source as arguments.
+		 */
+		set(
+			project: string,
+			files: () => Promise<Record<string, string>>,
+			iconSrc: string,
+		): void;
+	}
+}

package/src/lib/selectionMenu.d.ts

@@ -0,0 +1,19 @@
+declare namespace Acode {
+	interface SelectionMenu {
+		/**
+		 * The add method allows you to add new items to the selection menu.
+		 * @param onclick A function that gets executed when the menu item is clicked.
+		 * @param text The icon or text to display in the menu.
+		 * @param mode Specifies when this item should be shown in the selection menu. The possible values are:
+		 * 'selected': Show when some text is selected.
+		 * 'all': Show regardless of text selection.
+		 * @param readOnly A boolean value that determines whether the item should be shown in read-only mode.
+		 */
+		add(
+			onclick: (ev?: MouseEvent) => void,
+			text: string,
+			mode: "selected" | "all",
+			readOnly?: boolean,
+		): void;
+	}
+}

package/src/lib/settings.d.ts

@@ -0,0 +1,155 @@
+declare namespace Acode {
+	/**
+	 * The Settings module provides a way to interact with Acode's settings, allowing you to read, update and listen for changes to settings values.
+	 */
+	interface Settings {
+		readonly QUICKTOOLS_ROWS: number;
+		readonly QUICKTOOLS_GROUP_CAPACITY: number;
+		readonly QUICKTOOLS_GROUPS: number;
+		readonly QUICKTOOLS_TRIGGER_MODE_TOUCH: string;
+		readonly QUICKTOOLS_TRIGGER_MODE_CLICK: string;
+		readonly OPEN_FILE_LIST_POS_HEADER: string;
+		readonly OPEN_FILE_LIST_POS_SIDEBAR: string;
+		readonly OPEN_FILE_LIST_POS_BOTTOM: string;
+		readonly KEYBOARD_MODE_NO_SUGGESTIONS: string;
+		readonly KEYBOARD_MODE_NO_SUGGESTIONS_AGGRESSIVE: string;
+		readonly KEYBOARD_MODE_NORMAL: string;
+		readonly CONSOLE_ERUDA: string;
+		readonly CONSOLE_LEGACY: string;
+		readonly PREVIEW_MODE_INAPP: string;
+		readonly PREVIEW_MODE_BROWSER: string;
+
+		uiSettings: any;
+
+		value: ISettings;
+
+		init(): Promise<void>;
+
+		/**
+		 * Updates one or more settings.
+		 * @param settings Object containing settings to update.
+		 * @param showToast Whether to show a confirmation toast (default: true).
+		 * @param save Whether to save settings (default: true).
+		 */
+		update(
+			settings: Partial<ISettings>,
+			showToast: boolean,
+			save: boolean,
+		): Promise<void>;
+
+		/**
+		 * Resets settings to default values.
+		 * @param setting The name of the setting to reset. If setting is not provided, all settings will be reset.
+		 */
+		reset(setting?: string): Promise<void>;
+
+		/**
+		 * Adds an event listener
+		 * @param event Event name in format 'update:setting' or 'reset'
+		 * @param callback Function to call when event occurs
+		 */
+		on<K extends keyof ISettings>(
+			event: `update:${K}`,
+			callback: (value: ISettings[K]) => void,
+		): void;
+		on(event: "reset", callback: (value: ISettings) => void): void;
+
+		/**
+		 * Removes an event listener from the settings.
+		 * @param event  Event name in format 'update:setting' or 'reset'
+		 * @param callback Function to remove
+		 */
+		off<K extends keyof ISettings>(
+			event: `update:${K}`,
+			callback: (value: ISettings[K]) => void,
+		): void;
+		off(event: "reset", callback: (value: ISettings) => void): void;
+
+		/**
+		 * Gets the value of the setting.
+		 * @param setting Name of the setting to get.
+		 */
+		get<K extends keyof ISettings>(setting: K): ISettings[K];
+
+		applyAnimationSetting(): Promise<void>;
+		applyLangSetting(): Promise<void>;
+	}
+
+	interface ISettings {
+		animation: string;
+		appTheme: string;
+		autosave: number;
+		fileBrowser: {
+			showHiddenFiles: boolean;
+			sortByName: boolean;
+		};
+		formatter: Record<string, unknown>;
+		maxFileSize: number;
+		serverPort: number;
+		previewPort: number;
+		showConsoleToggler: boolean;
+		previewMode: string;
+		disableCache: boolean;
+		useCurrentFileForPreview: boolean;
+		host: string;
+		search: {
+			caseSensitive: boolean;
+			regExp: boolean;
+			wholeWord: boolean;
+		};
+		lang: string;
+		fontSize: string;
+		editorTheme: string;
+		textWrap: boolean;
+		softTab: boolean;
+		tabSize: number;
+		retryRemoteFsAfterFail: boolean;
+		linenumbers: boolean;
+		formatOnSave: boolean;
+		fadeFoldWidgets: boolean;
+		autoCorrect: boolean;
+		openFileListPos: string;
+		quickTools: number;
+		quickToolsTriggerMode: string;
+		editorFont: string;
+		vibrateOnTap: boolean;
+		fullscreen: boolean;
+		floatingButton: boolean;
+		liveAutoCompletion: boolean;
+		showPrintMargin: boolean;
+		printMargin: number;
+		scrollbarSize: number;
+		showSpaces: boolean;
+		confirmOnExit: boolean;
+		lineHeight: number;
+		leftMargin: number;
+		checkFiles: boolean;
+		desktopMode: boolean;
+		console: string;
+		keyboardMode: string;
+		rememberFiles: boolean;
+		rememberFolders: boolean;
+		diagonalScrolling: boolean;
+		reverseScrolling: boolean;
+		teardropTimeout: number;
+		teardropSize: number;
+		scrollSpeed: string;
+		customTheme: Record<string, string>;
+		relativeLineNumbers: boolean;
+		elasticTabstops: boolean;
+		rtlText: boolean;
+		hardWrap: boolean;
+		useTextareaForIME: boolean;
+		touchMoveThreshold: number;
+		quicktoolsItems: unknown[];
+		excludeFolders: string[];
+		defaultFileEncoding: string;
+		inlineAutoCompletion: boolean;
+		colorPreview: boolean;
+		maxRetryCount: number;
+		showRetryToast: boolean;
+		showSideButtons: boolean;
+		showAnnotations: boolean;
+		pluginsDisabled: Record<string, boolean>;
+	}
+}

package/src/pages/fileBrowser/fileBrowser.d.ts

@@ -0,0 +1,65 @@
+type BrowseMode = "file" | "folder" | "both";
+
+interface SelectedFile {
+	type: "file" | "folder";
+	url: string;
+	name: string;
+}
+
+interface DefaultDir {
+	name: string;
+	url: string;
+}
+
+interface FileBrowser {
+	/**
+	 * Opens the file browser.
+	 * @param mode Specify file browser mode
+	 * @param info A small message to show what the file browser is opened for
+	 * @param doesOpenLast Should file browser open lastly visited directory?
+	 * @param defaultDir Default directory to open
+	 * @returns Selected file or folder information
+	 */
+	(
+		mode?: BrowseMode,
+		info?: string,
+		doesOpenLast?: boolean,
+		...defaultDir: DefaultDir[]
+	): Promise<SelectedFile>;
+
+	/**
+	 * Opens the selected file in the editor.
+	 * @param res The selected file result from file browser
+	 */
+	openFile(res: SelectedFile & { mode?: string }): void;
+
+	/**
+	 * Handles file open errors.
+	 * @param err Error object with optional code property
+	 */
+	openFileError(err: { code?: number }): void;
+
+	/**
+	 * Opens the selected folder.
+	 * @param res The selected folder result from file browser
+	 */
+	openFolder(res: SelectedFile): Promise<void>;
+
+	/**
+	 * Handles folder open errors.
+	 * @param err Error object with optional code property
+	 */
+	openFolderError(err: { code?: number }): void;
+
+	/**
+	 * Opens the selected file or folder based on its type.
+	 * @param res The selected result from file browser
+	 */
+	open(res: SelectedFile): void;
+
+	/**
+	 * Handles open errors (delegates to openFileError).
+	 * @param err Error object with optional code property
+	 */
+	openError(err: { code?: number }): void;
+}

package/src/pages/fileBrowser/index.d.ts

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

package/src/pages/index.d.ts

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

package/src/plugins/customtabs/CustomTabs.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Options for opening a URL in Chrome Custom Tabs.
+ */
+interface CustomTabsOptions {
+	/**
+	 * The toolbar color for the Custom Tab.
+	 * Accepts any valid CSS color string (e.g., '#FF5733', 'rgb(255,87,51)', 'red').
+	 */
+	toolbarColor?: string;
+
+	/**
+	 * Whether to show the page title in the toolbar.
+	 * @default true
+	 */
+	showTitle?: boolean;
+}
+
+/**
+ * Chrome Custom Tabs plugin for Cordova.
+ * Opens URLs in a Chrome Custom Tab, providing a seamless in-app browsing experience
+ * with faster loading times compared to launching the default browser.
+ * Falls back to the default browser if Custom Tabs are not available.
+ */
+interface CustomTabs {
+	/**
+	 * Opens a URL in a Chrome Custom Tab.
+	 *
+	 * @param url - The URL to open.
+	 * @param options - Optional configuration for the Custom Tab appearance.
+	 * @param success - Callback called when the Custom Tab is successfully launched.
+	 * @param error - Callback called if an error occurs while opening the URL.
+	 *
+	 * @example
+	 * // Open a URL with default options
+	 * CustomTabs.open('https://example.com');
+	 *
+	 * @example
+	 * // Open with custom toolbar color
+	 * CustomTabs.open(
+	 *   'https://example.com',
+	 *   { toolbarColor: '#6200EE', showTitle: true },
+	 *   () => console.log('Opened successfully'),
+	 *   (err) => console.error('Failed to open:', err)
+	 * );
+	 */
+	open(
+		url: string,
+		options?: CustomTabsOptions,
+		success?: () => void,
+		error?: (message: string) => void,
+	): void;
+}
+
+/**
+ * Global CustomTabs instance for opening URLs in Chrome Custom Tabs.
+ */
+declare const CustomTabs: CustomTabs;

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

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

package/src/plugins/index.d.ts

@@ -0,0 +1,4 @@
+/// <reference path="./customtabs/index.d.ts" />
+/// <reference path="./system/index.d.ts" />
+/// <reference path="./terminal/index.d.ts" />
+/// <reference path="./websocket/index.d.ts" />