@artisan-commerce/analytics-web 0.2.0-canary.80 → 0.2.0-canary.9

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

@@ -0,0 +1,11 @@
+import { SpendPointsParams } from "./spendPoints.types";
+/**
+ * Emits a spendPoints event to every configured provider.
+ *
+ * Log this event when users spend their points.
+ *
+ * @since 0.5.14
+ * @property {SpendPointsParams} params SpendPoints event parameters
+ */
+declare const logSpendPoints: (params: SpendPointsParams) => void;
+export default logSpendPoints;

package/build/src/lib/events/loyalty/spendPoints/spendPoints.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,20 @@
+import { SpendPointsParams as GoogleSpendPointsParams } from "../../../providers/GoogleAnalytics/events/loyalty/spendPoints/spendPoints.types";
+import { SpendPointsParams as FacebookSpendPointsParams } from "../../../providers/FacebookPixel/events/loyalty/spendPoints/spendPoints.types";
+import { SpendPointsParams as SegmentSpendPointsParams } from "../../../providers/Segment/events/loyalty/spendPoints/spendPoints.types";
+/**
+ * spendPoints event interface
+ *
+ * @interface SpendPointsCommonParams
+ * @since 0.5.14
+ * @property {number} amount The amount of spent points
+ */
+export interface SpendPointsCommonParams {
+    amount: number;
+}
+/**
+ * spendPoints event params.
+ *
+ * @typedef SpendPointsParams
+ * @since 0.5.14
+ */
+export declare type SpendPointsParams = GoogleSpendPointsParams & FacebookSpendPointsParams & SegmentSpendPointsParams;

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

@@ -0,0 +1,11 @@
+import { ViewLoyaltyLevelParams } from "./viewLoyaltyLevel.types";
+/**
+ * Emits a viewLoyaltyLevel event to every configured provider.
+ *
+ * Log this event when users view a loyalty level.
+ *
+ * @since 0.5.14
+ * @property {ViewLoyaltyLevelParams} params ViewLoyaltyLevel event parameters
+ */
+declare const logViewLoyaltyLevel: (params: ViewLoyaltyLevelParams) => void;
+export default logViewLoyaltyLevel;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,20 @@
+import { ViewLoyaltyLevelParams as GoogleViewLoyaltyLevelParams } from "../../../providers/GoogleAnalytics/events/loyalty/viewLoyaltyLevel/viewLoyaltyLevel.types";
+import { ViewLoyaltyLevelParams as FacebookViewLoyaltyLevelParams } from "../../../providers/FacebookPixel/events/loyalty/viewLoyaltyLevel/viewLoyaltyLevel.types";
+import { ViewLoyaltyLevelParams as SegmentViewLoyaltyLevelParams } from "../../../providers/Segment/events/loyalty/viewLoyaltyLevel/viewLoyaltyLevel.types";
+/**
+ * viewLoyaltyLevel event interface.
+ *
+ * @interface ViewLoyaltyLevelCommonParams
+ * @since 0.5.14
+ * @property {string} level The loyalty level name
+ */
+export interface ViewLoyaltyLevelCommonParams {
+    level: string;
+}
+/**
+ * viewLoyaltyLevel event params.
+ *
+ * @typedef ViewLoyaltyLevelParams
+ * @since 0.5.14
+ */
+export declare type ViewLoyaltyLevelParams = GoogleViewLoyaltyLevelParams & FacebookViewLoyaltyLevelParams & SegmentViewLoyaltyLevelParams;

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

@@ -0,0 +1,11 @@
+import { CancelOrderParams } from "./cancelOrder.types";
+/**
+ * Emits a cancelOrder event to every configured provider.
+ *
+ * Log this event when users cancel an order.
+ *
+ * @since 0.5.14
+ * @property {CancelOrderParams} params CancelOrder event parameters
+ */
+declare const logCancelOrder: (params: CancelOrderParams) => void;
+export default logCancelOrder;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,22 @@
+import { CancelOrderParams as GoogleCancelOrderParams } from "../../../providers/GoogleAnalytics/events/order/cancelOrder/cancelOrder.types";
+import { CancelOrderParams as FacebookCancelOrderParams } from "../../../providers/FacebookPixel/events/order/cancelOrder/cancelOrder.types";
+import { CancelOrderParams as SegmentCancelOrderParams } from "../../../providers/Segment/events/order/cancelOrder/cancelOrder.types";
+/**
+ * cancelOrder event interface
+ *
+ * @interface CancelOrderCommonParams
+ * @since 0.5.14
+ * @property {string} orderId The orders unique identifier
+ * @property {string} reason The reason by which the user canceled the order
+ */
+export interface CancelOrderCommonParams {
+    orderId: string;
+    reason?: string;
+}
+/**
+ * cancelOrder event params.
+ *
+ * @typedef CancelOrderParams
+ * @since 0.5.14
+ */
+export declare type CancelOrderParams = GoogleCancelOrderParams & FacebookCancelOrderParams & SegmentCancelOrderParams;

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

@@ -0,0 +1,6 @@
+declare const events: {
+    logCancelOrder: (params: import("./cancelOrder/cancelOrder.types").CancelOrderParams) => void;
+    logRateOrder: (params: import("./rateOrder/rateOrder.types").RateOrderParams) => void;
+    logRequestRefund: (params: import("./requestRefund/requestRefund.types").RequestRefundParams) => void;
+};
+export default events;

package/build/src/lib/events/order/index.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,11 @@
+import { RateOrderParams } from "./rateOrder.types";
+/**
+ * Emits a rateOrder event to every configured provider.
+ *
+ * Log this event when users rate an order.
+ *
+ * @since 0.5.14
+ * @property {RateOrderParams} params RateOrder event parameters
+ */
+declare const logRateOrder: (params: RateOrderParams) => void;
+export default logRateOrder;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,26 @@
+import { RateOrderParams as GoogleRateOrderParams } from "../../../providers/GoogleAnalytics/events/order/rateOrder/rateOrder.types";
+import { RateOrderParams as FacebookRateOrderParams } from "../../../providers/FacebookPixel/events/order/rateOrder/rateOrder.types";
+import { RateOrderParams as SegmentRateOrderParams } from "../../../providers/Segment/events/order/rateOrder/rateOrder.types";
+/**
+ * rateOrder event interface
+ *
+ * @interface RateOrderCommonParams
+ * @since 0.5.14
+ * @property {string} orderId The order's unique identifier
+ * @property {number} score The score user gave to the order
+ * @property {number} minScore The min score the user could give to an order
+ * @property {number} maxScore The max score the user could give to an order
+ */
+export interface RateOrderCommonParams {
+    orderId: string;
+    score?: number;
+    minScore?: number;
+    maxScore?: number;
+}
+/**
+ * rateOrder event params.
+ *
+ * @typedef RateOrderParams
+ * @since 0.5.14
+ */
+export declare type RateOrderParams = GoogleRateOrderParams & FacebookRateOrderParams & SegmentRateOrderParams;

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

@@ -0,0 +1,11 @@
+import { RequestRefundParams } from "./requestRefund.types";
+/**
+ * Emits a requestRefund event to every configured provider.
+ *
+ * Log this event when users request a refund of the order.
+ *
+ * @since 0.5.14
+ * @property {RequestRefundParams} params RequestRefund event parameters
+ */
+declare const logRequestRefund: (params: RequestRefundParams) => void;
+export default logRequestRefund;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,24 @@
+import { RequestRefundParams as GoogleRequestRefundParams } from "../../../providers/GoogleAnalytics/events/order/requestRefund/requestRefund.types";
+import { RequestRefundParams as FacebookRequestRefundParams } from "../../../providers/FacebookPixel/events/order/requestRefund/requestRefund.types";
+import { RequestRefundParams as SegmentRequestRefundParams } from "../../../providers/Segment/events/order/requestRefund/requestRefund.types";
+/**
+ * requestRefund event interface
+ *
+ * @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 {
+    orderId: string;
+    orderTotal: number;
+    reason?: string;
+}
+/**
+ * requestRefund event params.
+ *
+ * @typedef RequestRefundParams
+ * @since 0.5.14
+ */
+export declare type RequestRefundParams = GoogleRequestRefundParams & FacebookRequestRefundParams & SegmentRequestRefundParams;

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

@@ -0,0 +1,11 @@
+import { GenerateLeadParams } from "./generateLead.types";
+/**
+ * Emits a generateLead event to every configured provider.
+ *
+ * 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
+ */
+declare const logGenerateLead: (params?: GenerateLeadParams) => void;
+export default logGenerateLead;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,18 @@
+import { GenerateLeadParams as GoogleGenerateLeadParams } from "../../../providers/GoogleAnalytics/events/other/generateLead/generateLead.types";
+import { GenerateLeadParams as FacebookGenerateLeadParams } from "../../../providers/FacebookPixel/events/other/generateLead/generateLead.types";
+import { GenerateLeadParams as SegmentGenerateLeadParams } from "../../../providers/Segment/events/other/generateLead/generateLead.types";
+/**
+ * generateLead event interface
+ *
+ * @interface GenerateLeadCommonParams
+ * @since 0.5.14
+ */
+export interface GenerateLeadCommonParams {
+}
+/**
+ * generateLead event params.
+ *
+ * @typedef GenerateLeadParams
+ * @since 0.5.14
+ */
+export declare type GenerateLeadParams = GoogleGenerateLeadParams & FacebookGenerateLeadParams & SegmentGenerateLeadParams;

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

@@ -0,0 +1,6 @@
+declare const events: {
+    logGenerateLead: (params?: import("./generateLead/generateLead.types").GenerateLeadParams) => void;
+    logPageView: (params: import("./pageView/pageView.types").PageViewParams) => void;
+    logSearchPageContent: (params: import("./searchPageContent/searchPageContent.types").SearchPageContentParams) => void;
+};
+export default events;

package/build/src/lib/events/other/index.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,12 @@
+import { PageViewParams } from "./pageView.types";
+/**
+ * Emits a pageView event to every configured provider.
+ *
+ * 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
+ */
+declare const logPageView: (params: PageViewParams) => void;
+export default logPageView;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,22 @@
+import { PageViewParams as GooglePageViewParams } from "../../../providers/GoogleAnalytics/events/other/pageView/pageView.types";
+import { PageViewParams as FacebookPageViewParams } from "../../../providers/FacebookPixel/events/other/pageView/pageView.types";
+import { PageViewParams as SegmentPageViewParams } from "../../../providers/Segment/events/other/pageView/pageView.types";
+/**
+ * pageView event interface.
+ *
+ * @interface PageViewCommonParams
+ * @since 0.5.14
+ * @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;
+    name?: string;
+}
+/**
+ * pageView event params.
+ *
+ * @typedef PageViewParams
+ * @since 0.5.14
+ */
+export declare type PageViewParams = GooglePageViewParams & FacebookPageViewParams & SegmentPageViewParams;

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

@@ -0,0 +1,11 @@
+import { SearchPageContentParams } from "./searchPageContent.types";
+/**
+ * Emits a searchPageContent event to every configured provider.
+ *
+ * Log this event when users search for any content in the application.
+ *
+ * @since 0.5.14
+ * @property {SearchPageContentParams} params SearchPageContent event parameters
+ */
+declare const logSearchPageContent: (params: SearchPageContentParams) => void;
+export default logSearchPageContent;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,20 @@
+import { SearchPageContentParams as GoogleSearchPageContentParams } from "../../../providers/GoogleAnalytics/events/other/searchPageContent/searchPageContent.types";
+import { SearchPageContentParams as FacebookSearchPageContentParams } from "../../../providers/FacebookPixel/events/other/searchPageContent/searchPageContent.types";
+import { SearchPageContentParams as SegmentSearchPageContentParams } from "../../../providers/Segment/events/other/searchPageContent/searchPageContent.types";
+/**
+ * searchPageContent event interface
+ *
+ * @interface SearchPageContentCommonParams
+ * @since 0.5.14
+ * @property {string} query The searched text
+ */
+export interface SearchPageContentCommonParams {
+    query: string;
+}
+/**
+ * searchPageContent event params.
+ *
+ * @typedef SearchPageContentParams
+ * @since 0.5.14
+ */
+export declare type SearchPageContentParams = GoogleSearchPageContentParams & FacebookSearchPageContentParams & SegmentSearchPageContentParams;

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

@@ -0,0 +1,11 @@
+import { ChangePaymentTypeParams } from "./changePaymentType.types";
+/**
+ * Emits a changePaymentType event to every configured provider.
+ *
+ * Log this event when users change the payment type.
+ *
+ * @since 0.5.14
+ * @property {ChangePaymentTypeParams} params ChangePaymentType event parameters
+ */
+declare const logChangePaymentType: (params: ChangePaymentTypeParams) => void;
+export default logChangePaymentType;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,29 @@
+import { ChangePaymentTypeParams as GoogleChangePaymentTypeParams } from "../../../providers/GoogleAnalytics/events/payment/changePaymentType/changePaymentType.types";
+import { ChangePaymentTypeParams as FacebookChangePaymentTypeParams } from "../../../providers/FacebookPixel/events/payment/changePaymentType/changePaymentType.types";
+import { ChangePaymentTypeParams as SegmentChangePaymentTypeParams } from "../../../providers/Segment/events/payment/changePaymentType/changePaymentType.types";
+import { PaymentType } from "../../events.types";
+/**
+ * changePaymentType event interface
+ *
+ * @interface ChangePaymentTypeCommonParams
+ * @since 0.5.14
+ * @property {PaymentType} previousPaymentType The previously 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;
+    previousCardType?: string;
+    nextPaymentType: PaymentType;
+    nextCardType?: string;
+    orderTotal: number;
+}
+/**
+ * changePaymentType event params.
+ *
+ * @typedef ChangePaymentTypeParams
+ * @since 0.5.14
+ */
+export declare type ChangePaymentTypeParams = GoogleChangePaymentTypeParams & FacebookChangePaymentTypeParams & SegmentChangePaymentTypeParams;

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

@@ -0,0 +1,6 @@
+declare const events: {
+    logChangePaymentType: (params: import("./changePaymentType/changePaymentType.types").ChangePaymentTypeParams) => void;
+    logSelectPaymentType: (params: import("./selectPaymentType/selectPaymentType.types").SelectPaymentTypeParams) => void;
+    logSetPaymentInfo: (params: import("./setPaymentInfo/setPaymentInfo.types").SetPaymentInfoParams) => void;
+};
+export default events;

package/build/src/lib/events/payment/index.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,11 @@
+import { SelectPaymentTypeParams } from "./selectPaymentType.types";
+/**
+ * Emits a selectPaymentType event to every configured provider.
+ *
+ * Log this event when users select the payment type.
+ *
+ * @since 0.5.14
+ * @property {SelectPaymentTypeParams} params SelectPaymentType event parameters
+ */
+declare const logSelectPaymentType: (params: SelectPaymentTypeParams) => void;
+export default logSelectPaymentType;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,23 @@
+import { SelectPaymentTypeParams as GoogleSelectPaymentTypeParams } from "../../../providers/GoogleAnalytics/events/payment/selectPaymentType/selectPaymentType.types";
+import { SelectPaymentTypeParams as FacebookSelectPaymentTypeParams } from "../../../providers/FacebookPixel/events/payment/selectPaymentType/selectPaymentType.types";
+import { SelectPaymentTypeParams as SegmentSelectPaymentTypeParams } from "../../../providers/Segment/events/payment/selectPaymentType/selectPaymentType.types";
+import { PaymentType } from "../../events.types";
+/**
+ * selectPaymentType event interface
+ *
+ * @interface SelectPaymentTypeCommonParams
+ * @since 0.5.14
+ * @property {PaymentType} paymentType The new set payment type (e.g. Cash)
+ * @property {number} orderTotal The total cost of the order
+ */
+export interface SelectPaymentTypeCommonParams {
+    paymentType: PaymentType;
+    orderTotal: number;
+}
+/**
+ * selectPaymentType event params.
+ *
+ * @typedef SelectPaymentTypeParams
+ * @since 0.5.14
+ */
+export declare type SelectPaymentTypeParams = GoogleSelectPaymentTypeParams & FacebookSelectPaymentTypeParams & SegmentSelectPaymentTypeParams;

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

@@ -0,0 +1,11 @@
+import { SetPaymentInfoParams } from "./setPaymentInfo.types";
+/**
+ * Emits a setPaymentInfo event to every configured provider.
+ *
+ * Log this event when users set the payment type for the first time.
+ *
+ * @since 0.5.14
+ * @property {SetPaymentInfoParams} params SetPaymentInfo event parameters
+ */
+declare const logSetPaymentInfo: (params: SetPaymentInfoParams) => void;
+export default logSetPaymentInfo;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,25 @@
+import { SetPaymentInfoParams as GoogleSetPaymentInfoParams } from "../../../providers/GoogleAnalytics/events/payment/setPaymentInfo/setPaymentInfo.types";
+import { SetPaymentInfoParams as FacebookSetPaymentInfoParams } from "../../../providers/FacebookPixel/events/payment/setPaymentInfo/setPaymentInfo.types";
+import { SetPaymentInfoParams as SegmentSetPaymentInfoParams } from "../../../providers/Segment/events/payment/setPaymentInfo/setPaymentInfo.types";
+import { PaymentType } from "../../events.types";
+/**
+ * setPaymentInfo event interface
+ *
+ * @interface SetPaymentInfoCommonParams
+ * @since 0.5.14
+ * @property {number} orderTotal The total cost of the order
+ * @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;
+    paymentType: PaymentType;
+    cardType?: string;
+}
+/**
+ * setPaymentInfo event params.
+ *
+ * @typedef SetPaymentInfoParams
+ * @since 0.5.14
+ */
+export declare type SetPaymentInfoParams = GoogleSetPaymentInfoParams & FacebookSetPaymentInfoParams & SegmentSetPaymentInfoParams;

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

@@ -0,0 +1,11 @@
+import { CustomizeProductParams } from "./customizeProduct.types";
+/**
+ * Emits a customizeProduct event to every configured provider.
+ *
+ * Log this event when users add extras to the base offered product.
+ *
+ * @since 0.5.14
+ * @property {CustomizeProductParams} params CustomizeProduct event parameters
+ */
+declare const logCustomizeProduct: (params: CustomizeProductParams) => void;
+export default logCustomizeProduct;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,21 @@
+import { CartProduct } from "@artisan-commerce/types";
+import { CustomizeProductParams as GoogleCustomizeProductParams } from "../../../providers/GoogleAnalytics/events/product/customizeProduct/customizeProduct.types";
+import { CustomizeProductParams as FacebookCustomizeProductParams } from "../../../providers/FacebookPixel/events/product/customizeProduct/customizeProduct.types";
+import { CustomizeProductParams as SegmentCustomizeProductParams } from "../../../providers/Segment/events/product/customizeProduct/customizeProduct.types";
+/**
+ * customizeProduct event interface
+ *
+ * @interface CustomizeProductCommonParams
+ * @since 0.5.14
+ * @property {CartProduct} product the customized product
+ */
+export interface CustomizeProductCommonParams {
+    product: CartProduct;
+}
+/**
+ * customizeProduct event params.
+ *
+ * @typedef CustomizeProductParams
+ * @since 0.5.14
+ */
+export declare type CustomizeProductParams = GoogleCustomizeProductParams & FacebookCustomizeProductParams & SegmentCustomizeProductParams;

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

@@ -0,0 +1,11 @@
+import { FilterProductsParams } from "./filterProducts.types";
+/**
+ * Emits a filterProducts event to every configured provider.
+ *
+ * Log this event when users try to filter a list of products.
+ *
+ * @since 0.5.14
+ * @property {FilterProductsParams} params FilterProducts event parameters
+ */
+declare const logFilterProducts: (params: FilterProductsParams) => void;
+export default logFilterProducts;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,24 @@
+import { FilterProductsParams as GoogleFilterProductsParams } from "../../../providers/GoogleAnalytics/events/product/filterProducts/filterProducts.types";
+import { FilterProductsParams as FacebookFilterProductsParams } from "../../../providers/FacebookPixel/events/product/filterProducts/filterProducts.types";
+import { FilterProductsParams as SegmentFilterProductsParams } from "../../../providers/Segment/events/product/filterProducts/filterProducts.types";
+/**
+ * filterProducts event interface
+ *
+ * @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:Artisn"]
+ * @property {string} categoryId if the list is an artisn category, the category id
+ */
+export interface FilterProductsCommonParams {
+    list: string;
+    filterBy: string[];
+    categoryId?: string;
+}
+/**
+ * filterProducts event params.
+ *
+ * @typedef FilterProductsParams
+ * @since 0.5.14
+ */
+export declare type FilterProductsParams = GoogleFilterProductsParams & FacebookFilterProductsParams & SegmentFilterProductsParams;

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

@@ -0,0 +1,12 @@
+declare const events: {
+    logCustomizeProduct: (params: import("./customizeProduct/customizeProduct.types").CustomizeProductParams) => void;
+    logFilterProducts: (params: import("./filterProducts/filterProducts.types").FilterProductsParams) => void;
+    logProductImpression: (params: import("./productImpression/productImpression.types").ProductImpressionParams) => void;
+    logSearchProductSuccess: (params: import("./searchProductSuccess/searchProductSuccess.types").SearchProductSuccessParams) => void;
+    logSearchProductAttempt: (params: import("./searchProductAttempt/searchProductAttempt.types").SearchProductAttemptParams) => void;
+    logSearchProductNotFound: (params: import("./searchProductNotFound/searchProductNotFound.types").SearchProductNotFoundParams) => void;
+    logSelectProduct: (params: import("./selectProduct/selectProduct.types").SelectProductParams) => void;
+    logSortProducts: (params: import("./sortProducts/sortProducts.types").SortProductsParams) => void;
+    logViewProductDetails: (params: import("./viewProductDetails/viewProductDetails.types").ViewProductDetailsParams) => void;
+};
+export default events;

package/build/src/lib/events/product/index.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,11 @@
+import { ProductImpressionParams } from "./productImpression.types";
+/**
+ * Emits a productImpression event to every configured provider.
+ *
+ * Log this event when a product is visible on the screen.
+ *
+ * @since 0.5.14
+ * @property {ProductImpressionParams} params ProductImpression event parameters
+ */
+declare const logProductImpression: (params: ProductImpressionParams) => void;
+export default logProductImpression;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,27 @@
+import { Product } from "@artisan-commerce/types";
+import { ProductImpressionParams as GoogleProductImpressionParams } from "../../../providers/GoogleAnalytics/events/product/productImpression/productImpression.types";
+import { ProductImpressionParams as FacebookProductImpressionParams } from "../../../providers/FacebookPixel/events/product/productImpression/productImpression.types";
+import { ProductImpressionParams as SegmentProductImpressionParams } from "../../../providers/Segment/events/product/productImpression/productImpression.types";
+/**
+ * productImpression event interface
+ *
+ * @interface ProductImpressionCommonParams
+ * @since 0.5.14
+ * @property {Product} product the product a user had an impression on
+ * @property {string} list the name of the list where the product is
+ * @property {number} position the position in a list where the product is
+ * @property {number} duration how long in milliseconds the user had an impression before interacting with the product or left
+ */
+export interface ProductImpressionCommonParams {
+    product: Product;
+    list?: string;
+    position?: number;
+    duration?: number;
+}
+/**
+ * productImpression event params.
+ *
+ * @typedef ProductImpressionParams
+ * @since 0.5.14
+ */
+export declare type ProductImpressionParams = GoogleProductImpressionParams & FacebookProductImpressionParams & SegmentProductImpressionParams;

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

@@ -0,0 +1,11 @@
+import { SearchProductAttemptParams } from "./searchProductAttempt.types";
+/**
+ * Emits a searchProductAttempt event to every configured provider.
+ *
+ * Log this event when users try to search an specific product.
+ *
+ * @since 0.5.14
+ * @property {SearchProductAttemptParams} params SearchProductAttempt event parameters
+ */
+declare const logSearchProductAttempt: (params: SearchProductAttemptParams) => void;
+export default logSearchProductAttempt;