@lupinum/board-connections 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,113 @@
+import type { Bounds, BoardEventMap, BoardNode, EdgeId, NodeId, Point } from '@lupinum/board-core';
+/** Public events installed with the connections plugin. */
+export interface ConnectionsEventMap extends BoardEventMap {
+    'edge:created': (edge: BoardEdge) => void;
+    'edge:updated': (edge: BoardEdge, prev: BoardEdge) => void;
+    'edge:deleted': (edgeId: EdgeId) => void;
+}
+/** Side of a rectangular node used for connection anchors. */
+export type AnchorSide = 'top' | 'right' | 'bottom' | 'left';
+/** Routing strategy used when rendering a connection edge. */
+export type ConnectionRouting = 'bezier' | 'smooth-step' | 'step' | 'straight' | 'arc';
+/** How UI-created and reconnected edge endpoints choose node anchors. */
+export type ConnectionEndpointMode = 'auto' | 'manual';
+/** Marker rendered at either end of an edge. */
+export type EdgeEnd = 'none' | 'arrow';
+/** Whether an endpoint came from an explicit anchor or automatic side resolution. */
+type EndpointResolutionKind = 'explicit' | 'auto';
+/** Anchor location along a given node side, with `offset` normalized from 0 to 1. */
+export interface AnchorPosition {
+    side: AnchorSide;
+    offset: number;
+}
+/** Persistent edge record owned by the connections plugin. */
+export interface BoardEdge<T = Record<string, unknown>> {
+    id: EdgeId;
+    from: NodeId;
+    to: NodeId;
+    fromAnchor?: AnchorPosition;
+    toAnchor?: AnchorPosition;
+    fromEnd?: EdgeEnd;
+    toEnd?: EdgeEnd;
+    label?: string;
+    color?: string;
+    data: T;
+    zIndex: number;
+}
+/** Partial update payload accepted by `updateEdge`. */
+export interface BoardEdgePatch<T = Record<string, unknown>> {
+    from?: NodeId;
+    to?: NodeId;
+    fromAnchor?: AnchorPosition;
+    toAnchor?: AnchorPosition;
+    fromEnd?: EdgeEnd;
+    toEnd?: EdgeEnd;
+    label?: string;
+    color?: string;
+    data?: T;
+}
+/** Options for configuring the connections plugin defaults. */
+export interface ConnectionPluginOptions {
+    routing?: ConnectionRouting;
+    endpointMode?: ConnectionEndpointMode;
+    defaultArrow?: 'none' | 'start' | 'end' | 'both';
+}
+/** Context passed when a host opts into creating a node from an empty connection drop. */
+export interface CreateNodeForConnectionContext {
+    sourceNodeId: NodeId;
+    sourceSide: AnchorSide;
+    pointerWorld: Point;
+    candidateAnchor: AnchorPosition | null;
+}
+/** Resolved connection defaults installed with the engine plugin. */
+export interface ConnectionConfig {
+    routing: ConnectionRouting;
+    endpointMode: ConnectionEndpointMode;
+    defaultArrow: NonNullable<ConnectionPluginOptions['defaultArrow']>;
+}
+/** Engine API installed by the connections plugin. */
+export interface ConnectionsApi {
+    createEdge<T extends Record<string, unknown> = Record<string, unknown>>(input: Omit<BoardEdge<T>, 'id' | 'zIndex'> & {
+        id?: EdgeId;
+        zIndex?: number;
+    }): BoardEdge<T>;
+    updateEdge<T extends Record<string, unknown> = Record<string, unknown>>(id: EdgeId, patch: BoardEdgePatch<T>): BoardEdge<T>;
+    deleteEdge(id: EdgeId): void;
+    getEdge(id: EdgeId): BoardEdge | undefined;
+    getEdges(): BoardEdge[];
+    getEdgesFrom(id: NodeId): BoardEdge[];
+    getEdgesTo(id: NodeId): BoardEdge[];
+    getEdgesBetween(from: NodeId, to: NodeId): BoardEdge[];
+    getConfig(): ConnectionConfig;
+}
+/** Fully resolved endpoint used for rendering and hit-testing an edge. */
+export interface ResolvedConnectionEndpoint {
+    nodeId: NodeId;
+    node: Pick<BoardNode, 'id' | 'x' | 'y' | 'width' | 'height'>;
+    side: AnchorSide;
+    offset: number;
+    point: Point;
+    kind: EndpointResolutionKind;
+}
+/** Low-level path segment used to render a connection route. */
+export type ConnectionRouteSegment = {
+    type: 'line';
+    from: Point;
+    to: Point;
+} | {
+    type: 'cubic';
+    from: Point;
+    control1: Point;
+    control2: Point;
+    to: Point;
+};
+/** Render-ready edge route including path data, bounds, and label position. */
+export interface ConnectionRoute {
+    routing: ConnectionRouting;
+    path: string;
+    labelPoint: Point;
+    bounds: Bounds;
+    waypoints: Point[];
+    segments: ConnectionRouteSegment[];
+}
+export {};

package/dist/vue.d.ts

@@ -0,0 +1,2 @@
+/** Vue rendering shell for connections installed on the enclosing BoardRoot. */
+export { BoardConnectionLayer } from './layer.js';