canvu-react 0.3.7 → 0.3.8

package/dist/react.d.cts

@@ -1,14 +1,157 @@
-import { V as VectorToolDefinition, C as CanvasPlugin, B as BoardComponentPosition } from './types-B_rv7p8b.cjs';
-export { a as CanvasPluginComponentProps, b as CanvasPluginContribution, c as CanvasPluginItemsChangeMiddlewareContext, d as CanvasPluginRenderContext, e as CanvuChromeActiveToolStyle, f as CanvuChromeContext, g as CanvuChromeContextValue, h as CanvuChromeSelectionStyleChange, i as CanvuPluginContext, j as CanvuPluginContextValue, k as CanvuPluginViewportSnapshot, l as CustomShapePlacementOptions, N as NavMenu, m as NavMenuProps, P as PlacementPreview, n as VectorCanvas, o as VectorCanvasBody, p as VectorCanvasHeader, q as VectorCanvasMain, r as VectorCanvasRoot, s as VectorCanvasSlotProps, t as VectorCanvasSpacePosition, u as VectorCanvasSpaceProps, v as VectorCanvasToolbar, w as VectorCanvasToolbarProps, x as VectorCanvasViewportSurface, y as VectorSelectionInspector, z as VectorSelectionInspectorProps, A as VectorViewport, D as VectorViewportHandle, E as VectorViewportProps, W as WorldPointerDownDetail, F as createCanvuPlugin, G as getBoardPositionStyle, H as useCanvuChromeContext, I as useCanvuDocumentContext, J as useCanvuPluginContext, K as useCanvuPluginContribution, L as useCanvuResolvedTools, M as useCanvuViewportContext } from './types-B_rv7p8b.cjs';
+import { V as VectorSceneItem } from './types-CB0TZZuk.cjs';
+import { V as VectorViewportAssetKind, a as VectorViewportAssetStore, b as VectorToolDefinition, C as CanvasPlugin, B as BoardComponentPosition } from './types-CW146bKP.cjs';
+export { c as CanvasPluginComponentProps, d as CanvasPluginContribution, e as CanvasPluginItemsChangeMiddlewareContext, f as CanvasPluginRenderContext, g as CanvuChromeActiveToolStyle, h as CanvuChromeContext, i as CanvuChromeContextValue, j as CanvuChromeSelectionStyleChange, k as CanvuPluginContext, l as CanvuPluginContextValue, m as CanvuPluginViewportSnapshot, n as CustomShapePlacementOptions, N as NavMenu, o as NavMenuProps, P as PlacementPreview, p as VectorCanvas, q as VectorCanvasBody, r as VectorCanvasHeader, s as VectorCanvasMain, t as VectorCanvasRoot, u as VectorCanvasSlotProps, v as VectorCanvasSpacePosition, w as VectorCanvasSpaceProps, x as VectorCanvasToolbar, y as VectorCanvasToolbarProps, z as VectorCanvasViewportSurface, A as VectorSelectionInspector, D as VectorSelectionInspectorProps, E as VectorViewport, F as VectorViewportAssetResolveRequest, G as VectorViewportAssetResolveResult, H as VectorViewportAssetUploadRequest, I as VectorViewportAssetUploadResult, J as VectorViewportHandle, K as VectorViewportProps, W as WorldPointerDownDetail, L as createCanvuPlugin, M as getBoardPositionStyle, O as useCanvuChromeContext, Q as useCanvuDocumentContext, R as useCanvuPluginContext, S as useCanvuPluginContribution, T as useCanvuResolvedTools, U as useCanvuViewportContext } from './types-CW146bKP.cjs';
 import { V as VectorCanvasPersistenceAdapter, a as VectorCanvasRemoteAdapter } from './types-B58i5k-u.cjs';
 export { b as VectorCanvasSnapshot } from './types-B58i5k-u.cjs';
-import { V as VectorSceneItem } from './types-CB0TZZuk.cjs';
 import * as react from 'react';
 import { SVGProps, CSSProperties, ReactNode } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import './camera-BwQjm5oh.cjs';
 import './shape-builders-DxPoOecg.cjs';
 
+declare class IndexedDbImageStore {
+    private dbPromise;
+    private getDb;
+    storeOriginal(blob: Blob): Promise<string>;
+    getOriginal(id: string): Promise<Blob | undefined>;
+    deleteOriginal(id: string): Promise<void>;
+    storeThumbnail(blob: Blob): Promise<string>;
+    getThumbnail(id: string): Promise<Blob | undefined>;
+    deleteThumbnail(id: string): Promise<void>;
+}
+
+/**
+ * Extra context for each item created by {@link ingestAssetFilesToSceneItems}.
+ *
+ * Use this when you need to lock imported pages, assign custom ids, or attach
+ * additional metadata beyond the `pluginData` returned by {@link VectorViewportAssetStore.upload}.
+ */
+type IngestedAssetItemContext = {
+    file: File;
+    kind: VectorViewportAssetKind;
+    itemIndex: number;
+    pageNumber?: number;
+};
+/**
+ * Structured error produced while ingesting a file into scene items.
+ *
+ * The helper keeps partial success by default: one file can fail without
+ * preventing the remaining files from being converted.
+ */
+type IngestAssetFileError = {
+    file: File;
+    kind?: VectorViewportAssetKind;
+    error: unknown;
+};
+/**
+ * Options for {@link ingestAssetFilesToSceneItems}.
+ *
+ * This is the shared ingestion pipeline used by canvu's built-in file flow.
+ * Use it when files originate outside the viewport, such as:
+ *
+ * - custom upload dialogs
+ * - board/version creation flows
+ * - programmatic imports
+ * - legacy migrations
+ *
+ * Prefer passing `assetStore` directly to `VectorViewport` when the user is
+ * already interacting with canvu's native file picker or drag-and-drop UI.
+ *
+ * @example
+ * ```ts
+ * const result = await ingestAssetFilesToSceneItems({
+ *   files: Array.from(input.files ?? []),
+ *   worldCenter: { x: 0, y: 0 },
+ *   assetStore,
+ *   decorateItem(item) {
+ *     return {
+ *       ...item,
+ *       locked: true,
+ *     };
+ *   },
+ * });
+ *
+ * doc.onItemsChange([...doc.items, ...result.items]);
+ * ```
+ */
+type IngestAssetFilesToSceneItemsOptions = {
+    files: readonly File[];
+    worldCenter: {
+        x: number;
+        y: number;
+    };
+    /**
+     * Optional binary persistence bridge shared with `VectorViewport`.
+     *
+     * When provided, `upload(...)` is called once per source file before canvu
+     * converts that file into one or more scene items.
+     */
+    assetStore?: VectorViewportAssetStore;
+    /**
+     * Optional local blob store used to keep canvu's default image/PDF runtime
+     * behavior consistent across reload-safe persistence adapters.
+     *
+     * Omit this unless you need to share an existing store instance.
+     */
+    imageStore?: IndexedDbImageStore;
+    /**
+     * Optional custom id factory for imported items.
+     *
+     * Defaults to `createShapeId()`.
+     */
+    createId?: () => string;
+    /**
+     * Vertical gap between stacked PDF pages.
+     *
+     * Defaults to `16`, matching the built-in viewport flow.
+     */
+    gapWorld?: number;
+    /**
+     * Offset step used when placing standalone raster images.
+     *
+     * Defaults to `48`, matching the built-in viewport flow.
+     */
+    stepWorld?: number;
+    /**
+     * PDF rasterization scale forwarded to `pdfjs-dist`.
+     *
+     * Defaults to `1.5` for crisp zoom while keeping payloads reasonable.
+     */
+    pdfScale?: number;
+    /**
+     * Final hook to customize each created item after canvu attaches its own
+     * image metadata and any `assetStore.upload(...)` `pluginData`.
+     */
+    decorateItem?: (item: VectorSceneItem, context: IngestedAssetItemContext) => VectorSceneItem;
+    /**
+     * Optional side-channel for per-file errors.
+     *
+     * This is useful for toasts or telemetry in addition to reading the returned
+     * `errors` array.
+     */
+    onError?: (error: IngestAssetFileError) => void;
+};
+/**
+ * Result of {@link ingestAssetFilesToSceneItems}.
+ */
+type IngestAssetFilesToSceneItemsResult = {
+    items: VectorSceneItem[];
+    errors: IngestAssetFileError[];
+};
+/**
+ * Converts browser files into `VectorSceneItem[]` using the same ingestion
+ * pipeline as canvu's built-in file flow.
+ *
+ * Use this for external imports that should behave like the native canvas
+ * upload experience without reimplementing PDF rasterization, image storage, or
+ * `pluginData` attachment in app code.
+ *
+ * Do not use this as a persistence layer by itself. It only produces runtime
+ * scene items. Persist the resulting snapshot with your existing
+ * `useVectorCanvasDocument(...)` adapter or another app-specific document store.
+ */
+declare function ingestAssetFilesToSceneItems(options: IngestAssetFilesToSceneItemsOptions): Promise<IngestAssetFilesToSceneItemsResult>;
+
 /**
  * Persistence adapter that stores the document JSON in IndexedDB and manages
  * image blobs separately. Images are stored at original resolution in a dedicated
@@ -267,4 +410,4 @@ type ViewportZoomControlsProps = {
  */
 declare function ViewportZoomControls({ zoomPercent, onZoomIn, onZoomOut, className, position, inset, zIndex, style, }: ViewportZoomControlsProps): react_jsx_runtime.JSX.Element;
 
-export { BoardComponentPosition, CanvasPlugin, type CreateLocalStoragePersistenceAdapterOptions, type CreateToolPluginOptions, DEFAULT_OVERFLOW_TOOL_IDS, DEFAULT_VECTOR_CANVAS_STORAGE_KEY, DEFAULT_VECTOR_TOOLS, IconArrow, IconDraw, IconEllipse, IconHand, IconImage, IconLaser, IconLine, IconRect, IconSelect, IconText, ShapeContextMenu, type ShapeContextMenuProps, type UseVectorCanvasDocumentOptions, type UseVectorCanvasDocumentResult, VectorCanvasPersistenceAdapter, VectorCanvasRemoteAdapter, VectorToolDefinition, VectorToolbar, type VectorToolbarProps, type VectorToolbarRenderContext, ViewportZoomControls, type ViewportZoomControlsProps, createIndexedDbPersistenceAdapter, createLocalStoragePersistenceAdapter, createNoopPersistenceAdapter, createToolPlugin, cursorForVectorToolId, useVectorCanvasDocument };
+export { BoardComponentPosition, CanvasPlugin, type CreateLocalStoragePersistenceAdapterOptions, type CreateToolPluginOptions, DEFAULT_OVERFLOW_TOOL_IDS, DEFAULT_VECTOR_CANVAS_STORAGE_KEY, DEFAULT_VECTOR_TOOLS, IconArrow, IconDraw, IconEllipse, IconHand, IconImage, IconLaser, IconLine, IconRect, IconSelect, IconText, type IngestAssetFileError, type IngestAssetFilesToSceneItemsOptions, type IngestAssetFilesToSceneItemsResult, type IngestedAssetItemContext, ShapeContextMenu, type ShapeContextMenuProps, type UseVectorCanvasDocumentOptions, type UseVectorCanvasDocumentResult, VectorCanvasPersistenceAdapter, VectorCanvasRemoteAdapter, VectorToolDefinition, VectorToolbar, type VectorToolbarProps, type VectorToolbarRenderContext, VectorViewportAssetKind, VectorViewportAssetStore, ViewportZoomControls, type ViewportZoomControlsProps, createIndexedDbPersistenceAdapter, createLocalStoragePersistenceAdapter, createNoopPersistenceAdapter, createToolPlugin, cursorForVectorToolId, ingestAssetFilesToSceneItems, useVectorCanvasDocument };

package/dist/react.d.ts

@@ -1,14 +1,157 @@
-import { V as VectorToolDefinition, C as CanvasPlugin, B as BoardComponentPosition } from './types-BCtWx3zP.js';
-export { a as CanvasPluginComponentProps, b as CanvasPluginContribution, c as CanvasPluginItemsChangeMiddlewareContext, d as CanvasPluginRenderContext, e as CanvuChromeActiveToolStyle, f as CanvuChromeContext, g as CanvuChromeContextValue, h as CanvuChromeSelectionStyleChange, i as CanvuPluginContext, j as CanvuPluginContextValue, k as CanvuPluginViewportSnapshot, l as CustomShapePlacementOptions, N as NavMenu, m as NavMenuProps, P as PlacementPreview, n as VectorCanvas, o as VectorCanvasBody, p as VectorCanvasHeader, q as VectorCanvasMain, r as VectorCanvasRoot, s as VectorCanvasSlotProps, t as VectorCanvasSpacePosition, u as VectorCanvasSpaceProps, v as VectorCanvasToolbar, w as VectorCanvasToolbarProps, x as VectorCanvasViewportSurface, y as VectorSelectionInspector, z as VectorSelectionInspectorProps, A as VectorViewport, D as VectorViewportHandle, E as VectorViewportProps, W as WorldPointerDownDetail, F as createCanvuPlugin, G as getBoardPositionStyle, H as useCanvuChromeContext, I as useCanvuDocumentContext, J as useCanvuPluginContext, K as useCanvuPluginContribution, L as useCanvuResolvedTools, M as useCanvuViewportContext } from './types-BCtWx3zP.js';
+import { V as VectorSceneItem } from './types-CB0TZZuk.js';
+import { V as VectorViewportAssetKind, a as VectorViewportAssetStore, b as VectorToolDefinition, C as CanvasPlugin, B as BoardComponentPosition } from './types-CpqlbbCP.js';
+export { c as CanvasPluginComponentProps, d as CanvasPluginContribution, e as CanvasPluginItemsChangeMiddlewareContext, f as CanvasPluginRenderContext, g as CanvuChromeActiveToolStyle, h as CanvuChromeContext, i as CanvuChromeContextValue, j as CanvuChromeSelectionStyleChange, k as CanvuPluginContext, l as CanvuPluginContextValue, m as CanvuPluginViewportSnapshot, n as CustomShapePlacementOptions, N as NavMenu, o as NavMenuProps, P as PlacementPreview, p as VectorCanvas, q as VectorCanvasBody, r as VectorCanvasHeader, s as VectorCanvasMain, t as VectorCanvasRoot, u as VectorCanvasSlotProps, v as VectorCanvasSpacePosition, w as VectorCanvasSpaceProps, x as VectorCanvasToolbar, y as VectorCanvasToolbarProps, z as VectorCanvasViewportSurface, A as VectorSelectionInspector, D as VectorSelectionInspectorProps, E as VectorViewport, F as VectorViewportAssetResolveRequest, G as VectorViewportAssetResolveResult, H as VectorViewportAssetUploadRequest, I as VectorViewportAssetUploadResult, J as VectorViewportHandle, K as VectorViewportProps, W as WorldPointerDownDetail, L as createCanvuPlugin, M as getBoardPositionStyle, O as useCanvuChromeContext, Q as useCanvuDocumentContext, R as useCanvuPluginContext, S as useCanvuPluginContribution, T as useCanvuResolvedTools, U as useCanvuViewportContext } from './types-CpqlbbCP.js';
 import { V as VectorCanvasPersistenceAdapter, a as VectorCanvasRemoteAdapter } from './types-DgEArHkA.js';
 export { b as VectorCanvasSnapshot } from './types-DgEArHkA.js';
-import { V as VectorSceneItem } from './types-CB0TZZuk.js';
 import * as react from 'react';
 import { SVGProps, CSSProperties, ReactNode } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import './camera-KwCYYPhm.js';
 import './shape-builders-DTYvub8W.js';
 
+declare class IndexedDbImageStore {
+    private dbPromise;
+    private getDb;
+    storeOriginal(blob: Blob): Promise<string>;
+    getOriginal(id: string): Promise<Blob | undefined>;
+    deleteOriginal(id: string): Promise<void>;
+    storeThumbnail(blob: Blob): Promise<string>;
+    getThumbnail(id: string): Promise<Blob | undefined>;
+    deleteThumbnail(id: string): Promise<void>;
+}
+
+/**
+ * Extra context for each item created by {@link ingestAssetFilesToSceneItems}.
+ *
+ * Use this when you need to lock imported pages, assign custom ids, or attach
+ * additional metadata beyond the `pluginData` returned by {@link VectorViewportAssetStore.upload}.
+ */
+type IngestedAssetItemContext = {
+    file: File;
+    kind: VectorViewportAssetKind;
+    itemIndex: number;
+    pageNumber?: number;
+};
+/**
+ * Structured error produced while ingesting a file into scene items.
+ *
+ * The helper keeps partial success by default: one file can fail without
+ * preventing the remaining files from being converted.
+ */
+type IngestAssetFileError = {
+    file: File;
+    kind?: VectorViewportAssetKind;
+    error: unknown;
+};
+/**
+ * Options for {@link ingestAssetFilesToSceneItems}.
+ *
+ * This is the shared ingestion pipeline used by canvu's built-in file flow.
+ * Use it when files originate outside the viewport, such as:
+ *
+ * - custom upload dialogs
+ * - board/version creation flows
+ * - programmatic imports
+ * - legacy migrations
+ *
+ * Prefer passing `assetStore` directly to `VectorViewport` when the user is
+ * already interacting with canvu's native file picker or drag-and-drop UI.
+ *
+ * @example
+ * ```ts
+ * const result = await ingestAssetFilesToSceneItems({
+ *   files: Array.from(input.files ?? []),
+ *   worldCenter: { x: 0, y: 0 },
+ *   assetStore,
+ *   decorateItem(item) {
+ *     return {
+ *       ...item,
+ *       locked: true,
+ *     };
+ *   },
+ * });
+ *
+ * doc.onItemsChange([...doc.items, ...result.items]);
+ * ```
+ */
+type IngestAssetFilesToSceneItemsOptions = {
+    files: readonly File[];
+    worldCenter: {
+        x: number;
+        y: number;
+    };
+    /**
+     * Optional binary persistence bridge shared with `VectorViewport`.
+     *
+     * When provided, `upload(...)` is called once per source file before canvu
+     * converts that file into one or more scene items.
+     */
+    assetStore?: VectorViewportAssetStore;
+    /**
+     * Optional local blob store used to keep canvu's default image/PDF runtime
+     * behavior consistent across reload-safe persistence adapters.
+     *
+     * Omit this unless you need to share an existing store instance.
+     */
+    imageStore?: IndexedDbImageStore;
+    /**
+     * Optional custom id factory for imported items.
+     *
+     * Defaults to `createShapeId()`.
+     */
+    createId?: () => string;
+    /**
+     * Vertical gap between stacked PDF pages.
+     *
+     * Defaults to `16`, matching the built-in viewport flow.
+     */
+    gapWorld?: number;
+    /**
+     * Offset step used when placing standalone raster images.
+     *
+     * Defaults to `48`, matching the built-in viewport flow.
+     */
+    stepWorld?: number;
+    /**
+     * PDF rasterization scale forwarded to `pdfjs-dist`.
+     *
+     * Defaults to `1.5` for crisp zoom while keeping payloads reasonable.
+     */
+    pdfScale?: number;
+    /**
+     * Final hook to customize each created item after canvu attaches its own
+     * image metadata and any `assetStore.upload(...)` `pluginData`.
+     */
+    decorateItem?: (item: VectorSceneItem, context: IngestedAssetItemContext) => VectorSceneItem;
+    /**
+     * Optional side-channel for per-file errors.
+     *
+     * This is useful for toasts or telemetry in addition to reading the returned
+     * `errors` array.
+     */
+    onError?: (error: IngestAssetFileError) => void;
+};
+/**
+ * Result of {@link ingestAssetFilesToSceneItems}.
+ */
+type IngestAssetFilesToSceneItemsResult = {
+    items: VectorSceneItem[];
+    errors: IngestAssetFileError[];
+};
+/**
+ * Converts browser files into `VectorSceneItem[]` using the same ingestion
+ * pipeline as canvu's built-in file flow.
+ *
+ * Use this for external imports that should behave like the native canvas
+ * upload experience without reimplementing PDF rasterization, image storage, or
+ * `pluginData` attachment in app code.
+ *
+ * Do not use this as a persistence layer by itself. It only produces runtime
+ * scene items. Persist the resulting snapshot with your existing
+ * `useVectorCanvasDocument(...)` adapter or another app-specific document store.
+ */
+declare function ingestAssetFilesToSceneItems(options: IngestAssetFilesToSceneItemsOptions): Promise<IngestAssetFilesToSceneItemsResult>;
+
 /**
  * Persistence adapter that stores the document JSON in IndexedDB and manages
  * image blobs separately. Images are stored at original resolution in a dedicated
@@ -267,4 +410,4 @@ type ViewportZoomControlsProps = {
  */
 declare function ViewportZoomControls({ zoomPercent, onZoomIn, onZoomOut, className, position, inset, zIndex, style, }: ViewportZoomControlsProps): react_jsx_runtime.JSX.Element;
 
-export { BoardComponentPosition, CanvasPlugin, type CreateLocalStoragePersistenceAdapterOptions, type CreateToolPluginOptions, DEFAULT_OVERFLOW_TOOL_IDS, DEFAULT_VECTOR_CANVAS_STORAGE_KEY, DEFAULT_VECTOR_TOOLS, IconArrow, IconDraw, IconEllipse, IconHand, IconImage, IconLaser, IconLine, IconRect, IconSelect, IconText, ShapeContextMenu, type ShapeContextMenuProps, type UseVectorCanvasDocumentOptions, type UseVectorCanvasDocumentResult, VectorCanvasPersistenceAdapter, VectorCanvasRemoteAdapter, VectorToolDefinition, VectorToolbar, type VectorToolbarProps, type VectorToolbarRenderContext, ViewportZoomControls, type ViewportZoomControlsProps, createIndexedDbPersistenceAdapter, createLocalStoragePersistenceAdapter, createNoopPersistenceAdapter, createToolPlugin, cursorForVectorToolId, useVectorCanvasDocument };
+export { BoardComponentPosition, CanvasPlugin, type CreateLocalStoragePersistenceAdapterOptions, type CreateToolPluginOptions, DEFAULT_OVERFLOW_TOOL_IDS, DEFAULT_VECTOR_CANVAS_STORAGE_KEY, DEFAULT_VECTOR_TOOLS, IconArrow, IconDraw, IconEllipse, IconHand, IconImage, IconLaser, IconLine, IconRect, IconSelect, IconText, type IngestAssetFileError, type IngestAssetFilesToSceneItemsOptions, type IngestAssetFilesToSceneItemsResult, type IngestedAssetItemContext, ShapeContextMenu, type ShapeContextMenuProps, type UseVectorCanvasDocumentOptions, type UseVectorCanvasDocumentResult, VectorCanvasPersistenceAdapter, VectorCanvasRemoteAdapter, VectorToolDefinition, VectorToolbar, type VectorToolbarProps, type VectorToolbarRenderContext, VectorViewportAssetKind, VectorViewportAssetStore, ViewportZoomControls, type ViewportZoomControlsProps, createIndexedDbPersistenceAdapter, createLocalStoragePersistenceAdapter, createNoopPersistenceAdapter, createToolPlugin, cursorForVectorToolId, ingestAssetFilesToSceneItems, useVectorCanvasDocument };