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.

Sign up for GitHub

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

Jump to bottom

feat!: move client to @vite-pwa/workbox-window #634

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

feat!: move client to @vite-pwa/workbox-window #634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
33107e5
feat: move to `@vite-pwa/workbox-window`
userquin Dec 31, 2023
fe8b47a
chore: add `installingSW` and ``updatingSW` in dts files
userquin Dec 31, 2023
f420f84
docs: include `installing` jsdocs hints
userquin Jan 1, 2024
a299f01
docs: cleanup jsdocs dts
userquin Jan 1, 2024
6f31749
chore: update register logic
userquin Jan 1, 2024
d2c913a
Merge branch 'main' into userquin/feat-move-to-pwa-workbox-window
userquin Jan 25, 2024
5b1097b
Merge branch 'main' into userquin/feat-move-to-pwa-workbox-window
userquin Feb 11, 2024
ed83e56
chore: resolve conflicts
userquin Feb 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions examples/preact-router/package.json
View file
Open in desktop
Expand Up @@ -54,14 +54,14 @@
"devDependencies": {
"@preact/preset-vite": "^2.7.0",
"@rollup/plugin-replace": "^5.0.5",
"@vite-pwa/workbox-window": "^8.0.0",
"https-localhost": "^4.7.1",
"rimraf": "^5.0.5",
"typescript": "^5.2.2",
"vite": "^5.0.0",
"vite-plugin-pwa": "workspace:*",
"workbox-core": "^7.0.0",
"workbox-precaching": "^7.0.0",
"workbox-routing": "^7.0.0",
"workbox-window": "^7.0.0"
"workbox-routing": "^7.0.0"
}
}
4 changes: 2 additions & 2 deletions examples/react-router/package.json
View file
Open in desktop
Expand Up @@ -60,6 +60,7 @@
"@types/react-dom": "^18.2.15",
"@types/react-router-config": "^5.0.10",
"@types/react-router-dom": "^5.3.3",
"@vite-pwa/workbox-window": "^8.0.0",
"@vitejs/plugin-react": "^4.2.0",
"https-localhost": "^4.7.1",
"rimraf": "^5.0.5",
Expand All @@ -68,7 +69,6 @@
"vite-plugin-pwa": "workspace:*",
"workbox-core": "^7.0.0",
"workbox-precaching": "^7.0.0",
"workbox-routing": "^7.0.0",
"workbox-window": "^7.0.0"
"workbox-routing": "^7.0.0"
}
}
4 changes: 2 additions & 2 deletions examples/solid-router/package.json
View file
Open in desktop
Expand Up @@ -53,6 +53,7 @@
},
"devDependencies": {
"@rollup/plugin-replace": "^5.0.5",
"@vite-pwa/workbox-window": "^8.0.0",
"https-localhost": "^4.7.1",
"rimraf": "^5.0.5",
"typescript": "^5.2.2",
Expand All @@ -61,7 +62,6 @@
"vite-plugin-solid": "^2.7.2",
"workbox-core": "^7.0.0",
"workbox-precaching": "^7.0.0",
"workbox-routing": "^7.0.0",
"workbox-window": "^7.0.0"
"workbox-routing": "^7.0.0"
}
}
1 change: 1 addition & 0 deletions examples/svelte-routify/package.json
View file
Open in desktop
Expand Up @@ -52,6 +52,7 @@
"@roxi/routify": "^2.18.12",
"@sveltejs/vite-plugin-svelte": "^3.0.0",
"@tsconfig/svelte": "^5.0.2",
"@vite-pwa/workbox-window": "^8.0.0",
"eslint": "^8.54.0",
"eslint-plugin-svelte3": "^4.0.0",
"https-localhost": "^4.7.1",
Expand Down
1 change: 1 addition & 0 deletions examples/vanilla-ts-no-ip/package.json
View file
Open in desktop
Expand Up @@ -16,6 +16,7 @@
"test": "nr test-generate-sw && nr test-custom-sw"
},
"devDependencies": {
"@vite-pwa/workbox-window": "^8.0.0",
"lodash-es": "^4.17.21",
"rimraf": "^5.0.5",
"typescript": "^5.2.2",
Expand Down
4 changes: 2 additions & 2 deletions examples/vue-router/package.json
View file
Open in desktop
Expand Up @@ -53,6 +53,7 @@
},
"devDependencies": {
"@rollup/plugin-replace": "^5.0.5",
"@vite-pwa/workbox-window": "^8.0.0",
"@vitejs/plugin-vue": "^4.5.0",
"@vueuse/core": "^10.6.1",
"https-localhost": "^4.7.1",
Expand All @@ -62,7 +63,6 @@
"vite-plugin-pwa": "workspace:*",
"workbox-core": "^7.0.0",
"workbox-precaching": "^7.0.0",
"workbox-routing": "^7.0.0",
"workbox-window": "^7.0.0"
"workbox-routing": "^7.0.0"
}
}
6 changes: 6 additions & 0 deletions examples/vue-router/src/ReloadPrompt.vue
View file
Open in desktop
Expand Up @@ -25,6 +25,12 @@ const {
console.log(`SW Registered: ${r}`)
}
},
onInstalling(state) {
console.log(`SW Installing: ${state}`)
},
onUpdateFound(state) {
console.log(`SW Updating: ${state}`)
},
})

async function close() {
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Expand Up @@ -106,14 +106,14 @@
"peerDependencies": {
"vite": "^3.1.0 || ^4.0.0 || ^5.0.0",
"workbox-build": "^7.0.0",
"workbox-window": "^7.0.0"
"@vite-pwa/workbox-window": "^8.0.0"
},
"dependencies": {
"debug": "^4.3.4",
"fast-glob": "^3.3.2",
"pretty-bytes": "^6.1.1",
"workbox-build": "^7.0.0",
"workbox-window": "^7.0.0"
"@vite-pwa/workbox-window": "^8.0.0"
},
"devDependencies": {
"@antfu/eslint-config": "^2.0.0",
Expand Down
39 changes: 24 additions & 15 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions preact.d.ts
View file
Open in desktop
Expand Up @@ -9,6 +9,8 @@ declare module 'virtual:pwa-register/preact' {
export function useRegisterSW(options?: RegisterSWOptions): {
needRefresh: [boolean, StateUpdater<boolean>]
offlineReady: [boolean, StateUpdater<boolean>]
installingSW: [boolean, StateUpdater<boolean>]
updatingSW: [boolean, StateUpdater<boolean>]
/**
* Reloads the current window to allow the service worker take the control.
*
Expand Down
2 changes: 2 additions & 0 deletions react.d.ts
View file
Open in desktop
Expand Up @@ -9,6 +9,8 @@ declare module 'virtual:pwa-register/react' {
export function useRegisterSW(options?: RegisterSWOptions): {
needRefresh: [boolean, Dispatch<SetStateAction<boolean>>]
offlineReady: [boolean, Dispatch<SetStateAction<boolean>>]
installingSW: [boolean, Dispatch<SetStateAction<boolean>>]
updatingSW: [boolean, Dispatch<SetStateAction<boolean>>]
/**
* Reloads the current window to allow the service worker take the control.
*
Expand Down
2 changes: 2 additions & 0 deletions solid.d.ts
View file
Open in desktop
Expand Up @@ -9,6 +9,8 @@ declare module 'virtual:pwa-register/solid' {
export function useRegisterSW(options?: RegisterSWOptions): {
needRefresh: [Accessor<boolean>, Setter<boolean>]
offlineReady: [Accessor<boolean>, Setter<boolean>]
installingSW: [Accessor<boolean>, Setter<boolean>]
updatingSW: [Accessor<boolean>, Setter<boolean>]
/**
* Reloads the current window to allow the service worker take the control.
*
Expand Down
14 changes: 14 additions & 0 deletions src/client/build/preact.ts
View file
Open in desktop
Expand Up @@ -12,10 +12,14 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
onRegistered,
onRegisteredSW,
onRegisterError,
onInstalling,
onUpdateFound,
} = options

const [needRefresh, setNeedRefresh] = useState(false)
const [offlineReady, setOfflineReady] = useState(false)
const [installingSW, setInstallingSW] = useState(false)
const [updatingSW, setUpdatingSW] = useState(false)

const [updateServiceWorker] = useState(() => {
return registerSW({
Expand All @@ -28,6 +32,14 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
setNeedRefresh(true)
onNeedRefresh?.()
},
onInstalling(state, sw) {
setInstallingSW(state)
onInstalling?.(state, sw)
},
onUpdateFound(state, sw) {
setUpdatingSW(state)
onUpdateFound?.(state, sw)
},
onRegistered,
onRegisteredSW,
onRegisterError,
Expand All @@ -37,6 +49,8 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
return {
needRefresh: [needRefresh, setNeedRefresh],
offlineReady: [offlineReady, setOfflineReady],
installingSW: [installingSW, setInstallingSW],
updatingSW: [updatingSW, setUpdatingSW],
updateServiceWorker,
}
}
14 changes: 14 additions & 0 deletions src/client/build/react.ts
View file
Open in desktop
Expand Up @@ -12,10 +12,14 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
onRegistered,
onRegisteredSW,
onRegisterError,
onInstalling,
onUpdateFound,
} = options

const [needRefresh, setNeedRefresh] = useState(false)
const [offlineReady, setOfflineReady] = useState(false)
const [installingSW, setInstallingSW] = useState(false)
const [updatingSW, setUpdatingSW] = useState(false)

const [updateServiceWorker] = useState(() => {
return registerSW({
Expand All @@ -28,6 +32,14 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
setNeedRefresh(true)
onNeedRefresh?.()
},
onInstalling(state, sw) {
setInstallingSW(state)
onInstalling?.(state, sw)
},
onUpdateFound(state, sw) {
setUpdatingSW(state)
onUpdateFound?.(state, sw)
},
onRegistered,
onRegisteredSW,
onRegisterError,
Expand All @@ -37,6 +49,8 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
return {
needRefresh: [needRefresh, setNeedRefresh],
offlineReady: [offlineReady, setOfflineReady],
installingSW: [installingSW, setInstallingSW],
updatingSW: [updatingSW, setUpdatingSW],
updateServiceWorker,
}
}