@neo4j-nvl/base 0.3.5 → 0.3.6-379b7fef

package/dist/base.mjs.LICENSE.txt

@@ -1,5 +1,16 @@
+/*!
+ * The buffer module from node.js, for the browser.
+ *
+ * @author   Feross Aboukhadijeh <https://feross.org>
+ * @license  MIT
+ */
+
+/*! 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 */
 
+/*! safe-buffer. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */
+
 /**
  * @license
  * Lodash <https://lodash.com/>

package/dist/types/index.d.ts

@@ -7,6 +7,8 @@ import type { Node, PartialNode, PartialRelationship, Relationship } from './typ
 import { CompatibilityError } from './utils/errors';
 import type { Point } from './utils/geometry';
 import type { HitTargetNode, HitTargetRelationship, HitTargets } from './utils/hittest';
+import { nvlResultTransformer } from './utils/jsDriverResultTransformer';
+import { getZoomTargetForNodePositions } from './utils/zoomFunctions';
 /**
  * Extends the MouseEvent interface with the {@link HitTargets} property.
  * The result of a _.{@link NVL.getHits} call.
@@ -185,7 +187,7 @@ declare class NVL {
      * the zoom level will be set to the closest valid zoom level,
      * even if the given nodes do not fit the viewport yet.
      */
-    fit(nodeIds: string[], zoomOptions: NvlState['zoomOptions']): void;
+    fit(nodeIds: string[], zoomOptions?: NvlState['zoomOptions']): void;
     /**
      * Resets the zoom of the viewport back to the default zoom level of 0.75
      */
@@ -363,4 +365,4 @@ declare const colorMapperFunctions: {
 };
 export default NVL;
 export type { NvlOptions, Renderer, Node, Relationship, PartialNode, PartialRelationship, Layout, LayoutOptions, ForceDirectedOptions, HierarchicalOptions, ExternalCallbacks, HitTargets, HitTargetNode, HitTargetRelationship, Point, NvlMouseEvent, ZoomOptions, StyledCaption, WebGLRendererType, CanvasRendererType };
-export { NVL, colorMapperFunctions, CompatibilityError, ForceDirectedLayoutType, HierarchicalLayoutType, GridLayoutType, FreeLayoutType, d3ForceLayoutType, drawCircleBand };
+export { NVL, colorMapperFunctions, CompatibilityError, ForceDirectedLayoutType, HierarchicalLayoutType, GridLayoutType, FreeLayoutType, d3ForceLayoutType, drawCircleBand, nvlResultTransformer, getZoomTargetForNodePositions };

package/dist/types/layouts/forcedirectedlayout/cosebilkentlayout/CoseBilkentLayout.d.ts

@@ -15,13 +15,13 @@ export declare class CoseBilkentLayout extends AnimatedLayout {
     cytoCompleteCallback: () => void;
     computing: boolean;
     pendingLayoutData: LayoutData;
-    worker: SharedWorker | any;
+    worker: SharedWorker;
     constructor(config: {
         state: NvlState;
         cytoCompleteCallback?: () => void;
         animationCompleteCallback?: () => void;
     });
-    setupWorker(): Promise<unknown>;
+    setupWorker(): Promise<SharedWorker>;
     setOptions(): void;
     update(refreshPositions?: boolean, updateMobXNodes?: Node[], updateMobXRelationships?: Relationship[]): void;
     getShouldUpdate(): boolean;

package/dist/types/layouts/forcedirectedlayout/physlayout/solarmerger/SolarMerger.d.ts

@@ -19,7 +19,7 @@ export default class SolarMerger {
         idToRel: {};
     };
     nodeSortMap: {};
-    coarsenBy(level: any): {
+    coarsenBy(levelToCoarsenBy: any): {
         nodes: any[];
         relationships: any[];
         idToRel: {};

package/dist/types/layouts/gridLayout/GridLayout.d.ts

@@ -7,7 +7,7 @@ export class GridLayout {
     setOptions(options: any): void;
     updateNodes(positionList: any): void;
     update(refreshPositions?: boolean): void;
-    layout(nodes: any, nodeIds: any, idToPosition: any, rels: any): void;
+    layout(mobxNodes: any, nodeIds: any, idToPosition: any, rels: any): void;
     getNodePositions(nodeList: any): any[];
     getShouldUpdate(): boolean;
     getComputing(): boolean;

package/dist/types/layouts/hierarchicallayout/HierarchicalLayout.d.ts

@@ -15,7 +15,7 @@ export declare class HierarchicalLayout extends AnimatedLayout {
     private directionChanged;
     private packingChanged;
     constructor(config: HierarchicalLayoutConfig);
-    setupWorker(): Promise<unknown>;
+    setupWorker(): Promise<SharedWorker>;
     setOptions(options: LayoutOptions): void;
     update(refreshPositions?: boolean): void;
     getShouldUpdate(): boolean;

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

@@ -12,12 +12,15 @@ export interface ExternalCallbacks {
     /** Triggered when a asynchronous layout calculation starts/stops. */
     onLayoutComputing?: (isComputing: boolean) => void;
     onWebGLContextLost?: (webGLContextEvent: WebGLContextEvent) => void;
+    /** Triggered when a zoom transition (e.g. {@link NVL.fit} or {@link NVL.resetZoom}) function is done. */
+    onZoomTransitionDone?: () => void;
     restart?: () => void;
 }
 export declare const isExternalCallback: (callback: unknown) => callback is keyof ExternalCallbacks;
 export default class ExternalCallbackHandler {
     callbacks: ExternalCallbacks;
     constructor(externalCallbacks?: ExternalCallbacks);
+    onZoomTransitionDone(): void;
     onLayoutDone(): void;
     onLayoutStep(p: Node[]): void;
     onLayoutComputing(isComputing: boolean): void;

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

@@ -8,6 +8,7 @@ type SaveToFileOptions = {
     backgroundColor?: string;
 };
 export declare const EVENT_ERROR = "onError";
+export declare const EVENT_ZOOM_TRANSITION_DONE = "onZoomTransitionDone";
 export declare const EVENT_LAYOUT_DONE = "onLayoutDone";
 export declare const EVENT_LAYOUT_STEP = "onLayoutStep";
 export declare const EVENT_LAYOUT_COMPUTING = "onLayoutComputing";
@@ -95,7 +96,7 @@ export default class NvlController {
     setZoomLevel(_newLevel: number): void;
     setPanCoordinates(panX: number, panY: number): void;
     setZoomAndPan(zoom: number, panX: number, panY: number): void;
-    fit(nodeIds: string[], zoomOptions: ZoomOptions): void;
+    fit(nodeIds: string[], zoomOptions?: ZoomOptions): void;
     resetZoom(): void;
     setRenderer(renderer: string): void;
     on(name: keyof ExternalCallbacks, callback: (args: unknown) => void): void;

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

@@ -9,16 +9,14 @@ export default class ZoomTransitionHandler {
     private firstUpdate;
     private readonly state;
     private readonly canvas;
-    private readonly defaultZoomLevel;
     private readonly stateDisposers;
-    constructor({ state, getNodePositions, canvas, defaultZoomLevel }: {
+    constructor({ state, getNodePositions, canvas }: {
         state: NvlState;
         getNodePositions: (data: Node[]) => Node[];
         canvas: HTMLCanvasElement;
-        defaultZoomLevel: number;
     });
     needsToRun(): boolean;
-    update(layoutActive: boolean): void;
+    update(layoutActive: boolean, onTransitionCompleted?: () => void): void;
     destroy(): void;
     private recalculateTarget;
     private allNodesAreVisible;

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

@@ -13,10 +13,10 @@ export default class PerformanceTester {
     /**
      * Starts a performance measurement. Every call to this method must be followed
      * by a call to endTest(). Tests can be nested.
-     * @param  {String} name String identifying this measurement. Only used for printing, so
+     * @param  {String} measurement String identifying this measurement. Only used for printing, so
      *                       keep it human readable.
      */
-    startTest(name: string): void;
+    startTest(measurement: string): void;
     /**
      * Ends the last started test, giving it an end time.
      */

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

@@ -130,7 +130,12 @@ export interface NvlOptions {
      * The DOM element in which to render the graph visualization
      */
     frame?: HTMLElement;
-    /** The DOM container in which to render the minimap */
+    /**
+     * The DOM container in which to render the minimap.
+     *
+     * @note When using a React ref, make sure the attached element is rendered before the NVL instance is created.
+     * Otherwise, the minimap will not be displayed.
+     */
     minimapContainer?: HTMLElement;
     /** Configuration for the current layout */
     layoutOptions?: LayoutOptions;
@@ -196,6 +201,8 @@ export type ZoomOptions = {
     minZoom?: number;
     /** The maximum zoom value for the fit-to-zoom operation. */
     maxZoom?: number;
+    /** If true, will not animate the zoom/pan transition. */
+    animated?: boolean;
 };
 export interface NvlState {
     zoom: number;

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

@@ -65,9 +65,15 @@ interface Node extends GraphElement {
     size?: number;
     /** Whether or not the current node is pinned.*/
     pinned?: boolean;
-    /** The x-coordinate for the position of the node.*/
+    /**
+     * @ignore
+     * The x-coordinate for the position of the node.
+     */
     x?: number;
-    /** The y-coordinate for the position of the node.*/
+    /**
+     * @ignore
+     * The y-coordinate for the position of the node.
+     */
     y?: number;
     /** Whether or not the current node is activated.*/
     activated?: boolean;

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

@@ -0,0 +1,32 @@
+import type { Node as DriverNode, Relationship as DriverRelationship, Path, Record } from 'neo4j-driver';
+export declare const recordMapper: (record: Record) => any[];
+export declare const recordCollector: (graphElements: (DriverNode | DriverRelationship | Path)[][]) => {
+    recordObjectMap: Map<any, any>;
+    nodes: any[];
+    relationships: any[];
+};
+/**
+ * Result transformer for the Neo4j JavaScript driver results to NVL graph elements.
+ * @example
+ *
+ * ```ts
+ * import neo4j from "neo4j-driver";
+ * import { nvlResultTransformer, NVL } from "@neo4j-nvl/base";
+ *
+ * const driver = neo4j.driver("{uri}", neo4j.auth.basic("{user}", "{password}"));
+ * const nvlGraph = await driver.executeQuery(
+ *   "MATCH (a)-[r]-(b) RETURN a,r,b LIMIT 25",
+ *   {},
+ *   { resultTransformer: nvlResultTransformer }
+ * );
+ *
+ * const nvl = new NVL(document.getElementById('viz'), nvlGraph.nodes, nvlGraph.relationships);
+ * ```
+ *
+ * @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[];
+}>;

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

@@ -0,0 +1 @@
+export {};

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

@@ -2,19 +2,50 @@ import type { Node } from '../index';
 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
+ */
 declare const getPositionBoundaries: (nodePositions?: Point[] | Node[], maxNodeRadius?: number) => {
     centerX: number;
     centerY: number;
     nodesWidth: number;
     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
+ */
 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
+ */
 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
+ */
+declare const getZoomTargetForNodePositions: (nodePositions: Point[], containerWidth: number, containerHeight: number, maxNodeRadius?: number) => 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;
 declare const getDynamicZoom: (nodePositions: Point[] & Node[], minZoom: number, maxZoom: number, rect: HTMLCanvasElement, newZoom: number, currentZoom: number) => number;
-export { getFlexibleZoomLimit, isZoomOutAtLimit, getNewZoomWithinLimits, getExtremeLimits, getMaxDistance, getPositionBoundaries, getZoomLevel, createZoomTarget, getDynamicZoom };
+export { getFlexibleZoomLimit, getZoomTargetForNodePositions, isZoomOutAtLimit, getNewZoomWithinLimits, getExtremeLimits, getMaxDistance, getPositionBoundaries, getZoomLevel, createZoomTarget, getDynamicZoom };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neo4j-nvl/base",
-  "version": "0.3.5",
+  "version": "0.3.6-379b7fef",
   "license": "SEE LICENSE IN 'LICENSE.txt'",
   "homepage": "https://neo4j.com/docs/nvl/current/",
   "description": "Base library for the Neo4j Visualization Library",
@@ -22,13 +22,13 @@
     "build": "yarn global:tsc && webpack",
     "watch": "concurrently 'tsc -w' 'webpack -w' -k -n 'tsc,webpack' -c 'cyan,magenta'",
     "test": "yarn global:jest",
-    "eslint": "yarn global:eslint ./src/ --plugin only-warn",
+    "eslint": "yarn global:eslint ./src/",
     "coverage": "yarn test --coverage --silent",
     "prepack": "cp ../../LICENSE.txt ./",
     "postpack": "rm LICENSE.txt"
   },
   "dependencies": {
-    "@neo4j-nvl/layout-workers": "0.3.5",
+    "@neo4j-nvl/layout-workers": "0.3.6-379b7fef",
     "@segment/analytics-next": "^1.70.0",
     "color-string": "^1.9.1",
     "d3-force": "^3.0.0",
@@ -50,8 +50,13 @@
     "@types/tinycolor2": "^1.4.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"
-  }
+  },
+  "peerDependencies": {
+    "neo4j-driver": "*"
+  },
+  "stableVersion": "0.3.6"
 }