@konfuzio/document-validation-ui 0.1.19-dev.1 → 0.1.19

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 (145) 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/css/app.css +1 -1
  7. package/dist/index.html +1 -1
  8. package/dist/js/app.js +1 -1
  9. package/dist/js/app.js.map +1 -1
  10. package/dist/js/chunk-vendors.js +1 -1
  11. package/dist/js/chunk-vendors.js.map +1 -1
  12. package/jest.config.js +4 -4
  13. package/package.json +66 -66
  14. package/src/api.js +82 -82
  15. package/src/assets/images/AcceptedCheckMark.vue +8 -8
  16. package/src/assets/images/AcceptedUser.vue +8 -8
  17. package/src/assets/images/ActionIcon.vue +60 -60
  18. package/src/assets/images/ArrowDownKey.vue +11 -11
  19. package/src/assets/images/ArrowUpKey.vue +11 -11
  20. package/src/assets/images/CategoryIconImg.vue +13 -13
  21. package/src/assets/images/CheckMark.vue +8 -8
  22. package/src/assets/images/DraggableIcon.vue +14 -14
  23. package/src/assets/images/EditDocIcon.vue +12 -12
  24. package/src/assets/images/EmptyStateImg.vue +129 -129
  25. package/src/assets/images/ErrorIcon.vue +28 -28
  26. package/src/assets/images/EyeIcon.vue +11 -11
  27. package/src/assets/images/FileNameNotSavedImage.vue +26 -26
  28. package/src/assets/images/FileNameSavedImage.vue +14 -14
  29. package/src/assets/images/FitZoomIcon.vue +16 -16
  30. package/src/assets/images/GridIcon.vue +16 -16
  31. package/src/assets/images/KeyboardIcon.vue +16 -16
  32. package/src/assets/images/MagicWandIcon.vue +16 -16
  33. package/src/assets/images/MinusIcon.vue +13 -13
  34. package/src/assets/images/NotFoundIcon.vue +16 -16
  35. package/src/assets/images/NotOptimizedIllustration.vue +651 -651
  36. package/src/assets/images/PlusIcon.vue +13 -13
  37. package/src/assets/images/QuestionMark.vue +12 -12
  38. package/src/assets/images/ServerImage.vue +73 -73
  39. package/src/assets/images/SettingsIcon.vue +14 -14
  40. package/src/assets/images/SplitLines.vue +18 -18
  41. package/src/assets/images/SplitZigZag.vue +49 -49
  42. package/src/assets/images/StarIcon.vue +16 -16
  43. package/src/assets/images/StatusImg.vue +14 -14
  44. package/src/assets/images/TranslateArrows.vue +33 -33
  45. package/src/assets/scss/ann_set_table_options.scss +26 -26
  46. package/src/assets/scss/annotation_details.scss +141 -141
  47. package/src/assets/scss/choose_label_set_modal.scss +65 -65
  48. package/src/assets/scss/document_action_bar.scss +37 -37
  49. package/src/assets/scss/document_annotations.scss +558 -537
  50. package/src/assets/scss/document_category.scss +85 -85
  51. package/src/assets/scss/document_dashboard.scss +52 -52
  52. package/src/assets/scss/document_edit.scss +410 -410
  53. package/src/assets/scss/document_error.scss +81 -81
  54. package/src/assets/scss/document_name.scss +60 -60
  55. package/src/assets/scss/document_page.scss +12 -12
  56. package/src/assets/scss/document_thumbnails.scss +41 -41
  57. package/src/assets/scss/document_toolbar.scss +111 -111
  58. package/src/assets/scss/document_top_bar.scss +171 -171
  59. package/src/assets/scss/document_viewport_modal.scss +25 -25
  60. package/src/assets/scss/documents_list.scss +141 -141
  61. package/src/assets/scss/edit_page_thumbnail.scss +53 -53
  62. package/src/assets/scss/empty_state.scss +34 -34
  63. package/src/assets/scss/extracting_data.scss +35 -35
  64. package/src/assets/scss/imports.scss +1 -1
  65. package/src/assets/scss/multi_ann_table_overlay.scss +38 -38
  66. package/src/assets/scss/multi_ann_table_popup.scss +12 -12
  67. package/src/assets/scss/new_annotation.scss +102 -102
  68. package/src/assets/scss/scrolling_document.scss +19 -19
  69. package/src/assets/scss/theme.scss +801 -801
  70. package/src/assets/scss/variables.scss +66 -66
  71. package/src/components/App.cy.js +7 -7
  72. package/src/components/App.vue +187 -187
  73. package/src/components/DocumentAnnotations/AnnotationActionButtons.vue +152 -168
  74. package/src/components/DocumentAnnotations/AnnotationContent.vue +210 -210
  75. package/src/components/DocumentAnnotations/AnnotationDetails.vue +251 -251
  76. package/src/components/DocumentAnnotations/AnnotationRow.vue +752 -752
  77. package/src/components/DocumentAnnotations/AnnotationSetActionButtons.vue +89 -89
  78. package/src/components/DocumentAnnotations/ChooseLabelSetModal.vue +186 -186
  79. package/src/components/DocumentAnnotations/DocumentAnnotations.cy.js +441 -441
  80. package/src/components/DocumentAnnotations/DocumentAnnotations.vue +534 -534
  81. package/src/components/DocumentAnnotations/DocumentLabel.vue +189 -189
  82. package/src/components/DocumentAnnotations/EmptyAnnotation.vue +193 -193
  83. package/src/components/DocumentAnnotations/EmptyState.vue +21 -21
  84. package/src/components/DocumentAnnotations/ExtractingData.vue +41 -41
  85. package/src/components/DocumentAnnotations/LoadingAnnotations.vue +43 -43
  86. package/src/components/DocumentAnnotations/LoadingLabels.vue +43 -43
  87. package/src/components/DocumentAnnotations/MultiAnnotationTableOverlay.vue +338 -338
  88. package/src/components/DocumentAnnotations/index.js +8 -8
  89. package/src/components/DocumentCategory.vue +281 -281
  90. package/src/components/DocumentDashboard.vue +170 -170
  91. package/src/components/DocumentEdit/DocumentEdit.cy.js +541 -541
  92. package/src/components/DocumentEdit/DocumentEdit.vue +503 -503
  93. package/src/components/DocumentEdit/EditConfirmationModal.vue +55 -55
  94. package/src/components/DocumentEdit/EditPageThumbnail.vue +114 -114
  95. package/src/components/DocumentEdit/EditPages.vue +161 -161
  96. package/src/components/DocumentEdit/EditSidebar.vue +154 -154
  97. package/src/components/DocumentEdit/RenameAndCategorize.vue +184 -184
  98. package/src/components/DocumentEdit/SidebarButtons.vue +53 -53
  99. package/src/components/DocumentEdit/SplitInfoBar.vue +21 -21
  100. package/src/components/DocumentEdit/index.js +4 -4
  101. package/src/components/DocumentModals/DocumentErrorModal.vue +58 -58
  102. package/src/components/DocumentModals/NotOptimizedViewportModal.vue +51 -51
  103. package/src/components/DocumentPage/ActionBar.vue +48 -48
  104. package/src/components/DocumentPage/AnnSetTableOptions.vue +111 -111
  105. package/src/components/DocumentPage/BoxSelection.vue +152 -152
  106. package/src/components/DocumentPage/DocumentPage.cy.js +92 -92
  107. package/src/components/DocumentPage/DocumentPage.vue +568 -568
  108. package/src/components/DocumentPage/DocumentToolbar.cy.js +215 -215
  109. package/src/components/DocumentPage/DocumentToolbar.vue +228 -228
  110. package/src/components/DocumentPage/DummyPage.vue +55 -55
  111. package/src/components/DocumentPage/MultiAnnSelection.vue +371 -371
  112. package/src/components/DocumentPage/NewAnnotation.vue +308 -308
  113. package/src/components/DocumentPage/ScrollingDocument.vue +149 -149
  114. package/src/components/DocumentPage/ScrollingPage.vue +179 -179
  115. package/src/components/DocumentPage/index.js +5 -5
  116. package/src/components/DocumentThumbnails/DocumentThumbnails.cy.js +67 -67
  117. package/src/components/DocumentThumbnails/DocumentThumbnails.vue +132 -132
  118. package/src/components/DocumentThumbnails/LoadingThumbnail.vue +25 -25
  119. package/src/components/DocumentThumbnails/index.js +1 -1
  120. package/src/components/DocumentTopBar/DocumentName.vue +236 -236
  121. package/src/components/DocumentTopBar/DocumentTopBar.cy.js +222 -222
  122. package/src/components/DocumentTopBar/DocumentTopBar.vue +202 -202
  123. package/src/components/DocumentTopBar/DocumentTopBarButtons.vue +183 -183
  124. package/src/components/DocumentTopBar/KeyboardActionsDescription.vue +74 -74
  125. package/src/components/DocumentTopBar/index.js +3 -3
  126. package/src/components/DocumentsList/DocumentsList.vue +121 -121
  127. package/src/components/DocumentsList/index.js +1 -1
  128. package/src/components/ErrorMessage.vue +40 -40
  129. package/src/components/index.js +1 -1
  130. package/src/constants.js +5 -5
  131. package/src/directives/scroll.js +28 -28
  132. package/src/i18n.js +22 -22
  133. package/src/icons.js +45 -45
  134. package/src/locales/de.json +148 -148
  135. package/src/locales/en.json +148 -148
  136. package/src/main.js +26 -26
  137. package/src/store/category.js +191 -191
  138. package/src/store/display.js +311 -311
  139. package/src/store/document.js +1438 -1438
  140. package/src/store/edit.js +316 -316
  141. package/src/store/index.js +21 -21
  142. package/src/store/project.js +143 -143
  143. package/src/store/selection.js +210 -210
  144. package/src/utils/utils.js +54 -54
  145. package/vue.config.js +25 -25
@@ -1,210 +1,210 @@
1
- <template>
2
- <div :id="annotation.id" ref="annotation" class="annotation">
3
- <span
4
- :id="annotation.id"
5
- ref="contentEditable"
6
- :class="[
7
- 'annotation-value',
8
- 'keyboard-nav',
9
- isLoading && 'saving-changes',
10
- showActionError &&
11
- editAnnotation &&
12
- editAnnotation.id === annotation.id &&
13
- 'error-editing',
14
- isAnnotationBeingEdited && 'clicked-ann'
15
- ]"
16
- role="textbox"
17
- :contenteditable="isAnnotationBeingEdited"
18
- @click="handleEditAnnotation"
19
- @paste="handlePaste"
20
- @keypress.enter="saveAnnotationChanges"
21
- >
22
- {{ span.offset_string }}
23
- </span>
24
- </div>
25
- </template>
26
-
27
- <script>
28
- import { mapGetters, mapState } from "vuex";
29
- import { isElementArray } from "../../utils/utils";
30
-
31
- /**
32
- * This component is responsible for managing filled annotations.
33
- */
34
- export default {
35
- name: "AnnotationContent",
36
- props: {
37
- annotation: {
38
- type: Object,
39
- required: true,
40
- },
41
- span: {
42
- type: [Object, Array],
43
- required: true,
44
- },
45
- spanIndex: {
46
- type: Number,
47
- required: true,
48
- },
49
- label: {
50
- type: Object,
51
- required: true,
52
- },
53
- annotationSet: {
54
- type: Object,
55
- required: true,
56
- },
57
- },
58
- data() {
59
- return {
60
- isLoading: false,
61
- };
62
- },
63
- computed: {
64
- ...mapGetters("document", [
65
- "isAnnotationInEditMode",
66
- "pageAtIndex",
67
- "isDocumentReviewed",
68
- ]),
69
- ...mapGetters("display", ["bboxToRect"]),
70
- ...mapState("document", [
71
- "editAnnotation",
72
- "publicView",
73
- "annotations",
74
- "newAcceptedAnnotations",
75
- "showActionError",
76
- ]),
77
- isAnnotationBeingEdited() {
78
- return this.isAnnotationInEditMode(this.annotation.id, this.spanIndex);
79
- },
80
- },
81
-
82
- watch: {
83
- isAnnotationBeingEdited(newState, oldState) {
84
- // verify if new annotation in edit mode is not this one and if this
85
- // one was selected before so we set the state to the previous one (like a cancel)
86
- if (!newState && oldState) {
87
- this.handleCancel();
88
- }
89
- },
90
- span() {
91
- // span content changed, ex. from click on entity
92
- this.setText(this.span.offset_string);
93
- },
94
- },
95
-
96
- methods: {
97
- setText(text) {
98
- this.$refs.contentEditable.textContent = text;
99
- },
100
- getAnnotationText() {
101
- return this.$refs.contentEditable.textContent.trim();
102
- },
103
- handleEditAnnotation(event) {
104
- if (this.publicView || this.isDocumentReviewed) return;
105
-
106
- if (event) {
107
- event.preventDefault();
108
- }
109
-
110
- if (
111
- !this.publicView &&
112
- !this.isDocumentReviewed &&
113
- !this.isAnnotationBeingEdited &&
114
- !this.isLoading
115
- ) {
116
- this.$store.dispatch("selection/selectElement", this.annotation.id);
117
-
118
- this.$store
119
- .dispatch("document/setEditAnnotation", {
120
- id: this.annotation.id,
121
- index: this.spanIndex,
122
- label: this.label.id,
123
- labelSet: this.annotationSet.label_set.id,
124
- annotationSet: this.annotationSet.id,
125
- })
126
- .then(() => {
127
- this.$refs.contentEditable.focus();
128
- })
129
- .catch((error) => {
130
- console.log(error);
131
- });
132
-
133
- const page = this.pageAtIndex(this.span.page_index);
134
- if (page) {
135
- const { x, y, width, height } = this.bboxToRect(page, this.span);
136
-
137
- const selection = {
138
- start: {
139
- x,
140
- y,
141
- },
142
- end: {
143
- x: x + width,
144
- y: y + height,
145
- },
146
- pageNumber: page.number,
147
- custom: false,
148
- };
149
-
150
- this.$store.dispatch("selection/setSelection", {
151
- selection,
152
- span: this.span,
153
- });
154
- }
155
- }
156
- },
157
- handleCancel() {
158
- this.setText(this.span.offset_string);
159
- this.isLoading = false;
160
- if (this.$refs.contentEditable) {
161
- this.$refs.contentEditable.blur();
162
- }
163
-
164
- this.$store.dispatch("selection/setSelectedEntities", null);
165
- },
166
- handlePaste(event) {
167
- // TODO: modify to only paste plain text
168
- event.preventDefault();
169
- },
170
- saveAnnotationChanges(event) {
171
- if (this.publicView || this.isDocumentReviewed) return;
172
-
173
- if (event) {
174
- event.preventDefault();
175
- }
176
-
177
- // Validate if we are declining an Annotation that is not multi-lined
178
- // by deleting the content instead of clicking the 'decline' button
179
- let isToDecline =
180
- this.getAnnotationText().length === 0 &&
181
- (!isElementArray(this.annotation.span) ||
182
- this.annotation.span.length === 1);
183
-
184
- // API call handled in parent component - AnnotationRow
185
- this.$emit("save-annotation-changes", isToDecline);
186
- },
187
- createSpan() {
188
- const annotationText = this.getAnnotationText();
189
- if (!annotationText) return;
190
-
191
- return {
192
- offset_string: annotationText,
193
- page_index: this.span.page_index,
194
- x0: this.span.x0,
195
- x1: this.span.x1,
196
- y0: this.span.y0,
197
- y1: this.span.y1,
198
- start_offset: this.span.start_offset,
199
- end_offset: this.span.end_offset,
200
- };
201
- },
202
- },
203
- };
204
- </script>
205
-
206
- <style
207
- scoped
208
- lang="scss"
209
- src="../../assets/scss/document_annotations.scss"
210
- ></style>
1
+ <template>
2
+ <div :id="annotation.id" ref="annotation" class="annotation">
3
+ <span
4
+ :id="annotation.id"
5
+ ref="contentEditable"
6
+ :class="[
7
+ 'annotation-value',
8
+ 'keyboard-nav',
9
+ isLoading && 'saving-changes',
10
+ showActionError &&
11
+ editAnnotation &&
12
+ editAnnotation.id === annotation.id &&
13
+ 'error-editing',
14
+ isAnnotationBeingEdited && 'clicked-ann'
15
+ ]"
16
+ role="textbox"
17
+ :contenteditable="isAnnotationBeingEdited"
18
+ @click="handleEditAnnotation"
19
+ @paste="handlePaste"
20
+ @keypress.enter="saveAnnotationChanges"
21
+ >
22
+ {{ span.offset_string }}
23
+ </span>
24
+ </div>
25
+ </template>
26
+
27
+ <script>
28
+ import { mapGetters, mapState } from "vuex";
29
+ import { isElementArray } from "../../utils/utils";
30
+
31
+ /**
32
+ * This component is responsible for managing filled annotations.
33
+ */
34
+ export default {
35
+ name: "AnnotationContent",
36
+ props: {
37
+ annotation: {
38
+ type: Object,
39
+ required: true,
40
+ },
41
+ span: {
42
+ type: [Object, Array],
43
+ required: true,
44
+ },
45
+ spanIndex: {
46
+ type: Number,
47
+ required: true,
48
+ },
49
+ label: {
50
+ type: Object,
51
+ required: true,
52
+ },
53
+ annotationSet: {
54
+ type: Object,
55
+ required: true,
56
+ },
57
+ },
58
+ data() {
59
+ return {
60
+ isLoading: false,
61
+ };
62
+ },
63
+ computed: {
64
+ ...mapGetters("document", [
65
+ "isAnnotationInEditMode",
66
+ "pageAtIndex",
67
+ "isDocumentReviewed",
68
+ ]),
69
+ ...mapGetters("display", ["bboxToRect"]),
70
+ ...mapState("document", [
71
+ "editAnnotation",
72
+ "publicView",
73
+ "annotations",
74
+ "newAcceptedAnnotations",
75
+ "showActionError",
76
+ ]),
77
+ isAnnotationBeingEdited() {
78
+ return this.isAnnotationInEditMode(this.annotation.id, this.spanIndex);
79
+ },
80
+ },
81
+
82
+ watch: {
83
+ isAnnotationBeingEdited(newState, oldState) {
84
+ // verify if new annotation in edit mode is not this one and if this
85
+ // one was selected before so we set the state to the previous one (like a cancel)
86
+ if (!newState && oldState) {
87
+ this.handleCancel();
88
+ }
89
+ },
90
+ span() {
91
+ // span content changed, ex. from click on entity
92
+ this.setText(this.span.offset_string);
93
+ },
94
+ },
95
+
96
+ methods: {
97
+ setText(text) {
98
+ this.$refs.contentEditable.textContent = text;
99
+ },
100
+ getAnnotationText() {
101
+ return this.$refs.contentEditable.textContent.trim();
102
+ },
103
+ handleEditAnnotation(event) {
104
+ if (this.publicView || this.isDocumentReviewed) return;
105
+
106
+ if (event) {
107
+ event.preventDefault();
108
+ }
109
+
110
+ if (
111
+ !this.publicView &&
112
+ !this.isDocumentReviewed &&
113
+ !this.isAnnotationBeingEdited &&
114
+ !this.isLoading
115
+ ) {
116
+ this.$store.dispatch("selection/selectElement", this.annotation.id);
117
+
118
+ this.$store
119
+ .dispatch("document/setEditAnnotation", {
120
+ id: this.annotation.id,
121
+ index: this.spanIndex,
122
+ label: this.label.id,
123
+ labelSet: this.annotationSet.label_set.id,
124
+ annotationSet: this.annotationSet.id,
125
+ })
126
+ .then(() => {
127
+ this.$refs.contentEditable.focus();
128
+ })
129
+ .catch((error) => {
130
+ console.log(error);
131
+ });
132
+
133
+ const page = this.pageAtIndex(this.span.page_index);
134
+ if (page) {
135
+ const { x, y, width, height } = this.bboxToRect(page, this.span);
136
+
137
+ const selection = {
138
+ start: {
139
+ x,
140
+ y,
141
+ },
142
+ end: {
143
+ x: x + width,
144
+ y: y + height,
145
+ },
146
+ pageNumber: page.number,
147
+ custom: false,
148
+ };
149
+
150
+ this.$store.dispatch("selection/setSelection", {
151
+ selection,
152
+ span: this.span,
153
+ });
154
+ }
155
+ }
156
+ },
157
+ handleCancel() {
158
+ this.setText(this.span.offset_string);
159
+ this.isLoading = false;
160
+ if (this.$refs.contentEditable) {
161
+ this.$refs.contentEditable.blur();
162
+ }
163
+
164
+ this.$store.dispatch("selection/setSelectedEntities", null);
165
+ },
166
+ handlePaste(event) {
167
+ // TODO: modify to only paste plain text
168
+ event.preventDefault();
169
+ },
170
+ saveAnnotationChanges(event) {
171
+ if (this.publicView || this.isDocumentReviewed) return;
172
+
173
+ if (event) {
174
+ event.preventDefault();
175
+ }
176
+
177
+ // Validate if we are declining an Annotation that is not multi-lined
178
+ // by deleting the content instead of clicking the 'decline' button
179
+ let isToDecline =
180
+ this.getAnnotationText().length === 0 &&
181
+ (!isElementArray(this.annotation.span) ||
182
+ this.annotation.span.length === 1);
183
+
184
+ // API call handled in parent component - AnnotationRow
185
+ this.$emit("save-annotation-changes", isToDecline);
186
+ },
187
+ createSpan() {
188
+ const annotationText = this.getAnnotationText();
189
+ if (!annotationText) return;
190
+
191
+ return {
192
+ offset_string: annotationText,
193
+ page_index: this.span.page_index,
194
+ x0: this.span.x0,
195
+ x1: this.span.x1,
196
+ y0: this.span.y0,
197
+ y1: this.span.y1,
198
+ start_offset: this.span.start_offset,
199
+ end_offset: this.span.end_offset,
200
+ };
201
+ },
202
+ },
203
+ };
204
+ </script>
205
+
206
+ <style
207
+ scoped
208
+ lang="scss"
209
+ src="../../assets/scss/document_annotations.scss"
210
+ ></style>