acode-plugin-types 1.11.7-patch.1

package/src/components/inputhints.d.ts

@@ -0,0 +1,45 @@
+declare namespace Acode {
+	/**
+	 * Functionality:
+	 * - Generates a list of hints based on user input.
+	 * - Displays matching hints as the user types.
+	 * - Allows users to select a hint and populate the input field.
+	 */
+	interface InputHints {
+		/**
+		 *
+		 * @param $input The HTMLInputElement representing the input field.
+		 * @param hints An array of hint strings or a callback function that generates hints dynamically.
+		 * @param onSelect A callback function called when a user selects a hint.
+		 */
+		(
+			$input: HTMLInputElement,
+			hints: Hint[] | HintCallback,
+			onSelect?: (value: string) => void,
+		): {
+			/** Returns the currently selected hint element  */
+			getSelected(): HTMLLIElement | undefined;
+
+			/** The hint list container */
+			container: HTMLUListElement;
+		};
+	}
+
+	interface HintObj {
+		value: string;
+		text: string;
+	}
+
+	type Hint = string | HintObj;
+
+	interface HintModification {
+		add(hint: Hint, index?: number): void;
+		remove(hint: Hint): void;
+		removeIndex(index: number): void;
+	}
+
+	type HintCallback = (
+		setHints: (hints: Array<Hint>) => void,
+		modification: HintModification,
+	) => void;
+}

package/src/components/page.d.ts

@@ -0,0 +1,22 @@
+declare namespace Acode {
+	interface Page {
+		/**
+		 * @param title The title text shown in the page header.
+		 * @param options  Optional configuration object.
+		 */
+		(
+			title: string,
+			options: {
+				/**
+				 * Element shown before the title (e.g. back button).
+				 */
+				lead: HTMLElement;
+
+				/**
+				 * Element shown after the title (e.g. menu icon).
+				 */
+				tail: HTMLElement;
+			},
+		): WCPage;
+	}
+}

package/src/components/palette.d.ts

@@ -0,0 +1,21 @@
+declare namespace Acode {
+	/**
+	 * The Palette component provides an interactive search interface with dynamic suggestions for your Acode plugin.
+	 * It creates a searchable input field with a dropdown list of options that updates as the user types.
+	 * This is what used in command palettes, find files etc.
+	 */
+	interface Palette {
+		/**
+		 * @param getList  Function that returns an array of options or Promises resolving to options. Called whenever the search input changes.
+		 * @param onSelect Callback function executed when the user selects an option. Receives the selected option value.
+		 * @param placeholder Optional text to display in the input field when empty.
+		 * @param onRemove  Optional callback triggered when the palette is closed/removed.
+		 */
+		(
+			getList: (hints: HintModification) => Array<string | string[]>,
+			onSelect: (value: string) => void,
+			placeholder?: string,
+			onRemove?: () => void,
+		): void;
+	}
+}

package/src/components/sideButton.d.ts

@@ -0,0 +1,35 @@
+declare namespace Acode {
+	/** The side buttons are buttons that appear vertically along the right side of the editor screen.
+	 * @since versionCode: 316
+	 */
+	interface SideButton {
+		/** Shows the side button */
+		show(): void;
+
+		/** Hides the side button */
+		hide(): void;
+	}
+
+	/** A function that creates and renders side button that is shown in right side of the editor in vertical direction.
+	 * @since versionCode: 316
+	 * */
+	type SideButtonConstructor = (options: SideButtonOptions) => SideButton;
+
+	/** The options of the side button */
+	interface SideButtonOptions {
+		/** The text label for the button */
+		text: string;
+
+		/** CSS class name for the button icon */
+		icon?: string;
+
+		/** Click handler function */
+		onclick: (ev: MouseEvent) => void;
+
+		/** Background color of the button */
+		backgroundColor?: string;
+
+		/** Text color of the button */
+		textColor?: string;
+	}
+}

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

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

package/src/components/terminal/terminalManager.d.ts

@@ -0,0 +1,113 @@
+declare namespace Acode {
+	interface Terminal {
+		/**
+		 * Create a new terminal session
+		 * @param options Terminal options
+		 */
+		create(options: TerminalOptions): Promise<TerminalInstance>;
+
+		/**
+		 * Create a local terminal (no server connection)
+		 * @param options Terminal options
+		 */
+		createLocal(options: TerminalOptions): Promise<TerminalInstance>;
+
+		/**
+		 * Create a server terminal (with backend connection)
+		 * @param options Terminal options
+		 */
+		createServer(options: TerminalOptions): Promise<TerminalInstance>;
+
+		/**
+		 * Get terminal by ID
+		 * @param id Terminal ID
+		 * @returns Terminal instance
+		 */
+		get(id: string): TerminalInstance;
+
+		/**
+		 * Get all active terminals
+		 * @returns All terminals
+		 */
+		getAll(): Map<string, TerminalInstance>;
+
+		/**
+		 * Write to a specific terminal
+		 * @param id Terminal ID
+		 * @param data Data to write
+		 */
+		write(id: string, data: string): void;
+
+		/**
+		 * Clear a specific terminal
+		 * @param id Terminal ID
+		 */
+		clear(id: string): void;
+
+		/**
+		 * Close a terminal session
+		 * @param id Terminal ID
+		 */
+		close(id: string): void;
+
+		themes: {
+			/**
+			 * Register a plugin theme
+			 * @param name Theme name
+			 * @param theme Theme object
+			 * @param pluginId Plugin ID for cleanup
+			 * @returns success
+			 */
+			register(name: string, theme: Xterm.ITheme, pluginId: string): boolean;
+
+			/**
+			 * Unregister a plugin theme
+			 * @param name Theme name
+			 * @param pluginId Plugin ID for verification
+			 */
+			unregister(name: string, pluginId: string): boolean;
+
+			/**
+			 * Get a theme by name
+			 * @param themeName Theme name
+			 * @returns Theme object
+			 */
+			get(name: string): Xterm.ITheme;
+
+			/**
+			 * Get all available themes
+			 * @returns All themes
+			 */
+			getAll(): Record<string, Xterm.ITheme>;
+
+			/**
+			 * Get all theme names
+			 * @returns Array of theme names
+			 */
+			getNames(): string[];
+
+			/**
+			 * Create a theme variant based on existing theme
+			 * @param baseName Base theme name
+			 * @param overrides Color overrides
+			 * @returns New theme object
+			 */
+			createVariant(baseName: string, overrides: Xterm.ITheme): Xterm.ITheme;
+		};
+	}
+
+	interface TerminalOptions
+		extends Xterm.ITerminalOptions,
+			Xterm.ITerminalInitOnlyOptions {
+		name?: string;
+		serverMode?: boolean;
+		port?: number;
+	}
+
+	interface TerminalInstance {
+		id: string;
+		name: string;
+		file: EditorFile;
+		container: HTMLDivElement;
+	}
+}

package/src/components/toast.d.ts

@@ -0,0 +1,20 @@
+declare namespace Acode {
+	/**
+	 * This ui component help in showing toast messages for given time interval.
+	 */
+	interface Toast {
+		/**
+		 * @param message The message to be displayed in the toast.
+		 * @param duration The duration in milliseconds for which the toast should be displayed.
+		 */
+		(message: string, duration: number): void;
+	}
+}
+
+/** This ui component help in showing toast messages for given time interval. */
+declare const toast: Acode.Toast;
+
+interface Window {
+	/** This ui component help in showing toast messages for given time interval. */
+	toast: Acode.Toast;
+}

package/src/components/tutorial.d.ts

@@ -0,0 +1,13 @@
+declare namespace Acode {
+	/** The tutorial module provides functionality to display one-time tutorial messages to users. */
+	export interface Tutorial {
+		/**
+		 * @param id  Unique identifier for the tutorial message.
+		 * @param message The content to display, can be: - string: Plain text message - HTMLElement: Custom HTML content - Function: A function that returns HTMLElement and receives hide callback;
+		 */
+		(
+			id: string,
+			message: string | HTMLElement | ((hide: () => void) => void),
+		): void;
+	}
+}

package/src/components/webComponents/index.d.ts

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

package/src/components/webComponents/wcPage.d.ts

@@ -0,0 +1,85 @@
+declare namespace Acode {
+	interface WCPage extends HTMLElement {
+		handler: PageHandler;
+
+		onhide?: (this: WCPage) => void;
+		onconnect?: (this: WCPage) => void;
+		ondisconnect?: (this: WCPage) => void;
+		onwillconnect?: (this: WCPage) => void;
+		onwilldisconnect?: (this: WCPage) => void;
+
+		/** Adds elements to the main page content area */
+		appendBody(...elements: HTMLElement[]): void;
+
+		/** Adds elements outside the main content area */
+		appendOuter(...elements: HTMLElement[]): void;
+
+		connectedCallback(): void;
+
+		disconnectedCallback(): void;
+
+		/** Adds event listener to the page */
+		on(event: "hide" | "show", cb: (this: WCPage) => void): void;
+
+		/** Removes an event listener from the page */
+		off(event: "hide" | "show", cb: (this: WCPage) => void): void;
+
+		/** Updates the page title */
+		setTitle(title: string): void;
+
+		/** Hides the page */
+		hide(): string;
+
+		/** Shows the page */
+		show(): string;
+
+		/**
+		 * The main content container
+		 */
+		body: HTMLElement;
+
+		/**
+		 * The page's inner HTML content
+		 */
+		innerHTML: string;
+
+		/**
+		 * The page's text content
+		 */
+		textContent: string;
+
+		/** The lead element if defined */
+		lead: HTMLElement;
+
+		/**
+		 * The header container element
+		 */
+		header: HTMLElement;
+
+		initializeIfNotAlreadyInitialized(): void;
+	}
+
+	interface PageHandler {
+		$el: HTMLElement;
+
+		$replacement: HTMLElement;
+
+		onRestore?: () => void;
+		onReplace?: () => void;
+
+		/**
+		 * Replace current element with a replacement element
+		 */
+		replaceEl(): void;
+
+		/**
+		 * Restore current element from a replacement element
+		 */
+		restoreEl(): void;
+
+		onhide(): void;
+		onshow(): void;
+
+		remove(): void;
+	}
+}

package/src/dialogs/alert.d.ts

@@ -0,0 +1,15 @@
+declare namespace Acode {
+	/**
+	 * The alert component in Acode is a dialog box for displaying messages,
+	 * warnings, or errors to users within a modal window.
+	 * Similar to the traditional JavaScript alert().
+	 */
+	interface Alert {
+		/**
+		 * @param titleText The text to display in the title of the alert modal.
+		 * @param message The message to display in the body of the alert modal.
+		 * @param onhide An optional function to call when the alert modal is closed.
+		 */
+		(titleText: string, message: string, onhide?: () => void): void;
+	}
+}

package/src/dialogs/box.d.ts

@@ -0,0 +1,45 @@
+declare namespace Acode {
+	/**
+	 * The dialogBox API in Acode provides a way to create custom dialog boxes within your plugins.
+	 * Basically it creates a dialog and gives you the freedom to display whatever you wish.
+	 */
+	interface DialogBoxConstructor {
+		/**
+		 * Dialog Box Instance
+		 * @param titleText Title text
+		 * @param html HTML string
+		 * @param hideButtonText Text for hide button
+		 * @param cancelButtonText Text for cancel button
+		 * @returns Dialog Box instance
+		 */
+		(
+			titleText: string,
+			html: string,
+			hideButtonText: string,
+			cancelButtonText: string,
+		): DialogBox;
+	}
+
+	interface DialogBox {
+		/** The hide method is used to hide the dialog box. */
+		hide(): void;
+
+		/** The wait method disables the OK button for the specified time (in milliseconds). */
+		wait(time: number): DialogBox;
+
+		/** The onhide method sets a callback function to be called when the dialog box is hidden. */
+		onhide(onhide: () => void): DialogBox;
+
+		/** The onclick method sets a callback function to be called when the content is clicked. */
+		onclick(onclick: (this: HTMLElement, ev: MouseEvent) => void): DialogBox;
+
+		/** The then method sets a callback function to be called when the OK button is clicked. */
+		then(callback: (arg0: HTMLCollection) => void): DialogBox;
+
+		/** The ok method sets a callback function to be called when the OK button is clicked. */
+		ok(onOk: () => void): DialogBox;
+
+		/** The cancel method sets a callback function to be called when the Cancel button is clicked. */
+		cancel(onCancel: () => void): DialogBox;
+	}
+}

package/src/dialogs/color.d.ts

@@ -0,0 +1,15 @@
+declare namespace Acode {
+	/**
+	 * The colorPicker dialog box in Acode offers a way for users to choose colors within your plugins.
+	 * This feature-rich color picker opens a dialog box showcasing a spectrum of color options, providing users with an intuitive and visually pleasing experience.
+	 */
+	interface ColorPicker {
+		/**
+		 * @param defaultColor The default color that the color picker will display initially.
+		 * It should be a string representing a color in hexadecimal format or rgba or hsl.
+		 * @param onhide The callback function to be called when the color picker dialog box is closed.
+		 * @returns The colorPicker component returns a promise that resolves to a string representing the selected color.
+		 */
+		(defaultColor: string, onhide?: () => void): Promise<string>;
+	}
+}

package/src/dialogs/confirm.d.ts

@@ -0,0 +1,16 @@
+declare namespace Acode {
+	/**
+	 * The confirm ui component in Acode is a dialog box for displaying confirmation message modals to users.
+	 * Whether you're seeking user approval for a critical action or confirming a decision, this component is best suited for this process.
+	 */
+	interface Confirm {
+		/**
+		 * @param titleText A string representing the title of the confirmation message modal. This title will be displayed at the top of the message modal.
+		 * @param message A string representing the body of the confirmation message modal.
+		 * @returns The confirm component returns a promise that resolves to a boolean value.
+		 * The boolean value represents whether the user confirmed or denied the message.
+		 * A value of true represents confirmation, while false represents denial.
+		 */
+		(titleText: string, message: string): Promise<boolean>;
+	}
+}

package/src/dialogs/index.d.ts

@@ -0,0 +1,8 @@
+/// <reference path="./alert.d.ts" />
+/// <reference path="./box.d.ts" />
+/// <reference path="./color.d.ts" />
+/// <reference path="./confirm.d.ts" />
+/// <reference path="./loader.d.ts" />
+/// <reference path="./multiPrompt.d.ts" />
+/// <reference path="./prompt.d.ts" />
+/// <reference path="./select.d.ts" />

package/src/dialogs/loader.d.ts

@@ -0,0 +1,44 @@
+declare namespace Acode {
+	/**
+	 * The loader ui component in Acode is utility that help you to display loading dialogs with customizable titles and messages.
+	 * These loading dialogs offer an informative and engaging experience for users while waiting for various processes to complete.
+	 * The component also provides options for setting timeouts and callback functions for handling loading process cancellations.
+	 */
+	interface Loader {
+		/** Shows the title loader.
+		 * @param immortal If true, the loader will not be removed automatically.
+		 */
+		showTitleLoader(immortal?: boolean): void;
+
+		/**
+		 * Hides the title loader.
+		 * @param immortal If not true, the loader will not remove when immortal was true when it was created.
+		 */
+		removeTitleLoader(immortal?: boolean): void;
+
+		/**  Creates a new loading dialog with the specified options.
+		 * @param titleText The title text to display on the loading dialog.
+		 * @param message The message to display on the loading dialog.
+		 */
+		create(
+			titleText: string,
+			message: string,
+			cancel: {
+				/** The time (in milliseconds) after which the loading process will automatically be cancelled. */
+				timeout: number;
+
+				/** A function that will be called when the loading process is cancelled. */
+				callback: () => void;
+			},
+		): void;
+
+		/** Removes the loading dialog from the DOM permanently. */
+		destroy(): void;
+
+		/** Hides the loading dialog temporarily. The dialog can be restored using the show() method. */
+		hide(): void;
+
+		/** Shows a previously hidden loading dialog. */
+		show(): void;
+	}
+}

package/src/dialogs/multiPrompt.d.ts

@@ -0,0 +1,16 @@
+declare namespace Acode {
+	/**
+	 * The multiPrompt ui component in Acode is a dialog box for prompting users with multiple inputs at once.
+	 * Whether you need to collect various pieces of information or gather complex input data.
+	 */
+	interface MultiPrompt {
+		/**
+		 * @param message The title for the prompt modal.
+		 * @param inputs The inputs to prompt the user for. It can be a single input or an array of inputs. Each input is defined by an object with various properties such as id, type, placeholder, etc.
+		 * @param help The help icon at the top of the multiPrompt will be enabled with the specified help URL. It must be valid url.
+		 */
+		(message: string, inputs: (Input | Input[])[], help: string): Promise<void>;
+	}
+
+	type Input = Partial<HTMLInputElement>;
+}

package/src/dialogs/prompt.d.ts

@@ -0,0 +1,47 @@
+declare namespace Acode {
+	/**
+	 * The prompt ui component in Acode is a dialog box for displaying prompts to users,
+	 * allowing them to provide input in a convenient and straightforward manner.
+	 */
+	interface Prompt {
+		/**
+		 * @param message A string that represents the message to be displayed to the user.
+		 * @param defaultValue A string that represents the default value of the input.
+		 * @param type A string that represents the type of input.
+		 * @param options An object that contains additional options for the prompt.
+		 * @returns The prompt component returns a promise that resolves to a string, number, or null if the prompt is canceled.
+		 */
+		(
+			message: string,
+			defaultValue: string,
+			type: "number" | "tel", // TODO: verify
+			options: PromptOptions<number>,
+		): Promise<number | null>;
+		(
+			message: string,
+			defaultValue: string,
+			type: PromptType,
+			options: PromptOptions<string>,
+		): Promise<string | null>;
+	}
+
+	type PromptType =
+		| "textarea"
+		| "text"
+		| "number"
+		| "tel"
+		| "search"
+		| "email"
+		| "url";
+
+	type PromptOptions<T> = Partial<{
+		/** A regular expression that the input must match. */
+		match: RegExp;
+		/** A boolean that indicates whether the input is required or not. */
+		required: boolean;
+		/** A string that represents the placeholder text of the input. */
+		placeholder: string;
+		/** A function that takes in a value and returns a boolean indicating whether the value is valid. */
+		test: (value: T) => boolean;
+	}>;
+}

package/src/dialogs/select.d.ts

@@ -0,0 +1,66 @@
+declare namespace Acode {
+	interface Select {
+		/**
+		 * @param title The header text shown at the top of the selection dialog.
+		 * @param items Options to display.
+		 * @param options Pass true to reject the promise on cancel instead of using an object.
+		 * @returns The value of the selected item as a string, or rejects if cancelled with `options`: true.
+		 */
+		(
+			title: string,
+			items: SelectItems,
+			options?: boolean | SelectOptions,
+		): Promise<string>;
+	}
+
+	type SelectItems = string[] | (string | boolean | null)[][] | SelectItem[];
+
+	interface SelectItem {
+		/** Unique identifier returned when selected */
+		value: string;
+
+		/** Display text shown to the user */
+		text: string;
+
+		/** CSS class for icon or 'letters' to use the letters parameter */
+		icon?: string;
+
+		/** Whether the option can be selected  */
+		disabled?: boolean;
+
+		/** Shows letter initials as an icon (when icon='letters') */
+		letters?: string;
+
+		/** Adds a checkbox to the option when set */
+		checkbox?: boolean;
+	}
+
+	type SelectOptions = Partial<{
+		/** Close dialog after selection.
+		 * @default true
+		 */
+		hideOnSelect: boolean;
+
+		/** Apply text transformation to options.
+		 * @default true
+		 */
+		textTransform: boolean;
+
+		/** Pre-selected option value.
+		 * @default undefined
+		 */
+		default: string;
+
+		/**
+		 * Called when dialog is cancelled.
+		 * @default undefined
+		 */
+		onCancel: () => void;
+
+		/**
+		 * Called when dialog is hidden.
+		 * @default undefined
+		 */
+		onHide: () => void;
+	}>;
+}