@serwist/precaching 8.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Google LLC, 2019 ShadowWalker w@weiw.io https://weiw.io, 2023 Serwist
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+This module's documentation can be found at https://developers.google.com/web/tools/workbox/modules/workbox-precaching

package/dist/PrecacheController.d.ts

@@ -0,0 +1,138 @@
+import type { RouteHandlerCallback, SerwistPlugin } from "@serwist/core";
+import type { Strategy } from "@serwist/strategies";
+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;
+}
+/**
+ * Performs efficient precaching of assets.
+ */
+declare class PrecacheController {
+    private _installAndActiveListenersAdded?;
+    private readonly _strategy;
+    private readonly _urlsToCacheKeys;
+    private readonly _urlsToCacheModes;
+    private readonly _cacheKeysToIntegrities;
+    /**
+     * Create a new PrecacheController.
+     *
+     * @param options
+     */
+    constructor({ cacheName, plugins, fallbackToNetwork }?: 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: Array<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: Array<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(): Array<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 { PrecacheController };
+//# sourceMappingURL=PrecacheController.d.ts.map

package/dist/PrecacheController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrecacheController.d.ts","sourceRoot":"","sources":["../src/PrecacheController.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEzE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAW/E,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;CAC7B;AAED;;GAEG;AACH,cAAM,kBAAkB;IACtB,OAAO,CAAC,+BAA+B,CAAC,CAAU;IAClD,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,GAAE,yBAA8B;IAYjG;;;OAGG;IACH,IAAI,QAAQ,IAAI,QAAQ,CAEvB;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,aAAa,GAAG,MAAM,CAAC,GAAG,IAAI;IAUtD;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,aAAa,GAAG,MAAM,CAAC,GAAG,IAAI;IAyD5D;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC;IAsCvD;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC;IAwBxD;;;;;OAKG;IACH,kBAAkB,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IAIzC;;;;;OAKG;IACH,aAAa,IAAI,KAAK,CAAC,MAAM,CAAC;IAI9B;;;;;;;;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;AAED,OAAO,EAAE,kBAAkB,EAAE,CAAC"}

package/dist/PrecacheFallbackPlugin.d.ts

@@ -0,0 +1,44 @@
+import type { SerwistPlugin } from "@serwist/core";
+import type { PrecacheController } from "./PrecacheController.js";
+interface PrecacheFallbackPluginOptions {
+    /**
+     * A precached URL to use as the fallback
+     * if the associated strategy can't generate a response.
+     */
+    fallbackURL: string;
+    /**
+     * An optional
+     * PrecacheController instance. If not provided, the default
+     * PrecacheController will be used.
+     */
+    precacheController?: PrecacheController;
+}
+/**
+ * `PrecacheFallbackPlugin` allows you to specify an "offline fallback"
+ * response to be used when a given strategy is unable to generate a response.
+ *
+ * It does this by intercepting the `handlerDidError` plugin callback
+ * and returning a precached response, taking the expected revision parameter
+ * into account automatically.
+ *
+ * Unless you explicitly pass in a `PrecacheController` instance to the
+ * constructor, the default instance will be used. Generally speaking, most
+ * developers will end up using the default.
+ */
+declare class PrecacheFallbackPlugin implements SerwistPlugin {
+    private readonly _fallbackURL;
+    private readonly _precacheController;
+    /**
+     * Constructs a new PrecacheFallbackPlugin with the associated fallbackURL.
+     *
+     * @param config
+     */
+    constructor({ fallbackURL, precacheController }: PrecacheFallbackPluginOptions);
+    /**
+     * @returns The precache response for the fallback URL.
+     * @private
+     */
+    handlerDidError: SerwistPlugin["handlerDidError"];
+}
+export { PrecacheFallbackPlugin };
+//# sourceMappingURL=PrecacheFallbackPlugin.d.ts.map

package/dist/PrecacheFallbackPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrecacheFallbackPlugin.d.ts","sourceRoot":"","sources":["../src/PrecacheFallbackPlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAGlE,UAAU,6BAA6B;IACrC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC;AAED;;;;;;;;;;;GAWG;AACH,cAAM,sBAAuB,YAAW,aAAa;IACnD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAqB;IAEzD;;;;OAIG;gBACS,EAAE,WAAW,EAAE,kBAAkB,EAAE,EAAE,6BAA6B;IAK9E;;;OAGG;IACH,eAAe,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAmE;CACrH;AAED,OAAO,EAAE,sBAAsB,EAAE,CAAC"}

package/dist/PrecacheRoute.d.ts

@@ -0,0 +1,20 @@
+import { Route } from "@serwist/routing";
+import type { PrecacheRouteOptions } from "./_types.js";
+import type { PrecacheController } from "./PrecacheController.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/PrecacheRoute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrecacheRoute.d.ts","sourceRoot":"","sources":["../src/PrecacheRoute.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAGlE;;;;;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/PrecacheStrategy.d.ts

@@ -0,0 +1,67 @@
+import type { SerwistPlugin } from "@serwist/core";
+import type { StrategyHandler, StrategyOptions } from "@serwist/strategies";
+import { Strategy } from "@serwist/strategies";
+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.
+ */
+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 { PrecacheStrategy };
+//# sourceMappingURL=PrecacheStrategy.d.ts.map

package/dist/PrecacheStrategy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrecacheStrategy.d.ts","sourceRoot":"","sources":["../src/PrecacheStrategy.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAGnD,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C,UAAU,uBAAwB,SAAQ,eAAe;IACvD;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;GAQG;AACH,cAAM,gBAAiB,SAAQ,QAAQ;IACrC,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;IA0E3E,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAoBnF;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,qCAAqC,IAAI,IAAI;CA4B9C;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/_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 URLs ending with '/'
+     * to see if there is a hit when appending the `directoryIndex` value.
+     */
+    directoryIndex?: string;
+    /**
+     * 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/_types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_types.d.ts","sourceRoot":"","sources":["../src/_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,CAAC;IACxB;;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/addPlugins.d.ts

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

package/dist/addPlugins.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addPlugins.d.ts","sourceRoot":"","sources":["../src/addPlugins.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAInD;;;;GAIG;AACH,iBAAS,UAAU,CAAC,OAAO,EAAE,aAAa,EAAE,GAAG,IAAI,CAGlD;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/addRoute.d.ts

@@ -0,0 +1,16 @@
+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.
+ */
+declare function addRoute(options?: PrecacheRouteOptions): void;
+export { addRoute };
+//# sourceMappingURL=addRoute.d.ts.map

package/dist/addRoute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addRoute.d.ts","sourceRoot":"","sources":["../src/addRoute.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAIxD;;;;;;;;;;;GAWG;AACH,iBAAS,QAAQ,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAKtD;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/dist/cleanupOutdatedCaches.d.ts

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

package/dist/cleanupOutdatedCaches.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cleanupOutdatedCaches.d.ts","sourceRoot":"","sources":["../src/cleanupOutdatedCaches.ts"],"names":[],"mappings":"AAYA;;;GAGG;AACH,iBAAS,qBAAqB,IAAI,IAAI,CAerC;AAED,OAAO,EAAE,qBAAqB,EAAE,CAAC"}

package/dist/createHandlerBoundToURL.d.ts

@@ -0,0 +1,18 @@
+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
+ */
+declare function createHandlerBoundToURL(url: string): RouteHandlerCallback;
+export { createHandlerBoundToURL };
+//# sourceMappingURL=createHandlerBoundToURL.d.ts.map

package/dist/createHandlerBoundToURL.d.ts.map

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

package/dist/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/getCacheKeyForURL.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCacheKeyForURL.d.ts","sourceRoot":"","sources":["../src/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/index.d.ts

@@ -0,0 +1,25 @@
+import { addPlugins } from "./addPlugins.js";
+import { addRoute } from "./addRoute.js";
+import { cleanupOutdatedCaches } from "./cleanupOutdatedCaches.js";
+import { createHandlerBoundToURL } from "./createHandlerBoundToURL.js";
+import { getCacheKeyForURL } from "./getCacheKeyForURL.js";
+import { matchPrecache } from "./matchPrecache.js";
+import { precache } from "./precache.js";
+import { precacheAndRoute } from "./precacheAndRoute.js";
+import { PrecacheController } from "./PrecacheController.js";
+import { PrecacheFallbackPlugin } from "./PrecacheFallbackPlugin.js";
+import { PrecacheRoute } from "./PrecacheRoute.js";
+import { PrecacheStrategy } from "./PrecacheStrategy.js";
+/**
+ * Most consumers of this module will want to use the
+ * `@serwist/precaching.precacheAndRoute`
+ * method to add assets to the cache and respond to network requests with these
+ * cached assets.
+ *
+ * If you require more control over caching and routing, you can use the
+ * `@serwist/precaching.PrecacheController`
+ * interface.
+ */
+export { addPlugins, addRoute, cleanupOutdatedCaches, createHandlerBoundToURL, getCacheKeyForURL, matchPrecache, precache, precacheAndRoute, PrecacheController, PrecacheFallbackPlugin, PrecacheRoute, PrecacheStrategy, };
+export * from "./_types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD;;;;;;;;;GASG;AAEH,OAAO,EACL,UAAU,EACV,QAAQ,EACR,qBAAqB,EACrB,uBAAuB,EACvB,iBAAiB,EACjB,aAAa,EACb,QAAQ,EACR,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,EACtB,aAAa,EACb,gBAAgB,GACjB,CAAC;AAEF,cAAc,aAAa,CAAC"}