@docusaurus/plugin-pwa 2.0.0-beta.15 → 2.0.0-beta.16

package/lib/index.d.ts

@@ -6,5 +6,5 @@
  */
 import type { LoadContext, Plugin } from '@docusaurus/types';
 import type { PluginOptions } from '@docusaurus/plugin-pwa';
-export default function (context: LoadContext, options: PluginOptions): Plugin<void>;
+export default function pluginPWA(context: LoadContext, options: PluginOptions): Plugin<void>;
 export { validateOptions } from './options';

package/lib/index.js

@@ -34,21 +34,19 @@ function getSWBabelLoader() {
                     },
                 ],
             ],
-            plugins: [
-                require.resolve('@babel/plugin-proposal-object-rest-spread'),
-                require.resolve('@babel/plugin-proposal-optional-chaining'),
-                require.resolve('@babel/plugin-proposal-nullish-coalescing-operator'),
-            ],
         },
     };
 }
-function default_1(context, options) {
+function pluginPWA(context, options) {
     const { outDir, baseUrl, i18n: { currentLocale }, } = context;
     const { debug, offlineModeActivationStrategies, injectManifestConfig, reloadPopup, pwaHead, swCustom, swRegister, } = options;
     return {
         name: 'docusaurus-plugin-pwa',
         getThemePath() {
-            return path_1.default.resolve(__dirname, './theme');
+            return path_1.default.resolve(__dirname, '../lib/theme');
+        },
+        getTypeScriptThemePath() {
+            return path_1.default.resolve(__dirname, '../src/theme');
         },
         getClientModules() {
             return isProd ? [swRegister] : [];
@@ -137,7 +135,7 @@ function default_1(context, options) {
                     rules: [
                         {
                             test: swSourceFileTest,
-                            exclude: /(node_modules)/,
+                            exclude: /node_modules/,
                             use: getSWBabelLoader(),
                         },
                     ],
@@ -163,6 +161,6 @@ function default_1(context, options) {
         },
     };
 }
-exports.default = default_1;
+exports.default = pluginPWA;
 var options_1 = require("./options");
 Object.defineProperty(exports, "validateOptions", { enumerable: true, get: function () { return options_1.validateOptions; } });

package/lib/registerSw.js

@@ -219,8 +219,8 @@ async function registerSW() {
   }
 }
 
-// TODO these events still works in chrome but have been removed from the spec in 2019!
-// See https://github.com/w3c/manifest/pull/836
+// TODO these events still works in chrome but have been removed from the spec
+// in 2019! See https://github.com/w3c/manifest/pull/836
 function addLegacyAppInstalledEventsListeners() {
   if (typeof window !== 'undefined') {
     if (debug) {
@@ -248,7 +248,8 @@ function addLegacyAppInstalledEventsListeners() {
       await clearRegistrations();
     });
 
-    // TODO this event still works in chrome but has been removed from the spec in 2019!!!
+    // TODO this event still works in chrome but has been removed from the spec
+    // in 2019!!!
     window.addEventListener('beforeinstallprompt', async (event) => {
       if (debug) {
         console.log(
@@ -256,7 +257,8 @@ function addLegacyAppInstalledEventsListeners() {
           event,
         );
       }
-      // TODO instead of default browser install UI, show custom docusaurus prompt?
+      // TODO instead of default browser install UI, show custom docusaurus
+      // prompt?
       // event.preventDefault();
       if (debug) {
         console.log(
@@ -273,7 +275,7 @@ function addLegacyAppInstalledEventsListeners() {
         }
         // After uninstalling the app, if the user doesn't clear all data, then
         // the previous service worker will continue serving cached files. We
-        // need to clear registrations and reload, otherwise the popup will show.
+        // need to clear registrations and reload, otherwise the popup shows.
         await clearRegistrations();
       }
     });

package/lib/sw.js

@@ -18,10 +18,10 @@ function parseSwParams() {
   return params;
 }
 
-// doc advise against dynamic imports in SW
+// doc advises against dynamic imports in SW
 // https://developers.google.com/web/tools/workbox/guides/using-bundlers#code_splitting_and_dynamic_imports
 // https://twitter.com/sebastienlorber/status/1280155204575518720
-// but I think it's working fine as it's inlined by webpack, need to double check?
+// but looks it's working fine as it's inlined by webpack, need to double check
 async function runSWCustomCode(params) {
   if (process.env.PWA_SW_CUSTOM) {
     const customSW = await import(process.env.PWA_SW_CUSTOM);
@@ -70,6 +70,7 @@ function getPossibleURLs(url) {
 (async () => {
   const params = parseSwParams();
 
+  // eslint-disable-next-line no-underscore-dangle
   const precacheManifest = self.__WB_MANIFEST;
   const controller = new PrecacheController({
     fallbackToNetwork: true, // safer to turn this true?

package/lib/theme/PwaReloadPopup/index.d.ts

@@ -5,6 +5,5 @@
  * LICENSE file in the root directory of this source tree.
  */
 /// <reference types="react" />
-import type { PwaReloadPopupProps } from '@theme/PwaReloadPopup';
-declare function PwaReloadPopup({ onReload }: PwaReloadPopupProps): JSX.Element | false;
-export default PwaReloadPopup;
+import type { Props } from '@theme/PwaReloadPopup';
+export default function PwaReloadPopup({ onReload }: Props): JSX.Element | false;

package/lib/theme/PwaReloadPopup/index.js

@@ -8,7 +8,7 @@ import React, { useState } from 'react';
 import clsx from 'clsx';
 import Translate, { translate } from '@docusaurus/Translate';
 import styles from './styles.module.css';
-function PwaReloadPopup({ onReload }) {
+export default function PwaReloadPopup({ onReload }) {
     const [isVisible, setIsVisible] = useState(true);
     return (isVisible && (<div className={clsx('alert', 'alert--secondary', styles.popup)}>
         <p>
@@ -36,4 +36,3 @@ function PwaReloadPopup({ onReload }) {
         </div>
       </div>));
 }
-export default PwaReloadPopup;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-pwa",
-  "version": "2.0.0-beta.15",
+  "version": "2.0.0-beta.16",
   "description": "Docusaurus Plugin to add PWA support.",
   "main": "lib/index.js",
   "types": "src/plugin-pwa.d.ts",
@@ -20,33 +20,31 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.16.0",
-    "@babel/plugin-proposal-optional-chaining": "^7.16.0",
-    "@babel/preset-env": "^7.16.4",
-    "@docusaurus/core": "2.0.0-beta.15",
-    "@docusaurus/theme-common": "2.0.0-beta.15",
-    "@docusaurus/theme-translations": "2.0.0-beta.15",
-    "@docusaurus/utils": "2.0.0-beta.15",
-    "@docusaurus/utils-validation": "2.0.0-beta.15",
-    "babel-loader": "^8.2.2",
+    "@babel/core": "^7.17.5",
+    "@babel/preset-env": "^7.16.11",
+    "@docusaurus/core": "2.0.0-beta.16",
+    "@docusaurus/theme-common": "2.0.0-beta.16",
+    "@docusaurus/theme-translations": "2.0.0-beta.16",
+    "@docusaurus/utils": "2.0.0-beta.16",
+    "@docusaurus/utils-validation": "2.0.0-beta.16",
+    "babel-loader": "^8.2.3",
     "clsx": "^1.1.1",
-    "core-js": "^3.18.0",
-    "terser-webpack-plugin": "^5.2.4",
+    "core-js": "^3.21.0",
+    "terser-webpack-plugin": "^5.3.1",
     "tslib": "^2.3.1",
-    "webpack": "^5.61.0",
-    "webpack-merge": "^5.7.3",
-    "workbox-build": "^6.1.1",
-    "workbox-precaching": "^6.1.1",
-    "workbox-window": "^6.1.1"
+    "webpack": "^5.69.1",
+    "webpack-merge": "^5.8.0",
+    "workbox-build": "^6.5.0",
+    "workbox-precaching": "^6.5.0",
+    "workbox-window": "^6.5.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.15",
-    "fs-extra": "^10.0.0"
+    "@docusaurus/module-type-aliases": "2.0.0-beta.16",
+    "fs-extra": "^10.0.1"
   },
   "peerDependencies": {
-    "@babel/core": "^7.0.0",
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
   },
-  "gitHead": "6cfad16436c07d8d11e5c2e1486dc59afd483e33"
+  "gitHead": "eb43c4d4f95a4fb97dc9bb9dc615413e0dc2e1e7"
 }

package/src/index.ts

@@ -37,16 +37,11 @@ function getSWBabelLoader() {
           },
         ],
       ],
-      plugins: [
-        require.resolve('@babel/plugin-proposal-object-rest-spread'),
-        require.resolve('@babel/plugin-proposal-optional-chaining'),
-        require.resolve('@babel/plugin-proposal-nullish-coalescing-operator'),
-      ],
     },
   };
 }
 
-export default function (
+export default function pluginPWA(
   context: LoadContext,
   options: PluginOptions,
 ): Plugin<void> {
@@ -69,7 +64,10 @@ export default function (
     name: 'docusaurus-plugin-pwa',
 
     getThemePath() {
-      return path.resolve(__dirname, './theme');
+      return path.resolve(__dirname, '../lib/theme');
+    },
+    getTypeScriptThemePath() {
+      return path.resolve(__dirname, '../src/theme');
     },
 
     getClientModules() {
@@ -174,7 +172,7 @@ export default function (
           rules: [
             {
               test: swSourceFileTest,
-              exclude: /(node_modules)/,
+              exclude: /node_modules/,
               use: getSWBabelLoader(),
             },
           ],

package/src/plugin-pwa.d.ts

@@ -25,10 +25,8 @@ declare module '@docusaurus/plugin-pwa' {
 }
 
 declare module '@theme/PwaReloadPopup' {
-  export type PwaReloadPopupProps = {
+  export interface Props {
     readonly onReload: () => void;
-  };
-
-  const PwaReloadPopup: (props: PwaReloadPopupProps) => JSX.Element;
-  export default PwaReloadPopup;
+  }
+  export default function PwaReloadPopup(props: Props): JSX.Element;
 }

package/src/registerSw.js

@@ -219,8 +219,8 @@ async function registerSW() {
   }
 }
 
-// TODO these events still works in chrome but have been removed from the spec in 2019!
-// See https://github.com/w3c/manifest/pull/836
+// TODO these events still works in chrome but have been removed from the spec
+// in 2019! See https://github.com/w3c/manifest/pull/836
 function addLegacyAppInstalledEventsListeners() {
   if (typeof window !== 'undefined') {
     if (debug) {
@@ -248,7 +248,8 @@ function addLegacyAppInstalledEventsListeners() {
       await clearRegistrations();
     });
 
-    // TODO this event still works in chrome but has been removed from the spec in 2019!!!
+    // TODO this event still works in chrome but has been removed from the spec
+    // in 2019!!!
     window.addEventListener('beforeinstallprompt', async (event) => {
       if (debug) {
         console.log(
@@ -256,7 +257,8 @@ function addLegacyAppInstalledEventsListeners() {
           event,
         );
       }
-      // TODO instead of default browser install UI, show custom docusaurus prompt?
+      // TODO instead of default browser install UI, show custom docusaurus
+      // prompt?
       // event.preventDefault();
       if (debug) {
         console.log(
@@ -273,7 +275,7 @@ function addLegacyAppInstalledEventsListeners() {
         }
         // After uninstalling the app, if the user doesn't clear all data, then
         // the previous service worker will continue serving cached files. We
-        // need to clear registrations and reload, otherwise the popup will show.
+        // need to clear registrations and reload, otherwise the popup shows.
         await clearRegistrations();
       }
     });

package/src/sw.js

@@ -18,10 +18,10 @@ function parseSwParams() {
   return params;
 }
 
-// doc advise against dynamic imports in SW
+// doc advises against dynamic imports in SW
 // https://developers.google.com/web/tools/workbox/guides/using-bundlers#code_splitting_and_dynamic_imports
 // https://twitter.com/sebastienlorber/status/1280155204575518720
-// but I think it's working fine as it's inlined by webpack, need to double check?
+// but looks it's working fine as it's inlined by webpack, need to double check
 async function runSWCustomCode(params) {
   if (process.env.PWA_SW_CUSTOM) {
     const customSW = await import(process.env.PWA_SW_CUSTOM);
@@ -70,6 +70,7 @@ function getPossibleURLs(url) {
 (async () => {
   const params = parseSwParams();
 
+  // eslint-disable-next-line no-underscore-dangle
   const precacheManifest = self.__WB_MANIFEST;
   const controller = new PrecacheController({
     fallbackToNetwork: true, // safer to turn this true?

package/src/theme/PwaReloadPopup/index.tsx

@@ -9,11 +9,11 @@ import React, {useState} from 'react';
 import clsx from 'clsx';
 import Translate, {translate} from '@docusaurus/Translate';
 
-import type {PwaReloadPopupProps} from '@theme/PwaReloadPopup';
+import type {Props} from '@theme/PwaReloadPopup';
 
 import styles from './styles.module.css';
 
-function PwaReloadPopup({onReload}: PwaReloadPopupProps): JSX.Element | false {
+export default function PwaReloadPopup({onReload}: Props): JSX.Element | false {
   const [isVisible, setIsVisible] = useState(true);
 
   return (
@@ -58,5 +58,3 @@ function PwaReloadPopup({onReload}: PwaReloadPopupProps): JSX.Element | false {
     )
   );
 }
-
-export default PwaReloadPopup;