@xom11/whiteboard 0.6.5 → 0.9.1

package/README.md

@@ -14,7 +14,33 @@ npm install github:xom11/whiteboard#v0.2.0
 "@xom11/whiteboard": "github:xom11/whiteboard#v0.2.0"
 ```
 
-Peer deps: `react >=18`, `react-dom >=18`, `next >=14`.
+### Peer dependencies
+
+Từ phiên bản này, `@excalidraw/excalidraw`, `jsxgraph` và `katex` được externalize khỏi bundle (giảm bundle ~70%). Consumer **bắt buộc** cài kèm:
+
+```bash
+npm install @excalidraw/excalidraw@^0.18.1 jsxgraph@^1.12.2 katex@^0.16.45 react@>=18 react-dom@>=18
+```
+
+Hoặc thêm vào `package.json` của consumer:
+
+```json
+{
+  "dependencies": {
+    "@excalidraw/excalidraw": "^0.18.1",
+    "jsxgraph": "^1.12.2",
+    "katex": "^0.16.45",
+    "react": ">=18",
+    "react-dom": ">=18"
+  }
+}
+```
+
+Lý do externalize:
+
+- **Tránh duplicate React** khi consumer cũng dùng Excalidraw trực tiếp.
+- **Bundle nhẹ hơn ~70%** (jsxgraph ~600KB + katex ~280KB + excalidraw ~2MB không còn nằm trong dist của whiteboard).
+- **Consumer kiểm soát version** + dedupe qua npm/pnpm tự nhiên.
 
 ## Usage
 
@@ -35,6 +61,55 @@ export function ClassroomBoard() {
 }
 ```
 
+## Migration to v0.8.0 (geometry-3d redesign)
+
+`geometry3dStamp` được viết lại theo UX của GeoGebra 3D Calculator:
+
+- Click trên mặt nền / trục / mặt phẳng / mặt cầu để **đặt điểm constraint** (không còn prompt nhập toạ độ).
+- **Drag điểm** trên Move tool — điểm trượt theo surface (z-axis chỉ thay đổi z, mặt nền giữ z=0).
+- **Algebra panel** mới (tab bên trái) hiển thị mỗi object: label, biểu thức symbolic, giá trị numeric, menu ⋮ (đổi tên / màu / ẩn / xoá).
+- 16 tool: Move, Point, Point-on-Object, Segment, Line, Ray, Vector, Polygon, Plane (3 điểm), Pyramid, Prism, Tetrahedron, Cube, Sphere, Cylinder, Cone.
+
+**Backward compat**: Stamps lưu từ v0.7.0 load OK (legacy points → constraint free). API consumer giữ nguyên.
+
+**Tạm thời bỏ**: Chord-shortcut 2 phím (`G S` cho segment, v.v.) — sẽ trở lại với letter-mapping mới.
+
+## Migration to v0.7.0 (BREAKING)
+
+`DEFAULT_STAMPS` v0.7.0 chỉ gồm 2 stamps stable: `geometry` + `latex`. 3D + graph2d chuyển sang opt-IN (experimental).
+
+### Giữ behavior cũ (4 stamps):
+
+```tsx
+import { Whiteboard, ALL_STAMPS } from '@xom11/whiteboard';
+
+<Whiteboard stamps={ALL_STAMPS} />
+```
+
+### Chỉ thêm 3D (giữ default + 3D):
+
+```tsx
+import { Whiteboard, DEFAULT_STAMPS, geometry3dStamp } from '@xom11/whiteboard';
+
+<Whiteboard stamps={[...DEFAULT_STAMPS, geometry3dStamp]} />
+```
+
+### Subpath imports (tree-shake):
+
+Mỗi stamp có thể import riêng để bundle nhẹ hơn:
+
+```tsx
+import { Whiteboard } from '@xom11/whiteboard';
+import { geometryStamp } from '@xom11/whiteboard/geometry-2d';
+import { latexStamp } from '@xom11/whiteboard/latex';
+
+<Whiteboard stamps={[geometryStamp, latexStamp]} />
+```
+
+### Drop Next.js peer dep
+
+`next` không còn là peer dependency. Whiteboard dùng `React.lazy + Suspense` thuần. Consumer cần Next.js App Router vẫn hoạt động (dist có sẵn `'use client'` directive).
+
 ## Development
 
 ```bash
@@ -44,6 +119,17 @@ npm run build      # tsup → dist/{index.js, index.mjs, index.d.ts}
 npm run dev        # tsup watch mode
 ```
 
+## E2E tests
+
+Playwright smoke tests chạy qua headless Chromium, tự start vite demo:
+
+```bash
+npx playwright install chromium    # cài browser binary (chỉ làm 1 lần)
+npm run test:e2e                   # chạy specs
+```
+
+Chi tiết xem [`tests/e2e/README.md`](./tests/e2e/README.md).
+
 ## Workflow phát hành phiên bản mới
 
 `npm ci --ignore-scripts` ở consumer skip prepare hook → phải commit `dist/`: