@vuepress/plugin-pwa 2.0.0-beta.9 → 2.0.0-rc.0

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

@@ -1,2 +1,2 @@
-export * from './usePwaEvent';
-export * from './useSkipWaiting';
+export * from './usePwaEvent.js';
+export * from './useSkipWaiting.js';

package/lib/client/composables/index.js

@@ -1,2 +1,2 @@
-export * from './usePwaEvent';
-export * from './useSkipWaiting';
+export * from './usePwaEvent.js';
+export * from './useSkipWaiting.js';

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

@@ -1,22 +1,13 @@
-import type { Emitter, Handler, WildcardHandler } from 'mitt';
+import type { Emitter } from 'mitt';
 import type { InjectionKey } from 'vue';
-export interface PwaEvent extends Emitter {
-    on(type: 'ready', handler: Handler<ServiceWorkerRegistration>): void;
-    on(type: 'registered', handler: Handler<ServiceWorkerRegistration>): void;
-    on(type: 'cached', handler: Handler<ServiceWorkerRegistration>): void;
-    on(type: 'updatefound', handler: Handler<ServiceWorkerRegistration>): void;
-    on(type: 'updated', handler: Handler<ServiceWorkerRegistration>): void;
-    on(type: 'offline', handler: Handler<void>): void;
-    on(type: 'error', handler: Handler<Error>): void;
-    on(type: '*', handler: WildcardHandler): void;
-    emit(type: 'ready', event: ServiceWorkerRegistration): void;
-    emit(type: 'registered', event: ServiceWorkerRegistration): void;
-    emit(type: 'cached', event: ServiceWorkerRegistration): void;
-    emit(type: 'updatefound', event: ServiceWorkerRegistration): void;
-    emit(type: 'updated', event: ServiceWorkerRegistration): void;
-    emit(type: 'offline'): void;
-    emit(type: 'error', event: Error): void;
-    emit(type: '*', event?: any): void;
-}
+export type PwaEvent = Emitter<{
+    ready: ServiceWorkerRegistration;
+    registered: ServiceWorkerRegistration;
+    cached: ServiceWorkerRegistration;
+    updatefound: ServiceWorkerRegistration;
+    updated: ServiceWorkerRegistration;
+    offline: void;
+    error: Error;
+}>;
 export declare const pwaEventSymbol: InjectionKey<PwaEvent>;
 export declare const usePwaEvent: () => PwaEvent;

package/lib/client/composables/usePwaEvent.js

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

package/lib/client/config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@vuepress/client").ClientConfig;
+export default _default;

package/lib/client/config.js

@@ -0,0 +1,50 @@
+import { defineClientConfig, withBase } from '@vuepress/client';
+import mitt from 'mitt';
+import { onMounted, provide } from 'vue';
+import { pwaEventSymbol } from './composables/index.js';
+const swFilename = __PWA_SW_FILENAME__;
+export default defineClientConfig({
+    setup() {
+        if (__VUEPRESS_SSR__ || !swFilename)
+            return;
+        const log = (...args) => console.log('[@vuepress/plugin-pwa]', ...args);
+        // create event emitter and provide it
+        const event = mitt();
+        provide(pwaEventSymbol, event);
+        onMounted(async () => {
+            // lazy load register-service-worker
+            const { register } = await import('register-service-worker');
+            // Register service worker
+            register(withBase(swFilename), {
+                ready(registration) {
+                    log('Service worker is active.');
+                    event.emit('ready', registration);
+                },
+                registered(registration) {
+                    log('Service worker has been registered.');
+                    event.emit('registered', registration);
+                },
+                cached(registration) {
+                    log('Content has been cached for offline use.');
+                    event.emit('cached', registration);
+                },
+                updatefound(registration) {
+                    log('New content is downloading.');
+                    event.emit('updatefound', registration);
+                },
+                updated(registration) {
+                    log('New content is available, please refresh.');
+                    event.emit('updated', registration);
+                },
+                offline() {
+                    log('No internet connection found. App is running in offline mode.');
+                    event.emit('offline');
+                },
+                error(err) {
+                    log('Error during service worker registration:', err);
+                    event.emit('error', err);
+                },
+            });
+        });
+    },
+});

package/lib/client/index.d.ts

@@ -1 +1 @@
-export * from './composables';
+export * from './composables/index.js';

package/lib/client/index.js

@@ -1 +1 @@
-export * from './composables';
+export * from './composables/index.js';

package/lib/node/generateServiceWorker.d.ts

@@ -1,3 +1,4 @@
 import type { App } from '@vuepress/core';
-import type { GenerateSWConfig } from 'workbox-build';
-export declare const generateServiceWorker: (app: App, serviceWorkerFilename: string, generateSWConfig: Partial<GenerateSWConfig>) => Promise<void>;
+import type { GenerateSWOptions } from 'workbox-build';
+export type GenerateSWConfig = Omit<GenerateSWOptions, 'swDest' | 'globDirectory'>;
+export declare const generateServiceWorker: (app: App, serviceWorkerFilename: string, generateSWConfig: GenerateSWConfig) => Promise<void>;

package/lib/node/generateServiceWorker.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateServiceWorker = void 0;
-const utils_1 = require("@vuepress/utils");
+import { logger } from '@vuepress/utils';
 const assetsExtensions = [
     // basic
     'html',
@@ -20,9 +17,9 @@ const assetsExtensions = [
     'tff',
     'otf',
 ];
-const generateServiceWorker = async (app, serviceWorkerFilename, generateSWConfig) => {
+export const generateServiceWorker = async (app, serviceWorkerFilename, generateSWConfig) => {
     // lazy-load workbox-build
-    const generateSW = require('workbox-build/build/generate-sw');
+    const { generateSW } = await import('workbox-build');
     const globDirectory = app.dir.dest();
     const swDest = app.dir.dest(serviceWorkerFilename);
     const { warnings } = await generateSW({
@@ -35,6 +32,5 @@ const generateServiceWorker = async (app, serviceWorkerFilename, generateSWConfi
         globDirectory,
         swDest,
     });
-    warnings.forEach((warning) => utils_1.logger.warn('[@vuepress/plugin-pwa]', warning));
+    warnings.forEach((warning) => logger.warn('[@vuepress/plugin-pwa]', warning));
 };
-exports.generateServiceWorker = generateServiceWorker;

package/lib/node/index.d.ts

@@ -1,4 +1,4 @@
-import { pwaPlugin } from './pwaPlugin';
-export * from './generateServiceWorker';
-export * from './pwaPlugin';
+import { pwaPlugin } from './pwaPlugin.js';
+export * from './generateServiceWorker.js';
+export * from './pwaPlugin.js';
 export default pwaPlugin;

package/lib/node/index.js

@@ -1,16 +1,4 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const pwaPlugin_1 = require("./pwaPlugin");
-__exportStar(require("./generateServiceWorker"), exports);
-__exportStar(require("./pwaPlugin"), exports);
-exports.default = pwaPlugin_1.pwaPlugin;
+import { pwaPlugin } from './pwaPlugin.js';
+export * from './generateServiceWorker.js';
+export * from './pwaPlugin.js';
+export default pwaPlugin;

package/lib/node/pwaPlugin.d.ts

@@ -1,9 +1,9 @@
 import type { Plugin } from '@vuepress/core';
-import type { GenerateSWConfig } from 'workbox-build';
+import type { GenerateSWConfig } from './generateServiceWorker.js';
 /**
  * Options for @vuepress/plugin-pwa
  */
-export interface PwaPluginOptions extends Omit<GenerateSWConfig, 'swDest' | 'globDirectory'> {
+export interface PwaPluginOptions extends GenerateSWConfig {
     /**
      * Filename of the generated service worker file
      *
@@ -14,4 +14,4 @@ export interface PwaPluginOptions extends Omit<GenerateSWConfig, 'swDest' | 'glo
      */
     serviceWorkerFilename?: string;
 }
-export declare const pwaPlugin: Plugin<PwaPluginOptions>;
+export declare const pwaPlugin: ({ serviceWorkerFilename, ...generateSWConfig }?: PwaPluginOptions) => Plugin;

package/lib/node/pwaPlugin.js

@@ -1,14 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.pwaPlugin = void 0;
-const utils_1 = require("@vuepress/utils");
-const generateServiceWorker_1 = require("./generateServiceWorker");
-const pwaPlugin = ({ serviceWorkerFilename = 'service-worker.js', ...generateSWConfig }) => ({
-    name: '@vuepress/plugin-pwa',
-    clientAppSetupFiles: utils_1.path.resolve(__dirname, '../client/clientAppSetup.js'),
-    define: {
-        __PWA_SW_FILENAME__: serviceWorkerFilename,
-    },
-    onGenerated: (app) => utils_1.withSpinner('Generating service worker')(() => generateServiceWorker_1.generateServiceWorker(app, serviceWorkerFilename, generateSWConfig)),
-});
-exports.pwaPlugin = pwaPlugin;
+import { getDirname, path, withSpinner } from '@vuepress/utils';
+import { generateServiceWorker } from './generateServiceWorker.js';
+const __dirname = getDirname(import.meta.url);
+export const pwaPlugin = ({ serviceWorkerFilename = 'service-worker.js', ...generateSWConfig } = {}) => (app) => {
+    const plugin = {
+        name: '@vuepress/plugin-pwa',
+    };
+    if (app.env.isDev) {
+        return plugin;
+    }
+    return {
+        ...plugin,
+        clientConfigFile: path.resolve(__dirname, '../client/config.js'),
+        define: {
+            __PWA_SW_FILENAME__: serviceWorkerFilename,
+        },
+        onGenerated: (app) => withSpinner('Generating service worker')(() => generateServiceWorker(app, serviceWorkerFilename, generateSWConfig)),
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/plugin-pwa",
-  "version": "2.0.0-beta.9",
+  "version": "2.0.0-rc.0",
   "description": "VuePress plugin - progressive web application",
   "keywords": [
     "vuepress-plugin",
@@ -18,29 +18,31 @@
   },
   "license": "MIT",
   "author": "meteorlxy",
-  "main": "lib/node/index.js",
-  "types": "lib/node/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": "./lib/node/index.js",
+    "./client": "./lib/client/index.js",
+    "./package.json": "./package.json"
+  },
+  "main": "./lib/node/index.js",
+  "types": "./lib/node/index.d.ts",
   "files": [
     "lib"
   ],
-  "scripts": {
-    "build": "tsc -b tsconfig.build.json",
-    "clean": "rimraf lib *.tsbuildinfo"
-  },
   "dependencies": {
-    "@vuepress/client": "2.0.0-beta.9",
-    "@vuepress/core": "2.0.0-beta.9",
-    "@vuepress/utils": "2.0.0-beta.8",
-    "mitt": "^2.1.0",
+    "mitt": "^3.0.1",
     "register-service-worker": "^1.7.2",
-    "vue": "^3.0.11",
-    "workbox-build": "^6.1.2"
-  },
-  "devDependencies": {
-    "@types/workbox-build": "^5.0.0"
+    "vue": "^3.3.8",
+    "workbox-build": "^7.0.0",
+    "@vuepress/client": "2.0.0-rc.0",
+    "@vuepress/core": "2.0.0-rc.0",
+    "@vuepress/utils": "2.0.0-rc.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "edccb16372fabcf160d45ae6207a871e66c81974"
-}
+  "scripts": {
+    "build": "tsc -b tsconfig.build.json",
+    "clean": "rimraf lib *.tsbuildinfo"
+  }
+}

package/CHANGELOG.md

@@ -1,198 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-# [2.0.0-beta.9](https://github.com/vuepress/vuepress-next/compare/v2.0.0-beta.8...v2.0.0-beta.9) (2021-04-21)
-
-
-### Features
-
-* **client:** provide client types file ([89a32b5](https://github.com/vuepress/vuepress-next/commit/89a32b50767ef82556f5ae3300ec016e0acaf0e5))
-
-
-
-
-
-# [2.0.0-beta.8](https://github.com/vuepress/vuepress-next/compare/v2.0.0-beta.7...v2.0.0-beta.8) (2021-04-11)
-
-
-### Code Refactoring
-
-* normalize themes and plugins structure ([7781172](https://github.com/vuepress/vuepress-next/commit/77811722401bf1ed1fec44c64158ab0cd1ab3179))
-
-
-### BREAKING CHANGES
-
-* client API that provided by plugins should be imported from `plugin-foo/lib/client`
-
-
-
-
-
-# [2.0.0-beta.7](https://github.com/vuepress/vuepress-next/compare/v2.0.0-beta.6...v2.0.0-beta.7) (2021-04-09)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-beta.6](https://github.com/vuepress/vuepress-next/compare/v2.0.0-beta.5...v2.0.0-beta.6) (2021-03-26)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-beta.5](https://github.com/vuepress/vuepress-next/compare/v2.0.0-beta.4...v2.0.0-beta.5) (2021-03-26)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-beta.4](https://github.com/vuepress/vuepress-next/compare/v2.0.0-beta.3...v2.0.0-beta.4) (2021-03-20)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-beta.1](https://github.com/vuepress/vuepress-next/compare/v2.0.0-beta.0...v2.0.0-beta.1) (2021-03-13)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-beta.0](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.26...v2.0.0-beta.0) (2021-03-13)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-alpha.25](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.24...v2.0.0-alpha.25) (2021-02-20)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-alpha.24](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.23...v2.0.0-alpha.24) (2021-02-13)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-alpha.23](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.22...v2.0.0-alpha.23) (2021-02-10)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-alpha.22](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.21...v2.0.0-alpha.22) (2021-02-10)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-alpha.20](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.19...v2.0.0-alpha.20) (2021-02-04)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-alpha.19](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.18...v2.0.0-alpha.19) (2021-01-24)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-alpha.18](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.17...v2.0.0-alpha.18) (2021-01-17)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-alpha.17](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.16...v2.0.0-alpha.17) (2021-01-13)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-alpha.16](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.15...v2.0.0-alpha.16) (2021-01-11)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-alpha.15](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.14...v2.0.0-alpha.15) (2021-01-04)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-alpha.14](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.13...v2.0.0-alpha.14) (2021-01-03)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-alpha.13](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.12...v2.0.0-alpha.13) (2020-12-23)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-alpha.12](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.11...v2.0.0-alpha.12) (2020-12-19)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-alpha.9](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.8...v2.0.0-alpha.9) (2020-12-16)
-
-**Note:** Version bump only for package @vuepress/plugin-pwa
-
-
-
-
-
-# [2.0.0-alpha.8](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.7...v2.0.0-alpha.8) (2020-12-11)
-
-
-### Features
-
-* **plugin-pwa:** migrate pwa plugin ([aa54fd6](https://github.com/vuepress/vuepress-next/commit/aa54fd65aa77b32b97de0a38359f1ad07f96f566))

package/lib/client/clientAppSetup.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("@vuepress/client").ClientAppSetup;
-export default _default;

package/lib/client/clientAppSetup.js

@@ -1,48 +0,0 @@
-import mitt from 'mitt';
-import { onMounted, provide } from 'vue';
-import { defineClientAppSetup, withBase } from '@vuepress/client';
-import { pwaEventSymbol } from './composables';
-const swFilename = __PWA_SW_FILENAME__;
-export default defineClientAppSetup(() => {
-    if (__DEV__ || __SSR__ || !swFilename)
-        return;
-    const log = (...args) => console.log('[@vuepress/plugin-pwa]', ...args);
-    // create event emitter and provide it
-    const event = mitt();
-    provide(pwaEventSymbol, event);
-    onMounted(async () => {
-        // lazy load register-service-worker
-        const { register } = await import('register-service-worker');
-        // Register service worker
-        register(withBase(swFilename), {
-            ready(registration) {
-                log('Service worker is active.');
-                event.emit('ready', registration);
-            },
-            registered(registration) {
-                log('Service worker has been registered.');
-                event.emit('registered', registration);
-            },
-            cached(registration) {
-                log('Content has been cached for offline use.');
-                event.emit('cached', registration);
-            },
-            updatefound(registration) {
-                log('New content is downloading.');
-                event.emit('updatefound', registration);
-            },
-            updated(registration) {
-                log('New content is available, please refresh.');
-                event.emit('updated', registration);
-            },
-            offline() {
-                log('No internet connection found. App is running in offline mode.');
-                event.emit('offline');
-            },
-            error(err) {
-                log('Error during service worker registration:', err);
-                event.emit('error', err);
-            },
-        });
-    });
-});