@vuepress/plugin-pwa 2.0.0-beta.5 → 2.0.0-beta.50-pre

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/plugin-pwa",
-  "version": "2.0.0-beta.5",
+  "version": "2.0.0-beta.50-pre",
   "description": "VuePress plugin - progressive web application",
   "keywords": [
     "vuepress-plugin",
@@ -18,30 +18,31 @@
   },
   "license": "MIT",
   "author": "meteorlxy",
-  "main": "lib/index.js",
-  "types": "lib/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",
-    "styles"
+    "./lib"
   ],
-  "scripts": {
-    "build": "tsc -b tsconfig.build.json",
-    "clean": "rimraf lib *.tsbuildinfo"
-  },
   "dependencies": {
-    "@vuepress/client": "2.0.0-beta.5",
-    "@vuepress/core": "2.0.0-beta.5",
-    "@vuepress/utils": "2.0.0-beta.5",
-    "mitt": "^2.1.0",
+    "@vuepress/client": "2.0.0-beta.50-pre",
+    "@vuepress/core": "2.0.0-beta.50-pre",
+    "@vuepress/utils": "2.0.0-beta.50-pre",
+    "mitt": "^3.0.0",
     "register-service-worker": "^1.7.2",
-    "vue": "^3.0.7",
-    "workbox-build": "^6.1.2"
-  },
-  "devDependencies": {
-    "@types/workbox-build": "^5.0.0"
+    "vue": "^3.2.37",
+    "workbox-build": "^6.5.4"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e7135a70d478ddfd4978e66265b269481c2cb299"
-}
+  "scripts": {
+    "build": "tsc -b tsconfig.build.json",
+    "clean": "rimraf lib *.tsbuildinfo"
+  }
+}

package/CHANGELOG.md

@@ -1,155 +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.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/clientAppSetup.d.ts

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

package/lib/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);
-            },
-        });
-    });
-});

package/lib/composables/index.d.ts

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

package/lib/composables/index.js

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

package/lib/composables/usePwaEvent.d.ts

@@ -1,22 +0,0 @@
-import type { Emitter, Handler, WildcardHandler } 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 declare const pwaEventSymbol: InjectionKey<PwaEvent>;
-export declare const usePwaEvent: () => PwaEvent;

package/lib/composables/usePwaEvent.js

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

package/lib/composables/useSkipWaiting.d.ts

@@ -1,4 +0,0 @@
-/**
- * Call `skipWaiting()` inside current waiting worker
- */
-export declare const useSkipWaiting: (registration: ServiceWorkerRegistration) => void;

package/lib/composables/useSkipWaiting.js

@@ -1,13 +0,0 @@
-/**
- * Call `skipWaiting()` inside current waiting worker
- */
-export const useSkipWaiting = (registration) => {
-    // get the waiting worker
-    const worker = registration.waiting;
-    // if there is no waiting worker, return directly
-    if (!worker)
-        return;
-    // post SKIP_WAITING message to the waiting worker
-    const channel = new MessageChannel();
-    worker.postMessage({ type: 'SKIP_WAITING' }, [channel.port2]);
-};

package/lib/index.d.ts

@@ -1,18 +0,0 @@
-import type { Plugin } from '@vuepress/core';
-import type { GenerateSWConfig } from 'workbox-build';
-/**
- * Options for @vuepress/plugin-pwa
- */
-export interface PwaPluginOptions extends Omit<GenerateSWConfig, 'swDest' | 'globDirectory'> {
-    /**
-     * Filename of the generated service worker file
-     *
-     * If you put it into a sub directory, the `scope` of service worker
-     * might be affected
-     *
-     * @default 'service-worker.js'
-     */
-    serviceWorkerFilename?: string;
-}
-export declare const pwaPlugin: Plugin<PwaPluginOptions>;
-export default pwaPlugin;

package/lib/index.js

@@ -1,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.pwaPlugin = void 0;
-const utils_1 = require("@vuepress/utils");
-const assetsExtensions = [
-    // basic
-    'html',
-    'js',
-    'css',
-    // images
-    'png',
-    'jpg',
-    'jpeg',
-    'gif',
-    'svg',
-    // fonts
-    'woff',
-    'woff2',
-    'eot',
-    'tff',
-    'otf',
-];
-const pwaPlugin = ({ serviceWorkerFilename = 'service-worker.js', ...generateSWConfig }) => ({
-    name: '@vuepress/plugin-pwa',
-    clientAppSetupFiles: utils_1.path.resolve(__dirname, './clientAppSetup.js'),
-    define: {
-        __PWA_SW_FILENAME__: serviceWorkerFilename,
-    },
-    async onGenerated(app) {
-        await utils_1.withSpinner('Generating service worker')(async () => {
-            // lazy-load workbox-build
-            const generateSW = require('workbox-build/build/generate-sw');
-            const globDirectory = app.dir.dest();
-            const swDest = app.dir.dest(serviceWorkerFilename);
-            const { warnings } = await generateSW({
-                dontCacheBustURLsMatching: new RegExp(`\\.[0-9a-f]{8}\\.(${assetsExtensions.join('|')})$`),
-                globPatterns: [`**/*.{${assetsExtensions.join(',')}}`],
-                mode: app.env.isDebug ? 'development' : 'production',
-                sourcemap: app.env.isDebug,
-                ...generateSWConfig,
-                // should not be override by user config
-                globDirectory,
-                swDest,
-            });
-            warnings.forEach((warning) => utils_1.logger.warn('[@vuepress/plugin-pwa]', warning));
-        });
-    },
-});
-exports.pwaPlugin = pwaPlugin;
-exports.default = exports.pwaPlugin;