@caperjs/plugin-google-analytics 0.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) Relish Interactive
+Copyright (c) 2026 Anthony Sapp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/GoogleAnalyticsPlugin.d.ts

@@ -0,0 +1,27 @@
+import { IApplication, IPlugin, Plugin } from '@caperjs/core';
+type ConfigParams = Gtag.ConfigParams & Gtag.ControlParams & Gtag.EventParams & Gtag.ConfigParams & Gtag.CustomParams;
+export type GoogleAnalyticsPluginOptions = ConfigParams & {
+    trackingId?: string | string[];
+    dataLayerName?: string;
+    debug?: boolean;
+};
+export type GAEvents = Record<string, unknown>;
+export interface IGoogleAnalyticsPlugin<E extends GAEvents = GAEvents> extends IPlugin<GoogleAnalyticsPluginOptions> {
+    initialize(options: Partial<GoogleAnalyticsPluginOptions>, app: IApplication): void;
+    gtag(...args: any[]): void;
+    trackEvent<K extends keyof E>(eventName: K, eventData?: E[K]): void;
+}
+export declare class GoogleAnalyticsPlugin<E extends GAEvents = GAEvents> extends Plugin<GoogleAnalyticsPluginOptions> implements IGoogleAnalyticsPlugin<E> {
+    private _options;
+    private _dataLayer;
+    private _queue;
+    initialize(options: Partial<GoogleAnalyticsPluginOptions>, _app: IApplication): Promise<void>;
+    private hello;
+    private initDataLayer;
+    private drainQueue;
+    private install;
+    gtag(...args: any[]): void;
+    trackEvent<K extends keyof E>(eventName: K, eventData?: E[K]): void;
+}
+export {};
+//# sourceMappingURL=GoogleAnalyticsPlugin.d.ts.map

package/lib/GoogleAnalyticsPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GoogleAnalyticsPlugin.d.ts","sourceRoot":"","sources":["../src/GoogleAnalyticsPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC3D,OAAO,EAA2B,MAAM,EAAE,MAAM,eAAe,CAAC;AAGhE,KAAK,YAAY,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;AAEtH,MAAM,MAAM,4BAA4B,GAAG,YAAY,GAAG;IACxD,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE/C,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,QAAQ,GAAG,QAAQ,CAAE,SAAQ,OAAO,CAAC,4BAA4B,CAAC;IAClH,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,4BAA4B,CAAC,EAAE,GAAG,EAAE,YAAY,GAAG,IAAI,CAAC;IACpF,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC3B,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;CACrE;AAED,qBAAa,qBAAqB,CAAC,CAAC,SAAS,QAAQ,GAAG,QAAQ,CAC9D,SAAQ,MAAM,CAAC,4BAA4B,CAC3C,YAAW,sBAAsB,CAAC,CAAC,CAAC;IAEpC,OAAO,CAAC,QAAQ,CAA+B;IAC/C,OAAO,CAAC,UAAU,CAAgC;IAClD,OAAO,CAAC,MAAM,CAAa;IAErB,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,4BAA4B,CAAC,EAAE,IAAI,EAAE,YAAY;IAiBnF,OAAO,CAAC,KAAK;IASb,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,UAAU;IAOlB,OAAO,CAAC,OAAO;IA+BR,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE;IAanB,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CAGpE"}

package/lib/caper-plugin-google-analytics.mjs

@@ -0,0 +1,54 @@
+import { Logger as e, Plugin as t, isDev as n, omitKeys as r } from "@caperjs/core";
+//#region src/version.ts
+var i = "0.1.0", a = class extends t {
+	constructor(...e) {
+		super(...e), this._queue = [];
+	}
+	async initialize(t, r) {
+		if (this._options = {
+			debug: n,
+			trackingId: r.env.VITE_GOOGLE_ANALYTICS_TRACKING_ID || r.env.GOOGLE_ANALYTICS_TRACKING_ID,
+			...t
+		}, this.hello(), this.install(), !this._options.trackingId) {
+			e.warn("[Caper Google Analytics Plugin] Google Analytics tracking ID is not set, please set `VITE_GOOGLE_ANALYTICS_TRACKING_ID` or `GOOGLE_ANALYTICS_TRACKING_ID` environment variable.");
+			return;
+		}
+	}
+	hello() {
+		let t = `%c Caper Google Analytics Plugin v${i}`;
+		console.log(t, "background: rgba(31, 41, 55, 1);color: #74b64c"), this._options.debug && e.log(this._options);
+	}
+	initDataLayer() {
+		let e = window, t = this._options.dataLayerName || "dataLayer";
+		e[t] = e[t] || [], this._dataLayer = e[t], this.drainQueue();
+	}
+	drainQueue() {
+		for (; this._queue.length > 0;) {
+			let e = this._queue.shift();
+			this._dataLayer.push(e);
+		}
+	}
+	install() {
+		if (!this._options.trackingId) return;
+		let e = "ga-gtag";
+		if (document.getElementById(e)) return;
+		let { head: t } = document, n = document.createElement("script"), i = `https://www.googletagmanager.com/gtag/js?id=${this._options.trackingId}`;
+		this._options.dataLayerName && (i += `&l=${this._options.dataLayerName}`), n.id = e, n.async = !0, n.src = i, t.insertBefore(n, t.firstChild), this.initDataLayer(), this.gtag("js", /* @__PURE__ */ new Date()), Array.isArray(this._options.trackingId) || (this._options.trackingId = [this._options.trackingId]), this._options.trackingId.forEach((e) => {
+			this.gtag("config", e, r(["trackingId"], this._options));
+		});
+	}
+	gtag(...t) {
+		if (n && e.log(`gtag(${JSON.stringify(t)})`), !this._dataLayer) {
+			this._queue.push(t);
+			return;
+		}
+		this._dataLayer.push(t);
+	}
+	trackEvent(e, t) {
+		this.gtag("event", e, t || {});
+	}
+};
+//#endregion
+export { a as default };
+
+//# sourceMappingURL=caper-plugin-google-analytics.mjs.map

package/lib/caper-plugin-google-analytics.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"caper-plugin-google-analytics.mjs","names":[],"sources":["../src/version.ts","../src/GoogleAnalyticsPlugin.ts","../src/index.ts"],"sourcesContent":["export const version = '0.1.0';","import type { IApplication, IPlugin } from '@caperjs/core';\nimport { isDev, Logger, omitKeys, Plugin } from '@caperjs/core';\nimport { version } from './version';\n\ntype ConfigParams = Gtag.ConfigParams & Gtag.ControlParams & Gtag.EventParams & Gtag.ConfigParams & Gtag.CustomParams;\n\nexport type GoogleAnalyticsPluginOptions = ConfigParams & {\n  trackingId?: string | string[];\n  dataLayerName?: string;\n  debug?: boolean;\n};\n\nexport type GAEvents = Record<string, unknown>;\n\nexport interface IGoogleAnalyticsPlugin<E extends GAEvents = GAEvents> extends IPlugin<GoogleAnalyticsPluginOptions> {\n  initialize(options: Partial<GoogleAnalyticsPluginOptions>, app: IApplication): void;\n  gtag(...args: any[]): void;\n  trackEvent<K extends keyof E>(eventName: K, eventData?: E[K]): void;\n}\n\nexport class GoogleAnalyticsPlugin<E extends GAEvents = GAEvents>\n  extends Plugin<GoogleAnalyticsPluginOptions>\n  implements IGoogleAnalyticsPlugin<E>\n{\n  private _options: GoogleAnalyticsPluginOptions;\n  private _dataLayer: { push: (args: any) => void };\n  private _queue: any[] = [];\n\n  async initialize(options: Partial<GoogleAnalyticsPluginOptions>, _app: IApplication) {\n    this._options = {\n      debug: isDev,\n      trackingId: _app.env.VITE_GOOGLE_ANALYTICS_TRACKING_ID || _app.env.GOOGLE_ANALYTICS_TRACKING_ID,\n      ...options,\n    };\n    this.hello();\n    this.install();\n\n    if (!this._options.trackingId) {\n      Logger.warn(\n        '[Caper Google Analytics Plugin] Google Analytics tracking ID is not set, please set `VITE_GOOGLE_ANALYTICS_TRACKING_ID` or `GOOGLE_ANALYTICS_TRACKING_ID` environment variable.',\n      );\n      return;\n    }\n  }\n\n  private hello() {\n    const hello = `%c Caper Google Analytics Plugin v${version}`;\n    console.log(hello, 'background: rgba(31, 41, 55, 1);color: #74b64c');\n\n    if (this._options.debug) {\n      Logger.log(this._options);\n    }\n  }\n\n  private initDataLayer() {\n    const windowAsAny = window as any;\n    const dlName = this._options.dataLayerName || 'dataLayer';\n    windowAsAny[dlName] = windowAsAny[dlName] || [];\n    this._dataLayer = windowAsAny[dlName];\n\n    this.drainQueue();\n  }\n\n  private drainQueue() {\n    while (this._queue.length > 0) {\n      const args = this._queue.shift();\n      this._dataLayer.push(args);\n    }\n  }\n\n  private install() {\n    if (!this._options.trackingId) {\n      return;\n    }\n\n    const scriptId = 'ga-gtag';\n\n    if (document.getElementById(scriptId)) return;\n\n    const { head } = document;\n    const script = document.createElement('script');\n    let src = `https://www.googletagmanager.com/gtag/js?id=${this._options.trackingId}`;\n    if (this._options.dataLayerName) src += `&l=${this._options.dataLayerName}`;\n    script.id = scriptId;\n    script.async = true;\n    script.src = src;\n    head.insertBefore(script, head.firstChild);\n\n    this.initDataLayer();\n\n    this.gtag('js', new Date());\n\n    if (!Array.isArray(this._options.trackingId)) {\n      this._options.trackingId = [this._options.trackingId];\n    }\n\n    this._options.trackingId.forEach((trackingId) => {\n      this.gtag('config', trackingId, omitKeys(['trackingId'], this._options));\n    });\n  }\n\n  public gtag(...args: any[]) {\n    if (isDev) {\n      Logger.log(`gtag(${JSON.stringify(args)})`);\n    }\n\n    if (!this._dataLayer) {\n      this._queue.push(args);\n      return;\n    }\n\n    this._dataLayer.push(args);\n  }\n\n  public trackEvent<K extends keyof E>(eventName: K, eventData?: E[K]) {\n    this.gtag('event', eventName as string, eventData || {});\n  }\n}\n","import { GoogleAnalyticsPlugin } from './GoogleAnalyticsPlugin';\nexport type { GAEvents, GoogleAnalyticsPluginOptions, IGoogleAnalyticsPlugin } from './GoogleAnalyticsPlugin';\n\nexport default GoogleAnalyticsPlugin;\n"],"mappings":";;AAAA,IAAa,IAAU,SEGvB,IDiBA,cACU,EAEV;;6BAG0B,EAAE;;CAE1B,MAAM,WAAW,GAAgD,GAAoB;AASnF,MARA,KAAK,WAAW;GACd,OAAO;GACP,YAAY,EAAK,IAAI,qCAAqC,EAAK,IAAI;GACnE,GAAG;GACJ,EACD,KAAK,OAAO,EACZ,KAAK,SAAS,EAEV,CAAC,KAAK,SAAS,YAAY;AAC7B,KAAO,KACL,kLACD;AACD;;;CAIJ,QAAgB;EACd,IAAM,IAAQ,qCAAqC;AAGnD,EAFA,QAAQ,IAAI,GAAO,iDAAiD,EAEhE,KAAK,SAAS,SAChB,EAAO,IAAI,KAAK,SAAS;;CAI7B,gBAAwB;EACtB,IAAM,IAAc,QACd,IAAS,KAAK,SAAS,iBAAiB;AAI9C,EAHA,EAAY,KAAU,EAAY,MAAW,EAAE,EAC/C,KAAK,aAAa,EAAY,IAE9B,KAAK,YAAY;;CAGnB,aAAqB;AACnB,SAAO,KAAK,OAAO,SAAS,IAAG;GAC7B,IAAM,IAAO,KAAK,OAAO,OAAO;AAChC,QAAK,WAAW,KAAK,EAAK;;;CAI9B,UAAkB;AAChB,MAAI,CAAC,KAAK,SAAS,WACjB;EAGF,IAAM,IAAW;AAEjB,MAAI,SAAS,eAAe,EAAS,CAAE;EAEvC,IAAM,EAAE,YAAS,UACX,IAAS,SAAS,cAAc,SAAS,EAC3C,IAAM,+CAA+C,KAAK,SAAS;AAevE,EAdI,KAAK,SAAS,kBAAe,KAAO,MAAM,KAAK,SAAS,kBAC5D,EAAO,KAAK,GACZ,EAAO,QAAQ,IACf,EAAO,MAAM,GACb,EAAK,aAAa,GAAQ,EAAK,WAAW,EAE1C,KAAK,eAAe,EAEpB,KAAK,KAAK,sBAAM,IAAI,MAAM,CAAC,EAEtB,MAAM,QAAQ,KAAK,SAAS,WAAW,KAC1C,KAAK,SAAS,aAAa,CAAC,KAAK,SAAS,WAAW,GAGvD,KAAK,SAAS,WAAW,SAAS,MAAe;AAC/C,QAAK,KAAK,UAAU,GAAY,EAAS,CAAC,aAAa,EAAE,KAAK,SAAS,CAAC;IACxE;;CAGJ,KAAY,GAAG,GAAa;AAK1B,MAJI,KACF,EAAO,IAAI,QAAQ,KAAK,UAAU,EAAK,CAAC,GAAG,EAGzC,CAAC,KAAK,YAAY;AACpB,QAAK,OAAO,KAAK,EAAK;AACtB;;AAGF,OAAK,WAAW,KAAK,EAAK;;CAG5B,WAAqC,GAAc,GAAkB;AACnE,OAAK,KAAK,SAAS,GAAqB,KAAa,EAAE,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+import { GoogleAnalyticsPlugin } from './GoogleAnalyticsPlugin';
+export type { GAEvents, GoogleAnalyticsPluginOptions, IGoogleAnalyticsPlugin } from './GoogleAnalyticsPlugin';
+export default GoogleAnalyticsPlugin;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,YAAY,EAAE,QAAQ,EAAE,4BAA4B,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAE9G,eAAe,qBAAqB,CAAC"}

package/lib/version.d.ts

@@ -0,0 +1,2 @@
+export declare const version = "0.1.0";
+//# sourceMappingURL=version.d.ts.map

package/lib/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@caperjs/plugin-google-analytics",
+  "version": "0.1.0",
+  "description": "Google Analytics",
+  "files": [
+    "lib",
+    "src"
+  ],
+  "main": "lib/caper-plugin-google-analytics.mjs",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "default": "./lib/caper-plugin-google-analytics.mjs",
+      "types": "./lib/index.d.ts"
+    }
+  },
+  "sideEffects": false,
+  "keywords": [
+    "google",
+    "analytics",
+    "google-analytics",
+    "@caperjs/core",
+    "caper"
+  ],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "vite": "^8.0.7",
+    "vite-plugin-dts": "^4.5.3",
+    "@caperjs/core": "0.1.0"
+  },
+  "peerDependencies": {
+    "@caperjs/core": "0.1.0"
+  },
+  "dependencies": {
+    "@types/gtag.js": "^0.0.20"
+  },
+  "scripts": {
+    "build": "pnpm run version && vite build",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "version": "node generateVersion.mjs"
+  }
+}

package/src/GoogleAnalyticsPlugin.ts

@@ -0,0 +1,118 @@
+import type { IApplication, IPlugin } from '@caperjs/core';
+import { isDev, Logger, omitKeys, Plugin } from '@caperjs/core';
+import { version } from './version';
+
+type ConfigParams = Gtag.ConfigParams & Gtag.ControlParams & Gtag.EventParams & Gtag.ConfigParams & Gtag.CustomParams;
+
+export type GoogleAnalyticsPluginOptions = ConfigParams & {
+  trackingId?: string | string[];
+  dataLayerName?: string;
+  debug?: boolean;
+};
+
+export type GAEvents = Record<string, unknown>;
+
+export interface IGoogleAnalyticsPlugin<E extends GAEvents = GAEvents> extends IPlugin<GoogleAnalyticsPluginOptions> {
+  initialize(options: Partial<GoogleAnalyticsPluginOptions>, app: IApplication): void;
+  gtag(...args: any[]): void;
+  trackEvent<K extends keyof E>(eventName: K, eventData?: E[K]): void;
+}
+
+export class GoogleAnalyticsPlugin<E extends GAEvents = GAEvents>
+  extends Plugin<GoogleAnalyticsPluginOptions>
+  implements IGoogleAnalyticsPlugin<E>
+{
+  private _options: GoogleAnalyticsPluginOptions;
+  private _dataLayer: { push: (args: any) => void };
+  private _queue: any[] = [];
+
+  async initialize(options: Partial<GoogleAnalyticsPluginOptions>, _app: IApplication) {
+    this._options = {
+      debug: isDev,
+      trackingId: _app.env.VITE_GOOGLE_ANALYTICS_TRACKING_ID || _app.env.GOOGLE_ANALYTICS_TRACKING_ID,
+      ...options,
+    };
+    this.hello();
+    this.install();
+
+    if (!this._options.trackingId) {
+      Logger.warn(
+        '[Caper Google Analytics Plugin] Google Analytics tracking ID is not set, please set `VITE_GOOGLE_ANALYTICS_TRACKING_ID` or `GOOGLE_ANALYTICS_TRACKING_ID` environment variable.',
+      );
+      return;
+    }
+  }
+
+  private hello() {
+    const hello = `%c Caper Google Analytics Plugin v${version}`;
+    console.log(hello, 'background: rgba(31, 41, 55, 1);color: #74b64c');
+
+    if (this._options.debug) {
+      Logger.log(this._options);
+    }
+  }
+
+  private initDataLayer() {
+    const windowAsAny = window as any;
+    const dlName = this._options.dataLayerName || 'dataLayer';
+    windowAsAny[dlName] = windowAsAny[dlName] || [];
+    this._dataLayer = windowAsAny[dlName];
+
+    this.drainQueue();
+  }
+
+  private drainQueue() {
+    while (this._queue.length > 0) {
+      const args = this._queue.shift();
+      this._dataLayer.push(args);
+    }
+  }
+
+  private install() {
+    if (!this._options.trackingId) {
+      return;
+    }
+
+    const scriptId = 'ga-gtag';
+
+    if (document.getElementById(scriptId)) return;
+
+    const { head } = document;
+    const script = document.createElement('script');
+    let src = `https://www.googletagmanager.com/gtag/js?id=${this._options.trackingId}`;
+    if (this._options.dataLayerName) src += `&l=${this._options.dataLayerName}`;
+    script.id = scriptId;
+    script.async = true;
+    script.src = src;
+    head.insertBefore(script, head.firstChild);
+
+    this.initDataLayer();
+
+    this.gtag('js', new Date());
+
+    if (!Array.isArray(this._options.trackingId)) {
+      this._options.trackingId = [this._options.trackingId];
+    }
+
+    this._options.trackingId.forEach((trackingId) => {
+      this.gtag('config', trackingId, omitKeys(['trackingId'], this._options));
+    });
+  }
+
+  public gtag(...args: any[]) {
+    if (isDev) {
+      Logger.log(`gtag(${JSON.stringify(args)})`);
+    }
+
+    if (!this._dataLayer) {
+      this._queue.push(args);
+      return;
+    }
+
+    this._dataLayer.push(args);
+  }
+
+  public trackEvent<K extends keyof E>(eventName: K, eventData?: E[K]) {
+    this.gtag('event', eventName as string, eventData || {});
+  }
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+import { GoogleAnalyticsPlugin } from './GoogleAnalyticsPlugin';
+export type { GAEvents, GoogleAnalyticsPluginOptions, IGoogleAnalyticsPlugin } from './GoogleAnalyticsPlugin';
+
+export default GoogleAnalyticsPlugin;

package/src/version.ts

@@ -0,0 +1 @@
+export const version = '0.1.0';