@neo4j-nvl/base 0.3.9 → 1.0.0

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

@@ -3,9 +3,7 @@ import type { TextSegment } from './types';
 export declare const fontThresholds: [number, number][];
 /**
  * This function takes color in hex format or rgb() or rgba() format and overrides the opacity. Returns rgba() string.
- * @param {string} color
- * @param {number} opacity
- * @returns {string} rgba() string with the given opacity
+ * @param color - * @param opacity - * @returns rgba() string with the given opacity.
  */
 export declare const overrideOpacity: (color: string, opacity: number) => string;
 /**
@@ -20,22 +18,23 @@ type ArrowHeadParameters = {
 };
 /**
  * Creates an arrowhead shape using a polygon.
- * @param {CanvasRenderingContext2D} ctx - The canvas context to draw on.
- * @param {number} headLineWidth - The width of the arrowhead's outline.
- * @param {string} color - The color of the arrowhead.
- * @param {ArrowHeadParameters} arrowHeadParameters - The parameters for the arrowhead.
- * @param {boolean} fill - Whether or not to fill the triangle.
- * @param {boolean} stroke - Whether or not to stroke the triangle.
+ * @param ctx - The canvas context to draw on.
+ * @param headLineWidth - The width of the arrowhead's outline.
+ * @param color - The color of the arrowhead.
+ * @param arrowHeadParameters - The parameters for the arrowhead.
+ * @param fill - Whether or not to fill the triangle.
+ * @param stroke - Whether or not to stroke the triangle.
  */
 export declare const drawArrowHead: (ctx: CanvasRenderingContext2D, headLineWidth: number, color: string, arrowHeadParameters: ArrowHeadParameters, fill?: boolean, stroke?: boolean) => void;
 /**
  * Draws borders around a node with a given array of border styles
- * @param {CanvasRenderingContext2D} ctx - The canvas context
- * @param {number} x - The x coordinate of the node
- * @param {number} y - The y coordinate of the node
- * @param {number} innerRadius - The inner radius of the node without any border
- * @param {Array} borderStyles - An array of border styles
+ * @param ctx - The canvas context.
+ * @param x - The x coordinate of the node.
+ * @param y - The y coordinate of the node.
+ * @param innerRadius - The inner radius of the node without any border.
+ * @param borderStyles - An array of border styles.
  * @internal
+ * @hidden
  */
 export declare const drawCircleBand: (ctx: CanvasRenderingContext2D, x: number, y: number, innerRadius: number, borderStyles: {
     width: number;
@@ -44,13 +43,13 @@ export declare const drawCircleBand: (ctx: CanvasRenderingContext2D, x: number,
 export declare const drawCircle: (ctx: CanvasRenderingContext2D, x: number, y: number, r: number) => void;
 /**
  * Fill a circle band with a gradient from a certain color to transparent
- * @param {CanvasRenderingContext2D} ctx - The canvas context
- * @param {number} x - The x coordinate of the node
- * @param {number} y - The y coordinate of the node
- * @param {string} color - The color of the gradient
- * @param {number} radius - The inner radius of the node without any border
- * @param {number} blur - The blur radius of the gradient
- * @param {number} maxOpacity - The maximum opacity of the gradient
+ * @param ctx - The canvas context.
+ * @param x - The x coordinate of the node.
+ * @param y - The y coordinate of the node.
+ * @param color - The color of the gradient.
+ * @param radius - The inner radius of the node without any border.
+ * @param blur - The blur radius of the gradient.
+ * @param maxOpacity - The maximum opacity of the gradient.
  */
 export declare const drawGradientCircleBand: (ctx: CanvasRenderingContext2D, x: number, y: number, color: string, radius: number, blur: number, maxOpacity?: number) => void;
 /**

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

@@ -4,11 +4,11 @@ export declare const ellipsisChar = "\u2026";
 /**
  * This is the main function that tries to fit a text on one or more lines
  *
- * @param {string} text = The full string to place
- * @param {function} measureWidth - a function that returns the width of a string as pixels on the canvas
- * @param {function} getAvailbleWidth - A function providing the pixel width for a line index
- * @param {number} numberOfLines - How many lines is availble for this placement
- * @param {boolean} allowedToGiveUp - If cannot fit on last avilble line - should we give up or place as much as we can
+ * @param text - = The full string to place.
+ * @param measureWidth - A function that returns the width of a string as pixels on the canvas.
+ * @param getAvailableWidth - A function providing the pixel width for a line index.
+ * @param numberOfLines - How many lines is available for this placement.
+ * @param allowedToGiveUp - If cannot fit on last available line - should we give up or place as much as we can.
  *
  * @return  array of text lines
  */
@@ -16,24 +16,24 @@ export declare const tryWithNumberOfLines: (text: string, measureWidth: (text: s
 /**
  * This functions tries to fit the text in a given number of lines and only linebreak on whitespace
  *
- * @param {string} text = The full string to place
- * @param {function} measureWidth - a function that returns the width of a string as pixels on the canvas
- * @param {function} getAvailbleWidth - A function providing the pixel width for a line index
- * @param {number} numberOfLines - How many lines is availble for this placement
+ * @param text - = The full string to place.
+ * @param measureWidth - A function that returns the width of a string as pixels on the canvas.
+ * @param getAvailableWidth - A function providing the pixel width for a line index.
+ * @param numberOfLines - How many lines is available for this placement.
  *
  * @return  array of text lines
  */
 export declare const tryBreakingOnSpaces: (text: string, measureWidth: (text: string) => number, getAvailableWidth: (a: number, b: number) => number, numberOfLines: number) => TextSegment[];
 /**
- * @param {object} ctx = Canvas.2dContext
- * @param {object} text - The text to display
+ * @param ctx - = Canvas.2dContext
+ * @param rtlAdjustedText - The text to display
  *
  * @return  array of text lines
  */
 export declare const getLines: (ctx: CanvasRenderingContext2D, text: string, fontFace: string, fontSize: string | number, maxWidth: number, hasIcon: boolean, maxNoLines: number, align: string) => TextSegment[];
 /**
- * Returns the styles by char for a group of property values
- * @param {array} captions = array of captions
+ * Returns the styles by char for a group of property values.
+ * @param captions - = array of captions
  * @return array of list of styles by char
  */
 export declare const getStylesByChar: (captions?: StyledCaption[]) => {

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

@@ -3,6 +3,7 @@ import type { StyledCaption } from '../renderers/canvasrenderer/types';
  * The base type for graph elements.
  * @private
  * @internal
+ * @hidden
  */
 interface GraphElement {
     /**
@@ -11,11 +12,15 @@ interface GraphElement {
      * 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.
-     * @deprecated Use {@link captions} instead.
+    /**
+     * 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.*/
@@ -30,8 +35,9 @@ interface GraphElement {
      */
     captionAlign?: 'top' | 'bottom' | 'center';
     /**
-     * The caption text and font style.
-     * Captions are only visible when using the 'canvas' renderer.
+     * 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[];
     /**
@@ -39,6 +45,7 @@ interface GraphElement {
      * 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.
@@ -91,9 +98,10 @@ interface Node extends GraphElement {
     html?: HTMLElement;
 }
 /**
- * @internal
+ * A node with only a subset of its properties.
  */
 type PartialNode = Partial<Node> & {
+    /** The id of the node. */
     id: string;
 };
 export declare const isValidRelationship: (relationship: unknown) => relationship is Relationship;
@@ -118,9 +126,10 @@ interface Relationship extends GraphElement {
     captionHtml?: HTMLElement;
 }
 /**
- * @internal
+ * A relationship with only a subset of its properties.
  */
 type PartialRelationship = Partial<Relationship> & {
+    /** The id of the relationship. */
     id: string;
 };
 export type { Node, Relationship, PartialNode, PartialRelationship };

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

@@ -4,7 +4,8 @@
  *
  * Make sure canvas pixel buffer is 1 to 1 vs screen pixels
  *
- * @note If the parent element is not connected to the DOM, it will use the width and height from the style properties.
+ * @remarks If the parent element is not connected to the DOM,
+ * it will use the width and height from the style properties.
  */
 export declare const fitCanvasSizeToParent: (canvas: HTMLCanvasElement) => void;
 export declare const addWebGLContextLostListener: (canvas: HTMLCanvasElement, contextLostCallback?: (e: WebGLContextEvent) => void) => void;

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

@@ -1,8 +1,8 @@
 import colorString from 'color-string';
 /**
- * Determines whether a black or white font color is more readable for a given background color
- * @param {string} color The background color
- * @returns {string} The font color that should be used @defaultValue '#fff'
+ * Determines whether a black or white font color is more readable for a given background color.
+ * @param color - The background color.
+ * @returns The font color that should be used @defaultValue '#fff'.
  */
 export declare const textColorForBackground: (color: string) => string;
 export declare const colorToRGB: (color: string) => colorString.Color;

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

@@ -28,12 +28,12 @@ export declare const absFillStyle: {
 };
 /**
  * Factor to make nodes same size in WebGL renderer and Canvas.
- * @returns {number} The adjustment factor.
+ * @returns The adjustment factor.
  */
 export declare const GlAdjust: number;
 /**
- * Get the pixel ratio of the device
- * @returns {number} The pixel ratio of the device
+ * Get the pixel ratio of the device.
+ * @returns The pixel ratio of the device.
  */
 export declare const getDevicePixelRatio: () => number;
 export declare const HtmlCaptionMinWidthThreshold = 5;

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

@@ -1,11 +1,12 @@
 /**
  * Specific error that is being thrown by NVL when web browser is not WebGL compatible.
  * @internal
+ * @hidden
  */
 export declare class CompatibilityError extends Error {
     /**
      * Returns the error message of the compatibility error.
-     * @returns {string} the error message
+     * @returns The error message.
      */
     toString(): string;
 }

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

@@ -10,24 +10,24 @@ export interface Point {
 }
 /**
  * This function checks if the coordinates are defined.
- * @param {Point | Node} from - The node the edge starts from.
- * @param {Point | Node} to - The node the edge ends at.
- * @returns {boolean} True if the coordinates are defined.
+ * @param from - The {@link Node} the edge starts from.
+ * @param to - The {@link Node} the edge ends at.
+ * @returns True if the coordinates are defined.
  */
 export declare const areCoordinateDefined: (from: Point | Node, to: Point | Node) => boolean;
 /**
  * Returns true if the two points are within PointDelta pixels of each other
  * This function is used to determine if a new point is close enough to an
- * existing point to be considered the same point
- * @param {Node} p1 - The first point.
- * @param {Node} p2 - The second point.
- * @returns {boolean} True if the two points are within PointDelta pixels of each other.
+ * existing point to be considered the same point.
+ * @param p1 - The first {@link Point}.
+ * @param p2 - The second {@link Point}.
+ * @returns True if the two points are within PointDelta pixels of each other.
  */
 export declare const pointEqual: (p1: Node | Point, p2: Node | Point) => boolean;
 /**
  * A class representing a line segment between two points in 2D space.
- * @param {Point} p1 - The first point of the segment.
- * @param {Point} p2 - The second point of the segment.
+ * @param p1 - The first point of the segment.
+ * @param p2 - The second point of the segment.
  */
 export declare class Segment {
     /** The first point of the segment. */
@@ -45,21 +45,21 @@ export declare class Segment {
     constructor(p1: Point, p2: Point);
     /**
      * Get the vector between the two points of the segment.
-     * @returns {Point} 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 {number} The length 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 {Point} The unit vector 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}
@@ -67,7 +67,7 @@ export declare class Segment {
     private getUnitVector;
     /**
      * Get the unit normal vector of the two points of the segment.
-     * @returns {Point} The unit normal vector of the segment.
+     * @returns The unit normal vector of the segment.
      * @private
      * @see {@link https://en.wikipedia.org/wiki/Normal_(geometry)}
      */
@@ -75,9 +75,9 @@ export declare class Segment {
 }
 /**
  * Calculates the projection ratio between two vectors.
- * @param {Point} lineStartToPointVector - The vector from the start of the line to the point.
- * @param {Point} lineVector - The vector of the line.
- * @returns {number} The projection of the point onto the line.
+ * @param lineStartToPointVector - The vector from the start of the line to the point.
+ * @param lineVector - The vector of the line.
+ * @returns The projection of the point onto the line.
  * The projection ratio is a value between 0 and 1.
  * The projection ratio is 0 if the point is closest to the start of the line.
  * The projection ratio is 1 if the point is closest to the end of the line.
@@ -86,10 +86,11 @@ export declare class Segment {
 export declare const getProjectionRatio: (lineStartToPointVector: Point, lineVector: Point) => number;
 /**
  * Calculates the shortest distance between a point and a line.
- * @param {Point} lineStart - The first point of the line.
- * @param {Point} lineEnd - The second point of the line.
- * @param {Point} point - The point to calculate the distance to.
- * @returns {number} The distance between the point and the line.
+ * @param lineStart - The first point of the line.
+ * @param lineEnd - The second point of the line.
+ * @param point - The point to calculate the distance to.
+ * @returns The distance between the point and the line.
+ * @remarks
  * If the actual distance does not matter,
  * if you only want to compare what this function
  * returns to other results of this function, you
@@ -99,11 +100,11 @@ export declare const getProjectionRatio: (lineStartToPointVector: Point, lineVec
 export declare const getDistanceToLine: (lineStart: Point, lineEnd: Point, point: Point) => number;
 /**
  * Get the intersection point of two lines
- * @param {Point} p0 - First point of first line
- * @param {Point} p1 - Second point of first line
- * @param {Point} p2 - First point of second line
- * @param {Point} p3 - Second point of second line
- * @returns {Point | null} Intersection point
+ * @param p0 - First point of first line.
+ * @param p1 - Second point of first line.
+ * @param p2 - First point of second line.
+ * @param p3 - Second point of second line.
+ * @returns Intersection point.
  * @see https://github.com/bit101/CodingMath/blob/master/episode33/parallel.js
  * Returns null if lines are parallel
  */
@@ -113,10 +114,10 @@ export declare const getIntersection: (p0: Point, p1: Point, p2: Point, p3: Poin
  * The curve is defined by three points (from, to, control).
  * The point is defined by an object with x and y properties (point).
  * The function returns the distance between the point and the curve.
- * @param {Point} fromCoordinates - The first point of the curve.
- * @param {Point} toCoordinates - The second point of the curve.
- * @param {Point} control - The control point of the curve.
- * @param {Point} point - The point to calculate the distance to.
- * @returns {number} The distance between the point and the curve.
+ * @param fromCoordinates - The first point of the curve.
+ * @param toCoordinates - The second point of the curve.
+ * @param control - The control point of the curve.
+ * @param point - The point to calculate the distance to.
+ * @returns The distance between the point and the curve.
  */
 export declare const getDistanceToQuadratic: (fromCoordinates: Point, toCoordinates: Point, control: Point, point: Point) => number;

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

@@ -10,9 +10,9 @@ export declare const relItemsToFlatKeySet: (relItems: Relationship[]) => Set<str
  * Flattens a list of relationships so only one relationship remains between two nodes.
  * Falls back to default rel color when relationships between two nodes have varying colors.
  * Sums widths of relationships when more than one relationship exists between two nodes.
- * @param {Relationship[]} relItems List of all relationships and their connected ids.
- * @param {string} [disabledItemColor] The color to use for the disabled relationships
- * @return {FlatRel[]} A flattened list of relationships.
+ * @param relItems - List of all relationships and their connected ids.
+ * @param disabledItemColor - The color to use for the disabled relationships.
+ * @returns A flattened list of relationships.
  */
 export declare const relItemsToFlatList: (relItems: Relationship[], disabledItemColor?: string) => FlatRel[];
 export declare const getAdjNodesMapAndRelMap: (rels: Relationship[]) => {

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

@@ -38,7 +38,9 @@ export interface HitTargetRelationship {
  * Part of the result of a {@link NVL}.{@link NVL.getHits} call
  */
 export type HitTargets = {
+    /** The nodes that have been hit by the pointer event. */
     nodes: HitTargetNode[];
+    /** The relationships that have been hit by the pointer event. */
     relationships: HitTargetRelationship[];
 };
 export declare const hitTest: (x: number, y: number, state: NvlState, targets?: string[], options?: {

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

@@ -1,11 +1,15 @@
 import type { Node as DriverNode, Relationship as DriverRelationship, Path, Record } from 'neo4j-driver';
+import type { Node as NvlNode, Relationship as NvlRelationship } from '../types/graph-element';
 export declare const recordMapper: (record: Record) => any[];
 type GraphElement = DriverNode | DriverRelationship | Path;
 type NestedGraphElements = GraphElement | NestedGraphElements[];
 export declare const recordCollector: (graphElements: NestedGraphElements[]) => {
-    recordObjectMap: Map<any, any>;
-    nodes: any[];
-    relationships: any[];
+    /** The nodes of the graph. */
+    nodes: NvlNode[];
+    /** The relationships of the graph. */
+    relationships: NvlRelationship[];
+    /** A map from element id to the driver graph element. */
+    recordObjectMap: Map<string, DriverNode | DriverRelationship | Path>;
 };
 /**
  * Result transformer for the Neo4j JavaScript driver results to NVL graph elements.
@@ -28,8 +32,11 @@ 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<{
-    recordObjectMap: Map<any, any>;
-    nodes: any[];
-    relationships: any[];
+    /** The nodes of the graph. */
+    nodes: NvlNode[];
+    /** The relationships of the graph. */
+    relationships: NvlRelationship[];
+    /** A map from element id to the driver graph element. */
+    recordObjectMap: Map<string, DriverNode | DriverRelationship | Path>;
 }>;
 export {};

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

@@ -6,32 +6,32 @@ type AnalyticsTrackPayload = {
 };
 export declare abstract class AnalyticsFunction {
     /**
-     * Perform asynchronous bootstrapping
+     * Perform asynchronous bootstrapping.
      */
     abstract init(apiKey: string): void;
     /**
-     * Associate session with known user identifier
+     * Associate session with known user identifier.
      */
     abstract identify(): void;
     /**
-     * Load unique segment Id in the localstorage
+     * Load unique segment Id in the localstorage.
      */
     abstract loadSavedSegmentId(): string;
     /**
-     * save unique segment Id in the localstorage
+     * Save unique segment Id in the localstorage.
      */
     abstract saveTrackingId(segmentId: string): void;
     /**
-     * get/fetch unique segment Id from the localstorage
+     * Get/fetch unique segment Id from the localstorage.
      */
     abstract getSegmentTrackingId(): Record<string, unknown>;
     /**
-     * Track arbitrary event
+     * Track arbitrary event.
      */
-    abstract trackEvent(payload: AnalyticsTrackPayload): void;
+    abstract trackEvent(payload: AnalyticsTrackPayload): Promise<void>;
 }
 /**
- * Analytics adapter for Segment Analytics.js
+ * Analytics adapter for Segment Analytics.js.
  */
 export declare class SegmentAnalytics implements AnalyticsFunction {
     private analytics;

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

@@ -3,10 +3,10 @@ import type { Point } from './geometry';
 declare const getExtremeLimits: (nodePositions: Point[]) => Point[];
 declare const getMaxDistance: (extremeLimits?: Point[]) => number;
 /**
- * Gets the center choordinates and the width and height for the given node positions
- * @param {Point[] | Node[]} nodePositions - The node positions
- * @param {number} maxNodeRadius - The maximum node radius
- * @returns An object with the center x and y coordinates and the width and height
+ * Gets the center coordinates and the width and height for the given node positions.
+ * @param nodePositions - The node positions.
+ * @param maxNodeRadius - The maximum node radius.
+ * @returns An object with the center x and y coordinates and the width and height.
  */
 declare const getPositionBoundaries: (nodePositions?: Point[] | Node[], maxNodeRadius?: number) => {
     centerX: number;
@@ -15,35 +15,42 @@ declare const getPositionBoundaries: (nodePositions?: Point[] | Node[], maxNodeR
     nodesHeight: number;
 };
 /**
- * Gets the required zoom level for the given view and scene dimensions to fit the scene into the view
- * @param {number} viewWidth - The width of the required view
- * @param {number} viewHeight - The height of the required view
- * @param {number} sceneWidth - The width of the canvas scene
- * @param {number} sceneHeight - The height of the canvas scene
- * @returns An object with the zoom level for the x and y axis
+ * Gets the required zoom level for the given view and scene dimensions to fit the scene into the view.
+ * @param viewWidth - The width of the required view.
+ * @param viewHeight - The height of the required view.
+ * @param sceneWidth - The width of the canvas scene.
+ * @param sceneHeight - The height of the canvas scene.
+ * @returns An object with the zoom level for the x and y axis.
  */
 declare const getZoomLevel: (viewWidth: number, viewHeight: number, sceneWidth: number, sceneHeight: number) => {
     zoomX: number;
     zoomY: number;
 };
 /**
- * Creates a zoom target based on the given zoom levels and the min and max zoom level
- * @param {number} zoomX - The zoom level for the x axis
- * @param {number} zoomY - The zoom level for the y axis
- * @param {number} minZoom - The minimum zoom level
- * @param {number} maxZoom - The maximum zoom level
- * @returns The zoom target
+ * Creates a zoom target based on the given zoom levels and the min and max zoom level.
+ * @param zoomX - The zoom level for the x axis.
+ * @param zoomY - The zoom level for the y axis.
+ * @param minZoom - The minimum zoom level.
+ * @param maxZoom - The maximum zoom level.
+ * @returns The zoom target.
  */
 declare const createZoomTarget: (zoomX: number, zoomY: number, minZoom?: number, maxZoom?: number) => number;
 /**
- * Gets the zoom target to fit the given node positions into the scene
- * @param {Point[]} nodePositions - The node positions
- * @param {number} containerWidth - The width of the container NVL is displayed in
- * @param {number} containerHeight - The height of the container NVL is displayed in
- * @param {number} maxNodeRadius - The maximum node radius, which is added as margin to the scene (defaults to `50`)
- * @returns
+ * Gets the zoom target to fit the given node positions into the scene.
+ * @param nodePositions - The node positions.
+ * @param containerWidth - The width of the container NVL is displayed in.
+ * @param containerHeight - The height of the container NVL is displayed in.
+ * @param maxNodeRadius - The maximum node radius, which is added as margin to the scene (defaults to `50`).
+ * @returns The zoom and pan targets.
  */
-declare const getZoomTargetForNodePositions: (nodePositions: Point[], containerWidth: number, containerHeight: number, maxNodeRadius?: number) => number;
+declare const getZoomTargetForNodePositions: (nodePositions: Point[], containerWidth: number, containerHeight: number, maxNodeRadius?: number) => {
+    /** The zoom level. */
+    zoom: number;
+    /** The x-coordinate of the pan. */
+    panX: number;
+    /** The y-coordinate of the pan. */
+    panY: number;
+};
 declare const getFlexibleZoomLimit: (nodePositions: Point[], rect: HTMLCanvasElement, maxNodeRadius: number) => number;
 declare const getNewZoomWithinLimits: (newZoom: number, oldZoom: number, minZoom: number, maxZoom: number) => number;
 declare const isZoomOutAtLimit: (newZoom: number, oldZoom: number, zoomOutLimit: number) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neo4j-nvl/base",
-  "version": "0.3.9",
+  "version": "1.0.0",
   "license": "SEE LICENSE IN 'LICENSE.txt'",
   "homepage": "https://neo4j.com/docs/nvl/current/",
   "description": "Base library for the Neo4j Visualization Library",
@@ -29,7 +29,7 @@
     "postpack": "rm LICENSE.txt && rm CHANGELOG.md"
   },
   "dependencies": {
-    "@neo4j-nvl/layout-workers": "0.3.9",
+    "@neo4j-nvl/layout-workers": "1.0.0",
     "@segment/analytics-next": "^1.70.0",
     "color-string": "^1.9.1",
     "d3-force": "^3.0.0",
@@ -44,6 +44,7 @@
     "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",
@@ -52,7 +53,6 @@
     "babel-loader": "^8.2.5",
     "copy-webpack-plugin": "^11.0.0",
     "neo4j-driver": "^5.26.0",
-    "typedoc": "^0.23.15",
     "webpack": "^5.75.0",
     "webpack-cli": "^5.0.0"
   },