@konfuzio/document-validation-ui 0.1.5 → 0.1.6-multi-ann-set-2

package/src/store/display.js

@@ -29,6 +29,8 @@ const state = {
   interactionBlocked: false,
   documentActionBar: null, // document action bar properties
   categorizeModalIsActive: false,
+  pageChangedFromThumbnail: false,
+  showAnnSetTable: null,
 };
 
 const getters = {
@@ -59,6 +61,31 @@ const getters = {
   imageScale: (state) => (page) => {
     return new BigNumber(page.size[0]).div(page.original_size[0]).toNumber();
   },
+  bboxToPoint:
+    (state, getters) =>
+    (page, point, hasOffset = false) => {
+      const imageScale = getters.imageScale(page);
+      const { x, y } = point;
+      const pageHeight = new BigNumber(page.original_size[1]);
+      const newPoint = {
+        // left
+        x: new BigNumber(x)
+          .minus(hasOffset ? 1 : 0)
+          .times(state.scale)
+          .times(imageScale)
+          .div(PIXEL_RATIO)
+          .toNumber(),
+        // top
+        y: pageHeight
+          .minus(new BigNumber(y))
+          .minus(hasOffset ? 17.1 : 0)
+          .times(state.scale)
+          .times(imageScale)
+          .div(PIXEL_RATIO)
+          .toNumber(),
+      };
+      return newPoint;
+    },
   bboxToRect:
     (state, getters) =>
     (page, bbox, hasOffset = false) => {
@@ -206,9 +233,18 @@ const actions = {
       show ? { icon, text, action, loading } : null
     );
   },
+  showAnnSetTable({ commit }, tableSet) {
+    commit("SET_ANN_SET_TABLE", tableSet);
+  },
+  toggleAnnSetTable({ commit }, tableSet) {
+    commit("TOGGLE_ANN_SET_TABLE", tableSet);
+  },
   setCategorizeModalIsActive: ({ commit }, value) => {
     commit("SET_CATEGORIZE_MODAL_IS_ACTIVE", value);
   },
+  setPageChangedFromThumbnail: ({ commit }, value) => {
+    commit("SET_PAGE_CHANGED_FROM_THUMBNAIL", value);
+  },
 };
 
 const mutations = {
@@ -232,9 +268,24 @@ const mutations = {
     state.documentActionBar = actionBar;
   },
 
+  SET_ANN_SET_TABLE: (state, tableSet) => {
+    state.showAnnSetTable = tableSet;
+  },
+
+  TOGGLE_ANN_SET_TABLE: (state, tableSet) => {
+    if (state.showAnnSetTable) {
+      state.showAnnSetTable = null;
+    } else {
+      state.showAnnSetTable = tableSet;
+    }
+  },
+
   SET_CATEGORIZE_MODAL_IS_ACTIVE: (state, value) => {
     state.categorizeModalIsActive = value;
   },
+  SET_PAGE_CHANGED_FROM_THUMBNAIL: (state, value) => {
+    state.pageChangedFromThumbnail = value;
+  },
 };
 
 export default {

package/src/store/document.js

@@ -3,6 +3,7 @@ import { sleep } from "../utils/utils";
 
 const HTTP = myImports.HTTP;
 const documentPollDuration = 1000;
+export const table_reference_api = "api.v3.dvui.table";
 
 const state = {
   loading: true,
@@ -21,13 +22,15 @@ const state = {
   showActionError: false,
   errorMessage: null,
   showDocumentError: false,
-  rejectedMissingAnnotations: null,
+  annotationsMarkedAsMissing: null,
   errorMessageWidth: null,
   hoveredAnnotationSet: null,
   finishedReview: false,
   newAcceptedAnnotations: null,
   selectedEntities: null,
   serverError: false,
+  splittingSuggestions: null,
+  documentIsReviewed: false,
 };
 
 const getters = {
@@ -157,6 +160,78 @@ const getters = {
     return state.annotationSets.find((annSet) => annSet.id === annotationSetId);
   },
 
+  /* Get annotation sets created in table */
+  annotationSetsInTable: (state) => () => {
+    const annotationSetsList = {};
+    state.annotationSets.forEach((annotationSet) => {
+      let addAnnotationSet = false;
+      if (annotationSet.labels) {
+        annotationSet.labels.forEach((label) => {
+          if (
+            label.annotations &&
+            label.annotations.find(
+              (annotation) =>
+                annotation.origin && annotation.origin === table_reference_api
+            )
+          ) {
+            addAnnotationSet = true;
+            return;
+          }
+        });
+      }
+      if (addAnnotationSet) {
+        // group by label set
+        if (annotationSetsList[`${annotationSet.label_set.id}`]) {
+          annotationSetsList[`${annotationSet.label_set.id}`].push(
+            annotationSet
+          );
+        } else {
+          annotationSetsList[`${annotationSet.label_set.id}`] = [annotationSet];
+        }
+      }
+    });
+    return annotationSetsList;
+  },
+
+  /* Get annotation sets without tables */
+  annotationSetsToShowInList: (state) => () => {
+    const annotationSetsList = [];
+    state.annotationSets.forEach((annotationSet) => {
+      let addAnnotationSet = true;
+      if (annotationSet.labels) {
+        annotationSet.labels.forEach((label) => {
+          if (
+            label.annotations &&
+            label.annotations.find(
+              (annotation) =>
+                annotation.origin && annotation.origin === table_reference_api
+            )
+          ) {
+            addAnnotationSet = false;
+            return;
+          }
+        });
+      }
+      if (addAnnotationSet) {
+        annotationSetsList.push(annotationSet);
+      }
+    });
+    return annotationSetsList;
+  },
+
+  /* Get annotations inside a list of annotation sets */
+  annotationsInAnnotationsSets: (state) => (annotationsSets) => {
+    const annotations = [];
+    annotationsSets.forEach((annotationSet) => {
+      annotationSet.labels.forEach((label) => {
+        label.annotations.forEach((annotation) => {
+          annotations.push(annotation);
+        });
+      });
+    });
+    return annotations;
+  },
+
   /* Process annotations and extract labels and sets */
   processAnnotationSets: (state, getters) => (annotationSets) => {
     // group annotations for sidebar
@@ -228,6 +303,7 @@ const getters = {
       });
       return found ? `${value + 1}` : "";
     }
+    return "";
   },
 
   /**
@@ -308,6 +384,27 @@ const getters = {
     return pendingEmpty.length;
   },
 
+  annotationIsNotFound: (state) => (annotationSet, label) => {
+    // Check if the combined label and label set have been marked as missing
+    // or if the document is in public mode
+    if (state.missingAnnotations.length === 0) {
+      return false;
+    } else {
+      const found = state.missingAnnotations.filter(
+        (el) =>
+          el.label === label.id &&
+          el.annotation_set === annotationSet.id &&
+          el.label_set === annotationSet.label_set.id
+      );
+
+      if (found.length !== 0) {
+        return true;
+      } else {
+        return false;
+      }
+    }
+  },
+
   // Check if document is ready to be finished
   isDocumentReviewFinished: (state) => () => {
     // check if all annotations have been revised
@@ -335,7 +432,7 @@ const getters = {
 
     // if all annotations have been revised
     // and if there are no empty annotations or
-    // all empty annotations were rejected,
+    // all empty annotations were marked as missing,
     // we can finish the review
     if (
       !emptyAnnotations ||
@@ -419,6 +516,20 @@ const getters = {
     }
   },
 
+  /**
+   * If automatic splitting is enabled for the project
+   */
+  waitingForSplittingConfirmation: () => (document) => {
+    return document && document.status_data === 41;
+  },
+
+  /**
+   * Show the Smart Split switch or not
+   */
+  documentHasProposedSplit: () => (document) => {
+    return document.proposed_split && document.proposed_split.length > 0;
+  },
+
   /**
    * Joins all strings in a multi-entity Annotation array
    * to look like a single string
@@ -445,7 +556,7 @@ const getters = {
   /**
    * Check status of annotation
    */
-  notFound: () => (annotation) => {
+  notExtracted: () => (annotation) => {
     if (annotation) {
       return !annotation.span;
     } else {
@@ -574,8 +685,8 @@ const actions = {
   setDocumentError: ({ commit }, value) => {
     commit("SET_DOCUMENT_ERROR", value);
   },
-  setRejectedMissingAnnotations: ({ commit }, annotations) => {
-    commit("SET_REJECTED_MISSING_ANNOTATIONS", annotations);
+  setAnnotationsMarkedAsMissing: ({ commit }, annotations) => {
+    commit("SET_ANNOTATIONS_MARKED_AS_MISSING", annotations);
   },
   setErrorMessageWidth: ({ commit }, width) => {
     commit("SET_ERROR_MESSAGE_WIDTH", width);
@@ -589,6 +700,12 @@ const actions = {
   setSelectedEntities: ({ commit }, entities) => {
     commit("SET_SELECTED_ENTITIES", entities);
   },
+  setSplittingSuggestions: ({ commit }, value) => {
+    commit("SET_SPLITTING_SUGGESTIONS", value);
+  },
+  setDocumentIsReviewed: ({ commit }, value) => {
+    commit("SET_DOCUMENT_IS_REVIEWED", value);
+  },
 
   /**
    * Actions that use HTTP requests always return the axios promise,
@@ -619,11 +736,13 @@ const actions = {
           if (response.data.pages.length > 0) {
             dispatch("fetchDocumentPage", initialPage);
           }
+
           // set information on the store
           commit("SET_ANNOTATION_SETS", annotationSets);
           commit("SET_ANNOTATIONS", annotations);
           commit("SET_LABELS", labels);
           commit("SET_SELECTED_DOCUMENT", response.data);
+          commit("SET_DOCUMENT_IS_REVIEWED", response.data.is_reviewed);
           commit("SET_FINISHED_REVIEW", getters.isDocumentReviewFinished());
 
           if (rootState.project.projectId) {
@@ -635,6 +754,10 @@ const actions = {
             });
           }
 
+          if (getters.documentHasProposedSplit(response.data)) {
+            commit("SET_SPLITTING_SUGGESTIONS", response.data.proposed_split);
+          }
+
           categoryId = response.data.category;
           // TODO: add this validation to a method
           isRecalculatingAnnotations = response.data.labeling_available !== 1;
@@ -698,7 +821,7 @@ const actions = {
       id: annotation.id,
       span,
       page: span.page_index + 1,
-      labelName: label.name,
+      labelName: label ? label.name : "",
     };
     commit("SET_DOCUMENT_ANNOTATION_SELECTED", value);
   },
@@ -716,7 +839,7 @@ const actions = {
       HTTP.post(`/annotations/`, annotation)
         .then(async (response) => {
           if (response.status === 201) {
-            dispatch("fetchMissingAnnotations");
+            await dispatch("fetchMissingAnnotations");
             commit("SET_FINISHED_REVIEW", getters.isDocumentReviewFinished());
 
             if (!getters.annotationSetExists(response.data.annotation_set)) {
@@ -827,13 +950,14 @@ const actions = {
     });
   },
 
-  addMissingAnnotations: ({ commit, dispatch }, missingAnnotations) => {
+  addMissingAnnotations: ({ commit, getters }, missingAnnotations) => {
     return new Promise((resolve, reject) => {
-      return HTTP.post(`/missing-annotations/`, missingAnnotations)
-        .then((response) => {
+      HTTP.post(`/missing-annotations/`, missingAnnotations)
+        .then(async (response) => {
           if (response.status === 201) {
-            commit("SET_REJECTED_MISSING_ANNOTATIONS", null);
-            dispatch("fetchMissingAnnotations");
+            commit("SET_ANNOTATIONS_MARKED_AS_MISSING", null);
+            commit("ADD_MISSING_ANNOTATIONS", response.data);
+            commit("SET_FINISHED_REVIEW", getters.isDocumentReviewFinished());
           }
 
           resolve(response);
@@ -845,12 +969,13 @@ const actions = {
     });
   },
 
-  deleteMissingAnnotation: ({ commit, getters, dispatch }, id) => {
+  deleteMissingAnnotation: ({ commit, getters }, id) => {
     return new Promise((resolve, reject) => {
       return HTTP.delete(`/missing-annotations/${id}/`)
         .then((response) => {
           if (response.status === 204) {
-            dispatch("fetchMissingAnnotations");
+            commit("DELETE_MISSING_ANNOTATION", id);
+            commit("SET_FINISHED_REVIEW", getters.isDocumentReviewFinished());
             resolve(true);
           }
         })
@@ -891,8 +1016,11 @@ const actions = {
         `documents/${state.documentId}/?fields=status_data,labeling_available`
       )
         .then((response) => {
-          if (getters.isDocumentReadyToBeReviewed(response.data)) {
-            // ready
+          if (
+            getters.isDocumentReadyToBeReviewed(response.data) ||
+            getters.waitingForSplittingConfirmation(response.data)
+          ) {
+            // ready or has splitting suggestions
             return resolve(true);
           } else if (getters.documentHadErrorDuringExtraction(response.data)) {
             // error
@@ -1029,11 +1157,21 @@ const mutations = {
           (existingAnnotation) => existingAnnotation.id === annotation.id
         );
         if (indexOfAnnotationAnnotationSets > -1) {
-          label.annotations.splice(
-            indexOfAnnotationAnnotationSets,
-            1,
-            annotation
-          );
+          // checks if an annotation label was changed and add it to the new label
+          if (annotation.label && annotation.label.id !== label.id) {
+            label.annotations.splice(indexOfAnnotationAnnotationSets, 1);
+
+            const labelToAdd = annotationSet.labels.find(
+              (labelToAdd) => labelToAdd.id === annotation.label.id
+            );
+            labelToAdd.annotations.push(annotation);
+          } else {
+            label.annotations.splice(
+              indexOfAnnotationAnnotationSets,
+              1,
+              annotation
+            );
+          }
           updatedAnnotation = true;
           return;
         }
@@ -1110,7 +1248,7 @@ const mutations = {
   },
   SET_SELECTED_DOCUMENT: (state, document) => {
     if (document.is_reviewed === true) {
-      state.publicView = true;
+      state.documentIsReviewed = true;
     }
     state.selectedDocument = document;
 
@@ -1123,7 +1261,20 @@ const mutations = {
   SET_MISSING_ANNOTATIONS: (state, missingAnnotations) => {
     state.missingAnnotations = missingAnnotations;
   },
+  ADD_MISSING_ANNOTATIONS: (state, missingAnnotations) => {
+    missingAnnotations.map((annotation) => {
+      state.missingAnnotations.push(annotation);
+    });
+  },
+  DELETE_MISSING_ANNOTATION: (state, id) => {
+    const indexOfAnnotationToDelete = state.missingAnnotations.findIndex(
+      (annotation) => annotation.id === id
+    );
 
+    if (indexOfAnnotationToDelete > -1) {
+      state.missingAnnotations.splice(indexOfAnnotationToDelete, 1);
+    }
+  },
   SET_SHOW_ACTION_ERROR: (state, value) => {
     state.showActionError = value;
   },
@@ -1133,8 +1284,8 @@ const mutations = {
   SET_DOCUMENT_ERROR: (state, value) => {
     state.showDocumentError = value;
   },
-  SET_REJECTED_MISSING_ANNOTATIONS: (state, annotations) => {
-    state.rejectedMissingAnnotations = annotations;
+  SET_ANNOTATIONS_MARKED_AS_MISSING: (state, annotations) => {
+    state.annotationsMarkedAsMissing = annotations;
   },
   SET_ERROR_MESSAGE_WIDTH: (state, width) => {
     state.errorMessageWidth = width;
@@ -1164,6 +1315,12 @@ const mutations = {
   UPDATE_FILE_NAME: (state, value) => {
     state.selectedDocument.data_file_name = value;
   },
+  SET_SPLITTING_SUGGESTIONS: (state, array) => {
+    state.splittingSuggestions = array;
+  },
+  SET_DOCUMENT_IS_REVIEWED: (state, value) => {
+    state.documentIsReviewed = value;
+  },
 };
 
 export default {

package/src/store/edit.js

@@ -1,4 +1,9 @@
 import myImports from "../api";
+import {
+  getURLQueryParam,
+  navigateToNewDocumentURL,
+  getURLPath,
+} from "../utils/utils";
 
 const HTTP = myImports.HTTP;
 
@@ -6,9 +11,10 @@ const state = {
   editMode: false,
   splitOverview: false,
   isMultipleSelection: false,
-  documentPagesListForEditMode: [], // TODO: change name
+  pagesForPostprocess: [],
   selectedPages: [],
   updatedDocument: [],
+  showEditConfirmationModal: false,
 };
 
 const actions = {
@@ -25,8 +31,8 @@ const actions = {
     commit("SET_SPLIT_OVERVIEW", overview);
   },
 
-  setDocumentPagesListForEditMode: ({ commit }, pages) => {
-    commit("SET_DOCUMENT_PAGES_FOR_EDIT_MODE", pages);
+  setPagesForPostprocess: ({ commit }, pages) => {
+    commit("SET_PAGES_FOR_POSTPROCESS", pages);
   },
 
   setUpdatedDocument: ({ commit }, updatedDocument) => {
@@ -57,42 +63,41 @@ const actions = {
   },
 
   rotatePage: ({ state, commit }, { page, direction }) => {
-    if (state.documentPagesListForEditMode.find((p) => p.id === page[0].id)) {
-      const documentPagesListForEditMode =
-        state.documentPagesListForEditMode.map((p) => {
-          let rotatedAngle;
-          if (direction === "left") {
-            rotatedAngle = p.angle - 90;
-            if (p.id === page[0].id) {
-              if (rotatedAngle === -270) {
-                rotatedAngle = 90;
-              }
-              return {
-                ...p,
-                angle: rotatedAngle,
-              };
+    if (state.pagesForPostprocess.find((p) => p.id === page[0].id)) {
+      const pagesForPostprocess = state.pagesForPostprocess.map((p) => {
+        let rotatedAngle;
+        if (direction === "left") {
+          rotatedAngle = p.angle - 90;
+          if (p.id === page[0].id) {
+            if (rotatedAngle === -270) {
+              rotatedAngle = 90;
             }
-            return p;
+            return {
+              ...p,
+              angle: rotatedAngle,
+            };
           }
-          if (direction === "right") {
-            rotatedAngle = p.angle + 90;
-            if (p.id === page[0].id) {
-              if (rotatedAngle === 270) {
-                rotatedAngle = -90;
-              }
-              return {
-                ...p,
-                angle: rotatedAngle,
-              };
+          return p;
+        }
+        if (direction === "right") {
+          rotatedAngle = p.angle + 90;
+          if (p.id === page[0].id) {
+            if (rotatedAngle === 270) {
+              rotatedAngle = -90;
             }
-            return p;
+            return {
+              ...p,
+              angle: rotatedAngle,
+            };
           }
-        });
+          return p;
+        }
+      });
 
-      commit("SET_DOCUMENT_PAGES_FOR_EDIT_MODE", documentPagesListForEditMode);
+      commit("SET_PAGES_FOR_POSTPROCESS", pagesForPostprocess);
     } else {
       if (direction === "left") {
-        state.documentPagesListForEditMode.push({
+        state.pagesForPostprocess.push({
           id: page.id,
           number: page.number,
           angle: -90,
@@ -102,7 +107,7 @@ const actions = {
       }
 
       if (direction === "right") {
-        state.documentPagesListForEditMode.push({
+        state.pagesForPostprocess.push({
           id: page.id,
           number: page.number,
           angle: 90,
@@ -115,7 +120,7 @@ const actions = {
 
   updateRotationToTheLeft: ({ state, commit }) => {
     // updated the angles that will be sent to the backend
-    const array = state.documentPagesListForEditMode.map((p) => {
+    const array = state.pagesForPostprocess.map((p) => {
       let rotatedAngle = p.angle - 90;
       if (rotatedAngle === -270) {
         rotatedAngle = 90;
@@ -126,12 +131,12 @@ const actions = {
       };
     });
 
-    commit("SET_DOCUMENT_PAGES_FOR_EDIT_MODE", array);
+    commit("SET_PAGES_FOR_POSTPROCESS", array);
   },
 
   updateRotationToTheRight: ({ state, commit }) => {
     // updated the angles that will be sent to the backend
-    const array = state.documentPagesListForEditMode.map((p) => {
+    const array = state.pagesForPostprocess.map((p) => {
       let rotatedAngle = p.angle + 90;
       if (rotatedAngle === 270) {
         rotatedAngle = -90;
@@ -142,13 +147,16 @@ const actions = {
       };
     });
 
-    commit("SET_DOCUMENT_PAGES_FOR_EDIT_MODE", array);
+    commit("SET_PAGES_FOR_POSTPROCESS", array);
   },
 
   editDocument: ({ rootState, dispatch }, editedDocument) => {
     dispatch("document/startRecalculatingAnnotations", null, {
       root: true,
     });
+
+    const oldId = rootState.document.documentId;
+
     return new Promise((resolve, reject) => {
       HTTP.post(
         `/documents/${rootState.document.documentId}/postprocess/`,
@@ -156,15 +164,23 @@ const actions = {
       )
         .then(async (response) => {
           if (response && response.status === 200) {
-            const newDocument = response.data[0];
-            const newId = newDocument.id;
-
-            await dispatch("document/setDocId", newId, {
-              root: true,
-            });
-            dispatch("document/pollDocumentEndpoint", null, {
-              root: true,
-            });
+            const newId = response.data[0].id;
+            dispatch("document/setSplittingSuggestions", null, { root: true });
+
+            if (newId !== oldId) {
+              if (getURLQueryParam("document") || getURLPath("docs")) {
+                navigateToNewDocumentURL(oldId, newId);
+              } else {
+                await dispatch("document/setDocId", newId, {
+                  root: true,
+                });
+
+                dispatch("document/pollDocumentEndpoint", null, {
+                  root: true,
+                });
+              }
+            }
+
             resolve(null);
           } else {
             resolve(response);
@@ -176,6 +192,10 @@ const actions = {
         });
     });
   },
+
+  setShowEditConfirmationModal: ({ commit }, value) => {
+    commit("SET_SHOW_EDIT_CONFIRMATION_MODAL", value);
+  },
 };
 
 const mutations = {
@@ -187,8 +207,8 @@ const mutations = {
     state.splitOverview = overview;
   },
 
-  SET_DOCUMENT_PAGES_FOR_EDIT_MODE: (state, pages) => {
-    state.documentPagesListForEditMode = pages;
+  SET_PAGES_FOR_POSTPROCESS: (state, pages) => {
+    state.pagesForPostprocess = pages;
   },
 
   SET_UPDATED_DOCUMENT: (state, updatedDocument) => {
@@ -200,6 +220,9 @@ const mutations = {
   ADD_SELECTED_PAGE: (state, selectedPage) => {
     state.selectedPages.push(selectedPage);
   },
+  SET_SHOW_EDIT_CONFIRMATION_MODAL: (state, value) => {
+    state.showEditConfirmationModal = value;
+  },
 };
 
 export default {