@neo4j-nvl/interaction-handlers 0.2.8 → 0.2.9

package/lib/index.d.ts

@@ -3,13 +3,14 @@ import { ClickInteraction } from './interaction-handlers/click-interaction';
 import { DragNodeInteraction } from './interaction-handlers/drag-node-interaction';
 import type { DragNodeInteractionCallbacks } from './interaction-handlers/drag-node-interaction';
 import { DrawInteraction } from './interaction-handlers/draw-interaction';
+import type { DrawInteractionCallbacks } from './interaction-handlers/draw-interaction';
 import type { HoverInteractionOptions, HoverInteractionCallbacks } from './interaction-handlers/hover-interaction';
 import { HoverInteraction } from './interaction-handlers/hover-interaction';
-import type { MultiSelectInteractionOptions } from './interaction-handlers/multi-select-interaction';
+import type { MultiSelectInteractionOptions, MultiSelectInteractionCallbacks } from './interaction-handlers/multi-select-interaction';
 import { MultiSelectInteraction } from './interaction-handlers/multi-select-interaction';
 import type { PanInteractionCallbacks } from './interaction-handlers/pan-interaction';
 import { PanInteraction } from './interaction-handlers/pan-interaction';
 import type { ZoomInteractionCallbacks } from './interaction-handlers/zoom-interaction';
 import { ZoomInteraction } from './interaction-handlers/zoom-interaction';
-export type { MultiSelectInteractionOptions, ClickInteractionOptions, HoverInteractionOptions, HoverInteractionCallbacks, DragNodeInteractionCallbacks, ClickInteractionCallbacks, PanInteractionCallbacks, ZoomInteractionCallbacks };
+export type { MultiSelectInteractionOptions, MultiSelectInteractionCallbacks, ClickInteractionOptions, HoverInteractionOptions, HoverInteractionCallbacks, DragNodeInteractionCallbacks, ClickInteractionCallbacks, PanInteractionCallbacks, ZoomInteractionCallbacks, DrawInteractionCallbacks };
 export { ZoomInteraction, PanInteraction, MultiSelectInteraction, ClickInteraction, HoverInteraction, DragNodeInteraction, DrawInteraction };

package/lib/interaction-handlers/base.d.ts

@@ -4,7 +4,7 @@ import { NVL } from '@neo4j-nvl/core';
  * @abstract
  * @internal
  */
-declare abstract class BaseInteraction<T extends Record<string, (...args: unknown[]) => void>> {
+declare abstract class BaseInteraction<T extends Record<string, ((...args: unknown[]) => void) | boolean>> {
     private readonly nvl;
     private readonly container;
     /**
@@ -34,7 +34,7 @@ declare abstract class BaseInteraction<T extends Record<string, (...args: unknow
     /**
      * @internal
      */
-    callCallbackIfRegistered: (name: keyof T, ...args: Parameters<T[keyof T]>) => void;
+    callCallbackIfRegistered: (name: keyof T, ...args: any) => void;
     /**
      * Add or update a callback for a given event of type.
      * @param name - The name of the event

package/lib/interaction-handlers/base.js

@@ -60,7 +60,7 @@ class BaseInteraction {
             writable: true,
             value: (name, ...args) => {
                 const callback = this.callbackMap.get(name);
-                if (callback) {
+                if (typeof callback === 'function') {
                     callback(...args);
                 }
             }

package/lib/interaction-handlers/click-interaction.d.ts

@@ -20,57 +20,57 @@ export type ClickInteractionCallbacks = {
      * @param hitElements - All elements that were hit by the click
      * @param event - The original mouse event
      */
-    onNodeClick: (nodes: Node, hitElements: HitTargets, event: MouseEvent) => void;
+    onNodeClick?: ((nodes: Node, hitElements: HitTargets, event: MouseEvent) => void) | boolean;
     /**
      * Called when a relationship is clicked
      * @param relationship - The relationship that was clicked
      * @param hitElements - All elements that were hit by the click
      * @param event - The original mouse event
      */
-    onRelationshipClick: (relationship: Relationship, hitElements: HitTargets, event: MouseEvent) => void;
+    onRelationshipClick?: ((relationship: Relationship, hitElements: HitTargets, event: MouseEvent) => void) | boolean;
     /**
      * Called when the canvas is clicked
      * @param event - The original mouse event
      */
-    onCanvasClick: (event: MouseEvent) => void;
+    onCanvasClick?: ((event: MouseEvent) => void) | boolean;
     /**
      * Called when a node is double clicked
      * @param event - The original mouse event
      */
-    onCanvasDoubleClick: (event: MouseEvent) => void;
+    onCanvasDoubleClick?: ((event: MouseEvent) => void) | boolean;
     /**
      * Called when a relationship is right-clicked
      * @param event - The original mouse event
      */
-    onCanvasRightClick: (event: MouseEvent) => void;
+    onCanvasRightClick?: ((event: MouseEvent) => void) | boolean;
     /**
      * Called when a node is double-clicked
      * @param nodes - The node that was double-clicked
      * @param hitElements - All elements that were hit by the double-click
      * @param event - The original mouse event
      */
-    onNodeDoubleClick: (node: Node, hitElements: HitTargets, event: MouseEvent) => void;
+    onNodeDoubleClick?: ((node: Node, hitElements: HitTargets, event: MouseEvent) => void) | boolean;
     /**
      * Called when a node is right-clicked
      * @param nodes - The node that was right-clicked
      * @param hitElements - All elements that were hit by the right-click
      * @param event - The original mouse event
      */
-    onNodeRightClick: (node: Node, hitElements: HitTargets, event: MouseEvent) => void;
+    onNodeRightClick?: ((node: Node, hitElements: HitTargets, event: MouseEvent) => void) | boolean;
     /**
      * Called when a relationship is double-clicked
      * @param relationship - The relationship that was double-clicked
      * @param hitElements - All elements that were hit by the double-click
      * @param event - The original mouse event
      */
-    onRelationshipDoubleClick: (relationship: Relationship, hitElements: HitTargets, event: MouseEvent) => void;
+    onRelationshipDoubleClick?: ((relationship: Relationship, hitElements: HitTargets, event: MouseEvent) => void) | boolean;
     /**
      * Called when a relationship is right-clicked
      * @param relationship - The relationship that was right-clicked
      * @param hitElements - All elements that were hit by the right-click
      * @param event - The original mouse event
      */
-    onRelationshipRightClick: (relationship: Relationship, hitElements: HitTargets, event: MouseEvent) => void;
+    onRelationshipRightClick?: ((relationship: Relationship, hitElements: HitTargets, event: MouseEvent) => void) | boolean;
 };
 /**
  * Click interaction handler that handles click, double click and right click events on

package/lib/interaction-handlers/drag-node-interaction.d.ts

@@ -8,7 +8,7 @@ export type DragNodeInteractionCallbacks = {
      * Called when node(s) are dragged
      * @param nodes - The node(s) being dragged
      */
-    onDrag: (nodes: Node[]) => void;
+    onDrag?: ((nodes: Node[]) => void) | boolean;
 };
 /**
  * Interaction handler for dragging nodes.

package/lib/interaction-handlers/draw-interaction.d.ts

@@ -2,10 +2,16 @@ import { NVL, Node, Relationship } from '@neo4j-nvl/core';
 import { BaseInteraction } from './base';
 /**
  * @internal
+ * @experimental
  */
-export declare class DrawInteraction extends BaseInteraction<{
-    onDrawEnd: (newRelationshipToAdd: Relationship | null, newTargetNodeToAdd: Node | null) => void;
-}> {
+export type DrawInteractionCallbacks = {
+    onDrawEnd?: ((newRelationshipToAdd: Relationship | null, newTargetNodeToAdd: Node | null) => void) | boolean;
+};
+/**
+ * @internal
+ * @experimental
+ */
+export declare class DrawInteraction extends BaseInteraction<DrawInteractionCallbacks> {
     private overlayRenderer;
     private isMoved;
     private isDrawing;

package/lib/interaction-handlers/draw-interaction.js

@@ -4,6 +4,7 @@ import { NODE_EDGE_WIDTH } from '../constants';
 import { BaseInteraction } from './base';
 /**
  * @internal
+ * @experimental
  */
 export class DrawInteraction extends BaseInteraction {
     constructor(nvl) {

package/lib/interaction-handlers/hover-interaction.d.ts

@@ -22,7 +22,7 @@ export type HoverInteractionCallbacks = {
      * @note This callback is called every time the mouse moves,
      * even when no element is hovered or the current element is already hovered.
      */
-    onHover: (element: Node | Relationship, hitElements: HitTargets, event: MouseEvent) => void;
+    onHover?: ((element: Node | Relationship, hitElements: HitTargets, event: MouseEvent) => void) | boolean;
 };
 /**
  * Interaction handler for hovering nodes and relationships.

package/lib/interaction-handlers/multi-select-interaction.d.ts

@@ -16,10 +16,10 @@ export type MultiSelectInteractionCallbacks = {
      * @param nodes - The nodes that were selected
      * @param rels - The relationships that were selected
      */
-    onMultiSelect: ({ nodes, rels }: {
+    onMultiSelect?: (({ nodes, rels }: {
         nodes: Node[];
         rels: Relationship[];
-    }) => void;
+    }) => void) | boolean;
 };
 /**
  * Interaction handler for multi-selecting nodes and relationships.

package/lib/interaction-handlers/pan-interaction.d.ts

@@ -8,10 +8,10 @@ export type PanInteractionCallbacks = {
      * Called when the canvas is panned.
      * @param panning - The panning coordinates
      */
-    onPan: (panning: {
+    onPan?: ((panning: {
         x: number;
         y: number;
-    }) => void;
+    }) => void) | boolean;
 };
 /**
  * Interaction handler for panning the canvas.

package/lib/interaction-handlers/zoom-interaction.d.ts

@@ -8,7 +8,7 @@ export type ZoomInteractionCallbacks = {
      * Called when the canvas is zoomed.
      * @param zoomLevel - The zoom level
      */
-    onZoom: (zoomLevel: number) => void;
+    onZoom?: (zoomLevel: number) => void | boolean;
 };
 /**
  * Interaction handler for zooming the canvas.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neo4j-nvl/interaction-handlers",
-  "version": "0.2.8",
+  "version": "0.2.9",
   "license": "SEE LICENSE IN 'Neo4j Early Access Agreement - Visualization Library.pdf'",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",