Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
react-ga4-forked
Advanced tools
react-ga4-forked - npm Package Compare versions
Comparing version 1.5.4 to 2.0.0
152
dist/ga4.js
@@ -11,8 +11,7 @@ "use strict"; | ||
| _excluded2 = ["title", "location"], | ||
| _excluded3 = ["page", "hitType"], | ||
| _excluded4 = ["action", "category", "label", "value", "nonInteraction", "transport"]; | ||
| _excluded3 = ["page", "hitType"]; | ||
| function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; } | ||
| function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; } | ||
| function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; } | ||
| function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); } | ||
| function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); } | ||
| function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); } | ||
@@ -22,4 +21,4 @@ function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } | ||
| function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); } | ||
| function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; } | ||
| function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; } | ||
| function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; } | ||
| function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; } | ||
| function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); } | ||
@@ -29,3 +28,3 @@ function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } | ||
| function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; } | ||
| function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i["return"] && (_r = _i["return"](), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } } | ||
| function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } } | ||
| function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; } | ||
@@ -80,3 +79,3 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } } | ||
| */ | ||
| var GA4 = /*#__PURE__*/function () { | ||
| var GA4 = exports.GA4 = /*#__PURE__*/function () { | ||
| function GA4() { | ||
@@ -107,3 +106,5 @@ var _this = this; | ||
| }); | ||
| _defineProperty(this, "_loadGA", function (GA_MEASUREMENT_ID, nonce, scriptSrc, scriptLoadingMode) { | ||
| _defineProperty(this, "_loadGA", function (GA_MEASUREMENT_ID, nonce) { | ||
| var scriptSrc = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 'https://www.googletagmanager.com/gtag/js'; | ||
| var scriptLoadingMode = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 'async'; | ||
| if (typeof window === 'undefined' || typeof document === 'undefined') { | ||
@@ -169,2 +170,13 @@ return; | ||
| }); | ||
| /** | ||
| * | ||
| * @param {InitOptions[]|string} GA_MEASUREMENT_ID | ||
| * @param {Object} [options] | ||
| * @param {boolean} [options.scriptSrc="https://www.googletagmanager.com/gtag/js"] | ||
| * @param {'async'|'defer'} [options.scriptLoadingMode='async'] | ||
| * @param {string} [options.nonce] | ||
| * @param {boolean} [options.testMode=false] | ||
| * @param {GaOptions|any} [options.gaOptions] | ||
| * @param {Object} [options.gtagOptions] New parameter | ||
| */ | ||
| _defineProperty(this, "initialize", function (GA_MEASUREMENT_ID) { | ||
@@ -181,4 +193,2 @@ var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; | ||
| gtagOptions = options.gtagOptions, | ||
| _options$legacyDimens = options.legacyDimensionMetric, | ||
| legacyDimensionMetric = _options$legacyDimens === void 0 ? true : _options$legacyDimens, | ||
| nonce = options.nonce, | ||
@@ -198,7 +208,8 @@ _options$testMode = options.testMode, | ||
| initConfigs.forEach(function (config) { | ||
| var mergedGtagOptions = _this._appendCustomMap(_objectSpread(_objectSpread(_objectSpread({ | ||
| // https://developers.google.com/analytics/devguides/collection/gtagjs/pages#disable_pageview_measurement | ||
| send_page_view: false | ||
| }, _this._toGtagOptions(_objectSpread(_objectSpread({}, gaOptions), config.gaOptions))), gtagOptions), config.gtagOptions), legacyDimensionMetric); | ||
| _this._gtag('config', config.trackingId, mergedGtagOptions); | ||
| var mergedGtagOptions = _objectSpread(_objectSpread(_objectSpread({}, _this._toGtagOptions(_objectSpread(_objectSpread({}, gaOptions), config.gaOptions))), gtagOptions), config.gtagOptions); | ||
| if (Object.keys(mergedGtagOptions).length) { | ||
| _this._gtag('config', config.trackingId, mergedGtagOptions); | ||
| } else { | ||
| _this._gtag('config', config.trackingId); | ||
| } | ||
| }); | ||
@@ -303,2 +314,3 @@ } | ||
| }); | ||
| // https://developers.google.com/analytics/devguides/collection/analyticsjs/command-queue-reference#send | ||
| _defineProperty(this, "_gaCommandSend", function () { | ||
@@ -381,2 +393,6 @@ for (var _len4 = arguments.length, args = new Array(_len4), _key4 = 0; _key4 < _len4; _key4++) { | ||
| }); | ||
| /** | ||
| * @param {UaEventOptions|string} optionsOrName | ||
| * @param {Object} [params] | ||
| */ | ||
| _defineProperty(this, "event", function (optionsOrName, params) { | ||
@@ -391,4 +407,3 @@ if (typeof optionsOrName === 'string') { | ||
| nonInteraction = optionsOrName.nonInteraction, | ||
| transport = optionsOrName.transport, | ||
| rest = _objectWithoutProperties(optionsOrName, _excluded4); | ||
| transport = optionsOrName.transport; | ||
| if (!category || !action) { | ||
@@ -434,12 +449,2 @@ console.warn('args.category AND args.action are required in event()'); | ||
| } | ||
| Object.keys(rest).filter(function (key) { | ||
| return key.substr(0, 'dimension'.length) === 'dimension'; | ||
| }).forEach(function (key) { | ||
| fieldObject[key] = rest[key]; | ||
| }); | ||
| Object.keys(rest).filter(function (key) { | ||
| return key.substr(0, 'metric'.length) === 'metric'; | ||
| }).forEach(function (key) { | ||
| fieldObject[key] = rest[key]; | ||
| }); | ||
| _this._gaCommand('send', fieldObject); | ||
@@ -451,12 +456,2 @@ } | ||
| }); | ||
| _defineProperty(this, "pageview", function (path, _, title) { | ||
| var pathTrim = path === null || path === void 0 ? void 0 : path.trim(); | ||
| if (pathTrim === '') { | ||
| console.warn('path cannot be an empty string in .pageview()'); | ||
| return; | ||
| } | ||
| _this._gaCommand('send', 'pageview', pathTrim, { | ||
| title: title | ||
| }); | ||
| }); | ||
| this.reset(); | ||
@@ -469,86 +464,5 @@ } | ||
| } | ||
| }, { | ||
| key: "_appendCustomMap", | ||
| value: function _appendCustomMap(options) { | ||
| var legacyDimensionMetric = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true; | ||
| if (!legacyDimensionMetric) { | ||
| return options; | ||
| } | ||
| if (!options.custom_map) { | ||
| options.custom_map = {}; | ||
| } | ||
| for (var i = 1; i <= 200; i++) { | ||
| if (!options.custom_map["dimension".concat(i)]) { | ||
| options.custom_map["dimension".concat(i)] = "dimension".concat(i); | ||
| } | ||
| if (!options.custom_map["metric".concat(i)]) { | ||
| options.custom_map["metric".concat(i)] = "metric".concat(i); | ||
| } | ||
| } | ||
| return options; | ||
| } | ||
| /** | ||
| * @since v1.0.2 | ||
| * @param {string} [path="location.href"] | ||
| * @param {string[]} [_] unsupported | ||
| * @param {string} [title="location.pathname"] | ||
| * @deprecated Use `.send("pageview")` instead | ||
| */ | ||
| }, { | ||
| key: "outboundLink", | ||
| value: | ||
| /** | ||
| * @since v1.0.6 | ||
| * @param {Object} options | ||
| * @param {string} options.label | ||
| * @param {function} hitCallback | ||
| * @deprecated Use `enhanced measurement` feature in Google Analytics. | ||
| */ | ||
| function outboundLink(_ref3, hitCallback) { | ||
| var label = _ref3.label; | ||
| if (typeof hitCallback !== 'function') { | ||
| console.warn('hitCallback function is required'); | ||
| return; | ||
| } | ||
| if (!label) { | ||
| console.warn('args.label is required in outboundLink()'); | ||
| return; | ||
| } | ||
| // Required Fields | ||
| var fieldObject = { | ||
| hitType: 'event', | ||
| eventCategory: 'Outbound', | ||
| eventAction: 'Click', | ||
| eventLabel: (0, _format["default"])(label) | ||
| }; | ||
| var safetyCallbackCalled = false; | ||
| var safetyCallback = function safetyCallback() { | ||
| // This prevents a delayed response from GA | ||
| // causing hitCallback from being fired twice | ||
| safetyCallbackCalled = true; | ||
| hitCallback(); | ||
| }; | ||
| // Using a timeout to ensure the execution of critical application code | ||
| // in the case when the GA server might be down | ||
| // or an ad blocker prevents sending the data | ||
| // register safety net timeout: | ||
| var t = setTimeout(safetyCallback, 250); | ||
| var clearableCallbackForGA = function clearableCallbackForGA() { | ||
| clearTimeout(t); | ||
| if (!safetyCallbackCalled) { | ||
| hitCallback(); | ||
| } | ||
| }; | ||
| fieldObject.hitCallback = clearableCallbackForGA; | ||
| this._gaCommand('send', fieldObject); | ||
| } | ||
| }]); | ||
| return GA4; | ||
| }(); | ||
| exports.GA4 = GA4; | ||
| var _default = new GA4(); | ||
| exports["default"] = _default; | ||
| var _default = exports["default"] = new GA4(); |
| "use strict"; | ||
| function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); } | ||
| function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); } | ||
| var _gtag = _interopRequireDefault(require("./gtag")); | ||
| var _ga = _interopRequireDefault(require("./ga4")); | ||
| var _ga2 = require("./ga4.mock"); | ||
| function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; } | ||
| function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return exports; }; var exports = {}, Op = Object.prototype, hasOwn = Op.hasOwnProperty, defineProperty = Object.defineProperty || function (obj, key, desc) { obj[key] = desc.value; }, $Symbol = "function" == typeof Symbol ? Symbol : {}, iteratorSymbol = $Symbol.iterator || "@@iterator", asyncIteratorSymbol = $Symbol.asyncIterator || "@@asyncIterator", toStringTagSymbol = $Symbol.toStringTag || "@@toStringTag"; function define(obj, key, value) { return Object.defineProperty(obj, key, { value: value, enumerable: !0, configurable: !0, writable: !0 }), obj[key]; } try { define({}, ""); } catch (err) { define = function define(obj, key, value) { return obj[key] = value; }; } function wrap(innerFn, outerFn, self, tryLocsList) { var protoGenerator = outerFn && outerFn.prototype instanceof Generator ? outerFn : Generator, generator = Object.create(protoGenerator.prototype), context = new Context(tryLocsList || []); return defineProperty(generator, "_invoke", { value: makeInvokeMethod(innerFn, self, context) }), generator; } function tryCatch(fn, obj, arg) { try { return { type: "normal", arg: fn.call(obj, arg) }; } catch (err) { return { type: "throw", arg: err }; } } exports.wrap = wrap; var ContinueSentinel = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var IteratorPrototype = {}; define(IteratorPrototype, iteratorSymbol, function () { return this; }); var getProto = Object.getPrototypeOf, NativeIteratorPrototype = getProto && getProto(getProto(values([]))); NativeIteratorPrototype && NativeIteratorPrototype !== Op && hasOwn.call(NativeIteratorPrototype, iteratorSymbol) && (IteratorPrototype = NativeIteratorPrototype); var Gp = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(IteratorPrototype); function defineIteratorMethods(prototype) { ["next", "throw", "return"].forEach(function (method) { define(prototype, method, function (arg) { return this._invoke(method, arg); }); }); } function AsyncIterator(generator, PromiseImpl) { function invoke(method, arg, resolve, reject) { var record = tryCatch(generator[method], generator, arg); if ("throw" !== record.type) { var result = record.arg, value = result.value; return value && "object" == _typeof(value) && hasOwn.call(value, "__await") ? PromiseImpl.resolve(value.__await).then(function (value) { invoke("next", value, resolve, reject); }, function (err) { invoke("throw", err, resolve, reject); }) : PromiseImpl.resolve(value).then(function (unwrapped) { result.value = unwrapped, resolve(result); }, function (error) { return invoke("throw", error, resolve, reject); }); } reject(record.arg); } var previousPromise; defineProperty(this, "_invoke", { value: function value(method, arg) { function callInvokeWithMethodAndArg() { return new PromiseImpl(function (resolve, reject) { invoke(method, arg, resolve, reject); }); } return previousPromise = previousPromise ? previousPromise.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(innerFn, self, context) { var state = "suspendedStart"; return function (method, arg) { if ("executing" === state) throw new Error("Generator is already running"); if ("completed" === state) { if ("throw" === method) throw arg; return doneResult(); } for (context.method = method, context.arg = arg;;) { var delegate = context.delegate; if (delegate) { var delegateResult = maybeInvokeDelegate(delegate, context); if (delegateResult) { if (delegateResult === ContinueSentinel) continue; return delegateResult; } } if ("next" === context.method) context.sent = context._sent = context.arg;else if ("throw" === context.method) { if ("suspendedStart" === state) throw state = "completed", context.arg; context.dispatchException(context.arg); } else "return" === context.method && context.abrupt("return", context.arg); state = "executing"; var record = tryCatch(innerFn, self, context); if ("normal" === record.type) { if (state = context.done ? "completed" : "suspendedYield", record.arg === ContinueSentinel) continue; return { value: record.arg, done: context.done }; } "throw" === record.type && (state = "completed", context.method = "throw", context.arg = record.arg); } }; } function maybeInvokeDelegate(delegate, context) { var methodName = context.method, method = delegate.iterator[methodName]; if (undefined === method) return context.delegate = null, "throw" === methodName && delegate.iterator["return"] && (context.method = "return", context.arg = undefined, maybeInvokeDelegate(delegate, context), "throw" === context.method) || "return" !== methodName && (context.method = "throw", context.arg = new TypeError("The iterator does not provide a '" + methodName + "' method")), ContinueSentinel; var record = tryCatch(method, delegate.iterator, context.arg); if ("throw" === record.type) return context.method = "throw", context.arg = record.arg, context.delegate = null, ContinueSentinel; var info = record.arg; return info ? info.done ? (context[delegate.resultName] = info.value, context.next = delegate.nextLoc, "return" !== context.method && (context.method = "next", context.arg = undefined), context.delegate = null, ContinueSentinel) : info : (context.method = "throw", context.arg = new TypeError("iterator result is not an object"), context.delegate = null, ContinueSentinel); } function pushTryEntry(locs) { var entry = { tryLoc: locs[0] }; 1 in locs && (entry.catchLoc = locs[1]), 2 in locs && (entry.finallyLoc = locs[2], entry.afterLoc = locs[3]), this.tryEntries.push(entry); } function resetTryEntry(entry) { var record = entry.completion || {}; record.type = "normal", delete record.arg, entry.completion = record; } function Context(tryLocsList) { this.tryEntries = [{ tryLoc: "root" }], tryLocsList.forEach(pushTryEntry, this), this.reset(!0); } function values(iterable) { if (iterable) { var iteratorMethod = iterable[iteratorSymbol]; if (iteratorMethod) return iteratorMethod.call(iterable); if ("function" == typeof iterable.next) return iterable; if (!isNaN(iterable.length)) { var i = -1, next = function next() { for (; ++i < iterable.length;) if (hasOwn.call(iterable, i)) return next.value = iterable[i], next.done = !1, next; return next.value = undefined, next.done = !0, next; }; return next.next = next; } } return { next: doneResult }; } function doneResult() { return { value: undefined, done: !0 }; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, defineProperty(Gp, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), defineProperty(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, toStringTagSymbol, "GeneratorFunction"), exports.isGeneratorFunction = function (genFun) { var ctor = "function" == typeof genFun && genFun.constructor; return !!ctor && (ctor === GeneratorFunction || "GeneratorFunction" === (ctor.displayName || ctor.name)); }, exports.mark = function (genFun) { return Object.setPrototypeOf ? Object.setPrototypeOf(genFun, GeneratorFunctionPrototype) : (genFun.__proto__ = GeneratorFunctionPrototype, define(genFun, toStringTagSymbol, "GeneratorFunction")), genFun.prototype = Object.create(Gp), genFun; }, exports.awrap = function (arg) { return { __await: arg }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, asyncIteratorSymbol, function () { return this; }), exports.AsyncIterator = AsyncIterator, exports.async = function (innerFn, outerFn, self, tryLocsList, PromiseImpl) { void 0 === PromiseImpl && (PromiseImpl = Promise); var iter = new AsyncIterator(wrap(innerFn, outerFn, self, tryLocsList), PromiseImpl); return exports.isGeneratorFunction(outerFn) ? iter : iter.next().then(function (result) { return result.done ? result.value : iter.next(); }); }, defineIteratorMethods(Gp), define(Gp, toStringTagSymbol, "Generator"), define(Gp, iteratorSymbol, function () { return this; }), define(Gp, "toString", function () { return "[object Generator]"; }), exports.keys = function (val) { var object = Object(val), keys = []; for (var key in object) keys.push(key); return keys.reverse(), function next() { for (; keys.length;) { var key = keys.pop(); if (key in object) return next.value = key, next.done = !1, next; } return next.done = !0, next; }; }, exports.values = values, Context.prototype = { constructor: Context, reset: function reset(skipTempReset) { if (this.prev = 0, this.next = 0, this.sent = this._sent = undefined, this.done = !1, this.delegate = null, this.method = "next", this.arg = undefined, this.tryEntries.forEach(resetTryEntry), !skipTempReset) for (var name in this) "t" === name.charAt(0) && hasOwn.call(this, name) && !isNaN(+name.slice(1)) && (this[name] = undefined); }, stop: function stop() { this.done = !0; var rootRecord = this.tryEntries[0].completion; if ("throw" === rootRecord.type) throw rootRecord.arg; return this.rval; }, dispatchException: function dispatchException(exception) { if (this.done) throw exception; var context = this; function handle(loc, caught) { return record.type = "throw", record.arg = exception, context.next = loc, caught && (context.method = "next", context.arg = undefined), !!caught; } for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i], record = entry.completion; if ("root" === entry.tryLoc) return handle("end"); if (entry.tryLoc <= this.prev) { var hasCatch = hasOwn.call(entry, "catchLoc"), hasFinally = hasOwn.call(entry, "finallyLoc"); if (hasCatch && hasFinally) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } else if (hasCatch) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); } else { if (!hasFinally) throw new Error("try statement without catch or finally"); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } } } }, abrupt: function abrupt(type, arg) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc <= this.prev && hasOwn.call(entry, "finallyLoc") && this.prev < entry.finallyLoc) { var finallyEntry = entry; break; } } finallyEntry && ("break" === type || "continue" === type) && finallyEntry.tryLoc <= arg && arg <= finallyEntry.finallyLoc && (finallyEntry = null); var record = finallyEntry ? finallyEntry.completion : {}; return record.type = type, record.arg = arg, finallyEntry ? (this.method = "next", this.next = finallyEntry.finallyLoc, ContinueSentinel) : this.complete(record); }, complete: function complete(record, afterLoc) { if ("throw" === record.type) throw record.arg; return "break" === record.type || "continue" === record.type ? this.next = record.arg : "return" === record.type ? (this.rval = this.arg = record.arg, this.method = "return", this.next = "end") : "normal" === record.type && afterLoc && (this.next = afterLoc), ContinueSentinel; }, finish: function finish(finallyLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.finallyLoc === finallyLoc) return this.complete(entry.completion, entry.afterLoc), resetTryEntry(entry), ContinueSentinel; } }, "catch": function _catch(tryLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc === tryLoc) { var record = entry.completion; if ("throw" === record.type) { var thrown = record.arg; resetTryEntry(entry); } return thrown; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(iterable, resultName, nextLoc) { return this.delegate = { iterator: values(iterable), resultName: resultName, nextLoc: nextLoc }, "next" === this.method && (this.arg = undefined), ContinueSentinel; } }, exports; } | ||
| function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return e; }; var t, e = {}, r = Object.prototype, n = r.hasOwnProperty, o = Object.defineProperty || function (t, e, r) { t[e] = r.value; }, i = "function" == typeof Symbol ? Symbol : {}, a = i.iterator || "@@iterator", c = i.asyncIterator || "@@asyncIterator", u = i.toStringTag || "@@toStringTag"; function define(t, e, r) { return Object.defineProperty(t, e, { value: r, enumerable: !0, configurable: !0, writable: !0 }), t[e]; } try { define({}, ""); } catch (t) { define = function define(t, e, r) { return t[e] = r; }; } function wrap(t, e, r, n) { var i = e && e.prototype instanceof Generator ? e : Generator, a = Object.create(i.prototype), c = new Context(n || []); return o(a, "_invoke", { value: makeInvokeMethod(t, r, c) }), a; } function tryCatch(t, e, r) { try { return { type: "normal", arg: t.call(e, r) }; } catch (t) { return { type: "throw", arg: t }; } } e.wrap = wrap; var h = "suspendedStart", l = "suspendedYield", f = "executing", s = "completed", y = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var p = {}; define(p, a, function () { return this; }); var d = Object.getPrototypeOf, v = d && d(d(values([]))); v && v !== r && n.call(v, a) && (p = v); var g = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(p); function defineIteratorMethods(t) { ["next", "throw", "return"].forEach(function (e) { define(t, e, function (t) { return this._invoke(e, t); }); }); } function AsyncIterator(t, e) { function invoke(r, o, i, a) { var c = tryCatch(t[r], t, o); if ("throw" !== c.type) { var u = c.arg, h = u.value; return h && "object" == _typeof(h) && n.call(h, "__await") ? e.resolve(h.__await).then(function (t) { invoke("next", t, i, a); }, function (t) { invoke("throw", t, i, a); }) : e.resolve(h).then(function (t) { u.value = t, i(u); }, function (t) { return invoke("throw", t, i, a); }); } a(c.arg); } var r; o(this, "_invoke", { value: function value(t, n) { function callInvokeWithMethodAndArg() { return new e(function (e, r) { invoke(t, n, e, r); }); } return r = r ? r.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(e, r, n) { var o = h; return function (i, a) { if (o === f) throw new Error("Generator is already running"); if (o === s) { if ("throw" === i) throw a; return { value: t, done: !0 }; } for (n.method = i, n.arg = a;;) { var c = n.delegate; if (c) { var u = maybeInvokeDelegate(c, n); if (u) { if (u === y) continue; return u; } } if ("next" === n.method) n.sent = n._sent = n.arg;else if ("throw" === n.method) { if (o === h) throw o = s, n.arg; n.dispatchException(n.arg); } else "return" === n.method && n.abrupt("return", n.arg); o = f; var p = tryCatch(e, r, n); if ("normal" === p.type) { if (o = n.done ? s : l, p.arg === y) continue; return { value: p.arg, done: n.done }; } "throw" === p.type && (o = s, n.method = "throw", n.arg = p.arg); } }; } function maybeInvokeDelegate(e, r) { var n = r.method, o = e.iterator[n]; if (o === t) return r.delegate = null, "throw" === n && e.iterator["return"] && (r.method = "return", r.arg = t, maybeInvokeDelegate(e, r), "throw" === r.method) || "return" !== n && (r.method = "throw", r.arg = new TypeError("The iterator does not provide a '" + n + "' method")), y; var i = tryCatch(o, e.iterator, r.arg); if ("throw" === i.type) return r.method = "throw", r.arg = i.arg, r.delegate = null, y; var a = i.arg; return a ? a.done ? (r[e.resultName] = a.value, r.next = e.nextLoc, "return" !== r.method && (r.method = "next", r.arg = t), r.delegate = null, y) : a : (r.method = "throw", r.arg = new TypeError("iterator result is not an object"), r.delegate = null, y); } function pushTryEntry(t) { var e = { tryLoc: t[0] }; 1 in t && (e.catchLoc = t[1]), 2 in t && (e.finallyLoc = t[2], e.afterLoc = t[3]), this.tryEntries.push(e); } function resetTryEntry(t) { var e = t.completion || {}; e.type = "normal", delete e.arg, t.completion = e; } function Context(t) { this.tryEntries = [{ tryLoc: "root" }], t.forEach(pushTryEntry, this), this.reset(!0); } function values(e) { if (e || "" === e) { var r = e[a]; if (r) return r.call(e); if ("function" == typeof e.next) return e; if (!isNaN(e.length)) { var o = -1, i = function next() { for (; ++o < e.length;) if (n.call(e, o)) return next.value = e[o], next.done = !1, next; return next.value = t, next.done = !0, next; }; return i.next = i; } } throw new TypeError(_typeof(e) + " is not iterable"); } return GeneratorFunction.prototype = GeneratorFunctionPrototype, o(g, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), o(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, u, "GeneratorFunction"), e.isGeneratorFunction = function (t) { var e = "function" == typeof t && t.constructor; return !!e && (e === GeneratorFunction || "GeneratorFunction" === (e.displayName || e.name)); }, e.mark = function (t) { return Object.setPrototypeOf ? Object.setPrototypeOf(t, GeneratorFunctionPrototype) : (t.__proto__ = GeneratorFunctionPrototype, define(t, u, "GeneratorFunction")), t.prototype = Object.create(g), t; }, e.awrap = function (t) { return { __await: t }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, c, function () { return this; }), e.AsyncIterator = AsyncIterator, e.async = function (t, r, n, o, i) { void 0 === i && (i = Promise); var a = new AsyncIterator(wrap(t, r, n, o), i); return e.isGeneratorFunction(r) ? a : a.next().then(function (t) { return t.done ? t.value : a.next(); }); }, defineIteratorMethods(g), define(g, u, "Generator"), define(g, a, function () { return this; }), define(g, "toString", function () { return "[object Generator]"; }), e.keys = function (t) { var e = Object(t), r = []; for (var n in e) r.push(n); return r.reverse(), function next() { for (; r.length;) { var t = r.pop(); if (t in e) return next.value = t, next.done = !1, next; } return next.done = !0, next; }; }, e.values = values, Context.prototype = { constructor: Context, reset: function reset(e) { if (this.prev = 0, this.next = 0, this.sent = this._sent = t, this.done = !1, this.delegate = null, this.method = "next", this.arg = t, this.tryEntries.forEach(resetTryEntry), !e) for (var r in this) "t" === r.charAt(0) && n.call(this, r) && !isNaN(+r.slice(1)) && (this[r] = t); }, stop: function stop() { this.done = !0; var t = this.tryEntries[0].completion; if ("throw" === t.type) throw t.arg; return this.rval; }, dispatchException: function dispatchException(e) { if (this.done) throw e; var r = this; function handle(n, o) { return a.type = "throw", a.arg = e, r.next = n, o && (r.method = "next", r.arg = t), !!o; } for (var o = this.tryEntries.length - 1; o >= 0; --o) { var i = this.tryEntries[o], a = i.completion; if ("root" === i.tryLoc) return handle("end"); if (i.tryLoc <= this.prev) { var c = n.call(i, "catchLoc"), u = n.call(i, "finallyLoc"); if (c && u) { if (this.prev < i.catchLoc) return handle(i.catchLoc, !0); if (this.prev < i.finallyLoc) return handle(i.finallyLoc); } else if (c) { if (this.prev < i.catchLoc) return handle(i.catchLoc, !0); } else { if (!u) throw new Error("try statement without catch or finally"); if (this.prev < i.finallyLoc) return handle(i.finallyLoc); } } } }, abrupt: function abrupt(t, e) { for (var r = this.tryEntries.length - 1; r >= 0; --r) { var o = this.tryEntries[r]; if (o.tryLoc <= this.prev && n.call(o, "finallyLoc") && this.prev < o.finallyLoc) { var i = o; break; } } i && ("break" === t || "continue" === t) && i.tryLoc <= e && e <= i.finallyLoc && (i = null); var a = i ? i.completion : {}; return a.type = t, a.arg = e, i ? (this.method = "next", this.next = i.finallyLoc, y) : this.complete(a); }, complete: function complete(t, e) { if ("throw" === t.type) throw t.arg; return "break" === t.type || "continue" === t.type ? this.next = t.arg : "return" === t.type ? (this.rval = this.arg = t.arg, this.method = "return", this.next = "end") : "normal" === t.type && e && (this.next = e), y; }, finish: function finish(t) { for (var e = this.tryEntries.length - 1; e >= 0; --e) { var r = this.tryEntries[e]; if (r.finallyLoc === t) return this.complete(r.completion, r.afterLoc), resetTryEntry(r), y; } }, "catch": function _catch(t) { for (var e = this.tryEntries.length - 1; e >= 0; --e) { var r = this.tryEntries[e]; if (r.tryLoc === t) { var n = r.completion; if ("throw" === n.type) { var o = n.arg; resetTryEntry(r); } return o; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(e, r, n) { return this.delegate = { iterator: values(e), resultName: r, nextLoc: n }, "next" === this.method && (this.arg = t), y; } }, e; } | ||
| function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } } | ||
@@ -28,6 +27,3 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; } | ||
| expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "js", newDate); | ||
| expect(_gtag["default"]).toHaveBeenNthCalledWith(2, "config", GA_MEASUREMENT_ID, { | ||
| custom_map: _ga2.givenCustomMap, | ||
| send_page_view: false | ||
| }); | ||
| expect(_gtag["default"]).toHaveBeenNthCalledWith(2, "config", GA_MEASUREMENT_ID); | ||
| expect(_gtag["default"]).toHaveBeenCalledTimes(2); | ||
@@ -49,4 +45,2 @@ }); | ||
| expect(_gtag["default"]).toHaveBeenNthCalledWith(2, "config", GA_MEASUREMENT_ID, { | ||
| custom_map: _ga2.givenCustomMap, | ||
| send_page_view: false, | ||
| cookie_update: false | ||
@@ -87,10 +81,4 @@ }); | ||
| expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "js", newDate); | ||
| expect(_gtag["default"]).toHaveBeenNthCalledWith(2, "config", GA_MEASUREMENT_ID, { | ||
| custom_map: _ga2.givenCustomMap, | ||
| send_page_view: false | ||
| }); | ||
| expect(_gtag["default"]).toHaveBeenNthCalledWith(3, "config", GA_MEASUREMENT_ID2, { | ||
| custom_map: _ga2.givenCustomMap, | ||
| send_page_view: false | ||
| }); | ||
| expect(_gtag["default"]).toHaveBeenNthCalledWith(2, "config", GA_MEASUREMENT_ID); | ||
| expect(_gtag["default"]).toHaveBeenNthCalledWith(3, "config", GA_MEASUREMENT_ID2); | ||
| expect(_gtag["default"]).toHaveBeenCalledTimes(3); | ||
@@ -266,31 +254,2 @@ }); | ||
| }); | ||
| it("event() with dimensions and metrics", function () { | ||
| // Given | ||
| var object = { | ||
| category: "category value", | ||
| action: "action value", | ||
| label: "label value", | ||
| nonInteraction: true, | ||
| id: "id value", | ||
| // id doesnt exist in event | ||
| value: 0, | ||
| dimension2: "dimension2 value", | ||
| dimension4: "dimension4 value", | ||
| metric2: "metric2 value" | ||
| }; | ||
| // When | ||
| _ga["default"].event(object); | ||
| // Then | ||
| expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "event", "Action Value", { | ||
| event_category: "Category Value", | ||
| event_label: "Label Value", | ||
| non_interaction: true, | ||
| dimension2: "dimension2 value", | ||
| dimension4: "dimension4 value", | ||
| metric2: "metric2 value", | ||
| value: 0 | ||
| }); | ||
| }); | ||
| }); | ||
@@ -303,4 +262,2 @@ describe("GA4.set()", function () { | ||
| referrer: "/signup", | ||
| dimension2: "dimension2 value", | ||
| dimension3: undefined, | ||
| allowAdFeatures: "allowAdFeatures value", | ||
@@ -318,3 +275,2 @@ allowAdPersonalizationSignals: "allowAdPersonalizationSignals value", | ||
| referrer: "/signup", | ||
| dimension2: "dimension2 value", | ||
| allow_google_signals: "allowAdFeatures value", | ||
@@ -324,54 +280,4 @@ allow_ad_personalization_signals: "allowAdPersonalizationSignals value", | ||
| }); | ||
| expect(Object.keys(_gtag["default"].mock.calls[0][1])).toContain("dimension3"); | ||
| }); | ||
| }); | ||
| describe("GA4.pageview()", function () { | ||
| it("pageview()", function () { | ||
| // Given | ||
| var path = "/location-pathname"; | ||
| var title = "title value"; | ||
| // When | ||
| _ga["default"].pageview(path, undefined, title); | ||
| // Then | ||
| expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "event", "page_view", { | ||
| page_title: title, | ||
| page_path: path | ||
| }); | ||
| }); | ||
| }); | ||
| describe("GA4.outboundLink()", function () { | ||
| function outboundLinkTest(givenTimeout) { | ||
| // Given | ||
| var label = "label value"; | ||
| _gtag["default"].mockImplementationOnce(function (command, event_name, event_params) { | ||
| setTimeout(function () { | ||
| return event_params.event_callback(); | ||
| }, givenTimeout); | ||
| }); | ||
| var callback = jest.fn(function () {}); | ||
| // When | ||
| _ga["default"].outboundLink({ | ||
| label: label | ||
| }, callback); | ||
| // Then | ||
| expect(_gtag["default"]).toHaveBeenNthCalledWith(1, "event", "Click", { | ||
| event_category: "Outbound", | ||
| event_label: "Label Value", | ||
| event_callback: expect.any(Function) | ||
| }); | ||
| expect(callback).toHaveBeenCalledTimes(0); | ||
| jest.runAllTimers(); | ||
| expect(callback).toHaveBeenCalledTimes(1); | ||
| } | ||
| it("outboundLink() before 250ms timeout", function () { | ||
| outboundLinkTest(100); | ||
| }); | ||
| it("outboundLink() after 250ms timeout", function () { | ||
| outboundLinkTest(300); | ||
| }); | ||
| }); | ||
| describe("Reference", function () { | ||
@@ -378,0 +284,0 @@ it("pageview", function () { |
@@ -22,3 +22,2 @@ "use strict"; | ||
| }; | ||
| var _default = gtag; | ||
| exports["default"] = _default; | ||
| var _default = exports["default"] = gtag; |
| "use strict"; | ||
| function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); } | ||
| function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); } | ||
| Object.defineProperty(exports, "__esModule", { | ||
@@ -11,5 +11,3 @@ value: true | ||
| function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; } | ||
| var ReactGAImplementation = _ga.GA4; | ||
| exports.ReactGAImplementation = ReactGAImplementation; | ||
| var _default = _ga["default"]; | ||
| exports["default"] = _default; | ||
| var ReactGAImplementation = exports.ReactGAImplementation = _ga.GA4; | ||
| var _default = exports["default"] = _ga["default"]; |
| { | ||
| "name": "react-ga4-forked", | ||
| "version": "1.5.4", | ||
| "version": "2.0.0", | ||
| "description": "React Google Analytics 4 - forked", | ||
@@ -10,3 +10,3 @@ "main": "dist/index.js", | ||
| "postbuild": "tsc src/index.js --declaration --allowJs --emitDeclarationOnly --outDir types", | ||
| "prepublish": "npm run build && npm test", | ||
| "prepublishOnly": "npm run build && npm test", | ||
| "test": "NODE_ENV=test jest" | ||
@@ -28,8 +28,8 @@ }, | ||
| "devDependencies": { | ||
| "@babel/cli": "^7.20.7", | ||
| "@babel/core": "^7.20.7", | ||
| "@babel/preset-env": "^7.20.2", | ||
| "babel-jest": "^29.3.1", | ||
| "jest": "^29.3.1", | ||
| "typescript": "^4.9.4" | ||
| "@babel/cli": "^7.23.0", | ||
| "@babel/core": "^7.23.0", | ||
| "@babel/preset-env": "^7.22.20", | ||
| "babel-jest": "^29.7.0", | ||
| "jest": "^29.7.0", | ||
| "typescript": "^5.2.2" | ||
| }, | ||
@@ -36,0 +36,0 @@ "jest": { |
@@ -7,3 +7,2 @@ # React Google Analytics 4 - forked | ||
| // Simply replace `react-ga` with `react-ga4-forked` | ||
| // import ReactGA from "react-ga"; | ||
| import ReactGA from "react-ga4-forked"; | ||
@@ -24,3 +23,2 @@ ``` | ||
| ReactGA.initialize("your GA measurement id"); | ||
| ReactGA.send("pageview"); | ||
| ``` | ||
@@ -46,3 +44,3 @@ | ||
| // Send pageview with a custom path | ||
| ReactGA.send({ hitType: "pageview", page: "/my-path" }); | ||
| ReactGA.send({ hitType: "pageview", page: "/my-path", title: "Custom Title" }); | ||
@@ -71,3 +69,2 @@ // Send a custom event | ||
| | options.gtagOptions | `object` Optional | | ||
| | options.legacyDimensionMetric | `boolean` Default true | | ||
| | options.scriptSrc | `string` Default `https://www.googletagmanager.com/gtag/js` | | ||
@@ -93,13 +90,11 @@ | options.scriptLoadingMode | `'async'\|'defer'\` Default `async` | | ||
| | Parameter | Notes | | ||
| | ---------------------------- | ----------------------------------- | | ||
| | options | `object` Required | | ||
| | options.action | `string` Required | | ||
| | options.category | `string` Required | | ||
| | options.label | `string` Optional | | ||
| | options.value | `number` Optional | | ||
| | options.nonInteraction | `boolean` Optional | | ||
| | options.transport | `'beacon'\|'xhr'\|'image'` Optional | | ||
| | options.dimension`{1...200}` | `any` Optional | | ||
| | options.metric`{1...200}` | `any` Optional | | ||
| | Parameter | Notes | | ||
| | ---------------------- | ----------------------------------- | | ||
| | options | `object` Required | | ||
| | options.action | `string` Required | | ||
| | options.category | `string` Required | | ||
| | options.label | `string` Optional | | ||
| | options.value | `number` Optional | | ||
| | options.nonInteraction | `boolean` Optional | | ||
| | options.transport | `'beacon'\|'xhr'\|'image'` Optional | | ||
@@ -116,10 +111,2 @@ #### ReactGA.send(fieldsObject) | ||
| #### ~~ReactGA.pageview(path, \_, title)~~ | ||
| Deprecated Use `.send("pageview")` instead | ||
| #### ~~ReactGA.outboundLink({ label }, hitCallback)~~ | ||
| Deprecated Use `enhanced measurement` feature in Google Analytics. | ||
| ### Extending | ||
@@ -126,0 +113,0 @@ |
146
src/ga4.js
@@ -81,3 +81,8 @@ import gtag from './gtag'; | ||
| _loadGA = (GA_MEASUREMENT_ID, nonce, scriptSrc, scriptLoadingMode) => { | ||
| _loadGA = ( | ||
| GA_MEASUREMENT_ID, | ||
| nonce, | ||
| scriptSrc = 'https://www.googletagmanager.com/gtag/js', | ||
| scriptLoadingMode = 'async', | ||
| ) => { | ||
| if (typeof window === 'undefined' || typeof document === 'undefined') { | ||
@@ -157,3 +162,2 @@ return; | ||
| * @param {'async'|'defer'} [options.scriptLoadingMode='async'] | ||
| * @param {boolean} [options.legacyDimensionMetric=true] | ||
| * @param {string} [options.nonce] | ||
@@ -178,3 +182,2 @@ * @param {boolean} [options.testMode=false] | ||
| gtagOptions, | ||
| legacyDimensionMetric = true, | ||
| nonce, | ||
@@ -199,13 +202,13 @@ testMode = false, | ||
| initConfigs.forEach((config) => { | ||
| const mergedGtagOptions = this._appendCustomMap( | ||
| { | ||
| // https://developers.google.com/analytics/devguides/collection/gtagjs/pages#disable_pageview_measurement | ||
| send_page_view: false, // default true, but React GA had false before. | ||
| ...this._toGtagOptions({ ...gaOptions, ...config.gaOptions }), | ||
| ...gtagOptions, | ||
| ...config.gtagOptions, | ||
| }, | ||
| legacyDimensionMetric, | ||
| ); | ||
| this._gtag('config', config.trackingId, mergedGtagOptions); | ||
| const mergedGtagOptions = { | ||
| // https://developers.google.com/analytics/devguides/collection/gtagjs/pages#disable_pageview_measurement | ||
| ...this._toGtagOptions({ ...gaOptions, ...config.gaOptions }), | ||
| ...gtagOptions, | ||
| ...config.gtagOptions, | ||
| }; | ||
| if (Object.keys(mergedGtagOptions).length) { | ||
| this._gtag('config', config.trackingId, mergedGtagOptions); | ||
| } else { | ||
| this._gtag('config', config.trackingId); | ||
| } | ||
| }); | ||
@@ -421,11 +424,4 @@ } | ||
| } else { | ||
| const { | ||
| action, | ||
| category, | ||
| label, | ||
| value, | ||
| nonInteraction, | ||
| transport, | ||
| ...rest | ||
| } = optionsOrName; | ||
| const { action, category, label, value, nonInteraction, transport } = | ||
| optionsOrName; | ||
| if (!category || !action) { | ||
@@ -479,14 +475,2 @@ console.warn('args.category AND args.action are required in event()'); | ||
| Object.keys(rest) | ||
| .filter((key) => key.substr(0, 'dimension'.length) === 'dimension') | ||
| .forEach((key) => { | ||
| fieldObject[key] = rest[key]; | ||
| }); | ||
| Object.keys(rest) | ||
| .filter((key) => key.substr(0, 'metric'.length) === 'metric') | ||
| .forEach((key) => { | ||
| fieldObject[key] = rest[key]; | ||
| }); | ||
| this._gaCommand('send', fieldObject); | ||
@@ -499,96 +483,4 @@ } | ||
| }; | ||
| _appendCustomMap(options, legacyDimensionMetric = true) { | ||
| if (!legacyDimensionMetric) { | ||
| return options; | ||
| } | ||
| if (!options.custom_map) { | ||
| options.custom_map = {}; | ||
| } | ||
| for (let i = 1; i <= 200; i++) { | ||
| if (!options.custom_map[`dimension${i}`]) { | ||
| options.custom_map[`dimension${i}`] = `dimension${i}`; | ||
| } | ||
| if (!options.custom_map[`metric${i}`]) { | ||
| options.custom_map[`metric${i}`] = `metric${i}`; | ||
| } | ||
| } | ||
| return options; | ||
| } | ||
| /** | ||
| * @since v1.0.2 | ||
| * @param {string} [path="location.href"] | ||
| * @param {string[]} [_] unsupported | ||
| * @param {string} [title="location.pathname"] | ||
| * @deprecated Use `.send("pageview")` instead | ||
| */ | ||
| pageview = (path, _, title) => { | ||
| const pathTrim = path?.trim(); | ||
| if (pathTrim === '') { | ||
| console.warn('path cannot be an empty string in .pageview()'); | ||
| return; | ||
| } | ||
| this._gaCommand('send', 'pageview', pathTrim, { title }); | ||
| }; | ||
| /** | ||
| * @since v1.0.6 | ||
| * @param {Object} options | ||
| * @param {string} options.label | ||
| * @param {function} hitCallback | ||
| * @deprecated Use `enhanced measurement` feature in Google Analytics. | ||
| */ | ||
| outboundLink({ label }, hitCallback) { | ||
| if (typeof hitCallback !== 'function') { | ||
| console.warn('hitCallback function is required'); | ||
| return; | ||
| } | ||
| if (!label) { | ||
| console.warn('args.label is required in outboundLink()'); | ||
| return; | ||
| } | ||
| // Required Fields | ||
| const fieldObject = { | ||
| hitType: 'event', | ||
| eventCategory: 'Outbound', | ||
| eventAction: 'Click', | ||
| eventLabel: format(label), | ||
| }; | ||
| let safetyCallbackCalled = false; | ||
| const safetyCallback = () => { | ||
| // This prevents a delayed response from GA | ||
| // causing hitCallback from being fired twice | ||
| safetyCallbackCalled = true; | ||
| hitCallback(); | ||
| }; | ||
| // Using a timeout to ensure the execution of critical application code | ||
| // in the case when the GA server might be down | ||
| // or an ad blocker prevents sending the data | ||
| // register safety net timeout: | ||
| const t = setTimeout(safetyCallback, 250); | ||
| const clearableCallbackForGA = () => { | ||
| clearTimeout(t); | ||
| if (!safetyCallbackCalled) { | ||
| hitCallback(); | ||
| } | ||
| }; | ||
| fieldObject.hitCallback = clearableCallbackForGA; | ||
| this._gaCommand('send', fieldObject); | ||
| } | ||
| } | ||
| export default new GA4(); |
| import gtag from "./gtag"; | ||
| import GA4 from "./ga4"; | ||
| import { givenCustomMap } from "./ga4.mock"; | ||
@@ -25,6 +24,3 @@ const newDate = new Date("2020-01-01"); | ||
| expect(gtag).toHaveBeenNthCalledWith(1, "js", newDate); | ||
| expect(gtag).toHaveBeenNthCalledWith(2, "config", GA_MEASUREMENT_ID, { | ||
| custom_map: givenCustomMap, | ||
| send_page_view: false, | ||
| }); | ||
| expect(gtag).toHaveBeenNthCalledWith(2, "config", GA_MEASUREMENT_ID); | ||
| expect(gtag).toHaveBeenCalledTimes(2); | ||
@@ -47,4 +43,2 @@ }); | ||
| expect(gtag).toHaveBeenNthCalledWith(2, "config", GA_MEASUREMENT_ID, { | ||
| custom_map: givenCustomMap, | ||
| send_page_view: false, | ||
| cookie_update: false, | ||
@@ -84,10 +78,4 @@ }); | ||
| expect(gtag).toHaveBeenNthCalledWith(1, "js", newDate); | ||
| expect(gtag).toHaveBeenNthCalledWith(2, "config", GA_MEASUREMENT_ID, { | ||
| custom_map: givenCustomMap, | ||
| send_page_view: false, | ||
| }); | ||
| expect(gtag).toHaveBeenNthCalledWith(3, "config", GA_MEASUREMENT_ID2, { | ||
| custom_map: givenCustomMap, | ||
| send_page_view: false, | ||
| }); | ||
| expect(gtag).toHaveBeenNthCalledWith(2, "config", GA_MEASUREMENT_ID); | ||
| expect(gtag).toHaveBeenNthCalledWith(3, "config", GA_MEASUREMENT_ID2); | ||
| expect(gtag).toHaveBeenCalledTimes(3); | ||
@@ -272,31 +260,2 @@ }); | ||
| }); | ||
| it("event() with dimensions and metrics", () => { | ||
| // Given | ||
| const object = { | ||
| category: "category value", | ||
| action: "action value", | ||
| label: "label value", | ||
| nonInteraction: true, | ||
| id: "id value", // id doesnt exist in event | ||
| value: 0, | ||
| dimension2: "dimension2 value", | ||
| dimension4: "dimension4 value", | ||
| metric2: "metric2 value", | ||
| }; | ||
| // When | ||
| GA4.event(object); | ||
| // Then | ||
| expect(gtag).toHaveBeenNthCalledWith(1, "event", "Action Value", { | ||
| event_category: "Category Value", | ||
| event_label: "Label Value", | ||
| non_interaction: true, | ||
| dimension2: "dimension2 value", | ||
| dimension4: "dimension4 value", | ||
| metric2: "metric2 value", | ||
| value: 0, | ||
| }); | ||
| }); | ||
| }); | ||
@@ -310,4 +269,2 @@ | ||
| referrer: "/signup", | ||
| dimension2: "dimension2 value", | ||
| dimension3: undefined, | ||
| allowAdFeatures: "allowAdFeatures value", | ||
@@ -325,3 +282,2 @@ allowAdPersonalizationSignals: "allowAdPersonalizationSignals value", | ||
| referrer: "/signup", | ||
| dimension2: "dimension2 value", | ||
| allow_google_signals: "allowAdFeatures value", | ||
@@ -331,58 +287,5 @@ allow_ad_personalization_signals: "allowAdPersonalizationSignals value", | ||
| }); | ||
| expect(Object.keys(gtag.mock.calls[0][1])).toContain("dimension3"); | ||
| }); | ||
| }); | ||
| describe("GA4.pageview()", () => { | ||
| it("pageview()", () => { | ||
| // Given | ||
| const path = "/location-pathname"; | ||
| const title = "title value"; | ||
| // When | ||
| GA4.pageview(path, undefined, title); | ||
| // Then | ||
| expect(gtag).toHaveBeenNthCalledWith(1, "event", "page_view", { | ||
| page_title: title, | ||
| page_path: path, | ||
| }); | ||
| }); | ||
| }); | ||
| describe("GA4.outboundLink()", () => { | ||
| function outboundLinkTest(givenTimeout) { | ||
| // Given | ||
| const label = "label value"; | ||
| gtag.mockImplementationOnce((command, event_name, event_params) => { | ||
| setTimeout(() => event_params.event_callback(), givenTimeout); | ||
| }); | ||
| const callback = jest.fn(() => {}); | ||
| // When | ||
| GA4.outboundLink({ label }, callback); | ||
| // Then | ||
| expect(gtag).toHaveBeenNthCalledWith(1, "event", "Click", { | ||
| event_category: "Outbound", | ||
| event_label: "Label Value", | ||
| event_callback: expect.any(Function), | ||
| }); | ||
| expect(callback).toHaveBeenCalledTimes(0); | ||
| jest.runAllTimers(); | ||
| expect(callback).toHaveBeenCalledTimes(1); | ||
| } | ||
| it("outboundLink() before 250ms timeout", () => { | ||
| outboundLinkTest(100); | ||
| }); | ||
| it("outboundLink() after 250ms timeout", () => { | ||
| outboundLinkTest(300); | ||
| }); | ||
| }); | ||
| describe("Reference", () => { | ||
@@ -389,0 +292,0 @@ it("pageview", () => { |
@@ -47,3 +47,3 @@ /** | ||
| gtag(...args: any[]): void; | ||
| _loadGA: (GA_MEASUREMENT_ID: any, nonce: any, scriptSrc: any, scriptLoadingMode: any) => void; | ||
| _loadGA: (GA_MEASUREMENT_ID: any, nonce: any, scriptSrc?: string, scriptLoadingMode?: string) => void; | ||
| _toGtagOptions: (gaOptions: any) => {}; | ||
@@ -56,3 +56,2 @@ /** | ||
| * @param {'async'|'defer'} [options.scriptLoadingMode='async'] | ||
| * @param {boolean} [options.legacyDimensionMetric=true] | ||
| * @param {string} [options.nonce] | ||
@@ -66,3 +65,2 @@ * @param {boolean} [options.testMode=false] | ||
| scriptLoadingMode?: 'async' | 'defer'; | ||
| legacyDimensionMetric?: boolean; | ||
| nonce?: string; | ||
@@ -90,21 +88,2 @@ testMode?: boolean; | ||
| send: (fieldObject: any) => void; | ||
| _appendCustomMap(options: any, legacyDimensionMetric?: boolean): any; | ||
| /** | ||
| * @since v1.0.2 | ||
| * @param {string} [path="location.href"] | ||
| * @param {string[]} [_] unsupported | ||
| * @param {string} [title="location.pathname"] | ||
| * @deprecated Use `.send("pageview")` instead | ||
| */ | ||
| pageview: (path?: string, _?: string[], title?: string) => void; | ||
| /** | ||
| * @since v1.0.6 | ||
| * @param {Object} options | ||
| * @param {string} options.label | ||
| * @param {function} hitCallback | ||
| * @deprecated Use `enhanced measurement` feature in Google Analytics. | ||
| */ | ||
| outboundLink({ label }: { | ||
| label: string; | ||
| }, hitCallback: Function): void; | ||
| } | ||
@@ -111,0 +90,0 @@ declare const _default: GA4; |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-22.25%
94358
- Number of package files
- decreased by-5.26%
18
- Lines of code
- decreased by-25.71%
2260
- Number of lines in readme file
- decreased by-9.29%
127
No dependency changes