Releases

Bug Fixes

• types: mark module options fields as optional (#420) (7d75c28)

Bug Fixes

• workbox: add additional details for uncaught errors and fix chromium cors (#417) (f20489c)
• workbox: deepClone options to avoid cross-build mutation (e39027e)

Update Notes

If you was previously using workbox.clientsClaim: false option in nuxt.config to handle uncaught error, you have to revert it because disabling makes caching issues

Bug Fixes

• avoid adding revision to start_url (1c44cff)

Bug Fixes

• append to start_url without query param (fixes #403) (054b8a2)

Features

• manifest: add revision to start_url (ad26827)

Bug Fixes

• manifest: invalidate start_url cache (240d4a1)
• add revision to precache assets (#386) (872dce1)

Bug Fixes

• serve static webpack assets from disk in dev mode (fixes #373) (8298f95)

Bug Fixes

• workbox: precache start_url (resolves #372) (27e19a0)

Changes

• Support static mode build cache (#371) (9a825c9) (resolves #367, #353, #352)
• meta: fix mergeMeta cjs export (774f1a8) (resolves #369)

Bug Fixes

• meta: avoid unnecessary log for meta.json (de8e039)
• meta: fix issues regarding favicon.ico fallback (7a1e773)

Bug Fixes

• meta: load meta when ssr is disable and using nuxt dev (fixes #219) (b6a5ead)
• workbox: handle offlinePage options (fixes #365) (2b9856e)

Features

• meta: merge head at runtime (#363) (c0d86ea) (resolves #341)
• workbox: Support strategyPlugins (#337)

Bug Fixes

• icon: fork without original process args (#343) (8b1f19f) (resolves #218)
• manifest: do not use nuxt loading bar color as default theme_color (#344) (a18a79f) (resolves #223)
• meta: add missing router.base prefix to favicon (#354) (3e910ae)
• meta: allow setting appleStatusBarStyle without mobileAppIOS (b0f226a) (resolves #338)
• meta: prevent build failure for ios splash image when no icon is used (#362) (494eed5) (resolves #355 and #334)

Thanks to

• @Yihao-G
• @1ed
• @maybebot
• @DraftProducts

Bug Fixes

• workbox: missing required parameter request for handle() (#335) (eedf23f)

Bug Fixes

• icon: update warning url to docs (#329) (61633fa)

⭐ What's new?

• Using workbox 5
• Support purpose option and defaulting to any maskable
• Brand new docs powered by nuxt/content

🚀 Features

• Update to workbox 5.x
• Add types (#323) (8723d07)
• icon: Support for icon purpose (#246) (9248174)
• icon: Default purpose to any maskable (30f0f63)
• icon: Expose options.cacheDir (f8dbf1d)
• icon: Use favicon.ico when available with warning (#258) (7a48d2a)
• icon: Rename accessibleIcons to iconPlugin (3e175f9)
• icon Rename iconSrc, iconFileName, iconPlugin and iconProperty to source, fileName, plugin and pluginName
• icon: Support for iOS splash screens (#308) (f4eeda7)
• module: Allow disabling sub-modules with top-level options (65800f9)
• workbox: Support enabled option and self destroying sw (c64226c)
• Support manifest.fileName with template (f05353b), closes #193
• Use integraty file to invalidate icon cache (6661a09)
• manifest: Add useWebmanifestExtension option and improve docs (#241) (4484e6c)

📝 Docs

• Fix a typo on icon (#235)
• Add tip for pwa.manifest.display: 'browser' (#249)
• Fix typo in icon.md (#253)
• Use CacheFirst instead of cacheFirst (#251)
• Fix wrong position of a description (#270)
• Add an example for refresh to update implementation (#271)
• Document workbox.swDest (#285)
• Add title to external links (#288)
• Migrate to nuxt content (#313)

🐛 Bug Fixes

• icon: Clean cacheDir when generating icons (1e6eb19)

⚠ BREAKING CHANGES

• Requeires Node 10.x
• Updated to workbox 5.x (optional: migration guide)
• Icon options renamed: iconSrc, iconFileName, iconPlugin, iconProperty, accessibleIcons (see docs)
• Icon purpose is now any maskable by default which means you have to consider minimum safe-zone (read more)

💖 Contributors

• @alperbicer
• @danbeneventano
• @danielroe
• @daniel-tikken
• @DCsunset
• @debs-obrien
• @dvarnai
• @gangsthub
• @Gomah
• @hans00
• @Hxmic
• @jefrydco
• @jeremy21212121
• @jsulpis
• @ricardogobbosouza
• @s-pace
• @svale
• @Timibadass
• @Wisdom132
• @zachjharris

Bug Fixes

• expose modified pwa context to the config (c325e44)
• truncate manifest hash (5c74621)

Bug Fixes

• Fix option handling regressions of beta.17 (#231) (3c19baebc0a1dba5e8b7ef20c7230e81ce6a8e95, 38485af547401c2336be97082bac1dd8d514744c)

Summary

This release contains LOTS of internal improvements!

• Starting with this release, PWA module is a single package (no longer depending on @nuxtjs/meta, ...)
• Package install size reduced from 17.1MB to 1.42MB thanks to https://github.com/nuxt-community/jimp-compact
• Now you can provide all module related options under pwa key in nuxt.config.js: (except one signal module) and older option may be deprecated in future versions.

export default {
  modules: [
    '@nuxtjs/pwa'
  ],
  pwa: {
    icon: {},
    manifest: {},
    meta: {},
    workbox: {},
  }
}

Bug Fixes

• icon: handle situation where the iconSrc is null or undefined (#187) (66be874)

Bug Fixes

• icon: handle situation where the iconSrc is null or undefined (#187) (66be874)

Bug Fixes

• workbox: disable cacheAssets for dev (dbf6d67)
• workbox: use NetworkFirst for dev (9a67580)

Features

• workbox: support offlineStrategy (e377436)
• icon: rewrite icon with async image resizer (#171)

Reverts

• workbox: revert unnecessary HMR regex (1ac5f5c)

BREAKING CHANGES

• workbox: default offlineStrategy changed from NetworkOnly to NetworkFirst when offlinePage is enabled

Bug Fixes

• onesignal: ensure no duplicate script is added (#161) (89c1a1d)

Features

• workbox: make plugin fully asynchronous (1eb1190)
• workbox: improve computed cacheId (cd6c9cc)
• workbox: improve sw.register error handling (9aa76f8)

Features

• workbox: improve sw.register (c35f610)
• workbox: sync workbox version with workbox-cdn
• workbox: Upgrade workbox to 4.1.1

Bug Fixes

• pwa-utils: don't combine with esm (fddfa7a), closes #147

Bug Fixes

• workbox: always prepend routerBase to swURL (d3a52b6), closes #157

Features

• workbox: allow cache names to be configured (#154) (2d7ed53)
• workbox: workbox-window support (2e356d0)

Features

• workbox: use workbox 4.0.0-0 (70813ef)

Bug Fixes

• pwa-utils: handle non-strings in startCase (#150) (782217a) (@alexkcollier)

Workbox

• Upgrade workbox to v4.0.0-rc.4

Bug Fixes

• manifest: remove publicPath field (b03dc14)

Bug Fixes

• module: handle readJSFiles for string param (#143) (4f06479)

Features

• workbox: bump to 4.0.0-rc.2 (7e278f0)

Bug Fixes

• relax pages regex for workbox 4 compatiblity (04e74a7)

Features

• cleanupOutdatedCaches (9167013)
• workbox: assetsURLPattern, pagesURLPattern (5fc3d66)
• workbox: preCaching option (67f1c3d)
• workbox: upgrade workboxVersion to 4.0.0-rc.0 (b364572)

Bug Fixes

• add workboxExtensions to defaults (#138) (ac8ba74)

Bug Fixes

• onesignal: add cache query to sw.js (33f8f61)
• pwa-utils: ensure joinUrl not modifying scheme part (09a465a)

Features

• options.dev (fb0d38c)