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

package/build/src/lib/events/loyalty/viewLoyaltyLevel/viewLoyaltyLevel.d.ts

@@ -2,7 +2,7 @@ import { ViewLoyaltyLevelParams } from "./viewLoyaltyLevel.types";
 /**
  * Emits a viewLoyaltyLevel event to every configured provider.
  *
- * Record this event when
+ * Log this event when users view a loyalty level.
  *
  * @since 0.5.14
  * @property {ViewLoyaltyLevelParams} params ViewLoyaltyLevel event parameters

package/build/src/lib/events/order/cancelOrder/cancelOrder.d.ts

@@ -2,7 +2,7 @@ import { CancelOrderParams } from "./cancelOrder.types";
 /**
  * Emits a cancelOrder event to every configured provider.
  *
- * Record this event when
+ * Log this event when users cancel an order.
  *
  * @since 0.5.14
  * @property {CancelOrderParams} params CancelOrder event parameters

package/build/src/lib/events/order/rateOrder/rateOrder.d.ts

@@ -2,7 +2,7 @@ import { RateOrderParams } from "./rateOrder.types";
 /**
  * Emits a rateOrder event to every configured provider.
  *
- * Record this event when
+ * Log this event when users rate an order.
  *
  * @since 0.5.14
  * @property {RateOrderParams} params RateOrder event parameters

package/build/src/lib/events/order/requestRefund/requestRefund.d.ts

@@ -2,7 +2,7 @@ import { RequestRefundParams } from "./requestRefund.types";
 /**
  * Emits a requestRefund event to every configured provider.
  *
- * Record this event when
+ * Log this event when users request a refund of the order.
  *
  * @since 0.5.14
  * @property {RequestRefundParams} params RequestRefund event parameters

package/build/src/lib/events/order/requestRefund/requestRefund.types.d.ts

@@ -6,6 +6,7 @@ import { RequestRefundParams as FacebookRequestRefundParams } from "../../../pro
  * @interface RequestRefundCommonParams
  * @since 0.5.14
  * @property {string} orderId The orders unique identifier
+ * @property {number} orderTotal The total cost of the order
  * @property {string} reason The reason by which the user is requesting a refund of the order
  */
 export interface RequestRefundCommonParams {

package/build/src/lib/events/other/generateLead/generateLead.d.ts

@@ -2,7 +2,7 @@ import { GenerateLeadParams } from "./generateLead.types";
 /**
  * Emits a generateLead event to every configured provider.
  *
- * Record this event when
+ * Log this event when users take an action that tells you they can be a lead.
  *
  * @since 0.5.14
  * @property {GenerateLeadParams} params GenerateLead event parameters

package/build/src/lib/events/other/pageView/pageView.d.ts

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

package/build/src/lib/events/other/pageView/pageView.types.d.ts

@@ -5,8 +5,8 @@ import { PageViewParams as FacebookPageViewParams } from "../../../providers/Fac
  *
  * @interface PageViewCommonParams
  * @since 0.5.14
- * @property {string} pathname The visited url path
- * @property {string} name The name of the visited path
+ * @property {string} pathname The name of the visited path, this value must start with a / character
+ * @property {string} name The title of the page
  */
 export interface PageViewCommonParams {
     pathname?: string;

package/build/src/lib/events/other/searchPageContent/searchPageContent.d.ts

@@ -2,7 +2,7 @@ import { SearchPageContentParams } from "./searchPageContent.types";
 /**
  * Emits a searchPageContent event to every configured provider.
  *
- * Record this event when
+ * Log this event when users search for any content in the application.
  *
  * @since 0.5.14
  * @property {SearchPageContentParams} params SearchPageContent event parameters

package/build/src/lib/events/other/searchPageContent/searchPageContent.types.d.ts

@@ -5,7 +5,7 @@ import { SearchPageContentParams as FacebookSearchPageContentParams } from "../.
  *
  * @interface SearchPageContentCommonParams
  * @since 0.5.14
- * @property {string} query The searched query
+ * @property {string} query The searched text
  */
 export interface SearchPageContentCommonParams {
     query: string;

package/build/src/lib/events/payment/changePaymentType/changePaymentType.d.ts

@@ -2,7 +2,7 @@ import { ChangePaymentTypeParams } from "./changePaymentType.types";
 /**
  * Emits a changePaymentType event to every configured provider.
  *
- * Record this event when
+ * Log this event when users change the payment type.
  *
  * @since 0.5.14
  * @property {ChangePaymentTypeParams} params ChangePaymentType event parameters

package/build/src/lib/events/payment/changePaymentType/changePaymentType.types.d.ts

@@ -7,12 +7,16 @@ import { PaymentType } from "../../events.types";
  * @interface ChangePaymentTypeCommonParams
  * @since 0.5.14
  * @property {PaymentType} previousPaymentType The previously set payment type
- * @property {PaymentType} nextPayamentType The new set payment type
+ * @property {string} previousCardType If was paying with card, the previously set card provider (e.g. visa)
+ * @property {PaymentType} nextPaymentType The new set payment type
+ * @property {string} nextCardType If paying with card, the new card provider
  * @property {number} orderTotal The total cost of the order
  */
 export interface ChangePaymentTypeCommonParams {
     previousPaymentType: PaymentType;
-    nextPayamentType: PaymentType;
+    previousCardType?: string;
+    nextPaymentType: PaymentType;
+    nextCardType?: string;
     orderTotal: number;
 }
 /**

package/build/src/lib/events/payment/selectPaymentType/selectPaymentType.d.ts

@@ -2,7 +2,7 @@ import { SelectPaymentTypeParams } from "./selectPaymentType.types";
 /**
  * Emits a selectPaymentType event to every configured provider.
  *
- * Record this event when
+ * Log this event when users select the payment type.
  *
  * @since 0.5.14
  * @property {SelectPaymentTypeParams} params SelectPaymentType event parameters

package/build/src/lib/events/payment/selectPaymentType/selectPaymentType.types.d.ts

@@ -6,11 +6,11 @@ import { PaymentType } from "../../events.types";
  *
  * @interface SelectPaymentTypeCommonParams
  * @since 0.5.14
- * @property {PaymentType} payamentType The new set payment type (e.g. Cash)
+ * @property {PaymentType} paymentType The new set payment type (e.g. Cash)
  * @property {number} orderTotal The total cost of the order
  */
 export interface SelectPaymentTypeCommonParams {
-    payamentType: PaymentType;
+    paymentType: PaymentType;
     orderTotal: number;
 }
 /**

package/build/src/lib/events/payment/setPaymentInfo/setPaymentInfo.d.ts

@@ -2,7 +2,7 @@ import { SetPaymentInfoParams } from "./setPaymentInfo.types";
 /**
  * Emits a setPaymentInfo event to every configured provider.
  *
- * Record this event when
+ * Log this event when users set the payment type for the first time.
  *
  * @since 0.5.14
  * @property {SetPaymentInfoParams} params SetPaymentInfo event parameters

package/build/src/lib/events/payment/setPaymentInfo/setPaymentInfo.types.d.ts

@@ -7,12 +7,12 @@ import { PaymentType } from "../../events.types";
  * @interface SetPaymentInfoCommonParams
  * @since 0.5.14
  * @property {number} orderTotal The total cost of the order
- * @property {PaymentType} payamentType The new set payment type (e.g. Cash)
- * @property {string} cardType If paying with card the card provider (e.g. visa)
+ * @property {PaymentType} paymentType The new set payment type (e.g. Cash)
+ * @property {string} cardType If paying with card, the card provider (e.g. visa)
  */
 export interface SetPaymentInfoCommonParams {
     orderTotal: number;
-    payamentType: PaymentType;
+    paymentType: PaymentType;
     cardType?: string;
 }
 /**

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

@@ -2,7 +2,7 @@ import { CustomizeProductParams } from "./customizeProduct.types";
 /**
  * Emits a customizeProduct event to every configured provider.
  *
- * Record this event when
+ * Log this event when users add extras to the base offered product.
  *
  * @since 0.5.14
  * @property {CustomizeProductParams} params CustomizeProduct event parameters

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.
  *
- * Record this event when
+ * 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/filterProducts/filterProducts.types.d.ts

@@ -6,7 +6,7 @@ import { FilterProductsParams as FacebookFilterProductsParams } from "../../../p
  * @interface FilterProductsCommonParams
  * @since 0.5.14
  * @property {string} list the name of the list of products to filter
- * @property {string} filterBy key:value list of filtera e.g. ["brand:Artisan"]
+ * @property {string} filterBy key:value list of filters e.g. ["brand:Artisan"]
  * @property {string} categoryId if the list is an artisan category, the category id
  */
 export interface FilterProductsCommonParams {

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

@@ -2,7 +2,7 @@ import { ProductImpressionParams } from "./productImpression.types";
 /**
  * Emits a productImpression event to every configured provider.
  *
- * Record this event when
+ * Log this event when a product is visible on the screen.
  *
  * @since 0.5.14
  * @property {ProductImpressionParams} params ProductImpression 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.
  *
- * Record this event when
+ * 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/searchProductNotFound/searchProductNotFound.d.ts

@@ -2,7 +2,7 @@ import { SearchProductNotFoundParams } from "./searchProductNotFound.types";
 /**
  * Emits a searchProductNotFound event to every configured provider.
  *
- * Record this event when
+ * Log this event when your search request has failed.
  *
  * @since 0.5.14
  * @property {SearchProductNotFoundParams} params SearchProductNotFound event parameters

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

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

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

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

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.
  *
- * Record this event when
+ * 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/product/sortProducts/sortProducts.types.d.ts

@@ -6,8 +6,8 @@ import { SortProductsParams as FacebookSortProductsParams } from "../../../provi
  * @interface SortProductsCommonParams
  * @since 0.5.14
  * @property {string} list the name of the list of products to sort
- * @property {string} sortBy sort attribute by e.g. "alphabetical"
- * @property {string} sortMethod method used to sort e.g. "asc"
+ * @property {string} sortBy sort attribute by (e.g. alphabetical)
+ * @property {string} sortMethod method used to sort (e.g. asc)
  * @property {string} categoryId if the list is an artisan category, the category id
  */
 export interface SortProductsCommonParams {

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

@@ -2,7 +2,8 @@ import { ViewProductDetailsParams } from "./viewProductDetails.types";
 /**
  * Emits a viewProductDetails event to every configured provider.
  *
- * Record this event when
+ * Log this event when the details of a product load successfully and are shown
+ * to the user.
  *
  * @since 0.5.14
  * @property {ViewProductDetailsParams} params ViewProductDetails event parameters

package/build/src/lib/events/product/viewProductDetails/viewProductDetails.types.d.ts

@@ -7,7 +7,7 @@ import { ViewProductDetailsParams as FacebookViewProductDetailsParams } from "..
  * @interface ViewProductDetailsCommonParams
  * @since 0.5.14
  * @property {Product} product the product that the details are being viewed
- * @property {string} categoryId if user came from a category list, the category id
+ * @property {string} categoryId if the user came from a category list, the category id
  */
 export interface ViewProductDetailsCommonParams {
     product: Product;

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.
  *
- * Record 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.
  *
- * Record 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.
  *
- * Record 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.
  *
- * Record 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.
  *
- * Record 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.
  *
- * Record 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.
  *
- * Record 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.
  *
- * Record this event when
+ * 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.
  *
- * Record this event when
+ * 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/clearCart/clearCart.d.ts

@@ -2,7 +2,7 @@ import { ClearCartParams } from "./clearCart.types";
 /**
  * Emits a clearCart event to every configured provider.
  *
- * Record this event when
+ * Log this event when users empty the cart.
  *
  * @since 0.5.14
  * @property {ClearCartParams} params ClearCart 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.
  *
- * Record this event when
+ * 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/removeProductFromCart/removeProductFromCart.types.d.ts

@@ -6,7 +6,7 @@ import { RemoveProductFromCartParams as FacebookRemoveProductFromCartParams } fr
  *
  * @interface RemoveProductFromCartCommonParams
  * @since 0.5.14
- * @property {CartProduct} product The product that was added to the cart
+ * @property {CartProduct} product The product that was removed to the cart
  * @property {string} cartId Shopping cart identifier
  * @property {string} cartName Shopping cart name
  * @property {Store} store Store where the user is buying the product

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.
  *
- * Record this event when
+ * 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/removeProductFromWishlist/removeProductFromWishlist.types.d.ts

@@ -6,7 +6,7 @@ import { RemoveProductFromWishlistParams as FacebookRemoveProductFromWishlistPar
  *
  * @interface RemoveProductFromWishlistCommonParams
  * @since 0.5.14
- * @property {CartProduct} product The product that was added to the cart
+ * @property {CartProduct} product The product that was removed from the wishlist
  * @property {string} cartId Shopping cart identifier
  */
 export interface RemoveProductFromWishlistCommonParams {

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

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

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

@@ -6,7 +6,7 @@ import { CartProduct, ShoppingCart, Store } from "@artisan-commerce/types";
  *
  * @interface UpdateProductInCartCommonParams
  * @since 0.5.14
- * @property {CartProduct} product The product that was added to the cart
+ * @property {CartProduct} product The product in the cart that was updated
  * @property {string} cartId Shopping cart identifier
  * @property {string} cartName Shopping cart name
  * @property {Store} store Store where the user is buying the product

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

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

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

@@ -6,7 +6,7 @@ import { UpdateProductInWishlistParams as FacebookUpdateProductInWishlistParams
  *
  * @interface UpdateProductInWishlistCommonParams
  * @since 0.5.14
- * @property {CartProduct} product The product that was added to the cart
+ * @property {CartProduct} product The product in the wishlist that was updated
  * @property {string} cartId Shopping cart identifier
  * @property {string[]} fields The updated fields names
  */

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.
  *
- * Record this event when
+ * 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.
  *
- * Record 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/changeStore/changeStore.d.ts

@@ -2,7 +2,7 @@ import { ChangeStoreParams } from "./changeStore.types";
 /**
  * Emits a changeStore event to every configured provider.
  *
- * Record this event when
+ * Log this event when the selected store has changed.
  *
  * @since 0.5.14
  * @property {ChangeStoreParams} params ChangeStore event parameters

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.
  *
- * Record this event when
+ * 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,8 @@ import { SetUserInfoParams } from "./setUserInfo.types";
 /**
  * Emits a setUserInfo event to every configured provider.
  *
- * Record this event when
+ * Log this event when users set data like their birthdate, phone number,
+ * etc.
  *
  * @since 0.5.14
  * @property {SetUserInfoParams} params SetUserInfo event parameters

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

@@ -1,8 +1,9 @@
 import { UpdateUserInfoParams } from "./updateUserInfo.types";
 /**
- * Emits a updateUserInfo event to every configured provider.
+ * Emits an updateUserInfo event to every configured provider.
  *
- * Record this event when
+ * Log this event when users update data like their birthdate, phone number,
+ * etc.
  *
  * @since 0.5.14
  * @property {UpdateUserInfoParams} params UpdateUserInfo event parameters