Skip to content
This repository was archived by the owner on Apr 13, 2025. It is now read-only.

chore(deps): bump obs-websocket-js from 4.0.3 to 5.0.0 #668

Merged
merged 2 commits into from
Jul 10, 2022

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jul 9, 2022

Bumps obs-websocket-js from 4.0.3 to 5.0.0.

Release notes

Sourced from obs-websocket-js's releases.

v5.0.0

v5 is made for obs-websocket versions 5.x that uses a completely new protocol and isn't backwards compatible with 4.x. If you're planning to build something for 4.x, consider upgrading (as all releases for future obs versions will be based on v5) or use the latest/last v4 version.

Breaking changes

  • Obviously, only 5.x of obs-websocket is supported. In case an older version of the server is detected, the connection is automatically closed and the connect promise is rejected
  • Distribution files target a more modern environment allowing for smaller builds for modern browsers and runtimes. Should you still want to target older browsers, make sure to configure your bundler to transpile dependencies.
  • async connect(args = {}) has been changed to async connect(address = 'ws://localhost:4444', password?: string, options?: IdentifyMessageFields)
  • send(type, data) has been replaced with call(type, data), aligning with simpleobsws
    • Due to changes between obs-websocket 4.x and 5.x, you'll likely need to check all send calls anyway to match the new request names
  • sendCallback has been removed, use the promise chain if you want to keep callback syntax (.send(...).then((res) => { ... }, (error) => { ... }))

v5.0.0-beta.2

v5.0.0-beta.1

For changes between 4.x and 5.x see release notes for v5.0.0-alpha.0

v5.0.0-alpha.5

For changes between 4.x and 5.x see release notes for v5.0.0-alpha.0

  • Fixed __esModule flag for improved support for cjs scripts using esModuleInterop

v5.0.0-alpha.4

For changes between 4.x and 5.x see release notes for v5.0.0-alpha.0

v5.0.0-alpha.3

For changes between 4.x and 5.x see release notes for v5.0.0-alpha.0

  • Add __esModule flag to improve support for cjs scripts using esModuleInterop
  • Flag package as side-effect free

v5.0.0-alpha.2

For changes between 4.x and 5.x see release notes for v5.0.0-alpha.0

v5.0.0-alpha.1

For changes between 4.x and 5.x see release notes for v5.0.0-alpha.0

  • Improve error object when connection fails in browsers
  • Typescript: export EventTypes (map of all events including internal)
  • Update typings to the latest obs-websocket commit

... (truncated)

Commits
  • 159cd55 5.0.0
  • 593a26e Update readme for v5 release
  • 1a20a48 Update typings for obs-websocket 5.0
  • 3340572 5.0.0-beta.2
  • 3345acd Update test matrix, packages
  • 11c6ee1 Rename cdn build to use js extension
  • d17b707 Use exports types for tsd files
  • e71e8d5 Add proxy d.ts files to fix typescript with explicit encoding imports (eg. `o...
  • c1ee0cb Update default port to match 5.0.0-alpha0 changes
  • 4e4a75e 5.0.0-beta.1
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot will merge this PR once CI passes on it, as requested by @daniel0611.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code labels Jul 9, 2022
@hlxid
Copy link
Member

hlxid commented Jul 9, 2022

@dependabot squash and merge

@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Jul 9, 2022

One of your CI runs failed on this pull request, so Dependabot won't merge it.

Dependabot will still automatically merge this pull request if you amend it and your tests pass.

@hlxid
Copy link
Member

hlxid commented Jul 9, 2022

Eh, usage obviously changed with this major update. Will fix this hopefully tomorrow.

@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/obs-websocket-js-5.0.0 branch from f4e7f3f to bce964c Compare July 9, 2022 21:38
Bumps [obs-websocket-js](https://github.com/obs-websocket-community-projects/obs-websocket-js) from 4.0.3 to 5.0.0.
- [Release notes](https://github.com/obs-websocket-community-projects/obs-websocket-js/releases)
- [Commits](obs-websocket-community-projects/obs-websocket-js@v4.0.3...v5.0.0)

---
updated-dependencies:
- dependency-name: obs-websocket-js
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/obs-websocket-js-5.0.0 branch from bce964c to c23ed92 Compare July 9, 2022 21:50
@hlxid hlxid merged commit f3af3c6 into main Jul 10, 2022
@hlxid hlxid deleted the dependabot/npm_and_yarn/obs-websocket-js-5.0.0 branch July 10, 2022 19:59
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant