@azzas/azzas-tracker-web 2.0.0-preview.1 → 2.0.0-preview.11

package/dist/mod.d.cts

@@ -952,31 +952,481 @@ type ProductType_Minicart = {
     offerings: OfferingItem[];
 };
 
+interface MarketingData {
+    utmSource: string | undefined;
+    utmMedium: string | undefined;
+    utmCampaign: string | undefined;
+    utmiPage: string | undefined;
+    utmiPart: string | undefined;
+    utmiCampaign: string | undefined;
+    coupon: string | undefined;
+    marketingTags: string[] | undefined;
+}
+interface Installment {
+    Value: number;
+    InterestRate: number;
+    TotalValuePlusInterestRate: number;
+    NumberOfInstallments: number;
+    PaymentSystemName: string;
+    PaymentSystemGroupName: string;
+    Name: string;
+}
+interface ClientProfileData {
+    email: string;
+    firstName: null;
+    lastName: null;
+    document: null;
+    documentType: null;
+    phone: null;
+    corporateName: null;
+    tradeName: null;
+    corporateDocument: null;
+    stateInscription: null;
+    corporatePhone: null;
+    isCorporate: boolean;
+    profileCompleteOnLoading: boolean;
+    profileErrorOnLoading: boolean;
+    customerClass: null;
+}
+interface Address {
+    addressType?: string;
+    receiverName: string | null;
+    addressId: string;
+    isDisposable?: boolean;
+    postalCode?: string;
+    city?: string;
+    state?: string;
+    country?: string;
+    street?: string;
+    number?: string;
+    neighborhood?: string;
+    addressName?: string;
+    complement: string | null;
+    reference?: string;
+    geoCoordinates?: number[];
+    name?: string;
+}
+interface Offering {
+    type: string;
+    id: string;
+    name: string;
+    allowGiftMessage: boolean;
+    attachmentOfferings: unknown[];
+    price: number;
+}
+interface Ean {
+    maximumNumberOfCharacters: number;
+    domain: unknown[];
+}
+interface Schema {
+    Sku: Ean;
+    Price: Ean;
+    Qtde?: Ean;
+    EAN: Ean;
+    Measuremt_unit: Ean;
+    Unit_multiplier: Ean;
+    Quantity: Ean;
+}
+declare enum Name {
+    AlternativeSubstitute = "ALTERNATIVE_SUBSTITUTE",
+    Substituto = "Substituto"
+}
+interface AttachmentOffering {
+    name: Name;
+    required: boolean;
+    schema: Schema;
+}
+interface SellingPrice {
+    value: number;
+    quantity: number;
+}
+interface PriceDefinition {
+    calculatedSellingPrice: number;
+    total: number;
+    sellingPrices: SellingPrice[];
+}
+interface PriceTag {
+    name: string;
+    value: number;
+    rawValue: number;
+    isPercentual: boolean;
+    identifier: string;
+    owner: string;
+}
+type AvailableAssociations = Record<string, string>;
+interface Component {
+    uniqueId: string;
+    id: string;
+    productId: null;
+    productRefId: null;
+    refId: string;
+    ean: string;
+    name: string;
+    skuName: null;
+    modalType: null;
+    parentItemIndex: null;
+    parentAssemblyBinding: null;
+    assemblies: unknown[];
+    priceValidUntil: null;
+    tax: number;
+    price: number;
+    listPrice: null;
+    manualPrice: null;
+    manualPriceAppliedBy: null;
+    sellingPrice: number;
+    rewardValue: number;
+    isGift: boolean;
+    additionalInfo: AdditionalInfo;
+    preSaleDate: null;
+    productCategoryIds: null;
+    productCategories: AvailableAssociations;
+    quantity: number;
+    seller: null;
+    sellerChain: null[];
+    imageUrl: null;
+    detailUrl: null;
+    components: unknown[];
+    bundleItems: unknown[];
+    attachments: unknown[];
+    attachmentOfferings: unknown[];
+    offerings: unknown[];
+    priceTags: PriceTag[];
+    availability: null;
+    measurementUnit: string;
+    unitMultiplier: number;
+    manufacturerCode: null;
+    priceDefinition: PriceDefinition;
+}
+interface AdditionalInfo {
+    dimension: null;
+    brandName: null | string;
+    brandId: null | string;
+    offeringInfo: null;
+    offeringType: null;
+    offeringTypeId: null;
+}
+interface OrderFormItem {
+    uniqueId: string;
+    id: string;
+    productId: string;
+    productRefId: string;
+    refId: string;
+    ean: null | string;
+    name: string;
+    skuName: string;
+    modalType: null | string;
+    parentItemIndex: null;
+    parentAssemblyBinding: null;
+    assemblies: unknown[];
+    priceValidUntil: Date;
+    tax: number;
+    price: number;
+    listPrice: number;
+    manualPrice: null;
+    manualPriceAppliedBy: null;
+    sellingPrice: number;
+    rewardValue: number;
+    isGift: boolean;
+    additionalInfo: AdditionalInfo;
+    preSaleDate: null;
+    productCategoryIds: string;
+    productCategories: {
+        [key: string]: string;
+    };
+    quantity: number;
+    seller: string;
+    sellerChain: string[];
+    imageUrl: string;
+    detailUrl: string;
+    components: Component[];
+    bundleItems: unknown[];
+    attachments: unknown[];
+    attachmentOfferings: AttachmentOffering[];
+    offerings: Offering[];
+    priceTags: PriceTag[];
+    availability: string;
+    measurementUnit: string;
+    unitMultiplier: number;
+    manufacturerCode: null;
+    priceDefinition: PriceDefinition;
+}
+interface Fields {
+    ean?: string;
+    itemIndex?: string;
+    skuName?: string;
+}
+interface Message {
+    code: null | string;
+    text: string;
+    status: string;
+    fields: Fields;
+}
+interface Totalizer {
+    id: string;
+    name: string;
+    value: number;
+    alternativeTotals?: Totalizer[];
+}
+declare enum SelectedSla {
+    ClickRetireRJS = "Click & Retire (RJS)",
+    Normal = "Normal"
+}
+declare enum SelectedDeliveryChannel {
+    Delivery = "delivery",
+    PickupInPoint = "pickup-in-point"
+}
+interface DeliveryID {
+    courierId: string;
+    warehouseId: string;
+    dockId: string;
+    courierName: string;
+    quantity: number;
+    kitItemDetails: unknown[];
+}
+interface AvailableDeliveryWindow {
+    startDateUtc: Date;
+    endDateUtc: Date;
+    price: number;
+    lisPrice: number;
+    tax: number;
+}
+interface PickupStoreInfo {
+    isPickupStore: boolean;
+    friendlyName: null | string;
+    address: Address | null;
+    additionalInfo: null | string;
+    dockId: null;
+}
+interface Sla {
+    id: SelectedSla;
+    deliveryChannel: SelectedDeliveryChannel;
+    name: SelectedSla;
+    deliveryIds: DeliveryID[];
+    shippingEstimate: string;
+    shippingEstimateDate: null;
+    lockTTL: null;
+    availableDeliveryWindows: AvailableDeliveryWindow[];
+    deliveryWindow: null;
+    price: number;
+    listPrice: number;
+    tax: number;
+    pickupStoreInfo: PickupStoreInfo;
+    pickupPointId: null | string;
+    pickupDistance: number | null;
+    polygonName: string;
+    transitTime: string;
+    line_items?: string;
+}
+interface LogisticsInfo {
+    itemIndex: number;
+    selectedSla: SelectedSla | null;
+    selectedDeliveryChannel: SelectedDeliveryChannel;
+    addressId: string;
+    slas: Sla[];
+    shipsTo: string[];
+    itemId: string;
+    deliveryChannels: DeliveryChannel[];
+}
+interface DeliveryChannel {
+    id: SelectedDeliveryChannel;
+}
+interface PickupHolidays {
+    date?: string;
+    hourBegin?: string;
+    hourEnd?: string;
+}
+interface BusinessHour {
+    DayOfWeek: number;
+    OpeningTime: string;
+    ClosingTime: string;
+}
+interface PickupPoint {
+    friendlyName: string;
+    address: Address;
+    additionalInfo: string;
+    id: string;
+    businessHours: BusinessHour[];
+    pickupHolidays?: PickupHolidays[];
+}
+interface ShippingData {
+    address: Address;
+    logisticsInfo: LogisticsInfo[];
+    selectedAddresses: Address[];
+    availableAddresses: Address[];
+    pickupPoints: PickupPoint[];
+}
+interface CartInstallment {
+    count: number;
+    hasInterestRate: boolean;
+    interestRate: number;
+    value: number;
+    total: number;
+    sellerMerchantInstallments?: Installment[];
+    id?: string;
+}
+interface InstallmentOption {
+    paymentSystem: string;
+    bin: null;
+    paymentName: null;
+    paymentGroupName: null;
+    value: number;
+    installments: CartInstallment[];
+}
+declare enum CardCodeRegex {
+    The093$ = "^[0-9]{3}$",
+    The094$ = "^[0-9]{4}$"
+}
+interface Validator {
+    regex: null | string;
+    mask: null | string;
+    cardCodeRegex: CardCodeRegex | null;
+    cardCodeMask: null | string;
+    weights: number[] | null;
+    useCvv: boolean;
+    useExpirationDate: boolean;
+    useCardHolderName: boolean;
+    useBillingAddress: boolean;
+}
+interface PaymentSystem {
+    id: number;
+    name: string;
+    groupName: string;
+    validator: Validator;
+    stringId: string;
+    template: string;
+    requiresDocument: boolean;
+    displayDocument: boolean;
+    isCustom: boolean;
+    description: null | string;
+    requiresAuthentication: boolean;
+    dueDate: Date;
+    availablePayments: null;
+}
+interface PaymentData {
+    updateStatus: string;
+    installmentOptions: InstallmentOption[];
+    paymentSystems: PaymentSystem[];
+    payments: unknown[];
+    giftCards: unknown[];
+    giftCardMessages: unknown[];
+    availableAccounts: unknown[];
+    availableTokens: unknown[];
+    availableAssociations: AvailableAssociations;
+}
+interface Seller {
+    id: string;
+    name: string;
+    logo: string;
+}
+interface ClientPreferencesData {
+    locale: string;
+    optinNewsLetter: null;
+}
+interface CurrencyFormatInfo {
+    currencyDecimalDigits: number;
+    currencyDecimalSeparator: string;
+    currencyGroupSeparator: string;
+    currencyGroupSize: number;
+    startsWithCurrencySymbol: boolean;
+}
+interface StorePreferencesData {
+    countryCode: string;
+    saveUserData: boolean;
+    timeZone: string;
+    currencyCode: string;
+    currencyLocale: number;
+    currencySymbol: string;
+    currencyFormatInfo: CurrencyFormatInfo;
+}
+interface MatchedParameters {
+    "Seller@CatalogSystem": string;
+    "productCluster@CatalogSystem"?: string;
+    "zipCode@Shipping"?: string;
+    slaIds?: string;
+}
+interface RateAndBenefitsIdentifier {
+    id: string;
+    name: string;
+    featured: boolean;
+    description: string;
+    matchedParameters: MatchedParameters;
+    additionalInfo: null;
+}
+interface RatesAndBenefitsData {
+    rateAndBenefitsIdentifiers: RateAndBenefitsIdentifier[];
+    teaser: unknown[];
+}
+interface OrderForm {
+    selected?: string;
+    index?: number;
+    item_list_name: string;
+    zipcode?: string;
+    orderFormId: string;
+    salesChannel: string;
+    loggedIn: boolean;
+    isCheckedIn: boolean;
+    storeId: null;
+    checkedInPickupPointId: null;
+    allowManualPrice: boolean;
+    canEditData: boolean;
+    userProfileId: null;
+    userType: null;
+    ignoreProfileData: boolean;
+    value: number;
+    messages: Message[];
+    items: OrderFormItem[];
+    selectableGifts: unknown[];
+    totalizers: Totalizer[];
+    shippingData: ShippingData;
+    clientProfileData: ClientProfileData | null;
+    paymentData: PaymentData;
+    marketingData: MarketingData;
+    sellers: Seller[];
+    clientPreferencesData: ClientPreferencesData;
+    commercialConditionData: null;
+    storePreferencesData: StorePreferencesData;
+    giftRegistryData: null;
+    openTextField: null;
+    invoiceData: null;
+    customData: null;
+    hooksData: null;
+    ratesAndBenefitsData: RatesAndBenefitsData;
+    subscriptionData: null;
+    merchantContextData: null;
+    itemsOrdination: null;
+}
+
+declare const PROD_DOMAINS: Record<string, Record<string, string>>;
+
 declare global {
     interface Window {
         dataLayer: any[];
     }
 }
 type EventName = keyof typeof EVENTS;
+type InitialConfig = {
+    brand: string;
+    currency: string;
+};
 type ProductMeta = {
     index?: number;
     item_list_name?: string | undefined | null;
 };
-type AdapterPayload = {
-    adapter: 'HEADLESS';
-    zone: 'PDP';
-    products: (ProductType_PDP & ProductMeta)[];
-} | {
-    adapter: 'HEADLESS';
-    zone: 'PDC';
-    products: (ProductType_PDC & ProductMeta)[];
-} | {
-    adapter: 'HEADLESS';
-    zone: 'Minicart';
-    products: (ProductType_Minicart & ProductMeta)[];
-} | {
-    adapter: 'DECO';
-    products: (Product & ProductMeta)[];
+type ManuallyInfoContext = {
+    cpf: string;
+    birthDate: string;
+    phone: string;
+    firstName: string;
+    lastName: string;
+    email: string;
+    email_optin?: boolean;
+};
+type UserInfoContext = {
+    account: keyof typeof PROD_DOMAINS;
+    platform: 'store' | 'checkout';
+    userEmail: string;
+    userId?: string;
+    manuallyInfo?: ManuallyInfoContext;
 };
 interface TrackMeta {
     region?: string;
@@ -985,23 +1435,60 @@ interface TrackMeta {
     type?: string;
     item_ref?: string;
     size?: string;
+    color?: string;
+    ordering?: string;
+    price_range?: string;
+    category?: string;
     search_term?: string;
     search_found?: boolean;
     search_quantity?: number;
-    zip_code?: string;
+    zipcode?: string;
+    content_type?: string;
     promotion_name?: string;
     creative_name?: string;
     creative_slot?: string;
     coupon_code?: string;
-    currency?: string;
+    user_info?: UserInfoContext;
 }
+type CallOverrides = {
+    brand?: string;
+};
+type AdapterPayload = ({
+    adapter: 'META';
+} | {
+    adapter: 'DECO';
+    products: (Product & ProductMeta)[];
+} | {
+    adapter: 'ORDERFORM';
+    orderForm: (OrderForm & ProductMeta)[];
+} | {
+    adapter: 'PICKUP';
+    flag_pickup: boolean;
+    shippings: Sla[];
+} | {
+    adapter: 'HEADLESS';
+    zone: 'PDP';
+    products: (ProductType_PDP & ProductMeta)[];
+} | {
+    adapter: 'HEADLESS';
+    zone: 'PDC';
+    products: (ProductType_PDC & ProductMeta)[];
+} | {
+    adapter: 'HEADLESS';
+    zone: 'Minicart';
+    products: (ProductType_Minicart & ProductMeta)[];
+}) & CallOverrides;
 type RequiredMetaKeys<E extends EventName> = Extract<RequiredParamsOf<E>, keyof TrackMeta>;
 type MetaForEvent<E extends EventName> = Required<Pick<TrackMeta, RequiredMetaKeys<E>>> & Omit<TrackMeta, RequiredMetaKeys<E>>;
-
-declare function trackWebEvent<E extends EventName>(event: E, context: AdapterPayload & {
+type PayloadFor<E extends EventName> = ('items' extends RequiredParamsOf<E> ? Exclude<AdapterPayload, {
+    adapter: 'META';
+}> : AdapterPayload) & {
     meta: MetaForEvent<E>;
     window?: unknown;
-}): Promise<void>;
+};
+
+declare function initTracker(c: InitialConfig): void;
+declare function trackWebEvent<E extends EventName>(event: E, context: PayloadFor<E>): Promise<void>;
 
 declare const _default: {
     trackWebEvent: typeof trackWebEvent;
@@ -1183,4 +1670,4 @@ declare const _default: {
     };
 };
 
-export { EVENTS, _default as default, trackWebEvent };
+export { EVENTS, _default as default, initTracker, trackWebEvent };