@serwist/sw 9.0.0-preview.2 → 9.0.0-preview.20

package/dist/index.js

@@ -1,159 +1,156 @@
-import { precacheAndRoute, cleanupOutdatedCaches, createHandlerBoundToURL, PrecacheFallbackPlugin } from '@serwist/precaching';
-import { registerRoute, NavigationRoute } from '@serwist/routing';
 import { setCacheNameDetails, clientsClaim } from '@serwist/core';
+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 getSingletonPrecacheController } from './chunks/singletonPrecacheController.js';
+import { N as NavigationRoute } from './chunks/NavigationRoute.js';
+import { g as getSingletonRouter, p as parseRoute } from './chunks/singletonRouter.js';
+import { S as Strategy } from './chunks/Strategy.js';
 import { logger } from '@serwist/core/internal';
-import { initialize } from '@serwist/google-analytics/initialize';
-import { enable } from '@serwist/navigation-preload';
-import { BackgroundSyncPlugin } from '@serwist/background-sync';
-import { BroadcastUpdatePlugin } from '@serwist/broadcast-update';
-import { CacheableResponsePlugin } from '@serwist/cacheable-response';
-import { ExpirationPlugin } from '@serwist/expiration';
-import { RangeRequestsPlugin } from '@serwist/range-requests';
-import { CacheFirst, CacheOnly, NetworkFirst, NetworkOnly, StaleWhileRevalidate } from '@serwist/strategies';
+import { r as registerRoute } from './chunks/registerRoute.js';
+import './chunks/NetworkOnly.js';
+import 'idb';
 
 const disableDevLogs = ()=>{
     self.__WB_DISABLE_DEV_LOGS = true;
 };
 
 const fallbacks = ({ runtimeCaching, entries, precacheOptions })=>{
-    precacheAndRoute(entries.map(({ url, revision })=>({
-            url: typeof url === "string" ? url : url.toString(),
-            revision
-        })), precacheOptions);
-    runtimeCaching = runtimeCaching.map((cacheEntry)=>{
-        if (!cacheEntry.options || cacheEntry.options.precacheFallback || cacheEntry.options.plugins?.some((plugin)=>"handlerDidError" in plugin)) {
-            return cacheEntry;
-        }
-        if (!cacheEntry.options.plugins) {
-            cacheEntry.options.plugins = [];
+    precacheAndRoute(entries, precacheOptions);
+    const fallbackPlugin = new PrecacheFallbackPlugin({
+        fallbackUrls: entries
+    });
+    runtimeCaching.forEach((cacheEntry)=>{
+        if (cacheEntry.handler instanceof Strategy && !cacheEntry.handler.plugins.some((plugin)=>"handlerDidError" in plugin)) {
+            cacheEntry.handler.plugins.push(fallbackPlugin);
         }
-        cacheEntry.options.plugins.push({
-            async handlerDidError (info) {
-                for (const { matcher, url, cacheMatchOptions = {
-                    ignoreSearch: true
-                } } of entries){
-                    if (matcher(info)) {
-                        return caches.match(url, cacheMatchOptions);
-                    }
-                }
-                return Response.error();
-            }
-        });
         return cacheEntry;
     });
     return runtimeCaching;
 };
 
-const handlePrecaching = ({ precacheEntries, precacheOptions, cleanupOutdatedCaches: cleanupOutdatedCaches$1 = false, ...options })=>{
-    if (!!precacheEntries && precacheEntries.length > 0) {
-        precacheAndRoute(precacheEntries, precacheOptions);
-    }
-    if (cleanupOutdatedCaches$1) cleanupOutdatedCaches();
-    if (options.navigateFallback) {
-        registerRoute(new NavigationRoute(createHandlerBoundToURL(options.navigateFallback), {
-            allowlist: options.navigateFallbackAllowlist,
-            denylist: options.navigateFallbackDenylist
-        }));
-    }
-};
-
-const nonNullable = (value)=>value !== null && value !== undefined;
-
-const HANDLER_NAME_TO_METHOD = {
-    CacheFirst,
-    CacheOnly,
-    NetworkFirst,
-    NetworkOnly,
-    StaleWhileRevalidate
+const isNavigationPreloadSupported = ()=>{
+    return Boolean(self.registration?.navigationPreload);
 };
-const registerRuntimeCaching = (...runtimeCachingList)=>{
-    if (!("__WB_FORCE_RUNTIME_CACHING" in globalThis)) {
-        self.__WB_FORCE_RUNTIME_CACHING = false;
-    }
-    if (!self.__WB_FORCE_RUNTIME_CACHING && process.env.NODE_ENV !== "production") {
-        logger.log("registerRuntimeCaching is disabled in development mode.");
-        return;
+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.");
+        }
     }
-    for (const rcEntry of runtimeCachingList){
-        if (typeof rcEntry.handler === "string") {
-            const { cacheName, networkTimeoutSeconds, fetchOptions, matchOptions, plugins, backgroundSync, broadcastUpdate, cacheableResponse, expiration, precacheFallback, rangeRequests } = rcEntry.options;
-            const Handler = HANDLER_NAME_TO_METHOD[rcEntry.handler];
-            registerRoute(rcEntry.urlPattern, new Handler({
-                cacheName: cacheName ?? undefined,
-                networkTimeoutSeconds,
-                fetchOptions,
-                matchOptions,
-                plugins: [
-                    ...plugins ?? [],
-                    backgroundSync && new BackgroundSyncPlugin(backgroundSync.name, backgroundSync.options),
-                    broadcastUpdate && new BroadcastUpdatePlugin({
-                        channelName: broadcastUpdate.channelName,
-                        ...broadcastUpdate.options
-                    }),
-                    cacheableResponse && new CacheableResponsePlugin(cacheableResponse),
-                    expiration && new ExpirationPlugin(expiration),
-                    precacheFallback && new PrecacheFallbackPlugin(precacheFallback),
-                    rangeRequests ? new RangeRequestsPlugin() : undefined
-                ].filter(nonNullable)
-            }), rcEntry.method);
-        } else {
-            registerRoute(rcEntry.urlPattern, rcEntry.handler, rcEntry.method);
+};
+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.");
         }
     }
 };
 
-const installSerwist = ({ precacheEntries, precacheOptions, cleanupOutdatedCaches, skipWaiting = false, importScripts, navigationPreload = false, cacheId, clientsClaim: clientsClaim$1 = false, runtimeCaching, offlineAnalyticsConfig, disableDevLogs: disableDevLogs$1, fallbacks: fallbacks$1, ...options })=>{
-    if (!!importScripts && importScripts.length > 0) self.importScripts(...importScripts);
-    if (navigationPreload) enable();
-    if (cacheId !== undefined) {
-        setCacheNameDetails({
-            prefix: cacheId
-        });
+class Serwist {
+    _precacheController;
+    _router;
+    constructor({ precacheController, router } = {}){
+        this._precacheController = precacheController || getSingletonPrecacheController();
+        this._router = router || getSingletonRouter();
     }
-    if (skipWaiting) {
-        self.skipWaiting();
-    } else {
-        self.addEventListener("message", (event)=>{
-            if (event.data && event.data.type === "SKIP_WAITING") {
-                self.skipWaiting();
+    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) enableNavigationPreload();
+        if (cacheId !== undefined) {
+            setCacheNameDetails({
+                prefix: cacheId
+            });
+        }
+        if (skipWaiting) {
+            self.skipWaiting();
+        } else {
+            self.addEventListener("message", (event)=>{
+                if (event.data && event.data.type === "SKIP_WAITING") {
+                    self.skipWaiting();
+                }
+            });
+        }
+        if (clientsClaim$1) clientsClaim();
+        if (!!precacheEntries && precacheEntries.length > 0) {
+            this._precacheController.precache(precacheEntries);
+            this._router.registerRoute(new PrecacheRoute(this._precacheController, precacheOptions));
+            if (cleanupOutdatedCaches$1) cleanupOutdatedCaches();
+            if (navigateFallback) {
+                this._router.registerRoute(new NavigationRoute(createHandlerBoundToURL(navigateFallback), {
+                    allowlist: navigateFallbackAllowlist,
+                    denylist: navigateFallbackDenylist
+                }));
             }
-        });
-    }
-    if (clientsClaim$1) clientsClaim();
-    handlePrecaching({
-        precacheEntries,
-        precacheOptions,
-        cleanupOutdatedCaches,
-        ...options.navigateFallback && {
-            navigateFallback: options.navigateFallback,
-            navigateFallbackAllowlist: options.navigateFallbackAllowlist,
-            navigateFallbackDenylist: options.navigateFallbackDenylist
         }
-    });
-    if (runtimeCaching !== undefined) {
-        if (!("__WB_FORCE_RUNTIME_CACHING" in globalThis)) {
-            self.__WB_FORCE_RUNTIME_CACHING = false;
+        if (offlineAnalyticsConfig !== undefined) {
+            if (typeof offlineAnalyticsConfig === "boolean") {
+                offlineAnalyticsConfig && initialize();
+            } else {
+                initialize(offlineAnalyticsConfig);
+            }
         }
-        if (!self.__WB_FORCE_RUNTIME_CACHING && process.env.NODE_ENV !== "production") {
-            logger.log("runtimeCaching and fallbacks are disabled in development mode.");
-        } else {
+        if (runtimeCaching !== undefined) {
             if (fallbacks$1 !== undefined) {
-                runtimeCaching = fallbacks({
+                fallbacks({
                     ...fallbacks$1,
                     runtimeCaching
                 });
             }
-            registerRuntimeCaching(...runtimeCaching);
+            for (const entry of runtimeCaching){
+                this._router.registerRoute(parseRoute(entry.matcher, entry.handler, entry.method));
+            }
         }
+        if (disableDevLogs$1) disableDevLogs();
     }
-    if (offlineAnalyticsConfig !== undefined) {
-        if (typeof offlineAnalyticsConfig === "boolean") {
-            offlineAnalyticsConfig && initialize();
-        } else {
-            initialize(offlineAnalyticsConfig);
+}
+
+const handlePrecaching = ({ precacheEntries, precacheOptions, cleanupOutdatedCaches: cleanupOutdatedCaches$1 = false, ...options })=>{
+    if (!!precacheEntries && precacheEntries.length > 0) {
+        precacheAndRoute(precacheEntries, precacheOptions);
+        if (cleanupOutdatedCaches$1) cleanupOutdatedCaches();
+        if (options.navigateFallback) {
+            registerRoute(new NavigationRoute(createHandlerBoundToURL(options.navigateFallback), {
+                allowlist: options.navigateFallbackAllowlist,
+                denylist: options.navigateFallbackDenylist
+            }));
         }
     }
-    if (disableDevLogs$1) disableDevLogs();
 };
 
-export { disableDevLogs, fallbacks, handlePrecaching, installSerwist, registerRuntimeCaching };
+const installSerwist = (options)=>{
+    if (process.env.NODE_ENV !== "production") {
+        logger.warn("'installSerwist' has been deprecated. Please migrate to 'new Serwist().install()'.");
+    }
+    const serwist = new Serwist({
+        precacheController: getSingletonPrecacheController(),
+        router: getSingletonRouter()
+    });
+    serwist.install(options);
+};
+
+const registerRuntimeCaching = (...runtimeCachingList)=>{
+    for (const entry of runtimeCachingList){
+        registerRoute(entry.matcher, entry.handler, entry.method);
+    }
+};
+
+export { Serwist, disableDevLogs, disableNavigationPreload, enableNavigationPreload, fallbacks, handlePrecaching, installSerwist, isNavigationPreloadSupported, registerRuntimeCaching };

package/dist/index.plugins.d.ts

@@ -0,0 +1,41 @@
+import { BackgroundSyncPlugin } from "./plugins/backgroundSync/BackgroundSyncPlugin.js";
+import type { QueueEntry as BackgroundSyncQueueEntry, QueueOptions as BackgroundSyncQueueOptions } from "./plugins/backgroundSync/Queue.js";
+import { Queue as BackgroundSyncQueue } from "./plugins/backgroundSync/Queue.js";
+import { QueueStore as BackgroundSyncQueueStore } from "./plugins/backgroundSync/QueueStore.js";
+import { StorableRequest } from "./plugins/backgroundSync/StorableRequest.js";
+import { BroadcastCacheUpdate } from "./plugins/broadcastUpdate/BroadcastCacheUpdate.js";
+import { BroadcastUpdatePlugin } from "./plugins/broadcastUpdate/BroadcastUpdatePlugin.js";
+import { CACHE_UPDATED_MESSAGE_META as BROADCAST_UPDATE_MESSAGE_META, CACHE_UPDATED_MESSAGE_TYPE as BROADCAST_UPDATE_MESSAGE_TYPE, defaultHeadersToCheck as BROADCAST_UPDATE_DEFAULT_HEADERS } from "./plugins/broadcastUpdate/constants.js";
+import { responsesAreSame } from "./plugins/broadcastUpdate/responsesAreSame.js";
+import type { BroadcastCacheUpdateOptions, BroadcastMessage, BroadcastPayload, BroadcastPayloadGenerator } from "./plugins/broadcastUpdate/types.js";
+import type { CacheableResponseOptions } from "./plugins/cacheableResponse/CacheableResponse.js";
+import { CacheableResponse } from "./plugins/cacheableResponse/CacheableResponse.js";
+import { CacheableResponsePlugin } from "./plugins/cacheableResponse/CacheableResponsePlugin.js";
+import { CacheExpiration } from "./plugins/expiration/CacheExpiration.js";
+import type { ExpirationPluginOptions } from "./plugins/expiration/ExpirationPlugin.js";
+import { ExpirationPlugin } from "./plugins/expiration/ExpirationPlugin.js";
+import type { GoogleAnalyticsInitializeOptions } from "./plugins/googleAnalytics/initialize.js";
+import { initialize as initializeGoogleAnalytics } from "./plugins/googleAnalytics/initialize.js";
+import type { PrecacheFallbackEntry, PrecacheFallbackPluginOptions } from "./plugins/precaching/PrecacheFallbackPlugin.js";
+import { PrecacheFallbackPlugin } from "./plugins/precaching/PrecacheFallbackPlugin.js";
+import { RangeRequestsPlugin } from "./plugins/rangeRequests/RangeRequestsPlugin.js";
+import { createPartialResponse } from "./plugins/rangeRequests/createPartialResponse.js";
+interface SyncManager {
+    getTags(): Promise<string[]>;
+    register(tag: string): Promise<void>;
+}
+declare global {
+    interface ServiceWorkerRegistration {
+        readonly sync: SyncManager;
+    }
+    interface SyncEvent extends ExtendableEvent {
+        readonly lastChance: boolean;
+        readonly tag: string;
+    }
+    interface ServiceWorkerGlobalScopeEventMap {
+        sync: SyncEvent;
+    }
+}
+export { BackgroundSyncPlugin, BackgroundSyncQueue, BackgroundSyncQueueStore, StorableRequest, BroadcastCacheUpdate, BroadcastUpdatePlugin, responsesAreSame, BROADCAST_UPDATE_MESSAGE_META, BROADCAST_UPDATE_MESSAGE_TYPE, BROADCAST_UPDATE_DEFAULT_HEADERS, CacheableResponse, CacheableResponsePlugin, CacheExpiration, ExpirationPlugin, PrecacheFallbackPlugin, createPartialResponse, RangeRequestsPlugin, initializeGoogleAnalytics, };
+export type { BackgroundSyncQueueOptions, BackgroundSyncQueueEntry, BroadcastCacheUpdateOptions, BroadcastPayload, BroadcastPayloadGenerator, BroadcastMessage, CacheableResponseOptions, ExpirationPluginOptions, PrecacheFallbackEntry, PrecacheFallbackPluginOptions, GoogleAnalyticsInitializeOptions, };
+//# sourceMappingURL=index.plugins.d.ts.map

package/dist/index.plugins.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.plugins.d.ts","sourceRoot":"","sources":["../src/index.plugins.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,kDAAkD,CAAC;AACxF,OAAO,KAAK,EAAE,UAAU,IAAI,wBAAwB,EAAE,YAAY,IAAI,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAC5I,OAAO,EAAE,KAAK,IAAI,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACjF,OAAO,EAAE,UAAU,IAAI,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAChG,OAAO,EAAE,eAAe,EAAE,MAAM,6CAA6C,CAAC;AAC9E,OAAO,EAAE,oBAAoB,EAAE,MAAM,mDAAmD,CAAC;AACzF,OAAO,EAAE,qBAAqB,EAAE,MAAM,oDAAoD,CAAC;AAC3F,OAAO,EACL,0BAA0B,IAAI,6BAA6B,EAC3D,0BAA0B,IAAI,6BAA6B,EAC3D,qBAAqB,IAAI,gCAAgC,EAC1D,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,+CAA+C,CAAC;AACjF,OAAO,KAAK,EAAE,2BAA2B,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AACrJ,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,kDAAkD,CAAC;AACjG,OAAO,EAAE,iBAAiB,EAAE,MAAM,kDAAkD,CAAC;AACrF,OAAO,EAAE,uBAAuB,EAAE,MAAM,wDAAwD,CAAC;AACjG,OAAO,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAC1E,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAC;AACxF,OAAO,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAC;AAC5E,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,yCAAyC,CAAC;AAChG,OAAO,EAAE,UAAU,IAAI,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AAClG,OAAO,KAAK,EAAE,qBAAqB,EAAE,6BAA6B,EAAE,MAAM,gDAAgD,CAAC;AAC3H,OAAO,EAAE,sBAAsB,EAAE,MAAM,gDAAgD,CAAC;AACxF,OAAO,EAAE,mBAAmB,EAAE,MAAM,gDAAgD,CAAC;AACrF,OAAO,EAAE,qBAAqB,EAAE,MAAM,kDAAkD,CAAC;AAGzF,UAAU,WAAW;IACnB,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7B,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtC;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,yBAAyB;QACjC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;KAC5B;IAED,UAAU,SAAU,SAAQ,eAAe;QACzC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;QAC7B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;KACtB;IAED,UAAU,gCAAgC;QACxC,IAAI,EAAE,SAAS,CAAC;KACjB;CACF;AAED,OAAO,EAEL,oBAAoB,EACpB,mBAAmB,EACnB,wBAAwB,EACxB,eAAe,EAEf,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAChB,6BAA6B,EAC7B,6BAA6B,EAC7B,gCAAgC,EAEhC,iBAAiB,EACjB,uBAAuB,EAEvB,eAAe,EACf,gBAAgB,EAEhB,sBAAsB,EAEtB,qBAAqB,EACrB,mBAAmB,EAEnB,yBAAyB,GAC1B,CAAC;AAEF,YAAY,EAEV,0BAA0B,EAC1B,wBAAwB,EAExB,2BAA2B,EAC3B,gBAAgB,EAChB,yBAAyB,EACzB,gBAAgB,EAEhB,wBAAwB,EAExB,uBAAuB,EAEvB,qBAAqB,EACrB,6BAA6B,EAE7B,gCAAgC,GACjC,CAAC"}