Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Define own compact wire format for annotation transport to browsers #2798

Closed
reckart opened this issue Jan 4, 2022 · 0 comments
Closed

Define own compact wire format for annotation transport to browsers #2798

reckart opened this issue Jan 4, 2022 · 0 comments
Assignees
@reckart
Labels
Module: JavaScript Editor API ⚙️ Refactoring
Projects
Kanban
Milestone
23.0

Comments

@reckart
Copy link
Member

reckart commented Jan 4, 2022

Describe the refactoring action
The structures we adopted for brat in the brat editor are a good basis, but it would be better to go towards a client-independent compact format that also cleans up some of the cruft we inherited from brat.

Expected benefit
Cleaner and even more compact wire format for (external) editors.
@reckart reckart added this to the 23.0 milestone Jan 4, 2022
@reckart reckart self-assigned this Jan 4, 2022
@reckart reckart added this to 🔖 To do in Kanban via automation Jan 4, 2022
reckart added a commit that referenced this issue Jan 4, 2022
@reckart
#2798 - Define own compact wire format for annotation transport to br…
4357b95 
…owsers

- Started setting up a new compact format in the diam module
- Bit of cleaning up of serialization in the brat module as well
- Bit of extracting common code into the support module
reckart added a commit that referenced this issue Jan 4, 2022
@reckart
#2798 - Define own compact wire format for annotation transport to br…
e7cedd6 
…owsers

- Remove unused dependency
reckart added a commit that referenced this issue Jan 7, 2022
@reckart
#2798 - Define own compact wire format for annotation transport to br…
06cb648 
…owsers

- Added missing license header
reckart added a commit that referenced this issue Jan 8, 2022
@reckart
#2798 - Define own compact wire format for annotation transport to br…
0ff8f4d 
…owsers

- Adjust to API change
reckart added a commit that referenced this issue Jan 8, 2022
@reckart
#2798 - Define own compact wire format for annotation transport to br…
3ecb9da 
…owsers

- Add TypeScript definitions for the stuff that's in the compact format
- Remove things from the compact format that should probably be handled differently or independently (Markers, Lazy Detail Queries) - we can still add them again later
reckart added a commit that referenced this issue Jan 8, 2022
@reckart
#2798 - Define own compact wire format for annotation transport to br…
c0f6a8f 
…owsers

- Add TypeScript definitions for the stuff that's in the compact format
- Remove things from the compact format that should probably be handled differently or independently (Markers, Lazy Detail Queries) - we can still add them again later
reckart added a commit that referenced this issue Jan 8, 2022
@reckart
#2798 - Define own compact wire format for annotation transport to br…
1312768 
…owsers

- Remove the "type" from span and relationa annotations as we do not need it for the time being - and if we need it, might add it back in a different way
- Turn CompactAnnotation into an interface because the base class approach was not compatible with our BeanAsArraySerializer
@reckart reckart closed this as completed Jan 8, 2022
Kanban automation moved this from 🔖 To do to 🍹 Done Jan 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@reckart reckart

Labels
Module: JavaScript Editor API ⚙️ Refactoring
Projects
Kanban
  
🍹 Done
Milestone
23.0
Development

No branches or pull requests
1 participant
@reckart