ayanova/devdocs/todo.txt

@@ -8,15 +8,24 @@ PRIORITY - ALWAYS Lowest level stuff first, i.e. TODO at server, api route chang
 todo: Administration - translation
 	translation page with translation settings
 	- Translation feedback link in translation page https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/3722
-	- https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1442
-	https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1439
+	- Update local copies, make sure search is kick ass	
+		https://rockfish.ayanova.com/default.htm#!/rfcaseEdit/1442
+
 	- No need to show the built in ones at all if they can't be edited.
-	
-
-todo: Administration - Attached files
-
+		although, need something to duplicate for custom locales
+	- have a filter button type what you want and it will reduce the entire list to those that contain the filter for easy id and editing
+	- Replace function
+	- Export function (download as file I guess)
+	- Import function
+	- Duplicate select new
+	- Set all users to use chosen translation feature?
+		this might be a handy thing
+	- When change translation if it's the same one currently in use then it should also update the local copy so user doesn't have to logout to see it in action	
+		- maybe a function called from Translation.js that you pass all the updated keys after a successful save and it automatically scans for local copies and changes them
 
+todo: help links for User, Users, Translations, Translation
 
+todo: Administration - Attached files manager
 
 todo: Administration - History
 	What is this for?

ayanova/src/api/initialize.js

@@ -564,7 +564,7 @@ function initNavPanel() {
     sub.push({
       title: t("Translation"),
       icon: "fa-language",
-      route: "/adm-translation",
+      route: "/adm-translations",
       key: key++
     });
 

ayanova/src/router.js

@@ -310,7 +310,13 @@ export default new Router({
         import(/* webpackChunkName: "adm" */ "./views/adm-user.vue")
     },
     {
-      path: "/adm-translation",
+      path: "/adm-translations",
+      name: "adm-translations",
+      component: () =>
+        import(/* webpackChunkName: "adm" */ "./views/adm-translations.vue")
+    },
+    {
+      path: "/adm-translations/:recordid",
       name: "adm-translation",
       component: () =>
         import(/* webpackChunkName: "adm" */ "./views/adm-translation.vue")

ayanova/src/views/adm-global-settings.vue

@@ -14,8 +14,6 @@
 </template>
 
 <script>
-import UnderConstruction from "../components/underconstruction.vue";
-
 export default {
   beforeCreate() {
     window.$gz.eventBus.$emit("menu-change", {

ayanova/src/views/adm-translation.vue

@@ -1,21 +1,514 @@
 <template>
-  <UnderConstruction />
+  <v-container fluid>
+    <gz-report-selector ref="reportSelector"></gz-report-selector>
+    <v-row v-if="formState.ready">
+      <v-col>
+        <v-form ref="form">
+          <v-row>
+            <gz-error :errorBoxMessage="formState.errorBoxMessage"></gz-error>
+
+            <!-- <v-col cols="12" sm="6" lg="4" xl="3">
+              <v-text-field
+                v-model="obj.name"
+                :readonly="formState.readOnly"
+                :disabled="formState.readOnly"
+                :clearable="!formState.readOnly"
+                @click:clear="fieldValueChanged('name')"
+                :counter="255"
+                :label="$ay.t('Name')"
+                :rules="[
+                  form().max255(this, 'name'),
+                  form().required(this, 'name')
+                ]"
+                :error-messages="form().serverErrors(this, 'name')"
+                ref="name"
+                :data-cy="!!$ay.dev ? 'name' : false"
+                @input="fieldValueChanged('name')"
+              ></v-text-field>
+            </v-col> -->
+          </v-row>
+        </v-form>
+      </v-col>
+    </v-row>
+    <template v-if="!formState.ready">
+      <v-progress-circular
+        indeterminate
+        color="primary"
+        :size="60"
+      ></v-progress-circular>
+    </template>
+  </v-container>
 </template>
 
 <script>
-import UnderConstruction from "../components/underconstruction.vue";
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////
+/*  Xeslint-disable    */
+//
+////////////////////////////////////////////////////////////////////////////////////////////////////////////
+//
+const FORM_KEY = "translation-edit";
+const API_BASE_URL = "translation/";
+const FORM_CUSTOM_TEMPLATE_KEY = "Translation";
 
 export default {
-  components: {
-    UnderConstruction
+  async created() {
+    //created is called when the route is updated to show a new record even though we don't need to re-init again
+    let vm = this;
+    try {
+      await initForm(vm);
+
+      vm.rights = window.$gz.role.getRights(window.$gz.type.Translation);
+      vm.formState.readOnly = !vm.rights.change;
+      window.$gz.eventBus.$on("menu-click", clickHandler);
+
+      //id 0 means create a new record don't load one
+      if (vm.$route.params.recordid != 0) {
+        //is there already an obj from a prior operation?
+        if (this.$route.params.obj) {
+          //yes, no need to fetch it
+          this.obj = this.$route.params.obj;
+          vm.formState.loading = false; //here we handle it immediately
+        } else {
+          vm.getDataFromApi(vm.$route.params.recordid); //let getdata handle loading
+        }
+      } else {
+        vm.formState.loading = false; //here we handle it immediately
+      }
+      //set initial form status
+      window.$gz.form.setFormState({
+        vm: vm,
+        dirty: false,
+        valid: true
+      });
+
+      generateMenu(vm);
+    } catch (error) {
+      window.$gz.errorHandler.handleFormError(error, vm);
+    } finally {
+      vm.formState.ready = true;
+    }
   },
-  beforeCreate() {
-    window.$gz.eventBus.$emit("menu-change", {
-      isMain: true,
-      icon: "fa-language",
-      title: this.$ay.t("Translation"),
-      helpUrl: "form-adm-translation"
-    });
+  async beforeRouteLeave(to, from, next) {
+    if (!this.formState.dirty || JUST_DELETED) {
+      next();
+      return;
+    }
+    if ((await window.$gz.dialog.confirmLeaveUnsaved()) === true) {
+      next();
+    } else {
+      next(false);
+    }
+  },
+  beforeDestroy() {
+    window.$gz.eventBus.$off("menu-click", clickHandler);
+  },
+  components: {},
+  data() {
+    return {
+      formCustomTemplateKey: FORM_CUSTOM_TEMPLATE_KEY,
+      selectLists: {},
+      obj: {},
+      login: null,
+      password: null,
+      reveal: true,
+      formState: {
+        ready: false,
+        dirty: false,
+        valid: true,
+        readOnly: false,
+        loading: true,
+        errorBoxMessage: null,
+        appError: null,
+        serverError: {}
+      },
+      rights: window.$gz.role.defaultRightsObject(),
+      ayaType: window.$gz.type.Translation
+    };
+  },
+  //WATCHERS
+  watch: {
+    formState: {
+      handler: function(val) {
+        if (this.formState.loading) {
+          return;
+        }
+
+        //enable / disable save button
+        if (val.dirty && val.valid && !val.readOnly) {
+          window.$gz.eventBus.$emit("menu-enable-item", FORM_KEY + ":save");
+        } else {
+          window.$gz.eventBus.$emit("menu-disable-item", FORM_KEY + ":save");
+        }
+
+        //enable / disable duplicate / new button
+        if (!val.dirty && val.valid && !val.readOnly) {
+          window.$gz.eventBus.$emit(
+            "menu-enable-item",
+            FORM_KEY + ":duplicate"
+          );
+          window.$gz.eventBus.$emit("menu-enable-item", FORM_KEY + ":new");
+        } else {
+          window.$gz.eventBus.$emit(
+            "menu-disable-item",
+            FORM_KEY + ":duplicate"
+          );
+          window.$gz.eventBus.$emit("menu-disable-item", FORM_KEY + ":new");
+        }
+      },
+      deep: true
+    }
+  },
+  computed: {
+    canSave: function() {
+      return this.formState.valid && this.formState.dirty;
+    },
+    canDuplicate: function() {
+      return this.formState.valid && !this.formState.dirty;
+    }
+  },
+  methods: {
+    ayaTypes: function() {
+      return window.$gz.type;
+    },
+    form() {
+      return window.$gz.form;
+    },
+    fieldValueChanged(ref) {
+      if (
+        this.formState.ready &&
+        !this.formState.loading &&
+        !this.formState.readOnly
+      ) {
+        window.$gz.form.fieldValueChanged(this, ref);
+      }
+    },
+    async getDataFromApi(recordId) {
+      let vm = this;
+      vm.formState.loading = true;
+
+      if (!recordId) {
+        throw FORM_KEY + "::getDataFromApi -> Missing recordID!";
+      }
+      let url = API_BASE_URL + recordId;
+      try {
+        window.$gz.form.deleteAllErrorBoxErrors(vm);
+        let res = await window.$gz.api.get(url);
+
+        if (res.error) {
+          //Not found?
+          if (res.error.code == "2010") {
+            //notify not found error then navigate backwards
+            window.$gz.eventBus.$emit("notify-error", vm.$ay.t("ErrorAPI2010"));
+            // navigate backwards
+            window.$gz._.delay(function() {
+              vm.$router.go(-1);
+            }, 2000);
+          }
+          vm.formState.serverError = res.error;
+          window.$gz.form.setErrorBoxErrors(vm);
+        } else {
+          vm.obj = res.data;
+          //modify the menu as necessary
+          generateMenu(vm);
+
+          //Update the form status
+          window.$gz.form.setFormState({
+            vm: vm,
+            dirty: false,
+            valid: true,
+            loading: false
+          });
+        }
+      } catch (error) {
+        window.$gz.errorHandler.handleFormError(error, vm);
+      } finally {
+        vm.formState.loading = false;
+      }
+    },
+    async submit() {
+      let vm = this;
+      if (vm.canSave == false) {
+        return;
+      }
+
+      try {
+        vm.formState.loading = true;
+        let url = API_BASE_URL;
+        //clear any errors vm might be around from previous submit
+        window.$gz.form.deleteAllErrorBoxErrors(vm);
+
+        let res = await window.$gz.api.upsert(url, submitObject);
+        if (res.error) {
+          vm.formState.serverError = res.error;
+          window.$gz.form.setErrorBoxErrors(vm);
+        } else {
+          //Logic for detecting if a post or put: if id then it was a post, if no id then it was a put
+          if (res.data.id) {
+            //POST - whole new object returned
+            vm.obj = res.data;
+            //Change URL to new record
+            //NOTE: will not cause a page re-render, almost nothing does unless forced with a KEY property or using router.GO()
+
+            this.$router.push({
+              name: "adm-translation",
+              params: {
+                recordid: res.data.id,
+                obj: res.data //Pass data object to new form
+              }
+            });
+          } else {
+            //PUT - only concurrency token is returned (**warning, if server changes object other fields then this needs to act more like POST above but is more efficient this way**)
+            //Handle "put" of an existing record (UPDATE)
+            vm.obj.concurrency = res.data.concurrency;
+          }
+
+          //Update the form status
+          window.$gz.form.setFormState({
+            vm: vm,
+            dirty: false,
+            valid: true
+          });
+        }
+      } catch (ex) {
+        window.$gz.errorHandler.handleFormError(ex, vm);
+      } finally {
+        vm.formState.loading = false;
+      }
+    },
+    async remove() {
+      let vm = this;
+      try {
+        let dialogResult = await window.$gz.dialog.confirmDelete();
+        if (dialogResult != true) {
+          return;
+        }
+
+        //do the delete
+        vm.formState.loading = true;
+        //No need to delete a new record, just abandon it...
+        if (vm.$route.params.recordid == 0) {
+          //this should not get offered for delete but to be safe and clear just in case:
+          JUST_DELETED = true;
+          // navigate backwards
+          vm.$router.go(-1);
+        } else {
+          let url = API_BASE_URL + vm.$route.params.recordid;
+
+          window.$gz.form.deleteAllErrorBoxErrors(vm);
+          let res = await window.$gz.api.remove(url);
+          if (res.error) {
+            vm.formState.serverError = res.error;
+            window.$gz.form.setErrorBoxErrors(vm);
+          } else {
+            //workaround to prevent warning about leaving dirty record
+            //For some reason I couldn't just reset isdirty in formstate
+            JUST_DELETED = true;
+            // navigate backwards
+            vm.$router.go(-1);
+          }
+        }
+      } catch (ex) {
+        window.$gz.errorHandler.handleFormError(ex, vm);
+      } finally {
+        vm.formState.loading = false;
+      }
+    },
+    async duplicate() {
+      let vm = this;
+      if (!vm.canDuplicate || vm.$route.params.recordid == 0) {
+        return;
+      }
+      vm.formState.loading = true;
+      let url = API_BASE_URL + "duplicate/" + vm.$route.params.recordid;
+
+      try {
+        window.$gz.form.deleteAllErrorBoxErrors(vm);
+        let res = await window.$gz.api.upsert(url);
+        if (res.error) {
+          vm.formState.serverError = res.error;
+          window.$gz.form.setErrorBoxErrors(vm);
+        } else {
+          //Navigate to new record
+          this.$router.push({
+            name: "adm-translation",
+            params: {
+              recordid: res.data.id,
+              obj: res.data // pass data object to new form
+            }
+          });
+        }
+      } catch (ex) {
+        window.$gz.errorHandler.handleFormError(ex, vm);
+      } finally {
+        vm.formState.loading = false;
+      }
+    }
   }
 };
+
+/////////////////////////////
+//
+//
+async function clickHandler(menuItem) {
+  if (!menuItem) {
+    return;
+  }
+  let m = window.$gz.menu.parseMenuItem(menuItem);
+  if (m.owner == FORM_KEY && !m.disabled) {
+    switch (m.key) {
+      case "save":
+        m.vm.submit();
+        break;
+      case "delete":
+        m.vm.remove();
+        break;
+      case "new":
+        m.vm.$router.push({
+          name: "adm-translation",
+          params: { recordid: 0, new: true }
+        });
+        break;
+      case "duplicate":
+        m.vm.duplicate();
+        break;
+      case "report":
+        if (m.id != null) {
+          //last report selected
+          m.vm.$router.push({
+            name: "ay-report",
+            params: { recordid: m.id, ayatype: window.$gz.type.Translation }
+          });
+        } else {
+          //general report selector chosen
+          let res = await m.vm.$refs.reportSelector.open();
+
+          //if null for no selection
+          //just bail out
+          if (res == null) {
+            return;
+          }
+          //persist last report selected
+          window.$gz.form.setLastReport(FORM_KEY, res);
+
+          //Now open the report viewer...
+          m.vm.$router.push({
+            name: "ay-report",
+            params: { recordid: res.id, ayatype: window.$gz.type.Translation }
+          });
+        }
+        break;
+      default:
+        window.$gz.eventBus.$emit(
+          "notify-warning",
+          FORM_KEY + "::context click: [" + m.key + "]"
+        );
+    }
+  }
+}
+
+//////////////////////
+//
+//
+function generateMenu(vm) {
+  let menuOptions = {
+    isMain: false,
+    icon: "fa-language",
+    title: vm.$ay.t("Translation"),
+    helpUrl: "form-translation",
+    formData: {
+      ayaType: window.$gz.type.Translation,
+      recordId: vm.$route.params.recordid,
+      formCustomTemplateKey: FORM_CUSTOM_TEMPLATE_KEY
+    },
+    menuItems: []
+  };
+
+  if (vm.rights.change) {
+    menuOptions.menuItems.push({
+      title: vm.$ay.t("Save"),
+      icon: "fa-save",
+      surface: true,
+      key: FORM_KEY + ":save",
+      vm: vm
+    });
+  }
+
+  if (vm.rights.delete && vm.$route.params.recordid != 0) {
+    menuOptions.menuItems.push({
+      title: vm.$ay.t("Delete"),
+      icon: "fa-trash-alt",
+      surface: true,
+      key: FORM_KEY + ":delete",
+      vm: vm
+    });
+  }
+
+  //STUB REPORTS
+  //Report not Print, print is a further option
+  menuOptions.menuItems.push({
+    title: vm.$ay.t("Report"),
+    icon: "fa-file-alt",
+    key: FORM_KEY + ":report",
+    vm: vm
+  });
+
+  //get last report selected
+  let lastReport = window.$gz.form.getLastReport(FORM_KEY);
+  if (lastReport != null) {
+    menuOptions.menuItems.push({
+      title: lastReport.name,
+      icon: "fa-file-alt",
+      key: FORM_KEY + ":report:" + lastReport.id,
+      vm: vm
+    });
+  }
+
+  if (vm.rights.change) {
+    menuOptions.menuItems.push({
+      title: vm.$ay.t("New"),
+      icon: "fa-plus",
+      key: FORM_KEY + ":new",
+      vm: vm
+    });
+  }
+
+  if (vm.rights.change && vm.$route.params.recordid != 0) {
+    menuOptions.menuItems.push({
+      title: vm.$ay.t("Duplicate"),
+      icon: "fa-clone",
+      key: FORM_KEY + ":duplicate",
+      vm: vm
+    });
+  }
+
+  window.$gz.eventBus.$emit("menu-change", menuOptions);
+}
+
+let JUST_DELETED = false;
+
+/////////////////////////////////
+//
+//
+async function initForm(vm) {
+  await fetchTranslatedText(vm);
+  await window.$gz.formCustomTemplate.get(FORM_CUSTOM_TEMPLATE_KEY);
+  await populateSelectionLists(vm);
+}
+
+//////////////////////////////////////////////////////////
+//
+// Ensures UI translated text is available
+//
+async function fetchTranslatedText(vm) {
+  await window.$gz.translation.cacheTranslations(["Translation"]);
+}
+
+//////////////////////
+//
+//
+async function populateSelectionLists(vm) {
+  //ensure the pick lists required are pre-fetched
+  // await window.$gz.enums.fetchEnumList("usertype");
+  //vm.selectLists.usertypes = window.$gz.enums.getSelectionList("usertype");
+}
 </script>

ayanova/src/views/adm-translations.vue

@@ -0,0 +1,109 @@
+<template>
+  <gz-data-table
+    formKey="adm-translations"
+    :dataListKey="dataListKey"
+    :dataListFilter="dataListFilter"
+    :dataListSort="dataListSort"
+    :showSelect="false"
+    :singleSelect="false"
+    v-on:update:selected="handleSelected"
+  >
+  </gz-data-table>
+</template>
+
+<script>
+const FORM_KEY = "adm-translations";
+export default {
+  created() {
+    this.rights = window.$gz.role.getRights(window.$gz.type.Translation);
+    window.$gz.eventBus.$on("menu-click", clickHandler);
+    generateMenu(this);
+  },
+  beforeDestroy() {
+    window.$gz.eventBus.$off("menu-click", clickHandler);
+  },
+  data() {
+    return {
+      currentListViewId: 1,
+      dataListKey: "TranslationDataList",
+      dataListFilter: "",
+      dataListSort: "",
+      rights: window.$gz.role.defaultRightsObject()
+    };
+  },
+  methods: {
+    handleSelected(selectedItems) {
+      console.log(selectedItems);
+    }
+  }
+};
+
+/////////////////////////////
+//
+//
+function clickHandler(menuItem) {
+  if (!menuItem) {
+    return;
+  }
+  let m = window.$gz.menu.parseMenuItem(menuItem);
+  if (m.owner == FORM_KEY && !m.disabled) {
+    switch (m.key) {
+      case "new":
+        m.vm.$router.push({
+          name: "adm-translation",
+          params: { recordid: 0 }
+        });
+        break;
+      default:
+        window.$gz.eventBus.$emit(
+          "notify-warning",
+          FORM_KEY + "::context click: [" + m.key + "]"
+        );
+    }
+  }
+}
+
+//////////////////////
+//
+//
+function generateMenu(vm) {
+  let menuOptions = {
+    isMain: true,
+    icon: "fa-language",
+    title: vm.$ay.t("Translation"),
+    helpUrl: "form-adm-translations",
+    menuItems: [],
+    formData: {
+      ayaType: window.$gz.type.Translation
+    }
+  };
+
+  if (vm.rights.change) {
+    menuOptions.menuItems.push({
+      title: vm.$ay.t("New"),
+      icon: "fa-plus",
+      surface: true,
+      key: FORM_KEY + ":new",
+      vm: vm
+    });
+  }
+
+  //STUB REPORTS
+  //Report not Print, print is a further option
+  menuOptions.menuItems.push({
+    title: vm.$ay.t("Report"),
+    icon: "fa-file-alt",
+    key: FORM_KEY + ":report",
+    vm: vm
+  });
+
+  menuOptions.menuItems.push({
+    title: "stub: Last report used",
+    icon: "fa-file-alt",
+    key: FORM_KEY + ":report:STUBlastusedreportid",
+    vm: vm
+  });
+
+  window.$gz.eventBus.$emit("menu-change", menuOptions);
+}
+</script>