@artisan-commerce/analytics-web 0.1.0-canary.19 → 0.1.0-canary.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +0 -141
- package/build/main.bundle.js +11 -11
- package/build/report.json +1 -1
- package/build/src/index.d.ts +0 -1
- package/build/src/lib/events/auth/changePasswordAttempt/changePasswordAttempt.d.ts +1 -1
- package/build/src/lib/events/auth/changePasswordFail/changePasswordFail.d.ts +1 -1
- package/build/src/lib/events/auth/changePasswordSuccess/changePasswordSuccess.d.ts +1 -1
- package/build/src/lib/events/auth/signIn/signIn.d.ts +1 -1
- package/build/src/lib/events/auth/signOut/signOut.d.ts +1 -1
- package/build/src/lib/events/auth/signUp/signUp.d.ts +1 -1
- package/build/src/lib/events/auth/signUpAttempt/signUpAttempt.d.ts +1 -2
- package/build/src/lib/events/banner/bannerImpression/bannerImpression.d.ts +1 -1
- package/build/src/lib/events/banner/bannerImpression/bannerImpression.types.d.ts +1 -1
- package/build/src/lib/events/banner/selectBanner/selectBanner.d.ts +1 -1
- package/build/src/lib/events/banner/selectBanner/selectBanner.types.d.ts +4 -4
- package/build/src/lib/events/billing/addBillingInfo/addBillingInfo.d.ts +1 -1
- package/build/src/lib/events/billing/addBillingInfo/addBillingInfo.types.d.ts +1 -1
- package/build/src/lib/events/billing/selectBillingInfo/selectBillingInfo.d.ts +1 -1
- package/build/src/lib/events/billing/selectBillingInfo/selectBillingInfo.types.d.ts +2 -2
- package/build/src/lib/events/billing/updateBillingInfo/updateBillingInfo.d.ts +1 -1
- package/build/src/lib/events/billing/updateBillingInfo/updateBillingInfo.types.d.ts +2 -2
- package/build/src/lib/events/booking/bookAppointment/bookAppointment.d.ts +1 -1
- package/build/src/lib/events/category/categoryImpression/categoryImpression.d.ts +1 -1
- package/build/src/lib/events/category/searchCategoryAttempt/searchCategoryAttempt.d.ts +1 -1
- package/build/src/lib/events/category/selectCategory/selectCategory.d.ts +1 -2
- package/build/src/lib/events/category/viewCategory/viewCategory.d.ts +1 -2
- package/build/src/lib/events/checkout/checkoutAction/checkoutAction.d.ts +1 -1
- package/build/src/lib/events/checkout/checkoutAction/checkoutAction.types.d.ts +1 -1
- package/build/src/lib/events/checkout/initiateCheckout/initiateCheckout.d.ts +1 -1
- package/build/src/lib/events/coupon/applyBenefit/applyBenefit.d.ts +1 -1
- package/build/src/lib/events/coupon/couponCodeError/couponCodeError.d.ts +1 -1
- package/build/src/lib/events/coupon/redeemCouponCode/redeemCouponCode.d.ts +1 -1
- package/build/src/lib/events/coupon/removeBenefit/removeBenefit.d.ts +1 -1
- package/build/src/lib/events/coupon/viewBenefitDetails/viewBenefitDetails.d.ts +1 -1
- package/build/src/lib/events/coupon/viewBenefitsWallet/viewBenefitsWallet.d.ts +1 -1
- package/build/src/lib/events/coupon/viewQRStoreCoupon/viewQRStoreCoupon.d.ts +1 -2
- package/build/src/lib/events/credit/addCredits/addCredits.d.ts +1 -1
- package/build/src/lib/events/credit/spendCredits/spendCredits.d.ts +1 -1
- package/build/src/lib/events/credit/viewCredits/viewCredits.d.ts +1 -1
- package/build/src/lib/events/customEvent/customEvent.d.ts +2 -2
- package/build/src/lib/events/events.d.ts +5 -5
- package/build/src/lib/events/events.types.d.ts +1 -1
- package/build/src/lib/events/fulfillment/viewFulfillmentStep/viewFulfillmentStep.d.ts +1 -1
- package/build/src/lib/events/fulfillment/viewTracking/viewTracking.d.ts +1 -1
- package/build/src/lib/events/fulfillment/viewTracking/viewTracking.types.d.ts +1 -1
- package/build/src/lib/events/geo/changeLocation/changeLocation.d.ts +2 -2
- package/build/src/lib/events/geo/changeLocation/changeLocation.types.d.ts +4 -4
- package/build/src/lib/events/geo/findLocation/findLocation.d.ts +2 -2
- package/build/src/lib/events/geo/findLocation/findLocation.types.d.ts +2 -2
- package/build/src/lib/events/geo/index.d.ts +4 -4
- package/build/src/lib/events/geo/outOfCoverage/outOfCoverage.d.ts +2 -2
- package/build/src/lib/events/geo/outOfCoverage/outOfCoverage.types.d.ts +2 -2
- package/build/src/lib/events/geo/setLocation/setLocation.d.ts +2 -2
- package/build/src/lib/events/geo/setLocation/setLocation.types.d.ts +2 -2
- package/build/src/lib/events/help/requestAssistance/requestAssistance.d.ts +1 -2
- package/build/src/lib/events/loyalty/earnPoints/earnPoints.d.ts +1 -1
- package/build/src/lib/events/loyalty/sharePoints/sharePoints.d.ts +1 -1
- package/build/src/lib/events/loyalty/spendPoints/spendPoints.d.ts +1 -1
- package/build/src/lib/events/loyalty/viewLoyaltyLevel/viewLoyaltyLevel.d.ts +1 -1
- package/build/src/lib/events/order/cancelOrder/cancelOrder.d.ts +1 -1
- package/build/src/lib/events/order/rateOrder/rateOrder.d.ts +1 -1
- package/build/src/lib/events/order/requestRefund/requestRefund.d.ts +1 -1
- package/build/src/lib/events/order/requestRefund/requestRefund.types.d.ts +0 -1
- package/build/src/lib/events/other/generateLead/generateLead.d.ts +1 -1
- package/build/src/lib/events/other/pageView/pageView.d.ts +1 -2
- package/build/src/lib/events/other/pageView/pageView.types.d.ts +2 -2
- package/build/src/lib/events/other/searchPageContent/searchPageContent.d.ts +1 -1
- package/build/src/lib/events/other/searchPageContent/searchPageContent.types.d.ts +1 -1
- package/build/src/lib/events/payment/changePaymentType/changePaymentType.d.ts +1 -1
- package/build/src/lib/events/payment/changePaymentType/changePaymentType.types.d.ts +2 -6
- package/build/src/lib/events/payment/selectPaymentType/selectPaymentType.d.ts +1 -1
- package/build/src/lib/events/payment/selectPaymentType/selectPaymentType.types.d.ts +2 -2
- package/build/src/lib/events/payment/setPaymentInfo/setPaymentInfo.d.ts +1 -1
- package/build/src/lib/events/payment/setPaymentInfo/setPaymentInfo.types.d.ts +3 -3
- package/build/src/lib/events/product/customizeProduct/customizeProduct.d.ts +1 -1
- package/build/src/lib/events/product/filterProducts/filterProducts.d.ts +1 -1
- package/build/src/lib/events/product/filterProducts/filterProducts.types.d.ts +1 -1
- package/build/src/lib/events/product/productImpression/productImpression.d.ts +1 -1
- package/build/src/lib/events/product/searchProductAttempt/searchProductAttempt.d.ts +1 -1
- package/build/src/lib/events/product/searchProductNotFound/searchProductNotFound.d.ts +1 -1
- package/build/src/lib/events/product/searchProductSuccess/searchProductSuccess.d.ts +1 -1
- package/build/src/lib/events/product/selectProduct/selectProduct.d.ts +1 -2
- package/build/src/lib/events/product/sortProducts/sortProducts.d.ts +1 -1
- package/build/src/lib/events/product/sortProducts/sortProducts.types.d.ts +2 -2
- package/build/src/lib/events/product/viewProductDetails/viewProductDetails.d.ts +1 -2
- package/build/src/lib/events/product/viewProductDetails/viewProductDetails.types.d.ts +1 -1
- package/build/src/lib/events/purchase/purchaseAttempt/purchaseAttempt.d.ts +1 -1
- package/build/src/lib/events/purchase/purchaseAttempt/purchaseAttempt.types.d.ts +1 -1
- package/build/src/lib/events/purchase/purchaseFail/purchaseFail.d.ts +1 -1
- package/build/src/lib/events/purchase/purchaseSuccess/purchaseSuccess.d.ts +1 -1
- package/build/src/lib/events/settings/viewSettings/viewSettings.d.ts +1 -1
- package/build/src/lib/events/shipping/addShippingAddress/addShippingAddress.d.ts +1 -1
- package/build/src/lib/events/shipping/addShippingAddress/addShippingAddress.types.d.ts +1 -1
- package/build/src/lib/events/shipping/selectShippingAddress/selectShippingAddress.d.ts +1 -1
- package/build/src/lib/events/shipping/selectShippingAddress/selectShippingAddress.types.d.ts +1 -1
- package/build/src/lib/events/shipping/updateShippingAddress/updateShippingAddress.d.ts +1 -1
- package/build/src/lib/events/shipping/updateShippingAddress/updateShippingAddress.types.d.ts +1 -1
- package/build/src/lib/events/shoppingCart/addProductToCart/addProductToCart.d.ts +1 -1
- package/build/src/lib/events/shoppingCart/addProductToWishlist/addProductToWishlist.d.ts +1 -1
- package/build/src/lib/events/shoppingCart/clearCart/clearCart.d.ts +1 -1
- package/build/src/lib/events/shoppingCart/removeProductFromCart/removeProductFromCart.d.ts +1 -1
- package/build/src/lib/events/shoppingCart/removeProductFromCart/removeProductFromCart.types.d.ts +1 -1
- package/build/src/lib/events/shoppingCart/removeProductFromWishlist/removeProductFromWishlist.d.ts +1 -1
- package/build/src/lib/events/shoppingCart/removeProductFromWishlist/removeProductFromWishlist.types.d.ts +1 -1
- package/build/src/lib/events/shoppingCart/updateProductInCart/updateProductInCart.d.ts +1 -2
- package/build/src/lib/events/shoppingCart/updateProductInCart/updateProductInCart.types.d.ts +1 -1
- package/build/src/lib/events/shoppingCart/updateProductInWishlist/updateProductInWishlist.d.ts +1 -2
- package/build/src/lib/events/shoppingCart/updateProductInWishlist/updateProductInWishlist.types.d.ts +1 -1
- package/build/src/lib/events/shoppingCart/viewCart/viewCart.d.ts +1 -1
- package/build/src/lib/events/social/share/share.d.ts +1 -1
- package/build/src/lib/events/social/share/share.types.d.ts +3 -3
- package/build/src/lib/events/store/changeStore/changeStore.d.ts +1 -1
- package/build/src/lib/events/store/setStore/setStore.d.ts +1 -1
- package/build/src/lib/events/user/setUserInfo/setUserInfo.d.ts +1 -2
- package/build/src/lib/events/user/updateUserInfo/updateUserInfo.d.ts +2 -3
- package/build/src/lib/events/vendor/changeVendor/changeVendor.d.ts +1 -1
- package/build/src/lib/events/vendor/setVendor/setVendor.d.ts +1 -1
- package/build/src/lib/events/workflow/selectWorkflow/selectWorkflow.d.ts +1 -1
- package/build/src/lib/events/workflow/updateWorkflow/updateWorkflow.d.ts +1 -1
- package/build/src/lib/initAnalytics/initAnalytics.helpers.d.ts +1 -1
- package/build/src/lib/initAnalytics/initAnalytics.types.d.ts +1 -13
- package/build/src/lib/providers/AnalyticsProvider/AnalyticsProvider.d.ts +1 -1
- package/build/src/lib/providers/AnalyticsProvider/AnalyticsProvider.types.d.ts +2 -2
- package/build/src/lib/providers/FacebookPixel/FacebookPixel.types.d.ts +1 -0
- package/build/src/lib/providers/FacebookPixel/events/order/rateOrder/rateOrder.types.d.ts +0 -1
- package/build/src/lib/providers/FacebookPixel/events/product/productImpression/productImpression.types.d.ts +1 -1
- package/build/src/lib/providers/GlobalProvider/GlobalProvider.d.ts +1 -1
- package/build/src/lib/providers/GoogleAnalytics/GoogleAnalytics.types.d.ts +2 -8
- package/build/src/types/event.types.d.ts +1 -0
- package/build/src/utils/logs.utils.d.ts +1 -1
- package/build/src/utils/state.utils.d.ts +0 -8
- package/package.json +7 -6
package/build/src/index.d.ts
CHANGED
|
@@ -6,4 +6,3 @@ export * from "./lib/providers/FacebookPixel/FacebookPixel.types";
|
|
|
6
6
|
export * from "./lib/providers/GoogleAnalytics/GoogleAnalytics.types";
|
|
7
7
|
export { default as events } from "./lib/events/events";
|
|
8
8
|
export * from "./types/common.types";
|
|
9
|
-
export { updateActiveVendor } from "./utils/state.utils";
|
|
@@ -2,7 +2,7 @@ import { ChangePasswordAttemptParams } from "./changePasswordAttempt.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a changePasswordAttempt event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @param {ChangePasswordAttemptParams} params ChangePasswordAttempt event parameters
|
|
@@ -2,7 +2,7 @@ import { ChangePasswordFailParams } from "./changePasswordFail.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a changePasswordFail event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @param {ChangePasswordFailParams} params ChangePasswordFail event parameters
|
|
@@ -2,7 +2,7 @@ import { ChangePasswordSuccessParams } from "./changePasswordSuccess.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a changePasswordSuccess event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @param {ChangePasswordSuccessParams} params ChangePasswordSuccess event parameters
|
|
@@ -2,7 +2,7 @@ import { SignInParams } from "./signIn.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a signIn event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @param {SignInParams} params SingIn event parameters
|
|
@@ -2,7 +2,7 @@ import { SignOutParams } from "./signOut.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a signOut event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @param {SignOutParams} params SignOut event parameters
|
|
@@ -2,7 +2,7 @@ import { SignUpParams } from "./signUp.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a signUp event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @param {SignUpParams} params SignUp event parameters
|
|
@@ -2,8 +2,7 @@ import { SignUpAttemptParams } from "./signUpAttempt.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a signUpAttempt event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
6
|
-
* after the sign up action has resolved.
|
|
5
|
+
* Record this event when submitting the sign up action. It should not be triggered after the sign up action has resolved.
|
|
7
6
|
*
|
|
8
7
|
* @since 0.5.14
|
|
9
8
|
* @param {SignUpAttemptParams} params SignUpAttempt event parameters
|
|
@@ -2,7 +2,7 @@ import { BannerImpressionParams } from "./bannerImpression.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a bannerImpression event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {BannerImpressionParams} params BannerImpression event parameters
|
|
@@ -5,7 +5,7 @@ import { BannerImpressionParams as FacebookBannerImpressionParams } from "../../
|
|
|
5
5
|
*
|
|
6
6
|
* @interface BannerImpressionCommonParams
|
|
7
7
|
* @since 0.5.14
|
|
8
|
-
* @property {string} url The
|
|
8
|
+
* @property {string} url The url of a banner a user had an impression on
|
|
9
9
|
* @property {string} name The name of a banner a user had an impression on
|
|
10
10
|
* @property {string} list The name of the list where the banner is
|
|
11
11
|
* @property {number} position The position in a list where the banner is
|
|
@@ -2,7 +2,7 @@ import { SelectBannerParams } from "./selectBanner.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a selectBanner event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {SelectBannerParams} params SelectBanner event parameters
|
|
@@ -5,10 +5,10 @@ import { SelectBannerParams as FacebookSelectBannerParams } from "../../../provi
|
|
|
5
5
|
*
|
|
6
6
|
* @interface SelectBannerCommonParams
|
|
7
7
|
* @since 0.5.14
|
|
8
|
-
* @property {string} url The url of
|
|
9
|
-
* @property {string} name The name of
|
|
10
|
-
* @property {string} list the name of the list where the
|
|
11
|
-
* @property {number} position the position in a list where the
|
|
8
|
+
* @property {string} url The url of a banner a user had an impression on
|
|
9
|
+
* @property {string} name The name of a banner a user had an impression on
|
|
10
|
+
* @property {string} list the name of the list where the product is
|
|
11
|
+
* @property {number} position the position in a list where the product is
|
|
12
12
|
*/
|
|
13
13
|
export interface SelectBannerCommonParams {
|
|
14
14
|
url: string;
|
|
@@ -2,7 +2,7 @@ import { AddBillingInfoParams } from "./addBillingInfo.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a addBillingInfo event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {AddBillingInfoParams} params AddBillingInfo event parameters
|
|
@@ -5,7 +5,7 @@ import { AddBillingInfoParams as FacebookAddBillingInfoParams } from "../../../p
|
|
|
5
5
|
*
|
|
6
6
|
* @interface AddBillingInfoCommonParams
|
|
7
7
|
* @since 0.5.14
|
|
8
|
-
* @property {string} alias The name of the new billing
|
|
8
|
+
* @property {string} alias The name of the new billing info data
|
|
9
9
|
*/
|
|
10
10
|
export interface AddBillingInfoCommonParams {
|
|
11
11
|
alias?: string;
|
|
@@ -2,7 +2,7 @@ import { SelectBillingInfoParams } from "./selectBillingInfo.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a selectBillingInfo event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {SelectBillingInfoParams} params SelectBillingInfo event parameters
|
|
@@ -5,8 +5,8 @@ import { SelectBillingInfoParams as FacebookSelectBillingInfoParams } from "../.
|
|
|
5
5
|
*
|
|
6
6
|
* @interface SelectBillingInfoCommonParams
|
|
7
7
|
* @since 0.5.14
|
|
8
|
-
* @property {string} alias The name of the new billing
|
|
9
|
-
* @property {number} position
|
|
8
|
+
* @property {string} alias The name of the new billing info data
|
|
9
|
+
* @property {number} position the position in a list where the product is
|
|
10
10
|
*/
|
|
11
11
|
export interface SelectBillingInfoCommonParams {
|
|
12
12
|
alias?: string;
|
|
@@ -2,7 +2,7 @@ import { UpdateBillingInfoParams } from "./updateBillingInfo.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a updateBillingInfo event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {UpdateBillingInfoParams} params UpdateBillingInfo event parameters
|
|
@@ -5,8 +5,8 @@ import { UpdateBillingInfoParams as FacebookUpdateBillingInfoParams } from "../.
|
|
|
5
5
|
*
|
|
6
6
|
* @interface UpdateBillingInfoCommonParams
|
|
7
7
|
* @since 0.5.14
|
|
8
|
-
* @property {string} alias The name of the new billing
|
|
9
|
-
* @property {number} position
|
|
8
|
+
* @property {string} alias The name of the new billing info data
|
|
9
|
+
* @property {number} position the position in a list where the product is
|
|
10
10
|
* @property {string[]} fields The updated fields names
|
|
11
11
|
*/
|
|
12
12
|
export interface UpdateBillingInfoCommonParams {
|
|
@@ -2,7 +2,7 @@ import { BookAppointmentParams } from "./bookAppointment.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a bookAppointment event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {BookAppointmentParams} params BookAppointment event parameters
|
|
@@ -2,7 +2,7 @@ import { CategoryImpressionParams } from "./categoryImpression.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a categoryImpression event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {CategoryImpressionParams} params CategoryImpression event parameters
|
|
@@ -2,7 +2,7 @@ import { SearchCategoryAttemptParams } from "./searchCategoryAttempt.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a SearchCategoryAttempt event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {SearchCategoryAttemptParams} params SearchCategoryAttempt event parameters
|
|
@@ -2,8 +2,7 @@ import { SelectCategoryParams } from "./selectCategory.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a selectCategory event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
6
|
-
* be on a list.
|
|
5
|
+
* Record this event when
|
|
7
6
|
*
|
|
8
7
|
* @since 0.5.14
|
|
9
8
|
* @property {SelectCategoryParams} params SelectCategory event parameters
|
|
@@ -2,8 +2,7 @@ import { ViewCategoryParams } from "./viewCategory.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a viewCategory event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
6
|
-
* and are shown to the user.
|
|
5
|
+
* Record this event when
|
|
7
6
|
*
|
|
8
7
|
* @since 0.5.14
|
|
9
8
|
* @property {ViewCategoryParams} params ViewCategory event parameters
|
|
@@ -2,7 +2,7 @@ import { CheckoutActionParams } from "./checkoutAction.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a checkoutAction event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {CheckoutActionParams} params CheckoutAction event parameters
|
|
@@ -6,7 +6,7 @@ import { CheckoutActionParams as FacebookCheckoutActionParams } from "../../../p
|
|
|
6
6
|
* @interface CheckoutActionCommonParams
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {string} action The name of the checkout step (e.g "billing")
|
|
9
|
-
* @property {string} progress The
|
|
9
|
+
* @property {string} progress The completness of the checkout progress (e.g "1/3")
|
|
10
10
|
*/
|
|
11
11
|
export interface CheckoutActionCommonParams {
|
|
12
12
|
action: string;
|
|
@@ -2,7 +2,7 @@ import { InitiateCheckoutParams } from "./initiateCheckout.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a initiateCheckout event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {InitiateCheckoutParams} params InitiateCheckout event parameters
|
|
@@ -2,7 +2,7 @@ import { ApplyBenefitParams } from "./applyBenefit.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a applyBenefit event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {ApplyBenefitParams} params ApplyBenefit event parameters
|
|
@@ -2,7 +2,7 @@ import { CouponCodeErrorParams } from "./couponCodeError.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a couponCodeError event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {CouponCodeErrorParams} params CouponCodeError event parameters
|
|
@@ -2,7 +2,7 @@ import { RedeemCouponCodeParams } from "./redeemCouponCode.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a redeemCouponCode event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {RedeemCouponCodeParams} params RedeemCouponCode event parameters
|
|
@@ -2,7 +2,7 @@ import { RemoveBenefitParams } from "./removeBenefit.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a removeBenefit event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {RemoveBenefitParams} params RemoveBenefit event parameters
|
|
@@ -2,7 +2,7 @@ import { ViewBenefitDetailsParams } from "./viewBenefitDetails.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a viewBenefitDetails event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {ViewBenefitDetailsParams} params ViewBenefitDetails event parameters
|
|
@@ -2,7 +2,7 @@ import { ViewBenefitsWalletParams } from "./viewBenefitsWallet.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a viewBenefitsWallet event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {ViewBenefitsWalletParams} params ViewBenefitsWallet event parameters
|
|
@@ -2,8 +2,7 @@ import { ViewQRStoreCouponParams } from "./viewQRStoreCoupon.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a viewQrStoreCoupon event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
6
|
-
* code.
|
|
5
|
+
* Record this event when
|
|
7
6
|
*
|
|
8
7
|
* @since 0.5.14
|
|
9
8
|
* @property {ViewQrStoreCouponParams} params ViewQrStoreCoupon event parameters
|
|
@@ -2,7 +2,7 @@ import { AddCreditsParams } from "./addCredits.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a addCredits event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {AddCreditsParams} params AddCredits event parameters
|
|
@@ -2,7 +2,7 @@ import { SpendCreditsParams } from "./spendCredits.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a spendCredits event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {SpendCreditsParams} params SpendCredits event parameters
|
|
@@ -2,7 +2,7 @@ import { ViewCreditsParams } from "./viewCredits.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a viewCredits event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {ViewCreditsParams} params ViewCredits event parameters
|
|
@@ -2,11 +2,11 @@ import { CustomEventParams } from "./customEvent.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a customEvent event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @param {string} eventName The name of the custom event
|
|
9
9
|
* @param {CustomEventParams} params CustomEvent event parameters
|
|
10
10
|
*/
|
|
11
|
-
declare const logCustomEvent: (eventName: string, params
|
|
11
|
+
declare const logCustomEvent: (eventName: string, params: CustomEventParams) => void;
|
|
12
12
|
export default logCustomEvent;
|
|
@@ -49,15 +49,15 @@ declare const events: {
|
|
|
49
49
|
logViewTracking: (params: import("./fulfillment/viewTracking/viewTracking.types").ViewTrackingParams) => void;
|
|
50
50
|
};
|
|
51
51
|
geo: {
|
|
52
|
-
logChangeLocation: (params
|
|
53
|
-
logFindLocation: (params
|
|
54
|
-
logOutOfCoverage: (params
|
|
55
|
-
logSetLocation: (params
|
|
52
|
+
logChangeLocation: (params: import("./geo/changeLocation/changeLocation.types").ChangeLocationParams) => void;
|
|
53
|
+
logFindLocation: (params: import("./geo/findLocation/findLocation.types").FindLocationParams) => void;
|
|
54
|
+
logOutOfCoverage: (params: import("./geo/outOfCoverage/outOfCoverage.types").OutOfCoverageParams) => void;
|
|
55
|
+
logSetLocation: (params: import("./geo/setLocation/setLocation.types").SetLocationParams) => void;
|
|
56
56
|
};
|
|
57
57
|
help: {
|
|
58
58
|
logRequestAssistance: (params: import("./help/requestAssistance/requestAssistance.types").RequestAssistanceParams) => void;
|
|
59
59
|
};
|
|
60
|
-
logCustomEvent: (eventName: string, params
|
|
60
|
+
logCustomEvent: (eventName: string, params: import("./customEvent/customEvent.types").CustomEventParams) => void;
|
|
61
61
|
loyalty: {
|
|
62
62
|
logEarnPoints: (params: import("./loyalty/earnPoints/earnPoints.types").EarnPointsParams) => void;
|
|
63
63
|
logSharePoints: (params: import("./loyalty/sharePoints/sharePoints.types").SharePointsParams) => void;
|
|
@@ -21,4 +21,4 @@ export declare type Workflow = "Delivery" | "Pickup" | "Other";
|
|
|
21
21
|
* @typedef PaymentType
|
|
22
22
|
* @since 0.5.14
|
|
23
23
|
*/
|
|
24
|
-
export declare type PaymentType = "Credit" | "Debit" | "Cash" | "
|
|
24
|
+
export declare type PaymentType = "Credit" | "Debit" | "Cash" | "Other";
|
|
@@ -2,7 +2,7 @@ import { ViewFulfillmentStepParams } from "./viewFulfillmentStep.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a viewFulfillmentStep event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {ViewFulfillmentStepParams} params ViewFulfillmentStep event parameters
|
|
@@ -2,7 +2,7 @@ import { ViewTrackingParams } from "./viewTracking.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a viewTracking event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {ViewTrackingParams} params ViewTracking event parameters
|
|
@@ -5,7 +5,7 @@ import { ViewTrackingParams as FacebookViewTrackingParams } from "../../../provi
|
|
|
5
5
|
*
|
|
6
6
|
* @interface ViewTrackingCommonParams
|
|
7
7
|
* @since 0.5.14
|
|
8
|
-
* @property {string} orderId The order unique
|
|
8
|
+
* @property {string} orderId The order unique identifer
|
|
9
9
|
*/
|
|
10
10
|
export interface ViewTrackingCommonParams {
|
|
11
11
|
orderId: string;
|
|
@@ -2,10 +2,10 @@ import { ChangeLocationParams } from "./changeLocation.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a changeLocation event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {ChangeLocationParams} params ChangeLocation event parameters
|
|
9
9
|
*/
|
|
10
|
-
declare const logChangeLocation: (params
|
|
10
|
+
declare const logChangeLocation: (params: ChangeLocationParams) => void;
|
|
11
11
|
export default logChangeLocation;
|
|
@@ -11,10 +11,10 @@ import { ChangeLocationParams as FacebookChangeLocationParams } from "../../../p
|
|
|
11
11
|
* @property {number} nextLng New set user's longitude
|
|
12
12
|
*/
|
|
13
13
|
export interface ChangeLocationCommonParams {
|
|
14
|
-
previousLat
|
|
15
|
-
previousLng
|
|
16
|
-
nextLat
|
|
17
|
-
nextLng
|
|
14
|
+
previousLat: number;
|
|
15
|
+
previousLng: number;
|
|
16
|
+
nextLat: number;
|
|
17
|
+
nextLng: number;
|
|
18
18
|
}
|
|
19
19
|
/**
|
|
20
20
|
* changeLocation event params.
|
|
@@ -2,10 +2,10 @@ import { FindLocationParams } from "./findLocation.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a findLocation event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {FindLocationParams} params FindLocation event parameters
|
|
9
9
|
*/
|
|
10
|
-
declare const logFindLocation: (params
|
|
10
|
+
declare const logFindLocation: (params: FindLocationParams) => void;
|
|
11
11
|
export default logFindLocation;
|
|
@@ -9,8 +9,8 @@ import { FindLocationParams as FacebookFindLocationParams } from "../../../provi
|
|
|
9
9
|
* @property {number} lng longitude being searched
|
|
10
10
|
*/
|
|
11
11
|
export interface FindLocationCommonParams {
|
|
12
|
-
lat
|
|
13
|
-
lng
|
|
12
|
+
lat: number;
|
|
13
|
+
lng: number;
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
16
|
* findLocation event params.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
declare const events: {
|
|
2
|
-
logChangeLocation: (params
|
|
3
|
-
logFindLocation: (params
|
|
4
|
-
logOutOfCoverage: (params
|
|
5
|
-
logSetLocation: (params
|
|
2
|
+
logChangeLocation: (params: import("./changeLocation/changeLocation.types").ChangeLocationParams) => void;
|
|
3
|
+
logFindLocation: (params: import("./findLocation/findLocation.types").FindLocationParams) => void;
|
|
4
|
+
logOutOfCoverage: (params: import("./outOfCoverage/outOfCoverage.types").OutOfCoverageParams) => void;
|
|
5
|
+
logSetLocation: (params: import("./setLocation/setLocation.types").SetLocationParams) => void;
|
|
6
6
|
};
|
|
7
7
|
export default events;
|
|
@@ -2,10 +2,10 @@ import { OutOfCoverageParams } from "./outOfCoverage.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a outOfCoverage event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {OutOfCoverageParams} params OutOfCoverage event parameters
|
|
9
9
|
*/
|
|
10
|
-
declare const logOutOfCoverage: (params
|
|
10
|
+
declare const logOutOfCoverage: (params: OutOfCoverageParams) => void;
|
|
11
11
|
export default logOutOfCoverage;
|
|
@@ -9,8 +9,8 @@ import { OutOfCoverageParams as FacebookOutOfCoverageParams } from "../../../pro
|
|
|
9
9
|
* @property {number} lng longitude being searched
|
|
10
10
|
*/
|
|
11
11
|
export interface OutOfCoverageCommonParams {
|
|
12
|
-
lat
|
|
13
|
-
lng
|
|
12
|
+
lat: number;
|
|
13
|
+
lng: number;
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
16
|
* outOfCoverage event params.
|
|
@@ -2,10 +2,10 @@ import { SetLocationParams } from "./setLocation.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a setLocation event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {SetLocationParams} params SetLocation event parameters
|
|
9
9
|
*/
|
|
10
|
-
declare const logSetLocation: (params
|
|
10
|
+
declare const logSetLocation: (params: SetLocationParams) => void;
|
|
11
11
|
export default logSetLocation;
|
|
@@ -9,8 +9,8 @@ import { SetLocationParams as FacebookSetLocationParams } from "../../../provide
|
|
|
9
9
|
* @property {number} lng the new set longitude
|
|
10
10
|
*/
|
|
11
11
|
export interface SetLocationCommonParams {
|
|
12
|
-
lat
|
|
13
|
-
lng
|
|
12
|
+
lat: number;
|
|
13
|
+
lng: number;
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
16
|
* setLocation event params.
|
|
@@ -2,8 +2,7 @@ import { RequestAssistanceParams } from "./requestAssistance.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a requestAssistance event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
6
|
-
* chat, or other means.
|
|
5
|
+
* Record this event when
|
|
7
6
|
*
|
|
8
7
|
* @since 0.5.14
|
|
9
8
|
* @property {RequestAssistanceParams} params RequestAssistance event parameters
|
|
@@ -2,7 +2,7 @@ import { EarnPointsParams } from "./earnPoints.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a earnPoints event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {EarnPointsParams} params EarnPoints event parameters
|
|
@@ -2,7 +2,7 @@ import { SharePointsParams } from "./sharePoints.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a sharePoints event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {SharePointsParams} params SharePoints event parameters
|
|
@@ -2,7 +2,7 @@ import { SpendPointsParams } from "./spendPoints.types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Emits a spendPoints event to every configured provider.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Record this event when
|
|
6
6
|
*
|
|
7
7
|
* @since 0.5.14
|
|
8
8
|
* @property {SpendPointsParams} params SpendPoints event parameters
|