@remixproject/engine-web

v0.3.38

The web engine provides a connector for Iframe & Websocket. `npm install @remixproject/engine-web` For more information about how to use this package see README

Latest version published 1 year ago

License: MIT

NPM

GitHub

Package Health Score

58 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.3.38	\|	06/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (141)

GitHub Stars: 163
Forks: 104
Contributors: 20

Direct Usage Popularity

The npm package @remixproject/engine-web receives a total of 141 downloads a week. As such, we scored @remixproject/engine-web popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @remixproject/engine-web, we found that it has been starred 163 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the @remixproject/engine-web repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like @remixproject/engine-web is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 49
Open PR: 30
Last Release: 1 year ago
Last Commit: 1 year ago

Further analysis of the maintenance status of @remixproject/engine-web based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @remixproject/engine-web is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 4 years
Dependencies: 3 Direct
Versions: 93
Install Size: 28.7 kB
Dist-tags: 3
# of Files: 26
Maintainers: 6
TS Typings: Yes

@remixproject/engine-web has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Engine Web

The web engine provides a connector for Iframe & Websocket. npm install @remixproject/engine-web

Iframe

The iframe connector is used to load & connect a plugin inside an iframe. Iframe based plugin are webview using an index.html as entry point & need to use @remixproject/plugin-iframe.

const myPlugin = new IframePlugin({
  name: 'my-plugin',
  url: 'https://my-plugin-path.com',
  methods: ['getData']
})
engine.register(myPlugin);
// This will create the iframe with src="https://my-plugin-path.com"
await manager.activatePlugin('my-plugin');
const data = manager.call('my-plugin', 'getData');

Communication between the plugin & the engine uses the window.postMessage() API.

Websocket

The websocket connector wraps the native Websocket object from the Web API. Websocket based plugin are usually server with a Websocket connection open. Any library can be used, remixproject provide a wrapper around the ws library : @remixproject/plugin-ws.

const myPlugin = new WebsocketOptions({
  name: 'my-plugin',
  url: 'https://my-server.com',
  methods: ['getData']
}, {
  reconnectDelay: 5000 // Time in ms to wait to reconnect after a disconnection 
});
engine.register(myPlugin);
// This will open a connection with the server. The server must be running first.
await manager.activatePlugin('my-plugin');
const data = manager.call('my-plugin', 'getData');

@remixproject/engine-web dependencies

@remixproject/plugin-utils @remixproject/engine @remixproject/plugin-api

FAQs

What is @remixproject/engine-web?

The web engine provides a connector for Iframe & Websocket. `npm install @remixproject/engine-web`. Visit Snyk Advisor to see a full health score report for @remixproject/engine-web, including popularity, security, maintenance & community analysis.

Is @remixproject/engine-web popular?

The npm package @remixproject/engine-web receives a total of 141 weekly downloads. As such, @remixproject/engine-web popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @remixproject/engine-web well maintained?

We found indications that @remixproject/engine-web is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @remixproject/engine-web safe to use?

The npm package @remixproject/engine-web was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 9 November-2024, at 18:02 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP