@serwist/precaching 8.0.0

package/dist/matchPrecache.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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
+ */
+declare function matchPrecache(request: string | Request): Promise<Response | undefined>;
+export { matchPrecache };
+//# sourceMappingURL=matchPrecache.d.ts.map

package/dist/matchPrecache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchPrecache.d.ts","sourceRoot":"","sources":["../src/matchPrecache.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;GAWG;AACH,iBAAS,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAG/E;AAED,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist/precache.d.ts

@@ -0,0 +1,20 @@
+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.
+ */
+declare function precache(entries: Array<PrecacheEntry | string>): void;
+export { precache };
+//# sourceMappingURL=precache.d.ts.map

package/dist/precache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"precache.d.ts","sourceRoot":"","sources":["../src/precache.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAGjD;;;;;;;;;;;;;;;GAeG;AACH,iBAAS,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,aAAa,GAAG,MAAM,CAAC,GAAG,IAAI,CAG9D;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/dist/precacheAndRoute.d.ts

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

package/dist/precacheAndRoute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"precacheAndRoute.d.ts","sourceRoot":"","sources":["../src/precacheAndRoute.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAIvE;;;;;;;;;;GAUG;AACH,iBAAS,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,aAAa,GAAG,MAAM,CAAC,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAGtG;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"createCacheKey.d.ts","sourceRoot":"","sources":["../../src/utils/createCacheKey.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAElD,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/utils/deleteOutdatedCaches.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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
+ */
+declare const deleteOutdatedCaches: (currentPrecacheName: string, substringToFind?: string) => Promise<string[]>;
+export { deleteOutdatedCaches };
+//# sourceMappingURL=deleteOutdatedCaches.d.ts.map

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

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

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

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

package/dist/utils/getCacheKeyForURL.d.ts

@@ -0,0 +1,14 @@
+import type { PrecacheRouteOptions } from "../_types.js";
+/**
+ * This function will take the request URL and manipulate it based on the
+ * configuration options.
+ *
+ * @param url
+ * @param options
+ * @returns Returns the URL in the cache that matches the request,
+ * if possible.
+ *
+ * @private
+ */
+export declare const getCacheKeyForURL: (url: string, options: PrecacheRouteOptions) => string | void;
+//# sourceMappingURL=getCacheKeyForURL.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getCacheKeyForURL.d.ts","sourceRoot":"","sources":["../../src/utils/getCacheKeyForURL.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAIzD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,iBAAiB,QAAS,MAAM,WAAW,oBAAoB,KAAG,MAAM,GAAG,IAUvF,CAAC"}

package/dist/utils/getOrCreatePrecacheController.d.ts

@@ -0,0 +1,7 @@
+import { PrecacheController } from "../PrecacheController.js";
+/**
+ * @returns
+ * @private
+ */
+export declare const getOrCreatePrecacheController: () => PrecacheController;
+//# sourceMappingURL=getOrCreatePrecacheController.d.ts.map

package/dist/utils/getOrCreatePrecacheController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getOrCreatePrecacheController.d.ts","sourceRoot":"","sources":["../../src/utils/getOrCreatePrecacheController.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAI9D;;;GAGG;AACH,eAAO,MAAM,6BAA6B,QAAO,kBAKhD,CAAC"}

package/dist/utils/printCleanupDetails.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @param deletedURLs
+ * @private
+ */
+export declare function printCleanupDetails(deletedURLs: string[]): void;
+//# sourceMappingURL=printCleanupDetails.d.ts.map

package/dist/utils/printCleanupDetails.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"printCleanupDetails.d.ts","sourceRoot":"","sources":["../../src/utils/printCleanupDetails.ts"],"names":[],"mappings":"AA0BA;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI,CAO/D"}

package/dist/utils/printInstallDetails.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @param urlsToPrecache
+ * @param  urlsAlreadyPrecached
+ * @private
+ */
+export declare function printInstallDetails(urlsToPrecache: string[], urlsAlreadyPrecached: string[]): void;
+//# sourceMappingURL=printInstallDetails.d.ts.map

package/dist/utils/printInstallDetails.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"printInstallDetails.d.ts","sourceRoot":"","sources":["../../src/utils/printInstallDetails.ts"],"names":[],"mappings":"AA8BA;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,oBAAoB,EAAE,MAAM,EAAE,GAAG,IAAI,CAiBlG"}

package/dist/utils/removeIgnoredSearchParams.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Removes any URL search parameters that should be ignored.
+ *
+ * @param urlObject The original URL.
+ * @param ignoreURLParametersMatching RegExps to test against
+ * each search parameter name. Matches mean that the search parameter should be
+ * ignored.
+ * @returns The URL with any ignored search parameters removed.
+ * @private
+ */
+export declare function removeIgnoredSearchParams(urlObject: URL, ignoreURLParametersMatching?: RegExp[]): URL;
+//# sourceMappingURL=removeIgnoredSearchParams.d.ts.map

package/dist/utils/removeIgnoredSearchParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"removeIgnoredSearchParams.d.ts","sourceRoot":"","sources":["../../src/utils/removeIgnoredSearchParams.ts"],"names":[],"mappings":"AAQA;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,GAAG,EAAE,2BAA2B,GAAE,MAAM,EAAO,GAAG,GAAG,CAUzG"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@serwist/precaching",
+  "version": "8.0.0",
+  "type": "module",
+  "description": "This module efficiently precaches assets.",
+  "files": [
+    "dist",
+    "!dist/**/dts"
+  ],
+  "keywords": [
+    "serwist",
+    "serwistjs",
+    "service worker",
+    "sw"
+  ],
+  "author": "Google's Web DevRel Team, Serwist's Team",
+  "license": "MIT",
+  "repository": "serwist/serwist",
+  "bugs": "https://github.com/serwist/serwist/issues",
+  "homepage": "https://ducanh-next-pwa.vercel.app",
+  "module": "./dist/index.js",
+  "main": "./dist/index.old.cjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.old.cjs",
+      "types": "./dist/index.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@serwist/core": "8.0.0",
+    "@serwist/routing": "8.0.0",
+    "@serwist/strategies": "8.0.0"
+  },
+  "devDependencies": {
+    "rollup": "3.28.1",
+    "@serwist/constants": "8.0.0"
+  },
+  "scripts": {
+    "build": "rimraf dist && cross-env NODE_ENV=production rollup --config rollup.config.js",
+    "lint": "eslint src --ext ts,tsx,js,jsx,cjs,mjs",
+    "typecheck": "tsc"
+  }
+}