@neo4j-nvl/base 0.3.6 → 0.3.7-e45b6384

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/CHANGELOG.md +152 -0
  2. package/README.md +1 -0
  3. package/dist/base.mjs +1 -1
  4. package/dist/types/index.d.ts +6 -3
  5. package/dist/types/layouts/animatedlayout/AnimatedLayout.d.ts +1 -1
  6. package/dist/types/layouts/forcedirectedlayout/cosebilkentlayout/CoseBilkentLayout.d.ts +2 -2
  7. package/dist/types/layouts/forcedirectedlayout/physlayout/PhysLayout.d.ts +1 -1
  8. package/dist/types/layouts/freeLayout/FreeLayout.d.ts +1 -1
  9. package/dist/types/layouts/hierarchicallayout/HierarchicalLayout.d.ts +2 -2
  10. package/dist/types/layouts/hierarchicallayout/constants.d.ts +1 -1
  11. package/dist/types/modules/NvlController.d.ts +2 -1
  12. package/dist/types/modules/ZoomTransitionHandler.d.ts +1 -1
  13. package/dist/types/modules/state/constants.d.ts +9 -0
  14. package/dist/types/modules/state/state.d.ts +8 -0
  15. package/dist/types/modules/{state.d.ts → state/types.d.ts} +70 -16
  16. package/dist/types/modules/state/utils.d.ts +44 -0
  17. package/dist/types/modules/state/utils.test.d.ts +1 -0
  18. package/dist/types/renderers/canvasrenderer/CanvasRenderer.d.ts +2 -1
  19. package/dist/types/renderers/canvasrenderer/arrows/arrows.d.ts +8 -5
  20. package/dist/types/renderers/canvasrenderer/arrows/constants.d.ts +1 -6
  21. package/dist/types/renderers/canvasrenderer/nodes/nodes.d.ts +3 -2
  22. package/dist/types/renderers/canvasrenderer/util.d.ts +2 -2
  23. package/dist/types/renderers/canvasrenderer/wordwrap.d.ts +1 -1
  24. package/dist/types/renderers/webglrenderer/Controller.d.ts +1 -1
  25. package/dist/types/renderers/webglrenderer/Renderer.d.ts +1 -1
  26. package/dist/types/renderers/webglrenderer/node-fragment-point.d.ts +1 -1
  27. package/dist/types/renderers/webglrenderer/node-vertex-point.d.ts +1 -1
  28. package/dist/types/renderers/webglrenderer/viewport-box-fragment.d.ts +1 -1
  29. package/dist/types/renderers/webglrenderer/viewport-box-vertex.d.ts +1 -1
  30. package/dist/types/utils/ariaUtils.d.ts +3 -0
  31. package/dist/types/utils/ariaUtils.test.d.ts +1 -0
  32. package/dist/types/utils/colorUtils.d.ts +14 -0
  33. package/dist/types/utils/colorUtils.test.d.ts +1 -0
  34. package/dist/types/utils/constants.d.ts +9 -2
  35. package/dist/types/utils/graphObjectUtils.d.ts +2 -1
  36. package/dist/types/utils/hittest.d.ts +1 -1
  37. package/dist/types/utils/webWorkerUtils.d.ts +3 -0
  38. package/dist/types/utils/webWorkerUtils.test.d.ts +1 -0
  39. package/dist/types/utils/zoomFunctions.d.ts +32 -1
  40. package/package.json +6 -5
  41. package/dist/types/utils/colorMapperFunctions.d.ts +0 -6
  42. /package/dist/types/modules/{state.test.d.ts → state/state.test.d.ts} +0 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,152 @@
1
+ # Changelog
2
+
3
+ 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/).
4
+
5
+ ## [0.3.7] - 2025-02-28
6
+
7
+ ### Added
8
+
9
+ * Export zoom functionalities as a named function
10
+ * Add a `positions` prop to the react wrapper
11
+ * Color custimzation options
12
+ * Aria attributes for NVL canvas and option to disable them
13
+ * Option to disable web workers
14
+
15
+ ### Changed
16
+
17
+ * Change default threshold when relationship captions are displayed
18
+ * update default selection color and default node color to be aligned with the Neo4j Design Library
19
+
20
+ ### Deprecated
21
+
22
+ * `selectedBorderColor` - use `styling.selectedBorderColor` instead
23
+ * `nodeDefaultBorderColor` - use `styling.nodeDefaultBorderColor` instead
24
+
25
+ ### Fixed
26
+
27
+ * Fix icon colors not being inverted for dark node colors
28
+ * fix bug where selected border color was not processed if a default border color was not provided in options
29
+ * Address several warnings during initialization
30
+ * Address multi-select callback inconsistencies
31
+ * Canvas renderer performance improvements
32
+ * ensure properties provided via `nvlOptions` are also updated on prop change in React wrappers
33
+
34
+ ## [0.3.6] - 2025-02-21
35
+
36
+ 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.
37
+
38
+ ### Added
39
+
40
+ - [result transformer for the Neo4j JavaScript Driver](https://neo4j.com/docs/api/nvl/current/functions/_neo4j_nvl_base.nvlResultTransformer.html)
41
+ - [option](https://neo4j.com/docs/api/nvl/current/types/_neo4j_nvl_base.ZoomOptions.html) to disable transition when fitting nodes
42
+
43
+ ### Fixed
44
+
45
+ - lasso handler issues during initialization
46
+
47
+ ## [0.3.5] - 2025-02-20
48
+
49
+ NVL 0.3.5 contains several bug fixes and changes the default rendering method of NVL from "webgl" to "canvas".
50
+
51
+ ### Changed
52
+
53
+ - Change default value for renderer to canvas
54
+
55
+ ### Fixed
56
+
57
+ - Self-referring relationship overlay icon rotation position issue
58
+ - Invalid lasso area calculation when segment from first to last point intersects
59
+
60
+ ## [0.3.4] - 2025-02-19
61
+
62
+ 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.
63
+
64
+ ### Added
65
+
66
+ - NVL's API documentation and examples on [neo4j.com/docs/api/nvl/current](http://neo4j.com/docs/api/nvl/current).
67
+ - A fallback implementation for web workers when they aren't avilable in the current environment.
68
+ - A new onDrawStarted callback for the [draw interaction handler](https://neo4j.com/docs/api/nvl/current/classes/_neo4j_nvl_interaction_handlers.DrawInteraction.html)
69
+
70
+ ### Fixed
71
+
72
+ - Issues with lasso shape when parts of it are close to each other
73
+ - NVL crash when sometimes position map and nodeToBundle are out of sync
74
+
75
+ ## [0.3.3] - 2025-02-18
76
+
77
+ This is a patch release to address a dependency issue in 0.3.2
78
+
79
+ ### Fixed
80
+
81
+ - Move Segment dependency from dev dependencies
82
+ - Ensure workspace version references point to exact version
83
+
84
+ ## [0.3.2] - 2025-02-17
85
+
86
+ This is our first patch release since going GA in May.
87
+
88
+ ### Added
89
+
90
+ - [Telemetry](https://neo4j.com/docs/api/nvl/current/interfaces/_neo4j_nvl_base.NvlOptions.html#disableTelemetry)
91
+ - [Examples](https://neo4j.com/docs/api/nvl/current/examples.html) in API documentation
92
+ - More information in package.json files
93
+ - Overlay icons for nodes and relationships
94
+ - Links to documentation websites in readme
95
+
96
+ ### Fixed
97
+
98
+ - Fixed zoom to fit for self relationships
99
+ - Aalign selected border color
100
+ - Issues with WebGL error propagation
101
+ - Issue with key captures on mouse click in draw-interactions
102
+ - Zoom to fit finishing too early
103
+ - Improve imagecache error handling
104
+ - Minimap viewport box not rendering
105
+
106
+ ## [0.3.1] - 2025-02-16
107
+
108
+ This is our first GA release of NVL.
109
+
110
+ ### Added
111
+
112
+ - Expose callback types through interactive react wrapper
113
+ - Feature/adv interaction fw drag callbacks amendments
114
+ - Add [lasso select interaction module](https://neo4j.com/docs/api/nvl/current/classes/_neo4j_nvl_interaction_handlers.LassoInteraction.html)
115
+ - Configurable node ring styles
116
+ - Support React concurrent mode in React wrappers
117
+ - [`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
118
+
119
+ ### Deprecated
120
+
121
+ - `useWebGL` and `setUseWebGL` (use `renderer` and `setRenderer` instead).
122
+
123
+ ### Changed
124
+
125
+ - Core library is now named "base" library
126
+ - All packages are published publicly
127
+ - Refactor rel validation method to improve performance
128
+ - Convert layout web workers to shared workers
129
+ - 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
130
+
131
+ ### Removed
132
+
133
+ - Remove deprecated elements
134
+
135
+ ### Fixed
136
+
137
+ - Wrong directions in a relationship bundle
138
+ - Issues with node and relationship id handling when strings are not numeric
139
+ - Zoom/pan jitter removal
140
+ - Ensure all interaction handlers return mouse events
141
+ - Cytoscape behaviour fixes
142
+ - Drag triggers too early
143
+ - Fix issue where right clicking sometime also triggers mouseup event
144
+ - Issues in dynamic zoom boundaries
145
+ - Don't trigger panning when mouse down was outside of NVL
146
+ - Only register callbacks if provided
147
+ - Ensure fit operation does not keep going on when zoom limit is reached
148
+ - Only update hover effect of elements when graph is not empty
149
+ - Ensure zoom to fit continues if panning has not finished yet
150
+ - Improve html overlay scaling
151
+ - Ensure Webgl context is released when NVL instance is destroyed
152
+ - Emoji in captions not rendering correctly
package/README.md CHANGED
@@ -44,3 +44,4 @@ In order to improve the library we are collecting some information about the usa
44
44
 
45
45
  - NVL documentation: https://neo4j.com/docs/nvl/current/
46
46
  - NVL API docs: https://neo4j.com/docs/api/nvl/current/
47
+ - NVL code examples: https://neo4j.com/docs/api/nvl/current/examples.html