@suds-cli/filetree 0.1.0-alpha.0

package/dist/index.d.cts

@@ -0,0 +1,196 @@
+import { Cmd, Msg } from '@suds-cli/tea';
+import { FileSystemAdapter, PathAdapter } from '@suds-cli/machine';
+import { Binding } from '@suds-cli/key';
+import { Style } from '@suds-cli/chapstick';
+
+/**
+ * Represents a file or directory item in the file tree.
+ * @public
+ */
+interface DirectoryItem {
+    /** Name of the file or directory */
+    name: string;
+    /** Formatted details string (e.g., "2024-01-15 10:30:00 -rw-r--r-- 1.2K") */
+    details: string;
+    /** Full path to the item */
+    path: string;
+    /** File extension (empty for directories) */
+    extension: string;
+    /** Whether this item is a directory */
+    isDirectory: boolean;
+    /** Parent directory path */
+    currentDirectory: string;
+    /** File mode bits (from fs.Stats.mode) for determining file type and permissions */
+    mode: number;
+}
+
+/**
+ * Keyboard bindings for the filetree component.
+ * @public
+ */
+interface FiletreeKeyMap {
+    down: Binding;
+    up: Binding;
+}
+/**
+ * Default key bindings for the filetree.
+ * @public
+ */
+declare const defaultKeyMap: FiletreeKeyMap;
+
+/**
+ * Style configuration for the filetree component.
+ * @public
+ */
+interface FiletreeStyles {
+    /** Style for selected/highlighted item */
+    selectedItem: Style;
+    /** Style for normal items */
+    normalItem: Style;
+}
+/**
+ * Default styles for the filetree component.
+ * @public
+ */
+declare function defaultStyles(): FiletreeStyles;
+/**
+ * Merge user provided style overrides with defaults.
+ * @public
+ */
+declare function mergeStyles(overrides?: Partial<FiletreeStyles>): FiletreeStyles;
+
+/**
+ * Options for creating a new FiletreeModel.
+ * @public
+ */
+interface FiletreeOptions {
+    /** Filesystem adapter for file operations */
+    filesystem: FileSystemAdapter;
+    /** Path adapter for path operations */
+    path: PathAdapter;
+    /** Initial directory to display */
+    currentDir?: string;
+    /** Whether to show hidden files */
+    showHidden?: boolean;
+    /** Custom key bindings */
+    keyMap?: FiletreeKeyMap;
+    /** Custom styles */
+    styles?: Partial<FiletreeStyles>;
+    /** Initial width */
+    width?: number;
+    /** Initial height */
+    height?: number;
+}
+/**
+ * Model for the filetree component.
+ * @public
+ */
+declare class FiletreeModel {
+    /** Current cursor position */
+    readonly cursor: number;
+    /** Array of directory items */
+    readonly files: DirectoryItem[];
+    /** Whether component is active and receives input */
+    readonly active: boolean;
+    /** Key bindings */
+    readonly keyMap: FiletreeKeyMap;
+    /** Minimum viewport scroll position */
+    readonly min: number;
+    /** Maximum viewport scroll position */
+    readonly max: number;
+    /** Component height */
+    readonly height: number;
+    /** Component width */
+    readonly width: number;
+    /** Styles */
+    readonly styles: FiletreeStyles;
+    /** Current directory */
+    readonly currentDir: string;
+    /** Whether to show hidden files */
+    readonly showHidden: boolean;
+    /** Last error, if any */
+    readonly error: Error | null;
+    /** Filesystem adapter */
+    readonly filesystem: FileSystemAdapter;
+    /** Path adapter */
+    readonly path: PathAdapter;
+    private constructor();
+    /**
+     * Creates a new filetree model.
+     * @param options - Configuration options
+     * @returns A new FiletreeModel instance
+     * @public
+     */
+    static new(options: FiletreeOptions): FiletreeModel;
+    /**
+     * Initializes the model and returns a command to load the directory.
+     * @returns Command to load directory listing
+     * @public
+     */
+    init(): Cmd<Msg>;
+    /**
+     * Sets whether the component is active and receives input.
+     * @param active - Whether component should be active
+     * @returns Updated model
+     * @public
+     */
+    setIsActive(active: boolean): FiletreeModel;
+    /**
+     * Updates the model in response to a message.
+     * @param msg - The message to handle
+     * @returns Tuple of updated model and command
+     * @public
+     */
+    update(msg: Msg): [FiletreeModel, Cmd<Msg> | null];
+    /**
+     * Renders the file tree view.
+     * @returns Rendered string
+     * @public
+     */
+    view(): string;
+    /**
+     * Gets the currently selected file, if any.
+     * @returns The selected DirectoryItem or null
+     * @public
+     */
+    get selectedFile(): DirectoryItem | null;
+}
+
+/**
+ * Message containing directory listing results.
+ * @public
+ */
+declare class GetDirectoryListingMsg {
+    readonly items: DirectoryItem[];
+    readonly _tag = "filetree-get-directory-listing";
+    constructor(items: DirectoryItem[]);
+}
+/**
+ * Message containing an error.
+ * @public
+ */
+declare class ErrorMsg {
+    readonly error: Error;
+    readonly _tag = "filetree-error";
+    constructor(error: Error);
+}
+
+/**
+ * Converts bytes to a human-readable size string.
+ * @param size - Size in bytes
+ * @returns Formatted string (e.g., "1.2K", "5.4M", "2.3G")
+ * @public
+ */
+declare function convertBytesToSizeString(size: number): string;
+/**
+ * Creates a command to asynchronously fetch directory contents.
+ * @param filesystem - Filesystem adapter for file operations
+ * @param path - Path adapter for path operations
+ * @param dir - Directory path to list
+ * @param showHidden - Whether to show hidden files
+ * @returns Command that will emit GetDirectoryListingMsg or ErrorMsg
+ * @public
+ */
+declare function getDirectoryListingCmd(filesystem: FileSystemAdapter, path: PathAdapter, dir: string, showHidden: boolean): Cmd<GetDirectoryListingMsg | ErrorMsg>;
+
+export { type DirectoryItem, ErrorMsg, type FiletreeKeyMap, FiletreeModel, type FiletreeOptions, type FiletreeStyles, GetDirectoryListingMsg, convertBytesToSizeString, defaultKeyMap, defaultStyles, getDirectoryListingCmd, mergeStyles };

package/dist/index.d.ts

@@ -0,0 +1,196 @@
+import { Cmd, Msg } from '@suds-cli/tea';
+import { FileSystemAdapter, PathAdapter } from '@suds-cli/machine';
+import { Binding } from '@suds-cli/key';
+import { Style } from '@suds-cli/chapstick';
+
+/**
+ * Represents a file or directory item in the file tree.
+ * @public
+ */
+interface DirectoryItem {
+    /** Name of the file or directory */
+    name: string;
+    /** Formatted details string (e.g., "2024-01-15 10:30:00 -rw-r--r-- 1.2K") */
+    details: string;
+    /** Full path to the item */
+    path: string;
+    /** File extension (empty for directories) */
+    extension: string;
+    /** Whether this item is a directory */
+    isDirectory: boolean;
+    /** Parent directory path */
+    currentDirectory: string;
+    /** File mode bits (from fs.Stats.mode) for determining file type and permissions */
+    mode: number;
+}
+
+/**
+ * Keyboard bindings for the filetree component.
+ * @public
+ */
+interface FiletreeKeyMap {
+    down: Binding;
+    up: Binding;
+}
+/**
+ * Default key bindings for the filetree.
+ * @public
+ */
+declare const defaultKeyMap: FiletreeKeyMap;
+
+/**
+ * Style configuration for the filetree component.
+ * @public
+ */
+interface FiletreeStyles {
+    /** Style for selected/highlighted item */
+    selectedItem: Style;
+    /** Style for normal items */
+    normalItem: Style;
+}
+/**
+ * Default styles for the filetree component.
+ * @public
+ */
+declare function defaultStyles(): FiletreeStyles;
+/**
+ * Merge user provided style overrides with defaults.
+ * @public
+ */
+declare function mergeStyles(overrides?: Partial<FiletreeStyles>): FiletreeStyles;
+
+/**
+ * Options for creating a new FiletreeModel.
+ * @public
+ */
+interface FiletreeOptions {
+    /** Filesystem adapter for file operations */
+    filesystem: FileSystemAdapter;
+    /** Path adapter for path operations */
+    path: PathAdapter;
+    /** Initial directory to display */
+    currentDir?: string;
+    /** Whether to show hidden files */
+    showHidden?: boolean;
+    /** Custom key bindings */
+    keyMap?: FiletreeKeyMap;
+    /** Custom styles */
+    styles?: Partial<FiletreeStyles>;
+    /** Initial width */
+    width?: number;
+    /** Initial height */
+    height?: number;
+}
+/**
+ * Model for the filetree component.
+ * @public
+ */
+declare class FiletreeModel {
+    /** Current cursor position */
+    readonly cursor: number;
+    /** Array of directory items */
+    readonly files: DirectoryItem[];
+    /** Whether component is active and receives input */
+    readonly active: boolean;
+    /** Key bindings */
+    readonly keyMap: FiletreeKeyMap;
+    /** Minimum viewport scroll position */
+    readonly min: number;
+    /** Maximum viewport scroll position */
+    readonly max: number;
+    /** Component height */
+    readonly height: number;
+    /** Component width */
+    readonly width: number;
+    /** Styles */
+    readonly styles: FiletreeStyles;
+    /** Current directory */
+    readonly currentDir: string;
+    /** Whether to show hidden files */
+    readonly showHidden: boolean;
+    /** Last error, if any */
+    readonly error: Error | null;
+    /** Filesystem adapter */
+    readonly filesystem: FileSystemAdapter;
+    /** Path adapter */
+    readonly path: PathAdapter;
+    private constructor();
+    /**
+     * Creates a new filetree model.
+     * @param options - Configuration options
+     * @returns A new FiletreeModel instance
+     * @public
+     */
+    static new(options: FiletreeOptions): FiletreeModel;
+    /**
+     * Initializes the model and returns a command to load the directory.
+     * @returns Command to load directory listing
+     * @public
+     */
+    init(): Cmd<Msg>;
+    /**
+     * Sets whether the component is active and receives input.
+     * @param active - Whether component should be active
+     * @returns Updated model
+     * @public
+     */
+    setIsActive(active: boolean): FiletreeModel;
+    /**
+     * Updates the model in response to a message.
+     * @param msg - The message to handle
+     * @returns Tuple of updated model and command
+     * @public
+     */
+    update(msg: Msg): [FiletreeModel, Cmd<Msg> | null];
+    /**
+     * Renders the file tree view.
+     * @returns Rendered string
+     * @public
+     */
+    view(): string;
+    /**
+     * Gets the currently selected file, if any.
+     * @returns The selected DirectoryItem or null
+     * @public
+     */
+    get selectedFile(): DirectoryItem | null;
+}
+
+/**
+ * Message containing directory listing results.
+ * @public
+ */
+declare class GetDirectoryListingMsg {
+    readonly items: DirectoryItem[];
+    readonly _tag = "filetree-get-directory-listing";
+    constructor(items: DirectoryItem[]);
+}
+/**
+ * Message containing an error.
+ * @public
+ */
+declare class ErrorMsg {
+    readonly error: Error;
+    readonly _tag = "filetree-error";
+    constructor(error: Error);
+}
+
+/**
+ * Converts bytes to a human-readable size string.
+ * @param size - Size in bytes
+ * @returns Formatted string (e.g., "1.2K", "5.4M", "2.3G")
+ * @public
+ */
+declare function convertBytesToSizeString(size: number): string;
+/**
+ * Creates a command to asynchronously fetch directory contents.
+ * @param filesystem - Filesystem adapter for file operations
+ * @param path - Path adapter for path operations
+ * @param dir - Directory path to list
+ * @param showHidden - Whether to show hidden files
+ * @returns Command that will emit GetDirectoryListingMsg or ErrorMsg
+ * @public
+ */
+declare function getDirectoryListingCmd(filesystem: FileSystemAdapter, path: PathAdapter, dir: string, showHidden: boolean): Cmd<GetDirectoryListingMsg | ErrorMsg>;
+
+export { type DirectoryItem, ErrorMsg, type FiletreeKeyMap, FiletreeModel, type FiletreeOptions, type FiletreeStyles, GetDirectoryListingMsg, convertBytesToSizeString, defaultKeyMap, defaultStyles, getDirectoryListingCmd, mergeStyles };