@artisan-commerce/analytics-rn 0.2.0-canary.18 → 0.2.0-canary.2

package/build/analytics-rn/src/lib/events/shoppingCart/updateProductInWishlist/updateProductInWishlist.types.d.ts

@@ -1,7 +1,6 @@
 import { CartProduct, ShoppingCart } from "@artisan-commerce/types";
 import { UpdateProductInWishlistParams as GoogleUpdateProductInWishlistParams } from "../../../providers/GoogleAnalytics/events/shoppingCart/updateProductInWishlist/updateProductInWishlist.types";
 import { UpdateProductInWishlistParams as FacebookUpdateProductInWishlistParams } from "../../../providers/FacebookPixel/events/shoppingCart/updateProductInWishlist/updateProductInWishlist.types";
-import { UpdateProductInWishlistParams as SegmentUpdateProductInWishlistParams } from "../../../providers/Segment/events/shoppingCart/updateProductInWishlist/updateProductInWishlist.types";
 /**
  * updateProductInWishlist event interface.
  *
@@ -22,4 +21,4 @@ export interface UpdateProductInWishlistCommonParams {
  * @typedef UpdateProductInWishlistParams
  * @since 0.5.14
  */
-export declare type UpdateProductInWishlistParams = GoogleUpdateProductInWishlistParams & FacebookUpdateProductInWishlistParams & SegmentUpdateProductInWishlistParams;
+export declare type UpdateProductInWishlistParams = GoogleUpdateProductInWishlistParams & FacebookUpdateProductInWishlistParams;

package/build/analytics-rn/src/lib/events/shoppingCart/viewCart/viewCart.types.d.ts

@@ -1,6 +1,5 @@
 import { ViewCartParams as GoogleViewCartParams } from "../../../providers/GoogleAnalytics/events/shoppingCart/viewCart/viewCart.types";
 import { ViewCartParams as FacebookViewCartParams } from "../../../providers/FacebookPixel/events/shoppingCart/viewCart/viewCart.types";
-import { ViewCartParams as SegmentViewCartParams } from "../../../providers/Segment/events/shoppingCart/viewCart/viewCart.types";
 import { ShoppingCart } from "@artisan-commerce/types";
 /**
  * viewCart event interface
@@ -20,4 +19,4 @@ export interface ViewCartCommonParams {
  * @typedef ViewCartParams
  * @since 0.5.14
  */
-export declare type ViewCartParams = GoogleViewCartParams & FacebookViewCartParams & SegmentViewCartParams;
+export declare type ViewCartParams = GoogleViewCartParams & FacebookViewCartParams;

package/build/analytics-rn/src/lib/events/social/share/share.types.d.ts

@@ -1,6 +1,5 @@
 import { ShareParams as GoogleShareParams } from "../../../providers/GoogleAnalytics/events/social/share/share.types";
 import { ShareParams as FacebookShareParams } from "../../../providers/FacebookPixel/events/social/share/share.types";
-import { ShareParams as SegmentShareParams } from "../../../providers/Segment/events/social/share/share.types";
 /**
  * share event interface
  *
@@ -21,4 +20,4 @@ export interface ShareCommonParams {
  * @typedef ShareParams
  * @since 0.5.14
  */
-export declare type ShareParams = GoogleShareParams & FacebookShareParams & SegmentShareParams;
+export declare type ShareParams = GoogleShareParams & FacebookShareParams;

package/build/analytics-rn/src/lib/events/store/changeStore/changeStore.types.d.ts

@@ -1,7 +1,6 @@
 import { Store } from "@artisan-commerce/types";
 import { ChangeStoreParams as GoogleChangeStoreParams } from "../../../providers/GoogleAnalytics/events/store/changeStore/changeStore.types";
 import { ChangeStoreParams as FacebookChangeStoreParams } from "../../../providers/FacebookPixel/events/store/changeStore/changeStore.types";
-import { ChangeStoreParams as SegmentChangeStoreParams } from "../../../providers/Segment/events/store/changeStore/changeStore.types";
 /**
  * changeStore event interface
  *
@@ -20,4 +19,4 @@ export interface ChangeStoreCommonParams {
  * @typedef ChangeStoreParams
  * @since 0.5.14
  */
-export declare type ChangeStoreParams = GoogleChangeStoreParams & FacebookChangeStoreParams & SegmentChangeStoreParams;
+export declare type ChangeStoreParams = GoogleChangeStoreParams & FacebookChangeStoreParams;

package/build/analytics-rn/src/lib/events/store/setStore/setStore.types.d.ts

@@ -1,7 +1,6 @@
 import { Store } from "@artisan-commerce/types";
 import { SetStoreParams as GoogleSetStoreParams } from "../../../providers/GoogleAnalytics/events/store/setStore/setStore.types";
 import { SetStoreParams as FacebookSetStoreParams } from "../../../providers/FacebookPixel/events/store/setStore/setStore.types";
-import { SetStoreParams as SegmentSetStoreParams } from "../../../providers/Segment/events/store/setStore/setStore.types";
 /**
  * setStore event interface.
  *
@@ -18,4 +17,4 @@ export interface SetStoreCommonParams {
  * @typedef SetStoreParams
  * @since 0.5.14
  */
-export declare type SetStoreParams = GoogleSetStoreParams & FacebookSetStoreParams & SegmentSetStoreParams;
+export declare type SetStoreParams = GoogleSetStoreParams & FacebookSetStoreParams;

package/build/analytics-rn/src/lib/events/user/setUserInfo/setUserInfo.types.d.ts

@@ -1,6 +1,5 @@
 import { SetUserInfoParams as GoogleSetUserInfoParams } from "../../../providers/GoogleAnalytics/events/user/setUserInfo/setUserInfo.types";
 import { SetUserInfoParams as FacebookSetUserInfoParams } from "../../../providers/FacebookPixel/events/user/setUserInfo/setUserInfo.types";
-import { SetUserInfoParams as SegmentSetUserInfoParams } from "../../../providers/Segment/events/user/setUserInfo/setUserInfo.types";
 /**
  * setUserInfo event interface.
  *
@@ -15,4 +14,4 @@ export interface SetUserInfoCommonParams {
  * @typedef SetUserInfoParams
  * @since 0.5.14
  */
-export declare type SetUserInfoParams = GoogleSetUserInfoParams & FacebookSetUserInfoParams & SegmentSetUserInfoParams;
+export declare type SetUserInfoParams = GoogleSetUserInfoParams & FacebookSetUserInfoParams;

package/build/analytics-rn/src/lib/events/user/updateUserInfo/updateUserInfo.types.d.ts

@@ -1,6 +1,5 @@
 import { UpdateUserInfoParams as GoogleUpdateUserInfoParams } from "../../../providers/GoogleAnalytics/events/user/updateUserInfo/updateUserInfo.types";
 import { UpdateUserInfoParams as FacebookUpdateUserInfoParams } from "../../../providers/FacebookPixel/events/user/updateUserInfo/updateUserInfo.types";
-import { UpdateUserInfoParams as SegmentUpdateUserInfoParams } from "../../../providers/Segment/events/user/updateUserInfo/updateUserInfo.types";
 /**
  * updateUserInfo event interface.
  *
@@ -17,4 +16,4 @@ export interface UpdateUserInfoCommonParams {
  * @typedef UpdateUserInfoParams
  * @since 0.5.14
  */
-export declare type UpdateUserInfoParams = GoogleUpdateUserInfoParams & FacebookUpdateUserInfoParams & SegmentUpdateUserInfoParams;
+export declare type UpdateUserInfoParams = GoogleUpdateUserInfoParams & FacebookUpdateUserInfoParams;

package/build/analytics-rn/src/lib/events/vendor/changeVendor/changeVendor.types.d.ts

@@ -1,7 +1,6 @@
 import { Vendor } from "@artisan-commerce/types";
 import { ChangeVendorParams as GoogleChangeVendorParams } from "../../../providers/GoogleAnalytics/events/vendor/changeVendor/changeVendor.types";
 import { ChangeVendorParams as FacebookChangeVendorParams } from "../../../providers/FacebookPixel/events/vendor/changeVendor/changeVendor.types";
-import { ChangeVendorParams as SegmentChangeVendorParams } from "../../../providers/Segment/events/vendor/changeVendor/changeVendor.types";
 /**
  * changeVendor event interface.
  *
@@ -24,4 +23,4 @@ export interface ChangeVendorCommonParams {
  * @typedef ChangeVendorParams
  * @since 0.5.14
  */
-export declare type ChangeVendorParams = GoogleChangeVendorParams & FacebookChangeVendorParams & SegmentChangeVendorParams;
+export declare type ChangeVendorParams = GoogleChangeVendorParams & FacebookChangeVendorParams;

package/build/analytics-rn/src/lib/events/vendor/setVendor/setVendor.types.d.ts

@@ -1,7 +1,6 @@
 import { Vendor } from "@artisan-commerce/types";
 import { SetVendorParams as GoogleSetVendorParams } from "../../../providers/GoogleAnalytics/events/vendor/setVendor/setVendor.types";
 import { SetVendorParams as FacebookSetVendorParams } from "../../../providers/FacebookPixel/events/vendor/setVendor/setVendor.types";
-import { SetVendorParams as SegmentSetVendorParams } from "../../../providers/Segment/events/vendor/setVendor/setVendor.types";
 /**
  * setVendor event interface.
  *
@@ -20,4 +19,4 @@ export interface SetVendorCommonParams {
  * @typedef SetVendorParams
  * @since 0.5.14
  */
-export declare type SetVendorParams = GoogleSetVendorParams & FacebookSetVendorParams & SegmentSetVendorParams;
+export declare type SetVendorParams = GoogleSetVendorParams & FacebookSetVendorParams;

package/build/analytics-rn/src/lib/events/workflow/selectWorkflow/selectWorkflow.types.d.ts

@@ -1,6 +1,5 @@
 import { SelectWorkflowParams as GoogleSelectWorkflowParams } from "../../../providers/GoogleAnalytics/events/workflow/selectWorkflow/selectWorkflow.types";
 import { SelectWorkflowParams as FacebookSelectWorkflowParams } from "../../../providers/FacebookPixel/events/workflow/selectWorkflow/selectWorkflow.types";
-import { SelectWorkflowParams as SegmentSelectWorkflowParams } from "../../../providers/Segment/events/workflow/selectWorkflow/selectWorkflow.types";
 import { Workflow } from "../../events.types";
 /**
  * selectWorkflow event interface.
@@ -18,4 +17,4 @@ export interface SelectWorkflowCommonParams {
  * @typedef SelectWorkflowParams
  * @since 0.5.14
  */
-export declare type SelectWorkflowParams = GoogleSelectWorkflowParams & FacebookSelectWorkflowParams & SegmentSelectWorkflowParams;
+export declare type SelectWorkflowParams = GoogleSelectWorkflowParams & FacebookSelectWorkflowParams;

package/build/analytics-rn/src/lib/events/workflow/updateWorkflow/updateWorkflow.types.d.ts

@@ -1,6 +1,5 @@
 import { UpdateWorkflowParams as GoogleUpdateWorkflowParams } from "../../../providers/GoogleAnalytics/events/workflow/updateWorkflow/updateWorkflow.types";
 import { UpdateWorkflowParams as FacebookUpdateWorkflowParams } from "../../../providers/FacebookPixel/events/workflow/updateWorkflow/updateWorkflow.types";
-import { UpdateWorkflowParams as SegmentUpdateWorkflowParams } from "../../../providers/Segment/events/workflow/updateWorkflow/updateWorkflow.types";
 import { Workflow } from "../../events.types";
 /**
  * updateWorkflow event interface.
@@ -20,4 +19,4 @@ export interface UpdateWorkflowCommonParams {
  * @typedef UpdateWorkflowParams
  * @since 0.5.14
  */
-export declare type UpdateWorkflowParams = GoogleUpdateWorkflowParams & FacebookUpdateWorkflowParams & SegmentUpdateWorkflowParams;
+export declare type UpdateWorkflowParams = GoogleUpdateWorkflowParams & FacebookUpdateWorkflowParams;

package/build/analytics-rn/src/lib/initAnalytics/initAnalytics.types.d.ts

@@ -1,21 +1,9 @@
 import { Vendor } from "@artisan-commerce/types";
 import { AnalyticsMeta } from "../../types/common.types";
-import AnalyticsProvider from "../providers/AnalyticsProvider/AnalyticsProvider";
-/**
- * Initial configuration that can be passed to initAnalytics method.
- *
- * @interface InitAnalyticsConfig
- * @since 0.5.14
- * @property {AnalyticsProviderTypes[]} providers Analytics providers instances that can be targeted to emit events
- * @property {number} activeVendor The vendor that will emit the events
- * @property {number[]|undefined} vendors List of vendors that can emit events if active
- * @property {boolean} debug Debug mode
- * @property {InitAnalyticsConfigMeta} meta Commerce's metadata
- */
 export interface InitAnalyticsConfig {
-    providers: AnalyticsProvider[];
+    providers: any[];
     activeVendor?: Vendor["id"];
-    vendors: Vendor["id"][] | undefined;
+    vendors: Vendor["id"][];
     debug?: boolean;
     meta: InitAnalyticsConfigMeta;
 }

package/build/analytics-rn/src/lib/providers/AnalyticsProvider/AnalyticsProvider.d.ts

@@ -7,7 +7,6 @@ import { IAnaliticsProvider } from "./AnalyticsProvider.types";
  * @since 0.5.14
  */
 declare abstract class AnalyticsProvider implements IAnaliticsProvider {
-    private initialized;
     readonly type: Config["type"];
     readonly name: Config["name"];
     private readonly _vendors;
@@ -25,13 +24,7 @@ declare abstract class AnalyticsProvider implements IAnaliticsProvider {
      * @since 0.5.14
      * @returns Analytics Provider vendors, if not specified it fallsback to the global vendors
      */
-    get vendors(): number[] | undefined;
-    /**
-     * Runs any specific platform script to initialize the SDK.
-     *
-     * @since 0.5.14
-     */
-    init(): void;
+    get vendors(): number[];
     /**
      * Updates the provider instance config for the next events.
      *

package/build/analytics-rn/src/lib/providers/AnalyticsProvider/AnalyticsProvider.types.d.ts

@@ -19,12 +19,10 @@ export interface AnalyticsProviderConstructor {
  *
  * @interface IAnaliticsProvider
  * @since 0.5.14
- * @property {Function} init Initializes the provider connection
  * @property {Function} updateConfig Updates the initial config of the provider
- * @property {number[]} vendors The provider selected vendors ids
+ * @property {Function} getVendors Return the provider selected vendors
  */
 export interface IAnaliticsProvider {
-    init: () => void;
     updateConfig: (config: Partial<unknown>) => void;
-    vendors: Vendor["id"][] | undefined;
+    vendors: Vendor["id"][];
 }

package/build/analytics-rn/src/lib/providers/FacebookPixel/FacebookPixel.types.d.ts

@@ -40,3 +40,19 @@ export interface FacebookPixelCommonEventParams extends EventCommonParams {
 export interface FacebookPixelCustomEventParams {
     [key: string]: any;
 }
+export declare namespace Fbq {
+    interface Fbq {
+        (command: "trackSingle", targetId: string, eventName: EventNames, eventParams?: ControlParams | EventParams | CustomParams): void;
+        (command: "trackSingleCustom", targetId: string, eventName: string, eventParams?: ControlParams | EventParams | CustomParams): void;
+    }
+    interface CustomParams {
+        [key: string]: any;
+    }
+    interface ControlParams {
+    }
+    type EventNames = "ScreenView" | "CompleteRegistration" | "FindLocation" | "Search" | "CustomizeProduct" | "InitiateCheckout" | "AddPaymentInfo" | "Schedule" | "Purchase" | "Lead" | "AddToCart" | "AddToWishlist" | "Contact";
+    interface EventParams {
+        currency?: string;
+        value?: number;
+    }
+}

package/build/analytics-rn/src/lib/providers/GoogleAnalytics/GoogleAnalytics.types.d.ts

@@ -33,8 +33,10 @@ export interface GoogleAnalyticsProviderConfig {
  * @interface GoogleAnalyticsCommonEventParams
  * @since 0.5.14
  * @extends EventCommonParams
+ * @property {Function} callback Fired when event is resolved
  */
 export interface GoogleAnalyticsCommonEventParams extends EventCommonParams {
+    callback?: () => void;
 }
 /**
  * Google Analytics custom event shared parameters.
@@ -46,6 +48,44 @@ export interface GoogleAnalyticsCustomEventParams {
     [key: string]: any;
 }
 export declare namespace Gtag {
+    interface Gtag {
+        (command: "config", targetId: string, config?: ControlParams | EventParams | CustomParams): void;
+        (command: "get", targetId: string, fieldName: string, callback: (field: unknown) => void): void;
+        (command: "set", targetId: string, config: CustomParams): void;
+        (command: "event", eventName: EventNames | string, eventParams?: ControlParams | EventParams | CustomParams): void;
+    }
+    interface CustomParams {
+        [key: string]: any;
+    }
+    interface ControlParams {
+        groups?: string | string[];
+        send_to: string | string[];
+        event_callback?: () => void;
+        event_timeout?: number;
+    }
+    type EventNames = "add_payment_info" | "add_to_cart" | "add_to_wishlist" | "begin_checkout" | "earn_virtual_currency" | "exception" | "generate_lead" | "login" | "page_view" | "purchase" | "refund" | "remove_from_cart" | "screen_view" | "search" | "select_content" | "set_checkout_option" | "share" | "sign_up" | "timing_complete" | "view_item" | "view_item_list" | "view_promotion" | "view_search_results";
+    interface EventParams {
+        checkout_option?: string;
+        checkout_step?: number;
+        content_id?: string;
+        content_type?: string;
+        coupon?: string;
+        currency?: string;
+        description?: string;
+        fatal?: boolean;
+        items?: Item[];
+        method?: string;
+        number?: string;
+        promotions?: Promotion[];
+        screen_name?: string;
+        search_term?: string;
+        shipping?: Currency;
+        tax?: Currency;
+        transaction_id?: string;
+        value?: number;
+        event_label?: string;
+        event_category?: string;
+    }
     type Currency = string | number;
     interface Item {
         brand?: string;
@@ -65,4 +105,10 @@ export declare namespace Gtag {
         price?: Currency;
         quantity?: number;
     }
+    interface Promotion {
+        creative_name?: string;
+        creative_slot?: string;
+        id?: string;
+        name?: string;
+    }
 }

package/build/analytics-rn/src/lib/providers/providers.d.ts

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

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

@@ -42,7 +42,7 @@ export interface AnalyticsMeta {
  * @typedef ArtisanPlatform
  * @since 0.5.14
  */
-export declare type SupportedProviders = "GOOGLE_ANALYTICS" | "FACEBOOK_PIXEL" | "SEGMENT";
+export declare type SupportedProviders = "GOOGLE_ANALYTICS" | "FACEBOOK_PIXEL";
 /**
  * Supported auth providers methods.
  *

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

@@ -1,7 +1,6 @@
 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";
 /**
  * Artisan Auth event names type
  *
@@ -195,12 +194,12 @@ export declare type ArtisanEventNames = ArtisanAuthEventNames | ArtisanBannerEve
 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
+ * @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

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

@@ -2,7 +2,6 @@ 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.
  *
@@ -62,19 +61,3 @@ export declare const mapProductToGoogleItem: (product: CartProduct, currency?: C
  * @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/state.utils.d.ts

@@ -1,12 +1,4 @@
 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;