serwist 9.0.0-preview.24 → 9.0.0-preview.26

package/src/{plugins/backgroundSync/QueueDb.ts → lib/backgroundSync/BackgroundSyncQueueDb.ts}

@@ -11,16 +11,16 @@ import { openDB } from "idb";
 
 import type { RequestData } from "./StorableRequest.js";
 
-interface QueueDBSchema extends DBSchema {
+interface BackgroundSyncQueueDBSchema extends DBSchema {
   requests: {
     key: number;
-    value: QueueStoreEntry;
+    value: BackgroundSyncQueueStoreEntry;
     indexes: { queueName: string };
   };
 }
 
-const DB_VERSION = 3;
-const DB_NAME = "serwist-background-sync";
+const BACKGROUND_SYNC_DB_VERSION = 3;
+const BACKGROUND_SYNC_DB_NAME = "serwist-background-sync";
 const REQUEST_OBJECT_STORE_NAME = "requests";
 const QUEUE_NAME_INDEX = "queueName";
 
@@ -32,7 +32,7 @@ export interface UnidentifiedQueueStoreEntry {
   metadata?: Record<string, unknown>;
 }
 
-export interface QueueStoreEntry extends UnidentifiedQueueStoreEntry {
+export interface BackgroundSyncQueueStoreEntry extends UnidentifiedQueueStoreEntry {
   id: number;
 }
 
@@ -44,8 +44,8 @@ export interface QueueStoreEntry extends UnidentifiedQueueStoreEntry {
  * @private
  */
 
-export class QueueDb {
-  private _db: IDBPDatabase<QueueDBSchema> | null = null;
+export class BackgroundSyncQueueDb {
+  private _db: IDBPDatabase<BackgroundSyncQueueDBSchema> | null = null;
 
   /**
    * Add QueueStoreEntry to underlying db.
@@ -57,7 +57,7 @@ export class QueueDb {
     const tx = db.transaction(REQUEST_OBJECT_STORE_NAME, "readwrite", {
       durability: "relaxed",
     });
-    await tx.store.add(entry as QueueStoreEntry);
+    await tx.store.add(entry as BackgroundSyncQueueStoreEntry);
     await tx.done;
   }
 
@@ -78,10 +78,10 @@ export class QueueDb {
    * @param queueName
    * @returns
    */
-  async getAllEntriesByQueueName(queueName: string): Promise<QueueStoreEntry[]> {
+  async getAllEntriesByQueueName(queueName: string): Promise<BackgroundSyncQueueStoreEntry[]> {
     const db = await this.getDb();
     const results = await db.getAllFromIndex(REQUEST_OBJECT_STORE_NAME, QUEUE_NAME_INDEX, IDBKeyRange.only(queueName));
-    return results ? results : new Array<QueueStoreEntry>();
+    return results ? results : new Array<BackgroundSyncQueueStoreEntry>();
   }
 
   /**
@@ -110,7 +110,7 @@ export class QueueDb {
    * @param queueName
    * @returns
    */
-  async getFirstEntryByQueueName(queueName: string): Promise<QueueStoreEntry | undefined> {
+  async getFirstEntryByQueueName(queueName: string): Promise<BackgroundSyncQueueStoreEntry | undefined> {
     return await this.getEndEntryFromIndex(IDBKeyRange.only(queueName), "next");
   }
 
@@ -119,7 +119,7 @@ export class QueueDb {
    * @param queueName
    * @returns
    */
-  async getLastEntryByQueueName(queueName: string): Promise<QueueStoreEntry | undefined> {
+  async getLastEntryByQueueName(queueName: string): Promise<BackgroundSyncQueueStoreEntry | undefined> {
     return await this.getEndEntryFromIndex(IDBKeyRange.only(queueName), "prev");
   }
 
@@ -132,7 +132,7 @@ export class QueueDb {
    * @returns
    * @private
    */
-  async getEndEntryFromIndex(query: IDBKeyRange, direction: IDBCursorDirection): Promise<QueueStoreEntry | undefined> {
+  async getEndEntryFromIndex(query: IDBKeyRange, direction: IDBCursorDirection): Promise<BackgroundSyncQueueStoreEntry | undefined> {
     const db = await this.getDb();
 
     const cursor = await db.transaction(REQUEST_OBJECT_STORE_NAME).store.index(QUEUE_NAME_INDEX).openCursor(query, direction);
@@ -146,7 +146,7 @@ export class QueueDb {
    */
   private async getDb() {
     if (!this._db) {
-      this._db = await openDB(DB_NAME, DB_VERSION, {
+      this._db = await openDB(BACKGROUND_SYNC_DB_NAME, BACKGROUND_SYNC_DB_VERSION, {
         upgrade: this._upgradeDb,
       });
     }
@@ -160,8 +160,8 @@ export class QueueDb {
    * @param oldVersion
    * @private
    */
-  private _upgradeDb(db: IDBPDatabase<QueueDBSchema>, oldVersion: number) {
-    if (oldVersion > 0 && oldVersion < DB_VERSION) {
+  private _upgradeDb(db: IDBPDatabase<BackgroundSyncQueueDBSchema>, oldVersion: number) {
+    if (oldVersion > 0 && oldVersion < BACKGROUND_SYNC_DB_VERSION) {
       if (db.objectStoreNames.contains(REQUEST_OBJECT_STORE_NAME)) {
         db.deleteObjectStore(REQUEST_OBJECT_STORE_NAME);
       }

package/src/{plugins/backgroundSync/QueueStore.ts → lib/backgroundSync/BackgroundSyncQueueStore.ts}

@@ -6,8 +6,8 @@
   https://opensource.org/licenses/MIT.
 */
 import { assert } from "../../utils/assert.js";
-import type { QueueStoreEntry, UnidentifiedQueueStoreEntry } from "./QueueDb.js";
-import { QueueDb } from "./QueueDb.js";
+import type { BackgroundSyncQueueStoreEntry, UnidentifiedQueueStoreEntry } from "./BackgroundSyncQueueDb.js";
+import { BackgroundSyncQueueDb } from "./BackgroundSyncQueueDb.js";
 
 /**
  * A class to manage storing requests from a Queue in IndexedDB,
@@ -16,9 +16,9 @@ import { QueueDb } from "./QueueDb.js";
  * Most developers will not need to access this class directly;
  * it is exposed for advanced use cases.
  */
-export class QueueStore {
+export class BackgroundSyncQueueStore {
   private readonly _queueName: string;
-  private readonly _queueDb: QueueDb;
+  private readonly _queueDb: BackgroundSyncQueueDb;
 
   /**
    * Associates this instance with a Queue instance, so entries added can be
@@ -28,7 +28,7 @@ export class QueueStore {
    */
   constructor(queueName: string) {
     this._queueName = queueName;
-    this._queueDb = new QueueDb();
+    this._queueDb = new BackgroundSyncQueueDb();
   }
 
   /**
@@ -39,13 +39,13 @@ export class QueueStore {
   async pushEntry(entry: UnidentifiedQueueStoreEntry): Promise<void> {
     if (process.env.NODE_ENV !== "production") {
       assert!.isType(entry, "object", {
-        moduleName: "serwist/plugins",
+        moduleName: "serwist",
         className: "BackgroundSyncQueueStore",
         funcName: "pushEntry",
         paramName: "entry",
       });
       assert!.isType(entry.requestData, "object", {
-        moduleName: "serwist/plugins",
+        moduleName: "serwist",
         className: "BackgroundSyncQueueStore",
         funcName: "pushEntry",
         paramName: "entry.requestData",
@@ -67,13 +67,13 @@ export class QueueStore {
   async unshiftEntry(entry: UnidentifiedQueueStoreEntry): Promise<void> {
     if (process.env.NODE_ENV !== "production") {
       assert!.isType(entry, "object", {
-        moduleName: "serwist/plugins",
+        moduleName: "serwist",
         className: "BackgroundSyncQueueStore",
         funcName: "unshiftEntry",
         paramName: "entry",
       });
       assert!.isType(entry.requestData, "object", {
-        moduleName: "serwist/plugins",
+        moduleName: "serwist",
         className: "BackgroundSyncQueueStore",
         funcName: "unshiftEntry",
         paramName: "entry.requestData",
@@ -99,7 +99,7 @@ export class QueueStore {
    *
    * @returns
    */
-  async popEntry(): Promise<QueueStoreEntry | undefined> {
+  async popEntry(): Promise<BackgroundSyncQueueStoreEntry | undefined> {
     return this._removeEntry(await this._queueDb.getLastEntryByQueueName(this._queueName));
   }
 
@@ -108,7 +108,7 @@ export class QueueStore {
    *
    * @returns
    */
-  async shiftEntry(): Promise<QueueStoreEntry | undefined> {
+  async shiftEntry(): Promise<BackgroundSyncQueueStoreEntry | undefined> {
     return this._removeEntry(await this._queueDb.getFirstEntryByQueueName(this._queueName));
   }
 
@@ -117,7 +117,7 @@ export class QueueStore {
    *
    * @returns
    */
-  async getAll(): Promise<QueueStoreEntry[]> {
+  async getAll(): Promise<BackgroundSyncQueueStoreEntry[]> {
     return await this._queueDb.getAllEntriesByQueueName(this._queueName);
   }
 
@@ -151,7 +151,7 @@ export class QueueStore {
    * @returns
    * @private
    */
-  async _removeEntry(entry?: QueueStoreEntry): Promise<QueueStoreEntry | undefined> {
+  async _removeEntry(entry?: BackgroundSyncQueueStoreEntry): Promise<BackgroundSyncQueueStoreEntry | undefined> {
     if (entry) {
       await this.deleteEntry(entry.id);
     }

package/src/{plugins → lib}/backgroundSync/StorableRequest.ts

@@ -85,13 +85,13 @@ export class StorableRequest {
   constructor(requestData: RequestData) {
     if (process.env.NODE_ENV !== "production") {
       assert!.isType(requestData, "object", {
-        moduleName: "serwist/plugins",
+        moduleName: "serwist",
         className: "StorableRequest",
         funcName: "constructor",
         paramName: "requestData",
       });
       assert!.isType(requestData.url, "string", {
-        moduleName: "serwist/plugins",
+        moduleName: "serwist",
         className: "StorableRequest",
         funcName: "constructor",
         paramName: "requestData.url",

package/src/{plugins → lib}/broadcastUpdate/BroadcastCacheUpdate.ts

@@ -11,7 +11,12 @@ import { assert } from "../../utils/assert.js";
 import { logger } from "../../utils/logger.js";
 import { resultingClientExists } from "../../utils/resultingClientExists.js";
 import { timeout } from "../../utils/timeout.js";
-import { CACHE_UPDATED_MESSAGE_META, CACHE_UPDATED_MESSAGE_TYPE, defaultHeadersToCheck, defaultNotifyAllClients } from "./constants.js";
+import {
+  BROADCAST_UPDATE_DEFAULT_HEADERS,
+  BROADCAST_UPDATE_DEFAULT_NOTIFY,
+  BROADCAST_UPDATE_MESSAGE_META,
+  BROADCAST_UPDATE_MESSAGE_TYPE,
+} from "./constants.js";
 import { responsesAreSame } from "./responsesAreSame.js";
 import type { BroadcastCacheUpdateOptions, BroadcastMessage, BroadcastPayload, BroadcastPayloadGenerator } from "./types.js";
 
@@ -21,7 +26,7 @@ import type { BroadcastCacheUpdateOptions, BroadcastMessage, BroadcastPayload, B
 const isSafari = typeof navigator !== "undefined" && /^((?!chrome|android).)*safari/i.test(navigator.userAgent);
 
 // Give TypeScript the correct global.
-declare let self: ServiceWorkerGlobalScope;
+declare const self: ServiceWorkerGlobalScope;
 /**
  * Generates the default payload used in update messages. By default the
  * payload includes the `cacheName` and `updatedURL` fields.
@@ -55,9 +60,9 @@ export class BroadcastCacheUpdate {
    * @param options
    */
   constructor({ generatePayload, headersToCheck, notifyAllClients }: BroadcastCacheUpdateOptions = {}) {
-    this._headersToCheck = headersToCheck || defaultHeadersToCheck;
+    this._headersToCheck = headersToCheck || BROADCAST_UPDATE_DEFAULT_HEADERS;
     this._generatePayload = generatePayload || defaultPayloadGenerator;
-    this._notifyAllClients = notifyAllClients ?? defaultNotifyAllClients;
+    this._notifyAllClients = notifyAllClients ?? BROADCAST_UPDATE_DEFAULT_NOTIFY;
   }
 
   /**
@@ -85,19 +90,19 @@ export class BroadcastCacheUpdate {
   async notifyIfUpdated(options: CacheDidUpdateCallbackParam): Promise<void> {
     if (process.env.NODE_ENV !== "production") {
       assert!.isType(options.cacheName, "string", {
-        moduleName: "serwist/plugins",
+        moduleName: "serwist",
         className: "BroadcastCacheUpdate",
         funcName: "notifyIfUpdated",
         paramName: "cacheName",
       });
       assert!.isInstance(options.newResponse, Response, {
-        moduleName: "serwist/plugins",
+        moduleName: "serwist",
         className: "BroadcastCacheUpdate",
         funcName: "notifyIfUpdated",
         paramName: "newResponse",
       });
       assert!.isInstance(options.request, Request, {
-        moduleName: "serwist/plugins",
+        moduleName: "serwist",
         className: "BroadcastCacheUpdate",
         funcName: "notifyIfUpdated",
         paramName: "request",
@@ -115,8 +120,8 @@ export class BroadcastCacheUpdate {
       }
 
       const messageData = {
-        type: CACHE_UPDATED_MESSAGE_TYPE,
-        meta: CACHE_UPDATED_MESSAGE_META,
+        type: BROADCAST_UPDATE_MESSAGE_TYPE,
+        meta: BROADCAST_UPDATE_MESSAGE_META,
         payload: this._generatePayload(options),
       } satisfies BroadcastMessage;
 

package/src/{plugins → lib}/broadcastUpdate/BroadcastUpdatePlugin.ts

@@ -18,7 +18,7 @@ export class BroadcastUpdatePlugin implements SerwistPlugin {
   private readonly _broadcastUpdate: BroadcastCacheUpdate;
 
   /**
-   * Construct a `serwist/plugins.BroadcastCacheUpdate` instance with
+   * Construct a `serwist.BroadcastCacheUpdate` instance with
    * the passed options and calls its `notifyIfUpdated` method whenever the
    * plugin's `cacheDidUpdate` callback is invoked.
    *

package/src/lib/broadcastUpdate/constants.ts

@@ -0,0 +1,12 @@
+/*
+  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.
+*/
+
+export const BROADCAST_UPDATE_MESSAGE_TYPE = "CACHE_UPDATED";
+export const BROADCAST_UPDATE_MESSAGE_META = "serwist-broadcast-update";
+export const BROADCAST_UPDATE_DEFAULT_NOTIFY = true;
+export const BROADCAST_UPDATE_DEFAULT_HEADERS = ["content-length", "etag", "last-modified"];

package/src/{plugins → lib}/broadcastUpdate/types.ts

@@ -1,5 +1,5 @@
 import type { CacheDidUpdateCallbackParam } from "../../types.js";
-import type { CACHE_UPDATED_MESSAGE_META, CACHE_UPDATED_MESSAGE_TYPE } from "./constants.js";
+import type { BROADCAST_UPDATE_MESSAGE_META, BROADCAST_UPDATE_MESSAGE_TYPE } from "./constants.js";
 
 export interface BroadcastCacheUpdateOptions {
   /**
@@ -31,7 +31,7 @@ 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;
+  type: typeof BROADCAST_UPDATE_MESSAGE_TYPE;
+  meta: typeof BROADCAST_UPDATE_MESSAGE_META;
   payload: BroadcastPayload;
 }

package/src/{plugins → lib}/cacheableResponse/CacheableResponse.ts

@@ -6,8 +6,8 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { assert } from "../../utils/assert.js";
 import { SerwistError } from "../../utils/SerwistError.js";
+import { assert } from "../../utils/assert.js";
 import { getFriendlyURL } from "../../utils/getFriendlyURL.js";
 import { logger } from "../../utils/logger.js";
 
@@ -45,7 +45,7 @@ export class CacheableResponse {
     if (process.env.NODE_ENV !== "production") {
       if (!(config.statuses || config.headers)) {
         throw new SerwistError("statuses-or-headers-required", {
-          moduleName: "serwist/plugins",
+          moduleName: "serwist",
           className: "CacheableResponse",
           funcName: "constructor",
         });
@@ -53,7 +53,7 @@ export class CacheableResponse {
 
       if (config.statuses) {
         assert!.isArray(config.statuses, {
-          moduleName: "serwist/plugins",
+          moduleName: "serwist",
           className: "CacheableResponse",
           funcName: "constructor",
           paramName: "config.statuses",
@@ -62,7 +62,7 @@ export class CacheableResponse {
 
       if (config.headers) {
         assert!.isType(config.headers, "object", {
-          moduleName: "serwist/plugins",
+          moduleName: "serwist",
           className: "CacheableResponse",
           funcName: "constructor",
           paramName: "config.headers",
@@ -87,7 +87,7 @@ export class CacheableResponse {
   isResponseCacheable(response: Response): boolean {
     if (process.env.NODE_ENV !== "production") {
       assert!.isInstance(response, Response, {
-        moduleName: "serwist/plugins",
+        moduleName: "serwist",
         className: "CacheableResponse",
         funcName: "isResponseCacheable",
         paramName: "response",

package/src/{plugins → lib}/expiration/CacheExpiration.ts

@@ -6,8 +6,8 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { assert } from "../../utils/assert.js";
 import { SerwistError } from "../../utils/SerwistError.js";
+import { assert } from "../../utils/assert.js";
 import { logger } from "../../utils/logger.js";
 import { CacheTimestampsModel } from "./models/CacheTimestampsModel.js";
 
@@ -30,7 +30,7 @@ interface CacheExpirationConfig {
 
 /**
  * Allows you to expires cached responses based on age or maximum number of entries.
- * @see https://serwist.pages.dev/docs/expiration/cache-expiration
+ * @see https://serwist.pages.dev/docs/serwist/core/cache-expiration
  */
 export class CacheExpiration {
   private _isRunning = false;
@@ -51,7 +51,7 @@ export class CacheExpiration {
   constructor(cacheName: string, config: CacheExpirationConfig = {}) {
     if (process.env.NODE_ENV !== "production") {
       assert!.isType(cacheName, "string", {
-        moduleName: "serwist/plugins",
+        moduleName: "serwist",
         className: "CacheExpiration",
         funcName: "constructor",
         paramName: "cacheName",
@@ -59,7 +59,7 @@ export class CacheExpiration {
 
       if (!(config.maxEntries || config.maxAgeSeconds)) {
         throw new SerwistError("max-entries-or-age-required", {
-          moduleName: "serwist/plugins",
+          moduleName: "serwist",
           className: "CacheExpiration",
           funcName: "constructor",
         });
@@ -67,7 +67,7 @@ export class CacheExpiration {
 
       if (config.maxEntries) {
         assert!.isType(config.maxEntries, "number", {
-          moduleName: "serwist/plugins",
+          moduleName: "serwist",
           className: "CacheExpiration",
           funcName: "constructor",
           paramName: "config.maxEntries",
@@ -76,7 +76,7 @@ export class CacheExpiration {
 
       if (config.maxAgeSeconds) {
         assert!.isType(config.maxAgeSeconds, "number", {
-          moduleName: "serwist/plugins",
+          moduleName: "serwist",
           className: "CacheExpiration",
           funcName: "constructor",
           paramName: "config.maxAgeSeconds",
@@ -145,7 +145,7 @@ export class CacheExpiration {
   async updateTimestamp(url: string): Promise<void> {
     if (process.env.NODE_ENV !== "production") {
       assert!.isType(url, "string", {
-        moduleName: "serwist/plugins",
+        moduleName: "serwist",
         className: "CacheExpiration",
         funcName: "updateTimestamp",
         paramName: "url",

package/src/{plugins → lib}/expiration/ExpirationPlugin.ts

@@ -6,13 +6,13 @@
   https://opensource.org/licenses/MIT.
 */
 
-import type { CacheDidUpdateCallbackParam, CachedResponseWillBeUsedCallbackParam, SerwistPlugin } from "../../types.js";
 import { registerQuotaErrorCallback } from "../../registerQuotaErrorCallback.js";
-import { assert } from "../../utils/assert.js";
+import type { CacheDidUpdateCallbackParam, CachedResponseWillBeUsedCallbackParam, SerwistPlugin } from "../../types.js";
 import { SerwistError } from "../../utils/SerwistError.js";
+import { assert } from "../../utils/assert.js";
+import { cacheNames as privateCacheNames } from "../../utils/cacheNames.js";
 import { getFriendlyURL } from "../../utils/getFriendlyURL.js";
 import { logger } from "../../utils/logger.js";
-import { cacheNames as privateCacheNames } from "../../utils/cacheNames.js";
 import { CacheExpiration } from "./CacheExpiration.js";
 
 export interface ExpirationPluginOptions {
@@ -62,7 +62,7 @@ export interface ExpirationPluginOptions {
  * When using `maxEntries`, the least recently requested entry will be removed
  * from the cache.
  *
- * @see https://serwist.pages.dev/docs/expiration/expiration-plugin
+ * @see https://serwist.pages.dev/docs/serwist/runtime-caching/plugins/expiration-plugin
  */
 export class ExpirationPlugin implements SerwistPlugin {
   private readonly _config: ExpirationPluginOptions;
@@ -75,7 +75,7 @@ export class ExpirationPlugin implements SerwistPlugin {
     if (process.env.NODE_ENV !== "production") {
       if (!(config.maxEntries || config.maxAgeSeconds)) {
         throw new SerwistError("max-entries-or-age-required", {
-          moduleName: "serwist/plugins",
+          moduleName: "serwist",
           className: "ExpirationPlugin",
           funcName: "constructor",
         });
@@ -83,7 +83,7 @@ export class ExpirationPlugin implements SerwistPlugin {
 
       if (config.maxEntries) {
         assert!.isType(config.maxEntries, "number", {
-          moduleName: "serwist/plugins",
+          moduleName: "serwist",
           className: "ExpirationPlugin",
           funcName: "constructor",
           paramName: "config.maxEntries",
@@ -92,7 +92,7 @@ export class ExpirationPlugin implements SerwistPlugin {
 
       if (config.maxAgeSeconds) {
         assert!.isType(config.maxAgeSeconds, "number", {
-          moduleName: "serwist/plugins",
+          moduleName: "serwist",
           className: "ExpirationPlugin",
           funcName: "constructor",
           paramName: "config.maxAgeSeconds",
@@ -101,7 +101,7 @@ export class ExpirationPlugin implements SerwistPlugin {
 
       if (config.maxAgeFrom) {
         assert!.isType(config.maxAgeFrom, "string", {
-          moduleName: "serwist/plugins",
+          moduleName: "serwist",
           className: "ExpirationPlugin",
           funcName: "constructor",
           paramName: "config.maxAgeFrom",
@@ -256,13 +256,13 @@ export class ExpirationPlugin implements SerwistPlugin {
   async cacheDidUpdate({ cacheName, request }: CacheDidUpdateCallbackParam) {
     if (process.env.NODE_ENV !== "production") {
       assert!.isType(cacheName, "string", {
-        moduleName: "serwist/plugins",
+        moduleName: "serwist",
         className: "Plugin",
         funcName: "cacheDidUpdate",
         paramName: "cacheName",
       });
       assert!.isInstance(request, Request, {
-        moduleName: "serwist/plugins",
+        moduleName: "serwist",
         className: "Plugin",
         funcName: "cacheDidUpdate",
         paramName: "request",

package/src/lib/googleAnalytics/constants.ts

@@ -0,0 +1,22 @@
+/*
+  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.
+*/
+
+export const QUEUE_NAME = "serwist-google-analytics";
+export const MAX_RETENTION_TIME = 60 * 48; // Two days in minutes
+export const GOOGLE_ANALYTICS_HOST = "www.google-analytics.com";
+export const GTM_HOST = "www.googletagmanager.com";
+export const ANALYTICS_JS_PATH = "/analytics.js";
+export const GTAG_JS_PATH = "/gtag/js";
+export const GTM_JS_PATH = "/gtm.js";
+export const COLLECT_DEFAULT_PATH = "/collect";
+
+// This RegExp matches all known Measurement Protocol single-hit collect
+// endpoints. Most of the time the default path (/collect) is used, but
+// occasionally an experimental endpoint is used when testing new features,
+// (e.g. /r/collect or /j/collect)
+export const COLLECT_PATHS_REGEX = /^\/(\w+\/)?collect/;

package/src/{plugins/googleAnalytics/initialize.ts → lib/googleAnalytics/initializeGoogleAnalytics.ts}

@@ -6,15 +6,16 @@
   https://opensource.org/licenses/MIT.
 */
 
+import { Route } from "../../Route.js";
+import type { Serwist } from "../../Serwist.js";
+import { NetworkFirst } from "../../lib/strategies/NetworkFirst.js";
+import { NetworkOnly } from "../../lib/strategies/NetworkOnly.js";
 import type { RouteMatchCallbackOptions } from "../../types.js";
+import { cacheNames as privateCacheNames } from "../../utils/cacheNames.js";
 import { getFriendlyURL } from "../../utils/getFriendlyURL.js";
 import { logger } from "../../utils/logger.js";
-import { cacheNames as privateCacheNames } from "../../utils/cacheNames.js";
-import { Route } from "../../Route.js";
-import { NetworkFirst } from "../../strategies/NetworkFirst.js";
-import { NetworkOnly } from "../../strategies/NetworkOnly.js";
 import { BackgroundSyncPlugin } from "../backgroundSync/BackgroundSyncPlugin.js";
-import type { Queue, QueueEntry } from "../backgroundSync/Queue.js";
+import type { BackgroundSyncQueue, BackgroundSyncQueueEntry } from "../backgroundSync/BackgroundSyncQueue.js";
 import {
   ANALYTICS_JS_PATH,
   COLLECT_PATHS_REGEX,
@@ -25,7 +26,6 @@ import {
   MAX_RETENTION_TIME,
   QUEUE_NAME,
 } from "./constants.js";
-import type { Serwist } from "../../Serwist.js";
 
 export interface GoogleAnalyticsInitializeOptions {
   serwist: Serwist;
@@ -59,8 +59,8 @@ export interface GoogleAnalyticsInitializeOptions {
  * @private
  */
 const createOnSyncCallback = (config: Pick<GoogleAnalyticsInitializeOptions, "parameterOverrides" | "hitFilter">) => {
-  return async ({ queue }: { queue: Queue }) => {
-    let entry: QueueEntry | undefined = undefined;
+  return async ({ queue }: { queue: BackgroundSyncQueue }) => {
+    let entry: BackgroundSyncQueueEntry | undefined = undefined;
     while ((entry = await queue.shiftRequest())) {
       const { request, timestamp } = entry;
       const url = new URL(request.url);
@@ -188,7 +188,7 @@ const createGtmJsRoute = (cacheName: string) => {
  *
  * @param options
  */
-export const initialize = ({ serwist, cacheName, ...options }: GoogleAnalyticsInitializeOptions): void => {
+export const initializeGoogleAnalytics = ({ serwist, cacheName, ...options }: GoogleAnalyticsInitializeOptions): void => {
   const resolvedCacheName = privateCacheNames.getGoogleAnalyticsName(cacheName);
 
   const bgSyncPlugin = new BackgroundSyncPlugin(QUEUE_NAME, {

package/src/{strategies → lib/strategies}/CacheFirst.ts

@@ -6,9 +6,9 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { assert } from "../utils/assert.js";
-import { SerwistError } from "../utils/SerwistError.js";
-import { logger } from "../utils/logger.js";
+import { SerwistError } from "../../utils/SerwistError.js";
+import { assert } from "../../utils/assert.js";
+import { logger } from "../../utils/logger.js";
 import { Strategy } from "./Strategy.js";
 import type { StrategyHandler } from "./StrategyHandler.js";
 import { messages } from "./utils/messages.js";
@@ -18,7 +18,7 @@ import { messages } from "./utils/messages.js";
  * request strategy.
  *
  * A cache first strategy is useful for assets that have been revisioned,
- * such as URLs like `/styles/example.a8f5f1.css`, since they
+ * such as URLs like "/styles/example.a8f5f1.css", since they
  * can be cached for long periods of time.
  *
  * If the network request fails, and there is no cache match, this will throw
@@ -36,7 +36,7 @@ export class CacheFirst extends Strategy {
 
     if (process.env.NODE_ENV !== "production") {
       assert!.isInstance(request, Request, {
-        moduleName: "serwist/strategies",
+        moduleName: "serwist",
         className: this.constructor.name,
         funcName: "makeRequest",
         paramName: "request",

package/src/{strategies → lib/strategies}/CacheOnly.ts

@@ -6,18 +6,18 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { assert } from "../utils/assert.js";
-import { SerwistError } from "../utils/SerwistError.js";
-import { logger } from "../utils/logger.js";
+import { SerwistError } from "../../utils/SerwistError.js";
+import { assert } from "../../utils/assert.js";
+import { logger } from "../../utils/logger.js";
 import { Strategy } from "./Strategy.js";
 import type { StrategyHandler } from "./StrategyHandler.js";
 import { messages } from "./utils/messages.js";
 
 /**
- * An implementation of the [cache only](https://developer.chrome.com/docs/workbox/caching-strategies-overview/#cache-only)
+ * An implementation of the [cache only](https://developer.chrome.com/docs/workbox/caching-strategies-overview/#cache_only)
  * request strategy.
  *
- * This class is useful if you want to take advantage of any Serwist plugin.
+ * This class is useful if you already have your own precaching step.
  *
  * If there is no cache match, this will throw a `SerwistError` exception.
  */
@@ -31,7 +31,7 @@ export class CacheOnly extends Strategy {
   async _handle(request: Request, handler: StrategyHandler): Promise<Response> {
     if (process.env.NODE_ENV !== "production") {
       assert!.isInstance(request, Request, {
-        moduleName: "serwist/strategies",
+        moduleName: "serwist",
         className: this.constructor.name,
         funcName: "makeRequest",
         paramName: "request",