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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9,4 +9,3 @@ export { default as events } from "./lib/events/events";
9
9
  export * from "./types/common.types";
10
10
  export { updateActiveVendor } from "./utils/state.utils";
11
11
  export { identifyUser } from "./utils/segment.utils";
12
- export { checkInit } from "./utils/common.utils";
@@ -1,5 +1,4 @@
1
1
  import { CartProduct, ShoppingCart, Store } from "@artisan-commerce/types";
2
- import { PriceCategoryType } from "@artisan-commerce/types";
3
2
  import { AddProductToCartParams as GoogleAddProductToCartParams } from "../../../providers/GoogleAnalytics/events/shoppingCart/addProductToCart/addProductToCart.types";
4
3
  import { AddProductToCartParams as FacebookAddProductToCartParams } from "../../../providers/FacebookPixel/events/shoppingCart/addProductToCart/addProductToCart.types";
5
4
  import { AddProductToCartParams as SegmentAddProductToCartParams } from "../../../providers/Segment/events/shoppingCart/addProductToCart/addProductToCart.types";
@@ -12,14 +11,12 @@ import { AddProductToCartParams as SegmentAddProductToCartParams } from "../../.
12
11
  * @property {string} cartId Shopping cart identifier
13
12
  * @property {string} cartName Shopping cart name
14
13
  * @property {Store} store Store where the user is buying the product
15
- * @property {PriceCategoryType} priceCategory The product price category identifier
16
14
  */
17
15
  export interface AddProductToCartCommonParams {
18
16
  product: CartProduct;
19
17
  cartId: ShoppingCart["id"];
20
18
  cartName?: ShoppingCart["name"];
21
19
  store: Store;
22
- priceCategory?: PriceCategoryType;
23
20
  }
24
21
  /**
25
22
  * addProductToCart event params.
@@ -1,5 +1,4 @@
1
1
  import { CartProduct, ShoppingCart } from "@artisan-commerce/types";
2
- import { PriceCategoryType } from "@artisan-commerce/types";
3
2
  import { AddProductToWishlistParams as GoogleAddProductToWishlistParams } from "../../../providers/GoogleAnalytics/events/shoppingCart/addProductToWishlist/addProductToWishlist.types";
4
3
  import { AddProductToWishlistParams as FacebookAddProductToWishlistParams } from "../../../providers/FacebookPixel/events/shoppingCart/addProductToWishlist/addProductToWishlist.types";
5
4
  import { AddProductToWishlistParams as SegmentAddProductToWishlistParams } from "../../../providers/Segment/events/shoppingCart/addProductToWishlist/addProductToWishlist.types";
@@ -10,12 +9,10 @@ import { AddProductToWishlistParams as SegmentAddProductToWishlistParams } from
10
9
  * @since 0.5.14
11
10
  * @property {CartProduct} product The product that was added to the wishlist
12
11
  * @property {string} cartId Shopping cart identifier
13
- * @property {PriceCategoryType} priceCategory The product price category identifier
14
12
  */
15
13
  export interface AddProductToWishlistCommonParams {
16
14
  product: CartProduct;
17
15
  cartId: ShoppingCart["id"];
18
- priceCategory?: PriceCategoryType;
19
16
  }
20
17
  /**
21
18
  * addProductToWishlist event params.
@@ -1,5 +1,4 @@
1
1
  import { CartProduct, ShoppingCart, Store } from "@artisan-commerce/types";
2
- import { PriceCategoryType } from "@artisan-commerce/types";
3
2
  import { RemoveProductFromCartParams as GoogleRemoveProductFromCartParams } from "../../../providers/GoogleAnalytics/events/shoppingCart/removeProductFromCart/removeProductFromCart.types";
4
3
  import { RemoveProductFromCartParams as FacebookRemoveProductFromCartParams } from "../../../providers/FacebookPixel/events/shoppingCart/removeProductFromCart/removeProductFromCart.types";
5
4
  import { RemoveProductFromCartParams as SegmentRemoveProductFromCartParams } from "../../../providers/Segment/events/shoppingCart/removeProductFromCart/removeProductFromCart.types";
@@ -12,14 +11,12 @@ import { RemoveProductFromCartParams as SegmentRemoveProductFromCartParams } fro
12
11
  * @property {string} cartId Shopping cart identifier
13
12
  * @property {string} cartName Shopping cart name
14
13
  * @property {Store} store Store where the user is buying the product
15
- * @property {PriceCategoryType} priceCategory The product price category identifier
16
14
  */
17
15
  export interface RemoveProductFromCartCommonParams {
18
16
  product: CartProduct;
19
17
  cartId: ShoppingCart["id"];
20
18
  cartName?: ShoppingCart["name"];
21
19
  store: Store;
22
- priceCategory?: PriceCategoryType;
23
20
  }
24
21
  /**
25
22
  * removeProductFromCart event params.
@@ -1,5 +1,4 @@
1
1
  import { CartProduct, ShoppingCart } from "@artisan-commerce/types";
2
- import { PriceCategoryType } from "@artisan-commerce/types";
3
2
  import { RemoveProductFromWishlistParams as GoogleRemoveProductFromWishlistParams } from "../../../providers/GoogleAnalytics/events/shoppingCart/removeProductFromWishlist/removeProductFromWishlist.types";
4
3
  import { RemoveProductFromWishlistParams as FacebookRemoveProductFromWishlistParams } from "../../../providers/FacebookPixel/events/shoppingCart/removeProductFromWishlist/removeProductFromWishlist.types";
5
4
  import { RemoveProductFromWishlistParams as SegmentRemoveProductFromWishlistParams } from "../../../providers/Segment/events/shoppingCart/removeProductFromWishlist/removeProductFromWishlist.types";
@@ -10,12 +9,10 @@ import { RemoveProductFromWishlistParams as SegmentRemoveProductFromWishlistPara
10
9
  * @since 0.5.14
11
10
  * @property {CartProduct} product The product that was removed from the wishlist
12
11
  * @property {string} cartId Shopping cart identifier
13
- * @property {PriceCategoryType} priceCategory The product price category identifier
14
12
  */
15
13
  export interface RemoveProductFromWishlistCommonParams {
16
14
  product: CartProduct;
17
15
  cartId: ShoppingCart["id"];
18
- priceCategory?: PriceCategoryType;
19
16
  }
20
17
  /**
21
18
  * removeProductFromWishlist event params.
@@ -1,8 +1,7 @@
1
- import { CartProduct, ShoppingCart, Store } from "@artisan-commerce/types";
2
- import { PriceCategoryType } from "@artisan-commerce/types";
3
1
  import { UpdateProductInCartParams as GoogleUpdateProductInCartParams } from "../../../providers/GoogleAnalytics/events/shoppingCart/updateProductInCart/updateProductInCart.types";
4
2
  import { UpdateProductInCartParams as FacebookUpdateProductInCartParams } from "../../../providers/FacebookPixel/events/shoppingCart/updateProductInCart/updateProductInCart.types";
5
3
  import { UpdateProductInCartParams as SegmentUpdateProductInCartParams } from "../../../providers/Segment/events/shoppingCart/updateProductInCart/updateProductInCart.types";
4
+ import { CartProduct, ShoppingCart, Store } from "@artisan-commerce/types";
6
5
  /**
7
6
  * updateProductInCart event interface
8
7
  *
@@ -13,7 +12,6 @@ import { UpdateProductInCartParams as SegmentUpdateProductInCartParams } from ".
13
12
  * @property {string} cartName Shopping cart name
14
13
  * @property {Store} store Store where the user is buying the product
15
14
  * @property {string[]} fields The updated fields names
16
- * @property {PriceCategoryType} priceCategory The product price category identifier
17
15
  */
18
16
  export interface UpdateProductInCartCommonParams {
19
17
  product: CartProduct;
@@ -21,7 +19,6 @@ export interface UpdateProductInCartCommonParams {
21
19
  cartName?: ShoppingCart["name"];
22
20
  store: Store;
23
21
  fields: string[];
24
- priceCategory?: PriceCategoryType;
25
22
  }
26
23
  /**
27
24
  * updateProductInCart event params.
@@ -1,5 +1,4 @@
1
1
  import { CartProduct, ShoppingCart } from "@artisan-commerce/types";
2
- import { PriceCategoryType } from "@artisan-commerce/types";
3
2
  import { UpdateProductInWishlistParams as GoogleUpdateProductInWishlistParams } from "../../../providers/GoogleAnalytics/events/shoppingCart/updateProductInWishlist/updateProductInWishlist.types";
4
3
  import { UpdateProductInWishlistParams as FacebookUpdateProductInWishlistParams } from "../../../providers/FacebookPixel/events/shoppingCart/updateProductInWishlist/updateProductInWishlist.types";
5
4
  import { UpdateProductInWishlistParams as SegmentUpdateProductInWishlistParams } from "../../../providers/Segment/events/shoppingCart/updateProductInWishlist/updateProductInWishlist.types";
@@ -11,13 +10,11 @@ import { UpdateProductInWishlistParams as SegmentUpdateProductInWishlistParams }
11
10
  * @property {CartProduct} product The product in the wishlist that was updated
12
11
  * @property {string} cartId Shopping cart identifier
13
12
  * @property {string[]} fields The updated fields names
14
- * @property {PriceCategoryType} priceCategory The product price category identifier
15
13
  */
16
14
  export interface UpdateProductInWishlistCommonParams {
17
15
  product: CartProduct;
18
16
  cartId: ShoppingCart["id"];
19
17
  fields: string[];
20
- priceCategory?: PriceCategoryType;
21
18
  }
22
19
  /**
23
20
  * updateProductInWishlist event params.
@@ -59,7 +59,7 @@ export declare namespace Segment {
59
59
  identify(traits?: Traits, options?: SegmentOptions, callback?: () => void): void;
60
60
  identify(traits?: Traits, callback?: () => void): void;
61
61
  identify(callback: () => void): void;
62
- track(event: EventNames | string, properties?: TrackProperties | CustomParams, options?: SegmentOptions, callback?: () => void): void;
62
+ track(event: EventNames | string, properties?: TrackProperties, options?: SegmentOptions, callback?: () => void): void;
63
63
  track(event: EventNames | string, properties?: TrackProperties, callback?: () => void): void;
64
64
  track(event: EventNames | string, callback?: () => void): void;
65
65
  reset(): void;
@@ -2,20 +2,12 @@ import { InitAnalyticsConfig } from "../lib/initAnalytics/initAnalytics.types";
2
2
  import { AnalyticsMeta } from "./common.types";
3
3
  declare type StrictInitAnalyticsConfig = Required<InitAnalyticsConfig>;
4
4
  export interface GlobalState {
5
- /** Analytics providers instances that can be targeted to emit events */
6
5
  providers: StrictInitAnalyticsConfig["providers"];
7
- /** The vendor that will emit the events */
8
6
  activeVendor?: StrictInitAnalyticsConfig["activeVendor"];
9
- /** List of vendors that can emit events if active */
10
7
  vendors: StrictInitAnalyticsConfig["vendors"];
11
- /** Debug mode */
12
8
  debug: StrictInitAnalyticsConfig["debug"];
13
- /** Share e-commerce analytics with Trade */
14
9
  shareArtisnAnalytics: StrictInitAnalyticsConfig["shareArtisnAnalytics"];
15
- /** Static commerce metadata */
16
10
  meta: GlobalStateMeta;
17
- /** Indicates whether or not web analytics has been initialized */
18
- initialized: boolean;
19
11
  }
20
12
  export interface GlobalStateMeta extends Omit<AnalyticsMeta, "accountId" | "vendorId" | "vendorName" | "storeId" | "storeName" | "catalogueId" | "catalogueName" | "appName" | "versionApp"> {
21
13
  accountId: AnalyticsMeta["accountId"] | undefined;
@@ -1,15 +1,8 @@
1
1
  /**
2
- * Update the event parameters keys to be in snake case.
2
+ * Update the event prameters keys to be in snake case.
3
3
  *
4
4
  * @since 0.5.14
5
5
  * @param {T} params Event parameters to be transformed
6
6
  * @returns {T} Event parameters with its keys in snake case
7
7
  */
8
8
  export declare const eventParamsToSnakeCase: <T>(params: T) => T;
9
- /**
10
- * Checks if the web analytics package has been initialized.
11
- *
12
- * @returns {boolean} The attribute that indicates whether or not web analytics
13
- * has been initialized
14
- */
15
- export declare const checkInit: () => boolean;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@artisan-commerce/analytics-web",
3
3
  "description": "Artisn commerce analytics web library",
4
- "version": "0.2.0-canary.18",
4
+ "version": "0.2.0-canary.2",
5
5
  "main": "./build/main.bundle.js",
6
6
  "types": "./build/src/index.d.ts",
7
7
  "files": [
@@ -34,9 +34,9 @@
34
34
  "snake-case": "^3.0.4"
35
35
  },
36
36
  "devDependencies": {
37
- "@artisan-commerce/products": "0.9.0-canary.14",
38
- "@artisan-commerce/shopping-cart": "0.12.0-canary.17",
39
- "@artisan-commerce/types": "0.14.0-canary.11",
37
+ "@artisan-commerce/products": "0.9.0-canary.4",
38
+ "@artisan-commerce/shopping-cart": "0.12.0-canary.2",
39
+ "@artisan-commerce/types": "0.14.0-canary.2",
40
40
  "@babel/core": "^7.10.5",
41
41
  "@babel/preset-env": "^7.10.4",
42
42
  "@babel/preset-react": "^7.10.4",
@@ -83,5 +83,5 @@
83
83
  "@artisan-commerce/products": "*",
84
84
  "@artisan-commerce/shopping-cart": "*"
85
85
  },
86
- "gitHead": "5c18fbdf0bd570d9d5f2c125d5a64a8b9b8a5c3a"
86
+ "gitHead": "bf0cd7736f111ee863d48fd866d1d3590aa39eac"
87
87
  }