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

package/src/utils/createCacheKey.ts

@@ -1,68 +0,0 @@
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-
-import { SerwistError } from "@serwist/core/internal";
-
-import type { PrecacheEntry } from "../_types.js";
-
-interface CacheKey {
-  cacheKey: string;
-  url: string;
-}
-
-// Name of the search parameter used to store revision info.
-const REVISION_SEARCH_PARAM = "__WB_REVISION__";
-
-/**
- * Converts a manifest entry into a versioned URL suitable for precaching.
- *
- * @param entry
- * @returns A URL with versioning info.
- *
- * @private
- */
-export function createCacheKey(entry: PrecacheEntry | string): CacheKey {
-  if (!entry) {
-    throw new SerwistError("add-to-cache-list-unexpected-type", { entry });
-  }
-
-  // If a precache manifest entry is a string, it's assumed to be a versioned
-  // URL, like '/app.abcd1234.js'. Return as-is.
-  if (typeof entry === "string") {
-    const urlObject = new URL(entry, location.href);
-    return {
-      cacheKey: urlObject.href,
-      url: urlObject.href,
-    };
-  }
-
-  const { revision, url } = entry;
-  if (!url) {
-    throw new SerwistError("add-to-cache-list-unexpected-type", { entry });
-  }
-
-  // If there's just a URL and no revision, then it's also assumed to be a
-  // versioned URL.
-  if (!revision) {
-    const urlObject = new URL(url, location.href);
-    return {
-      cacheKey: urlObject.href,
-      url: urlObject.href,
-    };
-  }
-
-  // Otherwise, construct a properly versioned URL using the custom Serwist
-  // search parameter along with the revision info.
-  const cacheKeyURL = new URL(url, location.href);
-  const originalURL = new URL(url, location.href);
-  cacheKeyURL.searchParams.set(REVISION_SEARCH_PARAM, revision);
-  return {
-    cacheKey: cacheKeyURL.href,
-    url: originalURL.href,
-  };
-}

package/src/utils/deleteOutdatedCaches.ts

@@ -1,40 +0,0 @@
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-
-// Give TypeScript the correct global.
-declare let self: ServiceWorkerGlobalScope;
-
-const SUBSTRING_TO_FIND = "-precache-";
-
-/**
- * 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 const deleteOutdatedCaches = async (currentPrecacheName: string, substringToFind: string = SUBSTRING_TO_FIND): Promise<string[]> => {
-  const cacheNames = await self.caches.keys();
-
-  const cacheNamesToDelete = cacheNames.filter((cacheName) => {
-    return cacheName.includes(substringToFind) && cacheName.includes(self.registration.scope) && cacheName !== currentPrecacheName;
-  });
-
-  await Promise.all(cacheNamesToDelete.map((cacheName) => self.caches.delete(cacheName)));
-
-  return cacheNamesToDelete;
-};

package/src/utils/generateURLVariations.ts

@@ -1,55 +0,0 @@
-/*
-  Copyright 2019 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-
-import type { PrecacheRouteOptions } from "../_types.js";
-import { removeIgnoredSearchParams } from "./removeIgnoredSearchParams.js";
-
-/**
- * Generator function that yields possible variations on the original URL to
- * check, one at a time.
- *
- * @param url
- * @param options
- *
- * @private
- */
-export function* generateURLVariations(
-  url: string,
-  {
-    ignoreURLParametersMatching = [/^utm_/, /^fbclid$/],
-    directoryIndex = "index.html",
-    cleanURLs = true,
-    urlManipulation,
-  }: PrecacheRouteOptions = {},
-): Generator<string, void, unknown> {
-  const urlObject = new URL(url, location.href);
-  urlObject.hash = "";
-  yield urlObject.href;
-
-  const urlWithoutIgnoredParams = removeIgnoredSearchParams(urlObject, ignoreURLParametersMatching);
-  yield urlWithoutIgnoredParams.href;
-
-  if (directoryIndex && urlWithoutIgnoredParams.pathname.endsWith("/")) {
-    const directoryURL = new URL(urlWithoutIgnoredParams.href);
-    directoryURL.pathname += directoryIndex;
-    yield directoryURL.href;
-  }
-
-  if (cleanURLs) {
-    const cleanURL = new URL(urlWithoutIgnoredParams.href);
-    cleanURL.pathname += ".html";
-    yield cleanURL.href;
-  }
-
-  if (urlManipulation) {
-    const additionalURLs = urlManipulation({ url: urlObject });
-    for (const urlToAttempt of additionalURLs) {
-      yield urlToAttempt.href;
-    }
-  }
-}

package/src/utils/getCacheKeyForURL.ts

@@ -1,36 +0,0 @@
-/*
-  Copyright 2019 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-
-import type { PrecacheRouteOptions } from "../_types.js";
-import { generateURLVariations } from "./generateURLVariations.js";
-import { getOrCreatePrecacheController } from "./getOrCreatePrecacheController.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 const getCacheKeyForURL = (url: string, options: PrecacheRouteOptions): string | undefined => {
-  const precacheController = getOrCreatePrecacheController();
-
-  const urlsToCacheKeys = precacheController.getURLsToCacheKeys();
-  for (const possibleURL of generateURLVariations(url, options)) {
-    const possibleCacheKey = urlsToCacheKeys.get(possibleURL);
-    if (possibleCacheKey) {
-      return possibleCacheKey;
-    }
-  }
-
-  return undefined;
-};

package/src/utils/getOrCreatePrecacheController.ts

@@ -1,22 +0,0 @@
-/*
-  Copyright 2019 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-
-import { PrecacheController } from "../PrecacheController.js";
-
-let precacheController: PrecacheController | undefined;
-
-/**
- * @returns
- * @private
- */
-export const getOrCreatePrecacheController = (): PrecacheController => {
-  if (!precacheController) {
-    precacheController = new PrecacheController();
-  }
-  return precacheController;
-};

package/src/utils/printCleanupDetails.ts

@@ -1,38 +0,0 @@
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-
-import { logger } from "@serwist/core/internal";
-
-/**
- * @param groupTitle
- * @param deletedURLs
- *
- * @private
- */
-const logGroup = (groupTitle: string, deletedURLs: string[]) => {
-  logger.groupCollapsed(groupTitle);
-
-  for (const url of deletedURLs) {
-    logger.log(url);
-  }
-
-  logger.groupEnd();
-};
-
-/**
- * @param deletedURLs
- * @private
- */
-export function printCleanupDetails(deletedURLs: string[]): void {
-  const deletionCount = deletedURLs.length;
-  if (deletionCount > 0) {
-    logger.groupCollapsed(`During precaching cleanup, ${deletionCount} cached request${deletionCount === 1 ? " was" : "s were"} deleted.`);
-    logGroup("Deleted Cache Requests", deletedURLs);
-    logger.groupEnd();
-  }
-}

package/src/utils/printInstallDetails.ts

@@ -1,53 +0,0 @@
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-
-import { logger } from "@serwist/core/internal";
-
-/**
- * @param groupTitle
- * @param urls
- *
- * @private
- */
-function _nestedGroup(groupTitle: string, urls: string[]): void {
-  if (urls.length === 0) {
-    return;
-  }
-
-  logger.groupCollapsed(groupTitle);
-
-  for (const url of urls) {
-    logger.log(url);
-  }
-
-  logger.groupEnd();
-}
-
-/**
- * @param urlsToPrecache
- * @param  urlsAlreadyPrecached
- * @private
- */
-export function printInstallDetails(urlsToPrecache: string[], urlsAlreadyPrecached: string[]): void {
-  const precachedCount = urlsToPrecache.length;
-  const alreadyPrecachedCount = urlsAlreadyPrecached.length;
-
-  if (precachedCount || alreadyPrecachedCount) {
-    let message = `Precaching ${precachedCount} file${precachedCount === 1 ? "" : "s"}.`;
-
-    if (alreadyPrecachedCount > 0) {
-      message += ` ${alreadyPrecachedCount} ` + `file${alreadyPrecachedCount === 1 ? " is" : "s are"} already cached.`;
-    }
-
-    logger.groupCollapsed(message);
-
-    _nestedGroup("View newly precached URLs.", urlsToPrecache);
-    _nestedGroup("View previously precached URLs.", urlsAlreadyPrecached);
-    logger.groupEnd();
-  }
-}

package/src/utils/removeIgnoredSearchParams.ts

@@ -1,29 +0,0 @@
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-
-/**
- * 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 function removeIgnoredSearchParams(urlObject: URL, ignoreURLParametersMatching: RegExp[] = []): URL {
-  // Convert the iterable into an array at the start of the loop to make sure
-  // deletion doesn't mess up iteration.
-  for (const paramName of [...urlObject.searchParams.keys()]) {
-    if (ignoreURLParametersMatching.some((regExp) => regExp.test(paramName))) {
-      urlObject.searchParams.delete(paramName);
-    }
-  }
-
-  return urlObject;
-}