import { PageType } from "../../commons/types/page-type"; import { EventRunner, PageItem, PageInfo } from "../../event/core/event-runner"; import { OrderProduct, PageConfirmationEvent } from "../../event/types/page/confirmation"; import { CartEvent } from "../types/base/cart-event"; import { PageCartEvent } from "../types/page/cart"; /** * Specific runner used by EnhancedEcommerce. * * @class EnhancedEcommerceRunner * @implements {Runner} */ export class EnhancedEcommerceRunner extends EventRunner { /** * Process DataLayer item. * * @protected * @param {*} item Current item. * @memberof EnhancedEcommerceRunner */ protected processItem(item: PageItem): void { const info = this.getPageInfo(item); if (info) { if (info.pageType === PageType.Confirmation) { this.sendOrderEvent(info.item); } else if (info.pageType === PageType.Cart) { this.sendCartEvent(info.item); } } } /** * Get current page info based on DataLayer. * * @private * @param {PageItem} item Current item. * @return {PageInfo} Current page info. * @memberof EnhancedEcommerceRunner */ private getPageInfo(item: PageItem): PageInfo { if (item) { if ( item.ecommerce && item.ecommerce.purchase && item.ecommerce.purchase.actionField && item.ecommerce.purchase.actionField.action && item.ecommerce.purchase.actionField.action.toUpperCase() === "PURCHASE" ) { return { item, pageType: PageType.Confirmation, }; } else if ( item.event && (item.event.toUpperCase() === "ADDTOCART" || item.event.toUpperCase() === "CART") ) { return { item, pageType: PageType.Cart, }; } } return undefined; } /** * Send order event, based on a order item. * * @private * @param {*} orderItem Order item from the DataLayer. * @memberof EnhancedEcommerceRunner */ private sendOrderEvent(orderItem: PageItem): void { const orderId = orderItem.ecommerce.purchase.actionField.id; const products: OrderProduct[] = []; if (orderItem.ecommerce.purchase.products) { for (const transactionProduct of orderItem.ecommerce.purchase.products) { products.push({ product: transactionProduct.id, quantity: transactionProduct.quantity, price: transactionProduct.price, }); } } const event = new PageConfirmationEvent(orderId).withProducts(products); event.push(); } /** * Send cart event, based on a cart item. * * @private * @param {*} cartItem Cart item from the DataLayer. * @memberof EnhancedEcommerceRunner */ private sendCartEvent(cartItem: PageItem): void { // Create a generic cart event. const event = this.createCartEvent(cartItem.event); // Get layer products from specific event key. const layerProducts = cartItem.ecommerce.add.products; if (layerProducts && layerProducts instanceof Array && layerProducts.length > 0) { for (const product of layerProducts) { const id = product.id || product.product.baseProduct; event.withProduct(id, product.quantity); } } event.push(); } /** * Create a generic cart event. * * @private * @param {string} _event Current event name. * @return {CartEvent} Relevant cart event. * @memberof EnhancedEcommerceRunner */ private createCartEvent(_event: string): CartEvent { return new PageCartEvent(); } }