@serwist/sw 9.0.0-preview.21 → 9.0.0-preview.25

package/dist/chunks/singletonRouter.js

@@ -1,435 +0,0 @@
-import { assert, logger, SerwistError, getFriendlyURL } from '@serwist/core/internal';
-
-const defaultMethod = "GET";
-const validMethods = [
-    "DELETE",
-    "GET",
-    "HEAD",
-    "PATCH",
-    "POST",
-    "PUT"
-];
-
-const normalizeHandler = (handler)=>{
-    if (handler && typeof handler === "object") {
-        if (process.env.NODE_ENV !== "production") {
-            assert.hasMethod(handler, "handle", {
-                moduleName: "@serwist/routing",
-                className: "Route",
-                funcName: "constructor",
-                paramName: "handler"
-            });
-        }
-        return handler;
-    }
-    if (process.env.NODE_ENV !== "production") {
-        assert.isType(handler, "function", {
-            moduleName: "@serwist/routing",
-            className: "Route",
-            funcName: "constructor",
-            paramName: "handler"
-        });
-    }
-    return {
-        handle: handler
-    };
-};
-
-class Route {
-    handler;
-    match;
-    method;
-    catchHandler;
-    constructor(match, handler, method = defaultMethod){
-        if (process.env.NODE_ENV !== "production") {
-            assert.isType(match, "function", {
-                moduleName: "@serwist/routing",
-                className: "Route",
-                funcName: "constructor",
-                paramName: "match"
-            });
-            if (method) {
-                assert.isOneOf(method, validMethods, {
-                    paramName: "method"
-                });
-            }
-        }
-        this.handler = normalizeHandler(handler);
-        this.match = match;
-        this.method = method;
-    }
-    setCatchHandler(handler) {
-        this.catchHandler = normalizeHandler(handler);
-    }
-}
-
-class RegExpRoute extends Route {
-    constructor(regExp, handler, method){
-        if (process.env.NODE_ENV !== "production") {
-            assert.isInstance(regExp, RegExp, {
-                moduleName: "@serwist/routing",
-                className: "RegExpRoute",
-                funcName: "constructor",
-                paramName: "pattern"
-            });
-        }
-        const match = ({ url })=>{
-            const result = regExp.exec(url.href);
-            if (!result) {
-                return;
-            }
-            if (url.origin !== location.origin && result.index !== 0) {
-                if (process.env.NODE_ENV !== "production") {
-                    logger.debug(`The regular expression '${regExp.toString()}' only partially matched against the cross-origin URL '${url.toString()}'. RegExpRoute's will only handle cross-origin requests if they match the entire URL.`);
-                }
-                return;
-            }
-            return result.slice(1);
-        };
-        super(match, handler, method);
-    }
-}
-
-const parseRoute = (capture, handler, method)=>{
-    let route;
-    if (typeof capture === "string") {
-        const captureUrl = new URL(capture, location.href);
-        if (process.env.NODE_ENV !== "production") {
-            if (!(capture.startsWith("/") || capture.startsWith("http"))) {
-                throw new SerwistError("invalid-string", {
-                    moduleName: "@serwist/routing",
-                    funcName: "registerRoute",
-                    paramName: "capture"
-                });
-            }
-            const valueToCheck = capture.startsWith("http") ? captureUrl.pathname : capture;
-            const wildcards = "[*:?+]";
-            if (new RegExp(`${wildcards}`).exec(valueToCheck)) {
-                logger.debug(`The '$capture' parameter contains an Express-style wildcard character (${wildcards}). Strings are now always interpreted as exact matches; use a RegExp for partial or wildcard matches.`);
-            }
-        }
-        const matchCallback = ({ url })=>{
-            if (process.env.NODE_ENV !== "production") {
-                if (url.pathname === captureUrl.pathname && url.origin !== captureUrl.origin) {
-                    logger.debug(`${capture} only partially matches the cross-origin URL ${url.toString()}. This route will only handle cross-origin requests if they match the entire URL.`);
-                }
-            }
-            return url.href === captureUrl.href;
-        };
-        route = new Route(matchCallback, handler, method);
-    } else if (capture instanceof RegExp) {
-        route = new RegExpRoute(capture, handler, method);
-    } else if (typeof capture === "function") {
-        route = new Route(capture, handler, method);
-    } else if (capture instanceof Route) {
-        route = capture;
-    } else {
-        throw new SerwistError("unsupported-route-type", {
-            moduleName: "@serwist/routing",
-            funcName: "registerRoute",
-            paramName: "capture"
-        });
-    }
-    return route;
-};
-
-class Router {
-    _routes;
-    _defaultHandlerMap;
-    _fetchListenerHandler = null;
-    _cacheListenerHandler = null;
-    _catchHandler;
-    constructor(){
-        this._routes = new Map();
-        this._defaultHandlerMap = new Map();
-    }
-    get routes() {
-        return this._routes;
-    }
-    addFetchListener() {
-        if (!this._fetchListenerHandler) {
-            this._fetchListenerHandler = (event)=>{
-                const { request } = event;
-                const responsePromise = this.handleRequest({
-                    request,
-                    event
-                });
-                if (responsePromise) {
-                    event.respondWith(responsePromise);
-                }
-            };
-            self.addEventListener("fetch", this._fetchListenerHandler);
-        }
-    }
-    removeFetchListener() {
-        if (this._fetchListenerHandler) {
-            self.removeEventListener("fetch", this._fetchListenerHandler);
-            this._fetchListenerHandler = null;
-        }
-    }
-    addCacheListener() {
-        if (!this._cacheListenerHandler) {
-            this._cacheListenerHandler = (event)=>{
-                if (event.data && event.data.type === "CACHE_URLS") {
-                    const { payload } = event.data;
-                    if (process.env.NODE_ENV !== "production") {
-                        logger.debug("Caching URLs from the window", payload.urlsToCache);
-                    }
-                    const requestPromises = Promise.all(payload.urlsToCache.map((entry)=>{
-                        if (typeof entry === "string") {
-                            entry = [
-                                entry
-                            ];
-                        }
-                        const request = new Request(...entry);
-                        return this.handleRequest({
-                            request,
-                            event
-                        });
-                    }));
-                    event.waitUntil(requestPromises);
-                    if (event.ports?.[0]) {
-                        void requestPromises.then(()=>event.ports[0].postMessage(true));
-                    }
-                }
-            };
-            self.addEventListener("message", this._cacheListenerHandler);
-        }
-    }
-    removeCacheListener() {
-        if (this._cacheListenerHandler) {
-            self.removeEventListener("message", this._cacheListenerHandler);
-        }
-    }
-    handleRequest({ request, event }) {
-        if (process.env.NODE_ENV !== "production") {
-            assert.isInstance(request, Request, {
-                moduleName: "@serwist/routing",
-                className: "Router",
-                funcName: "handleRequest",
-                paramName: "options.request"
-            });
-        }
-        const url = new URL(request.url, location.href);
-        if (!url.protocol.startsWith("http")) {
-            if (process.env.NODE_ENV !== "production") {
-                logger.debug("Router only supports URLs that start with 'http'.");
-            }
-            return;
-        }
-        const sameOrigin = url.origin === location.origin;
-        const { params, route } = this.findMatchingRoute({
-            event,
-            request,
-            sameOrigin,
-            url
-        });
-        let handler = route?.handler;
-        const debugMessages = [];
-        if (process.env.NODE_ENV !== "production") {
-            if (handler) {
-                debugMessages.push([
-                    "Found a route to handle this request:",
-                    route
-                ]);
-                if (params) {
-                    debugMessages.push([
-                        `Passing the following params to the route's handler:`,
-                        params
-                    ]);
-                }
-            }
-        }
-        const method = request.method;
-        if (!handler && this._defaultHandlerMap.has(method)) {
-            if (process.env.NODE_ENV !== "production") {
-                debugMessages.push(`Failed to find a matching route. Falling back to the default handler for ${method}.`);
-            }
-            handler = this._defaultHandlerMap.get(method);
-        }
-        if (!handler) {
-            if (process.env.NODE_ENV !== "production") {
-                logger.debug(`No route found for: ${getFriendlyURL(url)}`);
-            }
-            return;
-        }
-        if (process.env.NODE_ENV !== "production") {
-            logger.groupCollapsed(`Router is responding to: ${getFriendlyURL(url)}`);
-            for (const msg of debugMessages){
-                if (Array.isArray(msg)) {
-                    logger.log(...msg);
-                } else {
-                    logger.log(msg);
-                }
-            }
-            logger.groupEnd();
-        }
-        let responsePromise;
-        try {
-            responsePromise = handler.handle({
-                url,
-                request,
-                event,
-                params
-            });
-        } catch (err) {
-            responsePromise = Promise.reject(err);
-        }
-        const catchHandler = route?.catchHandler;
-        if (responsePromise instanceof Promise && (this._catchHandler || catchHandler)) {
-            responsePromise = responsePromise.catch(async (err)=>{
-                if (catchHandler) {
-                    if (process.env.NODE_ENV !== "production") {
-                        logger.groupCollapsed(`Error thrown when responding to:  ${getFriendlyURL(url)}. Falling back to route's Catch Handler.`);
-                        logger.error("Error thrown by:", route);
-                        logger.error(err);
-                        logger.groupEnd();
-                    }
-                    try {
-                        return await catchHandler.handle({
-                            url,
-                            request,
-                            event,
-                            params
-                        });
-                    } catch (catchErr) {
-                        if (catchErr instanceof Error) {
-                            err = catchErr;
-                        }
-                    }
-                }
-                if (this._catchHandler) {
-                    if (process.env.NODE_ENV !== "production") {
-                        logger.groupCollapsed(`Error thrown when responding to:  ${getFriendlyURL(url)}. Falling back to global Catch Handler.`);
-                        logger.error("Error thrown by:", route);
-                        logger.error(err);
-                        logger.groupEnd();
-                    }
-                    return this._catchHandler.handle({
-                        url,
-                        request,
-                        event
-                    });
-                }
-                throw err;
-            });
-        }
-        return responsePromise;
-    }
-    findMatchingRoute({ url, sameOrigin, request, event }) {
-        const routes = this._routes.get(request.method) || [];
-        for (const route of routes){
-            let params;
-            const matchResult = route.match({
-                url,
-                sameOrigin,
-                request,
-                event
-            });
-            if (matchResult) {
-                if (process.env.NODE_ENV !== "production") {
-                    if (matchResult instanceof Promise) {
-                        logger.warn(`While routing ${getFriendlyURL(url)}, an async matchCallback function was used. Please convert the following route to use a synchronous matchCallback function:`, route);
-                    }
-                }
-                params = matchResult;
-                if (Array.isArray(params) && params.length === 0) {
-                    params = undefined;
-                } else if (matchResult.constructor === Object && Object.keys(matchResult).length === 0) {
-                    params = undefined;
-                } else if (typeof matchResult === "boolean") {
-                    params = undefined;
-                }
-                return {
-                    route,
-                    params
-                };
-            }
-        }
-        return {};
-    }
-    setDefaultHandler(handler, method = defaultMethod) {
-        this._defaultHandlerMap.set(method, normalizeHandler(handler));
-    }
-    setCatchHandler(handler) {
-        this._catchHandler = normalizeHandler(handler);
-    }
-    registerCapture(capture, handler, method) {
-        const route = parseRoute(capture, handler, method);
-        this.registerRoute(route);
-        return route;
-    }
-    registerRoute(route) {
-        if (process.env.NODE_ENV !== "production") {
-            assert.isType(route, "object", {
-                moduleName: "@serwist/routing",
-                className: "Router",
-                funcName: "registerRoute",
-                paramName: "route"
-            });
-            assert.hasMethod(route, "match", {
-                moduleName: "@serwist/routing",
-                className: "Router",
-                funcName: "registerRoute",
-                paramName: "route"
-            });
-            assert.isType(route.handler, "object", {
-                moduleName: "@serwist/routing",
-                className: "Router",
-                funcName: "registerRoute",
-                paramName: "route"
-            });
-            assert.hasMethod(route.handler, "handle", {
-                moduleName: "@serwist/routing",
-                className: "Router",
-                funcName: "registerRoute",
-                paramName: "route.handler"
-            });
-            assert.isType(route.method, "string", {
-                moduleName: "@serwist/routing",
-                className: "Router",
-                funcName: "registerRoute",
-                paramName: "route.method"
-            });
-        }
-        if (!this._routes.has(route.method)) {
-            this._routes.set(route.method, []);
-        }
-        this._routes.get(route.method).push(route);
-    }
-    unregisterRoute(route) {
-        if (!this._routes.has(route.method)) {
-            throw new SerwistError("unregister-route-but-not-found-with-method", {
-                method: route.method
-            });
-        }
-        const routeIndex = this._routes.get(route.method).indexOf(route);
-        if (routeIndex > -1) {
-            this._routes.get(route.method).splice(routeIndex, 1);
-        } else {
-            throw new SerwistError("unregister-route-route-not-registered");
-        }
-    }
-}
-
-let defaultRouter = undefined;
-const getSingletonRouter = ()=>{
-    if (!defaultRouter) {
-        defaultRouter = new Router();
-        defaultRouter.addFetchListener();
-        defaultRouter.addCacheListener();
-    }
-    return defaultRouter;
-};
-const setSingletonRouter = (router)=>{
-    if (defaultRouter) {
-        defaultRouter.removeFetchListener();
-        defaultRouter.removeCacheListener();
-    }
-    defaultRouter = router;
-    defaultRouter.addFetchListener();
-    defaultRouter.addCacheListener();
-    return defaultRouter;
-};
-
-export { Route as R, RegExpRoute as a, Router as b, getSingletonRouter as g, parseRoute as p, setSingletonRouter as s };

package/dist/index.plugins.d.ts

@@ -1,41 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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"}