@artisan-commerce/analytics-web 0.1.0-canary.3 → 0.1.0-canary.4

package/build/src/lib/events/product/filterProducts/filterProducts.d.ts

@@ -2,7 +2,7 @@ import { FilterProductsParams } from "./filterProducts.types";
 /**
  * Emits a filterProducts event to every configured provider.
  *
- * Log this event when the users try to filter a list of products.
+ * Log this event when users try to filter a list of products.
  *
  * @since 0.5.14
  * @property {FilterProductsParams} params FilterProducts event parameters

package/build/src/lib/events/product/searchProductAttempt/searchProductAttempt.d.ts

@@ -2,7 +2,7 @@ import { SearchProductAttemptParams } from "./searchProductAttempt.types";
 /**
  * Emits a searchProductAttempt event to every configured provider.
  *
- * Log this event when the users try to search an specific product.
+ * Log this event when users try to search an specific product.
  *
  * @since 0.5.14
  * @property {SearchProductAttemptParams} params SearchProductAttempt event parameters

package/build/src/lib/events/product/selectProduct/selectProduct.d.ts

@@ -2,7 +2,7 @@ import { SelectProductParams } from "./selectProduct.types";
 /**
  * Emits a selectProduct event to every configured provider.
  *
- * Log this event when the users select a product. This product may or may not
+ * Log this event when users select a product. This product may or may not
  * be on a list.
  *
  * @since 0.5.14

package/build/src/lib/events/product/sortProducts/sortProducts.d.ts

@@ -2,7 +2,7 @@ import { SortProductsParams } from "./sortProducts.types";
 /**
  * Emits a sortProducts event to every configured provider.
  *
- * Log this event when the users try to sort a list of products.
+ * Log this event when users try to sort a list of products.
  *
  * @since 0.5.14
  * @property {SortProductsParams} params SortProducts event parameters

package/build/src/lib/events/purchase/purchaseAttempt/purchaseAttempt.d.ts

@@ -2,7 +2,7 @@ import { PurchaseAttemptParams } from "./purchaseAttempt.types";
 /**
  * Emits a purchaseAttempt event to every configured provider.
  *
- * Log this event when
+ * Log this event when users show an intention to purchase.
  *
  * @since 0.5.14
  * @property {PurchaseAttemptParams} params PurchaseAttempt event parameters

package/build/src/lib/events/purchase/purchaseAttempt/purchaseAttempt.types.d.ts

@@ -11,7 +11,7 @@ import { PaymentType, Workflow } from "../../events.types";
  * @property {ShoppingCart} shoppingCart The order shopping cart
  * @property {PaymentType} selectedPaymentType The selected payment type (e.g. Cash, Credit, Debit)
  * @property {Workflow} fulfillmentType The workflow name (e.g. Delivery)
- * @property {string} cardType If paying with card the card provider (e.g. visa)
+ * @property {string} cardType If paying with card, the card provider (e.g. visa)
  * @property {number} shippingAddressId The selected shipping address identifier
  * @property {number} billingInfoId The selected billing info identifier
  */

package/build/src/lib/events/purchase/purchaseFail/purchaseFail.d.ts

@@ -2,7 +2,7 @@ import { PurchaseFailParams } from "./purchaseFail.types";
 /**
  * Emits a purchaseFail event to every configured provider.
  *
- * Log this event when
+ * Log this event when your purchase request has failed.
  *
  * @since 0.5.14
  * @property {PurchaseFailParams} params PurchaseFail event parameters

package/build/src/lib/events/purchase/purchaseSuccess/purchaseSuccess.d.ts

@@ -2,7 +2,7 @@ import { PurchaseSuccessParams } from "./purchaseSuccess.types";
 /**
  * Emits a purchaseSuccess event to every configured provider.
  *
- * Log this event when
+ * Log this event when your purchase request has resolved successfully.
  *
  * @since 0.5.14
  * @property {PurchaseSuccessParams} params PurchaseSuccess event parameters

package/build/src/lib/events/settings/viewSettings/viewSettings.d.ts

@@ -2,7 +2,7 @@ import { ViewSettingsParams } from "./viewSettings.types";
 /**
  * Emits a viewSettings event to every configured provider.
  *
- * Log this event when
+ * Log this event when users view the settings.
  *
  * @since 0.5.14
  * @property {ViewSettingsParams} params ViewSettings event parameters

package/build/src/lib/events/shipping/addShippingAddress/addShippingAddress.d.ts

@@ -2,7 +2,7 @@ import { AddShippingAddressParams } from "./addShippingAddress.types";
 /**
  * Emits a addShippingAddress event to every configured provider.
  *
- * Log this event when
+ * Log this event when users add their shipping address.
  *
  * @since 0.5.14
  * @property {AddShippingAddressParams} params AddShippingAddress event parameters

package/build/src/lib/events/shipping/addShippingAddress/addShippingAddress.types.d.ts

@@ -8,7 +8,7 @@ import { AddShippingAddressParams as FacebookAddShippingAddressParams } from "..
  * @property {number} lat The address latitude
  * @property {number} lng The address longitude
  * @property {string} alias The address alias or name
- * @property {address} address Full address
+ * @property {string} address Full address
  */
 export interface AddShippingAddressCommonParams {
     lat: number;

package/build/src/lib/events/shipping/selectShippingAddress/selectShippingAddress.d.ts

@@ -2,7 +2,7 @@ import { SelectShippingAddressParams } from "./selectShippingAddress.types";
 /**
  * Emits a selectShippingAddress event to every configured provider.
  *
- * Log this event when
+ * Log this event when users select a shipping address.
  *
  * @since 0.5.14
  * @property {SelectShippingAddressParams} params SelectShippingAddress event parameters

package/build/src/lib/events/shipping/selectShippingAddress/selectShippingAddress.types.d.ts

@@ -11,7 +11,7 @@ import { SelectShippingAddressParams as FacebookSelectShippingAddressParams } fr
  * @property {number} lat The address latitude
  * @property {number} lng The address longitude
  * @property {string} alias The address alias or name
- * @property {address} address Full address
+ * @property {string} address Full address
  */
 export interface SelectShippingAddressCommonParams {
     addressId: ShippingAddress["id"];

package/build/src/lib/events/shipping/updateShippingAddress/updateShippingAddress.d.ts

@@ -2,7 +2,7 @@ import { UpdateShippingAddressParams } from "./updateShippingAddress.types";
 /**
  * Emits a updateShippingAddress event to every configured provider.
  *
- * Log this event when
+ * Log this event when users update their shipping address.
  *
  * @since 0.5.14
  * @property {UpdateShippingAddressParams} params UpdateShippingAddress event parameters

package/build/src/lib/events/shipping/updateShippingAddress/updateShippingAddress.types.d.ts

@@ -7,7 +7,7 @@ import { UpdateShippingAddressParams as FacebookUpdateShippingAddressParams } fr
  * @interface UpdateShippingAddressCommonParams
  * @since 0.5.14
  * @property {number} addressId The address identifier
- * @property {address} address The new full address
+ * @property {string} address The new full address
  * @property {string[]} fields The updated fields names
  */
 export interface UpdateShippingAddressCommonParams {

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

@@ -2,7 +2,7 @@ import { AddProductToCartParams } from "./addProductToCart.types";
 /**
  * Emits a addProductToCart event to every configured provider.
  *
- * Log this event when the users add a product to the cart.
+ * Log this event when users add a product to the cart.
  *
  * @since 0.5.14
  * @property {AddProductToCartParams} params AddProductToCart event parameters

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

@@ -2,7 +2,7 @@ import { AddProductToWishlistParams } from "./addProductToWishlist.types";
 /**
  * Emits a addProductToWishlist event to every configured provider.
  *
- * Log this event when the users add a product to the wishlist.
+ * Log this event when users add a product to the wishlist.
  *
  * @since 0.5.14
  * @property {AddProductToWishlistParams} params AddProductToWishlist event parameters

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

@@ -2,7 +2,7 @@ import { RemoveProductFromCartParams } from "./removeProductFromCart.types";
 /**
  * Emits a removeProductFromCart event to every configured provider.
  *
- * Log this event when the users remove a product from the cart.
+ * Log this event when users remove a product from the cart.
  *
  * @since 0.5.14
  * @property {RemoveProductFromCartParams} params RemoveProductFromCart event parameters

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

@@ -2,7 +2,7 @@ import { RemoveProductFromWishlistParams } from "./removeProductFromWishlist.typ
 /**
  * Emits a removeProductFromWishlist event to every configured provider.
  *
- * Log this event when the users remove a product from the wishlist.
+ * Log this event when users remove a product from the wishlist.
  *
  * @since 0.5.14
  * @property {RemoveProductFromWishlistParams} params RemoveProductFromWishlist event parameters

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

@@ -2,7 +2,7 @@ import { UpdateProductInCartParams } from "./updateProductInCart.types";
 /**
  * Emits a updateProductInCart event to every configured provider.
  *
- * Log this event when the users update a product that was added earlier to the
+ * Log this event when users update a product that was added earlier to the
  * cart.
  *
  * @since 0.5.14

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

@@ -2,7 +2,7 @@ import { UpdateProductInWishlistParams } from "./updateProductInWishlist.types";
 /**
  * Emits a updateProductInWishlist event to every configured provider.
  *
- * Log this event when the users update a product that was added earlier to the
+ * Log this event when users update a product that was added earlier to the
  * wishlist.
  *
  * @since 0.5.14

package/build/src/lib/events/shoppingCart/viewCart/viewCart.d.ts

@@ -2,7 +2,7 @@ import { ViewCartParams } from "./viewCart.types";
 /**
  * Emits a viewCart event to every configured provider.
  *
- * Log this event when the users view the cart.
+ * Log this event when users view the cart.
  *
  * @since 0.5.14
  * @property {ViewCartParams} params ViewCart event parameters

package/build/src/lib/events/social/share/share.d.ts

@@ -2,7 +2,7 @@ import { ShareParams } from "./share.types";
 /**
  * Emits a share event to every configured provider.
  *
- * Log this event when
+ * Log this event when users share any content of the application.
  *
  * @since 0.5.14
  * @property {ShareParams} params Share event parameters

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

@@ -5,9 +5,9 @@ import { ShareParams as FacebookShareParams } from "../../../providers/FacebookP
  *
  * @interface ShareCommonParams
  * @since 0.5.14
- * @property {string} shareTarget The mean or plarform by which the user will share some content (e.g. link, Facebook)
- * @property {string|number} itemId The content identifier that will be shared
- * @property {string} itemName The content name that will be shared
+ * @property {string} shareTarget The mean or platform by which the user will share some content (e.g. link, Facebook)
+ * @property {string|number} itemId The identifier of the content to be shared
+ * @property {string} itemName The name of the content to be shared
  */
 export interface ShareCommonParams {
     shareTarget: string;

package/build/src/lib/events/store/setStore/setStore.d.ts

@@ -2,7 +2,7 @@ import { SetStoreParams } from "./setStore.types";
 /**
  * Emits a setStore event to every configured provider.
  *
- * Log this event when the users set a store for the first time.
+ * Log this event when users set a store for the first time.
  *
  * @since 0.5.14
  * @property {SetStoreParams} params SetStore event parameters

package/build/src/lib/events/user/setUserInfo/setUserInfo.d.ts

@@ -2,7 +2,7 @@ import { SetUserInfoParams } from "./setUserInfo.types";
 /**
  * Emits a setUserInfo event to every configured provider.
  *
- * Log this event when the users set data like their birthdate, phone number,
+ * Log this event when users set data like their birthdate, phone number,
  * etc.
  *
  * @since 0.5.14

package/build/src/lib/events/user/updateUserInfo/updateUserInfo.d.ts

@@ -2,7 +2,7 @@ import { UpdateUserInfoParams } from "./updateUserInfo.types";
 /**
  * Emits an updateUserInfo event to every configured provider.
  *
- * Log this event when the users update data like their birthdate, phone number,
+ * Log this event when users update data like their birthdate, phone number,
  * etc.
  *
  * @since 0.5.14

package/build/src/lib/events/vendor/setVendor/setVendor.d.ts

@@ -2,7 +2,7 @@ import { SetVendorParams } from "./setVendor.types";
 /**
  * Emits a setVendor event to every configured provider.
  *
- * Log this event when the users set the vendor for the first time.
+ * Log this event when users set the vendor for the first time.
  *
  * @since 0.5.14
  * @property {SetVendorParams} params SetVendor event parameters

package/build/src/lib/events/workflow/selectWorkflow/selectWorkflow.d.ts

@@ -2,7 +2,7 @@ import { SelectWorkflowParams } from "./selectWorkflow.types";
 /**
  * Emits a SelectWorkflow event to every configured provider.
  *
- * Log this event when the users set the workflow for the first time.
+ * Log this event when users set the workflow for the first time.
  *
  * @since 0.5.14
  * @property {SelectWorkflowParams} params SelectWorkflow event parameters

package/build/src/lib/providers/FacebookPixel/events/order/rateOrder/rateOrder.types.d.ts

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@artisan-commerce/analytics-web",
   "description": "Artisan commerce analytics web library",
-  "version": "0.1.0-canary.3",
+  "version": "0.1.0-canary.4",
   "main": "./build/main.bundle.js",
   "types": "./build/src/index.d.ts",
   "files": [
@@ -84,5 +84,5 @@
     "@artisan-commerce/products": "*",
     "@artisan-commerce/shopping-cart": "*"
   },
-  "gitHead": "8f5a6cbbc54829581ad40f3da57e93f745cc8cad"
+  "gitHead": "cbbfc21f2de6539d23c668d7f0997c77274a5a9e"
 }