Skip to content

Commit

Permalink
Release 15th Dec (#84)
Browse files Browse the repository at this point in the history
---- MBRDI Changes:
Bug Fixes & New Features

---- Neodash Changes:
* Renamed docs portal

* Release 2.3.4 (neo4j-labs#580)

* Improved contrast for light and dark theme interfaces

* Improve styling for actions model. Improved robustness of card settings content

* First draft

* Fix editing

* Clean console

* Clean  drawer

* Fixed issue where users cannot return to edit mode after turning off editing. Make extensions a seperate FAB. Improved styling for rule-based styling creation modal

* circular dependencies

* circular dependencies 2

* circular dependencies 3

* circular dependencies 4

* circular dependencies 5

* Last clean

* Deleting Sidebar and Workflow

* Final touch

* Icons migration 1

* Icons material free

* Reducing duplication

* Smells

* uuid migration

* Added user agent to driver object

* Bumped version

* Added better version format

* Moving circular to dev dep

* Smells

* Adding release notes

* Updated Github runners

* Fixed IT test for advanced settings

* remove luma + markers pin

* Selector options

* Fixed double scroll bar

* Tooltips nivo contrast

* Runs on non drafts

* Color picker selection

* Version bump and release notes

* Fix on Nivo Canvas

* Fixing unused import

* Fix version 2.3.4 (neo4j-labs#581)

* Hotfix for outdated version config on some components

---------

Co-authored-by: Niels de Jong <niels-121@hotmail.com>

* Fix axis color on non canvas

* Moving Header Text color up

* Adjusting to default
Pie Margins default neo4j-labs#486

* Bump @adobe/css-tools from 4.1.0 to 4.3.1

Bumps [@adobe/css-tools](https://github.com/adobe/css-tools) from 4.1.0 to 4.3.1.
- [Changelog](https://github.com/adobe/css-tools/blob/main/History.md)
- [Commits](https://github.com/adobe/css-tools/commits)

---
updated-dependencies:
- dependency-name: "@adobe/css-tools"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

* Removed hardcoded subpath
Signed off: monish.nandakumaran@mercedes-benz.com

* Fix multiple providers

* Update quickstart.adoc

change docker pull to use neo4jlabs repo instead of Niels

* Fix if

* Base config

* Docs on ssoProviders

* Optional Params

* Fix bar colors

* Cherry Cleaned

* Extra colors

* Fix

* Improve robustness for edge header title

* Fix locale and link prep

* Clean logs

* Changelog

* Version bumps

* Tests

* Change start to prod

* back to dev

* back to prod

* Version package

* bump cypress

* bump cypress

* Font on pies

* FIxes

* FIxes

* Made API keys hidden (password fields) in the query translator module

* Added new report action type for tables: multiselect checkboxes (neo4j-labs#664)

* Work in progress on table checkboxes

* Fix handling external updates of parameter values in parameter selector

* Improved handling of multiselector parameters for tables with checkboxes

* Removed console log statement. Fix invalid behaviour

* Updated comments

* Added multiselect value limit

* Clean up action rule create modal

* Added docs on multiple selection with table rows and report actions

* Fix handling external updates of parameter values in parameter selector (neo4j-labs#663)

* Fix handling external updates of parameter values in parameter selector

* Removed console log statement. Fix invalid behaviour

* Updated comments

* Feature/new dashboard load UI (neo4j-labs#657)

* Added sidebar prototype

* Return of the sidebar

* Add database selector to sidebar

* Iterating on the dashboard sidebar interface

* Fixed usage of hardcoded color

* Updated dashboard loading mechanism, iterating

* Updated dashboard loading mechanism, iterating

* Updated file structure for dashboard sidebar

* Improved modal/menu handling for dashboard load

* Import/export dashboards

* New dashboard sharing interface

* Removed old save/load modal

* Finalized v1 of the new multi-dashboard UI

* removing useless imports

* Removed old isLoaded in state of dashboard load screen. Updated warning buttons

---------

Co-authored-by: Alfred Rubin <alfredo.rubin@neo4j.com>

* Bump @babel/traverse from 7.21.4 to 7.23.2 in /gallery (neo4j-labs#670)

Bumps [@babel/traverse](https://github.com/babel/babel/tree/HEAD/packages/babel-traverse) from 7.21.4 to 7.23.2.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.23.2/packages/babel-traverse)

---
updated-dependencies:
- dependency-name: "@babel/traverse"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Harold Agudelo <agudeloharold13@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump @babel/traverse from 7.20.13 to 7.23.2 (neo4j-labs#669)

Bumps [@babel/traverse](https://github.com/babel/babel/tree/HEAD/packages/babel-traverse) from 7.20.13 to 7.23.2.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.23.2/packages/babel-traverse)

---
updated-dependencies:
- dependency-name: "@babel/traverse"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Harold Agudelo <agudeloharold13@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Niels de Jong <Niels-121@hotmail.com>

* Bump postcss from 8.4.23 to 8.4.31 in /gallery (neo4j-labs#656)

Bumps [postcss](https://github.com/postcss/postcss) from 8.4.23 to 8.4.31.
- [Release notes](https://github.com/postcss/postcss/releases)
- [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
- [Commits](postcss/postcss@8.4.23...8.4.31)

---
updated-dependencies:
- dependency-name: postcss
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Harold Agudelo <agudeloharold13@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Niels de Jong <Niels-121@hotmail.com>

* Bump postcss from 8.4.21 to 8.4.31 (neo4j-labs#655)

Bumps [postcss](https://github.com/postcss/postcss) from 8.4.21 to 8.4.31.
- [Release notes](https://github.com/postcss/postcss/releases)
- [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
- [Commits](postcss/postcss@8.4.21...8.4.31)

---
updated-dependencies:
- dependency-name: postcss
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Harold Agudelo <agudeloharold13@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Niels de Jong <Niels-121@hotmail.com>

* Text hard to read on dark theme (neo4j-labs#668)

* Hiding columns in Table does not work neo4j-labs#374

* Revert "Hiding columns in Table does not work neo4j-labs#374"

This reverts commit dc36d84.

* Text hard to read on Dark Theme neo4j-labs#667

* Fixed code style

---------

Co-authored-by: Niels de Jong <niels-121@hotmail.com>

* Hotfix for wrong default parameter replacement in markdown

* Add back arrow on connection modal (neo4j-labs#675)

* fix: add back arrow on connection modal

* WIP on improved back arrow for connection modal

* Fixed dismissable connection modal based on connected state and standalone mode

---------

Co-authored-by: Niels de Jong <niels-121@hotmail.com>

* VULCAN-126/Override default message (neo4j-labs#683)

* Override default message

* Refactored code

* refactored code

* Added docs

---------

Co-authored-by: Monish <139316519+m-o-n-i-s-h@users.noreply.github.com>

* Fix/hiding columns in table (neo4j-labs#685)

* fixed the issues with not being able to close columns in table chart

* reverted back to orignal testpass

---------

Co-authored-by: aleksandarneo4j <aleksandar.simeunovic@neotechnology.com>

* Fix parameters values (neo4j-labs#641)

Co-authored-by: Niels de Jong <Niels-121@hotmail.com>

* Updated dashboard format to 2.4. Double resolution for horizontal and vertical card placement. Fixed several small usability issues (neo4j-labs#682)

* Updated dashboard format to 2.4. Double resolution for horizontal and vertical card placement. Fixed several small usability issues

* Handling for dashboards in standalone mode

* cleaning code followign SonarCloud code smells

* changed migration function to reduce duplication, tested on twitter example dashboard

* changed how we fetch the latest version of the code

* changed migration function to reduce duplication, to test for applicationThunks

---------

Co-authored-by: Alfred Rubin <alfredo.rubin@neo4j.com>

* Feature/gantt chart (neo4j-labs#684)

* Added forms skeleton

* Completed form skeleton

* WIP on forms interface

* Form framework (data entry, running, success, error) added

* Added comments

* Adding fields specification interface

* UI for specifying individual parameter in a form

* changing Dockerfile to enable args during build

* fixing typo on argument in dockerfile

* reverting dockerfile to older version

* Rendering parameters inside the form component

* Added docs for forms. Improved stability on form

* Fixed warnings in console

* Finished IT test for forms report

* Added package

* added new field to disable a parameter selector (in this way it works only with actions)

* Gantt Chart Visualization

* Fixed issue where parameter values were not updated on external changes

* Fixed styling on freetext spinner

* Workaround for clipping menu selectors in Needle

* fix(rule based styling): js doing is magic with parseFloat (some strings were casted to floats event if they were just strings starting with 0

* Added save button to form create UI

* removing console logs

* Fix for needle dropdowns not showing on modals

* Sortable list for form parameters

* Improving the drag 'n drop

* Iterating on form interface

* Final version of forms

* Disabling test

* Gantt chart with live data

* Improved robustness of form / parameter select component

* Improve Gantt chart customizability. Added report action for Gantt charts

* Added wait-logic for form submission, so that all fields are debounced and set correctly

* Added multiline support for freetext parameter selector

* Added support for drilled-down parameters used in the forms component

* Fixed issues with parameter selector/forms, improve usability

* Added default advanced settings to form

* hanging if orders to prevent wrong casting to number for certain edge cases (EX: string with numbers and E : 00E1304)

* adding more options to gantt chart and adding variable calendar type

* Prototype of Frappe Gantt implementation

* Improved version of frappe gantt

* work in progress on new gantt chart

* Clean up code structure

* Clean up and documenting Gantt chart

* Gantt chart stability & arrow directions

* Handling task dependency directions in Gantt chart

* Improved styling

* More optimization & style fixes.

* Added docs for Gantt Chart

* Added rule-based styling and actions to Gantt chart

* Finalized Gantt chart docs, examples, and fallback date parsing

* removing code smells

* trying to plug quarter date format and cleaning code

* cleaning code accordingly to SonarCloud

* Fixed UI not populating correctly for rule-based styling and actions

* Gantt - fixed default width/height for bars. Visible labels. Handling quarters

* Updated label positions

* Fixed inspect modal for Gantt chart, fixed arrow spacing between tasks

* Fixed linting issues

---------

Co-authored-by: Niels de Jong <niels-121@hotmail.com>
Co-authored-by: Alfred Rubin <alfredo.rubin@neo4j.com>

* adding in advanced config for the graph viz more graph layout config … (neo4j-labs#690)

* adding in advanced config for the graph viz more graph layout config options

* added doc about the new advanced setting

---------

Co-authored-by: aleksandarneo4j <aleksandar.simeunovic@neotechnology.com>

* Adding form widget as a new extension (neo4j-labs#568)

* Added forms skeleton

* Completed form skeleton

* WIP on forms interface

* Form framework (data entry, running, success, error) added

* Added comments

* Adding fields specification interface

* UI for specifying individual parameter in a form

* changing Dockerfile to enable args during build

* fixing typo on argument in dockerfile

* reverting dockerfile to older version

* Rendering parameters inside the form component

* Added docs for forms. Improved stability on form

* Fixed warnings in console

* Finished IT test for forms report

* added new field to disable a parameter selector (in this way it works only with actions)

* Fixed issue where parameter values were not updated on external changes

* Fixed styling on freetext spinner

* Workaround for clipping menu selectors in Needle

* fix(rule based styling): js doing is magic with parseFloat (some strings were casted to floats event if they were just strings starting with 0

* Added save button to form create UI

* removing console logs

* Fix for needle dropdowns not showing on modals

* Sortable list for form parameters

* Improving the drag 'n drop

* Iterating on form interface

* Final version of forms

* Disabling test

* Improved robustness of form / parameter select component

* Updated docs, added clear form button

* removing code smells

* cleaning code followign SonarCloud code smells

* cleaning code followign SonarCloud code smells

* removing code smells

* Intelligent parameters clearing in forms

---------

Co-authored-by: Alfred Rubin <alfredo.rubin@neo4j.com>

* Model Examples and LLM improvements (neo4j-labs#600)

* now when changing database in a card the query will retrigger correctly

* adding schema sampling with apoc.meta.data and changing system prompt

* cleaning code and adding examples management

* starting working on plugging examples to the model

* examples plugged to state and to the modelClient to add the example prompy

* fixed examples in modelCLient because the there was a missing edge case

* added Q&A form for AI training

* Updated styling, added validation

* validation on q&a form (to talk with Marius about UX and styling)

* watching smells on sonarqube

* Question Answer form updated with tailwind and needle styling

* WIP creating edit Q&A modal

* working on examples modal

* WIP trying to get index prop to pass for ExampleEditorModal to work properly

* fix

* WIP

* latest

* plugging modelExamples table to the state and changing folder structure

* Issue with addModelExample action call

* working on model examples and fixing prompt behaviour

* Paginated table implemented. Needs styling.

* pagination done

* Added cypher code editor. No line numbers right now - would be useful. Also no label for cypher editor

* Added loading button when saving, error message if cypher editor is empty upon submission, removed legacy code

* latest

* ready for review

* changing prompt

* Updated. Fixed editing. Ready for Review

* fixing code smells

* WIP

* WIP ExampleDisplayTable2

* styling and pagination needed

* table done with styling, pagination

* deleted old table

* code smell 2/7 check

* check smells

* Checking smells

* moving component inside const

* Table ready for review

* Added initial pageSize

* Fixed instructions on 'tweak model' screen

* Fixed instructions on 'tweak model' screen

* Got rid of show number of queries per page

* checking code smells

* removing useless row from task definition

* changing folder names and changin from lazy import to normal on in ExtensionConfig

* removing code smells

* removing code smells

* removing code smells

* Fixed double dependency on react-table

* refactoring code according to Sonarcube code smelles and fixed play button on card vie w to rerun the chatCompletion

* Improved names

* Usability improvements for LLM extension

* Updating docs

* Added docs for custom LLM examples

---------

Co-authored-by: Alfred Rubin <alfredo.rubin@neo4j.com>
Co-authored-by: jacobbleakley-neo4j <jacob.bleakley@neo4j.com>
Co-authored-by: Niels de Jong <niels-121@hotmail.com>

* Added release notes for 2.4 + bonus feature (keyboard shortcut to run query from the editor) (neo4j-labs#694)

* Release notes for 2.4

* Updated release notes. Added quick feature to run reports with keyboard shortcuts

* Finalized release notes

* Hotfix for not clearing disabled parameters in forms

* Finalized release notes

* Removed old gantt chart dependency

* Bump docs version to 2.4

* Fixed issue with CodeMirror editor not capturing keys in Cypress test

* Hotfix for automigrated tree layouts

* Hotfixes for Sonarqube issues

* minor fix in the forms where it wasn't getting the correct value in the settings

* 2.4 Release (neo4j-labs#688)

* Made API keys hidden (password fields) in the query translator module

* Added new report action type for tables: multiselect checkboxes (neo4j-labs#664)

* Work in progress on table checkboxes

* Fix handling external updates of parameter values in parameter selector

* Improved handling of multiselector parameters for tables with checkboxes

* Removed console log statement. Fix invalid behaviour

* Updated comments

* Added multiselect value limit

* Clean up action rule create modal

* Added docs on multiple selection with table rows and report actions

* Fix handling external updates of parameter values in parameter selector (neo4j-labs#663)

* Fix handling external updates of parameter values in parameter selector

* Removed console log statement. Fix invalid behaviour

* Updated comments

* Feature/new dashboard load UI (neo4j-labs#657)

* Added sidebar prototype

* Return of the sidebar

* Add database selector to sidebar

* Iterating on the dashboard sidebar interface

* Fixed usage of hardcoded color

* Updated dashboard loading mechanism, iterating

* Updated dashboard loading mechanism, iterating

* Updated file structure for dashboard sidebar

* Improved modal/menu handling for dashboard load

* Import/export dashboards

* New dashboard sharing interface

* Removed old save/load modal

* Finalized v1 of the new multi-dashboard UI

* removing useless imports

* Removed old isLoaded in state of dashboard load screen. Updated warning buttons

---------

Co-authored-by: Alfred Rubin <alfredo.rubin@neo4j.com>

* Bump @babel/traverse from 7.21.4 to 7.23.2 in /gallery (neo4j-labs#670)

Bumps [@babel/traverse](https://github.com/babel/babel/tree/HEAD/packages/babel-traverse) from 7.21.4 to 7.23.2.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.23.2/packages/babel-traverse)

---
updated-dependencies:
- dependency-name: "@babel/traverse"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Harold Agudelo <agudeloharold13@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump @babel/traverse from 7.20.13 to 7.23.2 (neo4j-labs#669)

Bumps [@babel/traverse](https://github.com/babel/babel/tree/HEAD/packages/babel-traverse) from 7.20.13 to 7.23.2.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.23.2/packages/babel-traverse)

---
updated-dependencies:
- dependency-name: "@babel/traverse"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Harold Agudelo <agudeloharold13@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Niels de Jong <Niels-121@hotmail.com>

* Bump postcss from 8.4.23 to 8.4.31 in /gallery (neo4j-labs#656)

Bumps [postcss](https://github.com/postcss/postcss) from 8.4.23 to 8.4.31.
- [Release notes](https://github.com/postcss/postcss/releases)
- [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
- [Commits](postcss/postcss@8.4.23...8.4.31)

---
updated-dependencies:
- dependency-name: postcss
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Harold Agudelo <agudeloharold13@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Niels de Jong <Niels-121@hotmail.com>

* Bump postcss from 8.4.21 to 8.4.31 (neo4j-labs#655)

Bumps [postcss](https://github.com/postcss/postcss) from 8.4.21 to 8.4.31.
- [Release notes](https://github.com/postcss/postcss/releases)
- [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
- [Commits](postcss/postcss@8.4.21...8.4.31)

---
updated-dependencies:
- dependency-name: postcss
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Harold Agudelo <agudeloharold13@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Niels de Jong <Niels-121@hotmail.com>

* Text hard to read on dark theme (neo4j-labs#668)

* Hiding columns in Table does not work neo4j-labs#374

* Revert "Hiding columns in Table does not work neo4j-labs#374"

This reverts commit dc36d84.

* Text hard to read on Dark Theme neo4j-labs#667

* Fixed code style

---------

Co-authored-by: Niels de Jong <niels-121@hotmail.com>

* Hotfix for wrong default parameter replacement in markdown

* Add back arrow on connection modal (neo4j-labs#675)

* fix: add back arrow on connection modal

* WIP on improved back arrow for connection modal

* Fixed dismissable connection modal based on connected state and standalone mode

---------

Co-authored-by: Niels de Jong <niels-121@hotmail.com>

* VULCAN-126/Override default message (neo4j-labs#683)

* Override default message

* Refactored code

* refactored code

* Added docs

---------

Co-authored-by: Monish <139316519+m-o-n-i-s-h@users.noreply.github.com>

* Fix/hiding columns in table (neo4j-labs#685)

* fixed the issues with not being able to close columns in table chart

* reverted back to orignal testpass

---------

Co-authored-by: aleksandarneo4j <aleksandar.simeunovic@neotechnology.com>

* Fix parameters values (neo4j-labs#641)

Co-authored-by: Niels de Jong <Niels-121@hotmail.com>

* Updated dashboard format to 2.4. Double resolution for horizontal and vertical card placement. Fixed several small usability issues (neo4j-labs#682)

* Updated dashboard format to 2.4. Double resolution for horizontal and vertical card placement. Fixed several small usability issues

* Handling for dashboards in standalone mode

* cleaning code followign SonarCloud code smells

* changed migration function to reduce duplication, tested on twitter example dashboard

* changed how we fetch the latest version of the code

* changed migration function to reduce duplication, to test for applicationThunks

---------

Co-authored-by: Alfred Rubin <alfredo.rubin@neo4j.com>

* Feature/gantt chart (neo4j-labs#684)

* Added forms skeleton

* Completed form skeleton

* WIP on forms interface

* Form framework (data entry, running, success, error) added

* Added comments

* Adding fields specification interface

* UI for specifying individual parameter in a form

* changing Dockerfile to enable args during build

* fixing typo on argument in dockerfile

* reverting dockerfile to older version

* Rendering parameters inside the form component

* Added docs for forms. Improved stability on form

* Fixed warnings in console

* Finished IT test for forms report

* Added package

* added new field to disable a parameter selector (in this way it works only with actions)

* Gantt Chart Visualization

* Fixed issue where parameter values were not updated on external changes

* Fixed styling on freetext spinner

* Workaround for clipping menu selectors in Needle

* fix(rule based styling): js doing is magic with parseFloat (some strings were casted to floats event if they were just strings starting with 0

* Added save button to form create UI

* removing console logs

* Fix for needle dropdowns not showing on modals

* Sortable list for form parameters

* Improving the drag 'n drop

* Iterating on form interface

* Final version of forms

* Disabling test

* Gantt chart with live data

* Improved robustness of form / parameter select component

* Improve Gantt chart customizability. Added report action for Gantt charts

* Added wait-logic for form submission, so that all fields are debounced and set correctly

* Added multiline support for freetext parameter selector

* Added support for drilled-down parameters used in the forms component

* Fixed issues with parameter selector/forms, improve usability

* Added default advanced settings to form

* hanging if orders to prevent wrong casting to number for certain edge cases (EX: string with numbers and E : 00E1304)

* adding more options to gantt chart and adding variable calendar type

* Prototype of Frappe Gantt implementation

* Improved version of frappe gantt

* work in progress on new gantt chart

* Clean up code structure

* Clean up and documenting Gantt chart

* Gantt chart stability & arrow directions

* Handling task dependency directions in Gantt chart

* Improved styling

* More optimization & style fixes.

* Added docs for Gantt Chart

* Added rule-based styling and actions to Gantt chart

* Finalized Gantt chart docs, examples, and fallback date parsing

* removing code smells

* trying to plug quarter date format and cleaning code

* cleaning code accordingly to SonarCloud

* Fixed UI not populating correctly for rule-based styling and actions

* Gantt - fixed default width/height for bars. Visible labels. Handling quarters

* Updated label positions

* Fixed inspect modal for Gantt chart, fixed arrow spacing between tasks

* Fixed linting issues

---------

Co-authored-by: Niels de Jong <niels-121@hotmail.com>
Co-authored-by: Alfred Rubin <alfredo.rubin@neo4j.com>

* adding in advanced config for the graph viz more graph layout config … (neo4j-labs#690)

* adding in advanced config for the graph viz more graph layout config options

* added doc about the new advanced setting

---------

Co-authored-by: aleksandarneo4j <aleksandar.simeunovic@neotechnology.com>

* Adding form widget as a new extension (neo4j-labs#568)

* Added forms skeleton

* Completed form skeleton

* WIP on forms interface

* Form framework (data entry, running, success, error) added

* Added comments

* Adding fields specification interface

* UI for specifying individual parameter in a form

* changing Dockerfile to enable args during build

* fixing typo on argument in dockerfile

* reverting dockerfile to older version

* Rendering parameters inside the form component

* Added docs for forms. Improved stability on form

* Fixed warnings in console

* Finished IT test for forms report

* added new field to disable a parameter selector (in this way it works only with actions)

* Fixed issue where parameter values were not updated on external changes

* Fixed styling on freetext spinner

* Workaround for clipping menu selectors in Needle

* fix(rule based styling): js doing is magic with parseFloat (some strings were casted to floats event if they were just strings starting with 0

* Added save button to form create UI

* removing console logs

* Fix for needle dropdowns not showing on modals

* Sortable list for form parameters

* Improving the drag 'n drop

* Iterating on form interface

* Final version of forms

* Disabling test

* Improved robustness of form / parameter select component

* Updated docs, added clear form button

* removing code smells

* cleaning code followign SonarCloud code smells

* cleaning code followign SonarCloud code smells

* removing code smells

* Intelligent parameters clearing in forms

---------

Co-authored-by: Alfred Rubin <alfredo.rubin@neo4j.com>

* Model Examples and LLM improvements (neo4j-labs#600)

* now when changing database in a card the query will retrigger correctly

* adding schema sampling with apoc.meta.data and changing system prompt

* cleaning code and adding examples management

* starting working on plugging examples to the model

* examples plugged to state and to the modelClient to add the example prompy

* fixed examples in modelCLient because the there was a missing edge case

* added Q&A form for AI training

* Updated styling, added validation

* validation on q&a form (to talk with Marius about UX and styling)

* watching smells on sonarqube

* Question Answer form updated with tailwind and needle styling

* WIP creating edit Q&A modal

* working on examples modal

* WIP trying to get index prop to pass for ExampleEditorModal to work properly

* fix

* WIP

* latest

* plugging modelExamples table to the state and changing folder structure

* Issue with addModelExample action call

* working on model examples and fixing prompt behaviour

* Paginated table implemented. Needs styling.

* pagination done

* Added cypher code editor. No line numbers right now - would be useful. Also no label for cypher editor

* Added loading button when saving, error message if cypher editor is empty upon submission, removed legacy code

* latest

* ready for review

* changing prompt

* Updated. Fixed editing. Ready for Review

* fixing code smells

* WIP

* WIP ExampleDisplayTable2

* styling and pagination needed

* table done with styling, pagination

* deleted old table

* code smell 2/7 check

* check smells

* Checking smells

* moving component inside const

* Table ready for review

* Added initial pageSize

* Fixed instructions on 'tweak model' screen

* Fixed instructions on 'tweak model' screen

* Got rid of show number of queries per page

* checking code smells

* removing useless row from task definition

* changing folder names and changin from lazy import to normal on in ExtensionConfig

* removing code smells

* removing code smells

* removing code smells

* Fixed double dependency on react-table

* refactoring code according to Sonarcube code smelles and fixed play button on card vie w to rerun the chatCompletion

* Improved names

* Usability improvements for LLM extension

* Updating docs

* Added docs for custom LLM examples

---------

Co-authored-by: Alfred Rubin <alfredo.rubin@neo4j.com>
Co-authored-by: jacobbleakley-neo4j <jacob.bleakley@neo4j.com>
Co-authored-by: Niels de Jong <niels-121@hotmail.com>

* Added release notes for 2.4 + bonus feature (keyboard shortcut to run query from the editor) (neo4j-labs#694)

* Release notes for 2.4

* Updated release notes. Added quick feature to run reports with keyboard shortcuts

* Finalized release notes

* Hotfix for not clearing disabled parameters in forms

* Finalized release notes

* Removed old gantt chart dependency

* Bump docs version to 2.4

* Fixed issue with CodeMirror editor not capturing keys in Cypress test

* Hotfix for automigrated tree layouts

* Hotfixes for Sonarqube issues

* minor fix in the forms where it wasn't getting the correct value in the settings

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Alfred Rubin <alfredo.rubin@neo4j.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Harold Agudelo <agudeloharold13@gmail.com>
Co-authored-by: Jon Ander Oribe <jonan.oribe@gmail.com>
Co-authored-by: Antônio Hugo <hugorplobo@gmail.com>
Co-authored-by: Monish <139316519+m-o-n-i-s-h@users.noreply.github.com>
Co-authored-by: Aleksandar <aleksandar.simeunovic94@gmail.com>
Co-authored-by: aleksandarneo4j <aleksandar.simeunovic@neotechnology.com>
Co-authored-by: alfredorubin96 <103421036+alfredorubin96@users.noreply.github.com>
Co-authored-by: jacobbleakley-neo4j <jacob.bleakley@neo4j.com>

* Fix hiding column prefix (neo4j-labs#695)

* fixing missing feature that was hiding columns starting with __

* removing test console log

* removing code smell

* removing code smell

* fixing test

* Bumped outdated version numbers

---------

Co-authored-by: Alfred Rubin <alfredo.rubin@neo4j.com>
Co-authored-by: Niels de Jong <niels-121@hotmail.com>

* fixing merge

* Dynamic height report

* Refactored

* Wrapping NeoDashboardSidebar in a div to prevent rendering issues

* Neodash Bug Fixes

* opens landing page in new url

* Added landing page link to logo

* Removed obsolete code

* Bug Fixes (#82)

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Niels de Jong <niels-121@hotmail.com>
Co-authored-by: Harold Agudelo <agudeloharold13@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Monish <139316519+m-o-n-i-s-h@users.noreply.github.com>
Co-authored-by: davidlrosenblum <davidlrosenblum@users.noreply.github.com>
Co-authored-by: Aleksandar <aleksandar.simeunovic94@gmail.com>
Co-authored-by: Alfred Rubin <alfredo.rubin@neo4j.com>
Co-authored-by: Jon Ander Oribe <jonan.oribe@gmail.com>
Co-authored-by: Antônio Hugo <hugorplobo@gmail.com>
Co-authored-by: aleksandarneo4j <aleksandar.simeunovic@neotechnology.com>
Co-authored-by: alfredorubin96 <103421036+alfredorubin96@users.noreply.github.com>
Co-authored-by: jacobbleakley-neo4j <jacob.bleakley@neo4j.com>
  • Loading branch information
13 people authored Dec 15, 2023
1 parent 4955adf commit 40254e0
Show file tree
Hide file tree
Showing 178 changed files with 7,656 additions and 1,728 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/master-deployment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ jobs:
context: .
file: ./Dockerfile
push: true
tags: ${{ secrets.DOCKER_HUB_LABS_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_LABS_USERNAME }}/neodash:2.3.4
tags: ${{ secrets.DOCKER_HUB_LABS_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_LABS_USERNAME }}/neodash:2.4.0
build-docker-legacy:
needs: build-test
runs-on: neodash-runners
Expand All @@ -103,7 +103,7 @@ jobs:
context: .
file: ./Dockerfile
push: true
tags: ${{ secrets.DOCKER_HUB_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_USERNAME }}/neodash:2.3.4
tags: ${{ secrets.DOCKER_HUB_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_USERNAME }}/neodash:2.4.0
deploy-gallery:
runs-on: neodash-runners
strategy:
Expand Down
47 changes: 47 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,50 @@
## NeoDash 2.4.0
NeoDash 2.4 is out! 🎂 This release packs a ton of new features, as well as improvements to the existing visualizations.

Key new features:
- A new sidebar with support for managing, save and load multiple dashboards directly from the UI.
[#657](https://github.com/neo4j-labs/neodash/pull/657)
- Added **Forms** as a new extension. Forms let you combine multiple parameter selectors in one card and have users edit/submit data to Neo4j. [#568](https://github.com/neo4j-labs/neodash/pull/568)
- Added a new advanced visualization type: Gantt charts. [#684](https://github.com/neo4j-labs/neodash/pull/684)
- Doubled the grid resolution for dashboards, giving you more freedom to arrange visualizations. [#682](https://github.com/neo4j-labs/neodash/pull/682)
- Several improvements for the natural language queries extension - including customizable prompting, and faster schema retrieval. [#600](https://github.com/neo4j-labs/neodash/pull/600)

Other improvements:
- Support for multiselect checkboxes as a report action for tables. [#688](https://github.com/neo4j-labs/neodash/pull/688/commits)
- Added keyboard shortcuts (CMD/CTRL+Enter) for running Cypher queries from the editor. [#694](https://github.com/neo4j-labs/neodash/pull/694/)
- Added new experimental graph layouts (trees in various directions), with customizable level distance. [#690](https://github.com/neo4j-labs/neodash/pull/690)
- Increased customizability for the Pie chart's styling. [#638](https://github.com/neo4j-labs/neodash/pull/638/)
- Fixed issues with parameter selector: Better handling of integer / long parameters and processing external updates. [#641](https://github.com/neo4j-labs/neodash/pull/641/)
- Improvements on text readability for the experimental dark mode. [#668](https://github.com/neo4j-labs/neodash/pull/668/)
- UX improvements on database connection interface. [#675](https://github.com/neo4j-labs/neodash/pull/675/)
- Added option to provide a custom message when no data is returned by a report. [#683](https://github.com/neo4j-labs/neodash/pull/683/)
- Fixed issue where column names were not hidden correctly. [#685](https://github.com/neo4j-labs/neodash/pull/685/commits)

Thanks to all the contributors for this release:
[alfredorubin96](https://github.com/alfredorubin96),
[AleSim94](https://github.com/AleSim94),
[BennuFire](https://github.com/BennuFire),
[jacobbleakley-neo4j](https://github.com/jacobbleakley-neo4j),
[hugorplobo](https://github.com/hugorplobo),
[brahmprakashMishra](https://github.com/brahmprakashMishra),
[m-o-n-i-s-h](https://github.com/m-o-n-i-s-h),
[JonanOribe](https://github.com/JonanOribe),
[nielsdejong](https://github.com/nielsdejong)

## NeoDash 2.3.5
This is a bugfix / stability release directly following 2.3.4.

Improvements:
- Fixed issue where orphan relationships prevented graph charts from working ([@BennuFire](https://github.com/BennuFire), [#586](https://github.com/neo4j-labs/neodash/pull/586))
- Fix issue where only one style rule was used a time on tables. ([@BennuFire](https://github.com/BennuFire), [#632](https://github.com/neo4j-labs/neodash/pull/632))
- Added information about source and target on Graph Chart information modal . ([@BennuFire](https://github.com/BennuFire), [#627](https://github.com/neo4j-labs/neodash/pull/627)) Based on [@brahmprakashMishra](https://github.com/brahmprakashMishra) PR
- Fixed issue where bar charts where displaying black bars instead of scheme colors. ([@BennuFire](https://github.com/BennuFire), [#626](https://github.com/neo4j-labs/neodash/pull/626))
- Added right subpath replacement on shared links redirection while in self deployments. ([@m-o-n-i-s-h](https://github.com/m-o-n-i-s-h), [#618](https://github.com/neo4j-labs/neodash/pull/618))
- Dark theme tweaks. ([@BennuFire](https://github.com/BennuFire), [#585](https://github.com/neo4j-labs/neodash/pull/585))
- Fixed parameter selector search where numbers were not found and sporadically displayed with decimal points. ([@BennuFire](https://github.com/BennuFire), [#633](https://github.com/neo4j-labs/neodash/pull/633))
- Added a configuration in order to list sso providers to be used whenever a database has more than one configured. ([@BennuFire](https://github.com/BennuFire), [#624](https://github.com/neo4j-labs/neodash/pull/624))
- Added 'Ignore undefined parameters' advanced setting support for optional parameters on a query. Now queries will assume a null value instead of returning the error 'Parameter not defined'. ([@BennuFire](https://github.com/BennuFire), [#625](https://github.com/neo4j-labs/neodash/pull/625))

## NeoDash 2.3.3 & 2.3.4
This is a bugfix / stability release directly following 2.3.2.

Expand Down
2 changes: 1 addition & 1 deletion cypress.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export default defineConfig({
},
retries: {
runMode: 2,
openMode: 0,
openMode: 2,
},
},
env: {
Expand Down
43 changes: 34 additions & 9 deletions cypress/e2e/start_page.cy.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
loadDashboardURL,
sankeyChartCypherQuery,
gaugeChartCypherQuery,
formCypherQuery,
} from '../fixtures/cypher_queries';

const WAITING_TIME = 20000;
Expand Down Expand Up @@ -244,13 +245,28 @@ describe('NeoDash E2E Tests', () => {
cy.get('main .react-grid-item:eq(2) .MuiCardContent-root h1', { timeout: 45000 }).should('have.text', 'Hello');
});

// it('creates a radar report', () => {
// // TODO - create a test for radar.
// })
it.skip('creates a form report', () => {
enableFormsExtension();
checkInitialState();
createReportOfType('Form', formCypherQuery, true, false);
cy.get('main .react-grid-item:eq(2) .form-add-parameter').click();
cy.wait(200);
cy.get('#autocomplete-label-type').type('Movie');
cy.get('#autocomplete-label-type-option-0').click();
cy.wait(200);
cy.get('#autocomplete-property').type('title');
cy.get('#autocomplete-property-option-0').click();

// it('creates a sankey report', () => {
// // TODO - create a test for sankey charts.
// })
cy.get('.ndl-dialog-close').click();

cy.get('main .react-grid-item:eq(2) button[aria-label="run"]').scrollIntoView().should('be.visible').click();
cy.wait(500);
cy.get('#autocomplete').type('The Matrix');
cy.get('#autocomplete-option-0').click();
cy.get('#form-submit').click();
cy.wait(500);
cy.get('.form-submitted-message').should('have.text', 'Form Submitted.Reset Form');
});

// Test load stress-test dashboard from file
// TODO - this test is flaky, especially in GitHub actions environment.
Expand Down Expand Up @@ -285,6 +301,14 @@ function enableAdvancedVisualizations() {
cy.wait(200);
}

function enableFormsExtension() {
cy.get('main button[aria-label="Extensions').should('be.visible').click();
cy.get('#checkbox-forms').scrollIntoView();
cy.get('#checkbox-forms').should('be.visible').click();
cy.get('.ndl-dialog-close').scrollIntoView().should('be.visible').click();
cy.wait(200);
}

function selectReportOfType(type) {
cy.get('main .react-grid-item button[aria-label="add report"]').should('be.visible').click();
cy.get('main .react-grid-item')
Expand All @@ -298,7 +322,7 @@ function selectReportOfType(type) {
cy.wait(100);
}

function createReportOfType(type, query, fast = false) {
function createReportOfType(type, query, fast = false, run = true) {
selectReportOfType(type);
if (fast) {
cy.get('main .react-grid-item:eq(2) .ReactCodeMirror').type(query, { delay: 1, parseSpecialCharSequences: false });
Expand All @@ -308,8 +332,9 @@ function createReportOfType(type, query, fast = false) {
cy.wait(400);

cy.get('main .react-grid-item:eq(2)').contains('Advanced settings').click();

cy.get('main .react-grid-item:eq(2) button[aria-label="run"]').click();
if (run) {
cy.get('main .react-grid-item:eq(2) button[aria-label="run"]').click();
}
}

function checkInitialState() {
Expand Down
1 change: 1 addition & 0 deletions cypress/fixtures/cypher_queries.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ An external workflow picks up this directory, embeds it into the Neo4j docs, and
```
https://neo4j.com/labs/neodash/{version}
```
For example: https://neo4j.com/labs/neodash/2.3
For example: https://neo4j.com/labs/neodash/2.4

## Local Build
To compile and view the documentation locally, navigate to this (`./docs`) folder and run:
Expand Down
4 changes: 2 additions & 2 deletions docs/antora.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
name: neodash
version: 2.3
version: 2.4
title: NeoDash
start_page: ROOT:index.adoc
nav:
- modules/ROOT/nav.adoc

asciidoc:
attributes:
docs-version: 2.3
docs-version: 2.4
page-product: NeoDash
page-type: NeoDash Manual
page-canonical-root: /labs
Binary file added docs/modules/ROOT/images/createform.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/modules/ROOT/images/formbutton.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/modules/ROOT/images/forms.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/modules/ROOT/images/formselector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/modules/ROOT/images/formsimple.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/modules/ROOT/images/gantt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/modules/ROOT/images/llm-examples.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/modules/ROOT/images/select-single-table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@
*** xref:user-guide/reports/treemap.adoc[Treemap]
*** xref:user-guide/reports/radar.adoc[Radar Chart]
*** xref:user-guide/reports/sankey.adoc[Sankey Chart]
*** xref:user-guide/reports/gantt.adoc[Gantt Chart]
*** xref:user-guide/reports/map.adoc[Map]
*** xref:user-guide/reports/single-value.adoc[Single Value]
*** xref:user-guide/reports/gauge-chart.adoc[Gauge Chart]
*** xref:user-guide/reports/raw-json.adoc[Raw JSON]
*** xref:user-guide/reports/parameter-select.adoc[Parameter Select]
*** xref:user-guide/reports/form.adoc[Form]
*** xref:user-guide/reports/iframe.adoc[iFrame]
*** xref:user-guide/reports/markdown.adoc[Markdown]
** xref:user-guide/publishing.adoc[Publishing]
Expand All @@ -29,7 +31,8 @@
*** xref:user-guide/extensions/advanced-visualizations.adoc[Advanced Visualizations]
*** xref:user-guide/extensions/rule-based-styling.adoc[Rule-Based Styling]
*** xref:user-guide/extensions/report-actions.adoc[Report Actions]
*** xref:user-guide/extensions/natural-language-queries.adoc[Natural Language Queries]
*** xref:user-guide/extensions/natural-language-queries.adoc[Text2Cypher - Natural Language Queries]
*** xref:user-guide/extensions/forms.adoc[Forms]
** xref:user-guide/faq.adoc[FAQ]
* xref:developer-guide/index.adoc[Developer Guide]
** xref:developer-guide/build-and-run.adoc[Build & Run]
Expand Down
3 changes: 3 additions & 0 deletions docs/modules/ROOT/pages/developer-guide/configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ will look like this:
....
{
"ssoEnabled": false,
"ssoProviders": [],
"ssoDiscoveryUrl": "https://example.com",
"standalone": false,
"standaloneProtocol": "neo4j",
Expand All @@ -37,6 +38,8 @@ will look like this:
using SSO. This requires the app to be running in standalone mode, and a
valid ssoDiscoveryUrl to be set.

|ssoProviders |List |[] |When using multiple SSO providers on the database, you can configure the list of providers (by id) to be used on Neodash. If empty, all providers will be displayed.

|ssoDiscoveryUrl |string |https://example.com |If ssoEnabled is true &
standalone mode is enabled, the URL to retrieve SSO auth config from.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Depending on the webserver type and version, this could be different directory.
As an example - to copy the files to an nginx webserver using `scp`:

```bash
scp neodash-2.3.4 username@host:/usr/share/nginx/html
scp neodash-2.4.0 username@host:/usr/share/nginx/html
```

NeoDash should now be visible by visiting your (sub)domain in the browser.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ variables to Docker:
....
docker run -it --rm -p 5005:5005 \
-e ssoEnabled=false \
-e ssoProviders=[] \
-e ssoDiscoveryUrl="https://example.com" \
-e standalone=true \
-e standaloneProtocol="neo4j" \
Expand Down
5 changes: 3 additions & 2 deletions docs/modules/ROOT/pages/developer-guide/state-management.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ structure:
{
"dashboard": {
"title": "My Dashboard Name",
"version": "2.3",
"version": "2.4",
"settings": {
"pagenumber": 0,
"editable": true,
Expand Down Expand Up @@ -56,7 +56,7 @@ dashboard. Take the following simple dashboard as an example.
{
"dashboard": {
"title": "A Simple Dashboard",
"version": "2.3",
"version": "2.4",
"settings": {
"pagenumber": 0,
"editable": true,
Expand Down Expand Up @@ -127,6 +127,7 @@ standalone mode.
"standalone": false,
"oldDashboard": null,
"ssoEnabled": false,
"ssoProviders": [],
"ssoDiscoveryUrl": "https://example.com",
"standaloneProtocol": "neo4j",
"standaloneHost": "localhost",
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/quickstart.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ https://neodash.graphapp.io.
App Gallery].
. Using Docker:
```
docker pull neo4jlabs/neodash:latest
docker pull neo4jlabs/neodash:latest
docker run -it --rm -p 5005:5005 neo4jlabs/neodash
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ The following visualizations are part of this extension:

- A link:../../reports/sankey[Sankey Chart] to visualize flows.
- Three charts to plot hierarchical data (link:../../reports/sunburst[Sunburst], link:../../reports/circle-packing[Circle Packing], link:../../reports/treemap[Treemap])
- A link:../../reports/gauge-chart[Gauge Chart] to show percentages
- A link:../../reports/gauge-chart[Gauge Chart] to show percentages.
- An link:../../reports/choropleth[Choropleth] to visualize numeric, country-data.
- An link:../../reports/areamap[Area Map] to show an interactive world map, annotated with numeric country / region values.
- A link:../../reports/gantt[Gantt] chart to visualize dependencies between tasks.
- A link:../../reports/radar[Radar Chart] to create a radial view of multiple categoric values.
image::advanced-visualizations.png[Advanced Visualizations]
13 changes: 13 additions & 0 deletions docs/modules/ROOT/pages/user-guide/extensions/forms.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
= Forms

The 'forms' extension lets you combine different parameter selectors to update / modify your graph data.
Update queries are predefined by the dashboard builder, and the user is limited to specifying the parameters for the query only.

See link:../../reports/form[Form] on how to create, configure, and use forms.

> Keep in mind that data-altering forms require your Neo4j user to have **write-access** to the graph. Make sure you give access to a select group of power-users only.




image::forms.png[Forms]
3 changes: 2 additions & 1 deletion docs/modules/ROOT/pages/user-guide/extensions/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ The currently available extensions in NeoDash are:
- link:advanced-visualizations[Advanced Visualizations]
- link:rule-based-styling[Rule-based Styling]
- link:report-actions[Report Actions]
- link:natural-language-queries[Natural Language Queries]
- link:natural-language-queries[Text2Cypher - Natural Language Queries]
- link:forms[Forms]
== Types of Extensions

Expand Down
Original file line number Diff line number Diff line change
@@ -1,25 +1,23 @@
= Natural Language Query Generation in NeoDash!
= Text2Cypher - Natural Language Queries
Use natural language to generate Cypher queries in NeoDash. Connect to an LLM through an API, and let NeoDash use your database schema + the report types to generate queries automatically.

== Natural Language Queries
Natural Language Queries feature allows users to interact with NeoDash using natural language to generate Cypher queries for querying Neo4j graph databases.
== How it works
This extension feature allows users to interact with NeoDash using natural language to generate Cypher queries for querying Neo4j graph databases.
This integration leverages Language Models (LLMs) to interpret user inputs and generate Cypher queries based on the provided schema definition.

== Configuration
To enable Natural Language Queries in NeoDash, follow these configuration steps:

1. Open NeoDash and navigate to the "Extensions" section in the left sidebar.
2. Locate the "Natural Language Queries" extension and click on it to activate it.
3. Once activated, a new button will appear in the sidebar(see image below). Click on the button to open the configuration window.
2. Locate the "Text2Cypher" extension and click on it to activate it.
3. Once activated, a new button will appear on top of the screen, with a red exclamation mark (⚠️). Click this button.
4. In the configuration window, you will be prompted to provide the necessary information to connect to the Language Model (LLM). Enter the model provider, API key, deployment url if needed by the model provider, and select the desired model to use.
5. After providing the required information, click on the "Start Querying" button to finalize the configuration.

image::extensionbutton.png[Extension Button enables Natural Language Queries button in the sidebar]

image::llmconfiguration.png[Configuration settings for the Natural Language Queries extension]

== Usage
Once the Natural Language Queries extension is configured, you can start using it in your NeoDash reports. Here's how:
Once the extension is configured, you can start using it in your NeoDash reports. Here's how:

1. Open the Report settings for the desired report.
2. In the report settings, you will find a toggle switch located above the editor. This switch allows you to toggle between Cypher and English languages.
Expand All @@ -33,7 +31,21 @@ This allows you to review and modify the generated Cypher query before execution

image::englisheditor.png[Example of the English editor in NeoDash]

=== Here is how it works behind the scenes:
== Improving Accuracy with Custom Prompting
To boost the accuracy of the language model, you can provide your own example queries to be fed into the prompt.
Specifying queries specific to your data model & use-cases can significantly improve the quality of Text2Cypher translations.

To access the model examples screen, open up the settings for the extensions.
After specifying the provider and model, click the "Tweak Prompts" button on the bottom-left of the window.
This leads you to the example interface:

image::llm-examples.png[Custom Examples for your prompt]

In this interface, you can specify one or more examples that are sent to the language model.
An example consists of both a Cypher query, and a natural language equivalent of that query.
You can create as many examples as you want, but keeping them close to your user queries will yield best results.

== Underlying Functionality
* Retrieve the Schema: The system prompts at the beginning of the interaction to retrieve the database schema. This ensures that the generated queries adhere to the provided schema and available relationship types and properties.

* Prompting in English: Once the schema is retrieved, you can start prompting your queries in plain English. NeoDash, powered by the LLM, will interpret your English query and generate the corresponding Cypher query based on the provided schema.
Expand Down
Loading

0 comments on commit 40254e0

Please sign in to comment.