mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2026-11-19 20:25:21 +00:00
Compare commits
171
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4e2bda3a35 | ||
|
|
14252054a1 | ||
|
|
61c8eec856 | ||
|
|
409539d4d1 | ||
|
|
c1bb327f1f | ||
|
|
0e6d06c255 | ||
|
|
acf7ba346c | ||
|
|
63a87dd11b | ||
|
|
1f41e63af1 | ||
|
|
dc16714e19 | ||
|
|
044da9a627 | ||
|
|
093c18e68b | ||
|
|
d706904a18 | ||
|
|
1c6742723f | ||
|
|
e03faab730 | ||
|
|
9ff48ecfce | ||
|
|
65fdfcdea7 | ||
|
|
bb78373ad1 | ||
|
|
73e0390a84 | ||
|
|
6009027bf7 | ||
|
|
17cdcda76b | ||
|
|
88d0f30c1a | ||
|
|
e3904fe376 | ||
|
|
9d5c7abfaa | ||
|
|
1c685eb85a | ||
|
|
44bbfd8932 | ||
|
|
4788ac602b | ||
|
|
0c90c57e3e | ||
|
|
bcfdfcaa29 | ||
|
|
35b0439195 | ||
|
|
f21f6b9795 | ||
|
|
855b161407 | ||
|
|
3153b118bd | ||
|
|
7977093e83 | ||
|
|
237521ec4b | ||
|
|
0596579d4b | ||
|
|
a22579e311 | ||
|
|
199d1a88e9 | ||
|
|
f68c093097 | ||
|
|
b5d6009e15 | ||
|
|
c3fa454ffa | ||
|
|
bfd0d7fe36 | ||
|
|
48c7a11195 | ||
|
|
9ba98d1cb3 | ||
|
|
de75249e51 | ||
|
|
28bb63824f | ||
|
|
64bf7f8457 | ||
|
|
c177c13acf | ||
|
|
4610171a94 | ||
|
|
cf2e2bde71 | ||
|
|
aa669aca89 | ||
|
|
b42bf50b7e | ||
|
|
d31110278b | ||
|
|
5d98a5e5c8 | ||
|
|
fc8c4e91ec | ||
|
|
e746e008a0 | ||
|
|
897f6a9e5a | ||
|
|
694619c33e | ||
|
|
1f2faaec86 | ||
|
|
30e95a6d28 | ||
|
|
6b15d625ed | ||
|
|
8c50a5ee7b | ||
|
|
b63ea77543 | ||
|
|
bfd5628dcc | ||
|
|
3dbeca603e | ||
|
|
62d729e301 | ||
|
|
886761a53b | ||
|
|
198b165f26 | ||
|
|
e63f27a712 | ||
|
|
3ce5f8bc69 | ||
|
|
58cdd4f19a | ||
|
|
5c8c0db08f | ||
|
|
5c28d8282d | ||
|
|
aede2e6a5a | ||
|
|
fa792d33c2 | ||
|
|
ade5901a4d | ||
|
|
2b620a2823 | ||
|
|
45b8977623 | ||
|
|
800748d5ab | ||
|
|
182b0b4712 | ||
|
|
c718636f79 | ||
|
|
54f7f43f35 | ||
|
|
94da3d4c57 | ||
|
|
453e89d6dd | ||
|
|
6562415894 | ||
|
|
257c33453d | ||
|
|
87913411ef | ||
|
|
cec393dcae | ||
|
|
f5526d5700 | ||
|
|
2534d3c16b | ||
|
|
95c8bf2058 | ||
|
|
930d23956b | ||
|
|
d2e6834602 | ||
|
|
a7bf04ddee | ||
|
|
8ab2bf63aa | ||
|
|
c63a7e25e7 | ||
|
|
9171a1aa6a | ||
|
|
55c5d9121f | ||
|
|
e4efb62667 | ||
|
|
f0597a7c54 | ||
|
|
bbdc016a32 | ||
|
|
eae392469f | ||
|
|
bedefd85f2 | ||
|
|
bd73fe1e80 | ||
|
|
8b77a924dc | ||
|
|
1bdeb7ebcd | ||
|
|
fa3acfe13f | ||
|
|
2bc22b14bd | ||
|
|
dbce8c1409 | ||
|
|
e976b2ec7a | ||
|
|
05da0ba5a3 | ||
|
|
4ff2cb9c72 | ||
|
|
77a7fb40ec | ||
|
|
8100a8e1eb | ||
|
|
1e334903f3 | ||
|
|
a958d89bf4 | ||
|
|
8b3295fce0 | ||
|
|
9783c4995f | ||
|
|
e89495dc02 | ||
|
|
8bb2f88015 | ||
|
|
7d9b8c770d | ||
|
|
3296fd7cb5 | ||
|
|
bff41907c2 | ||
|
|
592f882394 | ||
|
|
29ea9cec66 | ||
|
|
123df2e826 | ||
|
|
639827ec65 | ||
|
|
b3106e408c | ||
|
|
ea31b6a043 | ||
|
|
0572b54579 | ||
|
|
2afec3e0b7 | ||
|
|
57019bccbe | ||
|
|
26b3964a20 | ||
|
|
a2eeadca7f | ||
|
|
ba5474ba81 | ||
|
|
e3592804bd | ||
|
|
2d54927be8 | ||
|
|
1d2832ac30 | ||
|
|
3321ba46d6 | ||
|
|
bf316cba8a | ||
|
|
36c31b3a73 | ||
|
|
d10d303980 | ||
|
|
a51e6a71f4 | ||
|
|
ebd8dba3bb | ||
|
|
3ed9586347 | ||
|
|
7055f7a745 | ||
|
|
8f7500ba64 | ||
|
|
816774815c | ||
|
|
c5e6748771 | ||
|
|
9b42170554 | ||
|
|
d2ed0c55a4 | ||
|
|
4d31063082 | ||
|
|
a4fb9bf2b0 | ||
|
|
e028257da5 | ||
|
|
68eb4fe96d | ||
|
|
d2d434535b | ||
|
|
1d75c0c99b | ||
|
|
1de1261728 | ||
|
|
f5f33e0744 | ||
|
|
c9d62afa50 | ||
|
|
b5a9353780 | ||
|
|
cf6d16edcd | ||
|
|
551445773a | ||
|
|
c54cb4a84b | ||
|
|
af61044b63 | ||
|
|
1ef5a6d3cf | ||
|
|
4da311f91f | ||
|
|
cbb84649c7 | ||
|
|
8da734a495 | ||
|
|
351671011d | ||
|
|
15c95c251d |
No files matched your search
@@ -285,6 +285,12 @@ The API supports various bulk-editing operations which are executed asynchronous
|
|||||||
|
|
||||||
### Documents
|
### Documents
|
||||||
|
|
||||||
|
Document bulk operations, including the dedicated document action endpoints, return
|
||||||
|
`{"result":"OK","task_id":"…"}` when queued. Use `/api/tasks/?task_id={uuid}`
|
||||||
|
to check the task outcome. Actions that create or reprocess files may start further
|
||||||
|
consumption or reprocessing tasks and completion of the bulk task means those tasks
|
||||||
|
were scheduled, not that their file processing has finished.
|
||||||
|
|
||||||
For bulk operations on documents, use the endpoint `/api/documents/bulk_edit/` which accepts
|
For bulk operations on documents, use the endpoint `/api/documents/bulk_edit/` which accepts
|
||||||
a json payload of the format:
|
a json payload of the format:
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,121 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## paperless-ngx 3.5.1
|
||||||
|
|
||||||
|
### Changes
|
||||||
|
|
||||||
|
- Tweak: adjust chat timing for streaming [@shamoon](https://github.com/shamoon) ([#14805](https://github.com/paperless-ngx/paperless-ngx/pull/14805))
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Fix: dont use set\_actor if audit log disabled in tasks [@shamoon](https://github.com/shamoon) ([#14808](https://github.com/paperless-ngx/paperless-ngx/pull/14808))
|
||||||
|
- Fix: stream AI chat answers under ASGI [@stumpylog](https://github.com/stumpylog) ([#14803](https://github.com/paperless-ngx/paperless-ngx/pull/14803))
|
||||||
|
- Tweak/fix: retain bulk edit selection after queuing operation [@shamoon](https://github.com/shamoon) ([#14797](https://github.com/paperless-ngx/paperless-ngx/pull/14797))
|
||||||
|
|
||||||
|
### All App Changes
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>4 changes</summary>
|
||||||
|
|
||||||
|
- Fix: dont use set\_actor if audit log disabled in tasks [@shamoon](https://github.com/shamoon) ([#14808](https://github.com/paperless-ngx/paperless-ngx/pull/14808))
|
||||||
|
- Tweak: adjust chat timing for streaming [@shamoon](https://github.com/shamoon) ([#14805](https://github.com/paperless-ngx/paperless-ngx/pull/14805))
|
||||||
|
- Fix: stream AI chat answers under ASGI [@stumpylog](https://github.com/stumpylog) ([#14803](https://github.com/paperless-ngx/paperless-ngx/pull/14803))
|
||||||
|
- Tweak/fix: retain bulk edit selection after queuing operation [@shamoon](https://github.com/shamoon) ([#14797](https://github.com/paperless-ngx/paperless-ngx/pull/14797))
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
## paperless-ngx 3.5.0
|
||||||
|
|
||||||
|
### Features / Enhancements
|
||||||
|
|
||||||
|
- Chorehancement: move all bulk operations to async hand-off [@shamoon](https://github.com/shamoon) ([#14773](https://github.com/paperless-ngx/paperless-ngx/pull/14773))
|
||||||
|
- Enhancement: render document notes as markdown [@zwif](https://github.com/zwif) ([#14626](https://github.com/paperless-ngx/paperless-ngx/pull/14626))
|
||||||
|
- Feature: manual workflow trigger [@shamoon](https://github.com/shamoon) ([#14704](https://github.com/paperless-ngx/paperless-ngx/pull/14704))
|
||||||
|
- Enhancement: make bulk metadata operations run async [@shamoon](https://github.com/shamoon) ([#14711](https://github.com/paperless-ngx/paperless-ngx/pull/14711))
|
||||||
|
- Fixhancement: add automatic clearing of sessions [@shamoon](https://github.com/shamoon) ([#14722](https://github.com/paperless-ngx/paperless-ngx/pull/14722))
|
||||||
|
- Tweak: chat reference tweaks [@shamoon](https://github.com/shamoon) ([#14723](https://github.com/paperless-ngx/paperless-ngx/pull/14723))
|
||||||
|
- Fixhancement: rework saved view widget queue processing to expected [@shamoon](https://github.com/shamoon) ([#14699](https://github.com/paperless-ngx/paperless-ngx/pull/14699))
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Fix: use a constant password mask and consolidate the no-change check [@stumpylog](https://github.com/stumpylog) ([#14784](https://github.com/paperless-ngx/paperless-ngx/pull/14784))
|
||||||
|
- Fix: use a PostgreSQL-compatible regex for scheduled workflow filename filters [@stumpylog](https://github.com/stumpylog) ([#14783](https://github.com/paperless-ngx/paperless-ngx/pull/14783))
|
||||||
|
- Fix: get users for saved view create dialog [@shamoon](https://github.com/shamoon) ([#14769](https://github.com/paperless-ngx/paperless-ngx/pull/14769))
|
||||||
|
- Fix: Allow AI chat filters over more than 32700 documents [@stumpylog](https://github.com/stumpylog) ([#14754](https://github.com/paperless-ngx/paperless-ngx/pull/14754))
|
||||||
|
- Fix: Enforce CRLF when writing an email message to the file [@stumpylog](https://github.com/stumpylog) ([#14745](https://github.com/paperless-ngx/paperless-ngx/pull/14745))
|
||||||
|
- Fix: restore image without archive version thumbnail generation [@shamoon](https://github.com/shamoon) ([#14741](https://github.com/paperless-ngx/paperless-ngx/pull/14741))
|
||||||
|
- Fix: Blacklist certain OCR user arguments that paperless itself uses [@stumpylog](https://github.com/stumpylog) ([#14734](https://github.com/paperless-ngx/paperless-ngx/pull/14734))
|
||||||
|
- Fix: remove redundant ui task text filters [@shamoon](https://github.com/shamoon) ([#14736](https://github.com/paperless-ngx/paperless-ngx/pull/14736))
|
||||||
|
- Fix: fix allowed\_hosts default [@shamoon](https://github.com/shamoon) ([#14735](https://github.com/paperless-ngx/paperless-ngx/pull/14735))
|
||||||
|
- Fixhancement: add automatic clearing of sessions [@shamoon](https://github.com/shamoon) ([#14722](https://github.com/paperless-ngx/paperless-ngx/pull/14722))
|
||||||
|
- Fix: two dropdown-related UI fixes [@shamoon](https://github.com/shamoon) ([#14717](https://github.com/paperless-ngx/paperless-ngx/pull/14717))
|
||||||
|
- Fix: use filtered documents for statistics ASN max [@shamoon](https://github.com/shamoon) ([#14710](https://github.com/paperless-ngx/paperless-ngx/pull/14710))
|
||||||
|
- Fix: make config view permissions consistent [@shamoon](https://github.com/shamoon) ([#14709](https://github.com/paperless-ngx/paperless-ngx/pull/14709))
|
||||||
|
- Fix: release the LLM index read lock before streaming the chat answer [@stumpylog](https://github.com/stumpylog) ([#14674](https://github.com/paperless-ngx/paperless-ngx/pull/14674))
|
||||||
|
- Fix: retrieve once per document chat question [@stumpylog](https://github.com/stumpylog) ([#14673](https://github.com/paperless-ngx/paperless-ngx/pull/14673))
|
||||||
|
- Fixhancement: rework saved view widget queue processing to expected [@shamoon](https://github.com/shamoon) ([#14699](https://github.com/paperless-ngx/paperless-ngx/pull/14699))
|
||||||
|
- Fix: apply PDF/A conversion once for mail archives [@shamoon](https://github.com/shamoon) ([#14698](https://github.com/paperless-ngx/paperless-ngx/pull/14698))
|
||||||
|
- Fix default MFA trusted AMR setting [@shamoon](https://github.com/shamoon) ([#14693](https://github.com/paperless-ngx/paperless-ngx/pull/14693))
|
||||||
|
- Fix: check descendant tag permissions on delete [@shamoon](https://github.com/shamoon) ([#14687](https://github.com/paperless-ngx/paperless-ngx/pull/14687))
|
||||||
|
- Fix: lock rows for first-user signup [@shamoon](https://github.com/shamoon) ([#14688](https://github.com/paperless-ngx/paperless-ngx/pull/14688))
|
||||||
|
- Fix: prevent ID badge wrapping under title on mobile [@shamoon](https://github.com/shamoon) ([#14682](https://github.com/paperless-ngx/paperless-ngx/pull/14682))
|
||||||
|
|
||||||
|
### Maintenance
|
||||||
|
|
||||||
|
- Chore(deps): Bump the actions group across 1 directory with 17 updates @[dependabot[bot]](https://github.com/apps/dependabot) ([#14691](https://github.com/paperless-ngx/paperless-ngx/pull/14691))
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>4 changes</summary>
|
||||||
|
|
||||||
|
- Chore(deps): Bump the pre-commit-dependencies group with 4 updates @[dependabot[bot]](https://github.com/apps/dependabot) ([#14636](https://github.com/paperless-ngx/paperless-ngx/pull/14636))
|
||||||
|
- Chore(deps): Bump the actions group across 1 directory with 17 updates @[dependabot[bot]](https://github.com/apps/dependabot) ([#14691](https://github.com/paperless-ngx/paperless-ngx/pull/14691))
|
||||||
|
- docker(deps): bump astral-sh/uv from 0.13.5-python3.14-trixie-slim to 0.13.7-python3.14-trixie-slim @[dependabot[bot]](https://github.com/apps/dependabot) ([#14635](https://github.com/paperless-ngx/paperless-ngx/pull/14635))
|
||||||
|
- chore(deps): bump django-allauth to 65.21.1 [@stumpylog](https://github.com/stumpylog) ([#14672](https://github.com/paperless-ngx/paperless-ngx/pull/14672))
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
### All App Changes
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>32 changes</summary>
|
||||||
|
|
||||||
|
- Chorehancement: move all bulk operations to async hand-off [@shamoon](https://github.com/shamoon) ([#14773](https://github.com/paperless-ngx/paperless-ngx/pull/14773))
|
||||||
|
- Fix: use a constant password mask and consolidate the no-change check [@stumpylog](https://github.com/stumpylog) ([#14784](https://github.com/paperless-ngx/paperless-ngx/pull/14784))
|
||||||
|
- Fix: use a PostgreSQL-compatible regex for scheduled workflow filename filters [@stumpylog](https://github.com/stumpylog) ([#14783](https://github.com/paperless-ngx/paperless-ngx/pull/14783))
|
||||||
|
- Fix: get users for saved view create dialog [@shamoon](https://github.com/shamoon) ([#14769](https://github.com/paperless-ngx/paperless-ngx/pull/14769))
|
||||||
|
- Enhancement: render document notes as markdown [@zwif](https://github.com/zwif) ([#14626](https://github.com/paperless-ngx/paperless-ngx/pull/14626))
|
||||||
|
- Feature: manual workflow trigger [@shamoon](https://github.com/shamoon) ([#14704](https://github.com/paperless-ngx/paperless-ngx/pull/14704))
|
||||||
|
- Fix: Allow AI chat filters over more than 32700 documents [@stumpylog](https://github.com/stumpylog) ([#14754](https://github.com/paperless-ngx/paperless-ngx/pull/14754))
|
||||||
|
- Fix: Enforce CRLF when writing an email message to the file [@stumpylog](https://github.com/stumpylog) ([#14745](https://github.com/paperless-ngx/paperless-ngx/pull/14745))
|
||||||
|
- Enhancement: make bulk metadata operations run async [@shamoon](https://github.com/shamoon) ([#14711](https://github.com/paperless-ngx/paperless-ngx/pull/14711))
|
||||||
|
- Performance: load a cached Hugging Face embedding model without contacting the Hub [@stumpylog](https://github.com/stumpylog) ([#14728](https://github.com/paperless-ngx/paperless-ngx/pull/14728))
|
||||||
|
- Fix: restore image without archive version thumbnail generation [@shamoon](https://github.com/shamoon) ([#14741](https://github.com/paperless-ngx/paperless-ngx/pull/14741))
|
||||||
|
- Fix: Blacklist certain OCR user arguments that paperless itself uses [@stumpylog](https://github.com/stumpylog) ([#14734](https://github.com/paperless-ngx/paperless-ngx/pull/14734))
|
||||||
|
- Fix: remove redundant ui task text filters [@shamoon](https://github.com/shamoon) ([#14736](https://github.com/paperless-ngx/paperless-ngx/pull/14736))
|
||||||
|
- Fix: fix allowed\_hosts default [@shamoon](https://github.com/shamoon) ([#14735](https://github.com/paperless-ngx/paperless-ngx/pull/14735))
|
||||||
|
- Fixhancement: add automatic clearing of sessions [@shamoon](https://github.com/shamoon) ([#14722](https://github.com/paperless-ngx/paperless-ngx/pull/14722))
|
||||||
|
- Tweak: chat reference tweaks [@shamoon](https://github.com/shamoon) ([#14723](https://github.com/paperless-ngx/paperless-ngx/pull/14723))
|
||||||
|
- Fix: two dropdown-related UI fixes [@shamoon](https://github.com/shamoon) ([#14717](https://github.com/paperless-ngx/paperless-ngx/pull/14717))
|
||||||
|
- Fix: use filtered documents for statistics ASN max [@shamoon](https://github.com/shamoon) ([#14710](https://github.com/paperless-ngx/paperless-ngx/pull/14710))
|
||||||
|
- Fix: make config view permissions consistent [@shamoon](https://github.com/shamoon) ([#14709](https://github.com/paperless-ngx/paperless-ngx/pull/14709))
|
||||||
|
- Performance: stop embedding every document ID in selection\_data queries [@stumpylog](https://github.com/stumpylog) ([#14597](https://github.com/paperless-ngx/paperless-ngx/pull/14597))
|
||||||
|
- Performance: replace django-treenode with adjacency-list tags [@shamoon](https://github.com/shamoon) ([#14612](https://github.com/paperless-ngx/paperless-ngx/pull/14612))
|
||||||
|
- Performance: use small vec0 chunks and larger pages for the LLM index [@stumpylog](https://github.com/stumpylog) ([#14678](https://github.com/paperless-ngx/paperless-ngx/pull/14678))
|
||||||
|
- Fix: release the LLM index read lock before streaming the chat answer [@stumpylog](https://github.com/stumpylog) ([#14674](https://github.com/paperless-ngx/paperless-ngx/pull/14674))
|
||||||
|
- Fix: retrieve once per document chat question [@stumpylog](https://github.com/stumpylog) ([#14673](https://github.com/paperless-ngx/paperless-ngx/pull/14673))
|
||||||
|
- Fixhancement: rework saved view widget queue processing to expected [@shamoon](https://github.com/shamoon) ([#14699](https://github.com/paperless-ngx/paperless-ngx/pull/14699))
|
||||||
|
- Fix: apply PDF/A conversion once for mail archives [@shamoon](https://github.com/shamoon) ([#14698](https://github.com/paperless-ngx/paperless-ngx/pull/14698))
|
||||||
|
- Fix default MFA trusted AMR setting [@shamoon](https://github.com/shamoon) ([#14693](https://github.com/paperless-ngx/paperless-ngx/pull/14693))
|
||||||
|
- Fix: check descendant tag permissions on delete [@shamoon](https://github.com/shamoon) ([#14687](https://github.com/paperless-ngx/paperless-ngx/pull/14687))
|
||||||
|
- Fix: lock rows for first-user signup [@shamoon](https://github.com/shamoon) ([#14688](https://github.com/paperless-ngx/paperless-ngx/pull/14688))
|
||||||
|
- Fix: prevent ID badge wrapping under title on mobile [@shamoon](https://github.com/shamoon) ([#14682](https://github.com/paperless-ngx/paperless-ngx/pull/14682))
|
||||||
|
- chore(deps): bump django-allauth to 65.21.1 [@stumpylog](https://github.com/stumpylog) ([#14672](https://github.com/paperless-ngx/paperless-ngx/pull/14672))
|
||||||
|
- chore(deps): bump dev tooling [@stumpylog](https://github.com/stumpylog) ([#14671](https://github.com/paperless-ngx/paperless-ngx/pull/14671))
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
## paperless-ngx 3.4.2
|
## paperless-ngx 3.4.2
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
|||||||
+113
-6
@@ -109,7 +109,7 @@ Think of versions as **file history** for a document.
|
|||||||
Paperless-ngx includes management lists for tags, correspondents, document types
|
Paperless-ngx includes management lists for tags, correspondents, document types
|
||||||
and more. These areas allow you to view, add, edit, delete and manage permissions
|
and more. These areas allow you to view, add, edit, delete and manage permissions
|
||||||
for these objects. You can also manage saved views, mail accounts, mail rules,
|
for these objects. You can also manage saved views, mail accounts, mail rules,
|
||||||
workflows and more from the management sections.
|
workflows, [OCR templates](#ocr-templates) and more from the management sections.
|
||||||
|
|
||||||
### Nested Tags
|
### Nested Tags
|
||||||
|
|
||||||
@@ -493,7 +493,7 @@ fields and permissions, which will be merged.
|
|||||||
|
|
||||||
#### Types {#workflow-trigger-types}
|
#### Types {#workflow-trigger-types}
|
||||||
|
|
||||||
Currently, there are four events that correspond to workflow trigger 'types':
|
Currently, there are five events that correspond to workflow trigger 'types':
|
||||||
|
|
||||||
1. **Consumption Started**: _before_ a document is consumed, so events can include filters by source (mail, consumption
|
1. **Consumption Started**: _before_ a document is consumed, so events can include filters by source (mail, consumption
|
||||||
folder or API), file path, file name, mail rule
|
folder or API), file path, file name, mail rule
|
||||||
@@ -505,8 +505,10 @@ Currently, there are four events that correspond to workflow trigger 'types':
|
|||||||
4. **Scheduled**: a scheduled trigger that can be used to run workflows at a specific time. The date used can be either the document
|
4. **Scheduled**: a scheduled trigger that can be used to run workflows at a specific time. The date used can be either the document
|
||||||
added, created, updated date or you can specify a (date) custom field. You can also specify a day offset from the date (positive
|
added, created, updated date or you can specify a (date) custom field. You can also specify a day offset from the date (positive
|
||||||
offsets will trigger after the date, negative offsets will trigger before).
|
offsets will trigger after the date, negative offsets will trigger before).
|
||||||
|
5. **Manual**: a trigger that only runs when you explicitly choose to run the workflow against one or more existing documents. See
|
||||||
|
[running a workflow manually](#running-a-workflow-manually) below.
|
||||||
|
|
||||||
The following flow diagram illustrates the four document trigger types:
|
The following flow diagram illustrates the document trigger types:
|
||||||
|
|
||||||
```mermaid
|
```mermaid
|
||||||
flowchart TD
|
flowchart TD
|
||||||
@@ -526,6 +528,10 @@ flowchart TD
|
|||||||
matching
|
matching
|
||||||
trigger(s)"}
|
trigger(s)"}
|
||||||
|
|
||||||
|
manual{"Matching
|
||||||
|
'Manual'
|
||||||
|
trigger(s)"}
|
||||||
|
|
||||||
A[New Document] --> consumption
|
A[New Document] --> consumption
|
||||||
consumption --> |Yes| C[Workflow Actions Run]
|
consumption --> |Yes| C[Workflow Actions Run]
|
||||||
consumption --> |No| D
|
consumption --> |No| D
|
||||||
@@ -543,6 +549,10 @@ flowchart TD
|
|||||||
scheduled --> |Yes| N[Workflow Actions Run]
|
scheduled --> |Yes| N[Workflow Actions Run]
|
||||||
scheduled --> |No| O[Document Saved]
|
scheduled --> |No| O[Document Saved]
|
||||||
N --> O
|
N --> O
|
||||||
|
P[User Runs Workflow] --> manual
|
||||||
|
manual --> |Yes| Q[Workflow Actions Run]
|
||||||
|
manual --> |No| R[Document Saved]
|
||||||
|
Q --> R
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Filters {#workflow-trigger-filters}
|
#### Filters {#workflow-trigger-filters}
|
||||||
@@ -554,9 +564,9 @@ Workflows allow you to filter by:
|
|||||||
- File path, including wildcards. Note that enabling `PAPERLESS_CONSUMER_RECURSIVE` would allow, for
|
- File path, including wildcards. Note that enabling `PAPERLESS_CONSUMER_RECURSIVE` would allow, for
|
||||||
example, automatically assigning documents to different owners based on the upload directory.
|
example, automatically assigning documents to different owners based on the upload directory.
|
||||||
- Mail rule. Choosing this option will force 'mail fetch' to be the workflow source.
|
- Mail rule. Choosing this option will force 'mail fetch' to be the workflow source.
|
||||||
- Content matching (`Added`, `Updated` and `Scheduled` triggers only). Filter document content using the matching settings.
|
- Content matching (`Added`, `Updated`, `Scheduled` and `Manual` triggers only). Filter document content using the matching settings.
|
||||||
|
|
||||||
There are also 'advanced' filters available for `Added`, `Updated` and `Scheduled` triggers:
|
There are also 'advanced' filters available for `Added`, `Updated`, `Scheduled` and `Manual` triggers:
|
||||||
|
|
||||||
- Any Tags: Filter for documents with any of the specified tags.
|
- Any Tags: Filter for documents with any of the specified tags.
|
||||||
- All Tags: Filter for documents with all of the specified tags.
|
- All Tags: Filter for documents with all of the specified tags.
|
||||||
@@ -569,6 +579,22 @@ There are also 'advanced' filters available for `Added`, `Updated` and `Schedule
|
|||||||
- Not Storage paths: Filter documents without any of these storage paths.
|
- Not Storage paths: Filter documents without any of these storage paths.
|
||||||
- Custom field query: Filter documents with a custom field query (the same as used for the document list filters).
|
- Custom field query: Filter documents with a custom field query (the same as used for the document list filters).
|
||||||
|
|
||||||
|
#### Running a workflow manually {#running-a-workflow-manually}
|
||||||
|
|
||||||
|
A workflow with a **Manual** trigger does not run automatically. Instead, it can be run on demand against existing
|
||||||
|
documents from the web UI:
|
||||||
|
|
||||||
|
- From the document list, select one or more documents and choose **Run workflow** from the "Actions" menu.
|
||||||
|
- From an individual document, choose **Run workflow** from the "Actions" menu.
|
||||||
|
|
||||||
|
You will be asked which workflow to run. From the document list, the workflow's trigger filters apply by default, so
|
||||||
|
documents that do not match are skipped. You can choose to **run on all selected documents** to ignore the filters.
|
||||||
|
From an individual document, the option to ignore trigger filters is selected by default. Clear it to run the workflow
|
||||||
|
only if the document matches its trigger filters.
|
||||||
|
|
||||||
|
Manual runs happen in the background. As with scheduled workflows, the document list is not refreshed automatically when
|
||||||
|
they finish, so you may need to reload the list to see the results.
|
||||||
|
|
||||||
### Workflow Actions
|
### Workflow Actions
|
||||||
|
|
||||||
#### Types {#workflow-action-types}
|
#### Types {#workflow-action-types}
|
||||||
@@ -649,7 +675,7 @@ new version of the same document, this time with normal OCR/text extraction appl
|
|||||||
a password-protected file added with this trigger will briefly exist as an un-OCR'd version before
|
a password-protected file added with this trigger will briefly exist as an un-OCR'd version before
|
||||||
the properly processed version is created.
|
the properly processed version is created.
|
||||||
|
|
||||||
**Document Added**, **Document Updated**, **Scheduled**: these triggers run against a document that
|
**Document Added**, **Document Updated**, **Scheduled**, **Manual**: these triggers run against a document that
|
||||||
already exists, so password removal happens immediately: the decrypted content is queued for
|
already exists, so password removal happens immediately: the decrypted content is queued for
|
||||||
consumption as a new version right away. Note that if the document's initial consumption also
|
consumption as a new version right away. Note that if the document's initial consumption also
|
||||||
happened while it was still encrypted, that original version will likewise be missing OCR text.
|
happened while it was still encrypted, that original version will likewise be missing OCR text.
|
||||||
@@ -795,6 +821,87 @@ The following custom field types are supported:
|
|||||||
- `Document Link`: reference(s) to other document(s) displayed as links, automatically creates a symmetrical link in reverse
|
- `Document Link`: reference(s) to other document(s) displayed as links, automatically creates a symmetrical link in reverse
|
||||||
- `Select`: a pre-defined list of strings from which the user can choose
|
- `Select`: a pre-defined list of strings from which the user can choose
|
||||||
|
|
||||||
|
## OCR Templates {#ocr-templates}
|
||||||
|
|
||||||
|
OCR templates read text from fixed areas ("zones") of a document and write it to a
|
||||||
|
[custom field](#custom-fields), or to the document's title, archive serial number or created date. They are
|
||||||
|
useful for documents that always share the same layout, such as bills from a particular utility. They allow you
|
||||||
|
to draw a zone around the account number once, and every new bill gets its account number filled in.
|
||||||
|
|
||||||
|
Like tags or document types, each template has a [matching algorithm](advanced_usage.md#matching) that
|
||||||
|
decides which documents it automatically applies to (or not), based on their content.
|
||||||
|
|
||||||
|
### Creating a template
|
||||||
|
|
||||||
|
1. Open **OCR Templates** under "Manage" and choose **Add Template**.
|
||||||
|
2. Give the template a name and set up its matching, for example **Any word** with the utility's name. Choose
|
||||||
|
**None** for a template that should only ever be run manually.
|
||||||
|
3. Search for a sample document with the layout the template is for. Its pages are shown next to the template
|
||||||
|
settings.
|
||||||
|
4. Draw zones on the document. Click a zone to select and edit it.
|
||||||
|
5. Choose the field each zone fills.
|
||||||
|
6. Use **Test** to run OCR on the selected zone of the sample document and see the text it finds and the value
|
||||||
|
that would be written.
|
||||||
|
|
||||||
|
Zones are positioned relative to the sample document's page, so templates work best when the documents they
|
||||||
|
match have an identical layout. Keep the matching specific enough that it only catches documents with that
|
||||||
|
layout.
|
||||||
|
|
||||||
|
### Zone settings
|
||||||
|
|
||||||
|
- **Page**: the page the zone is on. Turn on **Last page** for zones that are always on the final page,
|
||||||
|
regardless of how many pages a document has.
|
||||||
|
- **OCR language**: the Tesseract languages used to read the zone. Languages other than the defaults must be
|
||||||
|
installed, see [`PAPERLESS_OCR_LANGUAGES`](configuration.md#PAPERLESS_OCR_LANGUAGES).
|
||||||
|
- **Transform**: post-processing applied to the text, such as stripping whitespace, keeping only numbers,
|
||||||
|
parsing a date or reading a QR code or barcode instead of text.
|
||||||
|
- **Date format**: for the "Parse date" transform, the format of the date using
|
||||||
|
[Python date codes](https://docs.python.org/3/library/datetime.html#format-codes), e.g. `%d.%m.%Y`.
|
||||||
|
Leave it empty to detect the format automatically.
|
||||||
|
- **Validation regex**: a regular expression the whole value must match. Values that do not match are not
|
||||||
|
written.
|
||||||
|
|
||||||
|
Zones can fill custom fields of type text, long text, URL, date, integer, number, monetary or boolean.
|
||||||
|
Document link and select fields are not supported.
|
||||||
|
|
||||||
|
### Combining zones
|
||||||
|
|
||||||
|
When several zones fill the same field, a **Combined value** setting appears for that field. Use it to arrange
|
||||||
|
the zones' values with `{Zone name}` tokens and any text in between, for example `{Start} - {End}`. If it
|
||||||
|
is left empty, the values are joined with spaces in zone order.
|
||||||
|
|
||||||
|
### When templates run
|
||||||
|
|
||||||
|
When a document is added, every enabled template that matches its content runs automatically. A template is
|
||||||
|
only used for a document if the document's owner can view the template, so users' templates apply to their own
|
||||||
|
documents, and unowned templates apply to everyone's. Templates run in name order, so if two templates fill the
|
||||||
|
same field, the later one wins.
|
||||||
|
|
||||||
|
Turn off **Enabled** to pause a template without deleting it. Disabled templates never run automatically, but
|
||||||
|
can still be run manually.
|
||||||
|
|
||||||
|
### Running templates manually
|
||||||
|
|
||||||
|
To run templates on documents that are already in Paperless-ngx, open the **Actions** menu on the document
|
||||||
|
details page:
|
||||||
|
|
||||||
|
- **Run Zone OCR** runs every enabled template that matches the document.
|
||||||
|
- The button next to it opens a dialog where you can choose one template to run
|
||||||
|
instead. A template you choose runs even if it does not match the document or is disabled.
|
||||||
|
|
||||||
|
Both actions use the file version selected in document details. The latest version is selected by default.
|
||||||
|
Extracted values update the document's metadata, which is shared across its versions.
|
||||||
|
|
||||||
|
The bulk editor's **Run Zone OCR** action opens the same dialog for the selected documents. Bulk runs use
|
||||||
|
the latest version of each document and are processed in the background.
|
||||||
|
|
||||||
|
!!! warning
|
||||||
|
|
||||||
|
Zone OCR overwrites the fields it fills. A zone that finds no value leaves its field unchanged.
|
||||||
|
|
||||||
|
Managing OCR templates requires the OCR template permissions. Running zone OCR on documents requires
|
||||||
|
permission to change them, and choosing a template requires permission to view it.
|
||||||
|
|
||||||
## PDF Actions
|
## PDF Actions
|
||||||
|
|
||||||
Paperless-ngx supports basic editing operations for PDFs (these operations currently cannot be performed on non-PDF files). When viewing an individual document you can
|
Paperless-ngx supports basic editing operations for PDFs (these operations currently cannot be performed on non-PDF files). When viewing an individual document you can
|
||||||
|
|||||||
+4
-3
@@ -1,6 +1,6 @@
|
|||||||
[project]
|
[project]
|
||||||
name = "paperless-ngx"
|
name = "paperless-ngx"
|
||||||
version = "3.4.2"
|
version = "3.5.1"
|
||||||
description = """\
|
description = """\
|
||||||
A community-supported supercharged document management system: scan, index and archive all your physical documents\
|
A community-supported supercharged document management system: scan, index and archive all your physical documents\
|
||||||
"""
|
"""
|
||||||
@@ -151,8 +151,9 @@ typing = [
|
|||||||
required-version = ">=0.9.0"
|
required-version = ">=0.9.0"
|
||||||
prerelease = "disallow"
|
prerelease = "disallow"
|
||||||
environments = [
|
environments = [
|
||||||
"sys_platform == 'darwin'",
|
"sys_platform == 'darwin' and platform_machine == 'arm64' and platform_python_implementation == 'CPython'",
|
||||||
"sys_platform == 'linux'",
|
"sys_platform == 'linux' and platform_machine == 'aarch64' and platform_python_implementation == 'CPython'",
|
||||||
|
"sys_platform == 'linux' and platform_machine == 'x86_64' and platform_python_implementation == 'CPython'",
|
||||||
]
|
]
|
||||||
package = false
|
package = false
|
||||||
[tool.uv.sources]
|
[tool.uv.sources]
|
||||||
|
|||||||
+737
-348
File diff suppressed because it is too large.
Load diff
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "paperless-ngx-ui",
|
"name": "paperless-ngx-ui",
|
||||||
"version": "3.4.2",
|
"version": "3.5.1",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"preinstall": "npx only-allow pnpm",
|
"preinstall": "npx only-allow pnpm",
|
||||||
"ng": "ng",
|
"ng": "ng",
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ import { DocumentDetailComponent } from './components/document-detail/document-d
|
|||||||
import { DocumentListComponent } from './components/document-list/document-list.component'
|
import { DocumentListComponent } from './components/document-list/document-list.component'
|
||||||
import { DocumentAttributesComponent } from './components/manage/document-attributes/document-attributes.component'
|
import { DocumentAttributesComponent } from './components/manage/document-attributes/document-attributes.component'
|
||||||
import { MailComponent } from './components/manage/mail/mail.component'
|
import { MailComponent } from './components/manage/mail/mail.component'
|
||||||
|
import { OcrTemplatesComponent } from './components/manage/ocr-templates/ocr-templates.component'
|
||||||
import { SavedViewsComponent } from './components/manage/saved-views/saved-views.component'
|
import { SavedViewsComponent } from './components/manage/saved-views/saved-views.component'
|
||||||
import { ShareLinksComponent } from './components/manage/share-links/share-links.component'
|
import { ShareLinksComponent } from './components/manage/share-links/share-links.component'
|
||||||
import { WorkflowsComponent } from './components/manage/workflows/workflows.component'
|
import { WorkflowsComponent } from './components/manage/workflows/workflows.component'
|
||||||
@@ -275,6 +276,18 @@ export const routes: Routes = [
|
|||||||
componentName: 'WorkflowsComponent',
|
componentName: 'WorkflowsComponent',
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
path: 'ocr-templates',
|
||||||
|
component: OcrTemplatesComponent,
|
||||||
|
canActivate: [PermissionsGuard],
|
||||||
|
data: {
|
||||||
|
requiredPermission: {
|
||||||
|
action: PermissionAction.View,
|
||||||
|
type: PermissionType.OcrTemplate,
|
||||||
|
},
|
||||||
|
componentName: 'OcrTemplatesComponent',
|
||||||
|
},
|
||||||
|
},
|
||||||
{
|
{
|
||||||
path: 'mail',
|
path: 'mail',
|
||||||
component: MailComponent,
|
component: MailComponent,
|
||||||
|
|||||||
@@ -113,6 +113,7 @@ const sidebarItemLabels: Record<HideableSidebarItemID, string> = {
|
|||||||
[HideableSidebarItemID.SavedViews]: $localize`Saved Views`,
|
[HideableSidebarItemID.SavedViews]: $localize`Saved Views`,
|
||||||
[HideableSidebarItemID.ShareLinks]: $localize`Share Links`,
|
[HideableSidebarItemID.ShareLinks]: $localize`Share Links`,
|
||||||
[HideableSidebarItemID.Workflows]: $localize`Workflows`,
|
[HideableSidebarItemID.Workflows]: $localize`Workflows`,
|
||||||
|
[HideableSidebarItemID.OcrTemplates]: $localize`OCR Templates`,
|
||||||
[HideableSidebarItemID.Mail]: $localize`Mail`,
|
[HideableSidebarItemID.Mail]: $localize`Mail`,
|
||||||
[HideableSidebarItemID.Documentation]: $localize`Documentation`,
|
[HideableSidebarItemID.Documentation]: $localize`Documentation`,
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -175,7 +175,13 @@
|
|||||||
</div>
|
</div>
|
||||||
</td>
|
</td>
|
||||||
<td class="overflow-auto name-col">
|
<td class="overflow-auto name-col">
|
||||||
<div>{{ taskDisplayName(task) }}</div>
|
@let documentCount = taskDocumentCount(task);
|
||||||
|
<div>
|
||||||
|
{{ taskDisplayName(task) }}
|
||||||
|
@if (documentCount !== null && documentCount > 1) {
|
||||||
|
<small class="text-muted ms-1" i18n>({documentCount, plural, =1 {1 document} other {{{ documentCount }} documents}})</small>
|
||||||
|
}
|
||||||
|
</div>
|
||||||
<div class="small text-muted">
|
<div class="small text-muted">
|
||||||
@if (taskShowsSeparateTypeLabel(task)) {
|
@if (taskShowsSeparateTypeLabel(task)) {
|
||||||
<span class="me-2">{{ task.task_type_display }}</span>
|
<span class="me-2">{{ task.task_type_display }}</span>
|
||||||
|
|||||||
@@ -895,6 +895,117 @@ describe('TasksComponent', () => {
|
|||||||
expect(sanityTaskRow.nativeElement.textContent).toContain('System')
|
expect(sanityTaskRow.nativeElement.textContent).toContain('System')
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
['modify_tags', 12, 'Bulk operation: Update tags', '(12 documents)'],
|
||||||
|
['run_workflow', 1, 'Run workflow', null],
|
||||||
|
['delete', 3, 'Bulk operation: Move to trash', '(3 documents)'],
|
||||||
|
['reprocess', 2, 'Bulk operation: Document reprocessing', '(2 documents)'],
|
||||||
|
])(
|
||||||
|
'shows the operation, document count and outcome for %s',
|
||||||
|
(operation, count, label, summary) => {
|
||||||
|
const task: PaperlessTask = {
|
||||||
|
...tasks[4],
|
||||||
|
task_type:
|
||||||
|
operation === 'delete'
|
||||||
|
? PaperlessTaskType.BulkDelete
|
||||||
|
: PaperlessTaskType.BulkUpdate,
|
||||||
|
task_type_display:
|
||||||
|
operation === 'delete' ? 'Bulk Delete' : 'Bulk Update',
|
||||||
|
trigger_source: PaperlessTaskTriggerSource.WebUI,
|
||||||
|
trigger_source_display: 'Web UI',
|
||||||
|
input_data: { operation, document_count: count },
|
||||||
|
result_data: { operation, document_count: count },
|
||||||
|
}
|
||||||
|
component.setSection(TaskSection.Completed)
|
||||||
|
flushTaskLists(25, 1, [task])
|
||||||
|
fixture.detectChanges()
|
||||||
|
|
||||||
|
const name = fixture.nativeElement.querySelector('tbody .name-col')
|
||||||
|
expect(name.textContent).toContain(label)
|
||||||
|
const countLabel = name.querySelector('small.text-muted')
|
||||||
|
if (summary) {
|
||||||
|
expect(countLabel.textContent).toContain(summary)
|
||||||
|
} else {
|
||||||
|
expect(countLabel).toBeNull()
|
||||||
|
expect(name.textContent).not.toContain('Bulk operation:')
|
||||||
|
}
|
||||||
|
expect(name.textContent).not.toContain('·')
|
||||||
|
expect(name.textContent).toContain('Web UI')
|
||||||
|
expect(name.textContent).not.toContain(task.task_type_display)
|
||||||
|
expect(
|
||||||
|
name.closest('tr').querySelector('.results-col').textContent
|
||||||
|
).toContain(
|
||||||
|
[
|
||||||
|
'reprocess',
|
||||||
|
'rotate',
|
||||||
|
'merge',
|
||||||
|
'split',
|
||||||
|
'delete_pages',
|
||||||
|
'edit_pdf',
|
||||||
|
'remove_password',
|
||||||
|
].includes(operation)
|
||||||
|
? 'Submitted for processing'
|
||||||
|
: 'Completed'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
it('shows operation context while work is pending without reporting completion', () => {
|
||||||
|
const task = {
|
||||||
|
...tasks[2],
|
||||||
|
task_type: PaperlessTaskType.BulkUpdate,
|
||||||
|
task_type_display: 'Bulk Update',
|
||||||
|
input_data: { operation: 'reprocess', document_count: 1 },
|
||||||
|
}
|
||||||
|
component.setSection(TaskSection.InProgress)
|
||||||
|
flushTaskLists(25, 1, [task])
|
||||||
|
fixture.detectChanges()
|
||||||
|
|
||||||
|
const name = fixture.nativeElement.querySelector('tbody .name-col')
|
||||||
|
expect(name.textContent).toContain('Document reprocessing')
|
||||||
|
expect(name.textContent).not.toContain('Bulk operation:')
|
||||||
|
expect(name.querySelector('small')).toBeNull()
|
||||||
|
expect(component.taskResultMessage(task)).toBeNull()
|
||||||
|
})
|
||||||
|
|
||||||
|
it.each([{}, { operation: 'future_operation' }])(
|
||||||
|
'preserves the fallback for legacy or unknown operation data: %j',
|
||||||
|
(input_data) => {
|
||||||
|
const task = {
|
||||||
|
...tasks[4],
|
||||||
|
task_type: PaperlessTaskType.BulkUpdate,
|
||||||
|
task_type_display: 'Bulk Update',
|
||||||
|
input_data,
|
||||||
|
result_data: {},
|
||||||
|
}
|
||||||
|
expect(component.taskDisplayName(task)).toBe('Bulk Update')
|
||||||
|
expect(component.taskDocumentCount(task)).toBeNull()
|
||||||
|
expect(component.taskResultMessage(task)).toBeNull()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
it.each([-1, 1.5, '2', null, undefined])(
|
||||||
|
'does not display an invalid document count: %s',
|
||||||
|
(document_count) => {
|
||||||
|
expect(
|
||||||
|
component.taskDocumentCount({
|
||||||
|
...tasks[4],
|
||||||
|
input_data: { operation: 'modify_tags', document_count },
|
||||||
|
})
|
||||||
|
).toBeNull()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
it('retains error details for failed operation tasks', () => {
|
||||||
|
expect(
|
||||||
|
component.taskResultMessage({
|
||||||
|
...tasks[0],
|
||||||
|
input_data: { operation: 'modify_tags', document_count: 12 },
|
||||||
|
result_data: { error_message: 'Insufficient permissions' },
|
||||||
|
})
|
||||||
|
).toBe('Insufficient permissions')
|
||||||
|
})
|
||||||
|
|
||||||
it('should filter tasks by result', () => {
|
it('should filter tasks by result', () => {
|
||||||
component.setSection(TaskSection.NeedsAttention)
|
component.setSection(TaskSection.NeedsAttention)
|
||||||
component.filterTargetID = 1
|
component.filterTargetID = 1
|
||||||
|
|||||||
@@ -33,6 +33,10 @@ import { IfPermissionsDirective } from 'src/app/directives/if-permissions.direct
|
|||||||
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
|
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
|
||||||
import { TasksService } from 'src/app/services/tasks.service'
|
import { TasksService } from 'src/app/services/tasks.service'
|
||||||
import { ToastService } from 'src/app/services/toast.service'
|
import { ToastService } from 'src/app/services/toast.service'
|
||||||
|
import {
|
||||||
|
documentOperationHasFollowUpTasks,
|
||||||
|
getDocumentOperationLabel,
|
||||||
|
} from 'src/app/utils/document-operation'
|
||||||
import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component'
|
import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component'
|
||||||
import { PageHeaderComponent } from '../../common/page-header/page-header.component'
|
import { PageHeaderComponent } from '../../common/page-header/page-header.component'
|
||||||
import { LoadingComponentWithPermissions } from '../../loading-component/loading.component'
|
import { LoadingComponentWithPermissions } from '../../loading-component/loading.component'
|
||||||
@@ -414,11 +418,30 @@ export class TasksComponent
|
|||||||
}
|
}
|
||||||
|
|
||||||
taskDisplayName(task: PaperlessTask): string {
|
taskDisplayName(task: PaperlessTask): string {
|
||||||
return task.input_data?.filename?.toString() || task.task_type_display
|
const filename = task.input_data?.filename?.toString()
|
||||||
|
if (filename) return filename
|
||||||
|
const operation = this.taskOperationLabel(task)
|
||||||
|
const count = this.taskDocumentCount(task)
|
||||||
|
if (operation && count !== null && count > 1) {
|
||||||
|
return $localize`Bulk operation: ${operation}`
|
||||||
|
}
|
||||||
|
return operation || task.task_type_display
|
||||||
}
|
}
|
||||||
|
|
||||||
taskShowsSeparateTypeLabel(task: PaperlessTask): boolean {
|
taskShowsSeparateTypeLabel(task: PaperlessTask): boolean {
|
||||||
return this.taskDisplayName(task) !== task.task_type_display
|
return (
|
||||||
|
!this.taskOperationLabel(task) &&
|
||||||
|
this.taskDisplayName(task) !== task.task_type_display
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
private taskOperationLabel(task: PaperlessTask): string | null {
|
||||||
|
return getDocumentOperationLabel(task.input_data?.operation)
|
||||||
|
}
|
||||||
|
|
||||||
|
taskDocumentCount(task: PaperlessTask): number | null {
|
||||||
|
const count = task.input_data?.document_count
|
||||||
|
return Number.isInteger(count) && count >= 0 ? count : null
|
||||||
}
|
}
|
||||||
|
|
||||||
taskResultMessage(task: PaperlessTask): string | null {
|
taskResultMessage(task: PaperlessTask): string | null {
|
||||||
@@ -446,6 +469,15 @@ export class TasksComponent
|
|||||||
return errorMessage
|
return errorMessage
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
task.status === PaperlessTaskStatus.Success &&
|
||||||
|
this.taskOperationLabel(task)
|
||||||
|
) {
|
||||||
|
return documentOperationHasFollowUpTasks(task.input_data?.operation)
|
||||||
|
? $localize`Submitted for processing`
|
||||||
|
: $localize`Completed`
|
||||||
|
}
|
||||||
|
|
||||||
return null
|
return null
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -289,6 +289,17 @@
|
|||||||
<pngx-input-switch class="position-absolute top-50 end-0 translate-middle-y me-1" [class.d-none]="slimSidebarEnabled || slimSidebarAnimating()" [compact]="true" title="Workflows" i18n-title [ngModel]="!settingsService.sidebarItemIsHidden(HideableSidebarItemID.Workflows)" (ngModelChange)="toggleSidebarItem(HideableSidebarItemID.Workflows, $event)"></pngx-input-switch>
|
<pngx-input-switch class="position-absolute top-50 end-0 translate-middle-y me-1" [class.d-none]="slimSidebarEnabled || slimSidebarAnimating()" [compact]="true" title="Workflows" i18n-title [ngModel]="!settingsService.sidebarItemIsHidden(HideableSidebarItemID.Workflows)" (ngModelChange)="toggleSidebarItem(HideableSidebarItemID.Workflows, $event)"></pngx-input-switch>
|
||||||
}
|
}
|
||||||
</li>
|
</li>
|
||||||
|
<li class="nav-item app-link position-relative" [class.d-none]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.OcrTemplates) && !settingsService.organizingSidebarItems()"
|
||||||
|
*pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.OcrTemplate }">
|
||||||
|
<a class="nav-link" [class.opacity-50]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.OcrTemplates)" [class.pe-5]="settingsService.organizingSidebarItems() && !slimSidebarEnabled && !slimSidebarAnimating()" routerLink="ocr-templates" routerLinkActive="active" (click)="closeMenu()"
|
||||||
|
ngbPopover="OCR Templates" i18n-ngbPopover [disablePopover]="!slimSidebarPopoversEnabled" placement="end"
|
||||||
|
container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
|
||||||
|
<pngx-bs-icon class="me-2" name="bounding-box-circles"></pngx-bs-icon><span class="nav-link-label"><ng-container i18n>OCR Templates</ng-container></span>
|
||||||
|
</a>
|
||||||
|
@if (settingsService.organizingSidebarItems()) {
|
||||||
|
<pngx-input-switch class="position-absolute top-50 end-0 translate-middle-y me-1" [class.d-none]="slimSidebarEnabled || slimSidebarAnimating()" [compact]="true" title="OCR Templates" i18n-title [ngModel]="!settingsService.sidebarItemIsHidden(HideableSidebarItemID.OcrTemplates)" (ngModelChange)="toggleSidebarItem(HideableSidebarItemID.OcrTemplates, $event)"></pngx-input-switch>
|
||||||
|
}
|
||||||
|
</li>
|
||||||
<li class="nav-item app-link position-relative" [class.d-none]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Mail) && !settingsService.organizingSidebarItems()" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.MailAccount }"
|
<li class="nav-item app-link position-relative" [class.d-none]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Mail) && !settingsService.organizingSidebarItems()" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.MailAccount }"
|
||||||
tourAnchor="tour.mail">
|
tourAnchor="tour.mail">
|
||||||
<a class="nav-link" [class.opacity-50]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Mail)" [class.pe-5]="settingsService.organizingSidebarItems() && !slimSidebarEnabled && !slimSidebarAnimating()" routerLink="mail" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Mail"
|
<a class="nav-link" [class.opacity-50]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Mail)" [class.pe-5]="settingsService.organizingSidebarItems() && !slimSidebarEnabled && !slimSidebarAnimating()" routerLink="mail" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Mail"
|
||||||
|
|||||||
@@ -33,6 +33,7 @@ import { RemoteVersionService } from 'src/app/services/rest/remote-version.servi
|
|||||||
import { SavedViewService } from 'src/app/services/rest/saved-view.service'
|
import { SavedViewService } from 'src/app/services/rest/saved-view.service'
|
||||||
import { SearchService } from 'src/app/services/rest/search.service'
|
import { SearchService } from 'src/app/services/rest/search.service'
|
||||||
import { SettingsService } from 'src/app/services/settings.service'
|
import { SettingsService } from 'src/app/services/settings.service'
|
||||||
|
import { TaskNotificationService } from 'src/app/services/task-notification.service'
|
||||||
import { TasksService } from 'src/app/services/tasks.service'
|
import { TasksService } from 'src/app/services/tasks.service'
|
||||||
import { ToastService } from 'src/app/services/toast.service'
|
import { ToastService } from 'src/app/services/toast.service'
|
||||||
import { UploadDocumentsService } from 'src/app/services/upload-documents.service'
|
import { UploadDocumentsService } from 'src/app/services/upload-documents.service'
|
||||||
@@ -198,14 +199,14 @@ describe('AppFrameComponent', () => {
|
|||||||
fixture.detectChanges()
|
fixture.detectChanges()
|
||||||
})
|
})
|
||||||
|
|
||||||
it('refreshes and notifies on completion without client-side task tracking', () => {
|
it('refreshes and updates the task notification on completion', () => {
|
||||||
const list = TestBed.inject(DocumentListViewService)
|
const list = TestBed.inject(DocumentListViewService)
|
||||||
const reload = jest.spyOn(list, 'reload').mockImplementation(() => {})
|
const reload = jest.spyOn(list, 'reload').mockImplementation(() => {})
|
||||||
jest.spyOn(list, 'reduceSelectionToFilter').mockImplementation(() => {})
|
jest.spyOn(list, 'reduceSelectionToFilter').mockImplementation(() => {})
|
||||||
const tasksReload = jest
|
const tasksReload = jest
|
||||||
.spyOn(tasksService, 'reload')
|
.spyOn(tasksService, 'reload')
|
||||||
.mockImplementation(() => {})
|
.mockImplementation(() => {})
|
||||||
const success = jest.spyOn(toastService, 'showSuccess')
|
const success = jest.spyOn(toastService, 'show')
|
||||||
const refresh = jest
|
const refresh = jest
|
||||||
.spyOn(openDocumentsService, 'refreshDocument')
|
.spyOn(openDocumentsService, 'refreshDocument')
|
||||||
.mockImplementation(() => {})
|
.mockImplementation(() => {})
|
||||||
@@ -230,7 +231,12 @@ describe('AppFrameComponent', () => {
|
|||||||
expect(refresh).toHaveBeenCalledWith(document.id)
|
expect(refresh).toHaveBeenCalledWith(document.id)
|
||||||
expect(maybeRefreshSpy).toHaveBeenCalledTimes(1)
|
expect(maybeRefreshSpy).toHaveBeenCalledTimes(1)
|
||||||
expect(tasksReload).toHaveBeenCalledTimes(1)
|
expect(tasksReload).toHaveBeenCalledTimes(1)
|
||||||
expect(success).toHaveBeenCalledWith('Bulk operation completed.')
|
expect(success).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
id: 'task-bulk-task',
|
||||||
|
content: "Operation 'Set permissions' completed.",
|
||||||
|
})
|
||||||
|
)
|
||||||
fixture.destroy()
|
fixture.destroy()
|
||||||
bulkEvents.next({
|
bulkEvents.next({
|
||||||
task_id: 'bulk-task',
|
task_id: 'bulk-task',
|
||||||
@@ -245,14 +251,14 @@ describe('AppFrameComponent', () => {
|
|||||||
const reload = jest.spyOn(list, 'reload').mockImplementation(() => {})
|
const reload = jest.spyOn(list, 'reload').mockImplementation(() => {})
|
||||||
jest.spyOn(list, 'reduceSelectionToFilter').mockImplementation(() => {})
|
jest.spyOn(list, 'reduceSelectionToFilter').mockImplementation(() => {})
|
||||||
jest.spyOn(tasksService, 'reload').mockImplementation(() => {})
|
jest.spyOn(tasksService, 'reload').mockImplementation(() => {})
|
||||||
const error = jest.spyOn(toastService, 'showError')
|
const error = jest.spyOn(toastService, 'show')
|
||||||
const success = jest.spyOn(toastService, 'showSuccess')
|
const success = jest.spyOn(toastService, 'showSuccess')
|
||||||
for (const status of [
|
for (const status of [
|
||||||
PaperlessTaskStatus.Failure,
|
PaperlessTaskStatus.Failure,
|
||||||
PaperlessTaskStatus.Revoked,
|
PaperlessTaskStatus.Revoked,
|
||||||
]) {
|
]) {
|
||||||
bulkEvents.next({
|
bulkEvents.next({
|
||||||
task_id: 'bulk-task',
|
task_id: `${status}-task`,
|
||||||
operation: 'set_permissions',
|
operation: 'set_permissions',
|
||||||
status,
|
status,
|
||||||
error:
|
error:
|
||||||
@@ -262,11 +268,36 @@ describe('AppFrameComponent', () => {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
expect(reload).toHaveBeenCalledTimes(2)
|
expect(reload).toHaveBeenCalledTimes(2)
|
||||||
expect(error).toHaveBeenCalledWith(expect.any(String), 'Could not update')
|
|
||||||
expect(error).toHaveBeenCalledWith(
|
expect(error).toHaveBeenCalledWith(
|
||||||
'Bulk operation revoked.',
|
expect.objectContaining({
|
||||||
'Task expired before execution.'
|
content:
|
||||||
|
"Operation 'Set permissions' failed. Some changes may already have been applied.",
|
||||||
|
error: 'Could not update',
|
||||||
|
})
|
||||||
)
|
)
|
||||||
|
expect(error).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
content: "Operation 'Set permissions' revoked.",
|
||||||
|
error: 'Task expired before execution.',
|
||||||
|
})
|
||||||
|
)
|
||||||
|
expect(success).not.toHaveBeenCalled()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('passes delete completion to the shared task notification handler', () => {
|
||||||
|
const success = jest.spyOn(toastService, 'showSuccess')
|
||||||
|
const notifications = TestBed.inject(TaskNotificationService)
|
||||||
|
const handleStatus = jest.spyOn(notifications, 'complete')
|
||||||
|
bulkEvents.next({
|
||||||
|
task_id: 'delete-1',
|
||||||
|
operation: 'delete',
|
||||||
|
status: PaperlessTaskStatus.Success,
|
||||||
|
})
|
||||||
|
expect(handleStatus).toHaveBeenCalledWith({
|
||||||
|
task_id: 'delete-1',
|
||||||
|
operation: 'delete',
|
||||||
|
status: PaperlessTaskStatus.Success,
|
||||||
|
})
|
||||||
expect(success).not.toHaveBeenCalled()
|
expect(success).not.toHaveBeenCalled()
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -373,6 +404,7 @@ describe('AppFrameComponent', () => {
|
|||||||
HideableSidebarItemID.Dashboard,
|
HideableSidebarItemID.Dashboard,
|
||||||
HideableSidebarItemID.Workflows,
|
HideableSidebarItemID.Workflows,
|
||||||
HideableSidebarItemID.ShareLinks,
|
HideableSidebarItemID.ShareLinks,
|
||||||
|
HideableSidebarItemID.OcrTemplates,
|
||||||
])
|
])
|
||||||
fixture.detectChanges()
|
fixture.detectChanges()
|
||||||
|
|
||||||
@@ -388,6 +420,10 @@ describe('AppFrameComponent', () => {
|
|||||||
fixture.nativeElement.querySelector('[routerLink="share-links"]')
|
fixture.nativeElement.querySelector('[routerLink="share-links"]')
|
||||||
.parentElement.classList
|
.parentElement.classList
|
||||||
).toContain('d-none')
|
).toContain('d-none')
|
||||||
|
expect(
|
||||||
|
fixture.nativeElement.querySelector('[routerLink="ocr-templates"]')
|
||||||
|
.parentElement.classList
|
||||||
|
).toContain('d-none')
|
||||||
expect(
|
expect(
|
||||||
fixture.nativeElement.querySelector('[routerLink="mail"]').parentElement
|
fixture.nativeElement.querySelector('[routerLink="mail"]').parentElement
|
||||||
.classList
|
.classList
|
||||||
@@ -400,12 +436,21 @@ describe('AppFrameComponent', () => {
|
|||||||
])
|
])
|
||||||
settingsService.sidebarHiddenItemsEditing.set([
|
settingsService.sidebarHiddenItemsEditing.set([
|
||||||
HideableSidebarItemID.Dashboard,
|
HideableSidebarItemID.Dashboard,
|
||||||
|
HideableSidebarItemID.OcrTemplates,
|
||||||
])
|
])
|
||||||
fixture.detectChanges()
|
fixture.detectChanges()
|
||||||
|
|
||||||
expect(
|
expect(
|
||||||
fixture.nativeElement.querySelectorAll('pngx-input-switch').length
|
fixture.nativeElement.querySelectorAll('pngx-input-switch').length
|
||||||
).toBe(6)
|
).toBe(7)
|
||||||
|
const ocrTemplatesLink = fixture.nativeElement.querySelector(
|
||||||
|
'[routerLink="ocr-templates"]'
|
||||||
|
)
|
||||||
|
expect(ocrTemplatesLink.parentElement.classList).not.toContain('d-none')
|
||||||
|
expect(ocrTemplatesLink.classList).toContain('opacity-50')
|
||||||
|
expect(
|
||||||
|
ocrTemplatesLink.parentElement.querySelector('pngx-input-switch')
|
||||||
|
).not.toBeNull()
|
||||||
expect(
|
expect(
|
||||||
fixture.nativeElement.querySelector('[routerLink="dashboard"]')
|
fixture.nativeElement.querySelector('[routerLink="dashboard"]')
|
||||||
.parentElement.classList
|
.parentElement.classList
|
||||||
|
|||||||
@@ -57,6 +57,7 @@ import {
|
|||||||
} from 'src/app/services/rest/remote-version.service'
|
} from 'src/app/services/rest/remote-version.service'
|
||||||
import { SavedViewService } from 'src/app/services/rest/saved-view.service'
|
import { SavedViewService } from 'src/app/services/rest/saved-view.service'
|
||||||
import { SettingsService } from 'src/app/services/settings.service'
|
import { SettingsService } from 'src/app/services/settings.service'
|
||||||
|
import { TaskNotificationService } from 'src/app/services/task-notification.service'
|
||||||
import { TasksService } from 'src/app/services/tasks.service'
|
import { TasksService } from 'src/app/services/tasks.service'
|
||||||
import { ToastService } from 'src/app/services/toast.service'
|
import { ToastService } from 'src/app/services/toast.service'
|
||||||
import { UploadDocumentsService } from 'src/app/services/upload-documents.service'
|
import { UploadDocumentsService } from 'src/app/services/upload-documents.service'
|
||||||
@@ -115,6 +116,7 @@ export class AppFrameComponent
|
|||||||
settingsService = inject(SettingsService)
|
settingsService = inject(SettingsService)
|
||||||
tasksService = inject(TasksService)
|
tasksService = inject(TasksService)
|
||||||
private readonly toastService = inject(ToastService)
|
private readonly toastService = inject(ToastService)
|
||||||
|
private readonly taskNotifications = inject(TaskNotificationService)
|
||||||
private modalService = inject(NgbModal)
|
private modalService = inject(NgbModal)
|
||||||
permissionsService = inject(PermissionsService)
|
permissionsService = inject(PermissionsService)
|
||||||
private djangoMessagesService = inject(DjangoMessagesService)
|
private djangoMessagesService = inject(DjangoMessagesService)
|
||||||
@@ -182,9 +184,11 @@ export class AppFrameComponent
|
|||||||
),
|
),
|
||||||
takeUntilDestroyed(this.destroyRef)
|
takeUntilDestroyed(this.destroyRef)
|
||||||
)
|
)
|
||||||
.subscribe(({ status, error }) => {
|
.subscribe((result) => {
|
||||||
this.documentList.reload(null, false)
|
this.documentList.reload(null, false)
|
||||||
|
if (!this.documentList.allSelected) {
|
||||||
this.documentList.reduceSelectionToFilter()
|
this.documentList.reduceSelectionToFilter()
|
||||||
|
}
|
||||||
// maybe someday we can optimize to only refresh affected documents
|
// maybe someday we can optimize to only refresh affected documents
|
||||||
this.openDocumentsService.getOpenDocuments().forEach((doc) => {
|
this.openDocumentsService.getOpenDocuments().forEach((doc) => {
|
||||||
this.openDocumentsService.refreshDocument(doc.id)
|
this.openDocumentsService.refreshDocument(doc.id)
|
||||||
@@ -198,16 +202,7 @@ export class AppFrameComponent
|
|||||||
) {
|
) {
|
||||||
this.tasksService.reload()
|
this.tasksService.reload()
|
||||||
}
|
}
|
||||||
if (status === PaperlessTaskStatus.Success) {
|
this.taskNotifications.complete(result)
|
||||||
this.toastService.showSuccess($localize`Bulk operation completed.`)
|
|
||||||
} else if (status === PaperlessTaskStatus.Revoked) {
|
|
||||||
this.toastService.showError($localize`Bulk operation revoked.`, error)
|
|
||||||
} else {
|
|
||||||
this.toastService.showError(
|
|
||||||
$localize`Bulk operation failed. Some changes may already have been applied.`,
|
|
||||||
error
|
|
||||||
)
|
|
||||||
}
|
|
||||||
})
|
})
|
||||||
|
|
||||||
this.lastScrollY = window.scrollY
|
this.lastScrollY = window.scrollY
|
||||||
|
|||||||
@@ -188,6 +188,62 @@ describe('ChatComponent', () => {
|
|||||||
expect(component.loading()).toBe(false)
|
expect(component.loading()).toBe(false)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('should reveal a complete answer within one second', () => {
|
||||||
|
component.input.set('Hello')
|
||||||
|
component.sendMessage()
|
||||||
|
|
||||||
|
const answer = 'A'.repeat(660)
|
||||||
|
mockStream$.next(answer)
|
||||||
|
mockStream$.complete()
|
||||||
|
|
||||||
|
expect(component.messages()[1].content.length).toBeGreaterThan(0)
|
||||||
|
expect(component.messages()[1].content.length).toBeLessThan(answer.length)
|
||||||
|
expect(component.loading()).toBe(true)
|
||||||
|
|
||||||
|
jest.advanceTimersByTime(800)
|
||||||
|
expect(component.messages()[1].content).toBe(answer)
|
||||||
|
expect(component.loading()).toBe(false)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should give a long answer more time to reveal', () => {
|
||||||
|
component.input.set('Hello')
|
||||||
|
component.sendMessage()
|
||||||
|
|
||||||
|
const answer = 'A'.repeat(3000)
|
||||||
|
mockStream$.next(answer)
|
||||||
|
mockStream$.complete()
|
||||||
|
|
||||||
|
jest.advanceTimersByTime(800)
|
||||||
|
expect(component.messages()[1].content.length).toBeLessThan(answer.length)
|
||||||
|
expect(component.loading()).toBe(true)
|
||||||
|
|
||||||
|
jest.advanceTimersByTime(2500)
|
||||||
|
expect(component.messages()[1].content).toBe(answer)
|
||||||
|
expect(component.loading()).toBe(false)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should reveal fast incoming chunks without making them pop in', () => {
|
||||||
|
component.input.set('Hello')
|
||||||
|
component.sendMessage()
|
||||||
|
|
||||||
|
let answer = ''
|
||||||
|
for (let i = 0; i < 20; i++) {
|
||||||
|
answer += 'A'.repeat(100)
|
||||||
|
const visibleBefore = component.messages()[1].content.length
|
||||||
|
mockStream$.next(answer)
|
||||||
|
jest.advanceTimersByTime(10)
|
||||||
|
expect(
|
||||||
|
component.messages()[1].content.length - visibleBefore
|
||||||
|
).toBeLessThan(100)
|
||||||
|
}
|
||||||
|
expect(component.messages()[1].content.length).toBeLessThan(answer.length)
|
||||||
|
|
||||||
|
mockStream$.complete()
|
||||||
|
jest.advanceTimersByTime(5200)
|
||||||
|
expect(component.messages()[1].content).toBe(answer)
|
||||||
|
expect(component.loading()).toBe(false)
|
||||||
|
})
|
||||||
|
|
||||||
it('should show a slow response message while waiting', () => {
|
it('should show a slow response message while waiting', () => {
|
||||||
component.input.set('Hello')
|
component.input.set('Hello')
|
||||||
component.sendMessage()
|
component.sendMessage()
|
||||||
|
|||||||
@@ -21,6 +21,9 @@ import {
|
|||||||
import { pngxPopperOptions } from 'src/app/utils/popper-options'
|
import { pngxPopperOptions } from 'src/app/utils/popper-options'
|
||||||
|
|
||||||
const SLOW_RESPONSE_DELAY_MS = 8000
|
const SLOW_RESPONSE_DELAY_MS = 8000
|
||||||
|
const TYPEWRITER_MIN_DURATION_MS = 750
|
||||||
|
const TYPEWRITER_MAX_DURATION_MS = 3000
|
||||||
|
const TYPEWRITER_INTERVAL_MS = 16
|
||||||
|
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'pngx-chat',
|
selector: 'pngx-chat',
|
||||||
@@ -73,6 +76,7 @@ export class ChatComponent implements OnInit {
|
|||||||
private typewriterBuffer: string[] = []
|
private typewriterBuffer: string[] = []
|
||||||
private typewriterActive = false
|
private typewriterActive = false
|
||||||
private typewriterTimeout: ReturnType<typeof setTimeout>
|
private typewriterTimeout: ReturnType<typeof setTimeout>
|
||||||
|
private typewriterDeadline = 0
|
||||||
private streamSubscription: Subscription
|
private streamSubscription: Subscription
|
||||||
private streamingMessage: ChatMessage
|
private streamingMessage: ChatMessage
|
||||||
private streamFinished = false
|
private streamFinished = false
|
||||||
@@ -134,7 +138,7 @@ export class ChatComponent implements OnInit {
|
|||||||
if (nextResponse.content.length < lastVisibleContent.length) {
|
if (nextResponse.content.length < lastVisibleContent.length) {
|
||||||
this.resetTypewriter(assistantMessage, nextResponse.content)
|
this.resetTypewriter(assistantMessage, nextResponse.content)
|
||||||
lastVisibleContent = nextResponse.content
|
lastVisibleContent = nextResponse.content
|
||||||
} else {
|
} else if (nextResponse.content.length > lastVisibleContent.length) {
|
||||||
const visibleDelta = nextResponse.content.substring(
|
const visibleDelta = nextResponse.content.substring(
|
||||||
lastVisibleContent.length
|
lastVisibleContent.length
|
||||||
)
|
)
|
||||||
@@ -214,6 +218,12 @@ export class ChatComponent implements OnInit {
|
|||||||
if (!chunk) return
|
if (!chunk) return
|
||||||
|
|
||||||
this.typewriterBuffer.push(...chunk.split(''))
|
this.typewriterBuffer.push(...chunk.split(''))
|
||||||
|
// Longer bursts need more time to remain readable as the chat scrolls.
|
||||||
|
const revealDuration = Math.min(
|
||||||
|
TYPEWRITER_MAX_DURATION_MS,
|
||||||
|
Math.max(TYPEWRITER_MIN_DURATION_MS, this.typewriterBuffer.length)
|
||||||
|
)
|
||||||
|
this.typewriterDeadline = Date.now() + revealDuration
|
||||||
|
|
||||||
if (!this.typewriterActive) {
|
if (!this.typewriterActive) {
|
||||||
this.typewriterActive = true
|
this.typewriterActive = true
|
||||||
@@ -222,19 +232,29 @@ export class ChatComponent implements OnInit {
|
|||||||
}
|
}
|
||||||
|
|
||||||
playTypewriter(message: ChatMessage): void {
|
playTypewriter(message: ChatMessage): void {
|
||||||
if (this.typewriterBuffer.length === 0) {
|
// Spread the queued text across the updates left before the deadline
|
||||||
this.typewriterActive = false
|
const remainingUpdates = Math.max(
|
||||||
if (this.streamFinished) this.finishStreaming(message)
|
1,
|
||||||
return
|
Math.ceil((this.typewriterDeadline - Date.now()) / TYPEWRITER_INTERVAL_MS)
|
||||||
}
|
)
|
||||||
|
const charactersToShow = Math.ceil(
|
||||||
const nextChar = this.typewriterBuffer.shift()
|
this.typewriterBuffer.length / remainingUpdates
|
||||||
message.content += nextChar
|
)
|
||||||
|
message.content += this.typewriterBuffer
|
||||||
|
.splice(0, charactersToShow)
|
||||||
|
.join('')
|
||||||
this.notifyMessagesChanged()
|
this.notifyMessagesChanged()
|
||||||
this.scrollToBottom()
|
this.scrollToBottom()
|
||||||
|
|
||||||
// 10ms per character
|
if (this.typewriterBuffer.length === 0) {
|
||||||
this.typewriterTimeout = setTimeout(() => this.playTypewriter(message), 10)
|
this.typewriterActive = false
|
||||||
|
if (this.streamFinished) this.finishStreaming(message)
|
||||||
|
} else {
|
||||||
|
this.typewriterTimeout = setTimeout(
|
||||||
|
() => this.playTypewriter(message),
|
||||||
|
TYPEWRITER_INTERVAL_MS
|
||||||
|
)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private notifyMessagesChanged(): void {
|
private notifyMessagesChanged(): void {
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ import basket from 'bootstrap-icons/icons/basket.svg'
|
|||||||
import bell from 'bootstrap-icons/icons/bell.svg'
|
import bell from 'bootstrap-icons/icons/bell.svg'
|
||||||
import bodyText from 'bootstrap-icons/icons/body-text.svg'
|
import bodyText from 'bootstrap-icons/icons/body-text.svg'
|
||||||
import bookmark from 'bootstrap-icons/icons/bookmark.svg'
|
import bookmark from 'bootstrap-icons/icons/bookmark.svg'
|
||||||
|
import boundingBoxCircles from 'bootstrap-icons/icons/bounding-box-circles.svg'
|
||||||
import boxArrowInRight from 'bootstrap-icons/icons/box-arrow-in-right.svg'
|
import boxArrowInRight from 'bootstrap-icons/icons/box-arrow-in-right.svg'
|
||||||
import boxArrowUpRight from 'bootstrap-icons/icons/box-arrow-up-right.svg'
|
import boxArrowUpRight from 'bootstrap-icons/icons/box-arrow-up-right.svg'
|
||||||
import boxArrowUp from 'bootstrap-icons/icons/box-arrow-up.svg'
|
import boxArrowUp from 'bootstrap-icons/icons/box-arrow-up.svg'
|
||||||
@@ -77,6 +78,7 @@ import fileEarmarkMinus from 'bootstrap-icons/icons/file-earmark-minus.svg'
|
|||||||
import fileEarmarkPerson from 'bootstrap-icons/icons/file-earmark-person.svg'
|
import fileEarmarkPerson from 'bootstrap-icons/icons/file-earmark-person.svg'
|
||||||
import fileEarmarkPlus from 'bootstrap-icons/icons/file-earmark-plus.svg'
|
import fileEarmarkPlus from 'bootstrap-icons/icons/file-earmark-plus.svg'
|
||||||
import fileEarmarkRichtext from 'bootstrap-icons/icons/file-earmark-richtext.svg'
|
import fileEarmarkRichtext from 'bootstrap-icons/icons/file-earmark-richtext.svg'
|
||||||
|
import fileEarmarkRuled from 'bootstrap-icons/icons/file-earmark-ruled.svg'
|
||||||
import fileEarmarkSpreadsheet from 'bootstrap-icons/icons/file-earmark-spreadsheet.svg'
|
import fileEarmarkSpreadsheet from 'bootstrap-icons/icons/file-earmark-spreadsheet.svg'
|
||||||
import fileEarmark from 'bootstrap-icons/icons/file-earmark.svg'
|
import fileEarmark from 'bootstrap-icons/icons/file-earmark.svg'
|
||||||
import fileText from 'bootstrap-icons/icons/file-text.svg'
|
import fileText from 'bootstrap-icons/icons/file-text.svg'
|
||||||
@@ -118,6 +120,7 @@ import personFill from 'bootstrap-icons/icons/person-fill.svg'
|
|||||||
import personLock from 'bootstrap-icons/icons/person-lock.svg'
|
import personLock from 'bootstrap-icons/icons/person-lock.svg'
|
||||||
import personSquare from 'bootstrap-icons/icons/person-square.svg'
|
import personSquare from 'bootstrap-icons/icons/person-square.svg'
|
||||||
import person from 'bootstrap-icons/icons/person.svg'
|
import person from 'bootstrap-icons/icons/person.svg'
|
||||||
|
import playCircle from 'bootstrap-icons/icons/play-circle.svg'
|
||||||
import playFill from 'bootstrap-icons/icons/play-fill.svg'
|
import playFill from 'bootstrap-icons/icons/play-fill.svg'
|
||||||
import plusCircle from 'bootstrap-icons/icons/plus-circle.svg'
|
import plusCircle from 'bootstrap-icons/icons/plus-circle.svg'
|
||||||
import plus from 'bootstrap-icons/icons/plus.svg'
|
import plus from 'bootstrap-icons/icons/plus.svg'
|
||||||
@@ -130,6 +133,7 @@ import search from 'bootstrap-icons/icons/search.svg'
|
|||||||
import send from 'bootstrap-icons/icons/send.svg'
|
import send from 'bootstrap-icons/icons/send.svg'
|
||||||
import shop from 'bootstrap-icons/icons/shop.svg'
|
import shop from 'bootstrap-icons/icons/shop.svg'
|
||||||
import slashCircle from 'bootstrap-icons/icons/slash-circle.svg'
|
import slashCircle from 'bootstrap-icons/icons/slash-circle.svg'
|
||||||
|
import sliders2 from 'bootstrap-icons/icons/sliders2.svg'
|
||||||
import sliders2Vertical from 'bootstrap-icons/icons/sliders2-vertical.svg'
|
import sliders2Vertical from 'bootstrap-icons/icons/sliders2-vertical.svg'
|
||||||
import sortAlphaDown from 'bootstrap-icons/icons/sort-alpha-down.svg'
|
import sortAlphaDown from 'bootstrap-icons/icons/sort-alpha-down.svg'
|
||||||
import sortAlphaUpAlt from 'bootstrap-icons/icons/sort-alpha-up-alt.svg'
|
import sortAlphaUpAlt from 'bootstrap-icons/icons/sort-alpha-up-alt.svg'
|
||||||
@@ -178,6 +182,7 @@ export const icons: Record<string, string> = {
|
|||||||
braces,
|
braces,
|
||||||
bodyText,
|
bodyText,
|
||||||
bookmark,
|
bookmark,
|
||||||
|
boundingBoxCircles,
|
||||||
boxArrowInRight,
|
boxArrowInRight,
|
||||||
boxArrowUp,
|
boxArrowUp,
|
||||||
boxArrowUpRight,
|
boxArrowUpRight,
|
||||||
@@ -239,6 +244,7 @@ export const icons: Record<string, string> = {
|
|||||||
fileEarmarkPerson,
|
fileEarmarkPerson,
|
||||||
fileEarmarkPlus,
|
fileEarmarkPlus,
|
||||||
fileEarmarkRichtext,
|
fileEarmarkRichtext,
|
||||||
|
fileEarmarkRuled,
|
||||||
fileEarmarkSpreadsheet,
|
fileEarmarkSpreadsheet,
|
||||||
files,
|
files,
|
||||||
fileText,
|
fileText,
|
||||||
@@ -279,6 +285,7 @@ export const icons: Record<string, string> = {
|
|||||||
personFillLock,
|
personFillLock,
|
||||||
personLock,
|
personLock,
|
||||||
personSquare,
|
personSquare,
|
||||||
|
playCircle,
|
||||||
playFill,
|
playFill,
|
||||||
plus,
|
plus,
|
||||||
plusCircle,
|
plusCircle,
|
||||||
@@ -290,6 +297,7 @@ export const icons: Record<string, string> = {
|
|||||||
search,
|
search,
|
||||||
send,
|
send,
|
||||||
slashCircle,
|
slashCircle,
|
||||||
|
sliders2,
|
||||||
shop,
|
shop,
|
||||||
sliders2Vertical,
|
sliders2Vertical,
|
||||||
sortAlphaDown,
|
sortAlphaDown,
|
||||||
|
|||||||
+37
@@ -0,0 +1,37 @@
|
|||||||
|
<div class="modal-header">
|
||||||
|
<h4 class="modal-title" id="modal-basic-title">{{title}}</h4>
|
||||||
|
<button type="button" class="btn-close" aria-label="Close" (click)="cancel()">
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
<div class="modal-body">
|
||||||
|
@if (message) {
|
||||||
|
<p class="text-break" [innerHTML]="message"></p>
|
||||||
|
}
|
||||||
|
<div class="mb-3">
|
||||||
|
<label class="form-label" for="runWorkflowSelect" i18n>Workflow</label>
|
||||||
|
<select class="form-select" id="runWorkflowSelect" [(ngModel)]="workflowId" (ngModelChange)="workflowSelected()">
|
||||||
|
<option [ngValue]="null" disabled i18n>Select a workflow</option>
|
||||||
|
@for (workflow of workflows; track workflow.id) {
|
||||||
|
<option [ngValue]="workflow.id">{{workflow.name}}</option>
|
||||||
|
}
|
||||||
|
</select>
|
||||||
|
</div>
|
||||||
|
<div class="form-check">
|
||||||
|
<input class="form-check-input" type="checkbox" id="runWorkflowForce" [(ngModel)]="force" />
|
||||||
|
@if (singleDocument) {
|
||||||
|
<label class="form-check-label" for="runWorkflowForce" i18n>Run on this document regardless of trigger filters</label>
|
||||||
|
<div class="form-text" i18n>Ignore the workflow's trigger filters for this document.</div>
|
||||||
|
} @else {
|
||||||
|
<label class="form-check-label" for="runWorkflowForce" i18n>Run on all selected documents</label>
|
||||||
|
<div class="form-text" i18n>Ignore the workflow's trigger filters and run on every selected document.</div>
|
||||||
|
}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="modal-footer">
|
||||||
|
<button type="button" class="btn" [class]="cancelBtnClass" (click)="cancel()" [disabled]="!buttonsEnabled">
|
||||||
|
<span class="d-inline-block" style="padding-bottom: 1px;">{{cancelBtnCaption}}</span>
|
||||||
|
</button>
|
||||||
|
<button type="button" class="btn" [class]="btnClass" (click)="confirm()" [disabled]="!confirmButtonEnabled || !buttonsEnabled">
|
||||||
|
{{btnCaption}}
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
+63
@@ -0,0 +1,63 @@
|
|||||||
|
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
||||||
|
import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
|
||||||
|
import { RunWorkflowConfirmDialogComponent } from './run-workflow-confirm-dialog.component'
|
||||||
|
|
||||||
|
describe('RunWorkflowConfirmDialogComponent', () => {
|
||||||
|
let component: RunWorkflowConfirmDialogComponent
|
||||||
|
let fixture: ComponentFixture<RunWorkflowConfirmDialogComponent>
|
||||||
|
|
||||||
|
beforeEach(async () => {
|
||||||
|
TestBed.configureTestingModule({
|
||||||
|
providers: [NgbActiveModal],
|
||||||
|
imports: [RunWorkflowConfirmDialogComponent],
|
||||||
|
}).compileComponents()
|
||||||
|
|
||||||
|
fixture = TestBed.createComponent(RunWorkflowConfirmDialogComponent)
|
||||||
|
component = fixture.componentInstance
|
||||||
|
component.workflows = [{ id: 5, name: 'Manual workflow' } as any]
|
||||||
|
fixture.detectChanges()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should disable confirm until a workflow is selected and not force by default', () => {
|
||||||
|
expect(component.confirmButtonEnabled).toBeFalsy()
|
||||||
|
expect(component.force).toBeFalsy()
|
||||||
|
|
||||||
|
component.workflowId = 5
|
||||||
|
component.workflowSelected()
|
||||||
|
expect(component.confirmButtonEnabled).toBeTruthy()
|
||||||
|
|
||||||
|
component.workflowId = null
|
||||||
|
component.workflowSelected()
|
||||||
|
expect(component.confirmButtonEnabled).toBeFalsy()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should render an option per workflow', () => {
|
||||||
|
const options = fixture.nativeElement.querySelectorAll(
|
||||||
|
'#runWorkflowSelect option'
|
||||||
|
)
|
||||||
|
// placeholder option + one per workflow
|
||||||
|
expect(options).toHaveLength(2)
|
||||||
|
expect(options[1].textContent).toContain('Manual workflow')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should describe the checkbox for a selection or a single document', async () => {
|
||||||
|
const checkbox = fixture.nativeElement.querySelector('#runWorkflowForce')
|
||||||
|
expect(checkbox.checked).toBe(false)
|
||||||
|
expect(fixture.nativeElement.textContent).toContain(
|
||||||
|
'Run on all selected documents'
|
||||||
|
)
|
||||||
|
|
||||||
|
component.singleDocument = true
|
||||||
|
component.force = true
|
||||||
|
fixture.detectChanges()
|
||||||
|
await fixture.whenStable()
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(checkbox.checked).toBe(true)
|
||||||
|
expect(fixture.nativeElement.textContent).toContain(
|
||||||
|
'Run on this document regardless of trigger filters'
|
||||||
|
)
|
||||||
|
expect(fixture.nativeElement.textContent).not.toContain(
|
||||||
|
'Run on all selected documents'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
+26
@@ -0,0 +1,26 @@
|
|||||||
|
import { Component } from '@angular/core'
|
||||||
|
import { FormsModule } from '@angular/forms'
|
||||||
|
import { Workflow } from 'src/app/data/workflow'
|
||||||
|
import { ConfirmDialogComponent } from '../confirm-dialog.component'
|
||||||
|
|
||||||
|
@Component({
|
||||||
|
selector: 'pngx-run-workflow-confirm-dialog',
|
||||||
|
templateUrl: './run-workflow-confirm-dialog.component.html',
|
||||||
|
imports: [FormsModule],
|
||||||
|
})
|
||||||
|
export class RunWorkflowConfirmDialogComponent extends ConfirmDialogComponent {
|
||||||
|
public workflows: Workflow[] = []
|
||||||
|
|
||||||
|
public workflowId: number = null
|
||||||
|
|
||||||
|
public singleDocument: boolean = false
|
||||||
|
|
||||||
|
// i.e. ignore the workflow's trigger filters
|
||||||
|
public force: boolean = false
|
||||||
|
|
||||||
|
override confirmButtonEnabled = false
|
||||||
|
|
||||||
|
public workflowSelected(): void {
|
||||||
|
this.confirmButtonEnabled = !!this.workflowId
|
||||||
|
}
|
||||||
|
}
|
||||||
+30
@@ -0,0 +1,30 @@
|
|||||||
|
<div class="modal-header">
|
||||||
|
<h4 class="modal-title" id="modal-basic-title">{{title}}</h4>
|
||||||
|
<button type="button" class="btn-close" aria-label="Close" (click)="cancel()">
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
<div class="modal-body">
|
||||||
|
@if (messageBold) {
|
||||||
|
<p class="text-break"><b>{{messageBold}}</b></p>
|
||||||
|
}
|
||||||
|
@if (message) {
|
||||||
|
<p class="text-break" [innerHTML]="message"></p>
|
||||||
|
}
|
||||||
|
<pngx-input-select
|
||||||
|
[items]="templates()"
|
||||||
|
[(ngModel)]="template"
|
||||||
|
[allowNull]="true"
|
||||||
|
title="OCR template"
|
||||||
|
i18n-title
|
||||||
|
placeholder="All matching templates"
|
||||||
|
i18n-placeholder
|
||||||
|
></pngx-input-select>
|
||||||
|
</div>
|
||||||
|
<div class="modal-footer">
|
||||||
|
<button type="button" class="btn" [class]="cancelBtnClass" (click)="cancel()" [disabled]="!buttonsEnabled()">
|
||||||
|
<span class="d-inline-block" style="padding-bottom: 1px;">{{cancelBtnCaption}}</span>
|
||||||
|
</button>
|
||||||
|
<button type="button" class="btn" [class]="btnClass" (click)="confirm()" [disabled]="!confirmButtonEnabled || !buttonsEnabled()">
|
||||||
|
{{btnCaption}}
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
+52
@@ -0,0 +1,52 @@
|
|||||||
|
import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
|
||||||
|
import { provideHttpClientTesting } from '@angular/common/http/testing'
|
||||||
|
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
||||||
|
import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
|
||||||
|
import { of } from 'rxjs'
|
||||||
|
import { MATCH_NONE } from 'src/app/data/matching-model'
|
||||||
|
import { OcrTemplate } from 'src/app/data/ocr-template'
|
||||||
|
import { OcrTemplateService } from 'src/app/services/rest/ocr-template.service'
|
||||||
|
import { ZoneOcrConfirmDialogComponent } from './zone-ocr-confirm-dialog.component'
|
||||||
|
|
||||||
|
const templates: OcrTemplate[] = [
|
||||||
|
{
|
||||||
|
id: 1,
|
||||||
|
name: 'Invoices',
|
||||||
|
match: '',
|
||||||
|
matching_algorithm: MATCH_NONE,
|
||||||
|
sample_document: null,
|
||||||
|
source_width: 0,
|
||||||
|
source_height: 0,
|
||||||
|
enabled: true,
|
||||||
|
zones: [],
|
||||||
|
},
|
||||||
|
]
|
||||||
|
|
||||||
|
describe('ZoneOcrConfirmDialogComponent', () => {
|
||||||
|
let component: ZoneOcrConfirmDialogComponent
|
||||||
|
let fixture: ComponentFixture<ZoneOcrConfirmDialogComponent>
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
TestBed.configureTestingModule({
|
||||||
|
providers: [
|
||||||
|
NgbActiveModal,
|
||||||
|
provideHttpClient(withInterceptorsFromDi()),
|
||||||
|
provideHttpClientTesting(),
|
||||||
|
],
|
||||||
|
imports: [ZoneOcrConfirmDialogComponent],
|
||||||
|
})
|
||||||
|
jest
|
||||||
|
.spyOn(TestBed.inject(OcrTemplateService), 'listAll')
|
||||||
|
.mockReturnValue(of({ count: 1, all: [1], results: templates }))
|
||||||
|
|
||||||
|
fixture = TestBed.createComponent(ZoneOcrConfirmDialogComponent)
|
||||||
|
component = fixture.componentInstance
|
||||||
|
fixture.detectChanges()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should offer templates and default to all matching templates', () => {
|
||||||
|
expect(component.templates()).toEqual(templates)
|
||||||
|
expect(component.template).toBeNull()
|
||||||
|
expect(fixture.nativeElement.textContent).toContain('OCR template')
|
||||||
|
})
|
||||||
|
})
|
||||||
+31
@@ -0,0 +1,31 @@
|
|||||||
|
import { Component, OnInit, inject, signal } from '@angular/core'
|
||||||
|
import { FormsModule } from '@angular/forms'
|
||||||
|
import { takeUntil } from 'rxjs'
|
||||||
|
import { OcrTemplate } from 'src/app/data/ocr-template'
|
||||||
|
import { OcrTemplateService } from 'src/app/services/rest/ocr-template.service'
|
||||||
|
import { SelectComponent } from '../../input/select/select.component'
|
||||||
|
import { ConfirmDialogComponent } from '../confirm-dialog.component'
|
||||||
|
|
||||||
|
@Component({
|
||||||
|
selector: 'pngx-zone-ocr-confirm-dialog',
|
||||||
|
templateUrl: './zone-ocr-confirm-dialog.component.html',
|
||||||
|
imports: [FormsModule, SelectComponent],
|
||||||
|
})
|
||||||
|
export class ZoneOcrConfirmDialogComponent
|
||||||
|
extends ConfirmDialogComponent
|
||||||
|
implements OnInit
|
||||||
|
{
|
||||||
|
private readonly ocrTemplateService = inject(OcrTemplateService)
|
||||||
|
|
||||||
|
public readonly templates = signal<OcrTemplate[]>([])
|
||||||
|
|
||||||
|
/** The template to run, or null for every template that matches. */
|
||||||
|
template: number | null = null
|
||||||
|
|
||||||
|
ngOnInit() {
|
||||||
|
this.ocrTemplateService
|
||||||
|
.listAll()
|
||||||
|
.pipe(takeUntil(this.unsubscribeNotifier))
|
||||||
|
.subscribe((r) => this.templates.set(r.results))
|
||||||
|
}
|
||||||
|
}
|
||||||
+2
-2
@@ -164,7 +164,7 @@
|
|||||||
<pngx-input-text i18n-title title="Filter path" formControlName="filter_path" horizontal="true" i18n-hint hint="Apply to documents that match this path. Wildcards specified as * are allowed. Case-normalized." [error]="error?.filter_path"></pngx-input-text>
|
<pngx-input-text i18n-title title="Filter path" formControlName="filter_path" horizontal="true" i18n-hint hint="Apply to documents that match this path. Wildcards specified as * are allowed. Case-normalized." [error]="error?.filter_path"></pngx-input-text>
|
||||||
<pngx-input-select i18n-title title="Filter mail rule" [items]="mailRules()" horizontal="true" [allowNull]="true" formControlName="filter_mailrule" i18n-hint hint="Apply to documents consumed via this mail rule." [error]="error?.filter_mailrule"></pngx-input-select>
|
<pngx-input-select i18n-title title="Filter mail rule" [items]="mailRules()" horizontal="true" [allowNull]="true" formControlName="filter_mailrule" i18n-hint hint="Apply to documents consumed via this mail rule." [error]="error?.filter_mailrule"></pngx-input-select>
|
||||||
}
|
}
|
||||||
@if (formGroup.get('type').value === WorkflowTriggerType.DocumentAdded || formGroup.get('type').value === WorkflowTriggerType.DocumentUpdated || formGroup.get('type').value === WorkflowTriggerType.Scheduled) {
|
@if (formGroup.get('type').value === WorkflowTriggerType.DocumentAdded || formGroup.get('type').value === WorkflowTriggerType.DocumentUpdated || formGroup.get('type').value === WorkflowTriggerType.Scheduled || formGroup.get('type').value === WorkflowTriggerType.Manual) {
|
||||||
<pngx-input-select i18n-title title="Content matching algorithm" horizontal="true" [items]="getMatchingAlgorithms()" formControlName="matching_algorithm"></pngx-input-select>
|
<pngx-input-select i18n-title title="Content matching algorithm" horizontal="true" [items]="getMatchingAlgorithms()" formControlName="matching_algorithm"></pngx-input-select>
|
||||||
@if (matchingPatternRequired(formGroup)) {
|
@if (matchingPatternRequired(formGroup)) {
|
||||||
<pngx-input-text i18n-title title="Content matching pattern" horizontal="true" formControlName="match" [error]="error?.match"></pngx-input-text>
|
<pngx-input-text i18n-title title="Content matching pattern" horizontal="true" formControlName="match" [error]="error?.match"></pngx-input-text>
|
||||||
@@ -175,7 +175,7 @@
|
|||||||
}
|
}
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@if (formGroup.get('type').value === WorkflowTriggerType.DocumentAdded || formGroup.get('type').value === WorkflowTriggerType.DocumentUpdated || formGroup.get('type').value === WorkflowTriggerType.Scheduled) {
|
@if (formGroup.get('type').value === WorkflowTriggerType.DocumentAdded || formGroup.get('type').value === WorkflowTriggerType.DocumentUpdated || formGroup.get('type').value === WorkflowTriggerType.Scheduled || formGroup.get('type').value === WorkflowTriggerType.Manual) {
|
||||||
<div class="row mt-3">
|
<div class="row mt-3">
|
||||||
<div class="col">
|
<div class="col">
|
||||||
<div class="trigger-filters mb-3">
|
<div class="trigger-filters mb-3">
|
||||||
|
|||||||
+4
@@ -123,6 +123,10 @@ export const WORKFLOW_TYPE_OPTIONS = [
|
|||||||
id: WorkflowTriggerType.Scheduled,
|
id: WorkflowTriggerType.Scheduled,
|
||||||
name: $localize`Scheduled`,
|
name: $localize`Scheduled`,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
id: WorkflowTriggerType.Manual,
|
||||||
|
name: $localize`Manual`,
|
||||||
|
},
|
||||||
]
|
]
|
||||||
|
|
||||||
export const WORKFLOW_ACTION_OPTIONS = [
|
export const WORKFLOW_ACTION_OPTIONS = [
|
||||||
|
|||||||
@@ -40,7 +40,7 @@
|
|||||||
(change)="onChange(selectedDocumentIDs)">
|
(change)="onChange(selectedDocumentIDs)">
|
||||||
<ng-template ng-label-tmp let-document="item">
|
<ng-template ng-label-tmp let-document="item">
|
||||||
<div class="d-flex align-items-center">
|
<div class="d-flex align-items-center">
|
||||||
@if (!disabled) {
|
@if (!disabled && multiple) {
|
||||||
<button class="btn p-0 lh-1" (click)="unselect(document)" (mousedown)="$event.stopImmediatePropagation()" type="button" title="Remove link" i18n-title><pngx-bs-icon name="x"></pngx-bs-icon></button>
|
<button class="btn p-0 lh-1" (click)="unselect(document)" (mousedown)="$event.stopImmediatePropagation()" type="button" title="Remove link" i18n-title><pngx-bs-icon name="x"></pngx-bs-icon></button>
|
||||||
}
|
}
|
||||||
@if (document.title) {
|
@if (document.title) {
|
||||||
|
|||||||
@@ -81,6 +81,9 @@ export class DocumentLinkComponent
|
|||||||
@Input()
|
@Input()
|
||||||
placeholder: string = $localize`Search for documents`
|
placeholder: string = $localize`Search for documents`
|
||||||
|
|
||||||
|
@Input()
|
||||||
|
multiple: boolean = true
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parent for ng-select dropdown, needed to prevent close on click.
|
* Parent for ng-select dropdown, needed to prevent close on click.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -0,0 +1,90 @@
|
|||||||
|
import { provideHttpClient } from '@angular/common/http'
|
||||||
|
import { provideHttpClientTesting } from '@angular/common/http/testing'
|
||||||
|
import { Component } from '@angular/core'
|
||||||
|
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
||||||
|
import { FormControl, ReactiveFormsModule } from '@angular/forms'
|
||||||
|
import { NumberComponent } from './number/number.component'
|
||||||
|
import { TextComponent } from './text/text.component'
|
||||||
|
import { TextAreaComponent } from './textarea/textarea.component'
|
||||||
|
import { UrlComponent } from './url/url.component'
|
||||||
|
|
||||||
|
@Component({
|
||||||
|
imports: [
|
||||||
|
ReactiveFormsModule,
|
||||||
|
TextComponent,
|
||||||
|
NumberComponent,
|
||||||
|
TextAreaComponent,
|
||||||
|
UrlComponent,
|
||||||
|
],
|
||||||
|
template: `
|
||||||
|
<pngx-input-text [formControl]="control" />
|
||||||
|
<pngx-input-number [formControl]="control" [showAdd]="false" />
|
||||||
|
<pngx-input-textarea [formControl]="control" />
|
||||||
|
<pngx-input-url [formControl]="control" />
|
||||||
|
`,
|
||||||
|
})
|
||||||
|
class InputEventsHostComponent {
|
||||||
|
control = new FormControl<string | number | null>(null)
|
||||||
|
}
|
||||||
|
|
||||||
|
describe.each([
|
||||||
|
['text', 'pngx-input-text input', 'Edited text', 'Edited text'],
|
||||||
|
['number', 'pngx-input-number input', '42', 42],
|
||||||
|
['textarea', 'pngx-input-textarea textarea', 'Edited\ntext', 'Edited\ntext'],
|
||||||
|
['url', 'pngx-input-url input', 'https://example.com', 'https://example.com'],
|
||||||
|
])(
|
||||||
|
'%s input events',
|
||||||
|
(_type, selector: string, text: string, value: string | number) => {
|
||||||
|
let fixture: ComponentFixture<InputEventsHostComponent>
|
||||||
|
let control: FormControl<string | number | null>
|
||||||
|
let input: HTMLInputElement | HTMLTextAreaElement
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
TestBed.configureTestingModule({
|
||||||
|
imports: [InputEventsHostComponent],
|
||||||
|
providers: [provideHttpClient(), provideHttpClientTesting()],
|
||||||
|
})
|
||||||
|
fixture = TestBed.createComponent(InputEventsHostComponent)
|
||||||
|
control = fixture.componentInstance.control
|
||||||
|
})
|
||||||
|
|
||||||
|
async function render() {
|
||||||
|
fixture.detectChanges()
|
||||||
|
await fixture.whenStable()
|
||||||
|
input = fixture.nativeElement.querySelector(selector)
|
||||||
|
}
|
||||||
|
|
||||||
|
it('updates the form while typing and marks it touched only on blur', async () => {
|
||||||
|
await render()
|
||||||
|
const changed = jest.fn()
|
||||||
|
control.valueChanges.subscribe(changed)
|
||||||
|
input.value = text
|
||||||
|
input.dispatchEvent(new Event('input'))
|
||||||
|
expect(control.value).toBe(value)
|
||||||
|
expect(control.dirty).toBe(true)
|
||||||
|
expect(control.touched).toBe(false)
|
||||||
|
|
||||||
|
input.dispatchEvent(new Event('change'))
|
||||||
|
input.dispatchEvent(new Event('blur'))
|
||||||
|
expect(control.touched).toBe(true)
|
||||||
|
expect(changed).toHaveBeenCalledTimes(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('honors an explicit updateOn blur strategy', async () => {
|
||||||
|
control = new FormControl<string | number | null>(null, {
|
||||||
|
updateOn: 'blur',
|
||||||
|
})
|
||||||
|
fixture.componentInstance.control = control
|
||||||
|
await render()
|
||||||
|
input.value = text
|
||||||
|
input.dispatchEvent(new Event('input'))
|
||||||
|
expect(control.value).toBeNull()
|
||||||
|
expect(control.pristine).toBe(true)
|
||||||
|
|
||||||
|
input.dispatchEvent(new Event('blur'))
|
||||||
|
expect(control.value).toBe(value)
|
||||||
|
expect(control.dirty).toBe(true)
|
||||||
|
expect(control.touched).toBe(true)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
)
|
||||||
@@ -12,7 +12,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="position-relative" [class.col-md-9]="horizontal">
|
<div class="position-relative" [class.col-md-9]="horizontal">
|
||||||
<div class="input-group" [class.is-invalid]="error">
|
<div class="input-group" [class.is-invalid]="error">
|
||||||
<input #inputField type="number" class="form-control" [step]="step" [id]="inputId" [(ngModel)]="value" [ngModelOptions]="{standalone: true}" (change)="onChange(value)" [class.is-invalid]="error" [disabled]="disabled">
|
<input #inputField type="number" class="form-control" [step]="step" [id]="inputId" [(ngModel)]="value" [ngModelOptions]="{standalone: true}" (ngModelChange)="onChange($event)" (blur)="onTouched()" [class.is-invalid]="error" [disabled]="disabled">
|
||||||
@if (showAdd) {
|
@if (showAdd) {
|
||||||
<button class="btn btn-outline-secondary" type="button" id="button-addon1" (click)="nextAsn()" [disabled]="disabled">+1</button>
|
<button class="btn btn-outline-secondary" type="button" id="button-addon1" (click)="nextAsn()" [disabled]="disabled">+1</button>
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -11,7 +11,7 @@
|
|||||||
}
|
}
|
||||||
</div>
|
</div>
|
||||||
<div class="position-relative" [class.col-md-9]="horizontal">
|
<div class="position-relative" [class.col-md-9]="horizontal">
|
||||||
<input #inputField type="text" class="form-control" [class.is-invalid]="error" [id]="inputId" [(ngModel)]="value" [ngModelOptions]="{standalone: true}" (change)="onChange(value)" [disabled]="disabled" [autocomplete]="autocomplete" [placeholder]="placeholder">
|
<input #inputField type="text" class="form-control" [class.is-invalid]="error" [id]="inputId" [(ngModel)]="value" [ngModelOptions]="{standalone: true}" (ngModelChange)="onChange($event)" (blur)="onTouched()" [disabled]="disabled" [autocomplete]="autocomplete" [placeholder]="placeholder">
|
||||||
@if (hint) {
|
@if (hint) {
|
||||||
<small class="form-text text-muted" [innerHTML]="hint"></small>
|
<small class="form-text text-muted" [innerHTML]="hint"></small>
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -18,7 +18,8 @@
|
|||||||
[class.font-monospace]="monospace"
|
[class.font-monospace]="monospace"
|
||||||
[(ngModel)]="value"
|
[(ngModel)]="value"
|
||||||
[ngModelOptions]="{standalone: true}"
|
[ngModelOptions]="{standalone: true}"
|
||||||
(change)="onChange(value)"
|
(ngModelChange)="onChange($event)"
|
||||||
|
(blur)="onTouched()"
|
||||||
[disabled]="disabled"
|
[disabled]="disabled"
|
||||||
[placeholder]="placeholder"
|
[placeholder]="placeholder"
|
||||||
rows="4">
|
rows="4">
|
||||||
|
|||||||
@@ -10,7 +10,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div [class.col-md-9]="horizontal">
|
<div [class.col-md-9]="horizontal">
|
||||||
<div class="input-group" [class.is-invalid]="error">
|
<div class="input-group" [class.is-invalid]="error">
|
||||||
<input #inputField type="url" class="form-control" [class.is-invalid]="error" placeholder="https://" [id]="inputId" [(ngModel)]="value" [ngModelOptions]="{standalone: true}" (change)="onChange(value)" [disabled]="disabled">
|
<input #inputField type="url" class="form-control" [class.is-invalid]="error" placeholder="https://" [id]="inputId" [(ngModel)]="value" [ngModelOptions]="{standalone: true}" (ngModelChange)="onChange($event)" (blur)="onTouched()" [disabled]="disabled">
|
||||||
<a class="btn btn-outline-secondary rounded-end" title="Open link" i18n-title [href]="value" target="_blank">
|
<a class="btn btn-outline-secondary rounded-end" title="Open link" i18n-title [href]="value" target="_blank">
|
||||||
<pngx-bs-icon width="1.2em" height="1.2em" name="box-arrow-up-right"></pngx-bs-icon>
|
<pngx-bs-icon width="1.2em" height="1.2em" name="box-arrow-up-right"></pngx-bs-icon>
|
||||||
</a>
|
</a>
|
||||||
|
|||||||
@@ -7,6 +7,7 @@
|
|||||||
background-color: var(--pngx-toast-bg);
|
background-color: var(--pngx-toast-bg);
|
||||||
color: var(--bs-body-color);
|
color: var(--bs-body-color);
|
||||||
overflow: hidden;
|
overflow: hidden;
|
||||||
|
transition: background-color .18s ease, border-color .18s ease;
|
||||||
|
|
||||||
&.toast-success {
|
&.toast-success {
|
||||||
--pngx-toast-accent: var(--pngx-toast-success);
|
--pngx-toast-accent: var(--pngx-toast-success);
|
||||||
@@ -23,6 +24,13 @@
|
|||||||
|
|
||||||
.toast-icon {
|
.toast-icon {
|
||||||
color: var(--pngx-toast-accent);
|
color: var(--pngx-toast-accent);
|
||||||
|
transition: color .18s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (prefers-reduced-motion: reduce) {
|
||||||
|
.toast, .toast-icon {
|
||||||
|
transition: none;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.toast-content {
|
.toast-content {
|
||||||
|
|||||||
@@ -65,6 +65,36 @@ describe('ToastComponent', () => {
|
|||||||
expect(component.delayRemaining()).toEqual(3000)
|
expect(component.delayRemaining()).toEqual(3000)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('updates its color and icon in place and restarts the countdown', () => {
|
||||||
|
jest.useFakeTimers()
|
||||||
|
fixture.componentRef.setInput('toast', {
|
||||||
|
id: 'task-1',
|
||||||
|
content: 'Queued',
|
||||||
|
delay: 5000,
|
||||||
|
})
|
||||||
|
fixture.detectChanges()
|
||||||
|
component.onShown(component.toast)
|
||||||
|
jest.advanceTimersByTime(4500)
|
||||||
|
const element = fixture.nativeElement.querySelector('ngb-toast')
|
||||||
|
fixture.componentRef.setInput('toast', {
|
||||||
|
id: 'task-1',
|
||||||
|
content: 'Completed',
|
||||||
|
delay: 5000,
|
||||||
|
level: ToastLevel.Success,
|
||||||
|
})
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(fixture.nativeElement.querySelector('ngb-toast')).toBe(element)
|
||||||
|
expect(element.classList).toContain('toast-success')
|
||||||
|
expect(element.querySelector('[name="check-circle"]')).not.toBeNull()
|
||||||
|
expect(component.delayRemaining()).toBe(5000)
|
||||||
|
const hide = jest.spyOn(component.ngbToast, 'hide')
|
||||||
|
jest.advanceTimersByTime(1000)
|
||||||
|
expect(hide).not.toHaveBeenCalled()
|
||||||
|
jest.advanceTimersByTime(4200)
|
||||||
|
expect(hide).toHaveBeenCalled()
|
||||||
|
jest.useRealTimers()
|
||||||
|
})
|
||||||
|
|
||||||
it('should hide the toast when the countdown ends', () => {
|
it('should hide the toast when the countdown ends', () => {
|
||||||
jest.useFakeTimers()
|
jest.useFakeTimers()
|
||||||
const toast = { content: 'Info', delay: 3000 }
|
const toast = { content: 'Info', delay: 3000 }
|
||||||
|
|||||||
@@ -5,8 +5,10 @@ import {
|
|||||||
DestroyRef,
|
DestroyRef,
|
||||||
EventEmitter,
|
EventEmitter,
|
||||||
Input,
|
Input,
|
||||||
|
OnChanges,
|
||||||
OnInit,
|
OnInit,
|
||||||
Output,
|
Output,
|
||||||
|
SimpleChanges,
|
||||||
ViewChild,
|
ViewChild,
|
||||||
inject,
|
inject,
|
||||||
signal,
|
signal,
|
||||||
@@ -34,10 +36,10 @@ import { Toast, ToastLevel } from 'src/app/services/toast.service'
|
|||||||
styleUrl: './toast.component.scss',
|
styleUrl: './toast.component.scss',
|
||||||
providers: [DatePipe, CustomDatePipe],
|
providers: [DatePipe, CustomDatePipe],
|
||||||
})
|
})
|
||||||
export class ToastComponent implements OnInit {
|
export class ToastComponent implements OnInit, OnChanges {
|
||||||
private clipboard = inject(Clipboard)
|
private readonly clipboard = inject(Clipboard)
|
||||||
private customDatePipe = inject(CustomDatePipe)
|
private readonly customDatePipe = inject(CustomDatePipe)
|
||||||
private destroyRef = inject(DestroyRef)
|
private readonly destroyRef = inject(DestroyRef)
|
||||||
readonly copied = signal(false)
|
readonly copied = signal(false)
|
||||||
readonly ToastLevel = ToastLevel
|
readonly ToastLevel = ToastLevel
|
||||||
readonly delayRemaining = signal<number>(null)
|
readonly delayRemaining = signal<number>(null)
|
||||||
@@ -69,6 +71,12 @@ export class ToastComponent implements OnInit {
|
|||||||
if (this.autohide) this.delayRemaining.set(this.toast.delay)
|
if (this.autohide) this.delayRemaining.set(this.toast.delay)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
ngOnChanges(changes: SimpleChanges): void {
|
||||||
|
if (changes.toast && !changes.toast.firstChange && this.autohide) {
|
||||||
|
this.onShown(this.toast)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
get relativeTimestamp(): string {
|
get relativeTimestamp(): string {
|
||||||
return this.customDatePipe.transform(this.toast.timestamp, 'relative')
|
return this.customDatePipe.transform(this.toast.timestamp, 'relative')
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -68,9 +68,9 @@ describe('ToastsComponent', () => {
|
|||||||
toasts.forEach((t) => toastSubject.next(t))
|
toasts.forEach((t) => toastSubject.next(t))
|
||||||
expect(component.toasts().map((t) => t.id)).toEqual(['3', '2', '1'])
|
expect(component.toasts().map((t) => t.id)).toEqual(['3', '2', '1'])
|
||||||
|
|
||||||
// showing a visible toast again moves it to the top without duplicating
|
// Updating a visible toast preserves its position without duplicating it.
|
||||||
toastSubject.next(toasts[1])
|
toastSubject.next(toasts[1])
|
||||||
expect(component.toasts().map((t) => t.id)).toEqual(['1', '3', '2'])
|
expect(component.toasts().map((t) => t.id)).toEqual(['3', '2', '1'])
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should remove a popup when it hides without closing it', () => {
|
it('should remove a popup when it hides without closing it', () => {
|
||||||
|
|||||||
@@ -32,10 +32,11 @@ export class ToastsComponent {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
this.toasts.update((toasts) =>
|
this.toasts.update((toasts) =>
|
||||||
[toast, ...toasts.filter((t) => t.id !== toast.id)].slice(
|
toasts.some((existing) => existing.id === toast.id)
|
||||||
0,
|
? toasts.map((existing) =>
|
||||||
MAX_VISIBLE_TOASTS
|
existing.id === toast.id ? toast : existing
|
||||||
)
|
)
|
||||||
|
: [toast, ...toasts].slice(0, MAX_VISIBLE_TOASTS)
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -49,6 +49,12 @@
|
|||||||
<pngx-bs-icon width="1em" height="1em" name="arrow-counterclockwise" class="me-2"></pngx-bs-icon><span i18n>Reprocess</span>
|
<pngx-bs-icon width="1em" height="1em" name="arrow-counterclockwise" class="me-2"></pngx-bs-icon><span i18n>Reprocess</span>
|
||||||
</button>
|
</button>
|
||||||
|
|
||||||
|
@if (manualWorkflows().length > 0) {
|
||||||
|
<button ngbDropdownItem (click)="runWorkflow()" [disabled]="!userCanEdit || !userIsOwner">
|
||||||
|
<pngx-bs-icon width="1em" height="1em" name="play-circle" class="me-2"></pngx-bs-icon><span i18n>Run workflow</span>
|
||||||
|
</button>
|
||||||
|
}
|
||||||
|
|
||||||
<button ngbDropdownItem (click)="printDocument()" [hidden]="useNativePdfViewer || isMobile">
|
<button ngbDropdownItem (click)="printDocument()" [hidden]="useNativePdfViewer || isMobile">
|
||||||
<pngx-bs-icon width="1em" height="1em" name="printer" class="me-2"></pngx-bs-icon><span i18n>Print</span>
|
<pngx-bs-icon width="1em" height="1em" name="printer" class="me-2"></pngx-bs-icon><span i18n>Print</span>
|
||||||
</button>
|
</button>
|
||||||
@@ -61,6 +67,22 @@
|
|||||||
<pngx-bs-icon name="pencil" class="me-2"></pngx-bs-icon><ng-container i18n>PDF Editor</ng-container>
|
<pngx-bs-icon name="pencil" class="me-2"></pngx-bs-icon><ng-container i18n>PDF Editor</ng-container>
|
||||||
</button>
|
</button>
|
||||||
|
|
||||||
|
<div class="d-flex" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.OcrTemplate }">
|
||||||
|
<button ngbDropdownItem (click)="runZoneOcr()" [disabled]="!userCanEdit || networkActive()">
|
||||||
|
<pngx-bs-icon width="1em" height="1em" name="bounding-box-circles" class="me-2"></pngx-bs-icon><span i18n>Run Zone OCR</span>
|
||||||
|
</button>
|
||||||
|
<button
|
||||||
|
ngbDropdownItem
|
||||||
|
class="w-auto flex-shrink-0 px-2"
|
||||||
|
(click)="runZoneOcrWithOptions()"
|
||||||
|
[disabled]="!userCanEdit || networkActive()"
|
||||||
|
title="Choose OCR template"
|
||||||
|
i18n-title
|
||||||
|
>
|
||||||
|
<pngx-bs-icon width="1em" height="1em" name="sliders2"></pngx-bs-icon>
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
|
||||||
@if (userIsOwner && (requiresPassword || password)) {
|
@if (userIsOwner && (requiresPassword || password)) {
|
||||||
<button ngbDropdownItem (click)="removePassword()" [disabled]="!password">
|
<button ngbDropdownItem (click)="removePassword()" [disabled]="!password">
|
||||||
<pngx-bs-icon name="unlock" class="me-2"></pngx-bs-icon><ng-container i18n>Remove Password</ng-container>
|
<pngx-bs-icon name="unlock" class="me-2"></pngx-bs-icon><ng-container i18n>Remove Password</ng-container>
|
||||||
@@ -90,7 +112,7 @@
|
|||||||
<div class="row">
|
<div class="row">
|
||||||
<div class="col-md-6 col-xl-5 mb-4">
|
<div class="col-md-6 col-xl-5 mb-4">
|
||||||
|
|
||||||
<form [formGroup]='documentForm' (ngSubmit)="save()">
|
<form [formGroup]='documentForm' (ngSubmit)="save()" [attr.inert]="zoneOcrRunning() ? '' : null" [attr.aria-busy]="zoneOcrRunning()">
|
||||||
|
|
||||||
<div class="btn-toolbar mb-1 pb-3 gap-2 row-gap-2 border-bottom">
|
<div class="btn-toolbar mb-1 pb-3 gap-2 row-gap-2 border-bottom">
|
||||||
<div class="btn-group">
|
<div class="btn-group">
|
||||||
|
|||||||
@@ -390,14 +390,12 @@ describe('DocumentDetailComponent', () => {
|
|||||||
expect(component.documentForm.get('title').value).toEqual('Foo Bar')
|
expect(component.documentForm.get('title').value).toEqual('Foo Bar')
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should update title before doc change if was not updated via debounce', () => {
|
it('should update the title form value without waiting for debounce or blur', () => {
|
||||||
jest.useFakeTimers()
|
jest.useFakeTimers()
|
||||||
initNormally()
|
initNormally()
|
||||||
component.titleInput.value = 'Foo Bar'
|
const input = component.titleInput.inputField.nativeElement
|
||||||
component.titleInput.inputField.nativeElement.dispatchEvent(
|
input.value = 'Foo Bar'
|
||||||
new Event('change')
|
input.dispatchEvent(new Event('input'))
|
||||||
)
|
|
||||||
jest.advanceTimersByTime(1000)
|
|
||||||
expect(component.documentForm.get('title').value).toEqual('Foo Bar')
|
expect(component.documentForm.get('title').value).toEqual('Foo Bar')
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -1013,27 +1011,85 @@ describe('DocumentDetailComponent', () => {
|
|||||||
])
|
])
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should support reprocess, confirm and close modal after started', () => {
|
it('should queue reprocess, show the task link and close the modal', () => {
|
||||||
|
jest.useFakeTimers()
|
||||||
initNormally()
|
initNormally()
|
||||||
const reprocessSpy = jest.spyOn(documentService, 'reprocessDocuments')
|
const reprocessSpy = jest.spyOn(documentService, 'reprocessDocuments')
|
||||||
reprocessSpy.mockReturnValue(of(true))
|
reprocessSpy.mockReturnValue(of({ result: 'OK', task_id: 'reprocess-1' }))
|
||||||
let openModal: NgbModalRef
|
let openModal: NgbModalRef
|
||||||
modalService.activeInstances.subscribe((modal) => (openModal = modal[0]))
|
modalService.activeInstances.subscribe((modal) => (openModal = modal[0]))
|
||||||
const modalSpy = jest.spyOn(modalService, 'open')
|
const modalSpy = jest.spyOn(modalService, 'open')
|
||||||
const toastSpy = jest.spyOn(toastService, 'showInfo')
|
const toastSpy = jest.spyOn(toastService, 'show')
|
||||||
component.reprocess()
|
component.reprocess()
|
||||||
const modalCloseSpy = jest.spyOn(openModal, 'close')
|
const modalCloseSpy = jest.spyOn(openModal, 'close')
|
||||||
openModal.componentInstance.confirmClicked.next()
|
openModal.componentInstance.confirmClicked.next()
|
||||||
expect(reprocessSpy).toHaveBeenCalledWith({ documents: [doc.id] }, false)
|
expect(reprocessSpy).toHaveBeenCalledWith({ documents: [doc.id] }, false)
|
||||||
expect(modalSpy).toHaveBeenCalled()
|
expect(modalSpy).toHaveBeenCalled()
|
||||||
expect(toastSpy).toHaveBeenCalled()
|
expect(toastSpy).not.toHaveBeenCalled()
|
||||||
expect(modalCloseSpy).toHaveBeenCalled()
|
expect(modalCloseSpy).toHaveBeenCalled()
|
||||||
|
jest.advanceTimersByTime(400)
|
||||||
|
expect(toastSpy).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
content: 'Document reprocessing queued.',
|
||||||
|
actionName: 'View task',
|
||||||
|
})
|
||||||
|
)
|
||||||
|
toastSpy.mock.calls.at(-1)[0].action()
|
||||||
|
expect(router.navigate).toHaveBeenCalledWith(['/tasks'], {
|
||||||
|
queryParams: { task_id: 'reprocess-1' },
|
||||||
|
})
|
||||||
|
expect(modalCloseSpy).toHaveBeenCalled()
|
||||||
|
jest.useRealTimers()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should run a workflow on the document, confirm and close modal', () => {
|
||||||
|
jest.useFakeTimers()
|
||||||
|
initNormally()
|
||||||
|
const bulkEditSpy = jest.spyOn(documentService, 'bulkEdit')
|
||||||
|
bulkEditSpy.mockReturnValue(of({ result: 'OK', task_id: 'workflow-1' }))
|
||||||
|
let openModal: NgbModalRef
|
||||||
|
modalService.activeInstances.subscribe((modal) => (openModal = modal[0]))
|
||||||
|
const toastSpy = jest.spyOn(toastService, 'show')
|
||||||
|
component.runWorkflow()
|
||||||
|
expect(openModal.componentInstance.singleDocument).toBe(true)
|
||||||
|
expect(openModal.componentInstance.force).toBe(true)
|
||||||
|
const modalCloseSpy = jest.spyOn(openModal, 'close')
|
||||||
|
openModal.componentInstance.workflowId = 5
|
||||||
|
openModal.componentInstance.confirmClicked.next()
|
||||||
|
expect(bulkEditSpy).toHaveBeenCalledWith(
|
||||||
|
{ documents: [doc.id] },
|
||||||
|
'run_workflow',
|
||||||
|
{ workflow: 5, filter_documents: false }
|
||||||
|
)
|
||||||
|
jest.advanceTimersByTime(400)
|
||||||
|
expect(toastSpy).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({ content: 'Workflow queued.' })
|
||||||
|
)
|
||||||
|
expect(modalCloseSpy).toHaveBeenCalled()
|
||||||
|
jest.useRealTimers()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should apply workflow filters when the single-document checkbox is cleared', () => {
|
||||||
|
initNormally()
|
||||||
|
const bulkEditSpy = jest.spyOn(documentService, 'bulkEdit')
|
||||||
|
bulkEditSpy.mockReturnValue(of({ result: 'OK', task_id: 'workflow-2' }))
|
||||||
|
let openModal: NgbModalRef
|
||||||
|
modalService.activeInstances.subscribe((modal) => (openModal = modal[0]))
|
||||||
|
component.runWorkflow()
|
||||||
|
openModal.componentInstance.workflowId = 5
|
||||||
|
openModal.componentInstance.force = false
|
||||||
|
openModal.componentInstance.confirmClicked.next()
|
||||||
|
expect(bulkEditSpy).toHaveBeenCalledWith(
|
||||||
|
{ documents: [doc.id] },
|
||||||
|
'run_workflow',
|
||||||
|
{ workflow: 5, filter_documents: true }
|
||||||
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should pass remote OCR choice when reprocessing', () => {
|
it('should pass remote OCR choice when reprocessing', () => {
|
||||||
initNormally()
|
initNormally()
|
||||||
const reprocessSpy = jest.spyOn(documentService, 'reprocessDocuments')
|
const reprocessSpy = jest.spyOn(documentService, 'reprocessDocuments')
|
||||||
reprocessSpy.mockReturnValue(of(true))
|
reprocessSpy.mockReturnValue(of({ result: 'OK', task_id: 'reprocess-2' }))
|
||||||
let openModal: NgbModalRef
|
let openModal: NgbModalRef
|
||||||
modalService.activeInstances.subscribe((modal) => (openModal = modal[0]))
|
modalService.activeInstances.subscribe((modal) => (openModal = modal[0]))
|
||||||
component.reprocess()
|
component.reprocess()
|
||||||
@@ -1909,6 +1965,203 @@ describe('DocumentDetailComponent', () => {
|
|||||||
expect(toastSpy).toHaveBeenCalledWith('Document reloaded.')
|
expect(toastSpy).toHaveBeenCalledWith('Document reloaded.')
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('should run a chosen zone OCR template on the selected version and reload', () => {
|
||||||
|
component.documentId.set(doc.id)
|
||||||
|
component.document.set({ ...doc, versions: docVersions })
|
||||||
|
component.selectedVersionId.set(10)
|
||||||
|
jest.spyOn(documentService, 'runZoneOcr').mockReturnValue(
|
||||||
|
of({
|
||||||
|
results: [
|
||||||
|
{ zone: 'Total', value: '102.10' },
|
||||||
|
{ zone: 'Due', value: '' },
|
||||||
|
],
|
||||||
|
} as any)
|
||||||
|
)
|
||||||
|
const loadSpy = jest
|
||||||
|
.spyOn(component as any, 'loadDocument')
|
||||||
|
.mockImplementation(() => {})
|
||||||
|
const notifySpy = jest.spyOn(component.docChangeNotifier, 'next')
|
||||||
|
const toastSpy = jest.spyOn(toastService, 'showInfo')
|
||||||
|
const modalSpy = jest.spyOn(modalService, 'open')
|
||||||
|
|
||||||
|
component.runZoneOcrWithOptions()
|
||||||
|
const dialog = modalSpy.mock.results[0].value.componentInstance
|
||||||
|
expect(dialog.message).toBe(
|
||||||
|
'Fields filled by the template will be overwritten.'
|
||||||
|
)
|
||||||
|
dialog.template = 3
|
||||||
|
dialog.confirmClicked.emit()
|
||||||
|
|
||||||
|
expect(documentService.runZoneOcr).toHaveBeenCalledWith(doc.id, 3, 10)
|
||||||
|
expect(toastSpy).toHaveBeenCalledWith(
|
||||||
|
'Filled 1 of 2 fields. No value found for: Due'
|
||||||
|
)
|
||||||
|
expect(notifySpy).toHaveBeenCalledWith(doc.id)
|
||||||
|
expect(loadSpy).toHaveBeenCalledWith(doc.id, true, expect.any(Function))
|
||||||
|
expect(component.zoneOcrRunning()).toBe(true)
|
||||||
|
loadSpy.mock.calls[0][2]()
|
||||||
|
expect(component.zoneOcrRunning()).toBe(false)
|
||||||
|
expect(component.networkActive()).toBe(false)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should summarize zone OCR results', () => {
|
||||||
|
component.documentId.set(doc.id)
|
||||||
|
component.document.set({ ...doc, versions: docVersions })
|
||||||
|
component.selectedVersionId.set(12)
|
||||||
|
jest.spyOn(component as any, 'loadDocument').mockImplementation(() => {})
|
||||||
|
const runSpy = jest.spyOn(documentService, 'runZoneOcr')
|
||||||
|
const toastSpy = jest.spyOn(toastService, 'showInfo')
|
||||||
|
const modalSpy = jest.spyOn(modalService, 'open')
|
||||||
|
|
||||||
|
runSpy.mockReturnValueOnce(of({ status: 'completed', results: [] }))
|
||||||
|
component.runZoneOcr()
|
||||||
|
expect(modalSpy).not.toHaveBeenCalled()
|
||||||
|
expect(runSpy).toHaveBeenCalledWith(doc.id, null, null)
|
||||||
|
expect(toastSpy).toHaveBeenLastCalledWith(
|
||||||
|
'Zone OCR found no fields to fill.'
|
||||||
|
)
|
||||||
|
|
||||||
|
component.networkActive.set(false)
|
||||||
|
runSpy.mockReturnValueOnce(
|
||||||
|
of({
|
||||||
|
status: 'completed',
|
||||||
|
results: [
|
||||||
|
{ template: 'T', zone: 'Total', custom_field: 'Amount', value: 0 },
|
||||||
|
],
|
||||||
|
})
|
||||||
|
)
|
||||||
|
component.runZoneOcr()
|
||||||
|
expect(toastSpy).toHaveBeenLastCalledWith('Filled 1 of 1 fields.')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should confirm before running zone OCR over unsaved changes', () => {
|
||||||
|
component.documentId.set(doc.id)
|
||||||
|
component.document.set({ ...doc, __changedFields: ['title'] })
|
||||||
|
component.documentForm.patchValue({ title: 'Unsaved title' })
|
||||||
|
const runSpy = jest.spyOn(documentService, 'runZoneOcr')
|
||||||
|
const modalSpy = jest.spyOn(modalService, 'open')
|
||||||
|
|
||||||
|
component.runZoneOcr()
|
||||||
|
|
||||||
|
const modal = modalSpy.mock.results[0].value
|
||||||
|
expect(modal.componentInstance.message).toBe(
|
||||||
|
'Running Zone OCR will discard them.'
|
||||||
|
)
|
||||||
|
expect(runSpy).not.toHaveBeenCalled()
|
||||||
|
modal.componentInstance.cancel()
|
||||||
|
expect(runSpy).not.toHaveBeenCalled()
|
||||||
|
expect(component.documentForm.get('title').value).toBe('Unsaved title')
|
||||||
|
expect(component.zoneOcrRunning()).toBe(false)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should warn about unsaved changes in the zone OCR options dialog', () => {
|
||||||
|
component.documentId.set(doc.id)
|
||||||
|
component.document.set({ ...doc, __changedFields: ['title'] })
|
||||||
|
const runSpy = jest.spyOn(documentService, 'runZoneOcr')
|
||||||
|
const modalSpy = jest.spyOn(modalService, 'open')
|
||||||
|
|
||||||
|
component.runZoneOcrWithOptions()
|
||||||
|
|
||||||
|
const dialog = modalSpy.mock.results[0].value.componentInstance
|
||||||
|
expect(dialog.message).toBe('Running Zone OCR will discard them.')
|
||||||
|
expect(dialog.btnClass).toBe('btn-warning')
|
||||||
|
dialog.cancel()
|
||||||
|
expect(runSpy).not.toHaveBeenCalled()
|
||||||
|
component.networkActive.set(true)
|
||||||
|
component.runZoneOcrWithOptions()
|
||||||
|
expect(modalSpy).toHaveBeenCalledTimes(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should not allow saving or a second zone OCR run while one is running', () => {
|
||||||
|
component.documentId.set(doc.id)
|
||||||
|
component.document.set({
|
||||||
|
...doc,
|
||||||
|
versions: docVersions,
|
||||||
|
__changedFields: ['title'],
|
||||||
|
})
|
||||||
|
component.selectedVersionId.set(doc.id)
|
||||||
|
const pending = new Subject<any>()
|
||||||
|
const runSpy = jest
|
||||||
|
.spyOn(documentService, 'runZoneOcr')
|
||||||
|
.mockReturnValue(pending)
|
||||||
|
const modalSpy = jest.spyOn(modalService, 'open')
|
||||||
|
|
||||||
|
component.runZoneOcr()
|
||||||
|
modalSpy.mock.results[0].value.componentInstance.confirmClicked.emit()
|
||||||
|
|
||||||
|
expect(runSpy).toHaveBeenCalledWith(doc.id, null, doc.id)
|
||||||
|
expect(component.zoneOcrRunning()).toBe(true)
|
||||||
|
expect(component.networkActive()).toBe(true)
|
||||||
|
const saveSpy = jest.spyOn(documentService, 'patch')
|
||||||
|
component.save()
|
||||||
|
expect(saveSpy).not.toHaveBeenCalled()
|
||||||
|
component.runZoneOcr()
|
||||||
|
expect(modalSpy).toHaveBeenCalledTimes(1)
|
||||||
|
expect(runSpy).toHaveBeenCalledTimes(1)
|
||||||
|
pending.error(new Error('failed'))
|
||||||
|
expect(component.zoneOcrRunning()).toBe(false)
|
||||||
|
expect(component.networkActive()).toBe(false)
|
||||||
|
expect(component.document().__changedFields).toEqual(['title'])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should not reload after zone OCR if another document is open', () => {
|
||||||
|
component.documentId.set(doc.id)
|
||||||
|
component.document.set({ ...doc, __changedFields: [] })
|
||||||
|
const pending = new Subject<any>()
|
||||||
|
jest.spyOn(documentService, 'runZoneOcr').mockReturnValue(pending)
|
||||||
|
const loadSpy = jest.spyOn(component as any, 'loadDocument')
|
||||||
|
|
||||||
|
component.runZoneOcr()
|
||||||
|
component.documentId.set(99)
|
||||||
|
pending.next({ results: [] })
|
||||||
|
|
||||||
|
expect(loadSpy).not.toHaveBeenCalled()
|
||||||
|
expect(component.zoneOcrRunning()).toBe(false)
|
||||||
|
pending.complete()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should keep unsaved changes when zone OCR is skipped', () => {
|
||||||
|
component.documentId.set(doc.id)
|
||||||
|
component.document.set({ ...doc, __changedFields: ['title'] })
|
||||||
|
component.documentForm.patchValue({ title: 'Unsaved title' })
|
||||||
|
const modalSpy = jest.spyOn(modalService, 'open')
|
||||||
|
jest
|
||||||
|
.spyOn(documentService, 'runZoneOcr')
|
||||||
|
.mockReturnValue(of({ status: 'skipped', results: [] }))
|
||||||
|
const loadSpy = jest.spyOn(component as any, 'loadDocument')
|
||||||
|
const infoSpy = jest.spyOn(toastService, 'showInfo')
|
||||||
|
|
||||||
|
component.runZoneOcr()
|
||||||
|
modalSpy.mock.results[0].value.componentInstance.confirm()
|
||||||
|
|
||||||
|
expect(loadSpy).not.toHaveBeenCalled()
|
||||||
|
expect(component.documentForm.get('title').value).toBe('Unsaved title')
|
||||||
|
expect(component.zoneOcrRunning()).toBe(false)
|
||||||
|
expect(component.networkActive()).toBe(false)
|
||||||
|
expect(infoSpy).toHaveBeenCalledWith(
|
||||||
|
'No OCR template applies to this document.'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should show an error when zone OCR fails', () => {
|
||||||
|
component.document.set(doc)
|
||||||
|
jest
|
||||||
|
.spyOn(documentService, 'runZoneOcr')
|
||||||
|
.mockReturnValue(throwError(() => new Error('nope')))
|
||||||
|
const loadSpy = jest.spyOn(component as any, 'loadDocument')
|
||||||
|
const errorSpy = jest.spyOn(toastService, 'showError')
|
||||||
|
|
||||||
|
component.runZoneOcr()
|
||||||
|
|
||||||
|
expect(errorSpy).toHaveBeenCalledWith(
|
||||||
|
'Error running zone OCR.',
|
||||||
|
expect.any(Error)
|
||||||
|
)
|
||||||
|
expect(loadSpy).not.toHaveBeenCalled()
|
||||||
|
expect(component.zoneOcrRunning()).toBe(false)
|
||||||
|
expect(component.networkActive()).toBe(false)
|
||||||
|
})
|
||||||
|
|
||||||
it('should change preview element by render type', () => {
|
it('should change preview element by render type', () => {
|
||||||
initNormally()
|
initNormally()
|
||||||
component.document.update((document) => ({
|
component.document.update((document) => ({
|
||||||
@@ -1962,10 +2215,12 @@ describe('DocumentDetailComponent', () => {
|
|||||||
})
|
})
|
||||||
|
|
||||||
it('should support pdf editor, handle error', () => {
|
it('should support pdf editor, handle error', () => {
|
||||||
|
jest.useFakeTimers()
|
||||||
let modal: NgbModalRef
|
let modal: NgbModalRef
|
||||||
modalService.activeInstances.subscribe((m) => (modal = m[0]))
|
modalService.activeInstances.subscribe((m) => (modal = m[0]))
|
||||||
const closeSpy = jest.spyOn(openDocumentsService, 'closeDocument')
|
const closeSpy = jest.spyOn(openDocumentsService, 'closeDocument')
|
||||||
const errorSpy = jest.spyOn(toastService, 'showError')
|
const errorSpy = jest.spyOn(toastService, 'showError')
|
||||||
|
const queuedToastSpy = jest.spyOn(toastService, 'show')
|
||||||
initNormally()
|
initNormally()
|
||||||
component.selectedVersionId.set(10)
|
component.selectedVersionId.set(10)
|
||||||
component.editPdf()
|
component.editPdf()
|
||||||
@@ -1984,6 +2239,7 @@ describe('DocumentDetailComponent', () => {
|
|||||||
update_document: false,
|
update_document: false,
|
||||||
include_metadata: true,
|
include_metadata: true,
|
||||||
source_mode: 'explicit_selection',
|
source_mode: 'explicit_selection',
|
||||||
|
from_webui: true,
|
||||||
})
|
})
|
||||||
req.error(new ErrorEvent('failed'))
|
req.error(new ErrorEvent('failed'))
|
||||||
expect(errorSpy).toHaveBeenCalled()
|
expect(errorSpy).toHaveBeenCalled()
|
||||||
@@ -1996,13 +2252,21 @@ describe('DocumentDetailComponent', () => {
|
|||||||
req = httpTestingController.expectOne(
|
req = httpTestingController.expectOne(
|
||||||
`${environment.apiBaseUrl}documents/edit_pdf/`
|
`${environment.apiBaseUrl}documents/edit_pdf/`
|
||||||
)
|
)
|
||||||
req.flush(true)
|
req.flush({ result: 'OK', task_id: 'edit-pdf-1' })
|
||||||
expect(closeSpy).toHaveBeenCalled()
|
jest.advanceTimersByTime(400)
|
||||||
|
expect(closeSpy).not.toHaveBeenCalled()
|
||||||
|
expect(queuedToastSpy).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({ content: 'PDF edit queued.' })
|
||||||
|
)
|
||||||
|
jest.useRealTimers()
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should support removing password protection from pdfs', () => {
|
it('should support removing password protection from pdfs', () => {
|
||||||
|
jest.useFakeTimers()
|
||||||
let modal: NgbModalRef
|
let modal: NgbModalRef
|
||||||
modalService.activeInstances.subscribe((m) => (modal = m[0]))
|
modalService.activeInstances.subscribe((m) => (modal = m[0]))
|
||||||
|
const closeSpy = jest.spyOn(openDocumentsService, 'closeDocument')
|
||||||
|
const queuedToastSpy = jest.spyOn(toastService, 'show')
|
||||||
initNormally()
|
initNormally()
|
||||||
component.selectedVersionId.set(10)
|
component.selectedVersionId.set(10)
|
||||||
component.password = 'secret'
|
component.password = 'secret'
|
||||||
@@ -2023,8 +2287,15 @@ describe('DocumentDetailComponent', () => {
|
|||||||
include_metadata: false,
|
include_metadata: false,
|
||||||
delete_original: true,
|
delete_original: true,
|
||||||
source_mode: 'explicit_selection',
|
source_mode: 'explicit_selection',
|
||||||
|
from_webui: true,
|
||||||
})
|
})
|
||||||
req.flush(true)
|
req.flush({ result: 'OK', task_id: 'remove-password-1' })
|
||||||
|
jest.advanceTimersByTime(400)
|
||||||
|
expect(closeSpy).not.toHaveBeenCalled()
|
||||||
|
expect(queuedToastSpy).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({ content: 'Password removal queued.' })
|
||||||
|
)
|
||||||
|
jest.useRealTimers()
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should require the current password before removing it', () => {
|
it('should require the current password before removing it', () => {
|
||||||
@@ -2076,9 +2347,9 @@ describe('DocumentDetailComponent', () => {
|
|||||||
const req = httpTestingController.expectOne(
|
const req = httpTestingController.expectOne(
|
||||||
`${environment.apiBaseUrl}documents/remove_password/`
|
`${environment.apiBaseUrl}documents/remove_password/`
|
||||||
)
|
)
|
||||||
req.flush(true)
|
req.flush({ result: 'OK', task_id: 'remove-password-2' })
|
||||||
|
|
||||||
expect(refreshSpy).toHaveBeenCalledWith(doc.id)
|
expect(refreshSpy).not.toHaveBeenCalled()
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should support keyboard shortcuts', () => {
|
it('should support keyboard shortcuts', () => {
|
||||||
|
|||||||
@@ -64,10 +64,13 @@ import {
|
|||||||
FILTER_STORAGE_PATH,
|
FILTER_STORAGE_PATH,
|
||||||
} from 'src/app/data/filter-rule-type'
|
} from 'src/app/data/filter-rule-type'
|
||||||
import { ObjectWithId } from 'src/app/data/object-with-id'
|
import { ObjectWithId } from 'src/app/data/object-with-id'
|
||||||
|
import { OcrZoneRunResult } from 'src/app/data/ocr-template'
|
||||||
import { StoragePath } from 'src/app/data/storage-path'
|
import { StoragePath } from 'src/app/data/storage-path'
|
||||||
import { Tag } from 'src/app/data/tag'
|
import { Tag } from 'src/app/data/tag'
|
||||||
import { SETTINGS_KEYS, SuggestionSource } from 'src/app/data/ui-settings'
|
import { SETTINGS_KEYS, SuggestionSource } from 'src/app/data/ui-settings'
|
||||||
import { User } from 'src/app/data/user'
|
import { User } from 'src/app/data/user'
|
||||||
|
import { Workflow } from 'src/app/data/workflow'
|
||||||
|
import { WorkflowTriggerType } from 'src/app/data/workflow-trigger'
|
||||||
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
|
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
|
||||||
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
|
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
|
||||||
import { DocumentTitlePipe } from 'src/app/pipes/document-title.pipe'
|
import { DocumentTitlePipe } from 'src/app/pipes/document-title.pipe'
|
||||||
@@ -93,7 +96,9 @@ import { SavedViewService } from 'src/app/services/rest/saved-view.service'
|
|||||||
import { StoragePathService } from 'src/app/services/rest/storage-path.service'
|
import { StoragePathService } from 'src/app/services/rest/storage-path.service'
|
||||||
import { TagService } from 'src/app/services/rest/tag.service'
|
import { TagService } from 'src/app/services/rest/tag.service'
|
||||||
import { UserService } from 'src/app/services/rest/user.service'
|
import { UserService } from 'src/app/services/rest/user.service'
|
||||||
|
import { WorkflowService } from 'src/app/services/rest/workflow.service'
|
||||||
import { SettingsService } from 'src/app/services/settings.service'
|
import { SettingsService } from 'src/app/services/settings.service'
|
||||||
|
import { TaskNotificationService } from 'src/app/services/task-notification.service'
|
||||||
import { ToastService } from 'src/app/services/toast.service'
|
import { ToastService } from 'src/app/services/toast.service'
|
||||||
import { TrashService } from 'src/app/services/trash.service'
|
import { TrashService } from 'src/app/services/trash.service'
|
||||||
import { WebsocketStatusService } from 'src/app/services/websocket-status.service'
|
import { WebsocketStatusService } from 'src/app/services/websocket-status.service'
|
||||||
@@ -104,6 +109,8 @@ import { DocumentDetailFieldID } from '../admin/settings/settings.component'
|
|||||||
import { ConfirmDialogComponent } from '../common/confirm-dialog/confirm-dialog.component'
|
import { ConfirmDialogComponent } from '../common/confirm-dialog/confirm-dialog.component'
|
||||||
import { PasswordRemovalConfirmDialogComponent } from '../common/confirm-dialog/password-removal-confirm-dialog/password-removal-confirm-dialog.component'
|
import { PasswordRemovalConfirmDialogComponent } from '../common/confirm-dialog/password-removal-confirm-dialog/password-removal-confirm-dialog.component'
|
||||||
import { ReprocessConfirmDialogComponent } from '../common/confirm-dialog/reprocess-confirm-dialog/reprocess-confirm-dialog.component'
|
import { ReprocessConfirmDialogComponent } from '../common/confirm-dialog/reprocess-confirm-dialog/reprocess-confirm-dialog.component'
|
||||||
|
import { RunWorkflowConfirmDialogComponent } from '../common/confirm-dialog/run-workflow-confirm-dialog/run-workflow-confirm-dialog.component'
|
||||||
|
import { ZoneOcrConfirmDialogComponent } from '../common/confirm-dialog/zone-ocr-confirm-dialog/zone-ocr-confirm-dialog.component'
|
||||||
import { CustomFieldsDropdownComponent } from '../common/custom-fields-dropdown/custom-fields-dropdown.component'
|
import { CustomFieldsDropdownComponent } from '../common/custom-fields-dropdown/custom-fields-dropdown.component'
|
||||||
import { CorrespondentEditDialogComponent } from '../common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component'
|
import { CorrespondentEditDialogComponent } from '../common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component'
|
||||||
import { DocumentTypeEditDialogComponent } from '../common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component'
|
import { DocumentTypeEditDialogComponent } from '../common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component'
|
||||||
@@ -222,6 +229,7 @@ export class DocumentDetailComponent
|
|||||||
private documentListViewService = inject(DocumentListViewService)
|
private documentListViewService = inject(DocumentListViewService)
|
||||||
private documentTitlePipe = inject(DocumentTitlePipe)
|
private documentTitlePipe = inject(DocumentTitlePipe)
|
||||||
private toastService = inject(ToastService)
|
private toastService = inject(ToastService)
|
||||||
|
private taskNotifications = inject(TaskNotificationService)
|
||||||
private trashService = inject(TrashService)
|
private trashService = inject(TrashService)
|
||||||
private settings = inject(SettingsService)
|
private settings = inject(SettingsService)
|
||||||
private storagePathService = inject(StoragePathService)
|
private storagePathService = inject(StoragePathService)
|
||||||
@@ -233,6 +241,7 @@ export class DocumentDetailComponent
|
|||||||
private componentRouterService = inject(ComponentRouterService)
|
private componentRouterService = inject(ComponentRouterService)
|
||||||
private deviceDetectorService = inject(DeviceDetectorService)
|
private deviceDetectorService = inject(DeviceDetectorService)
|
||||||
private savedViewService = inject(SavedViewService)
|
private savedViewService = inject(SavedViewService)
|
||||||
|
private readonly workflowService = inject(WorkflowService)
|
||||||
private readonly websocketStatusService = inject(WebsocketStatusService)
|
private readonly websocketStatusService = inject(WebsocketStatusService)
|
||||||
private readonly useNativePdfViewerSetting = this.settings.getSignal<boolean>(
|
private readonly useNativePdfViewerSetting = this.settings.getSignal<boolean>(
|
||||||
SETTINGS_KEYS.USE_NATIVE_PDF_VIEWER
|
SETTINGS_KEYS.USE_NATIVE_PDF_VIEWER
|
||||||
@@ -266,6 +275,7 @@ export class DocumentDetailComponent
|
|||||||
readonly error = signal<any>(undefined)
|
readonly error = signal<any>(undefined)
|
||||||
|
|
||||||
readonly networkActive = signal(false)
|
readonly networkActive = signal(false)
|
||||||
|
readonly zoneOcrRunning = signal(false)
|
||||||
|
|
||||||
readonly documentId = signal<number>(undefined)
|
readonly documentId = signal<number>(undefined)
|
||||||
readonly document = signal<Document>(undefined)
|
readonly document = signal<Document>(undefined)
|
||||||
@@ -295,6 +305,7 @@ export class DocumentDetailComponent
|
|||||||
readonly correspondents = signal<Correspondent[]>(undefined)
|
readonly correspondents = signal<Correspondent[]>(undefined)
|
||||||
readonly documentTypes = signal<DocumentType[]>(undefined)
|
readonly documentTypes = signal<DocumentType[]>(undefined)
|
||||||
readonly storagePaths = signal<StoragePath[]>(undefined)
|
readonly storagePaths = signal<StoragePath[]>(undefined)
|
||||||
|
readonly manualWorkflows = signal<Workflow[]>([])
|
||||||
|
|
||||||
documentForm: FormGroup = new FormGroup({
|
documentForm: FormGroup = new FormGroup({
|
||||||
title: new FormControl(''),
|
title: new FormControl(''),
|
||||||
@@ -543,7 +554,11 @@ export class DocumentDetailComponent
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
private loadDocument(documentId: number, forceRemote: boolean = false): void {
|
private loadDocument(
|
||||||
|
documentId: number,
|
||||||
|
forceRemote: boolean = false,
|
||||||
|
onComplete?: () => void
|
||||||
|
): void {
|
||||||
let redirectedToRoot = false
|
let redirectedToRoot = false
|
||||||
this.closeIncomingUpdateModal()
|
this.closeIncomingUpdateModal()
|
||||||
this.pendingIncomingUpdate = null
|
this.pendingIncomingUpdate = null
|
||||||
@@ -600,7 +615,8 @@ export class DocumentDetailComponent
|
|||||||
}),
|
}),
|
||||||
first(),
|
first(),
|
||||||
takeUntil(this.unsubscribeNotifier),
|
takeUntil(this.unsubscribeNotifier),
|
||||||
takeUntil(this.docChangeNotifier)
|
takeUntil(this.docChangeNotifier),
|
||||||
|
finalize(() => onComplete?.())
|
||||||
)
|
)
|
||||||
.subscribe({
|
.subscribe({
|
||||||
next: (doc) => {
|
next: (doc) => {
|
||||||
@@ -836,6 +852,20 @@ export class DocumentDetailComponent
|
|||||||
.pipe(first(), takeUntil(this.unsubscribeNotifier))
|
.pipe(first(), takeUntil(this.unsubscribeNotifier))
|
||||||
.subscribe((result) => this.users.set(result.results))
|
.subscribe((result) => this.users.set(result.results))
|
||||||
}
|
}
|
||||||
|
if (
|
||||||
|
this.permissionsService.currentUserCan(
|
||||||
|
PermissionAction.View,
|
||||||
|
PermissionType.Workflow
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
this.workflowService
|
||||||
|
.list(1, 100000, null, null, {
|
||||||
|
trigger_type: WorkflowTriggerType.Manual,
|
||||||
|
enabled: true,
|
||||||
|
})
|
||||||
|
.pipe(first(), takeUntil(this.unsubscribeNotifier))
|
||||||
|
.subscribe((result) => this.manualWorkflows.set(result.results))
|
||||||
|
}
|
||||||
|
|
||||||
this.getCustomFields()
|
this.getCustomFields()
|
||||||
|
|
||||||
@@ -1334,6 +1364,7 @@ export class DocumentDetailComponent
|
|||||||
}
|
}
|
||||||
|
|
||||||
save(close: boolean = false, savedCallback: () => void = null) {
|
save(close: boolean = false, savedCallback: () => void = null) {
|
||||||
|
if (this.zoneOcrRunning()) return
|
||||||
this.networkActive.set(true)
|
this.networkActive.set(true)
|
||||||
;(document.activeElement as HTMLElement)?.dispatchEvent(new Event('change'))
|
;(document.activeElement as HTMLElement)?.dispatchEvent(new Event('change'))
|
||||||
this.documentsService
|
this.documentsService
|
||||||
@@ -1538,9 +1569,11 @@ export class DocumentDetailComponent
|
|||||||
modal.componentInstance.remoteOcr
|
modal.componentInstance.remoteOcr
|
||||||
)
|
)
|
||||||
.subscribe({
|
.subscribe({
|
||||||
next: () => {
|
next: ({ task_id }) => {
|
||||||
this.toastService.showInfo(
|
this.taskNotifications.showQueued(
|
||||||
$localize`Reprocess operation for "${this.document().title}" will begin in the background.`
|
task_id,
|
||||||
|
$localize`Document reprocessing queued.`,
|
||||||
|
{ content: $localize`Document submitted for reprocessing.` }
|
||||||
)
|
)
|
||||||
if (modal) {
|
if (modal) {
|
||||||
modal.close()
|
modal.close()
|
||||||
@@ -1559,6 +1592,152 @@ export class DocumentDetailComponent
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
runWorkflow() {
|
||||||
|
const modal = this.modalService.open(RunWorkflowConfirmDialogComponent, {
|
||||||
|
backdrop: 'static',
|
||||||
|
})
|
||||||
|
modal.componentInstance.title = $localize`Run workflow`
|
||||||
|
modal.componentInstance.message = $localize`Run a workflow on "${this.document().title}".`
|
||||||
|
modal.componentInstance.btnCaption = $localize`Run`
|
||||||
|
modal.componentInstance.workflows = this.manualWorkflows()
|
||||||
|
modal.componentInstance.singleDocument = true
|
||||||
|
modal.componentInstance.force = true
|
||||||
|
modal.componentInstance.confirmClicked.subscribe(() => {
|
||||||
|
modal.componentInstance.buttonsEnabled.set(false)
|
||||||
|
this.documentsService
|
||||||
|
.bulkEdit({ documents: [this.document().id] }, 'run_workflow', {
|
||||||
|
workflow: modal.componentInstance.workflowId,
|
||||||
|
filter_documents: !modal.componentInstance.force,
|
||||||
|
})
|
||||||
|
.subscribe({
|
||||||
|
next: ({ task_id }) => {
|
||||||
|
this.taskNotifications.showQueued(
|
||||||
|
task_id,
|
||||||
|
$localize`Workflow queued.`,
|
||||||
|
{
|
||||||
|
content: $localize`Workflow completed.`,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
modal.close()
|
||||||
|
},
|
||||||
|
error: (error) => {
|
||||||
|
modal.componentInstance.buttonsEnabled.set(true)
|
||||||
|
this.toastService.showError(
|
||||||
|
$localize`Error executing operation`,
|
||||||
|
error
|
||||||
|
)
|
||||||
|
},
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Runs every template that matches, confirming only over unsaved changes. */
|
||||||
|
runZoneOcr() {
|
||||||
|
if (this.networkActive()) return
|
||||||
|
const documentId = this.documentId()
|
||||||
|
const versionId = this.getSelectedNonLatestVersionId()
|
||||||
|
if (!this.hasLocalEdits(this.document())) {
|
||||||
|
this.executeZoneOcr(documentId, null, versionId)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
const modal = this.modalService.open(ConfirmDialogComponent, {
|
||||||
|
backdrop: 'static',
|
||||||
|
})
|
||||||
|
modal.componentInstance.title = $localize`Run Zone OCR`
|
||||||
|
modal.componentInstance.messageBold = $localize`You have unsaved changes.`
|
||||||
|
modal.componentInstance.message = $localize`Running Zone OCR will discard them.`
|
||||||
|
modal.componentInstance.btnClass = 'btn-warning'
|
||||||
|
modal.componentInstance.btnCaption = $localize`Run Zone OCR`
|
||||||
|
modal.componentInstance.confirmClicked
|
||||||
|
.pipe(first(), takeUntil(this.unsubscribeNotifier))
|
||||||
|
.subscribe(() => {
|
||||||
|
modal.close()
|
||||||
|
if (this.documentId() === documentId && !this.networkActive()) {
|
||||||
|
this.executeZoneOcr(documentId, null, versionId)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Opens the dialog to pick which template to run. */
|
||||||
|
runZoneOcrWithOptions() {
|
||||||
|
if (this.networkActive()) return
|
||||||
|
const documentId = this.documentId()
|
||||||
|
const versionId = this.getSelectedNonLatestVersionId()
|
||||||
|
const modal = this.modalService.open(ZoneOcrConfirmDialogComponent, {
|
||||||
|
backdrop: 'static',
|
||||||
|
})
|
||||||
|
const dialog = modal.componentInstance as ZoneOcrConfirmDialogComponent
|
||||||
|
dialog.title = $localize`Run Zone OCR`
|
||||||
|
dialog.btnCaption = $localize`Run Zone OCR`
|
||||||
|
if (this.hasLocalEdits(this.document())) {
|
||||||
|
dialog.messageBold = $localize`You have unsaved changes.`
|
||||||
|
dialog.message = $localize`Running Zone OCR will discard them.`
|
||||||
|
dialog.btnClass = 'btn-warning'
|
||||||
|
} else {
|
||||||
|
dialog.message = $localize`Fields filled by the template will be overwritten.`
|
||||||
|
}
|
||||||
|
dialog.confirmClicked
|
||||||
|
.pipe(first(), takeUntil(this.unsubscribeNotifier))
|
||||||
|
.subscribe(() => {
|
||||||
|
modal.close()
|
||||||
|
if (this.documentId() === documentId && !this.networkActive()) {
|
||||||
|
this.executeZoneOcr(documentId, dialog.template, versionId)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
private executeZoneOcr(
|
||||||
|
documentId: number,
|
||||||
|
templateId: number | null,
|
||||||
|
versionId: number | null
|
||||||
|
) {
|
||||||
|
this.zoneOcrRunning.set(true)
|
||||||
|
this.networkActive.set(true)
|
||||||
|
this.documentsService
|
||||||
|
.runZoneOcr(documentId, templateId, versionId)
|
||||||
|
.pipe(takeUntil(this.unsubscribeNotifier))
|
||||||
|
.subscribe({
|
||||||
|
next: (response) => {
|
||||||
|
if (
|
||||||
|
this.documentId() !== documentId ||
|
||||||
|
response.status === 'skipped'
|
||||||
|
) {
|
||||||
|
this.finishZoneOcr()
|
||||||
|
if (response.status === 'skipped') {
|
||||||
|
this.toastService.showInfo(
|
||||||
|
$localize`No OCR template applies to this document.`
|
||||||
|
)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
this.toastService.showInfo(this.zoneOcrSummary(response.results))
|
||||||
|
this.docChangeNotifier.next(documentId)
|
||||||
|
this.loadDocument(documentId, true, () => this.finishZoneOcr())
|
||||||
|
},
|
||||||
|
error: (error) => {
|
||||||
|
this.finishZoneOcr()
|
||||||
|
this.toastService.showError($localize`Error running zone OCR.`, error)
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
private zoneOcrSummary(results: OcrZoneRunResult[]): string {
|
||||||
|
if (!results.length) return $localize`Zone OCR found no fields to fill.`
|
||||||
|
const missed = results
|
||||||
|
.filter((result) => !`${result.value ?? ''}`.trim())
|
||||||
|
.map((result) => result.zone)
|
||||||
|
const filled = results.length - missed.length
|
||||||
|
return missed.length
|
||||||
|
? $localize`Filled ${filled} of ${results.length} fields. No value found for: ${missed.join(', ')}`
|
||||||
|
: $localize`Filled ${filled} of ${results.length} fields.`
|
||||||
|
}
|
||||||
|
|
||||||
|
private finishZoneOcr() {
|
||||||
|
this.zoneOcrRunning.set(false)
|
||||||
|
this.networkActive.set(false)
|
||||||
|
this.flushPendingIncomingUpdate()
|
||||||
|
}
|
||||||
|
|
||||||
private getSelectedNonLatestVersionId(): number | null {
|
private getSelectedNonLatestVersionId(): number | null {
|
||||||
const versions = this.document()?.versions ?? []
|
const versions = this.document()?.versions ?? []
|
||||||
if (!versions.length || !this.selectedVersionId()) {
|
if (!versions.length || !this.selectedVersionId()) {
|
||||||
@@ -1934,14 +2113,15 @@ export class DocumentDetailComponent
|
|||||||
})
|
})
|
||||||
.pipe(first(), takeUntil(this.unsubscribeNotifier))
|
.pipe(first(), takeUntil(this.unsubscribeNotifier))
|
||||||
.subscribe({
|
.subscribe({
|
||||||
next: () => {
|
next: ({ task_id }) => {
|
||||||
this.toastService.showInfo(
|
this.taskNotifications.showQueued(
|
||||||
$localize`PDF edit operation for "${this.document().title}" will begin in the background.`
|
task_id,
|
||||||
|
$localize`PDF edit queued.`,
|
||||||
|
{
|
||||||
|
content: $localize`PDF edit submitted for processing.`,
|
||||||
|
}
|
||||||
)
|
)
|
||||||
modal.close()
|
modal.close()
|
||||||
if (modal.componentInstance.deleteOriginal) {
|
|
||||||
this.openDocumentService.closeDocument(this.document())
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
error: (error) => {
|
error: (error) => {
|
||||||
if (modal) {
|
if (modal) {
|
||||||
@@ -1991,17 +2171,16 @@ export class DocumentDetailComponent
|
|||||||
})
|
})
|
||||||
.pipe(first(), takeUntil(this.unsubscribeNotifier))
|
.pipe(first(), takeUntil(this.unsubscribeNotifier))
|
||||||
.subscribe({
|
.subscribe({
|
||||||
next: () => {
|
next: ({ task_id }) => {
|
||||||
this.toastService.showInfo(
|
this.taskNotifications.showQueued(
|
||||||
$localize`Password removal operation for "${this.document().title}" will begin in the background.`
|
task_id,
|
||||||
|
$localize`Password removal queued.`,
|
||||||
|
{
|
||||||
|
content: $localize`Password removal submitted for processing.`,
|
||||||
|
}
|
||||||
)
|
)
|
||||||
this.networkActive.set(false)
|
this.networkActive.set(false)
|
||||||
modal.close()
|
modal.close()
|
||||||
if (!dialog.updateDocument && dialog.deleteOriginal) {
|
|
||||||
this.openDocumentService.closeDocument(this.document())
|
|
||||||
} else if (dialog.updateDocument) {
|
|
||||||
this.openDocumentService.refreshDocument(this.documentId())
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
error: (error) => {
|
error: (error) => {
|
||||||
dialog.buttonsEnabled.set(true)
|
dialog.buttonsEnabled.set(true)
|
||||||
|
|||||||
+23
-14
@@ -2,6 +2,7 @@ import { DatePipe } from '@angular/common'
|
|||||||
import { SimpleChange, signal } from '@angular/core'
|
import { SimpleChange, signal } from '@angular/core'
|
||||||
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
||||||
import { By } from '@angular/platform-browser'
|
import { By } from '@angular/platform-browser'
|
||||||
|
import { Router } from '@angular/router'
|
||||||
import { NgbModal } from '@ng-bootstrap/ng-bootstrap'
|
import { NgbModal } from '@ng-bootstrap/ng-bootstrap'
|
||||||
import { Subject, of, throwError } from 'rxjs'
|
import { Subject, of, throwError } from 'rxjs'
|
||||||
import { DocumentVersionInfo } from 'src/app/data/document'
|
import { DocumentVersionInfo } from 'src/app/data/document'
|
||||||
@@ -33,7 +34,7 @@ describe('DocumentVersionDropdownComponent', () => {
|
|||||||
>
|
>
|
||||||
>
|
>
|
||||||
let toastService: jest.Mocked<
|
let toastService: jest.Mocked<
|
||||||
Pick<ToastService, 'showError' | 'showInfo' | 'showSuccess'>
|
Pick<ToastService, 'show' | 'showError' | 'showInfo' | 'showSuccess'>
|
||||||
>
|
>
|
||||||
let finished$: Subject<{ taskId: string }>
|
let finished$: Subject<{ taskId: string }>
|
||||||
let failed$: Subject<{ taskId: string; message?: string }>
|
let failed$: Subject<{ taskId: string; message?: string }>
|
||||||
@@ -54,6 +55,7 @@ describe('DocumentVersionDropdownComponent', () => {
|
|||||||
}
|
}
|
||||||
modalService = { open: jest.fn() }
|
modalService = { open: jest.fn() }
|
||||||
toastService = {
|
toastService = {
|
||||||
|
show: jest.fn(),
|
||||||
showError: jest.fn(),
|
showError: jest.fn(),
|
||||||
showInfo: jest.fn(),
|
showInfo: jest.fn(),
|
||||||
showSuccess: jest.fn(),
|
showSuccess: jest.fn(),
|
||||||
@@ -88,6 +90,10 @@ describe('DocumentVersionDropdownComponent', () => {
|
|||||||
provide: PermissionsService,
|
provide: PermissionsService,
|
||||||
useValue: permissionsService,
|
useValue: permissionsService,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
provide: Router,
|
||||||
|
useValue: { navigate: jest.fn() },
|
||||||
|
},
|
||||||
{
|
{
|
||||||
provide: WebsocketStatusService,
|
provide: WebsocketStatusService,
|
||||||
useValue: {
|
useValue: {
|
||||||
@@ -377,7 +383,8 @@ describe('DocumentVersionDropdownComponent', () => {
|
|||||||
expect(component.versionLabelDraft).toEqual('')
|
expect(component.versionLabelDraft).toEqual('')
|
||||||
})
|
})
|
||||||
|
|
||||||
it('addExistingDocumentAsVersion should merge with a label and refresh versions', () => {
|
it('addExistingDocumentAsVersion should queue with a label and wait to refresh versions', () => {
|
||||||
|
jest.useFakeTimers()
|
||||||
const confirmClicked = new Subject<number>()
|
const confirmClicked = new Subject<number>()
|
||||||
const modal = {
|
const modal = {
|
||||||
componentInstance: {
|
componentInstance: {
|
||||||
@@ -388,14 +395,9 @@ describe('DocumentVersionDropdownComponent', () => {
|
|||||||
close: jest.fn(),
|
close: jest.fn(),
|
||||||
}
|
}
|
||||||
modalService.open.mockReturnValue(modal as any)
|
modalService.open.mockReturnValue(modal as any)
|
||||||
documentService.mergeDocumentsAsVersions.mockReturnValue(of({} as any))
|
documentService.mergeDocumentsAsVersions.mockReturnValue(
|
||||||
// Newest first, as the API returns them. The merged document has a lower id
|
of({ result: 'OK', task_id: 'versions-1' })
|
||||||
// than the root, which is the whole point of merging an existing document.
|
)
|
||||||
const versions: DocumentVersionInfo[] = [
|
|
||||||
{ id: 2, is_root: false, checksum: 'cccc' },
|
|
||||||
{ id: 3, is_root: true, checksum: 'aaaa' },
|
|
||||||
]
|
|
||||||
documentService.getVersions.mockReturnValue(of({ id: 3, versions } as any))
|
|
||||||
component.newVersionLabel = ' Imported '
|
component.newVersionLabel = ' Imported '
|
||||||
const versionsEmitSpy = jest.spyOn(component.versionsUpdated, 'emit')
|
const versionsEmitSpy = jest.spyOn(component.versionsUpdated, 'emit')
|
||||||
const selectedEmitSpy = jest.spyOn(component.versionSelected, 'emit')
|
const selectedEmitSpy = jest.spyOn(component.versionSelected, 'emit')
|
||||||
@@ -410,11 +412,18 @@ describe('DocumentVersionDropdownComponent', () => {
|
|||||||
'Imported'
|
'Imported'
|
||||||
)
|
)
|
||||||
expect(documentService.updateVersionLabel).not.toHaveBeenCalled()
|
expect(documentService.updateVersionLabel).not.toHaveBeenCalled()
|
||||||
expect(documentService.getVersions).toHaveBeenCalledWith(3)
|
expect(documentService.getVersions).not.toHaveBeenCalled()
|
||||||
expect(versionsEmitSpy).toHaveBeenCalledWith(versions)
|
expect(versionsEmitSpy).not.toHaveBeenCalled()
|
||||||
expect(selectedEmitSpy).toHaveBeenCalledWith(2)
|
expect(selectedEmitSpy).not.toHaveBeenCalled()
|
||||||
expect(component.newVersionLabel).toEqual('')
|
expect(component.newVersionLabel).toEqual('')
|
||||||
expect(modal.close).toHaveBeenCalled()
|
expect(modal.close).toHaveBeenCalled()
|
||||||
expect(toastService.showSuccess).toHaveBeenCalled()
|
jest.advanceTimersByTime(400)
|
||||||
|
expect(toastService.show).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
content: 'Existing document queued to be added as a version.',
|
||||||
|
actionName: 'View task',
|
||||||
|
})
|
||||||
|
)
|
||||||
|
jest.useRealTimers()
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
+7
-9
@@ -28,6 +28,7 @@ import { DocumentVersionInfo } from 'src/app/data/document'
|
|||||||
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
|
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
|
||||||
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
|
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
|
||||||
import { DocumentService } from 'src/app/services/rest/document.service'
|
import { DocumentService } from 'src/app/services/rest/document.service'
|
||||||
|
import { TaskNotificationService } from 'src/app/services/task-notification.service'
|
||||||
import { ToastService } from 'src/app/services/toast.service'
|
import { ToastService } from 'src/app/services/toast.service'
|
||||||
import {
|
import {
|
||||||
UploadState,
|
UploadState,
|
||||||
@@ -77,6 +78,7 @@ export class DocumentVersionDropdownComponent
|
|||||||
private readonly toastService = inject(ToastService)
|
private readonly toastService = inject(ToastService)
|
||||||
private readonly websocketStatusService = inject(WebsocketStatusService)
|
private readonly websocketStatusService = inject(WebsocketStatusService)
|
||||||
private readonly modalService = inject(NgbModal)
|
private readonly modalService = inject(NgbModal)
|
||||||
|
private readonly taskNotifications = inject(TaskNotificationService)
|
||||||
private readonly destroy$ = new Subject<void>()
|
private readonly destroy$ = new Subject<void>()
|
||||||
private readonly documentChange$ = new Subject<void>()
|
private readonly documentChange$ = new Subject<void>()
|
||||||
|
|
||||||
@@ -305,23 +307,19 @@ export class DocumentVersionDropdownComponent
|
|||||||
versionLabel
|
versionLabel
|
||||||
)
|
)
|
||||||
.pipe(
|
.pipe(
|
||||||
switchMap(() => this.documentsService.getVersions(this.documentId)),
|
|
||||||
first(),
|
first(),
|
||||||
finalize(() => dialog.buttonsEnabled.set(true)),
|
finalize(() => dialog.buttonsEnabled.set(true)),
|
||||||
takeUntil(this.destroy$),
|
takeUntil(this.destroy$),
|
||||||
takeUntil(this.documentChange$)
|
takeUntil(this.documentChange$)
|
||||||
)
|
)
|
||||||
.subscribe({
|
.subscribe({
|
||||||
next: (document) => {
|
next: ({ task_id }) => {
|
||||||
if (document?.versions?.length) {
|
|
||||||
this.versionsUpdated.emit(document.versions)
|
|
||||||
// The API returns versions newest first
|
|
||||||
this.versionSelected.emit(document.versions[0].id)
|
|
||||||
}
|
|
||||||
this.newVersionLabel = ''
|
this.newVersionLabel = ''
|
||||||
modal.close()
|
modal.close()
|
||||||
this.toastService.showSuccess(
|
this.taskNotifications.showQueued(
|
||||||
$localize`Existing document added as a version.`
|
task_id,
|
||||||
|
$localize`Existing document queued to be added as a version.`,
|
||||||
|
{ content: $localize`Existing document added as a version.` }
|
||||||
)
|
)
|
||||||
},
|
},
|
||||||
error: (error) => {
|
error: (error) => {
|
||||||
|
|||||||
@@ -98,6 +98,16 @@
|
|||||||
<button ngbDropdownItem (click)="mergeSelectedAsVersions()" [disabled]="!userOwnsAll || !userCanEditAll || !userCanDelete || list.allSelected || list.selectedCount < 2">
|
<button ngbDropdownItem (click)="mergeSelectedAsVersions()" [disabled]="!userOwnsAll || !userCanEditAll || !userCanDelete || list.allSelected || list.selectedCount < 2">
|
||||||
<pngx-bs-icon name="journal-bookmark-fill" class="me-2"></pngx-bs-icon><ng-container i18n>Merge as versions</ng-container>
|
<pngx-bs-icon name="journal-bookmark-fill" class="me-2"></pngx-bs-icon><ng-container i18n>Merge as versions</ng-container>
|
||||||
</button>
|
</button>
|
||||||
|
@if (manualWorkflows.length > 0) {
|
||||||
|
<button ngbDropdownItem (click)="runWorkflowSelected()" [disabled]="!canRunWorkflow">
|
||||||
|
<pngx-bs-icon name="play-circle" class="me-2"></pngx-bs-icon><ng-container i18n>Run workflow</ng-container>
|
||||||
|
</button>
|
||||||
|
}
|
||||||
|
@if (permissionService.currentUserCan(PermissionAction.View, PermissionType.OcrTemplate)) {
|
||||||
|
<button ngbDropdownItem (click)="runZoneOcrSelected()" [disabled]="!userCanEditAll">
|
||||||
|
<pngx-bs-icon name="bounding-box-circles" class="me-2"></pngx-bs-icon><ng-container i18n>Run Zone OCR</ng-container>
|
||||||
|
</button>
|
||||||
|
}
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
+231
-33
@@ -14,9 +14,11 @@ import { Correspondent } from 'src/app/data/correspondent'
|
|||||||
import { CustomField, CustomFieldDataType } from 'src/app/data/custom-field'
|
import { CustomField, CustomFieldDataType } from 'src/app/data/custom-field'
|
||||||
import { DocumentType } from 'src/app/data/document-type'
|
import { DocumentType } from 'src/app/data/document-type'
|
||||||
import { FILTER_TITLE } from 'src/app/data/filter-rule-type'
|
import { FILTER_TITLE } from 'src/app/data/filter-rule-type'
|
||||||
import { Results } from 'src/app/data/results'
|
import { PaperlessTaskStatus } from 'src/app/data/paperless-task'
|
||||||
|
import { Results, SelectionData } from 'src/app/data/results'
|
||||||
import { StoragePath } from 'src/app/data/storage-path'
|
import { StoragePath } from 'src/app/data/storage-path'
|
||||||
import { Tag } from 'src/app/data/tag'
|
import { Tag } from 'src/app/data/tag'
|
||||||
|
import { WorkflowTriggerType } from 'src/app/data/workflow-trigger'
|
||||||
import { FilterPipe } from 'src/app/pipes/filter.pipe'
|
import { FilterPipe } from 'src/app/pipes/filter.pipe'
|
||||||
import { DocumentListViewService } from 'src/app/services/document-list-view.service'
|
import { DocumentListViewService } from 'src/app/services/document-list-view.service'
|
||||||
import {
|
import {
|
||||||
@@ -27,16 +29,15 @@ import {
|
|||||||
import { CorrespondentService } from 'src/app/services/rest/correspondent.service'
|
import { CorrespondentService } from 'src/app/services/rest/correspondent.service'
|
||||||
import { CustomFieldsService } from 'src/app/services/rest/custom-fields.service'
|
import { CustomFieldsService } from 'src/app/services/rest/custom-fields.service'
|
||||||
import { DocumentTypeService } from 'src/app/services/rest/document-type.service'
|
import { DocumentTypeService } from 'src/app/services/rest/document-type.service'
|
||||||
import {
|
import { DocumentService } from 'src/app/services/rest/document.service'
|
||||||
DocumentService,
|
|
||||||
SelectionData,
|
|
||||||
} from 'src/app/services/rest/document.service'
|
|
||||||
import { GroupService } from 'src/app/services/rest/group.service'
|
import { GroupService } from 'src/app/services/rest/group.service'
|
||||||
import { ShareLinkBundleService } from 'src/app/services/rest/share-link-bundle.service'
|
import { ShareLinkBundleService } from 'src/app/services/rest/share-link-bundle.service'
|
||||||
import { StoragePathService } from 'src/app/services/rest/storage-path.service'
|
import { StoragePathService } from 'src/app/services/rest/storage-path.service'
|
||||||
import { TagService } from 'src/app/services/rest/tag.service'
|
import { TagService } from 'src/app/services/rest/tag.service'
|
||||||
import { UserService } from 'src/app/services/rest/user.service'
|
import { UserService } from 'src/app/services/rest/user.service'
|
||||||
|
import { WorkflowService } from 'src/app/services/rest/workflow.service'
|
||||||
import { SettingsService } from 'src/app/services/settings.service'
|
import { SettingsService } from 'src/app/services/settings.service'
|
||||||
|
import { TaskNotificationService } from 'src/app/services/task-notification.service'
|
||||||
import { ToastService } from 'src/app/services/toast.service'
|
import { ToastService } from 'src/app/services/toast.service'
|
||||||
import { TrashService } from 'src/app/services/trash.service'
|
import { TrashService } from 'src/app/services/trash.service'
|
||||||
import { environment } from 'src/environments/environment'
|
import { environment } from 'src/environments/environment'
|
||||||
@@ -83,6 +84,7 @@ describe('BulkEditorComponent', () => {
|
|||||||
let customFieldsService: CustomFieldsService
|
let customFieldsService: CustomFieldsService
|
||||||
let httpTestingController: HttpTestingController
|
let httpTestingController: HttpTestingController
|
||||||
let shareLinkBundleService: ShareLinkBundleService
|
let shareLinkBundleService: ShareLinkBundleService
|
||||||
|
let workflowService: WorkflowService
|
||||||
let router: Router
|
let router: Router
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
@@ -173,6 +175,22 @@ describe('BulkEditorComponent', () => {
|
|||||||
delete: jest.fn(),
|
delete: jest.fn(),
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
provide: WorkflowService,
|
||||||
|
useValue: {
|
||||||
|
list: jest.fn(() =>
|
||||||
|
of({
|
||||||
|
results: [
|
||||||
|
{
|
||||||
|
id: 5,
|
||||||
|
name: 'Manual workflow',
|
||||||
|
triggers: [{ type: WorkflowTriggerType.Manual }],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
})
|
||||||
|
),
|
||||||
|
},
|
||||||
|
},
|
||||||
{
|
{
|
||||||
provide: Router,
|
provide: Router,
|
||||||
useValue: { navigate: jest.fn().mockResolvedValue(true) },
|
useValue: { navigate: jest.fn().mockResolvedValue(true) },
|
||||||
@@ -195,6 +213,7 @@ describe('BulkEditorComponent', () => {
|
|||||||
customFieldsService = TestBed.inject(CustomFieldsService)
|
customFieldsService = TestBed.inject(CustomFieldsService)
|
||||||
httpTestingController = TestBed.inject(HttpTestingController)
|
httpTestingController = TestBed.inject(HttpTestingController)
|
||||||
shareLinkBundleService = TestBed.inject(ShareLinkBundleService)
|
shareLinkBundleService = TestBed.inject(ShareLinkBundleService)
|
||||||
|
workflowService = TestBed.inject(WorkflowService)
|
||||||
router = TestBed.inject(Router)
|
router = TestBed.inject(Router)
|
||||||
|
|
||||||
fixture = TestBed.createComponent(BulkEditorComponent)
|
fixture = TestBed.createComponent(BulkEditorComponent)
|
||||||
@@ -654,6 +673,80 @@ describe('BulkEditorComponent', () => {
|
|||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('should load manual workflows on init', () => {
|
||||||
|
jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(workflowService.list).toHaveBeenCalledWith(1, 100000, null, null, {
|
||||||
|
trigger_type: WorkflowTriggerType.Manual,
|
||||||
|
enabled: true,
|
||||||
|
})
|
||||||
|
expect(component.manualWorkflows).toHaveLength(1)
|
||||||
|
expect(component.manualWorkflows[0].id).toEqual(5)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should run a workflow on the selection via the run workflow dialog', () => {
|
||||||
|
const toast = jest.spyOn(toastService, 'show')
|
||||||
|
const infoToast = jest.spyOn(toastService, 'showInfo')
|
||||||
|
let modal: NgbModalRef
|
||||||
|
modalService.activeInstances.subscribe((m) => (modal = m[0]))
|
||||||
|
jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
|
||||||
|
jest
|
||||||
|
.spyOn(documentListViewService, 'documents', 'get')
|
||||||
|
.mockReturnValue([{ id: 3 }, { id: 4 }])
|
||||||
|
jest
|
||||||
|
.spyOn(documentListViewService, 'selected', 'get')
|
||||||
|
.mockReturnValue(new Set([3, 4]))
|
||||||
|
fixture.detectChanges()
|
||||||
|
component.runWorkflowSelected()
|
||||||
|
expect(modal).not.toBeUndefined()
|
||||||
|
expect(modal.componentInstance.workflows).toEqual(component.manualWorkflows)
|
||||||
|
expect(modal.componentInstance.singleDocument).toBe(false)
|
||||||
|
expect(modal.componentInstance.force).toBe(false)
|
||||||
|
modal.componentInstance.workflowId = 5
|
||||||
|
modal.componentInstance.force = true
|
||||||
|
modal.componentInstance.confirm()
|
||||||
|
const req = httpTestingController.expectOne(
|
||||||
|
`${environment.apiBaseUrl}documents/bulk_edit/`
|
||||||
|
)
|
||||||
|
expect(req.request.body.method).toEqual('run_workflow')
|
||||||
|
expect(req.request.body.parameters).toEqual({
|
||||||
|
workflow: 5,
|
||||||
|
filter_documents: false,
|
||||||
|
})
|
||||||
|
req.flush({ result: 'OK' })
|
||||||
|
expect(infoToast).toHaveBeenCalledWith(
|
||||||
|
'Workflow will run on the selected documents in the background.'
|
||||||
|
)
|
||||||
|
expect(toast.mock.calls.at(-1)[0].actionName).toBeUndefined()
|
||||||
|
httpTestingController.match(
|
||||||
|
`${environment.apiBaseUrl}documents/?page=1&page_size=50&ordering=-created&truncate_content=true&include_selection_data=true`
|
||||||
|
) // list reload
|
||||||
|
httpTestingController.match(
|
||||||
|
`${environment.apiBaseUrl}documents/?page=1&page_size=100000&fields=id`
|
||||||
|
) // listAllFilteredIds
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should require ownership of selected documents to run a workflow', () => {
|
||||||
|
component.manualWorkflows = [{ id: 5 }] as any
|
||||||
|
jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
|
||||||
|
jest
|
||||||
|
.spyOn(permissionsService, 'currentUserHasObjectPermissions')
|
||||||
|
.mockReturnValue(true)
|
||||||
|
const ownsDocument = jest
|
||||||
|
.spyOn(permissionsService, 'currentUserOwnsObject')
|
||||||
|
.mockReturnValue(false)
|
||||||
|
jest
|
||||||
|
.spyOn(documentListViewService, 'documents', 'get')
|
||||||
|
.mockReturnValue([{ id: 3 }])
|
||||||
|
jest
|
||||||
|
.spyOn(documentListViewService, 'selected', 'get')
|
||||||
|
.mockReturnValue(new Set([3]))
|
||||||
|
|
||||||
|
expect(component.canRunWorkflow).toBe(false)
|
||||||
|
ownsDocument.mockReturnValue(true)
|
||||||
|
expect(component.canRunWorkflow).toBe(true)
|
||||||
|
})
|
||||||
|
|
||||||
it('should set modal dialog text accordingly for tag edit confirmation', () => {
|
it('should set modal dialog text accordingly for tag edit confirmation', () => {
|
||||||
let modal: NgbModalRef
|
let modal: NgbModalRef
|
||||||
modalService.activeInstances.subscribe((m) => (modal = m[m.length - 1]))
|
modalService.activeInstances.subscribe((m) => (modal = m[m.length - 1]))
|
||||||
@@ -1172,14 +1265,15 @@ describe('BulkEditorComponent', () => {
|
|||||||
let req = httpTestingController.expectOne(
|
let req = httpTestingController.expectOne(
|
||||||
`${environment.apiBaseUrl}documents/delete/`
|
`${environment.apiBaseUrl}documents/delete/`
|
||||||
)
|
)
|
||||||
const notifySpy = jest
|
const trackSpy = jest
|
||||||
.spyOn(trashService, 'notifyMovedToTrash')
|
.spyOn(trashService, 'trackMovedToTrash')
|
||||||
.mockImplementation(() => {})
|
.mockImplementation(() => {})
|
||||||
req.flush(true)
|
req.flush({ result: 'OK', task_id: 'delete-1' })
|
||||||
expect(req.request.body).toEqual({
|
expect(req.request.body).toEqual({
|
||||||
documents: [3, 4],
|
documents: [3, 4],
|
||||||
|
from_webui: true,
|
||||||
})
|
})
|
||||||
expect(notifySpy).toHaveBeenCalledWith(expect.any(String), [3, 4])
|
expect(trackSpy).toHaveBeenCalledWith('delete-1', 2, [3, 4])
|
||||||
httpTestingController.match(
|
httpTestingController.match(
|
||||||
`${environment.apiBaseUrl}documents/?page=1&page_size=50&ordering=-created&truncate_content=true&include_selection_data=true`
|
`${environment.apiBaseUrl}documents/?page=1&page_size=50&ordering=-created&truncate_content=true&include_selection_data=true`
|
||||||
) // list reload
|
) // list reload
|
||||||
@@ -1196,9 +1290,9 @@ describe('BulkEditorComponent', () => {
|
|||||||
req = httpTestingController.expectOne(
|
req = httpTestingController.expectOne(
|
||||||
`${environment.apiBaseUrl}documents/delete/`
|
`${environment.apiBaseUrl}documents/delete/`
|
||||||
)
|
)
|
||||||
req.flush(true)
|
req.flush({ result: 'OK', task_id: 'delete-2' })
|
||||||
// ids aren't known when all matching documents are selected, so no undo
|
// ids aren't known when all matching documents are selected, so no undo
|
||||||
expect(notifySpy).toHaveBeenLastCalledWith(expect.any(String), null)
|
expect(trackSpy).toHaveBeenLastCalledWith('delete-2', 2, null)
|
||||||
httpTestingController.match(
|
httpTestingController.match(
|
||||||
`${environment.apiBaseUrl}documents/?page=1&page_size=50&ordering=-created&truncate_content=true&include_selection_data=true`
|
`${environment.apiBaseUrl}documents/?page=1&page_size=50&ordering=-created&truncate_content=true&include_selection_data=true`
|
||||||
) // list reload
|
) // list reload
|
||||||
@@ -1278,10 +1372,11 @@ describe('BulkEditorComponent', () => {
|
|||||||
let req = httpTestingController.expectOne(
|
let req = httpTestingController.expectOne(
|
||||||
`${environment.apiBaseUrl}documents/reprocess/`
|
`${environment.apiBaseUrl}documents/reprocess/`
|
||||||
)
|
)
|
||||||
req.flush(true)
|
req.flush({ result: 'OK', task_id: 'reprocess-1' })
|
||||||
expect(req.request.body).toEqual({
|
expect(req.request.body).toEqual({
|
||||||
documents: [3, 4],
|
documents: [3, 4],
|
||||||
remote_ocr: false,
|
remote_ocr: false,
|
||||||
|
from_webui: true,
|
||||||
})
|
})
|
||||||
httpTestingController.match(
|
httpTestingController.match(
|
||||||
`${environment.apiBaseUrl}documents/?page=1&page_size=50&ordering=-created&truncate_content=true&include_selection_data=true`
|
`${environment.apiBaseUrl}documents/?page=1&page_size=50&ordering=-created&truncate_content=true&include_selection_data=true`
|
||||||
@@ -1291,7 +1386,72 @@ describe('BulkEditorComponent', () => {
|
|||||||
) // listAllFilteredIds
|
) // listAllFilteredIds
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('should support run zone ocr', () => {
|
||||||
|
const queued = jest
|
||||||
|
.spyOn(TestBed.inject(TaskNotificationService), 'showQueued')
|
||||||
|
.mockImplementation(() => {})
|
||||||
|
const reload = jest.spyOn(documentListViewService, 'reload')
|
||||||
|
let modal: NgbModalRef
|
||||||
|
modalService.activeInstances.subscribe((m) => (modal = m[0]))
|
||||||
|
jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
|
||||||
|
jest
|
||||||
|
.spyOn(documentListViewService, 'documents', 'get')
|
||||||
|
.mockReturnValue([{ id: 3 }, { id: 4 }])
|
||||||
|
jest
|
||||||
|
.spyOn(documentListViewService, 'selected', 'get')
|
||||||
|
.mockReturnValue(new Set([3, 4]))
|
||||||
|
jest
|
||||||
|
.spyOn(permissionsService, 'currentUserHasObjectPermissions')
|
||||||
|
.mockReturnValue(true)
|
||||||
|
fixture.detectChanges()
|
||||||
|
component.runZoneOcrSelected()
|
||||||
|
expect(modal).not.toBeUndefined()
|
||||||
|
modal.componentInstance.confirm()
|
||||||
|
let req = httpTestingController.expectOne(
|
||||||
|
`${environment.apiBaseUrl}documents/run_zone_ocr/`
|
||||||
|
)
|
||||||
|
req.flush({ result: 'OK', task_id: 'zone-ocr-1' })
|
||||||
|
expect(req.request.body).toEqual({
|
||||||
|
documents: [3, 4],
|
||||||
|
from_webui: true,
|
||||||
|
})
|
||||||
|
expect(queued).toHaveBeenLastCalledWith(
|
||||||
|
'zone-ocr-1',
|
||||||
|
"Bulk operation 'Run zone OCR' queued.",
|
||||||
|
{ content: "Bulk operation 'Run zone OCR' completed." }
|
||||||
|
)
|
||||||
|
expect(reload).not.toHaveBeenCalled()
|
||||||
|
|
||||||
|
component.runZoneOcrSelected()
|
||||||
|
modal.componentInstance.template = 3
|
||||||
|
modal.componentInstance.confirm()
|
||||||
|
req = httpTestingController.expectOne(
|
||||||
|
`${environment.apiBaseUrl}documents/run_zone_ocr/`
|
||||||
|
)
|
||||||
|
req.flush({ result: 'OK', task_id: 'zone-ocr-2' })
|
||||||
|
expect(req.request.body).toEqual({
|
||||||
|
documents: [3, 4],
|
||||||
|
template: 3,
|
||||||
|
from_webui: true,
|
||||||
|
})
|
||||||
|
expect(queued).toHaveBeenLastCalledWith(
|
||||||
|
'zone-ocr-2',
|
||||||
|
"Bulk operation 'Run zone OCR' queued.",
|
||||||
|
{ content: "Bulk operation 'Run zone OCR' completed." }
|
||||||
|
)
|
||||||
|
httpTestingController.match(
|
||||||
|
`${environment.apiBaseUrl}ocr_templates/?page=1&page_size=100000`
|
||||||
|
) // template list
|
||||||
|
httpTestingController.match(
|
||||||
|
`${environment.apiBaseUrl}documents/?page=1&page_size=50&ordering=-created&truncate_content=true&include_selection_data=true`
|
||||||
|
) // list reload
|
||||||
|
httpTestingController.match(
|
||||||
|
`${environment.apiBaseUrl}documents/?page=1&page_size=100000&fields=id`
|
||||||
|
) // listAllFilteredIds
|
||||||
|
})
|
||||||
|
|
||||||
it('should support rotate', () => {
|
it('should support rotate', () => {
|
||||||
|
const toast = jest.spyOn(toastService, 'show')
|
||||||
let modal: NgbModalRef
|
let modal: NgbModalRef
|
||||||
modalService.activeInstances.subscribe((m) => (modal = m[0]))
|
modalService.activeInstances.subscribe((m) => (modal = m[0]))
|
||||||
jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
|
jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
|
||||||
@@ -1312,11 +1472,20 @@ describe('BulkEditorComponent', () => {
|
|||||||
let req = httpTestingController.expectOne(
|
let req = httpTestingController.expectOne(
|
||||||
`${environment.apiBaseUrl}documents/rotate/`
|
`${environment.apiBaseUrl}documents/rotate/`
|
||||||
)
|
)
|
||||||
req.flush(true)
|
req.flush({ result: 'OK', task_id: 'rotate-1' })
|
||||||
|
TestBed.inject(TaskNotificationService).complete({
|
||||||
|
task_id: 'rotate-1',
|
||||||
|
operation: 'rotate',
|
||||||
|
status: PaperlessTaskStatus.Success,
|
||||||
|
})
|
||||||
|
expect(toast.mock.calls.at(-1)[0].content).toBe(
|
||||||
|
"Bulk operation 'Rotate documents' submitted for processing."
|
||||||
|
)
|
||||||
expect(req.request.body).toEqual({
|
expect(req.request.body).toEqual({
|
||||||
documents: [3, 4],
|
documents: [3, 4],
|
||||||
degrees: 90,
|
degrees: 90,
|
||||||
source_mode: 'latest_version',
|
source_mode: 'latest_version',
|
||||||
|
from_webui: true,
|
||||||
})
|
})
|
||||||
httpTestingController.match(
|
httpTestingController.match(
|
||||||
`${environment.apiBaseUrl}documents/?page=1&page_size=50&ordering=-created&truncate_content=true&include_selection_data=true`
|
`${environment.apiBaseUrl}documents/?page=1&page_size=50&ordering=-created&truncate_content=true&include_selection_data=true`
|
||||||
@@ -1354,10 +1523,11 @@ describe('BulkEditorComponent', () => {
|
|||||||
let req = httpTestingController.expectOne(
|
let req = httpTestingController.expectOne(
|
||||||
`${environment.apiBaseUrl}documents/merge/`
|
`${environment.apiBaseUrl}documents/merge/`
|
||||||
)
|
)
|
||||||
req.flush(true)
|
req.flush({ result: 'OK', task_id: 'merge-1' })
|
||||||
expect(req.request.body).toEqual({
|
expect(req.request.body).toEqual({
|
||||||
documents: [3, 4],
|
documents: [3, 4],
|
||||||
metadata_document_id: 3,
|
metadata_document_id: 3,
|
||||||
|
from_webui: true,
|
||||||
})
|
})
|
||||||
httpTestingController.match(
|
httpTestingController.match(
|
||||||
`${environment.apiBaseUrl}documents/?page=1&page_size=50&ordering=-created&truncate_content=true&include_selection_data=true`
|
`${environment.apiBaseUrl}documents/?page=1&page_size=50&ordering=-created&truncate_content=true&include_selection_data=true`
|
||||||
@@ -1372,11 +1542,12 @@ describe('BulkEditorComponent', () => {
|
|||||||
req = httpTestingController.expectOne(
|
req = httpTestingController.expectOne(
|
||||||
`${environment.apiBaseUrl}documents/merge/`
|
`${environment.apiBaseUrl}documents/merge/`
|
||||||
)
|
)
|
||||||
req.flush(true)
|
req.flush({ result: 'OK', task_id: 'merge-2' })
|
||||||
expect(req.request.body).toEqual({
|
expect(req.request.body).toEqual({
|
||||||
documents: [3, 4],
|
documents: [3, 4],
|
||||||
metadata_document_id: 3,
|
metadata_document_id: 3,
|
||||||
delete_originals: true,
|
delete_originals: true,
|
||||||
|
from_webui: true,
|
||||||
})
|
})
|
||||||
httpTestingController.match(
|
httpTestingController.match(
|
||||||
`${environment.apiBaseUrl}documents/?page=1&page_size=50&ordering=-created&truncate_content=true&include_selection_data=true`
|
`${environment.apiBaseUrl}documents/?page=1&page_size=50&ordering=-created&truncate_content=true&include_selection_data=true`
|
||||||
@@ -1384,7 +1555,6 @@ describe('BulkEditorComponent', () => {
|
|||||||
httpTestingController.match(
|
httpTestingController.match(
|
||||||
`${environment.apiBaseUrl}documents/?page=1&page_size=100000&fields=id`
|
`${environment.apiBaseUrl}documents/?page=1&page_size=100000&fields=id`
|
||||||
) // listAllFilteredIds
|
) // listAllFilteredIds
|
||||||
expect(documentListViewService.selected.size).toEqual(0)
|
|
||||||
|
|
||||||
// Test with archiveFallback enabled
|
// Test with archiveFallback enabled
|
||||||
modal.componentInstance.deleteOriginals.set(false)
|
modal.componentInstance.deleteOriginals.set(false)
|
||||||
@@ -1393,11 +1563,12 @@ describe('BulkEditorComponent', () => {
|
|||||||
req = httpTestingController.expectOne(
|
req = httpTestingController.expectOne(
|
||||||
`${environment.apiBaseUrl}documents/merge/`
|
`${environment.apiBaseUrl}documents/merge/`
|
||||||
)
|
)
|
||||||
req.flush(true)
|
req.flush({ result: 'OK', task_id: 'merge-3' })
|
||||||
expect(req.request.body).toEqual({
|
expect(req.request.body).toEqual({
|
||||||
documents: [3, 4],
|
documents: [3, 4],
|
||||||
metadata_document_id: 3,
|
metadata_document_id: 3,
|
||||||
archive_fallback: true,
|
archive_fallback: true,
|
||||||
|
from_webui: true,
|
||||||
})
|
})
|
||||||
httpTestingController.match(
|
httpTestingController.match(
|
||||||
`${environment.apiBaseUrl}documents/?page=1&page_size=50&ordering=-created&truncate_content=true&include_selection_data=true`
|
`${environment.apiBaseUrl}documents/?page=1&page_size=50&ordering=-created&truncate_content=true&include_selection_data=true`
|
||||||
@@ -1405,10 +1576,10 @@ describe('BulkEditorComponent', () => {
|
|||||||
httpTestingController.match(
|
httpTestingController.match(
|
||||||
`${environment.apiBaseUrl}documents/?page=1&page_size=100000&fields=id`
|
`${environment.apiBaseUrl}documents/?page=1&page_size=100000&fields=id`
|
||||||
) // listAllFilteredIds
|
) // listAllFilteredIds
|
||||||
expect(documentListViewService.selected.size).toEqual(0)
|
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should support merging documents as versions', () => {
|
it('should support merging documents as versions', () => {
|
||||||
|
jest.useFakeTimers()
|
||||||
let modal: NgbModalRef
|
let modal: NgbModalRef
|
||||||
modalService.activeInstances.subscribe((m) => (modal = m[0]))
|
modalService.activeInstances.subscribe((m) => (modal = m[0]))
|
||||||
jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
|
jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
|
||||||
@@ -1436,8 +1607,8 @@ describe('BulkEditorComponent', () => {
|
|||||||
.mockReturnValue(true)
|
.mockReturnValue(true)
|
||||||
const mergeAsVersionsSpy = jest
|
const mergeAsVersionsSpy = jest
|
||||||
.spyOn(documentService, 'mergeDocumentsAsVersions')
|
.spyOn(documentService, 'mergeDocumentsAsVersions')
|
||||||
.mockReturnValue(of(true))
|
.mockReturnValue(of({ result: 'OK', task_id: 'versions-1' }))
|
||||||
const toastSuccessSpy = jest.spyOn(toastService, 'showSuccess')
|
const toastSpy = jest.spyOn(toastService, 'show')
|
||||||
fixture.detectChanges()
|
fixture.detectChanges()
|
||||||
|
|
||||||
component.mergeSelectedAsVersions()
|
component.mergeSelectedAsVersions()
|
||||||
@@ -1452,10 +1623,21 @@ describe('BulkEditorComponent', () => {
|
|||||||
httpTestingController.match(
|
httpTestingController.match(
|
||||||
`${environment.apiBaseUrl}documents/?page=1&page_size=100000&fields=id`
|
`${environment.apiBaseUrl}documents/?page=1&page_size=100000&fields=id`
|
||||||
)
|
)
|
||||||
expect(documentListViewService.selected.size).toEqual(0)
|
jest.advanceTimersByTime(400)
|
||||||
expect(toastSuccessSpy).toHaveBeenCalledWith(
|
expect(toastSpy).toHaveBeenCalledWith(
|
||||||
'Documents merged as versions.'
|
expect.objectContaining({
|
||||||
|
content: "Bulk operation 'Merge as versions' queued.",
|
||||||
|
})
|
||||||
)
|
)
|
||||||
|
TestBed.inject(TaskNotificationService).complete({
|
||||||
|
task_id: 'versions-1',
|
||||||
|
operation: 'merge_as_versions',
|
||||||
|
status: PaperlessTaskStatus.Success,
|
||||||
|
})
|
||||||
|
expect(toastSpy.mock.calls.at(-1)[0].content).toBe(
|
||||||
|
"Bulk operation 'Merge as versions' completed."
|
||||||
|
)
|
||||||
|
jest.useRealTimers()
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should not report success when merging documents as versions fails', () => {
|
it('should not report success when merging documents as versions fails', () => {
|
||||||
@@ -1546,12 +1728,22 @@ describe('BulkEditorComponent', () => {
|
|||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
it.each([true, false])(
|
it.each<[boolean, number]>([
|
||||||
'shows queued feedback and gates the task link on permission (%s)',
|
[true, 2],
|
||||||
(canViewTasks) => {
|
[false, 2],
|
||||||
|
[true, 1],
|
||||||
|
])(
|
||||||
|
'names queued work and gates the task link (permission %s, documents %s)',
|
||||||
|
(canViewTasks, count) => {
|
||||||
|
jest.useFakeTimers()
|
||||||
jest
|
jest
|
||||||
.spyOn(permissionsService, 'currentUserCan')
|
.spyOn(permissionsService, 'currentUserCan')
|
||||||
.mockReturnValue(canViewTasks)
|
.mockReturnValue(canViewTasks)
|
||||||
|
jest
|
||||||
|
.spyOn(documentListViewService, 'selected', 'get')
|
||||||
|
.mockReturnValue(
|
||||||
|
new Set(Array.from({ length: count }, (_, index) => index + 3))
|
||||||
|
)
|
||||||
const queued = jest.spyOn(toastService, 'show')
|
const queued = jest.spyOn(toastService, 'show')
|
||||||
let modal: NgbModalRef
|
let modal: NgbModalRef
|
||||||
modalService.activeInstances.subscribe((instances) => {
|
modalService.activeInstances.subscribe((instances) => {
|
||||||
@@ -1569,8 +1761,11 @@ describe('BulkEditorComponent', () => {
|
|||||||
)
|
)
|
||||||
req.flush({ result: 'OK', task_id: 'queued-operation' })
|
req.flush({ result: 'OK', task_id: 'queued-operation' })
|
||||||
expect(close).toHaveBeenCalledTimes(1)
|
expect(close).toHaveBeenCalledTimes(1)
|
||||||
|
expect(queued).not.toHaveBeenCalled()
|
||||||
|
jest.advanceTimersByTime(400)
|
||||||
const notification = queued.mock.calls.at(-1)[0]
|
const notification = queued.mock.calls.at(-1)[0]
|
||||||
expect(notification.content).toBe('Bulk operation queued.')
|
const prefix = count > 1 ? 'Bulk operation' : 'Operation'
|
||||||
|
expect(notification.content).toBe(`${prefix} \'Set permissions\' queued.`)
|
||||||
if (canViewTasks) {
|
if (canViewTasks) {
|
||||||
expect(notification.actionName).toBe('View task')
|
expect(notification.actionName).toBe('View task')
|
||||||
notification.action()
|
notification.action()
|
||||||
@@ -1582,8 +1777,16 @@ describe('BulkEditorComponent', () => {
|
|||||||
expect(notification.actionName).toBeUndefined()
|
expect(notification.actionName).toBeUndefined()
|
||||||
}
|
}
|
||||||
expect(reload).not.toHaveBeenCalled()
|
expect(reload).not.toHaveBeenCalled()
|
||||||
expect(documentListViewService.selected.size).toBe(0)
|
|
||||||
expect(documentListViewService.allSelected).toBe(false)
|
expect(documentListViewService.allSelected).toBe(false)
|
||||||
|
TestBed.inject(TaskNotificationService).complete({
|
||||||
|
task_id: 'queued-operation',
|
||||||
|
operation: 'set_permissions',
|
||||||
|
status: PaperlessTaskStatus.Success,
|
||||||
|
})
|
||||||
|
const completed = queued.mock.calls.at(-1)[0]
|
||||||
|
expect(completed.content).toBe(`${prefix} \'Set permissions\' completed.`)
|
||||||
|
expect(completed.action).toBeUndefined()
|
||||||
|
jest.useRealTimers()
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -1664,7 +1867,6 @@ describe('BulkEditorComponent', () => {
|
|||||||
{ id: 2, name: 'Tag 2' },
|
{ id: 2, name: 'Tag 2' },
|
||||||
],
|
],
|
||||||
count: 2,
|
count: 2,
|
||||||
all: [1, 2],
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const modalInstance = {
|
const modalInstance = {
|
||||||
@@ -1707,7 +1909,6 @@ describe('BulkEditorComponent', () => {
|
|||||||
{ id: 2, name: 'Correspondent 2' },
|
{ id: 2, name: 'Correspondent 2' },
|
||||||
],
|
],
|
||||||
count: 2,
|
count: 2,
|
||||||
all: [1, 2],
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const modalInstance = {
|
const modalInstance = {
|
||||||
@@ -1756,7 +1957,6 @@ describe('BulkEditorComponent', () => {
|
|||||||
{ id: 2, name: 'Document Type 2' },
|
{ id: 2, name: 'Document Type 2' },
|
||||||
],
|
],
|
||||||
count: 2,
|
count: 2,
|
||||||
all: [1, 2],
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const modalInstance = {
|
const modalInstance = {
|
||||||
@@ -1802,7 +2002,6 @@ describe('BulkEditorComponent', () => {
|
|||||||
{ id: 2, name: 'Storage Path 2' },
|
{ id: 2, name: 'Storage Path 2' },
|
||||||
],
|
],
|
||||||
count: 2,
|
count: 2,
|
||||||
all: [1, 2],
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const modalInstance = {
|
const modalInstance = {
|
||||||
@@ -1856,7 +2055,6 @@ describe('BulkEditorComponent', () => {
|
|||||||
},
|
},
|
||||||
],
|
],
|
||||||
count: 2,
|
count: 2,
|
||||||
all: [1, 2],
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const modalInstance = {
|
const modalInstance = {
|
||||||
|
|||||||
@@ -19,24 +19,18 @@ import {
|
|||||||
NgbModalRef,
|
NgbModalRef,
|
||||||
} from '@ng-bootstrap/ng-bootstrap'
|
} from '@ng-bootstrap/ng-bootstrap'
|
||||||
import { saveAs } from 'file-saver'
|
import { saveAs } from 'file-saver'
|
||||||
import {
|
import { first, map, Observable, Subject, switchMap, takeUntil } from 'rxjs'
|
||||||
first,
|
|
||||||
map,
|
|
||||||
Observable,
|
|
||||||
Subject,
|
|
||||||
switchMap,
|
|
||||||
takeUntil,
|
|
||||||
tap,
|
|
||||||
} from 'rxjs'
|
|
||||||
import { BootstrapIconComponent } from 'src/app/components/common/bootstrap-icon/bootstrap-icon.component'
|
import { BootstrapIconComponent } from 'src/app/components/common/bootstrap-icon/bootstrap-icon.component'
|
||||||
import { ConfirmDialogComponent } from 'src/app/components/common/confirm-dialog/confirm-dialog.component'
|
import { ConfirmDialogComponent } from 'src/app/components/common/confirm-dialog/confirm-dialog.component'
|
||||||
|
import { BulkOperationResponse } from 'src/app/data/bulk-operation'
|
||||||
import { CustomField } from 'src/app/data/custom-field'
|
import { CustomField } from 'src/app/data/custom-field'
|
||||||
import { MatchingModel } from 'src/app/data/matching-model'
|
import { MatchingModel } from 'src/app/data/matching-model'
|
||||||
import { SelectionDataItem } from 'src/app/data/results'
|
import { SelectionDataItem } from 'src/app/data/results'
|
||||||
import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
|
import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
|
||||||
|
import { Workflow } from 'src/app/data/workflow'
|
||||||
|
import { WorkflowTriggerType } from 'src/app/data/workflow-trigger'
|
||||||
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
|
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
|
||||||
import { DocumentListViewService } from 'src/app/services/document-list-view.service'
|
import { DocumentListViewService } from 'src/app/services/document-list-view.service'
|
||||||
import { OpenDocumentsService } from 'src/app/services/open-documents.service'
|
|
||||||
import {
|
import {
|
||||||
PermissionAction,
|
PermissionAction,
|
||||||
PermissionsService,
|
PermissionsService,
|
||||||
@@ -51,19 +45,26 @@ import {
|
|||||||
DocumentService,
|
DocumentService,
|
||||||
MergeDocumentsRequest,
|
MergeDocumentsRequest,
|
||||||
} from 'src/app/services/rest/document.service'
|
} from 'src/app/services/rest/document.service'
|
||||||
import { SavedViewService } from 'src/app/services/rest/saved-view.service'
|
|
||||||
import { ShareLinkBundleService } from 'src/app/services/rest/share-link-bundle.service'
|
import { ShareLinkBundleService } from 'src/app/services/rest/share-link-bundle.service'
|
||||||
import { StoragePathService } from 'src/app/services/rest/storage-path.service'
|
import { StoragePathService } from 'src/app/services/rest/storage-path.service'
|
||||||
import { TagService } from 'src/app/services/rest/tag.service'
|
import { TagService } from 'src/app/services/rest/tag.service'
|
||||||
|
import { WorkflowService } from 'src/app/services/rest/workflow.service'
|
||||||
import { SettingsService } from 'src/app/services/settings.service'
|
import { SettingsService } from 'src/app/services/settings.service'
|
||||||
|
import { TaskNotificationService } from 'src/app/services/task-notification.service'
|
||||||
import { ToastService } from 'src/app/services/toast.service'
|
import { ToastService } from 'src/app/services/toast.service'
|
||||||
import { TrashService } from 'src/app/services/trash.service'
|
import { TrashService } from 'src/app/services/trash.service'
|
||||||
|
import {
|
||||||
|
documentOperationHasFollowUpTasks,
|
||||||
|
getDocumentOperationLabel,
|
||||||
|
} from 'src/app/utils/document-operation'
|
||||||
import { flattenTags } from 'src/app/utils/flatten-tags'
|
import { flattenTags } from 'src/app/utils/flatten-tags'
|
||||||
import { queryParamsFromFilterRules } from 'src/app/utils/query-params'
|
import { queryParamsFromFilterRules } from 'src/app/utils/query-params'
|
||||||
import { MergeAsVersionsConfirmDialogComponent } from '../../common/confirm-dialog/merge-as-versions-confirm-dialog/merge-as-versions-confirm-dialog.component'
|
import { MergeAsVersionsConfirmDialogComponent } from '../../common/confirm-dialog/merge-as-versions-confirm-dialog/merge-as-versions-confirm-dialog.component'
|
||||||
import { MergeConfirmDialogComponent } from '../../common/confirm-dialog/merge-confirm-dialog/merge-confirm-dialog.component'
|
import { MergeConfirmDialogComponent } from '../../common/confirm-dialog/merge-confirm-dialog/merge-confirm-dialog.component'
|
||||||
import { ReprocessConfirmDialogComponent } from '../../common/confirm-dialog/reprocess-confirm-dialog/reprocess-confirm-dialog.component'
|
import { ReprocessConfirmDialogComponent } from '../../common/confirm-dialog/reprocess-confirm-dialog/reprocess-confirm-dialog.component'
|
||||||
import { RotateConfirmDialogComponent } from '../../common/confirm-dialog/rotate-confirm-dialog/rotate-confirm-dialog.component'
|
import { RotateConfirmDialogComponent } from '../../common/confirm-dialog/rotate-confirm-dialog/rotate-confirm-dialog.component'
|
||||||
|
import { RunWorkflowConfirmDialogComponent } from '../../common/confirm-dialog/run-workflow-confirm-dialog/run-workflow-confirm-dialog.component'
|
||||||
|
import { ZoneOcrConfirmDialogComponent } from '../../common/confirm-dialog/zone-ocr-confirm-dialog/zone-ocr-confirm-dialog.component'
|
||||||
import { CorrespondentEditDialogComponent } from '../../common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component'
|
import { CorrespondentEditDialogComponent } from '../../common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component'
|
||||||
import { CustomFieldEditDialogComponent } from '../../common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component'
|
import { CustomFieldEditDialogComponent } from '../../common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component'
|
||||||
import { DocumentTypeEditDialogComponent } from '../../common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component'
|
import { DocumentTypeEditDialogComponent } from '../../common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component'
|
||||||
@@ -106,16 +107,18 @@ export class BulkEditorComponent
|
|||||||
private documentService = inject(DocumentService)
|
private documentService = inject(DocumentService)
|
||||||
private trashService = inject(TrashService)
|
private trashService = inject(TrashService)
|
||||||
private modalService = inject(NgbModal)
|
private modalService = inject(NgbModal)
|
||||||
private openDocumentService = inject(OpenDocumentsService)
|
|
||||||
private settings = inject(SettingsService)
|
private settings = inject(SettingsService)
|
||||||
private toastService = inject(ToastService)
|
private toastService = inject(ToastService)
|
||||||
|
private taskNotifications = inject(TaskNotificationService)
|
||||||
private storagePathService = inject(StoragePathService)
|
private storagePathService = inject(StoragePathService)
|
||||||
private customFieldService = inject(CustomFieldsService)
|
private customFieldService = inject(CustomFieldsService)
|
||||||
public readonly permissionService = inject(PermissionsService)
|
public readonly permissionService = inject(PermissionsService)
|
||||||
private savedViewService = inject(SavedViewService)
|
|
||||||
private readonly shareLinkBundleService = inject(ShareLinkBundleService)
|
private readonly shareLinkBundleService = inject(ShareLinkBundleService)
|
||||||
|
private readonly workflowService = inject(WorkflowService)
|
||||||
private readonly router = inject(Router)
|
private readonly router = inject(Router)
|
||||||
|
|
||||||
|
public manualWorkflows: Workflow[] = []
|
||||||
|
|
||||||
tagSelectionModel = new FilterableDropdownSelectionModel(true)
|
tagSelectionModel = new FilterableDropdownSelectionModel(true)
|
||||||
correspondentSelectionModel = new FilterableDropdownSelectionModel()
|
correspondentSelectionModel = new FilterableDropdownSelectionModel()
|
||||||
documentTypeSelectionModel = new FilterableDropdownSelectionModel()
|
documentTypeSelectionModel = new FilterableDropdownSelectionModel()
|
||||||
@@ -258,6 +261,20 @@ export class BulkEditorComponent
|
|||||||
(result) => (this.customFieldsSelectionModel.items = result.results)
|
(result) => (this.customFieldsSelectionModel.items = result.results)
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
if (
|
||||||
|
this.permissionService.currentUserCan(
|
||||||
|
PermissionAction.View,
|
||||||
|
PermissionType.Workflow
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
this.workflowService
|
||||||
|
.list(1, 100000, null, null, {
|
||||||
|
trigger_type: WorkflowTriggerType.Manual,
|
||||||
|
enabled: true,
|
||||||
|
})
|
||||||
|
.pipe(first())
|
||||||
|
.subscribe((result) => (this.manualWorkflows = result.results))
|
||||||
|
}
|
||||||
|
|
||||||
this.downloadForm
|
this.downloadForm
|
||||||
.get('downloadFileTypeArchive')
|
.get('downloadFileTypeArchive')
|
||||||
@@ -286,6 +303,42 @@ export class BulkEditorComponent
|
|||||||
this.unsubscribeNotifier.complete()
|
this.unsubscribeNotifier.complete()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
get canRunWorkflow(): boolean {
|
||||||
|
return (
|
||||||
|
this.userCanEditAll && this.userOwnsAll && this.manualWorkflows.length > 0
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
runWorkflowSelected() {
|
||||||
|
const modal = this.modalService.open(RunWorkflowConfirmDialogComponent, {
|
||||||
|
backdrop: 'static',
|
||||||
|
})
|
||||||
|
modal.componentInstance.title = $localize`Run workflow`
|
||||||
|
modal.componentInstance.message = $localize`Run a workflow on ${this.getSelectionSize()} selected document(s).`
|
||||||
|
modal.componentInstance.btnCaption = $localize`Run`
|
||||||
|
modal.componentInstance.workflows = this.manualWorkflows
|
||||||
|
modal.componentInstance.confirmClicked
|
||||||
|
.pipe(takeUntil(this.unsubscribeNotifier))
|
||||||
|
.subscribe(() => {
|
||||||
|
modal.componentInstance.buttonsEnabled.set(false)
|
||||||
|
this.documentService
|
||||||
|
.bulkEdit(this.getSelectionQuery(), 'run_workflow', {
|
||||||
|
workflow: modal.componentInstance.workflowId,
|
||||||
|
filter_documents: !modal.componentInstance.force,
|
||||||
|
})
|
||||||
|
.pipe(first())
|
||||||
|
.subscribe({
|
||||||
|
next: () => {
|
||||||
|
modal.close()
|
||||||
|
this.toastService.showInfo(
|
||||||
|
$localize`Workflow will run on the selected documents in the background.`
|
||||||
|
)
|
||||||
|
},
|
||||||
|
error: (error) => this.handleOperationError(modal, error),
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
private executeBulkEditMethod(
|
private executeBulkEditMethod(
|
||||||
modal: NgbModalRef,
|
modal: NgbModalRef,
|
||||||
method: DocumentBulkEditMethod,
|
method: DocumentBulkEditMethod,
|
||||||
@@ -299,70 +352,61 @@ export class BulkEditorComponent
|
|||||||
.bulkEdit(overrideSelection ?? this.getSelectionQuery(), method, args)
|
.bulkEdit(overrideSelection ?? this.getSelectionQuery(), method, args)
|
||||||
.pipe(first())
|
.pipe(first())
|
||||||
.subscribe({
|
.subscribe({
|
||||||
next: ({ task_id }) => this.handleOperationQueued(modal, task_id),
|
next: ({ task_id }) =>
|
||||||
|
this.handleOperationQueued(modal, task_id, method),
|
||||||
error: (error) => this.handleOperationError(modal, error),
|
error: (error) => this.handleOperationError(modal, error),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
private handleOperationQueued(modal: NgbModalRef, taskId: string) {
|
private handleOperationQueued(
|
||||||
|
modal: NgbModalRef,
|
||||||
|
taskId: string,
|
||||||
|
operation: string,
|
||||||
|
onQueued?: (taskId: string) => void
|
||||||
|
) {
|
||||||
|
const bulk = this.getSelectionSize() > 1
|
||||||
modal?.close()
|
modal?.close()
|
||||||
this.list.selectNone()
|
if (onQueued) {
|
||||||
const canViewTasks = this.permissionService.currentUserCan(
|
onQueued(taskId)
|
||||||
PermissionAction.View,
|
} else {
|
||||||
PermissionType.PaperlessTask
|
const label = getDocumentOperationLabel(operation)
|
||||||
|
const submittedMessage = bulk
|
||||||
|
? $localize`Bulk operation '${label}' submitted for processing.`
|
||||||
|
: $localize`Operation '${label}' submitted for processing.`
|
||||||
|
const completedMessage = bulk
|
||||||
|
? $localize`Bulk operation '${label}' completed.`
|
||||||
|
: $localize`Operation '${label}' completed.`
|
||||||
|
this.taskNotifications.showQueued(
|
||||||
|
taskId,
|
||||||
|
bulk
|
||||||
|
? $localize`Bulk operation '${label}' queued.`
|
||||||
|
: $localize`Operation '${label}' queued.`,
|
||||||
|
{
|
||||||
|
content: documentOperationHasFollowUpTasks(operation)
|
||||||
|
? submittedMessage
|
||||||
|
: completedMessage,
|
||||||
|
}
|
||||||
)
|
)
|
||||||
this.toastService.show({
|
|
||||||
content: $localize`Bulk operation queued.`,
|
|
||||||
delay: 5000,
|
|
||||||
...(canViewTasks
|
|
||||||
? {
|
|
||||||
actionName: $localize`View task`,
|
|
||||||
action: () =>
|
|
||||||
this.router.navigate(['/tasks'], {
|
|
||||||
queryParams: { task_id: taskId },
|
|
||||||
}),
|
|
||||||
}
|
}
|
||||||
: {}),
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private executeDocumentAction(
|
private executeDocumentAction(
|
||||||
modal: NgbModalRef,
|
modal: NgbModalRef,
|
||||||
request: Observable<any>,
|
operation: string,
|
||||||
options: { clearSelection?: boolean; successMessage?: string } = {}
|
request: Observable<BulkOperationResponse>,
|
||||||
|
onQueued?: (taskId: string) => void
|
||||||
) {
|
) {
|
||||||
if (modal) {
|
if (modal) {
|
||||||
modal.componentInstance.buttonsEnabled.set(false)
|
modal.componentInstance.buttonsEnabled.set(false)
|
||||||
}
|
}
|
||||||
request.pipe(first()).subscribe({
|
request.pipe(first()).subscribe({
|
||||||
next: () => {
|
next: ({ task_id }) => {
|
||||||
this.handleOperationSuccess(modal, options.clearSelection ?? false)
|
this.handleOperationQueued(modal, task_id, operation, onQueued)
|
||||||
if (options.successMessage) {
|
|
||||||
this.toastService.showSuccess(options.successMessage)
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
error: (error) => this.handleOperationError(modal, error),
|
error: (error) => this.handleOperationError(modal, error),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
private handleOperationSuccess(
|
|
||||||
modal: NgbModalRef,
|
|
||||||
clearSelection: boolean = false
|
|
||||||
) {
|
|
||||||
if (clearSelection) {
|
|
||||||
this.list.selected.clear()
|
|
||||||
}
|
|
||||||
this.list.reload()
|
|
||||||
this.list.reduceSelectionToFilter()
|
|
||||||
this.list.selected.forEach((id) => {
|
|
||||||
this.openDocumentService.refreshDocument(id)
|
|
||||||
})
|
|
||||||
this.savedViewService.maybeRefreshDocumentCounts()
|
|
||||||
if (modal) {
|
|
||||||
modal.close()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private handleOperationError(modal: NgbModalRef, error: any) {
|
private handleOperationError(modal: NgbModalRef, error: any) {
|
||||||
if (modal) {
|
if (modal) {
|
||||||
modal.componentInstance.buttonsEnabled.set(true)
|
modal.componentInstance.buttonsEnabled.set(true)
|
||||||
@@ -930,16 +974,9 @@ export class BulkEditorComponent
|
|||||||
const count = this.getSelectionSize()
|
const count = this.getSelectionSize()
|
||||||
this.executeDocumentAction(
|
this.executeDocumentAction(
|
||||||
modal,
|
modal,
|
||||||
this.documentService
|
'delete',
|
||||||
.deleteDocuments(this.getSelectionQuery())
|
this.documentService.deleteDocuments(this.getSelectionQuery()),
|
||||||
.pipe(
|
(taskId) => this.trashService.trackMovedToTrash(taskId, count, documents)
|
||||||
tap(() =>
|
|
||||||
this.trashService.notifyMovedToTrash(
|
|
||||||
$localize`Moved ${count} document(s) to the trash`,
|
|
||||||
documents
|
|
||||||
)
|
|
||||||
)
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -980,6 +1017,7 @@ export class BulkEditorComponent
|
|||||||
modal.componentInstance.buttonsEnabled.set(false)
|
modal.componentInstance.buttonsEnabled.set(false)
|
||||||
this.executeDocumentAction(
|
this.executeDocumentAction(
|
||||||
modal,
|
modal,
|
||||||
|
'reprocess',
|
||||||
this.documentService.reprocessDocuments(
|
this.documentService.reprocessDocuments(
|
||||||
this.getSelectionQuery(),
|
this.getSelectionQuery(),
|
||||||
modal.componentInstance.remoteOcr
|
modal.componentInstance.remoteOcr
|
||||||
@@ -988,6 +1026,31 @@ export class BulkEditorComponent
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
runZoneOcrSelected() {
|
||||||
|
const modal = this.modalService.open(ZoneOcrConfirmDialogComponent, {
|
||||||
|
backdrop: 'static',
|
||||||
|
})
|
||||||
|
const dialog = modal.componentInstance as ZoneOcrConfirmDialogComponent
|
||||||
|
dialog.title = $localize`Run zone OCR confirm`
|
||||||
|
dialog.messageBold = $localize`This operation will run zone OCR on ${this.getSelectionSize()} selected document(s).`
|
||||||
|
dialog.message = $localize`Fields filled by the template will be overwritten.`
|
||||||
|
dialog.btnClass = 'btn-warning'
|
||||||
|
dialog.btnCaption = $localize`Proceed`
|
||||||
|
dialog.confirmClicked
|
||||||
|
.pipe(takeUntil(this.unsubscribeNotifier))
|
||||||
|
.subscribe(() => {
|
||||||
|
dialog.buttonsEnabled.set(false)
|
||||||
|
this.executeDocumentAction(
|
||||||
|
modal,
|
||||||
|
'run_zone_ocr',
|
||||||
|
this.documentService.runZoneOcrDocuments(
|
||||||
|
this.getSelectionQuery(),
|
||||||
|
dialog.template
|
||||||
|
)
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
setPermissions() {
|
setPermissions() {
|
||||||
let modal = this.modalService.open(PermissionsDialogComponent, {
|
let modal = this.modalService.open(PermissionsDialogComponent, {
|
||||||
backdrop: 'static',
|
backdrop: 'static',
|
||||||
@@ -1020,6 +1083,7 @@ export class BulkEditorComponent
|
|||||||
rotateDialog.buttonsEnabled.set(false)
|
rotateDialog.buttonsEnabled.set(false)
|
||||||
this.executeDocumentAction(
|
this.executeDocumentAction(
|
||||||
modal,
|
modal,
|
||||||
|
'rotate',
|
||||||
this.documentService.rotateDocuments(
|
this.documentService.rotateDocuments(
|
||||||
this.getSelectionQuery(),
|
this.getSelectionQuery(),
|
||||||
rotateDialog.degrees
|
rotateDialog.degrees
|
||||||
@@ -1053,11 +1117,8 @@ export class BulkEditorComponent
|
|||||||
mergeDialog.buttonsEnabled.set(false)
|
mergeDialog.buttonsEnabled.set(false)
|
||||||
this.executeDocumentAction(
|
this.executeDocumentAction(
|
||||||
modal,
|
modal,
|
||||||
this.documentService.mergeDocuments(mergeDialog.documentIDs(), args),
|
'merge',
|
||||||
{ clearSelection: !!args.delete_originals }
|
this.documentService.mergeDocuments(mergeDialog.documentIDs(), args)
|
||||||
)
|
|
||||||
this.toastService.showInfo(
|
|
||||||
$localize`Merged document will be queued for consumption.`
|
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@@ -1079,14 +1140,11 @@ export class BulkEditorComponent
|
|||||||
.subscribe(() => {
|
.subscribe(() => {
|
||||||
this.executeDocumentAction(
|
this.executeDocumentAction(
|
||||||
modal,
|
modal,
|
||||||
|
'merge_as_versions',
|
||||||
this.documentService.mergeDocumentsAsVersions(
|
this.documentService.mergeDocumentsAsVersions(
|
||||||
mergeDialog.documentIDs(),
|
mergeDialog.documentIDs(),
|
||||||
mergeDialog.rootDocumentID()
|
mergeDialog.rootDocumentID()
|
||||||
),
|
)
|
||||||
{
|
|
||||||
clearSelection: true,
|
|
||||||
successMessage: $localize`Documents merged as versions.`,
|
|
||||||
}
|
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@@ -1111,7 +1169,7 @@ export class BulkEditorComponent
|
|||||||
dialog.selection = this.getSelectionQuery()
|
dialog.selection = this.getSelectionQuery()
|
||||||
dialog.selectionCount = this.getSelectionSize()
|
dialog.selectionCount = this.getSelectionSize()
|
||||||
dialog.succeeded.subscribe(({ task_id }) =>
|
dialog.succeeded.subscribe(({ task_id }) =>
|
||||||
this.handleOperationQueued(null, task_id)
|
this.handleOperationQueued(null, task_id, 'modify_custom_fields')
|
||||||
)
|
)
|
||||||
dialog.failed.subscribe((error) => {
|
dialog.failed.subscribe((error) => {
|
||||||
this.toastService.showError(
|
this.toastService.showError(
|
||||||
|
|||||||
+1
-1
@@ -16,7 +16,7 @@
|
|||||||
</pngx-input-select>
|
</pngx-input-select>
|
||||||
<pngx-input-check i18n-title title="Show in sidebar" formControlName="showInSideBar"></pngx-input-check>
|
<pngx-input-check i18n-title title="Show in sidebar" formControlName="showInSideBar"></pngx-input-check>
|
||||||
<pngx-input-check i18n-title title="Show on dashboard" formControlName="showOnDashboard"></pngx-input-check>
|
<pngx-input-check i18n-title title="Show on dashboard" formControlName="showOnDashboard"></pngx-input-check>
|
||||||
<pngx-permissions-form accordion="true" formControlName="permissions_form"></pngx-permissions-form>
|
<pngx-permissions-form [users]="users()" accordion="true" formControlName="permissions_form"></pngx-permissions-form>
|
||||||
@if (error()?.filter_rules) {
|
@if (error()?.filter_rules) {
|
||||||
<div class="alert alert-danger" role="alert">
|
<div class="alert alert-danger" role="alert">
|
||||||
<h6 class="alert-heading" i18n>Filter rules error occurred while saving this view</h6>
|
<h6 class="alert-heading" i18n>Filter rules error occurred while saving this view</h6>
|
||||||
|
|||||||
+16
-1
@@ -3,6 +3,7 @@ import { FormsModule, ReactiveFormsModule } from '@angular/forms'
|
|||||||
import { By } from '@angular/platform-browser'
|
import { By } from '@angular/platform-browser'
|
||||||
import { NgbActiveModal, NgbModalModule } from '@ng-bootstrap/ng-bootstrap'
|
import { NgbActiveModal, NgbModalModule } from '@ng-bootstrap/ng-bootstrap'
|
||||||
import { of } from 'rxjs'
|
import { of } from 'rxjs'
|
||||||
|
import { User } from 'src/app/data/user'
|
||||||
import { GroupService } from 'src/app/services/rest/group.service'
|
import { GroupService } from 'src/app/services/rest/group.service'
|
||||||
import { UserService } from 'src/app/services/rest/user.service'
|
import { UserService } from 'src/app/services/rest/user.service'
|
||||||
import { CheckComponent } from '../../common/input/check/check.component'
|
import { CheckComponent } from '../../common/input/check/check.component'
|
||||||
@@ -14,6 +15,7 @@ import { TextComponent } from '../../common/input/text/text.component'
|
|||||||
import { SaveViewConfigDialogComponent } from './save-view-config-dialog.component'
|
import { SaveViewConfigDialogComponent } from './save-view-config-dialog.component'
|
||||||
|
|
||||||
describe('SaveViewConfigDialogComponent', () => {
|
describe('SaveViewConfigDialogComponent', () => {
|
||||||
|
const users = [{ id: 10, username: 'user10' }] as User[]
|
||||||
let component: SaveViewConfigDialogComponent
|
let component: SaveViewConfigDialogComponent
|
||||||
let fixture: ComponentFixture<SaveViewConfigDialogComponent>
|
let fixture: ComponentFixture<SaveViewConfigDialogComponent>
|
||||||
let modal: NgbActiveModal
|
let modal: NgbActiveModal
|
||||||
@@ -25,7 +27,7 @@ describe('SaveViewConfigDialogComponent', () => {
|
|||||||
{
|
{
|
||||||
provide: UserService,
|
provide: UserService,
|
||||||
useValue: {
|
useValue: {
|
||||||
listAll: () => of({ results: [] }),
|
listAll: () => of({ results: users }),
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -124,6 +126,19 @@ describe('SaveViewConfigDialogComponent', () => {
|
|||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('should list users in the owner selector', () => {
|
||||||
|
fixture.debugElement
|
||||||
|
.query(By.css('button[ngbAccordionButton]'))
|
||||||
|
.nativeElement.click()
|
||||||
|
fixture.detectChanges()
|
||||||
|
|
||||||
|
const permissionsForm = fixture.debugElement.query(
|
||||||
|
By.directive(PermissionsFormComponent)
|
||||||
|
)
|
||||||
|
const ownerSelect = permissionsForm.query(By.directive(SelectComponent))
|
||||||
|
expect(ownerSelect.componentInstance.items).toEqual(users)
|
||||||
|
})
|
||||||
|
|
||||||
it('should support default name', () => {
|
it('should support default name', () => {
|
||||||
const saveClickedSpy = jest.spyOn(component.saveClicked, 'emit')
|
const saveClickedSpy = jest.spyOn(component.saveClicked, 'emit')
|
||||||
const modalCloseSpy = jest.spyOn(modal, 'close')
|
const modalCloseSpy = jest.spyOn(modal, 'close')
|
||||||
|
|||||||
+16
-1
@@ -6,6 +6,7 @@ import {
|
|||||||
inject,
|
inject,
|
||||||
signal,
|
signal,
|
||||||
} from '@angular/core'
|
} from '@angular/core'
|
||||||
|
import { toSignal } from '@angular/core/rxjs-interop'
|
||||||
import {
|
import {
|
||||||
FormControl,
|
FormControl,
|
||||||
FormGroup,
|
FormGroup,
|
||||||
@@ -13,11 +14,14 @@ import {
|
|||||||
ReactiveFormsModule,
|
ReactiveFormsModule,
|
||||||
} from '@angular/forms'
|
} from '@angular/forms'
|
||||||
import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
|
import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
|
||||||
|
import { catchError, map, of } from 'rxjs'
|
||||||
import {
|
import {
|
||||||
DEFAULT_SAVED_VIEW_ICON,
|
DEFAULT_SAVED_VIEW_ICON,
|
||||||
SAVED_VIEW_ICONS,
|
SAVED_VIEW_ICONS,
|
||||||
} from 'src/app/data/saved-view-icons'
|
} from 'src/app/data/saved-view-icons'
|
||||||
import { User } from 'src/app/data/user'
|
import { User } from 'src/app/data/user'
|
||||||
|
import { UserService } from 'src/app/services/rest/user.service'
|
||||||
|
import { ToastService } from 'src/app/services/toast.service'
|
||||||
import { CheckComponent } from '../../common/input/check/check.component'
|
import { CheckComponent } from '../../common/input/check/check.component'
|
||||||
import { PermissionsFormComponent } from '../../common/input/permissions/permissions-form/permissions-form.component'
|
import { PermissionsFormComponent } from '../../common/input/permissions/permissions-form/permissions-form.component'
|
||||||
import { SelectComponent } from '../../common/input/select/select.component'
|
import { SelectComponent } from '../../common/input/select/select.component'
|
||||||
@@ -38,6 +42,8 @@ import { TextComponent } from '../../common/input/text/text.component'
|
|||||||
})
|
})
|
||||||
export class SaveViewConfigDialogComponent implements OnInit {
|
export class SaveViewConfigDialogComponent implements OnInit {
|
||||||
private modal = inject(NgbActiveModal)
|
private modal = inject(NgbActiveModal)
|
||||||
|
private userService = inject(UserService)
|
||||||
|
private toastService = inject(ToastService)
|
||||||
readonly error = signal(undefined)
|
readonly error = signal(undefined)
|
||||||
readonly buttonsEnabled = signal(true)
|
readonly buttonsEnabled = signal(true)
|
||||||
readonly defaultName = signal('')
|
readonly defaultName = signal('')
|
||||||
@@ -46,7 +52,16 @@ export class SaveViewConfigDialogComponent implements OnInit {
|
|||||||
@Output()
|
@Output()
|
||||||
public saveClicked = new EventEmitter()
|
public saveClicked = new EventEmitter()
|
||||||
|
|
||||||
users: User[]
|
readonly users = toSignal(
|
||||||
|
this.userService.listAll().pipe(
|
||||||
|
map((result) => result.results),
|
||||||
|
catchError((error) => {
|
||||||
|
this.toastService.showError($localize`Error retrieving users`, error)
|
||||||
|
return of([])
|
||||||
|
})
|
||||||
|
),
|
||||||
|
{ initialValue: undefined as User[] }
|
||||||
|
)
|
||||||
readonly savedViewIcons = SAVED_VIEW_ICONS
|
readonly savedViewIcons = SAVED_VIEW_ICONS
|
||||||
|
|
||||||
setDefaultName(value: string) {
|
setDefaultName(value: string) {
|
||||||
|
|||||||
@@ -2,26 +2,47 @@
|
|||||||
<div>
|
<div>
|
||||||
<form [formGroup]="noteForm" class="needs-validation mt-3" *pngxIfPermissions="{ action: PermissionAction.Add, type: PermissionType.Note }" novalidate>
|
<form [formGroup]="noteForm" class="needs-validation mt-3" *pngxIfPermissions="{ action: PermissionAction.Add, type: PermissionType.Note }" novalidate>
|
||||||
<div class="form-group">
|
<div class="form-group">
|
||||||
<textarea class="form-control form-control-sm" [class.is-invalid]="newNoteError" rows="3" formControlName="newNote" placeholder="Enter note" i18n-placeholder (keydown)="noteFormKeydown($event)" required></textarea>
|
<textarea class="form-control form-control-sm" [class.is-invalid]="newNoteError" [class.d-none]="noteView() !== NoteViewMode.Edit" [attr.aria-invalid]="newNoteError" aria-label="Note" i18n-aria-label aria-describedby="noteFeedback" rows="3" formControlName="newNote" placeholder="Enter note (Markdown is supported)" i18n-placeholder (keydown)="noteFormKeydown($event)" required></textarea>
|
||||||
<div class="invalid-feedback" i18n>
|
@if (noteView() === NoteViewMode.Preview) {
|
||||||
|
<section class="form-control form-control-sm note-preview" aria-label="Note preview" i18n-aria-label>
|
||||||
|
@if (noteForm.get('newNote').value) {
|
||||||
|
<div class="note-markdown text-break text-wrap" [innerHTML]="noteForm.get('newNote').value | markdown"></div>
|
||||||
|
} @else {
|
||||||
|
<span class="text-muted" i18n>Nothing to preview</span>
|
||||||
|
}
|
||||||
|
</section>
|
||||||
|
}
|
||||||
|
<div id="noteFeedback" class="invalid-feedback" i18n>
|
||||||
Please enter a note.
|
Please enter a note.
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="form-group mt-2 d-flex justify-content-end align-items-center">
|
<div class="form-group mt-2 d-flex justify-content-between align-items-center">
|
||||||
@if (networkActive()) {
|
@if (networkActive()) {
|
||||||
<div class="spinner-border spinner-border-sm fw-normal me-auto" role="status"></div>
|
<div class="spinner-border spinner-border-sm fw-normal me-auto" role="status"></div>
|
||||||
}
|
}
|
||||||
|
<fieldset class="btn-group btn-group-sm" aria-label="Note input mode" i18n-aria-label>
|
||||||
|
<input type="radio" class="btn-check" id="noteViewEdit" name="noteViewMode" [checked]="noteView() === NoteViewMode.Edit" (change)="noteView.set(NoteViewMode.Edit)">
|
||||||
|
<label class="btn btn-outline-secondary" for="noteViewEdit" i18n>Edit</label>
|
||||||
|
<input type="radio" class="btn-check" id="noteViewPreview" name="noteViewMode" [checked]="noteView() === NoteViewMode.Preview" (change)="noteView.set(NoteViewMode.Preview)">
|
||||||
|
<label class="btn btn-outline-secondary" for="noteViewPreview" i18n>Preview</label>
|
||||||
|
</fieldset>
|
||||||
<button type="button" class="btn btn-primary btn-sm" [disabled]="networkActive() || addDisabled()" (click)="addNote()" i18n>Add note</button>
|
<button type="button" class="btn btn-primary btn-sm" [disabled]="networkActive() || addDisabled()" (click)="addNote()" i18n>Add note</button>
|
||||||
</div>
|
</div>
|
||||||
</form>
|
</form>
|
||||||
<hr>
|
<hr>
|
||||||
@for (note of notes(); track note) {
|
@for (note of notes(); track note.id) {
|
||||||
<div class="card border mb-3">
|
<div class="card border mb-3">
|
||||||
<div class="card-body text-dark">
|
<div class="card-body text-dark">
|
||||||
|
@if (note.format === NoteFormat.Markdown) {
|
||||||
|
<div class="card-text note-markdown text-break text-wrap" [innerHTML]="note.note | markdown"></div>
|
||||||
|
} @else {
|
||||||
<p class="card-text">{{note.note}}</p>
|
<p class="card-text">{{note.note}}</p>
|
||||||
|
}
|
||||||
</div>
|
</div>
|
||||||
<div class="d-flex card-footer small bg-light text-primary justify-content-between align-items-center">
|
<div class="d-flex card-footer small bg-light text-primary justify-content-between align-items-center">
|
||||||
<span>{{displayName(note)}} - {{ note.created | customDate}}</span>
|
<span>
|
||||||
|
{{displayName(note)}} - {{ note.created | customDate}}
|
||||||
|
</span>
|
||||||
<button type="button" class="btn btn-link btn-sm p-0 fade" title="Delete note" i18n-title (click)="deleteNote(note.id)" *pngxIfPermissions="{ action: PermissionAction.Delete, type: PermissionType.Note }">
|
<button type="button" class="btn btn-link btn-sm p-0 fade" title="Delete note" i18n-title (click)="deleteNote(note.id)" *pngxIfPermissions="{ action: PermissionAction.Delete, type: PermissionType.Note }">
|
||||||
<pngx-bs-icon name="trash"></pngx-bs-icon>
|
<pngx-bs-icon name="trash"></pngx-bs-icon>
|
||||||
<span class="visually-hidden" i18n>Delete note</span>
|
<span class="visually-hidden" i18n>Delete note</span>
|
||||||
|
|||||||
@@ -5,3 +5,45 @@
|
|||||||
.card:hover .fade {
|
.card:hover .fade {
|
||||||
opacity: 1;
|
opacity: 1;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.note-preview {
|
||||||
|
min-height: calc(1.5em * 3 + 0.5rem + var(--bs-border-width) * 2); // textfield height with 3 rows
|
||||||
|
}
|
||||||
|
|
||||||
|
.note-markdown ::ng-deep {
|
||||||
|
h1, h2, h3, h4, h5, h6 {
|
||||||
|
font-size: 1em;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 { font-size: 1.25em; }
|
||||||
|
h2 { font-size: 1.15em; }
|
||||||
|
h3 { font-size: 1.05em; }
|
||||||
|
|
||||||
|
table {
|
||||||
|
margin-bottom: 1rem;
|
||||||
|
display: block;
|
||||||
|
overflow-x: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
th, td {
|
||||||
|
padding: 0.15rem 0.4rem;
|
||||||
|
border: 1px solid var(--bs-border-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
pre {
|
||||||
|
padding: 0.5rem;
|
||||||
|
background-color: var(--bs-tertiary-bg);
|
||||||
|
border-radius: var(--bs-border-radius);
|
||||||
|
}
|
||||||
|
|
||||||
|
blockquote {
|
||||||
|
padding-left: 0.75rem;
|
||||||
|
border-left: 0.25rem solid var(--bs-border-color);
|
||||||
|
color: var(--bs-secondary-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
> :last-child {
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -5,7 +5,7 @@ import { ComponentFixture, TestBed } from '@angular/core/testing'
|
|||||||
import { FormsModule, ReactiveFormsModule } from '@angular/forms'
|
import { FormsModule, ReactiveFormsModule } from '@angular/forms'
|
||||||
import { By } from '@angular/platform-browser'
|
import { By } from '@angular/platform-browser'
|
||||||
import { of, throwError } from 'rxjs'
|
import { of, throwError } from 'rxjs'
|
||||||
import { DocumentNote } from 'src/app/data/document-note'
|
import { DocumentNote, NoteFormat } from 'src/app/data/document-note'
|
||||||
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
|
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
|
||||||
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
|
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
|
||||||
import { PermissionsService } from 'src/app/services/permissions.service'
|
import { PermissionsService } from 'src/app/services/permissions.service'
|
||||||
@@ -129,6 +129,66 @@ describe('DocumentNotesComponent', () => {
|
|||||||
expect(fixture.debugElement.nativeElement.textContent).toContain('user3')
|
expect(fixture.debugElement.nativeElement.textContent).toContain('user3')
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('should render notes according to their format', () => {
|
||||||
|
component.notes.set([
|
||||||
|
{ id: 31, note: '**x**', format: NoteFormat.Markdown },
|
||||||
|
{
|
||||||
|
id: 32,
|
||||||
|
note: '<script>alert(1)</script>',
|
||||||
|
format: NoteFormat.Markdown,
|
||||||
|
},
|
||||||
|
{ id: 33, note: '**x**', format: NoteFormat.Plain },
|
||||||
|
])
|
||||||
|
fixture.detectChanges()
|
||||||
|
|
||||||
|
const noteCards = fixture.debugElement.queryAll(By.css('.card-text'))
|
||||||
|
expect(noteCards[0].query(By.css('strong')).nativeElement.textContent).toBe(
|
||||||
|
'x'
|
||||||
|
)
|
||||||
|
expect(noteCards[1].query(By.css('script'))).toBeNull()
|
||||||
|
expect(noteCards[2].query(By.css('strong'))).toBeNull()
|
||||||
|
expect(noteCards[2].nativeElement.textContent).toBe('**x**')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should toggle between edit and preview', () => {
|
||||||
|
const radios = fixture.debugElement.queryAll(
|
||||||
|
By.css('.btn-group input[type="radio"]')
|
||||||
|
)
|
||||||
|
radios[1].triggerEventHandler('change')
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(
|
||||||
|
fixture.debugElement.query(By.css('.note-preview')).nativeElement
|
||||||
|
.textContent
|
||||||
|
).toContain('Nothing to preview')
|
||||||
|
|
||||||
|
component.noteForm.get('newNote').setValue('**bold**')
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(
|
||||||
|
fixture.debugElement.query(By.css('.note-preview strong'))
|
||||||
|
).not.toBeNull()
|
||||||
|
expect(
|
||||||
|
fixture.debugElement.query(By.css('textarea')).nativeElement.classList
|
||||||
|
).toContain('d-none')
|
||||||
|
|
||||||
|
radios[0].triggerEventHandler('change')
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(fixture.debugElement.query(By.css('.note-preview'))).toBeNull()
|
||||||
|
expect(
|
||||||
|
fixture.debugElement.query(By.css('textarea')).nativeElement.classList
|
||||||
|
).not.toContain('d-none')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return to edit mode after saving', () => {
|
||||||
|
component.documentId.set(12)
|
||||||
|
component.noteForm.get('newNote').setValue('Preview note')
|
||||||
|
fixture.debugElement
|
||||||
|
.queryAll(By.css('.btn-group input[type="radio"]'))[1]
|
||||||
|
.triggerEventHandler('change')
|
||||||
|
jest.spyOn(notesService, 'addNote').mockReturnValueOnce(of(notes))
|
||||||
|
component.addNote()
|
||||||
|
expect(component.noteView()).toBe('edit')
|
||||||
|
})
|
||||||
|
|
||||||
it('should handle note user display in all situations', () => {
|
it('should handle note user display in all situations', () => {
|
||||||
expect(
|
expect(
|
||||||
component.displayName({
|
component.displayName({
|
||||||
@@ -161,7 +221,7 @@ describe('DocumentNotesComponent', () => {
|
|||||||
const addSpy = jest.spyOn(notesService, 'addNote')
|
const addSpy = jest.spyOn(notesService, 'addNote')
|
||||||
addSpy.mockReturnValueOnce(throwError(() => new Error('error saving note')))
|
addSpy.mockReturnValueOnce(throwError(() => new Error('error saving note')))
|
||||||
const toastsSpy = jest.spyOn(toastService, 'showError')
|
const toastsSpy = jest.spyOn(toastService, 'showError')
|
||||||
const addButton = fixture.debugElement.query(By.css('button'))
|
const addButton = fixture.debugElement.query(By.css('.btn-primary'))
|
||||||
addButton.triggerEventHandler('click')
|
addButton.triggerEventHandler('click')
|
||||||
expect(addSpy).toHaveBeenCalledWith(12, note)
|
expect(addSpy).toHaveBeenCalledWith(12, note)
|
||||||
expect(toastsSpy).toHaveBeenCalled()
|
expect(toastsSpy).toHaveBeenCalled()
|
||||||
@@ -190,7 +250,9 @@ describe('DocumentNotesComponent', () => {
|
|||||||
component.documentId.set(12)
|
component.documentId.set(12)
|
||||||
component.notes.set(notes)
|
component.notes.set(notes)
|
||||||
fixture.detectChanges()
|
fixture.detectChanges()
|
||||||
const deleteButton = fixture.debugElement.queryAll(By.css('button'))[1] // 0 is add button
|
const deleteButton = fixture.debugElement.query(
|
||||||
|
By.css('.card-footer button')
|
||||||
|
)
|
||||||
const deleteSpy = jest.spyOn(notesService, 'deleteNote')
|
const deleteSpy = jest.spyOn(notesService, 'deleteNote')
|
||||||
const toastsSpy = jest.spyOn(toastService, 'showError')
|
const toastsSpy = jest.spyOn(toastService, 'showError')
|
||||||
deleteSpy.mockReturnValueOnce(
|
deleteSpy.mockReturnValueOnce(
|
||||||
|
|||||||
@@ -14,15 +14,21 @@ import {
|
|||||||
ReactiveFormsModule,
|
ReactiveFormsModule,
|
||||||
} from '@angular/forms'
|
} from '@angular/forms'
|
||||||
import { BootstrapIconComponent } from 'src/app/components/common/bootstrap-icon/bootstrap-icon.component'
|
import { BootstrapIconComponent } from 'src/app/components/common/bootstrap-icon/bootstrap-icon.component'
|
||||||
import { DocumentNote } from 'src/app/data/document-note'
|
import { DocumentNote, NoteFormat } from 'src/app/data/document-note'
|
||||||
import { User } from 'src/app/data/user'
|
import { User } from 'src/app/data/user'
|
||||||
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
|
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
|
||||||
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
|
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
|
||||||
|
import { MarkdownPipe } from 'src/app/pipes/markdown.pipe'
|
||||||
import { DocumentNotesService } from 'src/app/services/rest/document-notes.service'
|
import { DocumentNotesService } from 'src/app/services/rest/document-notes.service'
|
||||||
import { UserService } from 'src/app/services/rest/user.service'
|
import { UserService } from 'src/app/services/rest/user.service'
|
||||||
import { ToastService } from 'src/app/services/toast.service'
|
import { ToastService } from 'src/app/services/toast.service'
|
||||||
import { ComponentWithPermissions } from '../with-permissions/with-permissions.component'
|
import { ComponentWithPermissions } from '../with-permissions/with-permissions.component'
|
||||||
|
|
||||||
|
enum NoteViewMode {
|
||||||
|
Edit = 'edit',
|
||||||
|
Preview = 'preview',
|
||||||
|
}
|
||||||
|
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'pngx-document-notes',
|
selector: 'pngx-document-notes',
|
||||||
templateUrl: './document-notes.component.html',
|
templateUrl: './document-notes.component.html',
|
||||||
@@ -30,6 +36,7 @@ import { ComponentWithPermissions } from '../with-permissions/with-permissions.c
|
|||||||
imports: [
|
imports: [
|
||||||
IfPermissionsDirective,
|
IfPermissionsDirective,
|
||||||
CustomDatePipe,
|
CustomDatePipe,
|
||||||
|
MarkdownPipe,
|
||||||
FormsModule,
|
FormsModule,
|
||||||
ReactiveFormsModule,
|
ReactiveFormsModule,
|
||||||
BootstrapIconComponent,
|
BootstrapIconComponent,
|
||||||
@@ -43,6 +50,9 @@ export class DocumentNotesComponent extends ComponentWithPermissions {
|
|||||||
readonly notes = model<DocumentNote[]>([])
|
readonly notes = model<DocumentNote[]>([])
|
||||||
readonly addDisabled = input(false)
|
readonly addDisabled = input(false)
|
||||||
readonly networkActive = signal(false)
|
readonly networkActive = signal(false)
|
||||||
|
protected readonly NoteViewMode = NoteViewMode
|
||||||
|
protected readonly NoteFormat = NoteFormat
|
||||||
|
protected readonly noteView = signal<NoteViewMode>(NoteViewMode.Edit)
|
||||||
|
|
||||||
noteForm: FormGroup = new FormGroup({
|
noteForm: FormGroup = new FormGroup({
|
||||||
newNote: new FormControl(''),
|
newNote: new FormControl(''),
|
||||||
@@ -75,6 +85,7 @@ export class DocumentNotesComponent extends ComponentWithPermissions {
|
|||||||
next: (result) => {
|
next: (result) => {
|
||||||
this.notes.set(result)
|
this.notes.set(result)
|
||||||
this.noteForm.get('newNote').reset()
|
this.noteForm.get('newNote').reset()
|
||||||
|
this.noteView.set(NoteViewMode.Edit)
|
||||||
this.networkActive.set(false)
|
this.networkActive.set(false)
|
||||||
this.updated.emit(this.notes())
|
this.updated.emit(this.notes())
|
||||||
},
|
},
|
||||||
|
|||||||
+36
@@ -0,0 +1,36 @@
|
|||||||
|
@if (zones.length === 0) {
|
||||||
|
<p class="text-muted" i18n>No zones yet. Drag anywhere on the sample document to create one.</p>
|
||||||
|
} @else {
|
||||||
|
<div class="list-group">
|
||||||
|
@for (zone of zones; track $index; let i = $index) {
|
||||||
|
<div class="list-group-item list-group-item-action d-flex align-items-center gap-3 position-relative">
|
||||||
|
<span class="p-2 rounded flex-shrink-0" [style.background-color]="zoneColor(i)" aria-hidden="true"></span>
|
||||||
|
<div class="flex-grow-1 text-truncate">
|
||||||
|
<button type="button" class="btn btn-link p-0 fw-semibold text-reset text-decoration-none text-truncate mw-100 stretched-link" (click)="zoneSelected.emit(i)">{{ zone.name }}</button>
|
||||||
|
@if (!hasField(zone)) {
|
||||||
|
<div class="small text-warning text-truncate">
|
||||||
|
<pngx-bs-icon name="exclamation-triangle" class="me-1" aria-hidden="true"></pngx-bs-icon><span i18n>No field selected</span>
|
||||||
|
</div>
|
||||||
|
} @else {
|
||||||
|
<div class="small text-muted text-truncate">
|
||||||
|
{{ getZoneTargetName(zone) }}
|
||||||
|
@if (isCombined(zone)) {
|
||||||
|
<pngx-bs-icon name="braces" class="ms-1" title="Combined with other zones" i18n-title></pngx-bs-icon>
|
||||||
|
}
|
||||||
|
</div>
|
||||||
|
}
|
||||||
|
</div>
|
||||||
|
<small class="text-muted text-nowrap">
|
||||||
|
@if (zone.page === -1) {
|
||||||
|
<ng-container i18n>Last page</ng-container>
|
||||||
|
} @else {
|
||||||
|
<ng-container i18n>Page {{ zone.page ?? 1 }}</ng-container>
|
||||||
|
}
|
||||||
|
</small>
|
||||||
|
<button type="button" class="btn btn-sm btn-link text-danger position-relative z-2" (click)="zoneRemoved.emit(i)" title="Delete zone" i18n-title aria-label="Delete zone" i18n-aria-label>
|
||||||
|
<pngx-bs-icon name="trash"></pngx-bs-icon>
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
}
|
||||||
|
</div>
|
||||||
|
}
|
||||||
+115
@@ -0,0 +1,115 @@
|
|||||||
|
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
||||||
|
import { BootstrapIconComponent } from 'src/app/components/common/bootstrap-icon/bootstrap-icon.component'
|
||||||
|
import { CustomField } from 'src/app/data/custom-field'
|
||||||
|
import {
|
||||||
|
OcrTemplateZone,
|
||||||
|
OcrZoneTarget,
|
||||||
|
OcrZoneTransform,
|
||||||
|
} from 'src/app/data/ocr-template'
|
||||||
|
import { OcrTemplateEditorZoneListComponent } from './ocr-template-editor-zone-list.component'
|
||||||
|
|
||||||
|
function zone(overrides: Partial<OcrTemplateZone> = {}): OcrTemplateZone {
|
||||||
|
return {
|
||||||
|
name: 'Zone 1',
|
||||||
|
target: OcrZoneTarget.CustomField,
|
||||||
|
custom_field: 7,
|
||||||
|
x: 10,
|
||||||
|
y: 20,
|
||||||
|
width: 30,
|
||||||
|
height: 40,
|
||||||
|
page: 1,
|
||||||
|
ocr_language: 'eng',
|
||||||
|
transform: OcrZoneTransform.Strip,
|
||||||
|
validation_regex: '',
|
||||||
|
order: 0,
|
||||||
|
...overrides,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('OcrTemplateEditorZoneListComponent', () => {
|
||||||
|
let fixture: ComponentFixture<OcrTemplateEditorZoneListComponent>
|
||||||
|
let component: OcrTemplateEditorZoneListComponent
|
||||||
|
|
||||||
|
beforeEach(async () => {
|
||||||
|
await TestBed.configureTestingModule({
|
||||||
|
imports: [OcrTemplateEditorZoneListComponent, BootstrapIconComponent],
|
||||||
|
}).compileComponents()
|
||||||
|
|
||||||
|
fixture = TestBed.createComponent(OcrTemplateEditorZoneListComponent)
|
||||||
|
component = fixture.componentInstance
|
||||||
|
})
|
||||||
|
|
||||||
|
it('shows empty state when no zones are defined', () => {
|
||||||
|
fixture.detectChanges()
|
||||||
|
|
||||||
|
expect(fixture.nativeElement.textContent).toContain('No zones yet')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('renders zone name, target, and page', () => {
|
||||||
|
component.zones = [zone(), zone({ name: 'Zone 2', page: -1 })]
|
||||||
|
component.customFields = [{ id: 7, name: 'Invoice Number' } as CustomField]
|
||||||
|
fixture.detectChanges()
|
||||||
|
|
||||||
|
const text = fixture.nativeElement.textContent
|
||||||
|
expect(text).toContain('Zone 1')
|
||||||
|
expect(text).toContain('Invoice Number')
|
||||||
|
expect(text).toContain('Page 1')
|
||||||
|
expect(text).toContain('Last page')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('marks zones that share a field', () => {
|
||||||
|
component.zones = [
|
||||||
|
zone(),
|
||||||
|
zone({ name: 'Zone 2' }),
|
||||||
|
zone({ name: 'Zone 3', custom_field: 8 }),
|
||||||
|
]
|
||||||
|
fixture.detectChanges()
|
||||||
|
|
||||||
|
expect(component.isCombined(component.zones[0])).toBe(true)
|
||||||
|
expect(component.isCombined(component.zones[2])).toBe(false)
|
||||||
|
expect(
|
||||||
|
fixture.nativeElement.querySelectorAll(
|
||||||
|
'[title="Combined with other zones"]'
|
||||||
|
)
|
||||||
|
).toHaveLength(2)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('warns only for zones without a field and clears the warning when assigned', () => {
|
||||||
|
component.zones = [
|
||||||
|
zone({ custom_field: null }),
|
||||||
|
zone({ target: OcrZoneTarget.Title, custom_field: null }),
|
||||||
|
zone(),
|
||||||
|
]
|
||||||
|
fixture.detectChanges()
|
||||||
|
|
||||||
|
const warnings = () =>
|
||||||
|
fixture.nativeElement.querySelectorAll('.text-warning')
|
||||||
|
expect(warnings()).toHaveLength(1)
|
||||||
|
expect(warnings()[0].textContent).toContain('No field selected')
|
||||||
|
|
||||||
|
component.zones[0].custom_field = 7
|
||||||
|
fixture.componentRef.setInput('zones', [...component.zones])
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(warnings()).toHaveLength(0)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('emits select and remove events', () => {
|
||||||
|
component.zones = [zone()]
|
||||||
|
const selectSpy = jest.spyOn(component.zoneSelected, 'emit')
|
||||||
|
const removeSpy = jest.spyOn(component.zoneRemoved, 'emit')
|
||||||
|
fixture.detectChanges()
|
||||||
|
|
||||||
|
const buttons = fixture.nativeElement.querySelectorAll('button')
|
||||||
|
buttons[0].click()
|
||||||
|
buttons[1].click()
|
||||||
|
|
||||||
|
expect(selectSpy).toHaveBeenCalledWith(0)
|
||||||
|
expect(removeSpy).toHaveBeenCalledWith(0)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does not label an unknown built-in target', () => {
|
||||||
|
expect(
|
||||||
|
component.getZoneTargetName(zone({ target: 'unknown' as OcrZoneTarget }))
|
||||||
|
).toBe('')
|
||||||
|
})
|
||||||
|
})
|
||||||
+50
@@ -0,0 +1,50 @@
|
|||||||
|
import { Component, EventEmitter, Input, Output } from '@angular/core'
|
||||||
|
import { BootstrapIconComponent } from 'src/app/components/common/bootstrap-icon/bootstrap-icon.component'
|
||||||
|
import { CustomField } from 'src/app/data/custom-field'
|
||||||
|
import {
|
||||||
|
getZoneFieldKey,
|
||||||
|
OCR_BUILTIN_TARGETS,
|
||||||
|
OcrTemplateZone,
|
||||||
|
OcrZoneTarget,
|
||||||
|
} from 'src/app/data/ocr-template'
|
||||||
|
import { getZoneColor } from '../zone-geometry'
|
||||||
|
|
||||||
|
@Component({
|
||||||
|
selector: 'pngx-ocr-template-zone-list',
|
||||||
|
imports: [BootstrapIconComponent],
|
||||||
|
templateUrl: './ocr-template-editor-zone-list.component.html',
|
||||||
|
})
|
||||||
|
export class OcrTemplateEditorZoneListComponent {
|
||||||
|
@Input() zones: OcrTemplateZone[] = []
|
||||||
|
@Input() customFields: CustomField[] = []
|
||||||
|
|
||||||
|
@Output() public readonly zoneSelected = new EventEmitter<number>()
|
||||||
|
@Output() public readonly zoneRemoved = new EventEmitter<number>()
|
||||||
|
|
||||||
|
public readonly zoneColor = getZoneColor
|
||||||
|
|
||||||
|
hasField(zone: OcrTemplateZone): boolean {
|
||||||
|
return getZoneFieldKey(zone) !== null
|
||||||
|
}
|
||||||
|
|
||||||
|
isCombined(zone: OcrTemplateZone): boolean {
|
||||||
|
const key = getZoneFieldKey(zone)
|
||||||
|
return (
|
||||||
|
key !== null &&
|
||||||
|
this.zones.filter((z) => getZoneFieldKey(z) === key).length > 1
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
getZoneTargetName(zone: OcrTemplateZone): string {
|
||||||
|
if (zone.target === OcrZoneTarget.CustomField) {
|
||||||
|
return (
|
||||||
|
this.customFields.find((field) => field.id === zone.custom_field)
|
||||||
|
?.name ?? ''
|
||||||
|
)
|
||||||
|
}
|
||||||
|
return (
|
||||||
|
OCR_BUILTIN_TARGETS.find((target) => target.id === zone.target)?.name ??
|
||||||
|
''
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
+315
@@ -0,0 +1,315 @@
|
|||||||
|
<div class="modal-header">
|
||||||
|
<h4 class="modal-title" id="ocr-template-editor-title">{{ dialogTitle }}</h4>
|
||||||
|
@if (template.id) {
|
||||||
|
<span class="badge bg-primary text-primary-text-contrast ms-2">ID: {{ template.id }}</span>
|
||||||
|
}
|
||||||
|
<button type="button" class="btn-close" (click)="activeModal.dismiss()" [disabled]="saving()" aria-label="Close" i18n-aria-label></button>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="modal-body d-flex flex-column">
|
||||||
|
<div class="row gx-3 editor-layout flex-grow-1 flex-lg-nowrap" [attr.inert]="saving() ? '' : null" [attr.aria-busy]="saving()">
|
||||||
|
<div class="col-lg-4 mb-3 mb-lg-0 overflow-auto">
|
||||||
|
<ul ngbNav #nav="ngbNav" [(activeId)]="activeTab" class="nav-underline flex-nowrap flex-md-wrap overflow-auto">
|
||||||
|
<li ngbNavItem="template">
|
||||||
|
<a ngbNavLink i18n>Template</a>
|
||||||
|
<ng-template ngbNavContent>
|
||||||
|
<div class="row mb-3">
|
||||||
|
<div class="col-9">
|
||||||
|
<pngx-input-text [(ngModel)]="template.name" title="Template name" i18n-title></pngx-input-text>
|
||||||
|
</div>
|
||||||
|
<div class="col-3">
|
||||||
|
<pngx-input-switch [(ngModel)]="template.enabled" title="Enabled" i18n-title></pngx-input-switch>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<pngx-input-select [(ngModel)]="template.matching_algorithm" [items]="matchingAlgorithms" title="Matching algorithm" i18n-title></pngx-input-select>
|
||||||
|
@if (patternRequired) {
|
||||||
|
<pngx-input-text [(ngModel)]="template.match" title="Matching pattern" i18n-title></pngx-input-text>
|
||||||
|
<pngx-input-check [(ngModel)]="template.is_insensitive" title="Case insensitive" i18n-title></pngx-input-check>
|
||||||
|
}
|
||||||
|
|
||||||
|
<div *pngxIfOwner="object">
|
||||||
|
<hr />
|
||||||
|
<pngx-permissions-form [users]="users()" [accordion]="true" [(ngModel)]="permissionsForm"></pngx-permissions-form>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</ng-template>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li ngbNavItem="zones">
|
||||||
|
<a ngbNavLink><ng-container i18n>Zones</ng-container> <span class="badge bg-primary ms-2">{{ template.zones.length }}</span></a>
|
||||||
|
<ng-template ngbNavContent>
|
||||||
|
@if (selectedZone; as zone) {
|
||||||
|
<div class="d-flex align-items-center gap-2 mb-3">
|
||||||
|
<button type="button" class="btn btn-sm btn-link px-0 me-auto" (click)="deselectZone()">
|
||||||
|
<pngx-bs-icon name="arrow-left" class="me-1"></pngx-bs-icon><ng-container i18n>All zones</ng-container>
|
||||||
|
</button>
|
||||||
|
<button type="button" class="btn btn-sm btn-outline-primary" (click)="testZone()" [disabled]="!previewDocId || zoneTesting">
|
||||||
|
@if (zoneTesting) {
|
||||||
|
<span class="spinner-border spinner-border-sm me-1" aria-hidden="true"></span>
|
||||||
|
} @else {
|
||||||
|
<pngx-bs-icon name="play-fill" class="me-1"></pngx-bs-icon>
|
||||||
|
}
|
||||||
|
<ng-container i18n>Test</ng-container>
|
||||||
|
</button>
|
||||||
|
<button type="button" class="btn btn-sm btn-outline-danger" (click)="removeZone(selectedZoneIndex)" title="Delete zone" i18n-title aria-label="Delete zone" i18n-aria-label>
|
||||||
|
<pngx-bs-icon name="trash"></pngx-bs-icon>
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
@if (zoneTestResult; as result) {
|
||||||
|
@if (result.error) {
|
||||||
|
<div class="alert alert-warning py-2 mb-3 small" role="alert">{{ result.error }}</div>
|
||||||
|
} @else {
|
||||||
|
<dl class="row small border rounded mx-0 py-2 mb-3">
|
||||||
|
<dt class="col-4" i18n>OCR text</dt>
|
||||||
|
<dd class="col-8">
|
||||||
|
@if (result.raw_text) {
|
||||||
|
<code>{{ result.raw_text }}</code>
|
||||||
|
} @else {
|
||||||
|
<span class="text-muted" i18n>Nothing detected</span>
|
||||||
|
}
|
||||||
|
</dd>
|
||||||
|
<dt class="col-4" i18n>Value</dt>
|
||||||
|
<dd class="col-8" [class.mb-0]="!result.regex">
|
||||||
|
@if (result.value) {
|
||||||
|
<code>{{ result.value }}</code>
|
||||||
|
} @else {
|
||||||
|
<span class="text-muted" i18n>Empty</span>
|
||||||
|
}
|
||||||
|
</dd>
|
||||||
|
@if (result.regex) {
|
||||||
|
<dt class="col-4" i18n>Validation</dt>
|
||||||
|
<dd class="col-8 mb-0">
|
||||||
|
@if (result.regex_match) {
|
||||||
|
<span class="badge bg-success" i18n>Regex matches</span>
|
||||||
|
} @else {
|
||||||
|
<span class="badge bg-danger" i18n>Regex does not match</span>
|
||||||
|
}
|
||||||
|
</dd>
|
||||||
|
}
|
||||||
|
</dl>
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
<pngx-input-text [ngModel]="zone.name" (ngModelChange)="renameZone(zone, $event)" title="Name" i18n-title></pngx-input-text>
|
||||||
|
|
||||||
|
<pngx-input-select
|
||||||
|
[items]="fieldItems()"
|
||||||
|
[ngModel]="zoneFieldValue(zone)"
|
||||||
|
(ngModelChange)="setZoneField(zone, $event)"
|
||||||
|
(createNew)="createField($event)"
|
||||||
|
title="Field"
|
||||||
|
i18n-title
|
||||||
|
placeholder="Choose a field"
|
||||||
|
i18n-placeholder
|
||||||
|
hint="Where the extracted value is written."
|
||||||
|
i18n-hint
|
||||||
|
></pngx-input-select>
|
||||||
|
|
||||||
|
@if (isFieldShared(zone)) {
|
||||||
|
<pngx-input-text
|
||||||
|
[ngModel]="getCombineFormat(zone)"
|
||||||
|
(ngModelChange)="setCombineFormat(zone, $event)"
|
||||||
|
[placeholder]="defaultCombineFormat(zone)"
|
||||||
|
title="Combined value"
|
||||||
|
i18n-title
|
||||||
|
hint="Several zones write to this field. Set the format or leave empty to join them with spaces."
|
||||||
|
i18n-hint
|
||||||
|
></pngx-input-text>
|
||||||
|
<div class="d-flex flex-wrap gap-1 mt-n2 mb-3">
|
||||||
|
@for (z of zonesForField(zone); track z) {
|
||||||
|
<button type="button" class="btn btn-sm btn-outline-secondary font-monospace" (click)="insertCombineToken(zone, z)">{{ '{' + z.name + '}' }}</button>
|
||||||
|
}
|
||||||
|
</div>
|
||||||
|
}
|
||||||
|
|
||||||
|
<div class="row align-items-end">
|
||||||
|
<div class="col">
|
||||||
|
@if (!isLastPageZone(zone)) {
|
||||||
|
<pngx-input-number [(ngModel)]="zone.page" [showAdd]="false" title="Page" i18n-title></pngx-input-number>
|
||||||
|
}
|
||||||
|
</div>
|
||||||
|
<div class="col-auto">
|
||||||
|
<pngx-input-switch [ngModel]="isLastPageZone(zone)" (ngModelChange)="setLastPageZone(zone, $event)" [horizontal]="true" title="Last page" i18n-title></pngx-input-switch>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<h6 class="border-top pt-3 mt-1 mb-3" i18n>Processing</h6>
|
||||||
|
|
||||||
|
<pngx-input-select
|
||||||
|
[items]="languageOptions"
|
||||||
|
[multiple]="true"
|
||||||
|
[ngModel]="ocrLanguageArray(zone)"
|
||||||
|
(ngModelChange)="setOcrLanguages(zone, $event)"
|
||||||
|
title="OCR language"
|
||||||
|
i18n-title
|
||||||
|
placeholder="Select languages"
|
||||||
|
i18n-placeholder
|
||||||
|
></pngx-input-select>
|
||||||
|
|
||||||
|
<pngx-input-select [items]="transformOptions" [(ngModel)]="zone.transform" title="Transform" i18n-title></pngx-input-select>
|
||||||
|
|
||||||
|
@if (zone.transform === OcrZoneTransform.Date) {
|
||||||
|
<pngx-input-text
|
||||||
|
[(ngModel)]="zone.date_format"
|
||||||
|
title="Date format"
|
||||||
|
i18n-title
|
||||||
|
placeholder="Auto-detect"
|
||||||
|
i18n-placeholder
|
||||||
|
hint="Python date codes, e.g. %d.%m.%Y. Leave empty to detect the format automatically."
|
||||||
|
i18n-hint
|
||||||
|
></pngx-input-text>
|
||||||
|
}
|
||||||
|
|
||||||
|
<pngx-input-text [(ngModel)]="zone.validation_regex" title="Validation regex" i18n-title placeholder="\d{2}\.\d{2}\.\d{4}" hint="The value must match this pattern to be applied." i18n-hint></pngx-input-text>
|
||||||
|
} @else {
|
||||||
|
<pngx-ocr-template-zone-list
|
||||||
|
[zones]="template.zones"
|
||||||
|
[customFields]="customFields()"
|
||||||
|
(zoneSelected)="selectZone($event)"
|
||||||
|
(zoneRemoved)="removeZone($event)"
|
||||||
|
></pngx-ocr-template-zone-list>
|
||||||
|
}
|
||||||
|
</ng-template>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<div [ngbNavOutlet]="nav" class="mt-3"></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="col-lg-8 d-flex flex-column">
|
||||||
|
<div class="d-flex flex-wrap gap-2 mb-2 flex-shrink-0">
|
||||||
|
<pngx-input-document-link
|
||||||
|
class="flex-grow-1 paperless-input-select"
|
||||||
|
[ngModel]="sampleDocumentIds"
|
||||||
|
(ngModelChange)="setSampleDocument($event)"
|
||||||
|
[minimal]="true"
|
||||||
|
[multiple]="false"
|
||||||
|
placeholder="Search for a sample document"
|
||||||
|
i18n-placeholder
|
||||||
|
></pngx-input-document-link>
|
||||||
|
@if (previewDocId) {
|
||||||
|
<div class="input-group w-auto flex-nowrap">
|
||||||
|
<input class="form-control flex-grow-0 preview-page-input" type="number" min="1" [max]="previewPageCount()" [(ngModel)]="previewPageDisplay" [disabled]="!pageLoaded()" aria-label="Page" i18n-aria-label />
|
||||||
|
@if (previewPageCount(); as pageCount) {
|
||||||
|
<span class="input-group-text" i18n>of {{ pageCount }}</span>
|
||||||
|
}
|
||||||
|
</div>
|
||||||
|
<fieldset class="input-group w-auto flex-nowrap" aria-label="Zoom" i18n-aria-label>
|
||||||
|
<button type="button" class="btn btn-outline-secondary" aria-label="Zoom out" i18n-aria-label [disabled]="!pageLoaded() || zoom <= 0.5" (click)="zoomOut()"><pngx-bs-icon name="dash"></pngx-bs-icon></button>
|
||||||
|
<button type="button" class="btn btn-outline-secondary preview-zoom" title="Reset zoom" i18n-title [disabled]="!pageLoaded()" (click)="resetZoom()">{{ zoom | percent: '1.0-0' }}</button>
|
||||||
|
<button type="button" class="btn btn-outline-secondary" aria-label="Zoom in" i18n-aria-label [disabled]="!pageLoaded() || zoom >= 4" (click)="zoomIn()"><pngx-bs-icon name="plus"></pngx-bs-icon></button>
|
||||||
|
</fieldset>
|
||||||
|
}
|
||||||
|
</div>
|
||||||
|
<div class="flex-grow-1 overflow-hidden">
|
||||||
|
<div class="h-100 overflow-auto border" [attr.aria-busy]="previewDocId && !pageLoaded()">
|
||||||
|
@if (pageFailed()) {
|
||||||
|
<div class="py-5 px-3 text-center" role="alert">
|
||||||
|
<pngx-bs-icon name="exclamation-triangle" width="32" height="32" class="text-warning"></pngx-bs-icon>
|
||||||
|
<p class="my-3" i18n>Could not load this page.</p>
|
||||||
|
<button type="button" class="btn btn-sm btn-outline-secondary" (click)="setSampleDocument(sampleDocumentIds)"><pngx-bs-icon name="arrow-clockwise" class="me-1"></pngx-bs-icon><span i18n>Retry</span></button>
|
||||||
|
</div>
|
||||||
|
} @else if (previewDocId) {
|
||||||
|
<div class="position-relative" [class.d-none]="!pageLoaded()" [style.width.%]="zoom * 100">
|
||||||
|
<img
|
||||||
|
#pageImage
|
||||||
|
[src]="pageImageUrl"
|
||||||
|
(load)="onImageLoad()"
|
||||||
|
(error)="onImageError()"
|
||||||
|
alt="Sample document page"
|
||||||
|
i18n-alt
|
||||||
|
class="d-block w-100"
|
||||||
|
crossorigin="use-credentials"
|
||||||
|
/>
|
||||||
|
@if (pageLoaded()) {
|
||||||
|
<svg
|
||||||
|
#zoneOverlay
|
||||||
|
class="zone-overlay position-absolute top-0 start-0 w-100 h-100"
|
||||||
|
[attr.viewBox]="overlayViewBox()"
|
||||||
|
preserveAspectRatio="none"
|
||||||
|
[style.cursor]="overlayCursor"
|
||||||
|
(pointerdown)="onOverlayPointerDown($event)"
|
||||||
|
(pointermove)="onOverlayPointerMove($event)"
|
||||||
|
(pointerup)="onOverlayPointerUp($event)"
|
||||||
|
(pointercancel)="onOverlayPointerCancel($event)"
|
||||||
|
(lostpointercapture)="onOverlayPointerCancel($event)"
|
||||||
|
aria-label="Zone overlay" i18n-aria-label
|
||||||
|
>
|
||||||
|
@for (zone of template.zones; track $index; let i = $index) {
|
||||||
|
@if (zoneDisplayRect(i); as rect) {
|
||||||
|
<g>
|
||||||
|
<rect
|
||||||
|
class="zone-rect"
|
||||||
|
[class.zone-rect-selected]="selectedZoneIndex === i"
|
||||||
|
[attr.x]="rect.x"
|
||||||
|
[attr.y]="rect.y"
|
||||||
|
[attr.width]="rect.w"
|
||||||
|
[attr.height]="rect.h"
|
||||||
|
[attr.stroke]="zoneColor(i)"
|
||||||
|
[attr.fill]="zoneColor(i)"
|
||||||
|
></rect>
|
||||||
|
<text
|
||||||
|
class="zone-label fw-semibold pe-none"
|
||||||
|
[attr.x]="rect.x + overlayUnitSize(6)"
|
||||||
|
[attr.y]="zoneLabelY(rect)"
|
||||||
|
[attr.font-size]="overlayFontSize()"
|
||||||
|
[attr.fill]="zoneColor(i)"
|
||||||
|
>{{ zoneLabel(zone, i) }}</text>
|
||||||
|
|
||||||
|
@if (selectedZoneIndex === i) {
|
||||||
|
@for (handle of resizeHandles(rect); track handle.handle) {
|
||||||
|
<rect
|
||||||
|
class="zone-resize-handle"
|
||||||
|
[attr.x]="handle.x - overlayHandleSize() / 2"
|
||||||
|
[attr.y]="handle.y - overlayHandleSize() / 2"
|
||||||
|
[attr.width]="overlayHandleSize()"
|
||||||
|
[attr.height]="overlayHandleSize()"
|
||||||
|
[attr.fill]="zoneColor(i)"
|
||||||
|
></rect>
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</g>
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@if (drawingRect(); as rect) {
|
||||||
|
<rect
|
||||||
|
class="zone-drawing-rect"
|
||||||
|
[attr.x]="rect.x"
|
||||||
|
[attr.y]="rect.y"
|
||||||
|
[attr.width]="rect.w"
|
||||||
|
[attr.height]="rect.h"
|
||||||
|
></rect>
|
||||||
|
}
|
||||||
|
</svg>
|
||||||
|
}
|
||||||
|
</div>
|
||||||
|
@if (!pageLoaded()) {
|
||||||
|
<div class="p-5 d-flex justify-content-center align-items-center">
|
||||||
|
<output class="spinner-border">
|
||||||
|
<span class="visually-hidden" i18n>Loading page...</span>
|
||||||
|
</output>
|
||||||
|
</div>
|
||||||
|
}
|
||||||
|
} @else {
|
||||||
|
<div class="py-5 px-3 text-center text-muted">
|
||||||
|
<pngx-bs-icon name="file-text" width="32" height="32"></pngx-bs-icon>
|
||||||
|
<p class="mt-3 mb-0" i18n>No sample document selected.</p>
|
||||||
|
</div>
|
||||||
|
}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="modal-footer">
|
||||||
|
<button type="button" class="btn btn-outline-secondary" (click)="activeModal.dismiss()" [disabled]="saving()" i18n>Cancel</button>
|
||||||
|
<button type="button" class="btn btn-primary" (click)="save()" [disabled]="saving() || !isDirty">
|
||||||
|
@if (saving()) {
|
||||||
|
<span class="spinner-border spinner-border-sm me-1" aria-hidden="true"></span>
|
||||||
|
}
|
||||||
|
<span i18n>Save</span>
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
+64
@@ -0,0 +1,64 @@
|
|||||||
|
:host {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
min-height: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (min-width: 992px) {
|
||||||
|
.modal-body {
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
.editor-layout {
|
||||||
|
min-height: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.preview-page-input {
|
||||||
|
width: 3.5rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.preview-zoom {
|
||||||
|
min-width: 4rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.zone-overlay {
|
||||||
|
touch-action: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.zone-rect,
|
||||||
|
.zone-drawing-rect {
|
||||||
|
vector-effect: non-scaling-stroke;
|
||||||
|
}
|
||||||
|
|
||||||
|
.zone-rect {
|
||||||
|
fill-opacity: 0.2;
|
||||||
|
stroke-width: 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
.zone-rect-selected {
|
||||||
|
stroke-width: 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
.zone-label {
|
||||||
|
font-family: var(--bs-font-sans-serif);
|
||||||
|
paint-order: stroke;
|
||||||
|
stroke: #fff;
|
||||||
|
stroke-linejoin: round;
|
||||||
|
stroke-width: 4px;
|
||||||
|
vector-effect: non-scaling-stroke;
|
||||||
|
}
|
||||||
|
|
||||||
|
.zone-resize-handle {
|
||||||
|
stroke: #fff;
|
||||||
|
stroke-width: 1;
|
||||||
|
vector-effect: non-scaling-stroke;
|
||||||
|
}
|
||||||
|
|
||||||
|
.zone-drawing-rect {
|
||||||
|
fill: var(--bs-primary);
|
||||||
|
fill-opacity: 0.2;
|
||||||
|
stroke: var(--bs-primary);
|
||||||
|
stroke-dasharray: 5 5;
|
||||||
|
stroke-width: 2;
|
||||||
|
}
|
||||||
+906
@@ -0,0 +1,906 @@
|
|||||||
|
import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
|
||||||
|
import { provideHttpClientTesting } from '@angular/common/http/testing'
|
||||||
|
import { ElementRef } from '@angular/core'
|
||||||
|
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
||||||
|
import { By } from '@angular/platform-browser'
|
||||||
|
import { NgbActiveModal, NgbModal } from '@ng-bootstrap/ng-bootstrap'
|
||||||
|
import { BootstrapIconComponent } from 'src/app/components/common/bootstrap-icon/bootstrap-icon.component'
|
||||||
|
import { of, Subject, throwError } from 'rxjs'
|
||||||
|
import { PermissionsFormComponent } from 'src/app/components/common/input/permissions/permissions-form/permissions-form.component'
|
||||||
|
import { CustomField, CustomFieldDataType } from 'src/app/data/custom-field'
|
||||||
|
import { Document } from 'src/app/data/document'
|
||||||
|
import {
|
||||||
|
MATCH_ANY,
|
||||||
|
MATCH_AUTO,
|
||||||
|
MATCH_LITERAL,
|
||||||
|
MATCH_NONE,
|
||||||
|
} from 'src/app/data/matching-model'
|
||||||
|
import {
|
||||||
|
OcrTemplate,
|
||||||
|
OcrTemplateZone,
|
||||||
|
OcrZoneTarget,
|
||||||
|
OcrZoneTestResult,
|
||||||
|
OcrZoneTransform,
|
||||||
|
} from 'src/app/data/ocr-template'
|
||||||
|
import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
|
||||||
|
import { User } from 'src/app/data/user'
|
||||||
|
import { PermissionsService } from 'src/app/services/permissions.service'
|
||||||
|
import { CustomFieldsService } from 'src/app/services/rest/custom-fields.service'
|
||||||
|
import { DocumentService } from 'src/app/services/rest/document.service'
|
||||||
|
import { OcrTemplateService } from 'src/app/services/rest/ocr-template.service'
|
||||||
|
import { UserService } from 'src/app/services/rest/user.service'
|
||||||
|
import { SettingsService } from 'src/app/services/settings.service'
|
||||||
|
import { ToastService } from 'src/app/services/toast.service'
|
||||||
|
import { OcrTemplateEditorComponent } from './ocr-template-editor.component'
|
||||||
|
|
||||||
|
const customFields: CustomField[] = [
|
||||||
|
{ id: 1, name: 'Invoice number', data_type: CustomFieldDataType.String },
|
||||||
|
{ id: 2, name: 'Status', data_type: CustomFieldDataType.Select },
|
||||||
|
]
|
||||||
|
|
||||||
|
function zone(overrides: Partial<OcrTemplateZone> = {}): OcrTemplateZone {
|
||||||
|
return {
|
||||||
|
name: 'Invoice number',
|
||||||
|
target: OcrZoneTarget.CustomField,
|
||||||
|
custom_field: 1,
|
||||||
|
x: 100,
|
||||||
|
y: 100,
|
||||||
|
width: 200,
|
||||||
|
height: 100,
|
||||||
|
page: 1,
|
||||||
|
ocr_language: 'eng',
|
||||||
|
transform: OcrZoneTransform.Strip,
|
||||||
|
validation_regex: '',
|
||||||
|
order: 0,
|
||||||
|
...overrides,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function pointer(x: number, y: number, pointerId = 1): PointerEvent {
|
||||||
|
return Object.assign(
|
||||||
|
new MouseEvent('pointermove', { clientX: x, clientY: y, button: 0 }),
|
||||||
|
{ pointerId }
|
||||||
|
) as PointerEvent
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('OcrTemplateEditorComponent', () => {
|
||||||
|
let component: OcrTemplateEditorComponent
|
||||||
|
let fixture: ComponentFixture<OcrTemplateEditorComponent>
|
||||||
|
let documentService: DocumentService
|
||||||
|
let templateService: OcrTemplateService
|
||||||
|
let modalService: NgbModal
|
||||||
|
const activeModal = { close: jest.fn(), dismiss: jest.fn() }
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
TestBed.configureTestingModule({
|
||||||
|
imports: [BootstrapIconComponent, OcrTemplateEditorComponent],
|
||||||
|
providers: [
|
||||||
|
{ provide: NgbActiveModal, useValue: activeModal },
|
||||||
|
provideHttpClient(withInterceptorsFromDi()),
|
||||||
|
provideHttpClientTesting(),
|
||||||
|
],
|
||||||
|
})
|
||||||
|
jest
|
||||||
|
.spyOn(TestBed.inject(CustomFieldsService), 'listAll')
|
||||||
|
.mockReturnValue(of({ count: 2, all: [1, 2], results: customFields }))
|
||||||
|
jest
|
||||||
|
.spyOn(TestBed.inject(UserService), 'listAll')
|
||||||
|
.mockReturnValue(of({ count: 0, all: [], results: [] }))
|
||||||
|
TestBed.inject(PermissionsService).initialize([], { id: 1 } as User)
|
||||||
|
documentService = TestBed.inject(DocumentService)
|
||||||
|
jest
|
||||||
|
.spyOn(documentService, 'get')
|
||||||
|
.mockReturnValue(of({ id: 5, page_count: 3 }))
|
||||||
|
templateService = TestBed.inject(OcrTemplateService)
|
||||||
|
modalService = TestBed.inject(NgbModal)
|
||||||
|
activeModal.close.mockReset()
|
||||||
|
fixture = TestBed.createComponent(OcrTemplateEditorComponent)
|
||||||
|
component = fixture.componentInstance
|
||||||
|
})
|
||||||
|
|
||||||
|
function prepareOverlay() {
|
||||||
|
const image = document.createElement('img')
|
||||||
|
Object.defineProperties(image, {
|
||||||
|
naturalWidth: { value: 1000 },
|
||||||
|
naturalHeight: { value: 1000 },
|
||||||
|
clientWidth: { value: 1000 },
|
||||||
|
})
|
||||||
|
const overlay = document.createElementNS(
|
||||||
|
'http://www.w3.org/2000/svg',
|
||||||
|
'svg'
|
||||||
|
)
|
||||||
|
Object.assign(overlay, {
|
||||||
|
getScreenCTM: () => ({ inverse: () => ({}) }),
|
||||||
|
createSVGPoint: () => ({
|
||||||
|
x: 0,
|
||||||
|
y: 0,
|
||||||
|
matrixTransform() {
|
||||||
|
return { x: this.x, y: this.y }
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
setPointerCapture: jest.fn(),
|
||||||
|
hasPointerCapture: () => true,
|
||||||
|
releasePointerCapture: jest.fn(),
|
||||||
|
})
|
||||||
|
component.imageRef = new ElementRef(image)
|
||||||
|
component.overlayRef = new ElementRef(overlay)
|
||||||
|
component.pageLoaded.set(true)
|
||||||
|
}
|
||||||
|
|
||||||
|
function fieldDialog() {
|
||||||
|
const dialog = {
|
||||||
|
dialogMode: { set: jest.fn() },
|
||||||
|
object: null,
|
||||||
|
succeeded: new Subject<CustomField>(),
|
||||||
|
failed: new Subject(),
|
||||||
|
}
|
||||||
|
jest
|
||||||
|
.spyOn(modalService, 'open')
|
||||||
|
.mockReturnValue({ componentInstance: dialog } as any)
|
||||||
|
return dialog
|
||||||
|
}
|
||||||
|
|
||||||
|
it('updates screen-sized overlay units when the preview image resizes', () => {
|
||||||
|
let resize: ResizeObserverCallback
|
||||||
|
const observer = {
|
||||||
|
observe: jest.fn(),
|
||||||
|
unobserve: jest.fn(),
|
||||||
|
disconnect: jest.fn(),
|
||||||
|
}
|
||||||
|
const resizeObserver = jest
|
||||||
|
.spyOn(globalThis, 'ResizeObserver')
|
||||||
|
.mockImplementation((callback) => {
|
||||||
|
resize = callback
|
||||||
|
return observer
|
||||||
|
})
|
||||||
|
const image = document.createElement('img')
|
||||||
|
const ref = new ElementRef(image)
|
||||||
|
component.pageImage = ref
|
||||||
|
expect(observer.observe).toHaveBeenCalledWith(image)
|
||||||
|
resize([], observer)
|
||||||
|
expect(component.overlayUnitSize(8)).toBe(8)
|
||||||
|
|
||||||
|
Object.defineProperties(image, {
|
||||||
|
naturalWidth: { value: 1000 },
|
||||||
|
clientWidth: { value: 500 },
|
||||||
|
})
|
||||||
|
resize([], observer)
|
||||||
|
expect(component.overlayUnitSize(8)).toBe(16)
|
||||||
|
expect(component.overlayFontSize()).toBe(24)
|
||||||
|
|
||||||
|
component.pageImage = undefined
|
||||||
|
expect(observer.disconnect).toHaveBeenCalledTimes(1)
|
||||||
|
fixture.destroy()
|
||||||
|
expect(observer.disconnect).toHaveBeenCalledTimes(2)
|
||||||
|
resizeObserver.mockRestore()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('renders loaded image dimensions, zone labels, and selection handles', () => {
|
||||||
|
component.object = {
|
||||||
|
...component.template,
|
||||||
|
id: 3,
|
||||||
|
sample_document: 5,
|
||||||
|
zones: [zone()],
|
||||||
|
}
|
||||||
|
component.selectedZoneIndex = 0
|
||||||
|
fixture.detectChanges()
|
||||||
|
const image = fixture.nativeElement.querySelector('img')
|
||||||
|
Object.defineProperties(image, {
|
||||||
|
naturalWidth: { value: 1000 },
|
||||||
|
naturalHeight: { value: 1500 },
|
||||||
|
})
|
||||||
|
image.dispatchEvent(new Event('load'))
|
||||||
|
fixture.detectChanges()
|
||||||
|
|
||||||
|
expect(component.template).toMatchObject({
|
||||||
|
source_width: 1000,
|
||||||
|
source_height: 1500,
|
||||||
|
})
|
||||||
|
expect(
|
||||||
|
fixture.nativeElement
|
||||||
|
.querySelector('.zone-overlay')
|
||||||
|
.getAttribute('viewBox')
|
||||||
|
).toBe('0 0 1000 1500')
|
||||||
|
expect(
|
||||||
|
fixture.nativeElement.querySelector('.zone-label').textContent
|
||||||
|
).toContain('Invoice number')
|
||||||
|
expect(
|
||||||
|
fixture.nativeElement.querySelectorAll('.zone-resize-handle')
|
||||||
|
).toHaveLength(8)
|
||||||
|
expect(component.zoneLabel(zone({ name: '' }), 2)).toBe('Zone 3')
|
||||||
|
expect(component.zoneLabelY({ x: 0, y: 0, w: 100, h: 100 })).toBe(14)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('offers the supported language and transform choices', () => {
|
||||||
|
expect(component.languageOptions.map((option) => option.id)).toContain(
|
||||||
|
'eng'
|
||||||
|
)
|
||||||
|
expect(component.transformOptions.map((option) => option.id)).toEqual(
|
||||||
|
Object.values(OcrZoneTransform)
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('clamps page navigation and supports one-based page input', () => {
|
||||||
|
component.setSampleDocument([5])
|
||||||
|
component.previewPageDisplay = 2
|
||||||
|
expect(component.previewPage).toBe(1)
|
||||||
|
expect(component.previewPageDisplay).toBe(2)
|
||||||
|
expect(component.pageImageUrl).toContain('/5/1/')
|
||||||
|
component.pageLoaded.set(true)
|
||||||
|
component.goToPage(1)
|
||||||
|
expect(component.pageLoaded()).toBe(true)
|
||||||
|
component.goToPage(Infinity)
|
||||||
|
component.goToPage(NaN)
|
||||||
|
expect(component.previewPage).toBe(1)
|
||||||
|
component.goToPage(99)
|
||||||
|
expect(component.previewPage).toBe(2)
|
||||||
|
expect(component.pageLoaded()).toBe(false)
|
||||||
|
component.goToPage(-5)
|
||||||
|
expect(component.previewPage).toBe(0)
|
||||||
|
component.previewPageCount.set(null)
|
||||||
|
component.goToPage(4.7)
|
||||||
|
expect(component.previewPage).toBe(4)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('uses the standard picker styling and shows a known page total', () => {
|
||||||
|
component.setSampleDocument([5])
|
||||||
|
fixture.detectChanges()
|
||||||
|
const picker = fixture.nativeElement.querySelector(
|
||||||
|
'pngx-input-document-link'
|
||||||
|
)
|
||||||
|
expect(picker.classList.contains('paperless-input-select')).toBe(true)
|
||||||
|
const pageInput = fixture.nativeElement.querySelector(
|
||||||
|
'input[aria-label="Page"]'
|
||||||
|
)
|
||||||
|
expect(pageInput.max).toBe('3')
|
||||||
|
expect(pageInput.parentElement.textContent.trim()).toBe('of 3')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does not display a question mark when the page total is unknown', () => {
|
||||||
|
jest
|
||||||
|
.spyOn(documentService, 'get')
|
||||||
|
.mockReturnValueOnce(of({ id: 5, page_count: null }))
|
||||||
|
component.setSampleDocument([5])
|
||||||
|
fixture.detectChanges()
|
||||||
|
const pageInput = fixture.nativeElement.querySelector(
|
||||||
|
'input[aria-label="Page"]'
|
||||||
|
)
|
||||||
|
expect(
|
||||||
|
pageInput.parentElement.querySelector('.input-group-text')
|
||||||
|
).toBeNull()
|
||||||
|
component.pageLoaded.set(true)
|
||||||
|
component.previewPageDisplay = 2
|
||||||
|
expect(component.previewPage).toBe(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('limits zoom and resets it to the original size', () => {
|
||||||
|
for (let i = 0; i < 20; i++) component.zoomIn()
|
||||||
|
expect(component.zoom).toBe(4)
|
||||||
|
for (let i = 0; i < 20; i++) component.zoomOut()
|
||||||
|
expect(component.zoom).toBe(0.5)
|
||||||
|
component.resetZoom()
|
||||||
|
expect(component.zoom).toBe(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('moves last-page zones to the last page and can pin them to a page', () => {
|
||||||
|
component.setSampleDocument([5])
|
||||||
|
const selected = zone()
|
||||||
|
component.template.zones = [selected]
|
||||||
|
expect(component.isLastPageZone(selected)).toBe(false)
|
||||||
|
component.setLastPageZone(selected, true)
|
||||||
|
expect(selected.page).toBe(-1)
|
||||||
|
expect(component.isLastPageZone(selected)).toBe(true)
|
||||||
|
component.selectZone(0)
|
||||||
|
expect(component.previewPage).toBe(2)
|
||||||
|
component.setLastPageZone(selected, false)
|
||||||
|
expect(selected.page).toBe(3)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('ignores page-count errors from a previous sample document', () => {
|
||||||
|
const pending = new Subject<Document>()
|
||||||
|
jest
|
||||||
|
.spyOn(documentService, 'get')
|
||||||
|
.mockReturnValueOnce(pending)
|
||||||
|
.mockReturnValueOnce(of({ id: 6 }))
|
||||||
|
component.setSampleDocument([5])
|
||||||
|
component.setSampleDocument([6])
|
||||||
|
pending.error(new Error('Old document failed'))
|
||||||
|
expect(component.pageFailed()).toBe(false)
|
||||||
|
expect(component.previewPageCount()).toBeNull()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('ignores non-primary, unloaded, and saving pointer gestures', () => {
|
||||||
|
prepareOverlay()
|
||||||
|
component.onOverlayPointerDown(
|
||||||
|
new MouseEvent('pointerdown', { button: 2 }) as PointerEvent
|
||||||
|
)
|
||||||
|
expect(component.drawingRect()).toBeNull()
|
||||||
|
component.pageLoaded.set(false)
|
||||||
|
component.onOverlayPointerDown(pointer(100, 100))
|
||||||
|
expect(component.drawingRect()).toBeNull()
|
||||||
|
component.pageLoaded.set(true)
|
||||||
|
component.saving.set(true)
|
||||||
|
component.onOverlayPointerDown(pointer(100, 100))
|
||||||
|
expect(component.drawingRect()).toBeNull()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('ignores pointer events when the SVG coordinate transform is unavailable', () => {
|
||||||
|
component.onOverlayPointerDown(pointer(100, 100))
|
||||||
|
expect(component.drawingRect()).toBeNull()
|
||||||
|
prepareOverlay()
|
||||||
|
jest
|
||||||
|
.spyOn(component.overlayRef.nativeElement, 'getScreenCTM')
|
||||||
|
.mockReturnValue(null)
|
||||||
|
component.onOverlayPointerDown(pointer(100, 100))
|
||||||
|
component.onOverlayPointerMove(pointer(200, 200))
|
||||||
|
expect(component.drawingRect()).toBeNull()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('updates a drawing only for its captured pointer', () => {
|
||||||
|
prepareOverlay()
|
||||||
|
component.onOverlayPointerDown(pointer(100, 100))
|
||||||
|
component.onOverlayPointerDown(pointer(500, 500, 2))
|
||||||
|
component.onOverlayPointerMove(pointer(900, 900, 2))
|
||||||
|
expect(component.drawingRect()).toEqual({ x: 100, y: 100, w: 0, h: 0 })
|
||||||
|
component.onOverlayPointerMove(pointer(250, 200))
|
||||||
|
expect(component.drawingRect()).toEqual({ x: 100, y: 100, w: 150, h: 100 })
|
||||||
|
component.onOverlayPointerUp(pointer(250, 200))
|
||||||
|
expect(component.template.zones[0]).toMatchObject({
|
||||||
|
x: 100,
|
||||||
|
y: 100,
|
||||||
|
width: 150,
|
||||||
|
height: 100,
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('resizes a selected zone using its corner handle', () => {
|
||||||
|
prepareOverlay()
|
||||||
|
const selected = zone()
|
||||||
|
component.template.zones = [selected]
|
||||||
|
component.selectZone(0)
|
||||||
|
component.onOverlayPointerDown(pointer(100, 100))
|
||||||
|
component.onOverlayPointerMove(pointer(50, 75))
|
||||||
|
component.onOverlayPointerUp(pointer(60, 80))
|
||||||
|
expect(selected).toMatchObject({ x: 60, y: 80, width: 240, height: 120 })
|
||||||
|
expect(component.template.zones).toHaveLength(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('shows the appropriate cursor over handles, zones, and empty space', () => {
|
||||||
|
prepareOverlay()
|
||||||
|
component.template.zones = [zone()]
|
||||||
|
component.onOverlayPointerMove(pointer(150, 150))
|
||||||
|
expect(component.overlayCursor).toBe('move')
|
||||||
|
component.selectZone(0)
|
||||||
|
component.onOverlayPointerMove(pointer(100, 100))
|
||||||
|
expect(component.overlayCursor).toBe('nw-resize')
|
||||||
|
component.onOverlayPointerMove(pointer(500, 500))
|
||||||
|
expect(component.overlayCursor).toBe('crosshair')
|
||||||
|
component.template.zones[0].page = 2
|
||||||
|
component.onOverlayPointerMove(pointer(100, 100))
|
||||||
|
expect(component.zoneDisplayRect(0)).toBeNull()
|
||||||
|
expect(component.overlayCursor).toBe('crosshair')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('cancels only the captured pointer and tolerates an already-lost capture', () => {
|
||||||
|
prepareOverlay()
|
||||||
|
component.onOverlayPointerCancel(pointer(100, 100))
|
||||||
|
component.onOverlayPointerDown(pointer(100, 100))
|
||||||
|
component.onOverlayPointerCancel(pointer(150, 150, 2))
|
||||||
|
expect(component.drawingRect()).not.toBeNull()
|
||||||
|
jest
|
||||||
|
.spyOn(component.overlayRef.nativeElement, 'hasPointerCapture')
|
||||||
|
.mockReturnValue(false)
|
||||||
|
component.onOverlayPointerCancel(pointer(150, 150))
|
||||||
|
expect(component.drawingRect()).toBeNull()
|
||||||
|
expect(
|
||||||
|
component.overlayRef.nativeElement.releasePointerCapture
|
||||||
|
).not.toHaveBeenCalled()
|
||||||
|
expect(component.template.zones).toEqual([])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('preserves the selected zone when an earlier or later zone is removed', () => {
|
||||||
|
component.template.zones = [zone(), zone(), zone(), zone()]
|
||||||
|
component.selectZone(1)
|
||||||
|
const selected = component.selectedZone
|
||||||
|
component.removeZone(3)
|
||||||
|
expect(component.selectedZone).toBe(selected)
|
||||||
|
component.removeZone(0)
|
||||||
|
expect(component.selectedZoneIndex).toBe(0)
|
||||||
|
expect(component.selectedZone).toBe(selected)
|
||||||
|
component.selectZone(99)
|
||||||
|
expect(component.selectedZone).toBeNull()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does not test zones without a selection or a sample document', () => {
|
||||||
|
const test = jest.spyOn(templateService, 'testZone')
|
||||||
|
component.testZone()
|
||||||
|
component.template.zones = [zone()]
|
||||||
|
component.selectZone(0)
|
||||||
|
component.testZone()
|
||||||
|
expect(test).not.toHaveBeenCalled()
|
||||||
|
})
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
{
|
||||||
|
response: { error: { error: 'OCR unavailable' } },
|
||||||
|
message: 'OCR unavailable',
|
||||||
|
},
|
||||||
|
{ response: new Error('Network failure'), message: 'Test failed' },
|
||||||
|
])('shows zone-test errors: $message', ({ response, message }) => {
|
||||||
|
component.template.zones = [zone({ page: undefined })]
|
||||||
|
component.selectZone(0)
|
||||||
|
component.setSampleDocument([5])
|
||||||
|
jest
|
||||||
|
.spyOn(templateService, 'testZone')
|
||||||
|
.mockReturnValue(throwError(() => response))
|
||||||
|
component.testZone()
|
||||||
|
expect(component.zoneTestResult).toEqual({ error: message })
|
||||||
|
expect(component.zoneTesting).toBe(false)
|
||||||
|
expect(templateService.testZone).toHaveBeenCalledWith(
|
||||||
|
5,
|
||||||
|
expect.objectContaining({ page: 1 })
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('switches between built-in targets, custom fields, and an unassigned field', () => {
|
||||||
|
const selected = zone()
|
||||||
|
expect(component.zoneFieldValue(selected)).toBe(1)
|
||||||
|
component.setZoneField(selected, OcrZoneTarget.Title)
|
||||||
|
expect(component.zoneFieldValue(selected)).toBe(OcrZoneTarget.Title)
|
||||||
|
expect(selected.custom_field).toBeNull()
|
||||||
|
component.setZoneField(selected, 7)
|
||||||
|
expect(selected).toMatchObject({
|
||||||
|
target: OcrZoneTarget.CustomField,
|
||||||
|
custom_field: 7,
|
||||||
|
})
|
||||||
|
component.setZoneField(selected, null)
|
||||||
|
expect(component.zoneFieldValue(selected)).toBeNull()
|
||||||
|
expect(component.zonesForField(selected)).toEqual([])
|
||||||
|
component.setCombineFormat(selected, 'Ignored')
|
||||||
|
expect(component.template.combine_formats).toEqual({})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('creates combine formats when absent and leaves implicit formats alone on rename', () => {
|
||||||
|
const selected = zone({ target: OcrZoneTarget.Title, custom_field: null })
|
||||||
|
component.template.combine_formats = undefined
|
||||||
|
component.renameZone(selected, 'Renamed')
|
||||||
|
expect(selected.name).toBe('Renamed')
|
||||||
|
expect(component.getCombineFormat(selected)).toBe('')
|
||||||
|
component.setCombineFormat(selected, '{Renamed} ')
|
||||||
|
component.insertCombineToken(selected, selected)
|
||||||
|
expect(component.template.combine_formats).toEqual({
|
||||||
|
title: '{Renamed} {Renamed}',
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('saves templates without combine formats', () => {
|
||||||
|
component.template.combine_formats = undefined
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(component.isDirty).toBe(false)
|
||||||
|
jest
|
||||||
|
.spyOn(templateService, 'create')
|
||||||
|
.mockReturnValue(of(component.template))
|
||||||
|
component.save()
|
||||||
|
expect(component.template.combine_formats).toBeUndefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does not assign unsupported custom field types and surfaces creation failures', () => {
|
||||||
|
component.template.zones = [zone({ custom_field: null })]
|
||||||
|
component.selectZone(0)
|
||||||
|
const dialog = fieldDialog()
|
||||||
|
const error = jest.spyOn(TestBed.inject(ToastService), 'showError')
|
||||||
|
component.createField('Status')
|
||||||
|
expect(dialog.object).toEqual({ name: 'Status' })
|
||||||
|
dialog.succeeded.next(customFields[1])
|
||||||
|
expect(component.selectedZone.custom_field).toBeNull()
|
||||||
|
const failure = new Error('Could not save')
|
||||||
|
dialog.failed.next(failure)
|
||||||
|
expect(error).toHaveBeenCalledWith('Error saving field.', failure)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('refreshes field choices when a field is created without a selected zone', () => {
|
||||||
|
const dialog = fieldDialog()
|
||||||
|
component.createField('Total')
|
||||||
|
dialog.succeeded.next(customFields[0])
|
||||||
|
expect(component.customFields()).toEqual(customFields)
|
||||||
|
expect(component.selectedZone).toBeNull()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should edit a copy of the template and load its sample document', () => {
|
||||||
|
const original: OcrTemplate = {
|
||||||
|
...component.template,
|
||||||
|
id: 3,
|
||||||
|
name: 'Invoices',
|
||||||
|
match: 'Northwind',
|
||||||
|
matching_algorithm: MATCH_LITERAL,
|
||||||
|
sample_document: 5,
|
||||||
|
zones: [zone()],
|
||||||
|
combine_formats: { '1': '{Invoice number}' },
|
||||||
|
}
|
||||||
|
component.object = original
|
||||||
|
fixture.detectChanges()
|
||||||
|
|
||||||
|
expect(component.dialogTitle).toEqual('Edit OCR Template')
|
||||||
|
expect(component.previewDocId).toEqual(5)
|
||||||
|
expect(component.previewPageCount()).toEqual(3)
|
||||||
|
expect(component.pageImageUrl).toContain('document-page-image/5/0/')
|
||||||
|
expect(component.template.match).toEqual('Northwind')
|
||||||
|
expect(component.isDirty).toBeFalsy()
|
||||||
|
|
||||||
|
component.template.zones[0].x = 500
|
||||||
|
component.template.combine_formats['1'] = 'Edited'
|
||||||
|
expect(original.zones[0].x).toEqual(100)
|
||||||
|
expect(original.combine_formats['1']).toEqual('{Invoice number}')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should offer every matching algorithm except automatic', () => {
|
||||||
|
expect(component.matchingAlgorithms.map((a) => a.id)).not.toContain(
|
||||||
|
MATCH_AUTO
|
||||||
|
)
|
||||||
|
expect(component.template.matching_algorithm).toEqual(MATCH_ANY)
|
||||||
|
expect(component.patternRequired).toBeTruthy()
|
||||||
|
|
||||||
|
component.template.matching_algorithm = MATCH_NONE
|
||||||
|
expect(component.patternRequired).toBeFalsy()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should initialize new template permissions from saved defaults', () => {
|
||||||
|
const defaults = {
|
||||||
|
[SETTINGS_KEYS.DEFAULT_PERMS_OWNER]: 1,
|
||||||
|
[SETTINGS_KEYS.DEFAULT_PERMS_VIEW_USERS]: [2],
|
||||||
|
[SETTINGS_KEYS.DEFAULT_PERMS_VIEW_GROUPS]: [3],
|
||||||
|
[SETTINGS_KEYS.DEFAULT_PERMS_EDIT_USERS]: [],
|
||||||
|
[SETTINGS_KEYS.DEFAULT_PERMS_EDIT_GROUPS]: [4],
|
||||||
|
}
|
||||||
|
jest
|
||||||
|
.spyOn(TestBed.inject(SettingsService), 'get')
|
||||||
|
.mockImplementation((key) => defaults[key])
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(component.permissionsForm).toEqual({
|
||||||
|
owner: 1,
|
||||||
|
set_permissions: {
|
||||||
|
view: { users: [2], groups: [3] },
|
||||||
|
change: { users: [], groups: [4] },
|
||||||
|
},
|
||||||
|
})
|
||||||
|
expect(
|
||||||
|
fixture.debugElement.query(By.directive(PermissionsFormComponent))
|
||||||
|
).toBeTruthy()
|
||||||
|
expect(component.isDirty).toBe(false)
|
||||||
|
const create = jest
|
||||||
|
.spyOn(templateService, 'create')
|
||||||
|
.mockReturnValue(of({ ...component.template, id: 3 }))
|
||||||
|
component.save()
|
||||||
|
expect(create).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining(component.permissionsForm)
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should copy existing permissions and track changes without mutating the list item', () => {
|
||||||
|
component.object = {
|
||||||
|
...component.template,
|
||||||
|
id: 3,
|
||||||
|
owner: 1,
|
||||||
|
permissions: {
|
||||||
|
view: { users: [2], groups: [] },
|
||||||
|
change: { users: [], groups: [3] },
|
||||||
|
},
|
||||||
|
}
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(component.permissionsForm.owner).toBe(1)
|
||||||
|
expect(component.isDirty).toBe(false)
|
||||||
|
component.permissionsForm.set_permissions.view.users.push(4)
|
||||||
|
expect(component.isDirty).toBe(true)
|
||||||
|
expect(component.object.permissions.view.users).toEqual([2])
|
||||||
|
const update = jest
|
||||||
|
.spyOn(templateService, 'update')
|
||||||
|
.mockReturnValue(of(component.template))
|
||||||
|
component.save()
|
||||||
|
expect(update).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
owner: 1,
|
||||||
|
set_permissions: {
|
||||||
|
view: { users: [2, 4], groups: [] },
|
||||||
|
change: { users: [], groups: [3] },
|
||||||
|
},
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should hide sharing controls and omit permission changes for a shared editor', () => {
|
||||||
|
component.object = {
|
||||||
|
...component.template,
|
||||||
|
id: 3,
|
||||||
|
owner: 2,
|
||||||
|
user_can_change: true,
|
||||||
|
}
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(
|
||||||
|
fixture.debugElement.query(By.directive(PermissionsFormComponent))
|
||||||
|
).toBeNull()
|
||||||
|
component.permissionsForm = {
|
||||||
|
owner: 1,
|
||||||
|
set_permissions: { view: { users: [1] } },
|
||||||
|
}
|
||||||
|
const update = jest
|
||||||
|
.spyOn(templateService, 'update')
|
||||||
|
.mockReturnValue(of(component.template))
|
||||||
|
component.save()
|
||||||
|
expect(update.mock.calls[0][0].owner).toBe(2)
|
||||||
|
expect(update.mock.calls[0][0]).not.toHaveProperty('set_permissions')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should keep only the last picked sample document', () => {
|
||||||
|
component.setSampleDocument([5, 6])
|
||||||
|
expect(component.sampleDocumentIds).toEqual([6])
|
||||||
|
|
||||||
|
component.setSampleDocument([])
|
||||||
|
expect(component.previewDocId).toBeNull()
|
||||||
|
expect(component.pageImageUrl).toBeNull()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should ignore a stale sample document response', () => {
|
||||||
|
const pending = new Subject<Document>()
|
||||||
|
jest.spyOn(documentService, 'get').mockReturnValueOnce(pending)
|
||||||
|
component.setSampleDocument([5])
|
||||||
|
component.setSampleDocument([6])
|
||||||
|
pending.next({ id: 5, page_count: 99 })
|
||||||
|
|
||||||
|
expect(component.previewPageCount()).toEqual(3)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should show a failed page and retry it', () => {
|
||||||
|
jest
|
||||||
|
.spyOn(documentService, 'get')
|
||||||
|
.mockReturnValueOnce(throwError(() => new Error('offline')))
|
||||||
|
component.setSampleDocument([5])
|
||||||
|
expect(component.pageFailed()).toBeTruthy()
|
||||||
|
|
||||||
|
component.setSampleDocument(component.sampleDocumentIds)
|
||||||
|
expect(component.pageFailed()).toBeFalsy()
|
||||||
|
|
||||||
|
component.onImageError()
|
||||||
|
expect(component.pageFailed()).toBeTruthy()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should support create and update', () => {
|
||||||
|
const createSpy = jest
|
||||||
|
.spyOn(templateService, 'create')
|
||||||
|
.mockReturnValue(of({ ...component.template, id: 3 }))
|
||||||
|
const updateSpy = jest
|
||||||
|
.spyOn(templateService, 'update')
|
||||||
|
.mockReturnValue(of(component.template))
|
||||||
|
const succeededSpy = jest.spyOn(component.succeeded, 'emit')
|
||||||
|
|
||||||
|
component.save()
|
||||||
|
expect(createSpy).toHaveBeenCalled()
|
||||||
|
expect(succeededSpy).toHaveBeenCalledWith({ ...component.template, id: 3 })
|
||||||
|
expect(activeModal.close).toHaveBeenCalled()
|
||||||
|
|
||||||
|
component.saving.set(false)
|
||||||
|
component.template.id = 3
|
||||||
|
component.save()
|
||||||
|
expect(updateSpy).toHaveBeenCalledWith(component.template)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should emit failed and allow editing again after a failed save', () => {
|
||||||
|
prepareOverlay()
|
||||||
|
component.template.zones = [zone()]
|
||||||
|
const pending = new Subject<OcrTemplate>()
|
||||||
|
jest.spyOn(templateService, 'create').mockReturnValue(pending)
|
||||||
|
const failedSpy = jest.spyOn(component.failed, 'emit')
|
||||||
|
component.onOverlayPointerDown(pointer(150, 150))
|
||||||
|
|
||||||
|
component.save()
|
||||||
|
component.save()
|
||||||
|
expect(templateService.create).toHaveBeenCalledTimes(1)
|
||||||
|
component.onOverlayPointerMove(pointer(250, 250))
|
||||||
|
component.onOverlayPointerUp(pointer(250, 250))
|
||||||
|
expect(component.template.zones[0].x).toEqual(100)
|
||||||
|
|
||||||
|
pending.error(new Error('Save failed'))
|
||||||
|
expect(failedSpy).toHaveBeenCalled()
|
||||||
|
expect(component.saving()).toBeFalsy()
|
||||||
|
component.onOverlayPointerDown(pointer(150, 150))
|
||||||
|
component.onOverlayPointerUp(pointer(250, 250))
|
||||||
|
expect(component.template.zones[0].x).toEqual(200)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should track unsaved changes', () => {
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(component.isDirty).toBeFalsy()
|
||||||
|
|
||||||
|
component.template.combine_formats = { '1': '' }
|
||||||
|
expect(component.isDirty).toBeFalsy()
|
||||||
|
|
||||||
|
component.template.name = 'Invoices'
|
||||||
|
expect(component.isDirty).toBeTruthy()
|
||||||
|
component.template.name = ''
|
||||||
|
expect(component.isDirty).toBeFalsy()
|
||||||
|
|
||||||
|
component.setSampleDocument([5])
|
||||||
|
expect(component.isDirty).toBeTruthy()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should draw a zone with no field in empty space', () => {
|
||||||
|
prepareOverlay()
|
||||||
|
component.onOverlayPointerDown(pointer(100, 100))
|
||||||
|
component.onOverlayPointerUp(pointer(1200, 250))
|
||||||
|
|
||||||
|
expect(component.template.zones[0]).toMatchObject({
|
||||||
|
x: 100,
|
||||||
|
y: 100,
|
||||||
|
width: 900,
|
||||||
|
height: 150,
|
||||||
|
custom_field: null,
|
||||||
|
})
|
||||||
|
expect(component.selectedZoneIndex).toEqual(0)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should clear the selection on a click in empty space', () => {
|
||||||
|
prepareOverlay()
|
||||||
|
component.template.zones = [zone()]
|
||||||
|
component.selectZone(0)
|
||||||
|
component.onOverlayPointerDown(pointer(600, 600))
|
||||||
|
component.onOverlayPointerUp(pointer(602, 601))
|
||||||
|
|
||||||
|
expect(component.template.zones).toHaveLength(1)
|
||||||
|
expect(component.selectedZoneIndex).toBeNull()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should move a zone when dragging on it', () => {
|
||||||
|
prepareOverlay()
|
||||||
|
component.template.zones = [zone()]
|
||||||
|
component.onOverlayPointerDown(pointer(150, 150))
|
||||||
|
component.onOverlayPointerUp(pointer(250, 200))
|
||||||
|
|
||||||
|
expect(component.template.zones).toHaveLength(1)
|
||||||
|
expect(component.template.zones[0]).toMatchObject({ x: 200, y: 150 })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should cancel a drawing on escape and ignore other pointers', () => {
|
||||||
|
prepareOverlay()
|
||||||
|
component.onOverlayPointerDown(pointer(100, 100))
|
||||||
|
component.onOverlayPointerUp(pointer(300, 200, 2))
|
||||||
|
expect(component.drawingRect()).not.toBeNull()
|
||||||
|
|
||||||
|
component.cancelDrawing()
|
||||||
|
component.onOverlayPointerUp(pointer(300, 200))
|
||||||
|
expect(component.template.zones).toEqual([])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should open a zone in the zones tab and go back to the list', () => {
|
||||||
|
component.template.zones = [zone(), zone()]
|
||||||
|
component.selectZone(1)
|
||||||
|
expect(component.activeTab).toEqual('zones')
|
||||||
|
expect(component.selectedZone).toBe(component.template.zones[1])
|
||||||
|
|
||||||
|
component.deselectZone()
|
||||||
|
expect(component.selectedZone).toBeNull()
|
||||||
|
|
||||||
|
component.selectZone(0)
|
||||||
|
component.removeZone(0)
|
||||||
|
expect(component.template.zones).toHaveLength(1)
|
||||||
|
expect(component.selectedZone).toBeNull()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should only offer custom fields OCR can write to', () => {
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(component.fieldItems().map((item) => item.id)).toEqual([
|
||||||
|
OcrZoneTarget.Title,
|
||||||
|
OcrZoneTarget.Asn,
|
||||||
|
OcrZoneTarget.Created,
|
||||||
|
1,
|
||||||
|
])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should create a custom field and assign it to the zone', () => {
|
||||||
|
const succeeded = new Subject<CustomField>()
|
||||||
|
const dialog = {
|
||||||
|
dialogMode: { set: jest.fn() },
|
||||||
|
object: null,
|
||||||
|
succeeded,
|
||||||
|
failed: new Subject(),
|
||||||
|
}
|
||||||
|
jest
|
||||||
|
.spyOn(modalService, 'open')
|
||||||
|
.mockReturnValue({ componentInstance: dialog } as any)
|
||||||
|
component.template.zones = [zone({ custom_field: null })]
|
||||||
|
component.selectZone(0)
|
||||||
|
|
||||||
|
component.createField()
|
||||||
|
expect(dialog.object).toEqual({ name: 'Invoice number' })
|
||||||
|
succeeded.next(customFields[0])
|
||||||
|
|
||||||
|
expect(component.template.zones[0].custom_field).toEqual(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should build and prune combine formats', () => {
|
||||||
|
const first = zone({ name: 'First' })
|
||||||
|
const second = zone({ name: 'Second' })
|
||||||
|
const other = zone({ name: 'Other', custom_field: 2 })
|
||||||
|
component.template.zones = [first, second, other]
|
||||||
|
component.template.combine_formats = { '2': '{Other}' }
|
||||||
|
|
||||||
|
expect(component.isFieldShared(first)).toBeTruthy()
|
||||||
|
expect(component.isFieldShared(other)).toBeFalsy()
|
||||||
|
expect(component.defaultCombineFormat(first)).toEqual('{First} {Second}')
|
||||||
|
|
||||||
|
component.insertCombineToken(first, second)
|
||||||
|
component.insertCombineToken(first, first)
|
||||||
|
expect(component.getCombineFormat(second)).toEqual('{Second} {First}')
|
||||||
|
|
||||||
|
jest.spyOn(templateService, 'create').mockReturnValue(of(null))
|
||||||
|
component.save()
|
||||||
|
expect(component.template.combine_formats).toEqual({
|
||||||
|
'1': '{Second} {First}',
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should update exact tokens when a zone is renamed', () => {
|
||||||
|
const first = zone({ name: 'First [value]' })
|
||||||
|
component.template.zones = [first, zone({ name: 'Second' })]
|
||||||
|
component.template.combine_formats = {
|
||||||
|
'1': 'First [value]: {First [value]} / { First [value] } / {Second} / {First [value] extra}',
|
||||||
|
'2': '{First [value]}',
|
||||||
|
}
|
||||||
|
|
||||||
|
component.renameZone(first, '')
|
||||||
|
component.renameZone(first, 'Invoice number')
|
||||||
|
|
||||||
|
expect(first.name).toEqual('Invoice number')
|
||||||
|
expect(component.template.combine_formats).toEqual({
|
||||||
|
'1': 'First [value]: {Invoice number} / {Invoice number} / {Second} / {First [value] extra}',
|
||||||
|
'2': '{First [value]}',
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should keep the language array stable until the value changes', () => {
|
||||||
|
const selected = zone({ ocr_language: 'deu+eng' })
|
||||||
|
const languages = component.ocrLanguageArray(selected)
|
||||||
|
expect(languages).toEqual(['deu', 'eng'])
|
||||||
|
expect(component.ocrLanguageArray(selected)).toBe(languages)
|
||||||
|
|
||||||
|
component.setOcrLanguages(selected, ['fra'])
|
||||||
|
expect(selected.ocr_language).toEqual('fra')
|
||||||
|
expect(component.ocrLanguageArray(selected)).toEqual(['fra'])
|
||||||
|
|
||||||
|
component.setOcrLanguages(selected, null)
|
||||||
|
expect(component.ocrLanguageArray(selected)).toEqual([])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should hide a test result once the zone changes', () => {
|
||||||
|
const selected = zone()
|
||||||
|
component.template.zones = [selected]
|
||||||
|
component.selectZone(0)
|
||||||
|
component.setSampleDocument([5])
|
||||||
|
jest
|
||||||
|
.spyOn(templateService, 'testZone')
|
||||||
|
.mockReturnValue(of({ value: '123' }))
|
||||||
|
|
||||||
|
component.testZone()
|
||||||
|
expect(component.zoneTestResult.value).toEqual('123')
|
||||||
|
|
||||||
|
selected.transform = OcrZoneTransform.Numeric
|
||||||
|
expect(component.zoneTestResult).toBeNull()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should drop a pending test when the zone or sample document changes', () => {
|
||||||
|
const pending = new Subject<OcrZoneTestResult>()
|
||||||
|
component.template.zones = [zone(), zone()]
|
||||||
|
component.selectZone(0)
|
||||||
|
component.setSampleDocument([5])
|
||||||
|
jest.spyOn(templateService, 'testZone').mockReturnValue(pending)
|
||||||
|
|
||||||
|
component.testZone()
|
||||||
|
expect(component.zoneTesting).toBeTruthy()
|
||||||
|
component.selectZone(1)
|
||||||
|
pending.next({ value: 'Old zone' })
|
||||||
|
expect(component.zoneTestResult).toBeNull()
|
||||||
|
|
||||||
|
component.testZone()
|
||||||
|
component.setSampleDocument([])
|
||||||
|
pending.next({ value: 'Old document' })
|
||||||
|
expect(component.zoneTestResult).toBeNull()
|
||||||
|
})
|
||||||
|
})
|
||||||
+963
@@ -0,0 +1,963 @@
|
|||||||
|
import { CommonModule } from '@angular/common'
|
||||||
|
import {
|
||||||
|
Component,
|
||||||
|
computed,
|
||||||
|
ElementRef,
|
||||||
|
EventEmitter,
|
||||||
|
HostListener,
|
||||||
|
inject,
|
||||||
|
Input,
|
||||||
|
OnDestroy,
|
||||||
|
OnInit,
|
||||||
|
Output,
|
||||||
|
signal,
|
||||||
|
ViewChild,
|
||||||
|
} from '@angular/core'
|
||||||
|
import { FormsModule } from '@angular/forms'
|
||||||
|
import {
|
||||||
|
NgbActiveModal,
|
||||||
|
NgbModal,
|
||||||
|
NgbNavModule,
|
||||||
|
} from '@ng-bootstrap/ng-bootstrap'
|
||||||
|
import { BootstrapIconComponent } from 'src/app/components/common/bootstrap-icon/bootstrap-icon.component'
|
||||||
|
import { Subject, takeUntil } from 'rxjs'
|
||||||
|
import { CustomFieldEditDialogComponent } from 'src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component'
|
||||||
|
import { EditDialogMode } from 'src/app/components/common/edit-dialog/edit-dialog.component'
|
||||||
|
import { DocumentLinkComponent } from 'src/app/components/common/input/document-link/document-link.component'
|
||||||
|
import { CheckComponent } from 'src/app/components/common/input/check/check.component'
|
||||||
|
import { NumberComponent } from 'src/app/components/common/input/number/number.component'
|
||||||
|
import {
|
||||||
|
PermissionsFormComponent,
|
||||||
|
PermissionsFormObject,
|
||||||
|
} from 'src/app/components/common/input/permissions/permissions-form/permissions-form.component'
|
||||||
|
import { SelectComponent } from 'src/app/components/common/input/select/select.component'
|
||||||
|
import { SwitchComponent } from 'src/app/components/common/input/switch/switch.component'
|
||||||
|
import { TextComponent } from 'src/app/components/common/input/text/text.component'
|
||||||
|
import { CustomField } from 'src/app/data/custom-field'
|
||||||
|
import {
|
||||||
|
MATCH_ANY,
|
||||||
|
MATCH_AUTO,
|
||||||
|
MATCH_NONE,
|
||||||
|
MATCHING_ALGORITHMS,
|
||||||
|
} from 'src/app/data/matching-model'
|
||||||
|
import {
|
||||||
|
DEFAULT_OCR_ZONE_LANGUAGE,
|
||||||
|
getZoneFieldKey,
|
||||||
|
OCR_BUILTIN_TARGETS,
|
||||||
|
OCR_SUPPORTED_FIELD_TYPES,
|
||||||
|
OcrTemplate,
|
||||||
|
OcrTemplateZone,
|
||||||
|
OcrZoneTarget,
|
||||||
|
OcrZoneTestResult,
|
||||||
|
OcrZoneTransform,
|
||||||
|
ZoneTestRequest,
|
||||||
|
} from 'src/app/data/ocr-template'
|
||||||
|
import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
|
||||||
|
import { User } from 'src/app/data/user'
|
||||||
|
import { IfOwnerDirective } from 'src/app/directives/if-owner.directive'
|
||||||
|
import { PermissionsService } from 'src/app/services/permissions.service'
|
||||||
|
import { CustomFieldsService } from 'src/app/services/rest/custom-fields.service'
|
||||||
|
import { DocumentService } from 'src/app/services/rest/document.service'
|
||||||
|
import { OcrTemplateService } from 'src/app/services/rest/ocr-template.service'
|
||||||
|
import { UserService } from 'src/app/services/rest/user.service'
|
||||||
|
import { SettingsService } from 'src/app/services/settings.service'
|
||||||
|
import { ToastService } from 'src/app/services/toast.service'
|
||||||
|
import { OcrTemplateEditorZoneListComponent } from './ocr-template-editor-zone-list/ocr-template-editor-zone-list.component'
|
||||||
|
import {
|
||||||
|
DisplayRect,
|
||||||
|
DrawingRect,
|
||||||
|
findHandleAt,
|
||||||
|
findZoneAt,
|
||||||
|
getResizeHandles,
|
||||||
|
getZoneColor,
|
||||||
|
getZoneDisplayRect,
|
||||||
|
getZonePage,
|
||||||
|
HANDLE_SIZE,
|
||||||
|
isZoneOnPage,
|
||||||
|
MIN_ZONE_SIZE,
|
||||||
|
MoveStart,
|
||||||
|
moveZone,
|
||||||
|
Point,
|
||||||
|
ResizeHandle,
|
||||||
|
resizeZone,
|
||||||
|
} from './zone-geometry'
|
||||||
|
|
||||||
|
type ActiveTab = 'template' | 'zones'
|
||||||
|
type ZoneFieldSelection = OcrZoneTarget | number | null
|
||||||
|
type OverlayInteraction =
|
||||||
|
| { kind: 'idle' }
|
||||||
|
| { kind: 'drawing'; pointerId: number; rect: DrawingRect }
|
||||||
|
| { kind: 'moving'; pointerId: number; zoneIndex: number; start: MoveStart }
|
||||||
|
| {
|
||||||
|
kind: 'resizing'
|
||||||
|
pointerId: number
|
||||||
|
zoneIndex: number
|
||||||
|
handle: ResizeHandle
|
||||||
|
}
|
||||||
|
interface ZoneTest {
|
||||||
|
zone: OcrTemplateZone
|
||||||
|
/** The sample document and zone settings the result was produced from. */
|
||||||
|
key: string
|
||||||
|
result: OcrZoneTestResult | null
|
||||||
|
}
|
||||||
|
|
||||||
|
export const ZONE_TRANSFORM_OPTIONS = [
|
||||||
|
{ id: OcrZoneTransform.None, name: $localize`None` },
|
||||||
|
{ id: OcrZoneTransform.Strip, name: $localize`Strip whitespace` },
|
||||||
|
{ id: OcrZoneTransform.Uppercase, name: $localize`Uppercase` },
|
||||||
|
{ id: OcrZoneTransform.Lowercase, name: $localize`Lowercase` },
|
||||||
|
{ id: OcrZoneTransform.Numeric, name: $localize`Numeric only` },
|
||||||
|
{
|
||||||
|
id: OcrZoneTransform.StripPunctuation,
|
||||||
|
name: $localize`Remove leading/trailing punctuation`,
|
||||||
|
},
|
||||||
|
{ id: OcrZoneTransform.Date, name: $localize`Parse date` },
|
||||||
|
{ id: OcrZoneTransform.QrCode, name: $localize`Read QR/barcode` },
|
||||||
|
]
|
||||||
|
|
||||||
|
export const ZONE_LANGUAGE_OPTIONS = [
|
||||||
|
{ id: 'eng', name: $localize`English` },
|
||||||
|
{ id: 'deu', name: $localize`German` },
|
||||||
|
{ id: 'fra', name: $localize`French` },
|
||||||
|
{ id: 'ita', name: $localize`Italian` },
|
||||||
|
{ id: 'spa', name: $localize`Spanish` },
|
||||||
|
{ id: 'por', name: $localize`Portuguese` },
|
||||||
|
{ id: 'nld', name: $localize`Dutch` },
|
||||||
|
]
|
||||||
|
|
||||||
|
const TEMPLATE_MATCHING_ALGORITHMS = MATCHING_ALGORITHMS.filter(
|
||||||
|
(algorithm) => algorithm.id !== MATCH_AUTO
|
||||||
|
)
|
||||||
|
|
||||||
|
const NO_OVERLAY_INTERACTION: OverlayInteraction = { kind: 'idle' }
|
||||||
|
const RESIZE_CURSOR: Record<ResizeHandle, string> = {
|
||||||
|
nw: 'nw-resize',
|
||||||
|
ne: 'ne-resize',
|
||||||
|
sw: 'sw-resize',
|
||||||
|
se: 'se-resize',
|
||||||
|
n: 'n-resize',
|
||||||
|
s: 's-resize',
|
||||||
|
w: 'w-resize',
|
||||||
|
e: 'e-resize',
|
||||||
|
}
|
||||||
|
|
||||||
|
@Component({
|
||||||
|
selector: 'pngx-ocr-template-editor',
|
||||||
|
imports: [
|
||||||
|
DocumentLinkComponent,
|
||||||
|
NumberComponent,
|
||||||
|
TextComponent,
|
||||||
|
CheckComponent,
|
||||||
|
SelectComponent,
|
||||||
|
SwitchComponent,
|
||||||
|
CommonModule,
|
||||||
|
FormsModule,
|
||||||
|
NgbNavModule,
|
||||||
|
BootstrapIconComponent,
|
||||||
|
OcrTemplateEditorZoneListComponent,
|
||||||
|
PermissionsFormComponent,
|
||||||
|
IfOwnerDirective,
|
||||||
|
],
|
||||||
|
templateUrl: './ocr-template-editor.component.html',
|
||||||
|
styleUrls: ['./ocr-template-editor.component.scss'],
|
||||||
|
})
|
||||||
|
export class OcrTemplateEditorComponent implements OnInit, OnDestroy {
|
||||||
|
public readonly activeModal = inject(NgbActiveModal)
|
||||||
|
private readonly templateService = inject(OcrTemplateService)
|
||||||
|
private readonly customFieldsService = inject(CustomFieldsService)
|
||||||
|
private readonly documentService = inject(DocumentService)
|
||||||
|
private readonly toastService = inject(ToastService)
|
||||||
|
private readonly modalService = inject(NgbModal)
|
||||||
|
private readonly userService = inject(UserService)
|
||||||
|
private readonly settingsService = inject(SettingsService)
|
||||||
|
private readonly permissionsService = inject(PermissionsService)
|
||||||
|
private readonly destroy$ = new Subject<void>()
|
||||||
|
private readonly cancelZoneTest$ = new Subject<void>()
|
||||||
|
|
||||||
|
@Input() object: OcrTemplate
|
||||||
|
@Output() public readonly succeeded = new EventEmitter<OcrTemplate>()
|
||||||
|
@Output() public readonly failed = new EventEmitter()
|
||||||
|
|
||||||
|
@ViewChild('zoneOverlay') overlayRef: ElementRef<SVGSVGElement>
|
||||||
|
imageRef: ElementRef<HTMLImageElement>
|
||||||
|
private previewResizeObserver: ResizeObserver | null = null
|
||||||
|
private readonly overlayScale = signal(1)
|
||||||
|
|
||||||
|
@ViewChild('pageImage')
|
||||||
|
set pageImage(ref: ElementRef<HTMLImageElement> | undefined) {
|
||||||
|
this.previewResizeObserver?.disconnect()
|
||||||
|
this.imageRef = ref
|
||||||
|
if (!ref) return
|
||||||
|
this.previewResizeObserver = new ResizeObserver(() => {
|
||||||
|
const image = ref.nativeElement
|
||||||
|
if (image.naturalWidth && image.clientWidth) {
|
||||||
|
this.overlayScale.set(image.naturalWidth / image.clientWidth)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
this.previewResizeObserver.observe(ref.nativeElement)
|
||||||
|
}
|
||||||
|
|
||||||
|
template: OcrTemplate = {
|
||||||
|
id: null,
|
||||||
|
name: '',
|
||||||
|
match: '',
|
||||||
|
matching_algorithm: MATCH_ANY,
|
||||||
|
is_insensitive: true,
|
||||||
|
sample_document: null,
|
||||||
|
source_width: 0,
|
||||||
|
source_height: 0,
|
||||||
|
enabled: true,
|
||||||
|
combine_formats: {},
|
||||||
|
zones: [],
|
||||||
|
}
|
||||||
|
|
||||||
|
public readonly customFields = signal<CustomField[]>([])
|
||||||
|
public readonly fieldItems = computed<
|
||||||
|
{ id: ZoneFieldSelection; name: string }[]
|
||||||
|
>(() => [
|
||||||
|
...OCR_BUILTIN_TARGETS,
|
||||||
|
...this.customFields()
|
||||||
|
.filter((field) => OCR_SUPPORTED_FIELD_TYPES.includes(field.data_type))
|
||||||
|
.map((field) => ({ id: field.id, name: field.name })),
|
||||||
|
])
|
||||||
|
public readonly users = signal<User[]>([])
|
||||||
|
permissionsForm: PermissionsFormObject = {}
|
||||||
|
public readonly OcrZoneTransform = OcrZoneTransform
|
||||||
|
public readonly saving = signal(false)
|
||||||
|
|
||||||
|
/** Bound to the document picker, which works with id arrays. */
|
||||||
|
sampleDocumentIds: number[] = []
|
||||||
|
previewPage = 0
|
||||||
|
public readonly previewPageCount = signal<number | null>(null)
|
||||||
|
public readonly pageLoaded = signal(false)
|
||||||
|
public readonly pageFailed = signal(false)
|
||||||
|
zoom = 1
|
||||||
|
|
||||||
|
get previewDocId(): number | null {
|
||||||
|
return this.sampleDocumentIds[0] ?? null
|
||||||
|
}
|
||||||
|
|
||||||
|
get pageImageUrl(): string | null {
|
||||||
|
return this.previewDocId
|
||||||
|
? this.templateService.getPageImageUrl(
|
||||||
|
this.previewDocId,
|
||||||
|
this.previewPage
|
||||||
|
)
|
||||||
|
: null
|
||||||
|
}
|
||||||
|
|
||||||
|
get transformOptions() {
|
||||||
|
return ZONE_TRANSFORM_OPTIONS
|
||||||
|
}
|
||||||
|
|
||||||
|
get languageOptions() {
|
||||||
|
return ZONE_LANGUAGE_OPTIONS
|
||||||
|
}
|
||||||
|
|
||||||
|
get matchingAlgorithms() {
|
||||||
|
return TEMPLATE_MATCHING_ALGORITHMS
|
||||||
|
}
|
||||||
|
|
||||||
|
get patternRequired(): boolean {
|
||||||
|
return (
|
||||||
|
this.template.matching_algorithm !== MATCH_AUTO &&
|
||||||
|
this.template.matching_algorithm !== MATCH_NONE
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
public get previewPageDisplay(): number {
|
||||||
|
return this.previewPage + 1
|
||||||
|
}
|
||||||
|
|
||||||
|
public set previewPageDisplay(value: number) {
|
||||||
|
this.goToPage(value - 1)
|
||||||
|
}
|
||||||
|
|
||||||
|
activeTab: ActiveTab = 'template'
|
||||||
|
|
||||||
|
selectedZoneIndex: number | null = null
|
||||||
|
private overlayInteraction: OverlayInteraction = NO_OVERLAY_INTERACTION
|
||||||
|
overlayCursor = 'crosshair'
|
||||||
|
|
||||||
|
private readonly zoneTest = signal<ZoneTest | null>(null)
|
||||||
|
|
||||||
|
get zoneTestResult(): OcrZoneTestResult | null {
|
||||||
|
return this.isCurrentZoneTest() ? this.zoneTest().result : null
|
||||||
|
}
|
||||||
|
|
||||||
|
get zoneTesting(): boolean {
|
||||||
|
return this.isCurrentZoneTest() && this.zoneTest().result === null
|
||||||
|
}
|
||||||
|
|
||||||
|
get selectedZone(): OcrTemplateZone | null {
|
||||||
|
return this.selectedZoneIndex !== null
|
||||||
|
? (this.template.zones[this.selectedZoneIndex] ?? null)
|
||||||
|
: null
|
||||||
|
}
|
||||||
|
|
||||||
|
private initialState = ''
|
||||||
|
|
||||||
|
get isDirty(): boolean {
|
||||||
|
return this.editorState() !== this.initialState
|
||||||
|
}
|
||||||
|
|
||||||
|
private editorState(): string {
|
||||||
|
const formats = Object.entries(this.template.combine_formats ?? {}).filter(
|
||||||
|
([, format]) => format
|
||||||
|
)
|
||||||
|
return JSON.stringify({
|
||||||
|
...this.template,
|
||||||
|
combine_formats: Object.fromEntries(formats),
|
||||||
|
sample_document: this.previewDocId ?? null,
|
||||||
|
permissions_form: this.permissionsForm,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
get dialogTitle(): string {
|
||||||
|
return this.template.id
|
||||||
|
? $localize`Edit OCR Template`
|
||||||
|
: $localize`New OCR Template`
|
||||||
|
}
|
||||||
|
|
||||||
|
ngOnInit() {
|
||||||
|
this.userService
|
||||||
|
.listAll()
|
||||||
|
.pipe(takeUntil(this.destroy$))
|
||||||
|
.subscribe((r) => this.users.set(r.results))
|
||||||
|
this.customFieldsService
|
||||||
|
.listAll()
|
||||||
|
.pipe(takeUntil(this.destroy$))
|
||||||
|
.subscribe((r) => {
|
||||||
|
this.customFields.set(r.results)
|
||||||
|
})
|
||||||
|
|
||||||
|
if (this.object) {
|
||||||
|
this.template = {
|
||||||
|
...this.object,
|
||||||
|
zones: this.object.zones.map((zone) => ({ ...zone })),
|
||||||
|
combine_formats: { ...this.object.combine_formats },
|
||||||
|
}
|
||||||
|
if (this.template.sample_document) {
|
||||||
|
this.setSampleDocument([this.template.sample_document])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const permissions = this.object?.permissions
|
||||||
|
this.permissionsForm = this.object
|
||||||
|
? {
|
||||||
|
owner: this.object.owner,
|
||||||
|
set_permissions: {
|
||||||
|
view: {
|
||||||
|
users: [...(permissions?.view.users ?? [])],
|
||||||
|
groups: [...(permissions?.view.groups ?? [])],
|
||||||
|
},
|
||||||
|
change: {
|
||||||
|
users: [...(permissions?.change.users ?? [])],
|
||||||
|
groups: [...(permissions?.change.groups ?? [])],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
: {
|
||||||
|
owner: this.settingsService.get(SETTINGS_KEYS.DEFAULT_PERMS_OWNER),
|
||||||
|
set_permissions: {
|
||||||
|
view: {
|
||||||
|
users: this.settingsService.get(
|
||||||
|
SETTINGS_KEYS.DEFAULT_PERMS_VIEW_USERS
|
||||||
|
),
|
||||||
|
groups: this.settingsService.get(
|
||||||
|
SETTINGS_KEYS.DEFAULT_PERMS_VIEW_GROUPS
|
||||||
|
),
|
||||||
|
},
|
||||||
|
change: {
|
||||||
|
users: this.settingsService.get(
|
||||||
|
SETTINGS_KEYS.DEFAULT_PERMS_EDIT_USERS
|
||||||
|
),
|
||||||
|
groups: this.settingsService.get(
|
||||||
|
SETTINGS_KEYS.DEFAULT_PERMS_EDIT_GROUPS
|
||||||
|
),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
this.initialState = this.editorState()
|
||||||
|
}
|
||||||
|
|
||||||
|
setSampleDocument(ids: number[]) {
|
||||||
|
const id = ids.at(-1)
|
||||||
|
this.sampleDocumentIds = id ? [id] : []
|
||||||
|
this.previewPage = 0
|
||||||
|
this.previewPageCount.set(null)
|
||||||
|
this.resetPage()
|
||||||
|
if (!id) return
|
||||||
|
this.documentService
|
||||||
|
.get(id)
|
||||||
|
.pipe(takeUntil(this.destroy$))
|
||||||
|
.subscribe({
|
||||||
|
next: (doc) => {
|
||||||
|
if (this.previewDocId !== id) return
|
||||||
|
this.previewPageCount.set(doc.page_count ?? null)
|
||||||
|
},
|
||||||
|
error: () => {
|
||||||
|
if (this.previewDocId === id) this.pageFailed.set(true)
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
private resetPage() {
|
||||||
|
this.stopOverlayInteraction()
|
||||||
|
this.clearZoneTest()
|
||||||
|
this.pageLoaded.set(false)
|
||||||
|
this.pageFailed.set(false)
|
||||||
|
}
|
||||||
|
|
||||||
|
goToPage(page: number) {
|
||||||
|
if (!Number.isFinite(page)) return
|
||||||
|
const pageCount = this.previewPageCount()
|
||||||
|
const max = pageCount ? pageCount - 1 : page
|
||||||
|
const clamped = Math.max(0, Math.min(Math.trunc(page), max))
|
||||||
|
if (clamped === this.previewPage) return
|
||||||
|
this.previewPage = clamped
|
||||||
|
this.resetPage()
|
||||||
|
}
|
||||||
|
|
||||||
|
zoomIn() {
|
||||||
|
this.zoom = Math.min(4, Math.round((this.zoom + 0.25) * 100) / 100)
|
||||||
|
}
|
||||||
|
|
||||||
|
zoomOut() {
|
||||||
|
this.zoom = Math.max(0.5, Math.round((this.zoom - 0.25) * 100) / 100)
|
||||||
|
}
|
||||||
|
|
||||||
|
resetZoom() {
|
||||||
|
this.zoom = 1
|
||||||
|
}
|
||||||
|
|
||||||
|
zonePage(zone: OcrTemplateZone): number {
|
||||||
|
return getZonePage(zone, this.previewPage, this.previewPageCount())
|
||||||
|
}
|
||||||
|
|
||||||
|
isLastPageZone(zone: OcrTemplateZone): boolean {
|
||||||
|
return zone.page === -1
|
||||||
|
}
|
||||||
|
|
||||||
|
setLastPageZone(zone: OcrTemplateZone, lastPage: boolean) {
|
||||||
|
zone.page = lastPage ? -1 : this.previewPage + 1
|
||||||
|
}
|
||||||
|
|
||||||
|
private isOnCurrentPage(zone: OcrTemplateZone): boolean {
|
||||||
|
return isZoneOnPage(zone, this.previewPage, this.previewPageCount())
|
||||||
|
}
|
||||||
|
|
||||||
|
onImageLoad() {
|
||||||
|
this.pageLoaded.set(true)
|
||||||
|
const img = this.imageRef.nativeElement
|
||||||
|
this.template.source_width = img.naturalWidth
|
||||||
|
this.template.source_height = img.naturalHeight
|
||||||
|
}
|
||||||
|
|
||||||
|
onImageError() {
|
||||||
|
this.stopOverlayInteraction()
|
||||||
|
this.pageFailed.set(true)
|
||||||
|
}
|
||||||
|
|
||||||
|
@HostListener('document:keydown.escape')
|
||||||
|
cancelDrawing() {
|
||||||
|
this.stopOverlayInteraction()
|
||||||
|
}
|
||||||
|
|
||||||
|
onOverlayPointerDown(event: PointerEvent) {
|
||||||
|
if (this.saving()) return
|
||||||
|
if (event.button !== 0 || this.overlayInteraction.kind !== 'idle') return
|
||||||
|
const point = this.svgPointFromEvent(event)
|
||||||
|
if (!this.pageLoaded() || !point) return
|
||||||
|
event.preventDefault()
|
||||||
|
|
||||||
|
if (this.selectedZoneIndex !== null) {
|
||||||
|
const handle = this.handleAt(point, this.selectedZoneIndex)
|
||||||
|
if (handle) {
|
||||||
|
this.overlayInteraction = {
|
||||||
|
kind: 'resizing',
|
||||||
|
pointerId: event.pointerId,
|
||||||
|
zoneIndex: this.selectedZoneIndex,
|
||||||
|
handle,
|
||||||
|
}
|
||||||
|
this.overlayRef.nativeElement.setPointerCapture(event.pointerId)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const clickedIdx = this.zoneIndexAt(point)
|
||||||
|
if (clickedIdx !== null) {
|
||||||
|
this.selectZone(clickedIdx)
|
||||||
|
const zone = this.template.zones[clickedIdx]
|
||||||
|
this.overlayInteraction = {
|
||||||
|
kind: 'moving',
|
||||||
|
pointerId: event.pointerId,
|
||||||
|
zoneIndex: clickedIdx,
|
||||||
|
start: {
|
||||||
|
mouseX: point.x,
|
||||||
|
mouseY: point.y,
|
||||||
|
zoneX: zone.x,
|
||||||
|
zoneY: zone.y,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
this.overlayRef.nativeElement.setPointerCapture(event.pointerId)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Empty space: start drawing a new zone. A click without a drag just clears
|
||||||
|
// the selection (see onOverlayPointerUp).
|
||||||
|
this.clearZoneTest()
|
||||||
|
this.selectedZoneIndex = null
|
||||||
|
this.overlayInteraction = {
|
||||||
|
kind: 'drawing',
|
||||||
|
pointerId: event.pointerId,
|
||||||
|
rect: {
|
||||||
|
startX: point.x,
|
||||||
|
startY: point.y,
|
||||||
|
endX: point.x,
|
||||||
|
endY: point.y,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
this.overlayRef.nativeElement.setPointerCapture(event.pointerId)
|
||||||
|
}
|
||||||
|
|
||||||
|
onOverlayPointerMove(event: PointerEvent) {
|
||||||
|
if (
|
||||||
|
this.overlayInteraction.kind !== 'idle' &&
|
||||||
|
this.overlayInteraction.pointerId !== event.pointerId
|
||||||
|
)
|
||||||
|
return
|
||||||
|
const point = this.svgPointFromEvent(event)
|
||||||
|
if (!point) return
|
||||||
|
|
||||||
|
if (this.overlayInteraction.kind === 'resizing') {
|
||||||
|
resizeZone(
|
||||||
|
this.template.zones[this.overlayInteraction.zoneIndex],
|
||||||
|
this.overlayInteraction.handle,
|
||||||
|
point,
|
||||||
|
this.imageNaturalSize()
|
||||||
|
)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if (this.overlayInteraction.kind === 'moving') {
|
||||||
|
moveZone(
|
||||||
|
this.template.zones[this.overlayInteraction.zoneIndex],
|
||||||
|
point,
|
||||||
|
this.overlayInteraction.start,
|
||||||
|
this.imageNaturalSize()
|
||||||
|
)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if (this.overlayInteraction.kind === 'drawing') {
|
||||||
|
this.overlayInteraction.rect.endX = point.x
|
||||||
|
this.overlayInteraction.rect.endY = point.y
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
this.updateOverlayCursor(point)
|
||||||
|
}
|
||||||
|
|
||||||
|
private updateOverlayCursor(point: Point) {
|
||||||
|
if (this.selectedZoneIndex !== null) {
|
||||||
|
const handle = this.handleAt(point, this.selectedZoneIndex)
|
||||||
|
if (handle) {
|
||||||
|
this.overlayCursor = RESIZE_CURSOR[handle]
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
this.overlayCursor = this.zoneIndexAt(point) !== null ? 'move' : 'crosshair'
|
||||||
|
}
|
||||||
|
|
||||||
|
onOverlayPointerUp(event: PointerEvent) {
|
||||||
|
if (this.overlayInteraction.kind === 'idle') return
|
||||||
|
if (this.overlayInteraction.pointerId !== event.pointerId) return
|
||||||
|
this.onOverlayPointerMove(event)
|
||||||
|
const interaction = this.overlayInteraction
|
||||||
|
this.stopOverlayInteraction()
|
||||||
|
if (interaction.kind !== 'drawing') return
|
||||||
|
|
||||||
|
const rect = this.sourceRectFromDrawing(interaction.rect)
|
||||||
|
|
||||||
|
// Ignore tiny accidental clicks.
|
||||||
|
if (rect.w < MIN_ZONE_SIZE || rect.h < MIN_ZONE_SIZE) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
this.template.zones.push(this.createZoneFromRect(rect))
|
||||||
|
this.selectZone(this.template.zones.length - 1)
|
||||||
|
}
|
||||||
|
|
||||||
|
private createZoneFromRect(rect: DisplayRect): OcrTemplateZone {
|
||||||
|
const imageSize = this.imageNaturalSize()
|
||||||
|
return {
|
||||||
|
name: `Zone ${this.template.zones.length + 1}`,
|
||||||
|
target: OcrZoneTarget.CustomField,
|
||||||
|
custom_field: null,
|
||||||
|
x: rect.x,
|
||||||
|
y: rect.y,
|
||||||
|
width: rect.w,
|
||||||
|
height: rect.h,
|
||||||
|
page: this.previewPageDisplay,
|
||||||
|
ocr_language: DEFAULT_OCR_ZONE_LANGUAGE,
|
||||||
|
transform: OcrZoneTransform.Strip,
|
||||||
|
date_format: '',
|
||||||
|
validation_regex: '',
|
||||||
|
order: this.template.zones.length,
|
||||||
|
zone_source_width: imageSize.width,
|
||||||
|
zone_source_height: imageSize.height,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
onOverlayPointerCancel(event: PointerEvent) {
|
||||||
|
if (this.overlayInteraction.kind === 'idle') return
|
||||||
|
if (this.overlayInteraction.pointerId !== event.pointerId) return
|
||||||
|
this.stopOverlayInteraction()
|
||||||
|
}
|
||||||
|
|
||||||
|
private stopOverlayInteraction() {
|
||||||
|
const interaction = this.overlayInteraction
|
||||||
|
this.overlayInteraction = NO_OVERLAY_INTERACTION
|
||||||
|
this.overlayCursor = 'crosshair'
|
||||||
|
const overlay = this.overlayRef?.nativeElement
|
||||||
|
if (
|
||||||
|
interaction.kind !== 'idle' &&
|
||||||
|
overlay?.hasPointerCapture(interaction.pointerId)
|
||||||
|
) {
|
||||||
|
overlay.releasePointerCapture(interaction.pointerId)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
drawingRect(): DisplayRect | null {
|
||||||
|
return this.overlayInteraction.kind === 'drawing'
|
||||||
|
? this.displayRectFromDrawing(this.overlayInteraction.rect)
|
||||||
|
: null
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The zone's rectangle on the overlay, or null if it's on another page. */
|
||||||
|
zoneDisplayRect(zoneIndex: number): DisplayRect | null {
|
||||||
|
const zone = this.template.zones[zoneIndex]
|
||||||
|
if (!this.isOnCurrentPage(zone)) return null
|
||||||
|
return getZoneDisplayRect(zone, this.imageNaturalSize())
|
||||||
|
}
|
||||||
|
|
||||||
|
private handleAt(point: Point, zoneIndex: number): ResizeHandle | null {
|
||||||
|
const rect = this.zoneDisplayRect(zoneIndex)
|
||||||
|
return rect ? findHandleAt(point, rect, this.overlayHandleSize()) : null
|
||||||
|
}
|
||||||
|
|
||||||
|
private zoneIndexAt(point: Point): number | null {
|
||||||
|
return findZoneAt(
|
||||||
|
point,
|
||||||
|
this.template.zones,
|
||||||
|
this.previewPage,
|
||||||
|
this.previewPageCount(),
|
||||||
|
this.imageNaturalSize()
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
overlayViewBox(): string {
|
||||||
|
const imageSize = this.imageNaturalSize()
|
||||||
|
return `0 0 ${imageSize.width} ${imageSize.height}`
|
||||||
|
}
|
||||||
|
|
||||||
|
public readonly zoneColor = getZoneColor
|
||||||
|
|
||||||
|
zoneLabel(zone: OcrTemplateZone, index: number): string {
|
||||||
|
return zone.name || `Zone ${index + 1}`
|
||||||
|
}
|
||||||
|
|
||||||
|
zoneLabelY(rect: DisplayRect): number {
|
||||||
|
return Math.max(this.overlayUnitSize(14), rect.y - this.overlayUnitSize(4))
|
||||||
|
}
|
||||||
|
|
||||||
|
public readonly resizeHandles = getResizeHandles
|
||||||
|
|
||||||
|
overlayHandleSize(): number {
|
||||||
|
return this.overlayUnitSize(HANDLE_SIZE)
|
||||||
|
}
|
||||||
|
|
||||||
|
overlayFontSize(): number {
|
||||||
|
return this.overlayUnitSize(12)
|
||||||
|
}
|
||||||
|
|
||||||
|
overlayUnitSize(screenPixels: number): number {
|
||||||
|
return screenPixels * this.overlayScale()
|
||||||
|
}
|
||||||
|
|
||||||
|
private svgPointFromEvent(event: MouseEvent): Point | null {
|
||||||
|
const svg = this.overlayRef?.nativeElement
|
||||||
|
const matrix = svg?.getScreenCTM()
|
||||||
|
if (!svg || !matrix) return null
|
||||||
|
|
||||||
|
const point = svg.createSVGPoint()
|
||||||
|
point.x = event.clientX
|
||||||
|
point.y = event.clientY
|
||||||
|
|
||||||
|
const svgPoint = point.matrixTransform(matrix.inverse())
|
||||||
|
const size = this.imageNaturalSize()
|
||||||
|
return {
|
||||||
|
x: Math.max(0, Math.min(svgPoint.x, size.width)),
|
||||||
|
y: Math.max(0, Math.min(svgPoint.y, size.height)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private displayRectFromDrawing(rect: DrawingRect): DisplayRect {
|
||||||
|
return {
|
||||||
|
x: Math.min(rect.startX, rect.endX),
|
||||||
|
y: Math.min(rect.startY, rect.endY),
|
||||||
|
w: Math.abs(rect.endX - rect.startX),
|
||||||
|
h: Math.abs(rect.endY - rect.startY),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private sourceRectFromDrawing(rect: DrawingRect): DisplayRect {
|
||||||
|
const displayRect = this.displayRectFromDrawing(rect)
|
||||||
|
return {
|
||||||
|
x: Math.round(displayRect.x),
|
||||||
|
y: Math.round(displayRect.y),
|
||||||
|
w: Math.round(displayRect.w),
|
||||||
|
h: Math.round(displayRect.h),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private imageNaturalSize() {
|
||||||
|
const img = this.imageRef.nativeElement
|
||||||
|
return { width: img.naturalWidth, height: img.naturalHeight }
|
||||||
|
}
|
||||||
|
|
||||||
|
removeZone(index: number) {
|
||||||
|
this.stopOverlayInteraction()
|
||||||
|
this.clearZoneTest()
|
||||||
|
this.template.zones.splice(index, 1)
|
||||||
|
if (this.selectedZoneIndex === index) {
|
||||||
|
this.selectedZoneIndex = null
|
||||||
|
} else if (this.selectedZoneIndex > index) {
|
||||||
|
this.selectedZoneIndex--
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
selectZone(index: number) {
|
||||||
|
this.selectedZoneIndex = index
|
||||||
|
this.activeTab = 'zones'
|
||||||
|
this.clearZoneTest()
|
||||||
|
const zone = this.template.zones[index]
|
||||||
|
if (zone) {
|
||||||
|
this.goToPage(this.zonePage(zone) - 1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
deselectZone() {
|
||||||
|
this.selectedZoneIndex = null
|
||||||
|
this.clearZoneTest()
|
||||||
|
}
|
||||||
|
|
||||||
|
testZone() {
|
||||||
|
const zone = this.selectedZone
|
||||||
|
if (!zone || !this.previewDocId) return
|
||||||
|
this.clearZoneTest()
|
||||||
|
const test: ZoneTest = { zone, key: this.zoneTestKey(zone), result: null }
|
||||||
|
this.zoneTest.set(test)
|
||||||
|
this.templateService
|
||||||
|
.testZone(this.previewDocId, this.zoneTestRequest(zone))
|
||||||
|
.pipe(takeUntil(this.destroy$), takeUntil(this.cancelZoneTest$))
|
||||||
|
.subscribe({
|
||||||
|
next: (res) => this.zoneTest.set({ ...test, result: res }),
|
||||||
|
error: (err) =>
|
||||||
|
this.zoneTest.set({
|
||||||
|
...test,
|
||||||
|
result: { error: err.error?.error || $localize`Test failed` },
|
||||||
|
}),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
private clearZoneTest() {
|
||||||
|
this.cancelZoneTest$.next()
|
||||||
|
this.zoneTest.set(null)
|
||||||
|
}
|
||||||
|
|
||||||
|
/** A result is stale once its zone, settings or sample document change. */
|
||||||
|
private isCurrentZoneTest(): boolean {
|
||||||
|
const test = this.zoneTest()
|
||||||
|
return (
|
||||||
|
test?.zone === this.selectedZone &&
|
||||||
|
test.key === this.zoneTestKey(test.zone)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
private zoneTestKey(zone: OcrTemplateZone): string {
|
||||||
|
return JSON.stringify([this.previewDocId, this.zoneTestRequest(zone)])
|
||||||
|
}
|
||||||
|
|
||||||
|
private zoneTestRequest(zone: OcrTemplateZone): ZoneTestRequest {
|
||||||
|
return {
|
||||||
|
name: zone.name,
|
||||||
|
x: zone.x,
|
||||||
|
y: zone.y,
|
||||||
|
width: zone.width,
|
||||||
|
height: zone.height,
|
||||||
|
page: zone.page ?? 1,
|
||||||
|
ocr_language: zone.ocr_language,
|
||||||
|
transform: zone.transform,
|
||||||
|
date_format: zone.date_format,
|
||||||
|
validation_regex: zone.validation_regex,
|
||||||
|
zone_source_width: zone.zone_source_width,
|
||||||
|
zone_source_height: zone.zone_source_height,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
save() {
|
||||||
|
if (this.saving()) return
|
||||||
|
this.stopOverlayInteraction()
|
||||||
|
this.saving.set(true)
|
||||||
|
this.pruneCombineFormats()
|
||||||
|
this.template.sample_document = this.previewDocId
|
||||||
|
const payload = this.permissionsService.currentUserOwnsObject(this.object)
|
||||||
|
? { ...this.template, ...this.permissionsForm }
|
||||||
|
: this.template
|
||||||
|
const obs = this.template.id
|
||||||
|
? this.templateService.update(payload)
|
||||||
|
: this.templateService.create(payload)
|
||||||
|
|
||||||
|
obs.pipe(takeUntil(this.destroy$)).subscribe({
|
||||||
|
next: (saved) => {
|
||||||
|
this.activeModal.close()
|
||||||
|
this.succeeded.emit(saved)
|
||||||
|
},
|
||||||
|
error: (e) => {
|
||||||
|
this.saving.set(false)
|
||||||
|
this.failed.emit(e)
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// ng-select needs a stable array between change detection runs, so the
|
||||||
|
// split language list is cached per zone until ocr_language changes.
|
||||||
|
private readonly ocrLanguageCache = new WeakMap<
|
||||||
|
OcrTemplateZone,
|
||||||
|
{ language: string; languages: string[] }
|
||||||
|
>()
|
||||||
|
|
||||||
|
ocrLanguageArray(zone: OcrTemplateZone): string[] {
|
||||||
|
const language = zone.ocr_language || ''
|
||||||
|
const cached = this.ocrLanguageCache.get(zone)
|
||||||
|
if (cached?.language === language) return cached.languages
|
||||||
|
const languages = language.split('+').filter(Boolean)
|
||||||
|
this.ocrLanguageCache.set(zone, { language, languages })
|
||||||
|
return languages
|
||||||
|
}
|
||||||
|
|
||||||
|
setOcrLanguages(zone: OcrTemplateZone, langs: string[]) {
|
||||||
|
zone.ocr_language = (langs ?? []).join('+')
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The field select's value: a built-in target, or a custom field id. */
|
||||||
|
zoneFieldValue(zone: OcrTemplateZone): ZoneFieldSelection {
|
||||||
|
return zone.target === OcrZoneTarget.CustomField
|
||||||
|
? zone.custom_field
|
||||||
|
: zone.target
|
||||||
|
}
|
||||||
|
|
||||||
|
setZoneField(zone: OcrTemplateZone, value: ZoneFieldSelection) {
|
||||||
|
if (typeof value === 'string') {
|
||||||
|
zone.target = value
|
||||||
|
zone.custom_field = null
|
||||||
|
} else {
|
||||||
|
zone.target = OcrZoneTarget.CustomField
|
||||||
|
zone.custom_field = value
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
zonesForField(zone: OcrTemplateZone): OcrTemplateZone[] {
|
||||||
|
const key = getZoneFieldKey(zone)
|
||||||
|
if (!key) return []
|
||||||
|
return this.template.zones.filter((z) => getZoneFieldKey(z) === key)
|
||||||
|
}
|
||||||
|
|
||||||
|
isFieldShared(zone: OcrTemplateZone): boolean {
|
||||||
|
return this.zonesForField(zone).length > 1
|
||||||
|
}
|
||||||
|
|
||||||
|
renameZone(zone: OcrTemplateZone, name: string) {
|
||||||
|
const oldName = zone.name.trim()
|
||||||
|
const format = this.getCombineFormat(zone)
|
||||||
|
if (format) {
|
||||||
|
this.setCombineFormat(
|
||||||
|
zone,
|
||||||
|
format.replace(/\{([^{}]*)\}/g, (token, tokenName: string) =>
|
||||||
|
tokenName.trim() === oldName ? `{${name}}` : token
|
||||||
|
)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
zone.name = name
|
||||||
|
}
|
||||||
|
|
||||||
|
getCombineFormat(zone: OcrTemplateZone): string {
|
||||||
|
return this.template.combine_formats?.[getZoneFieldKey(zone)] ?? ''
|
||||||
|
}
|
||||||
|
|
||||||
|
setCombineFormat(zone: OcrTemplateZone, value: string) {
|
||||||
|
const key = getZoneFieldKey(zone)
|
||||||
|
if (!key) return
|
||||||
|
this.template.combine_formats ??= {}
|
||||||
|
this.template.combine_formats[key] = value
|
||||||
|
}
|
||||||
|
|
||||||
|
defaultCombineFormat(zone: OcrTemplateZone): string {
|
||||||
|
return this.zonesForField(zone)
|
||||||
|
.map((z) => `{${z.name}}`)
|
||||||
|
.join(' ')
|
||||||
|
}
|
||||||
|
|
||||||
|
insertCombineToken(zone: OcrTemplateZone, tokenZone: OcrTemplateZone) {
|
||||||
|
const current = this.getCombineFormat(zone)
|
||||||
|
const sep = current && !current.endsWith(' ') ? ' ' : ''
|
||||||
|
this.setCombineFormat(zone, `${current}${sep}{${tokenZone.name}}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Drop formats that are empty or whose field no longer has several zones. */
|
||||||
|
private pruneCombineFormats() {
|
||||||
|
const formats = this.template.combine_formats
|
||||||
|
if (!formats) return
|
||||||
|
const keys = this.template.zones.map(getZoneFieldKey)
|
||||||
|
for (const [key, format] of Object.entries(formats)) {
|
||||||
|
if (!format || keys.filter((k) => k === key).length < 2) {
|
||||||
|
delete formats[key]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
createField(name?: string) {
|
||||||
|
const zone = this.selectedZone
|
||||||
|
const modal = this.modalService.open(CustomFieldEditDialogComponent)
|
||||||
|
modal.componentInstance.dialogMode.set(EditDialogMode.CREATE)
|
||||||
|
modal.componentInstance.object = { name: name || zone?.name }
|
||||||
|
modal.componentInstance.succeeded
|
||||||
|
.pipe(takeUntil(this.destroy$))
|
||||||
|
.subscribe((field: CustomField) => {
|
||||||
|
this.toastService.showSuccess($localize`Saved field "${field.name}".`)
|
||||||
|
this.customFieldsService.clearCache()
|
||||||
|
this.customFieldsService
|
||||||
|
.listAll()
|
||||||
|
.pipe(takeUntil(this.destroy$))
|
||||||
|
.subscribe((r) => {
|
||||||
|
if (zone && OCR_SUPPORTED_FIELD_TYPES.includes(field.data_type)) {
|
||||||
|
this.setZoneField(zone, field.id)
|
||||||
|
}
|
||||||
|
this.customFields.set(r.results)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
modal.componentInstance.failed
|
||||||
|
.pipe(takeUntil(this.destroy$))
|
||||||
|
.subscribe((e) => {
|
||||||
|
this.toastService.showError($localize`Error saving field.`, e)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
ngOnDestroy() {
|
||||||
|
this.previewResizeObserver?.disconnect()
|
||||||
|
this.cancelZoneTest$.complete()
|
||||||
|
this.destroy$.next()
|
||||||
|
this.destroy$.complete()
|
||||||
|
}
|
||||||
|
}
|
||||||
+197
@@ -0,0 +1,197 @@
|
|||||||
|
import {
|
||||||
|
OcrTemplateZone,
|
||||||
|
OcrZoneTarget,
|
||||||
|
OcrZoneTransform,
|
||||||
|
} from 'src/app/data/ocr-template'
|
||||||
|
import {
|
||||||
|
findHandleAt,
|
||||||
|
findZoneAt,
|
||||||
|
getResizeHandles,
|
||||||
|
getZoneDisplayRect,
|
||||||
|
getZonePage,
|
||||||
|
isZoneOnPage,
|
||||||
|
moveZone,
|
||||||
|
resizeZone,
|
||||||
|
} from './zone-geometry'
|
||||||
|
|
||||||
|
function zone(overrides: Partial<OcrTemplateZone> = {}): OcrTemplateZone {
|
||||||
|
return {
|
||||||
|
name: 'Zone',
|
||||||
|
target: OcrZoneTarget.CustomField,
|
||||||
|
custom_field: 1,
|
||||||
|
x: 100,
|
||||||
|
y: 200,
|
||||||
|
width: 300,
|
||||||
|
height: 400,
|
||||||
|
page: 1,
|
||||||
|
ocr_language: 'eng',
|
||||||
|
transform: OcrZoneTransform.Strip,
|
||||||
|
validation_regex: '',
|
||||||
|
order: 0,
|
||||||
|
...overrides,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('OCR template editor geometry', () => {
|
||||||
|
it('normalizes zone pages', () => {
|
||||||
|
expect(getZonePage(zone({ page: 2 }), 0, 5)).toBe(2)
|
||||||
|
expect(getZonePage(zone({ page: -1 }), 0, 5)).toBe(5)
|
||||||
|
expect(getZonePage(zone({ page: -1 }), 2, null)).toBe(3)
|
||||||
|
expect(getZonePage(zone({ page: 0 }), 0, 5)).toBe(1)
|
||||||
|
expect(getZonePage(zone({ page: undefined }), 0, 5)).toBe(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('checks whether a zone is on the current preview page', () => {
|
||||||
|
expect(isZoneOnPage(zone({ page: 2 }), 1, 5)).toBe(true)
|
||||||
|
expect(isZoneOnPage(zone({ page: 2 }), 0, 5)).toBe(false)
|
||||||
|
expect(isZoneOnPage(zone({ page: -1 }), 4, 5)).toBe(true)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('uses natural image coordinates when source dimensions are unset', () => {
|
||||||
|
expect(
|
||||||
|
getZoneDisplayRect(zone({ x: 100, y: 200, width: 300, height: 400 }), {
|
||||||
|
width: 1000,
|
||||||
|
height: 2000,
|
||||||
|
})
|
||||||
|
).toEqual({ x: 100, y: 200, w: 300, h: 400 })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('uses per-zone source dimensions when present', () => {
|
||||||
|
expect(
|
||||||
|
getZoneDisplayRect(
|
||||||
|
zone({
|
||||||
|
x: 100,
|
||||||
|
y: 100,
|
||||||
|
width: 100,
|
||||||
|
height: 100,
|
||||||
|
zone_source_width: 1000,
|
||||||
|
zone_source_height: 1000,
|
||||||
|
}),
|
||||||
|
{ width: 500, height: 750 }
|
||||||
|
)
|
||||||
|
).toEqual({ x: 50, y: 75, w: 50, h: 75 })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('finds zones from topmost to bottommost on the current page', () => {
|
||||||
|
const zones = [
|
||||||
|
zone({ name: 'first', x: 0, y: 0, width: 100, height: 100, page: 1 }),
|
||||||
|
zone({ name: 'second', x: 0, y: 0, width: 50, height: 50, page: 1 }),
|
||||||
|
zone({ name: 'third', x: 0, y: 0, width: 50, height: 50, page: 2 }),
|
||||||
|
]
|
||||||
|
|
||||||
|
expect(
|
||||||
|
findZoneAt({ x: 25, y: 25 }, zones, 0, 2, { width: 100, height: 100 })
|
||||||
|
).toBe(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('finds resize handles around a display rect', () => {
|
||||||
|
const rect = { x: 10, y: 20, w: 100, h: 200 }
|
||||||
|
|
||||||
|
expect(findHandleAt({ x: 10, y: 20 }, rect)).toBe('nw')
|
||||||
|
expect(findHandleAt({ x: 110, y: 220 }, rect)).toBe('se')
|
||||||
|
expect(findHandleAt({ x: 60, y: 20 }, rect)).toBe('n')
|
||||||
|
expect(findHandleAt({ x: 90, y: 160 }, rect)).toBeNull()
|
||||||
|
expect(findHandleAt({ x: 19, y: 20 }, rect, 8)).toBeNull()
|
||||||
|
expect(findHandleAt({ x: 19, y: 20 }, rect, 10)).toBe('nw')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('returns no zone when the point is outside every rectangle', () => {
|
||||||
|
expect(
|
||||||
|
findZoneAt({ x: 900, y: 900 }, [zone()], 0, 1, {
|
||||||
|
width: 1000,
|
||||||
|
height: 1000,
|
||||||
|
})
|
||||||
|
).toBeNull()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('resizes north-west edges while keeping the opposite corner fixed', () => {
|
||||||
|
const z = zone({ x: 100, y: 200, width: 300, height: 400 })
|
||||||
|
resizeZone(z, 'nw', { x: 50, y: 100 }, { width: 1000, height: 1000 })
|
||||||
|
expect(z).toMatchObject({ x: 50, y: 100, width: 350, height: 500 })
|
||||||
|
resizeZone(z, 'nw', { x: 900, y: 900 }, { width: 1000, height: 1000 })
|
||||||
|
expect(z).toMatchObject({ x: 390, y: 590, width: 10, height: 10 })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('clamps resized north-west edges to the source image bounds', () => {
|
||||||
|
const z = zone({
|
||||||
|
x: 50,
|
||||||
|
y: 50,
|
||||||
|
width: 100,
|
||||||
|
height: 100,
|
||||||
|
zone_source_width: 200,
|
||||||
|
zone_source_height: 300,
|
||||||
|
})
|
||||||
|
resizeZone(z, 'nw', { x: -50, y: -50 }, { width: 400, height: 600 })
|
||||||
|
expect(z).toMatchObject({ x: 0, y: 0, width: 150, height: 150 })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('uses the rendered handle positions for hit testing', () => {
|
||||||
|
const rect = { x: 10, y: 20, w: 100, h: 200 }
|
||||||
|
const handles = getResizeHandles(rect)
|
||||||
|
|
||||||
|
expect(handles).toEqual([
|
||||||
|
{ handle: 'nw', x: 10, y: 20 },
|
||||||
|
{ handle: 'n', x: 60, y: 20 },
|
||||||
|
{ handle: 'ne', x: 110, y: 20 },
|
||||||
|
{ handle: 'w', x: 10, y: 120 },
|
||||||
|
{ handle: 'e', x: 110, y: 120 },
|
||||||
|
{ handle: 'sw', x: 10, y: 220 },
|
||||||
|
{ handle: 's', x: 60, y: 220 },
|
||||||
|
{ handle: 'se', x: 110, y: 220 },
|
||||||
|
])
|
||||||
|
for (const marker of handles) {
|
||||||
|
expect(findHandleAt(marker, rect)).toBe(marker.handle)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
it('moves zones without leaving source image bounds', () => {
|
||||||
|
const z = zone({ x: 50, y: 50, width: 100, height: 100 })
|
||||||
|
|
||||||
|
moveZone(
|
||||||
|
z,
|
||||||
|
{ x: 500, y: 500 },
|
||||||
|
{ mouseX: 50, mouseY: 50, zoneX: 50, zoneY: 50 },
|
||||||
|
{ width: 500, height: 500 }
|
||||||
|
)
|
||||||
|
|
||||||
|
expect(z.x).toBe(400)
|
||||||
|
expect(z.y).toBe(400)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('resizes zones without leaving source image bounds', () => {
|
||||||
|
const z = zone({
|
||||||
|
x: 50,
|
||||||
|
y: 50,
|
||||||
|
width: 100,
|
||||||
|
height: 100,
|
||||||
|
zone_source_width: 200,
|
||||||
|
zone_source_height: 200,
|
||||||
|
})
|
||||||
|
|
||||||
|
resizeZone(z, 'se', { x: 500, y: 500 }, { width: 500, height: 500 })
|
||||||
|
|
||||||
|
expect(z.width).toBe(150)
|
||||||
|
expect(z.height).toBe(150)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('moves zones in their original source coordinates on a different-size preview', () => {
|
||||||
|
const z = zone({
|
||||||
|
x: 50,
|
||||||
|
y: 50,
|
||||||
|
width: 100,
|
||||||
|
height: 100,
|
||||||
|
zone_source_width: 1000,
|
||||||
|
zone_source_height: 2000,
|
||||||
|
})
|
||||||
|
|
||||||
|
moveZone(
|
||||||
|
z,
|
||||||
|
{ x: 75, y: 75 },
|
||||||
|
{ mouseX: 25, mouseY: 25, zoneX: 50, zoneY: 50 },
|
||||||
|
{ width: 500, height: 500 }
|
||||||
|
)
|
||||||
|
|
||||||
|
expect(z.x).toBe(150)
|
||||||
|
expect(z.y).toBe(250)
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,204 @@
|
|||||||
|
import { OcrTemplateZone } from 'src/app/data/ocr-template'
|
||||||
|
|
||||||
|
export interface DrawingRect {
|
||||||
|
startX: number
|
||||||
|
startY: number
|
||||||
|
endX: number
|
||||||
|
endY: number
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Dimensions {
|
||||||
|
width: number
|
||||||
|
height: number
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Point {
|
||||||
|
x: number
|
||||||
|
y: number
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface DisplayRect {
|
||||||
|
x: number
|
||||||
|
y: number
|
||||||
|
w: number
|
||||||
|
h: number
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface MoveStart {
|
||||||
|
mouseX: number
|
||||||
|
mouseY: number
|
||||||
|
zoneX: number
|
||||||
|
zoneY: number
|
||||||
|
}
|
||||||
|
|
||||||
|
export type ResizeHandle = 'n' | 's' | 'e' | 'w' | 'ne' | 'nw' | 'se' | 'sw'
|
||||||
|
|
||||||
|
export interface ResizeHandleMarker extends Point {
|
||||||
|
handle: ResizeHandle
|
||||||
|
}
|
||||||
|
|
||||||
|
export const HANDLE_SIZE = 8
|
||||||
|
export const MIN_ZONE_SIZE = 10
|
||||||
|
|
||||||
|
const ZONE_COLORS = [
|
||||||
|
'#4f8ff7',
|
||||||
|
'#ff6b6b',
|
||||||
|
'#51cf66',
|
||||||
|
'#ffd43b',
|
||||||
|
'#cc5de8',
|
||||||
|
'#ff922b',
|
||||||
|
'#20c997',
|
||||||
|
'#e599f7',
|
||||||
|
]
|
||||||
|
|
||||||
|
/** Outline color for a zone, shared by the preview overlay and the zone list. */
|
||||||
|
export function getZoneColor(index: number): string {
|
||||||
|
return ZONE_COLORS[index % ZONE_COLORS.length]
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getZonePage(
|
||||||
|
zone: OcrTemplateZone,
|
||||||
|
previewPage: number,
|
||||||
|
previewPageCount: number | null
|
||||||
|
): number {
|
||||||
|
const page = zone.page ?? 1
|
||||||
|
if (page === -1) return previewPageCount ?? previewPage + 1
|
||||||
|
return Math.max(page, 1)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function isZoneOnPage(
|
||||||
|
zone: OcrTemplateZone,
|
||||||
|
previewPage: number,
|
||||||
|
previewPageCount: number | null
|
||||||
|
): boolean {
|
||||||
|
return getZonePage(zone, previewPage, previewPageCount) === previewPage + 1
|
||||||
|
}
|
||||||
|
|
||||||
|
function getZoneSourceSize(
|
||||||
|
zone: OcrTemplateZone,
|
||||||
|
imageSize: Dimensions
|
||||||
|
): Dimensions {
|
||||||
|
return {
|
||||||
|
width: zone.zone_source_width || imageSize.width,
|
||||||
|
height: zone.zone_source_height || imageSize.height,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getZoneDisplayRect(
|
||||||
|
zone: OcrTemplateZone,
|
||||||
|
imageSize: Dimensions
|
||||||
|
): DisplayRect {
|
||||||
|
const sourceSize = getZoneSourceSize(zone, imageSize)
|
||||||
|
// The SVG viewBox uses the preview image's natural dimensions.
|
||||||
|
const scaleX = imageSize.width / sourceSize.width
|
||||||
|
const scaleY = imageSize.height / sourceSize.height
|
||||||
|
|
||||||
|
return {
|
||||||
|
x: zone.x * scaleX,
|
||||||
|
y: zone.y * scaleY,
|
||||||
|
w: zone.width * scaleX,
|
||||||
|
h: zone.height * scaleY,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getResizeHandles(rect: DisplayRect): ResizeHandleMarker[] {
|
||||||
|
return [
|
||||||
|
{ handle: 'nw', x: rect.x, y: rect.y },
|
||||||
|
{ handle: 'n', x: rect.x + rect.w / 2, y: rect.y },
|
||||||
|
{ handle: 'ne', x: rect.x + rect.w, y: rect.y },
|
||||||
|
{ handle: 'w', x: rect.x, y: rect.y + rect.h / 2 },
|
||||||
|
{ handle: 'e', x: rect.x + rect.w, y: rect.y + rect.h / 2 },
|
||||||
|
{ handle: 'sw', x: rect.x, y: rect.y + rect.h },
|
||||||
|
{ handle: 's', x: rect.x + rect.w / 2, y: rect.y + rect.h },
|
||||||
|
{ handle: 'se', x: rect.x + rect.w, y: rect.y + rect.h },
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
export function findHandleAt(
|
||||||
|
point: Point,
|
||||||
|
rect: DisplayRect,
|
||||||
|
handleSize = HANDLE_SIZE
|
||||||
|
): ResizeHandle | null {
|
||||||
|
return (
|
||||||
|
getResizeHandles(rect).find(
|
||||||
|
({ x, y }) =>
|
||||||
|
Math.abs(point.x - x) <= handleSize &&
|
||||||
|
Math.abs(point.y - y) <= handleSize
|
||||||
|
)?.handle ?? null
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function findZoneAt(
|
||||||
|
point: Point,
|
||||||
|
zones: OcrTemplateZone[],
|
||||||
|
previewPage: number,
|
||||||
|
previewPageCount: number | null,
|
||||||
|
imageSize: Dimensions
|
||||||
|
): number | null {
|
||||||
|
for (let i = zones.length - 1; i >= 0; i--) {
|
||||||
|
const zone = zones[i]
|
||||||
|
if (!isZoneOnPage(zone, previewPage, previewPageCount)) continue
|
||||||
|
const rect = getZoneDisplayRect(zone, imageSize)
|
||||||
|
|
||||||
|
if (
|
||||||
|
point.x >= rect.x &&
|
||||||
|
point.x <= rect.x + rect.w &&
|
||||||
|
point.y >= rect.y &&
|
||||||
|
point.y <= rect.y + rect.h
|
||||||
|
) {
|
||||||
|
return i
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
|
||||||
|
export function moveZone(
|
||||||
|
zone: OcrTemplateZone,
|
||||||
|
point: Point,
|
||||||
|
moveStart: MoveStart,
|
||||||
|
imageSize: Dimensions
|
||||||
|
) {
|
||||||
|
const sourceSize = getZoneSourceSize(zone, imageSize)
|
||||||
|
const scaleX = sourceSize.width / imageSize.width
|
||||||
|
const scaleY = sourceSize.height / imageSize.height
|
||||||
|
const dx = Math.round((point.x - moveStart.mouseX) * scaleX)
|
||||||
|
const dy = Math.round((point.y - moveStart.mouseY) * scaleY)
|
||||||
|
|
||||||
|
zone.x = clamp(moveStart.zoneX + dx, 0, sourceSize.width - zone.width)
|
||||||
|
zone.y = clamp(moveStart.zoneY + dy, 0, sourceSize.height - zone.height)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function resizeZone(
|
||||||
|
zone: OcrTemplateZone,
|
||||||
|
handle: ResizeHandle,
|
||||||
|
point: Point,
|
||||||
|
imageSize: Dimensions
|
||||||
|
) {
|
||||||
|
const sourceSize = getZoneSourceSize(zone, imageSize)
|
||||||
|
const scaleX = sourceSize.width / imageSize.width
|
||||||
|
const scaleY = sourceSize.height / imageSize.height
|
||||||
|
const imageX = clamp(Math.round(point.x * scaleX), 0, sourceSize.width)
|
||||||
|
const imageY = clamp(Math.round(point.y * scaleY), 0, sourceSize.height)
|
||||||
|
|
||||||
|
if (handle.includes('w')) {
|
||||||
|
const right = Math.min(zone.x + zone.width, sourceSize.width)
|
||||||
|
zone.x = clamp(imageX, 0, right - MIN_ZONE_SIZE)
|
||||||
|
zone.width = right - zone.x
|
||||||
|
}
|
||||||
|
if (handle.includes('e')) {
|
||||||
|
zone.width = Math.max(MIN_ZONE_SIZE, imageX - zone.x)
|
||||||
|
}
|
||||||
|
if (handle.includes('n')) {
|
||||||
|
const bottom = Math.min(zone.y + zone.height, sourceSize.height)
|
||||||
|
zone.y = clamp(imageY, 0, bottom - MIN_ZONE_SIZE)
|
||||||
|
zone.height = bottom - zone.y
|
||||||
|
}
|
||||||
|
if (handle.includes('s')) {
|
||||||
|
zone.height = Math.max(MIN_ZONE_SIZE, imageY - zone.y)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function clamp(value: number, min: number, max: number): number {
|
||||||
|
return Math.max(min, Math.min(value, max))
|
||||||
|
}
|
||||||
@@ -0,0 +1,75 @@
|
|||||||
|
<pngx-page-header
|
||||||
|
title="OCR Templates"
|
||||||
|
i18n-title
|
||||||
|
info="Define extraction zones on document types to automatically populate custom fields via OCR."
|
||||||
|
i18n-info
|
||||||
|
>
|
||||||
|
<button type="button" class="btn btn-sm btn-outline-primary" (click)="editTemplate()" *pngxIfPermissions="{ action: PermissionAction.Add, type: PermissionType.OcrTemplate }">
|
||||||
|
<pngx-bs-icon name="plus-circle" class="me-1"></pngx-bs-icon><ng-container i18n>Add Template</ng-container>
|
||||||
|
</button>
|
||||||
|
</pngx-page-header>
|
||||||
|
|
||||||
|
<ul class="list-group">
|
||||||
|
|
||||||
|
<li class="list-group-item">
|
||||||
|
<div class="row">
|
||||||
|
<div class="col" i18n>Name</div>
|
||||||
|
<div class="col d-none d-sm-flex" i18n>Matching</div>
|
||||||
|
<div class="col d-none d-sm-flex" i18n>Zones</div>
|
||||||
|
<div class="col" i18n>Status</div>
|
||||||
|
<div class="col" i18n>Actions</div>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
@if (loading() && templates().length === 0) {
|
||||||
|
<li class="list-group-item">
|
||||||
|
<output class="spinner-border spinner-border-sm me-2"></output>
|
||||||
|
<ng-container i18n>Loading...</ng-container>
|
||||||
|
</li>
|
||||||
|
}
|
||||||
|
|
||||||
|
@for (template of templates(); track template.id) {
|
||||||
|
<li class="list-group-item">
|
||||||
|
<div class="row fade" [class.show]="show()">
|
||||||
|
<div class="col d-flex align-items-center"><button class="btn btn-link p-0 text-start" type="button" (click)="editTemplate(template)" [disabled]="!userCanEdit(template)">{{template.name}}</button></div>
|
||||||
|
<div class="col d-flex align-items-center d-none d-sm-flex">{{getMatching(template)}}</div>
|
||||||
|
<div class="col d-flex align-items-center d-none d-sm-flex"><code>{{template.zones.length}}</code></div>
|
||||||
|
<div class="col d-flex align-items-center">
|
||||||
|
<div class="form-check form-switch mb-0">
|
||||||
|
<input type="checkbox" class="form-check-input cursor-pointer" [id]="template.id+'_enable'" [(ngModel)]="template.enabled" (change)="toggleTemplateEnabled(template)" [disabled]="!userCanEdit(template)" *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.OcrTemplate }">
|
||||||
|
<label class="form-check-label cursor-pointer" [for]="template.id+'_enable'">
|
||||||
|
<code> @if(template.enabled) { <ng-container i18n>Enabled</ng-container> } @else { <span i18n class="text-muted">Disabled</span> }</code>
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="col">
|
||||||
|
|
||||||
|
<div class="btn-group d-block d-sm-none">
|
||||||
|
<div ngbDropdown container="body" class="d-inline-block">
|
||||||
|
<button type="button" class="btn btn-link" id="actionsMenuMobile{{template.id}}" (click)="$event.stopPropagation()" ngbDropdownToggle>
|
||||||
|
<pngx-bs-icon name="three-dots-vertical"></pngx-bs-icon>
|
||||||
|
</button>
|
||||||
|
<div ngbDropdownMenu aria-labelledby="actionsMenuMobile{{template.id}}">
|
||||||
|
<button (click)="editTemplate(template)" [disabled]="!userCanEdit(template)" *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.OcrTemplate }" ngbDropdownItem i18n>Edit</button>
|
||||||
|
<button (click)="deleteTemplate(template)" [disabled]="!permissionsService.currentUserOwnsObject(template)" *pngxIfPermissions="{ action: PermissionAction.Delete, type: PermissionType.OcrTemplate }" ngbDropdownItem i18n>Delete</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="btn-toolbar d-none d-sm-flex gap-2" role="toolbar">
|
||||||
|
<div class="btn-group">
|
||||||
|
<button *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.OcrTemplate }" [disabled]="!userCanEdit(template)" class="btn btn-sm btn-outline-secondary" type="button" (click)="editTemplate(template)">
|
||||||
|
<pngx-bs-icon width="1em" height="1em" name="pencil" class="me-1"></pngx-bs-icon><ng-container i18n>Edit</ng-container>
|
||||||
|
</button>
|
||||||
|
<button *pngxIfPermissions="{ action: PermissionAction.Delete, type: PermissionType.OcrTemplate }" [disabled]="!permissionsService.currentUserOwnsObject(template)" class="btn btn-sm btn-outline-danger" type="button" (click)="deleteTemplate(template)">
|
||||||
|
<pngx-bs-icon width="1em" height="1em" name="trash" class="me-1"></pngx-bs-icon><ng-container i18n>Delete</ng-container>
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
}
|
||||||
|
@if (!loading() && templates().length === 0) {
|
||||||
|
<li class="list-group-item" [class.show]="show()" i18n>No OCR templates defined.</li>
|
||||||
|
}
|
||||||
|
</ul>
|
||||||
@@ -0,0 +1,300 @@
|
|||||||
|
import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
|
||||||
|
import { provideHttpClientTesting } from '@angular/common/http/testing'
|
||||||
|
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
||||||
|
import { By } from '@angular/platform-browser'
|
||||||
|
import { NgbModal, NgbModalRef } from '@ng-bootstrap/ng-bootstrap'
|
||||||
|
import { of, throwError } from 'rxjs'
|
||||||
|
import { MATCH_LITERAL, MATCH_NONE } from 'src/app/data/matching-model'
|
||||||
|
import { OcrTemplate } from 'src/app/data/ocr-template'
|
||||||
|
import { User } from 'src/app/data/user'
|
||||||
|
import { DirtyFormGuard } from 'src/app/guards/dirty-form.guard'
|
||||||
|
import { PermissionsService } from 'src/app/services/permissions.service'
|
||||||
|
import { OcrTemplateService } from 'src/app/services/rest/ocr-template.service'
|
||||||
|
import { UserService } from 'src/app/services/rest/user.service'
|
||||||
|
import { ToastService } from 'src/app/services/toast.service'
|
||||||
|
import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component'
|
||||||
|
import { OcrTemplateEditorComponent } from './ocr-template-editor/ocr-template-editor.component'
|
||||||
|
import { OcrTemplatesComponent } from './ocr-templates.component'
|
||||||
|
import { BootstrapIconComponent } from 'src/app/components/common/bootstrap-icon/bootstrap-icon.component'
|
||||||
|
|
||||||
|
const templates: OcrTemplate[] = [
|
||||||
|
{
|
||||||
|
id: 1,
|
||||||
|
name: 'Invoices',
|
||||||
|
match: 'Northwind',
|
||||||
|
matching_algorithm: MATCH_LITERAL,
|
||||||
|
sample_document: null,
|
||||||
|
source_width: 0,
|
||||||
|
source_height: 0,
|
||||||
|
enabled: true,
|
||||||
|
zones: [],
|
||||||
|
},
|
||||||
|
]
|
||||||
|
|
||||||
|
describe('OcrTemplatesComponent', () => {
|
||||||
|
let component: OcrTemplatesComponent
|
||||||
|
let fixture: ComponentFixture<OcrTemplatesComponent>
|
||||||
|
let ocrTemplateService: OcrTemplateService
|
||||||
|
let modalService: NgbModal
|
||||||
|
let toastService: ToastService
|
||||||
|
let modal: NgbModalRef
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
TestBed.configureTestingModule({
|
||||||
|
imports: [OcrTemplatesComponent, BootstrapIconComponent],
|
||||||
|
providers: [
|
||||||
|
provideHttpClient(withInterceptorsFromDi()),
|
||||||
|
provideHttpClientTesting(),
|
||||||
|
],
|
||||||
|
})
|
||||||
|
|
||||||
|
TestBed.inject(PermissionsService).initialize(
|
||||||
|
[
|
||||||
|
'view_ocrtemplate',
|
||||||
|
'add_ocrtemplate',
|
||||||
|
'change_ocrtemplate',
|
||||||
|
'delete_ocrtemplate',
|
||||||
|
],
|
||||||
|
{ id: 1, groups: [], is_superuser: false } as User
|
||||||
|
)
|
||||||
|
jest
|
||||||
|
.spyOn(TestBed.inject(UserService), 'listAll')
|
||||||
|
.mockReturnValue(of({ count: 0, all: [], results: [] }))
|
||||||
|
|
||||||
|
ocrTemplateService = TestBed.inject(OcrTemplateService)
|
||||||
|
jest
|
||||||
|
.spyOn(ocrTemplateService, 'listAll')
|
||||||
|
.mockReturnValue(of({ count: 1, all: [1], results: templates }))
|
||||||
|
modalService = TestBed.inject(NgbModal)
|
||||||
|
modalService.activeInstances.subscribe((m) => (modal = m[m.length - 1]))
|
||||||
|
toastService = TestBed.inject(ToastService)
|
||||||
|
fixture = TestBed.createComponent(OcrTemplatesComponent)
|
||||||
|
component = fixture.componentInstance
|
||||||
|
fixture.detectChanges()
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => modalService.dismissAll())
|
||||||
|
|
||||||
|
it('should show templates with their matching', () => {
|
||||||
|
const text = fixture.nativeElement.textContent
|
||||||
|
expect(text).toContain('Invoices')
|
||||||
|
expect(text).toContain('Exact match: Northwind')
|
||||||
|
|
||||||
|
expect(
|
||||||
|
component.getMatching({ ...templates[0], matching_algorithm: MATCH_NONE })
|
||||||
|
).toEqual('None')
|
||||||
|
expect(component.getMatching({ ...templates[0], match: '' })).toEqual('-')
|
||||||
|
})
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
{
|
||||||
|
name: 'owned',
|
||||||
|
owner: 1,
|
||||||
|
user_can_change: true,
|
||||||
|
editable: true,
|
||||||
|
deletable: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'unowned',
|
||||||
|
owner: null,
|
||||||
|
user_can_change: true,
|
||||||
|
editable: true,
|
||||||
|
deletable: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'view-only shared',
|
||||||
|
owner: 2,
|
||||||
|
user_can_change: false,
|
||||||
|
editable: false,
|
||||||
|
deletable: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'editable shared',
|
||||||
|
owner: 2,
|
||||||
|
user_can_change: true,
|
||||||
|
editable: true,
|
||||||
|
deletable: false,
|
||||||
|
},
|
||||||
|
])(
|
||||||
|
'should respect permissions for $name templates',
|
||||||
|
async ({ owner, user_can_change, editable, deletable }) => {
|
||||||
|
const template = { ...templates[0], owner, user_can_change }
|
||||||
|
component.templates.set([template])
|
||||||
|
fixture.detectChanges()
|
||||||
|
await fixture.whenStable()
|
||||||
|
|
||||||
|
expect(fixture.nativeElement.querySelector('.text-start').disabled).toBe(
|
||||||
|
!editable
|
||||||
|
)
|
||||||
|
expect(
|
||||||
|
fixture.nativeElement.querySelector('.form-switch input').disabled
|
||||||
|
).toBe(!editable)
|
||||||
|
const buttons = Array.from<HTMLButtonElement>(
|
||||||
|
fixture.nativeElement.querySelectorAll('button')
|
||||||
|
)
|
||||||
|
for (const button of buttons.filter(
|
||||||
|
(button) => button.textContent.trim() === 'Edit'
|
||||||
|
)) {
|
||||||
|
expect(button.disabled).toBe(!editable)
|
||||||
|
}
|
||||||
|
for (const button of buttons.filter(
|
||||||
|
(button) => button.textContent.trim() === 'Delete'
|
||||||
|
)) {
|
||||||
|
expect(button.disabled).toBe(!deletable)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
it('should allow a superuser to manage another users template', () => {
|
||||||
|
TestBed.inject(PermissionsService).initialize([], {
|
||||||
|
id: 1,
|
||||||
|
is_superuser: true,
|
||||||
|
} as User)
|
||||||
|
component.templates.set([
|
||||||
|
{ ...templates[0], owner: 2, user_can_change: false },
|
||||||
|
])
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(fixture.nativeElement.querySelector('.text-start').disabled).toBe(
|
||||||
|
false
|
||||||
|
)
|
||||||
|
expect(
|
||||||
|
fixture.nativeElement.querySelector('.btn-outline-danger').disabled
|
||||||
|
).toBe(false)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should not open mutation dialogs or patch a view-only template', () => {
|
||||||
|
const template = { ...templates[0], owner: 2, user_can_change: false }
|
||||||
|
const open = jest.spyOn(modalService, 'open')
|
||||||
|
const patch = jest.spyOn(ocrTemplateService, 'patch')
|
||||||
|
component.editTemplate(template)
|
||||||
|
component.toggleTemplateEnabled(template)
|
||||||
|
component.deleteTemplate(template)
|
||||||
|
expect(open).not.toHaveBeenCalled()
|
||||||
|
expect(patch).not.toHaveBeenCalled()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should require global edit permission even for an owned template', () => {
|
||||||
|
TestBed.inject(PermissionsService).initialize(['view_ocrtemplate'], {
|
||||||
|
id: 1,
|
||||||
|
} as User)
|
||||||
|
fixture.destroy()
|
||||||
|
fixture = TestBed.createComponent(OcrTemplatesComponent)
|
||||||
|
component = fixture.componentInstance
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(fixture.nativeElement.querySelector('.text-start').disabled).toBe(
|
||||||
|
true
|
||||||
|
)
|
||||||
|
expect(fixture.nativeElement.querySelector('.form-switch input')).toBeNull()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should support create, show notification on error / success', () => {
|
||||||
|
const toastErrorSpy = jest.spyOn(toastService, 'showError')
|
||||||
|
const toastSuccessSpy = jest.spyOn(toastService, 'showSuccess')
|
||||||
|
const reloadSpy = jest.spyOn(component, 'reload')
|
||||||
|
|
||||||
|
fixture.debugElement
|
||||||
|
.queryAll(By.css('pngx-page-header button'))
|
||||||
|
.find((button) => button.nativeElement.textContent.includes('Add'))
|
||||||
|
.triggerEventHandler('click')
|
||||||
|
|
||||||
|
const editor = modal.componentInstance as OcrTemplateEditorComponent
|
||||||
|
expect(editor).toBeInstanceOf(OcrTemplateEditorComponent)
|
||||||
|
expect(editor.object).toBeUndefined()
|
||||||
|
|
||||||
|
editor.failed.emit({ error: 'error creating template' })
|
||||||
|
expect(toastErrorSpy).toHaveBeenCalled()
|
||||||
|
expect(reloadSpy).not.toHaveBeenCalled()
|
||||||
|
|
||||||
|
editor.succeeded.emit(templates[0])
|
||||||
|
expect(toastSuccessSpy).toHaveBeenCalled()
|
||||||
|
expect(reloadSpy).toHaveBeenCalled()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should pass the template to the editor', () => {
|
||||||
|
component.editTemplate(templates[0])
|
||||||
|
expect(modal.componentInstance.object).toBe(templates[0])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should confirm closing the editor with unsaved changes', async () => {
|
||||||
|
const confirmSpy = jest
|
||||||
|
.spyOn(TestBed.inject(DirtyFormGuard), 'confirmChanges')
|
||||||
|
.mockReturnValue(of(false))
|
||||||
|
component.editTemplate()
|
||||||
|
const editor = modal.componentInstance as OcrTemplateEditorComponent
|
||||||
|
editor.ngOnInit()
|
||||||
|
|
||||||
|
modal.dismiss()
|
||||||
|
await fixture.whenStable()
|
||||||
|
expect(confirmSpy).not.toHaveBeenCalled()
|
||||||
|
|
||||||
|
component.editTemplate()
|
||||||
|
const dirtyEditor = modal.componentInstance as OcrTemplateEditorComponent
|
||||||
|
dirtyEditor.ngOnInit()
|
||||||
|
dirtyEditor.template.name = 'Changed'
|
||||||
|
modal.dismiss()
|
||||||
|
await fixture.whenStable()
|
||||||
|
expect(confirmSpy).toHaveBeenCalled()
|
||||||
|
expect(modalService.hasOpenModals()).toBe(true)
|
||||||
|
|
||||||
|
dirtyEditor.saving.set(true)
|
||||||
|
confirmSpy.mockClear()
|
||||||
|
modal.dismiss()
|
||||||
|
await fixture.whenStable()
|
||||||
|
expect(confirmSpy).not.toHaveBeenCalled()
|
||||||
|
expect(modalService.hasOpenModals()).toBe(true)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should only send the enabled flag when toggling', () => {
|
||||||
|
const patchSpy = jest
|
||||||
|
.spyOn(ocrTemplateService, 'patch')
|
||||||
|
.mockReturnValueOnce(throwError(() => new Error('error toggling')))
|
||||||
|
.mockReturnValueOnce(of(templates[0]))
|
||||||
|
const toastErrorSpy = jest.spyOn(toastService, 'showError')
|
||||||
|
const toastSuccessSpy = jest.spyOn(toastService, 'showSuccess')
|
||||||
|
const reloadSpy = jest.spyOn(component, 'reload')
|
||||||
|
|
||||||
|
const toggle = fixture.debugElement.query(By.css('.form-switch input'))
|
||||||
|
toggle.nativeElement.click()
|
||||||
|
expect(patchSpy).toHaveBeenCalledWith({ id: 1, enabled: false })
|
||||||
|
expect(toastErrorSpy).toHaveBeenCalled()
|
||||||
|
expect(reloadSpy).toHaveBeenCalledTimes(1)
|
||||||
|
|
||||||
|
component.toggleTemplateEnabled(templates[0])
|
||||||
|
expect(toastSuccessSpy).toHaveBeenCalled()
|
||||||
|
expect(reloadSpy).toHaveBeenCalledTimes(2)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should support delete, show notification on error / success', () => {
|
||||||
|
const toastErrorSpy = jest.spyOn(toastService, 'showError')
|
||||||
|
const toastSuccessSpy = jest.spyOn(toastService, 'showSuccess')
|
||||||
|
const deleteSpy = jest.spyOn(ocrTemplateService, 'delete')
|
||||||
|
const reloadSpy = jest.spyOn(component, 'reload')
|
||||||
|
|
||||||
|
component.deleteTemplate(templates[0])
|
||||||
|
const dialog = modal.componentInstance as ConfirmDialogComponent
|
||||||
|
|
||||||
|
deleteSpy.mockReturnValueOnce(throwError(() => new Error('error deleting')))
|
||||||
|
dialog.confirmClicked.emit()
|
||||||
|
expect(toastErrorSpy).toHaveBeenCalled()
|
||||||
|
expect(dialog.buttonsEnabled()).toBe(true)
|
||||||
|
expect(reloadSpy).not.toHaveBeenCalled()
|
||||||
|
|
||||||
|
deleteSpy.mockReturnValueOnce(of(true))
|
||||||
|
dialog.confirmClicked.emit()
|
||||||
|
expect(toastSuccessSpy).toHaveBeenCalled()
|
||||||
|
expect(reloadSpy).toHaveBeenCalled()
|
||||||
|
})
|
||||||
|
|
||||||
|
it.each([true, false])(
|
||||||
|
'reports the enabled state %s after the update succeeds',
|
||||||
|
(enabled) => {
|
||||||
|
const template = { ...templates[0], enabled }
|
||||||
|
jest.spyOn(ocrTemplateService, 'patch').mockReturnValue(of(template))
|
||||||
|
const toast = jest.spyOn(toastService, 'showSuccess')
|
||||||
|
component.toggleTemplateEnabled(template)
|
||||||
|
expect(toast).toHaveBeenCalledWith(
|
||||||
|
`${enabled ? 'Enabled' : 'Disabled'} OCR template "${template.name}"`
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
@@ -0,0 +1,185 @@
|
|||||||
|
import { Component, OnInit, inject, signal } from '@angular/core'
|
||||||
|
import { FormsModule } from '@angular/forms'
|
||||||
|
import { NgbDropdownModule, NgbModal } from '@ng-bootstrap/ng-bootstrap'
|
||||||
|
import { BootstrapIconComponent } from 'src/app/components/common/bootstrap-icon/bootstrap-icon.component'
|
||||||
|
import { firstValueFrom, takeUntil, tap } from 'rxjs'
|
||||||
|
import { MATCH_NONE, MATCHING_ALGORITHMS } from 'src/app/data/matching-model'
|
||||||
|
import { OcrTemplate } from 'src/app/data/ocr-template'
|
||||||
|
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
|
||||||
|
import { DirtyFormGuard } from 'src/app/guards/dirty-form.guard'
|
||||||
|
import {
|
||||||
|
PermissionAction,
|
||||||
|
PermissionType,
|
||||||
|
PermissionsService,
|
||||||
|
} from 'src/app/services/permissions.service'
|
||||||
|
import { OcrTemplateService } from 'src/app/services/rest/ocr-template.service'
|
||||||
|
import { ToastService } from 'src/app/services/toast.service'
|
||||||
|
import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component'
|
||||||
|
import { PageHeaderComponent } from '../../common/page-header/page-header.component'
|
||||||
|
import { LoadingComponentWithPermissions } from '../../loading-component/loading.component'
|
||||||
|
import { OcrTemplateEditorComponent } from './ocr-template-editor/ocr-template-editor.component'
|
||||||
|
|
||||||
|
@Component({
|
||||||
|
selector: 'pngx-ocr-templates',
|
||||||
|
templateUrl: './ocr-templates.component.html',
|
||||||
|
imports: [
|
||||||
|
PageHeaderComponent,
|
||||||
|
IfPermissionsDirective,
|
||||||
|
FormsModule,
|
||||||
|
NgbDropdownModule,
|
||||||
|
BootstrapIconComponent,
|
||||||
|
],
|
||||||
|
})
|
||||||
|
export class OcrTemplatesComponent
|
||||||
|
extends LoadingComponentWithPermissions
|
||||||
|
implements OnInit
|
||||||
|
{
|
||||||
|
private readonly ocrTemplateService = inject(OcrTemplateService)
|
||||||
|
public readonly permissionsService = inject(PermissionsService)
|
||||||
|
private readonly modalService = inject(NgbModal)
|
||||||
|
private readonly dirtyFormGuard = inject(DirtyFormGuard)
|
||||||
|
private readonly toastService = inject(ToastService)
|
||||||
|
|
||||||
|
public readonly templates = signal<OcrTemplate[]>([])
|
||||||
|
|
||||||
|
ngOnInit() {
|
||||||
|
this.reload()
|
||||||
|
}
|
||||||
|
|
||||||
|
reload() {
|
||||||
|
this.loading.set(true)
|
||||||
|
this.ocrTemplateService
|
||||||
|
.listAll()
|
||||||
|
.pipe(
|
||||||
|
takeUntil(this.unsubscribeNotifier),
|
||||||
|
tap((r) => this.templates.set(r.results))
|
||||||
|
)
|
||||||
|
.subscribe(() => {
|
||||||
|
this.show.set(true)
|
||||||
|
this.loading.set(false)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
getMatching(template: OcrTemplate): string {
|
||||||
|
if (template.matching_algorithm === MATCH_NONE) {
|
||||||
|
return $localize`None`
|
||||||
|
}
|
||||||
|
if (!template.match) {
|
||||||
|
return '-'
|
||||||
|
}
|
||||||
|
const algorithm = MATCHING_ALGORITHMS.find(
|
||||||
|
(a) => a.id === template.matching_algorithm
|
||||||
|
)
|
||||||
|
return `${algorithm?.shortName}: ${template.match}`
|
||||||
|
}
|
||||||
|
|
||||||
|
editTemplate(template?: OcrTemplate) {
|
||||||
|
if (template && !this.userCanEdit(template)) return
|
||||||
|
const modal = this.modalService.open(OcrTemplateEditorComponent, {
|
||||||
|
backdrop: 'static',
|
||||||
|
keyboard: false,
|
||||||
|
size: 'xxl',
|
||||||
|
fullscreen: 'lg',
|
||||||
|
scrollable: true,
|
||||||
|
ariaLabelledBy: 'ocr-template-editor-title',
|
||||||
|
beforeDismiss: () => {
|
||||||
|
const editor: OcrTemplateEditorComponent = modal.componentInstance
|
||||||
|
if (editor.saving()) return false
|
||||||
|
if (!editor.isDirty) return true
|
||||||
|
return firstValueFrom(
|
||||||
|
this.dirtyFormGuard.confirmChanges(undefined, $localize`Close`)
|
||||||
|
)
|
||||||
|
},
|
||||||
|
})
|
||||||
|
modal.componentInstance.object = template
|
||||||
|
modal.componentInstance.succeeded
|
||||||
|
.pipe(takeUntil(this.unsubscribeNotifier))
|
||||||
|
.subscribe((saved: OcrTemplate) => {
|
||||||
|
this.toastService.showSuccess(
|
||||||
|
$localize`Saved OCR template "${saved.name}".`
|
||||||
|
)
|
||||||
|
this.ocrTemplateService.clearCache()
|
||||||
|
this.reload()
|
||||||
|
})
|
||||||
|
modal.componentInstance.failed
|
||||||
|
.pipe(takeUntil(this.unsubscribeNotifier))
|
||||||
|
.subscribe((e) => {
|
||||||
|
this.toastService.showError($localize`Error saving OCR template.`, e)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
toggleTemplateEnabled(template: OcrTemplate) {
|
||||||
|
if (!this.userCanEdit(template)) return
|
||||||
|
this.ocrTemplateService
|
||||||
|
.patch({ id: template.id, enabled: template.enabled } as OcrTemplate)
|
||||||
|
.subscribe({
|
||||||
|
next: () => {
|
||||||
|
this.toastService.showSuccess(
|
||||||
|
template.enabled
|
||||||
|
? $localize`Enabled OCR template "${template.name}"`
|
||||||
|
: $localize`Disabled OCR template "${template.name}"`
|
||||||
|
)
|
||||||
|
this.reload()
|
||||||
|
},
|
||||||
|
error: (e) => {
|
||||||
|
this.toastService.showError(
|
||||||
|
$localize`Error toggling OCR template "${template.name}".`,
|
||||||
|
e
|
||||||
|
)
|
||||||
|
this.reload()
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
deleteTemplate(template: OcrTemplate) {
|
||||||
|
if (
|
||||||
|
!this.permissionsService.currentUserCan(
|
||||||
|
PermissionAction.Delete,
|
||||||
|
PermissionType.OcrTemplate
|
||||||
|
) ||
|
||||||
|
!this.permissionsService.currentUserOwnsObject(template)
|
||||||
|
)
|
||||||
|
return
|
||||||
|
const modal = this.modalService.open(ConfirmDialogComponent, {
|
||||||
|
backdrop: 'static',
|
||||||
|
})
|
||||||
|
modal.componentInstance.title = $localize`Confirm delete OCR template`
|
||||||
|
modal.componentInstance.messageBold = $localize`This operation will permanently delete this OCR template.`
|
||||||
|
modal.componentInstance.message = $localize`This operation cannot be undone.`
|
||||||
|
modal.componentInstance.btnClass = 'btn-danger'
|
||||||
|
modal.componentInstance.btnCaption = $localize`Proceed`
|
||||||
|
modal.componentInstance.confirmClicked.subscribe(() => {
|
||||||
|
modal.componentInstance.buttonsEnabled.set(false)
|
||||||
|
this.ocrTemplateService.delete(template).subscribe({
|
||||||
|
next: () => {
|
||||||
|
modal.close()
|
||||||
|
this.toastService.showSuccess(
|
||||||
|
$localize`Deleted OCR template "${template.name}".`
|
||||||
|
)
|
||||||
|
this.ocrTemplateService.clearCache()
|
||||||
|
this.reload()
|
||||||
|
},
|
||||||
|
error: (e) => {
|
||||||
|
modal.componentInstance.buttonsEnabled.set(true)
|
||||||
|
this.toastService.showError(
|
||||||
|
$localize`Error deleting OCR template "${template.name}".`,
|
||||||
|
e
|
||||||
|
)
|
||||||
|
},
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
userCanEdit(template: OcrTemplate): boolean {
|
||||||
|
return (
|
||||||
|
this.permissionsService.currentUserCan(
|
||||||
|
PermissionAction.Change,
|
||||||
|
PermissionType.OcrTemplate
|
||||||
|
) &&
|
||||||
|
this.permissionsService.currentUserHasObjectPermissions(
|
||||||
|
PermissionAction.Change,
|
||||||
|
template
|
||||||
|
)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,8 +1,14 @@
|
|||||||
import { ObjectWithId } from './object-with-id'
|
import { ObjectWithId } from './object-with-id'
|
||||||
import { User } from './user'
|
import { User } from './user'
|
||||||
|
|
||||||
|
export enum NoteFormat {
|
||||||
|
Plain = 'plain',
|
||||||
|
Markdown = 'markdown',
|
||||||
|
}
|
||||||
|
|
||||||
export interface DocumentNote extends ObjectWithId {
|
export interface DocumentNote extends ObjectWithId {
|
||||||
created?: Date
|
created?: Date
|
||||||
note?: string
|
note?: string
|
||||||
user?: User
|
user?: User
|
||||||
|
format?: NoteFormat
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,115 @@
|
|||||||
|
import { CustomFieldDataType } from './custom-field'
|
||||||
|
import { MatchingModel } from './matching-model'
|
||||||
|
import { ObjectWithPermissions } from './object-with-permissions'
|
||||||
|
|
||||||
|
export enum OcrZoneTarget {
|
||||||
|
CustomField = 'custom_field',
|
||||||
|
Title = 'title',
|
||||||
|
Asn = 'asn',
|
||||||
|
Created = 'created',
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum OcrZoneTransform {
|
||||||
|
None = 'none',
|
||||||
|
Strip = 'strip',
|
||||||
|
Uppercase = 'uppercase',
|
||||||
|
Lowercase = 'lowercase',
|
||||||
|
Numeric = 'numeric',
|
||||||
|
StripPunctuation = 'strip_punctuation',
|
||||||
|
Date = 'date',
|
||||||
|
QrCode = 'qr_code',
|
||||||
|
}
|
||||||
|
|
||||||
|
export const DEFAULT_OCR_ZONE_LANGUAGE = 'eng'
|
||||||
|
|
||||||
|
/** The field a zone writes to, keyed by OcrTemplate.combine_formats. */
|
||||||
|
export function getZoneFieldKey(zone: OcrTemplateZone): string | null {
|
||||||
|
if (zone.target !== OcrZoneTarget.CustomField) return zone.target
|
||||||
|
return zone.custom_field === null ? null : String(zone.custom_field)
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Custom field types zone OCR can write to. See models.py OCR_SUPPORTED_FIELD_TYPES. */
|
||||||
|
export const OCR_SUPPORTED_FIELD_TYPES: CustomFieldDataType[] = [
|
||||||
|
CustomFieldDataType.String,
|
||||||
|
CustomFieldDataType.Url,
|
||||||
|
CustomFieldDataType.Date,
|
||||||
|
CustomFieldDataType.Integer,
|
||||||
|
CustomFieldDataType.Float,
|
||||||
|
CustomFieldDataType.Monetary,
|
||||||
|
CustomFieldDataType.LongText,
|
||||||
|
CustomFieldDataType.Boolean,
|
||||||
|
]
|
||||||
|
|
||||||
|
export const OCR_BUILTIN_TARGETS = [
|
||||||
|
{ id: OcrZoneTarget.Title, name: $localize`Title` },
|
||||||
|
{ id: OcrZoneTarget.Asn, name: $localize`Archive serial number` },
|
||||||
|
{ id: OcrZoneTarget.Created, name: $localize`Date created` },
|
||||||
|
]
|
||||||
|
|
||||||
|
export interface OcrTemplateZone {
|
||||||
|
id?: number
|
||||||
|
name: string
|
||||||
|
target: OcrZoneTarget
|
||||||
|
custom_field: number | null
|
||||||
|
page?: number
|
||||||
|
x: number
|
||||||
|
y: number
|
||||||
|
width: number
|
||||||
|
height: number
|
||||||
|
ocr_language: string
|
||||||
|
transform: OcrZoneTransform
|
||||||
|
date_format?: string
|
||||||
|
validation_regex: string
|
||||||
|
order: number
|
||||||
|
zone_source_width?: number
|
||||||
|
zone_source_height?: number
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface OcrTemplate extends MatchingModel, ObjectWithPermissions {
|
||||||
|
name: string
|
||||||
|
sample_document: number | null
|
||||||
|
source_width: number
|
||||||
|
source_height: number
|
||||||
|
enabled: boolean
|
||||||
|
combine_formats?: Record<string, string>
|
||||||
|
created?: string
|
||||||
|
updated?: string
|
||||||
|
zones: OcrTemplateZone[]
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ZoneTestRequest {
|
||||||
|
name: string
|
||||||
|
x: number
|
||||||
|
y: number
|
||||||
|
width: number
|
||||||
|
height: number
|
||||||
|
page: number
|
||||||
|
ocr_language: string
|
||||||
|
transform: OcrZoneTransform
|
||||||
|
date_format?: string
|
||||||
|
validation_regex: string
|
||||||
|
zone_source_width?: number
|
||||||
|
zone_source_height?: number
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface OcrZoneTestResult {
|
||||||
|
raw_text?: string | null
|
||||||
|
value?: string | null
|
||||||
|
regex?: string
|
||||||
|
regex_match?: boolean | null
|
||||||
|
error?: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface OcrZoneRunResult {
|
||||||
|
template: string
|
||||||
|
zone: string
|
||||||
|
custom_field: string
|
||||||
|
value: string | number | boolean | null
|
||||||
|
reason?: string | null
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface OcrZoneRunResponse {
|
||||||
|
status: 'completed' | 'skipped'
|
||||||
|
reason?: 'no_template'
|
||||||
|
results: OcrZoneRunResult[]
|
||||||
|
}
|
||||||
@@ -35,6 +35,7 @@ export enum HideableSidebarItemID {
|
|||||||
SavedViews = 'saved_views',
|
SavedViews = 'saved_views',
|
||||||
ShareLinks = 'share_links',
|
ShareLinks = 'share_links',
|
||||||
Workflows = 'workflows',
|
Workflows = 'workflows',
|
||||||
|
OcrTemplates = 'ocr_templates',
|
||||||
Mail = 'mail',
|
Mail = 'mail',
|
||||||
Documentation = 'documentation',
|
Documentation = 'documentation',
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ export enum WorkflowTriggerType {
|
|||||||
DocumentAdded = 2,
|
DocumentAdded = 2,
|
||||||
DocumentUpdated = 3,
|
DocumentUpdated = 3,
|
||||||
Scheduled = 4,
|
Scheduled = 4,
|
||||||
|
Manual = 5,
|
||||||
}
|
}
|
||||||
|
|
||||||
export enum ScheduleDateField {
|
export enum ScheduleDateField {
|
||||||
|
|||||||
@@ -3,12 +3,16 @@ import { NgbModal } from '@ng-bootstrap/ng-bootstrap'
|
|||||||
import { DirtyCheckGuard } from '@ngneat/dirty-check-forms'
|
import { DirtyCheckGuard } from '@ngneat/dirty-check-forms'
|
||||||
import { Observable, Subject } from 'rxjs'
|
import { Observable, Subject } from 'rxjs'
|
||||||
import { ConfirmDialogComponent } from 'src/app/components/common/confirm-dialog/confirm-dialog.component'
|
import { ConfirmDialogComponent } from 'src/app/components/common/confirm-dialog/confirm-dialog.component'
|
||||||
|
import { ActivatedRouteSnapshot } from '@angular/router'
|
||||||
|
|
||||||
@Injectable({ providedIn: 'root' })
|
@Injectable({ providedIn: 'root' })
|
||||||
export class DirtyFormGuard extends DirtyCheckGuard {
|
export class DirtyFormGuard extends DirtyCheckGuard {
|
||||||
private modalService = inject(NgbModal)
|
private modalService = inject(NgbModal)
|
||||||
|
|
||||||
confirmChanges(): Observable<boolean> {
|
confirmChanges(
|
||||||
|
_currentRoute?: ActivatedRouteSnapshot,
|
||||||
|
leaveLabel: string = $localize`Leave page`
|
||||||
|
): Observable<boolean> {
|
||||||
let modal = this.modalService.open(ConfirmDialogComponent, {
|
let modal = this.modalService.open(ConfirmDialogComponent, {
|
||||||
backdrop: 'static',
|
backdrop: 'static',
|
||||||
})
|
})
|
||||||
@@ -16,7 +20,7 @@ export class DirtyFormGuard extends DirtyCheckGuard {
|
|||||||
modal.componentInstance.messageBold = $localize`You have unsaved changes.`
|
modal.componentInstance.messageBold = $localize`You have unsaved changes.`
|
||||||
modal.componentInstance.message = $localize`Are you sure you want to leave?`
|
modal.componentInstance.message = $localize`Are you sure you want to leave?`
|
||||||
modal.componentInstance.btnClass = 'btn-warning'
|
modal.componentInstance.btnClass = 'btn-warning'
|
||||||
modal.componentInstance.btnCaption = $localize`Leave page`
|
modal.componentInstance.btnCaption = leaveLabel
|
||||||
modal.componentInstance.confirmClicked.subscribe(() => {
|
modal.componentInstance.confirmClicked.subscribe(() => {
|
||||||
modal.componentInstance.buttonsEnabled.set(false)
|
modal.componentInstance.buttonsEnabled.set(false)
|
||||||
modal.close()
|
modal.close()
|
||||||
|
|||||||
@@ -240,7 +240,7 @@ describe('OpenDocumentsService', () => {
|
|||||||
expect(refreshed.tags).toEqual([4])
|
expect(refreshed.tags).toEqual([4])
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should handle error on refresh documents', () => {
|
it('keeps documents open after a network error during refresh', () => {
|
||||||
subscriptions.push(
|
subscriptions.push(
|
||||||
openDocumentsService.openDocument(documents[1]).subscribe()
|
openDocumentsService.openDocument(documents[1]).subscribe()
|
||||||
)
|
)
|
||||||
@@ -250,7 +250,63 @@ describe('OpenDocumentsService', () => {
|
|||||||
)
|
)
|
||||||
expect(req.request.method).toEqual('GET')
|
expect(req.request.method).toEqual('GET')
|
||||||
req.error(new ErrorEvent('timeout'))
|
req.error(new ErrorEvent('timeout'))
|
||||||
|
expect(openDocumentsService.getOpenDocument(documents[1].id)).toBe(
|
||||||
|
documents[1]
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it.each([500, 403])(
|
||||||
|
'keeps documents open after HTTP %s during refresh',
|
||||||
|
(status) => {
|
||||||
|
const doc = { ...documents[0] }
|
||||||
|
openDocumentsService.openDocument(doc).subscribe()
|
||||||
|
openDocumentsService.refreshDocument(doc.id)
|
||||||
|
httpTestingController
|
||||||
|
.expectOne(
|
||||||
|
`${environment.apiBaseUrl}documents/${doc.id}/?full_perms=true`
|
||||||
|
)
|
||||||
|
.flush({}, { status, statusText: 'Error' })
|
||||||
|
expect(openDocumentsService.getOpenDocument(doc.id)).toBe(doc)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
it('preserves unsaved edits when a refreshed document no longer exists', () => {
|
||||||
|
const doc = { ...documents[0], title: 'Unsaved title' }
|
||||||
|
openDocumentsService.openDocument(doc).subscribe()
|
||||||
|
openDocumentsService.setDirty(doc, true, { title: doc.title })
|
||||||
|
openDocumentsService.refreshDocument(doc.id)
|
||||||
|
httpTestingController
|
||||||
|
.expectOne(
|
||||||
|
`${environment.apiBaseUrl}documents/${doc.id}/?full_perms=true`
|
||||||
|
)
|
||||||
|
.flush({}, { status: 404, statusText: 'Not Found' })
|
||||||
|
expect(openDocumentsService.getOpenDocument(doc.id)).toBe(doc)
|
||||||
|
expect(openDocumentsService.isDirty(doc)).toBe(true)
|
||||||
|
expect(
|
||||||
|
JSON.parse(sessionStorage.getItem(OPEN_DOCUMENT_SERVICE.DOCUMENTS))[0]
|
||||||
|
.title
|
||||||
|
).toBe('Unsaved title')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('removes only the missing document when tab positions change during refresh', () => {
|
||||||
|
const first = { ...documents[0] }
|
||||||
|
const second = { ...documents[1] }
|
||||||
|
openDocumentsService.openDocument(first).subscribe()
|
||||||
|
openDocumentsService.openDocument(second).subscribe()
|
||||||
|
openDocumentsService.refreshDocument(first.id)
|
||||||
|
openDocumentsService.refreshDocument(second.id)
|
||||||
|
const firstRequest = httpTestingController.expectOne(
|
||||||
|
`${environment.apiBaseUrl}documents/${first.id}/?full_perms=true`
|
||||||
|
)
|
||||||
|
const secondRequest = httpTestingController.expectOne(
|
||||||
|
`${environment.apiBaseUrl}documents/${second.id}/?full_perms=true`
|
||||||
|
)
|
||||||
|
openDocumentsService.closeDocument(second).subscribe()
|
||||||
|
firstRequest.flush({}, { status: 404, statusText: 'Not Found' })
|
||||||
expect(openDocumentsService.getOpenDocuments()).toHaveLength(0)
|
expect(openDocumentsService.getOpenDocuments()).toHaveLength(0)
|
||||||
|
openDocumentsService.openDocument(first).subscribe()
|
||||||
|
secondRequest.flush({}, { status: 404, statusText: 'Not Found' })
|
||||||
|
expect(openDocumentsService.getOpenDocuments()).toEqual([first])
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should log error on sessionStorage save', () => {
|
it('should log error on sessionStorage save', () => {
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import { HttpErrorResponse } from '@angular/common/http'
|
||||||
import { Injectable, inject, signal } from '@angular/core'
|
import { Injectable, inject, signal } from '@angular/core'
|
||||||
import { NgbModal } from '@ng-bootstrap/ng-bootstrap'
|
import { NgbModal } from '@ng-bootstrap/ng-bootstrap'
|
||||||
import { Observable, Subject, of } from 'rxjs'
|
import { Observable, Subject, of } from 'rxjs'
|
||||||
@@ -61,7 +62,12 @@ export class OpenDocumentsService {
|
|||||||
Object.assign(openDoc, doc, unsavedEdits)
|
Object.assign(openDoc, doc, unsavedEdits)
|
||||||
this.save()
|
this.save()
|
||||||
},
|
},
|
||||||
error: () => {
|
error: (error: HttpErrorResponse) => {
|
||||||
|
if (error.status !== 404) return
|
||||||
|
|
||||||
|
const index = this.openDocuments.findIndex((doc) => doc.id === id)
|
||||||
|
if (index === -1 || this.isDirty(this.openDocuments[index])) return
|
||||||
|
|
||||||
this.openDocuments.splice(index, 1)
|
this.openDocuments.splice(index, 1)
|
||||||
this.save()
|
this.save()
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -283,6 +283,10 @@ describe('PermissionsService', () => {
|
|||||||
'view_workflow',
|
'view_workflow',
|
||||||
'change_workflow',
|
'change_workflow',
|
||||||
'delete_workflow',
|
'delete_workflow',
|
||||||
|
'add_ocrtemplate',
|
||||||
|
'view_ocrtemplate',
|
||||||
|
'change_ocrtemplate',
|
||||||
|
'delete_ocrtemplate',
|
||||||
'add_customfield',
|
'add_customfield',
|
||||||
'view_customfield',
|
'view_customfield',
|
||||||
'change_customfield',
|
'change_customfield',
|
||||||
|
|||||||
@@ -29,6 +29,7 @@ export enum PermissionType {
|
|||||||
ShareLinkBundle = '%s_sharelinkbundle',
|
ShareLinkBundle = '%s_sharelinkbundle',
|
||||||
CustomField = '%s_customfield',
|
CustomField = '%s_customfield',
|
||||||
Workflow = '%s_workflow',
|
Workflow = '%s_workflow',
|
||||||
|
OcrTemplate = '%s_ocrtemplate',
|
||||||
ProcessedMail = '%s_processedmail',
|
ProcessedMail = '%s_processedmail',
|
||||||
GlobalStatistics = '%s_global_statistics',
|
GlobalStatistics = '%s_global_statistics',
|
||||||
SystemMonitoring = '%s_system_monitoring',
|
SystemMonitoring = '%s_system_monitoring',
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
import { HttpTestingController } from '@angular/common/http/testing'
|
import { HttpTestingController } from '@angular/common/http/testing'
|
||||||
import { TestBed } from '@angular/core/testing'
|
import { TestBed } from '@angular/core/testing'
|
||||||
import { Subscription } from 'rxjs'
|
import { Subscription } from 'rxjs'
|
||||||
|
import { NoteFormat } from 'src/app/data/document-note'
|
||||||
import { environment } from 'src/environments/environment'
|
import { environment } from 'src/environments/environment'
|
||||||
import { commonAbstractPaperlessServiceTests } from './abstract-paperless-service.spec'
|
import { commonAbstractPaperlessServiceTests } from './abstract-paperless-service.spec'
|
||||||
import { DocumentNotesService } from './document-notes.service'
|
import { DocumentNotesService } from './document-notes.service'
|
||||||
@@ -50,6 +51,7 @@ describe(`Additional service tests for DocumentNotesService`, () => {
|
|||||||
expect(req.request.method).toEqual('POST')
|
expect(req.request.method).toEqual('POST')
|
||||||
expect(req.request.body).toEqual({
|
expect(req.request.body).toEqual({
|
||||||
note: content,
|
note: content,
|
||||||
|
format: NoteFormat.Markdown,
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
import { HttpParams } from '@angular/common/http'
|
import { HttpParams } from '@angular/common/http'
|
||||||
import { Injectable } from '@angular/core'
|
import { Injectable } from '@angular/core'
|
||||||
import { Observable } from 'rxjs'
|
import { Observable } from 'rxjs'
|
||||||
import { DocumentNote } from 'src/app/data/document-note'
|
import { DocumentNote, NoteFormat } from 'src/app/data/document-note'
|
||||||
import { AbstractPaperlessService } from './abstract-paperless-service'
|
import { AbstractPaperlessService } from './abstract-paperless-service'
|
||||||
|
|
||||||
@Injectable({
|
@Injectable({
|
||||||
@@ -22,6 +22,7 @@ export class DocumentNotesService extends AbstractPaperlessService<DocumentNote>
|
|||||||
addNote(id: number, note: string): Observable<DocumentNote[]> {
|
addNote(id: number, note: string): Observable<DocumentNote[]> {
|
||||||
return this.http.post<DocumentNote[]>(this.getResourceUrl(id, 'notes'), {
|
return this.http.post<DocumentNote[]>(this.getResourceUrl(id, 'notes'), {
|
||||||
note: note,
|
note: note,
|
||||||
|
format: NoteFormat.Markdown,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -290,6 +290,7 @@ describe(`DocumentService`, () => {
|
|||||||
expect(req.request.method).toEqual('POST')
|
expect(req.request.method).toEqual('POST')
|
||||||
expect(req.request.body).toEqual({
|
expect(req.request.body).toEqual({
|
||||||
documents: ids,
|
documents: ids,
|
||||||
|
from_webui: true,
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -303,6 +304,7 @@ describe(`DocumentService`, () => {
|
|||||||
expect(req.request.body).toEqual({
|
expect(req.request.body).toEqual({
|
||||||
documents: ids,
|
documents: ids,
|
||||||
remote_ocr: false,
|
remote_ocr: false,
|
||||||
|
from_webui: true,
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -317,6 +319,28 @@ describe(`DocumentService`, () => {
|
|||||||
expect(req.request.body).toEqual({
|
expect(req.request.body).toEqual({
|
||||||
documents: ids,
|
documents: ids,
|
||||||
remote_ocr: true,
|
remote_ocr: true,
|
||||||
|
from_webui: true,
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it.each([null, 3])('should queue zone OCR with template %s', (template) => {
|
||||||
|
const queued = jest.fn()
|
||||||
|
subscription = service
|
||||||
|
.runZoneOcrDocuments({ documents: [1, 2] }, template)
|
||||||
|
.subscribe(queued)
|
||||||
|
const req = httpTestingController.expectOne(
|
||||||
|
`${environment.apiBaseUrl}${endpoint}/run_zone_ocr/`
|
||||||
|
)
|
||||||
|
expect(req.request.method).toBe('POST')
|
||||||
|
expect(req.request.body).toEqual({
|
||||||
|
documents: [1, 2],
|
||||||
|
...(template ? { template } : {}),
|
||||||
|
from_webui: true,
|
||||||
|
})
|
||||||
|
req.flush({ result: 'OK', task_id: 'zone-ocr-task' })
|
||||||
|
expect(queued).toHaveBeenCalledWith({
|
||||||
|
result: 'OK',
|
||||||
|
task_id: 'zone-ocr-task',
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -331,6 +355,7 @@ describe(`DocumentService`, () => {
|
|||||||
documents: ids,
|
documents: ids,
|
||||||
degrees: 90,
|
degrees: 90,
|
||||||
source_mode: 'latest_version',
|
source_mode: 'latest_version',
|
||||||
|
from_webui: true,
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -346,6 +371,7 @@ describe(`DocumentService`, () => {
|
|||||||
documents: ids,
|
documents: ids,
|
||||||
metadata_document_id: 1,
|
metadata_document_id: 1,
|
||||||
delete_originals: true,
|
delete_originals: true,
|
||||||
|
from_webui: true,
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -359,6 +385,7 @@ describe(`DocumentService`, () => {
|
|||||||
expect(req.request.body).toEqual({
|
expect(req.request.body).toEqual({
|
||||||
documents: ids,
|
documents: ids,
|
||||||
root_document_id: 2,
|
root_document_id: 2,
|
||||||
|
from_webui: true,
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -374,6 +401,7 @@ describe(`DocumentService`, () => {
|
|||||||
documents: ids,
|
documents: ids,
|
||||||
root_document_id: 2,
|
root_document_id: 2,
|
||||||
version_label: 'Imported',
|
version_label: 'Imported',
|
||||||
|
from_webui: true,
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -388,6 +416,7 @@ describe(`DocumentService`, () => {
|
|||||||
expect(req.request.body).toEqual({
|
expect(req.request.body).toEqual({
|
||||||
documents: ids,
|
documents: ids,
|
||||||
operations: [{ page: 1, rotate: 90, doc: 0 }],
|
operations: [{ page: 1, rotate: 90, doc: 0 }],
|
||||||
|
from_webui: true,
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -403,6 +432,7 @@ describe(`DocumentService`, () => {
|
|||||||
documents: ids,
|
documents: ids,
|
||||||
password: 'secret',
|
password: 'secret',
|
||||||
update_document: true,
|
update_document: true,
|
||||||
|
from_webui: true,
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -565,6 +595,20 @@ describe(`DocumentService`, () => {
|
|||||||
|
|
||||||
req.flush('task-id')
|
req.flush('task-id')
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('should call appropriate api endpoint for running zone OCR', () => {
|
||||||
|
const url = `${environment.apiBaseUrl}${endpoint}/${documents[0].id}/run-zone-ocr/`
|
||||||
|
subscription = service.runZoneOcr(documents[0].id).subscribe()
|
||||||
|
let req = httpTestingController.expectOne(url)
|
||||||
|
expect(req.request.method).toEqual('POST')
|
||||||
|
expect(req.request.body).toEqual({})
|
||||||
|
req.flush({ status: 'completed', results: [] })
|
||||||
|
|
||||||
|
subscription = service.runZoneOcr(documents[0].id, 3, 10).subscribe()
|
||||||
|
req = httpTestingController.expectOne(`${url}?version=10`)
|
||||||
|
expect(req.request.body).toEqual({ template: 3 })
|
||||||
|
req.flush({ status: 'completed', results: [] })
|
||||||
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should construct sort fields respecting permissions', () => {
|
it('should construct sort fields respecting permissions', () => {
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ import {
|
|||||||
import { DocumentMetadata } from 'src/app/data/document-metadata'
|
import { DocumentMetadata } from 'src/app/data/document-metadata'
|
||||||
import { DocumentSuggestions } from 'src/app/data/document-suggestions'
|
import { DocumentSuggestions } from 'src/app/data/document-suggestions'
|
||||||
import { FilterRule } from 'src/app/data/filter-rule'
|
import { FilterRule } from 'src/app/data/filter-rule'
|
||||||
|
import { OcrZoneRunResponse } from 'src/app/data/ocr-template'
|
||||||
import { Results, SelectionData } from 'src/app/data/results'
|
import { Results, SelectionData } from 'src/app/data/results'
|
||||||
import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
|
import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
|
||||||
import { BulkOperationResponse } from '../../data/bulk-operation'
|
import { BulkOperationResponse } from '../../data/bulk-operation'
|
||||||
@@ -39,6 +40,7 @@ export type DocumentBulkEditMethod =
|
|||||||
| 'modify_tags'
|
| 'modify_tags'
|
||||||
| 'modify_custom_fields'
|
| 'modify_custom_fields'
|
||||||
| 'set_permissions'
|
| 'set_permissions'
|
||||||
|
| 'run_workflow'
|
||||||
|
|
||||||
export interface MergeDocumentsRequest {
|
export interface MergeDocumentsRequest {
|
||||||
metadata_document_id?: number
|
metadata_document_id?: number
|
||||||
@@ -350,19 +352,50 @@ export class DocumentService extends AbstractPaperlessService<Document> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
deleteDocuments(selection: DocumentSelectionQuery) {
|
deleteDocuments(selection: DocumentSelectionQuery) {
|
||||||
return this.http.post(this.getResourceUrl(null, 'delete'), {
|
return this.http.post<BulkOperationResponse>(
|
||||||
...selection,
|
this.getResourceUrl(null, 'delete'),
|
||||||
})
|
{ ...selection, from_webui: true }
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
reprocessDocuments(
|
reprocessDocuments(
|
||||||
selection: DocumentSelectionQuery,
|
selection: DocumentSelectionQuery,
|
||||||
remoteOcr: boolean = false
|
remoteOcr: boolean = false
|
||||||
) {
|
) {
|
||||||
return this.http.post(this.getResourceUrl(null, 'reprocess'), {
|
return this.http.post<BulkOperationResponse>(
|
||||||
|
this.getResourceUrl(null, 'reprocess'),
|
||||||
|
{
|
||||||
...selection,
|
...selection,
|
||||||
remote_ocr: remoteOcr,
|
remote_ocr: remoteOcr,
|
||||||
})
|
from_webui: true,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
runZoneOcrDocuments(
|
||||||
|
selection: DocumentSelectionQuery,
|
||||||
|
templateId: number | null = null
|
||||||
|
) {
|
||||||
|
return this.http.post<BulkOperationResponse>(
|
||||||
|
this.getResourceUrl(null, 'run_zone_ocr'),
|
||||||
|
{
|
||||||
|
...selection,
|
||||||
|
...(templateId ? { template: templateId } : {}),
|
||||||
|
from_webui: true,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
runZoneOcr(
|
||||||
|
id: number,
|
||||||
|
templateId: number | null = null,
|
||||||
|
versionId: number | null = null
|
||||||
|
): Observable<OcrZoneRunResponse> {
|
||||||
|
return this.http.post<OcrZoneRunResponse>(
|
||||||
|
this.getResourceUrl(id, 'run-zone-ocr'),
|
||||||
|
templateId ? { template: templateId } : {},
|
||||||
|
{ params: versionId ? { version: versionId.toString() } : {} }
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
rotateDocuments(
|
rotateDocuments(
|
||||||
@@ -370,18 +403,26 @@ export class DocumentService extends AbstractPaperlessService<Document> {
|
|||||||
degrees: number,
|
degrees: number,
|
||||||
sourceMode: BulkEditSourceMode = BulkEditSourceMode.LATEST_VERSION
|
sourceMode: BulkEditSourceMode = BulkEditSourceMode.LATEST_VERSION
|
||||||
) {
|
) {
|
||||||
return this.http.post(this.getResourceUrl(null, 'rotate'), {
|
return this.http.post<BulkOperationResponse>(
|
||||||
|
this.getResourceUrl(null, 'rotate'),
|
||||||
|
{
|
||||||
...selection,
|
...selection,
|
||||||
degrees,
|
degrees,
|
||||||
source_mode: sourceMode,
|
source_mode: sourceMode,
|
||||||
})
|
from_webui: true,
|
||||||
|
}
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
mergeDocuments(ids: number[], request: MergeDocumentsRequest = {}) {
|
mergeDocuments(ids: number[], request: MergeDocumentsRequest = {}) {
|
||||||
return this.http.post(this.getResourceUrl(null, 'merge'), {
|
return this.http.post<BulkOperationResponse>(
|
||||||
|
this.getResourceUrl(null, 'merge'),
|
||||||
|
{
|
||||||
documents: ids,
|
documents: ids,
|
||||||
...request,
|
...request,
|
||||||
})
|
from_webui: true,
|
||||||
|
}
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
mergeDocumentsAsVersions(
|
mergeDocumentsAsVersions(
|
||||||
@@ -389,28 +430,40 @@ export class DocumentService extends AbstractPaperlessService<Document> {
|
|||||||
rootDocumentId: number,
|
rootDocumentId: number,
|
||||||
versionLabel?: string
|
versionLabel?: string
|
||||||
) {
|
) {
|
||||||
return this.http.post(this.getResourceUrl(null, 'merge_as_versions'), {
|
return this.http.post<BulkOperationResponse>(
|
||||||
|
this.getResourceUrl(null, 'merge_as_versions'),
|
||||||
|
{
|
||||||
documents: ids,
|
documents: ids,
|
||||||
root_document_id: rootDocumentId,
|
root_document_id: rootDocumentId,
|
||||||
...(versionLabel ? { version_label: versionLabel } : {}),
|
...(versionLabel ? { version_label: versionLabel } : {}),
|
||||||
})
|
from_webui: true,
|
||||||
|
}
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
editPdfDocuments(ids: number[], request: EditPdfDocumentsRequest) {
|
editPdfDocuments(ids: number[], request: EditPdfDocumentsRequest) {
|
||||||
return this.http.post(this.getResourceUrl(null, 'edit_pdf'), {
|
return this.http.post<BulkOperationResponse>(
|
||||||
|
this.getResourceUrl(null, 'edit_pdf'),
|
||||||
|
{
|
||||||
documents: ids,
|
documents: ids,
|
||||||
...request,
|
...request,
|
||||||
})
|
from_webui: true,
|
||||||
|
}
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
removePasswordDocuments(
|
removePasswordDocuments(
|
||||||
ids: number[],
|
ids: number[],
|
||||||
request: RemovePasswordDocumentsRequest
|
request: RemovePasswordDocumentsRequest
|
||||||
) {
|
) {
|
||||||
return this.http.post(this.getResourceUrl(null, 'remove_password'), {
|
return this.http.post<BulkOperationResponse>(
|
||||||
|
this.getResourceUrl(null, 'remove_password'),
|
||||||
|
{
|
||||||
documents: ids,
|
documents: ids,
|
||||||
...request,
|
...request,
|
||||||
})
|
from_webui: true,
|
||||||
|
}
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
getSelectionData(
|
getSelectionData(
|
||||||
|
|||||||
@@ -0,0 +1,78 @@
|
|||||||
|
import { provideHttpClient } from '@angular/common/http'
|
||||||
|
import {
|
||||||
|
HttpTestingController,
|
||||||
|
provideHttpClientTesting,
|
||||||
|
} from '@angular/common/http/testing'
|
||||||
|
import { TestBed } from '@angular/core/testing'
|
||||||
|
import { OcrZoneTransform, ZoneTestRequest } from 'src/app/data/ocr-template'
|
||||||
|
import { environment } from 'src/environments/environment'
|
||||||
|
import { OcrTemplateService } from './ocr-template.service'
|
||||||
|
|
||||||
|
describe('OcrTemplateService', () => {
|
||||||
|
let service: OcrTemplateService
|
||||||
|
let http: HttpTestingController
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
TestBed.configureTestingModule({
|
||||||
|
providers: [provideHttpClient(), provideHttpClientTesting()],
|
||||||
|
})
|
||||||
|
service = TestBed.inject(OcrTemplateService)
|
||||||
|
http = TestBed.inject(HttpTestingController)
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => http.verify())
|
||||||
|
|
||||||
|
it('builds page image URLs with zero-based page numbers', () => {
|
||||||
|
expect(service.getPageImageUrl(12, 0)).toBe(
|
||||||
|
`${environment.apiBaseUrl}ocr_templates/document-page-image/12/0/`
|
||||||
|
)
|
||||||
|
expect(service.getPageImageUrl(12, 2)).toBe(
|
||||||
|
`${environment.apiBaseUrl}ocr_templates/document-page-image/12/2/`
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('posts a zone test and returns the extraction result', () => {
|
||||||
|
const zone: ZoneTestRequest = {
|
||||||
|
name: 'Total',
|
||||||
|
x: 10,
|
||||||
|
y: 20,
|
||||||
|
width: 100,
|
||||||
|
height: 50,
|
||||||
|
page: -1,
|
||||||
|
ocr_language: 'eng',
|
||||||
|
transform: OcrZoneTransform.Numeric,
|
||||||
|
validation_regex: '\\d+',
|
||||||
|
zone_source_width: 1000,
|
||||||
|
zone_source_height: 1500,
|
||||||
|
}
|
||||||
|
const result = {
|
||||||
|
raw_text: 'Total: 123',
|
||||||
|
value: '123',
|
||||||
|
regex: '\\d+',
|
||||||
|
regex_match: true,
|
||||||
|
}
|
||||||
|
const next = jest.fn()
|
||||||
|
service.testZone(12, zone).subscribe(next)
|
||||||
|
const request = http.expectOne(
|
||||||
|
`${environment.apiBaseUrl}ocr_templates/test-zone/`
|
||||||
|
)
|
||||||
|
expect(request.request.method).toBe('POST')
|
||||||
|
expect(request.request.body).toEqual({ document: 12, zone })
|
||||||
|
request.flush(result)
|
||||||
|
expect(next).toHaveBeenCalledWith(result)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('passes zone-test failures to the caller', () => {
|
||||||
|
const error = jest.fn()
|
||||||
|
service.testZone(12, {} as ZoneTestRequest).subscribe({ error })
|
||||||
|
http
|
||||||
|
.expectOne(`${environment.apiBaseUrl}ocr_templates/test-zone/`)
|
||||||
|
.flush(
|
||||||
|
{ error: 'Invalid zone' },
|
||||||
|
{ status: 400, statusText: 'Bad Request' }
|
||||||
|
)
|
||||||
|
expect(error).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({ status: 400, error: { error: 'Invalid zone' } })
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
import { Injectable } from '@angular/core'
|
||||||
|
import { Observable } from 'rxjs'
|
||||||
|
import {
|
||||||
|
OcrTemplate,
|
||||||
|
OcrZoneTestResult,
|
||||||
|
ZoneTestRequest,
|
||||||
|
} from '../../data/ocr-template'
|
||||||
|
import { AbstractPaperlessService } from './abstract-paperless-service'
|
||||||
|
|
||||||
|
@Injectable({ providedIn: 'root' })
|
||||||
|
export class OcrTemplateService extends AbstractPaperlessService<OcrTemplate> {
|
||||||
|
constructor() {
|
||||||
|
super()
|
||||||
|
this.resourceName = 'ocr_templates'
|
||||||
|
}
|
||||||
|
|
||||||
|
getPageImageUrl(docId: number, page: number): string {
|
||||||
|
return `${this.baseUrl}${this.resourceName}/document-page-image/${docId}/${page}/`
|
||||||
|
}
|
||||||
|
|
||||||
|
testZone(
|
||||||
|
docId: number,
|
||||||
|
zone: ZoneTestRequest
|
||||||
|
): Observable<OcrZoneTestResult> {
|
||||||
|
return this.http.post<OcrZoneTestResult>(
|
||||||
|
`${this.baseUrl}${this.resourceName}/test-zone/`,
|
||||||
|
{ document: docId, zone }
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,186 @@
|
|||||||
|
import { TestBed } from '@angular/core/testing'
|
||||||
|
import { Router } from '@angular/router'
|
||||||
|
import { BulkOperationStatus } from '../data/bulk-operation'
|
||||||
|
import { PaperlessTaskStatus } from '../data/paperless-task'
|
||||||
|
import { PermissionsService } from './permissions.service'
|
||||||
|
import { TaskNotificationService } from './task-notification.service'
|
||||||
|
import { Toast, ToastLevel, ToastService } from './toast.service'
|
||||||
|
|
||||||
|
describe('TaskNotificationService', () => {
|
||||||
|
let service: TaskNotificationService
|
||||||
|
let toastService: ToastService
|
||||||
|
let popups: Toast[]
|
||||||
|
let notifications: Toast[]
|
||||||
|
const navigate = jest.fn()
|
||||||
|
const currentUserCan = jest.fn()
|
||||||
|
const result = (
|
||||||
|
status = PaperlessTaskStatus.Success
|
||||||
|
): BulkOperationStatus => ({
|
||||||
|
task_id: 'task-1',
|
||||||
|
operation: 'run_workflow',
|
||||||
|
status,
|
||||||
|
})
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
jest.useFakeTimers()
|
||||||
|
currentUserCan.mockReturnValue(true)
|
||||||
|
TestBed.configureTestingModule({
|
||||||
|
providers: [
|
||||||
|
{ provide: Router, useValue: { navigate } },
|
||||||
|
{ provide: PermissionsService, useValue: { currentUserCan } },
|
||||||
|
],
|
||||||
|
})
|
||||||
|
service = TestBed.inject(TaskNotificationService)
|
||||||
|
toastService = TestBed.inject(ToastService)
|
||||||
|
popups = []
|
||||||
|
notifications = []
|
||||||
|
toastService.showToast.subscribe((toast) => popups.push(toast))
|
||||||
|
toastService
|
||||||
|
.getToasts()
|
||||||
|
.subscribe((toasts) => (notifications = [...toasts]))
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
jest.clearAllTimers()
|
||||||
|
jest.useRealTimers()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('replaces a queued notification with its result, removing the task link on success', () => {
|
||||||
|
service.showQueued('task-1', 'Workflow queued.', {
|
||||||
|
content: 'Workflow completed.',
|
||||||
|
})
|
||||||
|
jest.advanceTimersByTime(399)
|
||||||
|
expect(popups).toHaveLength(0)
|
||||||
|
jest.advanceTimersByTime(1)
|
||||||
|
expect(popups[0].content).toBe('Workflow queued.')
|
||||||
|
expect(popups[0].actionName).toBe('View task')
|
||||||
|
popups[0].action()
|
||||||
|
expect(navigate).toHaveBeenCalledWith(['/tasks'], {
|
||||||
|
queryParams: { task_id: 'task-1' },
|
||||||
|
})
|
||||||
|
service.complete(result())
|
||||||
|
expect(notifications).toHaveLength(1)
|
||||||
|
expect(popups[1]).toEqual(
|
||||||
|
expect.objectContaining({
|
||||||
|
id: popups[0].id,
|
||||||
|
content: 'Workflow completed.',
|
||||||
|
level: ToastLevel.Success,
|
||||||
|
})
|
||||||
|
)
|
||||||
|
expect(popups[1].action).toBeUndefined()
|
||||||
|
expect(popups[1].actionName).toBeUndefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('shows only the result when a task completes during the grace period', () => {
|
||||||
|
service.showQueued('task-1', 'Queued')
|
||||||
|
jest.advanceTimersByTime(100)
|
||||||
|
service.complete(result())
|
||||||
|
jest.advanceTimersByTime(1000)
|
||||||
|
expect(popups.map((toast) => toast.content)).toEqual([
|
||||||
|
"Operation 'Run workflow' completed.",
|
||||||
|
])
|
||||||
|
})
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
'reprocess',
|
||||||
|
'rotate',
|
||||||
|
'merge',
|
||||||
|
'split',
|
||||||
|
'delete_pages',
|
||||||
|
'edit_pdf',
|
||||||
|
'remove_password',
|
||||||
|
])('reports %s as submitted rather than completed', (operation) => {
|
||||||
|
service.showQueued('task-1', 'Queued')
|
||||||
|
service.complete({ ...result(), operation })
|
||||||
|
expect(notifications[0].content).toContain('submitted for processing.')
|
||||||
|
expect(notifications[0].content).not.toContain('completed')
|
||||||
|
expect(notifications[0].action).toBeUndefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does not show a stale queued state when completion beats the HTTP response', () => {
|
||||||
|
service.complete(result())
|
||||||
|
service.showQueued('task-1', 'Workflow queued.', {
|
||||||
|
content: 'Workflow completed.',
|
||||||
|
})
|
||||||
|
jest.advanceTimersByTime(1000)
|
||||||
|
expect(popups.every((toast) => toast.level === ToastLevel.Success)).toBe(
|
||||||
|
true
|
||||||
|
)
|
||||||
|
expect(notifications).toHaveLength(1)
|
||||||
|
expect(notifications[0].content).toBe('Workflow completed.')
|
||||||
|
expect(notifications[0].action).toBeUndefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it.each([PaperlessTaskStatus.Failure, PaperlessTaskStatus.Revoked])(
|
||||||
|
'replaces the queued state with an error for %s',
|
||||||
|
(status) => {
|
||||||
|
service.showQueued('task-1', 'Queued', {
|
||||||
|
content: 'Success',
|
||||||
|
actionName: 'Undo',
|
||||||
|
})
|
||||||
|
jest.advanceTimersByTime(400)
|
||||||
|
service.complete({ ...result(status), error: 'Task failed' })
|
||||||
|
expect(notifications).toHaveLength(1)
|
||||||
|
expect(notifications[0]).toEqual(
|
||||||
|
expect.objectContaining({
|
||||||
|
level: ToastLevel.Error,
|
||||||
|
error: 'Task failed',
|
||||||
|
actionName: 'View task',
|
||||||
|
})
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
it('ignores nonterminal and duplicate outcomes', () => {
|
||||||
|
service.showQueued('task-1', 'Queued')
|
||||||
|
service.complete(result(PaperlessTaskStatus.Started))
|
||||||
|
expect(popups).toHaveLength(0)
|
||||||
|
service.complete(result())
|
||||||
|
service.complete(result())
|
||||||
|
expect(popups).toHaveLength(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('keeps concurrent task notifications separate', () => {
|
||||||
|
service.showQueued('task-1', 'First queued')
|
||||||
|
service.showQueued('task-2', 'Second queued')
|
||||||
|
jest.advanceTimersByTime(400)
|
||||||
|
service.complete(result())
|
||||||
|
expect(notifications).toHaveLength(2)
|
||||||
|
expect(notifications.map((toast) => toast.content)).toEqual([
|
||||||
|
'Second queued',
|
||||||
|
"Operation 'Run workflow' completed.",
|
||||||
|
])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('omits task links without task viewing permission', () => {
|
||||||
|
currentUserCan.mockReturnValue(false)
|
||||||
|
service.showQueued('task-1', 'Queued')
|
||||||
|
jest.advanceTimersByTime(400)
|
||||||
|
service.complete(result())
|
||||||
|
expect(popups.every((toast) => !toast.action && !toast.actionName)).toBe(
|
||||||
|
true
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('identifies concurrent operations even when completion arrives before their queue responses', () => {
|
||||||
|
service.complete({
|
||||||
|
task_id: 'tags',
|
||||||
|
operation: 'modify_tags',
|
||||||
|
status: PaperlessTaskStatus.Success,
|
||||||
|
})
|
||||||
|
service.complete({
|
||||||
|
task_id: 'correspondent',
|
||||||
|
operation: 'set_correspondent',
|
||||||
|
status: PaperlessTaskStatus.Success,
|
||||||
|
})
|
||||||
|
expect(notifications.map((toast) => toast.content)).toEqual([
|
||||||
|
"Operation 'Set correspondent' completed.",
|
||||||
|
"Operation 'Update tags' completed.",
|
||||||
|
])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('keeps the generic fallback for unknown operation names', () => {
|
||||||
|
service.complete({ ...result(), operation: 'future_operation' })
|
||||||
|
expect(notifications[0].content).toBe('Operation completed.')
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,128 @@
|
|||||||
|
import { inject, Injectable, OnDestroy } from '@angular/core'
|
||||||
|
import { Router } from '@angular/router'
|
||||||
|
import { BulkOperationStatus } from '../data/bulk-operation'
|
||||||
|
import { PaperlessTaskStatus } from '../data/paperless-task'
|
||||||
|
import {
|
||||||
|
documentOperationHasFollowUpTasks,
|
||||||
|
getDocumentOperationLabel,
|
||||||
|
} from '../utils/document-operation'
|
||||||
|
import {
|
||||||
|
PermissionAction,
|
||||||
|
PermissionsService,
|
||||||
|
PermissionType,
|
||||||
|
} from './permissions.service'
|
||||||
|
import { Toast, ToastLevel, ToastService } from './toast.service'
|
||||||
|
|
||||||
|
interface PendingNotification {
|
||||||
|
success: Partial<Toast>
|
||||||
|
timer: ReturnType<typeof setTimeout>
|
||||||
|
}
|
||||||
|
|
||||||
|
@Injectable({ providedIn: 'root' })
|
||||||
|
export class TaskNotificationService implements OnDestroy {
|
||||||
|
private readonly toastService = inject(ToastService)
|
||||||
|
private readonly router = inject(Router)
|
||||||
|
private readonly permissionsService = inject(PermissionsService)
|
||||||
|
private readonly pending = new Map<string, PendingNotification>()
|
||||||
|
private readonly completed = new Map<string, BulkOperationStatus>()
|
||||||
|
|
||||||
|
ngOnDestroy() {
|
||||||
|
this.pending.forEach(({ timer }) => clearTimeout(timer))
|
||||||
|
}
|
||||||
|
|
||||||
|
showQueued(taskId: string, content: string, success: Partial<Toast> = {}) {
|
||||||
|
const completed = this.completed.get(taskId)
|
||||||
|
if (completed) {
|
||||||
|
this.showResult(completed, success)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if (this.pending.has(taskId)) return
|
||||||
|
this.pending.set(taskId, {
|
||||||
|
success,
|
||||||
|
// short delay in case the task finishes super fast
|
||||||
|
timer: setTimeout(() => this.show(taskId, { content, delay: 5000 }), 400),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
complete(result: BulkOperationStatus) {
|
||||||
|
if (
|
||||||
|
![
|
||||||
|
PaperlessTaskStatus.Success,
|
||||||
|
PaperlessTaskStatus.Failure,
|
||||||
|
PaperlessTaskStatus.Revoked,
|
||||||
|
].includes(result.status) ||
|
||||||
|
this.completed.has(result.task_id)
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
this.completed.set(result.task_id, result)
|
||||||
|
// Retain recent outcomes in case task finishes quickly
|
||||||
|
if (this.completed.size > 100) {
|
||||||
|
this.completed.delete(this.completed.keys().next().value)
|
||||||
|
}
|
||||||
|
const pending = this.pending.get(result.task_id)
|
||||||
|
if (pending) {
|
||||||
|
clearTimeout(pending.timer)
|
||||||
|
this.pending.delete(result.task_id)
|
||||||
|
}
|
||||||
|
// Trash needs the caller's document IDs to offer Undo on success.
|
||||||
|
if (
|
||||||
|
pending ||
|
||||||
|
result.operation !== 'delete' ||
|
||||||
|
result.status !== PaperlessTaskStatus.Success
|
||||||
|
) {
|
||||||
|
this.showResult(result, pending?.success)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private showResult(
|
||||||
|
result: BulkOperationStatus,
|
||||||
|
success: Partial<Toast> = {}
|
||||||
|
) {
|
||||||
|
const succeeded = result.status === PaperlessTaskStatus.Success
|
||||||
|
const operation = getDocumentOperationLabel(result.operation)
|
||||||
|
let content: string
|
||||||
|
if (succeeded) {
|
||||||
|
let operationText = $localize`Operation`
|
||||||
|
if (operation) operationText += ` '${operation}'`
|
||||||
|
const resultText = documentOperationHasFollowUpTasks(result.operation)
|
||||||
|
? $localize`submitted for processing`
|
||||||
|
: $localize`completed`
|
||||||
|
content = `${operationText} ${resultText}.`
|
||||||
|
} else if (result.status === PaperlessTaskStatus.Revoked) {
|
||||||
|
content = operation
|
||||||
|
? $localize`Operation '${operation}' revoked.`
|
||||||
|
: $localize`Operation revoked.`
|
||||||
|
} else {
|
||||||
|
content = operation
|
||||||
|
? $localize`Operation '${operation}' failed. Some changes may already have been applied.`
|
||||||
|
: $localize`Operation failed. Some changes may already have been applied.`
|
||||||
|
}
|
||||||
|
this.show(result.task_id, {
|
||||||
|
content,
|
||||||
|
delay: succeeded ? 5000 : 10000,
|
||||||
|
level: succeeded ? ToastLevel.Success : ToastLevel.Error,
|
||||||
|
...(succeeded ? success : { error: result.error }),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
private show(taskId: string, toast: Toast) {
|
||||||
|
const canViewTasks = this.permissionsService.currentUserCan(
|
||||||
|
PermissionAction.View,
|
||||||
|
PermissionType.PaperlessTask
|
||||||
|
)
|
||||||
|
this.toastService.show({
|
||||||
|
id: `task-${taskId}`,
|
||||||
|
...(canViewTasks && toast.level !== ToastLevel.Success
|
||||||
|
? {
|
||||||
|
actionName: $localize`View task`,
|
||||||
|
action: () =>
|
||||||
|
this.router.navigate(['/tasks'], {
|
||||||
|
queryParams: { task_id: taskId },
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
: {}),
|
||||||
|
...toast,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -38,6 +38,29 @@ describe('ToastService', () => {
|
|||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('updates a notification by ID without duplicating or moving it', () => {
|
||||||
|
let notifications: Toast[] = []
|
||||||
|
toastService
|
||||||
|
.getToasts()
|
||||||
|
.subscribe((toasts) => (notifications = [...toasts]))
|
||||||
|
toastService.show({ id: 'task-1', content: 'Queued', delay: 5000 })
|
||||||
|
toastService.show({
|
||||||
|
id: 'other',
|
||||||
|
content: 'Another notification',
|
||||||
|
delay: 5000,
|
||||||
|
})
|
||||||
|
toastService.show({
|
||||||
|
id: 'task-1',
|
||||||
|
content: 'Completed',
|
||||||
|
delay: 5000,
|
||||||
|
level: ToastLevel.Success,
|
||||||
|
})
|
||||||
|
expect(notifications.map((toast) => toast.content)).toEqual([
|
||||||
|
'Another notification',
|
||||||
|
'Completed',
|
||||||
|
])
|
||||||
|
})
|
||||||
|
|
||||||
it('parses error string to object on show', () => {
|
it('parses error string to object on show', () => {
|
||||||
const toast = {
|
const toast = {
|
||||||
title: 'Title',
|
title: 'Title',
|
||||||
|
|||||||
@@ -75,7 +75,14 @@ export class ToastService {
|
|||||||
if (persistent) {
|
if (persistent) {
|
||||||
// the dropdown is open, so it's seen as it arrives
|
// the dropdown is open, so it's seen as it arrives
|
||||||
toast.read = !!this._suppressPopupToasts
|
toast.read = !!this._suppressPopupToasts
|
||||||
|
const index = this.toasts.findIndex(
|
||||||
|
(existing) => existing.id === toast.id
|
||||||
|
)
|
||||||
|
if (index === -1) {
|
||||||
this.toasts.unshift(toast)
|
this.toasts.unshift(toast)
|
||||||
|
} else {
|
||||||
|
this.toasts[index] = toast
|
||||||
|
}
|
||||||
this.toastsSubject.next(this.toasts)
|
this.toastsSubject.next(this.toasts)
|
||||||
}
|
}
|
||||||
// Popups are suppressed while the dropdown is open
|
// Popups are suppressed while the dropdown is open
|
||||||
|
|||||||
@@ -5,8 +5,10 @@ import {
|
|||||||
HttpTestingController,
|
HttpTestingController,
|
||||||
} from '@angular/common/http/testing'
|
} from '@angular/common/http/testing'
|
||||||
import { environment } from 'src/environments/environment'
|
import { environment } from 'src/environments/environment'
|
||||||
|
import { PaperlessTaskStatus } from '../data/paperless-task'
|
||||||
import { DocumentListViewService } from './document-list-view.service'
|
import { DocumentListViewService } from './document-list-view.service'
|
||||||
import { Toast, ToastService } from './toast.service'
|
import { TaskNotificationService } from './task-notification.service'
|
||||||
|
import { Toast, ToastLevel, ToastService } from './toast.service'
|
||||||
import { TrashService } from './trash.service'
|
import { TrashService } from './trash.service'
|
||||||
|
|
||||||
describe('TrashService', () => {
|
describe('TrashService', () => {
|
||||||
@@ -105,4 +107,52 @@ describe('TrashService', () => {
|
|||||||
expect(toast.content).toEqual('Moved 500 document(s) to the trash')
|
expect(toast.content).toEqual('Moved 500 document(s) to the trash')
|
||||||
expect(toast.action).toBeUndefined()
|
expect(toast.action).toBeUndefined()
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('offers Undo only after the matching delete task succeeds', () => {
|
||||||
|
let toasts: Toast[] = []
|
||||||
|
toastService.getToasts().subscribe((t) => (toasts = [...t]))
|
||||||
|
service.trackMovedToTrash('delete-1', 2, [1, 2])
|
||||||
|
expect(toasts).toHaveLength(0)
|
||||||
|
const notifications = TestBed.inject(TaskNotificationService)
|
||||||
|
notifications.complete({
|
||||||
|
task_id: 'other-delete',
|
||||||
|
operation: 'delete',
|
||||||
|
status: PaperlessTaskStatus.Success,
|
||||||
|
})
|
||||||
|
expect(toasts).toHaveLength(0)
|
||||||
|
notifications.complete({
|
||||||
|
task_id: 'delete-1',
|
||||||
|
operation: 'delete',
|
||||||
|
status: PaperlessTaskStatus.Success,
|
||||||
|
})
|
||||||
|
expect(toasts).toHaveLength(1)
|
||||||
|
expect(toasts[0].actionName).toBe('Undo')
|
||||||
|
toasts[0].action()
|
||||||
|
const req = httpTestingController.expectOne(
|
||||||
|
`${environment.apiBaseUrl}trash/`
|
||||||
|
)
|
||||||
|
expect(req.request.body).toEqual({ action: 'restore', documents: [1, 2] })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('handles completion before the queue response and does not offer Undo on failure', () => {
|
||||||
|
let toasts: Toast[] = []
|
||||||
|
toastService.getToasts().subscribe((t) => (toasts = [...t]))
|
||||||
|
const notifications = TestBed.inject(TaskNotificationService)
|
||||||
|
notifications.complete({
|
||||||
|
task_id: 'delete-1',
|
||||||
|
operation: 'delete',
|
||||||
|
status: PaperlessTaskStatus.Success,
|
||||||
|
})
|
||||||
|
service.trackMovedToTrash('delete-1', 1, [1])
|
||||||
|
expect(toasts[0].actionName).toBe('Undo')
|
||||||
|
service.trackMovedToTrash('delete-2', 1, [2])
|
||||||
|
notifications.complete({
|
||||||
|
task_id: 'delete-2',
|
||||||
|
operation: 'delete',
|
||||||
|
status: PaperlessTaskStatus.Failure,
|
||||||
|
})
|
||||||
|
expect(toasts).toHaveLength(2)
|
||||||
|
expect(toasts[0].level).toBe(ToastLevel.Error)
|
||||||
|
expect(toasts[0].actionName).not.toBe('Undo')
|
||||||
|
})
|
||||||
})
|
})
|
||||||
@@ -5,7 +5,8 @@ import { environment } from 'src/environments/environment'
|
|||||||
import { Document } from '../data/document'
|
import { Document } from '../data/document'
|
||||||
import { Results } from '../data/results'
|
import { Results } from '../data/results'
|
||||||
import { DocumentListViewService } from './document-list-view.service'
|
import { DocumentListViewService } from './document-list-view.service'
|
||||||
import { ToastLevel, ToastService } from './toast.service'
|
import { TaskNotificationService } from './task-notification.service'
|
||||||
|
import { Toast, ToastLevel, ToastService } from './toast.service'
|
||||||
|
|
||||||
@Injectable({
|
@Injectable({
|
||||||
providedIn: 'root',
|
providedIn: 'root',
|
||||||
@@ -14,6 +15,24 @@ export class TrashService {
|
|||||||
private http = inject(HttpClient)
|
private http = inject(HttpClient)
|
||||||
private toastService = inject(ToastService)
|
private toastService = inject(ToastService)
|
||||||
private documentListViewService = inject(DocumentListViewService)
|
private documentListViewService = inject(DocumentListViewService)
|
||||||
|
private taskNotifications = inject(TaskNotificationService)
|
||||||
|
|
||||||
|
public trackMovedToTrash(
|
||||||
|
taskId: string,
|
||||||
|
count: number,
|
||||||
|
documents?: number[]
|
||||||
|
) {
|
||||||
|
this.taskNotifications.showQueued(
|
||||||
|
taskId,
|
||||||
|
count > 1
|
||||||
|
? $localize`Bulk move to trash queued.`
|
||||||
|
: $localize`Move to trash queued.`,
|
||||||
|
this.movedToTrashToast(
|
||||||
|
$localize`Moved ${count} document(s) to the trash`,
|
||||||
|
documents
|
||||||
|
)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
public getTrash(page: number = 1): Observable<Results<Document>> {
|
public getTrash(page: number = 1): Observable<Results<Document>> {
|
||||||
const httpParams = new HttpParams().set('page', page.toString())
|
const httpParams = new HttpParams().set('page', page.toString())
|
||||||
@@ -43,14 +62,22 @@ export class TrashService {
|
|||||||
* Shows a toast with an Undo action when possible
|
* Shows a toast with an Undo action when possible
|
||||||
*/
|
*/
|
||||||
public notifyMovedToTrash(content: string, documents?: number[]) {
|
public notifyMovedToTrash(content: string, documents?: number[]) {
|
||||||
|
this.toastService.show(this.movedToTrashToast(content, documents))
|
||||||
|
}
|
||||||
|
|
||||||
|
private movedToTrashToast(content: string, documents?: number[]): Toast {
|
||||||
const canUndo = documents?.length > 0
|
const canUndo = documents?.length > 0
|
||||||
this.toastService.show({
|
return {
|
||||||
content,
|
content,
|
||||||
delay: 10000,
|
delay: 10000,
|
||||||
level: ToastLevel.Success,
|
level: ToastLevel.Success,
|
||||||
actionName: canUndo ? $localize`Undo` : undefined,
|
...(canUndo
|
||||||
action: canUndo ? () => this.undoMoveToTrash(documents) : undefined,
|
? {
|
||||||
})
|
actionName: $localize`Undo`,
|
||||||
|
action: () => this.undoMoveToTrash(documents),
|
||||||
|
}
|
||||||
|
: {}),
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private undoMoveToTrash(documents: number[]) {
|
private undoMoveToTrash(documents: number[]) {
|
||||||
|
|||||||
@@ -0,0 +1,18 @@
|
|||||||
|
import {
|
||||||
|
documentOperationHasFollowUpTasks,
|
||||||
|
getDocumentOperationLabel,
|
||||||
|
} from './document-operation'
|
||||||
|
|
||||||
|
describe('Document Operation Utils', () => {
|
||||||
|
it('names zone OCR and treats task completion as finished extraction', () => {
|
||||||
|
expect(getDocumentOperationLabel('run_zone_ocr')).toBe('Run zone OCR')
|
||||||
|
expect(documentOperationHasFollowUpTasks('run_zone_ocr')).toBe(false)
|
||||||
|
})
|
||||||
|
it('should retrieve the document operation label correctly for an existing operation, null otherwise', () => {
|
||||||
|
const result = getDocumentOperationLabel('modify_custom_fields')
|
||||||
|
expect(result).toBe('Update custom fields')
|
||||||
|
|
||||||
|
const resultNull = getDocumentOperationLabel('non_existing_operation')
|
||||||
|
expect(resultNull).toBeNull()
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
const OPERATION_LABELS: Record<string, string> = {
|
||||||
|
set_correspondent: $localize`Set correspondent`,
|
||||||
|
set_document_type: $localize`Set document type`,
|
||||||
|
set_storage_path: $localize`Set storage path`,
|
||||||
|
add_tag: $localize`Add tag`,
|
||||||
|
remove_tag: $localize`Remove tag`,
|
||||||
|
modify_tags: $localize`Update tags`,
|
||||||
|
modify_custom_fields: $localize`Update custom fields`,
|
||||||
|
set_permissions: $localize`Set permissions`,
|
||||||
|
delete: $localize`Move to trash`,
|
||||||
|
reprocess: $localize`Document reprocessing`,
|
||||||
|
run_workflow: $localize`Run workflow`,
|
||||||
|
run_zone_ocr: $localize`Run zone OCR`,
|
||||||
|
rotate: $localize`Rotate documents`,
|
||||||
|
merge: $localize`Merge documents`,
|
||||||
|
merge_as_versions: $localize`Merge as versions`,
|
||||||
|
split: $localize`Split documents`,
|
||||||
|
delete_pages: $localize`Delete pages`,
|
||||||
|
edit_pdf: $localize`Edit PDF`,
|
||||||
|
remove_password: $localize`Remove password`,
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getDocumentOperationLabel(operation?: string): string | null {
|
||||||
|
const label = operation ? OPERATION_LABELS[operation] : null
|
||||||
|
return label ?? null
|
||||||
|
}
|
||||||
|
|
||||||
|
// These operations queue processing in separate tasks
|
||||||
|
export function documentOperationHasFollowUpTasks(operation?: string): boolean {
|
||||||
|
return [
|
||||||
|
'reprocess',
|
||||||
|
'rotate',
|
||||||
|
'merge',
|
||||||
|
'split',
|
||||||
|
'delete_pages',
|
||||||
|
'edit_pdf',
|
||||||
|
'remove_password',
|
||||||
|
].includes(operation ?? '')
|
||||||
|
}
|
||||||
@@ -8,7 +8,7 @@ export const environment = {
|
|||||||
apiVersion: '10', // match src/paperless/settings.py
|
apiVersion: '10', // match src/paperless/settings.py
|
||||||
appTitle: DEFAULT_APP_TITLE,
|
appTitle: DEFAULT_APP_TITLE,
|
||||||
tag: 'prod',
|
tag: 'prod',
|
||||||
version: '3.4.2',
|
version: '3.5.1',
|
||||||
webSocketHost: window.location.host,
|
webSocketHost: window.location.host,
|
||||||
webSocketProtocol: window.location.protocol == 'https:' ? 'wss:' : 'ws:',
|
webSocketProtocol: window.location.protocol == 'https:' ? 'wss:' : 'ws:',
|
||||||
webSocketBaseUrl: base_url.pathname + 'ws/',
|
webSocketBaseUrl: base_url.pathname + 'ws/',
|
||||||
|
|||||||
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
Loaded 100 of 237 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user