@artisan-commerce/analytics-web 0.1.0-canary.10

package/build/src/lib/providers/GoogleAnalytics/events/social/index.d.ts

@@ -0,0 +1,4 @@
+declare const events: {
+    share: (provider: import("../../GoogleAnalytics.types").GoogleAnalyticsProvider, params: import("./share/share.types").ShareParams) => void;
+};
+export default events;

package/build/src/lib/providers/GoogleAnalytics/events/social/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/providers/GoogleAnalytics/events/social/share/share.d.ts

@@ -0,0 +1,11 @@
+import { GoogleAnalyticsProvider } from "../../../GoogleAnalytics.types";
+import { ShareParams } from "./share.types";
+/**
+ * Emits a share event to a Google Analytics Provider.
+ *
+ * @since 0.5.14
+ * @param {GoogleAnalyticsProvider} provider The provider instance that will emit the event
+ * @param {ShareParams} params Event configuration parameters
+ */
+declare const share: (provider: GoogleAnalyticsProvider, params: ShareParams) => void;
+export default share;

package/build/src/lib/providers/GoogleAnalytics/events/social/share/share.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/providers/GoogleAnalytics/events/social/share/share.types.d.ts

@@ -0,0 +1,16 @@
+import { ShareCommonParams } from "../../../../../events/social/share/share.types";
+import { GoogleAnalyticsCommonEventParams } from "../../../GoogleAnalytics.types";
+import { GoogleAnalyticsCustomEventParams } from "../../../GoogleAnalytics.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface ShareParams
+ * @since 0.5.14
+ * @extends GoogleAnalyticsCommonEventParams
+ * @extends GoogleAnalyticsCustomEventParams
+ * @extends ShareCommonParams
+ * @property {string} contentType The type of shared content
+ */
+export interface ShareParams extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, ShareCommonParams {
+    contentType?: string;
+}

package/build/src/lib/providers/GoogleAnalytics/events/store/changeStore/changeStore.d.ts

@@ -0,0 +1,11 @@
+import { GoogleAnalyticsProvider } from "../../../GoogleAnalytics.types";
+import { ChangeStoreParams } from "./changeStore.types";
+/**
+ * Emits a changeStore event to a Google Analytics Provider.
+ *
+ * @since 0.5.14
+ * @param {GoogleAnalyticsProvider} provider The provider instance that will emit the event
+ * @param {ChangeStoreParams} params Event configuration parameters
+ */
+declare const changeStore: (provider: GoogleAnalyticsProvider, params: ChangeStoreParams) => void;
+export default changeStore;

package/build/src/lib/providers/GoogleAnalytics/events/store/changeStore/changeStore.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/providers/GoogleAnalytics/events/store/changeStore/changeStore.types.d.ts

@@ -0,0 +1,14 @@
+import { ChangeStoreCommonParams } from "../../../../../events/store/changeStore/changeStore.types";
+import { GoogleAnalyticsCommonEventParams } from "../../../GoogleAnalytics.types";
+import { GoogleAnalyticsCustomEventParams } from "../../../GoogleAnalytics.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface ChangeStoreParams
+ * @since 0.5.14
+ * @extends GoogleAnalyticsCommonEventParams
+ * @extends GoogleAnalyticsCustomEventParams
+ * @extends ChangeStoreCommonParams
+ */
+export interface ChangeStoreParams extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, ChangeStoreCommonParams {
+}

package/build/src/lib/providers/GoogleAnalytics/events/store/index.d.ts

@@ -0,0 +1,5 @@
+declare const events: {
+    changeStore: (provider: import("../../GoogleAnalytics.types").GoogleAnalyticsProvider, params: import("./changeStore/changeStore.types").ChangeStoreParams) => void;
+    setStore: (provider: import("../../GoogleAnalytics.types").GoogleAnalyticsProvider, params: import("./setStore/setStore.types").SetStoreParams) => void;
+};
+export default events;

package/build/src/lib/providers/GoogleAnalytics/events/store/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/providers/GoogleAnalytics/events/store/setStore/setStore.d.ts

@@ -0,0 +1,11 @@
+import { GoogleAnalyticsProvider } from "../../../GoogleAnalytics.types";
+import { SetStoreParams } from "./setStore.types";
+/**
+ * Emits a setStore event to a Google Analytics Provider.
+ *
+ * @since 0.5.14
+ * @param {GoogleAnalyticsProvider} provider The provider instance that will emit the event
+ * @param {SetStoreParams} params Event configuration parameters
+ */
+declare const setStore: (provider: GoogleAnalyticsProvider, params: SetStoreParams) => void;
+export default setStore;

package/build/src/lib/providers/GoogleAnalytics/events/store/setStore/setStore.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/providers/GoogleAnalytics/events/store/setStore/setStore.types.d.ts

@@ -0,0 +1,14 @@
+import { SetStoreCommonParams } from "../../../../../events/store/setStore/setStore.types";
+import { GoogleAnalyticsCommonEventParams } from "../../../GoogleAnalytics.types";
+import { GoogleAnalyticsCustomEventParams } from "../../../GoogleAnalytics.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface SetStoreParams
+ * @since 0.5.14
+ * @extends GoogleAnalyticsCommonEventParams
+ * @extends GoogleAnalyticsCustomEventParams
+ * @extends SetStoreCommonParams
+ */
+export interface SetStoreParams extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, SetStoreCommonParams {
+}

package/build/src/lib/providers/GoogleAnalytics/events/user/index.d.ts

@@ -0,0 +1,5 @@
+declare const events: {
+    setUserInfo: (provider: import("../../GoogleAnalytics.types").GoogleAnalyticsProvider, params: import("./setUserInfo/setUserInfo.types").SetUserInfoParams) => void;
+    updateUserInfo: (provider: import("../../GoogleAnalytics.types").GoogleAnalyticsProvider, params: import("./updateUserInfo/updateUserInfo.types").UpdateUserInfoParams) => void;
+};
+export default events;

package/build/src/lib/providers/GoogleAnalytics/events/user/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/providers/GoogleAnalytics/events/user/setUserInfo/setUserInfo.d.ts

@@ -0,0 +1,11 @@
+import { GoogleAnalyticsProvider } from "../../../GoogleAnalytics.types";
+import { SetUserInfoParams } from "./setUserInfo.types";
+/**
+ * Emits a setUserInfo event to a Google Analytics Provider.
+ *
+ * @since 0.5.14
+ * @param {GoogleAnalyticsProvider} provider The provider instance that will emit the event
+ * @param {SetUserInfoParams} params Event configuration parameters
+ */
+declare const setUserInfo: (provider: GoogleAnalyticsProvider, params: SetUserInfoParams) => void;
+export default setUserInfo;

package/build/src/lib/providers/GoogleAnalytics/events/user/setUserInfo/setUserInfo.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/providers/GoogleAnalytics/events/user/setUserInfo/setUserInfo.types.d.ts

@@ -0,0 +1,16 @@
+import { SetUserInfoCommonParams } from "../../../../../events/user/setUserInfo/setUserInfo.types";
+import { GoogleAnalyticsCommonEventParams } from "../../../GoogleAnalytics.types";
+import { GoogleAnalyticsCustomEventParams } from "../../../GoogleAnalytics.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface SetUserInfoParams
+ * @since 0.5.14
+ * @extends GoogleAnalyticsCommonEventParams
+ * @extends GoogleAnalyticsCustomEventParams
+ * @extends SetUserInfoCommonParams
+ * @property {string} userId The user's unique identifier between platforms
+ */
+export interface SetUserInfoParams extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, SetUserInfoCommonParams {
+    userId: string;
+}

package/build/src/lib/providers/GoogleAnalytics/events/user/updateUserInfo/updateUserInfo.d.ts

@@ -0,0 +1,11 @@
+import { GoogleAnalyticsProvider } from "../../../GoogleAnalytics.types";
+import { UpdateUserInfoParams } from "./updateUserInfo.types";
+/**
+ * Emits a updateUserInfo event to a Google Analytics Provider.
+ *
+ * @since 0.5.14
+ * @param {GoogleAnalyticsProvider} provider The provider instance that will emit the event
+ * @param {UpdateUserInfoParams} params Event configuration parameters
+ */
+declare const updateUserInfo: (provider: GoogleAnalyticsProvider, params: UpdateUserInfoParams) => void;
+export default updateUserInfo;

package/build/src/lib/providers/GoogleAnalytics/events/user/updateUserInfo/updateUserInfo.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/providers/GoogleAnalytics/events/user/updateUserInfo/updateUserInfo.types.d.ts

@@ -0,0 +1,16 @@
+import { UpdateUserInfoCommonParams } from "../../../../../events/user/updateUserInfo/updateUserInfo.types";
+import { GoogleAnalyticsCommonEventParams } from "../../../GoogleAnalytics.types";
+import { GoogleAnalyticsCustomEventParams } from "../../../GoogleAnalytics.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface UpdateUserInfoParams
+ * @since 0.5.14
+ * @extends GoogleAnalyticsCommonEventParams
+ * @extends GoogleAnalyticsCustomEventParams
+ * @extends UpdateUserInfoCommonParams
+ * @property {string} userId The user's unique identifier between platforms
+ */
+export interface UpdateUserInfoParams extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, UpdateUserInfoCommonParams {
+    userId: string;
+}

package/build/src/lib/providers/GoogleAnalytics/events/vendor/changeVendor/changeVendor.d.ts

@@ -0,0 +1,11 @@
+import { GoogleAnalyticsProvider } from "../../../GoogleAnalytics.types";
+import { ChangeVendorParams } from "./changeVendor.types";
+/**
+ * Emits a changeVendor event to a Google Analytics Provider.
+ *
+ * @since 0.5.14
+ * @param {GoogleAnalyticsProvider} provider The provider instance that will emit the event
+ * @param {ChangeVendorParams} params Event configuration parameters
+ */
+declare const changeVendor: (provider: GoogleAnalyticsProvider, params: ChangeVendorParams) => void;
+export default changeVendor;

package/build/src/lib/providers/GoogleAnalytics/events/vendor/changeVendor/changeVendor.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/providers/GoogleAnalytics/events/vendor/changeVendor/changeVendor.types.d.ts

@@ -0,0 +1,14 @@
+import { ChangeVendorCommonParams } from "../../../../../events/vendor/changeVendor/changeVendor.types";
+import { GoogleAnalyticsCommonEventParams } from "../../../GoogleAnalytics.types";
+import { GoogleAnalyticsCustomEventParams } from "../../../GoogleAnalytics.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface ChangeVendorParams
+ * @since 0.5.14
+ * @extends GoogleAnalyticsCommonEventParams
+ * @extends GoogleAnalyticsCustomEventParams
+ * @extends ChangeVendorCommonParams
+ */
+export interface ChangeVendorParams extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, ChangeVendorCommonParams {
+}

package/build/src/lib/providers/GoogleAnalytics/events/vendor/index.d.ts

@@ -0,0 +1,5 @@
+declare const events: {
+    changeVendor: (provider: import("../../GoogleAnalytics.types").GoogleAnalyticsProvider, params: import("./changeVendor/changeVendor.types").ChangeVendorParams) => void;
+    setVendor: (provider: import("../../GoogleAnalytics.types").GoogleAnalyticsProvider, params: import("./setVendor/setVendor.types").SetVendorParams) => void;
+};
+export default events;

package/build/src/lib/providers/GoogleAnalytics/events/vendor/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/providers/GoogleAnalytics/events/vendor/setVendor/setVendor.d.ts

@@ -0,0 +1,11 @@
+import { GoogleAnalyticsProvider } from "../../../GoogleAnalytics.types";
+import { SetVendorParams } from "./setVendor.types";
+/**
+ * Emits a setVendor event to a Google Analytics Provider.
+ *
+ * @since 0.5.14
+ * @param {GoogleAnalyticsProvider} provider The provider instance that will emit the event
+ * @param {SetVendorParams} params Event configuration parameters
+ */
+declare const setVendor: (provider: GoogleAnalyticsProvider, params: SetVendorParams) => void;
+export default setVendor;

package/build/src/lib/providers/GoogleAnalytics/events/vendor/setVendor/setVendor.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/providers/GoogleAnalytics/events/vendor/setVendor/setVendor.types.d.ts

@@ -0,0 +1,14 @@
+import { SetVendorCommonParams } from "../../../../../events/vendor/setVendor/setVendor.types";
+import { GoogleAnalyticsCommonEventParams } from "../../../GoogleAnalytics.types";
+import { GoogleAnalyticsCustomEventParams } from "../../../GoogleAnalytics.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface SetVendorParams
+ * @since 0.5.14
+ * @extends GoogleAnalyticsCommonEventParams
+ * @extends GoogleAnalyticsCustomEventParams
+ * @extends SetVendorCommonParams
+ */
+export interface SetVendorParams extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, SetVendorCommonParams {
+}

package/build/src/lib/providers/GoogleAnalytics/events/workflow/index.d.ts

@@ -0,0 +1,5 @@
+declare const events: {
+    selectWorkflow: (provider: import("../../GoogleAnalytics.types").GoogleAnalyticsProvider, params: import("./selectWorkflow/selectWorkflow.types").SelectWorkflowParams) => void;
+    updateWorkflow: (provider: import("../../GoogleAnalytics.types").GoogleAnalyticsProvider, params: import("./updateWorkflow/updateWorkflow.types").UpdateWorkflowParams) => void;
+};
+export default events;

package/build/src/lib/providers/GoogleAnalytics/events/workflow/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/providers/GoogleAnalytics/events/workflow/selectWorkflow/selectWorkflow.d.ts

@@ -0,0 +1,11 @@
+import { GoogleAnalyticsProvider } from "../../../GoogleAnalytics.types";
+import { SelectWorkflowParams } from "./selectWorkflow.types";
+/**
+ * Emits a selectWorkflow event to a Google Analytics Provider.
+ *
+ * @since 0.5.14
+ * @param {GoogleAnalyticsProvider} provider The provider instance that will emit the event
+ * @param {SelectWorkflowParams} params Event configuration parameters
+ */
+declare const selectWorkflow: (provider: GoogleAnalyticsProvider, params: SelectWorkflowParams) => void;
+export default selectWorkflow;

package/build/src/lib/providers/GoogleAnalytics/events/workflow/selectWorkflow/selectWorkflow.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/providers/GoogleAnalytics/events/workflow/selectWorkflow/selectWorkflow.types.d.ts

@@ -0,0 +1,14 @@
+import { SelectWorkflowCommonParams } from "../../../../../events/workflow/selectWorkflow/selectWorkflow.types";
+import { GoogleAnalyticsCommonEventParams } from "../../../GoogleAnalytics.types";
+import { GoogleAnalyticsCustomEventParams } from "../../../GoogleAnalytics.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface SelectWorkflowParams
+ * @since 0.5.14
+ * @extends GoogleAnalyticsCommonEventParams
+ * @extends GoogleAnalyticsCustomEventParams
+ * @extends SelectWorkflowCommonParams
+ */
+export interface SelectWorkflowParams extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, SelectWorkflowCommonParams {
+}

package/build/src/lib/providers/GoogleAnalytics/events/workflow/updateWorkflow/updateWorkflow.d.ts

@@ -0,0 +1,11 @@
+import { GoogleAnalyticsProvider } from "../../../GoogleAnalytics.types";
+import { UpdateWorkflowParams } from "./updateWorkflow.types";
+/**
+ * Emits a updateWorkflow event to a Google Analytics Provider.
+ *
+ * @since 0.5.14
+ * @param {GoogleAnalyticsProvider} provider The provider instance that will emit the event
+ * @param {UpdateWorkflowParams} params Event configuration parameters
+ */
+declare const updateWorkflow: (provider: GoogleAnalyticsProvider, params: UpdateWorkflowParams) => void;
+export default updateWorkflow;

package/build/src/lib/providers/GoogleAnalytics/events/workflow/updateWorkflow/updateWorkflow.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/providers/GoogleAnalytics/events/workflow/updateWorkflow/updateWorkflow.types.d.ts

@@ -0,0 +1,14 @@
+import { UpdateWorkflowCommonParams } from "../../../../../events/workflow/updateWorkflow/updateWorkflow.types";
+import { GoogleAnalyticsCommonEventParams } from "../../../GoogleAnalytics.types";
+import { GoogleAnalyticsCustomEventParams } from "../../../GoogleAnalytics.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface UpdateWorkflowParams
+ * @since 0.5.14
+ * @extends GoogleAnalyticsCommonEventParams
+ * @extends GoogleAnalyticsCustomEventParams
+ * @extends UpdateWorkflowCommonParams
+ */
+export interface UpdateWorkflowParams extends GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, UpdateWorkflowCommonParams {
+}

package/build/src/lib/providers/providers.d.ts

@@ -0,0 +1,7 @@
+import FacebookPixel from "./FacebookPixel/FacebookPixel";
+import GoogleAnalytics from "./GoogleAnalytics/GoogleAnalytics";
+declare const Providers: {
+    FacebookPixel: typeof FacebookPixel;
+    GoogleAnalytics: typeof GoogleAnalytics;
+};
+export default Providers;

package/build/src/test/exports.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/types/common.types.d.ts

@@ -0,0 +1,55 @@
+import { Account, ArtisanPlatform, Channel } from "@artisan-commerce/types";
+import { Store, Vendor } from "@artisan-commerce/types";
+import { FacebookPixelProviderConfig } from "../lib/providers/FacebookPixel/FacebookPixel.types";
+import { GoogleAnalyticsProviderConfig } from "../lib/providers/GoogleAnalytics/GoogleAnalytics.types";
+/**
+ * Analytics providers configurable options.
+ *
+ * @typedef ArtisanPlatform
+ * @since 0.5.14
+ */
+export declare type AnalyticsProvidersConfigs = Partial<GoogleAnalyticsProviderConfig> | Partial<FacebookPixelProviderConfig>;
+/**
+ * Analytics event metadata to be included in every sent event.
+ *
+ * @interface ArtisanPlatform
+ * @since 0.5.14
+ * @property {number} accountId the id of the account it is running on
+ * @property {number} vendorId the id of the active vendor
+ * @property {string} vendorName the name of the active vendor
+ * @property {number} storeId the id of the active store
+ * @property {string} storeName the name of the active store
+ * @property {number} catalogueId the id of the active catalogue
+ * @property {string} catalogueName the name of the active catalogue
+ * @property {string} versionSDK the Analytics SDK version
+ * @property {string} versionApp the running on app version
+ * @property {string} appName the name of the app
+ * @property {ArtisanPlatform} platform the type of platform it is running on
+ */
+export interface AnalyticsMeta {
+    accountId: Account["accountId"];
+    vendorId: Vendor["id"];
+    vendorName: Vendor["name"];
+    storeId: Store["storeId"];
+    storeName: Store["storeName"];
+    catalogueId: Channel["id"];
+    catalogueName: Channel["name"];
+    versionSDK: string;
+    versionApp: string;
+    appName: string;
+    platform: ArtisanPlatform;
+}
+/**
+ * Analytics supported providers.
+ *
+ * @typedef ArtisanPlatform
+ * @since 0.5.14
+ */
+export declare type SupportedProviders = "GOOGLE_ANALYTICS" | "FACEBOOK_PIXEL";
+/**
+ * Supported auth providers methods.
+ *
+ * @typedef AuthProviderMethods
+ * @since 0.5.14
+ */
+export declare type AuthProviderMethods = "Google" | "Facebook" | "Apple" | "Email and Password" | "Phone";

package/build/src/types/event.types.d.ts

@@ -0,0 +1,221 @@
+import { CurrencyCodes } from "@artisan-commerce/types";
+import AnalyticsProvider from "../lib/providers/AnalyticsProvider/AnalyticsProvider";
+import { FacebookPixelProvider } from "../lib/providers/FacebookPixel/FacebookPixel.types";
+import GlobalProvider from "../lib/providers/GlobalProvider/GlobalProvider";
+import { GoogleAnalyticsProvider } from "../lib/providers/GoogleAnalytics/GoogleAnalytics.types";
+/**
+ * Types of artisan analytics providers
+ *
+ * @typedef AnalyticsProviderTypes
+ * @since 0.5.14
+ */
+export declare type AnalyticsProviderTypes = AnalyticsProvider | GlobalProvider;
+/**
+ * Artisan Auth event names type
+ *
+ * @typedef ArtisanAuthEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanAuthEventNames = "changePasswordAttempt" | "changePasswordFail" | "changePasswordSuccess" | "signIn" | "signOut" | "signUp" | "signUpAttempt";
+/**
+ * Artisan Banner event names type
+ *
+ * @typedef ArtisanBannerEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanBannerEventNames = "bannerImpression" | "selectBanner";
+/**
+ * Artisan Billing event names type
+ *
+ * @typedef ArtisanBillingEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanBillingEventNames = "addBillingInfo" | "selectBillingInfo" | "updateBillingInfo";
+/**
+ * Artisan Booking event names type
+ *
+ * @typedef ArtisanBookingEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanBookingEventNames = "bookAppointment";
+/**
+ * Artisan Category event names type
+ *
+ * @typedef ArtisanCategoryEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanCategoryEventNames = "categoryImpression" | "searchCategoryAttempt" | "selectCategory" | "viewCategory";
+/**
+ * Artisan Checkout event names type
+ *
+ * @typedef ArtisanCheckoutEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanCheckoutEventNames = "checkoutAction" | "initiateCheckout";
+/**
+ * Artisan Coupon event names type
+ *
+ * @typedef ArtisanCouponEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanCouponEventNames = "applyBenefit" | "couponCodeError" | "redeemCouponCode" | "removeBenefit" | "viewBenefitDetails" | "viewBenefitsWallet" | "viewQRStoreCoupon";
+/**
+ * Artisan Credit event names type
+ *
+ * @typedef ArtisanCreditEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanCreditEventNames = "addCredits" | "spendCredits" | "viewCredits";
+/**
+ * Artisan Fulfillment event names type
+ *
+ * @typedef ArtisanFulfillmentEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanFulfillmentEventNames = "viewFulfillmentStep" | "viewTracking";
+/**
+ * Artisan Geo event names type
+ *
+ * @typedef ArtisanGeoEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanGeoEventNames = "changeLocation" | "findLocation" | "outOfCoverage" | "setLocation";
+/**
+ * Artisan Help event names type
+ *
+ * @typedef ArtisanHelpEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanHelpEventNames = "requestAssistance";
+/**
+ * Artisan Loyalty event names type
+ *
+ * @typedef ArtisanLoyaltyEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanLoyaltyEventNames = "earnPoints" | "sharePoints" | "spendPoints" | "viewLoyaltyLevel";
+/**
+ * Artisan Order event names type
+ *
+ * @typedef ArtisanOrderEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanOrderEventNames = "cancelOrder" | "rateOrder" | "requestRefund";
+/**
+ * Artisan Other event names type
+ *
+ * @typedef ArtisanOtherEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanOtherEventNames = "generateLead" | "pageView" | "searchPageContent";
+/**
+ * Artisan Payment event names type
+ *
+ * @typedef ArtisanPaymentEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanPaymentEventNames = "changePaymentType" | "selectPaymentType" | "setPaymentInfo";
+/**
+ * Artisan Product event names type
+ *
+ * @typedef ArtisanProductEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanProductEventNames = "customizeProduct" | "filterProducts" | "productImpression" | "searchProductAttempt" | "searchProductNotFound" | "searchProductSuccess" | "selectProduct" | "sortProducts" | "viewProductDetails";
+/**
+ * Artisan Purchase event names type
+ *
+ * @typedef ArtisanPurchaseEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanPurchaseEventNames = "purchaseAttempt" | "purchaseFail" | "purchaseSuccess";
+/**
+ * Artisan Settings event names type
+ *
+ * @typedef ArtisanSettingsEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanSettingsEventNames = "viewSettings";
+/**
+ * Artisan Shipping event names type
+ *
+ * @typedef ArtisanShippingEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanShippingEventNames = "addShippingAddress" | "selectShippingAddress" | "updateShippingAddress";
+/**
+ * Artisan ShoppingCart event names type
+ *
+ * @typedef ArtisanShoppingCartEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanShoppingCartEventNames = "addProductToCart" | "addProductToWishlist" | "clearCart" | "removeProductFromCart" | "removeProductFromWishlist" | "updateProductInCart" | "updateProductInWishlist" | "viewCart";
+/**
+ * Artisan Social event names type
+ *
+ * @typedef ArtisanSocialEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanSocialEventNames = "share";
+/**
+ * Artisan Store event names type
+ *
+ * @typedef ArtisanStoreEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanStoreEventNames = "changeStore" | "setStore";
+/**
+ * Artisan User event names type
+ *
+ * @typedef ArtisanUserEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanUserEventNames = "setUserInfo" | "updateUserInfo";
+/**
+ * Artisan Vendor event names type
+ *
+ * @typedef ArtisanVendorEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanVendorEventNames = "changeVendor" | "setVendor";
+/**
+ * Artisan Workflow event names type
+ *
+ * @typedef ArtisanWorkflowEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanWorkflowEventNames = "selectWorkflow" | "updateWorkflow";
+/**
+ * Artisan  event names type
+ *
+ * @typedef ArtisanEventNames
+ * @since 0.5.14
+ */
+export declare type ArtisanEventNames = ArtisanAuthEventNames | ArtisanBannerEventNames | ArtisanBillingEventNames | ArtisanBookingEventNames | ArtisanCategoryEventNames | ArtisanCheckoutEventNames | ArtisanCouponEventNames | ArtisanCreditEventNames | ArtisanFulfillmentEventNames | ArtisanGeoEventNames | ArtisanHelpEventNames | ArtisanLoyaltyEventNames | ArtisanOrderEventNames | ArtisanOtherEventNames | ArtisanPaymentEventNames | ArtisanProductEventNames | ArtisanPurchaseEventNames | ArtisanSettingsEventNames | ArtisanShippingEventNames | ArtisanShoppingCartEventNames | ArtisanSocialEventNames | ArtisanStoreEventNames | ArtisanUserEventNames | ArtisanVendorEventNames | ArtisanWorkflowEventNames;
+/**
+ * ProvidersHandlers interface
+ *
+ * @interface ProvidersHandlers
+ * @since 0.5.14
+ * @property {Function} googleAnalyticsHandler Google Analytics event handler
+ * @property {Function} facebookPixelHandler Facebook Pixel event handler
+ */
+export interface ProvidersHandlers<T> {
+    googleAnalyticsHandler: (provider: GoogleAnalyticsProvider, params: T) => void;
+    facebookPixelHandler: (provider: FacebookPixelProvider, params: T) => void;
+}
+/**
+ * Shared params across every event.
+ *
+ * @interface EventCommonParams
+ * @author Luis Eduardo Andrade
+ * @since 0.5.14
+ * @property {string} userId The unique identifier of a user across platforms
+ * @property {boolean} isAnonymous Whether the user is registered or not
+ * @property {CurrencyCodes} currency user's country monetary code
+ */
+export interface EventCommonParams {
+    userId?: string;
+    isAnonymous?: boolean;
+    currency?: CurrencyCodes;
+}