Breadcrumbs

VDT 22.1 Changes [VDT RN]

22.1.0

cra-template-vdt

New

  • Example to use yarn create added

  • Linting added to template

Updates

  • Documentation updated

dependencies

  • [Added]

    • "react": "^16.14.0" (so it wouldn't start with 17)

    • "react-dom": "^16.14.0" (so it wouldn't start with 17)

@vidispine/eslint-config

  • Extends @vidispine/eslint-config-react, see inherited changes

  • Updates (listed in @vidispine/eslint-config-react and @vidispine/eslint-config-base) may result in "breaking" lint changes

@vidispine/eslint-config-react

  • Extends @vidispine/eslint-config-base so see that for more inherited changes

  • Updates (listed below and in @vidispine/eslint-config-base) may result in "breaking" lint changes

New

  • Lint sorting imports

  • Lint md files

  • Lint js code blocks inside md/mdx

    • Js code blocks aren't linted using cli, but works fine in vscode

Updates

  • Rules from eslint config updates in airbnb, prettier and import

  • Rule react/jsx-props-no-spreading turned 'off' (Note: it's re-enabled in @vidispine/eslint-config)

    • we could remove hundreds of lint disable comments

  • Rule react/function-component-definition set to named:function-declaration and unnamed:arrow-function

dependencies

  • [Added]

    • "@vidispine/prettier-config": "^22.1.0" (fetching config from package instead of duplicated)

    • "eslint-plugin-mdx": "^1.16.0"

  • [Updated]

    • "eslint-config-airbnb-base": "^14.2.1" => "^15.0.0"

    • "eslint-config-prettier": "^7.1.0" => "^8.3.0"

    • "eslint-plugin-import": "^2.25.4"

    • "eslint-plugin-prettier": "^3.3.1" => "^4.0.0"

@vidispine/eslint-config-base

  • Updates (listed below) may result in "breaking" lint changes

New

  • parserOptions set to ecmaVersion: 2020

  • Extends plugin:mdx/recommended (for md/mdx linting)

Updates

  • Rules from eslint config updates in airbnb, prettier and import

dependencies

  • [Added]

    • "eslint-plugin-import": "^2.25.4",

    • "eslint-plugin-mdx": "^1.16.0"

  • [Updated]

    • "eslint-config-airbnb": "^18.2.1" => "^19.0.4" "eslint-plugin-jsx-a11y": "^6.5.1", "eslint-plugin-react": "^7.28.0", "eslint-plugin-react-hooks": "^4.3.0"

@vidispine/prettier-config

New

  • jsxSingleQuote: false

  • endOfLine: 'auto' (less intrusive for lf/crlf mismatch)

peerDependencies

  • "prettier": "2.2.x" => "^2.0.0"

@vidispine/proptypes

No changes.

@vidispine/vdt-api

New

  • [bulkymetadata.listComponentBulkyMetadata] endpoint added

  • [shape.createComponentAnalyze] endpoint added

  • [utils.js] using buffer package since it was removed from webpack in react-scripts ^5.0.0

dependencies

  • [Added]

    • "@babel/runtime": "^7.17.0"

    • "buffer": "^6.0.3"

devDependencies

  • [Added]

    • "@storybook/addon-docs": "^6.4.18"

  • [Updated]

    • "@babel/core": "^7.17.0"

    • "@babel/plugin-external-helpers": "^7.16.7"

    • "@babel/preset-env": "^7.16.11"

    • "@rollup/plugin-babel": "^4.3.3" => "^5.3.0" (now scoped)

    • "@rollup/plugin-commonjs": "^10.1.0" => "^21.0.1" (now scoped)

    • "@rollup/plugin-node-resolve": "^5.2.0" => "^13.1.3" (now scoped)

    • "documentation": "^12.1.4" => "^13.2.5"

    • "rollup": "^1.29.0" => "^2.67.0"

    • "rollup-plugin-peer-deps-external": "^2.2.4"

@vidispine/vdt-js

New

  • Stories and jsdoc/md added for public functions

Updates

  • Using @babel/runtime instead of bundling babel in rollup

dependencies

  • [Added]

    • "@babel/runtime": "^7.17.0"

    • "buffer": "^6.0.3"

devDependencies

  • [Added]

    • "babel-plugin-transform-runtime": "^7.17.0"

  • [Updated]

    • "@babel/core": "^7.17.0"

    • "@babel/plugin-external-helpers": "^7.16.7"

    • "@rollup/plugin-babel": "^4.3.3" => "^5.3.0"

    • "@babel/preset-env": "^7.16.11"

    • "@rollup/plugin-babel": "^4.3.3" => "^5.3.0" (now scoped)

    • "@rollup/plugin-commonjs": "^10.1.0" => "^21.0.1" (now scoped)

    • "@rollup/plugin-node-resolve": "^5.2.0" => "^13.1.3" (now scoped)

    • "rollup": "^1.29.0" => "^2.67.0"

    • "rollup-plugin-cleanup": "^3.2.1",

    • "rollup-plugin-peer-deps-external": "^2.2.4"

    • "rollup-plugin-sass": "^1.2.10"

@vidispine/vdt-materialui

Breaking

  • Player styles are now included in player components, so no need to import '@vidispine/vdt-materialui/dist/index.css';

Updates

  • Using @babel/runtime instead of bundling babel

  • Generally, many components got displayName, propTypes, classNames and styles added

  • Fixed materialui deprecation warnings

    • justify => justifyContent

    • createMuiTheme => createTheme

    • fade => alpha

    • onChangePage => onPageChange

    • onChangeRowsPerPage => onRowsPerPageChange

  • Improved validation for Field components' props

  • [BatonAnalysisDialog] Support for component analysis added (also fixed bugs/improvements)

  • [BatonAnalysisForm] Support for component analysis added (also fixed bugs/improvements)

  • [CollectionList] onItemClick callback added to ListItem

  • [EntityAccessTable] Prop to add custom menu text added entityAccessMenuText

  • [EventTimeline] Improved validation of props

  • [ItemTimespanTab] Improved and refactored component

    • Updated styling and easier to customize

    • Bug fixes for editing

    • New props: queryParams, ItemTimespanSelectionComponent, ItemTimespanSelectionProps, ItemTimespanBoxComponent, ItemTimespanBoxProps

  • [JobFooter] Add button to close job footer

  • [JobFooterContext] Add context values for job footer open state showJobList and setShowJobList

  • Not bundling into one file during development to support hmr/fast refresh

  • Hygen template for creating components during development updated

dependencies

  • [Added]

    • "@babel/runtime": "^7.17.0"

    • "lodash.update": "^4.10.2" (moved from devDep)

    • "typeface-exo-2": "^1.1.4"

devDependencies

  • [Added]

    • "babel-plugin-transform-runtime": "^7.17.0"

  • [Updated]

    • "@babel/core": "^7.17.0"

    • "@babel/plugin-external-helpers": "^7.16.7"

    • "@babel/preset-env": "^7.16.11"

    • "@babel/preset-react": "^7.16.7"

    • "@rollup/plugin-babel": "^4.3.3" => "^5.3.0" (now scoped)

    • "@rollup/plugin-commonjs": "^10.1.0" => "^21.0.1" (now scoped)

    • "@rollup/plugin-node-resolve": "^5.2.0" => "^13.1.3" (now scoped)

    • "@svgr/rollup": "^5.5.0" => "^6.2.1"

    • "axios-mock-adapter": "^1.20.0"

    • "enzyme": "^3.11.0"

    • "enzyme-adapter-react-16": "^1.15.6"

    • "faker": "^4.1.0" => "^5.5.3"

    • "hygen": "^6.1.0"

    • "prop-types": "^15.8.1"

    • "rollup": "^1.29.0" => "^2.67.0"

    • "rollup-plugin-peer-deps-external": "^2.2.4"

  • [Removed]

    • "@storybook/addon-actions": "^6.0.0-alpha.27"

    • "@storybook/addon-knobs": "^6.0.0-alpha.27"

    • "rollup-plugin-scss"

@vidispine/vdt-react

Updates

  • Using @babel/runtime instead of bundling babel in rollup

  • [useApi] Updated to return a cancel callback

  • [useHoverScrub] Performance improvements

  • [useQueryInitialState] Updated to support react-router-dom 6 as well

  • [useUpdateQueryState] Updated to support react-router-dom 6 as well

dependencies

  • [Added]

    • "@babel/runtime": "^7.17.0"

devDependencies

  • [Added]

    • "babel-plugin-transform-runtime": "^7.17.0"

    • "prop-types": "^15.8.1"

  • [Updated]

    • "@babel/core": "^7.17.0"

    • "@babel/plugin-external-helpers": "^7.16.7"

    • "@babel/preset-env": "^7.16.11"

    • "@babel/preset-react": "^7.16.7"

    • "@rollup/plugin-babel": "^4.3.3" => "^5.3.0" (now scoped)

    • "@rollup/plugin-commonjs": "^10.1.0" => "^21.0.1" (now scoped)

    • "@rollup/plugin-node-resolve": "^5.2.0" => "^13.1.3" (now scoped)

    • "rollup": "^1.29.0" => "^2.67.0"

    • "rollup-plugin-peer-deps-external": "^2.2.4"

  • [Removed]

    • "rollup-plugin-scss"

@vidispine/vdt-videojs-react

Breaking

  • Player styles are now included in VideoPlayer component, so no need to import '@vidispine/vdt-videojs-react/dist/index.css';

Updates

  • Using @babel/runtime instead of bundling babel

dependencies

  • [Added]

    • "@babel/runtime": "^7.17.0"

devDependencies

  • [Added]

    • "babel-plugin-transform-runtime": "^7.17.0"

    • "rollup-plugin-styles": "^4.0.0"

  • [Updated]

    • "@babel/core": "^7.17.0"

    • "@babel/plugin-external-helpers": "^7.16.7"

    • "@babel/preset-env": "^7.16.11"

    • "@babel/preset-react": "^7.16.7"

    • "@rollup/plugin-babel": "^4.3.3" => "^5.3.0" (now scoped)

    • "@rollup/plugin-commonjs": "^10.1.0" => "^21.0.1" (now scoped)

    • "@rollup/plugin-node-resolve": "^5.2.0" => "^13.1.3" (now scoped)

    • "rollup": "^1.29.0" => "^2.67.0"

    • "rollup-plugin-peer-deps-external": "^2.2.4"

  • [Removed]

    • "rollup-plugin-scss"

    • "eslint-config-airbnb", "eslint-plugin-(jsx-a11y|react|react-hooks)" (uses @vidispine/eslint-config-react instead)

@vidispine/vdt-videojs

Updates

  • Changed to being bundled with rollup instead of parcel

  • Added linting and formatting

devDependencies

  • [Added]

    • "rollup-plugin-styles": "^4.0.0"

  • [Updated]

    • "@babel/core": "^7.17.0"

    • "@babel/plugin-external-helpers": "^7.16.7"

    • "@babel/preset-env": "^7.16.11"

    • "@babel/preset-react": "^7.16.7"

    • "@rollup/plugin-babel": "^4.3.3" => "^5.3.0"

    • "@rollup/plugin-commonjs": "^10.1.0" => "^21.0.1"

    • "@rollup/plugin-json": "^4.1.0" (now scoped)

    • "@rollup/plugin-node-resolve": "^5.2.0" => "^13.1.3"

    • "babel-plugin-transform-runtime": "^7.17.0"

    • "rollup": "^1.29.0" => "^2.67.0"

    • "rollup-plugin-cleanup": "^3.2.1"

    • "rollup-plugin-peer-deps-external": "^2.2.4"

    • "rollup-plugin-sass": "^1.2.10"

  • [Removed]

    • "chokidar": "^3.3.1" "colors": "^1.4.0" "parcel-bundler": "^1.12.4" "sass": "^1.24.3" "strip-comments": "^2.0.1"

example-vdt-material-app

New

  • More Deutsche and Swedish translations added

  • Baton views upgraded to support component analysis

  • [ItemStatus] added to header in item view

  • [StatusChip] added in item grid and table

Updates

  • Fix lint scripts & linting package

  • Context values memoized in providers

  • Fixed materialui deprecation warnings

  • Custom metadata fields removed (e.g. vod_hasWatermark, location_area)

  • Bug fix for videojs throwing play() promise error in Chrome

dependencies

  • [Updated]

    • "typeface-exo-2": "^1.1.13"

devDependencies

  • [Updated]

    • "prop-types": "^15.8.1"

    • "react-scripts": "^5.0.0"

core

New

  • New project structure: separating docs, examples and tests from packages

  • Script commands updated/simplified

  • Script commands to start:docs, build:docs, lint, lint:fix added

  • Github workflow for publishing npm release and pre-release packages (published with lerna now)

  • Vscode workspace settings updated to lint js, md, mdx and formatting added for html, json

Updates

  • Github workflow for publishing storybook docs updated

  • Github workflow for publishing example app updated

  • Github workflow for running PR Tests updated

  • Removing old dist folders before building new in packages

  • Updated README.md's

devDependencies

  • [Updated]

    • "eslint": "^7.26.0" => "^8.8.0"

    • "prettier": "2.2.x" => "^2.5.1"

    • "lerna": "^3.22.1" => "^4.0.0"

  • [Removed]

    • "jest" (moved to new tests package instead)

docs

Private package for creating docs with storybook

New

  • Fixed port to 3001

  • [vdt-react] Stories added

  • [vdt-js] Stories added

    • jsdoc2md-script added to extract jsdoc to markdown storybook docs

  • Documentation added for "Development" section (only visible during yarn start:docs)

  • Linting/formatting added for package

Updates

  • Storybook upgraded - Support for new way of creating stories with "Template"

  • [vdt-materialui, vdt-videojs, vdt-videojs-react] Exiting stories updated and some new added

  • Documentation updated for "Start Here" section

  • msw and msw-storybook-addon added to mock requests in stories

dependencies

  • [Added]

    • "@material-ui/core": "^4.12.3"

    • "@vidispine/vdt-materialui": "^22.1.0"

    • "@vidispine/vdt-storybook": "*"

    • "react": "^16.14.0"

    • "react-dom": "^16.14.0"

    • "typeface-roboto": "^1.1.13"

devDependencies

  • [Added]

    • "@storybook/addon-essentials": "^6.4.18" (instead of actions/knobs/notes)

    • "@storybook/addon-postcss": "^2.0.0" (isn't default anymore)

    • "@storybook/theming": "^6.4.18",

    • "@vidispine/eslint-config-react": "^22.1.0" (eslint/formatting added to stories)

    • "@vidispine/eslint-config-storybook": "*" (only used locally during development)

    • "autoprefixer": "^10.4.2" (isn't included by default anymore)

    • "jsdoc-to-markdown": "^7.1.1"

    • "msw": "^0.36.8",

    • "msw-storybook-addon": "^1.6.0",

    • "postcss": "^8.4.6" (isn't included by default anymore)

    • "postcss-flexbugs-fixes": "^5.0.2" (isn't included by default anymore)

  • [Updated] (these were moved from deps to devDeps too)

    • "@babel/core": "^7.17.0"

    • "@storybook/addon-docs": "^6.4.18"

    • "@storybook/storybook-deployer": "^2.8.10"

  • [Removed]

    • "@storybook/addon-actions" (new way using essentials)

    • "@storybook/addon-knobs" (new way using essentials)

    • "@storybook/addon-notes" (new way using essentials)

    • "@storybook/addon-storysource"

    • "babel-loader"

    • "react-smackdown" (using internal storybook md/mdx support)

    • "reprism" (using internal storybook support)

tests

Private package with jest for testing packages (includes configuration and test data)

@vidispine/vdt-storybook

Private package used to help building stories in storybook.

  • [data] to use as mocked data in stories,

  • [decorators] for mui theme and uniforming styles of stories,

  • [utils] such as displaying argTypes from component propTypes and showing markdown in docs tab,

  • [components] such as FunctionComponent and HookComponent to use in stories.

@vidispine/eslint-config-storybook

Private package with eslint config for storybook files (.stories.{js,jsx,md,mdx})