serwist 9.0.0-preview.26 → 9.0.2

package/README.md

@@ -1 +1 @@
-This module's documentation can be found at https://serwist.pages.dev/docs/serwist
+This module's documentation can be found at https://serwist.pages.dev/docs/serwist.

package/dist/lib/backgroundSync/StorableRequest.d.ts

@@ -15,7 +15,7 @@ export declare class StorableRequest {
     private readonly _requestData;
     /**
      * Converts a Request object to a plain object that can be structured
-     * cloned or JSON-stringified.
+     * cloned or stringified to JSON.
      *
      * @param request
      * @returns
@@ -25,12 +25,12 @@ export declare class StorableRequest {
      * Accepts an object of request data that can be used to construct a
      * `Request` but can also be stored in IndexedDB.
      *
-     * @param requestData An object of request data that includes the `url` plus any relevant properties of
-     * [requestInit](https://fetch.spec.whatwg.org/#requestinit).
+     * @param requestData An object of request data that includes the `url` plus any relevant property of
+     * [`requestInit`](https://fetch.spec.whatwg.org/#requestinit).
      */
     constructor(requestData: RequestData);
     /**
-     * Returns a deep clone of the instances `_requestData` object.
+     * Returns a deep clone of the instance's `requestData` object.
      *
      * @returns
      */

package/dist/lib/precaching/PrecacheFallbackPlugin.d.ts

@@ -29,10 +29,6 @@ export interface PrecacheFallbackPluginOptions {
  * It does this by intercepting the `handlerDidError` plugin callback
  * and returning a precached response, taking the expected revision parameter
  * into account automatically.
- *
- * Unless you explicitly pass in a `PrecacheController` instance to the
- * constructor, the default instance will be used. Generally speaking, most
- * developers will end up using the default.
  */
 export declare class PrecacheFallbackPlugin implements SerwistPlugin {
     private readonly _fallbackUrls;

package/dist/lib/precaching/PrecacheFallbackPlugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PrecacheFallbackPlugin.d.ts","sourceRoot":"","sources":["../../../src/lib/precaching/PrecacheFallbackPlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,EAAE,4BAA4B,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAElF,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,OAAO,EAAE,CAAC,KAAK,EAAE,4BAA4B,KAAK,OAAO,CAAC;IAC1D;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,YAAY,EAAE,CAAC,MAAM,GAAG,qBAAqB,CAAC,EAAE,CAAC;IACjD;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,sBAAuB,YAAW,aAAa;IAC1D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqC;IACnE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IAEnC;;;;OAIG;gBACS,EAAE,YAAY,EAAE,OAAO,EAAE,EAAE,6BAA6B;IAKpE;;;;OAIG;IACG,eAAe,CAAC,KAAK,EAAE,4BAA4B;CAgB1D"}
+{"version":3,"file":"PrecacheFallbackPlugin.d.ts","sourceRoot":"","sources":["../../../src/lib/precaching/PrecacheFallbackPlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,EAAE,4BAA4B,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAElF,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,OAAO,EAAE,CAAC,KAAK,EAAE,4BAA4B,KAAK,OAAO,CAAC;IAC1D;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,YAAY,EAAE,CAAC,MAAM,GAAG,qBAAqB,CAAC,EAAE,CAAC;IACjD;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;GAOG;AACH,qBAAa,sBAAuB,YAAW,aAAa;IAC1D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqC;IACnE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IAEnC;;;;OAIG;gBACS,EAAE,YAAY,EAAE,OAAO,EAAE,EAAE,6BAA6B;IAKpE;;;;OAIG;IACG,eAAe,CAAC,KAAK,EAAE,4BAA4B;CAgB1D"}

package/dist/lib/strategies/StrategyHandler.d.ts

@@ -80,8 +80,8 @@ export declare class StrategyHandler {
      * provided to the `Strategy` object.
      *
      * The following lifecycle methods are invoked when using this method:
-     * - `cacheKeyWillByUsed`
-     * - `cachedResponseWillByUsed`
+     * - `cacheKeyWillBeUsed`
+     * - `cachedResponseWillBeUsed`
      *
      * @param key The `Request` or `URL` object to use as the cache key.
      * @returns A matching response, if found.
@@ -93,7 +93,7 @@ export declare class StrategyHandler {
      * the `Strategy` object.
      *
      * The following plugin lifecycle methods are invoked when using this method:
-     * - `cacheKeyWillByUsed`
+     * - `cacheKeyWillBeUsed`
      * - `cacheWillUpdate`
      * - `cacheDidUpdate`
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serwist",
-  "version": "9.0.0-preview.26",
+  "version": "9.0.2",
   "type": "module",
   "description": "A Swiss Army knife for service workers.",
   "files": [
@@ -51,8 +51,8 @@
   "devDependencies": {
     "rollup": "4.14.3",
     "typescript": "5.5.0-dev.20240415",
-    "@serwist/configs": "9.0.0-preview.26",
-    "@serwist/utils": "9.0.0-preview.26"
+    "@serwist/configs": "9.0.2",
+    "@serwist/utils": "9.0.2"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"
@@ -63,7 +63,7 @@
     }
   },
   "scripts": {
-    "build": "rimraf dist && cross-env NODE_ENV=production rollup --config rollup.config.js",
+    "build": "rimraf dist && NODE_ENV=production rollup --config rollup.config.js",
     "dev": "rollup --config rollup.config.js --watch",
     "lint": "biome lint ./src",
     "typecheck": "tsc"

package/src/lib/backgroundSync/StorableRequest.ts

@@ -41,7 +41,7 @@ export class StorableRequest {
 
   /**
    * Converts a Request object to a plain object that can be structured
-   * cloned or JSON-stringified.
+   * cloned or stringified to JSON.
    *
    * @param request
    * @returns
@@ -79,8 +79,8 @@ export class StorableRequest {
    * Accepts an object of request data that can be used to construct a
    * `Request` but can also be stored in IndexedDB.
    *
-   * @param requestData An object of request data that includes the `url` plus any relevant properties of
-   * [requestInit](https://fetch.spec.whatwg.org/#requestinit).
+   * @param requestData An object of request data that includes the `url` plus any relevant property of
+   * [`requestInit`](https://fetch.spec.whatwg.org/#requestinit).
    */
   constructor(requestData: RequestData) {
     if (process.env.NODE_ENV !== "production") {
@@ -108,7 +108,7 @@ export class StorableRequest {
   }
 
   /**
-   * Returns a deep clone of the instances `_requestData` object.
+   * Returns a deep clone of the instance's `requestData` object.
    *
    * @returns
    */

package/src/lib/precaching/PrecacheFallbackPlugin.ts

@@ -40,10 +40,6 @@ export interface PrecacheFallbackPluginOptions {
  * It does this by intercepting the `handlerDidError` plugin callback
  * and returning a precached response, taking the expected revision parameter
  * into account automatically.
- *
- * Unless you explicitly pass in a `PrecacheController` instance to the
- * constructor, the default instance will be used. Generally speaking, most
- * developers will end up using the default.
  */
 export class PrecacheFallbackPlugin implements SerwistPlugin {
   private readonly _fallbackUrls: (string | PrecacheFallbackEntry)[];

package/src/lib/strategies/Strategy.ts

@@ -36,8 +36,8 @@ export interface StrategyOptions {
 
 /**
  * Abstract class for implementing runtime caching strategies.
- * 
- * Custom strategies should extend this class and leverage `StrategyHandler`, which will ensure all relevant cache options, 
+ *
+ * Custom strategies should extend this class and leverage `StrategyHandler`, which will ensure all relevant cache options,
  * fetch options, and plugins are used (per the current strategy instance), to perform all fetching and caching logic.
  */
 export abstract class Strategy implements RouteHandlerObject {
@@ -87,8 +87,8 @@ export abstract class Strategy implements RouteHandlerObject {
   }
 
   /**
-   * Similar to `handle()`, but instead of just returning a `Promise` that 
-   * resolves to a `Response`, it will return an tuple of `[response, done]` promises, 
+   * Similar to `handle()`, but instead of just returning a `Promise` that
+   * resolves to a `Response`, it will return an tuple of `[response, done]` promises,
    * where `response` is equivalent to what `handle()` returns, and `done` is a
    * `Promise` that will resolve once all promises added to `event.waitUntil()` as a part
    * of performing the strategy have completed.

package/src/lib/strategies/StrategyHandler.ts

@@ -222,8 +222,8 @@ export class StrategyHandler {
    * provided to the `Strategy` object.
    *
    * The following lifecycle methods are invoked when using this method:
-   * - `cacheKeyWillByUsed`
-   * - `cachedResponseWillByUsed`
+   * - `cacheKeyWillBeUsed`
+   * - `cachedResponseWillBeUsed`
    *
    * @param key The `Request` or `URL` object to use as the cache key.
    * @returns A matching response, if found.
@@ -265,7 +265,7 @@ export class StrategyHandler {
    * the `Strategy` object.
    *
    * The following plugin lifecycle methods are invoked when using this method:
-   * - `cacheKeyWillByUsed`
+   * - `cacheKeyWillBeUsed`
    * - `cacheWillUpdate`
    * - `cacheDidUpdate`
    *