@serwist/sw 9.0.0-preview.2 → 9.0.0-preview.20

package/dist/types.d.ts

@@ -1,110 +0,0 @@
-import type { QueueOptions } from "@serwist/background-sync";
-import type { BroadcastCacheUpdateOptions } from "@serwist/broadcast-update";
-import type { CacheableResponseOptions } from "@serwist/cacheable-response";
-import type { RouteHandler, RouteMatchCallback, SerwistPlugin } from "@serwist/core";
-import type { ExpirationPluginOptions } from "@serwist/expiration";
-import type { HTTPMethod } from "@serwist/routing";
-export type StrategyName = "CacheFirst" | "CacheOnly" | "NetworkFirst" | "NetworkOnly" | "StaleWhileRevalidate";
-export interface RuntimeCaching {
-    /**
-     * This determines how the runtime route will generate a response.
-     * To use one of the built-in `@serwist/strategies`, provide its name,
-     * like `'NetworkFirst'`.
-     * Alternatively, this can be a `@serwist/core.RouteHandler` callback
-     * function with custom response logic.
-     */
-    handler: RouteHandler | StrategyName;
-    /**
-     * The HTTP method to match against. The default value of `'GET'` is normally
-     * sufficient, unless you explicitly need to match `'POST'`, `'PUT'`, or
-     * another type of request.
-     * @default "GET"
-     */
-    method?: HTTPMethod;
-    options?: {
-        /**
-         * Configuring this will add a
-         * `@serwist/background-sync.BackgroundSyncPlugin` instance to the
-         * `@serwist/strategies` configured in `handler`.
-         */
-        backgroundSync?: {
-            name: string;
-            options?: QueueOptions;
-        };
-        /**
-         * Configuring this will add a
-         * `@serwist/broadcast-update.BroadcastUpdatePlugin` instance to the
-         * `@serwist/strategies` configured in `handler`.
-         */
-        broadcastUpdate?: {
-            channelName?: string;
-            options: BroadcastCacheUpdateOptions;
-        };
-        /**
-         * Configuring this will add a
-         * `@serwist/cacheable-response.CacheableResponsePlugin` instance to
-         * the `@serwist/strategies` configured in `handler`.
-         */
-        cacheableResponse?: CacheableResponseOptions;
-        /**
-         * If provided, this will set the `cacheName` property of the
-         * `@serwist/strategies` configured in `handler`.
-         */
-        cacheName?: string | null;
-        /**
-         * Configuring this will add a
-         * `@serwist/expiration.ExpirationPlugin` instance to
-         * the `@serwist/strategies` configured in `handler`.
-         */
-        expiration?: ExpirationPluginOptions;
-        /**
-         * If provided, this will set the `networkTimeoutSeconds` property of the
-         * `@serwist/strategies` configured in `handler`. Note that only
-         * `'NetworkFirst'` and `'NetworkOnly'` support `networkTimeoutSeconds`.
-         */
-        networkTimeoutSeconds?: number;
-        /**
-         * Configuring this allows the use of one or more Serwist plugins that
-         * don't have "shortcut" options (like `expiration` for
-         * `@serwist/expiration.ExpirationPlugin`). The plugins provided here
-         * will be added to the `@serwist/strategies` configured in `handler`.
-         */
-        plugins?: SerwistPlugin[];
-        /**
-         * Configuring this will add a
-         * `@serwist/precaching.PrecacheFallbackPlugin` instance to
-         * the `@serwist/strategies` configured in `handler`.
-         */
-        precacheFallback?: {
-            fallbackURL: string;
-        };
-        /**
-         * Enabling this will add a
-         * `@serwist/range-requests.RangeRequestsPlugin` instance to
-         * the `@serwist/strategies` configured in `handler`.
-         */
-        rangeRequests?: boolean;
-        /**
-         * Configuring this will pass along the `fetchOptions` value to
-         * the `@serwist/strategies` configured in `handler`.
-         */
-        fetchOptions?: RequestInit;
-        /**
-         * Configuring this will pass along the `matchOptions` value to
-         * the `@serwist/strategies` configured in `handler`.
-         */
-        matchOptions?: CacheQueryOptions;
-    };
-    /**
-     * This match criteria determines whether the configured handler will
-     * generate a response for any requests that don't match one of the precached
-     * URLs. If multiple `RuntimeCaching` routes are defined, then the first one
-     * whose `urlPattern` matches will be the one that responds.
-     *
-     * This value directly maps to the first parameter passed to
-     * `@serwist/routing.registerRoute`. It's recommended to use a
-     * `@serwist/core.RouteMatchCallback` function for greatest flexibility.
-     */
-    urlPattern: RegExp | string | RouteMatchCallback;
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AAC5E,OAAO,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACrF,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG,WAAW,GAAG,cAAc,GAAG,aAAa,GAAG,sBAAsB,CAAC;AAEhH,MAAM,WAAW,cAAc;IAC7B;;;;;;OAMG;IACH,OAAO,EAAE,YAAY,GAAG,YAAY,CAAC;IACrC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,OAAO,CAAC,EAAE;QACR;;;;WAIG;QACH,cAAc,CAAC,EAAE;YACf,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,CAAC,EAAE,YAAY,CAAC;SACxB,CAAC;QACF;;;;WAIG;QACH,eAAe,CAAC,EAAE;YAGhB,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,OAAO,EAAE,2BAA2B,CAAC;SACtC,CAAC;QACF;;;;WAIG;QACH,iBAAiB,CAAC,EAAE,wBAAwB,CAAC;QAC7C;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1B;;;;WAIG;QACH,UAAU,CAAC,EAAE,uBAAuB,CAAC;QACrC;;;;WAIG;QACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;QAC/B;;;;;WAKG;QACH,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;QAC1B;;;;WAIG;QACH,gBAAgB,CAAC,EAAE;YACjB,WAAW,EAAE,MAAM,CAAC;SACrB,CAAC;QACF;;;;WAIG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB;;;WAGG;QACH,YAAY,CAAC,EAAE,WAAW,CAAC;QAC3B;;;WAGG;QACH,YAAY,CAAC,EAAE,iBAAiB,CAAC;KAClC,CAAC;IACF;;;;;;;;;OASG;IACH,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,kBAAkB,CAAC;CAClD"}

package/src/disableDevLogs.ts

@@ -1,10 +0,0 @@
-declare const self: WorkerGlobalScope & {
-  __WB_DISABLE_DEV_LOGS: boolean;
-};
-
-/**
- * Disables Serwist's logging in development mode.
- */
-export const disableDevLogs = () => {
-  self.__WB_DISABLE_DEV_LOGS = true;
-};

package/src/fallbacks.ts

@@ -1,83 +0,0 @@
-import type { HandlerDidErrorCallbackParam } from "@serwist/core";
-import type { PrecacheRouteOptions } from "@serwist/precaching";
-import { precacheAndRoute } from "@serwist/precaching";
-
-import type { RuntimeCaching } from "./types.js";
-
-export type FallbackMatcher = (_: HandlerDidErrorCallbackParam) => boolean;
-
-export interface FallbackEntry {
-  /**
-   * The matcher, which checks whether the fallback entry can be used
-   * for a Request.
-   */
-  matcher: FallbackMatcher;
-  /**
-   * The fallback URL.
-   */
-  url: URL | string;
-  /**
-   * The revision used for precaching.
-   */
-  revision: string;
-  /**
-   * How the Response in the cache should be matched.
-   *
-   * @default
-   * { ignoreSearch: true }
-   */
-  cacheMatchOptions?: MultiCacheQueryOptions;
-}
-
-export interface FallbacksOptions {
-  /**
-   * Your previous `RuntimeCaching` array.
-   */
-  runtimeCaching: RuntimeCaching[];
-  /**
-   * A list of fallback entries.
-   */
-  entries: FallbackEntry[];
-  /**
-   * Precache options that will be used for your
-   * fallback entries.
-   */
-  precacheOptions?: PrecacheRouteOptions;
-}
-
-/**
- * Precaches routes so that they can be used as a fallback when 
- * a `RuntimeCaching` handler fails.
- * @param options
- * @returns The modified `RuntimeCaching` array. Using this value 
- * is not needed, as it is simply the provided array.
- */
-export const fallbacks = ({ runtimeCaching, entries, precacheOptions }: FallbacksOptions): RuntimeCaching[] => {
-  precacheAndRoute(
-    entries.map(({ url, revision }) => ({ url: typeof url === "string" ? url : url.toString(), revision })),
-    precacheOptions,
-  );
-  runtimeCaching = runtimeCaching.map((cacheEntry) => {
-    if (!cacheEntry.options || cacheEntry.options.precacheFallback || cacheEntry.options.plugins?.some((plugin) => "handlerDidError" in plugin)) {
-      return cacheEntry;
-    }
-
-    if (!cacheEntry.options.plugins) {
-      cacheEntry.options.plugins = [];
-    }
-
-    cacheEntry.options.plugins.push({
-      async handlerDidError(info) {
-        for (const { matcher, url, cacheMatchOptions = { ignoreSearch: true } } of entries) {
-          if (matcher(info)) {
-            return caches.match(url, cacheMatchOptions);
-          }
-        }
-        return Response.error();
-      },
-    });
-
-    return cacheEntry;
-  });
-  return runtimeCaching;
-};

package/src/handlePrecaching.ts

@@ -1,65 +0,0 @@
-import type { PrecacheEntry, PrecacheRouteOptions } from "@serwist/precaching";
-import { cleanupOutdatedCaches as cleanupOutdatedCachesImpl, createHandlerBoundToURL, precacheAndRoute } from "@serwist/precaching";
-import { NavigationRoute, registerRoute } from "@serwist/routing";
-
-export type HandlePrecachingOptions = {
-  /**
-   * A list of fallback entries.
-   */
-  precacheEntries?: (PrecacheEntry | string)[];
-  /**
-   * Precache options for the provided entries.
-   */
-  precacheOptions?: PrecacheRouteOptions;
-  /**
-   * Whether outdated caches should be removed.
-   * 
-   * @default false
-   */
-  cleanupOutdatedCaches?: boolean;
-} & (
-  | {
-      /**
-       * An URL that should point to a HTML
-       * file with which navigation requests for URLs that aren't precached will be fulfilled.
-       * For more complex cases, consider `@serwist/sw.fallbacks`instead.
-       */
-      navigateFallback: string;
-      /**
-       * URLs that should be allowed to use the `navigateFallback` handler.
-       */
-      navigateFallbackAllowlist?: RegExp[];
-      /**
-       * URLs that should not be allowed to use the `navigateFallback` handler. This takes precedence
-       * over `navigateFallbackAllowlist`.
-       */
-      navigateFallbackDenylist?: RegExp[];
-    }
-  | { navigateFallback?: never }
-);
-
-/**
- * Handles a list of precache entries and cleans up outdated caches.
- * @param options
- */
-export const handlePrecaching = ({ precacheEntries, precacheOptions, cleanupOutdatedCaches = false, ...options }: HandlePrecachingOptions) => {
-  if (!!precacheEntries && precacheEntries.length > 0) {
-    /**
-     * The precacheAndRoute() method efficiently caches and responds to
-     * requests for URLs in the manifest.
-     * See https://goo.gl/S9QRab
-     */
-    precacheAndRoute(precacheEntries, precacheOptions);
-  }
-
-  if (cleanupOutdatedCaches) cleanupOutdatedCachesImpl();
-
-  if (options.navigateFallback) {
-    registerRoute(
-      new NavigationRoute(createHandlerBoundToURL(options.navigateFallback), {
-        allowlist: options.navigateFallbackAllowlist,
-        denylist: options.navigateFallbackDenylist,
-      }),
-    );
-  }
-};

package/src/installSerwist.ts

@@ -1,106 +0,0 @@
-import { clientsClaim as clientsClaimImpl, setCacheNameDetails } from "@serwist/core";
-import { logger } from "@serwist/core/internal";
-import { type GoogleAnalyticsInitializeOptions, initialize } from "@serwist/google-analytics/initialize";
-import { enable } from "@serwist/navigation-preload";
-
-import { disableDevLogs as disableDevLogsImpl } from "./disableDevLogs.js";
-import type { FallbacksOptions } from "./fallbacks.js";
-import { fallbacks as fallbacksImpl } from "./fallbacks.js";
-import { type HandlePrecachingOptions, handlePrecaching } from "./handlePrecaching.js";
-import { registerRuntimeCaching } from "./registerRuntimeCaching.js";
-import type { RuntimeCaching } from "./types.js";
-
-declare const self: ServiceWorkerGlobalScope;
-
-export type InstallSerwistOptions = HandlePrecachingOptions & {
-  skipWaiting?: boolean;
-  importScripts?: string[];
-  navigationPreload?: boolean;
-  cacheId?: string | undefined;
-  clientsClaim?: boolean;
-  runtimeCaching?: RuntimeCaching[];
-  offlineAnalyticsConfig?: GoogleAnalyticsInitializeOptions | boolean;
-  disableDevLogs?: boolean;
-  fallbacks?: Omit<FallbacksOptions, "runtimeCaching">;
-};
-
-/**
- * A function that abstracts away the core APIs of Serwist.
- * @param options - `installSerwist` options.
- */
-export const installSerwist = ({
-  precacheEntries,
-  precacheOptions,
-  cleanupOutdatedCaches,
-
-  skipWaiting = false,
-  importScripts,
-  navigationPreload = false,
-  cacheId,
-  clientsClaim = false,
-  runtimeCaching,
-  offlineAnalyticsConfig,
-  disableDevLogs,
-  fallbacks,
-  ...options
-}: InstallSerwistOptions) => {
-  if (!!importScripts && importScripts.length > 0) self.importScripts(...importScripts);
-
-  if (navigationPreload) enable();
-
-  if (cacheId !== undefined) {
-    setCacheNameDetails({
-      prefix: cacheId,
-    });
-  }
-
-  if (skipWaiting) {
-    self.skipWaiting();
-  } else {
-    self.addEventListener("message", (event) => {
-      if (event.data && event.data.type === "SKIP_WAITING") {
-        self.skipWaiting();
-      }
-    });
-  }
-
-  if (clientsClaim) clientsClaimImpl();
-
-  handlePrecaching({
-    precacheEntries,
-    precacheOptions,
-    cleanupOutdatedCaches,
-    ...(options.navigateFallback && {
-      navigateFallback: options.navigateFallback,
-      navigateFallbackAllowlist: options.navigateFallbackAllowlist,
-      navigateFallbackDenylist: options.navigateFallbackDenylist,
-    }),
-  });
-
-  if (runtimeCaching !== undefined) {
-    if (!("__WB_FORCE_RUNTIME_CACHING" in globalThis)) {
-      self.__WB_FORCE_RUNTIME_CACHING = false;
-    }
-    if (!self.__WB_FORCE_RUNTIME_CACHING && process.env.NODE_ENV !== "production") {
-      logger.log("runtimeCaching and fallbacks are disabled in development mode.");
-    } else {
-      if (fallbacks !== undefined) {
-        runtimeCaching = fallbacksImpl({
-          ...fallbacks,
-          runtimeCaching,
-        });
-      }
-      registerRuntimeCaching(...runtimeCaching);
-    }
-  }
-
-  if (offlineAnalyticsConfig !== undefined) {
-    if (typeof offlineAnalyticsConfig === "boolean") {
-      offlineAnalyticsConfig && initialize();
-    } else {
-      initialize(offlineAnalyticsConfig);
-    }
-  }
-
-  if (disableDevLogs) disableDevLogsImpl();
-};

package/src/registerRuntimeCaching.ts

@@ -1,84 +0,0 @@
-import { BackgroundSyncPlugin } from "@serwist/background-sync";
-import { BroadcastUpdatePlugin } from "@serwist/broadcast-update";
-import { CacheableResponsePlugin } from "@serwist/cacheable-response";
-import { logger } from "@serwist/core/internal";
-import { ExpirationPlugin } from "@serwist/expiration";
-import { PrecacheFallbackPlugin } from "@serwist/precaching";
-import { RangeRequestsPlugin } from "@serwist/range-requests";
-import { registerRoute } from "@serwist/routing";
-import { CacheFirst, CacheOnly, NetworkFirst, NetworkOnly, StaleWhileRevalidate } from "@serwist/strategies";
-import { nonNullable } from "@serwist/utils";
-
-import type { RuntimeCaching, StrategyName } from "./types.js";
-
-declare const self: ServiceWorkerGlobalScope;
-
-const HANDLER_NAME_TO_METHOD = {
-  CacheFirst,
-  CacheOnly,
-  NetworkFirst,
-  NetworkOnly,
-  StaleWhileRevalidate,
-} satisfies Record<StrategyName, unknown>;
-
-/**
- * Registers caching strategies to a singleton Router instance. It is a simple
- * syntatic sugar for `@serwist/routing.registerRoute`.
- * @param runtimeCachingList
- * @returns
- */
-export const registerRuntimeCaching = (...runtimeCachingList: RuntimeCaching[]) => {
-  if (!("__WB_FORCE_RUNTIME_CACHING" in globalThis)) {
-    self.__WB_FORCE_RUNTIME_CACHING = false;
-  }
-
-  if (!self.__WB_FORCE_RUNTIME_CACHING && process.env.NODE_ENV !== "production") {
-    logger.log("registerRuntimeCaching is disabled in development mode.");
-    return;
-  }
-
-  for (const rcEntry of runtimeCachingList) {
-    if (typeof rcEntry.handler === "string") {
-      const {
-        cacheName,
-        networkTimeoutSeconds,
-        fetchOptions,
-        matchOptions,
-        plugins,
-        backgroundSync,
-        broadcastUpdate,
-        cacheableResponse,
-        expiration,
-        precacheFallback,
-        rangeRequests,
-      } = rcEntry.options!; // entry.options is always defined when entry.handler is of type 'string'.
-      const Handler = HANDLER_NAME_TO_METHOD[rcEntry.handler];
-      registerRoute(
-        rcEntry.urlPattern,
-        new Handler({
-          cacheName: cacheName ?? undefined,
-          networkTimeoutSeconds,
-          fetchOptions,
-          matchOptions,
-          plugins: [
-            ...(plugins ?? []),
-            backgroundSync && new BackgroundSyncPlugin(backgroundSync.name, backgroundSync.options),
-            broadcastUpdate &&
-              new BroadcastUpdatePlugin({
-                // @ts-expect-error weird...
-                channelName: broadcastUpdate.channelName,
-                ...broadcastUpdate.options,
-              }),
-            cacheableResponse && new CacheableResponsePlugin(cacheableResponse),
-            expiration && new ExpirationPlugin(expiration),
-            precacheFallback && new PrecacheFallbackPlugin(precacheFallback),
-            rangeRequests ? new RangeRequestsPlugin() : undefined,
-          ].filter(nonNullable),
-        }),
-        rcEntry.method,
-      );
-    } else {
-      registerRoute(rcEntry.urlPattern, rcEntry.handler, rcEntry.method);
-    }
-  }
-};

package/src/types.ts

@@ -1,113 +0,0 @@
-import type { QueueOptions } from "@serwist/background-sync";
-import type { BroadcastCacheUpdateOptions } from "@serwist/broadcast-update";
-import type { CacheableResponseOptions } from "@serwist/cacheable-response";
-import type { RouteHandler, RouteMatchCallback, SerwistPlugin } from "@serwist/core";
-import type { ExpirationPluginOptions } from "@serwist/expiration";
-import type { HTTPMethod } from "@serwist/routing";
-
-export type StrategyName = "CacheFirst" | "CacheOnly" | "NetworkFirst" | "NetworkOnly" | "StaleWhileRevalidate";
-
-export interface RuntimeCaching {
-  /**
-   * This determines how the runtime route will generate a response.
-   * To use one of the built-in `@serwist/strategies`, provide its name,
-   * like `'NetworkFirst'`.
-   * Alternatively, this can be a `@serwist/core.RouteHandler` callback
-   * function with custom response logic.
-   */
-  handler: RouteHandler | StrategyName;
-  /**
-   * The HTTP method to match against. The default value of `'GET'` is normally
-   * sufficient, unless you explicitly need to match `'POST'`, `'PUT'`, or
-   * another type of request.
-   * @default "GET"
-   */
-  method?: HTTPMethod;
-  options?: {
-    /**
-     * Configuring this will add a
-     * `@serwist/background-sync.BackgroundSyncPlugin` instance to the
-     * `@serwist/strategies` configured in `handler`.
-     */
-    backgroundSync?: {
-      name: string;
-      options?: QueueOptions;
-    };
-    /**
-     * Configuring this will add a
-     * `@serwist/broadcast-update.BroadcastUpdatePlugin` instance to the
-     * `@serwist/strategies` configured in `handler`.
-     */
-    broadcastUpdate?: {
-      // TODO: This option is ignored since we switched to using postMessage().
-      // Remove it in the next major release.
-      channelName?: string;
-      options: BroadcastCacheUpdateOptions;
-    };
-    /**
-     * Configuring this will add a
-     * `@serwist/cacheable-response.CacheableResponsePlugin` instance to
-     * the `@serwist/strategies` configured in `handler`.
-     */
-    cacheableResponse?: CacheableResponseOptions;
-    /**
-     * If provided, this will set the `cacheName` property of the
-     * `@serwist/strategies` configured in `handler`.
-     */
-    cacheName?: string | null;
-    /**
-     * Configuring this will add a
-     * `@serwist/expiration.ExpirationPlugin` instance to
-     * the `@serwist/strategies` configured in `handler`.
-     */
-    expiration?: ExpirationPluginOptions;
-    /**
-     * If provided, this will set the `networkTimeoutSeconds` property of the
-     * `@serwist/strategies` configured in `handler`. Note that only
-     * `'NetworkFirst'` and `'NetworkOnly'` support `networkTimeoutSeconds`.
-     */
-    networkTimeoutSeconds?: number;
-    /**
-     * Configuring this allows the use of one or more Serwist plugins that
-     * don't have "shortcut" options (like `expiration` for
-     * `@serwist/expiration.ExpirationPlugin`). The plugins provided here
-     * will be added to the `@serwist/strategies` configured in `handler`.
-     */
-    plugins?: SerwistPlugin[];
-    /**
-     * Configuring this will add a
-     * `@serwist/precaching.PrecacheFallbackPlugin` instance to
-     * the `@serwist/strategies` configured in `handler`.
-     */
-    precacheFallback?: {
-      fallbackURL: string;
-    };
-    /**
-     * Enabling this will add a
-     * `@serwist/range-requests.RangeRequestsPlugin` instance to
-     * the `@serwist/strategies` configured in `handler`.
-     */
-    rangeRequests?: boolean;
-    /**
-     * Configuring this will pass along the `fetchOptions` value to
-     * the `@serwist/strategies` configured in `handler`.
-     */
-    fetchOptions?: RequestInit;
-    /**
-     * Configuring this will pass along the `matchOptions` value to
-     * the `@serwist/strategies` configured in `handler`.
-     */
-    matchOptions?: CacheQueryOptions;
-  };
-  /**
-   * This match criteria determines whether the configured handler will
-   * generate a response for any requests that don't match one of the precached
-   * URLs. If multiple `RuntimeCaching` routes are defined, then the first one
-   * whose `urlPattern` matches will be the one that responds.
-   *
-   * This value directly maps to the first parameter passed to
-   * `@serwist/routing.registerRoute`. It's recommended to use a
-   * `@serwist/core.RouteMatchCallback` function for greatest flexibility.
-   */
-  urlPattern: RegExp | string | RouteMatchCallback;
-}