Added template for new operation

Reviewed-on: #277
Reviewed-by: Mikolaj Widla <widlam@noreply.example.com>
Co-authored-by: Adam Bem <adam.bem@zoho.eu>
Co-committed-by: Adam Bem <adam.bem@zoho.eu>

Backend/tools-services/src/main/java/com/r11/tools/controller/XmlController.java

@@ -50,7 +50,10 @@ public class XmlController implements RestController {
     public void acceptRequestXslt(Request request, Response response) {
         acceptRequest(request, response, XmlJobType.XSLT);
     }
-
+    @ScopedControllerManifest(method = HandlerType.POST, path = "/xslt/addParam")
+    public void acceptRequestXsltAddParam(Request request, Response response) {
+        acceptRequest(request, response, XmlJobType.XSLT_PARAM);
+    }
     private void acceptRequest(Request request, Response response, XmlJobType xmlJobType) {
         XMLRequestBody requestBody;
         try {
@@ -129,6 +132,8 @@ public class XmlController implements RestController {
 
         String result = null;
         switch (xmlJob.getXmlJobType()) {
+            case XSLT_PARAM:
+                result = engine.addParam(requestBody.getData(), requestBody.getProcessorData());
             case XSLT:
                 result = engine.processXSLT(requestBody.getData(), requestBody.getProcessorData());
                 break;

Backend/tools-services/src/main/java/com/r11/tools/controller/internal/XmlJobType.java

@@ -1,7 +1,7 @@
 package com.r11.tools.controller.internal;
 
 public enum XmlJobType {
-    XPath("XPath"), XSD("XSD"), XQuery("XQuery"), XSLT("XSLT");
+    XPath("XPath"), XSD("XSD"), XQuery("XQuery"), XSLT("XSLT"), XSLT_PARAM("PARAM");
 
     XmlJobType(String type) {
     }

Backend/tools-services/src/main/java/com/r11/tools/xml/Saxon.java

@@ -164,4 +164,9 @@ public class Saxon implements XmlEngine{
     public String getVersion() {
         return "Saxon " + new Processor(false).getSaxonProductVersion();
     }
+
+    @Override
+    public String addParam(String data, String processorData) throws Exception {
+        return null;
+    }
 }

Backend/tools-services/src/main/java/com/r11/tools/xml/Xalan.java

@@ -124,6 +124,11 @@ public class Xalan implements XmlEngine{
         return org.apache.xalan.Version.getVersion();
     }
 
+    @Override
+    public String addParam(String data, String processorData) throws Exception {
+        return null;
+    }
+
     /**
      * Validates string representation of the xml document against xsd schema
      * @param data xml document

Backend/tools-services/src/main/java/com/r11/tools/xml/XmlEngine.java

@@ -9,9 +9,7 @@ public interface XmlEngine {
     XPathQueryResult processXPath(String data, String query, String version) throws Exception;
     String processXSLT(String data, String transform) throws Exception;
     String validate(String data, String xsd) throws Exception;
-
     String executeXQuery(String data, String xquery, String version) throws Exception;
-
     public String getVersion();
-
+    String addParam(String data, String processorData) throws Exception;
 }

Frontend/README.md

@@ -1,4 +1,4 @@
-# new-frontend
+# Modern frontend for Release 11 Tools
 
 This template should help get you started developing with Vue 3 in Vite.
 
@@ -44,3 +44,46 @@ 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/XsltParamComponent.vue

@@ -0,0 +1,33 @@
+<script setup lang="ts">
+import {defineComponent, ref} from 'vue'
+const selected = ref('A')
+
+let options = ref([
+  { text: 'One', value: 'A' },
+  { text: 'Two', value: 'B' },
+  { text: 'Three', value: 'C' }
+])
+</script>
+
+<template>
+  <select v-model="selected" class="px-3 rounded-full border border-slate-400 bg-white dark:text-slate-100 dark:bg-gray-600 w-2/3" >
+    <option v-for="option in options" :value="option.value">
+      {{ option.text }}
+    </option>
+  </select>
+
+  <input
+      id="textInput1"
+      class="text-input px-3 rounded-full border border-slate-400 bg-white dark:text-slate-100 dark:bg-gray-600 w-1/3"
+      type="text"
+      placeholder="Name"
+  />
+  <input
+      id="textInput2"
+      class="text-input px-3 rounded-full border border-slate-400 bg-white dark:text-slate-100 dark:bg-gray-600 w-1/3"
+      type="text"
+      placeholder="Value"
+  />
+  <button class="tool-button" @click="clear">Add Variable</button>
+</template>
+

Frontend/src/components/common/CodeEditorComponent.vue

@@ -7,12 +7,6 @@ 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,
@@ -30,21 +24,25 @@ 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;
-  }
 }
 
-let extensions = parseExtensions();
+function isDarkModeSet(){
-
+  return localStorage.theme == "dark";
+}
 
 function parseExtensions(){
   return  [
@@ -68,7 +66,7 @@ function parseLanguage(name: String){
 }
 
 
-onBeforeUpdate( () => { extensions = parseExtensions(); } )
+
 
 </script>
 

Frontend/src/components/common/ThemeSwitcherComponent.vue

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

Frontend/src/components/formatter/HtmlButtonFormatterComponent.vue

@@ -21,6 +21,8 @@ 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";
@@ -45,8 +47,6 @@ 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 transformate XML using XSLT transformate.</li>
+      <li><strong>XSLT</strong> - Allows to transform XML using XSLT transform.</li>
     </ul>
     
     <h2 class="text-xl mt-2">Formatter - Tools:</h2>

Frontend/src/components/man/ElementDescription.vue

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

Frontend/src/components/man/ImgMan.vue

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

Frontend/src/components/man/ManTooltipComponent.vue

@@ -1,18 +1,6 @@
 <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:true, language:props.contentType.replace("application/","")}' />
+    <CodeEditorComponent :code="props.data" :config='{disabled:false, language:props.contentType.replace("application/","")}' />
 </template>

Frontend/src/components/mock/HistoryRecords.vue

@@ -1,6 +1,11 @@
 <script setup lang="ts">
 import {ref, type Ref } from 'vue';
 
+const emit = defineEmits([
+    'click:showHeaders',
+    'click:showBody',
+])
+
 interface historyRecord {
     clientUUID : String,
     dateTimeStamp: String,
@@ -14,15 +19,11 @@ 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,5 +1,4 @@
 <script setup lang="ts">
-import { ref } from 'vue';
 
 const emit = defineEmits([
     'closed:toast_closed',

Frontend/src/components/mock/RestMockMessageComponent.vue

@@ -4,10 +4,6 @@ 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;
@@ -16,6 +12,10 @@ 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);
+
 if ( localStorage.clientUUID != undefined ){
     clientUUID.value = localStorage.clientUUID;
 }

Frontend/src/components/xml/XmlInputFieldComponent.vue

@@ -1,13 +1,15 @@
 <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 XsltParamComponent from '@/components/XsltParamComponent.vue'
+
+import {ref} from 'vue'
 
 const props = defineProps(
     {
-        stylizedName: {type: String, required: true},
+      stylizedName: {type: String, required: true},
-        data: {type: String},
+      data: {type: String},
     }
 )
 const emit = defineEmits(['update:modelValue'])
@@ -16,54 +18,72 @@ 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
+  data.value = newData
-    if (clearFileSelector)
+  if (clearFileSelector)
-        inputFile.value.value = '';
+    inputFile.value.value = '';
-    sendValue()
+  sendValue()
 }
 
 function clear() {
-    updateData('')
+  updateData('')
 }
 
 function canBeFormatted() {
-    return props.stylizedName.toLowerCase() == 'xml' || 
+  return props.stylizedName.toLowerCase() == 'xml' ||
-           props.stylizedName.toLowerCase() == 'xsd' || 
+      props.stylizedName.toLowerCase() == 'xsd' ||
-           props.stylizedName.toLowerCase() == 'xslt'
+      props.stylizedName.toLowerCase() == 'xslt'
 }
 
-function readFile(file : any) {
+function addParameters() {
-    
+  return props.stylizedName?.toLowerCase() == "xslt"
-    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 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">
+    <div class="flex justify-between mb-2"></div>
-            <span class="dark:text-white mr-2">{{ stylizedName }}</span>
+
-            <div class="flex space-x-2 pb-2 overflow-x-auto">
+    <div class="flex place-content-between w-full items-center">
-                <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" />
+      <span class="dark:text-white mr-2">{{ stylizedName }}</span>
-                </div>
+
-                
+      <div class="flex items-stretch w-64">
-                <InsertTemplateComponent :stylized-name="props.stylizedName" @update:default-data="updateData"></InsertTemplateComponent>
+        <input id="fileLoader" ref="inputFile" class="file-selector" type="file" accept=".xml,.xql,.xquery,.xslt,text/xml,text/plain" @change="readFile"/>
-                <XMLButtonFormatterComponent v-if="canBeFormatted()" :xml="data" @update:result="(data:any) => updateData(data.result)"></XMLButtonFormatterComponent>
+      </div>
-                <button class="tool-button" @click="clear">Clear</button>
+
-            </div>
+      <div class="flex space-x-2 pb-2 overflow-x-auto">
-        </div>
+        <InsertTemplateComponent :stylized-name="props.stylizedName" @update:default-data="updateData"></InsertTemplateComponent>
-        <CodeEditor @update:updated-code="updateData" v-model="data" :code="data" :config="{disabled:false, language:stylizedName}"></CodeEditor>
+        <XMLButtonFormatterComponent v-if="canBeFormatted()" :xml="data" @update:result="(data:any) => updateData(data.result)"></XMLButtonFormatterComponent>
+        <button class="tool-button" @click="clear">Clear</button>
+      </div>
     </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">
+        <XsltParamComponent :stylizedName="stylizedName"/>
+      </div>
+    </div>
+
+    <CodeEditor @update:updated-code="updateData" v-model="data" :code="data" :config="{disabled:false, language:stylizedName}"></CodeEditor>
+  </div>
 </template>

Frontend/src/components/xml/XmlTabbedInputComponent.vue

@@ -17,6 +17,8 @@ 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({
@@ -25,10 +27,6 @@ tabs.value.push({
     data: "",
 })
 
-const data = ref('')
-const inputFile = ref()
-
-
 function sendValue() {
     emit('update:modelValue', tabs.value);
 }

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>