react-marketing-tools 0.0.7 → 0.1.0

package/README.md

@@ -112,22 +112,27 @@ COMING SOON: [React Marketing Tools Demo](https://)
             // create session cookie, useful for unauthenticated user tracking and other things
             document.cookie = `${appSessionCookieName}=${uuid()};max-age=${70};SameSite=Strict;Secure`
 
-            const eventNameInfo = {
-                actionPrefix: eventActionPrefixList.JOURNEY,
-                description: 'Welcome Landing',
-                globalAppEvent: analyticsGlobalEventActionList.UNAUTHENTICATED,
+            const sendAnalyticsEvent = async () => {
+                const eventNameInfo = {
+                    actionPrefix: eventActionPrefixList.JOURNEY,
+                    description: 'Welcome Landing',
+                    globalAppEvent: analyticsGlobalEventActionList.UNAUTHENTICATED,
+                }
+
+                await trackAnalyticsEvent({
+                    data: {},
+                    eventNameInfo,
+                    analyticsType: analyticsPlatform.DATALAYER_PUSH,
+                    dataLayerCheck: true,
+                })
             }
 
-            trackAnalyticsEvent({
-                data: {},
-                eventNameInfo,
-                analyticsType: analyticsPlatform.DATALAYER_PUSH,
-                dataLayerCheck: true,
-            })
+            sendAnalyticsEvent()
         })
 
-        const handleButtonClick = () => {
-            setCount((count) => count + 1)
+        const handleButtonClick = async () => {
+            const countActual = count + 1
+            setCount(countActual)
 
             const eventNameInfo = {
                 eventName: 'count button click',
@@ -136,9 +141,9 @@ COMING SOON: [React Marketing Tools Demo](https://)
                 previousGlobalAppEvent: analyticsGlobalEventActionList.UNAUTHENTICATED
             }
 
-            trackAnalyticsEvent({
+            await trackAnalyticsEvent({
                 data: {
-                    count,
+                    count: countActual,
                     firstName: 'bob',
                     lastName: 'yeah nah',
                     email: 'yeahnah@gmail.com',
@@ -150,6 +155,36 @@ COMING SOON: [React Marketing Tools Demo](https://)
                 }
             })
         }
+
+        /* Example: use GA4 directly 
+            const handleButtonClick = useCallback(async () => {
+                const countActual = count + 1
+
+                setCount(countActual)
+
+                const eventNameInfo = {
+                eventName: 'count button click',
+                actionPrefix: eventActionPrefixList.INTERACTION,
+                globalAppEvent: analyticsGlobalEventActionList.AUTHENTICATED,
+                previousGlobalAppEvent: analyticsGlobalEventActionList.UNAUTHENTICATED,
+                }
+
+                await trackAnalyticsEvent({
+                data: {
+                    count: countActual,
+                    firstName: 'bob',
+                    lastName: 'yeah nah',
+                    email: 'yeahnah@gmail.com',
+                },
+                eventNameInfo,
+                analyticsType: analyticsPlatform.GOOGLE,
+                userDataToHashKeyArray: ['email', 'firstName', 'lastName'],
+                consoleLogData: {
+                    showJourneyPropsPayload: true,
+                },
+                })
+            }, [count])
+        */
         ...
 
         return (
@@ -166,22 +201,27 @@ COMING SOON: [React Marketing Tools Demo](https://)
 
     const WelcomePage = () => {
         useEffect(function appLoadPageLandingWelcome() {
-            const eventNameInfo = {
-                actionPrefix: eventActionPrefixList.JOURNEY,
-                description: 'Welcome Landing',
-                globalAppEvent: analyticsGlobalEventActionList.UNAUTHENTICATED,
+            const sendAnalyticsEvent = async () => {
+                const eventNameInfo = {
+                    actionPrefix: eventActionPrefixList.JOURNEY,
+                    description: 'Welcome Landing',
+                    globalAppEvent: analyticsGlobalEventActionList.UNAUTHENTICATED,
+                }
+
+                trackAnalyticsEvent({
+                    data: {},
+                    eventNameInfo,
+                    analyticsType: analyticsPlatform.DATALAYER_PUSH,
+                    dataLayerCheck: true,
+                })
             }
 
-            trackAnalyticsEvent({
-                data: {},
-                eventNameInfo,
-                analyticsType: analyticsPlatform.DATALAYER_PUSH,
-                dataLayerCheck: true,
-            })
+            sendAnalyticsEvent()
         })
 
-        const handleButtonClick = () => {
-            setCount((count) => count + 1)
+        const handleButtonClick = async () => {
+            const countActual = count + 1
+            setCount(countActual)
 
             const eventNameInfo = {
                 eventName: 'count button click',
@@ -190,9 +230,9 @@ COMING SOON: [React Marketing Tools Demo](https://)
                 previousGlobalAppEvent: analyticsGlobalEventActionList.UNAUTHENTICATED
             }
 
-            trackAnalyticsEvent({
+            await trackAnalyticsEvent({
                 data: {
-                    count,
+                    count: countActual,
                     firstName: 'bob',
                     lastName: 'yeah nah',
                     email: 'yeahnah@gmail.com',

package/dist/react-marketing-tools.es.js

@@ -123,7 +123,7 @@ function ll() {
         }
       }
     }
-    var S = $, re = A, Le = m, he = g, $e = d, be = M, Ae = l, Me = k, q = N, z = o, me = i, ee = a, ie = P, se = !1;
+    var S = $, re = A, Le = m, he = g, $e = d, be = M, Ae = l, Me = k, q = N, z = o, ne = i, ee = a, ie = P, se = !1;
     function Pe(c) {
       return se || (se = !0, console.warn("The ReactIs.isAsyncMode() alias has been deprecated, and will be removed in React 17+. Update your code to use ReactIs.isConcurrentMode() instead. It has the exact same API.")), n(c) || U(c) === $;
     }
@@ -163,7 +163,7 @@ function ll() {
     function Z(c) {
       return U(c) === P;
     }
-    R.AsyncMode = S, R.ConcurrentMode = re, R.ContextConsumer = Le, R.ContextProvider = he, R.Element = $e, R.ForwardRef = be, R.Fragment = Ae, R.Lazy = Me, R.Memo = q, R.Portal = z, R.Profiler = me, R.StrictMode = ee, R.Suspense = ie, R.isAsyncMode = Pe, R.isConcurrentMode = n, R.isContextConsumer = u, R.isContextProvider = L, R.isElement = _, R.isForwardRef = T, R.isFragment = O, R.isLazy = p, R.isMemo = G, R.isPortal = b, R.isProfiler = I, R.isStrictMode = E, R.isSuspense = Z, R.isValidElementType = H, R.typeOf = U;
+    R.AsyncMode = S, R.ConcurrentMode = re, R.ContextConsumer = Le, R.ContextProvider = he, R.Element = $e, R.ForwardRef = be, R.Fragment = Ae, R.Lazy = Me, R.Memo = q, R.Portal = z, R.Profiler = ne, R.StrictMode = ee, R.Suspense = ie, R.isAsyncMode = Pe, R.isConcurrentMode = n, R.isContextConsumer = u, R.isContextProvider = L, R.isElement = _, R.isForwardRef = T, R.isFragment = O, R.isLazy = p, R.isMemo = G, R.isPortal = b, R.isProfiler = I, R.isStrictMode = E, R.isSuspense = Z, R.isValidElementType = H, R.typeOf = U;
   }()), R;
 }
 var Uo;
@@ -568,12 +568,12 @@ Valid keys: ` + JSON.stringify(Object.keys(n), null, "  ")
           return !1;
       }
     }
-    function me(n, u) {
+    function ne(n, u) {
       return n === "symbol" ? !0 : u ? u["@@toStringTag"] === "Symbol" || typeof Symbol == "function" && u instanceof Symbol : !1;
     }
     function ee(n) {
       var u = typeof n;
-      return Array.isArray(n) ? "array" : n instanceof RegExp ? "object" : me(u, n) ? "symbol" : u;
+      return Array.isArray(n) ? "array" : n instanceof RegExp ? "object" : ne(u, n) ? "symbol" : u;
     }
     function ie(n) {
       if (typeof n > "u" || n === null)
@@ -661,7 +661,7 @@ if (process.env.NODE_ENV !== "production") {
   j.exports = il()(ml.isElement, nl);
 } else
   j.exports = tl()();
-const xe = (e, d = "") => {
+const te = (e, d = "") => {
   if (!e)
     throw new Error(d != null ? d : "Is true assertion failed");
 }, Se = {
@@ -708,7 +708,7 @@ const o_ = (e) => {
     withDeviceInfo: m = !1,
     withServerLocationInfo: $ = !1
   } = { ...e };
-  xe(d, "An appName must be provided in the config."), oe = {
+  te(d, "An appName must be provided in the config."), oe = {
     TOKENS: g,
     appName: d,
     appSessionCookieName: o,
@@ -724,12 +724,12 @@ const o_ = (e) => {
       ...a
     }
   };
-}, ge = (e, d = "") => d ? e.hasOwnProperty(d) : Object.keys(e).length > 0, hr = (e, d) => d ? e.replace(/[\s]/g, d) : e.replace(/[\s]+/g, ""), cl = async (e) => {
+}, xe = (e, d = "") => d ? e.hasOwnProperty(d) : Object.keys(e).length > 0, hr = (e, d) => d ? e.replace(/[\s]/g, d) : e.replace(/[\s]+/g, ""), cl = async (e) => {
   const d = new TextEncoder().encode(e), o = await crypto.subtle.digest("SHA-256", d);
   return Array.from(new Uint8Array(o)).map((i) => i.toString(16).padStart(2, "0")).join("");
 }, Sl = async (e) => {
   const { TOKENS: d } = { ...oe };
-  if (xe(
+  if (te(
     e ? d == null ? void 0 : d.IP_INFO_TOKEN : !0,
     "if you want serverLocationInfo your config must have the TOKEN.IP_INFO_TOKEN AND withServerLocationInfo must be true."
   ), e && (d == null ? void 0 : d.IP_INFO_TOKEN)) {
@@ -750,18 +750,18 @@ const o_ = (e) => {
 }, ul = (e) => fetch(`https://ipinfo.io/110.174.218.10?token=${e}`).then(
   (d) => d.json()
 );
-var mo = {}, Fe = {}, te = {}, no = {};
+var mo = {}, Fe = {}, me = {}, no = {};
 Object.defineProperty(no, "__esModule", { value: !0 });
 no.trim = (e, d) => e.replace(new RegExp("^[" + d + "]+|[" + d + "]+$", "g"), "");
-Object.defineProperty(te, "__esModule", { value: !0 });
+Object.defineProperty(me, "__esModule", { value: !0 });
 const $l = no;
-te.formatVersion = (e, d) => {
+me.formatVersion = (e, d) => {
   if (e === void 0)
     return "";
   const o = $l.trim(e, ". ").replace(new RegExp("_", "g"), "."), l = o.split(".");
   return /^\d+$/.test(l.join("")) ? d !== 0 && Number.isInteger(parseFloat(o)) ? parseInt(o, 10).toFixed(1) : l.length > 1 && d !== null ? l.slice(0, d + 1).join(".") : o : o;
 };
-te.parseBrowserEngineVersion = (e, d) => {
+me.parseBrowserEngineVersion = (e, d) => {
   if (!d)
     return "";
   if (d === "Gecko") {
@@ -3803,7 +3803,7 @@ var fe = h && h.__importDefault || function(e) {
   return e && e.__esModule ? e : { default: e };
 };
 Object.defineProperty(Fe, "__esModule", { value: !0 });
-const Xe = te, zo = Y, An = Q, Mn = fe(Pl), Pn = fe(vl), vn = fe(un), Tn = fe($n);
+const Xe = me, zo = Y, An = Q, Mn = fe(Pl), Pn = fe(vl), vn = fe(un), Tn = fe($n);
 class Re {
   constructor(d) {
     this.options = {
@@ -4480,7 +4480,7 @@ var Gn = h && h.__importDefault || function(e) {
   return e && e.__esModule ? e : { default: e };
 };
 Object.defineProperty(xo, "__esModule", { value: !0 });
-const _n = Gn(pn), Ln = te, jo = Y, hn = Q;
+const _n = Gn(pn), Ln = me, jo = Y, hn = Q;
 class bn {
   constructor(d) {
     this.options = {
@@ -4671,7 +4671,7 @@ var Bn = h && h.__importDefault || function(e) {
   return e && e.__esModule ? e : { default: e };
 };
 Object.defineProperty(so, "__esModule", { value: !0 });
-const Cn = Bn(En), Nn = te, qo = Y, On = Q;
+const Cn = Bn(En), Nn = me, qo = Y, On = Q;
 class yn {
   constructor(d) {
     this.options = {
@@ -4871,7 +4871,7 @@ var wn = h && h.__importDefault || function(e) {
   return e && e.__esModule ? e : { default: e };
 };
 Object.defineProperty(co, "__esModule", { value: !0 });
-const Xn = wn(In), Dn = te, er = Y, Rn = Q;
+const Xn = wn(In), Dn = me, er = Y, Rn = Q;
 class Fn {
   constructor(d) {
     this.options = {
@@ -5027,7 +5027,7 @@ var Vn = h && h.__importDefault || function(e) {
   return e && e.__esModule ? e : { default: e };
 };
 Object.defineProperty(So, "__esModule", { value: !0 });
-const Hn = Vn(fn), Un = te, or = Y, kn = Q;
+const Hn = Vn(fn), Un = me, or = Y, kn = Q;
 class Kn {
   constructor(d) {
     this.options = {
@@ -5127,7 +5127,7 @@ var Qn = h && h.__importDefault || function(e) {
   return e && e.__esModule ? e : { default: e };
 };
 Object.defineProperty(uo, "__esModule", { value: !0 });
-const Zn = Qn(Wn), Yn = te, rr = Y, Jn = Q;
+const Zn = Qn(Wn), Yn = me, rr = Y, Jn = Q;
 class zn {
   constructor(d) {
     this.options = {
@@ -44477,7 +44477,7 @@ var br = h && h.__importDefault || function(e) {
   return e && e.__esModule ? e : { default: e };
 };
 Object.defineProperty(_o, "__esModule", { value: !0 });
-const dG = br(eG), aG = te, $r = Y, Ge = Q, Er = br(lG), iG = ["AmigaOS", "IBM", "GNU/Linux", "Mac", "Unix", "Windows", "BeOS", "Chrome OS"], tG = Er.default.operatingSystem, mG = Er.default.osFamilies;
+const dG = br(eG), aG = me, $r = Y, Ge = Q, Er = br(lG), iG = ["AmigaOS", "IBM", "GNU/Linux", "Mac", "Unix", "Windows", "BeOS", "Chrome OS"], tG = Er.default.operatingSystem, mG = Er.default.osFamilies;
 class Ne {
   constructor(d) {
     this.options = {
@@ -47729,8 +47729,8 @@ class fG {
 var VG = fG;
 const HG = async (e, d) => {
   const o = [...d], l = {};
-  xe(
-    ge(e),
+  te(
+    xe(e),
     `helpers.js ~ line 25 ~ hashUserData ~ Please check your user data, it looks like it is empty! ${e}`
   );
   for (let a in e)
@@ -47741,13 +47741,15 @@ const HG = async (e, d) => {
   return l;
 }, ro = (e, d) => {
   const o = {};
-  return ge(e) && d.length > 0 && d.forEach((l) => {
-    e[l] ? o[l] = `${e[l]}` : console.error(
-      `analyticsEventService -> buildNewUserData: line 94 - The key:${l} does not exist on the data object`
+  return xe(e) && (d == null ? void 0 : d.length) > 0 && d.forEach((l) => {
+    var a;
+    e.hasOwnProperty(l) ? o[l] = `${(a = e[l]) != null ? a : ""}` : console.info(
+      `1. user data was not included in payload, 2. the key -> ${l} does not exist on the user data object or was not included in the "includeUserKeys" in your config.`,
+      e
     );
   }), o;
 }, UG = (e) => {
-  if (!ge(e, "actionPrefix") && !ge(e, "globalAppEvent"))
+  if (!xe(e, "actionPrefix") && !xe(e, "globalAppEvent"))
     throw new Error(
       "actionPrefix AND globalAppEvent must be included in the eventNameInfo object passed to buildAnalyticsEventName function"
     );
@@ -47772,7 +47774,7 @@ const HG = async (e, d) => {
 }, kG = (e) => !!window.dataLayer.find((o) => o.event === e), KG = (e) => new VG().parse(e), Cr = (e, d = "") => {
   const { analyticsGlobalEventActionList: o } = oe;
   let l = "";
-  xe(
+  te(
     Object.values(o).includes(e),
     "getEventSequence(), globalAppEvent is not in the analyticsGlobalEventActionList!"
   );
@@ -47810,8 +47812,8 @@ const HG = async (e, d) => {
 }, ZG = async (e) => {
   var B, N;
   const { consoleLogData: d, data: o, eventName: l, globalAppEvent: a, userDetails: i } = e, { appSessionCookieName: g, TOKENS: m } = { ...oe };
-  xe(
-    m && !ge(m),
+  te(
+    m && xe(m),
     "TOKENS in config must contain GA4_PUBLIC_API_SECRET and GA4_PUBLIC_MEASUREMENT_ID key: value if you want to use ga4GoogleAnalyticsEventTracking"
   );
   const { GA4_PUBLIC_API_SECRET: $, GA4_PUBLIC_MEASUREMENT_ID: A } = m, M = await Br(o, a), P = {
@@ -47857,9 +47859,9 @@ const HG = async (e, d) => {
     globalVars: {
       app: m,
       ...P ? {
-        deviceCategory: (k = P.device) == null ? void 0 : k.type,
-        deviceOS: `${(w = P.os) == null ? void 0 : w.name}_${(V = P.os) == null ? void 0 : V.version}`,
-        deviceBrowser: (x = P.client) == null ? void 0 : x.name
+        device_category: (k = P.device) == null ? void 0 : k.type,
+        device_os: `${(w = P.os) == null ? void 0 : w.name}_${(V = P.os) == null ? void 0 : V.version}`,
+        device_browser: (x = P.client) == null ? void 0 : x.name
       } : []
     },
     userProps: {
@@ -47888,11 +47890,11 @@ const HG = async (e, d) => {
     dataLayerCheck: i = !1,
     consoleLogData: g = null
   } = e, { includeUserKeys: m } = oe;
-  xe(
-    ge(Se, l),
+  te(
+    xe(Se, l),
     `"analyticsType" of ${l} cannot be found in the analyticsPlatform object to view available platforms use showMeBuildInAnalyticsPlatform()`
-  ), xe(
-    ge(o, "actionPrefix") && ge(o, "globalAppEvent"),
+  ), te(
+    xe(o, "actionPrefix") && xe(o, "globalAppEvent"),
     "actionPrefix AND globalAppEvent must be included in the eventNameInfo object passed to trackAnalyticsEvent function"
   );
   const $ = o != null && o.eventName ? `${o.actionPrefix}_${hr(
@@ -47910,7 +47912,10 @@ const HG = async (e, d) => {
     consoleLogData: g
   }), l === Se.GOOGLE) {
     let A = {};
-    ge(ro(d, m)) && (A = await HG(
+    te(
+      a,
+      'User data must be hashed before sending to GA4, any user data that is considered "Identifiable"'
+    ), xe(ro(d, m)) && (A = await HG(
       ro(d, m),
       a
     )), await ZG({
@@ -48048,13 +48053,13 @@ function qG() {
         }
       return null;
     }
-    var z = Object.assign, me = 0, ee, ie, se, Pe, n, u, L;
+    var z = Object.assign, ne = 0, ee, ie, se, Pe, n, u, L;
     function _() {
     }
     _.__reactDisabledLog = !0;
     function T() {
       {
-        if (me === 0) {
+        if (ne === 0) {
           ee = console.log, ie = console.info, se = console.warn, Pe = console.error, n = console.group, u = console.groupCollapsed, L = console.groupEnd;
           var r = {
             configurable: !0,
@@ -48072,12 +48077,12 @@ function qG() {
             groupEnd: r
           });
         }
-        me++;
+        ne++;
       }
     }
     function O() {
       {
-        if (me--, me === 0) {
+        if (ne--, ne === 0) {
           var r = {
             configurable: !0,
             enumerable: !0,
@@ -48107,7 +48112,7 @@ function qG() {
             })
           });
         }
-        me < 0 && F("disabledDepth fell below zero. This is a bug in React. Please file an issue.");
+        ne < 0 && F("disabledDepth fell below zero. This is a bug in React. Please file an issue.");
       }
     }
     var p = x.ReactCurrentDispatcher, G;
@@ -48155,29 +48160,29 @@ function qG() {
           }), typeof Reflect == "object" && Reflect.construct) {
             try {
               Reflect.construct(y, []);
-            } catch (ne) {
-              v = ne;
+            } catch (ge) {
+              v = ge;
             }
             Reflect.construct(r, [], y);
           } else {
             try {
               y.call();
-            } catch (ne) {
-              v = ne;
+            } catch (ge) {
+              v = ge;
             }
             r.call(y.prototype);
           }
         } else {
           try {
             throw Error();
-          } catch (ne) {
-            v = ne;
+          } catch (ge) {
+            v = ge;
           }
           r();
         }
-      } catch (ne) {
-        if (ne && v && typeof ne.stack == "string") {
-          for (var C = ne.stack.split(`
+      } catch (ge) {
+        if (ge && v && typeof ge.stack == "string") {
+          for (var C = ge.stack.split(`
 `), J = v.stack.split(`
 `), K = C.length - 1, W = J.length - 1; K >= 1 && W >= 0 && C[K] !== J[W]; )
             W--;
@@ -48584,10 +48589,10 @@ const r_ = ({
   });
 }, l_ = () => {
   const e = Gr(Or);
-  return xe(e, "useAppState must be used within the AppProvider"), e;
+  return te(e, "useAppState must be used within the AppProvider"), e;
 }, d_ = () => {
   const e = Gr(yr);
-  return xe(e, "useAppApi must be used within the AppProvider"), e;
+  return te(e, "useAppApi must be used within the AppProvider"), e;
 };
 export {
   yr as ContextApi,