Workbox v2.0.0

What's new?

The v2.0.0 introduces a few breaking changes to interfaces, along with bug fixes and new functionality. Please read carefully before upgrading!

Note that all Workbox packages have been tagged with the 2.0.0 version number on npm, regardless of whether they have breaking changes or not.

Breaking changes

workbox-cli

• Move towards using 'workbox' over 'workbox-cli'.
  The workbox-cli alias for the command line interface is now deprecated, in favor of the preferred workbox alias. Using workbox-cli will log a warning message, and it will be removed as an alias in a future release. Developers are encouraged to switch to using workbox now.

workbox-routing

• No longer register a fetch handler for each Router by default
  We've made registering a fetch handler optional, allowing developers who want more control to use the Router class from inside any fetch handler.
  Developers who are using the workbox-routing module directly can call router.addFetchListener() to mimic the previous behavior.

workbox-runtime-caching

• Rename cacheWillMatch to cachedResponseWillBeUsed
  Developers who have implemented their own Workbox plugins that respond to cacheWillMatch lifecycle events should rename the method they expose to cachedResponseWillBeUsed. Developers using the pre-made plugins do not need to change anything.
• Adds JSDocs for the lifecycle methods, and awaits the return of each.
  The underlying RequestWrapper object that triggers request lifecycle methods will now always await the methods' return values. No changes should be necessary unless you've implemented your own plugin which returns a Promise and you do not want the RequestWrapper to delay while waiting for it to resolve.

New features

workbox-range-requests

• New library to support Range requests
  This allows Workbox to honor the Range: request header when fulfilling requests for cached resources. This comes up often when playing back cached media content.

Other changes

workbox-build

• Improved the workbox-build JSDoc

workbox-webpack-plugin

• adding manifest transform for webpack public path

Workbox 1.3.0

What's new?

The v1.3.0 release contains a few bug fixes for the workbox-build and workbox-sw projects.

It also includes some internal testing changes.

Note that packages that have not changed since the last release will not be tagged with a new version number on npm.

workbox-build

• fixed: bug that cauases passed in manifestTransforms not to run (thanks to @HenrikJoreteg)

workbox-routing

• Adds JSDocs for the handleFetch parameter

workbox-sw

• Fix for multiple cacheId prefixes in the precache handler (thanks to @HenrikJoreteg for reporting)
• Add all of workbox-sw's devDependencies to fix Lerna's versioning.

Workbox 1.2.0

What's new?

The v1.2.0 release contains a number of smaller changes and bug fixes across several packages; note that packages that have not changed since the last release will not have a 1.2.0 version published on npm.

workbox-background-sync

• fixing queue initialization bug

workbox-build

• typo: fix small typo (thanks to @markgoho)
• Copies sourcemap over with source files
• Adding defaults to workbox-build
• Add use strict to generate-sw for Node 4 support (thanks to @MaxLeiter)
• Adds support for manifestTransforms

workbox-cache-expiration

• Fixes a bug with cacheFirst handler + maxAgeSeconds + CORS request (h/t to @pbakaus for reporting)

workbox-precaching

• Adding some logging for the precache details

Workbox 1.1.0

What's new?

The v1.1.0 release contains a number of smaller changes and bug fixes across multiple packages.

workbox-sw

• You can now unregister previously registered routes using workbox-sw: #632
• The URL's query parameters will be included when matching NavigationRoute's white/blacklist: #637
• Makes it easier to register custom Route instances when using workbox-sw: #639
• Support for using non-GET HTTP verbs in workbox-sw's routes: #662

workbox-build / workbox-cli / workbox-webpack-plugin

• Ignore node_modules by default when using workbox-build: #609
• Improvements to workbox-cli when run from a directory that doesn't have subdirectories, or has hidden directories: #614 and #616
• workbox-build no longer unconditionally prepends a leading '/': #560

workbox-background-sync

• Fixes to replaying requests in workbox-background-sync: #601
• Added additional callbacks to workbox-background-sync: #666

Common

• Smaller dev bundles: #594
• Hashes present in request URLs will be stripped: #633