@konfuzio/document-validation-ui 0.1.19 → 0.1.20-dev.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (143) hide show
  1. package/.eslintrc.js +10 -10
  2. package/.prettierrc.json +1 -1
  3. package/LICENSE +21 -21
  4. package/README.md +24 -24
  5. package/cypress.config.js +13 -13
  6. package/dist/js/app.js +1 -1
  7. package/dist/js/app.js.map +1 -1
  8. package/dist/js/chunk-vendors.js +1 -1
  9. package/dist/js/chunk-vendors.js.map +1 -1
  10. package/jest.config.js +4 -4
  11. package/package.json +66 -66
  12. package/src/api.js +82 -82
  13. package/src/assets/images/AcceptedCheckMark.vue +8 -8
  14. package/src/assets/images/AcceptedUser.vue +8 -8
  15. package/src/assets/images/ActionIcon.vue +60 -60
  16. package/src/assets/images/ArrowDownKey.vue +11 -11
  17. package/src/assets/images/ArrowUpKey.vue +11 -11
  18. package/src/assets/images/CategoryIconImg.vue +13 -13
  19. package/src/assets/images/CheckMark.vue +8 -8
  20. package/src/assets/images/DraggableIcon.vue +14 -14
  21. package/src/assets/images/EditDocIcon.vue +12 -12
  22. package/src/assets/images/EmptyStateImg.vue +129 -129
  23. package/src/assets/images/ErrorIcon.vue +28 -28
  24. package/src/assets/images/EyeIcon.vue +11 -11
  25. package/src/assets/images/FileNameNotSavedImage.vue +26 -26
  26. package/src/assets/images/FileNameSavedImage.vue +14 -14
  27. package/src/assets/images/FitZoomIcon.vue +16 -16
  28. package/src/assets/images/GridIcon.vue +16 -16
  29. package/src/assets/images/KeyboardIcon.vue +16 -16
  30. package/src/assets/images/MagicWandIcon.vue +16 -16
  31. package/src/assets/images/MinusIcon.vue +13 -13
  32. package/src/assets/images/NotFoundIcon.vue +16 -16
  33. package/src/assets/images/NotOptimizedIllustration.vue +651 -651
  34. package/src/assets/images/PlusIcon.vue +13 -13
  35. package/src/assets/images/QuestionMark.vue +12 -12
  36. package/src/assets/images/ServerImage.vue +73 -73
  37. package/src/assets/images/SettingsIcon.vue +14 -14
  38. package/src/assets/images/SplitLines.vue +18 -18
  39. package/src/assets/images/SplitZigZag.vue +49 -49
  40. package/src/assets/images/StarIcon.vue +16 -16
  41. package/src/assets/images/StatusImg.vue +14 -14
  42. package/src/assets/images/TranslateArrows.vue +33 -33
  43. package/src/assets/scss/ann_set_table_options.scss +26 -26
  44. package/src/assets/scss/annotation_details.scss +141 -141
  45. package/src/assets/scss/choose_label_set_modal.scss +65 -65
  46. package/src/assets/scss/document_action_bar.scss +37 -37
  47. package/src/assets/scss/document_annotations.scss +558 -558
  48. package/src/assets/scss/document_category.scss +85 -85
  49. package/src/assets/scss/document_dashboard.scss +52 -52
  50. package/src/assets/scss/document_edit.scss +410 -410
  51. package/src/assets/scss/document_error.scss +81 -81
  52. package/src/assets/scss/document_name.scss +60 -60
  53. package/src/assets/scss/document_page.scss +12 -12
  54. package/src/assets/scss/document_thumbnails.scss +41 -41
  55. package/src/assets/scss/document_toolbar.scss +111 -111
  56. package/src/assets/scss/document_top_bar.scss +171 -171
  57. package/src/assets/scss/document_viewport_modal.scss +25 -25
  58. package/src/assets/scss/documents_list.scss +141 -141
  59. package/src/assets/scss/edit_page_thumbnail.scss +53 -53
  60. package/src/assets/scss/empty_state.scss +34 -34
  61. package/src/assets/scss/extracting_data.scss +35 -35
  62. package/src/assets/scss/imports.scss +1 -1
  63. package/src/assets/scss/multi_ann_table_overlay.scss +38 -38
  64. package/src/assets/scss/multi_ann_table_popup.scss +12 -12
  65. package/src/assets/scss/new_annotation.scss +102 -102
  66. package/src/assets/scss/scrolling_document.scss +19 -19
  67. package/src/assets/scss/theme.scss +801 -801
  68. package/src/assets/scss/variables.scss +66 -66
  69. package/src/components/App.cy.js +7 -7
  70. package/src/components/App.vue +187 -187
  71. package/src/components/DocumentAnnotations/AnnotationActionButtons.vue +152 -152
  72. package/src/components/DocumentAnnotations/AnnotationContent.vue +210 -210
  73. package/src/components/DocumentAnnotations/AnnotationDetails.vue +251 -251
  74. package/src/components/DocumentAnnotations/AnnotationRow.vue +752 -752
  75. package/src/components/DocumentAnnotations/AnnotationSetActionButtons.vue +89 -89
  76. package/src/components/DocumentAnnotations/ChooseLabelSetModal.vue +186 -186
  77. package/src/components/DocumentAnnotations/DocumentAnnotations.cy.js +441 -441
  78. package/src/components/DocumentAnnotations/DocumentAnnotations.vue +534 -534
  79. package/src/components/DocumentAnnotations/DocumentLabel.vue +189 -189
  80. package/src/components/DocumentAnnotations/EmptyAnnotation.vue +193 -193
  81. package/src/components/DocumentAnnotations/EmptyState.vue +21 -21
  82. package/src/components/DocumentAnnotations/ExtractingData.vue +41 -41
  83. package/src/components/DocumentAnnotations/LoadingAnnotations.vue +43 -43
  84. package/src/components/DocumentAnnotations/LoadingLabels.vue +43 -43
  85. package/src/components/DocumentAnnotations/MultiAnnotationTableOverlay.vue +338 -338
  86. package/src/components/DocumentAnnotations/index.js +8 -8
  87. package/src/components/DocumentCategory.vue +281 -281
  88. package/src/components/DocumentDashboard.vue +170 -170
  89. package/src/components/DocumentEdit/DocumentEdit.cy.js +541 -541
  90. package/src/components/DocumentEdit/DocumentEdit.vue +503 -503
  91. package/src/components/DocumentEdit/EditConfirmationModal.vue +55 -55
  92. package/src/components/DocumentEdit/EditPageThumbnail.vue +114 -114
  93. package/src/components/DocumentEdit/EditPages.vue +161 -161
  94. package/src/components/DocumentEdit/EditSidebar.vue +154 -154
  95. package/src/components/DocumentEdit/RenameAndCategorize.vue +184 -184
  96. package/src/components/DocumentEdit/SidebarButtons.vue +53 -53
  97. package/src/components/DocumentEdit/SplitInfoBar.vue +21 -21
  98. package/src/components/DocumentEdit/index.js +4 -4
  99. package/src/components/DocumentModals/DocumentErrorModal.vue +58 -58
  100. package/src/components/DocumentModals/NotOptimizedViewportModal.vue +51 -51
  101. package/src/components/DocumentPage/ActionBar.vue +48 -48
  102. package/src/components/DocumentPage/AnnSetTableOptions.vue +111 -111
  103. package/src/components/DocumentPage/BoxSelection.vue +152 -152
  104. package/src/components/DocumentPage/DocumentPage.cy.js +92 -92
  105. package/src/components/DocumentPage/DocumentPage.vue +568 -568
  106. package/src/components/DocumentPage/DocumentToolbar.cy.js +215 -215
  107. package/src/components/DocumentPage/DocumentToolbar.vue +228 -228
  108. package/src/components/DocumentPage/DummyPage.vue +55 -55
  109. package/src/components/DocumentPage/MultiAnnSelection.vue +371 -371
  110. package/src/components/DocumentPage/NewAnnotation.vue +308 -308
  111. package/src/components/DocumentPage/ScrollingDocument.vue +149 -149
  112. package/src/components/DocumentPage/ScrollingPage.vue +179 -179
  113. package/src/components/DocumentPage/index.js +5 -5
  114. package/src/components/DocumentThumbnails/DocumentThumbnails.cy.js +67 -67
  115. package/src/components/DocumentThumbnails/DocumentThumbnails.vue +132 -132
  116. package/src/components/DocumentThumbnails/LoadingThumbnail.vue +25 -25
  117. package/src/components/DocumentThumbnails/index.js +1 -1
  118. package/src/components/DocumentTopBar/DocumentName.vue +236 -236
  119. package/src/components/DocumentTopBar/DocumentTopBar.cy.js +222 -222
  120. package/src/components/DocumentTopBar/DocumentTopBar.vue +202 -202
  121. package/src/components/DocumentTopBar/DocumentTopBarButtons.vue +183 -183
  122. package/src/components/DocumentTopBar/KeyboardActionsDescription.vue +74 -74
  123. package/src/components/DocumentTopBar/index.js +3 -3
  124. package/src/components/DocumentsList/DocumentsList.vue +121 -121
  125. package/src/components/DocumentsList/index.js +1 -1
  126. package/src/components/ErrorMessage.vue +40 -40
  127. package/src/components/index.js +1 -1
  128. package/src/constants.js +5 -5
  129. package/src/directives/scroll.js +28 -28
  130. package/src/i18n.js +22 -22
  131. package/src/icons.js +45 -45
  132. package/src/locales/de.json +148 -148
  133. package/src/locales/en.json +148 -148
  134. package/src/main.js +26 -26
  135. package/src/store/category.js +191 -191
  136. package/src/store/display.js +311 -311
  137. package/src/store/document.js +1438 -1438
  138. package/src/store/edit.js +316 -316
  139. package/src/store/index.js +21 -21
  140. package/src/store/project.js +143 -143
  141. package/src/store/selection.js +210 -210
  142. package/src/utils/utils.js +54 -54
  143. package/vue.config.js +25 -25
@@ -1,202 +1,202 @@
1
- <template>
2
- <div id="document-top-bar-component" ref="documentTopBar">
3
- <div
4
- v-if="selectedDocument && selectedDocument.pages.length > 0 && !loading"
5
- :class="['document-top-bar', editMode && 'edit-mode-top-bar']"
6
- >
7
- <div v-if="!recalculatingAnnotations" class="left-bar-components">
8
- <DocumentCategory
9
- v-if="categories && !editMode && !publicView && !isDocumentReviewed"
10
- />
11
- </div>
12
-
13
- <div
14
- :class="[
15
- 'center-bar-components',
16
- recalculatingAnnotations && 'single-component',
17
- ]"
18
- >
19
- <div
20
- v-if="previousDocument"
21
- class="left-arrow navigation-arrow"
22
- type="button"
23
- @click="navigateToDocument(previousDocument)"
24
- >
25
- <b-icon icon="angle-left" size="is-small" />
26
- </div>
27
-
28
- <DocumentName :data-file-name="selectedDocument.data_file_name" />
29
-
30
- <div
31
- v-if="nextDocument"
32
- class="right-arrow navigation-arrow"
33
- type="button"
34
- @click="navigateToDocument(nextDocument)"
35
- >
36
- <b-icon icon="angle-right" size="is-small" />
37
- </div>
38
- </div>
39
-
40
- <div v-if="!recalculatingAnnotations" class="right-bar-components">
41
- <div
42
- v-if="!editMode && (!publicView || !isDocumentReviewed)"
43
- class="keyboard-actions-info"
44
- >
45
- <KeyboardActionsDescription />
46
- </div>
47
-
48
- <div
49
- v-if="!editMode && (publicView || isDocumentReviewed)"
50
- class="read-only-info"
51
- >
52
- <b-tooltip
53
- :animated="false"
54
- position="is-bottom"
55
- class="right-aligned width-184"
56
- >
57
- <span v-if="publicView">
58
- {{ $t("lite_mode") }}
59
- </span>
60
- <span v-else class="doc-reviewed">
61
- {{ $t("reviewed_mode") }}
62
- </span>
63
- <b-icon
64
- :class="[
65
- 'info-icon is-small',
66
- !publicView && isDocumentReviewed && 'info-reviewed',
67
- ]"
68
- icon="circle-info"
69
- />
70
- <template #content>
71
- <div v-if="publicView" class="read-only-details">
72
- {{ $t("limited_functionalities") }}
73
- </div>
74
- <div v-else class="read-only-details">
75
- {{ $t("document_reviewed") }}
76
- </div>
77
- </template>
78
- </b-tooltip>
79
- </div>
80
-
81
- <div class="top-bar-buttons">
82
- <DocumentTopBarButtons />
83
- </div>
84
- </div>
85
- </div>
86
- <div v-else class="loading-top-bar">
87
- <b-skeleton position="is-centered" width="25%" height="60%" />
88
- </div>
89
- </div>
90
- </template>
91
-
92
- <script>
93
- import { mapGetters, mapState } from "vuex";
94
- import DocumentCategory from "../../components/DocumentCategory";
95
- import DocumentName from "./DocumentName";
96
- import DocumentTopBarButtons from "./DocumentTopBarButtons";
97
- import KeyboardActionsDescription from "./KeyboardActionsDescription";
98
-
99
- /**
100
- * This component has different functionalities
101
- * based on Dashboard View or Edit Mode
102
- */
103
-
104
- export default {
105
- name: "DocumentTopBar",
106
- components: {
107
- DocumentCategory,
108
- DocumentName,
109
- DocumentTopBarButtons,
110
- KeyboardActionsDescription,
111
- },
112
- data() {
113
- return {
114
- categoryError: false,
115
- previousDocument: null,
116
- nextDocument: null,
117
- };
118
- },
119
- computed: {
120
- ...mapState("document", [
121
- "selectedDocument",
122
- "publicView",
123
- "loading",
124
- "recalculatingAnnotations",
125
- ]),
126
- ...mapState("category", ["categories"]),
127
- ...mapState("edit", ["editMode"]),
128
- ...mapState("project", ["documentsInProject"]),
129
- ...mapGetters("document", [
130
- "isDocumentReviewed",
131
- "isDocumentReadyToBeReviewed",
132
- "waitingForSplittingConfirmation",
133
- ]),
134
- },
135
- watch: {
136
- documentsInProject(newValue) {
137
- if (newValue && this.selectedDocument) {
138
- this.getPreviousAndNextDocuments();
139
- }
140
- },
141
- },
142
- created() {
143
- window.addEventListener("resize", this.handleResize);
144
- },
145
- destroyed() {
146
- window.removeEventListener("resize", this.handleResize);
147
- },
148
- mounted() {
149
- if (this.$refs.documentTopBar) {
150
- this.setComponentWidth(this.$refs.documentTopBar.offsetWidth);
151
- }
152
- },
153
- methods: {
154
- setComponentWidth(width) {
155
- // set width for the error messages to match the width
156
- // and avoid going over the Dashboard
157
- this.$store.dispatch("document/setErrorMessageWidth", width);
158
- },
159
- handleResize() {
160
- this.setComponentWidth(this.$refs.documentTopBar.offsetWidth);
161
- },
162
- getPreviousAndNextDocuments() {
163
- // Only consider documents who have a status of "ready"
164
- const filteredDocuments = this.documentsInProject.filter(
165
- (document) =>
166
- this.isDocumentReadyToBeReviewed(document) ||
167
- this.waitingForSplittingConfirmation(document)
168
- );
169
-
170
- if (!filteredDocuments) return;
171
-
172
- const found = filteredDocuments.find(
173
- (document) => document.id === this.selectedDocument.id
174
- );
175
-
176
- const indexOfCurrentDocument = filteredDocuments.indexOf(found);
177
-
178
- if (!(indexOfCurrentDocument < 0)) {
179
- this.previousDocument = filteredDocuments[indexOfCurrentDocument - 1];
180
- this.nextDocument = filteredDocuments[indexOfCurrentDocument + 1];
181
- } else {
182
- this.previousDocument = filteredDocuments[0];
183
- this.nextDocument = filteredDocuments[1];
184
- }
185
- },
186
- navigateToDocument(document) {
187
- if (!document) return;
188
-
189
- this.$store.dispatch("document/changeCurrentDocument", document.id);
190
-
191
- if (this.editMode) {
192
- // Reset edit mode when changing the document,
193
- // in case the change was made from the arrows in the Edit Mode
194
- // so that the user does not get stuck in this interface
195
- this.$store.dispatch("edit/disableEditMode");
196
- }
197
- },
198
- },
199
- };
200
- </script>
201
-
202
- <style scoped lang="scss" src="../../assets/scss/document_top_bar.scss"></style>
1
+ <template>
2
+ <div id="document-top-bar-component" ref="documentTopBar">
3
+ <div
4
+ v-if="selectedDocument && selectedDocument.pages.length > 0 && !loading"
5
+ :class="['document-top-bar', editMode && 'edit-mode-top-bar']"
6
+ >
7
+ <div v-if="!recalculatingAnnotations" class="left-bar-components">
8
+ <DocumentCategory
9
+ v-if="categories && !editMode && !publicView && !isDocumentReviewed"
10
+ />
11
+ </div>
12
+
13
+ <div
14
+ :class="[
15
+ 'center-bar-components',
16
+ recalculatingAnnotations && 'single-component',
17
+ ]"
18
+ >
19
+ <div
20
+ v-if="previousDocument"
21
+ class="left-arrow navigation-arrow"
22
+ type="button"
23
+ @click="navigateToDocument(previousDocument)"
24
+ >
25
+ <b-icon icon="angle-left" size="is-small" />
26
+ </div>
27
+
28
+ <DocumentName :data-file-name="selectedDocument.data_file_name" />
29
+
30
+ <div
31
+ v-if="nextDocument"
32
+ class="right-arrow navigation-arrow"
33
+ type="button"
34
+ @click="navigateToDocument(nextDocument)"
35
+ >
36
+ <b-icon icon="angle-right" size="is-small" />
37
+ </div>
38
+ </div>
39
+
40
+ <div v-if="!recalculatingAnnotations" class="right-bar-components">
41
+ <div
42
+ v-if="!editMode && (!publicView || !isDocumentReviewed)"
43
+ class="keyboard-actions-info"
44
+ >
45
+ <KeyboardActionsDescription />
46
+ </div>
47
+
48
+ <div
49
+ v-if="!editMode && (publicView || isDocumentReviewed)"
50
+ class="read-only-info"
51
+ >
52
+ <b-tooltip
53
+ :animated="false"
54
+ position="is-bottom"
55
+ class="right-aligned width-184"
56
+ >
57
+ <span v-if="publicView">
58
+ {{ $t("lite_mode") }}
59
+ </span>
60
+ <span v-else class="doc-reviewed">
61
+ {{ $t("reviewed_mode") }}
62
+ </span>
63
+ <b-icon
64
+ :class="[
65
+ 'info-icon is-small',
66
+ !publicView && isDocumentReviewed && 'info-reviewed',
67
+ ]"
68
+ icon="circle-info"
69
+ />
70
+ <template #content>
71
+ <div v-if="publicView" class="read-only-details">
72
+ {{ $t("limited_functionalities") }}
73
+ </div>
74
+ <div v-else class="read-only-details">
75
+ {{ $t("document_reviewed") }}
76
+ </div>
77
+ </template>
78
+ </b-tooltip>
79
+ </div>
80
+
81
+ <div class="top-bar-buttons">
82
+ <DocumentTopBarButtons />
83
+ </div>
84
+ </div>
85
+ </div>
86
+ <div v-else class="loading-top-bar">
87
+ <b-skeleton position="is-centered" width="25%" height="60%" />
88
+ </div>
89
+ </div>
90
+ </template>
91
+
92
+ <script>
93
+ import { mapGetters, mapState } from "vuex";
94
+ import DocumentCategory from "../../components/DocumentCategory";
95
+ import DocumentName from "./DocumentName";
96
+ import DocumentTopBarButtons from "./DocumentTopBarButtons";
97
+ import KeyboardActionsDescription from "./KeyboardActionsDescription";
98
+
99
+ /**
100
+ * This component has different functionalities
101
+ * based on Dashboard View or Edit Mode
102
+ */
103
+
104
+ export default {
105
+ name: "DocumentTopBar",
106
+ components: {
107
+ DocumentCategory,
108
+ DocumentName,
109
+ DocumentTopBarButtons,
110
+ KeyboardActionsDescription,
111
+ },
112
+ data() {
113
+ return {
114
+ categoryError: false,
115
+ previousDocument: null,
116
+ nextDocument: null,
117
+ };
118
+ },
119
+ computed: {
120
+ ...mapState("document", [
121
+ "selectedDocument",
122
+ "publicView",
123
+ "loading",
124
+ "recalculatingAnnotations",
125
+ ]),
126
+ ...mapState("category", ["categories"]),
127
+ ...mapState("edit", ["editMode"]),
128
+ ...mapState("project", ["documentsInProject"]),
129
+ ...mapGetters("document", [
130
+ "isDocumentReviewed",
131
+ "isDocumentReadyToBeReviewed",
132
+ "waitingForSplittingConfirmation",
133
+ ]),
134
+ },
135
+ watch: {
136
+ documentsInProject(newValue) {
137
+ if (newValue && this.selectedDocument) {
138
+ this.getPreviousAndNextDocuments();
139
+ }
140
+ },
141
+ },
142
+ created() {
143
+ window.addEventListener("resize", this.handleResize);
144
+ },
145
+ destroyed() {
146
+ window.removeEventListener("resize", this.handleResize);
147
+ },
148
+ mounted() {
149
+ if (this.$refs.documentTopBar) {
150
+ this.setComponentWidth(this.$refs.documentTopBar.offsetWidth);
151
+ }
152
+ },
153
+ methods: {
154
+ setComponentWidth(width) {
155
+ // set width for the error messages to match the width
156
+ // and avoid going over the Dashboard
157
+ this.$store.dispatch("document/setErrorMessageWidth", width);
158
+ },
159
+ handleResize() {
160
+ this.setComponentWidth(this.$refs.documentTopBar.offsetWidth);
161
+ },
162
+ getPreviousAndNextDocuments() {
163
+ // Only consider documents who have a status of "ready"
164
+ const filteredDocuments = this.documentsInProject.filter(
165
+ (document) =>
166
+ this.isDocumentReadyToBeReviewed(document) ||
167
+ this.waitingForSplittingConfirmation(document)
168
+ );
169
+
170
+ if (!filteredDocuments) return;
171
+
172
+ const found = filteredDocuments.find(
173
+ (document) => document.id === this.selectedDocument.id
174
+ );
175
+
176
+ const indexOfCurrentDocument = filteredDocuments.indexOf(found);
177
+
178
+ if (!(indexOfCurrentDocument < 0)) {
179
+ this.previousDocument = filteredDocuments[indexOfCurrentDocument - 1];
180
+ this.nextDocument = filteredDocuments[indexOfCurrentDocument + 1];
181
+ } else {
182
+ this.previousDocument = filteredDocuments[0];
183
+ this.nextDocument = filteredDocuments[1];
184
+ }
185
+ },
186
+ navigateToDocument(document) {
187
+ if (!document) return;
188
+
189
+ this.$store.dispatch("document/changeCurrentDocument", document.id);
190
+
191
+ if (this.editMode) {
192
+ // Reset edit mode when changing the document,
193
+ // in case the change was made from the arrows in the Edit Mode
194
+ // so that the user does not get stuck in this interface
195
+ this.$store.dispatch("edit/disableEditMode");
196
+ }
197
+ },
198
+ },
199
+ };
200
+ </script>
201
+
202
+ <style scoped lang="scss" src="../../assets/scss/document_top_bar.scss"></style>