serwist 9.1.0-preview.0 → 10.0.0-preview.2

package/src/types.ts

@@ -1,7 +1,13 @@
-import type { HTTPMethod } from "./constants.js";
-import type { PrecacheStrategyOptions } from "./lib/strategies/PrecacheStrategy.js";
+import type {
+  PrecacheControllerOptions,
+  PrecacheEntry,
+  PrecacheOptions,
+  PrecacheRouteOptions,
+} from "#lib/controllers/PrecacheController/PrecacheController.js";
+import type { Prettify } from "@serwist/utils";
 import type { Route } from "./Route.js";
 import type { Serwist } from "./Serwist.js";
+import type { HTTPMethod } from "./constants.js";
 
 export type PromiseOrNot<T> = T | Promise<T>;
 
@@ -15,6 +21,41 @@ export interface MapLikeObject {
  */
 export type PluginState = MapLikeObject;
 
+export interface InitCallbackParam {
+  serwist: Serwist;
+}
+
+export type InitCallback = (param: InitCallbackParam) => PromiseOrNot<void>;
+
+export interface InstallCallbackParam {
+  event: ExtendableEvent;
+  serwist: Serwist;
+}
+
+export type InstallCallback = (param: InstallCallbackParam) => PromiseOrNot<void>;
+
+export interface ActivateCallbackParam {
+  event: ExtendableEvent;
+  serwist: Serwist;
+}
+
+export type ActivateCallback = (param: ActivateCallbackParam) => PromiseOrNot<void>;
+
+/**
+ * An object with optional lifecycle callback properties for Serwist's operations.
+ */
+export interface Controller {
+  init?: InitCallback;
+  install?: InstallCallback;
+  activate?: ActivateCallback;
+}
+
+export interface ControllerParam {
+  init: InitCallbackParam;
+  install: InstallCallbackParam;
+  activate: ActivateCallbackParam;
+}
+
 /**
  * Options passed to a {@linkcode RouteMatchCallback} function.
  */
@@ -74,7 +115,7 @@ export interface ManualHandlerCallbackOptions {
   params?: never;
 }
 
-export type HandlerCallbackOptions = RouteHandlerCallbackOptions | ManualHandlerCallbackOptions;
+export type HandlerCallbackOptions = Prettify<RouteHandlerCallbackOptions | ManualHandlerCallbackOptions>;
 
 /**
  * The "handler" callback is invoked whenever a request is matched to a
@@ -110,7 +151,7 @@ export interface RouteHandlerObject {
  * Either a {@linkcode RouteHandlerCallback} or a {@linkcode RouteHandlerObject}.
  * Most APIs that accept route handlers take either.
  */
-export type RouteHandler = RouteHandlerCallback | RouteHandlerObject;
+export type RouteHandler = RouteHandlerCallback | Prettify<RouteHandlerObject>;
 
 export interface HandlerWillStartCallbackParam {
   request: Request;
@@ -256,7 +297,7 @@ export type HandlerDidCompleteCallback = (param: HandlerDidCompleteCallbackParam
  * An object with optional lifecycle callback properties for the fetch and
  * cache operations.
  */
-export declare interface SerwistPlugin {
+export interface StrategyPlugin {
   cacheDidUpdate?: CacheDidUpdateCallback;
   cachedResponseWillBeUsed?: CachedResponseWillBeUsedCallback;
   cacheKeyWillBeUsed?: CacheKeyWillBeUsedCallback;
@@ -271,7 +312,7 @@ export declare interface SerwistPlugin {
   requestWillFetch?: RequestWillFetchCallback;
 }
 
-export interface SerwistPluginCallbackParam {
+export interface StrategyPluginCallbackParam {
   cacheDidUpdate: CacheDidUpdateCallbackParam;
   cachedResponseWillBeUsed: CachedResponseWillBeUsedCallbackParam;
   cacheKeyWillBeUsed: CacheKeyWillBeUsedCallbackParam;
@@ -331,66 +372,13 @@ export interface CleanupResult {
   deletedCacheRequests: string[];
 }
 
-export declare interface PrecacheEntry {
-  integrity?: string;
-  url: string;
-  revision?: string | null;
-}
-
-export interface PrecacheRouteOptions {
-  /**
-   * Tells Serwist to check the precache for an entry whose URL is the request URL appended
-   * with the specified value. Only applies if the request URL ends with "/".
-   *
-   * @default "index.html"
-   */
-  directoryIndex?: string | null;
-  /**
-   * An array of `RegExp` objects matching search params that should be removed when looking
-   * for a precache match.
-   */
-  ignoreURLParametersMatching?: RegExp[];
-  /**
-   * Tells Serwist to check the precache for an entry whose URL is the request URL appended
-   * with ".html".
-   *
-   * @default true
-   */
-  cleanURLs?: boolean;
-  /**
-   * A function that should take a URL and return an array of alternative URLs that should
-   * be checked for precache matches.
-   */
-  urlManipulation?: UrlManipulation;
-}
-
-export interface PrecacheOptions extends PrecacheStrategyOptions, PrecacheRouteOptions {
-  /**
-   * Whether outdated caches should be removed.
-   *
-   * @default false
-   */
-  cleanupOutdatedCaches?: boolean;
-  /**
-   * The number of precache requests that should be made concurrently.
-   *
-   * @default 10
-   */
-  concurrency?: number;
-  /**
-   * An URL that should point to a HTML file with which navigation requests for URLs that aren't
-   * precached will be fulfilled.
-   */
-  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[];
-}
-
 export type UrlManipulation = ({ url }: { url: URL }) => URL[];
+
+export type {
+  StrategyPlugin as SerwistPlugin,
+  StrategyPluginCallbackParam as SerwistPluginCallbackParam,
+  PrecacheEntry,
+  PrecacheRouteOptions,
+  PrecacheControllerOptions,
+  PrecacheOptions,
+};

package/src/utils/SerwistError.ts

@@ -6,8 +6,8 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { messageGenerator } from "../models/messages/messageGenerator.js";
-import type { MessageKey } from "../models/messages/messages.js";
+import { messageGenerator } from "#models/messages/messageGenerator.js";
+import type { MessageKey } from "#models/messages/messages.js";
 import type { MapLikeObject } from "../types.js";
 
 /**

package/src/utils/cacheNames.ts

@@ -5,7 +5,7 @@
   license that can be found in the LICENSE file or at
   https://opensource.org/licenses/MIT.
 */
-import type { initializeGoogleAnalytics } from "../lib/googleAnalytics/initializeGoogleAnalytics.js";
+import type { initializeGoogleAnalytics } from "#lib/googleAnalytics/initializeGoogleAnalytics.js";
 
 declare let registration: ServiceWorkerRegistration | undefined;
 

package/src/utils/executeQuotaErrorCallbacks.ts

@@ -6,7 +6,7 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { quotaErrorCallbacks } from "../models/quotaErrorCallbacks.js";
+import { quotaErrorCallbacks } from "#models/quotaErrorCallbacks.js";
 import { logger } from "./logger.js";
 
 /**

package/src/utils/pluginUtils.ts

@@ -6,10 +6,10 @@
   https://opensource.org/licenses/MIT.
 */
 
-import type { SerwistPlugin } from "../types.js";
+import type { StrategyPlugin } from "../types.js";
 
 export const pluginUtils = {
-  filter: (plugins: SerwistPlugin[], callbackName: string): SerwistPlugin[] => {
+  filter: (plugins: StrategyPlugin[], callbackName: string): StrategyPlugin[] => {
     return plugins.filter((plugin) => callbackName in plugin);
   },
 };

package/dist/PrecacheRoute.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PrecacheRoute.d.ts","sourceRoot":"","sources":["../src/PrecacheRoute.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAKvD;;;GAGG;AACH,qBAAa,aAAc,SAAQ,KAAK;IACtC;;;;OAIG;gBACS,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,oBAAoB;CAkB7D"}