@artisan-commerce/analytics-web 0.2.0-canary.85 → 0.2.0-canary.87

package/dist/bundle.d.ts

@@ -432,9 +432,36 @@ interface FacebookPixelProvider extends Omit<AnalyticsProviderConstructor, "type
  * @interface FacebookPixelProvider
  * @since 0.1.0
  * @property {CurrencyCodes} currency user's country monetary code
+ * @property {boolean} isTrackingAllowed whether user tracking is allowed
+ * @property {boolean} withConversionsAPI whether conversion API feature is allowed
+ * @property {FacebookConversionsApiConfig} conversionsApiConfig facebook conversions API configuration
  */
 interface FacebookPixelProviderConfig {
     currency?: CurrencyCodes;
+    isTrackingAllowed?: boolean;
+    withConversionsAPI?: boolean;
+    conversionsApiConfig?: FacebookConversionsApiConfig;
+}
+/**
+ * Facebook Conversions API configuration.
+ *
+ * @interface FacebookConversionsApiConfig
+ * @since 0.1.0
+ * @implements FacebookPixelProviderConfig
+ * @property {string} eventSourceUrl website url
+ * @property {string} countryISOCode user's country ISO code in lowercase (e.g. "ec")
+ * @property {string} fbAccessToken Facebook pixel token
+ * @property {string} fbPixelId Facebook pixel id
+ * @property {string} apiURL api URL
+ * @property {string} authToken user's authorization token
+ */
+interface FacebookConversionsApiConfig {
+    eventSourceUrl: string;
+    countryISOCode: string;
+    fbAccessToken: string;
+    fbPixelId: string;
+    apiURL: string;
+    authToken: string;
 }
 /**
  * Facebook Pixel event shared parameters.
@@ -469,6 +496,12 @@ declare namespace Fbq {
         currency?: string;
         value?: number;
     }
+    interface Product {
+        id?: string;
+        quantity?: number;
+        item_price?: number;
+        delivery_category?: string;
+    }
 }
 
 /**
@@ -606,6 +639,9 @@ declare abstract class AnalyticsProvider implements IAnaliticsProvider {
 declare class FacebookPixel extends AnalyticsProvider {
     private readonly _version;
     private _currency;
+    private _isTrackingAllowed;
+    private _conversionsApiConfig;
+    readonly withConversionsAPI: FacebookPixelProvider["withConversionsAPI"];
     /**
      * Contructs a Facebook Pixel Provider
      *
@@ -616,6 +652,8 @@ declare class FacebookPixel extends AnalyticsProvider {
     constructor(config: FacebookPixelProvider);
     get version(): FacebookPixelProvider["version"];
     get currency(): FacebookPixelProvider["currency"];
+    get isTrackingAllowed(): FacebookPixelProvider["isTrackingAllowed"];
+    get conversionsApiConfig(): FacebookPixelProvider["conversionsApiConfig"];
     /**
      * @override
      * @since 0.1.0
@@ -5746,4 +5784,4 @@ declare const identifyUser: (identify: Segment$1.Traits) => void;
  */
 declare const checkInit: () => boolean;
 
-export { AnalyticsMeta, AnalyticsProvidersConfigs, AuthProviderMethods, FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, FacebookPixelProvider, FacebookPixelProviderConfig, Fbq, GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, GoogleAnalyticsProvider, GoogleAnalyticsProviderConfig, Gtag, InitAnalyticsConfig, InitAnalyticsConfigMeta, Providers, Segment$1 as Segment, SegmentCommonEventParams, SegmentCustomEventParams, SegmentProvider, SegmentProviderConfig, SupportedProviders, checkInit, events, identifyUser, initAnalytics, updateActiveVendor };
+export { AnalyticsMeta, AnalyticsProvidersConfigs, AuthProviderMethods, FacebookConversionsApiConfig, FacebookPixelCommonEventParams, FacebookPixelCustomEventParams, FacebookPixelProvider, FacebookPixelProviderConfig, Fbq, GoogleAnalyticsCommonEventParams, GoogleAnalyticsCustomEventParams, GoogleAnalyticsProvider, GoogleAnalyticsProviderConfig, Gtag, InitAnalyticsConfig, InitAnalyticsConfigMeta, Providers, Segment$1 as Segment, SegmentCommonEventParams, SegmentCustomEventParams, SegmentProvider, SegmentProviderConfig, SupportedProviders, checkInit, events, identifyUser, initAnalytics, updateActiveVendor };