@technoapple/ga4 1.0.4 → 1.1.0

package/src/types/plugins.ts

@@ -0,0 +1,98 @@
+export type SendFunction = (eventName: string, params: Record<string, unknown>) => void;
+
+export interface GA4Plugin {
+    remove(): void;
+}
+
+// --- Event Tracker ---
+
+export interface EventTrackerOptions {
+    events?: string[];
+    attributePrefix?: string;
+    hitFilter?: (params: Record<string, unknown>, element: Element, event: Event) => Record<string, unknown> | null;
+}
+
+// --- Outbound Link Tracker ---
+
+export interface OutboundLinkTrackerOptions {
+    events?: string[];
+    linkSelector?: string;
+    shouldTrackOutboundLink?: (link: Element, parseUrl: (url: string) => { hostname: string; protocol: string; href: string }) => boolean;
+    eventName?: string;
+    attributePrefix?: string;
+    hitFilter?: (params: Record<string, unknown>, element: Element, event: Event) => Record<string, unknown> | null;
+}
+
+// --- Outbound Form Tracker ---
+
+export interface OutboundFormTrackerOptions {
+    formSelector?: string;
+    shouldTrackOutboundForm?: (form: HTMLFormElement, parseUrl: (url: string) => { hostname: string; protocol: string; href: string }) => boolean;
+    eventName?: string;
+    hitFilter?: (params: Record<string, unknown>, element: Element, event: Event) => Record<string, unknown> | null;
+}
+
+// --- Page Visibility Tracker ---
+
+export interface PageVisibilityTrackerOptions {
+    sendInitialPageview?: boolean;
+    sessionTimeout?: number;
+    timeZone?: string;
+    eventName?: string;
+    hitFilter?: (params: Record<string, unknown>) => Record<string, unknown> | null;
+}
+
+// --- URL Change Tracker ---
+
+export interface UrlChangeTrackerOptions {
+    shouldTrackUrlChange?: (newPath: string, oldPath: string) => boolean;
+    trackReplaceState?: boolean;
+    hitFilter?: (params: Record<string, unknown>) => Record<string, unknown> | null;
+}
+
+// --- Impression Tracker ---
+
+export interface ImpressionElementConfig {
+    id: string;
+    threshold?: number;
+    trackFirstImpressionOnly?: boolean;
+}
+
+export interface ImpressionTrackerOptions {
+    elements?: Array<string | ImpressionElementConfig>;
+    rootMargin?: string;
+    attributePrefix?: string;
+    eventName?: string;
+    hitFilter?: (params: Record<string, unknown>, element: Element) => Record<string, unknown> | null;
+}
+
+// --- Clean URL Tracker ---
+
+export interface CleanUrlTrackerOptions {
+    stripQuery?: boolean;
+    queryParamsAllowlist?: string[];
+    queryParamsDenylist?: string[];
+    trailingSlash?: 'add' | 'remove';
+    urlFilter?: (url: string) => string;
+}
+
+// --- Media Query Tracker ---
+
+export interface MediaQueryDefinitionItem {
+    name: string;
+    media: string;
+}
+
+export interface MediaQueryDefinition {
+    name: string;
+    dimensionIndex?: number;
+    items: MediaQueryDefinitionItem[];
+}
+
+export interface MediaQueryTrackerOptions {
+    definitions?: MediaQueryDefinition[];
+    changeTemplate?: (oldValue: string, newValue: string) => string;
+    changeTimeout?: number;
+    eventName?: string;
+    hitFilter?: (params: Record<string, unknown>) => Record<string, unknown> | null;
+}

package/src/util.ts

@@ -1,18 +1,18 @@
-function findLast<T>(
-    list: Array<T>
-    , predicate: (value: T, index: number, obj: T[]) => unknown)
-    : T | undefined {
-
-    for (let index = list.length - 1; index >= 0; index--) {
-        let currentValue = list[index];
-        let predicateResult = predicate(currentValue, index, list);
-        if (predicateResult) {
-          return currentValue;
-        }
-    }        
-
-    return undefined;
-}
-
-export {findLast};
-
+function findLast<T>(
+    list: Array<T>
+    , predicate: (value: T, index: number, obj: T[]) => unknown)
+    : T | undefined {
+
+    for (let index = list.length - 1; index >= 0; index--) {
+        let currentValue = list[index];
+        let predicateResult = predicate(currentValue, index, list);
+        if (predicateResult) {
+          return currentValue;
+        }
+    }        
+
+    return undefined;
+}
+
+export {findLast};
+

package/test/dataLayer.spec.ts

@@ -1,56 +1,56 @@
-import {} from '../src/types/global';
-import {dataLayerHelper} from '../src/index';
-import {findLast} from '../src/util';
-
-describe('test dataLayer get function', () => {
-    beforeEach(() => {
-        window.dataLayer = [];
-    });
-
-    test('by default dataLayer get should return the 1st item', () => {
-
-        window.dataLayer = window.dataLayer || [];
-
-        window.dataLayer.push({
-            'test': 1
-        });
-        window.dataLayer.push({
-            'test': 11
-        });
-
-        const result = dataLayerHelper.get('test');
-        expect(result).toBe(1);
-
-    });
-
-    test('If dataLayer array has object use the key should get the value', () => {
-
-        const data = [
-            {event: 'test'},
-            ['js'],
-            ['config', 'g-123'],
-            ['event', 'conversion', {'allow': true}]
-        ];        
-        window.dataLayer = data;
-
-        const result = dataLayerHelper.get('allow');
-        expect(result).toBe(true);
-
-    });
-
-    test('if get last is true should return the last item', () => {
-
-        window.dataLayer = window.dataLayer || [];
-
-        window.dataLayer.push({
-            'test': 1
-        });
-        window.dataLayer.push({
-            'test': 11
-        });
-
-        const result = dataLayerHelper.get('test', true);
-        expect(result).toBe(11);
-
-    });
+import {} from '../src/types/global';
+import {dataLayerHelper} from '../src/index';
+import {findLast} from '../src/util';
+
+describe('test dataLayer get function', () => {
+    beforeEach(() => {
+        window.dataLayer = [];
+    });
+
+    test('by default dataLayer get should return the 1st item', () => {
+
+        window.dataLayer = window.dataLayer || [];
+
+        window.dataLayer.push({
+            'test': 1
+        });
+        window.dataLayer.push({
+            'test': 11
+        });
+
+        const result = dataLayerHelper.get('test');
+        expect(result).toBe(1);
+
+    });
+
+    test('If dataLayer array has object use the key should get the value', () => {
+
+        const data = [
+            {event: 'test'},
+            ['js'],
+            ['config', 'g-123'],
+            ['event', 'conversion', {'allow': true}]
+        ];        
+        window.dataLayer = data;
+
+        const result = dataLayerHelper.get('allow');
+        expect(result).toBe(true);
+
+    });
+
+    test('if get last is true should return the last item', () => {
+
+        window.dataLayer = window.dataLayer || [];
+
+        window.dataLayer.push({
+            'test': 1
+        });
+        window.dataLayer.push({
+            'test': 11
+        });
+
+        const result = dataLayerHelper.get('test', true);
+        expect(result).toBe(11);
+
+    });
 });

package/test/ga4.spec.ts

@@ -1,37 +1,37 @@
-import {} from '../src/types/global';
-import { ga4 } from '../src/index';
-import { ga4Option } from '../src/ga4/ga4option';
-
-describe('test ga4', () => {
-    test('init ga4 should call gtag', () => {
-
-        window.gtag = jest.fn();
-
-        ga4.init({
-            targetId: 'g-123'
-        } as ga4Option);
-
-        ga4.send('test', {
-            'test': 1
-        });                
-
-        expect(window.gtag).toBeCalledTimes(3);
-
-    });
-
-    test('init ga4 able to use gtag at ga4', () => {
-
-        window.gtag = jest.fn();
-
-        ga4.init({
-            targetId: 'g-123'
-        } as ga4Option);
-
-        ga4.gtag('event', 'test', {
-            'test': 1
-        });                
-
-        expect(window.gtag).toBeCalledTimes(3);
-
-    });
+import {} from '../src/types/global';
+import { ga4 } from '../src/index';
+import { ga4Option } from '../src/ga4/ga4option';
+
+describe('test ga4', () => {
+    test('init ga4 should call gtag', () => {
+
+        window.gtag = jest.fn();
+
+        ga4.init({
+            targetId: 'g-123'
+        } as ga4Option);
+
+        ga4.send('test', {
+            'test': 1
+        });                
+
+        expect(window.gtag).toBeCalledTimes(3);
+
+    });
+
+    test('init ga4 able to use gtag at ga4', () => {
+
+        window.gtag = jest.fn();
+
+        ga4.init({
+            targetId: 'g-123'
+        } as ga4Option);
+
+        ga4.gtag('event', 'test', {
+            'test': 1
+        });                
+
+        expect(window.gtag).toBeCalledTimes(3);
+
+    });
 });

package/tsconfig.json

@@ -1,29 +1,29 @@
-{
-    "compilerOptions": {
-      "incremental": true,
-      "target": "ES2022",
-      "outDir": "build/main",
-      "rootDir": "src",
-      "moduleResolution": "node",
-      "module": "commonjs",
-      "declaration": true,
-      "inlineSourceMap": true,
-      "esModuleInterop": true,
-      "resolveJsonModule": true,
-      "strict": true,
-      "noUnusedLocals": true,
-      "noUnusedParameters": true,
-      "noImplicitReturns": true,
-      "noFallthroughCasesInSwitch": true,
-      "traceResolution": false,
-      "listEmittedFiles": false,
-      "listFiles": false,
-      "pretty": true,  
-      "lib": ["es2017", "dom"],
-      "types": ["node"],
-      "typeRoots": ["node_modules/@types", "src/types"]
-    },
-    "include": ["src/**/*.ts"],
-    "exclude": ["node_modules/**"],
-    "compileOnSave": false
+{
+    "compilerOptions": {
+      "incremental": true,
+      "target": "ES2022",
+      "outDir": "build/main",
+      "rootDir": "src",
+      "moduleResolution": "node",
+      "module": "commonjs",
+      "declaration": true,
+      "inlineSourceMap": true,
+      "esModuleInterop": true,
+      "resolveJsonModule": true,
+      "strict": true,
+      "noUnusedLocals": true,
+      "noUnusedParameters": true,
+      "noImplicitReturns": true,
+      "noFallthroughCasesInSwitch": true,
+      "traceResolution": false,
+      "listEmittedFiles": false,
+      "listFiles": false,
+      "pretty": true,  
+      "lib": ["es2017", "dom"],
+      "types": ["node"],
+      "typeRoots": ["node_modules/@types", "src/types"]
+    },
+    "include": ["src/**/*.ts"],
+    "exclude": ["node_modules/**"],
+    "compileOnSave": false
   }

package/tsconfig.module.json

@@ -1,12 +1,12 @@
-{
-    "extends": "./tsconfig",
-    "compilerOptions": {
-      "target": "esnext",
-      "outDir": "build/module",
-      "module": "esnext"
-    },
-    "exclude": [
-      "node_modules/**",
-      "src/cli/**/*.ts"
-    ]
+{
+    "extends": "./tsconfig",
+    "compilerOptions": {
+      "target": "esnext",
+      "outDir": "build/module",
+      "module": "esnext"
+    },
+    "exclude": [
+      "node_modules/**",
+      "src/cli/**/*.ts"
+    ]
   }