canvu-react 0.4.59 → 0.4.61

package/dist/{types-BFZpRGyr.d.cts → types--jCoyZIF.d.cts}

@@ -179,6 +179,29 @@ type SelectModeItemClickDetail = {
     /** Set the viewport selection when activation should also select or clear. */
     setSelectedIds: (ids: readonly string[]) => void;
 };
+/**
+ * Best-effort reason attached to a React viewport item change.
+ *
+ * Middleware and `onItemsChange` consumers can use this to distinguish user
+ * actions such as deletion, erasing, placement, or text editing without
+ * diffing item snapshots themselves. Metadata may be omitted by legacy callers
+ * or by integrations that update items outside canvu's built-in interactions.
+ */
+type VectorItemsChangeMotive = "draw" | "place" | "text-create" | "text-edit" | "asset-add" | "asset-hydrate" | "move" | "resize" | "rotate" | "style" | "delete" | "erase" | "cut" | "paste" | "duplicate" | "lock" | "unlock" | "reorder" | "undo" | "redo" | "custom" | "remote-sync" | "plugin" | "unknown";
+/**
+ * Optional metadata passed alongside a React viewport item change.
+ *
+ * The payload is intentionally small and stable: `motive` describes the action
+ * class, `itemIds` identifies the primary affected items when known, and
+ * `toolId` records the active tool for placement or drawing flows. Treat this
+ * as advisory metadata; absence means the change came from legacy code or an
+ * external source that did not provide a motive.
+ */
+type VectorItemsChangeInfo = {
+    motive: VectorItemsChangeMotive;
+    itemIds?: readonly string[];
+    toolId?: string;
+};
 /**
  * Imperative API for pan/zoom and integrations (e.g. AI agents following a region).
  * Call {@link requestRender} after mutating the {@link Camera2D} from {@link getCamera}.
@@ -246,7 +269,15 @@ type VectorViewportProps = {
     /** Selected item ids (order preserved). Empty = none. */
     selectedIds?: readonly string[];
     onSelectionChange?: (ids: string[]) => void;
-    onItemsChange?: (items: VectorSceneItem[]) => void;
+    /**
+     * Called when the React viewport requests a replacement item list.
+     *
+     * `info` is best-effort action metadata for middleware and app code that
+     * needs to know whether the change was a deletion, placement, move, etc.
+     * Existing one-argument handlers remain valid, and callers outside canvu may
+     * omit `info`.
+     */
+    onItemsChange?: (items: VectorSceneItem[], info?: VectorItemsChangeInfo) => void;
     /**
      * Fires when a link/bookmark item is activated (double-click / double-tap).
      * When omitted, the link opens in a new browser tab by default (web only).
@@ -368,7 +399,7 @@ type CanvasPluginRenderContext = {
 type CanvasPluginItemsChangeMiddlewareContext = {
     /** Current board items before the pending change is applied. */
     currentItems: readonly VectorSceneItem[];
-    /** Continue the item change pipeline. */
+    /** Continue the item change pipeline. Forward `info` when preserving motive metadata. */
     next: NonNullable<VectorViewportProps["onItemsChange"]>;
     /** Original consumer callback passed to `VectorViewport`. */
     consumerOnItemsChange?: VectorViewportProps["onItemsChange"];
@@ -387,7 +418,7 @@ type CanvasPluginContribution = {
     /** Event callbacks chained into the viewport without manual wiring in app code. */
     callbacks?: Partial<Pick<VectorViewportProps, "onWorldPointerDown" | "onWorldPointerMove" | "onWorldPointerLeave" | "onPlacementPreviewChange" | "onCameraChange">>;
     /** Middleware around `onItemsChange` for collaboration, comments, persistence, etc. */
-    wrapOnItemsChange?: (nextItems: VectorSceneItem[], ctx: CanvasPluginItemsChangeMiddlewareContext) => void;
+    wrapOnItemsChange?: (nextItems: VectorSceneItem[], ctx: CanvasPluginItemsChangeMiddlewareContext, info?: VectorItemsChangeInfo) => void;
 };
 type CanvasPluginComponentProps = {
     /** Stable plugin id so the component can register contributions. */
@@ -467,4 +498,4 @@ declare function useCanvuResolvedTools(): VectorToolDefinition[];
  */
 declare function useCanvuPluginContribution(pluginId: string, contribution: CanvasPluginContribution): void;
 
-export { useCanvuViewportContext as A, type BoardComponentPosition as B, type CustomShapePlacementOptions as C, type PlacementPreview as P, type SelectModeItemClickDetail as S, type VectorToolDefinition as V, type WorldPointerDownDetail as W, type CanvasPlugin as a, VectorSelectionInspector 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 SelectModeItemClickResult as n, type VectorCanvasSpacePosition as o, type VectorSelectionInspectorProps as p, VectorViewport as q, type VectorViewportHandle as r, type VectorViewportProps as s, createCanvuPlugin as t, getBoardPositionStyle as u, useCanvuChromeContext as v, useCanvuDocumentContext as w, useCanvuPluginContext as x, useCanvuPluginContribution as y, useCanvuResolvedTools as z };
+export { useCanvuPluginContribution as A, type BoardComponentPosition as B, type CustomShapePlacementOptions as C, useCanvuResolvedTools as D, useCanvuViewportContext as E, type PlacementPreview as P, type SelectModeItemClickDetail as S, type VectorToolDefinition as V, type WorldPointerDownDetail as W, type CanvasPlugin as a, VectorSelectionInspector 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 SelectModeItemClickResult as n, type VectorCanvasSpacePosition as o, type VectorItemsChangeInfo as p, type VectorItemsChangeMotive as q, type VectorSelectionInspectorProps as r, VectorViewport as s, type VectorViewportHandle as t, type VectorViewportProps as u, createCanvuPlugin as v, getBoardPositionStyle as w, useCanvuChromeContext as x, useCanvuDocumentContext as y, useCanvuPluginContext as z };

package/dist/{types-D2zesNI8.d.ts → types-C_PMen-D.d.ts}

@@ -179,6 +179,29 @@ type SelectModeItemClickDetail = {
     /** Set the viewport selection when activation should also select or clear. */
     setSelectedIds: (ids: readonly string[]) => void;
 };
+/**
+ * Best-effort reason attached to a React viewport item change.
+ *
+ * Middleware and `onItemsChange` consumers can use this to distinguish user
+ * actions such as deletion, erasing, placement, or text editing without
+ * diffing item snapshots themselves. Metadata may be omitted by legacy callers
+ * or by integrations that update items outside canvu's built-in interactions.
+ */
+type VectorItemsChangeMotive = "draw" | "place" | "text-create" | "text-edit" | "asset-add" | "asset-hydrate" | "move" | "resize" | "rotate" | "style" | "delete" | "erase" | "cut" | "paste" | "duplicate" | "lock" | "unlock" | "reorder" | "undo" | "redo" | "custom" | "remote-sync" | "plugin" | "unknown";
+/**
+ * Optional metadata passed alongside a React viewport item change.
+ *
+ * The payload is intentionally small and stable: `motive` describes the action
+ * class, `itemIds` identifies the primary affected items when known, and
+ * `toolId` records the active tool for placement or drawing flows. Treat this
+ * as advisory metadata; absence means the change came from legacy code or an
+ * external source that did not provide a motive.
+ */
+type VectorItemsChangeInfo = {
+    motive: VectorItemsChangeMotive;
+    itemIds?: readonly string[];
+    toolId?: string;
+};
 /**
  * Imperative API for pan/zoom and integrations (e.g. AI agents following a region).
  * Call {@link requestRender} after mutating the {@link Camera2D} from {@link getCamera}.
@@ -246,7 +269,15 @@ type VectorViewportProps = {
     /** Selected item ids (order preserved). Empty = none. */
     selectedIds?: readonly string[];
     onSelectionChange?: (ids: string[]) => void;
-    onItemsChange?: (items: VectorSceneItem[]) => void;
+    /**
+     * Called when the React viewport requests a replacement item list.
+     *
+     * `info` is best-effort action metadata for middleware and app code that
+     * needs to know whether the change was a deletion, placement, move, etc.
+     * Existing one-argument handlers remain valid, and callers outside canvu may
+     * omit `info`.
+     */
+    onItemsChange?: (items: VectorSceneItem[], info?: VectorItemsChangeInfo) => void;
     /**
      * Fires when a link/bookmark item is activated (double-click / double-tap).
      * When omitted, the link opens in a new browser tab by default (web only).
@@ -368,7 +399,7 @@ type CanvasPluginRenderContext = {
 type CanvasPluginItemsChangeMiddlewareContext = {
     /** Current board items before the pending change is applied. */
     currentItems: readonly VectorSceneItem[];
-    /** Continue the item change pipeline. */
+    /** Continue the item change pipeline. Forward `info` when preserving motive metadata. */
     next: NonNullable<VectorViewportProps["onItemsChange"]>;
     /** Original consumer callback passed to `VectorViewport`. */
     consumerOnItemsChange?: VectorViewportProps["onItemsChange"];
@@ -387,7 +418,7 @@ type CanvasPluginContribution = {
     /** Event callbacks chained into the viewport without manual wiring in app code. */
     callbacks?: Partial<Pick<VectorViewportProps, "onWorldPointerDown" | "onWorldPointerMove" | "onWorldPointerLeave" | "onPlacementPreviewChange" | "onCameraChange">>;
     /** Middleware around `onItemsChange` for collaboration, comments, persistence, etc. */
-    wrapOnItemsChange?: (nextItems: VectorSceneItem[], ctx: CanvasPluginItemsChangeMiddlewareContext) => void;
+    wrapOnItemsChange?: (nextItems: VectorSceneItem[], ctx: CanvasPluginItemsChangeMiddlewareContext, info?: VectorItemsChangeInfo) => void;
 };
 type CanvasPluginComponentProps = {
     /** Stable plugin id so the component can register contributions. */
@@ -467,4 +498,4 @@ declare function useCanvuResolvedTools(): VectorToolDefinition[];
  */
 declare function useCanvuPluginContribution(pluginId: string, contribution: CanvasPluginContribution): void;
 
-export { useCanvuViewportContext as A, type BoardComponentPosition as B, type CustomShapePlacementOptions as C, type PlacementPreview as P, type SelectModeItemClickDetail as S, type VectorToolDefinition as V, type WorldPointerDownDetail as W, type CanvasPlugin as a, VectorSelectionInspector 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 SelectModeItemClickResult as n, type VectorCanvasSpacePosition as o, type VectorSelectionInspectorProps as p, VectorViewport as q, type VectorViewportHandle as r, type VectorViewportProps as s, createCanvuPlugin as t, getBoardPositionStyle as u, useCanvuChromeContext as v, useCanvuDocumentContext as w, useCanvuPluginContext as x, useCanvuPluginContribution as y, useCanvuResolvedTools as z };
+export { useCanvuPluginContribution as A, type BoardComponentPosition as B, type CustomShapePlacementOptions as C, useCanvuResolvedTools as D, useCanvuViewportContext as E, type PlacementPreview as P, type SelectModeItemClickDetail as S, type VectorToolDefinition as V, type WorldPointerDownDetail as W, type CanvasPlugin as a, VectorSelectionInspector 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 SelectModeItemClickResult as n, type VectorCanvasSpacePosition as o, type VectorItemsChangeInfo as p, type VectorItemsChangeMotive as q, type VectorSelectionInspectorProps as r, VectorViewport as s, type VectorViewportHandle as t, type VectorViewportProps as u, createCanvuPlugin as v, getBoardPositionStyle as w, useCanvuChromeContext as x, useCanvuDocumentContext as y, useCanvuPluginContext as z };

package/package.json

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