@artisan-commerce/analytics-web 0.2.0-canary.2 → 0.2.0-canary.21

package/build/src/index.d.ts

@@ -9,3 +9,4 @@ export { default as events } from "./lib/events/events";
 export * from "./types/common.types";
 export { updateActiveVendor } from "./utils/state.utils";
 export { identifyUser } from "./utils/segment.utils";
+export { checkInit } from "./utils/common.utils";

package/build/src/lib/events/shoppingCart/addProductToCart/addProductToCart.types.d.ts

@@ -1,4 +1,5 @@
 import { CartProduct, ShoppingCart, Store } from "@artisan-commerce/types";
+import { PriceCategoryType } from "@artisan-commerce/types";
 import { AddProductToCartParams as GoogleAddProductToCartParams } from "../../../providers/GoogleAnalytics/events/shoppingCart/addProductToCart/addProductToCart.types";
 import { AddProductToCartParams as FacebookAddProductToCartParams } from "../../../providers/FacebookPixel/events/shoppingCart/addProductToCart/addProductToCart.types";
 import { AddProductToCartParams as SegmentAddProductToCartParams } from "../../../providers/Segment/events/shoppingCart/addProductToCart/addProductToCart.types";
@@ -11,12 +12,14 @@ import { AddProductToCartParams as SegmentAddProductToCartParams } from "../../.
  * @property {string} cartId Shopping cart identifier
  * @property {string} cartName Shopping cart name
  * @property {Store} store Store where the user is buying the product
+ * @property {PriceCategoryType} priceCategory The product price category identifier
  */
 export interface AddProductToCartCommonParams {
     product: CartProduct;
     cartId: ShoppingCart["id"];
     cartName?: ShoppingCart["name"];
     store: Store;
+    priceCategory?: PriceCategoryType;
 }
 /**
  * addProductToCart event params.

package/build/src/lib/events/shoppingCart/addProductToWishlist/addProductToWishlist.types.d.ts

@@ -1,4 +1,5 @@
 import { CartProduct, ShoppingCart } from "@artisan-commerce/types";
+import { PriceCategoryType } from "@artisan-commerce/types";
 import { AddProductToWishlistParams as GoogleAddProductToWishlistParams } from "../../../providers/GoogleAnalytics/events/shoppingCart/addProductToWishlist/addProductToWishlist.types";
 import { AddProductToWishlistParams as FacebookAddProductToWishlistParams } from "../../../providers/FacebookPixel/events/shoppingCart/addProductToWishlist/addProductToWishlist.types";
 import { AddProductToWishlistParams as SegmentAddProductToWishlistParams } from "../../../providers/Segment/events/shoppingCart/addProductToWishlist/addProductToWishlist.types";
@@ -9,10 +10,12 @@ import { AddProductToWishlistParams as SegmentAddProductToWishlistParams } from
  * @since 0.5.14
  * @property {CartProduct} product The product that was added to the wishlist
  * @property {string} cartId Shopping cart identifier
+ * @property {PriceCategoryType} priceCategory The product price category identifier
  */
 export interface AddProductToWishlistCommonParams {
     product: CartProduct;
     cartId: ShoppingCart["id"];
+    priceCategory?: PriceCategoryType;
 }
 /**
  * addProductToWishlist event params.

package/build/src/lib/events/shoppingCart/removeProductFromCart/removeProductFromCart.types.d.ts

@@ -1,4 +1,5 @@
 import { CartProduct, ShoppingCart, Store } from "@artisan-commerce/types";
+import { PriceCategoryType } from "@artisan-commerce/types";
 import { RemoveProductFromCartParams as GoogleRemoveProductFromCartParams } from "../../../providers/GoogleAnalytics/events/shoppingCart/removeProductFromCart/removeProductFromCart.types";
 import { RemoveProductFromCartParams as FacebookRemoveProductFromCartParams } from "../../../providers/FacebookPixel/events/shoppingCart/removeProductFromCart/removeProductFromCart.types";
 import { RemoveProductFromCartParams as SegmentRemoveProductFromCartParams } from "../../../providers/Segment/events/shoppingCart/removeProductFromCart/removeProductFromCart.types";
@@ -11,12 +12,14 @@ import { RemoveProductFromCartParams as SegmentRemoveProductFromCartParams } fro
  * @property {string} cartId Shopping cart identifier
  * @property {string} cartName Shopping cart name
  * @property {Store} store Store where the user is buying the product
+ * @property {PriceCategoryType} priceCategory The product price category identifier
  */
 export interface RemoveProductFromCartCommonParams {
     product: CartProduct;
     cartId: ShoppingCart["id"];
     cartName?: ShoppingCart["name"];
     store: Store;
+    priceCategory?: PriceCategoryType;
 }
 /**
  * removeProductFromCart event params.

package/build/src/lib/events/shoppingCart/removeProductFromWishlist/removeProductFromWishlist.types.d.ts

@@ -1,4 +1,5 @@
 import { CartProduct, ShoppingCart } from "@artisan-commerce/types";
+import { PriceCategoryType } from "@artisan-commerce/types";
 import { RemoveProductFromWishlistParams as GoogleRemoveProductFromWishlistParams } from "../../../providers/GoogleAnalytics/events/shoppingCart/removeProductFromWishlist/removeProductFromWishlist.types";
 import { RemoveProductFromWishlistParams as FacebookRemoveProductFromWishlistParams } from "../../../providers/FacebookPixel/events/shoppingCart/removeProductFromWishlist/removeProductFromWishlist.types";
 import { RemoveProductFromWishlistParams as SegmentRemoveProductFromWishlistParams } from "../../../providers/Segment/events/shoppingCart/removeProductFromWishlist/removeProductFromWishlist.types";
@@ -9,10 +10,12 @@ import { RemoveProductFromWishlistParams as SegmentRemoveProductFromWishlistPara
  * @since 0.5.14
  * @property {CartProduct} product The product that was removed from the wishlist
  * @property {string} cartId Shopping cart identifier
+ * @property {PriceCategoryType} priceCategory The product price category identifier
  */
 export interface RemoveProductFromWishlistCommonParams {
     product: CartProduct;
     cartId: ShoppingCart["id"];
+    priceCategory?: PriceCategoryType;
 }
 /**
  * removeProductFromWishlist event params.

package/build/src/lib/events/shoppingCart/updateProductInCart/updateProductInCart.types.d.ts

@@ -1,7 +1,8 @@
+import { CartProduct, ShoppingCart, Store } from "@artisan-commerce/types";
+import { PriceCategoryType } from "@artisan-commerce/types";
 import { UpdateProductInCartParams as GoogleUpdateProductInCartParams } from "../../../providers/GoogleAnalytics/events/shoppingCart/updateProductInCart/updateProductInCart.types";
 import { UpdateProductInCartParams as FacebookUpdateProductInCartParams } from "../../../providers/FacebookPixel/events/shoppingCart/updateProductInCart/updateProductInCart.types";
 import { UpdateProductInCartParams as SegmentUpdateProductInCartParams } from "../../../providers/Segment/events/shoppingCart/updateProductInCart/updateProductInCart.types";
-import { CartProduct, ShoppingCart, Store } from "@artisan-commerce/types";
 /**
  * updateProductInCart event interface
  *
@@ -12,6 +13,7 @@ import { CartProduct, ShoppingCart, Store } from "@artisan-commerce/types";
  * @property {string} cartName Shopping cart name
  * @property {Store} store Store where the user is buying the product
  * @property {string[]} fields The updated fields names
+ * @property {PriceCategoryType} priceCategory The product price category identifier
  */
 export interface UpdateProductInCartCommonParams {
     product: CartProduct;
@@ -19,6 +21,7 @@ export interface UpdateProductInCartCommonParams {
     cartName?: ShoppingCart["name"];
     store: Store;
     fields: string[];
+    priceCategory?: PriceCategoryType;
 }
 /**
  * updateProductInCart event params.

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

@@ -1,4 +1,5 @@
 import { CartProduct, ShoppingCart } from "@artisan-commerce/types";
+import { PriceCategoryType } 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";
@@ -10,11 +11,13 @@ import { UpdateProductInWishlistParams as SegmentUpdateProductInWishlistParams }
  * @property {CartProduct} product The product in the wishlist that was updated
  * @property {string} cartId Shopping cart identifier
  * @property {string[]} fields The updated fields names
+ * @property {PriceCategoryType} priceCategory The product price category identifier
  */
 export interface UpdateProductInWishlistCommonParams {
     product: CartProduct;
     cartId: ShoppingCart["id"];
     fields: string[];
+    priceCategory?: PriceCategoryType;
 }
 /**
  * updateProductInWishlist event params.

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

@@ -59,7 +59,7 @@ export declare namespace Segment {
         identify(traits?: Traits, options?: SegmentOptions, callback?: () => void): void;
         identify(traits?: Traits, callback?: () => void): void;
         identify(callback: () => void): void;
-        track(event: EventNames | string, properties?: TrackProperties, options?: SegmentOptions, callback?: () => void): void;
+        track(event: EventNames | string, properties?: TrackProperties | CustomParams, options?: SegmentOptions, callback?: () => void): void;
         track(event: EventNames | string, properties?: TrackProperties, callback?: () => void): void;
         track(event: EventNames | string, callback?: () => void): void;
         reset(): void;

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

@@ -2,12 +2,20 @@ import { InitAnalyticsConfig } from "../lib/initAnalytics/initAnalytics.types";
 import { AnalyticsMeta } from "./common.types";
 declare type StrictInitAnalyticsConfig = Required<InitAnalyticsConfig>;
 export interface GlobalState {
+    /** Analytics providers instances that can be targeted to emit events */
     providers: StrictInitAnalyticsConfig["providers"];
+    /** The vendor that will emit the events */
     activeVendor?: StrictInitAnalyticsConfig["activeVendor"];
+    /** List of vendors that can emit events if active */
     vendors: StrictInitAnalyticsConfig["vendors"];
+    /** Debug mode */
     debug: StrictInitAnalyticsConfig["debug"];
+    /** Share e-commerce analytics with Trade */
     shareArtisnAnalytics: StrictInitAnalyticsConfig["shareArtisnAnalytics"];
+    /** Static commerce metadata */
     meta: GlobalStateMeta;
+    /** Indicates whether or not web analytics has been initialized */
+    initialized: boolean;
 }
 export interface GlobalStateMeta extends Omit<AnalyticsMeta, "accountId" | "vendorId" | "vendorName" | "storeId" | "storeName" | "catalogueId" | "catalogueName" | "appName" | "versionApp"> {
     accountId: AnalyticsMeta["accountId"] | undefined;

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

@@ -1,8 +1,15 @@
 /**
- * Update the event prameters keys to be in snake case.
+ * Update the event parameters 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;
+/**
+ * Checks if the web analytics package has been initialized.
+ *
+ * @returns {boolean} The attribute that indicates whether or not web analytics
+ * has been initialized
+ */
+export declare const checkInit: () => boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@artisan-commerce/analytics-web",
   "description": "Artisn commerce analytics web library",
-  "version": "0.2.0-canary.2",
+  "version": "0.2.0-canary.21",
   "main": "./build/main.bundle.js",
   "types": "./build/src/index.d.ts",
   "files": [
@@ -34,9 +34,9 @@
     "snake-case": "^3.0.4"
   },
   "devDependencies": {
-    "@artisan-commerce/products": "0.9.0-canary.4",
-    "@artisan-commerce/shopping-cart": "0.12.0-canary.2",
-    "@artisan-commerce/types": "0.14.0-canary.2",
+    "@artisan-commerce/products": "0.9.0-canary.14",
+    "@artisan-commerce/shopping-cart": "0.12.0-canary.20",
+    "@artisan-commerce/types": "0.14.0-canary.11",
     "@babel/core": "^7.10.5",
     "@babel/preset-env": "^7.10.4",
     "@babel/preset-react": "^7.10.4",
@@ -83,5 +83,5 @@
     "@artisan-commerce/products": "*",
     "@artisan-commerce/shopping-cart": "*"
   },
-  "gitHead": "bf0cd7736f111ee863d48fd866d1d3590aa39eac"
+  "gitHead": "3e84178aeeff64d0d0fc698b855ac463181340ba"
 }