@docusaurus/plugin-pwa 3.5.2 → 3.6.0-canary-6134

package/lib/index.js

@@ -10,13 +10,10 @@ 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"));
-const webpackbar_1 = tslib_1.__importDefault(require("webpackbar"));
-const terser_webpack_plugin_1 = tslib_1.__importDefault(require("terser-webpack-plugin"));
+const bundler_1 = require("@docusaurus/bundler");
 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 PluginName = 'docusaurus-plugin-pwa';
 function getSWBabelLoader() {
@@ -31,7 +28,7 @@ function getSWBabelLoader() {
                     {
                         useBuiltIns: 'entry',
                         corejs: '3',
-                        // See https://twitter.com/jeffposnick/status/1280223070876315649
+                        // See https://x.com/jeffposnick/status/1280223070876315649
                         targets: 'chrome >= 56',
                     },
                 ],
@@ -66,10 +63,10 @@ function pluginPWA(context, options) {
                 name: 'plugin-pwa',
             });
         },
-        configureWebpack(config) {
+        configureWebpack(config, isServer, { currentBundler }) {
             return {
                 plugins: [
-                    new webpack_1.default.EnvironmentPlugin({
+                    new currentBundler.instance.EnvironmentPlugin({
                         PWA_DEBUG: debug,
                         PWA_SERVICE_WORKER_URL: path_1.default.posix.resolve(`${config.output?.publicPath || '/'}`, 'sw.js'),
                         PWA_OFFLINE_MODE_ACTIVATION_STRATEGIES: offlineModeActivationStrategies,
@@ -99,6 +96,9 @@ function pluginPWA(context, options) {
         },
         async postBuild(props) {
             const swSourceFileTest = /\.m?js$/;
+            const ProgressBarPlugin = await (0, bundler_1.getProgressBarPlugin)({
+                currentBundler: props.currentBundler,
+            });
             const swWebpackConfig = {
                 entry: require.resolve('./sw.js'),
                 output: {
@@ -115,18 +115,17 @@ function pluginPWA(context, options) {
                     // See https://developers.google.com/web/tools/workbox/guides/using-bundlers#webpack
                     minimizer: debug
                         ? []
-                        : [
-                            new terser_webpack_plugin_1.default({
-                                test: swSourceFileTest,
-                            }),
-                        ],
+                        : await (0, bundler_1.getMinimizers)({
+                            faster: props.siteConfig.future.experimental_faster,
+                            currentBundler: props.currentBundler,
+                        }),
                 },
                 plugins: [
-                    new webpack_1.default.EnvironmentPlugin({
+                    new props.currentBundler.instance.EnvironmentPlugin({
                         // Fallback value required with Webpack 5
                         PWA_SW_CUSTOM: swCustom ?? '',
                     }),
-                    new webpackbar_1.default({
+                    new ProgressBarPlugin({
                         name: 'Service Worker',
                         color: 'red',
                     }),
@@ -141,7 +140,10 @@ function pluginPWA(context, options) {
                     ],
                 },
             };
-            await (0, utils_2.compile)([swWebpackConfig]);
+            await (0, bundler_1.compile)({
+                configs: [swWebpackConfig],
+                currentBundler: props.currentBundler,
+            });
             const swDest = path_1.default.resolve(props.outDir, 'sw.js');
             await (0, workbox_build_1.injectManifest)({
                 ...injectManifestConfig,

package/lib/renderReloadPopup.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-import ReactDOM from 'react-dom';
+import { createRoot } from 'react-dom/client';
 const POPUP_CONTAINER_ID = 'pwa-popup-container';
 const getContainer = () => document.getElementById(POPUP_CONTAINER_ID);
 const createContainer = () => {
@@ -17,6 +17,7 @@ const createContainer = () => {
 export function renderReloadPopup(props) {
     const container = getContainer() ?? createContainer();
     return import('@theme/PwaReloadPopup').then(({ default: ReloadPopup }) => {
-        ReactDOM.render(<ReloadPopup {...props}/>, container);
+        const root = createRoot(container);
+        root.render(<ReloadPopup {...props}/>);
     });
 }

package/lib/sw.js

@@ -15,7 +15,7 @@ function parseSwParams() {
 }
 // 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
+// https://x.com/sebastienlorber/status/1280155204575518720
 // 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) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-pwa",
-  "version": "3.5.2",
+  "version": "3.6.0-canary-6134",
   "description": "Docusaurus Plugin to add PWA support.",
   "main": "lib/index.js",
   "types": "src/plugin-pwa.d.ts",
@@ -20,29 +20,28 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@babel/core": "^7.23.3",
-    "@babel/preset-env": "^7.23.3",
-    "@docusaurus/core": "3.5.2",
-    "@docusaurus/logger": "3.5.2",
-    "@docusaurus/theme-common": "3.5.2",
-    "@docusaurus/theme-translations": "3.5.2",
-    "@docusaurus/types": "3.5.2",
-    "@docusaurus/utils": "3.5.2",
-    "@docusaurus/utils-validation": "3.5.2",
-    "babel-loader": "^9.1.3",
+    "@babel/core": "^7.25.9",
+    "@babel/preset-env": "^7.25.9",
+    "@docusaurus/bundler": "3.6.0-canary-6134",
+    "@docusaurus/core": "3.6.0-canary-6134",
+    "@docusaurus/logger": "3.6.0-canary-6134",
+    "@docusaurus/theme-common": "3.6.0-canary-6134",
+    "@docusaurus/theme-translations": "3.6.0-canary-6134",
+    "@docusaurus/types": "3.6.0-canary-6134",
+    "@docusaurus/utils": "3.6.0-canary-6134",
+    "@docusaurus/utils-validation": "3.6.0-canary-6134",
+    "babel-loader": "^9.2.1",
     "clsx": "^2.0.0",
     "core-js": "^3.31.1",
-    "terser-webpack-plugin": "^5.3.9",
     "tslib": "^2.6.0",
-    "webpack": "^5.88.1",
+    "webpack": "^5.95.0",
     "webpack-merge": "^5.9.0",
-    "webpackbar": "^5.0.2",
     "workbox-build": "^7.0.0",
     "workbox-precaching": "^7.0.0",
     "workbox-window": "^7.0.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.5.2",
+    "@docusaurus/module-type-aliases": "3.6.0-canary-6134",
     "fs-extra": "^11.1.0"
   },
   "peerDependencies": {
@@ -52,5 +51,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "eeec303dd773774ed5a023884800da0b061f6942"
+  "gitHead": "706c96c3bdd92c7d3ac61447ec49e4bfa6d0526b"
 }

package/src/index.ts

@@ -6,13 +6,15 @@
  */
 
 import path from 'path';
-import webpack, {type Configuration} from 'webpack';
-import WebpackBar from 'webpackbar';
-import Terser from 'terser-webpack-plugin';
+import {type Configuration} from 'webpack';
+import {
+  compile,
+  getProgressBarPlugin,
+  getMinimizers,
+} from '@docusaurus/bundler';
 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';
@@ -31,7 +33,7 @@ function getSWBabelLoader() {
           {
             useBuiltIns: 'entry',
             corejs: '3',
-            // See https://twitter.com/jeffposnick/status/1280223070876315649
+            // See https://x.com/jeffposnick/status/1280223070876315649
             targets: 'chrome >= 56',
           },
         ],
@@ -89,10 +91,10 @@ export default function pluginPWA(
       });
     },
 
-    configureWebpack(config) {
+    configureWebpack(config, isServer, {currentBundler}) {
       return {
         plugins: [
-          new webpack.EnvironmentPlugin({
+          new currentBundler.instance.EnvironmentPlugin({
             PWA_DEBUG: debug,
             PWA_SERVICE_WORKER_URL: path.posix.resolve(
               `${(config.output?.publicPath as string) || '/'}`,
@@ -134,6 +136,10 @@ export default function pluginPWA(
     async postBuild(props) {
       const swSourceFileTest = /\.m?js$/;
 
+      const ProgressBarPlugin = await getProgressBarPlugin({
+        currentBundler: props.currentBundler,
+      });
+
       const swWebpackConfig: Configuration = {
         entry: require.resolve('./sw.js'),
         output: {
@@ -150,18 +156,17 @@ export default function pluginPWA(
           // See https://developers.google.com/web/tools/workbox/guides/using-bundlers#webpack
           minimizer: debug
             ? []
-            : [
-                new Terser({
-                  test: swSourceFileTest,
-                }),
-              ],
+            : await getMinimizers({
+                faster: props.siteConfig.future.experimental_faster,
+                currentBundler: props.currentBundler,
+              }),
         },
         plugins: [
-          new webpack.EnvironmentPlugin({
+          new props.currentBundler.instance.EnvironmentPlugin({
             // Fallback value required with Webpack 5
             PWA_SW_CUSTOM: swCustom ?? '',
           }),
-          new WebpackBar({
+          new ProgressBarPlugin({
             name: 'Service Worker',
             color: 'red',
           }),
@@ -177,7 +182,10 @@ export default function pluginPWA(
         },
       };
 
-      await compile([swWebpackConfig]);
+      await compile({
+        configs: [swWebpackConfig],
+        currentBundler: props.currentBundler,
+      });
 
       const swDest = path.resolve(props.outDir, 'sw.js');
 

package/src/renderReloadPopup.tsx

@@ -6,7 +6,7 @@
  */
 
 import React from 'react';
-import ReactDOM from 'react-dom';
+import {createRoot} from 'react-dom/client';
 import type {Props} from '@theme/PwaReloadPopup';
 
 const POPUP_CONTAINER_ID = 'pwa-popup-container';
@@ -23,6 +23,7 @@ const createContainer = () => {
 export function renderReloadPopup(props: Props): Promise<void> {
   const container = getContainer() ?? createContainer();
   return import('@theme/PwaReloadPopup').then(({default: ReloadPopup}) => {
-    ReactDOM.render(<ReloadPopup {...props} />, container);
+    const root = createRoot(container);
+    root.render(<ReloadPopup {...props} />);
   });
 }

package/src/sw.ts

@@ -20,7 +20,7 @@ function parseSwParams() {
 
 // 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
+// https://x.com/sebastienlorber/status/1280155204575518720
 // but looks it's working fine as it's inlined by webpack, need to double check
 async function runSWCustomCode(params: {offlineMode: boolean; debug: boolean}) {
   if (process.env.PWA_SW_CUSTOM) {

package/src/deps.d.ts

@@ -1,15 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-// TODO incompatible declaration file: https://github.com/unjs/webpackbar/pull/108
-declare module 'webpackbar' {
-  import webpack from 'webpack';
-
-  export default class WebpackBarPlugin extends webpack.ProgressPlugin {
-    constructor(options: {name: string; color?: string});
-  }
-}