canvu-react 0.3.7 → 0.3.8

package/dist/{types-B_rv7p8b.d.cts → types-CW146bKP.d.cts}

@@ -5,6 +5,109 @@ import { C as Camera2D } from './camera-BwQjm5oh.cjs';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { S as StrokeStyle } from './shape-builders-DxPoOecg.cjs';
 
+/**
+ * Kind of binary selected through the built-in canvu asset ingestion flow.
+ *
+ * Use this to branch your backend upload logic when images and PDFs should be
+ * stored differently.
+ */
+type VectorViewportAssetKind = "image" | "pdf";
+/**
+ * Original browser `File` intercepted from the built-in asset flow.
+ *
+ * This is the high-level hook for apps that want canvu to keep its native file
+ * UX while still uploading the raw binary to their backend or object storage.
+ *
+ * The same request shape is also reused by
+ * {@link ingestAssetFilesToSceneItems}, so custom import flows and the native
+ * viewport UX can share one backend contract.
+ */
+type VectorViewportAssetUploadRequest = {
+    /** Original browser file before canvu converts it into scene items. */
+    file: File;
+    /** High-level bucket for routing image vs PDF upload behavior. */
+    kind: VectorViewportAssetKind;
+};
+/**
+ * Persisted metadata returned by a custom asset upload.
+ *
+ * The returned `pluginData` is shallow-merged into every `VectorSceneItem`
+ * created from the uploaded file, making it available to custom persistence
+ * adapters and later hydration flows.
+ *
+ * @example
+ * ```ts
+ * const assetStore: VectorViewportAssetStore = {
+ *   async upload({ file, kind }) {
+ *     const form = new FormData();
+ *     form.append("file", file);
+ *     form.append("kind", kind);
+ *
+ *     const response = await fetch("/api/canvu/assets", {
+ *       method: "POST",
+ *       body: form,
+ *     });
+ *
+ *     const asset = await response.json();
+ *     return {
+ *       pluginData: {
+ *         assetId: asset.id,
+ *         assetKey: asset.key,
+ *         mimeType: file.type,
+ *       },
+ *     };
+ *   },
+ *   async resolve({ assetIds }) {
+ *     const response = await fetch("/api/canvu/assets/resolve", {
+ *       method: "POST",
+ *       headers: { "content-type": "application/json" },
+ *       body: JSON.stringify({ assetIds }),
+ *     });
+ *
+ *     return response.json();
+ *   },
+ * };
+ * ```
+ */
+type VectorViewportAssetUploadResult = {
+    /**
+     * Opaque persisted metadata attached to created items.
+     *
+     * Use this for asset ids, bucket keys, original file names, or any backend
+     * reference needed to rehydrate the binary later from your own persistence
+     * adapter.
+     */
+    pluginData?: VectorSceneItem["pluginData"];
+};
+/**
+ * Request to resolve persisted asset ids back into runtime URLs.
+ *
+ * This is useful inside custom persistence adapters when you want to rehydrate
+ * signed URLs or CDN URLs after loading a snapshot.
+ */
+type VectorViewportAssetResolveRequest = {
+    assetIds: string[];
+};
+/**
+ * Runtime URL payload returned by a custom asset resolver.
+ */
+type VectorViewportAssetResolveResult = Record<string, {
+    url: string;
+    thumbnailUrl?: string;
+}>;
+/**
+ * High-level hook for apps that want to persist raw binaries out-of-band while
+ * keeping canvu's built-in file UX.
+ *
+ * `upload` is used by the built-in file picker / drag-and-drop flow and by
+ * {@link ingestAssetFilesToSceneItems}. `resolve` is optional for custom
+ * persistence adapters and future hydration flows.
+ */
+type VectorViewportAssetStore = {
+    upload: (request: VectorViewportAssetUploadRequest) => Promise<VectorViewportAssetUploadResult | undefined>;
+    resolve?: (request: VectorViewportAssetResolveRequest) => Promise<VectorViewportAssetResolveResult>;
+};
+
 type CanvuChromeActiveToolStyle = StrokeStyle & {
     toolKind: "draw" | "marker";
     label?: string;
@@ -425,6 +528,19 @@ type VectorViewportProps = {
      * placement is resolved by the current `toolId`.
      */
     customPlacements?: readonly CustomShapePlacementOptions[];
+    /**
+     * Optional asset persistence bridge for the built-in image/file flow.
+     *
+     * Use this when you want canvu to keep its native file picker and drag-and-drop
+     * behavior, while also uploading the original binary to your backend or bucket.
+     * Returned `pluginData` is persisted on every created item from that file.
+     *
+     * This is a high-level persistence hook. For fully custom ingestion UIs or
+     * imports that start outside the viewport, prefer
+     * `ingestAssetFilesToSceneItems(...)` so your app reuses the same pipeline as
+     * canvu's native file tool.
+     */
+    assetStore?: VectorViewportAssetStore;
     /**
      * When false (default), finishing a draw/place/erase gesture requests switching back to `autoResetToolTo`.
      * Use with controlled tool state (`onToolChangeRequest`) to keep "select-after-use" behavior.
@@ -572,4 +688,4 @@ declare function useCanvuResolvedTools(): VectorToolDefinition[];
  */
 declare function useCanvuPluginContribution(pluginId: string, contribution: CanvasPluginContribution): void;
 
-export { VectorViewport as A, type BoardComponentPosition as B, type CanvasPlugin as C, type VectorViewportHandle as D, type VectorViewportProps as E, createCanvuPlugin as F, getBoardPositionStyle as G, useCanvuChromeContext as H, useCanvuDocumentContext as I, useCanvuPluginContext as J, useCanvuPluginContribution as K, useCanvuResolvedTools as L, useCanvuViewportContext as M, NavMenu as N, type RemotePresencePeer as O, type PlacementPreview as P, type RealtimeConnectionState as Q, type RemotePresenceMarkupStroke as R, type PresenceOverlayRenderContext as S, type VectorToolDefinition as V, type WorldPointerDownDetail as W, type CanvasPluginComponentProps as a, type CanvasPluginContribution as b, type CanvasPluginItemsChangeMiddlewareContext as c, type CanvasPluginRenderContext as d, type CanvuChromeActiveToolStyle as e, CanvuChromeContext as f, type CanvuChromeContextValue as g, type CanvuChromeSelectionStyleChange as h, CanvuPluginContext as i, type CanvuPluginContextValue as j, type CanvuPluginViewportSnapshot as k, type CustomShapePlacementOptions as l, type NavMenuProps as m, VectorCanvas as n, VectorCanvasBody as o, VectorCanvasHeader as p, VectorCanvasMain as q, VectorCanvasRoot as r, type VectorCanvasSlotProps as s, type VectorCanvasSpacePosition as t, type VectorCanvasSpaceProps as u, VectorCanvasToolbar as v, type VectorCanvasToolbarProps as w, VectorCanvasViewportSurface as x, VectorSelectionInspector as y, type VectorSelectionInspectorProps as z };
+export { VectorSelectionInspector as A, type BoardComponentPosition as B, type CanvasPlugin as C, type VectorSelectionInspectorProps as D, VectorViewport as E, type VectorViewportAssetResolveRequest as F, type VectorViewportAssetResolveResult as G, type VectorViewportAssetUploadRequest as H, type VectorViewportAssetUploadResult as I, type VectorViewportHandle as J, type VectorViewportProps as K, createCanvuPlugin as L, getBoardPositionStyle as M, NavMenu as N, useCanvuChromeContext as O, type PlacementPreview as P, useCanvuDocumentContext as Q, useCanvuPluginContext as R, useCanvuPluginContribution as S, useCanvuResolvedTools as T, useCanvuViewportContext as U, type VectorViewportAssetKind as V, type WorldPointerDownDetail as W, type RemotePresenceMarkupStroke as X, type RemotePresencePeer as Y, type RealtimeConnectionState as Z, type PresenceOverlayRenderContext as _, type VectorViewportAssetStore as a, type VectorToolDefinition as b, type CanvasPluginComponentProps as c, type CanvasPluginContribution as d, type CanvasPluginItemsChangeMiddlewareContext as e, type CanvasPluginRenderContext as f, type CanvuChromeActiveToolStyle as g, CanvuChromeContext as h, type CanvuChromeContextValue as i, type CanvuChromeSelectionStyleChange as j, CanvuPluginContext as k, type CanvuPluginContextValue as l, type CanvuPluginViewportSnapshot as m, type CustomShapePlacementOptions as n, type NavMenuProps as o, VectorCanvas as p, VectorCanvasBody as q, VectorCanvasHeader as r, VectorCanvasMain as s, VectorCanvasRoot as t, type VectorCanvasSlotProps as u, type VectorCanvasSpacePosition as v, type VectorCanvasSpaceProps as w, VectorCanvasToolbar as x, type VectorCanvasToolbarProps as y, VectorCanvasViewportSurface as z };

package/dist/{types-BCtWx3zP.d.ts → types-CpqlbbCP.d.ts}

@@ -5,6 +5,109 @@ import { C as Camera2D } from './camera-KwCYYPhm.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { S as StrokeStyle } from './shape-builders-DTYvub8W.js';
 
+/**
+ * Kind of binary selected through the built-in canvu asset ingestion flow.
+ *
+ * Use this to branch your backend upload logic when images and PDFs should be
+ * stored differently.
+ */
+type VectorViewportAssetKind = "image" | "pdf";
+/**
+ * Original browser `File` intercepted from the built-in asset flow.
+ *
+ * This is the high-level hook for apps that want canvu to keep its native file
+ * UX while still uploading the raw binary to their backend or object storage.
+ *
+ * The same request shape is also reused by
+ * {@link ingestAssetFilesToSceneItems}, so custom import flows and the native
+ * viewport UX can share one backend contract.
+ */
+type VectorViewportAssetUploadRequest = {
+    /** Original browser file before canvu converts it into scene items. */
+    file: File;
+    /** High-level bucket for routing image vs PDF upload behavior. */
+    kind: VectorViewportAssetKind;
+};
+/**
+ * Persisted metadata returned by a custom asset upload.
+ *
+ * The returned `pluginData` is shallow-merged into every `VectorSceneItem`
+ * created from the uploaded file, making it available to custom persistence
+ * adapters and later hydration flows.
+ *
+ * @example
+ * ```ts
+ * const assetStore: VectorViewportAssetStore = {
+ *   async upload({ file, kind }) {
+ *     const form = new FormData();
+ *     form.append("file", file);
+ *     form.append("kind", kind);
+ *
+ *     const response = await fetch("/api/canvu/assets", {
+ *       method: "POST",
+ *       body: form,
+ *     });
+ *
+ *     const asset = await response.json();
+ *     return {
+ *       pluginData: {
+ *         assetId: asset.id,
+ *         assetKey: asset.key,
+ *         mimeType: file.type,
+ *       },
+ *     };
+ *   },
+ *   async resolve({ assetIds }) {
+ *     const response = await fetch("/api/canvu/assets/resolve", {
+ *       method: "POST",
+ *       headers: { "content-type": "application/json" },
+ *       body: JSON.stringify({ assetIds }),
+ *     });
+ *
+ *     return response.json();
+ *   },
+ * };
+ * ```
+ */
+type VectorViewportAssetUploadResult = {
+    /**
+     * Opaque persisted metadata attached to created items.
+     *
+     * Use this for asset ids, bucket keys, original file names, or any backend
+     * reference needed to rehydrate the binary later from your own persistence
+     * adapter.
+     */
+    pluginData?: VectorSceneItem["pluginData"];
+};
+/**
+ * Request to resolve persisted asset ids back into runtime URLs.
+ *
+ * This is useful inside custom persistence adapters when you want to rehydrate
+ * signed URLs or CDN URLs after loading a snapshot.
+ */
+type VectorViewportAssetResolveRequest = {
+    assetIds: string[];
+};
+/**
+ * Runtime URL payload returned by a custom asset resolver.
+ */
+type VectorViewportAssetResolveResult = Record<string, {
+    url: string;
+    thumbnailUrl?: string;
+}>;
+/**
+ * High-level hook for apps that want to persist raw binaries out-of-band while
+ * keeping canvu's built-in file UX.
+ *
+ * `upload` is used by the built-in file picker / drag-and-drop flow and by
+ * {@link ingestAssetFilesToSceneItems}. `resolve` is optional for custom
+ * persistence adapters and future hydration flows.
+ */
+type VectorViewportAssetStore = {
+    upload: (request: VectorViewportAssetUploadRequest) => Promise<VectorViewportAssetUploadResult | undefined>;
+    resolve?: (request: VectorViewportAssetResolveRequest) => Promise<VectorViewportAssetResolveResult>;
+};
+
 type CanvuChromeActiveToolStyle = StrokeStyle & {
     toolKind: "draw" | "marker";
     label?: string;
@@ -425,6 +528,19 @@ type VectorViewportProps = {
      * placement is resolved by the current `toolId`.
      */
     customPlacements?: readonly CustomShapePlacementOptions[];
+    /**
+     * Optional asset persistence bridge for the built-in image/file flow.
+     *
+     * Use this when you want canvu to keep its native file picker and drag-and-drop
+     * behavior, while also uploading the original binary to your backend or bucket.
+     * Returned `pluginData` is persisted on every created item from that file.
+     *
+     * This is a high-level persistence hook. For fully custom ingestion UIs or
+     * imports that start outside the viewport, prefer
+     * `ingestAssetFilesToSceneItems(...)` so your app reuses the same pipeline as
+     * canvu's native file tool.
+     */
+    assetStore?: VectorViewportAssetStore;
     /**
      * When false (default), finishing a draw/place/erase gesture requests switching back to `autoResetToolTo`.
      * Use with controlled tool state (`onToolChangeRequest`) to keep "select-after-use" behavior.
@@ -572,4 +688,4 @@ declare function useCanvuResolvedTools(): VectorToolDefinition[];
  */
 declare function useCanvuPluginContribution(pluginId: string, contribution: CanvasPluginContribution): void;
 
-export { VectorViewport as A, type BoardComponentPosition as B, type CanvasPlugin as C, type VectorViewportHandle as D, type VectorViewportProps as E, createCanvuPlugin as F, getBoardPositionStyle as G, useCanvuChromeContext as H, useCanvuDocumentContext as I, useCanvuPluginContext as J, useCanvuPluginContribution as K, useCanvuResolvedTools as L, useCanvuViewportContext as M, NavMenu as N, type RemotePresencePeer as O, type PlacementPreview as P, type RealtimeConnectionState as Q, type RemotePresenceMarkupStroke as R, type PresenceOverlayRenderContext as S, type VectorToolDefinition as V, type WorldPointerDownDetail as W, type CanvasPluginComponentProps as a, type CanvasPluginContribution as b, type CanvasPluginItemsChangeMiddlewareContext as c, type CanvasPluginRenderContext as d, type CanvuChromeActiveToolStyle as e, CanvuChromeContext as f, type CanvuChromeContextValue as g, type CanvuChromeSelectionStyleChange as h, CanvuPluginContext as i, type CanvuPluginContextValue as j, type CanvuPluginViewportSnapshot as k, type CustomShapePlacementOptions as l, type NavMenuProps as m, VectorCanvas as n, VectorCanvasBody as o, VectorCanvasHeader as p, VectorCanvasMain as q, VectorCanvasRoot as r, type VectorCanvasSlotProps as s, type VectorCanvasSpacePosition as t, type VectorCanvasSpaceProps as u, VectorCanvasToolbar as v, type VectorCanvasToolbarProps as w, VectorCanvasViewportSurface as x, VectorSelectionInspector as y, type VectorSelectionInspectorProps as z };
+export { VectorSelectionInspector as A, type BoardComponentPosition as B, type CanvasPlugin as C, type VectorSelectionInspectorProps as D, VectorViewport as E, type VectorViewportAssetResolveRequest as F, type VectorViewportAssetResolveResult as G, type VectorViewportAssetUploadRequest as H, type VectorViewportAssetUploadResult as I, type VectorViewportHandle as J, type VectorViewportProps as K, createCanvuPlugin as L, getBoardPositionStyle as M, NavMenu as N, useCanvuChromeContext as O, type PlacementPreview as P, useCanvuDocumentContext as Q, useCanvuPluginContext as R, useCanvuPluginContribution as S, useCanvuResolvedTools as T, useCanvuViewportContext as U, type VectorViewportAssetKind as V, type WorldPointerDownDetail as W, type RemotePresenceMarkupStroke as X, type RemotePresencePeer as Y, type RealtimeConnectionState as Z, type PresenceOverlayRenderContext as _, type VectorViewportAssetStore as a, type VectorToolDefinition as b, type CanvasPluginComponentProps as c, type CanvasPluginContribution as d, type CanvasPluginItemsChangeMiddlewareContext as e, type CanvasPluginRenderContext as f, type CanvuChromeActiveToolStyle as g, CanvuChromeContext as h, type CanvuChromeContextValue as i, type CanvuChromeSelectionStyleChange as j, CanvuPluginContext as k, type CanvuPluginContextValue as l, type CanvuPluginViewportSnapshot as m, type CustomShapePlacementOptions as n, type NavMenuProps as o, VectorCanvas as p, VectorCanvasBody as q, VectorCanvasHeader as r, VectorCanvasMain as s, VectorCanvasRoot as t, type VectorCanvasSlotProps as u, type VectorCanvasSpacePosition as v, type VectorCanvasSpaceProps as w, VectorCanvasToolbar as x, type VectorCanvasToolbarProps as y, VectorCanvasViewportSurface as z };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "canvu-react",
-	"version": "0.3.7",
+	"version": "0.3.8",
 	"description": "Vector-first infinite canvas (SVG) with pan, zoom, React bindings, and optional plugins",
 	"license": "MIT",
 	"type": "module",