serwist 10.0.0-preview.1 → 10.0.0-preview.11

package/src/controllers/PrecacheController/PrecacheRoute.ts

@@ -1,44 +0,0 @@
-/*
-  Copyright 2020 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 { Route } from "../../Route.js";
-import type { RouteMatchCallback, RouteMatchCallbackOptions } from "../../types.js";
-import { generateURLVariations } from "../../utils/generateURLVariations.js";
-import { getFriendlyURL } from "../../utils/getFriendlyURL.js";
-import { logger } from "../../utils/logger.js";
-import type { PrecacheController, PrecacheRouteOptions } from "./PrecacheController.js";
-
-/**
- * A subclass of {@linkcode Route} that takes a {@linkcode Serwist} instance and uses it to match
- * incoming requests and handle fetching responses from the precache.
- */
-export class PrecacheRoute extends Route {
-  /**
-   * @param controller A {@linkcode PrecacheController} instance.
-   * @param options Options to control how requests are matched
-   * against the list of precached URLs.
-   */
-  constructor(controller: PrecacheController, options?: PrecacheRouteOptions) {
-    const match: RouteMatchCallback = ({ request }: RouteMatchCallbackOptions) => {
-      const urlsToCacheKeys = controller.getUrlsToPrecacheKeys();
-      for (const possibleURL of generateURLVariations(request.url, options)) {
-        const cacheKey = urlsToCacheKeys.get(possibleURL);
-        if (cacheKey) {
-          const integrity = controller.getIntegrityForPrecacheKey(cacheKey);
-          return { cacheKey, integrity };
-        }
-      }
-      if (process.env.NODE_ENV !== "production") {
-        logger.debug(`Precaching did not find a match for ${getFriendlyURL(request.url)}.`);
-      }
-      return;
-    };
-
-    super(match, controller.strategy);
-  }
-}

package/src/copyResponse.ts

@@ -1,58 +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 { SerwistError } from "./utils/SerwistError.js";
-import { canConstructResponseFromBodyStream } from "./utils/canConstructResponseFromBodyStream.js";
-
-/**
- * Allows developers to copy a response and modify its `headers`, `status`,
- * or `statusText` values (the [valid options](https://developer.mozilla.org/en-US/docs/Web/API/Response/Response#options)
- * when constructing a `Response` object).
- * To modify these values, pass a function as the second argument. That
- * function will be invoked with the options of the initial `Response` object.
- * The return value of this function will be used as the options for the new `Response` object.
- * To change the values either modify the passed parameter(s) and return it or return a totally
- * new object.
- *
- * This method is intentionally limited to same-origin responses, regardless of
- * whether CORS was used or not.
- *
- * @param response The initial response.
- * @param modifier The function used to modify the options of the `Response` object.
- */
-export const copyResponse = async (response: Response, modifier?: (responseInit: ResponseInit) => ResponseInit): Promise<Response> => {
-  let origin = null;
-  // If response.url isn't set, assume it's cross-origin and keep origin null.
-  if (response.url) {
-    const responseURL = new URL(response.url);
-    origin = responseURL.origin;
-  }
-
-  if (origin !== self.location.origin) {
-    throw new SerwistError("cross-origin-copy-response", { origin });
-  }
-
-  const clonedResponse = response.clone();
-
-  // Create a fresh `ResponseInit` object by cloning the headers.
-  const responseInit: ResponseInit = {
-    headers: new Headers(clonedResponse.headers),
-    status: clonedResponse.status,
-    statusText: clonedResponse.statusText,
-  };
-
-  // Apply any user modifications.
-  const modifiedResponseInit = modifier ? modifier(responseInit) : responseInit;
-
-  // Create the new response from the body stream and `ResponseInit`
-  // modifications. Note: not all browsers support the Response.body stream,
-  // so fall back to reading the entire body into memory as a blob.
-  const body = canConstructResponseFromBodyStream() ? clonedResponse.body : await clonedResponse.blob();
-
-  return new Response(body, modifiedResponseInit);
-};

package/src/disableDevLogs.ts

@@ -1,10 +0,0 @@
-declare const self: ServiceWorkerGlobalScope;
-
-/**
- * Disables Serwist's logging in development mode.
- *
- * @see https://serwist.pages.dev/docs/serwist/core/disable-dev-logs
- */
-export const disableDevLogs = (): void => {
-  self.__WB_DISABLE_DEV_LOGS = true;
-};

package/src/registerQuotaErrorCallback.ts

@@ -1,34 +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 { quotaErrorCallbacks } from "./models/quotaErrorCallbacks.js";
-import { assert } from "./utils/assert.js";
-import { logger } from "./utils/logger.js";
-
-/**
- * Adds a function to the set of quotaErrorCallbacks that will be executed if
- * there's a quota error.
- *
- * @param callback
- */
-// biome-ignore lint/complexity/noBannedTypes: Can't change Function type
-export const registerQuotaErrorCallback = (callback: Function): void => {
-  if (process.env.NODE_ENV !== "production") {
-    assert!.isType(callback, "function", {
-      moduleName: "@serwist/core",
-      funcName: "register",
-      paramName: "callback",
-    });
-  }
-
-  quotaErrorCallbacks.add(callback);
-
-  if (process.env.NODE_ENV !== "production") {
-    logger.log("Registered a callback to respond to quota errors.", callback);
-  }
-};

package/src/setCacheNameDetails.ts

@@ -1,53 +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 { SerwistError } from "./utils/SerwistError.js";
-import { assert } from "./utils/assert.js";
-import type { PartialCacheNameDetails } from "./utils/cacheNames.js";
-import { cacheNames } from "./utils/cacheNames.js";
-
-/**
- * Modifies the default cache names used by Serwist packages.
- * Cache names are generated as `<prefix>-<Cache Name>-<suffix>`.
- *
- * @param details
- */
-export const setCacheNameDetails = (details: PartialCacheNameDetails): void => {
-  if (process.env.NODE_ENV !== "production") {
-    for (const key of Object.keys(details)) {
-      assert!.isType(details[key], "string", {
-        moduleName: "@serwist/core",
-        funcName: "setCacheNameDetails",
-        paramName: `details.${key}`,
-      });
-    }
-
-    if (details.precache?.length === 0) {
-      throw new SerwistError("invalid-cache-name", {
-        cacheNameId: "precache",
-        value: details.precache,
-      });
-    }
-
-    if (details.runtime?.length === 0) {
-      throw new SerwistError("invalid-cache-name", {
-        cacheNameId: "runtime",
-        value: details.runtime,
-      });
-    }
-
-    if (details.googleAnalytics?.length === 0) {
-      throw new SerwistError("invalid-cache-name", {
-        cacheNameId: "googleAnalytics",
-        value: details.googleAnalytics,
-      });
-    }
-  }
-
-  cacheNames.updateDetails(details);
-};