[PUI] Dashboard refactor (#8278)

* Refactor plugin components into <RemoteComponent />

* Clean up footer

* Allow BuildOrder list to be sorted by 'outstanding'

* Fix model name

* Update BuildOrderTable filter

* Add StockItemTable column

* Working towards new dashboard

* Cleanup unused imports

* Updates: Now rendering some custom widgets

* Define icons for model types

* Add icon

* Cleanup / refactor / delete

- Complete transfer of files into new structure

* Follow link for query count widgets

* Add some more widgets to the library

* Remove old dashboard link in header

* Remove feedback widget

* Bump API version

* Remove test widget

* Rename "Home" -> "Dashboard"

* Add some more widgets

* Pass 'editable' property through to widgets

* Cleanup

* Add drawer for selecting new widgets

* Allow different layouts per user on the same machine

* Fixes

* Add ability to *remove* widgets

* Add helpful button

* Add a keyboard shortcut

* Refactoring

* Add backend code for serving custom dashboard items

* Load dashboard items from plugins

* Tweak for dashboard item API query

- Refetch if user changes
- Tweak "loaded" value
- Prevent refetchOnMount

* Add message if no dashboard widgets are displayed

* Refactoring main navigation menu

- Group into sections
- Cleanup / consolidation
- General refactoring

* Remove playground

* Add backend field for storing dashboard layout

* Add extra type definitions for UseInstance

* Manual labels for builtin dashboard items

- Otherwise they will change with translation locale

* Shorten labels for more plugins

* Adjust DashboardMenu

* Reduce stored data

* Add widget filter by text

* Remove back-end settings

* Update playwright tests for dashboard

* Updated tests

* Refactor backend API for fetching plugin features

* Further fixes for back-end code

* More back-end fixes

* Refactor frontend:

- Custom panels
- Custom dashboard items

* Further backend fixes

* Yet more backend fixes

- Improve error handling

* Fix for custom plugin settings rendering

* Enable plugin panels for part index and stock index pages

* Cleanup

* Fix nav menu

* Update typing

* Helper func to return all plugin settings as a dict

* Update API version date

* Fix for UseInstancea

* typing fix

* Tweak layout callbacks

* Pass query parameters through to navigation functions

* Improve custom query display

* Add "news" widget

* Ensure links are prepended with base URL on receipt

* Update NewsWidget

* Bug fix

* Refactor template editor tests

* Refactor unit testing for test_ui_panels

* Unit test for dashboard item API endpoint

* Update comment

* Adjust playwright tests

* More playwright fixes

* Hide barcode scanning options if disabled

* Tweak dashboard widget

* Fix custom panel title

* Update documentation around UIMixin class

* Cleanup

* Additional docs

* Add icon def for 'error' ModelType

* Add error boundary to TemplateEditor component

* Fix so that it works with template editors and previews again

* Tweak error messages

* API unit test fixes

* Unit test fix

* More unit test fixes

* Playwright test tweaks

* Adjust error messages

src/frontend/tests/pages/pui_dashboard.spec.ts

@@ -0,0 +1,64 @@
+import { test } from '../baseFixtures.js';
+import { doQuickLogin } from '../login.js';
+import { setPluginState } from '../settings.js';
+
+test('Pages - Dashboard - Basic', async ({ page }) => {
+  await doQuickLogin(page);
+
+  await page.getByText('Use the menu to add widgets').waitFor();
+
+  // Let's add some widgets
+  await page.getByLabel('dashboard-menu').click();
+  await page.getByRole('menuitem', { name: 'Add Widget' }).click();
+  await page.getByLabel('dashboard-widgets-filter-input').fill('overdue order');
+
+  await page.getByLabel('add-widget-ovr-so').click();
+  await page.getByLabel('add-widget-ovr-po').click();
+
+  await page.getByLabel('dashboard-widgets-filter-clear').click();
+
+  // Close the widget
+  await page.getByRole('banner').getByRole('button').click();
+
+  await page.waitForTimeout(500);
+
+  // Check that the widgets are visible
+  await page.getByText('Overdue Sales Orders').waitFor();
+  await page.getByText('Overdue Purchase Orders').waitFor();
+
+  // Let's remove one of the widgets
+  await page.getByLabel('dashboard-menu').click();
+  await page.getByRole('menuitem', { name: 'Remove Widgets' }).click();
+  await page.getByLabel('remove-dashboard-item-ovr-so').click();
+
+  // Accept the layout
+  await page.getByLabel('dashboard-accept-layout').click();
+});
+
+test('Pages - Dashboard - Plugins', async ({ page, request }) => {
+  // Ensure that the "SampleUI" plugin is enabled
+  await setPluginState({
+    request,
+    plugin: 'sampleui',
+    state: true
+  });
+
+  await doQuickLogin(page);
+
+  // Add a dashboard widget from the SampleUI plugin
+  await page.getByLabel('dashboard-menu').click();
+  await page.getByRole('menuitem', { name: 'Add Widget' }).click();
+  await page.getByLabel('dashboard-widgets-filter-input').fill('sample');
+
+  // Add the widget
+  await page.getByLabel(/add-widget-p-sampleui-sample-/).click();
+
+  // Close the widget
+  await page.getByRole('banner').getByRole('button').click();
+
+  await page.waitForTimeout(500);
+
+  // Check that the widget is visible
+  await page.getByRole('heading', { name: 'Sample Dashboard Item' }).waitFor();
+  await page.getByText('Hello world! This is a sample').waitFor();
+});