From 4c78d1da66536e2999858293bec5e75f4e9e7803 Mon Sep 17 00:00:00 2001
From: Samuel Lorch <sam@soontm.de>
Date: Mon, 3 Apr 2023 22:59:20 +0200
Subject: [PATCH] Nice form (#11)

* wip

* vee-validate experiments

* get test enabled form working

* Make PillBar Properly work with ModelValue

* Register NumberBox Globally

* Rework NiceForm

* Use new form props

* Rework Definitions for new Form
---
 client/src/components/NiceForm.vue            | 56 ++++++++++-----
 client/src/components/inputs/PillBar.vue      | 18 ++---
 client/src/definitions.ts                     | 71 ++++++++++---------
 client/src/main.ts                            | 18 +++++
 .../pages/edit/[subsystem]/[entity]/[id].vue  |  4 +-
 .../pages/edit/[subsystem]/[entity]/index.vue |  4 +-
 client/src/pages/index.vue                    | 56 ++++++++++++---
 7 files changed, 153 insertions(+), 74 deletions(-)

diff --git a/client/src/components/NiceForm.vue b/client/src/components/NiceForm.vue
index f2aa438..f91aeb9 100644
--- a/client/src/components/NiceForm.vue
+++ b/client/src/components/NiceForm.vue
@@ -2,38 +2,60 @@
 
 const props = defineModel<{
   title: string
-  fields: {
-    key: string,
-    label: string,
-    component: () => Component,
-    props: any,
-  }[]
+  sections: {
+    title: string
+    fields: {
+      key: string,
+      label: string,
+      as: string,
+      props: any,
+      default: any,
+      enabled?: (values: Record<string, any>) => Boolean,
+      rules?: (value: any) => true | string,
+    }[],
+  }[],
+  modelValue: any,
 }>();
-let { title, fields } = $(props);
+
+let { sections } = $(props);
 
 </script>
 
 <template>
-  <div class="form">
-    <h2>{{ title }}</h2>
-    <template v-for="(field, index) in fields" :key="index">
-      <label :for="field.key" v-text="field.label"/>
-      <component :name="field.key" :is="field.component()" v-bind="field.props"/>
+  <ValidationForm as="div" v-slot="{ values }" @submit="false">
+    <template v-for="(section, index) in sections" :key="index">
+      <h4 v-if="section.title">{{ section.title }}</h4>
+      <div class="section">
+        <template v-for="(field, index) in section.fields" :key="index">
+          <template v-if="field.enabled ? field.enabled(values) : true">
+            <label :for="field.key" v-text="field.label" />
+            <Field :name="field.key" :as="field.as" :rules="field.rules" v-bind="field.props" />
+            <ErrorMessage :name="field.key" />
+          </template>
+        </template>
+      </div>
     </template>
-  </div>
+    <p>{{ values }}</p>
+  </ValidationForm>
 </template>
 
 <style scoped>
-.form {
+.section {
   display: grid;
   grid-template-columns: auto 1fr;
   padding: 0.5rem;
   gap: 0.5rem;
 }
-.form > :is(button, .button, h2) {
+
+h4,
+p {
   grid-column: 1 / 3;
 }
-.form > :is(label) {
-  grid-column: 1;
+
+h4 {
+  background-color: var(--cl-bg-hl);
+  padding: 0.3rem;
+  padding-left: 0.5rem;
+  ;
 }
 </style>
\ No newline at end of file
diff --git a/client/src/components/inputs/PillBar.vue b/client/src/components/inputs/PillBar.vue
index 9c3e214..6831494 100644
--- a/client/src/components/inputs/PillBar.vue
+++ b/client/src/components/inputs/PillBar.vue
@@ -10,25 +10,17 @@ const props = defineModel<{
 }>();
 let { options, modelValue } = $(props);
 
-const emit = defineEmits<{
-  (event: 'selectionChanged'): void
-}>();
-
-function select(option: any, index: number) {
-  for(let opt of options) {
-    opt.selected = false;
+onMounted(async() => {
+  if (modelValue === undefined) {
+    modelValue = 0
   }
-  option.selected = true;
-  modelValue = index;
-  emit('selectionChanged');
-  console.debug("selected", options);
-}
+});
 
 </script>
 
 <template>
   <div>
-    <button class="option" v-for="(option, index) in options" :key="index" :class="{selected:option.selected}" @click="select(option, index)">
+    <button class="option" v-for="(option, index) in options" :key="index" :class="{selected: modelValue == index}" @click="modelValue = index">
       <i class="material-icons" v-if="option.icon">{{ option.icon }}</i>
       {{ option.name }}
     </button>
diff --git a/client/src/definitions.ts b/client/src/definitions.ts
index 290e02b..4ffa32b 100644
--- a/client/src/definitions.ts
+++ b/client/src/definitions.ts
@@ -1,35 +1,42 @@
-import PillBar from "./components/inputs/PillBar.vue";
-import TextBox from "./components/inputs/TextBox.vue";
-import NumberBox from "./components/inputs/NumberBox.vue";
-import MultilineTextBox from "./components/inputs/MultilineTextBox.vue";
-import CheckBox from "./components/inputs/CheckBox.vue";
-
-export const editTypes: { [key: string]: {[key: string]: any} } = {
-    "firewall": {
-      "forwardrules": {
-        title: "Forward Rule",
-        fields: [
-          {key: "name", label: "Name", component: () => TextBox },
-          {key: "verdict", label: "Verdict", component: () => PillBar, props: {options: [{name: 'Accept'}, {name: 'Drop'}, {name: 'Continue'}]}},
-          {key: "counter", label: "Counter", component: () => CheckBox },
-          {key: "comment", label: "Comment", component: () => MultilineTextBox },
+export const editTypes: { [key: string]: { [key: string]: any } } = {
+  "firewall": {
+    "forwardrules": {
+      title: "Forward Rule",
+      sections: [
+        { 
+          fields: [
+          { key: "name", label: "Name", as: "TextBox" },
+          { key: "verdict", label: "Verdict", as: "PillBar", props: { options: [{ name: 'Accept' }, { name: 'Drop' }, { name: 'Continue' }] } },
+          { key: "counter", label: "Counter", as: "CheckBox", },
+          { key: "comment", label: "Comment", as: "MultilineTextBox", },
         ],
-      }
+      },
+      ],
     },
-    "network": {
-      "interfaces": {
-        title: "Interfaces",
-        fields: [
-          {key: "name", label: "Name", component: () => TextBox },
-          {key: "type", label: "Type", component: () => PillBar, props: {options: [{name: 'Hardware', selected: true}, {name: 'VLAN'}, {name: 'Bond'}, {name: 'Brdige'}]}},
-          {key: "hardware_interface", label: "Hardware Interface", component: () => TextBox },
-          {key: "vlan_id", label: "VLAN ID", component: () => NumberBox, props: {min: 1, max: 4094} },
-          {key: "bond_members", label: "Nond Members", component: () => TextBox },
-          {key: "bridge_members", label: "Bridge Memebers", component: () => TextBox },
-          {key: "addressing_mode", label: "Addressing Mode", component: () => PillBar, props: {options: [{name: 'None', selected: true}, {name: 'Static'}, {name: 'DHCP'}]}},
-          {key: "address", label: "Address", component: () => TextBox },
-          {key: "comment", label: "Comment", component: () => MultilineTextBox },
-        ],
-      }
+  },
+  "network": {
+    "interfaces": {
+      title: "Interfaces",
+      sections: [
+        {
+          fields: [
+            { key: "name", label: "Name", as: "TextBox", default: "placeholder" },
+            { key: "type", label: "Type", as: "PillBar", props: { options: [{ name: 'Hardware' }, { name: 'VLAN' }, { name: 'Bond' }, { name: 'Bridge' }] } },
+            { key: "hardware_interface", label: "Hardware Interface", as: "TextBox", enabled: (values: any) => (values["type"] == 0) },
+            { key: "vlan_id", label: "VLAN ID", as: "NumberBox", props: { min: 1, max: 4094 }, enabled: (values: any) => (values["type"] == 1) },
+            { key: "bond_members", label: "Bond Members", as: "TextBox", enabled: (values: any) => (values["type"] == 2) },
+            { key: "bridge_members", label: "Bridge Members", as: "TextBox", enabled: (values: any) => (values["type"] == 3) },
+          ],
+        },
+        {
+          title: "Addressing",
+          fields: [
+            { key: "addressing_mode", label: "Addressing Mode", as: "PillBar", props: { options: [{ name: 'None', selected: true }, { name: 'Static' }, { name: 'DHCP' }] } },
+            { key: "address", label: "Address", as: "TextBox", enabled: (values: any) => (values["addressing_mode"] == 1) },
+            { key: "comment", label: "Comment", as: "MultilineTextBox" },
+          ],
+        }
+      ],
     },
-  };
\ No newline at end of file
+  },
+};
\ No newline at end of file
diff --git a/client/src/main.ts b/client/src/main.ts
index 362bd1f..8a618da 100644
--- a/client/src/main.ts
+++ b/client/src/main.ts
@@ -5,6 +5,14 @@ import './global-styles/mlfe.css';
 import './global-styles/transitions.css';
 import 'vue-toast-notification/dist/theme-default.css';
 
+import PillBar from "./components/inputs/PillBar.vue";
+import TextBox from "./components/inputs/TextBox.vue";
+import NumberBox from "./components/inputs/NumberBox.vue";
+import MultilineTextBox from "./components/inputs/MultilineTextBox.vue";
+import CheckBox from "./components/inputs/CheckBox.vue";
+
+import { Form, Field, ErrorMessage  } from 'vee-validate';
+
 import App from './App.vue';
 import { createHead } from '@vueuse/head';
 import { createRouter, createWebHistory } from 'vue-router';
@@ -22,4 +30,14 @@ app.use(router);
 app.use(head);
 app.use(ToastPlugin);
 
+// Global Components
+app.component('PillBar', PillBar)
+app.component('TextBox', TextBox)
+app.component('NumberBox', NumberBox)
+app.component('MultilineTextBox', MultilineTextBox)
+app.component('CheckBox', CheckBox)
+app.component('ValidationForm', Form)
+app.component('Field', Field)
+app.component('ErrorMessage', ErrorMessage)
+
 app.mount('#app');
diff --git a/client/src/pages/edit/[subsystem]/[entity]/[id].vue b/client/src/pages/edit/[subsystem]/[entity]/[id].vue
index 01b8f28..3df437e 100644
--- a/client/src/pages/edit/[subsystem]/[entity]/[id].vue
+++ b/client/src/pages/edit/[subsystem]/[entity]/[id].vue
@@ -5,6 +5,8 @@ import { editTypes } from "../../../../definitions";
 const props = $defineProps<{subsystem: string, entity: string, id: string}>();
 const { subsystem, entity, id } = $(props);
 
+let data = $ref({} as {});
+
 async function update() {
   
 }
@@ -16,7 +18,7 @@ async function update() {
       <button @click="update">Update</button>
       <button @click="$router.go(-1)">Discard</button>
     </PageHeader>
-    <NiceForm class="scroll cl-secondary" :title="editTypes[subsystem][entity].title" :fields="editTypes[subsystem][entity].fields"/>
+    <NiceForm class="scroll cl-secondary" :title="editTypes[subsystem][entity].title" :sections="editTypes[subsystem][entity].sections" v-model="data"/>
   </div>
   <div v-else>
     <PageHeader title="Error"/>
diff --git a/client/src/pages/edit/[subsystem]/[entity]/index.vue b/client/src/pages/edit/[subsystem]/[entity]/index.vue
index 4d4bba8..9baeacb 100644
--- a/client/src/pages/edit/[subsystem]/[entity]/index.vue
+++ b/client/src/pages/edit/[subsystem]/[entity]/index.vue
@@ -4,6 +4,8 @@ import { editTypes } from "../../../../definitions";
 const props = $defineProps<{subsystem: string, entity: string}>();
 const { subsystem, entity } = $(props);
 
+let data = $ref({});
+
 async function create() {
   
 }
@@ -15,7 +17,7 @@ async function create() {
       <button @click="create">Create</button>
       <button @click="$router.go(-1)">Discard</button>
     </PageHeader>
-    <NiceForm class="scroll cl-secondary" :title="editTypes[subsystem][entity].title" :fields="editTypes[subsystem][entity].fields"/>
+    <NiceForm class="scroll cl-secondary" :title="editTypes[subsystem][entity].title" :sections="editTypes[subsystem][entity].sections" v-model="data"/>
   </div>
   <div v-else>
     <PageHeader title="Error"/>
diff --git a/client/src/pages/index.vue b/client/src/pages/index.vue
index 181372f..5c483b6 100644
--- a/client/src/pages/index.vue
+++ b/client/src/pages/index.vue
@@ -1,21 +1,37 @@
 <script setup lang="ts">
 import { apiCall } from "../api";
-import PillBar from "../components/inputs/PillBar.vue";
-import TextBox from "../components/inputs/TextBox.vue";
-import MultilineTextBox from "../components/inputs/MultilineTextBox.vue";
-import CheckBox from "../components/inputs/CheckBox.vue";
+import { Form as ValidationForm, Field, ErrorMessage  } from 'vee-validate';
 
 async function doShit(){
   apiCall("Firewall.GetForwardRules", {});
 }
 
 let fields = $ref([
-  {key: "name", label: "Name", component: () => TextBox },
-  {key: "verdict", label: "Verdict", component: () => PillBar, props: {options: [{name: 'Accept'}, {name: 'Drop'}, {name: 'Continue'}]}},
-  {key: "counter", label: "Counter", component: () => CheckBox },
-  {key: "comment", label: "Comment", component: () => MultilineTextBox },
+  {key: "name", label: "Name", as: "TextBox", rules: validateEmail},
+  {key: "verdict", label: "Verdict", as: "PillBar", props: {options: [{name: 'Accept'}, {name: 'Drop'}, {name: 'Continue'}]}},
+  {key: "counter", label: "Counter", as: "CheckBox" },
+  {key: "comment", label: "Comment", as: "MultilineTextBox", enabled: (values: Record<string, any>) => (values["verdict"] == 2) as Boolean },
 ]);
 
+
+function validateEmail(value: any) {
+  // if the field is empty
+  if (!value) {
+    return 'This field is required';
+  }
+
+  // if the field is not a valid email
+  const regex = /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$/i;
+  if (!regex.test(value)) {
+    return 'This field must be a valid email';
+  }
+
+  // All is good
+  return true;
+}
+
+
+
 </script>
 
 <template>
@@ -23,10 +39,30 @@ let fields = $ref([
     <PageHeader title="Dashboard">
       <button @click="doShit">Example Buttons</button>
     </PageHeader>
-    <NiceForm class="scroll cl-secondary" title="Testasdfdsfsdf" :fields="fields"/>
+    <ValidationForm class="form" v-slot="{ values }">
+      <template v-for="(field, index) in fields" :key="index">
+        <template v-if="field.enabled ? field.enabled(values) : true">
+          <label :for="field.key" v-text="field.label"/>
+          <Field :name="field.key" :as="field.as" :rules="field.rules" v-bind="field.props"/>
+          <ErrorMessage :name="field.key" />
+        </template>
+      </template>
+      {{ values }}
+    </ValidationForm>
   </div>
 </template>
 
 <style scoped>
-
+ValidationForm {
+  display: grid;
+  grid-template-columns: auto 1fr;
+  padding: 0.5rem;
+  gap: 0.5rem;
+}
+ValidationForm > :is(button, .button, h2) {
+  grid-column: 1 / 3;
+}
+ValidationForm > :is(label) {
+  grid-column: 1;
+}
 </style>
\ No newline at end of file