matomo-tracker-for-react 1.0.0

package/es/tracker-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=tracker-types.js.map

package/es/tracker-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracker-types.js","sourceRoot":"","sources":["../src/tracker-types.ts"],"names":[],"mappings":""}

package/es/types.d.ts

@@ -0,0 +1,19 @@
+import React from "react";
+export * from "./tracker-types";
+export interface MatomoProviderProps {
+    children: React.ReactNode;
+    urlBase: string;
+    siteId: string | number;
+    trackCookies?: boolean;
+    disabled?: boolean;
+}
+export interface MatomoInstance {
+    trackEvent: (category: string, action: string, name?: string, value?: number) => void;
+    trackPageView: (customTitle?: string) => void;
+    trackGoal: (goalId: number | string, revenue?: number) => void;
+    setUserId: (userId: string) => void;
+    trackLink: (url: string, linkType: "link" | "download") => void;
+    pushInstruction: (instruction: any[]) => void;
+}
+export type UseMatomo = MatomoInstance;
+//# sourceMappingURL=types.d.ts.map

package/es/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,cAAc,iBAAiB,CAAC;AAEhC,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,CACV,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,MAAM,EACb,KAAK,CAAC,EAAE,MAAM,KACX,IAAI,CAAC;IACV,aAAa,EAAE,CAAC,WAAW,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9C,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/D,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,UAAU,KAAK,IAAI,CAAC;IAChE,eAAe,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;CAC/C;AAGD,MAAM,MAAM,SAAS,GAAG,cAAc,CAAC"}

package/es/types.js

@@ -0,0 +1,3 @@
+// Re-export tracker types for convenience if needed by consumers of the React package
+export * from "./tracker-types";
+//# sourceMappingURL=types.js.map

package/es/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,sFAAsF;AACtF,cAAc,iBAAiB,CAAC"}

package/es/useMatomo.d.ts

@@ -0,0 +1,4 @@
+import { UseMatomo } from "./types";
+declare function useMatomo(): UseMatomo;
+export default useMatomo;
+//# sourceMappingURL=useMatomo.d.ts.map

package/es/useMatomo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useMatomo.d.ts","sourceRoot":"","sources":["../src/useMatomo.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC,iBAAS,SAAS,IAAI,SAAS,CAgD9B;AAED,eAAe,SAAS,CAAC"}

package/es/useMatomo.js

@@ -0,0 +1,30 @@
+import { useContext, useCallback } from "react";
+import MatomoContext from "./MatomoContext";
+function useMatomo() {
+    var context = useContext(MatomoContext);
+    if (context === null) {
+        throw new Error("useMatomo must be used within a MatomoProvider");
+    }
+    var trackPageView = useCallback(function (customTitle) { return context.trackPageView(customTitle); }, [context]);
+    var trackEvent = useCallback(function (category, action, name, value) {
+        return context.trackEvent(category, action, name, value);
+    }, [context]);
+    var trackGoal = useCallback(function (goalId, revenue) {
+        return context.trackGoal(goalId, revenue);
+    }, [context]);
+    var setUserId = useCallback(function (userId) { return context.setUserId(userId); }, [context]);
+    var trackLink = useCallback(function (url, linkType) {
+        return context.trackLink(url, linkType);
+    }, [context]);
+    var pushInstruction = useCallback(function (instruction) { return context.pushInstruction(instruction); }, [context]);
+    return {
+        trackEvent: trackEvent,
+        trackPageView: trackPageView,
+        trackGoal: trackGoal,
+        setUserId: setUserId,
+        trackLink: trackLink,
+        pushInstruction: pushInstruction,
+    };
+}
+export default useMatomo;
+//# sourceMappingURL=useMatomo.js.map

package/es/useMatomo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useMatomo.js","sourceRoot":"","sources":["../src/useMatomo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAChD,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAG5C,SAAS,SAAS;IAChB,IAAM,OAAO,GAAG,UAAU,CAAC,aAAa,CAAC,CAAC;IAE1C,IAAI,OAAO,KAAK,IAAI,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;KACnE;IAED,IAAM,aAAa,GAAG,WAAW,CAC/B,UAAC,WAAoB,IAAK,OAAA,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,EAAlC,CAAkC,EAC5D,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,IAAM,UAAU,GAAG,WAAW,CAC5B,UAAC,QAAgB,EAAE,MAAc,EAAE,IAAa,EAAE,KAAc;QAC9D,OAAA,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC;IAAjD,CAAiD,EACnD,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,IAAM,SAAS,GAAG,WAAW,CAC3B,UAAC,MAAuB,EAAE,OAAgB;QACxC,OAAA,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC;IAAlC,CAAkC,EACpC,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,IAAM,SAAS,GAAG,WAAW,CAC3B,UAAC,MAAc,IAAK,OAAA,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,EAAzB,CAAyB,EAC7C,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,IAAM,SAAS,GAAG,WAAW,CAC3B,UAAC,GAAW,EAAE,QAA6B;QACzC,OAAA,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC;IAAhC,CAAgC,EAClC,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,IAAM,eAAe,GAAG,WAAW,CACjC,UAAC,WAAkB,IAAK,OAAA,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,EAApC,CAAoC,EAC5D,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,OAAO;QACL,UAAU,YAAA;QACV,aAAa,eAAA;QACb,SAAS,WAAA;QACT,SAAS,WAAA;QACT,SAAS,WAAA;QACT,eAAe,iBAAA;KAChB,CAAC;AACJ,CAAC;AAED,eAAe,SAAS,CAAC"}

package/lib/MatomoContext.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { MatomoInstance } from './types';
+declare const MatomoContext: import("react").Context<MatomoInstance | null>;
+export default MatomoContext;
+//# sourceMappingURL=MatomoContext.d.ts.map

package/lib/MatomoContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MatomoContext.d.ts","sourceRoot":"","sources":["../src/MatomoContext.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAExC,QAAA,MAAM,aAAa,gDAA6C,CAAA;AAEhE,eAAe,aAAa,CAAA"}

package/lib/MatomoContext.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var react_1 = require("react");
+var MatomoContext = (0, react_1.createContext)(null);
+exports.default = MatomoContext;
+//# sourceMappingURL=MatomoContext.js.map

package/lib/MatomoContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MatomoContext.js","sourceRoot":"","sources":["../src/MatomoContext.tsx"],"names":[],"mappings":";;AAAA,+BAAqC;AAGrC,IAAM,aAAa,GAAG,IAAA,qBAAa,EAAwB,IAAI,CAAC,CAAA;AAEhE,kBAAe,aAAa,CAAA"}

package/lib/MatomoProvider.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+import { MatomoProviderProps } from './types';
+declare const MatomoProvider: React.FC<MatomoProviderProps>;
+export default MatomoProvider;
+//# sourceMappingURL=MatomoProvider.d.ts.map

package/lib/MatomoProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MatomoProvider.d.ts","sourceRoot":"","sources":["../src/MatomoProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAqC,MAAM,OAAO,CAAA;AAIzD,OAAO,EAAE,mBAAmB,EAA+B,MAAM,SAAS,CAAA;AAI1E,QAAA,MAAM,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC,mBAAmB,CAkFjD,CAAA;AAED,eAAe,cAAc,CAAA"}

package/lib/MatomoProvider.js

@@ -0,0 +1,122 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var react_1 = __importStar(require("react"));
+var react_router_dom_1 = require("react-router-dom"); // For automatic page view tracking
+var MatomoContext_1 = __importDefault(require("./MatomoContext"));
+var MatomoTracker_1 = __importDefault(require("./MatomoTracker"));
+var constants_1 = require("./constants");
+var MatomoProvider = function (_a) {
+    var children = _a.children, urlBase = _a.urlBase, siteId = _a.siteId, _b = _a.disabled, disabled = _b === void 0 ? false : _b, _c = _a.trackCookies, trackCookies = _c === void 0 ? true : _c;
+    var matomoInstanceRef = (0, react_1.useRef)(null);
+    var location = (0, react_router_dom_1.useLocation)(); // From react-router-dom
+    // Initialize MatomoTracker instance
+    if (!matomoInstanceRef.current && typeof window !== 'undefined' && !disabled) {
+        var matomoSiteId = typeof siteId === 'string' ? parseInt(siteId, 10) : siteId;
+        if (isNaN(matomoSiteId)) {
+            console.error("Matomo siteId must be a number or a string parseable to a number.");
+        }
+        else {
+            var effectiveConfigurations = {};
+            if (!trackCookies) {
+                effectiveConfigurations.disableCookies = true;
+            }
+            var trackerOptions = {
+                urlBase: urlBase,
+                siteId: matomoSiteId,
+                disabled: disabled,
+                configurations: effectiveConfigurations, // Pass only relevant configurations
+            };
+            matomoInstanceRef.current = new MatomoTracker_1.default(trackerOptions);
+        }
+    }
+    var matomoActions = (0, react_1.useMemo)(function () {
+        var currentInstance = matomoInstanceRef.current; // Use a variable for the dependency array
+        if (!currentInstance || disabled) {
+            var noOp = function () { };
+            var noOpInstance = {
+                trackEvent: noOp,
+                trackPageView: noOp,
+                trackGoal: noOp,
+                setUserId: noOp,
+                trackLink: noOp,
+                pushInstruction: function () {
+                    var _args = [];
+                    for (var _i = 0; _i < arguments.length; _i++) {
+                        _args[_i] = arguments[_i];
+                    }
+                },
+            };
+            return noOpInstance;
+        }
+        return {
+            trackEvent: function (category, action, name, value) {
+                return currentInstance.trackEvent({ category: category, action: action, name: name, value: value });
+            },
+            trackPageView: function (customTitle) {
+                return currentInstance.trackPageView(customTitle ? { documentTitle: customTitle } : undefined);
+            },
+            trackGoal: function (goalId, revenue) {
+                return currentInstance.pushInstruction(constants_1.TRACK_TYPES.TRACK_GOAL, goalId, revenue);
+            },
+            setUserId: function (uid) { return currentInstance.pushInstruction(constants_1.TRACK_TYPES.SET_USER_ID, uid); },
+            trackLink: function (url, linkType) {
+                return currentInstance.trackLink({ href: url, linkType: linkType });
+            },
+            pushInstruction: function (instruction) {
+                if (Array.isArray(instruction) && instruction.length > 0) {
+                    var name_1 = instruction[0], args = instruction.slice(1);
+                    currentInstance.pushInstruction.apply(currentInstance, __spreadArray([name_1], args, false));
+                }
+                else {
+                    console.warn('pushInstruction expects a non-empty array.');
+                }
+            },
+        };
+    }, [disabled, matomoInstanceRef.current]); // Use matomoInstanceRef.current here
+    // Effect for automatic page view tracking on route change
+    (0, react_1.useEffect)(function () {
+        if (matomoActions && matomoActions.trackPageView && !disabled) {
+            var currentPath = location.pathname + location.search + location.hash;
+            matomoActions.pushInstruction(['setCustomUrl', window.location.origin + currentPath]);
+            matomoActions.trackPageView(); // Track with potentially new document.title or default
+        }
+    }, [location, matomoActions, disabled]);
+    return (react_1.default.createElement(MatomoContext_1.default.Provider, { value: matomoActions }, children));
+};
+exports.default = MatomoProvider;
+//# sourceMappingURL=MatomoProvider.js.map

package/lib/MatomoProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MatomoProvider.js","sourceRoot":"","sources":["../src/MatomoProvider.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAAyD;AACzD,qDAA8C,CAAC,mCAAmC;AAClF,kEAA2C;AAC3C,kEAA2C;AAE3C,yCAAyC;AAGzC,IAAM,cAAc,GAAkC,UAAC,EAMtD;QALC,QAAQ,cAAA,EACR,OAAO,aAAA,EACP,MAAM,YAAA,EACN,gBAAgB,EAAhB,QAAQ,mBAAG,KAAK,KAAA,EAChB,oBAAmB,EAAnB,YAAY,mBAAG,IAAI,KAAA;IAEnB,IAAM,iBAAiB,GAAG,IAAA,cAAM,EAAuB,IAAI,CAAC,CAAA;IAC5D,IAAM,QAAQ,GAAG,IAAA,8BAAW,GAAE,CAAA,CAAC,wBAAwB;IAEvD,oCAAoC;IACpC,IAAI,CAAC,iBAAiB,CAAC,OAAO,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,CAAC,QAAQ,EAAE;QAC1E,IAAM,YAAY,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAChF,IAAI,KAAK,CAAC,YAAY,CAAC,EAAE;YACrB,OAAO,CAAC,KAAK,CAAC,mEAAmE,CAAC,CAAC;SACtF;aAAM;YACL,IAAM,uBAAuB,GAA2B,EAAE,CAAC;YAC3D,IAAI,CAAC,YAAY,EAAE;gBACf,uBAAuB,CAAC,cAAc,GAAG,IAAI,CAAC;aACjD;YAED,IAAM,cAAc,GAAgB;gBAChC,OAAO,SAAA;gBACP,MAAM,EAAE,YAAY;gBACpB,QAAQ,UAAA;gBACR,cAAc,EAAE,uBAAuB,EAAE,oCAAoC;aAChF,CAAC;YACF,iBAAiB,CAAC,OAAO,GAAG,IAAI,uBAAa,CAAC,cAAc,CAAC,CAAC;SAC/D;KACJ;IAED,IAAM,aAAa,GAAG,IAAA,eAAO,EAAwB;QACnD,IAAM,eAAe,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC,0CAA0C;QAC7F,IAAI,CAAC,eAAe,IAAI,QAAQ,EAAE;YAChC,IAAM,IAAI,GAAG,cAAO,CAAC,CAAC;YACtB,IAAM,YAAY,GAAmB;gBACnC,UAAU,EAAE,IAAI;gBAChB,aAAa,EAAE,IAAI;gBACnB,SAAS,EAAE,IAAI;gBACf,SAAS,EAAE,IAAI;gBACf,SAAS,EAAE,IAAI;gBACf,eAAe,EAAE;oBAAC,eAAe;yBAAf,UAAe,EAAf,qBAAe,EAAf,IAAe;wBAAf,0BAAe;;gBAAM,CAAC;aACzC,CAAC;YACF,OAAO,YAAY,CAAC;SACrB;QAED,OAAO;YACL,UAAU,EAAE,UAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK;gBACxC,OAAA,eAAe,CAAC,UAAU,CAAC,EAAE,QAAQ,UAAA,EAAE,MAAM,QAAA,EAAE,IAAI,MAAA,EAAE,KAAK,OAAA,EAAE,CAAC;YAA7D,CAA6D;YAC/D,aAAa,EAAE,UAAC,WAAW;gBACzB,OAAA,eAAe,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YAAvF,CAAuF;YACzF,SAAS,EAAE,UAAC,MAAM,EAAE,OAAO;gBACzB,OAAA,eAAe,CAAC,eAAe,CAAC,uBAAW,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC;YAAxE,CAAwE;YAC1E,SAAS,EAAE,UAAC,GAAG,IAAK,OAAA,eAAe,CAAC,eAAe,CAAC,uBAAW,CAAC,WAAW,EAAE,GAAG,CAAC,EAA7D,CAA6D;YACjF,SAAS,EAAE,UAAC,GAAG,EAAE,QAAQ;gBACvB,OAAA,eAAe,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,UAAA,EAAE,CAAC;YAAlD,CAAkD;YACpD,eAAe,EAAE,UAAC,WAAW;gBAC3B,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;oBACjD,IAAA,MAAI,GAAa,WAAW,GAAxB,EAAK,IAAI,GAAI,WAAW,SAAf,CAAgB;oBACpC,eAAe,CAAC,eAAe,OAA/B,eAAe,iBAAiB,MAAI,GAAK,IAAI,UAAE;iBAChD;qBAAM;oBACL,OAAO,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;iBAC5D;YACH,CAAC;SACF,CAAA;IACH,CAAC,EAAE,CAAC,QAAQ,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAA,CAAC,qCAAqC;IAE/E,0DAA0D;IAC1D,IAAA,iBAAS,EAAC;QACR,IAAI,aAAa,IAAI,aAAa,CAAC,aAAa,IAAI,CAAC,QAAQ,EAAE;YAC7D,IAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAA;YACvE,aAAa,CAAC,eAAe,CAAC,CAAC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,WAAW,CAAC,CAAC,CAAA;YACrF,aAAa,CAAC,aAAa,EAAE,CAAA,CAAC,uDAAuD;SACtF;IACH,CAAC,EAAE,CAAC,QAAQ,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAA;IAGvC,OAAO,CACL,8BAAC,uBAAa,CAAC,QAAQ,IAAC,KAAK,EAAE,aAAa,IACzC,QAAQ,CACc,CAC1B,CAAA;AACH,CAAC,CAAA;AAED,kBAAe,cAAc,CAAA"}

package/lib/MatomoTracker.d.ts

@@ -0,0 +1,49 @@
+import { AddEcommerceItemParams, RemoveEcommerceItemParams, SetEcommerceViewParams, TrackEcommerceOrderParams, TrackEventParams, TrackLinkParams, TrackPageViewParams, TrackSiteSearchParams, UserOptions } from "./tracker-types";
+declare global {
+    interface Window {
+        _paq?: Array<any[]>;
+    }
+}
+declare class MatomoTracker {
+    private mutationObserver?;
+    private isInitialized;
+    constructor(userOptions: UserOptions);
+    private initialize;
+    enableHeartBeatTimer(seconds: number): void;
+    enableLinkTracking(active: boolean): void;
+    private trackEventsForElements;
+    trackEvents(): void;
+    stopObserving(): void;
+    trackEvent({ category, action, name, value, ...otherParams }: TrackEventParams): void;
+    trackSiteSearch({ keyword, category, count, ...otherParams }: TrackSiteSearchParams): void;
+    trackLink({ href, linkType, customDimensions, }: TrackLinkParams): void;
+    trackPageView(params?: TrackPageViewParams): void;
+    addEcommerceItem({ sku, productName, productCategory, productPrice, productQuantity, }: AddEcommerceItemParams): void;
+    removeEcommerceItem({ sku }: RemoveEcommerceItemParams): void;
+    clearEcommerceCart(): void;
+    trackEcommerceOrder({ orderId, orderRevenue, orderSubTotal, taxAmount, shippingAmount, discountOffered, }: TrackEcommerceOrderParams): void;
+    trackEcommerceCartUpdate(amount: number): void;
+    setEcommerceView({ sku, productName, productCategory, productPrice, }: SetEcommerceViewParams): void;
+    setEcommerceCategoryView(productCategory: string): void;
+    private track;
+    /**
+     * Pushes an instruction to Matomo for execution, this is equivalent to pushing entries into the `_paq` array.
+     *
+     * For example:
+     *
+     * ```ts
+     * pushInstruction('setDocumentTitle', document.title)
+     * ```
+     * Is the equivalent of:
+     *
+     * ```ts
+     * _paq.push(['setDocumentTitle', document.title]);
+     * ```
+     *
+     * @param name The name of the instruction to be executed.
+     * @param args The arguments to pass along with the instruction.
+     */
+    pushInstruction(name: string, ...args: any[]): MatomoTracker;
+}
+export default MatomoTracker;
+//# sourceMappingURL=MatomoTracker.d.ts.map

package/lib/MatomoTracker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MatomoTracker.d.ts","sourceRoot":"","sources":["../src/MatomoTracker.ts"],"names":[],"mappings":"AACA,OAAO,EACL,sBAAsB,EACtB,yBAAyB,EAEzB,sBAAsB,EACtB,yBAAyB,EACzB,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EAEnB,qBAAqB,EACrB,WAAW,EACZ,MAAM,iBAAiB,CAAC;AAEzB,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,IAAI,CAAC,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC;KACrB;CACF;AAED,cAAM,aAAa;IACjB,OAAO,CAAC,gBAAgB,CAAC,CAAmB;IAC5C,OAAO,CAAC,aAAa,CAAS;gBAElB,WAAW,EAAE,WAAW;IAepC,OAAO,CAAC,UAAU;IAmFlB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI3C,kBAAkB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IAIzC,OAAO,CAAC,sBAAsB;IAwB9B,WAAW,IAAI,IAAI;IAqCnB,aAAa,IAAI,IAAI;IAQrB,UAAU,CAAC,EACT,QAAQ,EACR,MAAM,EACN,IAAI,EACJ,KAAK,EACL,GAAG,WAAW,EACf,EAAE,gBAAgB,GAAG,IAAI;IAa1B,eAAe,CAAC,EACd,OAAO,EACP,QAAQ,EACR,KAAK,EACL,GAAG,WAAW,EACf,EAAE,qBAAqB,GAAG,IAAI;IAa/B,SAAS,CAAC,EACR,IAAI,EACJ,QAAiB,EACjB,gBAAgB,GACjB,EAAE,eAAe,GAAG,IAAI;IAmBzB,aAAa,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI;IAOjD,gBAAgB,CAAC,EACf,GAAG,EACH,WAAW,EACX,eAAe,EACf,YAAkB,EAClB,eAAmB,GACpB,EAAE,sBAAsB,GAAG,IAAI;IAahC,mBAAmB,CAAC,EAAE,GAAG,EAAE,EAAE,yBAAyB,GAAG,IAAI;IAM7D,kBAAkB,IAAI,IAAI;IAM1B,mBAAmB,CAAC,EAClB,OAAO,EACP,YAAY,EACZ,aAAa,EACb,SAAS,EACT,cAAc,EACd,eAAuB,GACxB,EAAE,yBAAyB,GAAG,IAAI;IAiBnC,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAM9C,gBAAgB,CAAC,EACf,GAAG,EACH,WAAW,EACX,eAAe,EACf,YAAY,GACb,EAAE,sBAAsB,GAAG,IAAI;IAYhC,wBAAwB,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI;IAKvD,OAAO,CAAC,KAAK;IAoCb;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,aAAa;CAS7D;AAED,eAAe,aAAa,CAAC"}

package/lib/MatomoTracker.js

@@ -0,0 +1,332 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var constants_1 = require("./constants");
+var MatomoTracker = /** @class */ (function () {
+    function MatomoTracker(userOptions) {
+        this.isInitialized = false;
+        if (typeof window === "undefined") {
+            // Don't run in SSR or non-browser environments
+            return;
+        }
+        if (!userOptions.urlBase) {
+            throw new Error("Matomo urlBase is required.");
+        }
+        if (userOptions.siteId === undefined || userOptions.siteId === null) {
+            throw new Error("Matomo siteId is required.");
+        }
+        this.initialize(userOptions);
+    }
+    MatomoTracker.prototype.initialize = function (_a) {
+        var _this = this;
+        var _b;
+        var urlBase = _a.urlBase, siteId = _a.siteId, userId = _a.userId, trackerUrl = _a.trackerUrl, srcUrl = _a.srcUrl, _c = _a.disabled, disabled = _c === void 0 ? false : _c, heartBeat = _a.heartBeat, _d = _a.linkTracking, linkTracking = _d === void 0 ? true : _d, _e = _a.configurations, configurations = _e === void 0 ? {} : _e;
+        if (disabled) {
+            // If disabled, make all tracking calls no-ops by not initializing _paq or the script
+            this.pushInstruction = function () {
+                var _args = [];
+                for (var _i = 0; _i < arguments.length; _i++) {
+                    _args[_i] = arguments[_i];
+                }
+                return _this;
+            }; // No-op
+            // Make other methods no-op as well
+            var noOp = function () { };
+            this.trackEvent = noOp;
+            this.trackPageView = noOp;
+            this.trackSiteSearch = noOp;
+            this.trackLink = noOp;
+            // ... and so on for all public methods
+            return;
+        }
+        var normalizedUrlBase = urlBase.endsWith("/") ? urlBase : "".concat(urlBase, "/");
+        window._paq = window._paq || [];
+        // Prevent re-initialization if _paq already has Matomo commands beyond simple presence
+        if (this.isInitialized ||
+            (window._paq.length > 0 &&
+                window._paq.some(function (cmd) { return cmd[0] === "setTrackerUrl"; }))) {
+            // If siteId or userId needs to be updated on an existing instance:
+            if (siteId)
+                this.pushInstruction("setSiteId", siteId);
+            if (userId)
+                this.pushInstruction("setUserId", userId);
+            // Potentially re-apply other configurations if needed, or assume they are sticky
+            this.isInitialized = true;
+            return;
+        }
+        this.pushInstruction("setTrackerUrl", trackerUrl !== null && trackerUrl !== void 0 ? trackerUrl : "".concat(normalizedUrlBase, "matomo.php"));
+        this.pushInstruction("setSiteId", siteId);
+        if (userId) {
+            this.pushInstruction("setUserId", userId);
+        }
+        Object.entries(configurations).forEach(function (_a) {
+            var name = _a[0], instructions = _a[1];
+            if (name === "disableCookies" && typeof instructions === "boolean") {
+                _this.pushInstruction("disableCookies"); // Matomo's disableCookies takes no arguments if called this way
+            }
+            else if (instructions instanceof Array) {
+                _this.pushInstruction.apply(_this, __spreadArray([name], instructions, false));
+            }
+            else {
+                _this.pushInstruction(name, instructions);
+            }
+        });
+        if (!heartBeat || (heartBeat && heartBeat.active)) {
+            this.enableHeartBeatTimer((_b = (heartBeat && heartBeat.seconds)) !== null && _b !== void 0 ? _b : 15);
+        }
+        this.enableLinkTracking(linkTracking);
+        var doc = document;
+        var scriptElement = doc.createElement("script");
+        var scripts = doc.getElementsByTagName("script")[0];
+        scriptElement.type = "text/javascript";
+        scriptElement.async = true;
+        scriptElement.defer = true;
+        scriptElement.src = srcUrl || "".concat(normalizedUrlBase, "matomo.js");
+        if (scripts && scripts.parentNode) {
+            scripts.parentNode.insertBefore(scriptElement, scripts);
+        }
+        this.isInitialized = true;
+    };
+    MatomoTracker.prototype.enableHeartBeatTimer = function (seconds) {
+        this.pushInstruction("enableHeartBeatTimer", seconds);
+    };
+    MatomoTracker.prototype.enableLinkTracking = function (active) {
+        this.pushInstruction("enableLinkTracking", active);
+    };
+    MatomoTracker.prototype.trackEventsForElements = function (elements) {
+        var _this = this;
+        if (elements.length) {
+            elements.forEach(function (element) {
+                element.addEventListener("click", function () {
+                    var _a = element.dataset, matomoCategory = _a.matomoCategory, matomoAction = _a.matomoAction, matomoName = _a.matomoName, matomoValue = _a.matomoValue;
+                    if (matomoCategory && matomoAction) {
+                        _this.trackEvent({
+                            category: matomoCategory,
+                            action: matomoAction,
+                            name: matomoName,
+                            value: matomoValue ? Number(matomoValue) : undefined,
+                        });
+                    }
+                    else {
+                        throw new Error("Error: data-matomo-category and data-matomo-action are required.");
+                    }
+                });
+            });
+        }
+    };
+    // Tracks events based on data attributes
+    MatomoTracker.prototype.trackEvents = function () {
+        var _this = this;
+        if (typeof window === "undefined" || !document)
+            return;
+        var matchString = '[data-matomo-event="click"]';
+        var firstTime = false;
+        if (!this.mutationObserver) {
+            firstTime = true;
+            this.mutationObserver = new MutationObserver(function (mutations) {
+                mutations.forEach(function (mutation) {
+                    mutation.addedNodes.forEach(function (node) {
+                        // only track HTML elements
+                        if (!(node instanceof HTMLElement))
+                            return;
+                        // check the inserted element for being a code snippet
+                        if (node.matches(matchString)) {
+                            _this.trackEventsForElements([node]);
+                        }
+                        var elements = Array.from(node.querySelectorAll(matchString));
+                        _this.trackEventsForElements(elements);
+                    });
+                });
+            });
+        }
+        this.mutationObserver.observe(document, { childList: true, subtree: true });
+        // Now track all already existing elements
+        if (firstTime) {
+            var elements = Array.from(document.querySelectorAll(matchString));
+            this.trackEventsForElements(elements);
+        }
+    };
+    MatomoTracker.prototype.stopObserving = function () {
+        if (this.mutationObserver) {
+            this.mutationObserver.disconnect();
+        }
+    };
+    // Tracks events
+    // https://matomo.org/docs/event-tracking/#tracking-events
+    MatomoTracker.prototype.trackEvent = function (_a) {
+        var category = _a.category, action = _a.action, name = _a.name, value = _a.value, otherParams = __rest(_a, ["category", "action", "name", "value"]);
+        if (category && action) {
+            this.track(__assign({ data: [constants_1.TRACK_TYPES.TRACK_EVENT, category, action, name, value] }, otherParams));
+        }
+        else {
+            throw new Error("Error: category and action are required.");
+        }
+    };
+    // Tracks site search
+    // https://developer.matomo.org/guides/tracking-javascript-guide#internal-search-tracking
+    MatomoTracker.prototype.trackSiteSearch = function (_a) {
+        var keyword = _a.keyword, category = _a.category, count = _a.count, otherParams = __rest(_a, ["keyword", "category", "count"]);
+        if (keyword) {
+            this.track(__assign({ data: [constants_1.TRACK_TYPES.TRACK_SEARCH, keyword, category, count] }, otherParams));
+        }
+        else {
+            throw new Error("Error: keyword is required.");
+        }
+    };
+    // Tracks outgoing links to other sites and downloads
+    // https://developer.matomo.org/guides/tracking-javascript-guide#enabling-download-outlink-tracking
+    MatomoTracker.prototype.trackLink = function (_a) {
+        var _this = this;
+        var href = _a.href, _b = _a.linkType, linkType = _b === void 0 ? "link" : _b, customDimensions = _a.customDimensions;
+        if (customDimensions &&
+            Array.isArray(customDimensions) &&
+            customDimensions.length) {
+            customDimensions.forEach(function (customDimension) {
+                return _this.pushInstruction("setCustomDimension", customDimension.id, customDimension.value);
+            });
+        }
+        this.pushInstruction(constants_1.TRACK_TYPES.TRACK_LINK, href, linkType);
+    };
+    // Tracks page views
+    // https://developer.matomo.org/guides/spa-tracking#tracking-a-new-page-view
+    MatomoTracker.prototype.trackPageView = function (params) {
+        this.track(__assign({ data: [constants_1.TRACK_TYPES.TRACK_VIEW] }, params));
+    };
+    // Adds a product to an Ecommerce order to be tracked via trackEcommerceOrder.
+    // https://matomo.org/docs/ecommerce-analytics
+    // https://matomo.org/docs/ecommerce-analytics/#1-addecommerceitemproductsku-productname-productcategory-price-quantity
+    MatomoTracker.prototype.addEcommerceItem = function (_a) {
+        var sku = _a.sku, productName = _a.productName, productCategory = _a.productCategory, _b = _a.productPrice, productPrice = _b === void 0 ? 0.0 : _b, _c = _a.productQuantity, productQuantity = _c === void 0 ? 1 : _c;
+        this.pushInstruction("addEcommerceItem", sku, productName, productCategory, productPrice, productQuantity);
+    };
+    // Removes a product from an Ecommerce order to be tracked via trackEcommerceOrder.
+    // https://matomo.org/docs/ecommerce-analytics
+    MatomoTracker.prototype.removeEcommerceItem = function (_a) {
+        var sku = _a.sku;
+        this.pushInstruction("removeEcommerceItem", sku);
+    };
+    // Removes all products from an Ecommerce order to be tracked via trackEcommerceOrder.
+    // https://matomo.org/docs/ecommerce-analytics
+    MatomoTracker.prototype.clearEcommerceCart = function () {
+        this.pushInstruction("clearEcommerceCart");
+    };
+    // Tracks an Ecommerce order containing items added via addEcommerceItem.
+    // https://matomo.org/docs/ecommerce-analytics/#2-trackecommerceorderorderid-revenue-subtotal-tax-shipping-discount
+    MatomoTracker.prototype.trackEcommerceOrder = function (_a) {
+        var orderId = _a.orderId, orderRevenue = _a.orderRevenue, orderSubTotal = _a.orderSubTotal, taxAmount = _a.taxAmount, shippingAmount = _a.shippingAmount, _b = _a.discountOffered, discountOffered = _b === void 0 ? false : _b;
+        this.track({
+            data: [
+                constants_1.TRACK_TYPES.TRACK_ECOMMERCE_ORDER,
+                orderId,
+                orderRevenue,
+                orderSubTotal,
+                taxAmount,
+                shippingAmount,
+                discountOffered,
+            ],
+        });
+    };
+    // Tracks updates to an Ecommerce Cart before an actual purchase.
+    // This will replace currently tracked information of the cart. Always include all items of the updated cart!
+    // https://matomo.org/docs/ecommerce-analytics/#example-tracking-an-ecommerce-cart-update-containing-two-products
+    MatomoTracker.prototype.trackEcommerceCartUpdate = function (amount) {
+        this.pushInstruction(constants_1.TRACK_TYPES.TRACK_ECOMMERCE_CART_UPDATE, amount);
+    };
+    // Marks the next page view as an Ecommerce product page.
+    // https://matomo.org/docs/ecommerce-analytics/#example-tracking-a-product-page-view
+    MatomoTracker.prototype.setEcommerceView = function (_a) {
+        var sku = _a.sku, productName = _a.productName, productCategory = _a.productCategory, productPrice = _a.productPrice;
+        this.pushInstruction("setEcommerceView", sku, productName, productCategory, productPrice);
+    };
+    // Marks the next tracked page view as an Ecommerce category page.
+    // https://matomo.org/docs/ecommerce-analytics/#example-tracking-a-category-page-view
+    MatomoTracker.prototype.setEcommerceCategoryView = function (productCategory) {
+        this.setEcommerceView({ productCategory: productCategory, productName: false, sku: false });
+    };
+    // Sends the tracked page/view/search to Matomo
+    MatomoTracker.prototype.track = function (_a) {
+        var _this = this;
+        var _b = _a.data, data = _b === void 0 ? [] : _b, documentTitle = _a.documentTitle, // Changed: use passed documentTitle or fallback to window.document.title later
+        href = _a.href, _c = _a.customDimensions, customDimensions = _c === void 0 ? false : _c;
+        if (typeof window === "undefined")
+            return;
+        if (data.length) {
+            if (customDimensions &&
+                Array.isArray(customDimensions) &&
+                customDimensions.length) {
+                customDimensions.forEach(function (customDimension // Corrected type
+                ) {
+                    return _this.pushInstruction("setCustomDimension", customDimension.id, customDimension.value);
+                });
+            }
+            this.pushInstruction("setCustomUrl", href !== null && href !== void 0 ? href : window.location.href);
+            // Use provided documentTitle, fallback to actual document.title only if not provided
+            this.pushInstruction("setDocumentTitle", documentTitle !== null && documentTitle !== void 0 ? documentTitle : window.document.title);
+            this.pushInstruction.apply(this, data);
+        }
+    };
+    /**
+     * Pushes an instruction to Matomo for execution, this is equivalent to pushing entries into the `_paq` array.
+     *
+     * For example:
+     *
+     * ```ts
+     * pushInstruction('setDocumentTitle', document.title)
+     * ```
+     * Is the equivalent of:
+     *
+     * ```ts
+     * _paq.push(['setDocumentTitle', document.title]);
+     * ```
+     *
+     * @param name The name of the instruction to be executed.
+     * @param args The arguments to pass along with the instruction.
+     */
+    MatomoTracker.prototype.pushInstruction = function (name) {
+        var args = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            args[_i - 1] = arguments[_i];
+        }
+        if (typeof window !== "undefined" && window._paq) {
+            window._paq.push(__spreadArray([name], args, true));
+        }
+        else if (typeof window !== "undefined" && name === "setTrackerUrl") {
+            // Allow setting up _paq if it's the first instruction (like setTrackerUrl)
+            window._paq = [__spreadArray([name], args, true)];
+        }
+        return this;
+    };
+    return MatomoTracker;
+}());
+exports.default = MatomoTracker;
+//# sourceMappingURL=MatomoTracker.js.map