serwist 9.0.0-preview.24

package/dist/plugins/backgroundSync/Queue.d.ts

@@ -0,0 +1,166 @@
+interface OnSyncCallbackOptions {
+    queue: Queue;
+}
+type OnSyncCallback = (options: OnSyncCallbackOptions) => void | Promise<void>;
+export interface QueueOptions {
+    /**
+     * If `true`, instead of attempting to use background sync events, always attempt
+     * to replay queued request at service worker startup. Most folks will not need
+     * this, unless you explicitly target a runtime like Electron that exposes the
+     * interfaces for background sync, but does not have a working implementation.
+     *
+     * @default false
+     */
+    forceSyncFallback?: boolean;
+    /**
+     * The amount of time (in minutes) a request may be retried. After this amount
+     * of time has passed, the request will be deleted from the queue.
+     *
+     * @default 60 * 24 * 7
+     */
+    maxRetentionTime?: number;
+    /**
+     * A function that gets invoked whenever the 'sync' event fires. The function
+     * is invoked with an object containing the `queue` property (referencing this
+     * instance), and you can use the callback to customize the replay behavior of
+     * the queue. When not set the `replayRequests()` method is called. Note: if the
+     * replay fails after a sync event, make sure you throw an error, so the browser
+     * knows to retry the sync event later.
+     */
+    onSync?: OnSyncCallback;
+}
+export interface QueueEntry {
+    /**
+     * The request to store in the queue.
+     */
+    request: Request;
+    /**
+     * The timestamp (Epoch time in milliseconds) when the request was first added
+     * to the queue. This is used along with `maxRetentionTime` to remove outdated
+     * requests. In general you don't need to set this value, as it's automatically
+     * set for you (defaulting to `Date.now()`), but you can update it if you don't
+     * want particular requests to expire.
+     */
+    timestamp?: number;
+    /**
+     * Any metadata you want associated with the stored request. When requests are
+     * replayed you'll have access to this metadata object in case you need to modify
+     * the request beforehand.
+     */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * A class to manage storing failed requests in IndexedDB and retrying them
+ * later. All parts of the storing and replaying process are observable via
+ * callbacks.
+ */
+export declare class Queue {
+    private readonly _name;
+    private readonly _onSync;
+    private readonly _maxRetentionTime;
+    private readonly _queueStore;
+    private readonly _forceSyncFallback;
+    private _syncInProgress;
+    private _requestsAddedDuringSync;
+    /**
+     * Creates an instance of Queue with the given options
+     *
+     * @param name The unique name for this queue. This name must be
+     * unique as it's used to register sync events and store requests
+     * in IndexedDB specific to this instance. An error will be thrown if
+     * a duplicate name is detected.
+     * @param options
+     */
+    constructor(name: string, { forceSyncFallback, onSync, maxRetentionTime }?: QueueOptions);
+    /**
+     * @returns
+     */
+    get name(): string;
+    /**
+     * Stores the passed request in IndexedDB (with its timestamp and any
+     * metadata) at the end of the queue.
+     *
+     * @param entry
+     */
+    pushRequest(entry: QueueEntry): Promise<void>;
+    /**
+     * Stores the passed request in IndexedDB (with its timestamp and any
+     * metadata) at the beginning of the queue.
+     *
+     * @param entry
+     */
+    unshiftRequest(entry: QueueEntry): Promise<void>;
+    /**
+     * Removes and returns the last request in the queue (along with its
+     * timestamp and any metadata).
+     *
+     * @returns
+     */
+    popRequest(): Promise<QueueEntry | undefined>;
+    /**
+     * Removes and returns the first request in the queue (along with its
+     * timestamp and any metadata).
+     *
+     * @returns
+     */
+    shiftRequest(): Promise<QueueEntry | undefined>;
+    /**
+     * Returns all the entries that have not expired (per `maxRetentionTime`).
+     * Any expired entries are removed from the queue.
+     *
+     * @returns
+     */
+    getAll(): Promise<QueueEntry[]>;
+    /**
+     * Returns the number of entries present in the queue.
+     * Note that expired entries (per `maxRetentionTime`) are also included in this count.
+     *
+     * @returns
+     */
+    size(): Promise<number>;
+    /**
+     * Adds the entry to the QueueStore and registers for a sync event.
+     *
+     * @param entry
+     * @param operation
+     * @private
+     */
+    _addRequest({ request, metadata, timestamp }: QueueEntry, operation: "push" | "unshift"): Promise<void>;
+    /**
+     * Removes and returns the first or last (depending on `operation`) entry
+     * from the QueueStore that's not older than the `maxRetentionTime`.
+     *
+     * @param operation
+     * @returns
+     * @private
+     */
+    _removeRequest(operation: "pop" | "shift"): Promise<QueueEntry | undefined>;
+    /**
+     * Loops through each request in the queue and attempts to re-fetch it.
+     * If any request fails to re-fetch, it's put back in the same position in
+     * the queue (which registers a retry for the next sync event).
+     */
+    replayRequests(): Promise<void>;
+    /**
+     * Registers a sync event with a tag unique to this instance.
+     */
+    registerSync(): Promise<void>;
+    /**
+     * In sync-supporting browsers, this adds a listener for the sync event.
+     * In non-sync-supporting browsers, or if _forceSyncFallback is true, this
+     * will retry the queue on service worker startup.
+     *
+     * @private
+     */
+    private _addSyncListener;
+    /**
+     * Returns the set of queue names. This is primarily used to reset the list
+     * of queue names in tests.
+     *
+     * @returns
+     * @private
+     */
+    static get _queueNames(): Set<string>;
+}
+export {};
+//# sourceMappingURL=Queue.d.ts.map

package/dist/plugins/backgroundSync/Queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Queue.d.ts","sourceRoot":"","sources":["../../../src/plugins/backgroundSync/Queue.ts"],"names":[],"mappings":"AAkBA,UAAU,qBAAqB;IAC7B,KAAK,EAAE,KAAK,CAAC;CACd;AAED,KAAK,cAAc,GAAG,CAAC,OAAO,EAAE,qBAAqB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAE/E,MAAM,WAAW,YAAY;IAC3B;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AA2BD;;;;GAIG;AACH,qBAAa,KAAK;IAChB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiB;IACzC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAS;IAC3C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAa;IACzC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAU;IAC7C,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,wBAAwB,CAAS;IAEzC;;;;;;;;OAQG;gBACS,IAAI,EAAE,MAAM,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAE,YAAiB;IAgB5F;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;;OAKG;IACG,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBnD;;;;;OAKG;IACG,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBtD;;;;;OAKG;IACG,UAAU,IAAI,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAInD;;;;;OAKG;IACG,YAAY,IAAI,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAIrD;;;;;OAKG;IACG,MAAM,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAmBrC;;;;;OAKG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC;IAI7B;;;;;;OAMG;IACG,WAAW,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAsB,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAmC1H;;;;;;;OAOG;IACG,cAAc,CAAC,SAAS,EAAE,KAAK,GAAG,OAAO,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IA0BjF;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAuBrC;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAenC;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IAmDxB;;;;;;OAMG;IACH,MAAM,KAAK,WAAW,IAAI,GAAG,CAAC,MAAM,CAAC,CAEpC;CACF"}

package/dist/plugins/backgroundSync/QueueDb.d.ts

@@ -0,0 +1,90 @@
+import type { RequestData } from "./StorableRequest.js";
+export interface UnidentifiedQueueStoreEntry {
+    requestData: RequestData;
+    timestamp: number;
+    id?: number;
+    queueName?: string;
+    metadata?: Record<string, unknown>;
+}
+export interface QueueStoreEntry extends UnidentifiedQueueStoreEntry {
+    id: number;
+}
+/**
+ * A class to interact directly an IndexedDB created specifically to save and
+ * retrieve QueueStoreEntries. This class encapsulates all the schema details
+ * to store the representation of a Queue.
+ *
+ * @private
+ */
+export declare class QueueDb {
+    private _db;
+    /**
+     * Add QueueStoreEntry to underlying db.
+     *
+     * @param entry
+     */
+    addEntry(entry: UnidentifiedQueueStoreEntry): Promise<void>;
+    /**
+     * Returns the first entry id in the ObjectStore.
+     *
+     * @returns
+     */
+    getFirstEntryId(): Promise<number | undefined>;
+    /**
+     * Get all the entries filtered by index
+     *
+     * @param queueName
+     * @returns
+     */
+    getAllEntriesByQueueName(queueName: string): Promise<QueueStoreEntry[]>;
+    /**
+     * Returns the number of entries filtered by index
+     *
+     * @param queueName
+     * @returns
+     */
+    getEntryCountByQueueName(queueName: string): Promise<number>;
+    /**
+     * Deletes a single entry by id.
+     *
+     * @param id the id of the entry to be deleted
+     */
+    deleteEntry(id: number): Promise<void>;
+    /**
+     *
+     * @param queueName
+     * @returns
+     */
+    getFirstEntryByQueueName(queueName: string): Promise<QueueStoreEntry | undefined>;
+    /**
+     *
+     * @param queueName
+     * @returns
+     */
+    getLastEntryByQueueName(queueName: string): Promise<QueueStoreEntry | undefined>;
+    /**
+     * Returns either the first or the last entries, depending on direction.
+     * Filtered by index.
+     *
+     * @param direction
+     * @param query
+     * @returns
+     * @private
+     */
+    getEndEntryFromIndex(query: IDBKeyRange, direction: IDBCursorDirection): Promise<QueueStoreEntry | undefined>;
+    /**
+     * Returns an open connection to the database.
+     *
+     * @private
+     */
+    private getDb;
+    /**
+     * Upgrades QueueDB
+     *
+     * @param db
+     * @param oldVersion
+     * @private
+     */
+    private _upgradeDb;
+}
+//# sourceMappingURL=QueueDb.d.ts.map

package/dist/plugins/backgroundSync/QueueDb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueueDb.d.ts","sourceRoot":"","sources":["../../../src/plugins/backgroundSync/QueueDb.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAexD,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE,WAAW,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,eAAgB,SAAQ,2BAA2B;IAClE,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;;;;;GAMG;AAEH,qBAAa,OAAO;IAClB,OAAO,CAAC,GAAG,CAA4C;IAEvD;;;;OAIG;IACG,QAAQ,CAAC,KAAK,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;IASjE;;;;OAIG;IACG,eAAe,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAMpD;;;;;OAKG;IACG,wBAAwB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAM7E;;;;;OAKG;IACG,wBAAwB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAKlE;;;;OAIG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAK5C;;;;OAIG;IACG,wBAAwB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAIvF;;;;OAIG;IACG,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAItF;;;;;;;;OAQG;IACG,oBAAoB,CAAC,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAOnH;;;;OAIG;YACW,KAAK;IASnB;;;;;;OAMG;IACH,OAAO,CAAC,UAAU;CAanB"}

package/dist/plugins/backgroundSync/QueueStore.d.ts

@@ -0,0 +1,75 @@
+import type { QueueStoreEntry, UnidentifiedQueueStoreEntry } from "./QueueDb.js";
+/**
+ * A class to manage storing requests from a Queue in IndexedDB,
+ * indexed by their queue name for easier access.
+ *
+ * Most developers will not need to access this class directly;
+ * it is exposed for advanced use cases.
+ */
+export declare class QueueStore {
+    private readonly _queueName;
+    private readonly _queueDb;
+    /**
+     * Associates this instance with a Queue instance, so entries added can be
+     * identified by their queue name.
+     *
+     * @param queueName
+     */
+    constructor(queueName: string);
+    /**
+     * Append an entry last in the queue.
+     *
+     * @param entry
+     */
+    pushEntry(entry: UnidentifiedQueueStoreEntry): Promise<void>;
+    /**
+     * Prepend an entry first in the queue.
+     *
+     * @param entry
+     */
+    unshiftEntry(entry: UnidentifiedQueueStoreEntry): Promise<void>;
+    /**
+     * Removes and returns the last entry in the queue matching the `queueName`.
+     *
+     * @returns
+     */
+    popEntry(): Promise<QueueStoreEntry | undefined>;
+    /**
+     * Removes and returns the first entry in the queue matching the `queueName`.
+     *
+     * @returns
+     */
+    shiftEntry(): Promise<QueueStoreEntry | undefined>;
+    /**
+     * Returns all entries in the store matching the `queueName`.
+     *
+     * @returns
+     */
+    getAll(): Promise<QueueStoreEntry[]>;
+    /**
+     * Returns the number of entries in the store matching the `queueName`.
+     *
+     * @returns
+     */
+    size(): Promise<number>;
+    /**
+     * Deletes the entry for the given ID.
+     *
+     * WARNING: this method does not ensure the deleted entry belongs to this
+     * queue (i.e. matches the `queueName`). But this limitation is acceptable
+     * as this class is not publicly exposed. An additional check would make
+     * this method slower than it needs to be.
+     *
+     * @param id
+     */
+    deleteEntry(id: number): Promise<void>;
+    /**
+     * Removes and returns the first or last entry in the queue (based on the
+     * `direction` argument) matching the `queueName`.
+     *
+     * @returns
+     * @private
+     */
+    _removeEntry(entry?: QueueStoreEntry): Promise<QueueStoreEntry | undefined>;
+}
+//# sourceMappingURL=QueueStore.d.ts.map

package/dist/plugins/backgroundSync/QueueStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueueStore.d.ts","sourceRoot":"","sources":["../../../src/plugins/backgroundSync/QueueStore.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,eAAe,EAAE,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAGjF;;;;;;GAMG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IAEnC;;;;;OAKG;gBACS,SAAS,EAAE,MAAM;IAK7B;;;;OAIG;IACG,SAAS,CAAC,KAAK,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBlE;;;;OAIG;IACG,YAAY,CAAC,KAAK,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;IA8BrE;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAItD;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAIxD;;;;OAIG;IACG,MAAM,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IAI1C;;;;OAIG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC;IAI7B;;;;;;;;;OASG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI5C;;;;;;OAMG;IACG,YAAY,CAAC,KAAK,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;CAMlF"}

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

@@ -0,0 +1,51 @@
+import type { MapLikeObject } from "../../types.js";
+export interface RequestData extends MapLikeObject {
+    url: string;
+    headers: MapLikeObject;
+    body?: ArrayBuffer;
+}
+/**
+ * A class to make it easier to serialize and de-serialize requests so they
+ * can be stored in IndexedDB.
+ *
+ * Most developers will not need to access this class directly;
+ * it is exposed for advanced use cases.
+ */
+export declare class StorableRequest {
+    private readonly _requestData;
+    /**
+     * Converts a Request object to a plain object that can be structured
+     * cloned or JSON-stringified.
+     *
+     * @param request
+     * @returns
+     */
+    static fromRequest(request: Request): Promise<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).
+     */
+    constructor(requestData: RequestData);
+    /**
+     * Returns a deep clone of the instances `_requestData` object.
+     *
+     * @returns
+     */
+    toObject(): RequestData;
+    /**
+     * Converts this instance to a Request.
+     *
+     * @returns
+     */
+    toRequest(): Request;
+    /**
+     * Creates and returns a deep clone of the instance.
+     *
+     * @returns
+     */
+    clone(): StorableRequest;
+}
+//# sourceMappingURL=StorableRequest.d.ts.map

package/dist/plugins/backgroundSync/StorableRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorableRequest.d.ts","sourceRoot":"","sources":["../../../src/plugins/backgroundSync/StorableRequest.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAiBpD,MAAM,WAAW,WAAY,SAAQ,aAAa;IAChD,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,aAAa,CAAC;IACvB,IAAI,CAAC,EAAE,WAAW,CAAC;CACpB;AAED;;;;;;GAMG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAE3C;;;;;;OAMG;WACU,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC;IA6BpE;;;;;;OAMG;gBACS,WAAW,EAAE,WAAW;IAyBpC;;;;OAIG;IACH,QAAQ,IAAI,WAAW;IAUvB;;;;OAIG;IACH,SAAS,IAAI,OAAO;IAIpB;;;;OAIG;IACH,KAAK,IAAI,eAAe;CAGzB"}

package/dist/plugins/broadcastUpdate/BroadcastCacheUpdate.d.ts

@@ -0,0 +1,45 @@
+import type { CacheDidUpdateCallbackParam } from "../../types.js";
+import type { BroadcastCacheUpdateOptions } from "./types.js";
+/**
+ * A class that uses the `postMessage()` API to inform any open windows/tabs when
+ * a cached response has been updated.
+ *
+ * For efficiency's sake, the underlying response bodies are not compared;
+ * only specific response headers are checked.
+ */
+export declare class BroadcastCacheUpdate {
+    private readonly _headersToCheck;
+    private readonly _generatePayload;
+    private readonly _notifyAllClients;
+    /**
+     * Construct a BroadcastCacheUpdate instance with a specific `channelName` to
+     * broadcast messages on
+     *
+     * @param options
+     */
+    constructor({ generatePayload, headersToCheck, notifyAllClients }?: BroadcastCacheUpdateOptions);
+    /**
+     * Compares two responses and sends a message (via `postMessage()`) to all window clients if the
+     * responses differ. Neither of the Responses can be opaque.
+     *
+     * The message that's posted has the following format (where `payload` can
+     * be customized via the `generatePayload` option the instance is created
+     * with):
+     *
+     * ```
+     * {
+     *   type: 'CACHE_UPDATED',
+     *   meta: 'workbox-broadcast-update',
+     *   payload: {
+     *     cacheName: 'the-cache-name',
+     *     updatedURL: 'https://example.com/'
+     *   }
+     * }
+     * ```
+     *
+     * @param options
+     * @returns Resolves once the update is sent.
+     */
+    notifyIfUpdated(options: CacheDidUpdateCallbackParam): Promise<void>;
+}
+//# sourceMappingURL=BroadcastCacheUpdate.d.ts.map

package/dist/plugins/broadcastUpdate/BroadcastCacheUpdate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BroadcastCacheUpdate.d.ts","sourceRoot":"","sources":["../../../src/plugins/broadcastUpdate/BroadcastCacheUpdate.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,gBAAgB,CAAC;AAOlE,OAAO,KAAK,EAAE,2BAA2B,EAAiE,MAAM,YAAY,CAAC;AAuB7H;;;;;;GAMG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAW;IAC3C,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA4B;IAC7D,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAU;IAE5C;;;;;OAKG;gBACS,EAAE,eAAe,EAAE,cAAc,EAAE,gBAAgB,EAAE,GAAE,2BAAgC;IAMnG;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,eAAe,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;CA4E3E"}

package/dist/plugins/broadcastUpdate/BroadcastUpdatePlugin.d.ts

@@ -0,0 +1,27 @@
+import type { CacheDidUpdateCallbackParam, SerwistPlugin } from "../../types.js";
+import type { BroadcastCacheUpdateOptions } from "./types.js";
+/**
+ * A class implementing the `cacheDidUpdate` lifecycle callback. It will automatically
+ * broadcast a message whenever a cached response is updated.
+ */
+export declare class BroadcastUpdatePlugin implements SerwistPlugin {
+    private readonly _broadcastUpdate;
+    /**
+     * Construct a `serwist/plugins.BroadcastCacheUpdate` instance with
+     * the passed options and calls its `notifyIfUpdated` method whenever the
+     * plugin's `cacheDidUpdate` callback is invoked.
+     *
+     * @param options
+     */
+    constructor(options?: BroadcastCacheUpdateOptions);
+    /**
+     * A "lifecycle" callback that will be triggered automatically by
+     * `@serwist/build.RuntimeCaching` handlers when an entry is
+     * added to a cache.
+     *
+     * @private
+     * @param options The input object to this function.
+     */
+    cacheDidUpdate(options: CacheDidUpdateCallbackParam): void;
+}
+//# sourceMappingURL=BroadcastUpdatePlugin.d.ts.map

package/dist/plugins/broadcastUpdate/BroadcastUpdatePlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BroadcastUpdatePlugin.d.ts","sourceRoot":"","sources":["../../../src/plugins/broadcastUpdate/BroadcastUpdatePlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,2BAA2B,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEjF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAC;AAE9D;;;GAGG;AACH,qBAAa,qBAAsB,YAAW,aAAa;IACzD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAuB;IAExD;;;;;;OAMG;gBACS,OAAO,CAAC,EAAE,2BAA2B;IAIjD;;;;;;;OAOG;IACH,cAAc,CAAC,OAAO,EAAE,2BAA2B;CAGpD"}

package/dist/plugins/broadcastUpdate/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const CACHE_UPDATED_MESSAGE_TYPE = "CACHE_UPDATED";
+export declare const CACHE_UPDATED_MESSAGE_META = "serwist-broadcast-update";
+export declare const defaultNotifyAllClients = true;
+export declare const defaultHeadersToCheck: string[];
+//# sourceMappingURL=constants.d.ts.map

package/dist/plugins/broadcastUpdate/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/plugins/broadcastUpdate/constants.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,0BAA0B,kBAAkB,CAAC;AAC1D,eAAO,MAAM,0BAA0B,6BAA6B,CAAC;AACrE,eAAO,MAAM,uBAAuB,OAAO,CAAC;AAC5C,eAAO,MAAM,qBAAqB,UAA8C,CAAC"}

package/dist/plugins/broadcastUpdate/responsesAreSame.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Given two responses, compares several header values to see if they are
+ * the same or not.
+ *
+ * @param firstResponse The first response.
+ * @param secondResponse The second response.
+ * @param headersToCheck A list of headers to check.
+ * @returns
+ */
+export declare const responsesAreSame: (firstResponse: Response, secondResponse: Response, headersToCheck: string[]) => boolean;
+//# sourceMappingURL=responsesAreSame.d.ts.map

package/dist/plugins/broadcastUpdate/responsesAreSame.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responsesAreSame.d.ts","sourceRoot":"","sources":["../../../src/plugins/broadcastUpdate/responsesAreSame.ts"],"names":[],"mappings":"AAWA;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,kBAAmB,QAAQ,kBAAkB,QAAQ,kBAAkB,MAAM,EAAE,KAAG,OA4B9G,CAAC"}

package/dist/plugins/broadcastUpdate/types.d.ts

@@ -0,0 +1,34 @@
+import type { CacheDidUpdateCallbackParam } from "../../types.js";
+import type { CACHE_UPDATED_MESSAGE_META, CACHE_UPDATED_MESSAGE_TYPE } from "./constants.js";
+export interface BroadcastCacheUpdateOptions {
+    /**
+     * A list of headers that will be used to determine whether the responses
+     * differ.
+     *
+     * @default ['content-length', 'etag', 'last-modified']
+     */
+    headersToCheck?: string[];
+    /**
+     * A function whose return value
+     * will be used as the `payload` field in any cache update messages sent
+     * to the window clients.
+     * @param options
+     * @returns
+     */
+    generatePayload?: (options: CacheDidUpdateCallbackParam) => Record<string, any>;
+    /**
+     * If `true` (the default) then all open clients will receive a message. If `false`,
+     * then only the client that make the original request will be notified of the update.
+     *
+     * @default true
+     */
+    notifyAllClients?: boolean;
+}
+export type BroadcastPayload = Record<string, any>;
+export type BroadcastPayloadGenerator = (options: CacheDidUpdateCallbackParam) => BroadcastPayload;
+export interface BroadcastMessage {
+    type: typeof CACHE_UPDATED_MESSAGE_TYPE;
+    meta: typeof CACHE_UPDATED_MESSAGE_META;
+    payload: BroadcastPayload;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/plugins/broadcastUpdate/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/plugins/broadcastUpdate/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,KAAK,EAAE,0BAA0B,EAAE,0BAA0B,EAAE,MAAM,gBAAgB,CAAC;AAE7F,MAAM,WAAW,2BAA2B;IAC1C;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,2BAA2B,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAChF;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEnD,MAAM,MAAM,yBAAyB,GAAG,CAAC,OAAO,EAAE,2BAA2B,KAAK,gBAAgB,CAAC;AAEnG,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,0BAA0B,CAAC;IACxC,IAAI,EAAE,OAAO,0BAA0B,CAAC;IACxC,OAAO,EAAE,gBAAgB,CAAC;CAC3B"}

package/dist/plugins/cacheableResponse/CacheableResponse.d.ts

@@ -0,0 +1,40 @@
+export interface CacheableResponseOptions {
+    /**
+     * One or more status codes that a `Response` can have to be considered cacheable.
+     */
+    statuses?: number[];
+    /**
+     * A mapping of header names and expected values that a `Response` can have and be
+     * considered cacheable. If multiple headers are provided, only one needs to be present.
+     */
+    headers?: HeadersInit;
+}
+/**
+ * Allows you to set up rules determining what status codes and/or headers need
+ * to be present in order for a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
+ * to be considered cacheable.
+ */
+export declare class CacheableResponse {
+    private readonly _statuses?;
+    private readonly _headers?;
+    /**
+     * To construct a new CacheableResponse instance you must provide at least
+     * one of the `config` properties.
+     *
+     * If both `statuses` and `headers` are specified, then both conditions must
+     * be met for the `Response` to be considered cacheable.
+     *
+     * @param config
+     */
+    constructor(config?: CacheableResponseOptions);
+    /**
+     * Checks a response to see whether it's cacheable or not.
+     *
+     * @param response The response whose cacheability is being
+     * checked.
+     * @returns `true` if the `Response` is cacheable, and `false`
+     * otherwise.
+     */
+    isResponseCacheable(response: Response): boolean;
+}
+//# sourceMappingURL=CacheableResponse.d.ts.map

package/dist/plugins/cacheableResponse/CacheableResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CacheableResponse.d.ts","sourceRoot":"","sources":["../../../src/plugins/cacheableResponse/CacheableResponse.ts"],"names":[],"mappings":"AAaA,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;;OAGG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB;AAED;;;;GAIG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAuC;IAClE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAU;IAEpC;;;;;;;;OAQG;gBACS,MAAM,GAAE,wBAA6B;IAmCjD;;;;;;;OAOG;IACH,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO;CAyDjD"}

package/dist/plugins/cacheableResponse/CacheableResponsePlugin.d.ts

@@ -0,0 +1,27 @@
+import type { SerwistPlugin } from "../../types.js";
+import type { CacheableResponseOptions } from "./CacheableResponse.js";
+/**
+ * A class implementing the `cacheWillUpdate` lifecycle callback. This makes it
+ * easier to add in cacheability checks to requests made via Serwist's built-in
+ * strategies.
+ */
+export declare class CacheableResponsePlugin implements SerwistPlugin {
+    private readonly _cacheableResponse;
+    /**
+     * To construct a new CacheableResponsePlugin instance you must provide at
+     * least one of the `config` properties.
+     *
+     * If both `statuses` and `headers` are specified, then both conditions must
+     * be met for the `Response` to be considered cacheable.
+     *
+     * @param config
+     */
+    constructor(config: CacheableResponseOptions);
+    /**
+     * @param options
+     * @returns
+     * @private
+     */
+    cacheWillUpdate: SerwistPlugin["cacheWillUpdate"];
+}
+//# sourceMappingURL=CacheableResponsePlugin.d.ts.map

package/dist/plugins/cacheableResponse/CacheableResponsePlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CacheableResponsePlugin.d.ts","sourceRoot":"","sources":["../../../src/plugins/cacheableResponse/CacheableResponsePlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AAGvE;;;;GAIG;AACH,qBAAa,uBAAwB,YAAW,aAAa;IAC3D,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAoB;IAEvD;;;;;;;;OAQG;gBACS,MAAM,EAAE,wBAAwB;IAI5C;;;;OAIG;IACH,eAAe,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAK/C;CACH"}