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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/plugin-pwa",
-  "version": "2.0.0-beta.48",
+  "version": "2.0.0-beta.50-pre",
   "description": "VuePress plugin - progressive web application",
   "keywords": [
     "vuepress-plugin",
@@ -18,19 +18,25 @@
   },
   "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"
+    "./lib"
   ],
   "dependencies": {
-    "@vuepress/client": "2.0.0-beta.48",
-    "@vuepress/core": "2.0.0-beta.48",
-    "@vuepress/utils": "2.0.0-beta.48",
+    "@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.2.36",
-    "workbox-build": "^6.5.3"
+    "vue": "^3.2.37",
+    "workbox-build": "^6.5.4"
   },
   "publishConfig": {
     "access": "public"

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

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

package/lib/client/composables/index.js

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

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

@@ -1,13 +0,0 @@
-import type { Emitter } from 'mitt';
-import type { InjectionKey } from 'vue';
-export declare 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 +0,0 @@
-import { inject } from 'vue';
-export const pwaEventSymbol = Symbol('pwaEvent');
-export const usePwaEvent = () => {
-    const pwaEvent = inject(pwaEventSymbol);
-    if (!pwaEvent) {
-        throw new Error('usePwaEvent() is called without provider.');
-    }
-    return pwaEvent;
-};

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

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

package/lib/client/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/client/config.d.ts

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

package/lib/client/config.js

@@ -1,50 +0,0 @@
-import { defineClientConfig, withBase } from '@vuepress/client';
-import mitt from 'mitt';
-import { onMounted, provide } from 'vue';
-import { pwaEventSymbol } from './composables';
-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 +0,0 @@
-export * from './composables';

package/lib/client/index.js

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

package/lib/node/generateServiceWorker.d.ts

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

package/lib/node/generateServiceWorker.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateServiceWorker = 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 generateServiceWorker = async (app, serviceWorkerFilename, generateSWConfig) => {
-    // lazy-load workbox-build
-    const { generateSW } = await Promise.resolve().then(() => require('workbox-build'));
-    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.generateServiceWorker = generateServiceWorker;

package/lib/node/index.d.ts

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

package/lib/node/index.js

@@ -1,20 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (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;

package/lib/node/pwaPlugin.d.ts

@@ -1,17 +0,0 @@
-import type { Plugin } from '@vuepress/core';
-import type { GenerateSWConfig } from './generateServiceWorker';
-/**
- * Options for @vuepress/plugin-pwa
- */
-export interface PwaPluginOptions extends GenerateSWConfig {
-    /**
-     * 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: ({ serviceWorkerFilename, ...generateSWConfig }?: PwaPluginOptions) => Plugin;

package/lib/node/pwaPlugin.js

@@ -1,22 +0,0 @@
-"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 } = {}) => (app) => {
-    const plugin = {
-        name: '@vuepress/plugin-pwa',
-    };
-    if (app.env.isDev) {
-        return plugin;
-    }
-    return {
-        ...plugin,
-        clientConfigFile: utils_1.path.resolve(__dirname, '../client/config.js'),
-        define: {
-            __PWA_SW_FILENAME__: serviceWorkerFilename,
-        },
-        onGenerated: (app) => (0, utils_1.withSpinner)('Generating service worker')(() => (0, generateServiceWorker_1.generateServiceWorker)(app, serviceWorkerFilename, generateSWConfig)),
-    };
-};
-exports.pwaPlugin = pwaPlugin;