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

package/CHANGELOG.md

@@ -3,6 +3,24 @@
 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.18](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/analytics-rn@0.2.0-canary.17...@artisan-commerce/analytics-rn@0.2.0-canary.18) (2021-05-28)
+
+
+### Bug Fixes
+
+* **analytics-web:** add analytics scripts to the document's head ([243ec79](https://bitbucket.org/tradesystem/artisan_monorepo/commit/243ec790ae0d995e14498b5fb042af0251913267))
+
+
+
+## [0.2.0-canary.17](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/analytics-rn@0.2.0-canary.16...@artisan-commerce/analytics-rn@0.2.0-canary.17) (2021-05-28)
+
+
+### Bug Fixes
+
+* **analytics-rn:** finish events mapping ([eb2f04b](https://bitbucket.org/tradesystem/artisan_monorepo/commit/eb2f04b796bbf827a1c351dd834e5f0e0fbc49e0))
+
+
+
 ## [0.2.0-canary.16](https://bitbucket.org/tradesystem/artisan_monorepo/compare/@artisan-commerce/analytics-rn@0.2.0-canary.15...@artisan-commerce/analytics-rn@0.2.0-canary.16) (2021-05-14)
 
 

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

@@ -1,6 +1,17 @@
 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[];
     activeVendor?: Vendor["id"];

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

@@ -40,3 +40,19 @@ export interface SegmentCommonEventParams extends EventCommonParams {
 export interface SegmentCustomEventParams {
     [key: string]: any;
 }
+export declare namespace Segment {
+    interface Product {
+        product_id: string;
+        sku?: string;
+        category?: string;
+        name?: string;
+        brand?: string;
+        variant?: string;
+        price?: number;
+        quantity?: number;
+        coupon?: string;
+        position?: number;
+        url?: string;
+        image_url?: string;
+    }
+}

package/build/analytics-rn/src/lib/providers/Segment/events/auth/signIn/signIn.types.d.ts

@@ -9,6 +9,8 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends SignInCommonParams
+ * @property {string} name The user's name
  */
 export interface SignInParams extends SegmentCommonEventParams, SegmentCustomEventParams, SignInCommonParams {
+    name: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/auth/signOut/signOut.types.d.ts

@@ -9,6 +9,8 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends SignOutCommonParams
+ * @property {string} name The user's name
  */
 export interface SignOutParams extends SegmentCommonEventParams, SegmentCustomEventParams, SignOutCommonParams {
+    name: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/auth/signUp/signUp.types.d.ts

@@ -9,6 +9,10 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends SignUpCommonParams
+ * @property {string} name The user's name
+ * @property {string} email The user's email
  */
 export interface SignUpParams extends SegmentCommonEventParams, SegmentCustomEventParams, SignUpCommonParams {
+    name: string;
+    email: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/category/viewCategory/viewCategory.types.d.ts

@@ -1,3 +1,4 @@
+import { Product } from "@artisan-commerce/types";
 import { ViewCategoryCommonParams } from "../../../../../events/category/viewCategory/viewCategory.types";
 import { SegmentCommonEventParams } from "../../../Segment.types";
 import { SegmentCustomEventParams } from "../../../Segment.types";
@@ -9,6 +10,8 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends ViewCategoryCommonParams
+ * @property {Product[]} products The products in the order
  */
 export interface ViewCategoryParams extends SegmentCommonEventParams, SegmentCustomEventParams, ViewCategoryCommonParams {
+    products: Product[];
 }

package/build/analytics-rn/src/lib/providers/Segment/events/checkout/initiateCheckout/initiateCheckout.types.d.ts

@@ -9,8 +9,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends InitiateCheckoutCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface InitiateCheckoutParams extends SegmentCommonEventParams, SegmentCustomEventParams, InitiateCheckoutCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/order/cancelOrder/cancelOrder.types.d.ts

@@ -1,3 +1,4 @@
+import { Product } from "@artisan-commerce/types";
 import { CancelOrderCommonParams } from "../../../../../events/order/cancelOrder/cancelOrder.types";
 import { SegmentCommonEventParams } from "../../../Segment.types";
 import { SegmentCustomEventParams } from "../../../Segment.types";
@@ -9,6 +10,10 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends CancelOrderCommonParams
+ * @property {number} orderTotal The total cost of the order
+ * @property {Product[]} products The products in the order
  */
 export interface CancelOrderParams extends SegmentCommonEventParams, SegmentCustomEventParams, CancelOrderCommonParams {
+    orderTotal: number;
+    products: Product[];
 }

package/build/analytics-rn/src/lib/providers/Segment/events/order/rateOrder/rateOrder.types.d.ts

@@ -9,8 +9,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends RateOrderCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface RateOrderParams extends SegmentCommonEventParams, SegmentCustomEventParams, RateOrderCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/order/requestRefund/requestRefund.types.d.ts

@@ -1,3 +1,4 @@
+import { Product } from "@artisan-commerce/types";
 import { RequestRefundCommonParams } from "../../../../../events/order/requestRefund/requestRefund.types";
 import { SegmentCommonEventParams } from "../../../Segment.types";
 import { SegmentCustomEventParams } from "../../../Segment.types";
@@ -9,6 +10,8 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends RequestRefundCommonParams
+ * @property {Product[]} products The products in the order
  */
 export interface RequestRefundParams extends SegmentCommonEventParams, SegmentCustomEventParams, RequestRefundCommonParams {
+    products: Product[];
 }

package/build/analytics-rn/src/lib/providers/Segment/events/product/customizeProduct/customizeProduct.types.d.ts

@@ -8,8 +8,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @since 0.5.14
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface CustomizeProductParams extends SegmentCommonEventParams, SegmentCustomEventParams, CustomizeProductCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/product/filterProducts/filterProducts.types.d.ts

@@ -9,8 +9,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends FilterProductsCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface FilterProductsParams extends SegmentCommonEventParams, SegmentCustomEventParams, FilterProductsCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/product/productImpression/productImpression.types.d.ts

@@ -8,8 +8,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @since 0.5.14
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
- * @property {string} contentType The type of product the user had an impression on (e.g. food)
  */
 export interface ProductImpressionParams extends SegmentCommonEventParams, SegmentCustomEventParams, ProductImpressionCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/product/searchProductAttempt/searchProductAttempt.types.d.ts

@@ -9,8 +9,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends SearchProductAttemptCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface SearchProductAttemptParams extends SegmentCommonEventParams, SegmentCustomEventParams, SearchProductAttemptCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/product/searchProductNotFound/searchProductNotFound.types.d.ts

@@ -9,8 +9,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends SearchProductNotFoundCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface SearchProductNotFoundParams extends SegmentCommonEventParams, SegmentCustomEventParams, SearchProductNotFoundCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/product/searchProductSuccess/searchProductSuccess.types.d.ts

@@ -9,8 +9,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends SearchProductSuccessCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface SearchProductSuccessParams extends SegmentCommonEventParams, SegmentCustomEventParams, SearchProductSuccessCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/product/selectProduct/selectProduct.types.d.ts

@@ -8,8 +8,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @since 0.5.14
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface SelectProductParams extends SegmentCommonEventParams, SegmentCustomEventParams, SelectProductCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/product/sortProducts/sortProducts.types.d.ts

@@ -9,8 +9,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends SortProductsCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface SortProductsParams extends SegmentCommonEventParams, SegmentCustomEventParams, SortProductsCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/product/viewProductDetails/viewProductDetails.types.d.ts

@@ -8,8 +8,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @since 0.5.14
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface ViewProductDetailsParams extends SegmentCommonEventParams, SegmentCustomEventParams, ViewProductDetailsCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/purchase/purchaseAttempt/purchaseAttempt.types.d.ts

@@ -9,8 +9,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends PurchaseAttemptCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface PurchaseAttemptParams extends SegmentCommonEventParams, SegmentCustomEventParams, PurchaseAttemptCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/purchase/purchaseFail/purchaseFail.types.d.ts

@@ -9,8 +9,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends PurchaseFailCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface PurchaseFailParams extends SegmentCommonEventParams, SegmentCustomEventParams, PurchaseFailCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/purchase/purchaseSuccess/purchaseSuccess.types.d.ts

@@ -9,8 +9,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends PurchaseSuccessCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface PurchaseSuccessParams extends SegmentCommonEventParams, SegmentCustomEventParams, PurchaseSuccessCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/shoppingCart/addProductToCart/addProductToCart.types.d.ts

@@ -9,8 +9,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends AddProductToCartCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface AddProductToCartParams extends SegmentCommonEventParams, SegmentCustomEventParams, AddProductToCartCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/shoppingCart/addProductToWishlist/addProductToWishlist.types.d.ts

@@ -9,8 +9,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends AddProductToWishlistCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface AddProductToWishlistParams extends SegmentCommonEventParams, SegmentCustomEventParams, AddProductToWishlistCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/shoppingCart/clearCart/clearCart.types.d.ts

@@ -9,8 +9,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends ClearCartCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface ClearCartParams extends SegmentCommonEventParams, SegmentCustomEventParams, ClearCartCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/shoppingCart/removeProductFromCart/removeProductFromCart.types.d.ts

@@ -9,8 +9,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends RemoveProductFromCartCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface RemoveProductFromCartParams extends SegmentCommonEventParams, SegmentCustomEventParams, RemoveProductFromCartCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/shoppingCart/removeProductFromWishlist/removeProductFromWishlist.types.d.ts

@@ -9,8 +9,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends RemoveProductFromWishlistCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface RemoveProductFromWishlistParams extends SegmentCommonEventParams, SegmentCustomEventParams, RemoveProductFromWishlistCommonParams {
-    contentType?: string;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/shoppingCart/updateProductInCart/updateProductInCart.types.d.ts

@@ -9,8 +9,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends UpdateProductInCartCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface UpdateProductInCartParams extends SegmentCommonEventParams, SegmentCustomEventParams, UpdateProductInCartCommonParams {
-    contentType?: string;
 }

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

@@ -9,8 +9,6 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends UpdateProductInWishlistCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
  */
 export interface UpdateProductInWishlistParams extends SegmentCommonEventParams, SegmentCustomEventParams, UpdateProductInWishlistCommonParams {
-    contentType?: string;
 }

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

@@ -1,3 +1,4 @@
+import { Product } from "@artisan-commerce/types";
 import { ViewCartCommonParams } from "../../../../../events/shoppingCart/viewCart/viewCart.types";
 import { SegmentCommonEventParams } from "../../../Segment.types";
 import { SegmentCustomEventParams } from "../../../Segment.types";
@@ -9,8 +10,8 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends ViewCartCommonParams
- * @property {string} contentType The type of products being sold (e.g. food)
+ * @property {Product[]} products The products in the cart
  */
 export interface ViewCartParams extends SegmentCommonEventParams, SegmentCustomEventParams, ViewCartCommonParams {
-    contentType?: string;
+    products: Product[];
 }

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

@@ -2,6 +2,7 @@ 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.
  *
@@ -61,3 +62,19 @@ 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[];