npmpackage.info

Gathering detailed insights and metrics for @allex/webrtc-adapter

@allex/webrtc-adapter

Shim to insulate apps from spec changes and prefix differences. Latest adapter.js release:

6.4.4

3,657

BSD-3-Clause

JavaScript

20.23 kB

674 6.4

Installations

npm install @allex/webrtc-adapter

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=6.0.0

Node Version

10.5.0

NPM Version

6.7.0 Score

76.3

Supply Chain

91.2

Quality

74.5

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

2

Total

796

Closed

89

Merged

705

Issues

Open

7

Total

361

Closed

354

Releases

9.0.0

v9.0.0

Published on 27 Mar 2024

v8.0.0

Published on 06 May 2021

v7.2.5

Published on 07 Jul 2019

Fix issue with usage of this in addTrack/removeTrack shim

v7.1.1

Published on 11 Dec 2018

shim connectionState

v7.1.0

Published on 11 Dec 2018

ES6 all the things

v7.0.0

Published on 26 Nov 2018

View all 90 releases

Contributors

Unable to fetch Contributors

View all 74 contributors

Languages

JavaScript

HTML

JavaScript (99.92%)

HTML (0.08%)

Developer

webrtchacks

Download Statistics

Total Downloads

674

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

3,657 Stars

3,069 Commits

845 Forks

166 Watching

9 Branches

74 Contributors

Bundle Size

83.07 kB

Minified

20.23 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

6.4.4

Package Id

@allex/webrtc-adapter@6.4.4

Unpacked Size

740.10 kB

Size

182.74 kB

File Count

NPM Version

6.7.0

Node Version

10.5.0

Total Downloads

Cumulative downloads

Total Downloads

674

Last day

Compared to previous day

Last week

Compared to previous week

Last month

22.2%

Compared to previous month

Last year

-27.7%

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

WebRTC adapter

adapter.js is a shim to insulate apps from spec changes and prefix differences. In fact, the standards and protocols used for WebRTC implementations are highly stable, and there are only a few prefixed names. For full interop information, see webrtc.org/web-apis/interop.

This repository used to be part of the WebRTC organisation on github but moved. We aim to keep the old repository updated with new releases.

Install

NPM

1npm install webrtc-adapter

Bower

1bower install webrtc-adapter

Usage

NPM

Copy to desired location in your src tree or use a minify/vulcanize tool (node_modules is usually not published with the code). See webrtc/samples repo as an example on how you can do this.

Prebuilt releases

Web

In the gh-pages branch prebuilt ready to use files can be downloaded/linked directly. Latest version can be found at https://webrtc.github.io/adapter/adapter-latest.js. Specific versions can be found at https://webrtc.github.io/adapter/adapter-N.N.N.js, e.g. https://webrtc.github.io/adapter/adapter-1.0.2.js.

Bower

You will find adapter.js in bower_components/webrtc-adapter/.

NPM

In node_modules/webrtc-adapter/out/ folder you will find 4 files:

adapter.js - includes all the shims and is visible in the browser under the global adapter object (window.adapter).
adapter_no_edge.js - same as above but does not include the Microsoft Edge (ORTC) shim.
adapter_no_edge_no_global.js - same as above but is not exposed/visible in the browser (you cannot call/interact with the shims in the browser).
adapter_no_global.js - same as adapter.js but is not exposed/visible in the browser (you cannot call/interact with the shims in the browser).

Include the file that suits your need in your project.

Development

Head over to test/README.md and get started developing.

Publish a new version

Go to the adapter repository root directory
Make sure your repository is clean, i.e. no untracked files etc. Also check that you are on the master branch and have pulled the latest changes.
Depending on the impact of the release, either use patch, minor or major in place of <version>. Run npm version <version> -m 'bump to %s' and type in your password lots of times (setting up credential caching is probably a good idea).
Create and merge the PR if green in the GitHub web ui
Go to the releases tab in the GitHub web ui and edit the tag.
Add a summary of the recent commits in the tag summary and a link to the diff between the previous and current version in the description, example.
Go back to your checkout and run git pull
Run npm publish (you need access to the webrtc-adapter npmjs package)
Done! There should now be a new release published to NPM and the gh-pages branch.

Note: Currently only tested on Linux, not sure about Mac but will definitely not work on Windows.

Publish a hotfix patch versions

In some cases it may be necessary to do a patch version while there are significant changes changes on the master branch. To make a patch release,

checkout the latest git tag using git checkout tags/vMajor.minor.patch.
checkout a new branch, using a name such as patchrelease-major-minor-patch.
cherry-pick the fixes using git cherry-pick some-commit-hash.
run npm version patch. This will create a new patch version and publish it on github.
check out origin/bumpVersion branch and publish the new version using npm publish.
the branch can now safely be deleted. It is not necessary to merge it into the main branch since it only contains cherry-picked commits.

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

Pinned-Dependencies

Determines if the project has declared and pinned its dependencies.

6

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

5

Code-Review

Determines if the project requires code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has a CII Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

Score

6.4

/10

Last Scanned on 2022-08-15

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@allex/webrtc-adapter

Installations

Developer Guide

No

CommonJS

>=6.0.0

10.5.0

6.7.0

Score

Pull Requests

2

796

89

705

Issues

7

361

354

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

83.07 kB

20.23 kB

Maintainers

Package Meta Information

Total Downloads

674

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

WebRTC adapter

Install

NPM

Bower

Usage

NPM

Prebuilt releases

Web

Bower

NPM

Development

Publish a new version

Publish a hotfix patch versions

10

10

10

10

10

9

6

5

0

0

0

0

6.4

/10