@fluxlay/react 1.0.1 → 1.1.1

package/dist/index.d.ts

@@ -1,362 +0,0 @@
-import { FitAddon } from '@xterm/addon-fit';
-import { ITheme } from '@xterm/xterm';
-import { RefObject } from 'react';
-import { Terminal } from '@xterm/xterm';
-
-/** System audio information streamed from the Fluxlay backend. */
-declare interface AudioInfo {
-    /** RMS (Root Mean Square) volume level (0.0 - 1.0). */
-    rms: number;
-    /** Peak volume level (0.0 - 1.0). */
-    peak: number;
-    /** Frequency spectrum split into 32 logarithmically-scaled bands (0.0 - 1.0 each). */
-    spectrum: number[];
-}
-
-/** Storage information for a single disk/volume. */
-declare interface DiskInfo {
-    /** Mount point path (e.g. "/", "/home"). */
-    mountPoint: string;
-    /** Disk/volume name. */
-    name: string;
-    /** Total capacity in bytes. */
-    totalBytes: number;
-    /** Available (free) space in bytes. */
-    availableBytes: number;
-    /** Usage percentage (0.0 - 100.0). */
-    usage: number;
-}
-
-/** Media metadata information for the currently playing track. */
-declare interface MediaMetadataInfo {
-    /** Track title, or `null` if unavailable. */
-    title: string | null;
-    /** Artist name, or `null` if unavailable. */
-    artist: string | null;
-    /** Album name, or `null` if unavailable. */
-    album: string | null;
-    /** Artwork as a data URL (e.g. "data:image/jpeg;base64,..."), or `null` if unavailable. */
-    artwork: string | null;
-    /** Track duration in seconds, or `null` if unavailable. */
-    duration: number | null;
-    /** Elapsed playback time in seconds, or `null` if unavailable. */
-    elapsedTime: number | null;
-    /** Playback rate (0.0 = paused, 1.0 = playing), or `null` if unavailable. */
-    playbackRate: number | null;
-    /** Whether media is currently playing. */
-    isPlaying: boolean;
-}
-
-/**
- * Runs a pre-declared shell command from fluxlay.yaml.
- *
- * @param commandId The ID of the command declared in the manifest's `shell` section.
- * @param options Options for command execution.
- * @returns The standard output and error of the command.
- * @throws An error if the command fails or the ID is invalid.
- */
-export declare function runShell(commandId: string, options?: ShellOptions): Promise<ShellResult>;
-
-/** Options that control how a shell command is executed. */
-export declare interface ShellOptions {
-    /** Number of columns (character width) of the pseudo-terminal. */
-    columns?: number;
-    /** Number of rows (line height) of the pseudo-terminal. */
-    lines?: number;
-}
-
-/** The result returned after executing a shell command. */
-export declare interface ShellResult {
-    /** Standard output produced by the command. */
-    stdout: string;
-    /** Standard error produced by the command. */
-    stderr: string;
-    /** Exit status code of the process, or `null` if the process was terminated by a signal. */
-    statusCode: number | null;
-    /** Whether the command exited successfully (status code 0). */
-    success: boolean;
-    /** Signal number that terminated the process, or `null` if it exited normally. */
-    signal: number | null;
-}
-
-/** System hardware and performance information streamed from the Fluxlay backend. */
-declare interface SystemMonitorInfo {
-    /** Overall CPU usage percentage (0.0 - 100.0). */
-    cpuUsage: number;
-    /** Per-core CPU usage percentages (0.0 - 100.0 each). */
-    cpuPerCore: number[];
-    /** Per-core CPU frequency in MHz. */
-    cpuFrequencyMhz: number[];
-    /** Total physical memory in bytes. */
-    memoryTotal: number;
-    /** Used physical memory in bytes. */
-    memoryUsed: number;
-    /** Memory usage percentage (0.0 - 100.0). */
-    memoryUsage: number;
-    /** Total swap space in bytes. */
-    swapTotal: number;
-    /** Used swap space in bytes. */
-    swapUsed: number;
-    /** Swap usage percentage (0.0 - 100.0). */
-    swapUsage: number;
-    /** Battery charge level (0.0 - 100.0), or `null` if no battery is present. */
-    batteryLevel: number | null;
-    /** Whether the battery is currently charging, or `null` if no battery is present. */
-    batteryCharging: boolean | null;
-    /** Network receive speed in bytes per second. */
-    networkRxBytesPerSec: number;
-    /** Network transmit speed in bytes per second. */
-    networkTxBytesPerSec: number;
-    /** Disk read speed in bytes per second. */
-    diskReadBytesPerSec: number;
-    /** Disk write speed in bytes per second. */
-    diskWriteBytesPerSec: number;
-    /** Number of running processes. */
-    processCount: number;
-    /** System uptime in seconds. */
-    uptimeSecs: number;
-    /** Load average for the past 1, 5, and 15 minutes. */
-    loadAverage: [number, number, number];
-    /** Per-disk storage information. */
-    disks: DiskInfo[];
-    /** System hostname. */
-    hostname: string;
-    /** Operating system name and version. */
-    osName: string;
-    /** CPU model name (e.g. "Apple M2 Pro"). */
-    cpuBrand: string;
-    /** Number of physical CPU cores. */
-    physicalCoreCount: number;
-    /** Number of logical CPU cores (threads). */
-    logicalCoreCount: number;
-    /** CPU architecture (e.g. "aarch64", "x86_64"). */
-    cpuArch: string;
-    /** Kernel version string. */
-    kernelVersion: string;
-}
-
-/** Holds the xterm {@link Terminal} and its associated {@link FitAddon}. */
-export declare interface TerminalInstance {
-    /** The underlying xterm Terminal instance. */
-    terminal: Terminal;
-    /** The FitAddon used to resize the terminal to match its container element. */
-    fitAddon: FitAddon;
-}
-
-/**
- * Collection of pre-built xterm color themes.
- *
- * Pass any of these values to the `theme` option of {@link useTerminal}.
- *
- * @example
- * ```tsx
- * const { terminalRef, instance } = useTerminal({
- *   theme: TerminalThemes.dracula,
- * });
- * ```
- */
-export declare const TerminalThemes: {
-    /** Dark themes with a transparent background. */
-    readonly dark: {
-        /** Default dark theme using Tailwind color palette. */
-        readonly default: ITheme;
-        /** Modern dark theme using Slate/Rose color palette. */
-        readonly modern: ITheme;
-    };
-    /** Light themes. */
-    readonly light: {
-        /** Default light theme. */
-        readonly default: ITheme;
-        /** Modern light theme. */
-        readonly modern: ITheme;
-    };
-    /** Nord theme — an arctic, north-bluish color palette. */
-    readonly nord: ITheme;
-    /** Dracula theme — a dark theme with vivid accent colors. */
-    readonly dracula: ITheme;
-    /** Gruvbox themes — a retro groove color scheme. */
-    readonly gruvbox: {
-        /** Gruvbox dark variant. */
-        readonly dark: ITheme;
-        /** Gruvbox light variant. */
-        readonly light: ITheme;
-    };
-    /** Solarized themes — a precision color scheme with reduced brightness. */
-    readonly solarized: {
-        /** Solarized dark variant. */
-        readonly dark: ITheme;
-        /** Solarized light variant. */
-        readonly light: ITheme;
-    };
-    /** One Dark theme — based on Atom's One Dark syntax theme. */
-    readonly oneDark: ITheme;
-    /** Catppuccin themes — a soothing pastel color scheme. */
-    readonly catppuccin: {
-        /** Catppuccin Latte — the light variant. */
-        readonly latte: ITheme;
-        /** Catppuccin Frappé — a cool medium-dark variant. */
-        readonly frappe: ITheme;
-        /** Catppuccin Macchiato — a warm medium-dark variant. */
-        readonly macchiato: ITheme;
-        /** Catppuccin Mocha — the darkest variant. */
-        readonly mocha: ITheme;
-    };
-    /** Monokai Pro theme — a refined dark theme inspired by Monokai. */
-    readonly monokaiPro: ITheme;
-    /** Tokyo Night theme — a dark theme inspired by Tokyo city lights. */
-    readonly tokyoNight: ITheme;
-    /** Night Owl theme — optimized for late-night coding with low brightness. */
-    readonly nightOwl: ITheme;
-    /** Everforest themes — a green-tinted theme inspired by forests. */
-    readonly everforest: {
-        /** Everforest dark variant. */
-        readonly dark: ITheme;
-        /** Everforest light variant. */
-        readonly light: ITheme;
-    };
-};
-
-/**
- * React hook that subscribes to system audio information streamed from
- * the Fluxlay backend.
- *
- * Returns the current audio state including RMS volume, peak level,
- * and frequency spectrum data, useful for building audio visualizers.
- *
- * @returns The current audio info as `{ rms, peak, spectrum }`.
- */
-export declare function useAudio(): AudioInfo;
-
-/**
- * React hook that subscribes to media metadata streamed from the
- * Fluxlay backend.
- *
- * Returns information about the currently playing track from system
- * media players (e.g. Spotify, Apple Music), including title, artist,
- * album artwork, and playback state — useful for building
- * music-reactive wallpapers.
- *
- * @returns The current media metadata info.
- */
-export declare function useMediaMetadata(): MediaMetadataInfo;
-
-/**
- * React hook that subscribes to global mouse position events streamed from
- * the Fluxlay backend.
- *
- * The Y axis is inverted so that positive values point upward, matching a
- * standard mathematical coordinate system rather than the screen coordinate
- * system where Y grows downward.
- *
- * The subscription is scoped to the window identified by the `window_label`
- * query parameter of the current URL, defaulting to `"main"`.
- *
- * @returns The current mouse position as `{ x, y }`.
- */
-export declare function useMousePosition(): {
-    x: number;
-    y: number;
-};
-
-/**
- * React hook that executes a pre-declared Fluxlay shell command and
- * optionally renders its output into an xterm terminal.
- *
- * The command runs once on mount and is re-executed whenever `commandId`
- * changes or the `refreshInterval` elapses.
- *
- * @param commandId The ID of the command declared in `fluxlay.yaml`.
- * @param options Configuration options for execution and display behaviour.
- * @returns An object containing:
- *   - `execute` – manually triggers the command.
- *   - `isRunning` – `true` while the command is in progress.
- *   - `error` – error message string when the last execution failed, otherwise `null`.
- *   - `result` – the {@link ShellResult} of the last completed execution, or `null`.
- */
-export declare function useShell(commandId: string, options?: UseShellOptions): {
-    execute: () => Promise<void>;
-    isRunning: boolean;
-    error: string | null;
-    result: ShellResult | null;
-};
-
-/** Options for the {@link useShell} hook. */
-export declare interface UseShellOptions extends ShellOptions {
-    /**
-     * Interval in milliseconds at which the command is automatically re-executed.
-     * Set to `0` to disable auto-refresh.
-     * @defaultValue 30000
-     */
-    refreshInterval?: number;
-    /**
-     * Whether to write the command's stdout to the linked terminal.
-     * @defaultValue true
-     */
-    showStdout?: boolean;
-    /**
-     * Whether to write the command's stderr to the linked terminal.
-     * @defaultValue false
-     */
-    showStderr?: boolean;
-    /**
-     * Optional terminal instance returned by {@link useTerminal}.
-     * When provided, command output is rendered directly into the terminal and
-     * the terminal dimensions are used as the pseudo-terminal size.
-     */
-    terminal?: TerminalInstance | null;
-}
-
-/**
- * React hook that subscribes to system hardware information streamed
- * from the Fluxlay backend.
- *
- * Returns real-time system metrics including CPU usage, memory usage,
- * battery status, and network throughput — useful for building
- * system-reactive wallpapers (e.g. cyberpunk HUDs, hardware monitors).
- *
- * @returns The current system monitor info.
- */
-export declare function useSystemMonitor(): SystemMonitorInfo;
-
-/**
- * React hook that creates and manages a read-only xterm terminal rendered
- * inside a `<div>` element.
- *
- * The terminal is configured for display-only use: stdin is disabled, the
- * cursor is hidden, and the scrollback buffer is removed. Custom CSS overrides
- * are injected into `document.head` to make the terminal behave as an inline
- * block that expands to fill its container width.
- *
- * The terminal is disposed and the injected styles are removed when the
- * component unmounts or when `fontSize` / `fontFamily` change.
- *
- * @param options Display configuration for the terminal.
- * @returns An object containing:
- *   - `terminalRef` – a React ref that must be attached to the container `<div>`.
- *   - `instance` – the {@link TerminalInstance} once the terminal is mounted, or `null`.
- */
-export declare function useTerminal(options?: UseTerminalOptions): {
-    terminalRef: RefObject<HTMLDivElement | null>;
-    instance: TerminalInstance | null;
-};
-
-/** Options for the {@link useTerminal} hook. */
-export declare interface UseTerminalOptions {
-    /**
-     * Font size in pixels used by the terminal.
-     * @defaultValue 12
-     */
-    fontSize?: number;
-    /**
-     * CSS font-family string applied to the terminal.
-     * Defaults to a system monospace font stack.
-     */
-    fontFamily?: string;
-    /**
-     * Color theme applied to the terminal.
-     * @defaultValue {@link TerminalThemes.dark.default}
-     */
-    theme?: ITheme;
-}
-
-export { }