@ioai/lerobot-studio 1.2.1 → 1.3.0

package/dist-lib/lerobot.d.ts

@@ -5,6 +5,7 @@
  */
 
 import { default as React_2 } from 'react';
+import * as React_3 from 'react';
 
 /** Create a viewer data source for a local ZIP, TAR, or TAR.GZ archive. */
 export declare function createArchiveDataSourceFromFile(file: File): DataSource;
@@ -16,6 +17,9 @@ export declare function createArchiveDataSourceFromFile(file: File): DataSource;
  */
 export declare function createArchiveDataSourceFromUrl(url: string): DataSource;
 
+/** Create a viewer data source from a File System Access directory handle. */
+export declare function createDirectoryDataSource(handle: FileSystemDirectoryHandle): DataSource;
+
 /**
  * Create a viewer data source from a host-owned list of per-file HTTP(S) URLs.
  *
@@ -25,6 +29,20 @@ export declare function createArchiveDataSourceFromUrl(url: string): DataSource;
  */
 export declare function createRemoteManifestDataSource(files: RemoteFileEntry[]): DataSource;
 
+/** Tabbed picker for local directory, local archive, or remote archive URL. */
+export declare const DatasetSourceSelector: React_2.FC<DatasetSourceSelectorProps>;
+
+/** Picker for a local directory, local archive, or remote archive URL. */
+export declare interface DatasetSourceSelectorProps {
+    onOpenDirectory: () => void;
+    onOpenLocalArchive: () => void;
+    onOpenRemoteArchive: (url?: string) => void;
+    requested?: ParsedSourceUrl | null;
+    onRequestUrl?: (rawUrl: string | null, mode: 'push' | 'replace') => void;
+    onRestoreFromUrl?: (requested: ParsedSourceUrl) => void;
+    className?: string;
+}
+
 /** Browser-readable storage abstraction consumed by the viewer. */
 export declare interface DataSource {
     /** Return whether a logical dataset path exists. */
@@ -47,8 +65,50 @@ export declare interface DataSource {
     invalidateObjectUrl?(path: string): void | Promise<void>;
 }
 
+/** A dropped directory entry with a relative path. */
+export declare interface DirectoryFile {
+    file: File;
+    path: string;
+}
+
+/** Callbacks for window-level file and folder drop (and file paste). */
+export declare interface DragAndDropCallbacks {
+    onFile: (file: File) => void;
+    onDirectoryHandle?: (handle: FileSystemDirectoryHandle) => void;
+    onDirectoryFiles?: (files: DirectoryFile[]) => void;
+    onUnresolvedDirectory?: (name: string) => void;
+}
+
+/** @deprecated Prefer LeRobotStudioProvider */
+export declare const LeRobotProvider: React_2.FC<LeRobotStudioProviderProps>;
+
+/**
+ * Shared theme, language, and dataset context for the viewer and a custom welcome page.
+ */
+export declare const LeRobotStudioProvider: React_2.FC<LeRobotStudioProviderProps>;
+
+export declare interface LeRobotStudioProviderProps {
+    theme?: 'light' | 'dark' | 'system';
+    language?: string;
+    className?: string;
+    children: React_2.ReactNode;
+    /** When true, render the shared Sonner toaster inside the studio root. @defaultValue true */
+    showToaster?: boolean;
+    /**
+     * When true (default), wrap children in a scoped root for CSS and portals.
+     * Set false when the host page already provides its own layout wrapper.
+     */
+    wrapRoot?: boolean;
+}
+
 export declare const LeRobotViewer: React_2.FC<LeRobotViewerProps>;
 
+/** Viewer without the provider wrapper; render inside `LeRobotStudioProvider`. */
+export declare function LeRobotViewerContent({ dataSource, showSidebar, showPlaybackBar, onFatalError, enableKeyboardShortcuts, onBack, onExport, }: Omit<LeRobotViewerProps, 'theme' | 'language' | 'className'> & {
+    showSidebar: boolean;
+    showPlaybackBar: boolean;
+}): React_2.JSX.Element | null;
+
 /** A fatal viewer error that requires host action or an explicit retry. */
 export declare interface LeRobotViewerError {
     /** Machine-readable category. */
@@ -97,6 +157,34 @@ export declare interface LeRobotViewerProps {
 /** A phase reported while a data source reads or prepares content. */
 export declare type LoadingPhase = 'download' | 'index' | 'gunzip' | 'read';
 
+/**
+ * Domain table pagination composed from official shadcn pagination primitives.
+ */
+export declare function Pagination({ count, page, onPageChange, rowsPerPage, onRowsPerPageChange, rowsPerPageOptions, className, }: PaginationProps): React_3.JSX.Element;
+
+export declare interface PaginationProps {
+    count: number;
+    page: number;
+    onPageChange: (event: unknown, newPage: number) => void;
+    rowsPerPage: number;
+    onRowsPerPageChange: (event: React_3.ChangeEvent<HTMLSelectElement>) => void;
+    rowsPerPageOptions?: number[];
+    className?: string;
+}
+
+/** Parsed `?url=` intent for restoring a previous local or remote source. */
+export declare interface ParsedSourceUrl {
+    kind: SourceKind;
+    /** Decoded raw ?url= value */
+    raw: string;
+    /** UI hint (e.g. local label) */
+    hint?: string;
+    /** sample:// id */
+    sampleId?: string;
+    /** IndexedDB has a restorable handle */
+    restorable?: boolean;
+}
+
 /** Receives data-source progress updates. */
 export declare type ProgressHandler = (info: ProgressInfo) => void;
 
@@ -124,4 +212,34 @@ export declare interface RemoteFileEntry {
     sizeBytes?: number | null;
 }
 
+/** A sample dataset shown as a card on a welcome page. */
+export declare interface SampleDataset {
+    id: string;
+    name: string;
+    description: string;
+    url?: string;
+    version?: 'v2' | 'v3';
+    title?: string;
+    coverImageUrl?: string;
+    previewVideoUrl?: string;
+    archiveUrl?: string;
+}
+
+/** Cover card for a sample dataset or similar list entry. */
+export declare const SampleDatasetCard: React_2.FC<SampleDatasetCardProps>;
+
+/** Cover card for a sample dataset or similar list entry. */
+export declare interface SampleDatasetCardProps {
+    sample: SampleDataset;
+    onSelect: (sample: SampleDataset) => void | Promise<void>;
+    fallbackImageUrl?: string;
+}
+
+export declare type SourceKind = 'remoteArchive' | 'localArchive' | 'directory' | 'sample' | 'unknown';
+
+/** Window-level drag-and-drop (and file paste) for local archives and directories. */
+export declare function useDragAndDrop(callbacks: DragAndDropCallbacks): {
+    isDragging: boolean;
+};
+
 export { }