@artisan-commerce/analytics-rn 0.3.0-canary.92 → 0.3.0-canary.93

package/dist/bundle.d.ts

@@ -1,4 +1,5 @@
 import { Account, Vendor, Store, Catalogue, ArtisnPlatform, CurrencyCodes, Product, ShoppingCart, CartProduct, PriceCategoryType, ShippingAddress, BillingData, Order, Category } from '@artisan-commerce/types';
+import { JsonMap, UserTraits, SegmentClient } from '@segment/analytics-react-native';
 
 /**
  * Analytics providers configurable options.
@@ -206,7 +207,16 @@ interface SegmentProvider extends Omit<AnalyticsProviderConstructor, "type">, Se
  * @since 0.1.0
  */
 interface SegmentProviderConfig {
+    /** Currency country codes, see {@link CurrencyCodes} */
     currency?: CurrencyCodes;
+    /** Segment track event, use event name and properties as parameters */
+    track?: (event: string, properties?: JsonMap) => Promise<void>;
+    /** Segment screen event, use screen name and properties as parameters */
+    screen?: (name: string, properties?: JsonMap) => Promise<void>;
+    /** Segment user identify handler, use user id and userTraits as parameters */
+    identify?: (userId?: string, userTraits?: UserTraits) => Promise<void>;
+    /** Segment reset handler, use reset anonymous id as parameter */
+    reset?: (resetAnonymousId?: boolean) => Promise<void>;
 }
 /**
  * Segment event shared parameters.
@@ -226,58 +236,6 @@ interface SegmentCommonEventParams extends EventCommonParams {
 interface SegmentCustomEventParams {
     [key: string]: any;
 }
-declare namespace Segment$1 {
-    interface Product {
-        product_id: string;
-        sku?: string;
-        category?: string;
-        name?: string;
-        brand?: string;
-        variant?: string;
-        price?: number;
-        quantity?: number;
-        coupon?: string;
-        position?: number;
-        url?: string;
-        image_url?: string;
-    }
-    interface Address {
-        city?: string;
-        country?: string;
-        postalCode?: string;
-        state?: string;
-        street?: string;
-        [key: string]: any;
-    }
-    interface Company {
-        name?: string;
-        id?: string | number;
-        industry?: string;
-        employee_count?: number;
-        plan?: string;
-        [key: string]: any;
-    }
-    interface Traits {
-        id: string;
-        address?: Address;
-        age?: number;
-        avatar?: string;
-        bithday?: string;
-        company?: Company;
-        createdAt?: string;
-        description?: string;
-        email?: string;
-        firstName?: string;
-        gender?: string;
-        lastName?: string;
-        name?: string;
-        phone?: string;
-        title?: string;
-        username?: string;
-        website?: string;
-        [key: string]: any;
-    }
-}
 
 /**
  * Shared params across every event.
@@ -406,8 +364,13 @@ declare class GoogleAnalytics extends AnalyticsProvider {
 declare class Segment extends AnalyticsProvider {
     private _writeKey;
     private _currency;
+    private _segmentClient?;
+    private _track;
+    private _screen;
+    private _identify;
+    private _reset;
     /**
-     * Contructs a Segment Provider
+     * Constructs a Segment Provider
      *
      * @constructs
      * @since 0.1.0
@@ -419,6 +382,11 @@ declare class Segment extends AnalyticsProvider {
      * @since 0.1.0
      */
     init(): Promise<void>;
+    get segmentClient(): SegmentClient | undefined;
+    get track(): SegmentProvider["track"];
+    get screen(): SegmentProvider["screen"];
+    get identify(): SegmentProvider["identify"];
+    get reset(): SegmentProvider["reset"];
     /**
      * @override
      * @since 0.1.0
@@ -753,10 +721,10 @@ interface UpdateUserInfoParams$2 extends FacebookPixelCommonEventParams, Faceboo
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends UpdateUserInfoCommonParams
- * @property {Segment.Traits} identify Pieces of information you know about a user that are included in an identify call
+ * @property {UserTraits} identify Pieces of information you know about a user that are included in an identify call
  */
 interface UpdateUserInfoParams$1 extends SegmentCommonEventParams, SegmentCustomEventParams, UpdateUserInfoCommonParams {
-    identify?: Segment$1.Traits;
+    identify?: UserTraits;
 }
 
 /**
@@ -811,10 +779,10 @@ interface SetUserInfoParams$2 extends FacebookPixelCommonEventParams, FacebookPi
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends SetUserInfoCommonParams
- * @property {Segment.Traits} identify Pieces of information you know about a user that are included in an identify call
+ * @property {UserTraits} identify Pieces of information you know about a user that are included in an identify call
  */
 interface SetUserInfoParams$1 extends SegmentCommonEventParams, SegmentCustomEventParams, SetUserInfoCommonParams {
-    identify?: Segment$1.Traits;
+    identify?: UserTraits;
 }
 
 /**
@@ -1529,10 +1497,10 @@ interface UpdateShippingAddressParams$2 extends FacebookPixelCommonEventParams,
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends UpdateShippingAddressCommonParams
- * @property {Segment.Traits} identify Pieces of information you know about a user that are included in an identify call
+ * @property {UserTraits} identify Pieces of information you know about a user that are included in an identify call
  */
 interface UpdateShippingAddressParams$1 extends SegmentCommonEventParams, SegmentCustomEventParams, UpdateShippingAddressCommonParams {
-    identify?: Segment$1.Traits;
+    identify?: UserTraits;
 }
 
 /**
@@ -1589,10 +1557,10 @@ interface SelectShippingAddressParams$2 extends FacebookPixelCommonEventParams,
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends SelectShippingAddressCommonParams
- * @property {Segment.Traits} identify Pieces of information you know about a user that are included in an identify call
+ * @property {UserTraits} identify Pieces of information you know about a user that are included in an identify call
  */
 interface SelectShippingAddressParams$1 extends SegmentCommonEventParams, SegmentCustomEventParams, SelectShippingAddressCommonParams {
-    identify?: Segment$1.Traits;
+    identify?: UserTraits;
 }
 
 /**
@@ -1655,10 +1623,10 @@ interface AddShippingAddressParams$2 extends FacebookPixelCommonEventParams, Fac
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends AddShippingAddressCommonParams
- * @property {Segment.Traits} identify Pieces of information you know about a user that are included in an identify call
+ * @property {UserTraits} identify Pieces of information you know about a user that are included in an identify call
  */
 interface AddShippingAddressParams$1 extends SegmentCommonEventParams, SegmentCustomEventParams, AddShippingAddressCommonParams {
-    identify?: Segment$1.Traits;
+    identify?: UserTraits;
 }
 
 /**
@@ -4951,12 +4919,12 @@ interface SignUpParams$2 extends FacebookPixelCommonEventParams, FacebookPixelCu
  * @extends SignUpCommonParams
  * @property {string} name The user's name
  * @property {string} email The user's email
- * @property {Segment.Traits} identify Pieces of information you know about a user that are included in an identify call
+ * @property {UserTraits} identify Pieces of information you know about a user that are included in an identify call
  */
 interface SignUpParams$1 extends SegmentCommonEventParams, SegmentCustomEventParams, SignUpCommonParams {
     name: string;
     email: string;
-    identify?: Segment$1.Traits;
+    identify?: UserTraits;
 }
 
 /**
@@ -5066,11 +5034,11 @@ interface SignInParams$2 extends FacebookPixelCommonEventParams, FacebookPixelCu
  * @extends SegmentCustomEventParams
  * @extends SignInCommonParams
  * @property {string} name The user's name
- * @property {Segment.Traits} identify Pieces of information you know about a user that are included in an identify call
+ * @property {UserTraits} identify Pieces of information you know about a user that are included in an identify call
  */
 interface SignInParams$1 extends SegmentCommonEventParams, SegmentCustomEventParams, SignInCommonParams {
     name: string;
-    identify?: Segment$1.Traits;
+    identify?: UserTraits;
 }
 
 /**
@@ -5456,12 +5424,4 @@ declare const events: {
  */
 declare const updateActiveVendor: (vendor: Vendor | Vendor["id"] | -1 | undefined) => void;
 
-/**
- * Utility function to identify a user across Segment destinations.
- *
- * @since 0.1.0
- * @param {Segment.Traits} identify Pieces of information you know about a user that are included in an identify call
- */
-declare const identifyUser: (identify: Segment$1.Traits) => void;
-
-export { AnalyticsMeta, AuthProviderMethods, FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, FacebookPixelProvider, FacebookPixelProviderConfig, GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, GoogleAnalyticsProvider, GoogleAnalyticsProviderConfig, Gtag, InitAnalyticsConfig, InitAnalyticsConfigMeta, Providers, SupportedProviders, events, identifyUser, initAnalytics, updateActiveVendor };
+export { AnalyticsMeta, AuthProviderMethods, FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, FacebookPixelProvider, FacebookPixelProviderConfig, GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, GoogleAnalyticsProvider, GoogleAnalyticsProviderConfig, Gtag, InitAnalyticsConfig, InitAnalyticsConfigMeta, Providers, SupportedProviders, events, initAnalytics, updateActiveVendor };