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

package/dist/plugins/rangeRequests/RangeRequestsPlugin.d.ts

@@ -0,0 +1,19 @@
+import type { SerwistPlugin } from "@serwist/core";
+/**
+ * The range request plugin makes it easy for a request with a 'Range' header to
+ * be fulfilled by a cached response.
+ *
+ * It does this by intercepting the `cachedResponseWillBeUsed` plugin callback
+ * and returning the appropriate subset of the cached response body.
+ */
+export declare class RangeRequestsPlugin implements SerwistPlugin {
+    /**
+     * @param options
+     * @returns If request contains a 'Range' header, then a
+     * new response with status 206 whose body is a subset of `cachedResponse` is
+     * returned. Otherwise, `cachedResponse` is returned as-is.
+     * @private
+     */
+    cachedResponseWillBeUsed: SerwistPlugin["cachedResponseWillBeUsed"];
+}
+//# sourceMappingURL=RangeRequestsPlugin.d.ts.map

package/dist/plugins/rangeRequests/RangeRequestsPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RangeRequestsPlugin.d.ts","sourceRoot":"","sources":["../../../src/plugins/rangeRequests/RangeRequestsPlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAInD;;;;;;GAMG;AACH,qBAAa,mBAAoB,YAAW,aAAa;IACvD;;;;;;OAMG;IACH,wBAAwB,EAAE,aAAa,CAAC,0BAA0B,CAAC,CAUjE;CACH"}

package/dist/plugins/rangeRequests/createPartialResponse.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Given a `Request` and `Response` objects as input, this will return a
+ * promise for a new `Response`.
+ *
+ * If the original `Response` already contains partial content (i.e. it has
+ * a status of 206), then this assumes it already fulfills the `Range:`
+ * requirements, and will return it as-is.
+ *
+ * @param request A request, which should contain a Range:
+ * header.
+ * @param originalResponse A response.
+ * @returns Either a `206 Partial Content` response, with
+ * the response body set to the slice of content specified by the request's
+ * `Range:` header, or a `416 Range Not Satisfiable` response if the
+ * conditions of the `Range:` header can't be met.
+ */
+export declare const createPartialResponse: (request: Request, originalResponse: Response) => Promise<Response>;
+//# sourceMappingURL=createPartialResponse.d.ts.map

package/dist/plugins/rangeRequests/createPartialResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPartialResponse.d.ts","sourceRoot":"","sources":["../../../src/plugins/rangeRequests/createPartialResponse.ts"],"names":[],"mappings":"AAaA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,qBAAqB,YAAmB,OAAO,oBAAoB,QAAQ,KAAG,QAAQ,QAAQ,CA8D1G,CAAC"}

package/dist/plugins/rangeRequests/utils/calculateEffectiveBoundaries.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @param blob A source blob.
+ * @param start The offset to use as the start of the
+ * slice.
+ * @param end The offset to use as the end of the slice.
+ * @returns An object with `start` and `end` properties, reflecting
+ * the effective boundaries to use given the size of the blob.
+ * @private
+ */
+export declare const calculateEffectiveBoundaries: (blob: Blob, start?: number, end?: number) => {
+    start: number;
+    end: number;
+};
+//# sourceMappingURL=calculateEffectiveBoundaries.d.ts.map

package/dist/plugins/rangeRequests/utils/calculateEffectiveBoundaries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculateEffectiveBoundaries.d.ts","sourceRoot":"","sources":["../../../../src/plugins/rangeRequests/utils/calculateEffectiveBoundaries.ts"],"names":[],"mappings":"AAUA;;;;;;;;GAQG;AACH,eAAO,MAAM,4BAA4B,SAAU,IAAI,UAAU,MAAM,QAAQ,MAAM;WAAY,MAAM;SAAO,MAAM;CAsCnH,CAAC"}

package/dist/plugins/rangeRequests/utils/parseRangeHeader.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @param rangeHeader A Range: header value.
+ * @returns An object with `start` and `end` properties, reflecting
+ * the parsed value of the Range: header. If either the `start` or `end` are
+ * omitted, then `null` will be returned.
+ * @private
+ */
+export declare const parseRangeHeader: (rangeHeader: string) => {
+    start?: number;
+    end?: number;
+};
+//# sourceMappingURL=parseRangeHeader.d.ts.map

package/dist/plugins/rangeRequests/utils/parseRangeHeader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseRangeHeader.d.ts","sourceRoot":"","sources":["../../../../src/plugins/rangeRequests/utils/parseRangeHeader.ts"],"names":[],"mappings":"AAUA;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,gBACd,MAAM,KAClB;IACD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;CAgCd,CAAC"}

package/dist/precaching/PrecacheController.d.ts

@@ -0,0 +1,145 @@
+import type { RouteHandlerCallback, SerwistPlugin } from "@serwist/core";
+import type { Strategy } from "../strategies/Strategy.js";
+import type { CleanupResult, InstallResult, PrecacheEntry } from "./types.js";
+interface PrecacheControllerOptions {
+    /**
+     * The cache to use for precaching.
+     */
+    cacheName?: string;
+    /**
+     * Plugins to use when precaching as well as responding to fetch
+     * events for precached assets.
+     */
+    plugins?: SerwistPlugin[];
+    /**
+     * Whether to attempt to get the response from the network if there's
+     * a precache miss.
+     */
+    fallbackToNetwork?: boolean;
+    /**
+     * A number of how many precache requests should be made concurrently.
+     *
+     * @default 1
+     */
+    concurrentPrecaching?: number;
+}
+/**
+ * Performs efficient precaching of assets.
+ */
+export declare class PrecacheController {
+    private _installAndActiveListenersAdded?;
+    private _concurrentPrecaching;
+    private readonly _strategy;
+    private readonly _urlsToCacheKeys;
+    private readonly _urlsToCacheModes;
+    private readonly _cacheKeysToIntegrities;
+    /**
+     * Create a new PrecacheController.
+     *
+     * @param options
+     */
+    constructor({ cacheName, plugins, fallbackToNetwork, concurrentPrecaching }?: PrecacheControllerOptions);
+    /**
+     * The strategy created by this controller and
+     * used to cache assets and respond to fetch events.
+     */
+    get strategy(): Strategy;
+    /**
+     * Adds items to the precache list, removing any duplicates and
+     * stores the files in the precache cache when the service
+     * worker installs.
+     *
+     * This method can be called multiple times.
+     *
+     * @param entries Array of entries to precache.
+     */
+    precache(entries: (PrecacheEntry | string)[]): void;
+    /**
+     * This method will add items to the precache list, removing duplicates
+     * and ensuring the information is valid.
+     *
+     * @param entries Array of entries to precache.
+     */
+    addToCacheList(entries: (PrecacheEntry | string)[]): void;
+    /**
+     * Precaches new and updated assets. Call this method from the service worker
+     * install event.
+     *
+     * Note: this method calls `event.waitUntil()` for you, so you do not need
+     * to call it yourself in your event handlers.
+     *
+     * @param event
+     * @returns
+     */
+    install(event: ExtendableEvent): Promise<InstallResult>;
+    /**
+     * Deletes assets that are no longer present in the current precache manifest.
+     * Call this method from the service worker activate event.
+     *
+     * Note: this method calls `event.waitUntil()` for you, so you do not need
+     * to call it yourself in your event handlers.
+     *
+     * @param event
+     * @returns
+     */
+    activate(event: ExtendableEvent): Promise<CleanupResult>;
+    /**
+     * Returns a mapping of a precached URL to the corresponding cache key, taking
+     * into account the revision information for the URL.
+     *
+     * @returns A URL to cache key mapping.
+     */
+    getURLsToCacheKeys(): Map<string, string>;
+    /**
+     * Returns a list of all the URLs that have been precached by the current
+     * service worker.
+     *
+     * @returns The precached URLs.
+     */
+    getCachedURLs(): string[];
+    /**
+     * Returns the cache key used for storing a given URL. If that URL is
+     * unversioned, like `/index.html', then the cache key will be the original
+     * URL with a search parameter appended to it.
+     *
+     * @param url A URL whose cache key you want to look up.
+     * @returns The versioned URL that corresponds to a cache key
+     * for the original URL, or undefined if that URL isn't precached.
+     */
+    getCacheKeyForURL(url: string): string | undefined;
+    /**
+     * @param url A cache key whose SRI you want to look up.
+     * @returns The subresource integrity associated with the cache key,
+     * or undefined if it's not set.
+     */
+    getIntegrityForCacheKey(cacheKey: string): string | undefined;
+    /**
+     * This acts as a drop-in replacement for
+     * [`cache.match()`](https://developer.mozilla.org/en-US/docs/Web/API/Cache/match)
+     * with the following differences:
+     *
+     * - It knows what the name of the precache is, and only checks in that cache.
+     * - It allows you to pass in an "original" URL without versioning parameters,
+     * and it will automatically look up the correct cache key for the currently
+     * active revision of that URL.
+     *
+     * E.g., `matchPrecache('index.html')` will find the correct precached
+     * response for the currently active service worker, even if the actual cache
+     * key is `'/index.html?__WB_REVISION__=1234abcd'`.
+     *
+     * @param request The key (without revisioning parameters)
+     * to look up in the precache.
+     * @returns
+     */
+    matchPrecache(request: string | Request): Promise<Response | undefined>;
+    /**
+     * Returns a function that looks up `url` in the precache (taking into
+     * account revision information), and returns the corresponding `Response`.
+     *
+     * @param url The precached URL which will be used to lookup the response.
+     * @return
+     */
+    createHandlerBoundToURL(url: string): RouteHandlerCallback;
+}
+export {};
+//# sourceMappingURL=PrecacheController.d.ts.map

package/dist/precaching/PrecacheController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrecacheController.d.ts","sourceRoot":"","sources":["../../src/precaching/PrecacheController.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAGzE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAE1D,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAU9E,UAAU,yBAAyB;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,+BAA+B,CAAC,CAAU;IAClD,OAAO,CAAC,qBAAqB,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;IACrC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAkC;IACnE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA6G;IAC/I,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAkC;IAE1E;;;;OAIG;gBACS,EAAE,SAAS,EAAE,OAAY,EAAE,iBAAwB,EAAE,oBAAwB,EAAE,GAAE,yBAA8B;IAY3H;;;OAGG;IACH,IAAI,QAAQ,IAAI,QAAQ,CAEvB;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,aAAa,GAAG,MAAM,CAAC,EAAE,GAAG,IAAI;IAUnD;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE,CAAC,aAAa,GAAG,MAAM,CAAC,EAAE,GAAG,IAAI;IAwDzD;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC;IAmCvD;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC;IAuBxD;;;;;OAKG;IACH,kBAAkB,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IAIzC;;;;;OAKG;IACH,aAAa,IAAI,MAAM,EAAE;IAIzB;;;;;;;;OAQG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAKlD;;;;OAIG;IACH,uBAAuB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI7D;;;;;;;;;;;;;;;;;OAiBG;IACG,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;IAU7E;;;;;;OAMG;IACH,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,oBAAoB;CAY3D"}

package/dist/precaching/PrecacheRoute.d.ts

@@ -0,0 +1,20 @@
+import { Route } from "../routing/Route.js";
+import type { PrecacheController } from "./PrecacheController.js";
+import type { PrecacheRouteOptions } from "./types.js";
+/**
+ * A subclass of `@serwist/routing.Route` that takes a
+ * `@serwist/precaching.PrecacheController`
+ * instance and uses it to match incoming requests and handle fetching
+ * responses from the precache.
+ */
+declare class PrecacheRoute extends Route {
+    /**
+     * @param precacheController A `PrecacheController`
+     * instance used to both match requests and respond to fetch events.
+     * @param options Options to control how requests are matched
+     * against the list of precached URLs.
+     */
+    constructor(precacheController: PrecacheController, options?: PrecacheRouteOptions);
+}
+export { PrecacheRoute };
+//# sourceMappingURL=PrecacheRoute.d.ts.map

package/dist/precaching/PrecacheRoute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrecacheRoute.d.ts","sourceRoot":"","sources":["../../src/precaching/PrecacheRoute.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAE5C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAGvD;;;;;GAKG;AACH,cAAM,aAAc,SAAQ,KAAK;IAC/B;;;;;OAKG;gBACS,kBAAkB,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,oBAAoB;CAkBnF;AAED,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist/precaching/PrecacheStrategy.d.ts

@@ -0,0 +1,68 @@
+import type { SerwistPlugin } from "@serwist/core";
+import type { StrategyOptions } from "../strategies/Strategy.js";
+import { Strategy } from "../strategies/Strategy.js";
+import type { StrategyHandler } from "../strategies/StrategyHandler.js";
+interface PrecacheStrategyOptions extends StrategyOptions {
+    /**
+     * Whether to attempt to get the response from the network
+     * if there's a precache miss.
+     */
+    fallbackToNetwork?: boolean;
+}
+/**
+ * A `@serwist/strategies.Strategy` implementation
+ * specifically designed to work with
+ * `@serwist/precaching.PrecacheController`
+ * to both cache and fetch precached assets.
+ *
+ * Note: an instance of this class is created automatically when creating a
+ * `PrecacheController`; it's generally not necessary to create this yourself.
+ */
+export declare class PrecacheStrategy extends Strategy {
+    private readonly _fallbackToNetwork;
+    static readonly defaultPrecacheCacheabilityPlugin: SerwistPlugin;
+    static readonly copyRedirectedCacheableResponsesPlugin: SerwistPlugin;
+    /**
+     * @param options
+     */
+    constructor(options?: PrecacheStrategyOptions);
+    /**
+     * @private
+     * @param request A request to run this strategy for.
+     * @param handler The event that triggered the request.
+     * @returns
+     */
+    _handle(request: Request, handler: StrategyHandler): Promise<Response>;
+    _handleFetch(request: Request, handler: StrategyHandler): Promise<Response>;
+    _handleInstall(request: Request, handler: StrategyHandler): Promise<Response>;
+    /**
+     * This method is complex, as there a number of things to account for:
+     *
+     * The `plugins` array can be set at construction, and/or it might be added to
+     * to at any time before the strategy is used.
+     *
+     * At the time the strategy is used (i.e. during an `install` event), there
+     * needs to be at least one plugin that implements `cacheWillUpdate` in the
+     * array, other than `copyRedirectedCacheableResponsesPlugin`.
+     *
+     * - If this method is called and there are no suitable `cacheWillUpdate`
+     * plugins, we need to add `defaultPrecacheCacheabilityPlugin`.
+     *
+     * - If this method is called and there is exactly one `cacheWillUpdate`, then
+     * we don't have to do anything (this might be a previously added
+     * `defaultPrecacheCacheabilityPlugin`, or it might be a custom plugin).
+     *
+     * - If this method is called and there is more than one `cacheWillUpdate`,
+     * then we need to check if one is `defaultPrecacheCacheabilityPlugin`. If so,
+     * we need to remove it. (This situation is unlikely, but it could happen if
+     * the strategy is used multiple times, the first without a `cacheWillUpdate`,
+     * and then later on after manually adding a custom `cacheWillUpdate`.)
+     *
+     * See https://github.com/GoogleChrome/workbox/issues/2737 for more context.
+     *
+     * @private
+     */
+    _useDefaultCacheabilityPluginIfNeeded(): void;
+}
+export {};
+//# sourceMappingURL=PrecacheStrategy.d.ts.map

package/dist/precaching/PrecacheStrategy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrecacheStrategy.d.ts","sourceRoot":"","sources":["../../src/precaching/PrecacheStrategy.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAGnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AAExE,UAAU,uBAAwB,SAAQ,eAAe;IACvD;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;GAQG;AACH,qBAAa,gBAAiB,SAAQ,QAAQ;IAC5C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAU;IAE7C,MAAM,CAAC,QAAQ,CAAC,iCAAiC,EAAE,aAAa,CAQ9D;IAEF,MAAM,CAAC,QAAQ,CAAC,sCAAsC,EAAE,aAAa,CAInE;IAEF;;OAEG;gBACS,OAAO,GAAE,uBAA4B;IAajD;;;;;OAKG;IACG,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAiBtE,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAwE3E,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAoBnF;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,qCAAqC,IAAI,IAAI;CA4B9C"}

package/dist/precaching/addPlugins.d.ts

@@ -0,0 +1,8 @@
+import type { SerwistPlugin } from "@serwist/core";
+/**
+ * Adds plugins to the precaching strategy.
+ *
+ * @param plugins
+ */
+export declare const addPlugins: (plugins: SerwistPlugin[]) => void;
+//# sourceMappingURL=addPlugins.d.ts.map

package/dist/precaching/addPlugins.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addPlugins.d.ts","sourceRoot":"","sources":["../../src/precaching/addPlugins.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAInD;;;;GAIG;AACH,eAAO,MAAM,UAAU,YAAa,aAAa,EAAE,KAAG,IAGrD,CAAC"}

package/dist/precaching/addRoute.d.ts

@@ -0,0 +1,15 @@
+import type { PrecacheRouteOptions } from "./types.js";
+/**
+ * Add a `fetch` listener to the service worker that will
+ * respond to
+ * [network requests](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API/Using_Service_Workers#Custom_responses_to_requests)
+ * with precached assets.
+ *
+ * Requests for assets that aren't precached, the `FetchEvent` will not be
+ * responded to, allowing the event to fall through to other `fetch` event
+ * listeners.
+ *
+ * @param options See the `@serwist/precaching.PrecacheRoute` options.
+ */
+export declare const addRoute: (options?: PrecacheRouteOptions) => void;
+//# sourceMappingURL=addRoute.d.ts.map

package/dist/precaching/addRoute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addRoute.d.ts","sourceRoot":"","sources":["../../src/precaching/addRoute.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAGvD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,QAAQ,aAAc,oBAAoB,KAAG,IAKzD,CAAC"}

package/dist/precaching/cleanupOutdatedCaches.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Adds an `activate` event listener which will clean up incompatible
+ * precaches that were created by older versions of Serwist.
+ */
+export declare const cleanupOutdatedCaches: () => void;
+//# sourceMappingURL=cleanupOutdatedCaches.d.ts.map

package/dist/precaching/cleanupOutdatedCaches.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cleanupOutdatedCaches.d.ts","sourceRoot":"","sources":["../../src/precaching/cleanupOutdatedCaches.ts"],"names":[],"mappings":"AAcA;;;GAGG;AACH,eAAO,MAAM,qBAAqB,QAAO,IAcxC,CAAC"}

package/dist/precaching/createHandlerBoundToURL.d.ts

@@ -0,0 +1,17 @@
+import type { RouteHandlerCallback } from "@serwist/core";
+/**
+ * Helper function that calls `PrecacheController#createHandlerBoundToURL`
+ * on the default `PrecacheController` instance.
+ *
+ * If you are creating your own `PrecacheController`, then call the
+ * `PrecacheController#createHandlerBoundToURL` on that instance,
+ * instead of using this function.
+ *
+ * @param url The precached URL which will be used to lookup the
+ * `Response`.
+ * @param fallbackToNetwork Whether to attempt to get the
+ * response from the network if there's a precache miss.
+ * @return
+ */
+export declare const createHandlerBoundToURL: (url: string) => RouteHandlerCallback;
+//# sourceMappingURL=createHandlerBoundToURL.d.ts.map

package/dist/precaching/createHandlerBoundToURL.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createHandlerBoundToURL.d.ts","sourceRoot":"","sources":["../../src/precaching/createHandlerBoundToURL.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAI1D;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,uBAAuB,QAAS,MAAM,KAAG,oBAGrD,CAAC"}

package/dist/precaching/getCacheKeyForURL.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Takes in a URL, and returns the corresponding URL that could be used to
+ * lookup the entry in the precache.
+ *
+ * If a relative URL is provided, the location of the service worker file will
+ * be used as the base.
+ *
+ * For precached entries without revision information, the cache key will be the
+ * same as the original URL.
+ *
+ * For precached entries with revision information, the cache key will be the
+ * original URL with the addition of a query parameter used for keeping track of
+ * the revision info.
+ *
+ * @param url The URL whose cache key to look up.
+ * @returns The cache key that corresponds to that URL.
+ */
+declare function getCacheKeyForURL(url: string): string | undefined;
+export { getCacheKeyForURL };
+//# sourceMappingURL=getCacheKeyForURL.d.ts.map

package/dist/precaching/getCacheKeyForURL.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCacheKeyForURL.d.ts","sourceRoot":"","sources":["../../src/precaching/getCacheKeyForURL.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;;;;GAgBG;AACH,iBAAS,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAG1D;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/precaching/matchPrecache.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Helper function that calls `PrecacheController#matchPrecache`
+ * on the default `PrecacheController` instance.
+ *
+ * If you are creating your own `PrecacheController`, then call
+ * `PrecacheController#matchPrecache` on that instance,
+ * instead of using this function.
+ *
+ * @param request The key (without revisioning parameters)
+ * to look up in the precache.
+ * @returns
+ */
+export declare const matchPrecache: (request: string | Request) => Promise<Response | undefined>;
+//# sourceMappingURL=matchPrecache.d.ts.map

package/dist/precaching/matchPrecache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchPrecache.d.ts","sourceRoot":"","sources":["../../src/precaching/matchPrecache.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,aAAa,YAAa,MAAM,GAAG,OAAO,KAAG,QAAQ,QAAQ,GAAG,SAAS,CAGrF,CAAC"}

package/dist/precaching/precache.d.ts

@@ -0,0 +1,19 @@
+import type { PrecacheEntry } from "./types.js";
+/**
+ * Adds items to the precache list, removing any duplicates and
+ * stores the files in the precache cache when the service
+ * worker installs.
+ *
+ * This method can be called multiple times.
+ *
+ * Please note: This method **will not** serve any of the cached files for you.
+ * It only precaches files. To respond to a network request you call
+ * `@serwist/precaching.addRoute`.
+ *
+ * If you have a single array of files to precache, you can just call
+ * `@serwist/precaching.precacheAndRoute`.
+ *
+ * @param entries Array of entries to precache.
+ */
+export declare const precache: (entries: (PrecacheEntry | string)[]) => void;
+//# sourceMappingURL=precache.d.ts.map

package/dist/precaching/precache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"precache.d.ts","sourceRoot":"","sources":["../../src/precaching/precache.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAGhD;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,QAAQ,YAAa,CAAC,aAAa,GAAG,MAAM,CAAC,EAAE,KAAG,IAG9D,CAAC"}

package/dist/precaching/precacheAndRoute.d.ts

@@ -0,0 +1,14 @@
+import type { PrecacheEntry, PrecacheRouteOptions } from "./types.js";
+/**
+ * This method will add entries to the precache list and add a route to
+ * respond to fetch events.
+ *
+ * This is a convenience method that will call
+ * `@serwist/precaching.precache` and
+ * `@serwist/precaching.addRoute` in a single call.
+ *
+ * @param entries Array of entries to precache.
+ * @param options See the `@serwist/precaching.PrecacheRoute` options.
+ */
+export declare const precacheAndRoute: (entries: (PrecacheEntry | string)[], options?: PrecacheRouteOptions) => void;
+//# sourceMappingURL=precacheAndRoute.d.ts.map

package/dist/precaching/precacheAndRoute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"precacheAndRoute.d.ts","sourceRoot":"","sources":["../../src/precaching/precacheAndRoute.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAEtE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,YAAa,CAAC,aAAa,GAAG,MAAM,CAAC,EAAE,YAAY,oBAAoB,KAAG,IAGtG,CAAC"}

package/dist/precaching/types.d.ts

@@ -0,0 +1,37 @@
+export interface InstallResult {
+    updatedURLs: string[];
+    notUpdatedURLs: string[];
+}
+export interface CleanupResult {
+    deletedCacheRequests: string[];
+}
+export declare interface PrecacheEntry {
+    integrity?: string;
+    url: string;
+    revision?: string | null;
+}
+export interface PrecacheRouteOptions {
+    /**
+     * The `directoryIndex` will check cache entries for a URL ending with '/'
+     * to see if there is a hit when appending the `directoryIndex` value.
+     */
+    directoryIndex?: string | null;
+    /**
+     * An array of RegExp's to remove search params when looking for a cache match.
+     */
+    ignoreURLParametersMatching?: RegExp[];
+    /**
+     * The `cleanURLs` option will check the cache for the URL with a `.html` added
+     * to the end of the end.
+     */
+    cleanURLs?: boolean;
+    /**
+     * This is a function that should take a URL and return an array of
+     * alternative URLs that should be checked for precache matches.
+     */
+    urlManipulation?: UrlManipulation;
+}
+export type UrlManipulation = ({ url }: {
+    url: URL;
+}) => URL[];
+//# sourceMappingURL=types.d.ts.map

package/dist/precaching/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/precaching/types.ts"],"names":[],"mappings":"AAQA,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,aAAa;IAC5B,oBAAoB,EAAE,MAAM,EAAE,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,aAAa;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,EAAE,CAAC;IACvC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED,MAAM,MAAM,eAAe,GAAG,CAAC,EAAE,GAAG,EAAE,EAAE;IAAE,GAAG,EAAE,GAAG,CAAA;CAAE,KAAK,GAAG,EAAE,CAAC"}

package/dist/precaching/utils/PrecacheCacheKeyPlugin.d.ts

@@ -0,0 +1,17 @@
+import type { SerwistPlugin } from "@serwist/core";
+import type { PrecacheController } from "../PrecacheController.js";
+/**
+ * A plugin, designed to be used with PrecacheController, to translate URLs into
+ * the corresponding cache key, based on the current revision info.
+ *
+ * @private
+ */
+declare class PrecacheCacheKeyPlugin implements SerwistPlugin {
+    private readonly _precacheController;
+    constructor({ precacheController }: {
+        precacheController: PrecacheController;
+    });
+    cacheKeyWillBeUsed: SerwistPlugin["cacheKeyWillBeUsed"];
+}
+export { PrecacheCacheKeyPlugin };
+//# sourceMappingURL=PrecacheCacheKeyPlugin.d.ts.map

package/dist/precaching/utils/PrecacheCacheKeyPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrecacheCacheKeyPlugin.d.ts","sourceRoot":"","sources":["../../../src/precaching/utils/PrecacheCacheKeyPlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAA8B,MAAM,eAAe,CAAC;AAE/E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAEnE;;;;;GAKG;AACH,cAAM,sBAAuB,YAAW,aAAa;IACnD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAqB;gBAE7C,EAAE,kBAAkB,EAAE,EAAE;QAAE,kBAAkB,EAAE,kBAAkB,CAAA;KAAE;IAI9E,kBAAkB,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAOrD;CACH;AAED,OAAO,EAAE,sBAAsB,EAAE,CAAC"}

package/dist/precaching/utils/PrecacheInstallReportPlugin.d.ts

@@ -0,0 +1,15 @@
+import type { SerwistPlugin } from "@serwist/core";
+/**
+ * A plugin, designed to be used with PrecacheController, to determine the
+ * of assets that were updated (or not updated) during the install event.
+ *
+ * @private
+ */
+declare class PrecacheInstallReportPlugin implements SerwistPlugin {
+    updatedURLs: string[];
+    notUpdatedURLs: string[];
+    handlerWillStart: SerwistPlugin["handlerWillStart"];
+    cachedResponseWillBeUsed: SerwistPlugin["cachedResponseWillBeUsed"];
+}
+export { PrecacheInstallReportPlugin };
+//# sourceMappingURL=PrecacheInstallReportPlugin.d.ts.map

package/dist/precaching/utils/PrecacheInstallReportPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrecacheInstallReportPlugin.d.ts","sourceRoot":"","sources":["../../../src/precaching/utils/PrecacheInstallReportPlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAA8B,MAAM,eAAe,CAAC;AAE/E;;;;;GAKG;AACH,cAAM,2BAA4B,YAAW,aAAa;IACxD,WAAW,EAAE,MAAM,EAAE,CAAM;IAC3B,cAAc,EAAE,MAAM,EAAE,CAAM;IAE9B,gBAAgB,EAAE,aAAa,CAAC,kBAAkB,CAAC,CAKjD;IAEF,wBAAwB,EAAE,aAAa,CAAC,0BAA0B,CAAC,CAkBjE;CACH;AAED,OAAO,EAAE,2BAA2B,EAAE,CAAC"}

package/dist/precaching/utils/createCacheKey.d.ts

@@ -0,0 +1,16 @@
+import type { PrecacheEntry } from "../types.js";
+interface CacheKey {
+    cacheKey: string;
+    url: string;
+}
+/**
+ * Converts a manifest entry into a versioned URL suitable for precaching.
+ *
+ * @param entry
+ * @returns A URL with versioning info.
+ *
+ * @private
+ */
+export declare function createCacheKey(entry: PrecacheEntry | string): CacheKey;
+export {};
+//# sourceMappingURL=createCacheKey.d.ts.map

package/dist/precaching/utils/createCacheKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createCacheKey.d.ts","sourceRoot":"","sources":["../../../src/precaching/utils/createCacheKey.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEjD,UAAU,QAAQ;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;CACb;AAKD;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,aAAa,GAAG,MAAM,GAAG,QAAQ,CAuCtE"}

package/dist/precaching/utils/deleteOutdatedCaches.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Cleans up incompatible precaches that were created by older versions of
+ * Serwist, by a service worker registered under the current scope.
+ *
+ * This is meant to be called as part of the `activate` event.
+ *
+ * This should be safe to use as long as you don't include `substringToFind`
+ * (defaulting to `-precache-`) in your non-precache cache names.
+ *
+ * @param currentPrecacheName The cache name currently in use for
+ * precaching. This cache won't be deleted.
+ * @param substringToFind Cache names which include this
+ * substring will be deleted (excluding `currentPrecacheName`).
+ * @returns A list of all the cache names that were deleted.
+ * @private
+ */
+export declare const deleteOutdatedCaches: (currentPrecacheName: string, substringToFind?: string) => Promise<string[]>;
+//# sourceMappingURL=deleteOutdatedCaches.d.ts.map

package/dist/precaching/utils/deleteOutdatedCaches.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteOutdatedCaches.d.ts","sourceRoot":"","sources":["../../../src/precaching/utils/deleteOutdatedCaches.ts"],"names":[],"mappings":"AAaA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,oBAAoB,wBAA+B,MAAM,oBAAmB,MAAM,KAAuB,QAAQ,MAAM,EAAE,CAUrI,CAAC"}

package/dist/precaching/utils/generateURLVariations.d.ts

@@ -0,0 +1,12 @@
+import type { PrecacheRouteOptions } from "../types.js";
+/**
+ * Generator function that yields possible variations on the original URL to
+ * check, one at a time.
+ *
+ * @param url
+ * @param options
+ *
+ * @private
+ */
+export declare function generateURLVariations(url: string, { ignoreURLParametersMatching, directoryIndex, cleanURLs, urlManipulation, }?: PrecacheRouteOptions): Generator<string, void, unknown>;
+//# sourceMappingURL=generateURLVariations.d.ts.map

package/dist/precaching/utils/generateURLVariations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateURLVariations.d.ts","sourceRoot":"","sources":["../../../src/precaching/utils/generateURLVariations.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAGxD;;;;;;;;GAQG;AACH,wBAAiB,qBAAqB,CACpC,GAAG,EAAE,MAAM,EACX,EACE,2BAAmD,EACnD,cAA6B,EAC7B,SAAgB,EAChB,eAAe,GAChB,GAAE,oBAAyB,GAC3B,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CA0BlC"}