@artisan-commerce/analytics-rn 0.2.0-canary.1 → 0.2.0-canary.11

package/CHANGELOG.md

@@ -3,6 +3,91 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.2.0-canary.11](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/analytics-rn@0.2.0-canary.10...@artisan-commerce/analytics-rn@0.2.0-canary.11) (2021-05-05)
+
+**Note:** Version bump only for package @artisan-commerce/analytics-rn
+
+
+
+
+
+## [0.2.0-canary.10](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/analytics-rn@0.2.0-canary.9...@artisan-commerce/analytics-rn@0.2.0-canary.10) (2021-05-05)
+
+**Note:** Version bump only for package @artisan-commerce/analytics-rn
+
+
+
+
+
+## [0.2.0-canary.9](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/analytics-rn@0.2.0-canary.8...@artisan-commerce/analytics-rn@0.2.0-canary.9) (2021-04-27)
+
+
+### Bug Fixes
+
+* **global:** fix updateActiveVendor utility function and state lib ([e5d9c52](https://bitbucket.org/tradesystem/artisan_monorepo/commit/e5d9c52455929782ada1762b03abb3363efe88cf))
+
+
+
+## [0.2.0-canary.8](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/analytics-rn@0.2.0-canary.7...@artisan-commerce/analytics-rn@0.2.0-canary.8) (2021-04-23)
+
+
+### Bug Fixes
+
+* **analytics-rn:** expose util function to update active vendor ([4247982](https://bitbucket.org/tradesystem/artisan_monorepo/commit/4247982bfd6bec52db7dc28f32cd06821b724909))
+
+
+
+## [0.2.0-canary.7](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/analytics-rn@0.2.0-canary.6...@artisan-commerce/analytics-rn@0.2.0-canary.7) (2021-04-22)
+
+**Note:** Version bump only for package @artisan-commerce/analytics-rn
+
+
+
+
+
+## [0.2.0-canary.6](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/analytics-rn@0.2.0-canary.5...@artisan-commerce/analytics-rn@0.2.0-canary.6) (2021-04-21)
+
+**Note:** Version bump only for package @artisan-commerce/analytics-rn
+
+
+
+
+
+## [0.2.0-canary.5](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/analytics-rn@0.2.0-canary.4...@artisan-commerce/analytics-rn@0.2.0-canary.5) (2021-04-20)
+
+
+### Bug Fixes
+
+* **analytics-rn:** remove unused event parameter for google events ([2d76e14](https://bitbucket.org/tradesystem/artisan_monorepo/commit/2d76e1498ac4a86fe4b4172a3f5f35b39a69542f))
+
+
+
+## [0.2.0-canary.4](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/analytics-rn@0.2.0-canary.3...@artisan-commerce/analytics-rn@0.2.0-canary.4) (2021-04-19)
+
+**Note:** Version bump only for package @artisan-commerce/analytics-rn
+
+
+
+
+
+## [0.2.0-canary.3](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/analytics-rn@0.2.0-canary.2...@artisan-commerce/analytics-rn@0.2.0-canary.3) (2021-04-16)
+
+
+### Bug Fixes
+
+* **analytics-rn:** fix purchaseAttempt and purchaseFail events parameters ([a2ab693](https://bitbucket.org/tradesystem/artisan_monorepo/commit/a2ab693622c284ca4712fa8bd80e133636efb34a))
+
+
+
+## [0.2.0-canary.2](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/analytics-rn@0.2.0-canary.1...@artisan-commerce/analytics-rn@0.2.0-canary.2) (2021-04-16)
+
+
+### Bug Fixes
+
+* **global:** fix spendPoints google name event and update husky ([42adffb](https://bitbucket.org/tradesystem/artisan_monorepo/commit/42adffb8594780f9dc56c475ac2fe29ca5f9270a))
+
+
+
 ## [0.2.0-canary.1](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/analytics-rn@0.2.0-canary.0...@artisan-commerce/analytics-rn@0.2.0-canary.1) (2021-04-16)
 
 **Note:** Version bump only for package @artisan-commerce/analytics-rn

package/build/analytics-rn/src/index.d.ts

@@ -6,3 +6,4 @@ export * from "./lib/providers/FacebookPixel/FacebookPixel.types";
 export * from "./lib/providers/GoogleAnalytics/GoogleAnalytics.types";
 export { default as events } from "./lib/events/events";
 export * from "./types/common.types";
+export { updateActiveVendor } from "./utils/state.utils";

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

@@ -7,7 +7,7 @@ import { CustomEventParams as FacebookCustomEventParams } from "../../providers/
  * @since 0.5.14
  */
 export interface CustomEventCommonParams {
-    [key: string]: string | number | boolean;
+    [key: string]: string | number;
 }
 /**
  * customEvent event params.

package/build/analytics-rn/src/lib/events/other/screenView/screenView.d.ts

@@ -2,8 +2,7 @@ import { ScreenViewParams } from "./screenView.types";
 /**
  * Emits a screenView event to every configured provider.
  *
- * Log this event when you need to add custom page view that the default page
- * view event does not log.
+ * Log this event when for each visited screen.
  *
  * @since 0.5.14
  * @param {ScreenViewParams} params ScreenView event parameters

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

@@ -1,9 +1,10 @@
 import { Vendor } from "@artisan-commerce/types";
 import { AnalyticsMeta } from "../../types/common.types";
+import AnalyticsProvider from "../providers/AnalyticsProvider/AnalyticsProvider";
 export interface InitAnalyticsConfig {
-    providers: any[];
+    providers: AnalyticsProvider[];
     activeVendor?: Vendor["id"];
-    vendors: Vendor["id"][];
+    vendors: Vendor["id"][] | undefined;
     debug?: boolean;
     meta: InitAnalyticsConfigMeta;
 }

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

@@ -24,7 +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[];
+    get vendors(): number[] | undefined;
     /**
      * Updates the provider instance config for the next events.
      *

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

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

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

@@ -40,19 +40,3 @@ 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,10 +33,8 @@ 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.
@@ -48,44 +46,6 @@ 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;
@@ -105,10 +65,4 @@ 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/test/exports.test.d.ts

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

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

@@ -199,7 +199,6 @@ export interface ProvidersHandlers<T> {
  * 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/state.utils.d.ts

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