@vite-pwa/vitepress 0.0.5 → 0.2.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Anthony Fu<https://github.com/antfu>
+Copyright (c) 2022-PRESENT 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

package/README.md

@@ -40,6 +40,8 @@ Zero-config PWA Plugin for VitePress
 - ⚙️ **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)
+- 💥 PWA Assets Generator: generate all the PWA assets from a single command and a single source image
 
 ## 📦 Install
 
@@ -84,4 +86,4 @@ Check out the type declaration [src/types.ts](./src/types.ts) and the following
 
 ## 📄 License
 
-MIT License © 2022-PRESENT [Anthony Fu](https://github.com/antfu)
+[MIT](./LICENSE) License © 2022-PRESENT [Anthony Fu](https://github.com/antfu)

package/dist/index.cjs

@@ -1,6 +1,5 @@
 'use strict';
 
-const vitepress = require('vitepress');
 const vitePluginPwa = require('vite-plugin-pwa');
 
 function configurePWAOptions(options) {
@@ -17,7 +16,7 @@ function configurePWAOptions(options) {
   }
 }
 
-function withPwa(config) {
+function withUserConfig(config) {
   let viteConf = config.vite;
   if (!viteConf) {
     viteConf = {};
@@ -33,23 +32,22 @@ function withPwa(config) {
     if (pwaPlugin)
       throw new Error("Remove vite-plugin-pwa plugin from Vite Plugins entry in VitePress config file");
   }
-  const { pwa = {}, ...vitePressOptions } = config;
+  const { pwa = {} } = config;
   configurePWAOptions(pwa);
   let api;
   vitePlugins.push(
-    // @ts-expect-error vite 4 PluginOption and Plugin mismatch
     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;
+      configResolved(resolvedViteConfig) {
+        if (!resolvedViteConfig.build.ssr)
+          api = resolvedViteConfig.plugins.find((p) => p.name === "vite-plugin-pwa")?.api;
       }
     }
   );
-  const vitePressConfig = vitepress.defineConfigWithTheme(vitePressOptions);
+  const vitePressConfig = config;
   const userTransformHead = vitePressConfig.transformHead;
   const userBuildEnd = vitePressConfig.buildEnd;
   vitePressConfig.transformHead = async (ctx) => {
@@ -89,4 +87,14 @@ function withPwa(config) {
   return vitePressConfig;
 }
 
+async function withPwa(config) {
+  if (typeof config === "function") {
+    return async (ctx) => {
+      const userConfig = await config(ctx);
+      return withUserConfig(userConfig);
+    };
+  }
+  return withUserConfig(await config);
+}
+
 exports.withPwa = withPwa;

package/dist/index.d.ts

@@ -1,14 +1,16 @@
-import { UserConfig } from 'vitepress';
+import * as vite from 'vite';
+import * as vitepress_dist_node from 'vitepress/dist/node';
+import { DefaultTheme, UserConfigExport } from 'vitepress';
 import { VitePWAOptions } from 'vite-plugin-pwa';
 
-interface PwaOptions extends Partial<VitePWAOptions> {
-}
-declare module 'vitepress' {
-    interface UserConfig {
-        pwa?: PwaOptions;
-    }
+interface PwaOptions extends Partial<VitePWAOptions> {
+}
+declare module 'vitepress' {
+    interface UserConfig {
+        pwa?: PwaOptions;
+    }
 }
 
-declare function withPwa(config: UserConfig): UserConfig<any>;
+declare function withPwa<T = DefaultTheme.Config>(config: UserConfigExport<T>): Promise<vitepress_dist_node.UserConfig<T> | ((ctx: vite.ConfigEnv) => Promise<vitepress_dist_node.UserConfig<T>>)>;
 
 export { PwaOptions, withPwa };

package/dist/index.mjs

@@ -1,4 +1,3 @@
-import { defineConfigWithTheme } from 'vitepress';
 import { VitePWA } from 'vite-plugin-pwa';
 
 function configurePWAOptions(options) {
@@ -15,7 +14,7 @@ function configurePWAOptions(options) {
   }
 }
 
-function withPwa(config) {
+function withUserConfig(config) {
   let viteConf = config.vite;
   if (!viteConf) {
     viteConf = {};
@@ -31,23 +30,22 @@ function withPwa(config) {
     if (pwaPlugin)
       throw new Error("Remove vite-plugin-pwa plugin from Vite Plugins entry in VitePress config file");
   }
-  const { pwa = {}, ...vitePressOptions } = config;
+  const { pwa = {} } = config;
   configurePWAOptions(pwa);
   let api;
   vitePlugins.push(
-    // @ts-expect-error vite 4 PluginOption and Plugin mismatch
     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;
+      configResolved(resolvedViteConfig) {
+        if (!resolvedViteConfig.build.ssr)
+          api = resolvedViteConfig.plugins.find((p) => p.name === "vite-plugin-pwa")?.api;
       }
     }
   );
-  const vitePressConfig = defineConfigWithTheme(vitePressOptions);
+  const vitePressConfig = config;
   const userTransformHead = vitePressConfig.transformHead;
   const userBuildEnd = vitePressConfig.buildEnd;
   vitePressConfig.transformHead = async (ctx) => {
@@ -87,4 +85,14 @@ function withPwa(config) {
   return vitePressConfig;
 }
 
+async function withPwa(config) {
+  if (typeof config === "function") {
+    return async (ctx) => {
+      const userConfig = await config(ctx);
+      return withUserConfig(userConfig);
+    };
+  }
+  return withUserConfig(await config);
+}
+
 export { withPwa };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@vite-pwa/vitepress",
   "type": "module",
-  "version": "0.0.5",
-  "packageManager": "pnpm@7.18.1",
+  "version": "0.2.0",
+  "packageManager": "pnpm@8.6.1",
   "description": "Zero-config PWA for VitePress",
   "author": "antfu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -43,22 +43,21 @@
     "release": "bumpp && npm publish"
   },
   "peerDependencies": {
-    "vite-plugin-pwa": "^0.14.0"
+    "vite-plugin-pwa": ">=0.16.3 <1"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^0.35.2",
-    "@antfu/ni": "^0.19.0",
-    "@types/debug": "^4.1.7",
-    "@types/workbox-build": "^5.0.1",
-    "@typescript-eslint/eslint-plugin": "^5.51.0",
-    "bumpp": "^8.2.1",
-    "eslint": "^8.33.0",
+    "@antfu/eslint-config": "^0.39.5",
+    "@antfu/ni": "^0.21.4",
+    "@types/debug": "^4.1.8",
+    "@typescript-eslint/eslint-plugin": "^5.59.9",
+    "bumpp": "^9.1.1",
+    "eslint": "^8.42.0",
     "https-localhost": "^4.7.1",
-    "typescript": "^4.9.5",
-    "unbuild": "^1.1.1",
-    "vite": "^4.0.0",
-    "vite-plugin-pwa": "^0.14.2",
-    "vitepress": "1.0.0-alpha.45"
+    "typescript": "^5.1.3",
+    "unbuild": "^1.2.1",
+    "vite": "^4.3.9",
+    "vite-plugin-pwa": ">=0.16.3 <1",
+    "vitepress": "1.0.0-beta.2"
   },
   "pnpm": {
     "peerDependencyRules": {