@serwist/sw 9.0.0-preview.18 → 9.0.0-preview.19

package/dist/abstractions/Serwist.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Serwist.d.ts","sourceRoot":"","sources":["../../src/abstractions/Serwist.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,gCAAgC,EAAc,MAAM,0CAA0C,CAAC;AAC7G,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAMzE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAK9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAIjD,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;OAIG;IACH,cAAc,CAAC,EAAE,cAAc,EAAE,CAAC;IAClC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,gCAAgC,GAAG,OAAO,CAAC;IACpE;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;CACtD;AAED,qBAAa,OAAO;IAClB,OAAO,CAAC,mBAAmB,CAAqB;IAChD,OAAO,CAAC,OAAO,CAAS;gBACZ,EAAE,kBAAkB,EAAE,MAAM,EAAE,GAAE,cAAmB;IAI/D,OAAO,CAAC,EACN,eAAe,EACf,eAAe,EACf,qBAAqB,EACrB,gBAAgB,EAChB,yBAAyB,EACzB,wBAAwB,EACxB,WAAmB,EACnB,aAAa,EACb,iBAAyB,EACzB,OAAO,EACP,YAAoB,EACpB,cAAc,EACd,sBAAsB,EACtB,cAAsB,EACtB,SAAS,GACV,EAAE,qBAAqB;CA8DzB"}
+{"version":3,"file":"Serwist.d.ts","sourceRoot":"","sources":["../../src/abstractions/Serwist.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,gCAAgC,EAAc,MAAM,0CAA0C,CAAC;AAC7G,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAMzE,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAK9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAErE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAIjD,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;OAIG;IACH,cAAc,CAAC,EAAE,cAAc,EAAE,CAAC;IAClC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,gCAAgC,GAAG,OAAO,CAAC;IACpE;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;CACtD;AAED,qBAAa,OAAO;IAClB,OAAO,CAAC,mBAAmB,CAAqB;IAChD,OAAO,CAAC,OAAO,CAAS;gBACZ,EAAE,kBAAkB,EAAE,MAAM,EAAE,GAAE,cAAmB;IAI/D,OAAO,CAAC,EACN,eAAe,EACf,eAAe,EACf,qBAAqB,EACrB,gBAAgB,EAChB,yBAAyB,EACzB,wBAAwB,EACxB,WAAmB,EACnB,aAAa,EACb,iBAAyB,EACzB,OAAO,EACP,YAAoB,EACpB,cAAc,EACd,sBAAsB,EACtB,cAAsB,EACtB,SAAS,GACV,EAAE,qBAAqB;CA8DzB"}

package/dist/abstractions/navigationPreload.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Checks whether the current browser supports
+ * navigation preloading.
+ *
+ * @returns
+ */
+export declare const isNavigationPreloadSupported: () => boolean;
+/**
+ * If the browser supports navigation preloading, then this will enable it.
+ *
+ * @param headerValue Optional. Allows developers to override the value of
+ * the `Service-Worker-Navigation-Preload` header which will be sent to the
+ * server when making the navigation request.
+ */
+export declare const enableNavigationPreload: (headerValue?: string) => void;
+/**
+ * If the browser supports navigation preloading, then this will disable it.
+ */
+export declare const disableNavigationPreload: () => void;
+//# sourceMappingURL=navigationPreload.d.ts.map

package/dist/abstractions/navigationPreload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigationPreload.d.ts","sourceRoot":"","sources":["../../src/abstractions/navigationPreload.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,QAAO,OAE/C,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,iBAAkB,MAAM,KAAG,IAqB9D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB,QAAO,IAgB3C,CAAC"}

package/dist/index.d.ts

@@ -4,8 +4,9 @@ import type { FallbackEntry, FallbackMatcher, FallbacksOptions } from "./abstrac
 import { fallbacks } from "./abstractions/fallbacks.js";
 import { type HandlePrecachingOptions, handlePrecaching } from "./abstractions/handlePrecaching.js";
 import { type InstallSerwistOptions, installSerwist } from "./abstractions/installSerwist.js";
+import { disableNavigationPreload, enableNavigationPreload, isNavigationPreloadSupported } from "./abstractions/navigationPreload.js";
 import { registerRuntimeCaching } from "./abstractions/registerRuntimeCaching.js";
 import type { RuntimeCaching } from "./abstractions/types.js";
-export { disableDevLogs, fallbacks, handlePrecaching, installSerwist, Serwist, registerRuntimeCaching };
+export { disableDevLogs, fallbacks, handlePrecaching, installSerwist, Serwist, registerRuntimeCaching, disableNavigationPreload, enableNavigationPreload, isNavigationPreloadSupported, };
 export type { FallbackEntry, FallbackMatcher, FallbacksOptions, HandlePrecachingOptions, InstallSerwistOptions, SerwistOptions, SerwistInstallOptions, RuntimeCaching, };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,qBAAqB,EAAE,KAAK,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACrG,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AACpG,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,KAAK,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACpG,OAAO,EAAE,KAAK,qBAAqB,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAC9F,OAAO,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AAClF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,gBAAgB,EAAE,cAAc,EAAE,OAAO,EAAE,sBAAsB,EAAE,CAAC;AACxG,YAAY,EACV,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,uBAAuB,EACvB,qBAAqB,EACrB,cAAc,EACd,qBAAqB,EACrB,cAAc,GACf,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,qBAAqB,EAAE,KAAK,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACrG,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AACpG,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,KAAK,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACpG,OAAO,EAAE,KAAK,qBAAqB,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAC9F,OAAO,EAAE,wBAAwB,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAC;AACtI,OAAO,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AAClF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D,OAAO,EACL,cAAc,EACd,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,OAAO,EACP,sBAAsB,EAEtB,wBAAwB,EACxB,uBAAuB,EACvB,4BAA4B,GAC7B,CAAC;AACF,YAAY,EACV,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,uBAAuB,EACvB,qBAAqB,EACrB,cAAc,EACd,qBAAqB,EACrB,cAAc,GACf,CAAC"}

package/dist/index.js

@@ -1,5 +1,4 @@
 import { setCacheNameDetails, clientsClaim } from '@serwist/core';
-import { enable } from '@serwist/navigation-preload';
 import { P as PrecacheFallbackPlugin, i as initialize } from './chunks/PrecacheFallbackPlugin.js';
 import { p as precacheAndRoute, P as PrecacheRoute, c as cleanupOutdatedCaches, a as createHandlerBoundToURL } from './chunks/precacheAndRoute.js';
 import { g as getOrCreatePrecacheController } from './chunks/getOrCreatePrecacheController.js';
@@ -28,6 +27,43 @@ const fallbacks = ({ runtimeCaching, entries, precacheOptions })=>{
     return runtimeCaching;
 };
 
+const isNavigationPreloadSupported = ()=>{
+    return Boolean(self.registration?.navigationPreload);
+};
+const enableNavigationPreload = (headerValue)=>{
+    if (isNavigationPreloadSupported()) {
+        self.addEventListener("activate", (event)=>{
+            event.waitUntil(self.registration.navigationPreload.enable().then(()=>{
+                if (headerValue) {
+                    void self.registration.navigationPreload.setHeaderValue(headerValue);
+                }
+                if (process.env.NODE_ENV !== "production") {
+                    logger.log("Navigation preloading is enabled.");
+                }
+            }));
+        });
+    } else {
+        if (process.env.NODE_ENV !== "production") {
+            logger.log("Navigation preloading is not supported in this browser.");
+        }
+    }
+};
+const disableNavigationPreload = ()=>{
+    if (isNavigationPreloadSupported()) {
+        self.addEventListener("activate", (event)=>{
+            event.waitUntil(self.registration.navigationPreload.disable().then(()=>{
+                if (process.env.NODE_ENV !== "production") {
+                    logger.log("Navigation preloading is disabled.");
+                }
+            }));
+        });
+    } else {
+        if (process.env.NODE_ENV !== "production") {
+            logger.log("Navigation preloading is not supported in this browser.");
+        }
+    }
+};
+
 class Serwist {
     _precacheController;
     _router;
@@ -37,7 +73,7 @@ class Serwist {
     }
     install({ precacheEntries, precacheOptions, cleanupOutdatedCaches: cleanupOutdatedCaches$1, navigateFallback, navigateFallbackAllowlist, navigateFallbackDenylist, skipWaiting = false, importScripts, navigationPreload = false, cacheId, clientsClaim: clientsClaim$1 = false, runtimeCaching, offlineAnalyticsConfig, disableDevLogs: disableDevLogs$1 = false, fallbacks: fallbacks$1 }) {
         if (!!importScripts && importScripts.length > 0) self.importScripts(...importScripts);
-        if (navigationPreload) enable();
+        if (navigationPreload) enableNavigationPreload();
         if (cacheId !== undefined) {
             setCacheNameDetails({
                 prefix: cacheId
@@ -116,4 +152,4 @@ const registerRuntimeCaching = (...runtimeCachingList)=>{
     }
 };
 
-export { Serwist, disableDevLogs, fallbacks, handlePrecaching, installSerwist, registerRuntimeCaching };
+export { Serwist, disableDevLogs, disableNavigationPreload, enableNavigationPreload, fallbacks, handlePrecaching, installSerwist, isNavigationPreloadSupported, registerRuntimeCaching };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@serwist/sw",
-  "version": "9.0.0-preview.18",
+  "version": "9.0.0-preview.19",
   "type": "module",
-  "description": "A module that makes it easy to get started with the Serwist service worker libraries.",
+  "description": "A service worker helper module.",
   "files": [
     "src",
     "dist"
@@ -15,8 +15,8 @@
   ],
   "author": "Google's Web DevRel Team, Serwist's Team",
   "license": "MIT",
-  "repository": "serwist/serwist",
-  "bugs": "https://github.com/serwist/serwist/issues",
+  "repository": "https://gitlab.com/serwist/serwist",
+  "bugs": "https://gitlab.com/serwist/serwist/issues",
   "homepage": "https://serwist.pages.dev",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -61,14 +61,13 @@
   },
   "dependencies": {
     "idb": "8.0.0",
-    "@serwist/core": "9.0.0-preview.18",
-    "@serwist/navigation-preload": "9.0.0-preview.18"
+    "@serwist/core": "9.0.0-preview.19"
   },
   "devDependencies": {
     "rollup": "4.13.0",
     "typescript": "5.5.0-dev.20240323",
-    "@serwist/utils": "9.0.0-preview.18",
-    "@serwist/constants": "9.0.0-preview.18"
+    "@serwist/constants": "9.0.0-preview.19",
+    "@serwist/utils": "9.0.0-preview.19"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"

package/src/abstractions/Serwist.ts

@@ -1,5 +1,4 @@
 import { clientsClaim as clientsClaimImpl, setCacheNameDetails } from "@serwist/core";
-import { enable } from "@serwist/navigation-preload";
 import { type GoogleAnalyticsInitializeOptions, initialize } from "../plugins/googleAnalytics/initialize.js";
 import { PrecacheController } from "../precaching/PrecacheController.js";
 import { PrecacheRoute } from "../precaching/PrecacheRoute.js";
@@ -14,6 +13,7 @@ import { disableDevLogs as disableDevLogsImpl } from "./disableDevLogs.js";
 import { fallbacks as fallbacksImpl } from "./fallbacks.js";
 import type { FallbacksOptions } from "./fallbacks.js";
 import { type HandlePrecachingOptions } from "./handlePrecaching.js";
+import { enableNavigationPreload } from "./navigationPreload.js";
 import type { RuntimeCaching } from "./types.js";
 
 declare const self: ServiceWorkerGlobalScope;
@@ -117,7 +117,7 @@ export class Serwist {
   }: SerwistInstallOptions) {
     if (!!importScripts && importScripts.length > 0) self.importScripts(...importScripts);
 
-    if (navigationPreload) enable();
+    if (navigationPreload) enableNavigationPreload();
 
     if (cacheId !== undefined) {
       setCacheNameDetails({

package/src/abstractions/navigationPreload.ts

@@ -0,0 +1,64 @@
+import { logger } from "@serwist/core/internal";
+
+declare const self: ServiceWorkerGlobalScope;
+
+/**
+ * Checks whether the current browser supports
+ * navigation preloading.
+ *
+ * @returns
+ */
+export const isNavigationPreloadSupported = (): boolean => {
+  return Boolean(self.registration?.navigationPreload);
+};
+
+/**
+ * If the browser supports navigation preloading, then this will enable it.
+ *
+ * @param headerValue Optional. Allows developers to override the value of
+ * the `Service-Worker-Navigation-Preload` header which will be sent to the
+ * server when making the navigation request.
+ */
+export const enableNavigationPreload = (headerValue?: string): void => {
+  if (isNavigationPreloadSupported()) {
+    self.addEventListener("activate", (event) => {
+      event.waitUntil(
+        self.registration.navigationPreload.enable().then(() => {
+          // Defaults to Service-Worker-Navigation-Preload: true if not set.
+          if (headerValue) {
+            void self.registration.navigationPreload.setHeaderValue(headerValue);
+          }
+
+          if (process.env.NODE_ENV !== "production") {
+            logger.log("Navigation preloading is enabled.");
+          }
+        }),
+      );
+    });
+  } else {
+    if (process.env.NODE_ENV !== "production") {
+      logger.log("Navigation preloading is not supported in this browser.");
+    }
+  }
+};
+
+/**
+ * If the browser supports navigation preloading, then this will disable it.
+ */
+export const disableNavigationPreload = (): void => {
+  if (isNavigationPreloadSupported()) {
+    self.addEventListener("activate", (event: ExtendableEvent) => {
+      event.waitUntil(
+        self.registration.navigationPreload.disable().then(() => {
+          if (process.env.NODE_ENV !== "production") {
+            logger.log("Navigation preloading is disabled.");
+          }
+        }),
+      );
+    });
+  } else {
+    if (process.env.NODE_ENV !== "production") {
+      logger.log("Navigation preloading is not supported in this browser.");
+    }
+  }
+};

package/src/index.ts

@@ -4,10 +4,22 @@ import type { FallbackEntry, FallbackMatcher, FallbacksOptions } from "./abstrac
 import { fallbacks } from "./abstractions/fallbacks.js";
 import { type HandlePrecachingOptions, handlePrecaching } from "./abstractions/handlePrecaching.js";
 import { type InstallSerwistOptions, installSerwist } from "./abstractions/installSerwist.js";
+import { disableNavigationPreload, enableNavigationPreload, isNavigationPreloadSupported } from "./abstractions/navigationPreload.js";
 import { registerRuntimeCaching } from "./abstractions/registerRuntimeCaching.js";
 import type { RuntimeCaching } from "./abstractions/types.js";
 
-export { disableDevLogs, fallbacks, handlePrecaching, installSerwist, Serwist, registerRuntimeCaching };
+export {
+  disableDevLogs,
+  fallbacks,
+  handlePrecaching,
+  installSerwist,
+  Serwist,
+  registerRuntimeCaching,
+  // Navigation preloading
+  disableNavigationPreload,
+  enableNavigationPreload,
+  isNavigationPreloadSupported,
+};
 export type {
   FallbackEntry,
   FallbackMatcher,