From 0dad02fbdb65e575b3d0372d331b2b91256a839f Mon Sep 17 00:00:00 2001
From: Laila Los <44241786+ElectronicBlueberry@users.noreply.github.com>
Date: Mon, 12 Dec 2022 17:03:14 +0100
Subject: [PATCH] convert FormElement to ts

---
 client/src/components/Form/FormElement.vue    | 175 +++++++-----------
 .../src/components/Form/parameterTypes.d.ts   |  30 +++
 2 files changed, 100 insertions(+), 105 deletions(-)
 create mode 100644 client/src/components/Form/parameterTypes.d.ts

diff --git a/client/src/components/Form/FormElement.vue b/client/src/components/Form/FormElement.vue
index 85a1a78ddd2..8a686211162 100644
--- a/client/src/components/Form/FormElement.vue
+++ b/client/src/components/Form/FormElement.vue
@@ -1,95 +1,66 @@
-<script setup>
-import FormBoolean from "./Elements/FormBoolean";
-import FormHidden from "./Elements/FormHidden";
-import FormInput from "./Elements/FormInput";
-import FormParameter from "./Elements/FormParameter";
-import FormSelection from "./Elements/FormSelection";
-import FormColor from "./Elements/FormColor";
-import FormDirectory from "./Elements/FormDirectory";
-import FormNumber from "./Elements/FormNumber";
-import FormRulesEdit from "./Elements/FormRulesEdit";
+<script setup lang="ts">
+import FormBoolean from "./Elements/FormBoolean.vue";
+import FormHidden from "./Elements/FormHidden.vue";
+import FormInput from "./Elements/FormInput.vue";
+import FormParameter from "./Elements/FormParameter.vue";
+import FormSelection from "./Elements/FormSelection.vue";
+import FormColor from "./Elements/FormColor.vue";
+import FormDirectory from "./Elements/FormDirectory.vue";
+import FormNumber from "./Elements/FormNumber.vue";
+import FormRulesEdit from "./Elements/FormRulesEdit.vue";
 import { FontAwesomeIcon } from "@fortawesome/vue-fontawesome";
 import { ref, computed, useAttrs } from "vue";
+import { library } from "@fortawesome/fontawesome-svg-core";
+import { faExclamation, faTimes, faArrowsAltH } from "@fortawesome/free-solid-svg-icons";
+import { faCaretSquareDown, faCaretSquareUp } from "@fortawesome/free-regular-svg-icons";
 
-const props = defineProps({
-    id: {
-        type: String,
-        default: "identifier",
-    },
-    type: {
-        type: String,
-        default: null,
-    },
-    value: {
-        default: null,
-    },
-    title: {
-        type: String,
-        default: null,
-    },
-    refreshOnChange: {
-        type: Boolean,
-        default: false,
-    },
-    help: {
-        type: String,
-        default: null,
-    },
-    error: {
-        type: String,
-        default: null,
-    },
-    backbonejs: {
-        type: Boolean,
-        default: false,
-    },
-    disabled: {
-        type: Boolean,
-        default: false,
-    },
-    attributes: {
-        type: Object,
-        default: null,
-    },
-    collapsedEnableText: {
-        type: String,
-        default: "Enable",
-    },
-    collapsedDisableText: {
-        type: String,
-        default: "Disable",
-    },
-    collapsedEnableIcon: {
-        type: String,
-        default: "far fa-caret-square-down",
-    },
-    collapsedDisableIcon: {
-        type: String,
-        default: "far fa-caret-square-up",
-    },
-    connectedEnableText: {
-        type: String,
-        default: "Remove connection from module.",
-    },
-    connectedDisableText: {
-        type: String,
-        default: "Add connection to module.",
-    },
-    connectedEnableIcon: {
-        type: String,
-        default: "fa fa-times",
-    },
-    connectedDisableIcon: {
-        type: String,
-        default: "fa fa-arrows-alt-h",
-    },
-    workflowBuildingMode: {
-        type: Boolean,
-        default: false,
-    },
+import type { ComputedRef } from "vue";
+import type { FormParameterTypes, FormParameterAttributes, FormParameterValue } from "./parameterTypes";
+
+export interface FormElementProps {
+    id?: string;
+    type?: FormParameterTypes;
+    value?: FormParameterValue;
+    title?: string;
+    refreshOnChange?: boolean;
+    help?: string;
+    error?: string;
+    backbonejs?: boolean;
+    attributes?: FormParameterAttributes;
+    collapsedEnableText?: string;
+    collapsedDisableText?: string;
+    collapsedEnableIcon?: string;
+    collapsedDisableIcon?: string;
+    connectedEnableText?: string;
+    connectedDisableText?: string;
+    connectedEnableIcon?: string;
+    connectedDisableIcon?: string;
+    workflowBuildingMode?: boolean;
+}
+
+const props = withDefaults(defineProps<FormElementProps>(), {
+    id: "identifier",
+    refreshOnChange: false,
+    backbonejs: false,
+    disabled: false,
+    collapsedEnableText: "Enable",
+    collapsedDisableText: "Disable",
+    collapsedEnableIcon: "far fa-caret-square-down",
+    collapsedDisableIcon: "far fa-caret-square-up",
+    connectedEnableText: "Remove connection from module.",
+    connectedDisableText: "Add connection to module.",
+    connectedEnableIcon: "fa fa-times",
+    connectedDisableIcon: "fa fa-arrows-alt-h",
+    workflowBuildingMode: false,
 });
 
-const emit = defineEmits(["input", "change"]);
+const emit = defineEmits<{
+    (e: "input", value: FormParameterValue, id: string): void;
+    (e: "change", shouldRefresh: boolean): void;
+}>();
+
+//@ts-ignore bad library types
+library.add(faExclamation, faTimes, faArrowsAltH, faCaretSquareDown, faCaretSquareUp);
 
 /** TODO: remove attrs computed.
  useAttrs is *not* reactive, and does not play nice with type safety.
@@ -97,15 +68,15 @@ const emit = defineEmits(["input", "change"]);
  but should be removed as soon as that component is removed.
  */
 const attrs = computed(() => props.attributes || useAttrs());
-const collapsibleValue = computed(() => attrs.value["collapsible_value"]);
-const defaultValue = computed(() => attrs.value["default_value"]);
-const connectedValue = { __class__: "ConnectedValue" };
+const collapsibleValue: ComputedRef<FormParameterValue> = computed(() => attrs.value["collapsible_value"]);
+const defaultValue: ComputedRef<FormParameterValue> = computed(() => attrs.value["default_value"]);
+const connectedValue: FormParameterValue = { __class__: "ConnectedValue" };
 
 const connected = ref(false);
 const collapsed = ref(false);
 
 const collapsible = computed(() => !props.disabled && collapsibleValue.value !== undefined);
-const connectable = computed(() => collapsible.value && attrs.value["connectable"]);
+const connectable = computed(() => collapsible.value && Boolean(attrs.value["connectable"]));
 
 // Determines to wether expand or collapse the input
 {
@@ -118,7 +89,7 @@ const connectable = computed(() => collapsible.value && attrs.value["connectable
 }
 
 /** Submits a changed value. */
-function setValue(value) {
+function setValue(value: FormParameterValue) {
     emit("input", value, props.id);
     emit("change", props.refreshOnChange);
 }
@@ -154,7 +125,7 @@ const showField = computed(() => !collapsed.value && !props.disabled);
 const previewText = computed(() => attrs.value["text_value"]);
 const helpText = computed(() => {
     const helpArgument = attrs.value["argument"];
-    if (helpArgument && !props.help.includes(`(${helpArgument})`)) {
+    if (helpArgument && !props.help?.includes(`(${helpArgument})`)) {
         return `${props.help} (${helpArgument})`;
     } else {
         return props.help;
@@ -171,7 +142,9 @@ const currentValue = computed({
 });
 
 const isHiddenType = computed(
-    () => ["hidden", "hidden_data", "baseurl"].includes(props.type) || (props.attributes && props.attributes.titleonly)
+    () =>
+        ["hidden", "hidden_data", "baseurl"].includes(props.type ?? "") ||
+        (props.attributes && props.attributes.titleonly)
 );
 
 const collapseText = computed(() => (collapsed.value ? props.collapsedEnableText : props.collapsedDisableText));
@@ -182,7 +155,7 @@ const isEmpty = computed(() => {
         return true;
     }
 
-    if (["text", "integer", "float", "password"].includes(props.type) && currentValue.value === "") {
+    if (["text", "integer", "float", "password"].includes(props.type ?? "") && currentValue.value === "") {
         return true;
     }
 
@@ -194,14 +167,6 @@ const isRequiredType = computed(() => props.type !== "boolean");
 const isOptional = computed(() => !isRequired.value && attrs.value["optional"] !== undefined);
 </script>
 
-<script>
-import { library } from "@fortawesome/fontawesome-svg-core";
-import { faExclamation, faTimes, faArrowsAltH } from "@fortawesome/free-solid-svg-icons";
-import { faCaretSquareDown, faCaretSquareUp } from "@fortawesome/free-regular-svg-icons";
-
-library.add(faExclamation, faTimes, faArrowsAltH, faCaretSquareDown, faCaretSquareUp);
-</script>
-
 <template>
     <div
         v-show="!isHidden"
@@ -258,7 +223,7 @@ library.add(faExclamation, faTimes, faArrowsAltH, faCaretSquareDown, faCaretSqua
                 v-model="currentValue"
                 :max="attrs.max"
                 :min="attrs.min"
-                :type="type"
+                :type="props.type ?? 'float'"
                 :workflow-building-mode="workflowBuildingMode" />
             <FormSelection
                 v-else-if="props.type == 'select' && attrs.display == 'radio'"
@@ -277,7 +242,7 @@ library.add(faExclamation, faTimes, faArrowsAltH, faCaretSquareDown, faCaretSqua
                 :id="props.id"
                 v-model="currentValue"
                 :data-label="props.title"
-                :type="props.type"
+                :type="props.type ?? 'text'"
                 :attributes="attrs" />
             <FormInput v-else :id="props.id" v-model="currentValue" :area="attrs['area']" />
         </div>
diff --git a/client/src/components/Form/parameterTypes.d.ts b/client/src/components/Form/parameterTypes.d.ts
new file mode 100644
index 00000000000..e3c7ca53574
--- /dev/null
+++ b/client/src/components/Form/parameterTypes.d.ts
@@ -0,0 +1,30 @@
+// TODO: stricter types
+export type FormParameterValue = any;
+export type FormParameterAttributes = {
+    [attribute: string]: any;
+};
+
+export type FormParameterTypes =
+    | "boolean"
+    | "hidden"
+    | "hidden_data"
+    | "baseurl"
+    | "integer"
+    | "float"
+    | "radio"
+    | "color"
+    | "directory_uri"
+    | "text"
+    | "password"
+    | "select"
+    | "data_column"
+    | "genomebuild"
+    | "data"
+    | "data_collection"
+    | "drill_down"
+    | "group_tag"
+    | "library_data"
+    | "ftpfile"
+    | "upload"
+    | "rules"
+    | "data_dialog";