@vuepress/plugin-pwa 2.0.0-rc.16 → 2.0.0-rc.18

package/lib/client/components/{PWAFoundPopup.d.ts → PwaFoundPopup.d.ts}

@@ -1,16 +1,16 @@
 import type { PropType, SlotsType, VNode } from 'vue';
-import type { PWAPluginLocaleConfig } from '../../shared/index.js';
+import type { PwaPluginLocaleConfig } from '../../shared/index.js';
 import '../styles/popup.css';
-export declare const PWAFoundPopup: import("vue").DefineComponent<{
+export declare const PwaFoundPopup: import("vue").DefineComponent<{
     /** locale data */
     locales: {
-        type: PropType<PWAPluginLocaleConfig>;
+        type: PropType<PwaPluginLocaleConfig>;
         required: true;
     };
 }, () => VNode, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     /** locale data */
     locales: {
-        type: PropType<PWAPluginLocaleConfig>;
+        type: PropType<PwaPluginLocaleConfig>;
         required: true;
     };
 }>>, {}, SlotsType<{

package/lib/client/components/{PWAFoundPopup.js → PwaFoundPopup.js}

@@ -1,10 +1,10 @@
 import { useLocaleConfig } from '@vuepress/helper/client';
 import { defineComponent, h, onMounted, ref, Transition } from 'vue';
-import { usePWAEvent } from '../composables/index.js';
+import { usePwaEvent } from '../composables/index.js';
 import { UpdateIcon } from './icons.js';
 import '../styles/popup.css';
-export const PWAFoundPopup = defineComponent({
-    name: 'PWAFoundPopup',
+export const PwaFoundPopup = defineComponent({
+    name: 'PwaFoundPopup',
     props: {
         /** locale data */
         locales: {
@@ -25,7 +25,7 @@ export const PWAFoundPopup = defineComponent({
             }
         };
         onMounted(() => {
-            const event = usePWAEvent();
+            const event = usePwaEvent();
             event.on('updatefound', () => {
                 navigator.serviceWorker.getRegistration().then((registration) => {
                     // Check whether a valid service worker is active

package/lib/client/components/{PWAInstall.d.ts → PwaInstall.d.ts}

@@ -1,16 +1,16 @@
 import type { PropType, VNode } from 'vue';
-import type { PWAPluginLocaleConfig } from '../../shared/index.js';
+import type { PwaPluginLocaleConfig } from '../../shared/index.js';
 import '../styles/modal.css';
-export declare const PWAInstall: import("vue").DefineComponent<{
+export declare const PwaInstall: import("vue").DefineComponent<{
     /** locale data */
     locales: {
-        type: PropType<PWAPluginLocaleConfig>;
+        type: PropType<PwaPluginLocaleConfig>;
         required: true;
     };
 }, () => VNode, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     /** locale data */
     locales: {
-        type: PropType<PWAPluginLocaleConfig>;
+        type: PropType<PwaPluginLocaleConfig>;
         required: true;
     };
 }>>, {}, {}>;

package/lib/client/components/{PWAInstall.js → PwaInstall.js}

@@ -1,10 +1,10 @@
 import { useLocaleConfig } from '@vuepress/helper/client';
 import { useToggle } from '@vueuse/core';
 import { computed, defineComponent, h, onMounted, ref } from 'vue';
-import { PWAInstallModal } from './PWAInstallModal.js';
+import { PwaInstallModal } from './PwaInstallModal.js';
 import '../styles/modal.css';
-export const PWAInstall = defineComponent({
-    name: 'PWAInstall',
+export const PwaInstall = defineComponent({
+    name: 'PwaInstall',
     props: {
         /** locale data */
         locales: {
@@ -68,7 +68,7 @@ export const PWAInstall = defineComponent({
                     },
                 }, locale.value.install)
                 : null,
-            h(PWAInstallModal, {
+            h(PwaInstallModal, {
                 style: {
                     display: isOpen.value ? 'block' : 'none',
                 },

package/lib/client/components/{PWAInstallModal.d.ts → PwaInstallModal.d.ts}

@@ -1,9 +1,9 @@
 import type { PropType, VNode } from 'vue';
-import type { PWAPluginLocaleConfig } from '../../shared/index.js';
-export declare const PWAInstallModal: import("vue").DefineComponent<{
+import type { PwaPluginLocaleConfig } from '../../shared/index.js';
+export declare const PwaInstallModal: import("vue").DefineComponent<{
     /** locale data */
     locales: {
-        type: PropType<PWAPluginLocaleConfig>;
+        type: PropType<PwaPluginLocaleConfig>;
         required: true;
     };
     /**
@@ -15,7 +15,7 @@ export declare const PWAInstallModal: import("vue").DefineComponent<{
 }, () => VNode, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("close" | "canInstall" | "hint")[], "close" | "canInstall" | "hint", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     /** locale data */
     locales: {
-        type: PropType<PWAPluginLocaleConfig>;
+        type: PropType<PwaPluginLocaleConfig>;
         required: true;
     };
     /**

package/lib/client/components/{PWAInstallModal.js → PwaInstallModal.js}

@@ -3,8 +3,8 @@ import { useEventListener } from '@vueuse/core';
 import { defineComponent, h, onMounted, shallowRef } from 'vue';
 import { withBase } from 'vuepress/client';
 import { ArrowLeftIcon, ArrowRightIcon, CloseIcon } from './icons.js';
-export const PWAInstallModal = defineComponent({
-    name: 'PWAInstallModal',
+export const PwaInstallModal = defineComponent({
+    name: 'PwaInstallModal',
     props: {
         /** locale data */
         locales: {

package/lib/client/components/{PWAReadyPopup.d.ts → PwaReadyPopup.d.ts}

@@ -1,16 +1,16 @@
 import type { PropType, SlotsType, VNode } from 'vue';
-import type { PWAPluginLocaleConfig } from '../../shared/index.js';
+import type { PwaPluginLocaleConfig } from '../../shared/index.js';
 import '../styles/popup.css';
-export declare const PWAReadyPopup: import("vue").DefineComponent<{
+export declare const PwaReadyPopup: import("vue").DefineComponent<{
     /** locale data */
     locales: {
-        type: PropType<PWAPluginLocaleConfig>;
+        type: PropType<PwaPluginLocaleConfig>;
         required: true;
     };
 }, () => VNode, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     /** locale data */
     locales: {
-        type: PropType<PWAPluginLocaleConfig>;
+        type: PropType<PwaPluginLocaleConfig>;
         required: true;
     };
 }>>, {}, SlotsType<{

package/lib/client/components/{PWAReadyPopup.js → PwaReadyPopup.js}

@@ -1,11 +1,11 @@
 import { useLocaleConfig } from '@vuepress/helper/client';
 import { computed, defineComponent, h, onMounted, shallowRef, Transition, } from 'vue';
-import { usePWAEvent } from '../composables/index.js';
+import { usePwaEvent } from '../composables/index.js';
 import { skipWaiting } from '../utils/index.js';
 import { UpdateIcon } from './icons.js';
 import '../styles/popup.css';
-export const PWAReadyPopup = defineComponent({
-    name: 'PWAReadyPopup',
+export const PwaReadyPopup = defineComponent({
+    name: 'PwaReadyPopup',
     props: {
         /** locale data */
         locales: {
@@ -25,7 +25,7 @@ export const PWAReadyPopup = defineComponent({
             }
         };
         onMounted(() => {
-            const event = usePWAEvent();
+            const event = usePwaEvent();
             event.on('updated', (reg) => {
                 if (reg)
                     registration.value = reg;

package/lib/client/components/index.d.ts

@@ -1,3 +1,3 @@
-export * from './PWAInstall.js';
-export * from './PWAFoundPopup.js';
-export * from './PWAReadyPopup.js';
+export * from './PwaInstall.js';
+export * from './PwaFoundPopup.js';
+export * from './PwaReadyPopup.js';

package/lib/client/components/index.js

@@ -1,3 +1,3 @@
-export * from './PWAInstall.js';
-export * from './PWAFoundPopup.js';
-export * from './PWAReadyPopup.js';
+export * from './PwaInstall.js';
+export * from './PwaFoundPopup.js';
+export * from './PwaReadyPopup.js';

package/lib/client/composables/index.d.ts

@@ -1,3 +1,3 @@
-export * from './setupPWA.js';
-export * from './usePWAEvent.js';
+export * from './setupPwa.js';
+export * from './usePwaEvent.js';
 export * from './useRegisterSW.js';

package/lib/client/composables/index.js

@@ -1,3 +1,3 @@
-export * from './setupPWA.js';
-export * from './usePWAEvent.js';
+export * from './setupPwa.js';
+export * from './usePwaEvent.js';
 export * from './useRegisterSW.js';

package/lib/client/composables/setupPwa.d.ts

@@ -0,0 +1 @@
+export declare const setupPwa: (serviceWorkerPath: string, shouldForceUpdate?: boolean) => void;

package/lib/client/composables/{setupPWA.js → setupPwa.js}

@@ -1,9 +1,9 @@
 import mitt from 'mitt';
 import { onMounted, provide } from 'vue';
 import { forceUpdate } from '../utils/index.js';
-import { pwaEventSymbol } from './usePWAEvent.js';
+import { pwaEventSymbol } from './usePwaEvent.js';
 import { useRegisterSW } from './useRegisterSW.js';
-export const setupPWA = (serviceWorkerPath, shouldForceUpdate = false) => {
+export const setupPwa = (serviceWorkerPath, shouldForceUpdate = false) => {
     if (__VUEPRESS_SSR__)
         return;
     // Create event emitter and provide it

package/lib/client/composables/{usePWAEvent.d.ts → usePwaEvent.d.ts}

@@ -1,6 +1,6 @@
 import type { Emitter } from 'mitt';
 import type { InjectionKey } from 'vue';
-export type PWAEvent = Emitter<{
+export type PwaEvent = Emitter<{
     ready: ServiceWorkerRegistration;
     registered: ServiceWorkerRegistration;
     cached: ServiceWorkerRegistration;
@@ -9,5 +9,5 @@ export type PWAEvent = Emitter<{
     offline: void;
     error: Error;
 }>;
-export declare const pwaEventSymbol: InjectionKey<PWAEvent>;
-export declare const usePWAEvent: () => PWAEvent;
+export declare const pwaEventSymbol: InjectionKey<PwaEvent>;
+export declare const usePwaEvent: () => PwaEvent;

package/lib/client/composables/usePwaEvent.js

@@ -0,0 +1,8 @@
+import { inject } from 'vue';
+export const pwaEventSymbol = Symbol(__VUEPRESS_DEV__ ? 'PwaEvent' : '');
+export const usePwaEvent = () => {
+    const pwaEvent = inject(pwaEventSymbol);
+    if (!pwaEvent)
+        throw new Error('usePwaEvent() is called without provider.');
+    return pwaEvent;
+};

package/lib/client/composables/useRegisterSW.d.ts

@@ -1,2 +1,2 @@
-import type { PWAEvent } from './usePWAEvent.js';
-export declare const useRegisterSW: (serviceWorkerPath: string, event: PWAEvent) => Promise<void>;
+import type { PwaEvent } from './usePwaEvent.js';
+export declare const useRegisterSW: (serviceWorkerPath: string, event: PwaEvent) => Promise<void>;

package/lib/node/generateManifest.d.ts

@@ -1,3 +1,3 @@
 import type { App } from 'vuepress/core';
-import type { PWAPluginOptions } from './options.js';
-export declare const generateManifest: (app: App, options: PWAPluginOptions) => Promise<void>;
+import type { PwaPluginOptions } from './options.js';
+export declare const generateManifest: (app: App, options: PwaPluginOptions) => Promise<void>;

package/lib/node/generateServiceWorker.d.ts

@@ -1,3 +1,3 @@
 import type { App } from 'vuepress/core';
-import type { PWAPluginOptions } from './options.js';
-export declare const generateServiceWorker: (app: App, options: PWAPluginOptions) => Promise<void>;
+import type { PwaPluginOptions } from './options.js';
+export declare const generateServiceWorker: (app: App, options: PwaPluginOptions) => Promise<void>;

package/lib/node/getManifest.d.ts

@@ -1,4 +1,4 @@
 import type { App } from 'vuepress/core';
 import type { AppManifest } from '../shared/index.js';
-import type { PWAPluginOptions } from './options.js';
-export declare const getManifest: (app: App, options: PWAPluginOptions) => Promise<AppManifest>;
+import type { PwaPluginOptions } from './options.js';
+export declare const getManifest: (app: App, options: PwaPluginOptions) => Promise<AppManifest>;

package/lib/node/helper.d.ts

@@ -1,4 +1,4 @@
 import type { AppManifest } from '../shared/index.js';
-import type { PWAPluginOptions } from './options.js';
+import type { PwaPluginOptions } from './options.js';
 export declare const appendBaseToManifest: (base: string, manifest: AppManifest) => AppManifest;
-export declare const appendBase: (base: string, options: PWAPluginOptions) => void;
+export declare const appendBase: (base: string, options: PwaPluginOptions) => void;

package/lib/node/injectLinksToHead.d.ts

@@ -1,3 +1,3 @@
 import type { HeadConfig } from 'vuepress/core';
-import type { PWAPluginOptions } from './options.js';
-export declare const injectLinksToHead: (options: PWAPluginOptions, base?: string, head?: HeadConfig[]) => HeadConfig[];
+import type { PwaPluginOptions } from './options.js';
+export declare const injectLinksToHead: (options: PwaPluginOptions, base?: string, head?: HeadConfig[]) => HeadConfig[];

package/lib/node/locales.d.ts

@@ -1,3 +1,3 @@
-import type { PWAPluginLocaleConfig } from '../shared/index.js';
+import type { PwaPluginLocaleConfig } from '../shared/index.js';
 /** Multi language config for pwa popup */
-export declare const pwaLocales: PWAPluginLocaleConfig;
+export declare const pwaLocales: PwaPluginLocaleConfig;

package/lib/node/options.d.ts

@@ -1,7 +1,7 @@
 import type { LocaleConfig } from 'vuepress/shared';
 import type { GenerateSWOptions } from 'workbox-build';
-import type { AppManifest, PWAPluginLocaleData } from '../shared/index.js';
-interface ApplePWAOptions {
+import type { AppManifest, PwaPluginLocaleData } from '../shared/index.js';
+interface ApplePwaOptions {
     /**
      * Path of icon used on apple devices
      *
@@ -27,7 +27,7 @@ interface ApplePWAOptions {
      */
     maskIcon?: string;
 }
-interface MicrosoftPWAOptions {
+interface MicrosoftPwaOptions {
     /**
      * Microsoft tile image
      *
@@ -45,8 +45,7 @@ interface MicrosoftPWAOptions {
      */
     color?: string;
 }
-/** PWA 配置 */
-export interface PWAPluginOptions {
+export interface PwaPluginOptions {
     /**
      * Service Worker file path
      *
@@ -120,13 +119,13 @@ export interface PWAPluginOptions {
      *
      * 苹果设置
      */
-    apple?: ApplePWAOptions | false;
+    apple?: ApplePwaOptions | false;
     /**
      * Settings for Microsoft
      *
      * 微软设置
      */
-    msTile?: MicrosoftPWAOptions | false;
+    msTile?: MicrosoftPwaOptions | false;
     /**
      * Update logic
      *
@@ -150,7 +149,7 @@ export interface PWAPluginOptions {
      *
      * 用于替换默认提示弹出组件的自定义组件。
      *
-     * @default "PWAFoundPopup"
+     * @default "PwaFoundPopup"
      */
     foundComponent?: string;
     /**
@@ -158,7 +157,7 @@ export interface PWAPluginOptions {
      *
      * 用于替换默认更新弹出组件的自定义组件。
      *
-     * @default "PWAReadyPopup"
+     * @default "PwaReadyPopup"
      */
     readyComponent?: string;
     /**
@@ -171,7 +170,7 @@ export interface PWAPluginOptions {
      *
      * 国际化配置
      */
-    locales?: LocaleConfig<PWAPluginLocaleData>;
+    locales?: LocaleConfig<PwaPluginLocaleData>;
     /**
      * Whether append base to all absolute links in options
      *

package/lib/node/prepareConfigFile.d.ts

@@ -1,3 +1,3 @@
 import type { App } from 'vuepress/core';
-import type { PWAPluginOptions } from './options.js';
-export declare const prepareConfigFile: (app: App, options: PWAPluginOptions) => Promise<string>;
+import type { PwaPluginOptions } from './options.js';
+export declare const prepareConfigFile: (app: App, options: PwaPluginOptions) => Promise<string>;

package/lib/node/prepareConfigFile.js

@@ -5,38 +5,38 @@ export const prepareConfigFile = (app, options) => {
     const rootComponents = [];
     if (options.showInstall) {
         configImport += `\
-import { PWAInstall as _PWAInstall } from "${path.join(__dirname, '../client/components/PWAInstall.js')}";
+import { PwaInstall as _PwaInstall } from "${path.join(__dirname, '../client/components/PwaInstall.js')}";
 `;
-        rootComponents.push('PWAInstall');
+        rootComponents.push('PwaInstall');
     }
     if (options.update === 'hint') {
         configImport += `\
-import { PWAFoundPopup as _PWAFoundPopup } from "${options.foundComponent ||
-            path.join(__dirname, '../client/components/PWAFoundPopup.js')}";
+import { PwaFoundPopup as _PwaFoundPopup } from "${options.foundComponent ||
+            path.join(__dirname, '../client/components/PwaFoundPopup.js')}";
 `;
-        rootComponents.push('PWAFoundPopup');
+        rootComponents.push('PwaFoundPopup');
     }
     else if (options.update !== 'disable' && options.update !== 'force') {
         configImport += `\
-import { PWAReadyPopup as _PWAReadyPopup } from "${options.readyComponent ||
-            path.join(__dirname, '../client/components/PWAReadyPopup.js')}";
+import { PwaReadyPopup as _PwaReadyPopup } from "${options.readyComponent ||
+            path.join(__dirname, '../client/components/PwaReadyPopup.js')}";
 `;
-        rootComponents.push('PWAReadyPopup');
+        rootComponents.push('PwaReadyPopup');
     }
     return app.writeTemp(`pwa/config.js`, `\
 import { h }  from "vue";
 import { defineClientConfig } from "vuepress/client";
-import { setupPWA } from "${path.join(__dirname, '../client/composables/setupPWA.js')}";
+import { setupPwa } from "${path.join(__dirname, '../client/composables/setupPwa.js')}";
 ${configImport}
 import "${path.join(__dirname, '../client/styles/vars.css')}";
 
-const locales = PWA_LOCALES;
+const locales = __PWA_LOCALES__;
 
 ${rootComponents.map((item) => `const ${item} = () => h(_${item}, { locales })`).join('\n')}
 
 export default defineClientConfig({
   setup: () => {
-    setupPWA(SW_PATH, SW_FORCE_UPDATE);
+    setupPwa(__SW_PATH__, __SW_FORCE_UPDATE__);
   },
   rootComponents: [
 ${rootComponents.map((item) => `    ${item},`).join('\n')}

package/lib/node/pwaPlugin.d.ts

@@ -1,3 +1,3 @@
 import type { PluginFunction } from 'vuepress/core';
-import type { PWAPluginOptions } from './options.js';
-export declare const pwaPlugin: (options?: PWAPluginOptions) => PluginFunction;
+import type { PwaPluginOptions } from './options.js';
+export declare const pwaPlugin: (options?: PwaPluginOptions) => PluginFunction;

package/lib/node/pwaPlugin.js

@@ -19,14 +19,14 @@ export const pwaPlugin = (options = {}) => (app) => {
     return {
         name: PLUGIN_NAME,
         define: () => ({
-            PWA_LOCALES: getLocaleConfig({
+            __PWA_LOCALES__: getLocaleConfig({
                 app,
                 name: PLUGIN_NAME,
                 default: pwaLocales,
                 config: options.locales,
             }),
-            SW_FORCE_UPDATE: options.update === 'force',
-            SW_PATH: options.serviceWorkerFilename || 'service-worker.js',
+            __SW_FORCE_UPDATE__: options.update === 'force',
+            __SW_PATH__: options.serviceWorkerFilename || 'service-worker.js',
         }),
         extendsBundlerOptions: (bundlerOptions, app) => {
             addViteOptimizeDepsExclude(bundlerOptions, app, [

package/lib/shared/locales.d.ts

@@ -1,5 +1,5 @@
 import type { ExactLocaleConfig } from '@vuepress/helper';
-export interface PWAPluginLocaleData {
+export interface PwaPluginLocaleData {
     /**
      * Install button text
      *
@@ -67,4 +67,4 @@ export interface PWAPluginLocaleData {
      */
     update: string;
 }
-export type PWAPluginLocaleConfig = ExactLocaleConfig<PWAPluginLocaleData>;
+export type PwaPluginLocaleConfig = ExactLocaleConfig<PwaPluginLocaleData>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/plugin-pwa",
-  "version": "2.0.0-rc.16",
+  "version": "2.0.0-rc.18",
   "description": "VuePress plugin - progressive web application",
   "keywords": [
     "vuepress-plugin",
@@ -41,11 +41,11 @@
     "style": "sass src:lib --no-source-map"
   },
   "dependencies": {
-    "@vuepress/helper": "~2.0.0-rc.15",
-    "@vueuse/core": "^10.7.2",
+    "@vuepress/helper": "~2.0.0-rc.18",
+    "@vueuse/core": "^10.9.0",
     "mitt": "^3.0.1",
     "register-service-worker": "^1.7.2",
-    "vue": "^3.4.19",
+    "vue": "^3.4.21",
     "workbox-build": "^7.0.0"
   },
   "peerDependencies": {
@@ -54,5 +54,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f85c8b1cf54e30b2267f6dbf27d06263d2cfbfbd"
+  "gitHead": "8bad47f0dbefd1037574255bf95a719bb680f60e"
 }

package/lib/client/composables/setupPWA.d.ts

@@ -1 +0,0 @@
-export declare const setupPWA: (serviceWorkerPath: string, shouldForceUpdate?: boolean) => void;

package/lib/client/composables/usePWAEvent.js

@@ -1,8 +0,0 @@
-import { inject } from 'vue';
-export const pwaEventSymbol = Symbol(__VUEPRESS_DEV__ ? 'PWAEvent' : '');
-export const usePWAEvent = () => {
-    const pwaEvent = inject(pwaEventSymbol);
-    if (!pwaEvent)
-        throw new Error('usePWAEvent() is called without provider.');
-    return pwaEvent;
-};