VDT 22.3 Changes [VDT RN]
The information on this page is sourced from here: Start Here / Changelog - Page ⋅ Storybook (vidispine.github.io)
22.3.0
cra-template-vdt
Updates
Updated dependencies
@vidispine/eslint-config
No changes.
@vidispine/eslint-config-typescript
New package
Package with typescript eslint config
@vidispine/eslint-config-base
No changes.
@vidispine/eslint-config-react
Updates
Disabled preferring default export
'import/prefer-default-export': 'off'
example-vdt-mui-app
No changes.
example-vdt-material-app
New
Added export of collection in collection view header
Updates
Header updated with vidispine logo and new title.
Metadata fields and groups have been improved with e.g:
Refactor to use FieldGroup Context
OnSuccess and onError notifications
General bug fixes
Item Upload improved with possibility to add metadata to both fields and groups during upload
Fix so only delete option in item header is hidden if user doesn't have
_item_write
roleBug fix for export location including script tag with empty string
General refactor of Item components for better code readability
@vidispine/prettier-config
No changes.
@vidispine/proptypes
dependencies
@babel/runtime
7.17.0 -> 7.18.9
@vidispine/types
Updates
Typings updated for VidiCore 22.3.0
Bug fix for missing type properties for complexContent extensions
In a few cases these types were missing extended properties and only showed baseTypes, fixed with intersection
@vidispine/vdt-api
New
collection.exportCollection endpoint added
/API/collection/${collectionId}/export
library.exportLibrary endpoint added
/API/library/${libraryId}/export
@vidispine/vdt-js
New
SYSTEM_FIELDGROUPS: const with all built in VidiCore system field group names
SYSTEM_FIELDS: const with all built in VidiCore system field names
Improvements, documentation and tests added for time
and metadata
utils, see below:
CreateMetadataType
Breaking Changes
Multiple (array) groups with same name no longer have to be sent in with
groupName
, e.g.CODE{ //... group : [ { groupName : 'my_group_name' , my_fieldName : 'my value' } , //... ] , //... }Copy
Now these can instead be interpreted as groups with the same name if objects inside the array have an undefined
value
CODE{ //... my_group_name : [ { /* value: undefined => interpreted as group */ my_fieldName : 'my value' , } , ] ; //... }Copy
Updates
More alternatives for the input to enable creating all MetadataType variations in VidiCore
See the storybook examples for a walk through of them
TimeCode
TimeCode class and functions have been improved with features, tests, documentation and stories.
Breaking changes
toTime: No longer returns
frames
- use toUnits insteadtoJson: Deprecated (with warning for now) - use toObject instead
formatSeconds: Replaced with formatTimeCodeSeconds
formatSecondsPrecise: Replaced with formatTimeCodeSeconds
formatTimeCodeSeconds: timeBase sent in options to be same as other format functions
Instead of
formatTimeCodeSeconds(smpte, timeBase)
useformatTimeCodeSeconds(smpte, { timeBase })
formatSmpte: Renamed formatTimeCodeSmpte
TimeCode constructor options: Changing
field
toframeSeparator
Set the frameSeparator to use for smpte (e.g.
:|.|;|,
) instead of "1" or "2"It will, same as before, by default use
:
(and for dropFrame;
)
Improvements
Documentation added for all functions and class methods
toText: Added option object `{ includeTimeBaseForSeconds, constant, fraction }
toTime: Returns
milliseconds
as welltoDuration: Supporting different formats (with ms also), e.g. hh:mm:ss.SS
New
toUnits: Get hours, minutes, seconds and frames for TimeCode instance
toObject: Replacing toJson (same functionality)
formatTimeCodeSeconds: Combining formatSeconds and formatSecondsPrecise into one function
Will be precise by default if seconds have decimals
Option to
useGCD
to divide numerator/denominator in timeBaseOption to set
timeBase
for returned instance
createTimeCode: Formatting various inputs to a TimeCode instance in one combined function
TimeBase
TimeBase class and functions have been improved with features, tests, documentation and stories.
Breaking changes
toText: Changed to use an options object instead of bool arg
Use
toText({ constant: true })
instead oftoText(true)
toRate: Changed to use an options object instead of bool args
rounded renamed to fixed
Instead of
toRate(true)
usetoRate({ constant: true })
Instead of
toRate(false, false)
usetoRate({ fixed: false })
toJson: Deprecated (with warning for now) - use toObject instead
formatTimeBase: Renamed createTimeBase
Improvements
toDuration: Supporting different formats (with ms also), e.g. hh:mm:ss.SS
toText: Added options.fraction
always show numerator (even when 1)
Same default behavior as before
toRate: Added options object `{fixed, constant, rounded}``
Return max decimal places with
fixed:false
Return specific decimal places with
fixed:<number>
Return rounded to nearest integer with
rounded
Same default behavior as before
New
toObject: Replacing toJson (same functionality)
createTimeBase: Replacing formatTimeBase (same functionality)
dependencies
filesize
6.1.0 -> 6.4.0
@vidispine/mui
New
ImageCollage
moved over from vdt-materialuiA new flag
showLastRowStretched
for stretching all last row images instead of just a single
dependencies
@babel/runtime
7.17.0 -> 7.18.9@mui/icons-material
5.5.1 -> 5.8.4@mui/lab
5.0.0-alpha.75 -> 5.0.0-alpha.95@mui/material
5.5.3 -> 5.10.1@mui/styles
5.5.3 -> 5.9.3clsx
1.1.1 -> 1.2.1
@vidispine/vdt-materialui
Breaking Changes
FieldGroupDesigner
Changed propsmetadataFieldGroupDocument changed name to metadataFieldGroupType
setNotification replaced with onSuccess and onError
Updates
CollectionMetadataEdit
Updated to work with field groupsnew prop
metadataType
added for passing metadataType directly and not from inside collectionType
CollectionMetadataTab
Updated to work with field groups and their attributes using contentPathsnew props:
displayJoinValue
,displayGroupAsList
,useContentPaths
,formatValue
,queryParams
,getAttributes
EntityAccessTable
Possible to modify styles with propclasses.entityAccessMenuContext
ItemMetadataListFieldGroupItem
Added a defaultExpanded prop (default: false)ItemMetadataTab
Updated to work with field groupsnew props:
displayJoinValue
,displayGroupAsList
,queryParams
,getAttributes
ItemPlayer
Updated withA binary file player
Loading display
No Preview display
SavedSearch
Prop forextraMenuItems
addedSavedSearchList
Prop forextraMenuItems
addedSavedSearchRow
Props formenuContext
andextraMenuItems
addedAn extra menu for showing additional menu items added
SearchInput
Props for adding aTopSearchesComponent
andTopSearchesProps
addedUserAvatarButton
Prop for adding an customavatarText
dependencies
@babel/runtime
7.17.0 -> 7.18.9clsx
1.1.1 -> 1.2.1core-js
3.8.3 -> 3.24.1filesize
6.1.0 -> 6.4.0final-form
4.20.1 -> 4.20.7moment
2.28.0 -> 2.29.4pdfjs-dist
2.9.359 -> 2.15.349react-dropzone
11.2.4 -> 11.7.1react-final-form
6.5.2 -> 6.5.9react-pdf
5.4.0 -> 5.7.2react-select
4.3.1 -> 5.4.0typeface-exo-2
1.1.4 -> 1.1.13typeface-roboto
0.0.75 -> 1.1.13
...
@vidispine/vdt-react
Updates
useAddMetadataFieldAttributes
PropgetAttributes
(default true) for disabling fetching attributesuseGetEntityMetadata
Hook for fetching metadata for an entity (using the useApi hook)GetEntityMetadata
Wrapper component for fetching metadata for an entityuseGetFieldGroup
Hook for fetching a field group (using the useApi hook)GetFieldGroup
Wrapper component for fetching a field groupuseSearch
Added support for updating reducer withmatrixParams
andpage
for itemSearchDocumentMetadataType
Added prop formetadataType
directly
dependencies
@babel/runtime
7.17.0 -> 7.18.9react-cookie
4.0.3 -> 4.1.1use-deep-compare-effect
1.3.1 -> 1.8.1
@vidispine/vdt-react-timeline
New
TimelineEvent
component exported (was missing in 22.2)
dependencies
@babel/runtime
7.17.0 -> 7.18.9konva
8.2.1 -> 8.3.11react-konva
17.0.2-5 -> 17.0.2-6
@vidispine/vdt-videojs-react
dependencies
@babel/runtime
7.17.0 -> 7.18.9
@vidispine/vdt-videojs
dependencies
@babel/runtime
7.17.0 -> 7.18.9mousetrap
1.6.3 -> 1.6.5video.js
7.6.6 -> 7.20.2
core
Documentation (jsdoc) for vdt-js and vdt-api have been added as iframes inside storybook (seen in the "Docs"-tab)