@vite-pwa/nuxt 1.1.1 → 2.0.1

package/README.md

@@ -1,16 +1,22 @@
 <p align='center'>
-<img src='https://raw.githubusercontent.com/vite-pwa/nuxt/main/hero.png' alt="@vite-pwa/nuxt - Zero-config PWA for Nuxt 3"><br>
-Zero-config PWA Plugin for Nuxt 3
+    <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vite-pwa/.github/main/nuxt-module-hero-dark.svg" />
+        <img src="https://raw.githubusercontent.com/vite-pwa/.github/main/nuxt-module-hero.svg" alt="@vite-pwa/nuxt-module - PWA for Nuxt Module logo">
+    </picture>
 </p>
 
+<h1 align='center'>
+PWA for Nuxt Module
+</h1>
+
 <p align='center'>
-<a href='https://www.npmjs.com/package/@vite-pwa/nuxt' target="__blank">
+<a href='https://npmx.dev/package/@vite-pwa/nuxt' target="_blank" rel="noopener noreferrer">
 <img src='https://img.shields.io/npm/v/@vite-pwa/nuxt?color=33A6B8&label=' alt="NPM version">
 </a>
-<a href="https://www.npmjs.com/package/@vite-pwa/nuxt" target="__blank">
+<a href="https://npmx.dev/package/@vite-pwa/nuxt" target="_blank" rel="noopener noreferrer">
     <img alt="NPM Downloads" src="https://img.shields.io/npm/dm/@vite-pwa/nuxt?color=476582&label=">
 </a>
-<a href="https://vite-pwa-org.netlify.app/frameworks/nuxt" target="__blank">
+<a href="https://unplugin-pwa.netlify.app/frameworks/nuxt" target="__blank">
     <img src="https://img.shields.io/static/v1?label=&message=docs%20%26%20guides&color=2e859c" alt="Docs & Guides">
 </a>
 <br>
@@ -23,91 +29,54 @@ Zero-config PWA Plugin for Nuxt 3
 
 <p align="center">
   <a href="https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg">
-    <img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg'/>
+    <img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg' alt="Anthony Fu SVG sponsors image"/>
   </a>
 </p>
 
 ## 🚀 Features
 
-- 📖 [**Documentation & guides**](https://vite-pwa-org.netlify.app/)
+- 📖 [**Documentation & guides**](https://unplugin-pwa.netlify.app/)
 - 👌 **Zero-Config**: sensible built-in default configs for common use cases
 - 🔩 **Extensible**: expose the full ability to customize the behavior of the plugin
 - 🦾 **Type Strong**: written in [TypeScript](https://www.typescriptlang.org/)
 - 🔌 **Offline Support**: generate service worker with offline support (via Workbox)
-- ⚡ **Fully tree shakable**: auto inject Web App Manifest
+- ⚡ **Fully tree shakable**: client virtual modules are strictly optimized for Dead Code Elimination.
+- 📄 **Web Manifest**: auto-inject Web App Manifest and PWA assets seamlessly.
 - 💬 **Prompt for new content**: built-in support for Vanilla JavaScript, Vue 3, React, Svelte, SolidJS and Preact
 - ⚙️ **Stale-while-revalidate**: automatic reload when new content is available
 - ✨ **Static assets handling**: configure static assets for offline support
 - 🐞 **Development Support**: debug your custom service worker logic as you develop your application
-- 🛠️ **Versatile**: integration with meta frameworks: [îles](https://github.com/ElMassimo/iles), [SvelteKit](https://github.com/sveltejs/kit), [VitePress](https://github.com/vuejs/vitepress), [Astro](https://github.com/withastro/astro), [Nuxt 3](https://github.com/nuxt/nuxt) and [Remix](https://github.com/remix-run/remix)
+- 🔍 **Inspector**: visually inspect your resolved configuration, web manifest and service worker during development, via middleware or [DevFrame](https://github.com/devframes/devframe)
+- 🧩 **Modular**: use the ready-to-use plugins or compose your own integration from the building blocks in `@unplugin-pwa/core` and `@unplugin-pwa/vite`
+- 📦 **Universal Bundlers**: native integration with Vite, Rolldown, Webpack (WIP), Rspack (WIP), and Rsbuild (WIP).
+- 🛠️ **Meta-Frameworks**: seamless integration with [îles](https://github.com/ElMassimo/iles), [SvelteKit](https://github.com/sveltejs/kit), [VitePress](https://github.com/vuejs/vitepress), [Astro](https://github.com/withastro/astro), [Nuxt 3/4/5](https://github.com/nuxt/nuxt), [React Router](https://github.com/remix-run/react-router/), [TanStack](https://github.com/TanStack) and [Next](https://github.com/vercel/next.js/) (WIP).
 - 💥 **PWA Assets Generator**: generate all the PWA assets from a single command and a single source image
 - 🚀 **PWA Assets Integration**: serving, generating and injecting PWA Assets on the fly in your application
 
-## 📦 Install
+## 🔌 What is `@vite-pwa/nuxt`?
 
-> From v0.4.0, `@vite-pwa/nuxt` requires Vite 5 and Nuxt 3.9.0+.
+`@vite-pwa/nuxt` is the new for Nuxt PWA module, powered by [`unplugin-pwa`](https://github.com/vite-pwa/unplugin-pwa).
 
-> For older versions, `@vite-pwa/nuxt` requires Vite 3.2.0+ and Nuxt 3.0.0+.
+## 📦 Install
 
 ```bash
-npx nuxi@latest module add @vite-pwa/nuxt
+npx nuxt module add @vite-pwa/nuxt
 ```
 
 ## 🦄 Usage
 
-Add `@vite-pwa/nuxt` module to `nuxt.config.ts` and configure it:
-
 ```ts
 // nuxt.config.ts
-import { defineNuxtConfig } from 'nuxt/config'
-
 export default defineNuxtConfig({
-  modules: [
-    '@vite-pwa/nuxt'
-  ],
+  modules: ['@vite-pwa/nuxt'],
   pwa: {
     /* PWA options */
-  }
+  },
 })
 ```
 
-Read the [📖 documentation](https://vite-pwa-org.netlify.app/frameworks/nuxt) for a complete guide on how to configure and use
-this plugin.
-
-## ⚡️ Examples
-
-You need to stop the dev server once started and then to see the PWA in action run:
-- `nr dev:preview:build`: Nuxt build command + start server
-- `nr dev:preview:generate`: Nuxt generate command + start server
-
-<table>
-<thead>
-<tr>
-<th>Example</th>
-<th>Source</th>
-<th>Playground</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td><code>Auto Update PWA</code></td>
-<td><a href="https://github.com/vite-pwa/nuxt/tree/main/playground">GitHub</a></td>
-<td>
-<a href="https://stackblitz.com/fork/github/vite-pwa/nuxt" target="_blank" rel="noopener noreferrer">
-  <img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt="Open in StackBlitz" width="162" height="32">
-</a>
-</td>
-</tr>
-</tbody>
-</table>
-
-## 👀 Full config
-
-Check out the type declaration [src/types.ts](./src/types.ts) and the following links for more details.
-
-- [Web app manifests](https://developer.mozilla.org/en-US/docs/Web/Manifest)
-- [Workbox](https://developers.google.com/web/tools/workbox)
+Read the [documentation](https://unplugin-pwa.netlify.app/frameworks/nuxt) and the [repository README](https://github.com/vite-pwa/nuxt#readme) for more details.
 
-## 📄 License
+## License
 
-[MIT](./LICENSE) License &copy; 2023-PRESENT [Anthony Fu](https://github.com/antfu)
+[MIT](https://github.com/vite-pwa/nuxt/blob/main/LICENSE) License &copy; 2023-PRESENT [Anthony Fu](https://github.com/antfu)

package/config/index.d.mts

@@ -0,0 +1 @@
+export * from "@vite-pwa/nuxt-core/config";

package/config/index.mjs

@@ -0,0 +1,3 @@
+import { definePwaConfig } from "@vite-pwa/nuxt-core/config";
+
+export { definePwaConfig };

package/configuration.d.ts

@@ -1,4 +1,7 @@
 declare module 'virtual:nuxt-pwa-configuration' {
+  export const callBeforeRegisterHook: boolean
+  export function initializeDev(): void
+  export function activateSWSwitcherDev(): void
   export const enabled: boolean
   export const display: 'fullscreen' | 'standalone' | 'minimal-ui' | 'browser'
   export const installPrompt: string | undefined

package/dist/chunks/create-nuxt-pwa-context.mjs

@@ -0,0 +1,27 @@
+import { getNuxtVersion, useLogger } from '@nuxt/kit';
+
+async function createNuxtPwaContext(options, nuxt, moduleResolver) {
+  const nuxtVersion = getNuxtVersion(nuxt);
+  let buildAssetsDir = nuxt.options.app.buildAssetsDir ?? "_nuxt/";
+  if (buildAssetsDir[0] === "/") {
+    buildAssetsDir = buildAssetsDir.slice(1);
+  }
+  if (buildAssetsDir[buildAssetsDir.length - 1] !== "/") {
+    buildAssetsDir += "/";
+  }
+  const builder = options.builder ?? (nuxt.options.builder === "@nuxt/vite-builder" ? await import('@vite-pwa/nuxt-vite').then((m) => m.builder) : void 0);
+  if (!builder) {
+    const name = typeof nuxt.options.builder === "string" ? nuxt.options.builder : "custom";
+    useLogger("@vite-pwa/nuxt").warn(`Builder \`${name}\` is not supported yet, PWA support is disabled.`);
+    return void 0;
+  }
+  return await builder.build(
+    nuxtVersion,
+    buildAssetsDir,
+    options,
+    nuxt,
+    moduleResolver
+  );
+}
+
+export { createNuxtPwaContext };