Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remix PWA v5 Release Candidate #269

Merged
merged 32 commits into from
Oct 11, 2024
Merged

Remix PWA v5 Release Candidate #269

merged 32 commits into from
Oct 11, 2024

Conversation

ShafSpecs
Copy link
Member

@ShafSpecs ShafSpecs commented Sep 30, 2024

This PR aims to introduce the first release candidate (rc) of Remix PWA v5 - the next major version.

Includes a lot of breaking changes and packages.

@remix-pwa/dev

  • Support added for Remix SPA mode. Now, the service worker is made aware of client route modules within routes. This leads to a modified behaviour regarding how workerLoader and workerAction works
  • Ships a few new global variables (including a process.env object)
  • Added support for single fetch use cases. workerLoader/Action behaviour has been modified extensively in this release and that includes being disabled in single fetch's case
  • Removed all non-related exports from the dev package. Meaning WebManifest types are no longer exported from this package
  • Deprecated option registerSW, this would be replaced by injectSWRegister, a boolean property, that would be shipped alongside a component to handle registration
  • Automatically disables auto-injection of service worker registration if the worker is already being registered manually

@remix-pwa/worker-runtime

  • Added runtime support for SPA mode - via the modified _route search parameter
  • Disabled worker runtime APIs when single fetch is enabled in Remix

@remix-pwa/manifest

  • 🎉 New package!
  • Ships the ManifestLink component (removed from sw package)
  • Now ships the WebAppManifest type - no need to import from dev anymore!
  • Ships a new schema.json for JSON-format web manifests - get typings even within your json manifests!

@remix-pwa/sw

  • New PWAScripts component: allows you to manually register your service worker with custom parameters including CSRF support
  • Removed ManifestLink from the package
  • New hook: installPWAGlobals that takes care of every setup required by Remix PWA within the client
  • Removed useSWEffect hook - its main functionality has been ported to installPWAGlobals
  • Removed the SkipWaitHandler, as well as sendSkipWaitingMessage utility
  • Removed loadServiceWorker. Service worker registration now occurs via the vite plugin (automatically) or PWAScripts component (manually)

Moving new workflow to main branch stream
- added support for SPA mode\n- added single fetch support\n- added support for Remix client route modules

BREAKING CHANGES
@ShafSpecs ShafSpecs added the release A new release. Or release-related. label Sep 30, 2024
@ShafSpecs ShafSpecs self-assigned this Sep 30, 2024
@ShafSpecs ShafSpecs mentioned this pull request Sep 30, 2024
@ShafSpecs ShafSpecs linked an issue Sep 30, 2024 that may be closed by this pull request
- added support for SPA modec- Disabled worker runtime APIs when single fetch is enabled

BREAKING CHANGE
@ShafSpecs ShafSpecs added the blocked Issues blocked by other tasks or dependencies label Oct 1, 2024
@ShafSpecs ShafSpecs linked an issue Oct 5, 2024 that may be closed by this pull request
@ShafSpecs ShafSpecs merged commit 04fd604 into dev Oct 11, 2024
4 of 5 checks passed
@ShafSpecs ShafSpecs removed the blocked Issues blocked by other tasks or dependencies label Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release A new release. Or release-related.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remix PWA v5 How to handle nonce on entry.worker.js?
1 participant