@docusaurus/plugin-pwa 2.0.0-beta.17 → 2.0.0-beta.18

package/lib/index.js

@@ -43,13 +43,13 @@ function pluginPWA(context, options) {
     return {
         name: 'docusaurus-plugin-pwa',
         getThemePath() {
-            return path_1.default.resolve(__dirname, '../lib/theme');
+            return '../lib/theme';
         },
         getTypeScriptThemePath() {
-            return path_1.default.resolve(__dirname, '../src/theme');
+            return '../src/theme';
         },
         getClientModules() {
-            return isProd ? [swRegister] : [];
+            return isProd && swRegister ? [swRegister] : [];
         },
         getDefaultCodeTranslationMessages() {
             return (0, theme_translations_1.readDefaultCodeTranslationMessages)({
@@ -100,7 +100,7 @@ function pluginPWA(context, options) {
             }
             const swSourceFileTest = /\.m?js$/;
             const swWebpackConfig = {
-                entry: path_1.default.resolve(__dirname, 'sw.js'),
+                entry: require.resolve('./sw.js'),
                 output: {
                     path: outDir,
                     filename: 'sw.js',
@@ -148,9 +148,8 @@ function pluginPWA(context, options) {
                     '**/*.{js,json,css,html}',
                     '**/*.{png,jpg,jpeg,gif,svg,ico}',
                     '**/*.{woff,woff2,eot,ttf,otf}',
-                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                    // @ts-ignore
-                    ...(workbox_build_1.injectManifest.globPatterns || []),
+                    // @ts-expect-error: internal API?
+                    ...(workbox_build_1.injectManifest.globPatterns ?? []),
                 ],
                 // those attributes are not overrideable
                 swDest,

package/lib/options.d.ts

@@ -4,8 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { Joi } from '@docusaurus/utils-validation';
-import type { ThemeConfig, ValidationResult, OptionValidationContext } from '@docusaurus/types';
+import type { OptionValidationContext } from '@docusaurus/types';
 import type { PluginOptions } from '@docusaurus/plugin-pwa';
-export declare const Schema: Joi.ObjectSchema<any>;
-export declare function validateOptions({ validate, options, }: OptionValidationContext<PluginOptions>): ValidationResult<ThemeConfig>;
+export declare function validateOptions({ validate, options, }: OptionValidationContext<PluginOptions, PluginOptions>): PluginOptions;

package/lib/options.js

@@ -6,9 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateOptions = exports.Schema = void 0;
-const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
+exports.validateOptions = void 0;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const DEFAULT_OPTIONS = {
     debug: false,
@@ -20,10 +18,10 @@ const DEFAULT_OPTIONS = {
     injectManifestConfig: {},
     pwaHead: [],
     swCustom: undefined,
-    swRegister: path_1.default.join(__dirname, 'registerSw.js'),
+    swRegister: './registerSw.js',
     reloadPopup: '@theme/PwaReloadPopup',
 };
-exports.Schema = utils_validation_1.Joi.object({
+const Schema = utils_validation_1.Joi.object({
     debug: utils_validation_1.Joi.bool().default(DEFAULT_OPTIONS.debug),
     offlineModeActivationStrategies: utils_validation_1.Joi.array()
         .items(utils_validation_1.Joi.string()
@@ -43,6 +41,6 @@ exports.Schema = utils_validation_1.Joi.object({
         .default(DEFAULT_OPTIONS.reloadPopup),
 });
 function validateOptions({ validate, options, }) {
-    return validate(exports.Schema, options);
+    return validate(Schema, options);
 }
 exports.validateOptions = validateOptions;

package/lib/registerSw.js

@@ -79,7 +79,7 @@ function isStandaloneDisplayMode() {
 const OfflineModeActivationStrategiesImplementations = {
   always: () => true,
   mobile: () => window.innerWidth <= MAX_MOBILE_WIDTH,
-  saveData: () => !!(navigator.connection && navigator.connection.saveData),
+  saveData: () => !!navigator.connection?.saveData,
   appInstalled: async () => {
     const installedEventFired = await isAppInstalledEventFired();
     const installedRelatedApps = await isAppInstalledRelatedApps();

package/lib/sw.js

@@ -137,7 +137,7 @@ function getPossibleURLs(url) {
       });
     }
 
-    const type = event.data && event.data.type;
+    const type = event.data?.type;
 
     if (type === 'SKIP_WAITING') {
       self.skipWaiting();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-pwa",
-  "version": "2.0.0-beta.17",
+  "version": "2.0.0-beta.18",
   "description": "Docusaurus Plugin to add PWA support.",
   "main": "lib/index.js",
   "types": "src/plugin-pwa.d.ts",
@@ -20,31 +20,31 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@babel/core": "^7.17.5",
+    "@babel/core": "^7.17.8",
     "@babel/preset-env": "^7.16.11",
-    "@docusaurus/core": "2.0.0-beta.17",
-    "@docusaurus/theme-common": "2.0.0-beta.17",
-    "@docusaurus/theme-translations": "2.0.0-beta.17",
-    "@docusaurus/utils": "2.0.0-beta.17",
-    "@docusaurus/utils-validation": "2.0.0-beta.17",
-    "babel-loader": "^8.2.3",
+    "@docusaurus/core": "2.0.0-beta.18",
+    "@docusaurus/theme-common": "2.0.0-beta.18",
+    "@docusaurus/theme-translations": "2.0.0-beta.18",
+    "@docusaurus/utils": "2.0.0-beta.18",
+    "@docusaurus/utils-validation": "2.0.0-beta.18",
+    "babel-loader": "^8.2.4",
     "clsx": "^1.1.1",
-    "core-js": "^3.21.0",
+    "core-js": "^3.21.1",
     "terser-webpack-plugin": "^5.3.1",
     "tslib": "^2.3.1",
-    "webpack": "^5.69.1",
+    "webpack": "^5.70.0",
     "webpack-merge": "^5.8.0",
-    "workbox-build": "^6.5.0",
-    "workbox-precaching": "^6.5.0",
-    "workbox-window": "^6.5.0"
+    "workbox-build": "^6.5.2",
+    "workbox-precaching": "^6.5.2",
+    "workbox-window": "^6.5.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.17",
+    "@docusaurus/module-type-aliases": "2.0.0-beta.18",
     "fs-extra": "^10.0.1"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
   },
-  "gitHead": "0032c0b0480083227af2e1b4da2d3ee6ce992403"
+  "gitHead": "1a945d06993d53376e61bed2c942799fe07dc336"
 }

package/src/index.ts

@@ -64,14 +64,14 @@ export default function pluginPWA(
     name: 'docusaurus-plugin-pwa',
 
     getThemePath() {
-      return path.resolve(__dirname, '../lib/theme');
+      return '../lib/theme';
     },
     getTypeScriptThemePath() {
-      return path.resolve(__dirname, '../src/theme');
+      return '../src/theme';
     },
 
     getClientModules() {
-      return isProd ? [swRegister] : [];
+      return isProd && swRegister ? [swRegister] : [];
     },
 
     getDefaultCodeTranslationMessages() {
@@ -138,7 +138,7 @@ export default function pluginPWA(
       const swSourceFileTest = /\.m?js$/;
 
       const swWebpackConfig: Configuration = {
-        entry: path.resolve(__dirname, 'sw.js'),
+        entry: require.resolve('./sw.js'),
         output: {
           path: outDir,
           filename: 'sw.js',
@@ -189,9 +189,8 @@ export default function pluginPWA(
           '**/*.{js,json,css,html}',
           '**/*.{png,jpg,jpeg,gif,svg,ico}',
           '**/*.{woff,woff2,eot,ttf,otf}',
-          // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-          // @ts-ignore
-          ...(injectManifest.globPatterns || []),
+          // @ts-expect-error: internal API?
+          ...(injectManifest.globPatterns ?? []),
         ],
         // those attributes are not overrideable
         swDest,

package/src/options.ts

@@ -5,13 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import path from 'path';
 import {Joi} from '@docusaurus/utils-validation';
-import type {
-  ThemeConfig,
-  ValidationResult,
-  OptionValidationContext,
-} from '@docusaurus/types';
+import type {OptionValidationContext} from '@docusaurus/types';
 import type {PluginOptions} from '@docusaurus/plugin-pwa';
 
 const DEFAULT_OPTIONS = {
@@ -24,11 +19,11 @@ const DEFAULT_OPTIONS = {
   injectManifestConfig: {},
   pwaHead: [],
   swCustom: undefined,
-  swRegister: path.join(__dirname, 'registerSw.js'),
+  swRegister: './registerSw.js',
   reloadPopup: '@theme/PwaReloadPopup',
 };
 
-export const Schema = Joi.object({
+const Schema = Joi.object({
   debug: Joi.bool().default(DEFAULT_OPTIONS.debug),
   offlineModeActivationStrategies: Joi.array()
     .items(
@@ -62,6 +57,6 @@ export const Schema = Joi.object({
 export function validateOptions({
   validate,
   options,
-}: OptionValidationContext<PluginOptions>): ValidationResult<ThemeConfig> {
+}: OptionValidationContext<PluginOptions, PluginOptions>): PluginOptions {
   return validate(Schema, options);
 }

package/src/plugin-pwa.d.ts

@@ -6,26 +6,90 @@
  */
 
 declare module '@docusaurus/plugin-pwa' {
-  export type pwaHead = {
-    tagName: string;
-    href?: string;
-    content?: string;
-    [attributeName: string]: string | boolean;
-  };
+  import type {InjectManifestOptions} from 'workbox-build';
 
   export type PluginOptions = {
+    /**
+     * Turn debug mode on:
+     *
+     * - Workbox logs
+     * - Additional Docusaurus logs
+     * - Unoptimized SW file output
+     * - Source maps
+     */
     debug?: boolean;
-    offlineModeActivationStrategies;
-    injectManifestConfig;
-    reloadPopup;
-    pwaHead: pwaHead[];
-    swCustom;
-    swRegister;
+    /**
+     * Strategies used to turn the offline mode on:
+     *
+     * - `appInstalled`: activates for users having installed the site as an app
+     * (not 100% reliable)
+     * - `standalone`: activates for users running the app as standalone (often
+     * the case once a PWA is installed)
+     * - `queryString`: activates if queryString contains `offlineMode=true`
+     * (convenient for PWA debugging)
+     * - `mobile`: activates for mobile users (width <= 940px)
+     * - `saveData`: activates for users with `navigator.connection.saveData ===
+     * true`
+     * - `always`: activates for all users
+     */
+    offlineModeActivationStrategies: (
+      | 'appInstalled'
+      | 'queryString'
+      | 'standalone'
+      | 'mobile'
+      | 'saveData'
+      | 'always'
+    )[];
+    /**
+     * Workbox options to pass to `workbox.injectManifest()`. This gives you
+     * control over which assets will be precached, and be available offline.
+     * @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
+     * through this, but it's ideally used for tags to make your site PWA-
+     * compliant.
+     */
+    pwaHead: {
+      tagName: string;
+      href?: string;
+      content?: string;
+      [attributeName: string]: string | boolean;
+    }[];
+    /**
+     * Useful for additional Workbox rules. You can do whatever a service worker
+     * can do here, and use the full power of workbox libraries. The code is
+     * transpiled, so you can use modern ES6+ syntax here.
+     */
+    swCustom?: string;
+    /**
+     * Adds an entry before the Docusaurus app so that registration can happen
+     * before the app runs. The default `registerSW.js` file is enough for
+     * simple registration. Passing `false` will disable registration entirely.
+     */
+    swRegister: string | false;
   };
 }
 
 declare module '@theme/PwaReloadPopup' {
   export interface Props {
+    /**
+     * The popup should call this callback when the `reload` button is clicked.
+     * This will tell the service worker to install the waiting service worker
+     * and reload the page.
+     */
     readonly onReload: () => void;
   }
   export default function PwaReloadPopup(props: Props): JSX.Element;

package/src/registerSw.js

@@ -79,7 +79,7 @@ function isStandaloneDisplayMode() {
 const OfflineModeActivationStrategiesImplementations = {
   always: () => true,
   mobile: () => window.innerWidth <= MAX_MOBILE_WIDTH,
-  saveData: () => !!(navigator.connection && navigator.connection.saveData),
+  saveData: () => !!navigator.connection?.saveData,
   appInstalled: async () => {
     const installedEventFired = await isAppInstalledEventFired();
     const installedRelatedApps = await isAppInstalledRelatedApps();

package/src/sw.js

@@ -137,7 +137,7 @@ function getPossibleURLs(url) {
       });
     }
 
-    const type = event.data && event.data.type;
+    const type = event.data?.type;
 
     if (type === 'SKIP_WAITING') {
       self.skipWaiting();