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

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

@@ -1,12 +1,12 @@
 /**
  * Google Analytics event shared parameters.
  *
- * @interface ArtisanCommonEventParams
+ * @interface ArtisnCommonEventParams
  * @since 0.5.14
  * @property {string} userId The user's unique identifier between platforms
  */
-export interface ArtisanCommonEventParams {
-    artisanName?: string;
+export interface ArtisnCommonEventParams {
+    artisnName?: string;
 }
 /**
  * Workflow types.

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

@@ -7,8 +7,8 @@ import { FilterProductsParams as SegmentFilterProductsParams } from "../../../pr
  * @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 filters e.g. ["brand:Artisan"]
- * @property {string} categoryId if the list is an artisan category, the category id
+ * @property {string} filterBy key:value list of filters e.g. ["brand:Artisn"]
+ * @property {string} categoryId if the list is an artisn category, the category id
  */
 export interface FilterProductsCommonParams {
     list: string;

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

@@ -9,7 +9,7 @@ import { SortProductsParams as SegmentSortProductsParams } from "../../../provid
  * @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} categoryId if the list is an artisan category, the category id
+ * @property {string} categoryId if the list is an artisn category, the category id
  */
 export interface SortProductsCommonParams {
     list: string;

package/build/src/lib/initAnalytics/initAnalytics.types.d.ts

@@ -10,7 +10,7 @@ import { AnalyticsProviderTypes } from "../../types/event.types";
  * @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 {boolean} shareArtisanAnalytics Share e-commerce analytics with Trade
+ * @property {boolean} shareArtisnAnalytics Share e-commerce analytics with Trade
  * @property {InitAnalyticsConfigMeta} meta Commerce's metadata
  */
 export interface InitAnalyticsConfig {
@@ -18,7 +18,7 @@ export interface InitAnalyticsConfig {
     activeVendor?: Vendor["id"];
     vendors: Vendor["id"][] | undefined;
     debug?: boolean;
-    shareArtisanAnalytics?: boolean;
+    shareArtisnAnalytics?: boolean;
     meta: InitAnalyticsConfigMeta;
 }
 /**
@@ -32,7 +32,7 @@ export interface InitAnalyticsConfig {
  * @property {string} storeName The name of the active store
  * @property {number} catalogueId The id of the active catalogue
  * @property {string} catalogueName The name of the active catalogue
- * @property {ArtisanPlatform} platform The type of platform it is running on
+ * @property {ArtisnPlatform} platform The type of platform it is running on
  */
 export interface InitAnalyticsConfigMeta extends Omit<AnalyticsMeta, "vendorId" | "versionSDK" | "platform" | "vendorName" | "storeId" | "storeName" | "catalogueId" | "catalogueName"> {
     vendorName?: AnalyticsMeta["vendorName"] | undefined;

package/build/src/lib/providers/AnalyticsProvider/AnalyticsProvider.d.ts

@@ -17,7 +17,7 @@ declare abstract class AnalyticsProvider implements IAnaliticsProvider {
      *
      * @constructs
      * @since 0.5.14
-     * @param {Config} config artisan's account unique identifier.
+     * @param {Config} config artisn's account unique identifier.
      */
     constructor(config: Config);
     /**

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

@@ -83,7 +83,7 @@ export declare namespace Segment {
         value?: number;
         accountId?: number;
         app_name?: string;
-        artisan_event?: string;
+        artisn_event?: string;
         name?: string;
         platform?: string;
         price?: number;

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

@@ -1,18 +1,18 @@
-import { Account, ArtisanPlatform, Catalogue } from "@artisan-commerce/types";
+import { Account, ArtisnPlatform, Catalogue } from "@artisan-commerce/types";
 import { Store, Vendor } from "@artisan-commerce/types";
 import { FacebookPixelProviderConfig } from "../lib/providers/FacebookPixel/FacebookPixel.types";
 import { GoogleAnalyticsProviderConfig } from "../lib/providers/GoogleAnalytics/GoogleAnalytics.types";
 /**
  * Analytics providers configurable options.
  *
- * @typedef ArtisanPlatform
+ * @typedef ArtisnPlatform
  * @since 0.5.14
  */
 export declare type AnalyticsProvidersConfigs = Partial<GoogleAnalyticsProviderConfig> | Partial<FacebookPixelProviderConfig>;
 /**
  * Analytics event metadata to be included in every sent event.
  *
- * @interface ArtisanPlatform
+ * @interface ArtisnPlatform
  * @since 0.5.14
  * @property {number} accountId the id of the account it is running on
  * @property {number} vendorId the id of the active vendor
@@ -24,7 +24,7 @@ export declare type AnalyticsProvidersConfigs = Partial<GoogleAnalyticsProviderC
  * @property {string} versionSDK the Analytics SDK version
  * @property {string} versionApp the running on app version
  * @property {string} appName the name of the app
- * @property {ArtisanPlatform} platform the type of platform it is running on
+ * @property {ArtisnPlatform} platform the type of platform it is running on
  */
 export interface AnalyticsMeta {
     accountId: Account["accountId"];
@@ -37,12 +37,12 @@ export interface AnalyticsMeta {
     versionSDK: string;
     versionApp: string;
     appName: string;
-    platform: ArtisanPlatform;
+    platform: ArtisnPlatform;
 }
 /**
  * Analytics supported providers.
  *
- * @typedef ArtisanPlatform
+ * @typedef ArtisnPlatform
  * @since 0.5.14
  */
 export declare type SupportedProviders = "GOOGLE_ANALYTICS" | "FACEBOOK_PIXEL" | "SEGMENT";

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

@@ -5,194 +5,194 @@ import GlobalProvider from "../lib/providers/GlobalProvider/GlobalProvider";
 import { GoogleAnalyticsProvider } from "../lib/providers/GoogleAnalytics/GoogleAnalytics.types";
 import { SegmentProvider } from "../lib/providers/Segment/Segment.types";
 /**
- * Types of artisan analytics providers
+ * Types of artisn analytics providers
  *
  * @typedef AnalyticsProviderTypes
  * @since 0.5.14
  */
 export declare type AnalyticsProviderTypes = AnalyticsProvider | GlobalProvider;
 /**
- * Artisan Auth event names type
+ * Artisn Auth event names type
  *
- * @typedef ArtisanAuthEventNames
+ * @typedef ArtisnAuthEventNames
  * @since 0.5.14
  */
-export declare type ArtisanAuthEventNames = "changePasswordAttempt" | "changePasswordFail" | "changePasswordSuccess" | "signIn" | "signOut" | "signUp" | "signUpAttempt";
+export declare type ArtisnAuthEventNames = "changePasswordAttempt" | "changePasswordFail" | "changePasswordSuccess" | "signIn" | "signOut" | "signUp" | "signUpAttempt";
 /**
- * Artisan Banner event names type
+ * Artisn Banner event names type
  *
- * @typedef ArtisanBannerEventNames
+ * @typedef ArtisnBannerEventNames
  * @since 0.5.14
  */
-export declare type ArtisanBannerEventNames = "bannerImpression" | "selectBanner";
+export declare type ArtisnBannerEventNames = "bannerImpression" | "selectBanner";
 /**
- * Artisan Billing event names type
+ * Artisn Billing event names type
  *
- * @typedef ArtisanBillingEventNames
+ * @typedef ArtisnBillingEventNames
  * @since 0.5.14
  */
-export declare type ArtisanBillingEventNames = "addBillingInfo" | "selectBillingInfo" | "updateBillingInfo";
+export declare type ArtisnBillingEventNames = "addBillingInfo" | "selectBillingInfo" | "updateBillingInfo";
 /**
- * Artisan Booking event names type
+ * Artisn Booking event names type
  *
- * @typedef ArtisanBookingEventNames
+ * @typedef ArtisnBookingEventNames
  * @since 0.5.14
  */
-export declare type ArtisanBookingEventNames = "bookAppointment";
+export declare type ArtisnBookingEventNames = "bookAppointment";
 /**
- * Artisan Category event names type
+ * Artisn Category event names type
  *
- * @typedef ArtisanCategoryEventNames
+ * @typedef ArtisnCategoryEventNames
  * @since 0.5.14
  */
-export declare type ArtisanCategoryEventNames = "categoryImpression" | "searchCategoryAttempt" | "selectCategory" | "viewCategory";
+export declare type ArtisnCategoryEventNames = "categoryImpression" | "searchCategoryAttempt" | "selectCategory" | "viewCategory";
 /**
- * Artisan Checkout event names type
+ * Artisn Checkout event names type
  *
- * @typedef ArtisanCheckoutEventNames
+ * @typedef ArtisnCheckoutEventNames
  * @since 0.5.14
  */
-export declare type ArtisanCheckoutEventNames = "checkoutAction" | "initiateCheckout";
+export declare type ArtisnCheckoutEventNames = "checkoutAction" | "initiateCheckout";
 /**
- * Artisan Coupon event names type
+ * Artisn Coupon event names type
  *
- * @typedef ArtisanCouponEventNames
+ * @typedef ArtisnCouponEventNames
  * @since 0.5.14
  */
-export declare type ArtisanCouponEventNames = "applyBenefit" | "couponCodeError" | "redeemCouponCode" | "removeBenefit" | "viewBenefitDetails" | "viewBenefitsWallet" | "viewQRStoreCoupon";
+export declare type ArtisnCouponEventNames = "applyBenefit" | "couponCodeError" | "redeemCouponCode" | "removeBenefit" | "viewBenefitDetails" | "viewBenefitsWallet" | "viewQRStoreCoupon";
 /**
- * Artisan Credit event names type
+ * Artisn Credit event names type
  *
- * @typedef ArtisanCreditEventNames
+ * @typedef ArtisnCreditEventNames
  * @since 0.5.14
  */
-export declare type ArtisanCreditEventNames = "addCredits" | "spendCredits" | "viewCredits";
+export declare type ArtisnCreditEventNames = "addCredits" | "spendCredits" | "viewCredits";
 /**
- * Artisan Fulfillment event names type
+ * Artisn Fulfillment event names type
  *
- * @typedef ArtisanFulfillmentEventNames
+ * @typedef ArtisnFulfillmentEventNames
  * @since 0.5.14
  */
-export declare type ArtisanFulfillmentEventNames = "viewFulfillmentStep" | "viewTracking";
+export declare type ArtisnFulfillmentEventNames = "viewFulfillmentStep" | "viewTracking";
 /**
- * Artisan Geo event names type
+ * Artisn Geo event names type
  *
- * @typedef ArtisanGeoEventNames
+ * @typedef ArtisnGeoEventNames
  * @since 0.5.14
  */
-export declare type ArtisanGeoEventNames = "changeLocation" | "findLocation" | "outOfCoverage" | "setLocation";
+export declare type ArtisnGeoEventNames = "changeLocation" | "findLocation" | "outOfCoverage" | "setLocation";
 /**
- * Artisan Help event names type
+ * Artisn Help event names type
  *
- * @typedef ArtisanHelpEventNames
+ * @typedef ArtisnHelpEventNames
  * @since 0.5.14
  */
-export declare type ArtisanHelpEventNames = "requestAssistance";
+export declare type ArtisnHelpEventNames = "requestAssistance";
 /**
- * Artisan Loyalty event names type
+ * Artisn Loyalty event names type
  *
- * @typedef ArtisanLoyaltyEventNames
+ * @typedef ArtisnLoyaltyEventNames
  * @since 0.5.14
  */
-export declare type ArtisanLoyaltyEventNames = "earnPoints" | "sharePoints" | "spendPoints" | "viewLoyaltyLevel";
+export declare type ArtisnLoyaltyEventNames = "earnPoints" | "sharePoints" | "spendPoints" | "viewLoyaltyLevel";
 /**
- * Artisan Order event names type
+ * Artisn Order event names type
  *
- * @typedef ArtisanOrderEventNames
+ * @typedef ArtisnOrderEventNames
  * @since 0.5.14
  */
-export declare type ArtisanOrderEventNames = "cancelOrder" | "rateOrder" | "requestRefund";
+export declare type ArtisnOrderEventNames = "cancelOrder" | "rateOrder" | "requestRefund";
 /**
- * Artisan Other event names type
+ * Artisn Other event names type
  *
- * @typedef ArtisanOtherEventNames
+ * @typedef ArtisnOtherEventNames
  * @since 0.5.14
  */
-export declare type ArtisanOtherEventNames = "generateLead" | "pageView" | "searchPageContent";
+export declare type ArtisnOtherEventNames = "generateLead" | "pageView" | "searchPageContent";
 /**
- * Artisan Payment event names type
+ * Artisn Payment event names type
  *
- * @typedef ArtisanPaymentEventNames
+ * @typedef ArtisnPaymentEventNames
  * @since 0.5.14
  */
-export declare type ArtisanPaymentEventNames = "changePaymentType" | "selectPaymentType" | "setPaymentInfo";
+export declare type ArtisnPaymentEventNames = "changePaymentType" | "selectPaymentType" | "setPaymentInfo";
 /**
- * Artisan Product event names type
+ * Artisn Product event names type
  *
- * @typedef ArtisanProductEventNames
+ * @typedef ArtisnProductEventNames
  * @since 0.5.14
  */
-export declare type ArtisanProductEventNames = "customizeProduct" | "filterProducts" | "productImpression" | "searchProductAttempt" | "searchProductNotFound" | "searchProductSuccess" | "selectProduct" | "sortProducts" | "viewProductDetails";
+export declare type ArtisnProductEventNames = "customizeProduct" | "filterProducts" | "productImpression" | "searchProductAttempt" | "searchProductNotFound" | "searchProductSuccess" | "selectProduct" | "sortProducts" | "viewProductDetails";
 /**
- * Artisan Purchase event names type
+ * Artisn Purchase event names type
  *
- * @typedef ArtisanPurchaseEventNames
+ * @typedef ArtisnPurchaseEventNames
  * @since 0.5.14
  */
-export declare type ArtisanPurchaseEventNames = "purchaseAttempt" | "purchaseFail" | "purchaseSuccess";
+export declare type ArtisnPurchaseEventNames = "purchaseAttempt" | "purchaseFail" | "purchaseSuccess";
 /**
- * Artisan Settings event names type
+ * Artisn Settings event names type
  *
- * @typedef ArtisanSettingsEventNames
+ * @typedef ArtisnSettingsEventNames
  * @since 0.5.14
  */
-export declare type ArtisanSettingsEventNames = "viewSettings";
+export declare type ArtisnSettingsEventNames = "viewSettings";
 /**
- * Artisan Shipping event names type
+ * Artisn Shipping event names type
  *
- * @typedef ArtisanShippingEventNames
+ * @typedef ArtisnShippingEventNames
  * @since 0.5.14
  */
-export declare type ArtisanShippingEventNames = "addShippingAddress" | "selectShippingAddress" | "updateShippingAddress";
+export declare type ArtisnShippingEventNames = "addShippingAddress" | "selectShippingAddress" | "updateShippingAddress";
 /**
- * Artisan ShoppingCart event names type
+ * Artisn ShoppingCart event names type
  *
- * @typedef ArtisanShoppingCartEventNames
+ * @typedef ArtisnShoppingCartEventNames
  * @since 0.5.14
  */
-export declare type ArtisanShoppingCartEventNames = "addProductToCart" | "addProductToWishlist" | "clearCart" | "removeProductFromCart" | "removeProductFromWishlist" | "updateProductInCart" | "updateProductInWishlist" | "viewCart";
+export declare type ArtisnShoppingCartEventNames = "addProductToCart" | "addProductToWishlist" | "clearCart" | "removeProductFromCart" | "removeProductFromWishlist" | "updateProductInCart" | "updateProductInWishlist" | "viewCart";
 /**
- * Artisan Social event names type
+ * Artisn Social event names type
  *
- * @typedef ArtisanSocialEventNames
+ * @typedef ArtisnSocialEventNames
  * @since 0.5.14
  */
-export declare type ArtisanSocialEventNames = "share";
+export declare type ArtisnSocialEventNames = "share";
 /**
- * Artisan Store event names type
+ * Artisn Store event names type
  *
- * @typedef ArtisanStoreEventNames
+ * @typedef ArtisnStoreEventNames
  * @since 0.5.14
  */
-export declare type ArtisanStoreEventNames = "changeStore" | "setStore";
+export declare type ArtisnStoreEventNames = "changeStore" | "setStore";
 /**
- * Artisan User event names type
+ * Artisn User event names type
  *
- * @typedef ArtisanUserEventNames
+ * @typedef ArtisnUserEventNames
  * @since 0.5.14
  */
-export declare type ArtisanUserEventNames = "setUserInfo" | "updateUserInfo";
+export declare type ArtisnUserEventNames = "setUserInfo" | "updateUserInfo";
 /**
- * Artisan Vendor event names type
+ * Artisn Vendor event names type
  *
- * @typedef ArtisanVendorEventNames
+ * @typedef ArtisnVendorEventNames
  * @since 0.5.14
  */
-export declare type ArtisanVendorEventNames = "changeVendor" | "setVendor";
+export declare type ArtisnVendorEventNames = "changeVendor" | "setVendor";
 /**
- * Artisan Workflow event names type
+ * Artisn Workflow event names type
  *
- * @typedef ArtisanWorkflowEventNames
+ * @typedef ArtisnWorkflowEventNames
  * @since 0.5.14
  */
-export declare type ArtisanWorkflowEventNames = "selectWorkflow" | "updateWorkflow";
+export declare type ArtisnWorkflowEventNames = "selectWorkflow" | "updateWorkflow";
 /**
- * Artisan  event names type
+ * Artisn  event names type
  *
- * @typedef ArtisanEventNames
+ * @typedef ArtisnEventNames
  * @since 0.5.14
  */
-export declare type ArtisanEventNames = ArtisanAuthEventNames | ArtisanBannerEventNames | ArtisanBillingEventNames | ArtisanBookingEventNames | ArtisanCategoryEventNames | ArtisanCheckoutEventNames | ArtisanCouponEventNames | ArtisanCreditEventNames | ArtisanFulfillmentEventNames | ArtisanGeoEventNames | ArtisanHelpEventNames | ArtisanLoyaltyEventNames | ArtisanOrderEventNames | ArtisanOtherEventNames | ArtisanPaymentEventNames | ArtisanProductEventNames | ArtisanPurchaseEventNames | ArtisanSettingsEventNames | ArtisanShippingEventNames | ArtisanShoppingCartEventNames | ArtisanSocialEventNames | ArtisanStoreEventNames | ArtisanUserEventNames | ArtisanVendorEventNames | ArtisanWorkflowEventNames;
+export declare type ArtisnEventNames = ArtisnAuthEventNames | ArtisnBannerEventNames | ArtisnBillingEventNames | ArtisnBookingEventNames | ArtisnCategoryEventNames | ArtisnCheckoutEventNames | ArtisnCouponEventNames | ArtisnCreditEventNames | ArtisnFulfillmentEventNames | ArtisnGeoEventNames | ArtisnHelpEventNames | ArtisnLoyaltyEventNames | ArtisnOrderEventNames | ArtisnOtherEventNames | ArtisnPaymentEventNames | ArtisnProductEventNames | ArtisnPurchaseEventNames | ArtisnSettingsEventNames | ArtisnShippingEventNames | ArtisnShoppingCartEventNames | ArtisnSocialEventNames | ArtisnStoreEventNames | ArtisnUserEventNames | ArtisnVendorEventNames | ArtisnWorkflowEventNames;
 /**
  * ProvidersHandlers interface
  *

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

@@ -6,7 +6,7 @@ export interface GlobalState {
     activeVendor?: StrictInitAnalyticsConfig["activeVendor"];
     vendors: StrictInitAnalyticsConfig["vendors"];
     debug: StrictInitAnalyticsConfig["debug"];
-    shareArtisanAnalytics: StrictInitAnalyticsConfig["shareArtisanAnalytics"];
+    shareArtisnAnalytics: StrictInitAnalyticsConfig["shareArtisnAnalytics"];
     meta: GlobalStateMeta;
 }
 export interface GlobalStateMeta extends Omit<AnalyticsMeta, "accountId" | "vendorId" | "vendorName" | "storeId" | "storeName" | "catalogueId" | "catalogueName" | "appName" | "versionApp"> {

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

@@ -7,7 +7,7 @@ import { Segment } from "../lib/providers/Segment/Segment.types";
  * Triage event to each provider handler.
  *
  * @since 0.5.14
- * @param {string} eventName The Artisan event name
+ * @param {string} eventName The Artisn event name
  * @param {T} params The event parameters
  * @param {ProvidersHandlers<T>} providersHandlers The providers handlers
  */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@artisan-commerce/analytics-web",
-  "description": "Artisan commerce analytics web library",
-  "version": "0.1.1-canary.2",
+  "description": "Artisn commerce analytics web library",
+  "version": "0.2.0-canary.0",
   "main": "./build/main.bundle.js",
   "types": "./build/src/index.d.ts",
   "files": [
@@ -10,10 +10,10 @@
     "README.md"
   ],
   "scripts": {
-    "start": "webpack --config webpack.dev.js",
-    "dev": "yarn start",
+    "compile": "webpack --config webpack.dev.js",
+    "dev": "yarn compile",
     "build": "webpack --config webpack.prod.js",
-    "start:build": "nodemon ./build/main.bundle.js",
+    "compile:build": "nodemon ./build/main.bundle.js",
     "test": "jest  --watchAll --runInBand",
     "test:all": "yarn test --watchAll=false --coverage",
     "test:ci": "cross-env CI=true jest --runInBand",
@@ -30,13 +30,13 @@
   "author": "Luis Eduardo Andrade",
   "license": "MIT",
   "dependencies": {
-    "@artisan-commerce/state": "0.2.2",
+    "@artisan-commerce/state": "0.3.0-canary.0",
     "snake-case": "^3.0.4"
   },
   "devDependencies": {
-    "@artisan-commerce/products": "0.9.0-canary.1",
-    "@artisan-commerce/shopping-cart": "0.11.1-canary.2",
-    "@artisan-commerce/types": "0.14.0-canary.1",
+    "@artisan-commerce/products": "0.9.0-canary.2",
+    "@artisan-commerce/shopping-cart": "0.12.0-canary.0",
+    "@artisan-commerce/types": "0.14.0-canary.2",
     "@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": "caa730307125598ed71f2a24e10c7843a06e600d"
+  "gitHead": "61cd421cf586b967fe48a7502e1f3841c0877f0e"
 }