JsInterop Base ·

jsInterop-base contains a set of utilities that cannot be expressed with Jsinterop itself and allows GWT and J2CL projects to write certain JavaScript expressions with pure Java.

---

This is Vertispan LLC's fork of jsinterop-base, aimed at making this library usable by J2CL in Maven, instead of only working in Bazel or in GWT2. The changes here are not necessarily expected to work in GWT2, but this is something we might be able to iterate on.

To follow Google's own versioning, each release of this repository will be patterned as <upstream release>-<release count>, where <upstream release> is the original tag that Google released, followed by <release count>, an integer to increment for each tagged release - when a new jsinterop-base release is made, the release count will reset to 1. Later releases off of the same upstream tag will then increment that count, should they be needed.

The release process is to rebase this set of commmits, then update the version in the pom.xml appropriately. When a release is pushed to Maven Central, a tag will be pushed to our git repository matching the version we released. Snapshot releases will use a -SNAPSHOT suffix after the release count.

This repository also restores some old methods that were removed upstream, but leaves them @Deprecated to ensure that downstream projects don't need to rely on all libraries updating instantly to new releases.

The 1.0.0-1 release is not based off of the Google 1.0.0 tag directly, but includes some extra commits cherry-picked from the main branch, as the tag itself cannot be built cleanly. No changes to the sources of the project are included, only the changed documented above.

---

Bazel dependency

If your project use Bazel, add this repository as an external dependency in your WORKSPACE file:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
_JSINTEROP_BASE_VERSION = "1.0.0"
http_archive(
    name = "com_google_jsinterop_base",
    strip_prefix = "jsinterop-base-%s" % _JSINTEROP_BASE_VERSION,
    url = "https://github.com/google/jsinterop-base/archive/%s.zip" % _JSINTEROP_BASE_VERSION,
)

Then add @com_google_jsinterop_base//:jsinterop-base-j2cl to your j2cl_library deps.

Maven dependency

If your project use Maven, add maven dependency in your pom.xml:

<dependency>
  <groupId>com.google.jsinterop</groupId>
  <artifactId>base</artifactId>
  <version>1.0.0</version>
</dependency>

Download the jar file

You can also download manually the jar file.

GWT

If you use jsinterop-base with GWT, you need to inherit the following gwt module in your gwt.xml file:

<inherits name="jsinterop.base.Base" />

Build GWT compatible maven jar files

If you want to build the last version on your own, follow the instructions below:

• Install Bazel.

• clone this repository with git: git clone https://github.com/google/jsinterop-base.git

• Inside the repository, run the script release_jsinterop_base.sh:

   $ ./release_jsinterop_base.sh --version local --no-deploy
  

The script will output the directory containing the generated jar files that can be used with maven.

Contributing

Please refer to the contributing document.

Licensing

Please refer to the license file.

Disclaimer

This is not an official Google product.