Bubblewrap

Bubblewrap is a set of tools and libraries designed to help developers to create, build and update projects for Android Applications that launch Progressive Web App (PWA) using Trusted Web Activity (TWA).

Requirements

• Node.js 12.0 or above

Getting Started

• To get started with building an application using Bubblewrap, check the Trusted Web Activity Quick Start Guide or the bubblewrap/cli documentation.

Bubblewrap Components

• bubblewrap/core: a javascript library for generating, building and updating TWA projects.
• bubblewrap/cli: a command-line version of Bubblewrap.
• bubblewrap/validator: library to validate the correctness and compare Trusted Web Activity projects against the quality criteria.

Community

We welcome anyone who wants to contribute with issues, feedback, feature requests or just generally discuss Bubblewrap. Alternatively developers can contribute to the conversation by joining the public monthly office hours, which hosted on every first Thursday at 5PM, London time. Check when the next office hours is going to happen via this calendar and join the meeting via this link.

Getting started with GUI tools

• If you are just getting started with APK generation from PWA, You might want to check PWABuilder. This tool is powered by Bubblewrap and uses the same underlying core.

Contributing

See CONTRIBUTING for more.

License

See LICENSE for more.

Disclaimer

This is not an officially supported Google product.

v1.3.1 (2020-06-04)

:rocket: Enhancement

• cli, validator
  • #189 Adds Web Vitals metrics to validation (@andreban)
• cli
  • #186 Adds version, --version and --help commands (@andreban)

:bug: Bug Fix

• core
  • #191 Runs apksigner.jar instead of apksigner.bat on win32 (@andreban)

Committers: 1

• André Cipriani Bandarra (@andreban)

v1.3.0 (2020-05-27)

:rocket: Enhancement

• cli, core
  • #179 Generates assetlinks.json when building the App (@andreban)

:memo: Documentation

• #182 Link badge to workflow page (@Maxim-Mazurok)

Committers: 2

• André Cipriani Bandarra (@andreban)
• Maxim Mazurok (@Maxim-Mazurok)

v1.2.2 (2020-05-20)

:bug: Bug Fix

• cli, core, validator
  • #178 Prevent build failing when PSI fails (@andreban)

Committers: 1

• André Cipriani Bandarra (@andreban)

v1.2.1 (2020-05-18)

:house: Internal

• core
  • #174 Updates android-browser-helper version (@andreban)

Committers: 1

• André Cipriani Bandarra (@andreban)

v1.2.0 (2020-05-14)

:rocket: Enhancement

• cli, core
  • #161 Adds a bubblewrap install command (@andreban)
  • #157 Improves AndroidSdkTools errors (@andreban)
• cli
  • #160 CLI checks minimum supported Node.js version (@andreban)

:bug: Bug Fix

• core
  • #170 Ensure gradlew has execute permission (@andreban)

:memo: Documentation

• Other
  • #164 Update main README.md to help devs get started (@andreban)
• cli
  • #158 Updated Documentation for more detailed steps on requirements (@amanintech)

:house: Internal

• cli, core, validator
  • #165 Runs npm update and npm audit fix (@andreban)
• core
  • #162 Extract information from signing keys (@andreban)

Committers: 2

• Aman Sharma (@amanintech)
• André Cipriani Bandarra (@andreban)

v1.1.2 (2020-05-01)

:bug: Bug Fix

• core
  • #148 Fixes --sdk_root parameter on Windows (@andreban)

Committers: 1

• André Cipriani Bandarra (@andreban)

  v1.1.0 (2020-04-27)

:boom: Breaking Change

• cli, core
  • #142 Improves packageId generation / validation (@andreban)

:rocket: Enhancement

• cli, core
  • #142 Improves packageId generation / validation (@andreban)

:bug: Bug Fix

• core
  • #145 Fix for CLI to work on latest Android CLI Tools (@andreban)

Committers: 1

• André Cipriani Bandarra (@andreban)

v1.0.0 (2020-04-21)

:rocket: Enhancement

• cli, core
  • #135 Implements input validation for the AplicationId (@andreban)
• cli, validator
  • #134 Adds a validator module to Bubblewrap (@andreban)
• cli
  • #133 Adds instructions to update the CLI config (@andreban)

:memo: Documentation

• cli
  • #137 Adds CLI commands documentation (@andreban)

:house: Internal

• #129 Bump actions/checkout from v1 to v2 (@imbsky)

Committers: 2

• André Cipriani Bandarra (@andreban)
• BSKY (@imbsky)

v0.6.0 (2020-03-23)

:rocket: Enhancement

• core
  • #126 Updates android-browser-helper and enables WebView fallback on config (@andreban)

:house: Internal

• cli, core
  • #128 Runs npm audit fix and npm update (@andreban)

Committers: 1

• André Cipriani Bandarra (@andreban)

v0.5.2 (2020-03-11)

:rocket: Enhancement

• core
  • #122 Add console warnings if a shortcut has been skipped. (@rayankans)
  • #120 Increases minSdkVersion to 19 (@andreban)

:memo: Documentation

• cli, core
  • #121 Renames llama-pack => BubbleWrap (@andreban)

Committers: 2

• André Cipriani Bandarra (@andreban)
• Rayan Kanso (@rayankans)

v0.5.0 (2020-03-03)

:boom: Breaking Change

• cli, core
  • #109 Move Config read/write into cli (@NotWoods)

:rocket: Enhancement

• core
  • #117 Adaptative Icons Improvements (@andreban)
• cli, core
  • #108 Reduce package size by omitting tests & build tools (@NotWoods)

:bug: Bug Fix

• core
  • #114 Fix packageName generation (@andreban)

:house: Internal

• cli, core
  • #109 Move Config read/write into cli (@NotWoods)

Committers: 2

• André Cipriani Bandarra (@andreban)
• Tiger Oakes (@NotWoods)

v0.4.3 (2020-02-13)

:boom: Breaking Change

• cli, core
  • #101 Splits the project into core and cli modules (@andreban)

:rocket: Enhancement

• cli, core
  • #102 Fixes handling of maskable images (@andreban)
• Other
  • #98 Adds web-manifest-url meta-tag and web-app-manifest.json (@andreban)
  • #96 update upgrades versionCode and versionName (@andreban)
  • #91 Allows automated builds (@andreban)
  • #89 Adds help messages to the help command (@andreban)
  • #90 Adds a generator_app metatag to AndroidManifest.xml (@andreban)
  • #85 Updates to use android-browser-helper 1.1.0 (@andreban)
  • #73 Allows Customizing Project Location on Gradle Wrapper (@andreban)
  • #71 Reset versionName (@abdonrd)
  • #69 Update default navigationColor to black as PWAs (@abdonrd)
  • #67 Add new launcherName field (@abdonrd)
  • #64 Update com.android.tools.build:gradle version (@abdonrd)
  • #63 Move distributionUrl to the bottom (@abdonrd)

:bug: Bug Fix

• #93 Report an Error when iconUrl is not 200 (@andreban)
• #92 Fixes using the wrong password when building the app (@andreban)
• #83 Escaping user input to key tool (@JudahGabriel)
• #60 Fixes UnhandledPromiseRejection errors (@andreban)

:house: Internal

• #99 Refactors TwaManifest.shortcuts (@andreban)
• #94 Runs audit-fix to upgrade packages with vulnerabilities (@andreban)
• #86 Moves cli to TypeScript and uses Inquirer.js (@andreban)
• #84 Adds missing private keywords (@andreban)
• #82 Converts KeyTool.js to TypeScript (@andreban)
• #81 Converts TwaGenerator.js and Log.js to TypeScript (@andreban)
• #78 Converts util.js and utilSpec.js into TypesScript (@andreban)
• #75 Converts more Classes into Typescript (@andreban)

Committers: 3

• Abdón Rodríguez Davila (@abdonrd)
• André Cipriani Bandarra (@andreban)
• Judah Gabriel Himango (@JudahGabriel)

0.3.0 (2020-01-08)

:rocket: Enhancement

• #55 Uses android-browser-helper (@andreban)
• #56 Improve shortcut icon selection. (@rayankans)

:house: Internal

• #54 Typescript lint (@andreban)

Committers: 2

• André Cipriani Bandarra (@andreban)
• Rayan Kanso (@rayankans)

0.2.0 (2019-12-18)

:rocket: Enhancement

• #53 Updates to use useBrowserOnChromeOS (@andreban)
• #46 Support WebManifest shortcuts when generating the TWA (@rayankans)

:bug: Bug Fix

• #47 Paths with space fix (@andreban)
• #43 Fix import for jimp-resize (@andreban)

:memo: Documentation

• #39 Update README.md (@andreban)

:house: Internal

• #42 Configure eslint to lint ts files (@NotWoods)
• #41 Use custom jimp build (@NotWoods)
• #40 Transforms Config into TypeScript (@andreban)

Committers: 3

• André Cipriani Bandarra (@andreban)
• Rayan Kanso (@rayankans)
• Tiger Oakes (@NotWoods)