@ioai/lerobot-studio 1.0.0

package/dist-lib/lerobot.d.ts

@@ -0,0 +1,106 @@
+/**
+ * Client-only React viewer for supported LeRobot datasets.
+ *
+ * @packageDocumentation
+ */
+
+import { default as React_2 } from 'react';
+
+/** Create a viewer data source for a local ZIP, TAR, or TAR.GZ archive. */
+export declare function createArchiveDataSourceFromFile(file: File): DataSource;
+
+/**
+ * Create a viewer data source for a remote archive.
+ *
+ * The host must provide appropriate CORS and HTTP Range support.
+ */
+export declare function createArchiveDataSourceFromUrl(url: string): DataSource;
+
+/** Browser-readable storage abstraction consumed by the viewer. */
+export declare interface DataSource {
+    /** Return whether a logical dataset path exists. */
+    exists(path: string): Promise<boolean>;
+    /** Read a UTF-8 text file. */
+    readText(path: string, onProgress?: ProgressHandler): Promise<string>;
+    /** Read a file as bytes. */
+    readBytes(path: string, onProgress?: ProgressHandler): Promise<Uint8Array>;
+    /** Return an object URL or remote URL suitable for browser media APIs. */
+    getObjectUrl(path: string, mimeType?: string, onProgress?: ProgressHandler): Promise<string>;
+    /** Release object URLs, handles, caches, and other source-owned resources. */
+    clear(): void | Promise<void>;
+    /**
+     * Lists logical dataset paths when the backing source has an index.
+     * Adapters use this to load every v3 metadata shard rather than guessing a
+     * contiguous chunk/file sequence.
+     */
+    listPaths?(): Promise<string[]>;
+    /** Invalidate object/blob URL for a logical path when the implementation supports it. */
+    invalidateObjectUrl?(path: string): void | Promise<void>;
+}
+
+export declare const LeRobotViewer: React_2.FC<LeRobotViewerProps>;
+
+/** A fatal viewer error that requires host action or an explicit retry. */
+export declare interface LeRobotViewerError {
+    /** Machine-readable category. */
+    code: LeRobotViewerErrorCode;
+    /** Localized message suitable for display. */
+    message: string;
+    /** Whether retrying the same operation may succeed. */
+    recoverable: boolean;
+    /** Original failure when one is available. */
+    cause?: unknown;
+}
+
+/** Stable error categories reported to an embedding host. */
+export declare type LeRobotViewerErrorCode = 'INVALID_DATA_SOURCE' | 'REMOTE_SOURCE_UNAVAILABLE' | 'UNSUPPORTED_ARCHIVE' | 'DATASET_LOAD_FAILED';
+
+/** Properties for the stable, client-only LeRobot dataset viewer. */
+export declare interface LeRobotViewerProps {
+    /** Remote archive URL or a custom browser data source. */
+    dataSource: string | DataSource;
+    /** Viewer color scheme. @defaultValue 'system' */
+    theme?: 'light' | 'dark' | 'system';
+    /** BCP 47 language tag. Built-in messages currently cover en, zh, and ja. */
+    language?: string;
+    /** Show the episode sidebar. @defaultValue true */
+    showSidebar?: boolean;
+    /** Show playback controls. @defaultValue true */
+    showPlaybackBar?: boolean;
+    /** Additional class name applied to the scoped viewer root. */
+    className?: string;
+    /** Optional host-owned navigation action. */
+    onBack?: () => void;
+    /** Optional host-owned export action; the npm viewer does not export data itself. */
+    onExport?: () => void;
+    /**
+     * Receives fatal source or dataset loading failures. When provided, the host
+     * owns fatal-error rendering and the built-in fatal state is not rendered.
+     */
+    onFatalError?: (error: LeRobotViewerError) => void;
+    /**
+     * Enable viewer keyboard shortcuts such as Space and arrow-key seeking.
+     * @defaultValue true
+     */
+    enableKeyboardShortcuts?: boolean;
+}
+
+/** A phase reported while a data source reads or prepares content. */
+export declare type LoadingPhase = 'download' | 'index' | 'gunzip' | 'read';
+
+/** Receives data-source progress updates. */
+export declare type ProgressHandler = (info: ProgressInfo) => void;
+
+/** Progress reported by a data-source operation. */
+export declare interface ProgressInfo {
+    /** Current operation phase. */
+    phase: LoadingPhase;
+    /** Bytes or logical units processed so far. */
+    loaded?: number;
+    /** Total bytes or logical units when known. */
+    total?: number;
+    /** Optional human-readable detail. */
+    message?: string;
+}
+
+export { }