finished_milestone (#279)

Co-authored-by: Adam Bem <adam.bem@zoho.eu>
Reviewed-on: #279
Co-authored-by: widlam <mikolaj.widla@gmail.com>
Co-committed-by: widlam <mikolaj.widla@gmail.com>

Frontend/README.md

@@ -1,4 +1,4 @@
-# Modern frontend for Release 11 Tools
+# new-frontend
 
 This template should help get you started developing with Vue 3 in Vite.
 
@@ -44,46 +44,3 @@ npm run build
 ```sh
 npm run lint
 ```
-
-## Structure of Vuejs 3 components and views in this project
-
-For this document's needs components and views will be named "modules" even though this is not a correct term for these files officially.
-
-### Main structure
-
-- \<script\>
-- \<template\>
-- \<style\> - if really needed
-
-### Scripts
-
-#### Elements should be placed in this order:
- - Imports
- - Props - constant defined by defineProps function, named "props" in code
-This name allows to have readable code sending data to parent module: 
-```TS
-    props.exampleProp
-```
- - Emits - constant defined by defineEmits function, named "emit" in code. This name allows to have readable code sending data to parent module: 
-```TS
-    emit("update:modelValue", exampleVariable)
-```
- - Interfaces
- - Refs - constants defined by ref functions with appropriate values
- - Injects - variables assigned by "inject" function
- - Other variables/constants
- - onFunctions - functions like onBeforeUpdate
- - Other functions
-
-#### Rules regarding functions:
- - Functions ought to have descriptive name
- - Ought to do one thing. ie. function sendRequest should send request, but not prepare request body or process response data
- - In practice, if function has more than 10 SLoC, it probably should be split
- - DO NOT use "any" type. Just don't. *Optional
- - Function used in other function should be placed below it (if possible, as function can be called from many places in the code)
-
-#### Rules regarding variables and refs:
- - Variables ought to have descriptive name
-
-In cases not covered in this convention, TypeScript, VueJS 3 conventions and good programming practices are applied
-

Frontend/src/components/CodeEditorComponent.vue

@@ -0,0 +1,69 @@
+<script setup lang="ts">
+import { computed, ref } from 'vue'
+import { Codemirror } from 'vue-codemirror'
+import { oneDark } from '@codemirror/theme-one-dark'
+import {xml} from '@codemirror/lang-xml'
+import {json} from '@codemirror/lang-json'
+import {html} from '@codemirror/lang-html'
+
+
+
+  const props= defineProps({
+    code : {
+        type: String,
+        required: true
+    },
+    config: {
+        type: Object,
+        required: true
+      },
+  })
+
+  const emit = defineEmits(
+    [
+      'update:updatedCode'
+    ]
+  )
+
+  function dataUpdated(newData:String, viewUpdate : any){
+    emit('update:updatedCode',newData)
+  }
+
+  const extensions = computed( ()=> {
+    return  [
+        oneDark,
+        parseLanguage(props.config.language),
+    ]
+
+  } )
+
+  function parseLanguage(name: String){
+    switch(name.toUpperCase()){
+      case "JSON": {
+        return json();
+      }
+      case "HTML": {
+        return html();
+      }
+      default: {
+        return xml();
+      }
+    }
+  }
+
+
+</script>
+
+<template>
+  <div class="editor w-full max-w-full h-full overflow-scroll">
+    
+    <codemirror
+      style="height: 100%; width: 100%; padding:1rem ; border-radius: 1rem; font-size: large;"
+      :model-value="code"
+      @update:model-value="dataUpdated"
+      :extensions="extensions"
+      :disabled="config.disabled"
+      />
+    
+  </div>
+</template>

Frontend/src/components/common/CodeEditorComponent.vue

@@ -7,6 +7,12 @@ import {xml} from '@codemirror/lang-xml'
 import {json} from '@codemirror/lang-json'
 import {html} from '@codemirror/lang-html'
 
+function isDarkModeSet(){
+  return localStorage.theme == "dark";
+}
+
+const theme : string = inject('theme')! ;
+
 const props= defineProps({
   code : {
       type: String,
@@ -24,25 +30,21 @@ const emit = defineEmits(
   ]
 )
 
-const theme : string = inject('theme')!;
-let extensions = parseExtensions();
-
-onBeforeUpdate( () => { extensions = parseExtensions(); } )
-
 function dataUpdated(newData:String){
   emit('update:updatedCode',newData)
 }
 
 function selectTheme() {
-  if (isDarkModeSet())
+  if (isDarkModeSet()) {
     return oneDark;
-  else
+  }
+  else {
     return espresso;
+  }
 }
 
-function isDarkModeSet(){
-  return localStorage.theme == "dark";
-}
+let extensions = parseExtensions();
+
 
 function parseExtensions(){
   return  [
@@ -66,7 +68,7 @@ function parseLanguage(name: String){
 }
 
 
-
+onBeforeUpdate( () => { extensions = parseExtensions(); } )
 
 </script>
 

Frontend/src/components/common/ThemeSwitcherComponent.vue

@@ -1,22 +1,30 @@
 <script setup lang="ts">
 
-const emit = defineEmits([
-    "theme",
-]);
+import lightThemeIcon from '@/assets/light_theme.svg';
+import darkThemeIcon from '@/assets/dark_theme.svg';
 
-function toDarkMode(){
-    localStorage.theme = "dark";
-    document.documentElement.classList.add('dark');
-    emit('theme',"dark");
+    const emit = defineEmits([
+        "theme",
+    ]);
 
-}
 
-function toLightMode(){
-    localStorage.theme = "light";
-    document.documentElement.classList.remove('dark');
-    emit('theme',"light");
+    function toDarkMode(){
+        localStorage.theme = "dark";
+        document.documentElement.classList.add('dark');
+        emit('theme',"dark");
+
+    }
+
+    function toLightMode(){
+        localStorage.theme = "light";
+        document.documentElement.classList.remove('dark');
+        emit('theme',"light");
+
+    }
+
+    
+
 
-}
 
 </script>
 

Frontend/src/components/formatter/HtmlButtonFormatterComponent.vue

@@ -21,8 +21,6 @@ const emit = defineEmits([
     'update:error'
 ])
 
-const fetchLink = document.location.protocol + "//" + document.location.hostname + "/libxml/html/" + chooseType(props.formatType);
-
 function chooseType(formatType: String){
     if (formatType == "HTML -> XML"){
         return "convert";
@@ -47,6 +45,8 @@ function createBody(){
     });
 }
 
+const fetchLink = document.location.protocol + "//" + document.location.hostname + "/libxml/html/" + chooseType(props.formatType);
+
 
 function process(){
     fetch(fetchLink, {body:createBody(), method: "POST"})

Frontend/src/components/landing/LandingComponent.vue

@@ -19,7 +19,7 @@
       <li><strong>XPath</strong> - This is tool that allows to parse XPath on selected XML</li>
       <li><strong>XQuery</strong> - Allows to execute XQuery on provided XML file.</li>
       <li><strong>XSD</strong> - Allows to validate XML against provided XSD schema.</li>
-      <li><strong>XSLT</strong> - Allows to transform XML using XSLT transform.</li>
+      <li><strong>XSLT</strong> - Allows to transformate XML using XSLT transformate.</li>
     </ul>
     
     <h2 class="text-xl mt-2">Formatter - Tools:</h2>
@@ -39,4 +39,3 @@
 </template>
 
 <style scoped></style>
-

Frontend/src/components/man/ElementDescription.vue

@@ -1,5 +1,9 @@
 <script setup lang="ts">
 
+import { ref } from 'vue'
+
+
+
 const props = defineProps(
     {
         name: {type: String, required: true}

Frontend/src/components/man/ImgMan.vue

@@ -1,5 +1,9 @@
 <script setup lang="ts">
 
+import { ref } from 'vue'
+
+
+
 const props = defineProps(
     {
         imgPath: {type: String, required: true},

Frontend/src/components/man/ManTooltipComponent.vue

@@ -1,6 +1,18 @@
 <script setup lang="ts">
 import { ref } from 'vue';
 
+
+// const props = defineProps({
+//     version: {
+//         type: String,
+//         required: true
+//     },
+//     toolType: {
+//         type: String,
+//         required: true
+//     }
+// })
+
 const emit = defineEmits([
     "update:visible"
 ])

Frontend/src/components/mock/BodyDetailComponent.vue

@@ -14,5 +14,5 @@ const props = defineProps(
 </script>
 
 <template>
-    <CodeEditorComponent :code="props.data" :config='{disabled:false, language:props.contentType.replace("application/","")}' />
+    <CodeEditorComponent :code="props.data" :config='{disabled:true, language:props.contentType.replace("application/","")}' />
 </template>

Frontend/src/components/mock/HistoryRecords.vue

@@ -1,11 +1,6 @@
 <script setup lang="ts">
 import {ref, type Ref } from 'vue';
 
-const emit = defineEmits([
-    'click:showHeaders',
-    'click:showBody',
-])
-
 interface historyRecord {
     clientUUID : String,
     dateTimeStamp: String,
@@ -19,11 +14,15 @@ interface Headers {
     [propName: string]: any;
 }
 
+const emit = defineEmits([
+    'click:showHeaders',
+    'click:showBody',
+])
+
+
 const clientUUID = localStorage.getItem("clientUUID")
 const fetchLink = window.location.protocol + "//" + window.location.hostname + "/mock/api/event";
-const historyRecords : Ref<Array<historyRecord>> = ref([]);
-
-
+const historyRecords : Ref<Array<historyRecord>> = ref([])
 fetch(fetchLink+"/"+clientUUID).then(response => response.json()).then(data => { historyRecords.value = data });
 
 function parseTimeStamp(timestamp : String){

Frontend/src/components/mock/MockedMessageToastComponent.vue

@@ -1,4 +1,5 @@
 <script setup lang="ts">
+import { ref } from 'vue';
 
 const emit = defineEmits([
     'closed:toast_closed',

Frontend/src/components/mock/RestMockMessageComponent.vue

@@ -4,6 +4,10 @@ import HeadersComponent from './HeadersComponent.vue';
 import SaveComponent from './SaveComponent.vue';
 import CodeEditorComponent from '@/components/common/CodeEditorComponent.vue';
 
+const clientUUID = ref('');
+const host = window.location.protocol + "//" + window.location.hostname + "/mock";
+const mockMessageLink = ref("www.google.com");
+
 interface mockedMessageData {
   clientUUID: string;
   contentType: string;
@@ -12,10 +16,6 @@ interface mockedMessageData {
   httpStatus: number;
 }
 
-const clientUUID = ref('');
-const host = window.location.protocol + "//" + window.location.hostname + "/mock";
-const mockMessageLink = ref("www.google.com");
-
 const exampleData : mockedMessageData = {
   clientUUID : "exampleUUID",
   contentType: "application/json",
@@ -23,8 +23,8 @@ const exampleData : mockedMessageData = {
   httpHeaders: {Connection:"keep-alive"},
   httpStatus: 200,
 }
-let messageData : Ref<mockedMessageData> = ref(exampleData);
 
+let messageData : Ref<mockedMessageData> = ref(exampleData);
 if ( localStorage.clientUUID != undefined ){
     clientUUID.value = localStorage.clientUUID;
 }

Frontend/src/components/xml/XmlInputFieldComponent.vue

@@ -1,15 +1,13 @@
 <script setup lang="ts">
 import InsertTemplateComponent from '@components/common/InsertTemplateComponent.vue'
 import XMLButtonFormatterComponent from '@components/formatter/XMLButtonFormatterComponent.vue'
+import { ref } from 'vue'
 import CodeEditor from '@/components/common/CodeEditorComponent.vue'
 
-import {ref} from 'vue'
-import TabComponent from "@components/xml/TabComponent.vue";
-
 const props = defineProps(
     {
-      stylizedName: {type: String, required: true},
-      data: {type: String},
+        stylizedName: {type: String, required: true},
+        data: {type: String},
     }
 )
 const emit = defineEmits(['update:modelValue'])
@@ -18,88 +16,54 @@ const data = ref('')
 const inputFile = ref()
 
 function sendValue() {
-  emit('update:modelValue', data.value)
+    emit('update:modelValue', data.value)
 }
 
 function updateData(newData: string, clearFileSelector: boolean = true) {
-  data.value = newData
-  if (clearFileSelector)
-    inputFile.value.value = '';
-  sendValue()
+    data.value = newData
+    if (clearFileSelector)
+        inputFile.value.value = '';
+    sendValue()
 }
 
 function clear() {
-  updateData('')
+    updateData('')
 }
 
 function canBeFormatted() {
-  return props.stylizedName.toLowerCase() == 'xml' ||
-      props.stylizedName.toLowerCase() == 'xsd' ||
-      props.stylizedName.toLowerCase() == 'xslt'
+    return props.stylizedName.toLowerCase() == 'xml' || 
+           props.stylizedName.toLowerCase() == 'xsd' || 
+           props.stylizedName.toLowerCase() == 'xslt'
 }
 
-function addParameters() {
-  return props.stylizedName?.toLowerCase() == "xslt"
+function readFile(file : any) {
+    
+    const reader = new FileReader()
+    reader.onloadend = () => {
+        let result = reader.result?.toString()
+        if (typeof result == "string")
+            updateData(result, false);
+            
+    }
+    reader.readAsText(file.target.files[0])
 }
 
-function readFile(file: any) {
-
-  const reader = new FileReader()
-  reader.onloadend = () => {
-    let result = reader.result?.toString()
-    if (typeof result == "string")
-      updateData(result, false);
-
-  }
-  reader.readAsText(file.target.files[0])
-}
-
-
 </script>
 
 <template>
-  <div class="flex flex-col w-full h-1/2 lg:h-1/2 flex-none xl:pr-2 2xl:pr-4 pb-2">
-    <div class="flex justify-between mb-2"></div>
-
-    <div class="flex place-content-between w-full items-center">
-      <span class="dark:text-white mr-2">{{ stylizedName }}</span>
-      <div class="flex items-stretch w-64">
-        <input id="fileLoader" ref="inputFile" class="file-selector" type="file" accept=".xml,.xql,.xquery,.xslt,text/xml,text/plain" @change="readFile" />
-      </div>
-      <div class="flex space-x-2 pb-2 overflow-x-auto">
-        <InsertTemplateComponent :stylized-name="props.stylizedName" @update:default-data="updateData"></InsertTemplateComponent>
-        <XMLButtonFormatterComponent v-if="canBeFormatted()" :xml="data" @update:result="(data:any) => updateData(data.result)"></XMLButtonFormatterComponent>
-        <button class="tool-button" @click="clear">Clear</button>
-      </div>
+    <div class="flex flex-col w-full h-1/2 lg:h-1/2 flex-none xl:pr-2 2xl:pr-4 pb-2">
+        <div class="flex place-content-between w-full items-center">
+            <span class="dark:text-white mr-2">{{ stylizedName }}</span>
+            <div class="flex space-x-2 pb-2 overflow-x-auto">
+                <div class="flex items-stretch w-64">
+                    <input id="fileLoader" ref="inputFile" class="file-selector" type="file" accept=".xml,.xql,.xquery,.xslt,text/xml,text/plain" @change="readFile" />
+                </div>
+                
+                <InsertTemplateComponent :stylized-name="props.stylizedName" @update:default-data="updateData"></InsertTemplateComponent>
+                <XMLButtonFormatterComponent v-if="canBeFormatted()" :xml="data" @update:result="(data:any) => updateData(data.result)"></XMLButtonFormatterComponent>
+                <button class="tool-button" @click="clear">Clear</button>
+            </div>
+        </div>
+        <CodeEditor @update:updated-code="updateData" v-model="data" :code="data" :config="{disabled:false, language:stylizedName}"></CodeEditor>
     </div>
-
-    <div class="flex place-content-between w-full items-center">
-      <div v-if="addParameters()" class="flex justify-end space-x-2 pb-2 overflow-x-auto ml-auto">
-        <select id = "myList" onchange = "favTutorial()" class = "w-full rounded-3xl" >
-          <option> ---Choose tutorial--- </option>
-          <option> w3schools </option>
-          <option> Javatpoint </option>
-          <option> tutorialspoint </option>
-          <option> geeksforgeeks </option>
-        </select>
-        <input
-            id="textInput1"
-            class="text-input px-2 py-1 border rounded-3xl w-1/3"
-            type="text"
-            placeholder="Input 1"
-        />
-        <input
-            id="textInput2"
-            class="text-input px-2 py-1 border rounded-3xl w-1/3"
-            type="text"
-            placeholder="Input 2"
-        />
-        <button class="tool-button" @click="clear">Add Variable</button>
-      </div>
-    </div>
-
-    <CodeEditor @update:updated-code="updateData" v-model="data" :code="data"
-                :config="{disabled:false, language:stylizedName}"></CodeEditor>
-  </div>
-
 </template>

Frontend/src/components/xml/XmlInputFieldToolbarComponent.vue

@@ -0,0 +1,22 @@
+<script setup lang="ts">
+
+import InsertTemplateComponent from '@components/common/InsertTemplateComponent.vue'
+
+const props = defineProps(
+    {
+        prettyName: {type: String, required: true}
+    }
+)
+
+const emit = defineEmits(['update:defaultData'])
+
+function setDefault(data: string) {
+    const emitName = "update:defaultData";
+    emit(emitName, data)
+}
+
+</script>
+
+<template>
+    
+</template>

Frontend/src/components/xml/XmlOutputFieldComponent.vue

@@ -54,7 +54,6 @@ function changeAvailableVersions() {
         changeAvailableVersionsOfXSLT();
     else if (props.tool == "xsd")
         versionsForCurrentEngine.value = ["N/A"];
-
     else if (props.tool == "xpath")
         changeAvailableVersionsOfXPath();
 

Frontend/src/components/xml/XmlTabbedInputComponent.vue

@@ -17,8 +17,6 @@ const emit = defineEmits(['update:modelValue'])
 
 const newTabId = ref(0);
 const activeTabId = ref(0);
-const data = ref('')
-const inputFile = ref()
 
 const tabs = ref(new Array<TabData>);
 tabs.value.push({
@@ -27,6 +25,10 @@ tabs.value.push({
     data: "",
 })
 
+const data = ref('')
+const inputFile = ref()
+
+
 function sendValue() {
     emit('update:modelValue', tabs.value);
 }

Frontend/src/components/xml/XmlToolComponent.vue

@@ -0,0 +1,83 @@
+<script setup lang="ts">
+import { onMounted, ref, watch } from 'vue';
+
+const xml = ref('');
+const transform = ref('');
+const transformPlaceholder = ref('');
+const engine = ref('');
+const result = ref('');
+
+const activeXmlTool = ref('');
+
+async function submit() {
+  const engineEndpoint = engine.value == "libxml" ? "libxml" : "java";
+  const url = document.location.protocol + "//" + document.location.hostname + "/" + engineEndpoint + "/" + activeXmlTool.value;
+
+  var version = "1.0";
+  if (engine.value == "saxon")
+    version = "3.0"
+
+  var requestBody = JSON.stringify({
+    "data": xml.value,
+    "process": transform.value,
+    "processor": engine.value,
+    "version": version
+  });
+
+  var request = new Request(url, {
+    body: requestBody,
+    method: "POST"
+  });
+
+
+  var responseBody = await fetch(request)
+    .then(response => response.json())
+    .then((body) => body);
+
+  result.value = responseBody.result;
+}
+
+watch(activeXmlTool, (tool) => {
+  if (tool == "xpath")
+    transformPlaceholder.value = "XPath";
+  if (tool == "xsd")
+    transformPlaceholder.value = "XSD";
+  if (tool == "xslt")
+    transformPlaceholder.value = "XSLT";
+  if (tool == "xquery")
+    transformPlaceholder.value = "XQuery";
+  
+    transform.value = "";
+})
+
+onMounted(() => {
+  activeXmlTool.value = "xpath";
+});
+</script>
+
+<template>
+  <label for="xpath">XPath</label>
+  <input v-model="activeXmlTool" type="radio" id="xpath" name="xmltool" value="xpath" />
+
+  <label for="xslt">XSLT</label>
+  <input v-model="activeXmlTool" type="radio" id="xslt" name="xmltool" value="xslt" />
+
+  <label for="xsd">XSD</label>
+  <input v-model="activeXmlTool" type="radio" id="xsd" name="xmltool" value="xsd" />
+  
+  <label for="xquery">XQuery</label>
+  <input v-model="activeXmlTool" type="radio" id="xquery" name="xmltool" value="xquery" />
+  <br /><br />
+  <select name="engine" v-model="engine">
+    <option value="saxon" selected>Saxon</option>
+    <option value="xalan">Xalan</option>
+    <option value="libxml">libXML</option>
+  </select>
+  <br />
+  <textarea v-model="xml" id="xml" placeholder="XML"></textarea>
+  <textarea v-model="transform" id="transform" :placeholder="transformPlaceholder"></textarea><br />
+  <button @click="submit">Submit</button><br />
+  <pre><code>{{ result }}</code></pre>
+</template>
+
+<style scoped></style>

Frontend/src/components/xml/tooltips/TooltipDiffsComponent.vue

@@ -1,7 +1,7 @@
 <script setup lang="ts">
-import TooltipCategoryComponent from './TooltipCategoryComponent.vue';
 import xpathDiffs from '@/assets/tooltips/xpath/xpathdiffs.json';
 import xsltDiffs from '@/assets/tooltips/xslt/xsltdiffs.json';
+import TooltipCategoryComponent from './TooltipCategoryComponent.vue';
 
 
 const props = defineProps({
@@ -10,7 +10,7 @@ const props = defineProps({
 })
 
 function getDiffEntry(toolVersion : String) : string[] {
-    if ( props.toolName == "xpath" ) {
+    if ( props.toolName == "xpath" ){
         switch(toolVersion){
             case "2.0" : {
                 return xpathDiffs.VersionDiffs[0].diffs
@@ -27,7 +27,7 @@ function getDiffEntry(toolVersion : String) : string[] {
         }
     } else if (props.toolName == "xslt") {
         return ["XSLT 2.0"].concat(xsltDiffs.VersionDiffs[0].diffs).concat(["XSLT 3.0"]).concat(xsltDiffs.VersionDiffs[1].diffs) ;
-    } else {
+    } else{
         return ["foo"]
     }
     

Frontend/src/views/Base64EncoderView.vue

@@ -6,17 +6,17 @@ import { ref } from 'vue'
 
 const data : any = ref("")
 const imageData = ref("")
-const doShowImage = ref(false)
+const DoshowImage = ref(false)
 const inputImage = ref()
 
 function setTextFieldValue(newData: string) {
     data.value = newData.toString()
-    doShowImage.value = false
+    DoshowImage.value = false
 }
 
 function showImage(newImage : string){
     imageData.value = "data:image/jpeg;base64,"+newImage
-    doShowImage.value = true
+    DoshowImage.value = true
 }
 
 function convertImageToBase64(file : any){
@@ -32,7 +32,7 @@ function convertImageToBase64(file : any){
 function clear(){
     data.value = ""
     imageData.value = ""
-    doShowImage.value = false
+    DoshowImage.value = false
     inputImage.value.value = null
 }
 
@@ -65,7 +65,7 @@ function clear(){
     </div>
     
     <div id="layoutRight" class="w-full xl:w-1/2 min-h-[66%] xl:h-full">
-        <div class="border-2 rounded-lg border-gray-300 dark:border-gray-600 min-h-[50%]" v-on="doShowImage">
+        <div class="border-2 rounded-lg border-gray-300 dark:border-gray-600 min-h-[50%]" v-on="DoshowImage">
             <img :src="imageData"/>
         </div>
         

Samples/xquery/xquery.json

@@ -1,6 +1,10 @@
 {
     "data": "<people><person><name>John</name><age>67</age></person><person><name>Anna</name><age>69</age></person></people>",
+<<<<<<< HEAD
+    "process": "for $x in //person return string($x/name)",
+=======
     "processorData": "for $x in //person return string($x/name)",
+>>>>>>> 307e732608fca31b60027b417412691ff0e1c2f0
     "processor": "saxon",
     "version": "3.1"
 }