@aerokit/sdk 12.44.0

package/dist/dts/io/files.d.ts

@@ -0,0 +1,261 @@
+/**
+ * Provides a comprehensive static façade for file and directory operations,
+ * abstracting the underlying Java file system implementation.
+ */
+import { InputStream, OutputStream } from "@aerokit/sdk/io/streams";
+/**
+ * Represents a generic file system object (file or directory).
+ */
+export interface FileObject {
+    /** The simple name of the file or folder. */
+    name: string;
+    /** The absolute path of the file or folder. */
+    path: string;
+}
+/**
+ * Represents a folder object, extending the basic file object with lists of its contents.
+ */
+export interface FolderObject extends FileObject {
+    /** A list of file objects contained within this folder. */
+    files: FileObject[];
+    /** A list of sub-folder objects contained within this folder. */
+    folders: FolderObject[];
+}
+/**
+ * The Files class provides static methods for high-level file system manipulation,
+ * including checking properties, reading/writing content, and navigating the structure.
+ */
+export declare class Files {
+    /**
+     * The file system-dependent name separator character (e.g., "/" on Unix, "\" on Windows).
+     */
+    static readonly separator: string;
+    /**
+     * Checks if a file or directory exists at the given path.
+     * @param path The path to check.
+     * @returns True if the path exists, false otherwise.
+     */
+    static exists(path: string): boolean;
+    /**
+     * Checks if the file or directory at the given path is executable.
+     * @param path The path to check.
+     * @returns True if executable, false otherwise.
+     */
+    static isExecutable(path: string): boolean;
+    /**
+     * Checks if the file or directory at the given path is readable.
+     * @param path The path to check.
+     * @returns True if readable, false otherwise.
+     */
+    static isReadable(path: string): boolean;
+    /**
+     * Checks if the file or directory at the given path is writable.
+     * @param path The path to check.
+     * @returns True if writable, false otherwise.
+     */
+    static isWritable(path: string): boolean;
+    /**
+     * Checks if the file or directory at the given path is hidden.
+     * @param path The path to check.
+     * @returns True if hidden, false otherwise.
+     */
+    static isHidden(path: string): boolean;
+    /**
+     * Checks if the path refers to a directory.
+     * @param path The path to check.
+     * @returns True if it's a directory, false otherwise.
+     */
+    static isDirectory(path: string): boolean;
+    /**
+     * Checks if the path refers to a regular file.
+     * @param path The path to check.
+     * @returns True if it's a file, false otherwise.
+     */
+    static isFile(path: string): boolean;
+    /**
+     * Checks if two paths refer to the same underlying file system object.
+     * @param path1 The first path.
+     * @param path2 The second path.
+     * @returns True if they reference the same file/directory, false otherwise.
+     */
+    static isSameFile(path1: string, path2: string): boolean;
+    /**
+     * Returns the canonical (absolute and normalized) path for the given path.
+     * @param path The path to normalize.
+     * @returns The canonical path string.
+     */
+    static getCanonicalPath(path: string): string;
+    /**
+     * Gets the simple name of the file or directory at the given path (the last element).
+     * @param path The path.
+     * @returns The name.
+     */
+    static getName(path: string): string;
+    /**
+     * Gets the path of the parent directory.
+     * @param path The path.
+     * @returns The parent path string, or null/empty if none exists.
+     */
+    static getParentPath(path: string): string;
+    /**
+     * Reads all bytes from a file into a JavaScript byte array (an array of numbers).
+     *
+     * Note: This method automatically converts the native Java byte array to a
+     * JavaScript array using `Bytes.toJavaScriptBytes()`.
+     * @param path The path to the file.
+     * @returns A JavaScript array of byte values.
+     */
+    static readBytes(path: string): any[];
+    /**
+     * Reads all bytes from a file and returns the native Java byte array object.
+     * @param path The path to the file.
+     * @returns The native Java byte array.
+     */
+    static readBytesNative(path: string): any[];
+    /**
+     * Reads all text content from a file using the platform's default character encoding.
+     * @param path The path to the file.
+     * @returns The content of the file as a string.
+     */
+    static readText(path: string): string;
+    /**
+     * Writes the content of a JavaScript byte array to a file. Overwrites existing content.
+     *
+     * Note: This method automatically converts the JavaScript array to a native
+     * Java byte array using `Bytes.toJavaBytes()` before writing.
+     * @param path The path to the file.
+     * @param data The JavaScript array of byte values to write.
+     */
+    static writeBytes(path: string, data: any[]): void;
+    /**
+     * Writes the content of a native Java byte array to a file. Overwrites existing content.
+     * @param path The path to the file.
+     * @param data The native Java byte array to write.
+     */
+    static writeBytesNative(path: string, data: any[]): void;
+    /**
+     * Writes a string of text to a file using the platform's default character encoding. Overwrites existing content.
+     * @param path The path to the file.
+     * @param text The string content to write.
+     */
+    static writeText(path: string, text: string): void;
+    /**
+     * Gets the last modified time of the file or directory.
+     * @param path The path to the file or directory.
+     * @returns A JavaScript Date object representing the last modified time.
+     */
+    static getLastModified(path: string): Date;
+    /**
+     * Sets the last modified time of the file or directory.
+     * @param path The path to the file or directory.
+     * @param time The new Date object to set as the last modified time.
+     */
+    static setLastModified(path: string, time: Date): void;
+    /**
+     * Gets the owner of the file or directory.
+     * @param path The path to the file or directory.
+     * @returns The owner name as a string.
+     */
+    static getOwner(path: string): string;
+    /**
+     * Sets the owner of the file or directory.
+     * @param path The path to the file or directory.
+     * @param owner The new owner name.
+     */
+    static setOwner(path: string, owner: string): void;
+    /**
+     * Gets the permissions string for the file or directory (implementation dependent).
+     * @param path The path to the file or directory.
+     * @returns The permissions string.
+     */
+    static getPermissions(path: string): string;
+    /**
+     * Sets the permissions for the file or directory (implementation dependent).
+     * @param path The path to the file or directory.
+     * @param permissions The permissions string.
+     */
+    static setPermissions(path: string, permissions: string): void;
+    /**
+     * Gets the size of the file in bytes.
+     * @param path The path to the file.
+     * @returns The size in bytes.
+     */
+    static size(path: string): number;
+    /**
+     * Creates a new, empty file at the specified path.
+     * @param path The path where the file should be created.
+     */
+    static createFile(path: string): void;
+    /**
+     * Creates a new directory at the specified path.
+     * @param path The path where the directory should be created.
+     */
+    static createDirectory(path: string): void;
+    /**
+     * Copies a file or directory from a source path to a target path.
+     * @param source The source path.
+     * @param target The target path.
+     */
+    static copy(source: string, target: string): void;
+    /**
+     * Moves or renames a file or directory.
+     * @param source The source path.
+     * @param target The target path.
+     */
+    static move(source: string, target: string): void;
+    /**
+     * Deletes the file at the specified path.
+     * @param path The path to the file to delete.
+     */
+    static deleteFile(path: string): void;
+    /**
+     * Deletes the directory at the specified path.
+     * @param path The path to the directory to delete.
+     * @param forced If true, recursively deletes the directory and its contents.
+     */
+    static deleteDirectory(path: string, forced?: boolean): void;
+    /**
+     * Creates a new temporary file with the given prefix and suffix.
+     * @param prefix The prefix string to be used in generating the file's name.
+     * @param suffix The suffix string to be used in generating the file's name.
+     * @returns The path of the created temporary file.
+     */
+    static createTempFile(prefix: string, suffix: string): string;
+    /**
+     * Creates a new temporary directory with the given prefix.
+     * @param prefix The prefix string to be used in generating the directory's name.
+     * @returns The path of the created temporary directory.
+     */
+    static createTempDirectory(prefix: string): string;
+    /**
+     * Creates and returns a new {@link InputStream} for reading data from the file.
+     * @param path The path to the file.
+     * @returns A new InputStream instance.
+     */
+    static createInputStream(path: string): InputStream;
+    /**
+     * Creates and returns a new {@link OutputStream} for writing data to the file.
+     * @param path The path to the file.
+     * @returns A new OutputStream instance.
+     */
+    static createOutputStream(path: string): OutputStream;
+    /**
+     * Traverses a directory and returns a structured {@link FolderObject} hierarchy.
+     * @param path The path to the folder to traverse.
+     * @returns The root FolderObject containing the file system tree structure.
+     */
+    static traverse(path: string): FolderObject[];
+    /**
+     * Lists the direct children (files and folders) of a directory, returning only their paths.
+     * @param path The path to the directory.
+     * @returns An array of string paths for the contents of the directory.
+     */
+    static list(path: string): string[];
+    /**
+     * Finds files and directories matching a specified glob pattern within a directory tree.
+     * @param path The starting path for the search.
+     * @param pattern The glob pattern to match (e.g., "*.js", "**.txt").
+     * @returns An array of string paths that match the pattern.
+     */
+    static find(path: string, pattern: string): string[];
+}

package/dist/dts/io/image.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Provides a static façade for image manipulation operations,
+ * primarily focusing on resizing image streams.
+ */
+import { InputStream } from "@aerokit/sdk/io/streams";
+/**
+ * The Image class provides static methods for common image processing tasks.
+ * All methods operate on and return {@link InputStream} objects, making them
+ * suitable for piping image data through the file system or network.
+ */
+export declare class Image {
+    /**
+     * Resizes an image contained within an InputStream to the specified dimensions.
+     *
+     * @param original The InputStream containing the original image data.
+     * @param type The target format of the resized image (e.g., "png", "jpeg", "gif").
+     * @param width The target width in pixels.
+     * @param height The target height in pixels.
+     * @returns A new InputStream containing the resized image data in the specified format.
+     */
+    static resize(original: InputStream, type: string, width: number, height: number): InputStream;
+}

package/dist/dts/io/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./bytes";
+export { Bytes as bytes } from "./bytes";
+export * from "./files";
+export { Files as files } from "./files";
+export * from "./image";
+export { Image as image } from "./image";
+export * from "./streams";
+export { Streams as streams } from "./streams";
+export * from "./zip";
+export { Zip as zip } from "./zip";

package/dist/dts/io/streams.d.ts

@@ -0,0 +1,172 @@
+/**
+ * The Streams class provides static utility methods for stream creation,
+ * manipulation, and data copying.
+ */
+export declare class Streams {
+    /**
+     * Copies all bytes from the input stream to the output stream.
+     * This method is generally used for smaller streams.
+     *
+     * @param input The source {@link InputStream}.
+     * @param output The destination {@link OutputStream}.
+     */
+    static copy(input: InputStream, output: OutputStream): void;
+    /**
+     * Copies all bytes from the input stream to the output stream using a large buffer,
+     * suitable for large file transfers.
+     *
+     * @param input The source {@link InputStream}.
+     * @param output The destination {@link OutputStream}.
+     */
+    static copyLarge(input: InputStream, output: OutputStream): void;
+    /**
+     * Creates a new {@link InputStream} from a resource accessible via the class loader.
+     * This is typically used to read bundled resources within the application runtime.
+     *
+     * @param path The path to the resource.
+     * @returns A new {@link InputStream} instance for the resource.
+     */
+    static getResourceAsByteArrayInputStream(path: string): InputStream;
+    /**
+     * Creates a new {@link InputStream} from a JavaScript byte array (`any[]`).
+     *
+     * @param data The JavaScript array of byte values (`number[]`).
+     * @returns A new {@link InputStream} instance initialized with the byte data.
+     */
+    static createByteArrayInputStream(data: any[]): InputStream;
+    /**
+     * Creates a new {@link OutputStream} that writes data into an in-memory byte array.
+     * This is typically used as a buffer to capture output before processing it.
+     *
+     * @returns A new {@link OutputStream} instance backed by a byte array.
+     */
+    static createByteArrayOutputStream(): OutputStream;
+    /**
+     * Wraps a native (Java) InputStream object into a new JavaScript {@link InputStream} instance.
+     *
+     * @param native The underlying native InputStream object.
+     * @returns A new {@link InputStream} wrapper.
+     */
+    static createInputStream(native: any): InputStream;
+    /**
+     * Wraps a native (Java) OutputStream object into a new JavaScript {@link OutputStream} instance.
+     *
+     * Note: This method is not static in the original definition, but is placed here for completeness
+     * and consistency with other factory methods.
+     *
+     * @param native The underlying native OutputStream object.
+     * @returns A new {@link OutputStream} wrapper.
+     */
+    createOutputStream(native: any): OutputStream;
+}
+/**
+ * Represents an input stream for reading bytes.
+ * This class wraps a native stream object and provides methods for reading data.
+ */
+export declare class InputStream {
+    /** The underlying native Java stream object. */
+    readonly native: any;
+    /**
+     * @param native The native Java InputStream object.
+     */
+    constructor(native: any);
+    /**
+     * Reads the next byte of data from this input stream.
+     * @returns The next byte of data, or -1 if the end of the stream is reached.
+     */
+    read(): number;
+    /**
+     * Reads all remaining bytes from the stream and returns them as a JavaScript array.
+     *
+     * @returns A JavaScript array (`number[]`) of the byte values.
+     */
+    readBytes(): any[];
+    /**
+     * Reads all remaining bytes from the stream and returns the native Java byte array.
+     *
+     * @returns The native Java byte array object.
+     */
+    readBytesNative(): any[];
+    /**
+     * Reads all remaining bytes from the stream and converts them to a string
+     * using the platform's default character encoding.
+     *
+     * @returns The content of the stream as a string.
+     */
+    readText(): string;
+    /**
+     * Closes this input stream and releases any system resources associated with it.
+     */
+    close(): void;
+    /**
+     * Checks if the underlying native stream object is defined and non-null.
+     * @returns True if the stream is valid, false otherwise.
+     */
+    isValid(): boolean;
+}
+/**
+ * Represents an output stream for writing bytes.
+ * This class wraps a native stream object and provides methods for writing data.
+ */
+export declare class OutputStream {
+    /** The underlying native Java stream object. */
+    readonly native: any;
+    /**
+     * @param native The native Java OutputStream object.
+     */
+    constructor(native: any);
+    /**
+     * Writes the specified byte to this output stream.
+     * @param byte The byte (as a number 0-255) to write.
+     */
+    write(byte: number): void;
+    /**
+     * Writes the entire content of a JavaScript byte array to this output stream.
+     *
+     * @param data The JavaScript array (`number[]`) of byte values to write.
+     */
+    writeBytes(data: any[]): void;
+    /**
+     * Writes the entire content of a native Java byte array to this output stream.
+     *
+     * @param data The native Java byte array object to write.
+     */
+    writeBytesNative(data: any[]): void;
+    /**
+     * Converts the string to bytes using the platform's default character encoding
+     * and writes them to this output stream.
+     *
+     * @param text The string content to write.
+     */
+    writeText(text: string): void;
+    /**
+     * Closes this output stream and releases any system resources associated with it.
+     */
+    close(): void;
+    /**
+     * Retrieves the content written to this stream as a JavaScript byte array.
+     * This is typically used with a ByteArrayOutputStream.
+     *
+     * @returns A JavaScript array (`number[]`) of the byte values written to the stream.
+     */
+    getBytes(): any[];
+    /**
+     * Retrieves the content written to this stream as the native Java byte array.
+     * This is typically used with a ByteArrayOutputStream.
+     *
+     * @returns The native Java byte array object.
+     */
+    getBytesNative(): any[];
+    /**
+     * Retrieves the content written to this stream as a string using the platform's
+     * default character encoding. This is typically used with a ByteArrayOutputStream.
+     *
+     * @returns The content of the stream as a string.
+     */
+    getText(): string;
+    /**
+     * Checks if the underlying native stream object is defined and non-null.
+     * @returns True if the stream is valid, false otherwise.
+     */
+    isValid(): boolean;
+}

package/dist/dts/io/zip.d.ts

@@ -0,0 +1,178 @@
+import { InputStream, OutputStream } from "@aerokit/sdk/io/streams";
+/**
+ * The Zip class provides static utility methods for managing ZIP archives
+ * at both file path level and stream level.
+ */
+export declare class Zip {
+    /**
+     * Zips the content of a source directory or file into a target ZIP file.
+     *
+     * @param sourcePath The file system path to the content to be compressed.
+     * @param zipTargetPath The file system path where the resulting ZIP file should be saved.
+     */
+    static zip(sourcePath: string, zipTargetPath: string): void;
+    /**
+     * Unzips an existing ZIP file into a target directory.
+     *
+     * @param zipPath The file system path to the ZIP file to be extracted.
+     * @param targetPath The file system path to the directory where content should be extracted.
+     */
+    static unzip(zipPath: string, targetPath: string): void;
+    /**
+     * Creates a {@link ZipInputStream} that reads ZIP archive data from a provided
+     * generic {@link InputStream}. This allows for reading ZIP entries without
+     * writing the archive to disk first.
+     *
+     * @param inputStream The source stream containing the raw ZIP data.
+     * @returns A new {@link ZipInputStream} instance.
+     */
+    static createZipInputStream(inputStream: InputStream): ZipInputStream;
+    /**
+     * Creates a {@link ZipOutputStream} that writes compressed ZIP archive data
+     * to a provided generic {@link OutputStream}. This allows for creating ZIP archives
+     * in memory or streaming them directly.
+     *
+     * @param outputStream The destination stream where the raw ZIP data will be written.
+     * @returns A new {@link ZipOutputStream} instance.
+     */
+    static createZipOutputStream(outputStream: OutputStream): ZipOutputStream;
+}
+/**
+ * Represents an input stream for reading data from a ZIP archive.
+ * Data is accessed sequentially by iterating through {@link ZipEntry} objects.
+ */
+export declare class ZipInputStream {
+    private readonly native;
+    /**
+     * @param native The underlying native ZipInputStream object.
+     */
+    constructor(native: any);
+    /**
+     * Reads the next ZIP file entry and positions the stream at the beginning of the entry data.
+     * Must be called before reading data for an entry.
+     *
+     * @returns The next {@link ZipEntry} object, or null if there are no more entries.
+     */
+    getNextEntry(): ZipEntry;
+    /**
+     * Reads the data for the current entry and returns it as a JavaScript byte array.
+     *
+     * @returns A JavaScript array (`number[]`) of the byte values for the current entry.
+     */
+    read(): any[];
+    /**
+     * Reads the data for the current entry and returns the native Java byte array.
+     *
+     * @returns The native Java byte array object.
+     */
+    readNative(): any[];
+    /**
+     * Reads the data for the current entry and converts it to a string
+     * using the platform's default character encoding.
+     *
+     * @returns The content of the current entry as a string.
+     */
+    readText(): string;
+    /**
+     * Closes the underlying native ZipInputStream.
+     */
+    close(): void;
+}
+/**
+ * Represents an output stream for writing data to a ZIP archive.
+ * Entries must be explicitly created and closed.
+ */
+export declare class ZipOutputStream {
+    private readonly native;
+    /**
+     * @param native The underlying native ZipOutputStream object.
+     */
+    constructor(native: any);
+    /**
+     * Creates a new {@link ZipEntry} with the given name, and begins writing the
+     * entry's header to the archive stream. All subsequent write operations
+     * will apply to this entry until {@link closeEntry} is called.
+     *
+     * @param name The file or directory name to use inside the ZIP archive.
+     * @returns The newly created {@link ZipEntry} object.
+     */
+    createZipEntry(name: string): ZipEntry;
+    /**
+     * Writes the data from a JavaScript byte array to the current active entry in the stream.
+     *
+     * @param data The JavaScript array (`number[]`) of byte values to write.
+     */
+    write(data: any[]): void;
+    /**
+     * Writes the data from a native Java byte array to the current active entry in the stream.
+     *
+     * @param data The native Java byte array object to write.
+     */
+    writeNative(data: any[]): void;
+    /**
+     * Converts the string to bytes and writes it to the current active entry in the stream.
+     *
+     * @param text The string content to write.
+     */
+    writeText(text: string): void;
+    /**
+     * Closes the current active ZIP entry and positions the stream for the next entry.
+     */
+    closeEntry(): void;
+    /**
+     * Finalizes the writing of the ZIP file, flushes the stream, and closes the native object.
+     * This must be called after all entries have been written.
+     */
+    close(): void;
+}
+/**
+ * Represents an entry (file or directory) within a ZIP archive.
+ * It holds metadata about the archived item.
+ */
+export declare class ZipEntry {
+    private readonly native;
+    /**
+     * @param native The underlying native ZipEntry object.
+     */
+    constructor(native: any);
+    /**
+     * Gets the name of the entry (path relative to the ZIP root).
+     * @returns The name of the entry.
+     */
+    getName(): string;
+    /**
+     * Gets the uncompressed size of the entry data.
+     * @returns The size in bytes.
+     */
+    getSize(): number;
+    /**
+     * Gets the compressed size of the entry data.
+     * @returns The compressed size in bytes.
+     */
+    getCompressedSize(): number;
+    /**
+     * Gets the modification time of the entry.
+     * @returns The time as a numerical timestamp.
+     */
+    getTime(): number;
+    /**
+     * Gets the CRC-32 checksum of the uncompressed entry data.
+     * @returns The CRC value.
+     */
+    getCrc(): number;
+    /**
+     * Gets the optional comment for the entry.
+     * @returns The comment string.
+     */
+    getComment(): string;
+    /**
+     * Checks if the entry represents a directory.
+     * @returns True if it is a directory, false otherwise.
+     */
+    isDirectory(): boolean;
+    /**
+     * Checks if the underlying native ZipEntry object is defined and non-null.
+     * @returns True if the entry is valid, false otherwise.
+     */
+    isValid(): boolean;
+}

package/dist/dts/job/decorators.d.ts

@@ -0,0 +1,11 @@
+export interface ScheduledOptions {
+    expression: string;
+    group?: string;
+}
+/**
+ * @Scheduled decorator
+ * Marks an entire class as a scheduled job with a cron expression.
+ *
+ * introduced in TypeScript 5.0, which expects a ClassDecoratorContext object.
+ */
+export declare function Scheduled(options: ScheduledOptions): <T extends abstract new (...args: any) => any>(target: T, context: ClassDecoratorContext<T>) => void;

package/dist/dts/job/index.d.ts

@@ -0,0 +1,4 @@
+export { Scheduler as scheduler } from "./scheduler";
+export * from "./scheduler";
+export * as decorators from "./decorators";
+export * from "./decorators";