@neo4j-nvl/base 2.0.0-c8e499dc → 2.0.0-ec6fdba7

package/dist/types/types/graph-element.d.ts

@@ -1,5 +1,5 @@
-import type { StyledCaption } from '../renderers/domrenderer/shared/types';
-import type { Point } from '../utils/geometry';
+import { Point } from "../utils/geometry.js";
+import { StyledCaption } from "../renderers/domrenderer/shared/types.js";
 /**
  * The base type for graph elements.
  * @private
@@ -7,137 +7,137 @@ import type { Point } from '../utils/geometry';
  * @hidden
  */
 interface GraphElement {
+  /**
+   * The id of the current node or relationship.
+   * Ids need to be unique across all nodes and relationships.
+   * Ids need to be strings and cannot be empty.
+   */
+  readonly id: string;
+  /** The color of the graph element.*/
+  color?: string;
+  /** Whether or not the current node or relationship is selected.*/
+  selected?: boolean;
+  /**
+   * The text to display inside on node or relationship.
+   * @note: If both caption and captions are provided, captions takes precedence.
+   * @note: To provide multiple captions with custom styles, use the {@link captions} property.
+   * @note: Captions are only visible when using the 'canvas' renderer.
+   */
+  caption?: string;
+  /** Whether or not the current node or relationship is disabled.*/
+  disabled?: boolean;
+  /** Whether or not the current node or relationship is hovered.*/
+  hovered?: boolean;
+  /** The caption text size.*/
+  captionSize?: number;
+  /**
+   * The caption align.
+   * Has no affect on self-referring relationships.
+   */
+  captionAlign?: 'top' | 'bottom' | 'center';
+  /**
+   * The caption text and font styles.
+   * @note: To provide a single caption without custom styles, you can also use the {@link caption} property.
+   * @note: Captions are only visible when using the 'canvas' renderer.
+   */
+  captions?: StyledCaption[];
+  /**
+   * An icon to be displayed anywhere on top of the graph element.
+   * Icons are expected to be square.
+   */
+  overlayIcon?: {
+    /** The url to the icon.*/
+    url: string;
     /**
-     * The id of the current node or relationship.
-     * Ids need to be unique across all nodes and relationships.
-     * Ids need to be strings and cannot be empty.
+     * The position of the icon relative to the node or relationship.
+     * The position is a percentage of the node or relationship size.
+     * `[1, 1]` is the bottom right corner of the node or relationship.
+     * `[-1, -1]` is the top left corner of the node or relationship.
+     * @defaultValue `[0, 0]`, the center of the node or relationship.
      */
-    readonly id: string;
-    /** The color of the graph element.*/
-    color?: string;
-    /** Whether or not the current node or relationship is selected.*/
-    selected?: boolean;
+    position?: number[];
     /**
-     * The text to display inside on node or relationship.
-     * @note: If both caption and captions are provided, captions takes precedence.
-     * @note: To provide multiple captions with custom styles, use the {@link captions} property.
-     * @note: Captions are only visible when using the 'canvas' renderer.
+     * The size of the icon relative to the node size or relationship caption size.
+     * The size is a percentage of the node size or relationship caption size.
+     * @defaultValue `1`, the same size as the node size or relationship caption size.
      */
-    caption?: string;
-    /** Whether or not the current node or relationship is disabled.*/
-    disabled?: boolean;
-    /** Whether or not the current node or relationship is hovered.*/
-    hovered?: boolean;
-    /** The caption text size.*/
-    captionSize?: number;
-    /**
-     * The caption align.
-     * Has no affect on self-referring relationships.
-     */
-    captionAlign?: 'top' | 'bottom' | 'center';
-    /**
-     * The caption text and font styles.
-     * @note: To provide a single caption without custom styles, you can also use the {@link caption} property.
-     * @note: Captions are only visible when using the 'canvas' renderer.
-     */
-    captions?: StyledCaption[];
-    /**
-     * An icon to be displayed anywhere on top of the graph element.
-     * Icons are expected to be square.
-     */
-    overlayIcon?: {
-        /** The url to the icon.*/
-        url: string;
-        /**
-         * The position of the icon relative to the node or relationship.
-         * The position is a percentage of the node or relationship size.
-         * `[1, 1]` is the bottom right corner of the node or relationship.
-         * `[-1, -1]` is the top left corner of the node or relationship.
-         * @defaultValue `[0, 0]`, the center of the node or relationship.
-         */
-        position?: number[];
-        /**
-         * The size of the icon relative to the node size or relationship caption size.
-         * The size is a percentage of the node size or relationship caption size.
-         * @defaultValue `1`, the same size as the node size or relationship caption size.
-         */
-        size?: number;
-    };
+    size?: number;
+  };
 }
 export declare const isValidNode: (node: unknown) => node is Node;
 /**
  * A node inside the graph visualization.
  */
 interface Node extends GraphElement {
-    /** The size of the node.*/
-    size?: number;
-    /** Whether or not the current node is pinned.*/
-    pinned?: boolean;
-    /**
-     * @ignore
-     * The x-coordinate for the position of the node.
-     */
-    x?: number;
-    /**
-     * @ignore
-     * The y-coordinate for the position of the node.
-     */
-    y?: number;
-    /** Whether or not the current node is activated.*/
-    activated?: boolean;
-    /**
-     * The url to an icon to display inside the node.
-     * Icons are expected to be black. If the node's background color is dark,
-     * the icon will be inverted to white.
-     * Icons are expected to be square.
-     */
-    icon?: string;
-    /**
-     * The DOM element to display on top of a node.
-     * @experimental
-     */
-    html?: HTMLElement;
+  /** The size of the node.*/
+  size?: number;
+  /** Whether or not the current node is pinned.*/
+  pinned?: boolean;
+  /**
+   * @ignore
+   * The x-coordinate for the position of the node.
+   */
+  x?: number;
+  /**
+   * @ignore
+   * The y-coordinate for the position of the node.
+   */
+  y?: number;
+  /** Whether or not the current node is activated.*/
+  activated?: boolean;
+  /**
+   * The url to an icon to display inside the node.
+   * Icons are expected to be black. If the node's background color is dark,
+   * the icon will be inverted to white.
+   * Icons are expected to be square.
+   */
+  icon?: string;
+  /**
+   * The DOM element to display on top of a node.
+   * @experimental
+   */
+  html?: HTMLElement;
 }
 /**
  * A node returned by {@link NVL.getNodes} with layout coordinates and screen position.
  * `x` and `y` are canvas/layout space; `clientPosition` is relative to the canvas element.
  */
 type NodeWithClientPosition = Node & Point & {
-    clientPosition: Point;
+  clientPosition: Point;
 };
 /**
  * A node with only a subset of its properties.
  */
 type PartialNode = Partial<Node> & {
-    /** The id of the node. */
-    id: string;
+  /** The id of the node. */
+  id: string;
 };
 export declare const isValidRelationship: (relationship: unknown) => relationship is Relationship;
 /**
  * A relationship inside the graph visualization.
  */
 interface Relationship extends GraphElement {
-    /** Node id where the relationship starts from.*/
-    from: string;
-    /** Node id where the relationship points to.*/
-    to: string;
-    /** The relationship type.*/
-    type?: string;
-    /** The width of the relationship.*/
-    width?: number;
-    /**
-     * The DOM element to display on top of a relationship caption.
-     * @experimental
-     * The {@link captionSize} and {@link captionAlign} properties
-     * will affect the position and height of the html container element.
-     */
-    captionHtml?: HTMLElement;
+  /** Node id where the relationship starts from.*/
+  from: string;
+  /** Node id where the relationship points to.*/
+  to: string;
+  /** The relationship type.*/
+  type?: string;
+  /** The width of the relationship.*/
+  width?: number;
+  /**
+   * The DOM element to display on top of a relationship caption.
+   * @experimental
+   * The {@link captionSize} and {@link captionAlign} properties
+   * will affect the position and height of the html container element.
+   */
+  captionHtml?: HTMLElement;
 }
 /**
  * A relationship with only a subset of its properties.
  */
 type PartialRelationship = Partial<Relationship> & {
-    /** The id of the relationship. */
-    id: string;
+  /** The id of the relationship. */
+  id: string;
 };
-export type { Node, NodeWithClientPosition, Relationship, PartialNode, PartialRelationship };
+export type { Node, NodeWithClientPosition, PartialNode, PartialRelationship, Relationship };

package/dist/types/types/nvl-window-functions.d.ts

@@ -1,16 +1,15 @@
-import type { Node, NodeWithClientPosition, Relationship } from './graph-element';
+import { Node, NodeWithClientPosition, Relationship } from "./graph-element.js";
 export interface NvlWindow {
-    __Nvl_dumpNodes: (instanceId?: string) => NodeWithClientPosition[];
-    __Nvl_dumpRelationships: (instanceId?: string) => Relationship[];
-    __Nvl_getNodesOnScreen: (instanceId?: string) => {
-        nodes: Node[];
-        rels: Relationship[];
-    };
-    __Nvl_registerDoneCallback: (cb: () => void, instanceId: string) => void;
-    __Nvl_getZoomLevel: (instanceId?: string) => number;
+  __Nvl_dumpNodes: (instanceId?: string) => NodeWithClientPosition[];
+  __Nvl_dumpRelationships: (instanceId?: string) => Relationship[];
+  __Nvl_getNodesOnScreen: (instanceId?: string) => {
+    nodes: Node[];
+    rels: Relationship[];
+  };
+  __Nvl_registerDoneCallback: (cb: () => void, instanceId: string) => void;
+  __Nvl_getZoomLevel: (instanceId?: string) => number;
 }
 declare global {
-    interface Window extends NvlWindow {
-    }
-    const SEGMENT_WRITE_KEY: string;
-}
+  interface Window extends NvlWindow {}
+  const SEGMENT_WRITE_KEY: string;
+}

package/dist/types/types/utils.d.ts

@@ -1 +1 @@
-export declare const typedObjectEntries: <T>(obj: T) => [keyof T, T[keyof T]][];
+export declare const typedObjectEntries: <T>(obj: T) => [keyof T, T[keyof T]][];

package/dist/types/utils/ariaUtils.d.ts

@@ -1,3 +1,3 @@
-import type { NvlState } from '../modules/state/types';
+import { NvlState } from "../modules/state/types.js";
 export declare const enrichWithAria: (canvasParent: HTMLElement, instanceId: string) => HTMLDivElement;
-export declare const updateAriaDescription: (state: NvlState, descriptionElement: HTMLDivElement) => void;
+export declare const updateAriaDescription: (state: NvlState, descriptionElement: HTMLDivElement) => void;

package/dist/types/utils/canvasManagement.d.ts

@@ -36,4 +36,4 @@ export declare const measureTextCached: (ctx: CanvasRenderingContext2D, text: st
 /**
  * Clears the text measurement cache.
  */
-export declare const clearTextMeasurementCache: () => void;
+export declare const clearTextMeasurementCache: () => void;

package/dist/types/utils/circularUtils.d.ts

@@ -1,3 +1,3 @@
-import type { Node } from '../types/graph-element';
+import { Node } from "../types/graph-element.js";
 export declare const MIN_RADIUS = 250;
-export declare const getPositionsOnCircle: (nodes: Node[]) => Record<string, Node>;
+export declare const getPositionsOnCircle: (nodes: Node[]) => Record<string, Node>;

package/dist/types/utils/clusterGeometry.d.ts

@@ -1,14 +1,14 @@
-import { type Point } from './geometry';
+import { Point } from "./geometry.js";
 /** Extra world-space padding around each member disk before taking the cluster hull. */
 export declare const ClusterHullPadding = 14;
 /** Circumference samples per member disk before taking the convex hull. */
 export declare const DiskSampleCount = 8;
 export type ClusterMemberDisk = Point & {
-    radius: number;
+  radius: number;
 };
 /**
  * Fits a convex hull around the given disks by sampling each member circumference.
  * @param members - The cluster member disks to fit the hull around.
  * @returns The fitted hull, or null if fewer than two members have a usable position/radius.
  */
-export declare const fitClusterHull: (members: ClusterMemberDisk[]) => Point[] | null;
+export declare const fitClusterHull: (members: ClusterMemberDisk[]) => Point[] | null;

package/dist/types/utils/clusterHitRegions.d.ts

@@ -1,20 +1,20 @@
-import { type CoarsenedGraph, type Sun } from '../layouts/forcedirectedlayout/clustering/types';
-import type { Cluster, ClusterId } from '../modules/state/types';
-import type { Node } from '../types/graph-element';
-import { type ClusterMemberDisk } from './clusterGeometry';
-import { type Point } from './geometry';
+import { Point } from "./geometry.js";
+import { Node } from "../types/graph-element.js";
+import { Cluster, ClusterId } from "../modules/state/types.js";
+import { CoarsenedGraph, Sun } from "../layouts/forcedirectedlayout/clustering/types.js";
+import { ClusterMemberDisk } from "./clusterGeometry.js";
 /**
  * A fitted cluster hull region used for decoration and hit-testing.
  */
 export type ClusterHitRegion = Cluster & {
-    /** Convex hull used for picking / decoration. */
-    hull: Point[];
-    /** Layout sun original id (e.g. `synth-sun:${id}`). */
-    sunOriginalId: string;
+  /** Convex hull used for picking / decoration. */
+  hull: Point[];
+  /** Layout sun original id (e.g. `synth-sun:${id}`). */
+  sunOriginalId: string;
 };
 export type MultiMemberCluster = {
-    sun: Sun;
-    nodeIds: string[];
+  sun: Sun;
+  nodeIds: string[];
 };
 /**
  * Returns each multi-member first-level sun system in a coarsening hierarchy.
@@ -39,4 +39,4 @@ export declare const collectMemberDisks: (nodeIds: string[], idToPosition: Reado
  * @param clusterIdsBySun - Cluster id per synthetic cluster sun, keyed by sun `originalId`.
  * @returns Fitted cluster hit regions.
  */
-export declare const buildClusterByHitRegions: (subGraphs: CoarsenedGraph[], idToPosition: Readonly<Record<string, Point>>, idToItem: Record<string, Node>, clusterIdsBySun: ReadonlyMap<string, ClusterId>) => ClusterHitRegion[];
+export declare const buildClusterByHitRegions: (subGraphs: CoarsenedGraph[], idToPosition: Readonly<Record<string, Point>>, idToItem: Record<string, Node>, clusterIdsBySun: ReadonlyMap<string, ClusterId>) => ClusterHitRegion[];

package/dist/types/utils/colorUtils.d.ts

@@ -1,4 +1,4 @@
-import colorString from 'color-string';
+import colorString from "color-string";
 /**
  * Determines whether a black or white font color is more readable for a given background color.
  * @param color - The background color.
@@ -11,4 +11,4 @@ export declare const rgbaToVec4: (rgba: number[]) => number[];
 export declare const rgbToVec3: (rgb: number[]) => number[];
 export declare const colorToUIntArray: (color: string) => number;
 export declare const colorToVec3: (color: string) => number[];
-export declare const colorToVec4: (color: string) => number[];
+export declare const colorToVec4: (color: string) => number[];

package/dist/types/utils/constants.d.ts

@@ -28,11 +28,11 @@ export declare const TextColorInverse = "#FFFFFF";
 export declare const MaxArrowCountWithShadows = 500;
 export declare const DefaultFontFace = "\"Open Sans\", sans-serif";
 export declare const absFillStyle: {
-    position: string;
-    top: number;
-    bottom: number;
-    left: number;
-    right: number;
+  position: string;
+  top: number;
+  bottom: number;
+  left: number;
+  right: number;
 };
 /**
  * Factor to make nodes same size in WebGL renderer and Canvas.
@@ -47,4 +47,4 @@ export declare const getDevicePixelRatio: () => number;
 export declare const HtmlCaptionMinWidthThreshold = 5;
 /** Min on-screen icon size (px) before we skip drawing; avoids unreadable bitmaps when zoomed out. */
 export declare const MinNodeIconScreenPx = 10;
-export declare const allowedWrappers: string[];
+export declare const allowedWrappers: string[];

package/dist/types/utils/errors.d.ts

@@ -4,9 +4,9 @@
  * @hidden
  */
 export declare class CompatibilityError extends Error {
-    /**
-     * Returns the error message of the compatibility error.
-     * @returns The error message.
-     */
-    toString(): string;
-}
+  /**
+   * Returns the error message of the compatibility error.
+   * @returns The error message.
+   */
+  toString(): string;
+}

package/dist/types/utils/geometry.d.ts

@@ -1,12 +1,12 @@
-import type { Node } from '../types/graph-element';
+import { Node } from "../types/graph-element.js";
 /**
  * An object representing a point in 2D space.
  */
 export interface Point {
-    /** The x coordinate of the point. */
-    x: number;
-    /** The y coordinate of the point. */
-    y: number;
+  /** The x coordinate of the point. */
+  x: number;
+  /** The y coordinate of the point. */
+  y: number;
 }
 /**
  * Returns true when value is a finite number (not NaN or Infinity).
@@ -35,48 +35,48 @@ export declare const pointEqual: (p1: Node | Point, p2: Node | Point) => boolean
  * @param p2 - The second point of the segment.
  */
 export declare class Segment {
-    /** The first point of the segment. */
-    readonly p1: Point;
-    /** The second point of the segment. */
-    readonly p2: Point;
-    /** The unit vector of the segment. */
-    readonly unit: Point;
-    /** The unit normal vector of the segment. */
-    readonly norm: Point;
-    /** The length of the segment. */
-    readonly length: number;
-    /** The vector between the two points of the segment. */
-    readonly vector: Point;
-    constructor(p1: Point, p2: Point);
-    /**
-     * Get the vector between the two points of the segment.
-     * @returns The vector between the two points of the segment.
-     * @private
-     * @see {@link https://en.wikipedia.org/wiki/Vector_(spatial)}
-     */
-    private getVector;
-    /**
-     * Get the length of the vector between the two points of the segment.
-     * @returns The length of the segment.
-     * @private
-     * @see {@link https://en.wikipedia.org/wiki/Vector_(spatial)#Length}
-     */
-    private getLength;
-    /**
-     * Get the unit vector of the two points of the segment.
-     * @returns The unit vector of the segment.
-     * @private
-     * @see {@link https://en.wikipedia.org/wiki/Euclidean_vector#Unit_vector}
-     * @see {@link https://en.wikipedia.org/wiki/Unit_vector}
-     */
-    private getUnitVector;
-    /**
-     * Get the unit normal vector of the two points of the segment.
-     * @returns The unit normal vector of the segment.
-     * @private
-     * @see {@link https://en.wikipedia.org/wiki/Normal_(geometry)}
-     */
-    private getUnitNormalVector;
+  /** The first point of the segment. */
+  readonly p1: Point;
+  /** The second point of the segment. */
+  readonly p2: Point;
+  /** The unit vector of the segment. */
+  readonly unit: Point;
+  /** The unit normal vector of the segment. */
+  readonly norm: Point;
+  /** The length of the segment. */
+  readonly length: number;
+  /** The vector between the two points of the segment. */
+  readonly vector: Point;
+  constructor(p1: Point, p2: Point);
+  /**
+   * Get the vector between the two points of the segment.
+   * @returns The vector between the two points of the segment.
+   * @private
+   * @see {@link https://en.wikipedia.org/wiki/Vector_(spatial)}
+   */
+  private getVector;
+  /**
+   * Get the length of the vector between the two points of the segment.
+   * @returns The length of the segment.
+   * @private
+   * @see {@link https://en.wikipedia.org/wiki/Vector_(spatial)#Length}
+   */
+  private getLength;
+  /**
+   * Get the unit vector of the two points of the segment.
+   * @returns The unit vector of the segment.
+   * @private
+   * @see {@link https://en.wikipedia.org/wiki/Euclidean_vector#Unit_vector}
+   * @see {@link https://en.wikipedia.org/wiki/Unit_vector}
+   */
+  private getUnitVector;
+  /**
+   * Get the unit normal vector of the two points of the segment.
+   * @returns The unit normal vector of the segment.
+   * @private
+   * @see {@link https://en.wikipedia.org/wiki/Normal_(geometry)}
+   */
+  private getUnitNormalVector;
 }
 /**
  * Calculates the projection ratio between two vectors.
@@ -168,4 +168,4 @@ export declare const isPointInConvexPolygon: (point: Point, polygon: Point[]) =>
  * @param polygon - Polygon vertices in order around the boundary.
  * @returns The absolute area of the polygon.
  */
-export declare const getPolygonArea: (polygon: Point[]) => number;
+export declare const getPolygonArea: (polygon: Point[]) => number;

package/dist/types/utils/graphObjectUtils.d.ts

@@ -1,8 +1,8 @@
-import type { DataSet } from '../modules/dataset';
-import type { Node, Relationship } from '../types/graph-element';
+import { Node, Relationship } from "../types/graph-element.js";
+import { DataSet } from "../modules/dataset.js";
 export type FlatRel = Omit<Relationship & {
-    bundledRels: Omit<Relationship, 'from' | 'to'>[];
-    key: string;
+  bundledRels: Omit<Relationship, 'from' | 'to'>[];
+  key: string;
 }, 'id'>;
 export declare const getRelItemKey: (from: Node["id"], to: Node["id"]) => string;
 export declare const relItemsToFlatKeySet: (relItems: Relationship[]) => Set<string>;
@@ -16,11 +16,11 @@ export declare const relItemsToFlatKeySet: (relItems: Relationship[]) => Set<str
  */
 export declare const relItemsToFlatList: (relItems: Relationship[], disabledItemColor?: string) => FlatRel[];
 export declare const getAdjNodesMapAndRelMap: (rels: Relationship[]) => {
-    adjNodesMap: Record<string, Set<string>>;
-    relMap: Record<string, Relationship[]>;
+  adjNodesMap: Record<string, Set<string>>;
+  relMap: Record<string, Relationship[]>;
 };
 export declare const getConnectedNodesAndRels: (addedNodes: Set<Node["id"]>, addedRels: Set<Relationship["id"]>, nodes: DataSet<Node>, rels: DataSet<Relationship>) => {
-    connectedNodes: Record<string, Node>;
-    connectedRels: Record<string, Relationship>;
+  connectedNodes: Record<string, Node>;
+  connectedRels: Record<string, Relationship>;
 };
-export declare const hasSizeChanged: (graphObjectUpdates?: Node[]) => boolean;
+export declare const hasSizeChanged: (graphObjectUpdates?: Node[]) => boolean;