@ioai/lerobot-studio 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+> **Language / 语言：** [English](./CHANGELOG.md) | [简体中文](./CHANGELOG.zh-CN.md)
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2026-08-05
+
+### Added
+
+- Single-package source layout with logical `core`, `platform`, `ui`, `react`, and `web` boundaries
+- Package identity `@ioai/lerobot-studio` (MIT)
+- Shared `ViewerLayout` for app and library shells
+- `LeRobotStudioProvider` public composition root
+- Minimal synthetic LeRobot v2/v3 fixtures under `tests/fixtures/datasets`
+- GitHub Actions CI, nightly browser tests, and release workflow (npm + GHCR)
+- Governance, support, security response targets, privacy disclosure,
+  compatibility matrix, CODEOWNERS, and deprecation policy
+- Release evidence for the approved `1.0.0` gates
+
+### Changed
+
+- Defined the stable 1.0 library contract as viewer-only, ESM/CSR-only,
+  browser-only, React `^19.0.0`, zero telemetry, and backward compatible within
+  major version 1
+- Defined exact LeRobot `v2.1` and `v3.0` support; other declared versions are
+  unknown rather than prefix-compatible
+- Approved 1.0.0 release gates for unknown-version read-only warnings, blocked
+  export, browser validation, consumer validation, and official LeRobot
+  `v0.6.1` reader-consumable export
+- Sample datasets are env-injected only; no sample manifest ships in the repo
+
+### Removed
+
+- Internal GitLab CI / private deploy configuration
+- Google Analytics and Microsoft Clarity from the open-source web shell
+- Hardcoded monorepo `export` copy script
+- In-repo `public/sample-datasets.manifest.json`

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 IO-AI.TECH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/NOTICE

@@ -0,0 +1,42 @@
+LeRobot Studio Third-Party Notice
+=================================
+
+This repository depends on third-party packages. The exact dependency graph,
+versions, package registry locations, integrity hashes, and SPDX license
+identifiers are recorded in `package-lock.json`.
+
+## Notable production dependencies
+
+- `mediabunny` — MPL-2.0 (Mozilla Public License 2.0). Used for browser-side
+  video muxing, demuxing, and conversion during dataset export. MPL-2.0 is an
+  OSI-approved weak copyleft license (file-level). Unmodified use as a
+  dependency is permitted; if you modify MPL-covered files from mediabunny,
+  those modified files must remain under MPL-2.0 and source must be available
+  as required by that license.
+- `@fontsource-variable/geist` — OFL-1.1. Font software redistributed under the
+  SIL Open Font License. Retain the OFL text when redistributing the font files.
+
+Examples of additional non-MIT license identifiers present in the current
+lockfile include:
+
+- `argparse` 2.0.1 — Python-2.0
+- `caniuse-lite` 1.0.30001799 — CC-BY-4.0
+- `isexe` 3.1.5 — BlueOak-1.0.0
+- `lightningcss` 1.32.0 and 1.33.0 — MPL-2.0 (primarily a build tool)
+- `spawndamnit` 3.0.1 — `SEE LICENSE IN LICENSE`
+- `tslib` 2.8.1 — 0BSD
+
+This list is representative, not exhaustive; development tools, optional
+platform packages, and transitive dependencies may use additional licenses.
+This notice is an index, not a replacement for the applicable third-party
+license texts. Before distributing a built artifact, generate and review a
+complete production-artifact dependency and asset inventory from the exact
+lockfile and build output used for that release.
+
+## Trademarks
+
+LeRobot, Hugging Face, GitHub, Geist, and other product or company names are
+trademarks or registered trademarks of their respective owners. LeRobot Studio
+is an independent project by IO-AI.TECH and is not affiliated with, endorsed by,
+or sponsored by Hugging Face, GitHub, Vercel, or the trademark owners of those
+names, except where such a relationship is explicitly stated in writing.

package/README.md

@@ -0,0 +1,155 @@
+# LeRobot Studio  ·  [Live Demo →](https://lerobot.studio)
+
+[简体中文 — README.zh-CN.md](README.zh-CN.md)
+
+[![CI](https://github.com/ioai-tech/lerobot-studio/actions/workflows/ci.yml/badge.svg)](https://github.com/ioai-tech/lerobot-studio/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![Docs](https://img.shields.io/badge/docs-VitePress-blue.svg)](https://ioai-tech.github.io/lerobot-studio/)
+
+> Open [LeRobot](https://github.com/huggingface/lerobot) datasets in your browser. View video, charts, and raw data together, or add the same viewer to a React application.
+
+Use it as a standalone site at [lerobot.studio](https://lerobot.studio). The React package is not yet published to npm; until it is available, use the standalone app or build from this repository. Local folders and archives are processed in your browser and are not uploaded to a cloud service. If you open a remote URL, the browser requests data from that URL's server.
+
+<p align="center">
+  <img src=".github/assets/lerobot-studio-demo.webp" alt="LeRobot Studio demo — synchronized video, charts, and episode navigation" width="800" />
+</p>
+
+---
+
+## Documentation
+
+| Document                                   | Description                                                                  |
+| ------------------------------------------ | ---------------------------------------------------------------------------- |
+| [User Guide](docs/user-manual.md)          | Open data, browse episodes, inspect panels, edit, export, and use shortcuts. |
+| [Quick Start](docs/quick-start.md)         | Start with the standalone app or install the React package.                  |
+| [Embed in React](docs/embedding.md)        | Install and configure the viewer in your application.                        |
+| [API Reference](docs/api.md)               | `LeRobotViewer` props, data sources, and generated types.                    |
+| [Data formats](docs/data-formats.md)       | Supported LeRobot versions and archive types.                                |
+| [CORS & Range](docs/cors.md)               | Headers needed for remote archives.                                          |
+| [Browser support](docs/browser.md)         | Chromium / Firefox / WebKit notes.                                           |
+| [Troubleshooting](docs/troubleshooting.md) | Common failure modes.                                                        |
+| [Development](docs/development.md)         | Local setup and tests.                                                       |
+| [Deployment](docs/deployment.md)           | Docker, Cloudflare, sample env.                                              |
+| [Contributing](CONTRIBUTING.md)            | How to send a PR.                                                            |
+| [Security](SECURITY.md)                    | Reporting vulnerabilities.                                                   |
+
+Full docs site: [ioai-tech.github.io/lerobot-studio](https://ioai-tech.github.io/lerobot-studio/)
+
+---
+
+## Features
+
+- **Open local or remote data** — folders, `.zip`, `.tar`, `.tar.gz`, `.tgz`, and HTTP(S) archives
+- **Inspect data together** — synchronized video, images, charts, and raw features
+- **Navigate efficiently** — search and filter episodes, control playback, and use keyboard shortcuts
+- **Review dataset quality** — inspect dataset statistics and export health-check reports
+- **Edit and export in the standalone app** — update episode tasks, remove or restore episodes, and export `v2.1` or `v3.0` datasets
+- **Embed in React** — use the read-only viewer in a React 19 application
+- **Keep local data local** — local files are processed in the browser; the npm package does not collect usage data
+
+---
+
+## Quick Start (website)
+
+Open **[lerobot.studio](https://lerobot.studio)** — no installation required.
+
+Choose a local folder, a local archive, or paste a remote archive URL. For a guided walkthrough, see the [User Guide](docs/user-manual.md).
+
+### Run this repo locally
+
+```bash
+git clone https://github.com/ioai-tech/lerobot-studio.git
+cd lerobot-studio
+npm ci
+npm run fixtures:generate
+npm run dev          # http://localhost:5173
+npm run build        # production SPA → dist/
+```
+
+Docker:
+
+```bash
+docker build -t lerobot-studio .
+docker run --rm -p 8080:8080 lerobot-studio
+```
+
+---
+
+## Embedding in React
+
+The React package has not yet been published to npm. Its package name will be `@ioai/lerobot-studio`; until its first registry release, use the standalone app or build from this repository.
+
+```bash
+npm install @ioai/lerobot-studio
+```
+
+> **Requirements:** `react` and `react-dom` `^19.0.0`, ES modules, and client-side rendering. Server-side rendering, React Server Components, and Node.js are not supported.
+
+### Stylesheet
+
+```tsx
+import '@ioai/lerobot-studio/style.css';
+```
+
+### Basic usage
+
+```tsx
+import { LeRobotViewer } from '@ioai/lerobot-studio';
+import '@ioai/lerobot-studio/style.css';
+
+export function App() {
+  return (
+    <div style={{ height: 720, minHeight: 480 }}>
+      <LeRobotViewer dataSource="https://example.com/dataset.zip" />
+    </div>
+  );
+}
+```
+
+Give the wrapper an explicit height. The viewer fills its parent and does not set the page height.
+
+### Next.js (client only)
+
+```tsx
+'use client';
+
+import dynamic from 'next/dynamic';
+
+const Viewer = dynamic(() => import('@ioai/lerobot-studio').then((m) => m.LeRobotViewer), {
+  ssr: false,
+});
+```
+
+More integration examples: [Embedding Guide](docs/embedding.md) · [API Reference](docs/api.md).
+
+---
+
+## Supported datasets
+
+| `codebase_version`                               | Open                   | Notes                                       |
+| ------------------------------------------------ | ---------------------- | ------------------------------------------- |
+| `v2.1`                                           | View, edit, and export | Fully supported                             |
+| `v3.0`                                           | View, edit, and export | Fully supported                             |
+| Newer `v2` or `v3` minor version                 | View only              | Editing and export are disabled             |
+| `v2.0`, other major versions, or missing version | Not opened             | The app does not guess a compatible version |
+
+Archives: `.zip`, `.tar`, `.tar.gz`, `.tgz`.
+
+The npm package is for viewing and in-session episode changes. The export engine is only available in the standalone app. Details: [Data formats](docs/data-formats.md).
+
+---
+
+## Contributing
+
+Issues and PRs welcome — please read [CONTRIBUTING.md](CONTRIBUTING.md) first.
+
+- Bugs / features → GitHub Issues
+- Security → [SECURITY.md](SECURITY.md)
+
+---
+
+## License
+
+[MIT](LICENSE) © 2026 [IO-AI.TECH](https://io-ai.tech)
+
+Third-party notices: [NOTICE](NOTICE). LeRobot Studio is an independent project and is not affiliated with Hugging Face.

package/README.zh-CN.md

@@ -0,0 +1,155 @@
+# LeRobot Studio  ·  [在线演示 →](https://lerobot.studio)
+
+[English — README.md](README.md)
+
+[![CI](https://github.com/ioai-tech/lerobot-studio/actions/workflows/ci.yml/badge.svg)](https://github.com/ioai-tech/lerobot-studio/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![Docs](https://img.shields.io/badge/docs-VitePress-blue.svg)](https://ioai-tech.github.io/lerobot-studio/)
+
+> 在浏览器中打开 [LeRobot](https://github.com/huggingface/lerobot) 数据集，同时查看视频、图表和原始数据；也可以将同一套查看器加入 React 应用。
+
+你可以直接使用 [lerobot.studio](https://lerobot.studio)。React 包尚未发布到 npm；发布前请使用独立应用或从本仓库构建。本地文件夹和压缩包会在浏览器中处理，不会上传到云端。只有打开远程链接时，浏览器才会向该链接所在的服务器请求数据。
+
+<p align="center">
+  <img src=".github/assets/lerobot-studio-demo.webp" alt="LeRobot Studio 演示 — 同步视频、图表与 Episode 浏览" width="800" />
+</p>
+
+---
+
+## 文档
+
+| 文档                                      | 说明                                                 |
+| ----------------------------------------- | ---------------------------------------------------- |
+| [使用指南](docs/user-manual.zh-CN.md)     | 打开数据、浏览 Episode、查看面板、编辑、导出和快捷键 |
+| [快速开始](docs/quick-start.zh-CN.md)     | 使用独立应用或安装 React 包                          |
+| [嵌入 React](docs/embedding.zh-CN.md)     | 在自己的应用中安装和配置查看器                       |
+| [API 参考](docs/api.zh-CN.md)             | `LeRobotViewer` 属性、数据源和类型                   |
+| [数据格式](docs/data-formats.zh-CN.md)    | 支持的数据集版本与归档类型                           |
+| [CORS 与 Range](docs/cors.zh-CN.md)       | 远程归档需要的响应头                                 |
+| [浏览器支持](docs/browser.zh-CN.md)       | Chromium / Firefox / WebKit                          |
+| [故障排查](docs/troubleshooting.zh-CN.md) | 常见打不开的情况                                     |
+| [开发](docs/development.zh-CN.md)         | 本地环境与测试                                       |
+| [部署](docs/deployment.zh-CN.md)          | Docker、Cloudflare、样例环境变量                     |
+| [贡献指南](CONTRIBUTING.zh-CN.md)         | 怎么提 PR                                            |
+| [安全](SECURITY.zh-CN.md)                 | 漏洞报告                                             |
+
+文档站：[ioai-tech.github.io/lerobot-studio](https://ioai-tech.github.io/lerobot-studio/)
+
+---
+
+## 功能
+
+- **打开本地或远程数据** — 文件夹、`.zip`、`.tar`、`.tar.gz`、`.tgz` 和 HTTP(S) 压缩包
+- **同步查看数据** — 视频、图像、图表和原始特征保持在同一帧
+- **快速浏览 Episode** — 搜索和筛选 Episode，控制播放，并使用键盘快捷键
+- **检查数据集质量** — 查看数据集统计信息，导出健康检查报告
+- **在独立应用中编辑和导出** — 修改 Episode 任务、删除或恢复 Episode，并导出 `v2.1` 或 `v3.0` 数据集
+- **嵌入 React** — 在 React 19 应用中使用只读查看器
+- **本地数据留在本地** — 本地文件在浏览器中处理；npm 包不会收集使用数据
+
+---
+
+## 快速开始（网站）
+
+打开 **[lerobot.studio](https://lerobot.studio)**，无需安装。
+
+选择本地文件夹、本地压缩包，或粘贴远程压缩包地址。完整操作说明见 [使用指南](docs/user-manual.zh-CN.md)。
+
+### 在本地运行项目
+
+```bash
+git clone https://github.com/ioai-tech/lerobot-studio.git
+cd lerobot-studio
+npm ci
+npm run fixtures:generate
+npm run dev          # http://localhost:5173
+npm run build        # 生产包 → dist/
+```
+
+Docker：
+
+```bash
+docker build -t lerobot-studio .
+docker run --rm -p 8080:8080 lerobot-studio
+```
+
+---
+
+## 嵌入 React
+
+React 包尚未发布到 npm。其包名为 `@ioai/lerobot-studio`；在首次发布前，请使用独立应用或从本仓库构建。
+
+```bash
+npm install @ioai/lerobot-studio
+```
+
+> **环境要求：** `react` 和 `react-dom` `^19.0.0`、ES 模块和客户端渲染。不支持服务端渲染、React Server Components 和 Node.js。
+
+### 样式
+
+```tsx
+import '@ioai/lerobot-studio/style.css';
+```
+
+### 基本用法
+
+```tsx
+import { LeRobotViewer } from '@ioai/lerobot-studio';
+import '@ioai/lerobot-studio/style.css';
+
+export function App() {
+  return (
+    <div style={{ height: 720, minHeight: 480 }}>
+      <LeRobotViewer dataSource="https://example.com/dataset.zip" />
+    </div>
+  );
+}
+```
+
+外层容器需要有明确高度。查看器会填满父元素，不会自行决定页面高度。
+
+### Next.js（仅客户端）
+
+```tsx
+'use client';
+
+import dynamic from 'next/dynamic';
+
+const Viewer = dynamic(() => import('@ioai/lerobot-studio').then((m) => m.LeRobotViewer), {
+  ssr: false,
+});
+```
+
+更多集成示例：[嵌入指南](docs/embedding.zh-CN.md) · [API 参考](docs/api.zh-CN.md)。
+
+---
+
+## 支持的数据集
+
+| `codebase_version`             | 打开               | 说明                     |
+| ------------------------------ | ------------------ | ------------------------ |
+| `v2.1`                         | 可查看、编辑和导出 | 完全支持                 |
+| `v3.0`                         | 可查看、编辑和导出 | 完全支持                 |
+| 较新的 `v2` 或 `v3` minor 版本 | 仅查看             | 不支持编辑和导出         |
+| `v2.0`、其他主版本或缺失版本   | 不打开             | 应用不会猜测可兼容的版本 |
+
+归档：`.zip`、`.tar`、`.tar.gz`、`.tgz`。
+
+npm 包提供查看和会话内的 Episode 修改功能。导出引擎只在独立应用中提供。详见 [数据格式](docs/data-formats.zh-CN.md)。
+
+---
+
+## 参与贡献
+
+提交 Issue 或 Pull Request 前，请阅读 [CONTRIBUTING.zh-CN.md](CONTRIBUTING.zh-CN.md)。
+
+- Bug / 需求 → GitHub Issues
+- 安全问题 → [SECURITY.zh-CN.md](SECURITY.zh-CN.md)
+
+---
+
+## 许可证
+
+[MIT](LICENSE) © 2026 [IO-AI.TECH](https://io-ai.tech)
+
+第三方说明见 [NOTICE](NOTICE)。LeRobot Studio 是独立项目，与 Hugging Face 没有附属关系。