@serwist/core 9.0.0-preview.9 → 9.0.0

package/dist/types.d.ts

@@ -1,279 +0,0 @@
-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;
-}
-//# 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":"AAOA,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAE7C,MAAM,WAAW,aAAa;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,aAAa,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,KAAK,EAAE,eAAe,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,OAAO,CAAC;IACpB,GAAG,EAAE,GAAG,CAAC;CACV;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kBAAkB;IACjC,CAAC,OAAO,EAAE,yBAAyB,GAAG,GAAG,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,2BAA2B;IAClD;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,GAAG,CAAC;IACT;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC;CACnC;AACD;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB;;OAEG;IACH,OAAO,EAAE,OAAO,GAAG,MAAM,CAAC;CAC3B;AAED,MAAM,MAAM,sBAAsB,GAAG,2BAA2B,GAAG,4BAA4B,CAAC;AAEhG;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB;IACnC,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC3D;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB;IACpC,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC5D;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,oBAAoB,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,oBAAoB,GAAG,kBAAkB,CAAC;AAErE,MAAM,WAAW,6BAA6B;IAC5C,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,eAAe,CAAC;IACvB,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,CAAC,KAAK,EAAE,6BAA6B,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CACtD;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,EAAE,QAAQ,CAAC;IACtB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC9B,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,sBAAsB;IACrC,CAAC,KAAK,EAAE,2BAA2B,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;CACzD;AAED,MAAM,WAAW,+BAA+B;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,eAAe,CAAC;IACvB,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,0BAA0B;IACzC,CAAC,KAAK,EAAE,+BAA+B,GAAG,YAAY,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC;CAC1E;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,eAAe,CAAC;IACvB,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,uBAAuB;IACtC,CAAC,KAAK,EAAE,4BAA4B,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;CAC1D;AAED,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,cAAc,CAAC,EAAE,QAAQ,CAAC;IAC1B,KAAK,EAAE,eAAe,CAAC;IACvB,YAAY,CAAC,EAAE,iBAAiB,CAAC;IACjC,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,gCAAgC;IAC/C,CAAC,KAAK,EAAE,qCAAqC,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;CACnE;AAED,MAAM,WAAW,yBAAyB;IACxC,KAAK,EAAE,KAAK,CAAC;IACb,eAAe,EAAE,OAAO,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,eAAe,CAAC;IACvB,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,CAAC,KAAK,EAAE,yBAAyB,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,eAAe,CAAC;IACvB,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,uBAAuB;IACtC,CAAC,KAAK,EAAE,4BAA4B,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;CAC/D;AAED,MAAM,WAAW,6BAA6B;IAC5C,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,eAAe,CAAC;IACvB,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,CAAC,KAAK,EAAE,6BAA6B,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;CAC/D;AAED,MAAM,WAAW,+BAA+B;IAC9C,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,eAAe,CAAC;IACvB,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,0BAA0B;IACzC,CAAC,KAAK,EAAE,+BAA+B,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;CAClE;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,eAAe,CAAC;IACvB,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,uBAAuB;IACtC,CAAC,KAAK,EAAE,4BAA4B,GAAG,YAAY,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC;CAC3E;AAED,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,eAAe,CAAC;IACvB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,yBAAyB;IACxC,CAAC,KAAK,EAAE,8BAA8B,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,+BAA+B;IAC9C,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,KAAK,EAAE,eAAe,CAAC;IACvB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,0BAA0B;IACzC,CAAC,KAAK,EAAE,+BAA+B,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;CAC7D;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,aAAa;IACpC,cAAc,CAAC,EAAE,sBAAsB,CAAC;IACxC,wBAAwB,CAAC,EAAE,gCAAgC,CAAC;IAC5D,kBAAkB,CAAC,EAAE,0BAA0B,CAAC;IAChD,eAAe,CAAC,EAAE,uBAAuB,CAAC;IAC1C,YAAY,CAAC,EAAE,oBAAoB,CAAC;IACpC,eAAe,CAAC,EAAE,uBAAuB,CAAC;IAC1C,kBAAkB,CAAC,EAAE,0BAA0B,CAAC;IAChD,eAAe,CAAC,EAAE,uBAAuB,CAAC;IAC1C,iBAAiB,CAAC,EAAE,yBAAyB,CAAC;IAC9C,kBAAkB,CAAC,EAAE,0BAA0B,CAAC;IAChD,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;IAC5C,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;CAC7C;AAED,MAAM,WAAW,0BAA0B;IACzC,cAAc,EAAE,2BAA2B,CAAC;IAC5C,wBAAwB,EAAE,qCAAqC,CAAC;IAChE,kBAAkB,EAAE,+BAA+B,CAAC;IACpD,eAAe,EAAE,4BAA4B,CAAC;IAC9C,YAAY,EAAE,yBAAyB,CAAC;IACxC,eAAe,EAAE,4BAA4B,CAAC;IAC9C,kBAAkB,EAAE,+BAA+B,CAAC;IACpD,eAAe,EAAE,4BAA4B,CAAC;IAC9C,iBAAiB,EAAE,8BAA8B,CAAC;IAClD,kBAAkB,EAAE,+BAA+B,CAAC;IACpD,gBAAgB,EAAE,6BAA6B,CAAC;IAChD,gBAAgB,EAAE,6BAA6B,CAAC;CACjD;AAED,MAAM,WAAW,mBAAmB;IAClC,qBAAqB,EAAE,OAAO,CAAC;IAC/B,0BAA0B,EAAE,OAAO,CAAC;IACpC,0BAA0B,EAAE,MAAM,CAAC;CACpC"}

package/dist/utils/pluginUtils.d.ts

@@ -1,5 +0,0 @@
-import type { SerwistPlugin } from "../types.js";
-export declare const pluginUtils: {
-    filter: (plugins: SerwistPlugin[], callbackName: string) => SerwistPlugin[];
-};
-//# sourceMappingURL=pluginUtils.d.ts.map

package/dist/utils/pluginUtils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"pluginUtils.d.ts","sourceRoot":"","sources":["../../src/utils/pluginUtils.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEjD,eAAO,MAAM,WAAW;sBACJ,aAAa,EAAE,gBAAgB,MAAM,KAAG,aAAa,EAAE;CAG1E,CAAC"}

package/dist/utils/welcome.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=welcome.d.ts.map

package/dist/utils/welcome.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"welcome.d.ts","sourceRoot":"","sources":["../../src/utils/welcome.ts"],"names":[],"mappings":""}

package/src/_private/Deferred.ts

@@ -1,33 +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.
-*/
-
-/**
- * The Deferred class composes Promises in a way that allows for them to be
- * resolved or rejected from outside the constructor. In most cases promises
- * should be used directly, but Deferreds can be necessary when the logic to
- * resolve a promise must be separate.
- *
- * @private
- */
-class Deferred<T> {
-  promise: Promise<T>;
-  resolve!: (value: T) => void;
-  reject!: (reason?: any) => void;
-
-  /**
-   * Creates a promise and exposes its resolve and reject functions as methods.
-   */
-  constructor() {
-    this.promise = new Promise((resolve, reject) => {
-      this.resolve = resolve;
-      this.reject = reject;
-    });
-  }
-}
-
-export { Deferred };

package/src/_private/SerwistError.ts

@@ -1,43 +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 { messageGenerator } from "../models/messages/messageGenerator.js";
-import type { MessageKey } from "../models/messages/messages.js";
-import type { MapLikeObject } from "../types.js";
-
-/**
- * Serwist errors should be thrown with this class.
- * This allows use to ensure the type easily in tests,
- * helps developers identify errors from Serwist
- * easily and allows use to optimise error
- * messages correctly.
- *
- * @private
- */
-class SerwistError extends Error {
-  details?: MapLikeObject;
-
-  /**
-   *
-   * @param errorCode The error code that
-   * identifies this particular error.
-   * @param details Any relevant arguments
-   * that will help developers identify issues should
-   * be added as a key on the context object.
-   */
-  constructor(errorCode: MessageKey, details?: MapLikeObject) {
-    const message = messageGenerator(errorCode, details);
-
-    super(message);
-
-    this.name = errorCode;
-    this.details = details;
-  }
-}
-
-export { SerwistError };

package/src/_private/assert.ts

@@ -1,89 +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 { SerwistError } from "../_private/SerwistError.js";
-import type { MapLikeObject } from "../types.js";
-
-/*
- * This method throws if the supplied value is not an array.
- * The destructed values are required to produce a meaningful error for users.
- * The destructed and restructured object is so it's clear what is
- * needed.
- */
-const isArray = (value: any[], details: MapLikeObject) => {
-  if (!Array.isArray(value)) {
-    throw new SerwistError("not-an-array", details);
-  }
-};
-
-const hasMethod = (object: MapLikeObject, expectedMethod: string, details: MapLikeObject) => {
-  const type = typeof object[expectedMethod];
-  if (type !== "function") {
-    details.expectedMethod = expectedMethod;
-    throw new SerwistError("missing-a-method", details);
-  }
-};
-
-const isType = (object: unknown, expectedType: string, details: MapLikeObject) => {
-  // biome-ignore lint/suspicious/useValidTypeof: Know to not make a mistake...
-  if (typeof object !== expectedType) {
-    details.expectedType = expectedType;
-    throw new SerwistError("incorrect-type", details);
-  }
-};
-
-const isInstance = (
-  object: unknown,
-  // biome-ignore lint/complexity/noBannedTypes: Need the general type to do the check later.
-  expectedClass: Function,
-  details: MapLikeObject,
-) => {
-  if (!(object instanceof expectedClass)) {
-    details.expectedClassName = expectedClass.name;
-    throw new SerwistError("incorrect-class", details);
-  }
-};
-
-const isOneOf = (value: any, validValues: any[], details: MapLikeObject) => {
-  if (!validValues.includes(value)) {
-    details.validValueDescription = `Valid values are ${JSON.stringify(validValues)}.`;
-    throw new SerwistError("invalid-value", details);
-  }
-};
-
-const isArrayOfClass = (
-  value: any,
-  // biome-ignore lint/complexity/noBannedTypes: Need general type to do check later.
-  expectedClass: Function,
-  details: MapLikeObject,
-) => {
-  const error = new SerwistError("not-array-of-class", details);
-  if (!Array.isArray(value)) {
-    throw error;
-  }
-
-  for (const item of value) {
-    if (!(item instanceof expectedClass)) {
-      throw error;
-    }
-  }
-};
-
-const finalAssertExports =
-  process.env.NODE_ENV === "production"
-    ? null
-    : {
-        hasMethod,
-        isArray,
-        isInstance,
-        isOneOf,
-        isType,
-        isArrayOfClass,
-      };
-
-export { finalAssertExports as assert };

package/src/_private/cacheMatchIgnoreParams.ts

@@ -1,54 +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.
-*/
-
-function stripParams(fullURL: string, ignoreParams: string[]) {
-  const strippedURL = new URL(fullURL);
-  for (const param of ignoreParams) {
-    strippedURL.searchParams.delete(param);
-  }
-  return strippedURL.href;
-}
-
-/**
- * Matches an item in the cache, ignoring specific URL params. This is similar
- * to the `ignoreSearch` option, but it allows you to ignore just specific
- * params (while continuing to match on the others).
- *
- * @private
- * @param cache
- * @param request
- * @param matchOptions
- * @param ignoreParams
- * @returns
- */
-async function cacheMatchIgnoreParams(
-  cache: Cache,
-  request: Request,
-  ignoreParams: string[],
-  matchOptions?: CacheQueryOptions,
-): Promise<Response | undefined> {
-  const strippedRequestURL = stripParams(request.url, ignoreParams);
-
-  // If the request doesn't include any ignored params, match as normal.
-  if (request.url === strippedRequestURL) {
-    return cache.match(request, matchOptions);
-  }
-
-  // Otherwise, match by comparing keys
-  const keysOptions = { ...matchOptions, ignoreSearch: true };
-  const cacheKeys = await cache.keys(request, keysOptions);
-
-  for (const cacheKey of cacheKeys) {
-    const strippedCacheKeyURL = stripParams(cacheKey.url, ignoreParams);
-    if (strippedRequestURL === strippedCacheKeyURL) {
-      return cache.match(cacheKey, matchOptions);
-    }
-  }
-  return;
-}
-
-export { cacheMatchIgnoreParams };

package/src/_private/cacheNames.ts

@@ -1,87 +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.
-*/
-
-declare let registration: ServiceWorkerRegistration | undefined;
-
-export interface CacheNameDetails {
-  googleAnalytics: string;
-  precache: string;
-  prefix: string;
-  runtime: string;
-  suffix: string;
-}
-
-export interface PartialCacheNameDetails {
-  /**
-   * The string to add to the beginning of the precache and runtime cache names.
-   */
-  prefix?: string;
-  /**
-   * The string to add to the end of the precache and runtime cache names.
-   */
-  suffix?: string;
-  /**
-   * The cache name to use for precache caching.
-   */
-  precache?: string;
-  /**
-   * The cache name to use for runtime caching.
-   */
-  runtime?: string;
-  /**
-   * The cache name to use for `@serwist/google-analytics` caching.
-   */
-  googleAnalytics?: string;
-  [propName: string]: string | undefined;
-}
-
-export type CacheNameDetailsProp = "googleAnalytics" | "precache" | "prefix" | "runtime" | "suffix";
-
-const _cacheNameDetails: CacheNameDetails = {
-  googleAnalytics: "googleAnalytics",
-  precache: "precache-v2",
-  prefix: "serwist",
-  runtime: "runtime",
-  suffix: typeof registration !== "undefined" ? registration.scope : "",
-};
-
-const _createCacheName = (cacheName: string): string => {
-  return [_cacheNameDetails.prefix, cacheName, _cacheNameDetails.suffix].filter((value) => value && value.length > 0).join("-");
-};
-
-const eachCacheNameDetail = (fn: (key: CacheNameDetailsProp) => void): void => {
-  for (const key of Object.keys(_cacheNameDetails)) {
-    fn(key as CacheNameDetailsProp);
-  }
-};
-
-export const cacheNames = {
-  updateDetails: (details: PartialCacheNameDetails): void => {
-    eachCacheNameDetail((key: CacheNameDetailsProp): void => {
-      const detail = details[key];
-      if (typeof detail === "string") {
-        _cacheNameDetails[key] = detail;
-      }
-    });
-  },
-  getGoogleAnalyticsName: (userCacheName?: string): string => {
-    return userCacheName || _createCacheName(_cacheNameDetails.googleAnalytics);
-  },
-  getPrecacheName: (userCacheName?: string): string => {
-    return userCacheName || _createCacheName(_cacheNameDetails.precache);
-  },
-  getPrefix: (): string => {
-    return _cacheNameDetails.prefix;
-  },
-  getRuntimeName: (userCacheName?: string): string => {
-    return userCacheName || _createCacheName(_cacheNameDetails.runtime);
-  },
-  getSuffix: (): string => {
-    return _cacheNameDetails.suffix;
-  },
-};

package/src/_private/canConstructReadableStream.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.
-*/
-
-let supportStatus: boolean | undefined;
-
-/**
- * A utility function that determines whether the current browser supports
- * constructing a [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream/ReadableStream)
- * object.
- *
- * @returns `true`, if the current browser can successfully construct a `ReadableStream`, `false` otherwise.
- *
- * @private
- */
-function canConstructReadableStream(): boolean {
-  if (supportStatus === undefined) {
-    // See https://github.com/GoogleChrome/workbox/issues/1473
-    try {
-      new ReadableStream({ start() {} });
-      supportStatus = true;
-    } catch (error) {
-      supportStatus = false;
-    }
-  }
-
-  return supportStatus;
-}
-
-export { canConstructReadableStream };

package/src/_private/canConstructResponseFromBodyStream.ts

@@ -1,37 +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.
-*/
-
-let supportStatus: boolean | undefined;
-
-/**
- * A utility function that determines whether the current browser supports
- * constructing a new `Response` from a `response.body` stream.
- *
- * @returns `true`, if the current browser can successfully construct
- * a `Response` from a `response.body` stream, `false` otherwise.
- * @private
- */
-function canConstructResponseFromBodyStream(): boolean {
-  if (supportStatus === undefined) {
-    const testResponse = new Response("");
-
-    if ("body" in testResponse) {
-      try {
-        new Response(testResponse.body);
-        supportStatus = true;
-      } catch (error) {
-        supportStatus = false;
-      }
-    }
-    supportStatus = false;
-  }
-
-  return supportStatus;
-}
-
-export { canConstructResponseFromBodyStream };