@biggy/recsys/event/runners/vtex-runner.js

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
var tslib_1 = require("tslib");
var page_type_1 = require("../../commons/types/page-type");
var event_runner_1 = require("../../event/core/event-runner");
var confirmation_1 = require("../../event/types/page/confirmation");
var cart_1 = require("../types/page/cart");
var cart_add_1 = require("../types/session/cart-add");
var cart_remove_1 = require("../types/session/cart-remove");
/**
 * Specific runner used by VTEX stores.
 *
 * @class VTEXRunner
 * @implements {Runner}
 */
var VTEXRunner = /** @class */ (function (_super) {
    tslib_1.__extends(VTEXRunner, _super);
    function VTEXRunner() {
        return _super !== null && _super.apply(this, arguments) || this;
    }
    /**
     * Process DataLayer item.
     *
     * @protected
     * @param {*} item Current item.
     * @memberof VTEXRunner
     */
    VTEXRunner.prototype.processItem = function (item) {
        var info = this.getPageInfo(item);
        if (info) {
            if (info.pageType === page_type_1.PageType.Confirmation) {
                this.sendOrderEvent(info.item);
            }
            else if (info.pageType === page_type_1.PageType.Cart) {
                this.sendCartEvent(info.item);
            }
        }
    };
    /**
     * Get current page info based on DataLayer.
     *
     * @protected
     * @param {PageItem} item Current item.
     * @return {PageInfo} Current page info.
     * @memberof VTEXRunner
     */
    VTEXRunner.prototype.getPageInfo = function (item) {
        if (item && item.event) {
            if (item.event.toUpperCase() === "ORDERPLACED") {
                return {
                    item: item,
                    pageType: page_type_1.PageType.Confirmation,
                };
            }
            else if (item.event.toUpperCase() === "ADDTOCART" ||
                item.event.toUpperCase() === "REMOVEFROMCART" ||
                item.event.toUpperCase() === "CART") {
                return {
                    item: item,
                    pageType: page_type_1.PageType.Cart,
                };
            }
        }
        return undefined;
    };
    /**
     * Send order event, based on a order item.
     *
     * @protected
     * @param {*} orderItem Order item from the DataLayer.
     * @memberof VTEXRunner
     */
    VTEXRunner.prototype.sendOrderEvent = function (orderItem) {
        var orderId = orderItem.transactionId;
        var products = [];
        if (orderItem.transactionProducts) {
            for (var _i = 0, _a = orderItem.transactionProducts; _i < _a.length; _i++) {
                var transactionProduct = _a[_i];
                products.push({
                    product: transactionProduct.id,
                    quantity: transactionProduct.quantity,
                    price: transactionProduct.price,
                });
            }
        }
        var event = new confirmation_1.PageConfirmationEvent(orderId).withProducts(products);
        event.push();
    };
    /**
     * Send cart event, based on a cart item.
     *
     * @protected
     * @param {*} cartItem Cart item from the DataLayer.
     * @memberof VTEXRunner
     */
    VTEXRunner.prototype.sendCartEvent = function (cartItem) {
        // Create a generic cart event.
        var event = this.createCartEvent(cartItem.event);
        // Get layer products from specific event key.
        var layerProducts = cartItem.ecommerce[this.getCartProductsKeyFromEvent(cartItem.event)].products;
        if (layerProducts && layerProducts instanceof Array && layerProducts.length > 0) {
            for (var _i = 0, layerProducts_1 = layerProducts; _i < layerProducts_1.length; _i++) {
                var product = layerProducts_1[_i];
                event.withProduct(product.id, product.quantity);
            }
        }
        event.push();
    };
    /**
     * Get layer products from specific event key.
     *
     * VTEX has 3 specific keys when working with cart items on
     * the dataLayer.
     *
     * When products are added, they send the `ADDTOCART` event,
     * when they are removed `REMOVEFROMCART` and when they are
     * sending the full basket, they use the `CART` event.
     *
     * Whenever this events are sent, they come with an `ecommerce`
     * object, inside it, there is a key with the products array,
     * the key name follows the following rule:
     *
     *  - When event is `ADDTOCART`, the key is `add`.
     *  - When event is `REMOVEFROMCART`, the key is `remove`.
     *  - When event is `CART`, the key is `checkout`.
     *
     * @protected
     * @param {string} event Current event name.
     * @return {string} Event related key.
     * @memberof VTEXRunner
     */
    VTEXRunner.prototype.getCartProductsKeyFromEvent = function (event) {
        var keyFromEvent = {
            ADDTOCART: "add",
            REMOVEFROMCART: "remove",
            CART: "checkout",
        };
        return keyFromEvent[event.toUpperCase()];
    };
    /**
     * Create a generic cart event.
     *
     * @protected
     * @param {string} event Current event name.
     * @return {CartEvent} Relevant cart event.
     * @memberof VTEXRunner
     */
    VTEXRunner.prototype.createCartEvent = function (event) {
        switch (event.toUpperCase()) {
            case "ADDTOCART":
                return new cart_add_1.SessionCartAddEvent();
            case "REMOVEFROMCART":
                return new cart_remove_1.SessionCartRemoveEvent();
            default:
                return new cart_1.PageCartEvent();
        }
    };
    return VTEXRunner;
}(event_runner_1.EventRunner));
exports.VTEXRunner = VTEXRunner;
//# sourceMappingURL=vtex-runner.js.map