@serwist/expiration 9.0.0-preview.12 → 9.0.0-preview.14

package/dist/CacheExpiration.d.ts

@@ -15,11 +15,10 @@ interface CacheExpirationConfig {
     matchOptions?: CacheQueryOptions;
 }
 /**
- * The `CacheExpiration` class allows you define an expiration and / or
- * limit on the number of responses stored in a
- * [`Cache`](https://developer.mozilla.org/en-US/docs/Web/API/Cache).
+ * Allows you to expires cached responses based on age or maximum number of entries.
+ * @see https://serwist.pages.dev/docs/expiration/cache-expiration
  */
-declare class CacheExpiration {
+export declare class CacheExpiration {
     private _isRunning;
     private _rerunRequested;
     private readonly _maxEntries?;
@@ -40,30 +39,28 @@ declare class CacheExpiration {
      */
     expireEntries(): Promise<void>;
     /**
-     * Update the timestamp for the given URL. This ensures the when
-     * removing entries based on maximum entries, most recently used
-     * is accurate or when expiring, the timestamp is up-to-date.
+     * Updates the timestamp for the given URL, allowing it to be correctly
+     * tracked by the class.
      *
      * @param url
      */
     updateTimestamp(url: string): Promise<void>;
     /**
-     * Can be used to check if a URL has expired or not before it's used.
+     * Checks if a URL has expired or not before it's used.
      *
-     * This requires a look up from IndexedDB, so can be slow.
+     * This looks the timestamp up in IndexedDB and can be slow.
      *
-     * Note: This method will not remove the cached entry, call
-     * `expireEntries()` to remove indexedDB and Cache entries.
+     * Note: This method does not remove an expired entry, call
+     * `expireEntries()` to remove such entries instead.
      *
      * @param url
      * @returns
      */
     isURLExpired(url: string): Promise<boolean>;
     /**
-     * Removes the IndexedDB object store used to keep track of cache expiration
-     * metadata.
+     * Removes the IndexedDB used to keep track of cache expiration metadata.
      */
     delete(): Promise<void>;
 }
-export { CacheExpiration };
+export {};
 //# sourceMappingURL=CacheExpiration.d.ts.map

package/dist/CacheExpiration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CacheExpiration.d.ts","sourceRoot":"","sources":["../src/CacheExpiration.ts"],"names":[],"mappings":"AAYA,UAAU,qBAAqB;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,CAAC;CAClC;AAED;;;;GAIG;AACH,cAAM,eAAe;IACnB,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAoB;IACnD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAuB;IAEvD;;;;;;OAMG;gBACS,SAAS,EAAE,MAAM,EAAE,MAAM,GAAE,qBAA0B;IA2CjE;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IA0CpC;;;;;;OAMG;IACG,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAajD;;;;;;;;;;OAUG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAejD;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAM9B;AAED,OAAO,EAAE,eAAe,EAAE,CAAC"}
+{"version":3,"file":"CacheExpiration.d.ts","sourceRoot":"","sources":["../src/CacheExpiration.ts"],"names":[],"mappings":"AAYA,UAAU,qBAAqB;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,CAAC;CAClC;AAED;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAoB;IACnD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAuB;IAEvD;;;;;;OAMG;gBACS,SAAS,EAAE,MAAM,EAAE,MAAM,GAAE,qBAA0B;IA2CjE;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IA0CpC;;;;;OAKG;IACG,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAajD;;;;;;;;;;OAUG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAejD;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAM9B"}

package/dist/ExpirationPlugin.d.ts

@@ -15,32 +15,32 @@ export interface ExpirationPluginOptions {
      */
     matchOptions?: CacheQueryOptions;
     /**
-     * Whether to opt this cache in to automatic deletion if the available storage quota has been exceeded.
+     * Whether to opt this cache into automatic deletion if the available storage quota has been exceeded.
      */
     purgeOnQuotaError?: boolean;
 }
 /**
  * This plugin can be used in a `@serwist/strategies` Strategy to regularly enforce a
- * limit on the age and / or the number of cached requests.
+ * limit on the age and/or the number of cached requests.
  *
- * It can only be used with Strategy instances that have a
- * [custom `cacheName` property set](/web/tools/workbox/guides/configure-workbox#custom_cache_names_in_strategies).
- * In other words, it can't be used to expire entries in strategy that uses the
- * default runtime cache name.
+ * It can only be used with Strategy instances that have a custom `cacheName` property set.
+ * In other words, it can't be used to expire entries in strategies that use the default runtime
+ * cache name.
  *
  * Whenever a cached response is used or updated, this plugin will look
  * at the associated cache and remove any old or extra responses.
  *
  * When using `maxAgeSeconds`, responses may be used *once* after expiring
  * because the expiration clean up will not have occurred until *after* the
- * cached response has been used. If the response has a "Date" header, then
- * a light weight expiration check is performed and the response will not be
- * used immediately.
+ * cached response has been used. If the response has a "Date" header, then a lightweight expiration
+ * check is performed, and the response will not be used immediately.
  *
- * When using `maxEntries`, the entry least-recently requested will be removed
- * from the cache first.
+ * When using `maxEntries`, the least recently requested entry will be removed
+ * from the cache.
+ *
+ * @see https://serwist.pages.dev/docs/expiration/expiration-plugin
  */
-declare class ExpirationPlugin implements SerwistPlugin {
+export declare class ExpirationPlugin implements SerwistPlugin {
     private readonly _config;
     private readonly _maxAgeSeconds?;
     private _cacheExpirations;
@@ -95,16 +95,12 @@ declare class ExpirationPlugin implements SerwistPlugin {
      */
     cacheDidUpdate: SerwistPlugin["cacheDidUpdate"];
     /**
-     * This is a helper method that performs two operations:
-     *
-     * - Deletes *all* the underlying Cache instances associated with this plugin
-     * instance, by calling caches.delete() on your behalf.
-     * - Deletes the metadata from IndexedDB used to keep track of expiration
-     * details for each Cache instance.
+     * Deletes the underlying `Cache` instance associated with this instance and the metadata
+     * from IndexedDB used to keep track of expiration details for each `Cache` instance.
      *
      * When using cache expiration, calling this method is preferable to calling
      * `caches.delete()` directly, since this will ensure that the IndexedDB
-     * metadata is also cleanly removed and open IndexedDB instances are deleted.
+     * metadata is also cleanly removed and that open IndexedDB instances are deleted.
      *
      * Note that if you're *not* using cache expiration for a given cache, calling
      * `caches.delete()` and passing in the cache's name should be sufficient.
@@ -112,5 +108,4 @@ declare class ExpirationPlugin implements SerwistPlugin {
      */
     deleteCacheAndMetadata(): Promise<void>;
 }
-export { ExpirationPlugin };
 //# sourceMappingURL=ExpirationPlugin.d.ts.map

package/dist/ExpirationPlugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExpirationPlugin.d.ts","sourceRoot":"","sources":["../src/ExpirationPlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAMnD,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,CAAC;IACjC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,cAAM,gBAAiB,YAAW,aAAa;IAC7C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAClD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAS;IACzC,OAAO,CAAC,iBAAiB,CAA+B;IAExD;;OAEG;gBACS,MAAM,GAAE,uBAA4B;IAsChD;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IAa3B;;;;;;;;;;;;OAYG;IACH,wBAAwB,EAAE,aAAa,CAAC,0BAA0B,CAAC,CA+BjE;IAEF;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAqB5B;;;;;;;OAOG;IACH,OAAO,CAAC,uBAAuB;IAkB/B;;;;;;OAMG;IACH,cAAc,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAmB7C;IAEF;;;;;;;;;;;;;;;OAeG;IACG,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;CAW9C;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"ExpirationPlugin.d.ts","sourceRoot":"","sources":["../src/ExpirationPlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAMnD,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,CAAC;IACjC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,gBAAiB,YAAW,aAAa;IACpD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAClD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAS;IACzC,OAAO,CAAC,iBAAiB,CAA+B;IAExD;;OAEG;gBACS,MAAM,GAAE,uBAA4B;IAsChD;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IAa3B;;;;;;;;;;;;OAYG;IACH,wBAAwB,EAAE,aAAa,CAAC,0BAA0B,CAAC,CA+BjE;IAEF;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAqB5B;;;;;;;OAOG;IACH,OAAO,CAAC,uBAAuB;IAkB/B;;;;;;OAMG;IACH,cAAc,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAmB7C;IAEF;;;;;;;;;;;OAWG;IACG,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;CAW9C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/expiration",
-  "version": "9.0.0-preview.12",
+  "version": "9.0.0-preview.14",
   "type": "module",
   "description": "A module that expires cached responses based on age or maximum number of entries.",
   "files": [
@@ -30,12 +30,12 @@
   },
   "dependencies": {
     "idb": "8.0.0",
-    "@serwist/core": "9.0.0-preview.12"
+    "@serwist/core": "9.0.0-preview.14"
   },
   "devDependencies": {
-    "rollup": "4.9.6",
-    "typescript": "5.4.0-dev.20240206",
-    "@serwist/constants": "9.0.0-preview.12"
+    "rollup": "4.13.0",
+    "typescript": "5.5.0-dev.20240312",
+    "@serwist/constants": "9.0.0-preview.14"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"

package/src/CacheExpiration.ts

@@ -28,11 +28,10 @@ interface CacheExpirationConfig {
 }
 
 /**
- * The `CacheExpiration` class allows you define an expiration and / or
- * limit on the number of responses stored in a
- * [`Cache`](https://developer.mozilla.org/en-US/docs/Web/API/Cache).
+ * Allows you to expires cached responses based on age or maximum number of entries.
+ * @see https://serwist.pages.dev/docs/expiration/cache-expiration
  */
-class CacheExpiration {
+export class CacheExpiration {
   private _isRunning = false;
   private _rerunRequested = false;
   private readonly _maxEntries?: number;
@@ -137,9 +136,8 @@ class CacheExpiration {
   }
 
   /**
-   * Update the timestamp for the given URL. This ensures the when
-   * removing entries based on maximum entries, most recently used
-   * is accurate or when expiring, the timestamp is up-to-date.
+   * Updates the timestamp for the given URL, allowing it to be correctly
+   * tracked by the class.
    *
    * @param url
    */
@@ -157,12 +155,12 @@ class CacheExpiration {
   }
 
   /**
-   * Can be used to check if a URL has expired or not before it's used.
+   * Checks if a URL has expired or not before it's used.
    *
-   * This requires a look up from IndexedDB, so can be slow.
+   * This looks the timestamp up in IndexedDB and can be slow.
    *
-   * Note: This method will not remove the cached entry, call
-   * `expireEntries()` to remove indexedDB and Cache entries.
+   * Note: This method does not remove an expired entry, call
+   * `expireEntries()` to remove such entries instead.
    *
    * @param url
    * @returns
@@ -183,8 +181,7 @@ class CacheExpiration {
   }
 
   /**
-   * Removes the IndexedDB object store used to keep track of cache expiration
-   * metadata.
+   * Removes the IndexedDB used to keep track of cache expiration metadata.
    */
   async delete(): Promise<void> {
     // Make sure we don't attempt another rerun if we're called in the middle of
@@ -193,5 +190,3 @@ class CacheExpiration {
     await this._timestampModel.expireEntries(Infinity); // Expires all.
   }
 }
-
-export { CacheExpiration };

package/src/ExpirationPlugin.ts

@@ -28,33 +28,33 @@ export interface ExpirationPluginOptions {
    */
   matchOptions?: CacheQueryOptions;
   /**
-   * Whether to opt this cache in to automatic deletion if the available storage quota has been exceeded.
+   * Whether to opt this cache into automatic deletion if the available storage quota has been exceeded.
    */
   purgeOnQuotaError?: boolean;
 }
 
 /**
  * This plugin can be used in a `@serwist/strategies` Strategy to regularly enforce a
- * limit on the age and / or the number of cached requests.
+ * limit on the age and/or the number of cached requests.
  *
- * It can only be used with Strategy instances that have a
- * [custom `cacheName` property set](/web/tools/workbox/guides/configure-workbox#custom_cache_names_in_strategies).
- * In other words, it can't be used to expire entries in strategy that uses the
- * default runtime cache name.
+ * It can only be used with Strategy instances that have a custom `cacheName` property set.
+ * In other words, it can't be used to expire entries in strategies that use the default runtime
+ * cache name.
  *
  * Whenever a cached response is used or updated, this plugin will look
  * at the associated cache and remove any old or extra responses.
  *
  * When using `maxAgeSeconds`, responses may be used *once* after expiring
  * because the expiration clean up will not have occurred until *after* the
- * cached response has been used. If the response has a "Date" header, then
- * a light weight expiration check is performed and the response will not be
- * used immediately.
+ * cached response has been used. If the response has a "Date" header, then a lightweight expiration
+ * check is performed, and the response will not be used immediately.
  *
- * When using `maxEntries`, the entry least-recently requested will be removed
- * from the cache first.
+ * When using `maxEntries`, the least recently requested entry will be removed
+ * from the cache.
+ *
+ * @see https://serwist.pages.dev/docs/expiration/expiration-plugin
  */
-class ExpirationPlugin implements SerwistPlugin {
+export class ExpirationPlugin implements SerwistPlugin {
   private readonly _config: ExpirationPluginOptions;
   private readonly _maxAgeSeconds?: number;
   private _cacheExpirations: Map<string, CacheExpiration>;
@@ -248,16 +248,12 @@ class ExpirationPlugin implements SerwistPlugin {
   };
 
   /**
-   * This is a helper method that performs two operations:
-   *
-   * - Deletes *all* the underlying Cache instances associated with this plugin
-   * instance, by calling caches.delete() on your behalf.
-   * - Deletes the metadata from IndexedDB used to keep track of expiration
-   * details for each Cache instance.
+   * Deletes the underlying `Cache` instance associated with this instance and the metadata
+   * from IndexedDB used to keep track of expiration details for each `Cache` instance.
    *
    * When using cache expiration, calling this method is preferable to calling
    * `caches.delete()` directly, since this will ensure that the IndexedDB
-   * metadata is also cleanly removed and open IndexedDB instances are deleted.
+   * metadata is also cleanly removed and that open IndexedDB instances are deleted.
    *
    * Note that if you're *not* using cache expiration for a given cache, calling
    * `caches.delete()` and passing in the cache's name should be sufficient.
@@ -275,5 +271,3 @@ class ExpirationPlugin implements SerwistPlugin {
     this._cacheExpirations = new Map();
   }
 }
-
-export { ExpirationPlugin };