acode-plugin-types 1.11.7-patch.1

package/src/theme/list.d.ts

@@ -0,0 +1,29 @@
+declare namespace Acode {
+	/**
+	 * Acode provides a flexible and intuitive module for managing themes, enabling developers to seamlessly add,
+	 * retrieve, update, and list themes within their project.
+	 */
+	interface Themes {
+		/**
+		 * Adds a new theme to the theme collection.
+		 * @param theme An instance of ThemeBuilder defining the theme's properties.
+		 */
+		add(theme: ThemeBuilder): void;
+
+		/**
+		 * Retrieves a specific theme by its name.
+		 */
+		get(name: string): ThemeBuilder | undefined;
+
+		/**
+		 * Updates an existing theme in the theme collection.
+		 */
+		update(theme: ThemeBuilder): void;
+
+		/**
+		 * List all the themes in the theme list.
+		 * @returns The names of all the themes in the theme list.
+		 */
+		list(): string[];
+	}
+}

package/src/utils/KeyboardEvent.d.ts

@@ -0,0 +1,19 @@
+declare namespace Acode {
+	/**
+	 * The createKeyboardEvent API allows you to programmatically create and dispatch keyboard events in Acode.
+	 * This is useful for simulating keyboard interactions and testing keyboard-driven features.
+	 */
+	interface CreateKeyboardEvent {
+		/**
+		 * Creates a new keyboard event with the specified type and options.
+		 * @param type The type of keyboard event to create.
+		 * @param options Configuration options for the keyboard event.
+		 */
+		(
+			type: "keydown" | "keyup",
+			options: {
+				[K in keyof KeyboardEvent]?: KeyboardEvent[K];
+			},
+		): void;
+	}
+}

package/src/utils/Url.d.ts

@@ -0,0 +1,65 @@
+declare namespace Acode {
+	/** The Url module provides various utility functions for working with URLs.
+	 * This module is essential for parsing, manipulating, and formatting URLs within plugins.
+	 */
+	interface Url {
+		/**
+		 * Returns the basename of the last segment of the URL path, or null if the input is invalid.
+		 */
+		basename(url: string): string | null;
+
+		/**
+		 * Compares multiple URL strings and returns true if they are all the same, false otherwise.
+		 */
+		areSame(...urls: string[]): boolean;
+
+		/** Returns the file extension of the last segment of the URL path, or null if the input is invalid. */
+		extname(url: string): string | null;
+
+		/** Joins multiple path strings into a single URL string. */
+		join(...pathnames: string[]): string;
+
+		/** Returns a URL-safe string by encoding each component of the URL. */
+		safe(url: string): string;
+
+		/** Returns the path of the URL, or null if the input is invalid. */
+		pathname(url: string): string;
+
+		/** Returns the directory name from the URL, or null if the input is invalid. */
+		dirname(url: string): string;
+
+		/** Parses the given URL and returns an object containing the URL and query string. */
+		parse(url: string): { url: string; query: string };
+
+		/** Formats a URL object into a string. */
+		formate(urlObj: {
+			protocol: "ftp:" | "sftp:" | "http:" | "https:";
+			hostname: string | number;
+			path: string;
+			username?: string;
+			password?: string;
+			port?: string | number;
+			query?: object;
+		}): string;
+
+		/** Returns the protocol of a URL. */
+		getProtocol(url: string): "ftp:" | "sftp:" | "http:" | "https:";
+
+		/** Returns a URL string with the password (if present) replaced with asterisks. */
+		hidePassword(url: string): string;
+
+		/** Decodes the URL and returns an object containing username, password, hostname, pathname, port, and query. */
+		decodeUrl(url: string): {
+			protocol: "ftp:" | "sftp:" | "http:" | "https:";
+			hostname: string | number;
+			path: string;
+			username: string;
+			password: string;
+			port: string | number;
+			query: object;
+		};
+
+		/** Removes the trailing slash from a URL. */
+		trimSlash(url: string): string;
+	}
+}

package/src/utils/color.d.ts

@@ -0,0 +1,51 @@
+declare namespace Acode {
+	/**
+	 * The Color API provides functionality for color manipulation and conversion.
+	 * It allows you to create, modify, and analyze colors in different formats.
+	 */
+	interface ColorConstructor {
+		/**
+		 * Creates a new Color instance from a color string.
+		 * @param color A valid CSS color string (hex, rgb, hsl, color name etc.)
+		 */
+		(color: string): Color;
+	}
+
+	/**
+	 * The Color API provides functionality for color manipulation and conversion.
+	 * It allows you to create, modify, and analyze colors in different formats.
+	 */
+	interface Color {
+		/** Returns true if the color is considered dark (luminance < 0.5). */
+		isDark: boolean;
+
+		/** Returns true if the color is considered light (luminance >= 0.5). */
+		isLight: boolean;
+
+		/** Returns the HSL lightness value of the color (between 0 and 1). */
+		lightness: boolean;
+
+		/** Returns the perceived brightness of the color (between 0 and 1). */
+		luminance: boolean;
+
+		/** Returns the hexadecimal representation of the color. */
+		hex: string;
+
+		/** Returns the HSL representation of the color. */
+		hsl: { h: number; s: number; l: number };
+
+		/**
+		 * Darkens the color by the specified ratio
+		 * @param ratio Number between 0 and 1 indicating how much to darken
+		 * @returns The modified Color instance
+		 */
+		darken(ratio: number): Color;
+
+		/**
+		 * Lightens the color by the specified ratio
+		 * @param ratio Number between 0 and 1 indicating how much to darken
+		 * @returns The modified Color instance
+		 */
+		lighten(ratio: number): Color;
+	}
+}

package/src/utils/encodings.d.ts

@@ -0,0 +1,24 @@
+declare namespace Acode {
+	interface Encodings {
+		/** An array of all the supported encodings.  */
+		readonly encodings: {
+			name: string;
+			labels: string[];
+			aliases: string[];
+		}[];
+
+		/**
+		 * Encodes a string with the specified character set.
+		 * @param text The text to encode.
+		 * @param charset The character set name (e.g., UTF-8, GBK).
+		 */
+		encode(text: string, charset: string): Promise<ArrayBuffer>;
+
+		/**
+		 *
+		 * @param buffer The ArrayBuffer to decode.
+		 * @param charset The character set name (e.g., UTF-8, GBK).
+		 */
+		decode(buffer: ArrayBuffer, charset: string): Promise<string>;
+	}
+}

package/src/utils/helpers.d.ts

@@ -0,0 +1,102 @@
+declare namespace Acode {
+	interface Helpers {
+		/**
+		 * This helper method takes in a single parameter, a string named "filename", and returns a string representing an icon class for the file specified by the filename.
+		 * The icon class returned corresponds to the file type, which is determined by the file extension of the provided filename.
+		 * In simple, It will return icon according to filename.
+		 * @param filename The name of the file for which the icon class is to be returned.
+		 * @returns A string representing an icon class for the file specified by the filename. The icon class returned corresponds to the file type, which is determined by the file extension of the provided filename.
+		 */
+		getIconForFile(filename: string): string;
+
+		sortDir(
+			list: any[],
+			fileBrowser: any,
+			mode: "both" | "file" | "folder",
+		): any[];
+
+		/**
+		 * Gets error message from error object
+		 */
+		errorMessage(err: Error, ...args: string[]): Promise<string>;
+
+		error(err: Error, ...args: string[]): Promise<void>;
+
+		/**
+		 * Returns unique ID
+		 */
+		uuid(): string;
+
+		/**
+		 * Parses JSON string, if fails returns null
+		 */
+		parseJSON(string: string): unknown;
+
+		/**
+		 * Checks whether given type is directory or not
+		 */
+		isDir(type: "dir" | "directory" | "folder"): boolean;
+
+		/**
+		 * Checks whether given type is file or not
+		 */
+		isFile(type: "file" | "link"): boolean;
+
+		/**
+		 * Replace matching part of url to alias name by which storage is added.
+		 */
+		getVirtualPath(url: string): string;
+
+		/**
+		 * Updates uri of all active which matches the oldUrl as location
+		 * of the file
+		 */
+		updateUriOfAllActiveFiles(oldUrl: string, newUrl: string): void;
+
+		toInternalUri(uri: string): Promise<string>;
+
+		// biome-ignore lint/complexity/noBannedTypes: <explanation>
+		promisify(func: Function, ...args: unknown[]): Promise<unknown>;
+
+		checkAPIStatus(): Promise<boolean>;
+
+		fixFilename(name: string): string;
+
+		/**
+		 * Creates a debounced function that delays invoking the input function until after 'wait' milliseconds have elapsed
+		 * since the last time the debounced function was invoked. Useful for implementing behavior that should only happen
+		 * after the input is complete.
+		 *
+		 * @param func The function to debounce.
+		 * @param wait The number of milliseconds to delay.
+		 * @returns The new debounced function.
+		 * @example
+		 * window.addEventListener('resize', debounce(myFunction, 200));
+		 */
+
+		// biome-ignore lint/complexity/noBannedTypes: <explanation>
+		debounce(func: Function, wait: number): Function;
+
+		defineDeprecatedProperty<T, V>(
+			obj: T,
+			name: PropertyKey,
+			getter: () => V,
+			setter: (value: V) => void,
+		): void;
+
+		parseHTML(html: string): Element | Element[];
+
+		createFileStructure(
+			uri: string,
+			pathString: string,
+			isFile?: boolean,
+		): Promise<{
+			uri: string;
+			type: string;
+		}>;
+
+		formatDownloadCount(downloads: number): unknown;
+
+		isBinary(file: string): boolean;
+	}
+}

package/src/utils/index.d.ts

@@ -0,0 +1,5 @@
+/// <reference path="./KeyboardEvent.d.ts" />
+/// <reference path="./Url.d.ts" />
+/// <reference path="./color.d.ts" />
+/// <reference path="./encodings.d.ts" />
+/// <reference path="./helpers.d.ts" />

package/types/ace/VERSION

@@ -0,0 +1 @@
+v1.39.0