Merge pull request #823 from MediaJel/jbjm-add-back-reverted-features

Author: pacholoamit

src/adapters/ecommerce.ts

@@ -74,6 +74,11 @@ export default async (tracker: SnowplowTracker): Promise<void> => {
         // description: "ecwid is just a test description"
         // events-tracked: [{ "value": "transaction", "label": "Transaction" }]
         break;
+      case "evenue":
+        import("../shared/environment-data-sources/evenue").then(({ default: load }): void => load(tracker));
+        // description: "evenue is just a test description"
+        // events-tracked: [{ "value": "transaction", "label": "Transaction" }]
+        break;
       case "foxy":
         import("../shared/environment-data-sources/foxy").then(({ default: load }): void => load());
         // description: "foxy is just a test description"

src/index.ts

@@ -6,6 +6,7 @@ import { getCustomTags } from "./shared/utils/get-custom-tags";
 import { datasourceLogger } from "./shared/utils/datasource-logger";
 import { getAppIdTags } from "./shared/utils/get-appId-tags";
 import { initializeSessionTracking } from "./shared/utils/session-tracking";
+import { createRetailId } from "./shared/utils/retail-id-parser";
 
 (async (): Promise<void> => {
   try {
@@ -22,16 +23,19 @@ import { initializeSessionTracking } from "./shared/utils/session-tracking";
         const matchingOverride = window.overrides.find(
           (override) => override.tag === context.appId || override.appId === context.appId,
         );
+        logger.debug(`Using default overrides for appId: ${context.appId}`);
         if (matchingOverride) {
           overrides = matchingOverride;
         }
       } else if (typeof window.overrides === "object" && window.overrides !== null) {
         // New format: window.overrides is an object with appId properties
         if (context.appId && window.overrides[context.appId]) {
           overrides = window.overrides[context.appId];
+          logger.debug(`Using New Array overrides for appId: ${context.appId}`);
         } else {
           // Backwards compatibility for single object override
           overrides = window.overrides;
+          logger.debug(`Using default single overrides for appId: ${context.appId}`);
         }
       }
     } else {
@@ -40,10 +44,16 @@ import { initializeSessionTracking } from "./shared/utils/session-tracking";
         ...(context["s3.pv"] ? {} : { "s3.pv": "00000" }),
         ...(context["s3.tr"] ? {} : { "s3.tr": "00000" }),
       };
+      logger.debug(`Using default fallback overrides for appId: ${context.appId}`);
     }
 
     const modifiedContext = { ...context, ...overrides };
 
+    if (modifiedContext.enable === "false") {
+      logger.debug("Tag has been disabled. Reach out to your pixel provider for more information.");
+      return;
+    }
+
     logger.debug("MJ Tag Context", modifiedContext);
     logger.debug("Integrations In Progress");
 
@@ -54,6 +64,8 @@ import { initializeSessionTracking } from "./shared/utils/session-tracking";
       initializeSessionTracking(modifiedContext);
     }
 
+    window.parseRetailId = createRetailId;
+
     await import("src/adapters").then(({ default: load }) => load(modifiedContext));
   } catch (err) {
     const clientError = `An error has occured, please contact your pixel provider: `;

src/shared/environment-data-sources/evenue.ts

@@ -0,0 +1,51 @@
+import observable from "../utils/create-events-observable";
+import { isTrackerLoaded } from "../sources/utils/is-tracker-loaded";
+import { datalayerSource } from "../sources/google-datalayer-source";
+import { TransactionCartItem } from "../types";
+import { multiAdapterHandler } from "../utils/adapter-handler";
+import { SnowplowTracker } from "../snowplow/types";
+
+const evenueDataSource = (snowplow: SnowplowTracker) => {
+  const handler = multiAdapterHandler(snowplow);
+
+  handler.add("DataLayer Source", () => {
+    isTrackerLoaded(() => {
+      datalayerSource((data) => {
+        if (data.event === "purchase") {
+          const purchase = data?.ecommerce?.items;
+
+          observable.notify({
+            transactionEvent: {
+              id: data.transaction_id,
+              total: parseFloat(data.value) || 0,
+              tax: 0,
+              shipping: parseFloat(data.shipping) || 0,
+              discount: 0,
+              couponCode: "N/A",
+              city: "N/A",
+              state: "N/A",
+              country: "USA",
+              currency: "USD",
+              items:
+                purchase?.map((item) => {
+                  return {
+                    orderId: data.transaction_id,
+                    sku: item.item_id.toString() || "N/A",
+                    name: item.item_name.toString() || "N/A",
+                    category: item.item_category.toString() || "N/A",
+                    unitPrice: parseFloat(item.price) || 0,
+                    quantity: parseInt(item.quantity) || 1,
+                    currency: "USD",
+                  } as TransactionCartItem;
+                }) || [],
+            },
+          });
+        }
+      });
+    });
+  });
+
+  handler.execute();
+};
+
+export default evenueDataSource;

src/shared/environment-data-sources/jane.ts

@@ -58,6 +58,7 @@ const janeDataSource = (snowplow: SnowplowTracker) => {
             deliveryAddress = {},
             salesTax,
             storeTax,
+            discountTotal,
           } = payload.properties;
 
           observable.notify({
@@ -70,6 +71,8 @@ const janeDataSource = (snowplow: SnowplowTracker) => {
               city: (deliveryAddress?.city || "N/A").toString(),
               state: (deliveryAddress?.state_code || "N/A").toString(),
               country: (deliveryAddress?.country_code || "N/A").toString(),
+              discount: parseFloat(discountTotal || 0),
+              couponCode: "N/A",
               currency: "USD",
               items: products.map((product) => {
                 const { product_id, name, category, unit_price, count } = product;

src/shared/environment-data-sources/magento.ts

@@ -34,6 +34,8 @@ const magentoDataSource = () => {
                     city: "N/A",
                     country: "USA",
                     currency: "USD",
+                    couponCode: ecommerce.coupon || "N/A",
+                    discount: parseFloat(ecommerce.discount) || 0,
                     state: "N/A",
                     items: ecommerce.items.map((item: any) => {
                       return {

src/shared/interface.ts

@@ -1,5 +1,5 @@
 import { TransactionEvent, CartEvent, SignupParams } from "./snowplow/types";
-import { QueryStringContext, RegisterThirdPartyTagsInput } from "./types";
+import { QueryStringContext, RegisterThirdPartyTagsInput, retailIdentifier } from "./types";
 
 export {};
 
@@ -27,5 +27,7 @@ declare global {
     gtmDataLayer: any;
     registerThirdPartyTags: (input: RegisterThirdPartyTagsInput) => void;
     overrides: QueryStringContext;
+    parseRetailId: (retail: retailIdentifier) => void;
+    navigation: any;
   }
 }

src/shared/types.ts

@@ -74,6 +74,21 @@ export type SignupParams = {
   advertiser: string;
 };
 
+export interface retailIdentifier {
+  id: {
+    /**
+     * The name of the retail identifier, used to create a URL parameter.
+     */
+    retailId: string;
+    /**
+     * An array of CSS selectors or element IDs to poll for the retail identifier.
+     * These elements should be present on the page to ensure the retail ID is applied correctly.
+     */
+    element: string[];
+    fn?: () => void;
+  }[];
+}
+
 export type SnowplowParams = {
   appId: string;
   mediajelAppId?: string;
@@ -152,6 +167,10 @@ export type DstillerySegmentParams = {
   "s3.tr": string;
 };
 
+export type enableTagParam = {
+  enable: "true" | "false";
+};
+
 export type SegmentParams = LiquidmSegmentParams & NexxenSegmentParams & DstillerySegmentParams;
 
 export type DatasourceTrackerParam = {
@@ -167,6 +186,7 @@ export type QueryStringParams = Partial<TransactionParams> &
   BingAdsPluginParams &
   SnowplowParams &
   SegmentParams &
+  enableTagParam &
   DatasourceTrackerParam & { sdkUrl: string };
 
 // Params available to the tag's query string

src/shared/utils/retail-id-parser.ts

@@ -0,0 +1,68 @@
+import { pollForElement } from "../sources/utils/poll-for-element";
+import { retailIdentifier } from "../types";
+/**
+ * Dynamically parses a retail ID on the site url by polling for specific elements present on the checkout page.
+ * @param {retailIdentifier} retail - The retail identifier object containing the elements to poll.
+ * Please use a specific element id on a page to ascertain that the page should have a retail ID.
+ * ! If not used correctly, we could append a retail ID to every page.
+ * @example
+ * const ecommerce = {
+ *   id: [
+ *     {
+ *       retailId: "California",
+ *       element: [".ca-element", "#california-element", "[data-state='CA-element']"],
+ *       fn: () => { console.log("Retail ID applied for California"); }
+ *     },
+ *     {
+ *       retailId: "New York",
+ *       element: [".ny-element", "#ny-element", "[data-state='NY-element']"],
+ *       fn: () => { console.log("Retail ID applied for New York"); }
+ *     },
+ *   ],
+ * };
+ * createRetailId(ecommerce);
+ */
+export const createRetailId = (retail: retailIdentifier) => {
+  const { id } = retail;
+
+  const parseRetailId = () => {
+    id.forEach((retail) => {
+      pollForElement(retail.element, () => {
+        if (!retail.element) return;
+        const baseUrl = window.location.href;
+        const url = new URL(baseUrl);
+        const urlId = retail.retailId.replace(/\s+/g, "").toLowerCase();
+        retail.element.forEach((elementSelector) => {
+          const element = document.querySelector(elementSelector);
+          if (element) {
+            console.log(`Element detected for retail ID "${retail.retailId}": ${elementSelector}`);
+          }
+        });
+
+        url.searchParams.set("retailId", urlId);
+        window.history.replaceState({}, "", url.toString());
+
+        if (retail.fn) {
+          retail.fn();
+        }
+      });
+    });
+  };
+
+  parseRetailId();
+
+  const checkUrlChange = () => {
+    window.navigation.addEventListener("navigate", () => {
+      let previousUrl = sessionStorage.getItem("previousUrl");
+      const currentUrl = window.location.href;
+      sessionStorage.setItem("currentUrl", currentUrl);
+
+      if (currentUrl !== previousUrl) {
+        sessionStorage.setItem("previousUrl", currentUrl);
+        parseRetailId();
+      }
+    });
+  };
+
+  setInterval(checkUrlChange, 1000);
+};