@neo4j-nvl/react 0.3.6-8c7576fc → 0.3.6-ab6fbe86

package/CHANGELOG.md

@@ -0,0 +1,123 @@
+# Changelog
+
+All notable changes to NVL will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [0.3.6] - 2025-02-21
+
+NVL 0.3.6 improves the API docs and adds a result transformer for the Neo4j JavaScript Driver, as well as small improvements and bug fixes.
+
+### Added
+
+- [result transformer for the Neo4j JavaScript Driver](https://neo4j.com/docs/api/nvl/current/functions/_neo4j_nvl_base.nvlResultTransformer.html)
+- [option](https://neo4j.com/docs/api/nvl/current/types/_neo4j_nvl_base.ZoomOptions.html) to disable transition when fitting nodes
+
+### Fixed
+
+- lasso handler issues during initialization
+
+## [0.3.5] - 2025-02-20
+
+NVL 0.3.5 contains several bug fixes and changes the default rendering method of NVL from "webgl" to "canvas".
+
+### Changed
+
+- Change default value for renderer to canvas
+
+### Fixed
+
+- Self-referring relationship overlay icon rotation position issue
+- Invalid lasso area calculation when segment from first to last point intersects
+
+## [0.3.4] - 2025-02-19
+
+With this release, we are updating our docs and READMEs and publishing NVL's API documentation and examples on neo4j.com/docs/api/nvl/current.
+
+### Added
+
+- NVL's API documentation and examples on [neo4j.com/docs/api/nvl/current](http://neo4j.com/docs/api/nvl/current).
+- A fallback implementation for web workers when they aren't avilable in the current environment.
+- A new onDrawStarted callback for the [draw interaction handler](https://neo4j.com/docs/api/nvl/current/classes/_neo4j_nvl_interaction_handlers.DrawInteraction.html)
+
+### Fixed
+
+- Issues with lasso shape when parts of it are close to each other
+- NVL crash when sometimes position map and nodeToBundle are out of sync
+
+## [0.3.3] - 2025-02-18
+
+This is a patch release to address a dependency issue in 0.3.2
+
+### Fixed
+
+- Move Segment dependency from dev dependencies
+- Ensure workspace version references point to exact version
+
+## [0.3.2] - 2025-02-17
+
+This is our first patch release since going GA in May.
+
+### Added
+
+- [Telemetry](https://neo4j.com/docs/api/nvl/current/interfaces/_neo4j_nvl_base.NvlOptions.html#disableTelemetry)
+- [Examples](https://neo4j.com/docs/api/nvl/current/examples.html) in API documentation
+- More information in package.json files
+- Overlay icons for nodes and relationships
+- Links to documentation websites in readme
+
+### Fixed
+
+- Fixed zoom to fit for self relationships
+- Aalign selected border color
+- Issues with WebGL error propagation
+- Issue with key captures on mouse click in draw-interactions
+- Zoom to fit finishing too early
+- Improve imagecache error handling
+- Minimap viewport box not rendering
+
+## [0.3.1] - 2025-02-16
+
+This is our first GA release of NVL.
+
+### Added
+
+- Expose callback types through interactive react wrapper
+- Feature/adv interaction fw drag callbacks amendments
+- Add [lasso select interaction module](https://neo4j.com/docs/api/nvl/current/classes/_neo4j_nvl_interaction_handlers.LassoInteraction.html)
+- Configurable node ring styles
+- Support React concurrent mode in React wrappers
+- [`renderer`](https://neo4j.com/docs/api/nvl/current/interfaces/_neo4j_nvl_base.NvlOptions.html#renderer) and [`setRenderer`](https://neo4j.com/docs/api/nvl/current/classes/_neo4j_nvl_base.NVL.html#setRenderer) API option and method
+
+### Deprecated
+
+- `useWebGL` and `setUseWebGL` (use `renderer` and `setRenderer` instead).
+
+### Changed
+
+- Core library is now named "base" library
+- All packages are published publicly
+- Refactor rel validation method to improve performance
+- Convert layout web workers to shared workers
+- Don't check for WebGL availability if WebGL is disabled by NVL [`disableWebGL`](https://neo4j.com/docs/api/nvl/current/interfaces/_neo4j_nvl_base.NvlOptions.html#disableWebGL) option
+
+### Removed
+
+- Remove deprecated elements
+
+### Fixed
+
+- Wrong directions in a relationship bundle
+- Issues with node and relationship id handling when strings are not numeric
+- Zoom/pan jitter removal
+- Ensure all interaction handlers return mouse events
+- Cytoscape behaviour fixes
+- Drag triggers too early
+- Fix issue where right clicking sometime also triggers mouseup event
+- Issues in dynamic zoom boundaries
+- Don't trigger panning when mouse down was outside of NVL
+- Only register callbacks if provided
+- Ensure fit operation does not keep going on when zoom limit is reached
+- Only update hover effect of elements when graph is not empty
+- Ensure zoom to fit continues if panning has not finished yet
+- Improve html overlay scaling
+- Ensure Webgl context is released when NVL instance is destroyed
+- Emoji in captions not rendering correctly

package/README.md

@@ -90,3 +90,5 @@ For example:
   rels={[{ from: '0', to: '1', id: '10' }]}
 />
 ```
+
+You can find more instructions and examples on how to use NVL interaction handlers in the [docs](https://neo4j.com/docs/nvl/current/react-wrappers/) and [API docs](https://neo4j.com/docs/api/nvl/current/modules/_neo4j_nvl_react.html), as well as in these [NVL code examples](https://neo4j.com/docs/api/nvl/current/examples.html?tab=react-vanilla).

package/lib/basic-wrapper/BasicNvlWrapper.d.ts

@@ -23,6 +23,8 @@ export interface BasicReactWrapperProps {
     nvlCallbacks?: ExternalCallbacks;
     /** An object containing options for the Nvl instance */
     nvlOptions?: NvlOptions;
+    /** Sets the positions of the nodes in the graph using the {@link NVL.setNodePositions} method. */
+    positions?: Node[];
     /** A callback to handle any errors that happen during NVL initialization */
     onInitializationError?: (error: unknown) => void;
 }

package/lib/basic-wrapper/BasicNvlWrapper.js

@@ -12,7 +12,7 @@ import { useDeepCompareEffect } from '../utils/hooks';
  *
  * For examples, head to the {@link https://neo4j.com/docs/nvl/current/react-wrappers/#_basic_react_wrapper Basic React wrapper documentation page}.
  */
-export const BasicNvlWrapper = memo(forwardRef(({ nodes, rels, layout, layoutOptions, nvlCallbacks = {}, nvlOptions = {}, onInitializationError, ...nvlEvents }, ref) => {
+export const BasicNvlWrapper = memo(forwardRef(({ nodes, rels, layout, layoutOptions, nvlCallbacks = {}, nvlOptions = {}, positions = [], onInitializationError, ...nvlEvents }, ref) => {
     const nvlRef = useRef(null);
     useImperativeHandle(ref, () => {
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
@@ -78,17 +78,19 @@ export const BasicNvlWrapper = memo(forwardRef(({ nodes, rels, layout, layoutOpt
         nvlRef.current.removeNodesWithIds(nodeChanges.removed.map((n) => n.id));
     }, [currentNodes, currentRels, nodes, rels]);
     useEffect(() => {
-        if (nvlRef.current === null || layout === undefined) {
+        const updatedLayout = layout ?? nvlOptions.layout;
+        if (nvlRef.current === null || updatedLayout === undefined) {
             return;
         }
-        nvlRef.current.setLayout(layout);
-    }, [layout]);
+        nvlRef.current.setLayout(updatedLayout);
+    }, [layout, nvlOptions.layout]);
     useDeepCompareEffect(() => {
-        if (nvlRef.current === null || layoutOptions === undefined) {
+        const updatedLayoutOptions = layoutOptions ?? nvlOptions?.layoutOptions;
+        if (nvlRef.current === null || updatedLayoutOptions === undefined) {
             return;
         }
-        nvlRef.current.setLayoutOptions(layoutOptions);
-    }, [layoutOptions]);
+        nvlRef.current.setLayoutOptions(updatedLayoutOptions);
+    }, [layoutOptions, nvlOptions.layoutOptions]);
     useEffect(() => {
         if (nvlRef.current === null || nvlOptions.useWebGL === undefined) {
             return;
@@ -107,5 +109,11 @@ export const BasicNvlWrapper = memo(forwardRef(({ nodes, rels, layout, layoutOpt
         }
         nvlRef.current.setDisableWebGL(nvlOptions.disableWebGL);
     }, [nvlOptions.disableWebGL]);
+    useEffect(() => {
+        if (nvlRef.current === null || positions.length === 0) {
+            return;
+        }
+        nvlRef.current.setNodePositions(positions);
+    }, [positions]);
     return _jsx("div", { id: BASIC_WRAPPER_ID, ref: containerRef, style: { height: '100%', outline: '0' }, ...nvlEvents });
 }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neo4j-nvl/react",
-  "version": "0.3.6-8c7576fc",
+  "version": "0.3.6-ab6fbe86",
   "main": "lib/index.js",
   "homepage": "https://neo4j.com/docs/nvl/current/",
   "license": "SEE LICENSE IN 'LICENSE.txt'",
@@ -18,8 +18,8 @@
     "build": "yarn global:tsc",
     "watch": "yarn global:tsc -w",
     "test": " yarn global:jest",
-    "prepack": "cp ../../LICENSE.txt ./",
-    "postpack": "rm LICENSE.txt",
+    "prepack": "cp ../../LICENSE.txt ./ && cp ../../CHANGELOG.md ./",
+    "postpack": "rm LICENSE.txt && rm CHANGELOG.md",
     "eslint": "yarn global:eslint ./src/"
   },
   "files": [
@@ -34,8 +34,8 @@
     "babel-eslint": "^10.1.0"
   },
   "dependencies": {
-    "@neo4j-nvl/base": "0.3.6-8c7576fc",
-    "@neo4j-nvl/interaction-handlers": "0.3.6-8c7576fc",
+    "@neo4j-nvl/base": "0.3.6-ab6fbe86",
+    "@neo4j-nvl/interaction-handlers": "0.3.6-ab6fbe86",
     "lodash": "4.17.21",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"