Support new React Interface

.github/workflows/frontend.yaml

@@ -0,0 +1,24 @@
+# Run CI checks for frontend code
+name: Frontend CI
+
+on: ["push", "pull_request"]
+
+jobs:
+  frontend:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+      - name: Install Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: "18"
+      - name: Install Deps
+        run: |
+          cd src/frontend
+          npm install
+      - name: Build Frontend
+        run: |
+          cd src/frontend
+          npm run build

.gitignore

@@ -102,3 +102,4 @@ celerybeat.pid
 # SageMath parsed files
 *.sage.py
 
+src/frontend/tsconfig.app.tsbuildinfo

inventree_wireviz/version.py

@@ -1,3 +1,3 @@
 """Version information for the inventree-wireviz plugin"""
 
-PLUGIN_VERSION = "0.6.2"
+PLUGIN_VERSION = "0.7.0"

inventree_wireviz/wireviz.py

@@ -14,7 +14,7 @@
 from django.urls import path
 
 from plugin import InvenTreePlugin
-from plugin.mixins import PanelMixin, ReportMixin, SettingsMixin, UrlsMixin
+from plugin.mixins import PanelMixin, ReportMixin, SettingsMixin, UrlsMixin, UserInterfaceMixin
 
 from build.views import BuildDetail
 from part.models import Part, PartCategory
@@ -26,7 +26,7 @@
 logger = logging.getLogger('inventree')
 
 
-class WirevizPlugin(PanelMixin, ReportMixin, SettingsMixin, UrlsMixin, InvenTreePlugin):
+class WirevizPlugin(PanelMixin, ReportMixin, SettingsMixin, UrlsMixin, UserInterfaceMixin, InvenTreePlugin):
     """"Wireviz plugin for InvenTree
 
     - Provides a custom panel for rendering wireviz diagrams
@@ -131,8 +131,14 @@ def get_panel_context(self, view, request, context):
         except AttributeError:
             return context
 
+        return self.panel_context_from_instance(instance)
+
+    def panel_context_from_instance(self, instance):
+
         part = self.get_part_from_instance(instance)
 
+        context = {}
+
         if part and isinstance(part, Part):
 
             context['part'] = part
@@ -210,6 +216,33 @@ def get_custom_panels(self, view, request):
 
         return panels
 
+    def get_ui_panels(self, instance_type, instance_id, request, **kwargs):
+        """Return custom UI panels for the wireviz plugin."""
+
+        panels = []
+        part = None
+
+        if instance_type == 'part':
+            try:
+                part = Part.objects.get(pk=instance_id)
+            except Part.DoesNotExist:
+                part = None
+
+        if part and part.get_metadata('wireviz'):
+
+            ctx = self.panel_context_from_instance(part)
+
+            ctx['part'] = part.pk
+
+            panels.append({
+                'name': 'wireviz',
+                'label': 'Harness Diagram',
+                'context': ctx,
+                'source': f'/static/plugin/{self.SLUG}/WirevizPanel.js',
+            })
+
+        return panels
+
     def get_template_files(self):
         """Return a list of existing WireViz template files which have been uploaded."""
 

src/frontend/.gitignore

@@ -0,0 +1,25 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+*.tsbuildinfo

src/frontend/README.md

@@ -0,0 +1,29 @@
+# Wireviz Plugin - Frontend Code
+
+This directory contains the frontend code for the Wireviz plugin.
+
+## Development
+
+This project uses [Vite](https://vitejs.dev/) as the build tool. We followed [this guide](https://vitejs.dev/guide/#scaffolding-your-first-vite-project) to scaffold the project.
+
+## Building
+
+To compile the frontend code, run:
+
+```bash
+npm run build
+```
+
+This will compile the frontend code into the `dist/static` directory.
+
+## Testing
+
+To test the frontend code, run:
+
+```bash
+npm run dev
+```
+
+This will start a development server (usually on `localhost:5173`) which will automatically reload when changes are made to the source code.
+
+The development server provides some "dummy" harness data to test the frontend code.

src/frontend/eslint.config.js

@@ -0,0 +1,28 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import reactHooks from 'eslint-plugin-react-hooks'
+import reactRefresh from 'eslint-plugin-react-refresh'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+  { ignores: ['dist'] },
+  {
+    extends: [js.configs.recommended, ...tseslint.configs.recommended],
+    files: ['**/*.{ts,tsx}'],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+    },
+    plugins: {
+      'react-hooks': reactHooks,
+      'react-refresh': reactRefresh,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      'react-refresh/only-export-components': [
+        'warn',
+        { allowConstantExport: true },
+      ],
+    },
+  },
+)

src/frontend/index.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>InvenTree Wireviz - Developer View</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>