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

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

@@ -2,7 +2,7 @@ import { ChangeVendorParams } from "./changeVendor.types";
 /**
  * Emits a changeVendor event to every configured provider.
  *
- * Record this event when
+ * Log this event when the vendor has change.
  *
  * @since 0.5.14
  * @property {ChangeVendorParams} params ChangeVendor event parameters

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

@@ -2,7 +2,7 @@ import { UpdateWorkflowParams } from "./updateWorkflow.types";
 /**
  * Emits a UpdateWorkflow event to every configured provider.
  *
- * Record this event when
+ * Log this event when the workflow has changed.
  *
  * @since 0.5.14
  * @property {UpdateWorkflowParams} params UpdateWorkflow event parameters

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

@@ -11,7 +11,7 @@ export declare const checkUniqueProviderNames: (providers: AnalyticsProviderType
  * Check if the given providers tracker ids are unique.
  *
  * @since 0.5.14
- * @param {AnalytcsProvider[]} providers Providers list
+ * @param {AnalyticsProviderTypes[]} providers Providers list
  * @returns {boolean} true if no provider trackerId clashes with another
  */
 export declare const checkUniqueProviderTrackerIds: (providers: AnalyticsProviderTypes[]) => boolean;

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

@@ -1,10 +1,22 @@
 import { Vendor } from "@artisan-commerce/types";
 import { AnalyticsMeta } from "../../types/common.types";
 import { AnalyticsProviderTypes } from "../../types/event.types";
+/**
+ * Initial configuration that can be passed to initAnalytics method.
+ *
+ * @interface InitAnalyticsConfig
+ * @since 0.5.14
+ * @property {AnalyticsProviderTypes[]} providers Analytics providers instances that can be targeted to emit events
+ * @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 {InitAnalyticsConfigMeta} meta Commerce's metadata
+ */
 export interface InitAnalyticsConfig {
     providers: AnalyticsProviderTypes[];
     activeVendor?: Vendor["id"];
-    vendors: Vendor["id"][];
+    vendors: Vendor["id"][] | undefined;
     debug?: boolean;
     shareArtisanAnalytics?: boolean;
     meta: InitAnalyticsConfigMeta;

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

@@ -26,7 +26,7 @@ declare abstract class AnalyticsProvider implements IAnaliticsProvider {
      * @since 0.5.14
      * @returns Analytics Provider vendors, if not specified it fallsback to the global vendors
      */
-    get vendors(): number[];
+    get vendors(): number[] | undefined;
     /**
      * Inserts the initialization script to the body of the document.
      *

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

@@ -23,10 +23,10 @@ export interface AnalyticsProviderConstructor {
  * @since 0.5.14
  * @property {Function} init Initializes the provider connection
  * @property {Function} updateConfig Updates the initial config of the provider
- * @property {Function} getVendors Return the provider selected vendors
+ * @property {number[]} vendors The provider selected vendors ids
  */
 export interface IAnaliticsProvider {
     init: () => void;
     updateConfig: (config: Partial<unknown>) => void;
-    vendors: Vendor["id"][];
+    vendors: Vendor["id"][] | undefined;
 }

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

@@ -17,7 +17,6 @@ export interface FacebookPixelProvider extends Omit<AnalyticsProviderConstructor
  *
  * @interface FacebookPixelProvider
  * @since 0.5.14
- * @property {string} userId the users unique identifier between devices
  * @property {CurrencyCodes} currency user's country monetary code
  */
 export interface FacebookPixelProviderConfig {
@@ -51,7 +50,7 @@ export declare namespace Fbq {
     }
     interface ControlParams {
     }
-    type EventNames = "PageView" | "CompleteRegistration" | "FindLocation" | "Search" | "CustomizeProduct" | "InitiateCheckout" | "AddPaymentInfo" | "Schedule" | "Purchase" | "Lead" | "AddToCart" | "AddToWishlist" | "Contact";
+    type EventNames = "PageView" | "CompleteRegistration" | "FindLocation" | "Search" | "CustomizeProduct" | "InitiateCheckout" | "AddPaymentInfo" | "Schedule" | "Purchase" | "Lead" | "AddToCart" | "AddToWishlist" | "Contact" | "ViewContent" | "SpendCredits";
     interface EventParams {
         currency?: string;
         value?: number;

package/build/src/lib/providers/FacebookPixel/events/category/searchCategoryAttempt/searchCategoryAttempt.types.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/loyalty/spendPoints/spendPoints.types.d.ts

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

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/build/src/lib/providers/FacebookPixel/events/other/searchPageContent/searchPageContent.types.d.ts

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

package/build/src/lib/providers/FacebookPixel/events/product/productImpression/productImpression.types.d.ts

@@ -8,7 +8,7 @@ import { FacebookPixelCustomEventParams } from "../../../FacebookPixel.types";
  * @since 0.5.14
  * @extends FacebookPixelCommonEventParams
  * @extends FacebookPixelCustomEventParams
- * @property {string} contentType The type of products being sold (e.g. food)
+ * @property {string} contentType The type of product the user had an impression on (e.g. food)
  */
 export interface ProductImpressionParams extends FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, ProductImpressionCommonParams {
     contentType?: string;

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

@@ -41,7 +41,7 @@ declare class GlobalProvider {
      * @since 0.5.14
      * @returns Analytics Provider vendors, if not specified it fallsback to the global vendors
      */
-    get vendors(): number[];
+    get vendors(): number[] | undefined;
     setVendors(vendors: Config["vendors"]): void;
     /**
      * @override

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

@@ -92,12 +92,18 @@ export declare namespace Gtag {
         category?: string;
         creative_name?: string;
         creative_slot?: string;
+        currency?: string;
+        index?: number;
+        item_brand?: string;
+        item_category?: string;
         item_id?: string;
-        location_id?: string;
+        item_list_id?: string;
+        item_list_name?: string;
         item_name?: string;
+        item_variant?: string;
+        location_id?: string;
         price?: Currency;
         quantity?: number;
-        currency?: string;
     }
     interface Promotion {
         creative_name?: string;

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

@@ -208,7 +208,6 @@ export interface ProvidersHandlers<T> {
  * Shared params across every event.
  *
  * @interface EventCommonParams
- * @author Luis Eduardo Andrade
  * @since 0.5.14
  * @property {string} userId The unique identifier of a user across platforms
  * @property {boolean} isAnonymous Whether the user is registered or not

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

@@ -22,7 +22,7 @@ export declare const noActiveVendor: () => void;
  *
  * @since 0.5.14
  * @param {string} eventName The name of the event
- * @param {string} provider the provider that will emit the event
+ * @param {AnalyticsProviderTypes} provider the provider that will emit the event
  */
 export declare const vendorNotIncluded: (eventName: string, provider: AnalyticsProviderTypes) => void;
 /**

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

@@ -1,4 +1,12 @@
 import { GlobalState } from "../types/state.types";
+import { Vendor } from "@artisan-commerce/types";
 export declare const setInitialState: () => void;
 export declare const getState: () => GlobalState;
 export declare const setState: (state: Partial<GlobalState>) => void;
+/**
+ * Utility function to update the active vendor.
+ *
+ * @since 0.5.14
+ * @param {Vendor|number} vendor New active vendor
+ */
+export declare const updateActiveVendor: (vendor: Vendor | Vendor["id"] | undefined) => void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@artisan-commerce/analytics-web",
   "description": "Artisan commerce analytics web library",
-  "version": "0.1.0-canary.2",
+  "version": "0.1.0-canary.21",
   "main": "./build/main.bundle.js",
   "types": "./build/src/index.d.ts",
   "files": [
@@ -30,13 +30,13 @@
   "author": "Luis Eduardo Andrade",
   "license": "MIT",
   "dependencies": {
-    "@artisan-commerce/state": "0.2.2-canary.2",
+    "@artisan-commerce/state": "0.2.2-canary.4",
     "snake-case": "^3.0.4"
   },
   "devDependencies": {
-    "@artisan-commerce/products": "0.8.2-canary.8",
-    "@artisan-commerce/shopping-cart": "0.11.0-canary.8",
-    "@artisan-commerce/types": "0.13.0-canary.4",
+    "@artisan-commerce/products": "0.8.2-canary.17",
+    "@artisan-commerce/shopping-cart": "0.11.0-canary.17",
+    "@artisan-commerce/types": "0.13.0-canary.9",
     "@babel/core": "^7.10.5",
     "@babel/preset-env": "^7.10.4",
     "@babel/preset-react": "^7.10.4",
@@ -49,7 +49,6 @@
     "avn": "^0.2.4",
     "avn-nvm": "^0.2.2",
     "clean-webpack-plugin": "^3.0.0",
-    "cross-env": "^7.0.2",
     "dotenv-webpack": "^2.0.0",
     "env-cmd": "^10.1.0",
     "eslint": "^7.5.0",
@@ -84,5 +83,5 @@
     "@artisan-commerce/products": "*",
     "@artisan-commerce/shopping-cart": "*"
   },
-  "gitHead": "0164bdce85dc4dc2fce585bb788ae3adb1850fac"
+  "gitHead": "b4756aeffb2a6e68d76afb181d29ae9119085982"
 }