@neo4j-nvl/base 0.3.8 → 0.3.9-1ef8ccc1

package/dist/base.mjs.LICENSE.txt

@@ -7,7 +7,7 @@
 
 /*! ieee754. BSD-3-Clause License. Feross Aboukhadijeh <https://feross.org/opensource> */
 
-/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */
+/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/babel/babel/blob/main/packages/babel-helpers/LICENSE */
 
 /*! safe-buffer. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */
 

package/dist/types/index.d.ts

@@ -37,6 +37,7 @@ interface NvlMouseEvent extends MouseEvent {
  */
 declare class NVL {
     #private;
+    readonly performance: any;
     /**
      * Creates a new NVL instance.
      * @param {HTMLElement} frame - The DOM element to display the graph in
@@ -267,10 +268,13 @@ declare class NVL {
      * @param {string} options.backgroundColor - The background color of the png file.
      * The size of the png file will be the size of the canvas in the DOM.
      */
-    saveToFile(options: {
+    saveToFile(options?: {
         filename?: string;
         backgroundColor?: string;
     }): void;
+    getImageDataUrl(options?: {
+        backgroundColor?: string;
+    }): string;
     /**
      * Saves the entire graph visualization canvas as a png to the client.
      * @param {{ filename: string, backgroundColor: string }} options The filename and background color of the png.
@@ -279,17 +283,17 @@ declare class NVL {
      * The size of the png file will be as large as the entire graph at the default zoom level.
      * Can result in a very large file.
      */
-    saveFullGraphToLargeFile(options: {
+    saveFullGraphToLargeFile(options?: {
         filename?: string;
         backgroundColor?: string;
     }): void;
     /**
      * Sets the zoom of the viewport to a specific value.
      * @param {number} absolute The desired zoom level.
-     * When updating both the zoom level and pan coordinates,
+     * @note When updating both the zoom level and pan coordinates,
      * use {@link setZoomAndPan} instead of calling {@link setZoom} and {@link setPan}
      * separately to avoid jittering.
-     * If the zoom level is outside of the range provided by the
+     * @note If the zoom level is outside of the range provided by the
      * {@link NvlOptions.minZoom} and {@link NvlOptions.maxZoom} options,
      * the zoom level will be set to the closest valid zoom level.
      * If {@link NvlOptions.allowDynamicMinZoom} is set to true,
@@ -300,9 +304,8 @@ declare class NVL {
      * Sets the zoom of the viewport to a specific value.
      * @param {number} panX The desired panX value.
      * @param {number} panY The desired panY value.
-     * When updating both the zoom level and pan coordinates,
-     * use {@link setZoomAndPan} instead of calling {@link setZoom} and {@link setPan}
-     * separately to avoid jittering.
+     * @note When updating both the zoom level and pan coordinates,
+     * use {@link setZoomAndPan} instead of calling {@link setZoom} and {@link setPan} separately to avoid jittering.
      */
     setPan(panX: number, panY: number): void;
     /**
@@ -310,8 +313,8 @@ declare class NVL {
      * @param {number} zoom The desired zoom level.
      * @param {number} panX The desired panX value.
      * @param {number} panY The desired panY value.
-     * When only updating the zoom level or pan coordinates, use {@link setZoom} or {@link setPan} instead.
-     * If the zoom level is outside of the range provided by the
+     * @note When only updating zoom level or pan coordinates, use {@link setZoom} or {@link setPan} instead.
+     * @note If the zoom level is outside of the range provided by the
      * {@link NvlOptions.minZoom} and {@link NvlOptions.maxZoom} options,
      * the zoom level will be set to the closest valid zoom level.
      * If {@link NvlOptions.allowDynamicMinZoom} is set to true,

package/dist/types/layouts/forcedirectedlayout/physlayout/PhysLayout.d.ts

@@ -25,6 +25,7 @@ export declare class PhysLayout {
     private force;
     private nodeIdToIndex;
     private nodeIndexToId;
+    private flatRelationshipKeys;
     private numNodes;
     private solarMerger;
     private subGraphs;
@@ -126,11 +127,23 @@ export declare class PhysLayout {
     }, nodeChanges: {
         adds: Record<string, Node>;
         removes: Record<string, Node>;
+    }, relationshipChanges: {
+        adds: Record<string, Relationship>;
+        removes: Record<string, Relationship>;
     }): any;
     /**
      * Destroys the class and all buffers and textures.
      */
     destroy(): void;
+    /**
+     * Takes the new flat key set of relationships and the current relationship changes
+     * and checks whether removed relationships are still in the new flat key set
+     * and whether added relationships were already in the old flat key set.
+     * @param newFlatKeySet The new flat key set of relationships.
+     * @param relationshipChanges The changes in the relationships.
+     * @returns {boolean} Whether the relationship flat map has changed.
+     */
+    private hasRelationshipFlatMapChanged;
     private dumpTexture;
     private getScaleNumber;
     private getBaseLength;

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

@@ -1,5 +1,5 @@
 import { type ExternalCallbacks } from './ExternalCallbackHandler';
-type CallbackFunction = ExternalCallbacks['onError'] | ExternalCallbacks['onLayoutComputing'] | ExternalCallbacks['onLayoutDone'] | ExternalCallbacks['onLayoutStep'];
+type CallbackFunction = ExternalCallbacks[keyof ExternalCallbacks];
 /**
  * A class for registering and calling callbacks
  * @example

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

@@ -9,6 +9,8 @@ export interface ExternalCallbacks {
     onLayoutStep?: (p: Node[]) => void;
     /** Triggered when NVL throws an error after initialization. */
     onError?: (error: Error) => void;
+    /** Triggered when NVL is initialized. */
+    onInitialization?: () => void;
     /** Triggered when a asynchronous layout calculation starts/stops. */
     onLayoutComputing?: (isComputing: boolean) => void;
     onWebGLContextLost?: (webGLContextEvent: WebGLContextEvent) => void;
@@ -20,6 +22,7 @@ export declare const isExternalCallback: (callback: unknown) => callback is keyo
 export default class ExternalCallbackHandler {
     callbacks: ExternalCallbacks;
     constructor(externalCallbacks?: ExternalCallbacks);
+    onInitialization(): void;
     onZoomTransitionDone(): void;
     onLayoutDone(): void;
     onLayoutStep(p: Node[]): void;

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

@@ -109,9 +109,13 @@ export default class NvlController {
     private getLayout;
     setLayout(layoutType: Layout): void;
     setLayoutOptions(options: LayoutOptions): void;
-    createDownloadLink(filename: string, canvas: HTMLCanvasElement): HTMLAnchorElement;
+    private getDataUrlForCanvas;
+    private initiateFileDownload;
+    private updateLayoutAndPositions;
     saveToFile(options: SaveToFileOptions): void;
-    prepareLargeFileForDownload(options: SaveToFileOptions): Promise<unknown>;
+    getImageDataURL(options: SaveToFileOptions): string;
+    private prepareLargeFileForDownload;
+    private createCanvasAndRenderImage;
     saveFullGraphToLargeFile(options: SaveToFileOptions): Promise<void>;
 }
 export {};

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

@@ -12,9 +12,7 @@ export interface LabelGeometry {
  */
 export default class ArrowBundle {
     key: string;
-    rels: {
-        rel: Relationship;
-    }[];
+    rels: Map<string, Relationship>;
     waypointPath: WaypointPath;
     readonly selfReferring: boolean;
     fromId: string;
@@ -33,6 +31,7 @@ export default class ArrowBundle {
      */
     insert(rel: Relationship): void;
     setLabelInfo(relId: string, labelInfo: LabelGeometry): void;
+    has({ id }: Relationship): boolean;
     /**
      * Remove an arrow from the bundle
      * @param {Relationship} rel - The arrow to remove
@@ -43,6 +42,7 @@ export default class ArrowBundle {
      * @returns {number} The size of the arrow bundle
      */
     size(): number;
+    relArray(): Relationship[];
     /**
      * Get the maximum font size of the arrows in the bundle
      * @returns {number} The maximum font size of the arrows in the bundle

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

@@ -17,7 +17,7 @@ export default class ArrowBundler {
      * @param {Record<string, Relationship>} removedRels - The removed relations
      * @param {Record<string, WaypointPath>} waypoints - The waypoints
      */
-    updateData(addedRels: Record<string, Relationship>, removedRels: Record<string, Relationship>, waypoints: Record<string, WaypointPath>): void;
+    updateData(addedRels: Record<string, Relationship>, removedRels: Record<string, Relationship>, updatedRels: Record<string, Relationship>, waypoints: Record<string, WaypointPath>): void;
     /**
      * Updates the positions of the arrow bundles based on the provided `positionMap`.
      * @param positionMap A map of node IDs to positions.

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

@@ -26,7 +26,7 @@ export declare const tryWithNumberOfLines: (text: string, measureWidth: (text: s
 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 {object} rtlAdjustedText - The text to display
  *
  * @return  array of text lines
  */

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

@@ -3,6 +3,8 @@
  * @param canvas The canvas to fix the size of.
  *
  * 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.
  */
 export declare const fitCanvasSizeToParent: (canvas: HTMLCanvasElement) => void;
 export declare const addWebGLContextLostListener: (canvas: HTMLCanvasElement, contextLostCallback?: (e: WebGLContextEvent) => void) => void;

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

@@ -11,6 +11,7 @@ export declare const DefaultNodeSize = 25;
 export declare const DefaultNodeColor = "#FFDF81";
 export declare const DefaultRelColor = "#818790";
 export declare const DefaultRelWidth = 1;
+export declare const MaxFlatRelWidth = 20;
 export declare const DisabledItemColor = "#EDEDED";
 export declare const DisabledItemFontColor = "#DDDDDD";
 export declare const DefaultShadowColor = "#CFD1D4";

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

@@ -4,6 +4,8 @@ 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 relItemsToFlatKeySet: (relItems: Relationship[]) => Set<string>;
 /**
  * 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.

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

@@ -28,7 +28,7 @@ export declare abstract class AnalyticsFunction {
     /**
      * Track arbitrary event
      */
-    abstract trackEvent(payload: AnalyticsTrackPayload): void;
+    abstract trackEvent(payload: AnalyticsTrackPayload): Promise<void>;
 }
 /**
  * Analytics adapter for Segment Analytics.js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neo4j-nvl/base",
-  "version": "0.3.8",
+  "version": "0.3.9-1ef8ccc1",
   "license": "SEE LICENSE IN 'LICENSE.txt'",
   "homepage": "https://neo4j.com/docs/nvl/current/",
   "description": "Base library for the Neo4j Visualization Library",
@@ -20,7 +20,8 @@
   ],
   "scripts": {
     "build": "yarn global:tsc && webpack",
-    "watch": "concurrently 'tsc -w' 'webpack -w' -k -n 'tsc,webpack' -c 'cyan,magenta'",
+    "build:dev": "yarn global:tsc && webpack --mode development",
+    "watch": "concurrently 'tsc -w' 'webpack -w --mode development' -k -n 'tsc,webpack' -c 'cyan,magenta'",
     "test": "yarn global:jest",
     "eslint": "yarn global:eslint ./src/",
     "coverage": "yarn test --coverage --silent",
@@ -28,7 +29,7 @@
     "postpack": "rm LICENSE.txt && rm CHANGELOG.md"
   },
   "dependencies": {
-    "@neo4j-nvl/layout-workers": "0.3.8",
+    "@neo4j-nvl/layout-workers": "0.3.9-1ef8ccc1",
     "@segment/analytics-next": "^1.70.0",
     "color-string": "^1.9.1",
     "d3-force": "^3.0.0",
@@ -43,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",
@@ -51,11 +53,11 @@
     "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"
   },
   "peerDependencies": {
     "neo4j-driver": "*"
-  }
+  },
+  "stableVersion": "0.3.9"
 }