@vite-pwa/vitepress 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Anthony Fu<https://github.com/antfu>
+
+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,85 @@
+<p align='center'>
+<img src='./hero.png' alt="@vite-pwa/vitepress - Zero-config PWA for VitePress"><br>
+Zero-config PWA Plugin for VitePress
+</p>
+
+<p align='center'>
+<a href='https://www.npmjs.com/package/vite-plugin-pwa' target="__blank">
+<img src='https://img.shields.io/npm/v/vite-plugin-pwa?color=33A6B8&label=' alt="NPM version">
+</a>
+<a href="https://www.npmjs.com/package/vite-plugin-pwa" target="__blank">
+    <img alt="NPM Downloads" src="https://img.shields.io/npm/dm/vite-plugin-pwa?color=476582&label=">
+</a>
+<a href="https://vite-pwa-org.netlify.app/frameworks/vitepress" target="__blank">
+    <img src="https://img.shields.io/static/v1?label=&message=docs%20%26%20guides&color=2e859c" alt="Docs & Guides">
+</a>
+<br>
+<a href="https://github.com/antfu/vite-plugin-pwa" target="__blank">
+<img alt="GitHub stars" src="https://img.shields.io/github/stars/antfu/vite-plugin-pwa?style=social">
+</a>
+</p>
+
+<br>
+
+<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'/>
+  </a>
+</p>
+
+
+## 🚀 Features
+
+- 📖 [**Documentation & guides**](https://vite-pwa-org.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
+- 💬 **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
+
+## 📦 Install
+
+```bash
+npm i @vite-pwa/vitepress -D 
+
+# yarn 
+yarn add @vite-pwa/vitepress -D
+
+# pnpm 
+pnpm add @vite-pwa/vitepress -D
+```
+
+## 🦄 Usage
+
+You will need wrap your VitePress config with `withPwa`:
+
+```ts
+// .vitepress/config.ts
+import { defineConfig } from 'vitepress'
+import { withPwa } from '@vite-pwa/vitepress'
+
+export default withPwa(defineConfig({
+  /* your VitePress options */
+  /* Vite PWA Options */
+  pwa: {}
+}))
+```
+
+Read the [📖 documentation](https://vite-pwa-org.netlify.app/frameworks/vitepress) for a complete guide on how to configure and use
+this plugin.
+
+## 👀 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)
+
+
+## 📄 License
+
+MIT License © 2022-PRESENT [Anthony Fu](https://github.com/antfu)

package/dist/index.cjs

@@ -0,0 +1,91 @@
+'use strict';
+
+const vitepress = require('vitepress');
+const vitePluginPwa = require('vite-plugin-pwa');
+
+function configurePWAOptions(options) {
+  if (!options.outDir)
+    options.outDir = ".vitepress/dist";
+  if (options.strategies === "injectManifest") {
+    options.injectManifest = options.injectManifest ?? {};
+  } else {
+    options.workbox = options.workbox ?? {};
+    if (options.registerType === "autoUpdate" && (options.injectRegister === "script" || options.injectRegister === "inline")) {
+      options.workbox.clientsClaim = true;
+      options.workbox.skipWaiting = true;
+    }
+  }
+}
+
+function withPwa(config) {
+  let viteConf = config.vite;
+  if (!viteConf) {
+    viteConf = {};
+    config.vite = viteConf;
+  }
+  let vitePlugins = viteConf.plugins;
+  if (typeof vitePlugins === "undefined") {
+    vitePlugins = [];
+    viteConf.plugins = vitePlugins;
+  }
+  if (vitePlugins && vitePlugins.length > 0) {
+    const pwaPlugin = vitePlugins.find((i) => i && typeof i === "object" && "name" in i && i.name === "vite-plugin-pwa");
+    if (pwaPlugin)
+      throw new Error("Remove vite-plugin-pwa plugin from Vite Plugins entry in VitePress config file");
+  }
+  const { pwa = {}, ...vitePressOptions } = config;
+  configurePWAOptions(pwa);
+  let api;
+  vitePlugins.push(
+    vitePluginPwa.VitePWA({ ...pwa }),
+    {
+      name: "vite-plugin-pwa:vitepress",
+      apply: "build",
+      enforce: "post",
+      configResolved(resolvedViteconfig) {
+        if (!resolvedViteconfig.build.ssr)
+          api = resolvedViteconfig.plugins.find((p) => p.name === "vite-plugin-pwa")?.api;
+      }
+    }
+  );
+  const vitePressConfig = vitepress.defineConfigWithTheme(vitePressOptions);
+  const userTransformHead = vitePressConfig.transformHead;
+  const userBuildEnd = vitePressConfig.buildEnd;
+  vitePressConfig.transformHead = async (ctx) => {
+    const head = await userTransformHead?.(ctx) ?? [];
+    const webManifestData = api?.webManifestData();
+    if (webManifestData) {
+      const href = webManifestData.href;
+      if (webManifestData.useCredentials)
+        head.push(["link", { rel: "manifest", href, crossorigin: "use-credentials" }]);
+      else
+        head.push(["link", { rel: "manifest", href }]);
+    }
+    const registerSWData = api?.registerSWData();
+    if (registerSWData && registerSWData.shouldRegisterSW) {
+      if (registerSWData.inline) {
+        head.push([
+          "script",
+          { id: "vite-plugin-pwa:inline-sw" },
+          `if('serviceWorker' in navigator) {window.addEventListener('load', () => {navigator.serviceWorker.register('${registerSWData.inlinePath}', { scope: '${registerSWData.scope}' })})}`
+        ]);
+      } else {
+        head.push([
+          "script",
+          {
+            id: "vite-plugin-pwa:register-sw",
+            src: registerSWData.registerPath
+          }
+        ]);
+      }
+    }
+    return head;
+  };
+  vitePressConfig.buildEnd = async (siteConfig) => {
+    await userBuildEnd?.(siteConfig);
+    api && !api.disabled && await api.generateSW();
+  };
+  return vitePressConfig;
+}
+
+exports.withPwa = withPwa;

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import { UserConfig } from 'vitepress';
+import { VitePWAOptions } from 'vite-plugin-pwa';
+
+interface PwaOptions extends Partial<VitePWAOptions> {
+}
+declare module 'vitepress' {
+    interface UserConfig {
+        pwa?: PwaOptions;
+    }
+}
+
+declare function withPwa(config: UserConfig): UserConfig<any>;
+
+export { PwaOptions, withPwa };

package/dist/index.mjs

@@ -0,0 +1,89 @@
+import { defineConfigWithTheme } from 'vitepress';
+import { VitePWA } from 'vite-plugin-pwa';
+
+function configurePWAOptions(options) {
+  if (!options.outDir)
+    options.outDir = ".vitepress/dist";
+  if (options.strategies === "injectManifest") {
+    options.injectManifest = options.injectManifest ?? {};
+  } else {
+    options.workbox = options.workbox ?? {};
+    if (options.registerType === "autoUpdate" && (options.injectRegister === "script" || options.injectRegister === "inline")) {
+      options.workbox.clientsClaim = true;
+      options.workbox.skipWaiting = true;
+    }
+  }
+}
+
+function withPwa(config) {
+  let viteConf = config.vite;
+  if (!viteConf) {
+    viteConf = {};
+    config.vite = viteConf;
+  }
+  let vitePlugins = viteConf.plugins;
+  if (typeof vitePlugins === "undefined") {
+    vitePlugins = [];
+    viteConf.plugins = vitePlugins;
+  }
+  if (vitePlugins && vitePlugins.length > 0) {
+    const pwaPlugin = vitePlugins.find((i) => i && typeof i === "object" && "name" in i && i.name === "vite-plugin-pwa");
+    if (pwaPlugin)
+      throw new Error("Remove vite-plugin-pwa plugin from Vite Plugins entry in VitePress config file");
+  }
+  const { pwa = {}, ...vitePressOptions } = config;
+  configurePWAOptions(pwa);
+  let api;
+  vitePlugins.push(
+    VitePWA({ ...pwa }),
+    {
+      name: "vite-plugin-pwa:vitepress",
+      apply: "build",
+      enforce: "post",
+      configResolved(resolvedViteconfig) {
+        if (!resolvedViteconfig.build.ssr)
+          api = resolvedViteconfig.plugins.find((p) => p.name === "vite-plugin-pwa")?.api;
+      }
+    }
+  );
+  const vitePressConfig = defineConfigWithTheme(vitePressOptions);
+  const userTransformHead = vitePressConfig.transformHead;
+  const userBuildEnd = vitePressConfig.buildEnd;
+  vitePressConfig.transformHead = async (ctx) => {
+    const head = await userTransformHead?.(ctx) ?? [];
+    const webManifestData = api?.webManifestData();
+    if (webManifestData) {
+      const href = webManifestData.href;
+      if (webManifestData.useCredentials)
+        head.push(["link", { rel: "manifest", href, crossorigin: "use-credentials" }]);
+      else
+        head.push(["link", { rel: "manifest", href }]);
+    }
+    const registerSWData = api?.registerSWData();
+    if (registerSWData && registerSWData.shouldRegisterSW) {
+      if (registerSWData.inline) {
+        head.push([
+          "script",
+          { id: "vite-plugin-pwa:inline-sw" },
+          `if('serviceWorker' in navigator) {window.addEventListener('load', () => {navigator.serviceWorker.register('${registerSWData.inlinePath}', { scope: '${registerSWData.scope}' })})}`
+        ]);
+      } else {
+        head.push([
+          "script",
+          {
+            id: "vite-plugin-pwa:register-sw",
+            src: registerSWData.registerPath
+          }
+        ]);
+      }
+    }
+    return head;
+  };
+  vitePressConfig.buildEnd = async (siteConfig) => {
+    await userBuildEnd?.(siteConfig);
+    api && !api.disabled && await api.generateSW();
+  };
+  return vitePressConfig;
+}
+
+export { withPwa };

package/index.d.ts

@@ -0,0 +1 @@
+export * from './dist'

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@vite-pwa/vitepress",
+  "type": "module",
+  "version": "0.0.2",
+  "packageManager": "pnpm@7.14.2",
+  "description": "Zero-config PWA for VitePress",
+  "author": "antfu <anthonyfu117@hotmail.com>",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/antfu",
+  "homepage": "https://github.com/vite-pwa/vitepress#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vite-pwa/vitepress.git"
+  },
+  "bugs": "https://github.com/vite-pwa/vitepress/issues",
+  "keywords": [
+    "vitepress",
+    "workbox",
+    "pwa",
+    "vite",
+    "vite-plugin"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs"
+    },
+    "./dist/*": "./dist/*"
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "*.d.ts"
+  ],
+  "scripts": {
+    "build": "unbuild",
+    "lint": "eslint .",
+    "lint-fix": "nr lint --fix",
+    "xprepublishOnly": "npm run build",
+    "xrelease": "npx bumpp --push --tag --commit && npm publish"
+  },
+  "peerDependencies": {
+    "@types/workbox-build": "^5.0.1",
+    "vite-plugin-pwa": "^0.13.3"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^0.29.4",
+    "@antfu/ni": "^0.18.3",
+    "@types/debug": "^4.1.7",
+    "@types/workbox-build": "^5.0.1",
+    "@typescript-eslint/eslint-plugin": "^5.42.1",
+    "eslint": "^8.27.0",
+    "https-localhost": "^4.7.1",
+    "typescript": "^4.8.4",
+    "unbuild": "^0.9.4",
+    "vite": "^3.2.3",
+    "vite-plugin-pwa": "^0.13.3",
+    "vitepress": "1.0.0-alpha.27"
+  },
+  "pnpm": {
+    "peerDependencyRules": {
+      "ignoreMissing": [
+        "@algolia/client-search"
+      ]
+    }
+  }
+}