canvu-react 0.4.77 → 0.4.79

package/dist/{types-DOUBapS4.d.cts → VectorViewport-MlKilYoG.d.cts}

@@ -1,7 +1,7 @@
 import * as react from 'react';
-import { CSSProperties, ReactNode, RefObject } from 'react';
-import { V as VectorSceneItem, R as Rect } from './types-fJNwEnHf.cjs';
+import { ReactNode, RefObject, CSSProperties } from 'react';
 import { S as StrokeStyle, C as Camera2D } from './shape-builders-DzhCOuzo.cjs';
+import { V as VectorSceneItem, R as Rect } from './types-fJNwEnHf.cjs';
 import { a as VectorViewportAssetStore, R as RasterImageCanvasRenderingOptions } from './raster-image-canvas-ByaCKEVw.cjs';
 import { C as CanvuLinkData } from './link-item-BMV3VUCr.cjs';
 import { R as RemotePresencePeer, P as PresenceOverlayRenderContext } from './types-DqsqQQVf.cjs';
@@ -77,27 +77,6 @@ type PlacementPreview = {
     style?: StrokeStyle;
 };
 
-/**
- * Anchor presets for floating board components.
- *
- * Names are `<edge>-<position-along-edge>`:
- * - `top-*` / `bottom-*` anchor to the top or bottom edge.
- * - `left-*` / `right-*` anchor to the left or right edge.
- *
- * Corner aliases are equivalent (e.g. `top-left` and `left-top` resolve to the same anchor),
- * but kept distinct so callers can pick whichever reads best in their layout (a vertical
- * strip might prefer `left-top`; a horizontal strip prefers `top-left`).
- */
-type BoardComponentPosition = "top-left" | "top-center" | "top-right" | "bottom-left" | "bottom-center" | "bottom-right" | "left-top" | "left-center" | "left-bottom" | "right-top" | "right-center" | "right-bottom" | "center" | "fill";
-/** @deprecated Use {@link BoardComponentPosition}. */
-type VectorCanvasSpacePosition = BoardComponentPosition;
-/**
- * Compute absolute-position CSS for a board component anchor preset.
- * Returns `position`, `zIndex`, and the relevant edge offsets / transforms.
- * Callers merge the result with their own style/className overrides.
- */
-declare function getBoardPositionStyle(position: BoardComponentPosition, inset?: number, zIndex?: number): CSSProperties;
-
 /**
  * Describes one entry in {@link VectorToolbar}.
  */
@@ -118,36 +97,6 @@ type VectorToolDefinition = {
     ariaLabel?: string;
 };
 
-type ReadOnlyItemClickCandidateDetail = {
-    /** The item Canvu hit-tested under the read-only click. */
-    item: VectorSceneItem;
-    /** World-space pointer location at press time. */
-    worldX: number;
-    worldY: number;
-    /** Viewport/client pointer location at press time. */
-    clientX: number;
-    clientY: number;
-    pointerType: string;
-    shiftKey: boolean;
-    altKey: boolean;
-    metaKey: boolean;
-    ctrlKey: boolean;
-    /** Current viewport items. */
-    items: readonly VectorSceneItem[];
-    /** Selection snapshot before read-only activation handles the click. */
-    selectedIds: readonly string[];
-};
-/**
- * Controls which items may receive select-mode click activation while
- * `VectorViewport` is read-only (`interactive={false}`).
- *
- * `"custom"` keeps the default high-level behavior: custom placement/tool
- * items with `onSelectModeItemClick` remain clickable, while regular items do
- * not become selectable unless the app opts in. Use `"all"` or a predicate for
- * read-only viewers that still need item selection or item-specific side effects.
- */
-type ReadOnlyItemClickScope = "custom" | "all" | ((detail: ReadOnlyItemClickCandidateDetail) => boolean);
-
 /**
  * Stable ids for Canvu's built-in shape context-menu items.
  *
@@ -287,6 +236,183 @@ type ShapeContextMenuProps = {
  */
 declare function ShapeContextMenu({ x, y, selectedIds, selectedItems, allSelectedLocked, onClose, onToggleLock, onCut, onCopy, onBringToFront, onBringForward, onSendBackward, onSendToBack, onDuplicate, onDelete, items, itemContributions, children, }: ShapeContextMenuProps): react.ReactPortal | null;
 
+type CanvasPluginRenderContext = {
+    /** Live viewport handle when the plugin needs camera or viewport size. */
+    viewportRef?: RefObject<VectorViewportHandle | null>;
+};
+type CanvasPluginItemsChangeMiddlewareContext = {
+    /** Current board items before the pending change is applied. */
+    currentItems: readonly VectorSceneItem[];
+    /** Continue the item change pipeline. Forward `info` when preserving motive metadata. */
+    next: NonNullable<VectorViewportProps["onItemsChange"]>;
+    /** Original consumer callback passed to `VectorViewport`. */
+    consumerOnItemsChange?: VectorViewportProps["onItemsChange"];
+    /** Live viewport handle for advanced integrations. */
+    viewportRef?: RefObject<VectorViewportHandle | null>;
+};
+type CanvasPluginContribution = {
+    /** Additional tools injected into the board toolbar/runtime. */
+    tools?: readonly VectorToolDefinition[];
+    /** Transform the resolved tool list (reorder, replace, or filter existing tools). */
+    toolTransform?: (tools: VectorToolDefinition[]) => VectorToolDefinition[];
+    /**
+     * Additional shape context-menu items merged by id after Canvu's built-ins.
+     *
+     * Matching ids replace existing items in place, new ids append, and plugin order
+     * determines tie-breaking before app-level `VectorViewport.contextMenuItems`.
+     */
+    contextMenuItems?: readonly ShapeContextMenuItem[];
+    /** Multiple custom placements contributed by plugins; the active one is resolved by `toolId`. */
+    customPlacements?: readonly CustomShapePlacementOptions[];
+    /** Simple viewport prop overrides owned by the plugin runtime. */
+    viewportProps?: Partial<Pick<VectorViewportProps, "remotePresence" | "presenceOverlay">>;
+    /** Event callbacks chained into the viewport without manual wiring in app code. */
+    callbacks?: Partial<Pick<VectorViewportProps, "onWorldPointerDown" | "onWorldPointerMove" | "onWorldPointerLeave" | "onPlacementPreviewChange" | "onCameraChange">>;
+    /**
+     * Hooks around Canvu-owned pointer interactions.
+     *
+     * Use these for custom tool behavior that needs to observe or claim a gesture
+     * before the viewport mutates state. Use `wrapOnItemsChange` for exact item
+     * mutation middleware.
+     */
+    interactionHooks?: {
+        /** Return `"handled"` to claim the gesture and skip Canvu's built-in behavior. */
+        onBeforeInteraction?: CanvuBeforeInteractionHook;
+        /** Runs once when an accepted gesture completes or is cancelled. */
+        onAfterInteraction?: CanvuAfterInteractionHook;
+    };
+    /** Middleware around `onItemsChange` for collaboration, comments, persistence, etc. */
+    wrapOnItemsChange?: (nextItems: VectorSceneItem[], ctx: CanvasPluginItemsChangeMiddlewareContext, info?: VectorItemsChangeInfo) => void;
+};
+type CanvasPluginComponentProps = {
+    /** Stable plugin id so the component can register contributions. */
+    pluginId: string;
+};
+type CanvasPlugin = {
+    /** Stable id, e.g. `canvu.plugin.chatbot`. */
+    id: string;
+    /**
+     * Legacy/simple rendering path for purely visual plugins.
+     *
+     * Prefer `Component` for plugins that need hooks, document integration, tools, or runtime contributions.
+     */
+    render?: (ctx: CanvasPluginRenderContext) => ReactNode;
+    /**
+     * Preferred plugin entrypoint for first-party and advanced plugins.
+     *
+     * The component can use hooks and register contributions through `useCanvuPluginContribution`.
+     */
+    Component?: (props: CanvasPluginComponentProps) => ReactNode;
+};
+type CanvuPluginViewportSnapshot = Pick<VectorViewportProps, "items" | "onItemsChange" | "toolId" | "interactive" | "toolLocked" | "onToolChangeRequest">;
+type CanvuPluginContextValue = {
+    viewportRef?: RefObject<VectorViewportHandle | null>;
+    viewport: CanvuPluginViewportSnapshot;
+    resolvedTools: VectorToolDefinition[];
+    registerContribution: (pluginId: string, contribution: CanvasPluginContribution) => void;
+    unregisterContribution: (pluginId: string) => void;
+};
+declare const CanvuPluginContext: react.Context<CanvuPluginContextValue | null>;
+/**
+ * Creates a typed canvu plugin descriptor.
+ *
+ * Use this helper when authoring custom plugins so your editor can infer the plugin shape
+ * and surface better hover documentation for the returned object.
+ */
+declare function createCanvuPlugin(plugin: CanvasPlugin): CanvasPlugin;
+/**
+ * Returns the low-level canvu plugin runtime context.
+ *
+ * This is an advanced API for custom plugin authors. Prefer first-party plugin factories such as
+ * `chatbotPlugin(...)` and `realtimeCollaborationPlugin(...)` for the common path.
+ */
+declare function useCanvuPluginContext(): CanvuPluginContextValue;
+/**
+ * Returns the current viewport-facing board state exposed to plugins.
+ *
+ * Use this when a custom plugin needs access to items, the active tool, or the consumer's
+ * `onToolChangeRequest` callback.
+ */
+declare function useCanvuViewportContext(): {
+    viewportRef?: RefObject<VectorViewportHandle | null>;
+    viewport: CanvuPluginViewportSnapshot;
+};
+/**
+ * Returns the board document context exposed to plugins.
+ *
+ * This hook is intended for advanced plugins that need to read items or integrate with the board's
+ * `onItemsChange` lifecycle.
+ */
+declare function useCanvuDocumentContext(): {
+    items: readonly VectorSceneItem[];
+    onItemsChange?: VectorViewportProps["onItemsChange"];
+};
+/**
+ * Returns the tool list already resolved by the plugin runtime.
+ *
+ * `VectorToolbar` consumes this automatically when you omit its `tools` prop, so most apps do not
+ * need this hook directly.
+ */
+declare function useCanvuResolvedTools(): VectorToolDefinition[];
+/**
+ * Registers non-visual plugin contributions with the current `VectorViewport` runtime.
+ *
+ * Use this inside `plugin.Component` when you want to inject tools, pointer/camera behavior, or
+ * document middleware without requiring the consumer to wire hooks manually.
+ */
+declare function useCanvuPluginContribution(pluginId: string, contribution: CanvasPluginContribution): void;
+
+type ReadOnlyItemClickCandidateDetail = {
+    /** The item Canvu hit-tested under the read-only click. */
+    item: VectorSceneItem;
+    /** World-space pointer location at press time. */
+    worldX: number;
+    worldY: number;
+    /** Viewport/client pointer location at press time. */
+    clientX: number;
+    clientY: number;
+    pointerType: string;
+    shiftKey: boolean;
+    altKey: boolean;
+    metaKey: boolean;
+    ctrlKey: boolean;
+    /** Current viewport items. */
+    items: readonly VectorSceneItem[];
+    /** Selection snapshot before read-only activation handles the click. */
+    selectedIds: readonly string[];
+};
+/**
+ * Controls which items may receive select-mode click activation while
+ * `VectorViewport` is read-only (`interactive={false}`).
+ *
+ * `"custom"` keeps the default high-level behavior: custom placement/tool
+ * items with `onSelectModeItemClick` remain clickable, while regular items do
+ * not become selectable unless the app opts in. Use `"all"` or a predicate for
+ * read-only viewers that still need item selection or item-specific side effects.
+ */
+type ReadOnlyItemClickScope = "custom" | "all" | ((detail: ReadOnlyItemClickCandidateDetail) => boolean);
+
+/**
+ * Anchor presets for floating board components.
+ *
+ * Names are `<edge>-<position-along-edge>`:
+ * - `top-*` / `bottom-*` anchor to the top or bottom edge.
+ * - `left-*` / `right-*` anchor to the left or right edge.
+ *
+ * Corner aliases are equivalent (e.g. `top-left` and `left-top` resolve to the same anchor),
+ * but kept distinct so callers can pick whichever reads best in their layout (a vertical
+ * strip might prefer `left-top`; a horizontal strip prefers `top-left`).
+ */
+type BoardComponentPosition = "top-left" | "top-center" | "top-right" | "bottom-left" | "bottom-center" | "bottom-right" | "left-top" | "left-center" | "left-bottom" | "right-top" | "right-center" | "right-bottom" | "center" | "fill";
+/** @deprecated Use {@link BoardComponentPosition}. */
+type VectorCanvasSpacePosition = BoardComponentPosition;
+/**
+ * Compute absolute-position CSS for a board component anchor preset.
+ * Returns `position`, `zIndex`, and the relevant edge offsets / transforms.
+ * Callers merge the result with their own style/className overrides.
+ */
+declare function getBoardPositionStyle(position: BoardComponentPosition, inset?: number, zIndex?: number): CSSProperties;
+
 type ActiveToolStyle = StrokeStyle & {
     toolKind: "draw" | "marker" | "text" | "rect" | "ellipse" | "architectural-cloud" | "line" | "arrow";
     label?: string;
@@ -756,130 +882,4 @@ type VectorViewportProps = {
  */
 declare const VectorViewport: react.ForwardRefExoticComponent<VectorViewportProps & react.RefAttributes<VectorViewportHandle>>;
 
-type CanvasPluginRenderContext = {
-    /** Live viewport handle when the plugin needs camera or viewport size. */
-    viewportRef?: RefObject<VectorViewportHandle | null>;
-};
-type CanvasPluginItemsChangeMiddlewareContext = {
-    /** Current board items before the pending change is applied. */
-    currentItems: readonly VectorSceneItem[];
-    /** Continue the item change pipeline. Forward `info` when preserving motive metadata. */
-    next: NonNullable<VectorViewportProps["onItemsChange"]>;
-    /** Original consumer callback passed to `VectorViewport`. */
-    consumerOnItemsChange?: VectorViewportProps["onItemsChange"];
-    /** Live viewport handle for advanced integrations. */
-    viewportRef?: RefObject<VectorViewportHandle | null>;
-};
-type CanvasPluginContribution = {
-    /** Additional tools injected into the board toolbar/runtime. */
-    tools?: readonly VectorToolDefinition[];
-    /** Transform the resolved tool list (reorder, replace, or filter existing tools). */
-    toolTransform?: (tools: VectorToolDefinition[]) => VectorToolDefinition[];
-    /**
-     * Additional shape context-menu items merged by id after Canvu's built-ins.
-     *
-     * Matching ids replace existing items in place, new ids append, and plugin order
-     * determines tie-breaking before app-level `VectorViewport.contextMenuItems`.
-     */
-    contextMenuItems?: readonly ShapeContextMenuItem[];
-    /** Multiple custom placements contributed by plugins; the active one is resolved by `toolId`. */
-    customPlacements?: readonly CustomShapePlacementOptions[];
-    /** Simple viewport prop overrides owned by the plugin runtime. */
-    viewportProps?: Partial<Pick<VectorViewportProps, "remotePresence" | "presenceOverlay">>;
-    /** Event callbacks chained into the viewport without manual wiring in app code. */
-    callbacks?: Partial<Pick<VectorViewportProps, "onWorldPointerDown" | "onWorldPointerMove" | "onWorldPointerLeave" | "onPlacementPreviewChange" | "onCameraChange">>;
-    /**
-     * Hooks around Canvu-owned pointer interactions.
-     *
-     * Use these for custom tool behavior that needs to observe or claim a gesture
-     * before the viewport mutates state. Use `wrapOnItemsChange` for exact item
-     * mutation middleware.
-     */
-    interactionHooks?: {
-        /** Return `"handled"` to claim the gesture and skip Canvu's built-in behavior. */
-        onBeforeInteraction?: CanvuBeforeInteractionHook;
-        /** Runs once when an accepted gesture completes or is cancelled. */
-        onAfterInteraction?: CanvuAfterInteractionHook;
-    };
-    /** Middleware around `onItemsChange` for collaboration, comments, persistence, etc. */
-    wrapOnItemsChange?: (nextItems: VectorSceneItem[], ctx: CanvasPluginItemsChangeMiddlewareContext, info?: VectorItemsChangeInfo) => void;
-};
-type CanvasPluginComponentProps = {
-    /** Stable plugin id so the component can register contributions. */
-    pluginId: string;
-};
-type CanvasPlugin = {
-    /** Stable id, e.g. `canvu.plugin.chatbot`. */
-    id: string;
-    /**
-     * Legacy/simple rendering path for purely visual plugins.
-     *
-     * Prefer `Component` for plugins that need hooks, document integration, tools, or runtime contributions.
-     */
-    render?: (ctx: CanvasPluginRenderContext) => ReactNode;
-    /**
-     * Preferred plugin entrypoint for first-party and advanced plugins.
-     *
-     * The component can use hooks and register contributions through `useCanvuPluginContribution`.
-     */
-    Component?: (props: CanvasPluginComponentProps) => ReactNode;
-};
-type CanvuPluginViewportSnapshot = Pick<VectorViewportProps, "items" | "onItemsChange" | "toolId" | "interactive" | "toolLocked" | "onToolChangeRequest">;
-type CanvuPluginContextValue = {
-    viewportRef?: RefObject<VectorViewportHandle | null>;
-    viewport: CanvuPluginViewportSnapshot;
-    resolvedTools: VectorToolDefinition[];
-    registerContribution: (pluginId: string, contribution: CanvasPluginContribution) => void;
-    unregisterContribution: (pluginId: string) => void;
-};
-declare const CanvuPluginContext: react.Context<CanvuPluginContextValue | null>;
-/**
- * Creates a typed canvu plugin descriptor.
- *
- * Use this helper when authoring custom plugins so your editor can infer the plugin shape
- * and surface better hover documentation for the returned object.
- */
-declare function createCanvuPlugin(plugin: CanvasPlugin): CanvasPlugin;
-/**
- * Returns the low-level canvu plugin runtime context.
- *
- * This is an advanced API for custom plugin authors. Prefer first-party plugin factories such as
- * `chatbotPlugin(...)` and `realtimeCollaborationPlugin(...)` for the common path.
- */
-declare function useCanvuPluginContext(): CanvuPluginContextValue;
-/**
- * Returns the current viewport-facing board state exposed to plugins.
- *
- * Use this when a custom plugin needs access to items, the active tool, or the consumer's
- * `onToolChangeRequest` callback.
- */
-declare function useCanvuViewportContext(): {
-    viewportRef?: RefObject<VectorViewportHandle | null>;
-    viewport: CanvuPluginViewportSnapshot;
-};
-/**
- * Returns the board document context exposed to plugins.
- *
- * This hook is intended for advanced plugins that need to read items or integrate with the board's
- * `onItemsChange` lifecycle.
- */
-declare function useCanvuDocumentContext(): {
-    items: readonly VectorSceneItem[];
-    onItemsChange?: VectorViewportProps["onItemsChange"];
-};
-/**
- * Returns the tool list already resolved by the plugin runtime.
- *
- * `VectorToolbar` consumes this automatically when you omit its `tools` prop, so most apps do not
- * need this hook directly.
- */
-declare function useCanvuResolvedTools(): VectorToolDefinition[];
-/**
- * Registers non-visual plugin contributions with the current `VectorViewport` runtime.
- *
- * Use this inside `plugin.Component` when you want to inject tools, pointer/camera behavior, or
- * document middleware without requiring the consumer to wire hooks manually.
- */
-declare function useCanvuPluginContribution(pluginId: string, contribution: CanvasPluginContribution): void;
-
-export { type ShapeContextMenuItem as A, type BoardComponentPosition as B, type CustomShapePlacementOptions as C, type ShapeContextMenuProps as D, type ShapeContextMenuRenderContext as E, type VectorCanvasSpacePosition as F, type VectorItemsChangeInfo as G, type VectorItemsChangeMotive as H, type VectorSelectionInspectorProps as I, VectorViewport as J, type VectorViewportHandle as K, type VectorViewportProps as L, createCanvuPlugin as M, getBoardPositionStyle as N, useCanvuChromeContext as O, type PlacementPreview as P, useCanvuDocumentContext as Q, type ReadOnlyInteractionOptions as R, SHAPE_CONTEXT_MENU_ITEM_IDS as S, useCanvuPluginContext as T, useCanvuPluginContribution as U, type VectorToolDefinition as V, type WorldPointerDownDetail as W, useCanvuResolvedTools as X, useCanvuViewportContext as Y, type CanvuBeforeInteractionHook as a, type CanvuAfterInteractionHook as b, type CanvasPlugin as c, VectorSelectionInspector as d, type CanvasPluginComponentProps as e, type CanvasPluginContribution as f, type CanvasPluginItemsChangeMiddlewareContext as g, type CanvasPluginRenderContext as h, type CanvuAfterInteractionDetail as i, type CanvuBeforeInteractionResult as j, type CanvuChromeActiveToolStyle as k, CanvuChromeContext as l, type CanvuChromeContextValue as m, type CanvuChromeSelectionStyleChange as n, type CanvuInteractionDetail as o, type CanvuInteractionKind as p, type CanvuInteractionOutcome as q, type CanvuInteractionPoint as r, CanvuPluginContext as s, type CanvuPluginContextValue as t, type CanvuPluginViewportSnapshot as u, type ReadOnlyItemClickCandidateDetail as v, type ReadOnlyItemClickScope as w, type SelectModeItemClickDetail as x, type SelectModeItemClickResult as y, ShapeContextMenu as z };
+export { ShapeContextMenu as A, type BoardComponentPosition as B, type CustomShapePlacementOptions as C, type ShapeContextMenuItem as D, type ShapeContextMenuProps as E, type ShapeContextMenuRenderContext as F, type VectorCanvasSpacePosition as G, type VectorItemsChangeMotive as H, type VectorSelectionInspectorProps as I, VectorViewport as J, type VectorViewportHandle as K, type VectorViewportProps as L, createCanvuPlugin as M, getBoardPositionStyle as N, useCanvuChromeContext as O, type PlacementPreview as P, useCanvuDocumentContext as Q, type ReadOnlyInteractionOptions as R, SHAPE_CONTEXT_MENU_ITEM_IDS as S, useCanvuPluginContext as T, useCanvuPluginContribution as U, type VectorToolDefinition as V, type WorldPointerDownDetail as W, useCanvuResolvedTools as X, useCanvuViewportContext as Y, type CanvuBeforeInteractionHook as a, type CanvuAfterInteractionHook as b, type CanvasPlugin as c, type VectorItemsChangeInfo as d, VectorSelectionInspector as e, type CanvasPluginComponentProps as f, type CanvasPluginContribution as g, type CanvasPluginItemsChangeMiddlewareContext as h, type CanvasPluginRenderContext as i, type CanvuAfterInteractionDetail as j, type CanvuBeforeInteractionResult as k, type CanvuChromeActiveToolStyle as l, CanvuChromeContext as m, type CanvuChromeContextValue as n, type CanvuChromeSelectionStyleChange as o, type CanvuInteractionDetail as p, type CanvuInteractionKind as q, type CanvuInteractionOutcome as r, type CanvuInteractionPoint as s, CanvuPluginContext as t, type CanvuPluginContextValue as u, type CanvuPluginViewportSnapshot as v, type ReadOnlyItemClickCandidateDetail as w, type ReadOnlyItemClickScope as x, type SelectModeItemClickDetail as y, type SelectModeItemClickResult as z };