@konfuzio/document-validation-ui 0.1.1

package/src/locales/en.json

@@ -0,0 +1,114 @@
+{
+  "no_label_sets_found": "No annotation sets found",
+  "no_label_sets_found_description": "There are no annotation sets in this document.",
+  "no_labels_found": "No labels found",
+  "no_labels_description": "There are no labels in this label set.",
+  "resolution_not_supported": "App not supported on this resolution",
+  "upload_documents": "Upload your own documents",
+  "request_trial": "Request  trial access",
+  "warning_message": "AI can’t be trained if you change the text manually.",
+  "category": "Category",
+  "status": "Status",
+  "preparation": "Preparation",
+  "training": "Training",
+  "test": "Test",
+  "excluded": "Excluded",
+  "set_status": "Set a status",
+  "status_error": "We couldn’t change the status. Please try again later.",
+  "edit": "Edit",
+  "save": "Save",
+  "autosaving": "Auto saving...",
+  "saved": "Saved",
+  "not_saved": "Could not save. Try again",
+  "handover": "Handover",
+  "handover_document": "Handover document",
+  "type_email": "Type an email",
+  "invalid_email": "Please enter a valid email address.",
+  "members": "MEMBERS",
+  "select": "Select",
+  "document_successfully_handed": "Document successfully handed over to",
+  "handover_not_possible": "Handover was not possible. Please try again later.",
+  "small_viewport_title": "Small viewport size",
+  "small_viewport_info": "We’re sorry, but Konfuzio is not optimized to this viewport size. For a better experience, please open it on a bigger viewport.",
+  "ok": "Ok, got it",
+  "no_data_found": "Click to edit...",
+  "draw_box_document": "Find <i>{label_name}</i> in the document",
+  "accuracy": "Accuracy",
+  "not_found_in_document": "Not found in the document",
+  "approved_by": "Approved by",
+  "approved": "Approved",
+  "created_by": "Created by",
+  "edited_by": "Edited by",
+  "edited": "Edited",
+  "created": "Created manually",
+  "not_revised_yet": "Not revised yet",
+  "rotate_pages": "Rotate pages",
+  "rotate_all": "Rotate all",
+  "cancel": "Cancel",
+  "apply": "Apply",
+  "next": "Next",
+  "submit": "Submit",
+  "data_being_extracted": "New data is being extracted",
+  "analysing_document": "We are analysing your document.",
+  "few_minutes": "This might take a few minutes.",
+  "reject_label": "Reject",
+  "rejected": "Rejected",
+  "ann_exists": "An annotation for this label and label set already exists.",
+  "lite_mode": "Read Only",
+  "limited_functionalities": "You are using the Read Only version with limited functionalities.",
+  "accept": "Accept",
+  "split": "Split",
+  "reorder": "Reorder",
+  "rotate": "Rotate",
+  "edit_error": "The changes couldn’t be saved, please try again later.",
+  "overview": "Overview",
+  "select_pages": "You can now rotate pages, reorder and split documents.",
+  "edit_document": "Edit document (Early Access)",
+  "edit_early_access": "You are one of the users who have access to these functionalities before the release date.",
+  "selected": "selected",
+  "rotate_selected": "Rotate selected",
+  "edit_not_available": "Editing is not possible for documents with a status of 'Preparation', 'Training' or 'Test', or documents that are 'Read Only' or 'Reviewed'",
+  "back_to_edit": "Back to edit",
+  "split_document": "Split document",
+  "select_label": "Select Label",
+  "select_annotation_set": "Select Annotation Set",
+  "document_error_title": "Document error",
+  "document_error_info": "We’re sorry, the document ran into a problem and its data can’t be restored.",
+  "contact_support": "Contact support",
+  "finish_review": "Finish review",
+  "review_error": "Something went wrong finishing the review. Please try again later.",
+  "document_reviewed": "Editing is no longer possible since the document has already been reviewed.",
+  "reviewed_mode": "Reviewed",
+  "error_creating_annotation": "The annotation could not be created. Please try again later.",
+  "categorize_document_title": "Categorize the Document",
+  "categorized_as": "This document is currently categorized as",
+  "not_categorized": "This document is currently not categorized. Please select a category before annotating: ",
+  "choose_category": "Choose a category",
+  "select_category": "Select the correct category.",
+  "categorized_error": "If this is not the correct category, please change it and we'll proceed with the re-extraction.",
+  "categorize_document_no_category_description": "Ask the Project Manager to add a description of this Category to know more about this category.",
+  "annotations_pending": "pending",
+  "annotations_accepted": "accepted",
+  "reject_all_empty": "Reject all empty",
+  "no_labels_to_choose": "No Labels",
+  "accept_group": "Accept all",
+  "new_ann_set_title": "New annotation set",
+  "new_ann_set_description": "Select a data model from the existing ones. The new annotation set will contain the same labels.",
+  "select_label_set": "Select label-set model",
+  "new_ann_set_hint": "The new set will only be created in the moment you save your annotation.",
+  "new": "New",
+  "continue": "Continue",
+  "use_your_keyboard": "Use your keyboard",
+  "arrow_keys": "to Navigate",
+  "esc_key": "Exit",
+  "enter_key": "Accept or Save",
+  "delete_key": "Reject",
+  "decline": "Decline",
+  "server_error": "We are currently experiencing a server issue. Please try again later or",
+  "get_support": "Get Support",
+  "no_labels_available": "There are no unfilled or multiple labels in the selected annotation set.",
+  "new_multi_ann_title": "Create multiple annotations",
+  "new_multi_ann_description": "Select a data model from the existing ones, then deselect the labels that don't exist in this document.",
+  "drag_drop_columns_multi_ann": "Drag and drop to change the order of the labels",
+  "error_creating_multi_ann": "Not all annotation sets were created successfully."
+}

package/src/locales/es.json

@@ -0,0 +1,113 @@
+{
+  "no_label_sets_found": "No se han encontrado grupos de etiquetas",
+  "no_label_sets_found_description": "No existen grupos de etiquetas en este documento.",
+  "no_labels_found": "No se han encontrado etiquetas",
+  "no_labels_description": "No existen etiquetas en este grupo.",
+  "resolution_not_supported": "Aplicación no compatible con la resolución de pantalla actual",
+  "upload_documents": "Suba sus propios documentos",
+  "request_trial": "Solicite acceso a la versión de prueba",
+  "warning_message": "La IA no puede ser entrenada si se cambia el texto manualmente.",
+  "category": "Categoría",
+  "status": "Estado",
+  "preparation": "Preparación",
+  "training": "Entrenamiento",
+  "test": "Prueba",
+  "excluded": "Excluído",
+  "set_status": "Establecer estado",
+  "category_error": "La categoría no se puede cambiar porque hay anotaciones que ya han sido aceptadas o creadas manualmente en este documento.",
+  "status_error": "No ha sido posible cambiar el estado del documento. Por favor, inténtelo de nuevo más tarde.",
+  "edit": "Editar",
+  "save": "Guardar",
+  "autosaving": "Auto guardando...",
+  "saved": "Guardado",
+  "not_saved": "No se pudo guardar. Inténtelo de nuevo.",
+  "handover": "Asignar",
+  "handover_document": "Asignar documento",
+  "type_email": "Escriba un correo electrónico",
+  "invalid_email": "Por favor, introduzca un correo electrónico válido",
+  "members": "MIEMBROS",
+  "select": "Seleccionar",
+  "document_successfully_handed": "Documento asignado correctamente a",
+  "handover_not_possible": "La asignación no fue posible.  Por favor, inténtelo de nuevo más tarde.",
+  "small_viewport_title": "Tamaño de ventana demasiado pequeño",
+  "small_viewport_info": "Lo sentimos, pero Konfuzio no está optimizado para este tamaño de ventana. Para una mejor experiencia, por favor ábralo en una ventana más grande.",
+  "ok": "Ok, entendido",
+  "no_data_found": "Click para editar...",
+  "draw_box_document": "Encuentra <i>{label_name}</i> en el documento",
+  "accuracy": "Precisión",
+  "not_found_in_document": "No encontrado en el documento",
+  "approved_by": "Aprobado por",
+  "approved": "Aprobado",
+  "created_by": "Creado por",
+  "edited_by": "Editado por",
+  "edited": "Editado",
+  "created": "Creado manualmente",
+  "not_revised_yet": "No ha sido revisado aún",
+  "rotate_pages": "Rotar páginas",
+  "rotate_all": "Rotar todas",
+  "cancel": "Cancelar",
+  "apply": "Aplicar",
+  "next": "Siguiente",
+  "submit": "Enviar",
+  "data_being_extracted": "Se están extrayendo nuevos datos",
+  "analysing_document": "Estamos analizando el documento.",
+  "few_minutes": "Esto puede tardar unos minutos.",
+  "reject_label": "Rechazar",
+  "rejected": "Rechazadas",
+  "ann_exists": "Ya existe una anotación para esta etiqueta y grupo de etiquetas.",
+  "lite_mode": "Sólo lectura",
+  "limited_functionalities": "Está utilizando la versión de sólo lectura con funcionalidad limitada.",
+  "accept": "Aceptar",
+  "split": "Dividir",
+  "reorder": "Reordenar",
+  "rotate": "Rotar",
+  "edit_error": "No se han podido guardar los cambios, por favor, inténtelo de nuevo más tarde.",
+  "overview": "Vista general",
+  "select_pages": "Ahora puedes rotar, reordenar o dividir los documentos.",
+  "edit_document": "Editar documento (Early Access)",
+  "edit_early_access": "Eres uno de los usuarios que tiene acceso a estas funcionalidades antes de la fecha de lanzamiento.",
+  "selected": "seleccionadas",
+  "rotate_selected": "Rotar seleccionadas",
+  "edit_not_available": "No es posible editar documentos con estado en 'Preparación', 'Entrenamiento' o 'Pruebas', así como documentos que son de 'Sólo Lectura' o 'Revisados'",
+  "back_to_edit": "Volver a editar",
+  "split_document": "Dividir documento",
+  "select_label": "Seleccionar etiqueta",
+  "select_annotation_set": "Seleccionar grupo de etiquetas",
+  "document_error_title": "Error en el documento",
+  "document_error_info": "Lo sentimos, el documento ha sufrido un problema y no se pueden restaurar sus datos.",
+  "contact_support": "Contactar con el soporte",
+  "finish_review": "Finalizar revisión",
+  "review_error": "No ha sido posible finalizar la revisión. Por favor, inténtelo de nuevo más tarde.",
+  "document_reviewed": "No es posible editar el documento si ya ha sido revisado.",
+  "reviewed_mode": "Revisado",
+  "error_creating_annotation": "No ha sido posible crear la anotación. Por favor, inténtelo de nuevo más tarde.",
+  "categorize_document_title": "Categorizar documento",
+  "categorized_as": "Este documento ha sido categorizado como",
+  "not_categorized": "Este documento no ha sido categorizado. Por favor, seleccione una categoría antes de realizar anotaciones: ",
+  "choose_category": "Seleccione una categoría",
+  "select_category": "Seleccione la categoría correcta.",
+  "categorized_error": "Si esta no es la categoría correcta, por favor cámbiela y procederemos a realizar de nuevo la extracción.",
+  "categorize_document_no_category_description": "Solicite a su Gestor de Proyecto que agregue una descripción a esta Categoría para saber más sobre ella.",
+  "annotations_pending": "pendientes",
+  "annotations_accepted": "aceptadas",
+  "reject_all_empty": "Rechazar todas las anotaciones vacías",
+  "no_labels_to_choose": "Sin etiquetas",
+  "accept_group": "Aceptar todas",
+  "use_your_keyboard": "Use su teclado",
+  "arrow_keys": "para Navegar",
+  "esc_key": "Salir del modo de edición",
+  "enter_key": "Aceptar o Guardar",
+  "delete_key": "Rechazar",
+  "decline": "Declinar",
+  "server_error": "Estamos experimentando problemas con el servidor. Por favor, repita la operación o ",
+  "get_support": "Contacte al Soporte",
+  "no_labels_available": "No hay etiquetas vacías o múltiples en el grupo de anotaciones seleccionado.",
+  "new_ann_set_title": "Crear anotaciones múltiples",
+  "new_ann_set_description": "Seleccione un modelo de datos de las opciones disponibles, y luego deseleccione las etiquetas que no existen en este documento.",
+  "select_label_set": "Seleccione un modelo de grupo de etiquetas",
+  "new_ann_set_hint": "El nuevo grupo será creado solo cuando se haya guardado la anotación.",
+  "new": "Nuevo",
+  "continue": "Continuar",
+  "drag_drop_columns_multi_ann": "Arrastre y suelte las columnas para ordenar las etiquetas",
+  "error_creating_multi_ann": "No todos los grupos de anotaciones fueron creados de manera exitosa."
+}

package/src/main.js

@@ -0,0 +1,87 @@
+import Vue from "vue";
+import Buefy from "buefy";
+import "buefy/dist/buefy.css";
+import VueKonva from "vue-konva";
+import App from "./components/App";
+import * as Sentry from "@sentry/vue";
+import { Integrations } from "@sentry/tracing";
+import i18n from "./i18n";
+import store from "./store";
+import { library } from "@fortawesome/fontawesome-svg-core";
+// internal icons
+import {
+  faArrowUp,
+  faAngleRight,
+  faAngleLeft,
+  faAngleUp,
+  faAngleDown,
+  faSpinner,
+  faPlus,
+  faXmark,
+  faEllipsisVertical,
+  faCircleInfo,
+  faArrowRotateLeft,
+  faArrowRotateRight,
+  faScissors,
+  faRepeat,
+  faArrowLeft,
+  faArrowRight,
+} from "@fortawesome/free-solid-svg-icons";
+import { FontAwesomeIcon } from "@fortawesome/vue-fontawesome";
+
+library.add(
+  faArrowUp,
+  faAngleRight,
+  faAngleLeft,
+  faAngleUp,
+  faAngleDown,
+  faSpinner,
+  faXmark,
+  faSpinner,
+  faPlus,
+  faEllipsisVertical,
+  faCircleInfo,
+  faArrowRotateLeft,
+  faArrowRotateRight,
+  faScissors,
+  faRepeat,
+  faArrowLeft,
+  faArrowRight
+);
+Vue.component("VueFontawesome", FontAwesomeIcon);
+Vue.component("App", App);
+Vue.use(VueKonva);
+Vue.use(Buefy, {
+  defaultIconPack: "fas",
+  defaultIconComponent: "vue-fontawesome",
+});
+
+// Sentry config
+if (process.env.NODE_ENV != "development") {
+  Sentry.init({
+    Vue,
+    dsn: process.env.VUE_APP_SENTRY_DSN,
+    integrations: [new Integrations.BrowserTracing()],
+    environment: process.env.VUE_APP_SENTRY_ENVIRONMENT,
+
+    // We recommend adjusting this value in production, or using tracesSampler
+    // for finer control
+    tracesSampleRate: 1.0,
+
+    // If false, errors won't show up in devtools
+    logErrors: true,
+
+    tracingOptions: {
+      trackComponents: true,
+    },
+  });
+}
+
+/**
+ * Main entrypoint for the App
+ */
+new Vue({
+  i18n,
+  store,
+  el: "#app",
+});

package/src/store/category.js

@@ -0,0 +1,193 @@
+import myImports from "../api";
+
+const HTTP = myImports.HTTP;
+
+const state = {
+  documentsInProject: [],
+  documentsAvailableToReview: [], // filtered by user
+  categories: null,
+};
+
+const getters = {
+  /**
+   * Get the category name for a given category ID
+   */
+  categoryName: (state) => (categoryId) => {
+    if (categoryId && state.categories) {
+      return state.categories.find(
+        (tempCategory) => tempCategory.id == categoryId
+      ).name;
+    }
+    return "";
+  },
+
+  /**
+   * Get the category for a given category ID
+   */
+  category: (state) => (categoryId) => {
+    if (categoryId && state.categories) {
+      return state.categories.find(
+        (tempCategory) => tempCategory.id == categoryId
+      );
+    }
+    return null;
+  },
+};
+
+const actions = {
+  setDocumentsInProject: ({ commit }, documents) => {
+    commit("SET_DOCUMENTS_IN_PROJECT", documents);
+  },
+  setDocumentsAvailableToReview: ({ commit }, documentsAvailableToReview) => {
+    commit("SET_AVAILABLE_DOCUMENTS", documentsAvailableToReview);
+  },
+  setCategories: ({ commit }, categories) => {
+    commit("SET_CATEGORIES", categories);
+  },
+  /**
+   * Actions that use HTTP requests always return the axios promise,
+   * so they can be `await`ed (useful to set the `loading` status).
+   */
+  fetchDocumentList: ({ commit, rootState }, categoryId) => {
+    return HTTP.get(
+      `documents/?category=${categoryId}&assignee=${rootState.project.currentUser}`
+    )
+      .then((response) => {
+        if (response.data.results) {
+          commit("SET_DOCUMENTS_IN_PROJECT", response.data.results);
+        }
+      })
+      .catch((error) => {
+        console.log(error, "Could not fetch document list from the backend");
+      });
+  },
+
+  createAvailableDocumentsList: (
+    { commit, state, dispatch, rootGetters },
+    { categoryId, user, poll }
+  ) => {
+    const sleep = (duration) =>
+      new Promise((resolve) => setTimeout(resolve, duration));
+
+    // Poll document data until the status_data is 2
+    // and labeling is available (done)
+    let count = 0;
+    const pollUntilLabelingAvailable = (duration) => {
+      let errors = 0;
+      count += 1;
+
+      return dispatch("fetchDocumentList", categoryId).then(() => {
+        for (let i = 0; i < state.documentsInProject.length; i++) {
+          const found = state.documentsAvailableToReview.find(
+            (doc) => doc.id === state.documentsInProject[i].id
+          );
+
+          if (found) {
+            // If the document is already in the available docs array
+            // we go to the next item
+            continue;
+          } else if (
+            rootGetters["document/isDocumentReadyToBeReviewed"](
+              state.documentsInProject[i]
+            )
+          ) {
+            // add available doc to the end of the array
+            commit("ADD_AVAILABLE_DOCUMENT", state.documentsInProject[i]);
+          } else if (
+            rootGetters["document/documentHadErrorDuringExtraction"](
+              state.documentsInProject[i]
+            )
+          ) {
+            dispatch("document/setDocumentError", true);
+            // If error, add 1
+            // Then go to next item
+            errors += 1;
+            continue;
+          } else {
+            // Some other situation, such as labeling not yet available
+            // go to next item
+            // TODO: we should only poll the documents that are not yet available
+            continue;
+          }
+        }
+        // After looping, check if length of both arrays is different
+        // And if the difference is due to errors or to docs not ready
+        if (
+          poll &&
+          state.documentsInProject.length !==
+            state.documentsAvailableToReview.length &&
+          state.documentsAvailableToReview.length + errors !==
+            state.documentsInProject.length
+        ) {
+          if (count >= 10) return true;
+
+          // We poll the endpoint again
+          return sleep(duration).then(() => {
+            pollUntilLabelingAvailable(duration);
+          });
+        } else {
+          return true;
+        }
+      });
+    };
+
+    // Poll as long as the lengths are different
+    if (
+      state.documentsInProject.length === 0 ||
+      state.documentsInProject.length !==
+        state.documentsAvailableToReview.length
+    ) {
+      let duration;
+      if (count <= 5) {
+        duration = 5000;
+      } else if (count > 10) {
+        duration = 20000;
+      } else {
+        duration = 10000;
+      }
+      pollUntilLabelingAvailable(duration);
+    } else {
+      return;
+    }
+  },
+
+  fetchCategories: ({ commit }, projectId) => {
+    return HTTP.get(`categories/?limit=100&project=${projectId}`)
+      .then(async (response) => {
+        if (response.data && response.data.results) {
+          commit("SET_CATEGORIES", response.data.results);
+        }
+      })
+      .catch((error) => {
+        console.log(error, "Could not fetch categories from the backend");
+      });
+  },
+};
+
+const mutations = {
+  SET_DOCUMENTS_IN_PROJECT: (state, documents) => {
+    state.documentsInProject = documents;
+  },
+  SET_AVAILABLE_DOCUMENTS: (state, documentsAvailableToReview) => {
+    state.documentsAvailableToReview = documentsAvailableToReview;
+  },
+  ADD_AVAILABLE_DOCUMENT: (state, availableDocument) => {
+    const docAlreadyExists = state.documentsAvailableToReview.find(
+      (document) => document.id === availableDocument.id
+    );
+    if (!docAlreadyExists) {
+      state.documentsAvailableToReview.push(availableDocument);
+    }
+  },
+  SET_CATEGORIES: (state, categories) => {
+    state.categories = categories;
+  },
+};
+
+export default {
+  namespaced: true,
+  state,
+  actions,
+  mutations,
+  getters,
+};