feat(register): add on begin update hooks

vite-pwa · Dec 14, 2023 · 59ccbb3 · 59ccbb3
1 parent 4d3b1d0
commit 59ccbb3
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 0 deletions.
diff --git a/src/client/build/preact.ts b/src/client/build/preact.ts
@@ -8,6 +8,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
   const {
     immediate = true,
     onNeedRefresh,
+    onBeginUpdate,
     onOfflineReady,
     onRegistered,
     onRegisteredSW,
@@ -24,6 +25,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
         setOfflineReady(true)
         onOfflineReady?.()
       },
+      onBeginUpdate,
       onNeedRefresh() {
         setNeedRefresh(true)
         onNeedRefresh?.()

diff --git a/src/client/build/react.ts b/src/client/build/react.ts
@@ -8,6 +8,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
   const {
     immediate = true,
     onNeedRefresh,
+    onBeginUpdate,
     onOfflineReady,
     onRegistered,
     onRegisteredSW,
@@ -24,6 +25,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
         setOfflineReady(true)
         onOfflineReady?.()
       },
+      onBeginUpdate,
       onNeedRefresh() {
         setNeedRefresh(true)
         onNeedRefresh?.()

diff --git a/src/client/build/register.ts b/src/client/build/register.ts
@@ -18,6 +18,7 @@ export function registerSW(options: RegisterSWOptions = {}) {
   const {
     immediate = false,
     onNeedRefresh,
+    onBeginUpdate,
     onOfflineReady,
     onRegistered,
     onRegisteredSW,
@@ -81,6 +82,11 @@ export function registerSW(options: RegisterSWOptions = {}) {
 
             onNeedRefresh?.()
           }
+          // Add an event listener to detect when the new service worker
+          // start to be installed but not yet installed.
+          wb.addEventListener('installing', (event) => {
+            event.isUpdate && onBeginUpdate?.()
+          })
           wb.addEventListener('installed', (event) => {
             if (typeof event.isUpdate === 'undefined') {
               if (typeof event.isExternal !== 'undefined') {

diff --git a/src/client/build/solid.ts b/src/client/build/solid.ts
@@ -8,6 +8,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
   const {
     immediate = true,
     onNeedRefresh,
+    onBeginUpdate,
     onOfflineReady,
     onRegistered,
     onRegisteredSW,
@@ -19,6 +20,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
 
   const updateServiceWorker = registerSW({
     immediate,
+    onBeginUpdate,
     onOfflineReady() {
       setOfflineReady(true)
       onOfflineReady?.()

diff --git a/src/client/build/svelte.ts b/src/client/build/svelte.ts
@@ -8,6 +8,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
   const {
     immediate = true,
     onNeedRefresh,
+    onBeginUpdate,
     onOfflineReady,
     onRegistered,
     onRegisteredSW,
@@ -19,6 +20,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
 
   const updateServiceWorker = registerSW({
     immediate,
+    onBeginUpdate,
     onOfflineReady() {
       offlineReady.set(true)
       onOfflineReady?.()

diff --git a/src/client/build/vue.ts b/src/client/build/vue.ts
@@ -8,6 +8,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
   const {
     immediate = true,
     onNeedRefresh,
+    onBeginUpdate,
     onOfflineReady,
     onRegistered,
     onRegisteredSW,
@@ -19,6 +20,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
 
   const updateServiceWorker = registerSW({
     immediate,
+    onBeginUpdate,
     onNeedRefresh() {
       needRefresh.value = true
       onNeedRefresh?.()

diff --git a/src/client/type.d.ts b/src/client/type.d.ts
@@ -1,6 +1,7 @@
 export interface RegisterSWOptions {
   immediate?: boolean
   onNeedRefresh?: () => void
+  onBeginUpdate?: () => void
   onOfflineReady?: () => void
   /**
    * Called only if `onRegisteredSW` is not provided.