npmpackage.info

@sap-devx/webview-rpc

Provides a conventient way to communicate between VSCode extension and his Webviews. Use RPC calls to invoke functions on the webview and receive callbacks.

1.0.0

Apache-2.0

TypeScript

42.60 kB

451,448 3.8

Installations

npm install @sap-devx/webview-rpc

Developer Guide

BETA

Typescript

No

Module System

N/A

Node Version

18.20.2

NPM Version

10.5.0 Score

Supply Chain

99.5

Quality

81.3

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

7

Total

536

Closed

434

Merged

95

Issues

Open

0

Total

3

Closed

3

Releases

v1.0.0

Updated on Apr 21, 2024

v0.4.2

Updated on Apr 17, 2024

v0.4.1

Updated on Jan 26, 2022

v0.4.0

Updated on Jan 25, 2022

v0.3.1

Updated on Feb 07, 2021

v0.3.0

Updated on Feb 07, 2021

View All 6 releases

Contributors

608

Unable to fetch Contributors

View All 608 Contributors

Languages

TypeScript

HTML

JavaScript

TypeScript (88.38%)

HTML (7.77%)

JavaScript (3.85%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

SAP

Download Statistics

Total Downloads

451,448

Last Day

259

Last Week

3,270

Last Month

13,780

Last Year

173,960

GitHub Statistics

Apache-2.0 License

35 Stars

190 Commits

5 Forks

5 Watchers

8 Branches

608 Contributors

Updated on Jan 26, 2025

Maintainers

Package Meta Information

Latest Version

1.0.0

Package Id

@sap-devx/webview-rpc@1.0.0

Unpacked Size

42.60 kB

Size

10.73 kB

File Count

NPM Version

10.5.0

Node Version

18.20.2

Published on

Apr 21, 2024

Total Downloads

Cumulative downloads

Total Downloads

451,448

Last Day

-8.5%

259

Compared to previous day

Last Week

-2.7%

3,270

Compared to previous week

Last Month

17.8%

13,780

Compared to previous month

Last Year

15.7%

173,960

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

@commitlint/cli @commitlint/config-conventional @types/jest @types/node @types/vscode @types/ws @typescript-eslint/eslint-plugin @typescript-eslint/parser @vscode-logging/types coveralls cz-conventional-changelog eslint husky jest rimraf ts-jest typescript

vscode-webview-rpc-lib

Description

Provides a conventient way to communicate between VSCode extension and its webviews. Use RPC calls to invoke functions on the webview, receive callbacks and vice versa.

Requirements

You need to have node.js installed on your machine. Also, to use this library, you need to run it inside a VSCode extension using VSCode or Theia.

How to use

An example of using this libary can be seen under the "example" folder.

Installation

Create VSCode extension with a Webview. To create your extension go to https://code.visualstudio.com/api/extension-guides/webview.
Install using npm
```
1npm install @sap-devx/webview-rpc
```
This will install the library in your node_modules folder. The extension library can be used as any node.js module (with TypeScript). The webview library needs to be imported to your html.

Add the following script to the root html of your Webview

1<head>
2    <script>var exports = {};</script>
3    <script type="module" src="vscode-resource:/node_modules/@sap-devx/webview-rpc/out.browser/rpc-common.js"></script>
4    <script type="module" src="vscode-resource:/node_modules/@sap-devx/webview-rpc/out.browser/rpc-browser.js"></script>
5    <script type="module" src="vscode-resource:/out/media/main.js"></script>
6</head>

Initializations

Create new instance of the Rpc in the extension side and the Webview side

In the extension code use the following example to start new instance of the RpcExtension:
```
1this._rpc = new RpcExtension(this._panel.webview);
```
In the Webview JS code use the following example to start new instance of the RpcBrowser:
```
1const vscode = acquireVsCodeApi();
2let rpc = new RpcBrowser(window, vscode);
```

Register methods

In order to invoke an extension method from the webbiew or webview method from the extension, you will have to register the functions that can be invoked. Here is an example on how to register the methods

1function add(a,b) {
2    return a+b;
3}
4
5rpc.registerMethod({func: add});

Usage

To invoke a method use the invoke method on the rpc instance. You can pass a callback that will be invoked once the response received.
For version < 1.x :

1rpc.invoke("add", [1,2]).then((response)=>{
2    console.log("1+2="+response);
3});

Since version 1.x :

1rpc.invoke("add", 1,2).then((response)=>{
2    console.log("1+2="+response);
3});

Build and Development

To build for development purpose do the following:

Run "npm install" on the repo to download the project dependencies.
```
1npm install @sap-devx/webview-rpc
```
Run "npm run compile-ext" to compile the extension library sources to javascript. The compilation results will be on the directory "out.ext".
```
1npm run compile-ext
```
Run "npm run compile-browser" to compile the browser library sources to javascript. The compilation results will be on the directory "out.browser".
```
1npm run compile-browser
```
Run the test using "npm run test".
```
1npm run test
```

Known Issues

Browser library is does not generate d.ts files.
overcome Cors issue preventing post message to get through and hit the window: use the setHost method and sent the host name from the webview - and then the message should get through.

How to obtain support

To get more help, support and information please open a github issue.

Contributing

Contributing information can be found in the CONTRIBUTING.md file.

To-Do (upcoming changes)

remove the need to decalre exposed functions

No vulnerabilities found.

10

Dangerous-Workflow

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

10

Binary-Artifacts

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

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

10

Security-Policy

Determines if the project has published a security policy.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

1

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

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

0

Fuzzing

Determines if the project uses fuzzing.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.8

/10

Last Scanned on 2025-02-10

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