@neo4j-nvl/base 1.0.0 → 1.1.0

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

@@ -4,7 +4,7 @@ export type FlatRel = Omit<Relationship & {
     bundledRels: Omit<Relationship, 'from' | 'to'>[];
     key: string;
 }, 'id'>;
-export declare const getRelItemKey: (from: Node['id'], to: Node['id']) => string;
+export declare const getRelItemKey: (from: Node["id"], to: Node["id"]) => string;
 export declare const relItemsToFlatKeySet: (relItems: Relationship[]) => Set<string>;
 /**
  * Flattens a list of relationships so only one relationship remains between two nodes.
@@ -19,7 +19,7 @@ export declare const getAdjNodesMapAndRelMap: (rels: 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>) => {
+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>;
 };

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

@@ -31,7 +31,7 @@ export declare const recordCollector: (graphElements: NestedGraphElements[]) =>
  *
  * @see {@link https://neo4j.com/docs/api/javascript-driver/current/class/lib6/result-transformers.js~ResultTransformers.html|ResultTransformers on Neo4j JS Driver API Docs}
  */
-export declare const nvlResultTransformer: import("neo4j-driver-core/types/result-transformers").ResultTransformer<{
+export declare const nvlResultTransformer: import("neo4j-driver-core").ResultTransformer<{
     /** The nodes of the graph. */
     nodes: NvlNode[];
     /** The relationships of the graph. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neo4j-nvl/base",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "license": "SEE LICENSE IN 'LICENSE.txt'",
   "homepage": "https://neo4j.com/docs/nvl/current/",
   "description": "Base library for the Neo4j Visualization Library",
@@ -29,32 +29,32 @@
     "postpack": "rm LICENSE.txt && rm CHANGELOG.md"
   },
   "dependencies": {
-    "@neo4j-nvl/layout-workers": "1.0.0",
-    "@segment/analytics-next": "^1.70.0",
-    "color-string": "^1.9.1",
-    "d3-force": "^3.0.0",
-    "gl-matrix": "^3.3.0",
-    "glsl-inject-defines": "^1.0.3",
-    "lodash": "4.17.21",
-    "loglevel": "^1.8.0",
-    "mobx": "^3.2.2",
-    "node-pid-controller": "^1.0.1",
-    "resizelistener": "^1.1.0",
+    "@neo4j-nvl/layout-workers": "1.1.0",
+    "@segment/analytics-next": "1.81.1",
+    "color-string": "1.9.1",
+    "d3-force": "3.0.0",
+    "gl-matrix": "3.4.4",
+    "glsl-inject-defines": "1.0.3",
+    "lodash": "4.17.23",
+    "loglevel": "1.9.2",
+    "mobx": "3.6.2",
+    "node-pid-controller": "1.0.1",
+    "resizelistener": "1.1.0",
     "tinycolor2": "1.6.0",
-    "uuid": "^8.3.2"
+    "uuid": "8.3.2"
   },
   "devDependencies": {
-    "@babel/core": "^7.21.4",
-    "@types/color-string": "^1.5.5",
-    "@types/d3-force": "^3.0.3",
-    "@types/lodash": "4.14.202",
+    "@babel/core": "7.28.5",
+    "@types/color-string": "1.5.5",
+    "@types/d3-force": "3.0.10",
+    "@types/lodash": "4.17.21",
     "@types/segment-analytics": "0.0.38",
-    "@types/tinycolor2": "^1.4.6",
-    "babel-loader": "^8.2.5",
-    "copy-webpack-plugin": "^11.0.0",
-    "neo4j-driver": "^5.26.0",
-    "webpack": "^5.75.0",
-    "webpack-cli": "^5.0.0"
+    "@types/tinycolor2": "1.4.6",
+    "babel-loader": "8.4.1",
+    "copy-webpack-plugin": "11.0.0",
+    "neo4j-driver": "5.28.2",
+    "webpack": "5.103.0",
+    "webpack-cli": "5.1.4"
   },
   "peerDependencies": {
     "neo4j-driver": "*"

package/dist/types/modules/performance.d.ts

@@ -1,93 +0,0 @@
-/**
- * A class capable of measuring performance.
- * Usage:
- * When you want to measure a block of code, start by calling
- * performanceTesterInstance.startTest() or
- * performanceTesterInstance.startTest('Some readable name') if you
- * want to control how it prints.
- * After the block of code ends, call performanceTesterInstance.endTest()
- */
-export default class PerformanceTester {
-    disabled: boolean;
-    tree: PerformanceTree;
-    /**
-     * Starts a performance measurement. Every call to this method must be followed
-     * by a call to endTest(). Tests can be nested.
-     * @param  {String} measurement String identifying this measurement. Only used for printing, so
-     *                       keep it human readable.
-     */
-    startTest(measurement: string): void;
-    /**
-     * Ends the last started test, giving it an end time.
-     */
-    endTest(): void;
-    /**
-     * Clears all performance measurements
-     */
-    reset(): void;
-    /**
-     * Prints all the performance measurements to console by calling
-     * print() on the performance tree.
-     */
-    print(): void;
-}
-/**
- * A tree of PerformanceTreeNodes.
- * @type {PerformanceTree}
- */
-declare class PerformanceTree {
-    root: any;
-    current: any;
-    /**
-     * Empties the tree.
-     */
-    clear(): void;
-    /**
-     * Adds a new node to the tree at the current open position, containing the
-     * data provided. It also sets the newly added node as the currently open one.
-     * @param {PerformanceData} data A PerformanceData object.
-     */
-    add(data: PerformanceData): void;
-    /**
-     * The tree always maintains a pointer to the currently open node. This
-     * method closes that node, closes the data object in contains, and opens
-     * the parent node.
-     */
-    close(): void;
-    /**
-     * Gets the data object of the currently open node.
-     * @return {PerformanceData} The data object of the currently open node.
-     */
-    getCurrentData(): PerformanceData;
-    /**
-     * Prints this entire tree to the console.
-     */
-    print(): void;
-}
-/**
- * Performance measurement data.
- * @type {PerformanceData}
- */
-declare class PerformanceData {
-    /**
-     * Instantiates a data measurement, giving it the start time when constructor is called.
-     * Remember that you also have to call close on this object to make it valid.
-     * @param  {String} name String identifying this measurement. Only used for printing, so
-     *                       keep it human readable.
-     * @return {PerformanceData} The data object
-     */
-    constructor(name: string);
-    name: any;
-    startTime: any;
-    endTime: any;
-    /**
-     * Sets the endTime measurement on this data object.
-     */
-    close(): void;
-    /**
-     * Gets the time spent on this measurement
-     * @return {Number} Time spent in ms
-     */
-    _timeSpent(): number;
-}
-export {};

package/dist/types/renderers/canvasrenderer/CanvasRenderer.d.ts

@@ -1,93 +0,0 @@
-import type { NvlState } from '../../modules/state/types';
-import type { Node } from '../../types/graph-element';
-import type { Point } from '../../utils/geometry';
-import type { HitTargetNode, HitTargetRelationship } from '../../utils/hittest';
-import ArrowBundler from './arrows/ArrowBundler';
-export default class CanvasRenderer {
-    arrowBundler: ArrowBundler;
-    private activeNodes;
-    private canvas;
-    private context;
-    private state;
-    private stateDisposers;
-    private relationshipThreshold;
-    private animationHandler;
-    private imageCache;
-    private needsRun;
-    private nodeVersion;
-    private relVersion;
-    private waypointVersion;
-    private ellipsisWidth;
-    /**
-     * Creates a new CanvasRenderer.
-     * @param canvas {HTMLCanvasElement} - The canvas to render on.
-     * @param context {CanvasRenderingContext2D} - The canvas context.
-     * @param state {NvlState} - The state.
-     * @param options {{ relationshipThreshold: number }} - The visualization options.
-     */
-    constructor(canvas: HTMLCanvasElement, context: CanvasRenderingContext2D | null, state: NvlState, { relationshipThreshold }?: {
-        relationshipThreshold?: number;
-    });
-    /**
-     * Checks if the renderer needs to run.
-     * @returns Whether the renderer needs to run.
-     */
-    needsToRun(): boolean;
-    /**
-     * Processes the updates in nodes and relationships.
-     */
-    processUpdates(): void;
-    /**
-     * Draws the nodes and relationships to their positions on the canvas.
-     * @param positionArray {Node[]} - The array of nodes to draw
-     * @param options {any} - The options for the render
-     */
-    render(positionArray: Node[], options?: {
-        canvas?: HTMLCanvasElement;
-        context?: CanvasRenderingContext2D;
-        backgroundColor?: string;
-        ignoreAnimations?: boolean;
-        showCaptions?: boolean;
-    }): void;
-    private getRelationshipsToRender;
-    private getNodesToRender;
-    private renderNodes;
-    private renderRelationships;
-    /**
-     * Returns the nodes at the pointer position
-     * @param pointer - The position of the pointer.
-     * @returns The nodes at the pointer position.
-     * @todo Sort nodes by distance descending
-     */
-    getNodesAt(pointer: Point, hitNodeMarginWidth?: number): HitTargetNode[];
-    /**
-     * Returns the relationships at the pointer position
-     * @param pointer - The position of the pointer.
-     * @returns The relationships at the pointer position.
-     * @todo: sort relationships by distance descending
-     */
-    getRelsAt(pointer: Point): HitTargetRelationship[];
-    destroy(): void;
-    /**
-     * Checks if the bounding box is outside of the screen.
-     * @param boundingBox - The bounding box to check.
-     * @param clientWidth - The client width of the canvas.
-     * @param clientHeight - The client height of the canvas.
-     * @returns Whether the bounding box is off screen.
-     * @remarks This check doesn't catch all items that are off screen but its simple and removes many of them
-     */
-    private isBoundingBoxOffScreen;
-    /**
-     * Handles the channel's additions, removals and updates and adds or removes the id from the active nodes.
-     * @param channel {Channel<Node>} - The channel to process
-     * @param fullData {DataSet<Node>} - The full data
-     * @param processUpdates {boolean} - Whether to process channel updates as well
-     */
-    private handleChannelUpdate;
-    /**
-     * Handles zoom and pan on the canvas.
-     * @param context {CanvasRenderingContext2D} - The canvas context
-     * @param canvas {HTMLCanvasElement} - The canvas
-     */
-    private zoomAndPan;
-}

package/dist/types/renderers/canvasrenderer/ImageCache.d.ts

@@ -1,11 +0,0 @@
-import type { Cache } from './types';
-declare class ImageCache {
-    cache: Cache;
-    constructor();
-    getImage(src: string, inverted?: boolean): HTMLCanvasElement;
-    private getOrCreateEntry;
-    private invertCanvas;
-    private loadImage;
-    private drawIfNeeded;
-}
-export default ImageCache;

package/dist/types/renderers/canvasrenderer/arrows/arrows.d.ts

@@ -1,55 +0,0 @@
-import type { BorderStyle, DisabledItemStyles } from '../../../modules/state/types';
-import type { Node, Relationship } from '../../../types/graph-element';
-import type { Point } from '../../../utils/geometry';
-import type ImageCache from '../ImageCache';
-import type ArrowBundle from './ArrowBundle';
-/**
- * This function calculates the difference in radius between two nodes.
- * @param toArrowGap - The gap between the node and the arrow on the to side.
- * @param fromArrowGap - The gap between the node and the arrow on the from side.
- * @returns The difference in radius between the two nodes.
- * @comment can be affected for example by the label crust and selected ring
- * as well as a gap between the node and the arrow on it's side.
- */
-export declare const getRadiusDifference: (toArrowGap: number, fromArrowGap: number) => number;
-/**
- * This function calculates the coordinates of the via point
- * between two nodes. The via point is used to bend the edge
- * between the two nodes.
- * @param fromNode - The node the edge starts from.
- * @param toNode - The node the edge ends at.
- * @param fromArrowGap - The gap between the node and the arrow on the from side.
- * @param toArrowGap - The gap between the node and the arrow on the to side.
- * @returns The coordinates of the via point.
- */
-export declare const getViaCoordinates: (fromNode: Node, toNode: Node, fromArrowGap: number, toArrowGap: number, rel: Relationship, bundle: ArrowBundle) => Point;
-export declare const getPointsForStraight: (rel: Relationship, bundle: ArrowBundle, fromNode: Node, toNode: Node, showLabel: boolean, curved?: boolean) => Point[];
-/**
- * Draws a label for a relationship.
- * @param ctx - The canvas context.
- * @param x - The x coordinate of the label.
- * @param y - The y coordinate of the label.
- * @param angle - The angle of the label.
- * @param maxWidth - The maximum width of the label.
- * @param rel - The relationship.
- * @param bundle - The arrow bundle.
- * @param disabledItemStyles - The styles for disabled items.
- * @param fontColor - The color of the font.
- * @param flip - Whether to flip the label.
- */
-export declare const drawLabel: (ctx: CanvasRenderingContext2D, point: Point, angle: number, maxWidth: number, rel: Relationship, bundle: ArrowBundle, disabledItemStyles: DisabledItemStyles, fontColor: string, flip?: boolean) => void;
-export declare const renderWaypointArrow: (ctx: CanvasRenderingContext2D, rel: Relationship, from: Node, to: Node, bundle: ArrowBundle, imageCache: ImageCache, showLabel: boolean, drawCurves: boolean, selectedBorderStyle: BorderStyle, disabledItemStyles: DisabledItemStyles, defaultRelationshipColor?: string) => void;
-export declare const renderSelfArrow: (ctx: CanvasRenderingContext2D, rel: Relationship, node: Node, bundle: ArrowBundle, imageCache: ImageCache, showLabel: boolean, selectedBorderStyle: BorderStyle, disabledItemStyles: DisabledItemStyles, defaultRelationshipColor?: string) => void;
-export declare const renderArrow: (ctx: CanvasRenderingContext2D, rel: Relationship, fromNode: Node, toNode: Node, bundle: ArrowBundle, imageCache: ImageCache, showLabel: boolean, selectedBorderStyle: BorderStyle, disabledItemStyles: DisabledItemStyles, defaultRelationshipColor: string, drawCurves?: boolean) => void;
-export declare const distanceToEdge: (pos: Point, rel: Relationship, fromNode: Node, toNode: Node, bundle: ArrowBundle, showLabel: boolean, drawCurves?: boolean) => number;
-/**
- * Returns the bounding box of the arrow.
- * @param rel - The relationship to get the bounding box for.
- * @param bundle - The arrow bundle the relationship is part of.
- * @param fromNode - The node the relationship is coming from.
- * @param toNode - The node the relationship is going to.
- * @param showLabel - Whether or not a label is shown.
- * @param drawCurves - Whether or the relationship is drawn as a curve.
- * @returns The bounding box of the arrow.
- */
-export declare const getBoundingBox: (rel: Relationship, bundle: ArrowBundle, fromNode: Node, toNode: Node, showLabel?: boolean, drawCurves?: boolean) => DOMRect | null;

package/dist/types/renderers/canvasrenderer/nodes/nodes.d.ts

@@ -1,59 +0,0 @@
-import type { BorderStyles, DisabledItemStyles } from '../../../modules/state/types';
-import type { Node } from '../../../types/graph-element';
-import type AnimationHandler from '../AnimationHandler';
-type RingStyle = {
-    width: number;
-    color: string;
-};
-/**
- * Returns an array of styles for the rings of a node.
- * It takes the node as an argument, and an optional array of size animations.
- * If the node is selected, it returns the selectedStyle.rings array.
- * If the node is not selected, it returns an array containing only one object with
- * a width of 0 and an empty color.
- * @param node - The node to get the ring styles for.
- * @param animationHandler - The animation handler.
- * @param nodeBorderStyles - The node border styles.
- * @returns An array of ring styles.
- */
-export declare const getRingStyles: (node: Node, animationHandler: AnimationHandler, nodeBorderStyles: any) => RingStyle[];
-/**
- * Returns the bounding box of a node with the given x, y, and size properties.
- * If no size is given, the default size is used.
- * @param Node - The node to get the bounding box for.
- * @returns The bounding box of the node.
- */
-export declare const getBoundingBox: ({ x, y, size }: Node) => DOMRect;
-/**
- * Returns the caption font size that should be used
- * for the given info level and node diameter.
- * @param infoLevel {number} - The info level.
- * @param nodeRadius {number} - The radius of the node.
- * @param captionSize {number} - The size of the caption.
- * @returns The font size.
- */
-export declare const infoLevelToFontSize: (infoLevel: number, nodeRadius?: number, captionSize?: number, hasIcon?: boolean) => number;
-/**
- * Returns maximum length of lines
- * @param lines {array} - The lines info
- * @returns The font size.
- */
-export declare const findMaxLength: (lines: any[], ctx: CanvasRenderingContext2D, pixelRatio: number) => number;
-/**
- * Returns minimum length of lines
- * @param lines {array} - The lines info
- * @returns The font size.
- */
-export declare const findMinLength: (lines: any[], ctx: CanvasRenderingContext2D, pixelRatio: number) => any;
-/**
- * Draws a node with the given context, node, and image cache.
- * @param ctx {any} - The context to draw the node on.
- * @param node {Node} - The node to draw.
- * @param imageCache {any} - The image cache to use.
- * @param animationHandler {AnimationHandler} - The animation handler.
- * @param nodeBorderStyles {BorderStyles} - The node border styles.
- * @param disabledItemStyles {DisabledItemStyles} - The styles for the disabled items.
- * @param zoomLevel {number} - The current zoom level.
- */
-export declare const drawNode: (ctx: CanvasRenderingContext2D, node: Node, imageCache: any, animationHandler: AnimationHandler, nodeBorderStyles: BorderStyles, disabledItemStyles: DisabledItemStyles, defaultNodeColor?: string, ellipsisWidth?: number, zoomLevel?: number) => void;
-export {};