@serwist/core 9.0.0-preview.8 → 9.0.0

package/src/models/quotaErrorCallbacks.ts

@@ -1,13 +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.
-*/
-
-// Callbacks to be executed whenever there's a quota error.
-// biome-ignore lint/complexity/noBannedTypes: Can't change Function type right now.
-const quotaErrorCallbacks: Set<Function> = new Set();
-
-export { quotaErrorCallbacks };

package/src/registerQuotaErrorCallback.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 { assert } from "./_private/assert.js";
-import { logger } from "./_private/logger.js";
-import { quotaErrorCallbacks } from "./models/quotaErrorCallbacks.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
-function 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);
-  }
-}
-
-export { registerQuotaErrorCallback };

package/src/setCacheNameDetails.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 { SerwistError } from "./_private/SerwistError.js";
-import { assert } from "./_private/assert.js";
-import type { PartialCacheNameDetails } from "./_private/cacheNames.js";
-import { cacheNames } from "./_private/cacheNames.js";
-
-/**
- * Modifies the default cache names used by Serwist packages.
- * Cache names are generated as `<prefix>-<Cache Name>-<suffix>`.
- *
- * @param details
- */
-function 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);
-}
-
-export { setCacheNameDetails };

package/src/types.ts

@@ -1,322 +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.
-*/
-export type PromiseOrNot<T> = T | Promise<T>;
-
-export interface MapLikeObject {
-  [key: string]: any;
-}
-
-/**
- * Using a plain `MapLikeObject` for now, but could extend/restrict this
- * in the future.
- */
-export type PluginState = MapLikeObject;
-
-/**
- * Options passed to a `RouteMatchCallback` function.
- */
-export interface RouteMatchCallbackOptions {
-  event: ExtendableEvent;
-  request: Request;
-  sameOrigin: boolean;
-  url: URL;
-}
-
-/**
- * The "match" callback is used to determine if a `Route` should apply for a
- * particular URL and request. When matching occurs in response to a fetch
- * event from the client, the `event` object is also supplied. However, since
- * the match callback can be invoked outside of a fetch event, matching logic
- * should not assume the `event` object will always be available.
- * If the match callback returns a truthy value, the matching route's
- * `RouteHandlerCallback` will be invoked immediately. If the value returned
- * is a non-empty array or object, that value will be set on the handler's
- * `options.params` argument.
- */
-export interface RouteMatchCallback {
-  (options: RouteMatchCallbackOptions): any;
-}
-
-/**
- * Options passed to a `RouteHandlerCallback` function.
- */
-export declare interface RouteHandlerCallbackOptions {
-  /**
-   * The event associated with the request.
-   */
-  event: ExtendableEvent;
-  /**
-   * A request to run this strategy for.
-   */
-  request: Request;
-  url: URL;
-  /**
-   * The return value from `@serwist/routing`'s `matchCallback` (if applicable).
-   */
-  params?: string[] | MapLikeObject;
-}
-/**
- * Options passed to a `ManualHandlerCallback` function.
- */
-export interface ManualHandlerCallbackOptions {
-  /**
-   * The event associated with the request.
-   */
-  event: ExtendableEvent;
-  /**
-   * A request to run this strategy for.
-   */
-  request: Request | string;
-}
-
-export type HandlerCallbackOptions = RouteHandlerCallbackOptions | ManualHandlerCallbackOptions;
-
-/**
- * The "handler" callback is invoked whenever a `Router` matches a URL/Request
- * to a `Route` via its `RouteMatchCallback`. This handler callback should
- * return a `Promise` that resolves with a `Response`.
- *
- * If a non-empty array or object is returned by the `RouteMatchCallback` it
- * will be passed in as this handler's `options.params` argument.
- */
-export interface RouteHandlerCallback {
-  (options: RouteHandlerCallbackOptions): Promise<Response>;
-}
-
-/**
- * The "handler" callback is invoked whenever a `Router` matches a URL/Request
- * to a `Route` via its `RouteMatchCallback`. This handler callback should
- * return a `Promise` that resolves with a `Response`.
- *
- * If a non-empty array or object is returned by the `RouteMatchCallback` it
- * will be passed in as this handler's `options.params` argument.
- */
-export interface ManualHandlerCallback {
-  (options: ManualHandlerCallbackOptions): Promise<Response>;
-}
-
-/**
- * An object with a `handle` method of type `RouteHandlerCallback`.
- *
- * A `Route` object can be created with either an `RouteHandlerCallback`
- * function or this `RouteHandler` object. The benefit of the `RouteHandler`
- * is it can be extended (as is done by the `@serwist/strategies` package).
- */
-export interface RouteHandlerObject {
-  handle: RouteHandlerCallback;
-}
-
-/**
- * Either a `RouteHandlerCallback` or a `RouteHandlerObject`.
- * Most APIs in `@serwist/routing` that accept route handlers take either.
- */
-export type RouteHandler = RouteHandlerCallback | RouteHandlerObject;
-
-export interface HandlerWillStartCallbackParam {
-  request: Request;
-  event: ExtendableEvent;
-  state?: PluginState;
-}
-
-export interface HandlerWillStartCallback {
-  (param: HandlerWillStartCallbackParam): Promise<any>;
-}
-
-export interface CacheDidUpdateCallbackParam {
-  /**
-   * Name of the cache the responses belong to. This is included in the
-   * broadcast message.
-   */
-  cacheName: string;
-  /**
-   * Possibly updated response to compare.
-   */
-  newResponse: Response;
-  /**
-   * The `Request` object for the cached entry.
-   */
-  request: Request;
-  /**
-   * The event that triggered this possible cache update.
-   */
-  event: ExtendableEvent;
-  /**
-   * Cached response to compare.
-   */
-  oldResponse?: Response | null;
-  state?: PluginState;
-}
-
-export interface CacheDidUpdateCallback {
-  (param: CacheDidUpdateCallbackParam): PromiseOrNot<any>;
-}
-
-export interface CacheKeyWillBeUsedCallbackParam {
-  mode: string;
-  request: Request;
-  event: ExtendableEvent;
-  params?: any;
-  state?: PluginState;
-}
-
-export interface CacheKeyWillBeUsedCallback {
-  (param: CacheKeyWillBeUsedCallbackParam): PromiseOrNot<Request | string>;
-}
-
-export interface CacheWillUpdateCallbackParam {
-  request: Request;
-  response: Response;
-  event: ExtendableEvent;
-  state?: PluginState;
-}
-
-export interface CacheWillUpdateCallback {
-  (param: CacheWillUpdateCallbackParam): PromiseOrNot<any>;
-}
-
-export interface CachedResponseWillBeUsedCallbackParam {
-  /**
-   * Name of the cache the response is in.
-   */
-  cacheName: string;
-  /**
-   * The original request, which may or may not
-   * contain a Range: header.
-   */
-  request: Request;
-  /**
-   * The complete cached `Response` object that's been read
-   * from a cache and whose freshness should be checked.
-   */
-  cachedResponse?: Response;
-  event: ExtendableEvent;
-  matchOptions?: CacheQueryOptions;
-  state?: PluginState;
-}
-
-export interface CachedResponseWillBeUsedCallback {
-  (param: CachedResponseWillBeUsedCallbackParam): PromiseOrNot<any>;
-}
-
-export interface FetchDidFailCallbackParam {
-  error: Error;
-  originalRequest: Request;
-  request: Request;
-  event: ExtendableEvent;
-  state?: PluginState;
-}
-
-export interface FetchDidFailCallback {
-  (param: FetchDidFailCallbackParam): PromiseOrNot<any>;
-}
-
-export interface FetchDidSucceedCallbackParam {
-  request: Request;
-  response: Response;
-  event: ExtendableEvent;
-  state?: PluginState;
-}
-
-export interface FetchDidSucceedCallback {
-  (param: FetchDidSucceedCallbackParam): PromiseOrNot<Response>;
-}
-
-export interface RequestWillFetchCallbackParam {
-  request: Request;
-  event: ExtendableEvent;
-  state?: PluginState;
-}
-
-export interface RequestWillFetchCallback {
-  (param: RequestWillFetchCallbackParam): PromiseOrNot<Request>;
-}
-
-export interface HandlerWillRespondCallbackParam {
-  request: Request;
-  response: Response;
-  event: ExtendableEvent;
-  state?: PluginState;
-}
-
-export interface HandlerWillRespondCallback {
-  (param: HandlerWillRespondCallbackParam): PromiseOrNot<Response>;
-}
-
-export interface HandlerDidErrorCallbackParam {
-  request: Request;
-  event: ExtendableEvent;
-  error: Error;
-  state?: PluginState;
-}
-
-export interface HandlerDidErrorCallback {
-  (param: HandlerDidErrorCallbackParam): PromiseOrNot<Response | undefined>;
-}
-
-export interface HandlerDidRespondCallbackParam {
-  request: Request;
-  event: ExtendableEvent;
-  response?: Response;
-  state?: PluginState;
-}
-
-export interface HandlerDidRespondCallback {
-  (param: HandlerDidRespondCallbackParam): PromiseOrNot<any>;
-}
-
-export interface HandlerDidCompleteCallbackParam {
-  request: Request;
-  error?: Error;
-  event: ExtendableEvent;
-  response?: Response;
-  state?: PluginState;
-}
-
-export interface HandlerDidCompleteCallback {
-  (param: HandlerDidCompleteCallbackParam): PromiseOrNot<any>;
-}
-
-/**
- * An object with optional lifecycle callback properties for the fetch and
- * cache operations.
- */
-export declare interface SerwistPlugin {
-  cacheDidUpdate?: CacheDidUpdateCallback;
-  cachedResponseWillBeUsed?: CachedResponseWillBeUsedCallback;
-  cacheKeyWillBeUsed?: CacheKeyWillBeUsedCallback;
-  cacheWillUpdate?: CacheWillUpdateCallback;
-  fetchDidFail?: FetchDidFailCallback;
-  fetchDidSucceed?: FetchDidSucceedCallback;
-  handlerDidComplete?: HandlerDidCompleteCallback;
-  handlerDidError?: HandlerDidErrorCallback;
-  handlerDidRespond?: HandlerDidRespondCallback;
-  handlerWillRespond?: HandlerWillRespondCallback;
-  handlerWillStart?: HandlerWillStartCallback;
-  requestWillFetch?: RequestWillFetchCallback;
-}
-
-export interface SerwistPluginCallbackParam {
-  cacheDidUpdate: CacheDidUpdateCallbackParam;
-  cachedResponseWillBeUsed: CachedResponseWillBeUsedCallbackParam;
-  cacheKeyWillBeUsed: CacheKeyWillBeUsedCallbackParam;
-  cacheWillUpdate: CacheWillUpdateCallbackParam;
-  fetchDidFail: FetchDidFailCallbackParam;
-  fetchDidSucceed: FetchDidSucceedCallbackParam;
-  handlerDidComplete: HandlerDidCompleteCallbackParam;
-  handlerDidError: HandlerDidErrorCallbackParam;
-  handlerDidRespond: HandlerDidRespondCallbackParam;
-  handlerWillRespond: HandlerWillRespondCallbackParam;
-  handlerWillStart: HandlerWillStartCallbackParam;
-  requestWillFetch: RequestWillFetchCallbackParam;
-}
-
-export interface SerwistGlobalConfig {
-  __WB_DISABLE_DEV_LOGS: boolean;
-  __WB_FORCE_RUNTIME_CACHING: boolean;
-  __WB_CONCURRENT_PRECACHING: number;
-}

package/src/utils/pluginUtils.ts

@@ -1,15 +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 type { SerwistPlugin } from "../types.js";
-
-export const pluginUtils = {
-  filter: (plugins: SerwistPlugin[], callbackName: string): SerwistPlugin[] => {
-    return plugins.filter((plugin) => callbackName in plugin);
-  },
-};

package/src/utils/welcome.ts

@@ -1,25 +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 { logger } from "../_private/logger.js";
-
-// A SerwistCore instance must be exported before we can use the logger.
-// This is so it can get the current log level.
-if (process.env.NODE_ENV !== "production") {
-  const padding = "   ";
-  logger.groupCollapsed("Welcome to Serwist!");
-  logger.log(
-    "You are currently using a development build. " +
-      "By default this will switch to prod builds when not on localhost. " +
-      "You can force this with serwist.setConfig({debug: true|false}).",
-  );
-  logger.log(`📖 Read the guides and documentation\n${padding}https://developers.google.com/web/tools/workbox/`);
-  logger.log(`❓ Use the Discussions tab on Github to ask questions\n${padding}https://github.com/serwist/serwist/discussions`);
-  logger.log(`🐛 Found a bug? Report it on GitHub\n${padding}https://github.com/serwist/serwist/issues/new`);
-  logger.groupEnd();
-}