@uappi/public-sdk 1.0.0

package/modules/Tracking/events/views/viewItemList.ts

@@ -0,0 +1,65 @@
+import { getVariant } from '../../utils/cart';
+import { pushDatalayer } from '../../utils/pushDatalayer';
+
+import type {
+  Showcase,
+  UrlBrand,
+  UrlListing,
+  Search,
+} from '../../api/types';
+
+export function viewItemList(page: UrlBrand | UrlListing | Search): void;
+export function viewItemList(page: Array<Showcase>): void;
+
+export function viewItemList(
+  page: UrlBrand | UrlListing | Array<Showcase> | Search,
+) {
+  if (Array.isArray(page)) {
+    page.map(showcase => {
+      pushDatalayer({
+        event: 'view_item_list',
+        ecommerce: {
+          currency: 'BRL',
+          item_list_id: showcase.name,
+          item_list_name: showcase.name,
+          items: showcase.products.map(showcaseProduct => {
+            return {
+              coupon: '',
+              item_brand: showcaseProduct.brand?.name || '',
+              item_category: showcaseProduct.mainCategory?.name || '',
+              item_id: showcaseProduct.id,
+              item_name: showcaseProduct.name,
+              item_variant: getVariant(showcaseProduct),
+              price: showcaseProduct.price?.salePrice || 0,
+              quantity: 1,
+            };
+          }),
+        },
+      });
+    });
+    return;
+  }
+
+  pushDatalayer({
+    event: 'view_item_list',
+    ecommerce: {
+      currency: 'BRL',
+      item_list_id:
+        page.type === 'search' ? 'Search Results' : page.entity.name,
+      item_list_name:
+        page.type === 'search' ? 'Search Results' : page.entity.name,
+      items: page.content.registers.map(pageItem => {
+        return {
+          coupon: '',
+          item_brand: pageItem.brand?.name || '',
+          item_category: pageItem.mainCategory?.name || '',
+          item_id: pageItem.id,
+          item_name: pageItem.name,
+          item_variant: getVariant(pageItem),
+          price: pageItem.price?.salePrice || 0,
+          quantity: 1,
+        };
+      }),
+    },
+  });
+}

package/modules/Tracking/events/views/viewNotFound.ts

@@ -0,0 +1,5 @@
+import { pushDatalayer } from '../../utils/pushDatalayer';
+
+export function viewNotFound() {
+  pushDatalayer({ event: 'view_not_found' });
+}

package/modules/Tracking/events/views/viewOther.ts

@@ -0,0 +1,5 @@
+import { pushDatalayer } from '../../utils/pushDatalayer';
+
+export function viewOther() {
+  pushDatalayer({ event: 'view_other' });
+}

package/modules/Tracking/events/views/viewPayment.ts

@@ -0,0 +1,7 @@
+import { pushDatalayer } from '../../utils/pushDatalayer';
+
+export function viewPayment() {
+  pushDatalayer({
+    event: 'view_payment',
+  });
+}

package/modules/Tracking/events/views/viewPromotion.ts

@@ -0,0 +1,28 @@
+import { pushDatalayer } from '../../utils/pushDatalayer';
+
+import type { ViewPromotion } from '../../types';
+import type { Banners } from '../../api/types';
+
+export function viewPromotion<AdditionalParameters>(
+  bannerGroups: Array<Banners<AdditionalParameters>>,
+) {
+  bannerGroups.forEach(bannerGroup => {
+    pushDatalayer({
+      event: 'view_promotion',
+      ecommerce: {
+        items: [
+          ...bannerGroup.banners.map((banner, bannerIndex) => {
+            return {
+              promotion_id: banner.id,
+              promotion_name:
+                'Banners' as ViewPromotion['ecommerce']['items'][0]['promotion_name'],
+              creative_name: `${banner.scheduling?.startDate.slice(0, 10)}-${banner.name.replaceAll(' ', '-')}`,
+              creative_slot: bannerIndex + 1,
+              index: bannerIndex + 1,
+            };
+          }),
+        ],
+      },
+    });
+  });
+}

package/modules/Tracking/events/views/viewShipping.ts

@@ -0,0 +1,7 @@
+import { pushDatalayer } from '../../utils/pushDatalayer';
+
+export function viewShipping() {
+  pushDatalayer({
+    event: 'view_shipping',
+  });
+}

package/modules/Tracking/index.ts

@@ -0,0 +1,84 @@
+import { listBanners } from './endpoints/BannerComposable';
+import {
+  addProduct,
+  deleteProduct,
+  selectShipment,
+  shipmentQuote,
+  upsertProduct,
+  buy,
+  listDetail,
+} from './endpoints/CartComposable';
+import {
+  detail,
+  signinByDocument,
+  signinByEmail,
+  signup,
+  addNewsletter,
+} from './endpoints/CustomerComposable';
+import { listShipmentQuoteProduct } from './endpoints/ProductQuoteShipment';
+import { getSearch } from './endpoints/SearchComposable';
+import { listShowcase } from './endpoints/ShowcaseComposable';
+import { getUrl } from './endpoints/UrlComposable';
+import { addPaymentInfoAction as addPaymentInfo } from './events/actions/addPaymentInfo';
+import { beginCheckoutAction as beginCheckout } from './events/actions/beginCheckout';
+import { searchAction as search } from './events/actions/search';
+import { selectItemAction as selectItem } from './events/actions/selectItem';
+import { selectPromotionAction as selectPromotion } from './events/actions/selectPromotion';
+import { viewHome } from './events/views/viewHome';
+import { viewNotFound } from './events/views/viewNotFound';
+import { viewOther } from './events/views/viewOther';
+import { viewPayment } from './events/views/viewPayment';
+import { viewShipping } from './events/views/viewShipping';
+import publicApiTracking from './publicApiTracking';
+
+const view = {
+  viewHome,
+  viewShipping,
+  viewPayment,
+  viewOther,
+  viewNotFound,
+};
+
+const cart = {
+  listDetail,
+  addProduct,
+  deleteProduct,
+  selectShipment,
+  shipmentQuote,
+  upsertProduct,
+  beginCheckout,
+  addPaymentInfo,
+  buy,
+};
+
+const customer = {
+  detail,
+  signinByDocument,
+  signinByEmail,
+  signup,
+  addNewsletter,
+};
+
+const product = {
+  listShipmentQuoteProduct,
+  getUrl,
+  search,
+  selectItem,
+  getSearch,
+};
+
+const customization = {
+  listShowcase,
+  listBanners,
+  selectPromotion,
+};
+
+export { publicApiTracking, cart, customer, product, view, customization };
+export default {
+  publicApiTracking,
+  view,
+  cart,
+  customer,
+  product,
+  customization,
+};

package/modules/Tracking/publicApiTracking.ts

@@ -0,0 +1,36 @@
+import usePublicApi from '../Api';
+
+declare global {
+  interface Window {
+    // eslint-disable-next-line
+    dataLayer: Array<Record<string, any>>;
+  }
+}
+
+export default {
+  async install() {
+    if (import.meta.env.PROD) return;
+
+    await usePublicApi.customization
+      .listTemplateSettings(import.meta.env.VITE_BASE)
+      .then(data => {
+        const gtmApp = data.apps.find(app => app.code === 'google-tag-manager');
+        if (!gtmApp) return;
+
+        this.createGtm(gtmApp.settings['google-tag-manager-id']);
+      });
+  },
+
+  createGtm(tagId: string) {
+    const gtmTag = document.createElement('script');
+    gtmTag.innerHTML = `
+      (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+      new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+      j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+      'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+      })(window,document,'script','dataLayer','${tagId}');
+    `;
+
+    document.head.appendChild(gtmTag);
+  },
+};

package/modules/Tracking/types/actions/add-payment-info.interfaces.ts

@@ -0,0 +1,12 @@
+import type { Item } from '..';
+
+export interface AddPaymentInfo {
+  event: 'add_payment_info';
+  ecommerce: {
+    currency: 'BRL';
+    value: number;
+    coupon: string;
+    payment_type: string;
+    items: Array<Item>;
+  };
+}

package/modules/Tracking/types/actions/add-shipping-info.interfaces.ts

@@ -0,0 +1,11 @@
+import type { Item } from '..';
+
+export interface AddShippingInfo {
+  event: 'add_shipping_info';
+  ecommerce: {
+    currency: 'BRL';
+    value: number;
+    coupon: string;
+    items: Array<Item>;
+  };
+}

package/modules/Tracking/types/actions/add-to-cart.interfaces.ts

@@ -0,0 +1,10 @@
+import type { Item } from '..';
+
+export interface AddToCart {
+  event: 'add_to_cart';
+  ecommerce: {
+    currency: 'BRL';
+    value: number;
+    items: Array<Item>;
+  };
+}

package/modules/Tracking/types/actions/begin-checkout.interfaces.ts

@@ -0,0 +1,12 @@
+import type { Item } from '..';
+
+export interface BeginCheckout {
+  event: 'begin_checkout';
+  ecommerce: {
+    shipping_tier: 'Ground';
+    currency: 'BRL';
+    value: number;
+    coupon: string;
+    items: Array<Item>;
+  };
+}

package/modules/Tracking/types/actions/customer-profile.interfaces.ts

@@ -0,0 +1,19 @@
+import type {
+  CustomerAddressResponse,
+  CustomerGender,
+  CustomerResponse,
+} from '../../api/types';
+
+export interface CustomerProfile {
+  event: 'customer_profile';
+  customer: {
+    id: number;
+    email: string;
+    name: string;
+    gender: CustomerGender;
+    birthdate: string;
+    address: null | Array<CustomerAddressResponse>;
+    flags: CustomerResponse['flags'];
+    loginStatus: boolean;
+  };
+}

package/modules/Tracking/types/actions/file-download.interfaces.ts

@@ -0,0 +1,4 @@
+export interface FileDownload {
+  event: 'file_download';
+  item_id: number;
+}

package/modules/Tracking/types/actions/generate-lead.interfaces.ts

@@ -0,0 +1,12 @@
+export interface GenerateLead {
+  event: 'generate_lead';
+  name: string;
+  email: string;
+  phone: string;
+}
+
+export interface CustomerLead {
+  name: string;
+  email: string;
+  phone: string;
+}

package/modules/Tracking/types/actions/login.interfaces.ts

@@ -0,0 +1,4 @@
+export interface Login {
+  event: 'login';
+  method: 'Google' | 'Facebook' | 'Internal';
+}

package/modules/Tracking/types/actions/purchase.interfaces.ts

@@ -0,0 +1,18 @@
+import type { Item } from '../item.interfaces';
+
+export interface Purchase {
+  event: 'purchase';
+  ecommerce: {
+    transaction_id: string;
+    affiliation: string;
+    value: number;
+    tax: number;
+    shipping: number;
+    currency: 'BRL';
+    coupon: string;
+    payment_type: string;
+    payment_status: string;
+    shipping_tier: string;
+    items: Array<Item>;
+  };
+}

package/modules/Tracking/types/actions/remove-from-cart.interfaces.ts

@@ -0,0 +1,10 @@
+import type { Item } from '..';
+
+export interface RemoveFromCart {
+  event: 'remove_from_cart';
+  ecommerce: {
+    currency: 'BRL';
+    value: number;
+    items: Array<Item>;
+  };
+}

package/modules/Tracking/types/actions/search.interfaces.ts

@@ -0,0 +1,4 @@
+export interface Search {
+  event: 'search';
+  search_term: string;
+}

package/modules/Tracking/types/actions/select-item.interfaces.ts

@@ -0,0 +1,16 @@
+import type { Item } from '../item.interfaces';
+
+interface SelectedItem extends Item {
+  item_list_id: string;
+  item_list_name: string;
+}
+
+export interface SelectItem {
+  event: 'select_item';
+  ecommerce: {
+    item_list_id: string;
+    item_list_name: string;
+    currency: 'BRL';
+    items: Array<SelectedItem>;
+  };
+}

package/modules/Tracking/types/actions/select-promotion.interfaces.ts

@@ -0,0 +1,8 @@
+import type { BannerItem } from '..';
+
+export interface SelectPromotion {
+  event: 'select_promotion';
+  ecommerce: {
+    items: Array<BannerItem>;
+  };
+}

package/modules/Tracking/types/actions/share.interfaces.ts

@@ -0,0 +1,4 @@
+export interface Share {
+  event: 'share';
+  item_id: number;
+}

package/modules/Tracking/types/actions/shipping-calculation.interfaces.ts

@@ -0,0 +1,3 @@
+export interface ShippingCalculation {
+  event: 'item_view_shipping_calculation';
+}

package/modules/Tracking/types/actions/signup.interfaces.ts

@@ -0,0 +1,4 @@
+export interface Signup {
+  event: 'sign_up';
+  method: 'Google' | 'Facebook' | 'Internal';
+}

package/modules/Tracking/types/event.types.ts

@@ -0,0 +1,54 @@
+import type {
+  AddToCart,
+  CustomerProfile,
+  Login,
+  RemoveFromCart,
+  Signup,
+  BeginCheckout,
+  AddShippingInfo,
+  AddPaymentInfo,
+  ShippingCalculation,
+  ViewPayment,
+  ViewShipping,
+  Purchase,
+  ViewCart,
+  ViewHome,
+  ViewItem,
+  ViewItemList,
+  ViewOther,
+  ViewNotFound,
+  Search,
+  GenerateLead,
+  ViewPromotion,
+  SelectPromotion,
+  FileDownload,
+  Share,
+  SelectItem,
+} from '.';
+
+export type Event =
+  | AddToCart
+  | RemoveFromCart
+  | ViewCart
+  | ViewPayment
+  | ViewShipping
+  | BeginCheckout
+  | CustomerProfile
+  | Login
+  | Signup
+  | AddShippingInfo
+  | AddPaymentInfo
+  | ShippingCalculation
+  | Purchase
+  | ViewHome
+  | ViewItem
+  | ViewItemList
+  | ViewOther
+  | ViewNotFound
+  | Search
+  | GenerateLead
+  | ViewPromotion
+  | SelectPromotion
+  | FileDownload
+  | Share
+  | SelectItem;

package/modules/Tracking/types/index.ts

@@ -0,0 +1,37 @@
+export type { Event } from './event.types';
+export type {
+  Item,
+  UpsertTrackingCartItem,
+  UpsertTrackingCartRequest,
+  BannerItem,
+} from './item.interfaces';
+
+export type { Purchase } from './actions/purchase.interfaces';
+export type { AddToCart } from './actions/add-to-cart.interfaces';
+export type { RemoveFromCart } from './actions/remove-from-cart.interfaces';
+export type { Login } from './actions/login.interfaces';
+export type { Signup } from './actions/signup.interfaces';
+export type { CustomerProfile } from './actions/customer-profile.interfaces';
+export type { BeginCheckout } from './actions/begin-checkout.interfaces';
+export type { AddShippingInfo } from './actions/add-shipping-info.interfaces';
+export type { AddPaymentInfo } from './actions/add-payment-info.interfaces';
+export type { ShippingCalculation } from './actions/shipping-calculation.interfaces';
+export type { Search } from './actions/search.interfaces';
+export type {
+  CustomerLead,
+  GenerateLead,
+} from './actions/generate-lead.interfaces';
+export type { FileDownload } from './actions/file-download.interfaces';
+export type { Share } from './actions/share.interfaces';
+export type { SelectPromotion } from './actions/select-promotion.interfaces';
+export type { SelectItem } from './actions/select-item.interfaces';
+
+export type { ViewCart } from './views/view-cart.interfaces';
+export type { ViewPayment } from './views/view-payment.interfaces';
+export type { ViewShipping } from './views/view-shipping.interfaces';
+export type { ViewHome } from './views/view-home.interfaces';
+export type { ViewItemList } from './views/view-item-list.interfaces';
+export type { ViewItem } from './views/view-item.interfaces';
+export type { ViewOther } from './views/view-other.interfaces';
+export type { ViewNotFound } from './views/view-not-found.interfaces';
+export type { ViewPromotion } from './views/view-promotion.interfaces';

package/modules/Tracking/types/item.interfaces.ts

@@ -0,0 +1,30 @@
+import type { UpsertCartItem } from '../../Api/types';
+
+export interface Item {
+  coupon?: string;
+  item_id: number;
+  item_name: string;
+  price: number;
+  quantity?: number;
+  item_brand: string;
+  item_category: string;
+  item_variant: string;
+  index?: number;
+}
+
+export interface UpsertTrackingCartItem
+  extends Omit<UpsertCartItem, 'quantity'> {
+  oldQuantity?: number;
+  quantity?: number;
+}
+export interface UpsertTrackingCartRequest {
+  items: Array<UpsertTrackingCartItem>;
+}
+
+export interface BannerItem {
+  promotion_id: number;
+  promotion_name: 'Banners';
+  creative_name: string;
+  creative_slot: number;
+  index: number;
+}

package/modules/Tracking/types/views/view-cart.interfaces.ts

@@ -0,0 +1,11 @@
+import type { Item } from '..';
+
+export interface ViewCart {
+  event: 'view_cart';
+  ecommerce: {
+    currency: 'BRL';
+    value: number;
+    coupon: string;
+    items: Array<Item>;
+  };
+}

package/modules/Tracking/types/views/view-home.interfaces.ts

@@ -0,0 +1,3 @@
+export interface ViewHome {
+  event: 'view_home';
+}

package/modules/Tracking/types/views/view-item-list.interfaces.ts

@@ -0,0 +1,11 @@
+import type { Item } from '../item.interfaces';
+
+export interface ViewItemList {
+  event: 'view_item_list';
+  ecommerce: {
+    item_list_id: string;
+    item_list_name: string;
+    currency: 'BRL';
+    items: Array<Item>;
+  };
+}

package/modules/Tracking/types/views/view-item.interfaces.ts

@@ -0,0 +1,15 @@
+import type { Item } from '..';
+
+export interface ViewItem {
+  event: 'view_item';
+  google_tag_params: {
+    ecomm_prodid: number;
+    ecomm_pagetype: 'product';
+    ecomm_totalvalue: number;
+    ecomm_category: string;
+  };
+  ecommerce: {
+    currency: 'BRL';
+    items: Array<Item>;
+  };
+}

package/modules/Tracking/types/views/view-not-found.interfaces.ts

@@ -0,0 +1,3 @@
+export interface ViewNotFound {
+  event: 'view_not_found';
+}

package/modules/Tracking/types/views/view-other.interfaces.ts

@@ -0,0 +1,3 @@
+export interface ViewOther {
+  event: 'view_other';
+}

package/modules/Tracking/types/views/view-payment.interfaces.ts

@@ -0,0 +1,3 @@
+export interface ViewPayment {
+  event: 'view_payment';
+}

package/modules/Tracking/types/views/view-promotion.interfaces.ts

@@ -0,0 +1,8 @@
+import type { BannerItem } from '..';
+
+export interface ViewPromotion {
+  event: 'view_promotion';
+  ecommerce: {
+    items: Array<BannerItem>;
+  };
+}

package/modules/Tracking/types/views/view-shipping.interfaces.ts

@@ -0,0 +1,3 @@
+export interface ViewShipping {
+  event: 'view_shipping';
+}