@docusaurus/plugin-pwa 3.3.2 → 3.5.0

package/lib/index.d.ts

@@ -4,8 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference path="../src/plugin-pwa.d.ts" />
 import type { LoadContext, Plugin } from '@docusaurus/types';
 import type { PluginOptions } from '@docusaurus/plugin-pwa';
-export default function pluginPWA(context: LoadContext, options: PluginOptions): Plugin<void>;
+export default function pluginPWA(context: LoadContext, options: PluginOptions): Plugin<void> | null;
 export { validateOptions } from './options';

package/lib/index.js

@@ -7,6 +7,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = void 0;
+exports.default = pluginPWA;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const webpack_1 = tslib_1.__importDefault(require("webpack"));
@@ -14,9 +15,10 @@ const webpackbar_1 = tslib_1.__importDefault(require("webpackbar"));
 const terser_webpack_plugin_1 = tslib_1.__importDefault(require("terser-webpack-plugin"));
 const workbox_build_1 = require("workbox-build");
 const utils_1 = require("@docusaurus/utils");
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_2 = require("@docusaurus/core/lib/webpack/utils");
 const theme_translations_1 = require("@docusaurus/theme-translations");
-const isProd = process.env.NODE_ENV === 'production';
+const PluginName = 'docusaurus-plugin-pwa';
 function getSWBabelLoader() {
     return {
         loader: 'babel-loader',
@@ -38,10 +40,17 @@ function getSWBabelLoader() {
     };
 }
 function pluginPWA(context, options) {
+    if (process.env.NODE_ENV !== 'production') {
+        return null;
+    }
+    if (context.siteConfig.future.experimental_router === 'hash') {
+        logger_1.default.warn(`${PluginName} does not support the Hash Router and will be disabled.`);
+        return null;
+    }
     const { outDir, baseUrl, i18n: { currentLocale }, } = context;
     const { debug, offlineModeActivationStrategies, injectManifestConfig, pwaHead, swCustom, swRegister, } = options;
     return {
-        name: 'docusaurus-plugin-pwa',
+        name: PluginName,
         getThemePath() {
             return '../lib/theme';
         },
@@ -49,7 +58,7 @@ function pluginPWA(context, options) {
             return '../src/theme';
         },
         getClientModules() {
-            return isProd && swRegister ? [swRegister] : [];
+            return swRegister ? [swRegister] : [];
         },
         getDefaultCodeTranslationMessages() {
             return (0, theme_translations_1.readDefaultCodeTranslationMessages)({
@@ -58,9 +67,6 @@ function pluginPWA(context, options) {
             });
         },
         configureWebpack(config) {
-            if (!isProd) {
-                return {};
-            }
             return {
                 plugins: [
                     new webpack_1.default.EnvironmentPlugin({
@@ -73,30 +79,25 @@ function pluginPWA(context, options) {
         },
         injectHtmlTags() {
             const headTags = [];
-            if (isProd) {
-                pwaHead.forEach(({ tagName, ...attributes }) => {
-                    ['href', 'content'].forEach((attribute) => {
-                        const attributeValue = attributes[attribute];
-                        if (!attributeValue) {
-                            return;
-                        }
-                        const attributePath = !!path_1.default.extname(attributeValue) && attributeValue;
-                        if (attributePath && !attributePath.startsWith(baseUrl)) {
-                            attributes[attribute] = (0, utils_1.normalizeUrl)([baseUrl, attributeValue]);
-                        }
-                    });
-                    return headTags.push({
-                        tagName,
-                        attributes,
-                    });
+            pwaHead.forEach(({ tagName, ...attributes }) => {
+                ['href', 'content'].forEach((attribute) => {
+                    const attributeValue = attributes[attribute];
+                    if (!attributeValue) {
+                        return;
+                    }
+                    const attributePath = !!path_1.default.extname(attributeValue) && attributeValue;
+                    if (attributePath && !attributePath.startsWith(baseUrl)) {
+                        attributes[attribute] = (0, utils_1.normalizeUrl)([baseUrl, attributeValue]);
+                    }
+                });
+                return headTags.push({
+                    tagName,
+                    attributes,
                 });
-            }
+            });
             return { headTags };
         },
         async postBuild(props) {
-            if (!isProd) {
-                return;
-            }
             const swSourceFileTest = /\.m?js$/;
             const swWebpackConfig = {
                 entry: require.resolve('./sw.js'),
@@ -159,6 +160,5 @@ function pluginPWA(context, options) {
         },
     };
 }
-exports.default = pluginPWA;
 var options_1 = require("./options");
 Object.defineProperty(exports, "validateOptions", { enumerable: true, get: function () { return options_1.validateOptions; } });

package/lib/options.d.ts

@@ -4,7 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference path="../src/plugin-pwa.d.ts" />
 import type { OptionValidationContext } from '@docusaurus/types';
 import type { PluginOptions } from '@docusaurus/plugin-pwa';
 export declare function validateOptions({ validate, options, }: OptionValidationContext<PluginOptions, PluginOptions>): PluginOptions;

package/lib/options.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateOptions = void 0;
+exports.validateOptions = validateOptions;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const DEFAULT_OPTIONS = {
     debug: false,
@@ -43,4 +43,3 @@ const optionsSchema = utils_validation_1.Joi.object({
 function validateOptions({ validate, options, }) {
     return validate(optionsSchema, options);
 }
-exports.validateOptions = validateOptions;

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.
  */
-/// <reference path="../src/plugin-pwa.d.ts" />
 import type { Props } from '@theme/PwaReloadPopup';
 export declare function renderReloadPopup(props: Props): Promise<void>;

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

@@ -4,7 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference path="../../../src/plugin-pwa.d.ts" />
-/// <reference types="react" />
 import type { Props } from '@theme/PwaReloadPopup';
 export default function PwaReloadPopup({ onReload }: Props): JSX.Element | false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-pwa",
-  "version": "3.3.2",
+  "version": "3.5.0",
   "description": "Docusaurus Plugin to add PWA support.",
   "main": "lib/index.js",
   "types": "src/plugin-pwa.d.ts",
@@ -22,12 +22,13 @@
   "dependencies": {
     "@babel/core": "^7.23.3",
     "@babel/preset-env": "^7.23.3",
-    "@docusaurus/core": "3.3.2",
-    "@docusaurus/theme-common": "3.3.2",
-    "@docusaurus/theme-translations": "3.3.2",
-    "@docusaurus/types": "3.3.2",
-    "@docusaurus/utils": "3.3.2",
-    "@docusaurus/utils-validation": "3.3.2",
+    "@docusaurus/core": "3.5.0",
+    "@docusaurus/logger": "3.5.0",
+    "@docusaurus/theme-common": "3.5.0",
+    "@docusaurus/theme-translations": "3.5.0",
+    "@docusaurus/types": "3.5.0",
+    "@docusaurus/utils": "3.5.0",
+    "@docusaurus/utils-validation": "3.5.0",
     "babel-loader": "^9.1.3",
     "clsx": "^2.0.0",
     "core-js": "^3.31.1",
@@ -41,7 +42,7 @@
     "workbox-window": "^7.0.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.3.2",
+    "@docusaurus/module-type-aliases": "3.5.0",
     "fs-extra": "^11.1.0"
   },
   "peerDependencies": {
@@ -51,5 +52,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "bc638d674bfbde1e254ef306697f47e764b5e107"
+  "gitHead": "cb5829f3c34b26d798b869e38ee25073488140bd"
 }

package/src/index.ts

@@ -11,12 +11,13 @@ import WebpackBar from 'webpackbar';
 import Terser from 'terser-webpack-plugin';
 import {injectManifest} from 'workbox-build';
 import {normalizeUrl} from '@docusaurus/utils';
+import logger from '@docusaurus/logger';
 import {compile} from '@docusaurus/core/lib/webpack/utils';
 import {readDefaultCodeTranslationMessages} from '@docusaurus/theme-translations';
 import type {HtmlTags, LoadContext, Plugin} from '@docusaurus/types';
 import type {PluginOptions} from '@docusaurus/plugin-pwa';
 
-const isProd = process.env.NODE_ENV === 'production';
+const PluginName = 'docusaurus-plugin-pwa';
 
 function getSWBabelLoader() {
   return {
@@ -42,7 +43,17 @@ function getSWBabelLoader() {
 export default function pluginPWA(
   context: LoadContext,
   options: PluginOptions,
-): Plugin<void> {
+): Plugin<void> | null {
+  if (process.env.NODE_ENV !== 'production') {
+    return null;
+  }
+  if (context.siteConfig.future.experimental_router === 'hash') {
+    logger.warn(
+      `${PluginName} does not support the Hash Router and will be disabled.`,
+    );
+    return null;
+  }
+
   const {
     outDir,
     baseUrl,
@@ -58,7 +69,7 @@ export default function pluginPWA(
   } = options;
 
   return {
-    name: 'docusaurus-plugin-pwa',
+    name: PluginName,
 
     getThemePath() {
       return '../lib/theme';
@@ -68,7 +79,7 @@ export default function pluginPWA(
     },
 
     getClientModules() {
-      return isProd && swRegister ? [swRegister] : [];
+      return swRegister ? [swRegister] : [];
     },
 
     getDefaultCodeTranslationMessages() {
@@ -79,10 +90,6 @@ export default function pluginPWA(
     },
 
     configureWebpack(config) {
-      if (!isProd) {
-        return {};
-      }
-
       return {
         plugins: [
           new webpack.EnvironmentPlugin({
@@ -100,37 +107,31 @@ export default function pluginPWA(
 
     injectHtmlTags() {
       const headTags: HtmlTags = [];
-      if (isProd) {
-        pwaHead.forEach(({tagName, ...attributes}) => {
-          (['href', 'content'] as const).forEach((attribute) => {
-            const attributeValue = attributes[attribute];
-
-            if (!attributeValue) {
-              return;
-            }
-
-            const attributePath =
-              !!path.extname(attributeValue) && attributeValue;
-
-            if (attributePath && !attributePath.startsWith(baseUrl)) {
-              attributes[attribute] = normalizeUrl([baseUrl, attributeValue]);
-            }
-          });
-
-          return headTags.push({
-            tagName,
-            attributes,
-          });
+      pwaHead.forEach(({tagName, ...attributes}) => {
+        (['href', 'content'] as const).forEach((attribute) => {
+          const attributeValue = attributes[attribute];
+
+          if (!attributeValue) {
+            return;
+          }
+
+          const attributePath =
+            !!path.extname(attributeValue) && attributeValue;
+
+          if (attributePath && !attributePath.startsWith(baseUrl)) {
+            attributes[attribute] = normalizeUrl([baseUrl, attributeValue]);
+          }
         });
-      }
+
+        return headTags.push({
+          tagName,
+          attributes,
+        });
+      });
       return {headTags};
     },
 
     async postBuild(props) {
-      if (!isProd) {
-        return;
-      }
-
       const swSourceFileTest = /\.m?js$/;
 
       const swWebpackConfig: Configuration = {