@xom11/whiteboard 0.9.1 → 0.10.0

package/dist/index.d.mts

@@ -13,6 +13,7 @@ import { Geometry3DCustomData } from './geometry-3d.mjs';
 export { geometry3dStamp, isGeometry3DCustomData } from './geometry-3d.mjs';
 import { Graph2DCustomData } from './graph-2d.mjs';
 export { graph2dStamp, isGraph2DCustomData } from './graph-2d.mjs';
+import { PDFDocumentProxy } from 'pdfjs-dist';
 import 'react';
 
 interface SyncableAppState {
@@ -107,4 +108,129 @@ declare function restoreMissingStampFiles(api: any, elements: readonly ElementLi
 
 type StampCustomData = GeometryCustomData | LatexCustomData | Geometry3DCustomData | Graph2DCustomData;
 
-export { ALL_STAMPS, DEFAULT_STAMPS, EXPERIMENTAL_STAMPS, type ExcalidrawSceneSnapshot, Geometry3DCustomData, GeometryCustomData, Graph2DCustomData, LatexCustomData, STABLE_STAMPS, type StampCustomData, StampType, type SyncableAppState, Whiteboard, type WhiteboardProps, findStampForCustomData, isStampElement, pickSyncableAppState, restoreMissingStampFiles };
+/**
+ * Rasterize PDF → PNG dataURLs cho từng trang.
+ *
+ * Worker config:
+ *   - pdfjs-dist 5.x cần `GlobalWorkerOptions.workerSrc` (URL tới worker .mjs).
+ *   - Mặc định trỏ CDN (jsdelivr). Consumer có thể override qua
+ *     `configurePdfWorker(src)` trước khi gọi rasterize lần đầu.
+ *   - Lý do CDN thay vì bundled worker: tsup không có cách clean để emit
+ *     worker chunk ra cùng dist/ với URL ổn định, và consumer (Next.js)
+ *     có thể self-host nếu cần offline.
+ *
+ * Lazy import pdfjs-dist để không phình bundle khi user không dùng PDF.
+ */
+
+/**
+ * Override workerSrc trước khi rasterize. Gọi từ consumer khi cần self-host
+ * worker file (vd offline mode, CSP cấm CDN).
+ *
+ * Mặc định nếu không gọi: dùng CDN jsdelivr theo version pdfjs-dist đã cài.
+ */
+declare function configurePdfWorker(workerSrc: string): void;
+interface RasterizedPage {
+    pageNumber: number;
+    dataURL: string;
+    width: number;
+    height: number;
+    mimeType: 'image/png';
+}
+interface RasterizeOptions {
+    /** Scale render. Mặc định 2 (HiDPI sharp). */
+    scale?: number;
+    /** Danh sách trang 1-based. Mặc định: tất cả. */
+    pages?: number[];
+    /** Callback progress sau mỗi page. */
+    onProgress?: (done: number, total: number) => void;
+    /** AbortSignal để cancel giữa chừng. */
+    signal?: AbortSignal;
+}
+/**
+ * Load PDF chỉ để lấy `numPages` (vd hiển thị tổng số trang trên dialog).
+ * Caller phải tự đóng document bằng `closePdfDocument(doc)` khi xong.
+ */
+declare function loadPdfDocument(source: File | Blob | ArrayBuffer): Promise<PDFDocumentProxy>;
+declare function closePdfDocument(doc: PDFDocumentProxy): Promise<void>;
+/**
+ * Render danh sách trang ra PNG dataURL.
+ *
+ * Lưu ý:
+ *   - Sử dụng `OffscreenCanvas` nếu có (browser hiện đại) để không touch DOM,
+ *     fallback `<canvas>` document.createElement.
+ *   - Mỗi page render xong sẽ release canvas (cho GC sớm với PDF nhiều trang).
+ */
+declare function rasterizePdf(doc: PDFDocumentProxy, options?: RasterizeOptions): Promise<RasterizedPage[]>;
+
+type ExApi = any;
+interface InsertRasterizedPagesOptions {
+    /** Scale dùng khi rasterize (để chia pixel → scene units). */
+    scale: number;
+    /** Toạ độ scene gốc cho page đầu tiên. Bỏ qua → giữa viewport. */
+    origin?: {
+        x: number;
+        y: number;
+    };
+}
+interface InsertRasterizedPagesResult {
+    insertedElementIds: string[];
+    fileIds: string[];
+}
+/**
+ * Chèn array `RasterizedPage` đã có sẵn vào scene. Tách ra để Whiteboard
+ * có thể: load doc → hỏi user range → rasterize → insert mà không phải gọi
+ * insertPdfPages (load lại từ ArrayBuffer 2 lần).
+ */
+declare function insertRasterizedPagesIntoScene(api: ExApi, rendered: RasterizedPage[], options: InsertRasterizedPagesOptions): InsertRasterizedPagesResult;
+interface InsertPdfPagesOptions {
+    /** Trang cần chèn (1-based). Bỏ qua → chèn tất cả. */
+    pages?: number[];
+    /** Scale rasterize. Mặc định 2. */
+    scale?: number;
+    /** Toạ độ scene gốc cho page đầu tiên. Bỏ qua → giữa viewport. */
+    origin?: {
+        x: number;
+        y: number;
+    };
+    /** Progress callback. */
+    onProgress?: (done: number, total: number) => void;
+    /** AbortSignal. */
+    signal?: AbortSignal;
+}
+interface InsertPdfPagesResult {
+    insertedElementIds: string[];
+    pages: RasterizedPage[];
+}
+/**
+ * High-level: rasterize PDF + insert thành nhiều image element xếp dọc.
+ *
+ * Flow:
+ *   1. loadPdfDocument(source) → PDFDocumentProxy
+ *   2. rasterizePdf(doc, {pages, scale}) → RasterizedPage[]
+ *   3. Tạo fileId cho từng page, gọi api.addFiles batch.
+ *   4. Tính position: page 1 trung tâm viewport (hoặc origin), các page sau
+ *      xếp dưới, cách PAGE_GAP.
+ *   5. api.updateScene({ elements: [...cũ, ...mới] })
+ *
+ * Không serialize PDF bytes — sau insert, các page là image element thuần,
+ * không thể re-edit qua double-click (theo design quyết định).
+ */
+declare function insertPdfPages(api: ExApi, source: File | Blob | ArrayBuffer, options?: InsertPdfPagesOptions): Promise<InsertPdfPagesResult>;
+
+/**
+ * Parse chuỗi range trang dạng "1,3,5-10" → array số 1-based đã sort + dedupe.
+ *
+ * - Tokens cách nhau bằng dấu phẩy hoặc khoảng trắng.
+ * - Token có gạch "-" → range inclusive (5-10 = [5,6,7,8,9,10]).
+ * - Khoảng trắng quanh số bị bỏ qua.
+ * - Empty / chỉ space → [].
+ *
+ * Throws `Error` với message tiếng Việt khi:
+ *   - Token không phải số / không phải range hợp lệ.
+ *   - Số <= 0 hoặc > totalPages.
+ *   - Range đảo ngược (vd "10-5") — coi là lỗi user thay vì auto-reverse để
+ *     tránh nuốt typo.
+ */
+declare function parsePageRange(input: string, totalPages: number): number[];
+
+export { ALL_STAMPS, DEFAULT_STAMPS, EXPERIMENTAL_STAMPS, type ExcalidrawSceneSnapshot, Geometry3DCustomData, GeometryCustomData, Graph2DCustomData, type InsertPdfPagesOptions, type InsertPdfPagesResult, type InsertRasterizedPagesOptions, type InsertRasterizedPagesResult, LatexCustomData, type RasterizeOptions, type RasterizedPage, STABLE_STAMPS, type StampCustomData, StampType, type SyncableAppState, Whiteboard, type WhiteboardProps, closePdfDocument, configurePdfWorker, findStampForCustomData, insertPdfPages, insertRasterizedPagesIntoScene, isStampElement, loadPdfDocument, parsePageRange, pickSyncableAppState, rasterizePdf, restoreMissingStampFiles };

package/dist/index.d.ts

@@ -13,6 +13,7 @@ import { Geometry3DCustomData } from './geometry-3d.js';
 export { geometry3dStamp, isGeometry3DCustomData } from './geometry-3d.js';
 import { Graph2DCustomData } from './graph-2d.js';
 export { graph2dStamp, isGraph2DCustomData } from './graph-2d.js';
+import { PDFDocumentProxy } from 'pdfjs-dist';
 import 'react';
 
 interface SyncableAppState {
@@ -107,4 +108,129 @@ declare function restoreMissingStampFiles(api: any, elements: readonly ElementLi
 
 type StampCustomData = GeometryCustomData | LatexCustomData | Geometry3DCustomData | Graph2DCustomData;
 
-export { ALL_STAMPS, DEFAULT_STAMPS, EXPERIMENTAL_STAMPS, type ExcalidrawSceneSnapshot, Geometry3DCustomData, GeometryCustomData, Graph2DCustomData, LatexCustomData, STABLE_STAMPS, type StampCustomData, StampType, type SyncableAppState, Whiteboard, type WhiteboardProps, findStampForCustomData, isStampElement, pickSyncableAppState, restoreMissingStampFiles };
+/**
+ * Rasterize PDF → PNG dataURLs cho từng trang.
+ *
+ * Worker config:
+ *   - pdfjs-dist 5.x cần `GlobalWorkerOptions.workerSrc` (URL tới worker .mjs).
+ *   - Mặc định trỏ CDN (jsdelivr). Consumer có thể override qua
+ *     `configurePdfWorker(src)` trước khi gọi rasterize lần đầu.
+ *   - Lý do CDN thay vì bundled worker: tsup không có cách clean để emit
+ *     worker chunk ra cùng dist/ với URL ổn định, và consumer (Next.js)
+ *     có thể self-host nếu cần offline.
+ *
+ * Lazy import pdfjs-dist để không phình bundle khi user không dùng PDF.
+ */
+
+/**
+ * Override workerSrc trước khi rasterize. Gọi từ consumer khi cần self-host
+ * worker file (vd offline mode, CSP cấm CDN).
+ *
+ * Mặc định nếu không gọi: dùng CDN jsdelivr theo version pdfjs-dist đã cài.
+ */
+declare function configurePdfWorker(workerSrc: string): void;
+interface RasterizedPage {
+    pageNumber: number;
+    dataURL: string;
+    width: number;
+    height: number;
+    mimeType: 'image/png';
+}
+interface RasterizeOptions {
+    /** Scale render. Mặc định 2 (HiDPI sharp). */
+    scale?: number;
+    /** Danh sách trang 1-based. Mặc định: tất cả. */
+    pages?: number[];
+    /** Callback progress sau mỗi page. */
+    onProgress?: (done: number, total: number) => void;
+    /** AbortSignal để cancel giữa chừng. */
+    signal?: AbortSignal;
+}
+/**
+ * Load PDF chỉ để lấy `numPages` (vd hiển thị tổng số trang trên dialog).
+ * Caller phải tự đóng document bằng `closePdfDocument(doc)` khi xong.
+ */
+declare function loadPdfDocument(source: File | Blob | ArrayBuffer): Promise<PDFDocumentProxy>;
+declare function closePdfDocument(doc: PDFDocumentProxy): Promise<void>;
+/**
+ * Render danh sách trang ra PNG dataURL.
+ *
+ * Lưu ý:
+ *   - Sử dụng `OffscreenCanvas` nếu có (browser hiện đại) để không touch DOM,
+ *     fallback `<canvas>` document.createElement.
+ *   - Mỗi page render xong sẽ release canvas (cho GC sớm với PDF nhiều trang).
+ */
+declare function rasterizePdf(doc: PDFDocumentProxy, options?: RasterizeOptions): Promise<RasterizedPage[]>;
+
+type ExApi = any;
+interface InsertRasterizedPagesOptions {
+    /** Scale dùng khi rasterize (để chia pixel → scene units). */
+    scale: number;
+    /** Toạ độ scene gốc cho page đầu tiên. Bỏ qua → giữa viewport. */
+    origin?: {
+        x: number;
+        y: number;
+    };
+}
+interface InsertRasterizedPagesResult {
+    insertedElementIds: string[];
+    fileIds: string[];
+}
+/**
+ * Chèn array `RasterizedPage` đã có sẵn vào scene. Tách ra để Whiteboard
+ * có thể: load doc → hỏi user range → rasterize → insert mà không phải gọi
+ * insertPdfPages (load lại từ ArrayBuffer 2 lần).
+ */
+declare function insertRasterizedPagesIntoScene(api: ExApi, rendered: RasterizedPage[], options: InsertRasterizedPagesOptions): InsertRasterizedPagesResult;
+interface InsertPdfPagesOptions {
+    /** Trang cần chèn (1-based). Bỏ qua → chèn tất cả. */
+    pages?: number[];
+    /** Scale rasterize. Mặc định 2. */
+    scale?: number;
+    /** Toạ độ scene gốc cho page đầu tiên. Bỏ qua → giữa viewport. */
+    origin?: {
+        x: number;
+        y: number;
+    };
+    /** Progress callback. */
+    onProgress?: (done: number, total: number) => void;
+    /** AbortSignal. */
+    signal?: AbortSignal;
+}
+interface InsertPdfPagesResult {
+    insertedElementIds: string[];
+    pages: RasterizedPage[];
+}
+/**
+ * High-level: rasterize PDF + insert thành nhiều image element xếp dọc.
+ *
+ * Flow:
+ *   1. loadPdfDocument(source) → PDFDocumentProxy
+ *   2. rasterizePdf(doc, {pages, scale}) → RasterizedPage[]
+ *   3. Tạo fileId cho từng page, gọi api.addFiles batch.
+ *   4. Tính position: page 1 trung tâm viewport (hoặc origin), các page sau
+ *      xếp dưới, cách PAGE_GAP.
+ *   5. api.updateScene({ elements: [...cũ, ...mới] })
+ *
+ * Không serialize PDF bytes — sau insert, các page là image element thuần,
+ * không thể re-edit qua double-click (theo design quyết định).
+ */
+declare function insertPdfPages(api: ExApi, source: File | Blob | ArrayBuffer, options?: InsertPdfPagesOptions): Promise<InsertPdfPagesResult>;
+
+/**
+ * Parse chuỗi range trang dạng "1,3,5-10" → array số 1-based đã sort + dedupe.
+ *
+ * - Tokens cách nhau bằng dấu phẩy hoặc khoảng trắng.
+ * - Token có gạch "-" → range inclusive (5-10 = [5,6,7,8,9,10]).
+ * - Khoảng trắng quanh số bị bỏ qua.
+ * - Empty / chỉ space → [].
+ *
+ * Throws `Error` với message tiếng Việt khi:
+ *   - Token không phải số / không phải range hợp lệ.
+ *   - Số <= 0 hoặc > totalPages.
+ *   - Range đảo ngược (vd "10-5") — coi là lỗi user thay vì auto-reverse để
+ *     tránh nuốt typo.
+ */
+declare function parsePageRange(input: string, totalPages: number): number[];
+
+export { ALL_STAMPS, DEFAULT_STAMPS, EXPERIMENTAL_STAMPS, type ExcalidrawSceneSnapshot, Geometry3DCustomData, GeometryCustomData, Graph2DCustomData, type InsertPdfPagesOptions, type InsertPdfPagesResult, type InsertRasterizedPagesOptions, type InsertRasterizedPagesResult, LatexCustomData, type RasterizeOptions, type RasterizedPage, STABLE_STAMPS, type StampCustomData, StampType, type SyncableAppState, Whiteboard, type WhiteboardProps, closePdfDocument, configurePdfWorker, findStampForCustomData, insertPdfPages, insertRasterizedPagesIntoScene, isStampElement, loadPdfDocument, parsePageRange, pickSyncableAppState, rasterizePdf, restoreMissingStampFiles };