@artisan-commerce/analytics-rn 0.2.0-canary.2 → 0.2.0-canary.21

package/build/analytics-rn/src/lib/providers/Segment/events/shoppingCart/viewCart/viewCart.d.ts

@@ -0,0 +1,11 @@
+import { SegmentProvider } from "../../../Segment.types";
+import { ViewCartParams } from "./viewCart.types";
+/**
+ * Emits a viewCart event to a Segment Provider.
+ *
+ * @since 0.5.14
+ * @param {SegmentProvider} provider The provider instance that will emit the event
+ * @param {ViewCartParams} params Event configuration parameters
+ */
+declare const viewCart: (provider: SegmentProvider, params: ViewCartParams) => void;
+export default viewCart;

package/build/analytics-rn/src/lib/providers/Segment/events/shoppingCart/viewCart/viewCart.test.d.ts

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

package/build/analytics-rn/src/lib/providers/Segment/events/shoppingCart/viewCart/viewCart.types.d.ts

@@ -0,0 +1,17 @@
+import { Product } from "@artisan-commerce/types";
+import { ViewCartCommonParams } from "../../../../../events/shoppingCart/viewCart/viewCart.types";
+import { SegmentCommonEventParams } from "../../../Segment.types";
+import { SegmentCustomEventParams } from "../../../Segment.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface ViewCartParams
+ * @since 0.5.14
+ * @extends SegmentCommonEventParams
+ * @extends SegmentCustomEventParams
+ * @extends ViewCartCommonParams
+ * @property {Product[]} products The products in the cart
+ */
+export interface ViewCartParams extends SegmentCommonEventParams, SegmentCustomEventParams, ViewCartCommonParams {
+    products: Product[];
+}

package/build/analytics-rn/src/lib/providers/Segment/events/social/index.d.ts

@@ -0,0 +1,4 @@
+declare const events: {
+    share: (provider: import("../../Segment.types").SegmentProvider, params: import("./share/share.types").ShareParams) => void;
+};
+export default events;

package/build/analytics-rn/src/lib/providers/Segment/events/social/index.test.d.ts

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

package/build/analytics-rn/src/lib/providers/Segment/events/social/share/share.d.ts

@@ -0,0 +1,11 @@
+import { SegmentProvider } from "../../../Segment.types";
+import { ShareParams } from "./share.types";
+/**
+ * Emits a share event to a Segment Provider.
+ *
+ * @since 0.5.14
+ * @param {SegmentProvider} provider The provider instance that will emit the event
+ * @param {ShareParams} params Event configuration parameters
+ */
+declare const share: (provider: SegmentProvider, params: ShareParams) => void;
+export default share;

package/build/analytics-rn/src/lib/providers/Segment/events/social/share/share.test.d.ts

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

package/build/analytics-rn/src/lib/providers/Segment/events/social/share/share.types.d.ts

@@ -0,0 +1,14 @@
+import { ShareCommonParams } from "../../../../../events/social/share/share.types";
+import { SegmentCommonEventParams } from "../../../Segment.types";
+import { SegmentCustomEventParams } from "../../../Segment.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface ShareParams
+ * @since 0.5.14
+ * @extends SegmentCommonEventParams
+ * @extends SegmentCustomEventParams
+ * @extends ShareCommonParams
+ */
+export interface ShareParams extends SegmentCommonEventParams, SegmentCustomEventParams, ShareCommonParams {
+}

package/build/analytics-rn/src/lib/providers/Segment/events/store/changeStore/changeStore.d.ts

@@ -0,0 +1,11 @@
+import { SegmentProvider } from "../../../Segment.types";
+import { ChangeStoreParams } from "./changeStore.types";
+/**
+ * Emits a changeStore event to a Segment Provider.
+ *
+ * @since 0.5.14
+ * @param {SegmentProvider} provider The provider instance that will emit the event
+ * @param {ChangeStoreParams} params Event configuration parameters
+ */
+declare const changeStore: (provider: SegmentProvider, params: ChangeStoreParams) => void;
+export default changeStore;

package/build/analytics-rn/src/lib/providers/Segment/events/store/changeStore/changeStore.test.d.ts

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

package/build/analytics-rn/src/lib/providers/Segment/events/store/changeStore/changeStore.types.d.ts

@@ -0,0 +1,14 @@
+import { ChangeStoreCommonParams } from "../../../../../events/store/changeStore/changeStore.types";
+import { SegmentCommonEventParams } from "../../../Segment.types";
+import { SegmentCustomEventParams } from "../../../Segment.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface ChangeStoreParams
+ * @since 0.5.14
+ * @extends SegmentCommonEventParams
+ * @extends SegmentCustomEventParams
+ * @extends ChangeStoreCommonParams
+ */
+export interface ChangeStoreParams extends SegmentCommonEventParams, SegmentCustomEventParams, ChangeStoreCommonParams {
+}

package/build/analytics-rn/src/lib/providers/Segment/events/store/index.d.ts

@@ -0,0 +1,5 @@
+declare const events: {
+    changeStore: (provider: import("../../Segment.types").SegmentProvider, params: import("./changeStore/changeStore.types").ChangeStoreParams) => void;
+    setStore: (provider: import("../../Segment.types").SegmentProvider, params: import("./setStore/setStore.types").SetStoreParams) => void;
+};
+export default events;

package/build/analytics-rn/src/lib/providers/Segment/events/store/index.test.d.ts

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

package/build/analytics-rn/src/lib/providers/Segment/events/store/setStore/setStore.d.ts

@@ -0,0 +1,11 @@
+import { SegmentProvider } from "../../../Segment.types";
+import { SetStoreParams } from "./setStore.types";
+/**
+ * Emits a setStore event to a Segment Provider.
+ *
+ * @since 0.5.14
+ * @param {SegmentProvider} provider The provider instance that will emit the event
+ * @param {SetStoreParams} params Event configuration parameters
+ */
+declare const setStore: (provider: SegmentProvider, params: SetStoreParams) => void;
+export default setStore;

package/build/analytics-rn/src/lib/providers/Segment/events/store/setStore/setStore.test.d.ts

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

package/build/analytics-rn/src/lib/providers/Segment/events/store/setStore/setStore.types.d.ts

@@ -0,0 +1,14 @@
+import { SetStoreCommonParams } from "../../../../../events/store/setStore/setStore.types";
+import { SegmentCommonEventParams } from "../../../Segment.types";
+import { SegmentCustomEventParams } from "../../../Segment.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface SetStoreParams
+ * @since 0.5.14
+ * @extends SegmentCommonEventParams
+ * @extends SegmentCustomEventParams
+ * @extends SetStoreCommonParams
+ */
+export interface SetStoreParams extends SegmentCommonEventParams, SegmentCustomEventParams, SetStoreCommonParams {
+}

package/build/analytics-rn/src/lib/providers/Segment/events/user/index.d.ts

@@ -0,0 +1,5 @@
+declare const events: {
+    setUserInfo: (provider: import("../../Segment.types").SegmentProvider, params: import("./setUserInfo/setUserInfo.types").SetUserInfoParams) => void;
+    updateUserInfo: (provider: import("../../Segment.types").SegmentProvider, params: import("./updateUserInfo/updateUserInfo.types").UpdateUserInfoParams) => void;
+};
+export default events;

package/build/analytics-rn/src/lib/providers/Segment/events/user/index.test.d.ts

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

package/build/analytics-rn/src/lib/providers/Segment/events/user/setUserInfo/setUserInfo.d.ts

@@ -0,0 +1,11 @@
+import { SegmentProvider } from "../../../Segment.types";
+import { SetUserInfoParams } from "./setUserInfo.types";
+/**
+ * Emits a setUserInfo event to a Segment Provider.
+ *
+ * @since 0.5.14
+ * @param {SegmentProvider} provider The provider instance that will emit the event
+ * @param {SetUserInfoParams} params Event configuration parameters
+ */
+declare const setUserInfo: (provider: SegmentProvider, params: SetUserInfoParams) => void;
+export default setUserInfo;

package/build/analytics-rn/src/lib/providers/Segment/events/user/setUserInfo/setUserInfo.test.d.ts

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

package/build/analytics-rn/src/lib/providers/Segment/events/user/setUserInfo/setUserInfo.types.d.ts

@@ -0,0 +1,14 @@
+import { SetUserInfoCommonParams } from "../../../../../events/user/setUserInfo/setUserInfo.types";
+import { SegmentCommonEventParams } from "../../../Segment.types";
+import { SegmentCustomEventParams } from "../../../Segment.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface SetUserInfoParams
+ * @since 0.5.14
+ * @extends SegmentCommonEventParams
+ * @extends SegmentCustomEventParams
+ * @extends SetUserInfoCommonParams
+ */
+export interface SetUserInfoParams extends SegmentCommonEventParams, SegmentCustomEventParams, SetUserInfoCommonParams {
+}

package/build/analytics-rn/src/lib/providers/Segment/events/user/updateUserInfo/updateUserInfo.d.ts

@@ -0,0 +1,11 @@
+import { SegmentProvider } from "../../../Segment.types";
+import { UpdateUserInfoParams } from "./updateUserInfo.types";
+/**
+ * Emits a updateUserInfo event to a Segment Provider.
+ *
+ * @since 0.5.14
+ * @param {SegmentProvider} provider The provider instance that will emit the event
+ * @param {UpdateUserInfoParams} params Event configuration parameters
+ */
+declare const updateUserInfo: (provider: SegmentProvider, params: UpdateUserInfoParams) => void;
+export default updateUserInfo;

package/build/analytics-rn/src/lib/providers/Segment/events/user/updateUserInfo/updateUserInfo.test.d.ts

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

package/build/analytics-rn/src/lib/providers/Segment/events/user/updateUserInfo/updateUserInfo.types.d.ts

@@ -0,0 +1,14 @@
+import { UpdateUserInfoCommonParams } from "../../../../../events/user/updateUserInfo/updateUserInfo.types";
+import { SegmentCommonEventParams } from "../../../Segment.types";
+import { SegmentCustomEventParams } from "../../../Segment.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface UpdateUserInfoParams
+ * @since 0.5.14
+ * @extends SegmentCommonEventParams
+ * @extends SegmentCustomEventParams
+ * @extends UpdateUserInfoCommonParams
+ */
+export interface UpdateUserInfoParams extends SegmentCommonEventParams, SegmentCustomEventParams, UpdateUserInfoCommonParams {
+}

package/build/analytics-rn/src/lib/providers/Segment/events/vendor/changeVendor/changeVendor.d.ts

@@ -0,0 +1,11 @@
+import { SegmentProvider } from "../../../Segment.types";
+import { ChangeVendorParams } from "./changeVendor.types";
+/**
+ * Emits a changeVendor event to a Segment Provider.
+ *
+ * @since 0.5.14
+ * @param {SegmentProvider} provider The provider instance that will emit the event
+ * @param {ChangeVendorParams} params Event configuration parameters
+ */
+declare const changeVendor: (provider: SegmentProvider, params: ChangeVendorParams) => void;
+export default changeVendor;

package/build/analytics-rn/src/lib/providers/Segment/events/vendor/changeVendor/changeVendor.test.d.ts

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

package/build/analytics-rn/src/lib/providers/Segment/events/vendor/changeVendor/changeVendor.types.d.ts

@@ -0,0 +1,14 @@
+import { ChangeVendorCommonParams } from "../../../../../events/vendor/changeVendor/changeVendor.types";
+import { SegmentCommonEventParams } from "../../../Segment.types";
+import { SegmentCustomEventParams } from "../../../Segment.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface ChangeVendorParams
+ * @since 0.5.14
+ * @extends SegmentCommonEventParams
+ * @extends SegmentCustomEventParams
+ * @extends ChangeVendorCommonParams
+ */
+export interface ChangeVendorParams extends SegmentCommonEventParams, SegmentCustomEventParams, ChangeVendorCommonParams {
+}

package/build/analytics-rn/src/lib/providers/Segment/events/vendor/index.d.ts

@@ -0,0 +1,5 @@
+declare const events: {
+    changeVendor: (provider: import("../../Segment.types").SegmentProvider, params: import("./changeVendor/changeVendor.types").ChangeVendorParams) => void;
+    setVendor: (provider: import("../../Segment.types").SegmentProvider, params: import("./setVendor/setVendor.types").SetVendorParams) => void;
+};
+export default events;

package/build/analytics-rn/src/lib/providers/Segment/events/vendor/index.test.d.ts

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

package/build/analytics-rn/src/lib/providers/Segment/events/vendor/setVendor/setVendor.d.ts

@@ -0,0 +1,11 @@
+import { SegmentProvider } from "../../../Segment.types";
+import { SetVendorParams } from "./setVendor.types";
+/**
+ * Emits a setVendor event to a Segment Provider.
+ *
+ * @since 0.5.14
+ * @param {SegmentProvider} provider The provider instance that will emit the event
+ * @param {SetVendorParams} params Event configuration parameters
+ */
+declare const setVendor: (provider: SegmentProvider, params: SetVendorParams) => void;
+export default setVendor;

package/build/analytics-rn/src/lib/providers/Segment/events/vendor/setVendor/setVendor.test.d.ts

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

package/build/analytics-rn/src/lib/providers/Segment/events/vendor/setVendor/setVendor.types.d.ts

@@ -0,0 +1,14 @@
+import { SetVendorCommonParams } from "../../../../../events/vendor/setVendor/setVendor.types";
+import { SegmentCommonEventParams } from "../../../Segment.types";
+import { SegmentCustomEventParams } from "../../../Segment.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface SetVendorParams
+ * @since 0.5.14
+ * @extends SegmentCommonEventParams
+ * @extends SegmentCustomEventParams
+ * @extends SetVendorCommonParams
+ */
+export interface SetVendorParams extends SegmentCommonEventParams, SegmentCustomEventParams, SetVendorCommonParams {
+}

package/build/analytics-rn/src/lib/providers/Segment/events/workflow/index.d.ts

@@ -0,0 +1,5 @@
+declare const events: {
+    selectWorkflow: (provider: import("../../Segment.types").SegmentProvider, params: import("./selectWorkflow/selectWorkflow.types").SelectWorkflowParams) => void;
+    updateWorkflow: (provider: import("../../Segment.types").SegmentProvider, params: import("./updateWorkflow/updateWorkflow.types").UpdateWorkflowParams) => void;
+};
+export default events;

package/build/analytics-rn/src/lib/providers/Segment/events/workflow/index.test.d.ts

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

package/build/analytics-rn/src/lib/providers/Segment/events/workflow/selectWorkflow/selectWorkflow.d.ts

@@ -0,0 +1,11 @@
+import { SegmentProvider } from "../../../Segment.types";
+import { SelectWorkflowParams } from "./selectWorkflow.types";
+/**
+ * Emits a selectWorkflow event to a Segment Provider.
+ *
+ * @since 0.5.14
+ * @param {SegmentProvider} provider The provider instance that will emit the event
+ * @param {selectWorkflowParams} params Event configuration parameters
+ */
+declare const selectWorkflow: (provider: SegmentProvider, params: SelectWorkflowParams) => void;
+export default selectWorkflow;

package/build/analytics-rn/src/lib/providers/Segment/events/workflow/selectWorkflow/selectWorkflow.test.d.ts

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

package/build/analytics-rn/src/lib/providers/Segment/events/workflow/selectWorkflow/selectWorkflow.types.d.ts

@@ -0,0 +1,14 @@
+import { SelectWorkflowCommonParams } from "../../../../../events/workflow/selectWorkflow/selectWorkflow.types";
+import { SegmentCommonEventParams } from "../../../Segment.types";
+import { SegmentCustomEventParams } from "../../../Segment.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface SelectWorkflowParams
+ * @since 0.5.14
+ * @extends SegmentCommonEventParams
+ * @extends SegmentCustomEventParams
+ * @extends SelectWorkflowCommonParams
+ */
+export interface SelectWorkflowParams extends SegmentCommonEventParams, SegmentCustomEventParams, SelectWorkflowCommonParams {
+}

package/build/analytics-rn/src/lib/providers/Segment/events/workflow/updateWorkflow/updateWorkflow.d.ts

@@ -0,0 +1,11 @@
+import { SegmentProvider } from "../../../Segment.types";
+import { UpdateWorkflowParams } from "./updateWorkflow.types";
+/**
+ * Emits a updateWorkflow event to a Segment Provider.
+ *
+ * @since 0.5.14
+ * @param {SegmentProvider} provider The provider instance that will emit the event
+ * @param {updateWorkflowParams} params Event configuration parameters
+ */
+declare const updateWorkflow: (provider: SegmentProvider, params: UpdateWorkflowParams) => void;
+export default updateWorkflow;

package/build/analytics-rn/src/lib/providers/Segment/events/workflow/updateWorkflow/updateWorkflow.test.d.ts

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

package/build/analytics-rn/src/lib/providers/Segment/events/workflow/updateWorkflow/updateWorkflow.types.d.ts

@@ -0,0 +1,14 @@
+import { UpdateWorkflowCommonParams } from "../../../../../events/workflow/updateWorkflow/updateWorkflow.types";
+import { SegmentCommonEventParams } from "../../../Segment.types";
+import { SegmentCustomEventParams } from "../../../Segment.types";
+/**
+ * Event allowed parameters.
+ *
+ * @interface UpdateWorkflowParams
+ * @since 0.5.14
+ * @extends SegmentCommonEventParams
+ * @extends SegmentCustomEventParams
+ * @extends UpdateWorkflowCommonParams
+ */
+export interface UpdateWorkflowParams extends SegmentCommonEventParams, SegmentCustomEventParams, UpdateWorkflowCommonParams {
+}

package/build/analytics-rn/src/lib/providers/providers.d.ts

@@ -1,7 +1,9 @@
 import FacebookPixel from "./FacebookPixel/FacebookPixel";
 import GoogleAnalytics from "./GoogleAnalytics/GoogleAnalytics";
+import Segment from "./Segment/Segment";
 declare const Providers: {
     FacebookPixel: typeof FacebookPixel;
     GoogleAnalytics: typeof GoogleAnalytics;
+    Segment: typeof Segment;
 };
 export default Providers;

package/build/analytics-rn/src/test/exports.test.d.ts

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

package/build/analytics-rn/src/types/common.types.d.ts

@@ -42,7 +42,7 @@ export interface AnalyticsMeta {
  * @typedef ArtisanPlatform
  * @since 0.5.14
  */
-export declare type SupportedProviders = "GOOGLE_ANALYTICS" | "FACEBOOK_PIXEL";
+export declare type SupportedProviders = "GOOGLE_ANALYTICS" | "FACEBOOK_PIXEL" | "SEGMENT";
 /**
  * Supported auth providers methods.
  *

package/build/analytics-rn/src/types/event.types.d.ts

@@ -1,6 +1,7 @@
 import { CurrencyCodes } from "@artisan-commerce/types";
 import { FacebookPixelProvider } from "../lib/providers/FacebookPixel/FacebookPixel.types";
 import { GoogleAnalyticsProvider } from "../lib/providers/GoogleAnalytics/GoogleAnalytics.types";
+import { SegmentProvider } from "../lib/providers/Segment/Segment.types";
 /**
  * Artisan Auth event names type
  *
@@ -194,12 +195,12 @@ export declare type ArtisanEventNames = ArtisanAuthEventNames | ArtisanBannerEve
 export interface ProvidersHandlers<T> {
     googleAnalyticsHandler: (provider: GoogleAnalyticsProvider, params: T) => void;
     facebookPixelHandler: (provider: FacebookPixelProvider, params: T) => void;
+    segmentHandler: (provider: SegmentProvider, params: T) => void;
 }
 /**
  * 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/analytics-rn/src/utils/events.utils.d.ts

@@ -2,6 +2,7 @@ import { CartProduct, CurrencyCodes, Product } from "@artisan-commerce/types";
 import { ShoppingCart } from "@artisan-commerce/types";
 import { ProvidersHandlers } from "../types/event.types";
 import { Gtag } from "../lib/providers/GoogleAnalytics/GoogleAnalytics.types";
+import { Segment } from "../lib/providers/Segment/Segment.types";
 /**
  * Triage event to each provider handler.
  *
@@ -61,3 +62,19 @@ export declare const mapProductToGoogleItem: (product: CartProduct, currency?: C
  * @returns {string} The accepted parameter type
  */
 export declare const transformArrayParam: (param: unknown[]) => string;
+/**
+ * Maps a product into a segment product.
+ *
+ * @since 0.5.14
+ * @param {Product} product The wanted product's data
+ * @returns {Segment.Product} An object with Item data
+ */
+export declare const mapProductToSegmentProduct: (product: Product) => Segment.Product;
+/**
+ * Maps the order products into segment products.
+ *
+ * @since 0.5.14
+ * @param {Product[]} products The order product's data
+ * @returns {Segment.Product[]} An array of objects with google items data
+ */
+export declare const mapProductsToSegmentProducts: (products: Product[]) => Segment.Product[];

package/build/analytics-rn/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;