@serwist/nuxt 8.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020-2023 Anthony Fu <https://github.com/antfu>, 2023 Serwist
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+This module's documentation is a work-in-progress.

package/dist/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.mts

@@ -0,0 +1,62 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import { PluginOptions } from '@serwist/vite';
+
+/**
+ * Make certain fields in a object type required
+ *
+ * @example
+ *     interface A {
+ *         a?: string;
+ *         b?: string;
+ *         c?: string;
+ *     }
+ *     type B = RequiredFields<A, "b" | "c">;
+ *     const b: B = {
+ *         b: "hehe",
+ *         c: "hehe",
+ *     }; //valid
+ *     const b: B = { a: "hehe" }; //invalid
+ *     const c: B = { a: "hehe", b: "hehe" }; //invalid
+ */
+type RequiredFields<T, U extends keyof T> = T & Required<Pick<T, U>>;
+/**
+ * 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 OptionalFields<T, U extends keyof T> = Omit<T, U> & Partial<Pick<T, U>>;
+
+interface ClientOptions {
+    /**
+     * Whether this plugin should be registered.
+     */
+    registerPlugin?: boolean;
+}
+interface ModuleOptions extends OptionalFields<PluginOptions, "swSrc" | "swDest" | "globDirectory"> {
+    manifest?: string;
+    /**
+     * Options for plugin.
+     */
+    client?: ClientOptions;
+}
+
+declare const _default: _nuxt_schema.NuxtModule<RequiredFields<ModuleOptions, "swUrl" | "swSrc" | "swDest" | "globDirectory" | "injectionPoint">>;
+
+declare module "@nuxt/schema" {
+    interface NuxtConfig {
+        ["serwist"]?: ModuleOptions;
+    }
+    interface NuxtOptions {
+        ["serwist"]?: ModuleOptions;
+    }
+}
+
+export { type ClientOptions, type ModuleOptions, _default as default };

package/dist/module.d.ts

@@ -0,0 +1,62 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import { PluginOptions } from '@serwist/vite';
+
+/**
+ * Make certain fields in a object type required
+ *
+ * @example
+ *     interface A {
+ *         a?: string;
+ *         b?: string;
+ *         c?: string;
+ *     }
+ *     type B = RequiredFields<A, "b" | "c">;
+ *     const b: B = {
+ *         b: "hehe",
+ *         c: "hehe",
+ *     }; //valid
+ *     const b: B = { a: "hehe" }; //invalid
+ *     const c: B = { a: "hehe", b: "hehe" }; //invalid
+ */
+type RequiredFields<T, U extends keyof T> = T & Required<Pick<T, U>>;
+/**
+ * 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 OptionalFields<T, U extends keyof T> = Omit<T, U> & Partial<Pick<T, U>>;
+
+interface ClientOptions {
+    /**
+     * Whether this plugin should be registered.
+     */
+    registerPlugin?: boolean;
+}
+interface ModuleOptions extends OptionalFields<PluginOptions, "swSrc" | "swDest" | "globDirectory"> {
+    manifest?: string;
+    /**
+     * Options for plugin.
+     */
+    client?: ClientOptions;
+}
+
+declare const _default: _nuxt_schema.NuxtModule<RequiredFields<ModuleOptions, "swUrl" | "swSrc" | "swDest" | "globDirectory" | "injectionPoint">>;
+
+declare module "@nuxt/schema" {
+    interface NuxtConfig {
+        ["serwist"]?: ModuleOptions;
+    }
+    interface NuxtOptions {
+        ["serwist"]?: ModuleOptions;
+    }
+}
+
+export { type ClientOptions, type ModuleOptions, _default as default };

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "name": "@serwist/nuxt",
+  "configKey": "serwist",
+  "compatibility": {
+    "nuxt": "^3.8.0",
+    "bridge": false
+  },
+  "version": "8.4.0"
+}

package/dist/module.mjs

@@ -0,0 +1,185 @@
+import path from 'node:path';
+import { defineNuxtModule, createResolver, addPlugin, extendWebpackConfig } from '@nuxt/kit';
+import { resolveEntry, createContext, createApi, main, dev } from '@serwist/vite';
+import { createHash } from 'node:crypto';
+import { createReadStream } from 'node:fs';
+import fs from 'node:fs/promises';
+import pathe from 'pathe';
+
+const version = "8.4.0";
+
+function configurePwaOptions(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._generate || !!nitroConfig.prerender?.routes?.length || Object.values(nitroConfig.routeRules ?? {}).some((r) => r.prerender);
+    if (enableGlobPatterns) {
+      options.globPatterns = options.globPatterns ?? [];
+      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 ? pathe.resolve(_public) : pathe.resolve(nuxt.options.buildDir, "../.output/public");
+  if (!nuxt.options.dev && !options.manifestTransforms) {
+    options.manifestTransforms = [createManifestTransform(nuxt.options.app.baseURL ?? "/", publicDir, appManifestFolder)];
+  }
+}
+function createManifestTransform(base, publicFolder, appManifestFolder) {
+  return async (entries) => {
+    entries.filter((e) => e.url.endsWith(".html")).forEach((e) => {
+      const url = e.url.startsWith("/") ? e.url.slice(1) : e.url;
+      if (url === "index.html") {
+        e.url = base;
+      } else {
+        const parts = url.split("/");
+        parts[parts.length - 1] = parts[parts.length - 1].replace(/\.html$/, "");
+        e.url = parts.length > 1 ? parts.slice(0, parts.length - 1).join("/") : parts[0];
+      }
+    });
+    if (appManifestFolder) {
+      const regExp = /(\/)?[0-9a-f]{8}\b-[0-9a-f]{4}\b-[0-9a-f]{4}\b-[0-9a-f]{4}\b-[0-9a-f]{12}\.json$/i;
+      entries.filter((e) => e.url.startsWith(appManifestFolder) && regExp.test(e.url)).forEach((e) => {
+        e.revision = null;
+      });
+      const latest = `${appManifestFolder}latest.json`;
+      const latestJson = pathe.resolve(publicFolder, latest);
+      const data = await fs.lstat(latestJson).catch(() => void 0);
+      if (data?.isFile()) {
+        const revision = await new Promise((resolve, reject) => {
+          const cHash = createHash("MD5");
+          const stream = createReadStream(latestJson);
+          stream.on("error", (err) => {
+            reject(err);
+          });
+          stream.on("data", (chunk) => cHash.update(chunk));
+          stream.on("end", () => {
+            resolve(cHash.digest("hex"));
+          });
+        });
+        const latestEntry = entries.find((e) => e.url === latest);
+        if (latestEntry)
+          latestEntry.revision = revision;
+        else
+          entries.push({ url: latest, revision, size: data.size });
+      } else {
+        entries = entries.filter((e) => e.url !== latest);
+      }
+    }
+    return { manifest: entries, warnings: [] };
+  };
+}
+
+const module = defineNuxtModule({
+  meta: {
+    name: "@serwist/nuxt",
+    configKey: "serwist",
+    compatibility: {
+      nuxt: "^3.8.0",
+      bridge: false
+    },
+    version
+  },
+  defaults(nuxt) {
+    const publicDir = nuxt.options.nitro?.output?.publicDir ? path.resolve(nuxt.options.nitro.output.publicDir) : path.resolve(nuxt.options.buildDir, "../.output/public");
+    return {
+      base: nuxt.options.app.baseURL,
+      scope: nuxt.options.app.baseURL,
+      injectRegister: false,
+      client: {
+        registerPlugin: true
+      },
+      // 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"),
+      swUrl: "/sw.js",
+      globDirectory: publicDir,
+      injectionPoint: "self.__SW_MANIFEST"
+    };
+  },
+  async setup(options, nuxt) {
+    const resolver = createResolver(import.meta.url);
+    let ctx, api;
+    const { manifest: manifestPath, client: _client, ...userOptions } = options;
+    const client = { registerPlugin: true, ..._client };
+    const runtimeDir = resolver.resolve("./runtime");
+    if (!nuxt.options.ssr)
+      nuxt.options.build.transpile.push(runtimeDir);
+    if (client.registerPlugin) {
+      addPlugin({
+        src: resolver.resolve(runtimeDir, "plugins/client"),
+        mode: "client"
+      });
+    }
+    nuxt.hook("prepare:types", ({ references }) => {
+      references.push({ path: resolver.resolve(runtimeDir, "plugins/augmentation") });
+    });
+    nuxt.hook("nitro:init", (nitro) => {
+      configurePwaOptions(options, nuxt, nitro.options);
+    });
+    nuxt.hook("vite:extend", ({ config }) => {
+      const plugin = config.plugins?.find((p) => p && typeof p === "object" && "name" in p && p.name === "@serwist/vite");
+      if (plugin) {
+        throw new Error("Remove @serwist/vite from your Vite configuration! Do not use it alongside @serwist/nuxt.");
+      }
+    });
+    nuxt.hook("vite:extendConfig", async (viteInlineConfig, { isClient }) => {
+      if (!viteInlineConfig.plugins) {
+        viteInlineConfig.plugins = [];
+      }
+      const plugin = viteInlineConfig.plugins.find((p) => p && typeof p === "object" && "name" in p && p.name === "@serwist/vite");
+      if (plugin) {
+        throw new Error("Remove @serwist/vite from your Vite conoptionsfiguration! Do not use it alongside @serwist/nuxt.");
+      }
+      if (isClient) {
+        const configuration = "virtual:serwist-nuxt-configuration";
+        const resolvedConfiguration = `\0${configuration}`;
+        viteInlineConfig.plugins.push({
+          name: "@serwist/nuxt:configuration",
+          enforce: "pre",
+          resolveId(id) {
+            if (id === configuration) {
+              return resolvedConfiguration;
+            }
+            return void 0;
+          },
+          async load(id) {
+            if (id === resolvedConfiguration) {
+              return `export const enabled = ${client.registerPlugin};`;
+            }
+            return void 0;
+          }
+        });
+      }
+      ctx = createContext(userOptions, "nuxt");
+      api = createApi(ctx);
+      const plugins = [main(ctx, api), dev(ctx, api)];
+      viteInlineConfig.plugins.push(plugins);
+    });
+    extendWebpackConfig(() => {
+      throw new Error("Webpack is not supported: @serwist/nuxt can only be used with Vite!");
+    });
+    if (!nuxt.options.dev) {
+      nuxt.hook("nitro:build:public-assets", () => {
+        if (!api || api.disabled) {
+          return;
+        }
+        void api.generateSW();
+      });
+    }
+  }
+});
+
+export { module as default };

package/dist/runtime/plugins/augmentation.d.ts

@@ -0,0 +1,21 @@
+import type { Serwist } from "@serwist/window";
+
+declare module "#app" {
+  interface NuxtApp {
+    $serwist: Serwist | undefined;
+  }
+}
+
+declare module "vue" {
+  interface ComponentCustomProperties {
+    $serwist: Serwist | undefined;
+  }
+}
+
+declare module "@vue/runtime-core" {
+  interface ComponentCustomProperties {
+    $serwist: Serwist | undefined;
+  }
+}
+
+export {};

package/dist/runtime/plugins/client.d.ts

@@ -0,0 +1,2 @@
+declare const plugin: any;
+export default plugin;

package/dist/runtime/plugins/client.mjs

@@ -0,0 +1,11 @@
+import { getSerwist } from "@serwist/vite/browser";
+import { defineNuxtPlugin } from "#imports";
+const plugin = defineNuxtPlugin(async () => {
+  const serwist = await getSerwist();
+  return {
+    provide: {
+      serwist
+    }
+  };
+});
+export default plugin;

package/dist/types.d.mts

@@ -0,0 +1,16 @@
+
+import type { ModuleOptions } from './module.js'
+
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['serwist']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['serwist']?: ModuleOptions }
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['serwist']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['serwist']?: ModuleOptions }
+}
+
+
+export type { ClientOptions, ModuleOptions, default } from './module.js'

package/dist/types.d.ts

@@ -0,0 +1,16 @@
+
+import type { ModuleOptions } from './module'
+
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['serwist']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['serwist']?: ModuleOptions }
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['serwist']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['serwist']?: ModuleOptions }
+}
+
+
+export type { ClientOptions, ModuleOptions, default } from './module'

package/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "@serwist/nuxt",
+  "version": "8.4.0",
+  "type": "module",
+  "description": "A Nuxt module that integrates Serwist into your application.",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "nuxt",
+    "pwa",
+    "vite",
+    "vite-plugin",
+    "serwist",
+    "serwistjs",
+    "pwa",
+    "sw",
+    "service worker",
+    "web",
+    "service-worker",
+    "nuxt-module"
+  ],
+  "repository": "serwist/serwist",
+  "bugs": "https://github.com/serwist/serwist/issues",
+  "homepage": "https://serwist.pages.dev",
+  "main": "./dist/module.mjs",
+  "types": "./dist/types.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "default": "./dist/module.mjs"
+    }
+  },
+  "build": {
+    "externals": [
+      "node:child_process",
+      "node:fs",
+      "node:path",
+      "consola",
+      "esbuild",
+      "rollup",
+      "vite",
+      "@nuxt/kit",
+      "@serwist/build",
+      "@serwist/vite",
+      "pathe",
+      "ufo",
+      "virtual:serwist-nuxt-configuration"
+    ]
+  },
+  "dependencies": {
+    "@nuxt/kit": "3.9.0",
+    "fast-json-stable-stringify": "2.1.0",
+    "pathe": "1.1.1",
+    "ufo": "1.3.2",
+    "@serwist/build": "8.4.0",
+    "@serwist/vite": "8.4.0",
+    "@serwist/window": "8.4.0"
+  },
+  "devDependencies": {
+    "@nuxt/module-builder": "0.5.5",
+    "@nuxt/schema": "3.9.0",
+    "@nuxt/test-utils": "3.9.0",
+    "@playwright/test": "1.40.1",
+    "@types/node": "20.10.5",
+    "eslint": "8.56.0",
+    "nuxt": "3.9.0",
+    "publint": "0.2.7",
+    "rimraf": "5.0.5",
+    "serve": "14.2.1",
+    "typescript": "5.3.3",
+    "vite": "5.0.10",
+    "vitest": "1.1.0",
+    "vue-tsc": "1.8.27",
+    "@serwist/constants": "8.4.0"
+  },
+  "peerDependencies": {
+    "vite": "^5.0.0"
+  },
+  "scripts": {
+    "build": "nuxt-module-build prepare && nuxt-module-build build",
+    "dev": "nuxi dev playground",
+    "dev:generate": "nuxi generate playground",
+    "dev:generate:netlify": "NITRO_PRESET=netlify nuxi generate playground",
+    "dev:generate:vercel": "NITRO_PRESET=vercel nuxi generate playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "dev:preview:build": "nr dev:build && node playground/.output/server/index.mjs",
+    "dev:preview:generate": "nr dev:generate && serve playground/dist"
+  }
+}