feat!: v3 refactor (#1886)

* feat!: enable Suspense by default (#1775)

BREAKING CHANGES: enable Suspense by default, remove environment checks

* feat!: try out ESM only on canary (#1826)

BREAKING CHANGES: remove CJS and IIFE

* fix: type issue

* fix: improve types resolution (#1827)

* fix: Move exports.key.default to last position (#1828)

* feat: TS, function comps, media-elements

* feat: add config prop support

* test: update tests

* fix: upgrade Mux player

* fix: re-render issue, remove default wrapper,
update App to use function components,
update responsive logic and docs

* test: fix tests

* docs: add more docs and migration docs

* fix: allow video without src for source & track

* example: fix error callback

* fix: rename url to src

* docs: add more migrating changes

---------

Co-authored-by: Karl Horky <[email protected]>

Author: luwes

.github/workflows/cd.yml

@@ -56,10 +56,8 @@ jobs:
       - run: npm ci
       - run: npm run lint
       - run: npm run test:coverage
-      - run: npm run build:lib
+      - run: npm run build
       - run: npm run build:demo
-      - run: npm run build:dist
-      - run: npm run build:standalone
       - run: npx --yes [email protected] release ${{ inputs.version }} ${{ inputs.dryrun && '--dry-run' || '' }} ${{ inputs.prerelease && format('--prerelease {0}', inputs.prerelease) || '' }} --provenance --github-release --verbose
       - name: Get NPM version
         id: npm-version

.github/workflows/ci.yml

@@ -58,10 +58,8 @@ jobs:
         node-version: ${{ matrix.node-version }}
         cache: npm
     - run: npm ci
-    - run: npm run build:lib
+    - run: npm run build
     - run: npm run build:demo
-    - run: npm run build:dist
-    - run: npm run build:standalone
 
   deploy-preview:
     # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
@@ -82,7 +80,7 @@ jobs:
         with:
           node-version: 20
       - run: npm ci
-      - run: npm run build:lib
+      - run: npm run build
       - run: npm run build:demo
       - uses: actions/upload-pages-artifact@v3
         with:

.gitignore

@@ -10,3 +10,4 @@ yarn-error.log
 .idea/
 .vscode/
 /disttest/
+/dist/

.npmignore

@@ -1,3 +1,57 @@
+## Migrating to `v3.0`
+
+Breaking changes are in 🔥 __bold and on fire__.
+
+### Some player providers are not supported yet
+
+Since `v3.0` is a new architecture not all providers have been updated.
+It is recommended to keep using `v2` and vote to add this provider to `v3` in [discussions](https://github.com/cookpete/react-player/discussions).
+These include:
+
+  - `Dailymotion`
+  - `SoundCloud`
+  - `Streamable`
+  - `Twitch`
+  - `Facebook`
+  - `Mixcloud`
+  - `Kaltura`
+
+### Lazy players
+
+As of `v3.0` all the players are lazy loaded by default. 
+Due to the use of `lazy` and `Suspense`, 🔥 __React 16.6 or later is now required__.
+
+### Player props
+
+As of `v3.0` some player props are renamed to be closer to the native
+[HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement) naming.
+
+- 🔥 __`url` => `src`__
+- 🔥 __`playsinline` => `playsInline`__
+- 🔥 __`progressInterval` deprecated
+- 🔥 __`stopOnUnmount` => deprecated
+- 🔥 __`wrapper` is `undefined` by default. Set to `div` if you want a wrapper element.
+
+### Player instance methods
+
+As of `v3.0` use [`ref`](https://react.dev/learn/manipulating-the-dom-with-refs) to call instance methods on the player. See [the demo app](examples/react/src/App.js) for an example of this. Since `v3`, the instance methods aim to be 🔥 __compatible 
+with the [HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement) interface__.
+
+### Player callback props
+
+As of `v3.0` some player callback props are renamed to be closer to the native
+[HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement) event naming.
+
+- 🔥 __`onProgress` => `onTimeUpdate` and `onProgress`__
+- 🔥 __`onDuration` => `onDurationChange`__
+- 🔥 __`onPlaybackRateChange` => `onRateChange`__
+- 🔥 __`onSeek` => `onSeeking` and `onSeeked`__
+- 🔥 __`onBuffer` => `onWaiting`__
+- 🔥 __`onBufferEnd` => `onPlaying`__
+- 🔥 __`onEnablePIP` => `onEnterPictureInPicture`__
+- 🔥 __`onDisablePIP` => `onLeavePictureInPicture`__
+
+
 ## Migrating to `v2.0`
 
 Breaking changes are in 🔥 __bold and on fire__.

MIGRATING.md

@@ -0,0 +1,9 @@
+{
+  "files": {
+    "include": ["src/**/*.js", "src/**/*.jsx", "src/**/*.ts", "src/**/*.tsx"],
+    "ignore": ["dist/**"]
+  },
+  "formatter": {
+    "indentStyle": "space"
+  }
+}