serwist 9.1.1 → 10.0.0-preview.10

package/src/legacy/singletonPrecacheController.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 { PrecacheController } from "./PrecacheController.js";
-
-let defaultPrecacheController: PrecacheController | undefined;
-
-/**
- * Creates a new, singleton {@linkcode PrecacheController} if one does not exist. If one does
- * already exist, that instance is returned. This instance is used by Serwist's
- * {@linkcode PrecacheController}-dependent functions and classes unless you provide a different
- * {@linkcode PrecacheController} to them.
- *
- * @returns The singleton {@linkcode PrecacheController}.
- * @deprecated
- */
-export const getSingletonPrecacheController = (): PrecacheController => {
-  if (!defaultPrecacheController) {
-    defaultPrecacheController = new PrecacheController();
-  }
-  return defaultPrecacheController;
-};
-
-/**
- * Changes the singleton {@linkcode PrecacheController} to a different instance. This is meant for when you do not
- * want to pass your own {@linkcode PrecacheController} to every one of Serwist's {@linkcode PrecacheController}-dependent
- * functions and classes.
- *
- * It is highly recommended that you call this before anything else, if you plan on doing so.
- *
- * @example
- * ```js
- * import { PrecacheController, setSingletonPrecacheController } from "serwist/legacy";
- *
- * const controller = new PrecacheController();
- *
- * setSingletonPrecacheController(controller);
- *
- * // Do something with your controller...
- * ```
- * @param router
- * @returns The new singleton {@linkcode PrecacheController}.
- * @deprecated
- */
-export const setSingletonPrecacheController = (precacheController: PrecacheController): PrecacheController => {
-  defaultPrecacheController = precacheController;
-  return defaultPrecacheController;
-};

package/src/legacy/singletonRouter.ts

@@ -1,70 +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 { Router } from "./Router.js";
-
-let defaultRouter: Router | undefined;
-
-/**
- * Creates a new, singleton {@linkcode Router} if one does not exist. If one does
- * already exist, that instance is returned. This instance is used by
- * Serwist's {@linkcode Router}-dependent functions and classes unless you provide
- * a different {@linkcode Router} to them.
- *
- * @returns The singleton {@linkcode Router}.
- * @deprecated
- */
-export const getSingletonRouter = (): Router => {
-  if (!defaultRouter) {
-    defaultRouter = new Router();
-
-    // The helpers that use the default Router assume these listeners exist.
-    defaultRouter.addFetchListener();
-    defaultRouter.addCacheListener();
-  }
-  return defaultRouter;
-};
-
-/**
- * Changes the singleton {@linkcode Router} to a different instance. This is meant for when you do not
- * want to pass your own {@linkcode Router} to every one of Serwist's {@linkcode Router}-dependent functions and classes.
- * If this or {@linkcode getSingletonRouter} has been called before, it removes the listeners of the
- * previous singleton {@linkcode Router}. It also adds those of the new one, so you need not do that yourself.
- *
- * It is highly recommended that you call this before anything else, if you plan on doing so.
- *
- * @example
- * ```js
- * import { Router, setSingletonRouter } from "serwist/legacy";
- *
- * const router = new Router();
- *
- * setSingletonRouter(router);
- *
- * router.registerRoute(
- *   new Route(
- *     /\/api\/.*\/*.json/,
- *     new NetworkOnly(),
- *     "POST",
- *   ),
- * );
- * ```
- * @param router
- * @returns The new singleton {@linkcode Router}.
- * @deprecated
- */
-export const setSingletonRouter = (router: Router): Router => {
-  if (defaultRouter) {
-    defaultRouter.removeFetchListener();
-    defaultRouter.removeCacheListener();
-  }
-  defaultRouter = router;
-  defaultRouter.addFetchListener();
-  defaultRouter.addCacheListener();
-  return defaultRouter;
-};

package/src/legacy/unregisterRoute.ts

@@ -1,13 +0,0 @@
-import type { Route } from "../Route.js";
-import type { Router } from "./Router.js";
-import { getSingletonRouter } from "./singletonRouter.js";
-
-/**
- * Unregisters a route from the singleton {@linkcode Router} instance.
- *
- * @param route The route to unregister.
- * @deprecated
- */
-export const unregisterRoute = (route: Route): void => {
-  getSingletonRouter().unregisterRoute(route);
-};

package/src/legacy/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 "../../utils/generateURLVariations.js";
-import { getSingletonPrecacheController } from "../singletonPrecacheController.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 = getSingletonPrecacheController();
-
-  const urlsToCacheKeys = precacheController.getURLsToCacheKeys();
-  for (const possibleURL of generateURLVariations(url, options)) {
-    const possibleCacheKey = urlsToCacheKeys.get(possibleURL);
-    if (possibleCacheKey) {
-      return possibleCacheKey;
-    }
-  }
-
-  return undefined;
-};

package/src/lib/googleAnalytics/constants.ts

@@ -1,22 +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.
-*/
-
-export const QUEUE_NAME = "serwist-google-analytics";
-export const MAX_RETENTION_TIME = 60 * 48; // Two days in minutes
-export const GOOGLE_ANALYTICS_HOST = "www.google-analytics.com";
-export const GTM_HOST = "www.googletagmanager.com";
-export const ANALYTICS_JS_PATH = "/analytics.js";
-export const GTAG_JS_PATH = "/gtag/js";
-export const GTM_JS_PATH = "/gtm.js";
-export const COLLECT_DEFAULT_PATH = "/collect";
-
-// This RegExp matches all known Measurement Protocol single-hit collect
-// endpoints. Most of the time the default path (/collect) is used, but
-// occasionally an experimental endpoint is used when testing new features,
-// (e.g. /r/collect or /j/collect)
-export const COLLECT_PATHS_REGEX = /^\/(\w+\/)?collect/;

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);
-};

package/src/utils/PrecacheCacheKeyPlugin.ts

@@ -1,33 +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 type { Serwist } from "../Serwist.js";
-import type { SerwistPlugin, SerwistPluginCallbackParam } from "../types.js";
-
-/**
- * A plugin, designed to be used with PrecacheController, to translate URLs into
- * the corresponding cache key, based on the current revision info.
- *
- * @private
- */
-export class PrecacheCacheKeyPlugin implements SerwistPlugin {
-  private readonly _precacheController: Serwist;
-
-  constructor({ precacheController }: { precacheController: Serwist }) {
-    this._precacheController = precacheController;
-  }
-
-  cacheKeyWillBeUsed: SerwistPlugin["cacheKeyWillBeUsed"] = async ({ request, params }: SerwistPluginCallbackParam["cacheKeyWillBeUsed"]) => {
-    // Params is type any, can't change right now.
-    /* eslint-disable */
-    const cacheKey = params?.cacheKey || this._precacheController.getPrecacheKeyForUrl(request.url);
-    /* eslint-enable */
-
-    return cacheKey ? new Request(cacheKey, { headers: request.headers }) : request;
-  };
-}

package/src/utils/parsePrecacheOptions.ts

@@ -1,47 +0,0 @@
-import { privateCacheNames } from "../index.internal.js";
-import type { PrecacheStrategyOptions } from "../lib/strategies/PrecacheStrategy.js";
-import type { Serwist } from "../Serwist.js";
-import type { PrecacheOptions, PrecacheRouteOptions } from "../types.js";
-import { PrecacheCacheKeyPlugin } from "./PrecacheCacheKeyPlugin.js";
-
-export const parsePrecacheOptions = (serwist: Serwist, precacheOptions: PrecacheOptions = {}) => {
-  const {
-    cacheName: precacheCacheName,
-    plugins: precachePlugins = [],
-    fetchOptions: precacheFetchOptions,
-    matchOptions: precacheMatchOptions,
-    fallbackToNetwork: precacheFallbackToNetwork,
-    directoryIndex: precacheDirectoryIndex,
-    ignoreURLParametersMatching: precacheIgnoreUrls,
-    cleanURLs: precacheCleanUrls,
-    urlManipulation: precacheUrlManipulation,
-    cleanupOutdatedCaches,
-    concurrency = 10,
-    navigateFallback,
-    navigateFallbackAllowlist,
-    navigateFallbackDenylist,
-  } = precacheOptions ?? {};
-
-  return {
-    precacheStrategyOptions: {
-      cacheName: privateCacheNames.getPrecacheName(precacheCacheName),
-      plugins: [...precachePlugins, new PrecacheCacheKeyPlugin({ precacheController: serwist })],
-      fetchOptions: precacheFetchOptions,
-      matchOptions: precacheMatchOptions,
-      fallbackToNetwork: precacheFallbackToNetwork,
-    } satisfies PrecacheStrategyOptions,
-    precacheRouteOptions: {
-      directoryIndex: precacheDirectoryIndex,
-      ignoreURLParametersMatching: precacheIgnoreUrls,
-      cleanURLs: precacheCleanUrls,
-      urlManipulation: precacheUrlManipulation,
-    } satisfies PrecacheRouteOptions,
-    precacheMiscOptions: {
-      cleanupOutdatedCaches,
-      concurrency,
-      navigateFallback,
-      navigateFallbackAllowlist,
-      navigateFallbackDenylist,
-    },
-  };
-};