@artisan-commerce/analytics-capacitor 0.1.0-canary.2 → 0.1.0-canary.20

package/dist/bundle.d.ts

@@ -432,9 +432,44 @@ interface FacebookPixelProvider extends Omit<AnalyticsProviderConstructor, "type
  * @interface FacebookPixelProvider
  * @since 0.5.14
  * @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
+ * @property {boolean} advertiserTrackingEnabled whether advertiser tracking enabled
+ * @property {boolean} applicationTrackingEnabled whether application
  */
 interface FacebookPixelProviderConfig {
     currency?: CurrencyCodes;
+    isTrackingAllowed?: boolean;
+    withConversionsAPI?: boolean;
+    conversionsApiConfig?: FacebookConversionsApiConfig;
+    advertiserTrackingEnabled?: boolean;
+    applicationTrackingEnabled?: boolean;
+}
+/**
+ * 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} fbDataSourceId Facebook pixel or dataset id
+ * @property {string} apiURL api URL
+ * @property {string} authToken user's authorization token
+ * @property {boolean} advertiserTrackingEnabled whether advertiser tracking enabled
+ * @property {boolean} applicationTrackingEnabled whether application tracking enabled
+ */
+interface FacebookConversionsApiConfig {
+    eventSourceUrl?: string;
+    countryISOCode: string;
+    fbAccessToken: string;
+    fbDataSourceId: string;
+    apiURL: string;
+    authToken: string;
+    advertiserTrackingEnabled?: boolean;
+    applicationTrackingEnabled?: boolean;
 }
 /**
  * Facebook Pixel event shared parameters.
@@ -469,19 +504,25 @@ declare namespace Fbq {
         currency?: string;
         value?: number;
     }
+    interface Product {
+        id?: string;
+        quantity?: number;
+        item_price?: number;
+        delivery_category?: string;
+    }
 }
 
 /**
  * Analytics providers configurable options.
  *
- * @typedef ArtisnPlatform
+ * @typedef AnalyticsProvidersConfigs
  * @since 0.5.14
  */
 declare type AnalyticsProvidersConfigs = Partial<GoogleAnalyticsProviderConfig> | Partial<FacebookPixelProviderConfig>;
 /**
  * Analytics event metadata to be included in every sent event.
  *
- * @interface ArtisnPlatform
+ * @interface AnalyticsMeta
  * @since 0.5.14
  * @property {number} accountId the id of the account it is running on
  * @property {number} vendorId the id of the active vendor
@@ -606,8 +647,13 @@ declare abstract class AnalyticsProvider implements IAnaliticsProvider {
 declare class FacebookPixel extends AnalyticsProvider {
     private readonly _version;
     private _currency;
+    private _isTrackingAllowed;
+    private _conversionsApiConfig;
+    readonly withConversionsAPI: FacebookPixelProvider["withConversionsAPI"];
+    private _advertiserTrackingEnabled;
+    private _applicationTrackingEnabled;
     /**
-     * Contructs a Facebook Pixel Provider
+     * Constructs a Facebook Pixel Provider
      *
      * @constructs
      * @since 0.5.14
@@ -616,6 +662,10 @@ declare class FacebookPixel extends AnalyticsProvider {
     constructor(config: FacebookPixelProvider);
     get version(): FacebookPixelProvider["version"];
     get currency(): FacebookPixelProvider["currency"];
+    get isTrackingAllowed(): FacebookPixelProvider["isTrackingAllowed"];
+    get conversionsApiConfig(): FacebookPixelProvider["conversionsApiConfig"];
+    get advertiserTrackingEnabled(): FacebookPixelProvider["advertiserTrackingEnabled"];
+    get applicationTrackingEnabled(): FacebookPixelProvider["applicationTrackingEnabled"];
     /**
      * @override
      * @since 0.5.14
@@ -711,6 +761,7 @@ declare const Providers: {
  * @property {boolean} debug Debug mode
  * @property {boolean} shareArtisnAnalytics Share e-commerce analytics with Trade
  * @property {InitAnalyticsConfigMeta} meta Commerce's metadata
+ * @property {function} onInit fires the callback once analytics are initialized
  */
 interface InitAnalyticsConfig {
     providers: AnalyticsProviderTypes[];
@@ -719,6 +770,7 @@ interface InitAnalyticsConfig {
     debug?: boolean;
     shareArtisnAnalytics?: boolean;
     meta: InitAnalyticsConfigMeta;
+    onInit?: () => void;
 }
 /**
  * Commerce's metadata
@@ -5744,4 +5796,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 };