@docusaurus/plugin-pwa 4.0.0-canary-7041 → 4.0.0-canary-7102

package/lib/globPatterns.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+import type { PluginOptions } from '@docusaurus/plugin-pwa';
+/** The files to precache: the regular static assets, plus the user ones. */
+export declare function getGlobPatterns(injectManifestConfig: PluginOptions['injectManifestConfig']): string[];

package/lib/globPatterns.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGlobPatterns = getGlobPatterns;
+/** The files to precache: the regular static assets, plus the user ones. */
+function getGlobPatterns(injectManifestConfig) {
+    return [
+        '**/*.{js,json,css,html}',
+        '**/*.{png,jpg,jpeg,gif,svg,ico}',
+        '**/*.{woff,woff2,eot,ttf,otf}',
+        ...(injectManifestConfig.globPatterns ?? []),
+    ];
+}

package/lib/index.js

@@ -11,10 +11,11 @@ exports.default = pluginPWA;
 const tslib_1 = require("tslib");
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
 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 theme_translations_1 = require("@docusaurus/theme-translations");
+const globPatterns_1 = require("./globPatterns");
+const precacheManifest_1 = require("./precacheManifest");
 const PluginName = 'docusaurus-plugin-pwa';
 function pluginPWA(context, options) {
     if (process.env.NODE_ENV !== 'production') {
@@ -129,15 +130,9 @@ function pluginPWA(context, options) {
                 currentBundler: props.currentBundler,
             });
             const swDest = node_path_1.default.resolve(props.outDir, 'sw.js');
-            await (0, workbox_build_1.injectManifest)({
+            await (0, precacheManifest_1.injectPrecacheManifest)({
                 ...injectManifestConfig,
-                globPatterns: [
-                    '**/*.{js,json,css,html}',
-                    '**/*.{png,jpg,jpeg,gif,svg,ico}',
-                    '**/*.{woff,woff2,eot,ttf,otf}',
-                    // @ts-expect-error: internal API?
-                    ...(workbox_build_1.injectManifest.globPatterns ?? []),
-                ],
+                globPatterns: (0, globPatterns_1.getGlobPatterns)(injectManifestConfig),
                 // Those attributes are not overrideable
                 swDest,
                 swSrc: swDest,

package/lib/precacheManifest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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.
+ */
+import type { InjectManifestOptions } from 'workbox-build';
+/**
+ * Same as Workbox `injectManifest()`, but falls back to SHA-256 to hash the
+ * files when MD5 is not available. Workbox hardcodes MD5, which FIPS mode
+ * rejects. See https://github.com/GoogleChrome/workbox/issues/3366
+ */
+export declare function injectPrecacheManifest(config: InjectManifestOptions): Promise<void>;

package/lib/precacheManifest.js

@@ -0,0 +1,68 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.injectPrecacheManifest = injectPrecacheManifest;
+const tslib_1 = require("tslib");
+const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const workbox_build_1 = require("workbox-build");
+// Internal Workbox APIs, to apply the user options the same way Workbox does
+const transform_manifest_1 = require("workbox-build/build/lib/transform-manifest");
+const validate_options_1 = require("workbox-build/build/lib/validate-options");
+const fs_1 = require("@docusaurus/fs");
+const glob_1 = require("@docusaurus/glob");
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const utils_1 = require("@docusaurus/utils");
+/**
+ * Same as Workbox `injectManifest()`, but falls back to SHA-256 to hash the
+ * files when MD5 is not available. Workbox hardcodes MD5, which FIPS mode
+ * rejects. See https://github.com/GoogleChrome/workbox/issues/3366
+ */
+async function injectPrecacheManifest(config) {
+    const options = (0, validate_options_1.validateInjectManifestOptions)(config);
+    // Options our file hashing doesn't support: Workbox (and MD5) handles them
+    if (options.templatedURLs || !options.globFollow) {
+        await (0, workbox_build_1.injectManifest)(config);
+        return;
+    }
+    const files = await globFilesToPrecache(options);
+    const fileDetails = await getFileDetails(files, options.globDirectory);
+    const { manifestEntries } = await (0, transform_manifest_1.transformManifest)({ ...options, fileDetails });
+    await (0, workbox_build_1.injectManifest)({
+        swSrc: options.swSrc,
+        swDest: options.swDest,
+        globDirectory: options.globDirectory,
+        injectionPoint: options.injectionPoint,
+        globPatterns: [],
+        additionalManifestEntries: manifestEntries,
+    });
+}
+async function globFilesToPrecache({ globDirectory, globPatterns = [], globIgnores = [], swSrc, swDest, }) {
+    // Like Workbox, never precache the service worker itself
+    const swFiles = [swSrc, swDest].map((file) => (0, utils_1.posixPath)(node_path_1.default.relative(globDirectory, file)));
+    const files = await (0, glob_1.glob)(globPatterns, {
+        cwd: globDirectory,
+        ignore: [...globIgnores, ...swFiles],
+        // Like Workbox, don't precache all the files of a next.js/ directory
+        expandDirectories: false,
+    });
+    // Sorted for a deterministic sw.js output
+    return files.toSorted();
+}
+async function getFileDetails(files, globDirectory) {
+    return Promise.all(files.map((file) => getSingleFileDetails(file, globDirectory)));
+}
+async function getSingleFileDetails(file, globDirectory) {
+    const filePath = node_path_1.default.join(globDirectory, file);
+    try {
+        const content = await fs_1.fs.readFile(filePath);
+        return { file, hash: (0, utils_1.hashString)(content), size: content.length };
+    }
+    catch (err) {
+        throw new Error(logger_1.default.interpolate `Can't hash the file to precache at path=${node_path_1.default.relative(process.cwd(), filePath)}`, { cause: err });
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-pwa",
-  "version": "4.0.0-canary-7041",
+  "version": "4.0.0-canary-7102",
   "description": "Docusaurus Plugin to add PWA support.",
   "main": "lib/index.js",
   "types": "src/plugin-pwa.d.ts",
@@ -14,14 +14,16 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/bundler": "4.0.0-canary-7041",
-    "@docusaurus/core": "4.0.0-canary-7041",
-    "@docusaurus/logger": "4.0.0-canary-7041",
-    "@docusaurus/theme-common": "4.0.0-canary-7041",
-    "@docusaurus/theme-translations": "4.0.0-canary-7041",
-    "@docusaurus/types": "4.0.0-canary-7041",
-    "@docusaurus/utils": "4.0.0-canary-7041",
-    "@docusaurus/utils-validation": "4.0.0-canary-7041",
+    "@docusaurus/bundler": "4.0.0-canary-7102",
+    "@docusaurus/core": "4.0.0-canary-7102",
+    "@docusaurus/fs": "4.0.0-canary-7102",
+    "@docusaurus/glob": "4.0.0-canary-7102",
+    "@docusaurus/logger": "4.0.0-canary-7102",
+    "@docusaurus/theme-common": "4.0.0-canary-7102",
+    "@docusaurus/theme-translations": "4.0.0-canary-7102",
+    "@docusaurus/types": "4.0.0-canary-7102",
+    "@docusaurus/utils": "4.0.0-canary-7102",
+    "@docusaurus/utils-validation": "4.0.0-canary-7102",
     "clsx": "^2.1.1",
     "tslib": "^2.8.1",
     "webpack": "^5.111.0",
@@ -30,7 +32,7 @@
     "workbox-window": "^7.4.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "4.0.0-canary-7041",
+    "@docusaurus/module-type-aliases": "4.0.0-canary-7102",
     "@types/react-dom": "^19.3.0"
   },
   "peerDependencies": {

package/src/globPatterns.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+
+import type {PluginOptions} from '@docusaurus/plugin-pwa';
+
+/** The files to precache: the regular static assets, plus the user ones. */
+export function getGlobPatterns(
+  injectManifestConfig: PluginOptions['injectManifestConfig'],
+): string[] {
+  return [
+    '**/*.{js,json,css,html}',
+    '**/*.{png,jpg,jpeg,gif,svg,ico}',
+    '**/*.{woff,woff2,eot,ttf,otf}',
+    ...(injectManifestConfig.globPatterns ?? []),
+  ];
+}

package/src/index.ts

@@ -13,10 +13,11 @@ import {
   getProgressBarPlugin,
   getMinimizers,
 } from '@docusaurus/bundler';
-import {injectManifest} from 'workbox-build';
 import {normalizeUrl} from '@docusaurus/utils';
 import logger from '@docusaurus/logger';
 import {readDefaultCodeTranslationMessages} from '@docusaurus/theme-translations';
+import {getGlobPatterns} from './globPatterns';
+import {injectPrecacheManifest} from './precacheManifest';
 import type {HtmlTags, LoadContext, Plugin} from '@docusaurus/types';
 import type {PluginOptions} from '@docusaurus/plugin-pwa';
 
@@ -174,15 +175,9 @@ export default function pluginPWA(
 
       const swDest = path.resolve(props.outDir, 'sw.js');
 
-      await injectManifest({
+      await injectPrecacheManifest({
         ...injectManifestConfig,
-        globPatterns: [
-          '**/*.{js,json,css,html}',
-          '**/*.{png,jpg,jpeg,gif,svg,ico}',
-          '**/*.{woff,woff2,eot,ttf,otf}',
-          // @ts-expect-error: internal API?
-          ...((injectManifest.globPatterns as string[] | undefined) ?? []),
-        ],
+        globPatterns: getGlobPatterns(injectManifestConfig),
         // Those attributes are not overrideable
         swDest,
         swSrc: swDest,

package/src/precacheManifest.ts

@@ -0,0 +1,93 @@
+/**
+ * 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.
+ */
+
+import path from 'node:path';
+import {injectManifest} from 'workbox-build';
+// Internal Workbox APIs, to apply the user options the same way Workbox does
+import {transformManifest} from 'workbox-build/build/lib/transform-manifest';
+import {validateInjectManifestOptions} from 'workbox-build/build/lib/validate-options';
+import {fs} from '@docusaurus/fs';
+import {glob} from '@docusaurus/glob';
+import logger from '@docusaurus/logger';
+import {hashString, posixPath} from '@docusaurus/utils';
+import type {FileDetails, InjectManifestOptions} from 'workbox-build';
+
+/**
+ * Same as Workbox `injectManifest()`, but falls back to SHA-256 to hash the
+ * files when MD5 is not available. Workbox hardcodes MD5, which FIPS mode
+ * rejects. See https://github.com/GoogleChrome/workbox/issues/3366
+ */
+export async function injectPrecacheManifest(
+  config: InjectManifestOptions,
+): Promise<void> {
+  const options = validateInjectManifestOptions(config);
+
+  // Options our file hashing doesn't support: Workbox (and MD5) handles them
+  if (options.templatedURLs || !options.globFollow) {
+    await injectManifest(config);
+    return;
+  }
+
+  const files = await globFilesToPrecache(options);
+  const fileDetails = await getFileDetails(files, options.globDirectory);
+  const {manifestEntries} = await transformManifest({...options, fileDetails});
+
+  await injectManifest({
+    swSrc: options.swSrc,
+    swDest: options.swDest,
+    globDirectory: options.globDirectory,
+    injectionPoint: options.injectionPoint,
+    globPatterns: [],
+    additionalManifestEntries: manifestEntries,
+  });
+}
+
+async function globFilesToPrecache({
+  globDirectory,
+  globPatterns = [],
+  globIgnores = [],
+  swSrc,
+  swDest,
+}: InjectManifestOptions): Promise<string[]> {
+  // Like Workbox, never precache the service worker itself
+  const swFiles = [swSrc, swDest].map((file) =>
+    posixPath(path.relative(globDirectory, file)),
+  );
+  const files = await glob(globPatterns, {
+    cwd: globDirectory,
+    ignore: [...globIgnores, ...swFiles],
+    // Like Workbox, don't precache all the files of a next.js/ directory
+    expandDirectories: false,
+  });
+  // Sorted for a deterministic sw.js output
+  return files.toSorted();
+}
+
+async function getFileDetails(
+  files: string[],
+  globDirectory: string,
+): Promise<FileDetails[]> {
+  return Promise.all(
+    files.map((file) => getSingleFileDetails(file, globDirectory)),
+  );
+}
+
+async function getSingleFileDetails(
+  file: string,
+  globDirectory: string,
+): Promise<FileDetails> {
+  const filePath = path.join(globDirectory, file);
+  try {
+    const content = await fs.readFile(filePath);
+    return {file, hash: hashString(content), size: content.length};
+  } catch (err) {
+    throw new Error(
+      logger.interpolate`Can't hash the file to precache at path=${path.relative(process.cwd(), filePath)}`,
+      {cause: err},
+    );
+  }
+}