@vite-pwa/nuxt 0.0.5 → 0.0.6

package/README.md

@@ -40,6 +40,7 @@ Zero-config PWA Plugin for Nuxt 3
 - ⚙️ **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), and [Nuxt 3](https://github.com/nuxt/nuxt)
 
 ## 📦 Install
 

package/dist/module.json

@@ -1,5 +1,5 @@
 {
   "name": "pwa",
   "configKey": "pwa",
-  "version": "0.0.5"
+  "version": "0.0.6"
 }

package/dist/module.mjs

@@ -1,12 +1,16 @@
+import { join } from 'node:path';
+import { writeFile, mkdir } from 'node:fs/promises';
 import { defineNuxtModule, createResolver, addPluginTemplate, addComponent, extendWebpackConfig } from '@nuxt/kit';
 import { VitePWA } from 'vite-plugin-pwa';
 import { resolve } from 'pathe';
 
-function configurePWAOptions(options, nuxt) {
+function configurePWAOptions(options, nuxt, nitroConfig) {
   if (!options.outDir) {
-    const publicDir = nuxt.options.nitro?.output?.publicDir;
+    const publicDir = nitroConfig.output?.publicDir;
     options.outDir = publicDir ? resolve(publicDir) : resolve(nuxt.options.buildDir, "../.output/public");
   }
+  if (options.devOptions?.enabled)
+    options.devOptions.resolveTempFolder = () => resolve(nuxt.options.buildDir, "dev-sw-dist");
   let config;
   if (options.strategies === "injectManifest") {
     options.injectManifest = options.injectManifest ?? {};
@@ -43,6 +47,17 @@ function createManifestTransform(base) {
   };
 }
 
+async function regeneratePWA(dir, api) {
+  if (!api || api.disabled)
+    return;
+  await api.generateSW();
+}
+async function writeWebManifest(dir, path, api) {
+  const manifest = api.generateBundle({})?.[path];
+  if (manifest && "source" in manifest)
+    await writeFile(resolve(dir, path), manifest.source, "utf-8");
+}
+
 const module = defineNuxtModule({
   meta: {
     name: "pwa",
@@ -71,7 +86,7 @@ const module = defineNuxtModule({
     if (client.registerPlugin) {
       addPluginTemplate({
         src: resolver.resolve("../templates/pwa.client.ts"),
-        write: options.writePlugin,
+        write: nuxt.options.dev || options.writePlugin,
         options: {
           periodicSyncForUpdates: typeof client.periodicSyncForUpdates === "number" ? client.periodicSyncForUpdates : 0,
           installPrompt: typeof client.installPrompt === "undefined" || client.installPrompt === false ? void 0 : client.installPrompt === true || client.installPrompt.trim() === "" ? "vite-pwa:hide-install" : client.installPrompt.trim()
@@ -84,11 +99,17 @@ const module = defineNuxtModule({
     });
     nuxt.hook("prepare:types", ({ references }) => {
       references.push({ types: "vite-plugin-pwa/client" });
+      references.push({ types: "vite-plugin-pwa/info" });
     });
-    nuxt.hook("nitro:init", (nitro) => {
-      options.outDir = nitro.options.output.publicDir;
-      options.injectManifest = options.injectManifest || {};
-      options.injectManifest.globDirectory = nitro.options.output.publicDir;
+    const manifestDir = join(nuxt.options.buildDir, "manifests");
+    nuxt.options.nitro.publicAssets = nuxt.options.nitro.publicAssets || [];
+    nuxt.options.nitro.publicAssets.push({
+      dir: manifestDir,
+      baseURL: nuxt.options.app.baseURL,
+      maxAge: 0
+    });
+    nuxt.hook("nitro:config", (nitroConfig) => {
+      configurePWAOptions(options, nuxt, nitroConfig);
     });
     nuxt.hook("vite:extend", ({ config }) => {
       const plugin = config.plugins?.find((p) => p && typeof p === "object" && "name" in p && p.name === "vite-plugin-pwa");
@@ -100,8 +121,22 @@ const module = defineNuxtModule({
       const plugin = viteInlineConfig.plugins.find((p) => p && typeof p === "object" && "name" in p && p.name === "vite-plugin-pwa");
       if (plugin)
         throw new Error("Remove vite-plugin-pwa plugin from Vite Plugins entry in Nuxt config file!");
-      configurePWAOptions(options, nuxt);
-      const plugins = VitePWA(options);
+      if (options.manifest && isClient) {
+        viteInlineConfig.plugins.push({
+          name: "vite-pwa-nuxt:webmanifest:build",
+          apply: "build",
+          async writeBundle(_options, bundle) {
+            if (options.disable || !bundle)
+              return;
+            const api = resolveVitePluginPWAAPI();
+            if (api) {
+              await mkdir(manifestDir, { recursive: true });
+              await writeWebManifest(manifestDir, options.manifestFilename || "manifest.webmanifest", api);
+            }
+          }
+        });
+      }
+      const plugins = [...VitePWA(options).filter((p) => p.name !== "vite-plugin-pwa:build")];
       viteInlineConfig.plugins.push(plugins);
       if (isClient)
         vitePwaClientPlugin = plugins.find((p) => p.name === "vite-plugin-pwa");
@@ -128,28 +163,43 @@ const module = defineNuxtModule({
             return;
           viteServer.middlewares.stack.push({ route: workbox, handle: emptyHandle });
         });
-        nuxt.hook("close", async () => {
-        });
       }
     } else {
-      if (options.registerWebManifestInRouteRules) {
+      if (!options.disable && options.registerWebManifestInRouteRules) {
         nuxt.hook("nitro:config", async (nitroConfig) => {
           nitroConfig.routeRules = nitroConfig.routeRules || {};
-          nitroConfig.routeRules[`${nuxt.options.app.baseURL}${options.manifestFilename ?? "manifest.webmanifest"}`] = {
+          let swName = options.filename || "sw.js";
+          if (options.strategies === "injectManifest" && swName.endsWith(".ts"))
+            swName = swName.replace(/\.ts$/, ".js");
+          nitroConfig.routeRules[`${nuxt.options.app.baseURL}${swName}`] = {
             headers: {
-              "Content-Type": "application/manifest+json"
+              "Cache-Control": "public, max-age=0, must-revalidate"
             }
           };
+          if (options.manifest) {
+            nitroConfig.routeRules[`${nuxt.options.app.baseURL}${options.manifestFilename ?? "manifest.webmanifest"}`] = {
+              headers: {
+                "Content-Type": "application/manifest+json",
+                "Cache-Control": "public, max-age=0, must-revalidate"
+              }
+            };
+          }
         });
       }
       nuxt.hook("nitro:init", (nitro) => {
         nitro.hooks.hook("rollup:before", async () => {
-          await resolveVitePluginPWAAPI()?.generateSW();
+          await regeneratePWA(
+            options.outDir,
+            resolveVitePluginPWAAPI()
+          );
         });
       });
       if (nuxt.options._generate) {
         nuxt.hook("close", async () => {
-          await resolveVitePluginPWAAPI()?.generateSW();
+          await regeneratePWA(
+            options.outDir,
+            resolveVitePluginPWAAPI()
+          );
         });
       }
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vite-pwa/nuxt",
   "type": "module",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "packageManager": "pnpm@7.26.1",
   "description": "Zero-config PWA for Nuxt 3",
   "author": "antfu <anthonyfu117@hotmail.com>",
@@ -39,7 +39,7 @@
     "dev:generate": "nuxt generate playground",
     "dev:build": "nuxi build playground",
     "dev:prepare": "nuxt-module-build --stub && nuxi prepare playground",
-    "dev:preview": "npm run dev:build && node playground/.output/server/index.mjs",
+    "dev:preview:build": "npm run dev:build && node playground/.output/server/index.mjs",
     "dev:preview:generate": "npm run dev:generate && npx serve playground/dist",
     "prepublishOnly": "npm run prepack",
     "release": "bumpp && npm publish",
@@ -51,18 +51,18 @@
     "vite-plugin-pwa": "^0.14.0"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.1.1",
-    "vite-plugin-pwa": "^0.14.1"
+    "@nuxt/kit": "^3.2.0",
+    "vite-plugin-pwa": "^0.14.4"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^0.34.1",
-    "@antfu/ni": "^0.19.0",
+    "@antfu/eslint-config": "^0.35.2",
+    "@antfu/ni": "^0.20.0",
     "@nuxt/module-builder": "^0.2.1",
-    "@nuxt/schema": "^3.1.1",
-    "@nuxt/test-utils": "^3.1.1",
+    "@nuxt/schema": "^3.2.0",
+    "@nuxt/test-utils": "^3.2.0",
     "bumpp": "^8.2.1",
-    "eslint": "^8.32.0",
-    "nuxt": "^3.1.1",
+    "eslint": "^8.34.0",
+    "nuxt": "^3.2.0",
     "typescript": "^4.9.5"
   },
   "build": {