@vuepress/plugin-pwa 2.0.0-rc.47 → 2.0.0-rc.52

package/lib/node/prepareConfigFile.js

@@ -1,48 +0,0 @@
-import { getDirname, path } from 'vuepress/utils';
-const __dirname = getDirname(import.meta.url);
-export const prepareConfigFile = (app, options) => {
-    let configImport = '';
-    const rootComponents = [];
-    if (options.showInstall) {
-        configImport += `\
-import { PwaInstall as _PwaInstall } from "${path.join(__dirname, '../client/components/PwaInstall.js')}";
-`;
-        rootComponents.push('PwaInstall');
-    }
-    if (options.update === 'hint') {
-        configImport += `\
-import { PwaFoundPopup as _PwaFoundPopup } from "${options.foundComponent ||
-            path.join(__dirname, '../client/components/PwaFoundPopup.js')}";
-`;
-        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')}";
-`;
-        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 { setupViewPoint } from "${path.join(__dirname, '../client/composables/setupViewPoint.js')}";
-${configImport}
-import "${path.join(__dirname, '../client/styles/vars.css')}";
-
-const locales = __PWA_LOCALES__;
-
-${rootComponents.map((item) => `const ${item} = () => h(_${item}, { locales })`).join('\n')}
-
-export default defineClientConfig({
-  setup: () => {
-    setupPwa(__SW_PATH__, __SW_FORCE_UPDATE__);
-    setupViewPoint();
-  },
-  rootComponents: [
-${rootComponents.map((item) => `    ${item},`).join('\n')}
-  ],
-});
-`);
-};

package/lib/node/pwaPlugin.d.ts

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

package/lib/node/pwaPlugin.js

@@ -1,52 +0,0 @@
-import { addViteOptimizeDepsExclude, addViteSsrNoExternal, customizeDevServer, getLocaleConfig, } from '@vuepress/helper';
-import { generateManifest } from './generateManifest.js';
-import { generateServiceWorker } from './generateServiceWorker.js';
-import { getManifest } from './getManifest.js';
-import { appendBase } from './helper.js';
-import { injectLinksToHead } from './injectLinksToHead.js';
-import { pwaLocales } from './locales.js';
-import { PLUGIN_NAME, logger } from './logger.js';
-import { prepareConfigFile } from './prepareConfigFile.js';
-export const pwaPlugin = (options = {}) => (app) => {
-    if (app.env.isDebug)
-        logger.info('Options:', options);
-    const { base, shouldPrefetch = true } = app.options;
-    if (options.appendBase)
-        appendBase(base, options);
-    if (shouldPrefetch === true)
-        logger.warn('The plugin will register service worker to handle assets, so we recommend you to set "shouldPrefetch: false" in VuePress config file.');
-    app.options.head = injectLinksToHead(options, base, app.options.head);
-    return {
-        name: PLUGIN_NAME,
-        define: () => ({
-            __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',
-        }),
-        extendsBundlerOptions: (bundlerOptions) => {
-            addViteOptimizeDepsExclude(bundlerOptions, app, [
-                'mitt',
-                'register-service-worker',
-            ]);
-            addViteSsrNoExternal(bundlerOptions, app, '@vuepress/helper');
-            customizeDevServer(bundlerOptions, app, {
-                path: '/manifest.webmanifest',
-                response: async (_, response) => {
-                    response.setHeader('Content-Type', 'application/manifest+json');
-                    return JSON.stringify(await getManifest(app, options));
-                },
-                errMsg: 'Unexpected manifest generation error',
-            });
-        },
-        onGenerated: async () => {
-            await generateManifest(app, options);
-            await generateServiceWorker(app, options);
-        },
-        clientConfigFile: () => prepareConfigFile(app, options),
-    };
-};

package/lib/shared/index.d.ts

@@ -1,2 +0,0 @@
-export * from './locales.js';
-export * from './manifest.js';

package/lib/shared/index.js

@@ -1,2 +0,0 @@
-export * from './locales.js';
-export * from './manifest.js';

package/lib/shared/locales.js

@@ -1 +0,0 @@
-export {};

package/lib/shared/manifest.d.ts

@@ -1,129 +0,0 @@
-/**
- * @see https://www.w3.org/TR/mediaqueries-5/#display-mode
- */
-export type DisplayMode = 'browser' | 'fullscreen' | 'minimal-ui' | 'standalone';
-/**
- * @see https://github.com/w3c/manifest/wiki/Categories
- */
-export type ManifestCategory = 'books' | 'business' | 'education' | 'entertainment' | 'finance' | 'fitness' | 'food' | 'games' | 'government' | 'health' | 'kids' | 'lifestyle' | 'magazines' | 'medical' | 'music' | 'navigation' | 'news' | 'personalization' | 'photo' | 'politics' | 'productivity' | 'security' | 'shopping' | 'social' | 'sports' | 'travel' | 'utilities' | 'weather';
-/**
- * @see https://www.w3.org/TR/screen-orientation/#dom-orientationlocktype
- */
-export type OrientationLockType = 'any' | 'landscape-primary' | 'landscape-secondary' | 'landscape' | 'natural' | 'portrait-primary' | 'portrait-secondary' | 'portrait';
-/**
- * @see https://www.w3.org/TR/appmanifest/#manifest-image-resources
- */
-export interface ManifestImageResource {
-    src: string;
-    sizes: string;
-    type?: string;
-}
-export interface ManifestIcon extends ManifestImageResource {
-    purpose?: 'any' | 'maskable' | 'monochrome';
-}
-/**
- * @see https://www.w3.org/TR/appmanifest/#external-application-resource
- */
-export interface ManifestExternalApplicationResource {
-    /**
-     * @see https://github.com/w3c/manifest/wiki/Platforms
-     */
-    platform: 'amazon' | 'chrome_web_store' | 'chromeos_play' | 'f-droid' | 'itunes' | 'play' | 'webapp' | 'windows';
-    url: string;
-    id?: string;
-    min_version?: string;
-    fingerprints?: {
-        type: string;
-        value: string;
-    }[];
-}
-/**
- * @see https://www.w3.org/TR/appmanifest/#shortcut-items
- */
-export interface ManifestShortCutItem {
-    name: string;
-    url: string;
-    short_name?: string;
-    description?: string;
-    icons?: ManifestIcon[];
-}
-/**
- * @see https://www.w3.org/TR/appmanifest/
- */
-export interface AppManifest extends Record<string, unknown> {
-    /**
-     * @see https://www.w3.org/TR/appmanifest/#name-member
-     *
-     * The name of the web application as it is usually displayed to the user
-     */
-    name?: string;
-    /**
-     * @see https://www.w3.org/TR/appmanifest/#short_name-member
-     *
-     * A short version of the name of the web application
-     */
-    short_name?: string;
-    /**
-     * @see https://www.w3.org/TR/appmanifest/#dfn-background_color
-     *
-     * The expected background color of the web application
-     */
-    background_color?: string;
-    /**
-     * @see https://www.w3.org/TR/appmanifest/#dir-member
-     *
-     * The base direction for the localizable members of the manifest.
-     */
-    dir?: 'auto' | 'ltr' | 'rtl';
-    /**
-     * @see https://www.w3.org/TR/appmanifest/#lang-member
-     *
-     * specifies the primary language for the values of the manifest's localizable members
-     */
-    lang?: string;
-    /**
-     * @see https://www.w3.org/TR/appmanifest/#dfn-display
-     *
-     * The developer's preferred display mode for the web application
-     */
-    display?: DisplayMode;
-    icons?: ManifestIcon[];
-    /**
-     * @see https://www.w3.org/TR/appmanifest/#orientation-member
-     *
-     * Serves as the default screen orientation for all top-level browsing contexts of the web application
-     */
-    orientation?: OrientationLockType;
-    /**
-     * @see https://www.w3.org/TR/appmanifest/#scope-member
-     *
-     * The navigation scope of this web application's application context.
-     */
-    scope?: string;
-    /**
-     * @see https://www.w3.org/TR/appmanifest/#start_url-member
-     *
-     * Start URL
-     */
-    start_url?: string;
-    /**
-     * @see https://www.w3.org/TR/appmanifest/#id-member
-     *
-     * Identity for the application
-     */
-    id?: string;
-    /**
-     * @see https://www.w3.org/TR/appmanifest/#theme_color-member
-     *
-     * Default theme color for an application context
-     */
-    theme_color?: string;
-    shortcuts?: ManifestShortCutItem[];
-    prefer_related_applications?: boolean;
-    related_applications?: ManifestExternalApplicationResource[];
-    description?: string;
-    categories?: ManifestCategory[];
-    screenshots?: ManifestImageResource[];
-    iarc_rating_id?: string;
-    features?: string[];
-}

package/lib/shared/manifest.js

@@ -1 +0,0 @@
-export {};