@docusaurus/plugin-pwa 0.0.0-5065 → 0.0.0-5068

package/lib/index.js

@@ -39,7 +39,7 @@ function getSWBabelLoader() {
 }
 function pluginPWA(context, options) {
     const { outDir, baseUrl, i18n: { currentLocale }, } = context;
-    const { debug, offlineModeActivationStrategies, injectManifestConfig, reloadPopup, pwaHead, swCustom, swRegister, } = options;
+    const { debug, offlineModeActivationStrategies, injectManifestConfig, pwaHead, swCustom, swRegister, } = options;
     return {
         name: 'docusaurus-plugin-pwa',
         getThemePath() {
@@ -67,7 +67,6 @@ function pluginPWA(context, options) {
                         PWA_DEBUG: debug,
                         PWA_SERVICE_WORKER_URL: path_1.default.posix.resolve(`${config.output?.publicPath || '/'}`, 'sw.js'),
                         PWA_OFFLINE_MODE_ACTIVATION_STRATEGIES: offlineModeActivationStrategies,
-                        PWA_RELOAD_POPUP: reloadPopup,
                     }),
                 ],
             };

package/lib/options.js

@@ -19,7 +19,6 @@ const DEFAULT_OPTIONS = {
     pwaHead: [],
     swCustom: undefined,
     swRegister: './registerSw.js',
-    reloadPopup: '@theme/PwaReloadPopup',
 };
 const optionsSchema = utils_validation_1.Joi.object({
     debug: utils_validation_1.Joi.bool().default(DEFAULT_OPTIONS.debug),
@@ -36,9 +35,10 @@ const optionsSchema = utils_validation_1.Joi.object({
     swRegister: utils_validation_1.Joi.alternatives()
         .try(utils_validation_1.Joi.string(), utils_validation_1.Joi.bool().valid(false))
         .default(DEFAULT_OPTIONS.swRegister),
-    reloadPopup: utils_validation_1.Joi.alternatives()
-        .try(utils_validation_1.Joi.string(), utils_validation_1.Joi.bool().valid(false))
-        .default(DEFAULT_OPTIONS.reloadPopup),
+    // @ts-expect-error: forbidden
+    reloadPopup: utils_validation_1.Joi.any().forbidden().messages({
+        'any.unknown': 'The reloadPopup option is removed in favor of swizzling. See https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-pwa#customizing-reload-popup for how to customize the reload popup using swizzling.',
+    }),
 });
 function validateOptions({ validate, options, }) {
     return validate(optionsSchema, options);

package/lib/registerSw.js

@@ -8,7 +8,6 @@ import { createStorageSlot } from '@docusaurus/theme-common';
 // First: read the env variables (provided by Webpack)
 /* eslint-disable prefer-destructuring */
 const PWA_SERVICE_WORKER_URL = process.env.PWA_SERVICE_WORKER_URL;
-const PWA_RELOAD_POPUP = process.env.PWA_RELOAD_POPUP;
 const PWA_OFFLINE_MODE_ACTIVATION_STRATEGIES = process.env
     .PWA_OFFLINE_MODE_ACTIVATION_STRATEGIES;
 const PWA_DEBUG = process.env.PWA_DEBUG;
@@ -119,7 +118,7 @@ async function registerSW() {
         if (!offlineMode) {
             sendSkipWaiting();
         }
-        else if (PWA_RELOAD_POPUP) {
+        else {
             const renderReloadPopup = (await import('./renderReloadPopup')).default;
             await renderReloadPopup({
                 onReload() {

package/lib/renderReloadPopup.d.ts

@@ -4,6 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-export default function renderReloadPopup(props: {
-    onReload: () => void;
-}): Promise<void>;
+import type { Props } from '@theme/PwaReloadPopup';
+export default function renderReloadPopup(props: Props): Promise<void>;

package/lib/renderReloadPopup.js

@@ -16,6 +16,6 @@ const createContainer = () => {
 };
 export default async function renderReloadPopup(props) {
     const container = getContainer() || createContainer();
-    const { default: ReloadPopup } = await import(process.env.PWA_RELOAD_POPUP);
+    const ReloadPopup = (await import('@theme/PwaReloadPopup')).default;
     ReactDOM.render(<ReloadPopup {...props}/>, container);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-pwa",
-  "version": "0.0.0-5065",
+  "version": "0.0.0-5068",
   "description": "Docusaurus Plugin to add PWA support.",
   "main": "lib/index.js",
   "types": "src/plugin-pwa.d.ts",
@@ -20,16 +20,16 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@babel/core": "^7.18.0",
-    "@babel/preset-env": "^7.18.0",
-    "@docusaurus/core": "0.0.0-5065",
-    "@docusaurus/theme-common": "0.0.0-5065",
-    "@docusaurus/theme-translations": "0.0.0-5065",
-    "@docusaurus/utils": "0.0.0-5065",
-    "@docusaurus/utils-validation": "0.0.0-5065",
+    "@babel/core": "^7.18.2",
+    "@babel/preset-env": "^7.18.2",
+    "@docusaurus/core": "0.0.0-5068",
+    "@docusaurus/theme-common": "0.0.0-5068",
+    "@docusaurus/theme-translations": "0.0.0-5068",
+    "@docusaurus/utils": "0.0.0-5068",
+    "@docusaurus/utils-validation": "0.0.0-5068",
     "babel-loader": "^8.2.5",
     "clsx": "^1.1.1",
-    "core-js": "^3.22.5",
+    "core-js": "^3.22.7",
     "terser-webpack-plugin": "^5.3.1",
     "tslib": "^2.4.0",
     "webpack": "^5.72.1",
@@ -39,7 +39,7 @@
     "workbox-window": "^6.5.3"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-5065",
+    "@docusaurus/module-type-aliases": "0.0.0-5068",
     "fs-extra": "^10.1.0"
   },
   "peerDependencies": {
@@ -49,5 +49,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "aea52e586d5b585549e65c6fbcd8c1d7c6a21939"
+  "gitHead": "c986274701970d13ec3359b131736b9ee0788213"
 }

package/src/index.ts

@@ -52,7 +52,6 @@ export default function pluginPWA(
     debug,
     offlineModeActivationStrategies,
     injectManifestConfig,
-    reloadPopup,
     pwaHead,
     swCustom,
     swRegister,
@@ -94,7 +93,6 @@ export default function pluginPWA(
             ),
             PWA_OFFLINE_MODE_ACTIVATION_STRATEGIES:
               offlineModeActivationStrategies,
-            PWA_RELOAD_POPUP: reloadPopup,
           }),
         ],
       };

package/src/options.ts

@@ -20,7 +20,6 @@ const DEFAULT_OPTIONS = {
   pwaHead: [],
   swCustom: undefined,
   swRegister: './registerSw.js',
-  reloadPopup: '@theme/PwaReloadPopup',
 };
 
 const optionsSchema = Joi.object<PluginOptions>({
@@ -49,9 +48,11 @@ const optionsSchema = Joi.object<PluginOptions>({
   swRegister: Joi.alternatives()
     .try(Joi.string(), Joi.bool().valid(false))
     .default(DEFAULT_OPTIONS.swRegister),
-  reloadPopup: Joi.alternatives()
-    .try(Joi.string(), Joi.bool().valid(false))
-    .default(DEFAULT_OPTIONS.reloadPopup),
+  // @ts-expect-error: forbidden
+  reloadPopup: Joi.any().forbidden().messages({
+    'any.unknown':
+      'The reloadPopup option is removed in favor of swizzling. See https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-pwa#customizing-reload-popup for how to customize the reload popup using swizzling.',
+  }),
 });
 
 export function validateOptions({

package/src/plugin-pwa.d.ts

@@ -46,16 +46,6 @@ declare module '@docusaurus/plugin-pwa' {
      * @see https://developers.google.com/web/tools/workbox/reference-docs/latest/module-workbox-build#.injectManifest
      */
     injectManifestConfig: InjectManifestOptions;
-    /**
-     * Module path to reload popup component. This popup is rendered when a new
-     * service worker is waiting to be installed, and we suggest a reload to
-     * the user.
-     *
-     * Passing `false` will disable the popup, but this is not recommended:
-     * users won't have a way to get up-to-date content.
-     * @see {@link @theme/PwaReloadPopup}
-     */
-    reloadPopup: string | false;
     /**
      * Array of objects containing `tagName` and key-value pairs for attributes
      * to inject into the `<head>` tag. Technically you can inject any head tag

package/src/registerSw.ts

@@ -10,7 +10,6 @@ import {createStorageSlot} from '@docusaurus/theme-common';
 // First: read the env variables (provided by Webpack)
 /* eslint-disable prefer-destructuring */
 const PWA_SERVICE_WORKER_URL = process.env.PWA_SERVICE_WORKER_URL!;
-const PWA_RELOAD_POPUP = process.env.PWA_RELOAD_POPUP;
 const PWA_OFFLINE_MODE_ACTIVATION_STRATEGIES = process.env
   .PWA_OFFLINE_MODE_ACTIVATION_STRATEGIES as unknown as (keyof typeof OfflineModeActivationStrategiesImplementations)[];
 const PWA_DEBUG = process.env.PWA_DEBUG;
@@ -170,7 +169,7 @@ async function registerSW() {
     // Immediately load new service worker when files aren't cached
     if (!offlineMode) {
       sendSkipWaiting();
-    } else if (PWA_RELOAD_POPUP) {
+    } else {
       const renderReloadPopup = (await import('./renderReloadPopup')).default;
       await renderReloadPopup({
         onReload() {

package/src/renderReloadPopup.tsx

@@ -7,6 +7,7 @@
 
 import React from 'react';
 import ReactDOM from 'react-dom';
+import type {Props} from '@theme/PwaReloadPopup';
 
 const POPUP_CONTAINER_ID = 'pwa-popup-container';
 
@@ -19,10 +20,8 @@ const createContainer = () => {
   return container;
 };
 
-export default async function renderReloadPopup(props: {
-  onReload: () => void;
-}): Promise<void> {
+export default async function renderReloadPopup(props: Props): Promise<void> {
   const container = getContainer() || createContainer();
-  const {default: ReloadPopup} = await import(process.env.PWA_RELOAD_POPUP!);
+  const ReloadPopup = (await import('@theme/PwaReloadPopup')).default;
   ReactDOM.render(<ReloadPopup {...props} />, container);
 }