@artisan-commerce/analytics-rn 0.3.0-canary.7 → 0.3.0-canary.71

package/build/analytics-rn/src/types/event.types.d.ts

@@ -1,213 +0,0 @@
-import { CurrencyCodes } from "@artisan-commerce/types";
-import { FacebookPixelProvider } from "../lib/providers/FacebookPixel/FacebookPixel.types";
-import { GoogleAnalyticsProvider } from "../lib/providers/GoogleAnalytics/GoogleAnalytics.types";
-import { SegmentProvider } from "../lib/providers/Segment/Segment.types";
-/**
- * Artisn Auth event names type
- *
- * @typedef ArtisnAuthEventNames
- * @since 0.5.14
- */
-export declare type ArtisnAuthEventNames = "changePasswordAttempt" | "changePasswordFail" | "changePasswordSuccess" | "signIn" | "signOut" | "signUp" | "signUpAttempt";
-/**
- * Artisn Banner event names type
- *
- * @typedef ArtisnBannerEventNames
- * @since 0.5.14
- */
-export declare type ArtisnBannerEventNames = "bannerImpression" | "selectBanner";
-/**
- * Artisn Billing event names type
- *
- * @typedef ArtisnBillingEventNames
- * @since 0.5.14
- */
-export declare type ArtisnBillingEventNames = "addBillingInfo" | "selectBillingInfo" | "updateBillingInfo";
-/**
- * Artisn Booking event names type
- *
- * @typedef ArtisnBookingEventNames
- * @since 0.5.14
- */
-export declare type ArtisnBookingEventNames = "bookAppointment";
-/**
- * Artisn Category event names type
- *
- * @typedef ArtisnCategoryEventNames
- * @since 0.5.14
- */
-export declare type ArtisnCategoryEventNames = "categoryImpression" | "searchCategoryAttempt" | "selectCategory" | "viewCategory";
-/**
- * Artisn Checkout event names type
- *
- * @typedef ArtisnCheckoutEventNames
- * @since 0.5.14
- */
-export declare type ArtisnCheckoutEventNames = "checkoutAction" | "initiateCheckout";
-/**
- * Artisn Coupon event names type
- *
- * @typedef ArtisnCouponEventNames
- * @since 0.5.14
- */
-export declare type ArtisnCouponEventNames = "applyBenefit" | "couponCodeError" | "redeemCouponCode" | "removeBenefit" | "viewBenefitDetails" | "viewBenefitsWallet" | "viewQRStoreCoupon";
-/**
- * Artisn Credit event names type
- *
- * @typedef ArtisnCreditEventNames
- * @since 0.5.14
- */
-export declare type ArtisnCreditEventNames = "addCredits" | "spendCredits" | "viewCredits";
-/**
- * Artisn Fulfillment event names type
- *
- * @typedef ArtisnFulfillmentEventNames
- * @since 0.5.14
- */
-export declare type ArtisnFulfillmentEventNames = "viewFulfillmentStep" | "viewTracking";
-/**
- * Artisn Geo event names type
- *
- * @typedef ArtisnGeoEventNames
- * @since 0.5.14
- */
-export declare type ArtisnGeoEventNames = "changeLocation" | "findLocation" | "outOfCoverage" | "setLocation";
-/**
- * Artisn Help event names type
- *
- * @typedef ArtisnHelpEventNames
- * @since 0.5.14
- */
-export declare type ArtisnHelpEventNames = "requestAssistance";
-/**
- * Artisn Loyalty event names type
- *
- * @typedef ArtisnLoyaltyEventNames
- * @since 0.5.14
- */
-export declare type ArtisnLoyaltyEventNames = "earnPoints" | "sharePoints" | "spendPoints" | "viewLoyaltyLevel";
-/**
- * Artisn Order event names type
- *
- * @typedef ArtisnOrderEventNames
- * @since 0.5.14
- */
-export declare type ArtisnOrderEventNames = "cancelOrder" | "rateOrder" | "requestRefund";
-/**
- * Artisn Other event names type
- *
- * @typedef ArtisnOtherEventNames
- * @since 0.5.14
- */
-export declare type ArtisnOtherEventNames = "generateLead" | "screenView" | "searchPageContent";
-/**
- * Artisn Payment event names type
- *
- * @typedef ArtisnPaymentEventNames
- * @since 0.5.14
- */
-export declare type ArtisnPaymentEventNames = "changePaymentType" | "selectPaymentType" | "setPaymentInfo";
-/**
- * Artisn Product event names type
- *
- * @typedef ArtisnProductEventNames
- * @since 0.5.14
- */
-export declare type ArtisnProductEventNames = "customizeProduct" | "filterProducts" | "productImpression" | "searchProductAttempt" | "searchProductNotFound" | "searchProductSuccess" | "selectProduct" | "sortProducts" | "viewProductDetails";
-/**
- * Artisn Purchase event names type
- *
- * @typedef ArtisnPurchaseEventNames
- * @since 0.5.14
- */
-export declare type ArtisnPurchaseEventNames = "purchaseAttempt" | "purchaseFail" | "purchaseSuccess";
-/**
- * Artisn Settings event names type
- *
- * @typedef ArtisnSettingsEventNames
- * @since 0.5.14
- */
-export declare type ArtisnSettingsEventNames = "viewSettings";
-/**
- * Artisn Shipping event names type
- *
- * @typedef ArtisnShippingEventNames
- * @since 0.5.14
- */
-export declare type ArtisnShippingEventNames = "addShippingAddress" | "selectShippingAddress" | "updateShippingAddress";
-/**
- * Artisn ShoppingCart event names type
- *
- * @typedef ArtisnShoppingCartEventNames
- * @since 0.5.14
- */
-export declare type ArtisnShoppingCartEventNames = "addProductToCart" | "addProductToWishlist" | "clearCart" | "removeProductFromCart" | "removeProductFromWishlist" | "updateProductInCart" | "updateProductInWishlist" | "viewCart";
-/**
- * Artisn Social event names type
- *
- * @typedef ArtisnSocialEventNames
- * @since 0.5.14
- */
-export declare type ArtisnSocialEventNames = "share";
-/**
- * Artisn Store event names type
- *
- * @typedef ArtisnStoreEventNames
- * @since 0.5.14
- */
-export declare type ArtisnStoreEventNames = "changeStore" | "setStore";
-/**
- * Artisn User event names type
- *
- * @typedef ArtisnUserEventNames
- * @since 0.5.14
- */
-export declare type ArtisnUserEventNames = "setUserInfo" | "updateUserInfo";
-/**
- * Artisn Vendor event names type
- *
- * @typedef ArtisnVendorEventNames
- * @since 0.5.14
- */
-export declare type ArtisnVendorEventNames = "changeVendor" | "setVendor";
-/**
- * Artisn Workflow event names type
- *
- * @typedef ArtisnWorkflowEventNames
- * @since 0.5.14
- */
-export declare type ArtisnWorkflowEventNames = "selectWorkflow" | "updateWorkflow";
-/**
- * Artisn  event names type
- *
- * @typedef ArtisnEventNames
- * @since 0.5.14
- */
-export declare type ArtisnEventNames = ArtisnAuthEventNames | ArtisnBannerEventNames | ArtisnBillingEventNames | ArtisnBookingEventNames | ArtisnCategoryEventNames | ArtisnCheckoutEventNames | ArtisnCouponEventNames | ArtisnCreditEventNames | ArtisnFulfillmentEventNames | ArtisnGeoEventNames | ArtisnHelpEventNames | ArtisnLoyaltyEventNames | ArtisnOrderEventNames | ArtisnOtherEventNames | ArtisnPaymentEventNames | ArtisnProductEventNames | ArtisnPurchaseEventNames | ArtisnSettingsEventNames | ArtisnShippingEventNames | ArtisnShoppingCartEventNames | ArtisnSocialEventNames | ArtisnStoreEventNames | ArtisnUserEventNames | ArtisnVendorEventNames | ArtisnWorkflowEventNames;
-/**
- * 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;
-    segmentHandler: (provider: SegmentProvider, params: T) => void;
-}
-/**
- * Shared params across every event.
- *
- * @interface EventCommonParams
- * @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;
-}

package/build/analytics-rn/src/types/state.types.d.ts

@@ -1,22 +0,0 @@
-import { InitAnalyticsConfig } from "../lib/initAnalytics/initAnalytics.types";
-import { AnalyticsMeta } from "./common.types";
-declare type StrictInitAnalyticsConfig = Required<InitAnalyticsConfig>;
-export interface GlobalState {
-    providers: StrictInitAnalyticsConfig["providers"];
-    activeVendor?: StrictInitAnalyticsConfig["activeVendor"];
-    vendors: StrictInitAnalyticsConfig["vendors"];
-    debug: StrictInitAnalyticsConfig["debug"];
-    meta: GlobalStateMeta;
-}
-export interface GlobalStateMeta extends Omit<AnalyticsMeta, "accountId" | "vendorId" | "vendorName" | "storeId" | "storeName" | "catalogueId" | "catalogueName" | "appName" | "versionApp"> {
-    accountId: AnalyticsMeta["accountId"] | undefined;
-    vendorId?: AnalyticsMeta["vendorId"] | undefined;
-    vendorName?: AnalyticsMeta["vendorName"] | undefined;
-    storeId?: AnalyticsMeta["storeId"] | undefined;
-    storeName?: AnalyticsMeta["storeName"] | undefined;
-    catalogueId?: AnalyticsMeta["catalogueId"] | undefined;
-    catalogueName?: AnalyticsMeta["catalogueName"] | undefined;
-    appName?: AnalyticsMeta["appName"] | undefined;
-    versionApp?: AnalyticsMeta["versionApp"] | undefined;
-}
-export {};

package/build/analytics-rn/src/utils/common.utils.d.ts

@@ -1,8 +0,0 @@
-/**
- * Update the event prameters keys to be in snake case.
- *
- * @since 0.5.14
- * @param {T} params Event parameters to be transformed
- * @returns {T} Event parameters with its keys in snake case
- */
-export declare const eventParamsToSnakeCase: <T>(params: T) => T;

package/build/analytics-rn/src/utils/events.utils.d.ts

@@ -1,80 +0,0 @@
-import { CartProduct, CurrencyCodes, Product } from "@artisan-commerce/types";
-import { ShoppingCart } from "@artisan-commerce/types";
-import { ProvidersHandlers } from "../types/event.types";
-import { Gtag } from "../lib/providers/GoogleAnalytics/GoogleAnalytics.types";
-import { Segment } from "../lib/providers/Segment/Segment.types";
-/**
- * Triage event to each provider handler.
- *
- * @since 0.5.14
- * @param {string} eventName The Artisn event name
- * @param {T} params The event parameters
- * @param {ProvidersHandlers<T>} providersHandlers The providers handlers
- */
-export declare const triageEventToProviders: <T>(eventName: string, params: T, providersHandlers: ProvidersHandlers<T>) => void;
-/**
- * Gets an array of the product ids in the shopping cart.
- *
- * @since 0.5.14
- * @param {ShoppingCart} shoppingCart The shopping cart with the wanted product ids
- * @returns An array of the product ids in the shopping cart
- */
-export declare const getProductIdsFromShoppingCart: (shoppingCart: ShoppingCart) => string[];
-/**
- * Gets the name and price of all shopping cart products.
- *
- * @since 0.5.14
- * @param {ShoppingCart} shoppingCart The shopping cart with the wanted product's data
- * @returns The name and price of all shopping cart products
- */
-export declare const getProductContentFromShoppingCart: (shoppingCart: ShoppingCart) => string[];
-/**
- * Gets the name and price of a product.
- *
- * @since 0.5.14
- * @param {Product} product The wanted product's data
- * @returns The name and price of a product
- */
-export declare const getProductContent: (product: Product) => string;
-/**
- * Maps the shopping cart products into google items.
- *
- * @since 0.5.14
- * @param {ShoppingCart} shoppingCart The shopping cart with the wanted product's data
- * @param {CurrencyCodes} currency Currency of the purchase or items associated with the event (e.g. USD)
- * @returns {Gtag.Item[]} An array of objects with google items data
- */
-export declare const mapProductsToGoogleItems: (shoppingCart: ShoppingCart, currency?: CurrencyCodes | undefined) => Gtag.Item[];
-/**
- * Maps a cart product into a google item.
- *
- * @since 0.5.14
- * @param {Product} product The wanted product's data
- * @param {CurrencyCodes} currency Currency of the purchase or items associated with the event (e.g. USD)
- * @returns {Gtag.Item} An object with Item data
- */
-export declare const mapProductToGoogleItem: (product: CartProduct, currency?: CurrencyCodes | undefined) => Gtag.Item;
-/**
- * Transform array parameter to support mobile format parameters.
- *
- * @param {unknown} param Parameter to be transformed
- * @since 0.5.14
- * @returns {string} The accepted parameter type
- */
-export declare const transformArrayParam: (param: unknown[]) => string;
-/**
- * Maps a product into a segment product.
- *
- * @since 0.5.14
- * @param {Product} product The wanted product's data
- * @returns {Segment.Product} An object with Item data
- */
-export declare const mapProductToSegmentProduct: (product: Product) => Segment.Product;
-/**
- * Maps the order products into segment products.
- *
- * @since 0.5.14
- * @param {Product[]} products The order product's data
- * @returns {Segment.Product[]} An array of objects with google items data
- */
-export declare const mapProductsToSegmentProducts: (products: Product[]) => Segment.Product[];

package/build/analytics-rn/src/utils/logs.utils.d.ts

@@ -1,49 +0,0 @@
-import AnalyticsProvider from "../lib/providers/AnalyticsProvider/AnalyticsProvider";
-import { SupportedProviders } from "../types/common.types";
-/**
- * Handles logs by level and evironment.
- *
- * @since 0.5.14
- * @param {string} message  Message to be logged
- * @param {string} type message category
- * @throws If type is severe
- * @throws If type is not one of "debug" | "log" | "warn" | "error" | "severe"
- */
-export declare const logMessage: (message: string, type: "debug" | "log" | "warn" | "error" | "severe") => void;
-/**
- * Log that the developer probably forgot to set an active vendor.
- *
- * @since 0.5.14
- */
-export declare const noActiveVendor: () => void;
-/**
- * Log that the active vendor is not one of the included vendors to receive events.
- *
- * @since 0.5.14
- * @param {string} eventName The name of the event
- * @param {string} provider the provider that will emit the event
- */
-export declare const vendorNotIncluded: (eventName: string, provider: AnalyticsProvider) => void;
-/**
- * Log that a given event has been emmited to the configured providers.
- *
- * @since 0.5.14
- * @param {string} eventName The name of the event
- * @param {AnalyticsProvider[]} providers Providers that emmited the given event
- */
-export declare const eventSent: (eventName: string, providers: AnalyticsProvider[]) => void;
-/**
- * Log that the SDK must be initialized before to try emit an event.
- *
- * @since 0.5.14
- * @param {SupportedProviders} providerType Supported providers
- */
-export declare const logProvidersSDKNotLoaded: (providerType: SupportedProviders) => void;
-/**
- * Log a provider config was updated.
- *
- * @since 0.5.14
- * @param {AnalyticsProvider} provider The provider that will emit the event
- * @param {Partial<unknown>} config Analyticis provider configured options
- */
-export declare const logProviderConfigUpdated: (provider: AnalyticsProvider, config: Partial<unknown>) => void;

package/build/analytics-rn/src/utils/segment.utils.d.ts

@@ -1,8 +0,0 @@
-import { Segment } from "../lib/providers/Segment/Segment.types";
-/**
- * Utility function to identify a user across Segment destinations.
- *
- * @since 0.5.14
- * @param {Segment.Traits} identify Pieces of information you know about a user that are included in an identify call
- */
-export declare const identifyUser: (identify: Segment.Traits) => void;

package/build/analytics-rn/src/utils/state.utils.d.ts

@@ -1,12 +0,0 @@
-import { GlobalState } from "../types/state.types";
-import { Vendor } from "@artisan-commerce/types";
-export declare const setInitialState: () => void;
-export declare const getState: () => GlobalState;
-export declare const setState: (state: Partial<GlobalState>) => void;
-/**
- * Utility function to update the active vendor.
- *
- * @since 0.5.14
- * @param {Vendor|number} vendor New active vendor
- */
-export declare const updateActiveVendor: (vendor: Vendor | Vendor["id"] | undefined) => void;

package/build/analytics-rn/src/utils/validations.utils.d.ts

@@ -1,10 +0,0 @@
-import AnalyticsProvider from "../lib/providers/AnalyticsProvider/AnalyticsProvider";
-/**
- * Checks if the event should be emmit because the active vendor is not included.
- *
- * @since 0.5.14
- * @param {string} eventName The name of the event that will be emmited
- * @param {AnalyticsProvider} provider Provider that will emit the event
- * @returns {boolean} Whether the vendor will be skipped
- */
-export declare const skipVendor: (eventName: string, provider: AnalyticsProvider) => boolean;