@serwist/google-analytics 9.0.0-preview.17 → 9.0.0-preview.19

package/dist/index.d.ts

@@ -1,5 +1,3 @@
-import type { GoogleAnalyticsInitializeOptions } from "./initialize.js";
-import { initialize } from "./initialize.js";
-export { initialize };
-export type { GoogleAnalyticsInitializeOptions };
+export { initializeGoogleAnalytics as initialize } from "@serwist/sw/plugins";
+export type { GoogleAnalyticsInitializeOptions } from "@serwist/sw/plugins";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,EAAE,UAAU,EAAE,CAAC;AACtB,YAAY,EAAE,gCAAgC,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,IAAI,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC9E,YAAY,EAAE,gCAAgC,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/index.js

@@ -1,5 +1 @@
-export { initialize } from './initialize.js';
-import '@serwist/background-sync';
-import '@serwist/core/internal';
-import '@serwist/routing';
-import '@serwist/strategies';
+export { initializeGoogleAnalytics as initialize } from '@serwist/sw/plugins';

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@serwist/google-analytics",
-  "version": "9.0.0-preview.17",
+  "version": "9.0.0-preview.19",
   "type": "module",
-  "description": "Queues failed requests and uses the Background Sync API to replay them when the network is available",
+  "description": "Queues failed requests and uses the Background Sync API to replay them when the network is available.",
   "files": [
     "src",
     "dist"
@@ -18,15 +18,15 @@
   ],
   "author": "Google's Web DevRel Team, Serwist's Team",
   "license": "MIT",
-  "repository": "serwist/serwist",
-  "bugs": "https://github.com/serwist/serwist/issues",
+  "repository": "https://gitlab.com/serwist/serwist",
+  "bugs": "https://gitlab.com/serwist/serwist/issues",
   "homepage": "https://serwist.pages.dev",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "typesVersions": {
     "*": {
       "initialize": [
-        "./dist/initialize.d.ts"
+        "./dist/index.d.ts"
       ]
     }
   },
@@ -36,21 +36,18 @@
       "default": "./dist/index.js"
     },
     "./initialize": {
-      "types": "./dist/initialize.d.ts",
-      "default": "./dist/initialize.js"
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     },
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@serwist/background-sync": "9.0.0-preview.17",
-    "@serwist/core": "9.0.0-preview.17",
-    "@serwist/routing": "9.0.0-preview.17",
-    "@serwist/strategies": "9.0.0-preview.17"
+    "@serwist/sw": "9.0.0-preview.19"
   },
   "devDependencies": {
     "rollup": "4.13.0",
     "typescript": "5.5.0-dev.20240323",
-    "@serwist/constants": "9.0.0-preview.17"
+    "@serwist/constants": "9.0.0-preview.19"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"
@@ -62,7 +59,6 @@
   },
   "scripts": {
     "build": "rimraf dist && cross-env NODE_ENV=production rollup --config rollup.config.js",
-    "dev": "rollup --config rollup.config.js --watch",
     "lint": "biome lint ./src",
     "typecheck": "tsc"
   }

package/src/index.ts

@@ -1,13 +1,2 @@
-/*
-  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 type { GoogleAnalyticsInitializeOptions } from "./initialize.js";
-import { initialize } from "./initialize.js";
-
-export { initialize };
-export type { GoogleAnalyticsInitializeOptions };
+export { initializeGoogleAnalytics as initialize } from "@serwist/sw/plugins";
+export type { GoogleAnalyticsInitializeOptions } from "@serwist/sw/plugins";

package/dist/initialize.d.ts

@@ -1,26 +0,0 @@
-export interface GoogleAnalyticsInitializeOptions {
-    /**
-     * The cache name to store and retrieve analytics.js. Defaults to the cache names provided by `@serwist/core`.
-     */
-    cacheName?: string;
-    /**
-     * [Measurement Protocol parameters](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters),
-     * expressed as key/value pairs, to be added to replayed Google Analytics
-     * requests. This can be used to, e.g., set a custom dimension indicating
-     * that the request was replayed.
-     */
-    parameterOverrides?: {
-        [paramName: string]: string;
-    };
-    /**
-     * A function that allows you to modify the hit parameters prior to replaying
-     * the hit. The function is invoked with the original hit's URLSearchParams
-     * object as its only argument.
-     */
-    hitFilter?: (params: URLSearchParams) => void;
-}
-/**
- * @param options
- */
-export declare const initialize: (options?: GoogleAnalyticsInitializeOptions) => void;
-//# sourceMappingURL=initialize.d.ts.map

package/dist/initialize.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"initialize.d.ts","sourceRoot":"","sources":["../src/initialize.ts"],"names":[],"mappings":"AA0BA,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE;QAAE,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACrD;;;;OAIG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,CAAC;CAC/C;AAyID;;GAEG;AACH,eAAO,MAAM,UAAU,aAAa,gCAAgC,KAAQ,IAa3E,CAAC"}

package/dist/initialize.js

@@ -1,110 +0,0 @@
-import { BackgroundSyncPlugin } from '@serwist/background-sync';
-import { privateCacheNames, logger, getFriendlyURL } from '@serwist/core/internal';
-import { registerRoute, Route } from '@serwist/routing';
-import { NetworkOnly, NetworkFirst } from '@serwist/strategies';
-
-const QUEUE_NAME = "serwist-google-analytics";
-const MAX_RETENTION_TIME = 60 * 48;
-const GOOGLE_ANALYTICS_HOST = "www.google-analytics.com";
-const GTM_HOST = "www.googletagmanager.com";
-const ANALYTICS_JS_PATH = "/analytics.js";
-const GTAG_JS_PATH = "/gtag/js";
-const GTM_JS_PATH = "/gtm.js";
-const COLLECT_PATHS_REGEX = /^\/(\w+\/)?collect/;
-
-const createOnSyncCallback = (config)=>{
-    return async ({ queue })=>{
-        let entry = undefined;
-        while(entry = await queue.shiftRequest()){
-            const { request, timestamp } = entry;
-            const url = new URL(request.url);
-            try {
-                const params = request.method === "POST" ? new URLSearchParams(await request.clone().text()) : url.searchParams;
-                const originalHitTime = timestamp - (Number(params.get("qt")) || 0);
-                const queueTime = Date.now() - originalHitTime;
-                params.set("qt", String(queueTime));
-                if (config.parameterOverrides) {
-                    for (const param of Object.keys(config.parameterOverrides)){
-                        const value = config.parameterOverrides[param];
-                        params.set(param, value);
-                    }
-                }
-                if (typeof config.hitFilter === "function") {
-                    config.hitFilter.call(null, params);
-                }
-                await fetch(new Request(url.origin + url.pathname, {
-                    body: params.toString(),
-                    method: "POST",
-                    mode: "cors",
-                    credentials: "omit",
-                    headers: {
-                        "Content-Type": "text/plain"
-                    }
-                }));
-                if (process.env.NODE_ENV !== "production") {
-                    logger.log(`Request for '${getFriendlyURL(url.href)}' has been replayed`);
-                }
-            } catch (err) {
-                await queue.unshiftRequest(entry);
-                if (process.env.NODE_ENV !== "production") {
-                    logger.log(`Request for '${getFriendlyURL(url.href)}' failed to replay, putting it back in the queue.`);
-                }
-                throw err;
-            }
-        }
-        if (process.env.NODE_ENV !== "production") {
-            logger.log("All Google Analytics request successfully replayed; " + "the queue is now empty!");
-        }
-    };
-};
-const createCollectRoutes = (bgSyncPlugin)=>{
-    const match = ({ url })=>url.hostname === GOOGLE_ANALYTICS_HOST && COLLECT_PATHS_REGEX.test(url.pathname);
-    const handler = new NetworkOnly({
-        plugins: [
-            bgSyncPlugin
-        ]
-    });
-    return [
-        new Route(match, handler, "GET"),
-        new Route(match, handler, "POST")
-    ];
-};
-const createAnalyticsJsRoute = (cacheName)=>{
-    const match = ({ url })=>url.hostname === GOOGLE_ANALYTICS_HOST && url.pathname === ANALYTICS_JS_PATH;
-    const handler = new NetworkFirst({
-        cacheName
-    });
-    return new Route(match, handler, "GET");
-};
-const createGtagJsRoute = (cacheName)=>{
-    const match = ({ url })=>url.hostname === GTM_HOST && url.pathname === GTAG_JS_PATH;
-    const handler = new NetworkFirst({
-        cacheName
-    });
-    return new Route(match, handler, "GET");
-};
-const createGtmJsRoute = (cacheName)=>{
-    const match = ({ url })=>url.hostname === GTM_HOST && url.pathname === GTM_JS_PATH;
-    const handler = new NetworkFirst({
-        cacheName
-    });
-    return new Route(match, handler, "GET");
-};
-const initialize = (options = {})=>{
-    const cacheName = privateCacheNames.getGoogleAnalyticsName(options.cacheName);
-    const bgSyncPlugin = new BackgroundSyncPlugin(QUEUE_NAME, {
-        maxRetentionTime: MAX_RETENTION_TIME,
-        onSync: createOnSyncCallback(options)
-    });
-    const routes = [
-        createGtmJsRoute(cacheName),
-        createAnalyticsJsRoute(cacheName),
-        createGtagJsRoute(cacheName),
-        ...createCollectRoutes(bgSyncPlugin)
-    ];
-    for (const route of routes){
-        registerRoute(route);
-    }
-};
-
-export { initialize };

package/dist/utils/constants.d.ts

@@ -1,10 +0,0 @@
-export declare const QUEUE_NAME = "serwist-google-analytics";
-export declare const MAX_RETENTION_TIME: number;
-export declare const GOOGLE_ANALYTICS_HOST = "www.google-analytics.com";
-export declare const GTM_HOST = "www.googletagmanager.com";
-export declare const ANALYTICS_JS_PATH = "/analytics.js";
-export declare const GTAG_JS_PATH = "/gtag/js";
-export declare const GTM_JS_PATH = "/gtm.js";
-export declare const COLLECT_DEFAULT_PATH = "/collect";
-export declare const COLLECT_PATHS_REGEX: RegExp;
-//# sourceMappingURL=constants.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/utils/constants.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,UAAU,6BAA6B,CAAC;AACrD,eAAO,MAAM,kBAAkB,QAAU,CAAC;AAC1C,eAAO,MAAM,qBAAqB,6BAA6B,CAAC;AAChE,eAAO,MAAM,QAAQ,6BAA6B,CAAC;AACnD,eAAO,MAAM,iBAAiB,kBAAkB,CAAC;AACjD,eAAO,MAAM,YAAY,aAAa,CAAC;AACvC,eAAO,MAAM,WAAW,YAAY,CAAC;AACrC,eAAO,MAAM,oBAAoB,aAAa,CAAC;AAM/C,eAAO,MAAM,mBAAmB,QAAuB,CAAC"}

package/src/initialize.ts

@@ -1,198 +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 type { Queue, QueueEntry } from "@serwist/background-sync";
-import { BackgroundSyncPlugin } from "@serwist/background-sync";
-import type { RouteMatchCallbackOptions } from "@serwist/core";
-import { getFriendlyURL, logger, privateCacheNames } from "@serwist/core/internal";
-import { Route, registerRoute } from "@serwist/routing";
-import { NetworkFirst, NetworkOnly } from "@serwist/strategies";
-
-import {
-  ANALYTICS_JS_PATH,
-  COLLECT_PATHS_REGEX,
-  GOOGLE_ANALYTICS_HOST,
-  GTAG_JS_PATH,
-  GTM_HOST,
-  GTM_JS_PATH,
-  MAX_RETENTION_TIME,
-  QUEUE_NAME,
-} from "./utils/constants.js";
-
-export interface GoogleAnalyticsInitializeOptions {
-  /**
-   * The cache name to store and retrieve analytics.js. Defaults to the cache names provided by `@serwist/core`.
-   */
-  cacheName?: string;
-  /**
-   * [Measurement Protocol parameters](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters),
-   * expressed as key/value pairs, to be added to replayed Google Analytics
-   * requests. This can be used to, e.g., set a custom dimension indicating
-   * that the request was replayed.
-   */
-  parameterOverrides?: { [paramName: string]: string };
-  /**
-   * A function that allows you to modify the hit parameters prior to replaying
-   * the hit. The function is invoked with the original hit's URLSearchParams
-   * object as its only argument.
-   */
-  hitFilter?: (params: URLSearchParams) => void;
-}
-
-/**
- * Creates the requestWillDequeue callback to be used with the background
- * sync plugin. The callback takes the failed request and adds the
- * `qt` param based on the current time, as well as applies any other
- * user-defined hit modifications.
- *
- * @param config
- * @returns The requestWillDequeue callback function.
- * @private
- */
-const createOnSyncCallback = (config: GoogleAnalyticsInitializeOptions) => {
-  return async ({ queue }: { queue: Queue }) => {
-    let entry: QueueEntry | undefined = undefined;
-    while ((entry = await queue.shiftRequest())) {
-      const { request, timestamp } = entry;
-      const url = new URL(request.url);
-
-      try {
-        // Measurement protocol requests can set their payload parameters in
-        // either the URL query string (for GET requests) or the POST body.
-        const params = request.method === "POST" ? new URLSearchParams(await request.clone().text()) : url.searchParams;
-
-        // Calculate the qt param, accounting for the fact that an existing
-        // qt param may be present and should be updated rather than replaced.
-        const originalHitTime = timestamp! - (Number(params.get("qt")) || 0);
-        const queueTime = Date.now() - originalHitTime;
-
-        // Set the qt param prior to applying hitFilter or parameterOverrides.
-        params.set("qt", String(queueTime));
-
-        // Apply `parameterOverrides`, if set.
-        if (config.parameterOverrides) {
-          for (const param of Object.keys(config.parameterOverrides)) {
-            const value = config.parameterOverrides[param];
-            params.set(param, value);
-          }
-        }
-
-        // Apply `hitFilter`, if set.
-        if (typeof config.hitFilter === "function") {
-          config.hitFilter.call(null, params);
-        }
-
-        // Retry the fetch. Ignore URL search params from the URL as they're
-        // now in the post body.
-        await fetch(
-          new Request(url.origin + url.pathname, {
-            body: params.toString(),
-            method: "POST",
-            mode: "cors",
-            credentials: "omit",
-            headers: { "Content-Type": "text/plain" },
-          }),
-        );
-
-        if (process.env.NODE_ENV !== "production") {
-          logger.log(`Request for '${getFriendlyURL(url.href)}' has been replayed`);
-        }
-      } catch (err) {
-        await queue.unshiftRequest(entry);
-
-        if (process.env.NODE_ENV !== "production") {
-          logger.log(`Request for '${getFriendlyURL(url.href)}' failed to replay, putting it back in the queue.`);
-        }
-        throw err;
-      }
-    }
-    if (process.env.NODE_ENV !== "production") {
-      logger.log("All Google Analytics request successfully replayed; " + "the queue is now empty!");
-    }
-  };
-};
-
-/**
- * Creates GET and POST routes to catch failed Measurement Protocol hits.
- *
- * @param bgSyncPlugin
- * @returns The created routes.
- * @private
- */
-const createCollectRoutes = (bgSyncPlugin: BackgroundSyncPlugin) => {
-  const match = ({ url }: RouteMatchCallbackOptions) => url.hostname === GOOGLE_ANALYTICS_HOST && COLLECT_PATHS_REGEX.test(url.pathname);
-
-  const handler = new NetworkOnly({
-    plugins: [bgSyncPlugin],
-  });
-
-  return [new Route(match, handler, "GET"), new Route(match, handler, "POST")];
-};
-
-/**
- * Creates a route with a network first strategy for the analytics.js script.
- *
- * @param cacheName
- * @returns The created route.
- * @private
- */
-const createAnalyticsJsRoute = (cacheName: string) => {
-  const match = ({ url }: RouteMatchCallbackOptions) => url.hostname === GOOGLE_ANALYTICS_HOST && url.pathname === ANALYTICS_JS_PATH;
-
-  const handler = new NetworkFirst({ cacheName });
-
-  return new Route(match, handler, "GET");
-};
-
-/**
- * Creates a route with a network first strategy for the gtag.js script.
- *
- * @param cacheName
- * @returns The created route.
- * @private
- */
-const createGtagJsRoute = (cacheName: string) => {
-  const match = ({ url }: RouteMatchCallbackOptions) => url.hostname === GTM_HOST && url.pathname === GTAG_JS_PATH;
-
-  const handler = new NetworkFirst({ cacheName });
-
-  return new Route(match, handler, "GET");
-};
-
-/**
- * Creates a route with a network first strategy for the gtm.js script.
- *
- * @param cacheName
- * @returns The created route.
- * @private
- */
-const createGtmJsRoute = (cacheName: string) => {
-  const match = ({ url }: RouteMatchCallbackOptions) => url.hostname === GTM_HOST && url.pathname === GTM_JS_PATH;
-
-  const handler = new NetworkFirst({ cacheName });
-
-  return new Route(match, handler, "GET");
-};
-
-/**
- * @param options
- */
-export const initialize = (options: GoogleAnalyticsInitializeOptions = {}): void => {
-  const cacheName = privateCacheNames.getGoogleAnalyticsName(options.cacheName);
-
-  const bgSyncPlugin = new BackgroundSyncPlugin(QUEUE_NAME, {
-    maxRetentionTime: MAX_RETENTION_TIME,
-    onSync: createOnSyncCallback(options),
-  });
-
-  const routes = [createGtmJsRoute(cacheName), createAnalyticsJsRoute(cacheName), createGtagJsRoute(cacheName), ...createCollectRoutes(bgSyncPlugin)];
-
-  for (const route of routes) {
-    registerRoute(route);
-  }
-};

package/src/utils/constants.ts

@@ -1,22 +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.
-*/
-
-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/;