CHANGELOG.md 9.94 KB
Newer Older
Anton Koch's avatar
Anton Koch committed
1 2
# Changelog

3 4
This document tracks all important changes to the Motion
Bank Systems Frontend.
Anton Koch's avatar
Anton Koch committed
5

6 7 8 9
The format is based on
[Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
Anton Koch's avatar
Anton Koch committed
10

Anton's avatar
Anton committed
11 12 13 14
## [Unreleased]

### Added

Anton Koch's avatar
Anton Koch committed
15 16
- [cote](https://cote.js.org) Sockend client integration to
connect to [sockets service](https://gitlab.rlp.net/motionbank/microservices/sockets)
Anton's avatar
Anton committed
17
- Cell datatype available as vuex store module
Anton's avatar
Anton committed
18
- SwimLane component in post-annotator and on standalone page
Anton's avatar
Anton committed
19
- Annotations can have durations through target.selector.value
Anton's avatar
Anton committed
20
- PBA vocabularies (titles for pieces)
Anton's avatar
Anton committed
21
- Frontend can be built as an [Electron](https://electronjs.org/)
Anton's avatar
Anton committed
22
app, including a local metadata service as store module `metadata-ffprobe`
Anton's avatar
Anton committed
23 24 25 26
- Mobile device-friendliness
- Breadcrumb navigation
- Buttons now support right-click + open in new tab (still suffers from
[#253](https://gitlab.rlp.net/motionbank/applications/systems-frontend/issues/253))
Anton's avatar
Anton committed
27
- Audio annotations (supported types: `.m4a` and `.mp3`) can be added
Anton's avatar
Anton committed
28
under `media/create` (playback possible using forked
Anton's avatar
Anton committed
29
[vue-video-player](https://github.com/dasantonym/vue-video-player))
Anton's avatar
Anton committed
30
- Export timelines as CSV
Anton's avatar
Anton committed
31
- Mobile compatiblity for MoSys Editor
32 33
- The file `statics/env.js` can be overwritten to configure
the frontend at runtime
Anton's avatar
Anton committed
34 35 36 37 38 39

### Changed

- Videos always have title annotations
- Metadata uses video duration from annotation
- Annotation's target.selector.value conforms to standard
Anton's avatar
Anton committed
40 41 42
- VideoPlayer uses [privacy-enhanced mode](https://support.google.com/youtube/answer/171780)
for YouTube sources to be GDPR compliant
- VideoPlayer uses [dnt](https://github.com/vimeo/player.js/#embed-options)
Anton's avatar
Anton committed
43
(do not track) option for showing Vimeo media for GDPR compliance
Anton's avatar
Anton committed
44 45 46 47 48
- Basic colors, look & feel
- New post annotator layout
- Vocabulary menu layout and functionality
- Navigation redesign
- MoSys redesign
Anton's avatar
Anton committed
49
- Renamed `Video` to `Media` throughout project
Anton's avatar
Anton committed
50

Anton's avatar
Anton committed
51 52 53
### Updated

- [mbjs-data-models](https://gitlab.rlp.net/motionbank/mbjs/data-models)
Anton's avatar
Anton committed
54
  to version 1.2.4
Anton's avatar
Anton committed
55
- [mbjs-quasar](https://gitlab.rlp.net/motionbank/mbjs/quasar)
Anton's avatar
Anton committed
56
  to version 2.2.0
Anton's avatar
Anton committed
57

Anton's avatar
Anton committed
58 59 60 61 62 63
### Fixed

- Sync screen
- Timecode millisecond display
- Video player scaling issue

Anton's avatar
Anton committed
64 65
### Removed

Anton's avatar
Anton committed
66
- Unused store modules `forms`, `conversions` and `timecodes`
Anton's avatar
Anton committed
67
- Routes `media/ingest` and `timelines/timecode`
Anton's avatar
Anton committed
68

Anton's avatar
Anton committed
69

Anton's avatar
Anton committed
70
## [1.3.1] - 2019-04-06
Anton Koch's avatar
Anton Koch committed
71

Anton's avatar
Anton committed
72 73 74 75
### Changed

- MoSys VideoCells only load content when visible

Anton's avatar
Anton committed
76 77 78 79
### Fixed

- Resource cache uses the right env variable

Anton's avatar
Anton committed
80 81 82

## [1.3.0] - 2019-03-26

83 84
### Added

Anton's avatar
Anton committed
85 86
#### MoSys

Anton's avatar
Anton committed
87
- AnnotationList and Video cells deactivate off visible area
Anton's avatar
Anton committed
88
- AnnotationList has an additional tab layout
Anton's avatar
Anton committed
89
- AnnotationList shows formatted Markdown
90
- Exported Grid packages contain all linked grids as well
91 92 93
- Grid URLs accept the query parameter `datetime` specifying an
ISO datetime string (urlencoded) to set the time for video
player cells
94 95
- Grid URLs accept the query parameter `x` specifying an initial
horizontal cell index
Anton's avatar
Anton committed
96
- Image and Title cells can have links
97 98
- AnnotationList cell allows filtering annotations by simple
string or [Regular Expression](https://www.regular-expressions.info/quickstart.html)
Anton's avatar
Anton committed
99 100
- CellEditor adds start and duration filters for AnnotationList
and Video cells
101
- Cells display additional info in editor (class name, author name)
Anton's avatar
Anton committed
102
- CellText uses [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
Anton's avatar
Anton committed
103
to format text content
Anton's avatar
Anton committed
104
- Grids can have external and embedded stylesheets
105
defined on their 'edit' page (requires 'cssediting' feature)
Anton's avatar
Anton committed
106
- Cells additionally use their annotation target's
107 108
`styleClass` property (can be set in cell context menu,
requires 'cssediting' feature)
Anton's avatar
Anton committed
109 110 111 112 113 114
- Grids can be exported and imported like timelines
- Access control menu available for MoSys grids
- 'Documents' source tab (so far only shows images)

#### General

Anton's avatar
Anton committed
115
- Import timeline/grid now allows overriding author for all items
116
- Docker image already builds with the nginx SPA config
117 118
- The generic Vuex modules can use optional caching in memory
(activate with USE_RESOURCE_CACHE env variable)
119 120 121 122
- Generic vuex resources allow selection of returned
properties through array of strings
- Metadata store module caches responses from the
transcoder service until app reload
Anton's avatar
Anton committed
123
- UI version in site footer links to changelog
124 125 126

### Changed

Anton's avatar
Anton committed
127
- VideoCell hides volume control
Anton's avatar
Anton committed
128
- Text size in grids is relative to window height
Anton's avatar
Anton committed
129 130
- MoSys cell styling
- VideoPlayer styling
131
- Updated [mbjs-data-models](https://gitlab.rlp.net/motionbank/mbjs/data-models)
Anton's avatar
Anton committed
132
to 0.1.3 ([release_0_1](https://gitlab.rlp.net/motionbank/mbjs/data-models/commits/release_0_1)
133
branch)
134 135
- Video and AnnotationList cells now use [luxon](https://moment.github.io/luxon/)
DateTime and Interval objects
Anton's avatar
Anton committed
136
- AnnotationList cell's input field is now optional, defaults to off 
Anton's avatar
Anton committed
137
- Layout for MoSys Cells: AnnotationList, Title, Video and InternalLink
Anton's avatar
Anton committed
138
- Renamed 'mosysGridEditorStore' vuex module to 'mosys'
139 140 141 142 143 144 145 146 147 148 149
- Updated
[mbjs-api-client](https://gitlab.rlp.net/motionbank/mbjs/api-client)
to version 2.0.0
- Renamed 'Assets' to 'Documents' in screens and
navigation, Auth0 feature now also needs to be 'documents'
- Updated
[mbjs-quasar](https://gitlab.rlp.net/motionbank/mbjs/quasar)
to version 1.4.3
- Moved ACL functionality to
[mbjs-quasar](https://gitlab.rlp.net/motionbank/mbjs/quasar)
module
150

151 152
### Fixed

Anton's avatar
Anton committed
153
- Time and date selection was broken in last release
Anton's avatar
Anton committed
154
- Active annotation highlighting in MoSys AnnotationList
155 156 157 158 159
- Deep links into post-annotator no longer fail when
lots of annotations need to be loaded
- Delete map no longer fails when encountering access
denied errors (still suffers from
[#119](https://gitlab.rlp.net/motionbank/systems-frontend/issues/119))
160

Anton's avatar
Anton committed
161 162 163 164 165
### Removed

- Obsolete `MessengerComponent` as component events travel
via `this.$root`

166 167 168

## [1.2.1] - 2019-02-15

169 170
### Fixed

171 172 173 174 175 176
- Post-annotator timestamps display correct values,
independent of timezone or DST
- currentIndex property no longer throws when attempting
to scroll to invalid annotation index
- Timestamps in post-annotator are no longer being cut
off, display hours as well
Anton's avatar
Anton committed
177

178

Anton's avatar
Anton committed
179 180
## [1.2.0] - 2019-02-14

Anton's avatar
Anton committed
181 182
### Added

183 184 185 186 187 188 189 190
- Post annotator accepts annotation UUIDs as a hash
value and automatically jumps there on load
- Property 'originalTitle' (if title is overridden)
added to result in metadata store
- Very basic search page for timelines added,
accessible only with 'search' feature permission
- API client (and its associated resources' "find"
actions) now accept regular expressions
Anton's avatar
Anton committed
191
- Resource 'documents' available in the store
192 193 194 195 196
- 'Assets' feature allows uploading of files to
personal S3 compatible bucket
- 'Packager' feature allows export of MoSys grids
as static packages to be hosted in any webspace,
without the need of Motion Bank APIs
Anton's avatar
Anton committed
197

198 199
### Fixed

200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
- Automatic scrolling to annotations when video
player plays in post annotator
- Video titles are no longer removed when saving
video with same title as before
- Parameter 'feature' can be added to route metadata
to allow access control through Auth0 app metadata
- Exception when passing an id (URI) to ACL store
instead of a UUID
- Incompatibilities in MoSys cells (Video,
AnnotationList)
- App startup no longer breaks on Microsoft Edge
(works from version 15+)
- Perform date related queries to MongoDB with
properly formatted timezones (see:
[#106](https://gitlab.rlp.net/motionbank/systems-frontend/issues/106))
215

216 217
### Changed

218 219 220 221 222 223 224 225
- userHasFeature moved to
[mbjs-quasar](https://gitlab.rlp.net/motionbank/mbjs/quasar)
- "More Info" button on welcome page now links to
medium article
- MoSys components included through git submodule from
[quasar-components-mosys](https://gitlab.rlp.net/motionbank/mbjs/quasar-components-mosys)
- Shared components included through git submodule from
[quasar-components-shared](https://gitlab.rlp.net/motionbank/mbjs/quasar-components-shared)
226

Anton's avatar
Anton committed
227 228
### Updated

229 230
- [mbjs-api-client](https://gitlab.rlp.net/motionbank/mbjs/api-client)
now at version 1.1.0
231

232

233 234 235 236
## [1.1.1] - 2019-01-28

### Fixed

237 238
- Recursive setting of ACL for a timeline's associated
annotations now traverses the full relational depth.
239

Anton's avatar
Anton committed
240

241 242
## [1.1.0] - 2018-12-11

Anton Koch's avatar
Anton Koch committed
243 244
### Added

245
- Edit video screen allows moving video to another timeline
Anton Koch's avatar
Anton Koch committed
246
- Video list shows timeline title
247 248 249 250 251 252 253 254 255 256 257
- Data tables use an optional requestTransform function
to process rows on each data update
- Info button in the post-annotator shows video metadata
(so far only title)
- Hyperlinks in annotations are clickable in the
post-annotator
- Limited markdown support for annotations
(allowed tags: 'b', 'i', 'em', 'strong', 'a', 'br', 'p')
- Videos can be tagged
- Vuex module 'tags' - stores and retrieves tags as
annotations
Anton Koch's avatar
Anton Koch committed
258

Anton Koch's avatar
Anton Koch committed
259 260
### Changed

261 262
- Video list is sorted descending on reference
date by default
Anton Koch's avatar
Anton Koch committed
263
- Look of top right buttons in post-annotator
264 265 266 267 268 269
- Users need to explicitly click 'edit' to change
an annotation in the post-annotator
- External titles stored as annotations are retrieved
within the metadata store module
- BrowserWarning and MarkdownDisplay components moved to
[mbjs-quasar](https://gitlab.rlp.net/motionbank/mbjs/quasar)
Anton Koch's avatar
Anton Koch committed
270
- Readme info
Anton Koch's avatar
Anton Koch committed
271
- Pinned and updated runtime dependencies
Anton Koch's avatar
Anton Koch committed
272

Anton Koch's avatar
Anton Koch committed
273 274
### Fixed

275 276
- Post-annotation no longer fails when the duration
of a video cannot be retrieved
Anton Koch's avatar
Anton Koch committed
277
- Editing external title annotations
278 279
- Tables are properly searchable
- Timeline list updates after deleting an item
Anton Koch's avatar
Anton Koch committed
280

Anton Koch's avatar
Anton Koch committed
281 282 283 284 285
### Removed

- Old Github badges, CI and code review configs


Anton Koch's avatar
Anton Koch committed
286 287 288 289 290 291 292 293 294
## [1.0.0] - 2018-12-04

### Added

- Changelog document

### Changed

- Start proper versioning at 1.0.0
Anton Koch's avatar
Anton Koch committed
295 296


Anton's avatar
Anton committed
297 298
[Unreleased]: https://gitlab.rlp.net/motionbank/systems-frontend/compare/v1.3.1...master
[1.3.1]: https://gitlab.rlp.net/motionbank/systems-frontend/compare/v1.3.0...v1.3.1
Anton's avatar
Anton committed
299
[1.3.0]: https://gitlab.rlp.net/motionbank/systems-frontend/compare/v1.2.1...v1.3.0
300
[1.2.1]: https://gitlab.rlp.net/motionbank/systems-frontend/compare/v1.2.0...v1.2.1
Anton's avatar
Anton committed
301
[1.2.0]: https://gitlab.rlp.net/motionbank/systems-frontend/compare/v1.1.1...v1.2.0
302
[1.1.1]: https://gitlab.rlp.net/motionbank/systems-frontend/compare/v1.1.0...v1.1.1
303
[1.1.0]: https://gitlab.rlp.net/motionbank/systems-frontend/compare/v1.0.0...v1.1.0
304
[1.0.0]: https://gitlab.rlp.net/motionbank/systems-frontend/compare/initial...v1.0.0