@serwist/nuxt 10.0.0-preview.13 → 10.0.0-preview.14

package/dist/module.d.mts

@@ -1,21 +1,7 @@
 import * as _nuxt_schema from '@nuxt/schema';
+import { Optional, Require } from '@serwist/utils';
 import { PluginOptions } from 'vite-plugin-serwist';
 
-/**
- * Make certain fields in a object type optional
- *
- * @example
- *     interface A {
- *         a: string;
- *         b: string;
- *         c: string;
- *     }
- *     type B = Optional<A, "b" | "c">;
- *     const b: B = { a: "hehe" }; //valid
- *     const b: B = {}; //invalid
- */
-type Optional<T, U extends keyof T> = Omit<T, U> & Partial<Pick<T, U>>;
-
 interface ClientOptions {
     /**
      * Whether this plugin should be registered.
@@ -28,8 +14,11 @@ interface ModuleOptions extends Optional<PluginOptions, "swSrc" | "swDest" | "gl
      */
     client?: ClientOptions;
 }
+type DefaultModuleKeys = "base" | "scope" | "client" | "swSrc" | "swDest" | "swUrl" | "globDirectory" | "injectionPoint";
+type DefaultModuleOptions = Required<Pick<ModuleOptions, DefaultModuleKeys>>;
+type ResolvedModuleOptions = Require<ModuleOptions, DefaultModuleKeys>;
 
-declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, Required<Pick<ModuleOptions, DefaultModuleKeys>>, true>;
 
 export { _default as default };
-export type { ClientOptions, ModuleOptions };
+export type { ClientOptions, DefaultModuleKeys, DefaultModuleOptions, ModuleOptions, ResolvedModuleOptions };

package/dist/module.json

@@ -4,7 +4,7 @@
   "compatibility": {
     "nuxt": "^3.8.0 || ^4.0.0"
   },
-  "version": "10.0.0-preview.13",
+  "version": "10.0.0-preview.14",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "unknown"

package/dist/module.mjs

@@ -1,41 +1,40 @@
 import path from 'node:path';
 import { defineNuxtModule, createResolver, addPlugin, extendWebpackConfig } from '@nuxt/kit';
-import { resolveEntry } from '@serwist/utils/node';
-import { createContext, main, dev, generateServiceWorker } from 'vite-plugin-serwist';
+import { createContext, main, dev, generateServiceWorker, resolveEntry } from 'vite-plugin-serwist';
 import { createHash } from 'node:crypto';
 import { createReadStream } from 'node:fs';
 import fsp from 'node:fs/promises';
+import { DEFAULT_GLOB_PATTERNS } from '@serwist/build';
 
-const version = "10.0.0-preview.13";
+const version = "10.0.0-preview.14";
 const packageJson = {
 	version: version};
 
-function configurePwaOptions(options, nuxt, nitroConfig) {
+const configureSerwistOptions = (options, nuxt, nitroConfig) => {
   let buildAssetsDir = nuxt.options.app.buildAssetsDir ?? "_nuxt/";
   if (buildAssetsDir[0] === "/") buildAssetsDir = buildAssetsDir.slice(1);
   if (buildAssetsDir[buildAssetsDir.length - 1] !== "/") buildAssetsDir += "/";
   if (!("dontCacheBustURLsMatching" in options)) {
     options.dontCacheBustURLsMatching = new RegExp(buildAssetsDir);
   }
-  if (nuxt.options.experimental.payloadExtraction) {
-    const enableGlobPatterns = nuxt.options.nitro.static || nuxt.options._generate || !!nitroConfig.prerender?.routes?.length || Object.values(nitroConfig.routeRules ?? {}).some((r) => r.prerender);
-    if (enableGlobPatterns) {
-      options.globPatterns = options.globPatterns ?? [];
-      options.globPatterns.push("**/_payload.json");
-    }
+  options.globPatterns = options.globPatterns ?? DEFAULT_GLOB_PATTERNS;
+  if (nuxt.options.experimental.payloadExtraction && // Has prerendered routes
+  (nuxt.options.nitro.static || nuxt.options._generate || !!nitroConfig.prerender?.routes?.length || Object.values(nitroConfig.routeRules ?? {}).some((r) => r.prerender))) {
+    options.globPatterns.push("**/_payload.json");
   }
   let appManifestFolder;
   if (nuxt.options.experimental.appManifest) {
-    options.globPatterns = options.globPatterns ?? [];
     appManifestFolder = `${buildAssetsDir}builds/`;
     options.globPatterns.push(`${appManifestFolder}**/*.json`);
   }
   const _public = nitroConfig.output?.publicDir ?? nuxt.options.nitro?.output?.publicDir;
-  const publicDir = _public ? path.resolve(_public) : path.resolve(nuxt.options.buildDir, "../.output/public");
+  const publicDir = _public ? path.resolve(_public) : path.resolve(nuxt.options.rootDir, ".output/public");
+  options.swDest = options.swDest ? path.isAbsolute(options.swDest) ? options.swDest : path.resolve(publicDir, options.swDest) : path.resolve(publicDir, "sw.js");
+  options.globDirectory = options.globDirectory || publicDir;
   if (!nuxt.options.dev && !options.manifestTransforms) {
     options.manifestTransforms = [createManifestTransform(nuxt.options.app.baseURL ?? "/", publicDir, appManifestFolder)];
   }
-}
+};
 function createManifestTransform(base, publicDir, appManifestFolder) {
   return async (entries) => {
     entries.filter((e) => e.url.endsWith(".html")).forEach((e) => {
@@ -79,7 +78,7 @@ function createManifestTransform(base, publicDir, appManifestFolder) {
   };
 }
 
-const module = defineNuxtModule({
+const module = defineNuxtModule().with({
   meta: {
     name: "@serwist/nuxt",
     configKey: "serwist",
@@ -89,7 +88,6 @@ const module = defineNuxtModule({
     version: packageJson.version
   },
   defaults(nuxt) {
-    const publicDir = path.resolve(nuxt.options.rootDir, ".output/public");
     return {
       base: nuxt.options.app.baseURL,
       scope: nuxt.options.app.baseURL,
@@ -99,16 +97,18 @@ const module = defineNuxtModule({
       // Try to find `service-worker.{ts,js}` or `service-worker/index.{ts,js}`. If not found,
       // force the user to provide a `swSrc` themself.
       swSrc: resolveEntry(path.resolve(nuxt.options.rootDir, "service-worker")) || void 0,
-      swDest: path.resolve(publicDir, "sw.js"),
+      // If `swDest` is not set by `configureSerwistOptions`, something is wrong.
+      swDest: "",
       swUrl: "/sw.js",
-      globDirectory: publicDir,
+      // If `globDirectory` is not set by `configureSerwistOptions`, something is wrong.
+      globDirectory: "",
       injectionPoint: "self.__SW_MANIFEST"
     };
   },
-  async setup(options, nuxt) {
+  async setup(_options, nuxt) {
     const resolver = createResolver(import.meta.url);
     let ctx;
-    const { client: _client, ...userOptions } = options;
+    const { client: _client, ...options } = _options;
     const client = { registerPlugin: true, ..._client };
     const runtimeDir = resolver.resolve("./runtime");
     if (!nuxt.options.ssr) nuxt.options.build.transpile.push(runtimeDir);
@@ -122,7 +122,7 @@ const module = defineNuxtModule({
       references.push({ path: resolver.resolve(runtimeDir, "plugins/augmentation.d.ts") });
     });
     nuxt.hook("nitro:init", (nitro) => {
-      configurePwaOptions(options, nuxt, nitro.options);
+      configureSerwistOptions(options, nuxt, nitro.options);
     });
     nuxt.hook("vite:extend", ({ config }) => {
       const plugin = config.plugins?.find((p) => p && typeof p === "object" && "name" in p && p.name === "vite-plugin-serwist");
@@ -154,7 +154,7 @@ const module = defineNuxtModule({
           }
         });
       }
-      ctx = createContext(userOptions, "nuxt");
+      ctx = createContext(options, "nuxt");
       viteInlineConfig.plugins.push(main(ctx), dev(ctx));
     });
     extendWebpackConfig(() => {

package/dist/types.d.mts

@@ -1,3 +1,3 @@
 export { default } from './module.mjs'
 
-export { type ClientOptions, type ModuleOptions } from './module.mjs'
+export { type ClientOptions, type DefaultModuleKeys, type DefaultModuleOptions, type ModuleOptions, type ResolvedModuleOptions } from './module.mjs'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/nuxt",
-  "version": "10.0.0-preview.13",
+  "version": "10.0.0-preview.14",
   "type": "module",
   "sideEffects": false,
   "description": "A Nuxt module that integrates Serwist into your application.",
@@ -45,6 +45,7 @@
       "vite",
       "@nuxt/kit",
       "@serwist/build",
+      "@serwist/utils",
       "vite-plugin-serwist",
       "virtual:serwist-nuxt-configuration",
       "virtual:serwist"
@@ -52,10 +53,10 @@
   },
   "dependencies": {
     "@nuxt/kit": "4.0.3",
-    "@serwist/build": "10.0.0-preview.13",
-    "@serwist/utils": "10.0.0-preview.13",
-    "@serwist/window": "10.0.0-preview.13",
-    "vite-plugin-serwist": "10.0.0-preview.13"
+    "@serwist/build": "10.0.0-preview.14",
+    "@serwist/utils": "10.0.0-preview.14",
+    "@serwist/window": "10.0.0-preview.14",
+    "vite-plugin-serwist": "10.0.0-preview.14"
   },
   "devDependencies": {
     "@nuxt/module-builder": "1.0.2",
@@ -68,7 +69,7 @@
     "typescript": "5.9.2",
     "vite": "7.1.3",
     "vue-tsc": "3.0.6",
-    "@serwist/configs": "10.0.0-preview.13"
+    "@serwist/configs": "10.0.0-preview.14"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0",